ArmPlatformPkg: Correct mendacious comments.
authorAlexei <Alexei.Fedorov@arm.com>
Wed, 21 Sep 2016 20:33:14 +0000 (21:33 +0100)
committerLeif Lindholm <leif.lindholm@linaro.org>
Tue, 11 Oct 2016 13:23:41 +0000 (14:23 +0100)
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>
ArmPlatformPkg/Drivers/PL011Uart/PL011Uart.c
ArmPlatformPkg/Include/Drivers/PL011Uart.h
ArmPlatformPkg/Library/PL011SerialPortLib/PL011SerialPortLib.c

index b3ea138..7763023 100644 (file)
@@ -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
index 36ea9d6..d5e88e8 100644 (file)
@@ -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
index 5092a0a..5dce852 100644 (file)
 \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