[mirror_edk2.git] / MdeModulePkg / Library / GraphicsLib / Graphics.c

/** @file\r
  Library supports diplaying graphical splash screen,\r
  locking of keyboard input and printing character on\r
  screen. These basic graphics operations are based on UEFI HII, \r
  Graphics Output protocol or UGA Draw protocol.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. 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
\r
\r
#include <PiDxe.h>\r
\r
#include <Protocol/SimpleTextOut.h>\r
#include <Protocol/OEMBadging.h>\r
#include <Protocol/ConsoleControl.h>\r
#include <Protocol/GraphicsOutput.h>\r
#include <Protocol/UgaDraw.h>\r
#include <Protocol/HiiFont.h>\r
#include <Protocol/HiiImage.h>\r
\r
#include <Guid/Bmp.h>\r
\r
#include <Library/GraphicsLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DxePiLib.h>\r
#include <Library/PcdLib.h>\r
\r
STATIC EFI_GRAPHICS_OUTPUT_BLT_PIXEL mEfiColors[16] = {\r
  { 0x00, 0x00, 0x00, 0x00 },\r
  { 0x98, 0x00, 0x00, 0x00 },\r
  { 0x00, 0x98, 0x00, 0x00 },\r
  { 0x98, 0x98, 0x00, 0x00 },\r
  { 0x00, 0x00, 0x98, 0x00 },\r
  { 0x98, 0x00, 0x98, 0x00 },\r
  { 0x00, 0x98, 0x98, 0x00 },\r
  { 0x98, 0x98, 0x98, 0x00 },\r
  { 0x10, 0x10, 0x10, 0x00 },\r
  { 0xff, 0x10, 0x10, 0x00 },\r
  { 0x10, 0xff, 0x10, 0x00 },\r
  { 0xff, 0xff, 0x10, 0x00 },\r
  { 0x10, 0x10, 0xff, 0x00 },\r
  { 0xf0, 0x10, 0xff, 0x00 },\r
  { 0x10, 0xff, 0xff, 0x00 },\r
  { 0xff, 0xff, 0xff, 0x00 }\r
};\r
\r
\r
/**\r
  Return the graphics image file named FileNameGuid into Image and return it's\r
  size in ImageSize. All Firmware Volumes (FV) in the system are searched for the\r
  file name.\r
\r
  @param  FileNameGuid          File Name of graphics file in the FV(s).\r
  @param  Image                 Pointer to pointer to return graphics image.  If NULL, a \r
                                buffer will be allocated.\r
  @param  ImageSize             Size of the graphics Image in bytes. Zero if no image found.\r
\r
  @retval EFI_SUCCESS           Image and ImageSize are valid. \r
  @retval EFI_BUFFER_TOO_SMALL  Image not big enough. ImageSize has required size\r
  @retval EFI_NOT_FOUND         FileNameGuid not found\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GetGraphicsBitMapFromFV (\r
  IN  EFI_GUID      *FileNameGuid,\r
  OUT VOID          **Image,\r
  OUT UINTN         *ImageSize\r
  )\r
{\r
  return GetGraphicsBitMapFromFVEx (NULL, FileNameGuid, Image, ImageSize);\r
}\r
\r
/**\r
  Return the graphics image file named FileNameGuid into Image and return it's\r
  size in ImageSize. All Firmware Volumes (FV) in the system are searched for the\r
  file name.\r
\r
  @param  ImageHandle           The driver image handle of the caller. The parameter is used to\r
                                optimize the loading of the image file so that the FV from which\r
                                the driver image is loaded will be tried first. \r
  @param  FileNameGuid          File Name of graphics file in the FV(s).\r
  @param  Image                 Pointer to pointer to return graphics image.  If NULL, a \r
                                buffer will be allocated.\r
  @param  ImageSize             Size of the graphics Image in bytes. Zero if no image found.\r
\r
  @retval EFI_SUCCESS           Image and ImageSize are valid. \r
  @retval EFI_BUFFER_TOO_SMALL  Image not big enough. ImageSize has required size\r
  @retval EFI_NOT_FOUND         FileNameGuid not found\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GetGraphicsBitMapFromFVEx (\r
  IN  EFI_HANDLE    ImageHandle,\r
  IN  EFI_GUID      *FileNameGuid,\r
  OUT VOID          **Image,\r
  OUT UINTN         *ImageSize\r
  )\r
{\r
  return PiLibGetSectionFromAnyFv (\r
           FileNameGuid,\r
           EFI_SECTION_RAW,\r
           0,\r
           Image,\r
           ImageSize\r
           );\r
}\r
\r
/**\r
  Convert a *.BMP graphics image to a GOP blt buffer. If a NULL Blt buffer\r
  is passed in a GopBlt buffer will be allocated by this routine. If a GopBlt\r
  buffer is passed in it will be used if it is big enough.\r
\r
  @param  BmpImage      Pointer to BMP file\r
  @param  BmpImageSize  Number of bytes in BmpImage\r
  @param  GopBlt        Buffer containing GOP version of BmpImage.\r
  @param  GopBltSize    Size of GopBlt in bytes.\r
  @param  PixelHeight   Height of GopBlt/BmpImage in pixels\r
  @param  PixelWidth    Width of GopBlt/BmpImage in pixels\r
\r
  @retval EFI_SUCCESS           GopBlt and GopBltSize are returned. \r
  @retval EFI_UNSUPPORTED       BmpImage is not a valid *.BMP image\r
  @retval EFI_BUFFER_TOO_SMALL  The passed in GopBlt buffer is not big enough.\r
                                GopBltSize will contain the required size.\r
  @retval EFI_OUT_OF_RESOURCES  No enough buffer to allocate.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConvertBmpToGopBlt (\r
  IN     VOID      *BmpImage,\r
  IN     UINTN     BmpImageSize,\r
  IN OUT VOID      **GopBlt,\r
  IN OUT UINTN     *GopBltSize,\r
     OUT UINTN     *PixelHeight,\r
     OUT UINTN     *PixelWidth\r
  )\r
{\r
  UINT8                         *Image;\r
  UINT8                         *ImageHeader;\r
  BMP_IMAGE_HEADER              *BmpHeader;\r
  BMP_COLOR_MAP                 *BmpColorMap;\r
  EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer;\r
  EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Blt;\r
  UINTN                         BltBufferSize;\r
  UINTN                         Index;\r
  UINTN                         Height;\r
  UINTN                         Width;\r
  UINTN                         ImageIndex;\r
  BOOLEAN                       IsAllocated;\r
\r
  BmpHeader = (BMP_IMAGE_HEADER *) BmpImage;\r
\r
  if (BmpHeader->CharB != 'B' || BmpHeader->CharM != 'M') {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Doesn't support compress.\r
  //\r
  if (BmpHeader->CompressionType != 0) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Calculate Color Map offset in the image.\r
  //\r
  Image       = BmpImage;\r
  BmpColorMap = (BMP_COLOR_MAP *) (Image + sizeof (BMP_IMAGE_HEADER));\r
\r
  //\r
  // Calculate graphics image data address in the image\r
  //\r
  Image         = ((UINT8 *) BmpImage) + BmpHeader->ImageOffset;\r
  ImageHeader   = Image;\r
\r
  //\r
  // Calculate the BltBuffer needed size.\r
  //\r
  BltBufferSize = BmpHeader->PixelWidth * BmpHeader->PixelHeight * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL);\r
  IsAllocated   = FALSE;\r
  if (*GopBlt == NULL) {\r
    //\r
    // GopBlt is not allocated by caller.\r
    //\r
    *GopBltSize = BltBufferSize;\r
    *GopBlt     = AllocatePool (*GopBltSize);\r
    IsAllocated = TRUE;\r
    if (*GopBlt == NULL) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
  } else {\r
    //\r
    // GopBlt has been allocated by caller.\r
    //\r
    if (*GopBltSize < BltBufferSize) {\r
      *GopBltSize = BltBufferSize;\r
      return EFI_BUFFER_TOO_SMALL;\r
    }\r
  }\r
\r
  *PixelWidth   = BmpHeader->PixelWidth;\r
  *PixelHeight  = BmpHeader->PixelHeight;\r
\r
  //\r
  // Convert image from BMP to Blt buffer format\r
  //\r
  BltBuffer = *GopBlt;\r
  for (Height = 0; Height < BmpHeader->PixelHeight; Height++) {\r
    Blt = &BltBuffer[(BmpHeader->PixelHeight - Height - 1) * BmpHeader->PixelWidth];\r
    for (Width = 0; Width < BmpHeader->PixelWidth; Width++, Image++, Blt++) {\r
      switch (BmpHeader->BitPerPixel) {\r
      case 1:\r
        //\r
        // Convert 1-bit (2 colors) BMP to 24-bit color\r
        //\r
        for (Index = 0; Index < 8 && Width < BmpHeader->PixelWidth; Index++) {\r
          Blt->Red    = BmpColorMap[((*Image) >> (7 - Index)) & 0x1].Red;\r
          Blt->Green  = BmpColorMap[((*Image) >> (7 - Index)) & 0x1].Green;\r
          Blt->Blue   = BmpColorMap[((*Image) >> (7 - Index)) & 0x1].Blue;\r
          Blt++;\r
          Width++;\r
        }\r
\r
        Blt --;\r
        Width --;\r
        break;\r
\r
      case 4:\r
        //\r
        // Convert 4-bit (16 colors) BMP Palette to 24-bit color\r
        //\r
        Index       = (*Image) >> 4;\r
        Blt->Red    = BmpColorMap[Index].Red;\r
        Blt->Green  = BmpColorMap[Index].Green;\r
        Blt->Blue   = BmpColorMap[Index].Blue;\r
        if (Width < (BmpHeader->PixelWidth - 1)) {\r
          Blt++;\r
          Width++;\r
          Index       = (*Image) & 0x0f;\r
          Blt->Red    = BmpColorMap[Index].Red;\r
          Blt->Green  = BmpColorMap[Index].Green;\r
          Blt->Blue   = BmpColorMap[Index].Blue;\r
        }\r
        break;\r
\r
      case 8:\r
        //\r
        // Convert 8-bit (256 colors) BMP Palette to 24-bit color\r
        //\r
        Blt->Red    = BmpColorMap[*Image].Red;\r
        Blt->Green  = BmpColorMap[*Image].Green;\r
        Blt->Blue   = BmpColorMap[*Image].Blue;\r
        break;\r
\r
      case 24:\r
        //\r
        // It is 24-bit BMP.\r
        //\r
        Blt->Blue   = *Image++;\r
        Blt->Green  = *Image++;\r
        Blt->Red    = *Image;\r
        break;\r
\r
      default:\r
        //\r
        // Other bit format BMP is not supported.\r
        //\r
        if (IsAllocated) {\r
          FreePool (*GopBlt);\r
          *GopBlt = NULL;\r
        }\r
        return EFI_UNSUPPORTED;\r
        break;\r
      };\r
\r
    }\r
\r
    ImageIndex = (UINTN) (Image - ImageHeader);\r
    if ((ImageIndex % 4) != 0) {\r
      //\r
      // Bmp Image starts each row on a 32-bit boundary!\r
      //\r
      Image = Image + (4 - (ImageIndex % 4));\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Use Console Control Protocol to lock the Console In Spliter virtual handle. \r
  This is the ConInHandle and ConIn handle in the EFI system table. All key\r
  presses will be ignored until the Password is typed in. The only way to\r
  disable the password is to type it in to a ConIn device.\r
\r
  @param  Password        Password used to lock ConIn device.\r
\r
  @retval EFI_SUCCESS     lock the Console In Spliter virtual handle successfully.\r
  @retval EFI_UNSUPPORTED Password not found.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
LockKeyboards (\r
  IN  CHAR16    *Password\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  EFI_CONSOLE_CONTROL_PROTOCOL  *ConsoleControl;\r
\r
  Status = gBS->LocateProtocol (&gEfiConsoleControlProtocolGuid, NULL, (VOID **) &ConsoleControl);\r
  if (EFI_ERROR (Status)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  Status = ConsoleControl->LockStdIn (ConsoleControl, Password);\r
  return Status;\r
}\r
\r
\r
/**\r
  Use Console Control to turn off UGA based Simple Text Out consoles from going\r
  to the UGA device. Put up LogoFile on every UGA device that is a console.\r
\r
  @param  LogoFile        File name of logo to display on the center of the screen.\r
\r
  @retval EFI_SUCCESS     ConsoleControl has been flipped to graphics and logo displayed.\r
  @retval EFI_UNSUPPORTED Logo not found.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EnableQuietBoot (\r
  IN  EFI_GUID  *LogoFile\r
  )\r
{\r
  return EnableQuietBootEx (LogoFile, NULL);\r
}\r
\r
/**\r
  Use Console Control to turn off UGA based Simple Text Out consoles from going\r
  to the UGA device. Put up LogoFile on every UGA device that is a console\r
\r
  @param  LogoFile    File name of logo to display on the center of the screen.\r
  @param  ImageHandle The driver image handle of the caller. The parameter is used to\r
                      optimize the loading of the logo file so that the FV from which\r
                      the driver image is loaded will be tried first.\r
\r
  @retval EFI_SUCCESS     ConsoleControl has been flipped to graphics and logo displayed.\r
  @retval EFI_UNSUPPORTED Logo not found.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EnableQuietBootEx (\r
  IN  EFI_GUID    *LogoFile,\r
  IN  EFI_HANDLE  ImageHandle\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  EFI_CONSOLE_CONTROL_PROTOCOL  *ConsoleControl;\r
  EFI_OEM_BADGING_PROTOCOL      *Badging;\r
  UINT32                        SizeOfX;\r
  UINT32                        SizeOfY;\r
  INTN                          DestX;\r
  INTN                          DestY;\r
  UINT8                         *ImageData;\r
  UINTN                         ImageSize;\r
  UINTN                         BltSize;\r
  UINT32                        Instance;\r
  EFI_BADGING_FORMAT            Format;\r
  EFI_BADGING_DISPLAY_ATTRIBUTE Attribute;\r
  UINTN                         CoordinateX;\r
  UINTN                         CoordinateY;\r
  UINTN                         Height;\r
  UINTN                         Width;\r
  EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Blt;\r
  EFI_UGA_DRAW_PROTOCOL         *UgaDraw;\r
  UINT32                        ColorDepth;\r
  UINT32                        RefreshRate;\r
  EFI_GRAPHICS_OUTPUT_PROTOCOL  *GraphicsOutput;\r
\r
  Status = gBS->LocateProtocol (&gEfiConsoleControlProtocolGuid, NULL, (VOID **) &ConsoleControl);\r
  if (EFI_ERROR (Status)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  UgaDraw = NULL;\r
  //\r
  // Try to open GOP first\r
  //\r
  Status = gBS->HandleProtocol (gST->ConsoleOutHandle, &gEfiGraphicsOutputProtocolGuid, (VOID **) &GraphicsOutput);\r
  if (EFI_ERROR (Status) && FeaturePcdGet (PcdUgaConsumeSupport)) {\r
    GraphicsOutput = NULL;\r
    //\r
    // Open GOP failed, try to open UGA\r
    //\r
    Status = gBS->HandleProtocol (gST->ConsoleOutHandle, &gEfiUgaDrawProtocolGuid, (VOID **) &UgaDraw);\r
  }\r
  if (EFI_ERROR (Status)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  Badging = NULL;\r
  Status  = gBS->LocateProtocol (&gEfiOEMBadgingProtocolGuid, NULL, (VOID **) &Badging);\r
\r
  //\r
  // Set console control to graphics mode.\r
  //\r
  Status = ConsoleControl->SetMode (ConsoleControl, EfiConsoleControlScreenGraphics);\r
  if (EFI_ERROR (Status)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  if (GraphicsOutput != NULL) {\r
    SizeOfX = GraphicsOutput->Mode->Info->HorizontalResolution;\r
    SizeOfY = GraphicsOutput->Mode->Info->VerticalResolution;\r
  } else if (FeaturePcdGet (PcdUgaConsumeSupport)) {\r
    Status = UgaDraw->GetMode (UgaDraw, &SizeOfX, &SizeOfY, &ColorDepth, &RefreshRate);\r
    if (EFI_ERROR (Status)) {\r
      return EFI_UNSUPPORTED;\r
    }\r
  } else {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  Instance = 0;\r
  while (1) {\r
    ImageData = NULL;\r
    ImageSize = 0;\r
\r
    if (Badging != NULL) {\r
      //\r
      // Get image from OEMBadging protocol.\r
      //\r
      Status = Badging->GetImage (\r
                          Badging,\r
                          &Instance,\r
                          &Format,\r
                          &ImageData,\r
                          &ImageSize,\r
                          &Attribute,\r
                          &CoordinateX,\r
                          &CoordinateY\r
                          );\r
      if (EFI_ERROR (Status)) {\r
        return Status;\r
      }\r
\r
      //\r
      // Currently only support BMP format.\r
      //\r
      if (Format != EfiBadgingFormatBMP) {\r
        SafeFreePool (ImageData);\r
        continue;\r
      }\r
    } else {\r
      //\r
      // Get the specified image from FV.\r
      //\r
      Status = GetGraphicsBitMapFromFVEx (ImageHandle, LogoFile, (VOID **) &ImageData, &ImageSize);\r
      if (EFI_ERROR (Status)) {\r
        return EFI_UNSUPPORTED;\r
      }\r
\r
      CoordinateX = 0;\r
      CoordinateY = 0;\r
      Attribute   = EfiBadgingDisplayAttributeCenter;\r
    }\r
\r
    Blt = NULL;\r
    Status = ConvertBmpToGopBlt (\r
              ImageData,\r
              ImageSize,\r
              (VOID **) &Blt,\r
              &BltSize,\r
              &Height,\r
              &Width\r
              );\r
    if (EFI_ERROR (Status)) {\r
      SafeFreePool (ImageData);\r
      if (Badging == NULL) {\r
        return Status;\r
      } else {\r
        continue;\r
      }\r
    }\r
\r
    //\r
    // Caculate the display position according to Attribute.\r
    //\r
    switch (Attribute) {\r
    case EfiBadgingDisplayAttributeLeftTop:\r
      DestX = CoordinateX;\r
      DestY = CoordinateY;\r
      break;\r
\r
    case EfiBadgingDisplayAttributeCenterTop:\r
      DestX = (SizeOfX - Width) / 2;\r
      DestY = CoordinateY;\r
      break;\r
\r
    case EfiBadgingDisplayAttributeRightTop:\r
      DestX = (SizeOfX - Width - CoordinateX);\r
      DestY = CoordinateY;;\r
      break;\r
\r
    case EfiBadgingDisplayAttributeCenterRight:\r
      DestX = (SizeOfX - Width - CoordinateX);\r
      DestY = (SizeOfY - Height) / 2;\r
      break;\r
\r
    case EfiBadgingDisplayAttributeRightBottom:\r
      DestX = (SizeOfX - Width - CoordinateX);\r
      DestY = (SizeOfY - Height - CoordinateY);\r
      break;\r
\r
    case EfiBadgingDisplayAttributeCenterBottom:\r
      DestX = (SizeOfX - Width) / 2;\r
      DestY = (SizeOfY - Height - CoordinateY);\r
      break;\r
\r
    case EfiBadgingDisplayAttributeLeftBottom:\r
      DestX = CoordinateX;\r
      DestY = (SizeOfY - Height - CoordinateY);\r
      break;\r
\r
    case EfiBadgingDisplayAttributeCenterLeft:\r
      DestX = CoordinateX;\r
      DestY = (SizeOfY - Height) / 2;\r
      break;\r
\r
    case EfiBadgingDisplayAttributeCenter:\r
      DestX = (SizeOfX - Width) / 2;\r
      DestY = (SizeOfY - Height) / 2;\r
      break;\r
\r
    default:\r
      DestX = CoordinateX;\r
      DestY = CoordinateY;\r
      break;\r
    }\r
\r
    if ((DestX >= 0) && (DestY >= 0)) {\r
      if (GraphicsOutput != NULL) {\r
        Status = GraphicsOutput->Blt (\r
                            GraphicsOutput,\r
                            Blt,\r
                            EfiBltBufferToVideo,\r
                            0,\r
                            0,\r
                            (UINTN) DestX,\r
                            (UINTN) DestY,\r
                            Width,\r
                            Height,\r
                            Width * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL)\r
                            );\r
      } else if (FeaturePcdGet (PcdUgaConsumeSupport)) {\r
        Status = UgaDraw->Blt (\r
                            UgaDraw,\r
                            (EFI_UGA_PIXEL *) Blt,\r
                            EfiUgaBltBufferToVideo,\r
                            0,\r
                            0,\r
                            (UINTN) DestX,\r
                            (UINTN) DestY,\r
                            Width,\r
                            Height,\r
                            Width * sizeof (EFI_UGA_PIXEL)\r
                            );\r
      } else {\r
      Status = EFI_UNSUPPORTED;\r
      }\r
    }\r
\r
    SafeFreePool (ImageData);\r
    SafeFreePool (Blt);\r
\r
    if (Badging == NULL) {\r
      break;\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Use Console Control to turn on UGA based Simple Text Out consoles. The UGA \r
  Simple Text Out screens will now be synced up with all non UGA output devices\r
\r
  @retval EFI_SUCCESS          UGA devices are back in text mode and synced up.\r
  @retval EFI_UNSUPPORTED      Logo not found\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
DisableQuietBoot (\r
  VOID\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  EFI_CONSOLE_CONTROL_PROTOCOL  *ConsoleControl;\r
\r
  Status = gBS->LocateProtocol (&gEfiConsoleControlProtocolGuid, NULL, (VOID **) &ConsoleControl);\r
  if (EFI_ERROR (Status)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Set console control to text mode.\r
  //\r
  return ConsoleControl->SetMode (ConsoleControl, EfiConsoleControlScreenText);\r
}\r
\r
/**\r
  Internal display string worker function.\r
\r
  @param GraphicsOutput   Graphics output protocol interface.\r
  @param UgaDraw          UGA draw protocol interface.\r
  @param Sto              Simple text out protocol interface.\r
  @param X                X coordinate to start printing.\r
  @param Y                Y coordinate to start printing.\r
  @param Foreground       Foreground color.\r
  @param Background       Background color.\r
  @param fmt              Format string.\r
  @param args             Print arguments.\r
\r
  @return  Number of Characters printed. Zero means no any character \r
           displayed successfully.\r
\r
**/\r
UINTN\r
Print (\r
  IN EFI_GRAPHICS_OUTPUT_PROTOCOL     *GraphicsOutput,\r
  IN EFI_UGA_DRAW_PROTOCOL            *UgaDraw,\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *Sto,\r
  IN UINTN                            X,\r
  IN UINTN                            Y,\r
  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *Foreground,\r
  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *Background,\r
  IN CHAR16                           *fmt,\r
  IN VA_LIST                          args\r
  )\r
{\r
  VOID                           *Buffer;\r
  EFI_STATUS                     Status;\r
  UINTN                          Index;\r
  CHAR16                         *UnicodeWeight;\r
  UINT32                         HorizontalResolution;\r
  UINT32                         VerticalResolution;\r
  UINT32                         ColorDepth;\r
  UINT32                         RefreshRate;\r
  UINTN                          BufferLen;\r
  UINTN                          LineBufferLen;\r
  EFI_HII_FONT_PROTOCOL          *HiiFont;\r
  EFI_IMAGE_OUTPUT               *Blt;\r
  EFI_FONT_DISPLAY_INFO          *FontInfo;\r
  EFI_HII_ROW_INFO               *RowInfoArray;\r
  UINTN                          RowInfoArraySize;\r
  UINTN                          PrintNum;     \r
\r
  //\r
  // For now, allocate an arbitrarily long buffer\r
  //\r
  Buffer = AllocateZeroPool (0x10000);\r
  if (Buffer == NULL) {\r
    return 0;\r
  }\r
\r
  HorizontalResolution  = 0;\r
  VerticalResolution    = 0;\r
  Blt                   = NULL;\r
  FontInfo              = NULL;\r
  PrintNum              = 0;\r
\r
  if (GraphicsOutput != NULL) {\r
    HorizontalResolution = GraphicsOutput->Mode->Info->HorizontalResolution;\r
    VerticalResolution = GraphicsOutput->Mode->Info->VerticalResolution;\r
  } else if (FeaturePcdGet (PcdUgaConsumeSupport)) {\r
    UgaDraw->GetMode (UgaDraw, &HorizontalResolution, &VerticalResolution, &ColorDepth, &RefreshRate);\r
  } else {\r
    Status = EFI_UNSUPPORTED;\r
    goto Error;\r
  }\r
\r
  ASSERT ((HorizontalResolution != 0) && (VerticalResolution !=0));\r
\r
  Status = gBS->LocateProtocol (&gEfiHiiFontProtocolGuid, NULL, (VOID **) &HiiFont);\r
  if (EFI_ERROR (Status)) {\r
    goto Error;\r
  }\r
\r
  PrintNum = UnicodeVSPrint (Buffer, 0x10000, fmt, args);\r
\r
  UnicodeWeight = (CHAR16 *) Buffer;\r
\r
  for (Index = 0; UnicodeWeight[Index] != 0; Index++) {\r
    if (UnicodeWeight[Index] == CHAR_BACKSPACE ||\r
        UnicodeWeight[Index] == CHAR_LINEFEED  ||\r
        UnicodeWeight[Index] == CHAR_CARRIAGE_RETURN) {\r
      UnicodeWeight[Index] = 0;\r
    }\r
  }\r
\r
  BufferLen = StrLen (Buffer);\r
\r
  LineBufferLen = sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL) * HorizontalResolution * EFI_GLYPH_HEIGHT;\r
  if (EFI_GLYPH_WIDTH * EFI_GLYPH_HEIGHT * sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL) * BufferLen > LineBufferLen) {\r
     Status = EFI_INVALID_PARAMETER;\r
     goto Error;\r
  }\r
\r
  Blt = (EFI_IMAGE_OUTPUT *) AllocateZeroPool (sizeof (EFI_IMAGE_OUTPUT));\r
  if (Blt == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto Error;\r
  }\r
\r
  Blt->Width        = (UINT16) (HorizontalResolution);\r
  Blt->Height       = (UINT16) (VerticalResolution);\r
\r
  FontInfo = (EFI_FONT_DISPLAY_INFO *) AllocateZeroPool (sizeof (EFI_FONT_DISPLAY_INFO));\r
  if (FontInfo == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto Error;\r
  }\r
  if (Foreground != NULL) {\r
    CopyMem (&FontInfo->ForegroundColor, Foreground, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));\r
  } else {\r
    CopyMem (\r
      &FontInfo->ForegroundColor,\r
      &mEfiColors[Sto->Mode->Attribute & 0x0f],\r
      sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL)\r
      );\r
  }\r
  if (Background != NULL) {\r
    CopyMem (&FontInfo->BackgroundColor, Background, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));\r
  } else {\r
    CopyMem (\r
      &FontInfo->BackgroundColor,\r
      &mEfiColors[Sto->Mode->Attribute >> 4],\r
      sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL)\r
      );\r
  }\r
\r
  if (GraphicsOutput != NULL) {\r
    Blt->Image.Screen = GraphicsOutput;\r
    \r
    Status = HiiFont->StringToImage (\r
                         HiiFont,\r
                         EFI_HII_IGNORE_IF_NO_GLYPH | EFI_HII_DIRECT_TO_SCREEN,\r
                         Buffer,\r
                         FontInfo,\r
                         &Blt,\r
                         X,\r
                         Y,\r
                         NULL,\r
                         NULL,\r
                         NULL\r
                         );\r
\r
  } else if (FeaturePcdGet (PcdUgaConsumeSupport)) {\r
    ASSERT (UgaDraw!= NULL);\r
\r
    Blt->Image.Bitmap = AllocateZeroPool (Blt->Width * Blt->Height * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));\r
    if (Blt->Image.Bitmap == NULL) {\r
      SafeFreePool (Blt);\r
      SafeFreePool (Buffer);\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
\r
    RowInfoArray = NULL;\r
    //\r
    //  StringToImage only support blt'ing image to device using GOP protocol. If GOP is not supported in this platform,\r
    //  we ask StringToImage to print the string to blt buffer, then blt to device using UgaDraw.\r
    //\r
    Status = HiiFont->StringToImage (\r
                         HiiFont,\r
                         EFI_HII_IGNORE_IF_NO_GLYPH,\r
                         Buffer,\r
                         FontInfo,\r
                         &Blt,\r
                         X,\r
                         Y,\r
                         &RowInfoArray,\r
                         &RowInfoArraySize,\r
                         NULL\r
                         );\r
\r
    if (!EFI_ERROR (Status)) {\r
      //\r
      // Line breaks are handled by caller of DrawUnicodeWeightAtCursorN, so the updated parameter RowInfoArraySize by StringToImage will\r
      // always be 1 or 0 (if there is no valid Unicode Char can be printed). ASSERT here to make sure.\r
      //\r
      ASSERT (RowInfoArraySize <= 1);\r
\r
      Status = UgaDraw->Blt (\r
                          UgaDraw,\r
                          (EFI_UGA_PIXEL *) Blt->Image.Bitmap,\r
                          EfiUgaBltBufferToVideo,\r
                          X,\r
                          Y,\r
                          X,\r
                          Y,\r
                          RowInfoArray[0].LineWidth,\r
                          RowInfoArray[0].LineHeight,\r
                          Blt->Width * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL)\r
                          );\r
    }\r
