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>
18 #include <stdio_dev.h>
20 #include <env_internal.h>
23 DECLARE_GLOBAL_DATA_PTR;
25 static int on_console(const char *name, const char *value, enum env_op op,
30 /* Check for console redirection */
31 if (strcmp(name, "stdin") == 0)
33 else if (strcmp(name, "stdout") == 0)
35 else if (strcmp(name, "stderr") == 0)
38 /* if not actually setting a console variable, we don't care */
39 if (console == -1 || (gd->flags & GD_FLG_DEVINIT) == 0)
44 case env_op_overwrite:
46 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
47 if (iomux_doenv(console, value))
50 /* Try assigning specified device */
51 if (console_assign(console, value) < 0)
57 if ((flags & H_FORCE) == 0)
58 printf("Can't delete \"%s\"\n", name);
65 U_BOOT_ENV_CALLBACK(console, on_console);
67 #ifdef CONFIG_SILENT_CONSOLE
68 static int on_silent(const char *name, const char *value, enum env_op op,
71 #if !CONFIG_IS_ENABLED(SILENT_CONSOLE_UPDATE_ON_SET)
72 if (flags & H_INTERACTIVE)
75 #if !CONFIG_IS_ENABLED(SILENT_CONSOLE_UPDATE_ON_RELOC)
76 if ((flags & H_INTERACTIVE) == 0)
81 gd->flags |= GD_FLG_SILENT;
83 gd->flags &= ~GD_FLG_SILENT;
87 U_BOOT_ENV_CALLBACK(silent, on_silent);
90 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
92 * if overwrite_console returns 1, the stdin, stderr and stdout
93 * are switched to the serial port, else the settings in the
94 * environment are used
96 #ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
97 extern int overwrite_console(void);
98 #define OVERWRITE_CONSOLE overwrite_console()
100 #define OVERWRITE_CONSOLE 0
101 #endif /* CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE */
103 #endif /* CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */
105 static int console_setfile(int file, struct stdio_dev * dev)
116 /* Start new device */
118 error = dev->start(dev);
119 /* If it's not started dont use it */
124 /* Assign the new device (leaving the existing one started) */
125 stdio_devices[file] = dev;
128 * Update monitor functions
129 * (to use the console stuff by other applications)
139 gd->jt->printf = printf;
144 default: /* Invalid file ID */
151 * console_dev_is_serial() - Check if a stdio device is a serial device
153 * @sdev: Device to check
154 * @return true if this device is in the serial uclass (or for pre-driver-model,
155 * whether it is called "serial".
157 static bool console_dev_is_serial(struct stdio_dev *sdev)
161 #ifdef CONFIG_DM_SERIAL
162 if (sdev->flags & DEV_FLAGS_DM) {
163 struct udevice *dev = sdev->priv;
165 is_serial = device_get_uclass_id(dev) == UCLASS_SERIAL;
168 is_serial = !strcmp(sdev->name, "serial");
173 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
174 /** Console I/O multiplexing *******************************************/
176 static struct stdio_dev *tstcdev;
177 struct stdio_dev **console_devices[MAX_FILES];
178 int cd_count[MAX_FILES];
181 * This depends on tstc() always being called before getc().
182 * This is guaranteed to be true because this routine is called
183 * only from fgetc() which assures it.
184 * No attempt is made to demultiplex multiple input sources.
186 static int console_getc(int file)
190 /* This is never called with testcdev == NULL */
191 ret = tstcdev->getc(tstcdev);
196 static int console_tstc(int file)
199 struct stdio_dev *dev;
202 prev = disable_ctrlc(1);
203 for (i = 0; i < cd_count[file]; i++) {
204 dev = console_devices[file][i];
205 if (dev->tstc != NULL) {
206 ret = dev->tstc(dev);
219 static void console_putc(int file, const char c)
222 struct stdio_dev *dev;
224 for (i = 0; i < cd_count[file]; i++) {
225 dev = console_devices[file][i];
226 if (dev->putc != NULL)
231 static void console_puts_noserial(int file, const char *s)
234 struct stdio_dev *dev;
236 for (i = 0; i < cd_count[file]; i++) {
237 dev = console_devices[file][i];
238 if (dev->puts != NULL && !console_dev_is_serial(dev))
243 static void console_puts(int file, const char *s)
246 struct stdio_dev *dev;
248 for (i = 0; i < cd_count[file]; i++) {
249 dev = console_devices[file][i];
250 if (dev->puts != NULL)
255 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
256 static inline void console_doenv(int file, struct stdio_dev *dev)
258 iomux_doenv(file, dev->name);
262 static inline int console_getc(int file)
264 return stdio_devices[file]->getc(stdio_devices[file]);
267 static inline int console_tstc(int file)
269 return stdio_devices[file]->tstc(stdio_devices[file]);
272 static inline void console_putc(int file, const char c)
274 stdio_devices[file]->putc(stdio_devices[file], c);
277 static inline void console_puts_noserial(int file, const char *s)
279 if (!console_dev_is_serial(stdio_devices[file]))
280 stdio_devices[file]->puts(stdio_devices[file], s);
283 static inline void console_puts(int file, const char *s)
285 stdio_devices[file]->puts(stdio_devices[file], s);
288 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
289 static inline void console_doenv(int file, struct stdio_dev *dev)
291 console_setfile(file, dev);
294 #endif /* CONIFIG_IS_ENABLED(CONSOLE_MUX) */
296 /** U-Boot INITIAL CONSOLE-NOT COMPATIBLE FUNCTIONS *************************/
298 int serial_printf(const char *fmt, ...)
302 char printbuffer[CONFIG_SYS_PBSIZE];
306 /* For this to work, printbuffer must be larger than
307 * anything we ever want to print.
309 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
312 serial_puts(printbuffer);
318 if (file < MAX_FILES) {
320 * Effectively poll for input wherever it may be available.
324 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
326 * Upper layer may have already called tstc() so
327 * check for that first.
330 return console_getc(file);
333 if (console_tstc(file))
334 return console_getc(file);
336 #ifdef CONFIG_WATCHDOG
338 * If the watchdog must be rate-limited then it should
339 * already be handled in board-specific code.
351 if (file < MAX_FILES)
352 return console_tstc(file);
357 void fputc(int file, const char c)
359 if (file < MAX_FILES)
360 console_putc(file, c);
363 void fputs(int file, const char *s)
365 if (file < MAX_FILES)
366 console_puts(file, s);
369 int fprintf(int file, const char *fmt, ...)
373 char printbuffer[CONFIG_SYS_PBSIZE];
377 /* For this to work, printbuffer must be larger than
378 * anything we ever want to print.
380 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
383 /* Send to desired file */
384 fputs(file, printbuffer);
388 /** U-Boot INITIAL CONSOLE-COMPATIBLE FUNCTION *****************************/
392 #ifdef CONFIG_DISABLE_CONSOLE
393 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
397 if (!gd->have_console)
400 #ifdef CONFIG_CONSOLE_RECORD
401 if (gd->console_in.start) {
404 ch = membuff_getbyte((struct membuff *)&gd->console_in);
409 if (gd->flags & GD_FLG_DEVINIT) {
410 /* Get from the standard input */
414 /* Send directly to the handler */
415 return serial_getc();
420 #ifdef CONFIG_DISABLE_CONSOLE
421 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
425 if (!gd->have_console)
427 #ifdef CONFIG_CONSOLE_RECORD
428 if (gd->console_in.start) {
429 if (membuff_peekbyte((struct membuff *)&gd->console_in) != -1)
433 if (gd->flags & GD_FLG_DEVINIT) {
434 /* Test the standard input */
438 /* Send directly to the handler */
439 return serial_tstc();
442 #define PRE_CONSOLE_FLUSHPOINT1_SERIAL 0
443 #define PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL 1
445 #if CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
446 #define CIRC_BUF_IDX(idx) ((idx) % (unsigned long)CONFIG_PRE_CON_BUF_SZ)
448 static void pre_console_putc(const char c)
452 buffer = map_sysmem(CONFIG_PRE_CON_BUF_ADDR, CONFIG_PRE_CON_BUF_SZ);
454 buffer[CIRC_BUF_IDX(gd->precon_buf_idx++)] = c;
456 unmap_sysmem(buffer);
459 static void pre_console_puts(const char *s)
462 pre_console_putc(*s++);
465 static void print_pre_console_buffer(int flushpoint)
467 unsigned long in = 0, out = 0;
468 char buf_out[CONFIG_PRE_CON_BUF_SZ + 1];
471 #ifdef CONFIG_SILENT_CONSOLE
472 if (gd->flags & GD_FLG_SILENT)
476 buf_in = map_sysmem(CONFIG_PRE_CON_BUF_ADDR, CONFIG_PRE_CON_BUF_SZ);
477 if (gd->precon_buf_idx > CONFIG_PRE_CON_BUF_SZ)
478 in = gd->precon_buf_idx - CONFIG_PRE_CON_BUF_SZ;
480 while (in < gd->precon_buf_idx)
481 buf_out[out++] = buf_in[CIRC_BUF_IDX(in++)];
482 unmap_sysmem(buf_in);
486 switch (flushpoint) {
487 case PRE_CONSOLE_FLUSHPOINT1_SERIAL:
490 case PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL:
491 console_puts_noserial(stdout, buf_out);
496 static inline void pre_console_putc(const char c) {}
497 static inline void pre_console_puts(const char *s) {}
498 static inline void print_pre_console_buffer(int flushpoint) {}
501 void putc(const char c)
503 #ifdef CONFIG_SANDBOX
504 /* sandbox can send characters to stdout before it has a console */
505 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
510 #ifdef CONFIG_DEBUG_UART
511 /* if we don't have a console yet, use the debug UART */
512 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
519 #ifdef CONFIG_CONSOLE_RECORD
520 if ((gd->flags & GD_FLG_RECORD) && gd->console_out.start)
521 membuff_putbyte((struct membuff *)&gd->console_out, c);
523 #ifdef CONFIG_SILENT_CONSOLE
524 if (gd->flags & GD_FLG_SILENT) {
525 if (!(gd->flags & GD_FLG_DEVINIT))
531 #ifdef CONFIG_DISABLE_CONSOLE
532 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
536 if (!gd->have_console)
537 return pre_console_putc(c);
539 if (gd->flags & GD_FLG_DEVINIT) {
540 /* Send to the standard output */
543 /* Send directly to the handler */
549 void puts(const char *s)
551 #ifdef CONFIG_SANDBOX
552 /* sandbox can send characters to stdout before it has a console */
553 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
558 #ifdef CONFIG_DEBUG_UART
559 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
570 #ifdef CONFIG_CONSOLE_RECORD
571 if ((gd->flags & GD_FLG_RECORD) && gd->console_out.start)
572 membuff_put((struct membuff *)&gd->console_out, s, strlen(s));
574 #ifdef CONFIG_SILENT_CONSOLE
575 if (gd->flags & GD_FLG_SILENT) {
576 if (!(gd->flags & GD_FLG_DEVINIT))
582 #ifdef CONFIG_DISABLE_CONSOLE
583 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
587 if (!gd->have_console)
588 return pre_console_puts(s);
590 if (gd->flags & GD_FLG_DEVINIT) {
591 /* Send to the standard output */
594 /* Send directly to the handler */
600 #ifdef CONFIG_CONSOLE_RECORD
601 int console_record_init(void)
605 ret = membuff_new((struct membuff *)&gd->console_out,
606 CONFIG_CONSOLE_RECORD_OUT_SIZE);
609 ret = membuff_new((struct membuff *)&gd->console_in,
610 CONFIG_CONSOLE_RECORD_IN_SIZE);
615 void console_record_reset(void)
617 membuff_purge((struct membuff *)&gd->console_out);
618 membuff_purge((struct membuff *)&gd->console_in);
621 void console_record_reset_enable(void)
623 console_record_reset();
624 gd->flags |= GD_FLG_RECORD;
627 int console_record_readline(char *str, int maxlen)
629 return membuff_readline((struct membuff *)&gd->console_out, str,
633 int console_record_avail(void)
635 return membuff_avail((struct membuff *)&gd->console_out);
640 /* test if ctrl-c was pressed */
641 static int ctrlc_disabled = 0; /* see disable_ctrl() */
642 static int ctrlc_was_pressed = 0;
645 if (!ctrlc_disabled && gd->have_console) {
648 case 0x03: /* ^C - Control C */
649 ctrlc_was_pressed = 1;
659 /* Reads user's confirmation.
660 Returns 1 if user's input is "y", "Y", "yes" or "YES"
662 int confirm_yesno(void)
671 while (i < sizeof(str_input)) {
672 str_input[i] = getc();
674 if (str_input[i] == '\r')
679 if (strncmp(str_input, "y\r", 2) == 0 ||
680 strncmp(str_input, "Y\r", 2) == 0 ||
681 strncmp(str_input, "yes\r", 4) == 0 ||
682 strncmp(str_input, "YES\r", 4) == 0)
686 /* pass 1 to disable ctrlc() checking, 0 to enable.
687 * returns previous state
689 int disable_ctrlc(int disable)
691 int prev = ctrlc_disabled; /* save previous state */
693 ctrlc_disabled = disable;
699 return ctrlc_was_pressed;
702 void clear_ctrlc(void)
704 ctrlc_was_pressed = 0;
707 /** U-Boot INIT FUNCTIONS *************************************************/
709 struct stdio_dev *search_device(int flags, const char *name)
711 struct stdio_dev *dev;
713 dev = stdio_get_by_name(name);
714 #ifdef CONFIG_VIDCONSOLE_AS_LCD
715 if (!dev && !strcmp(name, "lcd"))
716 dev = stdio_get_by_name("vidconsole");
719 if (dev && (dev->flags & flags))
725 int console_assign(int file, const char *devname)
728 struct stdio_dev *dev;
730 /* Check for valid file */
733 flag = DEV_FLAGS_INPUT;
737 flag = DEV_FLAGS_OUTPUT;
743 /* Check for valid device name */
745 dev = search_device(flag, devname);
748 return console_setfile(file, dev);
753 /* return true if the 'silent' flag is removed */
754 static bool console_update_silent(void)
756 #ifdef CONFIG_SILENT_CONSOLE
757 if (env_get("silent")) {
758 gd->flags |= GD_FLG_SILENT;
760 unsigned long flags = gd->flags;
762 gd->flags &= ~GD_FLG_SILENT;
764 return !!(flags & GD_FLG_SILENT);
771 int console_announce_r(void)
773 #if !CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
774 char buf[DISPLAY_OPTIONS_BANNER_LENGTH];
776 display_options_get_banner(false, buf, sizeof(buf));
778 console_puts_noserial(stdout, buf);
784 /* Called before relocation - use serial functions */
785 int console_init_f(void)
787 gd->have_console = 1;
789 console_update_silent();
791 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT1_SERIAL);
796 void stdio_print_current_devices(void)
798 /* Print information */
800 if (stdio_devices[stdin] == NULL) {
801 puts("No input devices available!\n");
803 printf ("%s\n", stdio_devices[stdin]->name);
807 if (stdio_devices[stdout] == NULL) {
808 puts("No output devices available!\n");
810 printf ("%s\n", stdio_devices[stdout]->name);
814 if (stdio_devices[stderr] == NULL) {
815 puts("No error devices available!\n");
817 printf ("%s\n", stdio_devices[stderr]->name);
821 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
822 /* Called after the relocation - use desired console functions */
823 int console_init_r(void)
825 char *stdinname, *stdoutname, *stderrname;
826 struct stdio_dev *inputdev = NULL, *outputdev = NULL, *errdev = NULL;
827 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
829 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
830 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
835 /* update silent for env loaded from flash (initr_env) */
836 if (console_update_silent())
837 flushpoint = PRE_CONSOLE_FLUSHPOINT1_SERIAL;
839 flushpoint = PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL;
841 /* set default handlers at first */
842 gd->jt->getc = serial_getc;
843 gd->jt->tstc = serial_tstc;
844 gd->jt->putc = serial_putc;
845 gd->jt->puts = serial_puts;
846 gd->jt->printf = serial_printf;
848 /* stdin stdout and stderr are in environment */
850 stdinname = env_get("stdin");
851 stdoutname = env_get("stdout");
852 stderrname = env_get("stderr");
854 if (OVERWRITE_CONSOLE == 0) { /* if not overwritten by config switch */
855 inputdev = search_device(DEV_FLAGS_INPUT, stdinname);
856 outputdev = search_device(DEV_FLAGS_OUTPUT, stdoutname);
857 errdev = search_device(DEV_FLAGS_OUTPUT, stderrname);
858 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
859 iomux_err = iomux_doenv(stdin, stdinname);
860 iomux_err += iomux_doenv(stdout, stdoutname);
861 iomux_err += iomux_doenv(stderr, stderrname);
863 /* Successful, so skip all the code below. */
867 /* if the devices are overwritten or not found, use default device */
868 if (inputdev == NULL) {
869 inputdev = search_device(DEV_FLAGS_INPUT, "serial");
871 if (outputdev == NULL) {
872 outputdev = search_device(DEV_FLAGS_OUTPUT, "serial");
874 if (errdev == NULL) {
875 errdev = search_device(DEV_FLAGS_OUTPUT, "serial");
877 /* Initializes output console first */
878 if (outputdev != NULL) {
879 /* need to set a console if not done above. */
880 console_doenv(stdout, outputdev);
882 if (errdev != NULL) {
883 /* need to set a console if not done above. */
884 console_doenv(stderr, errdev);
886 if (inputdev != NULL) {
887 /* need to set a console if not done above. */
888 console_doenv(stdin, inputdev);
891 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
895 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
896 stdio_print_current_devices();
897 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
898 #ifdef CONFIG_VIDCONSOLE_AS_LCD
899 if (strstr(stdoutname, "lcd"))
900 printf("Warning: Please change 'lcd' to 'vidconsole' in stdout/stderr environment vars\n");
903 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
904 /* set the environment variables (will overwrite previous env settings) */
905 for (i = 0; i < MAX_FILES; i++) {
906 env_set(stdio_names[i], stdio_devices[i]->name);
908 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
910 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
913 /* If nothing usable installed, use only the initial console */
914 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
917 print_pre_console_buffer(flushpoint);
921 #else /* !CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */
923 /* Called after the relocation - use desired console functions */
924 int console_init_r(void)
926 struct stdio_dev *inputdev = NULL, *outputdev = NULL;
928 struct list_head *list = stdio_get_list();
929 struct list_head *pos;
930 struct stdio_dev *dev;
933 /* update silent for env loaded from flash (initr_env) */
934 if (console_update_silent())
935 flushpoint = PRE_CONSOLE_FLUSHPOINT1_SERIAL;
937 flushpoint = PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL;
939 #ifdef CONFIG_SPLASH_SCREEN
941 * suppress all output if splash screen is enabled and we have
942 * a bmp to display. We redirect the output from frame buffer
943 * console to serial console in this case or suppress it if
944 * "silent" mode was requested.
946 if (env_get("splashimage") != NULL) {
947 if (!(gd->flags & GD_FLG_SILENT))
948 outputdev = search_device (DEV_FLAGS_OUTPUT, "serial");
952 /* Scan devices looking for input and output devices */
953 list_for_each(pos, list) {
954 dev = list_entry(pos, struct stdio_dev, list);
956 if ((dev->flags & DEV_FLAGS_INPUT) && (inputdev == NULL)) {
959 if ((dev->flags & DEV_FLAGS_OUTPUT) && (outputdev == NULL)) {
962 if(inputdev && outputdev)
966 /* Initializes output console first */
967 if (outputdev != NULL) {
968 console_setfile(stdout, outputdev);
969 console_setfile(stderr, outputdev);
970 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
971 console_devices[stdout][0] = outputdev;
972 console_devices[stderr][0] = outputdev;
976 /* Initializes input console */
977 if (inputdev != NULL) {
978 console_setfile(stdin, inputdev);
979 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
980 console_devices[stdin][0] = inputdev;
984 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
985 stdio_print_current_devices();
986 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
988 /* Setting environment variables */
989 for (i = 0; i < MAX_FILES; i++) {
990 env_set(stdio_names[i], stdio_devices[i]->name);
993 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
996 /* If nothing usable installed, use only the initial console */
997 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
1000 print_pre_console_buffer(flushpoint);
1004 #endif /* CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */