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)
58 if ((flags & H_FORCE) == 0)
59 printf("Can't delete \"%s\"\n", name);
66 U_BOOT_ENV_CALLBACK(console, on_console);
68 #ifdef CONFIG_SILENT_CONSOLE
69 static int on_silent(const char *name, const char *value, enum env_op op,
72 #if !CONFIG_IS_ENABLED(SILENT_CONSOLE_UPDATE_ON_SET)
73 if (flags & H_INTERACTIVE)
76 #if !CONFIG_IS_ENABLED(SILENT_CONSOLE_UPDATE_ON_RELOC)
77 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 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
93 * if overwrite_console returns 1, the stdin, stderr and stdout
94 * are switched to the serial port, else the settings in the
95 * environment are used
97 #ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
98 extern int overwrite_console(void);
99 #define OVERWRITE_CONSOLE overwrite_console()
101 #define OVERWRITE_CONSOLE 0
102 #endif /* CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE */
104 #endif /* CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */
106 static int console_setfile(int file, struct stdio_dev * dev)
117 /* Start new device */
119 error = dev->start(dev);
120 /* If it's not started dont use it */
125 /* Assign the new device (leaving the existing one started) */
126 stdio_devices[file] = dev;
129 * Update monitor functions
130 * (to use the console stuff by other applications)
140 gd->jt->printf = printf;
145 default: /* Invalid file ID */
152 * console_dev_is_serial() - Check if a stdio device is a serial device
154 * @sdev: Device to check
155 * @return true if this device is in the serial uclass (or for pre-driver-model,
156 * whether it is called "serial".
158 static bool console_dev_is_serial(struct stdio_dev *sdev)
162 #ifdef CONFIG_DM_SERIAL
163 if (sdev->flags & DEV_FLAGS_DM) {
164 struct udevice *dev = sdev->priv;
166 is_serial = device_get_uclass_id(dev) == UCLASS_SERIAL;
169 is_serial = !strcmp(sdev->name, "serial");
174 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
175 /** Console I/O multiplexing *******************************************/
177 static struct stdio_dev *tstcdev;
178 struct stdio_dev **console_devices[MAX_FILES];
179 int cd_count[MAX_FILES];
182 * This depends on tstc() always being called before getc().
183 * This is guaranteed to be true because this routine is called
184 * only from fgetc() which assures it.
185 * No attempt is made to demultiplex multiple input sources.
187 static int console_getc(int file)
191 /* This is never called with testcdev == NULL */
192 ret = tstcdev->getc(tstcdev);
197 static int console_tstc(int file)
200 struct stdio_dev *dev;
203 prev = disable_ctrlc(1);
204 for (i = 0; i < cd_count[file]; i++) {
205 dev = console_devices[file][i];
206 if (dev->tstc != NULL) {
207 ret = dev->tstc(dev);
220 static void console_putc(int file, const char c)
223 struct stdio_dev *dev;
225 for (i = 0; i < cd_count[file]; i++) {
226 dev = console_devices[file][i];
227 if (dev->putc != NULL)
232 static void console_puts_noserial(int file, const char *s)
235 struct stdio_dev *dev;
237 for (i = 0; i < cd_count[file]; i++) {
238 dev = console_devices[file][i];
239 if (dev->puts != NULL && !console_dev_is_serial(dev))
244 static void console_puts(int file, const char *s)
247 struct stdio_dev *dev;
249 for (i = 0; i < cd_count[file]; i++) {
250 dev = console_devices[file][i];
251 if (dev->puts != NULL)
256 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
257 static inline void console_doenv(int file, struct stdio_dev *dev)
259 iomux_doenv(file, dev->name);
263 static inline int console_getc(int file)
265 return stdio_devices[file]->getc(stdio_devices[file]);
268 static inline int console_tstc(int file)
270 return stdio_devices[file]->tstc(stdio_devices[file]);
273 static inline void console_putc(int file, const char c)
275 stdio_devices[file]->putc(stdio_devices[file], c);
278 static inline void console_puts_noserial(int file, const char *s)
280 if (!console_dev_is_serial(stdio_devices[file]))
281 stdio_devices[file]->puts(stdio_devices[file], s);
284 static inline void console_puts(int file, const char *s)
286 stdio_devices[file]->puts(stdio_devices[file], s);
289 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
290 static inline void console_doenv(int file, struct stdio_dev *dev)
292 console_setfile(file, dev);
295 #endif /* CONIFIG_IS_ENABLED(CONSOLE_MUX) */
297 /** U-Boot INITIAL CONSOLE-NOT COMPATIBLE FUNCTIONS *************************/
299 int serial_printf(const char *fmt, ...)
303 char printbuffer[CONFIG_SYS_PBSIZE];
307 /* For this to work, printbuffer must be larger than
308 * anything we ever want to print.
310 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
313 serial_puts(printbuffer);
319 if (file < MAX_FILES) {
321 * Effectively poll for input wherever it may be available.
325 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
327 * Upper layer may have already called tstc() so
328 * check for that first.
331 return console_getc(file);
334 if (console_tstc(file))
335 return console_getc(file);
337 #ifdef CONFIG_WATCHDOG
339 * If the watchdog must be rate-limited then it should
340 * already be handled in board-specific code.
352 if (file < MAX_FILES)
353 return console_tstc(file);
358 void fputc(int file, const char c)
360 if (file < MAX_FILES)
361 console_putc(file, c);
364 void fputs(int file, const char *s)
366 if (file < MAX_FILES)
367 console_puts(file, s);
370 int fprintf(int file, const char *fmt, ...)
374 char printbuffer[CONFIG_SYS_PBSIZE];
378 /* For this to work, printbuffer must be larger than
379 * anything we ever want to print.
381 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
384 /* Send to desired file */
385 fputs(file, printbuffer);
389 /** U-Boot INITIAL CONSOLE-COMPATIBLE FUNCTION *****************************/
393 #ifdef CONFIG_DISABLE_CONSOLE
394 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
398 if (!gd->have_console)
401 #ifdef CONFIG_CONSOLE_RECORD
402 if (gd->console_in.start) {
405 ch = membuff_getbyte((struct membuff *)&gd->console_in);
410 if (gd->flags & GD_FLG_DEVINIT) {
411 /* Get from the standard input */
415 /* Send directly to the handler */
416 return serial_getc();
421 #ifdef CONFIG_DISABLE_CONSOLE
422 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
426 if (!gd->have_console)
428 #ifdef CONFIG_CONSOLE_RECORD
429 if (gd->console_in.start) {
430 if (membuff_peekbyte((struct membuff *)&gd->console_in) != -1)
434 if (gd->flags & GD_FLG_DEVINIT) {
435 /* Test the standard input */
439 /* Send directly to the handler */
440 return serial_tstc();
443 #define PRE_CONSOLE_FLUSHPOINT1_SERIAL 0
444 #define PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL 1
446 #if CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
447 #define CIRC_BUF_IDX(idx) ((idx) % (unsigned long)CONFIG_PRE_CON_BUF_SZ)
449 static void pre_console_putc(const char c)
453 buffer = map_sysmem(CONFIG_PRE_CON_BUF_ADDR, CONFIG_PRE_CON_BUF_SZ);
455 buffer[CIRC_BUF_IDX(gd->precon_buf_idx++)] = c;
457 unmap_sysmem(buffer);
460 static void pre_console_puts(const char *s)
463 pre_console_putc(*s++);
466 static void print_pre_console_buffer(int flushpoint)
468 unsigned long in = 0, out = 0;
469 char buf_out[CONFIG_PRE_CON_BUF_SZ + 1];
472 #ifdef CONFIG_SILENT_CONSOLE
473 if (gd->flags & GD_FLG_SILENT)
477 buf_in = map_sysmem(CONFIG_PRE_CON_BUF_ADDR, CONFIG_PRE_CON_BUF_SZ);
478 if (gd->precon_buf_idx > CONFIG_PRE_CON_BUF_SZ)
479 in = gd->precon_buf_idx - CONFIG_PRE_CON_BUF_SZ;
481 while (in < gd->precon_buf_idx)
482 buf_out[out++] = buf_in[CIRC_BUF_IDX(in++)];
483 unmap_sysmem(buf_in);
487 switch (flushpoint) {
488 case PRE_CONSOLE_FLUSHPOINT1_SERIAL:
491 case PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL:
492 console_puts_noserial(stdout, buf_out);
497 static inline void pre_console_putc(const char c) {}
498 static inline void pre_console_puts(const char *s) {}
499 static inline void print_pre_console_buffer(int flushpoint) {}
502 void putc(const char c)
504 #ifdef CONFIG_SANDBOX
505 /* sandbox can send characters to stdout before it has a console */
506 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
511 #ifdef CONFIG_DEBUG_UART
512 /* if we don't have a console yet, use the debug UART */
513 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
520 #ifdef CONFIG_CONSOLE_RECORD
521 if ((gd->flags & GD_FLG_RECORD) && gd->console_out.start)
522 membuff_putbyte((struct membuff *)&gd->console_out, c);
524 #ifdef CONFIG_SILENT_CONSOLE
525 if (gd->flags & GD_FLG_SILENT) {
526 if (!(gd->flags & GD_FLG_DEVINIT))
532 #ifdef CONFIG_DISABLE_CONSOLE
533 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
537 if (!gd->have_console)
538 return pre_console_putc(c);
540 if (gd->flags & GD_FLG_DEVINIT) {
541 /* Send to the standard output */
544 /* Send directly to the handler */
550 void puts(const char *s)
552 #ifdef CONFIG_SANDBOX
553 /* sandbox can send characters to stdout before it has a console */
554 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
559 #ifdef CONFIG_DEBUG_UART
560 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
571 #ifdef CONFIG_CONSOLE_RECORD
572 if ((gd->flags & GD_FLG_RECORD) && gd->console_out.start)
573 membuff_put((struct membuff *)&gd->console_out, s, strlen(s));
575 #ifdef CONFIG_SILENT_CONSOLE
576 if (gd->flags & GD_FLG_SILENT) {
577 if (!(gd->flags & GD_FLG_DEVINIT))
583 #ifdef CONFIG_DISABLE_CONSOLE
584 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
588 if (!gd->have_console)
589 return pre_console_puts(s);
591 if (gd->flags & GD_FLG_DEVINIT) {
592 /* Send to the standard output */
595 /* Send directly to the handler */
601 #ifdef CONFIG_CONSOLE_RECORD
602 int console_record_init(void)
606 ret = membuff_new((struct membuff *)&gd->console_out,
607 CONFIG_CONSOLE_RECORD_OUT_SIZE);
610 ret = membuff_new((struct membuff *)&gd->console_in,
611 CONFIG_CONSOLE_RECORD_IN_SIZE);
616 void console_record_reset(void)
618 membuff_purge((struct membuff *)&gd->console_out);
619 membuff_purge((struct membuff *)&gd->console_in);
622 void console_record_reset_enable(void)
624 console_record_reset();
625 gd->flags |= GD_FLG_RECORD;
628 int console_record_readline(char *str, int maxlen)
630 return membuff_readline((struct membuff *)&gd->console_out, str,
634 int console_record_avail(void)
636 return membuff_avail((struct membuff *)&gd->console_out);
641 /* test if ctrl-c was pressed */
642 static int ctrlc_disabled = 0; /* see disable_ctrl() */
643 static int ctrlc_was_pressed = 0;
646 if (!ctrlc_disabled && gd->have_console) {
649 case 0x03: /* ^C - Control C */
650 ctrlc_was_pressed = 1;
660 /* Reads user's confirmation.
661 Returns 1 if user's input is "y", "Y", "yes" or "YES"
663 int confirm_yesno(void)
672 while (i < sizeof(str_input)) {
673 str_input[i] = getc();
675 if (str_input[i] == '\r')
680 if (strncmp(str_input, "y\r", 2) == 0 ||
681 strncmp(str_input, "Y\r", 2) == 0 ||
682 strncmp(str_input, "yes\r", 4) == 0 ||
683 strncmp(str_input, "YES\r", 4) == 0)
687 /* pass 1 to disable ctrlc() checking, 0 to enable.
688 * returns previous state
690 int disable_ctrlc(int disable)
692 int prev = ctrlc_disabled; /* save previous state */
694 ctrlc_disabled = disable;
700 return ctrlc_was_pressed;
703 void clear_ctrlc(void)
705 ctrlc_was_pressed = 0;
708 /** U-Boot INIT FUNCTIONS *************************************************/
710 struct stdio_dev *search_device(int flags, const char *name)
712 struct stdio_dev *dev;
714 dev = stdio_get_by_name(name);
715 #ifdef CONFIG_VIDCONSOLE_AS_LCD
716 if (!dev && !strcmp(name, "lcd"))
717 dev = stdio_get_by_name("vidconsole");
720 if (dev && (dev->flags & flags))
726 int console_assign(int file, const char *devname)
729 struct stdio_dev *dev;
731 /* Check for valid file */
734 flag = DEV_FLAGS_INPUT;
738 flag = DEV_FLAGS_OUTPUT;
744 /* Check for valid device name */
746 dev = search_device(flag, devname);
749 return console_setfile(file, dev);
754 /* return true if the 'silent' flag is removed */
755 static bool console_update_silent(void)
757 #ifdef CONFIG_SILENT_CONSOLE
758 if (env_get("silent")) {
759 gd->flags |= GD_FLG_SILENT;
761 unsigned long flags = gd->flags;
763 gd->flags &= ~GD_FLG_SILENT;
765 return !!(flags & GD_FLG_SILENT);
772 int console_announce_r(void)
774 #if !CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
775 char buf[DISPLAY_OPTIONS_BANNER_LENGTH];
777 display_options_get_banner(false, buf, sizeof(buf));
779 console_puts_noserial(stdout, buf);
785 /* Called before relocation - use serial functions */
786 int console_init_f(void)
788 gd->have_console = 1;
790 console_update_silent();
792 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT1_SERIAL);
797 void stdio_print_current_devices(void)
799 /* Print information */
801 if (stdio_devices[stdin] == NULL) {
802 puts("No input devices available!\n");
804 printf ("%s\n", stdio_devices[stdin]->name);
808 if (stdio_devices[stdout] == NULL) {
809 puts("No output devices available!\n");
811 printf ("%s\n", stdio_devices[stdout]->name);
815 if (stdio_devices[stderr] == NULL) {
816 puts("No error devices available!\n");
818 printf ("%s\n", stdio_devices[stderr]->name);
822 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
823 /* Called after the relocation - use desired console functions */
824 int console_init_r(void)
826 char *stdinname, *stdoutname, *stderrname;
827 struct stdio_dev *inputdev = NULL, *outputdev = NULL, *errdev = NULL;
828 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
830 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
831 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
836 /* update silent for env loaded from flash (initr_env) */
837 if (console_update_silent())
838 flushpoint = PRE_CONSOLE_FLUSHPOINT1_SERIAL;
840 flushpoint = PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL;
842 /* set default handlers at first */
843 gd->jt->getc = serial_getc;
844 gd->jt->tstc = serial_tstc;
845 gd->jt->putc = serial_putc;
846 gd->jt->puts = serial_puts;
847 gd->jt->printf = serial_printf;
849 /* stdin stdout and stderr are in environment */
851 stdinname = env_get("stdin");
852 stdoutname = env_get("stdout");
853 stderrname = env_get("stderr");
855 if (OVERWRITE_CONSOLE == 0) { /* if not overwritten by config switch */
856 inputdev = search_device(DEV_FLAGS_INPUT, stdinname);
857 outputdev = search_device(DEV_FLAGS_OUTPUT, stdoutname);
858 errdev = search_device(DEV_FLAGS_OUTPUT, stderrname);
859 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
860 iomux_err = iomux_doenv(stdin, stdinname);
861 iomux_err += iomux_doenv(stdout, stdoutname);
862 iomux_err += iomux_doenv(stderr, stderrname);
864 /* Successful, so skip all the code below. */
868 /* if the devices are overwritten or not found, use default device */
869 if (inputdev == NULL) {
870 inputdev = search_device(DEV_FLAGS_INPUT, "serial");
872 if (outputdev == NULL) {
873 outputdev = search_device(DEV_FLAGS_OUTPUT, "serial");
875 if (errdev == NULL) {
876 errdev = search_device(DEV_FLAGS_OUTPUT, "serial");
878 /* Initializes output console first */
879 if (outputdev != NULL) {
880 /* need to set a console if not done above. */
881 console_doenv(stdout, outputdev);
883 if (errdev != NULL) {
884 /* need to set a console if not done above. */
885 console_doenv(stderr, errdev);
887 if (inputdev != NULL) {
888 /* need to set a console if not done above. */
889 console_doenv(stdin, inputdev);
892 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
896 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
897 stdio_print_current_devices();
898 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
899 #ifdef CONFIG_VIDCONSOLE_AS_LCD
900 if (strstr(stdoutname, "lcd"))
901 printf("Warning: Please change 'lcd' to 'vidconsole' in stdout/stderr environment vars\n");
904 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
905 /* set the environment variables (will overwrite previous env settings) */
906 for (i = 0; i < MAX_FILES; i++) {
907 env_set(stdio_names[i], stdio_devices[i]->name);
909 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
911 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
914 /* If nothing usable installed, use only the initial console */
915 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
918 print_pre_console_buffer(flushpoint);
922 #else /* !CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */
924 /* Called after the relocation - use desired console functions */
925 int console_init_r(void)
927 struct stdio_dev *inputdev = NULL, *outputdev = NULL;
929 struct list_head *list = stdio_get_list();
930 struct list_head *pos;
931 struct stdio_dev *dev;
934 /* update silent for env loaded from flash (initr_env) */
935 if (console_update_silent())
936 flushpoint = PRE_CONSOLE_FLUSHPOINT1_SERIAL;
938 flushpoint = PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL;
940 #ifdef CONFIG_SPLASH_SCREEN
942 * suppress all output if splash screen is enabled and we have
943 * a bmp to display. We redirect the output from frame buffer
944 * console to serial console in this case or suppress it if
945 * "silent" mode was requested.
947 if (env_get("splashimage") != NULL) {
948 if (!(gd->flags & GD_FLG_SILENT))
949 outputdev = search_device (DEV_FLAGS_OUTPUT, "serial");
953 /* Scan devices looking for input and output devices */
954 list_for_each(pos, list) {
955 dev = list_entry(pos, struct stdio_dev, list);
957 if ((dev->flags & DEV_FLAGS_INPUT) && (inputdev == NULL)) {
960 if ((dev->flags & DEV_FLAGS_OUTPUT) && (outputdev == NULL)) {
963 if(inputdev && outputdev)
967 /* Initializes output console first */
968 if (outputdev != NULL) {
969 console_setfile(stdout, outputdev);
970 console_setfile(stderr, outputdev);
971 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
972 console_devices[stdout][0] = outputdev;
973 console_devices[stderr][0] = outputdev;
977 /* Initializes input console */
978 if (inputdev != NULL) {
979 console_setfile(stdin, inputdev);
980 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
981 console_devices[stdin][0] = inputdev;
985 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
986 stdio_print_current_devices();
987 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
989 /* Setting environment variables */
990 for (i = 0; i < MAX_FILES; i++) {
991 env_set(stdio_names[i], stdio_devices[i]->name);
994 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
997 /* If nothing usable installed, use only the initial console */
998 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
1001 print_pre_console_buffer(flushpoint);
1005 #endif /* CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */