blob: db2fbac6295dee88285439b8b8e169030ebed4fc [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
Simon Glass7accb6e2011-10-03 19:26:46 +00002/*
3 * Copyright (c) 2011 The Chromium OS Authors.
Simon Glass7accb6e2011-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 Hershberger82a115f2018-07-02 20:06:49 -050013#include <console.h>
Simon Glass890fcef2014-09-04 16:27:27 -060014#include <dm.h>
15#include <fdtdec.h>
Simon Glass7d95f2a2014-02-27 13:26:19 -070016#include <lcd.h>
Simon Glass7accb6e2011-10-03 19:26:46 +000017#include <os.h>
Marek Vasutcef46b72012-09-14 22:33:21 +020018#include <serial.h>
Simon Glass3ade5bc2016-01-18 19:52:25 -070019#include <video.h>
Marek Vasutcef46b72012-09-14 22:33:21 +020020#include <linux/compiler.h>
Simon Glassffb87902014-02-27 13:26:22 -070021#include <asm/state.h>
Simon Glass7accb6e2011-10-03 19:26:46 +000022
Simon Glass890fcef2014-09-04 16:27:27 -060023DECLARE_GLOBAL_DATA_PTR;
24
Simon Glass114b60a2018-10-01 11:55:16 -060025#if CONFIG_IS_ENABLED(OF_CONTROL)
26
Taylor Hutte1015502013-02-24 17:33:13 +000027/*
28 *
29 * serial_buf: A buffer that holds keyboard characters for the
Bin Menga1875592016-02-05 19:30:11 -080030 * Sandbox U-Boot.
Taylor Hutte1015502013-02-24 17:33:13 +000031 *
32 * invariants:
33 * serial_buf_write == serial_buf_read -> empty buffer
34 * (serial_buf_write + 1) % 16 == serial_buf_read -> full buffer
35 */
Heinrich Schuchardt5e5c7852019-11-09 10:59:02 +010036static unsigned char serial_buf[16];
Taylor Hutte1015502013-02-24 17:33:13 +000037static unsigned int serial_buf_write;
38static unsigned int serial_buf_read;
39
Simon Glass72e98222014-09-04 16:27:28 -060040struct sandbox_serial_platdata {
41 int colour; /* Text colour to use for output, -1 for none */
42};
43
44struct 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 */
53static 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
61static void output_ansi_reset(void)
62{
63 os_write(1, "\x1b[0m", 4);
64}
65
Simon Glass890fcef2014-09-04 16:27:27 -060066static int sandbox_serial_probe(struct udevice *dev)
Simon Glass7accb6e2011-10-03 19:26:46 +000067{
Simon Glassffb87902014-02-27 13:26:22 -070068 struct sandbox_state *state = state_get_current();
Simon Glass72e98222014-09-04 16:27:28 -060069 struct sandbox_serial_priv *priv = dev_get_priv(dev);
Simon Glassffb87902014-02-27 13:26:22 -070070
71 if (state->term_raw != STATE_TERM_COOKED)
72 os_tty_raw(0, state->term_raw == STATE_TERM_RAW_WITH_SIGS);
Simon Glass72e98222014-09-04 16:27:28 -060073 priv->start_of_line = 0;
74
Joe Hershberger82a115f2018-07-02 20:06:49 -050075 if (state->term_raw != STATE_TERM_RAW)
76 disable_ctrlc(1);
77
Simon Glass72e98222014-09-04 16:27:28 -060078 return 0;
79}
80
81static 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();
Simon Glass890fcef2014-09-04 16:27:27 -060087
Simon Glass7accb6e2011-10-03 19:26:46 +000088 return 0;
89}
90
Simon Glass890fcef2014-09-04 16:27:27 -060091static int sandbox_serial_putc(struct udevice *dev, const char ch)
Simon Glass7accb6e2011-10-03 19:26:46 +000092{
Simon Glass72e98222014-09-04 16:27:28 -060093 struct sandbox_serial_priv *priv = dev_get_priv(dev);
94 struct sandbox_serial_platdata *plat = dev->platdata;
95
Walter Lozanoe3e24702020-06-25 01:10:04 -030096 /* With of-platdata we don't real the colour correctly, so disable it */
97 if (!CONFIG_IS_ENABLED(OF_PLATDATA) && priv->start_of_line &&
98 plat->colour != -1) {
Simon Glass72e98222014-09-04 16:27:28 -060099 priv->start_of_line = false;
100 output_ansi_colour(plat->colour);
101 }
102
Simon Glass7accb6e2011-10-03 19:26:46 +0000103 os_write(1, &ch, 1);
Simon Glass72e98222014-09-04 16:27:28 -0600104 if (ch == '\n')
105 priv->start_of_line = true;
Simon Glass7accb6e2011-10-03 19:26:46 +0000106
Simon Glass890fcef2014-09-04 16:27:27 -0600107 return 0;
Simon Glass7accb6e2011-10-03 19:26:46 +0000108}
109
Taylor Hutte1015502013-02-24 17:33:13 +0000110static unsigned int increment_buffer_index(unsigned int index)
Simon Glass7accb6e2011-10-03 19:26:46 +0000111{
Taylor Hutte1015502013-02-24 17:33:13 +0000112 return (index + 1) % ARRAY_SIZE(serial_buf);
Simon Glass7accb6e2011-10-03 19:26:46 +0000113}
114
Simon Glass890fcef2014-09-04 16:27:27 -0600115static int sandbox_serial_pending(struct udevice *dev, bool input)
Simon Glass7accb6e2011-10-03 19:26:46 +0000116{
Taylor Hutte1015502013-02-24 17:33:13 +0000117 const unsigned int next_index =
118 increment_buffer_index(serial_buf_write);
119 ssize_t count;
120
Simon Glass890fcef2014-09-04 16:27:27 -0600121 if (!input)
122 return 0;
123
Taylor Hutte1015502013-02-24 17:33:13 +0000124 os_usleep(100);
Simon Glass0110f502016-07-04 11:57:53 -0600125#ifndef CONFIG_SPL_BUILD
Simon Glass3ade5bc2016-01-18 19:52:25 -0700126 video_sync_all();
Simon Glass0110f502016-07-04 11:57:53 -0600127#endif
Taylor Hutte1015502013-02-24 17:33:13 +0000128 if (next_index == serial_buf_read)
129 return 1; /* buffer full */
130
Simon Glass4af3e9a2018-10-01 11:55:20 -0600131 count = os_read(0, &serial_buf[serial_buf_write], 1);
Taylor Hutte1015502013-02-24 17:33:13 +0000132 if (count == 1)
133 serial_buf_write = next_index;
Simon Glass890fcef2014-09-04 16:27:27 -0600134
Taylor Hutte1015502013-02-24 17:33:13 +0000135 return serial_buf_write != serial_buf_read;
136}
137
Simon Glass890fcef2014-09-04 16:27:27 -0600138static int sandbox_serial_getc(struct udevice *dev)
Taylor Hutte1015502013-02-24 17:33:13 +0000139{
140 int result;
141
Simon Glass890fcef2014-09-04 16:27:27 -0600142 if (!sandbox_serial_pending(dev, true))
143 return -EAGAIN; /* buffer empty */
Taylor Hutte1015502013-02-24 17:33:13 +0000144
145 result = serial_buf[serial_buf_read];
146 serial_buf_read = increment_buffer_index(serial_buf_read);
147 return result;
Simon Glass7accb6e2011-10-03 19:26:46 +0000148}
Simon Glass114b60a2018-10-01 11:55:16 -0600149#endif /* CONFIG_IS_ENABLED(OF_CONTROL) */
Marek Vasutcef46b72012-09-14 22:33:21 +0200150
Simon Glassee441762018-10-01 11:55:15 -0600151#ifdef CONFIG_DEBUG_UART_SANDBOX
152
153#include <debug_uart.h>
154
155static inline void _debug_uart_init(void)
156{
157}
158
159static inline void _debug_uart_putc(int ch)
160{
161 os_putc(ch);
162}
163
164DEBUG_UART_FUNCS
165
166#endif /* CONFIG_DEBUG_UART_SANDBOX */
167
Andy Shevchenkoac7f5db2018-11-20 23:52:32 +0200168static int sandbox_serial_getconfig(struct udevice *dev, uint *serial_config)
169{
170 uint config = SERIAL_DEFAULT_CONFIG;
171
172 if (!serial_config)
173 return -EINVAL;
174
175 *serial_config = config;
176
177 return 0;
178}
179
Patrice Chotardd7c09682018-08-03 15:07:41 +0200180static int sandbox_serial_setconfig(struct udevice *dev, uint serial_config)
181{
182 u8 parity = SERIAL_GET_PARITY(serial_config);
183 u8 bits = SERIAL_GET_BITS(serial_config);
184 u8 stop = SERIAL_GET_STOP(serial_config);
185
186 if (bits != SERIAL_8_BITS || stop != SERIAL_ONE_STOP ||
187 parity != SERIAL_PAR_NONE)
188 return -ENOTSUPP; /* not supported in driver*/
189
190 return 0;
191}
192
Andy Shevchenkod5bb4f82018-11-20 23:52:33 +0200193static int sandbox_serial_getinfo(struct udevice *dev,
194 struct serial_device_info *serial_info)
195{
196 struct serial_device_info info = {
197 .type = SERIAL_CHIP_UNKNOWN,
198 .addr_space = SERIAL_ADDRESS_SPACE_IO,
199 .addr = SERIAL_DEFAULT_ADDRESS,
200 .reg_width = 1,
201 .reg_offset = 0,
202 .reg_shift = 0,
Andy Shevchenkobf4661bc2020-02-27 17:21:54 +0200203 .clock = SERIAL_DEFAULT_CLOCK,
Andy Shevchenkod5bb4f82018-11-20 23:52:33 +0200204 };
205
206 if (!serial_info)
207 return -EINVAL;
208
209 *serial_info = info;
210
211 return 0;
212}
213
Simon Glass114b60a2018-10-01 11:55:16 -0600214#if CONFIG_IS_ENABLED(OF_CONTROL)
Simon Glass72e98222014-09-04 16:27:28 -0600215static const char * const ansi_colour[] = {
216 "black", "red", "green", "yellow", "blue", "megenta", "cyan",
217 "white",
218};
219
220static int sandbox_serial_ofdata_to_platdata(struct udevice *dev)
221{
222 struct sandbox_serial_platdata *plat = dev->platdata;
223 const char *colour;
224 int i;
225
Simon Glassea147782019-09-25 08:55:53 -0600226 if (CONFIG_IS_ENABLED(OF_PLATDATA))
227 return 0;
Simon Glass72e98222014-09-04 16:27:28 -0600228 plat->colour = -1;
Simon Glasse160f7d2017-01-17 16:52:55 -0700229 colour = fdt_getprop(gd->fdt_blob, dev_of_offset(dev),
Simon Glass72e98222014-09-04 16:27:28 -0600230 "sandbox,text-colour", NULL);
231 if (colour) {
232 for (i = 0; i < ARRAY_SIZE(ansi_colour); i++) {
233 if (!strcmp(colour, ansi_colour[i])) {
234 plat->colour = i;
235 break;
236 }
237 }
238 }
239
240 return 0;
241}
242
Simon Glass890fcef2014-09-04 16:27:27 -0600243static const struct dm_serial_ops sandbox_serial_ops = {
244 .putc = sandbox_serial_putc,
245 .pending = sandbox_serial_pending,
246 .getc = sandbox_serial_getc,
Andy Shevchenkoac7f5db2018-11-20 23:52:32 +0200247 .getconfig = sandbox_serial_getconfig,
Patrice Chotardd7c09682018-08-03 15:07:41 +0200248 .setconfig = sandbox_serial_setconfig,
Andy Shevchenkod5bb4f82018-11-20 23:52:33 +0200249 .getinfo = sandbox_serial_getinfo,
Marek Vasutcef46b72012-09-14 22:33:21 +0200250};
251
Simon Glass890fcef2014-09-04 16:27:27 -0600252static const struct udevice_id sandbox_serial_ids[] = {
253 { .compatible = "sandbox,serial" },
254 { }
255};
Marek Vasutcef46b72012-09-14 22:33:21 +0200256
Walter Lozanoe3e24702020-06-25 01:10:04 -0300257U_BOOT_DRIVER(sandbox_serial) = {
258 .name = "sandbox_serial",
Simon Glass890fcef2014-09-04 16:27:27 -0600259 .id = UCLASS_SERIAL,
260 .of_match = sandbox_serial_ids,
Simon Glass72e98222014-09-04 16:27:28 -0600261 .ofdata_to_platdata = sandbox_serial_ofdata_to_platdata,
262 .platdata_auto_alloc_size = sizeof(struct sandbox_serial_platdata),
263 .priv_auto_alloc_size = sizeof(struct sandbox_serial_priv),
Simon Glass890fcef2014-09-04 16:27:27 -0600264 .probe = sandbox_serial_probe,
Simon Glass72e98222014-09-04 16:27:28 -0600265 .remove = sandbox_serial_remove,
Simon Glass890fcef2014-09-04 16:27:27 -0600266 .ops = &sandbox_serial_ops,
267 .flags = DM_FLAG_PRE_RELOC,
268};
269
Simon Glassc1473292020-10-03 11:31:23 -0600270#if !CONFIG_IS_ENABLED(OF_PLATDATA)
Simon Glass72e98222014-09-04 16:27:28 -0600271static const struct sandbox_serial_platdata platdata_non_fdt = {
272 .colour = -1,
273};
274
Simon Glass890fcef2014-09-04 16:27:27 -0600275U_BOOT_DEVICE(serial_sandbox_non_fdt) = {
Walter Lozanoe3e24702020-06-25 01:10:04 -0300276 .name = "sandbox_serial",
Simon Glass72e98222014-09-04 16:27:28 -0600277 .platdata = &platdata_non_fdt,
Simon Glass890fcef2014-09-04 16:27:27 -0600278};
Simon Glassc1473292020-10-03 11:31:23 -0600279#endif
280
Simon Glass114b60a2018-10-01 11:55:16 -0600281#endif /* CONFIG_IS_ENABLED(OF_CONTROL) */