Add some comments.

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

diff --git a/MdePkg/Include/Protocol/Ip6.h b/MdePkg/Include/Protocol/Ip6.h
index e26bc8c94b6063470ec69eb563fc56c25acf30a3..590c9818013c98ac723242cbf485d7d73f4611e6 100644 (file)
--- a/MdePkg/Include/Protocol/Ip6.h
+++ b/MdePkg/Include/Protocol/Ip6.h
@@ -44,6 +44,7 @@ typedef struct _EFI_IP6_PROTOCOL EFI_IP6_PROTOCOL;
 \r
 ///\r
 /// EFI_IP6_ADDRESS_PAIR \r
+/// which is not defined in the UEFI 2.3 Specification.\r
 ///\r
 typedef struct{ \r
   ///\r
@@ -62,6 +63,7 @@ typedef struct{
 \r
 ///\r
 /// EFI_IP6_VARIABLE_DATA\r
+/// which is not defined in the UEFI 2.3 Specification.\r
 ///\r
 typedef struct {\r
   ///\r

diff --git a/MdePkg/Include/Protocol/Mtftp4.h b/MdePkg/Include/Protocol/Mtftp4.h
index 04095acffb156dd9dacdea287bef73d701ec73bb..095b81b285fad393bb0552192d0ca98782dac96a 100644 (file)
--- a/MdePkg/Include/Protocol/Mtftp4.h
+++ b/MdePkg/Include/Protocol/Mtftp4.h
@@ -323,6 +323,7 @@ EFI_STATUS
                        the caller.\r
 \r
   @retval EFI_SUCCESS              An MTFTPv4 OACK packet was received and is in the Packet.\r
+                                   Note: It does not match UEFI 2.3 Specification.\r
   @retval EFI_INVALID_PARAMETER    One or more of the following conditions is TRUE:\r
                                    - This is NULL.\r
                                    - Filename is NULL.\r
@@ -340,11 +341,17 @@ EFI_STATUS
   @retval EFI_OUT_OF_RESOURCES     Required system resources could not be allocated.\r
   @retval EFI_TFTP_ERROR           An MTFTPv4 ERROR packet was received and is in the Packet.\r
   @retval EFI_NETWORK_UNREACHABLE  An ICMP network unreachable error packet was received and the Packet is set to NULL.\r
+                                   Note: It is not defined in UEFI 2.3 Specification.\r
   @retval EFI_HOST_UNREACHABLE     An ICMP host unreachable error packet was received and the Packet is set to NULL.\r
+                                   Note: It is not defined in UEFI 2.3 Specification.\r
   @retval EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received and the Packet is set to NULL.\r
+                                   Note: It is not defined in UEFI 2.3 Specification.\r
   @retval EFI_PORT_UNREACHABLE     An ICMP port unreachable error packet was received and the Packet is set to NULL.\r
+                                   Note: It is not defined in UEFI 2.3 Specification.\r
   @retval EFI_ICMP_ERROR           Some other ICMP ERROR packet was received and is in the Buffer.\r
+                                   Note: It does not match UEFI 2.3 Specification.\r
   @retval EFI_PROTOCOL_ERROR       An unexpected MTFTPv4 packet was received and is in the Packet.\r
+                                   Note: It does not match UEFI 2.3 Specification.\r
   @retval EFI_TIMEOUT              No responses were received from the MTFTPv4 server.\r
   @retval EFI_DEVICE_ERROR         An unexpected network error or system error occurred.\r
 \r
@@ -406,12 +413,18 @@ EFI_STATUS
   @retval EFI_OUT_OF_RESOURCES     Required system resources could not be allocated.\r
   @retval EFI_BUFFER_TOO_SMALL     BufferSize is not zero but not large enough to hold the\r
                                    downloaded data in downloading process.\r
+                                                                  Note: It does not match UEFI 2.3 Specification.\r
   @retval EFI_ABORTED              Current operation is aborted by user.\r
   @retval EFI_NETWORK_UNREACHABLE  An ICMP network unreachable error packet was received.\r
+                                   Note: It is not defined in UEFI 2.3 Specification.\r
   @retval EFI_HOST_UNREACHABLE     An ICMP host unreachable error packet was received.\r
+                                   Note: It is not defined in UEFI 2.3 Specification.\r
   @retval EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received.\r
+                                   Note: It is not defined in UEFI 2.3 Specification.\r
   @retval EFI_PORT_UNREACHABLE     An ICMP port unreachable error packet was received.\r
+                                   Note: It is not defined in UEFI 2.3 Specification.\r
   @retval EFI_ICMP_ERROR           Some other  ICMP ERROR packet was received.\r
+                                   Note: It does not match UEFI 2.3 Specification.\r
   @retval EFI_TIMEOUT              No responses were received from the MTFTPv4 server.\r
   @retval EFI_TFTP_ERROR           An MTFTPv4 ERROR packet was received.\r
   @retval EFI_DEVICE_ERROR         An unexpected network error or system error occurred.\r

diff --git a/MdePkg/Include/Protocol/Mtftp6.h b/MdePkg/Include/Protocol/Mtftp6.h
index c22ab3a77c57e26c02dd52d06f444a1e611b2232..9debfe66d4ec5f11fa90e3f3251d2e0bd938dede 100644 (file)
--- a/MdePkg/Include/Protocol/Mtftp6.h
+++ b/MdePkg/Include/Protocol/Mtftp6.h
@@ -503,15 +503,19 @@ EFI_STATUS
                                  - MtftpConfigData.StationIp is neither zero nor one \r
                                    of the configured IP addresses in the underlying IPv6 driver.\r
                                  - MtftpCofigData.ServerIp is not a valid IPv6 unicast address.\r
+                                 Note: It does not match UEFI 2.3 Specification.\r
   @retval  EFI_ACCESS_DENIED     - The configuration could not be changed at this time because there \r
                                    is some MTFTP background operation in progress.\r
                                  - MtftpCofigData.LocalPort is already in use.\r
+                                                                Note: It does not match UEFI 2.3 Specification.\r
   @retval  EFI_NO_MAPPING        The underlying IPv6 driver was responsible for choosing a source \r
                                  address for this instance, but no source address was available for use.\r
   @retval  EFI_OUT_OF_RESOURCES  The EFI MTFTPv6 Protocol driver instance data could not be \r
                                  allocated.\r
+                                                                Note: It is not defined in UEFI 2.3 Specification.\r
   @retval  EFI_DEVICE_ERROR      An unexpected system or network error occurred. The EFI \r
                                  MTFTPv6 Protocol driver instance is not configured.\r
+                                                                Note: It is not defined in UEFI 2.3 Specification.\r
 \r
 \r
 **/\r
@@ -544,6 +548,7 @@ EFI_STATUS
                                  the caller.\r
 \r
   @retval  EFI_SUCCESS              An MTFTPv6 OACK packet was received and is in the Packet.\r
+                                    Note: It does not match UEFI 2.3 Specification.\r
   @retval  EFI_INVALID_PARAMETER    One or more of the following conditions is TRUE:\r
                                     - This is NULL.\r
                                     - Filename is NULL\r
@@ -560,10 +565,14 @@ EFI_STATUS
   @retval  EFI_OUT_OF_RESOURCES     Required system resources could not be allocated.\r
   @retval  EFI_TFTP_ERROR           An MTFTPv6 ERROR packet was received and is in the Packet.\r
   @retval  EFI_NETWORK_UNREACHABLE  An ICMP network unreachable error packet was received and the Packet is set to NULL.\r
+                                    Note: It is not defined in UEFI 2.3 Specification.\r
   @retval  EFI_HOST_UNREACHABLE     An ICMP host unreachable error packet was received and the Packet is set to NULL.\r
+                                    Note: It is not defined in UEFI 2.3 Specification.\r
   @retval  EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received and the Packet is set to NULL.\r
+                                    Note: It is not defined in UEFI 2.3 Specification.\r
   @retval  EFI_PORT_UNREACHABLE     An ICMP port unreachable error packet was received and the Packet is set to NULL.\r
   @retval  EFI_ICMP_ERROR           Some other ICMP ERROR packet was received and the Packet is set to NULL.\r
+                                    Note: It does not match UEFI 2.3 Specification.\r
   @retval  EFI_PROTOCOL_ERROR       An unexpected MTFTPv6 packet was received and is in the Packet.\r
   @retval  EFI_TIMEOUT              No responses were received from the MTFTPv6 server.\r
   @retval  EFI_DEVICE_ERROR         An unexpected network error or system error occurred.\r
@@ -645,11 +654,16 @@ EFI_STATUS
   @retval  EFI_OUT_OF_RESOURCES     Required system resources could not be allocated.\r
   @retval  EFI_BUFFER_TOO_SMALL     BufferSize is not zero but not large enough to hold the\r
                                     downloaded data in downloading process.\r
+                                                                       Note: It does not match UEFI 2.3 Specification.\r
   @retval  EFI_ABORTED              Current operation is aborted by user.\r
   @retval  EFI_NETWORK_UNREACHABLE  An ICMP network unreachable error packet was received.\r
+                                    Note: It is not defined in UEFI 2.3 Specification.\r
   @retval  EFI_HOST_UNREACHABLE     An ICMP host unreachable error packet was received.\r
+                                    Note: It is not defined in UEFI 2.3 Specification.\r
   @retval  EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received.\r
+                                    Note: It is not defined in UEFI 2.3 Specification.\r
   @retval  EFI_PORT_UNREACHABLE     An ICMP port unreachable error packet was received.\r
+                                    Note: It is not defined in UEFI 2.3 Specification.\r
   @retval  EFI_ICMP_ERROR           An ICMP ERROR packet was received.\r
   @retval  EFI_TIMEOUT              No responses were received from the MTFTPv6 server.\r
   @retval  EFI_TFTP_ERROR           An MTFTPv6 ERROR packet was received.\r

diff --git a/MdePkg/Include/Protocol/Tcp4.h b/MdePkg/Include/Protocol/Tcp4.h
index 71aec843b69948a2c66331e158ba24af972dd9cc..c0652a683a1ce48c0a058c432a214c5891b8eb2c 100644 (file)
--- a/MdePkg/Include/Protocol/Tcp4.h
+++ b/MdePkg/Include/Protocol/Tcp4.h
@@ -128,6 +128,7 @@ typedef struct {
   ///                           either by instance itself or the communication peer.\r
   /// EFI_CONNECTION_REFUSED:   The connect fails because this connection is initiated with\r
   ///                           an active open and the connection is refused.\r
+  ///                           Note: It is not defined in UEFI 2.3 Specification.\r
   /// EFI_ABORTED:              The active open is aborted.\r
   /// EFI_TIMEOUT:              The connection establishment timer expires and \r
   ///                           no more specific information is available.\r
@@ -180,6 +181,7 @@ typedef struct {
   /// EFI_CONNECTION_FIN:       The receiving operation fails because the communication peer \r
   ///                           has closed the connection and there is no more data in the \r
   ///                           receive buffer of the instance.\r
+  ///                           Note: It is not defined in UEFI 2.3 Specification.\r
   /// EFI_CONNECTION_RESET:     The receiving or transmission operation fails\r
   ///                           because this connection is reset either by instance \r
   ///                           itself or the communication peer.\r
@@ -513,6 +515,7 @@ EFI_STATUS
                                    transmission or receive queue. It has either \r
                                    completed or wasn't issued by Transmit() and Receive().\r
   @retval  EFI_UNSUPPORTED         The implementation does not support this function.\r
+                                   Note: It is not defined in UEFI 2.3 Specification.\r
 \r
 **/\r
 typedef\r

diff --git a/MdePkg/Include/Protocol/Tcp6.h b/MdePkg/Include/Protocol/Tcp6.h
index 7b851796cf86a0de5e0d718dc797bc10bbbb909d..913eb860b10f58c77c0cf17e52d79df19b6a52fd 100644 (file)
--- a/MdePkg/Include/Protocol/Tcp6.h
+++ b/MdePkg/Include/Protocol/Tcp6.h
@@ -291,6 +291,7 @@ typedef struct {
   ///                           either by instance itself or the communication peer.\r
   /// EFI_CONNECTION_REFUSED:   The receiving or transmission operation fails because this \r
   ///                           connection is refused.\r
+  ///                           Note: It is not defined in UEFI 2.3 Specification.\r
   /// EFI_ABORTED:              The active open is aborted.\r
   /// EFI_TIMEOUT:              The connection establishment timer expires and \r
   ///                           no more specific information is available.\r
@@ -414,6 +415,7 @@ typedef struct {
   /// EFI_CONNECTION_FIN:       The receiving operation fails because the communication peer \r
   ///                           has closed the connection and there is no more data in the \r
   ///                           receive buffer of the instance.\r
+  ///                           Note: It is not defined in UEFI 2.3 Specification.\r
   /// EFI_CONNECTION_RESET:     The receiving or transmission operation fails\r
   ///                           because this connection is reset either by instance \r
   ///                           itself or the communication peer.\r