MdePkg: Update the comments of Ip4Config2/Ip6Config Protocol

Update the comments of Ip4Config2/Ip6Config Protocol to consistent
with UEFI Spec 2.7, which provides the capability to clear specific
individual data types.

Cc: Ye Ting <ting.ye@intel.com>
Cc: Fu Siyuan <siyuan.fu@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Wu Jiaxin <jiaxin.wu@intel.com>
Reviewed-by: Ye Ting <ting.ye@intel.com>

diff --git a/MdePkg/Include/Protocol/Ip4Config2.h b/MdePkg/Include/Protocol/Ip4Config2.h
index fca2bb5e2d57620d794244b6f2d13dfab795badb..ced63cbcbf7768c4ab3d66e74d673b1dc05784fb 100644 (file)
--- a/MdePkg/Include/Protocol/Ip4Config2.h
+++ b/MdePkg/Include/Protocol/Ip4Config2.h
@@ -2,7 +2,7 @@
   This file provides a definition of the EFI IPv4 Configuration II\r
   Protocol.\r
 \r
-Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR>\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<BR>\r
@@ -51,7 +51,9 @@ typedef enum {
   /// The station addresses set manually for the EFI IPv4 network \r
   /// stack. It is only configurable when the policy is \r
   /// Ip4Config2PolicyStatic. The corresponding Data is of \r
-  /// type EFI_IP4_CONFIG2_MANUAL_ADDRESS.\r
+  /// type EFI_IP4_CONFIG2_MANUAL_ADDRESS. When DataSize \r
+  /// is 0 and Data is NULL, the existing configuration is cleared \r
+  /// from the EFI IPv4 Configuration II Protocol instance.\r
   ///\r
   Ip4Config2DataTypeManualAddress,\r
   ///\r
@@ -61,6 +63,8 @@ typedef enum {
   /// the policy is Ip4Config2PolicyDhcp. The gateway \r
   /// addresses must be unicast IPv4 addresses. The corresponding \r
   /// Data is a pointer to an array of EFI_IPv4_ADDRESS instances.\r
+  /// When DataSize is 0 and Data is NULL, the existing configuration \r
+  /// is cleared from the EFI IPv4 Configuration II Protocol instance.\r
   ///\r
   Ip4Config2DataTypeGateway,\r
   ///\r
@@ -69,7 +73,9 @@ typedef enum {
   /// Protocol manages. It is not configurable when the policy is \r
   /// Ip4Config2PolicyDhcp. The DNS server addresses must be \r
   /// unicast IPv4 addresses. The corresponding Data is a pointer to \r
-  /// an array of EFI_IPv4_ADDRESS instances.\r
+  /// an array of EFI_IPv4_ADDRESS instances. When DataSize \r
+  /// is 0 and Data is NULL, the existing configuration is cleared \r
+  /// from the EFI IPv4 Configuration II Protocol instance.\r
   ///\r
   Ip4Config2DataTypeDnsServer,\r
   Ip4Config2DataTypeMaximum\r
@@ -186,9 +192,8 @@ typedef struct {
                                   successfully.\r
   @retval EFI_INVALID_PARAMETER   One or more of the following are TRUE:\r
                                   This is NULL.\r
-                                  Data is NULL.\r
-                                  One or more fields in Data do not match the requirement of the data type \r
-                                  indicated by DataType.\r
+                                  One or more fields in Data and DataSize do not match the \r
+                                  requirement of the data type indicated by DataType.\r
   @retval EFI_WRITE_PROTECTED     The specified configuration data is read-only or the specified configuration \r
                                   data can not be set under the current policy.\r
   @retval EFI_ACCESS_DENIED       Another set operation on the specified configuration data is already in process.\r

diff --git a/MdePkg/Include/Protocol/Ip6Config.h b/MdePkg/Include/Protocol/Ip6Config.h
index b2c3be9ee7cf54e86757607642a23735d5ae46a4..bcb8ba2c6ffc39d994fbe55e0a75eab061b9c71b 100644 (file)
--- a/MdePkg/Include/Protocol/Ip6Config.h
+++ b/MdePkg/Include/Protocol/Ip6Config.h
@@ -2,7 +2,7 @@
   This file provides a definition of the EFI IPv6 Configuration\r
   Protocol.\r
 \r
-Copyright (c) 2008 - 2011, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2008 - 2017, Intel Corporation. All rights reserved.<BR>\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<BR>\r
@@ -66,7 +66,9 @@ typedef enum {
   /// The station addresses set manually for the EFI \r
   /// IPv6 network stack. It is only configurable when the policy is \r
   /// Ip6ConfigPolicyManual. The corresponding Data is a \r
-  /// pointer to an array of EFI_IPv6_ADDRESS instances.\r
+  /// pointer to an array of EFI_IPv6_ADDRESS instances. When \r
+  /// DataSize is 0 and Data is NULL, the existing configuration \r
+  /// is cleared from the EFI IPv6 Configuration Protocol instance.\r
   /// \r
   Ip6ConfigDataTypeManualAddress,\r
   /// \r
@@ -76,6 +78,8 @@ typedef enum {
   /// the policy is Ip6ConfigPolicyAutomatic. The gateway \r
   /// addresses must be unicast IPv6 addresses. The corresponding \r
   /// Data is a pointer to an array of EFI_IPv6_ADDRESS instances.\r
+  /// When DataSize is 0 and Data is NULL, the existing configuration \r
+  /// is cleared from the EFI IPv6 Configuration Protocol instance.\r
   /// \r
   Ip6ConfigDataTypeGateway,\r
   /// \r
@@ -85,6 +89,8 @@ typedef enum {
   /// policy is Ip6ConfigPolicyAutomatic.The DNS server \r
   /// addresses must be unicast IPv6 addresses. The corresponding \r
   /// Data is a pointer to an array of EFI_IPv6_ADDRESS instances.\r
+  /// When DataSize is 0 and Data is NULL, the existing configuration \r
+  /// is cleared from the EFI IPv6 Configuration Protocol instance.\r
   /// \r
   Ip6ConfigDataTypeDnsServer,\r
   ///\r
@@ -228,9 +234,8 @@ typedef struct {
                                 network stack is set successfully.\r
   @retval EFI_INVALID_PARAMETER One or more of the following are TRUE:\r
                                 - This is NULL.\r
-                                - Data is NULL.\r
-                                - One or more fields in Data do not match the requirement of the \r
-                                  data type indicated by DataType. \r
+                                - One or more fields in Data and DataSize do not match the \r
+                                  requirement of the data type indicated by DataType. \r
   @retval EFI_WRITE_PROTECTED   The specified configuration data is read-only or the specified \r
                                 configuration data can not be set under the current policy\r
   @retval EFI_ACCESS_DENIED     Another set operation on the specified configuration \r