3 * Paolo Scaffardi, AIRVENT SAM s.p.a - RIMINI(ITALY), arsenio@tin.it
5 * SPDX-License-Identifier: GPL-2.0+
14 #include <stdio_dev.h>
16 #include <environment.h>
18 DECLARE_GLOBAL_DATA_PTR;
20 static int on_console(const char *name, const char *value, enum env_op op,
25 /* Check for console redirection */
26 if (strcmp(name, "stdin") == 0)
28 else if (strcmp(name, "stdout") == 0)
30 else if (strcmp(name, "stderr") == 0)
33 /* if not actually setting a console variable, we don't care */
34 if (console == -1 || (gd->flags & GD_FLG_DEVINIT) == 0)
39 case env_op_overwrite:
41 #ifdef CONFIG_CONSOLE_MUX
42 if (iomux_doenv(console, value))
45 /* Try assigning specified device */
46 if (console_assign(console, value) < 0)
48 #endif /* CONFIG_CONSOLE_MUX */
52 if ((flags & H_FORCE) == 0)
53 printf("Can't delete \"%s\"\n", name);
60 U_BOOT_ENV_CALLBACK(console, on_console);
62 #ifdef CONFIG_SILENT_CONSOLE
63 static int on_silent(const char *name, const char *value, enum env_op op,
66 #ifndef CONFIG_SILENT_CONSOLE_UPDATE_ON_SET
67 if (flags & H_INTERACTIVE)
70 #ifndef CONFIG_SILENT_CONSOLE_UPDATE_ON_RELOC
71 if ((flags & H_INTERACTIVE) == 0)
76 gd->flags |= GD_FLG_SILENT;
78 gd->flags &= ~GD_FLG_SILENT;
82 U_BOOT_ENV_CALLBACK(silent, on_silent);
85 #ifdef CONFIG_SYS_CONSOLE_IS_IN_ENV
87 * if overwrite_console returns 1, the stdin, stderr and stdout
88 * are switched to the serial port, else the settings in the
89 * environment are used
91 #ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
92 extern int overwrite_console(void);
93 #define OVERWRITE_CONSOLE overwrite_console()
95 #define OVERWRITE_CONSOLE 0
96 #endif /* CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE */
98 #endif /* CONFIG_SYS_CONSOLE_IS_IN_ENV */
100 static int console_setfile(int file, struct stdio_dev * dev)
111 /* Start new device */
113 error = dev->start(dev);
114 /* If it's not started dont use it */
119 /* Assign the new device (leaving the existing one started) */
120 stdio_devices[file] = dev;
123 * Update monitor functions
124 * (to use the console stuff by other applications)
134 gd->jt->printf = printf;
139 default: /* Invalid file ID */
145 #if defined(CONFIG_CONSOLE_MUX)
146 /** Console I/O multiplexing *******************************************/
148 static struct stdio_dev *tstcdev;
149 struct stdio_dev **console_devices[MAX_FILES];
150 int cd_count[MAX_FILES];
153 * This depends on tstc() always being called before getc().
154 * This is guaranteed to be true because this routine is called
155 * only from fgetc() which assures it.
156 * No attempt is made to demultiplex multiple input sources.
158 static int console_getc(int file)
162 /* This is never called with testcdev == NULL */
163 ret = tstcdev->getc(tstcdev);
168 static int console_tstc(int file)
171 struct stdio_dev *dev;
174 for (i = 0; i < cd_count[file]; i++) {
175 dev = console_devices[file][i];
176 if (dev->tstc != NULL) {
177 ret = dev->tstc(dev);
190 static void console_putc(int file, const char c)
193 struct stdio_dev *dev;
195 for (i = 0; i < cd_count[file]; i++) {
196 dev = console_devices[file][i];
197 if (dev->putc != NULL)
202 #ifdef CONFIG_PRE_CONSOLE_BUFFER
203 static void console_puts_noserial(int file, const char *s)
206 struct stdio_dev *dev;
208 for (i = 0; i < cd_count[file]; i++) {
209 dev = console_devices[file][i];
210 if (dev->puts != NULL && strcmp(dev->name, "serial") != 0)
216 static void console_puts(int file, const char *s)
219 struct stdio_dev *dev;
221 for (i = 0; i < cd_count[file]; i++) {
222 dev = console_devices[file][i];
223 if (dev->puts != NULL)
228 static inline void console_printdevs(int file)
230 iomux_printdevs(file);
233 static inline void console_doenv(int file, struct stdio_dev *dev)
235 iomux_doenv(file, dev->name);
238 static inline int console_getc(int file)
240 return stdio_devices[file]->getc(stdio_devices[file]);
243 static inline int console_tstc(int file)
245 return stdio_devices[file]->tstc(stdio_devices[file]);
248 static inline void console_putc(int file, const char c)
250 stdio_devices[file]->putc(stdio_devices[file], c);
253 #ifdef CONFIG_PRE_CONSOLE_BUFFER
254 static inline void console_puts_noserial(int file, const char *s)
256 if (strcmp(stdio_devices[file]->name, "serial") != 0)
257 stdio_devices[file]->puts(stdio_devices[file], s);
261 static inline void console_puts(int file, const char *s)
263 stdio_devices[file]->puts(stdio_devices[file], s);
266 static inline void console_printdevs(int file)
268 printf("%s\n", stdio_devices[file]->name);
271 static inline void console_doenv(int file, struct stdio_dev *dev)
273 console_setfile(file, dev);
275 #endif /* defined(CONFIG_CONSOLE_MUX) */
277 /** U-Boot INITIAL CONSOLE-NOT COMPATIBLE FUNCTIONS *************************/
279 int serial_printf(const char *fmt, ...)
283 char printbuffer[CONFIG_SYS_PBSIZE];
287 /* For this to work, printbuffer must be larger than
288 * anything we ever want to print.
290 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
293 serial_puts(printbuffer);
299 if (file < MAX_FILES) {
300 #if defined(CONFIG_CONSOLE_MUX)
302 * Effectively poll for input wherever it may be available.
306 * Upper layer may have already called tstc() so
307 * check for that first.
310 return console_getc(file);
312 #ifdef CONFIG_WATCHDOG
314 * If the watchdog must be rate-limited then it should
315 * already be handled in board-specific code.
321 return console_getc(file);
330 if (file < MAX_FILES)
331 return console_tstc(file);
336 void fputc(int file, const char c)
338 if (file < MAX_FILES)
339 console_putc(file, c);
342 void fputs(int file, const char *s)
344 if (file < MAX_FILES)
345 console_puts(file, s);
348 int fprintf(int file, const char *fmt, ...)
352 char printbuffer[CONFIG_SYS_PBSIZE];
356 /* For this to work, printbuffer must be larger than
357 * anything we ever want to print.
359 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
362 /* Send to desired file */
363 fputs(file, printbuffer);
367 /** U-Boot INITIAL CONSOLE-COMPATIBLE FUNCTION *****************************/
371 #ifdef CONFIG_DISABLE_CONSOLE
372 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
376 if (!gd->have_console)
379 if (gd->flags & GD_FLG_DEVINIT) {
380 /* Get from the standard input */
384 /* Send directly to the handler */
385 return serial_getc();
390 #ifdef CONFIG_DISABLE_CONSOLE
391 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
395 if (!gd->have_console)
398 if (gd->flags & GD_FLG_DEVINIT) {
399 /* Test the standard input */
403 /* Send directly to the handler */
404 return serial_tstc();
407 #define PRE_CONSOLE_FLUSHPOINT1_SERIAL 0
408 #define PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL 1
410 #ifdef CONFIG_PRE_CONSOLE_BUFFER
411 #define CIRC_BUF_IDX(idx) ((idx) % (unsigned long)CONFIG_PRE_CON_BUF_SZ)
413 static void pre_console_putc(const char c)
415 char *buffer = (char *)CONFIG_PRE_CON_BUF_ADDR;
417 buffer[CIRC_BUF_IDX(gd->precon_buf_idx++)] = c;
420 static void pre_console_puts(const char *s)
423 pre_console_putc(*s++);
426 static void print_pre_console_buffer(int flushpoint)
428 unsigned long in = 0, out = 0;
429 char *buf_in = (char *)CONFIG_PRE_CON_BUF_ADDR;
430 char buf_out[CONFIG_PRE_CON_BUF_SZ + 1];
432 if (gd->precon_buf_idx > CONFIG_PRE_CON_BUF_SZ)
433 in = gd->precon_buf_idx - CONFIG_PRE_CON_BUF_SZ;
435 while (in < gd->precon_buf_idx)
436 buf_out[out++] = buf_in[CIRC_BUF_IDX(in++)];
440 switch (flushpoint) {
441 case PRE_CONSOLE_FLUSHPOINT1_SERIAL:
444 case PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL:
445 console_puts_noserial(stdout, buf_out);
450 static inline void pre_console_putc(const char c) {}
451 static inline void pre_console_puts(const char *s) {}
452 static inline void print_pre_console_buffer(int flushpoint) {}
455 void putc(const char c)
457 #ifdef CONFIG_SANDBOX
458 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
463 #ifdef CONFIG_SILENT_CONSOLE
464 if (gd->flags & GD_FLG_SILENT)
468 #ifdef CONFIG_DISABLE_CONSOLE
469 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
473 if (!gd->have_console)
474 return pre_console_putc(c);
476 if (gd->flags & GD_FLG_DEVINIT) {
477 /* Send to the standard output */
480 /* Send directly to the handler */
486 void puts(const char *s)
488 #ifdef CONFIG_SANDBOX
489 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
495 #ifdef CONFIG_SILENT_CONSOLE
496 if (gd->flags & GD_FLG_SILENT)
500 #ifdef CONFIG_DISABLE_CONSOLE
501 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
505 if (!gd->have_console)
506 return pre_console_puts(s);
508 if (gd->flags & GD_FLG_DEVINIT) {
509 /* Send to the standard output */
512 /* Send directly to the handler */
518 int printf(const char *fmt, ...)
522 char printbuffer[CONFIG_SYS_PBSIZE];
524 #if !defined(CONFIG_SANDBOX) && !defined(CONFIG_PRE_CONSOLE_BUFFER)
525 if (!gd->have_console)
531 /* For this to work, printbuffer must be larger than
532 * anything we ever want to print.
534 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
537 /* Print the string */
542 int vprintf(const char *fmt, va_list args)
545 char printbuffer[CONFIG_SYS_PBSIZE];
547 #if defined(CONFIG_PRE_CONSOLE_BUFFER) && !defined(CONFIG_SANDBOX)
548 if (!gd->have_console)
552 /* For this to work, printbuffer must be larger than
553 * anything we ever want to print.
555 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
557 /* Print the string */
562 /* test if ctrl-c was pressed */
563 static int ctrlc_disabled = 0; /* see disable_ctrl() */
564 static int ctrlc_was_pressed = 0;
567 #ifndef CONFIG_SANDBOX
568 if (!ctrlc_disabled && gd->have_console) {
571 case 0x03: /* ^C - Control C */
572 ctrlc_was_pressed = 1;
583 /* Reads user's confirmation.
584 Returns 1 if user's input is "y", "Y", "yes" or "YES"
586 int confirm_yesno(void)
595 while (i < sizeof(str_input)) {
596 str_input[i] = getc();
598 if (str_input[i] == '\r')
603 if (strncmp(str_input, "y\r", 2) == 0 ||
604 strncmp(str_input, "Y\r", 2) == 0 ||
605 strncmp(str_input, "yes\r", 4) == 0 ||
606 strncmp(str_input, "YES\r", 4) == 0)
610 /* pass 1 to disable ctrlc() checking, 0 to enable.
611 * returns previous state
613 int disable_ctrlc(int disable)
615 int prev = ctrlc_disabled; /* save previous state */
617 ctrlc_disabled = disable;
623 return ctrlc_was_pressed;
626 void clear_ctrlc(void)
628 ctrlc_was_pressed = 0;
631 #ifdef CONFIG_MODEM_SUPPORT_DEBUG
633 char *cursor = screen;
635 inline void dbg(const char *fmt, ...)
639 char printbuffer[CONFIG_SYS_PBSIZE];
642 memset(screen, 0, sizeof(screen));
648 /* For this to work, printbuffer must be larger than
649 * anything we ever want to print.
651 i = vsnprintf(printbuffer, sizeof(printbuffer), fmt, args);
654 if ((screen + sizeof(screen) - 1 - cursor)
655 < strlen(printbuffer) + 1) {
656 memset(screen, 0, sizeof(screen));
659 sprintf(cursor, printbuffer);
660 cursor += strlen(printbuffer);
664 static inline void dbg(const char *fmt, ...)
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);
677 if (dev && (dev->flags & flags))
683 int console_assign(int file, const char *devname)
686 struct stdio_dev *dev;
688 /* Check for valid file */
691 flag = DEV_FLAGS_INPUT;
695 flag = DEV_FLAGS_OUTPUT;
701 /* Check for valid device name */
703 dev = search_device(flag, devname);
706 return console_setfile(file, dev);
711 /* Called before relocation - use serial functions */
712 int console_init_f(void)
714 gd->have_console = 1;
716 #ifdef CONFIG_SILENT_CONSOLE
717 if (getenv("silent") != NULL)
718 gd->flags |= GD_FLG_SILENT;
721 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT1_SERIAL);
726 void stdio_print_current_devices(void)
728 /* Print information */
730 if (stdio_devices[stdin] == NULL) {
731 puts("No input devices available!\n");
733 printf ("%s\n", stdio_devices[stdin]->name);
737 if (stdio_devices[stdout] == NULL) {
738 puts("No output devices available!\n");
740 printf ("%s\n", stdio_devices[stdout]->name);
744 if (stdio_devices[stderr] == NULL) {
745 puts("No error devices available!\n");
747 printf ("%s\n", stdio_devices[stderr]->name);
751 #ifdef CONFIG_SYS_CONSOLE_IS_IN_ENV
752 /* Called after the relocation - use desired console functions */
753 int console_init_r(void)
755 char *stdinname, *stdoutname, *stderrname;
756 struct stdio_dev *inputdev = NULL, *outputdev = NULL, *errdev = NULL;
757 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
759 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
760 #ifdef CONFIG_CONSOLE_MUX
764 /* set default handlers at first */
765 gd->jt->getc = serial_getc;
766 gd->jt->tstc = serial_tstc;
767 gd->jt->putc = serial_putc;
768 gd->jt->puts = serial_puts;
769 gd->jt->printf = serial_printf;
771 /* stdin stdout and stderr are in environment */
773 stdinname = getenv("stdin");
774 stdoutname = getenv("stdout");
775 stderrname = getenv("stderr");
777 if (OVERWRITE_CONSOLE == 0) { /* if not overwritten by config switch */
778 inputdev = search_device(DEV_FLAGS_INPUT, stdinname);
779 outputdev = search_device(DEV_FLAGS_OUTPUT, stdoutname);
780 errdev = search_device(DEV_FLAGS_OUTPUT, stderrname);
781 #ifdef CONFIG_CONSOLE_MUX
782 iomux_err = iomux_doenv(stdin, stdinname);
783 iomux_err += iomux_doenv(stdout, stdoutname);
784 iomux_err += iomux_doenv(stderr, stderrname);
786 /* Successful, so skip all the code below. */
790 /* if the devices are overwritten or not found, use default device */
791 if (inputdev == NULL) {
792 inputdev = search_device(DEV_FLAGS_INPUT, "serial");
794 if (outputdev == NULL) {
795 outputdev = search_device(DEV_FLAGS_OUTPUT, "serial");
797 if (errdev == NULL) {
798 errdev = search_device(DEV_FLAGS_OUTPUT, "serial");
800 /* Initializes output console first */
801 if (outputdev != NULL) {
802 /* need to set a console if not done above. */
803 console_doenv(stdout, outputdev);
805 if (errdev != NULL) {
806 /* need to set a console if not done above. */
807 console_doenv(stderr, errdev);
809 if (inputdev != NULL) {
810 /* need to set a console if not done above. */
811 console_doenv(stdin, inputdev);
814 #ifdef CONFIG_CONSOLE_MUX
818 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
819 stdio_print_current_devices();
820 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
822 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
823 /* set the environment variables (will overwrite previous env settings) */
824 for (i = 0; i < 3; i++) {
825 setenv(stdio_names[i], stdio_devices[i]->name);
827 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
829 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
832 /* If nothing usable installed, use only the initial console */
833 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
836 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL);
840 #else /* CONFIG_SYS_CONSOLE_IS_IN_ENV */
842 /* Called after the relocation - use desired console functions */
843 int console_init_r(void)
845 struct stdio_dev *inputdev = NULL, *outputdev = NULL;
847 struct list_head *list = stdio_get_list();
848 struct list_head *pos;
849 struct stdio_dev *dev;
851 #ifdef CONFIG_SPLASH_SCREEN
853 * suppress all output if splash screen is enabled and we have
854 * a bmp to display. We redirect the output from frame buffer
855 * console to serial console in this case or suppress it if
856 * "silent" mode was requested.
858 if (getenv("splashimage") != NULL) {
859 if (!(gd->flags & GD_FLG_SILENT))
860 outputdev = search_device (DEV_FLAGS_OUTPUT, "serial");
864 /* Scan devices looking for input and output devices */
865 list_for_each(pos, list) {
866 dev = list_entry(pos, struct stdio_dev, list);
868 if ((dev->flags & DEV_FLAGS_INPUT) && (inputdev == NULL)) {
871 if ((dev->flags & DEV_FLAGS_OUTPUT) && (outputdev == NULL)) {
874 if(inputdev && outputdev)
878 /* Initializes output console first */
879 if (outputdev != NULL) {
880 console_setfile(stdout, outputdev);
881 console_setfile(stderr, outputdev);
882 #ifdef CONFIG_CONSOLE_MUX
883 console_devices[stdout][0] = outputdev;
884 console_devices[stderr][0] = outputdev;
888 /* Initializes input console */
889 if (inputdev != NULL) {
890 console_setfile(stdin, inputdev);
891 #ifdef CONFIG_CONSOLE_MUX
892 console_devices[stdin][0] = inputdev;
896 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
897 stdio_print_current_devices();
898 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
900 /* Setting environment variables */
901 for (i = 0; i < 3; i++) {
902 setenv(stdio_names[i], stdio_devices[i]->name);
905 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
908 /* If nothing usable installed, use only the initial console */
909 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
912 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL);
916 #endif /* CONFIG_SYS_CONSOLE_IS_IN_ENV */