#include <Uefi.h>
#include <IndustryStandard/Acpi.h>
#include <Protocol/AcpiTable.h>
#include <Protocol/GraphicsOutput.h>
#include <Protocol/BootLogo.h>
#include <Protocol/BootLogo2.h>
#include <Guid/EventGroup.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/DebugLib.h>
#include <Library/PcdLib.h>
#include <Library/SafeIntLib.h>
#include <Library/BmpSupportLib.h>

Functions
EFI_STATUS EFIAPI	SetBootLogo (IN EFI_BOOT_LOGO_PROTOCOL This, IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL BltBuffer OPTIONAL, IN UINTN DestinationX, IN UINTN DestinationY, IN UINTN Width, IN UINTN Height)

EFI_STATUS EFIAPI	SetBootLogo2 (IN EDKII_BOOT_LOGO2_PROTOCOL This, IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL BltBuffer OPTIONAL, IN UINTN DestinationX, IN UINTN DestinationY, IN UINTN Width, IN UINTN Height)

EFI_STATUS EFIAPI	GetBootLogo2 (IN EDKII_BOOT_LOGO2_PROTOCOL This, OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL BltBuffer, OUT UINTN DestinationX, OUT UINTN DestinationY, OUT UINTN Width, OUT UINTN *Height)

VOID EFIAPI	BgrtReadyToBootEventNotify (IN EFI_EVENT Event, IN VOID *Context)

