[mirror_edk2.git] / MdePkg / Include / Protocol / SimpleTextOut.h

/** @file\r
  Simple Text Out protocol from the UEFI 2.0 specification.\r
\r
  Abstraction of a very simple text based output device like VGA text mode or\r
  a serial terminal. The Simple Text Out protocol instance can represent\r
  a single hardware device or a virtual device that is an agregation\r
  of multiple physical devices.\r
\r
  Copyright (c) 2006 - 2008, 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 __SIMPLE_TEXT_OUT_H__\r
#define __SIMPLE_TEXT_OUT_H__\r
\r
#include <PiDxe.h>\r
\r
#define EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID \\r
  { \\r
    0x387477c2, 0x69c7, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r
  }\r
\r
///\r
/// Protocol GUID defined in EFI1.1.\r
/// \r
#define SIMPLE_TEXT_OUTPUT_PROTOCOL   EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID\r
\r
typedef struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL;\r
\r
///\r
/// Backward-compatible with EFI1.1.\r
/// \r
typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL   SIMPLE_TEXT_OUTPUT_INTERFACE;\r
\r
//\r
// Define's for required EFI Unicode Box Draw characters\r
//\r
#define BOXDRAW_HORIZONTAL                  0x2500\r
#define BOXDRAW_VERTICAL                    0x2502\r
#define BOXDRAW_DOWN_RIGHT                  0x250c\r
#define BOXDRAW_DOWN_LEFT                   0x2510\r
#define BOXDRAW_UP_RIGHT                    0x2514\r
#define BOXDRAW_UP_LEFT                     0x2518\r
#define BOXDRAW_VERTICAL_RIGHT              0x251c\r
#define BOXDRAW_VERTICAL_LEFT               0x2524\r
#define BOXDRAW_DOWN_HORIZONTAL             0x252c\r
#define BOXDRAW_UP_HORIZONTAL               0x2534\r
#define BOXDRAW_VERTICAL_HORIZONTAL         0x253c\r
#define BOXDRAW_DOUBLE_HORIZONTAL           0x2550\r
#define BOXDRAW_DOUBLE_VERTICAL             0x2551\r
#define BOXDRAW_DOWN_RIGHT_DOUBLE           0x2552\r
#define BOXDRAW_DOWN_DOUBLE_RIGHT           0x2553\r
#define BOXDRAW_DOUBLE_DOWN_RIGHT           0x2554\r
#define BOXDRAW_DOWN_LEFT_DOUBLE            0x2555\r
#define BOXDRAW_DOWN_DOUBLE_LEFT            0x2556\r
#define BOXDRAW_DOUBLE_DOWN_LEFT            0x2557\r
#define BOXDRAW_UP_RIGHT_DOUBLE             0x2558\r
#define BOXDRAW_UP_DOUBLE_RIGHT             0x2559\r
#define BOXDRAW_DOUBLE_UP_RIGHT             0x255a\r
#define BOXDRAW_UP_LEFT_DOUBLE              0x255b\r
#define BOXDRAW_UP_DOUBLE_LEFT              0x255c\r
#define BOXDRAW_DOUBLE_UP_LEFT              0x255d\r
#define BOXDRAW_VERTICAL_RIGHT_DOUBLE       0x255e\r
#define BOXDRAW_VERTICAL_DOUBLE_RIGHT       0x255f\r
#define BOXDRAW_DOUBLE_VERTICAL_RIGHT       0x2560\r
#define BOXDRAW_VERTICAL_LEFT_DOUBLE        0x2561\r
#define BOXDRAW_VERTICAL_DOUBLE_LEFT        0x2562\r
#define BOXDRAW_DOUBLE_VERTICAL_LEFT        0x2563\r
#define BOXDRAW_DOWN_HORIZONTAL_DOUBLE      0x2564\r
#define BOXDRAW_DOWN_DOUBLE_HORIZONTAL      0x2565\r
#define BOXDRAW_DOUBLE_DOWN_HORIZONTAL      0x2566\r
#define BOXDRAW_UP_HORIZONTAL_DOUBLE        0x2567\r
#define BOXDRAW_UP_DOUBLE_HORIZONTAL        0x2568\r
#define BOXDRAW_DOUBLE_UP_HORIZONTAL        0x2569\r
#define BOXDRAW_VERTICAL_HORIZONTAL_DOUBLE  0x256a\r
#define BOXDRAW_VERTICAL_DOUBLE_HORIZONTAL  0x256b\r
#define BOXDRAW_DOUBLE_VERTICAL_HORIZONTAL  0x256c\r
\r
//\r
// EFI Required Block Elements Code Chart\r
//\r
#define BLOCKELEMENT_FULL_BLOCK   0x2588\r
#define BLOCKELEMENT_LIGHT_SHADE  0x2591\r
\r
//\r
// EFI Required Geometric Shapes Code Chart\r
//\r
#define GEOMETRICSHAPE_UP_TRIANGLE    0x25b2\r
#define GEOMETRICSHAPE_RIGHT_TRIANGLE 0x25ba\r
#define GEOMETRICSHAPE_DOWN_TRIANGLE  0x25bc\r
#define GEOMETRICSHAPE_LEFT_TRIANGLE  0x25c4\r
\r
//\r
// EFI Required Arrow shapes\r
//\r
#define ARROW_LEFT  0x2190\r
#define ARROW_UP    0x2191\r
#define ARROW_RIGHT 0x2192\r
#define ARROW_DOWN  0x2193\r
\r
//\r
// EFI Console Colours\r
//\r
#define EFI_BLACK                 0x00\r
#define EFI_BLUE                  0x01\r
#define EFI_GREEN                 0x02\r
#define EFI_CYAN                  (EFI_BLUE | EFI_GREEN)\r
#define EFI_RED                   0x04\r
#define EFI_MAGENTA               (EFI_BLUE | EFI_RED)\r
#define EFI_BROWN                 (EFI_GREEN | EFI_RED)\r
#define EFI_LIGHTGRAY             (EFI_BLUE | EFI_GREEN | EFI_RED)\r
#define EFI_BRIGHT                0x08\r
#define EFI_DARKGRAY              (EFI_BRIGHT)\r
#define EFI_LIGHTBLUE             (EFI_BLUE | EFI_BRIGHT)\r
#define EFI_LIGHTGREEN            (EFI_GREEN | EFI_BRIGHT)\r
#define EFI_LIGHTCYAN             (EFI_CYAN | EFI_BRIGHT)\r
#define EFI_LIGHTRED              (EFI_RED | EFI_BRIGHT)\r
#define EFI_LIGHTMAGENTA          (EFI_MAGENTA | EFI_BRIGHT)\r
#define EFI_YELLOW                (EFI_BROWN | EFI_BRIGHT)\r
#define EFI_WHITE                 (EFI_BLUE | EFI_GREEN | EFI_RED | EFI_BRIGHT)\r
\r
#define EFI_TEXT_ATTR(f, b)       ((f) | ((b) << 4))\r
\r
#define EFI_BACKGROUND_BLACK      0x00\r
#define EFI_BACKGROUND_BLUE       0x10\r
#define EFI_BACKGROUND_GREEN      0x20\r
#define EFI_BACKGROUND_CYAN       (EFI_BACKGROUND_BLUE | EFI_BACKGROUND_GREEN)\r
#define EFI_BACKGROUND_RED        0x40\r
#define EFI_BACKGROUND_MAGENTA    (EFI_BACKGROUND_BLUE | EFI_BACKGROUND_RED)\r
#define EFI_BACKGROUND_BROWN      (EFI_BACKGROUND_GREEN | EFI_BACKGROUND_RED)\r
#define EFI_BACKGROUND_LIGHTGRAY  (EFI_BACKGROUND_BLUE | EFI_BACKGROUND_GREEN | EFI_BACKGROUND_RED)\r
\r
//\r
// We currently define attributes from 0 - 7F for color manipulations\r
// To internally handle the local display characteristics for a particular character, we are defining\r
// Bit 7 to signify the local glyph representation for a character.  If turned on, glyphs will be\r
// pulled from the wide glyph database and will display locally as a wide character (16 X 19 versus 8 X 19)\r
// If bit 7 is off, the narrow glyph database will be used.  This does NOT affect information that is sent to\r
// non-local displays (e.g. serial or LAN consoles).\r
//\r
#define EFI_WIDE_ATTRIBUTE  0x80\r
\r
/**\r
  Reset the text output device hardware and optionaly run diagnostics\r
\r
  @param  This                 Protocol instance pointer.\r
  @param  ExtendedVerification Driver may perform more exhaustive verfication\r
                               operation of the device 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
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_TEXT_RESET)(\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
  @param  This   Protocol instance pointer.\r
  @param  String The NULL-terminated Unicode string to be displayed on the output\r
                 device(s). All output devices must also support the Unicode\r
                 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
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_TEXT_STRING)(\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL        *This,\r
  IN CHAR16                                 *String\r
  );\r
\r
/**\r
  Verifies that all characters in a Unicode string can be output to the \r
  target device.\r
\r
  @param  This   Protocol instance pointer.\r
  @param  String The NULL-terminated Unicode string to be examined for the output\r
                 device(s).\r
\r
  @retval EFI_SUCCESS      The device(s) are capable of rendering the output string.\r
  @retval EFI_UNSUPPORTED  Some of the characters in the Unicode string cannot be\r
                           rendered by one or more of the output devices mapped\r
                           by the EFI handle.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_TEXT_TEST_STRING)(\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL        *This,\r
  IN CHAR16                                 *String\r
  );\r
\r
/**\r
  Returns information for an available text mode that the output device(s)\r
  supports.\r
\r
  @param  This       Protocol instance pointer.\r
  @param  ModeNumber The mode number to return information on.\r
  @param  Columns    Returns the geometry of the text output device for the\r
                     requested ModeNumber.\r
  @param  Rows       Returns the geometry of the text output device for the\r
                     requested ModeNumber.\r
                                          \r
  @retval EFI_SUCCESS      The requested mode information was returned.\r
  @retval EFI_DEVICE_ERROR The device had an error and could not complete the request.\r
  @retval EFI_UNSUPPORTED  The mode number was not valid.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_TEXT_QUERY_MODE)(\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL        *This,\r
  IN UINTN                                  ModeNumber,\r
  OUT UINTN                                 *Columns,\r
  OUT UINTN                                 *Rows\r
  );\r
\r
/**\r
  Sets the output device(s) to a specified mode.\r
\r
  @param  This       Protocol instance pointer.\r
  @param  ModeNumber The mode number to set.\r
\r
  @retval EFI_SUCCESS      The requested text mode was set.\r
  @retval EFI_DEVICE_ERROR The device had an error and could not complete the request.\r
  @retval EFI_UNSUPPORTED  The mode number was not valid.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_TEXT_SET_MODE)(\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL        *This,\r
  IN UINTN                                  ModeNumber\r
  );\r
\r
/**\r
  Sets the background and foreground colors for the OutputString () and\r
  ClearScreen () functions.\r
\r
  @param  This      Protocol instance pointer.\r
  @param  Attribute The attribute to set. Bits 0..3 are the foreground color, and\r
                    bits 4..6 are the background color. All other bits are undefined\r
                    and must be zero. The valid Attributes are defined in this file.\r
\r
  @retval EFI_SUCCESS     The attribute was set.\r
  @retval EFI_DEVICE_     ERROR The device had an error and could not complete the request.\r
  @retval EFI_UNSUPPORTED The attribute requested is not defined.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_TEXT_SET_ATTRIBUTE)(\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
  @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
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_TEXT_CLEAR_SCREEN)(\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL   *This\r
  );\r
\r
/**\r
  Sets the current coordinates of the cursor position\r
\r
  @param  This        Protocol instance pointer.\r
  @param  Column      The position to set the cursor to. Must be greater than or\r
                      equal to zero and less than the number of columns and rows\r
                      by QueryMode ().\r
  @param  Row         The position to set the cursor to. Must be greater than or\r
                      equal to zero and less than the number of columns and rows\r
                      by QueryMode ().\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, or the\r
                           cursor position is invalid for the current mode.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_TEXT_SET_CURSOR_POSITION)(\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL        *This,\r
  IN UINTN                                  Column,\r
  IN UINTN                                  Row\r
  );\r
\r
/**\r
  Makes the cursor visible or invisible\r
\r
  @param  This    Protocol instance pointer.\r
  @param  Visible If TRUE, the cursor is set to be visible. If FALSE, the cursor is\r
                  set to be invisible.\r
\r
  @retval EFI_SUCCESS      The operation completed successfully.\r
  @retval EFI_DEVICE_ERROR The device had an error and could not complete the\r
                           request, or the device does not support changing\r
                           the cursor mode.\r
  @retval EFI_UNSUPPORTED  The output device is not in a valid text mode.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_TEXT_ENABLE_CURSOR)(\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL        *This,\r
  IN BOOLEAN                                Visible\r
  );\r
\r
/**\r
  @par Data Structure Description:\r
  Mode Structure pointed to by Simple Text Out protocol.\r
\r
  @param MaxMode\r
  The number of modes supported by QueryMode () and SetMode ().\r
  \r
  @param Mode\r
  The text mode of the output device(s).\r
  \r
  @param Attribute\r
  The current character output attribute\r
  \r
  @param CursorColumn\r
  The cursor's column.\r
  \r
  @param CursorRow\r
  The cursor's row.\r
  \r
  @param CursorVisible\r
  The cursor is currently visbile or not.\r
\r
**/\r
typedef struct {\r
  INT32   MaxMode;\r
\r
  //\r
  // current settings\r
  //\r
  INT32   Mode;\r
  INT32   Attribute;\r
  INT32   CursorColumn;\r
  INT32   CursorRow;\r
  BOOLEAN CursorVisible;\r
} EFI_SIMPLE_TEXT_OUTPUT_MODE;\r
\r
/**  \r
  @par Protocol Description:\r
  The SIMPLE_TEXT_OUTPUT protocol is used to control text-based output devices. \r
  It is the minimum required protocol for any handle supplied as the ConsoleOut \r
  or StandardError device. In addition, the minimum supported text mode of such \r
  devices is at least 80 x 25 characters.\r
\r
  @param Reset\r
  Reset the ConsoleOut device. \r
\r
  @param OutputString\r
  Displays the Unicode string on the device at the current cursor location. \r
\r
  @param TestString\r
  Tests to see if the ConsoleOut device supports this Unicode string.\r
\r
  @param QueryMode\r
  Queries information concerning the output device's supported text mode. \r
\r
  @param SetMode\r
  Sets the current mode of the output device. \r
\r
  @param SetAttribute\r
  Sets the foreground and background color of the text that is output. \r
\r
  @param ClearScreen\r
  Clears the screen with the currently set background color. \r
\r
  @param SetCursorPosition\r
  Sets the current cursor position. \r
\r
  @param EnableCursor\r
  Turns the visibility of the cursor on/off. \r
\r
  @param Mode\r
  Pointer to SIMPLE_TEXT_OUTPUT_MODE data. \r
**/\r
struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL {\r
  EFI_TEXT_RESET                Reset;\r
\r
  EFI_TEXT_STRING               OutputString;\r
  EFI_TEXT_TEST_STRING          TestString;\r
\r
  EFI_TEXT_QUERY_MODE           QueryMode;\r
  EFI_TEXT_SET_MODE             SetMode;\r
  EFI_TEXT_SET_ATTRIBUTE        SetAttribute;\r
\r
  EFI_TEXT_CLEAR_SCREEN         ClearScreen;\r
  EFI_TEXT_SET_CURSOR_POSITION  SetCursorPosition;\r
  EFI_TEXT_ENABLE_CURSOR        EnableCursor;\r
\r
  //\r
  // Current mode\r
  //\r
  EFI_SIMPLE_TEXT_OUTPUT_MODE   *Mode;\r
};\r
\r
extern EFI_GUID gEfiSimpleTextOutProtocolGuid;\r
\r
#endif\r
Commit	Line	Data
d1f95000	1	/** @file\r
8a7d75b0	2	Simple Text Out protocol from the UEFI 2.0 specification.\r
d1f95000	3	\r
	4	Abstraction of a very simple text based output device like VGA text mode or\r
	5	a serial terminal. The Simple Text Out protocol instance can represent\r
	6	a single hardware device or a virtual device that is an agregation\r
	7	of multiple physical devices.\r
	8	\r
4ca9b6c4	9	Copyright (c) 2006 - 2008, Intel Corporation \r
d1f95000	10	All rights reserved. This program and the accompanying materials \r
	11	are licensed and made available under the terms and conditions of the BSD License \r
	12	which accompanies this distribution. The full text of the license may be found at \r
	13	http://opensource.org/licenses/bsd-license.php \r
	14	\r
	15	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	16	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	17	\r
d1f95000	18	**/\r
	19	\r
	20	#ifndef __SIMPLE_TEXT_OUT_H__\r
	21	#define __SIMPLE_TEXT_OUT_H__\r
	22	\r
3f748e52	23	#include <PiDxe.h>\r
3f748e52	24	\r
a6508c05	25	#define EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID \\r
d1f95000	26	{ \\r
	27	0x387477c2, 0x69c7, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r
	28	}\r
	29	\r
99e8ed21	30	///\r
	31	/// Protocol GUID defined in EFI1.1.\r
	32	/// \r
a6508c05	33	#define SIMPLE_TEXT_OUTPUT_PROTOCOL EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID\r
	34	\r
	35	typedef struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL;\r
d1f95000	36	\r
99e8ed21	37	///\r
	38	/// Backward-compatible with EFI1.1.\r
	39	/// \r
a6508c05	40	typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL SIMPLE_TEXT_OUTPUT_INTERFACE;\r
d1f95000	41	\r
	42	//\r
	43	// Define's for required EFI Unicode Box Draw characters\r
	44	//\r
	45	#define BOXDRAW_HORIZONTAL 0x2500\r
	46	#define BOXDRAW_VERTICAL 0x2502\r
	47	#define BOXDRAW_DOWN_RIGHT 0x250c\r
	48	#define BOXDRAW_DOWN_LEFT 0x2510\r
	49	#define BOXDRAW_UP_RIGHT 0x2514\r
	50	#define BOXDRAW_UP_LEFT 0x2518\r
	51	#define BOXDRAW_VERTICAL_RIGHT 0x251c\r
	52	#define BOXDRAW_VERTICAL_LEFT 0x2524\r
	53	#define BOXDRAW_DOWN_HORIZONTAL 0x252c\r
	54	#define BOXDRAW_UP_HORIZONTAL 0x2534\r
	55	#define BOXDRAW_VERTICAL_HORIZONTAL 0x253c\r
	56	#define BOXDRAW_DOUBLE_HORIZONTAL 0x2550\r
	57	#define BOXDRAW_DOUBLE_VERTICAL 0x2551\r
	58	#define BOXDRAW_DOWN_RIGHT_DOUBLE 0x2552\r
	59	#define BOXDRAW_DOWN_DOUBLE_RIGHT 0x2553\r
	60	#define BOXDRAW_DOUBLE_DOWN_RIGHT 0x2554\r
	61	#define BOXDRAW_DOWN_LEFT_DOUBLE 0x2555\r
	62	#define BOXDRAW_DOWN_DOUBLE_LEFT 0x2556\r
	63	#define BOXDRAW_DOUBLE_DOWN_LEFT 0x2557\r
	64	#define BOXDRAW_UP_RIGHT_DOUBLE 0x2558\r
	65	#define BOXDRAW_UP_DOUBLE_RIGHT 0x2559\r
	66	#define BOXDRAW_DOUBLE_UP_RIGHT 0x255a\r
	67	#define BOXDRAW_UP_LEFT_DOUBLE 0x255b\r
	68	#define BOXDRAW_UP_DOUBLE_LEFT 0x255c\r
	69	#define BOXDRAW_DOUBLE_UP_LEFT 0x255d\r
	70	#define BOXDRAW_VERTICAL_RIGHT_DOUBLE 0x255e\r
	71	#define BOXDRAW_VERTICAL_DOUBLE_RIGHT 0x255f\r
	72	#define BOXDRAW_DOUBLE_VERTICAL_RIGHT 0x2560\r
	73	#define BOXDRAW_VERTICAL_LEFT_DOUBLE 0x2561\r
	74	#define BOXDRAW_VERTICAL_DOUBLE_LEFT 0x2562\r
	75	#define BOXDRAW_DOUBLE_VERTICAL_LEFT 0x2563\r
	76	#define BOXDRAW_DOWN_HORIZONTAL_DOUBLE 0x2564\r
	77	#define BOXDRAW_DOWN_DOUBLE_HORIZONTAL 0x2565\r
	78	#define BOXDRAW_DOUBLE_DOWN_HORIZONTAL 0x2566\r
	79	#define BOXDRAW_UP_HORIZONTAL_DOUBLE 0x2567\r
	80	#define BOXDRAW_UP_DOUBLE_HORIZONTAL 0x2568\r
	81	#define BOXDRAW_DOUBLE_UP_HORIZONTAL 0x2569\r
	82	#define BOXDRAW_VERTICAL_HORIZONTAL_DOUBLE 0x256a\r
	83	#define BOXDRAW_VERTICAL_DOUBLE_HORIZONTAL 0x256b\r
	84	#define BOXDRAW_DOUBLE_VERTICAL_HORIZONTAL 0x256c\r
	85	\r
	86	//\r
	87	// EFI Required Block Elements Code Chart\r
	88	//\r
	89	#define BLOCKELEMENT_FULL_BLOCK 0x2588\r
	90	#define BLOCKELEMENT_LIGHT_SHADE 0x2591\r
	91	\r
	92	//\r
	93	// EFI Required Geometric Shapes Code Chart\r
	94	//\r
	95	#define GEOMETRICSHAPE_UP_TRIANGLE 0x25b2\r
	96	#define GEOMETRICSHAPE_RIGHT_TRIANGLE 0x25ba\r
	97	#define GEOMETRICSHAPE_DOWN_TRIANGLE 0x25bc\r
	98	#define GEOMETRICSHAPE_LEFT_TRIANGLE 0x25c4\r
	99	\r
	100	//\r
	101	// EFI Required Arrow shapes\r
	102	//\r
	103	#define ARROW_LEFT 0x2190\r
	104	#define ARROW_UP 0x2191\r
