OvmfPkg: add PcdVideoResolutionSource

[mirror_edk2.git] / OvmfPkg / QemuVideoDxe / Gop.c

/** @file\r
  Graphics Output Protocol functions for the QEMU video controller.\r
\r
  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "Qemu.h"\r
\r
STATIC\r
VOID\r
QemuVideoCompleteModeInfo (\r
  IN  QEMU_VIDEO_MODE_DATA                  *ModeData,\r
  OUT EFI_GRAPHICS_OUTPUT_MODE_INFORMATION  *Info\r
  )\r
{\r
  Info->Version = 0;\r
  if (ModeData->ColorDepth == 8) {\r
    Info->PixelFormat                   = PixelBitMask;\r
    Info->PixelInformation.RedMask      = PIXEL_RED_MASK;\r
    Info->PixelInformation.GreenMask    = PIXEL_GREEN_MASK;\r
    Info->PixelInformation.BlueMask     = PIXEL_BLUE_MASK;\r
    Info->PixelInformation.ReservedMask = 0;\r
  } else if (ModeData->ColorDepth == 24) {\r
    Info->PixelFormat                   = PixelBitMask;\r
    Info->PixelInformation.RedMask      = PIXEL24_RED_MASK;\r
    Info->PixelInformation.GreenMask    = PIXEL24_GREEN_MASK;\r
    Info->PixelInformation.BlueMask     = PIXEL24_BLUE_MASK;\r
    Info->PixelInformation.ReservedMask = 0;\r
  } else if (ModeData->ColorDepth == 32) {\r
    DEBUG ((DEBUG_INFO, "PixelBlueGreenRedReserved8BitPerColor\n"));\r
    Info->PixelFormat = PixelBlueGreenRedReserved8BitPerColor;\r
  }\r
\r
  Info->PixelsPerScanLine = Info->HorizontalResolution;\r
}\r
\r
STATIC\r
EFI_STATUS\r
QemuVideoCompleteModeData (\r
  IN  QEMU_VIDEO_PRIVATE_DATA            *Private,\r
  OUT EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE  *Mode\r
  )\r
{\r
  EFI_GRAPHICS_OUTPUT_MODE_INFORMATION  *Info;\r
  EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR     *FrameBufDesc;\r
  QEMU_VIDEO_MODE_DATA                  *ModeData;\r
\r
  ModeData = &Private->ModeData[Mode->Mode];\r
  Info     = Mode->Info;\r
  QemuVideoCompleteModeInfo (ModeData, Info);\r
\r
  Private->PciIo->GetBarAttributes (\r
                    Private->PciIo,\r
                    Private->FrameBufferVramBarIndex,\r
                    NULL,\r
                    (VOID **)&FrameBufDesc\r
                    );\r
\r
  Mode->FrameBufferBase = FrameBufDesc->AddrRangeMin;\r
  Mode->FrameBufferSize = Info->HorizontalResolution * Info->VerticalResolution;\r
  Mode->FrameBufferSize = Mode->FrameBufferSize * ((ModeData->ColorDepth + 7) / 8);\r
  Mode->FrameBufferSize = EFI_PAGES_TO_SIZE (\r
                            EFI_SIZE_TO_PAGES (Mode->FrameBufferSize)\r
                            );\r
  DEBUG ((\r
    DEBUG_INFO,\r
    "FrameBufferBase: 0x%Lx, FrameBufferSize: 0x%Lx\n",\r
    Mode->FrameBufferBase,\r
    (UINT64)Mode->FrameBufferSize\r
    ));\r
\r
  FreePool (FrameBufDesc);\r
  return EFI_SUCCESS;\r
}\r
\r
//\r
// Graphics Output Protocol Member Functions\r
//\r
EFI_STATUS\r
EFIAPI\r
QemuVideoGraphicsOutputQueryMode (\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
/*++\r
\r
Routine Description:\r
\r
  Graphics Output protocol interface to query video mode\r
\r
  Arguments:\r
    This                  - Protocol instance pointer.\r
    ModeNumber            - The mode number to return information on.\r
    Info                  - Caller allocated buffer that returns information about ModeNumber.\r
    SizeOfInfo            - A pointer to the size, in bytes, of the Info buffer.\r
\r
  Returns:\r
    EFI_SUCCESS           - Mode information returned.\r
    EFI_BUFFER_TOO_SMALL  - The Info buffer was too small.\r
    EFI_DEVICE_ERROR      - A hardware error occurred trying to retrieve the video mode.\r
    EFI_NOT_STARTED       - Video display is not initialized. Call SetMode ()\r
    EFI_INVALID_PARAMETER - One of the input args was NULL.\r
\r
--*/\r
{\r
  QEMU_VIDEO_PRIVATE_DATA  *Private;\r
  QEMU_VIDEO_MODE_DATA     *ModeData;\r
\r
  Private = QEMU_VIDEO_PRIVATE_DATA_FROM_GRAPHICS_OUTPUT_THIS (This);\r
\r
  if ((Info == NULL) || (SizeOfInfo == NULL) || (ModeNumber >= This->Mode->MaxMode)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  *Info = AllocatePool (sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION));\r
  if (*Info == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  *SizeOfInfo = sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION);\r
\r
  ModeData                      = &Private->ModeData[ModeNumber];\r
  (*Info)->HorizontalResolution = ModeData->HorizontalResolution;\r
  (*Info)->VerticalResolution   = ModeData->VerticalResolution;\r
  QemuVideoCompleteModeInfo (ModeData, *Info);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
QemuVideoGraphicsOutputSetMode (\r
  IN  EFI_GRAPHICS_OUTPUT_PROTOCOL  *This,\r
  IN  UINT32                        ModeNumber\r
  )\r
\r
/*++\r
\r
Routine Description:\r
\r
  Graphics Output protocol interface to set video mode\r
\r
  Arguments:\r
    This             - Protocol instance pointer.\r
    ModeNumber       - The mode number to be set.\r
\r
  Returns:\r
    EFI_SUCCESS      - Graphics mode was changed.\r
    EFI_DEVICE_ERROR - The device had an error and could not complete the request.\r
    EFI_UNSUPPORTED  - ModeNumber is not supported by this device.\r
\r
--*/\r
{\r
  QEMU_VIDEO_PRIVATE_DATA        *Private;\r
  QEMU_VIDEO_MODE_DATA           *ModeData;\r
  RETURN_STATUS                  Status;\r
  EFI_GRAPHICS_OUTPUT_BLT_PIXEL  Black;\r
\r
  Private = QEMU_VIDEO_PRIVATE_DATA_FROM_GRAPHICS_OUTPUT_THIS (This);\r
\r
  if (ModeNumber >= This->Mode->MaxMode) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  ModeData = &Private->ModeData[ModeNumber];\r
\r
  switch (Private->Variant) {\r
    case QEMU_VIDEO_CIRRUS_5430:\r
    case QEMU_VIDEO_CIRRUS_5446:\r
      InitializeCirrusGraphicsMode (Private, &QemuVideoCirrusModes[ModeData->InternalModeIndex]);\r
      break;\r
    case QEMU_VIDEO_BOCHS_MMIO:\r
    case QEMU_VIDEO_BOCHS:\r
      InitializeBochsGraphicsMode (Private, &QemuVideoBochsModes[ModeData->InternalModeIndex]);\r
      break;\r
    default:\r
      ASSERT (FALSE);\r
      return EFI_DEVICE_ERROR;\r
  }\r
\r
  This->Mode->Mode                       = ModeNumber;\r
  This->Mode->Info->HorizontalResolution = ModeData->HorizontalResolution;\r
  This->Mode->Info->VerticalResolution   = ModeData->VerticalResolution;\r
  This->Mode->SizeOfInfo                 = sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION);\r
\r
  QemuVideoCompleteModeData (Private, This->Mode);\r
\r
  //\r
  // Re-initialize the frame buffer configure when mode changes.\r
  //\r
  Status = FrameBufferBltConfigure (\r
             (VOID *)(UINTN)This->Mode->FrameBufferBase,\r
             This->Mode->Info,\r
             Private->FrameBufferBltConfigure,\r
             &Private->FrameBufferBltConfigureSize\r
             );\r
  if (Status == RETURN_BUFFER_TOO_SMALL) {\r
    //\r
    // Frame buffer configure may be larger in new mode.\r
    //\r
    if (Private->FrameBufferBltConfigure != NULL) {\r
      FreePool (Private->FrameBufferBltConfigure);\r
    }\r
\r
    Private->FrameBufferBltConfigure =\r
      AllocatePool (Private->FrameBufferBltConfigureSize);\r
    ASSERT (Private->FrameBufferBltConfigure != NULL);\r
\r
    //\r
    // Create the configuration for FrameBufferBltLib\r
    //\r
    Status = FrameBufferBltConfigure (\r
               (VOID *)(UINTN)This->Mode->FrameBufferBase,\r
               This->Mode->Info,\r
               Private->FrameBufferBltConfigure,\r
               &Private->FrameBufferBltConfigureSize\r
               );\r
  }\r
\r
  ASSERT (Status == RETURN_SUCCESS);\r
\r
  //\r
  // Per UEFI Spec, need to clear the visible portions of the output display to black.\r
  //\r
  ZeroMem (&Black, sizeof (Black));\r
  Status = FrameBufferBlt (\r
             Private->FrameBufferBltConfigure,\r
             &Black,\r
             EfiBltVideoFill,\r
             0,\r
             0,\r
             0,\r
             0,\r
             This->Mode->Info->HorizontalResolution,\r
             This->Mode->Info->VerticalResolution,\r
             0\r
             );\r
  ASSERT_RETURN_ERROR (Status);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
QemuVideoGraphicsOutputBlt (\r
  IN  EFI_GRAPHICS_OUTPUT_PROTOCOL       *This,\r
  IN  EFI_GRAPHICS_OUTPUT_BLT_PIXEL      *BltBuffer  OPTIONAL,\r
  IN  EFI_GRAPHICS_OUTPUT_BLT_OPERATION  BltOperation,\r
  IN  UINTN                              SourceX,\r
  IN  UINTN                              SourceY,\r
  IN  UINTN                              DestinationX,\r
  IN  UINTN                              DestinationY,\r
  IN  UINTN                              Width,\r
  IN  UINTN                              Height,\r
  IN  UINTN                              Delta\r
  )\r
\r
/*++\r
\r
Routine Description:\r
\r
  Graphics Output protocol instance to block transfer for CirrusLogic device\r
\r
Arguments:\r
\r
  This          - Pointer to Graphics Output protocol instance\r
  BltBuffer     - The data to transfer to screen\r
  BltOperation  - The operation to perform\r
  SourceX       - The X coordinate of the source for BltOperation\r
  SourceY       - The Y coordinate of the source for BltOperation\r
  DestinationX  - The X coordinate of the destination for BltOperation\r
  DestinationY  - The Y coordinate of the destination for BltOperation\r
  Width         - The width of a rectangle in the blt rectangle in pixels\r
  Height        - The height of a rectangle in the blt rectangle in pixels\r
  Delta         - Not used for EfiBltVideoFill and EfiBltVideoToVideo operation.\r
                  If a Delta of 0 is used, the entire BltBuffer will be operated on.\r
                  If a subrectangle of the BltBuffer is used, then Delta represents\r
                  the number of bytes in a row of the BltBuffer.\r
\r
Returns:\r
\r
  EFI_INVALID_PARAMETER - Invalid parameter passed in\r
  EFI_SUCCESS - Blt operation success\r
\r
--*/\r
{\r
  EFI_STATUS               Status;\r
  EFI_TPL                  OriginalTPL;\r
  QEMU_VIDEO_PRIVATE_DATA  *Private;\r
\r
  Private = QEMU_VIDEO_PRIVATE_DATA_FROM_GRAPHICS_OUTPUT_THIS (This);\r
  //\r
  // We have to raise to TPL Notify, so we make an atomic write the frame buffer.\r
  // We would not want a timer based event (Cursor, ...) to come in while we are\r
  // doing this operation.\r
  //\r
  OriginalTPL = gBS->RaiseTPL (TPL_NOTIFY);\r
\r
  switch (BltOperation) {\r
    case EfiBltVideoToBltBuffer:\r
    case EfiBltBufferToVideo:\r
    case EfiBltVideoFill:\r
    case EfiBltVideoToVideo:\r
      Status = FrameBufferBlt (\r
                 Private->FrameBufferBltConfigure,\r
                 BltBuffer,\r
                 BltOperation,\r
                 SourceX,\r
                 SourceY,\r
                 DestinationX,\r
                 DestinationY,\r
                 Width,\r
                 Height,\r
                 Delta\r
                 );\r
      break;\r
\r
    default:\r
      Status = EFI_INVALID_PARAMETER;\r
      break;\r
  }\r
\r
  gBS->RestoreTPL (OriginalTPL);\r
\r
  return Status;\r
}\r
\r
EFI_STATUS\r
QemuVideoGraphicsOutputConstructor (\r
  QEMU_VIDEO_PRIVATE_DATA  *Private\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  EFI_GRAPHICS_OUTPUT_PROTOCOL  *GraphicsOutput;\r
\r
  GraphicsOutput            = &Private->GraphicsOutput;\r
  GraphicsOutput->QueryMode = QemuVideoGraphicsOutputQueryMode;\r
  GraphicsOutput->SetMode   = QemuVideoGraphicsOutputSetMode;\r
  GraphicsOutput->Blt       = QemuVideoGraphicsOutputBlt;\r
\r
  //\r
  // Initialize the private data\r
  //\r
  Status = gBS->AllocatePool (\r
                  EfiBootServicesData,\r
                  sizeof (EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE),\r
                  (VOID **)&Private->GraphicsOutput.Mode\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = gBS->AllocatePool (\r
                  EfiBootServicesData,\r
                  sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION),\r
                  (VOID **)&Private->GraphicsOutput.Mode->Info\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto FreeMode;\r
  }\r
\r
  Private->GraphicsOutput.Mode->MaxMode = (UINT32)Private->MaxMode;\r
  Private->GraphicsOutput.Mode->Mode    = GRAPHICS_OUTPUT_INVALIDE_MODE_NUMBER;\r
  Private->FrameBufferBltConfigure      = NULL;\r
  Private->FrameBufferBltConfigureSize  = 0;\r
\r
  //\r
  // Initialize the hardware\r
  //\r
  Status = GraphicsOutput->SetMode (GraphicsOutput, 0);\r
  if (EFI_ERROR (Status)) {\r
    goto FreeInfo;\r
  }\r
\r
  DrawLogo (\r
    Private,\r
    Private->ModeData[Private->GraphicsOutput.Mode->Mode].HorizontalResolution,\r
    Private->ModeData[Private->GraphicsOutput.Mode->Mode].VerticalResolution\r
    );\r
\r
  return EFI_SUCCESS;\r
\r
FreeInfo:\r
  FreePool (Private->GraphicsOutput.Mode->Info);\r
\r
FreeMode:\r
  FreePool (Private->GraphicsOutput.Mode);\r
  Private->GraphicsOutput.Mode = NULL;\r
\r
  return Status;\r
}\r
\r
EFI_STATUS\r
QemuVideoGraphicsOutputDestructor (\r
  QEMU_VIDEO_PRIVATE_DATA  *Private\r
  )\r
\r
/*++\r
\r
Routine Description:\r
\r
Arguments:\r
\r
Returns:\r
\r
  None\r
\r
--*/\r
{\r
  if (Private->FrameBufferBltConfigure != NULL) {\r
    FreePool (Private->FrameBufferBltConfigure);\r
  }\r
\r
  if (Private->GraphicsOutput.Mode != NULL) {\r
    if (Private->GraphicsOutput.Mode->Info != NULL) {\r
      gBS->FreePool (Private->GraphicsOutput.Mode->Info);\r
    }\r
\r
    gBS->FreePool (Private->GraphicsOutput.Mode);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r