remove some comments.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10141 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 57 insertions, 70 deletions

diff --git a/MdePkg/Include/Protocol/Mtftp4.h b/MdePkg/Include/Protocol/Mtftp4.h
index 10f97e5b97..9ebeec8870 100644
--- a/MdePkg/Include/Protocol/Mtftp4.h
+++ b/MdePkg/Include/Protocol/Mtftp4.h
@@ -1,16 +1,16 @@
 /** @file

   EFI Multicast Trivial File Tranfer Protocol Definition

 

-  Copyright (c) 2006 - 2010, Intel Corporation                                                         

-  All rights reserved. This program and the accompanying materials                          

-  are licensed and made available under the terms and conditions of the BSD License         

-  which accompanies this distribution.  The full text of the license may be found at        

-  http://opensource.org/licenses/bsd-license.php                                            

+  Copyright (c) 2006 - 2010, Intel Corporation

+  All rights reserved. This program and the accompanying materials

+  are licensed and made available under the terms and conditions of the BSD License

+  which accompanies this distribution.  The full text of the license may be found at

+  http://opensource.org/licenses/bsd-license.php

 

-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.   

+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

-  @par Revision Reference:          

+  @par Revision Reference:

   This Protocol is introduced in UEFI Specification 2.0

 

 **/

@@ -165,9 +165,9 @@ typedef struct {
 

 typedef struct {

   EFI_MTFTP4_CONFIG_DATA  ConfigData;

-  UINT8                   SupportedOptionCount;  

+  UINT8                   SupportedOptionCount;

   UINT8                   **SupportedOptoins;

-  UINT8                   UnsupportedOptionCount;  

+  UINT8                   UnsupportedOptionCount;

   UINT8                   **UnsupportedOptoins;

 } EFI_MTFTP4_MODE_DATA;

 

@@ -185,11 +185,11 @@ typedef struct {
 //

 

 /**

-  A callback function that is provided by the caller to intercept               

+  A callback function that is provided by the caller to intercept

   the EFI_MTFTP4_OPCODE_DATA or EFI_MTFTP4_OPCODE_DATA8 packets processed in the

-  EFI_MTFTP4_PROTOCOL.ReadFile() function, and alternatively to intercept       

-  EFI_MTFTP4_OPCODE_OACK or EFI_MTFTP4_OPCODE_ERROR packets during a call to    

-  EFI_MTFTP4_PROTOCOL.ReadFile(), WriteFile() or ReadDirectory().                   

+  EFI_MTFTP4_PROTOCOL.ReadFile() function, and alternatively to intercept

+  EFI_MTFTP4_OPCODE_OACK or EFI_MTFTP4_OPCODE_ERROR packets during a call to

+  EFI_MTFTP4_PROTOCOL.ReadFile(), WriteFile() or ReadDirectory().

 

   @param  This        Pointer to the EFI_MTFTP4_PROTOCOL instance.

   @param  Token       The token that the caller provided in the

@@ -202,9 +202,9 @@ typedef struct {
   @retval Others      Abort transfer process

 

 **/

-typedef 

-EFI_STATUS 

-(EFIAPI *EFI_MTFTP4_CHECK_PACKET)( 

+typedef

+EFI_STATUS

+(EFIAPI *EFI_MTFTP4_CHECK_PACKET)(

   IN EFI_MTFTP4_PROTOCOL  *This,

   IN EFI_MTFTP4_TOKEN     *Token,

   IN UINT16               PacketLen,

@@ -212,7 +212,7 @@ EFI_STATUS
   );

 

 /**

-  Timeout callback funtion.            

+  Timeout callback funtion.

 

   @param  This           Pointer to the EFI_MTFTP4_PROTOCOL instance.

   @param  Token          The token that is provided in the

@@ -220,14 +220,14 @@ EFI_STATUS
                          EFI_MTFTP4_PROTOCOL.WriteFile() or

                          EFI_MTFTP4_PROTOCOL.ReadDirectory() functions

                          by the caller.

-                         

+

   @retval EFI_SUCCESS   Operation sucess

   @retval Others        Aborts download process.

 

 **/

-typedef 

-EFI_STATUS 

-(EFIAPI *EFI_MTFTP4_TIMEOUT_CALLBACK)( 

+typedef

+EFI_STATUS

+(EFIAPI *EFI_MTFTP4_TIMEOUT_CALLBACK)(

   IN EFI_MTFTP4_PROTOCOL  *This,

   IN EFI_MTFTP4_TOKEN     *Token

   );

@@ -247,9 +247,9 @@ EFI_STATUS
   @retval Others      Aborts session.

 

 **/

-typedef 

-EFI_STATUS 

-(EFIAPI *EFI_MTFTP4_PACKET_NEEDED)( 

+typedef

+EFI_STATUS

+(EFIAPI *EFI_MTFTP4_PACKET_NEEDED)(

   IN  EFI_MTFTP4_PROTOCOL *This,

   IN  EFI_MTFTP4_TOKEN    *Token,

   IN  OUT UINT16          *Length,

@@ -268,8 +268,8 @@ EFI_STATUS
   @retval EFI_INVALID_PARAMETER This is NULL or ModeData is NULL.

 

 **/

-typedef 

-EFI_STATUS 

+typedef

+EFI_STATUS

 (EFIAPI *EFI_MTFTP4_GET_MODE_DATA)(

   IN  EFI_MTFTP4_PROTOCOL     *This,

   OUT EFI_MTFTP4_MODE_DATA    *ModeData

@@ -277,7 +277,7 @@ EFI_STATUS
 

 

 /**

-  Initializes, changes, or resets the default operational setting for this 

+  Initializes, changes, or resets the default operational setting for this

   EFI MTFTPv4 Protocol driver instance.

 

   @param  This            Pointer to the EFI_MTFTP4_PROTOCOL instance.

@@ -298,14 +298,14 @@ EFI_STATUS
                                  MTFTPv4 Protocol driver instance is not configured.

 

 **/

-typedef 

-EFI_STATUS 

+typedef

+EFI_STATUS

 (EFIAPI *EFI_MTFTP4_CONFIGURE)(

   IN EFI_MTFTP4_PROTOCOL       *This,

   IN EFI_MTFTP4_CONFIG_DATA    *MtftpConfigData OPTIONAL

-  );   

-    

-    

+  );

+

+

 /**

   Gets information about a file from an MTFTPv4 server.

 

@@ -323,7 +323,6 @@ EFI_STATUS
                        the caller.

 

   @retval EFI_SUCCESS              An MTFTPv4 OACK packet was received and is in the Packet.

-                                   Note: It does not match UEFI 2.3 Specification.

   @retval EFI_INVALID_PARAMETER    One or more of the following conditions is TRUE:

                                    - This is NULL.

                                    - Filename is NULL.

@@ -341,24 +340,18 @@ EFI_STATUS
   @retval EFI_OUT_OF_RESOURCES     Required system resources could not be allocated.

   @retval EFI_TFTP_ERROR           An MTFTPv4 ERROR packet was received and is in the Packet.

   @retval EFI_NETWORK_UNREACHABLE  An ICMP network unreachable error packet was received and the Packet is set to NULL.

-                                   Note: It is not defined in UEFI 2.3 Specification.

   @retval EFI_HOST_UNREACHABLE     An ICMP host unreachable error packet was received and the Packet is set to NULL.

-                                   Note: It is not defined in UEFI 2.3 Specification.

   @retval EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received and the Packet is set to NULL.

-                                   Note: It is not defined in UEFI 2.3 Specification.

   @retval EFI_PORT_UNREACHABLE     An ICMP port unreachable error packet was received and the Packet is set to NULL.

-                                   Note: It is not defined in UEFI 2.3 Specification.

   @retval EFI_ICMP_ERROR           Some other ICMP ERROR packet was received and is in the Buffer.

-                                   Note: It does not match UEFI 2.3 Specification.

   @retval EFI_PROTOCOL_ERROR       An unexpected MTFTPv4 packet was received and is in the Packet.

-                                   Note: It does not match UEFI 2.3 Specification.

   @retval EFI_TIMEOUT              No responses were received from the MTFTPv4 server.

   @retval EFI_DEVICE_ERROR         An unexpected network error or system error occurred.

   @retval EFI_NO_MEDIA             There was a media error.

 

 **/

-typedef 

-EFI_STATUS 

+typedef

+EFI_STATUS

 (EFIAPI *EFI_MTFTP4_GET_INFO)(

   IN  EFI_MTFTP4_PROTOCOL      *This,

   IN  EFI_MTFTP4_OVERRIDE_DATA *OverrideData   OPTIONAL,

@@ -392,15 +385,15 @@ EFI_STATUS
   @retval EFI_PROTOCOL_ERROR    One or more of the option fields is invalid.

 

 **/

-typedef 

-EFI_STATUS 

+typedef

+EFI_STATUS

 (EFIAPI *EFI_MTFTP4_PARSE_OPTIONS)(

   IN  EFI_MTFTP4_PROTOCOL      *This,

   IN  UINT32                   PacketLen,

   IN  EFI_MTFTP4_PACKET        *Packet,

   OUT UINT32                   *OptionCount,

   OUT EFI_MTFTP4_OPTION        **OptionList OPTIONAL

-  );  

+  );

 

 

 /**

@@ -414,31 +407,25 @@ EFI_STATUS
   @retval EFI_OUT_OF_RESOURCES     Required system resources could not be allocated.

   @retval EFI_BUFFER_TOO_SMALL     BufferSize is not zero but not large enough to hold the

                                    downloaded data in downloading process.

-                                   Note: It does not match UEFI 2.3 Specification.

   @retval EFI_ABORTED              Current operation is aborted by user.

   @retval EFI_NETWORK_UNREACHABLE  An ICMP network unreachable error packet was received.

-                                   Note: It is not defined in UEFI 2.3 Specification.

   @retval EFI_HOST_UNREACHABLE     An ICMP host unreachable error packet was received.

-                                   Note: It is not defined in UEFI 2.3 Specification.

   @retval EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received.

-                                   Note: It is not defined in UEFI 2.3 Specification.

   @retval EFI_PORT_UNREACHABLE     An ICMP port unreachable error packet was received.

-                                   Note: It is not defined in UEFI 2.3 Specification.

   @retval EFI_ICMP_ERROR           Some other  ICMP ERROR packet was received.

-                                   Note: It does not match UEFI 2.3 Specification.

   @retval EFI_TIMEOUT              No responses were received from the MTFTPv4 server.

   @retval EFI_TFTP_ERROR           An MTFTPv4 ERROR packet was received.

   @retval EFI_DEVICE_ERROR         An unexpected network error or system error occurred.

   @retval EFI_NO_MEDIA             There was a media error.

 

 **/

-typedef 

-EFI_STATUS 

+typedef

+EFI_STATUS

 (EFIAPI *EFI_MTFTP4_READ_FILE)(

   IN EFI_MTFTP4_PROTOCOL       *This,

   IN EFI_MTFTP4_TOKEN          *Token

-  );  

-  

+  );

+

 

 

 /**

@@ -462,17 +449,17 @@ EFI_STATUS
   @retval EFI_DEVICE_ERROR      An unexpected network error or system error occurred.

 

 **/

-typedef 

-EFI_STATUS 

+typedef

+EFI_STATUS

 (EFIAPI *EFI_MTFTP4_WRITE_FILE)(

   IN EFI_MTFTP4_PROTOCOL       *This,

   IN EFI_MTFTP4_TOKEN          *Token

-  );  

-  

+  );

+

 

 /**

   Downloads a data file "directory" from an MTFTPv4 server. May be unsupported in some EFI

-  implementations.                                                                                                                                                                                 

+  implementations.

 

   @param  This  Pointer to the EFI_MTFTP4_PROTOCOL instance.

   @param  Token Pointer to the token structure to provide the parameters that are

@@ -492,12 +479,12 @@ EFI_STATUS
   @retval EFI_DEVICE_ERROR      An unexpected network error or system error occurred.

 

 **/

-typedef 

-EFI_STATUS 

+typedef

+EFI_STATUS

 (EFIAPI *EFI_MTFTP4_READ_DIRECTORY)(

   IN EFI_MTFTP4_PROTOCOL       *This,

   IN EFI_MTFTP4_TOKEN          *Token

-  );    

+  );

 

 /**

   Polls for incoming data packets and processes outgoing data packets.

@@ -518,13 +505,13 @@ typedef
 EFI_STATUS

 (EFIAPI *EFI_MTFTP4_POLL)(

   IN EFI_MTFTP4_PROTOCOL       *This

-  );                                                                                                                 

-                                                                                                                  

+  );

+

 ///

-/// The EFI_MTFTP4_PROTOCOL is designed to be used by UEFI drivers and applications 

-/// to transmit and receive data files. The EFI MTFTPv4 Protocol driver uses 

+/// The EFI_MTFTP4_PROTOCOL is designed to be used by UEFI drivers and applications

+/// to transmit and receive data files. The EFI MTFTPv4 Protocol driver uses

 /// the underlying EFI UDPv4 Protocol driver and EFI IPv4 Protocol driver.

-///  

+///

 struct _EFI_MTFTP4_PROTOCOL {

   EFI_MTFTP4_GET_MODE_DATA     GetModeData;

   EFI_MTFTP4_CONFIGURE         Configure;

@@ -581,7 +568,7 @@ struct _EFI_MTFTP4_TOKEN {
   ///

   VOID                        *Buffer;

   ///

-  /// Pointer to the context that will be used by CheckPacket, 

+  /// Pointer to the context that will be used by CheckPacket,

   /// TimeoutCallback and PacketNeeded.

   ///

   VOID                        *Context;

@@ -600,7 +587,7 @@ struct _EFI_MTFTP4_TOKEN {
 };

 

 extern EFI_GUID gEfiMtftp4ServiceBindingProtocolGuid;

-extern EFI_GUID gEfiMtftp4ProtocolGuid;  

+extern EFI_GUID gEfiMtftp4ProtocolGuid;

 

 #endif