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 int printf(const char *fmt
, ...)
565 char printbuffer
[CONFIG_SYS_PBSIZE
];
569 /* For this to work, printbuffer must be larger than
570 * anything we ever want to print.
572 i
= vscnprintf(printbuffer
, sizeof(printbuffer
), fmt
, args
);
575 /* Print the string */
580 int vprintf(const char *fmt
, va_list args
)
583 char printbuffer
[CONFIG_SYS_PBSIZE
];
585 /* For this to work, printbuffer must be larger than
586 * anything we ever want to print.
588 i
= vscnprintf(printbuffer
, sizeof(printbuffer
), fmt
, args
);
590 /* Print the string */
595 #ifdef CONFIG_CONSOLE_RECORD
596 int console_record_init(void)
600 ret
= membuff_new(&gd
->console_out
, CONFIG_CONSOLE_RECORD_OUT_SIZE
);
603 ret
= membuff_new(&gd
->console_in
, CONFIG_CONSOLE_RECORD_IN_SIZE
);
608 void console_record_reset(void)
610 membuff_purge(&gd
->console_out
);
611 membuff_purge(&gd
->console_in
);
614 void console_record_reset_enable(void)
616 console_record_reset();
617 gd
->flags
|= GD_FLG_RECORD
;
621 /* test if ctrl-c was pressed */
622 static int ctrlc_disabled
= 0; /* see disable_ctrl() */
623 static int ctrlc_was_pressed
= 0;
626 #ifndef CONFIG_SANDBOX
627 if (!ctrlc_disabled
&& gd
->have_console
) {
630 case 0x03: /* ^C - Control C */
631 ctrlc_was_pressed
= 1;
642 /* Reads user's confirmation.
643 Returns 1 if user's input is "y", "Y", "yes" or "YES"
645 int confirm_yesno(void)
654 while (i
< sizeof(str_input
)) {
655 str_input
[i
] = getc();
657 if (str_input
[i
] == '\r')
662 if (strncmp(str_input
, "y\r", 2) == 0 ||
663 strncmp(str_input
, "Y\r", 2) == 0 ||
664 strncmp(str_input
, "yes\r", 4) == 0 ||
665 strncmp(str_input
, "YES\r", 4) == 0)
669 /* pass 1 to disable ctrlc() checking, 0 to enable.
670 * returns previous state
672 int disable_ctrlc(int disable
)
674 int prev
= ctrlc_disabled
; /* save previous state */
676 ctrlc_disabled
= disable
;
682 return ctrlc_was_pressed
;
685 void clear_ctrlc(void)
687 ctrlc_was_pressed
= 0;
690 #ifdef CONFIG_MODEM_SUPPORT_DEBUG
692 char *cursor
= screen
;
694 inline void dbg(const char *fmt
, ...)
698 char printbuffer
[CONFIG_SYS_PBSIZE
];
701 memset(screen
, 0, sizeof(screen
));
707 /* For this to work, printbuffer must be larger than
708 * anything we ever want to print.
710 i
= vsnprintf(printbuffer
, sizeof(printbuffer
), fmt
, args
);
713 if ((screen
+ sizeof(screen
) - 1 - cursor
)
714 < strlen(printbuffer
) + 1) {
715 memset(screen
, 0, sizeof(screen
));
718 sprintf(cursor
, printbuffer
);
719 cursor
+= strlen(printbuffer
);
723 static inline void dbg(const char *fmt
, ...)
728 /** U-Boot INIT FUNCTIONS *************************************************/
730 struct stdio_dev
*search_device(int flags
, const char *name
)
732 struct stdio_dev
*dev
;
734 dev
= stdio_get_by_name(name
);
736 if (dev
&& (dev
->flags
& flags
))
742 int console_assign(int file
, const char *devname
)
745 struct stdio_dev
*dev
;
747 /* Check for valid file */
750 flag
= DEV_FLAGS_INPUT
;
754 flag
= DEV_FLAGS_OUTPUT
;
760 /* Check for valid device name */
762 dev
= search_device(flag
, devname
);
765 return console_setfile(file
, dev
);
770 /* Called before relocation - use serial functions */
771 int console_init_f(void)
773 gd
->have_console
= 1;
775 #ifdef CONFIG_SILENT_CONSOLE
776 if (getenv("silent") != NULL
)
777 gd
->flags
|= GD_FLG_SILENT
;
780 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT1_SERIAL
);
785 void stdio_print_current_devices(void)
787 /* Print information */
789 if (stdio_devices
[stdin
] == NULL
) {
790 puts("No input devices available!\n");
792 printf ("%s\n", stdio_devices
[stdin
]->name
);
796 if (stdio_devices
[stdout
] == NULL
) {
797 puts("No output devices available!\n");
799 printf ("%s\n", stdio_devices
[stdout
]->name
);
803 if (stdio_devices
[stderr
] == NULL
) {
804 puts("No error devices available!\n");
806 printf ("%s\n", stdio_devices
[stderr
]->name
);
810 #ifdef CONFIG_SYS_CONSOLE_IS_IN_ENV
811 /* Called after the relocation - use desired console functions */
812 int console_init_r(void)
814 char *stdinname
, *stdoutname
, *stderrname
;
815 struct stdio_dev
*inputdev
= NULL
, *outputdev
= NULL
, *errdev
= NULL
;
816 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
818 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
819 #ifdef CONFIG_CONSOLE_MUX
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
= getenv("stdin");
833 stdoutname
= getenv("stdout");
834 stderrname
= getenv("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 #ifdef CONFIG_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 #ifdef CONFIG_CONSOLE_MUX
877 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
878 stdio_print_current_devices();
879 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
881 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
882 /* set the environment variables (will overwrite previous env settings) */
883 for (i
= 0; i
< 3; i
++) {
884 setenv(stdio_names
[i
], stdio_devices
[i
]->name
);
886 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
888 gd
->flags
|= GD_FLG_DEVINIT
; /* device initialization completed */
891 /* If nothing usable installed, use only the initial console */
892 if ((stdio_devices
[stdin
] == NULL
) && (stdio_devices
[stdout
] == NULL
))
895 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL
);
899 #else /* CONFIG_SYS_CONSOLE_IS_IN_ENV */
901 /* Called after the relocation - use desired console functions */
902 int console_init_r(void)
904 struct stdio_dev
*inputdev
= NULL
, *outputdev
= NULL
;
906 struct list_head
*list
= stdio_get_list();
907 struct list_head
*pos
;
908 struct stdio_dev
*dev
;
910 #ifdef CONFIG_SPLASH_SCREEN
912 * suppress all output if splash screen is enabled and we have
913 * a bmp to display. We redirect the output from frame buffer
914 * console to serial console in this case or suppress it if
915 * "silent" mode was requested.
917 if (getenv("splashimage") != NULL
) {
918 if (!(gd
->flags
& GD_FLG_SILENT
))
919 outputdev
= search_device (DEV_FLAGS_OUTPUT
, "serial");
923 /* Scan devices looking for input and output devices */
924 list_for_each(pos
, list
) {
925 dev
= list_entry(pos
, struct stdio_dev
, list
);
927 if ((dev
->flags
& DEV_FLAGS_INPUT
) && (inputdev
== NULL
)) {
930 if ((dev
->flags
& DEV_FLAGS_OUTPUT
) && (outputdev
== NULL
)) {
933 if(inputdev
&& outputdev
)
937 /* Initializes output console first */
938 if (outputdev
!= NULL
) {
939 console_setfile(stdout
, outputdev
);
940 console_setfile(stderr
, outputdev
);
941 #ifdef CONFIG_CONSOLE_MUX
942 console_devices
[stdout
][0] = outputdev
;
943 console_devices
[stderr
][0] = outputdev
;
947 /* Initializes input console */
948 if (inputdev
!= NULL
) {
949 console_setfile(stdin
, inputdev
);
950 #ifdef CONFIG_CONSOLE_MUX
951 console_devices
[stdin
][0] = inputdev
;
955 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
956 stdio_print_current_devices();
957 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
959 /* Setting environment variables */
960 for (i
= 0; i
< 3; i
++) {
961 setenv(stdio_names
[i
], stdio_devices
[i
]->name
);
964 gd
->flags
|= GD_FLG_DEVINIT
; /* device initialization completed */
967 /* If nothing usable installed, use only the initial console */
968 if ((stdio_devices
[stdin
] == NULL
) && (stdio_devices
[stdout
] == NULL
))
971 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL
);
975 #endif /* CONFIG_SYS_CONSOLE_IS_IN_ENV */