RedfishDiscoverInternal.h

Go to the documentation of this file.

 
#ifndef EFI_REDFISH_DISCOVER_INTERNAL_H_
#define EFI_REDFISH_DISCOVER_INTERNAL_H_
 
#include <Uefi.h>
 
#include <Protocol/ComponentName.h>
#include <Protocol/ComponentName2.h>
#include <Protocol/DriverBinding.h>
#include <Protocol/RedfishDiscover.h>
#include <Protocol/Smbios.h>
#include <Protocol/Tcp4.h>
#include <Protocol/Tcp6.h>
 
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/NetLib.h>
#include <Library/PrintLib.h>
#include <Library/RedfishDebugLib.h>
#include <Library/RestExLib.h>
#include <Library/UefiLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiDriverEntryPoint.h>
 
#include <IndustryStandard/RedfishHostInterface.h>
 
#define REDFISH_DISCOVER_VERSION                    0x00010000
#define EFI_REDFISH_DISCOVER_NETWORK_INTERFACE_TPL  TPL_NOTIFY
 
#define MAC_COMPARE(This, Target)  (CompareMem ((VOID *)&(This)->MacAddress, &(Target)->MacAddress, (This)->HwAddressSize) == 0)
#define VALID_TCP6(Target, This)   ((Target)->IsIpv6 && ((This)->NetworkProtocolType == ProtocolTypeTcp6))
#define VALID_TCP4(Target, This)   (!(Target)->IsIpv6 && ((This)->NetworkProtocolType == ProtocolTypeTcp4))
#define REDFISH_HI_ITERFACE_SPECIFIC_DATA_LENGTH_OFFSET  ((UINT16)(UINTN)(&((SMBIOS_TABLE_TYPE42 *)0)->InterfaceTypeSpecificDataLength))
#define REDFISH_HI_PROTOCOL_HOSTNAME_LENGTH_OFFSET       ((UINT16)(UINTN)(&((REDFISH_OVER_IP_PROTOCOL_DATA *)0)->RedfishServiceHostnameLength))
 
//
// GUID definitions
//
 
#define EFI_REDFISH_DISCOVER_TCP4_INSTANCE_GUID \
  { \
    0xfbab97a4, 0x4c6a, 0xf8e8, { 0xf2, 0x25, 0x42, 0x8a, 0x80, 0x3f, 0xb6, 0xaa } \
  }
 
#define EFI_REDFISH_DISCOVER_TCP6_INSTANCE_GUID \
  { \
    0xbe513b6d, 0x41c1, 0x96Ed, { 0x8d, 0xaf, 0x3e, 0x89, 0xc5, 0xf5, 0x02, 0x25 } \
  }
 
#define EFI_REDFISH_DISCOVER_REST_EX_INSTANCE_GUID \
  { \
    0xc44a6076, 0xd42a, 0x4d54, { 0x85, 0x6d, 0x98, 0x8a, 0x85, 0x8f, 0xa1, 0x11 } \
  }
 
extern EFI_COMPONENT_NAME_PROTOCOL   gRedfishDiscoverComponentName;
extern EFI_COMPONENT_NAME2_PROTOCOL  gRedfishDiscoverComponentName2;
extern EFI_UNICODE_STRING_TABLE      *gRedfishDiscoverControllerNameTable;
 
//
// Enumeration of network protocols
// required for the Redfish service discovery.
//
typedef enum {
  ProtocolTypeTcp4 = 0, 
  ProtocolTypeTcp6,     
  ProtocolTypeRestEx,   
  MaxProtocolType
} NETWORK_INTERFACE_PROTOCOL_TYPE;
 
//
// Network protocol information installed on
// the network interface.
//
typedef struct {
  EFI_GUID      ProtocolGuid;              
  EFI_GUID      ProtocolServiceGuid;       
  UINT32        ProtocolDiscoverId;        
  EFI_HANDLE    ProtocolControllerHandle;  
  VOID          *NetworkProtocolInterface; 
} REDFISH_DISCOVER_NETWORK_INTERFACE_PROTOCOL;
 
//
// Internal structure used to maintain network
// interface properties.
//
typedef struct {
  LIST_ENTRY                                     Entry;                      
  EFI_HANDLE                                     OpenDriverAgentHandle;      
  EFI_HANDLE                                     OpenDriverControllerHandle; 
  UINTN                                          HwAddressSize;              
  EFI_MAC_ADDRESS                                MacAddress;                 
  CHAR16                                         *StrMacAddr;                
  BOOLEAN                                        GotSubnetInfo;              
  EFI_IP_ADDRESS                                 SubnetAddr;                 
  EFI_IP_ADDRESS                                 SubnetMask;                 
  UINT8                                          SubnetPrefixLength;         
  UINT16                                         VlanId;                     
  UINT32                                         SubnetAddrInfoIPv6Number;   
  EFI_IP6_ADDRESS_INFO                           *SubnetAddrInfoIPv6;        
  //
  // Network interface protocol and REST EX info.
  //
  UINT32                                         NetworkProtocolType;          
  REDFISH_DISCOVER_NETWORK_INTERFACE_PROTOCOL    NetworkInterfaceProtocolInfo; 
  EFI_HANDLE                                     RestExHandle;                 
  //
  // EFI_REDFISH_DISCOVER_PROTOCOL instance installed
  // on this network interface.
  //
  EFI_HANDLE                                     EfiRedfishDiscoverProtocolHandle; 
} EFI_REDFISH_DISCOVER_NETWORK_INTERFACE_INTERNAL;
 
//
// Redfish Discover Instance signature
//
 
#define EFI_REDFISH_DISCOVER_DATA_SIGNATURE  SIGNATURE_32 ('E', 'R', 'D', 'D')
 
#define EFI_REDFISH_DISOVER_DATA_FROM_DISCOVER_PROTOCOL(a) \
  CR (a, EFI_REDFISH_DISCOVER_REST_EX_INSTANCE_INTERNAL, RedfishDiscoverProtocol, EFI_REDFISH_DISCOVER_DATA_SIGNATURE)
 
//
// Internal structure used to maintain REST EX properties.
//
typedef struct {
  LIST_ENTRY                                Entry;                      
  UINT32                                    Signature;                  
  EFI_HANDLE                                OpenDriverAgentHandle;      
  EFI_HANDLE                                OpenDriverControllerHandle; 
  EFI_HANDLE                                RestExChildHandle;          
  EFI_HANDLE                                RestExControllerHandle;     
  EFI_REST_EX_PROTOCOL                      *RestExProtocolInterface;   
  UINT32                                    RestExId;                   
  UINTN                                     NumberOfNetworkInterfaces;  
  EFI_REDFISH_DISCOVER_NETWORK_INTERFACE    *NetworkInterfaceInstances; 
  EFI_REDFISH_DISCOVER_PROTOCOL             RedfishDiscoverProtocol;    
} EFI_REDFISH_DISCOVER_REST_EX_INSTANCE_INTERNAL;
 
typedef
EFI_STATUS
(EFIAPI *EFI_REDFISH_DISCOVER_GET_SUBNET_INFO)(
  IN EFI_HANDLE ImageHandle,
  IN EFI_REDFISH_DISCOVER_NETWORK_INTERFACE_INTERNAL *Instance
  );
 
//
// The require network protocol matrix.
//
typedef struct {
  UINT32                                  ProtocolType;                        
  CHAR16                                  *ProtocolName;                       
  EFI_GUID                                *RequiredProtocolGuid;               
  EFI_GUID                                *RequiredServiceBindingProtocolGuid; 
  EFI_GUID                                *DiscoveredProtocolGuid;             
  EFI_REDFISH_DISCOVER_GET_SUBNET_INFO    GetSubnetInfo;                       
} REDFISH_DISCOVER_REQUIRED_PROTOCOL;
 
//
// Link list of Redfish discover instance.
//
typedef struct {
  LIST_ENTRY                         NextInstance;      
  EFI_REDFISH_DISCOVERED_INSTANCE    *Instance;         
} EFI_REDFISH_DISCOVERED_INTERNAL_LIST;
 
//
// Internal structure of Redfish discover instance.
//
typedef struct {
  LIST_ENTRY                                         Entry;             
  EFI_HANDLE                                         Owner;             
  EFI_REDFISH_DISCOVER_FLAG                          DiscoverFlags;     
  EFI_REDFISH_DISCOVERED_TOKEN                       *DiscoverToken;    
  EFI_REDFISH_DISCOVER_NETWORK_INTERFACE_INTERNAL    *NetworkInterface; 
  //
  // Below for Host interface discovery.
  //
  BOOLEAN                                            HostIntfValidation; 
  EFI_IP_ADDRESS                                     TargetIpAddress;    
  UINT8                                              HostAddrFormat;     
  EFI_IP_ADDRESS                                     HostIpAddress;      
  EFI_IP_ADDRESS                                     HostSubnetMask;     
} EFI_REDFISH_DISCOVERED_INTERNAL_INSTANCE;
 
EFI_STATUS
AddAndSignalNewRedfishService (
  IN EFI_REDFISH_DISCOVERED_INTERNAL_INSTANCE  *Instance,
  IN UINTN                                     *RedfishVersion OPTIONAL,
  IN CHAR8                                     *RedfishLocation OPTIONAL,
  IN CHAR8                                     *Uuid  OPTIONAL,
  IN CHAR8                                     *Os  OPTIONAL,
  IN CHAR8                                     *OsVer  OPTIONAL,
  IN CHAR8                                     *Product  OPTIONAL,
  IN CHAR8                                     *ProductVer  OPTIONAL,
  IN BOOLEAN                                   UseHttps
  );
 
EFI_STATUS
RedfishGetHostInterfaceProtocolData (
  IN EFI_SMBIOS_PROTOCOL             *Smbios,
  OUT REDFISH_INTERFACE_DATA         **DeviceDescriptor,
  OUT REDFISH_OVER_IP_PROTOCOL_DATA  **ProtocolData
  );
 
extern EFI_GUID  gRedfishDiscoverTcp4Instance;
extern EFI_GUID  gRedfishDiscoverTcp6Instance;
extern EFI_GUID  gRedfishDiscoverRestEXInstance;
#endif