From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=2607:f8b0:4001:c06::241; helo=mail-io0-x241.google.com; envelope-from=ard.biesheuvel@linaro.org; receiver=edk2-devel@lists.01.org Received: from mail-io0-x241.google.com (mail-io0-x241.google.com [IPv6:2607:f8b0:4001:c06::241]) (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 E191B2035B2C5 for ; Sat, 23 Dec 2017 06:03:26 -0800 (PST) Received: by mail-io0-x241.google.com with SMTP id w127so27222466iow.11 for ; Sat, 23 Dec 2017 06:08:18 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=mime-version:in-reply-to:references:from:date:message-id:subject:to :cc; bh=py2WChZologwxizZfahw3RhuFKsMCOj9Ubj22ZbzylY=; b=jPXFugNE+afx5jmStpbt5hFO+JpIGWQVWB4XHFcW/wzo7yFGg38OqZpq3caoSu4Meh a11ERS4+t4OQw2mrpuijkyE6m1qUfKsmxekeCAZIGavuT0SA5ML0kMS6UBmSzhmrb9Bj 0vltObyiRgQbtno4NH+fgUiv79OME4TONPxeI= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:in-reply-to:references:from:date :message-id:subject:to:cc; bh=py2WChZologwxizZfahw3RhuFKsMCOj9Ubj22ZbzylY=; b=fsw2egMbV8aQcekarW7leBnEei587SZn3Mf4FFVxbNIprI/zwWwjZqZBIeJen9cUaw qLcGGakSyXoX46eP5tAJEKcbPw1ySADxiggVbPeJZK0k5G3I0afgAvzItjxIRJeY9Tw+ djeSfqkidy+o+ezwEP37m6zlJPFjkUO4Su/0CeNOmfo4GvHmRWq1I4ibx1W0XFP3sZ4u b3oKLewI5cFOHU3XdsTuWuemVJFkuRUG0KnLH9EjTqTsQL0uD6axGCorj/WQgYxKlPzS u9bOEyfytSaZIIvlnf8rxzn5y7D26mh6SKf0JUbFevmZmnhbmigShYfvwwqdaYwyOkGu dNSg== X-Gm-Message-State: AKGB3mLkfqhO17YrXh1fc/4oN/eu4WrMvCq9DyoseUDgXv9s95eKiLJ+ iR5uFANTXgmOlsFq+R7hTCdPqHvFgZeKsU3YuI9qjw== X-Google-Smtp-Source: ACJfBouylKW3Fr3D6KrbDMsaQfT3MRXMbmA+9ScMr2waDU51t5Mz9RG1z86cgQ+SMKmN42AkvKQijmpF5suRzSt7rx4= X-Received: by 10.107.2.212 with SMTP id 203mr17828501ioc.186.1514038097307; Sat, 23 Dec 2017 06:08:17 -0800 (PST) MIME-Version: 1.0 Received: by 10.107.52.14 with HTTP; Sat, 23 Dec 2017 06:08:16 -0800 (PST) In-Reply-To: <20171222190821.12440-4-evan.lloyd@arm.com> References: <20171222190821.12440-1-evan.lloyd@arm.com> <20171222190821.12440-4-evan.lloyd@arm.com> From: Ard Biesheuvel Date: Sat, 23 Dec 2017 14:08:16 +0000 Message-ID: To: Evan Lloyd Cc: "edk2-devel@lists.01.org" , <"Matteo.Carlini@arm.com"@arm.com>, <"leif.lindholm@linaro.org"@arm.com>, <"nd@arm.com"@arm.com>, Arvind Chauhan , Thomas Panakamattam Abraham , <"ard.biesheuvel@linaro.org"@arm.com> Subject: Re: [PATCH edk2-platforms v2 03/18] ARM/VExpressPkg: Tidy HdLcd/PL111Lcd code: Updated comments X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 23 Dec 2017 14:03:27 -0000 Content-Type: text/plain; charset="UTF-8" On 22 December 2017 at 19:08, wrote: > From: Girish Pathak > > 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 > Signed-off-by: Evan Lloyd Reviewed-by: Ard Biesheuvel > --- > 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.
> # > 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