SimpleTextOut.h File Reference

Simple Text Out protocol from the UEFI 2.0 specification. More...

Go to the source code of this file.

Data Structures
struct	EFI_SIMPLE_TEXT_OUTPUT_MODE
struct	_EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
	The SIMPLE_TEXT_OUTPUT protocol is used to control text-based output devices. More...

Macros
#define	EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID
#define	SIMPLE_TEXT_OUTPUT_PROTOCOL   EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID
	Protocol GUID defined in EFI1.1. More...
#define	BOXDRAW_HORIZONTAL   0x2500
#define	BOXDRAW_VERTICAL   0x2502
#define	BOXDRAW_DOWN_RIGHT   0x250c
#define	BOXDRAW_DOWN_LEFT   0x2510
#define	BOXDRAW_UP_RIGHT   0x2514
#define	BOXDRAW_UP_LEFT   0x2518
#define	BOXDRAW_VERTICAL_RIGHT   0x251c
#define	BOXDRAW_VERTICAL_LEFT   0x2524
#define	BOXDRAW_DOWN_HORIZONTAL   0x252c
#define	BOXDRAW_UP_HORIZONTAL   0x2534
#define	BOXDRAW_VERTICAL_HORIZONTAL   0x253c
#define	BOXDRAW_DOUBLE_HORIZONTAL   0x2550
#define	BOXDRAW_DOUBLE_VERTICAL   0x2551
#define	BOXDRAW_DOWN_RIGHT_DOUBLE   0x2552
#define	BOXDRAW_DOWN_DOUBLE_RIGHT   0x2553
#define	BOXDRAW_DOUBLE_DOWN_RIGHT   0x2554
#define	BOXDRAW_DOWN_LEFT_DOUBLE   0x2555
#define	BOXDRAW_DOWN_DOUBLE_LEFT   0x2556
#define	BOXDRAW_DOUBLE_DOWN_LEFT   0x2557
#define	BOXDRAW_UP_RIGHT_DOUBLE   0x2558
#define	BOXDRAW_UP_DOUBLE_RIGHT   0x2559
#define	BOXDRAW_DOUBLE_UP_RIGHT   0x255a
#define	BOXDRAW_UP_LEFT_DOUBLE   0x255b
#define	BOXDRAW_UP_DOUBLE_LEFT   0x255c
#define	BOXDRAW_DOUBLE_UP_LEFT   0x255d
#define	BOXDRAW_VERTICAL_RIGHT_DOUBLE   0x255e
#define	BOXDRAW_VERTICAL_DOUBLE_RIGHT   0x255f
#define	BOXDRAW_DOUBLE_VERTICAL_RIGHT   0x2560
#define	BOXDRAW_VERTICAL_LEFT_DOUBLE   0x2561
#define	BOXDRAW_VERTICAL_DOUBLE_LEFT   0x2562
#define	BOXDRAW_DOUBLE_VERTICAL_LEFT   0x2563
#define	BOXDRAW_DOWN_HORIZONTAL_DOUBLE   0x2564
#define	BOXDRAW_DOWN_DOUBLE_HORIZONTAL   0x2565
#define	BOXDRAW_DOUBLE_DOWN_HORIZONTAL   0x2566
#define	BOXDRAW_UP_HORIZONTAL_DOUBLE   0x2567
#define	BOXDRAW_UP_DOUBLE_HORIZONTAL   0x2568
#define	BOXDRAW_DOUBLE_UP_HORIZONTAL   0x2569
#define	BOXDRAW_VERTICAL_HORIZONTAL_DOUBLE   0x256a
#define	BOXDRAW_VERTICAL_DOUBLE_HORIZONTAL   0x256b
#define	BOXDRAW_DOUBLE_VERTICAL_HORIZONTAL   0x256c
#define	BLOCKELEMENT_FULL_BLOCK   0x2588
#define	BLOCKELEMENT_LIGHT_SHADE   0x2591
#define	GEOMETRICSHAPE_UP_TRIANGLE   0x25b2
#define	GEOMETRICSHAPE_RIGHT_TRIANGLE   0x25ba
#define	GEOMETRICSHAPE_DOWN_TRIANGLE   0x25bc
#define	GEOMETRICSHAPE_LEFT_TRIANGLE   0x25c4
#define	ARROW_LEFT   0x2190
#define	ARROW_UP   0x2191
#define	ARROW_RIGHT   0x2192
#define	ARROW_DOWN   0x2193
#define	EFI_BLACK   0x00
#define	EFI_BLUE   0x01
#define	EFI_GREEN   0x02
#define	EFI_CYAN   (EFI_BLUE | EFI_GREEN)
#define	EFI_RED   0x04
#define	EFI_MAGENTA   (EFI_BLUE | EFI_RED)
#define	EFI_BROWN   (EFI_GREEN | EFI_RED)
#define	EFI_LIGHTGRAY   (EFI_BLUE | EFI_GREEN | EFI_RED)
#define	EFI_BRIGHT   0x08
#define	EFI_DARKGRAY   (EFI_BLACK | EFI_BRIGHT)
#define	EFI_LIGHTBLUE   (EFI_BLUE | EFI_BRIGHT)
#define	EFI_LIGHTGREEN   (EFI_GREEN | EFI_BRIGHT)
#define	EFI_LIGHTCYAN   (EFI_CYAN | EFI_BRIGHT)
#define	EFI_LIGHTRED   (EFI_RED | EFI_BRIGHT)
#define	EFI_LIGHTMAGENTA   (EFI_MAGENTA | EFI_BRIGHT)
#define	EFI_YELLOW   (EFI_BROWN | EFI_BRIGHT)
#define	EFI_WHITE   (EFI_BLUE | EFI_GREEN | EFI_RED | EFI_BRIGHT)
#define	EFI_TEXT_ATTR(Foreground, Background)   ((Foreground) | ((Background) << 4))
#define	EFI_BACKGROUND_BLACK   0x00
#define	EFI_BACKGROUND_BLUE   0x10
#define	EFI_BACKGROUND_GREEN   0x20
#define	EFI_BACKGROUND_CYAN   (EFI_BACKGROUND_BLUE | EFI_BACKGROUND_GREEN)
#define	EFI_BACKGROUND_RED   0x40
#define	EFI_BACKGROUND_MAGENTA   (EFI_BACKGROUND_BLUE | EFI_BACKGROUND_RED)
#define	EFI_BACKGROUND_BROWN   (EFI_BACKGROUND_GREEN | EFI_BACKGROUND_RED)
#define	EFI_BACKGROUND_LIGHTGRAY   (EFI_BACKGROUND_BLUE | EFI_BACKGROUND_GREEN | EFI_BACKGROUND_RED)
#define	EFI_WIDE_ATTRIBUTE   0x80

