Browse Source

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>
Reviewed-by: Chasel Chiu <chasel.chiu@intel.com>
Reviewed-by: Michael Kubacki <michael.kubacki@microsoft.com>
Nate DeSimone 2 years ago
parent
commit
6e68849e55

+ 5 - 4
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 (

+ 5 - 4
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 (