Grammatical and disclaimer changes (does not follow internal C coding stds.)

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

1 files changed, 46 insertions, 46 deletions

diff --git a/MdePkg/Include/Protocol/Mtftp4.h b/MdePkg/Include/Protocol/Mtftp4.h
index 9ebeec8870..b6c54021d4 100644
--- a/MdePkg/Include/Protocol/Mtftp4.h
+++ b/MdePkg/Include/Protocol/Mtftp4.h
@@ -1,14 +1,14 @@
 /** @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

-

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

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

+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>

+This program and the accompanying materials are licensed and made available under 

+the terms and conditions of the BSD License that 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.

 

   @par Revision Reference:

   This Protocol is introduced in UEFI Specification 2.0

@@ -142,7 +142,7 @@ typedef union {
 #pragma pack()

 

 ///

-/// MTFTP4 option definition

+/// MTFTP4 option definition.

 ///

 typedef struct {

   UINT8                   *OptionStr;

@@ -191,15 +191,15 @@ typedef struct {
   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  This        The pointer to the EFI_MTFTP4_PROTOCOL instance.

   @param  Token       The token that the caller provided in the

                       EFI_MTFTP4_PROTOCOL.ReadFile(), WriteFile()

                       or ReadDirectory() function.

   @param  PacketLen   Indicates the length of the packet.

-  @param  Packet      Pointer to an MTFTPv4 packet.

+  @param  Packet      The pointer to an MTFTPv4 packet.

 

-  @retval EFI_SUCCESS Operation sucess

-  @retval Others      Abort transfer process

+  @retval EFI_SUCCESS The operation was successful.

+  @retval Others      Aborts the transfer process.

 

 **/

 typedef

@@ -214,14 +214,14 @@ EFI_STATUS
 /**

   Timeout callback funtion.

 

-  @param  This           Pointer to the EFI_MTFTP4_PROTOCOL instance.

+  @param  This           The pointer to the EFI_MTFTP4_PROTOCOL instance.

   @param  Token          The token that is provided in the

                          EFI_MTFTP4_PROTOCOL.ReadFile() or

                          EFI_MTFTP4_PROTOCOL.WriteFile() or

                          EFI_MTFTP4_PROTOCOL.ReadDirectory() functions

                          by the caller.

 

-  @retval EFI_SUCCESS   Operation sucess

+  @retval EFI_SUCCESS   The operation was successful.

   @retval Others        Aborts download process.

 

 **/

@@ -236,14 +236,14 @@ EFI_STATUS
   A callback function that the caller provides to feed data to the

   EFI_MTFTP4_PROTOCOL.WriteFile() function.

 

-  @param  This   Pointer to the EFI_MTFTP4_PROTOCOL instance.

+  @param  This   The pointer to the EFI_MTFTP4_PROTOCOL instance.

   @param  Token  The token provided in the

                  EFI_MTFTP4_PROTOCOL.WriteFile() by the caller.

   @param  Length Indicates the length of the raw data wanted on input, and the

                  length the data available on output.

-  @param  Buffer Pointer to the buffer where the data is stored.

+  @param  Buffer The pointer to the buffer where the data is stored.

 

-  @retval EFI_SUCCESS Operation sucess

+  @retval EFI_SUCCESS The operation was successful.

   @retval Others      Aborts session.

 

 **/

@@ -260,8 +260,8 @@ EFI_STATUS
 /**

   Submits an asynchronous interrupt transfer to an interrupt endpoint of a USB device.

 

-  @param  This     Pointer to the EFI_MTFTP4_PROTOCOL instance.

-  @param  ModeData Pointer to storage for the EFI MTFTPv4 Protocol driver mode data.

+  @param  This     The pointer to the EFI_MTFTP4_PROTOCOL instance.

+  @param  ModeData The pointer to storage for the EFI MTFTPv4 Protocol driver mode data.

 

   @retval EFI_SUCCESS           The configuration data was successfully returned.

   @retval EFI_OUT_OF_RESOURCES  The required mode data could not be allocated.

@@ -280,8 +280,8 @@ EFI_STATUS
   Initializes, changes, or resets the default operational setting for this

   EFI MTFTPv4 Protocol driver instance.

 

-  @param  This            Pointer to the EFI_MTFTP4_PROTOCOL instance.

-  @param  MtftpConfigData Pointer to the configuration data structure.

+  @param  This            The pointer to the EFI_MTFTP4_PROTOCOL instance.

+  @param  MtftpConfigData The pointer to the configuration data structure.

 

   @retval EFI_SUCCESS           The EFI MTFTPv4 Protocol driver was configured successfully.

   @retval EFI_INVALID_PARAMETER One or more parameters are invalid.

@@ -309,14 +309,14 @@ EFI_STATUS
 /**

   Gets information about a file from an MTFTPv4 server.

 

-  @param  This         Pointer to the EFI_MTFTP4_PROTOCOL instance.

+  @param  This         The pointer to the EFI_MTFTP4_PROTOCOL instance.

   @param  OverrideData Data that is used to override the existing parameters. If NULL,

                        the default parameters that were set in the

                        EFI_MTFTP4_PROTOCOL.Configure() function are used.

-  @param  Filename     Pointer to ASCIIZ file name string.

-  @param  ModeStr      Pointer to ASCIIZ mode string. If NULL, "octet" will be used.

+  @param  Filename     The pointer to ASCIIZ file name string.

+  @param  ModeStr      The pointer to ASCIIZ mode string. If NULL, "octet" will be used.

   @param  OptionCount  Number of option/value string pairs in OptionList.

-  @param  OptionList   Pointer to array of option/value string pairs. Ignored if

+  @param  OptionList   The pointer to array of option/value string pairs. Ignored if

                        OptionCount is zero.

   @param  PacketLength The number of bytes in the returned packet.

   @param  Packet       The pointer to the received packet. This buffer must be freed by

@@ -366,11 +366,11 @@ EFI_STATUS
 /**

   Parses the options in an MTFTPv4 OACK packet.

 

-  @param  This         Pointer to the EFI_MTFTP4_PROTOCOL instance.

+  @param  This         The pointer to the EFI_MTFTP4_PROTOCOL instance.

   @param  PacketLen    Length of the OACK packet to be parsed.

-  @param  Packet       Pointer to the OACK packet to be parsed.

-  @param  OptionCount  Pointer to the number of options in following OptionList.

-  @param  OptionList   Pointer to EFI_MTFTP4_OPTION storage. Call the EFI Boot

+  @param  Packet       The pointer to the OACK packet to be parsed.

+  @param  OptionCount  The pointer to the number of options in following OptionList.

+  @param  OptionList   The pointer to EFI_MTFTP4_OPTION storage. Call the EFI Boot

                        Service FreePool() to release the OptionList if the options

                        in this OptionList are not needed any more.

 

@@ -399,8 +399,8 @@ EFI_STATUS
 /**

   Downloads a file from an MTFTPv4 server.

 

-  @param  This  Pointer to the EFI_MTFTP4_PROTOCOL instance.

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

+  @param  This  The pointer to the EFI_MTFTP4_PROTOCOL instance.

+  @param  Token The pointer to the token structure to provide the parameters that are

                 used in this operation.

 

   @retval EFI_SUCCESS              The data file has been transferred successfully.

@@ -431,8 +431,8 @@ EFI_STATUS
 /**

   Sends a file to an MTFTPv4 server.

 

-  @param  This  Pointer to the EFI_MTFTP4_PROTOCOL instance.

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

+  @param  This  The pointer to the EFI_MTFTP4_PROTOCOL instance.

+  @param  Token The pointer to the token structure to provide the parameters that are

                 used in this operation.

 

   @retval EFI_SUCCESS           The upload session has started.

@@ -461,8 +461,8 @@ EFI_STATUS
   Downloads a data file "directory" from an MTFTPv4 server. May be unsupported in some EFI

   implementations.

 

-  @param  This  Pointer to the EFI_MTFTP4_PROTOCOL instance.

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

+  @param  This  The pointer to the EFI_MTFTP4_PROTOCOL instance.

+  @param  Token The pointer to the token structure to provide the parameters that are

                 used in this operation.

 

   @retval EFI_SUCCESS           The MTFTPv4 related file "directory" has been downloaded.

@@ -489,7 +489,7 @@ EFI_STATUS
 /**

   Polls for incoming data packets and processes outgoing data packets.

 

-  @param  This Pointer to the EFI_MTFTP4_PROTOCOL instance.

+  @param  This The pointer to the EFI_MTFTP4_PROTOCOL instance.

 

   @retval  EFI_SUCCESS           Incoming or outgoing data was processed.

   @retval  EFI_NOT_STARTED       This EFI MTFTPv4 Protocol instance has not been started.

@@ -542,11 +542,11 @@ struct _EFI_MTFTP4_TOKEN {
   ///

   EFI_MTFTP4_OVERRIDE_DATA    *OverrideData;

   ///

-  /// Pointer to the ASCIIZ file name string.

+  /// The pointer to the ASCIIZ file name string.

   ///

   UINT8                       *Filename;

   ///

-  /// Pointer to the ASCIIZ mode string. If NULL, "octet" is used.

+  /// The pointer to the ASCIIZ mode string. If NULL, "octet" is used.

   ///

   UINT8                       *ModeStr;

   ///

@@ -554,34 +554,34 @@ struct _EFI_MTFTP4_TOKEN {
   ///

   UINT32                      OptionCount;

   ///

-  /// Pointer to an array of option/value string pairs. Ignored if OptionCount is zero.

+  /// The pointer to an array of option/value string pairs. Ignored if OptionCount is zero.

   ///

   EFI_MTFTP4_OPTION           *OptionList;

   ///

-  /// Size of the data buffer.

+  /// The size of the data buffer.

   ///

   UINT64                      BufferSize;

   ///

-  /// Pointer to the data buffer. Data that is downloaded from the

+  /// The pointer to the data buffer. Data that is downloaded from the

   /// MTFTPv4 server is stored here. Data that is uploaded to the

   /// MTFTPv4 server is read from here. Ignored if BufferSize is zero.

   ///

   VOID                        *Buffer;

   ///

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

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

   /// TimeoutCallback and PacketNeeded.

   ///

   VOID                        *Context;

   ///

-  /// Pointer to the callback function to check the contents of the received packet.

+  /// The pointer to the callback function to check the contents of the received packet.

   ///

   EFI_MTFTP4_CHECK_PACKET     CheckPacket;

   ///

-  /// Pointer to the function to be called when a timeout occurs.

+  /// The pointer to the function to be called when a timeout occurs.

   ///

   EFI_MTFTP4_TIMEOUT_CALLBACK TimeoutCallback;

   ///

-  /// Pointer to the function to provide the needed packet contents.

+  /// The pointer to the function to provide the needed packet contents.

   ///

   EFI_MTFTP4_PACKET_NEEDED    PacketNeeded;

 };