TianoCore EDK2 master
Loading...
Searching...
No Matches
HttpBootDxe.h File Reference

Go to the source code of this file.

Data Structures

union  HTTP_BOOT_DHCP_PACKET_CACHE
 
struct  _HTTP_BOOT_VIRTUAL_NIC
 
struct  _HTTP_BOOT_PRIVATE_DATA
 

Macros

#define HTTP_BOOT_DXE_VERSION   0xa
 
#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"
 
#define HTTP_BOOT_PRIVATE_DATA_FROM_CALLBACK_INFO(Callback)
 
#define HTTP_BOOT_PRIVATE_DATA_FROM_CALLBACK_PROTOCOL(CallbackProtocol)
 
#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)
 

Typedefs

typedef struct _HTTP_BOOT_PRIVATE_DATA HTTP_BOOT_PRIVATE_DATA
 
typedef struct _HTTP_BOOT_VIRTUAL_NIC HTTP_BOOT_VIRTUAL_NIC
 

Enumerations

enum  HTTP_BOOT_IMAGE_TYPE { ImageTypeEfi , ImageTypeVirtualCd , ImageTypeVirtualDisk , ImageTypeMax }
 

Functions

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)
 

Variables

EFI_DRIVER_BINDING_PROTOCOL gHttpBootDxeDriverBinding
 
EFI_COMPONENT_NAME2_PROTOCOL gHttpBootDxeComponentName2
 
EFI_COMPONENT_NAME_PROTOCOL gHttpBootDxeComponentName
 
EFI_LOAD_FILE_PROTOCOL gHttpBootDxeLoadFile
 

Detailed Description

UEFI HTTP boot driver's private data structure and interfaces declaration.

Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
(C) Copyright 2016 - 2020 Hewlett Packard Enterprise Development LP
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file HttpBootDxe.h.

Macro Definition Documentation

◆ HTTP_BOOT_DXE_VERSION

#define HTTP_BOOT_DXE_VERSION   0xa

Definition at line 72 of file HttpBootDxe.h.

◆ HTTP_BOOT_PRIVATE_DATA_FROM_CALLBACK_INFO

#define HTTP_BOOT_PRIVATE_DATA_FROM_CALLBACK_INFO (   Callback)
Value:
CR ( \
Callback, \
CallbackInfo, \
HTTP_BOOT_PRIVATE_DATA_SIGNATURE \
)
#define CR(Record, TYPE, Field, TestSignature)
Definition: DebugLib.h:659

Definition at line 127 of file HttpBootDxe.h.

◆ HTTP_BOOT_PRIVATE_DATA_FROM_CALLBACK_PROTOCOL

#define HTTP_BOOT_PRIVATE_DATA_FROM_CALLBACK_PROTOCOL (   CallbackProtocol)
Value:
CR ( \
CallbackProtocol, \
LoadFileCallback, \
HTTP_BOOT_PRIVATE_DATA_SIGNATURE \
)

Definition at line 135 of file HttpBootDxe.h.

◆ HTTP_BOOT_PRIVATE_DATA_FROM_ID

#define HTTP_BOOT_PRIVATE_DATA_FROM_ID (   a)    CR (a, HTTP_BOOT_PRIVATE_DATA, Id, HTTP_BOOT_PRIVATE_DATA_SIGNATURE)

Definition at line 273 of file HttpBootDxe.h.

◆ HTTP_BOOT_PRIVATE_DATA_FROM_LOADFILE

#define HTTP_BOOT_PRIVATE_DATA_FROM_LOADFILE (   a)    CR (a, HTTP_BOOT_PRIVATE_DATA, LoadFile, HTTP_BOOT_PRIVATE_DATA_SIGNATURE)

Definition at line 272 of file HttpBootDxe.h.

◆ HTTP_BOOT_PRIVATE_DATA_SIGNATURE

#define HTTP_BOOT_PRIVATE_DATA_SIGNATURE   SIGNATURE_32 ('H', 'B', 'P', 'D')

Definition at line 270 of file HttpBootDxe.h.

◆ HTTP_BOOT_VIRTUAL_NIC_FROM_LOADFILE

#define HTTP_BOOT_VIRTUAL_NIC_FROM_LOADFILE (   a)    CR (a, HTTP_BOOT_VIRTUAL_NIC, LoadFile, HTTP_BOOT_VIRTUAL_NIC_SIGNATURE)

Definition at line 274 of file HttpBootDxe.h.

◆ HTTP_BOOT_VIRTUAL_NIC_SIGNATURE

#define HTTP_BOOT_VIRTUAL_NIC_SIGNATURE   SIGNATURE_32 ('H', 'B', 'V', 'N')

Definition at line 271 of file HttpBootDxe.h.

◆ HTTP_CONTENT_TYPE_APP_EFI

#define HTTP_CONTENT_TYPE_APP_EFI   "application/efi"

Definition at line 78 of file HttpBootDxe.h.

◆ HTTP_CONTENT_TYPE_APP_IMG

#define HTTP_CONTENT_TYPE_APP_IMG   "application/vnd.efi-img"

Definition at line 79 of file HttpBootDxe.h.

◆ HTTP_CONTENT_TYPE_APP_ISO

#define HTTP_CONTENT_TYPE_APP_ISO   "application/vnd.efi-iso"

Definition at line 80 of file HttpBootDxe.h.

Typedef Documentation

◆ HTTP_BOOT_PRIVATE_DATA

Definition at line 92 of file HttpBootDxe.h.

◆ HTTP_BOOT_VIRTUAL_NIC

Definition at line 93 of file HttpBootDxe.h.

Enumeration Type Documentation

◆ HTTP_BOOT_IMAGE_TYPE

enum HTTP_BOOT_IMAGE_TYPE

Definition at line 95 of file HttpBootDxe.h.

Function Documentation

◆ HttpBootIp4DxeDriverBindingStart()

