tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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>
This commit is contained in:
Alexei 2016-09-21 21:33:14 +01:00 committed by Leif Lindholm
parent 719a347c5d
commit 2d52a3a237
3 changed files with 11 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ArmPlatformPkg/Drivers/PL011Uart/PL011Uart.c
View File

@ -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

5
ArmPlatformPkg/Include/Drivers/PL011Uart.h
View File

@ -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

17
ArmPlatformPkg/Library/PL011SerialPortLib/PL011SerialPortLib.c
View File

@ -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