diff options
| author | Alexei <Alexei.Fedorov@arm.com> | 2016-09-21 21:33:14 +0100 |
|---|---|---|
| committer | Leif Lindholm <leif.lindholm@linaro.org> | 2016-10-11 14:23:41 +0100 |
| commit | 2d52a3a237c4294022030d99c82e26f9e58276ad (patch) | |
| tree | 3443c56c4611f73b671d31d9d117f135f6588ccb /ArmPlatformPkg | |
| parent | 719a347c5df53a1dca6f80e06a285424228436e1 (diff) | |
| download | edk2-2d52a3a237c4294022030d99c82e26f9e58276ad.tar.gz edk2-2d52a3a237c4294022030d99c82e26f9e58276ad.tar.bz2 edk2-2d52a3a237c4294022030d99c82e26f9e58276ad.zip | |
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>
Diffstat (limited to 'ArmPlatformPkg')
| -rw-r--r-- | ArmPlatformPkg/Drivers/PL011Uart/PL011Uart.c | 5 | ||||
| -rw-r--r-- | ArmPlatformPkg/Include/Drivers/PL011Uart.h | 5 | ||||
| -rw-r--r-- | ArmPlatformPkg/Library/PL011SerialPortLib/PL011SerialPortLib.c | 17 |
3 files changed, 11 insertions, 16 deletions
diff --git a/ArmPlatformPkg/Drivers/PL011Uart/PL011Uart.c b/ArmPlatformPkg/Drivers/PL011Uart/PL011Uart.c index b3ea138bf6..77630237ae 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/Include/Drivers/PL011Uart.h b/ArmPlatformPkg/Include/Drivers/PL011Uart.h index 36ea9d6269..d5e88e86c8 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/Library/PL011SerialPortLib/PL011SerialPortLib.c b/ArmPlatformPkg/Library/PL011SerialPortLib/PL011SerialPortLib.c index 5092a0a202..5dce852d90 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
|