mirror of https://github.com/acidanthera/audk.git
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>
This commit is contained in:
parent
f8daac8121
commit
1499e1ae68
|
@ -2,7 +2,7 @@
|
||||||
This file provides a definition of the EFI IPv4 Configuration II
|
This file provides a definition of the EFI IPv4 Configuration II
|
||||||
Protocol.
|
Protocol.
|
||||||
|
|
||||||
Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>
|
Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR>
|
||||||
This program and the accompanying materials
|
This program and the accompanying materials
|
||||||
are licensed and made available under the terms and conditions of the BSD License
|
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<BR>
|
which accompanies this distribution. The full text of the license may be found at<BR>
|
||||||
|
@ -51,7 +51,9 @@ typedef enum {
|
||||||
/// The station addresses set manually for the EFI IPv4 network
|
/// The station addresses set manually for the EFI IPv4 network
|
||||||
/// stack. It is only configurable when the policy is
|
/// stack. It is only configurable when the policy is
|
||||||
/// Ip4Config2PolicyStatic. The corresponding Data is of
|
/// Ip4Config2PolicyStatic. The corresponding Data is of
|
||||||
/// type EFI_IP4_CONFIG2_MANUAL_ADDRESS.
|
/// type EFI_IP4_CONFIG2_MANUAL_ADDRESS. When DataSize
|
||||||
|
/// is 0 and Data is NULL, the existing configuration is cleared
|
||||||
|
/// from the EFI IPv4 Configuration II Protocol instance.
|
||||||
///
|
///
|
||||||
Ip4Config2DataTypeManualAddress,
|
Ip4Config2DataTypeManualAddress,
|
||||||
///
|
///
|
||||||
|
@ -61,6 +63,8 @@ typedef enum {
|
||||||
/// the policy is Ip4Config2PolicyDhcp. The gateway
|
/// the policy is Ip4Config2PolicyDhcp. The gateway
|
||||||
/// addresses must be unicast IPv4 addresses. The corresponding
|
/// addresses must be unicast IPv4 addresses. The corresponding
|
||||||
/// Data is a pointer to an array of EFI_IPv4_ADDRESS instances.
|
/// Data is a pointer to an array of EFI_IPv4_ADDRESS instances.
|
||||||
|
/// When DataSize is 0 and Data is NULL, the existing configuration
|
||||||
|
/// is cleared from the EFI IPv4 Configuration II Protocol instance.
|
||||||
///
|
///
|
||||||
Ip4Config2DataTypeGateway,
|
Ip4Config2DataTypeGateway,
|
||||||
///
|
///
|
||||||
|
@ -69,7 +73,9 @@ typedef enum {
|
||||||
/// Protocol manages. It is not configurable when the policy is
|
/// Protocol manages. It is not configurable when the policy is
|
||||||
/// Ip4Config2PolicyDhcp. The DNS server addresses must be
|
/// Ip4Config2PolicyDhcp. The DNS server addresses must be
|
||||||
/// unicast IPv4 addresses. The corresponding Data is a pointer to
|
/// unicast IPv4 addresses. The corresponding Data is a pointer to
|
||||||
/// an array of EFI_IPv4_ADDRESS instances.
|
/// an array of EFI_IPv4_ADDRESS instances. When DataSize
|
||||||
|
/// is 0 and Data is NULL, the existing configuration is cleared
|
||||||
|
/// from the EFI IPv4 Configuration II Protocol instance.
|
||||||
///
|
///
|
||||||
Ip4Config2DataTypeDnsServer,
|
Ip4Config2DataTypeDnsServer,
|
||||||
Ip4Config2DataTypeMaximum
|
Ip4Config2DataTypeMaximum
|
||||||
|
@ -186,9 +192,8 @@ typedef struct {
|
||||||
successfully.
|
successfully.
|
||||||
@retval EFI_INVALID_PARAMETER One or more of the following are TRUE:
|
@retval EFI_INVALID_PARAMETER One or more of the following are TRUE:
|
||||||
This is NULL.
|
This is NULL.
|
||||||
Data is NULL.
|
One or more fields in Data and DataSize do not match the
|
||||||
One or more fields in Data do not match the requirement of the data type
|
requirement of the data type indicated by DataType.
|
||||||
indicated by DataType.
|
|
||||||
@retval EFI_WRITE_PROTECTED The specified configuration data is read-only or the specified configuration
|
@retval EFI_WRITE_PROTECTED The specified configuration data is read-only or the specified configuration
|
||||||
data can not be set under the current policy.
|
data can not be set under the current policy.
|
||||||
@retval EFI_ACCESS_DENIED Another set operation on the specified configuration data is already in process.
|
@retval EFI_ACCESS_DENIED Another set operation on the specified configuration data is already in process.
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
This file provides a definition of the EFI IPv6 Configuration
|
This file provides a definition of the EFI IPv6 Configuration
|
||||||
Protocol.
|
Protocol.
|
||||||
|
|
||||||
Copyright (c) 2008 - 2011, Intel Corporation. All rights reserved.<BR>
|
Copyright (c) 2008 - 2017, Intel Corporation. All rights reserved.<BR>
|
||||||
This program and the accompanying materials
|
This program and the accompanying materials
|
||||||
are licensed and made available under the terms and conditions of the BSD License
|
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<BR>
|
which accompanies this distribution. The full text of the license may be found at<BR>
|
||||||
|
@ -66,7 +66,9 @@ typedef enum {
|
||||||
/// The station addresses set manually for the EFI
|
/// The station addresses set manually for the EFI
|
||||||
/// IPv6 network stack. It is only configurable when the policy is
|
/// IPv6 network stack. It is only configurable when the policy is
|
||||||
/// Ip6ConfigPolicyManual. The corresponding Data is a
|
/// Ip6ConfigPolicyManual. The corresponding Data is a
|
||||||
/// pointer to an array of EFI_IPv6_ADDRESS instances.
|
/// pointer to an array of EFI_IPv6_ADDRESS instances. When
|
||||||
|
/// DataSize is 0 and Data is NULL, the existing configuration
|
||||||
|
/// is cleared from the EFI IPv6 Configuration Protocol instance.
|
||||||
///
|
///
|
||||||
Ip6ConfigDataTypeManualAddress,
|
Ip6ConfigDataTypeManualAddress,
|
||||||
///
|
///
|
||||||
|
@ -76,6 +78,8 @@ typedef enum {
|
||||||
/// the policy is Ip6ConfigPolicyAutomatic. The gateway
|
/// the policy is Ip6ConfigPolicyAutomatic. The gateway
|
||||||
/// addresses must be unicast IPv6 addresses. The corresponding
|
/// addresses must be unicast IPv6 addresses. The corresponding
|
||||||
/// Data is a pointer to an array of EFI_IPv6_ADDRESS instances.
|
/// Data is a pointer to an array of EFI_IPv6_ADDRESS instances.
|
||||||
|
/// When DataSize is 0 and Data is NULL, the existing configuration
|
||||||
|
/// is cleared from the EFI IPv6 Configuration Protocol instance.
|
||||||
///
|
///
|
||||||
Ip6ConfigDataTypeGateway,
|
Ip6ConfigDataTypeGateway,
|
||||||
///
|
///
|
||||||
|
@ -85,6 +89,8 @@ typedef enum {
|
||||||
/// policy is Ip6ConfigPolicyAutomatic.The DNS server
|
/// policy is Ip6ConfigPolicyAutomatic.The DNS server
|
||||||
/// addresses must be unicast IPv6 addresses. The corresponding
|
/// addresses must be unicast IPv6 addresses. The corresponding
|
||||||
/// Data is a pointer to an array of EFI_IPv6_ADDRESS instances.
|
/// Data is a pointer to an array of EFI_IPv6_ADDRESS instances.
|
||||||
|
/// When DataSize is 0 and Data is NULL, the existing configuration
|
||||||
|
/// is cleared from the EFI IPv6 Configuration Protocol instance.
|
||||||
///
|
///
|
||||||
Ip6ConfigDataTypeDnsServer,
|
Ip6ConfigDataTypeDnsServer,
|
||||||
///
|
///
|
||||||
|
@ -228,9 +234,8 @@ typedef struct {
|
||||||
network stack is set successfully.
|
network stack is set successfully.
|
||||||
@retval EFI_INVALID_PARAMETER One or more of the following are TRUE:
|
@retval EFI_INVALID_PARAMETER One or more of the following are TRUE:
|
||||||
- This is NULL.
|
- This is NULL.
|
||||||
- Data is NULL.
|
- One or more fields in Data and DataSize do not match the
|
||||||
- One or more fields in Data do not match the requirement of the
|
requirement of the data type indicated by DataType.
|
||||||
data type indicated by DataType.
|
|
||||||
@retval EFI_WRITE_PROTECTED The specified configuration data is read-only or the specified
|
@retval EFI_WRITE_PROTECTED The specified configuration data is read-only or the specified
|
||||||
configuration data can not be set under the current policy
|
configuration data can not be set under the current policy
|
||||||
@retval EFI_ACCESS_DENIED Another set operation on the specified configuration
|
@retval EFI_ACCESS_DENIED Another set operation on the specified configuration
|
||||||
|
|
Loading…
Reference in New Issue