blob: 43c028ebe63dfd22c72b5023ad79b6ec53fa59e7 [file] [log] [blame]
Simon Glass57d92752014-09-04 16:27:26 -06001/*
2 * Copyright (c) 2014 The Chromium OS Authors.
3 *
4 * SPDX-License-Identifier: GPL-2.0+
5 */
6
7#include <common.h>
8#include <dm.h>
Simon Glassad1b81c2014-10-29 13:09:03 -06009#include <environment.h>
Simon Glass57d92752014-09-04 16:27:26 -060010#include <errno.h>
11#include <fdtdec.h>
12#include <os.h>
13#include <serial.h>
14#include <stdio_dev.h>
Simon Glassc487fd42014-10-22 21:37:02 -060015#include <watchdog.h>
Simon Glass57d92752014-09-04 16:27:26 -060016#include <dm/lists.h>
17#include <dm/device-internal.h>
18
19DECLARE_GLOBAL_DATA_PTR;
20
Simon Glassad1b81c2014-10-29 13:09:03 -060021/*
22 * Table with supported baudrates (defined in config_xyz.h)
23 */
24static const unsigned long baudrate_table[] = CONFIG_SYS_BAUDRATE_TABLE;
25
Simon Glass57d92752014-09-04 16:27:26 -060026#ifndef CONFIG_SYS_MALLOC_F_LEN
27#error "Serial is required before relocation - define CONFIG_SYS_MALLOC_F_LEN to make this work"
28#endif
29
30static void serial_find_console_or_panic(void)
31{
Simon Glass6bdc5932015-10-17 19:41:17 -060032 const void *blob = gd->fdt_blob;
Simon Glass469a5792014-11-10 18:00:20 -070033 struct udevice *dev;
Simon Glass57d92752014-09-04 16:27:26 -060034 int node;
35
Simon Glassb484b0d2016-07-04 11:58:04 -060036 if (CONFIG_IS_ENABLED(OF_PLATDATA)) {
37 uclass_first_device(UCLASS_SERIAL, &dev);
38 if (dev) {
39 gd->cur_serial_dev = dev;
40 return;
41 }
42 } else if (CONFIG_IS_ENABLED(OF_CONTROL) && blob) {
Simon Glasse9fc0582015-05-12 14:55:05 -060043 /* Check for a chosen console */
Simon Glass6bdc5932015-10-17 19:41:17 -060044 node = fdtdec_get_chosen_node(blob, "stdout-path");
45 if (node < 0) {
46 const char *str, *p, *name;
47
48 /*
49 * Deal with things like
50 * stdout-path = "serial0:115200n8";
51 *
52 * We need to look up the alias and then follow it to
53 * the correct node.
54 */
55 str = fdtdec_get_chosen_prop(blob, "stdout-path");
56 if (str) {
57 p = strchr(str, ':');
58 name = fdt_get_alias_namelen(blob, str,
59 p ? p - str : strlen(str));
60 if (name)
61 node = fdt_path_offset(blob, name);
62 }
63 }
Simon Glasse9fc0582015-05-12 14:55:05 -060064 if (node < 0)
Simon Glass6bdc5932015-10-17 19:41:17 -060065 node = fdt_path_offset(blob, "console");
Simon Glasse9fc0582015-05-12 14:55:05 -060066 if (!uclass_get_device_by_of_offset(UCLASS_SERIAL, node,
67 &dev)) {
Simon Glass469a5792014-11-10 18:00:20 -070068 gd->cur_serial_dev = dev;
Simon Glass57d92752014-09-04 16:27:26 -060069 return;
Simon Glass469a5792014-11-10 18:00:20 -070070 }
Simon Glasse9fc0582015-05-12 14:55:05 -060071
72 /*
Stefan Roeseeb623b92015-11-26 13:38:43 +010073 * If the console is not marked to be bound before relocation,
74 * bind it anyway.
75 */
Simon Glasse9fc0582015-05-12 14:55:05 -060076 if (node > 0 &&
Simon Glass6bdc5932015-10-17 19:41:17 -060077 !lists_bind_fdt(gd->dm_root, blob, node, &dev)) {
Simon Glasse9fc0582015-05-12 14:55:05 -060078 if (!device_probe(dev)) {
79 gd->cur_serial_dev = dev;
80 return;
81 }
82 }
Simon Glassaf282242015-03-06 13:19:03 -070083 }
Simon Glass6bdc5932015-10-17 19:41:17 -060084 if (!SPL_BUILD || !CONFIG_IS_ENABLED(OF_CONTROL) || !blob) {
Simon Glasse9fc0582015-05-12 14:55:05 -060085 /*
Stefan Roeseeb623b92015-11-26 13:38:43 +010086 * Try to use CONFIG_CONS_INDEX if available (it is numbered
87 * from 1!).
88 *
89 * Failing that, get the device with sequence number 0, or in
90 * extremis just the first serial device we can find. But we
91 * insist on having a console (even if it is silent).
92 */
Simon Glass91155c62014-10-22 21:37:06 -060093#ifdef CONFIG_CONS_INDEX
94#define INDEX (CONFIG_CONS_INDEX - 1)
95#else
96#define INDEX 0
97#endif
Simon Glasse9fc0582015-05-12 14:55:05 -060098 if (!uclass_get_device_by_seq(UCLASS_SERIAL, INDEX, &dev) ||
99 !uclass_get_device(UCLASS_SERIAL, INDEX, &dev) ||
Simon Glass753812c2015-07-31 09:31:20 -0600100 (!uclass_first_device(UCLASS_SERIAL, &dev) && dev)) {
Simon Glasse9fc0582015-05-12 14:55:05 -0600101 gd->cur_serial_dev = dev;
102 return;
103 }
Simon Glass91155c62014-10-22 21:37:06 -0600104#undef INDEX
Simon Glasse9fc0582015-05-12 14:55:05 -0600105 }
106
Hans de Goede8c458582015-08-08 17:45:18 +0200107#ifdef CONFIG_REQUIRE_SERIAL_CONSOLE
Simon Glasse9fc0582015-05-12 14:55:05 -0600108 panic_str("No serial driver found");
Hans de Goede8c458582015-08-08 17:45:18 +0200109#endif
Simon Glass57d92752014-09-04 16:27:26 -0600110}
111
112/* Called prior to relocation */
113int serial_init(void)
114{
115 serial_find_console_or_panic();
116 gd->flags |= GD_FLG_SERIAL_READY;
117
118 return 0;
119}
120
121/* Called after relocation */
122void serial_initialize(void)
123{
Simon Glasse4d6ab02016-03-11 22:06:51 -0700124 serial_init();
Simon Glass57d92752014-09-04 16:27:26 -0600125}
126
Masahiro Yamadaeea5a4c2014-10-23 22:26:08 +0900127static void _serial_putc(struct udevice *dev, char ch)
Simon Glass57d92752014-09-04 16:27:26 -0600128{
Masahiro Yamadabac64462014-10-23 22:26:06 +0900129 struct dm_serial_ops *ops = serial_get_ops(dev);
Simon Glass57d92752014-09-04 16:27:26 -0600130 int err;
131
Alison Wangc5917b42016-03-02 11:00:36 +0800132 if (ch == '\n')
133 _serial_putc(dev, '\r');
134
Simon Glass57d92752014-09-04 16:27:26 -0600135 do {
Masahiro Yamadabac64462014-10-23 22:26:06 +0900136 err = ops->putc(dev, ch);
Simon Glass57d92752014-09-04 16:27:26 -0600137 } while (err == -EAGAIN);
Simon Glass57d92752014-09-04 16:27:26 -0600138}
139
Masahiro Yamadaeea5a4c2014-10-23 22:26:08 +0900140static void _serial_puts(struct udevice *dev, const char *str)
Simon Glass57d92752014-09-04 16:27:26 -0600141{
142 while (*str)
Masahiro Yamadaeea5a4c2014-10-23 22:26:08 +0900143 _serial_putc(dev, *str++);
Simon Glass57d92752014-09-04 16:27:26 -0600144}
145
Masahiro Yamadaeea5a4c2014-10-23 22:26:08 +0900146static int _serial_getc(struct udevice *dev)
Simon Glass57d92752014-09-04 16:27:26 -0600147{
Simon Glassb8893322014-10-01 19:57:23 -0600148 struct dm_serial_ops *ops = serial_get_ops(dev);
Simon Glass57d92752014-09-04 16:27:26 -0600149 int err;
150
151 do {
Simon Glassb8893322014-10-01 19:57:23 -0600152 err = ops->getc(dev);
Simon Glassc487fd42014-10-22 21:37:02 -0600153 if (err == -EAGAIN)
154 WATCHDOG_RESET();
Simon Glass57d92752014-09-04 16:27:26 -0600155 } while (err == -EAGAIN);
156
157 return err >= 0 ? err : 0;
158}
159
Masahiro Yamadaeea5a4c2014-10-23 22:26:08 +0900160static int _serial_tstc(struct udevice *dev)
161{
162 struct dm_serial_ops *ops = serial_get_ops(dev);
163
164 if (ops->pending)
165 return ops->pending(dev, true);
166
167 return 1;
168}
169
170void serial_putc(char ch)
171{
Hans de Goede8c458582015-08-08 17:45:18 +0200172 if (gd->cur_serial_dev)
173 _serial_putc(gd->cur_serial_dev, ch);
Masahiro Yamadaeea5a4c2014-10-23 22:26:08 +0900174}
175
176void serial_puts(const char *str)
177{
Hans de Goede8c458582015-08-08 17:45:18 +0200178 if (gd->cur_serial_dev)
179 _serial_puts(gd->cur_serial_dev, str);
Masahiro Yamadaeea5a4c2014-10-23 22:26:08 +0900180}
181
Simon Glassb8893322014-10-01 19:57:23 -0600182int serial_getc(void)
183{
Hans de Goede8c458582015-08-08 17:45:18 +0200184 if (!gd->cur_serial_dev)
185 return 0;
186
Simon Glass469a5792014-11-10 18:00:20 -0700187 return _serial_getc(gd->cur_serial_dev);
Masahiro Yamadaeea5a4c2014-10-23 22:26:08 +0900188}
189
190int serial_tstc(void)
191{
Hans de Goede8c458582015-08-08 17:45:18 +0200192 if (!gd->cur_serial_dev)
193 return 0;
194
Simon Glass469a5792014-11-10 18:00:20 -0700195 return _serial_tstc(gd->cur_serial_dev);
Masahiro Yamadaeea5a4c2014-10-23 22:26:08 +0900196}
197
198void serial_setbrg(void)
199{
Hans de Goede8c458582015-08-08 17:45:18 +0200200 struct dm_serial_ops *ops;
Masahiro Yamadaeea5a4c2014-10-23 22:26:08 +0900201
Hans de Goede8c458582015-08-08 17:45:18 +0200202 if (!gd->cur_serial_dev)
203 return;
204
205 ops = serial_get_ops(gd->cur_serial_dev);
Masahiro Yamadaeea5a4c2014-10-23 22:26:08 +0900206 if (ops->setbrg)
Simon Glass469a5792014-11-10 18:00:20 -0700207 ops->setbrg(gd->cur_serial_dev, gd->baudrate);
Simon Glassb8893322014-10-01 19:57:23 -0600208}
209
Simon Glass57d92752014-09-04 16:27:26 -0600210void serial_stdio_init(void)
211{
212}
213
Simon Glass92c55b62015-12-13 21:36:58 -0700214#if defined(CONFIG_DM_STDIO) && CONFIG_IS_ENABLED(SERIAL_PRESENT)
Simon Glassb8893322014-10-01 19:57:23 -0600215static void serial_stub_putc(struct stdio_dev *sdev, const char ch)
Simon Glass57d92752014-09-04 16:27:26 -0600216{
Masahiro Yamadaeea5a4c2014-10-23 22:26:08 +0900217 _serial_putc(sdev->priv, ch);
Simon Glass57d92752014-09-04 16:27:26 -0600218}
Simon Glass236f2bd2014-11-10 17:16:48 -0700219#endif
Simon Glass57d92752014-09-04 16:27:26 -0600220
221void serial_stub_puts(struct stdio_dev *sdev, const char *str)
222{
Masahiro Yamadaeea5a4c2014-10-23 22:26:08 +0900223 _serial_puts(sdev->priv, str);
Simon Glass57d92752014-09-04 16:27:26 -0600224}
225
226int serial_stub_getc(struct stdio_dev *sdev)
227{
Masahiro Yamadaeea5a4c2014-10-23 22:26:08 +0900228 return _serial_getc(sdev->priv);
Simon Glass57d92752014-09-04 16:27:26 -0600229}
230
231int serial_stub_tstc(struct stdio_dev *sdev)
232{
Masahiro Yamadaeea5a4c2014-10-23 22:26:08 +0900233 return _serial_tstc(sdev->priv);
Simon Glass57d92752014-09-04 16:27:26 -0600234}
235
Simon Glassad1b81c2014-10-29 13:09:03 -0600236/**
237 * on_baudrate() - Update the actual baudrate when the env var changes
238 *
239 * This will check for a valid baudrate and only apply it if valid.
240 */
241static int on_baudrate(const char *name, const char *value, enum env_op op,
242 int flags)
243{
244 int i;
245 int baudrate;
246
247 switch (op) {
248 case env_op_create:
249 case env_op_overwrite:
250 /*
251 * Switch to new baudrate if new baudrate is supported
252 */
253 baudrate = simple_strtoul(value, NULL, 10);
254
255 /* Not actually changing */
256 if (gd->baudrate == baudrate)
257 return 0;
258
259 for (i = 0; i < ARRAY_SIZE(baudrate_table); ++i) {
260 if (baudrate == baudrate_table[i])
261 break;
262 }
263 if (i == ARRAY_SIZE(baudrate_table)) {
264 if ((flags & H_FORCE) == 0)
265 printf("## Baudrate %d bps not supported\n",
266 baudrate);
267 return 1;
268 }
269 if ((flags & H_INTERACTIVE) != 0) {
270 printf("## Switch baudrate to %d bps and press ENTER ...\n",
271 baudrate);
272 udelay(50000);
273 }
274
275 gd->baudrate = baudrate;
276
277 serial_setbrg();
278
279 udelay(50000);
280
281 if ((flags & H_INTERACTIVE) != 0)
282 while (1) {
283 if (getc() == '\r')
284 break;
285 }
286
287 return 0;
288 case env_op_delete:
289 printf("## Baudrate may not be deleted\n");
290 return 1;
291 default:
292 return 0;
293 }
294}
295U_BOOT_ENV_CALLBACK(baudrate, on_baudrate);
296
Simon Glass92c55b62015-12-13 21:36:58 -0700297#if CONFIG_IS_ENABLED(SERIAL_PRESENT)
Simon Glass57d92752014-09-04 16:27:26 -0600298static int serial_post_probe(struct udevice *dev)
299{
Simon Glass57d92752014-09-04 16:27:26 -0600300 struct dm_serial_ops *ops = serial_get_ops(dev);
Simon Glass236f2bd2014-11-10 17:16:48 -0700301#ifdef CONFIG_DM_STDIO
Simon Glasse564f052015-03-05 12:25:20 -0700302 struct serial_dev_priv *upriv = dev_get_uclass_priv(dev);
Simon Glass236f2bd2014-11-10 17:16:48 -0700303 struct stdio_dev sdev;
304#endif
Simon Glass57d92752014-09-04 16:27:26 -0600305 int ret;
306
Michal Simek484fdf52015-02-02 16:31:59 +0100307#if defined(CONFIG_NEEDS_MANUAL_RELOC)
308 if (ops->setbrg)
309 ops->setbrg += gd->reloc_off;
310 if (ops->getc)
311 ops->getc += gd->reloc_off;
312 if (ops->putc)
313 ops->putc += gd->reloc_off;
314 if (ops->pending)
315 ops->pending += gd->reloc_off;
316 if (ops->clear)
317 ops->clear += gd->reloc_off;
318#if CONFIG_POST & CONFIG_SYS_POST_UART
319 if (ops->loop)
320 ops->loop += gd->reloc_off
321#endif
322#endif
Simon Glass57d92752014-09-04 16:27:26 -0600323 /* Set the baud rate */
324 if (ops->setbrg) {
325 ret = ops->setbrg(dev, gd->baudrate);
326 if (ret)
327 return ret;
328 }
329
Simon Glass236f2bd2014-11-10 17:16:48 -0700330#ifdef CONFIG_DM_STDIO
Simon Glass57d92752014-09-04 16:27:26 -0600331 if (!(gd->flags & GD_FLG_RELOC))
332 return 0;
Simon Glass57d92752014-09-04 16:27:26 -0600333 memset(&sdev, '\0', sizeof(sdev));
334
335 strncpy(sdev.name, dev->name, sizeof(sdev.name));
336 sdev.flags = DEV_FLAGS_OUTPUT | DEV_FLAGS_INPUT;
337 sdev.priv = dev;
338 sdev.putc = serial_stub_putc;
339 sdev.puts = serial_stub_puts;
340 sdev.getc = serial_stub_getc;
341 sdev.tstc = serial_stub_tstc;
342 stdio_register_dev(&sdev, &upriv->sdev);
Simon Glass236f2bd2014-11-10 17:16:48 -0700343#endif
Simon Glass57d92752014-09-04 16:27:26 -0600344 return 0;
345}
346
347static int serial_pre_remove(struct udevice *dev)
348{
Simon Glass869588d2016-10-17 20:13:02 -0600349#if CONFIG_IS_ENABLED(SYS_STDIO_DEREGISTER)
Simon Glasse564f052015-03-05 12:25:20 -0700350 struct serial_dev_priv *upriv = dev_get_uclass_priv(dev);
Simon Glass57d92752014-09-04 16:27:26 -0600351
Hans de Goede4a742982014-10-10 18:30:17 +0200352 if (stdio_deregister_dev(upriv->sdev, 0))
Simon Glass57d92752014-09-04 16:27:26 -0600353 return -EPERM;
354#endif
355
356 return 0;
357}
358
359UCLASS_DRIVER(serial) = {
360 .id = UCLASS_SERIAL,
361 .name = "serial",
Simon Glass9cc36a22015-01-25 08:27:05 -0700362 .flags = DM_UC_FLAG_SEQ_ALIAS,
Simon Glass57d92752014-09-04 16:27:26 -0600363 .post_probe = serial_post_probe,
364 .pre_remove = serial_pre_remove,
365 .per_device_auto_alloc_size = sizeof(struct serial_dev_priv),
366};
Simon Glass92c55b62015-12-13 21:36:58 -0700367#endif