diff options
Diffstat (limited to 'src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h')
-rw-r--r-- | src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h | 52 |
1 files changed, 26 insertions, 26 deletions
diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h index f653fdf7ff..c796a9e3a7 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h @@ -1,17 +1,17 @@ /** @file - It is invoked when the PXE Base Code Protocol is about to transmit, has received, + It is invoked when the PXE Base Code Protocol is about to transmit, has received, or is waiting to receive a packet. Copyright (c) 2006 - 2010, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that 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. +http://opensource.org/licenses/bsd-license.php. - @par Revision Reference: +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 EFI Specification 1.10 **/ @@ -45,7 +45,7 @@ typedef struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL EFI_PXE_BASE_CODE_CALLBACK_ /// /// EFI1.1 Protocol name. -/// +/// typedef EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL EFI_PXE_BASE_CODE_CALLBACK; /// @@ -73,10 +73,10 @@ typedef enum { EFI_PXE_BASE_CODE_CALLBACK_STATUS_LAST } EFI_PXE_BASE_CODE_CALLBACK_STATUS; -/** +/** Callback function that is invoked when the PXE Base Code Protocol is about to transmit, has - received, or is waiting to receive a packet. - + received, or is waiting to receive a packet. + This function is invoked when the PXE Base Code Protocol is about to transmit, has received, or is waiting to receive a packet. Parameters Function and Received specify the type of event. Parameters PacketLen and Packet specify the packet that generated the event. If these fields @@ -86,22 +86,22 @@ typedef enum { the polling nature of UEFI device drivers, a callback function should not execute for more than 5 ms. The SetParameters() function must be called after a Callback Protocol is installed to enable the use of callbacks. - + @param This The pointer to the EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL instance. - @param Function The PXE Base Code Protocol function that is waiting for an event. + @param Function The PXE Base Code Protocol function that is waiting for an event. @param 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. + the callback is being invoked due to a transmit event. @param PacketLen The length, in bytes, of Packet. This field will have a value of zero if - this is a wait for receive event. + this is a wait for receive event. @param Packet If Received is TRUE, a pointer to the packet that was just received; - otherwise a pointer to the packet that is about to be transmitted. - - @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE if Function specifies a continue operation + otherwise a pointer to the packet that is about to be transmitted. + + @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE if Function specifies a continue operation @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT if Function specifies an abort operation - + **/ -typedef -EFI_PXE_BASE_CODE_CALLBACK_STATUS +typedef +EFI_PXE_BASE_CODE_CALLBACK_STATUS (EFIAPI *EFI_PXE_CALLBACK)( IN EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL *This, IN EFI_PXE_BASE_CODE_FUNCTION Function, @@ -111,13 +111,13 @@ EFI_PXE_BASE_CODE_CALLBACK_STATUS ); /// -/// Protocol that is invoked when the PXE Base Code Protocol is about +/// Protocol that is invoked when the PXE Base Code Protocol is about /// to transmit, has received, or is waiting to receive a packet. /// struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL { /// - /// The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must - /// be backwards compatible. If a future version is not backwards compatible + /// The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must + /// be backwards compatible. If a future version is not backwards compatible /// it is not the same GUID. /// UINT64 Revision; @@ -126,5 +126,5 @@ struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL { extern EFI_GUID gEfiPxeBaseCodeCallbackProtocolGuid; -#endif +#endif |