1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3 * (C) Copyright 2000-2009
4 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 */
6
7 #ifndef __CONSOLE_H
8 #define __CONSOLE_H
9
10 #include <stdbool.h>
11 #include <stdio_dev.h>
12 #include <linux/errno.h>
13
14 extern char console_buffer[];
15
16 /* common/console.c */
17 int console_init_f(void); /* Before relocation; uses the serial stuff */
18 int console_init_r(void); /* After relocation; uses the console stuff */
19 int console_start(int file, struct stdio_dev *sdev); /* Start a console device */
20 void console_stop(int file, struct stdio_dev *sdev); /* Stop a console device */
21 int console_assign(int file, const char *devname); /* Assign the console */
22 int ctrlc(void);
23 int had_ctrlc(void); /* have we had a Control-C since last clear? */
24 void clear_ctrlc(void); /* clear the Control-C condition */
25 int disable_ctrlc(int); /* 1 to disable, 0 to enable Control-C detect */
26 int confirm_yesno(void); /* 1 if input is "y", "Y", "yes" or "YES" */
27
28 /**
29 * console_search_dev() - search for stdio device with given flags and name
30 * @flags: device flags as per input/output/system
31 * @name: device name
32 *
33 * Iterates over registered STDIO devices and match them with given @flags
34 * and @name.
35 *
36 * @return pointer to the &struct stdio_dev if found, or NULL otherwise
37 */
38 struct stdio_dev *console_search_dev(int flags, const char *name);
39
40 #ifdef CONFIG_CONSOLE_RECORD
41 /**
42 * console_record_init() - set up the console recording buffers
43 *
44 * This should be called as soon as malloc() is available so that the maximum
45 * amount of console output can be recorded.
46 *
47 * @return 0 if OK, -ENOMEM if out of memory
48 */
49 int console_record_init(void);
50
51 /**
52 * console_record_reset() - reset the console recording buffers
53 *
54 * Removes any data in the buffers
55 */
56 void console_record_reset(void);
57
58 /**
59 * console_record_reset_enable() - reset and enable the console buffers
60 *
61 * This should be called to enable the console buffer.
62 *
63 * @return 0 (always)
64 */
65 int console_record_reset_enable(void);
66
67 /**
68 * console_record_readline() - Read a line from the console output
69 *
70 * This reads the next available line from the console output previously
71 * recorded.
72 *
73 * @str: Place to put string
74 * @maxlen: Maximum length of @str including nul terminator
75 * @return length of string returned
76 */
77 int console_record_readline(char *str, int maxlen);
78
79 /**
80 * console_record_avail() - Get the number of available bytes in console output
81 *
82 * @return available bytes (0 if empty)
83 */
84 int console_record_avail(void);
85 #else
console_record_init(void)86 static inline int console_record_init(void)
87 {
88 /* Always succeed, since it is not enabled */
89
90 return 0;
91 }
92
console_record_reset(void)93 static inline void console_record_reset(void)
94 {
95 /* Nothing to do here */
96 }
97
console_record_reset_enable(void)98 static inline int console_record_reset_enable(void)
99 {
100 /* Cannot enable it as it is not supported */
101 return -ENOSYS;
102 }
103
console_record_readline(char * str,int maxlen)104 static inline int console_record_readline(char *str, int maxlen)
105 {
106 /* Nothing to read */
107 return 0;
108 }
109
console_record_avail(void)110 static inline int console_record_avail(void)
111 {
112 /* There is never anything available */
113 return 0;
114 }
115
116 #endif /* !CONFIG_CONSOLE_RECORD */
117
118 /**
119 * console_announce_r() - print a U-Boot console on non-serial consoles
120 *
121 * When U-Boot starts up with a display it generally does not announce itself
122 * on the display. The banner is instead emitted on the UART before relocation.
123 * This function prints a banner on devices which (we assume) did not receive
124 * it before relocation.
125 *
126 * @return 0 (meaning no errors)
127 */
128 int console_announce_r(void);
129
130 /**
131 * console_puts_select_stderr() - Output a string to selected console devices
132 *
133 * This writes to stderr only. It is useful for outputting errors
134 *
135 * @serial_only: true to output only to serial, false to output to everything
136 * else
137 * @s: String to output
138 */
139 void console_puts_select_stderr(bool serial_only, const char *s);
140
141 /*
142 * CONSOLE multiplexing.
143 */
144 #ifdef CONFIG_CONSOLE_MUX
145 #include <iomux.h>
146 #endif
147
148 #endif
149