drivers/serial/serial.c

   1 /*
   2  * (C) Copyright 2004
   3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   4  *
   5  * SPDX-License-Identifier:     GPL-2.0+
   6  */
   7
   8 #include <common.h>
   9 #include <environment.h>
  10 #include <serial.h>
  11 #include <stdio_dev.h>
  12 #include <post.h>
  13 #include <linux/compiler.h>
  14 #include <errno.h>
  15
  16 DECLARE_GLOBAL_DATA_PTR;
  17
  18 static struct serial_device *serial_devices;
  19 static struct serial_device *serial_current;
  20 /*
  21  * Table with supported baudrates (defined in config_xyz.h)
  22  */
  23 static const unsigned long baudrate_table[] = CONFIG_SYS_BAUDRATE_TABLE;
  24
  25 /**
  26  * serial_null() - Void registration routine of a serial driver
  27  *
  28  * This routine implements a void registration routine of a serial
  29  * driver. The registration routine of a particular driver is aliased
  30  * to this empty function in case the driver is not compiled into
  31  * U-Boot.
  32  */
  33 static void serial_null(void)
  34 {
  35 }
  36
  37 /**
  38  * on_baudrate() - Update the actual baudrate when the env var changes
  39  *
  40  * This will check for a valid baudrate and only apply it if valid.
  41  */
  42 static int on_baudrate(const char *name, const char *value, enum env_op op,
  43         int flags)
  44 {
  45         int i;
  46         int baudrate;
  47
  48         switch (op) {
  49         case env_op_create:
  50         case env_op_overwrite:
  51                 /*
  52                  * Switch to new baudrate if new baudrate is supported
  53                  */
  54                 baudrate = simple_strtoul(value, NULL, 10);
  55
  56                 /* Not actually changing */
  57                 if (gd->baudrate == baudrate)
  58                         return 0;
  59
  60                 for (i = 0; i < ARRAY_SIZE(baudrate_table); ++i) {
  61                         if (baudrate == baudrate_table[i])
  62                                 break;
  63                 }
  64                 if (i == ARRAY_SIZE(baudrate_table)) {
  65                         if ((flags & H_FORCE) == 0)
  66                                 printf("## Baudrate %d bps not supported\n",
  67                                         baudrate);
  68                         return 1;
  69                 }
  70                 if ((flags & H_INTERACTIVE) != 0) {
  71                         printf("## Switch baudrate to %d"
  72                                 " bps and press ENTER ...\n", baudrate);
  73                         udelay(50000);
  74                 }
  75
  76                 gd->baudrate = baudrate;
  77
  78                 serial_setbrg();
  79
  80                 udelay(50000);
  81
  82                 if ((flags & H_INTERACTIVE) != 0)
  83                         while (1) {
  84                                 if (getc() == '\r')
  85                                         break;
  86                         }
  87
  88                 return 0;
  89         case env_op_delete:
  90                 printf("## Baudrate may not be deleted\n");
  91                 return 1;
  92         default:
  93                 return 0;
  94         }
  95 }
  96 U_BOOT_ENV_CALLBACK(baudrate, on_baudrate);
  97
  98 /**
  99  * serial_initfunc() - Forward declare of driver registration routine
 100  * @name:       Name of the real driver registration routine.
 101  *
 102  * This macro expands onto forward declaration of a driver registration
 103  * routine, which is then used below in serial_initialize() function.
 104  * The declaration is made weak and aliases to serial_null() so in case
 105  * the driver is not compiled in, the function is still declared and can
 106  * be used, but aliases to serial_null() and thus is optimized away.
 107  */
 108 #define serial_initfunc(name)                                   \
 109         void name(void)                                         \
 110                 __attribute__((weak, alias("serial_null")));
 111
 112 serial_initfunc(mpc8xx_serial_initialize);
 113 serial_initfunc(ns16550_serial_initialize);
 114 serial_initfunc(pxa_serial_initialize);
 115 serial_initfunc(s3c24xx_serial_initialize);
 116 serial_initfunc(s5p_serial_initialize);
 117 serial_initfunc(zynq_serial_initialize);
 118 serial_initfunc(bfin_serial_initialize);
 119 serial_initfunc(bfin_jtag_initialize);
 120 serial_initfunc(mpc512x_serial_initialize);
 121 serial_initfunc(uartlite_serial_initialize);
 122 serial_initfunc(au1x00_serial_initialize);
 123 serial_initfunc(asc_serial_initialize);
 124 serial_initfunc(jz_serial_initialize);
 125 serial_initfunc(mpc5xx_serial_initialize);
 126 serial_initfunc(mpc8260_scc_serial_initialize);
 127 serial_initfunc(mpc8260_smc_serial_initialize);
 128 serial_initfunc(mpc85xx_serial_initialize);
 129 serial_initfunc(iop480_serial_initialize);
 130 serial_initfunc(leon2_serial_initialize);
 131 serial_initfunc(leon3_serial_initialize);
 132 serial_initfunc(marvell_serial_initialize);
 133 serial_initfunc(amirix_serial_initialize);
 134 serial_initfunc(bmw_serial_initialize);
 135 serial_initfunc(cogent_serial_initialize);
 136 serial_initfunc(cpci750_serial_initialize);
 137 serial_initfunc(evb64260_serial_initialize);
 138 serial_initfunc(ml2_serial_initialize);
 139 serial_initfunc(sconsole_serial_initialize);
 140 serial_initfunc(p3mx_serial_initialize);
 141 serial_initfunc(altera_jtag_serial_initialize);
 142 serial_initfunc(altera_serial_initialize);
 143 serial_initfunc(atmel_serial_initialize);
 144 serial_initfunc(lpc32xx_serial_initialize);
 145 serial_initfunc(mcf_serial_initialize);
 146 serial_initfunc(oc_serial_initialize);
 147 serial_initfunc(sandbox_serial_initialize);
 148 serial_initfunc(clps7111_serial_initialize);
 149 serial_initfunc(imx_serial_initialize);
 150 serial_initfunc(ks8695_serial_initialize);
 151 serial_initfunc(lh7a40x_serial_initialize);
 152 serial_initfunc(max3100_serial_initialize);
 153 serial_initfunc(mxc_serial_initialize);
 154 serial_initfunc(pl01x_serial_initialize);
 155 serial_initfunc(sa1100_serial_initialize);
 156 serial_initfunc(sh_serial_initialize);
 157 serial_initfunc(arm_dcc_initialize);
 158 serial_initfunc(mxs_auart_initialize);
 159 serial_initfunc(arc_serial_initialize);
 160 serial_initfunc(uniphier_serial_initialize);
 161
 162 /**
 163  * serial_register() - Register serial driver with serial driver core
 164  * @dev:        Pointer to the serial driver structure
 165  *
 166  * This function registers the serial driver supplied via @dev with
 167  * serial driver core, thus making U-Boot aware of it and making it
 168  * available for U-Boot to use. On platforms that still require manual
 169  * relocation of constant variables, relocation of the supplied structure
 170  * is performed.
 171  */
 172 void serial_register(struct serial_device *dev)
 173 {
 174 #ifdef CONFIG_NEEDS_MANUAL_RELOC
 175         if (dev->start)
 176                 dev->start += gd->reloc_off;
 177         if (dev->stop)
 178                 dev->stop += gd->reloc_off;
 179         if (dev->setbrg)
 180                 dev->setbrg += gd->reloc_off;
 181         if (dev->getc)
 182                 dev->getc += gd->reloc_off;
 183         if (dev->tstc)
 184                 dev->tstc += gd->reloc_off;
 185         if (dev->putc)
 186                 dev->putc += gd->reloc_off;
 187         if (dev->puts)
 188                 dev->puts += gd->reloc_off;
 189 #endif
 190
 191         dev->next = serial_devices;
 192         serial_devices = dev;
 193 }
 194
 195 /**
 196  * serial_initialize() - Register all compiled-in serial port drivers
 197  *
 198  * This function registers all serial port drivers that are compiled
 199  * into the U-Boot binary with the serial core, thus making them
 200  * available to U-Boot to use. Lastly, this function assigns a default
 201  * serial port to the serial core. That serial port is then used as a
 202  * default output.
 203  */
 204 void serial_initialize(void)
 205 {
 206         mpc8xx_serial_initialize();
 207         ns16550_serial_initialize();
 208         pxa_serial_initialize();
 209         s3c24xx_serial_initialize();
 210         s5p_serial_initialize();
 211         mpc512x_serial_initialize();
 212         bfin_serial_initialize();
 213         bfin_jtag_initialize();
 214         uartlite_serial_initialize();
 215         zynq_serial_initialize();
 216         au1x00_serial_initialize();
 217         asc_serial_initialize();
 218         jz_serial_initialize();
 219         mpc5xx_serial_initialize();
 220         mpc8260_scc_serial_initialize();
 221         mpc8260_smc_serial_initialize();
 222         mpc85xx_serial_initialize();
 223         iop480_serial_initialize();
 224         leon2_serial_initialize();
 225         leon3_serial_initialize();
 226         marvell_serial_initialize();
 227         amirix_serial_initialize();
 228         bmw_serial_initialize();
 229         cogent_serial_initialize();
 230         cpci750_serial_initialize();
 231         evb64260_serial_initialize();
 232         ml2_serial_initialize();
 233         sconsole_serial_initialize();
 234         p3mx_serial_initialize();
 235         altera_jtag_serial_initialize();
 236         altera_serial_initialize();
 237         atmel_serial_initialize();
 238         lpc32xx_serial_initialize();
 239         mcf_serial_initialize();
 240         oc_serial_initialize();
 241         sandbox_serial_initialize();
 242         clps7111_serial_initialize();
 243         imx_serial_initialize();
 244         ks8695_serial_initialize();
 245         lh7a40x_serial_initialize();
 246         max3100_serial_initialize();
 247         mxc_serial_initialize();
 248         pl01x_serial_initialize();
 249         sa1100_serial_initialize();
 250         sh_serial_initialize();
 251         arm_dcc_initialize();
 252         mxs_auart_initialize();
 253         arc_serial_initialize();
 254         uniphier_serial_initialize();
 255
 256         serial_assign(default_serial_console()->name);
 257 }
 258
 259 int serial_stub_start(struct stdio_dev *sdev)
 260 {
 261         struct serial_device *dev = sdev->priv;
 262
 263         return dev->start();
 264 }
 265
 266 int serial_stub_stop(struct stdio_dev *sdev)
 267 {
 268         struct serial_device *dev = sdev->priv;
 269
 270         return dev->stop();
 271 }
 272
 273 void serial_stub_putc(struct stdio_dev *sdev, const char ch)
 274 {
 275         struct serial_device *dev = sdev->priv;
 276
 277         dev->putc(ch);
 278 }
 279
 280 void serial_stub_puts(struct stdio_dev *sdev, const char *str)
 281 {
 282         struct serial_device *dev = sdev->priv;
 283
 284         dev->puts(str);
 285 }
 286
 287 int serial_stub_getc(struct stdio_dev *sdev)
 288 {
 289         struct serial_device *dev = sdev->priv;
 290
 291         return dev->getc();
 292 }
 293
 294 int serial_stub_tstc(struct stdio_dev *sdev)
 295 {
 296         struct serial_device *dev = sdev->priv;
 297
 298         return dev->tstc();
 299 }
 300
 301 /**
 302  * serial_stdio_init() - Register serial ports with STDIO core
 303  *
 304  * This function generates a proxy driver for each serial port driver.
 305  * These proxy drivers then register with the STDIO core, making the
 306  * serial drivers available as STDIO devices.
 307  */
 308 void serial_stdio_init(void)
 309 {
 310         struct stdio_dev dev;
 311         struct serial_device *s = serial_devices;
 312
 313         while (s) {
 314                 memset(&dev, 0, sizeof(dev));
 315
 316                 strcpy(dev.name, s->name);
 317                 dev.flags = DEV_FLAGS_OUTPUT | DEV_FLAGS_INPUT;
 318
 319                 dev.start = serial_stub_start;
 320                 dev.stop = serial_stub_stop;
 321                 dev.putc = serial_stub_putc;
 322                 dev.puts = serial_stub_puts;
 323                 dev.getc = serial_stub_getc;
 324                 dev.tstc = serial_stub_tstc;
 325                 dev.priv = s;
 326
 327                 stdio_register(&dev);
 328
 329                 s = s->next;
 330         }
 331 }
 332
 333 /**
 334  * serial_assign() - Select the serial output device by name
 335  * @name:       Name of the serial driver to be used as default output
 336  *
 337  * This function configures the serial output multiplexing by
 338  * selecting which serial device will be used as default. In case
 339  * the STDIO "serial" device is selected as stdin/stdout/stderr,
 340  * the serial device previously configured by this function will be
 341  * used for the particular operation.
 342  *
 343  * Returns 0 on success, negative on error.
 344  */
 345 int serial_assign(const char *name)
 346 {
 347         struct serial_device *s;
 348
 349         for (s = serial_devices; s; s = s->next) {
 350                 if (strcmp(s->name, name))
 351                         continue;
 352                 serial_current = s;
 353                 return 0;
 354         }
 355
 356         return -EINVAL;
 357 }
 358
 359 /**
 360  * serial_reinit_all() - Reinitialize all compiled-in serial ports
 361  *
 362  * This function reinitializes all serial ports that are compiled
 363  * into U-Boot by calling their serial_start() functions.
 364  */
 365 void serial_reinit_all(void)
 366 {
 367         struct serial_device *s;
 368
 369         for (s = serial_devices; s; s = s->next)
 370                 s->start();
 371 }
 372
 373 /**
 374  * get_current() - Return pointer to currently selected serial port
 375  *
 376  * This function returns a pointer to currently selected serial port.
 377  * The currently selected serial port is altered by serial_assign()
 378  * function.
 379  *
 380  * In case this function is called before relocation or before any serial
 381  * port is configured, this function calls default_serial_console() to
 382  * determine the serial port. Otherwise, the configured serial port is
 383  * returned.
 384  *
 385  * Returns pointer to the currently selected serial port on success,
 386  * NULL on error.
 387  */
 388 static struct serial_device *get_current(void)
 389 {
 390         struct serial_device *dev;
 391
 392         if (!(gd->flags & GD_FLG_RELOC))
 393                 dev = default_serial_console();
 394         else if (!serial_current)
 395                 dev = default_serial_console();
 396         else
 397                 dev = serial_current;
 398
 399         /* We must have a console device */
 400         if (!dev) {
 401 #ifdef CONFIG_SPL_BUILD
 402                 puts("Cannot find console\n");
 403                 hang();
 404 #else
 405                 panic("Cannot find console\n");
 406 #endif
 407         }
 408
 409         return dev;
 410 }
 411
 412 /**
 413  * serial_init() - Initialize currently selected serial port
 414  *
 415  * This function initializes the currently selected serial port. This
 416  * usually involves setting up the registers of that particular port,
 417  * enabling clock and such. This function uses the get_current() call
 418  * to determine which port is selected.
 419  *
 420  * Returns 0 on success, negative on error.
 421  */
 422 int serial_init(void)
 423 {
 424         gd->flags |= GD_FLG_SERIAL_READY;
 425         return get_current()->start();
 426 }
 427
 428 /**
 429  * serial_setbrg() - Configure baud-rate of currently selected serial port
 430  *
 431  * This function configures the baud-rate of the currently selected
 432  * serial port. The baud-rate is retrieved from global data within
 433  * the serial port driver. This function uses the get_current() call
 434  * to determine which port is selected.
 435  *
 436  * Returns 0 on success, negative on error.
 437  */
 438 void serial_setbrg(void)
 439 {
 440         get_current()->setbrg();
 441 }
 442
 443 /**
 444  * serial_getc() - Read character from currently selected serial port
 445  *
 446  * This function retrieves a character from currently selected serial
 447  * port. In case there is no character waiting on the serial port,
 448  * this function will block and wait for the character to appear. This
 449  * function uses the get_current() call to determine which port is
 450  * selected.
 451  *
 452  * Returns the character on success, negative on error.
 453  */
 454 int serial_getc(void)
 455 {
 456         return get_current()->getc();
 457 }
 458
 459 /**
 460  * serial_tstc() - Test if data is available on currently selected serial port
 461  *
 462  * This function tests if one or more characters are available on
 463  * currently selected serial port. This function never blocks. This
 464  * function uses the get_current() call to determine which port is
 465  * selected.
 466  *
 467  * Returns positive if character is available, zero otherwise.
 468  */
 469 int serial_tstc(void)
 470 {
 471         return get_current()->tstc();
 472 }
 473
 474 /**
 475  * serial_putc() - Output character via currently selected serial port
 476  * @c:  Single character to be output from the serial port.
 477  *
 478  * This function outputs a character via currently selected serial
 479  * port. This character is passed to the serial port driver responsible
 480  * for controlling the hardware. The hardware may still be in process
 481  * of transmitting another character, therefore this function may block
 482  * for a short amount of time. This function uses the get_current()
 483  * call to determine which port is selected.
 484  */
 485 void serial_putc(const char c)
 486 {
 487         get_current()->putc(c);
 488 }
 489
 490 /**
 491  * serial_puts() - Output string via currently selected serial port
 492  * @s:  Zero-terminated string to be output from the serial port.
 493  *
 494  * This function outputs a zero-terminated string via currently
 495  * selected serial port. This function behaves as an accelerator
 496  * in case the hardware can queue multiple characters for transfer.
 497  * The whole string that is to be output is available to the function
 498  * implementing the hardware manipulation. Transmitting the whole
 499  * string may take some time, thus this function may block for some
 500  * amount of time. This function uses the get_current() call to
 501  * determine which port is selected.
 502  */
 503 void serial_puts(const char *s)
 504 {
 505         get_current()->puts(s);
 506 }
 507
 508 /**
 509  * default_serial_puts() - Output string by calling serial_putc() in loop
 510  * @s:  Zero-terminated string to be output from the serial port.
 511  *
 512  * This function outputs a zero-terminated string by calling serial_putc()
 513  * in a loop. Most drivers do not support queueing more than one byte for
 514  * transfer, thus this function precisely implements their serial_puts().
 515  *
 516  * To optimize the number of get_current() calls, this function only
 517  * calls get_current() once and then directly accesses the putc() call
 518  * of the &struct serial_device .
 519  */
 520 void default_serial_puts(const char *s)
 521 {
 522         struct serial_device *dev = get_current();
 523         while (*s)
 524                 dev->putc(*s++);
 525 }
 526
 527 #if CONFIG_POST & CONFIG_SYS_POST_UART
 528 static const int bauds[] = CONFIG_SYS_BAUDRATE_TABLE;
 529
 530 /**
 531  * uart_post_test() - Test the currently selected serial port using POST
 532  * @flags:      POST framework flags
 533  *
 534  * Do a loopback test of the currently selected serial port. This
 535  * function is only useful in the context of the POST testing framwork.
 536  * The serial port is firstly configured into loopback mode and then
 537  * characters are sent through it.
 538  *
 539  * Returns 0 on success, value otherwise.
 540  */
 541 /* Mark weak until post/cpu/.../uart.c migrate over */
 542 __weak
 543 int uart_post_test(int flags)
 544 {
 545         unsigned char c;
 546         int ret, saved_baud, b;
 547         struct serial_device *saved_dev, *s;
 548
 549         /* Save current serial state */
 550         ret = 0;
 551         saved_dev = serial_current;
 552         saved_baud = gd->baudrate;
 553
 554         for (s = serial_devices; s; s = s->next) {
 555                 /* If this driver doesn't support loop back, skip it */
 556                 if (!s->loop)
 557                         continue;
 558
 559                 /* Test the next device */
 560                 serial_current = s;
 561
 562                 ret = serial_init();
 563                 if (ret)
 564                         goto done;
 565
 566                 /* Consume anything that happens to be queued */
 567                 while (serial_tstc())
 568                         serial_getc();
 569
 570                 /* Enable loop back */
 571                 s->loop(1);
 572
 573                 /* Test every available baud rate */
 574                 for (b = 0; b < ARRAY_SIZE(bauds); ++b) {
 575                         gd->baudrate = bauds[b];
 576                         serial_setbrg();
 577
 578                         /*
 579                          * Stick to printable chars to avoid issues:
 580                          *  - terminal corruption
 581                          *  - serial program reacting to sequences and sending
 582                          *    back random extra data
 583                          *  - most serial drivers add in extra chars (like \r\n)
 584                          */
 585                         for (c = 0x20; c < 0x7f; ++c) {
 586                                 /* Send it out */
 587                                 serial_putc(c);
 588
 589                                 /* Make sure it's the same one */
 590                                 ret = (c != serial_getc());
 591                                 if (ret) {
 592                                         s->loop(0);
 593                                         goto done;
 594                                 }
 595
 596                                 /* Clean up the output in case it was sent */
 597                                 serial_putc('\b');
 598                                 ret = ('\b' != serial_getc());
 599                                 if (ret) {
 600                                         s->loop(0);
 601                                         goto done;
 602                                 }
 603                         }
 604                 }
 605
 606                 /* Disable loop back */
 607                 s->loop(0);
 608
 609                 /* XXX: There is no serial_stop() !? */
 610                 if (s->stop)
 611                         s->stop();
 612         }
 613
 614  done:
 615         /* Restore previous serial state */
 616         serial_current = saved_dev;
 617         gd->baudrate = saved_baud;
 618         serial_reinit_all();
 619         serial_setbrg();
 620
 621         return ret;
 622 }
 623 #endif