Typedefs
typedef struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL	EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL	SIMPLE_TEXT_OUTPUT_INTERFACE
	Backward-compatible with EFI1.1. More...
typedef EFI_STATUS(EFIAPI *	EFI_TEXT_RESET) (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN BOOLEAN ExtendedVerification)
	Reset the text output device hardware and optionally run diagnostics. More...
typedef EFI_STATUS(EFIAPI *	EFI_TEXT_STRING) (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN CHAR16 *String)
	Write a string to the output device. More...
typedef EFI_STATUS(EFIAPI *	EFI_TEXT_TEST_STRING) (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN CHAR16 *String)
	Verifies that all characters in a string can be output to the target device. More...
typedef EFI_STATUS(EFIAPI *	EFI_TEXT_QUERY_MODE) (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN UINTN ModeNumber, OUT UINTN *Columns, OUT UINTN *Rows)
	Returns information for an available text mode that the output device(s) supports. More...
typedef EFI_STATUS(EFIAPI *	EFI_TEXT_SET_MODE) (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN UINTN ModeNumber)
	Sets the output device(s) to a specified mode. More...
typedef EFI_STATUS(EFIAPI *	EFI_TEXT_SET_ATTRIBUTE) (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN UINTN Attribute)
	Sets the background and foreground colors for the OutputString () and ClearScreen () functions. More...
typedef EFI_STATUS(EFIAPI *	EFI_TEXT_CLEAR_SCREEN) (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This)
	Clears the output device(s) display to the currently selected background color. More...
typedef EFI_STATUS(EFIAPI *	EFI_TEXT_SET_CURSOR_POSITION) (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN UINTN Column, IN UINTN Row)
	Sets the current coordinates of the cursor position. More...
typedef EFI_STATUS(EFIAPI *	EFI_TEXT_ENABLE_CURSOR) (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN BOOLEAN Visible)
	Makes the cursor visible or invisible. More...

Functions
	FILE_LICENCE (BSD2_PATENT)

Variables
EFI_GUID	gEfiSimpleTextOutProtocolGuid

Detailed Description

Simple Text Out protocol from the UEFI 2.0 specification.

Abstraction of a very simple text based output device like VGA text mode or a serial terminal. The Simple Text Out protocol instance can represent a single hardware device or a virtual device that is an aggregation of multiple physical devices.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file SimpleTextOut.h.

Macro Definition Documentation

EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID

#define EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID

Value:

{ \
    0x387477c2, 0x69c7, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
  }

Definition at line 19 of file SimpleTextOut.h.

SIMPLE_TEXT_OUTPUT_PROTOCOL

#define SIMPLE_TEXT_OUTPUT_PROTOCOL   EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID

Protocol GUID defined in EFI1.1.

Definition at line 27 of file SimpleTextOut.h.

BOXDRAW_HORIZONTAL

#define BOXDRAW_HORIZONTAL   0x2500

Definition at line 39 of file SimpleTextOut.h.

BOXDRAW_VERTICAL

#define BOXDRAW_VERTICAL   0x2502

Definition at line 40 of file SimpleTextOut.h.

BOXDRAW_DOWN_RIGHT

#define BOXDRAW_DOWN_RIGHT   0x250c

Definition at line 41 of file SimpleTextOut.h.

BOXDRAW_DOWN_LEFT

#define BOXDRAW_DOWN_LEFT   0x2510

Definition at line 42 of file SimpleTextOut.h.

BOXDRAW_UP_RIGHT

#define BOXDRAW_UP_RIGHT   0x2514

Definition at line 43 of file SimpleTextOut.h.

BOXDRAW_UP_LEFT

#define BOXDRAW_UP_LEFT   0x2518

Definition at line 44 of file SimpleTextOut.h.

BOXDRAW_VERTICAL_RIGHT

#define BOXDRAW_VERTICAL_RIGHT   0x251c

Definition at line 45 of file SimpleTextOut.h.

BOXDRAW_VERTICAL_LEFT

#define BOXDRAW_VERTICAL_LEFT   0x2524

Definition at line 46 of file SimpleTextOut.h.

BOXDRAW_DOWN_HORIZONTAL

#define BOXDRAW_DOWN_HORIZONTAL   0x252c

Definition at line 47 of file SimpleTextOut.h.

BOXDRAW_UP_HORIZONTAL

#define BOXDRAW_UP_HORIZONTAL   0x2534

Definition at line 48 of file SimpleTextOut.h.

BOXDRAW_VERTICAL_HORIZONTAL

#define BOXDRAW_VERTICAL_HORIZONTAL   0x253c

Definition at line 49 of file SimpleTextOut.h.

BOXDRAW_DOUBLE_HORIZONTAL

#define BOXDRAW_DOUBLE_HORIZONTAL   0x2550

Definition at line 50 of file SimpleTextOut.h.

BOXDRAW_DOUBLE_VERTICAL

#define BOXDRAW_DOUBLE_VERTICAL   0x2551

Definition at line 51 of file SimpleTextOut.h.

BOXDRAW_DOWN_RIGHT_DOUBLE

#define BOXDRAW_DOWN_RIGHT_DOUBLE   0x2552

Definition at line 52 of file SimpleTextOut.h.

BOXDRAW_DOWN_DOUBLE_RIGHT

#define BOXDRAW_DOWN_DOUBLE_RIGHT   0x2553

Definition at line 53 of file SimpleTextOut.h.

BOXDRAW_DOUBLE_DOWN_RIGHT

#define BOXDRAW_DOUBLE_DOWN_RIGHT   0x2554

Definition at line 54 of file SimpleTextOut.h.

BOXDRAW_DOWN_LEFT_DOUBLE

#define BOXDRAW_DOWN_LEFT_DOUBLE   0x2555

Definition at line 55 of file SimpleTextOut.h.

BOXDRAW_DOWN_DOUBLE_LEFT

#define BOXDRAW_DOWN_DOUBLE_LEFT   0x2556

Definition at line 56 of file SimpleTextOut.h.

BOXDRAW_DOUBLE_DOWN_LEFT

#define BOXDRAW_DOUBLE_DOWN_LEFT   0x2557

Definition at line 57 of file SimpleTextOut.h.

BOXDRAW_UP_RIGHT_DOUBLE

#define BOXDRAW_UP_RIGHT_DOUBLE   0x2558

Definition at line 58 of file SimpleTextOut.h.

BOXDRAW_UP_DOUBLE_RIGHT

#define BOXDRAW_UP_DOUBLE_RIGHT   0x2559

Definition at line 59 of file SimpleTextOut.h.

BOXDRAW_DOUBLE_UP_RIGHT

#define BOXDRAW_DOUBLE_UP_RIGHT   0x255a

Definition at line 60 of file SimpleTextOut.h.

BOXDRAW_UP_LEFT_DOUBLE

#define BOXDRAW_UP_LEFT_DOUBLE   0x255b

Definition at line 61 of file SimpleTextOut.h.

BOXDRAW_UP_DOUBLE_LEFT

#define BOXDRAW_UP_DOUBLE_LEFT   0x255c

Definition at line 62 of file SimpleTextOut.h.

BOXDRAW_DOUBLE_UP_LEFT

#define BOXDRAW_DOUBLE_UP_LEFT   0x255d

Definition at line 63 of file SimpleTextOut.h.

BOXDRAW_VERTICAL_RIGHT_DOUBLE

#define BOXDRAW_VERTICAL_RIGHT_DOUBLE   0x255e

Definition at line 64 of file SimpleTextOut.h.

BOXDRAW_VERTICAL_DOUBLE_RIGHT

#define BOXDRAW_VERTICAL_DOUBLE_RIGHT   0x255f

Definition at line 65 of file SimpleTextOut.h.

BOXDRAW_DOUBLE_VERTICAL_RIGHT

#define BOXDRAW_DOUBLE_VERTICAL_RIGHT   0x2560

Definition at line 66 of file SimpleTextOut.h.

BOXDRAW_VERTICAL_LEFT_DOUBLE

#define BOXDRAW_VERTICAL_LEFT_DOUBLE   0x2561

Definition at line 67 of file SimpleTextOut.h.

BOXDRAW_VERTICAL_DOUBLE_LEFT

#define BOXDRAW_VERTICAL_DOUBLE_LEFT   0x2562

Definition at line 68 of file SimpleTextOut.h.

BOXDRAW_DOUBLE_VERTICAL_LEFT

#define BOXDRAW_DOUBLE_VERTICAL_LEFT   0x2563

Definition at line 69 of file SimpleTextOut.h.

BOXDRAW_DOWN_HORIZONTAL_DOUBLE

#define BOXDRAW_DOWN_HORIZONTAL_DOUBLE   0x2564

Definition at line 70 of file SimpleTextOut.h.

BOXDRAW_DOWN_DOUBLE_HORIZONTAL

#define BOXDRAW_DOWN_DOUBLE_HORIZONTAL   0x2565

Definition at line 71 of file SimpleTextOut.h.

BOXDRAW_DOUBLE_DOWN_HORIZONTAL

#define BOXDRAW_DOUBLE_DOWN_HORIZONTAL   0x2566

Definition at line 72 of file SimpleTextOut.h.

BOXDRAW_UP_HORIZONTAL_DOUBLE

#define BOXDRAW_UP_HORIZONTAL_DOUBLE   0x2567

Definition at line 73 of file SimpleTextOut.h.

BOXDRAW_UP_DOUBLE_HORIZONTAL

#define BOXDRAW_UP_DOUBLE_HORIZONTAL   0x2568

Definition at line 74 of file SimpleTextOut.h.

BOXDRAW_DOUBLE_UP_HORIZONTAL

#define BOXDRAW_DOUBLE_UP_HORIZONTAL   0x2569

Definition at line 75 of file SimpleTextOut.h.

BOXDRAW_VERTICAL_HORIZONTAL_DOUBLE

#define BOXDRAW_VERTICAL_HORIZONTAL_DOUBLE   0x256a

Definition at line 76 of file SimpleTextOut.h.

BOXDRAW_VERTICAL_DOUBLE_HORIZONTAL

#define BOXDRAW_VERTICAL_DOUBLE_HORIZONTAL   0x256b

Definition at line 77 of file SimpleTextOut.h.

BOXDRAW_DOUBLE_VERTICAL_HORIZONTAL

#define BOXDRAW_DOUBLE_VERTICAL_HORIZONTAL   0x256c

Definition at line 78 of file SimpleTextOut.h.

BLOCKELEMENT_FULL_BLOCK

#define BLOCKELEMENT_FULL_BLOCK   0x2588

Definition at line 83 of file SimpleTextOut.h.

BLOCKELEMENT_LIGHT_SHADE

#define BLOCKELEMENT_LIGHT_SHADE   0x2591

Definition at line 84 of file SimpleTextOut.h.

GEOMETRICSHAPE_UP_TRIANGLE

#define GEOMETRICSHAPE_UP_TRIANGLE   0x25b2

Definition at line 89 of file SimpleTextOut.h.

GEOMETRICSHAPE_RIGHT_TRIANGLE

#define GEOMETRICSHAPE_RIGHT_TRIANGLE   0x25ba

Definition at line 90 of file SimpleTextOut.h.

GEOMETRICSHAPE_DOWN_TRIANGLE

#define GEOMETRICSHAPE_DOWN_TRIANGLE   0x25bc

Definition at line 91 of file SimpleTextOut.h.

GEOMETRICSHAPE_LEFT_TRIANGLE

#define GEOMETRICSHAPE_LEFT_TRIANGLE   0x25c4

Definition at line 92 of file SimpleTextOut.h.

ARROW_LEFT

#define ARROW_LEFT   0x2190

Definition at line 97 of file SimpleTextOut.h.

ARROW_UP

#define ARROW_UP   0x2191

Definition at line 98 of file SimpleTextOut.h.

ARROW_RIGHT

#define ARROW_RIGHT   0x2192

Definition at line 99 of file SimpleTextOut.h.

ARROW_DOWN

#define ARROW_DOWN   0x2193

Definition at line 100 of file SimpleTextOut.h.

EFI_BLACK

#define EFI_BLACK   0x00

Definition at line 105 of file SimpleTextOut.h.

EFI_BLUE

#define EFI_BLUE   0x01

Definition at line 106 of file SimpleTextOut.h.

EFI_GREEN

#define EFI_GREEN   0x02

Definition at line 107 of file SimpleTextOut.h.

EFI_CYAN

#define EFI_CYAN   (EFI_BLUE | EFI_GREEN)

Definition at line 108 of file SimpleTextOut.h.

EFI_RED

#define EFI_RED   0x04

Definition at line 109 of file SimpleTextOut.h.

EFI_MAGENTA

#define EFI_MAGENTA   (EFI_BLUE | EFI_RED)

Definition at line 110 of file SimpleTextOut.h.

EFI_BROWN

#define EFI_BROWN   (EFI_GREEN | EFI_RED)

Definition at line 111 of file SimpleTextOut.h.

EFI_LIGHTGRAY

#define EFI_LIGHTGRAY   (EFI_BLUE | EFI_GREEN | EFI_RED)

Definition at line 112 of file SimpleTextOut.h.

EFI_BRIGHT

#define EFI_BRIGHT   0x08

Definition at line 113 of file SimpleTextOut.h.

EFI_DARKGRAY

#define EFI_DARKGRAY   (EFI_BLACK | EFI_BRIGHT)

Definition at line 114 of file SimpleTextOut.h.

EFI_LIGHTBLUE

#define EFI_LIGHTBLUE   (EFI_BLUE | EFI_BRIGHT)

Definition at line 115 of file SimpleTextOut.h.

EFI_LIGHTGREEN

#define EFI_LIGHTGREEN   (EFI_GREEN | EFI_BRIGHT)

Definition at line 116 of file SimpleTextOut.h.

EFI_LIGHTCYAN

#define EFI_LIGHTCYAN   (EFI_CYAN | EFI_BRIGHT)

Definition at line 117 of file SimpleTextOut.h.

EFI_LIGHTRED

#define EFI_LIGHTRED   (EFI_RED | EFI_BRIGHT)

Definition at line 118 of file SimpleTextOut.h.

EFI_LIGHTMAGENTA

#define EFI_LIGHTMAGENTA   (EFI_MAGENTA | EFI_BRIGHT)

Definition at line 119 of file SimpleTextOut.h.

EFI_YELLOW

