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