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