[mirror_edk2.git] / MdeModulePkg / Universal / Console / GraphicsConsoleDxe / GraphicsConsole.h

/** @file\r
  Header file for GraphicsConsole driver.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\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 _GRAPHICS_CONSOLE_H_\r
#define _GRAPHICS_CONSOLE_H_\r
\r
#include <Uefi.h>\r
#include <Protocol/SimpleTextOut.h>\r
#include <Protocol/GraphicsOutput.h>\r
#include <Protocol/UgaDraw.h>\r
#include <Protocol/DevicePath.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/PcdLib.h>\r
\r
#include <MdeModuleHii.h>\r
\r
#include <Protocol/HiiFont.h>\r
#include <Protocol/HiiDatabase.h>\r
\r
\r
extern EFI_COMPONENT_NAME_PROTOCOL   gGraphicsConsoleComponentName;\r
extern EFI_COMPONENT_NAME2_PROTOCOL  gGraphicsConsoleComponentName2;\r
extern EFI_DRIVER_BINDING_PROTOCOL   gGraphicsConsoleDriverBinding;\r
extern EFI_NARROW_GLYPH              gUsStdNarrowGlyphData[];\r
\r
\r
//\r
// User can define valid graphic resolution here\r
// e.g. 640x480, 800x600, 1024x768...\r
//\r
#define CURRENT_HORIZONTAL_RESOLUTION  800\r
#define CURRENT_VERTICAL_RESOLUTION    600\r
\r
typedef union {\r
  EFI_NARROW_GLYPH  NarrowGlyph;\r
  EFI_WIDE_GLYPH    WideGlyph;\r
} GLYPH_UNION;\r
\r
//\r
// Device Structure\r
//\r
#define GRAPHICS_CONSOLE_DEV_SIGNATURE  SIGNATURE_32 ('g', 's', 't', 'o')\r
\r
typedef struct {\r
  UINTN   Columns;\r
  UINTN   Rows;\r
  INTN    DeltaX;\r
  INTN    DeltaY;\r
  UINT32  GopWidth;\r
  UINT32  GopHeight;\r
  UINT32  GopModeNumber;\r
} GRAPHICS_CONSOLE_MODE_DATA;\r
\r
#define GRAPHICS_MAX_MODE 4\r
\r
typedef struct {\r
  UINTN                            Signature;\r
  EFI_GRAPHICS_OUTPUT_PROTOCOL     *GraphicsOutput;\r
  EFI_UGA_DRAW_PROTOCOL            *UgaDraw;\r
  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  SimpleTextOutput;\r
  EFI_SIMPLE_TEXT_OUTPUT_MODE      SimpleTextOutputMode;\r
  GRAPHICS_CONSOLE_MODE_DATA       ModeData[GRAPHICS_MAX_MODE];\r
  EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *LineBuffer;\r
  EFI_HII_HANDLE                   HiiHandle;\r
} GRAPHICS_CONSOLE_DEV;\r
\r
#define GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS(a) \\r
  CR (a, GRAPHICS_CONSOLE_DEV, SimpleTextOutput, GRAPHICS_CONSOLE_DEV_SIGNATURE)\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 3066 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
GraphicsConsoleComponentNameGetDriverName (\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 3066 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
GraphicsConsoleComponentNameGetControllerName (\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
\r
/**\r
  Returns available Unicode glyphs narrow fonts(8*19 pixels) size.\r
\r
  @return Narrow font size.\r
\r
**/\r
UINT32\r
ReturnNarrowFontSize (\r
  VOID\r
  );\r
\r
/**\r
  Reset the text output device hardware and optionally run diagnostics.\r
  \r
  Implements SIMPLE_TEXT_OUTPUT.Reset().\r
  If ExtendeVerification is TRUE, then perform dependent Graphics Console\r
  device reset, and set display mode to mode 0.\r
  If ExtendedVerification is FALSE, only set display mode to mode 0.\r
\r
  @param  This                  Protocol instance pointer.\r
  @param  ExtendedVerification  Indicates that the driver may perform a more\r
                                exhaustive verification operation of the device\r
                                during reset.\r
\r
  @retval EFI_SUCCESS          The text output device was reset.\r
  @retval EFI_DEVICE_ERROR     The text output device is not functioning correctly and\r
                               could not be reset.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleConOutReset (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL    *This,\r
  IN  BOOLEAN                            ExtendedVerification\r
  );\r
\r
/**\r
  Write a Unicode string to the output device.\r
\r
  Implements SIMPLE_TEXT_OUTPUT.OutputString(). \r
  The Unicode string will be converted to Glyphs and will be\r
  sent to the Graphics Console.\r
\r
  @param  This                    Protocol instance pointer.\r
  @param  WString                 The NULL-terminated Unicode string to be displayed\r
                                  on the output device(s). All output devices must\r
                                  also support the Unicode drawing defined in this file.\r
\r
  @retval EFI_SUCCESS             The string was output to the device.\r
  @retval EFI_DEVICE_ERROR        The device reported an error while attempting to output\r
                                  the text.\r
  @retval EFI_UNSUPPORTED         The output device's mode is not currently in a\r
                                  defined text mode.\r
  @retval EFI_WARN_UNKNOWN_GLYPH  This warning code indicates that some of the\r
                                  characters in the Unicode string could not be\r
                                  rendered and were skipped.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleConOutOutputString (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  CHAR16                           *WString\r
  );\r
\r
/**\r
  Implements SIMPLE_TEXT_OUTPUT.TestString().\r
  If one of the characters in the *Wstring is\r
  neither valid valid Unicode drawing characters,\r
  not ASCII code, then this function will return\r
  EFI_UNSUPPORTED.\r
\r
  @param  This                  Indicates the calling context.\r
  @param  WString               The Null-terminated Unicode string to be tested.\r
\r
  @return EFI_SUCCESS\r
  @return The Graphics Console is capable of rendering the output string.\r
  @return EFI_UNSUPPORTED\r
  @return Some of the characters in the Unicode string cannot be rendered.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleConOutTestString (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  CHAR16                           *WString\r
  );\r
\r
/**\r
  Returns information for an available text mode that the output device(s)\r
  supports\r
\r
  Implements SIMPLE_TEXT_OUTPUT.QueryMode().\r
  It returnes information for an available text mode that the Graphics Console supports.\r
  In this driver,we only support text mode 80x25, which is defined as mode 0.\r
\r
  @param  This                  Protocol instance pointer.\r
  @param  ModeNumber            The mode number to return information on.\r
  @param  Columns               The returned columns of the requested mode.\r
  @param  Rows                  The returned rows of the requested mode.\r
\r
  @retval EFI_SUCCESS           The requested mode information is returned.\r
  @retval EFI_UNSUPPORTED       The mode number is not valid.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleConOutQueryMode (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  UINTN                            ModeNumber,\r
  OUT UINTN                            *Columns,\r
  OUT UINTN                            *Rows\r
  );\r
\r
\r
/**\r
  Sets the output device(s) to a specified mode.\r
  \r
  Implements SIMPLE_TEXT_OUTPUT.SetMode().\r
  Set the Graphics Console to a specified mode. In this driver, we only support mode 0.\r
\r
  @param  This                  Protocol instance pointer.\r
  @param  ModeNumber            The text mode to set.\r
\r
  @retval EFI_SUCCESS           The requested text mode is set.\r
  @retval EFI_DEVICE_ERROR      The requested text mode cannot be set because of \r
                                Graphics Console device error.\r
  @retval EFI_UNSUPPORTED       The text mode number is not valid.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleConOutSetMode (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  UINTN                            ModeNumber\r
  );\r
\r
/**\r
  Implements SIMPLE_TEXT_OUTPUT.SetAttribute().\r
\r
  @param  This                  Indicates the calling context.\r
  @param  Attribute             The attribute to set. Only bit0..6 are valid, all\r
                                other bits are undefined and must be zero.\r
\r
  @return EFI_SUCCESS           The requested attribute is set.\r
  @return EFI_DEVICE_ERROR      The requested attribute cannot be set due to Graphics Console port error.\r
  @return EFI_UNSUPPORTED       The attribute requested is not defined by EFI spec.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleConOutSetAttribute (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  UINTN                            Attribute\r
  );\r
\r
/**\r
  Clears the output device(s) display to the currently selected background \r
  color.\r
\r
  Implements SIMPLE_TEXT_OUTPUT.ClearScreen().\r
\r
  @param  This                  Protocol instance pointer.\r
\r
  @retval  EFI_SUCCESS      The operation completed successfully.\r
  @retval  EFI_DEVICE_ERROR The device had an error and could not complete the request.\r
  @retval  EFI_UNSUPPORTED  The output device is not in a valid text mode.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleConOutClearScreen (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This\r
  );\r
\r
/**\r
  Implements SIMPLE_TEXT_OUTPUT.SetCursorPosition().\r
\r
  @param  This                  Indicates the calling context.\r
  @param  Column                The row to set cursor to.\r
  @param  Row                   The column to set cursor to.\r
\r
  @return EFI_SUCCESS\r
  @return The operation completed successfully.\r
  @return EFI_DEVICE_ERROR\r
  @return The request fails due to Graphics Console device error.\r
  @return EFI_UNSUPPORTED\r
  @return The Graphics Console is not in a valid text mode, or the cursor position\r
  @return is invalid for current mode.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleConOutSetCursorPosition (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  UINTN                            Column,\r
  IN  UINTN                            Row\r
  );\r
\r
\r
/**\r
  Makes the cursor visible or invisible.\r
\r
  Implements SIMPLE_TEXT_OUTPUT.EnableCursor().\r
\r
  @param  This                  Protocol instance pointer.\r
  @param  Visible               If TRUE, the cursor is set to be visible, If FALSE,\r
                                the cursor is set to be invisible.\r
\r
  @retval EFI_SUCCESS           The operation completed successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleConOutEnableCursor (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  BOOLEAN                          Visible\r
  );\r
\r
/**\r
  Test to see if Graphics Console could be supported on the Controller.\r
\r
  Graphics Console could be supported if Graphics Output Protocol or UGA Draw\r
  Protocol exists on the Controller. (UGA Draw Protocol could be skipped\r
  if PcdUgaConsumeSupport is set to FALSE.)\r
\r
  @param  This                Protocol instance pointer.\r
  @param  Controller          Handle of device to test.\r
  @param  RemainingDevicePath Optional parameter use to pick a specific child\r
                              device to start.\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
GraphicsConsoleControllerDriverSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL    *This,\r
  IN EFI_HANDLE                     Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath\r
  );\r
\r
\r
/**\r
  Start this driver on Controller by opening Graphics Output protocol or \r
  UGA Draw protocol, and installing Simple Text Out protocol on Controller.\r
  (UGA Draw protocol could be skipped if PcdUgaConsumeSupport is set to FALSE.)\r
  \r
  @param  This                 Protocol instance pointer.\r
  @param  Controller           Handle of device to bind driver to\r
  @param  RemainingDevicePath  Optional parameter use to pick a specific child\r
                               device to start.\r
\r
  @retval EFI_SUCCESS          This driver is added to Controller.\r
  @retval other                This driver does not support this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleControllerDriverStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL    *This,\r
  IN EFI_HANDLE                     Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath\r
  );\r
\r
/**\r
  Stop this driver on Controller by removing Simple Text Out protocol \r
  and closing the Graphics Output Protocol or UGA Draw protocol on Controller.\r
  (UGA Draw protocol could be skipped if PcdUgaConsumeSupport is set to FALSE.)\r
  \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 EFI_NOT_STARTED   Simple Text Out protocol could not be found the \r
                            Controller.\r
  @retval other             This driver was not removed from this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleControllerDriverStop (\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
  Locate HII Database protocol and HII Font protocol.\r
\r
  @retval  EFI_SUCCESS     HII Database protocol and HII Font protocol \r
                           are located successfully.\r
  @return  other           Failed to locate HII Database protocol or \r
                           HII Font protocol.\r
\r
**/\r
EFI_STATUS\r
EfiLocateHiiProtocol (\r
  VOID\r
  );\r
\r
\r
#endif\r
Commit	Line	Data
fb0b259e	1	/** @file\r
fb0b259e	2	Header file for GraphicsConsole driver.\r
95276127	3	\r
6dcf9abc	4	Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
8541adab	5	All rights reserved. This program and the accompanying materials\r
	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
95276127	12	\r
fb0b259e	13	**/\r
95276127	14	\r
6dcf9abc	15	#ifndef _GRAPHICS_CONSOLE_H_\r
6dcf9abc	16	#define _GRAPHICS_CONSOLE_H_\r
95276127	17	\r
60c93673	18	#include <Uefi.h>\r
97a079ed A	19	#include <Protocol/SimpleTextOut.h>\r
	20	#include <Protocol/GraphicsOutput.h>\r
	21	#include <Protocol/UgaDraw.h>\r
	22	#include <Protocol/DevicePath.h>\r
	23	#include <Library/DebugLib.h>\r
	24	#include <Library/UefiDriverEntryPoint.h>\r
	25	#include <Library/UefiLib.h>\r
97a079ed A	26	#include <Library/BaseMemoryLib.h>\r
	27	#include <Library/MemoryAllocationLib.h>\r
	28	#include <Library/UefiBootServicesTableLib.h>\r
93e3992d	29	#include <Library/HiiLib.h>\r
93e3992d	30	#include <Library/BaseLib.h>\r
8541adab	31	#include <Library/PcdLib.h>\r
93e3992d	32	\r
	33	#include <MdeModuleHii.h>\r
	34	\r
	35	#include <Protocol/HiiFont.h>\r
	36	#include <Protocol/HiiDatabase.h>\r