EFI_STATUS EFIAPI HttpBootIp4DxeDriverBindingStart ( 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.
Parameters
[in]ThisA pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
[in]ControllerHandleThe handle of the controller to start. This handle must support a protocol interface that supplies an I/O abstraction to the driver.
[in]RemainingDevicePathA 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.
Return values
EFI_SUCCESSThe device was started.
EFI_DEVICE_ERRORThe device could not be started due to a device error.Currently not implemented.
EFI_OUT_OF_RESOURCESThe request could not be completed due to a lack of resources.
OthersThe driver failed to start the device.

Definition at line 384 of file HttpBootDxe.c.

◆ HttpBootIp4DxeDriverBindingStop()

EFI_STATUS EFIAPI HttpBootIp4DxeDriverBindingStop ( IN EFI_DRIVER_BINDING_PROTOCOL This,
IN EFI_HANDLE  ControllerHandle,
IN UINTN  NumberOfChildren,
IN EFI_HANDLE *ChildHandleBuffer  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.
Parameters
[in]ThisA pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
[in]ControllerHandleA 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.
[in]NumberOfChildrenThe number of child device handles in ChildHandleBuffer.
[in]ChildHandleBufferAn array of child handles to be freed. May be NULL if NumberOfChildren is 0.
Return values
EFI_SUCCESSThe device was stopped.
EFI_DEVICE_ERRORThe device could not be stopped due to a device error.

Definition at line 657 of file HttpBootDxe.c.

◆ HttpBootIp4DxeDriverBindingSupported()

EFI_STATUS EFIAPI HttpBootIp4DxeDriverBindingSupported ( IN EFI_DRIVER_BINDING_PROTOCOL This,
IN EFI_HANDLE  ControllerHandle,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath  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.

Parameters
[in]ThisA pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
[in]ControllerHandleThe handle of the controller to test. This handle must support a protocol interface that supplies an I/O abstraction to the driver.
[in]RemainingDevicePathA 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.
Return values
EFI_SUCCESSThe device specified by ControllerHandle and RemainingDevicePath is supported by the driver specified by This.
EFI_ALREADY_STARTEDThe device specified by ControllerHandle and RemainingDevicePath is already being managed by the driver specified by This.
EFI_ACCESS_DENIEDThe device specified by ControllerHandle and RemainingDevicePath is already being managed by a different driver or an application that requires exclusive access. Currently not implemented.
EFI_UNSUPPORTEDThe device specified by ControllerHandle and RemainingDevicePath is not supported by the driver specified by This.

Definition at line 300 of file HttpBootDxe.c.

◆ HttpBootIp6DxeDriverBindingStart()

EFI_STATUS EFIAPI HttpBootIp6DxeDriverBindingStart ( 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.
Parameters
[in]ThisA pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
[in]ControllerHandleThe handle of the controller to start. This handle must support a protocol interface that supplies an I/O abstraction to the driver.
[in]RemainingDevicePathA 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.
Return values
EFI_SUCCESSThe device was started.
EFI_DEVICE_ERRORThe device could not be started due to a device error.Currently not implemented.
EFI_OUT_OF_RESOURCESThe request could not be completed due to a lack of resources.
OthersThe driver failed to start the device.

Definition at line 874 of file HttpBootDxe.c.

◆ HttpBootIp6DxeDriverBindingStop()

EFI_STATUS EFIAPI HttpBootIp6DxeDriverBindingStop ( IN EFI_DRIVER_BINDING_PROTOCOL This,
IN EFI_HANDLE  ControllerHandle,
IN UINTN  NumberOfChildren,
IN EFI_HANDLE *ChildHandleBuffer  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.
Parameters
[in]ThisA pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
[in]ControllerHandleA 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.
[in]NumberOfChildrenThe number of child device handles in ChildHandleBuffer.
[in]ChildHandleBufferAn array of child handles to be freed. May be NULL if NumberOfChildren is 0.
Return values
EFI_SUCCESSThe device was stopped.
EFI_DEVICE_ERRORThe device could not be stopped due to a device error.

Definition at line 1189 of file HttpBootDxe.c.

◆ HttpBootIp6DxeDriverBindingSupported()

EFI_STATUS EFIAPI HttpBootIp6DxeDriverBindingSupported ( IN EFI_DRIVER_BINDING_PROTOCOL This,
IN EFI_HANDLE  ControllerHandle,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath  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.

Parameters
[in]ThisA pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
[in]ControllerHandleThe handle of the controller to test. This handle must support a protocol interface that supplies an I/O abstraction to the driver.
[in]RemainingDevicePathA 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.
Return values
EFI_SUCCESSThe device specified by ControllerHandle and RemainingDevicePath is supported by the driver specified by This.
EFI_ALREADY_STARTEDThe device specified by ControllerHandle and RemainingDevicePath is already being managed by the driver specified by This.
EFI_ACCESS_DENIEDThe device specified by ControllerHandle and RemainingDevicePath is already being managed by a different driver or an application that requires exclusive access. Currently not implemented.
EFI_UNSUPPORTEDThe device specified by ControllerHandle and RemainingDevicePath is not supported by the driver specified by This.

Definition at line 790 of file HttpBootDxe.c.

Variable Documentation

◆ gHttpBootDxeComponentName

EFI_COMPONENT_NAME_PROTOCOL gHttpBootDxeComponentName
extern

Component Name Protocol instance

Definition at line 15 of file HttpBootComponentName.c.

◆ gHttpBootDxeComponentName2

EFI_COMPONENT_NAME2_PROTOCOL gHttpBootDxeComponentName2
extern

Component Name 2 Protocol instance

Definition at line 25 of file HttpBootComponentName.c.

◆ gHttpBootDxeLoadFile

EFI_LOAD_FILE_PROTOCOL gHttpBootDxeLoadFile
extern

Load File Protocol instance

Definition at line 759 of file HttpBootImpl.c.