105	#define ARROW_RIGHT 0x2192\r
106	#define ARROW_DOWN 0x2193\r
107	\r
108	//\r
109	// EFI Console Colours\r
110	//\r
111	#define EFI_BLACK 0x00\r
112	#define EFI_BLUE 0x01\r
113	#define EFI_GREEN 0x02\r
114	#define EFI_CYAN (EFI_BLUE \| EFI_GREEN)\r
115	#define EFI_RED 0x04\r
116	#define EFI_MAGENTA (EFI_BLUE \| EFI_RED)\r
117	#define EFI_BROWN (EFI_GREEN \| EFI_RED)\r
118	#define EFI_LIGHTGRAY (EFI_BLUE \| EFI_GREEN \| EFI_RED)\r
119	#define EFI_BRIGHT 0x08\r
120	#define EFI_DARKGRAY (EFI_BRIGHT)\r
121	#define EFI_LIGHTBLUE (EFI_BLUE \| EFI_BRIGHT)\r
122	#define EFI_LIGHTGREEN (EFI_GREEN \| EFI_BRIGHT)\r
123	#define EFI_LIGHTCYAN (EFI_CYAN \| EFI_BRIGHT)\r
124	#define EFI_LIGHTRED (EFI_RED \| EFI_BRIGHT)\r
125	#define EFI_LIGHTMAGENTA (EFI_MAGENTA \| EFI_BRIGHT)\r
126	#define EFI_YELLOW (EFI_BROWN \| EFI_BRIGHT)\r
127	#define EFI_WHITE (EFI_BLUE \| EFI_GREEN \| EFI_RED \| EFI_BRIGHT)\r
128	\r
129	#define EFI_TEXT_ATTR(f, b) ((f) \| ((b) << 4))\r
130	\r
131	#define EFI_BACKGROUND_BLACK 0x00\r
132	#define EFI_BACKGROUND_BLUE 0x10\r
133	#define EFI_BACKGROUND_GREEN 0x20\r
134	#define EFI_BACKGROUND_CYAN (EFI_BACKGROUND_BLUE \| EFI_BACKGROUND_GREEN)\r
135	#define EFI_BACKGROUND_RED 0x40\r
136	#define EFI_BACKGROUND_MAGENTA (EFI_BACKGROUND_BLUE \| EFI_BACKGROUND_RED)\r
137	#define EFI_BACKGROUND_BROWN (EFI_BACKGROUND_GREEN \| EFI_BACKGROUND_RED)\r
138	#define EFI_BACKGROUND_LIGHTGRAY (EFI_BACKGROUND_BLUE \| EFI_BACKGROUND_GREEN \| EFI_BACKGROUND_RED)\r
139	\r
140	//\r
141	// We currently define attributes from 0 - 7F for color manipulations\r
142	// To internally handle the local display characteristics for a particular character, we are defining\r
143	// Bit 7 to signify the local glyph representation for a character. If turned on, glyphs will be\r
144	// pulled from the wide glyph database and will display locally as a wide character (16 X 19 versus 8 X 19)\r
145	// If bit 7 is off, the narrow glyph database will be used. This does NOT affect information that is sent to\r
146	// non-local displays (e.g. serial or LAN consoles).\r
147	//\r
148	#define EFI_WIDE_ATTRIBUTE 0x80\r
149	\r
150	/**\r
151	Reset the text output device hardware and optionaly run diagnostics\r
152	\r
153	@param This Protocol instance pointer.\r
154	@param ExtendedVerification Driver may perform more exhaustive verfication\r
155	operation of the device during reset.\r
156	\r
157	@retval EFI_SUCCESS The text output device was reset.\r
158	@retval EFI_DEVICE_ERROR The text output device is not functioning correctly and\r
159	could not be reset.\r
160	\r
161	**/\r
162	typedef\r
163	EFI_STATUS\r
8b13229b	164	(EFIAPI *EFI_TEXT_RESET)(\r
4ca9b6c4	165	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
d1f95000	166	IN BOOLEAN ExtendedVerification\r
ed66e1bc	167	);\r
d1f95000	168	\r
	169	/**\r
	170	Write a Unicode string to the output device.\r
	171	\r
	172	@param This Protocol instance pointer.\r
	173	@param String The NULL-terminated Unicode string to be displayed on the output\r
	174	device(s). All output devices must also support the Unicode\r
	175	drawing defined in this file.\r
	176	\r
	177	@retval EFI_SUCCESS The string was output to the device.\r
	178	@retval EFI_DEVICE_ERROR The device reported an error while attempting to output\r
	179	the text.\r
	180	@retval EFI_UNSUPPORTED The output device's mode is not currently in a\r
	181	defined text mode.\r
	182	@retval EFI_WARN_UNKNOWN_GLYPH This warning code indicates that some of the\r
	183	characters in the Unicode string could not be\r
	184	rendered and were skipped.\r
	185	\r
	186	**/\r
	187	typedef\r
	188	EFI_STATUS\r
8b13229b	189	(EFIAPI *EFI_TEXT_STRING)(\r
a6508c05	190	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
d1f95000	191	IN CHAR16 *String\r
ed66e1bc	192	);\r
d1f95000	193	\r
	194	/**\r
	195	Verifies that all characters in a Unicode string can be output to the \r
	196	target device.\r
	197	\r
	198	@param This Protocol instance pointer.\r
	199	@param String The NULL-terminated Unicode string to be examined for the output\r
	200	device(s).\r
	201	\r
	202	@retval EFI_SUCCESS The device(s) are capable of rendering the output string.\r
	203	@retval EFI_UNSUPPORTED Some of the characters in the Unicode string cannot be\r
	204	rendered by one or more of the output devices mapped\r
	205	by the EFI handle.\r
	206	\r
	207	**/\r
	208	typedef\r
	209	EFI_STATUS\r
8b13229b	210	(EFIAPI *EFI_TEXT_TEST_STRING)(\r
a6508c05	211	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
d1f95000	212	IN CHAR16 *String\r
ed66e1bc	213	);\r
d1f95000	214	\r
	215	/**\r
	216	Returns information for an available text mode that the output device(s)\r
	217	supports.\r
	218	\r
	219	@param This Protocol instance pointer.\r
	220	@param ModeNumber The mode number to return information on.\r
	221	@param Columns Returns the geometry of the text output device for the\r
	222	requested ModeNumber.\r
	223	@param Rows Returns the geometry of the text output device for the\r
	224	requested ModeNumber.\r
	225	\r
	226	@retval EFI_SUCCESS The requested mode information was returned.\r
	227	@retval EFI_DEVICE_ERROR The device had an error and could not complete the request.\r
	228	@retval EFI_UNSUPPORTED The mode number was not valid.\r
	229	\r
	230	**/\r
	231	typedef\r
	232	EFI_STATUS\r
8b13229b	233	(EFIAPI *EFI_TEXT_QUERY_MODE)(\r
a6508c05	234	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
d1f95000	235	IN UINTN ModeNumber,\r
	236	OUT UINTN *Columns,\r
	237	OUT UINTN *Rows\r
ed66e1bc	238	);\r
d1f95000	239	\r
	240	/**\r
	241	Sets the output device(s) to a specified mode.\r
	242	\r
	243	@param This Protocol instance pointer.\r
	244	@param ModeNumber The mode number to set.\r
	245	\r
	246	@retval EFI_SUCCESS The requested text mode was set.\r
	247	@retval EFI_DEVICE_ERROR The device had an error and could not complete the request.\r
	248	@retval EFI_UNSUPPORTED The mode number was not valid.\r
	249	\r
	250	**/\r
	251	typedef\r
	252	EFI_STATUS\r
8b13229b	253	(EFIAPI *EFI_TEXT_SET_MODE)(\r
a6508c05	254	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
d1f95000	255	IN UINTN ModeNumber\r
ed66e1bc	256	);\r
d1f95000	257	\r
	258	/**\r
	259	Sets the background and foreground colors for the OutputString () and\r
	260	ClearScreen () functions.\r
	261	\r
	262	@param This Protocol instance pointer.\r
	263	@param Attribute The attribute to set. Bits 0..3 are the foreground color, and\r
	264	bits 4..6 are the background color. All other bits are undefined\r
	265	and must be zero. The valid Attributes are defined in this file.\r
	266	\r
	267	@retval EFI_SUCCESS The attribute was set.\r
	268	@retval EFI_DEVICE_ ERROR The device had an error and could not complete the request.\r
	269	@retval EFI_UNSUPPORTED The attribute requested is not defined.\r
	270	\r
	271	**/\r
	272	typedef\r
	273	EFI_STATUS\r
