5 * SPDX-License-Identifier: GPL-2.0+
10 #include <debug_uart.h>
18 #include <stdio_dev.h>
20 #include <environment.h>
23 DECLARE_GLOBAL_DATA_PTR;
25 static int on_console(const char *name, const char *value, enum env_op op,
30 /* Check for console redirection */
31 if (strcmp(name, "stdin") == 0)
33 else if (strcmp(name, "stdout") == 0)
35 else if (strcmp(name, "stderr") == 0)
38 /* if not actually setting a console variable, we don't care */
39 if (console == -1 || (gd->flags & GD_FLG_DEVINIT) == 0)
44 case env_op_overwrite:
46 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
47 if (iomux_doenv(console, value))
50 /* Try assigning specified device */
51 if (console_assign(console, value) < 0)
57 if ((flags & H_FORCE) == 0)
58 printf("Can't delete \"%s\"\n", name);
65 U_BOOT_ENV_CALLBACK(console, on_console);
67 #ifdef CONFIG_SILENT_CONSOLE
68 static int on_silent(const char *name, const char *value, enum env_op op,
71 #if !CONFIG_IS_ENABLED(SILENT_CONSOLE_UPDATE_ON_SET)
72 if (flags & H_INTERACTIVE)
75 #if !CONFIG_IS_ENABLED(SILENT_CONSOLE_UPDATE_ON_RELOC)
76 if ((flags & H_INTERACTIVE) == 0)
81 gd->flags |= GD_FLG_SILENT;
83 gd->flags &= ~GD_FLG_SILENT;
87 U_BOOT_ENV_CALLBACK(silent, on_silent);
90 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
92 * if overwrite_console returns 1, the stdin, stderr and stdout
93 * are switched to the serial port, else the settings in the
94 * environment are used
96 #ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
97 extern int overwrite_console(void);
98 #define OVERWRITE_CONSOLE overwrite_console()
100 #define OVERWRITE_CONSOLE 0
101 #endif /* CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE */
103 #endif /* CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */
105 static int console_setfile(int file, struct stdio_dev * dev)
116 /* Start new device */
118 error = dev->start(dev);
119 /* If it's not started dont use it */
124 /* Assign the new device (leaving the existing one started) */
125 stdio_devices[file] = dev;
128 * Update monitor functions
129 * (to use the console stuff by other applications)
139 gd->jt->printf = printf;
144 default: /* Invalid file ID */
151 * console_dev_is_serial() - Check if a stdio device is a serial device
153 * @sdev: Device to check
154 * @return true if this device is in the serial uclass (or for pre-driver-model,
155 * whether it is called "serial".
157 static bool console_dev_is_serial(struct stdio_dev *sdev)
161 #ifdef CONFIG_DM_SERIAL
162 if (sdev->flags & DEV_FLAGS_DM) {
163 struct udevice *dev = sdev->priv;
165 is_serial = device_get_uclass_id(dev) == UCLASS_SERIAL;
168 is_serial = !strcmp(sdev->name, "serial");
173 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
174 /** Console I/O multiplexing *******************************************/
176 static struct stdio_dev *tstcdev;
177 struct stdio_dev **console_devices[MAX_FILES];
178 int cd_count[MAX_FILES];
181 * This depends on tstc() always being called before getc().
182 * This is guaranteed to be true because this routine is called
183 * only from fgetc() which assures it.
184 * No attempt is made to demultiplex multiple input sources.
186 static int console_getc(int file)
190 /* This is never called with testcdev == NULL */
191 ret = tstcdev->getc(tstcdev);
196 static int console_tstc(int file)
199 struct stdio_dev *dev;
202 for (i = 0; i < cd_count[file]; i++) {
203 dev = console_devices[file][i];
204 if (dev->tstc != NULL) {
205 ret = dev->tstc(dev);
218 static void console_putc(int file, const char c)
221 struct stdio_dev *dev;
223 for (i = 0; i < cd_count[file]; i++) {
224 dev = console_devices[file][i];
225 if (dev->putc != NULL)
230 static void console_puts_noserial(int file, const char *s)
233 struct stdio_dev *dev;
235 for (i = 0; i < cd_count[file]; i++) {
236 dev = console_devices[file][i];
237 if (dev->puts != NULL && !console_dev_is_serial(dev))
242 static void console_puts(int file, const char *s)
245 struct stdio_dev *dev;
247 for (i = 0; i < cd_count[file]; i++) {
248 dev = console_devices[file][i];
249 if (dev->puts != NULL)
254 static inline void console_doenv(int file, struct stdio_dev *dev)
256 iomux_doenv(file, dev->name);
259 static inline int console_getc(int file)
261 return stdio_devices[file]->getc(stdio_devices[file]);
264 static inline int console_tstc(int file)
266 return stdio_devices[file]->tstc(stdio_devices[file]);
269 static inline void console_putc(int file, const char c)
271 stdio_devices[file]->putc(stdio_devices[file], c);
274 static inline void console_puts_noserial(int file, const char *s)
276 if (!console_dev_is_serial(stdio_devices[file]))
277 stdio_devices[file]->puts(stdio_devices[file], s);
280 static inline void console_puts(int file, const char *s)
282 stdio_devices[file]->puts(stdio_devices[file], s);
285 static inline void console_doenv(int file, struct stdio_dev *dev)
287 console_setfile(file, dev);
289 #endif /* CONIFIG_IS_ENABLED(CONSOLE_MUX) */
291 /** U-Boot INITIAL CONSOLE-NOT COMPATIBLE FUNCTIONS *************************/
293 int serial_printf(const char *fmt, ...)
297 char printbuffer[CONFIG_SYS_PBSIZE];
301 /* For this to work, printbuffer must be larger than
302 * anything we ever want to print.
304 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
307 serial_puts(printbuffer);
313 if (file < MAX_FILES) {
314 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
316 * Effectively poll for input wherever it may be available.
321 * Upper layer may have already called tstc() so
322 * check for that first.
325 return console_getc(file);
327 #ifdef CONFIG_WATCHDOG
329 * If the watchdog must be rate-limited then it should
330 * already be handled in board-specific code.
336 return console_getc(file);
345 if (file < MAX_FILES)
346 return console_tstc(file);
351 void fputc(int file, const char c)
353 if (file < MAX_FILES)
354 console_putc(file, c);
357 void fputs(int file, const char *s)
359 if (file < MAX_FILES)
360 console_puts(file, s);
363 int fprintf(int file, const char *fmt, ...)
367 char printbuffer[CONFIG_SYS_PBSIZE];
371 /* For this to work, printbuffer must be larger than
372 * anything we ever want to print.
374 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
377 /* Send to desired file */
378 fputs(file, printbuffer);
382 /** U-Boot INITIAL CONSOLE-COMPATIBLE FUNCTION *****************************/
386 #ifdef CONFIG_DISABLE_CONSOLE
387 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
391 if (!gd->have_console)
394 #ifdef CONFIG_CONSOLE_RECORD
395 if (gd->console_in.start) {
398 ch = membuff_getbyte(&gd->console_in);
403 if (gd->flags & GD_FLG_DEVINIT) {
404 /* Get from the standard input */
408 /* Send directly to the handler */
409 return serial_getc();
414 #ifdef CONFIG_DISABLE_CONSOLE
415 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
419 if (!gd->have_console)
421 #ifdef CONFIG_CONSOLE_RECORD
422 if (gd->console_in.start) {
423 if (membuff_peekbyte(&gd->console_in) != -1)
427 if (gd->flags & GD_FLG_DEVINIT) {
428 /* Test the standard input */
432 /* Send directly to the handler */
433 return serial_tstc();
436 #define PRE_CONSOLE_FLUSHPOINT1_SERIAL 0
437 #define PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL 1
439 #if CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
440 #define CIRC_BUF_IDX(idx) ((idx) % (unsigned long)CONFIG_PRE_CON_BUF_SZ)
442 static void pre_console_putc(const char c)
446 buffer = map_sysmem(CONFIG_PRE_CON_BUF_ADDR, CONFIG_PRE_CON_BUF_SZ);
448 buffer[CIRC_BUF_IDX(gd->precon_buf_idx++)] = c;
450 unmap_sysmem(buffer);
453 static void pre_console_puts(const char *s)
456 pre_console_putc(*s++);
459 static void print_pre_console_buffer(int flushpoint)
461 unsigned long in = 0, out = 0;
462 char buf_out[CONFIG_PRE_CON_BUF_SZ + 1];
465 buf_in = map_sysmem(CONFIG_PRE_CON_BUF_ADDR, CONFIG_PRE_CON_BUF_SZ);
466 if (gd->precon_buf_idx > CONFIG_PRE_CON_BUF_SZ)
467 in = gd->precon_buf_idx - CONFIG_PRE_CON_BUF_SZ;
469 while (in < gd->precon_buf_idx)
470 buf_out[out++] = buf_in[CIRC_BUF_IDX(in++)];
471 unmap_sysmem(buf_in);
475 switch (flushpoint) {
476 case PRE_CONSOLE_FLUSHPOINT1_SERIAL:
479 case PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL:
480 console_puts_noserial(stdout, buf_out);
485 static inline void pre_console_putc(const char c) {}
486 static inline void pre_console_puts(const char *s) {}
487 static inline void print_pre_console_buffer(int flushpoint) {}
490 void putc(const char c)
492 #ifdef CONFIG_SANDBOX
493 /* sandbox can send characters to stdout before it has a console */
494 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
499 #ifdef CONFIG_DEBUG_UART
500 /* if we don't have a console yet, use the debug UART */
501 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
506 #ifdef CONFIG_CONSOLE_RECORD
507 if (gd && (gd->flags & GD_FLG_RECORD) && gd->console_out.start)
508 membuff_putbyte(&gd->console_out, c);
510 #ifdef CONFIG_SILENT_CONSOLE
511 if (gd->flags & GD_FLG_SILENT)
515 #ifdef CONFIG_DISABLE_CONSOLE
516 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
520 if (!gd->have_console)
521 return pre_console_putc(c);
523 if (gd->flags & GD_FLG_DEVINIT) {
524 /* Send to the standard output */
527 /* Send directly to the handler */
533 void puts(const char *s)
535 #ifdef CONFIG_DEBUG_UART
536 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
545 #ifdef CONFIG_CONSOLE_RECORD
546 if (gd && (gd->flags & GD_FLG_RECORD) && gd->console_out.start)
547 membuff_put(&gd->console_out, s, strlen(s));
549 #ifdef CONFIG_SILENT_CONSOLE
550 if (gd->flags & GD_FLG_SILENT)
554 #ifdef CONFIG_DISABLE_CONSOLE
555 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
559 if (!gd->have_console)
560 return pre_console_puts(s);
562 if (gd->flags & GD_FLG_DEVINIT) {
563 /* Send to the standard output */
566 /* Send directly to the handler */
572 #ifdef CONFIG_CONSOLE_RECORD
573 int console_record_init(void)
577 ret = membuff_new(&gd->console_out, CONFIG_CONSOLE_RECORD_OUT_SIZE);
580 ret = membuff_new(&gd->console_in, CONFIG_CONSOLE_RECORD_IN_SIZE);
585 void console_record_reset(void)
587 membuff_purge(&gd->console_out);
588 membuff_purge(&gd->console_in);
591 void console_record_reset_enable(void)
593 console_record_reset();
594 gd->flags |= GD_FLG_RECORD;
598 /* test if ctrl-c was pressed */
599 static int ctrlc_disabled = 0; /* see disable_ctrl() */
600 static int ctrlc_was_pressed = 0;
603 #ifndef CONFIG_SANDBOX
604 if (!ctrlc_disabled && gd->have_console) {
607 case 0x03: /* ^C - Control C */
608 ctrlc_was_pressed = 1;
619 /* Reads user's confirmation.
620 Returns 1 if user's input is "y", "Y", "yes" or "YES"
622 int confirm_yesno(void)
631 while (i < sizeof(str_input)) {
632 str_input[i] = getc();
634 if (str_input[i] == '\r')
639 if (strncmp(str_input, "y\r", 2) == 0 ||
640 strncmp(str_input, "Y\r", 2) == 0 ||
641 strncmp(str_input, "yes\r", 4) == 0 ||
642 strncmp(str_input, "YES\r", 4) == 0)
646 /* pass 1 to disable ctrlc() checking, 0 to enable.
647 * returns previous state
649 int disable_ctrlc(int disable)
651 int prev = ctrlc_disabled; /* save previous state */
653 ctrlc_disabled = disable;
659 return ctrlc_was_pressed;
662 void clear_ctrlc(void)
664 ctrlc_was_pressed = 0;
667 /** U-Boot INIT FUNCTIONS *************************************************/
669 struct stdio_dev *search_device(int flags, const char *name)
671 struct stdio_dev *dev;
673 dev = stdio_get_by_name(name);
674 #ifdef CONFIG_VIDCONSOLE_AS_LCD
675 if (!dev && !strcmp(name, "lcd"))
676 dev = stdio_get_by_name("vidconsole");
679 if (dev && (dev->flags & flags))
685 int console_assign(int file, const char *devname)
688 struct stdio_dev *dev;
690 /* Check for valid file */
693 flag = DEV_FLAGS_INPUT;
697 flag = DEV_FLAGS_OUTPUT;
703 /* Check for valid device name */
705 dev = search_device(flag, devname);
708 return console_setfile(file, dev);
713 static void console_update_silent(void)
715 #ifdef CONFIG_SILENT_CONSOLE
716 if (env_get("silent") != NULL)
717 gd->flags |= GD_FLG_SILENT;
719 gd->flags &= ~GD_FLG_SILENT;
723 int console_announce_r(void)
725 #if !CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
726 char buf[DISPLAY_OPTIONS_BANNER_LENGTH];
728 display_options_get_banner(false, buf, sizeof(buf));
730 console_puts_noserial(stdout, buf);
736 /* Called before relocation - use serial functions */
737 int console_init_f(void)
739 gd->have_console = 1;
741 console_update_silent();
743 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT1_SERIAL);
748 void stdio_print_current_devices(void)
750 /* Print information */
752 if (stdio_devices[stdin] == NULL) {
753 puts("No input devices available!\n");
755 printf ("%s\n", stdio_devices[stdin]->name);
759 if (stdio_devices[stdout] == NULL) {
760 puts("No output devices available!\n");
762 printf ("%s\n", stdio_devices[stdout]->name);
766 if (stdio_devices[stderr] == NULL) {
767 puts("No error devices available!\n");
769 printf ("%s\n", stdio_devices[stderr]->name);
773 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
774 /* Called after the relocation - use desired console functions */
775 int console_init_r(void)
777 char *stdinname, *stdoutname, *stderrname;
778 struct stdio_dev *inputdev = NULL, *outputdev = NULL, *errdev = NULL;
779 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
781 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
782 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
786 /* set default handlers at first */
787 gd->jt->getc = serial_getc;
788 gd->jt->tstc = serial_tstc;
789 gd->jt->putc = serial_putc;
790 gd->jt->puts = serial_puts;
791 gd->jt->printf = serial_printf;
793 /* stdin stdout and stderr are in environment */
795 stdinname = env_get("stdin");
796 stdoutname = env_get("stdout");
797 stderrname = env_get("stderr");
799 if (OVERWRITE_CONSOLE == 0) { /* if not overwritten by config switch */
800 inputdev = search_device(DEV_FLAGS_INPUT, stdinname);
801 outputdev = search_device(DEV_FLAGS_OUTPUT, stdoutname);
802 errdev = search_device(DEV_FLAGS_OUTPUT, stderrname);
803 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
804 iomux_err = iomux_doenv(stdin, stdinname);
805 iomux_err += iomux_doenv(stdout, stdoutname);
806 iomux_err += iomux_doenv(stderr, stderrname);
808 /* Successful, so skip all the code below. */
812 /* if the devices are overwritten or not found, use default device */
813 if (inputdev == NULL) {
814 inputdev = search_device(DEV_FLAGS_INPUT, "serial");
816 if (outputdev == NULL) {
817 outputdev = search_device(DEV_FLAGS_OUTPUT, "serial");
819 if (errdev == NULL) {
820 errdev = search_device(DEV_FLAGS_OUTPUT, "serial");
822 /* Initializes output console first */
823 if (outputdev != NULL) {
824 /* need to set a console if not done above. */
825 console_doenv(stdout, outputdev);
827 if (errdev != NULL) {
828 /* need to set a console if not done above. */
829 console_doenv(stderr, errdev);
831 if (inputdev != NULL) {
832 /* need to set a console if not done above. */
833 console_doenv(stdin, inputdev);
836 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
840 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
841 stdio_print_current_devices();
842 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
843 #ifdef CONFIG_VIDCONSOLE_AS_LCD
844 if (strstr(stdoutname, "lcd"))
845 printf("Warning: Please change 'lcd' to 'vidconsole' in stdout/stderr environment vars\n");
848 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
849 /* set the environment variables (will overwrite previous env settings) */
850 for (i = 0; i < 3; i++) {
851 env_set(stdio_names[i], stdio_devices[i]->name);
853 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
855 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
858 /* If nothing usable installed, use only the initial console */
859 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
862 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL);
866 #else /* !CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */
868 /* Called after the relocation - use desired console functions */
869 int console_init_r(void)
871 struct stdio_dev *inputdev = NULL, *outputdev = NULL;
873 struct list_head *list = stdio_get_list();
874 struct list_head *pos;
875 struct stdio_dev *dev;
877 console_update_silent();
879 #ifdef CONFIG_SPLASH_SCREEN
881 * suppress all output if splash screen is enabled and we have
882 * a bmp to display. We redirect the output from frame buffer
883 * console to serial console in this case or suppress it if
884 * "silent" mode was requested.
886 if (env_get("splashimage") != NULL) {
887 if (!(gd->flags & GD_FLG_SILENT))
888 outputdev = search_device (DEV_FLAGS_OUTPUT, "serial");
892 /* Scan devices looking for input and output devices */
893 list_for_each(pos, list) {
894 dev = list_entry(pos, struct stdio_dev, list);
896 if ((dev->flags & DEV_FLAGS_INPUT) && (inputdev == NULL)) {
899 if ((dev->flags & DEV_FLAGS_OUTPUT) && (outputdev == NULL)) {
902 if(inputdev && outputdev)
906 /* Initializes output console first */
907 if (outputdev != NULL) {
908 console_setfile(stdout, outputdev);
909 console_setfile(stderr, outputdev);
910 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
911 console_devices[stdout][0] = outputdev;
912 console_devices[stderr][0] = outputdev;
916 /* Initializes input console */
917 if (inputdev != NULL) {
918 console_setfile(stdin, inputdev);
919 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
920 console_devices[stdin][0] = inputdev;
924 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
925 stdio_print_current_devices();
926 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
928 /* Setting environment variables */
929 for (i = 0; i < 3; i++) {
930 env_set(stdio_names[i], stdio_devices[i]->name);
933 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
936 /* If nothing usable installed, use only the initial console */
937 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
940 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL);
944 #endif /* CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */