2 QEMU Video Controller Driver
4 Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>
5 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
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.
16 // QEMU Video Controller Driver
24 #include <Protocol/GraphicsOutput.h>
25 #include <Protocol/PciIo.h>
26 #include <Protocol/DriverSupportedEfiVersion.h>
27 #include <Protocol/DevicePath.h>
29 #include <Library/DebugLib.h>
30 #include <Library/UefiDriverEntryPoint.h>
31 #include <Library/UefiLib.h>
32 #include <Library/PcdLib.h>
33 #include <Library/MemoryAllocationLib.h>
34 #include <Library/UefiBootServicesTableLib.h>
35 #include <Library/BaseMemoryLib.h>
36 #include <Library/DevicePathLib.h>
37 #include <Library/TimerLib.h>
38 #include <Library/FrameBufferBltLib.h>
40 #include <IndustryStandard/Pci.h>
41 #include <IndustryStandard/Acpi.h>
44 // QEMU Video PCI Configuration Header values
46 #define CIRRUS_LOGIC_VENDOR_ID 0x1013
47 #define CIRRUS_LOGIC_5430_DEVICE_ID 0x00a8
48 #define CIRRUS_LOGIC_5430_ALTERNATE_DEVICE_ID 0x00a0
49 #define CIRRUS_LOGIC_5446_DEVICE_ID 0x00b8
52 // QEMU Vide Graphical Mode Data
55 UINT32 InternalModeIndex
; // points into card-specific mode table
56 UINT32 HorizontalResolution
;
57 UINT32 VerticalResolution
;
59 } QEMU_VIDEO_MODE_DATA
;
61 #define PIXEL_RED_SHIFT 0
62 #define PIXEL_GREEN_SHIFT 3
63 #define PIXEL_BLUE_SHIFT 6
65 #define PIXEL_RED_MASK (BIT7 | BIT6 | BIT5)
66 #define PIXEL_GREEN_MASK (BIT4 | BIT3 | BIT2)
67 #define PIXEL_BLUE_MASK (BIT1 | BIT0)
69 #define PIXEL_TO_COLOR_BYTE(pixel, mask, shift) ((UINT8) ((pixel & mask) << shift))
70 #define PIXEL_TO_RED_BYTE(pixel) PIXEL_TO_COLOR_BYTE(pixel, PIXEL_RED_MASK, PIXEL_RED_SHIFT)
71 #define PIXEL_TO_GREEN_BYTE(pixel) PIXEL_TO_COLOR_BYTE(pixel, PIXEL_GREEN_MASK, PIXEL_GREEN_SHIFT)
72 #define PIXEL_TO_BLUE_BYTE(pixel) PIXEL_TO_COLOR_BYTE(pixel, PIXEL_BLUE_MASK, PIXEL_BLUE_SHIFT)
74 #define RGB_BYTES_TO_PIXEL(Red, Green, Blue) \
75 (UINT8) ( (((Red) >> PIXEL_RED_SHIFT) & PIXEL_RED_MASK) | \
76 (((Green) >> PIXEL_GREEN_SHIFT) & PIXEL_GREEN_MASK) | \
77 (((Blue) >> PIXEL_BLUE_SHIFT) & PIXEL_BLUE_MASK) )
79 #define PIXEL24_RED_MASK 0x00ff0000
80 #define PIXEL24_GREEN_MASK 0x0000ff00
81 #define PIXEL24_BLUE_MASK 0x000000ff
83 #define GRAPHICS_OUTPUT_INVALIDE_MODE_NUMBER 0xffff
86 // QEMU Video Private Data Structure
88 #define QEMU_VIDEO_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('Q', 'V', 'I', 'D')
91 QEMU_VIDEO_CIRRUS_5430
= 1,
92 QEMU_VIDEO_CIRRUS_5446
,
94 QEMU_VIDEO_BOCHS_MMIO
,
100 QEMU_VIDEO_VARIANT Variant
;
107 EFI_PCI_IO_PROTOCOL
*PciIo
;
108 UINT64 OriginalPciAttributes
;
109 EFI_GRAPHICS_OUTPUT_PROTOCOL GraphicsOutput
;
110 EFI_DEVICE_PATH_PROTOCOL
*GopDevicePath
;
113 // The next two fields match the client-visible
114 // EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE.MaxMode field.
117 QEMU_VIDEO_MODE_DATA
*ModeData
;
119 QEMU_VIDEO_VARIANT Variant
;
120 FRAME_BUFFER_CONFIGURE
*FrameBufferBltConfigure
;
121 UINTN FrameBufferBltConfigureSize
;
122 } QEMU_VIDEO_PRIVATE_DATA
;
125 /// Card-specific Video Mode structures
134 } QEMU_VIDEO_CIRRUS_MODES
;
140 } QEMU_VIDEO_BOCHS_MODES
;
142 #define QEMU_VIDEO_PRIVATE_DATA_FROM_GRAPHICS_OUTPUT_THIS(a) \
143 CR(a, QEMU_VIDEO_PRIVATE_DATA, GraphicsOutput, QEMU_VIDEO_PRIVATE_DATA_SIGNATURE)
149 extern UINT8 AttributeController
[];
150 extern UINT8 GraphicsController
[];
151 extern UINT8 Crtc_640_480_256_60
[];
152 extern UINT16 Seq_640_480_256_60
[];
153 extern UINT8 Crtc_800_600_256_60
[];
154 extern UINT16 Seq_800_600_256_60
[];
155 extern UINT8 Crtc_1024_768_256_60
[];
156 extern UINT16 Seq_1024_768_256_60
[];
157 extern QEMU_VIDEO_CIRRUS_MODES QemuVideoCirrusModes
[];
158 extern QEMU_VIDEO_BOCHS_MODES QemuVideoBochsModes
[];
159 extern EFI_DRIVER_BINDING_PROTOCOL gQemuVideoDriverBinding
;
160 extern EFI_COMPONENT_NAME_PROTOCOL gQemuVideoComponentName
;
161 extern EFI_COMPONENT_NAME2_PROTOCOL gQemuVideoComponentName2
;
162 extern EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL gQemuVideoDriverSupportedEfiVersion
;
165 // Io Registers defined by VGA
167 #define CRTC_ADDRESS_REGISTER 0x3d4
168 #define CRTC_DATA_REGISTER 0x3d5
169 #define SEQ_ADDRESS_REGISTER 0x3c4
170 #define SEQ_DATA_REGISTER 0x3c5
171 #define GRAPH_ADDRESS_REGISTER 0x3ce
172 #define GRAPH_DATA_REGISTER 0x3cf
173 #define ATT_ADDRESS_REGISTER 0x3c0
174 #define MISC_OUTPUT_REGISTER 0x3c2
175 #define INPUT_STATUS_1_REGISTER 0x3da
176 #define DAC_PIXEL_MASK_REGISTER 0x3c6
177 #define PALETTE_INDEX_REGISTER 0x3c8
178 #define PALETTE_DATA_REGISTER 0x3c9
180 #define VBE_DISPI_IOPORT_INDEX 0x01CE
181 #define VBE_DISPI_IOPORT_DATA 0x01D0
183 #define VBE_DISPI_INDEX_ID 0x0
184 #define VBE_DISPI_INDEX_XRES 0x1
185 #define VBE_DISPI_INDEX_YRES 0x2
186 #define VBE_DISPI_INDEX_BPP 0x3
187 #define VBE_DISPI_INDEX_ENABLE 0x4
188 #define VBE_DISPI_INDEX_BANK 0x5
189 #define VBE_DISPI_INDEX_VIRT_WIDTH 0x6
190 #define VBE_DISPI_INDEX_VIRT_HEIGHT 0x7
191 #define VBE_DISPI_INDEX_X_OFFSET 0x8
192 #define VBE_DISPI_INDEX_Y_OFFSET 0x9
193 #define VBE_DISPI_INDEX_VIDEO_MEMORY_64K 0xa
195 #define VBE_DISPI_ID0 0xB0C0
196 #define VBE_DISPI_ID1 0xB0C1
197 #define VBE_DISPI_ID2 0xB0C2
198 #define VBE_DISPI_ID3 0xB0C3
199 #define VBE_DISPI_ID4 0xB0C4
200 #define VBE_DISPI_ID5 0xB0C5
202 #define VBE_DISPI_DISABLED 0x00
203 #define VBE_DISPI_ENABLED 0x01
204 #define VBE_DISPI_GETCAPS 0x02
205 #define VBE_DISPI_8BIT_DAC 0x20
206 #define VBE_DISPI_LFB_ENABLED 0x40
207 #define VBE_DISPI_NOCLEARMEM 0x80
210 // Graphics Output Hardware abstraction internal worker functions
213 QemuVideoGraphicsOutputConstructor (
214 QEMU_VIDEO_PRIVATE_DATA
*Private
218 QemuVideoGraphicsOutputDestructor (
219 QEMU_VIDEO_PRIVATE_DATA
*Private
224 // EFI_DRIVER_BINDING_PROTOCOL Protocol Interface
227 TODO: Add function description
229 @param This TODO: add argument description
230 @param Controller TODO: add argument description
231 @param RemainingDevicePath TODO: add argument description
233 TODO: add return values
238 QemuVideoControllerDriverSupported (
239 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
240 IN EFI_HANDLE Controller
,
241 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
245 TODO: Add function description
247 @param This TODO: add argument description
248 @param Controller TODO: add argument description
249 @param RemainingDevicePath TODO: add argument description
251 TODO: add return values
256 QemuVideoControllerDriverStart (
257 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
258 IN EFI_HANDLE Controller
,
259 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
263 TODO: Add function description
265 @param This TODO: add argument description
266 @param Controller TODO: add argument description
267 @param NumberOfChildren TODO: add argument description
268 @param ChildHandleBuffer TODO: add argument description
270 TODO: add return values
275 QemuVideoControllerDriverStop (
276 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
277 IN EFI_HANDLE Controller
,
278 IN UINTN NumberOfChildren
,
279 IN EFI_HANDLE
*ChildHandleBuffer
283 // EFI Component Name Functions
286 Retrieves a Unicode string that is the user readable name of the driver.
288 This function retrieves the user readable name of a driver in the form of a
289 Unicode string. If the driver specified by This has a user readable name in
290 the language specified by Language, then a pointer to the driver name is
291 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
292 by This does not support the language specified by Language,
293 then EFI_UNSUPPORTED is returned.
295 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
296 EFI_COMPONENT_NAME_PROTOCOL instance.
298 @param Language[in] A pointer to a Null-terminated ASCII string
299 array indicating the language. This is the
300 language of the driver name that the caller is
301 requesting, and it must match one of the
302 languages specified in SupportedLanguages. The
303 number of languages supported by a driver is up
304 to the driver writer. Language is specified
305 in RFC 4646 or ISO 639-2 language code format.
307 @param DriverName[out] A pointer to the Unicode string to return.
308 This Unicode string is the name of the
309 driver specified by This in the language
310 specified by Language.
312 @retval EFI_SUCCESS The Unicode string for the Driver specified by
313 This and the language specified by Language was
314 returned in DriverName.
316 @retval EFI_INVALID_PARAMETER Language is NULL.
318 @retval EFI_INVALID_PARAMETER DriverName is NULL.
320 @retval EFI_UNSUPPORTED The driver specified by This does not support
321 the language specified by Language.
326 QemuVideoComponentNameGetDriverName (
327 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
329 OUT CHAR16
**DriverName
334 Retrieves a Unicode string that is the user readable name of the controller
335 that is being managed by a driver.
337 This function retrieves the user readable name of the controller specified by
338 ControllerHandle and ChildHandle in the form of a Unicode string. If the
339 driver specified by This has a user readable name in the language specified by
340 Language, then a pointer to the controller name is returned in ControllerName,
341 and EFI_SUCCESS is returned. If the driver specified by This is not currently
342 managing the controller specified by ControllerHandle and ChildHandle,
343 then EFI_UNSUPPORTED is returned. If the driver specified by This does not
344 support the language specified by Language, then EFI_UNSUPPORTED is returned.
346 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
347 EFI_COMPONENT_NAME_PROTOCOL instance.
349 @param ControllerHandle[in] The handle of a controller that the driver
350 specified by This is managing. This handle
351 specifies the controller whose name is to be
354 @param ChildHandle[in] The handle of the child controller to retrieve
355 the name of. This is an optional parameter that
356 may be NULL. It will be NULL for device
357 drivers. It will also be NULL for a bus drivers
358 that wish to retrieve the name of the bus
359 controller. It will not be NULL for a bus
360 driver that wishes to retrieve the name of a
363 @param Language[in] A pointer to a Null-terminated ASCII string
364 array indicating the language. This is the
365 language of the driver name that the caller is
366 requesting, and it must match one of the
367 languages specified in SupportedLanguages. The
368 number of languages supported by a driver is up
369 to the driver writer. Language is specified in
370 RFC 4646 or ISO 639-2 language code format.
372 @param ControllerName[out] A pointer to the Unicode string to return.
373 This Unicode string is the name of the
374 controller specified by ControllerHandle and
375 ChildHandle in the language specified by
376 Language from the point of view of the driver
379 @retval EFI_SUCCESS The Unicode string for the user readable name in
380 the language specified by Language for the
381 driver specified by This was returned in
384 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
386 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
389 @retval EFI_INVALID_PARAMETER Language is NULL.
391 @retval EFI_INVALID_PARAMETER ControllerName is NULL.
393 @retval EFI_UNSUPPORTED The driver specified by This is not currently
394 managing the controller specified by
395 ControllerHandle and ChildHandle.
397 @retval EFI_UNSUPPORTED The driver specified by This does not support
398 the language specified by Language.
403 QemuVideoComponentNameGetControllerName (
404 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
405 IN EFI_HANDLE ControllerHandle
,
406 IN EFI_HANDLE ChildHandle OPTIONAL
,
408 OUT CHAR16
**ControllerName
413 // Local Function Prototypes
416 InitializeCirrusGraphicsMode (
417 QEMU_VIDEO_PRIVATE_DATA
*Private
,
418 QEMU_VIDEO_CIRRUS_MODES
*ModeData
422 InitializeBochsGraphicsMode (
423 QEMU_VIDEO_PRIVATE_DATA
*Private
,
424 QEMU_VIDEO_BOCHS_MODES
*ModeData
429 QEMU_VIDEO_PRIVATE_DATA
*Private
,
438 QEMU_VIDEO_PRIVATE_DATA
*Private
443 QEMU_VIDEO_PRIVATE_DATA
*Private
,
450 QEMU_VIDEO_PRIVATE_DATA
*Private
,
457 QEMU_VIDEO_PRIVATE_DATA
*Private
,
464 QEMU_VIDEO_PRIVATE_DATA
*Private
,
470 QEMU_VIDEO_PRIVATE_DATA
*Private
,
476 QEMU_VIDEO_PRIVATE_DATA
*Private
,
483 QEMU_VIDEO_PRIVATE_DATA
*Private
,
489 QEMU_VIDEO_PRIVATE_DATA
*Private
,
495 QemuVideoCirrusModeSetup (
496 QEMU_VIDEO_PRIVATE_DATA
*Private
500 QemuVideoBochsModeSetup (
501 QEMU_VIDEO_PRIVATE_DATA
*Private
,
507 IN CONST CHAR16
*CardName
,
508 IN EFI_PHYSICAL_ADDRESS FrameBufferBase