1 // SPDX-License-Identifier: GPL-2.0+
3 * EFI application console interface
5 * Copyright (c) 2016 Alexander Graf
10 #include <dm/device.h>
11 #include <efi_loader.h>
12 #include <stdio_dev.h>
13 #include <video_console.h>
15 #define EFI_COUT_MODE_2 2
16 #define EFI_MAX_COUT_MODE 3
19 unsigned long columns;
24 static struct cout_mode efi_cout_modes[] = {
25 /* EFI Mode 0 is 80x25 and always present */
31 /* EFI Mode 1 is always 80x50 */
37 /* Value are unknown until we query the console */
45 const efi_guid_t efi_guid_text_output_protocol =
46 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID;
47 const efi_guid_t efi_guid_text_input_protocol =
48 EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID;
53 /* Default to mode 0 */
54 static struct simple_text_output_mode efi_con_mode = {
64 * Receive and parse a reply from the terminal.
66 * @n: array of return values
67 * @num: number of return values expected
68 * @end_char: character indicating end of terminal message
69 * @return: non-zero indicates error
71 static int term_read_reply(int *n, int num, char end_char)
92 } else if (c == end_char) {
94 } else if (c > '9' || c < '0') {
98 /* Read one more decimal position */
108 static efi_status_t EFIAPI efi_cout_output_string(
109 struct efi_simple_text_output_protocol *this,
110 const efi_string_t string)
112 struct simple_text_output_mode *con = &efi_con_mode;
113 struct cout_mode *mode = &efi_cout_modes[con->mode];
115 EFI_ENTRY("%p, %p", this, string);
117 unsigned int n16 = u16_strlen(string);
118 char buf[MAX_UTF8_PER_UTF16 * n16 + 1];
121 *utf16_to_utf8((u8 *)buf, string, n16) = '\0';
126 * Update the cursor position.
128 * The UEFI spec provides advance rules for U+0000, U+0008, U+000A,
129 * and U000D. All other characters, including control characters
130 * U+0007 (bel) and U+0009 (tab), have to increase the column by one.
132 for (p = string; *p; ++p) {
134 case '\b': /* U+0008, backspace */
135 con->cursor_column = max(0, con->cursor_column - 1);
137 case '\n': /* U+000A, newline */
138 con->cursor_column = 0;
141 case '\r': /* U+000D, carriage-return */
142 con->cursor_column = 0;
144 case 0xd800 ... 0xdbff:
146 * Ignore high surrogates, we do not want to count a
147 * Unicode character twice.
151 con->cursor_column++;
154 if (con->cursor_column >= mode->columns) {
155 con->cursor_column = 0;
158 con->cursor_row = min(con->cursor_row, (s32)mode->rows - 1);
161 return EFI_EXIT(EFI_SUCCESS);
164 static efi_status_t EFIAPI efi_cout_test_string(
165 struct efi_simple_text_output_protocol *this,
166 const efi_string_t string)
168 EFI_ENTRY("%p, %p", this, string);
169 return EFI_EXIT(EFI_SUCCESS);
172 static bool cout_mode_matches(struct cout_mode *mode, int rows, int cols)
177 return (mode->rows == rows) && (mode->columns == cols);
180 static int query_console_serial(int *rows, int *cols)
182 /* Ask the terminal about its size */
186 /* Empty input buffer */
192 /* Check if we have a terminal that understands */
193 timeout = timer_get_us() + 1000000;
195 if (timer_get_us() > timeout)
198 /* Read {depth,rows,cols} */
199 if (term_read_reply(n, 3, 't'))
209 * Update the mode table.
211 * By default the only mode available is 80x25. If the console has at least 50
212 * lines, enable mode 80x50. If we can query the console size and it is neither
213 * 80x25 nor 80x50, set it as an additional mode.
215 static void query_console_size(void)
217 const char *stdout_name = env_get("stdout");
218 int rows = 25, cols = 80;
220 if (stdout_name && !strcmp(stdout_name, "vidconsole") &&
221 IS_ENABLED(CONFIG_DM_VIDEO)) {
222 struct stdio_dev *stdout_dev =
223 stdio_get_by_name("vidconsole");
224 struct udevice *dev = stdout_dev->priv;
225 struct vidconsole_priv *priv =
226 dev_get_uclass_priv(dev);
229 } else if (query_console_serial(&rows, &cols)) {
233 /* Test if we can have Mode 1 */
234 if (cols >= 80 && rows >= 50) {
235 efi_cout_modes[1].present = 1;
236 efi_con_mode.max_mode = 2;
240 * Install our mode as mode 2 if it is different
241 * than mode 0 or 1 and set it as the currently selected mode
243 if (!cout_mode_matches(&efi_cout_modes[0], rows, cols) &&
244 !cout_mode_matches(&efi_cout_modes[1], rows, cols)) {
245 efi_cout_modes[EFI_COUT_MODE_2].columns = cols;
246 efi_cout_modes[EFI_COUT_MODE_2].rows = rows;
247 efi_cout_modes[EFI_COUT_MODE_2].present = 1;
248 efi_con_mode.max_mode = EFI_MAX_COUT_MODE;
249 efi_con_mode.mode = EFI_COUT_MODE_2;
253 static efi_status_t EFIAPI efi_cout_query_mode(
254 struct efi_simple_text_output_protocol *this,
255 unsigned long mode_number, unsigned long *columns,
258 EFI_ENTRY("%p, %ld, %p, %p", this, mode_number, columns, rows);
260 if (mode_number >= efi_con_mode.max_mode)
261 return EFI_EXIT(EFI_UNSUPPORTED);
263 if (efi_cout_modes[mode_number].present != 1)
264 return EFI_EXIT(EFI_UNSUPPORTED);
267 *columns = efi_cout_modes[mode_number].columns;
269 *rows = efi_cout_modes[mode_number].rows;
271 return EFI_EXIT(EFI_SUCCESS);
274 static efi_status_t EFIAPI efi_cout_set_mode(
275 struct efi_simple_text_output_protocol *this,
276 unsigned long mode_number)
278 EFI_ENTRY("%p, %ld", this, mode_number);
281 if (mode_number > efi_con_mode.max_mode)
282 return EFI_EXIT(EFI_UNSUPPORTED);
284 efi_con_mode.mode = mode_number;
285 efi_con_mode.cursor_column = 0;
286 efi_con_mode.cursor_row = 0;
288 return EFI_EXIT(EFI_SUCCESS);
291 static const struct {
295 { 30, 40 }, /* 0: black */
296 { 34, 44 }, /* 1: blue */
297 { 32, 42 }, /* 2: green */
298 { 36, 46 }, /* 3: cyan */
299 { 31, 41 }, /* 4: red */
300 { 35, 45 }, /* 5: magenta */
301 { 33, 43 }, /* 6: brown, map to yellow as edk2 does*/
302 { 37, 47 }, /* 7: light grey, map to white */
305 /* See EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetAttribute(). */
306 static efi_status_t EFIAPI efi_cout_set_attribute(
307 struct efi_simple_text_output_protocol *this,
308 unsigned long attribute)
310 unsigned int bold = EFI_ATTR_BOLD(attribute);
311 unsigned int fg = EFI_ATTR_FG(attribute);
312 unsigned int bg = EFI_ATTR_BG(attribute);
314 EFI_ENTRY("%p, %lx", this, attribute);
317 printf(ESC"[%u;%u;%um", bold, color[fg].fg, color[bg].bg);
319 printf(ESC"[0;37;40m");
321 return EFI_EXIT(EFI_SUCCESS);
324 static efi_status_t EFIAPI efi_cout_clear_screen(
325 struct efi_simple_text_output_protocol *this)
327 EFI_ENTRY("%p", this);
330 efi_con_mode.cursor_column = 0;
331 efi_con_mode.cursor_row = 0;
333 return EFI_EXIT(EFI_SUCCESS);
336 static efi_status_t EFIAPI efi_cout_reset(
337 struct efi_simple_text_output_protocol *this,
338 char extended_verification)
340 EFI_ENTRY("%p, %d", this, extended_verification);
343 EFI_CALL(efi_cout_clear_screen(this));
344 /* Set default colors */
345 printf(ESC "[0;37;40m");
347 return EFI_EXIT(EFI_SUCCESS);
350 static efi_status_t EFIAPI efi_cout_set_cursor_position(
351 struct efi_simple_text_output_protocol *this,
352 unsigned long column, unsigned long row)
354 EFI_ENTRY("%p, %ld, %ld", this, column, row);
356 printf(ESC"[%d;%df", (int)row, (int)column);
357 efi_con_mode.cursor_column = column;
358 efi_con_mode.cursor_row = row;
360 return EFI_EXIT(EFI_SUCCESS);
363 static efi_status_t EFIAPI efi_cout_enable_cursor(
364 struct efi_simple_text_output_protocol *this,
367 EFI_ENTRY("%p, %d", this, enable);
369 printf(ESC"[?25%c", enable ? 'h' : 'l');
371 return EFI_EXIT(EFI_SUCCESS);
374 struct efi_simple_text_output_protocol efi_con_out = {
375 .reset = efi_cout_reset,
376 .output_string = efi_cout_output_string,
377 .test_string = efi_cout_test_string,
378 .query_mode = efi_cout_query_mode,
379 .set_mode = efi_cout_set_mode,
380 .set_attribute = efi_cout_set_attribute,
381 .clear_screen = efi_cout_clear_screen,
382 .set_cursor_position = efi_cout_set_cursor_position,
383 .enable_cursor = efi_cout_enable_cursor,
384 .mode = (void*)&efi_con_mode,
387 static efi_status_t EFIAPI efi_cin_reset(
388 struct efi_simple_input_interface *this,
389 bool extended_verification)
391 EFI_ENTRY("%p, %d", this, extended_verification);
393 /* Empty input buffer */
397 return EFI_EXIT(EFI_SUCCESS);
401 * Analyze modifiers (shift, alt, ctrl) for function keys.
402 * This gets called when we have already parsed CSI.
404 * @modifiers: bitmask (shift, alt, ctrl)
405 * @return: the unmodified code
407 static char skip_modifiers(int *modifiers)
409 char c, mod = 0, ret = 0;
442 static efi_status_t EFIAPI efi_cin_read_key_stroke(
443 struct efi_simple_input_interface *this,
444 struct efi_input_key *key)
446 struct efi_input_key pressed_key = {
452 EFI_ENTRY("%p, %p", this, key);
454 /* We don't do interrupts, so check for timers cooperatively */
459 return EFI_EXIT(EFI_NOT_READY);
465 * Xterm Control Sequences
466 * https://www.xfree86.org/4.8.0/ctlseqs.html
471 pressed_key.scan_code = 23;
473 case 'O': /* F1 - F4 */
478 pressed_key.scan_code = ch - 'P' + 11;
486 case 'A'...'D': /* up, down right, left */
487 pressed_key.scan_code = ch - 'A' + 1;
490 pressed_key.scan_code = 6;
493 pressed_key.scan_code = 5;
496 ch = skip_modifiers(NULL);
498 case '1'...'5': /* F1 - F5 */
499 pressed_key.scan_code = ch - '1' + 11;
501 case '7'...'9': /* F6 - F8 */
502 pressed_key.scan_code = ch - '7' + 16;
504 case 'A'...'D': /* up, down right, left */
505 pressed_key.scan_code = ch - 'A' + 1;
508 pressed_key.scan_code = 6; /* End */
511 pressed_key.scan_code = 5; /* Home */
516 ch = skip_modifiers(NULL);
518 case '0'...'1': /* F9 - F10 */
519 pressed_key.scan_code = ch - '0' + 19;
521 case '3'...'4': /* F11 - F12 */
522 pressed_key.scan_code = ch - '3' + 21;
525 pressed_key.scan_code = 7;
530 pressed_key.scan_code = 8;
531 skip_modifiers(NULL);
533 case '5': /* PG UP */
534 pressed_key.scan_code = 9;
535 skip_modifiers(NULL);
537 case '6': /* PG DOWN */
538 pressed_key.scan_code = 10;
539 skip_modifiers(NULL);
544 } else if (ch == 0x7f) {
548 if (!pressed_key.scan_code)
549 pressed_key.unicode_char = ch;
552 return EFI_EXIT(EFI_SUCCESS);
555 struct efi_simple_input_interface efi_con_in = {
556 .reset = efi_cin_reset,
557 .read_key_stroke = efi_cin_read_key_stroke,
558 .wait_for_key = NULL,
561 static struct efi_event *console_timer_event;
563 static void EFIAPI efi_key_notify(struct efi_event *event, void *context)
568 * Notification function of the console timer event.
570 * event: console timer event
573 static void EFIAPI efi_console_timer_notify(struct efi_event *event,
576 EFI_ENTRY("%p, %p", event, context);
578 /* Check if input is available */
580 /* Queue the wait for key event */
581 efi_con_in.wait_for_key->is_signaled = true;
582 efi_signal_event(efi_con_in.wait_for_key, true);
584 EFI_EXIT(EFI_SUCCESS);
587 /* This gets called from do_bootefi_exec(). */
588 int efi_console_register(void)
591 struct efi_object *efi_console_output_obj;
592 struct efi_object *efi_console_input_obj;
594 /* Set up mode information */
595 query_console_size();
598 r = efi_create_handle((efi_handle_t *)&efi_console_output_obj);
599 if (r != EFI_SUCCESS)
601 r = efi_add_protocol(efi_console_output_obj->handle,
602 &efi_guid_text_output_protocol, &efi_con_out);
603 if (r != EFI_SUCCESS)
605 r = efi_create_handle((efi_handle_t *)&efi_console_input_obj);
606 if (r != EFI_SUCCESS)
608 r = efi_add_protocol(efi_console_input_obj->handle,
609 &efi_guid_text_input_protocol, &efi_con_in);
610 if (r != EFI_SUCCESS)
613 /* Create console events */
614 r = efi_create_event(EVT_NOTIFY_WAIT, TPL_CALLBACK, efi_key_notify,
615 NULL, NULL, &efi_con_in.wait_for_key);
616 if (r != EFI_SUCCESS) {
617 printf("ERROR: Failed to register WaitForKey event\n");
620 r = efi_create_event(EVT_TIMER | EVT_NOTIFY_SIGNAL, TPL_CALLBACK,
621 efi_console_timer_notify, NULL, NULL,
622 &console_timer_event);
623 if (r != EFI_SUCCESS) {
624 printf("ERROR: Failed to register console event\n");
627 /* 5000 ns cycle is sufficient for 2 MBaud */
628 r = efi_set_timer(console_timer_event, EFI_TIMER_PERIODIC, 50);
629 if (r != EFI_SUCCESS)
630 printf("ERROR: Failed to set console timer\n");
633 printf("ERROR: Out of meemory\n");