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