mirror of https://github.com/acidanthera/audk.git
MdePkg: Add header file for HTTP Boot Callback protocol in UEFI 2.7.
Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Fu Siyuan <siyuan.fu@intel.com> Reviewed-by: Ye Ting <ting.ye@intel.com> Reviewed-by: Wu Jiaxin <jiaxin.wu@intel.com>
This commit is contained in:
Fu Siyuan
parent
415fc5e5a4
commit
a77d109ffa
|
|
@ -0,0 +1,100 @@
|
|||
/** @file
|
||||
This file defines the EFI HTTP Boot Callback Protocol interface.
|
||||
|
||||
Copyright (c) 2017, 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
|
||||
which 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.
|
||||
|
||||
@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
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
# This Package provides all definitions, library classes and libraries instances.
|
||||
#
|
||||
# It also provides the definitions(including PPIs/PROTOCOLs/GUIDs) of
|
||||
# EFI1.10/UEFI2.6/PI1.4 and some Industry Standards.
|
||||
# EFI1.10/UEFI2.7/PI1.4 and some Industry Standards.
|
||||
#
|
||||
# Copyright (c) 2007 - 2017, Intel Corporation. All rights reserved.<BR>
|
||||
# Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
|
||||
|
|
@ -1666,6 +1666,9 @@
|
|||
## Include/Protocol/UfsDeviceConfig.h
|
||||
gEfiUfsDeviceConfigProtocolGuid = { 0xb81bfab0, 0xeb3, 0x4cf9, { 0x84, 0x65, 0x7f, 0xa9, 0x86, 0x36, 0x16, 0x64 }}
|
||||
|
||||
## Include/Protocol/HttpBootCallback.h
|
||||
gEfiHttpBootCallbackProtocolGuid = {0xba23b311, 0x343d, 0x11e6, {0x91, 0x85, 0x58, 0x20, 0xb1, 0xd6, 0x52, 0x99}}
|
||||
|
||||
#
|
||||
# Protocols defined in Shell2.0
|
||||
#
|
||||
|
|
|
|||
Loading…
Reference in New Issue