97a079ed A	37	\r
97a079ed A	38	\r
5bca971e	39	extern EFI_COMPONENT_NAME_PROTOCOL gGraphicsConsoleComponentName;\r
5bca971e	40	extern EFI_COMPONENT_NAME2_PROTOCOL gGraphicsConsoleComponentName2;\r
878670ea	41	extern EFI_DRIVER_BINDING_PROTOCOL gGraphicsConsoleDriverBinding;\r
	42	extern EFI_NARROW_GLYPH gUsStdNarrowGlyphData[];\r
	43	\r
	44	\r
	45	//\r
	46	// User can define valid graphic resolution here\r
	47	// e.g. 640x480, 800x600, 1024x768...\r
	48	//\r
	49	#define CURRENT_HORIZONTAL_RESOLUTION 800\r
	50	#define CURRENT_VERTICAL_RESOLUTION 600\r
	51	\r
	52	typedef union {\r
	53	EFI_NARROW_GLYPH NarrowGlyph;\r
	54	EFI_WIDE_GLYPH WideGlyph;\r
	55	} GLYPH_UNION;\r
	56	\r
	57	//\r
	58	// Device Structure\r
	59	//\r
	60	#define GRAPHICS_CONSOLE_DEV_SIGNATURE SIGNATURE_32 ('g', 's', 't', 'o')\r
	61	\r
	62	typedef struct {\r
	63	UINTN Columns;\r
	64	UINTN Rows;\r
	65	INTN DeltaX;\r
	66	INTN DeltaY;\r
	67	UINT32 GopWidth;\r
	68	UINT32 GopHeight;\r
	69	UINT32 GopModeNumber;\r
	70	} GRAPHICS_CONSOLE_MODE_DATA;\r
	71	\r
	72	#define GRAPHICS_MAX_MODE 4\r
	73	\r
	74	typedef struct {\r
	75	UINTN Signature;\r
	76	EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;\r
	77	EFI_UGA_DRAW_PROTOCOL *UgaDraw;\r
	78	EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL SimpleTextOutput;\r
	79	EFI_SIMPLE_TEXT_OUTPUT_MODE SimpleTextOutputMode;\r
	80	GRAPHICS_CONSOLE_MODE_DATA ModeData[GRAPHICS_MAX_MODE];\r
	81	EFI_GRAPHICS_OUTPUT_BLT_PIXEL *LineBuffer;\r
	82	EFI_HII_HANDLE HiiHandle;\r
	83	} GRAPHICS_CONSOLE_DEV;\r
	84	\r
	85	#define GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS(a) \\r
	86	CR (a, GRAPHICS_CONSOLE_DEV, SimpleTextOutput, GRAPHICS_CONSOLE_DEV_SIGNATURE)\r
	87	\r
95276127	88	\r
95276127	89	//\r
97a079ed	90	// EFI Component Name Functions\r
95276127	91	//\r
5bca971e	92	/**\r
	93	Retrieves a Unicode string that is the user readable name of the driver.\r
	94	\r
	95	This function retrieves the user readable name of a driver in the form of a\r
	96	Unicode string. If the driver specified by This has a user readable name in\r
	97	the language specified by Language, then a pointer to the driver name is\r
	98	returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
	99	by This does not support the language specified by Language,\r
	100	then EFI_UNSUPPORTED is returned.\r
	101	\r
	102	@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
	103	EFI_COMPONENT_NAME_PROTOCOL instance.\r
	104	\r
	105	@param Language[in] A pointer to a Null-terminated ASCII string\r
	106	array indicating the language. This is the\r
	107	language of the driver name that the caller is\r
	108	requesting, and it must match one of the\r
	109	languages specified in SupportedLanguages. The\r
	110	number of languages supported by a driver is up\r
	111	to the driver writer. Language is specified\r
	112	in RFC 3066 or ISO 639-2 language code format.\r
	113	\r
	114	@param DriverName[out] A pointer to the Unicode string to return.\r
	115	This Unicode string is the name of the\r
	116	driver specified by This in the language\r
	117	specified by Language.\r
	118	\r
	119	@retval EFI_SUCCESS The Unicode string for the Driver specified by\r
	120	This and the language specified by Language was\r
	121	returned in DriverName.\r
	122	\r
	123	@retval EFI_INVALID_PARAMETER Language is NULL.\r
	124	\r
	125	@retval EFI_INVALID_PARAMETER DriverName is NULL.\r
	126	\r
	127	@retval EFI_UNSUPPORTED The driver specified by This does not support\r
	128	the language specified by Language.\r
	129	\r
	130	**/\r
97a079ed A	131	EFI_STATUS\r
	132	EFIAPI\r
	133	GraphicsConsoleComponentNameGetDriverName (\r
	134	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	135	IN CHAR8 *Language,\r
	136	OUT CHAR16 **DriverName\r
	137	);\r
	138	\r
5bca971e	139	\r
	140	/**\r
	141	Retrieves a Unicode string that is the user readable name of the controller\r
	142	that is being managed by a driver.\r
	143	\r
	144	This function retrieves the user readable name of the controller specified by\r
	145	ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
	146	driver specified by This has a user readable name in the language specified by\r
	147	Language, then a pointer to the controller name is returned in ControllerName,\r
	148	and EFI_SUCCESS is returned. If the driver specified by This is not currently\r
	149	managing the controller specified by ControllerHandle and ChildHandle,\r
	150	then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
	151	support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
	152	\r
	153	@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
	154	EFI_COMPONENT_NAME_PROTOCOL instance.\r
	155	\r
	156	@param ControllerHandle[in] The handle of a controller that the driver\r
	157	specified by This is managing. This handle\r
	158	specifies the controller whose name is to be\r
	159	returned.\r
	160	\r
	161	@param ChildHandle[in] The handle of the child controller to retrieve\r
	162	the name of. This is an optional parameter that\r
	163	may be NULL. It will be NULL for device\r
	164	drivers. It will also be NULL for a bus drivers\r
	165	that wish to retrieve the name of the bus\r
	166	controller. It will not be NULL for a bus\r
	167	driver that wishes to retrieve the name of a\r
	168	child controller.\r
	169	\r
	170	@param Language[in] A pointer to a Null-terminated ASCII string\r
	171	array indicating the language. This is the\r
	172	language of the driver name that the caller is\r
	173	requesting, and it must match one of the\r
	174	languages specified in SupportedLanguages. The\r
	175	number of languages supported by a driver is up\r
	176	to the driver writer. Language is specified in\r
	177	RFC 3066 or ISO 639-2 language code format.\r
	178	\r
	179	@param ControllerName[out] A pointer to the Unicode string to return.\r
	180	This Unicode string is the name of the\r
	181	controller specified by ControllerHandle and\r
	182	ChildHandle in the language specified by\r
	183	Language from the point of view of the driver\r
	184	specified by This.\r
	185	\r
	186	@retval EFI_SUCCESS The Unicode string for the user readable name in\r
	187	the language specified by Language for the\r
	188	driver specified by This was returned in\r
	189	DriverName.\r
	190	\r
	191	@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
	192	\r
	193	@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
	194	EFI_HANDLE.\r
	195	\r
	196	@retval EFI_INVALID_PARAMETER Language is NULL.\r
	197	\r
	198	@retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
	199	\r
	200	@retval EFI_UNSUPPORTED The driver specified by This is not currently\r
	201	managing the controller specified by\r
	202	ControllerHandle and ChildHandle.\r
203	\r
204	@retval EFI_UNSUPPORTED The driver specified by This does not support\r
205	the language specified by Language.\r
206	\r
207	**/\r
97a079ed A	208	EFI_STATUS\r
	209	EFIAPI\r
	210	GraphicsConsoleComponentNameGetControllerName (\r
	211	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	212	IN EFI_HANDLE ControllerHandle,\r
	213	IN EFI_HANDLE ChildHandle OPTIONAL,\r
	214	IN CHAR8 *Language,\r
	215	OUT CHAR16 **ControllerName\r
	216	);\r
95276127	217	\r
5bca971e	218	\r
95276127	219	\r
24248368	220	\r
	221	/**\r
	222	Returns available Unicode glyphs narrow fonts(8*19 pixels) size.\r
	223	\r
878670ea	224	@return Narrow font size.\r
24248368	225	\r
24248368	226	**/\r
878670ea	227	UINT32\r
95276127	228	ReturnNarrowFontSize (\r
	229	VOID\r
	230	);\r
	231	\r
6dcf9abc	232	/**\r
7601dbe7	233	Reset the text output device hardware and optionally run diagnostics.\r
7601dbe7	234	\r
6dcf9abc	235	Implements SIMPLE_TEXT_OUTPUT.Reset().\r
	236	If ExtendeVerification is TRUE, then perform dependent Graphics Console\r
	237	device reset, and set display mode to mode 0.\r
	238	If ExtendedVerification is FALSE, only set display mode to mode 0.\r
	239	\r
7601dbe7	240	@param This Protocol instance pointer.\r
6dcf9abc	241	@param ExtendedVerification Indicates that the driver may perform a more\r
	242	exhaustive verification operation of the device\r
	243	during reset.\r
	244	\r
7601dbe7	245	@retval EFI_SUCCESS The text output device was reset.\r
	246	@retval EFI_DEVICE_ERROR The text output device is not functioning correctly and\r
	247	could not be reset.\r
95276127	248	\r
6dcf9abc	249	**/\r
95276127	250	EFI_STATUS\r
	251	EFIAPI\r
	252	GraphicsConsoleConOutReset (\r
	253	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
	254	IN BOOLEAN ExtendedVerification\r
	255	);\r
	256	\r
6dcf9abc	257	/**\r
24248368	258	Write a Unicode string to the output device.\r
	259	\r
	260	Implements SIMPLE_TEXT_OUTPUT.OutputString(). \r
6dcf9abc	261	The Unicode string will be converted to Glyphs and will be\r
	262	sent to the Graphics Console.\r
	263	\r
24248368	264	@param This Protocol instance pointer.\r
	265	@param WString The NULL-terminated Unicode string to be displayed\r
	266	on the output device(s). All output devices must\r
	267	also support the Unicode drawing defined in this file.\r
6dcf9abc	268	\r
24248368	269	@retval EFI_SUCCESS The string was output to the device.\r
	270	@retval EFI_DEVICE_ERROR The device reported an error while attempting to output\r
	271	the text.\r
	272	@retval EFI_UNSUPPORTED The output device's mode is not currently in a\r
	273	defined text mode.\r
	274	@retval EFI_WARN_UNKNOWN_GLYPH This warning code indicates that some of the\r
	275	characters in the Unicode string could not be\r
	276	rendered and were skipped.\r
6dcf9abc	277	\r
6dcf9abc	278	**/\r
95276127	279	EFI_STATUS\r
	280	EFIAPI\r
	281	GraphicsConsoleConOutOutputString (\r
	282	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
	283	IN CHAR16 *WString\r
	284	);\r
	285	\r
6dcf9abc	286	/**\r
	287	Implements SIMPLE_TEXT_OUTPUT.TestString().\r
	288	If one of the characters in the *Wstring is\r
	289	neither valid valid Unicode drawing characters,\r
	290	not ASCII code, then this function will return\r
	291	EFI_UNSUPPORTED.\r
	292	\r
	293	@param This Indicates the calling context.\r
	294	@param WString The Null-terminated Unicode string to be tested.\r
	295	\r
	296	@return EFI_SUCCESS\r
	297	@return The Graphics Console is capable of rendering the output string.\r
	298	@return EFI_UNSUPPORTED\r
	299	@return Some of the characters in the Unicode string cannot be rendered.\r
	300	\r
	301	**/\r
95276127	302	EFI_STATUS\r
	303	EFIAPI\r
	304	GraphicsConsoleConOutTestString (\r
	305	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
	306	IN CHAR16 *WString\r
	307	);\r
	308	\r
6dcf9abc	309	/**\r
24248368	310	Returns information for an available text mode that the output device(s)\r
	311	supports\r
	312	\r
6dcf9abc	313	Implements SIMPLE_TEXT_OUTPUT.QueryMode().\r
24248368	314	It returnes information for an available text mode that the Graphics Console supports.\r
24248368	315	In this driver,we only support text mode 80x25, which is defined as mode 0.\r
6dcf9abc	316	\r
24248368	317	@param This Protocol instance pointer.\r
6dcf9abc	318	@param ModeNumber The mode number to return information on.\r
	319	@param Columns The returned columns of the requested mode.\r
	320	@param Rows The returned rows of the requested mode.\r
	321	\r
24248368	322	@retval EFI_SUCCESS The requested mode information is returned.\r
24248368	323	@retval EFI_UNSUPPORTED The mode number is not valid.\r
6dcf9abc	324	\r
6dcf9abc	325	**/\r
95276127	326	EFI_STATUS\r
	327	EFIAPI\r
	328	GraphicsConsoleConOutQueryMode (\r
	329	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
	330	IN UINTN ModeNumber,\r
	331	OUT UINTN *Columns,\r
	332	OUT UINTN *Rows\r
	333	);\r
	334	\r
24248368	335	\r
6dcf9abc	336	/**\r
24248368	337	Sets the output device(s) to a specified mode.\r
24248368	338	\r
6dcf9abc	339	Implements SIMPLE_TEXT_OUTPUT.SetMode().\r
24248368	340	Set the Graphics Console to a specified mode. In this driver, we only support mode 0.\r
6dcf9abc	341	\r
24248368	342	@param This Protocol instance pointer.\r
6dcf9abc	343	@param ModeNumber The text mode to set.\r
6dcf9abc	344	\r
24248368	345	@retval EFI_SUCCESS The requested text mode is set.\r
	346	@retval EFI_DEVICE_ERROR The requested text mode cannot be set because of \r
	347	Graphics Console device error.\r
	348	@retval EFI_UNSUPPORTED The text mode number is not valid.\r
6dcf9abc	349	\r
6dcf9abc	350	**/\r
95276127	351	EFI_STATUS\r
	352	EFIAPI\r
	353	GraphicsConsoleConOutSetMode (\r
	354	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
	355	IN UINTN ModeNumber\r
	356	);\r
	357	\r
6dcf9abc	358	/**\r
	359	Implements SIMPLE_TEXT_OUTPUT.SetAttribute().\r
	360	\r
	361	@param This Indicates the calling context.\r
	362	@param Attribute The attribute to set. Only bit0..6 are valid, all\r
	363	other bits are undefined and must be zero.\r
	364	\r
	365	@return EFI_SUCCESS The requested attribute is set.\r
	366	@return EFI_DEVICE_ERROR The requested attribute cannot be set due to Graphics Console port error.\r
	367	@return EFI_UNSUPPORTED The attribute requested is not defined by EFI spec.\r
	368	\r
	369	**/\r
95276127	370	EFI_STATUS\r
	371	EFIAPI\r
	372	GraphicsConsoleConOutSetAttribute (\r
	373	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
	374	IN UINTN Attribute\r
	375	);\r
	376	\r
6dcf9abc	377	/**\r
24248368	378	Clears the output device(s) display to the currently selected background \r
	379	color.\r
	380	\r
6dcf9abc	381	Implements SIMPLE_TEXT_OUTPUT.ClearScreen().\r
6dcf9abc	382	\r
24248368	383	@param This Protocol instance pointer.\r
6dcf9abc	384	\r
24248368	385	@retval EFI_SUCCESS The operation completed successfully.\r
	386	@retval EFI_DEVICE_ERROR The device had an error and could not complete the request.\r
	387	@retval EFI_UNSUPPORTED The output device is not in a valid text mode.\r
6dcf9abc	388	\r
6dcf9abc	389	**/\r
95276127	390	EFI_STATUS\r
	391	EFIAPI\r
	392	GraphicsConsoleConOutClearScreen (\r
	393	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This\r
	394	);\r
	395	\r
6dcf9abc	396	/**\r
	397	Implements SIMPLE_TEXT_OUTPUT.SetCursorPosition().\r
	398	\r
	399	@param This Indicates the calling context.\r
	400	@param Column The row to set cursor to.\r
	401	@param Row The column to set cursor to.\r
	402	\r
	403	@return EFI_SUCCESS\r
	404	@return The operation completed successfully.\r
	405	@return EFI_DEVICE_ERROR\r
	406	@return The request fails due to Graphics Console device error.\r
	407	@return EFI_UNSUPPORTED\r
	408	@return The Graphics Console is not in a valid text mode, or the cursor position\r
	409	@return is invalid for current mode.\r
	410	\r
	411	**/\r
95276127	412	EFI_STATUS\r
	413	EFIAPI\r
	414	GraphicsConsoleConOutSetCursorPosition (\r
	415	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
	416	IN UINTN Column,\r
	417	IN UINTN Row\r
	418	);\r
	419	\r
24248368	420	\r
6dcf9abc	421	/**\r
24248368	422	Makes the cursor visible or invisible.\r
24248368	423	\r
6dcf9abc	424	Implements SIMPLE_TEXT_OUTPUT.EnableCursor().\r
6dcf9abc	425	\r
24248368	426	@param This Protocol instance pointer.\r
6dcf9abc	427	@param Visible If TRUE, the cursor is set to be visible, If FALSE,\r
	428	the cursor is set to be invisible.\r
	429	\r
24248368	430	@retval EFI_SUCCESS The operation completed successfully.\r
6dcf9abc	431	\r
6dcf9abc	432	**/\r
95276127	433	EFI_STATUS\r
	434	EFIAPI\r
	435	GraphicsConsoleConOutEnableCursor (\r
	436	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
	437	IN BOOLEAN Visible\r
	438	);\r
	439	\r
