drivers/tty/serial/clps711x.c

   1 /*
   2  *  Driver for CLPS711x serial ports
   3  *
   4  *  Based on drivers/char/serial.c, by Linus Torvalds, Theodore Ts'o.
   5  *
   6  *  Copyright 1999 ARM Limited
   7  *  Copyright (C) 2000 Deep Blue Solutions Ltd.
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  */
  23
  24 #if defined(CONFIG_SERIAL_CLPS711X_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
  25 #define SUPPORT_SYSRQ
  26 #endif
  27
  28 #include <linux/module.h>
  29 #include <linux/ioport.h>
  30 #include <linux/init.h>
  31 #include <linux/console.h>
  32 #include <linux/sysrq.h>
  33 #include <linux/spinlock.h>
  34 #include <linux/device.h>
  35 #include <linux/tty.h>
  36 #include <linux/tty_flip.h>
  37 #include <linux/serial_core.h>
  38 #include <linux/serial.h>
  39 #include <linux/io.h>
  40 #include <linux/clk.h>
  41 #include <linux/platform_device.h>
  42
  43 #include <mach/hardware.h>
  44 #include <asm/irq.h>
  45
  46 #define UART_CLPS711X_NAME      "uart-clps711x"
  47 #define UART_CLPS711X_NR        2
  48 #define UART_CLPS711X_MAJOR     204
  49 #define UART_CLPS711X_MINOR     40
  50
  51 #define UBRLCR(port)            ((port)->line ? UBRLCR2 : UBRLCR1)
  52 #define UARTDR(port)            ((port)->line ? UARTDR2 : UARTDR1)
  53 #define SYSFLG(port)            ((port)->line ? SYSFLG2 : SYSFLG1)
  54 #define SYSCON(port)            ((port)->line ? SYSCON2 : SYSCON1)
  55 #define TX_IRQ(port)            ((port)->line ? IRQ_UTXINT2 : IRQ_UTXINT1)
  56 #define RX_IRQ(port)            ((port)->line ? IRQ_URXINT2 : IRQ_URXINT1)
  57
  58 #define UART_ANY_ERR            (UARTDR_FRMERR | UARTDR_PARERR | UARTDR_OVERR)
  59
  60 struct clps711x_port {
  61         struct uart_driver      uart;
  62         struct clk              *uart_clk;
  63         struct uart_port        port[UART_CLPS711X_NR];
  64         int                     tx_enabled[UART_CLPS711X_NR];
  65 #ifdef CONFIG_SERIAL_CLPS711X_CONSOLE
  66         struct console          console;
  67 #endif
  68 };
  69
  70 static void clps711xuart_stop_tx(struct uart_port *port)
  71 {
  72         struct clps711x_port *s = dev_get_drvdata(port->dev);
  73
  74         if (s->tx_enabled[port->line]) {
  75                 disable_irq(TX_IRQ(port));
  76                 s->tx_enabled[port->line] = 0;
  77         }
  78 }
  79
  80 static void clps711xuart_start_tx(struct uart_port *port)
  81 {
  82         struct clps711x_port *s = dev_get_drvdata(port->dev);
  83
  84         if (!s->tx_enabled[port->line]) {
  85                 enable_irq(TX_IRQ(port));
  86                 s->tx_enabled[port->line] = 1;
  87         }
  88 }
  89
  90 static void clps711xuart_stop_rx(struct uart_port *port)
  91 {
  92         disable_irq(RX_IRQ(port));
  93 }
  94
  95 static void clps711xuart_enable_ms(struct uart_port *port)
  96 {
  97 }
  98
  99 static irqreturn_t clps711xuart_int_rx(int irq, void *dev_id)
 100 {
 101         struct uart_port *port = dev_id;
 102         struct tty_struct *tty = port->state->port.tty;
 103         unsigned int status, ch, flg;
 104
 105         status = clps_readl(SYSFLG(port));
 106         while (!(status & SYSFLG_URXFE)) {
 107                 ch = clps_readl(UARTDR(port));
 108
 109                 port->icount.rx++;
 110
 111                 flg = TTY_NORMAL;
 112
 113                 /*
 114                  * Note that the error handling code is
 115                  * out of the main execution path
 116                  */
 117                 if (unlikely(ch & UART_ANY_ERR)) {
 118                         if (ch & UARTDR_PARERR)
 119                                 port->icount.parity++;
 120                         else if (ch & UARTDR_FRMERR)
 121                                 port->icount.frame++;
 122                         if (ch & UARTDR_OVERR)
 123                                 port->icount.overrun++;
 124
 125                         ch &= port->read_status_mask;
 126
 127                         if (ch & UARTDR_PARERR)
 128                                 flg = TTY_PARITY;
 129                         else if (ch & UARTDR_FRMERR)
 130                                 flg = TTY_FRAME;
 131
 132 #ifdef SUPPORT_SYSRQ
 133                         port->sysrq = 0;
 134 #endif
 135                 }
 136
 137                 if (uart_handle_sysrq_char(port, ch))
 138                         goto ignore_char;
 139
 140                 /*
 141                  * CHECK: does overrun affect the current character?
 142                  * ASSUMPTION: it does not.
 143                  */
 144                 uart_insert_char(port, ch, UARTDR_OVERR, ch, flg);
 145
 146         ignore_char:
 147                 status = clps_readl(SYSFLG(port));
 148         }
 149         tty_flip_buffer_push(tty);
 150         return IRQ_HANDLED;
 151 }
 152
 153 static irqreturn_t clps711xuart_int_tx(int irq, void *dev_id)
 154 {
 155         struct uart_port *port = dev_id;
 156         struct clps711x_port *s = dev_get_drvdata(port->dev);
 157         struct circ_buf *xmit = &port->state->xmit;
 158
 159         if (port->x_char) {
 160                 clps_writel(port->x_char, UARTDR(port));
 161                 port->icount.tx++;
 162                 port->x_char = 0;
 163                 return IRQ_HANDLED;
 164         }
 165
 166         if (uart_circ_empty(xmit) || uart_tx_stopped(port)) {
 167                 disable_irq_nosync(TX_IRQ(port));
 168                 s->tx_enabled[port->line] = 0;
 169                 return IRQ_HANDLED;
 170         }
 171
 172         while (!uart_circ_empty(xmit)) {
 173                 clps_writew(xmit->buf[xmit->tail], UARTDR(port));
 174                 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
 175                 port->icount.tx++;
 176                 if (clps_readl(SYSFLG(port) & SYSFLG_UTXFF))
 177                         break;
 178         }
 179
 180         if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
 181                 uart_write_wakeup(port);
 182
 183         return IRQ_HANDLED;
 184 }
 185
 186 static unsigned int clps711xuart_tx_empty(struct uart_port *port)
 187 {
 188         unsigned int status = clps_readl(SYSFLG(port));
 189         return status & SYSFLG_UBUSY ? 0 : TIOCSER_TEMT;
 190 }
 191
 192 static unsigned int clps711xuart_get_mctrl(struct uart_port *port)
 193 {
 194         unsigned int port_addr;
 195         unsigned int result = 0;
 196         unsigned int status;
 197
 198         port_addr = SYSFLG(port);
 199         if (port_addr == SYSFLG1) {
 200                 status = clps_readl(SYSFLG1);
 201                 if (status & SYSFLG1_DCD)
 202                         result |= TIOCM_CAR;
 203                 if (status & SYSFLG1_DSR)
 204                         result |= TIOCM_DSR;
 205                 if (status & SYSFLG1_CTS)
 206                         result |= TIOCM_CTS;
 207         }
 208
 209         return result;
 210 }
 211
 212 static void
 213 clps711xuart_set_mctrl_null(struct uart_port *port, unsigned int mctrl)
 214 {
 215 }
 216
 217 static void clps711xuart_break_ctl(struct uart_port *port, int break_state)
 218 {
 219         unsigned long flags;
 220         unsigned int ubrlcr;
 221
 222         spin_lock_irqsave(&port->lock, flags);
 223         ubrlcr = clps_readl(UBRLCR(port));
 224         if (break_state == -1)
 225                 ubrlcr |= UBRLCR_BREAK;
 226         else
 227                 ubrlcr &= ~UBRLCR_BREAK;
 228         clps_writel(ubrlcr, UBRLCR(port));
 229         spin_unlock_irqrestore(&port->lock, flags);
 230 }
 231
 232 static int clps711xuart_startup(struct uart_port *port)
 233 {
 234         struct clps711x_port *s = dev_get_drvdata(port->dev);
 235         unsigned int syscon;
 236         int retval;
 237
 238         s->tx_enabled[port->line] = 1;
 239
 240         /*
 241          * Allocate the IRQs
 242          */
 243         retval = request_irq(TX_IRQ(port), clps711xuart_int_tx, 0,
 244                              "clps711xuart_tx", port);
 245         if (retval)
 246                 return retval;
 247
 248         retval = request_irq(RX_IRQ(port), clps711xuart_int_rx, 0,
 249                              "clps711xuart_rx", port);
 250         if (retval) {
 251                 free_irq(TX_IRQ(port), port);
 252                 return retval;
 253         }
 254
 255         /*
 256          * enable the port
 257          */
 258         syscon = clps_readl(SYSCON(port));
 259         syscon |= SYSCON_UARTEN;
 260         clps_writel(syscon, SYSCON(port));
 261
 262         return 0;
 263 }
 264
 265 static void clps711xuart_shutdown(struct uart_port *port)
 266 {
 267         unsigned int ubrlcr, syscon;
 268
 269         /*
 270          * Free the interrupt
 271          */
 272         free_irq(TX_IRQ(port), port);   /* TX interrupt */
 273         free_irq(RX_IRQ(port), port);   /* RX interrupt */
 274
 275         /*
 276          * disable the port
 277          */
 278         syscon = clps_readl(SYSCON(port));
 279         syscon &= ~SYSCON_UARTEN;
 280         clps_writel(syscon, SYSCON(port));
 281
 282         /*
 283          * disable break condition and fifos
 284          */
 285         ubrlcr = clps_readl(UBRLCR(port));
 286         ubrlcr &= ~(UBRLCR_FIFOEN | UBRLCR_BREAK);
 287         clps_writel(ubrlcr, UBRLCR(port));
 288 }
 289
 290 static void
 291 clps711xuart_set_termios(struct uart_port *port, struct ktermios *termios,
 292                          struct ktermios *old)
 293 {
 294         unsigned int ubrlcr, baud, quot;
 295         unsigned long flags;
 296
 297         /*
 298          * We don't implement CREAD.
 299          */
 300         termios->c_cflag |= CREAD;
 301
 302         /* Ask the core to calculate the divisor for us */
 303         baud = uart_get_baud_rate(port, termios, old, port->uartclk / 4096,
 304                                                       port->uartclk / 16);
 305         quot = uart_get_divisor(port, baud);
 306
 307         switch (termios->c_cflag & CSIZE) {
 308         case CS5:
 309                 ubrlcr = UBRLCR_WRDLEN5;
 310                 break;
 311         case CS6:
 312                 ubrlcr = UBRLCR_WRDLEN6;
 313                 break;
 314         case CS7:
 315                 ubrlcr = UBRLCR_WRDLEN7;
 316                 break;
 317         default: // CS8
 318                 ubrlcr = UBRLCR_WRDLEN8;
 319                 break;
 320         }
 321         if (termios->c_cflag & CSTOPB)
 322                 ubrlcr |= UBRLCR_XSTOP;
 323         if (termios->c_cflag & PARENB) {
 324                 ubrlcr |= UBRLCR_PRTEN;
 325                 if (!(termios->c_cflag & PARODD))
 326                         ubrlcr |= UBRLCR_EVENPRT;
 327         }
 328
 329         /* Enable FIFO */
 330         ubrlcr |= UBRLCR_FIFOEN;
 331
 332         spin_lock_irqsave(&port->lock, flags);
 333
 334         /*
 335          * Update the per-port timeout.
 336          */
 337         uart_update_timeout(port, termios->c_cflag, baud);
 338
 339         port->read_status_mask = UARTDR_OVERR;
 340         if (termios->c_iflag & INPCK)
 341                 port->read_status_mask |= UARTDR_PARERR | UARTDR_FRMERR;
 342
 343         /*
 344          * Characters to ignore
 345          */
 346         port->ignore_status_mask = 0;
 347         if (termios->c_iflag & IGNPAR)
 348                 port->ignore_status_mask |= UARTDR_FRMERR | UARTDR_PARERR;
 349         if (termios->c_iflag & IGNBRK) {
 350                 /*
 351                  * If we're ignoring parity and break indicators,
 352                  * ignore overruns to (for real raw support).
 353                  */
 354                 if (termios->c_iflag & IGNPAR)
 355                         port->ignore_status_mask |= UARTDR_OVERR;
 356         }
 357
 358         quot -= 1;
 359
 360         clps_writel(ubrlcr | quot, UBRLCR(port));
 361
 362         spin_unlock_irqrestore(&port->lock, flags);
 363 }
 364
 365 static const char *clps711xuart_type(struct uart_port *port)
 366 {
 367         return port->type == PORT_CLPS711X ? "CLPS711x" : NULL;
 368 }
 369
 370 /*
 371  * Configure/autoconfigure the port.
 372  */
 373 static void clps711xuart_config_port(struct uart_port *port, int flags)
 374 {
 375         if (flags & UART_CONFIG_TYPE)
 376                 port->type = PORT_CLPS711X;
 377 }
 378
 379 static void clps711xuart_release_port(struct uart_port *port)
 380 {
 381 }
 382
 383 static int clps711xuart_request_port(struct uart_port *port)
 384 {
 385         return 0;
 386 }
 387
 388 static struct uart_ops uart_clps711x_ops = {
 389         .tx_empty       = clps711xuart_tx_empty,
 390         .set_mctrl      = clps711xuart_set_mctrl_null,
 391         .get_mctrl      = clps711xuart_get_mctrl,
 392         .stop_tx        = clps711xuart_stop_tx,
 393         .start_tx       = clps711xuart_start_tx,
 394         .stop_rx        = clps711xuart_stop_rx,
 395         .enable_ms      = clps711xuart_enable_ms,
 396         .break_ctl      = clps711xuart_break_ctl,
 397         .startup        = clps711xuart_startup,
 398         .shutdown       = clps711xuart_shutdown,
 399         .set_termios    = clps711xuart_set_termios,
 400         .type           = clps711xuart_type,
 401         .config_port    = clps711xuart_config_port,
 402         .release_port   = clps711xuart_release_port,
 403         .request_port   = clps711xuart_request_port,
 404 };
 405
 406 #ifdef CONFIG_SERIAL_CLPS711X_CONSOLE
 407 static void uart_clps711x_console_putchar(struct uart_port *port, int ch)
 408 {
 409         while (clps_readl(SYSFLG(port)) & SYSFLG_UTXFF)
 410                 barrier();
 411
 412         clps_writew(ch, UARTDR(port));
 413 }
 414
 415 static void uart_clps711x_console_write(struct console *co, const char *c,
 416                                         unsigned n)
 417 {
 418         struct clps711x_port *s = (struct clps711x_port *)co->data;
 419         struct uart_port *port = &s->port[co->index];
 420         u32 syscon;
 421
 422         /* Ensure that the port is enabled */
 423         syscon = clps_readl(SYSCON(port));
 424         clps_writel(syscon | SYSCON_UARTEN, SYSCON(port));
 425
 426         uart_console_write(port, c, n, uart_clps711x_console_putchar);
 427
 428         /* Wait for transmitter to become empty */
 429         while (clps_readl(SYSFLG(port)) & SYSFLG_UBUSY)
 430                 barrier();
 431
 432         /* Restore the uart state */
 433         clps_writel(syscon, SYSCON(port));
 434 }
 435
 436 static void uart_clps711x_console_get_options(struct uart_port *port,
 437                                               int *baud, int *parity,
 438                                               int *bits)
 439 {
 440         if (clps_readl(SYSCON(port)) & SYSCON_UARTEN) {
 441                 unsigned int ubrlcr, quot;
 442
 443                 ubrlcr = clps_readl(UBRLCR(port));
 444
 445                 *parity = 'n';
 446                 if (ubrlcr & UBRLCR_PRTEN) {
 447                         if (ubrlcr & UBRLCR_EVENPRT)
 448                                 *parity = 'e';
 449                         else
 450                                 *parity = 'o';
 451                 }
 452
 453                 if ((ubrlcr & UBRLCR_WRDLEN_MASK) == UBRLCR_WRDLEN7)
 454                         *bits = 7;
 455                 else
 456                         *bits = 8;
 457
 458                 quot = ubrlcr & UBRLCR_BAUD_MASK;
 459                 *baud = port->uartclk / (16 * (quot + 1));
 460         }
 461 }
 462
 463 static int uart_clps711x_console_setup(struct console *co, char *options)
 464 {
 465         int baud = 38400, bits = 8, parity = 'n', flow = 'n';
 466         struct clps711x_port *s = (struct clps711x_port *)co->data;
 467         struct uart_port *port = &s->port[(co->index > 0) ? co->index : 0];
 468
 469         if (options)
 470                 uart_parse_options(options, &baud, &parity, &bits, &flow);
 471         else
 472                 uart_clps711x_console_get_options(port, &baud, &parity, &bits);
 473
 474         return uart_set_options(port, co, baud, parity, bits, flow);
 475 }
 476 #endif
 477
 478 static int __devinit uart_clps711x_probe(struct platform_device *pdev)
 479 {
 480         struct clps711x_port *s;
 481         int ret, i;
 482
 483         s = devm_kzalloc(&pdev->dev, sizeof(struct clps711x_port), GFP_KERNEL);
 484         if (!s) {
 485                 dev_err(&pdev->dev, "Error allocating port structure\n");
 486                 return -ENOMEM;
 487         }
 488         platform_set_drvdata(pdev, s);
 489
 490         s->uart_clk = devm_clk_get(&pdev->dev, "uart");
 491         if (IS_ERR(s->uart_clk)) {
 492                 dev_err(&pdev->dev, "Can't get UART clocks\n");
 493                 ret = PTR_ERR(s->uart_clk);
 494                 goto err_out;
 495         }
 496
 497         s->uart.owner           = THIS_MODULE;
 498         s->uart.dev_name        = "ttyCL";
 499         s->uart.major           = UART_CLPS711X_MAJOR;
 500         s->uart.minor           = UART_CLPS711X_MINOR;
 501         s->uart.nr              = UART_CLPS711X_NR;
 502 #ifdef CONFIG_SERIAL_CLPS711X_CONSOLE
 503         s->uart.cons            = &s->console;
 504         s->uart.cons->device    = uart_console_device;
 505         s->uart.cons->write     = uart_clps711x_console_write;
 506         s->uart.cons->setup     = uart_clps711x_console_setup;
 507         s->uart.cons->flags     = CON_PRINTBUFFER;
 508         s->uart.cons->index     = -1;
 509         s->uart.cons->data      = s;
 510         strcpy(s->uart.cons->name, "ttyCL");
 511 #endif
 512         ret = uart_register_driver(&s->uart);
 513         if (ret) {
 514                 dev_err(&pdev->dev, "Registering UART driver failed\n");
 515                 devm_clk_put(&pdev->dev, s->uart_clk);
 516                 goto err_out;
 517         }
 518
 519         for (i = 0; i < UART_CLPS711X_NR; i++) {
 520                 s->port[i].line         = i;
 521                 s->port[i].dev          = &pdev->dev;
 522                 s->port[i].irq          = TX_IRQ(&s->port[i]);
 523                 s->port[i].iobase       = SYSCON(&s->port[i]);
 524                 s->port[i].type         = PORT_CLPS711X;
 525                 s->port[i].fifosize     = 16;
 526                 s->port[i].flags        = UPF_SKIP_TEST | UPF_FIXED_TYPE;
 527                 s->port[i].uartclk      = clk_get_rate(s->uart_clk);
 528                 s->port[i].ops          = &uart_clps711x_ops;
 529                 WARN_ON(uart_add_one_port(&s->uart, &s->port[i]));
 530         }
 531
 532         return 0;
 533
 534 err_out:
 535         platform_set_drvdata(pdev, NULL);
 536
 537         return ret;
 538 }
 539
 540 static int __devexit uart_clps711x_remove(struct platform_device *pdev)
 541 {
 542         struct clps711x_port *s = platform_get_drvdata(pdev);
 543         int i;
 544
 545         for (i = 0; i < UART_CLPS711X_NR; i++)
 546                 uart_remove_one_port(&s->uart, &s->port[i]);
 547
 548         devm_clk_put(&pdev->dev, s->uart_clk);
 549         uart_unregister_driver(&s->uart);
 550         platform_set_drvdata(pdev, NULL);
 551
 552         return 0;
 553 }
 554
 555 static struct platform_driver clps711x_uart_driver = {
 556         .driver = {
 557                 .name   = UART_CLPS711X_NAME,
 558                 .owner  = THIS_MODULE,
 559         },
 560         .probe  = uart_clps711x_probe,
 561         .remove = __devexit_p(uart_clps711x_remove),
 562 };
 563 module_platform_driver(clps711x_uart_driver);
 564
 565 static struct platform_device clps711x_uart_device = {
 566         .name   = UART_CLPS711X_NAME,
 567 };
 568
 569 static int __init uart_clps711x_init(void)
 570 {
 571         return platform_device_register(&clps711x_uart_device);
 572 }
 573 module_init(uart_clps711x_init);
 574
 575 static void __exit uart_clps711x_exit(void)
 576 {
 577         platform_device_unregister(&clps711x_uart_device);
 578 }
 579 module_exit(uart_clps711x_exit);
 580
 581 MODULE_AUTHOR("Deep Blue Solutions Ltd");
 582 MODULE_DESCRIPTION("CLPS711X serial driver");
 583 MODULE_LICENSE("GPL");