arch/powerpc/cpu/mpc512x/serial.c

   1 /*
   2  * (C) Copyright 2000 - 2010
   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  * Based ont the MPC5200 PSC driver.
  24  * Adapted for MPC512x by Jan Wrobel <wrr@semihalf.com>
  25  */
  26
  27 /*
  28  * Minimal serial functions needed to use one of the PSC ports
  29  * as serial console interface.
  30  */
  31
  32 #include <common.h>
  33 #include <linux/compiler.h>
  34 #include <asm/io.h>
  35 #include <asm/processor.h>
  36 #include <serial.h>
  37
  38 DECLARE_GLOBAL_DATA_PTR;
  39
  40 #if defined(CONFIG_PSC_CONSOLE) || defined(CONFIG_SERIAL_MULTI)
  41
  42 static void fifo_init (volatile psc512x_t *psc)
  43 {
  44         volatile immap_t *im = (immap_t *) CONFIG_SYS_IMMR;
  45         u32 tfsize, rfsize;
  46
  47         /* reset Rx & Tx fifo slice */
  48         out_be32(&psc->rfcmd, PSC_FIFO_RESET_SLICE);
  49         out_be32(&psc->tfcmd, PSC_FIFO_RESET_SLICE);
  50
  51         /* disable Tx & Rx FIFO interrupts */
  52         out_be32(&psc->rfintmask, 0);
  53         out_be32(&psc->tfintmask, 0);
  54
  55 #if defined(CONFIG_SERIAL_MULTI)
  56         switch (((u32)psc & 0xf00) >> 8) {
  57         case 0:
  58                 tfsize = FIFOC_PSC0_TX_SIZE | (FIFOC_PSC0_TX_ADDR << 16);
  59                 rfsize = FIFOC_PSC0_RX_SIZE | (FIFOC_PSC0_RX_ADDR << 16);
  60                 break;
  61         case 1:
  62                 tfsize = FIFOC_PSC1_TX_SIZE | (FIFOC_PSC1_TX_ADDR << 16);
  63                 rfsize = FIFOC_PSC1_RX_SIZE | (FIFOC_PSC1_RX_ADDR << 16);
  64                 break;
  65         case 2:
  66                 tfsize = FIFOC_PSC2_TX_SIZE | (FIFOC_PSC2_TX_ADDR << 16);
  67                 rfsize = FIFOC_PSC2_RX_SIZE | (FIFOC_PSC2_RX_ADDR << 16);
  68                 break;
  69         case 3:
  70                 tfsize = FIFOC_PSC3_TX_SIZE | (FIFOC_PSC3_TX_ADDR << 16);
  71                 rfsize = FIFOC_PSC3_RX_SIZE | (FIFOC_PSC3_RX_ADDR << 16);
  72                 break;
  73         case 4:
  74                 tfsize = FIFOC_PSC4_TX_SIZE | (FIFOC_PSC4_TX_ADDR << 16);
  75                 rfsize = FIFOC_PSC4_RX_SIZE | (FIFOC_PSC4_RX_ADDR << 16);
  76                 break;
  77         case 5:
  78                 tfsize = FIFOC_PSC5_TX_SIZE | (FIFOC_PSC5_TX_ADDR << 16);
  79                 rfsize = FIFOC_PSC5_RX_SIZE | (FIFOC_PSC5_RX_ADDR << 16);
  80                 break;
  81         case 6:
  82                 tfsize = FIFOC_PSC6_TX_SIZE | (FIFOC_PSC6_TX_ADDR << 16);
  83                 rfsize = FIFOC_PSC6_RX_SIZE | (FIFOC_PSC6_RX_ADDR << 16);
  84                 break;
  85         case 7:
  86                 tfsize = FIFOC_PSC7_TX_SIZE | (FIFOC_PSC7_TX_ADDR << 16);
  87                 rfsize = FIFOC_PSC7_RX_SIZE | (FIFOC_PSC7_RX_ADDR << 16);
  88                 break;
  89         case 8:
  90                 tfsize = FIFOC_PSC8_TX_SIZE | (FIFOC_PSC8_TX_ADDR << 16);
  91                 rfsize = FIFOC_PSC8_RX_SIZE | (FIFOC_PSC8_RX_ADDR << 16);
  92                 break;
  93         case 9:
  94                 tfsize = FIFOC_PSC9_TX_SIZE | (FIFOC_PSC9_TX_ADDR << 16);
  95                 rfsize = FIFOC_PSC9_RX_SIZE | (FIFOC_PSC9_RX_ADDR << 16);
  96                 break;
  97         case 10:
  98                 tfsize = FIFOC_PSC10_TX_SIZE | (FIFOC_PSC10_TX_ADDR << 16);
  99                 rfsize = FIFOC_PSC10_RX_SIZE | (FIFOC_PSC10_RX_ADDR << 16);
 100                 break;
 101         case 11:
 102                 tfsize = FIFOC_PSC11_TX_SIZE | (FIFOC_PSC11_TX_ADDR << 16);
 103                 rfsize = FIFOC_PSC11_RX_SIZE | (FIFOC_PSC11_RX_ADDR << 16);
 104                 break;
 105         default:
 106                 return;
 107         }
 108 #else
 109         tfsize = CONSOLE_FIFO_TX_SIZE | (CONSOLE_FIFO_TX_ADDR << 16);
 110         rfsize = CONSOLE_FIFO_RX_SIZE | (CONSOLE_FIFO_RX_ADDR << 16);
 111 #endif
 112         out_be32(&psc->tfsize, tfsize);
 113         out_be32(&psc->rfsize, rfsize);
 114
 115         /* enable Tx & Rx FIFO slice */
 116         out_be32(&psc->rfcmd, PSC_FIFO_ENABLE_SLICE);
 117         out_be32(&psc->tfcmd, PSC_FIFO_ENABLE_SLICE);
 118
 119         out_be32(&im->fifoc.fifoc_cmd, FIFOC_DISABLE_CLOCK_GATE);
 120         __asm__ volatile ("sync");
 121 }
 122
 123 void serial_setbrg_dev(unsigned int idx)
 124 {
 125         volatile immap_t *im = (immap_t *) CONFIG_SYS_IMMR;
 126         volatile psc512x_t *psc = (psc512x_t *) &im->psc[idx];
 127         unsigned long baseclk, div;
 128         unsigned long baudrate;
 129         char buf[16];
 130         char *br_env;
 131
 132         baudrate = gd->baudrate;
 133         if (idx != CONFIG_PSC_CONSOLE) {
 134                 /* Allows setting baudrate for other serial devices
 135                  * on PSCx using environment. If not specified, use
 136                  * the same baudrate as for console.
 137                  */
 138                 sprintf(buf, "psc%d_baudrate", idx);
 139                 br_env = getenv(buf);
 140                 if (br_env)
 141                         baudrate = simple_strtoul(br_env, NULL, 10);
 142
 143                 debug("%s: idx %d, baudrate %ld\n", __func__, idx, baudrate);
 144         }
 145
 146         /* calculate divisor for setting PSC CTUR and CTLR registers */
 147         baseclk = (gd->ips_clk + 8) / 16;
 148         div = (baseclk + (baudrate / 2)) / baudrate;
 149
 150         out_8(&psc->ctur, (div >> 8) & 0xff);
 151         out_8(&psc->ctlr,  div & 0xff); /* set baudrate */
 152 }
 153
 154 int serial_init_dev(unsigned int idx)
 155 {
 156         volatile immap_t *im = (immap_t *) CONFIG_SYS_IMMR;
 157         volatile psc512x_t *psc = (psc512x_t *) &im->psc[idx];
 158 #if defined(CONFIG_SERIAL_MULTI)
 159         u32 reg;
 160
 161         reg = in_be32(&im->clk.sccr[0]);
 162         out_be32(&im->clk.sccr[0], reg | CLOCK_SCCR1_PSC_EN(idx));
 163 #endif
 164
 165         fifo_init (psc);
 166
 167         /* set MR register to point to MR1 */
 168         out_8(&psc->command, PSC_SEL_MODE_REG_1);
 169
 170         /* disable Tx/Rx */
 171         out_8(&psc->command, PSC_TX_DISABLE | PSC_RX_DISABLE);
 172
 173         /* choose the prescaler by 16 for the Tx/Rx clock generation */
 174         out_be16(&psc->psc_clock_select, 0xdd00);
 175
 176         /* switch to UART mode */
 177         out_be32(&psc->sicr, 0);
 178
 179         /* mode register points to mr1 */
 180         /* configure parity, bit length and so on in mode register 1*/
 181         out_8(&psc->mode, PSC_MODE_8_BITS | PSC_MODE_PARNONE);
 182         /* now, mode register points to mr2 */
 183         out_8(&psc->mode, PSC_MODE_1_STOPBIT);
 184
 185         /* set baudrate */
 186         serial_setbrg_dev(idx);
 187
 188         /* disable all interrupts */
 189         out_be16(&psc->psc_imr, 0);
 190
 191         /* reset and enable Rx/Tx */
 192         out_8(&psc->command, PSC_RST_RX);
 193         out_8(&psc->command, PSC_RST_TX);
 194         out_8(&psc->command, PSC_RX_ENABLE | PSC_TX_ENABLE);
 195
 196         return 0;
 197 }
 198
 199 int serial_uninit_dev(unsigned int idx)
 200 {
 201         volatile immap_t *im = (immap_t *) CONFIG_SYS_IMMR;
 202         volatile psc512x_t *psc = (psc512x_t *) &im->psc[idx];
 203         u32 reg;
 204
 205         out_8(&psc->command, PSC_RX_DISABLE | PSC_TX_DISABLE);
 206         reg = in_be32(&im->clk.sccr[0]);
 207         reg &= ~CLOCK_SCCR1_PSC_EN(idx);
 208         out_be32(&im->clk.sccr[0], reg);
 209
 210         return 0;
 211 }
 212
 213 void serial_putc_dev(unsigned int idx, const char c)
 214 {
 215         volatile immap_t *im = (immap_t *)CONFIG_SYS_IMMR;
 216         volatile psc512x_t *psc = (psc512x_t *) &im->psc[idx];
 217
 218         if (c == '\n')
 219                 serial_putc_dev(idx, '\r');
 220
 221         /* Wait for last character to go. */
 222         while (!(in_be16(&psc->psc_status) & PSC_SR_TXEMP))
 223                 ;
 224
 225         out_8(&psc->tfdata_8, c);
 226 }
 227
 228 void serial_putc_raw_dev(unsigned int idx, const char c)
 229 {
 230         volatile immap_t *im = (immap_t *) CONFIG_SYS_IMMR;
 231         volatile psc512x_t *psc = (psc512x_t *) &im->psc[idx];
 232
 233         /* Wait for last character to go. */
 234         while (!(in_be16(&psc->psc_status) & PSC_SR_TXEMP))
 235                 ;
 236
 237         out_8(&psc->tfdata_8, c);
 238 }
 239
 240 void serial_puts_dev(unsigned int idx, const char *s)
 241 {
 242         while (*s)
 243                 serial_putc_dev(idx, *s++);
 244 }
 245
 246 int serial_getc_dev(unsigned int idx)
 247 {
 248         volatile immap_t *im = (immap_t *) CONFIG_SYS_IMMR;
 249         volatile psc512x_t *psc = (psc512x_t *) &im->psc[idx];
 250
 251         /* Wait for a character to arrive. */
 252         while (in_be32(&psc->rfstat) & PSC_FIFO_EMPTY)
 253                 ;
 254
 255         return in_8(&psc->rfdata_8);
 256 }
 257
 258 int serial_tstc_dev(unsigned int idx)
 259 {
 260         volatile immap_t *im = (immap_t *) CONFIG_SYS_IMMR;
 261         volatile psc512x_t *psc = (psc512x_t *) &im->psc[idx];
 262
 263         return !(in_be32(&psc->rfstat) & PSC_FIFO_EMPTY);
 264 }
 265
 266 void serial_setrts_dev(unsigned int idx, int s)
 267 {
 268         volatile immap_t *im = (immap_t *) CONFIG_SYS_IMMR;
 269         volatile psc512x_t *psc = (psc512x_t *) &im->psc[idx];
 270
 271         if (s) {
 272                 /* Assert RTS (become LOW) */
 273                 out_8(&psc->op1, 0x1);
 274         }
 275         else {
 276                 /* Negate RTS (become HIGH) */
 277                 out_8(&psc->op0, 0x1);
 278         }
 279 }
 280
 281 int serial_getcts_dev(unsigned int idx)
 282 {
 283         volatile immap_t *im = (immap_t *) CONFIG_SYS_IMMR;
 284         volatile psc512x_t *psc = (psc512x_t *) &im->psc[idx];
 285
 286         return (in_8(&psc->ip) & 0x1) ? 0 : 1;
 287 }
 288 #endif /* CONFIG_PSC_CONSOLE || CONFIG_SERIAL_MULTI */
 289
 290 #if defined(CONFIG_SERIAL_MULTI)
 291
 292 #define DECLARE_PSC_SERIAL_FUNCTIONS(port) \
 293         int serial##port##_init(void) \
 294         { \
 295                 return serial_init_dev(port); \
 296         } \
 297         int serial##port##_uninit(void) \
 298         { \
 299                 return serial_uninit_dev(port); \
 300         } \
 301         void serial##port##_setbrg(void) \
 302         { \
 303                 serial_setbrg_dev(port); \
 304         } \
 305         int serial##port##_getc(void) \
 306         { \
 307                 return serial_getc_dev(port); \
 308         } \
 309         int serial##port##_tstc(void) \
 310         { \
 311                 return serial_tstc_dev(port); \
 312         } \
 313         void serial##port##_putc(const char c) \
 314         { \
 315                 serial_putc_dev(port, c); \
 316         } \
 317         void serial##port##_puts(const char *s) \
 318         { \
 319                 serial_puts_dev(port, s); \
 320         }
 321
 322 #define INIT_PSC_SERIAL_STRUCTURE(port, name) { \
 323         name, \
 324         serial##port##_init, \
 325         serial##port##_uninit, \
 326         serial##port##_setbrg, \
 327         serial##port##_getc, \
 328         serial##port##_tstc, \
 329         serial##port##_putc, \
 330         serial##port##_puts, \
 331 }
 332
 333 #if defined(CONFIG_SYS_PSC1)
 334 DECLARE_PSC_SERIAL_FUNCTIONS(1);
 335 struct serial_device serial1_device =
 336 INIT_PSC_SERIAL_STRUCTURE(1, "psc1");
 337 #endif
 338
 339 #if defined(CONFIG_SYS_PSC3)
 340 DECLARE_PSC_SERIAL_FUNCTIONS(3);
 341 struct serial_device serial3_device =
 342 INIT_PSC_SERIAL_STRUCTURE(3, "psc3");
 343 #endif
 344
 345 #if defined(CONFIG_SYS_PSC4)
 346 DECLARE_PSC_SERIAL_FUNCTIONS(4);
 347 struct serial_device serial4_device =
 348 INIT_PSC_SERIAL_STRUCTURE(4, "psc4");
 349 #endif
 350
 351 #if defined(CONFIG_SYS_PSC6)
 352 DECLARE_PSC_SERIAL_FUNCTIONS(6);
 353 struct serial_device serial6_device =
 354 INIT_PSC_SERIAL_STRUCTURE(6, "psc6");
 355 #endif
 356
 357 __weak struct serial_device *default_serial_console(void)
 358 {
 359 #if (CONFIG_PSC_CONSOLE == 3)
 360         return &serial3_device;
 361 #elif (CONFIG_PSC_CONSOLE == 6)
 362         return &serial6_device;
 363 #else
 364 #error "invalid CONFIG_PSC_CONSOLE"
 365 #endif
 366 }
 367
 368 #else
 369
 370 void serial_setbrg(void)
 371 {
 372         serial_setbrg_dev(CONFIG_PSC_CONSOLE);
 373 }
 374
 375 int serial_init(void)
 376 {
 377         return serial_init_dev(CONFIG_PSC_CONSOLE);
 378 }
 379
 380 void serial_putc(const char c)
 381 {
 382         serial_putc_dev(CONFIG_PSC_CONSOLE, c);
 383 }
 384
 385 void serial_putc_raw(const char c)
 386 {
 387         serial_putc_raw_dev(CONFIG_PSC_CONSOLE, c);
 388 }
 389
 390 void serial_puts(const char *s)
 391 {
 392         serial_puts_dev(CONFIG_PSC_CONSOLE, s);
 393 }
 394
 395 int serial_getc(void)
 396 {
 397         return serial_getc_dev(CONFIG_PSC_CONSOLE);
 398 }
 399
 400 int serial_tstc(void)
 401 {
 402         return serial_tstc_dev(CONFIG_PSC_CONSOLE);
 403 }
 404
 405 void serial_setrts(int s)
 406 {
 407         return serial_setrts_dev(CONFIG_PSC_CONSOLE, s);
 408 }
 409
 410 int serial_getcts(void)
 411 {
 412         return serial_getcts_dev(CONFIG_PSC_CONSOLE);
 413 }
 414 #endif /* CONFIG_PSC_CONSOLE */
 415
 416 #if defined(CONFIG_SERIAL_MULTI)
 417 #include <stdio_dev.h>
 418 /*
 419  * Routines for communication with serial devices over PSC
 420  */
 421 /* Bitfield for initialized PSCs */
 422 static unsigned int initialized;
 423
 424 struct stdio_dev *open_port(int num, int baudrate)
 425 {
 426         struct stdio_dev *port;
 427         char env_var[16];
 428         char env_val[10];
 429         char name[7];
 430
 431         if (num < 0 || num > 11)
 432                 return NULL;
 433
 434         sprintf(name, "psc%d", num);
 435         port = stdio_get_by_name(name);
 436         if (!port)
 437                 return NULL;
 438
 439         if (!test_bit(num, &initialized)) {
 440                 sprintf(env_var, "psc%d_baudrate", num);
 441                 sprintf(env_val, "%d", baudrate);
 442                 setenv(env_var, env_val);
 443
 444                 if (port->start())
 445                         return NULL;
 446
 447                 set_bit(num, &initialized);
 448         }
 449
 450         return port;
 451 }
 452
 453 int close_port(int num)
 454 {
 455         struct stdio_dev *port;
 456         int ret;
 457         char name[7];
 458
 459         if (num < 0 || num > 11)
 460                 return -1;
 461
 462         sprintf(name, "psc%d", num);
 463         port = stdio_get_by_name(name);
 464         if (!port)
 465                 return -1;
 466
 467         ret = port->stop();
 468         clear_bit(num, &initialized);
 469
 470         return ret;
 471 }
 472
 473 int write_port(struct stdio_dev *port, char *buf)
 474 {
 475         if (!port || !buf)
 476                 return -1;
 477
 478         port->puts(buf);
 479
 480         return 0;
 481 }
 482
 483 int read_port(struct stdio_dev *port, char *buf, int size)
 484 {
 485         int cnt = 0;
 486
 487         if (!port || !buf)
 488                 return -1;
 489
 490         if (!size)
 491                 return 0;
 492
 493         while (port->tstc()) {
 494                 buf[cnt++] = port->getc();
 495                 if (cnt > size)
 496                         break;
 497         }
 498
 499         return cnt;
 500 }
 501 #endif /* CONFIG_SERIAL_MULTI */