| /** @file | |
| UEFI HTTP boot driver's private data structure and interfaces declaration. | |
| Copyright (c) 2015, Intel Corporation. All rights reserved.<BR> | |
| This program and the accompanying materials are licensed and made available under | |
| the terms and conditions of the BSD License that accompanies this distribution. | |
| The full text of the license may be found at | |
| http://opensource.org/licenses/bsd-license.php. | |
| THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, | |
| WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. | |
| **/ | |
| #ifndef __EFI_HTTP_BOOT_DXE_H__ | |
| #define __EFI_HTTP_BOOT_DXE_H__ | |
| #include <Uefi.h> | |
| // | |
| // Libraries | |
| // | |
| #include <Library/UefiBootServicesTableLib.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> | |
| // | |
| // UEFI Driver Model Protocols | |
| // | |
| #include <Protocol/DriverBinding.h> | |
| #include <Protocol/ComponentName2.h> | |
| #include <Protocol/ComponentName.h> | |
| // | |
| // Consumed Protocols | |
| // | |
| #include <Protocol/NetworkInterfaceIdentifier.h> | |
| #include <Protocol/Dhcp4.h> | |
| #include <Protocol/Http.h> | |
| #include <Protocol/Ip4Config2.h> | |
| // | |
| // Produced Protocols | |
| // | |
| #include <Protocol/LoadFile.h> | |
| // | |
| // Driver Version | |
| // | |
| #define HTTP_BOOT_DXE_VERSION 0xa | |
| // | |
| // 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; | |
| // | |
| // Include files with internal function prototypes | |
| // | |
| #include "HttpBootComponentName.h" | |
| #include "HttpBootDhcp4.h" | |
| #include "HttpBootImpl.h" | |
| #include "HttpBootSupport.h" | |
| #include "HttpBootClient.h" | |
| typedef union { | |
| HTTP_BOOT_DHCP4_PACKET_CACHE Dhcp4; | |
| } HTTP_BOOT_DHCP_PACKET_CACHE; | |
| struct _HTTP_BOOT_PRIVATE_DATA { | |
| UINT32 Signature; | |
| EFI_HANDLE Controller; | |
| EFI_HANDLE Image; | |
| // | |
| // Cousumed children | |
| // | |
| EFI_HANDLE Dhcp4Child; | |
| HTTP_IO HttpIo; | |
| BOOLEAN HttpCreated; | |
| // | |
| // Consumed protocol | |
| // | |
| EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL *Nii; | |
| EFI_IP4_CONFIG2_PROTOCOL *Ip4Config2; | |
| EFI_DHCP4_PROTOCOL *Dhcp4; | |
| EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath; | |
| // | |
| // Produced children | |
| // | |
| EFI_HANDLE ChildHandle; | |
| // | |
| // Produced protocol | |
| // | |
| EFI_LOAD_FILE_PROTOCOL LoadFile; | |
| EFI_DEVICE_PATH_PROTOCOL *DevicePath; | |
| UINT32 Id; | |
| // | |
| // Mode data | |
| // | |
| BOOLEAN UsingIpv6; | |
| BOOLEAN Started; | |
| EFI_IP_ADDRESS StationIp; | |
| EFI_IP_ADDRESS SubnetMask; | |
| EFI_IP_ADDRESS GatewayIp; | |
| UINT16 Port; | |
| CHAR8 *BootFileUri; | |
| VOID *BootFileUriParser; | |
| UINTN BootFileSize; | |
| // | |
| // 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_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) | |
| extern EFI_LOAD_FILE_PROTOCOL gHttpBootDxeLoadFile; | |
| /** | |
| 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 | |
| HttpBootIp4DxeDriverBindingSupported ( | |
| 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 | |
| HttpBootIp4DxeDriverBindingStart ( | |
| 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 | |
| HttpBootIp4DxeDriverBindingStop ( | |
| IN EFI_DRIVER_BINDING_PROTOCOL *This, | |
| IN EFI_HANDLE ControllerHandle, | |
| IN UINTN NumberOfChildren, | |
| IN EFI_HANDLE *ChildHandleBuffer OPTIONAL | |
| ); | |
| #endif |