From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-qt0-x22b.google.com (mail-qt0-x22b.google.com [IPv6:2607:f8b0:400d:c0d::22b]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id C4D891A1E60 for ; Mon, 10 Oct 2016 12:00:05 -0700 (PDT) Received: by mail-qt0-x22b.google.com with SMTP id s49so63083887qta.0 for ; Mon, 10 Oct 2016 12:00:05 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to:user-agent; bh=7rytTXHwvouf+9fZsv8HOeETVg0dE+/hNjKiBrKQ5eA=; b=e33ECNtUhKUQ/CMtLsjY1Wv+liiV1+j3Jz/tFYmRbshGUN6EOjY9BDK2qFBcoRQg4d VkEza3frtCFmOUgq9MVYj8QHTgZG3e9U/glpxaNDrSD9ibZiUtstiF30Z5EjhvHBUCxh qO+rOK/5wU67MnoCudCXXmsYVp5ktm6wTkf6s= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to:user-agent; bh=7rytTXHwvouf+9fZsv8HOeETVg0dE+/hNjKiBrKQ5eA=; b=DrsOPbyY8cVJBPzcB4xdcF702UA0EnrH4DFKGSys9mpvqakjqJDkEKJg2Q8AmxDfuW A39o5ozBeSz5oxoFIKOPb67tPfC3+wAXjJpdWE/gexoMtsCVTAfYhVg+UfrE5yVjUTn6 hJ4SlsMlc3R7jeW/8qDdI/PwV9Oxkpgfzu8cQyhDb/aEqA9JtC70OUrwDZXhyH9QV5vd q/axwArR3ElgCDJpUUdzS7yTyOxXglA/FQE09NSGvfT+7tba7wJ8b6kx0juDKGsQPWAw 7k7gB9Jbi4BJBF0ZYQMHMgSMNx4NK1Y9CgyqXBFVtgiU+sSgn6f76NsZHTNitF0ny8eE ONUw== X-Gm-Message-State: AA6/9RmyVbP3Q29qICM7Goy/ty6fiKQbBuTuLjLlun3bcd9NVG2dzQfJtEjhoplwqunIk64R X-Received: by 10.194.78.43 with SMTP id y11mr14464304wjw.150.1476126004746; Mon, 10 Oct 2016 12:00:04 -0700 (PDT) Received: from bivouac.eciton.net (bivouac.eciton.net. [2a00:1098:0:86:1000:23:0:2]) by smtp.gmail.com with ESMTPSA id r1sm42328738wjc.43.2016.10.10.12.00.03 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 10 Oct 2016 12:00:03 -0700 (PDT) Date: Mon, 10 Oct 2016 20:00:02 +0100 From: Leif Lindholm To: evan.lloyd@arm.com Cc: edk2-devel@ml01.01.org, Ard Biesheuvel , Ryan Harkin Message-ID: <20161010190002.GM3471@bivouac.eciton.net> References: <20160921203315.11204-1-evan.lloyd@arm.com> <20160921203315.11204-3-evan.lloyd@arm.com> MIME-Version: 1.0 In-Reply-To: <20160921203315.11204-3-evan.lloyd@arm.com> User-Agent: Mutt/1.5.23 (2014-03-12) Subject: Re: [PATCH 2/3] ArmPlatformPkg: Correct mendacious comments. X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 10 Oct 2016 19:00:06 -0000 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline On Wed, Sep 21, 2016 at 09:33:14PM +0100, evan.lloyd@arm.com wrote: > From: Alexei > > Correct some obviously incorrect comments that have invalid details for > the returned values. (Copy /Paste problem?) Oh, definitely. Reviewed-by: Leif Lindholm Thanks! > There are no functional changes in this commit. > > Contributed-under: TianoCore Contribution Agreement 1.0 > Signed-off-by: Alexei Fedorov > Signed-off-by: Evan Lloyd > --- > 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 > > +/** 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") >