MdeModulePkg/Universal/Console/GraphicsConsoleDxe/GraphicsConsole.h

   1 /** @file
   2   Header file for GraphicsConsole driver.
   3
   4 Copyright (c) 2006, Intel Corporation. <BR>
   5 All rights reserved. This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _GRAPHICS_CONSOLE_H
  16 #define _GRAPHICS_CONSOLE_H
  17
  18 #include <PiDxe.h>
  19 #include <Protocol/SimpleTextOut.h>
  20 #include <Protocol/GraphicsOutput.h>
  21 #include <Protocol/UgaDraw.h>
  22 #include <Protocol/DevicePath.h>
  23 #include <Library/DebugLib.h>
  24 #include <Library/UefiDriverEntryPoint.h>
  25 #include <Library/UefiLib.h>
  26 #include <Library/BaseMemoryLib.h>
  27 #include <Library/MemoryAllocationLib.h>
  28 #include <Library/UefiBootServicesTableLib.h>
  29 #include <Library/HiiLib.h>
  30 #include <Library/BaseLib.h>
  31 #include <Library/PcdLib.h>
  32
  33 #include <MdeModuleHii.h>
  34
  35 #include <Protocol/HiiFont.h>
  36 #include <Protocol/HiiDatabase.h>
  37
  38
  39 extern EFI_COMPONENT_NAME_PROTOCOL   gGraphicsConsoleComponentName;
  40 extern EFI_COMPONENT_NAME2_PROTOCOL  gGraphicsConsoleComponentName2;
  41
  42 //
  43 // EFI Component Name Functions
  44 //
  45 /**
  46   Retrieves a Unicode string that is the user readable name of the driver.
  47
  48   This function retrieves the user readable name of a driver in the form of a
  49   Unicode string. If the driver specified by This has a user readable name in
  50   the language specified by Language, then a pointer to the driver name is
  51   returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
  52   by This does not support the language specified by Language,
  53   then EFI_UNSUPPORTED is returned.
  54
  55   @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
  56                                 EFI_COMPONENT_NAME_PROTOCOL instance.
  57
  58   @param  Language[in]          A pointer to a Null-terminated ASCII string
  59                                 array indicating the language. This is the
  60                                 language of the driver name that the caller is
  61                                 requesting, and it must match one of the
  62                                 languages specified in SupportedLanguages. The
  63                                 number of languages supported by a driver is up
  64                                 to the driver writer. Language is specified
  65                                 in RFC 3066 or ISO 639-2 language code format.
  66
  67   @param  DriverName[out]       A pointer to the Unicode string to return.
  68                                 This Unicode string is the name of the
  69                                 driver specified by This in the language
  70                                 specified by Language.
  71
  72   @retval EFI_SUCCESS           The Unicode string for the Driver specified by
  73                                 This and the language specified by Language was
  74                                 returned in DriverName.
  75
  76   @retval EFI_INVALID_PARAMETER Language is NULL.
  77
  78   @retval EFI_INVALID_PARAMETER DriverName is NULL.
  79
  80   @retval EFI_UNSUPPORTED       The driver specified by This does not support
  81                                 the language specified by Language.
  82
  83 **/
  84 EFI_STATUS
  85 EFIAPI
  86 GraphicsConsoleComponentNameGetDriverName (
  87   IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  88   IN  CHAR8                        *Language,
  89   OUT CHAR16                       **DriverName
  90   );
  91
  92
  93 /**
  94   Retrieves a Unicode string that is the user readable name of the controller
  95   that is being managed by a driver.
  96
  97   This function retrieves the user readable name of the controller specified by
  98   ControllerHandle and ChildHandle in the form of a Unicode string. If the
  99   driver specified by This has a user readable name in the language specified by
 100   Language, then a pointer to the controller name is returned in ControllerName,
 101   and EFI_SUCCESS is returned.  If the driver specified by This is not currently
 102   managing the controller specified by ControllerHandle and ChildHandle,
 103   then EFI_UNSUPPORTED is returned.  If the driver specified by This does not
 104   support the language specified by Language, then EFI_UNSUPPORTED is returned.
 105
 106   @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
 107                                 EFI_COMPONENT_NAME_PROTOCOL instance.
 108
 109   @param  ControllerHandle[in]  The handle of a controller that the driver
 110                                 specified by This is managing.  This handle
 111                                 specifies the controller whose name is to be
 112                                 returned.
 113
 114   @param  ChildHandle[in]       The handle of the child controller to retrieve
 115                                 the name of.  This is an optional parameter that
 116                                 may be NULL.  It will be NULL for device
 117                                 drivers.  It will also be NULL for a bus drivers
 118                                 that wish to retrieve the name of the bus
 119                                 controller.  It will not be NULL for a bus
 120                                 driver that wishes to retrieve the name of a
 121                                 child controller.
 122
 123   @param  Language[in]          A pointer to a Null-terminated ASCII string
 124                                 array indicating the language.  This is the
 125                                 language of the driver name that the caller is
 126                                 requesting, and it must match one of the
 127                                 languages specified in SupportedLanguages. The
 128                                 number of languages supported by a driver is up
 129                                 to the driver writer. Language is specified in
 130                                 RFC 3066 or ISO 639-2 language code format.
 131
 132   @param  ControllerName[out]   A pointer to the Unicode string to return.
 133                                 This Unicode string is the name of the
 134                                 controller specified by ControllerHandle and
 135                                 ChildHandle in the language specified by
 136                                 Language from the point of view of the driver
 137                                 specified by This.
 138
 139   @retval EFI_SUCCESS           The Unicode string for the user readable name in
 140                                 the language specified by Language for the
 141                                 driver specified by This was returned in
 142                                 DriverName.
 143
 144   @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
 145
 146   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
 147                                 EFI_HANDLE.
 148
 149   @retval EFI_INVALID_PARAMETER Language is NULL.
 150
 151   @retval EFI_INVALID_PARAMETER ControllerName is NULL.
 152
 153   @retval EFI_UNSUPPORTED       The driver specified by This is not currently
 154                                 managing the controller specified by
 155                                 ControllerHandle and ChildHandle.
 156
 157   @retval EFI_UNSUPPORTED       The driver specified by This does not support
 158                                 the language specified by Language.
 159
 160 **/
 161 EFI_STATUS
 162 EFIAPI
 163 GraphicsConsoleComponentNameGetControllerName (
 164   IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,
 165   IN  EFI_HANDLE                                      ControllerHandle,
 166   IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,
 167   IN  CHAR8                                           *Language,
 168   OUT CHAR16                                          **ControllerName
 169   );
 170
 171
 172 //
 173 // User can define valid graphic resolution here
 174 // e.g. 640x480, 800x600, 1024x768...
 175 //
 176 #define CURRENT_HORIZONTAL_RESOLUTION  800
 177 #define CURRENT_VERTICAL_RESOLUTION    600
 178
 179 typedef union {
 180   EFI_NARROW_GLYPH  NarrowGlyph;
 181   EFI_WIDE_GLYPH    WideGlyph;
 182 } GLYPH_UNION;
 183
 184 extern EFI_NARROW_GLYPH  UsStdNarrowGlyphData[];
 185 extern EFI_WIDE_GLYPH    UsStdWideGlyphData[];
 186
 187 //
 188 // Device Structure
 189 //
 190 #define GRAPHICS_CONSOLE_DEV_SIGNATURE  EFI_SIGNATURE_32 ('g', 's', 't', 'o')
 191
 192 typedef struct {
 193   UINTN   Columns;
 194   UINTN   Rows;
 195   INTN    DeltaX;
 196   INTN    DeltaY;
 197   UINT32  GopWidth;
 198   UINT32  GopHeight;
 199   UINT32  GopModeNumber;
 200 } GRAPHICS_CONSOLE_MODE_DATA;
 201
 202 #define GRAPHICS_MAX_MODE 4
 203
 204 typedef struct {
 205   UINTN                            Signature;
 206   EFI_GRAPHICS_OUTPUT_PROTOCOL     *GraphicsOutput;
 207   EFI_UGA_DRAW_PROTOCOL            *UgaDraw;
 208   EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  SimpleTextOutput;
 209   EFI_SIMPLE_TEXT_OUTPUT_MODE      SimpleTextOutputMode;
 210   GRAPHICS_CONSOLE_MODE_DATA       ModeData[GRAPHICS_MAX_MODE];
 211   EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *LineBuffer;
 212   EFI_HII_HANDLE                   HiiHandle;
 213 } GRAPHICS_CONSOLE_DEV;
 214
 215 #define GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS(a) \
 216   CR (a, GRAPHICS_CONSOLE_DEV, SimpleTextOutput, GRAPHICS_CONSOLE_DEV_SIGNATURE)
 217
 218 //
 219 // Global Variables
 220 //
 221 extern EFI_DRIVER_BINDING_PROTOCOL   gGraphicsConsoleDriverBinding;
 222
 223 //
 224 // Prototypes
 225 //
 226 UINTN
 227 ReturnNarrowFontSize (
 228   VOID
 229   );
 230
 231 UINTN
 232 ReturnWideFontSize (
 233   VOID
 234   );
 235
 236 EFI_STATUS
 237 EFIAPI
 238 GraphicsConsoleConOutReset (
 239   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL    *This,
 240   IN  BOOLEAN                            ExtendedVerification
 241   );
 242
 243 EFI_STATUS
 244 EFIAPI
 245 GraphicsConsoleConOutOutputString (
 246   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,
 247   IN  CHAR16                           *WString
 248   );
 249
 250 EFI_STATUS
 251 EFIAPI
 252 GraphicsConsoleConOutTestString (
 253   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,
 254   IN  CHAR16                           *WString
 255   );
 256
 257 EFI_STATUS
 258 EFIAPI
 259 GraphicsConsoleConOutQueryMode (
 260   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,
 261   IN  UINTN                            ModeNumber,
 262   OUT UINTN                            *Columns,
 263   OUT UINTN                            *Rows
 264   );
 265
 266 EFI_STATUS
 267 EFIAPI
 268 GraphicsConsoleConOutSetMode (
 269   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,
 270   IN  UINTN                            ModeNumber
 271   );
 272
 273 EFI_STATUS
 274 EFIAPI
 275 GraphicsConsoleConOutSetAttribute (
 276   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,
 277   IN  UINTN                            Attribute
 278   );
 279
 280 EFI_STATUS
 281 EFIAPI
 282 GraphicsConsoleConOutClearScreen (
 283   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This
 284   );
 285
 286 EFI_STATUS
 287 EFIAPI
 288 GraphicsConsoleConOutSetCursorPosition (
 289   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,
 290   IN  UINTN                            Column,
 291   IN  UINTN                            Row
 292   );
 293
 294 EFI_STATUS
 295 EFIAPI
 296 GraphicsConsoleConOutEnableCursor (
 297   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,
 298   IN  BOOLEAN                          Visible
 299   );
 300
 301 EFI_STATUS
 302 EFIAPI
 303 GraphicsConsoleControllerDriverSupported (
 304   IN EFI_DRIVER_BINDING_PROTOCOL    *This,
 305   IN EFI_HANDLE                     Controller,
 306   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath
 307   );
 308
 309 EFI_STATUS
 310 EFIAPI
 311 GraphicsConsoleControllerDriverStart (
 312   IN EFI_DRIVER_BINDING_PROTOCOL    *This,
 313   IN EFI_HANDLE                     Controller,
 314   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath
 315   );
 316
 317 EFI_STATUS
 318 EFIAPI
 319 GraphicsConsoleControllerDriverStop (
 320   IN  EFI_DRIVER_BINDING_PROTOCOL    *This,
 321   IN  EFI_HANDLE                     Controller,
 322   IN  UINTN                          NumberOfChildren,
 323   IN  EFI_HANDLE                     *ChildHandleBuffer
 324   );
 325
 326 EFI_STATUS
 327 EfiLocateHiiProtocol (
 328   VOID
 329   )
 330 ;
 331
 332
 333 #endif