drivers/serial/sandbox.c

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