#define EFI_YELLOW   (EFI_BROWN | EFI_BRIGHT)

Definition at line 120 of file SimpleTextOut.h.

EFI_WHITE

#define EFI_WHITE   (EFI_BLUE | EFI_GREEN | EFI_RED | EFI_BRIGHT)

Definition at line 121 of file SimpleTextOut.h.

EFI_TEXT_ATTR

#define EFI_TEXT_ATTR	(		Foreground,
			Background
	)		((Foreground) | ((Background) << 4))

Definition at line 134 of file SimpleTextOut.h.

EFI_BACKGROUND_BLACK

#define EFI_BACKGROUND_BLACK   0x00

Definition at line 136 of file SimpleTextOut.h.

EFI_BACKGROUND_BLUE

#define EFI_BACKGROUND_BLUE   0x10

Definition at line 137 of file SimpleTextOut.h.

EFI_BACKGROUND_GREEN

#define EFI_BACKGROUND_GREEN   0x20

Definition at line 138 of file SimpleTextOut.h.

EFI_BACKGROUND_CYAN

#define EFI_BACKGROUND_CYAN   (EFI_BACKGROUND_BLUE | EFI_BACKGROUND_GREEN)

Definition at line 139 of file SimpleTextOut.h.

EFI_BACKGROUND_RED

#define EFI_BACKGROUND_RED   0x40

Definition at line 140 of file SimpleTextOut.h.

EFI_BACKGROUND_MAGENTA

#define EFI_BACKGROUND_MAGENTA   (EFI_BACKGROUND_BLUE | EFI_BACKGROUND_RED)

Definition at line 141 of file SimpleTextOut.h.

EFI_BACKGROUND_BROWN

#define EFI_BACKGROUND_BROWN   (EFI_BACKGROUND_GREEN | EFI_BACKGROUND_RED)

Definition at line 142 of file SimpleTextOut.h.

EFI_BACKGROUND_LIGHTGRAY

#define EFI_BACKGROUND_LIGHTGRAY   (EFI_BACKGROUND_BLUE | EFI_BACKGROUND_GREEN | EFI_BACKGROUND_RED)

Definition at line 143 of file SimpleTextOut.h.

EFI_WIDE_ATTRIBUTE

#define EFI_WIDE_ATTRIBUTE   0x80

Definition at line 153 of file SimpleTextOut.h.

Typedef Documentation

EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL

typedef struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL

Definition at line 29 of file SimpleTextOut.h.

SIMPLE_TEXT_OUTPUT_INTERFACE

typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL SIMPLE_TEXT_OUTPUT_INTERFACE

Backward-compatible with EFI1.1.

Definition at line 34 of file SimpleTextOut.h.

EFI_TEXT_RESET

typedef EFI_STATUS(EFIAPI * EFI_TEXT_RESET) (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN BOOLEAN ExtendedVerification)

Reset the text output device hardware and optionally run diagnostics.

Parameters

This	The protocol instance pointer.
ExtendedVerification	Driver may perform more exhaustive verification operation of the device during reset.

Return values

EFI_SUCCESS	The text output device was reset.
EFI_DEVICE_ERROR	The text output device is not functioning correctly and could not be reset.

Definition at line 169 of file SimpleTextOut.h.

EFI_TEXT_STRING

typedef EFI_STATUS(EFIAPI * EFI_TEXT_STRING) (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN CHAR16 *String)

Write a string to the output device.

Parameters

This	The protocol instance pointer.
String	The NULL-terminated string to be displayed on the output device(s). All output devices must also support the Unicode drawing character codes defined in this file.

Return values

EFI_SUCCESS	The string was output to the device.
EFI_DEVICE_ERROR	The device reported an error while attempting to output the text.
EFI_UNSUPPORTED	The output device's mode is not currently in a defined text mode.
EFI_WARN_UNKNOWN_GLYPH	This warning code indicates that some of the characters in the string could not be rendered and were skipped.

Definition at line 194 of file SimpleTextOut.h.

EFI_TEXT_TEST_STRING

typedef EFI_STATUS(EFIAPI * EFI_TEXT_TEST_STRING) (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN CHAR16 *String)

Verifies that all characters in a string can be output to the target device.

Parameters

This	The protocol instance pointer.
String	The NULL-terminated string to be examined for the output device(s).

Return values

EFI_SUCCESS	The device(s) are capable of rendering the output string.
EFI_UNSUPPORTED	Some of the characters in the string cannot be rendered by one or more of the output devices mapped by the EFI handle.

Definition at line 215 of file SimpleTextOut.h.

EFI_TEXT_QUERY_MODE

typedef EFI_STATUS(EFIAPI * EFI_TEXT_QUERY_MODE) (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN UINTN ModeNumber, OUT UINTN *Columns, OUT UINTN *Rows)

Returns information for an available text mode that the output device(s) supports.

Parameters

This	The protocol instance pointer.
ModeNumber	The mode number to return information on.
Columns	Returns the geometry of the text output device for the requested ModeNumber.
Rows	Returns the geometry of the text output device for the requested ModeNumber.

Return values

EFI_SUCCESS	The requested mode information was returned.
EFI_DEVICE_ERROR	The device had an error and could not complete the request.
EFI_UNSUPPORTED	The mode number was not valid.

Definition at line 238 of file SimpleTextOut.h.

EFI_TEXT_SET_MODE

typedef EFI_STATUS(EFIAPI * EFI_TEXT_SET_MODE) (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN UINTN ModeNumber)

Sets the output device(s) to a specified mode.

Parameters

This	The protocol instance pointer.
ModeNumber	The mode number to set.

Return values

EFI_SUCCESS	The requested text mode was set.
EFI_DEVICE_ERROR	The device had an error and could not complete the request.
EFI_UNSUPPORTED	The mode number was not valid.

Definition at line 258 of file SimpleTextOut.h.

EFI_TEXT_SET_ATTRIBUTE

typedef EFI_STATUS(EFIAPI * EFI_TEXT_SET_ATTRIBUTE) (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN UINTN Attribute)

Sets the background and foreground colors for the OutputString () and ClearScreen () functions.

Parameters

This	The protocol instance pointer.
Attribute	The attribute to set. Bits 0..3 are the foreground color, and bits 4..6 are the background color. All other bits are undefined and must be zero. The valid Attributes are defined in this file.

Return values

EFI_SUCCESS	The attribute was set.
EFI_DEVICE_ERROR	The device had an error and could not complete the request.
EFI_UNSUPPORTED	The attribute requested is not defined.

Definition at line 279 of file SimpleTextOut.h.

EFI_TEXT_CLEAR_SCREEN

typedef EFI_STATUS(EFIAPI * EFI_TEXT_CLEAR_SCREEN) (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This)

Clears the output device(s) display to the currently selected background color.

Parameters

This	The protocol instance pointer.

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_DEVICE_ERROR	The device had an error and could not complete the request.
EFI_UNSUPPORTED	The output device is not in a valid text mode.

Definition at line 297 of file SimpleTextOut.h.

EFI_TEXT_SET_CURSOR_POSITION

typedef EFI_STATUS(EFIAPI * EFI_TEXT_SET_CURSOR_POSITION) (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN UINTN Column, IN UINTN Row)

Sets the current coordinates of the cursor position.

Parameters

This	The protocol instance pointer.
Column	The position to set the cursor to. Must be greater than or equal to zero and less than the number of columns and rows by QueryMode ().
Row	The position to set the cursor to. Must be greater than or equal to zero and less than the number of columns and rows by QueryMode ().

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_DEVICE_ERROR	The device had an error and could not complete the request.
EFI_UNSUPPORTED	The output device is not in a valid text mode, or the cursor position is invalid for the current mode.

Definition at line 320 of file SimpleTextOut.h.

EFI_TEXT_ENABLE_CURSOR

typedef EFI_STATUS(EFIAPI * EFI_TEXT_ENABLE_CURSOR) (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN BOOLEAN Visible)

Makes the cursor visible or invisible.

Parameters

This	The protocol instance pointer.
Visible	If TRUE, the cursor is set to be visible. If FALSE, the cursor is set to be invisible.

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_DEVICE_ERROR	The device had an error and could not complete the request, or the device does not support changing the cursor mode.
EFI_UNSUPPORTED	The output device is not in a valid text mode.

Definition at line 342 of file SimpleTextOut.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

BSD2_PATENT

)

Variable Documentation

gEfiSimpleTextOutProtocolGuid

EFI_GUID gEfiSimpleTextOutProtocolGuid