Updated network related definitions.

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

diff --git a/MdePkg/Include/Protocol/Mtftp4.h b/MdePkg/Include/Protocol/Mtftp4.h
index a7b251e00153d6053043b557c5a05320f43f4852..04095acffb156dd9dacdea287bef73d701ec73bb 100644 (file)
--- a/MdePkg/Include/Protocol/Mtftp4.h
+++ b/MdePkg/Include/Protocol/Mtftp4.h
@@ -322,20 +322,31 @@ EFI_STATUS
   @param  Packet       The pointer to the received packet. This buffer must be freed by\r
                        the caller.\r
 \r
-  @retval EFI_SUCCESS           An MTFTPv4 OACK packet was received and is in the Buffer.\r
-  @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
-  @retval EFI_UNSUPPORTED       One or more options in the OptionList are in the\r
-                                unsupported list of structure EFI_MTFTP4_MODE_DATA.\r
-  @retval EFI_NOT_STARTED       The EFI MTFTPv4 Protocol driver has not been started.\r
-  @retval EFI_NO_MAPPING        When using a default address, configuration (DHCP, BOOTP,\r
-                                RARP, etc.) has not finished yet.\r
-  @retval EFI_ACCESS_DENIED     The previous operation has not completed yet.\r
-  @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 buffer.\r
-  @retval EFI_ICMP_ERROR        An ICMP ERROR packet was received and is in the Buffer.\r
-  @retval EFI_PROTOCOL_ERROR    An unexpected MTFTPv4 packet was received and is in the buffer.\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
+  @retval EFI_SUCCESS              An MTFTPv4 OACK packet was received and is in the Packet.\r
+  @retval EFI_INVALID_PARAMETER    One or more of the following conditions is TRUE:\r
+                                   - This is NULL.\r
+                                   - Filename is NULL.\r
+                                   - OptionCount is not zero and OptionList is NULL.\r
+                                   - One or more options in OptionList have wrong format.\r
+                                   - PacketLength is NULL.\r
+                                   - One or more IPv4 addresses in OverrideData are not valid\r
+                                     unicast IPv4 addresses if OverrideData is not NULL.\r
+  @retval EFI_UNSUPPORTED          One or more options in the OptionList are in the\r
+                                   unsupported list of structure EFI_MTFTP4_MODE_DATA.\r
+  @retval EFI_NOT_STARTED          The EFI MTFTPv4 Protocol driver has not been started.\r
+  @retval EFI_NO_MAPPING           When using a default address, configuration (DHCP, BOOTP,\r
+                                   RARP, etc.) has not finished yet.\r
+  @retval EFI_ACCESS_DENIED        The previous operation has not completed yet.\r
+  @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
+  @retval EFI_HOST_UNREACHABLE     An ICMP host unreachable error packet was received and the Packet is set to NULL.\r
+  @retval EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received and the Packet is set to NULL.\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 is in the Buffer.\r
+  @retval EFI_PROTOCOL_ERROR       An unexpected MTFTPv4 packet was received and is in the Packet.\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
 **/\r
 typedef \r
@@ -391,15 +402,19 @@ EFI_STATUS
   @param  Token Pointer to the token structure to provide the parameters that are\r
                 used in this operation.\r
 \r
-  @retval EFI_SUCCESS          The data file has been transferred successfully.\r
-  @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r
-  @retval EFI_BUFFER_TOO_SMALL BufferSize is not large enough to hold the downloaded data\r
-                               in downloading process.\r
-  @retval EFI_ABORTED          Current operation is aborted by user.\r
-  @retval EFI_ICMP_ERROR       An ICMP ERROR packet was received.\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
+  @retval EFI_SUCCESS              The data file has been transferred successfully.\r
+  @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
+  @retval EFI_ABORTED              Current operation is aborted by user.\r
+  @retval EFI_NETWORK_UNREACHABLE  An ICMP network unreachable error packet was received.\r
+  @retval EFI_HOST_UNREACHABLE     An ICMP host unreachable error packet was received.\r
+  @retval EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received.\r
+  @retval EFI_PORT_UNREACHABLE     An ICMP port unreachable error packet was received.\r
+  @retval EFI_ICMP_ERROR           Some other  ICMP ERROR packet was received.\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
 \r
 **/\r
 typedef \r