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) {
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)) {
508 #ifdef CONFIG_CONSOLE_RECORD
509 if ((gd->flags & GD_FLG_RECORD) && gd->console_out.start)
510 membuff_putbyte(&gd->console_out, c);
512 #ifdef CONFIG_SILENT_CONSOLE
513 if (gd->flags & GD_FLG_SILENT)
517 #ifdef CONFIG_DISABLE_CONSOLE
518 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
522 if (!gd->have_console)
523 return pre_console_putc(c);
525 if (gd->flags & GD_FLG_DEVINIT) {
526 /* Send to the standard output */
529 /* Send directly to the handler */
535 void puts(const char *s)
537 #ifdef CONFIG_DEBUG_UART
538 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
549 #ifdef CONFIG_CONSOLE_RECORD
550 if ((gd->flags & GD_FLG_RECORD) && gd->console_out.start)
551 membuff_put(&gd->console_out, s, strlen(s));
553 #ifdef CONFIG_SILENT_CONSOLE
554 if (gd->flags & GD_FLG_SILENT)
558 #ifdef CONFIG_DISABLE_CONSOLE
559 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
563 if (!gd->have_console)
564 return pre_console_puts(s);
566 if (gd->flags & GD_FLG_DEVINIT) {
567 /* Send to the standard output */
570 /* Send directly to the handler */
576 #ifdef CONFIG_CONSOLE_RECORD
577 int console_record_init(void)
581 ret = membuff_new(&gd->console_out, CONFIG_CONSOLE_RECORD_OUT_SIZE);
584 ret = membuff_new(&gd->console_in, CONFIG_CONSOLE_RECORD_IN_SIZE);
589 void console_record_reset(void)
591 membuff_purge(&gd->console_out);
592 membuff_purge(&gd->console_in);
595 void console_record_reset_enable(void)
597 console_record_reset();
598 gd->flags |= GD_FLG_RECORD;
602 /* test if ctrl-c was pressed */
603 static int ctrlc_disabled = 0; /* see disable_ctrl() */
604 static int ctrlc_was_pressed = 0;
607 if (!ctrlc_disabled && gd->have_console) {
610 case 0x03: /* ^C - Control C */
611 ctrlc_was_pressed = 1;
621 /* Reads user's confirmation.
622 Returns 1 if user's input is "y", "Y", "yes" or "YES"
624 int confirm_yesno(void)
633 while (i < sizeof(str_input)) {
634 str_input[i] = getc();
636 if (str_input[i] == '\r')
641 if (strncmp(str_input, "y\r", 2) == 0 ||
642 strncmp(str_input, "Y\r", 2) == 0 ||
643 strncmp(str_input, "yes\r", 4) == 0 ||
644 strncmp(str_input, "YES\r", 4) == 0)
648 /* pass 1 to disable ctrlc() checking, 0 to enable.
649 * returns previous state
651 int disable_ctrlc(int disable)
653 int prev = ctrlc_disabled; /* save previous state */
655 ctrlc_disabled = disable;
661 return ctrlc_was_pressed;
664 void clear_ctrlc(void)
666 ctrlc_was_pressed = 0;
669 /** U-Boot INIT FUNCTIONS *************************************************/
671 struct stdio_dev *search_device(int flags, const char *name)
673 struct stdio_dev *dev;
675 dev = stdio_get_by_name(name);
676 #ifdef CONFIG_VIDCONSOLE_AS_LCD
677 if (!dev && !strcmp(name, "lcd"))
678 dev = stdio_get_by_name("vidconsole");
681 if (dev && (dev->flags & flags))
687 int console_assign(int file, const char *devname)
690 struct stdio_dev *dev;
692 /* Check for valid file */
695 flag = DEV_FLAGS_INPUT;
699 flag = DEV_FLAGS_OUTPUT;
705 /* Check for valid device name */
707 dev = search_device(flag, devname);
710 return console_setfile(file, dev);
715 static void console_update_silent(void)
717 #ifdef CONFIG_SILENT_CONSOLE
718 if (env_get("silent") != NULL)
719 gd->flags |= GD_FLG_SILENT;
721 gd->flags &= ~GD_FLG_SILENT;
725 int console_announce_r(void)
727 #if !CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
728 char buf[DISPLAY_OPTIONS_BANNER_LENGTH];
730 display_options_get_banner(false, buf, sizeof(buf));
732 console_puts_noserial(stdout, buf);
738 /* Called before relocation - use serial functions */
739 int console_init_f(void)
741 gd->have_console = 1;
743 console_update_silent();
745 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT1_SERIAL);
750 void stdio_print_current_devices(void)
752 /* Print information */
754 if (stdio_devices[stdin] == NULL) {
755 puts("No input devices available!\n");
757 printf ("%s\n", stdio_devices[stdin]->name);
761 if (stdio_devices[stdout] == NULL) {
762 puts("No output devices available!\n");
764 printf ("%s\n", stdio_devices[stdout]->name);
768 if (stdio_devices[stderr] == NULL) {
769 puts("No error devices available!\n");
771 printf ("%s\n", stdio_devices[stderr]->name);
775 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
776 /* Called after the relocation - use desired console functions */
777 int console_init_r(void)
779 char *stdinname, *stdoutname, *stderrname;
780 struct stdio_dev *inputdev = NULL, *outputdev = NULL, *errdev = NULL;
781 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
783 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
784 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
788 /* set default handlers at first */
789 gd->jt->getc = serial_getc;
790 gd->jt->tstc = serial_tstc;
791 gd->jt->putc = serial_putc;
792 gd->jt->puts = serial_puts;
793 gd->jt->printf = serial_printf;
795 /* stdin stdout and stderr are in environment */
797 stdinname = env_get("stdin");
798 stdoutname = env_get("stdout");
799 stderrname = env_get("stderr");
801 if (OVERWRITE_CONSOLE == 0) { /* if not overwritten by config switch */
802 inputdev = search_device(DEV_FLAGS_INPUT, stdinname);
803 outputdev = search_device(DEV_FLAGS_OUTPUT, stdoutname);
804 errdev = search_device(DEV_FLAGS_OUTPUT, stderrname);
805 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
806 iomux_err = iomux_doenv(stdin, stdinname);
807 iomux_err += iomux_doenv(stdout, stdoutname);
808 iomux_err += iomux_doenv(stderr, stderrname);
810 /* Successful, so skip all the code below. */
814 /* if the devices are overwritten or not found, use default device */
815 if (inputdev == NULL) {
816 inputdev = search_device(DEV_FLAGS_INPUT, "serial");
818 if (outputdev == NULL) {
819 outputdev = search_device(DEV_FLAGS_OUTPUT, "serial");
821 if (errdev == NULL) {
822 errdev = search_device(DEV_FLAGS_OUTPUT, "serial");
824 /* Initializes output console first */
825 if (outputdev != NULL) {
826 /* need to set a console if not done above. */
827 console_doenv(stdout, outputdev);
829 if (errdev != NULL) {
830 /* need to set a console if not done above. */
831 console_doenv(stderr, errdev);
833 if (inputdev != NULL) {
834 /* need to set a console if not done above. */
835 console_doenv(stdin, inputdev);
838 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
842 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
843 stdio_print_current_devices();
844 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
845 #ifdef CONFIG_VIDCONSOLE_AS_LCD
846 if (strstr(stdoutname, "lcd"))
847 printf("Warning: Please change 'lcd' to 'vidconsole' in stdout/stderr environment vars\n");
850 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
851 /* set the environment variables (will overwrite previous env settings) */
852 for (i = 0; i < MAX_FILES; i++) {
853 env_set(stdio_names[i], stdio_devices[i]->name);
855 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
857 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
860 /* If nothing usable installed, use only the initial console */
861 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
864 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL);
868 #else /* !CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */
870 /* Called after the relocation - use desired console functions */
871 int console_init_r(void)
873 struct stdio_dev *inputdev = NULL, *outputdev = NULL;
875 struct list_head *list = stdio_get_list();
876 struct list_head *pos;
877 struct stdio_dev *dev;
879 console_update_silent();
881 #ifdef CONFIG_SPLASH_SCREEN
883 * suppress all output if splash screen is enabled and we have
884 * a bmp to display. We redirect the output from frame buffer
885 * console to serial console in this case or suppress it if
886 * "silent" mode was requested.
888 if (env_get("splashimage") != NULL) {
889 if (!(gd->flags & GD_FLG_SILENT))
890 outputdev = search_device (DEV_FLAGS_OUTPUT, "serial");
894 /* Scan devices looking for input and output devices */
895 list_for_each(pos, list) {
896 dev = list_entry(pos, struct stdio_dev, list);
898 if ((dev->flags & DEV_FLAGS_INPUT) && (inputdev == NULL)) {
901 if ((dev->flags & DEV_FLAGS_OUTPUT) && (outputdev == NULL)) {
904 if(inputdev && outputdev)
908 /* Initializes output console first */
909 if (outputdev != NULL) {
910 console_setfile(stdout, outputdev);
911 console_setfile(stderr, outputdev);
912 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
913 console_devices[stdout][0] = outputdev;
914 console_devices[stderr][0] = outputdev;
918 /* Initializes input console */
919 if (inputdev != NULL) {
920 console_setfile(stdin, inputdev);
921 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
922 console_devices[stdin][0] = inputdev;
926 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
927 stdio_print_current_devices();
928 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
930 /* Setting environment variables */
931 for (i = 0; i < MAX_FILES; i++) {
932 env_set(stdio_names[i], stdio_devices[i]->name);
935 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
938 /* If nothing usable installed, use only the initial console */
939 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
942 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL);
946 #endif /* CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */