[mirror_edk2.git] / OvmfPkg / QemuVideoDxe / Qemu.h

/** @file\r
  QEMU Video Controller Driver\r
\r
  Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
//\r
// QEMU Video Controller Driver\r
//\r
\r
#ifndef _QEMU_H_\r
#define _QEMU_H_\r
\r
\r
#include <Uefi.h>\r
#include <Protocol/GraphicsOutput.h>\r
#include <Protocol/PciIo.h>\r
#include <Protocol/DriverSupportedEfiVersion.h>\r
#include <Protocol/DevicePath.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/TimerLib.h>\r
#include <Library/FrameBufferBltLib.h>\r
\r
#include <IndustryStandard/Pci.h>\r
#include <IndustryStandard/Acpi.h>\r
\r
//\r
// QEMU Video PCI Configuration Header values\r
//\r
#define CIRRUS_LOGIC_VENDOR_ID                0x1013\r
#define CIRRUS_LOGIC_5430_DEVICE_ID           0x00a8\r
#define CIRRUS_LOGIC_5430_ALTERNATE_DEVICE_ID 0x00a0\r
#define CIRRUS_LOGIC_5446_DEVICE_ID           0x00b8\r
\r
//\r
// QEMU Vide Graphical Mode Data\r
//\r
typedef struct {\r
  UINT32  InternalModeIndex; // points into card-specific mode table\r
  UINT32  HorizontalResolution;\r
  UINT32  VerticalResolution;\r
  UINT32  ColorDepth;\r
} QEMU_VIDEO_MODE_DATA;\r
\r
#define PIXEL_RED_SHIFT   0\r
#define PIXEL_GREEN_SHIFT 3\r
#define PIXEL_BLUE_SHIFT  6\r
\r
#define PIXEL_RED_MASK    (BIT7 | BIT6 | BIT5)\r
#define PIXEL_GREEN_MASK  (BIT4 | BIT3 | BIT2)\r
#define PIXEL_BLUE_MASK   (BIT1 | BIT0)\r
\r
#define PIXEL_TO_COLOR_BYTE(pixel, mask, shift) ((UINT8) ((pixel & mask) << shift))\r
#define PIXEL_TO_RED_BYTE(pixel) PIXEL_TO_COLOR_BYTE(pixel, PIXEL_RED_MASK, PIXEL_RED_SHIFT)\r
#define PIXEL_TO_GREEN_BYTE(pixel) PIXEL_TO_COLOR_BYTE(pixel, PIXEL_GREEN_MASK, PIXEL_GREEN_SHIFT)\r
#define PIXEL_TO_BLUE_BYTE(pixel) PIXEL_TO_COLOR_BYTE(pixel, PIXEL_BLUE_MASK, PIXEL_BLUE_SHIFT)\r
\r
#define RGB_BYTES_TO_PIXEL(Red, Green, Blue) \\r
  (UINT8) ( (((Red) >> PIXEL_RED_SHIFT) & PIXEL_RED_MASK) | \\r
            (((Green) >> PIXEL_GREEN_SHIFT) & PIXEL_GREEN_MASK) | \\r
            (((Blue) >> PIXEL_BLUE_SHIFT) & PIXEL_BLUE_MASK) )\r
\r
#define PIXEL24_RED_MASK    0x00ff0000\r
#define PIXEL24_GREEN_MASK  0x0000ff00\r
#define PIXEL24_BLUE_MASK   0x000000ff\r
\r
#define GRAPHICS_OUTPUT_INVALIDE_MODE_NUMBER  0xffff\r
\r
//\r
// QEMU Video Private Data Structure\r
//\r
#define QEMU_VIDEO_PRIVATE_DATA_SIGNATURE  SIGNATURE_32 ('Q', 'V', 'I', 'D')\r
\r
typedef enum {\r
  QEMU_VIDEO_CIRRUS_5430 = 1,\r
  QEMU_VIDEO_CIRRUS_5446,\r
  QEMU_VIDEO_BOCHS,\r
  QEMU_VIDEO_BOCHS_MMIO,\r
  QEMU_VIDEO_VMWARE_SVGA,\r
} QEMU_VIDEO_VARIANT;\r
\r
typedef struct {\r
  UINT16                                VendorId;\r
  UINT16                                DeviceId;\r
  QEMU_VIDEO_VARIANT                    Variant;\r
  CHAR16                                *Name;\r
} QEMU_VIDEO_CARD;\r
\r
typedef struct {\r
  UINT64                                Signature;\r
  EFI_HANDLE                            Handle;\r
  EFI_PCI_IO_PROTOCOL                   *PciIo;\r
  UINT64                                OriginalPciAttributes;\r
  EFI_GRAPHICS_OUTPUT_PROTOCOL          GraphicsOutput;\r
  EFI_DEVICE_PATH_PROTOCOL              *GopDevicePath;\r
\r
  //\r
  // The next two fields match the client-visible\r
  // EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE.MaxMode field.\r
  //\r
  UINTN                                 MaxMode;\r
  QEMU_VIDEO_MODE_DATA                  *ModeData;\r
  EFI_GRAPHICS_OUTPUT_MODE_INFORMATION  *VmwareSvgaModeInfo;\r
\r
  QEMU_VIDEO_VARIANT                    Variant;\r
  FRAME_BUFFER_CONFIGURE                *FrameBufferBltConfigure;\r
  UINTN                                 FrameBufferBltConfigureSize;\r
  UINT8                                 FrameBufferVramBarIndex;\r
  UINT16                                VmwareSvgaBasePort;\r
} QEMU_VIDEO_PRIVATE_DATA;\r
\r
///\r
/// Card-specific Video Mode structures\r
///\r
typedef struct {\r
  UINT32  Width;\r
  UINT32  Height;\r
  UINT32  ColorDepth;\r
  UINT8   *CrtcSettings;\r
  UINT16  *SeqSettings;\r
  UINT8   MiscSetting;\r
} QEMU_VIDEO_CIRRUS_MODES;\r
\r
typedef struct {\r
  UINT32  Width;\r
  UINT32  Height;\r
  UINT32  ColorDepth;\r
} QEMU_VIDEO_BOCHS_MODES;\r
\r
#define QEMU_VIDEO_PRIVATE_DATA_FROM_GRAPHICS_OUTPUT_THIS(a) \\r
  CR(a, QEMU_VIDEO_PRIVATE_DATA, GraphicsOutput, QEMU_VIDEO_PRIVATE_DATA_SIGNATURE)\r
\r
\r
//\r
// Global Variables\r
//\r
extern UINT8                                      AttributeController[];\r
extern UINT8                                      GraphicsController[];\r
extern UINT8                                      Crtc_640_480_256_60[];\r
extern UINT16                                     Seq_640_480_256_60[];\r
extern UINT8                                      Crtc_800_600_256_60[];\r
extern UINT16                                     Seq_800_600_256_60[];\r
extern UINT8                                      Crtc_1024_768_256_60[];\r
extern UINT16                                     Seq_1024_768_256_60[];\r
extern QEMU_VIDEO_CIRRUS_MODES                    QemuVideoCirrusModes[];\r
extern QEMU_VIDEO_BOCHS_MODES                     QemuVideoBochsModes[];\r
extern EFI_DRIVER_BINDING_PROTOCOL                gQemuVideoDriverBinding;\r
extern EFI_COMPONENT_NAME_PROTOCOL                gQemuVideoComponentName;\r
extern EFI_COMPONENT_NAME2_PROTOCOL               gQemuVideoComponentName2;\r
extern EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL  gQemuVideoDriverSupportedEfiVersion;\r
\r
//\r
// Io Registers defined by VGA\r
//\r
#define CRTC_ADDRESS_REGISTER   0x3d4\r
#define CRTC_DATA_REGISTER      0x3d5\r
#define SEQ_ADDRESS_REGISTER    0x3c4\r
#define SEQ_DATA_REGISTER       0x3c5\r
#define GRAPH_ADDRESS_REGISTER  0x3ce\r
#define GRAPH_DATA_REGISTER     0x3cf\r
#define ATT_ADDRESS_REGISTER    0x3c0\r
#define MISC_OUTPUT_REGISTER    0x3c2\r
#define INPUT_STATUS_1_REGISTER 0x3da\r
#define DAC_PIXEL_MASK_REGISTER 0x3c6\r
#define PALETTE_INDEX_REGISTER  0x3c8\r
#define PALETTE_DATA_REGISTER   0x3c9\r
\r
#define VBE_DISPI_IOPORT_INDEX           0x01CE\r
#define VBE_DISPI_IOPORT_DATA            0x01D0\r
\r
#define VBE_DISPI_INDEX_ID               0x0\r
#define VBE_DISPI_INDEX_XRES             0x1\r
#define VBE_DISPI_INDEX_YRES             0x2\r
#define VBE_DISPI_INDEX_BPP              0x3\r
#define VBE_DISPI_INDEX_ENABLE           0x4\r
#define VBE_DISPI_INDEX_BANK             0x5\r
#define VBE_DISPI_INDEX_VIRT_WIDTH       0x6\r
#define VBE_DISPI_INDEX_VIRT_HEIGHT      0x7\r
#define VBE_DISPI_INDEX_X_OFFSET         0x8\r
#define VBE_DISPI_INDEX_Y_OFFSET         0x9\r
#define VBE_DISPI_INDEX_VIDEO_MEMORY_64K 0xa\r
\r
#define VBE_DISPI_ID0                    0xB0C0\r
#define VBE_DISPI_ID1                    0xB0C1\r
#define VBE_DISPI_ID2                    0xB0C2\r
#define VBE_DISPI_ID3                    0xB0C3\r
#define VBE_DISPI_ID4                    0xB0C4\r
#define VBE_DISPI_ID5                    0xB0C5\r
\r
#define VBE_DISPI_DISABLED               0x00\r
#define VBE_DISPI_ENABLED                0x01\r
#define VBE_DISPI_GETCAPS                0x02\r
#define VBE_DISPI_8BIT_DAC               0x20\r
#define VBE_DISPI_LFB_ENABLED            0x40\r
#define VBE_DISPI_NOCLEARMEM             0x80\r
\r
//\r
// Graphics Output Hardware abstraction internal worker functions\r
//\r
EFI_STATUS\r
QemuVideoGraphicsOutputConstructor (\r
  QEMU_VIDEO_PRIVATE_DATA  *Private\r
  );\r
\r
EFI_STATUS\r
QemuVideoGraphicsOutputDestructor (\r
  QEMU_VIDEO_PRIVATE_DATA  *Private\r
  );\r
\r
\r
//\r
// EFI_DRIVER_BINDING_PROTOCOL Protocol Interface\r
//\r
/**\r
  TODO: Add function description\r
\r
  @param  This TODO: add argument description\r
  @param  Controller TODO: add argument description\r
  @param  RemainingDevicePath TODO: add argument description\r
\r
  TODO: add return values\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
QemuVideoControllerDriverSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  );\r
\r
/**\r
  TODO: Add function description\r
\r
  @param  This TODO: add argument description\r
  @param  Controller TODO: add argument description\r
  @param  RemainingDevicePath TODO: add argument description\r
\r
  TODO: add return values\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
QemuVideoControllerDriverStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  );\r
\r
/**\r
  TODO: Add function description\r
\r
  @param  This TODO: add argument description\r
  @param  Controller TODO: add argument description\r
  @param  NumberOfChildren TODO: add argument description\r
  @param  ChildHandleBuffer TODO: add argument description\r
\r
  TODO: add return values\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
QemuVideoControllerDriverStop (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   Controller,\r
  IN UINTN                        NumberOfChildren,\r
  IN EFI_HANDLE                   *ChildHandleBuffer\r
  );\r
\r
//\r
// EFI Component Name Functions\r
//\r
/**\r
  Retrieves a Unicode string that is the user readable name of the driver.\r
\r
  This function retrieves the user readable name of a driver in the form of a\r
  Unicode string. If the driver specified by This has a user readable name in\r
  the language specified by Language, then a pointer to the driver name is\r
  returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
  by This does not support the language specified by Language,\r
  then EFI_UNSUPPORTED is returned.\r
\r
  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
  @param  Language[in]          A pointer to a Null-terminated ASCII string\r
                                array indicating the language. This is the\r
                                language of the driver name that the caller is\r
                                requesting, and it must match one of the\r
                                languages specified in SupportedLanguages. The\r
                                number of languages supported by a driver is up\r
                                to the driver writer. Language is specified\r
                                in RFC 4646 or ISO 639-2 language code format.\r
\r
  @param  DriverName[out]       A pointer to the Unicode string to return.\r
                                This Unicode string is the name of the\r
                                driver specified by This in the language\r
                                specified by Language.\r
\r
  @retval EFI_SUCCESS           The Unicode string for the Driver specified by\r
                                This and the language specified by Language was\r
                                returned in DriverName.\r
\r
  @retval EFI_INVALID_PARAMETER Language is NULL.\r
\r
  @retval EFI_INVALID_PARAMETER DriverName is NULL.\r
\r
  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
                                the language specified by Language.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
QemuVideoComponentNameGetDriverName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
  IN  CHAR8                        *Language,\r
  OUT CHAR16                       **DriverName\r
  );\r
\r
\r
/**\r
  Retrieves a Unicode string that is the user readable name of the controller\r
  that is being managed by a driver.\r
\r
  This function retrieves the user readable name of the controller specified by\r
  ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
  driver specified by This has a user readable name in the language specified by\r
  Language, then a pointer to the controller name is returned in ControllerName,\r
  and EFI_SUCCESS is returned.  If the driver specified by This is not currently\r
  managing the controller specified by ControllerHandle and ChildHandle,\r
  then EFI_UNSUPPORTED is returned.  If the driver specified by This does not\r
  support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
\r
  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
  @param  ControllerHandle[in]  The handle of a controller that the driver\r
                                specified by This is managing.  This handle\r
                                specifies the controller whose name is to be\r
                                returned.\r
\r
  @param  ChildHandle[in]       The handle of the child controller to retrieve\r
                                the name of.  This is an optional parameter that\r
                                may be NULL.  It will be NULL for device\r
                                drivers.  It will also be NULL for a bus drivers\r
                                that wish to retrieve the name of the bus\r
                                controller.  It will not be NULL for a bus\r
                                driver that wishes to retrieve the name of a\r
                                child controller.\r
\r
  @param  Language[in]          A pointer to a Null-terminated ASCII string\r
                                array indicating the language.  This is the\r
                                language of the driver name that the caller is\r
                                requesting, and it must match one of the\r
                                languages specified in SupportedLanguages. The\r
                                number of languages supported by a driver is up\r
                                to the driver writer. Language is specified in\r
                                RFC 4646 or ISO 639-2 language code format.\r
\r
  @param  ControllerName[out]   A pointer to the Unicode string to return.\r
                                This Unicode string is the name of the\r
                                controller specified by ControllerHandle and\r
                                ChildHandle in the language specified by\r
                                Language from the point of view of the driver\r
                                specified by This.\r
\r
  @retval EFI_SUCCESS           The Unicode string for the user readable name in\r
                                the language specified by Language for the\r
                                driver specified by This was returned in\r
                                DriverName.\r
\r
  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
\r
  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
                                EFI_HANDLE.\r
\r
  @retval EFI_INVALID_PARAMETER Language is NULL.\r
\r
  @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
\r
  @retval EFI_UNSUPPORTED       The driver specified by This is not currently\r
                                managing the controller specified by\r
                                ControllerHandle and ChildHandle.\r
\r
  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
                                the language specified by Language.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
QemuVideoComponentNameGetControllerName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,\r
  IN  EFI_HANDLE                                      ControllerHandle,\r
  IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,\r
  IN  CHAR8                                           *Language,\r
  OUT CHAR16                                          **ControllerName\r
  );\r
\r
\r
//\r
// Local Function Prototypes\r
//\r
VOID\r
InitializeCirrusGraphicsMode (\r
  QEMU_VIDEO_PRIVATE_DATA  *Private,\r
  QEMU_VIDEO_CIRRUS_MODES  *ModeData\r
  );\r
\r
VOID\r
InitializeBochsGraphicsMode (\r
  QEMU_VIDEO_PRIVATE_DATA  *Private,\r
  QEMU_VIDEO_BOCHS_MODES   *ModeData\r
  );\r
\r
VOID\r
SetPaletteColor (\r
  QEMU_VIDEO_PRIVATE_DATA  *Private,\r
  UINTN                           Index,\r
  UINT8                           Red,\r
  UINT8                           Green,\r
  UINT8                           Blue\r
  );\r
\r
VOID\r
SetDefaultPalette (\r
  QEMU_VIDEO_PRIVATE_DATA  *Private\r
  );\r
\r
VOID\r
DrawLogo (\r
  QEMU_VIDEO_PRIVATE_DATA  *Private,\r
  UINTN                           ScreenWidth,\r
  UINTN                           ScreenHeight\r
  );\r
\r
VOID\r
outb (\r
  QEMU_VIDEO_PRIVATE_DATA  *Private,\r
  UINTN                           Address,\r
  UINT8                           Data\r
  );\r
\r
VOID\r
outw (\r
  QEMU_VIDEO_PRIVATE_DATA  *Private,\r
  UINTN                           Address,\r
  UINT16                          Data\r
  );\r
\r
UINT8\r
inb (\r
  QEMU_VIDEO_PRIVATE_DATA  *Private,\r
  UINTN                           Address\r
  );\r
\r
UINT16\r
inw (\r
  QEMU_VIDEO_PRIVATE_DATA  *Private,\r
  UINTN                           Address\r
  );\r
\r
VOID\r
BochsWrite (\r
  QEMU_VIDEO_PRIVATE_DATA  *Private,\r
  UINT16                   Reg,\r
  UINT16                   Data\r
  );\r
\r
UINT16\r
BochsRead (\r
  QEMU_VIDEO_PRIVATE_DATA  *Private,\r
  UINT16                   Reg\r
  );\r
\r
VOID\r
VgaOutb (\r
  QEMU_VIDEO_PRIVATE_DATA  *Private,\r
  UINTN                    Reg,\r
  UINT8                    Data\r
  );\r
\r
EFI_STATUS\r
QemuVideoCirrusModeSetup (\r
  QEMU_VIDEO_PRIVATE_DATA  *Private\r
  );\r
\r
EFI_STATUS\r
QemuVideoBochsModeSetup (\r
  QEMU_VIDEO_PRIVATE_DATA  *Private,\r
  BOOLEAN                  IsQxl\r
  );\r
\r
EFI_STATUS\r
QemuVideoVmwareSvgaModeSetup (\r
  QEMU_VIDEO_PRIVATE_DATA *Private\r
  );\r
\r
VOID\r
InstallVbeShim (\r
  IN CONST CHAR16         *CardName,\r
  IN EFI_PHYSICAL_ADDRESS FrameBufferBase\r
  );\r
\r
VOID\r
VmwareSvgaWrite (\r
  QEMU_VIDEO_PRIVATE_DATA *Private,\r
  UINT16                  Register,\r
  UINT32                  Value\r
  );\r
\r
UINT32\r
VmwareSvgaRead (\r
  QEMU_VIDEO_PRIVATE_DATA *Private,\r
  UINT16                  Register\r
  );\r
\r
VOID\r
InitializeVmwareSvgaGraphicsMode (\r
  QEMU_VIDEO_PRIVATE_DATA  *Private,\r
  QEMU_VIDEO_BOCHS_MODES   *ModeData\r
  );\r
\r
#endif\r
Commit	Line	Data
eaf4f336	1	/** @file\r
	2	QEMU Video Controller Driver\r
	3	\r
5b2291f9	4	Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
3742b530	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
5b2291f9	38	#include <Library/FrameBufferBltLib.h>\r
eaf4f336	39	\r
eaf4f336	40	#include <IndustryStandard/Pci.h>\r
5b2291f9	41	#include <IndustryStandard/Acpi.h>\r
eaf4f336	42	\r
	43	//\r
	44	// QEMU Video PCI Configuration Header values\r
	45	//\r
	46	#define CIRRUS_LOGIC_VENDOR_ID 0x1013\r
	47	#define CIRRUS_LOGIC_5430_DEVICE_ID 0x00a8\r
	48	#define CIRRUS_LOGIC_5430_ALTERNATE_DEVICE_ID 0x00a0\r
	49	#define CIRRUS_LOGIC_5446_DEVICE_ID 0x00b8\r
	50	\r
	51	//\r
	52	// QEMU Vide Graphical Mode Data\r
	53	//\r
	54	typedef struct {\r
cd152610	55	UINT32 InternalModeIndex; // points into card-specific mode table\r
eaf4f336	56	UINT32 HorizontalResolution;\r
	57	UINT32 VerticalResolution;\r
	58	UINT32 ColorDepth;\r
eaf4f336	59	} QEMU_VIDEO_MODE_DATA;\r
	60	\r
	61	#define PIXEL_RED_SHIFT 0\r
	62	#define PIXEL_GREEN_SHIFT 3\r
	63	#define PIXEL_BLUE_SHIFT 6\r
	64	\r
	65	#define PIXEL_RED_MASK (BIT7 \| BIT6 \| BIT5)\r
	66	#define PIXEL_GREEN_MASK (BIT4 \| BIT3 \| BIT2)\r
	67	#define PIXEL_BLUE_MASK (BIT1 \| BIT0)\r
	68	\r
	69	#define PIXEL_TO_COLOR_BYTE(pixel, mask, shift) ((UINT8) ((pixel & mask) << shift))\r
	70	#define PIXEL_TO_RED_BYTE(pixel) PIXEL_TO_COLOR_BYTE(pixel, PIXEL_RED_MASK, PIXEL_RED_SHIFT)\r
	71	#define PIXEL_TO_GREEN_BYTE(pixel) PIXEL_TO_COLOR_BYTE(pixel, PIXEL_GREEN_MASK, PIXEL_GREEN_SHIFT)\r
	72	#define PIXEL_TO_BLUE_BYTE(pixel) PIXEL_TO_COLOR_BYTE(pixel, PIXEL_BLUE_MASK, PIXEL_BLUE_SHIFT)\r
	73	\r
	74	#define RGB_BYTES_TO_PIXEL(Red, Green, Blue) \\r
	75	(UINT8) ( (((Red) >> PIXEL_RED_SHIFT) & PIXEL_RED_MASK) \| \\r
	76	(((Green) >> PIXEL_GREEN_SHIFT) & PIXEL_GREEN_MASK) \| \\r
	77	(((Blue) >> PIXEL_BLUE_SHIFT) & PIXEL_BLUE_MASK) )\r
	78	\r
	79	#define PIXEL24_RED_MASK 0x00ff0000\r
	80	#define PIXEL24_GREEN_MASK 0x0000ff00\r
	81	#define PIXEL24_BLUE_MASK 0x000000ff\r
	82	\r
	83	#define GRAPHICS_OUTPUT_INVALIDE_MODE_NUMBER 0xffff\r
	84	\r
	85	//\r
	86	// QEMU Video Private Data Structure\r
	87	//\r
	88	#define QEMU_VIDEO_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('Q', 'V', 'I', 'D')\r
	89	\r
212aac55	90	typedef enum {\r
	91	QEMU_VIDEO_CIRRUS_5430 = 1,\r
	92	QEMU_VIDEO_CIRRUS_5446,\r
54f9b9ac	93	QEMU_VIDEO_BOCHS,\r
cdb4f5dc	94	QEMU_VIDEO_BOCHS_MMIO,\r
c137d950	95	QEMU_VIDEO_VMWARE_SVGA,\r
212aac55	96	} QEMU_VIDEO_VARIANT;\r
	97	\r
	98	typedef struct {\r
	99	UINT16 VendorId;\r
	100	UINT16 DeviceId;\r
	101	QEMU_VIDEO_VARIANT Variant;\r
	102	CHAR16 *Name;\r
	103	} QEMU_VIDEO_CARD;\r
	104	\r
eaf4f336	105	typedef struct {\r
	106	UINT64 Signature;\r
	107	EFI_HANDLE Handle;\r
	108	EFI_PCI_IO_PROTOCOL *PciIo;\r
	109	UINT64 OriginalPciAttributes;\r
	110	EFI_GRAPHICS_OUTPUT_PROTOCOL GraphicsOutput;\r
	111	EFI_DEVICE_PATH_PROTOCOL *GopDevicePath;\r
cd152610 LE	112	\r
cd152610 LE	113	//\r
37b9c0a6 LE	114	// The next two fields match the client-visible\r
37b9c0a6 LE	115	// EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE.MaxMode field.\r
cd152610	116	//\r
eaf4f336	117	UINTN MaxMode;\r
eaf4f336	118	QEMU_VIDEO_MODE_DATA *ModeData;\r
c137d950	119	EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *VmwareSvgaModeInfo;\r
cd152610	120	\r
212aac55	121	QEMU_VIDEO_VARIANT Variant;\r
5b2291f9 RN	122	FRAME_BUFFER_CONFIGURE *FrameBufferBltConfigure;\r
5b2291f9 RN	123	UINTN FrameBufferBltConfigureSize;\r
c137d950 PDJ	124	UINT8 FrameBufferVramBarIndex;\r
c137d950 PDJ	125	UINT16 VmwareSvgaBasePort;\r
eaf4f336	126	} QEMU_VIDEO_PRIVATE_DATA;\r
	127	\r
	128	///\r
cd152610	129	/// Card-specific Video Mode structures\r
eaf4f336	130	///\r
	131	typedef struct {\r
	132	UINT32 Width;\r
	133	UINT32 Height;\r
	134	UINT32 ColorDepth;\r
eaf4f336	135	UINT8 *CrtcSettings;\r
	136	UINT16 *SeqSettings;\r
	137	UINT8 MiscSetting;\r
212aac55	138	} QEMU_VIDEO_CIRRUS_MODES;\r
eaf4f336	139	\r
54f9b9ac	140	typedef struct {\r
	141	UINT32 Width;\r
	142	UINT32 Height;\r
	143	UINT32 ColorDepth;\r
	144	} QEMU_VIDEO_BOCHS_MODES;\r
	145	\r
eaf4f336	146	#define QEMU_VIDEO_PRIVATE_DATA_FROM_GRAPHICS_OUTPUT_THIS(a) \\r
	147	CR(a, QEMU_VIDEO_PRIVATE_DATA, GraphicsOutput, QEMU_VIDEO_PRIVATE_DATA_SIGNATURE)\r
	148	\r
	149	\r
	150	//\r
	151	// Global Variables\r
	152	//\r
	153	extern UINT8 AttributeController[];\r
	154	extern UINT8 GraphicsController[];\r
	155	extern UINT8 Crtc_640_480_256_60[];\r
	156	extern UINT16 Seq_640_480_256_60[];\r
	157	extern UINT8 Crtc_800_600_256_60[];\r
	158	extern UINT16 Seq_800_600_256_60[];\r
	159	extern UINT8 Crtc_1024_768_256_60[];\r
	160	extern UINT16 Seq_1024_768_256_60[];\r
212aac55	161	extern QEMU_VIDEO_CIRRUS_MODES QemuVideoCirrusModes[];\r
54f9b9ac	162	extern QEMU_VIDEO_BOCHS_MODES QemuVideoBochsModes[];\r
eaf4f336	163	extern EFI_DRIVER_BINDING_PROTOCOL gQemuVideoDriverBinding;\r
	164	extern EFI_COMPONENT_NAME_PROTOCOL gQemuVideoComponentName;\r
	165	extern EFI_COMPONENT_NAME2_PROTOCOL gQemuVideoComponentName2;\r
	166	extern EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL gQemuVideoDriverSupportedEfiVersion;\r
	167	\r
	168	//\r
	169	// Io Registers defined by VGA\r
	170	//\r
	171	#define CRTC_ADDRESS_REGISTER 0x3d4\r
	172	#define CRTC_DATA_REGISTER 0x3d5\r
	173	#define SEQ_ADDRESS_REGISTER 0x3c4\r
	174	#define SEQ_DATA_REGISTER 0x3c5\r
	175	#define GRAPH_ADDRESS_REGISTER 0x3ce\r
	176	#define GRAPH_DATA_REGISTER 0x3cf\r
	177	#define ATT_ADDRESS_REGISTER 0x3c0\r
	178	#define MISC_OUTPUT_REGISTER 0x3c2\r
	179	#define INPUT_STATUS_1_REGISTER 0x3da\r
	180	#define DAC_PIXEL_MASK_REGISTER 0x3c6\r
	181	#define PALETTE_INDEX_REGISTER 0x3c8\r
	182	#define PALETTE_DATA_REGISTER 0x3c9\r
	183	\r
54f9b9ac	184	#define VBE_DISPI_IOPORT_INDEX 0x01CE\r
	185	#define VBE_DISPI_IOPORT_DATA 0x01D0\r
	186	\r
	187	#define VBE_DISPI_INDEX_ID 0x0\r
	188	#define VBE_DISPI_INDEX_XRES 0x1\r
	189	#define VBE_DISPI_INDEX_YRES 0x2\r
	190	#define VBE_DISPI_INDEX_BPP 0x3\r
	191	#define VBE_DISPI_INDEX_ENABLE 0x4\r
	192	#define VBE_DISPI_INDEX_BANK 0x5\r
	193	#define VBE_DISPI_INDEX_VIRT_WIDTH 0x6\r
	194	#define VBE_DISPI_INDEX_VIRT_HEIGHT 0x7\r
	195	#define VBE_DISPI_INDEX_X_OFFSET 0x8\r
	196	#define VBE_DISPI_INDEX_Y_OFFSET 0x9\r
	197	#define VBE_DISPI_INDEX_VIDEO_MEMORY_64K 0xa\r
	198	\r
	199	#define VBE_DISPI_ID0 0xB0C0\r
	200	#define VBE_DISPI_ID1 0xB0C1\r
	201	#define VBE_DISPI_ID2 0xB0C2\r
	202	#define VBE_DISPI_ID3 0xB0C3\r
	203	#define VBE_DISPI_ID4 0xB0C4\r
	204	#define VBE_DISPI_ID5 0xB0C5\r
	205	\r
	206	#define VBE_DISPI_DISABLED 0x00\r
	207	#define VBE_DISPI_ENABLED 0x01\r
	208	#define VBE_DISPI_GETCAPS 0x02\r
	209	#define VBE_DISPI_8BIT_DAC 0x20\r
	210	#define VBE_DISPI_LFB_ENABLED 0x40\r
	211	#define VBE_DISPI_NOCLEARMEM 0x80\r
eaf4f336	212	\r
	213	//\r
	214	// Graphics Output Hardware abstraction internal worker functions\r
	215	//\r
	216	EFI_STATUS\r
	217	QemuVideoGraphicsOutputConstructor (\r
	218	QEMU_VIDEO_PRIVATE_DATA *Private\r
	219	);\r
	220	\r
	221	EFI_STATUS\r
	222	QemuVideoGraphicsOutputDestructor (\r
	223	QEMU_VIDEO_PRIVATE_DATA *Private\r
	224	);\r
	225	\r
	226	\r
	227	//\r
	228	// EFI_DRIVER_BINDING_PROTOCOL Protocol Interface\r
	229	//\r
	230	/**\r
	231	TODO: Add function description\r
	232	\r
	233	@param This TODO: add argument description\r
	234	@param Controller TODO: add argument description\r
	235	@param RemainingDevicePath TODO: add argument description\r
	236	\r
	237	TODO: add return values\r
	238	\r
	239	**/\r
	240	EFI_STATUS\r
	241	EFIAPI\r
	242	QemuVideoControllerDriverSupported (\r
	243	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	244	IN EFI_HANDLE Controller,\r
	245	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
	246	);\r
	247	\r
	248	/**\r
	249	TODO: Add function description\r
	250	\r
	251	@param This TODO: add argument description\r
	252	@param Controller TODO: add argument description\r
	253	@param RemainingDevicePath TODO: add argument description\r
	254	\r
	255	TODO: add return values\r
	256	\r
	257	**/\r
	258	EFI_STATUS\r
	259	EFIAPI\r
	260	QemuVideoControllerDriverStart (\r
	261	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	262	IN EFI_HANDLE Controller,\r
	263	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
	264	);\r
	265	\r
	266	/**\r
	267	TODO: Add function description\r
	268	\r
	269	@param This TODO: add argument description\r
	270	@param Controller TODO: add argument description\r
	271	@param NumberOfChildren TODO: add argument description\r
	272	@param ChildHandleBuffer TODO: add argument description\r
	273	\r
	274	TODO: add return values\r
	275	\r
276	**/\r
277	EFI_STATUS\r
278	EFIAPI\r
279	QemuVideoControllerDriverStop (\r
280	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
281	IN EFI_HANDLE Controller,\r
282	IN UINTN NumberOfChildren,\r
283	IN EFI_HANDLE *ChildHandleBuffer\r
284	);\r
285	\r
286	//\r
287	// EFI Component Name Functions\r
288	//\r
289	/**\r
290	Retrieves a Unicode string that is the user readable name of the driver.\r
291	\r
292	This function retrieves the user readable name of a driver in the form of a\r
293	Unicode string. If the driver specified by This has a user readable name in\r
294	the language specified by Language, then a pointer to the driver name is\r
295	returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
296	by This does not support the language specified by Language,\r
297	then EFI_UNSUPPORTED is returned.\r
298	\r
299	@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
300	EFI_COMPONENT_NAME_PROTOCOL instance.\r
301	\r
302	@param Language[in] A pointer to a Null-terminated ASCII string\r
303	array indicating the language. This is the\r
304	language of the driver name that the caller is\r
305	requesting, and it must match one of the\r
306	languages specified in SupportedLanguages. The\r
307	number of languages supported by a driver is up\r
308	to the driver writer. Language is specified\r
309	in RFC 4646 or ISO 639-2 language code format.\r
310	\r
311	@param DriverName[out] A pointer to the Unicode string to return.\r
312	This Unicode string is the name of the\r
313	driver specified by This in the language\r
314	specified by Language.\r
315	\r
316	@retval EFI_SUCCESS The Unicode string for the Driver specified by\r
317	This and the language specified by Language was\r
318	returned in DriverName.\r
319	\r
320	@retval EFI_INVALID_PARAMETER Language is NULL.\r
321	\r
322	@retval EFI_INVALID_PARAMETER DriverName is NULL.\r
323	\r
324	@retval EFI_UNSUPPORTED The driver specified by This does not support\r
325	the language specified by Language.\r
326	\r
327	**/\r
328	EFI_STATUS\r
329	EFIAPI\r
330	QemuVideoComponentNameGetDriverName (\r
331	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
332	IN CHAR8 *Language,\r
333	OUT CHAR16 **DriverName\r
334	);\r
335	\r
336	\r
337	/**\r
338	Retrieves a Unicode string that is the user readable name of the controller\r
339	that is being managed by a driver.\r
340	\r
341	This function retrieves the user readable name of the controller specified by\r
342	ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
343	driver specified by This has a user readable name in the language specified by\r
344	Language, then a pointer to the controller name is returned in ControllerName,\r
345	and EFI_SUCCESS is returned. If the driver specified by This is not currently\r
346	managing the controller specified by ControllerHandle and ChildHandle,\r
347	then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
348	support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
349	\r
350	@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
351	EFI_COMPONENT_NAME_PROTOCOL instance.\r
352	\r
353	@param ControllerHandle[in] The handle of a controller that the driver\r
354	specified by This is managing. This handle\r
355	specifies the controller whose name is to be\r
356	returned.\r
357	\r
358	@param ChildHandle[in] The handle of the child controller to retrieve\r
359	the name of. This is an optional parameter that\r
360	may be NULL. It will be NULL for device\r
361	drivers. It will also be NULL for a bus drivers\r
362	that wish to retrieve the name of the bus\r
363	controller. It will not be NULL for a bus\r
364	driver that wishes to retrieve the name of a\r
365	child controller.\r
366	\r
367	@param Language[in] A pointer to a Null-terminated ASCII string\r
368	array indicating the language. This is the\r
369	language of the driver name that the caller is\r
370	requesting, and it must match one of the\r
371	languages specified in SupportedLanguages. The\r
372	number of languages supported by a driver is up\r
373	to the driver writer. Language is specified in\r
374	RFC 4646 or ISO 639-2 language code format.\r
375	\r
376	@param ControllerName[out] A pointer to the Unicode string to return.\r
377	This Unicode string is the name of the\r
378	controller specified by ControllerHandle and\r
379	ChildHandle in the language specified by\r
380	Language from the point of view of the driver\r
381	specified by This.\r
382	\r
383	@retval EFI_SUCCESS The Unicode string for the user readable name in\r
384	the language specified by Language for the\r
385	driver specified by This was returned in\r
386	DriverName.\r
387	\r
388	@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
389	\r
390	@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
391	EFI_HANDLE.\r
392	\r
393	@retval EFI_INVALID_PARAMETER Language is NULL.\r
394	\r
395	@retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
396	\r
397	@retval EFI_UNSUPPORTED The driver specified by This is not currently\r
398	managing the controller specified by\r
399	ControllerHandle and ChildHandle.\r
400	\r
401	@retval EFI_UNSUPPORTED The driver specified by This does not support\r
402	the language specified by Language.\r
403	\r
404	**/\r
405	EFI_STATUS\r
406	EFIAPI\r
407	QemuVideoComponentNameGetControllerName (\r
408	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
409	IN EFI_HANDLE ControllerHandle,\r
410	IN EFI_HANDLE ChildHandle OPTIONAL,\r
411	IN CHAR8 *Language,\r
412	OUT CHAR16 **ControllerName\r
413	);\r
414	\r
415	\r
416	//\r
417	// Local Function Prototypes\r
418	//\r
419	VOID\r
212aac55	420	InitializeCirrusGraphicsMode (\r
eaf4f336	421	QEMU_VIDEO_PRIVATE_DATA *Private,\r
212aac55	422	QEMU_VIDEO_CIRRUS_MODES *ModeData\r
eaf4f336	423	);\r
eaf4f336	424	\r
54f9b9ac	425	VOID\r
	426	InitializeBochsGraphicsMode (\r
	427	QEMU_VIDEO_PRIVATE_DATA *Private,\r
	428	QEMU_VIDEO_BOCHS_MODES *ModeData\r
	429	);\r
	430	\r
eaf4f336	431	VOID\r
	432	SetPaletteColor (\r
	433	QEMU_VIDEO_PRIVATE_DATA *Private,\r
	434	UINTN Index,\r
	435	UINT8 Red,\r
	436	UINT8 Green,\r
	437	UINT8 Blue\r
	438	);\r
	439	\r
	440	VOID\r
	441	SetDefaultPalette (\r
	442	QEMU_VIDEO_PRIVATE_DATA *Private\r
	443	);\r
	444	\r
	445	VOID\r
	446	DrawLogo (\r
	447	QEMU_VIDEO_PRIVATE_DATA *Private,\r
	448	UINTN ScreenWidth,\r
	449	UINTN ScreenHeight\r
	450	);\r
	451	\r
	452	VOID\r
	453	outb (\r
	454	QEMU_VIDEO_PRIVATE_DATA *Private,\r
	455	UINTN Address,\r
	456	UINT8 Data\r
	457	);\r
	458	\r
	459	VOID\r
	460	outw (\r
	461	QEMU_VIDEO_PRIVATE_DATA *Private,\r
	462	UINTN Address,\r
	463	UINT16 Data\r
	464	);\r
	465	\r
	466	UINT8\r
	467	inb (\r
	468	QEMU_VIDEO_PRIVATE_DATA *Private,\r
	469	UINTN Address\r
	470	);\r
	471	\r
	472	UINT16\r
	473	inw (\r
	474	QEMU_VIDEO_PRIVATE_DATA *Private,\r
	475	UINTN Address\r
	476	);\r
	477	\r
54f9b9ac	478	VOID\r
	479	BochsWrite (\r
	480	QEMU_VIDEO_PRIVATE_DATA *Private,\r
	481	UINT16 Reg,\r
	482	UINT16 Data\r
	483	);\r
	484	\r
	485	UINT16\r
	486	BochsRead (\r
	487	QEMU_VIDEO_PRIVATE_DATA *Private,\r
	488	UINT16 Reg\r
	489	);\r
	490	\r
cdb4f5dc	491	VOID\r
	492	VgaOutb (\r
	493	QEMU_VIDEO_PRIVATE_DATA *Private,\r
	494	UINTN Reg,\r
	495	UINT8 Data\r
	496	);\r
	497	\r
eaf4f336	498	EFI_STATUS\r
212aac55	499	QemuVideoCirrusModeSetup (\r
eaf4f336	500	QEMU_VIDEO_PRIVATE_DATA *Private\r
	501	);\r
	502	\r
54f9b9ac	503	EFI_STATUS\r
54f9b9ac	504	QemuVideoBochsModeSetup (\r
b37bcfd6 LE	505	QEMU_VIDEO_PRIVATE_DATA *Private,\r
b37bcfd6 LE	506	BOOLEAN IsQxl\r
54f9b9ac	507	);\r
54f9b9ac	508	\r
c137d950 PDJ	509	EFI_STATUS\r
	510	QemuVideoVmwareSvgaModeSetup (\r
	511	QEMU_VIDEO_PRIVATE_DATA *Private\r
	512	);\r
	513	\r
90803342 LE	514	VOID\r
	515	InstallVbeShim (\r
	516	IN CONST CHAR16 *CardName,\r
	517	IN EFI_PHYSICAL_ADDRESS FrameBufferBase\r
	518	);\r
c137d950 PDJ	519	\r
	520	VOID\r
	521	VmwareSvgaWrite (\r
	522	QEMU_VIDEO_PRIVATE_DATA *Private,\r
	523	UINT16 Register,\r
	524	UINT32 Value\r
	525	);\r
	526	\r
	527	UINT32\r
	528	VmwareSvgaRead (\r
	529	QEMU_VIDEO_PRIVATE_DATA *Private,\r
	530	UINT16 Register\r
	531	);\r
	532	\r
	533	VOID\r
	534	InitializeVmwareSvgaGraphicsMode (\r
	535	QEMU_VIDEO_PRIVATE_DATA *Private,\r
	536	QEMU_VIDEO_BOCHS_MODES *ModeData\r
	537	);\r
	538	\r
eaf4f336	539	#endif\r