drivers/tty/serial/mxs-auart.c

   1 /*
   2  * Freescale STMP37XX/STMP378X Application UART driver
   3  *
   4  * Author: dmitry pervushin <dimka@embeddedalley.com>
   5  *
   6  * Copyright 2008-2010 Freescale Semiconductor, Inc.
   7  * Copyright 2008 Embedded Alley Solutions, Inc All Rights Reserved.
   8  *
   9  * The code contained herein is licensed under the GNU General Public
  10  * License. You may obtain a copy of the GNU General Public License
  11  * Version 2 or later at the following locations:
  12  *
  13  * http://www.opensource.org/licenses/gpl-license.html
  14  * http://www.gnu.org/copyleft/gpl.html
  15  */
  16
  17 #include <linux/kernel.h>
  18 #include <linux/errno.h>
  19 #include <linux/init.h>
  20 #include <linux/console.h>
  21 #include <linux/interrupt.h>
  22 #include <linux/module.h>
  23 #include <linux/slab.h>
  24 #include <linux/wait.h>
  25 #include <linux/tty.h>
  26 #include <linux/tty_driver.h>
  27 #include <linux/tty_flip.h>
  28 #include <linux/serial.h>
  29 #include <linux/serial_core.h>
  30 #include <linux/platform_device.h>
  31 #include <linux/device.h>
  32 #include <linux/clk.h>
  33 #include <linux/delay.h>
  34 #include <linux/io.h>
  35 #include <linux/pinctrl/consumer.h>
  36 #include <linux/of_device.h>
  37 #include <linux/dma-mapping.h>
  38 #include <linux/fsl/mxs-dma.h>
  39
  40 #include <asm/cacheflush.h>
  41
  42 #define MXS_AUART_PORTS 5
  43
  44 #define AUART_CTRL0                     0x00000000
  45 #define AUART_CTRL0_SET                 0x00000004
  46 #define AUART_CTRL0_CLR                 0x00000008
  47 #define AUART_CTRL0_TOG                 0x0000000c
  48 #define AUART_CTRL1                     0x00000010
  49 #define AUART_CTRL1_SET                 0x00000014
  50 #define AUART_CTRL1_CLR                 0x00000018
  51 #define AUART_CTRL1_TOG                 0x0000001c
  52 #define AUART_CTRL2                     0x00000020
  53 #define AUART_CTRL2_SET                 0x00000024
  54 #define AUART_CTRL2_CLR                 0x00000028
  55 #define AUART_CTRL2_TOG                 0x0000002c
  56 #define AUART_LINECTRL                  0x00000030
  57 #define AUART_LINECTRL_SET              0x00000034
  58 #define AUART_LINECTRL_CLR              0x00000038
  59 #define AUART_LINECTRL_TOG              0x0000003c
  60 #define AUART_LINECTRL2                 0x00000040
  61 #define AUART_LINECTRL2_SET             0x00000044
  62 #define AUART_LINECTRL2_CLR             0x00000048
  63 #define AUART_LINECTRL2_TOG             0x0000004c
  64 #define AUART_INTR                      0x00000050
  65 #define AUART_INTR_SET                  0x00000054
  66 #define AUART_INTR_CLR                  0x00000058
  67 #define AUART_INTR_TOG                  0x0000005c
  68 #define AUART_DATA                      0x00000060
  69 #define AUART_STAT                      0x00000070
  70 #define AUART_DEBUG                     0x00000080
  71 #define AUART_VERSION                   0x00000090
  72 #define AUART_AUTOBAUD                  0x000000a0
  73
  74 #define AUART_CTRL0_SFTRST                      (1 << 31)
  75 #define AUART_CTRL0_CLKGATE                     (1 << 30)
  76 #define AUART_CTRL0_RXTO_ENABLE                 (1 << 27)
  77 #define AUART_CTRL0_RXTIMEOUT(v)                (((v) & 0x7ff) << 16)
  78 #define AUART_CTRL0_XFER_COUNT(v)               ((v) & 0xffff)
  79
  80 #define AUART_CTRL1_XFER_COUNT(v)               ((v) & 0xffff)
  81
  82 #define AUART_CTRL2_DMAONERR                    (1 << 26)
  83 #define AUART_CTRL2_TXDMAE                      (1 << 25)
  84 #define AUART_CTRL2_RXDMAE                      (1 << 24)
  85
  86 #define AUART_CTRL2_CTSEN                       (1 << 15)
  87 #define AUART_CTRL2_RTSEN                       (1 << 14)
  88 #define AUART_CTRL2_RTS                         (1 << 11)
  89 #define AUART_CTRL2_RXE                         (1 << 9)
  90 #define AUART_CTRL2_TXE                         (1 << 8)
  91 #define AUART_CTRL2_UARTEN                      (1 << 0)
  92
  93 #define AUART_LINECTRL_BAUD_DIVINT_SHIFT        16
  94 #define AUART_LINECTRL_BAUD_DIVINT_MASK         0xffff0000
  95 #define AUART_LINECTRL_BAUD_DIVINT(v)           (((v) & 0xffff) << 16)
  96 #define AUART_LINECTRL_BAUD_DIVFRAC_SHIFT       8
  97 #define AUART_LINECTRL_BAUD_DIVFRAC_MASK        0x00003f00
  98 #define AUART_LINECTRL_BAUD_DIVFRAC(v)          (((v) & 0x3f) << 8)
  99 #define AUART_LINECTRL_WLEN_MASK                0x00000060
 100 #define AUART_LINECTRL_WLEN(v)                  (((v) & 0x3) << 5)
 101 #define AUART_LINECTRL_FEN                      (1 << 4)
 102 #define AUART_LINECTRL_STP2                     (1 << 3)
 103 #define AUART_LINECTRL_EPS                      (1 << 2)
 104 #define AUART_LINECTRL_PEN                      (1 << 1)
 105 #define AUART_LINECTRL_BRK                      (1 << 0)
 106
 107 #define AUART_INTR_RTIEN                        (1 << 22)
 108 #define AUART_INTR_TXIEN                        (1 << 21)
 109 #define AUART_INTR_RXIEN                        (1 << 20)
 110 #define AUART_INTR_CTSMIEN                      (1 << 17)
 111 #define AUART_INTR_RTIS                         (1 << 6)
 112 #define AUART_INTR_TXIS                         (1 << 5)
 113 #define AUART_INTR_RXIS                         (1 << 4)
 114 #define AUART_INTR_CTSMIS                       (1 << 1)
 115
 116 #define AUART_STAT_BUSY                         (1 << 29)
 117 #define AUART_STAT_CTS                          (1 << 28)
 118 #define AUART_STAT_TXFE                         (1 << 27)
 119 #define AUART_STAT_TXFF                         (1 << 25)
 120 #define AUART_STAT_RXFE                         (1 << 24)
 121 #define AUART_STAT_OERR                         (1 << 19)
 122 #define AUART_STAT_BERR                         (1 << 18)
 123 #define AUART_STAT_PERR                         (1 << 17)
 124 #define AUART_STAT_FERR                         (1 << 16)
 125 #define AUART_STAT_RXCOUNT_MASK                 0xffff
 126
 127 static struct uart_driver auart_driver;
 128
 129 enum mxs_auart_type {
 130         IMX23_AUART,
 131         IMX28_AUART,
 132 };
 133
 134 struct mxs_auart_port {
 135         struct uart_port port;
 136
 137 #define MXS_AUART_DMA_CONFIG    0x1
 138 #define MXS_AUART_DMA_ENABLED   0x2
 139 #define MXS_AUART_DMA_TX_SYNC   2  /* bit 2 */
 140 #define MXS_AUART_DMA_RX_READY  3  /* bit 3 */
 141         unsigned long flags;
 142         unsigned int ctrl;
 143         enum mxs_auart_type devtype;
 144
 145         unsigned int irq;
 146
 147         struct clk *clk;
 148         struct device *dev;
 149
 150         /* for DMA */
 151         struct mxs_dma_data dma_data;
 152         int dma_channel_rx, dma_channel_tx;
 153         int dma_irq_rx, dma_irq_tx;
 154         int dma_channel;
 155
 156         struct scatterlist tx_sgl;
 157         struct dma_chan *tx_dma_chan;
 158         void *tx_dma_buf;
 159
 160         struct scatterlist rx_sgl;
 161         struct dma_chan *rx_dma_chan;
 162         void *rx_dma_buf;
 163 };
 164
 165 static struct platform_device_id mxs_auart_devtype[] = {
 166         { .name = "mxs-auart-imx23", .driver_data = IMX23_AUART },
 167         { .name = "mxs-auart-imx28", .driver_data = IMX28_AUART },
 168         { /* sentinel */ }
 169 };
 170 MODULE_DEVICE_TABLE(platform, mxs_auart_devtype);
 171
 172 static struct of_device_id mxs_auart_dt_ids[] = {
 173         {
 174                 .compatible = "fsl,imx28-auart",
 175                 .data = &mxs_auart_devtype[IMX28_AUART]
 176         }, {
 177                 .compatible = "fsl,imx23-auart",
 178                 .data = &mxs_auart_devtype[IMX23_AUART]
 179         }, { /* sentinel */ }
 180 };
 181 MODULE_DEVICE_TABLE(of, mxs_auart_dt_ids);
 182
 183 static inline int is_imx28_auart(struct mxs_auart_port *s)
 184 {
 185         return s->devtype == IMX28_AUART;
 186 }
 187
 188 static inline bool auart_dma_enabled(struct mxs_auart_port *s)
 189 {
 190         return s->flags & MXS_AUART_DMA_ENABLED;
 191 }
 192
 193 static void mxs_auart_stop_tx(struct uart_port *u);
 194
 195 #define to_auart_port(u) container_of(u, struct mxs_auart_port, port)
 196
 197 static void mxs_auart_tx_chars(struct mxs_auart_port *s);
 198
 199 static void dma_tx_callback(void *param)
 200 {
 201         struct mxs_auart_port *s = param;
 202         struct circ_buf *xmit = &s->port.state->xmit;
 203
 204         dma_unmap_sg(s->dev, &s->tx_sgl, 1, DMA_TO_DEVICE);
 205
 206         /* clear the bit used to serialize the DMA tx. */
 207         clear_bit(MXS_AUART_DMA_TX_SYNC, &s->flags);
 208         smp_mb__after_clear_bit();
 209
 210         /* wake up the possible processes. */
 211         if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
 212                 uart_write_wakeup(&s->port);
 213
 214         mxs_auart_tx_chars(s);
 215 }
 216
 217 static int mxs_auart_dma_tx(struct mxs_auart_port *s, int size)
 218 {
 219         struct dma_async_tx_descriptor *desc;
 220         struct scatterlist *sgl = &s->tx_sgl;
 221         struct dma_chan *channel = s->tx_dma_chan;
 222         u32 pio;
 223
 224         /* [1] : send PIO. Note, the first pio word is CTRL1. */
 225         pio = AUART_CTRL1_XFER_COUNT(size);
 226         desc = dmaengine_prep_slave_sg(channel, (struct scatterlist *)&pio,
 227                                         1, DMA_TRANS_NONE, 0);
 228         if (!desc) {
 229                 dev_err(s->dev, "step 1 error\n");
 230                 return -EINVAL;
 231         }
 232
 233         /* [2] : set DMA buffer. */
 234         sg_init_one(sgl, s->tx_dma_buf, size);
 235         dma_map_sg(s->dev, sgl, 1, DMA_TO_DEVICE);
 236         desc = dmaengine_prep_slave_sg(channel, sgl,
 237                         1, DMA_MEM_TO_DEV, DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
 238         if (!desc) {
 239                 dev_err(s->dev, "step 2 error\n");
 240                 return -EINVAL;
 241         }
 242
 243         /* [3] : submit the DMA */
 244         desc->callback = dma_tx_callback;
 245         desc->callback_param = s;
 246         dmaengine_submit(desc);
 247         dma_async_issue_pending(channel);
 248         return 0;
 249 }
 250
 251 static void mxs_auart_tx_chars(struct mxs_auart_port *s)
 252 {
 253         struct circ_buf *xmit = &s->port.state->xmit;
 254
 255         if (auart_dma_enabled(s)) {
 256                 int i = 0;
 257                 int size;
 258                 void *buffer = s->tx_dma_buf;
 259
 260                 if (test_and_set_bit(MXS_AUART_DMA_TX_SYNC, &s->flags))
 261                         return;
 262
 263                 while (!uart_circ_empty(xmit) && !uart_tx_stopped(&s->port)) {
 264                         size = min_t(u32, UART_XMIT_SIZE - i,
 265                                      CIRC_CNT_TO_END(xmit->head,
 266                                                      xmit->tail,
 267                                                      UART_XMIT_SIZE));
 268                         memcpy(buffer + i, xmit->buf + xmit->tail, size);
 269                         xmit->tail = (xmit->tail + size) & (UART_XMIT_SIZE - 1);
 270
 271                         i += size;
 272                         if (i >= UART_XMIT_SIZE)
 273                                 break;
 274                 }
 275
 276                 if (uart_tx_stopped(&s->port))
 277                         mxs_auart_stop_tx(&s->port);
 278
 279                 if (i) {
 280                         mxs_auart_dma_tx(s, i);
 281                 } else {
 282                         clear_bit(MXS_AUART_DMA_TX_SYNC, &s->flags);
 283                         smp_mb__after_clear_bit();
 284                 }
 285                 return;
 286         }
 287
 288
 289         while (!(readl(s->port.membase + AUART_STAT) &
 290                  AUART_STAT_TXFF)) {
 291                 if (s->port.x_char) {
 292                         s->port.icount.tx++;
 293                         writel(s->port.x_char,
 294                                      s->port.membase + AUART_DATA);
 295                         s->port.x_char = 0;
 296                         continue;
 297                 }
 298                 if (!uart_circ_empty(xmit) && !uart_tx_stopped(&s->port)) {
 299                         s->port.icount.tx++;
 300                         writel(xmit->buf[xmit->tail],
 301                                      s->port.membase + AUART_DATA);
 302                         xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
 303                 } else
 304                         break;
 305         }
 306         if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
 307                 uart_write_wakeup(&s->port);
 308
 309         if (uart_circ_empty(&(s->port.state->xmit)))
 310                 writel(AUART_INTR_TXIEN,
 311                              s->port.membase + AUART_INTR_CLR);
 312         else
 313                 writel(AUART_INTR_TXIEN,
 314                              s->port.membase + AUART_INTR_SET);
 315
 316         if (uart_tx_stopped(&s->port))
 317                 mxs_auart_stop_tx(&s->port);
 318 }
 319
 320 static void mxs_auart_rx_char(struct mxs_auart_port *s)
 321 {
 322         int flag;
 323         u32 stat;
 324         u8 c;
 325
 326         c = readl(s->port.membase + AUART_DATA);
 327         stat = readl(s->port.membase + AUART_STAT);
 328
 329         flag = TTY_NORMAL;
 330         s->port.icount.rx++;
 331
 332         if (stat & AUART_STAT_BERR) {
 333                 s->port.icount.brk++;
 334                 if (uart_handle_break(&s->port))
 335                         goto out;
 336         } else if (stat & AUART_STAT_PERR) {
 337                 s->port.icount.parity++;
 338         } else if (stat & AUART_STAT_FERR) {
 339                 s->port.icount.frame++;
 340         }
 341
 342         /*
 343          * Mask off conditions which should be ingored.
 344          */
 345         stat &= s->port.read_status_mask;
 346
 347         if (stat & AUART_STAT_BERR) {
 348                 flag = TTY_BREAK;
 349         } else if (stat & AUART_STAT_PERR)
 350                 flag = TTY_PARITY;
 351         else if (stat & AUART_STAT_FERR)
 352                 flag = TTY_FRAME;
 353
 354         if (stat & AUART_STAT_OERR)
 355                 s->port.icount.overrun++;
 356
 357         if (uart_handle_sysrq_char(&s->port, c))
 358                 goto out;
 359
 360         uart_insert_char(&s->port, stat, AUART_STAT_OERR, c, flag);
 361 out:
 362         writel(stat, s->port.membase + AUART_STAT);
 363 }
 364
 365 static void mxs_auart_rx_chars(struct mxs_auart_port *s)
 366 {
 367         u32 stat = 0;
 368
 369         for (;;) {
 370                 stat = readl(s->port.membase + AUART_STAT);
 371                 if (stat & AUART_STAT_RXFE)
 372                         break;
 373                 mxs_auart_rx_char(s);
 374         }
 375
 376         writel(stat, s->port.membase + AUART_STAT);
 377         tty_flip_buffer_push(&s->port.state->port);
 378 }
 379
 380 static int mxs_auart_request_port(struct uart_port *u)
 381 {
 382         return 0;
 383 }
 384
 385 static int mxs_auart_verify_port(struct uart_port *u,
 386                                     struct serial_struct *ser)
 387 {
 388         if (u->type != PORT_UNKNOWN && u->type != PORT_IMX)
 389                 return -EINVAL;
 390         return 0;
 391 }
 392
 393 static void mxs_auart_config_port(struct uart_port *u, int flags)
 394 {
 395 }
 396
 397 static const char *mxs_auart_type(struct uart_port *u)
 398 {
 399         struct mxs_auart_port *s = to_auart_port(u);
 400
 401         return dev_name(s->dev);
 402 }
 403
 404 static void mxs_auart_release_port(struct uart_port *u)
 405 {
 406 }
 407
 408 static void mxs_auart_set_mctrl(struct uart_port *u, unsigned mctrl)
 409 {
 410         struct mxs_auart_port *s = to_auart_port(u);
 411
 412         u32 ctrl = readl(u->membase + AUART_CTRL2);
 413
 414         ctrl &= ~AUART_CTRL2_RTSEN;
 415         if (mctrl & TIOCM_RTS) {
 416                 if (tty_port_cts_enabled(&u->state->port))
 417                         ctrl |= AUART_CTRL2_RTSEN;
 418         }
 419
 420         s->ctrl = mctrl;
 421         writel(ctrl, u->membase + AUART_CTRL2);
 422 }
 423
 424 static u32 mxs_auart_get_mctrl(struct uart_port *u)
 425 {
 426         struct mxs_auart_port *s = to_auart_port(u);
 427         u32 stat = readl(u->membase + AUART_STAT);
 428         int ctrl2 = readl(u->membase + AUART_CTRL2);
 429         u32 mctrl = s->ctrl;
 430
 431         mctrl &= ~TIOCM_CTS;
 432         if (stat & AUART_STAT_CTS)
 433                 mctrl |= TIOCM_CTS;
 434
 435         if (ctrl2 & AUART_CTRL2_RTS)
 436                 mctrl |= TIOCM_RTS;
 437
 438         return mctrl;
 439 }
 440
 441 static bool mxs_auart_dma_filter(struct dma_chan *chan, void *param)
 442 {
 443         struct mxs_auart_port *s = param;
 444
 445         if (!mxs_dma_is_apbx(chan))
 446                 return false;
 447
 448         if (s->dma_channel == chan->chan_id) {
 449                 chan->private = &s->dma_data;
 450                 return true;
 451         }
 452         return false;
 453 }
 454
 455 static int mxs_auart_dma_prep_rx(struct mxs_auart_port *s);
 456 static void dma_rx_callback(void *arg)
 457 {
 458         struct mxs_auart_port *s = (struct mxs_auart_port *) arg;
 459         struct tty_port *port = &s->port.state->port;
 460         int count;
 461         u32 stat;
 462
 463         dma_unmap_sg(s->dev, &s->rx_sgl, 1, DMA_FROM_DEVICE);
 464
 465         stat = readl(s->port.membase + AUART_STAT);
 466         stat &= ~(AUART_STAT_OERR | AUART_STAT_BERR |
 467                         AUART_STAT_PERR | AUART_STAT_FERR);
 468
 469         count = stat & AUART_STAT_RXCOUNT_MASK;
 470         tty_insert_flip_string(port, s->rx_dma_buf, count);
 471
 472         writel(stat, s->port.membase + AUART_STAT);
 473         tty_flip_buffer_push(port);
 474
 475         /* start the next DMA for RX. */
 476         mxs_auart_dma_prep_rx(s);
 477 }
 478
 479 static int mxs_auart_dma_prep_rx(struct mxs_auart_port *s)
 480 {
 481         struct dma_async_tx_descriptor *desc;
 482         struct scatterlist *sgl = &s->rx_sgl;
 483         struct dma_chan *channel = s->rx_dma_chan;
 484         u32 pio[1];
 485
 486         /* [1] : send PIO */
 487         pio[0] = AUART_CTRL0_RXTO_ENABLE
 488                 | AUART_CTRL0_RXTIMEOUT(0x80)
 489                 | AUART_CTRL0_XFER_COUNT(UART_XMIT_SIZE);
 490         desc = dmaengine_prep_slave_sg(channel, (struct scatterlist *)pio,
 491                                         1, DMA_TRANS_NONE, 0);
 492         if (!desc) {
 493                 dev_err(s->dev, "step 1 error\n");
 494                 return -EINVAL;
 495         }
 496
 497         /* [2] : send DMA request */
 498         sg_init_one(sgl, s->rx_dma_buf, UART_XMIT_SIZE);
 499         dma_map_sg(s->dev, sgl, 1, DMA_FROM_DEVICE);
 500         desc = dmaengine_prep_slave_sg(channel, sgl, 1, DMA_DEV_TO_MEM,
 501                                         DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
 502         if (!desc) {
 503                 dev_err(s->dev, "step 2 error\n");
 504                 return -1;
 505         }
 506
 507         /* [3] : submit the DMA, but do not issue it. */
 508         desc->callback = dma_rx_callback;
 509         desc->callback_param = s;
 510         dmaengine_submit(desc);
 511         dma_async_issue_pending(channel);
 512         return 0;
 513 }
 514
 515 static void mxs_auart_dma_exit_channel(struct mxs_auart_port *s)
 516 {
 517         if (s->tx_dma_chan) {
 518                 dma_release_channel(s->tx_dma_chan);
 519                 s->tx_dma_chan = NULL;
 520         }
 521         if (s->rx_dma_chan) {
 522                 dma_release_channel(s->rx_dma_chan);
 523                 s->rx_dma_chan = NULL;
 524         }
 525
 526         kfree(s->tx_dma_buf);
 527         kfree(s->rx_dma_buf);
 528         s->tx_dma_buf = NULL;
 529         s->rx_dma_buf = NULL;
 530 }
 531
 532 static void mxs_auart_dma_exit(struct mxs_auart_port *s)
 533 {
 534
 535         writel(AUART_CTRL2_TXDMAE | AUART_CTRL2_RXDMAE | AUART_CTRL2_DMAONERR,
 536                 s->port.membase + AUART_CTRL2_CLR);
 537
 538         mxs_auart_dma_exit_channel(s);
 539         s->flags &= ~MXS_AUART_DMA_ENABLED;
 540         clear_bit(MXS_AUART_DMA_TX_SYNC, &s->flags);
 541         clear_bit(MXS_AUART_DMA_RX_READY, &s->flags);
 542 }
 543
 544 static int mxs_auart_dma_init(struct mxs_auart_port *s)
 545 {
 546         dma_cap_mask_t mask;
 547
 548         if (auart_dma_enabled(s))
 549                 return 0;
 550
 551         /* We do not get the right DMA channels. */
 552         if (s->dma_channel_rx == -1 || s->dma_channel_tx == -1)
 553                 return -EINVAL;
 554
 555         /* init for RX */
 556         dma_cap_zero(mask);
 557         dma_cap_set(DMA_SLAVE, mask);
 558         s->dma_channel = s->dma_channel_rx;
 559         s->dma_data.chan_irq = s->dma_irq_rx;
 560         s->rx_dma_chan = dma_request_channel(mask, mxs_auart_dma_filter, s);
 561         if (!s->rx_dma_chan)
 562                 goto err_out;
 563         s->rx_dma_buf = kzalloc(UART_XMIT_SIZE, GFP_KERNEL | GFP_DMA);
 564         if (!s->rx_dma_buf)
 565                 goto err_out;
 566
 567         /* init for TX */
 568         s->dma_channel = s->dma_channel_tx;
 569         s->dma_data.chan_irq = s->dma_irq_tx;
 570         s->tx_dma_chan = dma_request_channel(mask, mxs_auart_dma_filter, s);
 571         if (!s->tx_dma_chan)
 572                 goto err_out;
 573         s->tx_dma_buf = kzalloc(UART_XMIT_SIZE, GFP_KERNEL | GFP_DMA);
 574         if (!s->tx_dma_buf)
 575                 goto err_out;
 576
 577         /* set the flags */
 578         s->flags |= MXS_AUART_DMA_ENABLED;
 579         dev_dbg(s->dev, "enabled the DMA support.");
 580
 581         return 0;
 582
 583 err_out:
 584         mxs_auart_dma_exit_channel(s);
 585         return -EINVAL;
 586
 587 }
 588
 589 static void mxs_auart_settermios(struct uart_port *u,
 590                                  struct ktermios *termios,
 591                                  struct ktermios *old)
 592 {
 593         struct mxs_auart_port *s = to_auart_port(u);
 594         u32 bm, ctrl, ctrl2, div;
 595         unsigned int cflag, baud;
 596
 597         cflag = termios->c_cflag;
 598
 599         ctrl = AUART_LINECTRL_FEN;
 600         ctrl2 = readl(u->membase + AUART_CTRL2);
 601
 602         /* byte size */
 603         switch (cflag & CSIZE) {
 604         case CS5:
 605                 bm = 0;
 606                 break;
 607         case CS6:
 608                 bm = 1;
 609                 break;
 610         case CS7:
 611                 bm = 2;
 612                 break;
 613         case CS8:
 614                 bm = 3;
 615                 break;
 616         default:
 617                 return;
 618         }
 619
 620         ctrl |= AUART_LINECTRL_WLEN(bm);
 621
 622         /* parity */
 623         if (cflag & PARENB) {
 624                 ctrl |= AUART_LINECTRL_PEN;
 625                 if ((cflag & PARODD) == 0)
 626                         ctrl |= AUART_LINECTRL_EPS;
 627         }
 628
 629         u->read_status_mask = 0;
 630
 631         if (termios->c_iflag & INPCK)
 632                 u->read_status_mask |= AUART_STAT_PERR;
 633         if (termios->c_iflag & (BRKINT | PARMRK))
 634                 u->read_status_mask |= AUART_STAT_BERR;
 635
 636         /*
 637          * Characters to ignore
 638          */
 639         u->ignore_status_mask = 0;
 640         if (termios->c_iflag & IGNPAR)
 641                 u->ignore_status_mask |= AUART_STAT_PERR;
 642         if (termios->c_iflag & IGNBRK) {
 643                 u->ignore_status_mask |= AUART_STAT_BERR;
 644                 /*
 645                  * If we're ignoring parity and break indicators,
 646                  * ignore overruns too (for real raw support).
 647                  */
 648                 if (termios->c_iflag & IGNPAR)
 649                         u->ignore_status_mask |= AUART_STAT_OERR;
 650         }
 651
 652         /*
 653          * ignore all characters if CREAD is not set
 654          */
 655         if (cflag & CREAD)
 656                 ctrl2 |= AUART_CTRL2_RXE;
 657         else
 658                 ctrl2 &= ~AUART_CTRL2_RXE;
 659
 660         /* figure out the stop bits requested */
 661         if (cflag & CSTOPB)
 662                 ctrl |= AUART_LINECTRL_STP2;
 663
 664         /* figure out the hardware flow control settings */
 665         if (cflag & CRTSCTS) {
 666                 /*
 667                  * The DMA has a bug(see errata:2836) in mx23.
 668                  * So we can not implement the DMA for auart in mx23,
 669                  * we can only implement the DMA support for auart
 670                  * in mx28.
 671                  */
 672                 if (is_imx28_auart(s) && (s->flags & MXS_AUART_DMA_CONFIG)) {
 673                         if (!mxs_auart_dma_init(s))
 674                                 /* enable DMA tranfer */
 675                                 ctrl2 |= AUART_CTRL2_TXDMAE | AUART_CTRL2_RXDMAE
 676                                        | AUART_CTRL2_DMAONERR;
 677                 }
 678                 ctrl2 |= AUART_CTRL2_CTSEN | AUART_CTRL2_RTSEN;
 679         } else {
 680                 ctrl2 &= ~(AUART_CTRL2_CTSEN | AUART_CTRL2_RTSEN);
 681         }
 682
 683         /* set baud rate */
 684         baud = uart_get_baud_rate(u, termios, old, 0, u->uartclk);
 685         div = u->uartclk * 32 / baud;
 686         ctrl |= AUART_LINECTRL_BAUD_DIVFRAC(div & 0x3F);
 687         ctrl |= AUART_LINECTRL_BAUD_DIVINT(div >> 6);
 688
 689         writel(ctrl, u->membase + AUART_LINECTRL);
 690         writel(ctrl2, u->membase + AUART_CTRL2);
 691
 692         uart_update_timeout(u, termios->c_cflag, baud);
 693
 694         /* prepare for the DMA RX. */
 695         if (auart_dma_enabled(s) &&
 696                 !test_and_set_bit(MXS_AUART_DMA_RX_READY, &s->flags)) {
 697                 if (!mxs_auart_dma_prep_rx(s)) {
 698                         /* Disable the normal RX interrupt. */
 699                         writel(AUART_INTR_RXIEN | AUART_INTR_RTIEN,
 700                                         u->membase + AUART_INTR_CLR);
 701                 } else {
 702                         mxs_auart_dma_exit(s);
 703                         dev_err(s->dev, "We can not start up the DMA.\n");
 704                 }
 705         }
 706 }
 707
 708 static irqreturn_t mxs_auart_irq_handle(int irq, void *context)
 709 {
 710         u32 istatus, istat;
 711         struct mxs_auart_port *s = context;
 712         u32 stat = readl(s->port.membase + AUART_STAT);
 713
 714         istatus = istat = readl(s->port.membase + AUART_INTR);
 715
 716         if (istat & AUART_INTR_CTSMIS) {
 717                 uart_handle_cts_change(&s->port, stat & AUART_STAT_CTS);
 718                 writel(AUART_INTR_CTSMIS,
 719                                 s->port.membase + AUART_INTR_CLR);
 720                 istat &= ~AUART_INTR_CTSMIS;
 721         }
 722
 723         if (istat & (AUART_INTR_RTIS | AUART_INTR_RXIS)) {
 724                 if (!auart_dma_enabled(s))
 725                         mxs_auart_rx_chars(s);
 726                 istat &= ~(AUART_INTR_RTIS | AUART_INTR_RXIS);
 727         }
 728
 729         if (istat & AUART_INTR_TXIS) {
 730                 mxs_auart_tx_chars(s);
 731                 istat &= ~AUART_INTR_TXIS;
 732         }
 733
 734         writel(istatus & (AUART_INTR_RTIS
 735                 | AUART_INTR_TXIS
 736                 | AUART_INTR_RXIS
 737                 | AUART_INTR_CTSMIS),
 738                         s->port.membase + AUART_INTR_CLR);
 739
 740         return IRQ_HANDLED;
 741 }
 742
 743 static void mxs_auart_reset(struct uart_port *u)
 744 {
 745         int i;
 746         unsigned int reg;
 747
 748         writel(AUART_CTRL0_SFTRST, u->membase + AUART_CTRL0_CLR);
 749
 750         for (i = 0; i < 10000; i++) {
 751                 reg = readl(u->membase + AUART_CTRL0);
 752                 if (!(reg & AUART_CTRL0_SFTRST))
 753                         break;
 754                 udelay(3);
 755         }
 756         writel(AUART_CTRL0_CLKGATE, u->membase + AUART_CTRL0_CLR);
 757 }
 758
 759 static int mxs_auart_startup(struct uart_port *u)
 760 {
 761         struct mxs_auart_port *s = to_auart_port(u);
 762
 763         clk_prepare_enable(s->clk);
 764
 765         writel(AUART_CTRL0_CLKGATE, u->membase + AUART_CTRL0_CLR);
 766
 767         writel(AUART_CTRL2_UARTEN, u->membase + AUART_CTRL2_SET);
 768
 769         writel(AUART_INTR_RXIEN | AUART_INTR_RTIEN | AUART_INTR_CTSMIEN,
 770                         u->membase + AUART_INTR);
 771
 772         /*
 773          * Enable fifo so all four bytes of a DMA word are written to
 774          * output (otherwise, only the LSB is written, ie. 1 in 4 bytes)
 775          */
 776         writel(AUART_LINECTRL_FEN, u->membase + AUART_LINECTRL_SET);
 777
 778         return 0;
 779 }
 780
 781 static void mxs_auart_shutdown(struct uart_port *u)
 782 {
 783         struct mxs_auart_port *s = to_auart_port(u);
 784
 785         if (auart_dma_enabled(s))
 786                 mxs_auart_dma_exit(s);
 787
 788         writel(AUART_CTRL2_UARTEN, u->membase + AUART_CTRL2_CLR);
 789
 790         writel(AUART_INTR_RXIEN | AUART_INTR_RTIEN | AUART_INTR_CTSMIEN,
 791                         u->membase + AUART_INTR_CLR);
 792
 793         writel(AUART_CTRL0_CLKGATE, u->membase + AUART_CTRL0_SET);
 794
 795         clk_disable_unprepare(s->clk);
 796 }
 797
 798 static unsigned int mxs_auart_tx_empty(struct uart_port *u)
 799 {
 800         if (readl(u->membase + AUART_STAT) & AUART_STAT_TXFE)
 801                 return TIOCSER_TEMT;
 802         else
 803                 return 0;
 804 }
 805
 806 static void mxs_auart_start_tx(struct uart_port *u)
 807 {
 808         struct mxs_auart_port *s = to_auart_port(u);
 809
 810         /* enable transmitter */
 811         writel(AUART_CTRL2_TXE, u->membase + AUART_CTRL2_SET);
 812
 813         mxs_auart_tx_chars(s);
 814 }
 815
 816 static void mxs_auart_stop_tx(struct uart_port *u)
 817 {
 818         writel(AUART_CTRL2_TXE, u->membase + AUART_CTRL2_CLR);
 819 }
 820
 821 static void mxs_auart_stop_rx(struct uart_port *u)
 822 {
 823         writel(AUART_CTRL2_RXE, u->membase + AUART_CTRL2_CLR);
 824 }
 825
 826 static void mxs_auart_break_ctl(struct uart_port *u, int ctl)
 827 {
 828         if (ctl)
 829                 writel(AUART_LINECTRL_BRK,
 830                              u->membase + AUART_LINECTRL_SET);
 831         else
 832                 writel(AUART_LINECTRL_BRK,
 833                              u->membase + AUART_LINECTRL_CLR);
 834 }
 835
 836 static void mxs_auart_enable_ms(struct uart_port *port)
 837 {
 838         /* just empty */
 839 }
 840
 841 static struct uart_ops mxs_auart_ops = {
 842         .tx_empty       = mxs_auart_tx_empty,
 843         .start_tx       = mxs_auart_start_tx,
 844         .stop_tx        = mxs_auart_stop_tx,
 845         .stop_rx        = mxs_auart_stop_rx,
 846         .enable_ms      = mxs_auart_enable_ms,
 847         .break_ctl      = mxs_auart_break_ctl,
 848         .set_mctrl      = mxs_auart_set_mctrl,
 849         .get_mctrl      = mxs_auart_get_mctrl,
 850         .startup        = mxs_auart_startup,
 851         .shutdown       = mxs_auart_shutdown,
 852         .set_termios    = mxs_auart_settermios,
 853         .type           = mxs_auart_type,
 854         .release_port   = mxs_auart_release_port,
 855         .request_port   = mxs_auart_request_port,
 856         .config_port    = mxs_auart_config_port,
 857         .verify_port    = mxs_auart_verify_port,
 858 };
 859
 860 static struct mxs_auart_port *auart_port[MXS_AUART_PORTS];
 861
 862 #ifdef CONFIG_SERIAL_MXS_AUART_CONSOLE
 863 static void mxs_auart_console_putchar(struct uart_port *port, int ch)
 864 {
 865         unsigned int to = 1000;
 866
 867         while (readl(port->membase + AUART_STAT) & AUART_STAT_TXFF) {
 868                 if (!to--)
 869                         break;
 870                 udelay(1);
 871         }
 872
 873         writel(ch, port->membase + AUART_DATA);
 874 }
 875
 876 static void
 877 auart_console_write(struct console *co, const char *str, unsigned int count)
 878 {
 879         struct mxs_auart_port *s;
 880         struct uart_port *port;
 881         unsigned int old_ctrl0, old_ctrl2;
 882         unsigned int to = 1000;
 883
 884         if (co->index > MXS_AUART_PORTS || co->index < 0)
 885                 return;
 886
 887         s = auart_port[co->index];
 888         port = &s->port;
 889
 890         clk_enable(s->clk);
 891
 892         /* First save the CR then disable the interrupts */
 893         old_ctrl2 = readl(port->membase + AUART_CTRL2);
 894         old_ctrl0 = readl(port->membase + AUART_CTRL0);
 895
 896         writel(AUART_CTRL0_CLKGATE,
 897                      port->membase + AUART_CTRL0_CLR);
 898         writel(AUART_CTRL2_UARTEN | AUART_CTRL2_TXE,
 899                      port->membase + AUART_CTRL2_SET);
 900
 901         uart_console_write(port, str, count, mxs_auart_console_putchar);
 902
 903         /*
 904          * Finally, wait for transmitter to become empty
 905          * and restore the TCR
 906          */
 907         while (readl(port->membase + AUART_STAT) & AUART_STAT_BUSY) {
 908                 if (!to--)
 909                         break;
 910                 udelay(1);
 911         }
 912
 913         writel(old_ctrl0, port->membase + AUART_CTRL0);
 914         writel(old_ctrl2, port->membase + AUART_CTRL2);
 915
 916         clk_disable(s->clk);
 917 }
 918
 919 static void __init
 920 auart_console_get_options(struct uart_port *port, int *baud,
 921                           int *parity, int *bits)
 922 {
 923         unsigned int lcr_h, quot;
 924
 925         if (!(readl(port->membase + AUART_CTRL2) & AUART_CTRL2_UARTEN))
 926                 return;
 927
 928         lcr_h = readl(port->membase + AUART_LINECTRL);
 929
 930         *parity = 'n';
 931         if (lcr_h & AUART_LINECTRL_PEN) {
 932                 if (lcr_h & AUART_LINECTRL_EPS)
 933                         *parity = 'e';
 934                 else
 935                         *parity = 'o';
 936         }
 937
 938         if ((lcr_h & AUART_LINECTRL_WLEN_MASK) == AUART_LINECTRL_WLEN(2))
 939                 *bits = 7;
 940         else
 941                 *bits = 8;
 942
 943         quot = ((readl(port->membase + AUART_LINECTRL)
 944                         & AUART_LINECTRL_BAUD_DIVINT_MASK))
 945                             >> (AUART_LINECTRL_BAUD_DIVINT_SHIFT - 6);
 946         quot |= ((readl(port->membase + AUART_LINECTRL)
 947                         & AUART_LINECTRL_BAUD_DIVFRAC_MASK))
 948                                 >> AUART_LINECTRL_BAUD_DIVFRAC_SHIFT;
 949         if (quot == 0)
 950                 quot = 1;
 951
 952         *baud = (port->uartclk << 2) / quot;
 953 }
 954
 955 static int __init
 956 auart_console_setup(struct console *co, char *options)
 957 {
 958         struct mxs_auart_port *s;
 959         int baud = 9600;
 960         int bits = 8;
 961         int parity = 'n';
 962         int flow = 'n';
 963         int ret;
 964
 965         /*
 966          * Check whether an invalid uart number has been specified, and
 967          * if so, search for the first available port that does have
 968          * console support.
 969          */
 970         if (co->index == -1 || co->index >= ARRAY_SIZE(auart_port))
 971                 co->index = 0;
 972         s = auart_port[co->index];
 973         if (!s)
 974                 return -ENODEV;
 975
 976         clk_prepare_enable(s->clk);
 977
 978         if (options)
 979                 uart_parse_options(options, &baud, &parity, &bits, &flow);
 980         else
 981                 auart_console_get_options(&s->port, &baud, &parity, &bits);
 982
 983         ret = uart_set_options(&s->port, co, baud, parity, bits, flow);
 984
 985         clk_disable_unprepare(s->clk);
 986
 987         return ret;
 988 }
 989
 990 static struct console auart_console = {
 991         .name           = "ttyAPP",
 992         .write          = auart_console_write,
 993         .device         = uart_console_device,
 994         .setup          = auart_console_setup,
 995         .flags          = CON_PRINTBUFFER,
 996         .index          = -1,
 997         .data           = &auart_driver,
 998 };
 999 #endif
1000
1001 static struct uart_driver auart_driver = {
1002         .owner          = THIS_MODULE,
1003         .driver_name    = "ttyAPP",
1004         .dev_name       = "ttyAPP",
1005         .major          = 0,
1006         .minor          = 0,
1007         .nr             = MXS_AUART_PORTS,
1008 #ifdef CONFIG_SERIAL_MXS_AUART_CONSOLE
1009         .cons =         &auart_console,
1010 #endif
1011 };
1012
1013 /*
1014  * This function returns 1 if pdev isn't a device instatiated by dt, 0 if it
1015  * could successfully get all information from dt or a negative errno.
1016  */
1017 static int serial_mxs_probe_dt(struct mxs_auart_port *s,
1018                 struct platform_device *pdev)
1019 {
1020         struct device_node *np = pdev->dev.of_node;
1021         u32 dma_channel[2];
1022         int ret;
1023
1024         if (!np)
1025                 /* no device tree device */
1026                 return 1;
1027
1028         ret = of_alias_get_id(np, "serial");
1029         if (ret < 0) {
1030                 dev_err(&pdev->dev, "failed to get alias id: %d\n", ret);
1031                 return ret;
1032         }
1033         s->port.line = ret;
1034
1035         s->dma_irq_rx = platform_get_irq(pdev, 1);
1036         s->dma_irq_tx = platform_get_irq(pdev, 2);
1037
1038         ret = of_property_read_u32_array(np, "fsl,auart-dma-channel",
1039                                         dma_channel, 2);
1040         if (ret == 0) {
1041                 s->dma_channel_rx = dma_channel[0];
1042                 s->dma_channel_tx = dma_channel[1];
1043
1044                 s->flags |= MXS_AUART_DMA_CONFIG;
1045         } else {
1046                 s->dma_channel_rx = -1;
1047                 s->dma_channel_tx = -1;
1048         }
1049         return 0;
1050 }
1051
1052 static int mxs_auart_probe(struct platform_device *pdev)
1053 {
1054         const struct of_device_id *of_id =
1055                         of_match_device(mxs_auart_dt_ids, &pdev->dev);
1056         struct mxs_auart_port *s;
1057         u32 version;
1058         int ret = 0;
1059         struct resource *r;
1060         struct pinctrl *pinctrl;
1061
1062         s = kzalloc(sizeof(struct mxs_auart_port), GFP_KERNEL);
1063         if (!s) {
1064                 ret = -ENOMEM;
1065                 goto out;
1066         }
1067
1068         ret = serial_mxs_probe_dt(s, pdev);
1069         if (ret > 0)
1070                 s->port.line = pdev->id < 0 ? 0 : pdev->id;
1071         else if (ret < 0)
1072                 goto out_free;
1073
1074         pinctrl = devm_pinctrl_get_select_default(&pdev->dev);
1075         if (IS_ERR(pinctrl)) {
1076                 ret = PTR_ERR(pinctrl);
1077                 goto out_free;
1078         }
1079
1080         if (of_id) {
1081                 pdev->id_entry = of_id->data;
1082                 s->devtype = pdev->id_entry->driver_data;
1083         }
1084
1085         s->clk = clk_get(&pdev->dev, NULL);
1086         if (IS_ERR(s->clk)) {
1087                 ret = PTR_ERR(s->clk);
1088                 goto out_free;
1089         }
1090
1091         r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1092         if (!r) {
1093                 ret = -ENXIO;
1094                 goto out_free_clk;
1095         }
1096
1097         s->port.mapbase = r->start;
1098         s->port.membase = ioremap(r->start, resource_size(r));
1099         s->port.ops = &mxs_auart_ops;
1100         s->port.iotype = UPIO_MEM;
1101         s->port.fifosize = 16;
1102         s->port.uartclk = clk_get_rate(s->clk);
1103         s->port.type = PORT_IMX;
1104         s->port.dev = s->dev = get_device(&pdev->dev);
1105
1106         s->ctrl = 0;
1107
1108         s->irq = platform_get_irq(pdev, 0);
1109         s->port.irq = s->irq;
1110         ret = request_irq(s->irq, mxs_auart_irq_handle, 0, dev_name(&pdev->dev), s);
1111         if (ret)
1112                 goto out_free_clk;
1113
1114         platform_set_drvdata(pdev, s);
1115
1116         auart_port[s->port.line] = s;
1117
1118         mxs_auart_reset(&s->port);
1119
1120         ret = uart_add_one_port(&auart_driver, &s->port);
1121         if (ret)
1122                 goto out_free_irq;
1123
1124         version = readl(s->port.membase + AUART_VERSION);
1125         dev_info(&pdev->dev, "Found APPUART %d.%d.%d\n",
1126                (version >> 24) & 0xff,
1127                (version >> 16) & 0xff, version & 0xffff);
1128
1129         return 0;
1130
1131 out_free_irq:
1132         auart_port[pdev->id] = NULL;
1133         free_irq(s->irq, s);
1134 out_free_clk:
1135         put_device(s->dev);
1136         clk_put(s->clk);
1137 out_free:
1138         kfree(s);
1139 out:
1140         return ret;
1141 }
1142
1143 static int mxs_auart_remove(struct platform_device *pdev)
1144 {
1145         struct mxs_auart_port *s = platform_get_drvdata(pdev);
1146
1147         uart_remove_one_port(&auart_driver, &s->port);
1148
1149         auart_port[pdev->id] = NULL;
1150
1151         put_device(s->dev);
1152         clk_put(s->clk);
1153         free_irq(s->irq, s);
1154         kfree(s);
1155
1156         return 0;
1157 }
1158
1159 static struct platform_driver mxs_auart_driver = {
1160         .probe = mxs_auart_probe,
1161         .remove = mxs_auart_remove,
1162         .driver = {
1163                 .name = "mxs-auart",
1164                 .owner = THIS_MODULE,
1165                 .of_match_table = mxs_auart_dt_ids,
1166         },
1167 };
1168
1169 static int __init mxs_auart_init(void)
1170 {
1171         int r;
1172
1173         r = uart_register_driver(&auart_driver);
1174         if (r)
1175                 goto out;
1176
1177         r = platform_driver_register(&mxs_auart_driver);
1178         if (r)
1179                 goto out_err;
1180
1181         return 0;
1182 out_err:
1183         uart_unregister_driver(&auart_driver);
1184 out:
1185         return r;
1186 }
1187
1188 static void __exit mxs_auart_exit(void)
1189 {
1190         platform_driver_unregister(&mxs_auart_driver);
1191         uart_unregister_driver(&auart_driver);
1192 }
1193
1194 module_init(mxs_auart_init);
1195 module_exit(mxs_auart_exit);
1196 MODULE_LICENSE("GPL");
1197 MODULE_DESCRIPTION("Freescale MXS application uart driver");
1198 MODULE_ALIAS("platform:mxs-auart");