common/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 void serial_register(struct serial_device *dev)
  36 {
  37 #ifdef CONFIG_NEEDS_MANUAL_RELOC
  38         dev->init += gd->reloc_off;
  39         dev->setbrg += gd->reloc_off;
  40         dev->getc += gd->reloc_off;
  41         dev->tstc += gd->reloc_off;
  42         dev->putc += gd->reloc_off;
  43         dev->puts += gd->reloc_off;
  44 #endif
  45
  46         dev->next = serial_devices;
  47         serial_devices = dev;
  48 }
  49
  50 void serial_initialize(void)
  51 {
  52 #if defined(CONFIG_8xx_CONS_SMC1) || defined(CONFIG_8xx_CONS_SMC2)
  53         serial_register(&serial_smc_device);
  54 #endif
  55 #if     defined(CONFIG_8xx_CONS_SCC1) || defined(CONFIG_8xx_CONS_SCC2) || \
  56         defined(CONFIG_8xx_CONS_SCC3) || defined(CONFIG_8xx_CONS_SCC4)
  57         serial_register(&serial_scc_device);
  58 #endif
  59
  60 #if defined(CONFIG_SYS_NS16550_SERIAL)
  61 #if defined(CONFIG_SYS_NS16550_COM1)
  62         serial_register(&eserial1_device);
  63 #endif
  64 #if defined(CONFIG_SYS_NS16550_COM2)
  65         serial_register(&eserial2_device);
  66 #endif
  67 #if defined(CONFIG_SYS_NS16550_COM3)
  68         serial_register(&eserial3_device);
  69 #endif
  70 #if defined(CONFIG_SYS_NS16550_COM4)
  71         serial_register(&eserial4_device);
  72 #endif
  73 #endif /* CONFIG_SYS_NS16550_SERIAL */
  74 #if defined(CONFIG_FFUART)
  75         serial_register(&serial_ffuart_device);
  76 #endif
  77 #if defined(CONFIG_BTUART)
  78         serial_register(&serial_btuart_device);
  79 #endif
  80 #if defined(CONFIG_STUART)
  81         serial_register(&serial_stuart_device);
  82 #endif
  83 #if defined(CONFIG_S3C2410)
  84         serial_register(&s3c24xx_serial0_device);
  85         serial_register(&s3c24xx_serial1_device);
  86         serial_register(&s3c24xx_serial2_device);
  87 #endif
  88 #if defined(CONFIG_S5P)
  89         serial_register(&s5p_serial0_device);
  90         serial_register(&s5p_serial1_device);
  91         serial_register(&s5p_serial2_device);
  92         serial_register(&s5p_serial3_device);
  93 #endif
  94 #if defined(CONFIG_MPC512X)
  95 #if defined(CONFIG_SYS_PSC1)
  96         serial_register(&serial1_device);
  97 #endif
  98 #if defined(CONFIG_SYS_PSC3)
  99         serial_register(&serial3_device);
 100 #endif
 101 #if defined(CONFIG_SYS_PSC4)
 102         serial_register(&serial4_device);
 103 #endif
 104 #if defined(CONFIG_SYS_PSC6)
 105         serial_register(&serial6_device);
 106 #endif
 107 #endif
 108 #if defined(CONFIG_SYS_BFIN_UART)
 109         serial_register_bfin_uart();
 110 #endif
 111 #if defined(CONFIG_XILINX_UARTLITE)
 112 # ifdef XILINX_UARTLITE_BASEADDR
 113         serial_register(&uartlite_serial0_device);
 114 # endif /* XILINX_UARTLITE_BASEADDR */
 115 # ifdef XILINX_UARTLITE_BASEADDR1
 116         serial_register(&uartlite_serial1_device);
 117 # endif /* XILINX_UARTLITE_BASEADDR1 */
 118 # ifdef XILINX_UARTLITE_BASEADDR2
 119         serial_register(&uartlite_serial2_device);
 120 # endif /* XILINX_UARTLITE_BASEADDR2 */
 121 # ifdef XILINX_UARTLITE_BASEADDR3
 122         serial_register(&uartlite_serial3_device);
 123 # endif /* XILINX_UARTLITE_BASEADDR3 */
 124 #endif /* CONFIG_XILINX_UARTLITE */
 125         serial_assign(default_serial_console()->name);
 126 }
 127
 128 void serial_stdio_init(void)
 129 {
 130         struct stdio_dev dev;
 131         struct serial_device *s = serial_devices;
 132
 133         while (s) {
 134                 memset(&dev, 0, sizeof(dev));
 135
 136                 strcpy(dev.name, s->name);
 137                 dev.flags = DEV_FLAGS_OUTPUT | DEV_FLAGS_INPUT;
 138
 139                 dev.start = s->init;
 140                 dev.stop = s->uninit;
 141                 dev.putc = s->putc;
 142                 dev.puts = s->puts;
 143                 dev.getc = s->getc;
 144                 dev.tstc = s->tstc;
 145
 146                 stdio_register(&dev);
 147
 148                 s = s->next;
 149         }
 150 }
 151
 152 int serial_assign(const char *name)
 153 {
 154         struct serial_device *s;
 155
 156         for (s = serial_devices; s; s = s->next) {
 157                 if (strcmp(s->name, name) == 0) {
 158                         serial_current = s;
 159                         return 0;
 160                 }
 161         }
 162
 163         return 1;
 164 }
 165
 166 void serial_reinit_all(void)
 167 {
 168         struct serial_device *s;
 169
 170         for (s = serial_devices; s; s = s->next)
 171                 s->init();
 172 }
 173
 174 static struct serial_device *get_current(void)
 175 {
 176         struct serial_device *dev;
 177
 178         if (!(gd->flags & GD_FLG_RELOC) || !serial_current) {
 179                 dev = default_serial_console();
 180
 181                 /* We must have a console device */
 182                 if (!dev)
 183                         panic("Cannot find console");
 184         } else
 185                 dev = serial_current;
 186         return dev;
 187 }
 188
 189 int serial_init(void)
 190 {
 191         return get_current()->init();
 192 }
 193
 194 void serial_setbrg(void)
 195 {
 196         get_current()->setbrg();
 197 }
 198
 199 int serial_getc(void)
 200 {
 201         return get_current()->getc();
 202 }
 203
 204 int serial_tstc(void)
 205 {
 206         return get_current()->tstc();
 207 }
 208
 209 void serial_putc(const char c)
 210 {
 211         get_current()->putc(c);
 212 }
 213
 214 void serial_puts(const char *s)
 215 {
 216         get_current()->puts(s);
 217 }
 218
 219 #if CONFIG_POST & CONFIG_SYS_POST_UART
 220 static const int bauds[] = CONFIG_SYS_BAUDRATE_TABLE;
 221
 222 /* Mark weak until post/cpu/.../uart.c migrate over */
 223 __weak
 224 int uart_post_test(int flags)
 225 {
 226         unsigned char c;
 227         int ret, saved_baud, b;
 228         struct serial_device *saved_dev, *s;
 229         bd_t *bd = gd->bd;
 230
 231         /* Save current serial state */
 232         ret = 0;
 233         saved_dev = serial_current;
 234         saved_baud = bd->bi_baudrate;
 235
 236         for (s = serial_devices; s; s = s->next) {
 237                 /* If this driver doesn't support loop back, skip it */
 238                 if (!s->loop)
 239                         continue;
 240
 241                 /* Test the next device */
 242                 serial_current = s;
 243
 244                 ret = serial_init();
 245                 if (ret)
 246                         goto done;
 247
 248                 /* Consume anything that happens to be queued */
 249                 while (serial_tstc())
 250                         serial_getc();
 251
 252                 /* Enable loop back */
 253                 s->loop(1);
 254
 255                 /* Test every available baud rate */
 256                 for (b = 0; b < ARRAY_SIZE(bauds); ++b) {
 257                         bd->bi_baudrate = bauds[b];
 258                         serial_setbrg();
 259
 260                         /*
 261                          * Stick to printable chars to avoid issues:
 262                          *  - terminal corruption
 263                          *  - serial program reacting to sequences and sending
 264                          *    back random extra data
 265                          *  - most serial drivers add in extra chars (like \r\n)
 266                          */
 267                         for (c = 0x20; c < 0x7f; ++c) {
 268                                 /* Send it out */
 269                                 serial_putc(c);
 270
 271                                 /* Make sure it's the same one */
 272                                 ret = (c != serial_getc());
 273                                 if (ret) {
 274                                         s->loop(0);
 275                                         goto done;
 276                                 }
 277
 278                                 /* Clean up the output in case it was sent */
 279                                 serial_putc('\b');
 280                                 ret = ('\b' != serial_getc());
 281                                 if (ret) {
 282                                         s->loop(0);
 283                                         goto done;
 284                                 }
 285                         }
 286                 }
 287
 288                 /* Disable loop back */
 289                 s->loop(0);
 290
 291                 /* XXX: There is no serial_uninit() !? */
 292                 if (s->uninit)
 293                         s->uninit();
 294         }
 295
 296  done:
 297         /* Restore previous serial state */
 298         serial_current = saved_dev;
 299         bd->bi_baudrate = saved_baud;
 300         serial_reinit_all();
 301         serial_setbrg();
 302
 303         return ret;
 304 }
 305 #endif