RedfishPkg/Library: Redfish BMC USBNIC Host Interface

BMC exposed USB NIC platform Redfish Host Interface
library implementation.

Signed-off-by: Abner Chang <abner.chang@amd.com>
Cc: Nickle Wang <nicklew@nvidia.com>
Cc: Igor Kulchytskyy <igork@ami.com>
Reviewed-by: Nickle Wang <nicklew@nvidia.com>

RedfishPkg/Include/Library/RedfishDebugLib.h

@@ -14,7 +14,8 @@
 #include <Library/JsonLib.h>
 #include <Library/RedfishLib.h>
 
-#define DEBUG_REDFISH_NETWORK  DEBUG_INFO   ///< Debug error level for Redfish networking function
+#define DEBUG_REDFISH_NETWORK         DEBUG_INFO   ///< Debug error level for Redfish networking function
+#define DEBUG_REDFISH_HOST_INTERFACE  DEBUG_INFO   ///< Debug error level for Redfish networking function
 
 /**
 

RedfishPkg/Library/PlatformHostInterfaceBmcUsbNicLib/PlatformHostInterfaceBmcUsbNicLib.h

@@ -0,0 +1,84 @@
+/** @file
+  Header file to provide the platform Redfish Host Interface information
+  of USB NIC Device exposed by BMC.
+
+  Copyright (C) 2023 Advanced Micro Devices, Inc. All rights reserved.
+
+  SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+
+#ifndef PLATFORM_HOST_INTERFACE_BMC_USB_NIC_LIB_H_
+#define PLATFORM_HOST_INTERFACE_BMC_USB_NIC_LIB_H_
+
+#include <Uefi.h>
+#include <IndustryStandard/Ipmi.h>
+#include <IndustryStandard/IpmiNetFnApp.h>
+#include <IndustryStandard/IpmiNetFnTransport.h>
+#include <IndustryStandard/RedfishHostInterfaceIpmi.h>
+#include <IndustryStandard/SmBios.h>
+#include <Library/BaseLib.h>
+#include <Library/BaseMemoryLib.h>
+#include <Library/DebugLib.h>
+#include <Library/DevicePathLib.h>
+#include <Library/IpmiLib.h>
+#include <Library/IpmiCommandLib.h>
+#include <Library/RedfishHostInterfaceLib.h>
+#include <Library/MemoryAllocationLib.h>
+#include <Library/UefiBootServicesTableLib.h>
+#include <Library/DevicePathLib.h>
+#include <Library/RedfishDebugLib.h>
+
+#include <Protocol/SimpleNetwork.h>
+#include <Protocol/UsbIo.h>
+
+#define BMC_USB_NIC_HOST_INTERFASCE_READINESS_GUID \
+    {  \
+      0xDD96F5D7, 0x4AE1, 0x4E6C, {0xA1, 0x30, 0xA5, 0xAC, 0x77, 0xDD, 0xE4, 0xA5} \
+    }
+
+//
+// This is the structure for BMC exposed
+// USB NIC information.
+//
+typedef struct {
+  LIST_ENTRY                     NextInstance;              ///< Link to the next instance.
+  BOOLEAN                        IsExposedByBmc;            ///< Flag indicates this USB NIC is
+                                                            ///< exposed by BMC.
+  BOOLEAN                        IsSuppportedHostInterface; ///< This BMC USB NIC is supported
+                                                            ///< as Redfish host interface
+  EFI_SIMPLE_NETWORK_PROTOCOL    *ThisSnp;                  ///< The SNP instance associated with
+                                                            ///< this USB NIC.
+  EFI_USB_IO_PROTOCOL            *ThisUsbIo;                ///< The USBIO instance associated with
+                                                            ///< this USB NIC.
+  UINT16                         UsbVendorId;               ///< USB Vendor ID of this BMC exposed USB NIC.
+  UINT16                         UsbProductId;              ///< USB Product ID of this BMC exposed USB NIC.
+  UINTN                          MacAddressSize;            ///< HW address size.
+  UINT8                          *MacAddress;               ///< HW address.
+  UINT8                          IpmiLanChannelNumber;      ///< BMC IPMI Lan Channel number.
+
+  //
+  // Below is the infortmation for building SMBIOS type 42.
+  //
+  UINT8                          IpAssignedType;          ///< Redfish service IP assign type.
+  UINT8                          IpAddressFormat;         ///< Redfish service IP version.
+  UINT8                          HostIpAddressIpv4[4];    ///< Host IP address.
+  UINT8                          RedfishIpAddressIpv4[4]; ///< Redfish service IP address.
+  UINT8                          SubnetMaskIpv4[4];       ///< Subnet mask.
+  UINT8                          GatewayIpv4[4];          ///< Gateway IP address.
+  UINT16                         VLanId;                  ///< VLAN ID.
+  BOOLEAN                        CredentialBootstrapping; ///< If Credential bootstrapping is
+                                                          ///< supported.
+} HOST_INTERFACE_BMC_USB_NIC_INFO;
+
+//
+// This is the structure for caching
+// BMC IPMI LAN Channel
+//
+typedef struct {
+  LIST_ENTRY         NextInstance;            ///< Link to the next IPMI LAN Channel.
+  UINT8              Channel;                 ///< IPMI Channel number.
+  EFI_MAC_ADDRESS    MacAddress;              ///< IPMI LAN Channel MAC address.
+  UINT8              MacAddressSize;          ///< MAC address size;
+} BMC_IPMI_LAN_CHANNEL_INFO;
+#endif

RedfishPkg/Library/PlatformHostInterfaceBmcUsbNicLib/PlatformHostInterfaceBmcUsbNicLib.inf

@@ -0,0 +1,48 @@
+## @file
+#  Module to provide the platform Redfish Host Interface information
+#  of USB NIC Device exposed by BMC.
+#
+# Copyright (C) 2023 Advanced Micro Devices, Inc. All rights reserved.
+#
+#  SPDX-License-Identifier: BSD-2-Clause-Patent
+#
+##
+
+[Defines]
+  INF_VERSION                    = 0x0001000b
+  BASE_NAME                      = PlatformHostInterfaceBmcUsbNicLib
+  FILE_GUID                      = C4837B58-225E-4352-8FDC-4C52A5D65891
+  MODULE_TYPE                    = DXE_DRIVER
+  VERSION_STRING                 = 1.0
+  LIBRARY_CLASS                  = PlatformHostInterfaceBmcUsbNicLib
+
+[Sources]
+  PlatformHostInterfaceBmcUsbNicLib.c
+  PlatformHostInterfaceBmcUsbNicLib.h
+
+[Packages]
+  MdePkg/MdePkg.dec
+  MdeModulePkg/MdeModulePkg.dec
+  NetworkPkg/NetworkPkg.dec
+  RedfishPkg/RedfishPkg.dec
+
+[LibraryClasses]
+  BaseMemoryLib
+  DebugLib
+  IpmiLib
+  IpmiCommandLib
+  MemoryAllocationLib
+  UefiLib
+  UefiBootServicesTableLib
+
+[Protocols]
+  gEfiSimpleNetworkProtocolGuid                 ## CONSUMED
+  gEfiUsbIoProtocolGuid                         ## CONSUMED
+  gEfiDevicePathProtocolGuid                    ## CONSUMED
+
+[Pcd]
+  gEfiRedfishPkgTokenSpaceGuid.PcdRedfishHostName     ## CONSUMED
+  gEfiRedfishPkgTokenSpaceGuid.PcdRedfishServiceUuid  ## CONSUMED
+
+[Depex]
+  gIpmiProtocolGuid

RedfishPkg/RedfishPkg.dec

@@ -113,3 +113,13 @@
   # Default is set to not add.
   #
   gEfiRedfishPkgTokenSpaceGuid.PcdRedfishRestExAddingExpect|FALSE|BOOLEAN|0x00001004
+  #
+  # Use PCD to declare the Redfish host nmae becasue there is no
+  # specification for that.
+  #
+  gEfiRedfishPkgTokenSpaceGuid.PcdRedfishHostName|"Redfish service"|VOID*|0x00001005
+  #
+  # Use PCD to declare the Redfish service UUID becasue there is no
+  # specification for that.
+  #
+  gEfiRedfishPkgTokenSpaceGuid.PcdRedfishServiceUuid|L"00000000-0000-0000-0000-000000000000"|VOID*|0x00001006