mirror of
https://github.com/CloverHackyColor/CloverBootloader.git
synced 2024-12-18 15:27:48 +01:00
400 lines
20 KiB
C
400 lines
20 KiB
C
|
/** @file
|
||
|
|
The header files of the driver binding and service binding protocol for HttpDxe driver.
|
||
|
|
|
||
|
|
Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>
|
||
|
|
(C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
|
||
|
|
|
||
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
||
|
|
|
||
|
|
**/
|
||
|
|
|
||
|
|
#ifndef __EFI_HTTP_DRIVER_H__
|
||
|
|
#define __EFI_HTTP_DRIVER_H__
|
||
|
|
|
||
|
|
#include <Uefi.h>
|
||
|
|
#include <IndustryStandard/Http11.h>
|
||
|
|
|
||
|
|
//
|
||
|
|
// Libraries
|
||
|
|
//
|
||
|
|
#include <Library/UefiBootServicesTableLib.h>
|
||
|
|
#include <Library/UefiRuntimeServicesTableLib.h>
|
||
|
|
#include <Library/MemoryAllocationLib.h>
|
||
|
|
#include <Library/BaseLib.h>
|
||
|
|
#include <Library/UefiLib.h>
|
||
|
|
#include <Library/DebugLib.h>
|
||
|
|
#include <Library/NetLib.h>
|
||
|
|
#include <Library/HttpLib.h>
|
||
|
|
#include <Library/DpcLib.h>
|
||
|
|
|
||
|
|
//
|
||
|
|
// UEFI Driver Model Protocols
|
||
|
|
//
|
||
|
|
#include <Protocol/DriverBinding.h>
|
||
|
|
#include <Protocol/ServiceBinding.h>
|
||
|
|
#include <Protocol/ComponentName2.h>
|
||
|
|
#include <Protocol/ComponentName.h>
|
||
|
|
|
||
|
|
//
|
||
|
|
// Consumed Protocols
|
||
|
|
//
|
||
|
|
#include <Protocol/HttpUtilities.h>
|
||
|
|
#include <Protocol/Tcp4.h>
|
||
|
|
#include <Protocol/Tcp6.h>
|
||
|
|
#include <Protocol/Dns4.h>
|
||
|
|
#include <Protocol/Dns6.h>
|
||
|
|
#include <Protocol/Ip4Config2.h>
|
||
|
|
#include <Protocol/Ip6Config.h>
|
||
|
|
#include <Protocol/Tls.h>
|
||
|
|
#include <Protocol/TlsConfig.h>
|
||
|
|
|
||
|
|
#include <Guid/ImageAuthentication.h>
|
||
|
|
//
|
||
|
|
// Produced Protocols
|
||
|
|
//
|
||
|
|
#include <Protocol/Http.h>
|
||
|
|
|
||
|
|
#include <Guid/TlsAuthentication.h>
|
||
|
|
#include <Guid/HttpTlsCipherList.h>
|
||
|
|
|
||
|
|
#include <IndustryStandard/Tls1.h>
|
||
|
|
|
||
|
|
//
|
||
|
|
// Driver Version
|
||
|
|
//
|
||
|
|
#define HTTP_DRIVER_VERSION 0xa
|
||
|
|
|
||
|
|
//
|
||
|
|
// Protocol instances
|
||
|
|
//
|
||
|
|
extern EFI_DRIVER_BINDING_PROTOCOL gHttpDxeIp4DriverBinding;
|
||
|
|
extern EFI_DRIVER_BINDING_PROTOCOL gHttpDxeIp6DriverBinding;
|
||
|
|
|
||
|
|
extern EFI_COMPONENT_NAME2_PROTOCOL gHttpDxeComponentName2;
|
||
|
|
extern EFI_COMPONENT_NAME_PROTOCOL gHttpDxeComponentName;
|
||
|
|
|
||
|
|
extern EFI_HTTP_UTILITIES_PROTOCOL *mHttpUtilities;
|
||
|
|
|
||
|
|
//
|
||
|
|
// Include files with function prototypes
|
||
|
|
//
|
||
|
|
#include "ComponentName.h"
|
||
|
|
#include "HttpImpl.h"
|
||
|
|
#include "HttpProto.h"
|
||
|
|
#include "HttpsSupport.h"
|
||
|
|
#include "HttpDns.h"
|
||
|
|
|
||
|
|
typedef struct {
|
||
|
|
EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding;
|
||
|
|
UINTN NumberOfChildren;
|
||
|
|
EFI_HANDLE *ChildHandleBuffer;
|
||
|
|
} HTTP_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT;
|
||
|
|
|
||
|
|
/**
|
||
|
|
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
|
||
|
|
HttpDxeIp4DriverBindingSupported (
|
||
|
|
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
|
||
|
|
HttpDxeIp4DriverBindingStart (
|
||
|
|
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
|
||
|
|
HttpDxeIp4DriverBindingStop (
|
||
|
|
IN EFI_DRIVER_BINDING_PROTOCOL *This,
|
||
|
|
IN EFI_HANDLE ControllerHandle,
|
||
|
|
IN UINTN NumberOfChildren,
|
||
|
|
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
|
||
|
|
HttpDxeIp6DriverBindingSupported (
|
||
|
|
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_ALREADY_STARTED This device is already running on ControllerHandle.
|
||
|
|
@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
|
||
|
|
HttpDxeIp6DriverBindingStart (
|
||
|
|
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
|
||
|
|
HttpDxeIp6DriverBindingStop (
|
||
|
|
IN EFI_DRIVER_BINDING_PROTOCOL *This,
|
||
|
|
IN EFI_HANDLE ControllerHandle,
|
||
|
|
IN UINTN NumberOfChildren,
|
||
|
|
IN EFI_HANDLE *ChildHandleBuffer OPTIONAL
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
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.
|
||
|
|
|
||
|
|
@param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
|
||
|
|
@param 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.
|
||
|
|
|
||
|
|
@retval EFI_SUCCES The protocol was added to ChildHandle.
|
||
|
|
@retval EFI_INVALID_PARAMETER This is NULL, or ChildHandle is NULL.
|
||
|
|
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to create
|
||
|
|
the child.
|
||
|
|
@retval other The child handle was not created.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
HttpServiceBindingCreateChild (
|
||
|
|
IN EFI_SERVICE_BINDING_PROTOCOL *This,
|
||
|
|
IN OUT 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.
|
||
|
|
|
||
|
|
@param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
|
||
|
|
@param ChildHandle Handle of the child to destroy
|
||
|
|
|
||
|
|
@retval EFI_SUCCES The protocol was removed from ChildHandle.
|
||
|
|
@retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.
|
||
|
|
@retval EFI_INVALID_PARAMETER Child handle is NULL.
|
||
|
|
@retval other The child handle was not destroyed
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
HttpServiceBindingDestroyChild (
|
||
|
|
IN EFI_SERVICE_BINDING_PROTOCOL *This,
|
||
|
|
IN EFI_HANDLE ChildHandle
|
||
|
|
);
|
||
|
|
|
||
|
|
#endif
|