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 static inline void console_doenv(int file, struct stdio_dev *dev)
257 iomux_doenv(file, dev->name);
260 static inline int console_getc(int file)
262 return stdio_devices[file]->getc(stdio_devices[file]);
265 static inline int console_tstc(int file)
267 return stdio_devices[file]->tstc(stdio_devices[file]);
270 static inline void console_putc(int file, const char c)
272 stdio_devices[file]->putc(stdio_devices[file], c);
275 static inline void console_puts_noserial(int file, const char *s)
277 if (!console_dev_is_serial(stdio_devices[file]))
278 stdio_devices[file]->puts(stdio_devices[file], s);
281 static inline void console_puts(int file, const char *s)
283 stdio_devices[file]->puts(stdio_devices[file], s);
286 static inline void console_doenv(int file, struct stdio_dev *dev)
288 console_setfile(file, dev);
290 #endif /* CONIFIG_IS_ENABLED(CONSOLE_MUX) */
292 /** U-Boot INITIAL CONSOLE-NOT COMPATIBLE FUNCTIONS *************************/
294 int serial_printf(const char *fmt, ...)
298 char printbuffer[CONFIG_SYS_PBSIZE];
302 /* For this to work, printbuffer must be larger than
303 * anything we ever want to print.
305 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
308 serial_puts(printbuffer);
314 if (file < MAX_FILES) {
316 * Effectively poll for input wherever it may be available.
320 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
322 * Upper layer may have already called tstc() so
323 * check for that first.
326 return console_getc(file);
329 if (console_tstc(file))
330 return console_getc(file);
332 #ifdef CONFIG_WATCHDOG
334 * If the watchdog must be rate-limited then it should
335 * already be handled in board-specific code.
347 if (file < MAX_FILES)
348 return console_tstc(file);
353 void fputc(int file, const char c)
355 if (file < MAX_FILES)
356 console_putc(file, c);
359 void fputs(int file, const char *s)
361 if (file < MAX_FILES)
362 console_puts(file, s);
365 int fprintf(int file, const char *fmt, ...)
369 char printbuffer[CONFIG_SYS_PBSIZE];
373 /* For this to work, printbuffer must be larger than
374 * anything we ever want to print.
376 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
379 /* Send to desired file */
380 fputs(file, printbuffer);
384 /** U-Boot INITIAL CONSOLE-COMPATIBLE FUNCTION *****************************/
388 #ifdef CONFIG_DISABLE_CONSOLE
389 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
393 if (!gd->have_console)
396 #ifdef CONFIG_CONSOLE_RECORD
397 if (gd->console_in.start) {
400 ch = membuff_getbyte(&gd->console_in);
405 if (gd->flags & GD_FLG_DEVINIT) {
406 /* Get from the standard input */
410 /* Send directly to the handler */
411 return serial_getc();
416 #ifdef CONFIG_DISABLE_CONSOLE
417 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
421 if (!gd->have_console)
423 #ifdef CONFIG_CONSOLE_RECORD
424 if (gd->console_in.start) {
425 if (membuff_peekbyte(&gd->console_in) != -1)
429 if (gd->flags & GD_FLG_DEVINIT) {
430 /* Test the standard input */
434 /* Send directly to the handler */
435 return serial_tstc();
438 #define PRE_CONSOLE_FLUSHPOINT1_SERIAL 0
439 #define PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL 1
441 #if CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
442 #define CIRC_BUF_IDX(idx) ((idx) % (unsigned long)CONFIG_PRE_CON_BUF_SZ)
444 static void pre_console_putc(const char c)
448 buffer = map_sysmem(CONFIG_PRE_CON_BUF_ADDR, CONFIG_PRE_CON_BUF_SZ);
450 buffer[CIRC_BUF_IDX(gd->precon_buf_idx++)] = c;
452 unmap_sysmem(buffer);
455 static void pre_console_puts(const char *s)
458 pre_console_putc(*s++);
461 static void print_pre_console_buffer(int flushpoint)
463 unsigned long in = 0, out = 0;
464 char buf_out[CONFIG_PRE_CON_BUF_SZ + 1];
467 #ifdef CONFIG_SILENT_CONSOLE
468 if (gd->flags & GD_FLG_SILENT)
472 buf_in = map_sysmem(CONFIG_PRE_CON_BUF_ADDR, CONFIG_PRE_CON_BUF_SZ);
473 if (gd->precon_buf_idx > CONFIG_PRE_CON_BUF_SZ)
474 in = gd->precon_buf_idx - CONFIG_PRE_CON_BUF_SZ;
476 while (in < gd->precon_buf_idx)
477 buf_out[out++] = buf_in[CIRC_BUF_IDX(in++)];
478 unmap_sysmem(buf_in);
482 switch (flushpoint) {
483 case PRE_CONSOLE_FLUSHPOINT1_SERIAL:
486 case PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL:
487 console_puts_noserial(stdout, buf_out);
492 static inline void pre_console_putc(const char c) {}
493 static inline void pre_console_puts(const char *s) {}
494 static inline void print_pre_console_buffer(int flushpoint) {}
497 void putc(const char c)
499 #ifdef CONFIG_SANDBOX
500 /* sandbox can send characters to stdout before it has a console */
501 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
506 #ifdef CONFIG_DEBUG_UART
507 /* if we don't have a console yet, use the debug UART */
508 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
515 #ifdef CONFIG_CONSOLE_RECORD
516 if ((gd->flags & GD_FLG_RECORD) && gd->console_out.start)
517 membuff_putbyte(&gd->console_out, c);
519 #ifdef CONFIG_SILENT_CONSOLE
520 if (gd->flags & GD_FLG_SILENT) {
521 if (!(gd->flags & GD_FLG_DEVINIT))
527 #ifdef CONFIG_DISABLE_CONSOLE
528 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
532 if (!gd->have_console)
533 return pre_console_putc(c);
535 if (gd->flags & GD_FLG_DEVINIT) {
536 /* Send to the standard output */
539 /* Send directly to the handler */
545 void puts(const char *s)
547 #ifdef CONFIG_SANDBOX
548 /* sandbox can send characters to stdout before it has a console */
549 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
554 #ifdef CONFIG_DEBUG_UART
555 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
566 #ifdef CONFIG_CONSOLE_RECORD
567 if ((gd->flags & GD_FLG_RECORD) && gd->console_out.start)
568 membuff_put(&gd->console_out, s, strlen(s));
570 #ifdef CONFIG_SILENT_CONSOLE
571 if (gd->flags & GD_FLG_SILENT) {
572 if (!(gd->flags & GD_FLG_DEVINIT))
578 #ifdef CONFIG_DISABLE_CONSOLE
579 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
583 if (!gd->have_console)
584 return pre_console_puts(s);
586 if (gd->flags & GD_FLG_DEVINIT) {
587 /* Send to the standard output */
590 /* Send directly to the handler */
596 #ifdef CONFIG_CONSOLE_RECORD
597 int console_record_init(void)
601 ret = membuff_new(&gd->console_out, CONFIG_CONSOLE_RECORD_OUT_SIZE);
604 ret = membuff_new(&gd->console_in, CONFIG_CONSOLE_RECORD_IN_SIZE);
609 void console_record_reset(void)
611 membuff_purge(&gd->console_out);
612 membuff_purge(&gd->console_in);
615 void console_record_reset_enable(void)
617 console_record_reset();
618 gd->flags |= GD_FLG_RECORD;
622 /* test if ctrl-c was pressed */
623 static int ctrlc_disabled = 0; /* see disable_ctrl() */
624 static int ctrlc_was_pressed = 0;
627 if (!ctrlc_disabled && gd->have_console) {
630 case 0x03: /* ^C - Control C */
631 ctrlc_was_pressed = 1;
641 /* Reads user's confirmation.
642 Returns 1 if user's input is "y", "Y", "yes" or "YES"
644 int confirm_yesno(void)
653 while (i < sizeof(str_input)) {
654 str_input[i] = getc();
656 if (str_input[i] == '\r')
661 if (strncmp(str_input, "y\r", 2) == 0 ||
662 strncmp(str_input, "Y\r", 2) == 0 ||
663 strncmp(str_input, "yes\r", 4) == 0 ||
664 strncmp(str_input, "YES\r", 4) == 0)
668 /* pass 1 to disable ctrlc() checking, 0 to enable.
669 * returns previous state
671 int disable_ctrlc(int disable)
673 int prev = ctrlc_disabled; /* save previous state */
675 ctrlc_disabled = disable;
681 return ctrlc_was_pressed;
684 void clear_ctrlc(void)
686 ctrlc_was_pressed = 0;
689 /** U-Boot INIT FUNCTIONS *************************************************/
691 struct stdio_dev *search_device(int flags, const char *name)
693 struct stdio_dev *dev;
695 dev = stdio_get_by_name(name);
696 #ifdef CONFIG_VIDCONSOLE_AS_LCD
697 if (!dev && !strcmp(name, "lcd"))
698 dev = stdio_get_by_name("vidconsole");
701 if (dev && (dev->flags & flags))
707 int console_assign(int file, const char *devname)
710 struct stdio_dev *dev;
712 /* Check for valid file */
715 flag = DEV_FLAGS_INPUT;
719 flag = DEV_FLAGS_OUTPUT;
725 /* Check for valid device name */
727 dev = search_device(flag, devname);
730 return console_setfile(file, dev);
735 /* return true if the 'silent' flag is removed */
736 static bool console_update_silent(void)
738 #ifdef CONFIG_SILENT_CONSOLE
739 if (env_get("silent")) {
740 gd->flags |= GD_FLG_SILENT;
742 unsigned long flags = gd->flags;
744 gd->flags &= ~GD_FLG_SILENT;
746 return !!(flags & GD_FLG_SILENT);
753 int console_announce_r(void)
755 #if !CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
756 char buf[DISPLAY_OPTIONS_BANNER_LENGTH];
758 display_options_get_banner(false, buf, sizeof(buf));
760 console_puts_noserial(stdout, buf);
766 /* Called before relocation - use serial functions */
767 int console_init_f(void)
769 gd->have_console = 1;
771 console_update_silent();
773 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT1_SERIAL);
778 void stdio_print_current_devices(void)
780 /* Print information */
782 if (stdio_devices[stdin] == NULL) {
783 puts("No input devices available!\n");
785 printf ("%s\n", stdio_devices[stdin]->name);
789 if (stdio_devices[stdout] == NULL) {
790 puts("No output devices available!\n");
792 printf ("%s\n", stdio_devices[stdout]->name);
796 if (stdio_devices[stderr] == NULL) {
797 puts("No error devices available!\n");
799 printf ("%s\n", stdio_devices[stderr]->name);
803 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
804 /* Called after the relocation - use desired console functions */
805 int console_init_r(void)
807 char *stdinname, *stdoutname, *stderrname;
808 struct stdio_dev *inputdev = NULL, *outputdev = NULL, *errdev = NULL;
809 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
811 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
812 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
817 /* update silent for env loaded from flash (initr_env) */
818 if (console_update_silent())
819 flushpoint = PRE_CONSOLE_FLUSHPOINT1_SERIAL;
821 flushpoint = PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL;
823 /* set default handlers at first */
824 gd->jt->getc = serial_getc;
825 gd->jt->tstc = serial_tstc;
826 gd->jt->putc = serial_putc;
827 gd->jt->puts = serial_puts;
828 gd->jt->printf = serial_printf;
830 /* stdin stdout and stderr are in environment */
832 stdinname = env_get("stdin");
833 stdoutname = env_get("stdout");
834 stderrname = env_get("stderr");
836 if (OVERWRITE_CONSOLE == 0) { /* if not overwritten by config switch */
837 inputdev = search_device(DEV_FLAGS_INPUT, stdinname);
838 outputdev = search_device(DEV_FLAGS_OUTPUT, stdoutname);
839 errdev = search_device(DEV_FLAGS_OUTPUT, stderrname);
840 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
841 iomux_err = iomux_doenv(stdin, stdinname);
842 iomux_err += iomux_doenv(stdout, stdoutname);
843 iomux_err += iomux_doenv(stderr, stderrname);
845 /* Successful, so skip all the code below. */
849 /* if the devices are overwritten or not found, use default device */
850 if (inputdev == NULL) {
851 inputdev = search_device(DEV_FLAGS_INPUT, "serial");
853 if (outputdev == NULL) {
854 outputdev = search_device(DEV_FLAGS_OUTPUT, "serial");
856 if (errdev == NULL) {
857 errdev = search_device(DEV_FLAGS_OUTPUT, "serial");
859 /* Initializes output console first */
860 if (outputdev != NULL) {
861 /* need to set a console if not done above. */
862 console_doenv(stdout, outputdev);
864 if (errdev != NULL) {
865 /* need to set a console if not done above. */
866 console_doenv(stderr, errdev);
868 if (inputdev != NULL) {
869 /* need to set a console if not done above. */
870 console_doenv(stdin, inputdev);
873 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
877 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
878 stdio_print_current_devices();
879 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
880 #ifdef CONFIG_VIDCONSOLE_AS_LCD
881 if (strstr(stdoutname, "lcd"))
882 printf("Warning: Please change 'lcd' to 'vidconsole' in stdout/stderr environment vars\n");
885 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
886 /* set the environment variables (will overwrite previous env settings) */
887 for (i = 0; i < MAX_FILES; i++) {
888 env_set(stdio_names[i], stdio_devices[i]->name);
890 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
892 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
895 /* If nothing usable installed, use only the initial console */
896 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
899 print_pre_console_buffer(flushpoint);
903 #else /* !CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */
905 /* Called after the relocation - use desired console functions */
906 int console_init_r(void)
908 struct stdio_dev *inputdev = NULL, *outputdev = NULL;
910 struct list_head *list = stdio_get_list();
911 struct list_head *pos;
912 struct stdio_dev *dev;
915 /* update silent for env loaded from flash (initr_env) */
916 if (console_update_silent())
917 flushpoint = PRE_CONSOLE_FLUSHPOINT1_SERIAL;
919 flushpoint = PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL;
921 #ifdef CONFIG_SPLASH_SCREEN
923 * suppress all output if splash screen is enabled and we have
924 * a bmp to display. We redirect the output from frame buffer
925 * console to serial console in this case or suppress it if
926 * "silent" mode was requested.
928 if (env_get("splashimage") != NULL) {
929 if (!(gd->flags & GD_FLG_SILENT))
930 outputdev = search_device (DEV_FLAGS_OUTPUT, "serial");
934 /* Scan devices looking for input and output devices */
935 list_for_each(pos, list) {
936 dev = list_entry(pos, struct stdio_dev, list);
938 if ((dev->flags & DEV_FLAGS_INPUT) && (inputdev == NULL)) {
941 if ((dev->flags & DEV_FLAGS_OUTPUT) && (outputdev == NULL)) {
944 if(inputdev && outputdev)
948 /* Initializes output console first */
949 if (outputdev != NULL) {
950 console_setfile(stdout, outputdev);
951 console_setfile(stderr, outputdev);
952 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
953 console_devices[stdout][0] = outputdev;
954 console_devices[stderr][0] = outputdev;
958 /* Initializes input console */
959 if (inputdev != NULL) {
960 console_setfile(stdin, inputdev);
961 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
962 console_devices[stdin][0] = inputdev;
966 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
967 stdio_print_current_devices();
968 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
970 /* Setting environment variables */
971 for (i = 0; i < MAX_FILES; i++) {
972 env_set(stdio_names[i], stdio_devices[i]->name);
975 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
978 /* If nothing usable installed, use only the initial console */
979 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
982 print_pre_console_buffer(flushpoint);
986 #endif /* CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */