2 This driver is a sample implementation of the Graphics Output Protocol for
3 the QEMU (Cirrus Logic 5446) video controller.
5 Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 #include <IndustryStandard/Acpi.h>
20 EFI_DRIVER_BINDING_PROTOCOL gQemuVideoDriverBinding
= {
21 QemuVideoControllerDriverSupported
,
22 QemuVideoControllerDriverStart
,
23 QemuVideoControllerDriverStop
,
29 QEMU_VIDEO_CARD gQemuVideoCardList
[] = {
31 CIRRUS_LOGIC_VENDOR_ID
,
32 CIRRUS_LOGIC_5430_DEVICE_ID
,
33 QEMU_VIDEO_CIRRUS_5430
,
36 CIRRUS_LOGIC_VENDOR_ID
,
37 CIRRUS_LOGIC_5430_ALTERNATE_DEVICE_ID
,
38 QEMU_VIDEO_CIRRUS_5430
,
41 CIRRUS_LOGIC_VENDOR_ID
,
42 CIRRUS_LOGIC_5446_DEVICE_ID
,
43 QEMU_VIDEO_CIRRUS_5446
,
48 QEMU_VIDEO_BOCHS_MMIO
,
60 static QEMU_VIDEO_CARD
*
68 while (gQemuVideoCardList
[Index
].VendorId
!= 0) {
69 if (gQemuVideoCardList
[Index
].VendorId
== VendorId
&&
70 gQemuVideoCardList
[Index
].DeviceId
== DeviceId
) {
71 return gQemuVideoCardList
+ Index
;
79 Check if this device is supported.
81 @param This The driver binding protocol.
82 @param Controller The controller handle to check.
83 @param RemainingDevicePath The remaining device path.
85 @retval EFI_SUCCESS The bus supports this controller.
86 @retval EFI_UNSUPPORTED This device isn't supported.
91 QemuVideoControllerDriverSupported (
92 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
93 IN EFI_HANDLE Controller
,
94 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
98 EFI_PCI_IO_PROTOCOL
*PciIo
;
100 QEMU_VIDEO_CARD
*Card
;
103 // Open the PCI I/O Protocol
105 Status
= gBS
->OpenProtocol (
107 &gEfiPciIoProtocolGuid
,
109 This
->DriverBindingHandle
,
111 EFI_OPEN_PROTOCOL_BY_DRIVER
113 if (EFI_ERROR (Status
)) {
118 // Read the PCI Configuration Header from the PCI Device
120 Status
= PciIo
->Pci
.Read (
124 sizeof (Pci
) / sizeof (UINT32
),
127 if (EFI_ERROR (Status
)) {
131 Status
= EFI_UNSUPPORTED
;
132 Card
= QemuVideoDetect(Pci
.Hdr
.VendorId
, Pci
.Hdr
.DeviceId
);
134 DEBUG ((EFI_D_INFO
, "QemuVideo: %s detected\n", Card
->Name
));
135 Status
= EFI_SUCCESS
;
140 // Close the PCI I/O Protocol
144 &gEfiPciIoProtocolGuid
,
145 This
->DriverBindingHandle
,
153 Start to process the controller.
155 @param This The USB bus driver binding instance.
156 @param Controller The controller to check.
157 @param RemainingDevicePath The remaining device patch.
159 @retval EFI_SUCCESS The controller is controlled by the usb bus.
160 @retval EFI_ALREADY_STARTED The controller is already controlled by the usb
162 @retval EFI_OUT_OF_RESOURCES Failed to allocate resources.
167 QemuVideoControllerDriverStart (
168 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
169 IN EFI_HANDLE Controller
,
170 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
175 QEMU_VIDEO_PRIVATE_DATA
*Private
;
176 EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
;
177 ACPI_ADR_DEVICE_PATH AcpiDeviceNode
;
179 QEMU_VIDEO_CARD
*Card
;
180 EFI_PCI_IO_PROTOCOL
*ChildPciIo
;
182 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
185 // Allocate Private context data for GOP inteface.
187 Private
= AllocateZeroPool (sizeof (QEMU_VIDEO_PRIVATE_DATA
));
188 if (Private
== NULL
) {
189 Status
= EFI_OUT_OF_RESOURCES
;
194 // Set up context record
196 Private
->Signature
= QEMU_VIDEO_PRIVATE_DATA_SIGNATURE
;
199 // Open PCI I/O Protocol
201 Status
= gBS
->OpenProtocol (
203 &gEfiPciIoProtocolGuid
,
204 (VOID
**) &Private
->PciIo
,
205 This
->DriverBindingHandle
,
207 EFI_OPEN_PROTOCOL_BY_DRIVER
209 if (EFI_ERROR (Status
)) {
214 // Read the PCI Configuration Header from the PCI Device
216 Status
= Private
->PciIo
->Pci
.Read (
220 sizeof (Pci
) / sizeof (UINT32
),
223 if (EFI_ERROR (Status
)) {
228 // Determine card variant.
230 Card
= QemuVideoDetect(Pci
.Hdr
.VendorId
, Pci
.Hdr
.DeviceId
);
232 Status
= EFI_DEVICE_ERROR
;
235 Private
->Variant
= Card
->Variant
;
238 // Save original PCI attributes
240 Status
= Private
->PciIo
->Attributes (
242 EfiPciIoAttributeOperationGet
,
244 &Private
->OriginalPciAttributes
247 if (EFI_ERROR (Status
)) {
252 // Set new PCI attributes
254 Status
= Private
->PciIo
->Attributes (
256 EfiPciIoAttributeOperationEnable
,
257 EFI_PCI_DEVICE_ENABLE
| EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY
| EFI_PCI_IO_ATTRIBUTE_VGA_IO
,
260 if (EFI_ERROR (Status
)) {
265 // Check whenever the qemu stdvga mmio bar is present (qemu 1.3+).
267 if (Private
->Variant
== QEMU_VIDEO_BOCHS_MMIO
) {
268 EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*MmioDesc
;
270 Status
= Private
->PciIo
->GetBarAttributes (
276 if (EFI_ERROR (Status
) ||
277 MmioDesc
->ResType
!= ACPI_ADDRESS_SPACE_TYPE_MEM
) {
278 DEBUG ((EFI_D_INFO
, "QemuVideo: No mmio bar, fallback to port io\n"));
279 Private
->Variant
= QEMU_VIDEO_BOCHS
;
281 DEBUG ((EFI_D_INFO
, "QemuVideo: Using mmio bar @ 0x%lx\n",
282 MmioDesc
->AddrRangeMin
));
285 if (!EFI_ERROR (Status
)) {
291 // Check if accessing the bochs interface works.
293 if (Private
->Variant
== QEMU_VIDEO_BOCHS_MMIO
||
294 Private
->Variant
== QEMU_VIDEO_BOCHS
) {
296 BochsId
= BochsRead(Private
, VBE_DISPI_INDEX_ID
);
297 if ((BochsId
& 0xFFF0) != VBE_DISPI_ID0
) {
298 DEBUG ((EFI_D_INFO
, "QemuVideo: BochsID mismatch (got 0x%x)\n", BochsId
));
299 Status
= EFI_DEVICE_ERROR
;
300 goto RestoreAttributes
;
305 // Get ParentDevicePath
307 Status
= gBS
->HandleProtocol (
309 &gEfiDevicePathProtocolGuid
,
310 (VOID
**) &ParentDevicePath
312 if (EFI_ERROR (Status
)) {
313 goto RestoreAttributes
;
317 // Set Gop Device Path
319 ZeroMem (&AcpiDeviceNode
, sizeof (ACPI_ADR_DEVICE_PATH
));
320 AcpiDeviceNode
.Header
.Type
= ACPI_DEVICE_PATH
;
321 AcpiDeviceNode
.Header
.SubType
= ACPI_ADR_DP
;
322 AcpiDeviceNode
.ADR
= ACPI_DISPLAY_ADR (1, 0, 0, 1, 0, ACPI_ADR_DISPLAY_TYPE_VGA
, 0, 0);
323 SetDevicePathNodeLength (&AcpiDeviceNode
.Header
, sizeof (ACPI_ADR_DEVICE_PATH
));
325 Private
->GopDevicePath
= AppendDevicePathNode (
327 (EFI_DEVICE_PATH_PROTOCOL
*) &AcpiDeviceNode
329 if (Private
->GopDevicePath
== NULL
) {
330 Status
= EFI_OUT_OF_RESOURCES
;
331 goto RestoreAttributes
;
335 // Create new child handle and install the device path protocol on it.
337 Status
= gBS
->InstallMultipleProtocolInterfaces (
339 &gEfiDevicePathProtocolGuid
,
340 Private
->GopDevicePath
,
343 if (EFI_ERROR (Status
)) {
344 goto FreeGopDevicePath
;
348 // Construct video mode buffer
350 switch (Private
->Variant
) {
351 case QEMU_VIDEO_CIRRUS_5430
:
352 case QEMU_VIDEO_CIRRUS_5446
:
353 Status
= QemuVideoCirrusModeSetup (Private
);
355 case QEMU_VIDEO_BOCHS_MMIO
:
356 case QEMU_VIDEO_BOCHS
:
357 Status
= QemuVideoBochsModeSetup (Private
);
361 Status
= EFI_DEVICE_ERROR
;
364 if (EFI_ERROR (Status
)) {
365 goto UninstallGopDevicePath
;
369 // Start the GOP software stack.
371 Status
= QemuVideoGraphicsOutputConstructor (Private
);
372 if (EFI_ERROR (Status
)) {
376 Status
= gBS
->InstallMultipleProtocolInterfaces (
378 &gEfiGraphicsOutputProtocolGuid
,
379 &Private
->GraphicsOutput
,
382 if (EFI_ERROR (Status
)) {
383 goto DestructQemuVideoGraphics
;
387 // Reference parent handle from child handle.
389 Status
= gBS
->OpenProtocol (
391 &gEfiPciIoProtocolGuid
,
392 (VOID
**) &ChildPciIo
,
393 This
->DriverBindingHandle
,
395 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
397 if (EFI_ERROR (Status
)) {
401 if (Private
->Variant
== QEMU_VIDEO_BOCHS_MMIO
||
402 Private
->Variant
== QEMU_VIDEO_BOCHS
) {
403 InstallVbeShim (Card
->Name
, Private
->GraphicsOutput
.Mode
->FrameBufferBase
);
406 gBS
->RestoreTPL (OldTpl
);
410 gBS
->UninstallProtocolInterface (Private
->Handle
,
411 &gEfiGraphicsOutputProtocolGuid
, &Private
->GraphicsOutput
);
413 DestructQemuVideoGraphics
:
414 QemuVideoGraphicsOutputDestructor (Private
);
417 FreePool (Private
->ModeData
);
419 UninstallGopDevicePath
:
420 gBS
->UninstallProtocolInterface (Private
->Handle
,
421 &gEfiDevicePathProtocolGuid
, Private
->GopDevicePath
);
424 FreePool (Private
->GopDevicePath
);
427 Private
->PciIo
->Attributes (Private
->PciIo
, EfiPciIoAttributeOperationSet
,
428 Private
->OriginalPciAttributes
, NULL
);
431 gBS
->CloseProtocol (Controller
, &gEfiPciIoProtocolGuid
,
432 This
->DriverBindingHandle
, Controller
);
438 gBS
->RestoreTPL (OldTpl
);
446 @param This The USB bus driver binding protocol.
447 @param Controller The controller to release.
448 @param NumberOfChildren The number of children of this device that
449 opened the controller BY_CHILD.
450 @param ChildHandleBuffer The array of child handle.
452 @retval EFI_SUCCESS The controller or children are stopped.
453 @retval EFI_DEVICE_ERROR Failed to stop the driver.
458 QemuVideoControllerDriverStop (
459 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
460 IN EFI_HANDLE Controller
,
461 IN UINTN NumberOfChildren
,
462 IN EFI_HANDLE
*ChildHandleBuffer
465 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
468 QEMU_VIDEO_PRIVATE_DATA
*Private
;
470 if (NumberOfChildren
== 0) {
472 // Close the PCI I/O Protocol
476 &gEfiPciIoProtocolGuid
,
477 This
->DriverBindingHandle
,
484 // free all resources for whose access we need the child handle, because the
485 // child handle is going away
487 ASSERT (NumberOfChildren
== 1);
488 Status
= gBS
->OpenProtocol (
489 ChildHandleBuffer
[0],
490 &gEfiGraphicsOutputProtocolGuid
,
491 (VOID
**) &GraphicsOutput
,
492 This
->DriverBindingHandle
,
494 EFI_OPEN_PROTOCOL_GET_PROTOCOL
496 if (EFI_ERROR (Status
)) {
501 // Get our private context information
503 Private
= QEMU_VIDEO_PRIVATE_DATA_FROM_GRAPHICS_OUTPUT_THIS (GraphicsOutput
);
504 ASSERT (Private
->Handle
== ChildHandleBuffer
[0]);
506 QemuVideoGraphicsOutputDestructor (Private
);
508 // Remove the GOP protocol interface from the system
510 Status
= gBS
->UninstallMultipleProtocolInterfaces (
512 &gEfiGraphicsOutputProtocolGuid
,
513 &Private
->GraphicsOutput
,
517 if (EFI_ERROR (Status
)) {
522 // Restore original PCI attributes
524 Private
->PciIo
->Attributes (
526 EfiPciIoAttributeOperationSet
,
527 Private
->OriginalPciAttributes
,
533 &gEfiPciIoProtocolGuid
,
534 This
->DriverBindingHandle
,
538 FreePool (Private
->ModeData
);
539 gBS
->UninstallProtocolInterface (Private
->Handle
,
540 &gEfiDevicePathProtocolGuid
, Private
->GopDevicePath
);
541 FreePool (Private
->GopDevicePath
);
544 // Free our instance data
546 gBS
->FreePool (Private
);
552 TODO: Add function description
554 @param Private TODO: add argument description
555 @param Address TODO: add argument description
556 @param Data TODO: add argument description
558 TODO: add return values
563 QEMU_VIDEO_PRIVATE_DATA
*Private
,
568 Private
->PciIo
->Io
.Write (
571 EFI_PCI_IO_PASS_THROUGH_BAR
,
579 TODO: Add function description
581 @param Private TODO: add argument description
582 @param Address TODO: add argument description
583 @param Data TODO: add argument description
585 TODO: add return values
590 QEMU_VIDEO_PRIVATE_DATA
*Private
,
595 Private
->PciIo
->Io
.Write (
598 EFI_PCI_IO_PASS_THROUGH_BAR
,
606 TODO: Add function description
608 @param Private TODO: add argument description
609 @param Address TODO: add argument description
611 TODO: add return values
616 QEMU_VIDEO_PRIVATE_DATA
*Private
,
622 Private
->PciIo
->Io
.Read (
625 EFI_PCI_IO_PASS_THROUGH_BAR
,
634 TODO: Add function description
636 @param Private TODO: add argument description
637 @param Address TODO: add argument description
639 TODO: add return values
644 QEMU_VIDEO_PRIVATE_DATA
*Private
,
650 Private
->PciIo
->Io
.Read (
653 EFI_PCI_IO_PASS_THROUGH_BAR
,
662 TODO: Add function description
664 @param Private TODO: add argument description
665 @param Index TODO: add argument description
666 @param Red TODO: add argument description
667 @param Green TODO: add argument description
668 @param Blue TODO: add argument description
670 TODO: add return values
675 QEMU_VIDEO_PRIVATE_DATA
*Private
,
682 VgaOutb (Private
, PALETTE_INDEX_REGISTER
, (UINT8
) Index
);
683 VgaOutb (Private
, PALETTE_DATA_REGISTER
, (UINT8
) (Red
>> 2));
684 VgaOutb (Private
, PALETTE_DATA_REGISTER
, (UINT8
) (Green
>> 2));
685 VgaOutb (Private
, PALETTE_DATA_REGISTER
, (UINT8
) (Blue
>> 2));
689 TODO: Add function description
691 @param Private TODO: add argument description
693 TODO: add return values
698 QEMU_VIDEO_PRIVATE_DATA
*Private
707 for (RedIndex
= 0; RedIndex
< 8; RedIndex
++) {
708 for (GreenIndex
= 0; GreenIndex
< 8; GreenIndex
++) {
709 for (BlueIndex
= 0; BlueIndex
< 4; BlueIndex
++) {
710 SetPaletteColor (Private
, Index
, (UINT8
) (RedIndex
<< 5), (UINT8
) (GreenIndex
<< 5), (UINT8
) (BlueIndex
<< 6));
718 TODO: Add function description
720 @param Private TODO: add argument description
722 TODO: add return values
727 QEMU_VIDEO_PRIVATE_DATA
*Private
733 Private
->PciIo
->Mem
.Write (
735 EfiPciIoWidthFillUint32
,
744 TODO: Add function description
746 @param Private TODO: add argument description
748 TODO: add return values
753 QEMU_VIDEO_PRIVATE_DATA
*Private
,
761 TODO: Add function description
763 @param Private TODO: add argument description
764 @param ModeData TODO: add argument description
766 TODO: add return values
770 InitializeCirrusGraphicsMode (
771 QEMU_VIDEO_PRIVATE_DATA
*Private
,
772 QEMU_VIDEO_CIRRUS_MODES
*ModeData
778 outw (Private
, SEQ_ADDRESS_REGISTER
, 0x1206);
779 outw (Private
, SEQ_ADDRESS_REGISTER
, 0x0012);
781 for (Index
= 0; Index
< 15; Index
++) {
782 outw (Private
, SEQ_ADDRESS_REGISTER
, ModeData
->SeqSettings
[Index
]);
785 if (Private
->Variant
== QEMU_VIDEO_CIRRUS_5430
) {
786 outb (Private
, SEQ_ADDRESS_REGISTER
, 0x0f);
787 Byte
= (UINT8
) ((inb (Private
, SEQ_DATA_REGISTER
) & 0xc7) ^ 0x30);
788 outb (Private
, SEQ_DATA_REGISTER
, Byte
);
791 outb (Private
, MISC_OUTPUT_REGISTER
, ModeData
->MiscSetting
);
792 outw (Private
, GRAPH_ADDRESS_REGISTER
, 0x0506);
793 outw (Private
, SEQ_ADDRESS_REGISTER
, 0x0300);
794 outw (Private
, CRTC_ADDRESS_REGISTER
, 0x2011);
796 for (Index
= 0; Index
< 28; Index
++) {
797 outw (Private
, CRTC_ADDRESS_REGISTER
, (UINT16
) ((ModeData
->CrtcSettings
[Index
] << 8) | Index
));
800 for (Index
= 0; Index
< 9; Index
++) {
801 outw (Private
, GRAPH_ADDRESS_REGISTER
, (UINT16
) ((GraphicsController
[Index
] << 8) | Index
));
804 inb (Private
, INPUT_STATUS_1_REGISTER
);
806 for (Index
= 0; Index
< 21; Index
++) {
807 outb (Private
, ATT_ADDRESS_REGISTER
, (UINT8
) Index
);
808 outb (Private
, ATT_ADDRESS_REGISTER
, AttributeController
[Index
]);
811 outb (Private
, ATT_ADDRESS_REGISTER
, 0x20);
813 outw (Private
, GRAPH_ADDRESS_REGISTER
, 0x0009);
814 outw (Private
, GRAPH_ADDRESS_REGISTER
, 0x000a);
815 outw (Private
, GRAPH_ADDRESS_REGISTER
, 0x000b);
816 outb (Private
, DAC_PIXEL_MASK_REGISTER
, 0xff);
818 SetDefaultPalette (Private
);
819 ClearScreen (Private
);
824 QEMU_VIDEO_PRIVATE_DATA
*Private
,
831 if (Private
->Variant
== QEMU_VIDEO_BOCHS_MMIO
) {
832 Status
= Private
->PciIo
->Mem
.Write (
840 ASSERT_EFI_ERROR (Status
);
842 outw (Private
, VBE_DISPI_IOPORT_INDEX
, Reg
);
843 outw (Private
, VBE_DISPI_IOPORT_DATA
, Data
);
849 QEMU_VIDEO_PRIVATE_DATA
*Private
,
856 if (Private
->Variant
== QEMU_VIDEO_BOCHS_MMIO
) {
857 Status
= Private
->PciIo
->Mem
.Read (
865 ASSERT_EFI_ERROR (Status
);
867 outw (Private
, VBE_DISPI_IOPORT_INDEX
, Reg
);
868 Data
= inw (Private
, VBE_DISPI_IOPORT_DATA
);
875 QEMU_VIDEO_PRIVATE_DATA
*Private
,
882 if (Private
->Variant
== QEMU_VIDEO_BOCHS_MMIO
) {
883 Status
= Private
->PciIo
->Mem
.Write (
891 ASSERT_EFI_ERROR (Status
);
893 outb (Private
, Reg
, Data
);
898 InitializeBochsGraphicsMode (
899 QEMU_VIDEO_PRIVATE_DATA
*Private
,
900 QEMU_VIDEO_BOCHS_MODES
*ModeData
903 DEBUG ((EFI_D_INFO
, "InitializeBochsGraphicsMode: %dx%d @ %d\n",
904 ModeData
->Width
, ModeData
->Height
, ModeData
->ColorDepth
));
907 VgaOutb (Private
, ATT_ADDRESS_REGISTER
, 0x20);
909 BochsWrite (Private
, VBE_DISPI_INDEX_ENABLE
, 0);
910 BochsWrite (Private
, VBE_DISPI_INDEX_BANK
, 0);
911 BochsWrite (Private
, VBE_DISPI_INDEX_X_OFFSET
, 0);
912 BochsWrite (Private
, VBE_DISPI_INDEX_Y_OFFSET
, 0);
914 BochsWrite (Private
, VBE_DISPI_INDEX_BPP
, (UINT16
) ModeData
->ColorDepth
);
915 BochsWrite (Private
, VBE_DISPI_INDEX_XRES
, (UINT16
) ModeData
->Width
);
916 BochsWrite (Private
, VBE_DISPI_INDEX_VIRT_WIDTH
, (UINT16
) ModeData
->Width
);
917 BochsWrite (Private
, VBE_DISPI_INDEX_YRES
, (UINT16
) ModeData
->Height
);
918 BochsWrite (Private
, VBE_DISPI_INDEX_VIRT_HEIGHT
, (UINT16
) ModeData
->Height
);
920 BochsWrite (Private
, VBE_DISPI_INDEX_ENABLE
,
921 VBE_DISPI_ENABLED
| VBE_DISPI_LFB_ENABLED
);
923 SetDefaultPalette (Private
);
924 ClearScreen (Private
);
929 InitializeQemuVideo (
930 IN EFI_HANDLE ImageHandle
,
931 IN EFI_SYSTEM_TABLE
*SystemTable
936 Status
= EfiLibInstallDriverBindingComponentName2 (
939 &gQemuVideoDriverBinding
,
941 &gQemuVideoComponentName
,
942 &gQemuVideoComponentName2
944 ASSERT_EFI_ERROR (Status
);
947 // Install EFI Driver Supported EFI Version Protocol required for
948 // EFI drivers that are on PCI and other plug in cards.
950 gQemuVideoDriverSupportedEfiVersion
.FirmwareVersion
= PcdGet32 (PcdDriverSupportedEfiVersion
);
951 Status
= gBS
->InstallMultipleProtocolInterfaces (
953 &gEfiDriverSupportedEfiVersionProtocolGuid
,
954 &gQemuVideoDriverSupportedEfiVersion
,
957 ASSERT_EFI_ERROR (Status
);