/** @file
|
BDS Lib functions which contain all the code to connect console device
|
|
Copyright (c) 2006 - 2019 Intel Corporation. All rights reserved. <BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
**/
|
|
#include <PiDxe.h>
|
#include <Protocol/SimpleTextOut.h>
|
#include <OemBadging.h>
|
#include <Protocol/GraphicsOutput.h>
|
#include <Protocol/UgaDraw.h>
|
#include <Library/BaseLib.h>
|
#include <Library/UefiLib.h>
|
#include <Library/BaseMemoryLib.h>
|
#include <Library/UefiBootServicesTableLib.h>
|
#include <Library/DxeServicesLib.h>
|
#include <Library/PcdLib.h>
|
#include <Library/MemoryAllocationLib.h>
|
#include <Library/DebugLib.h>
|
|
#include <IndustryStandard/Bmp.h>
|
#include <Protocol/BootLogo.h>
|
|
/**
|
Convert a *.BMP graphics image to a GOP blt buffer. If a NULL Blt buffer
|
is passed in a GopBlt buffer will be allocated by this routine. If a GopBlt
|
buffer is passed in it will be used if it is big enough.
|
|
@param BmpImage Pointer to BMP file
|
@param BmpImageSize Number of bytes in BmpImage
|
@param GopBlt Buffer containing GOP version of BmpImage.
|
@param GopBltSize Size of GopBlt in bytes.
|
@param PixelHeight Height of GopBlt/BmpImage in pixels
|
@param PixelWidth Width of GopBlt/BmpImage in pixels
|
|
@retval EFI_SUCCESS GopBlt and GopBltSize are returned.
|
@retval EFI_UNSUPPORTED BmpImage is not a valid *.BMP image
|
@retval EFI_BUFFER_TOO_SMALL The passed in GopBlt buffer is not big enough.
|
GopBltSize will contain the required size.
|
@retval EFI_OUT_OF_RESOURCES No enough buffer to allocate.
|
|
**/
|
EFI_STATUS
|
ConvertBmpToGopBlt (
|
IN VOID *BmpImage,
|
IN UINTN BmpImageSize,
|
IN OUT VOID **GopBlt,
|
IN OUT UINTN *GopBltSize,
|
OUT UINTN *PixelHeight,
|
OUT UINTN *PixelWidth
|
)
|
{
|
UINT8 *Image;
|
UINT8 *ImageHeader;
|
BMP_IMAGE_HEADER *BmpHeader;
|
BMP_COLOR_MAP *BmpColorMap;
|
EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer;
|
EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Blt;
|
UINT64 BltBufferSize;
|
UINTN Index;
|
UINTN Height;
|
UINTN Width;
|
UINTN ImageIndex;
|
UINT32 DataSizePerLine;
|
BOOLEAN IsAllocated;
|
UINT32 ColorMapNum;
|
|
if (sizeof (BMP_IMAGE_HEADER) > BmpImageSize) {
|
return EFI_INVALID_PARAMETER;
|
}
|
|
BmpHeader = (BMP_IMAGE_HEADER *) BmpImage;
|
|
if (BmpHeader->CharB != 'B' || BmpHeader->CharM != 'M') {
|
return EFI_UNSUPPORTED;
|
}
|
|
//
|
// Doesn't support compress.
|
//
|
if (BmpHeader->CompressionType != 0) {
|
return EFI_UNSUPPORTED;
|
}
|
|
//
|
// Only support BITMAPINFOHEADER format.
|
// BITMAPFILEHEADER + BITMAPINFOHEADER = BMP_IMAGE_HEADER
|
//
|
if (BmpHeader->HeaderSize != sizeof (BMP_IMAGE_HEADER) - OFFSET_OF(BMP_IMAGE_HEADER, HeaderSize)) {
|
return EFI_UNSUPPORTED;
|
}
|
|
//
|
// The data size in each line must be 4 byte alignment.
|
//
|
DataSizePerLine = ((BmpHeader->PixelWidth * BmpHeader->BitPerPixel + 31) >> 3) & (~0x3);
|
BltBufferSize = MultU64x32 (DataSizePerLine, BmpHeader->PixelHeight);
|
if (BltBufferSize > (UINT32) ~0) {
|
return EFI_INVALID_PARAMETER;
|
}
|
|
if ((BmpHeader->Size != BmpImageSize) ||
|
(BmpHeader->Size < BmpHeader->ImageOffset) ||
|
(BmpHeader->Size - BmpHeader->ImageOffset != BmpHeader->PixelHeight * DataSizePerLine)) {
|
return EFI_INVALID_PARAMETER;
|
}
|
|
//
|
// Calculate Color Map offset in the image.
|
//
|
Image = BmpImage;
|
BmpColorMap = (BMP_COLOR_MAP *) (Image + sizeof (BMP_IMAGE_HEADER));
|
if (BmpHeader->ImageOffset < sizeof (BMP_IMAGE_HEADER)) {
|
return EFI_INVALID_PARAMETER;
|
}
|
|
if (BmpHeader->ImageOffset > sizeof (BMP_IMAGE_HEADER)) {
|
switch (BmpHeader->BitPerPixel) {
|
case 1:
|
ColorMapNum = 2;
|
break;
|
case 4:
|
ColorMapNum = 16;
|
break;
|
case 8:
|
ColorMapNum = 256;
|
break;
|
default:
|
ColorMapNum = 0;
|
break;
|
}
|
//
|
// BMP file may has padding data between the bmp header section and the bmp data section.
|
//
|
if (BmpHeader->ImageOffset - sizeof (BMP_IMAGE_HEADER) < sizeof (BMP_COLOR_MAP) * ColorMapNum) {
|
return EFI_INVALID_PARAMETER;
|
}
|
}
|
|
//
|
// Calculate graphics image data address in the image
|
//
|
Image = ((UINT8 *) BmpImage) + BmpHeader->ImageOffset;
|
ImageHeader = Image;
|
|
//
|
// Calculate the BltBuffer needed size.
|
//
|
BltBufferSize = MultU64x32 ((UINT64) BmpHeader->PixelWidth, BmpHeader->PixelHeight);
|
//
|
// Ensure the BltBufferSize * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL) doesn't overflow
|
//
|
if (BltBufferSize > DivU64x32 ((UINTN) ~0, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL))) {
|
return EFI_UNSUPPORTED;
|
}
|
BltBufferSize = MultU64x32 (BltBufferSize, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));
|
|
IsAllocated = FALSE;
|
if (*GopBlt == NULL) {
|
//
|
// GopBlt is not allocated by caller.
|
//
|
*GopBltSize = (UINTN) BltBufferSize;
|
*GopBlt = AllocatePool (*GopBltSize);
|
IsAllocated = TRUE;
|
if (*GopBlt == NULL) {
|
return EFI_OUT_OF_RESOURCES;
|
}
|
} else {
|
//
|
// GopBlt has been allocated by caller.
|
//
|
if (*GopBltSize < (UINTN) BltBufferSize) {
|
*GopBltSize = (UINTN) BltBufferSize;
|
return EFI_BUFFER_TOO_SMALL;
|
}
|
}
|
|
*PixelWidth = BmpHeader->PixelWidth;
|
*PixelHeight = BmpHeader->PixelHeight;
|
|
//
|
// Convert image from BMP to Blt buffer format
|
//
|
BltBuffer = *GopBlt;
|
for (Height = 0; Height < BmpHeader->PixelHeight; Height++) {
|
Blt = &BltBuffer[(BmpHeader->PixelHeight - Height - 1) * BmpHeader->PixelWidth];
|
for (Width = 0; Width < BmpHeader->PixelWidth; Width++, Image++, Blt++) {
|
switch (BmpHeader->BitPerPixel) {
|
case 1:
|
//
|
// Convert 1-bit (2 colors) BMP to 24-bit color
|
//
|
for (Index = 0; Index < 8 && Width < BmpHeader->PixelWidth; Index++) {
|
Blt->Red = BmpColorMap[((*Image) >> (7 - Index)) & 0x1].Red;
|
Blt->Green = BmpColorMap[((*Image) >> (7 - Index)) & 0x1].Green;
|
Blt->Blue = BmpColorMap[((*Image) >> (7 - Index)) & 0x1].Blue;
|
Blt++;
|
Width++;
|
}
|
|
Blt--;
|
Width--;
|
break;
|
|
case 4:
|
//
|
// Convert 4-bit (16 colors) BMP Palette to 24-bit color
|
//
|
Index = (*Image) >> 4;
|
Blt->Red = BmpColorMap[Index].Red;
|
Blt->Green = BmpColorMap[Index].Green;
|
Blt->Blue = BmpColorMap[Index].Blue;
|
if (Width < (BmpHeader->PixelWidth - 1)) {
|
Blt++;
|
Width++;
|
Index = (*Image) & 0x0f;
|
Blt->Red = BmpColorMap[Index].Red;
|
Blt->Green = BmpColorMap[Index].Green;
|
Blt->Blue = BmpColorMap[Index].Blue;
|
}
|
break;
|
|
case 8:
|
//
|
// Convert 8-bit (256 colors) BMP Palette to 24-bit color
|
//
|
Blt->Red = BmpColorMap[*Image].Red;
|
Blt->Green = BmpColorMap[*Image].Green;
|
Blt->Blue = BmpColorMap[*Image].Blue;
|
break;
|
|
case 24:
|
//
|
// It is 24-bit BMP.
|
//
|
Blt->Blue = *Image++;
|
Blt->Green = *Image++;
|
Blt->Red = *Image;
|
break;
|
|
default:
|
//
|
// Other bit format BMP is not supported.
|
//
|
if (IsAllocated) {
|
FreePool (*GopBlt);
|
*GopBlt = NULL;
|
}
|
return EFI_UNSUPPORTED;
|
break;
|
};
|
|
}
|
|
ImageIndex = (UINTN) (Image - ImageHeader);
|
if ((ImageIndex % 4) != 0) {
|
//
|
// Bmp Image starts each row on a 32-bit boundary!
|
//
|
Image = Image + (4 - (ImageIndex % 4));
|
}
|
}
|
|
return EFI_SUCCESS;
|
}
|
|
/**
|
Use SystemTable Conout to stop video based Simple Text Out consoles from going
|
to the video device. Put up LogoFile on every video device that is a console.
|
|
@param[in] LogoFile File name of logo to display on the center of the screen.
|
|
@retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo displayed.
|
@retval EFI_UNSUPPORTED Logo not found
|
|
**/
|
EFI_STATUS
|
EFIAPI
|
EnableBootLogo (
|
IN EFI_GUID *LogoFile
|
)
|
{
|
EFI_STATUS Status;
|
EFI_OEM_BADGING_PROTOCOL *Badging;
|
UINT32 SizeOfX;
|
UINT32 SizeOfY;
|
INTN DestX;
|
INTN DestY;
|
UINT8 *ImageData;
|
UINTN ImageSize;
|
UINTN BltSize;
|
UINT32 Instance;
|
EFI_BADGING_FORMAT Format;
|
EFI_BADGING_DISPLAY_ATTRIBUTE Attribute;
|
UINTN CoordinateX;
|
UINTN CoordinateY;
|
UINTN Height;
|
UINTN Width;
|
EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Blt;
|
EFI_UGA_DRAW_PROTOCOL *UgaDraw;
|
UINT32 ColorDepth;
|
UINT32 RefreshRate;
|
EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;
|
EFI_BOOT_LOGO_PROTOCOL *BootLogo;
|
UINTN NumberOfLogos;
|
EFI_GRAPHICS_OUTPUT_BLT_PIXEL *LogoBlt;
|
UINTN LogoDestX;
|
UINTN LogoDestY;
|
UINTN LogoHeight;
|
UINTN LogoWidth;
|
UINTN NewDestX;
|
UINTN NewDestY;
|
UINTN NewHeight;
|
UINTN NewWidth;
|
UINT64 BufferSize;
|
|
UgaDraw = NULL;
|
//
|
// Try to open GOP first
|
//
|
Status = gBS->HandleProtocol (gST->ConsoleOutHandle, &gEfiGraphicsOutputProtocolGuid, (VOID **) &GraphicsOutput);
|
if (EFI_ERROR (Status) && FeaturePcdGet (PcdUgaConsumeSupport)) {
|
GraphicsOutput = NULL;
|
//
|
// Open GOP failed, try to open UGA
|
//
|
Status = gBS->HandleProtocol (gST->ConsoleOutHandle, &gEfiUgaDrawProtocolGuid, (VOID **) &UgaDraw);
|
}
|
if (EFI_ERROR (Status)) {
|
return EFI_UNSUPPORTED;
|
}
|
|
//
|
// Try to open Boot Logo Protocol.
|
//
|
BootLogo = NULL;
|
gBS->LocateProtocol (&gEfiBootLogoProtocolGuid, NULL, (VOID **) &BootLogo);
|
|
//
|
// Erase Cursor from screen
|
//
|
gST->ConOut->EnableCursor (gST->ConOut, FALSE);
|
|
Badging = NULL;
|
Status = gBS->LocateProtocol (&gEfiOemBadgingProtocolGuid, NULL, (VOID **) &Badging);
|
|
if (GraphicsOutput != NULL) {
|
SizeOfX = GraphicsOutput->Mode->Info->HorizontalResolution;
|
SizeOfY = GraphicsOutput->Mode->Info->VerticalResolution;
|
|
} else if (UgaDraw != NULL && FeaturePcdGet (PcdUgaConsumeSupport)) {
|
Status = UgaDraw->GetMode (UgaDraw, &SizeOfX, &SizeOfY, &ColorDepth, &RefreshRate);
|
if (EFI_ERROR (Status)) {
|
return EFI_UNSUPPORTED;
|
}
|
} else {
|
return EFI_UNSUPPORTED;
|
}
|
|
Blt = NULL;
|
NumberOfLogos = 0;
|
LogoDestX = 0;
|
LogoDestY = 0;
|
LogoHeight = 0;
|
LogoWidth = 0;
|
NewDestX = 0;
|
NewDestY = 0;
|
NewHeight = 0;
|
NewWidth = 0;
|
Instance = 0;
|
while (1) {
|
ImageData = NULL;
|
ImageSize = 0;
|
|
if (Badging != NULL) {
|
//
|
// Get image from OEMBadging protocol.
|
//
|
Status = Badging->GetImage (
|
Badging,
|
&Instance,
|
&Format,
|
&ImageData,
|
&ImageSize,
|
&Attribute,
|
&CoordinateX,
|
&CoordinateY
|
);
|
if (EFI_ERROR (Status)) {
|
goto Done;
|
}
|
|
} else {
|
//
|
// Get the specified image from FV.
|
//
|
Status = GetSectionFromAnyFv (LogoFile, EFI_SECTION_RAW, 0, (VOID **) &ImageData, &ImageSize);
|
if (EFI_ERROR (Status)) {
|
return EFI_UNSUPPORTED;
|
}
|
|
CoordinateX = 0;
|
CoordinateY = 0;
|
Attribute = EfiBadgingDisplayAttributeCenter;
|
}
|
|
if (Blt != NULL) {
|
FreePool (Blt);
|
}
|
|
//
|
// Try BMP decoder
|
//
|
Blt = NULL;
|
Status = ConvertBmpToGopBlt (
|
ImageData,
|
ImageSize,
|
(VOID **) &Blt,
|
&BltSize,
|
&Height,
|
&Width
|
);
|
|
if (EFI_ERROR (Status)) {
|
FreePool (ImageData);
|
|
if (Badging == NULL) {
|
return Status;
|
} else {
|
continue;
|
}
|
}
|
|
//
|
// Calculate the display position according to Attribute.
|
//
|
switch (Attribute) {
|
case EfiBadgingDisplayAttributeLeftTop:
|
DestX = CoordinateX;
|
DestY = CoordinateY;
|
break;
|
|
case EfiBadgingDisplayAttributeCenterTop:
|
DestX = (SizeOfX - Width) / 2;
|
DestY = CoordinateY;
|
break;
|
|
case EfiBadgingDisplayAttributeRightTop:
|
DestX = (SizeOfX - Width - CoordinateX);
|
DestY = CoordinateY;;
|
break;
|
|
case EfiBadgingDisplayAttributeCenterRight:
|
DestX = (SizeOfX - Width - CoordinateX);
|
DestY = (SizeOfY - Height) / 2;
|
break;
|
|
case EfiBadgingDisplayAttributeRightBottom:
|
DestX = (SizeOfX - Width - CoordinateX);
|
DestY = (SizeOfY - Height - CoordinateY);
|
break;
|
|
case EfiBadgingDisplayAttributeCenterBottom:
|
DestX = (SizeOfX - Width) / 2;
|
DestY = (SizeOfY - Height - CoordinateY);
|
break;
|
|
case EfiBadgingDisplayAttributeLeftBottom:
|
DestX = CoordinateX;
|
DestY = (SizeOfY - Height - CoordinateY);
|
break;
|
|
case EfiBadgingDisplayAttributeCenterLeft:
|
DestX = CoordinateX;
|
DestY = (SizeOfY - Height) / 2;
|
break;
|
|
case EfiBadgingDisplayAttributeCenter:
|
DestX = (SizeOfX - Width) / 2;
|
DestY = (SizeOfY - Height) / 2;
|
break;
|
|
default:
|
DestX = CoordinateX;
|
DestY = CoordinateY;
|
break;
|
}
|
|
if ((DestX >= 0) && (DestY >= 0)) {
|
if (GraphicsOutput != NULL) {
|
Status = GraphicsOutput->Blt (
|
GraphicsOutput,
|
Blt,
|
EfiBltBufferToVideo,
|
0,
|
0,
|
(UINTN) DestX,
|
(UINTN) DestY,
|
Width,
|
Height,
|
Width * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL)
|
);
|
} else if (UgaDraw != NULL && FeaturePcdGet (PcdUgaConsumeSupport)) {
|
Status = UgaDraw->Blt (
|
UgaDraw,
|
(EFI_UGA_PIXEL *) Blt,
|
EfiUgaBltBufferToVideo,
|
0,
|
0,
|
(UINTN) DestX,
|
(UINTN) DestY,
|
Width,
|
Height,
|
Width * sizeof (EFI_UGA_PIXEL)
|
);
|
} else {
|
Status = EFI_UNSUPPORTED;
|
}
|
|
//
|
// Report displayed Logo information.
|
//
|
if (!EFI_ERROR (Status)) {
|
NumberOfLogos++;
|
|
if (LogoWidth == 0) {
|
//
|
// The first Logo.
|
//
|
LogoDestX = (UINTN) DestX;
|
LogoDestY = (UINTN) DestY;
|
LogoWidth = Width;
|
LogoHeight = Height;
|
} else {
|
//
|
// Merge new logo with old one.
|
//
|
NewDestX = MIN ((UINTN) DestX, LogoDestX);
|
NewDestY = MIN ((UINTN) DestY, LogoDestY);
|
NewWidth = MAX ((UINTN) DestX + Width, LogoDestX + LogoWidth) - NewDestX;
|
NewHeight = MAX ((UINTN) DestY + Height, LogoDestY + LogoHeight) - NewDestY;
|
|
LogoDestX = NewDestX;
|
LogoDestY = NewDestY;
|
LogoWidth = NewWidth;
|
LogoHeight = NewHeight;
|
}
|
}
|
}
|
|
FreePool (ImageData);
|
|
if (Badging == NULL) {
|
break;
|
}
|
}
|
|
Done:
|
if (BootLogo == NULL || NumberOfLogos == 0) {
|
//
|
// No logo displayed.
|
//
|
if (Blt != NULL) {
|
FreePool (Blt);
|
}
|
|
return Status;
|
}
|
|
//
|
// Advertise displayed Logo information.
|
//
|
if (NumberOfLogos == 1) {
|
//
|
// Only one logo displayed, use its Blt buffer directly for BootLogo protocol.
|
//
|
LogoBlt = Blt;
|
Status = EFI_SUCCESS;
|
} else {
|
//
|
// More than one Logo displayed, get merged BltBuffer using VideoToBuffer operation.
|
//
|
if (Blt != NULL) {
|
FreePool (Blt);
|
}
|
|
//
|
// Ensure the LogoHeight * LogoWidth doesn't overflow
|
//
|
if (LogoHeight > DivU64x64Remainder ((UINTN) ~0, LogoWidth, NULL)) {
|
return EFI_UNSUPPORTED;
|
}
|
BufferSize = MultU64x64 (LogoWidth, LogoHeight);
|
|
//
|
// Ensure the BufferSize * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL) doesn't overflow
|
//
|
if (BufferSize > DivU64x32 ((UINTN) ~0, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL))) {
|
return EFI_UNSUPPORTED;
|
}
|
|
LogoBlt = AllocateZeroPool ((UINTN)BufferSize * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));
|
if (LogoBlt == NULL) {
|
return EFI_OUT_OF_RESOURCES;
|
}
|
|
if (GraphicsOutput != NULL) {
|
Status = GraphicsOutput->Blt (
|
GraphicsOutput,
|
LogoBlt,
|
EfiBltVideoToBltBuffer,
|
LogoDestX,
|
LogoDestY,
|
0,
|
0,
|
LogoWidth,
|
LogoHeight,
|
LogoWidth * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL)
|
);
|
} else if (UgaDraw != NULL && FeaturePcdGet (PcdUgaConsumeSupport)) {
|
Status = UgaDraw->Blt (
|
UgaDraw,
|
(EFI_UGA_PIXEL *) LogoBlt,
|
EfiUgaVideoToBltBuffer,
|
LogoDestX,
|
LogoDestY,
|
0,
|
0,
|
LogoWidth,
|
LogoHeight,
|
LogoWidth * sizeof (EFI_UGA_PIXEL)
|
);
|
} else {
|
Status = EFI_UNSUPPORTED;
|
}
|
}
|
|
if (!EFI_ERROR (Status)) {
|
BootLogo->SetBootLogo (BootLogo, LogoBlt, LogoDestX, LogoDestY, LogoWidth, LogoHeight);
|
}
|
FreePool (LogoBlt);
|
|
return Status;
|
}
|
