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 18ae20bc4b9a795139d6ca5651eb51924bdd4a28..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
@@ -468,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