8b13229b	274	(EFIAPI *EFI_TEXT_SET_ATTRIBUTE)(\r
a6508c05	275	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
d1f95000	276	IN UINTN Attribute\r
ed66e1bc	277	);\r
d1f95000	278	\r
	279	/**\r
	280	Clears the output device(s) display to the currently selected background \r
	281	color.\r
	282	\r
	283	@param This Protocol instance pointer.\r
	284	\r
	285	@retval EFI_SUCCESS The operation completed successfully.\r
	286	@retval EFI_DEVICE_ERROR The device had an error and could not complete the request.\r
	287	@retval EFI_UNSUPPORTED The output device is not in a valid text mode.\r
	288	\r
	289	**/\r
	290	typedef\r
	291	EFI_STATUS\r
8b13229b	292	(EFIAPI *EFI_TEXT_CLEAR_SCREEN)(\r
a6508c05	293	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This\r
ed66e1bc	294	);\r
d1f95000	295	\r
	296	/**\r
	297	Sets the current coordinates of the cursor position\r
	298	\r
	299	@param This Protocol instance pointer.\r
	300	@param Column The position to set the cursor to. Must be greater than or\r
	301	equal to zero and less than the number of columns and rows\r
	302	by QueryMode ().\r
	303	@param Row The position to set the cursor to. Must be greater than or\r
	304	equal to zero and less than the number of columns and rows\r
	305	by QueryMode ().\r
	306	\r
	307	@retval EFI_SUCCESS The operation completed successfully.\r
	308	@retval EFI_DEVICE_ERROR The device had an error and could not complete the request.\r
	309	@retval EFI_UNSUPPORTED The output device is not in a valid text mode, or the\r
	310	cursor position is invalid for the current mode.\r
	311	\r
	312	**/\r
	313	typedef\r
	314	EFI_STATUS\r
