RedfishHostInterfaceLib.h File Reference

#include <Uefi.h>
#include <IndustryStandard/RedfishHostInterface.h>
#include <IndustryStandard/SmBios.h>
#include <Protocol/Smbios.h>

Go to the source code of this file.

Functions
EFI_STATUS	RedfishPlatformHostInterfaceDeviceDescriptor (OUT UINT8 *DeviceType, OUT REDFISH_INTERFACE_DATA **DeviceDescriptor)
EFI_STATUS	RedfishPlatformHostInterfaceProtocolData (IN OUT MC_HOST_INTERFACE_PROTOCOL_RECORD **ProtocolRecord, IN UINT8 IndexOfProtocolData)
EFI_STATUS	RedfishPlatformHostInterfaceNotification (OUT EFI_GUID **InformationReadinessGuid)

Detailed Description

Definitinos of RedfishHostInterfaceDxe driver.

(C) Copyright 2020 Hewlett Packard Enterprise Development LP
Copyright (C) 2022 Advanced Micro Devices, Inc. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file RedfishHostInterfaceLib.h.

Function Documentation

RedfishPlatformHostInterfaceDeviceDescriptor()

EFI_STATUS RedfishPlatformHostInterfaceDeviceDescriptor	(	OUT UINT8 *	DeviceType,
		OUT REDFISH_INTERFACE_DATA **	DeviceDescriptor
	)

Get platform Redfish host interface device descriptor.

Parameters

[out]	DeviceType	Pointer to retrieve device type.
[out]	DeviceDescriptor	Pointer to retrieve REDFISH_INTERFACE_DATA, caller has to free this memory using FreePool().

Return values

EFI_SUCCESS	Device descriptor is returned successfully in DeviceDescriptor.
EFI_NOT_FOUND	No Redfish host interface descriptor provided on this platform.
Others	Fail to get device descriptor.

Get platform Redfish host interface device descriptor.

Parameters

[in]	DeviceType	Pointer to retrieve device type.
[out]	DeviceDescriptor	Pointer to retrieve REDFISH_INTERFACE_DATA, caller has to free this memory using FreePool().

Return values

EFI_NOT_FOUND

No Redfish host interface descriptor provided on this platform.

Definition at line 95 of file RedfishPlatformHostInterfaceLib.c.

RedfishPlatformHostInterfaceNotification()

EFI_STATUS RedfishPlatformHostInterfaceNotification

(

OUT EFI_GUID **

InformationReadinessGuid

)

Get the EFI protocol GUID installed by platform library which indicates the necessary information is ready for building SMBIOS 42h record.

Parameters

[out]

InformationReadinessGuid

Pointer to retrive the protocol GUID.

Return values

EFI_SUCCESS	Notification is required for building up SMBIOS type 42h record.
EFI_UNSUPPORTED	Notification is not required for building up SMBIOS type 42h record.
EFI_ALREADY_STARTED	Platform host information is already ready.
Others	Other errors.

Definition at line 563 of file RedfishPlatformHostInterfaceLib.c.

RedfishPlatformHostInterfaceProtocolData()

EFI_STATUS RedfishPlatformHostInterfaceProtocolData	(	IN OUT MC_HOST_INTERFACE_PROTOCOL_RECORD **	ProtocolRecord,
		IN UINT8	IndexOfProtocolData
	)

Get platform Redfish host interface protocol data. Caller should pass NULL in ProtocolRecord to retrive the first protocol record. Then continuously pass previous ProtocolRecord for retrieving the next ProtocolRecord.

Parameters

[in,out]	ProtocolRecord	Pointer to retrieve the first or the next protocol record. caller has to free the new protocol record returned from this function using FreePool().
[in]	IndexOfProtocolData	The index of protocol data.

Return values

EFI_SUCCESS	Protocol records are all returned.
EFI_NOT_FOUND	No more protocol records.
Others	Fail to get protocol records.

Get platform Redfish host interface protocol data. Caller should pass NULL in ProtocolRecord to retrive the first protocol record. Then continuously pass previous ProtocolRecord for retrieving the next ProtocolRecord.

Parameters

[in,out]	ProtocolRecord	Pointer to retrieve the first or the next protocol record. caller has to free the new protocol record returned from this function using FreePool().
[in]	IndexOfProtocolData	The index of protocol data.

Return values

EFI_NOT_FOUND

No more protocol records.

Definition at line 164 of file PlatformHostInterfaceBmcUsbNicLib.c.