NetworkPkg:Enable Http Boot over Ipv6 stack

Add new features to support Http boot over ipv6 stack.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Zhang Lubo <lubo.zhang@intel.com>
Reviewed-by: Fu Siyuan <siyuan.fu@intel.com>
Reviewed-by: Ye Ting <ting.ye@intel.com>
Reviewed-by: Wu Jiaxin <jiaxin.wu@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@18743 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 153 insertions, 6 deletions

diff --git a/NetworkPkg/HttpBootDxe/HttpBootDxe.h b/NetworkPkg/HttpBootDxe/HttpBootDxe.h
index 08415f6e0c..452c8f4906 100644
--- a/NetworkPkg/HttpBootDxe/HttpBootDxe.h
+++ b/NetworkPkg/HttpBootDxe/HttpBootDxe.h
@@ -41,9 +41,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 //

 #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>

 //

 // Produced Protocols

 //

@@ -65,29 +67,45 @@ 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;

 

 //

 // Include files with internal function prototypes

 //

 #include "HttpBootComponentName.h"

 #include "HttpBootDhcp4.h"

+#include "HttpBootDhcp6.h"

 #include "HttpBootImpl.h"

 #include "HttpBootSupport.h"

 #include "HttpBootClient.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_LOAD_FILE_PROTOCOL                    LoadFile;

+  EFI_DEVICE_PATH_PROTOCOL                  *DevicePath;

+  HTTP_BOOT_PRIVATE_DATA                    *Private;

+};

+

 struct _HTTP_BOOT_PRIVATE_DATA {

   UINT32                                    Signature;

   EFI_HANDLE                                Controller;

   EFI_HANDLE                                Image;

 

+  HTTP_BOOT_VIRTUAL_NIC                     *Ip4Nic;

+  HTTP_BOOT_VIRTUAL_NIC                     *Ip6Nic;

+

   //

   // Cousumed children

   //

+  EFI_HANDLE                                Ip6Child;

   EFI_HANDLE                                Dhcp4Child;

+  EFI_HANDLE                                Dhcp6Child;

   HTTP_IO                                   HttpIo;

   BOOLEAN                                   HttpCreated;

 

@@ -95,14 +113,13 @@ struct _HTTP_BOOT_PRIVATE_DATA {
   // 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 children

-  //

-  EFI_HANDLE                                ChildHandle;

   

   //

   // Produced protocol

@@ -119,10 +136,12 @@ struct _HTTP_BOOT_PRIVATE_DATA {
   EFI_IP_ADDRESS                            StationIp;

   EFI_IP_ADDRESS                            SubnetMask;

   EFI_IP_ADDRESS                            GatewayIp;

+  EFI_IP_ADDRESS                            ServerIp;

   UINT16                                    Port;

   CHAR8                                     *BootFileUri;

   VOID                                      *BootFileUriParser;

   UINTN                                     BootFileSize;

+  BOOLEAN                                   NoGateway;

 

   //

   // Cached HTTP data

@@ -167,9 +186,10 @@ struct _HTTP_BOOT_PRIVATE_DATA {
 };

 

 #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;

 

 /**

@@ -300,4 +320,131 @@ HttpBootIp4DxeDriverBindingStop (
   IN EFI_HANDLE                   *ChildHandleBuffer OPTIONAL

   );

 

+/**

+  Tests to see if this driver supports a given controller. If a child device is provided, 

+  it further tests to see if this driver supports creating a handle for the specified child device.

+

+  This function checks to see if the driver specified by This supports the device specified by 

+  ControllerHandle. Drivers will typically use the device path attached to 

+  ControllerHandle and/or the services from the bus I/O abstraction attached to 

+  ControllerHandle to determine if the driver supports ControllerHandle. This function 

+  may be called many times during platform initialization. In order to reduce boot times, the tests 

+  performed by this function must be very small, and take as little time as possible to execute. This 

+  function must not change the state of any hardware devices, and this function must be aware that the 

+  device specified by ControllerHandle may already be managed by the same driver or a 

+  different driver. This function must match its calls to AllocatePages() with FreePages(), 

+  AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().  

+  Because ControllerHandle may have been previously started by the same driver, if a protocol is 

+  already in the opened state, then it must not be closed with CloseProtocol(). This is required 

+  to guarantee the state of ControllerHandle is not modified by this function.

+

+  @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.

+  @param[in]  ControllerHandle     The handle of the controller to test. This handle 

+                                   must support a protocol interface that supplies 

+                                   an I/O abstraction to the driver.

+  @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This 

+                                   parameter is ignored by device drivers, and is optional for bus 

+                                   drivers. For bus drivers, if this parameter is not NULL, then 

+                                   the bus driver must determine if the bus controller specified 

+                                   by ControllerHandle and the child controller specified 

+                                   by RemainingDevicePath are both supported by this 

+                                   bus driver.

+

+  @retval EFI_SUCCESS              The device specified by ControllerHandle and

+                                   RemainingDevicePath is supported by the driver specified by This.

+  @retval EFI_ALREADY_STARTED      The device specified by ControllerHandle and

+                                   RemainingDevicePath is already being managed by the driver

+                                   specified by This.

+  @retval EFI_ACCESS_DENIED        The device specified by ControllerHandle and

+                                   RemainingDevicePath is already being managed by a different

+                                   driver or an application that requires exclusive access.

+                                   Currently not implemented.

+  @retval EFI_UNSUPPORTED          The device specified by ControllerHandle and

+                                   RemainingDevicePath is not supported by the driver specified by This.

+**/

+EFI_STATUS

+EFIAPI

+HttpBootIp6DxeDriverBindingSupported (

+  IN EFI_DRIVER_BINDING_PROTOCOL  *This,

+  IN EFI_HANDLE                   ControllerHandle,

+  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL

+  );

+

+/**

+  Starts a device controller or a bus controller.

+

+  The Start() function is designed to be invoked from the EFI boot service ConnectController().

+  As a result, much of the error checking on the parameters to Start() has been moved into this 

+  common boot service. It is legal to call Start() from other locations, 

+  but the following calling restrictions must be followed, or the system behavior will not be deterministic.

+  1. ControllerHandle must be a valid EFI_HANDLE.

+  2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned

+     EFI_DEVICE_PATH_PROTOCOL.

+  3. Prior to calling Start(), the Supported() function for the driver specified by This must

+     have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.  

+

+  @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.

+  @param[in]  ControllerHandle     The handle of the controller to start. This handle 

+                                   must support a protocol interface that supplies 

+                                   an I/O abstraction to the driver.

+  @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This 

+                                   parameter is ignored by device drivers, and is optional for bus 

+                                   drivers. For a bus driver, if this parameter is NULL, then handles 

+                                   for all the children of Controller are created by this driver.  

+                                   If this parameter is not NULL and the first Device Path Node is 

+                                   not the End of Device Path Node, then only the handle for the 

+                                   child device specified by the first Device Path Node of 

+                                   RemainingDevicePath is created by this driver.

+                                   If the first Device Path Node of RemainingDevicePath is 

+                                   the End of Device Path Node, no child handle is created by this

+                                   driver.

+

+  @retval EFI_SUCCESS              The device was started.

+  @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.

+  @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.

+  @retval Others                   The driver failded to start the device.

+

+**/

+EFI_STATUS

+EFIAPI

+HttpBootIp6DxeDriverBindingStart (

+  IN EFI_DRIVER_BINDING_PROTOCOL  *This,

+  IN EFI_HANDLE                   ControllerHandle,

+  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL

+  );

+

+/**

+  Stops a device controller or a bus controller.

+  

+  The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). 

+  As a result, much of the error checking on the parameters to Stop() has been moved 

+  into this common boot service. It is legal to call Stop() from other locations, 

+  but the following calling restrictions must be followed, or the system behavior will not be deterministic.

+  1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this

+     same driver's Start() function.

+  2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid

+     EFI_HANDLE. In addition, all of these handles must have been created in this driver's

+     Start() function, and the Start() function must have called OpenProtocol() on

+     ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.

+  

+  @param[in]  This              A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.

+  @param[in]  ControllerHandle  A handle to the device being stopped. The handle must 

+                                support a bus specific I/O protocol for the driver 

+                                to use to stop the device.

+  @param[in]  NumberOfChildren  The number of child device handles in ChildHandleBuffer.

+  @param[in]  ChildHandleBuffer An array of child handles to be freed. May be NULL 

+                                if NumberOfChildren is 0.

+

+  @retval EFI_SUCCESS           The device was stopped.

+  @retval EFI_DEVICE_ERROR      The device could not be stopped due to a device error.

+

+**/

+EFI_STATUS

+EFIAPI

+HttpBootIp6DxeDriverBindingStop (

+  IN EFI_DRIVER_BINDING_PROTOCOL  *This,

+  IN EFI_HANDLE                   ControllerHandle,

+  IN UINTN                        NumberOfChildren,

+  IN EFI_HANDLE                   *ChildHandleBuffer OPTIONAL

+  );

 #endif