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

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