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