[mirror_edk2.git] / MdeModulePkg / Universal / Acpi / BootGraphicsResourceTableDxe / BootGraphicsResourceTableDxe.c

/** @file\r
  This module install ACPI Boot Graphics Resource Table (BGRT).\r
\r
  Copyright (c) 2011, Intel Corporation. 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
\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
#include <Uefi.h>\r
\r
#include <IndustryStandard/Acpi50.h>\r
#include <IndustryStandard/Bmp.h>\r
\r
#include <Protocol/AcpiTable.h>\r
#include <Protocol/GraphicsOutput.h>\r
#include <Protocol/BootLogo.h>\r
\r
#include <Guid/EventGroup.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/DebugLib.h>\r
\r
//\r
// ACPI table information used to initialize tables.\r
//\r
#define EFI_ACPI_OEM_ID           "INTEL"\r
#define EFI_ACPI_OEM_TABLE_ID     0x2020204F4E414954ULL // "TIANO   "\r
#define EFI_ACPI_OEM_REVISION     0x00000001\r
#define EFI_ACPI_CREATOR_ID       0x5446534D            // TBD "MSFT"\r
#define EFI_ACPI_CREATOR_REVISION 0x01000013            // TBD\r
\r
//\r
// Module globals.\r
//\r
EFI_EVENT  mBootGraphicsReadyToBootEvent;\r
UINTN      mBootGraphicsResourceTableKey = 0;\r
\r
EFI_HANDLE                     mBootLogoHandle = NULL;\r
BOOLEAN                        mIsLogoValid = FALSE;\r
EFI_GRAPHICS_OUTPUT_BLT_PIXEL  *mLogoBltBuffer = NULL;\r
UINTN                          mLogoDestX = 0;\r
UINTN                          mLogoDestY = 0;\r
UINTN                          mLogoWidth = 0;\r
UINTN                          mLogoHeight = 0;\r
\r
BMP_IMAGE_HEADER  mBmpImageHeaderTemplate = {\r
  'B',    // CharB\r
  'M',    // CharM\r
  0,      // Size will be updated at runtime\r
  {0, 0}, // Reserved\r
  sizeof (BMP_IMAGE_HEADER), // ImageOffset\r
  sizeof (BMP_IMAGE_HEADER) - OFFSET_OF (BMP_IMAGE_HEADER, HeaderSize), // HeaderSize\r
  0,      // PixelWidth will be updated at runtime\r
  0,      // PixelHeight will be updated at runtime\r
  1,      // Planes\r
  24,     // BitPerPixel\r
  0,      // CompressionType\r
  0,      // ImageSize will be updated at runtime\r
  0,      // XPixelsPerMeter\r
  0,      // YPixelsPerMeter\r
  0,      // NumberOfColors\r
  0       // ImportantColors\r
};\r
\r
BOOLEAN  mAcpiBgrtInstalled = FALSE;\r
\r
EFI_ACPI_5_0_BOOT_GRAPHICS_RESOURCE_TABLE mBootGraphicsResourceTableTemplate = {\r
  {\r
    EFI_ACPI_5_0_BOOT_GRAPHICS_RESOURCE_TABLE_SIGNATURE,\r
    sizeof (EFI_ACPI_5_0_BOOT_GRAPHICS_RESOURCE_TABLE),\r
    EFI_ACPI_5_0_BOOT_GRAPHICS_RESOURCE_TABLE_REVISION,     // Revision\r
    0x00,  // Checksum will be updated at runtime\r
    //\r
    // It is expected that these values will be updated at runtime.\r
    //\r
    EFI_ACPI_OEM_ID,            // OEMID is a 6 bytes long field\r
    EFI_ACPI_OEM_TABLE_ID,      // OEM table identification(8 bytes long)\r
    EFI_ACPI_OEM_REVISION,      // OEM revision number\r
    EFI_ACPI_CREATOR_ID,        // ASL compiler vendor ID\r
    EFI_ACPI_CREATOR_REVISION,  // ASL compiler revision number\r
  },\r
  EFI_ACPI_5_0_BGRT_VERSION,         // Version\r
  EFI_ACPI_5_0_BGRT_STATUS_VALID,    // Status\r
  EFI_ACPI_5_0_BGRT_IMAGE_TYPE_BMP,  // Image Type\r
  0,                                 // Image Address\r
  0,                                 // Image Offset X\r
  0                                  // Image Offset Y\r
};\r
\r
/**\r
  Update information of logo image drawn on screen.\r
\r
  @param  This           The pointer to the Boot Logo protocol instance.\r
  @param  BltBuffer      The BLT buffer for logo drawn on screen. If BltBuffer\r
                         is set to NULL, it indicates that logo image is no\r
                         longer on the screen.\r
  @param  DestinationX   X coordinate of destination for the BltBuffer.\r
  @param  DestinationY   Y coordinate of destination for the BltBuffer.\r
  @param  Width          Width of rectangle in BltBuffer in pixels.\r
  @param  Height         Hight of rectangle in BltBuffer in pixels.\r
\r
  @retval EFI_SUCCESS             The boot logo information was updated.\r
  @retval EFI_INVALID_PARAMETER   One of the parameters has an invalid value.\r
  @retval EFI_OUT_OF_RESOURCES    The logo information was not updated due to\r
                                  insufficient memory resources.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SetBootLogo (\r
  IN EFI_BOOT_LOGO_PROTOCOL            *This,\r
  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL     *BltBuffer       OPTIONAL,\r
  IN UINTN                             DestinationX,\r
  IN UINTN                             DestinationY,\r
  IN UINTN                             Width,\r
  IN UINTN                             Height\r
  );\r
\r
EFI_BOOT_LOGO_PROTOCOL  mBootLogoProtocolTemplate = { SetBootLogo };\r
\r
/**\r
  Update information of logo image drawn on screen.\r
\r
  @param  This           The pointer to the Boot Logo protocol instance.\r
  @param  BltBuffer      The BLT buffer for logo drawn on screen. If BltBuffer\r
                         is set to NULL, it indicates that logo image is no\r
                         longer on the screen.\r
  @param  DestinationX   X coordinate of destination for the BltBuffer.\r
  @param  DestinationY   Y coordinate of destination for the BltBuffer.\r
  @param  Width          Width of rectangle in BltBuffer in pixels.\r
  @param  Height         Hight of rectangle in BltBuffer in pixels.\r
\r
  @retval EFI_SUCCESS             The boot logo information was updated.\r
  @retval EFI_INVALID_PARAMETER   One of the parameters has an invalid value.\r
  @retval EFI_OUT_OF_RESOURCES    The logo information was not updated due to\r
                                  insufficient memory resources.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SetBootLogo (\r
  IN EFI_BOOT_LOGO_PROTOCOL            *This,\r
  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL     *BltBuffer       OPTIONAL,\r
  IN UINTN                             DestinationX,\r
  IN UINTN                             DestinationY,\r
  IN UINTN                             Width,\r
  IN UINTN                             Height\r
  )\r
{\r
  if (BltBuffer == NULL) {\r
    mIsLogoValid = FALSE;\r
    return EFI_SUCCESS;\r
  }\r
\r
  if (Width == 0 || Height == 0) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (mLogoBltBuffer != NULL) {\r
    FreePool (mLogoBltBuffer);\r
  }\r
\r
  mLogoBltBuffer = AllocateCopyPool (\r
                     Width * Height * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL),\r
                     BltBuffer\r
                     );\r
  if (mLogoBltBuffer == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  mLogoDestX = DestinationX;\r
  mLogoDestY = DestinationY;\r
  mLogoWidth = Width;\r
  mLogoHeight = Height;\r
  mIsLogoValid = TRUE;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This function calculates and updates an UINT8 checksum.\r
\r
  @param[in]  Buffer          Pointer to buffer to checksum.\r
  @param[in]  Size            Number of bytes to checksum.\r
\r
**/\r
VOID\r
BgrtAcpiTableChecksum (\r
  IN UINT8      *Buffer,\r
  IN UINTN      Size\r
  )\r
{\r
  UINTN ChecksumOffset;\r
\r
  ChecksumOffset = OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER, Checksum);\r
\r
  //\r
  // Set checksum to 0 first.\r
  //\r
  Buffer[ChecksumOffset] = 0;\r
\r
  //\r
  // Update checksum value.\r
  //\r
  Buffer[ChecksumOffset] = CalculateCheckSum8 (Buffer, Size);\r
}\r
\r
/**\r
  Allocate EfiReservedMemoryType below 4G memory address.\r
\r
  This function allocates EfiReservedMemoryType below 4G memory address.\r
\r
  @param[in]  Size   Size of memory to allocate.\r
\r
  @return Allocated address for output.\r
\r
**/\r
VOID *\r
BgrtAllocateReservedMemoryBelow4G (\r
  IN UINTN       Size\r
  )\r
{\r
  UINTN                 Pages;\r
  EFI_PHYSICAL_ADDRESS  Address;\r
  EFI_STATUS            Status;\r
  VOID                  *Buffer;\r
\r
  Pages   = EFI_SIZE_TO_PAGES (Size);\r
  Address = 0xffffffff;\r
\r
  Status = gBS->AllocatePages (\r
                  AllocateMaxAddress,\r
                  EfiReservedMemoryType,\r
                  Pages,\r
                  &Address\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Buffer = (VOID *) (UINTN) Address;\r
  ZeroMem (Buffer, Size);\r
\r
  return Buffer;\r
}\r
\r
/**\r
  Install Boot Graphics Resource Table to ACPI table.\r
\r
  @return Status code.\r
\r
**/\r
EFI_STATUS\r
InstallBootGraphicsResourceTable (\r
  VOID\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  EFI_ACPI_TABLE_PROTOCOL       *AcpiTableProtocol;\r
  UINT8                         *ImageBuffer;\r
  UINTN                         PaddingSize;\r
  UINTN                         BmpSize;\r
  UINT8                         *Image;\r
  EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltPixel;\r
  UINTN                         Col;\r
  UINTN                         Row;\r
\r
  //\r
  // Check whether Boot Graphics Resource Table is already installed.\r
  //\r
  if (mAcpiBgrtInstalled) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // Get ACPI Table protocol.\r
  //\r
  Status = gBS->LocateProtocol (&gEfiAcpiTableProtocolGuid, NULL, (VOID **) &AcpiTableProtocol);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Check whether Logo exist.\r
  //\r
  if (mLogoBltBuffer == NULL) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  //\r
  // Allocate memory for BMP file.\r
  //\r
  PaddingSize = mLogoWidth & 0x3;\r
  BmpSize = (mLogoWidth * 3 + PaddingSize) * mLogoHeight + sizeof (BMP_IMAGE_HEADER);\r
  ImageBuffer = BgrtAllocateReservedMemoryBelow4G (BmpSize);\r
  if (ImageBuffer == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  mBmpImageHeaderTemplate.Size = (UINT32) BmpSize;\r
  mBmpImageHeaderTemplate.ImageSize = (UINT32) BmpSize - sizeof (BMP_IMAGE_HEADER);\r
  mBmpImageHeaderTemplate.PixelWidth = (UINT32) mLogoWidth;\r
  mBmpImageHeaderTemplate.PixelHeight = (UINT32) mLogoHeight;\r
  CopyMem (ImageBuffer, &mBmpImageHeaderTemplate, sizeof (BMP_IMAGE_HEADER));\r
\r
  //\r
  // Convert BLT buffer to BMP file.\r
  //\r
  Image = ImageBuffer + sizeof (BMP_IMAGE_HEADER);\r
  for (Row = 0; Row < mLogoHeight; Row++) {\r
    BltPixel = &mLogoBltBuffer[(mLogoHeight - Row - 1) * mLogoWidth];\r
\r
    for (Col = 0; Col < mLogoWidth; Col++) {\r
      *Image++ = BltPixel->Blue;\r
      *Image++ = BltPixel->Green;\r
      *Image++ = BltPixel->Red;\r
      BltPixel++;\r
    }\r
\r
    //\r
    // Padding for 4 byte alignment.\r
    //\r
    Image += PaddingSize;\r
  }\r
  FreePool (mLogoBltBuffer);\r
  mLogoBltBuffer = NULL;\r
\r
  mBootGraphicsResourceTableTemplate.Status = (UINT8) (mIsLogoValid ? EFI_ACPI_5_0_BGRT_STATUS_VALID : EFI_ACPI_5_0_BGRT_STATUS_INVALID);\r
  mBootGraphicsResourceTableTemplate.ImageAddress = (UINT64) (UINTN) ImageBuffer;\r
  mBootGraphicsResourceTableTemplate.ImageOffsetX = (UINT32) mLogoDestX;\r
  mBootGraphicsResourceTableTemplate.ImageOffsetY = (UINT32) mLogoDestY;\r
\r
  //\r
  // Update Checksum.\r
  //\r
  BgrtAcpiTableChecksum ((UINT8 *) &mBootGraphicsResourceTableTemplate, sizeof (EFI_ACPI_5_0_BOOT_GRAPHICS_RESOURCE_TABLE));\r
\r
  //\r
  // Publish Boot Graphics Resource Table.\r
  //\r
  Status = AcpiTableProtocol->InstallAcpiTable (\r
                                AcpiTableProtocol,\r
                                &mBootGraphicsResourceTableTemplate,\r
                                sizeof (EFI_ACPI_5_0_BOOT_GRAPHICS_RESOURCE_TABLE),\r
                                &mBootGraphicsResourceTableKey\r
                                );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  mAcpiBgrtInstalled = TRUE;\r
  return Status;\r
}\r
\r
/**\r
  Notify function for event group EFI_EVENT_GROUP_READY_TO_BOOT. This is used to\r
  install the Boot Graphics Resource Table.\r
\r
  @param[in]  Event   The Event that is being processed.\r
  @param[in]  Context The Event Context.\r
\r
**/\r
VOID\r
EFIAPI\r
BgrtReadyToBootEventNotify (\r
  IN EFI_EVENT        Event,\r
  IN VOID             *Context\r
  )\r
{\r
  InstallBootGraphicsResourceTable ();\r
}\r
\r
/**\r
  The module Entry Point of the Boot Graphics Resource Table DXE driver.\r
\r
  @param[in]  ImageHandle    The firmware allocated handle for the EFI image.\r
  @param[in]  SystemTable    A pointer to the EFI System Table.\r
\r
  @retval EFI_SUCCESS    The entry point is executed successfully.\r
  @retval Other          Some error occurs when executing this entry point.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BootGraphicsDxeEntryPoint (\r
  IN EFI_HANDLE          ImageHandle,\r
  IN EFI_SYSTEM_TABLE    *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Install Boot Logo protocol.\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &mBootLogoHandle,\r
                  &gEfiBootLogoProtocolGuid,\r
                  &mBootLogoProtocolTemplate,\r
                  NULL\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Register notify function to install BGRT on ReadyToBoot Event.\r
  //\r
  Status = gBS->CreateEventEx (\r
                  EVT_NOTIFY_SIGNAL,\r
                  TPL_CALLBACK,\r
                  BgrtReadyToBootEventNotify,\r
                  NULL,\r
                  &gEfiEventReadyToBootGuid,\r
                  &mBootGraphicsReadyToBootEvent\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return Status;\r
}\r
Commit	Line	Data
0284e90c LG	1	/** @file\r
	2	This module install ACPI Boot Graphics Resource Table (BGRT).\r
	3	\r
	4	Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>\r
	5	This program and the accompanying materials\r
	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	**/\r
	13	\r
	14	#include <Uefi.h>\r
	15	\r
	16	#include <IndustryStandard/Acpi50.h>\r
	17	#include <IndustryStandard/Bmp.h>\r
	18	\r
	19	#include <Protocol/AcpiTable.h>\r
	20	#include <Protocol/GraphicsOutput.h>\r
	21	#include <Protocol/BootLogo.h>\r
	22	\r
	23	#include <Guid/EventGroup.h>\r
	24	\r
	25	#include <Library/BaseLib.h>\r
	26	#include <Library/BaseMemoryLib.h>\r
	27	#include <Library/MemoryAllocationLib.h>\r
	28	#include <Library/UefiBootServicesTableLib.h>\r
	29	#include <Library/DebugLib.h>\r
	30	\r
	31	//\r
	32	// ACPI table information used to initialize tables.\r
	33	//\r
	34	#define EFI_ACPI_OEM_ID "INTEL"\r
	35	#define EFI_ACPI_OEM_TABLE_ID 0x2020204F4E414954ULL // "TIANO "\r
	36	#define EFI_ACPI_OEM_REVISION 0x00000001\r
	37	#define EFI_ACPI_CREATOR_ID 0x5446534D // TBD "MSFT"\r
	38	#define EFI_ACPI_CREATOR_REVISION 0x01000013 // TBD\r
	39	\r
	40	//\r
	41	// Module globals.\r
	42	//\r
	43	EFI_EVENT mBootGraphicsReadyToBootEvent;\r
	44	UINTN mBootGraphicsResourceTableKey = 0;\r
	45	\r
	46	EFI_HANDLE mBootLogoHandle = NULL;\r
	47	BOOLEAN mIsLogoValid = FALSE;\r
	48	EFI_GRAPHICS_OUTPUT_BLT_PIXEL *mLogoBltBuffer = NULL;\r
	49	UINTN mLogoDestX = 0;\r
	50	UINTN mLogoDestY = 0;\r
	51	UINTN mLogoWidth = 0;\r
	52	UINTN mLogoHeight = 0;\r
	53	\r
	54	BMP_IMAGE_HEADER mBmpImageHeaderTemplate = {\r
	55	'B', // CharB\r
	56	'M', // CharM\r
	57	0, // Size will be updated at runtime\r
	58	{0, 0}, // Reserved\r
	59	sizeof (BMP_IMAGE_HEADER), // ImageOffset\r
	60	sizeof (BMP_IMAGE_HEADER) - OFFSET_OF (BMP_IMAGE_HEADER, HeaderSize), // HeaderSize\r
	61	0, // PixelWidth will be updated at runtime\r
	62	0, // PixelHeight will be updated at runtime\r
	63	1, // Planes\r
	64	24, // BitPerPixel\r
65	0, // CompressionType\r
66	0, // ImageSize will be updated at runtime\r
67	0, // XPixelsPerMeter\r
68	0, // YPixelsPerMeter\r
69	0, // NumberOfColors\r
70	0 // ImportantColors\r
71	};\r
72	\r
73	BOOLEAN mAcpiBgrtInstalled = FALSE;\r
74	\r
75	EFI_ACPI_5_0_BOOT_GRAPHICS_RESOURCE_TABLE mBootGraphicsResourceTableTemplate = {\r
76	{\r
77	EFI_ACPI_5_0_BOOT_GRAPHICS_RESOURCE_TABLE_SIGNATURE,\r
78	sizeof (EFI_ACPI_5_0_BOOT_GRAPHICS_RESOURCE_TABLE),\r
79	EFI_ACPI_5_0_BOOT_GRAPHICS_RESOURCE_TABLE_REVISION, // Revision\r
80	0x00, // Checksum will be updated at runtime\r
81	//\r
82	// It is expected that these values will be updated at runtime.\r
83	//\r
84	EFI_ACPI_OEM_ID, // OEMID is a 6 bytes long field\r
85	EFI_ACPI_OEM_TABLE_ID, // OEM table identification(8 bytes long)\r
86	EFI_ACPI_OEM_REVISION, // OEM revision number\r
87	EFI_ACPI_CREATOR_ID, // ASL compiler vendor ID\r
88	EFI_ACPI_CREATOR_REVISION, // ASL compiler revision number\r
89	},\r
90	EFI_ACPI_5_0_BGRT_VERSION, // Version\r
91	EFI_ACPI_5_0_BGRT_STATUS_VALID, // Status\r
92	EFI_ACPI_5_0_BGRT_IMAGE_TYPE_BMP, // Image Type\r
93	0, // Image Address\r
94	0, // Image Offset X\r
95	0 // Image Offset Y\r
96	};\r
97	\r
98	/**\r
99	Update information of logo image drawn on screen.\r
100	\r
101	@param This The pointer to the Boot Logo protocol instance.\r
102	@param BltBuffer The BLT buffer for logo drawn on screen. If BltBuffer\r
103	is set to NULL, it indicates that logo image is no\r
104	longer on the screen.\r
105	@param DestinationX X coordinate of destination for the BltBuffer.\r
106	@param DestinationY Y coordinate of destination for the BltBuffer.\r
107	@param Width Width of rectangle in BltBuffer in pixels.\r
108	@param Height Hight of rectangle in BltBuffer in pixels.\r
109	\r
110	@retval EFI_SUCCESS The boot logo information was updated.\r
111	@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
112	@retval EFI_OUT_OF_RESOURCES The logo information was not updated due to\r
113	insufficient memory resources.\r
114	\r
115	**/\r
116	EFI_STATUS\r
117	EFIAPI\r
118	SetBootLogo (\r
119	IN EFI_BOOT_LOGO_PROTOCOL *This,\r
120	IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer OPTIONAL,\r
121	IN UINTN DestinationX,\r
122	IN UINTN DestinationY,\r
123	IN UINTN Width,\r
124	IN UINTN Height\r
125	);\r
126	\r
127	EFI_BOOT_LOGO_PROTOCOL mBootLogoProtocolTemplate = { SetBootLogo };\r
128	\r
129	/**\r
130	Update information of logo image drawn on screen.\r
131	\r
132	@param This The pointer to the Boot Logo protocol instance.\r
133	@param BltBuffer The BLT buffer for logo drawn on screen. If BltBuffer\r
134	is set to NULL, it indicates that logo image is no\r
135	longer on the screen.\r
136	@param DestinationX X coordinate of destination for the BltBuffer.\r
137	@param DestinationY Y coordinate of destination for the BltBuffer.\r
138	@param Width Width of rectangle in BltBuffer in pixels.\r
139	@param Height Hight of rectangle in BltBuffer in pixels.\r
140	\r
141	@retval EFI_SUCCESS The boot logo information was updated.\r
142	@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
143	@retval EFI_OUT_OF_RESOURCES The logo information was not updated due to\r
144	insufficient memory resources.\r
145	\r
146	**/\r
147	EFI_STATUS\r
148	EFIAPI\r
149	SetBootLogo (\r
150	IN EFI_BOOT_LOGO_PROTOCOL *This,\r
151	IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer OPTIONAL,\r
152	IN UINTN DestinationX,\r
153	IN UINTN DestinationY,\r
154	IN UINTN Width,\r
155	IN UINTN Height\r
156	)\r
157	{\r
158	if (BltBuffer == NULL) {\r
159	mIsLogoValid = FALSE;\r
160	return EFI_SUCCESS;\r
161	}\r
162	\r
163	if (Width == 0 \|\| Height == 0) {\r
164	return EFI_INVALID_PARAMETER;\r
165	}\r
166	\r
167	if (mLogoBltBuffer != NULL) {\r
168	FreePool (mLogoBltBuffer);\r
169	}\r
170	\r
171	mLogoBltBuffer = AllocateCopyPool (\r
172	Width * Height * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL),\r
173	BltBuffer\r
174	);\r
175	if (mLogoBltBuffer == NULL) {\r
176	return EFI_OUT_OF_RESOURCES;\r
177	}\r
178	mLogoDestX = DestinationX;\r
179	mLogoDestY = DestinationY;\r
180	mLogoWidth = Width;\r
181	mLogoHeight = Height;\r
182	mIsLogoValid = TRUE;\r
183	\r
184	return EFI_SUCCESS;\r
185	}\r
186	\r
187	/**\r
188	This function calculates and updates an UINT8 checksum.\r
189	\r
190	@param[in] Buffer Pointer to buffer to checksum.\r
191	@param[in] Size Number of bytes to checksum.\r
192	\r
193	**/\r
194	VOID\r
195	BgrtAcpiTableChecksum (\r
196	IN UINT8 *Buffer,\r
197	IN UINTN Size\r
198	)\r
199	{\r
200	UINTN ChecksumOffset;\r
201	\r
202	ChecksumOffset = OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER, Checksum);\r
203	\r
204	//\r
205	// Set checksum to 0 first.\r
206	//\r
207	Buffer[ChecksumOffset] = 0;\r
208	\r
209	//\r
210	// Update checksum value.\r
211	//\r
212	Buffer[ChecksumOffset] = CalculateCheckSum8 (Buffer, Size);\r
213	}\r
214	\r
215	/**\r
216	Allocate EfiReservedMemoryType below 4G memory address.\r
217	\r
218	This function allocates EfiReservedMemoryType below 4G memory address.\r
219	\r
220	@param[in] Size Size of memory to allocate.\r
221	\r
222	@return Allocated address for output.\r
223	\r
224	**/\r
225	VOID *\r
226	BgrtAllocateReservedMemoryBelow4G (\r
227	IN UINTN Size\r
228	)\r
229	{\r
230	UINTN Pages;\r
231	EFI_PHYSICAL_ADDRESS Address;\r
232	EFI_STATUS Status;\r
233	VOID *Buffer;\r
234	\r
235	Pages = EFI_SIZE_TO_PAGES (Size);\r
236	Address = 0xffffffff;\r
237	\r
238	Status = gBS->AllocatePages (\r
239	AllocateMaxAddress,\r
240	EfiReservedMemoryType,\r
241	Pages,\r
242	&Address\r
243	);\r
244	ASSERT_EFI_ERROR (Status);\r
245	\r
246	Buffer = (VOID *) (UINTN) Address;\r
247	ZeroMem (Buffer, Size);\r
248	\r
249	return Buffer;\r
250	}\r
251	\r
252	/**\r
253	Install Boot Graphics Resource Table to ACPI table.\r
254	\r
255	@return Status code.\r
256	\r
257	**/\r
258	EFI_STATUS\r
259	InstallBootGraphicsResourceTable (\r
260	VOID\r
261	)\r
262	{\r
263	EFI_STATUS Status;\r
264	EFI_ACPI_TABLE_PROTOCOL *AcpiTableProtocol;\r
265	UINT8 *ImageBuffer;\r
266	UINTN PaddingSize;\r
267	UINTN BmpSize;\r
268	UINT8 *Image;\r
269	EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltPixel;\r
270	UINTN Col;\r
271	UINTN Row;\r
272	\r
273	//\r
274	// Check whether Boot Graphics Resource Table is already installed.\r
275	//\r
276	if (mAcpiBgrtInstalled) {\r
277	return EFI_SUCCESS;\r
278	}\r
279	\r
280	//\r
281	// Get ACPI Table protocol.\r
282	//\r
283	Status = gBS->LocateProtocol (&gEfiAcpiTableProtocolGuid, NULL, (VOID **) &AcpiTableProtocol);\r
284	if (EFI_ERROR (Status)) {\r
285	return Status;\r
286	}\r
287	\r
288	//\r
289	// Check whether Logo exist.\r
290	//\r
291	if (mLogoBltBuffer == NULL) {\r
292	return EFI_NOT_FOUND;\r
293	}\r
294	\r
295	//\r
296	// Allocate memory for BMP file.\r
297	//\r
298	PaddingSize = mLogoWidth & 0x3;\r
299	BmpSize = (mLogoWidth * 3 + PaddingSize) * mLogoHeight + sizeof (BMP_IMAGE_HEADER);\r
300	ImageBuffer = BgrtAllocateReservedMemoryBelow4G (BmpSize);\r
301	if (ImageBuffer == NULL) {\r
302	return EFI_OUT_OF_RESOURCES;\r
303	}\r
304	\r
305	mBmpImageHeaderTemplate.Size = (UINT32) BmpSize;\r
306	mBmpImageHeaderTemplate.ImageSize = (UINT32) BmpSize - sizeof (BMP_IMAGE_HEADER);\r
307	mBmpImageHeaderTemplate.PixelWidth = (UINT32) mLogoWidth;\r
308	mBmpImageHeaderTemplate.PixelHeight = (UINT32) mLogoHeight;\r
309	CopyMem (ImageBuffer, &mBmpImageHeaderTemplate, sizeof (BMP_IMAGE_HEADER));\r
310	\r
311	//\r
312	// Convert BLT buffer to BMP file.\r
313	//\r
314	Image = ImageBuffer + sizeof (BMP_IMAGE_HEADER);\r
315	for (Row = 0; Row < mLogoHeight; Row++) {\r
316	BltPixel = &mLogoBltBuffer[(mLogoHeight - Row - 1) * mLogoWidth];\r
317	\r
318	for (Col = 0; Col < mLogoWidth; Col++) {\r
319	*Image++ = BltPixel->Blue;\r
320	*Image++ = BltPixel->Green;\r
321	*Image++ = BltPixel->Red;\r
322	BltPixel++;\r
323	}\r
324	\r
325	//\r
326	// Padding for 4 byte alignment.\r
327	//\r
328	Image += PaddingSize;\r
329	}\r
330	FreePool (mLogoBltBuffer);\r
331	mLogoBltBuffer = NULL;\r
332	\r
333	mBootGraphicsResourceTableTemplate.Status = (UINT8) (mIsLogoValid ? EFI_ACPI_5_0_BGRT_STATUS_VALID : EFI_ACPI_5_0_BGRT_STATUS_INVALID);\r
334	mBootGraphicsResourceTableTemplate.ImageAddress = (UINT64) (UINTN) ImageBuffer;\r
335	mBootGraphicsResourceTableTemplate.ImageOffsetX = (UINT32) mLogoDestX;\r
336	mBootGraphicsResourceTableTemplate.ImageOffsetY = (UINT32) mLogoDestY;\r
337	\r
338	//\r
339	// Update Checksum.\r
340	//\r
341	BgrtAcpiTableChecksum ((UINT8 *) &mBootGraphicsResourceTableTemplate, sizeof (EFI_ACPI_5_0_BOOT_GRAPHICS_RESOURCE_TABLE));\r
342	\r
343	//\r
344	// Publish Boot Graphics Resource Table.\r
345	//\r
346	Status = AcpiTableProtocol->InstallAcpiTable (\r
347	AcpiTableProtocol,\r
348	&mBootGraphicsResourceTableTemplate,\r
349	sizeof (EFI_ACPI_5_0_BOOT_GRAPHICS_RESOURCE_TABLE),\r
350	&mBootGraphicsResourceTableKey\r
351	);\r
352	if (EFI_ERROR (Status)) {\r
353	return Status;\r
354	}\r
355	\r
356	mAcpiBgrtInstalled = TRUE;\r
357	return Status;\r
358	}\r
359	\r
360	/**\r
361	Notify function for event group EFI_EVENT_GROUP_READY_TO_BOOT. This is used to\r
362	install the Boot Graphics Resource Table.\r
363	\r
364	@param[in] Event The Event that is being processed.\r
365	@param[in] Context The Event Context.\r
366	\r
367	**/\r
368	VOID\r
369	EFIAPI\r
370	BgrtReadyToBootEventNotify (\r
371	IN EFI_EVENT Event,\r
372	IN VOID *Context\r
373	)\r
374	{\r
375	InstallBootGraphicsResourceTable ();\r
376	}\r
377	\r
378	/**\r
379	The module Entry Point of the Boot Graphics Resource Table DXE driver.\r
380	\r
381	@param[in] ImageHandle The firmware allocated handle for the EFI image.\r
382	@param[in] SystemTable A pointer to the EFI System Table.\r
383	\r
384	@retval EFI_SUCCESS The entry point is executed successfully.\r
385	@retval Other Some error occurs when executing this entry point.\r
386	\r
387	**/\r
388	EFI_STATUS\r
389	EFIAPI\r
390	BootGraphicsDxeEntryPoint (\r
391	IN EFI_HANDLE ImageHandle,\r
392	IN EFI_SYSTEM_TABLE *SystemTable\r
393	)\r
394	{\r
395	EFI_STATUS Status;\r
396	\r
397	//\r
398	// Install Boot Logo protocol.\r
399	//\r
400	Status = gBS->InstallMultipleProtocolInterfaces (\r
401	&mBootLogoHandle,\r
402	&gEfiBootLogoProtocolGuid,\r
403	&mBootLogoProtocolTemplate,\r
404	NULL\r
405	);\r
406	ASSERT_EFI_ERROR (Status);\r
407	\r
408	//\r
409	// Register notify function to install BGRT on ReadyToBoot Event.\r
410	//\r
411	Status = gBS->CreateEventEx (\r
412	EVT_NOTIFY_SIGNAL,\r
413	TPL_CALLBACK,\r
414	BgrtReadyToBootEventNotify,\r
415	NULL,\r
416	&gEfiEventReadyToBootGuid,\r
417	&mBootGraphicsReadyToBootEvent\r
418	);\r
419	ASSERT_EFI_ERROR (Status);\r
420	\r
421	return Status;\r
422	}\r