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 prev
= disable_ctrlc(1);
202 for (i
= 0; i
< cd_count
[file
]; i
++) {
203 dev
= console_devices
[file
][i
];
204 if (dev
->tstc
!= NULL
) {
205 ret
= dev
->tstc(dev
);
218 static void console_putc(int file
, const char c
)
221 struct stdio_dev
*dev
;
223 for (i
= 0; i
< cd_count
[file
]; i
++) {
224 dev
= console_devices
[file
][i
];
225 if (dev
->putc
!= NULL
)
230 static void console_puts_noserial(int file
, const char *s
)
233 struct stdio_dev
*dev
;
235 for (i
= 0; i
< cd_count
[file
]; i
++) {
236 dev
= console_devices
[file
][i
];
237 if (dev
->puts
!= NULL
&& !console_dev_is_serial(dev
))
242 static void console_puts(int file
, const char *s
)
245 struct stdio_dev
*dev
;
247 for (i
= 0; i
< cd_count
[file
]; i
++) {
248 dev
= console_devices
[file
][i
];
249 if (dev
->puts
!= NULL
)
254 static inline void console_doenv(int file
, struct stdio_dev
*dev
)
256 iomux_doenv(file
, dev
->name
);
259 static inline int console_getc(int file
)
261 return stdio_devices
[file
]->getc(stdio_devices
[file
]);
264 static inline int console_tstc(int file
)
266 return stdio_devices
[file
]->tstc(stdio_devices
[file
]);
269 static inline void console_putc(int file
, const char c
)
271 stdio_devices
[file
]->putc(stdio_devices
[file
], c
);
274 static inline void console_puts_noserial(int file
, const char *s
)
276 if (!console_dev_is_serial(stdio_devices
[file
]))
277 stdio_devices
[file
]->puts(stdio_devices
[file
], s
);
280 static inline void console_puts(int file
, const char *s
)
282 stdio_devices
[file
]->puts(stdio_devices
[file
], s
);
285 static inline void console_doenv(int file
, struct stdio_dev
*dev
)
287 console_setfile(file
, dev
);
289 #endif /* CONIFIG_IS_ENABLED(CONSOLE_MUX) */
291 /** U-Boot INITIAL CONSOLE-NOT COMPATIBLE FUNCTIONS *************************/
293 int serial_printf(const char *fmt
, ...)
297 char printbuffer
[CONFIG_SYS_PBSIZE
];
301 /* For this to work, printbuffer must be larger than
302 * anything we ever want to print.
304 i
= vscnprintf(printbuffer
, sizeof(printbuffer
), fmt
, args
);
307 serial_puts(printbuffer
);
313 if (file
< MAX_FILES
) {
315 * Effectively poll for input wherever it may be available.
319 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
321 * Upper layer may have already called tstc() so
322 * check for that first.
325 return console_getc(file
);
328 if (console_tstc(file
))
329 return console_getc(file
);
331 #ifdef CONFIG_WATCHDOG
333 * If the watchdog must be rate-limited then it should
334 * already be handled in board-specific code.
346 if (file
< MAX_FILES
)
347 return console_tstc(file
);
352 void fputc(int file
, const char c
)
354 if (file
< MAX_FILES
)
355 console_putc(file
, c
);
358 void fputs(int file
, const char *s
)
360 if (file
< MAX_FILES
)
361 console_puts(file
, s
);
364 int fprintf(int file
, const char *fmt
, ...)
368 char printbuffer
[CONFIG_SYS_PBSIZE
];
372 /* For this to work, printbuffer must be larger than
373 * anything we ever want to print.
375 i
= vscnprintf(printbuffer
, sizeof(printbuffer
), fmt
, args
);
378 /* Send to desired file */
379 fputs(file
, printbuffer
);
383 /** U-Boot INITIAL CONSOLE-COMPATIBLE FUNCTION *****************************/
387 #ifdef CONFIG_DISABLE_CONSOLE
388 if (gd
->flags
& GD_FLG_DISABLE_CONSOLE
)
392 if (!gd
->have_console
)
395 #ifdef CONFIG_CONSOLE_RECORD
396 if (gd
->console_in
.start
) {
399 ch
= membuff_getbyte(&gd
->console_in
);
404 if (gd
->flags
& GD_FLG_DEVINIT
) {
405 /* Get from the standard input */
409 /* Send directly to the handler */
410 return serial_getc();
415 #ifdef CONFIG_DISABLE_CONSOLE
416 if (gd
->flags
& GD_FLG_DISABLE_CONSOLE
)
420 if (!gd
->have_console
)
422 #ifdef CONFIG_CONSOLE_RECORD
423 if (gd
->console_in
.start
) {
424 if (membuff_peekbyte(&gd
->console_in
) != -1)
428 if (gd
->flags
& GD_FLG_DEVINIT
) {
429 /* Test the standard input */
433 /* Send directly to the handler */
434 return serial_tstc();
437 #define PRE_CONSOLE_FLUSHPOINT1_SERIAL 0
438 #define PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL 1
440 #if CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
441 #define CIRC_BUF_IDX(idx) ((idx) % (unsigned long)CONFIG_PRE_CON_BUF_SZ)
443 static void pre_console_putc(const char c
)
447 buffer
= map_sysmem(CONFIG_PRE_CON_BUF_ADDR
, CONFIG_PRE_CON_BUF_SZ
);
449 buffer
[CIRC_BUF_IDX(gd
->precon_buf_idx
++)] = c
;
451 unmap_sysmem(buffer
);
454 static void pre_console_puts(const char *s
)
457 pre_console_putc(*s
++);
460 static void print_pre_console_buffer(int flushpoint
)
462 unsigned long in
= 0, out
= 0;
463 char buf_out
[CONFIG_PRE_CON_BUF_SZ
+ 1];
466 buf_in
= map_sysmem(CONFIG_PRE_CON_BUF_ADDR
, CONFIG_PRE_CON_BUF_SZ
);
467 if (gd
->precon_buf_idx
> CONFIG_PRE_CON_BUF_SZ
)
468 in
= gd
->precon_buf_idx
- CONFIG_PRE_CON_BUF_SZ
;
470 while (in
< gd
->precon_buf_idx
)
471 buf_out
[out
++] = buf_in
[CIRC_BUF_IDX(in
++)];
472 unmap_sysmem(buf_in
);
476 switch (flushpoint
) {
477 case PRE_CONSOLE_FLUSHPOINT1_SERIAL
:
480 case PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL
:
481 console_puts_noserial(stdout
, buf_out
);
486 static inline void pre_console_putc(const char c
) {}
487 static inline void pre_console_puts(const char *s
) {}
488 static inline void print_pre_console_buffer(int flushpoint
) {}
491 void putc(const char c
)
493 #ifdef CONFIG_SANDBOX
494 /* sandbox can send characters to stdout before it has a console */
495 if (!gd
|| !(gd
->flags
& GD_FLG_SERIAL_READY
)) {
500 #ifdef CONFIG_DEBUG_UART
501 /* if we don't have a console yet, use the debug UART */
502 if (!gd
|| !(gd
->flags
& GD_FLG_SERIAL_READY
)) {
509 #ifdef CONFIG_CONSOLE_RECORD
510 if ((gd
->flags
& GD_FLG_RECORD
) && gd
->console_out
.start
)
511 membuff_putbyte(&gd
->console_out
, c
);
513 #ifdef CONFIG_SILENT_CONSOLE
514 if (gd
->flags
& GD_FLG_SILENT
)
518 #ifdef CONFIG_DISABLE_CONSOLE
519 if (gd
->flags
& GD_FLG_DISABLE_CONSOLE
)
523 if (!gd
->have_console
)
524 return pre_console_putc(c
);
526 if (gd
->flags
& GD_FLG_DEVINIT
) {
527 /* Send to the standard output */
530 /* Send directly to the handler */
536 void puts(const char *s
)
538 #ifdef CONFIG_DEBUG_UART
539 if (!gd
|| !(gd
->flags
& GD_FLG_SERIAL_READY
)) {
550 #ifdef CONFIG_CONSOLE_RECORD
551 if ((gd
->flags
& GD_FLG_RECORD
) && gd
->console_out
.start
)
552 membuff_put(&gd
->console_out
, s
, strlen(s
));
554 #ifdef CONFIG_SILENT_CONSOLE
555 if (gd
->flags
& GD_FLG_SILENT
)
559 #ifdef CONFIG_DISABLE_CONSOLE
560 if (gd
->flags
& GD_FLG_DISABLE_CONSOLE
)
564 if (!gd
->have_console
)
565 return pre_console_puts(s
);
567 if (gd
->flags
& GD_FLG_DEVINIT
) {
568 /* Send to the standard output */
571 /* Send directly to the handler */
577 #ifdef CONFIG_CONSOLE_RECORD
578 int console_record_init(void)
582 ret
= membuff_new(&gd
->console_out
, CONFIG_CONSOLE_RECORD_OUT_SIZE
);
585 ret
= membuff_new(&gd
->console_in
, CONFIG_CONSOLE_RECORD_IN_SIZE
);
590 void console_record_reset(void)
592 membuff_purge(&gd
->console_out
);
593 membuff_purge(&gd
->console_in
);
596 void console_record_reset_enable(void)
598 console_record_reset();
599 gd
->flags
|= GD_FLG_RECORD
;
603 /* test if ctrl-c was pressed */
604 static int ctrlc_disabled
= 0; /* see disable_ctrl() */
605 static int ctrlc_was_pressed
= 0;
608 if (!ctrlc_disabled
&& gd
->have_console
) {
611 case 0x03: /* ^C - Control C */
612 ctrlc_was_pressed
= 1;
622 /* Reads user's confirmation.
623 Returns 1 if user's input is "y", "Y", "yes" or "YES"
625 int confirm_yesno(void)
634 while (i
< sizeof(str_input
)) {
635 str_input
[i
] = getc();
637 if (str_input
[i
] == '\r')
642 if (strncmp(str_input
, "y\r", 2) == 0 ||
643 strncmp(str_input
, "Y\r", 2) == 0 ||
644 strncmp(str_input
, "yes\r", 4) == 0 ||
645 strncmp(str_input
, "YES\r", 4) == 0)
649 /* pass 1 to disable ctrlc() checking, 0 to enable.
650 * returns previous state
652 int disable_ctrlc(int disable
)
654 int prev
= ctrlc_disabled
; /* save previous state */
656 ctrlc_disabled
= disable
;
662 return ctrlc_was_pressed
;
665 void clear_ctrlc(void)
667 ctrlc_was_pressed
= 0;
670 /** U-Boot INIT FUNCTIONS *************************************************/
672 struct stdio_dev
*search_device(int flags
, const char *name
)
674 struct stdio_dev
*dev
;
676 dev
= stdio_get_by_name(name
);
677 #ifdef CONFIG_VIDCONSOLE_AS_LCD
678 if (!dev
&& !strcmp(name
, "lcd"))
679 dev
= stdio_get_by_name("vidconsole");
682 if (dev
&& (dev
->flags
& flags
))
688 int console_assign(int file
, const char *devname
)
691 struct stdio_dev
*dev
;
693 /* Check for valid file */
696 flag
= DEV_FLAGS_INPUT
;
700 flag
= DEV_FLAGS_OUTPUT
;
706 /* Check for valid device name */
708 dev
= search_device(flag
, devname
);
711 return console_setfile(file
, dev
);
716 static void console_update_silent(void)
718 #ifdef CONFIG_SILENT_CONSOLE
719 if (env_get("silent") != NULL
)
720 gd
->flags
|= GD_FLG_SILENT
;
722 gd
->flags
&= ~GD_FLG_SILENT
;
726 int console_announce_r(void)
728 #if !CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
729 char buf
[DISPLAY_OPTIONS_BANNER_LENGTH
];
731 display_options_get_banner(false, buf
, sizeof(buf
));
733 console_puts_noserial(stdout
, buf
);
739 /* Called before relocation - use serial functions */
740 int console_init_f(void)
742 gd
->have_console
= 1;
744 console_update_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 #if CONFIG_IS_ENABLED(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 #if CONFIG_IS_ENABLED(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
= env_get("stdin");
799 stdoutname
= env_get("stdout");
800 stderrname
= env_get("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 #if CONFIG_IS_ENABLED(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 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
843 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
844 stdio_print_current_devices();
845 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
846 #ifdef CONFIG_VIDCONSOLE_AS_LCD
847 if (strstr(stdoutname
, "lcd"))
848 printf("Warning: Please change 'lcd' to 'vidconsole' in stdout/stderr environment vars\n");
851 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
852 /* set the environment variables (will overwrite previous env settings) */
853 for (i
= 0; i
< MAX_FILES
; i
++) {
854 env_set(stdio_names
[i
], stdio_devices
[i
]->name
);
856 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
858 gd
->flags
|= GD_FLG_DEVINIT
; /* device initialization completed */
861 /* If nothing usable installed, use only the initial console */
862 if ((stdio_devices
[stdin
] == NULL
) && (stdio_devices
[stdout
] == NULL
))
865 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL
);
869 #else /* !CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */
871 /* Called after the relocation - use desired console functions */
872 int console_init_r(void)
874 struct stdio_dev
*inputdev
= NULL
, *outputdev
= NULL
;
876 struct list_head
*list
= stdio_get_list();
877 struct list_head
*pos
;
878 struct stdio_dev
*dev
;
880 console_update_silent();
882 #ifdef CONFIG_SPLASH_SCREEN
884 * suppress all output if splash screen is enabled and we have
885 * a bmp to display. We redirect the output from frame buffer
886 * console to serial console in this case or suppress it if
887 * "silent" mode was requested.
889 if (env_get("splashimage") != NULL
) {
890 if (!(gd
->flags
& GD_FLG_SILENT
))
891 outputdev
= search_device (DEV_FLAGS_OUTPUT
, "serial");
895 /* Scan devices looking for input and output devices */
896 list_for_each(pos
, list
) {
897 dev
= list_entry(pos
, struct stdio_dev
, list
);
899 if ((dev
->flags
& DEV_FLAGS_INPUT
) && (inputdev
== NULL
)) {
902 if ((dev
->flags
& DEV_FLAGS_OUTPUT
) && (outputdev
== NULL
)) {
905 if(inputdev
&& outputdev
)
909 /* Initializes output console first */
910 if (outputdev
!= NULL
) {
911 console_setfile(stdout
, outputdev
);
912 console_setfile(stderr
, outputdev
);
913 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
914 console_devices
[stdout
][0] = outputdev
;
915 console_devices
[stderr
][0] = outputdev
;
919 /* Initializes input console */
920 if (inputdev
!= NULL
) {
921 console_setfile(stdin
, inputdev
);
922 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
923 console_devices
[stdin
][0] = inputdev
;
927 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
928 stdio_print_current_devices();
929 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
931 /* Setting environment variables */
932 for (i
= 0; i
< MAX_FILES
; i
++) {
933 env_set(stdio_names
[i
], stdio_devices
[i
]->name
);
936 gd
->flags
|= GD_FLG_DEVINIT
; /* device initialization completed */
939 /* If nothing usable installed, use only the initial console */
940 if ((stdio_devices
[stdin
] == NULL
) && (stdio_devices
[stdout
] == NULL
))
943 print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL
);
947 #endif /* CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */