1 // SPDX-License-Identifier: GPL-2.0+
4 * Paolo Scaffardi, AIRVENT SAM s.p.a - RIMINI(ITALY), arsenio@tin.it
9 #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(SILENT_CONSOLE_UPDATE_ON_SET)
71 if (flags & H_INTERACTIVE)
74 #if !CONFIG_IS_ENABLED(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 */
150 * console_dev_is_serial() - Check if a stdio device is a serial device
152 * @sdev: Device to check
153 * @return true if this device is in the serial uclass (or for pre-driver-model,
154 * whether it is called "serial".
156 static bool console_dev_is_serial(struct stdio_dev *sdev)
160 #ifdef CONFIG_DM_SERIAL
161 if (sdev->flags & DEV_FLAGS_DM) {
162 struct udevice *dev = sdev->priv;
164 is_serial = device_get_uclass_id(dev) == UCLASS_SERIAL;
167 is_serial = !strcmp(sdev->name, "serial");
172 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
173 /** Console I/O multiplexing *******************************************/
175 static struct stdio_dev *tstcdev;
176 struct stdio_dev **console_devices[MAX_FILES];
177 int cd_count[MAX_FILES];
180 * This depends on tstc() always being called before getc().
181 * This is guaranteed to be true because this routine is called
182 * only from fgetc() which assures it.
183 * No attempt is made to demultiplex multiple input sources.
185 static int console_getc(int file)
189 /* This is never called with testcdev == NULL */
190 ret = tstcdev->getc(tstcdev);
195 static int console_tstc(int file)
198 struct stdio_dev *dev;
201 for (i = 0; i < cd_count[file]; i++) {
202 dev = console_devices[file][i];
203 if (dev->tstc != NULL) {
204 ret = dev->tstc(dev);
217 static void console_putc(int file, const char c)
220 struct stdio_dev *dev;
222 for (i = 0; i < cd_count[file]; i++) {
223 dev = console_devices[file][i];
224 if (dev->putc != NULL)
229 static void console_puts_noserial(int file, const char *s)
232 struct stdio_dev *dev;
234 for (i = 0; i < cd_count[file]; i++) {
235 dev = console_devices[file][i];
236 if (dev->puts != NULL && !console_dev_is_serial(dev))
241 static void console_puts(int file, const char *s)
244 struct stdio_dev *dev;
246 for (i = 0; i < cd_count[file]; i++) {
247 dev = console_devices[file][i];
248 if (dev->puts != NULL)
253 static inline void console_doenv(int file, struct stdio_dev *dev)
255 iomux_doenv(file, dev->name);
258 static inline int console_getc(int file)
260 return stdio_devices[file]->getc(stdio_devices[file]);
263 static inline int console_tstc(int file)
265 return stdio_devices[file]->tstc(stdio_devices[file]);
268 static inline void console_putc(int file, const char c)
270 stdio_devices[file]->putc(stdio_devices[file], c);
273 static inline void console_puts_noserial(int file, const char *s)
275 if (!console_dev_is_serial(stdio_devices[file]))
276 stdio_devices[file]->puts(stdio_devices[file], s);
279 static inline void console_puts(int file, const char *s)
281 stdio_devices[file]->puts(stdio_devices[file], s);
284 static inline void console_doenv(int file, struct stdio_dev *dev)
286 console_setfile(file, dev);
288 #endif /* CONIFIG_IS_ENABLED(CONSOLE_MUX) */
290 /** U-Boot INITIAL CONSOLE-NOT COMPATIBLE FUNCTIONS *************************/
292 int serial_printf(const char *fmt, ...)
296 char printbuffer[CONFIG_SYS_PBSIZE];
300 /* For this to work, printbuffer must be larger than
301 * anything we ever want to print.
303 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
306 serial_puts(printbuffer);
312 if (file < MAX_FILES) {
313 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
315 * Effectively poll for input wherever it may be available.
320 * Upper layer may have already called tstc() so
321 * check for that first.
324 return console_getc(file);
326 #ifdef CONFIG_WATCHDOG
328 * If the watchdog must be rate-limited then it should
329 * already be handled in board-specific code.
335 return console_getc(file);
344 if (file < MAX_FILES)
345 return console_tstc(file);
350 void fputc(int file, const char c)
352 if (file < MAX_FILES)
353 console_putc(file, c);
356 void fputs(int file, const char *s)
358 if (file < MAX_FILES)
359 console_puts(file, s);
362 int fprintf(int file, const char *fmt, ...)
366 char printbuffer[CONFIG_SYS_PBSIZE];
370 /* For this to work, printbuffer must be larger than
371 * anything we ever want to print.
373 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
376 /* Send to desired file */
377 fputs(file, printbuffer);
381 /** U-Boot INITIAL CONSOLE-COMPATIBLE FUNCTION *****************************/
385 #ifdef CONFIG_DISABLE_CONSOLE
386 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
390 if (!gd->have_console)
393 #ifdef CONFIG_CONSOLE_RECORD
394 if (gd->console_in.start) {
397 ch = membuff_getbyte(&gd->console_in);
402 if (gd->flags & GD_FLG_DEVINIT) {
403 /* Get from the standard input */
407 /* Send directly to the handler */
408 return serial_getc();
413 #ifdef CONFIG_DISABLE_CONSOLE
414 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
418 if (!gd->have_console)
420 #ifdef CONFIG_CONSOLE_RECORD
421 if (gd->console_in.start) {
422 if (membuff_peekbyte(&gd->console_in) != -1)
426 if (gd->flags & GD_FLG_DEVINIT) {
427 /* Test the standard input */
431 /* Send directly to the handler */
432 return serial_tstc();
435 #define PRE_CONSOLE_FLUSHPOINT1_SERIAL 0
436 #define PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL 1
438 #if CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
439 #define CIRC_BUF_IDX(idx) ((idx) % (unsigned long)CONFIG_PRE_CON_BUF_SZ)
441 static void pre_console_putc(const char c)
445 buffer = map_sysmem(CONFIG_PRE_CON_BUF_ADDR, CONFIG_PRE_CON_BUF_SZ);
447 buffer[CIRC_BUF_IDX(gd->precon_buf_idx++)] = c;
449 unmap_sysmem(buffer);
452 static void pre_console_puts(const char *s)
455 pre_console_putc(*s++);
458 static void print_pre_console_buffer(int flushpoint)
460 unsigned long in = 0, out = 0;
461 char buf_out[CONFIG_PRE_CON_BUF_SZ + 1];
464 buf_in = map_sysmem(CONFIG_PRE_CON_BUF_ADDR, CONFIG_PRE_CON_BUF_SZ);
465 if (gd->precon_buf_idx > CONFIG_PRE_CON_BUF_SZ)
466 in = gd->precon_buf_idx - CONFIG_PRE_CON_BUF_SZ;
468 while (in < gd->precon_buf_idx)
469 buf_out[out++] = buf_in[CIRC_BUF_IDX(in++)];
470 unmap_sysmem(buf_in);
474 switch (flushpoint) {
475 case PRE_CONSOLE_FLUSHPOINT1_SERIAL:
478 case PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL:
479 console_puts_noserial(stdout, buf_out);
484 static inline void pre_console_putc(const char c) {}
485 static inline void pre_console_puts(const char *s) {}
486 static inline void print_pre_console_buffer(int flushpoint) {}
489 void putc(const char c)
491 #ifdef CONFIG_SANDBOX
492 /* sandbox can send characters to stdout before it has a console */
493 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
498 #ifdef CONFIG_DEBUG_UART
499 /* if we don't have a console yet, use the debug UART */
500 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
505 #ifdef CONFIG_CONSOLE_RECORD
506 if (gd && (gd->flags & GD_FLG_RECORD) && gd->console_out.start)
507 membuff_putbyte(&gd->console_out, c);
509 #ifdef CONFIG_SILENT_CONSOLE
510 if (gd->flags & GD_FLG_SILENT)
514 #ifdef CONFIG_DISABLE_CONSOLE
515 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
519 if (!gd->have_console)
520 return pre_console_putc(c);
522 if (gd->flags & GD_FLG_DEVINIT) {
523 /* Send to the standard output */
526 /* Send directly to the handler */
532 void puts(const char *s)
534 #ifdef CONFIG_DEBUG_UART
535 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
544 #ifdef CONFIG_CONSOLE_RECORD
545 if (gd && (gd->flags & GD_FLG_RECORD) && gd->console_out.start)
546 membuff_put(&gd->console_out, s, strlen(s));
548 #ifdef CONFIG_SILENT_CONSOLE
549 if (gd->flags & GD_FLG_SILENT)
553 #ifdef CONFIG_DISABLE_CONSOLE
554 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
558 if (!gd->have_console)
559 return pre_console_puts(s);
561 if (gd->flags & GD_FLG_DEVINIT) {
562 /* Send to the standard output */
565 /* Send directly to the handler */
571 #ifdef CONFIG_CONSOLE_RECORD
572 int console_record_init(void)
576 ret = membuff_new(&gd->console_out, CONFIG_CONSOLE_RECORD_OUT_SIZE);
579 ret = membuff_new(&gd->console_in, CONFIG_CONSOLE_RECORD_IN_SIZE);
584 void console_record_reset(void)
586 membuff_purge(&gd->console_out);
587 membuff_purge(&gd->console_in);
590 void console_record_reset_enable(void)
592 console_record_reset();
593 gd->flags |= GD_FLG_RECORD;
597 /* test if ctrl-c was pressed */
598 static int ctrlc_disabled = 0; /* see disable_ctrl() */
599 static int ctrlc_was_pressed = 0;
602 #ifndef CONFIG_SANDBOX
603 if (!ctrlc_disabled && gd->have_console) {
606 case 0x03: /* ^C - Control C */
607 ctrlc_was_pressed = 1;
618 /* Reads user's confirmation.
619 Returns 1 if user's input is "y", "Y", "yes" or "YES"
621 int confirm_yesno(void)
630 while (i < sizeof(str_input)) {
631 str_input[i] = getc();
633 if (str_input[i] == '\r')
638 if (strncmp(str_input, "y\r", 2) == 0 ||
639 strncmp(str_input, "Y\r", 2) == 0 ||
640 strncmp(str_input, "yes\r", 4) == 0 ||
641 strncmp(str_input, "YES\r", 4) == 0)
645 /* pass 1 to disable ctrlc() checking, 0 to enable.
646 * returns previous state
648 int disable_ctrlc(int disable)
650 int prev = ctrlc_disabled; /* save previous state */
652 ctrlc_disabled = disable;
658 return ctrlc_was_pressed;
661 void clear_ctrlc(void)
663 ctrlc_was_pressed = 0;
666 /** U-Boot INIT FUNCTIONS *************************************************/
668 struct stdio_dev *search_device(int flags, const char *name)
670 struct stdio_dev *dev;
672 dev = stdio_get_by_name(name);
673 #ifdef CONFIG_VIDCONSOLE_AS_LCD
674 if (!dev && !strcmp(name, "lcd"))
675 dev = stdio_get_by_name("vidconsole");
678 if (dev && (dev->flags & flags))
684 int console_assign(int file, const char *devname)
687 struct stdio_dev *dev;
689 /* Check for valid file */
692 flag = DEV_FLAGS_INPUT;
696 flag = DEV_FLAGS_OUTPUT;
702 /* Check for valid device name */
704 dev = search_device(flag, devname);
707 return console_setfile(file, dev);
712 static void console_update_silent(void)
714 #ifdef CONFIG_SILENT_CONSOLE
715 if (env_get("silent") != NULL)
716 gd->flags |= GD_FLG_SILENT;
718 gd->flags &= ~GD_FLG_SILENT;
722 int console_announce_r(void)
724 #if !CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
725 char buf[DISPLAY_OPTIONS_BANNER_LENGTH];
727 display_options_get_banner(false, buf, sizeof(buf));
729 console_puts_noserial(stdout, buf);
735 /* Called before relocation - use serial functions */
736 int console_init_f(void)
738 gd->have_console = 1;
740 console_update_silent();
742 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT1_SERIAL);
747 void stdio_print_current_devices(void)
749 /* Print information */
751 if (stdio_devices[stdin] == NULL) {
752 puts("No input devices available!\n");
754 printf ("%s\n", stdio_devices[stdin]->name);
758 if (stdio_devices[stdout] == NULL) {
759 puts("No output devices available!\n");
761 printf ("%s\n", stdio_devices[stdout]->name);
765 if (stdio_devices[stderr] == NULL) {
766 puts("No error devices available!\n");
768 printf ("%s\n", stdio_devices[stderr]->name);
772 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
773 /* Called after the relocation - use desired console functions */
774 int console_init_r(void)
776 char *stdinname, *stdoutname, *stderrname;
777 struct stdio_dev *inputdev = NULL, *outputdev = NULL, *errdev = NULL;
778 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
780 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
781 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
785 /* set default handlers at first */
786 gd->jt->getc = serial_getc;
787 gd->jt->tstc = serial_tstc;
788 gd->jt->putc = serial_putc;
789 gd->jt->puts = serial_puts;
790 gd->jt->printf = serial_printf;
792 /* stdin stdout and stderr are in environment */
794 stdinname = env_get("stdin");
795 stdoutname = env_get("stdout");
796 stderrname = env_get("stderr");
798 if (OVERWRITE_CONSOLE == 0) { /* if not overwritten by config switch */
799 inputdev = search_device(DEV_FLAGS_INPUT, stdinname);
800 outputdev = search_device(DEV_FLAGS_OUTPUT, stdoutname);
801 errdev = search_device(DEV_FLAGS_OUTPUT, stderrname);
802 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
803 iomux_err = iomux_doenv(stdin, stdinname);
804 iomux_err += iomux_doenv(stdout, stdoutname);
805 iomux_err += iomux_doenv(stderr, stderrname);
807 /* Successful, so skip all the code below. */
811 /* if the devices are overwritten or not found, use default device */
812 if (inputdev == NULL) {
813 inputdev = search_device(DEV_FLAGS_INPUT, "serial");
815 if (outputdev == NULL) {
816 outputdev = search_device(DEV_FLAGS_OUTPUT, "serial");
818 if (errdev == NULL) {
819 errdev = search_device(DEV_FLAGS_OUTPUT, "serial");
821 /* Initializes output console first */
822 if (outputdev != NULL) {
823 /* need to set a console if not done above. */
824 console_doenv(stdout, outputdev);
826 if (errdev != NULL) {
827 /* need to set a console if not done above. */
828 console_doenv(stderr, errdev);
830 if (inputdev != NULL) {
831 /* need to set a console if not done above. */
832 console_doenv(stdin, inputdev);
835 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
839 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
840 stdio_print_current_devices();
841 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
842 #ifdef CONFIG_VIDCONSOLE_AS_LCD
843 if (strstr(stdoutname, "lcd"))
844 printf("Warning: Please change 'lcd' to 'vidconsole' in stdout/stderr environment vars\n");
847 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
848 /* set the environment variables (will overwrite previous env settings) */
849 for (i = 0; i < MAX_FILES; i++) {
850 env_set(stdio_names[i], stdio_devices[i]->name);
852 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
854 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
857 /* If nothing usable installed, use only the initial console */
858 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
861 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL);
865 #else /* !CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */
867 /* Called after the relocation - use desired console functions */
868 int console_init_r(void)
870 struct stdio_dev *inputdev = NULL, *outputdev = NULL;
872 struct list_head *list = stdio_get_list();
873 struct list_head *pos;
874 struct stdio_dev *dev;
876 console_update_silent();
878 #ifdef CONFIG_SPLASH_SCREEN
880 * suppress all output if splash screen is enabled and we have
881 * a bmp to display. We redirect the output from frame buffer
882 * console to serial console in this case or suppress it if
883 * "silent" mode was requested.
885 if (env_get("splashimage") != NULL) {
886 if (!(gd->flags & GD_FLG_SILENT))
887 outputdev = search_device (DEV_FLAGS_OUTPUT, "serial");
891 /* Scan devices looking for input and output devices */
892 list_for_each(pos, list) {
893 dev = list_entry(pos, struct stdio_dev, list);
895 if ((dev->flags & DEV_FLAGS_INPUT) && (inputdev == NULL)) {
898 if ((dev->flags & DEV_FLAGS_OUTPUT) && (outputdev == NULL)) {
901 if(inputdev && outputdev)
905 /* Initializes output console first */
906 if (outputdev != NULL) {
907 console_setfile(stdout, outputdev);
908 console_setfile(stderr, outputdev);
909 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
910 console_devices[stdout][0] = outputdev;
911 console_devices[stderr][0] = outputdev;
915 /* Initializes input console */
916 if (inputdev != NULL) {
917 console_setfile(stdin, inputdev);
918 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
919 console_devices[stdin][0] = inputdev;
923 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
924 stdio_print_current_devices();
925 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
927 /* Setting environment variables */
928 for (i = 0; i < MAX_FILES; i++) {
929 env_set(stdio_names[i], stdio_devices[i]->name);
932 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
935 /* If nothing usable installed, use only the initial console */
936 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
939 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL);
943 #endif /* CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */