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