From: Alexei <alexei.fedo...@arm.com>
Correct some obviously incorrect comments that have invalid details for
the returned values. (Copy /Paste problem?)
There are no functional changes in this commit.
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Alexei Fedorov <alexei.fedo...@arm.com>
Signed-off-by: Evan Lloyd <evan.ll...@arm.com>
---
ArmPlatformPkg/Include/Drivers/PL011Uart.h | 5 ++---
ArmPlatformPkg/Drivers/PL011Uart/PL011Uart.c | 5 ++---
ArmPlatformPkg/Library/PL011SerialPortLib/PL011SerialPortLib.c | 17
+++++++----------
3 files changed, 11 insertions(+), 16 deletions(-)
diff --git a/ArmPlatformPkg/Include/Drivers/PL011Uart.h
b/ArmPlatformPkg/Include/Drivers/PL011Uart.h
index
36ea9d62696162460567d91f9c1ba245d830db71..d5e88e86c86814e708bc901cca2153f5b7e5f927
100644
--- a/ArmPlatformPkg/Include/Drivers/PL011Uart.h
+++ b/ArmPlatformPkg/Include/Drivers/PL011Uart.h
@@ -246,9 +246,8 @@ PL011UartRead (
/**
Check to see if any data is available to be read from the debug device.
- @retval EFI_SUCCESS At least one byte of data is available to be read
- @retval EFI_NOT_READY No data is available to be read
- @retval EFI_DEVICE_ERROR The serial device is not functioning properly
+ @retval TRUE At least one byte of data is available to be read
+ @retval FALSE No data is available to be read
**/
BOOLEAN
diff --git a/ArmPlatformPkg/Drivers/PL011Uart/PL011Uart.c
b/ArmPlatformPkg/Drivers/PL011Uart/PL011Uart.c
index
b3ea138bf60b93a1000dd29aedaad206f2d15f2b..77630237ae91e38d8579303023c111bb56fe159d
100644
--- a/ArmPlatformPkg/Drivers/PL011Uart/PL011Uart.c
+++ b/ArmPlatformPkg/Drivers/PL011Uart/PL011Uart.c
@@ -456,9 +456,8 @@ PL011UartRead (
/**
Check to see if any data is available to be read from the debug device.
- @retval EFI_SUCCESS At least one byte of data is available to be read
- @retval EFI_NOT_READY No data is available to be read
- @retval EFI_DEVICE_ERROR The serial device is not functioning properly
+ @retval TRUE At least one byte of data is available to be read
+ @retval FALSE No data is available to be read
**/
BOOLEAN
diff --git a/ArmPlatformPkg/Library/PL011SerialPortLib/PL011SerialPortLib.c
b/ArmPlatformPkg/Library/PL011SerialPortLib/PL011SerialPortLib.c
index
5092a0a202fac18f8c1b7bdc6d4e904db0c0d585..5dce852d90f9cafb828d81dae39d03451ea608e2
100644
--- a/ArmPlatformPkg/Library/PL011SerialPortLib/PL011SerialPortLib.c
+++ b/ArmPlatformPkg/Library/PL011SerialPortLib/PL011SerialPortLib.c
@@ -23,14 +23,12 @@
#include <Drivers/PL011Uart.h>
+/** Initialise the serial device hardware with default settings.
-/**
-
- Programmed hardware of Serial port.
-
- @return Always return RETURN_UNSUPPORTED.
-
-**/
+ @retval RETURN_SUCCESS The serial device was initialised.
+ @retval RETURN_INVALID_PARAMETER One or more of the default settings
+ has an unsupported value.
+ **/
RETURN_STATUS
EFIAPI
SerialPortInitialize (
@@ -103,9 +101,8 @@ SerialPortRead (
/**
Check to see if any data is available to be read from the debug device.
- @retval EFI_SUCCESS At least one byte of data is available to be read
- @retval EFI_NOT_READY No data is available to be read
- @retval EFI_DEVICE_ERROR The serial device is not functioning properly
+ @retval TRUE At least one byte of data is available to be read
+ @retval FALSE No data is available to be read
**/
BOOLEAN
--
Guid("CE165669-3EF3-493F-B85D-6190EE5B9759")
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
