RedfishHostInterfaceLib.h File Reference

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

Detailed Description

Definitinos of RedfishHostInterfaceDxe driver.

(C) Copyright 2020 Hewlett Packard Enterprise Development LP

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

Function Documentation

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

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_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.

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(). param[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.