[mirror_edk2.git] / IntelFrameworkModulePkg / Csm / BiosThunk / VideoDxe / BiosVideo.h

/** @file\r
\r
Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>\r
\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _BIOS_GRAPHICS_OUTPUT_H_\r
#define _BIOS_GRAPHICS_OUTPUT_H_\r
\r
#include <FrameworkDxe.h>\r
\r
#include <Protocol/PciIo.h>\r
#include <Protocol/EdidActive.h>\r
#include <Protocol/DevicePath.h>\r
#include <Protocol/EdidDiscovered.h>\r
#include <Protocol/LegacyBios.h>\r
#include <Protocol/VgaMiniPort.h>\r
#include <Protocol/GraphicsOutput.h>\r
#include <Protocol/EdidOverride.h>\r
\r
#include <Guid/StatusCodeDataTypeId.h>\r
#include <Guid/LegacyBios.h>\r
#include <Guid/EventGroup.h>\r
\r
#include <Library/PcdLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/ReportStatusCodeLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
\r
#include <IndustryStandard/Pci.h>\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                      ColorDepth;\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\r
  //\r
  EFI_PCI_IO_PROTOCOL                         *PciIo;\r
  EFI_LEGACY_BIOS_PROTOCOL                    *LegacyBios;\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
  UINTN                                       CurrentMode;\r
  UINTN                                       MaxMode;\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                    *GopDevicePath;\r
\r
  EFI_EVENT                                   ExitBootServicesEvent;\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
/**\r
  Supported.\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\r
                                 path\r
\r
  @retval EFI_STATUS             EFI_SUCCESS:This controller can be managed by this\r
                                 driver, Otherwise, this controller cannot be\r
                                 managed by this driver\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\r
                                 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.\r
\r
  @param  This                   Pointer to driver binding protocol\r
  @param  Controller             Controller handle to connect\r
  @param  NumberOfChildren       Number of children handle created by this driver\r
  @param  ChildHandleBuffer      Buffer containing child handle created\r
\r
  @retval EFI_SUCCESS            Driver disconnected successfully from controller\r
  @retval EFI_UNSUPPORTED        Cannot find BIOS_VIDEO_DEV structure\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
// Private worker functions\r
//\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
  IN OUT 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
  IN OUT BIOS_VIDEO_DEV  *BiosVideoPrivate\r
  );\r
\r
\r
\r
\r
/**\r
  Release resource for biso video instance.\r
\r
  @param  BiosVideoPrivate       Video child device private data structure\r
\r
**/\r
VOID\r
BiosVideoDeviceReleaseResource (\r
  BIOS_VIDEO_DEV  *BiosVideoPrivate\r
  );\r
\r
//\r
// BIOS Graphics Output Protocol functions\r
//\r
\r
/**\r
  Graphics Output protocol interface to get video mode.\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\r
                                 buffer.\r
  @param  Info                   Caller allocated buffer that returns information\r
                                 about ModeNumber.\r
\r
  @retval EFI_SUCCESS            Mode information returned.\r
  @retval EFI_BUFFER_TOO_SMALL   The Info buffer was too small.\r
  @retval EFI_DEVICE_ERROR       A hardware error occurred trying to retrieve the\r
                                 video mode.\r
  @retval EFI_NOT_STARTED        Video display is not initialized. Call SetMode ()\r
  @retval 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
  Graphics Output protocol interface to set video mode.\r
\r
  @param  This                   Protocol instance pointer.\r
  @param  ModeNumber             The mode number to be set.\r
\r
  @retval EFI_SUCCESS            Graphics mode was changed.\r
  @retval EFI_DEVICE_ERROR       The device had an error and could not complete the\r
                                 request.\r
  @retval 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
  Graphics Output protocol instance to block transfer for VBE device.\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\r
                                 BltOperation\r
  @param  DestinationY           The Y coordinate of the destination for\r
                                 BltOperation\r
  @param  Width                  The width of a rectangle in the blt rectangle in\r
                                 pixels\r
  @param  Height                 The height of a rectangle in the blt rectangle in\r
                                 pixels\r
  @param  Delta                  Not used for EfiBltVideoFill and\r
                                 EfiBltVideoToVideo operation. If a Delta of 0 is\r
                                 used, the entire BltBuffer will be operated on. If\r
                                 a subrectangle of the BltBuffer is used, then\r
                                 Delta represents the number of bytes in a row of\r
                                 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
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\r
                                 BltOperation\r
  @param  DestinationY           The Y coordinate of the destination for\r
                                 BltOperation\r
  @param  Width                  The width of a rectangle in the blt rectangle in\r
                                 pixels\r
  @param  Height                 The height of a rectangle in the blt rectangle in\r
                                 pixels\r
  @param  Delta                  Not used for EfiBltVideoFill and\r
                                 EfiBltVideoToVideo operation. If a Delta of 0 is\r
                                 used, the entire BltBuffer will be operated on. If\r
                                 a subrectangle of the BltBuffer is used, then\r
                                 Delta represents the number of bytes in a row of\r
                                 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
// BIOS VGA Mini Port Protocol functions\r
//\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
  Event handler for Exit Boot Service.\r
\r
  @param  Event       The event that be siganlled when exiting boot service.\r
  @param  Context     Pointer to instance of BIOS_VIDEO_DEV.\r
\r
**/\r
VOID\r
EFIAPI\r
BiosVideoNotifyExitBootServices (\r
  IN  EFI_EVENT Event,\r
  IN  VOID      *Context\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
  Install child handles if the Handle supports MBR format.\r
\r
  @param  This                   Calling context.\r
  @param  ParentHandle           Parent Handle\r
  @param  ParentPciIo            Parent PciIo interface\r
  @param  ParentLegacyBios       Parent LegacyBios interface\r
  @param  ParentDevicePath       Parent Device Path\r
  @param  RemainingDevicePath    Remaining Device Path\r
\r
  @retval EFI_SUCCESS            If a child handle was added\r
  @retval other                  A child handle was not added\r
\r
**/\r
EFI_STATUS\r
BiosVideoChildHandleInstall (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN  EFI_HANDLE                   ParentHandle,\r
  IN  EFI_PCI_IO_PROTOCOL          *ParentPciIo,\r
  IN  EFI_LEGACY_BIOS_PROTOCOL     *ParentLegacyBios,\r
  IN  EFI_DEVICE_PATH_PROTOCOL     *ParentDevicePath,\r
  IN  EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  );\r
\r
/**\r
  Deregister an video child handle and free resources.\r
\r
  @param  This                   Protocol instance pointer.\r
  @param  Controller             Video controller handle\r
  @param  Handle                 Video child handle\r
\r
  @return EFI_STATUS\r
\r
**/\r
EFI_STATUS\r
BiosVideoChildHandleUninstall (\r
  EFI_DRIVER_BINDING_PROTOCOL    *This,\r
  EFI_HANDLE                     Controller,\r
  EFI_HANDLE                     Handle\r
  );\r
\r
/**\r
  Release resource for biso video instance.\r
\r
  @param  BiosVideoPrivate       Video child device private data structure\r
\r
**/\r
VOID\r
BiosVideoDeviceReleaseResource (\r
  BIOS_VIDEO_DEV  *BiosVideoPrivate\r
  );\r
\r
/**\r
  Check if all video child handles have been uninstalled.\r
\r
  @param  Controller             Video controller handle\r
\r
  @return TRUE                   Child handles exist.\r
  @return FALSE                  All video child handles have been uninstalled.\r
\r
**/\r
BOOLEAN\r
HasChildHandle (\r
  IN EFI_HANDLE  Controller\r
  );\r
#endif\r
Commit	Line	Data
bcecde14	1	/** @file\r
bcecde14	2	\r
eca7d271	3	Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>\r
bcecde14	4	\r
c0a00b14	5	SPDX-License-Identifier: BSD-2-Clause-Patent\r
bcecde14	6	\r
	7	**/\r
	8	\r
	9	#ifndef _BIOS_GRAPHICS_OUTPUT_H_\r
	10	#define _BIOS_GRAPHICS_OUTPUT_H_\r
	11	\r
	12	#include <FrameworkDxe.h>\r
	13	\r
	14	#include <Protocol/PciIo.h>\r
	15	#include <Protocol/EdidActive.h>\r
	16	#include <Protocol/DevicePath.h>\r
	17	#include <Protocol/EdidDiscovered.h>\r
	18	#include <Protocol/LegacyBios.h>\r
	19	#include <Protocol/VgaMiniPort.h>\r
	20	#include <Protocol/GraphicsOutput.h>\r
	21	#include <Protocol/EdidOverride.h>\r
	22	\r
	23	#include <Guid/StatusCodeDataTypeId.h>\r
	24	#include <Guid/LegacyBios.h>\r
	25	#include <Guid/EventGroup.h>\r
	26	\r
	27	#include <Library/PcdLib.h>\r
	28	#include <Library/DebugLib.h>\r
	29	#include <Library/ReportStatusCodeLib.h>\r
	30	#include <Library/BaseMemoryLib.h>\r
	31	#include <Library/UefiDriverEntryPoint.h>\r
	32	#include <Library/UefiBootServicesTableLib.h>\r
	33	#include <Library/UefiLib.h>\r
	34	#include <Library/DevicePathLib.h>\r
	35	#include <Library/MemoryAllocationLib.h>\r
	36	\r
	37	#include <IndustryStandard/Pci.h>\r
	38	#include "VesaBiosExtensions.h"\r
	39	\r
	40	//\r
	41	// Packed format support: The number of bits reserved for each of the colors and the actual\r
	42	// position of RGB in the frame buffer is specified in the VBE Mode information\r
	43	//\r
	44	typedef struct {\r
	45	UINT8 Position; // Position of the color\r
	46	UINT8 Mask; // The number of bits expressed as a mask\r
	47	} BIOS_VIDEO_COLOR_PLACEMENT;\r
	48	\r
	49	//\r
	50	// BIOS Graphics Output Graphical Mode Data\r
	51	//\r
	52	typedef struct {\r
	53	UINT16 VbeModeNumber;\r
	54	UINT16 BytesPerScanLine;\r
	55	VOID *LinearFrameBuffer;\r
	56	UINTN FrameBufferSize;\r
	57	UINT32 HorizontalResolution;\r
	58	UINT32 VerticalResolution;\r
	59	UINT32 ColorDepth;\r
	60	UINT32 RefreshRate;\r
	61	UINT32 BitsPerPixel;\r
	62	BIOS_VIDEO_COLOR_PLACEMENT Red;\r
	63	BIOS_VIDEO_COLOR_PLACEMENT Green;\r
	64	BIOS_VIDEO_COLOR_PLACEMENT Blue;\r
	65	BIOS_VIDEO_COLOR_PLACEMENT Reserved;\r
	66	EFI_GRAPHICS_PIXEL_FORMAT PixelFormat;\r
	67	EFI_PIXEL_BITMASK PixelBitMask;\r
	68	} BIOS_VIDEO_MODE_DATA;\r
	69	\r
70	//\r
71	// BIOS video child handle private data Structure\r
72	//\r
73	#define BIOS_VIDEO_DEV_SIGNATURE SIGNATURE_32 ('B', 'V', 'M', 'p')\r
74	\r
75	typedef struct {\r
76	UINTN Signature;\r
77	EFI_HANDLE Handle;\r
78	\r
79	//\r
80	// Consumed Protocols\r
81	//\r
82	EFI_PCI_IO_PROTOCOL *PciIo;\r
83	EFI_LEGACY_BIOS_PROTOCOL *LegacyBios;\r
bcecde14	84	\r
	85	//\r
	86	// Produced Protocols\r
	87	//\r
	88	EFI_GRAPHICS_OUTPUT_PROTOCOL GraphicsOutput;\r
	89	EFI_EDID_DISCOVERED_PROTOCOL EdidDiscovered;\r
	90	EFI_EDID_ACTIVE_PROTOCOL EdidActive;\r
	91	EFI_VGA_MINI_PORT_PROTOCOL VgaMiniPort;\r
	92	\r
	93	//\r
	94	// General fields\r
	95	//\r
	96	BOOLEAN VgaCompatible;\r
	97	BOOLEAN ProduceGraphicsOutput;\r
	98	\r
	99	//\r
	100	// Graphics Output Protocol related fields\r
	101	//\r
	102	BOOLEAN HardwareNeedsStarting;\r
	103	UINTN CurrentMode;\r
	104	UINTN MaxMode;\r
	105	BIOS_VIDEO_MODE_DATA *ModeData;\r
	106	UINT8 *LineBuffer;\r
	107	EFI_GRAPHICS_OUTPUT_BLT_PIXEL *VbeFrameBuffer;\r
	108	UINT8 *VgaFrameBuffer;\r
	109	\r
	110	//\r
	111	// VESA Bios Extensions related fields\r
	112	//\r
	113	UINTN NumberOfPagesBelow1MB; // Number of 4KB pages in PagesBelow1MB\r
	114	EFI_PHYSICAL_ADDRESS PagesBelow1MB; // Buffer for all VBE Information Blocks\r
	115	VESA_BIOS_EXTENSIONS_INFORMATION_BLOCK *VbeInformationBlock; // 0x200 bytes. Must be allocated below 1MB\r
	116	VESA_BIOS_EXTENSIONS_MODE_INFORMATION_BLOCK *VbeModeInformationBlock; // 0x100 bytes. Must be allocated below 1MB\r
	117	VESA_BIOS_EXTENSIONS_EDID_DATA_BLOCK *VbeEdidDataBlock; // 0x80 bytes. Must be allocated below 1MB\r
	118	VESA_BIOS_EXTENSIONS_CRTC_INFORMATION_BLOCK *VbeCrtcInformationBlock; // 59 bytes. Must be allocated below 1MB\r
	119	UINTN VbeSaveRestorePages; // Number of 4KB pages in VbeSaveRestoreBuffer\r
	120	EFI_PHYSICAL_ADDRESS VbeSaveRestoreBuffer; // Must be allocated below 1MB\r
	121	//\r
	122	// Status code\r
	123	//\r
	124	EFI_DEVICE_PATH_PROTOCOL *GopDevicePath;\r
	125	\r
	126	EFI_EVENT ExitBootServicesEvent;\r
	127	} BIOS_VIDEO_DEV;\r
	128	\r
	129	#define BIOS_VIDEO_DEV_FROM_PCI_IO_THIS(a) CR (a, BIOS_VIDEO_DEV, PciIo, BIOS_VIDEO_DEV_SIGNATURE)\r
	130	#define BIOS_VIDEO_DEV_FROM_GRAPHICS_OUTPUT_THIS(a) CR (a, BIOS_VIDEO_DEV, GraphicsOutput, BIOS_VIDEO_DEV_SIGNATURE)\r
	131	#define BIOS_VIDEO_DEV_FROM_VGA_MINI_PORT_THIS(a) CR (a, BIOS_VIDEO_DEV, VgaMiniPort, BIOS_VIDEO_DEV_SIGNATURE)\r
	132	\r
	133	#define GRAPHICS_OUTPUT_INVALIDE_MODE_NUMBER 0xffff\r
	134	\r
	135	//\r
	136	// Global Variables\r
	137	//\r
	138	extern EFI_DRIVER_BINDING_PROTOCOL gBiosVideoDriverBinding;\r
	139	extern EFI_COMPONENT_NAME_PROTOCOL gBiosVideoComponentName;\r
	140	extern EFI_COMPONENT_NAME2_PROTOCOL gBiosVideoComponentName2;\r
	141	\r
	142	//\r
	143	// Driver Binding Protocol functions\r
	144	//\r
	145	\r
	146	/**\r
	147	Supported.\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\r
152	path\r
153	\r
154	@retval EFI_STATUS EFI_SUCCESS:This controller can be managed by this\r
155	driver, Otherwise, this controller cannot be\r
156	managed by this driver\r
157	\r
158	**/\r
159	EFI_STATUS\r
160	EFIAPI\r
161	BiosVideoDriverBindingSupported (\r
162	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
163	IN EFI_HANDLE Controller,\r
164	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
165	);\r
166	\r
167	\r
168	/**\r
169	Install Graphics Output Protocol onto VGA device handles.\r
170	\r
171	@param This Pointer to driver binding protocol\r
172	@param Controller Controller handle to connect\r
173	@param RemainingDevicePath A pointer to the remaining portion of a device\r
174	path\r
175	\r
176	@return EFI_STATUS\r
177	\r
178	**/\r
179	EFI_STATUS\r
180	EFIAPI\r
181	BiosVideoDriverBindingStart (\r
182	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
183	IN EFI_HANDLE Controller,\r
184	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
185	);\r
186	\r
187	\r
188	/**\r
189	Stop.\r
190	\r
191	@param This Pointer to driver binding protocol\r
192	@param Controller Controller handle to connect\r
193	@param NumberOfChildren Number of children handle created by this driver\r
194	@param ChildHandleBuffer Buffer containing child handle created\r
195	\r
196	@retval EFI_SUCCESS Driver disconnected successfully from controller\r
197	@retval EFI_UNSUPPORTED Cannot find BIOS_VIDEO_DEV structure\r
198	\r
199	**/\r
200	EFI_STATUS\r
201	EFIAPI\r
202	BiosVideoDriverBindingStop (\r
203	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
204	IN EFI_HANDLE Controller,\r
205	IN UINTN NumberOfChildren,\r
206	IN EFI_HANDLE *ChildHandleBuffer\r
207	);\r
208	\r
209	//\r
210	// Private worker functions\r
211	//\r
212	\r
213	/**\r
214	Check for VBE device.\r
215	\r
216	@param BiosVideoPrivate Pointer to BIOS_VIDEO_DEV structure\r
217	\r
218	@retval EFI_SUCCESS VBE device found\r
219	\r
220	**/\r
221	EFI_STATUS\r
222	BiosVideoCheckForVbe (\r
223	IN OUT BIOS_VIDEO_DEV *BiosVideoPrivate\r
224	);\r
225	\r
226	\r
227	/**\r
228	Check for VGA device.\r
229	\r
230	@param BiosVideoPrivate Pointer to BIOS_VIDEO_DEV structure\r
231	\r
232	@retval EFI_SUCCESS Standard VGA device found\r
233	\r
234	**/\r
235	EFI_STATUS\r
236	BiosVideoCheckForVga (\r
237	IN OUT BIOS_VIDEO_DEV *BiosVideoPrivate\r
238	);\r
239	\r
240	\r
241	\r
242	\r
243	/**\r
244	Release resource for biso video instance.\r
245	\r
246	@param BiosVideoPrivate Video child device private data structure\r
247	\r
248	**/\r
249	VOID\r
250	BiosVideoDeviceReleaseResource (\r
251	BIOS_VIDEO_DEV *BiosVideoPrivate\r
252	);\r
253	\r
254	//\r
255	// BIOS Graphics Output Protocol functions\r
256	//\r
257	\r
258	/**\r
259	Graphics Output protocol interface to get video mode.\r
260	\r
261	@param This Protocol instance pointer.\r
262	@param ModeNumber The mode number to return information on.\r
263	@param SizeOfInfo A pointer to the size, in bytes, of the Info\r
264	buffer.\r
265	@param Info Caller allocated buffer that returns information\r
266	about ModeNumber.\r
267	\r
268	@retval EFI_SUCCESS Mode information returned.\r
269	@retval EFI_BUFFER_TOO_SMALL The Info buffer was too small.\r
270	@retval EFI_DEVICE_ERROR A hardware error occurred trying to retrieve the\r
271	video mode.\r
272	@retval EFI_NOT_STARTED Video display is not initialized. Call SetMode ()\r
273	@retval EFI_INVALID_PARAMETER One of the input args was NULL.\r
274	\r
275	**/\r
276	EFI_STATUS\r
277	EFIAPI\r
278	BiosVideoGraphicsOutputQueryMode (\r
279	IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,\r
280	IN UINT32 ModeNumber,\r
281	OUT UINTN *SizeOfInfo,\r
282	OUT EFI_GRAPHICS_OUTPUT_MODE_INFORMATION **Info\r
283	);\r
284	\r
285	\r
286	/**\r
287	Graphics Output protocol interface to set video mode.\r
288	\r
289	@param This Protocol instance pointer.\r
290	@param ModeNumber The mode number to be set.\r
291	\r
292	@retval EFI_SUCCESS Graphics mode was changed.\r
293	@retval EFI_DEVICE_ERROR The device had an error and could not complete the\r
294	request.\r
295	@retval EFI_UNSUPPORTED ModeNumber is not supported by this device.\r
296	\r
297	**/\r
298	EFI_STATUS\r
299	EFIAPI\r
300	BiosVideoGraphicsOutputSetMode (\r
301	IN EFI_GRAPHICS_OUTPUT_PROTOCOL * This,\r
302	IN UINT32 ModeNumber\r
303	);\r
304	\r
305	\r
306	/**\r
307	Graphics Output protocol instance to block transfer for VBE device.\r
308	\r
309	@param This Pointer to Graphics Output protocol instance\r
310	@param BltBuffer The data to transfer to screen\r
311	@param BltOperation The operation to perform\r
312	@param SourceX The X coordinate of the source for BltOperation\r
313	@param SourceY The Y coordinate of the source for BltOperation\r
314	@param DestinationX The X coordinate of the destination for\r
315	BltOperation\r
316	@param DestinationY The Y coordinate of the destination for\r
317	BltOperation\r
318	@param Width The width of a rectangle in the blt rectangle in\r
319	pixels\r
320	@param Height The height of a rectangle in the blt rectangle in\r
321	pixels\r
322	@param Delta Not used for EfiBltVideoFill and\r
323	EfiBltVideoToVideo operation. If a Delta of 0 is\r
324	used, the entire BltBuffer will be operated on. If\r
325	a subrectangle of the BltBuffer is used, then\r
326	Delta represents the number of bytes in a row of\r
327	the BltBuffer.\r
328	\r
329	@retval EFI_INVALID_PARAMETER Invalid parameter passed in\r
330	@retval EFI_SUCCESS Blt operation success\r
331	\r
332	**/\r
333	EFI_STATUS\r
334	EFIAPI\r
335	BiosVideoGraphicsOutputVbeBlt (\r
336	IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,\r
337	IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer, OPTIONAL\r
338	IN EFI_GRAPHICS_OUTPUT_BLT_OPERATION BltOperation,\r
339	IN UINTN SourceX,\r
340	IN UINTN SourceY,\r
341	IN UINTN DestinationX,\r
342	IN UINTN DestinationY,\r
343	IN UINTN Width,\r
344	IN UINTN Height,\r
345	IN UINTN Delta\r
346	);\r
347	\r
348	\r
349	/**\r
350	Grahpics Output protocol instance to block transfer for VGA device.\r
351	\r
352	@param This Pointer to Grahpics Output protocol instance\r
353	@param BltBuffer The data to transfer to screen\r
354	@param BltOperation The operation to perform\r
355	@param SourceX The X coordinate of the source for BltOperation\r
356	@param SourceY The Y coordinate of the source for BltOperation\r
357	@param DestinationX The X coordinate of the destination for\r
358	BltOperation\r
359	@param DestinationY The Y coordinate of the destination for\r
360	BltOperation\r
361	@param Width The width of a rectangle in the blt rectangle in\r
362	pixels\r
363	@param Height The height of a rectangle in the blt rectangle in\r
364	pixels\r
365	@param Delta Not used for EfiBltVideoFill and\r
366	EfiBltVideoToVideo operation. If a Delta of 0 is\r
367	used, the entire BltBuffer will be operated on. If\r
368	a subrectangle of the BltBuffer is used, then\r
369	Delta represents the number of bytes in a row of\r
370	the BltBuffer.\r
371	\r
372	@retval EFI_INVALID_PARAMETER Invalid parameter passed in\r
373	@retval EFI_SUCCESS Blt operation success\r
374	\r
375	**/\r
376	EFI_STATUS\r
377	EFIAPI\r
378	BiosVideoGraphicsOutputVgaBlt (\r
379	IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,\r
380	IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer, OPTIONAL\r
381	IN EFI_GRAPHICS_OUTPUT_BLT_OPERATION BltOperation,\r
382	IN UINTN SourceX,\r
383	IN UINTN SourceY,\r
384	IN UINTN DestinationX,\r
385	IN UINTN DestinationY,\r
386	IN UINTN Width,\r
387	IN UINTN Height,\r
388	IN UINTN Delta\r
389	);\r
390	\r
391	//\r
392	// BIOS VGA Mini Port Protocol functions\r
393	//\r
394	\r
395	/**\r
396	VgaMiniPort protocol interface to set mode.\r
397	\r
398	@param This Pointer to VgaMiniPort protocol instance\r
399	@param ModeNumber The index of the mode\r
400	\r
401	@retval EFI_UNSUPPORTED The requested mode is not supported\r
402	@retval EFI_SUCCESS The requested mode is set successfully\r
403	\r
404	**/\r
405	EFI_STATUS\r
406	EFIAPI\r
407	BiosVideoVgaMiniPortSetMode (\r
408	IN EFI_VGA_MINI_PORT_PROTOCOL *This,\r
409	IN UINTN ModeNumber\r
410	);\r
411	\r
412	/**\r
413	Event handler for Exit Boot Service.\r
414	\r
415	@param Event The event that be siganlled when exiting boot service.\r
416	@param Context Pointer to instance of BIOS_VIDEO_DEV.\r
417	\r
418	**/\r
419	VOID\r
420	EFIAPI\r
421	BiosVideoNotifyExitBootServices (\r
422	IN EFI_EVENT Event,\r
423	IN VOID *Context\r
424	);\r
425	\r
426	//\r
427	// Standard VGA Definitions\r
428	//\r
429	#define VGA_HORIZONTAL_RESOLUTION 640\r
430	#define VGA_VERTICAL_RESOLUTION 480\r
431	#define VGA_NUMBER_OF_BIT_PLANES 4\r
432	#define VGA_PIXELS_PER_BYTE 8\r
433	#define VGA_BYTES_PER_SCAN_LINE (VGA_HORIZONTAL_RESOLUTION / VGA_PIXELS_PER_BYTE)\r
434	#define VGA_BYTES_PER_BIT_PLANE (VGA_VERTICAL_RESOLUTION * VGA_BYTES_PER_SCAN_LINE)\r
435	\r
436	#define VGA_GRAPHICS_CONTROLLER_ADDRESS_REGISTER 0x3ce\r
437	#define VGA_GRAPHICS_CONTROLLER_DATA_REGISTER 0x3cf\r
438	\r
439	#define VGA_GRAPHICS_CONTROLLER_SET_RESET_REGISTER 0x00\r
440	\r
441	#define VGA_GRAPHICS_CONTROLLER_ENABLE_SET_RESET_REGISTER 0x01\r
442	\r
443	#define VGA_GRAPHICS_CONTROLLER_COLOR_COMPARE_REGISTER 0x02\r
444	\r
445	#define VGA_GRAPHICS_CONTROLLER_DATA_ROTATE_REGISTER 0x03\r
446	#define VGA_GRAPHICS_CONTROLLER_FUNCTION_REPLACE 0x00\r
447	#define VGA_GRAPHICS_CONTROLLER_FUNCTION_AND 0x08\r
448	#define VGA_GRAPHICS_CONTROLLER_FUNCTION_OR 0x10\r
449	#define VGA_GRAPHICS_CONTROLLER_FUNCTION_XOR 0x18\r
450	\r
451	#define VGA_GRAPHICS_CONTROLLER_READ_MAP_SELECT_REGISTER 0x04\r
452	\r
453	#define VGA_GRAPHICS_CONTROLLER_MODE_REGISTER 0x05\r
454	#define VGA_GRAPHICS_CONTROLLER_READ_MODE_0 0x00\r
455	#define VGA_GRAPHICS_CONTROLLER_READ_MODE_1 0x08\r
456	#define VGA_GRAPHICS_CONTROLLER_WRITE_MODE_0 0x00\r
457	#define VGA_GRAPHICS_CONTROLLER_WRITE_MODE_1 0x01\r
458	#define VGA_GRAPHICS_CONTROLLER_WRITE_MODE_2 0x02\r
459	#define VGA_GRAPHICS_CONTROLLER_WRITE_MODE_3 0x03\r
460	\r
461	#define VGA_GRAPHICS_CONTROLLER_MISCELLANEOUS_REGISTER 0x06\r
462	\r
463	#define VGA_GRAPHICS_CONTROLLER_COLOR_DONT_CARE_REGISTER 0x07\r
464	\r
465	#define VGA_GRAPHICS_CONTROLLER_BIT_MASK_REGISTER 0x08\r
466	\r
467	/**\r
468	Install child handles if the Handle supports MBR format.\r
469	\r
470	@param This Calling context.\r
471	@param ParentHandle Parent Handle\r
472	@param ParentPciIo Parent PciIo interface\r
473	@param ParentLegacyBios Parent LegacyBios interface\r
474	@param ParentDevicePath Parent Device Path\r
475	@param RemainingDevicePath Remaining Device Path\r
bcecde14	476	\r
	477	@retval EFI_SUCCESS If a child handle was added\r
	478	@retval other A child handle was not added\r
	479	\r
	480	**/\r
	481	EFI_STATUS\r
	482	BiosVideoChildHandleInstall (\r
	483	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	484	IN EFI_HANDLE ParentHandle,\r
	485	IN EFI_PCI_IO_PROTOCOL *ParentPciIo,\r
	486	IN EFI_LEGACY_BIOS_PROTOCOL *ParentLegacyBios,\r
	487	IN EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath,\r
eca7d271	488	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
bcecde14	489	);\r
	490	\r
	491	/**\r
	492	Deregister an video child handle and free resources.\r
	493	\r
	494	@param This Protocol instance pointer.\r
	495	@param Controller Video controller handle\r
	496	@param Handle Video child handle\r
	497	\r
	498	@return EFI_STATUS\r
	499	\r
	500	**/\r
	501	EFI_STATUS\r
	502	BiosVideoChildHandleUninstall (\r
	503	EFI_DRIVER_BINDING_PROTOCOL *This,\r
	504	EFI_HANDLE Controller,\r
	505	EFI_HANDLE Handle\r
	506	);\r
	507	\r
	508	/**\r
	509	Release resource for biso video instance.\r
	510	\r
	511	@param BiosVideoPrivate Video child device private data structure\r
	512	\r
	513	**/\r
	514	VOID\r
	515	BiosVideoDeviceReleaseResource (\r
	516	BIOS_VIDEO_DEV *BiosVideoPrivate\r
	517	);\r
	518	\r
eca7d271	519	/**\r
	520	Check if all video child handles have been uninstalled.\r
	521	\r
	522	@param Controller Video controller handle\r
	523	\r
	524	@return TRUE Child handles exist.\r
	525	@return FALSE All video child handles have been uninstalled.\r
	526	\r
	527	**/\r
	528	BOOLEAN\r
	529	HasChildHandle (\r
	530	IN EFI_HANDLE Controller\r
	531	);\r
bcecde14	532	#endif\r