507 lines
16 KiB
C
507 lines
16 KiB
C
|
/** @file
|
||
|
QEMU Video Controller Driver
|
||
|
|
||
|
Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
|
||
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
||
|
|
||
|
**/
|
||
|
|
||
|
//
|
||
|
// QEMU Video Controller Driver
|
||
|
//
|
||
|
|
||
|
#ifndef _QEMU_H_
|
||
|
#define _QEMU_H_
|
||
|
|
||
|
|
||
|
#include <Uefi.h>
|
||
|
#include <Protocol/GraphicsOutput.h>
|
||
|
#include <Protocol/PciIo.h>
|
||
|
#include <Protocol/DriverSupportedEfiVersion.h>
|
||
|
#include <Protocol/DevicePath.h>
|
||
|
|
||
|
#include <Library/DebugLib.h>
|
||
|
#include <Library/UefiDriverEntryPoint.h>
|
||
|
#include <Library/UefiLib.h>
|
||
|
#include <Library/PcdLib.h>
|
||
|
#include <Library/MemoryAllocationLib.h>
|
||
|
#include <Library/UefiBootServicesTableLib.h>
|
||
|
#include <Library/BaseMemoryLib.h>
|
||
|
#include <Library/DevicePathLib.h>
|
||
|
#include <Library/TimerLib.h>
|
||
|
#include <Library/FrameBufferBltLib.h>
|
||
|
|
||
|
#include <IndustryStandard/Pci.h>
|
||
|
#include <IndustryStandard/Acpi.h>
|
||
|
|
||
|
//
|
||
|
// QEMU Video PCI Configuration Header values
|
||
|
//
|
||
|
#define CIRRUS_LOGIC_VENDOR_ID 0x1013
|
||
|
#define CIRRUS_LOGIC_5430_DEVICE_ID 0x00a8
|
||
|
#define CIRRUS_LOGIC_5430_ALTERNATE_DEVICE_ID 0x00a0
|
||
|
#define CIRRUS_LOGIC_5446_DEVICE_ID 0x00b8
|
||
|
|
||
|
//
|
||
|
// QEMU Vide Graphical Mode Data
|
||
|
//
|
||
|
typedef struct {
|
||
|
UINT32 InternalModeIndex; // points into card-specific mode table
|
||
|
UINT32 HorizontalResolution;
|
||
|
UINT32 VerticalResolution;
|
||
|
UINT32 ColorDepth;
|
||
|
} QEMU_VIDEO_MODE_DATA;
|
||
|
|
||
|
#define PIXEL_RED_SHIFT 0
|
||
|
#define PIXEL_GREEN_SHIFT 3
|
||
|
#define PIXEL_BLUE_SHIFT 6
|
||
|
|
||
|
#define PIXEL_RED_MASK (BIT7 | BIT6 | BIT5)
|
||
|
#define PIXEL_GREEN_MASK (BIT4 | BIT3 | BIT2)
|
||
|
#define PIXEL_BLUE_MASK (BIT1 | BIT0)
|
||
|
|
||
|
#define PIXEL_TO_COLOR_BYTE(pixel, mask, shift) ((UINT8) ((pixel & mask) << shift))
|
||
|
#define PIXEL_TO_RED_BYTE(pixel) PIXEL_TO_COLOR_BYTE(pixel, PIXEL_RED_MASK, PIXEL_RED_SHIFT)
|
||
|
#define PIXEL_TO_GREEN_BYTE(pixel) PIXEL_TO_COLOR_BYTE(pixel, PIXEL_GREEN_MASK, PIXEL_GREEN_SHIFT)
|
||
|
#define PIXEL_TO_BLUE_BYTE(pixel) PIXEL_TO_COLOR_BYTE(pixel, PIXEL_BLUE_MASK, PIXEL_BLUE_SHIFT)
|
||
|
|
||
|
#define RGB_BYTES_TO_PIXEL(Red, Green, Blue) \
|
||
|
(UINT8) ( (((Red) >> PIXEL_RED_SHIFT) & PIXEL_RED_MASK) | \
|
||
|
(((Green) >> PIXEL_GREEN_SHIFT) & PIXEL_GREEN_MASK) | \
|
||
|
(((Blue) >> PIXEL_BLUE_SHIFT) & PIXEL_BLUE_MASK) )
|
||
|
|
||
|
#define PIXEL24_RED_MASK 0x00ff0000
|
||
|
#define PIXEL24_GREEN_MASK 0x0000ff00
|
||
|
#define PIXEL24_BLUE_MASK 0x000000ff
|
||
|
|
||
|
#define GRAPHICS_OUTPUT_INVALIDE_MODE_NUMBER 0xffff
|
||
|
|
||
|
//
|
||
|
// QEMU Video Private Data Structure
|
||
|
//
|
||
|
#define QEMU_VIDEO_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('Q', 'V', 'I', 'D')
|
||
|
|
||
|
typedef enum {
|
||
|
QEMU_VIDEO_CIRRUS_5430 = 1,
|
||
|
QEMU_VIDEO_CIRRUS_5446,
|
||
|
QEMU_VIDEO_BOCHS,
|
||
|
QEMU_VIDEO_BOCHS_MMIO,
|
||
|
QEMU_VIDEO_VMWARE_SVGA,
|
||
|
} QEMU_VIDEO_VARIANT;
|
||
|
|
||
|
typedef struct {
|
||
|
UINT8 SubClass;
|
||
|
UINT16 VendorId;
|
||
|
UINT16 DeviceId;
|
||
|
QEMU_VIDEO_VARIANT Variant;
|
||
|
CHAR16 *Name;
|
||
|
} QEMU_VIDEO_CARD;
|
||
|
|
||
|
typedef struct {
|
||
|
UINT64 Signature;
|
||
|
EFI_HANDLE Handle;
|
||
|
EFI_PCI_IO_PROTOCOL *PciIo;
|
||
|
UINT64 OriginalPciAttributes;
|
||
|
EFI_GRAPHICS_OUTPUT_PROTOCOL GraphicsOutput;
|
||
|
EFI_DEVICE_PATH_PROTOCOL *GopDevicePath;
|
||
|
|
||
|
//
|
||
|
// The next two fields match the client-visible
|
||
|
// EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE.MaxMode field.
|
||
|
//
|
||
|
UINTN MaxMode;
|
||
|
QEMU_VIDEO_MODE_DATA *ModeData;
|
||
|
|
||
|
QEMU_VIDEO_VARIANT Variant;
|
||
|
FRAME_BUFFER_CONFIGURE *FrameBufferBltConfigure;
|
||
|
UINTN FrameBufferBltConfigureSize;
|
||
|
UINT8 FrameBufferVramBarIndex;
|
||
|
} QEMU_VIDEO_PRIVATE_DATA;
|
||
|
|
||
|
///
|
||
|
/// Card-specific Video Mode structures
|
||
|
///
|
||
|
typedef struct {
|
||
|
UINT32 Width;
|
||
|
UINT32 Height;
|
||
|
UINT32 ColorDepth;
|
||
|
UINT8 *CrtcSettings;
|
||
|
UINT16 *SeqSettings;
|
||
|
UINT8 MiscSetting;
|
||
|
} QEMU_VIDEO_CIRRUS_MODES;
|
||
|
|
||
|
typedef struct {
|
||
|
UINT32 Width;
|
||
|
UINT32 Height;
|
||
|
UINT32 ColorDepth;
|
||
|
} QEMU_VIDEO_BOCHS_MODES;
|
||
|
|
||
|
#define QEMU_VIDEO_PRIVATE_DATA_FROM_GRAPHICS_OUTPUT_THIS(a) \
|
||
|
CR(a, QEMU_VIDEO_PRIVATE_DATA, GraphicsOutput, QEMU_VIDEO_PRIVATE_DATA_SIGNATURE)
|
||
|
|
||
|
|
||
|
//
|
||
|
// Global Variables
|
||
|
//
|
||
|
extern UINT8 AttributeController[];
|
||
|
extern UINT8 GraphicsController[];
|
||
|
extern UINT8 Crtc_640_480_256_60[];
|
||
|
extern UINT16 Seq_640_480_256_60[];
|
||
|
extern UINT8 Crtc_800_600_256_60[];
|
||
|
extern UINT16 Seq_800_600_256_60[];
|
||
|
extern UINT8 Crtc_1024_768_256_60[];
|
||
|
extern UINT16 Seq_1024_768_256_60[];
|
||
|
extern QEMU_VIDEO_CIRRUS_MODES QemuVideoCirrusModes[];
|
||
|
extern QEMU_VIDEO_BOCHS_MODES QemuVideoBochsModes[];
|
||
|
extern EFI_DRIVER_BINDING_PROTOCOL gQemuVideoDriverBinding;
|
||
|
extern EFI_COMPONENT_NAME_PROTOCOL gQemuVideoComponentName;
|
||
|
extern EFI_COMPONENT_NAME2_PROTOCOL gQemuVideoComponentName2;
|
||
|
|
||
|
//
|
||
|
// Io Registers defined by VGA
|
||
|
//
|
||
|
#define CRTC_ADDRESS_REGISTER 0x3d4
|
||
|
#define CRTC_DATA_REGISTER 0x3d5
|
||
|
#define SEQ_ADDRESS_REGISTER 0x3c4
|
||
|
#define SEQ_DATA_REGISTER 0x3c5
|
||
|
#define GRAPH_ADDRESS_REGISTER 0x3ce
|
||
|
#define GRAPH_DATA_REGISTER 0x3cf
|
||
|
#define ATT_ADDRESS_REGISTER 0x3c0
|
||
|
#define MISC_OUTPUT_REGISTER 0x3c2
|
||
|
#define INPUT_STATUS_1_REGISTER 0x3da
|
||
|
#define DAC_PIXEL_MASK_REGISTER 0x3c6
|
||
|
#define PALETTE_INDEX_REGISTER 0x3c8
|
||
|
#define PALETTE_DATA_REGISTER 0x3c9
|
||
|
|
||
|
#define VBE_DISPI_IOPORT_INDEX 0x01CE
|
||
|
#define VBE_DISPI_IOPORT_DATA 0x01D0
|
||
|
|
||
|
#define VBE_DISPI_INDEX_ID 0x0
|
||
|
#define VBE_DISPI_INDEX_XRES 0x1
|
||
|
#define VBE_DISPI_INDEX_YRES 0x2
|
||
|
#define VBE_DISPI_INDEX_BPP 0x3
|
||
|
#define VBE_DISPI_INDEX_ENABLE 0x4
|
||
|
#define VBE_DISPI_INDEX_BANK 0x5
|
||
|
#define VBE_DISPI_INDEX_VIRT_WIDTH 0x6
|
||
|
#define VBE_DISPI_INDEX_VIRT_HEIGHT 0x7
|
||
|
#define VBE_DISPI_INDEX_X_OFFSET 0x8
|
||
|
#define VBE_DISPI_INDEX_Y_OFFSET 0x9
|
||
|
#define VBE_DISPI_INDEX_VIDEO_MEMORY_64K 0xa
|
||
|
|
||
|
#define VBE_DISPI_ID0 0xB0C0
|
||
|
#define VBE_DISPI_ID1 0xB0C1
|
||
|
#define VBE_DISPI_ID2 0xB0C2
|
||
|
#define VBE_DISPI_ID3 0xB0C3
|
||
|
#define VBE_DISPI_ID4 0xB0C4
|
||
|
#define VBE_DISPI_ID5 0xB0C5
|
||
|
|
||
|
#define VBE_DISPI_DISABLED 0x00
|
||
|
#define VBE_DISPI_ENABLED 0x01
|
||
|
#define VBE_DISPI_GETCAPS 0x02
|
||
|
#define VBE_DISPI_8BIT_DAC 0x20
|
||
|
#define VBE_DISPI_LFB_ENABLED 0x40
|
||
|
#define VBE_DISPI_NOCLEARMEM 0x80
|
||
|
|
||
|
//
|
||
|
// Graphics Output Hardware abstraction internal worker functions
|
||
|
//
|
||
|
EFI_STATUS
|
||
|
QemuVideoGraphicsOutputConstructor (
|
||
|
QEMU_VIDEO_PRIVATE_DATA *Private
|
||
|
);
|
||
|
|
||
|
EFI_STATUS
|
||
|
QemuVideoGraphicsOutputDestructor (
|
||
|
QEMU_VIDEO_PRIVATE_DATA *Private
|
||
|
);
|
||
|
|
||
|
|
||
|
//
|
||
|
// EFI_DRIVER_BINDING_PROTOCOL Protocol Interface
|
||
|
//
|
||
|
/**
|
||
|
TODO: Add function description
|
||
|
|
||
|
@param This TODO: add argument description
|
||
|
@param Controller TODO: add argument description
|
||
|
@param RemainingDevicePath TODO: add argument description
|
||
|
|
||
|
TODO: add return values
|
||
|
|
||
|
**/
|
||
|
EFI_STATUS
|
||
|
EFIAPI
|
||
|
QemuVideoControllerDriverSupported (
|
||
|
IN EFI_DRIVER_BINDING_PROTOCOL *This,
|
||
|
IN EFI_HANDLE Controller,
|
||
|
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
|
||
|
);
|
||
|
|
||
|
/**
|
||
|
TODO: Add function description
|
||
|
|
||
|
@param This TODO: add argument description
|
||
|
@param Controller TODO: add argument description
|
||
|
@param RemainingDevicePath TODO: add argument description
|
||
|
|
||
|
TODO: add return values
|
||
|
|
||
|
**/
|
||
|
EFI_STATUS
|
||
|
EFIAPI
|
||
|
QemuVideoControllerDriverStart (
|
||
|
IN EFI_DRIVER_BINDING_PROTOCOL *This,
|
||
|
IN EFI_HANDLE Controller,
|
||
|
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
|
||
|
);
|
||
|
|
||
|
/**
|
||
|
TODO: Add function description
|
||
|
|
||
|
@param This TODO: add argument description
|
||
|
@param Controller TODO: add argument description
|
||
|
@param NumberOfChildren TODO: add argument description
|
||
|
@param ChildHandleBuffer TODO: add argument description
|
||
|
|
||
|
TODO: add return values
|
||
|
|
||
|
**/
|
||
|
EFI_STATUS
|
||
|
EFIAPI
|
||
|
QemuVideoControllerDriverStop (
|
||
|
IN EFI_DRIVER_BINDING_PROTOCOL *This,
|
||
|
IN EFI_HANDLE Controller,
|
||
|
IN UINTN NumberOfChildren,
|
||
|
IN EFI_HANDLE *ChildHandleBuffer
|
||
|
);
|
||
|
|
||
|
//
|
||
|
// EFI Component Name Functions
|
||
|
//
|
||
|
/**
|
||
|
Retrieves a Unicode string that is the user readable name of the driver.
|
||
|
|
||
|
This function retrieves the user readable name of a driver in the form of a
|
||
|
Unicode string. If the driver specified by This has a user readable name in
|
||
|
the language specified by Language, then a pointer to the driver name is
|
||
|
returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
|
||
|
by This does not support the language specified by Language,
|
||
|
then EFI_UNSUPPORTED is returned.
|
||
|
|
||
|
@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
|
||
|
EFI_COMPONENT_NAME_PROTOCOL instance.
|
||
|
|
||
|
@param Language[in] A pointer to a Null-terminated ASCII string
|
||
|
array indicating the language. This is the
|
||
|
language of the driver name that the caller is
|
||
|
requesting, and it must match one of the
|
||
|
languages specified in SupportedLanguages. The
|
||
|
number of languages supported by a driver is up
|
||
|
to the driver writer. Language is specified
|
||
|
in RFC 4646 or ISO 639-2 language code format.
|
||
|
|
||
|
@param DriverName[out] A pointer to the Unicode string to return.
|
||
|
This Unicode string is the name of the
|
||
|
driver specified by This in the language
|
||
|
specified by Language.
|
||
|
|
||
|
@retval EFI_SUCCESS The Unicode string for the Driver specified by
|
||
|
This and the language specified by Language was
|
||
|
returned in DriverName.
|
||
|
|
||
|
@retval EFI_INVALID_PARAMETER Language is NULL.
|
||
|
|
||
|
@retval EFI_INVALID_PARAMETER DriverName is NULL.
|
||
|
|
||
|
@retval EFI_UNSUPPORTED The driver specified by This does not support
|
||
|
the language specified by Language.
|
||
|
|
||
|
**/
|
||
|
EFI_STATUS
|
||
|
EFIAPI
|
||
|
QemuVideoComponentNameGetDriverName (
|
||
|
IN EFI_COMPONENT_NAME_PROTOCOL *This,
|
||
|
IN CHAR8 *Language,
|
||
|
OUT CHAR16 **DriverName
|
||
|
);
|
||
|
|
||
|
|
||
|
/**
|
||
|
Retrieves a Unicode string that is the user readable name of the controller
|
||
|
that is being managed by a driver.
|
||
|
|
||
|
This function retrieves the user readable name of the controller specified by
|
||
|
ControllerHandle and ChildHandle in the form of a Unicode string. If the
|
||
|
driver specified by This has a user readable name in the language specified by
|
||
|
Language, then a pointer to the controller name is returned in ControllerName,
|
||
|
and EFI_SUCCESS is returned. If the driver specified by This is not currently
|
||
|
managing the controller specified by ControllerHandle and ChildHandle,
|
||
|
then EFI_UNSUPPORTED is returned. If the driver specified by This does not
|
||
|
support the language specified by Language, then EFI_UNSUPPORTED is returned.
|
||
|
|
||
|
@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
|
||
|
EFI_COMPONENT_NAME_PROTOCOL instance.
|
||
|
|
||
|
@param ControllerHandle[in] The handle of a controller that the driver
|
||
|
specified by This is managing. This handle
|
||
|
specifies the controller whose name is to be
|
||
|
returned.
|
||
|
|
||
|
@param ChildHandle[in] The handle of the child controller to retrieve
|
||
|
the name of. This is an optional parameter that
|
||
|
may be NULL. It will be NULL for device
|
||
|
drivers. It will also be NULL for a bus drivers
|
||
|
that wish to retrieve the name of the bus
|
||
|
controller. It will not be NULL for a bus
|
||
|
driver that wishes to retrieve the name of a
|
||
|
child controller.
|
||
|
|
||
|
@param Language[in] A pointer to a Null-terminated ASCII string
|
||
|
array indicating the language. This is the
|
||
|
language of the driver name that the caller is
|
||
|
requesting, and it must match one of the
|
||
|
languages specified in SupportedLanguages. The
|
||
|
number of languages supported by a driver is up
|
||
|
to the driver writer. Language is specified in
|
||
|
RFC 4646 or ISO 639-2 language code format.
|
||
|
|
||
|
@param ControllerName[out] A pointer to the Unicode string to return.
|
||
|
This Unicode string is the name of the
|
||
|
controller specified by ControllerHandle and
|
||
|
ChildHandle in the language specified by
|
||
|
Language from the point of view of the driver
|
||
|
specified by This.
|
||
|
|
||
|
@retval EFI_SUCCESS The Unicode string for the user readable name in
|
||
|
the language specified by Language for the
|
||
|
driver specified by This was returned in
|
||
|
DriverName.
|
||
|
|
||
|
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
|
||
|
|
||
|
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
|
||
|
EFI_HANDLE.
|
||
|
|
||
|
@retval EFI_INVALID_PARAMETER Language is NULL.
|
||
|
|
||
|
@retval EFI_INVALID_PARAMETER ControllerName is NULL.
|
||
|
|
||
|
@retval EFI_UNSUPPORTED The driver specified by This is not currently
|
||
|
managing the controller specified by
|
||
|
ControllerHandle and ChildHandle.
|
||
|
|
||
|
@retval EFI_UNSUPPORTED The driver specified by This does not support
|
||
|
the language specified by Language.
|
||
|
|
||
|
**/
|
||
|
EFI_STATUS
|
||
|
EFIAPI
|
||
|
QemuVideoComponentNameGetControllerName (
|
||
|
IN EFI_COMPONENT_NAME_PROTOCOL *This,
|
||
|
IN EFI_HANDLE ControllerHandle,
|
||
|
IN EFI_HANDLE ChildHandle OPTIONAL,
|
||
|
IN CHAR8 *Language,
|
||
|
OUT CHAR16 **ControllerName
|
||
|
);
|
||
|
|
||
|
|
||
|
//
|
||
|
// Local Function Prototypes
|
||
|
//
|
||
|
VOID
|
||
|
InitializeCirrusGraphicsMode (
|
||
|
QEMU_VIDEO_PRIVATE_DATA *Private,
|
||
|
QEMU_VIDEO_CIRRUS_MODES *ModeData
|
||
|
);
|
||
|
|
||
|
VOID
|
||
|
InitializeBochsGraphicsMode (
|
||
|
QEMU_VIDEO_PRIVATE_DATA *Private,
|
||
|
QEMU_VIDEO_BOCHS_MODES *ModeData
|
||
|
);
|
||
|
|
||
|
VOID
|
||
|
SetPaletteColor (
|
||
|
QEMU_VIDEO_PRIVATE_DATA *Private,
|
||
|
UINTN Index,
|
||
|
UINT8 Red,
|
||
|
UINT8 Green,
|
||
|
UINT8 Blue
|
||
|
);
|
||
|
|
||
|
VOID
|
||
|
SetDefaultPalette (
|
||
|
QEMU_VIDEO_PRIVATE_DATA *Private
|
||
|
);
|
||
|
|
||
|
VOID
|
||
|
DrawLogo (
|
||
|
QEMU_VIDEO_PRIVATE_DATA *Private,
|
||
|
UINTN ScreenWidth,
|
||
|
UINTN ScreenHeight
|
||
|
);
|
||
|
|
||
|
VOID
|
||
|
outb (
|
||
|
QEMU_VIDEO_PRIVATE_DATA *Private,
|
||
|
UINTN Address,
|
||
|
UINT8 Data
|
||
|
);
|
||
|
|
||
|
VOID
|
||
|
outw (
|
||
|
QEMU_VIDEO_PRIVATE_DATA *Private,
|
||
|
UINTN Address,
|
||
|
UINT16 Data
|
||
|
);
|
||
|
|
||
|
UINT8
|
||
|
inb (
|
||
|
QEMU_VIDEO_PRIVATE_DATA *Private,
|
||
|
UINTN Address
|
||
|
);
|
||
|
|
||
|
UINT16
|
||
|
inw (
|
||
|
QEMU_VIDEO_PRIVATE_DATA *Private,
|
||
|
UINTN Address
|
||
|
);
|
||
|
|
||
|
VOID
|
||
|
BochsWrite (
|
||
|
QEMU_VIDEO_PRIVATE_DATA *Private,
|
||
|
UINT16 Reg,
|
||
|
UINT16 Data
|
||
|
);
|
||
|
|
||
|
UINT16
|
||
|
BochsRead (
|
||
|
QEMU_VIDEO_PRIVATE_DATA *Private,
|
||
|
UINT16 Reg
|
||
|
);
|
||
|
|
||
|
VOID
|
||
|
VgaOutb (
|
||
|
QEMU_VIDEO_PRIVATE_DATA *Private,
|
||
|
UINTN Reg,
|
||
|
UINT8 Data
|
||
|
);
|
||
|
|
||
|
EFI_STATUS
|
||
|
QemuVideoCirrusModeSetup (
|
||
|
QEMU_VIDEO_PRIVATE_DATA *Private
|
||
|
);
|
||
|
|
||
|
EFI_STATUS
|
||
|
QemuVideoBochsModeSetup (
|
||
|
QEMU_VIDEO_PRIVATE_DATA *Private,
|
||
|
BOOLEAN IsQxl
|
||
|
);
|
||
|
|
||
|
VOID
|
||
|
InstallVbeShim (
|
||
|
IN CONST CHAR16 *CardName,
|
||
|
IN EFI_PHYSICAL_ADDRESS FrameBufferBase
|
||
|
);
|
||
|
#endif
|