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

2016-01-28 Thread Jiaxin Wu 
This patch is used to correct inconsistent function descriptions
in DnsDxe.

Cc: Fu Siyuan 
Cc: Ye Ting 
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jiaxin Wu 
---
 NetworkPkg/DnsDxe/DnsImpl.h | 583 ++-
 NetworkPkg/DnsDxe/DnsProtocol.c | 585 +++-
 2 files changed, 665 insertions(+), 503 deletions(-)

diff --git a/NetworkPkg/DnsDxe/DnsImpl.h b/NetworkPkg/DnsDxe/DnsImpl.h
index 72b85cb..8cd73e7 100644
--- a/NetworkPkg/DnsDxe/DnsImpl.h
+++ b/NetworkPkg/DnsDxe/DnsImpl.h
@@ -730,130 +730,147 @@ DnsOnTimerUpdate (
   IN VOID   *Context
   );
 
 
 /**
-  This function is used to retrieve DNS mode data for this DNS instance.
+  Retrieve mode data of this DNS instance.
 
-  @param[in]  This   Pointer to EFI_DNS4_PROTOCOL instance.
-  @param[out] DnsModeDataPointer to the caller-allocated storage for 
the EFI_DNS4_MODE_DATA structure.
+  This function is used to retrieve DNS mode data for this DNS instance.
 
-  @retval  EFI_SUCCESS   The operation completed successfully.
-  @retval  EFI_NOT_STARTED   When DnsConfigData is queried, no 
configuration data is 
- available because this instance has not been 
configured.
-  @retval  EFI_OUT_OF_RESOURCES  Failed to allocate needed resources.
-  @retval  EFI_INVALID_PARAMETER This is NULL or DnsModeData is NULL.
+  @param[in]   This   Pointer to EFI_DNS4_PROTOCOL instance.
+  @param[out]  DnsModeDataPoint to the mode data.
 
+  @retval EFI_SUCCESS The operation completed successfully.
+  @retval EFI_NOT_STARTED When DnsConfigData is queried, no 
configuration data
+  is available because this instance has not 
been
+  configured.
+  @retval EFI_INVALID_PARAMETER   This is NULL or DnsModeData is NULL.
+  @retval EFI_OUT_OF_RESOURCESFailed to allocate needed resources.
 **/
 EFI_STATUS
 EFIAPI
 Dns4GetModeData (
   IN  EFI_DNS4_PROTOCOL  *This,
   OUT EFI_DNS4_MODE_DATA *DnsModeData
   );
 
 /**
-  This function is used to configure DNS configuration data for this DNS 
instance.
-
-  @param[in]  This   Pointer to EFI_DNS4_PROTOCOL instance.
-  @param[in]  DnsConfigData  Pointer to caller-allocated buffer containing 
EFI_DNS4_CONFIG_DATA structure. 
- If NULL, the driver will reinitialize the 
protocol instance to the unconfigured state.
-
-  @retval  EFI_SUCCESS   The operation completed successfully.
-  @retval  EFI_UNSUPPORTED   The designated protocol is not supported.
-  @retval  EFI_OUT_OF_RESOURCES  Failed to allocate needed resources.
-  @retval  EFI_INVALID_PARAMETER This is NULL.
- The StationIp address provided in 
DnsConfigData is not a valid unicast.
- DnsServerList is NULL while 
DnsServerListCount is not equal to Zero.
- DnsServerListCount is Zero while 
DnsServerListCount is not equal to NULL.
-  @retval  EFI_DEVICE_ERROR  An unexpected system or network error 
occurred. The EFI DNSv4 Protocol instance is not configured.
-
+  Configure this DNS instance.
+
+  This function is used to configure DNS mode data for this DNS instance.
+
+  @param[in]  ThisPointer to EFI_DNS4_PROTOCOL instance.
+  @param[in]  DnsConfigData   Point to the Configuration data.
+
+  @retval EFI_SUCCESS The operation completed successfully.
+  @retval EFI_UNSUPPORTED The designated protocol is not supported.
+  @retval EFI_INVALID_PARAMTERThisis NULL.
+  The StationIp address provided in 
DnsConfigData is not a 
+  valid unicast.
+  DnsServerList is NULL while 
DnsServerListCount
+  is not ZERO.
+  DnsServerListCount 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 DNSv4 Protocol instance is not 
configured.
+  @retval EFI_ALREADY_STARTED Second call to Configure() with 
DnsConfigData. To 
+  reconfigure the instance the caller must 
call Configure() 
+  with NULL first to return driver to 
unconfigured state.
 **/
 EFI_STATUS
 EFIAPI
 Dns4Configure (
   IN EFI_DNS4_PROTOCOL   *This,
   IN EFI_DNS4_CONFIG_DATA*DnsConfigData
   );
 
 /**
-  The function is used to translate the host name to host IP

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

2016-01-28 Thread Fu, Siyuan 
Reviewed-by: Siyuan Fu 



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

This patch is used to correct inconsistent function descriptions
in DnsDxe.

Cc: Fu Siyuan 
Cc: Ye Ting 
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jiaxin Wu 
---
 NetworkPkg/DnsDxe/DnsImpl.h | 583 ++-
 NetworkPkg/DnsDxe/DnsProtocol.c | 585 +++-
 2 files changed, 665 insertions(+), 503 deletions(-)

diff --git a/NetworkPkg/DnsDxe/DnsImpl.h b/NetworkPkg/DnsDxe/DnsImpl.h
index 72b85cb..8cd73e7 100644
--- a/NetworkPkg/DnsDxe/DnsImpl.h
+++ b/NetworkPkg/DnsDxe/DnsImpl.h
@@ -730,130 +730,147 @@ DnsOnTimerUpdate (
   IN VOID   *Context
   );
 
 
 /**
-  This function is used to retrieve DNS mode data for this DNS instance.
+  Retrieve mode data of this DNS instance.
 
-  @param[in]  This   Pointer to EFI_DNS4_PROTOCOL instance.
-  @param[out] DnsModeDataPointer to the caller-allocated storage for 
the EFI_DNS4_MODE_DATA structure.
+  This function is used to retrieve DNS mode data for this DNS instance.
 
-  @retval  EFI_SUCCESS   The operation completed successfully.
-  @retval  EFI_NOT_STARTED   When DnsConfigData is queried, no 
configuration data is 
- available because this instance has not been 
configured.
-  @retval  EFI_OUT_OF_RESOURCES  Failed to allocate needed resources.
-  @retval  EFI_INVALID_PARAMETER This is NULL or DnsModeData is NULL.
+  @param[in]   This   Pointer to EFI_DNS4_PROTOCOL instance.
+  @param[out]  DnsModeDataPoint to the mode data.
 
+  @retval EFI_SUCCESS The operation completed successfully.
+  @retval EFI_NOT_STARTED When DnsConfigData is queried, no 
configuration data
+  is available because this instance has not 
been
+  configured.
+  @retval EFI_INVALID_PARAMETER   This is NULL or DnsModeData is NULL.
+  @retval EFI_OUT_OF_RESOURCESFailed to allocate needed resources.
 **/
 EFI_STATUS
 EFIAPI
 Dns4GetModeData (
   IN  EFI_DNS4_PROTOCOL  *This,
   OUT EFI_DNS4_MODE_DATA *DnsModeData
   );
 
 /**
-  This function is used to configure DNS configuration data for this DNS 
instance.
-
-  @param[in]  This   Pointer to EFI_DNS4_PROTOCOL instance.
-  @param[in]  DnsConfigData  Pointer to caller-allocated buffer containing 
EFI_DNS4_CONFIG_DATA structure. 
- If NULL, the driver will reinitialize the 
protocol instance to the unconfigured state.
-
-  @retval  EFI_SUCCESS   The operation completed successfully.
-  @retval  EFI_UNSUPPORTED   The designated protocol is not supported.
-  @retval  EFI_OUT_OF_RESOURCES  Failed to allocate needed resources.
-  @retval  EFI_INVALID_PARAMETER This is NULL.
- The StationIp address provided in 
DnsConfigData is not a valid unicast.
- DnsServerList is NULL while 
DnsServerListCount is not equal to Zero.
- DnsServerListCount is Zero while 
DnsServerListCount is not equal to NULL.
-  @retval  EFI_DEVICE_ERROR  An unexpected system or network error 
occurred. The EFI DNSv4 Protocol instance is not configured.
-
+  Configure this DNS instance.
+
+  This function is used to configure DNS mode data for this DNS instance.
+
+  @param[in]  ThisPointer to EFI_DNS4_PROTOCOL instance.
+  @param[in]  DnsConfigData   Point to the Configuration data.
+
+  @retval EFI_SUCCESS The operation completed successfully.
+  @retval EFI_UNSUPPORTED The designated protocol is not supported.
+  @retval EFI_INVALID_PARAMTERThisis NULL.
+  The StationIp address provided in 
DnsConfigData is not a 
+  valid unicast.
+  DnsServerList is NULL while 
DnsServerListCount
+  is not ZERO.
+  DnsServerListCount 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 DNSv4 Protocol instance is not 
configured.
+  @retval EFI_ALREADY_STARTED Second call to Configure() with 
DnsConfigData. To 
+  reconfigure the instance the caller must 
call