/** @file\r
+ This file implements the Graphics Output protocol for Arm platforms\r
\r
- Copyright (c) 2011, ARM Ltd. All rights reserved.<BR>\r
- This program and the accompanying materials\r
- are licensed and made available under the terms and conditions of the BSD License\r
- which accompanies this distribution. The full text of the license may be found at\r
- http://opensource.org/licenses/bsd-license.php\r
+ Copyright (c) 2011 - 2020, Arm Limited. All rights reserved.<BR>\r
+ SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
- **/\r
+**/\r
\r
#include <PiDxe.h>\r
#include <Library/BaseMemoryLib.h>\r
\r
#include "LcdGraphicsOutputDxe.h"\r
\r
-/**********************************************************************\r
- *\r
- * This file implements the Graphics Output protocol on ArmVersatileExpress\r
- * using the Lcd controller\r
- *\r
- **********************************************************************/\r
-\r
//\r
// Global variables\r
//\r
\r
-BOOLEAN mDisplayInitialized = FALSE;\r
+BOOLEAN mDisplayInitialized = FALSE;\r
\r
-LCD_INSTANCE mLcdTemplate = {\r
+LCD_INSTANCE mLcdTemplate = {\r
LCD_INSTANCE_SIGNATURE,\r
- NULL, // Handle\r
- { // ModeInfo\r
- 0, // Version\r
- 0, // HorizontalResolution\r
- 0, // VerticalResolution\r
+ NULL, // Handle\r
+ { // ModeInfo\r
+ 0, // Version\r
+ 0, // HorizontalResolution\r
+ 0, // VerticalResolution\r
PixelBltOnly, // PixelFormat\r
- 0, // PixelInformation\r
- 0, // PixelsPerScanLine\r
+ { 0 }, // PixelInformation\r
+ 0, // PixelsPerScanLine\r
},\r
{\r
- 0, // MaxMode;\r
- 0, // Mode;\r
+ 0, // MaxMode;\r
+ 0, // Mode;\r
NULL, // Info;\r
- 0, // SizeOfInfo;\r
- 0, // FrameBufferBase;\r
- 0 // FrameBufferSize;\r
+ 0, // SizeOfInfo;\r
+ 0, // FrameBufferBase;\r
+ 0 // FrameBufferSize;\r
},\r
- { // Gop\r
- LcdGraphicsQueryMode, // QueryMode\r
- LcdGraphicsSetMode, // SetMode\r
- LcdGraphicsBlt, // Blt\r
- NULL // *Mode\r
+ { // Gop\r
+ LcdGraphicsQueryMode, // QueryMode\r
+ LcdGraphicsSetMode, // SetMode\r
+ LcdGraphicsBlt, // Blt\r
+ NULL // *Mode\r
},\r
{ // DevicePath\r
{\r
{\r
- HARDWARE_DEVICE_PATH, HW_VENDOR_DP,\r
- (UINT8) (sizeof(VENDOR_DEVICE_PATH)),\r
- (UINT8) ((sizeof(VENDOR_DEVICE_PATH)) >> 8),\r
+ HARDWARE_DEVICE_PATH, HW_VENDOR_DP,\r
+ {\r
+ (UINT8)(sizeof (VENDOR_DEVICE_PATH)),\r
+ (UINT8)((sizeof (VENDOR_DEVICE_PATH)) >> 8)\r
+ },\r
},\r
// Hardware Device Path for Lcd\r
EFI_CALLER_ID_GUID // Use the driver's GUID\r
{\r
END_DEVICE_PATH_TYPE,\r
END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
- sizeof(EFI_DEVICE_PATH_PROTOCOL),\r
- 0\r
+ {\r
+ sizeof (EFI_DEVICE_PATH_PROTOCOL),\r
+ 0\r
+ }\r
}\r
},\r
- (EFI_EVENT) NULL // ExitBootServicesEvent\r
+ (EFI_EVENT)NULL // ExitBootServicesEvent\r
};\r
\r
EFI_STATUS\r
LcdInstanceContructor (\r
- OUT LCD_INSTANCE** NewInstance\r
+ OUT LCD_INSTANCE **NewInstance\r
)\r
{\r
- LCD_INSTANCE* Instance;\r
+ LCD_INSTANCE *Instance;\r
\r
- Instance = AllocateCopyPool (sizeof(LCD_INSTANCE), &mLcdTemplate);\r
+ Instance = AllocateCopyPool (sizeof (LCD_INSTANCE), &mLcdTemplate);\r
if (Instance == NULL) {\r
return EFI_OUT_OF_RESOURCES;\r
}\r
\r
EFI_STATUS\r
InitializeDisplay (\r
- IN LCD_INSTANCE* Instance\r
+ IN LCD_INSTANCE *Instance\r
)\r
{\r
- EFI_STATUS Status = EFI_SUCCESS;\r
- EFI_PHYSICAL_ADDRESS VramBaseAddress;\r
- UINTN VramSize;\r
+ EFI_STATUS Status;\r
+ EFI_PHYSICAL_ADDRESS VramBaseAddress;\r
+ UINTN VramSize;\r
\r
Status = LcdPlatformGetVram (&VramBaseAddress, &VramSize);\r
- if (EFI_ERROR(Status)) {\r
+ if (EFI_ERROR (Status)) {\r
return Status;\r
}\r
\r
// Setup the LCD\r
Status = LcdInitialize (VramBaseAddress);\r
- if (EFI_ERROR(Status)) {\r
+ if (EFI_ERROR (Status)) {\r
goto EXIT_ERROR_LCD_SHUTDOWN;\r
}\r
\r
Status = LcdPlatformInitializeDisplay (Instance->Handle);\r
- if (EFI_ERROR(Status)) {\r
+ if (EFI_ERROR (Status)) {\r
goto EXIT_ERROR_LCD_SHUTDOWN;\r
}\r
\r
// Setup all the relevant mode information\r
- Instance->Gop.Mode->SizeOfInfo = sizeof(EFI_GRAPHICS_OUTPUT_MODE_INFORMATION);\r
+ Instance->Gop.Mode->SizeOfInfo = sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION);\r
Instance->Gop.Mode->FrameBufferBase = VramBaseAddress;\r
- Instance->Gop.Mode->FrameBufferSize = VramSize;\r
\r
// Set the flag before changing the mode, to avoid infinite loops\r
mDisplayInitialized = TRUE;\r
goto EXIT;\r
\r
EXIT_ERROR_LCD_SHUTDOWN:\r
- DEBUG((DEBUG_ERROR, "InitializeDisplay: ERROR - Can not initialise the display. Exit Status=%r\n", Status));\r
+ DEBUG ((DEBUG_ERROR, "InitializeDisplay: ERROR - Can not initialise the display. Exit Status=%r\n", Status));\r
+\r
LcdShutdown ();\r
\r
EXIT:\r
EFI_STATUS\r
EFIAPI\r
LcdGraphicsOutputDxeInitialize (\r
- IN EFI_HANDLE ImageHandle,\r
- IN EFI_SYSTEM_TABLE *SystemTable\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
)\r
{\r
- EFI_STATUS Status = EFI_SUCCESS;\r
- LCD_INSTANCE* Instance;\r
+ EFI_STATUS Status;\r
+ LCD_INSTANCE *Instance;\r
+\r
+ Status = LcdIdentify ();\r
+ if (EFI_ERROR (Status)) {\r
+ goto EXIT;\r
+ }\r
\r
Status = LcdInstanceContructor (&Instance);\r
- if (EFI_ERROR(Status)) {\r
+ if (EFI_ERROR (Status)) {\r
goto EXIT;\r
}\r
\r
- // Install the Graphics Output Protocol and the Device Path\r
- Status = gBS->InstallMultipleProtocolInterfaces(\r
- &Instance->Handle,\r
- &gEfiGraphicsOutputProtocolGuid, &Instance->Gop,\r
- &gEfiDevicePathProtocolGuid, &Instance->DevicePath,\r
- NULL\r
- );\r
-\r
- if (EFI_ERROR(Status)) {\r
- DEBUG((DEBUG_ERROR, "GraphicsOutputDxeInitialize: Can not install the protocol. Exit Status=%r\n", Status));\r
- goto EXIT;\r
- }\r
-\r
- // Register for an ExitBootServicesEvent\r
- // When ExitBootServices starts, this function here will make sure that the graphics driver will shut down properly,\r
- // i.e. it will free up all allocated memory and perform any necessary hardware re-configuration.\r
- Status = gBS->CreateEvent (\r
- EVT_SIGNAL_EXIT_BOOT_SERVICES,\r
- TPL_NOTIFY,\r
- LcdGraphicsExitBootServicesEvent, NULL,\r
- &Instance->ExitBootServicesEvent\r
- );\r
-\r
- if (EFI_ERROR(Status)) {\r
- DEBUG((DEBUG_ERROR, "GraphicsOutputDxeInitialize: Can not install the ExitBootServicesEvent handler. Exit Status=%r\n", Status));\r
- goto EXIT_ERROR_UNINSTALL_PROTOCOL;\r
- }\r
-\r
- // To get here, everything must be fine, so just exit\r
- goto EXIT;\r
+ // Install the Graphics Output Protocol and the Device Path\r
+ Status = gBS->InstallMultipleProtocolInterfaces (\r
+ &Instance->Handle,\r
+ &gEfiGraphicsOutputProtocolGuid,\r
+ &Instance->Gop,\r
+ &gEfiDevicePathProtocolGuid,\r
+ &Instance->DevicePath,\r
+ NULL\r
+ );\r
+\r
+ if (EFI_ERROR (Status)) {\r
+ DEBUG ((DEBUG_ERROR, "LcdGraphicsOutputDxeInitialize: Can not install the protocol. Exit Status=%r\n", Status));\r
+ goto EXIT;\r
+ }\r
+\r
+ // Register for an ExitBootServicesEvent\r
+ // When ExitBootServices starts, this function will make sure that the\r
+ // graphics driver shuts down properly, i.e. it will free up all\r
+ // allocated memory and perform any necessary hardware re-configuration.\r
+ Status = gBS->CreateEvent (\r
+ EVT_SIGNAL_EXIT_BOOT_SERVICES,\r
+ TPL_NOTIFY,\r
+ LcdGraphicsExitBootServicesEvent,\r
+ NULL,\r
+ &Instance->ExitBootServicesEvent\r
+ );\r
+\r
+ if (EFI_ERROR (Status)) {\r
+ DEBUG ((DEBUG_ERROR, "LcdGraphicsOutputDxeInitialize: Can not install the ExitBootServicesEvent handler. Exit Status=%r\n", Status));\r
+ goto EXIT_ERROR_UNINSTALL_PROTOCOL;\r
+ }\r
+\r
+ // To get here, everything must be fine, so just exit\r
+ goto EXIT;\r
\r
EXIT_ERROR_UNINSTALL_PROTOCOL:\r
- /* The following function could return an error message,\r
- * however, to get here something must have gone wrong already,\r
- * so preserve the original error, i.e. don't change\r
- * the Status variable, even it fails to uninstall the protocol.\r
- */\r
- gBS->UninstallMultipleProtocolInterfaces (\r
- Instance->Handle,\r
- &gEfiGraphicsOutputProtocolGuid, &Instance->Gop, // Uninstall Graphics Output protocol\r
- &gEfiDevicePathProtocolGuid, &Instance->DevicePath, // Uninstall device path\r
- NULL\r
- );\r
+ // The following function could return an error message,\r
+ // however, to get here something must have gone wrong already,\r
+ // so preserve the original error, i.e. don't change\r
+ // the Status variable, even it fails to uninstall the protocol.\r
+ gBS->UninstallMultipleProtocolInterfaces (\r
+ Instance->Handle,\r
+ &gEfiGraphicsOutputProtocolGuid,\r
+ &Instance->Gop, // Uninstall Graphics Output protocol\r
+ &gEfiDevicePathProtocolGuid,\r
+ &Instance->DevicePath, // Uninstall device path\r
+ NULL\r
+ );\r
\r
EXIT:\r
- return Status;\r
-\r
+ return Status;\r
}\r
\r
-/***************************************\r
- * This function should be called\r
- * on Event: ExitBootServices\r
- * to free up memory, stop the driver\r
- * and uninstall the protocols\r
- ***************************************/\r
+/** This function should be called\r
+ on Event: ExitBootServices\r
+ to free up memory, stop the driver\r
+ and uninstall the protocols\r
+**/\r
VOID\r
LcdGraphicsExitBootServicesEvent (\r
IN EFI_EVENT Event,\r
IN VOID *Context\r
)\r
{\r
- // By default, this PCD is FALSE. But if a platform starts a predefined OS that\r
- // does not use a framebuffer then we might want to disable the display controller\r
- // to avoid to display corrupted information on the screen.\r
+ // By default, this PCD is FALSE. But if a platform starts a predefined OS\r
+ // that does not use a framebuffer then we might want to disable the display\r
+ // controller to avoid to display corrupted information on the screen.\r
if (FeaturePcdGet (PcdGopDisableOnExitBootServices)) {\r
// Turn-off the Display controller\r
LcdShutdown ();\r
}\r
}\r
\r
-/***************************************\r
- * GraphicsOutput Protocol function, mapping to\r
- * EFI_GRAPHICS_OUTPUT_PROTOCOL.QueryMode\r
- ***************************************/\r
+/** GraphicsOutput Protocol function, mapping to\r
+ EFI_GRAPHICS_OUTPUT_PROTOCOL.QueryMode\r
+**/\r
EFI_STATUS\r
EFIAPI\r
LcdGraphicsQueryMode (\r
- IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,\r
- IN UINT32 ModeNumber,\r
- OUT UINTN *SizeOfInfo,\r
- OUT EFI_GRAPHICS_OUTPUT_MODE_INFORMATION **Info\r
- )\r
+ IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,\r
+ IN UINT32 ModeNumber,\r
+ OUT UINTN *SizeOfInfo,\r
+ OUT EFI_GRAPHICS_OUTPUT_MODE_INFORMATION **Info\r
+ )\r
{\r
- EFI_STATUS Status = EFI_SUCCESS;\r
- LCD_INSTANCE *Instance;\r
+ EFI_STATUS Status;\r
+ LCD_INSTANCE *Instance;\r
\r
- Instance = LCD_INSTANCE_FROM_GOP_THIS(This);\r
+ Instance = LCD_INSTANCE_FROM_GOP_THIS (This);\r
\r
// Setup the hardware if not already done\r
- if( !mDisplayInitialized ) {\r
- Status = InitializeDisplay(Instance);\r
- if (EFI_ERROR(Status)) {\r
+ if (!mDisplayInitialized) {\r
+ Status = InitializeDisplay (Instance);\r
+ if (EFI_ERROR (Status)) {\r
goto EXIT;\r
}\r
}\r
\r
- // Error checking\r
- if ( (This == NULL) || (Info == NULL) || (SizeOfInfo == NULL) || (ModeNumber >= This->Mode->MaxMode) ) {\r
- DEBUG((DEBUG_ERROR, "LcdGraphicsQueryMode: ERROR - For mode number %d : Invalid Parameter.\n", ModeNumber ));\r
- Status = EFI_INVALID_PARAMETER;\r
- goto EXIT;\r
- }\r
+ // Error checking\r
+ if ((This == NULL) ||\r
+ (Info == NULL) ||\r
+ (SizeOfInfo == NULL) ||\r
+ (ModeNumber >= This->Mode->MaxMode))\r
+ {\r
+ DEBUG ((DEBUG_ERROR, "LcdGraphicsQueryMode: ERROR - For mode number %d : Invalid Parameter.\n", ModeNumber));\r
+ Status = EFI_INVALID_PARAMETER;\r
+ goto EXIT;\r
+ }\r
\r
- *Info = AllocatePool (sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION));\r
+ *Info = AllocatePool (sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION));\r
if (*Info == NULL) {\r
Status = EFI_OUT_OF_RESOURCES;\r
goto EXIT;\r
}\r
\r
- *SizeOfInfo = sizeof( EFI_GRAPHICS_OUTPUT_MODE_INFORMATION);\r
+ *SizeOfInfo = sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION);\r
\r
- Status = LcdPlatformQueryMode (ModeNumber,*Info);\r
- if (EFI_ERROR(Status)) {\r
- FreePool(*Info);\r
+ Status = LcdPlatformQueryMode (ModeNumber, *Info);\r
+ if (EFI_ERROR (Status)) {\r
+ FreePool (*Info);\r
}\r
\r
EXIT:\r
- return Status;\r
+ return Status;\r
}\r
\r
-/***************************************\r
- * GraphicsOutput Protocol function, mapping to\r
- * EFI_GRAPHICS_OUTPUT_PROTOCOL.SetMode\r
- ***************************************/\r
+/** GraphicsOutput Protocol function, mapping to\r
+ EFI_GRAPHICS_OUTPUT_PROTOCOL.SetMode\r
+**/\r
EFI_STATUS\r
EFIAPI\r
LcdGraphicsSetMode (\r
- IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,\r
- IN UINT32 ModeNumber\r
- )\r
+ IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,\r
+ IN UINT32 ModeNumber\r
+ )\r
{\r
- EFI_STATUS Status = EFI_SUCCESS;\r
- EFI_GRAPHICS_OUTPUT_BLT_PIXEL FillColour;\r
- LCD_INSTANCE* Instance;\r
+ EFI_STATUS Status;\r
+ EFI_GRAPHICS_OUTPUT_BLT_PIXEL FillColour;\r
+ LCD_INSTANCE *Instance;\r
+ LCD_BPP Bpp;\r
\r
- Instance = LCD_INSTANCE_FROM_GOP_THIS (This);\r
+ Instance = LCD_INSTANCE_FROM_GOP_THIS (This);\r
\r
// Setup the hardware if not already done\r
- if(!mDisplayInitialized) {\r
+ if (!mDisplayInitialized) {\r
Status = InitializeDisplay (Instance);\r
- if (EFI_ERROR(Status)) {\r
+ if (EFI_ERROR (Status)) {\r
goto EXIT;\r
}\r
}\r
\r
// Check if this mode is supported\r
- if( ModeNumber >= This->Mode->MaxMode ) {\r
- DEBUG((DEBUG_ERROR, "LcdGraphicsSetMode: ERROR - Unsupported mode number %d .\n", ModeNumber ));\r
+ if (ModeNumber >= This->Mode->MaxMode) {\r
+ DEBUG ((DEBUG_ERROR, "LcdGraphicsSetMode: ERROR - Unsupported mode number %d .\n", ModeNumber));\r
Status = EFI_UNSUPPORTED;\r
goto EXIT;\r
}\r
\r
- // Set the oscillator frequency to support the new mode\r
+ // Set the oscillator frequency to support the new mode\r
Status = LcdPlatformSetMode (ModeNumber);\r
- if (EFI_ERROR(Status)) {\r
+ if (EFI_ERROR (Status)) {\r
Status = EFI_DEVICE_ERROR;\r
goto EXIT;\r
}\r
\r
- // Update the UEFI mode information\r
- This->Mode->Mode = ModeNumber;\r
- LcdPlatformQueryMode (ModeNumber,&Instance->ModeInfo);\r
+ // Update the UEFI mode information\r
+ This->Mode->Mode = ModeNumber;\r
+ LcdPlatformQueryMode (ModeNumber, &Instance->ModeInfo);\r
+ Status = LcdPlatformGetBpp (ModeNumber, &Bpp);\r
+ if (EFI_ERROR (Status)) {\r
+ DEBUG ((DEBUG_ERROR, "LcdGraphicsSetMode: ERROR - Couldn't get bytes per pixel, status: %r\n", Status));\r
+ goto EXIT;\r
+ }\r
+\r
+ This->Mode->FrameBufferSize = Instance->ModeInfo.VerticalResolution\r
+ * Instance->ModeInfo.PixelsPerScanLine\r
+ * GetBytesPerPixel (Bpp);\r
\r
// Set the hardware to the new mode\r
- Status = LcdSetMode (ModeNumber);\r
- if (EFI_ERROR(Status)) {\r
+ Status = LcdSetMode (ModeNumber);\r
+ if (EFI_ERROR (Status)) {\r
Status = EFI_DEVICE_ERROR;\r
goto EXIT;\r
}\r
\r
- // The UEFI spec requires that we now clear the visible portions of the output display to black.\r
+ // The UEFI spec requires that we now clear the visible portions of the\r
+ // output display to black.\r
\r
// Set the fill colour to black\r
SetMem (&FillColour, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL), 0x0);\r
\r
// Fill the entire visible area with the same colour.\r
Status = This->Blt (\r
- This,\r
- &FillColour,\r
- EfiBltVideoFill,\r
- 0,\r
- 0,\r
- 0,\r
- 0,\r
- This->Mode->Info->HorizontalResolution,\r
- This->Mode->Info->VerticalResolution,\r
- 0);\r
+ This,\r
+ &FillColour,\r
+ EfiBltVideoFill,\r
+ 0,\r
+ 0,\r
+ 0,\r
+ 0,\r
+ This->Mode->Info->HorizontalResolution,\r
+ This->Mode->Info->VerticalResolution,\r
+ 0\r
+ );\r
\r
EXIT:\r
- return Status;\r
+ return Status;\r
}\r
\r
UINTN\r
GetBytesPerPixel (\r
- IN LCD_BPP Bpp\r
+ IN LCD_BPP Bpp\r
)\r
{\r
- switch(Bpp) {\r
- case LCD_BITS_PER_PIXEL_24:\r
- return 4;\r
-\r
- case LCD_BITS_PER_PIXEL_16_565:\r
- case LCD_BITS_PER_PIXEL_16_555:\r
- case LCD_BITS_PER_PIXEL_12_444:\r
- return 2;\r
-\r
- case LCD_BITS_PER_PIXEL_8:\r
- case LCD_BITS_PER_PIXEL_4:\r
- case LCD_BITS_PER_PIXEL_2:\r
- case LCD_BITS_PER_PIXEL_1:\r
- return 1;\r
-\r
- default:\r
- return 0;\r
+ switch (Bpp) {\r
+ case LcdBitsPerPixel_24:\r
+ return 4;\r
+\r
+ case LcdBitsPerPixel_16_565:\r
+ case LcdBitsPerPixel_16_555:\r
+ case LcdBitsPerPixel_12_444:\r
+ return 2;\r
+\r
+ case LcdBitsPerPixel_8:\r
+ case LcdBitsPerPixel_4:\r
+ case LcdBitsPerPixel_2:\r
+ case LcdBitsPerPixel_1:\r
+ return 1;\r
+\r
+ default:\r
+ return 0;\r
}\r
}\r
projects / mirror_edk2.git / blobdiff