7 Copyright (c) 1998 Intel Corporation
24 * Text output protocol
27 #define SIMPLE_TEXT_OUTPUT_PROTOCOL \
28 { 0x387477c2, 0x69c7, 0x11d2, 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b }
30 INTERFACE_DECL(_SIMPLE_TEXT_OUTPUT_INTERFACE);
34 (EFIAPI *EFI_TEXT_RESET) (
35 IN struct _SIMPLE_TEXT_OUTPUT_INTERFACE *This,
36 IN BOOLEAN ExtendedVerification
41 (EFIAPI *EFI_TEXT_OUTPUT_STRING) (
42 IN struct _SIMPLE_TEXT_OUTPUT_INTERFACE *This,
48 (EFIAPI *EFI_TEXT_TEST_STRING) (
49 IN struct _SIMPLE_TEXT_OUTPUT_INTERFACE *This,
55 (EFIAPI *EFI_TEXT_QUERY_MODE) (
56 IN struct _SIMPLE_TEXT_OUTPUT_INTERFACE *This,
64 (EFIAPI *EFI_TEXT_SET_MODE) (
65 IN struct _SIMPLE_TEXT_OUTPUT_INTERFACE *This,
71 (EFIAPI *EFI_TEXT_SET_ATTRIBUTE) (
72 IN struct _SIMPLE_TEXT_OUTPUT_INTERFACE *This,
76 #define EFI_BLACK 0x00
78 #define EFI_GREEN 0x02
79 #define EFI_CYAN (EFI_BLUE | EFI_GREEN)
81 #define EFI_MAGENTA (EFI_BLUE | EFI_RED)
82 #define EFI_BROWN (EFI_GREEN | EFI_RED)
83 #define EFI_LIGHTGRAY (EFI_BLUE | EFI_GREEN | EFI_RED)
84 #define EFI_BRIGHT 0x08
85 #define EFI_DARKGRAY (EFI_BRIGHT)
86 #define EFI_LIGHTBLUE (EFI_BLUE | EFI_BRIGHT)
87 #define EFI_LIGHTGREEN (EFI_GREEN | EFI_BRIGHT)
88 #define EFI_LIGHTCYAN (EFI_CYAN | EFI_BRIGHT)
89 #define EFI_LIGHTRED (EFI_RED | EFI_BRIGHT)
90 #define EFI_LIGHTMAGENTA (EFI_MAGENTA | EFI_BRIGHT)
91 #define EFI_YELLOW (EFI_BROWN | EFI_BRIGHT)
92 #define EFI_WHITE (EFI_BLUE | EFI_GREEN | EFI_RED | EFI_BRIGHT)
94 #define EFI_TEXT_ATTR(f,b) ((f) | ((b) << 4))
96 #define EFI_BACKGROUND_BLACK 0x00
97 #define EFI_BACKGROUND_BLUE 0x10
98 #define EFI_BACKGROUND_GREEN 0x20
99 #define EFI_BACKGROUND_CYAN (EFI_BACKGROUND_BLUE | EFI_BACKGROUND_GREEN)
100 #define EFI_BACKGROUND_RED 0x40
101 #define EFI_BACKGROUND_MAGENTA (EFI_BACKGROUND_BLUE | EFI_BACKGROUND_RED)
102 #define EFI_BACKGROUND_BROWN (EFI_BACKGROUND_GREEN | EFI_BACKGROUND_RED)
103 #define EFI_BACKGROUND_LIGHTGRAY (EFI_BACKGROUND_BLUE | EFI_BACKGROUND_GREEN | EFI_BACKGROUND_RED)
108 (EFIAPI *EFI_TEXT_CLEAR_SCREEN) (
109 IN struct _SIMPLE_TEXT_OUTPUT_INTERFACE *This
114 (EFIAPI *EFI_TEXT_SET_CURSOR_POSITION) (
115 IN struct _SIMPLE_TEXT_OUTPUT_INTERFACE *This,
122 (EFIAPI *EFI_TEXT_ENABLE_CURSOR) (
123 IN struct _SIMPLE_TEXT_OUTPUT_INTERFACE *This,
129 /* current settings */
134 BOOLEAN CursorVisible;
135 } SIMPLE_TEXT_OUTPUT_MODE;
137 typedef struct _SIMPLE_TEXT_OUTPUT_INTERFACE {
138 EFI_TEXT_RESET Reset;
140 EFI_TEXT_OUTPUT_STRING OutputString;
141 EFI_TEXT_TEST_STRING TestString;
143 EFI_TEXT_QUERY_MODE QueryMode;
144 EFI_TEXT_SET_MODE SetMode;
145 EFI_TEXT_SET_ATTRIBUTE SetAttribute;
147 EFI_TEXT_CLEAR_SCREEN ClearScreen;
148 EFI_TEXT_SET_CURSOR_POSITION SetCursorPosition;
149 EFI_TEXT_ENABLE_CURSOR EnableCursor;
152 SIMPLE_TEXT_OUTPUT_MODE *Mode;
153 } SIMPLE_TEXT_OUTPUT_INTERFACE;
156 * Define's for required EFI Unicode Box Draw character
159 #define BOXDRAW_HORIZONTAL 0x2500
160 #define BOXDRAW_VERTICAL 0x2502
161 #define BOXDRAW_DOWN_RIGHT 0x250c
162 #define BOXDRAW_DOWN_LEFT 0x2510
163 #define BOXDRAW_UP_RIGHT 0x2514
164 #define BOXDRAW_UP_LEFT 0x2518
165 #define BOXDRAW_VERTICAL_RIGHT 0x251c
166 #define BOXDRAW_VERTICAL_LEFT 0x2524
167 #define BOXDRAW_DOWN_HORIZONTAL 0x252c
168 #define BOXDRAW_UP_HORIZONTAL 0x2534
169 #define BOXDRAW_VERTICAL_HORIZONTAL 0x253c
171 #define BOXDRAW_DOUBLE_HORIZONTAL 0x2550
172 #define BOXDRAW_DOUBLE_VERTICAL 0x2551
173 #define BOXDRAW_DOWN_RIGHT_DOUBLE 0x2552
174 #define BOXDRAW_DOWN_DOUBLE_RIGHT 0x2553
175 #define BOXDRAW_DOUBLE_DOWN_RIGHT 0x2554
177 #define BOXDRAW_DOWN_LEFT_DOUBLE 0x2555
178 #define BOXDRAW_DOWN_DOUBLE_LEFT 0x2556
179 #define BOXDRAW_DOUBLE_DOWN_LEFT 0x2557
181 #define BOXDRAW_UP_RIGHT_DOUBLE 0x2558
182 #define BOXDRAW_UP_DOUBLE_RIGHT 0x2559
183 #define BOXDRAW_DOUBLE_UP_RIGHT 0x255a
185 #define BOXDRAW_UP_LEFT_DOUBLE 0x255b
186 #define BOXDRAW_UP_DOUBLE_LEFT 0x255c
187 #define BOXDRAW_DOUBLE_UP_LEFT 0x255d
189 #define BOXDRAW_VERTICAL_RIGHT_DOUBLE 0x255e
190 #define BOXDRAW_VERTICAL_DOUBLE_RIGHT 0x255f
191 #define BOXDRAW_DOUBLE_VERTICAL_RIGHT 0x2560
193 #define BOXDRAW_VERTICAL_LEFT_DOUBLE 0x2561
194 #define BOXDRAW_VERTICAL_DOUBLE_LEFT 0x2562
195 #define BOXDRAW_DOUBLE_VERTICAL_LEFT 0x2563
197 #define BOXDRAW_DOWN_HORIZONTAL_DOUBLE 0x2564
198 #define BOXDRAW_DOWN_DOUBLE_HORIZONTAL 0x2565
199 #define BOXDRAW_DOUBLE_DOWN_HORIZONTAL 0x2566
201 #define BOXDRAW_UP_HORIZONTAL_DOUBLE 0x2567
202 #define BOXDRAW_UP_DOUBLE_HORIZONTAL 0x2568
203 #define BOXDRAW_DOUBLE_UP_HORIZONTAL 0x2569
205 #define BOXDRAW_VERTICAL_HORIZONTAL_DOUBLE 0x256a
206 #define BOXDRAW_VERTICAL_DOUBLE_HORIZONTAL 0x256b
207 #define BOXDRAW_DOUBLE_VERTICAL_HORIZONTAL 0x256c
210 * EFI Required Block Elements Code Chart
212 #define BLOCKELEMENT_FULL_BLOCK 0x2588
213 #define BLOCKELEMENT_LIGHT_SHADE 0x2591
216 * EFI Required Geometric Shapes Code Chart
218 #define GEOMETRICSHAPE_UP_TRIANGLE 0x25b2
219 #define GEOMETRICSHAPE_RIGHT_TRIANGLE 0x25ba
220 #define GEOMETRICSHAPE_DOWN_TRIANGLE 0x25bc
221 #define GEOMETRICSHAPE_LEFT_TRIANGLE 0x25c4
224 * EFI Required Arrow shapes
226 #define ARROW_UP 0x2191
227 #define ARROW_DOWN 0x2193
230 * Text input protocol
233 #define SIMPLE_TEXT_INPUT_PROTOCOL \
234 { 0x387477c1, 0x69c7, 0x11d2, 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b }
236 INTERFACE_DECL(_SIMPLE_INPUT_INTERFACE);
244 * Baseline unicode control chars
247 #define CHAR_NULL 0x0000
248 #define CHAR_BACKSPACE 0x0008
249 #define CHAR_TAB 0x0009
250 #define CHAR_LINEFEED 0x000A
251 #define CHAR_CARRIAGE_RETURN 0x000D
254 * Scan codes for base line keys
256 #define SCAN_NULL 0x0000
257 #define SCAN_UP 0x0001
258 #define SCAN_DOWN 0x0002
259 #define SCAN_RIGHT 0x0003
260 #define SCAN_LEFT 0x0004
261 #define SCAN_HOME 0x0005
262 #define SCAN_END 0x0006
263 #define SCAN_INSERT 0x0007
264 #define SCAN_DELETE 0x0008
265 #define SCAN_PAGE_UP 0x0009
266 #define SCAN_PAGE_DOWN 0x000A
267 #define SCAN_F1 0x000B
268 #define SCAN_F2 0x000C
269 #define SCAN_F3 0x000D
270 #define SCAN_F4 0x000E
271 #define SCAN_F5 0x000F
272 #define SCAN_F6 0x0010
273 #define SCAN_F7 0x0011
274 #define SCAN_F8 0x0012
275 #define SCAN_F9 0x0013
276 #define SCAN_F10 0x0014
277 #define SCAN_ESC 0x0017
281 (EFIAPI *EFI_INPUT_RESET) (
282 IN struct _SIMPLE_INPUT_INTERFACE *This,
283 IN BOOLEAN ExtendedVerification
288 (EFIAPI *EFI_INPUT_READ_KEY) (
289 IN struct _SIMPLE_INPUT_INTERFACE *This,
290 OUT EFI_INPUT_KEY *Key
293 typedef struct _SIMPLE_INPUT_INTERFACE {
294 EFI_INPUT_RESET Reset;
295 EFI_INPUT_READ_KEY ReadKeyStroke;
296 EFI_EVENT WaitForKey;
297 } SIMPLE_INPUT_INTERFACE;