Code Scrub for Protocol and Ppi Definition

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

diff --git a/MdePkg/Include/Protocol/PxeBaseCode.h b/MdePkg/Include/Protocol/PxeBaseCode.h
index e98a4976a7b3f9caa425eb4f8c33418b94077d33..c341d46aeca6e1b04f900b2deefe6359b1afd4a4 100644 (file)
--- a/MdePkg/Include/Protocol/PxeBaseCode.h
+++ b/MdePkg/Include/Protocol/PxeBaseCode.h
@@ -1,7 +1,8 @@
 /** @file\r
-  EFI PXE Base Code Protocol definitions.\r
+  EFI PXE Base Code Protocol definitions, which is used to access PXE-compatible \r
+  devices for network access and network booting.\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
@@ -607,6 +608,63 @@ EFI_STATUS
 // \r
 #define EFI_PXE_BASE_CODE_INTERFACE_REVISION  EFI_PXE_BASE_CODE_PROTOCOL_REVISION\r
 \r
+/**  \r
+  @par Protocol Description:\r
+  The EFI_PXE_BASE_CODE_PROTOCOL is used to control PXE-compatible devices.\r
+  An EFI_PXE_BASE_CODE_PROTOCOL will be layered on top of an\r
+  EFI_MANAGED_NETWORK_PROTOCOL protocol in order to perform packet level transactions.\r
+  The EFI_PXE_BASE_CODE_PROTOCOL handle also supports the\r
+  EFI_LOAD_FILE_PROTOCOL protocol. This provides a clean way to obtain control from the\r
+  boot manager if the boot path is from the remote device.\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 Start\r
+  Starts the PXE Base Code Protocol. Mode structure information is not valid and \r
+  no other Base Code Protocol functions will operate until the Base Code is started. \r
+\r
+  @param Stop\r
+  Stops the PXE Base Code Protocol. Mode structure information is unchanged by this function. \r
+  No Base Code Protocol functions will operate until the Base Code is restarted. \r
+\r
+  @param Dhcp\r
+  Attempts to complete a DHCPv4 D.O.R.A. (discover / offer / request / acknowledge) \r
+  or DHCPv6 S.A.R.R (solicit / advertise / request / reply) sequence. \r
+\r
+  @param Discover\r
+  Attempts to complete the PXE Boot Server and/or boot image discovery sequence. \r
+\r
+  @param Mtftp\r
+  Performs TFTP and MTFTP services. \r
+\r
+  @param UdpWrite\r
+  Writes a UDP packet to the network interface. \r
+\r
+  @param UdpRead\r
+  Reads a UDP packet from the network interface. \r
+\r
+  @param SetIpFilter\r
+  Updates the IP receive filters of the network device. \r
+\r
+  @param Arp\r
+  Uses the ARP protocol to resolve a MAC address. \r
+\r
+  @param SetParameters\r
+  Updates the parameters that affect the operation of the PXE Base Code Protocol. \r
+\r
+  @param SetStationIp\r
+  Updates the station IP address and subnet mask values. \r
+\r
+  @param SetPackets\r
+  Updates the contents of the cached DHCP and Discover packets. \r
+\r
+  @param Mode\r
+  Pointer to the EFI_PXE_BASE_CODE_MODE data for this device. \r
+\r
+**/\r
 struct _EFI_PXE_BASE_CODE_PROTOCOL {\r
   UINT64                            Revision;\r
   EFI_PXE_BASE_CODE_START           Start;\r