8b13229b	315	(EFIAPI *EFI_TEXT_SET_CURSOR_POSITION)(\r
a6508c05	316	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
d1f95000	317	IN UINTN Column,\r
d1f95000	318	IN UINTN Row\r
ed66e1bc	319	);\r
d1f95000	320	\r
	321	/**\r
	322	Makes the cursor visible or invisible\r
	323	\r
	324	@param This Protocol instance pointer.\r
	325	@param Visible If TRUE, the cursor is set to be visible. If FALSE, the cursor is\r
	326	set to be invisible.\r
	327	\r
	328	@retval EFI_SUCCESS The operation completed successfully.\r
	329	@retval EFI_DEVICE_ERROR The device had an error and could not complete the\r
	330	request, or the device does not support changing\r
	331	the cursor mode.\r
	332	@retval EFI_UNSUPPORTED The output device is not in a valid text mode.\r
	333	\r
	334	**/\r
	335	typedef\r
	336	EFI_STATUS\r
8b13229b	337	(EFIAPI *EFI_TEXT_ENABLE_CURSOR)(\r
a6508c05	338	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
d1f95000	339	IN BOOLEAN Visible\r
ed66e1bc	340	);\r
d1f95000	341	\r
d1f95000	342	/**\r
4ca9b6c4	343	@par Data Structure Description:\r
d1f95000	344	Mode Structure pointed to by Simple Text Out protocol.\r
d1f95000	345	\r
4ca9b6c4 LG	346	@param MaxMode\r
	347	The number of modes supported by QueryMode () and SetMode ().\r
	348	\r
	349	@param Mode\r
	350	The text mode of the output device(s).\r
	351	\r
	352	@param Attribute\r
	353	The current character output attribute\r
	354	\r
	355	@param CursorColumn\r
	356	The cursor's column.\r
	357	\r
	358	@param CursorRow\r
	359	The cursor's row.\r
	360	\r
	361	@param CursorVisible\r
	362	The cursor is currently visbile or not.\r
d1f95000	363	\r
	364	**/\r
	365	typedef struct {\r
	366	INT32 MaxMode;\r
	367	\r
	368	//\r
	369	// current settings\r
	370	//\r
	371	INT32 Mode;\r
	372	INT32 Attribute;\r
	373	INT32 CursorColumn;\r
	374	INT32 CursorRow;\r
	375	BOOLEAN CursorVisible;\r
	376	} EFI_SIMPLE_TEXT_OUTPUT_MODE;\r
	377	\r
4ca9b6c4 LG	378	/** \r
	379	@par Protocol Description:\r
	380	The SIMPLE_TEXT_OUTPUT protocol is used to control text-based output devices. \r
	381	It is the minimum required protocol for any handle supplied as the ConsoleOut \r
	382	or StandardError device. In addition, the minimum supported text mode of such \r
	383	devices is at least 80 x 25 characters.\r
	384	\r
	385	@param Reset\r
	386	Reset the ConsoleOut device. \r
	387	\r
	388	@param OutputString\r
	389	Displays the Unicode string on the device at the current cursor location. \r
	390	\r
	391	@param TestString\r
	392	Tests to see if the ConsoleOut device supports this Unicode string.\r
	393	\r
	394	@param QueryMode\r
	395	Queries information concerning the output device's supported text mode. \r
	396	\r
	397	@param SetMode\r
	398	Sets the current mode of the output device. \r
	399	\r
	400	@param SetAttribute\r
	401	Sets the foreground and background color of the text that is output. \r
	402	\r
	403	@param ClearScreen\r
	404	Clears the screen with the currently set background color. \r
	405	\r
	406	@param SetCursorPosition\r
	407	Sets the current cursor position. \r
	408	\r
	409	@param EnableCursor\r
	410	Turns the visibility of the cursor on/off. \r
	411	\r
	412	@param Mode\r
	413	Pointer to SIMPLE_TEXT_OUTPUT_MODE data. \r
	414	**/\r
a6508c05	415	struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL {\r
d1f95000	416	EFI_TEXT_RESET Reset;\r
	417	\r
	418	EFI_TEXT_STRING OutputString;\r
	419	EFI_TEXT_TEST_STRING TestString;\r
	420	\r
	421	EFI_TEXT_QUERY_MODE QueryMode;\r
	422	EFI_TEXT_SET_MODE SetMode;\r
	423	EFI_TEXT_SET_ATTRIBUTE SetAttribute;\r
	424	\r
	425	EFI_TEXT_CLEAR_SCREEN ClearScreen;\r
	426	EFI_TEXT_SET_CURSOR_POSITION SetCursorPosition;\r
	427	EFI_TEXT_ENABLE_CURSOR EnableCursor;\r
	428	\r
	429	//\r
	430	// Current mode\r
	431	//\r
	432	EFI_SIMPLE_TEXT_OUTPUT_MODE *Mode;\r
	433	};\r
	434	\r
09f0ddd0	435	extern EFI_GUID gEfiSimpleTextOutProtocolGuid;\r
d1f95000	436	\r
d1f95000	437	#endif\r