[edk2] [Patch 1/2] MdePkg: Correct inconsistent function descriptions in DNS

2016-01-28 Thread Jiaxin Wu 
This patch is used to correct inconsistent function descriptions
in Dns4.h and Dns6.h.

Cc: Fu Siyuan 
Cc: Ye Ting 
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jiaxin Wu 
---
 MdePkg/Include/Protocol/Dns4.h | 5 ++---
 MdePkg/Include/Protocol/Dns6.h | 8 
 2 files changed, 6 insertions(+), 7 deletions(-)

diff --git a/MdePkg/Include/Protocol/Dns4.h b/MdePkg/Include/Protocol/Dns4.h
index 3e7cdaa..2489268 100644
--- a/MdePkg/Include/Protocol/Dns4.h
+++ b/MdePkg/Include/Protocol/Dns4.h
@@ -2,11 +2,11 @@
   This file defines the EFI Domain Name Service Binding Protocol interface. It 
is split
   into the following two main sections:
   DNSv4 Service Binding Protocol (DNSv4SB)
   DNSv4 Protocol (DNSv4)
 
-  Copyright (c) 2015, Intel Corporation. All rights reserved.
+  Copyright (c) 2015 - 2016, 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
 
@@ -337,11 +337,11 @@ EFI_STATUS
 
   The HostNameToIp () function is used to translate the host name to host IP 
address. A
   type A query is used to get the one or more IP addresses for this host.
 
   @param[in]  ThisPointer to EFI_DNS4_PROTOCOL instance.
-  @param[in]  HostnameHost name.
+  @param[in]  HostNameHost name.
   @param[in]  Token   Point to the completion token to translate 
host name
   to host address.
 
   @retval EFI_SUCCESS The operation completed successfully.
   @retval EFI_INVALID_PARAMETER   One or more of the following conditions is 
TRUE:
@@ -378,11 +378,10 @@ EFI_STATUS
   Token is NULL.
   Token.Event is NULL.
   IpAddress is not valid IP address .
   @retval EFI_NO_MAPPING  There's no source address is available for 
use.
   @retval EFI_ALREADY_STARTED This Token is being used in another DNS 
