From nobody Fri Dec 27 18:35:54 2024 Delivered-To: importer@patchew.org Received-SPF: none (zoho.com: 198.145.21.10 is neither permitted nor denied by domain of lists.01.org) client-ip=198.145.21.10; envelope-from=edk2-devel-bounces@lists.01.org; helo=ml01.01.org; Authentication-Results: mx.zohomail.com; spf=none (zoho.com: 198.145.21.10 is neither permitted nor denied by domain of lists.01.org) smtp.mailfrom=edk2-devel-bounces@lists.01.org Return-Path: Received: from ml01.01.org (ml01.01.org [198.145.21.10]) by mx.zohomail.com with SMTPS id 1501050522981538.7864791391103; Tue, 25 Jul 2017 23:28:42 -0700 (PDT) Received: from [127.0.0.1] (localhost [IPv6:::1]) by ml01.01.org (Postfix) with ESMTP id 72E5821C9127A; Tue, 25 Jul 2017 23:26:37 -0700 (PDT) Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 548CC21AEB0C0 for ; Tue, 25 Jul 2017 23:26:35 -0700 (PDT) Received: from orsmga003.jf.intel.com ([10.7.209.27]) by fmsmga105.fm.intel.com with ESMTP; 25 Jul 2017 23:28:37 -0700 Received: from jiaxinwu-mobl2.ccr.corp.intel.com ([10.239.196.131]) by orsmga003.jf.intel.com with ESMTP; 25 Jul 2017 23:28:36 -0700 X-Original-To: edk2-devel@lists.01.org X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.40,413,1496127600"; d="scan'208";a="997280361" From: Jiaxin Wu To: edk2-devel@lists.01.org Date: Wed, 26 Jul 2017 14:28:29 +0800 Message-Id: <1501050511-16884-2-git-send-email-jiaxin.wu@intel.com> X-Mailer: git-send-email 1.9.5.msysgit.1 In-Reply-To: <1501050511-16884-1-git-send-email-jiaxin.wu@intel.com> References: <1501050511-16884-1-git-send-email-jiaxin.wu@intel.com> Subject: [edk2] [Patch 1/3] MdePkg: Update the comments of Ip4Config2/Ip6Config Protocol X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.22 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Ye Ting , Fu Siyuan , Wu Jiaxin MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Errors-To: edk2-devel-bounces@lists.01.org Sender: "edk2-devel" X-ZohoMail: RSF_4 Z_629925259 SPT_0 Content-Type: text/plain; charset="utf-8" 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 Cc: Fu Siyuan Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Wu Jiaxin --- MdePkg/Include/Protocol/Ip4Config2.h | 17 +++++++++++------ MdePkg/Include/Protocol/Ip6Config.h | 15 ++++++++++----- 2 files changed, 21 insertions(+), 11 deletions(-) diff --git a/MdePkg/Include/Protocol/Ip4Config2.h b/MdePkg/Include/Protocol= /Ip4Config2.h index fca2bb5..ced63cb 100644 --- a/MdePkg/Include/Protocol/Ip4Config2.h +++ b/MdePkg/Include/Protocol/Ip4Config2.h @@ -1,10 +1,10 @@ /** @file This file provides a definition of the EFI IPv4 Configuration II Protocol. =20 -Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.
+Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD = License which accompanies this distribution. The full text of the license may be = found at
http://opensource.org/licenses/bsd-license.php =20 @@ -49,29 +49,35 @@ typedef enum { Ip4Config2DataTypePolicy, /// /// The station addresses set manually for the EFI IPv4 network=20 /// stack. It is only configurable when the policy is=20 /// Ip4Config2PolicyStatic. The corresponding Data is of=20 - /// type EFI_IP4_CONFIG2_MANUAL_ADDRESS. + /// type EFI_IP4_CONFIG2_MANUAL_ADDRESS. When DataSize=20 + /// is 0 and Data is NULL, the existing configuration is cleared=20 + /// from the EFI IPv4 Configuration II Protocol instance. /// Ip4Config2DataTypeManualAddress, /// /// The gateway addresses set manually for the EFI IPv4 network=20 /// stack running on the communication device this EFI IPv4=20 /// Configuration II Protocol manages. It is not configurable when=20 /// the policy is Ip4Config2PolicyDhcp. The gateway=20 /// addresses must be unicast IPv4 addresses. The corresponding=20 /// Data is a pointer to an array of EFI_IPv4_ADDRESS instances. + /// When DataSize is 0 and Data is NULL, the existing configuration=20 + /// is cleared from the EFI IPv4 Configuration II Protocol instance. /// Ip4Config2DataTypeGateway, /// /// The DNS server list for the EFI IPv4 network stack running on=20 /// the communication device this EFI IPv4 Configuration II=20 /// Protocol manages. It is not configurable when the policy is=20 /// Ip4Config2PolicyDhcp. The DNS server addresses must be=20 /// unicast IPv4 addresses. The corresponding Data is a pointer to=20 - /// an array of EFI_IPv4_ADDRESS instances. + /// an array of EFI_IPv4_ADDRESS instances. When DataSize=20 + /// is 0 and Data is NULL, the existing configuration is cleared=20 + /// from the EFI IPv4 Configuration II Protocol instance. /// Ip4Config2DataTypeDnsServer, Ip4Config2DataTypeMaximum } EFI_IP4_CONFIG2_DATA_TYPE; =20 @@ -184,13 +190,12 @@ typedef struct { =20 @retval EFI_SUCCESS The specified configuration data for the= EFI IPv4 network stack is set=20 successfully. @retval EFI_INVALID_PARAMETER One or more of the following are TRUE: This is NULL. - Data is NULL. - One or more fields in Data do not match = the requirement of the data type=20 - indicated by DataType. + One or more fields in Data and DataSize = do not match the=20 + requirement of the data type indicated b= y DataType. @retval EFI_WRITE_PROTECTED The specified configuration data is read= -only or the specified configuration=20 data can not be set under the current po= licy. @retval EFI_ACCESS_DENIED Another set operation on the specified c= onfiguration data is already in process. @retval EFI_NOT_READY An asynchronous process is invoked to se= t the specified configuration data and=20 the process is not finished yet. diff --git a/MdePkg/Include/Protocol/Ip6Config.h b/MdePkg/Include/Protocol/= Ip6Config.h index b2c3be9..bcb8ba2 100644 --- a/MdePkg/Include/Protocol/Ip6Config.h +++ b/MdePkg/Include/Protocol/Ip6Config.h @@ -1,10 +1,10 @@ /** @file This file provides a definition of the EFI IPv6 Configuration Protocol. =20 -Copyright (c) 2008 - 2011, Intel Corporation. All rights reserved.
+Copyright (c) 2008 - 2017, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD = License which accompanies this distribution. The full text of the license may be = found at
http://opensource.org/licenses/bsd-license.php =20 @@ -64,29 +64,35 @@ typedef enum { Ip6ConfigDataTypeDupAddrDetectTransmits, ///=20 /// The station addresses set manually for the EFI=20 /// IPv6 network stack. It is only configurable when the policy is=20 /// Ip6ConfigPolicyManual. The corresponding Data is a=20 - /// pointer to an array of EFI_IPv6_ADDRESS instances. + /// pointer to an array of EFI_IPv6_ADDRESS instances. When=20 + /// DataSize is 0 and Data is NULL, the existing configuration=20 + /// is cleared from the EFI IPv6 Configuration Protocol instance. ///=20 Ip6ConfigDataTypeManualAddress, ///=20 /// The gateway addresses set manually for the EFI IPv6=20 /// network stack running on the communication device this EFI=20 /// IPv6 Configuration Protocol manages. It is not configurable when=20 /// the policy is Ip6ConfigPolicyAutomatic. The gateway=20 /// addresses must be unicast IPv6 addresses. The corresponding=20 /// Data is a pointer to an array of EFI_IPv6_ADDRESS instances. + /// When DataSize is 0 and Data is NULL, the existing configuration=20 + /// is cleared from the EFI IPv6 Configuration Protocol instance. ///=20 Ip6ConfigDataTypeGateway, ///=20 /// The DNS server list for the EFI IPv6 network stack=20 /// running on the communication device this EFI IPv6=20 /// Configuration Protocol manages. It is not configurable when the=20 /// policy is Ip6ConfigPolicyAutomatic.The DNS server=20 /// addresses must be unicast IPv6 addresses. The corresponding=20 /// Data is a pointer to an array of EFI_IPv6_ADDRESS instances. + /// When DataSize is 0 and Data is NULL, the existing configuration=20 + /// is cleared from the EFI IPv6 Configuration Protocol instance. ///=20 Ip6ConfigDataTypeDnsServer, /// /// The number of this enumeration memebers. /// @@ -226,13 +232,12 @@ typedef struct { =20 @retval EFI_SUCCESS The specified configuration data for the E= FI IPv6=20 network stack is set successfully. @retval EFI_INVALID_PARAMETER One or more of the following are TRUE: - This is NULL. - - Data is NULL. - - One or more fields in Data do not match = the requirement of the=20 - data type indicated by DataType.=20 + - One or more fields in Data and DataSize = do not match the=20 + requirement of the data type indicated b= y DataType.=20 @retval EFI_WRITE_PROTECTED The specified configuration data is read-o= nly or the specified=20 configuration data can not be set under th= e current policy @retval EFI_ACCESS_DENIED Another set operation on the specified con= figuration=20 data is already in process. @retval EFI_NOT_READY An asynchronous process is invoked to set = the specified --=20 1.9.5.msysgit.1 _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel