From: Leif Lindholm <leif.lindholm@linaro.org>
To: evan.lloyd@arm.com
Cc: edk2-devel@ml01.01.org,
Ard Biesheuvel <ard.biesheuvel@linaro.org>,
Ryan Harkin <ryan.harkin@linaro.org>
Subject: Re: [PATCH 2/3] ArmPlatformPkg: Correct mendacious comments.
Date: Mon, 10 Oct 2016 20:00:02 +0100 [thread overview]
Message-ID: <20161010190002.GM3471@bivouac.eciton.net> (raw)
In-Reply-To: <20160921203315.11204-3-evan.lloyd@arm.com>
On Wed, Sep 21, 2016 at 09:33:14PM +0100, evan.lloyd@arm.com wrote:
> From: Alexei <Alexei.Fedorov@arm.com>
>
> Correct some obviously incorrect comments that have invalid details for
> the returned values. (Copy /Paste problem?)
Oh, definitely.
Reviewed-by: Leif Lindholm <leif.lindholm@linaro.org>
Thanks!
> 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>
> ---
> 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")
>
next prev parent reply other threads:[~2016-10-10 19:00 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-09-21 20:33 [PATCH 0/3] PL011 updates evan.lloyd
2016-09-21 20:33 ` [PATCH 1/3] ArmPlatformPkg: Fix PL011 FIFO size test evan.lloyd
2016-10-10 18:58 ` Leif Lindholm
2016-09-21 20:33 ` [PATCH 2/3] ArmPlatformPkg: Correct mendacious comments evan.lloyd
2016-10-10 19:00 ` Leif Lindholm [this message]
2016-09-21 20:33 ` [PATCH 3/3] ArmPlatformPkg: Remove UINTN cast when setting BaudRate evan.lloyd
2016-10-10 19:04 ` Leif Lindholm
2016-10-11 10:23 ` Evan Lloyd
2016-10-11 11:27 ` Leif Lindholm
2016-10-11 12:29 ` Evan Lloyd
2016-10-11 11:34 ` Laszlo Ersek
2016-10-12 7:30 ` [PATCH 0/3] PL011 updates Ryan Harkin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20161010190002.GM3471@bivouac.eciton.net \
--to=devel@edk2.groups.io \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox