Clarify the UEFI/EFI specification version in file header comments.

[mirror_edk2.git] / MdePkg / Include / Protocol / PxeBaseCodeCallBack.h

diff --git a/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h b/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h
index 26b1503582cc23652a5df08a2febb09370fa58a0..f47ee49219d2831c6eb8a4c7e199304d5faaa909 100644 (file)
--- a/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h
+++ b/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h
@@ -1,9 +1,8 @@
 /** @file\r
-  EFI PXE Base Code CallBack Protocol is as defined in UEFI specification.\r
   It is invoked when the PXE Base Code Protocol is about to transmit, has received, \r
   or is waiting to receive a packet.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2009, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r
   which accompanies this distribution.  The full text of the license may be found at        \r
@@ -12,6 +11,9 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
+  @par Revision Reference:          \r
+  This Protocol is introduced in EFI Specification 1.10\r
+\r
 **/\r
 \r
 #ifndef _PXE_BASE_CODE_CALLBACK_H_\r
@@ -75,6 +77,16 @@ typedef enum {
   Callback function that is invoked when the PXE Base Code Protocol is about to transmit, has\r
   received, or is waiting to receive a packet.                                                 \r
   \r
+  This function is invoked when the PXE Base Code Protocol is about to transmit, has received,\r
+  or is waiting to receive a packet. Parameters Function and Received specify the type of event.\r
+  Parameters PacketLen and Packet specify the packet that generated the event. If these fields\r
+  are zero and NULL respectively, then this is a status update callback. If the operation specified\r
+  by Function is to continue, then CALLBACK_STATUS_CONTINUE should be returned. If the operation\r
+  specified by Function should be aborted, then CALLBACK_STATUS_ABORT should be returned. Due to\r
+  the polling nature of UEFI device drivers, a callback function should not execute for more than 5 ms.\r
+  The SetParameters() function must be called after a Callback Protocol is installed to enable the\r
+  use of callbacks.\r
+  \r
   @param  This                  Pointer to the EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL instance.\r
   @param  Function              The PXE Base Code Protocol function that is waiting for an event.                                                              \r
   @param  Received              TRUE if the callback is being invoked due to a receive event. FALSE if\r