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 - 2008, 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 **/
  16
  17 #ifndef __GRAPHICS_OUTPUT_H__
  18 #define __GRAPHICS_OUTPUT_H__
  19
  20 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
  21   { \
  22     0x9042a9de, 0x23dc, 0x4a38, {0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a } \
  23   }
  24
  25 typedef struct _EFI_GRAPHICS_OUTPUT_PROTOCOL EFI_GRAPHICS_OUTPUT_PROTOCOL;
  26
  27 typedef struct {
  28   UINT32            RedMask;
  29   UINT32            GreenMask;
  30   UINT32            BlueMask;
  31   UINT32            ReservedMask;
  32 } EFI_PIXEL_BITMASK;
  33
  34 typedef enum {
  35   ///
  36   /// A pixel is 32-bits and byte zero represents red, byte one represents green,
  37   /// byte two represents blue, and byte three is reserved. This is the definition
  38   /// for the physical frame buffer. The byte values for the red, green, and blue
  39   /// components represent the color intensity. This color intensity value range
  40   /// from a minimum intensity of 0 to maximum intensity of 255.
  41   ///
  42   PixelRedGreenBlueReserved8BitPerColor,
  43   ///
  44   /// A pixel is 32-bits and byte zero represents blue, byte one represents green,
  45   /// byte two represents red, and byte three is reserved. This is the definition
  46   /// for the physical frame buffer. The byte values for the red, green, and blue
  47   /// components represent the color intensity. This color intensity value range
  48   /// from a minimum intensity of 0 to maximum intensity of 255.
  49   ///
  50   PixelBlueGreenRedReserved8BitPerColor,
  51   ///
  52   /// The Pixel definition of the physical frame buffer.
  53   ///
  54   PixelBitMask,
  55   ///
  56   /// This mode does not support a physical frame buffer.
  57   ///
  58   PixelBltOnly,
  59   ///
  60   /// Valid EFI_GRAPHICS_PIXEL_FORMAT enum values are less than this value.
  61   ///
  62   PixelFormatMax
  63 } EFI_GRAPHICS_PIXEL_FORMAT;
  64
  65 typedef struct {
  66   ///
  67   /// The version of this data structure. A value of zero represents the
  68   /// EFI_GRAPHICS_OUTPUT_MODE_INFORMATION structure as defined in this specification.
  69   ///
  70   UINT32                     Version;
  71   ///
  72   /// The size of video screen in pixels in the X dimension.
  73   ///
  74   UINT32                     HorizontalResolution;
  75   ///
  76   /// The size of video screen in pixels in the Y dimension.
  77   ///
  78   UINT32                     VerticalResolution;
  79   ///
  80   /// Enumeration that defines the physical format of the pixel. A value of PixelBltOnly
  81   /// implies that a linear frame buffer is not available for this mode.
  82   ///
  83   EFI_GRAPHICS_PIXEL_FORMAT  PixelFormat;
  84   ///
  85   /// This bit-mask is only valid if PixelFormat is set to PixelPixelBitMask.
  86   /// A bit being set defines what bits are used for what purpose such as Red, Green, Blue, or Reserved.
  87   ///
  88   EFI_PIXEL_BITMASK          PixelInformation;
  89   ///
  90   /// Defines the number of pixel elements per video memory line.
  91   ///
  92   UINT32                     PixelsPerScanLine;
  93 } EFI_GRAPHICS_OUTPUT_MODE_INFORMATION;
  94
  95 /**
  96   Return the current video mode information.
  97
  98   @param  This       Protocol instance pointer.
  99   @param  ModeNumber The mode number to return information on.
 100   @param  SizeOfInfo A pointer to the size, in bytes, of the Info buffer.
 101   @param  Info       A pointer to callee allocated buffer that returns information about ModeNumber.
 102
 103   @retval EFI_SUCCESS           Mode information returned.
 104   @retval EFI_BUFFER_TOO_SMALL  The Info buffer was too small.
 105   @retval EFI_DEVICE_ERROR      A hardware error occurred trying to retrieve the video mode.
 106   @retval EFI_NOT_STARTED       Video display is not initialized. Call SetMode ()
 107   @retval EFI_INVALID_PARAMETER One of the input args was NULL.
 108
 109 **/
 110 typedef
 111 EFI_STATUS
 112 (EFIAPI *EFI_GRAPHICS_OUTPUT_PROTOCOL_QUERY_MODE)(
 113   IN  EFI_GRAPHICS_OUTPUT_PROTOCOL          *This,
 114   IN  UINT32                                ModeNumber,
 115   OUT UINTN                                 *SizeOfInfo,
 116   OUT EFI_GRAPHICS_OUTPUT_MODE_INFORMATION  **Info
 117   );
 118
 119 /**
 120   Return the current video mode information.
 121
 122   @param  This              Protocol instance pointer.
 123   @param  ModeNumber        The mode number to be set.
 124
 125   @retval EFI_SUCCESS       Graphics mode was changed.
 126   @retval EFI_DEVICE_ERROR  The device had an error and could not complete the request.
 127   @retval EFI_UNSUPPORTED   ModeNumber is not supported by this device.
 128
 129 **/
 130 typedef
 131 EFI_STATUS
 132 (EFIAPI *EFI_GRAPHICS_OUTPUT_PROTOCOL_SET_MODE)(
 133   IN  EFI_GRAPHICS_OUTPUT_PROTOCOL *This,
 134   IN  UINT32                       ModeNumber
 135   );
 136
 137 typedef struct {
 138   UINT8 Blue;
 139   UINT8 Green;
 140   UINT8 Red;
 141   UINT8 Reserved;
 142 } EFI_GRAPHICS_OUTPUT_BLT_PIXEL;
 143
 144 typedef union {
 145   EFI_GRAPHICS_OUTPUT_BLT_PIXEL Pixel;
 146   UINT32                        Raw;
 147 } EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION;
 148
 149 ///
 150 /// actions for BltOperations
 151 ///
 152 typedef enum {
 153   ///
 154   /// Write data from the  BltBuffer pixel (SourceX, SourceY)
 155   /// directly to every pixel of the video display rectangle
 156   /// (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height).
 157   /// Only one pixel will be used from the BltBuffer. Delta is NOT used.
 158   ///
 159   EfiBltVideoFill,
 160
 161   ///
 162   /// Read data from the video display rectangle
 163   /// (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in
 164   /// the BltBuffer rectangle (DestinationX, DestinationY )
 165   /// (DestinationX + Width, DestinationY + Height). If DestinationX or
 166   /// DestinationY is not zero then Delta must be set to the length in bytes
 167   /// of a row in the BltBuffer.
 168   ///
 169   EfiBltVideoToBltBuffer,
 170
 171   ///
 172   /// Write data from the  BltBuffer rectangle
 173   /// (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the
 174   /// video display rectangle (DestinationX, DestinationY)
 175   /// (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is
 176   /// not zero then Delta must be set to the length in bytes of a row in the
 177   /// BltBuffer.
 178   ///
 179   EfiBltBufferToVideo,
 180
 181   ///
 182   /// Copy from the video display rectangle (SourceX, SourceY)
 183   /// (SourceX + Width, SourceY + Height) .to the video display rectangle
 184   /// (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height).
 185   /// The BltBuffer and Delta  are not used in this mode.
 186   /// EfiBltVideoToVideo,
 187   ///
 188   EfiBltVideoToVideo,
 189
 190   EfiGraphicsOutputBltOperationMax
 191 } EFI_GRAPHICS_OUTPUT_BLT_OPERATION;
 192
 193 /**
 194   Blt a rectangle of pixels on the graphics screen. Blt stands for BLock Transfer.
 195
 196   @param  This         Protocol instance pointer.
 197   @param  BltBuffer    Buffer containing data to blit into video buffer. This
 198                        buffer has a size of Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL)
 199   @param  BltOperation Operation to perform on BlitBuffer and video memory
 200   @param  SourceX      X coordinate of source for the BltBuffer.
 201   @param  SourceY      Y coordinate of source for the BltBuffer.
 202   @param  DestinationX X coordinate of destination for the BltBuffer.
 203   @param  DestinationY Y coordinate of destination for the BltBuffer.
 204   @param  Width        Width of rectangle in BltBuffer in pixels.
 205   @param  Height       Hight of rectangle in BltBuffer in pixels.
 206   @param  Delta        OPTIONAL
 207
 208   @retval EFI_SUCCESS           The Blt operation completed.
 209   @retval EFI_INVALID_PARAMETER BltOperation is not valid.
 210   @retval EFI_DEVICE_ERROR      A hardware error occured writting to the video buffer.
 211
 212 **/
 213 typedef
 214 EFI_STATUS
 215 (EFIAPI *EFI_GRAPHICS_OUTPUT_PROTOCOL_BLT)(
 216   IN  EFI_GRAPHICS_OUTPUT_PROTOCOL            *This,
 217   IN  EFI_GRAPHICS_OUTPUT_BLT_PIXEL           *BltBuffer,   OPTIONAL
 218   IN  EFI_GRAPHICS_OUTPUT_BLT_OPERATION       BltOperation,
 219   IN  UINTN                                   SourceX,
 220   IN  UINTN                                   SourceY,
 221   IN  UINTN                                   DestinationX,
 222   IN  UINTN                                   DestinationY,
 223   IN  UINTN                                   Width,
 224   IN  UINTN                                   Height,
 225   IN  UINTN                                   Delta         OPTIONAL
 226   );
 227
 228 typedef struct {
 229   ///
 230   /// The number of modes supported by QueryMode() and SetMode().
 231   ///
 232   UINT32                                 MaxMode;
 233   ///
 234   /// Current Mode of the graphics device. Valid mode numbers are 0 to MaxMode -1.
 235   ///
 236   UINT32                                 Mode;
 237   ///
 238   /// Pointer to read-only EFI_GRAPHICS_OUTPUT_MODE_INFORMATION data.
 239   ///
 240   EFI_GRAPHICS_OUTPUT_MODE_INFORMATION   *Info;
 241   ///
 242   /// Size of Info structure in bytes.
 243   ///
 244   UINTN                                  SizeOfInfo;
 245   ///
 246   /// Base address of graphics linear frame buffer.
 247   /// Offset zero in FrameBufferBase represents the upper left pixel of the display.
 248   ///
 249   EFI_PHYSICAL_ADDRESS                   FrameBufferBase;
 250   ///
 251   /// Size of the frame buffer represented by FrameBufferBase in bytes.
 252   ///
 253   UINTN                                  FrameBufferSize;
 254 } EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE;
 255
 256 ///
 257 /// Provides a basic abstraction to set video modes and copy pixels to and from
 258 /// the graphics controller's frame buffer. The linear address of the hardware
 259 /// frame buffer is also exposed so software can write directly to the video hardware.
 260 ///
 261 struct _EFI_GRAPHICS_OUTPUT_PROTOCOL {
 262   EFI_GRAPHICS_OUTPUT_PROTOCOL_QUERY_MODE  QueryMode;
 263   EFI_GRAPHICS_OUTPUT_PROTOCOL_SET_MODE    SetMode;
 264   EFI_GRAPHICS_OUTPUT_PROTOCOL_BLT         Blt;
 265   ///
 266   /// Pointer to EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE data.
 267   ///
 268   EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE        *Mode;
 269 };
 270
 271 extern EFI_GUID gEfiGraphicsOutputProtocolGuid;
 272
 273 #endif