9344f09215
https://bugzilla.tianocore.org/show_bug.cgi?id=1373 Replace BSD 2-Clause License with BSD+Patent License. This change is based on the following emails: https://lists.01.org/pipermail/edk2-devel/2019-February/036260.html https://lists.01.org/pipermail/edk2-devel/2018-October/030385.html RFCs with detailed process for the license change: V3: https://lists.01.org/pipermail/edk2-devel/2019-March/038116.html V2: https://lists.01.org/pipermail/edk2-devel/2019-March/037669.html V1: https://lists.01.org/pipermail/edk2-devel/2019-March/037500.html Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com> Reviewed-by: Liming Gao <liming.gao@intel.com>
95 lines
3.4 KiB
C
95 lines
3.4 KiB
C
/** @file
|
|
This file defines the EFI HTTP Boot Callback Protocol interface.
|
|
|
|
Copyright (c) 2017 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
@par Revision Reference:
|
|
This Protocol is introduced in UEFI Specification 2.7
|
|
|
|
**/
|
|
|
|
#ifndef __EFI_HTTP_BOOT_CALLBACK_H__
|
|
#define __EFI_HTTP_BOOT_CALLBACK_H__
|
|
|
|
#define EFI_HTTP_BOOT_CALLBACK_PROTOCOL_GUID \
|
|
{ \
|
|
0xba23b311, 0x343d, 0x11e6, {0x91, 0x85, 0x58, 0x20, 0xb1, 0xd6, 0x52, 0x99} \
|
|
}
|
|
|
|
typedef struct _EFI_HTTP_BOOT_CALLBACK_PROTOCOL EFI_HTTP_BOOT_CALLBACK_PROTOCOL;
|
|
|
|
///
|
|
/// EFI_HTTP_BOOT_CALLBACK_DATA_TYPE
|
|
///
|
|
typedef enum {
|
|
///
|
|
/// Data points to a DHCP4 packet which is about to transmit or has received.
|
|
///
|
|
HttpBootDhcp4,
|
|
///
|
|
/// Data points to a DHCP6 packet which is about to be transmit or has received.
|
|
///
|
|
HttpBootDhcp6,
|
|
///
|
|
/// Data points to an EFI_HTTP_MESSAGE structure, whichcontians a HTTP request message
|
|
/// to be transmitted.
|
|
///
|
|
HttpBootHttpRequest,
|
|
///
|
|
/// Data points to an EFI_HTTP_MESSAGE structure, which contians a received HTTP
|
|
/// response message.
|
|
///
|
|
HttpBootHttpResponse,
|
|
///
|
|
/// Part of the entity body has been received from the HTTP server. Data points to the
|
|
/// buffer of the entity body data.
|
|
///
|
|
HttpBootHttpEntityBody,
|
|
HttpBootTypeMax
|
|
} EFI_HTTP_BOOT_CALLBACK_DATA_TYPE;
|
|
|
|
/**
|
|
Callback function that is invoked when the HTTP Boot driver is about to transmit or has received a
|
|
packet.
|
|
|
|
This function is invoked when the HTTP Boot driver is about to transmit or has received packet.
|
|
Parameters DataType and Received specify the type of event and the format of the buffer pointed
|
|
to by Data. Due to the polling nature of UEFI device drivers, this callback function should not
|
|
execute for more than 5 ms.
|
|
The returned status code determines the behavior of the HTTP Boot driver.
|
|
|
|
@param[in] This Pointer to the EFI_HTTP_BOOT_CALLBACK_PROTOCOL instance.
|
|
@param[in] DataType The event that occurs in the current state.
|
|
@param[in] Received TRUE if the callback is being invoked due to a receive event.
|
|
FALSE if the callback is being invoked due to a transmit event.
|
|
@param[in] DataLength The length in bytes of the buffer pointed to by Data.
|
|
@param[in] Data A pointer to the buffer of data, the data type is specified by
|
|
DataType.
|
|
|
|
@retval EFI_SUCCESS Tells the HTTP Boot driver to continue the HTTP Boot process.
|
|
@retval EFI_ABORTED Tells the HTTP Boot driver to abort the current HTTP Boot process.
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI * EFI_HTTP_BOOT_CALLBACK) (
|
|
IN EFI_HTTP_BOOT_CALLBACK_PROTOCOL *This,
|
|
IN EFI_HTTP_BOOT_CALLBACK_DATA_TYPE DataType,
|
|
IN BOOLEAN Received,
|
|
IN UINT32 DataLength,
|
|
IN VOID *Data OPTIONAL
|
|
);
|
|
|
|
///
|
|
/// EFI HTTP Boot Callback Protocol is invoked when the HTTP Boot driver is about to transmit or
|
|
/// has received a packet. The EFI HTTP Boot Callback Protocol must be installed on the same handle
|
|
/// as the Load File Protocol for the HTTP Boot.
|
|
///
|
|
struct _EFI_HTTP_BOOT_CALLBACK_PROTOCOL {
|
|
EFI_HTTP_BOOT_CALLBACK Callback;
|
|
};
|
|
|
|
extern EFI_GUID gEfiHttpBootCallbackProtocolGuid;
|
|
|
|
#endif
|