projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| c527aecd AC |
1 | /** @file\r |
| 2 | Definitinos of RedfishHostInterfaceDxe driver.\r | |
| 3 | \r | |
| 4 | (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>\r | |
| 5 | \r | |
| 6 | SPDX-License-Identifier: BSD-2-Clause-Patent\r | |
| 7 | \r | |
| 8 | **/\r | |
| 9 | #ifndef REDFISH_HOST_INTERFACE_LIB_H_\r | |
| 10 | #define REDFISH_HOST_INTERFACE_LIB_H_\r | |
| 11 | \r | |
| 12 | #include <Uefi.h>\r | |
| 13 | #include <IndustryStandard/RedfishHostInterface.h>\r | |
| 14 | #include <IndustryStandard/SmBios.h>\r | |
| 15 | \r | |
| 16 | #include <Protocol/Smbios.h>\r | |
| 17 | \r | |
| 18 | /**\r | |
| 19 | Get platform Redfish host interface device descriptor.\r | |
| 20 | \r | |
| 21 | @param[in] DeviceType Pointer to retrieve device type.\r | |
| 22 | @param[out] DeviceDescriptor Pointer to retrieve REDFISH_INTERFACE_DATA, caller has to free\r | |
| 23 | this memory using FreePool().\r | |
| 24 | @retval EFI_SUCCESS Device descriptor is returned successfully in DeviceDescriptor.\r | |
| 25 | @retval EFI_NOT_FOUND No Redfish host interface descriptor provided on this platform.\r | |
| 26 | @retval Others Fail to get device descriptor.\r | |
| 27 | **/\r | |
| 28 | EFI_STATUS\r | |
| 29 | RedfishPlatformHostInterfaceDeviceDescriptor (\r | |
| 30 | IN UINT8 *DeviceType,\r | |
| 31 | OUT REDFISH_INTERFACE_DATA **DeviceDescriptor\r | |
| 32 | );\r | |
| 33 | /**\r | |
| 34 | Get platform Redfish host interface protocol data.\r | |
| 35 | Caller should pass NULL in ProtocolRecord to retrive the first protocol record.\r | |
| 36 | Then continuously pass previous ProtocolRecord for retrieving the next ProtocolRecord.\r | |
| 37 | \r | |
| 38 | @param[in, out] ProtocolRecord Pointer to retrieve the first or the next protocol record.\r | |
| 39 | caller has to free the new protocol record returned from\r | |
| 40 | this function using FreePool().\r | |
| 41 | param[in] IndexOfProtocolData The index of protocol data.\r | |
| 42 | \r | |
| a7cf2c56 | 43 | @retval EFI_SUCCESS Protocol records are all returned.\r |
| c527aecd AC |
44 | @retval EFI_NOT_FOUND No more protocol records.\r |
| 45 | @retval Others Fail to get protocol records.\r | |
| 46 | **/\r | |
| 47 | EFI_STATUS\r | |
| 48 | RedfishPlatformHostInterfaceProtocolData (\r | |
| 49 | IN OUT MC_HOST_INTERFACE_PROTOCOL_RECORD **ProtocolRecord,\r | |
| 50 | IN UINT8 IndexOfProtocolData\r | |
| 51 | );\r | |
| 52 | #endif\r |