OptionRomPkg/CirrusLogic5430Dxe/CirrusLogic5430.h

   1 /** @file
   2   Cirrus Logic 5430 Controller Driver
   3
   4   Copyright (c) 2006 - 2007, Intel Corporation
   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 //
  16 // Cirrus Logic 5430 Controller Driver
  17 //
  18
  19 #ifndef _CIRRUS_LOGIC_5430_H_
  20 #define _CIRRUS_LOGIC_5430_H_
  21
  22
  23 #include <Uefi.h>
  24 #include <Protocol/UgaDraw.h>
  25 #include <Protocol/GraphicsOutput.h>
  26 #include <Protocol/PciIo.h>
  27 #include <Protocol/DriverSupportedEfiVersion.h>
  28 #include <Protocol/EdidOverride.h>
  29 #include <Protocol/EdidDiscovered.h>
  30 #include <Protocol/EdidActive.h>
  31 #include <Protocol/DevicePath.h>
  32
  33 #include <Library/DebugLib.h>
  34 #include <Library/UefiDriverEntryPoint.h>
  35 #include <Library/UefiLib.h>
  36 #include <Library/PcdLib.h>
  37 #include <Library/MemoryAllocationLib.h>
  38 #include <Library/UefiBootServicesTableLib.h>
  39 #include <Library/BaseMemoryLib.h>
  40 #include <Library/DevicePathLib.h>
  41 #include <Library/DxeI2cLib.h>
  42
  43 #include <IndustryStandard/Pci22.h>
  44 //
  45 // Cirrus Logic 5430 PCI Configuration Header values
  46 //
  47 #define CIRRUS_LOGIC_VENDOR_ID                0x1013
  48 #define CIRRUS_LOGIC_5430_DEVICE_ID           0x00a8
  49 #define CIRRUS_LOGIC_5430_ALTERNATE_DEVICE_ID 0x00a0
  50 #define CIRRUS_LOGIC_5446_DEVICE_ID           0x00b8
  51
  52 //
  53 // Cirrus Logic Graphical Mode Data
  54 //
  55 #define CIRRUS_LOGIC_5430_MODE_COUNT         3
  56
  57 typedef struct {
  58   UINT32  ModeNumber;
  59   UINT32  HorizontalResolution;
  60   UINT32  VerticalResolution;
  61   UINT32  ColorDepth;
  62   UINT32  RefreshRate;
  63 } CIRRUS_LOGIC_5430_MODE_DATA;
  64
  65 #define GRAPHICS_OUTPUT_INVALIDE_MODE_NUMBER  0xffff
  66
  67 //
  68 // Cirrus Logic 5440 Private Data Structure
  69 //
  70 #define CIRRUS_LOGIC_5430_PRIVATE_DATA_SIGNATURE  EFI_SIGNATURE_32 ('C', 'L', '5', '4')
  71
  72 typedef struct {
  73   UINT64                                Signature;
  74   EFI_HANDLE                            Handle;
  75   EFI_PCI_IO_PROTOCOL                   *PciIo;
  76   UINT64                                OriginalPciAttributes;
  77   EFI_UGA_DRAW_PROTOCOL                 UgaDraw;
  78   EFI_GRAPHICS_OUTPUT_PROTOCOL          GraphicsOutput;
  79   EFI_EDID_DISCOVERED_PROTOCOL          EdidDiscovered;
  80   EFI_EDID_ACTIVE_PROTOCOL              EdidActive;
  81   EFI_DEVICE_PATH_PROTOCOL              *GopDevicePath;
  82   EFI_DEVICE_PATH_PROTOCOL              *UgaDevicePath;
  83   UINTN                                 CurrentMode;
  84   UINTN                                 MaxMode;
  85   CIRRUS_LOGIC_5430_MODE_DATA           ModeData[CIRRUS_LOGIC_5430_MODE_COUNT];
  86   UINT8                                 *LineBuffer;
  87   BOOLEAN                               HardwareNeedsStarting;
  88 } CIRRUS_LOGIC_5430_PRIVATE_DATA;
  89
  90 ///
  91 /// Video Mode structure
  92 ///
  93 typedef struct {
  94   UINT32  Width;
  95   UINT32  Height;
  96   UINT32  ColorDepth;
  97   UINT32  RefreshRate;
  98   UINT8   *CrtcSettings;
  99   UINT16  *SeqSettings;
 100   UINT8   MiscSetting;
 101 } CIRRUS_LOGIC_5430_VIDEO_MODES;
 102
 103 #define CIRRUS_LOGIC_5430_PRIVATE_DATA_FROM_UGA_DRAW_THIS(a) \
 104   CR(a, CIRRUS_LOGIC_5430_PRIVATE_DATA, UgaDraw, CIRRUS_LOGIC_5430_PRIVATE_DATA_SIGNATURE)
 105
 106 #define CIRRUS_LOGIC_5430_PRIVATE_DATA_FROM_GRAPHICS_OUTPUT_THIS(a) \
 107   CR(a, CIRRUS_LOGIC_5430_PRIVATE_DATA, GraphicsOutput, CIRRUS_LOGIC_5430_PRIVATE_DATA_SIGNATURE)
 108
 109
 110 //
 111 // Global Variables
 112 //
 113 extern UINT8                                      AttributeController[];
 114 extern UINT8                                      GraphicsController[];
 115 extern UINT8                                      Crtc_640_480_256_60[];
 116 extern UINT16                                     Seq_640_480_256_60[];
 117 extern UINT8                                      Crtc_800_600_256_60[];
 118 extern UINT16                                     Seq_800_600_256_60[];
 119 extern UINT8                                      Crtc_1024_768_256_60[];
 120 extern UINT16                                     Seq_1024_768_256_60[];
 121 extern CIRRUS_LOGIC_5430_VIDEO_MODES              CirrusLogic5430VideoModes[];
 122 extern EFI_DRIVER_BINDING_PROTOCOL                gCirrusLogic5430DriverBinding;
 123 extern EFI_COMPONENT_NAME_PROTOCOL                gCirrusLogic5430ComponentName;
 124 extern EFI_COMPONENT_NAME2_PROTOCOL               gCirrusLogic5430ComponentName2;
 125 extern EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL  gCirrusLogic5430DriverSupportedEfiVersion;
 126
 127 //
 128 // Io Registers defined by VGA
 129 //
 130 #define CRTC_ADDRESS_REGISTER   0x3d4
 131 #define CRTC_DATA_REGISTER      0x3d5
 132 #define SEQ_ADDRESS_REGISTER    0x3c4
 133 #define SEQ_DATA_REGISTER       0x3c5
 134 #define GRAPH_ADDRESS_REGISTER  0x3ce
 135 #define GRAPH_DATA_REGISTER     0x3cf
 136 #define ATT_ADDRESS_REGISTER    0x3c0
 137 #define MISC_OUTPUT_REGISTER    0x3c2
 138 #define INPUT_STATUS_1_REGISTER 0x3da
 139 #define DAC_PIXEL_MASK_REGISTER 0x3c6
 140 #define PALETTE_INDEX_REGISTER  0x3c8
 141 #define PALETTE_DATA_REGISTER   0x3c9
 142
 143 //
 144 // UGA Draw Hardware abstraction internal worker functions
 145 //
 146 EFI_STATUS
 147 CirrusLogic5430UgaDrawConstructor (
 148   CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private
 149   )
 150 ;
 151
 152 EFI_STATUS
 153 CirrusLogic5430UgaDrawDestructor (
 154   CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private
 155   )
 156 ;
 157
 158 //
 159 // Graphics Output Hardware abstraction internal worker functions
 160 //
 161 EFI_STATUS
 162 CirrusLogic5430GraphicsOutputConstructor (
 163   CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private
 164   )
 165 ;
 166
 167 EFI_STATUS
 168 CirrusLogic5430GraphicsOutputDestructor (
 169   CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private
 170   )
 171 ;
 172
 173
 174 //
 175 // EFI_DRIVER_BINDING_PROTOCOL Protocol Interface
 176 //
 177 /**
 178   TODO: Add function description
 179
 180   @param  This TODO: add argument description
 181   @param  Controller TODO: add argument description
 182   @param  RemainingDevicePath TODO: add argument description
 183
 184   TODO: add return values
 185
 186 **/
 187 EFI_STATUS
 188 EFIAPI
 189 CirrusLogic5430ControllerDriverSupported (
 190   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
 191   IN EFI_HANDLE                   Controller,
 192   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
 193   )
 194 ;
 195
 196 /**
 197   TODO: Add function description
 198
 199   @param  This TODO: add argument description
 200   @param  Controller TODO: add argument description
 201   @param  RemainingDevicePath TODO: add argument description
 202
 203   TODO: add return values
 204
 205 **/
 206 EFI_STATUS
 207 EFIAPI
 208 CirrusLogic5430ControllerDriverStart (
 209   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
 210   IN EFI_HANDLE                   Controller,
 211   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
 212   )
 213 ;
 214
 215 /**
 216   TODO: Add function description
 217
 218   @param  This TODO: add argument description
 219   @param  Controller TODO: add argument description
 220   @param  NumberOfChildren TODO: add argument description
 221   @param  ChildHandleBuffer TODO: add argument description
 222
 223   TODO: add return values
 224
 225 **/
 226 EFI_STATUS
 227 EFIAPI
 228 CirrusLogic5430ControllerDriverStop (
 229   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
 230   IN EFI_HANDLE                   Controller,
 231   IN UINTN                        NumberOfChildren,
 232   IN EFI_HANDLE                   *ChildHandleBuffer
 233   )
 234 ;
 235
 236 //
 237 // EFI Component Name Functions
 238 //
 239 /**
 240   Retrieves a Unicode string that is the user readable name of the driver.
 241
 242   This function retrieves the user readable name of a driver in the form of a
 243   Unicode string. If the driver specified by This has a user readable name in
 244   the language specified by Language, then a pointer to the driver name is
 245   returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
 246   by This does not support the language specified by Language,
 247   then EFI_UNSUPPORTED is returned.
 248
 249   @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
 250                                 EFI_COMPONENT_NAME_PROTOCOL instance.
 251
 252   @param  Language[in]          A pointer to a Null-terminated ASCII string
 253                                 array indicating the language. This is the
 254                                 language of the driver name that the caller is
 255                                 requesting, and it must match one of the
 256                                 languages specified in SupportedLanguages. The
 257                                 number of languages supported by a driver is up
 258                                 to the driver writer. Language is specified
 259                                 in RFC 3066 or ISO 639-2 language code format.
 260
 261   @param  DriverName[out]       A pointer to the Unicode string to return.
 262                                 This Unicode string is the name of the
 263                                 driver specified by This in the language
 264                                 specified by Language.
 265
 266   @retval EFI_SUCCESS           The Unicode string for the Driver specified by
 267                                 This and the language specified by Language was
 268                                 returned in DriverName.
 269
 270   @retval EFI_INVALID_PARAMETER Language is NULL.
 271
 272   @retval EFI_INVALID_PARAMETER DriverName is NULL.
 273
 274   @retval EFI_UNSUPPORTED       The driver specified by This does not support
 275                                 the language specified by Language.
 276
 277 **/
 278 EFI_STATUS
 279 EFIAPI
 280 CirrusLogic5430ComponentNameGetDriverName (
 281   IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
 282   IN  CHAR8                        *Language,
 283   OUT CHAR16                       **DriverName
 284   );
 285
 286
 287 /**
 288   Retrieves a Unicode string that is the user readable name of the controller
 289   that is being managed by a driver.
 290
 291   This function retrieves the user readable name of the controller specified by
 292   ControllerHandle and ChildHandle in the form of a Unicode string. If the
 293   driver specified by This has a user readable name in the language specified by
 294   Language, then a pointer to the controller name is returned in ControllerName,
 295   and EFI_SUCCESS is returned.  If the driver specified by This is not currently
 296   managing the controller specified by ControllerHandle and ChildHandle,
 297   then EFI_UNSUPPORTED is returned.  If the driver specified by This does not
 298   support the language specified by Language, then EFI_UNSUPPORTED is returned.
 299
 300   @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
 301                                 EFI_COMPONENT_NAME_PROTOCOL instance.
 302
 303   @param  ControllerHandle[in]  The handle of a controller that the driver
 304                                 specified by This is managing.  This handle
 305                                 specifies the controller whose name is to be
 306                                 returned.
 307
 308   @param  ChildHandle[in]       The handle of the child controller to retrieve
 309                                 the name of.  This is an optional parameter that
 310                                 may be NULL.  It will be NULL for device
 311                                 drivers.  It will also be NULL for a bus drivers
 312                                 that wish to retrieve the name of the bus
 313                                 controller.  It will not be NULL for a bus
 314                                 driver that wishes to retrieve the name of a
 315                                 child controller.
 316
 317   @param  Language[in]          A pointer to a Null-terminated ASCII string
 318                                 array indicating the language.  This is the
 319                                 language of the driver name that the caller is
 320                                 requesting, and it must match one of the
 321                                 languages specified in SupportedLanguages. The
 322                                 number of languages supported by a driver is up
 323                                 to the driver writer. Language is specified in
 324                                 RFC 3066 or ISO 639-2 language code format.
 325
 326   @param  ControllerName[out]   A pointer to the Unicode string to return.
 327                                 This Unicode string is the name of the
 328                                 controller specified by ControllerHandle and
 329                                 ChildHandle in the language specified by
 330                                 Language from the point of view of the driver
 331                                 specified by This.
 332
 333   @retval EFI_SUCCESS           The Unicode string for the user readable name in
 334                                 the language specified by Language for the
 335                                 driver specified by This was returned in
 336                                 DriverName.
 337
 338   @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
 339
 340   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
 341                                 EFI_HANDLE.
 342
 343   @retval EFI_INVALID_PARAMETER Language is NULL.
 344
 345   @retval EFI_INVALID_PARAMETER ControllerName is NULL.
 346
 347   @retval EFI_UNSUPPORTED       The driver specified by This is not currently
 348                                 managing the controller specified by
 349                                 ControllerHandle and ChildHandle.
 350
 351   @retval EFI_UNSUPPORTED       The driver specified by This does not support
 352                                 the language specified by Language.
 353
 354 **/
 355 EFI_STATUS
 356 EFIAPI
 357 CirrusLogic5430ComponentNameGetControllerName (
 358   IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,
 359   IN  EFI_HANDLE                                      ControllerHandle,
 360   IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,
 361   IN  CHAR8                                           *Language,
 362   OUT CHAR16                                          **ControllerName
 363   );
 364
 365
 366 //
 367 // Local Function Prototypes
 368 //
 369 VOID
 370 InitializeGraphicsMode (
 371   CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private,
 372   CIRRUS_LOGIC_5430_VIDEO_MODES   *ModeData
 373   );
 374
 375 VOID
 376 SetPaletteColor (
 377   CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private,
 378   UINTN                           Index,
 379   UINT8                           Red,
 380   UINT8                           Green,
 381   UINT8                           Blue
 382   );
 383
 384 VOID
 385 SetDefaultPalette (
 386   CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private
 387   );
 388
 389 VOID
 390 DrawLogo (
 391   CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private,
 392   UINTN                           ScreenWidth,
 393   UINTN                           ScreenHeight
 394   );
 395
 396 VOID
 397 outb (
 398   CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private,
 399   UINTN                           Address,
 400   UINT8                           Data
 401   );
 402
 403 VOID
 404 outw (
 405   CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private,
 406   UINTN                           Address,
 407   UINT16                          Data
 408   );
 409
 410 UINT8
 411 inb (
 412   CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private,
 413   UINTN                           Address
 414   );
 415
 416 UINT16
 417 inw (
 418   CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private,
 419   UINTN                           Address
 420   );
 421
 422 EFI_STATUS
 423 CirrusLogic5430VideoModeSetup (
 424   CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private
 425   );
 426
 427 #endif