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