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