Re: [edk2-devel] [edk2-platforms] [PATCH V1] KabylakeOpenBoardPkg: Document EcLib return value

Re: [edk2-devel] [edk2-platforms] [PATCH V1] KabylakeOpenBoardPkg: Document EcLib return value

[Michael Kubacki]

Reviewed-by: Michael Kubacki <michael.kubacki@microsoft.com>

On 8/25/2021 11:55 PM, Nate DeSimone wrote:
> Added EFI_INVALID_PARAMETER to the EcRead()
> function's list of return values.
> 
> Cc: Chasel Chiu <chasel.chiu@intel.com>
> Cc: Michael Kubacki <michael.kubacki@microsoft.com>
> Cc: Benjamin Doron <benjamin.doron00@gmail.com>
> Signed-off-by: Nate DeSimone <nathaniel.l.desimone@intel.com>
> ---
>   .../Intel/KabylakeOpenBoardPkg/Include/Library/EcLib.h   | 9 +++++----
>   .../KabylakeOpenBoardPkg/Library/BaseEcLib/EcCommands.c  | 9 +++++----
>   2 files changed, 10 insertions(+), 8 deletions(-)
> 
> diff --git a/Platform/Intel/KabylakeOpenBoardPkg/Include/Library/EcLib.h b/Platform/Intel/KabylakeOpenBoardPkg/Include/Library/EcLib.h
> index 7c58e592d9..e95accc465 100644
> --- a/Platform/Intel/KabylakeOpenBoardPkg/Include/Library/EcLib.h
> +++ b/Platform/Intel/KabylakeOpenBoardPkg/Include/Library/EcLib.h
> @@ -7,7 +7,7 @@
>     Make sure you meet the requirements for the library (protocol dependencies, use
>     restrictions, etc).
>   
> -Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
> +Copyright (c) 2019 - 2021, Intel Corporation. All rights reserved.<BR>
>   SPDX-License-Identifier: BSD-2-Clause-Patent
>   
>   **/
> @@ -109,9 +109,10 @@ LpcEcInterface (
>     @param[in]  Address          Address to read
>     @param[out] Data             Data received
>   
> -  @retval    EFI_SUCCESS       Command success
> -  @retval    EFI_DEVICE_ERROR  Command error
> -  @retval    EFI_TIMEOUT       Command timeout
> +  @retval    EFI_SUCCESS            Command success
> +  @retval    EFI_INVALID_PARAMETER  Data is NULL
> +  @retval    EFI_DEVICE_ERROR       Command error
> +  @retval    EFI_TIMEOUT            Command timeout
>   **/
>   EFI_STATUS
>   EcRead (
> diff --git a/Platform/Intel/KabylakeOpenBoardPkg/Library/BaseEcLib/EcCommands.c b/Platform/Intel/KabylakeOpenBoardPkg/Library/BaseEcLib/EcCommands.c
> index d14edb75de..14a746172b 100644
> --- a/Platform/Intel/KabylakeOpenBoardPkg/Library/BaseEcLib/EcCommands.c
> +++ b/Platform/Intel/KabylakeOpenBoardPkg/Library/BaseEcLib/EcCommands.c
> @@ -1,7 +1,7 @@
>   /** @file
>     Common EC commands.
>   
> -Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
> +Copyright (c) 2019 - 2021, Intel Corporation. All rights reserved.<BR>
>   SPDX-License-Identifier: BSD-2-Clause-Patent
>   
>   **/
> @@ -16,9 +16,10 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
>     @param[in]  Address          Address to read
>     @param[out] Data             Data received
>   
> -  @retval    EFI_SUCCESS       Command success
> -  @retval    EFI_DEVICE_ERROR  Command error
> -  @retval    EFI_TIMEOUT       Command timeout
> +  @retval    EFI_SUCCESS            Command success
> +  @retval    EFI_INVALID_PARAMETER  Data is NULL
> +  @retval    EFI_DEVICE_ERROR       Command error
> +  @retval    EFI_TIMEOUT            Command timeout
>   **/
>   EFI_STATUS
>   EcRead (
> 

Re: [edk2-devel] [edk2-platforms] [PATCH V1] KabylakeOpenBoardPkg: Document EcLib return value

[Nate DeSimone]

Pushed: https://github.com/tianocore/edk2-platforms/commit/6e68849

-----Original Message-----
From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Nate DeSimone
Sent: Wednesday, August 25, 2021 8:56 PM
To: devel@edk2.groups.io
Cc: Chiu, Chasel <chasel.chiu@intel.com>; Michael Kubacki <michael.kubacki@microsoft.com>; Benjamin Doron <benjamin.doron00@gmail.com>
Subject: [edk2-devel] [edk2-platforms] [PATCH V1] KabylakeOpenBoardPkg: Document EcLib return value

Added EFI_INVALID_PARAMETER to the EcRead() function's list of return values.

Cc: Chasel Chiu <chasel.chiu@intel.com>
Cc: Michael Kubacki <michael.kubacki@microsoft.com>
Cc: Benjamin Doron <benjamin.doron00@gmail.com>
Signed-off-by: Nate DeSimone <nathaniel.l.desimone@intel.com>
---
 .../Intel/KabylakeOpenBoardPkg/Include/Library/EcLib.h   | 9 +++++----
 .../KabylakeOpenBoardPkg/Library/BaseEcLib/EcCommands.c  | 9 +++++----
 2 files changed, 10 insertions(+), 8 deletions(-)

diff --git a/Platform/Intel/KabylakeOpenBoardPkg/Include/Library/EcLib.h b/Platform/Intel/KabylakeOpenBoardPkg/Include/Library/EcLib.h
index 7c58e592d9..e95accc465 100644
--- a/Platform/Intel/KabylakeOpenBoardPkg/Include/Library/EcLib.h
+++ b/Platform/Intel/KabylakeOpenBoardPkg/Include/Library/EcLib.h
@@ -7,7 +7,7 @@
   Make sure you meet the requirements for the library (protocol dependencies, use
   restrictions, etc).
 
-Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2019 - 2021, Intel Corporation. All rights reserved.<BR>
 SPDX-License-Identifier: BSD-2-Clause-Patent
 
 **/
@@ -109,9 +109,10 @@ LpcEcInterface (
   @param[in]  Address          Address to read
   @param[out] Data             Data received
 
-  @retval    EFI_SUCCESS       Command success
-  @retval    EFI_DEVICE_ERROR  Command error
-  @retval    EFI_TIMEOUT       Command timeout
+  @retval    EFI_SUCCESS            Command success
+  @retval    EFI_INVALID_PARAMETER  Data is NULL
+  @retval    EFI_DEVICE_ERROR       Command error
+  @retval    EFI_TIMEOUT            Command timeout
 **/
 EFI_STATUS
 EcRead (
diff --git a/Platform/Intel/KabylakeOpenBoardPkg/Library/BaseEcLib/EcCommands.c b/Platform/Intel/KabylakeOpenBoardPkg/Library/BaseEcLib/EcCommands.c
index d14edb75de..14a746172b 100644
--- a/Platform/Intel/KabylakeOpenBoardPkg/Library/BaseEcLib/EcCommands.c
+++ b/Platform/Intel/KabylakeOpenBoardPkg/Library/BaseEcLib/EcCommands.c
@@ -1,7 +1,7 @@
 /** @file
   Common EC commands.
 
-Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2019 - 2021, Intel Corporation. All rights reserved.<BR>
 SPDX-License-Identifier: BSD-2-Clause-Patent
 
 **/
@@ -16,9 +16,10 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
   @param[in]  Address          Address to read
   @param[out] Data             Data received
 
-  @retval    EFI_SUCCESS       Command success
-  @retval    EFI_DEVICE_ERROR  Command error
-  @retval    EFI_TIMEOUT       Command timeout
+  @retval    EFI_SUCCESS            Command success
+  @retval    EFI_INVALID_PARAMETER  Data is NULL
+  @retval    EFI_DEVICE_ERROR       Command error
+  @retval    EFI_TIMEOUT            Command timeout
 **/
 EFI_STATUS
 EcRead (
--
2.27.0.windows.1