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>
13 #include <stdio_dev.h>
14 #include <video_console.h>
16 #define EFI_COUT_MODE_2 2
17 #define EFI_MAX_COUT_MODE 3
20 unsigned long columns;
25 static struct cout_mode efi_cout_modes[] = {
26 /* EFI Mode 0 is 80x25 and always present */
32 /* EFI Mode 1 is always 80x50 */
38 /* Value are unknown until we query the console */
46 const efi_guid_t efi_guid_text_input_ex_protocol =
47 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL_GUID;
48 const efi_guid_t efi_guid_text_input_protocol =
49 EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID;
50 const efi_guid_t efi_guid_text_output_protocol =
51 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID;
56 /* Default to mode 0 */
57 static struct simple_text_output_mode efi_con_mode = {
66 static int term_get_char(s32 *c)
70 /* Wait up to 100 ms for a character */
71 timeout = timer_get_us() + 100000;
74 if (timer_get_us() > timeout)
82 * Receive and parse a reply from the terminal.
84 * @n: array of return values
85 * @num: number of return values expected
86 * @end_char: character indicating end of terminal message
87 * @return: non-zero indicates error
89 static int term_read_reply(int *n, int num, char end_char)
94 if (term_get_char(&c) || c != cESC)
97 if (term_get_char(&c) || c != '[')
102 if (!term_get_char(&c)) {
109 } else if (c == end_char) {
111 } else if (c > '9' || c < '0') {
115 /* Read one more decimal position */
128 static efi_status_t EFIAPI efi_cout_output_string(
129 struct efi_simple_text_output_protocol *this,
130 const efi_string_t string)
132 struct simple_text_output_mode *con = &efi_con_mode;
133 struct cout_mode *mode = &efi_cout_modes[con->mode];
136 efi_status_t ret = EFI_SUCCESS;
138 EFI_ENTRY("%p, %p", this, string);
140 if (!this || !string) {
141 ret = EFI_INVALID_PARAMETER;
145 buf = malloc(utf16_utf8_strlen(string) + 1);
147 ret = EFI_OUT_OF_RESOURCES;
151 utf16_utf8_strcpy(&pos, string);
156 * Update the cursor position.
158 * The UEFI spec provides advance rules for U+0000, U+0008, U+000A,
159 * and U000D. All other control characters are ignored. Any non-control
160 * character increase the column by one.
162 for (p = string; *p; ++p) {
164 case '\b': /* U+0008, backspace */
165 if (con->cursor_column)
166 con->cursor_column--;
168 case '\n': /* U+000A, newline */
169 con->cursor_column = 0;
172 case '\r': /* U+000D, carriage-return */
173 con->cursor_column = 0;
175 case 0xd800 ... 0xdbff:
177 * Ignore high surrogates, we do not want to count a
178 * Unicode character twice.
182 /* Exclude control codes */
184 con->cursor_column++;
187 if (con->cursor_column >= mode->columns) {
188 con->cursor_column = 0;
192 * When we exceed the row count the terminal will scroll up one
193 * line. We have to adjust the cursor position.
195 if (con->cursor_row >= mode->rows && con->cursor_row)
200 return EFI_EXIT(ret);
203 static efi_status_t EFIAPI efi_cout_test_string(
204 struct efi_simple_text_output_protocol *this,
205 const efi_string_t string)
207 EFI_ENTRY("%p, %p", this, string);
208 return EFI_EXIT(EFI_SUCCESS);
211 static bool cout_mode_matches(struct cout_mode *mode, int rows, int cols)
216 return (mode->rows == rows) && (mode->columns == cols);
220 * query_console_serial() - query console size
222 * @rows pointer to return number of rows
223 * @columns pointer to return number of columns
224 * Returns 0 on success
226 static int query_console_serial(int *rows, int *cols)
231 /* Empty input buffer */
236 * Not all terminals understand CSI [18t for querying the console size.
237 * We should adhere to escape sequences documented in the console_codes
238 * man page and the ECMA-48 standard.
240 * So here we follow a different approach. We position the cursor to the
241 * bottom right and query its position. Before leaving the function we
242 * restore the original cursor position.
244 printf(ESC "7" /* Save cursor position */
245 ESC "[r" /* Set scrolling region to full window */
246 ESC "[999;999H" /* Move to bottom right corner */
247 ESC "[6n"); /* Query cursor position */
249 /* Read {rows,cols} */
250 if (term_read_reply(n, 2, 'R')) {
258 printf(ESC "8"); /* Restore cursor position */
263 * Update the mode table.
265 * By default the only mode available is 80x25. If the console has at least 50
266 * lines, enable mode 80x50. If we can query the console size and it is neither
267 * 80x25 nor 80x50, set it as an additional mode.
269 static void query_console_size(void)
271 const char *stdout_name = env_get("stdout");
272 int rows = 25, cols = 80;
274 if (stdout_name && !strcmp(stdout_name, "vidconsole") &&
275 IS_ENABLED(CONFIG_DM_VIDEO)) {
276 struct stdio_dev *stdout_dev =
277 stdio_get_by_name("vidconsole");
278 struct udevice *dev = stdout_dev->priv;
279 struct vidconsole_priv *priv =
280 dev_get_uclass_priv(dev);
283 } else if (query_console_serial(&rows, &cols)) {
287 /* Test if we can have Mode 1 */
288 if (cols >= 80 && rows >= 50) {
289 efi_cout_modes[1].present = 1;
290 efi_con_mode.max_mode = 2;
294 * Install our mode as mode 2 if it is different
295 * than mode 0 or 1 and set it as the currently selected mode
297 if (!cout_mode_matches(&efi_cout_modes[0], rows, cols) &&
298 !cout_mode_matches(&efi_cout_modes[1], rows, cols)) {
299 efi_cout_modes[EFI_COUT_MODE_2].columns = cols;
300 efi_cout_modes[EFI_COUT_MODE_2].rows = rows;
301 efi_cout_modes[EFI_COUT_MODE_2].present = 1;
302 efi_con_mode.max_mode = EFI_MAX_COUT_MODE;
303 efi_con_mode.mode = EFI_COUT_MODE_2;
307 static efi_status_t EFIAPI efi_cout_query_mode(
308 struct efi_simple_text_output_protocol *this,
309 unsigned long mode_number, unsigned long *columns,
312 EFI_ENTRY("%p, %ld, %p, %p", this, mode_number, columns, rows);
314 if (mode_number >= efi_con_mode.max_mode)
315 return EFI_EXIT(EFI_UNSUPPORTED);
317 if (efi_cout_modes[mode_number].present != 1)
318 return EFI_EXIT(EFI_UNSUPPORTED);
321 *columns = efi_cout_modes[mode_number].columns;
323 *rows = efi_cout_modes[mode_number].rows;
325 return EFI_EXIT(EFI_SUCCESS);
328 static const struct {
332 { 30, 40 }, /* 0: black */
333 { 34, 44 }, /* 1: blue */
334 { 32, 42 }, /* 2: green */
335 { 36, 46 }, /* 3: cyan */
336 { 31, 41 }, /* 4: red */
337 { 35, 45 }, /* 5: magenta */
338 { 33, 43 }, /* 6: brown, map to yellow as EDK2 does*/
339 { 37, 47 }, /* 7: light gray, map to white */
342 /* See EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetAttribute(). */
343 static efi_status_t EFIAPI efi_cout_set_attribute(
344 struct efi_simple_text_output_protocol *this,
345 unsigned long attribute)
347 unsigned int bold = EFI_ATTR_BOLD(attribute);
348 unsigned int fg = EFI_ATTR_FG(attribute);
349 unsigned int bg = EFI_ATTR_BG(attribute);
351 EFI_ENTRY("%p, %lx", this, attribute);
353 efi_con_mode.attribute = attribute;
355 printf(ESC"[%u;%u;%um", bold, color[fg].fg, color[bg].bg);
357 printf(ESC"[0;37;40m");
359 return EFI_EXIT(EFI_SUCCESS);
362 static efi_status_t EFIAPI efi_cout_clear_screen(
363 struct efi_simple_text_output_protocol *this)
365 EFI_ENTRY("%p", this);
368 efi_con_mode.cursor_column = 0;
369 efi_con_mode.cursor_row = 0;
371 return EFI_EXIT(EFI_SUCCESS);
374 static efi_status_t EFIAPI efi_cout_set_mode(
375 struct efi_simple_text_output_protocol *this,
376 unsigned long mode_number)
378 EFI_ENTRY("%p, %ld", this, mode_number);
380 if (mode_number >= efi_con_mode.max_mode)
381 return EFI_EXIT(EFI_UNSUPPORTED);
383 if (!efi_cout_modes[mode_number].present)
384 return EFI_EXIT(EFI_UNSUPPORTED);
386 efi_con_mode.mode = mode_number;
387 EFI_CALL(efi_cout_clear_screen(this));
389 return EFI_EXIT(EFI_SUCCESS);
392 static efi_status_t EFIAPI efi_cout_reset(
393 struct efi_simple_text_output_protocol *this,
394 char extended_verification)
396 EFI_ENTRY("%p, %d", this, extended_verification);
399 EFI_CALL(efi_cout_clear_screen(this));
400 /* Set default colors */
401 efi_con_mode.attribute = 0x07;
402 printf(ESC "[0;37;40m");
404 return EFI_EXIT(EFI_SUCCESS);
407 static efi_status_t EFIAPI efi_cout_set_cursor_position(
408 struct efi_simple_text_output_protocol *this,
409 unsigned long column, unsigned long row)
411 efi_status_t ret = EFI_SUCCESS;
412 struct simple_text_output_mode *con = &efi_con_mode;
413 struct cout_mode *mode = &efi_cout_modes[con->mode];
415 EFI_ENTRY("%p, %ld, %ld", this, column, row);
417 /* Check parameters */
419 ret = EFI_INVALID_PARAMETER;
422 if (row >= mode->rows || column >= mode->columns) {
423 ret = EFI_UNSUPPORTED;
428 * Set cursor position by sending CSI H.
429 * EFI origin is [0, 0], terminal origin is [1, 1].
431 printf(ESC "[%d;%dH", (int)row + 1, (int)column + 1);
432 efi_con_mode.cursor_column = column;
433 efi_con_mode.cursor_row = row;
435 return EFI_EXIT(ret);
438 static efi_status_t EFIAPI efi_cout_enable_cursor(
439 struct efi_simple_text_output_protocol *this,
442 EFI_ENTRY("%p, %d", this, enable);
444 printf(ESC"[?25%c", enable ? 'h' : 'l');
445 efi_con_mode.cursor_visible = !!enable;
447 return EFI_EXIT(EFI_SUCCESS);
450 struct efi_simple_text_output_protocol efi_con_out = {
451 .reset = efi_cout_reset,
452 .output_string = efi_cout_output_string,
453 .test_string = efi_cout_test_string,
454 .query_mode = efi_cout_query_mode,
455 .set_mode = efi_cout_set_mode,
456 .set_attribute = efi_cout_set_attribute,
457 .clear_screen = efi_cout_clear_screen,
458 .set_cursor_position = efi_cout_set_cursor_position,
459 .enable_cursor = efi_cout_enable_cursor,
460 .mode = (void*)&efi_con_mode,
464 * struct efi_cin_notify_function - registered console input notify function
466 * @link: link to list
467 * @data: key to notify
468 * @function: function to call
470 struct efi_cin_notify_function {
471 struct list_head link;
472 struct efi_key_data key;
473 efi_status_t (EFIAPI *function)
474 (struct efi_key_data *key_data);
477 static bool key_available;
478 static struct efi_key_data next_key;
479 static LIST_HEAD(cin_notify_functions);
482 * set_shift_mask() - set shift mask
484 * @mod: Xterm shift mask
486 void set_shift_mask(int mod, struct efi_key_state *key_state)
488 key_state->key_shift_state = EFI_SHIFT_STATE_VALID;
492 key_state->key_shift_state |= EFI_LEFT_SHIFT_PRESSED;
494 key_state->key_shift_state |= EFI_LEFT_ALT_PRESSED;
496 key_state->key_shift_state |= EFI_LEFT_CONTROL_PRESSED;
497 if (!mod || (mod & 8))
498 key_state->key_shift_state |= EFI_LEFT_LOGO_PRESSED;
503 * analyze_modifiers() - analyze modifiers (shift, alt, ctrl) for function keys
505 * This gets called when we have already parsed CSI.
507 * @modifiers: bit mask (shift, alt, ctrl)
508 * @return: the unmodified code
510 static int analyze_modifiers(struct efi_key_state *key_state)
512 int c, mod = 0, ret = 0;
536 set_shift_mask(mod, key_state);
543 * efi_cin_read_key() - read a key from the console input
545 * @key: - key received
546 * Return: - status code
548 static efi_status_t efi_cin_read_key(struct efi_key_data *key)
550 struct efi_input_key pressed_key = {
556 if (console_read_unicode(&ch))
557 return EFI_NOT_READY;
559 key->key_state.key_shift_state = EFI_SHIFT_STATE_INVALID;
560 key->key_state.key_toggle_state = EFI_TOGGLE_STATE_INVALID;
562 /* We do not support multi-word codes */
569 * Xterm Control Sequences
570 * https://www.xfree86.org/4.8.0/ctlseqs.html
575 pressed_key.scan_code = 23;
577 case 'O': /* F1 - F4, End */
579 /* consider modifiers */
580 if (ch == 'F') { /* End */
581 pressed_key.scan_code = 6;
583 } else if (ch < 'P') {
584 set_shift_mask(ch - '0', &key->key_state);
587 pressed_key.scan_code = ch - 'P' + 11;
592 case 'A'...'D': /* up, down right, left */
593 pressed_key.scan_code = ch - 'A' + 1;
596 pressed_key.scan_code = 6;
599 pressed_key.scan_code = 5;
602 ch = analyze_modifiers(&key->key_state);
604 case '1'...'5': /* F1 - F5 */
605 pressed_key.scan_code = ch - '1' + 11;
607 case '6'...'9': /* F5 - F8 */
608 pressed_key.scan_code = ch - '6' + 15;
610 case 'A'...'D': /* up, down right, left */
611 pressed_key.scan_code = ch - 'A' + 1;
614 pressed_key.scan_code = 6;
617 pressed_key.scan_code = 5;
620 pressed_key.scan_code = 5;
625 ch = analyze_modifiers(&key->key_state);
627 case '0'...'1': /* F9 - F10 */
628 pressed_key.scan_code = ch - '0' + 19;
630 case '3'...'4': /* F11 - F12 */
631 pressed_key.scan_code = ch - '3' + 21;
634 pressed_key.scan_code = 7;
639 pressed_key.scan_code = 8;
640 analyze_modifiers(&key->key_state);
642 case '5': /* PG UP */
643 pressed_key.scan_code = 9;
644 analyze_modifiers(&key->key_state);
646 case '6': /* PG DOWN */
647 pressed_key.scan_code = 10;
648 analyze_modifiers(&key->key_state);
654 set_shift_mask(3, &key->key_state);
661 if (pressed_key.scan_code) {
662 key->key_state.key_shift_state |= EFI_SHIFT_STATE_VALID;
664 pressed_key.unicode_char = ch;
667 * Assume left control key for control characters typically
668 * entered using the control key.
670 if (ch >= 0x01 && ch <= 0x1f) {
671 key->key_state.key_shift_state |=
672 EFI_SHIFT_STATE_VALID;
677 key->key_state.key_shift_state |=
678 EFI_LEFT_CONTROL_PRESSED;
682 key->key = pressed_key;
688 * efi_cin_notify() - notify registered functions
690 static void efi_cin_notify(void)
692 struct efi_cin_notify_function *item;
694 list_for_each_entry(item, &cin_notify_functions, link) {
697 /* We do not support toggle states */
698 if (item->key.key.unicode_char || item->key.key.scan_code) {
699 if (item->key.key.unicode_char !=
700 next_key.key.unicode_char ||
701 item->key.key.scan_code != next_key.key.scan_code)
704 if (item->key.key_state.key_shift_state &&
705 item->key.key_state.key_shift_state !=
706 next_key.key_state.key_shift_state)
710 /* We don't bother about the return code */
711 EFI_CALL(item->function(&next_key));
716 * efi_cin_check() - check if keyboard input is available
718 static void efi_cin_check(void)
723 efi_signal_event(efi_con_in.wait_for_key);
728 ret = efi_cin_read_key(&next_key);
729 if (ret == EFI_SUCCESS) {
730 key_available = true;
732 /* Notify registered functions */
735 /* Queue the wait for key event */
737 efi_signal_event(efi_con_in.wait_for_key);
743 * efi_cin_empty_buffer() - empty input buffer
745 static void efi_cin_empty_buffer(void)
749 key_available = false;
753 * efi_cin_reset_ex() - reset console input
755 * @this: - the extended simple text input protocol
756 * @extended_verification: - extended verification
758 * This function implements the reset service of the
759 * EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.
761 * See the Unified Extensible Firmware Interface (UEFI) specification for
764 * Return: old value of the task priority level
766 static efi_status_t EFIAPI efi_cin_reset_ex(
767 struct efi_simple_text_input_ex_protocol *this,
768 bool extended_verification)
770 efi_status_t ret = EFI_SUCCESS;
772 EFI_ENTRY("%p, %d", this, extended_verification);
774 /* Check parameters */
776 ret = EFI_INVALID_PARAMETER;
780 efi_cin_empty_buffer();
782 return EFI_EXIT(ret);
786 * efi_cin_read_key_stroke_ex() - read key stroke
788 * @this: instance of the EFI_SIMPLE_TEXT_INPUT_PROTOCOL
789 * @key_data: key read from console
790 * Return: status code
792 * This function implements the ReadKeyStrokeEx service of the
793 * EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.
795 * See the Unified Extensible Firmware Interface (UEFI) specification for
798 static efi_status_t EFIAPI efi_cin_read_key_stroke_ex(
799 struct efi_simple_text_input_ex_protocol *this,
800 struct efi_key_data *key_data)
802 efi_status_t ret = EFI_SUCCESS;
804 EFI_ENTRY("%p, %p", this, key_data);
806 /* Check parameters */
807 if (!this || !key_data) {
808 ret = EFI_INVALID_PARAMETER;
812 /* We don't do interrupts, so check for timers cooperatively */
815 /* Enable console input after ExitBootServices */
818 if (!key_available) {
823 * CTRL+A - CTRL+Z have to be signaled as a - z.
824 * SHIFT+CTRL+A - SHIFT+CTRL+Z have to be signaled as A - Z.
826 switch (next_key.key.unicode_char) {
830 if (!(next_key.key_state.key_toggle_state &
831 EFI_CAPS_LOCK_ACTIVE) ^
832 !(next_key.key_state.key_shift_state &
833 (EFI_LEFT_SHIFT_PRESSED | EFI_RIGHT_SHIFT_PRESSED)))
834 next_key.key.unicode_char += 0x40;
836 next_key.key.unicode_char += 0x60;
838 *key_data = next_key;
839 key_available = false;
840 efi_con_in.wait_for_key->is_signaled = false;
843 return EFI_EXIT(ret);
847 * efi_cin_set_state() - set toggle key state
849 * @this: instance of the EFI_SIMPLE_TEXT_INPUT_PROTOCOL
850 * @key_toggle_state: pointer to key toggle state
851 * Return: status code
853 * This function implements the SetState service of the
854 * EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.
856 * See the Unified Extensible Firmware Interface (UEFI) specification for
859 static efi_status_t EFIAPI efi_cin_set_state(
860 struct efi_simple_text_input_ex_protocol *this,
861 u8 *key_toggle_state)
863 EFI_ENTRY("%p, %p", this, key_toggle_state);
865 * U-Boot supports multiple console input sources like serial and
866 * net console for which a key toggle state cannot be set at all.
868 * According to the UEFI specification it is allowable to not implement
871 return EFI_EXIT(EFI_UNSUPPORTED);
875 * efi_cin_register_key_notify() - register key notification function
877 * @this: instance of the EFI_SIMPLE_TEXT_INPUT_PROTOCOL
878 * @key_data: key to be notified
879 * @key_notify_function: function to be called if the key is pressed
880 * @notify_handle: handle for unregistering the notification
881 * Return: status code
883 * This function implements the SetState service of the
884 * EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.
886 * See the Unified Extensible Firmware Interface (UEFI) specification for
889 static efi_status_t EFIAPI efi_cin_register_key_notify(
890 struct efi_simple_text_input_ex_protocol *this,
891 struct efi_key_data *key_data,
892 efi_status_t (EFIAPI *key_notify_function)(
893 struct efi_key_data *key_data),
894 void **notify_handle)
896 efi_status_t ret = EFI_SUCCESS;
897 struct efi_cin_notify_function *notify_function;
899 EFI_ENTRY("%p, %p, %p, %p",
900 this, key_data, key_notify_function, notify_handle);
902 /* Check parameters */
903 if (!this || !key_data || !key_notify_function || !notify_handle) {
904 ret = EFI_INVALID_PARAMETER;
908 EFI_PRINT("u+%04x, sc %04x, sh %08x, tg %02x\n",
909 key_data->key.unicode_char,
910 key_data->key.scan_code,
911 key_data->key_state.key_shift_state,
912 key_data->key_state.key_toggle_state);
914 notify_function = calloc(1, sizeof(struct efi_cin_notify_function));
915 if (!notify_function) {
916 ret = EFI_OUT_OF_RESOURCES;
919 notify_function->key = *key_data;
920 notify_function->function = key_notify_function;
921 list_add_tail(¬ify_function->link, &cin_notify_functions);
922 *notify_handle = notify_function;
924 return EFI_EXIT(ret);
928 * efi_cin_unregister_key_notify() - unregister key notification function
930 * @this: instance of the EFI_SIMPLE_TEXT_INPUT_PROTOCOL
931 * @notification_handle: handle received when registering
932 * Return: status code
934 * This function implements the SetState service of the
935 * EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.
937 * See the Unified Extensible Firmware Interface (UEFI) specification for
940 static efi_status_t EFIAPI efi_cin_unregister_key_notify(
941 struct efi_simple_text_input_ex_protocol *this,
942 void *notification_handle)
944 efi_status_t ret = EFI_INVALID_PARAMETER;
945 struct efi_cin_notify_function *item, *notify_function =
948 EFI_ENTRY("%p, %p", this, notification_handle);
950 /* Check parameters */
951 if (!this || !notification_handle)
954 list_for_each_entry(item, &cin_notify_functions, link) {
955 if (item == notify_function) {
960 if (ret != EFI_SUCCESS)
963 /* Remove the notify function */
964 list_del(¬ify_function->link);
965 free(notify_function);
967 return EFI_EXIT(ret);
972 * efi_cin_reset() - drain the input buffer
974 * @this: instance of the EFI_SIMPLE_TEXT_INPUT_PROTOCOL
975 * @extended_verification: allow for exhaustive verification
976 * Return: status code
978 * This function implements the Reset service of the
979 * EFI_SIMPLE_TEXT_INPUT_PROTOCOL.
981 * See the Unified Extensible Firmware Interface (UEFI) specification for
984 static efi_status_t EFIAPI efi_cin_reset
985 (struct efi_simple_text_input_protocol *this,
986 bool extended_verification)
988 efi_status_t ret = EFI_SUCCESS;
990 EFI_ENTRY("%p, %d", this, extended_verification);
992 /* Check parameters */
994 ret = EFI_INVALID_PARAMETER;
998 efi_cin_empty_buffer();
1000 return EFI_EXIT(ret);
1004 * efi_cin_read_key_stroke() - read key stroke
1006 * @this: instance of the EFI_SIMPLE_TEXT_INPUT_PROTOCOL
1007 * @key: key read from console
1008 * Return: status code
1010 * This function implements the ReadKeyStroke service of the
1011 * EFI_SIMPLE_TEXT_INPUT_PROTOCOL.
1013 * See the Unified Extensible Firmware Interface (UEFI) specification for
1016 static efi_status_t EFIAPI efi_cin_read_key_stroke
1017 (struct efi_simple_text_input_protocol *this,
1018 struct efi_input_key *key)
1020 efi_status_t ret = EFI_SUCCESS;
1022 EFI_ENTRY("%p, %p", this, key);
1024 /* Check parameters */
1025 if (!this || !key) {
1026 ret = EFI_INVALID_PARAMETER;
1030 /* We don't do interrupts, so check for timers cooperatively */
1033 /* Enable console input after ExitBootServices */
1036 if (!key_available) {
1037 ret = EFI_NOT_READY;
1040 *key = next_key.key;
1041 key_available = false;
1042 efi_con_in.wait_for_key->is_signaled = false;
1044 return EFI_EXIT(ret);
1047 static struct efi_simple_text_input_ex_protocol efi_con_in_ex = {
1048 .reset = efi_cin_reset_ex,
1049 .read_key_stroke_ex = efi_cin_read_key_stroke_ex,
1050 .wait_for_key_ex = NULL,
1051 .set_state = efi_cin_set_state,
1052 .register_key_notify = efi_cin_register_key_notify,
1053 .unregister_key_notify = efi_cin_unregister_key_notify,
1056 struct efi_simple_text_input_protocol efi_con_in = {
1057 .reset = efi_cin_reset,
1058 .read_key_stroke = efi_cin_read_key_stroke,
1059 .wait_for_key = NULL,
1062 static struct efi_event *console_timer_event;
1065 * efi_console_timer_notify() - notify the console timer event
1067 * @event: console timer event
1068 * @context: not used
1070 static void EFIAPI efi_console_timer_notify(struct efi_event *event,
1073 EFI_ENTRY("%p, %p", event, context);
1075 EFI_EXIT(EFI_SUCCESS);
1079 * efi_key_notify() - notify the wait for key event
1081 * @event: wait for key event
1082 * @context: not used
1084 static void EFIAPI efi_key_notify(struct efi_event *event, void *context)
1086 EFI_ENTRY("%p, %p", event, context);
1088 EFI_EXIT(EFI_SUCCESS);
1092 * efi_console_register() - install the console protocols
1094 * This function is called from do_bootefi_exec().
1096 * Return: status code
1098 efi_status_t efi_console_register(void)
1101 efi_handle_t console_output_handle;
1102 efi_handle_t console_input_handle;
1104 /* Set up mode information */
1105 query_console_size();
1107 /* Create handles */
1108 r = efi_create_handle(&console_output_handle);
1109 if (r != EFI_SUCCESS)
1112 r = efi_add_protocol(console_output_handle,
1113 &efi_guid_text_output_protocol, &efi_con_out);
1114 if (r != EFI_SUCCESS)
1116 systab.con_out_handle = console_output_handle;
1117 systab.stderr_handle = console_output_handle;
1119 r = efi_create_handle(&console_input_handle);
1120 if (r != EFI_SUCCESS)
1123 r = efi_add_protocol(console_input_handle,
1124 &efi_guid_text_input_protocol, &efi_con_in);
1125 if (r != EFI_SUCCESS)
1127 systab.con_in_handle = console_input_handle;
1128 r = efi_add_protocol(console_input_handle,
1129 &efi_guid_text_input_ex_protocol, &efi_con_in_ex);
1130 if (r != EFI_SUCCESS)
1133 /* Create console events */
1134 r = efi_create_event(EVT_NOTIFY_WAIT, TPL_CALLBACK, efi_key_notify,
1135 NULL, NULL, &efi_con_in.wait_for_key);
1136 if (r != EFI_SUCCESS) {
1137 printf("ERROR: Failed to register WaitForKey event\n");
1140 efi_con_in_ex.wait_for_key_ex = efi_con_in.wait_for_key;
1141 r = efi_create_event(EVT_TIMER | EVT_NOTIFY_SIGNAL, TPL_CALLBACK,
1142 efi_console_timer_notify, NULL, NULL,
1143 &console_timer_event);
1144 if (r != EFI_SUCCESS) {
1145 printf("ERROR: Failed to register console event\n");
1148 /* 5000 ns cycle is sufficient for 2 MBaud */
1149 r = efi_set_timer(console_timer_event, EFI_TIMER_PERIODIC, 50);
1150 if (r != EFI_SUCCESS)
1151 printf("ERROR: Failed to set console timer\n");
1154 printf("ERROR: Out of memory\n");