From: Ard Biesheuvel <ard.biesheuvel@linaro.org>
To: Evan Lloyd <evan.lloyd@arm.com>
Cc: "edk2-devel@lists.01.org" <edk2-devel@lists.01.org>,
<"Matteo.Carlini@arm.com"@arm.com>,
<"leif.lindholm@linaro.org"@arm.com>, <"nd@arm.com"@arm.com>,
Arvind Chauhan <Arvind.Chauhan@arm.com>,
Thomas Panakamattam Abraham <thomas.abraham@arm.com>,
<"ard.biesheuvel@linaro.org"@arm.com>
Subject: Re: [PATCH edk2-platforms v2 03/18] ARM/VExpressPkg: Tidy HdLcd/PL111Lcd code: Updated comments
Date: Sat, 23 Dec 2017 14:08:16 +0000 [thread overview]
Message-ID: <CAKv+Gu9aOwx=_CFap9v4UW=8KsFgq4HKiCrwqop+isQvBHfxAQ@mail.gmail.com> (raw)
In-Reply-To: <20171222190821.12440-4-evan.lloyd@arm.com>
On 22 December 2017 at 19:08, <evan.lloyd@arm.com> wrote:
> From: Girish Pathak <girish.pathak at arm.com>
>
> There is no functional modification in this change.
> In this change some comments in HDLCD and PL111LCD platform library
> code are modified and a few new comments are added. This is to
> prevent mixing formatting changes with functional changes.
>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Girish Pathak <girish.pathak@arm.com>
> Signed-off-by: Evan Lloyd <evan.lloyd@arm.com>
Reviewed-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>
> ---
> Platform/ARM/VExpressPkg/Library/PL111LcdArmVExpressLib/PL111LcdArmVExpressLib.inf | 2 +-
> Platform/ARM/VExpressPkg/Library/HdLcdArmVExpressLib/HdLcdArmVExpress.c | 74 ++++++++++++++++++++
> Platform/ARM/VExpressPkg/Library/PL111LcdArmVExpressLib/PL111LcdArmVExpress.c | 73 +++++++++++++++++++
> 3 files changed, 148 insertions(+), 1 deletion(-)
>
> diff --git a/Platform/ARM/VExpressPkg/Library/PL111LcdArmVExpressLib/PL111LcdArmVExpressLib.inf b/Platform/ARM/VExpressPkg/Library/PL111LcdArmVExpressLib/PL111LcdArmVExpressLib.inf
> index 335c84841a4ff4b57c0d495bc48e93579b5ce576..e97febb91c89f82f8cad12823f5ffe182e87f8cd 100644
> --- a/Platform/ARM/VExpressPkg/Library/PL111LcdArmVExpressLib/PL111LcdArmVExpressLib.inf
> +++ b/Platform/ARM/VExpressPkg/Library/PL111LcdArmVExpressLib/PL111LcdArmVExpressLib.inf
> @@ -1,6 +1,6 @@
> #/** @file
> #
> -# Component description file for ArmVeGraphicsDxe module
> +# Component description file for PL111LcdArmVExpressLib module
> #
> # Copyright (c) 2011-2017, ARM Ltd. All rights reserved.<BR>
> #
> diff --git a/Platform/ARM/VExpressPkg/Library/HdLcdArmVExpressLib/HdLcdArmVExpress.c b/Platform/ARM/VExpressPkg/Library/HdLcdArmVExpressLib/HdLcdArmVExpress.c
> index 851ba83b79f0fea7019269c30e7add58f5ff9cb2..e4d0a4c8407835df6ab62c02d18531c4d3f08c97 100644
> --- a/Platform/ARM/VExpressPkg/Library/HdLcdArmVExpressLib/HdLcdArmVExpress.c
> +++ b/Platform/ARM/VExpressPkg/Library/HdLcdArmVExpressLib/HdLcdArmVExpress.c
> @@ -44,6 +44,8 @@ typedef struct {
> UINT32 VFrontPorch;
> } LCD_RESOLUTION;
>
> +/** The display modes supported by the platform.
> +**/
> LCD_RESOLUTION mResolutions[] = {
> { // Mode 0 : VGA : 640 x 480 x 24 bpp
> VGA, VGA_H_RES_PIXELS, VGA_V_RES_PIXELS, LCD_BITS_PER_PIXEL_24,
> @@ -93,6 +95,13 @@ EFI_EDID_ACTIVE_PROTOCOL mEdidActive = {
> NULL
> };
>
> +/** HDLCD platform specific initialization function.
> +
> + @param[in] Handle Handle to the LCD device instance.
> +
> + @retval EFI_SUCCESS Plaform library initialized successfully.
> + @retval !(EFI_SUCCESS) Other errors.
> +**/
> EFI_STATUS
> LcdPlatformInitializeDisplay (
> IN EFI_HANDLE Handle
> @@ -123,6 +132,18 @@ LcdPlatformInitializeDisplay (
> return Status;
> }
>
> +/** Allocate VRAM memory in DRAM for the frame buffer
> + (unless it is reserved already).
> +
> + The allocated address can be used to set the frame buffer.
> +
> + @param[out] VramBaseAddress A pointer to the frame buffer address.
> + @param[out] VramSize A pointer to the size of the frame
> + buffer in bytes
> +
> + @retval EFI_SUCCESS Frame buffer memory allocated successfully.
> + @retval !(EFI_SUCCESS) Other errors.
> +**/
> EFI_STATUS
> LcdPlatformGetVram (
> OUT EFI_PHYSICAL_ADDRESS* VramBaseAddress,
> @@ -169,6 +190,13 @@ LcdPlatformGetVram (
> return EFI_SUCCESS;
> }
>
> +/** Return total number of modes supported.
> +
> + Note: Valid mode numbers are 0 to MaxMode - 1
> + See Section 12.9 of the UEFI Specification 2.7
> +
> + @retval UINT32 Mode Number.
> +**/
> UINT32
> LcdPlatformGetMaxMode (VOID)
> {
> @@ -177,6 +205,14 @@ LcdPlatformGetMaxMode (VOID)
> return (sizeof (mResolutions) / sizeof (LCD_RESOLUTION));
> }
>
> +/** Set the requested display mode.
> +
> + @param[in] ModeNumber Mode Number.
> +
> + @retval EFI_SUCCESS Mode set successfully.
> + @retval EFI_INVALID_PARAMETER Requested mode not found.
> + @retval !(EFI_SUCCESS) Other errors.
> +**/
> EFI_STATUS
> LcdPlatformSetMode (
> IN UINT32 ModeNumber
> @@ -226,6 +262,17 @@ LcdPlatformSetMode (
> return Status;
> }
>
> +/** Return information for the requested mode number.
> +
> + @param[in] ModeNumber Mode Number.
> +
> + @param[out] Info Pointer for returned mode information
> + (on success).
> +
> + @retval EFI_SUCCESS Mode information for the requested mode
> + returned successfully.
> + @retval EFI_INVALID_PARAMETER Requested mode not found.
> +**/
> EFI_STATUS
> LcdPlatformQueryMode (
> IN UINT32 ModeNumber,
> @@ -266,6 +313,23 @@ LcdPlatformQueryMode (
> return EFI_SUCCESS;
> }
>
> +/** Return display timing information for the requested mode number.
> +
> + @param[in] ModeNumber Mode Number.
> +
> + @param[out] HRes Pointer to horizontal resolution.
> + @param[out] HSync Pointer to horizontal sync width.
> + @param[out] HBackPorch Pointer to horizontal back porch.
> + @param[out] HFrontPorch Pointer to horizontal front porch.
> + @param[out] VRes Pointer to vertical resolution.
> + @param[out] VSync Pointer to vertical sync width.
> + @param[out] VBackPorch Pointer to vertical back porch.
> + @param[out] VFrontPorch Pointer to vertical front porch.
> +
> + @retval EFI_SUCCESS Display timing information for the requested
> + mode returned successfully.
> + @retval EFI_INVALID_PARAMETER Requested mode not found.
> +**/
> EFI_STATUS
> LcdPlatformGetTimings (
> IN UINT32 ModeNumber,
> @@ -295,6 +359,16 @@ LcdPlatformGetTimings (
> return EFI_SUCCESS;
> }
>
> +/** Return bits per pixel information for a mode number.
> +
> + @param[in] ModeNumber Mode Number.
> +
> + @param[out] Bpp Pointer to value bits per pixel.
> +
> + @retval EFI_SUCCESS Bit per pixel information for the requested
> + mode returned successfully.
> + @retval EFI_INVALID_PARAMETER Requested mode not found.
> +**/
> EFI_STATUS
> LcdPlatformGetBpp (
> IN UINT32 ModeNumber,
> diff --git a/Platform/ARM/VExpressPkg/Library/PL111LcdArmVExpressLib/PL111LcdArmVExpress.c b/Platform/ARM/VExpressPkg/Library/PL111LcdArmVExpressLib/PL111LcdArmVExpress.c
> index 2586a6d8c2076c9aff15f50d652e462d783f13dc..0bbd40ceeb850209cd4842f34e72a0b635309a15 100644
> --- a/Platform/ARM/VExpressPkg/Library/PL111LcdArmVExpressLib/PL111LcdArmVExpress.c
> +++ b/Platform/ARM/VExpressPkg/Library/PL111LcdArmVExpressLib/PL111LcdArmVExpress.c
> @@ -41,6 +41,8 @@ typedef struct {
> UINT32 VFrontPorch;
> } LCD_RESOLUTION;
>
> +/** The display modes supported by the platform.
> +**/
> LCD_RESOLUTION mResolutions[] = {
> { // Mode 0 : VGA : 640 x 480 x 24 bpp
> VGA, VGA_H_RES_PIXELS, VGA_V_RES_PIXELS, LCD_BITS_PER_PIXEL_24,
> @@ -150,6 +152,12 @@ EFI_EDID_ACTIVE_PROTOCOL mEdidActive = {
> NULL
> };
>
> +/** PL111 Platform specific initialization function.
> +
> + @param[in] Handle Handle to the LCD device instance.
> + @retval EFI_SUCCESS Plaform library initialized successfully.
> + @retval !(EFI_SUCCESS) Other errors.
> +**/
> EFI_STATUS
> LcdPlatformInitializeDisplay (
> IN EFI_HANDLE Handle
> @@ -175,6 +183,18 @@ LcdPlatformInitializeDisplay (
> return Status;
> }
>
> +/** Allocate VRAM memory in DRAM for the frame buffer
> + (unless it is reserved already).
> +
> + The allocated address can be used to set the frame buffer.
> +
> + @param[out] VramBaseAddress A pointer to the frame buffer address.
> + @param[out] VramSize A pointer to the size of the frame
> + buffer in bytes
> +
> + @retval EFI_SUCCESS Frame buffer memory allocated successfully.
> + @retval !(EFI_SUCCESS) Other errors.
> +**/
> EFI_STATUS
> LcdPlatformGetVram (
> OUT EFI_PHYSICAL_ADDRESS* VramBaseAddress,
> @@ -231,6 +251,13 @@ LcdPlatformGetVram (
> return Status;
> }
>
> +/** Return total number of modes supported.
> +
> + Note: Valid mode numbers are 0 to MaxMode - 1
> + See Section 12.9 of the UEFI Specification 2.7
> +
> + @retval UINT32 Mode Number.
> +**/
> UINT32
> LcdPlatformGetMaxMode (VOID)
> {
> @@ -246,6 +273,15 @@ LcdPlatformGetMaxMode (VOID)
> return (PcdGet32 (PcdPL111LcdMaxMode));
> }
>
> +/** Set the requested display mode.
> +
> + @param[in] ModeNumber Mode Number.
> +
> + @retval EFI_SUCCESS Mode set successfully.
> + @retval EFI_INVALID_PARAMETER Requested mode not found.
> + @retval EFI_UNSUPPORTED PLL111 configuration not supported.
> + @retval !(EFI_SUCCESS) Other errors.
> +**/
> EFI_STATUS
> LcdPlatformSetMode (
> IN UINT32 ModeNumber
> @@ -317,6 +353,16 @@ LcdPlatformSetMode (
> return Status;
> }
>
> +/** Return information for the requested mode number.
> +
> + @param[in] ModeNumber Mode Number.
> + @param[out] Info Pointer for returned mode information
> + (on success).
> +
> + @retval EFI_SUCCESS Mode information for the requested mode
> + returned successfully.
> + @retval EFI_INVALID_PARAMETER Requested mode not found.
> +**/
> EFI_STATUS
> LcdPlatformQueryMode (
> IN UINT32 ModeNumber,
> @@ -357,6 +403,23 @@ LcdPlatformQueryMode (
> return EFI_SUCCESS;
> }
>
> +/** Return display timing information for the requested mode number.
> +
> + @param[in] ModeNumber Mode Number.
> +
> + @param[out] HRes Pointer to horizontal resolution.
> + @param[out] HSync Pointer to horizontal sync width.
> + @param[out] HBackPorch Pointer to horizontal back porch.
> + @param[out] HFrontPorch Pointer to horizontal front porch.
> + @param[out] VRes Pointer to vertical resolution.
> + @param[out] VSync Pointer to vertical sync width.
> + @param[out] VBackPorch Pointer to vertical back porch.
> + @param[out] VFrontPorch Pointer to vertical front porch.
> +
> + @retval EFI_SUCCESS Display timing information for the requested
> + mode returned successfully.
> + @retval EFI_INVALID_PARAMETER Requested mode not found.
> +**/
> EFI_STATUS
> LcdPlatformGetTimings (
> IN UINT32 ModeNumber,
> @@ -386,6 +449,16 @@ LcdPlatformGetTimings (
> return EFI_SUCCESS;
> }
>
> +/** Return bits per pixel information for a mode number.
> +
> + @param[in] ModeNumber Mode Number.
> +
> + @param[out] Bpp Pointer to value bits per pixel.
> +
> + @retval EFI_SUCCESS Bit per pixel information for the requested
> + mode returned successfully.
> + @retval EFI_INVALID_PARAMETER Requested mode not found.
> +**/
> EFI_STATUS
> LcdPlatformGetBpp (
> IN UINT32 ModeNumber,
> --
> Guid("CE165669-3EF3-493F-B85D-6190EE5B9759")
>
> _______________________________________________
> edk2-devel mailing list
> edk2-devel@lists.01.org
> https://lists.01.org/mailman/listinfo/edk2-devel
next prev parent reply other threads:[~2017-12-23 14:03 UTC|newest]
Thread overview: 57+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-12-22 19:08 [PATCH edk2-platforms v2 00/18] ARM: Update GOP evan.lloyd
2017-12-22 19:08 ` [PATCH edk2-platforms v2 01/18] ARM/VExpressPkg: Fix MODULE_TYPE of HDLCD/PL111 platform libraries evan.lloyd
2017-12-22 19:08 ` [PATCH edk2-platforms v2 02/18] ARM/VExpressPkg: Tidy HDLCD and PL11LCD platform Lib: Coding standard evan.lloyd
2017-12-23 14:07 ` Ard Biesheuvel
2017-12-22 19:08 ` [PATCH edk2-platforms v2 03/18] ARM/VExpressPkg: Tidy HdLcd/PL111Lcd code: Updated comments evan.lloyd
2017-12-23 14:08 ` Ard Biesheuvel [this message]
2017-12-22 19:08 ` [PATCH edk2-platforms v2 04/18] ARM/VExpressPkg: Remove unused PcdPL111LcdMaxMode from HDLCD inf evan.lloyd
2017-12-23 14:08 ` Ard Biesheuvel
2017-12-22 19:08 ` [PATCH edk2-platforms v2 05/18] ARM/VExpressPkg: PL111 and HDLCD: add const qualifier evan.lloyd
2017-12-23 14:09 ` Ard Biesheuvel
2017-12-22 19:08 ` [PATCH edk2-platforms v2 06/18] ARM/VExpressPkg: Add and update debug ASSERTS evan.lloyd
2017-12-23 14:12 ` Ard Biesheuvel
2018-01-04 18:55 ` Girish Pathak
2018-01-04 19:24 ` Ard Biesheuvel
2018-01-04 19:51 ` Evan Lloyd
2018-01-04 19:54 ` Ard Biesheuvel
2018-02-28 20:27 ` Evan Lloyd
2018-03-02 19:07 ` Ard Biesheuvel
2018-03-05 15:08 ` Evan Lloyd
2018-03-06 11:16 ` Ard Biesheuvel
2018-03-14 12:24 ` Leif Lindholm
2018-03-14 12:35 ` Ard Biesheuvel
2018-03-14 12:39 ` Leif Lindholm
2017-12-22 19:08 ` [PATCH edk2-platforms v2 07/18] ARM/VExpressPkg: PL111LcdArmVExpressLib: Minor code cleanup evan.lloyd
2017-12-23 14:13 ` Ard Biesheuvel
2017-12-22 19:08 ` [PATCH edk2-platforms v2 08/18] ARM/VExpressPkg: PL111 and HDLCD: Use FixedPcdGet32 evan.lloyd
2017-12-23 14:14 ` Ard Biesheuvel
2017-12-22 19:08 ` [PATCH edk2-platforms v2 09/18] ARM/VExpressPkg: PL11LcdArmVExpressLib: Improvement conditional evan.lloyd
2017-12-23 14:16 ` Ard Biesheuvel
2017-12-22 19:08 ` [PATCH edk2-platforms v2 10/18] ARM/VExpressPkg: HdLcdArmVExpressLib: Remove status check EFI_TIMEOUT evan.lloyd
2017-12-23 14:16 ` Ard Biesheuvel
2017-12-22 19:08 ` [PATCH edk2-platforms v2 11/18] ARM/VExpressPkg: HdLcdArmVExpressLib: Remove redundant Bpp evan.lloyd
2017-12-23 14:17 ` Ard Biesheuvel
2017-12-22 19:08 ` [PATCH edk2-platforms v2 12/18] ARM/VExpressPkg: Redefine LcdPlatformGetTimings function evan.lloyd
2017-12-23 14:18 ` Ard Biesheuvel
2017-12-22 19:08 ` [PATCH edk2-platforms v2 13/18] ARM/VExpressPkg: PL111 and HDLCD: Add PCD to select pixel format evan.lloyd
2017-12-23 16:00 ` Ard Biesheuvel
2017-12-22 19:08 ` [PATCH edk2-platforms v2 14/18] ARM/VExpressPkg: Reserving framebuffer at build evan.lloyd
2017-12-23 16:02 ` Ard Biesheuvel
2018-01-03 11:04 ` Evan Lloyd
2017-12-22 19:08 ` [PATCH edk2-platforms v2 15/18] ARM/VExpressPkg: New DP500/DP550/DP650 platform library evan.lloyd
2017-12-23 16:07 ` Ard Biesheuvel
2018-01-08 18:51 ` Evan Lloyd
2018-01-24 11:27 ` Alexei Fedorov
2018-01-24 11:34 ` Ard Biesheuvel
2017-12-22 19:08 ` [PATCH edk2-platforms v2 16/18] ARM/JunoPkg: Mapping Non-Trused SRAM as device memory evan.lloyd
2017-12-23 16:08 ` Ard Biesheuvel
2017-12-22 19:08 ` [PATCH edk2-platforms v2 17/18] ARM/JunoPkg: Adding SCMI MTL library evan.lloyd
2017-12-23 16:12 ` Ard Biesheuvel
2017-12-22 19:08 ` [PATCH edk2-platforms v2 18/18] ARM/JunoPkg: Add HDLCD platform library evan.lloyd
2017-12-23 16:22 ` Ard Biesheuvel
2018-01-09 18:21 ` Evan Lloyd
2018-01-09 18:26 ` Ard Biesheuvel
2018-01-10 11:45 ` Alexei Fedorov
2018-01-10 12:02 ` Ard Biesheuvel
2017-12-22 19:29 ` [PATCH edk2-platforms v2 00/18] ARM: Update GOP Ard Biesheuvel
2018-01-02 10:28 ` Evan Lloyd
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='CAKv+Gu9aOwx=_CFap9v4UW=8KsFgq4HKiCrwqop+isQvBHfxAQ@mail.gmail.com' \
--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