\r
    SafeFreePool (RowInfoArray);\r
    SafeFreePool (Blt->Image.Bitmap);\r
  } else {\r
    Status = EFI_UNSUPPORTED;\r
  }\r
\r
Error:\r
  SafeFreePool (Blt);\r
  SafeFreePool (FontInfo);\r
  FreePool (Buffer);\r
\r
  if (EFI_ERROR (Status)) {\r
    return PrintNum;\r
  } else {\r
    return 0;\r
  }\r
}\r
\r
/**\r
  Print Unicode string to graphics screen at the given X,Y coordinates of the graphics screen.\r
  see definition of Print to find rules for constructing Fmt.\r
\r
  @param  X            Row to start printing at.\r
  @param  Y            Column to start printing at.\r
  @param  ForeGround   Foreground color.\r
  @param  BackGround   background color.\r
  @param  Fmt          Print format sting. See definition of Print.\r
  @param  ...          Argumnet stream defined by Fmt string.\r
\r
  @return  Number of Characters printed. Zero means no any character \r
           displayed successfully.\r
\r
**/\r
UINTN\r
EFIAPI\r
PrintXY (\r
  IN UINTN                            X,\r
  IN UINTN                            Y,\r
  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *ForeGround, OPTIONAL\r
  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *BackGround, OPTIONAL\r
  IN CHAR16                           *Fmt,\r
  ...\r
  )\r
{\r
  EFI_HANDLE                       Handle;\r
  EFI_GRAPHICS_OUTPUT_PROTOCOL     *GraphicsOutput;\r
  EFI_UGA_DRAW_PROTOCOL            *UgaDraw;\r
  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *Sto;\r
  EFI_STATUS                       Status;\r
  VA_LIST                          Args;\r
\r
  VA_START (Args, Fmt);\r
\r
  Handle = gST->ConsoleOutHandle;\r
\r
  Status = gBS->HandleProtocol (\r
                  Handle,\r
                  &gEfiGraphicsOutputProtocolGuid,\r
                  (VOID **) &GraphicsOutput\r
                  );\r
\r
  UgaDraw = NULL;\r
  if (EFI_ERROR (Status) && FeaturePcdGet (PcdUgaConsumeSupport)) {\r
    //\r
    // If no GOP available, try to open UGA Draw protocol if supported.\r
    //\r
    GraphicsOutput = NULL;\r
\r
    Status = gBS->HandleProtocol (\r
                    Handle,\r
                    &gEfiUgaDrawProtocolGuid,\r
                    (VOID **) &UgaDraw\r
                    );\r
  }\r
  if (EFI_ERROR (Status)) {\r
    return 0;\r
  }\r
\r
  Status = gBS->HandleProtocol (\r
                  Handle,\r
                  &gEfiSimpleTextOutProtocolGuid,\r
                  (VOID **) &Sto\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    return 0;\r
  }\r
\r
  return Print (GraphicsOutput, UgaDraw, Sto, X, Y, ForeGround, BackGround, Fmt, Args);\r
}\r
\r