* [edk2-platforms] [PATCH V1] KabylakeOpenBoardPkg: Document EcLib return value
@ 2021-08-26 3:55 Nate DeSimone
2021-08-26 15:36 ` [edk2-devel] " Michael Kubacki
2021-09-01 0:34 ` Chiu, Chasel
0 siblings, 2 replies; 3+ messages in thread
From: Nate DeSimone @ 2021-08-26 3:55 UTC (permalink / raw)
To: devel; +Cc: Chasel Chiu, Michael Kubacki, Benjamin Doron
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
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [edk2-devel] [edk2-platforms] [PATCH V1] KabylakeOpenBoardPkg: Document EcLib return value
2021-08-26 3:55 [edk2-platforms] [PATCH V1] KabylakeOpenBoardPkg: Document EcLib return value Nate DeSimone
@ 2021-08-26 15:36 ` Michael Kubacki
2021-09-01 0:34 ` Chiu, Chasel
1 sibling, 0 replies; 3+ messages in thread
From: Michael Kubacki @ 2021-08-26 15:36 UTC (permalink / raw)
To: devel, nathaniel.l.desimone; +Cc: Chasel Chiu, Michael Kubacki, Benjamin Doron
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 (
>
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [edk2-platforms] [PATCH V1] KabylakeOpenBoardPkg: Document EcLib return value
2021-08-26 3:55 [edk2-platforms] [PATCH V1] KabylakeOpenBoardPkg: Document EcLib return value Nate DeSimone
2021-08-26 15:36 ` [edk2-devel] " Michael Kubacki
@ 2021-09-01 0:34 ` Chiu, Chasel
1 sibling, 0 replies; 3+ messages in thread
From: Chiu, Chasel @ 2021-09-01 0:34 UTC (permalink / raw)
To: Desimone, Nathaniel L, devel@edk2.groups.io
Cc: Michael Kubacki, Benjamin Doron
Reviewed-by: Chasel Chiu <chasel.chiu@intel.com>
> -----Original Message-----
> From: Desimone, Nathaniel L <nathaniel.l.desimone@intel.com>
> Sent: Thursday, August 26, 2021 11:56 AM
> 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-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
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2021-09-01 0:34 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-08-26 3:55 [edk2-platforms] [PATCH V1] KabylakeOpenBoardPkg: Document EcLib return value Nate DeSimone
2021-08-26 15:36 ` [edk2-devel] " Michael Kubacki
2021-09-01 0:34 ` Chiu, Chasel
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox