1. Mark the network volatile variables as deprecated in code comments and remove...

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

diff --git a/MdePkg/Include/Protocol/Udp4.h b/MdePkg/Include/Protocol/Udp4.h
index f1738163275b0a136651fdd9249b1b9f3110085c..dfd550757b2696cdbf2d0404ba91c59b1de13821 100644 (file)
--- a/MdePkg/Include/Protocol/Udp4.h
+++ b/MdePkg/Include/Protocol/Udp4.h
@@ -4,7 +4,7 @@
   The EFI UDPv4 Protocol provides simple packet-oriented services \r
   to transmit and receive UDP packets.  \r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials are licensed and made available under \r
 the terms and conditions of the BSD License that accompanies this distribution.  \r
 The full text of the license may be found at\r
@@ -37,6 +37,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 typedef struct _EFI_UDP4_PROTOCOL EFI_UDP4_PROTOCOL; \r
   \r
+///\r
+/// EFI_UDP4_SERVICE_POINT is deprecated in the UEFI 2.4B and should not be used any more.\r
+/// The definition in here is only present to provide backwards compatability.\r
+///\r
 typedef struct {\r
   EFI_HANDLE              InstanceHandle;\r
   EFI_IPv4_ADDRESS        LocalAddress;\r
@@ -45,6 +49,10 @@ typedef struct {
   UINT16                  RemotePort;\r
 } EFI_UDP4_SERVICE_POINT; \r
 \r
+///\r
+/// EFI_UDP4_VARIABLE_DATA is deprecated in the UEFI 2.4B and should not be used any more.\r
+/// The definition in here is only present to provide backwards compatability.\r
+///\r
 typedef struct {\r
   EFI_HANDLE              DriverHandle;\r
   UINT32                  ServiceCount;\r
@@ -168,7 +176,12 @@ EFI_STATUS
   @retval EFI_SUCCESS           The configuration settings were set, changed, or reset successfully.\r
   @retval EFI_NO_MAPPING        When using a default address, configuration (DHCP, BOOTP,\r
                                 RARP, etc.) is not finished yet.\r
-  @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE:\r
+  @retval EFI_INVALID_PARAMETER This is NULL.\r
+  @retval EFI_INVALID_PARAMETER UdpConfigData.StationAddress is not a valid unicast IPv4 address.\r
+  @retval EFI_INVALID_PARAMETER UdpConfigData.SubnetMask is not a valid IPv4 address mask. The subnet\r
+                                mask must be contiguous.\r
+  @retval EFI_INVALID_PARAMETER UdpConfigData.RemoteAddress is not a valid unicast IPv4 address if it\r
+                                is not zero.\r
   @retval EFI_ALREADY_STARTED   The EFI UDPv4 Protocol instance is already started/configured\r
                                 and must be stopped/reset before it can be reconfigured.\r
   @retval EFI_ACCESS_DENIED     UdpConfigData. AllowDuplicatePort is FALSE\r
@@ -318,7 +331,9 @@ EFI_STATUS
   @retval EFI_NOT_STARTED       This EFI UDPv4 Protocol instance has not been started.\r
   @retval EFI_NO_MAPPING        When using a default address, configuration (DHCP, BOOTP, RARP, etc.)\r
                                 is not finished yet.\r
-  @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+  @retval EFI_INVALID_PARAMETER This is NULL.\r
+  @retval EFI_INVALID_PARAMETER Token is NULL.\r
+  @retval EFI_INVALID_PARAMETER Token.Event is NULL.\r
   @retval EFI_OUT_OF_RESOURCES  The receive completion token could not be queued due to a lack of system\r
                                 resources (usually memory).\r
   @retval EFI_DEVICE_ERROR      An unexpected system or network error occurred.\r