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 print_pre_console_buffer(int flushpoint)
431 unsigned long in = 0, out = 0;
432 char buf_out[CONFIG_PRE_CON_BUF_SZ + 1];
435 buf_in = map_sysmem(CONFIG_PRE_CON_BUF_ADDR, CONFIG_PRE_CON_BUF_SZ);
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++)];
441 unmap_sysmem(buf_in);
445 switch (flushpoint) {
446 case PRE_CONSOLE_FLUSHPOINT1_SERIAL:
449 case PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL:
450 console_puts_noserial(stdout, buf_out);
455 static inline void pre_console_putc(const char c) {}
456 static inline void print_pre_console_buffer(int flushpoint) {}
459 void putc(const char c)
461 #ifdef CONFIG_DEBUG_UART
462 /* if we don't have a console yet, use the debug UART */
463 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
468 #ifdef CONFIG_CONSOLE_RECORD
469 if (gd && (gd->flags & GD_FLG_RECORD) && gd->console_out.start)
470 membuff_putbyte(&gd->console_out, c);
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)
501 #ifdef CONFIG_CONSOLE_RECORD
502 int console_record_init(void)
506 ret = membuff_new(&gd->console_out, CONFIG_CONSOLE_RECORD_OUT_SIZE);
509 ret = membuff_new(&gd->console_in, CONFIG_CONSOLE_RECORD_IN_SIZE);
514 void console_record_reset(void)
516 membuff_purge(&gd->console_out);
517 membuff_purge(&gd->console_in);
520 void console_record_reset_enable(void)
522 console_record_reset();
523 gd->flags |= GD_FLG_RECORD;
527 /* test if ctrl-c was pressed */
528 static int ctrlc_disabled = 0; /* see disable_ctrl() */
529 static int ctrlc_was_pressed = 0;
532 #ifndef CONFIG_SANDBOX
533 if (!ctrlc_disabled && gd->have_console) {
536 case 0x03: /* ^C - Control C */
537 ctrlc_was_pressed = 1;
548 /* Reads user's confirmation.
549 Returns 1 if user's input is "y", "Y", "yes" or "YES"
551 int confirm_yesno(void)
560 while (i < sizeof(str_input)) {
561 str_input[i] = getc();
563 if (str_input[i] == '\r')
568 if (strncmp(str_input, "y\r", 2) == 0 ||
569 strncmp(str_input, "Y\r", 2) == 0 ||
570 strncmp(str_input, "yes\r", 4) == 0 ||
571 strncmp(str_input, "YES\r", 4) == 0)
575 /* pass 1 to disable ctrlc() checking, 0 to enable.
576 * returns previous state
578 int disable_ctrlc(int disable)
580 int prev = ctrlc_disabled; /* save previous state */
582 ctrlc_disabled = disable;
588 return ctrlc_was_pressed;
591 void clear_ctrlc(void)
593 ctrlc_was_pressed = 0;
596 /** U-Boot INIT FUNCTIONS *************************************************/
598 struct stdio_dev *search_device(int flags, const char *name)
600 struct stdio_dev *dev;
602 dev = stdio_get_by_name(name);
603 #ifdef CONFIG_VIDCONSOLE_AS_LCD
604 if (!dev && !strcmp(name, "lcd"))
605 dev = stdio_get_by_name("vidconsole");
608 if (dev && (dev->flags & flags))
614 int console_assign(int file, const char *devname)
617 struct stdio_dev *dev;
619 /* Check for valid file */
622 flag = DEV_FLAGS_INPUT;
626 flag = DEV_FLAGS_OUTPUT;
632 /* Check for valid device name */
634 dev = search_device(flag, devname);
637 return console_setfile(file, dev);
642 static void console_update_silent(void)
644 #ifdef CONFIG_SILENT_CONSOLE
645 if (getenv("silent") != NULL)
646 gd->flags |= GD_FLG_SILENT;
648 gd->flags &= ~GD_FLG_SILENT;
652 int console_announce_r(void)
654 #if !CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
655 char buf[DISPLAY_OPTIONS_BANNER_LENGTH];
657 display_options_get_banner(false, buf, sizeof(buf));
659 console_puts_noserial(stdout, buf);
665 /* Called before relocation - use serial functions */
666 int console_init_f(void)
668 gd->have_console = 1;
670 console_update_silent();
672 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT1_SERIAL);
677 void stdio_print_current_devices(void)
679 /* Print information */
681 if (stdio_devices[stdin] == NULL) {
682 puts("No input devices available!\n");
684 printf ("%s\n", stdio_devices[stdin]->name);
688 if (stdio_devices[stdout] == NULL) {
689 puts("No output devices available!\n");
691 printf ("%s\n", stdio_devices[stdout]->name);
695 if (stdio_devices[stderr] == NULL) {
696 puts("No error devices available!\n");
698 printf ("%s\n", stdio_devices[stderr]->name);
702 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
703 /* Called after the relocation - use desired console functions */
704 int console_init_r(void)
706 char *stdinname, *stdoutname, *stderrname;
707 struct stdio_dev *inputdev = NULL, *outputdev = NULL, *errdev = NULL;
708 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
710 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
711 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
715 /* set default handlers at first */
716 gd->jt->getc = serial_getc;
717 gd->jt->tstc = serial_tstc;
718 gd->jt->putc = serial_putc;
719 gd->jt->puts = serial_puts;
720 gd->jt->printf = serial_printf;
722 /* stdin stdout and stderr are in environment */
724 stdinname = getenv("stdin");
725 stdoutname = getenv("stdout");
726 stderrname = getenv("stderr");
728 if (OVERWRITE_CONSOLE == 0) { /* if not overwritten by config switch */
729 inputdev = search_device(DEV_FLAGS_INPUT, stdinname);
730 outputdev = search_device(DEV_FLAGS_OUTPUT, stdoutname);
731 errdev = search_device(DEV_FLAGS_OUTPUT, stderrname);
732 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
733 iomux_err = iomux_doenv(stdin, stdinname);
734 iomux_err += iomux_doenv(stdout, stdoutname);
735 iomux_err += iomux_doenv(stderr, stderrname);
737 /* Successful, so skip all the code below. */
741 /* if the devices are overwritten or not found, use default device */
742 if (inputdev == NULL) {
743 inputdev = search_device(DEV_FLAGS_INPUT, "serial");
745 if (outputdev == NULL) {
746 outputdev = search_device(DEV_FLAGS_OUTPUT, "serial");
748 if (errdev == NULL) {
749 errdev = search_device(DEV_FLAGS_OUTPUT, "serial");
751 /* Initializes output console first */
752 if (outputdev != NULL) {
753 /* need to set a console if not done above. */
754 console_doenv(stdout, outputdev);
756 if (errdev != NULL) {
757 /* need to set a console if not done above. */
758 console_doenv(stderr, errdev);
760 if (inputdev != NULL) {
761 /* need to set a console if not done above. */
762 console_doenv(stdin, inputdev);
765 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
769 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
770 stdio_print_current_devices();
771 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
772 #ifdef CONFIG_VIDCONSOLE_AS_LCD
773 if (strstr(stdoutname, "lcd"))
774 printf("Warning: Please change 'lcd' to 'vidconsole' in stdout/stderr environment vars\n");
777 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
778 /* set the environment variables (will overwrite previous env settings) */
779 for (i = 0; i < 3; i++) {
780 setenv(stdio_names[i], stdio_devices[i]->name);
782 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
784 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
787 /* If nothing usable installed, use only the initial console */
788 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
791 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL);
795 #else /* !CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */
797 /* Called after the relocation - use desired console functions */
798 int console_init_r(void)
800 struct stdio_dev *inputdev = NULL, *outputdev = NULL;
802 struct list_head *list = stdio_get_list();
803 struct list_head *pos;
804 struct stdio_dev *dev;
806 console_update_silent();
808 #ifdef CONFIG_SPLASH_SCREEN
810 * suppress all output if splash screen is enabled and we have
811 * a bmp to display. We redirect the output from frame buffer
812 * console to serial console in this case or suppress it if
813 * "silent" mode was requested.
815 if (getenv("splashimage") != NULL) {
816 if (!(gd->flags & GD_FLG_SILENT))
817 outputdev = search_device (DEV_FLAGS_OUTPUT, "serial");
821 /* Scan devices looking for input and output devices */
822 list_for_each(pos, list) {
823 dev = list_entry(pos, struct stdio_dev, list);
825 if ((dev->flags & DEV_FLAGS_INPUT) && (inputdev == NULL)) {
828 if ((dev->flags & DEV_FLAGS_OUTPUT) && (outputdev == NULL)) {
831 if(inputdev && outputdev)
835 /* Initializes output console first */
836 if (outputdev != NULL) {
837 console_setfile(stdout, outputdev);
838 console_setfile(stderr, outputdev);
839 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
840 console_devices[stdout][0] = outputdev;
841 console_devices[stderr][0] = outputdev;
845 /* Initializes input console */
846 if (inputdev != NULL) {
847 console_setfile(stdin, inputdev);
848 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
849 console_devices[stdin][0] = inputdev;
853 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
854 stdio_print_current_devices();
855 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
857 /* Setting environment variables */
858 for (i = 0; i < 3; i++) {
859 setenv(stdio_names[i], stdio_devices[i]->name);
862 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
865 /* If nothing usable installed, use only the initial console */
866 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
869 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL);
873 #endif /* CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */