[mirror_edk2.git] / DuetPkg / BiosVideoThunkDxe / BiosVideo.h

/** @file\r
\r
Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
All rights reserved. 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
#ifndef _BIOS_GRAPHICS_OUTPUT_H\r
#define _BIOS_GRAPHICS_OUTPUT_H\r
\r
#include <Uefi.h>\r
\r
//\r
// Driver Consumed Protocol Prototypes\r
//\r
#include <Protocol/DevicePath.h>\r
#include <Protocol/PciIo.h>\r
#include <Protocol/DriverBinding.h>\r
#include <Protocol/ComponentName.h>\r
#include <Protocol/ComponentName2.h>\r
#include <Protocol/UgaDraw.h>\r
#include <Protocol/VgaMiniPort.h>\r
#include <Protocol/Legacy8259.h>\r
#include <Protocol/EdidActive.h>\r
#include <Protocol/EdidDiscovered.h>\r
#include <Protocol/DevicePath.h>\r
#include <Protocol/LegacyBios.h>\r
\r
#include <Library/UefiLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DevicePathLib.h>\r
\r
#include <IndustryStandard/Pci22.h>\r
\r
#include "VesaBiosExtensions.h"\r
\r
//\r
// Packed format support: The number of bits reserved for each of the colors and the actual\r
// position of RGB in the frame buffer is specified in the VBE Mode information\r
//\r
typedef struct {\r
  UINT8 Position; // Position of the color\r
  UINT8 Mask;     // The number of bits expressed as a mask\r
} BIOS_VIDEO_COLOR_PLACEMENT;\r
\r
//\r
// BIOS Graphics Output Graphical Mode Data\r
//\r
typedef struct {\r
  UINT16                      VbeModeNumber;\r
  UINT16                      BytesPerScanLine;\r
  VOID                        *LinearFrameBuffer;\r
  UINTN                       FrameBufferSize;\r
  UINT32                      HorizontalResolution;\r
  UINT32                      VerticalResolution;\r
  UINT32                      RefreshRate;\r
  UINT32                      BitsPerPixel;\r
  BIOS_VIDEO_COLOR_PLACEMENT  Red;\r
  BIOS_VIDEO_COLOR_PLACEMENT  Green;\r
  BIOS_VIDEO_COLOR_PLACEMENT  Blue;\r
  BIOS_VIDEO_COLOR_PLACEMENT  Reserved;\r
  EFI_GRAPHICS_PIXEL_FORMAT   PixelFormat;\r
  EFI_PIXEL_BITMASK           PixelBitMask;\r
} BIOS_VIDEO_MODE_DATA;\r
\r
//\r
// BIOS video child handle private data Structure\r
//\r
#define BIOS_VIDEO_DEV_SIGNATURE    SIGNATURE_32 ('B', 'V', 'M', 'p')\r
\r
typedef struct {\r
  UINTN                                       Signature;\r
  EFI_HANDLE                                  Handle;\r
\r
  //\r
  // Consumed Protocols inherited from parent controller.\r
  //\r
  EFI_PCI_IO_PROTOCOL                         *PciIo;\r
  EFI_LEGACY_8259_PROTOCOL                    *Legacy8259;\r
  THUNK_CONTEXT                               *ThunkContext;\r
  \r
  //\r
  // Produced Protocols\r
  //\r
  EFI_GRAPHICS_OUTPUT_PROTOCOL                GraphicsOutput;\r
  EFI_EDID_DISCOVERED_PROTOCOL                EdidDiscovered;\r
  EFI_EDID_ACTIVE_PROTOCOL                    EdidActive;\r
  EFI_VGA_MINI_PORT_PROTOCOL                  VgaMiniPort;\r
\r
  //\r
  // General fields\r
  //\r
  BOOLEAN                                     VgaCompatible;\r
  BOOLEAN                                     ProduceGraphicsOutput;\r
\r
  //\r
  // Graphics Output Protocol related fields\r
  //\r
  BOOLEAN                                     HardwareNeedsStarting;\r
  BIOS_VIDEO_MODE_DATA                        *ModeData;\r
  UINT8                                       *LineBuffer;\r
  EFI_GRAPHICS_OUTPUT_BLT_PIXEL               *VbeFrameBuffer;\r
  UINT8                                       *VgaFrameBuffer;\r
\r
  //\r
  // VESA Bios Extensions related fields\r
  //\r
  UINTN                                       NumberOfPagesBelow1MB;    // Number of 4KB pages in PagesBelow1MB\r
  EFI_PHYSICAL_ADDRESS                        PagesBelow1MB;            // Buffer for all VBE Information Blocks\r
  VESA_BIOS_EXTENSIONS_INFORMATION_BLOCK      *VbeInformationBlock;     // 0x200 bytes.  Must be allocated below 1MB\r
  VESA_BIOS_EXTENSIONS_MODE_INFORMATION_BLOCK *VbeModeInformationBlock; // 0x100 bytes.  Must be allocated below 1MB\r
  VESA_BIOS_EXTENSIONS_EDID_DATA_BLOCK        *VbeEdidDataBlock;        // 0x80  bytes.  Must be allocated below 1MB\r
  VESA_BIOS_EXTENSIONS_CRTC_INFORMATION_BLOCK *VbeCrtcInformationBlock; // 59 bytes.  Must be allocated below 1MB\r
  UINTN                                       VbeSaveRestorePages;      // Number of 4KB pages in VbeSaveRestoreBuffer\r
  EFI_PHYSICAL_ADDRESS                        VbeSaveRestoreBuffer;     // Must be allocated below 1MB\r
  //\r
  // Status code\r
  //\r
  EFI_DEVICE_PATH_PROTOCOL                    *DevicePath;\r
} BIOS_VIDEO_DEV;\r
\r
#define BIOS_VIDEO_DEV_FROM_PCI_IO_THIS(a)      CR (a, BIOS_VIDEO_DEV, PciIo, BIOS_VIDEO_DEV_SIGNATURE)\r
#define BIOS_VIDEO_DEV_FROM_GRAPHICS_OUTPUT_THIS(a)      CR (a, BIOS_VIDEO_DEV, GraphicsOutput, BIOS_VIDEO_DEV_SIGNATURE)\r
#define BIOS_VIDEO_DEV_FROM_VGA_MINI_PORT_THIS(a) CR (a, BIOS_VIDEO_DEV, VgaMiniPort, BIOS_VIDEO_DEV_SIGNATURE)\r
\r
#define GRAPHICS_OUTPUT_INVALIDE_MODE_NUMBER	0xffff\r
\r
//\r
// Global Variables\r
//\r
extern EFI_DRIVER_BINDING_PROTOCOL   gBiosVideoDriverBinding;\r
extern EFI_COMPONENT_NAME_PROTOCOL   gBiosVideoComponentName;\r
extern EFI_COMPONENT_NAME2_PROTOCOL  gBiosVideoComponentName2;\r
\r
//\r
// Driver Binding Protocol functions\r
//\r
/**\r
  Test to see if Bios Video could be supported on the Controller.\r
\r
  @param This                  Pointer to driver binding protocol\r
  @param Controller            Controller handle to connect\r
  @param RemainingDevicePath   A pointer to the remaining portion of a device path\r
\r
  @retval EFI_SUCCESS         This driver supports this device.\r
  @retval other               This driver does not support this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BiosVideoDriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  )\r
;\r
\r
/**\r
  Install Graphics Output Protocol onto VGA device handles\r
\r
  @param This                   Pointer to driver binding protocol\r
  @param Controller             Controller handle to connect\r
  @param RemainingDevicePath    A pointer to the remaining portion of a device path\r
\r
  @return EFI_STATUS\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BiosVideoDriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  )\r
;\r
\r
/**\r
  Stop this driver on Controller \r
\r
  @param  This              Protocol instance pointer.\r
  @param  Controller        Handle of device to stop driver on\r
  @param  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of\r
                            children is zero stop the entire bus driver.\r
  @param  ChildHandleBuffer List of Child Handles to Stop.\r
\r
  @retval EFI_SUCCESS       This driver is removed Controller.\r
  @retval other             This driver was not removed from this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BiosVideoDriverBindingStop (\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
//\r
// Private worker functions\r
//\r
/**\r
  Check for VBE device\r
\r
  @param BiosVideoPrivate - Pointer to BIOS_VIDEO_DEV structure\r
\r
  @retval EFI_SUCCESS VBE device found\r
\r
**/\r
EFI_STATUS\r
BiosVideoCheckForVbe (\r
  BIOS_VIDEO_DEV  *BiosVideoPrivate\r
  )\r
;\r
\r
/**\r
  Check for VGA device\r
\r
  @param BiosVideoPrivate - Pointer to BIOS_VIDEO_DEV structure\r
\r
  @retval EFI_SUCCESS  Standard VGA device found\r
**/\r
\r
EFI_STATUS\r
BiosVideoCheckForVga (\r
  BIOS_VIDEO_DEV  *BiosVideoPrivate\r
  )\r
;\r
\r
/**\r
  Collect the resource from destroyed bios video device.\r
\r
  @param BiosVideoPrivate   Video child device private data structure\r
\r
**/\r
VOID\r
BiosVideoDeviceReleaseResource (\r
  BIOS_VIDEO_DEV  *BiosVideoChildPrivate\r
  )\r
;\r
\r
//\r
// BIOS Graphics Output Protocol functions\r
//\r
/**\r
\r
  Graphics Output protocol interface to get video mode\r
\r
\r
  @param This            - Protocol instance pointer.\r
  @param ModeNumber      - The mode number to return information on.\r
  @param SizeOfInfo      - A pointer to the size, in bytes, of the Info buffer.\r
  @param Info            - Caller allocated buffer that returns information about ModeNumber.\r
\r
  @return EFI_SUCCESS           - Mode information returned.\r
          EFI_DEVICE_ERROR      - A hardware error occurred trying to retrieve the video mode.\r
          EFI_NOT_STARTED       - Video display is not initialized. Call SetMode ()\r
          EFI_INVALID_PARAMETER - One of the input args was NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BiosVideoGraphicsOutputQueryMode (\r
  IN  EFI_GRAPHICS_OUTPUT_PROTOCOL          *This,\r
  IN  UINT32                                ModeNumber,\r
  OUT UINTN                                 *SizeOfInfo,\r
  OUT EFI_GRAPHICS_OUTPUT_MODE_INFORMATION  **Info\r
  )\r
;\r
\r
/**\r
\r
  Graphics Output protocol interface to set video mode\r
\r
\r
  @param This            - Protocol instance pointer.\r
  @param ModeNumber      - The mode number to be set.\r
\r
  @return EFI_SUCCESS      - Graphics mode was changed.\r
          EFI_DEVICE_ERROR - The device had an error and could not complete the request.\r
          EFI_UNSUPPORTED  - ModeNumber is not supported by this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BiosVideoGraphicsOutputSetMode (\r
  IN  EFI_GRAPHICS_OUTPUT_PROTOCOL * This,\r
  IN  UINT32                       ModeNumber\r
  )\r
;\r
\r
/**\r
\r
  Graphics Output protocol instance to block transfer for VBE device\r
\r
\r
  @param This            - Pointer to Graphics Output protocol instance\r
  @param BltBuffer       - The data to transfer to screen\r
  @param BltOperation    - The operation to perform\r
  @param SourceX         - The X coordinate of the source for BltOperation\r
  @param SourceY         - The Y coordinate of the source for BltOperation\r
  @param DestinationX    - The X coordinate of the destination for BltOperation\r
  @param DestinationY    - The Y coordinate of the destination for BltOperation\r
  @param Width           - The width of a rectangle in the blt rectangle in pixels\r
  @param Height          - The height of a rectangle in the blt rectangle in pixels\r
  @param Delta           - Not used for EfiBltVideoFill and EfiBltVideoToVideo operation.\r
                         If a Delta of 0 is used, the entire BltBuffer will be operated on.\r
                         If a subrectangle of the BltBuffer is used, then Delta represents\r
                         the number of bytes in a row of the BltBuffer.\r
\r
  @return EFI_INVALID_PARAMETER - Invalid parameter passed in\r
          EFI_SUCCESS - Blt operation success\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BiosVideoGraphicsOutputVbeBlt (\r
  IN  EFI_GRAPHICS_OUTPUT_PROTOCOL       *This,\r
  IN  EFI_GRAPHICS_OUTPUT_BLT_PIXEL      *BltBuffer, OPTIONAL\r
  IN  EFI_GRAPHICS_OUTPUT_BLT_OPERATION  BltOperation,\r
  IN  UINTN                              SourceX,\r
  IN  UINTN                              SourceY,\r
  IN  UINTN                              DestinationX,\r
  IN  UINTN                              DestinationY,\r
  IN  UINTN                              Width,\r
  IN  UINTN                              Height,\r
  IN  UINTN                              Delta\r
  )\r
;\r
\r
/**\r
  Grahpics Output protocol instance to block transfer for VGA device\r
\r
  @param This            Pointer to Grahpics Output protocol instance\r
  @param BltBuffer       The data to transfer to screen\r
  @param BltOperation    The operation to perform\r
  @param SourceX         The X coordinate of the source for BltOperation\r
  @param SourceY         The Y coordinate of the source for BltOperation\r
  @param DestinationX    The X coordinate of the destination for BltOperation\r
  @param DestinationY    The Y coordinate of the destination for BltOperation\r
  @param Width           The width of a rectangle in the blt rectangle in pixels\r
  @param Height          The height of a rectangle in the blt rectangle in pixels\r
  @param Delta           Not used for EfiBltVideoFill and EfiBltVideoToVideo operation.\r
                         If a Delta of 0 is used, the entire BltBuffer will be operated on.\r
                         If a subrectangle of the BltBuffer is used, then Delta represents\r
                         the number of bytes in a row of the BltBuffer.\r
\r
  @retval EFI_INVALID_PARAMETER Invalid parameter passed in\r
  @retval EFI_SUCCESS           Blt operation success\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BiosVideoGraphicsOutputVgaBlt (\r
  IN  EFI_GRAPHICS_OUTPUT_PROTOCOL       *This,\r
  IN  EFI_GRAPHICS_OUTPUT_BLT_PIXEL      *BltBuffer, OPTIONAL\r
  IN  EFI_GRAPHICS_OUTPUT_BLT_OPERATION  BltOperation,\r
  IN  UINTN                              SourceX,\r
  IN  UINTN                              SourceY,\r
  IN  UINTN                              DestinationX,\r
  IN  UINTN                              DestinationY,\r
  IN  UINTN                              Width,\r
  IN  UINTN                              Height,\r
  IN  UINTN                              Delta\r
  )\r
;\r
\r
//\r
// BIOS VGA Mini Port Protocol functions\r
//\r
/**\r
  VgaMiniPort protocol interface to set mode\r
\r
  @param This             Pointer to VgaMiniPort protocol instance\r
  @param ModeNumber       The index of the mode\r
\r
  @retval EFI_UNSUPPORTED The requested mode is not supported\r
  @retval EFI_SUCCESS     The requested mode is set successfully\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BiosVideoVgaMiniPortSetMode (\r
  IN  EFI_VGA_MINI_PORT_PROTOCOL  *This,\r
  IN  UINTN                       ModeNumber\r
  )\r
;\r
\r
/**\r
  Judge whether this device is VGA device.\r
\r
  @param PciIo      Parent PciIo protocol instance pointer\r
\r
  @retval TRUE  Is vga device\r
  @retval FALSE Is no vga device\r
**/\r
BOOLEAN\r
BiosVideoIsVga (\r
  IN  EFI_PCI_IO_PROTOCOL       *PciIo\r
  )\r
;\r
\r
\r
//\r
// Standard VGA Definitions\r
//\r
#define VGA_HORIZONTAL_RESOLUTION                         640\r
#define VGA_VERTICAL_RESOLUTION                           480\r
#define VGA_NUMBER_OF_BIT_PLANES                          4\r
#define VGA_PIXELS_PER_BYTE                               8\r
#define VGA_BYTES_PER_SCAN_LINE                           (VGA_HORIZONTAL_RESOLUTION / VGA_PIXELS_PER_BYTE)\r
#define VGA_BYTES_PER_BIT_PLANE                           (VGA_VERTICAL_RESOLUTION * VGA_BYTES_PER_SCAN_LINE)\r
\r
#define VGA_GRAPHICS_CONTROLLER_ADDRESS_REGISTER          0x3ce\r
#define VGA_GRAPHICS_CONTROLLER_DATA_REGISTER             0x3cf\r
\r
#define VGA_GRAPHICS_CONTROLLER_SET_RESET_REGISTER        0x00\r
\r
#define VGA_GRAPHICS_CONTROLLER_ENABLE_SET_RESET_REGISTER 0x01\r
\r
#define VGA_GRAPHICS_CONTROLLER_COLOR_COMPARE_REGISTER    0x02\r
\r
#define VGA_GRAPHICS_CONTROLLER_DATA_ROTATE_REGISTER      0x03\r
#define VGA_GRAPHICS_CONTROLLER_FUNCTION_REPLACE          0x00\r
#define VGA_GRAPHICS_CONTROLLER_FUNCTION_AND              0x08\r
#define VGA_GRAPHICS_CONTROLLER_FUNCTION_OR               0x10\r
#define VGA_GRAPHICS_CONTROLLER_FUNCTION_XOR              0x18\r
\r
#define VGA_GRAPHICS_CONTROLLER_READ_MAP_SELECT_REGISTER  0x04\r
\r
#define VGA_GRAPHICS_CONTROLLER_MODE_REGISTER             0x05\r
#define VGA_GRAPHICS_CONTROLLER_READ_MODE_0               0x00\r
#define VGA_GRAPHICS_CONTROLLER_READ_MODE_1               0x08\r
#define VGA_GRAPHICS_CONTROLLER_WRITE_MODE_0              0x00\r
#define VGA_GRAPHICS_CONTROLLER_WRITE_MODE_1              0x01\r
#define VGA_GRAPHICS_CONTROLLER_WRITE_MODE_2              0x02\r
#define VGA_GRAPHICS_CONTROLLER_WRITE_MODE_3              0x03\r
\r
#define VGA_GRAPHICS_CONTROLLER_MISCELLANEOUS_REGISTER    0x06\r
\r
#define VGA_GRAPHICS_CONTROLLER_COLOR_DONT_CARE_REGISTER  0x07\r
\r
#define VGA_GRAPHICS_CONTROLLER_BIT_MASK_REGISTER         0x08\r
\r
/**\r
  Initialize legacy environment for BIOS INI caller.\r
  \r
  @param ThunkContext   the instance pointer of THUNK_CONTEXT\r
**/\r
VOID\r
InitializeBiosIntCaller (\r
  THUNK_CONTEXT     *ThunkContext\r
  );\r
  \r
/**\r
   Initialize interrupt redirection code and entries, because\r
   IDT Vectors 0x68-0x6f must be redirected to IDT Vectors 0x08-0x0f.\r
   Or the interrupt will lost when we do thunk.\r
   NOTE: We do not reset 8259 vector base, because it will cause pending\r
   interrupt lost.\r
   \r
   @param Legacy8259  Instance pointer for EFI_LEGACY_8259_PROTOCOL.\r
   \r
**/  \r
VOID\r
InitializeInterruptRedirection (\r
  IN  EFI_LEGACY_8259_PROTOCOL  *Legacy8259\r
  );\r
  \r
/**\r
  Thunk to 16-bit real mode and execute a software interrupt with a vector \r
  of BiosInt. Regs will contain the 16-bit register context on entry and \r
  exit.\r
  \r
  @param  This    Protocol instance pointer.\r
  @param  BiosInt Processor interrupt vector to invoke\r
  @param  Reg     Register contexted passed into (and returned) from thunk to 16-bit mode\r
  \r
  @retval TRUE   Thunk completed, and there were no BIOS errors in the target code.\r
                 See Regs for status.\r
  @retval FALSE  There was a BIOS erro in the target code.  \r
**/  \r
BOOLEAN\r
EFIAPI\r
LegacyBiosInt86 (\r
  IN  BIOS_VIDEO_DEV                 *BiosDev,\r
  IN  UINT8                           BiosInt,\r
  IN  EFI_IA32_REGISTER_SET           *Regs\r
  );    \r
  \r
#endif\r
Commit	Line	Data
f1294e4a	1	/** @file\r
7da78b1f	2	\r
	3	Copyright (c) 2006 - 2007, Intel Corporation \r
	4	All rights reserved. This program and the accompanying materials \r
	5	are licensed and made available under the terms and conditions of the BSD License \r
	6	which accompanies this distribution. The full text of the license may be found at \r
	7	http://opensource.org/licenses/bsd-license.php \r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	11	\r
f1294e4a	12	**/\r
7da78b1f	13	\r
0d92cdc2	14	#ifndef _BIOS_GRAPHICS_OUTPUT_H\r
0d92cdc2	15	#define _BIOS_GRAPHICS_OUTPUT_H\r
7da78b1f	16	\r
	17	#include <Uefi.h>\r
	18	\r
	19	//\r
	20	// Driver Consumed Protocol Prototypes\r
	21	//\r
	22	#include <Protocol/DevicePath.h>\r
	23	#include <Protocol/PciIo.h>\r
	24	#include <Protocol/DriverBinding.h>\r
	25	#include <Protocol/ComponentName.h>\r
	26	#include <Protocol/ComponentName2.h>\r
	27	#include <Protocol/UgaDraw.h>\r
	28	#include <Protocol/VgaMiniPort.h>\r
	29	#include <Protocol/Legacy8259.h>\r
0d92cdc2	30	#include <Protocol/EdidActive.h>\r
	31	#include <Protocol/EdidDiscovered.h>\r
	32	#include <Protocol/DevicePath.h>\r
7da78b1f	33	#include <Protocol/LegacyBios.h>\r
	34	\r
	35	#include <Library/UefiLib.h>\r
	36	#include <Library/DebugLib.h>\r
	37	#include <Library/UefiBootServicesTableLib.h>\r
	38	#include <Library/BaseMemoryLib.h>\r
0d92cdc2	39	#include <Library/DevicePathLib.h>\r
7da78b1f	40	\r
	41	#include <IndustryStandard/Pci22.h>\r
	42	\r
	43	#include "VesaBiosExtensions.h"\r
7da78b1f	44	\r
	45	//\r
	46	// Packed format support: The number of bits reserved for each of the colors and the actual\r
	47	// position of RGB in the frame buffer is specified in the VBE Mode information\r
	48	//\r
	49	typedef struct {\r
	50	UINT8 Position; // Position of the color\r
	51	UINT8 Mask; // The number of bits expressed as a mask\r
	52	} BIOS_VIDEO_COLOR_PLACEMENT;\r
	53	\r
	54	//\r
0d92cdc2	55	// BIOS Graphics Output Graphical Mode Data\r
7da78b1f	56	//\r
	57	typedef struct {\r
	58	UINT16 VbeModeNumber;\r
	59	UINT16 BytesPerScanLine;\r
	60	VOID *LinearFrameBuffer;\r
0d92cdc2	61	UINTN FrameBufferSize;\r
7da78b1f	62	UINT32 HorizontalResolution;\r
7da78b1f	63	UINT32 VerticalResolution;\r
7da78b1f	64	UINT32 RefreshRate;\r
	65	UINT32 BitsPerPixel;\r
	66	BIOS_VIDEO_COLOR_PLACEMENT Red;\r
	67	BIOS_VIDEO_COLOR_PLACEMENT Green;\r
	68	BIOS_VIDEO_COLOR_PLACEMENT Blue;\r
0d92cdc2	69	BIOS_VIDEO_COLOR_PLACEMENT Reserved;\r
	70	EFI_GRAPHICS_PIXEL_FORMAT PixelFormat;\r
	71	EFI_PIXEL_BITMASK PixelBitMask;\r
7da78b1f	72	} BIOS_VIDEO_MODE_DATA;\r
	73	\r
	74	//\r
0d92cdc2	75	// BIOS video child handle private data Structure\r
7da78b1f	76	//\r
0d92cdc2	77	#define BIOS_VIDEO_DEV_SIGNATURE SIGNATURE_32 ('B', 'V', 'M', 'p')\r
7da78b1f	78	\r
	79	typedef struct {\r
	80	UINTN Signature;\r
	81	EFI_HANDLE Handle;\r
	82	\r
	83	//\r
f1294e4a	84	// Consumed Protocols inherited from parent controller.\r
7da78b1f	85	//\r
7da78b1f	86	EFI_PCI_IO_PROTOCOL *PciIo;\r
0d92cdc2	87	EFI_LEGACY_8259_PROTOCOL *Legacy8259;\r
f1294e4a	88	THUNK_CONTEXT *ThunkContext;\r
f1294e4a	89	\r
7da78b1f	90	//\r
	91	// Produced Protocols\r
	92	//\r
0d92cdc2	93	EFI_GRAPHICS_OUTPUT_PROTOCOL GraphicsOutput;\r
	94	EFI_EDID_DISCOVERED_PROTOCOL EdidDiscovered;\r
	95	EFI_EDID_ACTIVE_PROTOCOL EdidActive;\r
7da78b1f	96	EFI_VGA_MINI_PORT_PROTOCOL VgaMiniPort;\r
	97	\r
	98	//\r
	99	// General fields\r
	100	//\r
7da78b1f	101	BOOLEAN VgaCompatible;\r
0d92cdc2	102	BOOLEAN ProduceGraphicsOutput;\r
7da78b1f	103	\r
7da78b1f	104	//\r
0d92cdc2	105	// Graphics Output Protocol related fields\r
7da78b1f	106	//\r
7da78b1f	107	BOOLEAN HardwareNeedsStarting;\r
7da78b1f	108	BIOS_VIDEO_MODE_DATA *ModeData;\r
7da78b1f	109	UINT8 *LineBuffer;\r
0d92cdc2	110	EFI_GRAPHICS_OUTPUT_BLT_PIXEL *VbeFrameBuffer;\r
7da78b1f	111	UINT8 *VgaFrameBuffer;\r
	112	\r
	113	//\r
	114	// VESA Bios Extensions related fields\r
	115	//\r
	116	UINTN NumberOfPagesBelow1MB; // Number of 4KB pages in PagesBelow1MB\r
	117	EFI_PHYSICAL_ADDRESS PagesBelow1MB; // Buffer for all VBE Information Blocks\r
	118	VESA_BIOS_EXTENSIONS_INFORMATION_BLOCK *VbeInformationBlock; // 0x200 bytes. Must be allocated below 1MB\r
	119	VESA_BIOS_EXTENSIONS_MODE_INFORMATION_BLOCK *VbeModeInformationBlock; // 0x100 bytes. Must be allocated below 1MB\r
0d92cdc2	120	VESA_BIOS_EXTENSIONS_EDID_DATA_BLOCK *VbeEdidDataBlock; // 0x80 bytes. Must be allocated below 1MB\r
7da78b1f	121	VESA_BIOS_EXTENSIONS_CRTC_INFORMATION_BLOCK *VbeCrtcInformationBlock; // 59 bytes. Must be allocated below 1MB\r
	122	UINTN VbeSaveRestorePages; // Number of 4KB pages in VbeSaveRestoreBuffer\r
	123	EFI_PHYSICAL_ADDRESS VbeSaveRestoreBuffer; // Must be allocated below 1MB\r
	124	//\r
	125	// Status code\r
	126	//\r
	127	EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
	128	} BIOS_VIDEO_DEV;\r
	129	\r
0d92cdc2	130	#define BIOS_VIDEO_DEV_FROM_PCI_IO_THIS(a) CR (a, BIOS_VIDEO_DEV, PciIo, BIOS_VIDEO_DEV_SIGNATURE)\r
0d92cdc2	131	#define BIOS_VIDEO_DEV_FROM_GRAPHICS_OUTPUT_THIS(a) CR (a, BIOS_VIDEO_DEV, GraphicsOutput, BIOS_VIDEO_DEV_SIGNATURE)\r
7da78b1f	132	#define BIOS_VIDEO_DEV_FROM_VGA_MINI_PORT_THIS(a) CR (a, BIOS_VIDEO_DEV, VgaMiniPort, BIOS_VIDEO_DEV_SIGNATURE)\r
7da78b1f	133	\r
0d92cdc2	134	#define GRAPHICS_OUTPUT_INVALIDE_MODE_NUMBER 0xffff\r
0d92cdc2	135	\r
7da78b1f	136	//\r
	137	// Global Variables\r
	138	//\r
	139	extern EFI_DRIVER_BINDING_PROTOCOL gBiosVideoDriverBinding;\r
	140	extern EFI_COMPONENT_NAME_PROTOCOL gBiosVideoComponentName;\r
	141	extern EFI_COMPONENT_NAME2_PROTOCOL gBiosVideoComponentName2;\r
	142	\r
	143	//\r
	144	// Driver Binding Protocol functions\r
	145	//\r
f1294e4a	146	/**\r
	147	Test to see if Bios Video could be supported on the Controller.\r
	148	\r
	149	@param This Pointer to driver binding protocol\r
	150	@param Controller Controller handle to connect\r
	151	@param RemainingDevicePath A pointer to the remaining portion of a device path\r
	152	\r
	153	@retval EFI_SUCCESS This driver supports this device.\r
	154	@retval other This driver does not support this device.\r
	155	\r
	156	**/\r
7da78b1f	157	EFI_STATUS\r
	158	EFIAPI\r
	159	BiosVideoDriverBindingSupported (\r
	160	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	161	IN EFI_HANDLE Controller,\r
	162	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
	163	)\r
f1294e4a	164	;\r
0d92cdc2	165	\r
f1294e4a	166	/**\r
f1294e4a	167	Install Graphics Output Protocol onto VGA device handles\r
0d92cdc2	168	\r
f1294e4a	169	@param This Pointer to driver binding protocol\r
	170	@param Controller Controller handle to connect\r
	171	@param RemainingDevicePath A pointer to the remaining portion of a device path\r
7da78b1f	172	\r
f1294e4a	173	@return EFI_STATUS\r
7da78b1f	174	\r
f1294e4a	175	**/\r
7da78b1f	176	EFI_STATUS\r
	177	EFIAPI\r
	178	BiosVideoDriverBindingStart (\r
	179	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	180	IN EFI_HANDLE Controller,\r
	181	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
	182	)\r
f1294e4a	183	;\r
0d92cdc2	184	\r
f1294e4a	185	/**\r
f1294e4a	186	Stop this driver on Controller \r
0d92cdc2	187	\r
f1294e4a	188	@param This Protocol instance pointer.\r
	189	@param Controller Handle of device to stop driver on\r
	190	@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
	191	children is zero stop the entire bus driver.\r
	192	@param ChildHandleBuffer List of Child Handles to Stop.\r
7da78b1f	193	\r
f1294e4a	194	@retval EFI_SUCCESS This driver is removed Controller.\r
f1294e4a	195	@retval other This driver was not removed from this device.\r
7da78b1f	196	\r
f1294e4a	197	**/\r
7da78b1f	198	EFI_STATUS\r
	199	EFIAPI\r
	200	BiosVideoDriverBindingStop (\r
	201	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	202	IN EFI_HANDLE Controller,\r
	203	IN UINTN NumberOfChildren,\r
	204	IN EFI_HANDLE *ChildHandleBuffer\r
	205	)\r
7da78b1f	206	;\r
	207	\r
	208	//\r
	209	// Private worker functions\r
	210	//\r
f1294e4a	211	/**\r
	212	Check for VBE device\r
	213	\r
	214	@param BiosVideoPrivate - Pointer to BIOS_VIDEO_DEV structure\r
	215	\r
	216	@retval EFI_SUCCESS VBE device found\r
	217	\r
	218	**/\r
7da78b1f	219	EFI_STATUS\r
	220	BiosVideoCheckForVbe (\r
	221	BIOS_VIDEO_DEV *BiosVideoPrivate\r
	222	)\r
f1294e4a	223	;\r
0d92cdc2	224	\r
f1294e4a	225	/**\r
f1294e4a	226	Check for VGA device\r
0d92cdc2	227	\r
f1294e4a	228	@param BiosVideoPrivate - Pointer to BIOS_VIDEO_DEV structure\r
0d92cdc2	229	\r
f1294e4a	230	@retval EFI_SUCCESS Standard VGA device found\r
f1294e4a	231	**/\r
7da78b1f	232	\r
	233	EFI_STATUS\r
	234	BiosVideoCheckForVga (\r
	235	BIOS_VIDEO_DEV *BiosVideoPrivate\r
	236	)\r
7da78b1f	237	;\r
7da78b1f	238	\r
f1294e4a	239	/**\r
f1294e4a	240	Collect the resource from destroyed bios video device.\r
7da78b1f	241	\r
f1294e4a	242	@param BiosVideoPrivate Video child device private data structure\r
7da78b1f	243	\r
f1294e4a	244	**/\r
0d92cdc2	245	VOID\r
	246	BiosVideoDeviceReleaseResource (\r
	247	BIOS_VIDEO_DEV *BiosVideoChildPrivate\r
	248	)\r
f1294e4a	249	;\r
0d92cdc2	250	\r
f1294e4a	251	//\r
	252	// BIOS Graphics Output Protocol functions\r
	253	//\r
	254	/**\r
0d92cdc2	255	\r
f1294e4a	256	Graphics Output protocol interface to get video mode\r
0d92cdc2	257	\r
0d92cdc2	258	\r
f1294e4a	259	@param This - Protocol instance pointer.\r
	260	@param ModeNumber - The mode number to return information on.\r
	261	@param SizeOfInfo - A pointer to the size, in bytes, of the Info buffer.\r
	262	@param Info - Caller allocated buffer that returns information about ModeNumber.\r
0d92cdc2	263	\r
f1294e4a	264	@return EFI_SUCCESS - Mode information returned.\r
	265	EFI_DEVICE_ERROR - A hardware error occurred trying to retrieve the video mode.\r
	266	EFI_NOT_STARTED - Video display is not initialized. Call SetMode ()\r
	267	EFI_INVALID_PARAMETER - One of the input args was NULL.\r
0d92cdc2	268	\r
f1294e4a	269	**/\r
7da78b1f	270	EFI_STATUS\r
7da78b1f	271	EFIAPI\r
0d92cdc2	272	BiosVideoGraphicsOutputQueryMode (\r
	273	IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,\r
	274	IN UINT32 ModeNumber,\r
	275	OUT UINTN *SizeOfInfo,\r
	276	OUT EFI_GRAPHICS_OUTPUT_MODE_INFORMATION **Info\r
7da78b1f	277	)\r
f1294e4a	278	;\r
7da78b1f	279	\r
f1294e4a	280	/**\r
7da78b1f	281	\r
f1294e4a	282	Graphics Output protocol interface to set video mode\r
7da78b1f	283	\r
7da78b1f	284	\r
f1294e4a	285	@param This - Protocol instance pointer.\r
f1294e4a	286	@param ModeNumber - The mode number to be set.\r
7da78b1f	287	\r
f1294e4a	288	@return EFI_SUCCESS - Graphics mode was changed.\r
	289	EFI_DEVICE_ERROR - The device had an error and could not complete the request.\r
	290	EFI_UNSUPPORTED - ModeNumber is not supported by this device.\r
0d92cdc2	291	\r
f1294e4a	292	**/\r
0d92cdc2	293	EFI_STATUS\r
	294	EFIAPI\r
	295	BiosVideoGraphicsOutputSetMode (\r
	296	IN EFI_GRAPHICS_OUTPUT_PROTOCOL * This,\r
	297	IN UINT32 ModeNumber\r
	298	)\r
f1294e4a	299	;\r
0d92cdc2	300	\r
f1294e4a	301	/**\r
0d92cdc2	302	\r
f1294e4a	303	Graphics Output protocol instance to block transfer for VBE device\r
0d92cdc2	304	\r
7da78b1f	305	\r
f1294e4a	306	@param This - Pointer to Graphics Output protocol instance\r
	307	@param BltBuffer - The data to transfer to screen\r
	308	@param BltOperation - The operation to perform\r
	309	@param SourceX - The X coordinate of the source for BltOperation\r
	310	@param SourceY - The Y coordinate of the source for BltOperation\r
	311	@param DestinationX - The X coordinate of the destination for BltOperation\r
	312	@param DestinationY - The Y coordinate of the destination for BltOperation\r
	313	@param Width - The width of a rectangle in the blt rectangle in pixels\r
	314	@param Height - The height of a rectangle in the blt rectangle in pixels\r
	315	@param Delta - Not used for EfiBltVideoFill and EfiBltVideoToVideo operation.\r
	316	If a Delta of 0 is used, the entire BltBuffer will be operated on.\r
	317	If a subrectangle of the BltBuffer is used, then Delta represents\r
	318	the number of bytes in a row of the BltBuffer.\r
	319	\r
	320	@return EFI_INVALID_PARAMETER - Invalid parameter passed in\r
	321	EFI_SUCCESS - Blt operation success\r
	322	\r
	323	**/\r
7da78b1f	324	EFI_STATUS\r
7da78b1f	325	EFIAPI\r
0d92cdc2	326	BiosVideoGraphicsOutputVbeBlt (\r
	327	IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,\r
	328	IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer, OPTIONAL\r
	329	IN EFI_GRAPHICS_OUTPUT_BLT_OPERATION BltOperation,\r
	330	IN UINTN SourceX,\r
	331	IN UINTN SourceY,\r
	332	IN UINTN DestinationX,\r
	333	IN UINTN DestinationY,\r
	334	IN UINTN Width,\r
	335	IN UINTN Height,\r
	336	IN UINTN Delta\r
7da78b1f	337	)\r
7da78b1f	338	;\r
7da78b1f	339	\r
f1294e4a	340	/**\r
	341	Grahpics Output protocol instance to block transfer for VGA device\r
	342	\r
	343	@param This Pointer to Grahpics Output protocol instance\r
	344	@param BltBuffer The data to transfer to screen\r
	345	@param BltOperation The operation to perform\r
	346	@param SourceX The X coordinate of the source for BltOperation\r
	347	@param SourceY The Y coordinate of the source for BltOperation\r
	348	@param DestinationX The X coordinate of the destination for BltOperation\r
	349	@param DestinationY The Y coordinate of the destination for BltOperation\r
	350	@param Width The width of a rectangle in the blt rectangle in pixels\r
	351	@param Height The height of a rectangle in the blt rectangle in pixels\r
	352	@param Delta Not used for EfiBltVideoFill and EfiBltVideoToVideo operation.\r
	353	If a Delta of 0 is used, the entire BltBuffer will be operated on.\r
	354	If a subrectangle of the BltBuffer is used, then Delta represents\r
	355	the number of bytes in a row of the BltBuffer.\r
	356	\r
	357	@retval EFI_INVALID_PARAMETER Invalid parameter passed in\r
	358	@retval EFI_SUCCESS Blt operation success\r
	359	\r
	360	**/\r
7da78b1f	361	EFI_STATUS\r
7da78b1f	362	EFIAPI\r
0d92cdc2	363	BiosVideoGraphicsOutputVgaBlt (\r
	364	IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,\r
	365	IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer, OPTIONAL\r
	366	IN EFI_GRAPHICS_OUTPUT_BLT_OPERATION BltOperation,\r
	367	IN UINTN SourceX,\r
	368	IN UINTN SourceY,\r
	369	IN UINTN DestinationX,\r
	370	IN UINTN DestinationY,\r
	371	IN UINTN Width,\r
	372	IN UINTN Height,\r
	373	IN UINTN Delta\r
7da78b1f	374	)\r
7da78b1f	375	;\r
	376	\r
	377	//\r
	378	// BIOS VGA Mini Port Protocol functions\r
	379	//\r
f1294e4a	380	/**\r
	381	VgaMiniPort protocol interface to set mode\r
	382	\r
	383	@param This Pointer to VgaMiniPort protocol instance\r
	384	@param ModeNumber The index of the mode\r
	385	\r
	386	@retval EFI_UNSUPPORTED The requested mode is not supported\r
	387	@retval EFI_SUCCESS The requested mode is set successfully\r
	388	\r
	389	**/\r
7da78b1f	390	EFI_STATUS\r
	391	EFIAPI\r
	392	BiosVideoVgaMiniPortSetMode (\r
	393	IN EFI_VGA_MINI_PORT_PROTOCOL *This,\r
	394	IN UINTN ModeNumber\r
	395	)\r
7da78b1f	396	;\r
7da78b1f	397	\r
f1294e4a	398	/**\r
	399	Judge whether this device is VGA device.\r
	400	\r
	401	@param PciIo Parent PciIo protocol instance pointer\r
7da78b1f	402	\r
f1294e4a	403	@retval TRUE Is vga device\r
	404	@retval FALSE Is no vga device\r
	405	**/\r
7da78b1f	406	BOOLEAN\r
	407	BiosVideoIsVga (\r
	408	IN EFI_PCI_IO_PROTOCOL *PciIo\r
	409	)\r
	410	;\r
	411	\r
	412	\r
	413	//\r
	414	// Standard VGA Definitions\r
	415	//\r
	416	#define VGA_HORIZONTAL_RESOLUTION 640\r
	417	#define VGA_VERTICAL_RESOLUTION 480\r
	418	#define VGA_NUMBER_OF_BIT_PLANES 4\r
	419	#define VGA_PIXELS_PER_BYTE 8\r
	420	#define VGA_BYTES_PER_SCAN_LINE (VGA_HORIZONTAL_RESOLUTION / VGA_PIXELS_PER_BYTE)\r
	421	#define VGA_BYTES_PER_BIT_PLANE (VGA_VERTICAL_RESOLUTION * VGA_BYTES_PER_SCAN_LINE)\r
	422	\r
	423	#define VGA_GRAPHICS_CONTROLLER_ADDRESS_REGISTER 0x3ce\r
	424	#define VGA_GRAPHICS_CONTROLLER_DATA_REGISTER 0x3cf\r
	425	\r
	426	#define VGA_GRAPHICS_CONTROLLER_SET_RESET_REGISTER 0x00\r
	427	\r
	428	#define VGA_GRAPHICS_CONTROLLER_ENABLE_SET_RESET_REGISTER 0x01\r
	429	\r
	430	#define VGA_GRAPHICS_CONTROLLER_COLOR_COMPARE_REGISTER 0x02\r
	431	\r
	432	#define VGA_GRAPHICS_CONTROLLER_DATA_ROTATE_REGISTER 0x03\r
	433	#define VGA_GRAPHICS_CONTROLLER_FUNCTION_REPLACE 0x00\r
	434	#define VGA_GRAPHICS_CONTROLLER_FUNCTION_AND 0x08\r
	435	#define VGA_GRAPHICS_CONTROLLER_FUNCTION_OR 0x10\r
	436	#define VGA_GRAPHICS_CONTROLLER_FUNCTION_XOR 0x18\r
	437	\r
	438	#define VGA_GRAPHICS_CONTROLLER_READ_MAP_SELECT_REGISTER 0x04\r
	439	\r
	440	#define VGA_GRAPHICS_CONTROLLER_MODE_REGISTER 0x05\r
	441	#define VGA_GRAPHICS_CONTROLLER_READ_MODE_0 0x00\r
	442	#define VGA_GRAPHICS_CONTROLLER_READ_MODE_1 0x08\r
	443	#define VGA_GRAPHICS_CONTROLLER_WRITE_MODE_0 0x00\r
	444	#define VGA_GRAPHICS_CONTROLLER_WRITE_MODE_1 0x01\r
	445	#define VGA_GRAPHICS_CONTROLLER_WRITE_MODE_2 0x02\r
	446	#define VGA_GRAPHICS_CONTROLLER_WRITE_MODE_3 0x03\r
	447	\r
	448	#define VGA_GRAPHICS_CONTROLLER_MISCELLANEOUS_REGISTER 0x06\r
	449	\r
	450	#define VGA_GRAPHICS_CONTROLLER_COLOR_DONT_CARE_REGISTER 0x07\r
	451	\r
	452	#define VGA_GRAPHICS_CONTROLLER_BIT_MASK_REGISTER 0x08\r
	453	\r
f1294e4a	454	/**\r
	455	Initialize legacy environment for BIOS INI caller.\r
	456	\r
	457	@param ThunkContext the instance pointer of THUNK_CONTEXT\r
	458	**/\r
0d92cdc2	459	VOID\r
0d92cdc2	460	InitializeBiosIntCaller (\r
f1294e4a	461	THUNK_CONTEXT *ThunkContext\r
0d92cdc2	462	);\r
0d92cdc2	463	\r
f1294e4a	464	/**\r
	465	Initialize interrupt redirection code and entries, because\r
	466	IDT Vectors 0x68-0x6f must be redirected to IDT Vectors 0x08-0x0f.\r
	467	Or the interrupt will lost when we do thunk.\r
	468	NOTE: We do not reset 8259 vector base, because it will cause pending\r
	469	interrupt lost.\r
	470	\r
	471	@param Legacy8259 Instance pointer for EFI_LEGACY_8259_PROTOCOL.\r
	472	\r
	473	**/ \r
0d92cdc2	474	VOID\r
0d92cdc2	475	InitializeInterruptRedirection (\r
f1294e4a	476	IN EFI_LEGACY_8259_PROTOCOL *Legacy8259\r
0d92cdc2	477	);\r
0d92cdc2	478	\r
f1294e4a	479	/**\r
	480	Thunk to 16-bit real mode and execute a software interrupt with a vector \r
	481	of BiosInt. Regs will contain the 16-bit register context on entry and \r
	482	exit.\r
	483	\r
	484	@param This Protocol instance pointer.\r
	485	@param BiosInt Processor interrupt vector to invoke\r
	486	@param Reg Register contexted passed into (and returned) from thunk to 16-bit mode\r
	487	\r
	488	@retval TRUE Thunk completed, and there were no BIOS errors in the target code.\r
	489	See Regs for status.\r
	490	@retval FALSE There was a BIOS erro in the target code. \r
	491	**/ \r
0d92cdc2	492	BOOLEAN\r
	493	EFIAPI\r
	494	LegacyBiosInt86 (\r
	495	IN BIOS_VIDEO_DEV *BiosDev,\r
	496	IN UINT8 BiosInt,\r
	497	IN EFI_IA32_REGISTER_SET *Regs\r
	498	); \r
	499	\r
7da78b1f	500	#endif\r