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>
16 #include <stdio_dev.h>
18 #include <environment.h>
20 DECLARE_GLOBAL_DATA_PTR;
22 static int on_console(const char *name, const char *value, enum env_op op,
27 /* Check for console redirection */
28 if (strcmp(name, "stdin") == 0)
30 else if (strcmp(name, "stdout") == 0)
32 else if (strcmp(name, "stderr") == 0)
35 /* if not actually setting a console variable, we don't care */
36 if (console == -1 || (gd->flags & GD_FLG_DEVINIT) == 0)
41 case env_op_overwrite:
43 #ifdef CONFIG_CONSOLE_MUX
44 if (iomux_doenv(console, value))
47 /* Try assigning specified device */
48 if (console_assign(console, value) < 0)
50 #endif /* CONFIG_CONSOLE_MUX */
54 if ((flags & H_FORCE) == 0)
55 printf("Can't delete \"%s\"\n", name);
62 U_BOOT_ENV_CALLBACK(console, on_console);
64 #ifdef CONFIG_SILENT_CONSOLE
65 static int on_silent(const char *name, const char *value, enum env_op op,
68 #ifndef CONFIG_SILENT_CONSOLE_UPDATE_ON_SET
69 if (flags & H_INTERACTIVE)
72 #ifndef CONFIG_SILENT_CONSOLE_UPDATE_ON_RELOC
73 if ((flags & H_INTERACTIVE) == 0)
78 gd->flags |= GD_FLG_SILENT;
80 gd->flags &= ~GD_FLG_SILENT;
84 U_BOOT_ENV_CALLBACK(silent, on_silent);
87 #ifdef CONFIG_SYS_CONSOLE_IS_IN_ENV
89 * if overwrite_console returns 1, the stdin, stderr and stdout
90 * are switched to the serial port, else the settings in the
91 * environment are used
93 #ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
94 extern int overwrite_console(void);
95 #define OVERWRITE_CONSOLE overwrite_console()
97 #define OVERWRITE_CONSOLE 0
98 #endif /* CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE */
100 #endif /* CONFIG_SYS_CONSOLE_IS_IN_ENV */
102 static int console_setfile(int file, struct stdio_dev * dev)
113 /* Start new device */
115 error = dev->start(dev);
116 /* If it's not started dont use it */
121 /* Assign the new device (leaving the existing one started) */
122 stdio_devices[file] = dev;
125 * Update monitor functions
126 * (to use the console stuff by other applications)
136 gd->jt->printf = printf;
141 default: /* Invalid file ID */
147 #if defined(CONFIG_CONSOLE_MUX)
148 /** Console I/O multiplexing *******************************************/
150 static struct stdio_dev *tstcdev;
151 struct stdio_dev **console_devices[MAX_FILES];
152 int cd_count[MAX_FILES];
155 * This depends on tstc() always being called before getc().
156 * This is guaranteed to be true because this routine is called
157 * only from fgetc() which assures it.
158 * No attempt is made to demultiplex multiple input sources.
160 static int console_getc(int file)
164 /* This is never called with testcdev == NULL */
165 ret = tstcdev->getc(tstcdev);
170 static int console_tstc(int file)
173 struct stdio_dev *dev;
176 for (i = 0; i < cd_count[file]; i++) {
177 dev = console_devices[file][i];
178 if (dev->tstc != NULL) {
179 ret = dev->tstc(dev);
192 static void console_putc(int file, const char c)
195 struct stdio_dev *dev;
197 for (i = 0; i < cd_count[file]; i++) {
198 dev = console_devices[file][i];
199 if (dev->putc != NULL)
204 #ifdef CONFIG_PRE_CONSOLE_BUFFER
205 static void console_puts_noserial(int file, const char *s)
208 struct stdio_dev *dev;
210 for (i = 0; i < cd_count[file]; i++) {
211 dev = console_devices[file][i];
212 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_printdevs(int file)
232 iomux_printdevs(file);
235 static inline void console_doenv(int file, struct stdio_dev *dev)
237 iomux_doenv(file, dev->name);
240 static inline int console_getc(int file)
242 return stdio_devices[file]->getc(stdio_devices[file]);
245 static inline int console_tstc(int file)
247 return stdio_devices[file]->tstc(stdio_devices[file]);
250 static inline void console_putc(int file, const char c)
252 stdio_devices[file]->putc(stdio_devices[file], c);
255 #ifdef CONFIG_PRE_CONSOLE_BUFFER
256 static inline void console_puts_noserial(int file, const char *s)
258 if (strcmp(stdio_devices[file]->name, "serial") != 0)
259 stdio_devices[file]->puts(stdio_devices[file], s);
263 static inline void console_puts(int file, const char *s)
265 stdio_devices[file]->puts(stdio_devices[file], s);
268 static inline void console_printdevs(int file)
270 printf("%s\n", stdio_devices[file]->name);
273 static inline void console_doenv(int file, struct stdio_dev *dev)
275 console_setfile(file, dev);
277 #endif /* defined(CONFIG_CONSOLE_MUX) */
279 /** U-Boot INITIAL CONSOLE-NOT COMPATIBLE FUNCTIONS *************************/
281 int serial_printf(const char *fmt, ...)
285 char printbuffer[CONFIG_SYS_PBSIZE];
289 /* For this to work, printbuffer must be larger than
290 * anything we ever want to print.
292 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
295 serial_puts(printbuffer);
301 if (file < MAX_FILES) {
302 #if defined(CONFIG_CONSOLE_MUX)
304 * Effectively poll for input wherever it may be available.
308 * Upper layer may have already called tstc() so
309 * check for that first.
312 return console_getc(file);
314 #ifdef CONFIG_WATCHDOG
316 * If the watchdog must be rate-limited then it should
317 * already be handled in board-specific code.
323 return console_getc(file);
332 if (file < MAX_FILES)
333 return console_tstc(file);
338 void fputc(int file, const char c)
340 if (file < MAX_FILES)
341 console_putc(file, c);
344 void fputs(int file, const char *s)
346 if (file < MAX_FILES)
347 console_puts(file, s);
350 int fprintf(int file, const char *fmt, ...)
354 char printbuffer[CONFIG_SYS_PBSIZE];
358 /* For this to work, printbuffer must be larger than
359 * anything we ever want to print.
361 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
364 /* Send to desired file */
365 fputs(file, printbuffer);
369 /** U-Boot INITIAL CONSOLE-COMPATIBLE FUNCTION *****************************/
373 #ifdef CONFIG_DISABLE_CONSOLE
374 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
378 if (!gd->have_console)
381 #ifdef CONFIG_CONSOLE_RECORD
382 if (gd->console_in.start) {
385 ch = membuff_getbyte(&gd->console_in);
390 if (gd->flags & GD_FLG_DEVINIT) {
391 /* Get from the standard input */
395 /* Send directly to the handler */
396 return serial_getc();
401 #ifdef CONFIG_DISABLE_CONSOLE
402 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
406 if (!gd->have_console)
408 #ifdef CONFIG_CONSOLE_RECORD
409 if (gd->console_in.start) {
410 if (membuff_peekbyte(&gd->console_in) != -1)
414 if (gd->flags & GD_FLG_DEVINIT) {
415 /* Test the standard input */
419 /* Send directly to the handler */
420 return serial_tstc();
423 #define PRE_CONSOLE_FLUSHPOINT1_SERIAL 0
424 #define PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL 1
426 #ifdef CONFIG_PRE_CONSOLE_BUFFER
427 #define CIRC_BUF_IDX(idx) ((idx) % (unsigned long)CONFIG_PRE_CON_BUF_SZ)
429 static void pre_console_putc(const char c)
431 char *buffer = (char *)CONFIG_PRE_CON_BUF_ADDR;
433 buffer[CIRC_BUF_IDX(gd->precon_buf_idx++)] = c;
436 static void pre_console_puts(const char *s)
439 pre_console_putc(*s++);
442 static void print_pre_console_buffer(int flushpoint)
444 unsigned long in = 0, out = 0;
445 char *buf_in = (char *)CONFIG_PRE_CON_BUF_ADDR;
446 char buf_out[CONFIG_PRE_CON_BUF_SZ + 1];
448 if (gd->precon_buf_idx > CONFIG_PRE_CON_BUF_SZ)
449 in = gd->precon_buf_idx - CONFIG_PRE_CON_BUF_SZ;
451 while (in < gd->precon_buf_idx)
452 buf_out[out++] = buf_in[CIRC_BUF_IDX(in++)];
456 switch (flushpoint) {
457 case PRE_CONSOLE_FLUSHPOINT1_SERIAL:
460 case PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL:
461 console_puts_noserial(stdout, buf_out);
466 static inline void pre_console_putc(const char c) {}
467 static inline void pre_console_puts(const char *s) {}
468 static inline void print_pre_console_buffer(int flushpoint) {}
471 void putc(const char c)
473 #ifdef CONFIG_SANDBOX
474 /* sandbox can send characters to stdout before it has a console */
475 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
480 #ifdef CONFIG_DEBUG_UART
481 /* if we don't have a console yet, use the debug UART */
482 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
487 #ifdef CONFIG_CONSOLE_RECORD
488 if (gd && (gd->flags & GD_FLG_RECORD) && gd->console_out.start)
489 membuff_putbyte(&gd->console_out, c);
491 #ifdef CONFIG_SILENT_CONSOLE
492 if (gd->flags & GD_FLG_SILENT)
496 #ifdef CONFIG_DISABLE_CONSOLE
497 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
501 if (!gd->have_console)
502 return pre_console_putc(c);
504 if (gd->flags & GD_FLG_DEVINIT) {
505 /* Send to the standard output */
508 /* Send directly to the handler */
514 void puts(const char *s)
516 #ifdef CONFIG_SANDBOX
517 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
522 #ifdef CONFIG_DEBUG_UART
523 if (!gd || !(gd->flags & GD_FLG_SERIAL_READY)) {
534 #ifdef CONFIG_CONSOLE_RECORD
535 if (gd && (gd->flags & GD_FLG_RECORD) && gd->console_out.start)
536 membuff_put(&gd->console_out, s, strlen(s));
538 #ifdef CONFIG_SILENT_CONSOLE
539 if (gd->flags & GD_FLG_SILENT)
543 #ifdef CONFIG_DISABLE_CONSOLE
544 if (gd->flags & GD_FLG_DISABLE_CONSOLE)
548 if (!gd->have_console)
549 return pre_console_puts(s);
551 if (gd->flags & GD_FLG_DEVINIT) {
552 /* Send to the standard output */
555 /* Send directly to the handler */
561 #ifdef CONFIG_CONSOLE_RECORD
562 int console_record_init(void)
566 ret = membuff_new(&gd->console_out, CONFIG_CONSOLE_RECORD_OUT_SIZE);
569 ret = membuff_new(&gd->console_in, CONFIG_CONSOLE_RECORD_IN_SIZE);
574 void console_record_reset(void)
576 membuff_purge(&gd->console_out);
577 membuff_purge(&gd->console_in);
580 void console_record_reset_enable(void)
582 console_record_reset();
583 gd->flags |= GD_FLG_RECORD;
587 /* test if ctrl-c was pressed */
588 static int ctrlc_disabled = 0; /* see disable_ctrl() */
589 static int ctrlc_was_pressed = 0;
592 #ifndef CONFIG_SANDBOX
593 if (!ctrlc_disabled && gd->have_console) {
596 case 0x03: /* ^C - Control C */
597 ctrlc_was_pressed = 1;
608 /* Reads user's confirmation.
609 Returns 1 if user's input is "y", "Y", "yes" or "YES"
611 int confirm_yesno(void)
620 while (i < sizeof(str_input)) {
621 str_input[i] = getc();
623 if (str_input[i] == '\r')
628 if (strncmp(str_input, "y\r", 2) == 0 ||
629 strncmp(str_input, "Y\r", 2) == 0 ||
630 strncmp(str_input, "yes\r", 4) == 0 ||
631 strncmp(str_input, "YES\r", 4) == 0)
635 /* pass 1 to disable ctrlc() checking, 0 to enable.
636 * returns previous state
638 int disable_ctrlc(int disable)
640 int prev = ctrlc_disabled; /* save previous state */
642 ctrlc_disabled = disable;
648 return ctrlc_was_pressed;
651 void clear_ctrlc(void)
653 ctrlc_was_pressed = 0;
656 #ifdef CONFIG_MODEM_SUPPORT_DEBUG
658 char *cursor = screen;
660 inline void dbg(const char *fmt, ...)
664 char printbuffer[CONFIG_SYS_PBSIZE];
667 memset(screen, 0, sizeof(screen));
673 /* For this to work, printbuffer must be larger than
674 * anything we ever want to print.
676 i = vsnprintf(printbuffer, sizeof(printbuffer), fmt, args);
679 if ((screen + sizeof(screen) - 1 - cursor)
680 < strlen(printbuffer) + 1) {
681 memset(screen, 0, sizeof(screen));
684 sprintf(cursor, printbuffer);
685 cursor += strlen(printbuffer);
689 static inline void dbg(const char *fmt, ...)
694 /** U-Boot INIT FUNCTIONS *************************************************/
696 struct stdio_dev *search_device(int flags, const char *name)
698 struct stdio_dev *dev;
700 dev = stdio_get_by_name(name);
702 if (dev && (dev->flags & flags))
708 int console_assign(int file, const char *devname)
711 struct stdio_dev *dev;
713 /* Check for valid file */
716 flag = DEV_FLAGS_INPUT;
720 flag = DEV_FLAGS_OUTPUT;
726 /* Check for valid device name */
728 dev = search_device(flag, devname);
731 return console_setfile(file, dev);
736 /* Called before relocation - use serial functions */
737 int console_init_f(void)
739 gd->have_console = 1;
741 #ifdef CONFIG_SILENT_CONSOLE
742 if (getenv("silent") != NULL)
743 gd->flags |= GD_FLG_SILENT;
746 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT1_SERIAL);
751 void stdio_print_current_devices(void)
753 /* Print information */
755 if (stdio_devices[stdin] == NULL) {
756 puts("No input devices available!\n");
758 printf ("%s\n", stdio_devices[stdin]->name);
762 if (stdio_devices[stdout] == NULL) {
763 puts("No output devices available!\n");
765 printf ("%s\n", stdio_devices[stdout]->name);
769 if (stdio_devices[stderr] == NULL) {
770 puts("No error devices available!\n");
772 printf ("%s\n", stdio_devices[stderr]->name);
776 #ifdef CONFIG_SYS_CONSOLE_IS_IN_ENV
777 /* Called after the relocation - use desired console functions */
778 int console_init_r(void)
780 char *stdinname, *stdoutname, *stderrname;
781 struct stdio_dev *inputdev = NULL, *outputdev = NULL, *errdev = NULL;
782 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
784 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
785 #ifdef CONFIG_CONSOLE_MUX
789 /* set default handlers at first */
790 gd->jt->getc = serial_getc;
791 gd->jt->tstc = serial_tstc;
792 gd->jt->putc = serial_putc;
793 gd->jt->puts = serial_puts;
794 gd->jt->printf = serial_printf;
796 /* stdin stdout and stderr are in environment */
798 stdinname = getenv("stdin");
799 stdoutname = getenv("stdout");
800 stderrname = getenv("stderr");
802 if (OVERWRITE_CONSOLE == 0) { /* if not overwritten by config switch */
803 inputdev = search_device(DEV_FLAGS_INPUT, stdinname);
804 outputdev = search_device(DEV_FLAGS_OUTPUT, stdoutname);
805 errdev = search_device(DEV_FLAGS_OUTPUT, stderrname);
806 #ifdef CONFIG_CONSOLE_MUX
807 iomux_err = iomux_doenv(stdin, stdinname);
808 iomux_err += iomux_doenv(stdout, stdoutname);
809 iomux_err += iomux_doenv(stderr, stderrname);
811 /* Successful, so skip all the code below. */
815 /* if the devices are overwritten or not found, use default device */
816 if (inputdev == NULL) {
817 inputdev = search_device(DEV_FLAGS_INPUT, "serial");
819 if (outputdev == NULL) {
820 outputdev = search_device(DEV_FLAGS_OUTPUT, "serial");
822 if (errdev == NULL) {
823 errdev = search_device(DEV_FLAGS_OUTPUT, "serial");
825 /* Initializes output console first */
826 if (outputdev != NULL) {
827 /* need to set a console if not done above. */
828 console_doenv(stdout, outputdev);
830 if (errdev != NULL) {
831 /* need to set a console if not done above. */
832 console_doenv(stderr, errdev);
834 if (inputdev != NULL) {
835 /* need to set a console if not done above. */
836 console_doenv(stdin, inputdev);
839 #ifdef CONFIG_CONSOLE_MUX
843 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
844 stdio_print_current_devices();
845 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
847 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
848 /* set the environment variables (will overwrite previous env settings) */
849 for (i = 0; i < 3; i++) {
850 setenv(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_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 #ifdef CONFIG_SPLASH_SCREEN
878 * suppress all output if splash screen is enabled and we have
879 * a bmp to display. We redirect the output from frame buffer
880 * console to serial console in this case or suppress it if
881 * "silent" mode was requested.
883 if (getenv("splashimage") != NULL) {
884 if (!(gd->flags & GD_FLG_SILENT))
885 outputdev = search_device (DEV_FLAGS_OUTPUT, "serial");
889 /* Scan devices looking for input and output devices */
890 list_for_each(pos, list) {
891 dev = list_entry(pos, struct stdio_dev, list);
893 if ((dev->flags & DEV_FLAGS_INPUT) && (inputdev == NULL)) {
896 if ((dev->flags & DEV_FLAGS_OUTPUT) && (outputdev == NULL)) {
899 if(inputdev && outputdev)
903 /* Initializes output console first */
904 if (outputdev != NULL) {
905 console_setfile(stdout, outputdev);
906 console_setfile(stderr, outputdev);
907 #ifdef CONFIG_CONSOLE_MUX
908 console_devices[stdout][0] = outputdev;
909 console_devices[stderr][0] = outputdev;
913 /* Initializes input console */
914 if (inputdev != NULL) {
915 console_setfile(stdin, inputdev);
916 #ifdef CONFIG_CONSOLE_MUX
917 console_devices[stdin][0] = inputdev;
921 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
922 stdio_print_current_devices();
923 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
925 /* Setting environment variables */
926 for (i = 0; i < 3; i++) {
927 setenv(stdio_names[i], stdio_devices[i]->name);
930 gd->flags |= GD_FLG_DEVINIT; /* device initialization completed */
933 /* If nothing usable installed, use only the initial console */
934 if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
937 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL);
941 #endif /* CONFIG_SYS_CONSOLE_IS_IN_ENV */