MdePkg: Add header file for HTTP Boot Callback protocol in UEFI 2.7.

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

diff --git a/MdePkg/Include/Protocol/Mtftp6.h b/MdePkg/Include/Protocol/Mtftp6.h
index f35d42515a04db022e70d4cfd0160d1f3e2b6ebb..4667addeec37537d82c80f76cc37541ae0e084b2 100644 (file)
--- a/MdePkg/Include/Protocol/Mtftp6.h
+++ b/MdePkg/Include/Protocol/Mtftp6.h
@@ -1,10 +1,12 @@
 /** @file\r
-  UEFI Multicast Trivial File Tranfer Protocol v6 Definition, which is built upon\r
+  UEFI Multicast Trivial File Transfer Protocol v6 Definition, which is built upon\r
   the EFI UDPv6 Protocol and provides basic services for client-side unicast and/or\r
   multicast TFTP operations.\r
 \r
-  Copyright (c) 2008 - 2010, Intel Corporation\r
-  All rights reserved. This program and the accompanying materials\r
+  Copyright (c) 2008 - 2011, Intel Corporation. All rights reserved.<BR>\r
+  (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
+\r
+  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
@@ -70,7 +72,7 @@ typedef struct _EFI_MTFTP6_TOKEN    EFI_MTFTP6_TOKEN;
 ///\r
 /// The MTFTPv6 operation was illegal.\r
 ///\r
-#define EFI_MTFTP6_ERRORCODE_ILLEGAL_OPERATION     6\r
+#define EFI_MTFTP6_ERRORCODE_ILLEGAL_OPERATION     4\r
 ///\r
 /// The transfer ID is unknown.\r
 ///\r
@@ -265,7 +267,7 @@ typedef struct {
   ///\r
   UINT8                   SupportedOptionCount;\r
   ///\r
-  /// An array of option strings that are recognized and supported by\r
+  /// An array of null-terminated ASCII option strings that are recognized and supported by\r
   /// this EFI MTFTPv6 Protocol driver implementation. The buffer is\r
   /// read only to the caller and the caller should NOT free the buffer.\r
   ///\r
@@ -304,8 +306,8 @@ typedef struct {
 /// EFI_MTFTP6_OPTION\r
 ///\r
 typedef struct {\r
-  UINT8                  *OptionStr; ///< Pointer to the ASCIIZ MTFTPv6 option string.\r
-  UINT8                  *ValueStr;  ///< Pointer to the ASCIIZ MTFTPv6 value string.\r
+  UINT8                  *OptionStr; ///< Pointer to the null-terminated ASCII MTFTPv6 option string.\r
+  UINT8                  *ValueStr;  ///< Pointer to the null-terminated ASCII MTFTPv6 value string.\r
 } EFI_MTFTP6_OPTION;\r
 \r
 /**\r
@@ -323,7 +325,7 @@ typedef struct {
   @param[in] PacketLen     Indicates the length of the packet.\r
   @param[in] Packet        Pointer to an MTFTPv6 packet.\r
 \r
-  @retval EFI_SUCCESS      Operation sucess.\r
+  @retval EFI_SUCCESS      Operation success.\r
   @retval Others           Aborts session.\r
 \r
 **/\r
@@ -350,7 +352,7 @@ EFI_STATUS
                            EFI_MTFTP6_PROTOCOL.WriteFile() or EFI_MTFTP6_PROTOCOL.ReadDirectory()\r
                            functions by the caller.\r
 \r
-  @retval EFI_SUCCESS      Operation sucess.\r
+  @retval EFI_SUCCESS      Operation success.\r
   @retval Others           Aborts session.\r
 \r
 **/\r
@@ -377,7 +379,7 @@ EFI_STATUS
                            length the data available on output.\r
   @param[out]     Buffer   Pointer to the buffer where the data is stored.\r
 \r
-  @retval EFI_SUCCESS      Operation sucess.\r
+  @retval EFI_SUCCESS      Operation success.\r
   @retval Others           Aborts session.\r
 \r
 **/\r
@@ -409,11 +411,11 @@ struct _EFI_MTFTP6_TOKEN {
   ///\r
   EFI_MTFTP6_OVERRIDE_DATA    *OverrideData;\r
   ///\r
-  /// Pointer to the ASCIIZ file name string.\r
+  /// Pointer to the null-terminated ASCII file name string.\r
   ///\r
   UINT8                       *Filename;\r
   ///\r
-  /// Pointer to the ASCIIZ mode string. If NULL, octet is used.\r
+  /// Pointer to the null-terminated ASCII mode string. If NULL, octet is used.\r
   ///\r
   UINT8                       *ModeStr;\r
   ///\r
@@ -534,8 +536,8 @@ EFI_STATUS
   @param[in]  OverrideData       Data that is used to override the existing parameters. If NULL, the\r
                                  default parameters that were set in the EFI_MTFTP6_PROTOCOL.Configure()\r
                                  function are used.\r
-  @param[in]  Filename           Pointer to ASCIIZ file name string.\r
-  @param[in]  ModeStr            Pointer to ASCIIZ mode string. If NULL, octet will be used\r
+  @param[in]  Filename           Pointer to null-terminated ASCII file name string.\r
+  @param[in]  ModeStr            Pointer to null-terminated ASCII mode string. If NULL, octet will be used\r
   @param[in]  OptionCount        Number of option/value string pairs in OptionList.\r
   @param[in]  OptionList         Pointer to array of option/value string pairs. Ignored if\r
                                  OptionCount is zero.\r