[PATCH] MdePkg/BluetoothConfig: Update comments for GetData/GetRemoteData

[PATCH] MdePkg/BluetoothConfig: Update comments for GetData/GetRemoteData

[Hao Wu]

Updates the GetData and GetRemoteData services description comments
according to latest UEFI spec.

Cc: Ruiyu Ni <ruiyu.ni@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Hao Wu <hao.a.wu@intel.com>
---
 MdePkg/Include/Protocol/BluetoothConfig.h | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/MdePkg/Include/Protocol/BluetoothConfig.h b/MdePkg/Include/Protocol/BluetoothConfig.h
index 4240ef0a14..1460ee9eb6 100644
--- a/MdePkg/Include/Protocol/BluetoothConfig.h
+++ b/MdePkg/Include/Protocol/BluetoothConfig.h
@@ -1,5 +1,5 @@
 /** @file
-  EFI Bluetooth Configuration Protocol as defined in UEFI 2.5.
+  EFI Bluetooth Configuration Protocol as defined in UEFI 2.7.
   This protocol abstracts user interface configuration for Bluetooth device.
 
   Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR>
@@ -12,7 +12,7 @@
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
   @par Revision Reference:          
-  This Protocol is introduced in UEFI Specification 2.5
+  This Protocol is introduced in UEFI Specification 2.7
 
 **/
 
@@ -273,11 +273,11 @@ EFI_STATUS
   @retval EFI_SUCCESS           The Bluetooth configuration data is returned successfully.
   @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
                                 - DataSize is NULL.
-                                - *DataSize is 0.
-                                - Data is NULL.
+                                - *DataSize is not 0 and Data is NULL.
   @retval EFI_UNSUPPORTED       The DataType is unsupported.
   @retval EFI_NOT_FOUND         The DataType is not found.
   @retval EFI_BUFFER_TOO_SMALL  The buffer is too small to hold the buffer.
+                                *DataSize has been updated with the size needed to complete the request.
 
 **/
 typedef 
@@ -327,11 +327,11 @@ EFI_STATUS
   @retval EFI_SUCCESS           The remote Bluetooth device configuration data is returned successfully.
   @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
                                 - DataSize is NULL.
-                                - *DataSize is 0.
-                                - Data is NULL.
+                                - *DataSize is not 0 and Data is NULL.
   @retval EFI_UNSUPPORTED       The DataType is unsupported.
   @retval EFI_NOT_FOUND         The DataType is not found.
   @retval EFI_BUFFER_TOO_SMALL  The buffer is too small to hold the buffer.
+                                *DataSize has been updated with the size needed to complete the request.
 
 **/
 typedef 
-- 
2.12.0.windows.1

Re: [PATCH] MdePkg/BluetoothConfig: Update comments for GetData/GetRemoteData

[Ni, Ruiyu]

Reviewed-by: Ruiyu Ni <ruiyu.ni@intel.com>

Thanks/Ray

> -----Original Message-----
> From: Wu, Hao A
> Sent: Monday, June 19, 2017 1:29 PM
> To: edk2-devel@lists.01.org
> Cc: Wu, Hao A <hao.a.wu@intel.com>; Ni, Ruiyu <ruiyu.ni@intel.com>
> Subject: [PATCH] MdePkg/BluetoothConfig: Update comments for
> GetData/GetRemoteData
> 
> Updates the GetData and GetRemoteData services description comments
> according to latest UEFI spec.
> 
> Cc: Ruiyu Ni <ruiyu.ni@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.0
> Signed-off-by: Hao Wu <hao.a.wu@intel.com>
> ---
>  MdePkg/Include/Protocol/BluetoothConfig.h | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/MdePkg/Include/Protocol/BluetoothConfig.h
> b/MdePkg/Include/Protocol/BluetoothConfig.h
> index 4240ef0a14..1460ee9eb6 100644
> --- a/MdePkg/Include/Protocol/BluetoothConfig.h
> +++ b/MdePkg/Include/Protocol/BluetoothConfig.h
> @@ -1,5 +1,5 @@
>  /** @file
> -  EFI Bluetooth Configuration Protocol as defined in UEFI 2.5.
> +  EFI Bluetooth Configuration Protocol as defined in UEFI 2.7.
>    This protocol abstracts user interface configuration for Bluetooth device.
> 
>    Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR> @@ -
> 12,7 +12,7 @@
>    WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER
> EXPRESS OR IMPLIED.
> 
>    @par Revision Reference:
> -  This Protocol is introduced in UEFI Specification 2.5
> +  This Protocol is introduced in UEFI Specification 2.7
> 
>  **/
> 
> @@ -273,11 +273,11 @@ EFI_STATUS
>    @retval EFI_SUCCESS           The Bluetooth configuration data is returned
> successfully.
>    @retval EFI_INVALID_PARAMETER One or more of the following conditions
> is TRUE:
>                                  - DataSize is NULL.
> -                                - *DataSize is 0.
> -                                - Data is NULL.
> +                                - *DataSize is not 0 and Data is NULL.
>    @retval EFI_UNSUPPORTED       The DataType is unsupported.
>    @retval EFI_NOT_FOUND         The DataType is not found.
>    @retval EFI_BUFFER_TOO_SMALL  The buffer is too small to hold the buffer.
> +                                *DataSize has been updated with the size needed to
> complete the request.
> 
>  **/
>  typedef
> @@ -327,11 +327,11 @@ EFI_STATUS
>    @retval EFI_SUCCESS           The remote Bluetooth device configuration data
> is returned successfully.
>    @retval EFI_INVALID_PARAMETER One or more of the following conditions
> is TRUE:
>                                  - DataSize is NULL.
> -                                - *DataSize is 0.
> -                                - Data is NULL.
> +                                - *DataSize is not 0 and Data is NULL.
>    @retval EFI_UNSUPPORTED       The DataType is unsupported.
>    @retval EFI_NOT_FOUND         The DataType is not found.
>    @retval EFI_BUFFER_TOO_SMALL  The buffer is too small to hold the buffer.
> +                                *DataSize has been updated with the size needed to
> complete the request.
> 
>  **/
>  typedef
> --
> 2.12.0.windows.1