1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * Copyright (c) 2011 The Chromium OS Authors.
4 */
5
6 /*
7 * This provide a test serial port. It provides an emulated serial port where
8 * a test program and read out the serial output and inject serial input for
9 * U-Boot.
10 */
11
12 #include <common.h>
13 #include <console.h>
14 #include <dm.h>
15 #include <fdtdec.h>
16 #include <lcd.h>
17 #include <os.h>
18 #include <serial.h>
19 #include <video.h>
20 #include <linux/compiler.h>
21 #include <asm/state.h>
22
23 DECLARE_GLOBAL_DATA_PTR;
24
25 #if CONFIG_IS_ENABLED(OF_CONTROL)
26
27 /*
28 *
29 * serial_buf: A buffer that holds keyboard characters for the
30 * Sandbox U-Boot.
31 *
32 * invariants:
33 * serial_buf_write == serial_buf_read -> empty buffer
34 * (serial_buf_write + 1) % 16 == serial_buf_read -> full buffer
35 */
36 static char serial_buf[16];
37 static unsigned int serial_buf_write;
38 static unsigned int serial_buf_read;
39
40 struct sandbox_serial_platdata {
41 int colour; /* Text colour to use for output, -1 for none */
42 };
43
44 struct sandbox_serial_priv {
45 bool start_of_line;
46 };
47
48 /**
49 * output_ansi_colour() - Output an ANSI colour code
50 *
51 * @colour: Colour to output (0-7)
52 */
output_ansi_colour(int colour)53 static void output_ansi_colour(int colour)
54 {
55 char ansi_code[] = "\x1b[1;3Xm";
56
57 ansi_code[5] = '0' + colour;
58 os_write(1, ansi_code, sizeof(ansi_code) - 1);
59 }
60
output_ansi_reset(void)61 static void output_ansi_reset(void)
62 {
63 os_write(1, "\x1b[0m", 4);
64 }
65
sandbox_serial_probe(struct udevice * dev)66 static int sandbox_serial_probe(struct udevice *dev)
67 {
68 struct sandbox_state *state = state_get_current();
69 struct sandbox_serial_priv *priv = dev_get_priv(dev);
70
71 if (state->term_raw != STATE_TERM_COOKED)
72 os_tty_raw(0, state->term_raw == STATE_TERM_RAW_WITH_SIGS);
73 priv->start_of_line = 0;
74
75 if (state->term_raw != STATE_TERM_RAW)
76 disable_ctrlc(1);
77
78 return 0;
79 }
80
sandbox_serial_remove(struct udevice * dev)81 static int sandbox_serial_remove(struct udevice *dev)
82 {
83 struct sandbox_serial_platdata *plat = dev->platdata;
84
85 if (plat->colour != -1)
86 output_ansi_reset();
87
88 return 0;
89 }
90
sandbox_serial_putc(struct udevice * dev,const char ch)91 static int sandbox_serial_putc(struct udevice *dev, const char ch)
92 {
93 struct sandbox_serial_priv *priv = dev_get_priv(dev);
94 struct sandbox_serial_platdata *plat = dev->platdata;
95
96 if (priv->start_of_line && plat->colour != -1) {
97 priv->start_of_line = false;
98 output_ansi_colour(plat->colour);
99 }
100
101 os_write(1, &ch, 1);
102 if (ch == '\n')
103 priv->start_of_line = true;
104
105 return 0;
106 }
107
increment_buffer_index(unsigned int index)108 static unsigned int increment_buffer_index(unsigned int index)
109 {
110 return (index + 1) % ARRAY_SIZE(serial_buf);
111 }
112
sandbox_serial_pending(struct udevice * dev,bool input)113 static int sandbox_serial_pending(struct udevice *dev, bool input)
114 {
115 const unsigned int next_index =
116 increment_buffer_index(serial_buf_write);
117 ssize_t count;
118
119 if (!input)
120 return 0;
121
122 os_usleep(100);
123 #ifndef CONFIG_SPL_BUILD
124 video_sync_all();
125 #endif
126 if (next_index == serial_buf_read)
127 return 1; /* buffer full */
128
129 count = os_read(0, &serial_buf[serial_buf_write], 1);
130 if (count == 1)
131 serial_buf_write = next_index;
132
133 return serial_buf_write != serial_buf_read;
134 }
135
sandbox_serial_getc(struct udevice * dev)136 static int sandbox_serial_getc(struct udevice *dev)
137 {
138 int result;
139
140 if (!sandbox_serial_pending(dev, true))
141 return -EAGAIN; /* buffer empty */
142
143 result = serial_buf[serial_buf_read];
144 serial_buf_read = increment_buffer_index(serial_buf_read);
145 return result;
146 }
147 #endif /* CONFIG_IS_ENABLED(OF_CONTROL) */
148
149 #ifdef CONFIG_DEBUG_UART_SANDBOX
150
151 #include <debug_uart.h>
152
_debug_uart_init(void)153 static inline void _debug_uart_init(void)
154 {
155 }
156
_debug_uart_putc(int ch)157 static inline void _debug_uart_putc(int ch)
158 {
159 os_putc(ch);
160 }
161
162 DEBUG_UART_FUNCS
163
164 #endif /* CONFIG_DEBUG_UART_SANDBOX */
165
sandbox_serial_getconfig(struct udevice * dev,uint * serial_config)166 static int sandbox_serial_getconfig(struct udevice *dev, uint *serial_config)
167 {
168 uint config = SERIAL_DEFAULT_CONFIG;
169
170 if (!serial_config)
171 return -EINVAL;
172
173 *serial_config = config;
174
175 return 0;
176 }
177
sandbox_serial_setconfig(struct udevice * dev,uint serial_config)178 static int sandbox_serial_setconfig(struct udevice *dev, uint serial_config)
179 {
180 u8 parity = SERIAL_GET_PARITY(serial_config);
181 u8 bits = SERIAL_GET_BITS(serial_config);
182 u8 stop = SERIAL_GET_STOP(serial_config);
183
184 if (bits != SERIAL_8_BITS || stop != SERIAL_ONE_STOP ||
185 parity != SERIAL_PAR_NONE)
186 return -ENOTSUPP; /* not supported in driver*/
187
188 return 0;
189 }
190
sandbox_serial_getinfo(struct udevice * dev,struct serial_device_info * serial_info)191 static int sandbox_serial_getinfo(struct udevice *dev,
192 struct serial_device_info *serial_info)
193 {
194 struct serial_device_info info = {
195 .type = SERIAL_CHIP_UNKNOWN,
196 .addr_space = SERIAL_ADDRESS_SPACE_IO,
197 .addr = SERIAL_DEFAULT_ADDRESS,
198 .reg_width = 1,
199 .reg_offset = 0,
200 .reg_shift = 0,
201 };
202
203 if (!serial_info)
204 return -EINVAL;
205
206 *serial_info = info;
207
208 return 0;
209 }
210
211 #if CONFIG_IS_ENABLED(OF_CONTROL)
212 static const char * const ansi_colour[] = {
213 "black", "red", "green", "yellow", "blue", "megenta", "cyan",
214 "white",
215 };
216
sandbox_serial_ofdata_to_platdata(struct udevice * dev)217 static int sandbox_serial_ofdata_to_platdata(struct udevice *dev)
218 {
219 struct sandbox_serial_platdata *plat = dev->platdata;
220 const char *colour;
221 int i;
222
223 plat->colour = -1;
224 colour = fdt_getprop(gd->fdt_blob, dev_of_offset(dev),
225 "sandbox,text-colour", NULL);
226 if (colour) {
227 for (i = 0; i < ARRAY_SIZE(ansi_colour); i++) {
228 if (!strcmp(colour, ansi_colour[i])) {
229 plat->colour = i;
230 break;
231 }
232 }
233 }
234
235 return 0;
236 }
237
238 static const struct dm_serial_ops sandbox_serial_ops = {
239 .putc = sandbox_serial_putc,
240 .pending = sandbox_serial_pending,
241 .getc = sandbox_serial_getc,
242 .getconfig = sandbox_serial_getconfig,
243 .setconfig = sandbox_serial_setconfig,
244 .getinfo = sandbox_serial_getinfo,
245 };
246
247 static const struct udevice_id sandbox_serial_ids[] = {
248 { .compatible = "sandbox,serial" },
249 { }
250 };
251
252 U_BOOT_DRIVER(serial_sandbox) = {
253 .name = "serial_sandbox",
254 .id = UCLASS_SERIAL,
255 .of_match = sandbox_serial_ids,
256 .ofdata_to_platdata = sandbox_serial_ofdata_to_platdata,
257 .platdata_auto_alloc_size = sizeof(struct sandbox_serial_platdata),
258 .priv_auto_alloc_size = sizeof(struct sandbox_serial_priv),
259 .probe = sandbox_serial_probe,
260 .remove = sandbox_serial_remove,
261 .ops = &sandbox_serial_ops,
262 .flags = DM_FLAG_PRE_RELOC,
263 };
264
265 static const struct sandbox_serial_platdata platdata_non_fdt = {
266 .colour = -1,
267 };
268
269 U_BOOT_DEVICE(serial_sandbox_non_fdt) = {
270 .name = "serial_sandbox",
271 .platdata = &platdata_non_fdt,
272 };
273 #endif /* CONFIG_IS_ENABLED(OF_CONTROL) */
274