[mirror_edk2.git] / NetworkPkg / HttpBootDxe / HttpBootDxe.h

/** @file\r
  UEFI HTTP boot driver's private data structure and interfaces declaration.\r
\r
Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
(C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
This program and the accompanying materials are licensed and made available under \r
the terms and conditions of the BSD License that accompanies this distribution.  \r
The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php.                                          \r
    \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.              \r
\r
**/\r
\r
#ifndef __EFI_HTTP_BOOT_DXE_H__\r
#define __EFI_HTTP_BOOT_DXE_H__\r
\r
#include <Uefi.h>\r
\r
#include <IndustryStandard/Http11.h>\r
\r
//\r
// Libraries\r
//\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/NetLib.h>\r
#include <Library/HttpLib.h>\r
\r
//\r
// UEFI Driver Model Protocols\r
//\r
#include <Protocol/DriverBinding.h>\r
#include <Protocol/ComponentName2.h>\r
#include <Protocol/ComponentName.h>\r
\r
//\r
// Consumed Protocols\r
//\r
#include <Protocol/NetworkInterfaceIdentifier.h>\r
#include <Protocol/Dhcp4.h>\r
#include <Protocol/Dhcp6.h>\r
#include <Protocol/Dns6.h>\r
#include <Protocol/Http.h>\r
#include <Protocol/Ip4Config2.h>\r
#include <Protocol/Ip6Config.h>\r
//\r
// Produced Protocols\r
//\r
#include <Protocol/LoadFile.h>\r
\r
//\r
// Driver Version\r
//\r
#define HTTP_BOOT_DXE_VERSION  0xa\r
\r
//\r
// Protocol instances\r
//\r
extern EFI_DRIVER_BINDING_PROTOCOL  gHttpBootDxeDriverBinding;\r
extern EFI_COMPONENT_NAME2_PROTOCOL gHttpBootDxeComponentName2;\r
extern EFI_COMPONENT_NAME_PROTOCOL  gHttpBootDxeComponentName;\r
\r
//\r
// Private data structure\r
//\r
typedef struct _HTTP_BOOT_PRIVATE_DATA      HTTP_BOOT_PRIVATE_DATA;\r
typedef struct _HTTP_BOOT_VIRTUAL_NIC       HTTP_BOOT_VIRTUAL_NIC;\r
\r
//\r
// Include files with internal function prototypes\r
//\r
#include "HttpBootComponentName.h"\r
#include "HttpBootDhcp4.h"\r
#include "HttpBootDhcp6.h"\r
#include "HttpBootImpl.h"\r
#include "HttpBootSupport.h"\r
#include "HttpBootClient.h"\r
\r
typedef union {\r
  HTTP_BOOT_DHCP4_PACKET_CACHE              Dhcp4;\r
  HTTP_BOOT_DHCP6_PACKET_CACHE              Dhcp6;\r
} HTTP_BOOT_DHCP_PACKET_CACHE;\r
\r
struct _HTTP_BOOT_VIRTUAL_NIC {\r
  UINT32                                    Signature;\r
  EFI_HANDLE                                Controller;\r
  EFI_LOAD_FILE_PROTOCOL                    LoadFile;\r
  EFI_DEVICE_PATH_PROTOCOL                  *DevicePath;\r
  HTTP_BOOT_PRIVATE_DATA                    *Private;\r
};\r
\r
struct _HTTP_BOOT_PRIVATE_DATA {\r
  UINT32                                    Signature;\r
  EFI_HANDLE                                Controller;\r
  EFI_HANDLE                                Image;\r
\r
  HTTP_BOOT_VIRTUAL_NIC                     *Ip4Nic;\r
  HTTP_BOOT_VIRTUAL_NIC                     *Ip6Nic;\r
\r
  //\r
  // Cousumed children\r
  //\r
  EFI_HANDLE                                Ip6Child;\r
  EFI_HANDLE                                Dhcp4Child;\r
  EFI_HANDLE                                Dhcp6Child;\r
  HTTP_IO                                   HttpIo;\r
  BOOLEAN                                   HttpCreated;\r
\r
  //\r
  // Consumed protocol\r
  //\r
  EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL *Nii;\r
  EFI_IP6_PROTOCOL                          *Ip6;\r
  EFI_IP4_CONFIG2_PROTOCOL                  *Ip4Config2;\r
  EFI_IP6_CONFIG_PROTOCOL                   *Ip6Config;\r
  EFI_DHCP4_PROTOCOL                        *Dhcp4;\r
  EFI_DHCP6_PROTOCOL                        *Dhcp6;\r
  EFI_DEVICE_PATH_PROTOCOL                  *ParentDevicePath;\r
\r
  \r
  //\r
  // Produced protocol\r
  //\r
  EFI_LOAD_FILE_PROTOCOL                    LoadFile;\r
  EFI_DEVICE_PATH_PROTOCOL                  *DevicePath;\r
  UINT32                                    Id;\r
\r
  //\r
  // Mode data\r
  //\r
  BOOLEAN                                   UsingIpv6;\r
  BOOLEAN                                   Started;\r
  EFI_IP_ADDRESS                            StationIp;\r
  EFI_IP_ADDRESS                            SubnetMask;\r
  EFI_IP_ADDRESS                            GatewayIp;\r
  EFI_IP_ADDRESS                            ServerIp;\r
  UINT16                                    Port;\r
  CHAR8                                     *BootFileUri;\r
  VOID                                      *BootFileUriParser;\r
  UINTN                                     BootFileSize;\r
  BOOLEAN                                   NoGateway;\r
\r
  //\r
  // Cached HTTP data\r
  //\r
  LIST_ENTRY                                CacheList;\r
\r
  //\r
  // Cached DHCP offer\r
  //\r
  // OfferIndex records the index of DhcpOffer[] buffer, and OfferCount records the num of each type of offer.\r
  //\r
  // It supposed that\r
  //\r
  //   OfferNum:    8\r
  //   OfferBuffer: [ProxyNameUri, DhcpNameUri, DhcpIpUri, ProxyNameUri, ProxyIpUri, DhcpOnly, DhcpIpUri, DhcpNameUriDns]\r
  //   (OfferBuffer is 0-based.)\r
  //\r
  // And assume that (DhcpIpUri is the first priority actually.)\r
  //\r
  //   SelectIndex:     5\r
  //   SelectProxyType: HttpOfferTypeProxyIpUri\r
  //   (SelectIndex is 1-based, and 0 means no one is selected.)\r
  //\r
  // So it should be\r
  //\r
  //                 DhcpIpUri  DhcpNameUriDns  DhcpDns  DhcpOnly  ProxyNameUri  ProxyIpUri  DhcpNameUri\r
  //   OfferCount:  [       2,              1,       0,        1,            2,          1,            1]\r
  //\r
  //   OfferIndex: {[       2,              7,       0,        5,            0,         *4,            1]\r
  //                [       6,              0,       0,        0,            3,          0,            0]\r
  //                [       0,              0,       0,        0,            0,          0,            0]\r
  //                ...                                                                                 ]}\r
  //   (OfferIndex is 0-based.)\r
  //\r
  //\r
  UINT32                                    SelectIndex;\r
  UINT32                                    SelectProxyType;\r
  HTTP_BOOT_DHCP_PACKET_CACHE               OfferBuffer[HTTP_BOOT_OFFER_MAX_NUM];\r
  UINT32                                    OfferNum;\r
  UINT32                                    OfferCount[HttpOfferTypeMax];\r
  UINT32                                    OfferIndex[HttpOfferTypeMax][HTTP_BOOT_OFFER_MAX_NUM];\r
};\r
\r
#define HTTP_BOOT_PRIVATE_DATA_SIGNATURE          SIGNATURE_32 ('H', 'B', 'P', 'D')\r
#define HTTP_BOOT_VIRTUAL_NIC_SIGNATURE           SIGNATURE_32 ('H', 'B', 'V', 'N')\r
#define HTTP_BOOT_PRIVATE_DATA_FROM_LOADFILE(a)   CR (a, HTTP_BOOT_PRIVATE_DATA, LoadFile, HTTP_BOOT_PRIVATE_DATA_SIGNATURE)\r
#define HTTP_BOOT_PRIVATE_DATA_FROM_ID(a)         CR (a, HTTP_BOOT_PRIVATE_DATA, Id, HTTP_BOOT_PRIVATE_DATA_SIGNATURE)\r
#define HTTP_BOOT_VIRTUAL_NIC_FROM_LOADFILE(a)    CR (a, HTTP_BOOT_VIRTUAL_NIC, LoadFile, HTTP_BOOT_VIRTUAL_NIC_SIGNATURE)\r
extern EFI_LOAD_FILE_PROTOCOL               gHttpBootDxeLoadFile;\r
\r
/**\r
  Tests to see if this driver supports a given controller. If a child device is provided, \r
  it further tests to see if this driver supports creating a handle for the specified child device.\r
\r
  This function checks to see if the driver specified by This supports the device specified by \r
  ControllerHandle. Drivers will typically use the device path attached to \r
  ControllerHandle and/or the services from the bus I/O abstraction attached to \r
  ControllerHandle to determine if the driver supports ControllerHandle. This function \r
  may be called many times during platform initialization. In order to reduce boot times, the tests \r
  performed by this function must be very small, and take as little time as possible to execute. This \r
  function must not change the state of any hardware devices, and this function must be aware that the \r
  device specified by ControllerHandle may already be managed by the same driver or a \r
  different driver. This function must match its calls to AllocatePages() with FreePages(), \r
  AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().  \r
  Because ControllerHandle may have been previously started by the same driver, if a protocol is \r
  already in the opened state, then it must not be closed with CloseProtocol(). This is required \r
  to guarantee the state of ControllerHandle is not modified by this function.\r
\r
  @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle     The handle of the controller to test. This handle \r
                                   must support a protocol interface that supplies \r
                                   an I/O abstraction to the driver.\r
  @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This \r
                                   parameter is ignored by device drivers, and is optional for bus \r
                                   drivers. For bus drivers, if this parameter is not NULL, then \r
                                   the bus driver must determine if the bus controller specified \r
                                   by ControllerHandle and the child controller specified \r
                                   by RemainingDevicePath are both supported by this \r
                                   bus driver.\r
\r
  @retval EFI_SUCCESS              The device specified by ControllerHandle and\r
                                   RemainingDevicePath is supported by the driver specified by This.\r
  @retval EFI_ALREADY_STARTED      The device specified by ControllerHandle and\r
                                   RemainingDevicePath is already being managed by the driver\r
                                   specified by This.\r
  @retval EFI_ACCESS_DENIED        The device specified by ControllerHandle and\r
                                   RemainingDevicePath is already being managed by a different\r
                                   driver or an application that requires exclusive access.\r
                                   Currently not implemented.\r
  @retval EFI_UNSUPPORTED          The device specified by ControllerHandle and\r
                                   RemainingDevicePath is not supported by the driver specified by This.\r
**/\r
EFI_STATUS\r
EFIAPI\r
HttpBootIp4DxeDriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  );\r
\r
/**\r
  Starts a device controller or a bus controller.\r
\r
  The Start() function is designed to be invoked from the EFI boot service ConnectController().\r
  As a result, much of the error checking on the parameters to Start() has been moved into this \r
  common boot service. It is legal to call Start() from other locations, \r
  but the following calling restrictions must be followed, or the system behavior will not be deterministic.\r
  1. ControllerHandle must be a valid EFI_HANDLE.\r
  2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned\r
     EFI_DEVICE_PATH_PROTOCOL.\r
  3. Prior to calling Start(), the Supported() function for the driver specified by This must\r
     have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.  \r
\r
  @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle     The handle of the controller to start. This handle \r
                                   must support a protocol interface that supplies \r
                                   an I/O abstraction to the driver.\r
  @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This \r
                                   parameter is ignored by device drivers, and is optional for bus \r
                                   drivers. For a bus driver, if this parameter is NULL, then handles \r
                                   for all the children of Controller are created by this driver.  \r
                                   If this parameter is not NULL and the first Device Path Node is \r
                                   not the End of Device Path Node, then only the handle for the \r
                                   child device specified by the first Device Path Node of \r
                                   RemainingDevicePath is created by this driver.\r
                                   If the first Device Path Node of RemainingDevicePath is \r
                                   the End of Device Path Node, no child handle is created by this\r
                                   driver.\r
\r
  @retval EFI_SUCCESS              The device was started.\r
  @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.\r
  @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.\r
  @retval Others                   The driver failded to start the device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HttpBootIp4DxeDriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  );\r
\r
/**\r
  Stops a device controller or a bus controller.\r
  \r
  The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). \r
  As a result, much of the error checking on the parameters to Stop() has been moved \r
  into this common boot service. It is legal to call Stop() from other locations, \r
  but the following calling restrictions must be followed, or the system behavior will not be deterministic.\r
  1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this\r
     same driver's Start() function.\r
  2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid\r
     EFI_HANDLE. In addition, all of these handles must have been created in this driver's\r
     Start() function, and the Start() function must have called OpenProtocol() on\r
     ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.\r
  \r
  @param[in]  This              A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle  A handle to the device being stopped. The handle must \r
                                support a bus specific I/O protocol for the driver \r
                                to use to stop the device.\r
  @param[in]  NumberOfChildren  The number of child device handles in ChildHandleBuffer.\r
  @param[in]  ChildHandleBuffer An array of child handles to be freed. May be NULL \r
                                if NumberOfChildren is 0.\r
\r
  @retval EFI_SUCCESS           The device was stopped.\r
  @retval EFI_DEVICE_ERROR      The device could not be stopped due to a device error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HttpBootIp4DxeDriverBindingStop (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN UINTN                        NumberOfChildren,\r
  IN EFI_HANDLE                   *ChildHandleBuffer OPTIONAL\r
  );\r
\r
/**\r
  Tests to see if this driver supports a given controller. If a child device is provided, \r
  it further tests to see if this driver supports creating a handle for the specified child device.\r
\r
  This function checks to see if the driver specified by This supports the device specified by \r
  ControllerHandle. Drivers will typically use the device path attached to \r
  ControllerHandle and/or the services from the bus I/O abstraction attached to \r
  ControllerHandle to determine if the driver supports ControllerHandle. This function \r
  may be called many times during platform initialization. In order to reduce boot times, the tests \r
  performed by this function must be very small, and take as little time as possible to execute. This \r
  function must not change the state of any hardware devices, and this function must be aware that the \r
  device specified by ControllerHandle may already be managed by the same driver or a \r
  different driver. This function must match its calls to AllocatePages() with FreePages(), \r
  AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().  \r
  Because ControllerHandle may have been previously started by the same driver, if a protocol is \r
  already in the opened state, then it must not be closed with CloseProtocol(). This is required \r
  to guarantee the state of ControllerHandle is not modified by this function.\r
\r
  @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle     The handle of the controller to test. This handle \r
                                   must support a protocol interface that supplies \r
                                   an I/O abstraction to the driver.\r
  @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This \r
                                   parameter is ignored by device drivers, and is optional for bus \r
                                   drivers. For bus drivers, if this parameter is not NULL, then \r
                                   the bus driver must determine if the bus controller specified \r
                                   by ControllerHandle and the child controller specified \r
                                   by RemainingDevicePath are both supported by this \r
                                   bus driver.\r
\r
  @retval EFI_SUCCESS              The device specified by ControllerHandle and\r
                                   RemainingDevicePath is supported by the driver specified by This.\r
  @retval EFI_ALREADY_STARTED      The device specified by ControllerHandle and\r
                                   RemainingDevicePath is already being managed by the driver\r
                                   specified by This.\r
  @retval EFI_ACCESS_DENIED        The device specified by ControllerHandle and\r
                                   RemainingDevicePath is already being managed by a different\r
                                   driver or an application that requires exclusive access.\r
                                   Currently not implemented.\r
  @retval EFI_UNSUPPORTED          The device specified by ControllerHandle and\r
                                   RemainingDevicePath is not supported by the driver specified by This.\r
**/\r
EFI_STATUS\r
EFIAPI\r
HttpBootIp6DxeDriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  );\r
\r
/**\r
  Starts a device controller or a bus controller.\r
\r
  The Start() function is designed to be invoked from the EFI boot service ConnectController().\r
  As a result, much of the error checking on the parameters to Start() has been moved into this \r
  common boot service. It is legal to call Start() from other locations, \r
  but the following calling restrictions must be followed, or the system behavior will not be deterministic.\r
  1. ControllerHandle must be a valid EFI_HANDLE.\r
  2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned\r
     EFI_DEVICE_PATH_PROTOCOL.\r
  3. Prior to calling Start(), the Supported() function for the driver specified by This must\r
     have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.  \r
\r
  @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle     The handle of the controller to start. This handle \r
                                   must support a protocol interface that supplies \r
                                   an I/O abstraction to the driver.\r
  @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This \r
                                   parameter is ignored by device drivers, and is optional for bus \r
                                   drivers. For a bus driver, if this parameter is NULL, then handles \r
                                   for all the children of Controller are created by this driver.  \r
                                   If this parameter is not NULL and the first Device Path Node is \r
                                   not the End of Device Path Node, then only the handle for the \r
                                   child device specified by the first Device Path Node of \r
                                   RemainingDevicePath is created by this driver.\r
                                   If the first Device Path Node of RemainingDevicePath is \r
                                   the End of Device Path Node, no child handle is created by this\r
                                   driver.\r
\r
  @retval EFI_SUCCESS              The device was started.\r
  @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.\r
  @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.\r
  @retval Others                   The driver failded to start the device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HttpBootIp6DxeDriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  );\r
\r
/**\r
  Stops a device controller or a bus controller.\r
  \r
  The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). \r
  As a result, much of the error checking on the parameters to Stop() has been moved \r
  into this common boot service. It is legal to call Stop() from other locations, \r
  but the following calling restrictions must be followed, or the system behavior will not be deterministic.\r
  1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this\r
     same driver's Start() function.\r
  2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid\r
     EFI_HANDLE. In addition, all of these handles must have been created in this driver's\r
     Start() function, and the Start() function must have called OpenProtocol() on\r
     ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.\r
  \r
  @param[in]  This              A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle  A handle to the device being stopped. The handle must \r
                                support a bus specific I/O protocol for the driver \r
                                to use to stop the device.\r
  @param[in]  NumberOfChildren  The number of child device handles in ChildHandleBuffer.\r
  @param[in]  ChildHandleBuffer An array of child handles to be freed. May be NULL \r
                                if NumberOfChildren is 0.\r
\r
  @retval EFI_SUCCESS           The device was stopped.\r
  @retval EFI_DEVICE_ERROR      The device could not be stopped due to a device error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HttpBootIp6DxeDriverBindingStop (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN UINTN                        NumberOfChildren,\r
  IN EFI_HANDLE                   *ChildHandleBuffer OPTIONAL\r
  );\r
#endif\r