blob: e3967deaaf2121683da81d739a20f9113de20a87 [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
Simon Glass479349a2011-10-03 19:26:46 +00002/*
3 * Copyright (c) 2011 The Chromium OS Authors.
Simon Glass479349a2011-10-03 19:26:46 +00004 */
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>
Joe Hershbergerb3eff9b2018-07-02 20:06:49 -050013#include <console.h>
Simon Glasse5870692014-09-04 16:27:27 -060014#include <dm.h>
15#include <fdtdec.h>
Simon Glassb9ddbf42014-02-27 13:26:19 -070016#include <lcd.h>
Simon Glass479349a2011-10-03 19:26:46 +000017#include <os.h>
Marek Vasut289c3002012-09-14 22:33:21 +020018#include <serial.h>
Simon Glass38a2ae22016-01-18 19:52:25 -070019#include <video.h>
Marek Vasut289c3002012-09-14 22:33:21 +020020#include <linux/compiler.h>
Simon Glass678ef472014-02-27 13:26:22 -070021#include <asm/state.h>
Simon Glass479349a2011-10-03 19:26:46 +000022
Simon Glasse5870692014-09-04 16:27:27 -060023DECLARE_GLOBAL_DATA_PTR;
24
Taylor Hutt868aa3a2013-02-24 17:33:13 +000025/*
26 *
27 * serial_buf: A buffer that holds keyboard characters for the
Bin Meng75574052016-02-05 19:30:11 -080028 * Sandbox U-Boot.
Taylor Hutt868aa3a2013-02-24 17:33:13 +000029 *
30 * invariants:
31 * serial_buf_write == serial_buf_read -> empty buffer
32 * (serial_buf_write + 1) % 16 == serial_buf_read -> full buffer
33 */
Heinrich Schuchardt81620a52019-11-09 10:59:02 +010034static unsigned char serial_buf[16];
Taylor Hutt868aa3a2013-02-24 17:33:13 +000035static unsigned int serial_buf_write;
36static unsigned int serial_buf_read;
37
Simon Glass1a823a92014-09-04 16:27:28 -060038struct sandbox_serial_platdata {
39 int colour; /* Text colour to use for output, -1 for none */
40};
41
42struct sandbox_serial_priv {
43 bool start_of_line;
44};
45
46/**
47 * output_ansi_colour() - Output an ANSI colour code
48 *
49 * @colour: Colour to output (0-7)
50 */
51static void output_ansi_colour(int colour)
52{
53 char ansi_code[] = "\x1b[1;3Xm";
54
55 ansi_code[5] = '0' + colour;
56 os_write(1, ansi_code, sizeof(ansi_code) - 1);
57}
58
59static void output_ansi_reset(void)
60{
61 os_write(1, "\x1b[0m", 4);
62}
63
Simon Glasse5870692014-09-04 16:27:27 -060064static int sandbox_serial_probe(struct udevice *dev)
Simon Glass479349a2011-10-03 19:26:46 +000065{
Simon Glass678ef472014-02-27 13:26:22 -070066 struct sandbox_state *state = state_get_current();
Simon Glass1a823a92014-09-04 16:27:28 -060067 struct sandbox_serial_priv *priv = dev_get_priv(dev);
Simon Glass678ef472014-02-27 13:26:22 -070068
69 if (state->term_raw != STATE_TERM_COOKED)
70 os_tty_raw(0, state->term_raw == STATE_TERM_RAW_WITH_SIGS);
Simon Glass1a823a92014-09-04 16:27:28 -060071 priv->start_of_line = 0;
Simon Glass479349a2011-10-03 19:26:46 +000072
Joe Hershbergerb3eff9b2018-07-02 20:06:49 -050073 if (state->term_raw != STATE_TERM_RAW)
74 disable_ctrlc(1);
75
Simon Glasse5870692014-09-04 16:27:27 -060076 return 0;
Simon Glass479349a2011-10-03 19:26:46 +000077}
78
Simon Glass1a823a92014-09-04 16:27:28 -060079static int sandbox_serial_remove(struct udevice *dev)
80{
81 struct sandbox_serial_platdata *plat = dev->platdata;
82
83 if (plat->colour != -1)
84 output_ansi_reset();
85
86 return 0;
87}
88
Simon Glasse5870692014-09-04 16:27:27 -060089static int sandbox_serial_putc(struct udevice *dev, const char ch)
Simon Glass479349a2011-10-03 19:26:46 +000090{
Simon Glass1a823a92014-09-04 16:27:28 -060091 struct sandbox_serial_priv *priv = dev_get_priv(dev);
92 struct sandbox_serial_platdata *plat = dev->platdata;
93
Walter Lozano2901ac62020-06-25 01:10:04 -030094 /* With of-platdata we don't real the colour correctly, so disable it */
95 if (!CONFIG_IS_ENABLED(OF_PLATDATA) && priv->start_of_line &&
96 plat->colour != -1) {
Simon Glass1a823a92014-09-04 16:27:28 -060097 priv->start_of_line = false;
98 output_ansi_colour(plat->colour);
99 }
100
Simon Glass479349a2011-10-03 19:26:46 +0000101 os_write(1, &ch, 1);
Simon Glass1a823a92014-09-04 16:27:28 -0600102 if (ch == '\n')
103 priv->start_of_line = true;
Simon Glass479349a2011-10-03 19:26:46 +0000104
Simon Glasse5870692014-09-04 16:27:27 -0600105 return 0;
Simon Glass479349a2011-10-03 19:26:46 +0000106}
107
Taylor Hutt868aa3a2013-02-24 17:33:13 +0000108static unsigned int increment_buffer_index(unsigned int index)
109{
110 return (index + 1) % ARRAY_SIZE(serial_buf);
111}
112
Simon Glasse5870692014-09-04 16:27:27 -0600113static int sandbox_serial_pending(struct udevice *dev, bool input)
Simon Glass479349a2011-10-03 19:26:46 +0000114{
Taylor Hutt868aa3a2013-02-24 17:33:13 +0000115 const unsigned int next_index =
116 increment_buffer_index(serial_buf_write);
Mike Frysingerd174fd92011-10-26 00:21:01 +0000117 ssize_t count;
Simon Glass479349a2011-10-03 19:26:46 +0000118
Simon Glasse5870692014-09-04 16:27:27 -0600119 if (!input)
120 return 0;
121
Taylor Hutt868aa3a2013-02-24 17:33:13 +0000122 os_usleep(100);
Simon Glass0b8ffa72020-11-08 20:36:48 -0700123 if (!IS_ENABLED(CONFIG_SPL_BUILD))
124 video_sync_all();
Taylor Hutt868aa3a2013-02-24 17:33:13 +0000125 if (next_index == serial_buf_read)
126 return 1; /* buffer full */
127
Simon Glassae50ec72018-10-01 11:55:20 -0600128 count = os_read(0, &serial_buf[serial_buf_write], 1);
Taylor Hutt868aa3a2013-02-24 17:33:13 +0000129 if (count == 1)
130 serial_buf_write = next_index;
Simon Glasse5870692014-09-04 16:27:27 -0600131
Taylor Hutt868aa3a2013-02-24 17:33:13 +0000132 return serial_buf_write != serial_buf_read;
Simon Glass479349a2011-10-03 19:26:46 +0000133}
134
Simon Glasse5870692014-09-04 16:27:27 -0600135static int sandbox_serial_getc(struct udevice *dev)
Simon Glass479349a2011-10-03 19:26:46 +0000136{
Taylor Hutt868aa3a2013-02-24 17:33:13 +0000137 int result;
138
Simon Glasse5870692014-09-04 16:27:27 -0600139 if (!sandbox_serial_pending(dev, true))
140 return -EAGAIN; /* buffer empty */
Taylor Hutt868aa3a2013-02-24 17:33:13 +0000141
142 result = serial_buf[serial_buf_read];
143 serial_buf_read = increment_buffer_index(serial_buf_read);
144 return result;
Simon Glass479349a2011-10-03 19:26:46 +0000145}
Marek Vasut289c3002012-09-14 22:33:21 +0200146
Simon Glasse3057f32018-10-01 11:55:15 -0600147#ifdef CONFIG_DEBUG_UART_SANDBOX
148
149#include <debug_uart.h>
150
151static inline void _debug_uart_init(void)
152{
153}
154
155static inline void _debug_uart_putc(int ch)
156{
157 os_putc(ch);
158}
159
160DEBUG_UART_FUNCS
161
162#endif /* CONFIG_DEBUG_UART_SANDBOX */
163
Andy Shevchenko08e98792018-11-20 23:52:32 +0200164static int sandbox_serial_getconfig(struct udevice *dev, uint *serial_config)
165{
166 uint config = SERIAL_DEFAULT_CONFIG;
167
168 if (!serial_config)
169 return -EINVAL;
170
171 *serial_config = config;
172
173 return 0;
174}
175
Patrice Chotard70ed0ea2018-08-03 15:07:41 +0200176static int sandbox_serial_setconfig(struct udevice *dev, uint serial_config)
177{
178 u8 parity = SERIAL_GET_PARITY(serial_config);
179 u8 bits = SERIAL_GET_BITS(serial_config);
180 u8 stop = SERIAL_GET_STOP(serial_config);
181
182 if (bits != SERIAL_8_BITS || stop != SERIAL_ONE_STOP ||
183 parity != SERIAL_PAR_NONE)
184 return -ENOTSUPP; /* not supported in driver*/
185
186 return 0;
187}
188
Andy Shevchenko44f21da2018-11-20 23:52:33 +0200189static int sandbox_serial_getinfo(struct udevice *dev,
190 struct serial_device_info *serial_info)
191{
192 struct serial_device_info info = {
193 .type = SERIAL_CHIP_UNKNOWN,
194 .addr_space = SERIAL_ADDRESS_SPACE_IO,
195 .addr = SERIAL_DEFAULT_ADDRESS,
196 .reg_width = 1,
197 .reg_offset = 0,
198 .reg_shift = 0,
Andy Shevchenko106930e2020-02-27 17:21:54 +0200199 .clock = SERIAL_DEFAULT_CLOCK,
Andy Shevchenko44f21da2018-11-20 23:52:33 +0200200 };
201
202 if (!serial_info)
203 return -EINVAL;
204
205 *serial_info = info;
206
207 return 0;
208}
209
Simon Glass1a823a92014-09-04 16:27:28 -0600210static const char * const ansi_colour[] = {
211 "black", "red", "green", "yellow", "blue", "megenta", "cyan",
212 "white",
213};
214
215static int sandbox_serial_ofdata_to_platdata(struct udevice *dev)
216{
217 struct sandbox_serial_platdata *plat = dev->platdata;
218 const char *colour;
219 int i;
220
Simon Glassa91e48b2019-09-25 08:55:53 -0600221 if (CONFIG_IS_ENABLED(OF_PLATDATA))
222 return 0;
Simon Glass1a823a92014-09-04 16:27:28 -0600223 plat->colour = -1;
Simon Glassdd79d6e2017-01-17 16:52:55 -0700224 colour = fdt_getprop(gd->fdt_blob, dev_of_offset(dev),
Simon Glass1a823a92014-09-04 16:27:28 -0600225 "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
Simon Glasse5870692014-09-04 16:27:27 -0600238static const struct dm_serial_ops sandbox_serial_ops = {
239 .putc = sandbox_serial_putc,
240 .pending = sandbox_serial_pending,
241 .getc = sandbox_serial_getc,
Andy Shevchenko08e98792018-11-20 23:52:32 +0200242 .getconfig = sandbox_serial_getconfig,
Patrice Chotard70ed0ea2018-08-03 15:07:41 +0200243 .setconfig = sandbox_serial_setconfig,
Andy Shevchenko44f21da2018-11-20 23:52:33 +0200244 .getinfo = sandbox_serial_getinfo,
Marek Vasut289c3002012-09-14 22:33:21 +0200245};
246
Simon Glasse5870692014-09-04 16:27:27 -0600247static const struct udevice_id sandbox_serial_ids[] = {
248 { .compatible = "sandbox,serial" },
249 { }
250};
Marek Vasut289c3002012-09-14 22:33:21 +0200251
Walter Lozano2901ac62020-06-25 01:10:04 -0300252U_BOOT_DRIVER(sandbox_serial) = {
253 .name = "sandbox_serial",
Simon Glasse5870692014-09-04 16:27:27 -0600254 .id = UCLASS_SERIAL,
255 .of_match = sandbox_serial_ids,
Simon Glass1a823a92014-09-04 16:27:28 -0600256 .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),
Simon Glasse5870692014-09-04 16:27:27 -0600259 .probe = sandbox_serial_probe,
Simon Glass1a823a92014-09-04 16:27:28 -0600260 .remove = sandbox_serial_remove,
Simon Glasse5870692014-09-04 16:27:27 -0600261 .ops = &sandbox_serial_ops,
262 .flags = DM_FLAG_PRE_RELOC,
263};
264
Simon Glasscb90bd32020-10-03 11:31:23 -0600265#if !CONFIG_IS_ENABLED(OF_PLATDATA)
Simon Glass1a823a92014-09-04 16:27:28 -0600266static const struct sandbox_serial_platdata platdata_non_fdt = {
267 .colour = -1,
268};
269
Simon Glasse5870692014-09-04 16:27:27 -0600270U_BOOT_DEVICE(serial_sandbox_non_fdt) = {
Walter Lozano2901ac62020-06-25 01:10:04 -0300271 .name = "sandbox_serial",
Simon Glass1a823a92014-09-04 16:27:28 -0600272 .platdata = &platdata_non_fdt,
Simon Glasse5870692014-09-04 16:27:27 -0600273};
Simon Glasscb90bd32020-10-03 11:31:23 -0600274#endif