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 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)
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_doenv(int file, struct stdio_dev *dev)
231 iomux_doenv(file, dev->name);
234 static inline int console_getc(int file)
236 return stdio_devices[file]->getc(stdio_devices[file]);
239 static inline int console_tstc(int file)
241 return stdio_devices[file]->tstc(stdio_devices[file]);
244 static inline void console_putc(int file, const char c)
246 stdio_devices[file]->putc(stdio_devices[file], c);
249 static inline void console_puts_noserial(int file, const char *s)
251 if (strcmp(stdio_devices[file]->name, "serial") != 0)
252 stdio_devices[file]->puts(stdio_devices[file], s);
255 static inline void console_puts(int file, const char *s)
257 stdio_devices[file]->puts(stdio_devices[file], s);
260 static inline void console_doenv(int file, struct stdio_dev *dev)
262 console_setfile(file, dev);
264 #endif /* CONIFIG_IS_ENABLED(CONSOLE_MUX) */
266 /** U-Boot INITIAL CONSOLE-NOT COMPATIBLE FUNCTIONS *************************/
268 int serial_printf(const char *fmt, ...)
272 char printbuffer[CONFIG_SYS_PBSIZE];
276 /* For this to work, printbuffer must be larger than
277 * anything we ever want to print.
279 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
282 serial_puts(printbuffer);
288 if (file < MAX_FILES) {
289 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
291 * Effectively poll for input wherever it may be available.
296 * Upper layer may have already called tstc() so
297 * check for that first.
300 return console_getc(file);
302 #ifdef CONFIG_WATCHDOG
304 * If the watchdog must be rate-limited then it should
305 * already be handled in board-specific code.
311 return console_getc(file);
320 if (file < MAX_FILES)
321 return console_tstc(file);
326 void fputc(int file, const char c)
328 if (file < MAX_FILES)
329 console_putc(file, c);
332 void fputs(int file, const char *s)
334 if (file < MAX_FILES)
335 console_puts(file, s);
338 int fprintf(int file, const char *fmt, ...)
342 char printbuffer[CONFIG_SYS_PBSIZE];
346 /* For this to work, printbuffer must be larger than
347 * anything we ever want to print.
349 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
352 /* Send to desired file */
353 fputs(file, printbuffer);
357 /** U-Boot INITIAL CONSOLE-COMPATIBLE FUNCTION *****************************/
361 #ifdef CONFIG_DISABLE_CONSOLE
362 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
366 if (!gd->have_console)
369 #ifdef CONFIG_CONSOLE_RECORD
370 if (gd->console_in.start) {
373 ch = membuff_getbyte(&gd->console_in);
378 if (gd->flags & GD_FLG_DEVINIT) {
379 /* Get from the standard input */
383 /* Send directly to the handler */
384 return serial_getc();
389 #ifdef CONFIG_DISABLE_CONSOLE
390 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
394 if (!gd->have_console)
396 #ifdef CONFIG_CONSOLE_RECORD
397 if (gd->console_in.start) {
398 if (membuff_peekbyte(&gd->console_in) != -1)
402 if (gd->flags & GD_FLG_DEVINIT) {
403 /* Test the standard input */
407 /* Send directly to the handler */
408 return serial_tstc();
411 #define PRE_CONSOLE_FLUSHPOINT1_SERIAL 0
412 #define PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL 1
414 #if CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
415 #define CIRC_BUF_IDX(idx) ((idx) % (unsigned long)CONFIG_PRE_CON_BUF_SZ)
417 static void pre_console_putc(const char c)
419 char *buffer = (char *)CONFIG_PRE_CON_BUF_ADDR;
421 buffer[CIRC_BUF_IDX(gd->precon_buf_idx++)] = c;
424 static void pre_console_puts(const char *s)
427 pre_console_putc(*s++);
430 static void print_pre_console_buffer(int flushpoint)
432 unsigned long in = 0, out = 0;
433 char *buf_in = (char *)CONFIG_PRE_CON_BUF_ADDR;
434 char buf_out[CONFIG_PRE_CON_BUF_SZ + 1];
436 if (gd->precon_buf_idx > CONFIG_PRE_CON_BUF_SZ)
437 in = gd->precon_buf_idx - CONFIG_PRE_CON_BUF_SZ;
439 while (in < gd->precon_buf_idx)
440 buf_out[out++] = buf_in[CIRC_BUF_IDX(in++)];
444 switch (flushpoint) {
445 case PRE_CONSOLE_FLUSHPOINT1_SERIAL:
448 case PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL:
449 console_puts_noserial(stdout, buf_out);
454 static inline void pre_console_putc(const char c) {}
455 static inline void pre_console_puts(const char *s) {}
456 static inline void print_pre_console_buffer(int flushpoint) {}
459 void putc(const char c)
461 #ifdef CONFIG_SANDBOX
462 /* sandbox can send characters to stdout before it has a console */
463 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
468 #ifdef CONFIG_DEBUG_UART
469 /* if we don't have a console yet, use the debug UART */
470 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
475 #ifdef CONFIG_CONSOLE_RECORD
476 if (gd && (gd->flags & GD_FLG_RECORD) && gd->console_out.start)
477 membuff_putbyte(&gd->console_out, c);
479 #ifdef CONFIG_SILENT_CONSOLE
480 if (gd->flags & GD_FLG_SILENT)
484 #ifdef CONFIG_DISABLE_CONSOLE
485 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
489 if (!gd->have_console)
490 return pre_console_putc(c);
492 if (gd->flags & GD_FLG_DEVINIT) {
493 /* Send to the standard output */
496 /* Send directly to the handler */
502 void puts(const char *s)
504 #ifdef CONFIG_SANDBOX
505 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
510 #ifdef CONFIG_DEBUG_UART
511 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
520 #ifdef CONFIG_CONSOLE_RECORD
521 if (gd && (gd->flags & GD_FLG_RECORD) && gd->console_out.start)
522 membuff_put(&gd->console_out, s, strlen(s));
524 #ifdef CONFIG_SILENT_CONSOLE
525 if (gd->flags & GD_FLG_SILENT)
529 #ifdef CONFIG_DISABLE_CONSOLE
530 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
534 if (!gd->have_console)
535 return pre_console_puts(s);
537 if (gd->flags & GD_FLG_DEVINIT) {
538 /* Send to the standard output */
541 /* Send directly to the handler */
547 #ifdef CONFIG_CONSOLE_RECORD
548 int console_record_init(void)
552 ret = membuff_new(&gd->console_out, CONFIG_CONSOLE_RECORD_OUT_SIZE);
555 ret = membuff_new(&gd->console_in, CONFIG_CONSOLE_RECORD_IN_SIZE);
560 void console_record_reset(void)
562 membuff_purge(&gd->console_out);
563 membuff_purge(&gd->console_in);
566 void console_record_reset_enable(void)
568 console_record_reset();
569 gd->flags |= GD_FLG_RECORD;
573 /* test if ctrl-c was pressed */
574 static int ctrlc_disabled = 0; /* see disable_ctrl() */
575 static int ctrlc_was_pressed = 0;
578 #ifndef CONFIG_SANDBOX
579 if (!ctrlc_disabled && gd->have_console) {
582 case 0x03: /* ^C - Control C */
583 ctrlc_was_pressed = 1;
594 /* Reads user's confirmation.
595 Returns 1 if user's input is "y", "Y", "yes" or "YES"
597 int confirm_yesno(void)
606 while (i < sizeof(str_input)) {
607 str_input[i] = getc();
609 if (str_input[i] == '\r')
614 if (strncmp(str_input, "y\r", 2) == 0 ||
615 strncmp(str_input, "Y\r", 2) == 0 ||
616 strncmp(str_input, "yes\r", 4) == 0 ||
617 strncmp(str_input, "YES\r", 4) == 0)
621 /* pass 1 to disable ctrlc() checking, 0 to enable.
622 * returns previous state
624 int disable_ctrlc(int disable)
626 int prev = ctrlc_disabled; /* save previous state */
628 ctrlc_disabled = disable;
634 return ctrlc_was_pressed;
637 void clear_ctrlc(void)
639 ctrlc_was_pressed = 0;
642 /** U-Boot INIT FUNCTIONS *************************************************/
644 struct stdio_dev *search_device(int flags, const char *name)
646 struct stdio_dev *dev;
648 dev = stdio_get_by_name(name);
649 #ifdef CONFIG_VIDCONSOLE_AS_LCD
650 if (!dev && !strcmp(name, "lcd"))
651 dev = stdio_get_by_name("vidconsole");
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 static void console_update_silent(void)
690 #ifdef CONFIG_SILENT_CONSOLE
691 if (getenv("silent") != NULL)
692 gd->flags |= GD_FLG_SILENT;
694 gd->flags &= ~GD_FLG_SILENT;
698 int console_announce_r(void)
700 #if !CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
701 char buf[DISPLAY_OPTIONS_BANNER_LENGTH];
703 display_options_get_banner(false, buf, sizeof(buf));
705 console_puts_noserial(stdout, buf);
711 /* Called before relocation - use serial functions */
712 int console_init_f(void)
714 gd->have_console = 1;
716 console_update_silent();
718 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT1_SERIAL);
723 void stdio_print_current_devices(void)
725 /* Print information */
727 if (stdio_devices[stdin] == NULL) {
728 puts("No input devices available!\n");
730 printf ("%s\n", stdio_devices[stdin]->name);
734 if (stdio_devices[stdout] == NULL) {
735 puts("No output devices available!\n");
737 printf ("%s\n", stdio_devices[stdout]->name);
741 if (stdio_devices[stderr] == NULL) {
742 puts("No error devices available!\n");
744 printf ("%s\n", stdio_devices[stderr]->name);
748 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
749 /* Called after the relocation - use desired console functions */
750 int console_init_r(void)
752 char *stdinname, *stdoutname, *stderrname;
753 struct stdio_dev *inputdev = NULL, *outputdev = NULL, *errdev = NULL;
754 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
756 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
757 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
761 /* set default handlers at first */
762 gd->jt->getc = serial_getc;
763 gd->jt->tstc = serial_tstc;
764 gd->jt->putc = serial_putc;
765 gd->jt->puts = serial_puts;
766 gd->jt->printf = serial_printf;
768 /* stdin stdout and stderr are in environment */
770 stdinname = getenv("stdin");
771 stdoutname = getenv("stdout");
772 stderrname = getenv("stderr");
774 if (OVERWRITE_CONSOLE == 0) { /* if not overwritten by config switch */
775 inputdev = search_device(DEV_FLAGS_INPUT, stdinname);
776 outputdev = search_device(DEV_FLAGS_OUTPUT, stdoutname);
777 errdev = search_device(DEV_FLAGS_OUTPUT, stderrname);
778 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
779 iomux_err = iomux_doenv(stdin, stdinname);
780 iomux_err += iomux_doenv(stdout, stdoutname);
781 iomux_err += iomux_doenv(stderr, stderrname);
783 /* Successful, so skip all the code below. */
787 /* if the devices are overwritten or not found, use default device */
788 if (inputdev == NULL) {
789 inputdev = search_device(DEV_FLAGS_INPUT, "serial");
791 if (outputdev == NULL) {
792 outputdev = search_device(DEV_FLAGS_OUTPUT, "serial");
794 if (errdev == NULL) {
795 errdev = search_device(DEV_FLAGS_OUTPUT, "serial");
797 /* Initializes output console first */
798 if (outputdev != NULL) {
799 /* need to set a console if not done above. */
800 console_doenv(stdout, outputdev);
802 if (errdev != NULL) {
803 /* need to set a console if not done above. */
804 console_doenv(stderr, errdev);
806 if (inputdev != NULL) {
807 /* need to set a console if not done above. */
808 console_doenv(stdin, inputdev);
811 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
815 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
816 stdio_print_current_devices();
817 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
818 #ifdef CONFIG_VIDCONSOLE_AS_LCD
819 if (strstr(stdoutname, "lcd"))
820 printf("Warning: Please change 'lcd' to 'vidconsole' in stdout/stderr environment vars\n");
823 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
824 /* set the environment variables (will overwrite previous env settings) */
825 for (i = 0; i < 3; i++) {
826 setenv(stdio_names[i], stdio_devices[i]->name);
828 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
830 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
833 /* If nothing usable installed, use only the initial console */
834 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
837 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL);
841 #else /* !CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */
843 /* Called after the relocation - use desired console functions */
844 int console_init_r(void)
846 struct stdio_dev *inputdev = NULL, *outputdev = NULL;
848 struct list_head *list = stdio_get_list();
849 struct list_head *pos;
850 struct stdio_dev *dev;
852 console_update_silent();
854 #ifdef CONFIG_SPLASH_SCREEN
856 * suppress all output if splash screen is enabled and we have
857 * a bmp to display. We redirect the output from frame buffer
858 * console to serial console in this case or suppress it if
859 * "silent" mode was requested.
861 if (getenv("splashimage") != NULL) {
862 if (!(gd->flags & GD_FLG_SILENT))
863 outputdev = search_device (DEV_FLAGS_OUTPUT, "serial");
867 /* Scan devices looking for input and output devices */
868 list_for_each(pos, list) {
869 dev = list_entry(pos, struct stdio_dev, list);
871 if ((dev->flags & DEV_FLAGS_INPUT) && (inputdev == NULL)) {
874 if ((dev->flags & DEV_FLAGS_OUTPUT) && (outputdev == NULL)) {
877 if(inputdev && outputdev)
881 /* Initializes output console first */
882 if (outputdev != NULL) {
883 console_setfile(stdout, outputdev);
884 console_setfile(stderr, outputdev);
885 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
886 console_devices[stdout][0] = outputdev;
887 console_devices[stderr][0] = outputdev;
891 /* Initializes input console */
892 if (inputdev != NULL) {
893 console_setfile(stdin, inputdev);
894 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
895 console_devices[stdin][0] = inputdev;
899 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
900 stdio_print_current_devices();
901 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
903 /* Setting environment variables */
904 for (i = 0; i < 3; i++) {
905 setenv(stdio_names[i], stdio_devices[i]->name);
908 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
911 /* If nothing usable installed, use only the initial console */
912 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
915 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL);
919 #endif /* CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */