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