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>
17 #include <stdio_dev.h>
19 #include <environment.h>
22 DECLARE_GLOBAL_DATA_PTR;
24 static int on_console(const char *name, const char *value, enum env_op op,
29 /* Check for console redirection */
30 if (strcmp(name, "stdin") == 0)
32 else if (strcmp(name, "stdout") == 0)
34 else if (strcmp(name, "stderr") == 0)
37 /* if not actually setting a console variable, we don't care */
38 if (console == -1 || (gd->flags & GD_FLG_DEVINIT) == 0)
43 case env_op_overwrite:
45 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
46 if (iomux_doenv(console, value))
49 /* Try assigning specified device */
50 if (console_assign(console, value) < 0)
56 if ((flags & H_FORCE) == 0)
57 printf("Can't delete \"%s\"\n", name);
64 U_BOOT_ENV_CALLBACK(console, on_console);
66 #ifdef CONFIG_SILENT_CONSOLE
67 static int on_silent(const char *name, const char *value, enum env_op op,
70 #if !CONFIG_IS_ENABLED(SILENT_CONSOLE_UPDATE_ON_SET)
71 if (flags & H_INTERACTIVE)
74 #if !CONFIG_IS_ENABLED(SILENT_CONSOLE_UPDATE_ON_RELOC)
75 if ((flags & H_INTERACTIVE) == 0)
80 gd->flags |= GD_FLG_SILENT;
82 gd->flags &= ~GD_FLG_SILENT;
86 U_BOOT_ENV_CALLBACK(silent, on_silent);
89 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
91 * if overwrite_console returns 1, the stdin, stderr and stdout
92 * are switched to the serial port, else the settings in the
93 * environment are used
95 #ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
96 extern int overwrite_console(void);
97 #define OVERWRITE_CONSOLE overwrite_console()
99 #define OVERWRITE_CONSOLE 0
100 #endif /* CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE */
102 #endif /* CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */
104 static int console_setfile(int file, struct stdio_dev * dev)
115 /* Start new device */
117 error = dev->start(dev);
118 /* If it's not started dont use it */
123 /* Assign the new device (leaving the existing one started) */
124 stdio_devices[file] = dev;
127 * Update monitor functions
128 * (to use the console stuff by other applications)
138 gd->jt->printf = printf;
143 default: /* Invalid file ID */
150 * console_dev_is_serial() - Check if a stdio device is a serial device
152 * @sdev: Device to check
153 * @return true if this device is in the serial uclass (or for pre-driver-model,
154 * whether it is called "serial".
156 static bool console_dev_is_serial(struct stdio_dev *sdev)
160 #ifdef CONFIG_DM_SERIAL
161 if (sdev->flags & DEV_FLAGS_DM) {
162 struct udevice *dev = sdev->priv;
164 is_serial = device_get_uclass_id(dev) == UCLASS_SERIAL;
167 is_serial = !strcmp(sdev->name, "serial");
172 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
173 /** Console I/O multiplexing *******************************************/
175 static struct stdio_dev *tstcdev;
176 struct stdio_dev **console_devices[MAX_FILES];
177 int cd_count[MAX_FILES];
180 * This depends on tstc() always being called before getc().
181 * This is guaranteed to be true because this routine is called
182 * only from fgetc() which assures it.
183 * No attempt is made to demultiplex multiple input sources.
185 static int console_getc(int file)
189 /* This is never called with testcdev == NULL */
190 ret = tstcdev->getc(tstcdev);
195 static int console_tstc(int file)
198 struct stdio_dev *dev;
201 prev = disable_ctrlc(1);
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) {
315 * Effectively poll for input wherever it may be available.
319 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
321 * Upper layer may have already called tstc() so
322 * check for that first.
325 return console_getc(file);
328 if (console_tstc(file))
329 return console_getc(file);
331 #ifdef CONFIG_WATCHDOG
333 * If the watchdog must be rate-limited then it should
334 * already be handled in board-specific code.
346 if (file < MAX_FILES)
347 return console_tstc(file);
352 void fputc(int file, const char c)
354 if (file < MAX_FILES)
355 console_putc(file, c);
358 void fputs(int file, const char *s)
360 if (file < MAX_FILES)
361 console_puts(file, s);
364 int fprintf(int file, const char *fmt, ...)
368 char printbuffer[CONFIG_SYS_PBSIZE];
372 /* For this to work, printbuffer must be larger than
373 * anything we ever want to print.
375 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
378 /* Send to desired file */
379 fputs(file, printbuffer);
383 /** U-Boot INITIAL CONSOLE-COMPATIBLE FUNCTION *****************************/
387 #ifdef CONFIG_DISABLE_CONSOLE
388 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
392 if (!gd->have_console)
395 #ifdef CONFIG_CONSOLE_RECORD
396 if (gd->console_in.start) {
399 ch = membuff_getbyte(&gd->console_in);
404 if (gd->flags & GD_FLG_DEVINIT) {
405 /* Get from the standard input */
409 /* Send directly to the handler */
410 return serial_getc();
415 #ifdef CONFIG_DISABLE_CONSOLE
416 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
420 if (!gd->have_console)
422 #ifdef CONFIG_CONSOLE_RECORD
423 if (gd->console_in.start) {
424 if (membuff_peekbyte(&gd->console_in) != -1)
428 if (gd->flags & GD_FLG_DEVINIT) {
429 /* Test the standard input */
433 /* Send directly to the handler */
434 return serial_tstc();
437 #define PRE_CONSOLE_FLUSHPOINT1_SERIAL 0
438 #define PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL 1
440 #if CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
441 #define CIRC_BUF_IDX(idx) ((idx) % (unsigned long)CONFIG_PRE_CON_BUF_SZ)
443 static void pre_console_putc(const char c)
447 buffer = map_sysmem(CONFIG_PRE_CON_BUF_ADDR, CONFIG_PRE_CON_BUF_SZ);
449 buffer[CIRC_BUF_IDX(gd->precon_buf_idx++)] = c;
451 unmap_sysmem(buffer);
454 static void pre_console_puts(const char *s)
457 pre_console_putc(*s++);
460 static void print_pre_console_buffer(int flushpoint)
462 unsigned long in = 0, out = 0;
463 char buf_out[CONFIG_PRE_CON_BUF_SZ + 1];
466 #ifdef CONFIG_SILENT_CONSOLE
467 if (gd->flags & GD_FLG_SILENT)
471 buf_in = map_sysmem(CONFIG_PRE_CON_BUF_ADDR, CONFIG_PRE_CON_BUF_SZ);
472 if (gd->precon_buf_idx > CONFIG_PRE_CON_BUF_SZ)
473 in = gd->precon_buf_idx - CONFIG_PRE_CON_BUF_SZ;
475 while (in < gd->precon_buf_idx)
476 buf_out[out++] = buf_in[CIRC_BUF_IDX(in++)];
477 unmap_sysmem(buf_in);
481 switch (flushpoint) {
482 case PRE_CONSOLE_FLUSHPOINT1_SERIAL:
485 case PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL:
486 console_puts_noserial(stdout, buf_out);
491 static inline void pre_console_putc(const char c) {}
492 static inline void pre_console_puts(const char *s) {}
493 static inline void print_pre_console_buffer(int flushpoint) {}
496 void putc(const char c)
498 #ifdef CONFIG_SANDBOX
499 /* sandbox can send characters to stdout before it has a console */
500 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
505 #ifdef CONFIG_DEBUG_UART
506 /* if we don't have a console yet, use the debug UART */
507 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
514 #ifdef CONFIG_CONSOLE_RECORD
515 if ((gd->flags & GD_FLG_RECORD) && gd->console_out.start)
516 membuff_putbyte(&gd->console_out, c);
518 #ifdef CONFIG_SILENT_CONSOLE
519 if (gd->flags & GD_FLG_SILENT) {
520 if (!(gd->flags & GD_FLG_DEVINIT))
526 #ifdef CONFIG_DISABLE_CONSOLE
527 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
531 if (!gd->have_console)
532 return pre_console_putc(c);
534 if (gd->flags & GD_FLG_DEVINIT) {
535 /* Send to the standard output */
538 /* Send directly to the handler */
544 void puts(const char *s)
546 #ifdef CONFIG_SANDBOX
547 /* sandbox can send characters to stdout before it has a console */
548 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
553 #ifdef CONFIG_DEBUG_UART
554 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
565 #ifdef CONFIG_CONSOLE_RECORD
566 if ((gd->flags & GD_FLG_RECORD) && gd->console_out.start)
567 membuff_put(&gd->console_out, s, strlen(s));
569 #ifdef CONFIG_SILENT_CONSOLE
570 if (gd->flags & GD_FLG_SILENT) {
571 if (!(gd->flags & GD_FLG_DEVINIT))
577 #ifdef CONFIG_DISABLE_CONSOLE
578 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
582 if (!gd->have_console)
583 return pre_console_puts(s);
585 if (gd->flags & GD_FLG_DEVINIT) {
586 /* Send to the standard output */
589 /* Send directly to the handler */
595 #ifdef CONFIG_CONSOLE_RECORD
596 int console_record_init(void)
600 ret = membuff_new(&gd->console_out, CONFIG_CONSOLE_RECORD_OUT_SIZE);
603 ret = membuff_new(&gd->console_in, CONFIG_CONSOLE_RECORD_IN_SIZE);
608 void console_record_reset(void)
610 membuff_purge(&gd->console_out);
611 membuff_purge(&gd->console_in);
614 void console_record_reset_enable(void)
616 console_record_reset();
617 gd->flags |= GD_FLG_RECORD;
621 /* test if ctrl-c was pressed */
622 static int ctrlc_disabled = 0; /* see disable_ctrl() */
623 static int ctrlc_was_pressed = 0;
626 if (!ctrlc_disabled && gd->have_console) {
629 case 0x03: /* ^C - Control C */
630 ctrlc_was_pressed = 1;
640 /* Reads user's confirmation.
641 Returns 1 if user's input is "y", "Y", "yes" or "YES"
643 int confirm_yesno(void)
652 while (i < sizeof(str_input)) {
653 str_input[i] = getc();
655 if (str_input[i] == '\r')
660 if (strncmp(str_input, "y\r", 2) == 0 ||
661 strncmp(str_input, "Y\r", 2) == 0 ||
662 strncmp(str_input, "yes\r", 4) == 0 ||
663 strncmp(str_input, "YES\r", 4) == 0)
667 /* pass 1 to disable ctrlc() checking, 0 to enable.
668 * returns previous state
670 int disable_ctrlc(int disable)
672 int prev = ctrlc_disabled; /* save previous state */
674 ctrlc_disabled = disable;
680 return ctrlc_was_pressed;
683 void clear_ctrlc(void)
685 ctrlc_was_pressed = 0;
688 /** U-Boot INIT FUNCTIONS *************************************************/
690 struct stdio_dev *search_device(int flags, const char *name)
692 struct stdio_dev *dev;
694 dev = stdio_get_by_name(name);
695 #ifdef CONFIG_VIDCONSOLE_AS_LCD
696 if (!dev && !strcmp(name, "lcd"))
697 dev = stdio_get_by_name("vidconsole");
700 if (dev && (dev->flags & flags))
706 int console_assign(int file, const char *devname)
709 struct stdio_dev *dev;
711 /* Check for valid file */
714 flag = DEV_FLAGS_INPUT;
718 flag = DEV_FLAGS_OUTPUT;
724 /* Check for valid device name */
726 dev = search_device(flag, devname);
729 return console_setfile(file, dev);
734 /* return true if the 'silent' flag is removed */
735 static bool console_update_silent(void)
737 #ifdef CONFIG_SILENT_CONSOLE
738 if (env_get("silent")) {
739 gd->flags |= GD_FLG_SILENT;
741 unsigned long flags = gd->flags;
743 gd->flags &= ~GD_FLG_SILENT;
745 return !!(flags & GD_FLG_SILENT);
752 int console_announce_r(void)
754 #if !CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
755 char buf[DISPLAY_OPTIONS_BANNER_LENGTH];
757 display_options_get_banner(false, buf, sizeof(buf));
759 console_puts_noserial(stdout, buf);
765 /* Called before relocation - use serial functions */
766 int console_init_f(void)
768 gd->have_console = 1;
770 console_update_silent();
772 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT1_SERIAL);
777 void stdio_print_current_devices(void)
779 /* Print information */
781 if (stdio_devices[stdin] == NULL) {
782 puts("No input devices available!\n");
784 printf ("%s\n", stdio_devices[stdin]->name);
788 if (stdio_devices[stdout] == NULL) {
789 puts("No output devices available!\n");
791 printf ("%s\n", stdio_devices[stdout]->name);
795 if (stdio_devices[stderr] == NULL) {
796 puts("No error devices available!\n");
798 printf ("%s\n", stdio_devices[stderr]->name);
802 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
803 /* Called after the relocation - use desired console functions */
804 int console_init_r(void)
806 char *stdinname, *stdoutname, *stderrname;
807 struct stdio_dev *inputdev = NULL, *outputdev = NULL, *errdev = NULL;
808 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
810 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
811 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
816 /* update silent for env loaded from flash (initr_env) */
817 if (console_update_silent())
818 flushpoint = PRE_CONSOLE_FLUSHPOINT1_SERIAL;
820 flushpoint = PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL;
822 /* set default handlers at first */
823 gd->jt->getc = serial_getc;
824 gd->jt->tstc = serial_tstc;
825 gd->jt->putc = serial_putc;
826 gd->jt->puts = serial_puts;
827 gd->jt->printf = serial_printf;
829 /* stdin stdout and stderr are in environment */
831 stdinname = env_get("stdin");
832 stdoutname = env_get("stdout");
833 stderrname = env_get("stderr");
835 if (OVERWRITE_CONSOLE == 0) { /* if not overwritten by config switch */
836 inputdev = search_device(DEV_FLAGS_INPUT, stdinname);
837 outputdev = search_device(DEV_FLAGS_OUTPUT, stdoutname);
838 errdev = search_device(DEV_FLAGS_OUTPUT, stderrname);
839 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
840 iomux_err = iomux_doenv(stdin, stdinname);
841 iomux_err += iomux_doenv(stdout, stdoutname);
842 iomux_err += iomux_doenv(stderr, stderrname);
844 /* Successful, so skip all the code below. */
848 /* if the devices are overwritten or not found, use default device */
849 if (inputdev == NULL) {
850 inputdev = search_device(DEV_FLAGS_INPUT, "serial");
852 if (outputdev == NULL) {
853 outputdev = search_device(DEV_FLAGS_OUTPUT, "serial");
855 if (errdev == NULL) {
856 errdev = search_device(DEV_FLAGS_OUTPUT, "serial");
858 /* Initializes output console first */
859 if (outputdev != NULL) {
860 /* need to set a console if not done above. */
861 console_doenv(stdout, outputdev);
863 if (errdev != NULL) {
864 /* need to set a console if not done above. */
865 console_doenv(stderr, errdev);
867 if (inputdev != NULL) {
868 /* need to set a console if not done above. */
869 console_doenv(stdin, inputdev);
872 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
876 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
877 stdio_print_current_devices();
878 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
879 #ifdef CONFIG_VIDCONSOLE_AS_LCD
880 if (strstr(stdoutname, "lcd"))
881 printf("Warning: Please change 'lcd' to 'vidconsole' in stdout/stderr environment vars\n");
884 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
885 /* set the environment variables (will overwrite previous env settings) */
886 for (i = 0; i < MAX_FILES; i++) {
887 env_set(stdio_names[i], stdio_devices[i]->name);
889 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
891 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
894 /* If nothing usable installed, use only the initial console */
895 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
898 print_pre_console_buffer(flushpoint);
902 #else /* !CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */
904 /* Called after the relocation - use desired console functions */
905 int console_init_r(void)
907 struct stdio_dev *inputdev = NULL, *outputdev = NULL;
909 struct list_head *list = stdio_get_list();
910 struct list_head *pos;
911 struct stdio_dev *dev;
914 /* update silent for env loaded from flash (initr_env) */
915 if (console_update_silent())
916 flushpoint = PRE_CONSOLE_FLUSHPOINT1_SERIAL;
918 flushpoint = PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL;
920 #ifdef CONFIG_SPLASH_SCREEN
922 * suppress all output if splash screen is enabled and we have
923 * a bmp to display. We redirect the output from frame buffer
924 * console to serial console in this case or suppress it if
925 * "silent" mode was requested.
927 if (env_get("splashimage") != NULL) {
928 if (!(gd->flags & GD_FLG_SILENT))
929 outputdev = search_device (DEV_FLAGS_OUTPUT, "serial");
933 /* Scan devices looking for input and output devices */
934 list_for_each(pos, list) {
935 dev = list_entry(pos, struct stdio_dev, list);
937 if ((dev->flags & DEV_FLAGS_INPUT) && (inputdev == NULL)) {
940 if ((dev->flags & DEV_FLAGS_OUTPUT) && (outputdev == NULL)) {
943 if(inputdev && outputdev)
947 /* Initializes output console first */
948 if (outputdev != NULL) {
949 console_setfile(stdout, outputdev);
950 console_setfile(stderr, outputdev);
951 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
952 console_devices[stdout][0] = outputdev;
953 console_devices[stderr][0] = outputdev;
957 /* Initializes input console */
958 if (inputdev != NULL) {
959 console_setfile(stdin, inputdev);
960 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
961 console_devices[stdin][0] = inputdev;
965 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
966 stdio_print_current_devices();
967 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
969 /* Setting environment variables */
970 for (i = 0; i < MAX_FILES; i++) {
971 env_set(stdio_names[i], stdio_devices[i]->name);
974 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
977 /* If nothing usable installed, use only the initial console */
978 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
981 print_pre_console_buffer(flushpoint);
985 #endif /* CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */