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>
17 #include <stdio_dev.h>
19 #include <environment.h>
22 DECLARE_GLOBAL_DATA_PTR;
24 static int on_console(const char *name, const char *value, enum env_op op,
29 /* Check for console redirection */
30 if (strcmp(name, "stdin") == 0)
32 else if (strcmp(name, "stdout") == 0)
34 else if (strcmp(name, "stderr") == 0)
37 /* if not actually setting a console variable, we don't care */
38 if (console == -1 || (gd->flags & GD_FLG_DEVINIT) == 0)
43 case env_op_overwrite:
45 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
46 if (iomux_doenv(console, value))
49 /* Try assigning specified device */
50 if (console_assign(console, value) < 0)
56 if ((flags & H_FORCE) == 0)
57 printf("Can't delete \"%s\"\n", name);
64 U_BOOT_ENV_CALLBACK(console, on_console);
66 #ifdef CONFIG_SILENT_CONSOLE
67 static int on_silent(const char *name, const char *value, enum env_op op,
70 #if !CONFIG_IS_ENABLED(CONFIG_SILENT_CONSOLE_UPDATE_ON_SET)
71 if (flags & H_INTERACTIVE)
74 #if !CONFIG_IS_ENABLED(CONFIG_SILENT_CONSOLE_UPDATE_ON_RELOC)
75 if ((flags & H_INTERACTIVE) == 0)
80 gd->flags |= GD_FLG_SILENT;
82 gd->flags &= ~GD_FLG_SILENT;
86 U_BOOT_ENV_CALLBACK(silent, on_silent);
89 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
91 * if overwrite_console returns 1, the stdin, stderr and stdout
92 * are switched to the serial port, else the settings in the
93 * environment are used
95 #ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
96 extern int overwrite_console(void);
97 #define OVERWRITE_CONSOLE overwrite_console()
99 #define OVERWRITE_CONSOLE 0
100 #endif /* CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE */
102 #endif /* CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */
104 static int console_setfile(int file, struct stdio_dev * dev)
115 /* Start new device */
117 error = dev->start(dev);
118 /* If it's not started dont use it */
123 /* Assign the new device (leaving the existing one started) */
124 stdio_devices[file] = dev;
127 * Update monitor functions
128 * (to use the console stuff by other applications)
138 gd->jt->printf = printf;
143 default: /* Invalid file ID */
149 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
150 /** Console I/O multiplexing *******************************************/
152 static struct stdio_dev *tstcdev;
153 struct stdio_dev **console_devices[MAX_FILES];
154 int cd_count[MAX_FILES];
157 * This depends on tstc() always being called before getc().
158 * This is guaranteed to be true because this routine is called
159 * only from fgetc() which assures it.
160 * No attempt is made to demultiplex multiple input sources.
162 static int console_getc(int file)
166 /* This is never called with testcdev == NULL */
167 ret = tstcdev->getc(tstcdev);
172 static int console_tstc(int file)
175 struct stdio_dev *dev;
178 for (i = 0; i < cd_count[file]; i++) {
179 dev = console_devices[file][i];
180 if (dev->tstc != NULL) {
181 ret = dev->tstc(dev);
194 static void console_putc(int file, const char c)
197 struct stdio_dev *dev;
199 for (i = 0; i < cd_count[file]; i++) {
200 dev = console_devices[file][i];
201 if (dev->putc != NULL)
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)
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 static inline void console_puts_noserial(int file, const char *s)
252 if (strcmp(stdio_devices[file]->name, "serial") != 0)
253 stdio_devices[file]->puts(stdio_devices[file], s);
256 static inline void console_puts(int file, const char *s)
258 stdio_devices[file]->puts(stdio_devices[file], s);
261 static inline void console_doenv(int file, struct stdio_dev *dev)
263 console_setfile(file, dev);
265 #endif /* CONIFIG_IS_ENABLED(CONSOLE_MUX) */
267 /** U-Boot INITIAL CONSOLE-NOT COMPATIBLE FUNCTIONS *************************/
269 int serial_printf(const char *fmt, ...)
273 char printbuffer[CONFIG_SYS_PBSIZE];
277 /* For this to work, printbuffer must be larger than
278 * anything we ever want to print.
280 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
283 serial_puts(printbuffer);
289 if (file < MAX_FILES) {
290 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
292 * Effectively poll for input wherever it may be available.
297 * Upper layer may have already called tstc() so
298 * check for that first.
301 return console_getc(file);
303 #ifdef CONFIG_WATCHDOG
305 * If the watchdog must be rate-limited then it should
306 * already be handled in board-specific code.
312 return console_getc(file);
321 if (file < MAX_FILES)
322 return console_tstc(file);
327 void fputc(int file, const char c)
329 if (file < MAX_FILES)
330 console_putc(file, c);
333 void fputs(int file, const char *s)
335 if (file < MAX_FILES)
336 console_puts(file, s);
339 int fprintf(int file, const char *fmt, ...)
343 char printbuffer[CONFIG_SYS_PBSIZE];
347 /* For this to work, printbuffer must be larger than
348 * anything we ever want to print.
350 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
353 /* Send to desired file */
354 fputs(file, printbuffer);
358 /** U-Boot INITIAL CONSOLE-COMPATIBLE FUNCTION *****************************/
362 #ifdef CONFIG_DISABLE_CONSOLE
363 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
367 if (!gd->have_console)
370 #ifdef CONFIG_CONSOLE_RECORD
371 if (gd->console_in.start) {
374 ch = membuff_getbyte(&gd->console_in);
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)
397 #ifdef CONFIG_CONSOLE_RECORD
398 if (gd->console_in.start) {
399 if (membuff_peekbyte(&gd->console_in) != -1)
403 if (gd->flags & GD_FLG_DEVINIT) {
404 /* Test the standard input */
408 /* Send directly to the handler */
409 return serial_tstc();
412 #define PRE_CONSOLE_FLUSHPOINT1_SERIAL 0
413 #define PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL 1
415 #if CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
416 #define CIRC_BUF_IDX(idx) ((idx) % (unsigned long)CONFIG_PRE_CON_BUF_SZ)
418 static void pre_console_putc(const char c)
422 buffer = map_sysmem(CONFIG_PRE_CON_BUF_ADDR, CONFIG_PRE_CON_BUF_SZ);
424 buffer[CIRC_BUF_IDX(gd->precon_buf_idx++)] = c;
426 unmap_sysmem(buffer);
429 static void pre_console_puts(const char *s)
432 pre_console_putc(*s++);
435 static void print_pre_console_buffer(int flushpoint)
437 unsigned long in = 0, out = 0;
438 char buf_out[CONFIG_PRE_CON_BUF_SZ + 1];
441 buf_in = map_sysmem(CONFIG_PRE_CON_BUF_ADDR, CONFIG_PRE_CON_BUF_SZ);
442 if (gd->precon_buf_idx > CONFIG_PRE_CON_BUF_SZ)
443 in = gd->precon_buf_idx - CONFIG_PRE_CON_BUF_SZ;
445 while (in < gd->precon_buf_idx)
446 buf_out[out++] = buf_in[CIRC_BUF_IDX(in++)];
447 unmap_sysmem(buf_in);
451 switch (flushpoint) {
452 case PRE_CONSOLE_FLUSHPOINT1_SERIAL:
455 case PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL:
456 console_puts_noserial(stdout, buf_out);
461 static inline void pre_console_putc(const char c) {}
462 static inline void pre_console_puts(const char *s) {}
463 static inline void print_pre_console_buffer(int flushpoint) {}
466 void putc(const char c)
468 #ifdef CONFIG_SANDBOX
469 /* sandbox can send characters to stdout before it has a console */
470 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
475 #ifdef CONFIG_DEBUG_UART
476 /* if we don't have a console yet, use the debug UART */
477 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
482 #ifdef CONFIG_CONSOLE_RECORD
483 if (gd && (gd->flags & GD_FLG_RECORD) && gd->console_out.start)
484 membuff_putbyte(&gd->console_out, c);
486 #ifdef CONFIG_SILENT_CONSOLE
487 if (gd->flags & GD_FLG_SILENT)
491 #ifdef CONFIG_DISABLE_CONSOLE
492 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
496 if (!gd->have_console)
497 return pre_console_putc(c);
499 if (gd->flags & GD_FLG_DEVINIT) {
500 /* Send to the standard output */
503 /* Send directly to the handler */
509 void puts(const char *s)
511 #ifdef CONFIG_SANDBOX
512 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
517 #ifdef CONFIG_DEBUG_UART
518 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
527 #ifdef CONFIG_CONSOLE_RECORD
528 if (gd && (gd->flags & GD_FLG_RECORD) && gd->console_out.start)
529 membuff_put(&gd->console_out, s, strlen(s));
531 #ifdef CONFIG_SILENT_CONSOLE
532 if (gd->flags & GD_FLG_SILENT)
536 #ifdef CONFIG_DISABLE_CONSOLE
537 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
541 if (!gd->have_console)
542 return pre_console_puts(s);
544 if (gd->flags & GD_FLG_DEVINIT) {
545 /* Send to the standard output */
548 /* Send directly to the handler */
554 #ifdef CONFIG_CONSOLE_RECORD
555 int console_record_init(void)
559 ret = membuff_new(&gd->console_out, CONFIG_CONSOLE_RECORD_OUT_SIZE);
562 ret = membuff_new(&gd->console_in, CONFIG_CONSOLE_RECORD_IN_SIZE);
567 void console_record_reset(void)
569 membuff_purge(&gd->console_out);
570 membuff_purge(&gd->console_in);
573 void console_record_reset_enable(void)
575 console_record_reset();
576 gd->flags |= GD_FLG_RECORD;
580 /* test if ctrl-c was pressed */
581 static int ctrlc_disabled = 0; /* see disable_ctrl() */
582 static int ctrlc_was_pressed = 0;
585 #ifndef CONFIG_SANDBOX
586 if (!ctrlc_disabled && gd->have_console) {
589 case 0x03: /* ^C - Control C */
590 ctrlc_was_pressed = 1;
601 /* Reads user's confirmation.
602 Returns 1 if user's input is "y", "Y", "yes" or "YES"
604 int confirm_yesno(void)
613 while (i < sizeof(str_input)) {
614 str_input[i] = getc();
616 if (str_input[i] == '\r')
621 if (strncmp(str_input, "y\r", 2) == 0 ||
622 strncmp(str_input, "Y\r", 2) == 0 ||
623 strncmp(str_input, "yes\r", 4) == 0 ||
624 strncmp(str_input, "YES\r", 4) == 0)
628 /* pass 1 to disable ctrlc() checking, 0 to enable.
629 * returns previous state
631 int disable_ctrlc(int disable)
633 int prev = ctrlc_disabled; /* save previous state */
635 ctrlc_disabled = disable;
641 return ctrlc_was_pressed;
644 void clear_ctrlc(void)
646 ctrlc_was_pressed = 0;
649 /** U-Boot INIT FUNCTIONS *************************************************/
651 struct stdio_dev *search_device(int flags, const char *name)
653 struct stdio_dev *dev;
655 dev = stdio_get_by_name(name);
656 #ifdef CONFIG_VIDCONSOLE_AS_LCD
657 if (!dev && !strcmp(name, "lcd"))
658 dev = stdio_get_by_name("vidconsole");
661 if (dev && (dev->flags & flags))
667 int console_assign(int file, const char *devname)
670 struct stdio_dev *dev;
672 /* Check for valid file */
675 flag = DEV_FLAGS_INPUT;
679 flag = DEV_FLAGS_OUTPUT;
685 /* Check for valid device name */
687 dev = search_device(flag, devname);
690 return console_setfile(file, dev);
695 static void console_update_silent(void)
697 #ifdef CONFIG_SILENT_CONSOLE
698 if (getenv("silent") != NULL)
699 gd->flags |= GD_FLG_SILENT;
701 gd->flags &= ~GD_FLG_SILENT;
705 int console_announce_r(void)
707 #if !CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
708 char buf[DISPLAY_OPTIONS_BANNER_LENGTH];
710 display_options_get_banner(false, buf, sizeof(buf));
712 console_puts_noserial(stdout, buf);
718 /* Called before relocation - use serial functions */
719 int console_init_f(void)
721 gd->have_console = 1;
723 console_update_silent();
725 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT1_SERIAL);
730 void stdio_print_current_devices(void)
732 /* Print information */
734 if (stdio_devices[stdin] == NULL) {
735 puts("No input devices available!\n");
737 printf ("%s\n", stdio_devices[stdin]->name);
741 if (stdio_devices[stdout] == NULL) {
742 puts("No output devices available!\n");
744 printf ("%s\n", stdio_devices[stdout]->name);
748 if (stdio_devices[stderr] == NULL) {
749 puts("No error devices available!\n");
751 printf ("%s\n", stdio_devices[stderr]->name);
755 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
756 /* Called after the relocation - use desired console functions */
757 int console_init_r(void)
759 char *stdinname, *stdoutname, *stderrname;
760 struct stdio_dev *inputdev = NULL, *outputdev = NULL, *errdev = NULL;
761 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
763 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
764 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
768 /* set default handlers at first */
769 gd->jt->getc = serial_getc;
770 gd->jt->tstc = serial_tstc;
771 gd->jt->putc = serial_putc;
772 gd->jt->puts = serial_puts;
773 gd->jt->printf = serial_printf;
775 /* stdin stdout and stderr are in environment */
777 stdinname = getenv("stdin");
778 stdoutname = getenv("stdout");
779 stderrname = getenv("stderr");
781 if (OVERWRITE_CONSOLE == 0) { /* if not overwritten by config switch */
782 inputdev = search_device(DEV_FLAGS_INPUT, stdinname);
783 outputdev = search_device(DEV_FLAGS_OUTPUT, stdoutname);
784 errdev = search_device(DEV_FLAGS_OUTPUT, stderrname);
785 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
786 iomux_err = iomux_doenv(stdin, stdinname);
787 iomux_err += iomux_doenv(stdout, stdoutname);
788 iomux_err += iomux_doenv(stderr, stderrname);
790 /* Successful, so skip all the code below. */
794 /* if the devices are overwritten or not found, use default device */
795 if (inputdev == NULL) {
796 inputdev = search_device(DEV_FLAGS_INPUT, "serial");
798 if (outputdev == NULL) {
799 outputdev = search_device(DEV_FLAGS_OUTPUT, "serial");
801 if (errdev == NULL) {
802 errdev = search_device(DEV_FLAGS_OUTPUT, "serial");
804 /* Initializes output console first */
805 if (outputdev != NULL) {
806 /* need to set a console if not done above. */
807 console_doenv(stdout, outputdev);
809 if (errdev != NULL) {
810 /* need to set a console if not done above. */
811 console_doenv(stderr, errdev);
813 if (inputdev != NULL) {
814 /* need to set a console if not done above. */
815 console_doenv(stdin, inputdev);
818 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
822 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
823 stdio_print_current_devices();
824 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
825 #ifdef CONFIG_VIDCONSOLE_AS_LCD
826 if (strstr(stdoutname, "lcd"))
827 printf("Warning: Please change 'lcd' to 'vidconsole' in stdout/stderr environment vars\n");
830 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
831 /* set the environment variables (will overwrite previous env settings) */
832 for (i = 0; i < 3; i++) {
833 setenv(stdio_names[i], stdio_devices[i]->name);
835 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
837 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
840 /* If nothing usable installed, use only the initial console */
841 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
844 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL);
848 #else /* !CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */
850 /* Called after the relocation - use desired console functions */
851 int console_init_r(void)
853 struct stdio_dev *inputdev = NULL, *outputdev = NULL;
855 struct list_head *list = stdio_get_list();
856 struct list_head *pos;
857 struct stdio_dev *dev;
859 console_update_silent();
861 #ifdef CONFIG_SPLASH_SCREEN
863 * suppress all output if splash screen is enabled and we have
864 * a bmp to display. We redirect the output from frame buffer
865 * console to serial console in this case or suppress it if
866 * "silent" mode was requested.
868 if (getenv("splashimage") != NULL) {
869 if (!(gd->flags & GD_FLG_SILENT))
870 outputdev = search_device (DEV_FLAGS_OUTPUT, "serial");
874 /* Scan devices looking for input and output devices */
875 list_for_each(pos, list) {
876 dev = list_entry(pos, struct stdio_dev, list);
878 if ((dev->flags & DEV_FLAGS_INPUT) && (inputdev == NULL)) {
881 if ((dev->flags & DEV_FLAGS_OUTPUT) && (outputdev == NULL)) {
884 if(inputdev && outputdev)
888 /* Initializes output console first */
889 if (outputdev != NULL) {
890 console_setfile(stdout, outputdev);
891 console_setfile(stderr, outputdev);
892 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
893 console_devices[stdout][0] = outputdev;
894 console_devices[stderr][0] = outputdev;
898 /* Initializes input console */
899 if (inputdev != NULL) {
900 console_setfile(stdin, inputdev);
901 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
902 console_devices[stdin][0] = inputdev;
906 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
907 stdio_print_current_devices();
908 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
910 /* Setting environment variables */
911 for (i = 0; i < 3; i++) {
912 setenv(stdio_names[i], stdio_devices[i]->name);
915 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
918 /* If nothing usable installed, use only the initial console */
919 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
922 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL);
926 #endif /* CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */