drivers: PL011: avoid potential unregister_driver call
[linux-2.6-block.git] / drivers / tty / serial / amba-pl011.c
CommitLineData
1da177e4 1/*
1da177e4
LT
2 * Driver for AMBA serial ports
3 *
4 * Based on drivers/char/serial.c, by Linus Torvalds, Theodore Ts'o.
5 *
6 * Copyright 1999 ARM Limited
7 * Copyright (C) 2000 Deep Blue Solutions Ltd.
68b65f73 8 * Copyright (C) 2010 ST-Ericsson SA
1da177e4
LT
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 *
1da177e4
LT
24 * This is a generic driver for ARM AMBA-type serial ports. They
25 * have a lot of 16550-like features, but are not register compatible.
26 * Note that although they do have CTS, DCD and DSR inputs, they do
27 * not have an RI input, nor do they have DTR or RTS outputs. If
28 * required, these have to be supplied via some other means (eg, GPIO)
29 * and hooked into this driver.
30 */
1da177e4 31
cb06ff10 32
1da177e4
LT
33#if defined(CONFIG_SERIAL_AMBA_PL011_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
34#define SUPPORT_SYSRQ
35#endif
36
37#include <linux/module.h>
38#include <linux/ioport.h>
39#include <linux/init.h>
40#include <linux/console.h>
41#include <linux/sysrq.h>
42#include <linux/device.h>
43#include <linux/tty.h>
44#include <linux/tty_flip.h>
45#include <linux/serial_core.h>
46#include <linux/serial.h>
a62c80e5
RK
47#include <linux/amba/bus.h>
48#include <linux/amba/serial.h>
f8ce2547 49#include <linux/clk.h>
5a0e3ad6 50#include <linux/slab.h>
68b65f73
RK
51#include <linux/dmaengine.h>
52#include <linux/dma-mapping.h>
53#include <linux/scatterlist.h>
c16d51a3 54#include <linux/delay.h>
258aea76 55#include <linux/types.h>
32614aad
ML
56#include <linux/of.h>
57#include <linux/of_device.h>
258e0551 58#include <linux/pinctrl/consumer.h>
cb70706c 59#include <linux/sizes.h>
de609582 60#include <linux/io.h>
1da177e4
LT
61
62#define UART_NR 14
63
64#define SERIAL_AMBA_MAJOR 204
65#define SERIAL_AMBA_MINOR 64
66#define SERIAL_AMBA_NR UART_NR
67
68#define AMBA_ISR_PASS_LIMIT 256
69
b63d4f0f
RK
70#define UART_DR_ERROR (UART011_DR_OE|UART011_DR_BE|UART011_DR_PE|UART011_DR_FE)
71#define UART_DUMMY_DR_RX (1 << 16)
1da177e4 72
5926a295
AR
73/* There is by now at least one vendor with differing details, so handle it */
74struct vendor_data {
75 unsigned int ifls;
ec489aa8
LW
76 unsigned int lcrh_tx;
77 unsigned int lcrh_rx;
ac3e3fb4 78 bool oversampling;
38d62436 79 bool dma_threshold;
4fd0690b 80 bool cts_event_workaround;
78506f22 81
ea33640a 82 unsigned int (*get_fifosize)(struct amba_device *dev);
5926a295
AR
83};
84
ea33640a 85static unsigned int get_fifosize_arm(struct amba_device *dev)
78506f22 86{
ea33640a 87 return amba_rev(dev) < 3 ? 16 : 32;
78506f22
JK
88}
89
5926a295
AR
90static struct vendor_data vendor_arm = {
91 .ifls = UART011_IFLS_RX4_8|UART011_IFLS_TX4_8,
ec489aa8
LW
92 .lcrh_tx = UART011_LCRH,
93 .lcrh_rx = UART011_LCRH,
ac3e3fb4 94 .oversampling = false,
38d62436 95 .dma_threshold = false,
4fd0690b 96 .cts_event_workaround = false,
78506f22 97 .get_fifosize = get_fifosize_arm,
5926a295
AR
98};
99
ea33640a 100static unsigned int get_fifosize_st(struct amba_device *dev)
78506f22
JK
101{
102 return 64;
103}
104
5926a295
AR
105static struct vendor_data vendor_st = {
106 .ifls = UART011_IFLS_RX_HALF|UART011_IFLS_TX_HALF,
ec489aa8
LW
107 .lcrh_tx = ST_UART011_LCRH_TX,
108 .lcrh_rx = ST_UART011_LCRH_RX,
ac3e3fb4 109 .oversampling = true,
38d62436 110 .dma_threshold = true,
4fd0690b 111 .cts_event_workaround = true,
78506f22 112 .get_fifosize = get_fifosize_st,
1da177e4
LT
113};
114
68b65f73 115/* Deals with DMA transactions */
ead76f32
LW
116
117struct pl011_sgbuf {
118 struct scatterlist sg;
119 char *buf;
120};
121
122struct pl011_dmarx_data {
123 struct dma_chan *chan;
124 struct completion complete;
125 bool use_buf_b;
126 struct pl011_sgbuf sgbuf_a;
127 struct pl011_sgbuf sgbuf_b;
128 dma_cookie_t cookie;
129 bool running;
cb06ff10
CM
130 struct timer_list timer;
131 unsigned int last_residue;
132 unsigned long last_jiffies;
133 bool auto_poll_rate;
134 unsigned int poll_rate;
135 unsigned int poll_timeout;
ead76f32
LW
136};
137
68b65f73
RK
138struct pl011_dmatx_data {
139 struct dma_chan *chan;
140 struct scatterlist sg;
141 char *buf;
142 bool queued;
143};
144
c19f12b5
RK
145/*
146 * We wrap our port structure around the generic uart_port.
147 */
148struct uart_amba_port {
149 struct uart_port port;
150 struct clk *clk;
151 const struct vendor_data *vendor;
68b65f73 152 unsigned int dmacr; /* dma control reg */
c19f12b5
RK
153 unsigned int im; /* interrupt mask */
154 unsigned int old_status;
ffca2b11 155 unsigned int fifosize; /* vendor-specific */
c19f12b5
RK
156 unsigned int lcrh_tx; /* vendor-specific */
157 unsigned int lcrh_rx; /* vendor-specific */
d8d8ffa4 158 unsigned int old_cr; /* state during shutdown */
c19f12b5
RK
159 bool autorts;
160 char type[12];
68b65f73
RK
161#ifdef CONFIG_DMA_ENGINE
162 /* DMA stuff */
ead76f32
LW
163 bool using_tx_dma;
164 bool using_rx_dma;
165 struct pl011_dmarx_data dmarx;
68b65f73 166 struct pl011_dmatx_data dmatx;
1c9be310 167 bool dma_probed;
68b65f73
RK
168#endif
169};
170
29772c4e
LW
171/*
172 * Reads up to 256 characters from the FIFO or until it's empty and
173 * inserts them into the TTY layer. Returns the number of characters
174 * read from the FIFO.
175 */
176static int pl011_fifo_to_tty(struct uart_amba_port *uap)
177{
178 u16 status, ch;
179 unsigned int flag, max_count = 256;
180 int fifotaken = 0;
181
182 while (max_count--) {
183 status = readw(uap->port.membase + UART01x_FR);
184 if (status & UART01x_FR_RXFE)
185 break;
186
187 /* Take chars from the FIFO and update status */
188 ch = readw(uap->port.membase + UART01x_DR) |
189 UART_DUMMY_DR_RX;
190 flag = TTY_NORMAL;
191 uap->port.icount.rx++;
192 fifotaken++;
193
194 if (unlikely(ch & UART_DR_ERROR)) {
195 if (ch & UART011_DR_BE) {
196 ch &= ~(UART011_DR_FE | UART011_DR_PE);
197 uap->port.icount.brk++;
198 if (uart_handle_break(&uap->port))
199 continue;
200 } else if (ch & UART011_DR_PE)
201 uap->port.icount.parity++;
202 else if (ch & UART011_DR_FE)
203 uap->port.icount.frame++;
204 if (ch & UART011_DR_OE)
205 uap->port.icount.overrun++;
206
207 ch &= uap->port.read_status_mask;
208
209 if (ch & UART011_DR_BE)
210 flag = TTY_BREAK;
211 else if (ch & UART011_DR_PE)
212 flag = TTY_PARITY;
213 else if (ch & UART011_DR_FE)
214 flag = TTY_FRAME;
215 }
216
217 if (uart_handle_sysrq_char(&uap->port, ch & 255))
218 continue;
219
220 uart_insert_char(&uap->port, ch, UART011_DR_OE, ch, flag);
221 }
222
223 return fifotaken;
224}
225
226
68b65f73
RK
227/*
228 * All the DMA operation mode stuff goes inside this ifdef.
229 * This assumes that you have a generic DMA device interface,
230 * no custom DMA interfaces are supported.
231 */
232#ifdef CONFIG_DMA_ENGINE
233
234#define PL011_DMA_BUFFER_SIZE PAGE_SIZE
235
ead76f32
LW
236static int pl011_sgbuf_init(struct dma_chan *chan, struct pl011_sgbuf *sg,
237 enum dma_data_direction dir)
238{
cb06ff10
CM
239 dma_addr_t dma_addr;
240
241 sg->buf = dma_alloc_coherent(chan->device->dev,
242 PL011_DMA_BUFFER_SIZE, &dma_addr, GFP_KERNEL);
ead76f32
LW
243 if (!sg->buf)
244 return -ENOMEM;
245
cb06ff10
CM
246 sg_init_table(&sg->sg, 1);
247 sg_set_page(&sg->sg, phys_to_page(dma_addr),
248 PL011_DMA_BUFFER_SIZE, offset_in_page(dma_addr));
249 sg_dma_address(&sg->sg) = dma_addr;
c64be923 250 sg_dma_len(&sg->sg) = PL011_DMA_BUFFER_SIZE;
ead76f32 251
ead76f32
LW
252 return 0;
253}
254
255static void pl011_sgbuf_free(struct dma_chan *chan, struct pl011_sgbuf *sg,
256 enum dma_data_direction dir)
257{
258 if (sg->buf) {
cb06ff10
CM
259 dma_free_coherent(chan->device->dev,
260 PL011_DMA_BUFFER_SIZE, sg->buf,
261 sg_dma_address(&sg->sg));
ead76f32
LW
262 }
263}
264
1c9be310 265static void pl011_dma_probe(struct uart_amba_port *uap)
68b65f73
RK
266{
267 /* DMA is the sole user of the platform data right now */
574de559 268 struct amba_pl011_data *plat = dev_get_platdata(uap->port.dev);
1c9be310 269 struct device *dev = uap->port.dev;
68b65f73
RK
270 struct dma_slave_config tx_conf = {
271 .dst_addr = uap->port.mapbase + UART01x_DR,
272 .dst_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE,
a485df4b 273 .direction = DMA_MEM_TO_DEV,
68b65f73 274 .dst_maxburst = uap->fifosize >> 1,
258aea76 275 .device_fc = false,
68b65f73
RK
276 };
277 struct dma_chan *chan;
278 dma_cap_mask_t mask;
279
1c9be310
JRO
280 uap->dma_probed = true;
281 chan = dma_request_slave_channel_reason(dev, "tx");
282 if (IS_ERR(chan)) {
283 if (PTR_ERR(chan) == -EPROBE_DEFER) {
1c9be310
JRO
284 uap->dma_probed = false;
285 return;
286 }
68b65f73 287
787b0c1f
AB
288 /* We need platform data */
289 if (!plat || !plat->dma_filter) {
290 dev_info(uap->port.dev, "no DMA platform data\n");
291 return;
292 }
293
294 /* Try to acquire a generic DMA engine slave TX channel */
295 dma_cap_zero(mask);
296 dma_cap_set(DMA_SLAVE, mask);
297
298 chan = dma_request_channel(mask, plat->dma_filter,
299 plat->dma_tx_param);
300 if (!chan) {
301 dev_err(uap->port.dev, "no TX DMA channel!\n");
302 return;
303 }
68b65f73
RK
304 }
305
306 dmaengine_slave_config(chan, &tx_conf);
307 uap->dmatx.chan = chan;
308
309 dev_info(uap->port.dev, "DMA channel TX %s\n",
310 dma_chan_name(uap->dmatx.chan));
ead76f32
LW
311
312 /* Optionally make use of an RX channel as well */
787b0c1f 313 chan = dma_request_slave_channel(dev, "rx");
0d3c673e 314
787b0c1f
AB
315 if (!chan && plat->dma_rx_param) {
316 chan = dma_request_channel(mask, plat->dma_filter, plat->dma_rx_param);
317
318 if (!chan) {
319 dev_err(uap->port.dev, "no RX DMA channel!\n");
320 return;
321 }
322 }
323
324 if (chan) {
ead76f32
LW
325 struct dma_slave_config rx_conf = {
326 .src_addr = uap->port.mapbase + UART01x_DR,
327 .src_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE,
a485df4b 328 .direction = DMA_DEV_TO_MEM,
b2aeb775 329 .src_maxburst = uap->fifosize >> 2,
258aea76 330 .device_fc = false,
ead76f32 331 };
2d3b7d6e
AJ
332 struct dma_slave_caps caps;
333
334 /*
335 * Some DMA controllers provide information on their capabilities.
336 * If the controller does, check for suitable residue processing
337 * otherwise assime all is well.
338 */
339 if (0 == dma_get_slave_caps(chan, &caps)) {
340 if (caps.residue_granularity ==
341 DMA_RESIDUE_GRANULARITY_DESCRIPTOR) {
342 dma_release_channel(chan);
343 dev_info(uap->port.dev,
344 "RX DMA disabled - no residue processing\n");
345 return;
346 }
347 }
ead76f32
LW
348 dmaengine_slave_config(chan, &rx_conf);
349 uap->dmarx.chan = chan;
350
98267d33 351 uap->dmarx.auto_poll_rate = false;
8f898bfd 352 if (plat && plat->dma_rx_poll_enable) {
cb06ff10
CM
353 /* Set poll rate if specified. */
354 if (plat->dma_rx_poll_rate) {
355 uap->dmarx.auto_poll_rate = false;
356 uap->dmarx.poll_rate = plat->dma_rx_poll_rate;
357 } else {
358 /*
359 * 100 ms defaults to poll rate if not
360 * specified. This will be adjusted with
361 * the baud rate at set_termios.
362 */
363 uap->dmarx.auto_poll_rate = true;
364 uap->dmarx.poll_rate = 100;
365 }
366 /* 3 secs defaults poll_timeout if not specified. */
367 if (plat->dma_rx_poll_timeout)
368 uap->dmarx.poll_timeout =
369 plat->dma_rx_poll_timeout;
370 else
371 uap->dmarx.poll_timeout = 3000;
98267d33
AJ
372 } else if (!plat && dev->of_node) {
373 uap->dmarx.auto_poll_rate = of_property_read_bool(
374 dev->of_node, "auto-poll");
375 if (uap->dmarx.auto_poll_rate) {
376 u32 x;
377
378 if (0 == of_property_read_u32(dev->of_node,
379 "poll-rate-ms", &x))
380 uap->dmarx.poll_rate = x;
381 else
382 uap->dmarx.poll_rate = 100;
383 if (0 == of_property_read_u32(dev->of_node,
384 "poll-timeout-ms", &x))
385 uap->dmarx.poll_timeout = x;
386 else
387 uap->dmarx.poll_timeout = 3000;
388 }
389 }
ead76f32
LW
390 dev_info(uap->port.dev, "DMA channel RX %s\n",
391 dma_chan_name(uap->dmarx.chan));
392 }
68b65f73
RK
393}
394
68b65f73
RK
395static void pl011_dma_remove(struct uart_amba_port *uap)
396{
68b65f73
RK
397 if (uap->dmatx.chan)
398 dma_release_channel(uap->dmatx.chan);
ead76f32
LW
399 if (uap->dmarx.chan)
400 dma_release_channel(uap->dmarx.chan);
68b65f73
RK
401}
402
734745ca 403/* Forward declare these for the refill routine */
68b65f73 404static int pl011_dma_tx_refill(struct uart_amba_port *uap);
734745ca 405static void pl011_start_tx_pio(struct uart_amba_port *uap);
68b65f73
RK
406
407/*
408 * The current DMA TX buffer has been sent.
409 * Try to queue up another DMA buffer.
410 */
411static void pl011_dma_tx_callback(void *data)
412{
413 struct uart_amba_port *uap = data;
414 struct pl011_dmatx_data *dmatx = &uap->dmatx;
415 unsigned long flags;
416 u16 dmacr;
417
418 spin_lock_irqsave(&uap->port.lock, flags);
419 if (uap->dmatx.queued)
420 dma_unmap_sg(dmatx->chan->device->dev, &dmatx->sg, 1,
421 DMA_TO_DEVICE);
422
423 dmacr = uap->dmacr;
424 uap->dmacr = dmacr & ~UART011_TXDMAE;
425 writew(uap->dmacr, uap->port.membase + UART011_DMACR);
426
427 /*
428 * If TX DMA was disabled, it means that we've stopped the DMA for
429 * some reason (eg, XOFF received, or we want to send an X-char.)
430 *
431 * Note: we need to be careful here of a potential race between DMA
432 * and the rest of the driver - if the driver disables TX DMA while
433 * a TX buffer completing, we must update the tx queued status to
434 * get further refills (hence we check dmacr).
435 */
436 if (!(dmacr & UART011_TXDMAE) || uart_tx_stopped(&uap->port) ||
437 uart_circ_empty(&uap->port.state->xmit)) {
438 uap->dmatx.queued = false;
439 spin_unlock_irqrestore(&uap->port.lock, flags);
440 return;
441 }
442
734745ca 443 if (pl011_dma_tx_refill(uap) <= 0)
68b65f73
RK
444 /*
445 * We didn't queue a DMA buffer for some reason, but we
446 * have data pending to be sent. Re-enable the TX IRQ.
447 */
734745ca
DM
448 pl011_start_tx_pio(uap);
449
68b65f73
RK
450 spin_unlock_irqrestore(&uap->port.lock, flags);
451}
452
453/*
454 * Try to refill the TX DMA buffer.
455 * Locking: called with port lock held and IRQs disabled.
456 * Returns:
457 * 1 if we queued up a TX DMA buffer.
458 * 0 if we didn't want to handle this by DMA
459 * <0 on error
460 */
461static int pl011_dma_tx_refill(struct uart_amba_port *uap)
462{
463 struct pl011_dmatx_data *dmatx = &uap->dmatx;
464 struct dma_chan *chan = dmatx->chan;
465 struct dma_device *dma_dev = chan->device;
466 struct dma_async_tx_descriptor *desc;
467 struct circ_buf *xmit = &uap->port.state->xmit;
468 unsigned int count;
469
470 /*
471 * Try to avoid the overhead involved in using DMA if the
472 * transaction fits in the first half of the FIFO, by using
473 * the standard interrupt handling. This ensures that we
474 * issue a uart_write_wakeup() at the appropriate time.
475 */
476 count = uart_circ_chars_pending(xmit);
477 if (count < (uap->fifosize >> 1)) {
478 uap->dmatx.queued = false;
479 return 0;
480 }
481
482 /*
483 * Bodge: don't send the last character by DMA, as this
484 * will prevent XON from notifying us to restart DMA.
485 */
486 count -= 1;
487
488 /* Else proceed to copy the TX chars to the DMA buffer and fire DMA */
489 if (count > PL011_DMA_BUFFER_SIZE)
490 count = PL011_DMA_BUFFER_SIZE;
491
492 if (xmit->tail < xmit->head)
493 memcpy(&dmatx->buf[0], &xmit->buf[xmit->tail], count);
494 else {
495 size_t first = UART_XMIT_SIZE - xmit->tail;
e2a545a6
AJ
496 size_t second;
497
498 if (first > count)
499 first = count;
500 second = count - first;
68b65f73
RK
501
502 memcpy(&dmatx->buf[0], &xmit->buf[xmit->tail], first);
503 if (second)
504 memcpy(&dmatx->buf[first], &xmit->buf[0], second);
505 }
506
507 dmatx->sg.length = count;
508
509 if (dma_map_sg(dma_dev->dev, &dmatx->sg, 1, DMA_TO_DEVICE) != 1) {
510 uap->dmatx.queued = false;
511 dev_dbg(uap->port.dev, "unable to map TX DMA\n");
512 return -EBUSY;
513 }
514
16052827 515 desc = dmaengine_prep_slave_sg(chan, &dmatx->sg, 1, DMA_MEM_TO_DEV,
68b65f73
RK
516 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
517 if (!desc) {
518 dma_unmap_sg(dma_dev->dev, &dmatx->sg, 1, DMA_TO_DEVICE);
519 uap->dmatx.queued = false;
520 /*
521 * If DMA cannot be used right now, we complete this
522 * transaction via IRQ and let the TTY layer retry.
523 */
524 dev_dbg(uap->port.dev, "TX DMA busy\n");
525 return -EBUSY;
526 }
527
528 /* Some data to go along to the callback */
529 desc->callback = pl011_dma_tx_callback;
530 desc->callback_param = uap;
531
532 /* All errors should happen at prepare time */
533 dmaengine_submit(desc);
534
535 /* Fire the DMA transaction */
536 dma_dev->device_issue_pending(chan);
537
538 uap->dmacr |= UART011_TXDMAE;
539 writew(uap->dmacr, uap->port.membase + UART011_DMACR);
540 uap->dmatx.queued = true;
541
542 /*
543 * Now we know that DMA will fire, so advance the ring buffer
544 * with the stuff we just dispatched.
545 */
546 xmit->tail = (xmit->tail + count) & (UART_XMIT_SIZE - 1);
547 uap->port.icount.tx += count;
548
549 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
550 uart_write_wakeup(&uap->port);
551
552 return 1;
553}
554
555/*
556 * We received a transmit interrupt without a pending X-char but with
557 * pending characters.
558 * Locking: called with port lock held and IRQs disabled.
559 * Returns:
560 * false if we want to use PIO to transmit
561 * true if we queued a DMA buffer
562 */
563static bool pl011_dma_tx_irq(struct uart_amba_port *uap)
564{
ead76f32 565 if (!uap->using_tx_dma)
68b65f73
RK
566 return false;
567
568 /*
569 * If we already have a TX buffer queued, but received a
570 * TX interrupt, it will be because we've just sent an X-char.
571 * Ensure the TX DMA is enabled and the TX IRQ is disabled.
572 */
573 if (uap->dmatx.queued) {
574 uap->dmacr |= UART011_TXDMAE;
575 writew(uap->dmacr, uap->port.membase + UART011_DMACR);
576 uap->im &= ~UART011_TXIM;
577 writew(uap->im, uap->port.membase + UART011_IMSC);
578 return true;
579 }
580
581 /*
582 * We don't have a TX buffer queued, so try to queue one.
25985edc 583 * If we successfully queued a buffer, mask the TX IRQ.
68b65f73
RK
584 */
585 if (pl011_dma_tx_refill(uap) > 0) {
586 uap->im &= ~UART011_TXIM;
587 writew(uap->im, uap->port.membase + UART011_IMSC);
588 return true;
589 }
590 return false;
591}
592
593/*
594 * Stop the DMA transmit (eg, due to received XOFF).
595 * Locking: called with port lock held and IRQs disabled.
596 */
597static inline void pl011_dma_tx_stop(struct uart_amba_port *uap)
598{
599 if (uap->dmatx.queued) {
600 uap->dmacr &= ~UART011_TXDMAE;
601 writew(uap->dmacr, uap->port.membase + UART011_DMACR);
602 }
603}
604
605/*
606 * Try to start a DMA transmit, or in the case of an XON/OFF
607 * character queued for send, try to get that character out ASAP.
608 * Locking: called with port lock held and IRQs disabled.
609 * Returns:
610 * false if we want the TX IRQ to be enabled
611 * true if we have a buffer queued
612 */
613static inline bool pl011_dma_tx_start(struct uart_amba_port *uap)
614{
615 u16 dmacr;
616
ead76f32 617 if (!uap->using_tx_dma)
68b65f73
RK
618 return false;
619
620 if (!uap->port.x_char) {
621 /* no X-char, try to push chars out in DMA mode */
622 bool ret = true;
623
624 if (!uap->dmatx.queued) {
625 if (pl011_dma_tx_refill(uap) > 0) {
626 uap->im &= ~UART011_TXIM;
734745ca
DM
627 writew(uap->im, uap->port.membase +
628 UART011_IMSC);
629 } else
68b65f73 630 ret = false;
68b65f73
RK
631 } else if (!(uap->dmacr & UART011_TXDMAE)) {
632 uap->dmacr |= UART011_TXDMAE;
633 writew(uap->dmacr,
634 uap->port.membase + UART011_DMACR);
635 }
636 return ret;
637 }
638
639 /*
640 * We have an X-char to send. Disable DMA to prevent it loading
641 * the TX fifo, and then see if we can stuff it into the FIFO.
642 */
643 dmacr = uap->dmacr;
644 uap->dmacr &= ~UART011_TXDMAE;
645 writew(uap->dmacr, uap->port.membase + UART011_DMACR);
646
647 if (readw(uap->port.membase + UART01x_FR) & UART01x_FR_TXFF) {
648 /*
649 * No space in the FIFO, so enable the transmit interrupt
650 * so we know when there is space. Note that once we've
651 * loaded the character, we should just re-enable DMA.
652 */
653 return false;
654 }
655
656 writew(uap->port.x_char, uap->port.membase + UART01x_DR);
657 uap->port.icount.tx++;
658 uap->port.x_char = 0;
659
660 /* Success - restore the DMA state */
661 uap->dmacr = dmacr;
662 writew(dmacr, uap->port.membase + UART011_DMACR);
663
664 return true;
665}
666
667/*
668 * Flush the transmit buffer.
669 * Locking: called with port lock held and IRQs disabled.
670 */
671static void pl011_dma_flush_buffer(struct uart_port *port)
b83286bf
FE
672__releases(&uap->port.lock)
673__acquires(&uap->port.lock)
68b65f73 674{
a5820c24
DT
675 struct uart_amba_port *uap =
676 container_of(port, struct uart_amba_port, port);
68b65f73 677
ead76f32 678 if (!uap->using_tx_dma)
68b65f73
RK
679 return;
680
681 /* Avoid deadlock with the DMA engine callback */
682 spin_unlock(&uap->port.lock);
683 dmaengine_terminate_all(uap->dmatx.chan);
684 spin_lock(&uap->port.lock);
685 if (uap->dmatx.queued) {
686 dma_unmap_sg(uap->dmatx.chan->device->dev, &uap->dmatx.sg, 1,
687 DMA_TO_DEVICE);
688 uap->dmatx.queued = false;
689 uap->dmacr &= ~UART011_TXDMAE;
690 writew(uap->dmacr, uap->port.membase + UART011_DMACR);
691 }
692}
693
ead76f32
LW
694static void pl011_dma_rx_callback(void *data);
695
696static int pl011_dma_rx_trigger_dma(struct uart_amba_port *uap)
697{
698 struct dma_chan *rxchan = uap->dmarx.chan;
ead76f32
LW
699 struct pl011_dmarx_data *dmarx = &uap->dmarx;
700 struct dma_async_tx_descriptor *desc;
701 struct pl011_sgbuf *sgbuf;
702
703 if (!rxchan)
704 return -EIO;
705
706 /* Start the RX DMA job */
707 sgbuf = uap->dmarx.use_buf_b ?
708 &uap->dmarx.sgbuf_b : &uap->dmarx.sgbuf_a;
16052827 709 desc = dmaengine_prep_slave_sg(rxchan, &sgbuf->sg, 1,
a485df4b 710 DMA_DEV_TO_MEM,
ead76f32
LW
711 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
712 /*
713 * If the DMA engine is busy and cannot prepare a
714 * channel, no big deal, the driver will fall back
715 * to interrupt mode as a result of this error code.
716 */
717 if (!desc) {
718 uap->dmarx.running = false;
719 dmaengine_terminate_all(rxchan);
720 return -EBUSY;
721 }
722
723 /* Some data to go along to the callback */
724 desc->callback = pl011_dma_rx_callback;
725 desc->callback_param = uap;
726 dmarx->cookie = dmaengine_submit(desc);
727 dma_async_issue_pending(rxchan);
728
729 uap->dmacr |= UART011_RXDMAE;
730 writew(uap->dmacr, uap->port.membase + UART011_DMACR);
731 uap->dmarx.running = true;
732
733 uap->im &= ~UART011_RXIM;
734 writew(uap->im, uap->port.membase + UART011_IMSC);
735
736 return 0;
737}
738
739/*
740 * This is called when either the DMA job is complete, or
741 * the FIFO timeout interrupt occurred. This must be called
742 * with the port spinlock uap->port.lock held.
743 */
744static void pl011_dma_rx_chars(struct uart_amba_port *uap,
745 u32 pending, bool use_buf_b,
746 bool readfifo)
747{
05c7cd39 748 struct tty_port *port = &uap->port.state->port;
ead76f32
LW
749 struct pl011_sgbuf *sgbuf = use_buf_b ?
750 &uap->dmarx.sgbuf_b : &uap->dmarx.sgbuf_a;
ead76f32
LW
751 int dma_count = 0;
752 u32 fifotaken = 0; /* only used for vdbg() */
753
cb06ff10
CM
754 struct pl011_dmarx_data *dmarx = &uap->dmarx;
755 int dmataken = 0;
756
757 if (uap->dmarx.poll_rate) {
758 /* The data can be taken by polling */
759 dmataken = sgbuf->sg.length - dmarx->last_residue;
760 /* Recalculate the pending size */
761 if (pending >= dmataken)
762 pending -= dmataken;
763 }
764
765 /* Pick the remain data from the DMA */
ead76f32 766 if (pending) {
ead76f32
LW
767
768 /*
769 * First take all chars in the DMA pipe, then look in the FIFO.
770 * Note that tty_insert_flip_buf() tries to take as many chars
771 * as it can.
772 */
cb06ff10
CM
773 dma_count = tty_insert_flip_string(port, sgbuf->buf + dmataken,
774 pending);
ead76f32
LW
775
776 uap->port.icount.rx += dma_count;
777 if (dma_count < pending)
778 dev_warn(uap->port.dev,
779 "couldn't insert all characters (TTY is full?)\n");
780 }
781
cb06ff10
CM
782 /* Reset the last_residue for Rx DMA poll */
783 if (uap->dmarx.poll_rate)
784 dmarx->last_residue = sgbuf->sg.length;
785
ead76f32
LW
786 /*
787 * Only continue with trying to read the FIFO if all DMA chars have
788 * been taken first.
789 */
790 if (dma_count == pending && readfifo) {
791 /* Clear any error flags */
792 writew(UART011_OEIS | UART011_BEIS | UART011_PEIS | UART011_FEIS,
793 uap->port.membase + UART011_ICR);
794
795 /*
796 * If we read all the DMA'd characters, and we had an
29772c4e
LW
797 * incomplete buffer, that could be due to an rx error, or
798 * maybe we just timed out. Read any pending chars and check
799 * the error status.
800 *
801 * Error conditions will only occur in the FIFO, these will
802 * trigger an immediate interrupt and stop the DMA job, so we
803 * will always find the error in the FIFO, never in the DMA
804 * buffer.
ead76f32 805 */
29772c4e 806 fifotaken = pl011_fifo_to_tty(uap);
ead76f32
LW
807 }
808
809 spin_unlock(&uap->port.lock);
810 dev_vdbg(uap->port.dev,
811 "Took %d chars from DMA buffer and %d chars from the FIFO\n",
812 dma_count, fifotaken);
2e124b4a 813 tty_flip_buffer_push(port);
ead76f32
LW
814 spin_lock(&uap->port.lock);
815}
816
817static void pl011_dma_rx_irq(struct uart_amba_port *uap)
818{
819 struct pl011_dmarx_data *dmarx = &uap->dmarx;
820 struct dma_chan *rxchan = dmarx->chan;
821 struct pl011_sgbuf *sgbuf = dmarx->use_buf_b ?
822 &dmarx->sgbuf_b : &dmarx->sgbuf_a;
823 size_t pending;
824 struct dma_tx_state state;
825 enum dma_status dmastat;
826
827 /*
828 * Pause the transfer so we can trust the current counter,
829 * do this before we pause the PL011 block, else we may
830 * overflow the FIFO.
831 */
832 if (dmaengine_pause(rxchan))
833 dev_err(uap->port.dev, "unable to pause DMA transfer\n");
834 dmastat = rxchan->device->device_tx_status(rxchan,
835 dmarx->cookie, &state);
836 if (dmastat != DMA_PAUSED)
837 dev_err(uap->port.dev, "unable to pause DMA transfer\n");
838
839 /* Disable RX DMA - incoming data will wait in the FIFO */
840 uap->dmacr &= ~UART011_RXDMAE;
841 writew(uap->dmacr, uap->port.membase + UART011_DMACR);
842 uap->dmarx.running = false;
843
844 pending = sgbuf->sg.length - state.residue;
845 BUG_ON(pending > PL011_DMA_BUFFER_SIZE);
846 /* Then we terminate the transfer - we now know our residue */
847 dmaengine_terminate_all(rxchan);
848
849 /*
850 * This will take the chars we have so far and insert
851 * into the framework.
852 */
853 pl011_dma_rx_chars(uap, pending, dmarx->use_buf_b, true);
854
855 /* Switch buffer & re-trigger DMA job */
856 dmarx->use_buf_b = !dmarx->use_buf_b;
857 if (pl011_dma_rx_trigger_dma(uap)) {
858 dev_dbg(uap->port.dev, "could not retrigger RX DMA job "
859 "fall back to interrupt mode\n");
860 uap->im |= UART011_RXIM;
861 writew(uap->im, uap->port.membase + UART011_IMSC);
862 }
863}
864
865static void pl011_dma_rx_callback(void *data)
866{
867 struct uart_amba_port *uap = data;
868 struct pl011_dmarx_data *dmarx = &uap->dmarx;
6dc01aa6 869 struct dma_chan *rxchan = dmarx->chan;
ead76f32 870 bool lastbuf = dmarx->use_buf_b;
6dc01aa6
CM
871 struct pl011_sgbuf *sgbuf = dmarx->use_buf_b ?
872 &dmarx->sgbuf_b : &dmarx->sgbuf_a;
873 size_t pending;
874 struct dma_tx_state state;
ead76f32
LW
875 int ret;
876
877 /*
878 * This completion interrupt occurs typically when the
879 * RX buffer is totally stuffed but no timeout has yet
880 * occurred. When that happens, we just want the RX
881 * routine to flush out the secondary DMA buffer while
882 * we immediately trigger the next DMA job.
883 */
884 spin_lock_irq(&uap->port.lock);
6dc01aa6
CM
885 /*
886 * Rx data can be taken by the UART interrupts during
887 * the DMA irq handler. So we check the residue here.
888 */
889 rxchan->device->device_tx_status(rxchan, dmarx->cookie, &state);
890 pending = sgbuf->sg.length - state.residue;
891 BUG_ON(pending > PL011_DMA_BUFFER_SIZE);
892 /* Then we terminate the transfer - we now know our residue */
893 dmaengine_terminate_all(rxchan);
894
ead76f32
LW
895 uap->dmarx.running = false;
896 dmarx->use_buf_b = !lastbuf;
897 ret = pl011_dma_rx_trigger_dma(uap);
898
6dc01aa6 899 pl011_dma_rx_chars(uap, pending, lastbuf, false);
ead76f32
LW
900 spin_unlock_irq(&uap->port.lock);
901 /*
902 * Do this check after we picked the DMA chars so we don't
903 * get some IRQ immediately from RX.
904 */
905 if (ret) {
906 dev_dbg(uap->port.dev, "could not retrigger RX DMA job "
907 "fall back to interrupt mode\n");
908 uap->im |= UART011_RXIM;
909 writew(uap->im, uap->port.membase + UART011_IMSC);
910 }
911}
912
913/*
914 * Stop accepting received characters, when we're shutting down or
915 * suspending this port.
916 * Locking: called with port lock held and IRQs disabled.
917 */
918static inline void pl011_dma_rx_stop(struct uart_amba_port *uap)
919{
920 /* FIXME. Just disable the DMA enable */
921 uap->dmacr &= ~UART011_RXDMAE;
922 writew(uap->dmacr, uap->port.membase + UART011_DMACR);
923}
68b65f73 924
cb06ff10
CM
925/*
926 * Timer handler for Rx DMA polling.
927 * Every polling, It checks the residue in the dma buffer and transfer
928 * data to the tty. Also, last_residue is updated for the next polling.
929 */
930static void pl011_dma_rx_poll(unsigned long args)
931{
932 struct uart_amba_port *uap = (struct uart_amba_port *)args;
933 struct tty_port *port = &uap->port.state->port;
934 struct pl011_dmarx_data *dmarx = &uap->dmarx;
935 struct dma_chan *rxchan = uap->dmarx.chan;
936 unsigned long flags = 0;
937 unsigned int dmataken = 0;
938 unsigned int size = 0;
939 struct pl011_sgbuf *sgbuf;
940 int dma_count;
941 struct dma_tx_state state;
942
943 sgbuf = dmarx->use_buf_b ? &uap->dmarx.sgbuf_b : &uap->dmarx.sgbuf_a;
944 rxchan->device->device_tx_status(rxchan, dmarx->cookie, &state);
945 if (likely(state.residue < dmarx->last_residue)) {
946 dmataken = sgbuf->sg.length - dmarx->last_residue;
947 size = dmarx->last_residue - state.residue;
948 dma_count = tty_insert_flip_string(port, sgbuf->buf + dmataken,
949 size);
950 if (dma_count == size)
951 dmarx->last_residue = state.residue;
952 dmarx->last_jiffies = jiffies;
953 }
954 tty_flip_buffer_push(port);
955
956 /*
957 * If no data is received in poll_timeout, the driver will fall back
958 * to interrupt mode. We will retrigger DMA at the first interrupt.
959 */
960 if (jiffies_to_msecs(jiffies - dmarx->last_jiffies)
961 > uap->dmarx.poll_timeout) {
962
963 spin_lock_irqsave(&uap->port.lock, flags);
964 pl011_dma_rx_stop(uap);
c25a1ad7
GL
965 uap->im |= UART011_RXIM;
966 writew(uap->im, uap->port.membase + UART011_IMSC);
cb06ff10
CM
967 spin_unlock_irqrestore(&uap->port.lock, flags);
968
969 uap->dmarx.running = false;
970 dmaengine_terminate_all(rxchan);
971 del_timer(&uap->dmarx.timer);
972 } else {
973 mod_timer(&uap->dmarx.timer,
974 jiffies + msecs_to_jiffies(uap->dmarx.poll_rate));
975 }
976}
977
68b65f73
RK
978static void pl011_dma_startup(struct uart_amba_port *uap)
979{
ead76f32
LW
980 int ret;
981
1c9be310
JRO
982 if (!uap->dma_probed)
983 pl011_dma_probe(uap);
984
68b65f73
RK
985 if (!uap->dmatx.chan)
986 return;
987
4c0be45b 988 uap->dmatx.buf = kmalloc(PL011_DMA_BUFFER_SIZE, GFP_KERNEL | __GFP_DMA);
68b65f73
RK
989 if (!uap->dmatx.buf) {
990 dev_err(uap->port.dev, "no memory for DMA TX buffer\n");
991 uap->port.fifosize = uap->fifosize;
992 return;
993 }
994
995 sg_init_one(&uap->dmatx.sg, uap->dmatx.buf, PL011_DMA_BUFFER_SIZE);
996
997 /* The DMA buffer is now the FIFO the TTY subsystem can use */
998 uap->port.fifosize = PL011_DMA_BUFFER_SIZE;
ead76f32
LW
999 uap->using_tx_dma = true;
1000
1001 if (!uap->dmarx.chan)
1002 goto skip_rx;
1003
1004 /* Allocate and map DMA RX buffers */
1005 ret = pl011_sgbuf_init(uap->dmarx.chan, &uap->dmarx.sgbuf_a,
1006 DMA_FROM_DEVICE);
1007 if (ret) {
1008 dev_err(uap->port.dev, "failed to init DMA %s: %d\n",
1009 "RX buffer A", ret);
1010 goto skip_rx;
1011 }
68b65f73 1012
ead76f32
LW
1013 ret = pl011_sgbuf_init(uap->dmarx.chan, &uap->dmarx.sgbuf_b,
1014 DMA_FROM_DEVICE);
1015 if (ret) {
1016 dev_err(uap->port.dev, "failed to init DMA %s: %d\n",
1017 "RX buffer B", ret);
1018 pl011_sgbuf_free(uap->dmarx.chan, &uap->dmarx.sgbuf_a,
1019 DMA_FROM_DEVICE);
1020 goto skip_rx;
1021 }
1022
1023 uap->using_rx_dma = true;
68b65f73 1024
ead76f32 1025skip_rx:
68b65f73
RK
1026 /* Turn on DMA error (RX/TX will be enabled on demand) */
1027 uap->dmacr |= UART011_DMAONERR;
1028 writew(uap->dmacr, uap->port.membase + UART011_DMACR);
38d62436
RK
1029
1030 /*
1031 * ST Micro variants has some specific dma burst threshold
1032 * compensation. Set this to 16 bytes, so burst will only
1033 * be issued above/below 16 bytes.
1034 */
1035 if (uap->vendor->dma_threshold)
1036 writew(ST_UART011_DMAWM_RX_16 | ST_UART011_DMAWM_TX_16,
1037 uap->port.membase + ST_UART011_DMAWM);
ead76f32
LW
1038
1039 if (uap->using_rx_dma) {
1040 if (pl011_dma_rx_trigger_dma(uap))
1041 dev_dbg(uap->port.dev, "could not trigger initial "
1042 "RX DMA job, fall back to interrupt mode\n");
cb06ff10
CM
1043 if (uap->dmarx.poll_rate) {
1044 init_timer(&(uap->dmarx.timer));
1045 uap->dmarx.timer.function = pl011_dma_rx_poll;
1046 uap->dmarx.timer.data = (unsigned long)uap;
1047 mod_timer(&uap->dmarx.timer,
1048 jiffies +
1049 msecs_to_jiffies(uap->dmarx.poll_rate));
1050 uap->dmarx.last_residue = PL011_DMA_BUFFER_SIZE;
1051 uap->dmarx.last_jiffies = jiffies;
1052 }
ead76f32 1053 }
68b65f73
RK
1054}
1055
1056static void pl011_dma_shutdown(struct uart_amba_port *uap)
1057{
ead76f32 1058 if (!(uap->using_tx_dma || uap->using_rx_dma))
68b65f73
RK
1059 return;
1060
1061 /* Disable RX and TX DMA */
1062 while (readw(uap->port.membase + UART01x_FR) & UART01x_FR_BUSY)
1063 barrier();
1064
1065 spin_lock_irq(&uap->port.lock);
1066 uap->dmacr &= ~(UART011_DMAONERR | UART011_RXDMAE | UART011_TXDMAE);
1067 writew(uap->dmacr, uap->port.membase + UART011_DMACR);
1068 spin_unlock_irq(&uap->port.lock);
1069
ead76f32
LW
1070 if (uap->using_tx_dma) {
1071 /* In theory, this should already be done by pl011_dma_flush_buffer */
1072 dmaengine_terminate_all(uap->dmatx.chan);
1073 if (uap->dmatx.queued) {
1074 dma_unmap_sg(uap->dmatx.chan->device->dev, &uap->dmatx.sg, 1,
1075 DMA_TO_DEVICE);
1076 uap->dmatx.queued = false;
1077 }
1078
1079 kfree(uap->dmatx.buf);
1080 uap->using_tx_dma = false;
68b65f73
RK
1081 }
1082
ead76f32
LW
1083 if (uap->using_rx_dma) {
1084 dmaengine_terminate_all(uap->dmarx.chan);
1085 /* Clean up the RX DMA */
1086 pl011_sgbuf_free(uap->dmarx.chan, &uap->dmarx.sgbuf_a, DMA_FROM_DEVICE);
1087 pl011_sgbuf_free(uap->dmarx.chan, &uap->dmarx.sgbuf_b, DMA_FROM_DEVICE);
cb06ff10
CM
1088 if (uap->dmarx.poll_rate)
1089 del_timer_sync(&uap->dmarx.timer);
ead76f32
LW
1090 uap->using_rx_dma = false;
1091 }
1092}
68b65f73 1093
ead76f32
LW
1094static inline bool pl011_dma_rx_available(struct uart_amba_port *uap)
1095{
1096 return uap->using_rx_dma;
68b65f73
RK
1097}
1098
ead76f32
LW
1099static inline bool pl011_dma_rx_running(struct uart_amba_port *uap)
1100{
1101 return uap->using_rx_dma && uap->dmarx.running;
1102}
1103
68b65f73
RK
1104#else
1105/* Blank functions if the DMA engine is not available */
1c9be310 1106static inline void pl011_dma_probe(struct uart_amba_port *uap)
68b65f73
RK
1107{
1108}
1109
1110static inline void pl011_dma_remove(struct uart_amba_port *uap)
1111{
1112}
1113
1114static inline void pl011_dma_startup(struct uart_amba_port *uap)
1115{
1116}
1117
1118static inline void pl011_dma_shutdown(struct uart_amba_port *uap)
1119{
1120}
1121
1122static inline bool pl011_dma_tx_irq(struct uart_amba_port *uap)
1123{
1124 return false;
1125}
1126
1127static inline void pl011_dma_tx_stop(struct uart_amba_port *uap)
1128{
1129}
1130
1131static inline bool pl011_dma_tx_start(struct uart_amba_port *uap)
1132{
1133 return false;
1134}
1135
ead76f32
LW
1136static inline void pl011_dma_rx_irq(struct uart_amba_port *uap)
1137{
1138}
1139
1140static inline void pl011_dma_rx_stop(struct uart_amba_port *uap)
1141{
1142}
1143
1144static inline int pl011_dma_rx_trigger_dma(struct uart_amba_port *uap)
1145{
1146 return -EIO;
1147}
1148
1149static inline bool pl011_dma_rx_available(struct uart_amba_port *uap)
1150{
1151 return false;
1152}
1153
1154static inline bool pl011_dma_rx_running(struct uart_amba_port *uap)
1155{
1156 return false;
1157}
1158
68b65f73
RK
1159#define pl011_dma_flush_buffer NULL
1160#endif
1161
b129a8cc 1162static void pl011_stop_tx(struct uart_port *port)
1da177e4 1163{
a5820c24
DT
1164 struct uart_amba_port *uap =
1165 container_of(port, struct uart_amba_port, port);
1da177e4
LT
1166
1167 uap->im &= ~UART011_TXIM;
1168 writew(uap->im, uap->port.membase + UART011_IMSC);
68b65f73 1169 pl011_dma_tx_stop(uap);
1da177e4
LT
1170}
1171
1e84d223 1172static void pl011_tx_chars(struct uart_amba_port *uap, bool from_irq);
734745ca
DM
1173
1174/* Start TX with programmed I/O only (no DMA) */
1175static void pl011_start_tx_pio(struct uart_amba_port *uap)
1176{
1177 uap->im |= UART011_TXIM;
1178 writew(uap->im, uap->port.membase + UART011_IMSC);
1e84d223 1179 pl011_tx_chars(uap, false);
734745ca
DM
1180}
1181
b129a8cc 1182static void pl011_start_tx(struct uart_port *port)
1da177e4 1183{
a5820c24
DT
1184 struct uart_amba_port *uap =
1185 container_of(port, struct uart_amba_port, port);
1da177e4 1186
734745ca
DM
1187 if (!pl011_dma_tx_start(uap))
1188 pl011_start_tx_pio(uap);
1da177e4
LT
1189}
1190
1191static void pl011_stop_rx(struct uart_port *port)
1192{
a5820c24
DT
1193 struct uart_amba_port *uap =
1194 container_of(port, struct uart_amba_port, port);
1da177e4
LT
1195
1196 uap->im &= ~(UART011_RXIM|UART011_RTIM|UART011_FEIM|
1197 UART011_PEIM|UART011_BEIM|UART011_OEIM);
1198 writew(uap->im, uap->port.membase + UART011_IMSC);
ead76f32
LW
1199
1200 pl011_dma_rx_stop(uap);
1da177e4
LT
1201}
1202
1203static void pl011_enable_ms(struct uart_port *port)
1204{
a5820c24
DT
1205 struct uart_amba_port *uap =
1206 container_of(port, struct uart_amba_port, port);
1da177e4
LT
1207
1208 uap->im |= UART011_RIMIM|UART011_CTSMIM|UART011_DCDMIM|UART011_DSRMIM;
1209 writew(uap->im, uap->port.membase + UART011_IMSC);
1210}
1211
7d12e780 1212static void pl011_rx_chars(struct uart_amba_port *uap)
b83286bf
FE
1213__releases(&uap->port.lock)
1214__acquires(&uap->port.lock)
1da177e4 1215{
29772c4e 1216 pl011_fifo_to_tty(uap);
1da177e4 1217
2389b272 1218 spin_unlock(&uap->port.lock);
2e124b4a 1219 tty_flip_buffer_push(&uap->port.state->port);
ead76f32
LW
1220 /*
1221 * If we were temporarily out of DMA mode for a while,
1222 * attempt to switch back to DMA mode again.
1223 */
1224 if (pl011_dma_rx_available(uap)) {
1225 if (pl011_dma_rx_trigger_dma(uap)) {
1226 dev_dbg(uap->port.dev, "could not trigger RX DMA job "
1227 "fall back to interrupt mode again\n");
1228 uap->im |= UART011_RXIM;
30ae5859 1229 writew(uap->im, uap->port.membase + UART011_IMSC);
cb06ff10 1230 } else {
89fa28db 1231#ifdef CONFIG_DMA_ENGINE
cb06ff10
CM
1232 /* Start Rx DMA poll */
1233 if (uap->dmarx.poll_rate) {
1234 uap->dmarx.last_jiffies = jiffies;
1235 uap->dmarx.last_residue = PL011_DMA_BUFFER_SIZE;
1236 mod_timer(&uap->dmarx.timer,
1237 jiffies +
1238 msecs_to_jiffies(uap->dmarx.poll_rate));
1239 }
89fa28db 1240#endif
cb06ff10 1241 }
ead76f32 1242 }
2389b272 1243 spin_lock(&uap->port.lock);
1da177e4
LT
1244}
1245
1e84d223
DM
1246static bool pl011_tx_char(struct uart_amba_port *uap, unsigned char c,
1247 bool from_irq)
734745ca 1248{
1e84d223
DM
1249 if (unlikely(!from_irq) &&
1250 readw(uap->port.membase + UART01x_FR) & UART01x_FR_TXFF)
1251 return false; /* unable to transmit character */
1252
734745ca
DM
1253 writew(c, uap->port.membase + UART01x_DR);
1254 uap->port.icount.tx++;
1255
1e84d223 1256 return true;
734745ca
DM
1257}
1258
1e84d223 1259static void pl011_tx_chars(struct uart_amba_port *uap, bool from_irq)
1da177e4 1260{
ebd2c8f6 1261 struct circ_buf *xmit = &uap->port.state->xmit;
1e84d223 1262 int count = uap->fifosize >> 1;
734745ca 1263
1da177e4 1264 if (uap->port.x_char) {
1e84d223
DM
1265 if (!pl011_tx_char(uap, uap->port.x_char, from_irq))
1266 return;
1da177e4 1267 uap->port.x_char = 0;
734745ca 1268 --count;
1da177e4
LT
1269 }
1270 if (uart_circ_empty(xmit) || uart_tx_stopped(&uap->port)) {
b129a8cc 1271 pl011_stop_tx(&uap->port);
1e84d223 1272 return;
1da177e4
LT
1273 }
1274
68b65f73
RK
1275 /* If we are using DMA mode, try to send some characters. */
1276 if (pl011_dma_tx_irq(uap))
1e84d223 1277 return;
68b65f73 1278
1e84d223
DM
1279 do {
1280 if (likely(from_irq) && count-- == 0)
1da177e4 1281 break;
1e84d223
DM
1282
1283 if (!pl011_tx_char(uap, xmit->buf[xmit->tail], from_irq))
1284 break;
1285
1286 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
1287 } while (!uart_circ_empty(xmit));
1da177e4
LT
1288
1289 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
1290 uart_write_wakeup(&uap->port);
1291
1e84d223 1292 if (uart_circ_empty(xmit))
b129a8cc 1293 pl011_stop_tx(&uap->port);
1da177e4
LT
1294}
1295
1296static void pl011_modem_status(struct uart_amba_port *uap)
1297{
1298 unsigned int status, delta;
1299
1300 status = readw(uap->port.membase + UART01x_FR) & UART01x_FR_MODEM_ANY;
1301
1302 delta = status ^ uap->old_status;
1303 uap->old_status = status;
1304
1305 if (!delta)
1306 return;
1307
1308 if (delta & UART01x_FR_DCD)
1309 uart_handle_dcd_change(&uap->port, status & UART01x_FR_DCD);
1310
1311 if (delta & UART01x_FR_DSR)
1312 uap->port.icount.dsr++;
1313
1314 if (delta & UART01x_FR_CTS)
1315 uart_handle_cts_change(&uap->port, status & UART01x_FR_CTS);
1316
bdc04e31 1317 wake_up_interruptible(&uap->port.state->port.delta_msr_wait);
1da177e4
LT
1318}
1319
7d12e780 1320static irqreturn_t pl011_int(int irq, void *dev_id)
1da177e4
LT
1321{
1322 struct uart_amba_port *uap = dev_id;
963cc981 1323 unsigned long flags;
1da177e4
LT
1324 unsigned int status, pass_counter = AMBA_ISR_PASS_LIMIT;
1325 int handled = 0;
4fd0690b 1326 unsigned int dummy_read;
1da177e4 1327
963cc981 1328 spin_lock_irqsave(&uap->port.lock, flags);
1da177e4
LT
1329 status = readw(uap->port.membase + UART011_MIS);
1330 if (status) {
1331 do {
4fd0690b
R
1332 if (uap->vendor->cts_event_workaround) {
1333 /* workaround to make sure that all bits are unlocked.. */
1334 writew(0x00, uap->port.membase + UART011_ICR);
1335
1336 /*
1337 * WA: introduce 26ns(1 uart clk) delay before W1C;
1338 * single apb access will incur 2 pclk(133.12Mhz) delay,
1339 * so add 2 dummy reads
1340 */
1341 dummy_read = readw(uap->port.membase + UART011_ICR);
1342 dummy_read = readw(uap->port.membase + UART011_ICR);
1343 }
1344
1da177e4
LT
1345 writew(status & ~(UART011_TXIS|UART011_RTIS|
1346 UART011_RXIS),
1347 uap->port.membase + UART011_ICR);
1348
ead76f32
LW
1349 if (status & (UART011_RTIS|UART011_RXIS)) {
1350 if (pl011_dma_rx_running(uap))
1351 pl011_dma_rx_irq(uap);
1352 else
1353 pl011_rx_chars(uap);
1354 }
1da177e4
LT
1355 if (status & (UART011_DSRMIS|UART011_DCDMIS|
1356 UART011_CTSMIS|UART011_RIMIS))
1357 pl011_modem_status(uap);
1e84d223
DM
1358 if (status & UART011_TXIS)
1359 pl011_tx_chars(uap, true);
1da177e4 1360
4fd0690b 1361 if (pass_counter-- == 0)
1da177e4
LT
1362 break;
1363
1364 status = readw(uap->port.membase + UART011_MIS);
1365 } while (status != 0);
1366 handled = 1;
1367 }
1368
963cc981 1369 spin_unlock_irqrestore(&uap->port.lock, flags);
1da177e4
LT
1370
1371 return IRQ_RETVAL(handled);
1372}
1373
e643f87f 1374static unsigned int pl011_tx_empty(struct uart_port *port)
1da177e4 1375{
a5820c24
DT
1376 struct uart_amba_port *uap =
1377 container_of(port, struct uart_amba_port, port);
1da177e4
LT
1378 unsigned int status = readw(uap->port.membase + UART01x_FR);
1379 return status & (UART01x_FR_BUSY|UART01x_FR_TXFF) ? 0 : TIOCSER_TEMT;
1380}
1381
e643f87f 1382static unsigned int pl011_get_mctrl(struct uart_port *port)
1da177e4 1383{
a5820c24
DT
1384 struct uart_amba_port *uap =
1385 container_of(port, struct uart_amba_port, port);
1da177e4
LT
1386 unsigned int result = 0;
1387 unsigned int status = readw(uap->port.membase + UART01x_FR);
1388
5159f407 1389#define TIOCMBIT(uartbit, tiocmbit) \
1da177e4
LT
1390 if (status & uartbit) \
1391 result |= tiocmbit
1392
5159f407
JS
1393 TIOCMBIT(UART01x_FR_DCD, TIOCM_CAR);
1394 TIOCMBIT(UART01x_FR_DSR, TIOCM_DSR);
1395 TIOCMBIT(UART01x_FR_CTS, TIOCM_CTS);
1396 TIOCMBIT(UART011_FR_RI, TIOCM_RNG);
1397#undef TIOCMBIT
1da177e4
LT
1398 return result;
1399}
1400
1401static void pl011_set_mctrl(struct uart_port *port, unsigned int mctrl)
1402{
a5820c24
DT
1403 struct uart_amba_port *uap =
1404 container_of(port, struct uart_amba_port, port);
1da177e4
LT
1405 unsigned int cr;
1406
1407 cr = readw(uap->port.membase + UART011_CR);
1408
5159f407 1409#define TIOCMBIT(tiocmbit, uartbit) \
1da177e4
LT
1410 if (mctrl & tiocmbit) \
1411 cr |= uartbit; \
1412 else \
1413 cr &= ~uartbit
1414
5159f407
JS
1415 TIOCMBIT(TIOCM_RTS, UART011_CR_RTS);
1416 TIOCMBIT(TIOCM_DTR, UART011_CR_DTR);
1417 TIOCMBIT(TIOCM_OUT1, UART011_CR_OUT1);
1418 TIOCMBIT(TIOCM_OUT2, UART011_CR_OUT2);
1419 TIOCMBIT(TIOCM_LOOP, UART011_CR_LBE);
3b43816f
RV
1420
1421 if (uap->autorts) {
1422 /* We need to disable auto-RTS if we want to turn RTS off */
1423 TIOCMBIT(TIOCM_RTS, UART011_CR_RTSEN);
1424 }
5159f407 1425#undef TIOCMBIT
1da177e4
LT
1426
1427 writew(cr, uap->port.membase + UART011_CR);
1428}
1429
1430static void pl011_break_ctl(struct uart_port *port, int break_state)
1431{
a5820c24
DT
1432 struct uart_amba_port *uap =
1433 container_of(port, struct uart_amba_port, port);
1da177e4
LT
1434 unsigned long flags;
1435 unsigned int lcr_h;
1436
1437 spin_lock_irqsave(&uap->port.lock, flags);
ec489aa8 1438 lcr_h = readw(uap->port.membase + uap->lcrh_tx);
1da177e4
LT
1439 if (break_state == -1)
1440 lcr_h |= UART01x_LCRH_BRK;
1441 else
1442 lcr_h &= ~UART01x_LCRH_BRK;
ec489aa8 1443 writew(lcr_h, uap->port.membase + uap->lcrh_tx);
1da177e4
LT
1444 spin_unlock_irqrestore(&uap->port.lock, flags);
1445}
1446
84b5ae15 1447#ifdef CONFIG_CONSOLE_POLL
5c8124a0
AV
1448
1449static void pl011_quiesce_irqs(struct uart_port *port)
1450{
a5820c24
DT
1451 struct uart_amba_port *uap =
1452 container_of(port, struct uart_amba_port, port);
5c8124a0
AV
1453 unsigned char __iomem *regs = uap->port.membase;
1454
1455 writew(readw(regs + UART011_MIS), regs + UART011_ICR);
1456 /*
1457 * There is no way to clear TXIM as this is "ready to transmit IRQ", so
1458 * we simply mask it. start_tx() will unmask it.
1459 *
1460 * Note we can race with start_tx(), and if the race happens, the
1461 * polling user might get another interrupt just after we clear it.
1462 * But it should be OK and can happen even w/o the race, e.g.
1463 * controller immediately got some new data and raised the IRQ.
1464 *
1465 * And whoever uses polling routines assumes that it manages the device
1466 * (including tx queue), so we're also fine with start_tx()'s caller
1467 * side.
1468 */
1469 writew(readw(regs + UART011_IMSC) & ~UART011_TXIM, regs + UART011_IMSC);
1470}
1471
e643f87f 1472static int pl011_get_poll_char(struct uart_port *port)
84b5ae15 1473{
a5820c24
DT
1474 struct uart_amba_port *uap =
1475 container_of(port, struct uart_amba_port, port);
84b5ae15
JW
1476 unsigned int status;
1477
5c8124a0
AV
1478 /*
1479 * The caller might need IRQs lowered, e.g. if used with KDB NMI
1480 * debugger.
1481 */
1482 pl011_quiesce_irqs(port);
1483
f5316b4a
JW
1484 status = readw(uap->port.membase + UART01x_FR);
1485 if (status & UART01x_FR_RXFE)
1486 return NO_POLL_CHAR;
84b5ae15
JW
1487
1488 return readw(uap->port.membase + UART01x_DR);
1489}
1490
e643f87f 1491static void pl011_put_poll_char(struct uart_port *port,
84b5ae15
JW
1492 unsigned char ch)
1493{
a5820c24
DT
1494 struct uart_amba_port *uap =
1495 container_of(port, struct uart_amba_port, port);
84b5ae15
JW
1496
1497 while (readw(uap->port.membase + UART01x_FR) & UART01x_FR_TXFF)
1498 barrier();
1499
1500 writew(ch, uap->port.membase + UART01x_DR);
1501}
1502
1503#endif /* CONFIG_CONSOLE_POLL */
1504
b3564c2c 1505static int pl011_hwinit(struct uart_port *port)
1da177e4 1506{
a5820c24
DT
1507 struct uart_amba_port *uap =
1508 container_of(port, struct uart_amba_port, port);
1da177e4
LT
1509 int retval;
1510
78d80c5a 1511 /* Optionaly enable pins to be muxed in and configured */
2b996fc5 1512 pinctrl_pm_select_default_state(port->dev);
78d80c5a 1513
1da177e4
LT
1514 /*
1515 * Try to enable the clock producer.
1516 */
1c4c4394 1517 retval = clk_prepare_enable(uap->clk);
1da177e4 1518 if (retval)
7f6d942a 1519 return retval;
1da177e4
LT
1520
1521 uap->port.uartclk = clk_get_rate(uap->clk);
1522
9b96fbac
LW
1523 /* Clear pending error and receive interrupts */
1524 writew(UART011_OEIS | UART011_BEIS | UART011_PEIS | UART011_FEIS |
1525 UART011_RTIS | UART011_RXIS, uap->port.membase + UART011_ICR);
1526
b3564c2c
AV
1527 /*
1528 * Save interrupts enable mask, and enable RX interrupts in case if
1529 * the interrupt is used for NMI entry.
1530 */
1531 uap->im = readw(uap->port.membase + UART011_IMSC);
1532 writew(UART011_RTIM | UART011_RXIM, uap->port.membase + UART011_IMSC);
1533
574de559 1534 if (dev_get_platdata(uap->port.dev)) {
b3564c2c
AV
1535 struct amba_pl011_data *plat;
1536
574de559 1537 plat = dev_get_platdata(uap->port.dev);
b3564c2c
AV
1538 if (plat->init)
1539 plat->init();
1540 }
1541 return 0;
b3564c2c
AV
1542}
1543
b60f2f66
JM
1544static void pl011_write_lcr_h(struct uart_amba_port *uap, unsigned int lcr_h)
1545{
1546 writew(lcr_h, uap->port.membase + uap->lcrh_rx);
1547 if (uap->lcrh_rx != uap->lcrh_tx) {
1548 int i;
1549 /*
1550 * Wait 10 PCLKs before writing LCRH_TX register,
1551 * to get this delay write read only register 10 times
1552 */
1553 for (i = 0; i < 10; ++i)
1554 writew(0xff, uap->port.membase + UART011_MIS);
1555 writew(lcr_h, uap->port.membase + uap->lcrh_tx);
1556 }
1557}
1558
b3564c2c
AV
1559static int pl011_startup(struct uart_port *port)
1560{
a5820c24
DT
1561 struct uart_amba_port *uap =
1562 container_of(port, struct uart_amba_port, port);
734745ca 1563 unsigned int cr;
b3564c2c
AV
1564 int retval;
1565
1566 retval = pl011_hwinit(port);
1567 if (retval)
1568 goto clk_dis;
1569
1570 writew(uap->im, uap->port.membase + UART011_IMSC);
1571
1da177e4
LT
1572 /*
1573 * Allocate the IRQ
1574 */
1575 retval = request_irq(uap->port.irq, pl011_int, 0, "uart-pl011", uap);
1576 if (retval)
1577 goto clk_dis;
1578
c19f12b5 1579 writew(uap->vendor->ifls, uap->port.membase + UART011_IFLS);
1da177e4 1580
734745ca 1581 spin_lock_irq(&uap->port.lock);
570d2910 1582
d8d8ffa4
SKS
1583 /* restore RTS and DTR */
1584 cr = uap->old_cr & (UART011_CR_RTS | UART011_CR_DTR);
1585 cr |= UART01x_CR_UARTEN | UART011_CR_RXE | UART011_CR_TXE;
1da177e4
LT
1586 writew(cr, uap->port.membase + UART011_CR);
1587
fe433907
JM
1588 spin_unlock_irq(&uap->port.lock);
1589
1da177e4
LT
1590 /*
1591 * initialise the old status of the modem signals
1592 */
1593 uap->old_status = readw(uap->port.membase + UART01x_FR) & UART01x_FR_MODEM_ANY;
1594
68b65f73
RK
1595 /* Startup DMA */
1596 pl011_dma_startup(uap);
1597
1da177e4 1598 /*
ead76f32
LW
1599 * Finally, enable interrupts, only timeouts when using DMA
1600 * if initial RX DMA job failed, start in interrupt mode
1601 * as well.
1da177e4
LT
1602 */
1603 spin_lock_irq(&uap->port.lock);
9b96fbac
LW
1604 /* Clear out any spuriously appearing RX interrupts */
1605 writew(UART011_RTIS | UART011_RXIS,
1606 uap->port.membase + UART011_ICR);
ead76f32
LW
1607 uap->im = UART011_RTIM;
1608 if (!pl011_dma_rx_running(uap))
1609 uap->im |= UART011_RXIM;
1da177e4
LT
1610 writew(uap->im, uap->port.membase + UART011_IMSC);
1611 spin_unlock_irq(&uap->port.lock);
1612
1613 return 0;
1614
1615 clk_dis:
1c4c4394 1616 clk_disable_unprepare(uap->clk);
1da177e4
LT
1617 return retval;
1618}
1619
ec489aa8
LW
1620static void pl011_shutdown_channel(struct uart_amba_port *uap,
1621 unsigned int lcrh)
1622{
1623 unsigned long val;
1624
1625 val = readw(uap->port.membase + lcrh);
1626 val &= ~(UART01x_LCRH_BRK | UART01x_LCRH_FEN);
1627 writew(val, uap->port.membase + lcrh);
1628}
1629
1da177e4
LT
1630static void pl011_shutdown(struct uart_port *port)
1631{
a5820c24
DT
1632 struct uart_amba_port *uap =
1633 container_of(port, struct uart_amba_port, port);
d8d8ffa4 1634 unsigned int cr;
1da177e4
LT
1635
1636 /*
1637 * disable all interrupts
1638 */
1639 spin_lock_irq(&uap->port.lock);
1640 uap->im = 0;
1641 writew(uap->im, uap->port.membase + UART011_IMSC);
f28c1d0a 1642 writew(0xffff, uap->port.membase + UART011_ICR);
1da177e4
LT
1643 spin_unlock_irq(&uap->port.lock);
1644
68b65f73
RK
1645 pl011_dma_shutdown(uap);
1646
1da177e4
LT
1647 /*
1648 * Free the interrupt
1649 */
1650 free_irq(uap->port.irq, uap);
1651
1652 /*
1653 * disable the port
d8d8ffa4
SKS
1654 * disable the port. It should not disable RTS and DTR.
1655 * Also RTS and DTR state should be preserved to restore
1656 * it during startup().
1da177e4 1657 */
3b43816f 1658 uap->autorts = false;
fe433907 1659 spin_lock_irq(&uap->port.lock);
d8d8ffa4
SKS
1660 cr = readw(uap->port.membase + UART011_CR);
1661 uap->old_cr = cr;
1662 cr &= UART011_CR_RTS | UART011_CR_DTR;
1663 cr |= UART01x_CR_UARTEN | UART011_CR_TXE;
1664 writew(cr, uap->port.membase + UART011_CR);
fe433907 1665 spin_unlock_irq(&uap->port.lock);
1da177e4
LT
1666
1667 /*
1668 * disable break condition and fifos
1669 */
ec489aa8
LW
1670 pl011_shutdown_channel(uap, uap->lcrh_rx);
1671 if (uap->lcrh_rx != uap->lcrh_tx)
1672 pl011_shutdown_channel(uap, uap->lcrh_tx);
1da177e4
LT
1673
1674 /*
1675 * Shut down the clock producer
1676 */
1c4c4394 1677 clk_disable_unprepare(uap->clk);
78d80c5a 1678 /* Optionally let pins go into sleep states */
2b996fc5 1679 pinctrl_pm_select_sleep_state(port->dev);
c16d51a3 1680
574de559 1681 if (dev_get_platdata(uap->port.dev)) {
c16d51a3
SKS
1682 struct amba_pl011_data *plat;
1683
574de559 1684 plat = dev_get_platdata(uap->port.dev);
c16d51a3
SKS
1685 if (plat->exit)
1686 plat->exit();
1687 }
1688
36f339d1
PH
1689 if (uap->port.ops->flush_buffer)
1690 uap->port.ops->flush_buffer(port);
1da177e4
LT
1691}
1692
1693static void
606d099c
AC
1694pl011_set_termios(struct uart_port *port, struct ktermios *termios,
1695 struct ktermios *old)
1da177e4 1696{
a5820c24
DT
1697 struct uart_amba_port *uap =
1698 container_of(port, struct uart_amba_port, port);
1da177e4
LT
1699 unsigned int lcr_h, old_cr;
1700 unsigned long flags;
c19f12b5
RK
1701 unsigned int baud, quot, clkdiv;
1702
1703 if (uap->vendor->oversampling)
1704 clkdiv = 8;
1705 else
1706 clkdiv = 16;
1da177e4
LT
1707
1708 /*
1709 * Ask the core to calculate the divisor for us.
1710 */
ac3e3fb4 1711 baud = uart_get_baud_rate(port, termios, old, 0,
c19f12b5 1712 port->uartclk / clkdiv);
89fa28db 1713#ifdef CONFIG_DMA_ENGINE
cb06ff10
CM
1714 /*
1715 * Adjust RX DMA polling rate with baud rate if not specified.
1716 */
1717 if (uap->dmarx.auto_poll_rate)
1718 uap->dmarx.poll_rate = DIV_ROUND_UP(10000000, baud);
89fa28db 1719#endif
ac3e3fb4
LW
1720
1721 if (baud > port->uartclk/16)
1722 quot = DIV_ROUND_CLOSEST(port->uartclk * 8, baud);
1723 else
1724 quot = DIV_ROUND_CLOSEST(port->uartclk * 4, baud);
1da177e4
LT
1725
1726 switch (termios->c_cflag & CSIZE) {
1727 case CS5:
1728 lcr_h = UART01x_LCRH_WLEN_5;
1729 break;
1730 case CS6:
1731 lcr_h = UART01x_LCRH_WLEN_6;
1732 break;
1733 case CS7:
1734 lcr_h = UART01x_LCRH_WLEN_7;
1735 break;
1736 default: // CS8
1737 lcr_h = UART01x_LCRH_WLEN_8;
1738 break;
1739 }
1740 if (termios->c_cflag & CSTOPB)
1741 lcr_h |= UART01x_LCRH_STP2;
1742 if (termios->c_cflag & PARENB) {
1743 lcr_h |= UART01x_LCRH_PEN;
1744 if (!(termios->c_cflag & PARODD))
1745 lcr_h |= UART01x_LCRH_EPS;
1746 }
ffca2b11 1747 if (uap->fifosize > 1)
1da177e4
LT
1748 lcr_h |= UART01x_LCRH_FEN;
1749
1750 spin_lock_irqsave(&port->lock, flags);
1751
1752 /*
1753 * Update the per-port timeout.
1754 */
1755 uart_update_timeout(port, termios->c_cflag, baud);
1756
b63d4f0f 1757 port->read_status_mask = UART011_DR_OE | 255;
1da177e4 1758 if (termios->c_iflag & INPCK)
b63d4f0f 1759 port->read_status_mask |= UART011_DR_FE | UART011_DR_PE;
ef8b9ddc 1760 if (termios->c_iflag & (IGNBRK | BRKINT | PARMRK))
b63d4f0f 1761 port->read_status_mask |= UART011_DR_BE;
1da177e4
LT
1762
1763 /*
1764 * Characters to ignore
1765 */
1766 port->ignore_status_mask = 0;
1767 if (termios->c_iflag & IGNPAR)
b63d4f0f 1768 port->ignore_status_mask |= UART011_DR_FE | UART011_DR_PE;
1da177e4 1769 if (termios->c_iflag & IGNBRK) {
b63d4f0f 1770 port->ignore_status_mask |= UART011_DR_BE;
1da177e4
LT
1771 /*
1772 * If we're ignoring parity and break indicators,
1773 * ignore overruns too (for real raw support).
1774 */
1775 if (termios->c_iflag & IGNPAR)
b63d4f0f 1776 port->ignore_status_mask |= UART011_DR_OE;
1da177e4
LT
1777 }
1778
1779 /*
1780 * Ignore all characters if CREAD is not set.
1781 */
1782 if ((termios->c_cflag & CREAD) == 0)
b63d4f0f 1783 port->ignore_status_mask |= UART_DUMMY_DR_RX;
1da177e4
LT
1784
1785 if (UART_ENABLE_MS(port, termios->c_cflag))
1786 pl011_enable_ms(port);
1787
1788 /* first, disable everything */
1789 old_cr = readw(port->membase + UART011_CR);
1790 writew(0, port->membase + UART011_CR);
1791
3b43816f
RV
1792 if (termios->c_cflag & CRTSCTS) {
1793 if (old_cr & UART011_CR_RTS)
1794 old_cr |= UART011_CR_RTSEN;
1795
1796 old_cr |= UART011_CR_CTSEN;
1797 uap->autorts = true;
1798 } else {
1799 old_cr &= ~(UART011_CR_CTSEN | UART011_CR_RTSEN);
1800 uap->autorts = false;
1801 }
1802
c19f12b5
RK
1803 if (uap->vendor->oversampling) {
1804 if (baud > port->uartclk / 16)
ac3e3fb4
LW
1805 old_cr |= ST_UART011_CR_OVSFACT;
1806 else
1807 old_cr &= ~ST_UART011_CR_OVSFACT;
1808 }
1809
c5dd553b
LW
1810 /*
1811 * Workaround for the ST Micro oversampling variants to
1812 * increase the bitrate slightly, by lowering the divisor,
1813 * to avoid delayed sampling of start bit at high speeds,
1814 * else we see data corruption.
1815 */
1816 if (uap->vendor->oversampling) {
1817 if ((baud >= 3000000) && (baud < 3250000) && (quot > 1))
1818 quot -= 1;
1819 else if ((baud > 3250000) && (quot > 2))
1820 quot -= 2;
1821 }
1da177e4
LT
1822 /* Set baud rate */
1823 writew(quot & 0x3f, port->membase + UART011_FBRD);
1824 writew(quot >> 6, port->membase + UART011_IBRD);
1825
1826 /*
1827 * ----------v----------v----------v----------v-----
c5dd553b
LW
1828 * NOTE: lcrh_tx and lcrh_rx MUST BE WRITTEN AFTER
1829 * UART011_FBRD & UART011_IBRD.
1da177e4
LT
1830 * ----------^----------^----------^----------^-----
1831 */
b60f2f66 1832 pl011_write_lcr_h(uap, lcr_h);
1da177e4
LT
1833 writew(old_cr, port->membase + UART011_CR);
1834
1835 spin_unlock_irqrestore(&port->lock, flags);
1836}
1837
1838static const char *pl011_type(struct uart_port *port)
1839{
a5820c24
DT
1840 struct uart_amba_port *uap =
1841 container_of(port, struct uart_amba_port, port);
e8a7ba86 1842 return uap->port.type == PORT_AMBA ? uap->type : NULL;
1da177e4
LT
1843}
1844
1845/*
1846 * Release the memory region(s) being used by 'port'
1847 */
e643f87f 1848static void pl011_release_port(struct uart_port *port)
1da177e4
LT
1849{
1850 release_mem_region(port->mapbase, SZ_4K);
1851}
1852
1853/*
1854 * Request the memory region(s) being used by 'port'
1855 */
e643f87f 1856static int pl011_request_port(struct uart_port *port)
1da177e4
LT
1857{
1858 return request_mem_region(port->mapbase, SZ_4K, "uart-pl011")
1859 != NULL ? 0 : -EBUSY;
1860}
1861
1862/*
1863 * Configure/autoconfigure the port.
1864 */
e643f87f 1865static void pl011_config_port(struct uart_port *port, int flags)
1da177e4
LT
1866{
1867 if (flags & UART_CONFIG_TYPE) {
1868 port->type = PORT_AMBA;
e643f87f 1869 pl011_request_port(port);
1da177e4
LT
1870 }
1871}
1872
1873/*
1874 * verify the new serial_struct (for TIOCSSERIAL).
1875 */
e643f87f 1876static int pl011_verify_port(struct uart_port *port, struct serial_struct *ser)
1da177e4
LT
1877{
1878 int ret = 0;
1879 if (ser->type != PORT_UNKNOWN && ser->type != PORT_AMBA)
1880 ret = -EINVAL;
a62c4133 1881 if (ser->irq < 0 || ser->irq >= nr_irqs)
1da177e4
LT
1882 ret = -EINVAL;
1883 if (ser->baud_base < 9600)
1884 ret = -EINVAL;
1885 return ret;
1886}
1887
1888static struct uart_ops amba_pl011_pops = {
e643f87f 1889 .tx_empty = pl011_tx_empty,
1da177e4 1890 .set_mctrl = pl011_set_mctrl,
e643f87f 1891 .get_mctrl = pl011_get_mctrl,
1da177e4
LT
1892 .stop_tx = pl011_stop_tx,
1893 .start_tx = pl011_start_tx,
1894 .stop_rx = pl011_stop_rx,
1895 .enable_ms = pl011_enable_ms,
1896 .break_ctl = pl011_break_ctl,
1897 .startup = pl011_startup,
1898 .shutdown = pl011_shutdown,
68b65f73 1899 .flush_buffer = pl011_dma_flush_buffer,
1da177e4
LT
1900 .set_termios = pl011_set_termios,
1901 .type = pl011_type,
e643f87f
LW
1902 .release_port = pl011_release_port,
1903 .request_port = pl011_request_port,
1904 .config_port = pl011_config_port,
1905 .verify_port = pl011_verify_port,
84b5ae15 1906#ifdef CONFIG_CONSOLE_POLL
b3564c2c 1907 .poll_init = pl011_hwinit,
e643f87f
LW
1908 .poll_get_char = pl011_get_poll_char,
1909 .poll_put_char = pl011_put_poll_char,
84b5ae15 1910#endif
1da177e4
LT
1911};
1912
1913static struct uart_amba_port *amba_ports[UART_NR];
1914
1915#ifdef CONFIG_SERIAL_AMBA_PL011_CONSOLE
1916
d358788f 1917static void pl011_console_putchar(struct uart_port *port, int ch)
1da177e4 1918{
a5820c24
DT
1919 struct uart_amba_port *uap =
1920 container_of(port, struct uart_amba_port, port);
1da177e4 1921
d358788f
RK
1922 while (readw(uap->port.membase + UART01x_FR) & UART01x_FR_TXFF)
1923 barrier();
1da177e4
LT
1924 writew(ch, uap->port.membase + UART01x_DR);
1925}
1926
1927static void
1928pl011_console_write(struct console *co, const char *s, unsigned int count)
1929{
1930 struct uart_amba_port *uap = amba_ports[co->index];
1931 unsigned int status, old_cr, new_cr;
ef605fdb
RV
1932 unsigned long flags;
1933 int locked = 1;
1da177e4
LT
1934
1935 clk_enable(uap->clk);
1936
ef605fdb
RV
1937 local_irq_save(flags);
1938 if (uap->port.sysrq)
1939 locked = 0;
1940 else if (oops_in_progress)
1941 locked = spin_trylock(&uap->port.lock);
1942 else
1943 spin_lock(&uap->port.lock);
1944
1da177e4
LT
1945 /*
1946 * First save the CR then disable the interrupts
1947 */
1948 old_cr = readw(uap->port.membase + UART011_CR);
1949 new_cr = old_cr & ~UART011_CR_CTSEN;
1950 new_cr |= UART01x_CR_UARTEN | UART011_CR_TXE;
1951 writew(new_cr, uap->port.membase + UART011_CR);
1952
d358788f 1953 uart_console_write(&uap->port, s, count, pl011_console_putchar);
1da177e4
LT
1954
1955 /*
1956 * Finally, wait for transmitter to become empty
1957 * and restore the TCR
1958 */
1959 do {
1960 status = readw(uap->port.membase + UART01x_FR);
1961 } while (status & UART01x_FR_BUSY);
1962 writew(old_cr, uap->port.membase + UART011_CR);
1963
ef605fdb
RV
1964 if (locked)
1965 spin_unlock(&uap->port.lock);
1966 local_irq_restore(flags);
1967
1da177e4
LT
1968 clk_disable(uap->clk);
1969}
1970
1971static void __init
1972pl011_console_get_options(struct uart_amba_port *uap, int *baud,
1973 int *parity, int *bits)
1974{
1975 if (readw(uap->port.membase + UART011_CR) & UART01x_CR_UARTEN) {
1976 unsigned int lcr_h, ibrd, fbrd;
1977
ec489aa8 1978 lcr_h = readw(uap->port.membase + uap->lcrh_tx);
1da177e4
LT
1979
1980 *parity = 'n';
1981 if (lcr_h & UART01x_LCRH_PEN) {
1982 if (lcr_h & UART01x_LCRH_EPS)
1983 *parity = 'e';
1984 else
1985 *parity = 'o';
1986 }
1987
1988 if ((lcr_h & 0x60) == UART01x_LCRH_WLEN_7)
1989 *bits = 7;
1990 else
1991 *bits = 8;
1992
1993 ibrd = readw(uap->port.membase + UART011_IBRD);
1994 fbrd = readw(uap->port.membase + UART011_FBRD);
1995
1996 *baud = uap->port.uartclk * 4 / (64 * ibrd + fbrd);
ac3e3fb4 1997
c19f12b5 1998 if (uap->vendor->oversampling) {
ac3e3fb4
LW
1999 if (readw(uap->port.membase + UART011_CR)
2000 & ST_UART011_CR_OVSFACT)
2001 *baud *= 2;
2002 }
1da177e4
LT
2003 }
2004}
2005
2006static int __init pl011_console_setup(struct console *co, char *options)
2007{
2008 struct uart_amba_port *uap;
2009 int baud = 38400;
2010 int bits = 8;
2011 int parity = 'n';
2012 int flow = 'n';
4b4851c6 2013 int ret;
1da177e4
LT
2014
2015 /*
2016 * Check whether an invalid uart number has been specified, and
2017 * if so, search for the first available port that does have
2018 * console support.
2019 */
2020 if (co->index >= UART_NR)
2021 co->index = 0;
2022 uap = amba_ports[co->index];
d28122a5
RK
2023 if (!uap)
2024 return -ENODEV;
1da177e4 2025
78d80c5a 2026 /* Allow pins to be muxed in and configured */
2b996fc5 2027 pinctrl_pm_select_default_state(uap->port.dev);
78d80c5a 2028
4b4851c6
RK
2029 ret = clk_prepare(uap->clk);
2030 if (ret)
2031 return ret;
2032
574de559 2033 if (dev_get_platdata(uap->port.dev)) {
c16d51a3
SKS
2034 struct amba_pl011_data *plat;
2035
574de559 2036 plat = dev_get_platdata(uap->port.dev);
c16d51a3
SKS
2037 if (plat->init)
2038 plat->init();
2039 }
2040
1da177e4
LT
2041 uap->port.uartclk = clk_get_rate(uap->clk);
2042
2043 if (options)
2044 uart_parse_options(options, &baud, &parity, &bits, &flow);
2045 else
2046 pl011_console_get_options(uap, &baud, &parity, &bits);
2047
2048 return uart_set_options(&uap->port, co, baud, parity, bits, flow);
2049}
2050
2d93486c 2051static struct uart_driver amba_reg;
1da177e4
LT
2052static struct console amba_console = {
2053 .name = "ttyAMA",
2054 .write = pl011_console_write,
2055 .device = uart_console_device,
2056 .setup = pl011_console_setup,
2057 .flags = CON_PRINTBUFFER,
2058 .index = -1,
2059 .data = &amba_reg,
2060};
2061
2062#define AMBA_CONSOLE (&amba_console)
0d3c673e
RH
2063
2064static void pl011_putc(struct uart_port *port, int c)
2065{
2066 while (readl(port->membase + UART01x_FR) & UART01x_FR_TXFF)
2067 ;
2068 writeb(c, port->membase + UART01x_DR);
2069 while (readl(port->membase + UART01x_FR) & UART01x_FR_BUSY)
2070 ;
2071}
2072
2073static void pl011_early_write(struct console *con, const char *s, unsigned n)
2074{
2075 struct earlycon_device *dev = con->data;
2076
2077 uart_console_write(&dev->port, s, n, pl011_putc);
2078}
2079
2080static int __init pl011_early_console_setup(struct earlycon_device *device,
2081 const char *opt)
2082{
2083 if (!device->port.membase)
2084 return -ENODEV;
2085
2086 device->con->write = pl011_early_write;
2087 return 0;
2088}
2089EARLYCON_DECLARE(pl011, pl011_early_console_setup);
45e0f0f5 2090OF_EARLYCON_DECLARE(pl011, "arm,pl011", pl011_early_console_setup);
0d3c673e 2091
1da177e4
LT
2092#else
2093#define AMBA_CONSOLE NULL
2094#endif
2095
2096static struct uart_driver amba_reg = {
2097 .owner = THIS_MODULE,
2098 .driver_name = "ttyAMA",
2099 .dev_name = "ttyAMA",
2100 .major = SERIAL_AMBA_MAJOR,
2101 .minor = SERIAL_AMBA_MINOR,
2102 .nr = UART_NR,
2103 .cons = AMBA_CONSOLE,
2104};
2105
32614aad
ML
2106static int pl011_probe_dt_alias(int index, struct device *dev)
2107{
2108 struct device_node *np;
2109 static bool seen_dev_with_alias = false;
2110 static bool seen_dev_without_alias = false;
2111 int ret = index;
2112
2113 if (!IS_ENABLED(CONFIG_OF))
2114 return ret;
2115
2116 np = dev->of_node;
2117 if (!np)
2118 return ret;
2119
2120 ret = of_alias_get_id(np, "serial");
2121 if (IS_ERR_VALUE(ret)) {
2122 seen_dev_without_alias = true;
2123 ret = index;
2124 } else {
2125 seen_dev_with_alias = true;
2126 if (ret >= ARRAY_SIZE(amba_ports) || amba_ports[ret] != NULL) {
2127 dev_warn(dev, "requested serial port %d not available.\n", ret);
2128 ret = index;
2129 }
2130 }
2131
2132 if (seen_dev_with_alias && seen_dev_without_alias)
2133 dev_warn(dev, "aliased and non-aliased serial devices found in device tree. Serial port enumeration may be unpredictable.\n");
2134
2135 return ret;
2136}
2137
49bb3c86
AP
2138/* unregisters the driver also if no more ports are left */
2139static void pl011_unregister_port(struct uart_amba_port *uap)
2140{
2141 int i;
2142 bool busy = false;
2143
2144 for (i = 0; i < ARRAY_SIZE(amba_ports); i++) {
2145 if (amba_ports[i] == uap)
2146 amba_ports[i] = NULL;
2147 else if (amba_ports[i])
2148 busy = true;
2149 }
2150 pl011_dma_remove(uap);
2151 if (!busy)
2152 uart_unregister_driver(&amba_reg);
2153}
2154
aa25afad 2155static int pl011_probe(struct amba_device *dev, const struct amba_id *id)
1da177e4
LT
2156{
2157 struct uart_amba_port *uap;
5926a295 2158 struct vendor_data *vendor = id->data;
1da177e4
LT
2159 void __iomem *base;
2160 int i, ret;
2161
2162 for (i = 0; i < ARRAY_SIZE(amba_ports); i++)
2163 if (amba_ports[i] == NULL)
2164 break;
2165
7f6d942a
TB
2166 if (i == ARRAY_SIZE(amba_ports))
2167 return -EBUSY;
1da177e4 2168
de609582
LW
2169 uap = devm_kzalloc(&dev->dev, sizeof(struct uart_amba_port),
2170 GFP_KERNEL);
7f6d942a
TB
2171 if (uap == NULL)
2172 return -ENOMEM;
1da177e4 2173
32614aad
ML
2174 i = pl011_probe_dt_alias(i, &dev->dev);
2175
de609582
LW
2176 base = devm_ioremap(&dev->dev, dev->res.start,
2177 resource_size(&dev->res));
7f6d942a
TB
2178 if (!base)
2179 return -ENOMEM;
1da177e4 2180
de609582 2181 uap->clk = devm_clk_get(&dev->dev, NULL);
7f6d942a
TB
2182 if (IS_ERR(uap->clk))
2183 return PTR_ERR(uap->clk);
1da177e4 2184
c19f12b5 2185 uap->vendor = vendor;
ec489aa8
LW
2186 uap->lcrh_rx = vendor->lcrh_rx;
2187 uap->lcrh_tx = vendor->lcrh_tx;
d8d8ffa4 2188 uap->old_cr = 0;
ea33640a 2189 uap->fifosize = vendor->get_fifosize(dev);
1da177e4
LT
2190 uap->port.dev = &dev->dev;
2191 uap->port.mapbase = dev->res.start;
2192 uap->port.membase = base;
2193 uap->port.iotype = UPIO_MEM;
2194 uap->port.irq = dev->irq[0];
ffca2b11 2195 uap->port.fifosize = uap->fifosize;
1da177e4
LT
2196 uap->port.ops = &amba_pl011_pops;
2197 uap->port.flags = UPF_BOOT_AUTOCONF;
2198 uap->port.line = i;
2199
c3d8b76f
LW
2200 /* Ensure interrupts from this UART are masked and cleared */
2201 writew(0, uap->port.membase + UART011_IMSC);
2202 writew(0xffff, uap->port.membase + UART011_ICR);
2203
e8a7ba86
RK
2204 snprintf(uap->type, sizeof(uap->type), "PL011 rev%u", amba_rev(dev));
2205
1da177e4
LT
2206 amba_ports[i] = uap;
2207
2208 amba_set_drvdata(dev, uap);
ef2889f7
TB
2209
2210 if (!amba_reg.state) {
2211 ret = uart_register_driver(&amba_reg);
2212 if (ret < 0) {
1c9be310
JRO
2213 dev_err(&dev->dev,
2214 "Failed to register AMBA-PL011 driver\n");
ef2889f7
TB
2215 return ret;
2216 }
2217 }
2218
1da177e4 2219 ret = uart_add_one_port(&amba_reg, &uap->port);
49bb3c86
AP
2220 if (ret)
2221 pl011_unregister_port(uap);
7f6d942a 2222
1da177e4
LT
2223 return ret;
2224}
2225
2226static int pl011_remove(struct amba_device *dev)
2227{
2228 struct uart_amba_port *uap = amba_get_drvdata(dev);
1da177e4 2229
1da177e4 2230 uart_remove_one_port(&amba_reg, &uap->port);
49bb3c86 2231 pl011_unregister_port(uap);
1da177e4
LT
2232 return 0;
2233}
2234
d0ce850d
UH
2235#ifdef CONFIG_PM_SLEEP
2236static int pl011_suspend(struct device *dev)
b736b89f 2237{
d0ce850d 2238 struct uart_amba_port *uap = dev_get_drvdata(dev);
b736b89f
LC
2239
2240 if (!uap)
2241 return -EINVAL;
2242
2243 return uart_suspend_port(&amba_reg, &uap->port);
2244}
2245
d0ce850d 2246static int pl011_resume(struct device *dev)
b736b89f 2247{
d0ce850d 2248 struct uart_amba_port *uap = dev_get_drvdata(dev);
b736b89f
LC
2249
2250 if (!uap)
2251 return -EINVAL;
2252
2253 return uart_resume_port(&amba_reg, &uap->port);
2254}
2255#endif
2256
d0ce850d
UH
2257static SIMPLE_DEV_PM_OPS(pl011_dev_pm_ops, pl011_suspend, pl011_resume);
2258
2c39c9e1 2259static struct amba_id pl011_ids[] = {
1da177e4
LT
2260 {
2261 .id = 0x00041011,
2262 .mask = 0x000fffff,
5926a295
AR
2263 .data = &vendor_arm,
2264 },
2265 {
2266 .id = 0x00380802,
2267 .mask = 0x00ffffff,
2268 .data = &vendor_st,
1da177e4
LT
2269 },
2270 { 0, 0 },
2271};
2272
60f7a33b
DM
2273MODULE_DEVICE_TABLE(amba, pl011_ids);
2274
1da177e4
LT
2275static struct amba_driver pl011_driver = {
2276 .drv = {
2277 .name = "uart-pl011",
d0ce850d 2278 .pm = &pl011_dev_pm_ops,
1da177e4
LT
2279 },
2280 .id_table = pl011_ids,
2281 .probe = pl011_probe,
2282 .remove = pl011_remove,
2283};
2284
2285static int __init pl011_init(void)
2286{
1da177e4
LT
2287 printk(KERN_INFO "Serial: AMBA PL011 UART driver\n");
2288
ef2889f7 2289 return amba_driver_register(&pl011_driver);
1da177e4
LT
2290}
2291
2292static void __exit pl011_exit(void)
2293{
2294 amba_driver_unregister(&pl011_driver);
1da177e4
LT
2295}
2296
4dd9e742
AR
2297/*
2298 * While this can be a module, if builtin it's most likely the console
2299 * So let's leave module_exit but move module_init to an earlier place
2300 */
2301arch_initcall(pl011_init);
1da177e4
LT
2302module_exit(pl011_exit);
2303
2304MODULE_AUTHOR("ARM Ltd/Deep Blue Solutions Ltd");
2305MODULE_DESCRIPTION("ARM AMBA serial port driver");
2306MODULE_LICENSE("GPL");