Tom Rini | 10e4779 | 2018-05-06 17:58:06 -0400 | [diff] [blame] | 1 | // SPDX-License-Identifier: GPL-2.0+ |
Simon Glass | 479349a | 2011-10-03 19:26:46 +0000 | [diff] [blame] | 2 | /* |
| 3 | * Copyright (c) 2011 The Chromium OS Authors. |
Simon Glass | 479349a | 2011-10-03 19:26:46 +0000 | [diff] [blame] | 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> |
Joe Hershberger | b3eff9b | 2018-07-02 20:06:49 -0500 | [diff] [blame] | 13 | #include <console.h> |
Simon Glass | e587069 | 2014-09-04 16:27:27 -0600 | [diff] [blame] | 14 | #include <dm.h> |
| 15 | #include <fdtdec.h> |
Simon Glass | b9ddbf4 | 2014-02-27 13:26:19 -0700 | [diff] [blame] | 16 | #include <lcd.h> |
Simon Glass | 479349a | 2011-10-03 19:26:46 +0000 | [diff] [blame] | 17 | #include <os.h> |
Marek Vasut | 289c300 | 2012-09-14 22:33:21 +0200 | [diff] [blame] | 18 | #include <serial.h> |
Simon Glass | 38a2ae2 | 2016-01-18 19:52:25 -0700 | [diff] [blame] | 19 | #include <video.h> |
Marek Vasut | 289c300 | 2012-09-14 22:33:21 +0200 | [diff] [blame] | 20 | #include <linux/compiler.h> |
Simon Glass | 678ef47 | 2014-02-27 13:26:22 -0700 | [diff] [blame] | 21 | #include <asm/state.h> |
Simon Glass | 479349a | 2011-10-03 19:26:46 +0000 | [diff] [blame] | 22 | |
Simon Glass | e587069 | 2014-09-04 16:27:27 -0600 | [diff] [blame] | 23 | DECLARE_GLOBAL_DATA_PTR; |
| 24 | |
Taylor Hutt | 868aa3a | 2013-02-24 17:33:13 +0000 | [diff] [blame] | 25 | /* |
| 26 | * |
| 27 | * serial_buf: A buffer that holds keyboard characters for the |
Bin Meng | 7557405 | 2016-02-05 19:30:11 -0800 | [diff] [blame] | 28 | * Sandbox U-Boot. |
Taylor Hutt | 868aa3a | 2013-02-24 17:33:13 +0000 | [diff] [blame] | 29 | * |
| 30 | * invariants: |
| 31 | * serial_buf_write == serial_buf_read -> empty buffer |
| 32 | * (serial_buf_write + 1) % 16 == serial_buf_read -> full buffer |
| 33 | */ |
Heinrich Schuchardt | 81620a5 | 2019-11-09 10:59:02 +0100 | [diff] [blame] | 34 | static unsigned char serial_buf[16]; |
Taylor Hutt | 868aa3a | 2013-02-24 17:33:13 +0000 | [diff] [blame] | 35 | static unsigned int serial_buf_write; |
| 36 | static unsigned int serial_buf_read; |
| 37 | |
Simon Glass | 1a823a9 | 2014-09-04 16:27:28 -0600 | [diff] [blame] | 38 | struct sandbox_serial_platdata { |
| 39 | int colour; /* Text colour to use for output, -1 for none */ |
| 40 | }; |
| 41 | |
| 42 | struct 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 | */ |
| 51 | static 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 | |
| 59 | static void output_ansi_reset(void) |
| 60 | { |
| 61 | os_write(1, "\x1b[0m", 4); |
| 62 | } |
| 63 | |
Simon Glass | e587069 | 2014-09-04 16:27:27 -0600 | [diff] [blame] | 64 | static int sandbox_serial_probe(struct udevice *dev) |
Simon Glass | 479349a | 2011-10-03 19:26:46 +0000 | [diff] [blame] | 65 | { |
Simon Glass | 678ef47 | 2014-02-27 13:26:22 -0700 | [diff] [blame] | 66 | struct sandbox_state *state = state_get_current(); |
Simon Glass | 1a823a9 | 2014-09-04 16:27:28 -0600 | [diff] [blame] | 67 | struct sandbox_serial_priv *priv = dev_get_priv(dev); |
Simon Glass | 678ef47 | 2014-02-27 13:26:22 -0700 | [diff] [blame] | 68 | |
| 69 | if (state->term_raw != STATE_TERM_COOKED) |
| 70 | os_tty_raw(0, state->term_raw == STATE_TERM_RAW_WITH_SIGS); |
Simon Glass | 1a823a9 | 2014-09-04 16:27:28 -0600 | [diff] [blame] | 71 | priv->start_of_line = 0; |
Simon Glass | 479349a | 2011-10-03 19:26:46 +0000 | [diff] [blame] | 72 | |
Joe Hershberger | b3eff9b | 2018-07-02 20:06:49 -0500 | [diff] [blame] | 73 | if (state->term_raw != STATE_TERM_RAW) |
| 74 | disable_ctrlc(1); |
| 75 | |
Simon Glass | e587069 | 2014-09-04 16:27:27 -0600 | [diff] [blame] | 76 | return 0; |
Simon Glass | 479349a | 2011-10-03 19:26:46 +0000 | [diff] [blame] | 77 | } |
| 78 | |
Simon Glass | 1a823a9 | 2014-09-04 16:27:28 -0600 | [diff] [blame] | 79 | static 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 Glass | e587069 | 2014-09-04 16:27:27 -0600 | [diff] [blame] | 89 | static int sandbox_serial_putc(struct udevice *dev, const char ch) |
Simon Glass | 479349a | 2011-10-03 19:26:46 +0000 | [diff] [blame] | 90 | { |
Simon Glass | 1a823a9 | 2014-09-04 16:27:28 -0600 | [diff] [blame] | 91 | struct sandbox_serial_priv *priv = dev_get_priv(dev); |
| 92 | struct sandbox_serial_platdata *plat = dev->platdata; |
| 93 | |
Walter Lozano | 2901ac6 | 2020-06-25 01:10:04 -0300 | [diff] [blame] | 94 | /* 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 Glass | 1a823a9 | 2014-09-04 16:27:28 -0600 | [diff] [blame] | 97 | priv->start_of_line = false; |
| 98 | output_ansi_colour(plat->colour); |
| 99 | } |
| 100 | |
Simon Glass | 479349a | 2011-10-03 19:26:46 +0000 | [diff] [blame] | 101 | os_write(1, &ch, 1); |
Simon Glass | 1a823a9 | 2014-09-04 16:27:28 -0600 | [diff] [blame] | 102 | if (ch == '\n') |
| 103 | priv->start_of_line = true; |
Simon Glass | 479349a | 2011-10-03 19:26:46 +0000 | [diff] [blame] | 104 | |
Simon Glass | e587069 | 2014-09-04 16:27:27 -0600 | [diff] [blame] | 105 | return 0; |
Simon Glass | 479349a | 2011-10-03 19:26:46 +0000 | [diff] [blame] | 106 | } |
| 107 | |
Taylor Hutt | 868aa3a | 2013-02-24 17:33:13 +0000 | [diff] [blame] | 108 | static unsigned int increment_buffer_index(unsigned int index) |
| 109 | { |
| 110 | return (index + 1) % ARRAY_SIZE(serial_buf); |
| 111 | } |
| 112 | |
Simon Glass | e587069 | 2014-09-04 16:27:27 -0600 | [diff] [blame] | 113 | static int sandbox_serial_pending(struct udevice *dev, bool input) |
Simon Glass | 479349a | 2011-10-03 19:26:46 +0000 | [diff] [blame] | 114 | { |
Taylor Hutt | 868aa3a | 2013-02-24 17:33:13 +0000 | [diff] [blame] | 115 | const unsigned int next_index = |
| 116 | increment_buffer_index(serial_buf_write); |
Mike Frysinger | d174fd9 | 2011-10-26 00:21:01 +0000 | [diff] [blame] | 117 | ssize_t count; |
Simon Glass | 479349a | 2011-10-03 19:26:46 +0000 | [diff] [blame] | 118 | |
Simon Glass | e587069 | 2014-09-04 16:27:27 -0600 | [diff] [blame] | 119 | if (!input) |
| 120 | return 0; |
| 121 | |
Taylor Hutt | 868aa3a | 2013-02-24 17:33:13 +0000 | [diff] [blame] | 122 | os_usleep(100); |
Simon Glass | 0b8ffa7 | 2020-11-08 20:36:48 -0700 | [diff] [blame^] | 123 | if (!IS_ENABLED(CONFIG_SPL_BUILD)) |
| 124 | video_sync_all(); |
Taylor Hutt | 868aa3a | 2013-02-24 17:33:13 +0000 | [diff] [blame] | 125 | if (next_index == serial_buf_read) |
| 126 | return 1; /* buffer full */ |
| 127 | |
Simon Glass | ae50ec7 | 2018-10-01 11:55:20 -0600 | [diff] [blame] | 128 | count = os_read(0, &serial_buf[serial_buf_write], 1); |
Taylor Hutt | 868aa3a | 2013-02-24 17:33:13 +0000 | [diff] [blame] | 129 | if (count == 1) |
| 130 | serial_buf_write = next_index; |
Simon Glass | e587069 | 2014-09-04 16:27:27 -0600 | [diff] [blame] | 131 | |
Taylor Hutt | 868aa3a | 2013-02-24 17:33:13 +0000 | [diff] [blame] | 132 | return serial_buf_write != serial_buf_read; |
Simon Glass | 479349a | 2011-10-03 19:26:46 +0000 | [diff] [blame] | 133 | } |
| 134 | |
Simon Glass | e587069 | 2014-09-04 16:27:27 -0600 | [diff] [blame] | 135 | static int sandbox_serial_getc(struct udevice *dev) |
Simon Glass | 479349a | 2011-10-03 19:26:46 +0000 | [diff] [blame] | 136 | { |
Taylor Hutt | 868aa3a | 2013-02-24 17:33:13 +0000 | [diff] [blame] | 137 | int result; |
| 138 | |
Simon Glass | e587069 | 2014-09-04 16:27:27 -0600 | [diff] [blame] | 139 | if (!sandbox_serial_pending(dev, true)) |
| 140 | return -EAGAIN; /* buffer empty */ |
Taylor Hutt | 868aa3a | 2013-02-24 17:33:13 +0000 | [diff] [blame] | 141 | |
| 142 | result = serial_buf[serial_buf_read]; |
| 143 | serial_buf_read = increment_buffer_index(serial_buf_read); |
| 144 | return result; |
Simon Glass | 479349a | 2011-10-03 19:26:46 +0000 | [diff] [blame] | 145 | } |
Marek Vasut | 289c300 | 2012-09-14 22:33:21 +0200 | [diff] [blame] | 146 | |
Simon Glass | e3057f3 | 2018-10-01 11:55:15 -0600 | [diff] [blame] | 147 | #ifdef CONFIG_DEBUG_UART_SANDBOX |
| 148 | |
| 149 | #include <debug_uart.h> |
| 150 | |
| 151 | static inline void _debug_uart_init(void) |
| 152 | { |
| 153 | } |
| 154 | |
| 155 | static inline void _debug_uart_putc(int ch) |
| 156 | { |
| 157 | os_putc(ch); |
| 158 | } |
| 159 | |
| 160 | DEBUG_UART_FUNCS |
| 161 | |
| 162 | #endif /* CONFIG_DEBUG_UART_SANDBOX */ |
| 163 | |
Andy Shevchenko | 08e9879 | 2018-11-20 23:52:32 +0200 | [diff] [blame] | 164 | static 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 Chotard | 70ed0ea | 2018-08-03 15:07:41 +0200 | [diff] [blame] | 176 | static 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 Shevchenko | 44f21da | 2018-11-20 23:52:33 +0200 | [diff] [blame] | 189 | static 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 Shevchenko | 106930e | 2020-02-27 17:21:54 +0200 | [diff] [blame] | 199 | .clock = SERIAL_DEFAULT_CLOCK, |
Andy Shevchenko | 44f21da | 2018-11-20 23:52:33 +0200 | [diff] [blame] | 200 | }; |
| 201 | |
| 202 | if (!serial_info) |
| 203 | return -EINVAL; |
| 204 | |
| 205 | *serial_info = info; |
| 206 | |
| 207 | return 0; |
| 208 | } |
| 209 | |
Simon Glass | 1a823a9 | 2014-09-04 16:27:28 -0600 | [diff] [blame] | 210 | static const char * const ansi_colour[] = { |
| 211 | "black", "red", "green", "yellow", "blue", "megenta", "cyan", |
| 212 | "white", |
| 213 | }; |
| 214 | |
| 215 | static 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 Glass | a91e48b | 2019-09-25 08:55:53 -0600 | [diff] [blame] | 221 | if (CONFIG_IS_ENABLED(OF_PLATDATA)) |
| 222 | return 0; |
Simon Glass | 1a823a9 | 2014-09-04 16:27:28 -0600 | [diff] [blame] | 223 | plat->colour = -1; |
Simon Glass | dd79d6e | 2017-01-17 16:52:55 -0700 | [diff] [blame] | 224 | colour = fdt_getprop(gd->fdt_blob, dev_of_offset(dev), |
Simon Glass | 1a823a9 | 2014-09-04 16:27:28 -0600 | [diff] [blame] | 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 | |
Simon Glass | e587069 | 2014-09-04 16:27:27 -0600 | [diff] [blame] | 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, |
Andy Shevchenko | 08e9879 | 2018-11-20 23:52:32 +0200 | [diff] [blame] | 242 | .getconfig = sandbox_serial_getconfig, |
Patrice Chotard | 70ed0ea | 2018-08-03 15:07:41 +0200 | [diff] [blame] | 243 | .setconfig = sandbox_serial_setconfig, |
Andy Shevchenko | 44f21da | 2018-11-20 23:52:33 +0200 | [diff] [blame] | 244 | .getinfo = sandbox_serial_getinfo, |
Marek Vasut | 289c300 | 2012-09-14 22:33:21 +0200 | [diff] [blame] | 245 | }; |
| 246 | |
Simon Glass | e587069 | 2014-09-04 16:27:27 -0600 | [diff] [blame] | 247 | static const struct udevice_id sandbox_serial_ids[] = { |
| 248 | { .compatible = "sandbox,serial" }, |
| 249 | { } |
| 250 | }; |
Marek Vasut | 289c300 | 2012-09-14 22:33:21 +0200 | [diff] [blame] | 251 | |
Walter Lozano | 2901ac6 | 2020-06-25 01:10:04 -0300 | [diff] [blame] | 252 | U_BOOT_DRIVER(sandbox_serial) = { |
| 253 | .name = "sandbox_serial", |
Simon Glass | e587069 | 2014-09-04 16:27:27 -0600 | [diff] [blame] | 254 | .id = UCLASS_SERIAL, |
| 255 | .of_match = sandbox_serial_ids, |
Simon Glass | 1a823a9 | 2014-09-04 16:27:28 -0600 | [diff] [blame] | 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), |
Simon Glass | e587069 | 2014-09-04 16:27:27 -0600 | [diff] [blame] | 259 | .probe = sandbox_serial_probe, |
Simon Glass | 1a823a9 | 2014-09-04 16:27:28 -0600 | [diff] [blame] | 260 | .remove = sandbox_serial_remove, |
Simon Glass | e587069 | 2014-09-04 16:27:27 -0600 | [diff] [blame] | 261 | .ops = &sandbox_serial_ops, |
| 262 | .flags = DM_FLAG_PRE_RELOC, |
| 263 | }; |
| 264 | |
Simon Glass | cb90bd3 | 2020-10-03 11:31:23 -0600 | [diff] [blame] | 265 | #if !CONFIG_IS_ENABLED(OF_PLATDATA) |
Simon Glass | 1a823a9 | 2014-09-04 16:27:28 -0600 | [diff] [blame] | 266 | static const struct sandbox_serial_platdata platdata_non_fdt = { |
| 267 | .colour = -1, |
| 268 | }; |
| 269 | |
Simon Glass | e587069 | 2014-09-04 16:27:27 -0600 | [diff] [blame] | 270 | U_BOOT_DEVICE(serial_sandbox_non_fdt) = { |
Walter Lozano | 2901ac6 | 2020-06-25 01:10:04 -0300 | [diff] [blame] | 271 | .name = "sandbox_serial", |
Simon Glass | 1a823a9 | 2014-09-04 16:27:28 -0600 | [diff] [blame] | 272 | .platdata = &platdata_non_fdt, |
Simon Glass | e587069 | 2014-09-04 16:27:27 -0600 | [diff] [blame] | 273 | }; |
Simon Glass | cb90bd3 | 2020-10-03 11:31:23 -0600 | [diff] [blame] | 274 | #endif |