EFI_STATUS EFIAPI	BootGraphicsDxeEntryPoint (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables
EFI_HANDLE	mBootLogoHandle = NULL

EFI_BOOT_LOGO_PROTOCOL	mBootLogoProtocolTemplate

EDKII_BOOT_LOGO2_PROTOCOL	mBootLogo2ProtocolTemplate

EFI_EVENT	mBootGraphicsReadyToBootEvent

UINTN	mBootGraphicsResourceTableKey = 0

BOOLEAN	mIsLogoValid = FALSE

EFI_GRAPHICS_OUTPUT_BLT_PIXEL *	mLogoBltBuffer = NULL

UINTN	mLogoDestX = 0

UINTN	mLogoDestY = 0

UINTN	mLogoWidth = 0

UINTN	mLogoHeight = 0

BOOLEAN	mAcpiBgrtInstalled = FALSE

BOOLEAN	mAcpiBgrtStatusChanged = FALSE

BOOLEAN	mAcpiBgrtBufferChanged = FALSE

EFI_ACPI_5_0_BOOT_GRAPHICS_RESOURCE_TABLE	mBootGraphicsResourceTableTemplate

Detailed Description

This module install ACPI Boot Graphics Resource Table (BGRT).

Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.
Copyright (c) 2016, Microsoft Corporation
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file BootGraphicsResourceTableDxe.c.

Function Documentation

◆ BgrtReadyToBootEventNotify()

VOID EFIAPI BgrtReadyToBootEventNotify	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Notify function for event group EFI_EVENT_GROUP_READY_TO_BOOT. This is used to install the Boot Graphics Resource Table.

Parameters

[in]	Event	The Event that is being processed.
[in]	Context	The Event Context.

Definition at line 417 of file BootGraphicsResourceTableDxe.c.

◆ BootGraphicsDxeEntryPoint()

EFI_STATUS EFIAPI BootGraphicsDxeEntryPoint	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

The module Entry Point of the Boot Graphics Resource Table DXE driver.

Parameters

[in]	ImageHandle	The firmware allocated handle for the EFI image.
[in]	SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS	The entry point is executed successfully.
Other	Some error occurs when executing this entry point.

Definition at line 557 of file BootGraphicsResourceTableDxe.c.

◆ GetBootLogo2()

EFI_STATUS EFIAPI GetBootLogo2	(	IN EDKII_BOOT_LOGO2_PROTOCOL *	This,
		OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL **	BltBuffer,
		OUT UINTN *	DestinationX,
		OUT UINTN *	DestinationY,
		OUT UINTN *	Width,
		OUT UINTN *	Height
	)

Get the location of the boot logo on the screen.

Parameters

[in]	This	The pointer to the Boot Logo Protocol 2 instance
[out]	BltBuffer	Returns pointer to the GOP BLT buffer that was previously registered with SetBootLogo2(). The buffer returned must not be modified or freed.
[out]	DestinationX	Returns the X start position of the GOP BLT buffer that was previously registered with SetBootLogo2().
[out]	DestinationY	Returns the Y start position of the GOP BLT buffer that was previously registered with SetBootLogo2().
[out]	Width	Returns the width of the GOP BLT buffer that was previously registered with SetBootLogo2().
[out]	Height	Returns the height of the GOP BLT buffer that was previously registered with SetBootLogo2().

Return values

EFI_SUCCESS	The location of the boot logo was returned.
EFI_NOT_READY	The boot logo has not been set.
EFI_INVALID_PARAMETER	BltBuffer is NULL.
EFI_INVALID_PARAMETER	DestinationX is NULL.
EFI_INVALID_PARAMETER	DestinationY is NULL.
EFI_INVALID_PARAMETER	Width is NULL.
EFI_INVALID_PARAMETER	Height is NULL.

Definition at line 367 of file BootGraphicsResourceTableDxe.c.

◆ SetBootLogo()

EFI_STATUS EFIAPI SetBootLogo	(	IN EFI_BOOT_LOGO_PROTOCOL *	This,
		IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer	OPTIONAL,
		IN UINTN	DestinationX,
		IN UINTN	DestinationY,
		IN UINTN	Width,
		IN UINTN	Height
	)

Update information of logo image drawn on screen.

Parameters

[in]	This	The pointer to the Boot Logo protocol 2 instance.
[in]	BltBuffer	The BLT buffer for logo drawn on screen. If BltBuffer is set to NULL, it indicates that logo image is no longer on the screen.
[in]	DestinationX	X coordinate of destination for the BltBuffer.
[in]	DestinationY	Y coordinate of destination for the BltBuffer.
[in]	Width	Width of rectangle in BltBuffer in pixels.
[in]	Height	Hight of rectangle in BltBuffer in pixels.

Return values

EFI_SUCCESS	The boot logo information was updated.
EFI_INVALID_PARAMETER	One of the parameters has an invalid value.
EFI_OUT_OF_RESOURCES	The logo information was not updated due to insufficient memory resources.

Update information of logo image drawn on screen.

Parameters

This	The pointer to the Boot Logo protocol instance.
BltBuffer	The BLT buffer for logo drawn on screen. If BltBuffer is set to NULL, it indicates that logo image is no longer on the screen.
DestinationX	X coordinate of destination for the BltBuffer.
DestinationY	Y coordinate of destination for the BltBuffer.
Width	Width of rectangle in BltBuffer in pixels.
Height	Hight of rectangle in BltBuffer in pixels.

Return values

EFI_SUCCESS	The boot logo information was updated.
EFI_INVALID_PARAMETER	One of the parameters has an invalid value.
EFI_OUT_OF_RESOURCES	The logo information was not updated due to insufficient memory resources.

Definition at line 198 of file BootGraphicsResourceTableDxe.c.

◆ SetBootLogo2()

EFI_STATUS EFIAPI SetBootLogo2	(	IN EDKII_BOOT_LOGO2_PROTOCOL *	This,
		IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer	OPTIONAL,
		IN UINTN	DestinationX,
		IN UINTN	DestinationY,
		IN UINTN	Width,
		IN UINTN	Height
	)

Update information of logo image drawn on screen.

Parameters

[in]	This	The pointer to the Boot Logo protocol 2 instance.
[in]	BltBuffer	The BLT buffer for logo drawn on screen. If BltBuffer is set to NULL, it indicates that logo image is no longer on the screen.
[in]	DestinationX	X coordinate of destination for the BltBuffer.
[in]	DestinationY	Y coordinate of destination for the BltBuffer.
[in]	Width	Width of rectangle in BltBuffer in pixels.
[in]	Height	Hight of rectangle in BltBuffer in pixels.

Return values

EFI_SUCCESS	The boot logo information was updated.
EFI_INVALID_PARAMETER	One of the parameters has an invalid value.
EFI_OUT_OF_RESOURCES	The logo information was not updated due to insufficient memory resources.

Definition at line 239 of file BootGraphicsResourceTableDxe.c.

Variable Documentation

◆ mAcpiBgrtBufferChanged

BOOLEAN mAcpiBgrtBufferChanged = FALSE

Definition at line 150 of file BootGraphicsResourceTableDxe.c.

◆ mAcpiBgrtInstalled

BOOLEAN mAcpiBgrtInstalled = FALSE

Definition at line 148 of file BootGraphicsResourceTableDxe.c.

◆ mAcpiBgrtStatusChanged

BOOLEAN mAcpiBgrtStatusChanged = FALSE

Definition at line 149 of file BootGraphicsResourceTableDxe.c.

◆ mBootGraphicsReadyToBootEvent

EFI_EVENT mBootGraphicsReadyToBootEvent

Definition at line 140 of file BootGraphicsResourceTableDxe.c.

◆ mBootGraphicsResourceTableKey

UINTN mBootGraphicsResourceTableKey = 0

Definition at line 141 of file BootGraphicsResourceTableDxe.c.

◆ mBootGraphicsResourceTableTemplate

EFI_ACPI_5_0_BOOT_GRAPHICS_RESOURCE_TABLE mBootGraphicsResourceTableTemplate

Initial value:

= {
  {
    EFI_ACPI_5_0_BOOT_GRAPHICS_RESOURCE_TABLE_SIGNATURE,
    sizeof (EFI_ACPI_5_0_BOOT_GRAPHICS_RESOURCE_TABLE),
    EFI_ACPI_5_0_BOOT_GRAPHICS_RESOURCE_TABLE_REVISION, 
    0x00,                                               
    
    
    
    { 0x00 },   
    0x00,       
    0x00,       
    0x00,       
    0x00,       
  },
  EFI_ACPI_5_0_BGRT_VERSION,         
  EFI_ACPI_5_0_BGRT_STATUS_VALID,    
  EFI_ACPI_5_0_BGRT_IMAGE_TYPE_BMP,  
  0,                                 
  0,                                 
  0                                  
}