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