RedfishHostInterface.h

Go to the documentation of this file.

 
#ifndef REDFISH_HOST_INTERFACE_
#define REDFISH_HOST_INTERFACE_
 
#include <IndustryStandard/SmBios.h>
 
#define REDFISH_HOST_INTERFACE_DEVICE_TYPE_USB  0x02        // We don't support this type of interface.
                                                            // Use REDFISH_HOST_INTERFACE_DEVICE_TYPE_USB_V2 instead.
#define REDFISH_HOST_INTERFACE_DEVICE_TYPE_PCI_PCIE  0x03   // We don't support this type of interface.
                                                            // Use REDFISH_HOST_INTERFACE_DEVICE_TYPE_PCI_PCIE_V2 instead.
#define REDFISH_HOST_INTERFACE_DEVICE_TYPE_USB_V2       0x04
#define REDFISH_HOST_INTERFACE_DEVICE_TYPE_PCI_PCIE_V2  0x05
 
#define REDFISH_HOST_INTERFACE_HOST_IP_ASSIGNMENT_TYPE_UNKNOWN         0x00
#define REDFISH_HOST_INTERFACE_HOST_IP_ASSIGNMENT_TYPE_STATIC          0x01
#define REDFISH_HOST_INTERFACE_HOST_IP_ASSIGNMENT_TYPE_DHCP            0x02
#define REDFISH_HOST_INTERFACE_HOST_IP_ASSIGNMENT_TYPE_AUTO_CONFIGURE  0x03
#define REDFISH_HOST_INTERFACE_HOST_IP_ASSIGNMENT_TYPE_HOST_SELECTED   0x04
 
#define REDFISH_HOST_INTERFACE_HOST_IP_ADDRESS_FORMAT_UNKNOWN  0x00
#define REDFISH_HOST_INTERFACE_HOST_IP_ADDRESS_FORMAT_IP4      0x01
#define REDFISH_HOST_INTERFACE_HOST_IP_ADDRESS_FORMAT_IP6      0x02
 
typedef enum {
  RedfishHostIpAssignmentUnknown,
  RedfishHostIpAssignmentStatic,
  RedfishHostIpAssignmentDhcp,
  RedfishHostIpAssignmentAutoConfigure,
  RedfishHostIpAssignmentHostSelected,
  RedfishHostIpAssignmentReserved
} REDFISH_HOST_IP_ASSIGNMENT;
 
#pragma pack(1)
typedef struct {
  UINT8     Length;                        
  UINT16    IdVendor;                      
  UINT16    IdProduct;                     
  UINT8     SerialNumberStr;               
  UINT8     MacAddress[6];                 
 
  UINT16    Characteristics;               
  UINT16    CredentialBootstrappingHandle; 
} USB_INTERFACE_DEVICE_DESCRIPTOR_V2;
 
//
// Structure definitions of Host Interface device type 05h (PCI/PCIE V2)
//
typedef struct {
  UINT8     Length;                             
  UINT16    VendorId;                           
  UINT16    DeviceId;                           
  UINT16    SubsystemVendorId;                  
  UINT16    SubsystemId;                        
  UINT8     MacAddress[6];                      
  UINT16    SegmemtGroupNumber;                 
  UINT8     BusNumber;                          
  UINT8     DeviceFunctionNumber;               
} PCI_OR_PCIE_INTERFACE_DEVICE_DESCRIPTOR_V2;
 
typedef struct {
  UINT32    VendorIana;                        
  UINT8     OemDefinedData[1];                 
} OEM_DEVICE_DESCRIPTOR;
 
#define USB_INTERFACE_DEVICE_DESCRIPTOR_V2_SIZE_1_3  0x11        
#define USB_INTERFACE_DEVICE_DESCRIPTOR_V2_SIZE_1_2  0x0d        
typedef union {
  USB_INTERFACE_DEVICE_DESCRIPTOR_V2            UsbDeviceV2;     
  PCI_OR_PCIE_INTERFACE_DEVICE_DESCRIPTOR_V2    PciPcieDeviceV2; 
  OEM_DEVICE_DESCRIPTOR                         OemDevice;       
} DEVICE_DESCRITOR; 
 
typedef struct {
  UINT8               DeviceType;       
  DEVICE_DESCRITOR    DeviceDescriptor; 
} REDFISH_INTERFACE_DATA;
 
//
//  the protocol-specific data for the "Redfish Over IP" protocol
//
typedef struct {
  EFI_GUID    ServiceUuid;          // same as Redfish Service UUID in Redfish Service Root resource
 
  //
  //  Unknown=00h,
  //  Static=01h,
  //  DHCP=02h,
  //  AutoConfigure=03h,
  //  HostSelected=04h,
  //  other values reserved
  //
  UINT8    HostIpAssignmentType;
 
  //
  //  Unknown=00h,
  //  Ipv4=01h,
  //  Ipv6=02h,
  //  other values reserved
  //
  UINT8    HostIpAddressFormat;
 
  //
  //  Used for Static and AutoConfigure.
  //  For IPV4, use the first 4 Bytes and zero fill the remaining bytes.
  //
  UINT8    HostIpAddress[16];
 
  //
  //  Used for Static and AutoConfigure.
  //  For IPV4, use the first 4 Bytes and zero fill the remaining bytes.
  //
  UINT8    HostIpMask[16];
 
  //
  //  Unknown=00h,
  //  Static=01h,
  //  DHCP=02h,
  //  AutoConfigure=03h,
  //  HostSelected=04h,
  //  other values reserved
  //
  UINT8     RedfishServiceIpDiscoveryType;
 
  //
  //  Unknown=00h,
  //  Ipv4=01h,
  //  Ipv6=02h,
  //  other values reserved
  //
  UINT8     RedfishServiceIpAddressFormat;
 
  //
  //  Used for Static and AutoConfigure.
  //  For IPV4, use the first 4 Bytes and zero fill the remaining bytes.
  //
  UINT8     RedfishServiceIpAddress[16];
 
  //
  //  Used for Static and AutoConfigure.
  //  For IPV4, use the first 4 Bytes and zero fill the remaining bytes.
  //
  UINT8     RedfishServiceIpMask[16];
 
  UINT16    RedfishServiceIpPort;            // Used for Static and AutoConfigure.
  UINT32    RedfishServiceVlanId;            // Used for Static and AutoConfigure.
  UINT8     RedfishServiceHostnameLength;    // length of the following hostname string
  UINT8     RedfishServiceHostname[1];       // hostname of Redfish Service
} REDFISH_OVER_IP_PROTOCOL_DATA;
 
#pragma pack()
 
#endif