blob: 858e340f5937d0b7b5031042893063f19a905bd0 [file] [log] [blame]
Simon Glass7accb6e2011-10-03 19:26:46 +00001/*
2 * Copyright (c) 2011 The Chromium OS Authors.
Simon Glass7accb6e2011-10-03 19:26:46 +00003 *
Wolfgang Denk1a459662013-07-08 09:37:19 +02004 * SPDX-License-Identifier: GPL-2.0+
Simon Glass7accb6e2011-10-03 19:26:46 +00005 */
6
7/*
8 * This provide a test serial port. It provides an emulated serial port where
9 * a test program and read out the serial output and inject serial input for
10 * U-Boot.
11 */
12
13#include <common.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
Taylor Hutte1015502013-02-24 17:33:13 +000025/*
26 *
27 * serial_buf: A buffer that holds keyboard characters for the
Bin Menga1875592016-02-05 19:30:11 -080028 * Sandbox U-Boot.
Taylor Hutte1015502013-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 */
34static char serial_buf[16];
35static unsigned int serial_buf_write;
36static unsigned int serial_buf_read;
37
Simon Glass72e98222014-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 Glass890fcef2014-09-04 16:27:27 -060064static int sandbox_serial_probe(struct udevice *dev)
Simon Glass7accb6e2011-10-03 19:26:46 +000065{
Simon Glassffb87902014-02-27 13:26:22 -070066 struct sandbox_state *state = state_get_current();
Simon Glass72e98222014-09-04 16:27:28 -060067 struct sandbox_serial_priv *priv = dev_get_priv(dev);
Simon Glassffb87902014-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 Glass72e98222014-09-04 16:27:28 -060071 priv->start_of_line = 0;
72
73 return 0;
74}
75
76static int sandbox_serial_remove(struct udevice *dev)
77{
78 struct sandbox_serial_platdata *plat = dev->platdata;
79
80 if (plat->colour != -1)
81 output_ansi_reset();
Simon Glass890fcef2014-09-04 16:27:27 -060082
Simon Glass7accb6e2011-10-03 19:26:46 +000083 return 0;
84}
85
Simon Glass890fcef2014-09-04 16:27:27 -060086static int sandbox_serial_putc(struct udevice *dev, const char ch)
Simon Glass7accb6e2011-10-03 19:26:46 +000087{
Simon Glass72e98222014-09-04 16:27:28 -060088 struct sandbox_serial_priv *priv = dev_get_priv(dev);
89 struct sandbox_serial_platdata *plat = dev->platdata;
90
91 if (priv->start_of_line && plat->colour != -1) {
92 priv->start_of_line = false;
93 output_ansi_colour(plat->colour);
94 }
95
Simon Glass7accb6e2011-10-03 19:26:46 +000096 os_write(1, &ch, 1);
Simon Glass72e98222014-09-04 16:27:28 -060097 if (ch == '\n')
98 priv->start_of_line = true;
Simon Glass7accb6e2011-10-03 19:26:46 +000099
Simon Glass890fcef2014-09-04 16:27:27 -0600100 return 0;
Simon Glass7accb6e2011-10-03 19:26:46 +0000101}
102
Taylor Hutte1015502013-02-24 17:33:13 +0000103static unsigned int increment_buffer_index(unsigned int index)
Simon Glass7accb6e2011-10-03 19:26:46 +0000104{
Taylor Hutte1015502013-02-24 17:33:13 +0000105 return (index + 1) % ARRAY_SIZE(serial_buf);
Simon Glass7accb6e2011-10-03 19:26:46 +0000106}
107
Simon Glass890fcef2014-09-04 16:27:27 -0600108static int sandbox_serial_pending(struct udevice *dev, bool input)
Simon Glass7accb6e2011-10-03 19:26:46 +0000109{
Taylor Hutte1015502013-02-24 17:33:13 +0000110 const unsigned int next_index =
111 increment_buffer_index(serial_buf_write);
112 ssize_t count;
113
Simon Glass890fcef2014-09-04 16:27:27 -0600114 if (!input)
115 return 0;
116
Taylor Hutte1015502013-02-24 17:33:13 +0000117 os_usleep(100);
Simon Glass0110f502016-07-04 11:57:53 -0600118#ifndef CONFIG_SPL_BUILD
Simon Glass3ade5bc2016-01-18 19:52:25 -0700119 video_sync_all();
Simon Glass0110f502016-07-04 11:57:53 -0600120#endif
Taylor Hutte1015502013-02-24 17:33:13 +0000121 if (next_index == serial_buf_read)
122 return 1; /* buffer full */
123
124 count = os_read_no_block(0, &serial_buf[serial_buf_write], 1);
125 if (count == 1)
126 serial_buf_write = next_index;
Simon Glass890fcef2014-09-04 16:27:27 -0600127
Taylor Hutte1015502013-02-24 17:33:13 +0000128 return serial_buf_write != serial_buf_read;
129}
130
Simon Glass890fcef2014-09-04 16:27:27 -0600131static int sandbox_serial_getc(struct udevice *dev)
Taylor Hutte1015502013-02-24 17:33:13 +0000132{
133 int result;
134
Simon Glass890fcef2014-09-04 16:27:27 -0600135 if (!sandbox_serial_pending(dev, true))
136 return -EAGAIN; /* buffer empty */
Taylor Hutte1015502013-02-24 17:33:13 +0000137
138 result = serial_buf[serial_buf_read];
139 serial_buf_read = increment_buffer_index(serial_buf_read);
140 return result;
Simon Glass7accb6e2011-10-03 19:26:46 +0000141}
Marek Vasutcef46b72012-09-14 22:33:21 +0200142
Simon Glass72e98222014-09-04 16:27:28 -0600143static const char * const ansi_colour[] = {
144 "black", "red", "green", "yellow", "blue", "megenta", "cyan",
145 "white",
146};
147
148static int sandbox_serial_ofdata_to_platdata(struct udevice *dev)
149{
150 struct sandbox_serial_platdata *plat = dev->platdata;
151 const char *colour;
152 int i;
153
154 plat->colour = -1;
Simon Glasse160f7d2017-01-17 16:52:55 -0700155 colour = fdt_getprop(gd->fdt_blob, dev_of_offset(dev),
Simon Glass72e98222014-09-04 16:27:28 -0600156 "sandbox,text-colour", NULL);
157 if (colour) {
158 for (i = 0; i < ARRAY_SIZE(ansi_colour); i++) {
159 if (!strcmp(colour, ansi_colour[i])) {
160 plat->colour = i;
161 break;
162 }
163 }
164 }
165
166 return 0;
167}
168
Simon Glass890fcef2014-09-04 16:27:27 -0600169static const struct dm_serial_ops sandbox_serial_ops = {
170 .putc = sandbox_serial_putc,
171 .pending = sandbox_serial_pending,
172 .getc = sandbox_serial_getc,
Marek Vasutcef46b72012-09-14 22:33:21 +0200173};
174
Simon Glass890fcef2014-09-04 16:27:27 -0600175static const struct udevice_id sandbox_serial_ids[] = {
176 { .compatible = "sandbox,serial" },
177 { }
178};
Marek Vasutcef46b72012-09-14 22:33:21 +0200179
Simon Glass890fcef2014-09-04 16:27:27 -0600180U_BOOT_DRIVER(serial_sandbox) = {
181 .name = "serial_sandbox",
182 .id = UCLASS_SERIAL,
183 .of_match = sandbox_serial_ids,
Simon Glass72e98222014-09-04 16:27:28 -0600184 .ofdata_to_platdata = sandbox_serial_ofdata_to_platdata,
185 .platdata_auto_alloc_size = sizeof(struct sandbox_serial_platdata),
186 .priv_auto_alloc_size = sizeof(struct sandbox_serial_priv),
Simon Glass890fcef2014-09-04 16:27:27 -0600187 .probe = sandbox_serial_probe,
Simon Glass72e98222014-09-04 16:27:28 -0600188 .remove = sandbox_serial_remove,
Simon Glass890fcef2014-09-04 16:27:27 -0600189 .ops = &sandbox_serial_ops,
190 .flags = DM_FLAG_PRE_RELOC,
191};
192
Simon Glass72e98222014-09-04 16:27:28 -0600193static const struct sandbox_serial_platdata platdata_non_fdt = {
194 .colour = -1,
195};
196
Simon Glass890fcef2014-09-04 16:27:27 -0600197U_BOOT_DEVICE(serial_sandbox_non_fdt) = {
198 .name = "serial_sandbox",
Simon Glass72e98222014-09-04 16:27:28 -0600199 .platdata = &platdata_non_fdt,
Simon Glass890fcef2014-09-04 16:27:27 -0600200};