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