Add some comments.

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

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