drivers/serial/serial-uclass.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (c) 2014 The Chromium OS Authors.
   4  */
   5
   6 #include <common.h>
   7 #include <dm.h>
   8 #include <env_internal.h>
   9 #include <errno.h>
  10 #include <malloc.h>
  11 #include <os.h>
  12 #include <serial.h>
  13 #include <stdio_dev.h>
  14 #include <watchdog.h>
  15 #include <dm/lists.h>
  16 #include <dm/device-internal.h>
  17 #include <dm/of_access.h>
  18
  19 DECLARE_GLOBAL_DATA_PTR;
  20
  21 /*
  22  * Table with supported baudrates (defined in config_xyz.h)
  23  */
  24 static const unsigned long baudrate_table[] = CONFIG_SYS_BAUDRATE_TABLE;
  25
  26 #if !CONFIG_VAL(SYS_MALLOC_F_LEN)
  27 #error "Serial is required before relocation - define CONFIG_$(SPL_)SYS_MALLOC_F_LEN to make this work"
  28 #endif
  29
  30 #if CONFIG_IS_ENABLED(SERIAL_PRESENT)
  31 static int serial_check_stdout(const void *blob, struct udevice **devp)
  32 {
  33         int node = -1;
  34         const char *str, *p, *name;
  35         int namelen;
  36
  37         /* Check for a chosen console */
  38         str = fdtdec_get_chosen_prop(blob, "stdout-path");
  39         if (str) {
  40                 p = strchr(str, ':');
  41                 namelen = p ? p - str : strlen(str);
  42                 node = fdt_path_offset_namelen(blob, str, namelen);
  43
  44                 if (node < 0) {
  45                         /*
  46                          * Deal with things like
  47                          *      stdout-path = "serial0:115200n8";
  48                          *
  49                          * We need to look up the alias and then follow it to
  50                          * the correct node.
  51                          */
  52                         name = fdt_get_alias_namelen(blob, str, namelen);
  53                         if (name)
  54                                 node = fdt_path_offset(blob, name);
  55                 }
  56         }
  57
  58         if (node < 0)
  59                 node = fdt_path_offset(blob, "console");
  60         if (!uclass_get_device_by_of_offset(UCLASS_SERIAL, node, devp))
  61                 return 0;
  62
  63         /*
  64          * If the console is not marked to be bound before relocation, bind it
  65          * anyway.
  66          */
  67         if (node > 0 && !lists_bind_fdt(gd->dm_root, offset_to_ofnode(node),
  68                                         devp, false)) {
  69                 if (!device_probe(*devp))
  70                         return 0;
  71         }
  72
  73         return -ENODEV;
  74 }
  75
  76 static void serial_find_console_or_panic(void)
  77 {
  78         const void *blob = gd->fdt_blob;
  79         struct udevice *dev;
  80 #ifdef CONFIG_SERIAL_SEARCH_ALL
  81         int ret;
  82 #endif
  83
  84         if (CONFIG_IS_ENABLED(OF_PLATDATA)) {
  85                 uclass_first_device(UCLASS_SERIAL, &dev);
  86                 if (dev) {
  87                         gd->cur_serial_dev = dev;
  88                         return;
  89                 }
  90         } else if (CONFIG_IS_ENABLED(OF_CONTROL) && blob) {
  91                 /* Live tree has support for stdout */
  92                 if (of_live_active()) {
  93                         struct device_node *np = of_get_stdout();
  94
  95                         if (np && !uclass_get_device_by_ofnode(UCLASS_SERIAL,
  96                                         np_to_ofnode(np), &dev)) {
  97                                 gd->cur_serial_dev = dev;
  98                                 return;
  99                         }
 100                 } else {
 101                         if (!serial_check_stdout(blob, &dev)) {
 102                                 gd->cur_serial_dev = dev;
 103                                 return;
 104                         }
 105                 }
 106         }
 107         if (!SPL_BUILD || !CONFIG_IS_ENABLED(OF_CONTROL) || !blob) {
 108                 /*
 109                  * Try to use CONFIG_CONS_INDEX if available (it is numbered
 110                  * from 1!).
 111                  *
 112                  * Failing that, get the device with sequence number 0, or in
 113                  * extremis just the first working serial device we can find.
 114                  * But we insist on having a console (even if it is silent).
 115                  */
 116 #ifdef CONFIG_CONS_INDEX
 117 #define INDEX (CONFIG_CONS_INDEX - 1)
 118 #else
 119 #define INDEX 0
 120 #endif
 121
 122 #ifdef CONFIG_SERIAL_SEARCH_ALL
 123                 if (!uclass_get_device_by_seq(UCLASS_SERIAL, INDEX, &dev) ||
 124                     !uclass_get_device(UCLASS_SERIAL, INDEX, &dev)) {
 125                         if (dev->flags & DM_FLAG_ACTIVATED) {
 126                                 gd->cur_serial_dev = dev;
 127                                 return;
 128                         }
 129                 }
 130
 131                 /* Search for any working device */
 132                 for (ret = uclass_first_device_check(UCLASS_SERIAL, &dev);
 133                      dev;
 134                      ret = uclass_next_device_check(&dev)) {
 135                         if (!ret) {
 136                                 /* Device did succeed probing */
 137                                 gd->cur_serial_dev = dev;
 138                                 return;
 139                         }
 140                 }
 141 #else
 142                 if (!uclass_get_device_by_seq(UCLASS_SERIAL, INDEX, &dev) ||
 143                     !uclass_get_device(UCLASS_SERIAL, INDEX, &dev) ||
 144                     (!uclass_first_device(UCLASS_SERIAL, &dev) && dev)) {
 145                         gd->cur_serial_dev = dev;
 146                         return;
 147                 }
 148 #endif
 149
 150 #undef INDEX
 151         }
 152
 153 #ifdef CONFIG_REQUIRE_SERIAL_CONSOLE
 154         panic_str("No serial driver found");
 155 #endif
 156 }
 157 #endif /* CONFIG_SERIAL_PRESENT */
 158
 159 /* Called prior to relocation */
 160 int serial_init(void)
 161 {
 162 #if CONFIG_IS_ENABLED(SERIAL_PRESENT)
 163         serial_find_console_or_panic();
 164         gd->flags |= GD_FLG_SERIAL_READY;
 165         serial_setbrg();
 166 #endif
 167
 168         return 0;
 169 }
 170
 171 /* Called after relocation */
 172 void serial_initialize(void)
 173 {
 174         serial_init();
 175 }
 176
 177 static void _serial_putc(struct udevice *dev, char ch)
 178 {
 179         struct dm_serial_ops *ops = serial_get_ops(dev);
 180         int err;
 181
 182         if (ch == '\n')
 183                 _serial_putc(dev, '\r');
 184
 185         do {
 186                 err = ops->putc(dev, ch);
 187         } while (err == -EAGAIN);
 188 }
 189
 190 static void _serial_puts(struct udevice *dev, const char *str)
 191 {
 192         while (*str)
 193                 _serial_putc(dev, *str++);
 194 }
 195
 196 static int __serial_getc(struct udevice *dev)
 197 {
 198         struct dm_serial_ops *ops = serial_get_ops(dev);
 199         int err;
 200
 201         do {
 202                 err = ops->getc(dev);
 203                 if (err == -EAGAIN)
 204                         WATCHDOG_RESET();
 205         } while (err == -EAGAIN);
 206
 207         return err >= 0 ? err : 0;
 208 }
 209
 210 static int __serial_tstc(struct udevice *dev)
 211 {
 212         struct dm_serial_ops *ops = serial_get_ops(dev);
 213
 214         if (ops->pending)
 215                 return ops->pending(dev, true);
 216
 217         return 1;
 218 }
 219
 220 #if CONFIG_IS_ENABLED(SERIAL_RX_BUFFER)
 221 static int _serial_tstc(struct udevice *dev)
 222 {
 223         struct serial_dev_priv *upriv = dev_get_uclass_priv(dev);
 224
 225         /* Read all available chars into the RX buffer */
 226         while (__serial_tstc(dev)) {
 227                 upriv->buf[upriv->wr_ptr++] = __serial_getc(dev);
 228                 upriv->wr_ptr %= CONFIG_SERIAL_RX_BUFFER_SIZE;
 229         }
 230
 231         return upriv->rd_ptr != upriv->wr_ptr ? 1 : 0;
 232 }
 233
 234 static int _serial_getc(struct udevice *dev)
 235 {
 236         struct serial_dev_priv *upriv = dev_get_uclass_priv(dev);
 237         char val;
 238
 239         if (upriv->rd_ptr == upriv->wr_ptr)
 240                 return __serial_getc(dev);
 241
 242         val = upriv->buf[upriv->rd_ptr++];
 243         upriv->rd_ptr %= CONFIG_SERIAL_RX_BUFFER_SIZE;
 244
 245         return val;
 246 }
 247
 248 #else /* CONFIG_IS_ENABLED(SERIAL_RX_BUFFER) */
 249
 250 static int _serial_getc(struct udevice *dev)
 251 {
 252         return __serial_getc(dev);
 253 }
 254
 255 static int _serial_tstc(struct udevice *dev)
 256 {
 257         return __serial_tstc(dev);
 258 }
 259 #endif /* CONFIG_IS_ENABLED(SERIAL_RX_BUFFER) */
 260
 261 void serial_putc(char ch)
 262 {
 263         if (gd->cur_serial_dev)
 264                 _serial_putc(gd->cur_serial_dev, ch);
 265 }
 266
 267 void serial_puts(const char *str)
 268 {
 269         if (gd->cur_serial_dev)
 270                 _serial_puts(gd->cur_serial_dev, str);
 271 }
 272
 273 int serial_getc(void)
 274 {
 275         if (!gd->cur_serial_dev)
 276                 return 0;
 277
 278         return _serial_getc(gd->cur_serial_dev);
 279 }
 280
 281 int serial_tstc(void)
 282 {
 283         if (!gd->cur_serial_dev)
 284                 return 0;
 285
 286         return _serial_tstc(gd->cur_serial_dev);
 287 }
 288
 289 void serial_setbrg(void)
 290 {
 291         struct dm_serial_ops *ops;
 292
 293         if (!gd->cur_serial_dev)
 294                 return;
 295
 296         ops = serial_get_ops(gd->cur_serial_dev);
 297         if (ops->setbrg)
 298                 ops->setbrg(gd->cur_serial_dev, gd->baudrate);
 299 }
 300
 301 int serial_getconfig(struct udevice *dev, uint *config)
 302 {
 303         struct dm_serial_ops *ops;
 304
 305         ops = serial_get_ops(dev);
 306         if (ops->getconfig)
 307                 return ops->getconfig(dev, config);
 308
 309         return 0;
 310 }
 311
 312 int serial_setconfig(struct udevice *dev, uint config)
 313 {
 314         struct dm_serial_ops *ops;
 315
 316         ops = serial_get_ops(dev);
 317         if (ops->setconfig)
 318                 return ops->setconfig(dev, config);
 319
 320         return 0;
 321 }
 322
 323 int serial_getinfo(struct udevice *dev, struct serial_device_info *info)
 324 {
 325         struct dm_serial_ops *ops;
 326
 327         if (!info)
 328                 return -EINVAL;
 329
 330         info->baudrate = gd->baudrate;
 331
 332         ops = serial_get_ops(dev);
 333         if (ops->getinfo)
 334                 return ops->getinfo(dev, info);
 335
 336         return -EINVAL;
 337 }
 338
 339 void serial_stdio_init(void)
 340 {
 341 }
 342
 343 #if defined(CONFIG_DM_STDIO)
 344
 345 #if CONFIG_IS_ENABLED(SERIAL_PRESENT)
 346 static void serial_stub_putc(struct stdio_dev *sdev, const char ch)
 347 {
 348         _serial_putc(sdev->priv, ch);
 349 }
 350 #endif
 351
 352 static void serial_stub_puts(struct stdio_dev *sdev, const char *str)
 353 {
 354         _serial_puts(sdev->priv, str);
 355 }
 356
 357 static int serial_stub_getc(struct stdio_dev *sdev)
 358 {
 359         return _serial_getc(sdev->priv);
 360 }
 361
 362 static int serial_stub_tstc(struct stdio_dev *sdev)
 363 {
 364         return _serial_tstc(sdev->priv);
 365 }
 366 #endif
 367
 368 /**
 369  * on_baudrate() - Update the actual baudrate when the env var changes
 370  *
 371  * This will check for a valid baudrate and only apply it if valid.
 372  */
 373 static int on_baudrate(const char *name, const char *value, enum env_op op,
 374         int flags)
 375 {
 376         int i;
 377         int baudrate;
 378
 379         switch (op) {
 380         case env_op_create:
 381         case env_op_overwrite:
 382                 /*
 383                  * Switch to new baudrate if new baudrate is supported
 384                  */
 385                 baudrate = simple_strtoul(value, NULL, 10);
 386
 387                 /* Not actually changing */
 388                 if (gd->baudrate == baudrate)
 389                         return 0;
 390
 391                 for (i = 0; i < ARRAY_SIZE(baudrate_table); ++i) {
 392                         if (baudrate == baudrate_table[i])
 393                                 break;
 394                 }
 395                 if (i == ARRAY_SIZE(baudrate_table)) {
 396                         if ((flags & H_FORCE) == 0)
 397                                 printf("## Baudrate %d bps not supported\n",
 398                                        baudrate);
 399                         return 1;
 400                 }
 401                 if ((flags & H_INTERACTIVE) != 0) {
 402                         printf("## Switch baudrate to %d bps and press ENTER ...\n",
 403                                baudrate);
 404                         udelay(50000);
 405                 }
 406
 407                 gd->baudrate = baudrate;
 408
 409                 serial_setbrg();
 410
 411                 udelay(50000);
 412
 413                 if ((flags & H_INTERACTIVE) != 0)
 414                         while (1) {
 415                                 if (getc() == '\r')
 416                                         break;
 417                         }
 418
 419                 return 0;
 420         case env_op_delete:
 421                 printf("## Baudrate may not be deleted\n");
 422                 return 1;
 423         default:
 424                 return 0;
 425         }
 426 }
 427 U_BOOT_ENV_CALLBACK(baudrate, on_baudrate);
 428
 429 #if CONFIG_IS_ENABLED(SERIAL_PRESENT)
 430 static int serial_post_probe(struct udevice *dev)
 431 {
 432         struct dm_serial_ops *ops = serial_get_ops(dev);
 433 #ifdef CONFIG_DM_STDIO
 434         struct serial_dev_priv *upriv = dev_get_uclass_priv(dev);
 435         struct stdio_dev sdev;
 436 #endif
 437         int ret;
 438
 439 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
 440         if (ops->setbrg)
 441                 ops->setbrg += gd->reloc_off;
 442         if (ops->getc)
 443                 ops->getc += gd->reloc_off;
 444         if (ops->putc)
 445                 ops->putc += gd->reloc_off;
 446         if (ops->pending)
 447                 ops->pending += gd->reloc_off;
 448         if (ops->clear)
 449                 ops->clear += gd->reloc_off;
 450         if (ops->getconfig)
 451                 ops->getconfig += gd->reloc_off;
 452         if (ops->setconfig)
 453                 ops->setconfig += gd->reloc_off;
 454 #if CONFIG_POST & CONFIG_SYS_POST_UART
 455         if (ops->loop)
 456                 ops->loop += gd->reloc_off;
 457 #endif
 458         if (ops->getinfo)
 459                 ops->getinfo += gd->reloc_off;
 460 #endif
 461         /* Set the baud rate */
 462         if (ops->setbrg) {
 463                 ret = ops->setbrg(dev, gd->baudrate);
 464                 if (ret)
 465                         return ret;
 466         }
 467
 468 #ifdef CONFIG_DM_STDIO
 469         if (!(gd->flags & GD_FLG_RELOC))
 470                 return 0;
 471         memset(&sdev, '\0', sizeof(sdev));
 472
 473         strncpy(sdev.name, dev->name, sizeof(sdev.name));
 474         sdev.flags = DEV_FLAGS_OUTPUT | DEV_FLAGS_INPUT | DEV_FLAGS_DM;
 475         sdev.priv = dev;
 476         sdev.putc = serial_stub_putc;
 477         sdev.puts = serial_stub_puts;
 478         sdev.getc = serial_stub_getc;
 479         sdev.tstc = serial_stub_tstc;
 480
 481 #if CONFIG_IS_ENABLED(SERIAL_RX_BUFFER)
 482         /* Allocate the RX buffer */
 483         upriv->buf = malloc(CONFIG_SERIAL_RX_BUFFER_SIZE);
 484 #endif
 485
 486         stdio_register_dev(&sdev, &upriv->sdev);
 487 #endif
 488         return 0;
 489 }
 490
 491 static int serial_pre_remove(struct udevice *dev)
 492 {
 493 #if CONFIG_IS_ENABLED(SYS_STDIO_DEREGISTER)
 494         struct serial_dev_priv *upriv = dev_get_uclass_priv(dev);
 495
 496         if (stdio_deregister_dev(upriv->sdev, true))
 497                 return -EPERM;
 498 #endif
 499
 500         return 0;
 501 }
 502
 503 UCLASS_DRIVER(serial) = {
 504         .id             = UCLASS_SERIAL,
 505         .name           = "serial",
 506         .flags          = DM_UC_FLAG_SEQ_ALIAS,
 507         .post_probe     = serial_post_probe,
 508         .pre_remove     = serial_pre_remove,
 509         .per_device_auto_alloc_size = sizeof(struct serial_dev_priv),
 510 };
 511 #endif