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