ArmPlatformPkg: Correct mendacious comments.

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.fedorov@arm.com>
Signed-off-by: Evan Lloyd <evan.lloyd@arm.com>
Reviewed-by: Leif Lindholm <leif.lindholm@linaro.org>

diff --git a/ArmPlatformPkg/Drivers/PL011Uart/PL011Uart.c b/ArmPlatformPkg/Drivers/PL011Uart/PL011Uart.c
index b3ea138bf60b93a1000dd29aedaad206f2d15f2b..77630237ae91e38d8579303023c111bb56fe159d 100644 (file)
--- a/ArmPlatformPkg/Drivers/PL011Uart/PL011Uart.c
+++ b/ArmPlatformPkg/Drivers/PL011Uart/PL011Uart.c
@@ -456,9 +456,8 @@ PL011UartRead (
 /**\r
   Check to see if any data is available to be read from the debug device.\r
 \r
-  @retval EFI_SUCCESS       At least one byte of data is available to be read\r
-  @retval EFI_NOT_READY     No data is available to be read\r
-  @retval EFI_DEVICE_ERROR  The serial device is not functioning properly\r
+  @retval TRUE       At least one byte of data is available to be read\r
+  @retval FALSE      No data is available to be read\r
 \r
 **/\r
 BOOLEAN\r

diff --git a/ArmPlatformPkg/Include/Drivers/PL011Uart.h b/ArmPlatformPkg/Include/Drivers/PL011Uart.h
index 36ea9d62696162460567d91f9c1ba245d830db71..d5e88e86c86814e708bc901cca2153f5b7e5f927 100644 (file)
--- a/ArmPlatformPkg/Include/Drivers/PL011Uart.h
+++ b/ArmPlatformPkg/Include/Drivers/PL011Uart.h
@@ -246,9 +246,8 @@ PL011UartRead (
 /**\r
   Check to see if any data is available to be read from the debug device.\r
 \r
-  @retval EFI_SUCCESS       At least one byte of data is available to be read\r
-  @retval EFI_NOT_READY     No data is available to be read\r
-  @retval EFI_DEVICE_ERROR  The serial device is not functioning properly\r
+  @retval TRUE       At least one byte of data is available to be read\r
+  @retval FALSE      No data is available to be read\r
 \r
 **/\r
 BOOLEAN\r

diff --git a/ArmPlatformPkg/Library/PL011SerialPortLib/PL011SerialPortLib.c b/ArmPlatformPkg/Library/PL011SerialPortLib/PL011SerialPortLib.c
index 5092a0a202fac18f8c1b7bdc6d4e904db0c0d585..5dce852d90f9cafb828d81dae39d03451ea608e2 100644 (file)
--- a/ArmPlatformPkg/Library/PL011SerialPortLib/PL011SerialPortLib.c
+++ b/ArmPlatformPkg/Library/PL011SerialPortLib/PL011SerialPortLib.c
@@ -23,14 +23,12 @@
 \r
 #include <Drivers/PL011Uart.h>\r
 \r
+/** Initialise the serial device hardware with default settings.\r
 \r
-/**\r
-\r
-  Programmed hardware of Serial port.\r
-\r
-  @return    Always return RETURN_UNSUPPORTED.\r
-\r
-**/\r
+  @retval RETURN_SUCCESS            The serial device was initialised.\r
+  @retval RETURN_INVALID_PARAMETER  One or more of the default settings\r
+                                    has an unsupported value.\r
+ **/\r
 RETURN_STATUS\r
 EFIAPI\r
 SerialPortInitialize (\r
@@ -103,9 +101,8 @@ SerialPortRead (
 /**\r
   Check to see if any data is available to be read from the debug device.\r
 \r
-  @retval EFI_SUCCESS       At least one byte of data is available to be read\r
-  @retval EFI_NOT_READY     No data is available to be read\r
-  @retval EFI_DEVICE_ERROR  The serial device is not functioning properly\r
+  @retval TRUE       At least one byte of data is available to be read\r
+  @retval FALSE      No data is available to be read\r
 \r
 **/\r
 BOOLEAN\r