Code Scrub for Protocol and Ppi Definition

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

diff --git a/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h b/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h
index 265c4e9f453302562b8c360e06c7cdd305e7bbe6..0745d7c655c30ec7c0d79018fdcccb76fa9aeeea 100644 (file)
--- a/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h
+++ b/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h
@@ -1,7 +1,9 @@
 /** @file\r
-  EFI PXE Base Code CallBack Protocol\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, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
@@ -86,6 +88,21 @@ EFI_PXE_BASE_CODE_CALLBACK_STATUS
   IN EFI_PXE_BASE_CODE_PACKET             *Packet     OPTIONAL\r
   );\r
 \r
+/**  \r
+  @par Protocol Description:\r
+  Protocol that is invoked when the PXE Base Code Protocol is about \r
+  to transmit, has received, or is waiting to receive a packet.\r
+\r
+  @param Revision\r
+  The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must \r
+  be backwards compatible. If a future version is not backwards compatible \r
+  it is not the same GUID.\r
+\r
+  @param Callback\r
+  Callback routine used by the PXE Base Code Dhcp(), Discover(), Mtftp(), \r
+  UdpWrite(), and Arp() functions.\r
+\r
+**/\r
 struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL {\r
   UINT64            Revision;\r
   EFI_PXE_CALLBACK  Callback;\r