public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Abner Chang" <abner.chang@hpe.com>
To: devel@edk2.groups.io
Cc: Jiaxin Wu <jiaxin.wu@intel.com>, Siyuan Fu <siyuan.fu@intel.com>,
	Fan Wang <fan.wang@intel.com>, Jiewen Yao <jiewen.yao@intel.com>,
	Nickle Wang <nickle.wang@hpe.com>
Subject: [EFI Redfish Host Interface PATCH v2 2/6] RedfishPkg/Include: PlatformHostInterfaceLib header file
Date: Fri, 30 Oct 2020 18:02:05 +0800	[thread overview]
Message-ID: <20201030100209.9954-3-abner.chang@hpe.com> (raw)
In-Reply-To: <20201030100209.9954-1-abner.chang@hpe.com>

Signed-off-by: Abner Chang <abner.chang@hpe.com>

Cc: Jiaxin Wu <jiaxin.wu@intel.com>
Cc: Siyuan Fu <siyuan.fu@intel.com>
Cc: Fan Wang <fan.wang@intel.com>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Nickle Wang <nickle.wang@hpe.com>
---
 .../Include/Library/RedfishHostInterfaceLib.h | 52 +++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 RedfishPkg/Include/Library/RedfishHostInterfaceLib.h

diff --git a/RedfishPkg/Include/Library/RedfishHostInterfaceLib.h b/RedfishPkg/Include/Library/RedfishHostInterfaceLib.h
new file mode 100644
index 0000000000..fe37b2739a
--- /dev/null
+++ b/RedfishPkg/Include/Library/RedfishHostInterfaceLib.h
@@ -0,0 +1,52 @@
+/** @file
+  Definitinos of RedfishHostInterfaceDxe driver.
+
+  (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>
+
+  SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+#ifndef REDFISH_HOST_INTERFACE_LIB_H_
+#define REDFISH_HOST_INTERFACE_LIB_H_
+
+#include <Uefi.h>
+#include <IndustryStandard/RedfishHostInterface.h>
+#include <IndustryStandard/SmBios.h>
+
+#include <Protocol/Smbios.h>
+
+/**
+  Get platform Redfish host interface device descriptor.
+
+  @param[in] DeviceType         Pointer to retrieve device type.
+  @param[out] DeviceDescriptor  Pointer to retrieve REDFISH_INTERFACE_DATA, caller has to free
+                                this memory using FreePool().
+  @retval EFI_SUCCESS     Device descriptor is returned successfully in DeviceDescriptor.
+  @retval EFI_NOT_FOUND   No Redfish host interface descriptor provided on this platform.
+  @retval Others          Fail to get device descriptor.
+**/
+EFI_STATUS
+RedfishPlatformHostInterfaceDeviceDescriptor (
+  IN UINT8 *DeviceType,
+  OUT REDFISH_INTERFACE_DATA  **DeviceDescriptor
+);
+/**
+  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.
+
+  @param[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.
+
+  @retval EFI_SUCESS      Protocol records are all returned.
+  @retval EFI_NOT_FOUND   No more protocol records.
+  @retval Others          Fail to get protocol records.
+**/
+EFI_STATUS
+RedfishPlatformHostInterfaceProtocolData (
+  IN OUT MC_HOST_INTERFACE_PROTOCOL_RECORD **ProtocolRecord,
+  IN UINT8  IndexOfProtocolData
+);
+#endif
-- 
2.17.1


  parent reply	other threads:[~2020-10-30 10:47 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-30 10:02 [EFI Redfish Host Interface PATCH v2 0/6] Create SMBIOS type 42 record Abner Chang
2020-10-30 10:02 ` [EFI Redfish Host Interface PATCH v2 1/6] RedfishPkg/Include: Definitions of SMBIOS Redfish Host Interface Abner Chang
2020-10-30 10:02 ` Abner Chang [this message]
2020-11-02  3:51   ` [EFI Redfish Host Interface PATCH v2 2/6] RedfishPkg/Include: PlatformHostInterfaceLib header file Nickle Wang
2020-10-30 10:02 ` [EFI Redfish Host Interface PATCH v2 3/6] RedfishPkg/PlatformHostInterfaceLib: Platform NULL lib Abner Chang
2020-11-02  3:51   ` Nickle Wang
2020-10-30 10:02 ` [EFI Redfish Host Interface PATCH v2 4/6] RedfishPkg/RedfishHostInterfaceDxe: Create SMBIOS type 42 record Abner Chang
2020-10-30 10:02 ` [EFI Redfish Host Interface PATCH v2 5/6] RedfishPkg: Add RedfishHostInterfaceDxe to RedfishPkg Abner Chang
2020-11-02  3:52   ` Nickle Wang
2020-10-30 10:02 ` [EFI Redfish Host Interface PATCH v2 6/6] RedfishPkg: Changes on RedfishPkg for CI test Abner Chang
2020-11-02  3:52   ` Nickle Wang

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20201030100209.9954-3-abner.chang@hpe.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox