PlatformHostInterfaceBmcUsbNicLib.h

Go to the documentation of this file.

 
#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/IpmiCommandLib.h>
#include <Library/RedfishHostInterfaceLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/DevicePathLib.h>
#include <Library/RedfishDebugLib.h>
 
#include <Protocol/EdkIIRedfishCredential2.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;              
  BOOLEAN                        IsExposedByBmc;            
  BOOLEAN                        IsSuppportedHostInterface; 
  EFI_SIMPLE_NETWORK_PROTOCOL    *ThisSnp;                  
  EFI_USB_IO_PROTOCOL            *ThisUsbIo;                
  UINT16                         UsbVendorId;               
  UINT16                         UsbProductId;              
  UINTN                          MacAddressSize;            
  UINT8                          *MacAddress;               
  UINT8                          IpmiLanChannelNumber;      
 
  //
  // Below is the infortmation for building SMBIOS type 42.
  //
  UINT8                          IpAssignedType;          
  UINT8                          IpAddressFormat;         
  UINT8                          HostIpAddressIpv4[4];    
  UINT8                          RedfishIpAddressIpv4[4]; 
  UINT8                          SubnetMaskIpv4[4];       
  UINT8                          GatewayIpv4[4];          
  UINT16                         VLanId;                  
  BOOLEAN                        CredentialBootstrapping; 
} HOST_INTERFACE_BMC_USB_NIC_INFO;
 
//
// This is the structure for caching
// BMC IPMI LAN Channel
//
typedef struct {
  LIST_ENTRY         NextInstance;            
  UINT8              Channel;                 
  EFI_MAC_ADDRESS    MacAddress;              
  UINT8              MacAddressSize;          
} BMC_IPMI_LAN_CHANNEL_INFO;
#endif