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