3 * Paolo Scaffardi, AIRVENT SAM s.p.a - RIMINI(ITALY), arsenio@tin.it
5 * SPDX-License-Identifier: GPL-2.0+
9 #include <debug_uart.h>
15 #include <stdio_dev.h>
17 #include <environment.h>
19 DECLARE_GLOBAL_DATA_PTR;
21 static int on_console(const char *name, const char *value, enum env_op op,
26 /* Check for console redirection */
27 if (strcmp(name, "stdin") == 0)
29 else if (strcmp(name, "stdout") == 0)
31 else if (strcmp(name, "stderr") == 0)
34 /* if not actually setting a console variable, we don't care */
35 if (console == -1 || (gd->flags & GD_FLG_DEVINIT) == 0)
40 case env_op_overwrite:
42 #ifdef CONFIG_CONSOLE_MUX
43 if (iomux_doenv(console, value))
46 /* Try assigning specified device */
47 if (console_assign(console, value) < 0)
49 #endif /* CONFIG_CONSOLE_MUX */
53 if ((flags & H_FORCE) == 0)
54 printf("Can't delete \"%s\"\n", name);
61 U_BOOT_ENV_CALLBACK(console, on_console);
63 #ifdef CONFIG_SILENT_CONSOLE
64 static int on_silent(const char *name, const char *value, enum env_op op,
67 #ifndef CONFIG_SILENT_CONSOLE_UPDATE_ON_SET
68 if (flags & H_INTERACTIVE)
71 #ifndef CONFIG_SILENT_CONSOLE_UPDATE_ON_RELOC
72 if ((flags & H_INTERACTIVE) == 0)
77 gd->flags |= GD_FLG_SILENT;
79 gd->flags &= ~GD_FLG_SILENT;
83 U_BOOT_ENV_CALLBACK(silent, on_silent);
86 #ifdef CONFIG_SYS_CONSOLE_IS_IN_ENV
88 * if overwrite_console returns 1, the stdin, stderr and stdout
89 * are switched to the serial port, else the settings in the
90 * environment are used
92 #ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
93 extern int overwrite_console(void);
94 #define OVERWRITE_CONSOLE overwrite_console()
96 #define OVERWRITE_CONSOLE 0
97 #endif /* CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE */
99 #endif /* CONFIG_SYS_CONSOLE_IS_IN_ENV */
101 static int console_setfile(int file, struct stdio_dev * dev)
112 /* Start new device */
114 error = dev->start(dev);
115 /* If it's not started dont use it */
120 /* Assign the new device (leaving the existing one started) */
121 stdio_devices[file] = dev;
124 * Update monitor functions
125 * (to use the console stuff by other applications)
135 gd->jt->printf = printf;
140 default: /* Invalid file ID */
146 #if defined(CONFIG_CONSOLE_MUX)
147 /** Console I/O multiplexing *******************************************/
149 static struct stdio_dev *tstcdev;
150 struct stdio_dev **console_devices[MAX_FILES];
151 int cd_count[MAX_FILES];
154 * This depends on tstc() always being called before getc().
155 * This is guaranteed to be true because this routine is called
156 * only from fgetc() which assures it.
157 * No attempt is made to demultiplex multiple input sources.
159 static int console_getc(int file)
163 /* This is never called with testcdev == NULL */
164 ret = tstcdev->getc(tstcdev);
169 static int console_tstc(int file)
172 struct stdio_dev *dev;
175 for (i = 0; i < cd_count[file]; i++) {
176 dev = console_devices[file][i];
177 if (dev->tstc != NULL) {
178 ret = dev->tstc(dev);
191 static void console_putc(int file, const char c)
194 struct stdio_dev *dev;
196 for (i = 0; i < cd_count[file]; i++) {
197 dev = console_devices[file][i];
198 if (dev->putc != NULL)
203 #ifdef CONFIG_PRE_CONSOLE_BUFFER
204 static void console_puts_noserial(int file, const char *s)
207 struct stdio_dev *dev;
209 for (i = 0; i < cd_count[file]; i++) {
210 dev = console_devices[file][i];
211 if (dev->puts != NULL && strcmp(dev->name, "serial") != 0)
217 static void console_puts(int file, const char *s)
220 struct stdio_dev *dev;
222 for (i = 0; i < cd_count[file]; i++) {
223 dev = console_devices[file][i];
224 if (dev->puts != NULL)
229 static inline void console_printdevs(int file)
231 iomux_printdevs(file);
234 static inline void console_doenv(int file, struct stdio_dev *dev)
236 iomux_doenv(file, dev->name);
239 static inline int console_getc(int file)
241 return stdio_devices[file]->getc(stdio_devices[file]);
244 static inline int console_tstc(int file)
246 return stdio_devices[file]->tstc(stdio_devices[file]);
249 static inline void console_putc(int file, const char c)
251 stdio_devices[file]->putc(stdio_devices[file], c);
254 #ifdef CONFIG_PRE_CONSOLE_BUFFER
255 static inline void console_puts_noserial(int file, const char *s)
257 if (strcmp(stdio_devices[file]->name, "serial") != 0)
258 stdio_devices[file]->puts(stdio_devices[file], s);
262 static inline void console_puts(int file, const char *s)
264 stdio_devices[file]->puts(stdio_devices[file], s);
267 static inline void console_printdevs(int file)
269 printf("%s\n", stdio_devices[file]->name);
272 static inline void console_doenv(int file, struct stdio_dev *dev)
274 console_setfile(file, dev);
276 #endif /* defined(CONFIG_CONSOLE_MUX) */
278 /** U-Boot INITIAL CONSOLE-NOT COMPATIBLE FUNCTIONS *************************/
280 int serial_printf(const char *fmt, ...)
284 char printbuffer[CONFIG_SYS_PBSIZE];
288 /* For this to work, printbuffer must be larger than
289 * anything we ever want to print.
291 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
294 serial_puts(printbuffer);
300 if (file < MAX_FILES) {
301 #if defined(CONFIG_CONSOLE_MUX)
303 * Effectively poll for input wherever it may be available.
307 * Upper layer may have already called tstc() so
308 * check for that first.
311 return console_getc(file);
313 #ifdef CONFIG_WATCHDOG
315 * If the watchdog must be rate-limited then it should
316 * already be handled in board-specific code.
322 return console_getc(file);
331 if (file < MAX_FILES)
332 return console_tstc(file);
337 void fputc(int file, const char c)
339 if (file < MAX_FILES)
340 console_putc(file, c);
343 void fputs(int file, const char *s)
345 if (file < MAX_FILES)
346 console_puts(file, s);
349 int fprintf(int file, const char *fmt, ...)
353 char printbuffer[CONFIG_SYS_PBSIZE];
357 /* For this to work, printbuffer must be larger than
358 * anything we ever want to print.
360 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
363 /* Send to desired file */
364 fputs(file, printbuffer);
368 /** U-Boot INITIAL CONSOLE-COMPATIBLE FUNCTION *****************************/
372 #ifdef CONFIG_DISABLE_CONSOLE
373 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
377 if (!gd->have_console)
380 if (gd->flags & GD_FLG_DEVINIT) {
381 /* Get from the standard input */
385 /* Send directly to the handler */
386 return serial_getc();
391 #ifdef CONFIG_DISABLE_CONSOLE
392 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
396 if (!gd->have_console)
399 if (gd->flags & GD_FLG_DEVINIT) {
400 /* Test the standard input */
404 /* Send directly to the handler */
405 return serial_tstc();
408 #define PRE_CONSOLE_FLUSHPOINT1_SERIAL 0
409 #define PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL 1
411 #ifdef CONFIG_PRE_CONSOLE_BUFFER
412 #define CIRC_BUF_IDX(idx) ((idx) % (unsigned long)CONFIG_PRE_CON_BUF_SZ)
414 static void pre_console_putc(const char c)
416 char *buffer = (char *)CONFIG_PRE_CON_BUF_ADDR;
418 buffer[CIRC_BUF_IDX(gd->precon_buf_idx++)] = c;
421 static void pre_console_puts(const char *s)
424 pre_console_putc(*s++);
427 static void print_pre_console_buffer(int flushpoint)
429 unsigned long in = 0, out = 0;
430 char *buf_in = (char *)CONFIG_PRE_CON_BUF_ADDR;
431 char buf_out[CONFIG_PRE_CON_BUF_SZ + 1];
433 if (gd->precon_buf_idx > CONFIG_PRE_CON_BUF_SZ)
434 in = gd->precon_buf_idx - CONFIG_PRE_CON_BUF_SZ;
436 while (in < gd->precon_buf_idx)
437 buf_out[out++] = buf_in[CIRC_BUF_IDX(in++)];
441 switch (flushpoint) {
442 case PRE_CONSOLE_FLUSHPOINT1_SERIAL:
445 case PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL:
446 console_puts_noserial(stdout, buf_out);
451 static inline void pre_console_putc(const char c) {}
452 static inline void pre_console_puts(const char *s) {}
453 static inline void print_pre_console_buffer(int flushpoint) {}
456 void putc(const char c)
458 #ifdef CONFIG_SANDBOX
459 /* sandbox can send characters to stdout before it has a console */
460 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
465 #ifdef CONFIG_DEBUG_UART
466 /* if we don't have a console yet, use the debug UART */
467 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
472 #ifdef CONFIG_SILENT_CONSOLE
473 if (gd->flags & GD_FLG_SILENT)
477 #ifdef CONFIG_DISABLE_CONSOLE
478 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
482 if (!gd->have_console)
483 return pre_console_putc(c);
485 if (gd->flags & GD_FLG_DEVINIT) {
486 /* Send to the standard output */
489 /* Send directly to the handler */
495 void puts(const char *s)
497 #ifdef CONFIG_SANDBOX
498 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
503 #ifdef CONFIG_DEBUG_UART
504 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
515 #ifdef CONFIG_SILENT_CONSOLE
516 if (gd->flags & GD_FLG_SILENT)
520 #ifdef CONFIG_DISABLE_CONSOLE
521 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
525 if (!gd->have_console)
526 return pre_console_puts(s);
528 if (gd->flags & GD_FLG_DEVINIT) {
529 /* Send to the standard output */
532 /* Send directly to the handler */
538 int printf(const char *fmt, ...)
542 char printbuffer[CONFIG_SYS_PBSIZE];
546 /* For this to work, printbuffer must be larger than
547 * anything we ever want to print.
549 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
552 /* Print the string */
557 int vprintf(const char *fmt, va_list args)
560 char printbuffer[CONFIG_SYS_PBSIZE];
562 #if defined(CONFIG_PRE_CONSOLE_BUFFER) && !defined(CONFIG_SANDBOX)
563 if (!gd->have_console)
567 /* For this to work, printbuffer must be larger than
568 * anything we ever want to print.
570 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
572 /* Print the string */
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 #ifdef CONFIG_MODEM_SUPPORT_DEBUG
648 char *cursor = screen;
650 inline void dbg(const char *fmt, ...)
654 char printbuffer[CONFIG_SYS_PBSIZE];
657 memset(screen, 0, sizeof(screen));
663 /* For this to work, printbuffer must be larger than
664 * anything we ever want to print.
666 i = vsnprintf(printbuffer, sizeof(printbuffer), fmt, args);
669 if ((screen + sizeof(screen) - 1 - cursor)
670 < strlen(printbuffer) + 1) {
671 memset(screen, 0, sizeof(screen));
674 sprintf(cursor, printbuffer);
675 cursor += strlen(printbuffer);
679 static inline void dbg(const char *fmt, ...)
684 /** U-Boot INIT FUNCTIONS *************************************************/
686 struct stdio_dev *search_device(int flags, const char *name)
688 struct stdio_dev *dev;
690 dev = stdio_get_by_name(name);
692 if (dev && (dev->flags & flags))
698 int console_assign(int file, const char *devname)
701 struct stdio_dev *dev;
703 /* Check for valid file */
706 flag = DEV_FLAGS_INPUT;
710 flag = DEV_FLAGS_OUTPUT;
716 /* Check for valid device name */
718 dev = search_device(flag, devname);
721 return console_setfile(file, dev);
726 /* Called before relocation - use serial functions */
727 int console_init_f(void)
729 gd->have_console = 1;
731 #ifdef CONFIG_SILENT_CONSOLE
732 if (getenv("silent") != NULL)
733 gd->flags |= GD_FLG_SILENT;
736 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT1_SERIAL);
741 void stdio_print_current_devices(void)
743 /* Print information */
745 if (stdio_devices[stdin] == NULL) {
746 puts("No input devices available!\n");
748 printf ("%s\n", stdio_devices[stdin]->name);
752 if (stdio_devices[stdout] == NULL) {
753 puts("No output devices available!\n");
755 printf ("%s\n", stdio_devices[stdout]->name);
759 if (stdio_devices[stderr] == NULL) {
760 puts("No error devices available!\n");
762 printf ("%s\n", stdio_devices[stderr]->name);
766 #ifdef CONFIG_SYS_CONSOLE_IS_IN_ENV
767 /* Called after the relocation - use desired console functions */
768 int console_init_r(void)
770 char *stdinname, *stdoutname, *stderrname;
771 struct stdio_dev *inputdev = NULL, *outputdev = NULL, *errdev = NULL;
772 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
774 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
775 #ifdef CONFIG_CONSOLE_MUX
779 /* set default handlers at first */
780 gd->jt->getc = serial_getc;
781 gd->jt->tstc = serial_tstc;
782 gd->jt->putc = serial_putc;
783 gd->jt->puts = serial_puts;
784 gd->jt->printf = serial_printf;
786 /* stdin stdout and stderr are in environment */
788 stdinname = getenv("stdin");
789 stdoutname = getenv("stdout");
790 stderrname = getenv("stderr");
792 if (OVERWRITE_CONSOLE == 0) { /* if not overwritten by config switch */
793 inputdev = search_device(DEV_FLAGS_INPUT, stdinname);
794 outputdev = search_device(DEV_FLAGS_OUTPUT, stdoutname);
795 errdev = search_device(DEV_FLAGS_OUTPUT, stderrname);
796 #ifdef CONFIG_CONSOLE_MUX
797 iomux_err = iomux_doenv(stdin, stdinname);
798 iomux_err += iomux_doenv(stdout, stdoutname);
799 iomux_err += iomux_doenv(stderr, stderrname);
801 /* Successful, so skip all the code below. */
805 /* if the devices are overwritten or not found, use default device */
806 if (inputdev == NULL) {
807 inputdev = search_device(DEV_FLAGS_INPUT, "serial");
809 if (outputdev == NULL) {
810 outputdev = search_device(DEV_FLAGS_OUTPUT, "serial");
812 if (errdev == NULL) {
813 errdev = search_device(DEV_FLAGS_OUTPUT, "serial");
815 /* Initializes output console first */
816 if (outputdev != NULL) {
817 /* need to set a console if not done above. */
818 console_doenv(stdout, outputdev);
820 if (errdev != NULL) {
821 /* need to set a console if not done above. */
822 console_doenv(stderr, errdev);
824 if (inputdev != NULL) {
825 /* need to set a console if not done above. */
826 console_doenv(stdin, inputdev);
829 #ifdef CONFIG_CONSOLE_MUX
833 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
834 stdio_print_current_devices();
835 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
837 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
838 /* set the environment variables (will overwrite previous env settings) */
839 for (i = 0; i < 3; i++) {
840 setenv(stdio_names[i], stdio_devices[i]->name);
842 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
844 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
847 /* If nothing usable installed, use only the initial console */
848 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
851 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL);
855 #else /* CONFIG_SYS_CONSOLE_IS_IN_ENV */
857 /* Called after the relocation - use desired console functions */
858 int console_init_r(void)
860 struct stdio_dev *inputdev = NULL, *outputdev = NULL;
862 struct list_head *list = stdio_get_list();
863 struct list_head *pos;
864 struct stdio_dev *dev;
866 #ifdef CONFIG_SPLASH_SCREEN
868 * suppress all output if splash screen is enabled and we have
869 * a bmp to display. We redirect the output from frame buffer
870 * console to serial console in this case or suppress it if
871 * "silent" mode was requested.
873 if (getenv("splashimage") != NULL) {
874 if (!(gd->flags & GD_FLG_SILENT))
875 outputdev = search_device (DEV_FLAGS_OUTPUT, "serial");
879 /* Scan devices looking for input and output devices */
880 list_for_each(pos, list) {
881 dev = list_entry(pos, struct stdio_dev, list);
883 if ((dev->flags & DEV_FLAGS_INPUT) && (inputdev == NULL)) {
886 if ((dev->flags & DEV_FLAGS_OUTPUT) && (outputdev == NULL)) {
889 if(inputdev && outputdev)
893 /* Initializes output console first */
894 if (outputdev != NULL) {
895 console_setfile(stdout, outputdev);
896 console_setfile(stderr, outputdev);
897 #ifdef CONFIG_CONSOLE_MUX
898 console_devices[stdout][0] = outputdev;
899 console_devices[stderr][0] = outputdev;
903 /* Initializes input console */
904 if (inputdev != NULL) {
905 console_setfile(stdin, inputdev);
906 #ifdef CONFIG_CONSOLE_MUX
907 console_devices[stdin][0] = inputdev;
911 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
912 stdio_print_current_devices();
913 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
915 /* Setting environment variables */
916 for (i = 0; i < 3; i++) {
917 setenv(stdio_names[i], stdio_devices[i]->name);
920 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
923 /* If nothing usable installed, use only the initial console */
924 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
927 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL);
931 #endif /* CONFIG_SYS_CONSOLE_IS_IN_ENV */