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>
20 DECLARE_GLOBAL_DATA_PTR;
22 static int on_console(const char *name, const char *value, enum env_op op,
27 /* Check for console redirection */
28 if (strcmp(name, "stdin") == 0)
30 else if (strcmp(name, "stdout") == 0)
32 else if (strcmp(name, "stderr") == 0)
35 /* if not actually setting a console variable, we don't care */
36 if (console == -1 || (gd->flags & GD_FLG_DEVINIT) == 0)
41 case env_op_overwrite:
43 #ifdef CONFIG_CONSOLE_MUX
44 if (iomux_doenv(console, value))
47 /* Try assigning specified device */
48 if (console_assign(console, value) < 0)
50 #endif /* CONFIG_CONSOLE_MUX */
54 if ((flags & H_FORCE) == 0)
55 printf("Can't delete \"%s\"\n", name);
62 U_BOOT_ENV_CALLBACK(console, on_console);
64 #ifdef CONFIG_SILENT_CONSOLE
65 static int on_silent(const char *name, const char *value, enum env_op op,
68 #ifndef CONFIG_SILENT_CONSOLE_UPDATE_ON_SET
69 if (flags & H_INTERACTIVE)
72 #ifndef CONFIG_SILENT_CONSOLE_UPDATE_ON_RELOC
73 if ((flags & H_INTERACTIVE) == 0)
78 gd->flags |= GD_FLG_SILENT;
80 gd->flags &= ~GD_FLG_SILENT;
84 U_BOOT_ENV_CALLBACK(silent, on_silent);
87 #ifdef CONFIG_SYS_CONSOLE_IS_IN_ENV
89 * if overwrite_console returns 1, the stdin, stderr and stdout
90 * are switched to the serial port, else the settings in the
91 * environment are used
93 #ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
94 extern int overwrite_console(void);
95 #define OVERWRITE_CONSOLE overwrite_console()
97 #define OVERWRITE_CONSOLE 0
98 #endif /* CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE */
100 #endif /* CONFIG_SYS_CONSOLE_IS_IN_ENV */
102 static int console_setfile(int file, struct stdio_dev * dev)
113 /* Start new device */
115 error = dev->start(dev);
116 /* If it's not started dont use it */
121 /* Assign the new device (leaving the existing one started) */
122 stdio_devices[file] = dev;
125 * Update monitor functions
126 * (to use the console stuff by other applications)
136 gd->jt->printf = printf;
141 default: /* Invalid file ID */
147 #if defined(CONFIG_CONSOLE_MUX)
148 /** Console I/O multiplexing *******************************************/
150 static struct stdio_dev *tstcdev;
151 struct stdio_dev **console_devices[MAX_FILES];
152 int cd_count[MAX_FILES];
155 * This depends on tstc() always being called before getc().
156 * This is guaranteed to be true because this routine is called
157 * only from fgetc() which assures it.
158 * No attempt is made to demultiplex multiple input sources.
160 static int console_getc(int file)
164 /* This is never called with testcdev == NULL */
165 ret = tstcdev->getc(tstcdev);
170 static int console_tstc(int file)
173 struct stdio_dev *dev;
176 for (i = 0; i < cd_count[file]; i++) {
177 dev = console_devices[file][i];
178 if (dev->tstc != NULL) {
179 ret = dev->tstc(dev);
192 static void console_putc(int file, const char c)
195 struct stdio_dev *dev;
197 for (i = 0; i < cd_count[file]; i++) {
198 dev = console_devices[file][i];
199 if (dev->putc != NULL)
204 #ifdef CONFIG_PRE_CONSOLE_BUFFER
205 static void console_puts_noserial(int file, const char *s)
208 struct stdio_dev *dev;
210 for (i = 0; i < cd_count[file]; i++) {
211 dev = console_devices[file][i];
212 if (dev->puts != NULL && strcmp(dev->name, "serial") != 0)
218 static void console_puts(int file, const char *s)
221 struct stdio_dev *dev;
223 for (i = 0; i < cd_count[file]; i++) {
224 dev = console_devices[file][i];
225 if (dev->puts != NULL)
230 static inline void console_doenv(int file, struct stdio_dev *dev)
232 iomux_doenv(file, dev->name);
235 static inline int console_getc(int file)
237 return stdio_devices[file]->getc(stdio_devices[file]);
240 static inline int console_tstc(int file)
242 return stdio_devices[file]->tstc(stdio_devices[file]);
245 static inline void console_putc(int file, const char c)
247 stdio_devices[file]->putc(stdio_devices[file], c);
250 #ifdef CONFIG_PRE_CONSOLE_BUFFER
251 static inline void console_puts_noserial(int file, const char *s)
253 if (strcmp(stdio_devices[file]->name, "serial") != 0)
254 stdio_devices[file]->puts(stdio_devices[file], s);
258 static inline void console_puts(int file, const char *s)
260 stdio_devices[file]->puts(stdio_devices[file], s);
263 static inline void console_doenv(int file, struct stdio_dev *dev)
265 console_setfile(file, dev);
267 #endif /* defined(CONFIG_CONSOLE_MUX) */
269 /** U-Boot INITIAL CONSOLE-NOT COMPATIBLE FUNCTIONS *************************/
271 int serial_printf(const char *fmt, ...)
275 char printbuffer[CONFIG_SYS_PBSIZE];
279 /* For this to work, printbuffer must be larger than
280 * anything we ever want to print.
282 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
285 serial_puts(printbuffer);
291 if (file < MAX_FILES) {
292 #if defined(CONFIG_CONSOLE_MUX)
294 * Effectively poll for input wherever it may be available.
298 * Upper layer may have already called tstc() so
299 * check for that first.
302 return console_getc(file);
304 #ifdef CONFIG_WATCHDOG
306 * If the watchdog must be rate-limited then it should
307 * already be handled in board-specific code.
313 return console_getc(file);
322 if (file < MAX_FILES)
323 return console_tstc(file);
328 void fputc(int file, const char c)
330 if (file < MAX_FILES)
331 console_putc(file, c);
334 void fputs(int file, const char *s)
336 if (file < MAX_FILES)
337 console_puts(file, s);
340 int fprintf(int file, const char *fmt, ...)
344 char printbuffer[CONFIG_SYS_PBSIZE];
348 /* For this to work, printbuffer must be larger than
349 * anything we ever want to print.
351 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
354 /* Send to desired file */
355 fputs(file, printbuffer);
359 /** U-Boot INITIAL CONSOLE-COMPATIBLE FUNCTION *****************************/
363 #ifdef CONFIG_DISABLE_CONSOLE
364 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
368 if (!gd->have_console)
371 #ifdef CONFIG_CONSOLE_RECORD
372 if (gd->console_in.start) {
375 ch = membuff_getbyte(&gd->console_in);
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)
398 #ifdef CONFIG_CONSOLE_RECORD
399 if (gd->console_in.start) {
400 if (membuff_peekbyte(&gd->console_in) != -1)
404 if (gd->flags & GD_FLG_DEVINIT) {
405 /* Test the standard input */
409 /* Send directly to the handler */
410 return serial_tstc();
413 #define PRE_CONSOLE_FLUSHPOINT1_SERIAL 0
414 #define PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL 1
416 #ifdef CONFIG_PRE_CONSOLE_BUFFER
417 #define CIRC_BUF_IDX(idx) ((idx) % (unsigned long)CONFIG_PRE_CON_BUF_SZ)
419 static void pre_console_putc(const char c)
421 char *buffer = (char *)CONFIG_PRE_CON_BUF_ADDR;
423 buffer[CIRC_BUF_IDX(gd->precon_buf_idx++)] = c;
426 static void pre_console_puts(const char *s)
429 pre_console_putc(*s++);
432 static void print_pre_console_buffer(int flushpoint)
434 unsigned long in = 0, out = 0;
435 char *buf_in = (char *)CONFIG_PRE_CON_BUF_ADDR;
436 char buf_out[CONFIG_PRE_CON_BUF_SZ + 1];
438 if (gd->precon_buf_idx > CONFIG_PRE_CON_BUF_SZ)
439 in = gd->precon_buf_idx - CONFIG_PRE_CON_BUF_SZ;
441 while (in < gd->precon_buf_idx)
442 buf_out[out++] = buf_in[CIRC_BUF_IDX(in++)];
446 switch (flushpoint) {
447 case PRE_CONSOLE_FLUSHPOINT1_SERIAL:
450 case PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL:
451 console_puts_noserial(stdout, buf_out);
456 static inline void pre_console_putc(const char c) {}
457 static inline void pre_console_puts(const char *s) {}
458 static inline void print_pre_console_buffer(int flushpoint) {}
461 void putc(const char c)
463 #ifdef CONFIG_SANDBOX
464 /* sandbox can send characters to stdout before it has a console */
465 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
470 #ifdef CONFIG_DEBUG_UART
471 /* if we don't have a console yet, use the debug UART */
472 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
477 #ifdef CONFIG_CONSOLE_RECORD
478 if (gd && (gd->flags & GD_FLG_RECORD) && gd->console_out.start)
479 membuff_putbyte(&gd->console_out, c);
481 #ifdef CONFIG_SILENT_CONSOLE
482 if (gd->flags & GD_FLG_SILENT)
486 #ifdef CONFIG_DISABLE_CONSOLE
487 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
491 if (!gd->have_console)
492 return pre_console_putc(c);
494 if (gd->flags & GD_FLG_DEVINIT) {
495 /* Send to the standard output */
498 /* Send directly to the handler */
504 void puts(const char *s)
506 #ifdef CONFIG_SANDBOX
507 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
512 #ifdef CONFIG_DEBUG_UART
513 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);
654 if (dev && (dev->flags & flags))
660 int console_assign(int file, const char *devname)
663 struct stdio_dev *dev;
665 /* Check for valid file */
668 flag = DEV_FLAGS_INPUT;
672 flag = DEV_FLAGS_OUTPUT;
678 /* Check for valid device name */
680 dev = search_device(flag, devname);
683 return console_setfile(file, dev);
688 /* Called before relocation - use serial functions */
689 int console_init_f(void)
691 gd->have_console = 1;
693 #ifdef CONFIG_SILENT_CONSOLE
694 if (getenv("silent") != NULL)
695 gd->flags |= GD_FLG_SILENT;
698 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT1_SERIAL);
703 void stdio_print_current_devices(void)
705 /* Print information */
707 if (stdio_devices[stdin] == NULL) {
708 puts("No input devices available!\n");
710 printf ("%s\n", stdio_devices[stdin]->name);
714 if (stdio_devices[stdout] == NULL) {
715 puts("No output devices available!\n");
717 printf ("%s\n", stdio_devices[stdout]->name);
721 if (stdio_devices[stderr] == NULL) {
722 puts("No error devices available!\n");
724 printf ("%s\n", stdio_devices[stderr]->name);
728 #ifdef CONFIG_SYS_CONSOLE_IS_IN_ENV
729 /* Called after the relocation - use desired console functions */
730 int console_init_r(void)
732 char *stdinname, *stdoutname, *stderrname;
733 struct stdio_dev *inputdev = NULL, *outputdev = NULL, *errdev = NULL;
734 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
736 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
737 #ifdef CONFIG_CONSOLE_MUX
741 /* set default handlers at first */
742 gd->jt->getc = serial_getc;
743 gd->jt->tstc = serial_tstc;
744 gd->jt->putc = serial_putc;
745 gd->jt->puts = serial_puts;
746 gd->jt->printf = serial_printf;
748 /* stdin stdout and stderr are in environment */
750 stdinname = getenv("stdin");
751 stdoutname = getenv("stdout");
752 stderrname = getenv("stderr");
754 if (OVERWRITE_CONSOLE == 0) { /* if not overwritten by config switch */
755 inputdev = search_device(DEV_FLAGS_INPUT, stdinname);
756 outputdev = search_device(DEV_FLAGS_OUTPUT, stdoutname);
757 errdev = search_device(DEV_FLAGS_OUTPUT, stderrname);
758 #ifdef CONFIG_CONSOLE_MUX
759 iomux_err = iomux_doenv(stdin, stdinname);
760 iomux_err += iomux_doenv(stdout, stdoutname);
761 iomux_err += iomux_doenv(stderr, stderrname);
763 /* Successful, so skip all the code below. */
767 /* if the devices are overwritten or not found, use default device */
768 if (inputdev == NULL) {
769 inputdev = search_device(DEV_FLAGS_INPUT, "serial");
771 if (outputdev == NULL) {
772 outputdev = search_device(DEV_FLAGS_OUTPUT, "serial");
774 if (errdev == NULL) {
775 errdev = search_device(DEV_FLAGS_OUTPUT, "serial");
777 /* Initializes output console first */
778 if (outputdev != NULL) {
779 /* need to set a console if not done above. */
780 console_doenv(stdout, outputdev);
782 if (errdev != NULL) {
783 /* need to set a console if not done above. */
784 console_doenv(stderr, errdev);
786 if (inputdev != NULL) {
787 /* need to set a console if not done above. */
788 console_doenv(stdin, inputdev);
791 #ifdef CONFIG_CONSOLE_MUX
795 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
796 stdio_print_current_devices();
797 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
799 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
800 /* set the environment variables (will overwrite previous env settings) */
801 for (i = 0; i < 3; i++) {
802 setenv(stdio_names[i], stdio_devices[i]->name);
804 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
806 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
809 /* If nothing usable installed, use only the initial console */
810 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
813 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL);
817 #else /* CONFIG_SYS_CONSOLE_IS_IN_ENV */
819 /* Called after the relocation - use desired console functions */
820 int console_init_r(void)
822 struct stdio_dev *inputdev = NULL, *outputdev = NULL;
824 struct list_head *list = stdio_get_list();
825 struct list_head *pos;
826 struct stdio_dev *dev;
828 #ifdef CONFIG_SPLASH_SCREEN
830 * suppress all output if splash screen is enabled and we have
831 * a bmp to display. We redirect the output from frame buffer
832 * console to serial console in this case or suppress it if
833 * "silent" mode was requested.
835 if (getenv("splashimage") != NULL) {
836 if (!(gd->flags & GD_FLG_SILENT))
837 outputdev = search_device (DEV_FLAGS_OUTPUT, "serial");
841 /* Scan devices looking for input and output devices */
842 list_for_each(pos, list) {
843 dev = list_entry(pos, struct stdio_dev, list);
845 if ((dev->flags & DEV_FLAGS_INPUT) && (inputdev == NULL)) {
848 if ((dev->flags & DEV_FLAGS_OUTPUT) && (outputdev == NULL)) {
851 if(inputdev && outputdev)
855 /* Initializes output console first */
856 if (outputdev != NULL) {
857 console_setfile(stdout, outputdev);
858 console_setfile(stderr, outputdev);
859 #ifdef CONFIG_CONSOLE_MUX
860 console_devices[stdout][0] = outputdev;
861 console_devices[stderr][0] = outputdev;
865 /* Initializes input console */
866 if (inputdev != NULL) {
867 console_setfile(stdin, inputdev);
868 #ifdef CONFIG_CONSOLE_MUX
869 console_devices[stdin][0] = inputdev;
873 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
874 stdio_print_current_devices();
875 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
877 /* Setting environment variables */
878 for (i = 0; i < 3; i++) {
879 setenv(stdio_names[i], stdio_devices[i]->name);
882 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
885 /* If nothing usable installed, use only the initial console */
886 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
889 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL);
893 #endif /* CONFIG_SYS_CONSOLE_IS_IN_ENV */