Code Scrub for Protocol and Ppi Definition

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

diff --git a/MdePkg/Include/Protocol/Mtftp4.h b/MdePkg/Include/Protocol/Mtftp4.h
index 840e04b4f36668aa5c240096f84d9136959f396c..4191227e9f47883fe598377fdb8669c106334a63 100644 (file)
--- a/MdePkg/Include/Protocol/Mtftp4.h
+++ b/MdePkg/Include/Protocol/Mtftp4.h
@@ -1,7 +1,7 @@
 /** @file\r
   EFI Multicast Trivial File Tranfer Protocol Definition\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
@@ -10,8 +10,6 @@
   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
-  Module Name:  Mtftp4.h\r
-\r
 **/\r
 \r
 #ifndef __EFI_MTFTP4_PROTOCOL_H__\r
@@ -24,7 +22,7 @@
 \r
 #define EFI_MTFTP4_PROTOCOL_GUID \\r
   { \\r
-    0x3ad9df29, 0x4501, 0x478d, {0xb1, 0xf8, 0x7f, 0x7f, 0xe7, 0x0e, 0x50, 0xf3 } \\r
+    0x78247c57, 0x63db, 0x4708, {0x99, 0xc2, 0xa8, 0xb4, 0xa9, 0xa6, 0x1f, 0x6b } \\r
   }\r
 \r
 typedef struct _EFI_MTFTP4_PROTOCOL EFI_MTFTP4_PROTOCOL;\r
@@ -291,7 +289,7 @@ EFI_STATUS
                        the default parameters that were set in the\r
                        EFI_MTFTP4_PROTOCOL.Configure() function are used.\r
   @param  Filename     Pointer to ASCIIZ file name string.\r
-  @param  ModeStr      Pointer to ASCIIZ mode string. If NULL, ¡°octet¡± will be used.\r
+  @param  ModeStr      Pointer to ASCIIZ mode string. If NULL, "octet" will be used.\r
   @param  OptionCount  Number of option/value string pairs in OptionList.\r
   @param  OptionList   Pointer to array of option/value string pairs. Ignored if\r
                        OptionCount is zero.\r
@@ -303,7 +301,6 @@ EFI_STATUS
   @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
   @retval EFI_UNSUPPORTED       One or more options in the OptionList are in the\r
                                 unsupported list of structure EFI_MTFTP4_MODE_DATA.\r
-  \r
   @retval EFI_NOT_STARTED       The EFI MTFTPv4 Protocol driver has not been started.\r
   @retval EFI_NO_MAPPING        When using a default address, configuration (DHCP, BOOTP,\r
                                 RARP, etc.) has not finished yet.\r
@@ -395,9 +392,9 @@ EFI_STATUS
 /**\r
   Sends a file to an MTFTPv4 server.\r
 \r
-  @param  This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
+  @param  This  Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
   @param  Token Pointer to the token structure to provide the parameters that are\r
-  used in this operation.\r
+                used in this operation.\r
 \r
   @retval EFI_SUCCESS           The upload session has started.\r
   @retval EFI_UNSUPPORTED       The operation is not supported by this implementation.\r
@@ -423,7 +420,7 @@ EFI_STATUS
   \r
 \r
 /**\r
-  Downloads a data file ¡°directory¡± from an MTFTPv4 server. May be unsupported in some EFI\r
+  Downloads a data file "directory" from an MTFTPv4 server. May be unsupported in some EFI\r
   implementations.                                                                                                                                                                                 \r
 \r
   @param  This  Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
@@ -469,12 +466,48 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_MTFTP4_POLL) (\r
+(EFIAPI *EFI_MTFTP4_POLL)(\r
   IN EFI_MTFTP4_PROTOCOL       *This\r
   )\r
 ;                                                                                                                 \r
                                                                                                                   \r
-  \r
+/**  \r
+  The EFI MTFTPv4 Protocol provides basic services for client-side unicast \r
+  and/or multicast TFTP operations.\r
+\r
+  @par Protocol Description:\r
+  The EFI_MTFTP4_PROTOCOL is designed to be used by UEFI drivers and applications \r
+  to transmit and receive data files. The EFI MTFTPv4 Protocol driver uses \r
+  the underlying EFI UDPv4 Protocol driver and EFI IPv4 Protocol driver.\r
+\r
+  @param GetModeData\r
+  Reads the current operational settings. \r
+\r
+  @param Configure\r
+  Initializes, changes, or resets the operational settings for \r
+  this instance of the EFI MTFTPv4 Protocol driver. \r
+\r
+  @param GetInfo\r
+  Retrieves information about a file from an MTFTPv4 server. \r
+\r
+  @param ParseOptions\r
+  Parses the options in an MTFTPv4 OACK (options acknowledgement) packet. \r
+\r
+  @param ReadFile\r
+  Downloads a file from an MTFTPv4 server. \r
+\r
+  @param WriteFile\r
+  Uploads a file to an MTFTPv4 server. This function may be unsupported \r
+  in some EFI implementations. \r
+\r
+  @param ReadDirectory\r
+  Downloads a related file directory from an MTFTPv4 server. This function \r
+  may be unsupported in some EFI implementations. \r
+\r
+  @param Poll\r
+  Polls for incoming data packets and processes outgoing data packets. \r
+\r
+**/  \r
 struct _EFI_MTFTP4_PROTOCOL {\r
   EFI_MTFTP4_GET_MODE_DATA     GetModeData;\r
   EFI_MTFTP4_CONFIGURE         Configure;\r