1 // SPDX-License-Identifier: GPL-2.0+
4 * Paolo Scaffardi, AIRVENT SAM s.p.a - RIMINI(ITALY), arsenio@tin.it
9 #include <debug_uart.h>
18 #include <stdio_dev.h>
20 #include <env_internal.h>
22 #include <linux/delay.h>
24 DECLARE_GLOBAL_DATA_PTR;
26 static int on_console(const char *name, const char *value, enum env_op op,
31 /* Check for console redirection */
32 if (strcmp(name, "stdin") == 0)
34 else if (strcmp(name, "stdout") == 0)
36 else if (strcmp(name, "stderr") == 0)
39 /* if not actually setting a console variable, we don't care */
40 if (console == -1 || (gd->flags & GD_FLG_DEVINIT) == 0)
45 case env_op_overwrite:
47 if (CONFIG_IS_ENABLED(CONSOLE_MUX)) {
48 if (iomux_doenv(console, value))
51 /* Try assigning specified device */
52 if (console_assign(console, value) < 0)
59 if ((flags & H_FORCE) == 0)
60 printf("Can't delete \"%s\"\n", name);
67 U_BOOT_ENV_CALLBACK(console, on_console);
69 #ifdef CONFIG_SILENT_CONSOLE
70 static int on_silent(const char *name, const char *value, enum env_op op,
73 if (!CONFIG_IS_ENABLED(SILENT_CONSOLE_UPDATE_ON_SET))
74 if (flags & H_INTERACTIVE)
77 if (!CONFIG_IS_ENABLED(SILENT_CONSOLE_UPDATE_ON_RELOC))
78 if ((flags & H_INTERACTIVE) == 0)
82 gd->flags |= GD_FLG_SILENT;
84 gd->flags &= ~GD_FLG_SILENT;
88 U_BOOT_ENV_CALLBACK(silent, on_silent);
91 #ifdef CONFIG_CONSOLE_RECORD
92 /* helper function: access to gd->console_out and gd->console_in */
93 static void console_record_putc(const char c)
95 if (!(gd->flags & GD_FLG_RECORD))
97 if (gd->console_out.start)
98 membuff_putbyte((struct membuff *)&gd->console_out, c);
101 static void console_record_puts(const char *s)
103 if (!(gd->flags & GD_FLG_RECORD))
105 if (gd->console_out.start)
106 membuff_put((struct membuff *)&gd->console_out, s, strlen(s));
109 static int console_record_getc(void)
111 if (!(gd->flags & GD_FLG_RECORD))
113 if (!gd->console_in.start)
116 return membuff_getbyte((struct membuff *)&gd->console_in);
119 static int console_record_tstc(void)
121 if (!(gd->flags & GD_FLG_RECORD))
123 if (gd->console_in.start) {
124 if (membuff_peekbyte((struct membuff *)&gd->console_in) != -1)
130 static void console_record_putc(char c)
134 static void console_record_puts(const char *s)
138 static int console_record_getc(void)
143 static int console_record_tstc(void)
149 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
151 * if overwrite_console returns 1, the stdin, stderr and stdout
152 * are switched to the serial port, else the settings in the
153 * environment are used
155 #ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
156 extern int overwrite_console(void);
157 #define OVERWRITE_CONSOLE overwrite_console()
159 #define OVERWRITE_CONSOLE 0
160 #endif /* CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE */
162 #endif /* CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */
164 static int console_setfile(int file, struct stdio_dev * dev)
175 /* Start new device */
177 error = dev->start(dev);
178 /* If it's not started dont use it */
183 /* Assign the new device (leaving the existing one started) */
184 stdio_devices[file] = dev;
187 * Update monitor functions
188 * (to use the console stuff by other applications)
192 gd->jt->getc = getchar;
198 gd->jt->printf = printf;
203 default: /* Invalid file ID */
210 * console_dev_is_serial() - Check if a stdio device is a serial device
212 * @sdev: Device to check
213 * @return true if this device is in the serial uclass (or for pre-driver-model,
214 * whether it is called "serial".
216 static bool console_dev_is_serial(struct stdio_dev *sdev)
220 if (IS_ENABLED(CONFIG_DM_SERIAL) && (sdev->flags & DEV_FLAGS_DM)) {
221 struct udevice *dev = sdev->priv;
223 is_serial = device_get_uclass_id(dev) == UCLASS_SERIAL;
225 is_serial = !strcmp(sdev->name, "serial");
231 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
232 /** Console I/O multiplexing *******************************************/
234 /* tstcdev: save the last stdio device with pending characters, with tstc != 0 */
235 static struct stdio_dev *tstcdev;
236 struct stdio_dev **console_devices[MAX_FILES];
237 int cd_count[MAX_FILES];
239 static void __maybe_unused console_devices_set(int file, struct stdio_dev *dev)
241 console_devices[file][0] = dev;
245 * This depends on tstc() always being called before getchar().
246 * This is guaranteed to be true because this routine is called
247 * only from fgetc() which assures it.
248 * No attempt is made to demultiplex multiple input sources.
250 static int console_getc(int file)
254 /* This is never called with testcdev == NULL */
255 ret = tstcdev->getc(tstcdev);
260 /* Upper layer may have already called tstc(): check the saved result */
261 static bool console_has_tstc(void)
266 static int console_tstc(int file)
269 struct stdio_dev *dev;
272 prev = disable_ctrlc(1);
273 for (i = 0; i < cd_count[file]; i++) {
274 dev = console_devices[file][i];
275 if (dev->tstc != NULL) {
276 ret = dev->tstc(dev);
289 static void console_putc(int file, const char c)
292 struct stdio_dev *dev;
294 for (i = 0; i < cd_count[file]; i++) {
295 dev = console_devices[file][i];
296 if (dev->putc != NULL)
302 * console_puts_select() - Output a string to all console devices
304 * @file: File number to output to (e,g, stdout, see stdio.h)
305 * @serial_only: true to output only to serial, false to output to everything
307 * @s: String to output
309 static void console_puts_select(int file, bool serial_only, const char *s)
312 struct stdio_dev *dev;
314 for (i = 0; i < cd_count[file]; i++) {
317 dev = console_devices[file][i];
318 is_serial = console_dev_is_serial(dev);
319 if (dev->puts && serial_only == is_serial)
324 void console_puts_select_stderr(bool serial_only, const char *s)
326 console_puts_select(stderr, serial_only, s);
329 static void console_puts(int file, const char *s)
332 struct stdio_dev *dev;
334 for (i = 0; i < cd_count[file]; i++) {
335 dev = console_devices[file][i];
336 if (dev->puts != NULL)
341 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
342 static inline void console_doenv(int file, struct stdio_dev *dev)
344 iomux_doenv(file, dev->name);
349 static void __maybe_unused console_devices_set(int file, struct stdio_dev *dev)
353 static inline int console_getc(int file)
355 return stdio_devices[file]->getc(stdio_devices[file]);
358 static bool console_has_tstc(void)
363 static inline int console_tstc(int file)
365 return stdio_devices[file]->tstc(stdio_devices[file]);
368 static inline void console_putc(int file, const char c)
370 stdio_devices[file]->putc(stdio_devices[file], c);
373 void console_puts_select(int file, bool serial_only, const char *s)
375 if (serial_only == console_dev_is_serial(stdio_devices[file]))
376 stdio_devices[file]->puts(stdio_devices[file], s);
379 static inline void console_puts(int file, const char *s)
381 stdio_devices[file]->puts(stdio_devices[file], s);
384 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
385 static inline void console_doenv(int file, struct stdio_dev *dev)
387 console_setfile(file, dev);
390 #endif /* CONIFIG_IS_ENABLED(CONSOLE_MUX) */
392 /** U-Boot INITIAL CONSOLE-NOT COMPATIBLE FUNCTIONS *************************/
394 int serial_printf(const char *fmt, ...)
398 char printbuffer[CONFIG_SYS_PBSIZE];
402 /* For this to work, printbuffer must be larger than
403 * anything we ever want to print.
405 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
408 serial_puts(printbuffer);
414 if (file < MAX_FILES) {
416 * Effectively poll for input wherever it may be available.
420 if (CONFIG_IS_ENABLED(CONSOLE_MUX)) {
422 * Upper layer may have already called tstc() so
423 * check for that first.
425 if (console_has_tstc())
426 return console_getc(file);
429 if (console_tstc(file))
430 return console_getc(file);
434 * If the watchdog must be rate-limited then it should
435 * already be handled in board-specific code.
437 if (IS_ENABLED(CONFIG_WATCHDOG))
447 if (file < MAX_FILES)
448 return console_tstc(file);
453 void fputc(int file, const char c)
455 if (file < MAX_FILES)
456 console_putc(file, c);
459 void fputs(int file, const char *s)
461 if (file < MAX_FILES)
462 console_puts(file, s);
465 int fprintf(int file, const char *fmt, ...)
469 char printbuffer[CONFIG_SYS_PBSIZE];
473 /* For this to work, printbuffer must be larger than
474 * anything we ever want to print.
476 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
479 /* Send to desired file */
480 fputs(file, printbuffer);
484 /** U-Boot INITIAL CONSOLE-COMPATIBLE FUNCTION *****************************/
490 if (IS_ENABLED(CONFIG_DISABLE_CONSOLE) && (gd->flags & GD_FLG_DISABLE_CONSOLE))
493 if (!gd->have_console)
496 ch = console_record_getc();
500 if (gd->flags & GD_FLG_DEVINIT) {
501 /* Get from the standard input */
505 /* Send directly to the handler */
506 return serial_getc();
511 if (IS_ENABLED(CONFIG_DISABLE_CONSOLE) && (gd->flags & GD_FLG_DISABLE_CONSOLE))
514 if (!gd->have_console)
517 if (console_record_tstc())
520 if (gd->flags & GD_FLG_DEVINIT) {
521 /* Test the standard input */
525 /* Send directly to the handler */
526 return serial_tstc();
529 #define PRE_CONSOLE_FLUSHPOINT1_SERIAL 0
530 #define PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL 1
532 #if CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
533 #define CIRC_BUF_IDX(idx) ((idx) % (unsigned long)CONFIG_PRE_CON_BUF_SZ)
535 static void pre_console_putc(const char c)
539 buffer = map_sysmem(CONFIG_PRE_CON_BUF_ADDR, CONFIG_PRE_CON_BUF_SZ);
541 buffer[CIRC_BUF_IDX(gd->precon_buf_idx++)] = c;
543 unmap_sysmem(buffer);
546 static void pre_console_puts(const char *s)
549 pre_console_putc(*s++);
552 static void print_pre_console_buffer(int flushpoint)
554 unsigned long in = 0, out = 0;
555 char buf_out[CONFIG_PRE_CON_BUF_SZ + 1];
558 if (IS_ENABLED(CONFIG_SILENT_CONSOLE) && (gd->flags & GD_FLG_SILENT))
561 buf_in = map_sysmem(CONFIG_PRE_CON_BUF_ADDR, CONFIG_PRE_CON_BUF_SZ);
562 if (gd->precon_buf_idx > CONFIG_PRE_CON_BUF_SZ)
563 in = gd->precon_buf_idx - CONFIG_PRE_CON_BUF_SZ;
565 while (in < gd->precon_buf_idx)
566 buf_out[out++] = buf_in[CIRC_BUF_IDX(in++)];
567 unmap_sysmem(buf_in);
571 switch (flushpoint) {
572 case PRE_CONSOLE_FLUSHPOINT1_SERIAL:
575 case PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL:
576 console_puts_select(stdout, false, buf_out);
581 static inline void pre_console_putc(const char c) {}
582 static inline void pre_console_puts(const char *s) {}
583 static inline void print_pre_console_buffer(int flushpoint) {}
586 void putc(const char c)
591 console_record_putc(c);
593 /* sandbox can send characters to stdout before it has a console */
594 if (IS_ENABLED(CONFIG_SANDBOX) && !(gd->flags & GD_FLG_SERIAL_READY)) {
599 /* if we don't have a console yet, use the debug UART */
600 if (IS_ENABLED(CONFIG_DEBUG_UART) && !(gd->flags & GD_FLG_SERIAL_READY)) {
605 if (IS_ENABLED(CONFIG_SILENT_CONSOLE) && (gd->flags & GD_FLG_SILENT)) {
606 if (!(gd->flags & GD_FLG_DEVINIT))
611 if (IS_ENABLED(CONFIG_DISABLE_CONSOLE) && (gd->flags & GD_FLG_DISABLE_CONSOLE))
614 if (!gd->have_console)
615 return pre_console_putc(c);
617 if (gd->flags & GD_FLG_DEVINIT) {
618 /* Send to the standard output */
621 /* Send directly to the handler */
627 void puts(const char *s)
632 console_record_puts(s);
634 /* sandbox can send characters to stdout before it has a console */
635 if (IS_ENABLED(CONFIG_SANDBOX) && !(gd->flags & GD_FLG_SERIAL_READY)) {
640 if (IS_ENABLED(CONFIG_DEBUG_UART) && !(gd->flags & GD_FLG_SERIAL_READY)) {
649 if (IS_ENABLED(CONFIG_SILENT_CONSOLE) && (gd->flags & GD_FLG_SILENT)) {
650 if (!(gd->flags & GD_FLG_DEVINIT))
655 if (IS_ENABLED(CONFIG_DISABLE_CONSOLE) && (gd->flags & GD_FLG_DISABLE_CONSOLE))
658 if (!gd->have_console)
659 return pre_console_puts(s);
661 if (gd->flags & GD_FLG_DEVINIT) {
662 /* Send to the standard output */
665 /* Send directly to the handler */
671 #ifdef CONFIG_CONSOLE_RECORD
672 int console_record_init(void)
676 ret = membuff_new((struct membuff *)&gd->console_out,
677 CONFIG_CONSOLE_RECORD_OUT_SIZE);
680 ret = membuff_new((struct membuff *)&gd->console_in,
681 CONFIG_CONSOLE_RECORD_IN_SIZE);
686 void console_record_reset(void)
688 membuff_purge((struct membuff *)&gd->console_out);
689 membuff_purge((struct membuff *)&gd->console_in);
692 int console_record_reset_enable(void)
694 console_record_reset();
695 gd->flags |= GD_FLG_RECORD;
700 int console_record_readline(char *str, int maxlen)
702 return membuff_readline((struct membuff *)&gd->console_out, str,
706 int console_record_avail(void)
708 return membuff_avail((struct membuff *)&gd->console_out);
713 /* test if ctrl-c was pressed */
714 static int ctrlc_disabled = 0; /* see disable_ctrl() */
715 static int ctrlc_was_pressed = 0;
718 if (!ctrlc_disabled && gd->have_console) {
721 case 0x03: /* ^C - Control C */
722 ctrlc_was_pressed = 1;
732 /* Reads user's confirmation.
733 Returns 1 if user's input is "y", "Y", "yes" or "YES"
735 int confirm_yesno(void)
744 while (i < sizeof(str_input)) {
745 str_input[i] = getchar();
747 if (str_input[i] == '\r')
752 if (strncmp(str_input, "y\r", 2) == 0 ||
753 strncmp(str_input, "Y\r", 2) == 0 ||
754 strncmp(str_input, "yes\r", 4) == 0 ||
755 strncmp(str_input, "YES\r", 4) == 0)
759 /* pass 1 to disable ctrlc() checking, 0 to enable.
760 * returns previous state
762 int disable_ctrlc(int disable)
764 int prev = ctrlc_disabled; /* save previous state */
766 ctrlc_disabled = disable;
772 return ctrlc_was_pressed;
775 void clear_ctrlc(void)
777 ctrlc_was_pressed = 0;
780 /** U-Boot INIT FUNCTIONS *************************************************/
782 struct stdio_dev *search_device(int flags, const char *name)
784 struct stdio_dev *dev;
786 dev = stdio_get_by_name(name);
787 #ifdef CONFIG_VIDCONSOLE_AS_LCD
788 if (!dev && !strcmp(name, CONFIG_VIDCONSOLE_AS_NAME))
789 dev = stdio_get_by_name("vidconsole");
792 if (dev && (dev->flags & flags))
798 int console_assign(int file, const char *devname)
801 struct stdio_dev *dev;
803 /* Check for valid file */
806 flag = DEV_FLAGS_INPUT;
810 flag = DEV_FLAGS_OUTPUT;
816 /* Check for valid device name */
818 dev = search_device(flag, devname);
821 return console_setfile(file, dev);
826 /* return true if the 'silent' flag is removed */
827 static bool console_update_silent(void)
829 unsigned long flags = gd->flags;
831 if (!IS_ENABLED(CONFIG_SILENT_CONSOLE))
834 if (env_get("silent")) {
835 gd->flags |= GD_FLG_SILENT;
839 gd->flags &= ~GD_FLG_SILENT;
841 return !!(flags & GD_FLG_SILENT);
844 int console_announce_r(void)
846 #if !CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
847 char buf[DISPLAY_OPTIONS_BANNER_LENGTH];
849 display_options_get_banner(false, buf, sizeof(buf));
851 console_puts_select(stdout, false, buf);
857 /* Called before relocation - use serial functions */
858 int console_init_f(void)
860 gd->have_console = 1;
862 console_update_silent();
864 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT1_SERIAL);
869 void stdio_print_current_devices(void)
871 /* Print information */
873 if (stdio_devices[stdin] == NULL) {
874 puts("No input devices available!\n");
876 printf ("%s\n", stdio_devices[stdin]->name);
880 if (stdio_devices[stdout] == NULL) {
881 puts("No output devices available!\n");
883 printf ("%s\n", stdio_devices[stdout]->name);
887 if (stdio_devices[stderr] == NULL) {
888 puts("No error devices available!\n");
890 printf ("%s\n", stdio_devices[stderr]->name);
894 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
895 /* Called after the relocation - use desired console functions */
896 int console_init_r(void)
898 char *stdinname, *stdoutname, *stderrname;
899 struct stdio_dev *inputdev = NULL, *outputdev = NULL, *errdev = NULL;
904 /* update silent for env loaded from flash (initr_env) */
905 if (console_update_silent())
906 flushpoint = PRE_CONSOLE_FLUSHPOINT1_SERIAL;
908 flushpoint = PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL;
910 /* set default handlers at first */
911 gd->jt->getc = serial_getc;
912 gd->jt->tstc = serial_tstc;
913 gd->jt->putc = serial_putc;
914 gd->jt->puts = serial_puts;
915 gd->jt->printf = serial_printf;
917 /* stdin stdout and stderr are in environment */
919 stdinname = env_get("stdin");
920 stdoutname = env_get("stdout");
921 stderrname = env_get("stderr");
923 if (OVERWRITE_CONSOLE == 0) { /* if not overwritten by config switch */
924 inputdev = search_device(DEV_FLAGS_INPUT, stdinname);
925 outputdev = search_device(DEV_FLAGS_OUTPUT, stdoutname);
926 errdev = search_device(DEV_FLAGS_OUTPUT, stderrname);
927 if (CONFIG_IS_ENABLED(CONSOLE_MUX)) {
928 iomux_err = iomux_doenv(stdin, stdinname);
929 iomux_err += iomux_doenv(stdout, stdoutname);
930 iomux_err += iomux_doenv(stderr, stderrname);
932 /* Successful, so skip all the code below. */
936 /* if the devices are overwritten or not found, use default device */
937 if (inputdev == NULL) {
938 inputdev = search_device(DEV_FLAGS_INPUT, "serial");
940 if (outputdev == NULL) {
941 outputdev = search_device(DEV_FLAGS_OUTPUT, "serial");
943 if (errdev == NULL) {
944 errdev = search_device(DEV_FLAGS_OUTPUT, "serial");
946 /* Initializes output console first */
947 if (outputdev != NULL) {
948 /* need to set a console if not done above. */
949 console_doenv(stdout, outputdev);
951 if (errdev != NULL) {
952 /* need to set a console if not done above. */
953 console_doenv(stderr, errdev);
955 if (inputdev != NULL) {
956 /* need to set a console if not done above. */
957 console_doenv(stdin, inputdev);
962 if (!IS_ENABLED(CONFIG_SYS_CONSOLE_INFO_QUIET))
963 stdio_print_current_devices();
965 #ifdef CONFIG_VIDCONSOLE_AS_LCD
966 if (strstr(stdoutname, CONFIG_VIDCONSOLE_AS_NAME))
967 printf("Warning: Please change '%s' to 'vidconsole' in stdout/stderr environment vars\n",
968 CONFIG_VIDCONSOLE_AS_NAME);
971 if (IS_ENABLED(CONFIG_SYS_CONSOLE_ENV_OVERWRITE)) {
972 /* set the environment variables (will overwrite previous env settings) */
973 for (i = 0; i < MAX_FILES; i++)
974 env_set(stdio_names[i], stdio_devices[i]->name);
977 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
980 /* If nothing usable installed, use only the initial console */
981 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
984 print_pre_console_buffer(flushpoint);
988 #else /* !CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */
990 /* Called after the relocation - use desired console functions */
991 int console_init_r(void)
993 struct stdio_dev *inputdev = NULL, *outputdev = NULL;
995 struct list_head *list = stdio_get_list();
996 struct list_head *pos;
997 struct stdio_dev *dev;
1000 /* update silent for env loaded from flash (initr_env) */
1001 if (console_update_silent())
1002 flushpoint = PRE_CONSOLE_FLUSHPOINT1_SERIAL;
1004 flushpoint = PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL;
1007 * suppress all output if splash screen is enabled and we have
1008 * a bmp to display. We redirect the output from frame buffer
1009 * console to serial console in this case or suppress it if
1010 * "silent" mode was requested.
1012 if (IS_ENABLED(CONFIG_SPLASH_SCREEN) && env_get("splashimage")) {
1013 if (!(gd->flags & GD_FLG_SILENT))
1014 outputdev = search_device (DEV_FLAGS_OUTPUT, "serial");
1017 /* Scan devices looking for input and output devices */
1018 list_for_each(pos, list) {
1019 dev = list_entry(pos, struct stdio_dev, list);
1021 if ((dev->flags & DEV_FLAGS_INPUT) && (inputdev == NULL)) {
1024 if ((dev->flags & DEV_FLAGS_OUTPUT) && (outputdev == NULL)) {
1027 if(inputdev && outputdev)
1031 /* Initializes output console first */
1032 if (outputdev != NULL) {
1033 console_setfile(stdout, outputdev);
1034 console_setfile(stderr, outputdev);
1035 console_devices_set(stdout, outputdev);
1036 console_devices_set(stderr, outputdev);
1039 /* Initializes input console */
1040 if (inputdev != NULL) {
1041 console_setfile(stdin, inputdev);
1042 console_devices_set(stdin, inputdev);
1045 if (!IS_ENABLED(CONFIG_SYS_CONSOLE_INFO_QUIET))
1046 stdio_print_current_devices();
1048 /* Setting environment variables */
1049 for (i = 0; i < MAX_FILES; i++) {
1050 env_set(stdio_names[i], stdio_devices[i]->name);
1053 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
1056 /* If nothing usable installed, use only the initial console */
1057 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
1060 print_pre_console_buffer(flushpoint);
1064 #endif /* CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */