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