MdePkg/Include/Protocol/GraphicsOutput.h

   1 /** @file
   2   Graphics Output Protocol from the UEFI 2.0 specification.
   3
   4   Abstraction of a very simple graphics device.
   5
   6   Copyright (c) 2006, Intel Corporation
   7   All rights reserved. This program and the accompanying materials
   8   are licensed and made available under the terms and conditions of the BSD License
   9   which accompanies this distribution.  The full text of the license may be found at
  10   http://opensource.org/licenses/bsd-license.php
  11
  12   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15   Module Name:  GraphicsOutput.h
  16
  17 **/
  18
  19 #ifndef __GRAPHICS_OUTPUT_H__
  20 #define __GRAPHICS_OUTPUT_H__
  21
  22 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
  23   { \
  24     0x9042a9de, 0x23dc, 0x4a38, {0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a } \
  25   }
  26
  27 typedef struct _EFI_GRAPHICS_OUTPUT_PROTOCOL EFI_GRAPHICS_OUTPUT_PROTOCOL;
  28
  29 typedef struct {
  30   UINT32            RedMask;
  31   UINT32            GreenMask;
  32   UINT32            BlueMask;
  33   UINT32            ReservedMask;
  34 } EFI_PIXEL_BITMASK;
  35
  36 typedef enum {
  37   PixelRedGreenBlueReserved8BitPerColor,
  38   PixelBlueGreenRedReserved8BitPerColor,
  39   PixelBitMask,
  40   PixelBltOnly,
  41   PixelFormatMax
  42 } EFI_GRAPHICS_PIXEL_FORMAT;
  43
  44 typedef struct {
  45   UINT32                     Version;
  46   UINT32                     HorizontalResolution;
  47   UINT32                     VerticalResolution;
  48   EFI_GRAPHICS_PIXEL_FORMAT  PixelFormat;
  49   EFI_PIXEL_BITMASK          PixelInformation;
  50   UINT32                     PixelsPerScanLine;
  51 } EFI_GRAPHICS_OUTPUT_MODE_INFORMATION;
  52
  53 /**
  54   Return the current video mode information.
  55
  56   @param  This       Protocol instance pointer.
  57   @param  ModeNumber The mode number to return information on.
  58   @param  SizeOfInfo A pointer to the size, in bytes, of the Info buffer.
  59   @param  Info       A pointer to callee allocated buffer that returns information about ModeNumber.
  60
  61   @retval EFI_SUCCESS           Mode information returned.
  62   @retval EFI_BUFFER_TOO_SMALL  The Info buffer was too small.
  63   @retval EFI_DEVICE_ERROR      A hardware error occurred trying to retrieve the video mode.
  64   @retval EFI_NOT_STARTED       Video display is not initialized. Call SetMode ()
  65   @retval EFI_INVALID_PARAMETER One of the input args was NULL.
  66
  67 **/
  68 typedef
  69 EFI_STATUS
  70 (EFIAPI *EFI_GRAPHICS_OUTPUT_PROTOCOL_QUERY_MODE) (
  71   IN  EFI_GRAPHICS_OUTPUT_PROTOCOL          *This,
  72   IN  UINT32                                ModeNumber,
  73   OUT UINTN                                 *SizeOfInfo,
  74   OUT EFI_GRAPHICS_OUTPUT_MODE_INFORMATION  **Info
  75   )
  76 ;
  77
  78 /**
  79   Return the current video mode information.
  80
  81   @param  This              Protocol instance pointer.
  82   @param  ModeNumber        The mode number to be set.
  83
  84   @retval EFI_SUCCESS       Graphics mode was changed.
  85   @retval EFI_DEVICE_ERROR  The device had an error and could not complete the request.
  86   @retval EFI_UNSUPPORTED   ModeNumber is not supported by this device.
  87
  88 **/
  89 typedef
  90 EFI_STATUS
  91 (EFIAPI *EFI_GRAPHICS_OUTPUT_PROTOCOL_SET_MODE) (
  92   IN  EFI_GRAPHICS_OUTPUT_PROTOCOL *This,
  93   IN  UINT32                       ModeNumber
  94   )
  95 ;
  96
  97 typedef struct {
  98   UINT8 Blue;
  99   UINT8 Green;
 100   UINT8 Red;
 101   UINT8 Reserved;
 102 } EFI_GRAPHICS_OUTPUT_BLT_PIXEL;
 103
 104 typedef union {
 105   EFI_GRAPHICS_OUTPUT_BLT_PIXEL Pixel;
 106   UINT32                        Raw;
 107 } EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION;
 108
 109 typedef enum {
 110   EfiBltVideoFill,
 111   EfiBltVideoToBltBuffer,
 112   EfiBltBufferToVideo,
 113   EfiBltVideoToVideo,
 114   EfiGraphicsOutputBltOperationMax
 115 } EFI_GRAPHICS_OUTPUT_BLT_OPERATION;
 116
 117 /**
 118   The following table defines actions for BltOperations:
 119
 120   <B>EfiBltVideoFill</B> - Write data from the  BltBuffer pixel (SourceX, SourceY)
 121   directly to every pixel of the video display rectangle
 122   (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height).
 123   Only one pixel will be used from the BltBuffer. Delta is NOT used.
 124
 125   <B>EfiBltVideoToBltBuffer</B> - Read data from the video display rectangle
 126   (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in
 127   the BltBuffer rectangle (DestinationX, DestinationY )
 128   (DestinationX + Width, DestinationY + Height). If DestinationX or
 129   DestinationY is not zero then Delta must be set to the length in bytes
 130   of a row in the BltBuffer.
 131
 132   <B>EfiBltBufferToVideo</B> - Write data from the  BltBuffer rectangle
 133   (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the
 134   video display rectangle (DestinationX, DestinationY)
 135   (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is
 136   not zero then Delta must be set to the length in bytes of a row in the
 137   BltBuffer.
 138
 139   <B>EfiBltVideoToVideo</B> - Copy from the video display rectangle (SourceX, SourceY)
 140   (SourceX + Width, SourceY + Height) .to the video display rectangle
 141   (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height).
 142   The BltBuffer and Delta  are not used in this mode.
 143
 144   @param  This         Protocol instance pointer.
 145   @param  BltBuffer    Buffer containing data to blit into video buffer. This
 146                        buffer has a size of Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL)
 147   @param  BltOperation Operation to perform on BlitBuffer and video memory
 148   @param  SourceX      X coordinate of source for the BltBuffer.
 149   @param  SourceY      Y coordinate of source for the BltBuffer.
 150   @param  DestinationX X coordinate of destination for the BltBuffer.
 151   @param  DestinationY Y coordinate of destination for the BltBuffer.
 152   @param  Width        Width of rectangle in BltBuffer in pixels.
 153   @param  Height       Hight of rectangle in BltBuffer in pixels.
 154   @param  Delta        OPTIONAL
 155
 156   @retval EFI_SUCCESS           The Blt operation completed.
 157   @retval EFI_INVALID_PARAMETER BltOperation is not valid.
 158   @retval EFI_DEVICE_ERROR      A hardware error occured writting to the video buffer.
 159
 160 **/
 161 typedef
 162 EFI_STATUS
 163 (EFIAPI *EFI_GRAPHICS_OUTPUT_PROTOCOL_BLT) (
 164   IN  EFI_GRAPHICS_OUTPUT_PROTOCOL            *This,
 165   IN  EFI_GRAPHICS_OUTPUT_BLT_PIXEL           *BltBuffer,   OPTIONAL
 166   IN  EFI_GRAPHICS_OUTPUT_BLT_OPERATION       BltOperation,
 167   IN  UINTN                                   SourceX,
 168   IN  UINTN                                   SourceY,
 169   IN  UINTN                                   DestinationX,
 170   IN  UINTN                                   DestinationY,
 171   IN  UINTN                                   Width,
 172   IN  UINTN                                   Height,
 173   IN  UINTN                                   Delta         OPTIONAL
 174   );
 175
 176 typedef struct {
 177   UINT32                                 MaxMode;
 178   UINT32                                 Mode;
 179   EFI_GRAPHICS_OUTPUT_MODE_INFORMATION   *Info;
 180   UINTN                                  SizeOfInfo;
 181   EFI_PHYSICAL_ADDRESS                   FrameBufferBase;
 182   UINTN                                  FrameBufferSize;
 183 } EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE;
 184
 185 struct _EFI_GRAPHICS_OUTPUT_PROTOCOL {
 186   EFI_GRAPHICS_OUTPUT_PROTOCOL_QUERY_MODE  QueryMode;
 187   EFI_GRAPHICS_OUTPUT_PROTOCOL_SET_MODE    SetMode;
 188   EFI_GRAPHICS_OUTPUT_PROTOCOL_BLT         Blt;
 189   EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE        *Mode;
 190 };
 191
 192 extern EFI_GUID gEfiGraphicsOutputProtocolGuid;
 193
 194 #endif