TianoCore EDK2 master
|
#include "HttpDriver.h"
Go to the source code of this file.
Variables | |
EFI_HTTP_UTILITIES_PROTOCOL * | mHttpUtilities = NULL |
EFI_DRIVER_BINDING_PROTOCOL | gHttpDxeIp4DriverBinding |
EFI_DRIVER_BINDING_PROTOCOL | gHttpDxeIp6DriverBinding |
The driver binding and service binding protocol for HttpDxe driver.
Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
(C) Copyright 2016 Hewlett Packard Enterprise Development LP
Copyright (c) 2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
Definition in file HttpDriver.c.
VOID HttpCleanService | ( | IN HTTP_SERVICE * | HttpService, |
IN BOOLEAN | UsingIpv6 | ||
) |
Release all the resource used the HTTP service binding instance.
[in] | HttpService | The HTTP private instance. |
[in] | UsingIpv6 | Indicate use TCP4 protocol or TCP6 protocol. if TRUE, use Tcp6 protocol. if FALSE, use Tcp4 protocol. |
Definition at line 84 of file HttpDriver.c.
EFI_STATUS HttpCreateService | ( | IN EFI_HANDLE | Controller, |
OUT HTTP_SERVICE ** | ServiceData | ||
) |
Create a HTTP driver service binding private instance.
[in] | Controller | The controller that has TCP4 service binding installed. |
[out] | ServiceData | Point to HTTP driver private instance. |
EFI_OUT_OF_RESOURCES | Failed to allocate some resources. |
EFI_SUCCESS | A new HTTP driver private instance is created. |
Definition at line 49 of file HttpDriver.c.
EFI_STATUS EFIAPI HttpDestroyChildEntryInHandleBuffer | ( | IN LIST_ENTRY * | Entry, |
IN VOID * | Context | ||
) |
Callback function which provided by user to remove one node in NetDestroyLinkList process.
[in] | Entry | The entry to be removed. |
[in] | Context | Pointer to the callback context corresponds to the Context in NetDestroyLinkList. |
EFI_INVALID_PARAMETER | Any input parameter is NULL. |
EFI_SUCCESS | The entry has been removed successfully. |
Others | Fail to remove the entry. |
Definition at line 249 of file HttpDriver.c.
EFI_STATUS EFIAPI HttpDxeDriverEntryPoint | ( | IN EFI_HANDLE | ImageHandle, |
IN EFI_SYSTEM_TABLE * | SystemTable | ||
) |
This is the declaration of an EFI image entry point. This entry point is the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including both device drivers and bus drivers.
ImageHandle | The firmware allocated handle for the UEFI image. |
SystemTable | A pointer to the EFI System Table. |
EFI_SUCCESS | The operation completed successfully. |
Others | An unexpected error occurred. |
Definition at line 175 of file HttpDriver.c.
EFI_STATUS EFIAPI HttpDxeIp4DriverBindingStart | ( | 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.
[in] | This | A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. |
[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. |
[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. |
EFI_SUCCESS | The device was started. |
EFI_ALREADY_STARTED | This device is already running on ControllerHandle. |
EFI_DEVICE_ERROR | The device could not be started due to a device error.Currently not implemented. |
EFI_OUT_OF_RESOURCES | The request could not be completed due to a lack of resources. |
Others | The driver failed to start the device. |
Definition at line 676 of file HttpDriver.c.
EFI_STATUS EFIAPI HttpDxeIp4DriverBindingStop | ( | 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.
[in] | This | A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. |
[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. |
[in] | NumberOfChildren | The number of child device handles in ChildHandleBuffer. |
[in] | ChildHandleBuffer | An array of child handles to be freed. May be NULL if NumberOfChildren is 0. |
EFI_SUCCESS | The device was stopped. |
EFI_DEVICE_ERROR | The device could not be stopped due to a device error. |
Definition at line 718 of file HttpDriver.c.
EFI_STATUS EFIAPI HttpDxeIp4DriverBindingSupported | ( | 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.
[in] | This | A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. |
[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. |
[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. |
EFI_SUCCESS | The device specified by ControllerHandle and RemainingDevicePath is supported by the driver specified by This. |
EFI_ALREADY_STARTED | The device specified by ControllerHandle and RemainingDevicePath is already being managed by the driver specified by This. |
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. |
EFI_UNSUPPORTED | The device specified by ControllerHandle and RemainingDevicePath is not supported by the driver specified by This. |
Definition at line 624 of file HttpDriver.c.
EFI_STATUS EFIAPI HttpDxeIp6DriverBindingStart | ( | 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.
[in] | This | A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. |
[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. |
[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. |
EFI_SUCCESS | The device was started. |
EFI_ALREADY_STARTED | This device is already running on ControllerHandle. |
EFI_DEVICE_ERROR | The device could not be started due to a device error.Currently not implemented. |
EFI_OUT_OF_RESOURCES | The request could not be completed due to a lack of resources. |
Others | The driver failed to start the device. |
Definition at line 830 of file HttpDriver.c.
EFI_STATUS EFIAPI HttpDxeIp6DriverBindingStop | ( | 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.
[in] | This | A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. |
[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. |
[in] | NumberOfChildren | The number of child device handles in ChildHandleBuffer. |
[in] | ChildHandleBuffer | An array of child handles to be freed. May be NULL if NumberOfChildren is 0. |
EFI_SUCCESS | The device was stopped. |
EFI_DEVICE_ERROR | The device could not be stopped due to a device error. |
Definition at line 872 of file HttpDriver.c.
EFI_STATUS EFIAPI HttpDxeIp6DriverBindingSupported | ( | 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.
[in] | This | A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. |
[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. |
[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. |
EFI_SUCCESS | The device specified by ControllerHandle and RemainingDevicePath is supported by the driver specified by This. |
EFI_ALREADY_STARTED | The device specified by ControllerHandle and RemainingDevicePath is already being managed by the driver specified by This. |
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. |
EFI_UNSUPPORTED | The device specified by ControllerHandle and RemainingDevicePath is not supported by the driver specified by This. |
Definition at line 778 of file HttpDriver.c.
EFI_STATUS EFIAPI HttpDxeStart | ( | IN EFI_DRIVER_BINDING_PROTOCOL * | This, |
IN EFI_HANDLE | ControllerHandle, | ||
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath | OPTIONAL, | ||
IN UINT8 | IpVersion | ||
) |
Start this driver on ControllerHandle. This is the worker function for HttpDxeIp4(6)DriverBindingStart.
[in] | This | The pointer to the driver binding protocol. |
[in] | ControllerHandle | The handle of device to be started. |
[in] | RemainingDevicePath | Optional parameter used to pick a specific child device to be started. |
[in] | IpVersion | IP_VERSION_4 or IP_VERSION_6. |
EFI_SUCCESS | This driver is installed to ControllerHandle. |
EFI_ALREADY_STARTED | This driver is already running on ControllerHandle. |
other | This driver does not support this device. |
Definition at line 341 of file HttpDriver.c.
EFI_STATUS EFIAPI HttpDxeStop | ( | IN EFI_DRIVER_BINDING_PROTOCOL * | This, |
IN EFI_HANDLE | ControllerHandle, | ||
IN UINTN | NumberOfChildren, | ||
IN EFI_HANDLE * | ChildHandleBuffer, | ||
IN UINT8 | IpVersion | ||
) |
Stop this driver on ControllerHandle. This is the worker function for HttpDxeIp4(6)DriverBindingStop.
[in] | This | Protocol instance pointer. |
[in] | ControllerHandle | Handle of device to stop driver on. |
[in] | NumberOfChildren | Number of Handles in ChildHandleBuffer. If number of children is zero stop the entire bus driver. |
[in] | ChildHandleBuffer | List of Child Handles to Stop. |
[in] | IpVersion | IP_VERSION_4 or IP_VERSION_6. |
EFI_SUCCESS | This driver was removed ControllerHandle. |
EFI_DEVICE_ERROR | An unexpected system or network error occurred. |
Others | This driver was not removed from this device |
Definition at line 502 of file HttpDriver.c.
EFI_STATUS EFIAPI HttpDxeSupported | ( | IN EFI_DRIVER_BINDING_PROTOCOL * | This, |
IN EFI_HANDLE | ControllerHandle, | ||
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath | OPTIONAL, | ||
IN UINT8 | IpVersion | ||
) |
Test to see if this driver supports ControllerHandle. This is the worker function for HttpDxeIp4(6)DriverBindingSupported.
[in] | This | The pointer to the driver binding protocol. |
[in] | ControllerHandle | The handle of device to be tested. |
[in] | RemainingDevicePath | Optional parameter used to pick a specific child device to be started. |
[in] | IpVersion | IP_VERSION_4 or IP_VERSION_6. |
EFI_SUCCESS | This driver supports this device. |
EFI_UNSUPPORTED | This driver does not support this device. |
Definition at line 291 of file HttpDriver.c.
EFI_STATUS EFIAPI HttpServiceBindingCreateChild | ( | IN EFI_SERVICE_BINDING_PROTOCOL * | This, |
IN OUT EFI_HANDLE * | ChildHandle | ||
) |
Creates a child handle and installs a protocol.
The CreateChild() function installs a protocol on ChildHandle. If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.
This | Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. |
ChildHandle | Pointer to the handle of the child to create. If it is NULL, then a new handle is created. If it is a pointer to an existing UEFI handle, then the protocol is added to the existing UEFI handle. |
EFI_SUCCESS | The protocol was added to ChildHandle. |
EFI_INVALID_PARAMETER | This is NULL, or ChildHandle is NULL. |
EFI_OUT_OF_RESOURCES | There are not enough resources available to create the child. |
other | The child handle was not created. |
Definition at line 909 of file HttpDriver.c.
EFI_STATUS EFIAPI HttpServiceBindingDestroyChild | ( | IN EFI_SERVICE_BINDING_PROTOCOL * | This, |
IN EFI_HANDLE | ChildHandle | ||
) |
Destroys a child handle with a protocol installed on it.
The DestroyChild() function does the opposite of CreateChild(). It removes a protocol that was installed by CreateChild() from ChildHandle. If the removed protocol is the last protocol on ChildHandle, then ChildHandle is destroyed.
This | Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. |
ChildHandle | Handle of the child to destroy |
EFI_SUCCESS | The protocol was removed from ChildHandle. |
EFI_UNSUPPORTED | ChildHandle does not support the protocol that is being removed. |
EFI_INVALID_PARAMETER | Child handle is NULL. |
other | The child handle was not destroyed |
Definition at line 992 of file HttpDriver.c.
The event process routine when the http utilities protocol is installed in the system.
[in] | Event | Not used. |
[in] | Context | The pointer to the IP4 config2 instance data or IP6 Config instance data. |
Definition at line 142 of file HttpDriver.c.
EFI_DRIVER_BINDING_PROTOCOL gHttpDxeIp4DriverBinding |
Driver Binding Protocol instance
Definition at line 19 of file HttpDriver.c.
EFI_DRIVER_BINDING_PROTOCOL gHttpDxeIp6DriverBinding |
Definition at line 28 of file HttpDriver.c.
EFI_HTTP_UTILITIES_PROTOCOL* mHttpUtilities = NULL |
Definition at line 14 of file HttpDriver.c.