24248368	440	/**\r
8595bdaf	441	Test to see if Graphics Console could be supported on the Controller.\r
24248368	442	\r
24248368	443	Graphics Console could be supported if Graphics Output Protocol or UGA Draw\r
8595bdaf	444	Protocol exists on the Controller. (UGA Draw Protocol could be skipped\r
24248368	445	if PcdUgaConsumeSupport is set to FALSE.)\r
	446	\r
	447	@param This Protocol instance pointer.\r
8595bdaf	448	@param Controller Handle of device to test.\r
24248368	449	@param RemainingDevicePath Optional parameter use to pick a specific child\r
	450	device to start.\r
	451	\r
8595bdaf	452	@retval EFI_SUCCESS This driver supports this device.\r
8595bdaf	453	@retval other This driver does not support this device.\r
24248368	454	\r
24248368	455	**/\r
95276127	456	EFI_STATUS\r
	457	EFIAPI\r
	458	GraphicsConsoleControllerDriverSupported (\r
	459	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	460	IN EFI_HANDLE Controller,\r
	461	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
	462	);\r
	463	\r
8595bdaf	464	\r
24248368	465	/**\r
8595bdaf	466	Start this driver on Controller by opening Graphics Output protocol or \r
8595bdaf	467	UGA Draw protocol, and installing Simple Text Out protocol on Controller.\r
878670ea	468	(UGA Draw protocol could be skipped if PcdUgaConsumeSupport is set to FALSE.)\r
24248368	469	\r
24248368	470	@param This Protocol instance pointer.\r
8595bdaf	471	@param Controller Handle of device to bind driver to\r
24248368	472	@param RemainingDevicePath Optional parameter use to pick a specific child\r
	473	device to start.\r
	474	\r
8595bdaf	475	@retval EFI_SUCCESS This driver is added to Controller.\r
8595bdaf	476	@retval other This driver does not support this device.\r
24248368	477	\r
24248368	478	**/\r
95276127	479	EFI_STATUS\r
	480	EFIAPI\r
	481	GraphicsConsoleControllerDriverStart (\r
	482	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	483	IN EFI_HANDLE Controller,\r
	484	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
	485	);\r
	486	\r
24248368	487	/**\r
8595bdaf	488	Stop this driver on Controller by removing Simple Text Out protocol \r
8595bdaf	489	and closing the Graphics Output Protocol or UGA Draw protocol on Controller.\r
878670ea	490	(UGA Draw protocol could be skipped if PcdUgaConsumeSupport is set to FALSE.)\r
24248368	491	\r
	492	\r
	493	@param This Protocol instance pointer.\r
8595bdaf	494	@param Controller Handle of device to stop driver on\r
24248368	495	@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
	496	children is zero stop the entire bus driver.\r
	497	@param ChildHandleBuffer List of Child Handles to Stop.\r
	498	\r
8595bdaf	499	@retval EFI_SUCCESS This driver is removed Controller.\r
24248368	500	@retval EFI_NOT_STARTED Simple Text Out protocol could not be found the \r
8595bdaf	501	Controller.\r
24248368	502	@retval other This driver was not removed from this device.\r
	503	\r
	504	**/\r
95276127	505	EFI_STATUS\r
	506	EFIAPI\r
	507	GraphicsConsoleControllerDriverStop (\r
	508	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	509	IN EFI_HANDLE Controller,\r
	510	IN UINTN NumberOfChildren,\r
	511	IN EFI_HANDLE *ChildHandleBuffer\r
	512	);\r
	513	\r
6dcf9abc	514	\r
24248368	515	/**\r
	516	Locate HII Database protocol and HII Font protocol.\r
	517	\r
	518	@retval EFI_SUCCESS HII Database protocol and HII Font protocol \r
	519	are located successfully.\r
	520	@return other Failed to locate HII Database protocol or \r
	521	HII Font protocol.\r
	522	\r
	523	**/\r
93e3992d	524	EFI_STATUS\r
	525	EfiLocateHiiProtocol (\r
	526	VOID\r
ed66e1bc	527	);\r
93e3992d	528	\r
93e3992d	529	\r
95276127	530	#endif\r