3 * Paolo Scaffardi, AIRVENT SAM s.p.a - RIMINI(ITALY), arsenio@tin.it
5 * SPDX-License-Identifier: GPL-2.0+
10 #include <debug_uart.h>
16 #include <stdio_dev.h>
18 #include <environment.h>
21 DECLARE_GLOBAL_DATA_PTR;
23 static int on_console(const char *name, const char *value, enum env_op op,
28 /* Check for console redirection */
29 if (strcmp(name, "stdin") == 0)
31 else if (strcmp(name, "stdout") == 0)
33 else if (strcmp(name, "stderr") == 0)
36 /* if not actually setting a console variable, we don't care */
37 if (console == -1 || (gd->flags & GD_FLG_DEVINIT) == 0)
42 case env_op_overwrite:
44 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
45 if (iomux_doenv(console, value))
48 /* Try assigning specified device */
49 if (console_assign(console, value) < 0)
55 if ((flags & H_FORCE) == 0)
56 printf("Can't delete \"%s\"\n", name);
63 U_BOOT_ENV_CALLBACK(console, on_console);
65 #ifdef CONFIG_SILENT_CONSOLE
66 static int on_silent(const char *name, const char *value, enum env_op op,
69 #if !CONFIG_IS_ENABLED(CONFIG_SILENT_CONSOLE_UPDATE_ON_SET)
70 if (flags & H_INTERACTIVE)
73 #if !CONFIG_IS_ENABLED(CONFIG_SILENT_CONSOLE_UPDATE_ON_RELOC)
74 if ((flags & H_INTERACTIVE) == 0)
79 gd->flags |= GD_FLG_SILENT;
81 gd->flags &= ~GD_FLG_SILENT;
85 U_BOOT_ENV_CALLBACK(silent, on_silent);
88 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
90 * if overwrite_console returns 1, the stdin, stderr and stdout
91 * are switched to the serial port, else the settings in the
92 * environment are used
94 #ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
95 extern int overwrite_console(void);
96 #define OVERWRITE_CONSOLE overwrite_console()
98 #define OVERWRITE_CONSOLE 0
99 #endif /* CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE */
101 #endif /* CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */
103 static int console_setfile(int file, struct stdio_dev * dev)
114 /* Start new device */
116 error = dev->start(dev);
117 /* If it's not started dont use it */
122 /* Assign the new device (leaving the existing one started) */
123 stdio_devices[file] = dev;
126 * Update monitor functions
127 * (to use the console stuff by other applications)
137 gd->jt->printf = printf;
142 default: /* Invalid file ID */
148 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
149 /** Console I/O multiplexing *******************************************/
151 static struct stdio_dev *tstcdev;
152 struct stdio_dev **console_devices[MAX_FILES];
153 int cd_count[MAX_FILES];
156 * This depends on tstc() always being called before getc().
157 * This is guaranteed to be true because this routine is called
158 * only from fgetc() which assures it.
159 * No attempt is made to demultiplex multiple input sources.
161 static int console_getc(int file)
165 /* This is never called with testcdev == NULL */
166 ret = tstcdev->getc(tstcdev);
171 static int console_tstc(int file)
174 struct stdio_dev *dev;
177 for (i = 0; i < cd_count[file]; i++) {
178 dev = console_devices[file][i];
179 if (dev->tstc != NULL) {
180 ret = dev->tstc(dev);
193 static void console_putc(int file, const char c)
196 struct stdio_dev *dev;
198 for (i = 0; i < cd_count[file]; i++) {
199 dev = console_devices[file][i];
200 if (dev->putc != NULL)
205 #if CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
206 static void console_puts_noserial(int file, const char *s)
209 struct stdio_dev *dev;
211 for (i = 0; i < cd_count[file]; i++) {
212 dev = console_devices[file][i];
213 if (dev->puts != NULL && strcmp(dev->name, "serial") != 0)
219 static void console_puts(int file, const char *s)
222 struct stdio_dev *dev;
224 for (i = 0; i < cd_count[file]; i++) {
225 dev = console_devices[file][i];
226 if (dev->puts != NULL)
231 static inline void console_doenv(int file, struct stdio_dev *dev)
233 iomux_doenv(file, dev->name);
236 static inline int console_getc(int file)
238 return stdio_devices[file]->getc(stdio_devices[file]);
241 static inline int console_tstc(int file)
243 return stdio_devices[file]->tstc(stdio_devices[file]);
246 static inline void console_putc(int file, const char c)
248 stdio_devices[file]->putc(stdio_devices[file], c);
251 #if CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
252 static inline void console_puts_noserial(int file, const char *s)
254 if (strcmp(stdio_devices[file]->name, "serial") != 0)
255 stdio_devices[file]->puts(stdio_devices[file], s);
259 static inline void console_puts(int file, const char *s)
261 stdio_devices[file]->puts(stdio_devices[file], s);
264 static inline void console_doenv(int file, struct stdio_dev *dev)
266 console_setfile(file, dev);
268 #endif /* CONIFIG_IS_ENABLED(CONSOLE_MUX) */
270 /** U-Boot INITIAL CONSOLE-NOT COMPATIBLE FUNCTIONS *************************/
272 int serial_printf(const char *fmt, ...)
276 char printbuffer[CONFIG_SYS_PBSIZE];
280 /* For this to work, printbuffer must be larger than
281 * anything we ever want to print.
283 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
286 serial_puts(printbuffer);
292 if (file < MAX_FILES) {
293 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
295 * Effectively poll for input wherever it may be available.
300 * Upper layer may have already called tstc() so
301 * check for that first.
304 return console_getc(file);
306 #ifdef CONFIG_WATCHDOG
308 * If the watchdog must be rate-limited then it should
309 * already be handled in board-specific code.
315 return console_getc(file);
324 if (file < MAX_FILES)
325 return console_tstc(file);
330 void fputc(int file, const char c)
332 if (file < MAX_FILES)
333 console_putc(file, c);
336 void fputs(int file, const char *s)
338 if (file < MAX_FILES)
339 console_puts(file, s);
342 int fprintf(int file, const char *fmt, ...)
346 char printbuffer[CONFIG_SYS_PBSIZE];
350 /* For this to work, printbuffer must be larger than
351 * anything we ever want to print.
353 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
356 /* Send to desired file */
357 fputs(file, printbuffer);
361 /** U-Boot INITIAL CONSOLE-COMPATIBLE FUNCTION *****************************/
365 #ifdef CONFIG_DISABLE_CONSOLE
366 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
370 if (!gd->have_console)
373 #ifdef CONFIG_CONSOLE_RECORD
374 if (gd->console_in.start) {
377 ch = membuff_getbyte(&gd->console_in);
382 if (gd->flags & GD_FLG_DEVINIT) {
383 /* Get from the standard input */
387 /* Send directly to the handler */
388 return serial_getc();
393 #ifdef CONFIG_DISABLE_CONSOLE
394 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
398 if (!gd->have_console)
400 #ifdef CONFIG_CONSOLE_RECORD
401 if (gd->console_in.start) {
402 if (membuff_peekbyte(&gd->console_in) != -1)
406 if (gd->flags & GD_FLG_DEVINIT) {
407 /* Test the standard input */
411 /* Send directly to the handler */
412 return serial_tstc();
415 #define PRE_CONSOLE_FLUSHPOINT1_SERIAL 0
416 #define PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL 1
418 #if CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
419 #define CIRC_BUF_IDX(idx) ((idx) % (unsigned long)CONFIG_PRE_CON_BUF_SZ)
421 static void pre_console_putc(const char c)
423 char *buffer = (char *)CONFIG_PRE_CON_BUF_ADDR;
425 buffer[CIRC_BUF_IDX(gd->precon_buf_idx++)] = c;
428 static void pre_console_puts(const char *s)
431 pre_console_putc(*s++);
434 static void print_pre_console_buffer(int flushpoint)
436 unsigned long in = 0, out = 0;
437 char *buf_in = (char *)CONFIG_PRE_CON_BUF_ADDR;
438 char buf_out[CONFIG_PRE_CON_BUF_SZ + 1];
440 if (gd->precon_buf_idx > CONFIG_PRE_CON_BUF_SZ)
441 in = gd->precon_buf_idx - CONFIG_PRE_CON_BUF_SZ;
443 while (in < gd->precon_buf_idx)
444 buf_out[out++] = buf_in[CIRC_BUF_IDX(in++)];
448 switch (flushpoint) {
449 case PRE_CONSOLE_FLUSHPOINT1_SERIAL:
452 case PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL:
453 console_puts_noserial(stdout, buf_out);
458 static inline void pre_console_putc(const char c) {}
459 static inline void pre_console_puts(const char *s) {}
460 static inline void print_pre_console_buffer(int flushpoint) {}
463 void putc(const char c)
465 #ifdef CONFIG_SANDBOX
466 /* sandbox can send characters to stdout before it has a console */
467 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
472 #ifdef CONFIG_DEBUG_UART
473 /* if we don't have a console yet, use the debug UART */
474 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
479 #ifdef CONFIG_CONSOLE_RECORD
480 if (gd && (gd->flags & GD_FLG_RECORD) && gd->console_out.start)
481 membuff_putbyte(&gd->console_out, c);
483 #ifdef CONFIG_SILENT_CONSOLE
484 if (gd->flags & GD_FLG_SILENT)
488 #ifdef CONFIG_DISABLE_CONSOLE
489 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
493 if (!gd->have_console)
494 return pre_console_putc(c);
496 if (gd->flags & GD_FLG_DEVINIT) {
497 /* Send to the standard output */
500 /* Send directly to the handler */
506 void puts(const char *s)
508 #ifdef CONFIG_SANDBOX
509 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
514 #ifdef CONFIG_DEBUG_UART
515 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
524 #ifdef CONFIG_CONSOLE_RECORD
525 if (gd && (gd->flags & GD_FLG_RECORD) && gd->console_out.start)
526 membuff_put(&gd->console_out, s, strlen(s));
528 #ifdef CONFIG_SILENT_CONSOLE
529 if (gd->flags & GD_FLG_SILENT)
533 #ifdef CONFIG_DISABLE_CONSOLE
534 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
538 if (!gd->have_console)
539 return pre_console_puts(s);
541 if (gd->flags & GD_FLG_DEVINIT) {
542 /* Send to the standard output */
545 /* Send directly to the handler */
551 #ifdef CONFIG_CONSOLE_RECORD
552 int console_record_init(void)
556 ret = membuff_new(&gd->console_out, CONFIG_CONSOLE_RECORD_OUT_SIZE);
559 ret = membuff_new(&gd->console_in, CONFIG_CONSOLE_RECORD_IN_SIZE);
564 void console_record_reset(void)
566 membuff_purge(&gd->console_out);
567 membuff_purge(&gd->console_in);
570 void console_record_reset_enable(void)
572 console_record_reset();
573 gd->flags |= GD_FLG_RECORD;
577 /* test if ctrl-c was pressed */
578 static int ctrlc_disabled = 0; /* see disable_ctrl() */
579 static int ctrlc_was_pressed = 0;
582 #ifndef CONFIG_SANDBOX
583 if (!ctrlc_disabled && gd->have_console) {
586 case 0x03: /* ^C - Control C */
587 ctrlc_was_pressed = 1;
598 /* Reads user's confirmation.
599 Returns 1 if user's input is "y", "Y", "yes" or "YES"
601 int confirm_yesno(void)
610 while (i < sizeof(str_input)) {
611 str_input[i] = getc();
613 if (str_input[i] == '\r')
618 if (strncmp(str_input, "y\r", 2) == 0 ||
619 strncmp(str_input, "Y\r", 2) == 0 ||
620 strncmp(str_input, "yes\r", 4) == 0 ||
621 strncmp(str_input, "YES\r", 4) == 0)
625 /* pass 1 to disable ctrlc() checking, 0 to enable.
626 * returns previous state
628 int disable_ctrlc(int disable)
630 int prev = ctrlc_disabled; /* save previous state */
632 ctrlc_disabled = disable;
638 return ctrlc_was_pressed;
641 void clear_ctrlc(void)
643 ctrlc_was_pressed = 0;
646 /** U-Boot INIT FUNCTIONS *************************************************/
648 struct stdio_dev *search_device(int flags, const char *name)
650 struct stdio_dev *dev;
652 dev = stdio_get_by_name(name);
653 #ifdef CONFIG_VIDCONSOLE_AS_LCD
654 if (!dev && !strcmp(name, "lcd"))
655 dev = stdio_get_by_name("vidconsole");
658 if (dev && (dev->flags & flags))
664 int console_assign(int file, const char *devname)
667 struct stdio_dev *dev;
669 /* Check for valid file */
672 flag = DEV_FLAGS_INPUT;
676 flag = DEV_FLAGS_OUTPUT;
682 /* Check for valid device name */
684 dev = search_device(flag, devname);
687 return console_setfile(file, dev);
692 static void console_update_silent(void)
694 #ifdef CONFIG_SILENT_CONSOLE
695 if (getenv("silent") != NULL)
696 gd->flags |= GD_FLG_SILENT;
698 gd->flags &= ~GD_FLG_SILENT;
702 /* Called before relocation - use serial functions */
703 int console_init_f(void)
705 gd->have_console = 1;
707 console_update_silent();
709 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT1_SERIAL);
714 void stdio_print_current_devices(void)
716 /* Print information */
718 if (stdio_devices[stdin] == NULL) {
719 puts("No input devices available!\n");
721 printf ("%s\n", stdio_devices[stdin]->name);
725 if (stdio_devices[stdout] == NULL) {
726 puts("No output devices available!\n");
728 printf ("%s\n", stdio_devices[stdout]->name);
732 if (stdio_devices[stderr] == NULL) {
733 puts("No error devices available!\n");
735 printf ("%s\n", stdio_devices[stderr]->name);
739 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
740 /* Called after the relocation - use desired console functions */
741 int console_init_r(void)
743 char *stdinname, *stdoutname, *stderrname;
744 struct stdio_dev *inputdev = NULL, *outputdev = NULL, *errdev = NULL;
745 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
747 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
748 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
752 /* set default handlers at first */
753 gd->jt->getc = serial_getc;
754 gd->jt->tstc = serial_tstc;
755 gd->jt->putc = serial_putc;
756 gd->jt->puts = serial_puts;
757 gd->jt->printf = serial_printf;
759 /* stdin stdout and stderr are in environment */
761 stdinname = getenv("stdin");
762 stdoutname = getenv("stdout");
763 stderrname = getenv("stderr");
765 if (OVERWRITE_CONSOLE == 0) { /* if not overwritten by config switch */
766 inputdev = search_device(DEV_FLAGS_INPUT, stdinname);
767 outputdev = search_device(DEV_FLAGS_OUTPUT, stdoutname);
768 errdev = search_device(DEV_FLAGS_OUTPUT, stderrname);
769 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
770 iomux_err = iomux_doenv(stdin, stdinname);
771 iomux_err += iomux_doenv(stdout, stdoutname);
772 iomux_err += iomux_doenv(stderr, stderrname);
774 /* Successful, so skip all the code below. */
778 /* if the devices are overwritten or not found, use default device */
779 if (inputdev == NULL) {
780 inputdev = search_device(DEV_FLAGS_INPUT, "serial");
782 if (outputdev == NULL) {
783 outputdev = search_device(DEV_FLAGS_OUTPUT, "serial");
785 if (errdev == NULL) {
786 errdev = search_device(DEV_FLAGS_OUTPUT, "serial");
788 /* Initializes output console first */
789 if (outputdev != NULL) {
790 /* need to set a console if not done above. */
791 console_doenv(stdout, outputdev);
793 if (errdev != NULL) {
794 /* need to set a console if not done above. */
795 console_doenv(stderr, errdev);
797 if (inputdev != NULL) {
798 /* need to set a console if not done above. */
799 console_doenv(stdin, inputdev);
802 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
806 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
807 stdio_print_current_devices();
808 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
809 #ifdef CONFIG_VIDCONSOLE_AS_LCD
810 if (strstr(stdoutname, "lcd"))
811 printf("Warning: Please change 'lcd' to 'vidconsole' in stdout/stderr environment vars\n");
814 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
815 /* set the environment variables (will overwrite previous env settings) */
816 for (i = 0; i < 3; i++) {
817 setenv(stdio_names[i], stdio_devices[i]->name);
819 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
821 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
824 /* If nothing usable installed, use only the initial console */
825 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
828 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL);
832 #else /* !CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */
834 /* Called after the relocation - use desired console functions */
835 int console_init_r(void)
837 struct stdio_dev *inputdev = NULL, *outputdev = NULL;
839 struct list_head *list = stdio_get_list();
840 struct list_head *pos;
841 struct stdio_dev *dev;
843 console_update_silent();
845 #ifdef CONFIG_SPLASH_SCREEN
847 * suppress all output if splash screen is enabled and we have
848 * a bmp to display. We redirect the output from frame buffer
849 * console to serial console in this case or suppress it if
850 * "silent" mode was requested.
852 if (getenv("splashimage") != NULL) {
853 if (!(gd->flags & GD_FLG_SILENT))
854 outputdev = search_device (DEV_FLAGS_OUTPUT, "serial");
858 /* Scan devices looking for input and output devices */
859 list_for_each(pos, list) {
860 dev = list_entry(pos, struct stdio_dev, list);
862 if ((dev->flags & DEV_FLAGS_INPUT) && (inputdev == NULL)) {
865 if ((dev->flags & DEV_FLAGS_OUTPUT) && (outputdev == NULL)) {
868 if(inputdev && outputdev)
872 /* Initializes output console first */
873 if (outputdev != NULL) {
874 console_setfile(stdout, outputdev);
875 console_setfile(stderr, outputdev);
876 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
877 console_devices[stdout][0] = outputdev;
878 console_devices[stderr][0] = outputdev;
882 /* Initializes input console */
883 if (inputdev != NULL) {
884 console_setfile(stdin, inputdev);
885 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
886 console_devices[stdin][0] = inputdev;
890 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
891 stdio_print_current_devices();
892 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
894 /* Setting environment variables */
895 for (i = 0; i < 3; i++) {
896 setenv(stdio_names[i], stdio_devices[i]->name);
899 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
902 /* If nothing usable installed, use only the initial console */
903 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
906 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL);
910 #endif /* CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */