drivers/serial/serial.c

   1 /*
   2  * (C) Copyright 2000
   3  * Rob Taylor, Flying Pig Systems. robt@flyingpig.com.
   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 <linux/compiler.h>
  26
  27 #include <ns16550.h>
  28 #ifdef CONFIG_NS87308
  29 #include <ns87308.h>
  30 #endif
  31 #ifdef CONFIG_KIRKWOOD
  32 #include <asm/arch/kirkwood.h>
  33 #elif defined(CONFIG_ORION5X)
  34 #include <asm/arch/orion5x.h>
  35 #elif defined(CONFIG_ARMADA100)
  36 #include <asm/arch/armada100.h>
  37 #elif defined(CONFIG_PANTHEON)
  38 #include <asm/arch/pantheon.h>
  39 #endif
  40
  41 #if defined (CONFIG_SERIAL_MULTI)
  42 #include <serial.h>
  43 #endif
  44
  45 DECLARE_GLOBAL_DATA_PTR;
  46
  47 #if !defined(CONFIG_CONS_INDEX)
  48 #if defined (CONFIG_SERIAL_MULTI)
  49 /*   with CONFIG_SERIAL_MULTI we might have no console
  50  *  on these devices
  51  */
  52 #else
  53 #error  "No console index specified."
  54 #endif /* CONFIG_SERIAL_MULTI */
  55 #elif (CONFIG_CONS_INDEX < 1) || (CONFIG_CONS_INDEX > 4)
  56 #error  "Invalid console index value."
  57 #endif
  58
  59 #if CONFIG_CONS_INDEX == 1 && !defined(CONFIG_SYS_NS16550_COM1)
  60 #error  "Console port 1 defined but not configured."
  61 #elif CONFIG_CONS_INDEX == 2 && !defined(CONFIG_SYS_NS16550_COM2)
  62 #error  "Console port 2 defined but not configured."
  63 #elif CONFIG_CONS_INDEX == 3 && !defined(CONFIG_SYS_NS16550_COM3)
  64 #error  "Console port 3 defined but not configured."
  65 #elif CONFIG_CONS_INDEX == 4 && !defined(CONFIG_SYS_NS16550_COM4)
  66 #error  "Console port 4 defined but not configured."
  67 #endif
  68
  69 /* Note: The port number specified in the functions is 1 based.
  70  *       the array is 0 based.
  71  */
  72 static NS16550_t serial_ports[4] = {
  73 #ifdef CONFIG_SYS_NS16550_COM1
  74         (NS16550_t)CONFIG_SYS_NS16550_COM1,
  75 #else
  76         NULL,
  77 #endif
  78 #ifdef CONFIG_SYS_NS16550_COM2
  79         (NS16550_t)CONFIG_SYS_NS16550_COM2,
  80 #else
  81         NULL,
  82 #endif
  83 #ifdef CONFIG_SYS_NS16550_COM3
  84         (NS16550_t)CONFIG_SYS_NS16550_COM3,
  85 #else
  86         NULL,
  87 #endif
  88 #ifdef CONFIG_SYS_NS16550_COM4
  89         (NS16550_t)CONFIG_SYS_NS16550_COM4
  90 #else
  91         NULL
  92 #endif
  93 };
  94
  95 #define PORT    serial_ports[port-1]
  96 #if defined(CONFIG_CONS_INDEX)
  97 #define CONSOLE (serial_ports[CONFIG_CONS_INDEX-1])
  98 #endif
  99
 100 #if defined(CONFIG_SERIAL_MULTI)
 101
 102 /* Multi serial device functions */
 103 #define DECLARE_ESERIAL_FUNCTIONS(port) \
 104     int  eserial##port##_init (void) {\
 105         int clock_divisor; \
 106         clock_divisor = calc_divisor(serial_ports[port-1]); \
 107         NS16550_init(serial_ports[port-1], clock_divisor); \
 108         return(0);}\
 109     void eserial##port##_setbrg (void) {\
 110         serial_setbrg_dev(port);}\
 111     int  eserial##port##_getc (void) {\
 112         return serial_getc_dev(port);}\
 113     int  eserial##port##_tstc (void) {\
 114         return serial_tstc_dev(port);}\
 115     void eserial##port##_putc (const char c) {\
 116         serial_putc_dev(port, c);}\
 117     void eserial##port##_puts (const char *s) {\
 118         serial_puts_dev(port, s);}
 119
 120 /* Serial device descriptor */
 121 #define INIT_ESERIAL_STRUCTURE(port,name,bus) {\
 122         name,\
 123         bus,\
 124         eserial##port##_init,\
 125         NULL,\
 126         eserial##port##_setbrg,\
 127         eserial##port##_getc,\
 128         eserial##port##_tstc,\
 129         eserial##port##_putc,\
 130         eserial##port##_puts, }
 131
 132 #endif /* CONFIG_SERIAL_MULTI */
 133
 134 static int calc_divisor (NS16550_t port)
 135 {
 136 #ifdef CONFIG_OMAP1510
 137         /* If can't cleanly clock 115200 set div to 1 */
 138         if ((CONFIG_SYS_NS16550_CLK == 12000000) && (gd->baudrate == 115200)) {
 139                 port->osc_12m_sel = OSC_12M_SEL;        /* enable 6.5 * divisor */
 140                 return (1);                             /* return 1 for base divisor */
 141         }
 142         port->osc_12m_sel = 0;                  /* clear if previsouly set */
 143 #endif
 144 #ifdef CONFIG_OMAP1610
 145         /* If can't cleanly clock 115200 set div to 1 */
 146         if ((CONFIG_SYS_NS16550_CLK == 48000000) && (gd->baudrate == 115200)) {
 147                 return (26);            /* return 26 for base divisor */
 148         }
 149 #endif
 150
 151 #ifdef CONFIG_APTIX
 152 #define MODE_X_DIV 13
 153 #else
 154 #define MODE_X_DIV 16
 155 #endif
 156
 157         /* Compute divisor value. Normally, we should simply return:
 158          *   CONFIG_SYS_NS16550_CLK) / MODE_X_DIV / gd->baudrate
 159          * but we need to round that value by adding 0.5.
 160          * Rounding is especially important at high baud rates.
 161          */
 162         return (CONFIG_SYS_NS16550_CLK + (gd->baudrate * (MODE_X_DIV / 2))) /
 163                 (MODE_X_DIV * gd->baudrate);
 164 }
 165
 166 #if !defined(CONFIG_SERIAL_MULTI)
 167 int serial_init (void)
 168 {
 169         int clock_divisor;
 170
 171 #ifdef CONFIG_NS87308
 172         initialise_ns87308();
 173 #endif
 174
 175 #ifdef CONFIG_SYS_NS16550_COM1
 176         clock_divisor = calc_divisor(serial_ports[0]);
 177         NS16550_init(serial_ports[0], clock_divisor);
 178 #endif
 179 #ifdef CONFIG_SYS_NS16550_COM2
 180         clock_divisor = calc_divisor(serial_ports[1]);
 181         NS16550_init(serial_ports[1], clock_divisor);
 182 #endif
 183 #ifdef CONFIG_SYS_NS16550_COM3
 184         clock_divisor = calc_divisor(serial_ports[2]);
 185         NS16550_init(serial_ports[2], clock_divisor);
 186 #endif
 187 #ifdef CONFIG_SYS_NS16550_COM4
 188         clock_divisor = calc_divisor(serial_ports[3]);
 189         NS16550_init(serial_ports[3], clock_divisor);
 190 #endif
 191
 192         return (0);
 193 }
 194 #endif
 195
 196 void
 197 _serial_putc(const char c,const int port)
 198 {
 199         if (c == '\n')
 200                 NS16550_putc(PORT, '\r');
 201
 202         NS16550_putc(PORT, c);
 203 }
 204
 205 void
 206 _serial_putc_raw(const char c,const int port)
 207 {
 208         NS16550_putc(PORT, c);
 209 }
 210
 211 void
 212 _serial_puts (const char *s,const int port)
 213 {
 214         while (*s) {
 215                 _serial_putc (*s++,port);
 216         }
 217 }
 218
 219
 220 int
 221 _serial_getc(const int port)
 222 {
 223         return NS16550_getc(PORT);
 224 }
 225
 226 int
 227 _serial_tstc(const int port)
 228 {
 229         return NS16550_tstc(PORT);
 230 }
 231
 232 void
 233 _serial_setbrg (const int port)
 234 {
 235         int clock_divisor;
 236
 237         clock_divisor = calc_divisor(PORT);
 238         NS16550_reinit(PORT, clock_divisor);
 239 }
 240
 241 #if defined(CONFIG_SERIAL_MULTI)
 242 static inline void
 243 serial_putc_dev(unsigned int dev_index,const char c)
 244 {
 245         _serial_putc(c,dev_index);
 246 }
 247 #else
 248 void
 249 serial_putc(const char c)
 250 {
 251         _serial_putc(c,CONFIG_CONS_INDEX);
 252 }
 253 #endif
 254
 255 #if defined(CONFIG_SERIAL_MULTI)
 256 static inline void
 257 serial_putc_raw_dev(unsigned int dev_index,const char c)
 258 {
 259         _serial_putc_raw(c,dev_index);
 260 }
 261 #else
 262 void
 263 serial_putc_raw(const char c)
 264 {
 265         _serial_putc_raw(c,CONFIG_CONS_INDEX);
 266 }
 267 #endif
 268
 269 #if defined(CONFIG_SERIAL_MULTI)
 270 static inline void
 271 serial_puts_dev(unsigned int dev_index,const char *s)
 272 {
 273         _serial_puts(s,dev_index);
 274 }
 275 #else
 276 void
 277 serial_puts(const char *s)
 278 {
 279         _serial_puts(s,CONFIG_CONS_INDEX);
 280 }
 281 #endif
 282
 283 #if defined(CONFIG_SERIAL_MULTI)
 284 static inline int
 285 serial_getc_dev(unsigned int dev_index)
 286 {
 287         return _serial_getc(dev_index);
 288 }
 289 #else
 290 int
 291 serial_getc(void)
 292 {
 293         return _serial_getc(CONFIG_CONS_INDEX);
 294 }
 295 #endif
 296
 297 #if defined(CONFIG_SERIAL_MULTI)
 298 static inline int
 299 serial_tstc_dev(unsigned int dev_index)
 300 {
 301         return _serial_tstc(dev_index);
 302 }
 303 #else
 304 int
 305 serial_tstc(void)
 306 {
 307         return _serial_tstc(CONFIG_CONS_INDEX);
 308 }
 309 #endif
 310
 311 #if defined(CONFIG_SERIAL_MULTI)
 312 static inline void
 313 serial_setbrg_dev(unsigned int dev_index)
 314 {
 315         _serial_setbrg(dev_index);
 316 }
 317 #else
 318 void
 319 serial_setbrg(void)
 320 {
 321         _serial_setbrg(CONFIG_CONS_INDEX);
 322 }
 323 #endif
 324
 325 #if defined(CONFIG_SERIAL_MULTI)
 326
 327 DECLARE_ESERIAL_FUNCTIONS(1);
 328 struct serial_device eserial1_device =
 329         INIT_ESERIAL_STRUCTURE(1,"eserial0","EUART1");
 330 DECLARE_ESERIAL_FUNCTIONS(2);
 331 struct serial_device eserial2_device =
 332         INIT_ESERIAL_STRUCTURE(2,"eserial1","EUART2");
 333 DECLARE_ESERIAL_FUNCTIONS(3);
 334 struct serial_device eserial3_device =
 335         INIT_ESERIAL_STRUCTURE(3,"eserial2","EUART3");
 336 DECLARE_ESERIAL_FUNCTIONS(4);
 337 struct serial_device eserial4_device =
 338         INIT_ESERIAL_STRUCTURE(4,"eserial3","EUART4");
 339
 340 __weak struct serial_device *default_serial_console(void)
 341 {
 342 #if CONFIG_CONS_INDEX == 1
 343         return &eserial1_device;
 344 #elif CONFIG_CONS_INDEX == 2
 345         return &eserial2_device;
 346 #elif CONFIG_CONS_INDEX == 3
 347         return &eserial3_device;
 348 #elif CONFIG_CONS_INDEX == 4
 349         return &eserial4_device;
 350 #else
 351 #error "Bad CONFIG_CONS_INDEX."
 352 #endif
 353 }
 354
 355 #endif /* CONFIG_SERIAL_MULTI */