common/serial.c

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