drivers/tty/serial/amba-pl011.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  *  Driver for AMBA serial ports
   4  *
   5  *  Based on drivers/char/serial.c, by Linus Torvalds, Theodore Ts'o.
   6  *
   7  *  Copyright 1999 ARM Limited
   8  *  Copyright (C) 2000 Deep Blue Solutions Ltd.
   9  *  Copyright (C) 2010 ST-Ericsson SA
  10  *
  11  * This is a generic driver for ARM AMBA-type serial ports.  They
  12  * have a lot of 16550-like features, but are not register compatible.
  13  * Note that although they do have CTS, DCD and DSR inputs, they do
  14  * not have an RI input, nor do they have DTR or RTS outputs.  If
  15  * required, these have to be supplied via some other means (eg, GPIO)
  16  * and hooked into this driver.
  17  */
  18
  19
  20 #if defined(CONFIG_SERIAL_AMBA_PL011_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
  21 #define SUPPORT_SYSRQ
  22 #endif
  23
  24 #include <linux/module.h>
  25 #include <linux/ioport.h>
  26 #include <linux/init.h>
  27 #include <linux/console.h>
  28 #include <linux/sysrq.h>
  29 #include <linux/device.h>
  30 #include <linux/tty.h>
  31 #include <linux/tty_flip.h>
  32 #include <linux/serial_core.h>
  33 #include <linux/serial.h>
  34 #include <linux/amba/bus.h>
  35 #include <linux/amba/serial.h>
  36 #include <linux/clk.h>
  37 #include <linux/slab.h>
  38 #include <linux/dmaengine.h>
  39 #include <linux/dma-mapping.h>
  40 #include <linux/scatterlist.h>
  41 #include <linux/delay.h>
  42 #include <linux/types.h>
  43 #include <linux/of.h>
  44 #include <linux/of_device.h>
  45 #include <linux/pinctrl/consumer.h>
  46 #include <linux/sizes.h>
  47 #include <linux/io.h>
  48 #include <linux/acpi.h>
  49
  50 #include "amba-pl011.h"
  51
  52 #define UART_NR                 14
  53
  54 #define SERIAL_AMBA_MAJOR       204
  55 #define SERIAL_AMBA_MINOR       64
  56 #define SERIAL_AMBA_NR          UART_NR
  57
  58 #define AMBA_ISR_PASS_LIMIT     256
  59
  60 #define UART_DR_ERROR           (UART011_DR_OE|UART011_DR_BE|UART011_DR_PE|UART011_DR_FE)
  61 #define UART_DUMMY_DR_RX        (1 << 16)
  62
  63 static u16 pl011_std_offsets[REG_ARRAY_SIZE] = {
  64         [REG_DR] = UART01x_DR,
  65         [REG_FR] = UART01x_FR,
  66         [REG_LCRH_RX] = UART011_LCRH,
  67         [REG_LCRH_TX] = UART011_LCRH,
  68         [REG_IBRD] = UART011_IBRD,
  69         [REG_FBRD] = UART011_FBRD,
  70         [REG_CR] = UART011_CR,
  71         [REG_IFLS] = UART011_IFLS,
  72         [REG_IMSC] = UART011_IMSC,
  73         [REG_RIS] = UART011_RIS,
  74         [REG_MIS] = UART011_MIS,
  75         [REG_ICR] = UART011_ICR,
  76         [REG_DMACR] = UART011_DMACR,
  77 };
  78
  79 /* There is by now at least one vendor with differing details, so handle it */
  80 struct vendor_data {
  81         const u16               *reg_offset;
  82         unsigned int            ifls;
  83         unsigned int            fr_busy;
  84         unsigned int            fr_dsr;
  85         unsigned int            fr_cts;
  86         unsigned int            fr_ri;
  87         unsigned int            inv_fr;
  88         bool                    access_32b;
  89         bool                    oversampling;
  90         bool                    dma_threshold;
  91         bool                    cts_event_workaround;
  92         bool                    always_enabled;
  93         bool                    fixed_options;
  94
  95         unsigned int (*get_fifosize)(struct amba_device *dev);
  96 };
  97
  98 static unsigned int get_fifosize_arm(struct amba_device *dev)
  99 {
 100         return amba_rev(dev) < 3 ? 16 : 32;
 101 }
 102
 103 static struct vendor_data vendor_arm = {
 104         .reg_offset             = pl011_std_offsets,
 105         .ifls                   = UART011_IFLS_RX4_8|UART011_IFLS_TX4_8,
 106         .fr_busy                = UART01x_FR_BUSY,
 107         .fr_dsr                 = UART01x_FR_DSR,
 108         .fr_cts                 = UART01x_FR_CTS,
 109         .fr_ri                  = UART011_FR_RI,
 110         .oversampling           = false,
 111         .dma_threshold          = false,
 112         .cts_event_workaround   = false,
 113         .always_enabled         = false,
 114         .fixed_options          = false,
 115         .get_fifosize           = get_fifosize_arm,
 116 };
 117
 118 static const struct vendor_data vendor_sbsa = {
 119         .reg_offset             = pl011_std_offsets,
 120         .fr_busy                = UART01x_FR_BUSY,
 121         .fr_dsr                 = UART01x_FR_DSR,
 122         .fr_cts                 = UART01x_FR_CTS,
 123         .fr_ri                  = UART011_FR_RI,
 124         .access_32b             = true,
 125         .oversampling           = false,
 126         .dma_threshold          = false,
 127         .cts_event_workaround   = false,
 128         .always_enabled         = true,
 129         .fixed_options          = true,
 130 };
 131
 132 #ifdef CONFIG_ACPI_SPCR_TABLE
 133 static const struct vendor_data vendor_qdt_qdf2400_e44 = {
 134         .reg_offset             = pl011_std_offsets,
 135         .fr_busy                = UART011_FR_TXFE,
 136         .fr_dsr                 = UART01x_FR_DSR,
 137         .fr_cts                 = UART01x_FR_CTS,
 138         .fr_ri                  = UART011_FR_RI,
 139         .inv_fr                 = UART011_FR_TXFE,
 140         .access_32b             = true,
 141         .oversampling           = false,
 142         .dma_threshold          = false,
 143         .cts_event_workaround   = false,
 144         .always_enabled         = true,
 145         .fixed_options          = true,
 146 };
 147 #endif
 148
 149 static u16 pl011_st_offsets[REG_ARRAY_SIZE] = {
 150         [REG_DR] = UART01x_DR,
 151         [REG_ST_DMAWM] = ST_UART011_DMAWM,
 152         [REG_ST_TIMEOUT] = ST_UART011_TIMEOUT,
 153         [REG_FR] = UART01x_FR,
 154         [REG_LCRH_RX] = ST_UART011_LCRH_RX,
 155         [REG_LCRH_TX] = ST_UART011_LCRH_TX,
 156         [REG_IBRD] = UART011_IBRD,
 157         [REG_FBRD] = UART011_FBRD,
 158         [REG_CR] = UART011_CR,
 159         [REG_IFLS] = UART011_IFLS,
 160         [REG_IMSC] = UART011_IMSC,
 161         [REG_RIS] = UART011_RIS,
 162         [REG_MIS] = UART011_MIS,
 163         [REG_ICR] = UART011_ICR,
 164         [REG_DMACR] = UART011_DMACR,
 165         [REG_ST_XFCR] = ST_UART011_XFCR,
 166         [REG_ST_XON1] = ST_UART011_XON1,
 167         [REG_ST_XON2] = ST_UART011_XON2,
 168         [REG_ST_XOFF1] = ST_UART011_XOFF1,
 169         [REG_ST_XOFF2] = ST_UART011_XOFF2,
 170         [REG_ST_ITCR] = ST_UART011_ITCR,
 171         [REG_ST_ITIP] = ST_UART011_ITIP,
 172         [REG_ST_ABCR] = ST_UART011_ABCR,
 173         [REG_ST_ABIMSC] = ST_UART011_ABIMSC,
 174 };
 175
 176 static unsigned int get_fifosize_st(struct amba_device *dev)
 177 {
 178         return 64;
 179 }
 180
 181 static struct vendor_data vendor_st = {
 182         .reg_offset             = pl011_st_offsets,
 183         .ifls                   = UART011_IFLS_RX_HALF|UART011_IFLS_TX_HALF,
 184         .fr_busy                = UART01x_FR_BUSY,
 185         .fr_dsr                 = UART01x_FR_DSR,
 186         .fr_cts                 = UART01x_FR_CTS,
 187         .fr_ri                  = UART011_FR_RI,
 188         .oversampling           = true,
 189         .dma_threshold          = true,
 190         .cts_event_workaround   = true,
 191         .always_enabled         = false,
 192         .fixed_options          = false,
 193         .get_fifosize           = get_fifosize_st,
 194 };
 195
 196 static const u16 pl011_zte_offsets[REG_ARRAY_SIZE] = {
 197         [REG_DR] = ZX_UART011_DR,
 198         [REG_FR] = ZX_UART011_FR,
 199         [REG_LCRH_RX] = ZX_UART011_LCRH,
 200         [REG_LCRH_TX] = ZX_UART011_LCRH,
 201         [REG_IBRD] = ZX_UART011_IBRD,
 202         [REG_FBRD] = ZX_UART011_FBRD,
 203         [REG_CR] = ZX_UART011_CR,
 204         [REG_IFLS] = ZX_UART011_IFLS,
 205         [REG_IMSC] = ZX_UART011_IMSC,
 206         [REG_RIS] = ZX_UART011_RIS,
 207         [REG_MIS] = ZX_UART011_MIS,
 208         [REG_ICR] = ZX_UART011_ICR,
 209         [REG_DMACR] = ZX_UART011_DMACR,
 210 };
 211
 212 static unsigned int get_fifosize_zte(struct amba_device *dev)
 213 {
 214         return 16;
 215 }
 216
 217 static struct vendor_data vendor_zte = {
 218         .reg_offset             = pl011_zte_offsets,
 219         .access_32b             = true,
 220         .ifls                   = UART011_IFLS_RX4_8|UART011_IFLS_TX4_8,
 221         .fr_busy                = ZX_UART01x_FR_BUSY,
 222         .fr_dsr                 = ZX_UART01x_FR_DSR,
 223         .fr_cts                 = ZX_UART01x_FR_CTS,
 224         .fr_ri                  = ZX_UART011_FR_RI,
 225         .get_fifosize           = get_fifosize_zte,
 226 };
 227
 228 /* Deals with DMA transactions */
 229
 230 struct pl011_sgbuf {
 231         struct scatterlist sg;
 232         char *buf;
 233 };
 234
 235 struct pl011_dmarx_data {
 236         struct dma_chan         *chan;
 237         struct completion       complete;
 238         bool                    use_buf_b;
 239         struct pl011_sgbuf      sgbuf_a;
 240         struct pl011_sgbuf      sgbuf_b;
 241         dma_cookie_t            cookie;
 242         bool                    running;
 243         struct timer_list       timer;
 244         unsigned int last_residue;
 245         unsigned long last_jiffies;
 246         bool auto_poll_rate;
 247         unsigned int poll_rate;
 248         unsigned int poll_timeout;
 249 };
 250
 251 struct pl011_dmatx_data {
 252         struct dma_chan         *chan;
 253         struct scatterlist      sg;
 254         char                    *buf;
 255         bool                    queued;
 256 };
 257
 258 /*
 259  * We wrap our port structure around the generic uart_port.
 260  */
 261 struct uart_amba_port {
 262         struct uart_port        port;
 263         const u16               *reg_offset;
 264         struct clk              *clk;
 265         const struct vendor_data *vendor;
 266         unsigned int            dmacr;          /* dma control reg */
 267         unsigned int            im;             /* interrupt mask */
 268         unsigned int            old_status;
 269         unsigned int            fifosize;       /* vendor-specific */
 270         unsigned int            old_cr;         /* state during shutdown */
 271         unsigned int            fixed_baud;     /* vendor-set fixed baud rate */
 272         char                    type[12];
 273 #ifdef CONFIG_DMA_ENGINE
 274         /* DMA stuff */
 275         bool                    using_tx_dma;
 276         bool                    using_rx_dma;
 277         struct pl011_dmarx_data dmarx;
 278         struct pl011_dmatx_data dmatx;
 279         bool                    dma_probed;
 280 #endif
 281 };
 282
 283 static unsigned int pl011_reg_to_offset(const struct uart_amba_port *uap,
 284         unsigned int reg)
 285 {
 286         return uap->reg_offset[reg];
 287 }
 288
 289 static unsigned int pl011_read(const struct uart_amba_port *uap,
 290         unsigned int reg)
 291 {
 292         void __iomem *addr = uap->port.membase + pl011_reg_to_offset(uap, reg);
 293
 294         return (uap->port.iotype == UPIO_MEM32) ?
 295                 readl_relaxed(addr) : readw_relaxed(addr);
 296 }
 297
 298 static void pl011_write(unsigned int val, const struct uart_amba_port *uap,
 299         unsigned int reg)
 300 {
 301         void __iomem *addr = uap->port.membase + pl011_reg_to_offset(uap, reg);
 302
 303         if (uap->port.iotype == UPIO_MEM32)
 304                 writel_relaxed(val, addr);
 305         else
 306                 writew_relaxed(val, addr);
 307 }
 308
 309 /*
 310  * Reads up to 256 characters from the FIFO or until it's empty and
 311  * inserts them into the TTY layer. Returns the number of characters
 312  * read from the FIFO.
 313  */
 314 static int pl011_fifo_to_tty(struct uart_amba_port *uap)
 315 {
 316         u16 status;
 317         unsigned int ch, flag, fifotaken;
 318
 319         for (fifotaken = 0; fifotaken != 256; fifotaken++) {
 320                 status = pl011_read(uap, REG_FR);
 321                 if (status & UART01x_FR_RXFE)
 322                         break;
 323
 324                 /* Take chars from the FIFO and update status */
 325                 ch = pl011_read(uap, REG_DR) | UART_DUMMY_DR_RX;
 326                 flag = TTY_NORMAL;
 327                 uap->port.icount.rx++;
 328
 329                 if (unlikely(ch & UART_DR_ERROR)) {
 330                         if (ch & UART011_DR_BE) {
 331                                 ch &= ~(UART011_DR_FE | UART011_DR_PE);
 332                                 uap->port.icount.brk++;
 333                                 if (uart_handle_break(&uap->port))
 334                                         continue;
 335                         } else if (ch & UART011_DR_PE)
 336                                 uap->port.icount.parity++;
 337                         else if (ch & UART011_DR_FE)
 338                                 uap->port.icount.frame++;
 339                         if (ch & UART011_DR_OE)
 340                                 uap->port.icount.overrun++;
 341
 342                         ch &= uap->port.read_status_mask;
 343
 344                         if (ch & UART011_DR_BE)
 345                                 flag = TTY_BREAK;
 346                         else if (ch & UART011_DR_PE)
 347                                 flag = TTY_PARITY;
 348                         else if (ch & UART011_DR_FE)
 349                                 flag = TTY_FRAME;
 350                 }
 351
 352                 if (uart_handle_sysrq_char(&uap->port, ch & 255))
 353                         continue;
 354
 355                 uart_insert_char(&uap->port, ch, UART011_DR_OE, ch, flag);
 356         }
 357
 358         return fifotaken;
 359 }
 360
 361
 362 /*
 363  * All the DMA operation mode stuff goes inside this ifdef.
 364  * This assumes that you have a generic DMA device interface,
 365  * no custom DMA interfaces are supported.
 366  */
 367 #ifdef CONFIG_DMA_ENGINE
 368
 369 #define PL011_DMA_BUFFER_SIZE PAGE_SIZE
 370
 371 static int pl011_sgbuf_init(struct dma_chan *chan, struct pl011_sgbuf *sg,
 372         enum dma_data_direction dir)
 373 {
 374         dma_addr_t dma_addr;
 375
 376         sg->buf = dma_alloc_coherent(chan->device->dev,
 377                 PL011_DMA_BUFFER_SIZE, &dma_addr, GFP_KERNEL);
 378         if (!sg->buf)
 379                 return -ENOMEM;
 380
 381         sg_init_table(&sg->sg, 1);
 382         sg_set_page(&sg->sg, phys_to_page(dma_addr),
 383                 PL011_DMA_BUFFER_SIZE, offset_in_page(dma_addr));
 384         sg_dma_address(&sg->sg) = dma_addr;
 385         sg_dma_len(&sg->sg) = PL011_DMA_BUFFER_SIZE;
 386
 387         return 0;
 388 }
 389
 390 static void pl011_sgbuf_free(struct dma_chan *chan, struct pl011_sgbuf *sg,
 391         enum dma_data_direction dir)
 392 {
 393         if (sg->buf) {
 394                 dma_free_coherent(chan->device->dev,
 395                         PL011_DMA_BUFFER_SIZE, sg->buf,
 396                         sg_dma_address(&sg->sg));
 397         }
 398 }
 399
 400 static void pl011_dma_probe(struct uart_amba_port *uap)
 401 {
 402         /* DMA is the sole user of the platform data right now */
 403         struct amba_pl011_data *plat = dev_get_platdata(uap->port.dev);
 404         struct device *dev = uap->port.dev;
 405         struct dma_slave_config tx_conf = {
 406                 .dst_addr = uap->port.mapbase +
 407                                  pl011_reg_to_offset(uap, REG_DR),
 408                 .dst_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE,
 409                 .direction = DMA_MEM_TO_DEV,
 410                 .dst_maxburst = uap->fifosize >> 1,
 411                 .device_fc = false,
 412         };
 413         struct dma_chan *chan;
 414         dma_cap_mask_t mask;
 415
 416         uap->dma_probed = true;
 417         chan = dma_request_slave_channel_reason(dev, "tx");
 418         if (IS_ERR(chan)) {
 419                 if (PTR_ERR(chan) == -EPROBE_DEFER) {
 420                         uap->dma_probed = false;
 421                         return;
 422                 }
 423
 424                 /* We need platform data */
 425                 if (!plat || !plat->dma_filter) {
 426                         dev_info(uap->port.dev, "no DMA platform data\n");
 427                         return;
 428                 }
 429
 430                 /* Try to acquire a generic DMA engine slave TX channel */
 431                 dma_cap_zero(mask);
 432                 dma_cap_set(DMA_SLAVE, mask);
 433
 434                 chan = dma_request_channel(mask, plat->dma_filter,
 435                                                 plat->dma_tx_param);
 436                 if (!chan) {
 437                         dev_err(uap->port.dev, "no TX DMA channel!\n");
 438                         return;
 439                 }
 440         }
 441
 442         dmaengine_slave_config(chan, &tx_conf);
 443         uap->dmatx.chan = chan;
 444
 445         dev_info(uap->port.dev, "DMA channel TX %s\n",
 446                  dma_chan_name(uap->dmatx.chan));
 447
 448         /* Optionally make use of an RX channel as well */
 449         chan = dma_request_slave_channel(dev, "rx");
 450
 451         if (!chan && plat && plat->dma_rx_param) {
 452                 chan = dma_request_channel(mask, plat->dma_filter, plat->dma_rx_param);
 453
 454                 if (!chan) {
 455                         dev_err(uap->port.dev, "no RX DMA channel!\n");
 456                         return;
 457                 }
 458         }
 459
 460         if (chan) {
 461                 struct dma_slave_config rx_conf = {
 462                         .src_addr = uap->port.mapbase +
 463                                 pl011_reg_to_offset(uap, REG_DR),
 464                         .src_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE,
 465                         .direction = DMA_DEV_TO_MEM,
 466                         .src_maxburst = uap->fifosize >> 2,
 467                         .device_fc = false,
 468                 };
 469                 struct dma_slave_caps caps;
 470
 471                 /*
 472                  * Some DMA controllers provide information on their capabilities.
 473                  * If the controller does, check for suitable residue processing
 474                  * otherwise assime all is well.
 475                  */
 476                 if (0 == dma_get_slave_caps(chan, &caps)) {
 477                         if (caps.residue_granularity ==
 478                                         DMA_RESIDUE_GRANULARITY_DESCRIPTOR) {
 479                                 dma_release_channel(chan);
 480                                 dev_info(uap->port.dev,
 481                                         "RX DMA disabled - no residue processing\n");
 482                                 return;
 483                         }
 484                 }
 485                 dmaengine_slave_config(chan, &rx_conf);
 486                 uap->dmarx.chan = chan;
 487
 488                 uap->dmarx.auto_poll_rate = false;
 489                 if (plat && plat->dma_rx_poll_enable) {
 490                         /* Set poll rate if specified. */
 491                         if (plat->dma_rx_poll_rate) {
 492                                 uap->dmarx.auto_poll_rate = false;
 493                                 uap->dmarx.poll_rate = plat->dma_rx_poll_rate;
 494                         } else {
 495                                 /*
 496                                  * 100 ms defaults to poll rate if not
 497                                  * specified. This will be adjusted with
 498                                  * the baud rate at set_termios.
 499                                  */
 500                                 uap->dmarx.auto_poll_rate = true;
 501                                 uap->dmarx.poll_rate =  100;
 502                         }
 503                         /* 3 secs defaults poll_timeout if not specified. */
 504                         if (plat->dma_rx_poll_timeout)
 505                                 uap->dmarx.poll_timeout =
 506                                         plat->dma_rx_poll_timeout;
 507                         else
 508                                 uap->dmarx.poll_timeout = 3000;
 509                 } else if (!plat && dev->of_node) {
 510                         uap->dmarx.auto_poll_rate = of_property_read_bool(
 511                                                 dev->of_node, "auto-poll");
 512                         if (uap->dmarx.auto_poll_rate) {
 513                                 u32 x;
 514
 515                                 if (0 == of_property_read_u32(dev->of_node,
 516                                                 "poll-rate-ms", &x))
 517                                         uap->dmarx.poll_rate = x;
 518                                 else
 519                                         uap->dmarx.poll_rate = 100;
 520                                 if (0 == of_property_read_u32(dev->of_node,
 521                                                 "poll-timeout-ms", &x))
 522                                         uap->dmarx.poll_timeout = x;
 523                                 else
 524                                         uap->dmarx.poll_timeout = 3000;
 525                         }
 526                 }
 527                 dev_info(uap->port.dev, "DMA channel RX %s\n",
 528                          dma_chan_name(uap->dmarx.chan));
 529         }
 530 }
 531
 532 static void pl011_dma_remove(struct uart_amba_port *uap)
 533 {
 534         if (uap->dmatx.chan)
 535                 dma_release_channel(uap->dmatx.chan);
 536         if (uap->dmarx.chan)
 537                 dma_release_channel(uap->dmarx.chan);
 538 }
 539
 540 /* Forward declare these for the refill routine */
 541 static int pl011_dma_tx_refill(struct uart_amba_port *uap);
 542 static void pl011_start_tx_pio(struct uart_amba_port *uap);
 543
 544 /*
 545  * The current DMA TX buffer has been sent.
 546  * Try to queue up another DMA buffer.
 547  */
 548 static void pl011_dma_tx_callback(void *data)
 549 {
 550         struct uart_amba_port *uap = data;
 551         struct pl011_dmatx_data *dmatx = &uap->dmatx;
 552         unsigned long flags;
 553         u16 dmacr;
 554
 555         spin_lock_irqsave(&uap->port.lock, flags);
 556         if (uap->dmatx.queued)
 557                 dma_unmap_sg(dmatx->chan->device->dev, &dmatx->sg, 1,
 558                              DMA_TO_DEVICE);
 559
 560         dmacr = uap->dmacr;
 561         uap->dmacr = dmacr & ~UART011_TXDMAE;
 562         pl011_write(uap->dmacr, uap, REG_DMACR);
 563
 564         /*
 565          * If TX DMA was disabled, it means that we've stopped the DMA for
 566          * some reason (eg, XOFF received, or we want to send an X-char.)
 567          *
 568          * Note: we need to be careful here of a potential race between DMA
 569          * and the rest of the driver - if the driver disables TX DMA while
 570          * a TX buffer completing, we must update the tx queued status to
 571          * get further refills (hence we check dmacr).
 572          */
 573         if (!(dmacr & UART011_TXDMAE) || uart_tx_stopped(&uap->port) ||
 574             uart_circ_empty(&uap->port.state->xmit)) {
 575                 uap->dmatx.queued = false;
 576                 spin_unlock_irqrestore(&uap->port.lock, flags);
 577                 return;
 578         }
 579
 580         if (pl011_dma_tx_refill(uap) <= 0)
 581                 /*
 582                  * We didn't queue a DMA buffer for some reason, but we
 583                  * have data pending to be sent.  Re-enable the TX IRQ.
 584                  */
 585                 pl011_start_tx_pio(uap);
 586
 587         spin_unlock_irqrestore(&uap->port.lock, flags);
 588 }
 589
 590 /*
 591  * Try to refill the TX DMA buffer.
 592  * Locking: called with port lock held and IRQs disabled.
 593  * Returns:
 594  *   1 if we queued up a TX DMA buffer.
 595  *   0 if we didn't want to handle this by DMA
 596  *  <0 on error
 597  */
 598 static int pl011_dma_tx_refill(struct uart_amba_port *uap)
 599 {
 600         struct pl011_dmatx_data *dmatx = &uap->dmatx;
 601         struct dma_chan *chan = dmatx->chan;
 602         struct dma_device *dma_dev = chan->device;
 603         struct dma_async_tx_descriptor *desc;
 604         struct circ_buf *xmit = &uap->port.state->xmit;
 605         unsigned int count;
 606
 607         /*
 608          * Try to avoid the overhead involved in using DMA if the
 609          * transaction fits in the first half of the FIFO, by using
 610          * the standard interrupt handling.  This ensures that we
 611          * issue a uart_write_wakeup() at the appropriate time.
 612          */
 613         count = uart_circ_chars_pending(xmit);
 614         if (count < (uap->fifosize >> 1)) {
 615                 uap->dmatx.queued = false;
 616                 return 0;
 617         }
 618
 619         /*
 620          * Bodge: don't send the last character by DMA, as this
 621          * will prevent XON from notifying us to restart DMA.
 622          */
 623         count -= 1;
 624
 625         /* Else proceed to copy the TX chars to the DMA buffer and fire DMA */
 626         if (count > PL011_DMA_BUFFER_SIZE)
 627                 count = PL011_DMA_BUFFER_SIZE;
 628
 629         if (xmit->tail < xmit->head)
 630                 memcpy(&dmatx->buf[0], &xmit->buf[xmit->tail], count);
 631         else {
 632                 size_t first = UART_XMIT_SIZE - xmit->tail;
 633                 size_t second;
 634
 635                 if (first > count)
 636                         first = count;
 637                 second = count - first;
 638
 639                 memcpy(&dmatx->buf[0], &xmit->buf[xmit->tail], first);
 640                 if (second)
 641                         memcpy(&dmatx->buf[first], &xmit->buf[0], second);
 642         }
 643
 644         dmatx->sg.length = count;
 645
 646         if (dma_map_sg(dma_dev->dev, &dmatx->sg, 1, DMA_TO_DEVICE) != 1) {
 647                 uap->dmatx.queued = false;
 648                 dev_dbg(uap->port.dev, "unable to map TX DMA\n");
 649                 return -EBUSY;
 650         }
 651
 652         desc = dmaengine_prep_slave_sg(chan, &dmatx->sg, 1, DMA_MEM_TO_DEV,
 653                                              DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
 654         if (!desc) {
 655                 dma_unmap_sg(dma_dev->dev, &dmatx->sg, 1, DMA_TO_DEVICE);
 656                 uap->dmatx.queued = false;
 657                 /*
 658                  * If DMA cannot be used right now, we complete this
 659                  * transaction via IRQ and let the TTY layer retry.
 660                  */
 661                 dev_dbg(uap->port.dev, "TX DMA busy\n");
 662                 return -EBUSY;
 663         }
 664
 665         /* Some data to go along to the callback */
 666         desc->callback = pl011_dma_tx_callback;
 667         desc->callback_param = uap;
 668
 669         /* All errors should happen at prepare time */
 670         dmaengine_submit(desc);
 671
 672         /* Fire the DMA transaction */
 673         dma_dev->device_issue_pending(chan);
 674
 675         uap->dmacr |= UART011_TXDMAE;
 676         pl011_write(uap->dmacr, uap, REG_DMACR);
 677         uap->dmatx.queued = true;
 678
 679         /*
 680          * Now we know that DMA will fire, so advance the ring buffer
 681          * with the stuff we just dispatched.
 682          */
 683         xmit->tail = (xmit->tail + count) & (UART_XMIT_SIZE - 1);
 684         uap->port.icount.tx += count;
 685
 686         if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
 687                 uart_write_wakeup(&uap->port);
 688
 689         return 1;
 690 }
 691
 692 /*
 693  * We received a transmit interrupt without a pending X-char but with
 694  * pending characters.
 695  * Locking: called with port lock held and IRQs disabled.
 696  * Returns:
 697  *   false if we want to use PIO to transmit
 698  *   true if we queued a DMA buffer
 699  */
 700 static bool pl011_dma_tx_irq(struct uart_amba_port *uap)
 701 {
 702         if (!uap->using_tx_dma)
 703                 return false;
 704
 705         /*
 706          * If we already have a TX buffer queued, but received a
 707          * TX interrupt, it will be because we've just sent an X-char.
 708          * Ensure the TX DMA is enabled and the TX IRQ is disabled.
 709          */
 710         if (uap->dmatx.queued) {
 711                 uap->dmacr |= UART011_TXDMAE;
 712                 pl011_write(uap->dmacr, uap, REG_DMACR);
 713                 uap->im &= ~UART011_TXIM;
 714                 pl011_write(uap->im, uap, REG_IMSC);
 715                 return true;
 716         }
 717
 718         /*
 719          * We don't have a TX buffer queued, so try to queue one.
 720          * If we successfully queued a buffer, mask the TX IRQ.
 721          */
 722         if (pl011_dma_tx_refill(uap) > 0) {
 723                 uap->im &= ~UART011_TXIM;
 724                 pl011_write(uap->im, uap, REG_IMSC);
 725                 return true;
 726         }
 727         return false;
 728 }
 729
 730 /*
 731  * Stop the DMA transmit (eg, due to received XOFF).
 732  * Locking: called with port lock held and IRQs disabled.
 733  */
 734 static inline void pl011_dma_tx_stop(struct uart_amba_port *uap)
 735 {
 736         if (uap->dmatx.queued) {
 737                 uap->dmacr &= ~UART011_TXDMAE;
 738                 pl011_write(uap->dmacr, uap, REG_DMACR);
 739         }
 740 }
 741
 742 /*
 743  * Try to start a DMA transmit, or in the case of an XON/OFF
 744  * character queued for send, try to get that character out ASAP.
 745  * Locking: called with port lock held and IRQs disabled.
 746  * Returns:
 747  *   false if we want the TX IRQ to be enabled
 748  *   true if we have a buffer queued
 749  */
 750 static inline bool pl011_dma_tx_start(struct uart_amba_port *uap)
 751 {
 752         u16 dmacr;
 753
 754         if (!uap->using_tx_dma)
 755                 return false;
 756
 757         if (!uap->port.x_char) {
 758                 /* no X-char, try to push chars out in DMA mode */
 759                 bool ret = true;
 760
 761                 if (!uap->dmatx.queued) {
 762                         if (pl011_dma_tx_refill(uap) > 0) {
 763                                 uap->im &= ~UART011_TXIM;
 764                                 pl011_write(uap->im, uap, REG_IMSC);
 765                         } else
 766                                 ret = false;
 767                 } else if (!(uap->dmacr & UART011_TXDMAE)) {
 768                         uap->dmacr |= UART011_TXDMAE;
 769                         pl011_write(uap->dmacr, uap, REG_DMACR);
 770                 }
 771                 return ret;
 772         }
 773
 774         /*
 775          * We have an X-char to send.  Disable DMA to prevent it loading
 776          * the TX fifo, and then see if we can stuff it into the FIFO.
 777          */
 778         dmacr = uap->dmacr;
 779         uap->dmacr &= ~UART011_TXDMAE;
 780         pl011_write(uap->dmacr, uap, REG_DMACR);
 781
 782         if (pl011_read(uap, REG_FR) & UART01x_FR_TXFF) {
 783                 /*
 784                  * No space in the FIFO, so enable the transmit interrupt
 785                  * so we know when there is space.  Note that once we've
 786                  * loaded the character, we should just re-enable DMA.
 787                  */
 788                 return false;
 789         }
 790
 791         pl011_write(uap->port.x_char, uap, REG_DR);
 792         uap->port.icount.tx++;
 793         uap->port.x_char = 0;
 794
 795         /* Success - restore the DMA state */
 796         uap->dmacr = dmacr;
 797         pl011_write(dmacr, uap, REG_DMACR);
 798
 799         return true;
 800 }
 801
 802 /*
 803  * Flush the transmit buffer.
 804  * Locking: called with port lock held and IRQs disabled.
 805  */
 806 static void pl011_dma_flush_buffer(struct uart_port *port)
 807 __releases(&uap->port.lock)
 808 __acquires(&uap->port.lock)
 809 {
 810         struct uart_amba_port *uap =
 811             container_of(port, struct uart_amba_port, port);
 812
 813         if (!uap->using_tx_dma)
 814                 return;
 815
 816         /* Avoid deadlock with the DMA engine callback */
 817         spin_unlock(&uap->port.lock);
 818         dmaengine_terminate_all(uap->dmatx.chan);
 819         spin_lock(&uap->port.lock);
 820         if (uap->dmatx.queued) {
 821                 dma_unmap_sg(uap->dmatx.chan->device->dev, &uap->dmatx.sg, 1,
 822                              DMA_TO_DEVICE);
 823                 uap->dmatx.queued = false;
 824                 uap->dmacr &= ~UART011_TXDMAE;
 825                 pl011_write(uap->dmacr, uap, REG_DMACR);
 826         }
 827 }
 828
 829 static void pl011_dma_rx_callback(void *data);
 830
 831 static int pl011_dma_rx_trigger_dma(struct uart_amba_port *uap)
 832 {
 833         struct dma_chan *rxchan = uap->dmarx.chan;
 834         struct pl011_dmarx_data *dmarx = &uap->dmarx;
 835         struct dma_async_tx_descriptor *desc;
 836         struct pl011_sgbuf *sgbuf;
 837
 838         if (!rxchan)
 839                 return -EIO;
 840
 841         /* Start the RX DMA job */
 842         sgbuf = uap->dmarx.use_buf_b ?
 843                 &uap->dmarx.sgbuf_b : &uap->dmarx.sgbuf_a;
 844         desc = dmaengine_prep_slave_sg(rxchan, &sgbuf->sg, 1,
 845                                         DMA_DEV_TO_MEM,
 846                                         DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
 847         /*
 848          * If the DMA engine is busy and cannot prepare a
 849          * channel, no big deal, the driver will fall back
 850          * to interrupt mode as a result of this error code.
 851          */
 852         if (!desc) {
 853                 uap->dmarx.running = false;
 854                 dmaengine_terminate_all(rxchan);
 855                 return -EBUSY;
 856         }
 857
 858         /* Some data to go along to the callback */
 859         desc->callback = pl011_dma_rx_callback;
 860         desc->callback_param = uap;
 861         dmarx->cookie = dmaengine_submit(desc);
 862         dma_async_issue_pending(rxchan);
 863
 864         uap->dmacr |= UART011_RXDMAE;
 865         pl011_write(uap->dmacr, uap, REG_DMACR);
 866         uap->dmarx.running = true;
 867
 868         uap->im &= ~UART011_RXIM;
 869         pl011_write(uap->im, uap, REG_IMSC);
 870
 871         return 0;
 872 }
 873
 874 /*
 875  * This is called when either the DMA job is complete, or
 876  * the FIFO timeout interrupt occurred. This must be called
 877  * with the port spinlock uap->port.lock held.
 878  */
 879 static void pl011_dma_rx_chars(struct uart_amba_port *uap,
 880                                u32 pending, bool use_buf_b,
 881                                bool readfifo)
 882 {
 883         struct tty_port *port = &uap->port.state->port;
 884         struct pl011_sgbuf *sgbuf = use_buf_b ?
 885                 &uap->dmarx.sgbuf_b : &uap->dmarx.sgbuf_a;
 886         int dma_count = 0;
 887         u32 fifotaken = 0; /* only used for vdbg() */
 888
 889         struct pl011_dmarx_data *dmarx = &uap->dmarx;
 890         int dmataken = 0;
 891
 892         if (uap->dmarx.poll_rate) {
 893                 /* The data can be taken by polling */
 894                 dmataken = sgbuf->sg.length - dmarx->last_residue;
 895                 /* Recalculate the pending size */
 896                 if (pending >= dmataken)
 897                         pending -= dmataken;
 898         }
 899
 900         /* Pick the remain data from the DMA */
 901         if (pending) {
 902
 903                 /*
 904                  * First take all chars in the DMA pipe, then look in the FIFO.
 905                  * Note that tty_insert_flip_buf() tries to take as many chars
 906                  * as it can.
 907                  */
 908                 dma_count = tty_insert_flip_string(port, sgbuf->buf + dmataken,
 909                                 pending);
 910
 911                 uap->port.icount.rx += dma_count;
 912                 if (dma_count < pending)
 913                         dev_warn(uap->port.dev,
 914                                  "couldn't insert all characters (TTY is full?)\n");
 915         }
 916
 917         /* Reset the last_residue for Rx DMA poll */
 918         if (uap->dmarx.poll_rate)
 919                 dmarx->last_residue = sgbuf->sg.length;
 920
 921         /*
 922          * Only continue with trying to read the FIFO if all DMA chars have
 923          * been taken first.
 924          */
 925         if (dma_count == pending && readfifo) {
 926                 /* Clear any error flags */
 927                 pl011_write(UART011_OEIS | UART011_BEIS | UART011_PEIS |
 928                             UART011_FEIS, uap, REG_ICR);
 929
 930                 /*
 931                  * If we read all the DMA'd characters, and we had an
 932                  * incomplete buffer, that could be due to an rx error, or
 933                  * maybe we just timed out. Read any pending chars and check
 934                  * the error status.
 935                  *
 936                  * Error conditions will only occur in the FIFO, these will
 937                  * trigger an immediate interrupt and stop the DMA job, so we
 938                  * will always find the error in the FIFO, never in the DMA
 939                  * buffer.
 940                  */
 941                 fifotaken = pl011_fifo_to_tty(uap);
 942         }
 943
 944         spin_unlock(&uap->port.lock);
 945         dev_vdbg(uap->port.dev,
 946                  "Took %d chars from DMA buffer and %d chars from the FIFO\n",
 947                  dma_count, fifotaken);
 948         tty_flip_buffer_push(port);
 949         spin_lock(&uap->port.lock);
 950 }
 951
 952 static void pl011_dma_rx_irq(struct uart_amba_port *uap)
 953 {
 954         struct pl011_dmarx_data *dmarx = &uap->dmarx;
 955         struct dma_chan *rxchan = dmarx->chan;
 956         struct pl011_sgbuf *sgbuf = dmarx->use_buf_b ?
 957                 &dmarx->sgbuf_b : &dmarx->sgbuf_a;
 958         size_t pending;
 959         struct dma_tx_state state;
 960         enum dma_status dmastat;
 961
 962         /*
 963          * Pause the transfer so we can trust the current counter,
 964          * do this before we pause the PL011 block, else we may
 965          * overflow the FIFO.
 966          */
 967         if (dmaengine_pause(rxchan))
 968                 dev_err(uap->port.dev, "unable to pause DMA transfer\n");
 969         dmastat = rxchan->device->device_tx_status(rxchan,
 970                                                    dmarx->cookie, &state);
 971         if (dmastat != DMA_PAUSED)
 972                 dev_err(uap->port.dev, "unable to pause DMA transfer\n");
 973
 974         /* Disable RX DMA - incoming data will wait in the FIFO */
 975         uap->dmacr &= ~UART011_RXDMAE;
 976         pl011_write(uap->dmacr, uap, REG_DMACR);
 977         uap->dmarx.running = false;
 978
 979         pending = sgbuf->sg.length - state.residue;
 980         BUG_ON(pending > PL011_DMA_BUFFER_SIZE);
 981         /* Then we terminate the transfer - we now know our residue */
 982         dmaengine_terminate_all(rxchan);
 983
 984         /*
 985          * This will take the chars we have so far and insert
 986          * into the framework.
 987          */
 988         pl011_dma_rx_chars(uap, pending, dmarx->use_buf_b, true);
 989
 990         /* Switch buffer & re-trigger DMA job */
 991         dmarx->use_buf_b = !dmarx->use_buf_b;
 992         if (pl011_dma_rx_trigger_dma(uap)) {
 993                 dev_dbg(uap->port.dev, "could not retrigger RX DMA job "
 994                         "fall back to interrupt mode\n");
 995                 uap->im |= UART011_RXIM;
 996                 pl011_write(uap->im, uap, REG_IMSC);
 997         }
 998 }
 999
1000 static void pl011_dma_rx_callback(void *data)
1001 {
1002         struct uart_amba_port *uap = data;
1003         struct pl011_dmarx_data *dmarx = &uap->dmarx;
1004         struct dma_chan *rxchan = dmarx->chan;
1005         bool lastbuf = dmarx->use_buf_b;
1006         struct pl011_sgbuf *sgbuf = dmarx->use_buf_b ?
1007                 &dmarx->sgbuf_b : &dmarx->sgbuf_a;
1008         size_t pending;
1009         struct dma_tx_state state;
1010         int ret;
1011
1012         /*
1013          * This completion interrupt occurs typically when the
1014          * RX buffer is totally stuffed but no timeout has yet
1015          * occurred. When that happens, we just want the RX
1016          * routine to flush out the secondary DMA buffer while
1017          * we immediately trigger the next DMA job.
1018          */
1019         spin_lock_irq(&uap->port.lock);
1020         /*
1021          * Rx data can be taken by the UART interrupts during
1022          * the DMA irq handler. So we check the residue here.
1023          */
1024         rxchan->device->device_tx_status(rxchan, dmarx->cookie, &state);
1025         pending = sgbuf->sg.length - state.residue;
1026         BUG_ON(pending > PL011_DMA_BUFFER_SIZE);
1027         /* Then we terminate the transfer - we now know our residue */
1028         dmaengine_terminate_all(rxchan);
1029
1030         uap->dmarx.running = false;
1031         dmarx->use_buf_b = !lastbuf;
1032         ret = pl011_dma_rx_trigger_dma(uap);
1033
1034         pl011_dma_rx_chars(uap, pending, lastbuf, false);
1035         spin_unlock_irq(&uap->port.lock);
1036         /*
1037          * Do this check after we picked the DMA chars so we don't
1038          * get some IRQ immediately from RX.
1039          */
1040         if (ret) {
1041                 dev_dbg(uap->port.dev, "could not retrigger RX DMA job "
1042                         "fall back to interrupt mode\n");
1043                 uap->im |= UART011_RXIM;
1044                 pl011_write(uap->im, uap, REG_IMSC);
1045         }
1046 }
1047
1048 /*
1049  * Stop accepting received characters, when we're shutting down or
1050  * suspending this port.
1051  * Locking: called with port lock held and IRQs disabled.
1052  */
1053 static inline void pl011_dma_rx_stop(struct uart_amba_port *uap)
1054 {
1055         /* FIXME.  Just disable the DMA enable */
1056         uap->dmacr &= ~UART011_RXDMAE;
1057         pl011_write(uap->dmacr, uap, REG_DMACR);
1058 }
1059
1060 /*
1061  * Timer handler for Rx DMA polling.
1062  * Every polling, It checks the residue in the dma buffer and transfer
1063  * data to the tty. Also, last_residue is updated for the next polling.
1064  */
1065 static void pl011_dma_rx_poll(struct timer_list *t)
1066 {
1067         struct uart_amba_port *uap = from_timer(uap, t, dmarx.timer);
1068         struct tty_port *port = &uap->port.state->port;
1069         struct pl011_dmarx_data *dmarx = &uap->dmarx;
1070         struct dma_chan *rxchan = uap->dmarx.chan;
1071         unsigned long flags = 0;
1072         unsigned int dmataken = 0;
1073         unsigned int size = 0;
1074         struct pl011_sgbuf *sgbuf;
1075         int dma_count;
1076         struct dma_tx_state state;
1077
1078         sgbuf = dmarx->use_buf_b ? &uap->dmarx.sgbuf_b : &uap->dmarx.sgbuf_a;
1079         rxchan->device->device_tx_status(rxchan, dmarx->cookie, &state);
1080         if (likely(state.residue < dmarx->last_residue)) {
1081                 dmataken = sgbuf->sg.length - dmarx->last_residue;
1082                 size = dmarx->last_residue - state.residue;
1083                 dma_count = tty_insert_flip_string(port, sgbuf->buf + dmataken,
1084                                 size);
1085                 if (dma_count == size)
1086                         dmarx->last_residue =  state.residue;
1087                 dmarx->last_jiffies = jiffies;
1088         }
1089         tty_flip_buffer_push(port);
1090
1091         /*
1092          * If no data is received in poll_timeout, the driver will fall back
1093          * to interrupt mode. We will retrigger DMA at the first interrupt.
1094          */
1095         if (jiffies_to_msecs(jiffies - dmarx->last_jiffies)
1096                         > uap->dmarx.poll_timeout) {
1097
1098                 spin_lock_irqsave(&uap->port.lock, flags);
1099                 pl011_dma_rx_stop(uap);
1100                 uap->im |= UART011_RXIM;
1101                 pl011_write(uap->im, uap, REG_IMSC);
1102                 spin_unlock_irqrestore(&uap->port.lock, flags);
1103
1104                 uap->dmarx.running = false;
1105                 dmaengine_terminate_all(rxchan);
1106                 del_timer(&uap->dmarx.timer);
1107         } else {
1108                 mod_timer(&uap->dmarx.timer,
1109                         jiffies + msecs_to_jiffies(uap->dmarx.poll_rate));
1110         }
1111 }
1112
1113 static void pl011_dma_startup(struct uart_amba_port *uap)
1114 {
1115         int ret;
1116
1117         if (!uap->dma_probed)
1118                 pl011_dma_probe(uap);
1119
1120         if (!uap->dmatx.chan)
1121                 return;
1122
1123         uap->dmatx.buf = kmalloc(PL011_DMA_BUFFER_SIZE, GFP_KERNEL | __GFP_DMA);
1124         if (!uap->dmatx.buf) {
1125                 dev_err(uap->port.dev, "no memory for DMA TX buffer\n");
1126                 uap->port.fifosize = uap->fifosize;
1127                 return;
1128         }
1129
1130         sg_init_one(&uap->dmatx.sg, uap->dmatx.buf, PL011_DMA_BUFFER_SIZE);
1131
1132         /* The DMA buffer is now the FIFO the TTY subsystem can use */
1133         uap->port.fifosize = PL011_DMA_BUFFER_SIZE;
1134         uap->using_tx_dma = true;
1135
1136         if (!uap->dmarx.chan)
1137                 goto skip_rx;
1138
1139         /* Allocate and map DMA RX buffers */
1140         ret = pl011_sgbuf_init(uap->dmarx.chan, &uap->dmarx.sgbuf_a,
1141                                DMA_FROM_DEVICE);
1142         if (ret) {
1143                 dev_err(uap->port.dev, "failed to init DMA %s: %d\n",
1144                         "RX buffer A", ret);
1145                 goto skip_rx;
1146         }
1147
1148         ret = pl011_sgbuf_init(uap->dmarx.chan, &uap->dmarx.sgbuf_b,
1149                                DMA_FROM_DEVICE);
1150         if (ret) {
1151                 dev_err(uap->port.dev, "failed to init DMA %s: %d\n",
1152                         "RX buffer B", ret);
1153                 pl011_sgbuf_free(uap->dmarx.chan, &uap->dmarx.sgbuf_a,
1154                                  DMA_FROM_DEVICE);
1155                 goto skip_rx;
1156         }
1157
1158         uap->using_rx_dma = true;
1159
1160 skip_rx:
1161         /* Turn on DMA error (RX/TX will be enabled on demand) */
1162         uap->dmacr |= UART011_DMAONERR;
1163         pl011_write(uap->dmacr, uap, REG_DMACR);
1164
1165         /*
1166          * ST Micro variants has some specific dma burst threshold
1167          * compensation. Set this to 16 bytes, so burst will only
1168          * be issued above/below 16 bytes.
1169          */
1170         if (uap->vendor->dma_threshold)
1171                 pl011_write(ST_UART011_DMAWM_RX_16 | ST_UART011_DMAWM_TX_16,
1172                             uap, REG_ST_DMAWM);
1173
1174         if (uap->using_rx_dma) {
1175                 if (pl011_dma_rx_trigger_dma(uap))
1176                         dev_dbg(uap->port.dev, "could not trigger initial "
1177                                 "RX DMA job, fall back to interrupt mode\n");
1178                 if (uap->dmarx.poll_rate) {
1179                         timer_setup(&uap->dmarx.timer, pl011_dma_rx_poll, 0);
1180                         mod_timer(&uap->dmarx.timer,
1181                                 jiffies +
1182                                 msecs_to_jiffies(uap->dmarx.poll_rate));
1183                         uap->dmarx.last_residue = PL011_DMA_BUFFER_SIZE;
1184                         uap->dmarx.last_jiffies = jiffies;
1185                 }
1186         }
1187 }
1188
1189 static void pl011_dma_shutdown(struct uart_amba_port *uap)
1190 {
1191         if (!(uap->using_tx_dma || uap->using_rx_dma))
1192                 return;
1193
1194         /* Disable RX and TX DMA */
1195         while (pl011_read(uap, REG_FR) & uap->vendor->fr_busy)
1196                 cpu_relax();
1197
1198         spin_lock_irq(&uap->port.lock);
1199         uap->dmacr &= ~(UART011_DMAONERR | UART011_RXDMAE | UART011_TXDMAE);
1200         pl011_write(uap->dmacr, uap, REG_DMACR);
1201         spin_unlock_irq(&uap->port.lock);
1202
1203         if (uap->using_tx_dma) {
1204                 /* In theory, this should already be done by pl011_dma_flush_buffer */
1205                 dmaengine_terminate_all(uap->dmatx.chan);
1206                 if (uap->dmatx.queued) {
1207                         dma_unmap_sg(uap->dmatx.chan->device->dev, &uap->dmatx.sg, 1,
1208                                      DMA_TO_DEVICE);
1209                         uap->dmatx.queued = false;
1210                 }
1211
1212                 kfree(uap->dmatx.buf);
1213                 uap->using_tx_dma = false;
1214         }
1215
1216         if (uap->using_rx_dma) {
1217                 dmaengine_terminate_all(uap->dmarx.chan);
1218                 /* Clean up the RX DMA */
1219                 pl011_sgbuf_free(uap->dmarx.chan, &uap->dmarx.sgbuf_a, DMA_FROM_DEVICE);
1220                 pl011_sgbuf_free(uap->dmarx.chan, &uap->dmarx.sgbuf_b, DMA_FROM_DEVICE);
1221                 if (uap->dmarx.poll_rate)
1222                         del_timer_sync(&uap->dmarx.timer);
1223                 uap->using_rx_dma = false;
1224         }
1225 }
1226
1227 static inline bool pl011_dma_rx_available(struct uart_amba_port *uap)
1228 {
1229         return uap->using_rx_dma;
1230 }
1231
1232 static inline bool pl011_dma_rx_running(struct uart_amba_port *uap)
1233 {
1234         return uap->using_rx_dma && uap->dmarx.running;
1235 }
1236
1237 #else
1238 /* Blank functions if the DMA engine is not available */
1239 static inline void pl011_dma_probe(struct uart_amba_port *uap)
1240 {
1241 }
1242
1243 static inline void pl011_dma_remove(struct uart_amba_port *uap)
1244 {
1245 }
1246
1247 static inline void pl011_dma_startup(struct uart_amba_port *uap)
1248 {
1249 }
1250
1251 static inline void pl011_dma_shutdown(struct uart_amba_port *uap)
1252 {
1253 }
1254
1255 static inline bool pl011_dma_tx_irq(struct uart_amba_port *uap)
1256 {
1257         return false;
1258 }
1259
1260 static inline void pl011_dma_tx_stop(struct uart_amba_port *uap)
1261 {
1262 }
1263
1264 static inline bool pl011_dma_tx_start(struct uart_amba_port *uap)
1265 {
1266         return false;
1267 }
1268
1269 static inline void pl011_dma_rx_irq(struct uart_amba_port *uap)
1270 {
1271 }
1272
1273 static inline void pl011_dma_rx_stop(struct uart_amba_port *uap)
1274 {
1275 }
1276
1277 static inline int pl011_dma_rx_trigger_dma(struct uart_amba_port *uap)
1278 {
1279         return -EIO;
1280 }
1281
1282 static inline bool pl011_dma_rx_available(struct uart_amba_port *uap)
1283 {
1284         return false;
1285 }
1286
1287 static inline bool pl011_dma_rx_running(struct uart_amba_port *uap)
1288 {
1289         return false;
1290 }
1291
1292 #define pl011_dma_flush_buffer  NULL
1293 #endif
1294
1295 static void pl011_stop_tx(struct uart_port *port)
1296 {
1297         struct uart_amba_port *uap =
1298             container_of(port, struct uart_amba_port, port);
1299
1300         uap->im &= ~UART011_TXIM;
1301         pl011_write(uap->im, uap, REG_IMSC);
1302         pl011_dma_tx_stop(uap);
1303 }
1304
1305 static bool pl011_tx_chars(struct uart_amba_port *uap, bool from_irq);
1306
1307 /* Start TX with programmed I/O only (no DMA) */
1308 static void pl011_start_tx_pio(struct uart_amba_port *uap)
1309 {
1310         if (pl011_tx_chars(uap, false)) {
1311                 uap->im |= UART011_TXIM;
1312                 pl011_write(uap->im, uap, REG_IMSC);
1313         }
1314 }
1315
1316 static void pl011_start_tx(struct uart_port *port)
1317 {
1318         struct uart_amba_port *uap =
1319             container_of(port, struct uart_amba_port, port);
1320
1321         if (!pl011_dma_tx_start(uap))
1322                 pl011_start_tx_pio(uap);
1323 }
1324
1325 static void pl011_stop_rx(struct uart_port *port)
1326 {
1327         struct uart_amba_port *uap =
1328             container_of(port, struct uart_amba_port, port);
1329
1330         uap->im &= ~(UART011_RXIM|UART011_RTIM|UART011_FEIM|
1331                      UART011_PEIM|UART011_BEIM|UART011_OEIM);
1332         pl011_write(uap->im, uap, REG_IMSC);
1333
1334         pl011_dma_rx_stop(uap);
1335 }
1336
1337 static void pl011_enable_ms(struct uart_port *port)
1338 {
1339         struct uart_amba_port *uap =
1340             container_of(port, struct uart_amba_port, port);
1341
1342         uap->im |= UART011_RIMIM|UART011_CTSMIM|UART011_DCDMIM|UART011_DSRMIM;
1343         pl011_write(uap->im, uap, REG_IMSC);
1344 }
1345
1346 static void pl011_rx_chars(struct uart_amba_port *uap)
1347 __releases(&uap->port.lock)
1348 __acquires(&uap->port.lock)
1349 {
1350         pl011_fifo_to_tty(uap);
1351
1352         spin_unlock(&uap->port.lock);
1353         tty_flip_buffer_push(&uap->port.state->port);
1354         /*
1355          * If we were temporarily out of DMA mode for a while,
1356          * attempt to switch back to DMA mode again.
1357          */
1358         if (pl011_dma_rx_available(uap)) {
1359                 if (pl011_dma_rx_trigger_dma(uap)) {
1360                         dev_dbg(uap->port.dev, "could not trigger RX DMA job "
1361                                 "fall back to interrupt mode again\n");
1362                         uap->im |= UART011_RXIM;
1363                         pl011_write(uap->im, uap, REG_IMSC);
1364                 } else {
1365 #ifdef CONFIG_DMA_ENGINE
1366                         /* Start Rx DMA poll */
1367                         if (uap->dmarx.poll_rate) {
1368                                 uap->dmarx.last_jiffies = jiffies;
1369                                 uap->dmarx.last_residue = PL011_DMA_BUFFER_SIZE;
1370                                 mod_timer(&uap->dmarx.timer,
1371                                         jiffies +
1372                                         msecs_to_jiffies(uap->dmarx.poll_rate));
1373                         }
1374 #endif
1375                 }
1376         }
1377         spin_lock(&uap->port.lock);
1378 }
1379
1380 static bool pl011_tx_char(struct uart_amba_port *uap, unsigned char c,
1381                           bool from_irq)
1382 {
1383         if (unlikely(!from_irq) &&
1384             pl011_read(uap, REG_FR) & UART01x_FR_TXFF)
1385                 return false; /* unable to transmit character */
1386
1387         pl011_write(c, uap, REG_DR);
1388         uap->port.icount.tx++;
1389
1390         return true;
1391 }
1392
1393 /* Returns true if tx interrupts have to be (kept) enabled  */
1394 static bool pl011_tx_chars(struct uart_amba_port *uap, bool from_irq)
1395 {
1396         struct circ_buf *xmit = &uap->port.state->xmit;
1397         int count = uap->fifosize >> 1;
1398
1399         if (uap->port.x_char) {
1400                 if (!pl011_tx_char(uap, uap->port.x_char, from_irq))
1401                         return true;
1402                 uap->port.x_char = 0;
1403                 --count;
1404         }
1405         if (uart_circ_empty(xmit) || uart_tx_stopped(&uap->port)) {
1406                 pl011_stop_tx(&uap->port);
1407                 return false;
1408         }
1409
1410         /* If we are using DMA mode, try to send some characters. */
1411         if (pl011_dma_tx_irq(uap))
1412                 return true;
1413
1414         do {
1415                 if (likely(from_irq) && count-- == 0)
1416                         break;
1417
1418                 if (!pl011_tx_char(uap, xmit->buf[xmit->tail], from_irq))
1419                         break;
1420
1421                 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
1422         } while (!uart_circ_empty(xmit));
1423
1424         if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
1425                 uart_write_wakeup(&uap->port);
1426
1427         if (uart_circ_empty(xmit)) {
1428                 pl011_stop_tx(&uap->port);
1429                 return false;
1430         }
1431         return true;
1432 }
1433
1434 static void pl011_modem_status(struct uart_amba_port *uap)
1435 {
1436         unsigned int status, delta;
1437
1438         status = pl011_read(uap, REG_FR) & UART01x_FR_MODEM_ANY;
1439
1440         delta = status ^ uap->old_status;
1441         uap->old_status = status;
1442
1443         if (!delta)
1444                 return;
1445
1446         if (delta & UART01x_FR_DCD)
1447                 uart_handle_dcd_change(&uap->port, status & UART01x_FR_DCD);
1448
1449         if (delta & uap->vendor->fr_dsr)
1450                 uap->port.icount.dsr++;
1451
1452         if (delta & uap->vendor->fr_cts)
1453                 uart_handle_cts_change(&uap->port,
1454                                        status & uap->vendor->fr_cts);
1455
1456         wake_up_interruptible(&uap->port.state->port.delta_msr_wait);
1457 }
1458
1459 static void check_apply_cts_event_workaround(struct uart_amba_port *uap)
1460 {
1461         unsigned int dummy_read;
1462
1463         if (!uap->vendor->cts_event_workaround)
1464                 return;
1465
1466         /* workaround to make sure that all bits are unlocked.. */
1467         pl011_write(0x00, uap, REG_ICR);
1468
1469         /*
1470          * WA: introduce 26ns(1 uart clk) delay before W1C;
1471          * single apb access will incur 2 pclk(133.12Mhz) delay,
1472          * so add 2 dummy reads
1473          */
1474         dummy_read = pl011_read(uap, REG_ICR);
1475         dummy_read = pl011_read(uap, REG_ICR);
1476 }
1477
1478 static irqreturn_t pl011_int(int irq, void *dev_id)
1479 {
1480         struct uart_amba_port *uap = dev_id;
1481         unsigned long flags;
1482         unsigned int status, pass_counter = AMBA_ISR_PASS_LIMIT;
1483         u16 imsc;
1484         int handled = 0;
1485
1486         spin_lock_irqsave(&uap->port.lock, flags);
1487         imsc = pl011_read(uap, REG_IMSC);
1488         status = pl011_read(uap, REG_RIS) & imsc;
1489         if (status) {
1490                 do {
1491                         check_apply_cts_event_workaround(uap);
1492
1493                         pl011_write(status & ~(UART011_TXIS|UART011_RTIS|
1494                                                UART011_RXIS),
1495                                     uap, REG_ICR);
1496
1497                         if (status & (UART011_RTIS|UART011_RXIS)) {
1498                                 if (pl011_dma_rx_running(uap))
1499                                         pl011_dma_rx_irq(uap);
1500                                 else
1501                                         pl011_rx_chars(uap);
1502                         }
1503                         if (status & (UART011_DSRMIS|UART011_DCDMIS|
1504                                       UART011_CTSMIS|UART011_RIMIS))
1505                                 pl011_modem_status(uap);
1506                         if (status & UART011_TXIS)
1507                                 pl011_tx_chars(uap, true);
1508
1509                         if (pass_counter-- == 0)
1510                                 break;
1511
1512                         status = pl011_read(uap, REG_RIS) & imsc;
1513                 } while (status != 0);
1514                 handled = 1;
1515         }
1516
1517         spin_unlock_irqrestore(&uap->port.lock, flags);
1518
1519         return IRQ_RETVAL(handled);
1520 }
1521
1522 static unsigned int pl011_tx_empty(struct uart_port *port)
1523 {
1524         struct uart_amba_port *uap =
1525             container_of(port, struct uart_amba_port, port);
1526
1527         /* Allow feature register bits to be inverted to work around errata */
1528         unsigned int status = pl011_read(uap, REG_FR) ^ uap->vendor->inv_fr;
1529
1530         return status & (uap->vendor->fr_busy | UART01x_FR_TXFF) ?
1531                                                         0 : TIOCSER_TEMT;
1532 }
1533
1534 static unsigned int pl011_get_mctrl(struct uart_port *port)
1535 {
1536         struct uart_amba_port *uap =
1537             container_of(port, struct uart_amba_port, port);
1538         unsigned int result = 0;
1539         unsigned int status = pl011_read(uap, REG_FR);
1540
1541 #define TIOCMBIT(uartbit, tiocmbit)     \
1542         if (status & uartbit)           \
1543                 result |= tiocmbit
1544
1545         TIOCMBIT(UART01x_FR_DCD, TIOCM_CAR);
1546         TIOCMBIT(uap->vendor->fr_dsr, TIOCM_DSR);
1547         TIOCMBIT(uap->vendor->fr_cts, TIOCM_CTS);
1548         TIOCMBIT(uap->vendor->fr_ri, TIOCM_RNG);
1549 #undef TIOCMBIT
1550         return result;
1551 }
1552
1553 static void pl011_set_mctrl(struct uart_port *port, unsigned int mctrl)
1554 {
1555         struct uart_amba_port *uap =
1556             container_of(port, struct uart_amba_port, port);
1557         unsigned int cr;
1558
1559         cr = pl011_read(uap, REG_CR);
1560
1561 #define TIOCMBIT(tiocmbit, uartbit)             \
1562         if (mctrl & tiocmbit)           \
1563                 cr |= uartbit;          \
1564         else                            \
1565                 cr &= ~uartbit
1566
1567         TIOCMBIT(TIOCM_RTS, UART011_CR_RTS);
1568         TIOCMBIT(TIOCM_DTR, UART011_CR_DTR);
1569         TIOCMBIT(TIOCM_OUT1, UART011_CR_OUT1);
1570         TIOCMBIT(TIOCM_OUT2, UART011_CR_OUT2);
1571         TIOCMBIT(TIOCM_LOOP, UART011_CR_LBE);
1572
1573         if (port->status & UPSTAT_AUTORTS) {
1574                 /* We need to disable auto-RTS if we want to turn RTS off */
1575                 TIOCMBIT(TIOCM_RTS, UART011_CR_RTSEN);
1576         }
1577 #undef TIOCMBIT
1578
1579         pl011_write(cr, uap, REG_CR);
1580 }
1581
1582 static void pl011_break_ctl(struct uart_port *port, int break_state)
1583 {
1584         struct uart_amba_port *uap =
1585             container_of(port, struct uart_amba_port, port);
1586         unsigned long flags;
1587         unsigned int lcr_h;
1588
1589         spin_lock_irqsave(&uap->port.lock, flags);
1590         lcr_h = pl011_read(uap, REG_LCRH_TX);
1591         if (break_state == -1)
1592                 lcr_h |= UART01x_LCRH_BRK;
1593         else
1594                 lcr_h &= ~UART01x_LCRH_BRK;
1595         pl011_write(lcr_h, uap, REG_LCRH_TX);
1596         spin_unlock_irqrestore(&uap->port.lock, flags);
1597 }
1598
1599 #ifdef CONFIG_CONSOLE_POLL
1600
1601 static void pl011_quiesce_irqs(struct uart_port *port)
1602 {
1603         struct uart_amba_port *uap =
1604             container_of(port, struct uart_amba_port, port);
1605
1606         pl011_write(pl011_read(uap, REG_MIS), uap, REG_ICR);
1607         /*
1608          * There is no way to clear TXIM as this is "ready to transmit IRQ", so
1609          * we simply mask it. start_tx() will unmask it.
1610          *
1611          * Note we can race with start_tx(), and if the race happens, the
1612          * polling user might get another interrupt just after we clear it.
1613          * But it should be OK and can happen even w/o the race, e.g.
1614          * controller immediately got some new data and raised the IRQ.
1615          *
1616          * And whoever uses polling routines assumes that it manages the device
1617          * (including tx queue), so we're also fine with start_tx()'s caller
1618          * side.
1619          */
1620         pl011_write(pl011_read(uap, REG_IMSC) & ~UART011_TXIM, uap,
1621                     REG_IMSC);
1622 }
1623
1624 static int pl011_get_poll_char(struct uart_port *port)
1625 {
1626         struct uart_amba_port *uap =
1627             container_of(port, struct uart_amba_port, port);
1628         unsigned int status;
1629
1630         /*
1631          * The caller might need IRQs lowered, e.g. if used with KDB NMI
1632          * debugger.
1633          */
1634         pl011_quiesce_irqs(port);
1635
1636         status = pl011_read(uap, REG_FR);
1637         if (status & UART01x_FR_RXFE)
1638                 return NO_POLL_CHAR;
1639
1640         return pl011_read(uap, REG_DR);
1641 }
1642
1643 static void pl011_put_poll_char(struct uart_port *port,
1644                          unsigned char ch)
1645 {
1646         struct uart_amba_port *uap =
1647             container_of(port, struct uart_amba_port, port);
1648
1649         while (pl011_read(uap, REG_FR) & UART01x_FR_TXFF)
1650                 cpu_relax();
1651
1652         pl011_write(ch, uap, REG_DR);
1653 }
1654
1655 #endif /* CONFIG_CONSOLE_POLL */
1656
1657 static int pl011_hwinit(struct uart_port *port)
1658 {
1659         struct uart_amba_port *uap =
1660             container_of(port, struct uart_amba_port, port);
1661         int retval;
1662
1663         /* Optionaly enable pins to be muxed in and configured */
1664         pinctrl_pm_select_default_state(port->dev);
1665
1666         /*
1667          * Try to enable the clock producer.
1668          */
1669         retval = clk_prepare_enable(uap->clk);
1670         if (retval)
1671                 return retval;
1672
1673         uap->port.uartclk = clk_get_rate(uap->clk);
1674
1675         /* Clear pending error and receive interrupts */
1676         pl011_write(UART011_OEIS | UART011_BEIS | UART011_PEIS |
1677                     UART011_FEIS | UART011_RTIS | UART011_RXIS,
1678                     uap, REG_ICR);
1679
1680         /*
1681          * Save interrupts enable mask, and enable RX interrupts in case if
1682          * the interrupt is used for NMI entry.
1683          */
1684         uap->im = pl011_read(uap, REG_IMSC);
1685         pl011_write(UART011_RTIM | UART011_RXIM, uap, REG_IMSC);
1686
1687         if (dev_get_platdata(uap->port.dev)) {
1688                 struct amba_pl011_data *plat;
1689
1690                 plat = dev_get_platdata(uap->port.dev);
1691                 if (plat->init)
1692                         plat->init();
1693         }
1694         return 0;
1695 }
1696
1697 static bool pl011_split_lcrh(const struct uart_amba_port *uap)
1698 {
1699         return pl011_reg_to_offset(uap, REG_LCRH_RX) !=
1700                pl011_reg_to_offset(uap, REG_LCRH_TX);
1701 }
1702
1703 static void pl011_write_lcr_h(struct uart_amba_port *uap, unsigned int lcr_h)
1704 {
1705         pl011_write(lcr_h, uap, REG_LCRH_RX);
1706         if (pl011_split_lcrh(uap)) {
1707                 int i;
1708                 /*
1709                  * Wait 10 PCLKs before writing LCRH_TX register,
1710                  * to get this delay write read only register 10 times
1711                  */
1712                 for (i = 0; i < 10; ++i)
1713                         pl011_write(0xff, uap, REG_MIS);
1714                 pl011_write(lcr_h, uap, REG_LCRH_TX);
1715         }
1716 }
1717
1718 static int pl011_allocate_irq(struct uart_amba_port *uap)
1719 {
1720         pl011_write(uap->im, uap, REG_IMSC);
1721
1722         return request_irq(uap->port.irq, pl011_int, 0, "uart-pl011", uap);
1723 }
1724
1725 /*
1726  * Enable interrupts, only timeouts when using DMA
1727  * if initial RX DMA job failed, start in interrupt mode
1728  * as well.
1729  */
1730 static void pl011_enable_interrupts(struct uart_amba_port *uap)
1731 {
1732         spin_lock_irq(&uap->port.lock);
1733
1734         /* Clear out any spuriously appearing RX interrupts */
1735         pl011_write(UART011_RTIS | UART011_RXIS, uap, REG_ICR);
1736         uap->im = UART011_RTIM;
1737         if (!pl011_dma_rx_running(uap))
1738                 uap->im |= UART011_RXIM;
1739         pl011_write(uap->im, uap, REG_IMSC);
1740         spin_unlock_irq(&uap->port.lock);
1741 }
1742
1743 static int pl011_startup(struct uart_port *port)
1744 {
1745         struct uart_amba_port *uap =
1746             container_of(port, struct uart_amba_port, port);
1747         unsigned int cr;
1748         int retval;
1749
1750         retval = pl011_hwinit(port);
1751         if (retval)
1752                 goto clk_dis;
1753
1754         retval = pl011_allocate_irq(uap);
1755         if (retval)
1756                 goto clk_dis;
1757
1758         pl011_write(uap->vendor->ifls, uap, REG_IFLS);
1759
1760         spin_lock_irq(&uap->port.lock);
1761
1762         /* restore RTS and DTR */
1763         cr = uap->old_cr & (UART011_CR_RTS | UART011_CR_DTR);
1764         cr |= UART01x_CR_UARTEN | UART011_CR_RXE | UART011_CR_TXE;
1765         pl011_write(cr, uap, REG_CR);
1766
1767         spin_unlock_irq(&uap->port.lock);
1768
1769         /*
1770          * initialise the old status of the modem signals
1771          */
1772         uap->old_status = pl011_read(uap, REG_FR) & UART01x_FR_MODEM_ANY;
1773
1774         /* Startup DMA */
1775         pl011_dma_startup(uap);
1776
1777         pl011_enable_interrupts(uap);
1778
1779         return 0;
1780
1781  clk_dis:
1782         clk_disable_unprepare(uap->clk);
1783         return retval;
1784 }
1785
1786 static int sbsa_uart_startup(struct uart_port *port)
1787 {
1788         struct uart_amba_port *uap =
1789                 container_of(port, struct uart_amba_port, port);
1790         int retval;
1791
1792         retval = pl011_hwinit(port);
1793         if (retval)
1794                 return retval;
1795
1796         retval = pl011_allocate_irq(uap);
1797         if (retval)
1798                 return retval;
1799
1800         /* The SBSA UART does not support any modem status lines. */
1801         uap->old_status = 0;
1802
1803         pl011_enable_interrupts(uap);
1804
1805         return 0;
1806 }
1807
1808 static void pl011_shutdown_channel(struct uart_amba_port *uap,
1809                                         unsigned int lcrh)
1810 {
1811       unsigned long val;
1812
1813       val = pl011_read(uap, lcrh);
1814       val &= ~(UART01x_LCRH_BRK | UART01x_LCRH_FEN);
1815       pl011_write(val, uap, lcrh);
1816 }
1817
1818 /*
1819  * disable the port. It should not disable RTS and DTR.
1820  * Also RTS and DTR state should be preserved to restore
1821  * it during startup().
1822  */
1823 static void pl011_disable_uart(struct uart_amba_port *uap)
1824 {
1825         unsigned int cr;
1826
1827         uap->port.status &= ~(UPSTAT_AUTOCTS | UPSTAT_AUTORTS);
1828         spin_lock_irq(&uap->port.lock);
1829         cr = pl011_read(uap, REG_CR);
1830         uap->old_cr = cr;
1831         cr &= UART011_CR_RTS | UART011_CR_DTR;
1832         cr |= UART01x_CR_UARTEN | UART011_CR_TXE;
1833         pl011_write(cr, uap, REG_CR);
1834         spin_unlock_irq(&uap->port.lock);
1835
1836         /*
1837          * disable break condition and fifos
1838          */
1839         pl011_shutdown_channel(uap, REG_LCRH_RX);
1840         if (pl011_split_lcrh(uap))
1841                 pl011_shutdown_channel(uap, REG_LCRH_TX);
1842 }
1843
1844 static void pl011_disable_interrupts(struct uart_amba_port *uap)
1845 {
1846         spin_lock_irq(&uap->port.lock);
1847
1848         /* mask all interrupts and clear all pending ones */
1849         uap->im = 0;
1850         pl011_write(uap->im, uap, REG_IMSC);
1851         pl011_write(0xffff, uap, REG_ICR);
1852
1853         spin_unlock_irq(&uap->port.lock);
1854 }
1855
1856 static void pl011_shutdown(struct uart_port *port)
1857 {
1858         struct uart_amba_port *uap =
1859                 container_of(port, struct uart_amba_port, port);
1860
1861         pl011_disable_interrupts(uap);
1862
1863         pl011_dma_shutdown(uap);
1864
1865         free_irq(uap->port.irq, uap);
1866
1867         pl011_disable_uart(uap);
1868
1869         /*
1870          * Shut down the clock producer
1871          */
1872         clk_disable_unprepare(uap->clk);
1873         /* Optionally let pins go into sleep states */
1874         pinctrl_pm_select_sleep_state(port->dev);
1875
1876         if (dev_get_platdata(uap->port.dev)) {
1877                 struct amba_pl011_data *plat;
1878
1879                 plat = dev_get_platdata(uap->port.dev);
1880                 if (plat->exit)
1881                         plat->exit();
1882         }
1883
1884         if (uap->port.ops->flush_buffer)
1885                 uap->port.ops->flush_buffer(port);
1886 }
1887
1888 static void sbsa_uart_shutdown(struct uart_port *port)
1889 {
1890         struct uart_amba_port *uap =
1891                 container_of(port, struct uart_amba_port, port);
1892
1893         pl011_disable_interrupts(uap);
1894
1895         free_irq(uap->port.irq, uap);
1896
1897         if (uap->port.ops->flush_buffer)
1898                 uap->port.ops->flush_buffer(port);
1899 }
1900
1901 static void
1902 pl011_setup_status_masks(struct uart_port *port, struct ktermios *termios)
1903 {
1904         port->read_status_mask = UART011_DR_OE | 255;
1905         if (termios->c_iflag & INPCK)
1906                 port->read_status_mask |= UART011_DR_FE | UART011_DR_PE;
1907         if (termios->c_iflag & (IGNBRK | BRKINT | PARMRK))
1908                 port->read_status_mask |= UART011_DR_BE;
1909
1910         /*
1911          * Characters to ignore
1912          */
1913         port->ignore_status_mask = 0;
1914         if (termios->c_iflag & IGNPAR)
1915                 port->ignore_status_mask |= UART011_DR_FE | UART011_DR_PE;
1916         if (termios->c_iflag & IGNBRK) {
1917                 port->ignore_status_mask |= UART011_DR_BE;
1918                 /*
1919                  * If we're ignoring parity and break indicators,
1920                  * ignore overruns too (for real raw support).
1921                  */
1922                 if (termios->c_iflag & IGNPAR)
1923                         port->ignore_status_mask |= UART011_DR_OE;
1924         }
1925
1926         /*
1927          * Ignore all characters if CREAD is not set.
1928          */
1929         if ((termios->c_cflag & CREAD) == 0)
1930                 port->ignore_status_mask |= UART_DUMMY_DR_RX;
1931 }
1932
1933 static void
1934 pl011_set_termios(struct uart_port *port, struct ktermios *termios,
1935                      struct ktermios *old)
1936 {
1937         struct uart_amba_port *uap =
1938             container_of(port, struct uart_amba_port, port);
1939         unsigned int lcr_h, old_cr;
1940         unsigned long flags;
1941         unsigned int baud, quot, clkdiv;
1942
1943         if (uap->vendor->oversampling)
1944                 clkdiv = 8;
1945         else
1946                 clkdiv = 16;
1947
1948         /*
1949          * Ask the core to calculate the divisor for us.
1950          */
1951         baud = uart_get_baud_rate(port, termios, old, 0,
1952                                   port->uartclk / clkdiv);
1953 #ifdef CONFIG_DMA_ENGINE
1954         /*
1955          * Adjust RX DMA polling rate with baud rate if not specified.
1956          */
1957         if (uap->dmarx.auto_poll_rate)
1958                 uap->dmarx.poll_rate = DIV_ROUND_UP(10000000, baud);
1959 #endif
1960
1961         if (baud > port->uartclk/16)
1962                 quot = DIV_ROUND_CLOSEST(port->uartclk * 8, baud);
1963         else
1964                 quot = DIV_ROUND_CLOSEST(port->uartclk * 4, baud);
1965
1966         switch (termios->c_cflag & CSIZE) {
1967         case CS5:
1968                 lcr_h = UART01x_LCRH_WLEN_5;
1969                 break;
1970         case CS6:
1971                 lcr_h = UART01x_LCRH_WLEN_6;
1972                 break;
1973         case CS7:
1974                 lcr_h = UART01x_LCRH_WLEN_7;
1975                 break;
1976         default: // CS8
1977                 lcr_h = UART01x_LCRH_WLEN_8;
1978                 break;
1979         }
1980         if (termios->c_cflag & CSTOPB)
1981                 lcr_h |= UART01x_LCRH_STP2;
1982         if (termios->c_cflag & PARENB) {
1983                 lcr_h |= UART01x_LCRH_PEN;
1984                 if (!(termios->c_cflag & PARODD))
1985                         lcr_h |= UART01x_LCRH_EPS;
1986                 if (termios->c_cflag & CMSPAR)
1987                         lcr_h |= UART011_LCRH_SPS;
1988         }
1989         if (uap->fifosize > 1)
1990                 lcr_h |= UART01x_LCRH_FEN;
1991
1992         spin_lock_irqsave(&port->lock, flags);
1993
1994         /*
1995          * Update the per-port timeout.
1996          */
1997         uart_update_timeout(port, termios->c_cflag, baud);
1998
1999         pl011_setup_status_masks(port, termios);
2000
2001         if (UART_ENABLE_MS(port, termios->c_cflag))
2002                 pl011_enable_ms(port);
2003
2004         /* first, disable everything */
2005         old_cr = pl011_read(uap, REG_CR);
2006         pl011_write(0, uap, REG_CR);
2007
2008         if (termios->c_cflag & CRTSCTS) {
2009                 if (old_cr & UART011_CR_RTS)
2010                         old_cr |= UART011_CR_RTSEN;
2011
2012                 old_cr |= UART011_CR_CTSEN;
2013                 port->status |= UPSTAT_AUTOCTS | UPSTAT_AUTORTS;
2014         } else {
2015                 old_cr &= ~(UART011_CR_CTSEN | UART011_CR_RTSEN);
2016                 port->status &= ~(UPSTAT_AUTOCTS | UPSTAT_AUTORTS);
2017         }
2018
2019         if (uap->vendor->oversampling) {
2020                 if (baud > port->uartclk / 16)
2021                         old_cr |= ST_UART011_CR_OVSFACT;
2022                 else
2023                         old_cr &= ~ST_UART011_CR_OVSFACT;
2024         }
2025
2026         /*
2027          * Workaround for the ST Micro oversampling variants to
2028          * increase the bitrate slightly, by lowering the divisor,
2029          * to avoid delayed sampling of start bit at high speeds,
2030          * else we see data corruption.
2031          */
2032         if (uap->vendor->oversampling) {
2033                 if ((baud >= 3000000) && (baud < 3250000) && (quot > 1))
2034                         quot -= 1;
2035                 else if ((baud > 3250000) && (quot > 2))
2036                         quot -= 2;
2037         }
2038         /* Set baud rate */
2039         pl011_write(quot & 0x3f, uap, REG_FBRD);
2040         pl011_write(quot >> 6, uap, REG_IBRD);
2041
2042         /*
2043          * ----------v----------v----------v----------v-----
2044          * NOTE: REG_LCRH_TX and REG_LCRH_RX MUST BE WRITTEN AFTER
2045          * REG_FBRD & REG_IBRD.
2046          * ----------^----------^----------^----------^-----
2047          */
2048         pl011_write_lcr_h(uap, lcr_h);
2049         pl011_write(old_cr, uap, REG_CR);
2050
2051         spin_unlock_irqrestore(&port->lock, flags);
2052 }
2053
2054 static void
2055 sbsa_uart_set_termios(struct uart_port *port, struct ktermios *termios,
2056                       struct ktermios *old)
2057 {
2058         struct uart_amba_port *uap =
2059             container_of(port, struct uart_amba_port, port);
2060         unsigned long flags;
2061
2062         tty_termios_encode_baud_rate(termios, uap->fixed_baud, uap->fixed_baud);
2063
2064         /* The SBSA UART only supports 8n1 without hardware flow control. */
2065         termios->c_cflag &= ~(CSIZE | CSTOPB | PARENB | PARODD);
2066         termios->c_cflag &= ~(CMSPAR | CRTSCTS);
2067         termios->c_cflag |= CS8 | CLOCAL;
2068
2069         spin_lock_irqsave(&port->lock, flags);
2070         uart_update_timeout(port, CS8, uap->fixed_baud);
2071         pl011_setup_status_masks(port, termios);
2072         spin_unlock_irqrestore(&port->lock, flags);
2073 }
2074
2075 static const char *pl011_type(struct uart_port *port)
2076 {
2077         struct uart_amba_port *uap =
2078             container_of(port, struct uart_amba_port, port);
2079         return uap->port.type == PORT_AMBA ? uap->type : NULL;
2080 }
2081
2082 /*
2083  * Release the memory region(s) being used by 'port'
2084  */
2085 static void pl011_release_port(struct uart_port *port)
2086 {
2087         release_mem_region(port->mapbase, SZ_4K);
2088 }
2089
2090 /*
2091  * Request the memory region(s) being used by 'port'
2092  */
2093 static int pl011_request_port(struct uart_port *port)
2094 {
2095         return request_mem_region(port->mapbase, SZ_4K, "uart-pl011")
2096                         != NULL ? 0 : -EBUSY;
2097 }
2098
2099 /*
2100  * Configure/autoconfigure the port.
2101  */
2102 static void pl011_config_port(struct uart_port *port, int flags)
2103 {
2104         if (flags & UART_CONFIG_TYPE) {
2105                 port->type = PORT_AMBA;
2106                 pl011_request_port(port);
2107         }
2108 }
2109
2110 /*
2111  * verify the new serial_struct (for TIOCSSERIAL).
2112  */
2113 static int pl011_verify_port(struct uart_port *port, struct serial_struct *ser)
2114 {
2115         int ret = 0;
2116         if (ser->type != PORT_UNKNOWN && ser->type != PORT_AMBA)
2117                 ret = -EINVAL;
2118         if (ser->irq < 0 || ser->irq >= nr_irqs)
2119                 ret = -EINVAL;
2120         if (ser->baud_base < 9600)
2121                 ret = -EINVAL;
2122         return ret;
2123 }
2124
2125 static const struct uart_ops amba_pl011_pops = {
2126         .tx_empty       = pl011_tx_empty,
2127         .set_mctrl      = pl011_set_mctrl,
2128         .get_mctrl      = pl011_get_mctrl,
2129         .stop_tx        = pl011_stop_tx,
2130         .start_tx       = pl011_start_tx,
2131         .stop_rx        = pl011_stop_rx,
2132         .enable_ms      = pl011_enable_ms,
2133         .break_ctl      = pl011_break_ctl,
2134         .startup        = pl011_startup,
2135         .shutdown       = pl011_shutdown,
2136         .flush_buffer   = pl011_dma_flush_buffer,
2137         .set_termios    = pl011_set_termios,
2138         .type           = pl011_type,
2139         .release_port   = pl011_release_port,
2140         .request_port   = pl011_request_port,
2141         .config_port    = pl011_config_port,
2142         .verify_port    = pl011_verify_port,
2143 #ifdef CONFIG_CONSOLE_POLL
2144         .poll_init     = pl011_hwinit,
2145         .poll_get_char = pl011_get_poll_char,
2146         .poll_put_char = pl011_put_poll_char,
2147 #endif
2148 };
2149
2150 static void sbsa_uart_set_mctrl(struct uart_port *port, unsigned int mctrl)
2151 {
2152 }
2153
2154 static unsigned int sbsa_uart_get_mctrl(struct uart_port *port)
2155 {
2156         return 0;
2157 }
2158
2159 static const struct uart_ops sbsa_uart_pops = {
2160         .tx_empty       = pl011_tx_empty,
2161         .set_mctrl      = sbsa_uart_set_mctrl,
2162         .get_mctrl      = sbsa_uart_get_mctrl,
2163         .stop_tx        = pl011_stop_tx,
2164         .start_tx       = pl011_start_tx,
2165         .stop_rx        = pl011_stop_rx,
2166         .startup        = sbsa_uart_startup,
2167         .shutdown       = sbsa_uart_shutdown,
2168         .set_termios    = sbsa_uart_set_termios,
2169         .type           = pl011_type,
2170         .release_port   = pl011_release_port,
2171         .request_port   = pl011_request_port,
2172         .config_port    = pl011_config_port,
2173         .verify_port    = pl011_verify_port,
2174 #ifdef CONFIG_CONSOLE_POLL
2175         .poll_init     = pl011_hwinit,
2176         .poll_get_char = pl011_get_poll_char,
2177         .poll_put_char = pl011_put_poll_char,
2178 #endif
2179 };
2180
2181 static struct uart_amba_port *amba_ports[UART_NR];
2182
2183 #ifdef CONFIG_SERIAL_AMBA_PL011_CONSOLE
2184
2185 static void pl011_console_putchar(struct uart_port *port, int ch)
2186 {
2187         struct uart_amba_port *uap =
2188             container_of(port, struct uart_amba_port, port);
2189
2190         while (pl011_read(uap, REG_FR) & UART01x_FR_TXFF)
2191                 cpu_relax();
2192         pl011_write(ch, uap, REG_DR);
2193 }
2194
2195 static void
2196 pl011_console_write(struct console *co, const char *s, unsigned int count)
2197 {
2198         struct uart_amba_port *uap = amba_ports[co->index];
2199         unsigned int old_cr = 0, new_cr;
2200         unsigned long flags;
2201         int locked = 1;
2202
2203         clk_enable(uap->clk);
2204
2205         local_irq_save(flags);
2206         if (uap->port.sysrq)
2207                 locked = 0;
2208         else if (oops_in_progress)
2209                 locked = spin_trylock(&uap->port.lock);
2210         else
2211                 spin_lock(&uap->port.lock);
2212
2213         /*
2214          *      First save the CR then disable the interrupts
2215          */
2216         if (!uap->vendor->always_enabled) {
2217                 old_cr = pl011_read(uap, REG_CR);
2218                 new_cr = old_cr & ~UART011_CR_CTSEN;
2219                 new_cr |= UART01x_CR_UARTEN | UART011_CR_TXE;
2220                 pl011_write(new_cr, uap, REG_CR);
2221         }
2222
2223         uart_console_write(&uap->port, s, count, pl011_console_putchar);
2224
2225         /*
2226          *      Finally, wait for transmitter to become empty and restore the
2227          *      TCR. Allow feature register bits to be inverted to work around
2228          *      errata.
2229          */
2230         while ((pl011_read(uap, REG_FR) ^ uap->vendor->inv_fr)
2231                                                 & uap->vendor->fr_busy)
2232                 cpu_relax();
2233         if (!uap->vendor->always_enabled)
2234                 pl011_write(old_cr, uap, REG_CR);
2235
2236         if (locked)
2237                 spin_unlock(&uap->port.lock);
2238         local_irq_restore(flags);
2239
2240         clk_disable(uap->clk);
2241 }
2242
2243 static void __init
2244 pl011_console_get_options(struct uart_amba_port *uap, int *baud,
2245                              int *parity, int *bits)
2246 {
2247         if (pl011_read(uap, REG_CR) & UART01x_CR_UARTEN) {
2248                 unsigned int lcr_h, ibrd, fbrd;
2249
2250                 lcr_h = pl011_read(uap, REG_LCRH_TX);
2251
2252                 *parity = 'n';
2253                 if (lcr_h & UART01x_LCRH_PEN) {
2254                         if (lcr_h & UART01x_LCRH_EPS)
2255                                 *parity = 'e';
2256                         else
2257                                 *parity = 'o';
2258                 }
2259
2260                 if ((lcr_h & 0x60) == UART01x_LCRH_WLEN_7)
2261                         *bits = 7;
2262                 else
2263                         *bits = 8;
2264
2265                 ibrd = pl011_read(uap, REG_IBRD);
2266                 fbrd = pl011_read(uap, REG_FBRD);
2267
2268                 *baud = uap->port.uartclk * 4 / (64 * ibrd + fbrd);
2269
2270                 if (uap->vendor->oversampling) {
2271                         if (pl011_read(uap, REG_CR)
2272                                   & ST_UART011_CR_OVSFACT)
2273                                 *baud *= 2;
2274                 }
2275         }
2276 }
2277
2278 static int __init pl011_console_setup(struct console *co, char *options)
2279 {
2280         struct uart_amba_port *uap;
2281         int baud = 38400;
2282         int bits = 8;
2283         int parity = 'n';
2284         int flow = 'n';
2285         int ret;
2286
2287         /*
2288          * Check whether an invalid uart number has been specified, and
2289          * if so, search for the first available port that does have
2290          * console support.
2291          */
2292         if (co->index >= UART_NR)
2293                 co->index = 0;
2294         uap = amba_ports[co->index];
2295         if (!uap)
2296                 return -ENODEV;
2297
2298         /* Allow pins to be muxed in and configured */
2299         pinctrl_pm_select_default_state(uap->port.dev);
2300
2301         ret = clk_prepare(uap->clk);
2302         if (ret)
2303                 return ret;
2304
2305         if (dev_get_platdata(uap->port.dev)) {
2306                 struct amba_pl011_data *plat;
2307
2308                 plat = dev_get_platdata(uap->port.dev);
2309                 if (plat->init)
2310                         plat->init();
2311         }
2312
2313         uap->port.uartclk = clk_get_rate(uap->clk);
2314
2315         if (uap->vendor->fixed_options) {
2316                 baud = uap->fixed_baud;
2317         } else {
2318                 if (options)
2319                         uart_parse_options(options,
2320                                            &baud, &parity, &bits, &flow);
2321                 else
2322                         pl011_console_get_options(uap, &baud, &parity, &bits);
2323         }
2324
2325         return uart_set_options(&uap->port, co, baud, parity, bits, flow);
2326 }
2327
2328 /**
2329  *      pl011_console_match - non-standard console matching
2330  *      @co:      registering console
2331  *      @name:    name from console command line
2332  *      @idx:     index from console command line
2333  *      @options: ptr to option string from console command line
2334  *
2335  *      Only attempts to match console command lines of the form:
2336  *          console=pl011,mmio|mmio32,<addr>[,<options>]
2337  *          console=pl011,0x<addr>[,<options>]
2338  *      This form is used to register an initial earlycon boot console and
2339  *      replace it with the amba_console at pl011 driver init.
2340  *
2341  *      Performs console setup for a match (as required by interface)
2342  *      If no <options> are specified, then assume the h/w is already setup.
2343  *
2344  *      Returns 0 if console matches; otherwise non-zero to use default matching
2345  */
2346 static int __init pl011_console_match(struct console *co, char *name, int idx,
2347                                       char *options)
2348 {
2349         unsigned char iotype;
2350         resource_size_t addr;
2351         int i;
2352
2353         /*
2354          * Systems affected by the Qualcomm Technologies QDF2400 E44 erratum
2355          * have a distinct console name, so make sure we check for that.
2356          * The actual implementation of the erratum occurs in the probe
2357          * function.
2358          */
2359         if ((strcmp(name, "qdf2400_e44") != 0) && (strcmp(name, "pl011") != 0))
2360                 return -ENODEV;
2361
2362         if (uart_parse_earlycon(options, &iotype, &addr, &options))
2363                 return -ENODEV;
2364
2365         if (iotype != UPIO_MEM && iotype != UPIO_MEM32)
2366                 return -ENODEV;
2367
2368         /* try to match the port specified on the command line */
2369         for (i = 0; i < ARRAY_SIZE(amba_ports); i++) {
2370                 struct uart_port *port;
2371
2372                 if (!amba_ports[i])
2373                         continue;
2374
2375                 port = &amba_ports[i]->port;
2376
2377                 if (port->mapbase != addr)
2378                         continue;
2379
2380                 co->index = i;
2381                 port->cons = co;
2382                 return pl011_console_setup(co, options);
2383         }
2384
2385         return -ENODEV;
2386 }
2387
2388 static struct uart_driver amba_reg;
2389 static struct console amba_console = {
2390         .name           = "ttyAMA",
2391         .write          = pl011_console_write,
2392         .device         = uart_console_device,
2393         .setup          = pl011_console_setup,
2394         .match          = pl011_console_match,
2395         .flags          = CON_PRINTBUFFER | CON_ANYTIME,
2396         .index          = -1,
2397         .data           = &amba_reg,
2398 };
2399
2400 #define AMBA_CONSOLE    (&amba_console)
2401
2402 static void qdf2400_e44_putc(struct uart_port *port, int c)
2403 {
2404         while (readl(port->membase + UART01x_FR) & UART01x_FR_TXFF)
2405                 cpu_relax();
2406         writel(c, port->membase + UART01x_DR);
2407         while (!(readl(port->membase + UART01x_FR) & UART011_FR_TXFE))
2408                 cpu_relax();
2409 }
2410
2411 static void qdf2400_e44_early_write(struct console *con, const char *s, unsigned n)
2412 {
2413         struct earlycon_device *dev = con->data;
2414
2415         uart_console_write(&dev->port, s, n, qdf2400_e44_putc);
2416 }
2417
2418 static void pl011_putc(struct uart_port *port, int c)
2419 {
2420         while (readl(port->membase + UART01x_FR) & UART01x_FR_TXFF)
2421                 cpu_relax();
2422         if (port->iotype == UPIO_MEM32)
2423                 writel(c, port->membase + UART01x_DR);
2424         else
2425                 writeb(c, port->membase + UART01x_DR);
2426         while (readl(port->membase + UART01x_FR) & UART01x_FR_BUSY)
2427                 cpu_relax();
2428 }
2429
2430 static void pl011_early_write(struct console *con, const char *s, unsigned n)
2431 {
2432         struct earlycon_device *dev = con->data;
2433
2434         uart_console_write(&dev->port, s, n, pl011_putc);
2435 }
2436
2437 /*
2438  * On non-ACPI systems, earlycon is enabled by specifying
2439  * "earlycon=pl011,<address>" on the kernel command line.
2440  *
2441  * On ACPI ARM64 systems, an "early" console is enabled via the SPCR table,
2442  * by specifying only "earlycon" on the command line.  Because it requires
2443  * SPCR, the console starts after ACPI is parsed, which is later than a
2444  * traditional early console.
2445  *
2446  * To get the traditional early console that starts before ACPI is parsed,
2447  * specify the full "earlycon=pl011,<address>" option.
2448  */
2449 static int __init pl011_early_console_setup(struct earlycon_device *device,
2450                                             const char *opt)
2451 {
2452         if (!device->port.membase)
2453                 return -ENODEV;
2454
2455         device->con->write = pl011_early_write;
2456
2457         return 0;
2458 }
2459 OF_EARLYCON_DECLARE(pl011, "arm,pl011", pl011_early_console_setup);
2460 OF_EARLYCON_DECLARE(pl011, "arm,sbsa-uart", pl011_early_console_setup);
2461
2462 /*
2463  * On Qualcomm Datacenter Technologies QDF2400 SOCs affected by
2464  * Erratum 44, traditional earlycon can be enabled by specifying
2465  * "earlycon=qdf2400_e44,<address>".  Any options are ignored.
2466  *
2467  * Alternatively, you can just specify "earlycon", and the early console
2468  * will be enabled with the information from the SPCR table.  In this
2469  * case, the SPCR code will detect the need for the E44 work-around,
2470  * and set the console name to "qdf2400_e44".
2471  */
2472 static int __init
2473 qdf2400_e44_early_console_setup(struct earlycon_device *device,
2474                                 const char *opt)
2475 {
2476         if (!device->port.membase)
2477                 return -ENODEV;
2478
2479         device->con->write = qdf2400_e44_early_write;
2480         return 0;
2481 }
2482 EARLYCON_DECLARE(qdf2400_e44, qdf2400_e44_early_console_setup);
2483
2484 #else
2485 #define AMBA_CONSOLE    NULL
2486 #endif
2487
2488 static struct uart_driver amba_reg = {
2489         .owner                  = THIS_MODULE,
2490         .driver_name            = "ttyAMA",
2491         .dev_name               = "ttyAMA",
2492         .major                  = SERIAL_AMBA_MAJOR,
2493         .minor                  = SERIAL_AMBA_MINOR,
2494         .nr                     = UART_NR,
2495         .cons                   = AMBA_CONSOLE,
2496 };
2497
2498 static int pl011_probe_dt_alias(int index, struct device *dev)
2499 {
2500         struct device_node *np;
2501         static bool seen_dev_with_alias = false;
2502         static bool seen_dev_without_alias = false;
2503         int ret = index;
2504
2505         if (!IS_ENABLED(CONFIG_OF))
2506                 return ret;
2507
2508         np = dev->of_node;
2509         if (!np)
2510                 return ret;
2511
2512         ret = of_alias_get_id(np, "serial");
2513         if (ret < 0) {
2514                 seen_dev_without_alias = true;
2515                 ret = index;
2516         } else {
2517                 seen_dev_with_alias = true;
2518                 if (ret >= ARRAY_SIZE(amba_ports) || amba_ports[ret] != NULL) {
2519                         dev_warn(dev, "requested serial port %d  not available.\n", ret);
2520                         ret = index;
2521                 }
2522         }
2523
2524         if (seen_dev_with_alias && seen_dev_without_alias)
2525                 dev_warn(dev, "aliased and non-aliased serial devices found in device tree. Serial port enumeration may be unpredictable.\n");
2526
2527         return ret;
2528 }
2529
2530 /* unregisters the driver also if no more ports are left */
2531 static void pl011_unregister_port(struct uart_amba_port *uap)
2532 {
2533         int i;
2534         bool busy = false;
2535
2536         for (i = 0; i < ARRAY_SIZE(amba_ports); i++) {
2537                 if (amba_ports[i] == uap)
2538                         amba_ports[i] = NULL;
2539                 else if (amba_ports[i])
2540                         busy = true;
2541         }
2542         pl011_dma_remove(uap);
2543         if (!busy)
2544                 uart_unregister_driver(&amba_reg);
2545 }
2546
2547 static int pl011_find_free_port(void)
2548 {
2549         int i;
2550
2551         for (i = 0; i < ARRAY_SIZE(amba_ports); i++)
2552                 if (amba_ports[i] == NULL)
2553                         return i;
2554
2555         return -EBUSY;
2556 }
2557
2558 static int pl011_setup_port(struct device *dev, struct uart_amba_port *uap,
2559                             struct resource *mmiobase, int index)
2560 {
2561         void __iomem *base;
2562
2563         base = devm_ioremap_resource(dev, mmiobase);
2564         if (IS_ERR(base))
2565                 return PTR_ERR(base);
2566
2567         index = pl011_probe_dt_alias(index, dev);
2568
2569         uap->old_cr = 0;
2570         uap->port.dev = dev;
2571         uap->port.mapbase = mmiobase->start;
2572         uap->port.membase = base;
2573         uap->port.fifosize = uap->fifosize;
2574         uap->port.flags = UPF_BOOT_AUTOCONF;
2575         uap->port.line = index;
2576
2577         amba_ports[index] = uap;
2578
2579         return 0;
2580 }
2581
2582 static int pl011_register_port(struct uart_amba_port *uap)
2583 {
2584         int ret;
2585
2586         /* Ensure interrupts from this UART are masked and cleared */
2587         pl011_write(0, uap, REG_IMSC);
2588         pl011_write(0xffff, uap, REG_ICR);
2589
2590         if (!amba_reg.state) {
2591                 ret = uart_register_driver(&amba_reg);
2592                 if (ret < 0) {
2593                         dev_err(uap->port.dev,
2594                                 "Failed to register AMBA-PL011 driver\n");
2595                         return ret;
2596                 }
2597         }
2598
2599         ret = uart_add_one_port(&amba_reg, &uap->port);
2600         if (ret)
2601                 pl011_unregister_port(uap);
2602
2603         return ret;
2604 }
2605
2606 static int pl011_probe(struct amba_device *dev, const struct amba_id *id)
2607 {
2608         struct uart_amba_port *uap;
2609         struct vendor_data *vendor = id->data;
2610         int portnr, ret;
2611
2612         portnr = pl011_find_free_port();
2613         if (portnr < 0)
2614                 return portnr;
2615
2616         uap = devm_kzalloc(&dev->dev, sizeof(struct uart_amba_port),
2617                            GFP_KERNEL);
2618         if (!uap)
2619                 return -ENOMEM;
2620
2621         uap->clk = devm_clk_get(&dev->dev, NULL);
2622         if (IS_ERR(uap->clk))
2623                 return PTR_ERR(uap->clk);
2624
2625         uap->reg_offset = vendor->reg_offset;
2626         uap->vendor = vendor;
2627         uap->fifosize = vendor->get_fifosize(dev);
2628         uap->port.iotype = vendor->access_32b ? UPIO_MEM32 : UPIO_MEM;
2629         uap->port.irq = dev->irq[0];
2630         uap->port.ops = &amba_pl011_pops;
2631
2632         snprintf(uap->type, sizeof(uap->type), "PL011 rev%u", amba_rev(dev));
2633
2634         ret = pl011_setup_port(&dev->dev, uap, &dev->res, portnr);
2635         if (ret)
2636                 return ret;
2637
2638         amba_set_drvdata(dev, uap);
2639
2640         return pl011_register_port(uap);
2641 }
2642
2643 static int pl011_remove(struct amba_device *dev)
2644 {
2645         struct uart_amba_port *uap = amba_get_drvdata(dev);
2646
2647         uart_remove_one_port(&amba_reg, &uap->port);
2648         pl011_unregister_port(uap);
2649         return 0;
2650 }
2651
2652 #ifdef CONFIG_PM_SLEEP
2653 static int pl011_suspend(struct device *dev)
2654 {
2655         struct uart_amba_port *uap = dev_get_drvdata(dev);
2656
2657         if (!uap)
2658                 return -EINVAL;
2659
2660         return uart_suspend_port(&amba_reg, &uap->port);
2661 }
2662
2663 static int pl011_resume(struct device *dev)
2664 {
2665         struct uart_amba_port *uap = dev_get_drvdata(dev);
2666
2667         if (!uap)
2668                 return -EINVAL;
2669
2670         return uart_resume_port(&amba_reg, &uap->port);
2671 }
2672 #endif
2673
2674 static SIMPLE_DEV_PM_OPS(pl011_dev_pm_ops, pl011_suspend, pl011_resume);
2675
2676 static int sbsa_uart_probe(struct platform_device *pdev)
2677 {
2678         struct uart_amba_port *uap;
2679         struct resource *r;
2680         int portnr, ret;
2681         int baudrate;
2682
2683         /*
2684          * Check the mandatory baud rate parameter in the DT node early
2685          * so that we can easily exit with the error.
2686          */
2687         if (pdev->dev.of_node) {
2688                 struct device_node *np = pdev->dev.of_node;
2689
2690                 ret = of_property_read_u32(np, "current-speed", &baudrate);
2691                 if (ret)
2692                         return ret;
2693         } else {
2694                 baudrate = 115200;
2695         }
2696
2697         portnr = pl011_find_free_port();
2698         if (portnr < 0)
2699                 return portnr;
2700
2701         uap = devm_kzalloc(&pdev->dev, sizeof(struct uart_amba_port),
2702                            GFP_KERNEL);
2703         if (!uap)
2704                 return -ENOMEM;
2705
2706         ret = platform_get_irq(pdev, 0);
2707         if (ret < 0) {
2708                 if (ret != -EPROBE_DEFER)
2709                         dev_err(&pdev->dev, "cannot obtain irq\n");
2710                 return ret;
2711         }
2712         uap->port.irq   = ret;
2713
2714 #ifdef CONFIG_ACPI_SPCR_TABLE
2715         if (qdf2400_e44_present) {
2716                 dev_info(&pdev->dev, "working around QDF2400 SoC erratum 44\n");
2717                 uap->vendor = &vendor_qdt_qdf2400_e44;
2718         } else
2719 #endif
2720                 uap->vendor = &vendor_sbsa;
2721
2722         uap->reg_offset = uap->vendor->reg_offset;
2723         uap->fifosize   = 32;
2724         uap->port.iotype = uap->vendor->access_32b ? UPIO_MEM32 : UPIO_MEM;
2725         uap->port.ops   = &sbsa_uart_pops;
2726         uap->fixed_baud = baudrate;
2727
2728         snprintf(uap->type, sizeof(uap->type), "SBSA");
2729
2730         r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
2731
2732         ret = pl011_setup_port(&pdev->dev, uap, r, portnr);
2733         if (ret)
2734                 return ret;
2735
2736         platform_set_drvdata(pdev, uap);
2737
2738         return pl011_register_port(uap);
2739 }
2740
2741 static int sbsa_uart_remove(struct platform_device *pdev)
2742 {
2743         struct uart_amba_port *uap = platform_get_drvdata(pdev);
2744
2745         uart_remove_one_port(&amba_reg, &uap->port);
2746         pl011_unregister_port(uap);
2747         return 0;
2748 }
2749
2750 static const struct of_device_id sbsa_uart_of_match[] = {
2751         { .compatible = "arm,sbsa-uart", },
2752         {},
2753 };
2754 MODULE_DEVICE_TABLE(of, sbsa_uart_of_match);
2755
2756 static const struct acpi_device_id sbsa_uart_acpi_match[] = {
2757         { "ARMH0011", 0 },
2758         {},
2759 };
2760 MODULE_DEVICE_TABLE(acpi, sbsa_uart_acpi_match);
2761
2762 static struct platform_driver arm_sbsa_uart_platform_driver = {
2763         .probe          = sbsa_uart_probe,
2764         .remove         = sbsa_uart_remove,
2765         .driver = {
2766                 .name   = "sbsa-uart",
2767                 .of_match_table = of_match_ptr(sbsa_uart_of_match),
2768                 .acpi_match_table = ACPI_PTR(sbsa_uart_acpi_match),
2769         },
2770 };
2771
2772 static const struct amba_id pl011_ids[] = {
2773         {
2774                 .id     = 0x00041011,
2775                 .mask   = 0x000fffff,
2776                 .data   = &vendor_arm,
2777         },
2778         {
2779                 .id     = 0x00380802,
2780                 .mask   = 0x00ffffff,
2781                 .data   = &vendor_st,
2782         },
2783         {
2784                 .id     = AMBA_LINUX_ID(0x00, 0x1, 0xffe),
2785                 .mask   = 0x00ffffff,
2786                 .data   = &vendor_zte,
2787         },
2788         { 0, 0 },
2789 };
2790
2791 MODULE_DEVICE_TABLE(amba, pl011_ids);
2792
2793 static struct amba_driver pl011_driver = {
2794         .drv = {
2795                 .name   = "uart-pl011",
2796                 .pm     = &pl011_dev_pm_ops,
2797         },
2798         .id_table       = pl011_ids,
2799         .probe          = pl011_probe,
2800         .remove         = pl011_remove,
2801 };
2802
2803 static int __init pl011_init(void)
2804 {
2805         printk(KERN_INFO "Serial: AMBA PL011 UART driver\n");
2806
2807         if (platform_driver_register(&arm_sbsa_uart_platform_driver))
2808                 pr_warn("could not register SBSA UART platform driver\n");
2809         return amba_driver_register(&pl011_driver);
2810 }
2811
2812 static void __exit pl011_exit(void)
2813 {
2814         platform_driver_unregister(&arm_sbsa_uart_platform_driver);
2815         amba_driver_unregister(&pl011_driver);
2816 }
2817
2818 /*
2819  * While this can be a module, if builtin it's most likely the console
2820  * So let's leave module_exit but move module_init to an earlier place
2821  */
2822 arch_initcall(pl011_init);
2823 module_exit(pl011_exit);
2824
2825 MODULE_AUTHOR("ARM Ltd/Deep Blue Solutions Ltd");
2826 MODULE_DESCRIPTION("ARM AMBA serial port driver");
2827 MODULE_LICENSE("GPL");