session.
-  @retval EFI_NOT_STARTED This instance has not been started.
   @retval EFI_OUT_OF_RESOURCESFailed to allocate needed resources.
 **/
 typedef
 EFI_STATUS
 (EFIAPI *EFI_DNS4_IP_TO_HOST_NAME) (
diff --git a/MdePkg/Include/Protocol/Dns6.h b/MdePkg/Include/Protocol/Dns6.h
index 03cdf6a..1ea85bc 100644
--- a/MdePkg/Include/Protocol/Dns6.h
+++ b/MdePkg/Include/Protocol/Dns6.h
@@ -2,11 +2,11 @@
   This file defines the EFI DNSv6 (Domain Name Service version 6) Protocol. It 
is split
   into the following two main sections:
   DNSv6 Service Binding Protocol (DNSv6SB)
   DNSv6 Protocol (DNSv6)
 
-  Copyright (c) 2015, Intel Corporation. All rights reserved.
+  Copyright (c) 2015 - 2016, 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
 
@@ -299,11 +299,11 @@ EFI_STATUS
   @param[in]  DnsConfigData   Pointer to the configuration data structure. 
All associated 
   storage to be allocated and released by 
caller.
 
   @retval EFI_SUCCESS The operation completed successfully.
   @retval EFI_INVALID_PARAMTERThis is NULL.
-  The StationIp address provided in 
DnsConfigData is not a valid unicast.
+  The StationIp address provided in 
DnsConfigData is not zero and not a valid unicast.
   DnsServerList is NULL while DnsServerList 
Count is not ZERO.
   DnsServerList Count is ZERO while 
DnsServerList is not NULL.
   @retval EFI_OUT_OF_RESOURCESThe DNS instance data or required space 
could not be allocated.
   @retval EFI_DEVICE_ERRORAn unexpected system or network error 
occurred. The
   EFI DNSv6 Protocol instance is not 
configured.
@@ -321,14 +321,14 @@ EFI_STATUS
 
 /**
   Host name to host address translation.
 
   The HostNameToIp () function is used to translate the host name to host IP 
address. A
-  type A query is used to get the one or more IPv6 addresses for this host.
+  type  query is used to get the one or more IPv6 addresses for this host.
 
   @param[in]  ThisPointer to EFI_DNS6_PROTOCOL instance.
-  @param[in]  HostnameHost name.
+  @param[in]  HostNameHost name.
   @param[in]  Token   Point to the completion token to translate 
host name
   to host address.
 
   @retval EFI_SUCCESS The operation

Re: [edk2] [Patch 1/2] MdePkg: Correct inconsistent function descriptions in DNS

2016-01-28 Thread Fu, Siyuan 
Reviewed-by: Siyuan Fu <siyuan...@intel.com>


-Original Message-
From: edk2-devel [mailto:edk2-devel-boun...@lists.01.org] On Behalf Of Jiaxin Wu
Sent: Friday, January 29, 2016 8:52 AM
To: edk2-devel@lists.01.org
Cc: Ye, Ting <ting...@intel.com>; Fu, Siyuan <siyuan...@intel.com>
Subject: [edk2] [Patch 1/2] MdePkg: Correct inconsistent function descriptions 
in DNS

This patch is used to correct inconsistent function descriptions in Dns4.h and 
Dns6.h.

Cc: Fu Siyuan <siyuan...@intel.com>
Cc: Ye Ting <ting...@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jiaxin Wu <jiaxin...@intel.com>
---
 MdePkg/Include/Protocol/Dns4.h | 5 ++---  MdePkg/Include/Protocol/Dns6.h | 8 

 2 files changed, 6 insertions(+), 7 deletions(-)

diff --git a/MdePkg/Include/Protocol/Dns4.h b/MdePkg/Include/Protocol/Dns4.h 
index 3e7cdaa..2489268 100644
--- a/MdePkg/Include/Protocol/Dns4.h
+++ b/MdePkg/Include/Protocol/Dns4.h
@@ -2,11 +2,11 @@
   This file defines the EFI Domain Name Service Binding Protocol interface. It 
is split
   into the following two main sections:
   DNSv4 Service Binding Protocol (DNSv4SB)
   DNSv4 Protocol (DNSv4)
 
-  Copyright (c) 2015, Intel Corporation. All rights reserved.
+  Copyright (c) 2015 - 2016, 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
 
@@ -337,11 +337,11 @@ EFI_STATUS
 
   The HostNameToIp () function is used to translate the host name to host IP 
address. A
   type A query is used to get the one or more IP addresses for this host.
 
   @param[in]  ThisPointer to EFI_DNS4_PROTOCOL instance.
-  @param[in]  HostnameHost name.
+  @param[in]  HostNameHost name.
   @param[in]  Token   Point to the completion token to translate 
host name
   to host address.
 
   @retval EFI_SUCCESS The operation completed successfully.
   @retval EFI_INVALID_PARAMETER   One or more of the following conditions is 
TRUE:
@@ -378,11 +378,10 @@ EFI_STATUS
   Token is NULL.
   Token.Event is NULL.
   IpAddress is not valid IP address .
   @retval EFI_NO_MAPPING  There's no source address is available for 
use.
   @retval EFI_ALREADY_STARTED This Token is being used in another DNS 
session.
-  @retval EFI_NOT_STARTED This instance has not been started.
   @retval EFI_OUT_OF_RESOURCESFailed to allocate needed resources.
 **/
 typedef
 EFI_STATUS
 (EFIAPI *EFI_DNS4_IP_TO_HOST_NAME) (
diff --git a/MdePkg/Include/Protocol/Dns6.h b/MdePkg/Include/Protocol/Dns6.h 
index 03cdf6a..1ea85bc 100644
--- a/MdePkg/Include/Protocol/Dns6.h
+++ b/MdePkg/Include/Protocol/Dns6.h
@@ -2,11 +2,11 @@
   This file defines the EFI DNSv6 (Domain Name Service version 6) Protocol. It 
is split
   into the following two main sections:
   DNSv6 Service Binding Protocol (DNSv6SB)
   DNSv6 Protocol (DNSv6)
 
-  Copyright (c) 2015, Intel Corporation. All rights reserved.
+  Copyright (c) 2015 - 2016, 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
 
@@ -299,11 +299,11 @@ EFI_STATUS
   @param[in]  DnsConfigData   Pointer to the configuration data structure. 
All associated 
   storage to be allocated and released by 
caller.
 
   @retval EFI_SUCCESS The operation completed successfully.
   @retval EFI_INVALID_PARAMTERThis is NULL.
-  The StationIp address provided in 
DnsConfigData is not a valid unicast.
+  The StationIp address provided in 
DnsConfigData is not zero and not a valid unicast.
   DnsServerList is NULL while DnsServerList 
Count is not ZERO.
   DnsServerList Count is ZERO while 
DnsServerList is not NULL.
   @retval EFI_OUT_OF_RESOURCESThe DNS instance data or required space 
could not be allocated.
   @retval EFI_DEVICE_ERRORAn unexpected system or network error 
occurred. The
   EFI DNSv6 Protocol instance is not 
configured.
@@ -321,14 +321,14 @@ EFI_STATUS
 
 /**
   Host name to host address translation.
 
   The HostNameToIp () function is used to translate the host name to host IP 
address. A
-  type A query is used to get the one or more IPv6 addresses for this host.
+  type  query

Re: [edk2] [Patch 1/2] MdePkg: Correct inconsistent function descriptions in DNS

2016-01-28 Thread Gao, Liming 
Reviewed-by: Liming Gao <liming@intel.com>

-Original Message-
From: edk2-devel [mailto:edk2-devel-boun...@lists.01.org] On Behalf Of Jiaxin Wu
Sent: Friday, January 29, 2016 8:52 AM
To: edk2-devel@lists.01.org
Cc: Ye, Ting; Fu, Siyuan
Subject: [edk2] [Patch 1/2] MdePkg: Correct inconsistent function descriptions 
in DNS

This patch is used to correct inconsistent function descriptions
in Dns4.h and Dns6.h.

Cc: Fu Siyuan <siyuan...@intel.com>
Cc: Ye Ting <ting...@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jiaxin Wu <jiaxin...@intel.com>
---
 MdePkg/Include/Protocol/Dns4.h | 5 ++---
 MdePkg/Include/Protocol/Dns6.h | 8 
 2 files changed, 6 insertions(+), 7 deletions(-)

diff --git a/MdePkg/Include/Protocol/Dns4.h b/MdePkg/Include/Protocol/Dns4.h
index 3e7cdaa..2489268 100644
--- a/MdePkg/Include/Protocol/Dns4.h
+++ b/MdePkg/Include/Protocol/Dns4.h
@@ -2,11 +2,11 @@
   This file defines the EFI Domain Name Service Binding Protocol interface. It 
is split
   into the following two main sections:
   DNSv4 Service Binding Protocol (DNSv4SB)
   DNSv4 Protocol (DNSv4)
 
-  Copyright (c) 2015, Intel Corporation. All rights reserved.
+  Copyright (c) 2015 - 2016, 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
 
@@ -337,11 +337,11 @@ EFI_STATUS
 
   The HostNameToIp () function is used to translate the host name to host IP 
address. A
   type A query is used to get the one or more IP addresses for this host.
 
   @param[in]  ThisPointer to EFI_DNS4_PROTOCOL instance.
-  @param[in]  HostnameHost name.
+  @param[in]  HostNameHost name.
   @param[in]  Token   Point to the completion token to translate 
host name
   to host address.
 
   @retval EFI_SUCCESS The operation completed successfully.
   @retval EFI_INVALID_PARAMETER   One or more of the following conditions is 
TRUE:
@@ -378,11 +378,10 @@ EFI_STATUS
   Token is NULL.
   Token.Event is NULL.
   IpAddress is not valid IP address .
   @retval EFI_NO_MAPPING  There's no source address is available for 
use.
   @retval EFI_ALREADY_STARTED This Token is being used in another DNS 
session.
-  @retval EFI_NOT_STARTED This instance has not been started.
   @retval EFI_OUT_OF_RESOURCESFailed to allocate needed resources.
 **/
 typedef
 EFI_STATUS
 (EFIAPI *EFI_DNS4_IP_TO_HOST_NAME) (
diff --git a/MdePkg/Include/Protocol/Dns6.h b/MdePkg/Include/Protocol/Dns6.h
index 03cdf6a..1ea85bc 100644
--- a/MdePkg/Include/Protocol/Dns6.h
+++ b/MdePkg/Include/Protocol/Dns6.h
@@ -2,11 +2,11 @@
   This file defines the EFI DNSv6 (Domain Name Service version 6) Protocol. It 
is split
   into the following two main sections:
   DNSv6 Service Binding Protocol (DNSv6SB)
   DNSv6 Protocol (DNSv6)
 
-  Copyright (c) 2015, Intel Corporation. All rights reserved.
+  Copyright (c) 2015 - 2016, 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
 
@@ -299,11 +299,11 @@ EFI_STATUS
   @param[in]  DnsConfigData   Pointer to the configuration data structure. 
All associated 
   storage to be allocated and released by 
caller.
 
   @retval EFI_SUCCESS The operation completed successfully.
   @retval EFI_INVALID_PARAMTERThis is NULL.
-  The StationIp address provided in 
DnsConfigData is not a valid unicast.
+  The StationIp address provided in 
DnsConfigData is not zero and not a valid unicast.
   DnsServerList is NULL while DnsServerList 
Count is not ZERO.
   DnsServerList Count is ZERO while 
DnsServerList is not NULL.
   @retval EFI_OUT_OF_RESOURCESThe DNS instance data or required space 
could not be allocated.
   @retval EFI_DEVICE_ERRORAn unexpected system or network error 
occurred. The
   EFI DNSv6 Protocol instance is not 
configured.
@@ -321,14 +321,14 @@ EFI_STATUS
 
 /**
   Host name to host address translation.
 
   The HostNameToIp () function is used to translate the host name to host IP 
address. A
-  type A query is used to get the one or more IPv6 addresses for this host.
+  type  query is used to get the one or more IPv6 addresses fo