IntelFrameworkModulePkg/Universal/Console/VgaClassDxe/VgaClass.h

   1 /*++
   2
   3 Copyright (c) 2006, Intel Corporation. All rights reserved.
   4 This software and associated documentation (if any) is furnished
   5 under a license and may only be used or copied in accordance
   6 with the terms of the license. Except as permitted by such
   7 license, no part of this software or documentation may be
   8 reproduced, stored in a retrieval system, or transmitted in any
   9 form or by any means without the express written consent of
  10 Intel Corporation.
  11
  12
  13 Module Name:
  14
  15     VgaClass.h
  16
  17 Abstract:
  18
  19
  20 Revision History
  21 --*/
  22
  23 #ifndef _VGA_CLASS_H
  24 #define _VGA_CLASS_H
  25
  26 #include <PiDxe.h>
  27 #include <FrameworkDxe.h>
  28
  29 #include <Protocol/SimpleTextIn.h>
  30 #include <Protocol/SimpleTextOut.h>
  31 #include <Protocol/PciIo.h>
  32 #include <Protocol/VgaMiniPort.h>
  33 #include <Protocol/DevicePath.h>
  34
  35 #include <Library/DebugLib.h>
  36 #include <Library/UefiDriverEntryPoint.h>
  37 #include <Library/BaseLib.h>
  38 #include <Library/UefiLib.h>
  39 #include <Library/DevicePathLib.h>
  40 #include <Library/BaseMemoryLib.h>
  41 #include <Library/MemoryAllocationLib.h>
  42 #include <Library/UefiBootServicesTableLib.h>
  43 #include <Library/ReportStatusCodeLib.h>
  44
  45
  46 #include <IndustryStandard/Pci22.h>
  47 #include "ComponentName.h"
  48 #include <Protocol/VgaMiniPort.h>
  49
  50 //
  51 // VGA specific registers
  52 //
  53 #define CRTC_CURSOR_START         0xA
  54 #define CRTC_CURSOR_END           0xB
  55
  56 #define CRTC_CURSOR_LOCATION_HIGH 0xE
  57 #define CRTC_CURSOR_LOCATION_LOW  0xF
  58
  59 #define EFI_MAX_ATTRIBUTE         0x7f
  60
  61 //
  62 // VGA Class Device Structure
  63 //
  64 #define VGA_CLASS_DEV_SIGNATURE EFI_SIGNATURE_32 ('V', 'G', 'A', 'C')
  65
  66 typedef struct {
  67   UINTN                         Signature;
  68   EFI_HANDLE                    Handle;
  69   EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  SimpleTextOut;
  70   EFI_SIMPLE_TEXT_OUTPUT_MODE   SimpleTextOutputMode;
  71   EFI_VGA_MINI_PORT_PROTOCOL    *VgaMiniPort;
  72   EFI_PCI_IO_PROTOCOL           *PciIo;
  73   EFI_DEVICE_PATH_PROTOCOL      *DevicePath;
  74 } VGA_CLASS_DEV;
  75
  76 #define VGA_CLASS_DEV_FROM_THIS(a)  CR (a, VGA_CLASS_DEV, SimpleTextOut, VGA_CLASS_DEV_SIGNATURE)
  77
  78 //
  79 // Global Variables
  80 //
  81 extern EFI_DRIVER_BINDING_PROTOCOL  gVgaClassDriverBinding;
  82
  83 //
  84 // Driver Binding Protocol functions
  85 //
  86 EFI_STATUS
  87 EFIAPI
  88 VgaClassDriverBindingSupported (
  89   IN EFI_DRIVER_BINDING_PROTOCOL   *This,
  90   IN EFI_HANDLE                    Controller,
  91   IN EFI_DEVICE_PATH_PROTOCOL      *RemainingDevicePath
  92   )
  93 /*++
  94
  95 Routine Description:
  96
  97   GC_TODO: Add function description
  98
  99 Arguments:
 100
 101   This                - GC_TODO: add argument description
 102   Controller          - GC_TODO: add argument description
 103   RemainingDevicePath - GC_TODO: add argument description
 104
 105 Returns:
 106
 107   GC_TODO: add return values
 108
 109 --*/
 110 ;
 111
 112 EFI_STATUS
 113 EFIAPI
 114 VgaClassDriverBindingStart (
 115   IN EFI_DRIVER_BINDING_PROTOCOL   *This,
 116   IN EFI_HANDLE                    Controller,
 117   IN EFI_DEVICE_PATH_PROTOCOL      *RemainingDevicePath
 118   )
 119 /*++
 120
 121 Routine Description:
 122
 123   GC_TODO: Add function description
 124
 125 Arguments:
 126
 127   This                - GC_TODO: add argument description
 128   Controller          - GC_TODO: add argument description
 129   RemainingDevicePath - GC_TODO: add argument description
 130
 131 Returns:
 132
 133   GC_TODO: add return values
 134
 135 --*/
 136 ;
 137
 138 EFI_STATUS
 139 EFIAPI
 140 VgaClassDriverBindingStop (
 141   IN  EFI_DRIVER_BINDING_PROTOCOL  *This,
 142   IN  EFI_HANDLE                   Controller,
 143   IN  UINTN                        NumberOfChildren,
 144   IN  EFI_HANDLE                   *ChildHandleBuffer
 145   )
 146 /*++
 147
 148 Routine Description:
 149
 150   GC_TODO: Add function description
 151
 152 Arguments:
 153
 154   This              - GC_TODO: add argument description
 155   Controller        - GC_TODO: add argument description
 156   NumberOfChildren  - GC_TODO: add argument description
 157   ChildHandleBuffer - GC_TODO: add argument description
 158
 159 Returns:
 160
 161   GC_TODO: add return values
 162
 163 --*/
 164 ;
 165
 166 //
 167 // Simple Text Output Protocol functions
 168 //
 169 EFI_STATUS
 170 EFIAPI
 171 VgaClassReset (
 172   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
 173   IN  BOOLEAN                      ExtendedVerification
 174   )
 175 /*++
 176
 177 Routine Description:
 178
 179   GC_TODO: Add function description
 180
 181 Arguments:
 182
 183   This                  - GC_TODO: add argument description
 184   ExtendedVerification  - GC_TODO: add argument description
 185
 186 Returns:
 187
 188   GC_TODO: add return values
 189
 190 --*/
 191 ;
 192
 193 EFI_STATUS
 194 EFIAPI
 195 VgaClassOutputString (
 196   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
 197   IN  CHAR16                       *WString
 198   )
 199 /*++
 200
 201 Routine Description:
 202
 203   GC_TODO: Add function description
 204
 205 Arguments:
 206
 207   This    - GC_TODO: add argument description
 208   WString - GC_TODO: add argument description
 209
 210 Returns:
 211
 212   GC_TODO: add return values
 213
 214 --*/
 215 ;
 216
 217 EFI_STATUS
 218 EFIAPI
 219 VgaClassTestString (
 220   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
 221   IN  CHAR16                       *WString
 222   )
 223 /*++
 224
 225 Routine Description:
 226
 227   GC_TODO: Add function description
 228
 229 Arguments:
 230
 231   This    - GC_TODO: add argument description
 232   WString - GC_TODO: add argument description
 233
 234 Returns:
 235
 236   GC_TODO: add return values
 237
 238 --*/
 239 ;
 240
 241 EFI_STATUS
 242 EFIAPI
 243 VgaClassClearScreen (
 244   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This
 245   )
 246 /*++
 247
 248 Routine Description:
 249
 250   GC_TODO: Add function description
 251
 252 Arguments:
 253
 254   This  - GC_TODO: add argument description
 255
 256 Returns:
 257
 258   GC_TODO: add return values
 259
 260 --*/
 261 ;
 262
 263 EFI_STATUS
 264 EFIAPI
 265 VgaClassSetAttribute (
 266   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
 267   IN  UINTN                        Attribute
 268   )
 269 /*++
 270
 271 Routine Description:
 272
 273   GC_TODO: Add function description
 274
 275 Arguments:
 276
 277   This      - GC_TODO: add argument description
 278   Attribute - GC_TODO: add argument description
 279
 280 Returns:
 281
 282   GC_TODO: add return values
 283
 284 --*/
 285 ;
 286
 287 EFI_STATUS
 288 EFIAPI
 289 VgaClassSetCursorPosition (
 290   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
 291   IN  UINTN                        Column,
 292   IN  UINTN                        Row
 293   )
 294 /*++
 295
 296 Routine Description:
 297
 298   GC_TODO: Add function description
 299
 300 Arguments:
 301
 302   This    - GC_TODO: add argument description
 303   Column  - GC_TODO: add argument description
 304   Row     - GC_TODO: add argument description
 305
 306 Returns:
 307
 308   GC_TODO: add return values
 309
 310 --*/
 311 ;
 312
 313 EFI_STATUS
 314 EFIAPI
 315 VgaClassEnableCursor (
 316   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
 317   IN  BOOLEAN                      Visible
 318   )
 319 /*++
 320
 321 Routine Description:
 322
 323   GC_TODO: Add function description
 324
 325 Arguments:
 326
 327   This    - GC_TODO: add argument description
 328   Visible - GC_TODO: add argument description
 329
 330 Returns:
 331
 332   GC_TODO: add return values
 333
 334 --*/
 335 ;
 336
 337 EFI_STATUS
 338 EFIAPI
 339 VgaClassQueryMode (
 340   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
 341   IN  UINTN                        ModeNumber,
 342   OUT UINTN                        *Columns,
 343   OUT UINTN                        *Rows
 344   )
 345 /*++
 346
 347 Routine Description:
 348
 349   GC_TODO: Add function description
 350
 351 Arguments:
 352
 353   This        - GC_TODO: add argument description
 354   ModeNumber  - GC_TODO: add argument description
 355   Columns     - GC_TODO: add argument description
 356   Rows        - GC_TODO: add argument description
 357
 358 Returns:
 359
 360   GC_TODO: add return values
 361
 362 --*/
 363 ;
 364
 365 EFI_STATUS
 366 EFIAPI
 367 VgaClassSetMode (
 368   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
 369   IN  UINTN                        ModeNumber
 370   )
 371 /*++
 372
 373 Routine Description:
 374
 375   GC_TODO: Add function description
 376
 377 Arguments:
 378
 379   This        - GC_TODO: add argument description
 380   ModeNumber  - GC_TODO: add argument description
 381
 382 Returns:
 383
 384   GC_TODO: add return values
 385
 386 --*/
 387 ;
 388
 389 #endif