]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/Mtftp4.h
Clarify the UEFI/EFI specification version in file header comments.
[mirror_edk2.git] / MdePkg / Include / Protocol / Mtftp4.h
index 149c6270e01eba5df7b1063d5a74c7d11020da4f..a7b251e00153d6053043b557c5a05320f43f4852 100644 (file)
@@ -1,14 +1,17 @@
 /** @file\r
   EFI Multicast Trivial File Tranfer Protocol Definition\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2009, 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
   http://opensource.org/licenses/bsd-license.php                                            \r
 \r
   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
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.   \r
+\r
+  @par Revision Reference:          \r
+  This Protocol is introduced in UEFI Specification 2.0\r
 \r
 **/\r
 \r
@@ -184,7 +187,7 @@ typedef struct {
 /**\r
   A callback function that is provided by the caller to intercept               \r
   the EFI_MTFTP4_OPCODE_DATA or EFI_MTFTP4_OPCODE_DATA8 packets processed in the\r
-  EFI_MTFTP4_PROTOCOL.ReadFile() function, or alternatively to intercept       \r
+  EFI_MTFTP4_PROTOCOL.ReadFile() function, and alternatively to intercept       \r
   EFI_MTFTP4_OPCODE_OACK or EFI_MTFTP4_OPCODE_ERROR packets during a call to    \r
   EFI_MTFTP4_PROTOCOL.ReadFile(), WriteFile() or ReadDirectory().                   \r
 \r
@@ -356,8 +359,8 @@ EFI_STATUS
   @param  Packet       Pointer to the OACK packet to be parsed.\r
   @param  OptionCount  Pointer to the number of options in following OptionList.\r
   @param  OptionList   Pointer to EFI_MTFTP4_OPTION storage. Call the EFI Boot\r
-                       Service FreePool() to release each option if they are not\r
-                       needed any more.\r
+                       Service FreePool() to release the OptionList if the options\r
+                       in this OptionList are not needed any more.\r
 \r
   @retval EFI_SUCCESS           The OACK packet was valid and the OptionCount and\r
                                 OptionList parameters have been updated.\r
@@ -540,13 +543,18 @@ struct _EFI_MTFTP4_TOKEN {
   ///\r
   /// Size of the data buffer.\r
   ///\r
-  OUT UINT64                  BufferSize;\r
+  UINT64                      BufferSize;\r
   ///\r
   /// Pointer to the data buffer. Data that is downloaded from the\r
   /// MTFTPv4 server is stored here. Data that is uploaded to the\r
   /// MTFTPv4 server is read from here. Ignored if BufferSize is zero.\r
   ///\r
-  OUT VOID                    *Buffer;\r
+  VOID                        *Buffer;\r
+  ///\r
+  /// Pointer to the context that will be used by CheckPacket, \r
+  /// TimeoutCallback and PacketNeeded.\r
+  ///\r
+  VOID                        *Context;\r
   ///\r
   /// Pointer to the callback function to check the contents of the received packet.\r
   ///\r