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_input_ex_protocol =
46 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL_GUID;
47 const efi_guid_t efi_guid_text_input_protocol =
48 EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID;
49 const efi_guid_t efi_guid_text_output_protocol =
50 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID;
55 /* Default to mode 0 */
56 static struct simple_text_output_mode efi_con_mode = {
66 * Receive and parse a reply from the terminal.
68 * @n: array of return values
69 * @num: number of return values expected
70 * @end_char: character indicating end of terminal message
71 * @return: non-zero indicates error
73 static int term_read_reply(int *n, int num, char end_char)
94 } else if (c == end_char) {
96 } else if (c > '9' || c < '0') {
100 /* Read one more decimal position */
110 static efi_status_t EFIAPI efi_cout_output_string(
111 struct efi_simple_text_output_protocol *this,
112 const efi_string_t string)
114 struct simple_text_output_mode *con = &efi_con_mode;
115 struct cout_mode *mode = &efi_cout_modes[con->mode];
118 efi_status_t ret = EFI_SUCCESS;
120 EFI_ENTRY("%p, %p", this, string);
122 buf = malloc(utf16_utf8_strlen(string) + 1);
124 ret = EFI_OUT_OF_RESOURCES;
128 utf16_utf8_strcpy(&pos, string);
133 * Update the cursor position.
135 * The UEFI spec provides advance rules for U+0000, U+0008, U+000A,
136 * and U000D. All other characters, including control characters
137 * U+0007 (BEL) and U+0009 (TAB), have to increase the column by one.
139 for (p = string; *p; ++p) {
141 case '\b': /* U+0008, backspace */
142 con->cursor_column = max(0, con->cursor_column - 1);
144 case '\n': /* U+000A, newline */
145 con->cursor_column = 0;
148 case '\r': /* U+000D, carriage-return */
149 con->cursor_column = 0;
151 case 0xd800 ... 0xdbff:
153 * Ignore high surrogates, we do not want to count a
154 * Unicode character twice.
158 con->cursor_column++;
161 if (con->cursor_column >= mode->columns) {
162 con->cursor_column = 0;
165 con->cursor_row = min(con->cursor_row, (s32)mode->rows - 1);
169 return EFI_EXIT(ret);
172 static efi_status_t EFIAPI efi_cout_test_string(
173 struct efi_simple_text_output_protocol *this,
174 const efi_string_t string)
176 EFI_ENTRY("%p, %p", this, string);
177 return EFI_EXIT(EFI_SUCCESS);
180 static bool cout_mode_matches(struct cout_mode *mode, int rows, int cols)
185 return (mode->rows == rows) && (mode->columns == cols);
188 static int query_console_serial(int *rows, int *cols)
190 /* Ask the terminal about its size */
194 /* Empty input buffer */
200 /* Check if we have a terminal that understands */
201 timeout = timer_get_us() + 1000000;
203 if (timer_get_us() > timeout)
206 /* Read {depth,rows,cols} */
207 if (term_read_reply(n, 3, 't'))
217 * Update the mode table.
219 * By default the only mode available is 80x25. If the console has at least 50
220 * lines, enable mode 80x50. If we can query the console size and it is neither
221 * 80x25 nor 80x50, set it as an additional mode.
223 static void query_console_size(void)
225 const char *stdout_name = env_get("stdout");
226 int rows = 25, cols = 80;
228 if (stdout_name && !strcmp(stdout_name, "vidconsole") &&
229 IS_ENABLED(CONFIG_DM_VIDEO)) {
230 struct stdio_dev *stdout_dev =
231 stdio_get_by_name("vidconsole");
232 struct udevice *dev = stdout_dev->priv;
233 struct vidconsole_priv *priv =
234 dev_get_uclass_priv(dev);
237 } else if (query_console_serial(&rows, &cols)) {
241 /* Test if we can have Mode 1 */
242 if (cols >= 80 && rows >= 50) {
243 efi_cout_modes[1].present = 1;
244 efi_con_mode.max_mode = 2;
248 * Install our mode as mode 2 if it is different
249 * than mode 0 or 1 and set it as the currently selected mode
251 if (!cout_mode_matches(&efi_cout_modes[0], rows, cols) &&
252 !cout_mode_matches(&efi_cout_modes[1], rows, cols)) {
253 efi_cout_modes[EFI_COUT_MODE_2].columns = cols;
254 efi_cout_modes[EFI_COUT_MODE_2].rows = rows;
255 efi_cout_modes[EFI_COUT_MODE_2].present = 1;
256 efi_con_mode.max_mode = EFI_MAX_COUT_MODE;
257 efi_con_mode.mode = EFI_COUT_MODE_2;
261 static efi_status_t EFIAPI efi_cout_query_mode(
262 struct efi_simple_text_output_protocol *this,
263 unsigned long mode_number, unsigned long *columns,
266 EFI_ENTRY("%p, %ld, %p, %p", this, mode_number, columns, rows);
268 if (mode_number >= efi_con_mode.max_mode)
269 return EFI_EXIT(EFI_UNSUPPORTED);
271 if (efi_cout_modes[mode_number].present != 1)
272 return EFI_EXIT(EFI_UNSUPPORTED);
275 *columns = efi_cout_modes[mode_number].columns;
277 *rows = efi_cout_modes[mode_number].rows;
279 return EFI_EXIT(EFI_SUCCESS);
282 static efi_status_t EFIAPI efi_cout_set_mode(
283 struct efi_simple_text_output_protocol *this,
284 unsigned long mode_number)
286 EFI_ENTRY("%p, %ld", this, mode_number);
289 if (mode_number > efi_con_mode.max_mode)
290 return EFI_EXIT(EFI_UNSUPPORTED);
292 efi_con_mode.mode = mode_number;
293 efi_con_mode.cursor_column = 0;
294 efi_con_mode.cursor_row = 0;
296 return EFI_EXIT(EFI_SUCCESS);
299 static const struct {
303 { 30, 40 }, /* 0: black */
304 { 34, 44 }, /* 1: blue */
305 { 32, 42 }, /* 2: green */
306 { 36, 46 }, /* 3: cyan */
307 { 31, 41 }, /* 4: red */
308 { 35, 45 }, /* 5: magenta */
309 { 33, 43 }, /* 6: brown, map to yellow as EDK2 does*/
310 { 37, 47 }, /* 7: light gray, map to white */
313 /* See EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetAttribute(). */
314 static efi_status_t EFIAPI efi_cout_set_attribute(
315 struct efi_simple_text_output_protocol *this,
316 unsigned long attribute)
318 unsigned int bold = EFI_ATTR_BOLD(attribute);
319 unsigned int fg = EFI_ATTR_FG(attribute);
320 unsigned int bg = EFI_ATTR_BG(attribute);
322 EFI_ENTRY("%p, %lx", this, attribute);
325 printf(ESC"[%u;%u;%um", bold, color[fg].fg, color[bg].bg);
327 printf(ESC"[0;37;40m");
329 return EFI_EXIT(EFI_SUCCESS);
332 static efi_status_t EFIAPI efi_cout_clear_screen(
333 struct efi_simple_text_output_protocol *this)
335 EFI_ENTRY("%p", this);
338 efi_con_mode.cursor_column = 0;
339 efi_con_mode.cursor_row = 0;
341 return EFI_EXIT(EFI_SUCCESS);
344 static efi_status_t EFIAPI efi_cout_reset(
345 struct efi_simple_text_output_protocol *this,
346 char extended_verification)
348 EFI_ENTRY("%p, %d", this, extended_verification);
351 EFI_CALL(efi_cout_clear_screen(this));
352 /* Set default colors */
353 printf(ESC "[0;37;40m");
355 return EFI_EXIT(EFI_SUCCESS);
358 static efi_status_t EFIAPI efi_cout_set_cursor_position(
359 struct efi_simple_text_output_protocol *this,
360 unsigned long column, unsigned long row)
362 EFI_ENTRY("%p, %ld, %ld", this, column, row);
364 printf(ESC"[%d;%df", (int)row, (int)column);
365 efi_con_mode.cursor_column = column;
366 efi_con_mode.cursor_row = row;
368 return EFI_EXIT(EFI_SUCCESS);
371 static efi_status_t EFIAPI efi_cout_enable_cursor(
372 struct efi_simple_text_output_protocol *this,
375 EFI_ENTRY("%p, %d", this, enable);
377 printf(ESC"[?25%c", enable ? 'h' : 'l');
379 return EFI_EXIT(EFI_SUCCESS);
382 struct efi_simple_text_output_protocol efi_con_out = {
383 .reset = efi_cout_reset,
384 .output_string = efi_cout_output_string,
385 .test_string = efi_cout_test_string,
386 .query_mode = efi_cout_query_mode,
387 .set_mode = efi_cout_set_mode,
388 .set_attribute = efi_cout_set_attribute,
389 .clear_screen = efi_cout_clear_screen,
390 .set_cursor_position = efi_cout_set_cursor_position,
391 .enable_cursor = efi_cout_enable_cursor,
392 .mode = (void*)&efi_con_mode,
395 static bool key_available;
396 static struct efi_key_data next_key;
399 * analyze_modifiers() - analyze modifiers (shift, alt, ctrl) for function keys
401 * This gets called when we have already parsed CSI.
403 * @modifiers: bitmask (shift, alt, ctrl)
404 * @return: the unmodified code
406 static int analyze_modifiers(struct efi_key_state *key_state)
408 int c, mod = 0, ret = 0;
434 key_state->key_shift_state = EFI_SHIFT_STATE_VALID;
437 key_state->key_shift_state |= EFI_LEFT_SHIFT_PRESSED;
439 key_state->key_shift_state |= EFI_LEFT_ALT_PRESSED;
441 key_state->key_shift_state |= EFI_LEFT_CONTROL_PRESSED;
443 key_state->key_shift_state |= EFI_LEFT_LOGO_PRESSED;
451 * efi_cin_read_key() - read a key from the console input
453 * @key: - key received
454 * Return: - status code
456 static efi_status_t efi_cin_read_key(struct efi_key_data *key)
459 struct efi_input_key pressed_key = {
465 ret = console_read_unicode(&ch);
467 return EFI_NOT_READY;
469 key->key_state.key_shift_state = EFI_SHIFT_STATE_INVALID;
470 key->key_state.key_toggle_state = EFI_TOGGLE_STATE_INVALID;
472 /* We do not support multi-word codes */
477 * Xterm Control Sequences
478 * https://www.xfree86.org/4.8.0/ctlseqs.html
483 pressed_key.scan_code = 23;
485 case 'O': /* F1 - F4 */
490 pressed_key.scan_code = ch - 'P' + 11;
498 case 'A'...'D': /* up, down right, left */
499 pressed_key.scan_code = ch - 'A' + 1;
502 pressed_key.scan_code = 6;
505 pressed_key.scan_code = 5;
508 ch = analyze_modifiers(&key->key_state);
510 case '1'...'5': /* F1 - F5 */
511 pressed_key.scan_code = ch - '1' + 11;
513 case '7'...'9': /* F6 - F8 */
514 pressed_key.scan_code = ch - '7' + 16;
516 case 'A'...'D': /* up, down right, left */
517 pressed_key.scan_code = ch - 'A' + 1;
520 pressed_key.scan_code = 6; /* End */
523 pressed_key.scan_code = 5; /* Home */
528 ch = analyze_modifiers(&key->key_state);
530 case '0'...'1': /* F9 - F10 */
531 pressed_key.scan_code = ch - '0' + 19;
533 case '3'...'4': /* F11 - F12 */
534 pressed_key.scan_code = ch - '3' + 21;
537 pressed_key.scan_code = 7;
542 pressed_key.scan_code = 8;
543 analyze_modifiers(&key->key_state);
545 case '5': /* PG UP */
546 pressed_key.scan_code = 9;
547 analyze_modifiers(&key->key_state);
549 case '6': /* PG DOWN */
550 pressed_key.scan_code = 10;
551 analyze_modifiers(&key->key_state);
556 } else if (ch == 0x7f) {
560 if (pressed_key.scan_code) {
561 key->key_state.key_shift_state |= EFI_SHIFT_STATE_VALID;
563 pressed_key.unicode_char = ch;
566 * Assume left control key for control characters typically
567 * entered using the control key.
569 if (ch >= 0x01 && ch <= 0x1f) {
570 key->key_state.key_shift_state =
571 EFI_SHIFT_STATE_VALID;
576 key->key_state.key_shift_state |=
577 EFI_LEFT_CONTROL_PRESSED;
581 key->key = pressed_key;
587 * efi_cin_check() - check if keyboard input is available
589 static void efi_cin_check(void)
594 efi_signal_event(efi_con_in.wait_for_key, true);
599 ret = efi_cin_read_key(&next_key);
600 if (ret == EFI_SUCCESS) {
601 key_available = true;
603 /* Queue the wait for key event */
604 efi_signal_event(efi_con_in.wait_for_key, true);
610 * efi_cin_empty_buffer() - empty input buffer
612 static void efi_cin_empty_buffer(void)
616 key_available = false;
620 * efi_cin_reset_ex() - reset console input
622 * @this: - the extended simple text input protocol
623 * @extended_verification: - extended verification
625 * This function implements the reset service of the
626 * EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.
628 * See the Unified Extensible Firmware Interface (UEFI) specification for
631 * Return: old value of the task priority level
633 static efi_status_t EFIAPI efi_cin_reset_ex(
634 struct efi_simple_text_input_ex_protocol *this,
635 bool extended_verification)
637 efi_status_t ret = EFI_SUCCESS;
639 EFI_ENTRY("%p, %d", this, extended_verification);
641 /* Check parameters */
643 ret = EFI_INVALID_PARAMETER;
647 efi_cin_empty_buffer();
649 return EFI_EXIT(ret);
653 * efi_cin_read_key_stroke_ex() - read key stroke
655 * @this: instance of the EFI_SIMPLE_TEXT_INPUT_PROTOCOL
656 * @key_data: key read from console
657 * Return: status code
659 * This function implements the ReadKeyStrokeEx service of the
660 * EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.
662 * See the Unified Extensible Firmware Interface (UEFI) specification for
665 static efi_status_t EFIAPI efi_cin_read_key_stroke_ex(
666 struct efi_simple_text_input_ex_protocol *this,
667 struct efi_key_data *key_data)
669 efi_status_t ret = EFI_SUCCESS;
671 EFI_ENTRY("%p, %p", this, key_data);
673 /* Check parameters */
674 if (!this || !key_data) {
675 ret = EFI_INVALID_PARAMETER;
679 /* We don't do interrupts, so check for timers cooperatively */
682 /* Enable console input after ExitBootServices */
685 if (!key_available) {
689 *key_data = next_key;
690 key_available = false;
691 efi_con_in.wait_for_key->is_signaled = false;
693 return EFI_EXIT(ret);
697 * efi_cin_set_state() - set toggle key state
699 * @this: instance of the EFI_SIMPLE_TEXT_INPUT_PROTOCOL
700 * @key_toggle_state: key toggle state
701 * Return: status code
703 * This function implements the SetState service of the
704 * EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.
706 * See the Unified Extensible Firmware Interface (UEFI) specification for
709 static efi_status_t EFIAPI efi_cin_set_state(
710 struct efi_simple_text_input_ex_protocol *this,
713 EFI_ENTRY("%p, %u", this, key_toggle_state);
715 * U-Boot supports multiple console input sources like serial and
716 * net console for which a key toggle state cannot be set at all.
718 * According to the UEFI specification it is allowable to not implement
721 return EFI_EXIT(EFI_UNSUPPORTED);
725 * efi_cin_register_key_notify() - register key notification function
727 * @this: instance of the EFI_SIMPLE_TEXT_INPUT_PROTOCOL
728 * @key_data: key to be notified
729 * @key_notify_function: function to be called if the key is pressed
730 * @notify_handle: handle for unregistering the notification
731 * Return: status code
733 * This function implements the SetState service of the
734 * EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.
736 * See the Unified Extensible Firmware Interface (UEFI) specification for
739 static efi_status_t EFIAPI efi_cin_register_key_notify(
740 struct efi_simple_text_input_ex_protocol *this,
741 struct efi_key_data *key_data,
742 efi_status_t (EFIAPI *key_notify_function)(
743 struct efi_key_data *key_data),
744 void **notify_handle)
746 EFI_ENTRY("%p, %p, %p, %p",
747 this, key_data, key_notify_function, notify_handle);
748 return EFI_EXIT(EFI_OUT_OF_RESOURCES);
752 * efi_cin_unregister_key_notify() - unregister key notification function
754 * @this: instance of the EFI_SIMPLE_TEXT_INPUT_PROTOCOL
755 * @notification_handle: handle received when registering
756 * Return: status code
758 * This function implements the SetState service of the
759 * EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.
761 * See the Unified Extensible Firmware Interface (UEFI) specification for
764 static efi_status_t EFIAPI efi_cin_unregister_key_notify(
765 struct efi_simple_text_input_ex_protocol *this,
766 void *notification_handle)
768 EFI_ENTRY("%p, %p", this, notification_handle);
769 return EFI_EXIT(EFI_INVALID_PARAMETER);
774 * efi_cin_reset() - drain the input buffer
776 * @this: instance of the EFI_SIMPLE_TEXT_INPUT_PROTOCOL
777 * @extended_verification: allow for exhaustive verification
778 * Return: status code
780 * This function implements the Reset service of the
781 * EFI_SIMPLE_TEXT_INPUT_PROTOCOL.
783 * See the Unified Extensible Firmware Interface (UEFI) specification for
786 static efi_status_t EFIAPI efi_cin_reset
787 (struct efi_simple_text_input_protocol *this,
788 bool extended_verification)
790 efi_status_t ret = EFI_SUCCESS;
792 EFI_ENTRY("%p, %d", this, extended_verification);
794 /* Check parameters */
796 ret = EFI_INVALID_PARAMETER;
800 efi_cin_empty_buffer();
802 return EFI_EXIT(ret);
806 * efi_cin_read_key_stroke() - read key stroke
808 * @this: instance of the EFI_SIMPLE_TEXT_INPUT_PROTOCOL
809 * @key: key read from console
810 * Return: status code
812 * This function implements the ReadKeyStroke service of the
813 * EFI_SIMPLE_TEXT_INPUT_PROTOCOL.
815 * See the Unified Extensible Firmware Interface (UEFI) specification for
818 static efi_status_t EFIAPI efi_cin_read_key_stroke
819 (struct efi_simple_text_input_protocol *this,
820 struct efi_input_key *key)
822 efi_status_t ret = EFI_SUCCESS;
824 EFI_ENTRY("%p, %p", this, key);
826 /* Check parameters */
828 ret = EFI_INVALID_PARAMETER;
832 /* We don't do interrupts, so check for timers cooperatively */
835 /* Enable console input after ExitBootServices */
838 if (!key_available) {
843 key_available = false;
844 efi_con_in.wait_for_key->is_signaled = false;
846 return EFI_EXIT(ret);
849 static struct efi_simple_text_input_ex_protocol efi_con_in_ex = {
850 .reset = efi_cin_reset_ex,
851 .read_key_stroke_ex = efi_cin_read_key_stroke_ex,
852 .wait_for_key_ex = NULL,
853 .set_state = efi_cin_set_state,
854 .register_key_notify = efi_cin_register_key_notify,
855 .unregister_key_notify = efi_cin_unregister_key_notify,
858 struct efi_simple_text_input_protocol efi_con_in = {
859 .reset = efi_cin_reset,
860 .read_key_stroke = efi_cin_read_key_stroke,
861 .wait_for_key = NULL,
864 static struct efi_event *console_timer_event;
867 * efi_console_timer_notify() - notify the console timer event
869 * @event: console timer event
872 static void EFIAPI efi_console_timer_notify(struct efi_event *event,
875 EFI_ENTRY("%p, %p", event, context);
877 EFI_EXIT(EFI_SUCCESS);
881 * efi_key_notify() - notify the wait for key event
883 * @event: wait for key event
886 static void EFIAPI efi_key_notify(struct efi_event *event, void *context)
888 EFI_ENTRY("%p, %p", event, context);
890 EFI_EXIT(EFI_SUCCESS);
894 * efi_console_register() - install the console protocols
896 * This function is called from do_bootefi_exec().
898 int efi_console_register(void)
901 struct efi_object *efi_console_output_obj;
902 struct efi_object *efi_console_input_obj;
904 /* Set up mode information */
905 query_console_size();
908 r = efi_create_handle((efi_handle_t *)&efi_console_output_obj);
909 if (r != EFI_SUCCESS)
912 r = efi_add_protocol(efi_console_output_obj->handle,
913 &efi_guid_text_output_protocol, &efi_con_out);
914 if (r != EFI_SUCCESS)
916 systab.con_out_handle = efi_console_output_obj->handle;
917 systab.stderr_handle = efi_console_output_obj->handle;
919 r = efi_create_handle((efi_handle_t *)&efi_console_input_obj);
920 if (r != EFI_SUCCESS)
923 r = efi_add_protocol(efi_console_input_obj->handle,
924 &efi_guid_text_input_protocol, &efi_con_in);
925 if (r != EFI_SUCCESS)
927 systab.con_in_handle = efi_console_input_obj->handle;
928 r = efi_add_protocol(efi_console_input_obj->handle,
929 &efi_guid_text_input_ex_protocol, &efi_con_in_ex);
930 if (r != EFI_SUCCESS)
933 /* Create console events */
934 r = efi_create_event(EVT_NOTIFY_WAIT, TPL_CALLBACK, efi_key_notify,
935 NULL, NULL, &efi_con_in.wait_for_key);
936 if (r != EFI_SUCCESS) {
937 printf("ERROR: Failed to register WaitForKey event\n");
940 efi_con_in_ex.wait_for_key_ex = efi_con_in.wait_for_key;
941 r = efi_create_event(EVT_TIMER | EVT_NOTIFY_SIGNAL, TPL_CALLBACK,
942 efi_console_timer_notify, NULL, NULL,
943 &console_timer_event);
944 if (r != EFI_SUCCESS) {
945 printf("ERROR: Failed to register console event\n");
948 /* 5000 ns cycle is sufficient for 2 MBaud */
949 r = efi_set_timer(console_timer_event, EFI_TIMER_PERIODIC, 50);
950 if (r != EFI_SUCCESS)
951 printf("ERROR: Failed to set console timer\n");
954 printf("ERROR: Out of memory\n");