drivers/serial/serial.c

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