HttpBootDxe.h

Go to the documentation of this file.

 
#ifndef __EFI_HTTP_BOOT_DXE_H__
#define __EFI_HTTP_BOOT_DXE_H__
 
#include <Uefi.h>
 
#include <IndustryStandard/Http11.h>
#include <IndustryStandard/Dhcp.h>
 
//
// Libraries
//
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiHiiServicesLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/BaseLib.h>
#include <Library/UefiLib.h>
#include <Library/DevicePathLib.h>
#include <Library/DebugLib.h>
#include <Library/NetLib.h>
#include <Library/HttpLib.h>
#include <Library/HttpIoLib.h>
#include <Library/HiiLib.h>
#include <Library/PrintLib.h>
#include <Library/DpcLib.h>
 
//
// UEFI Driver Model Protocols
//
#include <Protocol/DriverBinding.h>
#include <Protocol/ComponentName2.h>
#include <Protocol/ComponentName.h>
 
//
// Consumed Protocols
//
#include <Protocol/ServiceBinding.h>
#include <Protocol/HiiConfigAccess.h>
#include <Protocol/NetworkInterfaceIdentifier.h>
#include <Protocol/Dhcp4.h>
#include <Protocol/Dhcp6.h>
#include <Protocol/Dns6.h>
#include <Protocol/Http.h>
#include <Protocol/Ip4Config2.h>
#include <Protocol/Ip6Config.h>
#include <Protocol/RamDisk.h>
#include <Protocol/AdapterInformation.h>
 
//
// Produced Protocols
//
#include <Protocol/LoadFile.h>
#include <Protocol/HttpBootCallback.h>
 
//
// Consumed Guids
//
#include <Guid/HttpBootConfigHii.h>
 
//
// Driver Version
//
#define HTTP_BOOT_DXE_VERSION  0xa
 
//
// Standard Media Types defined in
// http://www.iana.org/assignments/media-types
//
#define HTTP_CONTENT_TYPE_APP_EFI  "application/efi"
#define HTTP_CONTENT_TYPE_APP_IMG  "application/vnd.efi-img"
#define HTTP_CONTENT_TYPE_APP_ISO  "application/vnd.efi-iso"
 
//
// Protocol instances
//
extern EFI_DRIVER_BINDING_PROTOCOL   gHttpBootDxeDriverBinding;
extern EFI_COMPONENT_NAME2_PROTOCOL  gHttpBootDxeComponentName2;
extern EFI_COMPONENT_NAME_PROTOCOL   gHttpBootDxeComponentName;
 
//
// Private data structure
//
typedef struct _HTTP_BOOT_PRIVATE_DATA  HTTP_BOOT_PRIVATE_DATA;
typedef struct _HTTP_BOOT_VIRTUAL_NIC   HTTP_BOOT_VIRTUAL_NIC;
 
typedef enum  {
  ImageTypeEfi,
  ImageTypeVirtualCd,
  ImageTypeVirtualDisk,
  ImageTypeMax
} HTTP_BOOT_IMAGE_TYPE;
 
//
// Include files with internal function prototypes
//
#include "HttpBootComponentName.h"
#include "HttpBootDhcp4.h"
#include "HttpBootDhcp6.h"
#include "HttpBootImpl.h"
#include "HttpBootSupport.h"
#include "HttpBootClient.h"
#include "HttpBootConfig.h"
 
typedef union {
  HTTP_BOOT_DHCP4_PACKET_CACHE    Dhcp4;
  HTTP_BOOT_DHCP6_PACKET_CACHE    Dhcp6;
} HTTP_BOOT_DHCP_PACKET_CACHE;
 
struct _HTTP_BOOT_VIRTUAL_NIC {
  UINT32                      Signature;
  EFI_HANDLE                  Controller;
  EFI_HANDLE                  ImageHandle;
  EFI_LOAD_FILE_PROTOCOL      LoadFile;
  EFI_DEVICE_PATH_PROTOCOL    *DevicePath;
  HTTP_BOOT_PRIVATE_DATA      *Private;
};
 
#define HTTP_BOOT_PRIVATE_DATA_FROM_CALLBACK_INFO(Callback) \
  CR ( \
  Callback, \
  HTTP_BOOT_PRIVATE_DATA, \
  CallbackInfo, \
  HTTP_BOOT_PRIVATE_DATA_SIGNATURE \
  )
 
#define HTTP_BOOT_PRIVATE_DATA_FROM_CALLBACK_PROTOCOL(CallbackProtocol) \
    CR ( \
    CallbackProtocol, \
    HTTP_BOOT_PRIVATE_DATA, \
    LoadFileCallback, \
    HTTP_BOOT_PRIVATE_DATA_SIGNATURE \
    )
 
struct _HTTP_BOOT_PRIVATE_DATA {
  UINT32                                       Signature;
  EFI_HANDLE                                   Controller;
 
  HTTP_BOOT_VIRTUAL_NIC                        *Ip4Nic;
  HTTP_BOOT_VIRTUAL_NIC                        *Ip6Nic;
 
  //
  // Consumed children
  //
  EFI_HANDLE                                   Ip6Child;
  EFI_HANDLE                                   Dhcp4Child;
  EFI_HANDLE                                   Dhcp6Child;
  HTTP_IO                                      HttpIo;
  BOOLEAN                                      HttpCreated;
 
  //
  // Consumed protocol
  //
  EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL    *Nii;
  EFI_IP6_PROTOCOL                             *Ip6;
  EFI_IP4_CONFIG2_PROTOCOL                     *Ip4Config2;
  EFI_IP6_CONFIG_PROTOCOL                      *Ip6Config;
  EFI_DHCP4_PROTOCOL                           *Dhcp4;
  EFI_DHCP6_PROTOCOL                           *Dhcp6;
  EFI_DEVICE_PATH_PROTOCOL                     *ParentDevicePath;
 
  //
  // Produced protocol
  //
  EFI_LOAD_FILE_PROTOCOL                       LoadFile;
  EFI_DEVICE_PATH_PROTOCOL                     *DevicePath;
  UINT32                                       Id;
  EFI_HTTP_BOOT_CALLBACK_PROTOCOL              *HttpBootCallback;
  EFI_HTTP_BOOT_CALLBACK_PROTOCOL              LoadFileCallback;
 
  //
  // Data for the default HTTP Boot callback protocol
  //
  UINT64                                       FileSize;
  UINT64                                       ReceivedSize;
  UINT32                                       Percentage;
 
  //
  // Data for the server to authenticate the client
  //
  CHAR8                                        *AuthData;
  CHAR8                                        *AuthScheme;
 
  //
  // HII callback info block
  //
  HTTP_BOOT_FORM_CALLBACK_INFO                 CallbackInfo;
 
  //
  // Mode data
  //
  BOOLEAN                                      UsingIpv6;
  BOOLEAN                                      Started;
  EFI_IP_ADDRESS                               StationIp;
  EFI_IP_ADDRESS                               SubnetMask;
  EFI_IP_ADDRESS                               GatewayIp;
  EFI_IP_ADDRESS                               ServerIp;
  UINT16                                       Port;
  UINT32                                       DnsServerCount;
  EFI_IP_ADDRESS                               *DnsServerIp;
 
  //
  // The URI string attempt to download through HTTP, may point to
  // the memory in cached DHCP offer, or to the memory in FilePathUri.
  //
  CHAR8                                        *BootFileUri;
  VOID                                         *BootFileUriParser;
  UINTN                                        BootFileSize;
  UINTN                                        PartialTransferredSize;
  CHAR8                                        *LastModifiedOrEtag;
  BOOLEAN                                      NoGateway;
  HTTP_BOOT_IMAGE_TYPE                         ImageType;
 
  //
  // URI string extracted from the input FilePath parameter.
  //
  CHAR8                                        *FilePathUri;
  VOID                                         *FilePathUriParser;
 
  //
  // Cached HTTP data
  //
  LIST_ENTRY                                   CacheList;
 
  //
  // Cached DHCP offer
  //
  // OfferIndex records the index of DhcpOffer[] buffer, and OfferCount records the num of each type of offer.
  //
  // It supposed that
  //
  //   OfferNum:    8
  //   OfferBuffer: [ProxyNameUri, DhcpNameUri, DhcpIpUri, ProxyNameUri, ProxyIpUri, DhcpOnly, DhcpIpUri, DhcpNameUriDns]
  //   (OfferBuffer is 0-based.)
  //
  // And assume that (DhcpIpUri is the first priority actually.)
  //
  //   SelectIndex:     5
  //   SelectProxyType: HttpOfferTypeProxyIpUri
  //   (SelectIndex is 1-based, and 0 means no one is selected.)
  //
  // So it should be
  //
  //                 DhcpIpUri  DhcpNameUriDns  DhcpDns  DhcpOnly  ProxyNameUri  ProxyIpUri  DhcpNameUri
  //   OfferCount:  [       2,              1,       0,        1,            2,          1,            1]
  //
  //   OfferIndex: {[       2,              7,       0,        5,            0,         *4,            1]
  //                [       6,              0,       0,        0,            3,          0,            0]
  //                [       0,              0,       0,        0,            0,          0,            0]
  //                ...                                                                                 ]}
  //   (OfferIndex is 0-based.)
  //
  //
  UINT32                         SelectIndex;
  UINT32                         SelectProxyType;
  HTTP_BOOT_DHCP_PACKET_CACHE    OfferBuffer[HTTP_BOOT_OFFER_MAX_NUM];
  UINT32                         OfferNum;
  UINT32                         OfferCount[HttpOfferTypeMax];
  UINT32                         OfferIndex[HttpOfferTypeMax][HTTP_BOOT_OFFER_MAX_NUM];
};
 
#define HTTP_BOOT_PRIVATE_DATA_SIGNATURE  SIGNATURE_32 ('H', 'B', 'P', 'D')
#define HTTP_BOOT_VIRTUAL_NIC_SIGNATURE   SIGNATURE_32 ('H', 'B', 'V', 'N')
#define HTTP_BOOT_PRIVATE_DATA_FROM_LOADFILE(a)  CR (a, HTTP_BOOT_PRIVATE_DATA, LoadFile, HTTP_BOOT_PRIVATE_DATA_SIGNATURE)
#define HTTP_BOOT_PRIVATE_DATA_FROM_ID(a)        CR (a, HTTP_BOOT_PRIVATE_DATA, Id, HTTP_BOOT_PRIVATE_DATA_SIGNATURE)
#define HTTP_BOOT_VIRTUAL_NIC_FROM_LOADFILE(a)   CR (a, HTTP_BOOT_VIRTUAL_NIC, LoadFile, HTTP_BOOT_VIRTUAL_NIC_SIGNATURE)
extern EFI_LOAD_FILE_PROTOCOL  gHttpBootDxeLoadFile;
 
EFI_STATUS
EFIAPI
HttpBootIp4DxeDriverBindingSupported (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   ControllerHandle,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL
  );
 
EFI_STATUS
EFIAPI
HttpBootIp4DxeDriverBindingStart (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   ControllerHandle,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL
  );
 
EFI_STATUS
EFIAPI
HttpBootIp4DxeDriverBindingStop (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   ControllerHandle,
  IN UINTN                        NumberOfChildren,
  IN EFI_HANDLE                   *ChildHandleBuffer OPTIONAL
  );
 
EFI_STATUS
EFIAPI
HttpBootIp6DxeDriverBindingSupported (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   ControllerHandle,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL
  );
 
EFI_STATUS
EFIAPI
HttpBootIp6DxeDriverBindingStart (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   ControllerHandle,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL
  );
 
EFI_STATUS
EFIAPI
HttpBootIp6DxeDriverBindingStop (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   ControllerHandle,
  IN UINTN                        NumberOfChildren,
  IN EFI_HANDLE                   *ChildHandleBuffer OPTIONAL
  );
 
#endif