drivers/serial/serial.c

   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
  30 DECLARE_GLOBAL_DATA_PTR;
  31
  32 static struct serial_device *serial_devices;
  33 static struct serial_device *serial_current;
  34
  35 static void serial_null(void)
  36 {
  37 }
  38
  39 #define serial_initfunc(name)                                   \
  40         void name(void)                                         \
  41                 __attribute__((weak, alias("serial_null")));
  42
  43 serial_initfunc(mpc8xx_serial_initialize);
  44 serial_initfunc(ns16550_serial_initialize);
  45 serial_initfunc(pxa_serial_initialize);
  46 serial_initfunc(s3c24xx_serial_initialize);
  47 serial_initfunc(s5p_serial_initialize);
  48 serial_initfunc(zynq_serial_initalize);
  49 serial_initfunc(bfin_serial_initialize);
  50 serial_initfunc(bfin_jtag_initialize);
  51 serial_initfunc(mpc512x_serial_initialize);
  52 serial_initfunc(uartlite_serial_initialize);
  53 serial_initfunc(au1x00_serial_initialize);
  54 serial_initfunc(asc_serial_initialize);
  55 serial_initfunc(jz_serial_initialize);
  56 serial_initfunc(mpc5xx_serial_initialize);
  57 serial_initfunc(mpc8220_serial_initialize);
  58 serial_initfunc(mpc8260_scc_serial_initialize);
  59 serial_initfunc(mpc8260_smc_serial_initialize);
  60 serial_initfunc(mpc85xx_serial_initialize);
  61 serial_initfunc(iop480_serial_initialize);
  62 serial_initfunc(leon2_serial_initialize);
  63 serial_initfunc(leon3_serial_initialize);
  64 serial_initfunc(marvell_serial_initialize);
  65 serial_initfunc(amirix_serial_initialize);
  66 serial_initfunc(bmw_serial_initialize);
  67 serial_initfunc(cogent_serial_initialize);
  68 serial_initfunc(cpci750_serial_initialize);
  69 serial_initfunc(evb64260_serial_initialize);
  70 serial_initfunc(ml2_serial_initialize);
  71 serial_initfunc(sconsole_serial_initialize);
  72 serial_initfunc(p3mx_serial_initialize);
  73 serial_initfunc(altera_jtag_serial_initialize);
  74 serial_initfunc(altera_serial_initialize);
  75 serial_initfunc(atmel_serial_initialize);
  76 serial_initfunc(lpc32xx_serial_initialize);
  77 serial_initfunc(mcf_serial_initialize);
  78 serial_initfunc(ns9750_serial_initialize);
  79 serial_initfunc(oc_serial_initialize);
  80 serial_initfunc(s3c4510b_serial_initialize);
  81 serial_initfunc(s3c64xx_serial_initialize);
  82 serial_initfunc(sandbox_serial_initialize);
  83 serial_initfunc(clps7111_serial_initialize);
  84 serial_initfunc(imx_serial_initialize);
  85 serial_initfunc(ixp_serial_initialize);
  86 serial_initfunc(ks8695_serial_initialize);
  87 serial_initfunc(lh7a40x_serial_initialize);
  88 serial_initfunc(lpc2292_serial_initialize);
  89 serial_initfunc(max3100_serial_initialize);
  90 serial_initfunc(mxc_serial_initialize);
  91 serial_initfunc(netarm_serial_initialize);
  92 serial_initfunc(pl01x_serial_initialize);
  93 serial_initfunc(s3c44b0_serial_initialize);
  94 serial_initfunc(sa1100_serial_initialize);
  95 serial_initfunc(sh_serial_initialize);
  96
  97 void serial_register(struct serial_device *dev)
  98 {
  99 #ifdef CONFIG_NEEDS_MANUAL_RELOC
 100         dev->start += gd->reloc_off;
 101         dev->setbrg += gd->reloc_off;
 102         dev->getc += gd->reloc_off;
 103         dev->tstc += gd->reloc_off;
 104         dev->putc += gd->reloc_off;
 105         dev->puts += gd->reloc_off;
 106 #endif
 107
 108         dev->next = serial_devices;
 109         serial_devices = dev;
 110 }
 111
 112 void serial_initialize(void)
 113 {
 114         mpc8xx_serial_initialize();
 115         ns16550_serial_initialize();
 116         pxa_serial_initialize();
 117         s3c24xx_serial_initialize();
 118         s5p_serial_initialize();
 119         mpc512x_serial_initialize();
 120         bfin_serial_initialize();
 121         bfin_jtag_initialize();
 122         uartlite_serial_initialize();
 123         zynq_serial_initalize();
 124         au1x00_serial_initialize();
 125         asc_serial_initialize();
 126         jz_serial_initialize();
 127         mpc5xx_serial_initialize();
 128         mpc8220_serial_initialize();
 129         mpc8260_scc_serial_initialize();
 130         mpc8260_smc_serial_initialize();
 131         mpc85xx_serial_initialize();
 132         iop480_serial_initialize();
 133         leon2_serial_initialize();
 134         leon3_serial_initialize();
 135         marvell_serial_initialize();
 136         amirix_serial_initialize();
 137         bmw_serial_initialize();
 138         cogent_serial_initialize();
 139         cpci750_serial_initialize();
 140         evb64260_serial_initialize();
 141         ml2_serial_initialize();
 142         sconsole_serial_initialize();
 143         p3mx_serial_initialize();
 144         altera_jtag_serial_initialize();
 145         altera_serial_initialize();
 146         atmel_serial_initialize();
 147         lpc32xx_serial_initialize();
 148         mcf_serial_initialize();
 149         ns9750_serial_initialize();
 150         oc_serial_initialize();
 151         s3c4510b_serial_initialize();
 152         s3c64xx_serial_initialize();
 153         sandbox_serial_initialize();
 154         clps7111_serial_initialize();
 155         imx_serial_initialize();
 156         ixp_serial_initialize();
 157         ks8695_serial_initialize();
 158         lh7a40x_serial_initialize();
 159         lpc2292_serial_initialize();
 160         max3100_serial_initialize();
 161         mxc_serial_initialize();
 162         netarm_serial_initialize();
 163         pl01x_serial_initialize();
 164         s3c44b0_serial_initialize();
 165         sa1100_serial_initialize();
 166         sh_serial_initialize();
 167
 168         serial_assign(default_serial_console()->name);
 169 }
 170
 171 void serial_stdio_init(void)
 172 {
 173         struct stdio_dev dev;
 174         struct serial_device *s = serial_devices;
 175
 176         while (s) {
 177                 memset(&dev, 0, sizeof(dev));
 178
 179                 strcpy(dev.name, s->name);
 180                 dev.flags = DEV_FLAGS_OUTPUT | DEV_FLAGS_INPUT;
 181
 182                 dev.start = s->start;
 183                 dev.stop = s->stop;
 184                 dev.putc = s->putc;
 185                 dev.puts = s->puts;
 186                 dev.getc = s->getc;
 187                 dev.tstc = s->tstc;
 188
 189                 stdio_register(&dev);
 190
 191                 s = s->next;
 192         }
 193 }
 194
 195 int serial_assign(const char *name)
 196 {
 197         struct serial_device *s;
 198
 199         for (s = serial_devices; s; s = s->next) {
 200                 if (strcmp(s->name, name) == 0) {
 201                         serial_current = s;
 202                         return 0;
 203                 }
 204         }
 205
 206         return 1;
 207 }
 208
 209 void serial_reinit_all(void)
 210 {
 211         struct serial_device *s;
 212
 213         for (s = serial_devices; s; s = s->next)
 214                 s->start();
 215 }
 216
 217 static struct serial_device *get_current(void)
 218 {
 219         struct serial_device *dev;
 220
 221         if (!(gd->flags & GD_FLG_RELOC) || !serial_current) {
 222                 dev = default_serial_console();
 223
 224                 /* We must have a console device */
 225                 if (!dev) {
 226 #ifdef CONFIG_SPL_BUILD
 227                         puts("Cannot find console\n");
 228                         hang();
 229 #else
 230                         panic("Cannot find console\n");
 231 #endif
 232                 }
 233         } else
 234                 dev = serial_current;
 235         return dev;
 236 }
 237
 238 int serial_init(void)
 239 {
 240         return get_current()->start();
 241 }
 242
 243 void serial_setbrg(void)
 244 {
 245         get_current()->setbrg();
 246 }
 247
 248 int serial_getc(void)
 249 {
 250         return get_current()->getc();
 251 }
 252
 253 int serial_tstc(void)
 254 {
 255         return get_current()->tstc();
 256 }
 257
 258 void serial_putc(const char c)
 259 {
 260         get_current()->putc(c);
 261 }
 262
 263 void serial_puts(const char *s)
 264 {
 265         get_current()->puts(s);
 266 }
 267
 268 #if CONFIG_POST & CONFIG_SYS_POST_UART
 269 static const int bauds[] = CONFIG_SYS_BAUDRATE_TABLE;
 270
 271 /* Mark weak until post/cpu/.../uart.c migrate over */
 272 __weak
 273 int uart_post_test(int flags)
 274 {
 275         unsigned char c;
 276         int ret, saved_baud, b;
 277         struct serial_device *saved_dev, *s;
 278         bd_t *bd = gd->bd;
 279
 280         /* Save current serial state */
 281         ret = 0;
 282         saved_dev = serial_current;
 283         saved_baud = bd->bi_baudrate;
 284
 285         for (s = serial_devices; s; s = s->next) {
 286                 /* If this driver doesn't support loop back, skip it */
 287                 if (!s->loop)
 288                         continue;
 289
 290                 /* Test the next device */
 291                 serial_current = s;
 292
 293                 ret = serial_init();
 294                 if (ret)
 295                         goto done;
 296
 297                 /* Consume anything that happens to be queued */
 298                 while (serial_tstc())
 299                         serial_getc();
 300
 301                 /* Enable loop back */
 302                 s->loop(1);
 303
 304                 /* Test every available baud rate */
 305                 for (b = 0; b < ARRAY_SIZE(bauds); ++b) {
 306                         bd->bi_baudrate = bauds[b];
 307                         serial_setbrg();
 308
 309                         /*
 310                          * Stick to printable chars to avoid issues:
 311                          *  - terminal corruption
 312                          *  - serial program reacting to sequences and sending
 313                          *    back random extra data
 314                          *  - most serial drivers add in extra chars (like \r\n)
 315                          */
 316                         for (c = 0x20; c < 0x7f; ++c) {
 317                                 /* Send it out */
 318                                 serial_putc(c);
 319
 320                                 /* Make sure it's the same one */
 321                                 ret = (c != serial_getc());
 322                                 if (ret) {
 323                                         s->loop(0);
 324                                         goto done;
 325                                 }
 326
 327                                 /* Clean up the output in case it was sent */
 328                                 serial_putc('\b');
 329                                 ret = ('\b' != serial_getc());
 330                                 if (ret) {
 331                                         s->loop(0);
 332                                         goto done;
 333                                 }
 334                         }
 335                 }
 336
 337                 /* Disable loop back */
 338                 s->loop(0);
 339
 340                 /* XXX: There is no serial_stop() !? */
 341                 if (s->stop)
 342                         s->stop();
 343         }
 344
 345  done:
 346         /* Restore previous serial state */
 347         serial_current = saved_dev;
 348         bd->bi_baudrate = saved_baud;
 349         serial_reinit_all();
 350         serial_setbrg();
 351
 352         return ret;
 353 }
 354 #endif