1 // SPDX-License-Identifier: GPL-2.0+
3 * Driver for Motorola/Freescale IMX serial ports
5 * Based on drivers/char/serial.c, by Linus Torvalds, Theodore Ts'o.
8 * Copyright (C) 2004 Pengutronix
11 #include <linux/module.h>
12 #include <linux/ioport.h>
13 #include <linux/init.h>
14 #include <linux/console.h>
15 #include <linux/sysrq.h>
16 #include <linux/platform_device.h>
17 #include <linux/tty.h>
18 #include <linux/tty_flip.h>
19 #include <linux/serial_core.h>
20 #include <linux/serial.h>
21 #include <linux/clk.h>
22 #include <linux/delay.h>
23 #include <linux/ktime.h>
24 #include <linux/pinctrl/consumer.h>
25 #include <linux/rational.h>
26 #include <linux/slab.h>
28 #include <linux/of_device.h>
30 #include <linux/dma-mapping.h>
33 #include <linux/platform_data/serial-imx.h>
34 #include <linux/platform_data/dma-imx.h>
36 #include "serial_mctrl_gpio.h"
38 /* Register definitions */
39 #define URXD0 0x0 /* Receiver Register */
40 #define URTX0 0x40 /* Transmitter Register */
41 #define UCR1 0x80 /* Control Register 1 */
42 #define UCR2 0x84 /* Control Register 2 */
43 #define UCR3 0x88 /* Control Register 3 */
44 #define UCR4 0x8c /* Control Register 4 */
45 #define UFCR 0x90 /* FIFO Control Register */
46 #define USR1 0x94 /* Status Register 1 */
47 #define USR2 0x98 /* Status Register 2 */
48 #define UESC 0x9c /* Escape Character Register */
49 #define UTIM 0xa0 /* Escape Timer Register */
50 #define UBIR 0xa4 /* BRM Incremental Register */
51 #define UBMR 0xa8 /* BRM Modulator Register */
52 #define UBRC 0xac /* Baud Rate Count Register */
53 #define IMX21_ONEMS 0xb0 /* One Millisecond register */
54 #define IMX1_UTS 0xd0 /* UART Test Register on i.mx1 */
55 #define IMX21_UTS 0xb4 /* UART Test Register on all other i.mx*/
57 /* UART Control Register Bit Fields.*/
58 #define URXD_DUMMY_READ (1<<16)
59 #define URXD_CHARRDY (1<<15)
60 #define URXD_ERR (1<<14)
61 #define URXD_OVRRUN (1<<13)
62 #define URXD_FRMERR (1<<12)
63 #define URXD_BRK (1<<11)
64 #define URXD_PRERR (1<<10)
65 #define URXD_RX_DATA (0xFF<<0)
66 #define UCR1_ADEN (1<<15) /* Auto detect interrupt */
67 #define UCR1_ADBR (1<<14) /* Auto detect baud rate */
68 #define UCR1_TRDYEN (1<<13) /* Transmitter ready interrupt enable */
69 #define UCR1_IDEN (1<<12) /* Idle condition interrupt */
70 #define UCR1_ICD_REG(x) (((x) & 3) << 10) /* idle condition detect */
71 #define UCR1_RRDYEN (1<<9) /* Recv ready interrupt enable */
72 #define UCR1_RXDMAEN (1<<8) /* Recv ready DMA enable */
73 #define UCR1_IREN (1<<7) /* Infrared interface enable */
74 #define UCR1_TXMPTYEN (1<<6) /* Transimitter empty interrupt enable */
75 #define UCR1_RTSDEN (1<<5) /* RTS delta interrupt enable */
76 #define UCR1_SNDBRK (1<<4) /* Send break */
77 #define UCR1_TXDMAEN (1<<3) /* Transmitter ready DMA enable */
78 #define IMX1_UCR1_UARTCLKEN (1<<2) /* UART clock enabled, i.mx1 only */
79 #define UCR1_ATDMAEN (1<<2) /* Aging DMA Timer Enable */
80 #define UCR1_DOZE (1<<1) /* Doze */
81 #define UCR1_UARTEN (1<<0) /* UART enabled */
82 #define UCR2_ESCI (1<<15) /* Escape seq interrupt enable */
83 #define UCR2_IRTS (1<<14) /* Ignore RTS pin */
84 #define UCR2_CTSC (1<<13) /* CTS pin control */
85 #define UCR2_CTS (1<<12) /* Clear to send */
86 #define UCR2_ESCEN (1<<11) /* Escape enable */
87 #define UCR2_PREN (1<<8) /* Parity enable */
88 #define UCR2_PROE (1<<7) /* Parity odd/even */
89 #define UCR2_STPB (1<<6) /* Stop */
90 #define UCR2_WS (1<<5) /* Word size */
91 #define UCR2_RTSEN (1<<4) /* Request to send interrupt enable */
92 #define UCR2_ATEN (1<<3) /* Aging Timer Enable */
93 #define UCR2_TXEN (1<<2) /* Transmitter enabled */
94 #define UCR2_RXEN (1<<1) /* Receiver enabled */
95 #define UCR2_SRST (1<<0) /* SW reset */
96 #define UCR3_DTREN (1<<13) /* DTR interrupt enable */
97 #define UCR3_PARERREN (1<<12) /* Parity enable */
98 #define UCR3_FRAERREN (1<<11) /* Frame error interrupt enable */
99 #define UCR3_DSR (1<<10) /* Data set ready */
100 #define UCR3_DCD (1<<9) /* Data carrier detect */
101 #define UCR3_RI (1<<8) /* Ring indicator */
102 #define UCR3_ADNIMP (1<<7) /* Autobaud Detection Not Improved */
103 #define UCR3_RXDSEN (1<<6) /* Receive status interrupt enable */
104 #define UCR3_AIRINTEN (1<<5) /* Async IR wake interrupt enable */
105 #define UCR3_AWAKEN (1<<4) /* Async wake interrupt enable */
106 #define UCR3_DTRDEN (1<<3) /* Data Terminal Ready Delta Enable. */
107 #define IMX21_UCR3_RXDMUXSEL (1<<2) /* RXD Muxed Input Select */
108 #define UCR3_INVT (1<<1) /* Inverted Infrared transmission */
109 #define UCR3_BPEN (1<<0) /* Preset registers enable */
110 #define UCR4_CTSTL_SHF 10 /* CTS trigger level shift */
111 #define UCR4_CTSTL_MASK 0x3F /* CTS trigger is 6 bits wide */
112 #define UCR4_INVR (1<<9) /* Inverted infrared reception */
113 #define UCR4_ENIRI (1<<8) /* Serial infrared interrupt enable */
114 #define UCR4_WKEN (1<<7) /* Wake interrupt enable */
115 #define UCR4_REF16 (1<<6) /* Ref freq 16 MHz */
116 #define UCR4_IDDMAEN (1<<6) /* DMA IDLE Condition Detected */
117 #define UCR4_IRSC (1<<5) /* IR special case */
118 #define UCR4_TCEN (1<<3) /* Transmit complete interrupt enable */
119 #define UCR4_BKEN (1<<2) /* Break condition interrupt enable */
120 #define UCR4_OREN (1<<1) /* Receiver overrun interrupt enable */
121 #define UCR4_DREN (1<<0) /* Recv data ready interrupt enable */
122 #define UFCR_RXTL_SHF 0 /* Receiver trigger level shift */
123 #define UFCR_DCEDTE (1<<6) /* DCE/DTE mode select */
124 #define UFCR_RFDIV (7<<7) /* Reference freq divider mask */
125 #define UFCR_RFDIV_REG(x) (((x) < 7 ? 6 - (x) : 6) << 7)
126 #define UFCR_TXTL_SHF 10 /* Transmitter trigger level shift */
127 #define USR1_PARITYERR (1<<15) /* Parity error interrupt flag */
128 #define USR1_RTSS (1<<14) /* RTS pin status */
129 #define USR1_TRDY (1<<13) /* Transmitter ready interrupt/dma flag */
130 #define USR1_RTSD (1<<12) /* RTS delta */
131 #define USR1_ESCF (1<<11) /* Escape seq interrupt flag */
132 #define USR1_FRAMERR (1<<10) /* Frame error interrupt flag */
133 #define USR1_RRDY (1<<9) /* Receiver ready interrupt/dma flag */
134 #define USR1_AGTIM (1<<8) /* Ageing timer interrupt flag */
135 #define USR1_DTRD (1<<7) /* DTR Delta */
136 #define USR1_RXDS (1<<6) /* Receiver idle interrupt flag */
137 #define USR1_AIRINT (1<<5) /* Async IR wake interrupt flag */
138 #define USR1_AWAKE (1<<4) /* Aysnc wake interrupt flag */
139 #define USR2_ADET (1<<15) /* Auto baud rate detect complete */
140 #define USR2_TXFE (1<<14) /* Transmit buffer FIFO empty */
141 #define USR2_DTRF (1<<13) /* DTR edge interrupt flag */
142 #define USR2_IDLE (1<<12) /* Idle condition */
143 #define USR2_RIDELT (1<<10) /* Ring Interrupt Delta */
144 #define USR2_RIIN (1<<9) /* Ring Indicator Input */
145 #define USR2_IRINT (1<<8) /* Serial infrared interrupt flag */
146 #define USR2_WAKE (1<<7) /* Wake */
147 #define USR2_DCDIN (1<<5) /* Data Carrier Detect Input */
148 #define USR2_RTSF (1<<4) /* RTS edge interrupt flag */
149 #define USR2_TXDC (1<<3) /* Transmitter complete */
150 #define USR2_BRCD (1<<2) /* Break condition */
151 #define USR2_ORE (1<<1) /* Overrun error */
152 #define USR2_RDR (1<<0) /* Recv data ready */
153 #define UTS_FRCPERR (1<<13) /* Force parity error */
154 #define UTS_LOOP (1<<12) /* Loop tx and rx */
155 #define UTS_TXEMPTY (1<<6) /* TxFIFO empty */
156 #define UTS_RXEMPTY (1<<5) /* RxFIFO empty */
157 #define UTS_TXFULL (1<<4) /* TxFIFO full */
158 #define UTS_RXFULL (1<<3) /* RxFIFO full */
159 #define UTS_SOFTRST (1<<0) /* Software reset */
161 /* We've been assigned a range on the "Low-density serial ports" major */
162 #define SERIAL_IMX_MAJOR 207
163 #define MINOR_START 16
164 #define DEV_NAME "ttymxc"
167 * This determines how often we check the modem status signals
168 * for any change. They generally aren't connected to an IRQ
169 * so we have to poll them. We also check immediately before
170 * filling the TX fifo incase CTS has been dropped.
172 #define MCTRL_TIMEOUT (250*HZ/1000)
174 #define DRIVER_NAME "IMX-uart"
178 /* i.MX21 type uart runs on all i.mx except i.MX1 and i.MX6q */
186 /* device type dependent stuff */
187 struct imx_uart_data {
189 enum imx_uart_type devtype;
200 struct uart_port port;
201 struct timer_list timer;
202 unsigned int old_status;
203 unsigned int have_rtscts:1;
204 unsigned int have_rtsgpio:1;
205 unsigned int dte_mode:1;
206 unsigned int inverted_tx:1;
207 unsigned int inverted_rx:1;
210 const struct imx_uart_data *devdata;
212 struct mctrl_gpios *gpios;
214 /* shadow registers */
222 unsigned int dma_is_enabled:1;
223 unsigned int dma_is_rxing:1;
224 unsigned int dma_is_txing:1;
225 struct dma_chan *dma_chan_rx, *dma_chan_tx;
226 struct scatterlist rx_sgl, tx_sgl[2];
228 struct circ_buf rx_ring;
229 unsigned int rx_periods;
230 dma_cookie_t rx_cookie;
231 unsigned int tx_bytes;
232 unsigned int dma_tx_nents;
233 unsigned int saved_reg[10];
236 enum imx_tx_state tx_state;
237 struct hrtimer trigger_start_tx;
238 struct hrtimer trigger_stop_tx;
241 struct imx_port_ucrs {
247 static struct imx_uart_data imx_uart_devdata[] = {
250 .devtype = IMX1_UART,
253 .uts_reg = IMX21_UTS,
254 .devtype = IMX21_UART,
257 .uts_reg = IMX21_UTS,
258 .devtype = IMX53_UART,
261 .uts_reg = IMX21_UTS,
262 .devtype = IMX6Q_UART,
266 static const struct platform_device_id imx_uart_devtype[] = {
269 .driver_data = (kernel_ulong_t) &imx_uart_devdata[IMX1_UART],
271 .name = "imx21-uart",
272 .driver_data = (kernel_ulong_t) &imx_uart_devdata[IMX21_UART],
274 .name = "imx53-uart",
275 .driver_data = (kernel_ulong_t) &imx_uart_devdata[IMX53_UART],
277 .name = "imx6q-uart",
278 .driver_data = (kernel_ulong_t) &imx_uart_devdata[IMX6Q_UART],
283 MODULE_DEVICE_TABLE(platform, imx_uart_devtype);
285 static const struct of_device_id imx_uart_dt_ids[] = {
286 { .compatible = "fsl,imx6q-uart", .data = &imx_uart_devdata[IMX6Q_UART], },
287 { .compatible = "fsl,imx53-uart", .data = &imx_uart_devdata[IMX53_UART], },
288 { .compatible = "fsl,imx1-uart", .data = &imx_uart_devdata[IMX1_UART], },
289 { .compatible = "fsl,imx21-uart", .data = &imx_uart_devdata[IMX21_UART], },
292 MODULE_DEVICE_TABLE(of, imx_uart_dt_ids);
294 static void imx_uart_writel(struct imx_port *sport, u32 val, u32 offset)
315 writel(val, sport->port.membase + offset);
318 static u32 imx_uart_readl(struct imx_port *sport, u32 offset)
326 * UCR2_SRST is the only bit in the cached registers that might
327 * differ from the value that was last written. As it only
328 * automatically becomes one after being cleared, reread
331 if (!(sport->ucr2 & UCR2_SRST))
332 sport->ucr2 = readl(sport->port.membase + offset);
345 return readl(sport->port.membase + offset);
349 static inline unsigned imx_uart_uts_reg(struct imx_port *sport)
351 return sport->devdata->uts_reg;
354 static inline int imx_uart_is_imx1(struct imx_port *sport)
356 return sport->devdata->devtype == IMX1_UART;
359 static inline int imx_uart_is_imx21(struct imx_port *sport)
361 return sport->devdata->devtype == IMX21_UART;
364 static inline int imx_uart_is_imx53(struct imx_port *sport)
366 return sport->devdata->devtype == IMX53_UART;
369 static inline int imx_uart_is_imx6q(struct imx_port *sport)
371 return sport->devdata->devtype == IMX6Q_UART;
374 * Save and restore functions for UCR1, UCR2 and UCR3 registers
376 #if IS_ENABLED(CONFIG_SERIAL_IMX_CONSOLE)
377 static void imx_uart_ucrs_save(struct imx_port *sport,
378 struct imx_port_ucrs *ucr)
380 /* save control registers */
381 ucr->ucr1 = imx_uart_readl(sport, UCR1);
382 ucr->ucr2 = imx_uart_readl(sport, UCR2);
383 ucr->ucr3 = imx_uart_readl(sport, UCR3);
386 static void imx_uart_ucrs_restore(struct imx_port *sport,
387 struct imx_port_ucrs *ucr)
389 /* restore control registers */
390 imx_uart_writel(sport, ucr->ucr1, UCR1);
391 imx_uart_writel(sport, ucr->ucr2, UCR2);
392 imx_uart_writel(sport, ucr->ucr3, UCR3);
396 /* called with port.lock taken and irqs caller dependent */
397 static void imx_uart_rts_active(struct imx_port *sport, u32 *ucr2)
399 *ucr2 &= ~(UCR2_CTSC | UCR2_CTS);
401 sport->port.mctrl |= TIOCM_RTS;
402 mctrl_gpio_set(sport->gpios, sport->port.mctrl);
405 /* called with port.lock taken and irqs caller dependent */
406 static void imx_uart_rts_inactive(struct imx_port *sport, u32 *ucr2)
411 sport->port.mctrl &= ~TIOCM_RTS;
412 mctrl_gpio_set(sport->gpios, sport->port.mctrl);
415 static void start_hrtimer_ms(struct hrtimer *hrt, unsigned long msec)
417 long sec = msec / MSEC_PER_SEC;
418 long nsec = (msec % MSEC_PER_SEC) * 1000000;
419 ktime_t t = ktime_set(sec, nsec);
421 hrtimer_start(hrt, t, HRTIMER_MODE_REL);
424 /* called with port.lock taken and irqs off */
425 static void imx_uart_start_rx(struct uart_port *port)
427 struct imx_port *sport = (struct imx_port *)port;
428 unsigned int ucr1, ucr2;
430 ucr1 = imx_uart_readl(sport, UCR1);
431 ucr2 = imx_uart_readl(sport, UCR2);
435 if (sport->dma_is_enabled) {
436 ucr1 |= UCR1_RXDMAEN | UCR1_ATDMAEN;
442 /* Write UCR2 first as it includes RXEN */
443 imx_uart_writel(sport, ucr2, UCR2);
444 imx_uart_writel(sport, ucr1, UCR1);
447 /* called with port.lock taken and irqs off */
448 static void imx_uart_stop_tx(struct uart_port *port)
450 struct imx_port *sport = (struct imx_port *)port;
451 u32 ucr1, ucr4, usr2;
453 if (sport->tx_state == OFF)
457 * We are maybe in the SMP context, so if the DMA TX thread is running
458 * on other cpu, we have to wait for it to finish.
460 if (sport->dma_is_txing)
463 ucr1 = imx_uart_readl(sport, UCR1);
464 imx_uart_writel(sport, ucr1 & ~UCR1_TRDYEN, UCR1);
466 usr2 = imx_uart_readl(sport, USR2);
467 if (!(usr2 & USR2_TXDC)) {
468 /* The shifter is still busy, so retry once TC triggers */
472 ucr4 = imx_uart_readl(sport, UCR4);
474 imx_uart_writel(sport, ucr4, UCR4);
476 /* in rs485 mode disable transmitter */
477 if (port->rs485.flags & SER_RS485_ENABLED) {
478 if (sport->tx_state == SEND) {
479 sport->tx_state = WAIT_AFTER_SEND;
480 start_hrtimer_ms(&sport->trigger_stop_tx,
481 port->rs485.delay_rts_after_send);
485 if (sport->tx_state == WAIT_AFTER_RTS ||
486 sport->tx_state == WAIT_AFTER_SEND) {
489 hrtimer_try_to_cancel(&sport->trigger_start_tx);
491 ucr2 = imx_uart_readl(sport, UCR2);
492 if (port->rs485.flags & SER_RS485_RTS_AFTER_SEND)
493 imx_uart_rts_active(sport, &ucr2);
495 imx_uart_rts_inactive(sport, &ucr2);
496 imx_uart_writel(sport, ucr2, UCR2);
498 imx_uart_start_rx(port);
500 sport->tx_state = OFF;
503 sport->tx_state = OFF;
507 /* called with port.lock taken and irqs off */
508 static void imx_uart_stop_rx(struct uart_port *port)
510 struct imx_port *sport = (struct imx_port *)port;
513 ucr1 = imx_uart_readl(sport, UCR1);
514 ucr2 = imx_uart_readl(sport, UCR2);
516 if (sport->dma_is_enabled) {
517 ucr1 &= ~(UCR1_RXDMAEN | UCR1_ATDMAEN);
519 ucr1 &= ~UCR1_RRDYEN;
522 imx_uart_writel(sport, ucr1, UCR1);
525 imx_uart_writel(sport, ucr2, UCR2);
528 /* called with port.lock taken and irqs off */
529 static void imx_uart_enable_ms(struct uart_port *port)
531 struct imx_port *sport = (struct imx_port *)port;
533 mod_timer(&sport->timer, jiffies);
535 mctrl_gpio_enable_ms(sport->gpios);
538 static void imx_uart_dma_tx(struct imx_port *sport);
540 /* called with port.lock taken and irqs off */
541 static inline void imx_uart_transmit_buffer(struct imx_port *sport)
543 struct circ_buf *xmit = &sport->port.state->xmit;
545 if (sport->port.x_char) {
547 imx_uart_writel(sport, sport->port.x_char, URTX0);
548 sport->port.icount.tx++;
549 sport->port.x_char = 0;
553 if (uart_circ_empty(xmit) || uart_tx_stopped(&sport->port)) {
554 imx_uart_stop_tx(&sport->port);
558 if (sport->dma_is_enabled) {
561 * We've just sent a X-char Ensure the TX DMA is enabled
562 * and the TX IRQ is disabled.
564 ucr1 = imx_uart_readl(sport, UCR1);
565 ucr1 &= ~UCR1_TRDYEN;
566 if (sport->dma_is_txing) {
567 ucr1 |= UCR1_TXDMAEN;
568 imx_uart_writel(sport, ucr1, UCR1);
570 imx_uart_writel(sport, ucr1, UCR1);
571 imx_uart_dma_tx(sport);
577 while (!uart_circ_empty(xmit) &&
578 !(imx_uart_readl(sport, imx_uart_uts_reg(sport)) & UTS_TXFULL)) {
579 /* send xmit->buf[xmit->tail]
580 * out the port here */
581 imx_uart_writel(sport, xmit->buf[xmit->tail], URTX0);
582 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
583 sport->port.icount.tx++;
586 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
587 uart_write_wakeup(&sport->port);
589 if (uart_circ_empty(xmit))
590 imx_uart_stop_tx(&sport->port);
593 static void imx_uart_dma_tx_callback(void *data)
595 struct imx_port *sport = data;
596 struct scatterlist *sgl = &sport->tx_sgl[0];
597 struct circ_buf *xmit = &sport->port.state->xmit;
601 spin_lock_irqsave(&sport->port.lock, flags);
603 dma_unmap_sg(sport->port.dev, sgl, sport->dma_tx_nents, DMA_TO_DEVICE);
605 ucr1 = imx_uart_readl(sport, UCR1);
606 ucr1 &= ~UCR1_TXDMAEN;
607 imx_uart_writel(sport, ucr1, UCR1);
609 /* update the stat */
610 xmit->tail = (xmit->tail + sport->tx_bytes) & (UART_XMIT_SIZE - 1);
611 sport->port.icount.tx += sport->tx_bytes;
613 dev_dbg(sport->port.dev, "we finish the TX DMA.\n");
615 sport->dma_is_txing = 0;
617 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
618 uart_write_wakeup(&sport->port);
620 if (!uart_circ_empty(xmit) && !uart_tx_stopped(&sport->port))
621 imx_uart_dma_tx(sport);
622 else if (sport->port.rs485.flags & SER_RS485_ENABLED) {
623 u32 ucr4 = imx_uart_readl(sport, UCR4);
625 imx_uart_writel(sport, ucr4, UCR4);
628 spin_unlock_irqrestore(&sport->port.lock, flags);
631 /* called with port.lock taken and irqs off */
632 static void imx_uart_dma_tx(struct imx_port *sport)
634 struct circ_buf *xmit = &sport->port.state->xmit;
635 struct scatterlist *sgl = sport->tx_sgl;
636 struct dma_async_tx_descriptor *desc;
637 struct dma_chan *chan = sport->dma_chan_tx;
638 struct device *dev = sport->port.dev;
642 if (sport->dma_is_txing)
645 ucr4 = imx_uart_readl(sport, UCR4);
647 imx_uart_writel(sport, ucr4, UCR4);
649 sport->tx_bytes = uart_circ_chars_pending(xmit);
651 if (xmit->tail < xmit->head || xmit->head == 0) {
652 sport->dma_tx_nents = 1;
653 sg_init_one(sgl, xmit->buf + xmit->tail, sport->tx_bytes);
655 sport->dma_tx_nents = 2;
656 sg_init_table(sgl, 2);
657 sg_set_buf(sgl, xmit->buf + xmit->tail,
658 UART_XMIT_SIZE - xmit->tail);
659 sg_set_buf(sgl + 1, xmit->buf, xmit->head);
662 ret = dma_map_sg(dev, sgl, sport->dma_tx_nents, DMA_TO_DEVICE);
664 dev_err(dev, "DMA mapping error for TX.\n");
667 desc = dmaengine_prep_slave_sg(chan, sgl, ret,
668 DMA_MEM_TO_DEV, DMA_PREP_INTERRUPT);
670 dma_unmap_sg(dev, sgl, sport->dma_tx_nents,
672 dev_err(dev, "We cannot prepare for the TX slave dma!\n");
675 desc->callback = imx_uart_dma_tx_callback;
676 desc->callback_param = sport;
678 dev_dbg(dev, "TX: prepare to send %lu bytes by DMA.\n",
679 uart_circ_chars_pending(xmit));
681 ucr1 = imx_uart_readl(sport, UCR1);
682 ucr1 |= UCR1_TXDMAEN;
683 imx_uart_writel(sport, ucr1, UCR1);
686 sport->dma_is_txing = 1;
687 dmaengine_submit(desc);
688 dma_async_issue_pending(chan);
692 /* called with port.lock taken and irqs off */
693 static void imx_uart_start_tx(struct uart_port *port)
695 struct imx_port *sport = (struct imx_port *)port;
698 if (!sport->port.x_char && uart_circ_empty(&port->state->xmit))
702 * We cannot simply do nothing here if sport->tx_state == SEND already
703 * because UCR1_TXMPTYEN might already have been cleared in
704 * imx_uart_stop_tx(), but tx_state is still SEND.
707 if (port->rs485.flags & SER_RS485_ENABLED) {
708 if (sport->tx_state == OFF) {
709 u32 ucr2 = imx_uart_readl(sport, UCR2);
710 if (port->rs485.flags & SER_RS485_RTS_ON_SEND)
711 imx_uart_rts_active(sport, &ucr2);
713 imx_uart_rts_inactive(sport, &ucr2);
714 imx_uart_writel(sport, ucr2, UCR2);
716 if (!(port->rs485.flags & SER_RS485_RX_DURING_TX))
717 imx_uart_stop_rx(port);
719 sport->tx_state = WAIT_AFTER_RTS;
720 start_hrtimer_ms(&sport->trigger_start_tx,
721 port->rs485.delay_rts_before_send);
725 if (sport->tx_state == WAIT_AFTER_SEND
726 || sport->tx_state == WAIT_AFTER_RTS) {
728 hrtimer_try_to_cancel(&sport->trigger_stop_tx);
731 * Enable transmitter and shifter empty irq only if DMA
732 * is off. In the DMA case this is done in the
735 if (!sport->dma_is_enabled) {
736 u32 ucr4 = imx_uart_readl(sport, UCR4);
738 imx_uart_writel(sport, ucr4, UCR4);
741 sport->tx_state = SEND;
744 sport->tx_state = SEND;
747 if (!sport->dma_is_enabled) {
748 ucr1 = imx_uart_readl(sport, UCR1);
749 imx_uart_writel(sport, ucr1 | UCR1_TRDYEN, UCR1);
752 if (sport->dma_is_enabled) {
753 if (sport->port.x_char) {
754 /* We have X-char to send, so enable TX IRQ and
755 * disable TX DMA to let TX interrupt to send X-char */
756 ucr1 = imx_uart_readl(sport, UCR1);
757 ucr1 &= ~UCR1_TXDMAEN;
759 imx_uart_writel(sport, ucr1, UCR1);
763 if (!uart_circ_empty(&port->state->xmit) &&
764 !uart_tx_stopped(port))
765 imx_uart_dma_tx(sport);
770 static irqreturn_t __imx_uart_rtsint(int irq, void *dev_id)
772 struct imx_port *sport = dev_id;
775 imx_uart_writel(sport, USR1_RTSD, USR1);
776 usr1 = imx_uart_readl(sport, USR1) & USR1_RTSS;
777 uart_handle_cts_change(&sport->port, !!usr1);
778 wake_up_interruptible(&sport->port.state->port.delta_msr_wait);
783 static irqreturn_t imx_uart_rtsint(int irq, void *dev_id)
785 struct imx_port *sport = dev_id;
788 spin_lock(&sport->port.lock);
790 ret = __imx_uart_rtsint(irq, dev_id);
792 spin_unlock(&sport->port.lock);
797 static irqreturn_t imx_uart_txint(int irq, void *dev_id)
799 struct imx_port *sport = dev_id;
801 spin_lock(&sport->port.lock);
802 imx_uart_transmit_buffer(sport);
803 spin_unlock(&sport->port.lock);
807 static irqreturn_t __imx_uart_rxint(int irq, void *dev_id)
809 struct imx_port *sport = dev_id;
810 unsigned int rx, flg, ignored = 0;
811 struct tty_port *port = &sport->port.state->port;
813 while (imx_uart_readl(sport, USR2) & USR2_RDR) {
817 sport->port.icount.rx++;
819 rx = imx_uart_readl(sport, URXD0);
821 usr2 = imx_uart_readl(sport, USR2);
822 if (usr2 & USR2_BRCD) {
823 imx_uart_writel(sport, USR2_BRCD, USR2);
824 if (uart_handle_break(&sport->port))
828 if (uart_handle_sysrq_char(&sport->port, (unsigned char)rx))
831 if (unlikely(rx & URXD_ERR)) {
833 sport->port.icount.brk++;
834 else if (rx & URXD_PRERR)
835 sport->port.icount.parity++;
836 else if (rx & URXD_FRMERR)
837 sport->port.icount.frame++;
838 if (rx & URXD_OVRRUN)
839 sport->port.icount.overrun++;
841 if (rx & sport->port.ignore_status_mask) {
847 rx &= (sport->port.read_status_mask | 0xFF);
851 else if (rx & URXD_PRERR)
853 else if (rx & URXD_FRMERR)
855 if (rx & URXD_OVRRUN)
858 sport->port.sysrq = 0;
861 if (sport->port.ignore_status_mask & URXD_DUMMY_READ)
864 if (tty_insert_flip_char(port, rx, flg) == 0)
865 sport->port.icount.buf_overrun++;
869 tty_flip_buffer_push(port);
874 static irqreturn_t imx_uart_rxint(int irq, void *dev_id)
876 struct imx_port *sport = dev_id;
879 spin_lock(&sport->port.lock);
881 ret = __imx_uart_rxint(irq, dev_id);
883 spin_unlock(&sport->port.lock);
888 static void imx_uart_clear_rx_errors(struct imx_port *sport);
891 * We have a modem side uart, so the meanings of RTS and CTS are inverted.
893 static unsigned int imx_uart_get_hwmctrl(struct imx_port *sport)
895 unsigned int tmp = TIOCM_DSR;
896 unsigned usr1 = imx_uart_readl(sport, USR1);
897 unsigned usr2 = imx_uart_readl(sport, USR2);
899 if (usr1 & USR1_RTSS)
902 /* in DCE mode DCDIN is always 0 */
903 if (!(usr2 & USR2_DCDIN))
907 if (!(imx_uart_readl(sport, USR2) & USR2_RIIN))
914 * Handle any change of modem status signal since we were last called.
916 static void imx_uart_mctrl_check(struct imx_port *sport)
918 unsigned int status, changed;
920 status = imx_uart_get_hwmctrl(sport);
921 changed = status ^ sport->old_status;
926 sport->old_status = status;
928 if (changed & TIOCM_RI && status & TIOCM_RI)
929 sport->port.icount.rng++;
930 if (changed & TIOCM_DSR)
931 sport->port.icount.dsr++;
932 if (changed & TIOCM_CAR)
933 uart_handle_dcd_change(&sport->port, status & TIOCM_CAR);
934 if (changed & TIOCM_CTS)
935 uart_handle_cts_change(&sport->port, status & TIOCM_CTS);
937 wake_up_interruptible(&sport->port.state->port.delta_msr_wait);
940 static irqreturn_t imx_uart_int(int irq, void *dev_id)
942 struct imx_port *sport = dev_id;
943 unsigned int usr1, usr2, ucr1, ucr2, ucr3, ucr4;
944 irqreturn_t ret = IRQ_NONE;
946 spin_lock(&sport->port.lock);
948 usr1 = imx_uart_readl(sport, USR1);
949 usr2 = imx_uart_readl(sport, USR2);
950 ucr1 = imx_uart_readl(sport, UCR1);
951 ucr2 = imx_uart_readl(sport, UCR2);
952 ucr3 = imx_uart_readl(sport, UCR3);
953 ucr4 = imx_uart_readl(sport, UCR4);
956 * Even if a condition is true that can trigger an irq only handle it if
957 * the respective irq source is enabled. This prevents some undesired
958 * actions, for example if a character that sits in the RX FIFO and that
959 * should be fetched via DMA is tried to be fetched using PIO. Or the
960 * receiver is currently off and so reading from URXD0 results in an
961 * exception. So just mask the (raw) status bits for disabled irqs.
963 if ((ucr1 & UCR1_RRDYEN) == 0)
965 if ((ucr2 & UCR2_ATEN) == 0)
967 if ((ucr1 & UCR1_TRDYEN) == 0)
969 if ((ucr4 & UCR4_TCEN) == 0)
971 if ((ucr3 & UCR3_DTRDEN) == 0)
973 if ((ucr1 & UCR1_RTSDEN) == 0)
975 if ((ucr3 & UCR3_AWAKEN) == 0)
977 if ((ucr4 & UCR4_OREN) == 0)
980 if (usr1 & (USR1_RRDY | USR1_AGTIM)) {
981 imx_uart_writel(sport, USR1_AGTIM, USR1);
983 __imx_uart_rxint(irq, dev_id);
987 if ((usr1 & USR1_TRDY) || (usr2 & USR2_TXDC)) {
988 imx_uart_transmit_buffer(sport);
992 if (usr1 & USR1_DTRD) {
993 imx_uart_writel(sport, USR1_DTRD, USR1);
995 imx_uart_mctrl_check(sport);
1000 if (usr1 & USR1_RTSD) {
1001 __imx_uart_rtsint(irq, dev_id);
1005 if (usr1 & USR1_AWAKE) {
1006 imx_uart_writel(sport, USR1_AWAKE, USR1);
1010 if (usr2 & USR2_ORE) {
1011 sport->port.icount.overrun++;
1012 imx_uart_writel(sport, USR2_ORE, USR2);
1016 spin_unlock(&sport->port.lock);
1022 * Return TIOCSER_TEMT when transmitter is not busy.
1024 static unsigned int imx_uart_tx_empty(struct uart_port *port)
1026 struct imx_port *sport = (struct imx_port *)port;
1029 ret = (imx_uart_readl(sport, USR2) & USR2_TXDC) ? TIOCSER_TEMT : 0;
1031 /* If the TX DMA is working, return 0. */
1032 if (sport->dma_is_txing)
1038 /* called with port.lock taken and irqs off */
1039 static unsigned int imx_uart_get_mctrl(struct uart_port *port)
1041 struct imx_port *sport = (struct imx_port *)port;
1042 unsigned int ret = imx_uart_get_hwmctrl(sport);
1044 mctrl_gpio_get(sport->gpios, &ret);
1049 /* called with port.lock taken and irqs off */
1050 static void imx_uart_set_mctrl(struct uart_port *port, unsigned int mctrl)
1052 struct imx_port *sport = (struct imx_port *)port;
1055 if (!(port->rs485.flags & SER_RS485_ENABLED)) {
1059 * Turn off autoRTS if RTS is lowered and restore autoRTS
1060 * setting if RTS is raised.
1062 ucr2 = imx_uart_readl(sport, UCR2);
1063 ucr2 &= ~(UCR2_CTS | UCR2_CTSC);
1064 if (mctrl & TIOCM_RTS) {
1067 * UCR2_IRTS is unset if and only if the port is
1068 * configured for CRTSCTS, so we use inverted UCR2_IRTS
1069 * to get the state to restore to.
1071 if (!(ucr2 & UCR2_IRTS))
1074 imx_uart_writel(sport, ucr2, UCR2);
1077 ucr3 = imx_uart_readl(sport, UCR3) & ~UCR3_DSR;
1078 if (!(mctrl & TIOCM_DTR))
1080 imx_uart_writel(sport, ucr3, UCR3);
1082 uts = imx_uart_readl(sport, imx_uart_uts_reg(sport)) & ~UTS_LOOP;
1083 if (mctrl & TIOCM_LOOP)
1085 imx_uart_writel(sport, uts, imx_uart_uts_reg(sport));
1087 mctrl_gpio_set(sport->gpios, mctrl);
1091 * Interrupts always disabled.
1093 static void imx_uart_break_ctl(struct uart_port *port, int break_state)
1095 struct imx_port *sport = (struct imx_port *)port;
1096 unsigned long flags;
1099 spin_lock_irqsave(&sport->port.lock, flags);
1101 ucr1 = imx_uart_readl(sport, UCR1) & ~UCR1_SNDBRK;
1103 if (break_state != 0)
1104 ucr1 |= UCR1_SNDBRK;
1106 imx_uart_writel(sport, ucr1, UCR1);
1108 spin_unlock_irqrestore(&sport->port.lock, flags);
1112 * This is our per-port timeout handler, for checking the
1113 * modem status signals.
1115 static void imx_uart_timeout(struct timer_list *t)
1117 struct imx_port *sport = from_timer(sport, t, timer);
1118 unsigned long flags;
1120 if (sport->port.state) {
1121 spin_lock_irqsave(&sport->port.lock, flags);
1122 imx_uart_mctrl_check(sport);
1123 spin_unlock_irqrestore(&sport->port.lock, flags);
1125 mod_timer(&sport->timer, jiffies + MCTRL_TIMEOUT);
1130 * There are two kinds of RX DMA interrupts(such as in the MX6Q):
1131 * [1] the RX DMA buffer is full.
1132 * [2] the aging timer expires
1134 * Condition [2] is triggered when a character has been sitting in the FIFO
1135 * for at least 8 byte durations.
1137 static void imx_uart_dma_rx_callback(void *data)
1139 struct imx_port *sport = data;
1140 struct dma_chan *chan = sport->dma_chan_rx;
1141 struct scatterlist *sgl = &sport->rx_sgl;
1142 struct tty_port *port = &sport->port.state->port;
1143 struct dma_tx_state state;
1144 struct circ_buf *rx_ring = &sport->rx_ring;
1145 enum dma_status status;
1146 unsigned int w_bytes = 0;
1147 unsigned int r_bytes;
1148 unsigned int bd_size;
1150 status = dmaengine_tx_status(chan, sport->rx_cookie, &state);
1152 if (status == DMA_ERROR) {
1153 imx_uart_clear_rx_errors(sport);
1157 if (!(sport->port.ignore_status_mask & URXD_DUMMY_READ)) {
1160 * The state-residue variable represents the empty space
1161 * relative to the entire buffer. Taking this in consideration
1162 * the head is always calculated base on the buffer total
1163 * length - DMA transaction residue. The UART script from the
1164 * SDMA firmware will jump to the next buffer descriptor,
1165 * once a DMA transaction if finalized (IMX53 RM - A.4.1.2.4).
1166 * Taking this in consideration the tail is always at the
1167 * beginning of the buffer descriptor that contains the head.
1170 /* Calculate the head */
1171 rx_ring->head = sg_dma_len(sgl) - state.residue;
1173 /* Calculate the tail. */
1174 bd_size = sg_dma_len(sgl) / sport->rx_periods;
1175 rx_ring->tail = ((rx_ring->head-1) / bd_size) * bd_size;
1177 if (rx_ring->head <= sg_dma_len(sgl) &&
1178 rx_ring->head > rx_ring->tail) {
1180 /* Move data from tail to head */
1181 r_bytes = rx_ring->head - rx_ring->tail;
1183 /* CPU claims ownership of RX DMA buffer */
1184 dma_sync_sg_for_cpu(sport->port.dev, sgl, 1,
1187 w_bytes = tty_insert_flip_string(port,
1188 sport->rx_buf + rx_ring->tail, r_bytes);
1190 /* UART retrieves ownership of RX DMA buffer */
1191 dma_sync_sg_for_device(sport->port.dev, sgl, 1,
1194 if (w_bytes != r_bytes)
1195 sport->port.icount.buf_overrun++;
1197 sport->port.icount.rx += w_bytes;
1199 WARN_ON(rx_ring->head > sg_dma_len(sgl));
1200 WARN_ON(rx_ring->head <= rx_ring->tail);
1205 tty_flip_buffer_push(port);
1206 dev_dbg(sport->port.dev, "We get %d bytes.\n", w_bytes);
1210 /* RX DMA buffer periods */
1211 #define RX_DMA_PERIODS 16
1212 #define RX_BUF_SIZE (RX_DMA_PERIODS * PAGE_SIZE / 4)
1214 static int imx_uart_start_rx_dma(struct imx_port *sport)
1216 struct scatterlist *sgl = &sport->rx_sgl;
1217 struct dma_chan *chan = sport->dma_chan_rx;
1218 struct device *dev = sport->port.dev;
1219 struct dma_async_tx_descriptor *desc;
1222 sport->rx_ring.head = 0;
1223 sport->rx_ring.tail = 0;
1224 sport->rx_periods = RX_DMA_PERIODS;
1226 sg_init_one(sgl, sport->rx_buf, RX_BUF_SIZE);
1227 ret = dma_map_sg(dev, sgl, 1, DMA_FROM_DEVICE);
1229 dev_err(dev, "DMA mapping error for RX.\n");
1233 desc = dmaengine_prep_dma_cyclic(chan, sg_dma_address(sgl),
1234 sg_dma_len(sgl), sg_dma_len(sgl) / sport->rx_periods,
1235 DMA_DEV_TO_MEM, DMA_PREP_INTERRUPT);
1238 dma_unmap_sg(dev, sgl, 1, DMA_FROM_DEVICE);
1239 dev_err(dev, "We cannot prepare for the RX slave dma!\n");
1242 desc->callback = imx_uart_dma_rx_callback;
1243 desc->callback_param = sport;
1245 dev_dbg(dev, "RX: prepare for the DMA.\n");
1246 sport->dma_is_rxing = 1;
1247 sport->rx_cookie = dmaengine_submit(desc);
1248 dma_async_issue_pending(chan);
1252 static void imx_uart_clear_rx_errors(struct imx_port *sport)
1254 struct tty_port *port = &sport->port.state->port;
1257 usr1 = imx_uart_readl(sport, USR1);
1258 usr2 = imx_uart_readl(sport, USR2);
1260 if (usr2 & USR2_BRCD) {
1261 sport->port.icount.brk++;
1262 imx_uart_writel(sport, USR2_BRCD, USR2);
1263 uart_handle_break(&sport->port);
1264 if (tty_insert_flip_char(port, 0, TTY_BREAK) == 0)
1265 sport->port.icount.buf_overrun++;
1266 tty_flip_buffer_push(port);
1268 if (usr1 & USR1_FRAMERR) {
1269 sport->port.icount.frame++;
1270 imx_uart_writel(sport, USR1_FRAMERR, USR1);
1271 } else if (usr1 & USR1_PARITYERR) {
1272 sport->port.icount.parity++;
1273 imx_uart_writel(sport, USR1_PARITYERR, USR1);
1277 if (usr2 & USR2_ORE) {
1278 sport->port.icount.overrun++;
1279 imx_uart_writel(sport, USR2_ORE, USR2);
1284 #define TXTL_DEFAULT 2 /* reset default */
1285 #define RXTL_DEFAULT 1 /* reset default */
1286 #define TXTL_DMA 8 /* DMA burst setting */
1287 #define RXTL_DMA 9 /* DMA burst setting */
1289 static void imx_uart_setup_ufcr(struct imx_port *sport,
1290 unsigned char txwl, unsigned char rxwl)
1294 /* set receiver / transmitter trigger level */
1295 val = imx_uart_readl(sport, UFCR) & (UFCR_RFDIV | UFCR_DCEDTE);
1296 val |= txwl << UFCR_TXTL_SHF | rxwl;
1297 imx_uart_writel(sport, val, UFCR);
1300 static void imx_uart_dma_exit(struct imx_port *sport)
1302 if (sport->dma_chan_rx) {
1303 dmaengine_terminate_sync(sport->dma_chan_rx);
1304 dma_release_channel(sport->dma_chan_rx);
1305 sport->dma_chan_rx = NULL;
1306 sport->rx_cookie = -EINVAL;
1307 kfree(sport->rx_buf);
1308 sport->rx_buf = NULL;
1311 if (sport->dma_chan_tx) {
1312 dmaengine_terminate_sync(sport->dma_chan_tx);
1313 dma_release_channel(sport->dma_chan_tx);
1314 sport->dma_chan_tx = NULL;
1318 static int imx_uart_dma_init(struct imx_port *sport)
1320 struct dma_slave_config slave_config = {};
1321 struct device *dev = sport->port.dev;
1324 /* Prepare for RX : */
1325 sport->dma_chan_rx = dma_request_slave_channel(dev, "rx");
1326 if (!sport->dma_chan_rx) {
1327 dev_dbg(dev, "cannot get the DMA channel.\n");
1332 slave_config.direction = DMA_DEV_TO_MEM;
1333 slave_config.src_addr = sport->port.mapbase + URXD0;
1334 slave_config.src_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
1335 /* one byte less than the watermark level to enable the aging timer */
1336 slave_config.src_maxburst = RXTL_DMA - 1;
1337 ret = dmaengine_slave_config(sport->dma_chan_rx, &slave_config);
1339 dev_err(dev, "error in RX dma configuration.\n");
1343 sport->rx_buf = kzalloc(RX_BUF_SIZE, GFP_KERNEL);
1344 if (!sport->rx_buf) {
1348 sport->rx_ring.buf = sport->rx_buf;
1350 /* Prepare for TX : */
1351 sport->dma_chan_tx = dma_request_slave_channel(dev, "tx");
1352 if (!sport->dma_chan_tx) {
1353 dev_err(dev, "cannot get the TX DMA channel!\n");
1358 slave_config.direction = DMA_MEM_TO_DEV;
1359 slave_config.dst_addr = sport->port.mapbase + URTX0;
1360 slave_config.dst_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
1361 slave_config.dst_maxburst = TXTL_DMA;
1362 ret = dmaengine_slave_config(sport->dma_chan_tx, &slave_config);
1364 dev_err(dev, "error in TX dma configuration.");
1370 imx_uart_dma_exit(sport);
1374 static void imx_uart_enable_dma(struct imx_port *sport)
1378 imx_uart_setup_ufcr(sport, TXTL_DMA, RXTL_DMA);
1381 ucr1 = imx_uart_readl(sport, UCR1);
1382 ucr1 |= UCR1_RXDMAEN | UCR1_TXDMAEN | UCR1_ATDMAEN;
1383 imx_uart_writel(sport, ucr1, UCR1);
1385 sport->dma_is_enabled = 1;
1388 static void imx_uart_disable_dma(struct imx_port *sport)
1393 ucr1 = imx_uart_readl(sport, UCR1);
1394 ucr1 &= ~(UCR1_RXDMAEN | UCR1_TXDMAEN | UCR1_ATDMAEN);
1395 imx_uart_writel(sport, ucr1, UCR1);
1397 imx_uart_setup_ufcr(sport, TXTL_DEFAULT, RXTL_DEFAULT);
1399 sport->dma_is_enabled = 0;
1402 /* half the RX buffer size */
1405 static int imx_uart_startup(struct uart_port *port)
1407 struct imx_port *sport = (struct imx_port *)port;
1409 unsigned long flags;
1410 int dma_is_inited = 0;
1411 u32 ucr1, ucr2, ucr3, ucr4;
1413 retval = clk_prepare_enable(sport->clk_per);
1416 retval = clk_prepare_enable(sport->clk_ipg);
1418 clk_disable_unprepare(sport->clk_per);
1422 imx_uart_setup_ufcr(sport, TXTL_DEFAULT, RXTL_DEFAULT);
1424 /* disable the DREN bit (Data Ready interrupt enable) before
1427 ucr4 = imx_uart_readl(sport, UCR4);
1429 /* set the trigger level for CTS */
1430 ucr4 &= ~(UCR4_CTSTL_MASK << UCR4_CTSTL_SHF);
1431 ucr4 |= CTSTL << UCR4_CTSTL_SHF;
1433 imx_uart_writel(sport, ucr4 & ~UCR4_DREN, UCR4);
1435 /* Can we enable the DMA support? */
1436 if (!uart_console(port) && imx_uart_dma_init(sport) == 0)
1439 spin_lock_irqsave(&sport->port.lock, flags);
1440 /* Reset fifo's and state machines */
1443 ucr2 = imx_uart_readl(sport, UCR2);
1445 imx_uart_writel(sport, ucr2, UCR2);
1447 while (!(imx_uart_readl(sport, UCR2) & UCR2_SRST) && (--i > 0))
1451 * Finally, clear and enable interrupts
1453 imx_uart_writel(sport, USR1_RTSD | USR1_DTRD, USR1);
1454 imx_uart_writel(sport, USR2_ORE, USR2);
1456 ucr1 = imx_uart_readl(sport, UCR1) & ~UCR1_RRDYEN;
1457 ucr1 |= UCR1_UARTEN;
1458 if (sport->have_rtscts)
1459 ucr1 |= UCR1_RTSDEN;
1461 imx_uart_writel(sport, ucr1, UCR1);
1463 ucr4 = imx_uart_readl(sport, UCR4) & ~(UCR4_OREN | UCR4_INVR);
1464 if (!sport->dma_is_enabled)
1466 if (sport->inverted_rx)
1468 imx_uart_writel(sport, ucr4, UCR4);
1470 ucr3 = imx_uart_readl(sport, UCR3) & ~UCR3_INVT;
1472 * configure tx polarity before enabling tx
1474 if (sport->inverted_tx)
1477 if (!imx_uart_is_imx1(sport)) {
1478 ucr3 |= UCR3_DTRDEN | UCR3_RI | UCR3_DCD;
1480 if (sport->dte_mode)
1481 /* disable broken interrupts */
1482 ucr3 &= ~(UCR3_RI | UCR3_DCD);
1484 imx_uart_writel(sport, ucr3, UCR3);
1486 ucr2 = imx_uart_readl(sport, UCR2) & ~UCR2_ATEN;
1487 ucr2 |= (UCR2_RXEN | UCR2_TXEN);
1488 if (!sport->have_rtscts)
1491 * make sure the edge sensitive RTS-irq is disabled,
1492 * we're using RTSD instead.
1494 if (!imx_uart_is_imx1(sport))
1495 ucr2 &= ~UCR2_RTSEN;
1496 imx_uart_writel(sport, ucr2, UCR2);
1499 * Enable modem status interrupts
1501 imx_uart_enable_ms(&sport->port);
1503 if (dma_is_inited) {
1504 imx_uart_enable_dma(sport);
1505 imx_uart_start_rx_dma(sport);
1507 ucr1 = imx_uart_readl(sport, UCR1);
1508 ucr1 |= UCR1_RRDYEN;
1509 imx_uart_writel(sport, ucr1, UCR1);
1511 ucr2 = imx_uart_readl(sport, UCR2);
1513 imx_uart_writel(sport, ucr2, UCR2);
1516 spin_unlock_irqrestore(&sport->port.lock, flags);
1521 static void imx_uart_shutdown(struct uart_port *port)
1523 struct imx_port *sport = (struct imx_port *)port;
1524 unsigned long flags;
1525 u32 ucr1, ucr2, ucr4;
1527 if (sport->dma_is_enabled) {
1528 dmaengine_terminate_sync(sport->dma_chan_tx);
1529 if (sport->dma_is_txing) {
1530 dma_unmap_sg(sport->port.dev, &sport->tx_sgl[0],
1531 sport->dma_tx_nents, DMA_TO_DEVICE);
1532 sport->dma_is_txing = 0;
1534 dmaengine_terminate_sync(sport->dma_chan_rx);
1535 if (sport->dma_is_rxing) {
1536 dma_unmap_sg(sport->port.dev, &sport->rx_sgl,
1537 1, DMA_FROM_DEVICE);
1538 sport->dma_is_rxing = 0;
1541 spin_lock_irqsave(&sport->port.lock, flags);
1542 imx_uart_stop_tx(port);
1543 imx_uart_stop_rx(port);
1544 imx_uart_disable_dma(sport);
1545 spin_unlock_irqrestore(&sport->port.lock, flags);
1546 imx_uart_dma_exit(sport);
1549 mctrl_gpio_disable_ms(sport->gpios);
1551 spin_lock_irqsave(&sport->port.lock, flags);
1552 ucr2 = imx_uart_readl(sport, UCR2);
1553 ucr2 &= ~(UCR2_TXEN | UCR2_ATEN);
1554 imx_uart_writel(sport, ucr2, UCR2);
1555 spin_unlock_irqrestore(&sport->port.lock, flags);
1560 del_timer_sync(&sport->timer);
1563 * Disable all interrupts, port and break condition.
1566 spin_lock_irqsave(&sport->port.lock, flags);
1568 ucr1 = imx_uart_readl(sport, UCR1);
1569 ucr1 &= ~(UCR1_TRDYEN | UCR1_RRDYEN | UCR1_RTSDEN | UCR1_UARTEN | UCR1_RXDMAEN | UCR1_ATDMAEN);
1570 imx_uart_writel(sport, ucr1, UCR1);
1572 ucr4 = imx_uart_readl(sport, UCR4);
1573 ucr4 &= ~(UCR4_OREN | UCR4_TCEN);
1574 imx_uart_writel(sport, ucr4, UCR4);
1576 spin_unlock_irqrestore(&sport->port.lock, flags);
1578 clk_disable_unprepare(sport->clk_per);
1579 clk_disable_unprepare(sport->clk_ipg);
1582 /* called with port.lock taken and irqs off */
1583 static void imx_uart_flush_buffer(struct uart_port *port)
1585 struct imx_port *sport = (struct imx_port *)port;
1586 struct scatterlist *sgl = &sport->tx_sgl[0];
1588 int i = 100, ubir, ubmr, uts;
1590 if (!sport->dma_chan_tx)
1593 sport->tx_bytes = 0;
1594 dmaengine_terminate_all(sport->dma_chan_tx);
1595 if (sport->dma_is_txing) {
1598 dma_unmap_sg(sport->port.dev, sgl, sport->dma_tx_nents,
1600 ucr1 = imx_uart_readl(sport, UCR1);
1601 ucr1 &= ~UCR1_TXDMAEN;
1602 imx_uart_writel(sport, ucr1, UCR1);
1603 sport->dma_is_txing = 0;
1607 * According to the Reference Manual description of the UART SRST bit:
1609 * "Reset the transmit and receive state machines,
1610 * all FIFOs and register USR1, USR2, UBIR, UBMR, UBRC, URXD, UTXD
1613 * We don't need to restore the old values from USR1, USR2, URXD and
1614 * UTXD. UBRC is read only, so only save/restore the other three
1617 ubir = imx_uart_readl(sport, UBIR);
1618 ubmr = imx_uart_readl(sport, UBMR);
1619 uts = imx_uart_readl(sport, IMX21_UTS);
1621 ucr2 = imx_uart_readl(sport, UCR2);
1623 imx_uart_writel(sport, ucr2, UCR2);
1625 while (!(imx_uart_readl(sport, UCR2) & UCR2_SRST) && (--i > 0))
1628 /* Restore the registers */
1629 imx_uart_writel(sport, ubir, UBIR);
1630 imx_uart_writel(sport, ubmr, UBMR);
1631 imx_uart_writel(sport, uts, IMX21_UTS);
1635 imx_uart_set_termios(struct uart_port *port, struct ktermios *termios,
1636 struct ktermios *old)
1638 struct imx_port *sport = (struct imx_port *)port;
1639 unsigned long flags;
1640 u32 ucr2, old_ucr2, ufcr;
1641 unsigned int baud, quot;
1642 unsigned int old_csize = old ? old->c_cflag & CSIZE : CS8;
1644 unsigned long num, denom, old_ubir, old_ubmr;
1648 * We only support CS7 and CS8.
1650 while ((termios->c_cflag & CSIZE) != CS7 &&
1651 (termios->c_cflag & CSIZE) != CS8) {
1652 termios->c_cflag &= ~CSIZE;
1653 termios->c_cflag |= old_csize;
1657 del_timer_sync(&sport->timer);
1660 * Ask the core to calculate the divisor for us.
1662 baud = uart_get_baud_rate(port, termios, old, 50, port->uartclk / 16);
1663 quot = uart_get_divisor(port, baud);
1665 spin_lock_irqsave(&sport->port.lock, flags);
1668 * Read current UCR2 and save it for future use, then clear all the bits
1669 * except those we will or may need to preserve.
1671 old_ucr2 = imx_uart_readl(sport, UCR2);
1672 ucr2 = old_ucr2 & (UCR2_TXEN | UCR2_RXEN | UCR2_ATEN | UCR2_CTS);
1674 ucr2 |= UCR2_SRST | UCR2_IRTS;
1675 if ((termios->c_cflag & CSIZE) == CS8)
1678 if (!sport->have_rtscts)
1679 termios->c_cflag &= ~CRTSCTS;
1681 if (port->rs485.flags & SER_RS485_ENABLED) {
1683 * RTS is mandatory for rs485 operation, so keep
1684 * it under manual control and keep transmitter
1687 if (port->rs485.flags & SER_RS485_RTS_AFTER_SEND)
1688 imx_uart_rts_active(sport, &ucr2);
1690 imx_uart_rts_inactive(sport, &ucr2);
1692 } else if (termios->c_cflag & CRTSCTS) {
1694 * Only let receiver control RTS output if we were not requested
1695 * to have RTS inactive (which then should take precedence).
1697 if (ucr2 & UCR2_CTS)
1701 if (termios->c_cflag & CRTSCTS)
1703 if (termios->c_cflag & CSTOPB)
1705 if (termios->c_cflag & PARENB) {
1707 if (termios->c_cflag & PARODD)
1711 sport->port.read_status_mask = 0;
1712 if (termios->c_iflag & INPCK)
1713 sport->port.read_status_mask |= (URXD_FRMERR | URXD_PRERR);
1714 if (termios->c_iflag & (BRKINT | PARMRK))
1715 sport->port.read_status_mask |= URXD_BRK;
1718 * Characters to ignore
1720 sport->port.ignore_status_mask = 0;
1721 if (termios->c_iflag & IGNPAR)
1722 sport->port.ignore_status_mask |= URXD_PRERR | URXD_FRMERR;
1723 if (termios->c_iflag & IGNBRK) {
1724 sport->port.ignore_status_mask |= URXD_BRK;
1726 * If we're ignoring parity and break indicators,
1727 * ignore overruns too (for real raw support).
1729 if (termios->c_iflag & IGNPAR)
1730 sport->port.ignore_status_mask |= URXD_OVRRUN;
1733 if ((termios->c_cflag & CREAD) == 0)
1734 sport->port.ignore_status_mask |= URXD_DUMMY_READ;
1737 * Update the per-port timeout.
1739 uart_update_timeout(port, termios->c_cflag, baud);
1741 /* custom-baudrate handling */
1742 div = sport->port.uartclk / (baud * 16);
1743 if (baud == 38400 && quot != div)
1744 baud = sport->port.uartclk / (quot * 16);
1746 div = sport->port.uartclk / (baud * 16);
1752 rational_best_approximation(16 * div * baud, sport->port.uartclk,
1753 1 << 16, 1 << 16, &num, &denom);
1755 tdiv64 = sport->port.uartclk;
1757 do_div(tdiv64, denom * 16 * div);
1758 tty_termios_encode_baud_rate(termios,
1759 (speed_t)tdiv64, (speed_t)tdiv64);
1764 ufcr = imx_uart_readl(sport, UFCR);
1765 ufcr = (ufcr & (~UFCR_RFDIV)) | UFCR_RFDIV_REG(div);
1766 imx_uart_writel(sport, ufcr, UFCR);
1769 * Two registers below should always be written both and in this
1770 * particular order. One consequence is that we need to check if any of
1771 * them changes and then update both. We do need the check for change
1772 * as even writing the same values seem to "restart"
1773 * transmission/receiving logic in the hardware, that leads to data
1774 * breakage even when rate doesn't in fact change. E.g., user switches
1775 * RTS/CTS handshake and suddenly gets broken bytes.
1777 old_ubir = imx_uart_readl(sport, UBIR);
1778 old_ubmr = imx_uart_readl(sport, UBMR);
1779 if (old_ubir != num || old_ubmr != denom) {
1780 imx_uart_writel(sport, num, UBIR);
1781 imx_uart_writel(sport, denom, UBMR);
1784 if (!imx_uart_is_imx1(sport))
1785 imx_uart_writel(sport, sport->port.uartclk / div / 1000,
1788 imx_uart_writel(sport, ucr2, UCR2);
1790 if (UART_ENABLE_MS(&sport->port, termios->c_cflag))
1791 imx_uart_enable_ms(&sport->port);
1793 spin_unlock_irqrestore(&sport->port.lock, flags);
1796 static const char *imx_uart_type(struct uart_port *port)
1798 struct imx_port *sport = (struct imx_port *)port;
1800 return sport->port.type == PORT_IMX ? "IMX" : NULL;
1804 * Configure/autoconfigure the port.
1806 static void imx_uart_config_port(struct uart_port *port, int flags)
1808 struct imx_port *sport = (struct imx_port *)port;
1810 if (flags & UART_CONFIG_TYPE)
1811 sport->port.type = PORT_IMX;
1815 * Verify the new serial_struct (for TIOCSSERIAL).
1816 * The only change we allow are to the flags and type, and
1817 * even then only between PORT_IMX and PORT_UNKNOWN
1820 imx_uart_verify_port(struct uart_port *port, struct serial_struct *ser)
1822 struct imx_port *sport = (struct imx_port *)port;
1825 if (ser->type != PORT_UNKNOWN && ser->type != PORT_IMX)
1827 if (sport->port.irq != ser->irq)
1829 if (ser->io_type != UPIO_MEM)
1831 if (sport->port.uartclk / 16 != ser->baud_base)
1833 if (sport->port.mapbase != (unsigned long)ser->iomem_base)
1835 if (sport->port.iobase != ser->port)
1842 #if defined(CONFIG_CONSOLE_POLL)
1844 static int imx_uart_poll_init(struct uart_port *port)
1846 struct imx_port *sport = (struct imx_port *)port;
1847 unsigned long flags;
1851 retval = clk_prepare_enable(sport->clk_ipg);
1854 retval = clk_prepare_enable(sport->clk_per);
1856 clk_disable_unprepare(sport->clk_ipg);
1858 imx_uart_setup_ufcr(sport, TXTL_DEFAULT, RXTL_DEFAULT);
1860 spin_lock_irqsave(&sport->port.lock, flags);
1863 * Be careful about the order of enabling bits here. First enable the
1864 * receiver (UARTEN + RXEN) and only then the corresponding irqs.
1865 * This prevents that a character that already sits in the RX fifo is
1866 * triggering an irq but the try to fetch it from there results in an
1867 * exception because UARTEN or RXEN is still off.
1869 ucr1 = imx_uart_readl(sport, UCR1);
1870 ucr2 = imx_uart_readl(sport, UCR2);
1872 if (imx_uart_is_imx1(sport))
1873 ucr1 |= IMX1_UCR1_UARTCLKEN;
1875 ucr1 |= UCR1_UARTEN;
1876 ucr1 &= ~(UCR1_TRDYEN | UCR1_RTSDEN | UCR1_RRDYEN);
1881 imx_uart_writel(sport, ucr1, UCR1);
1882 imx_uart_writel(sport, ucr2, UCR2);
1884 /* now enable irqs */
1885 imx_uart_writel(sport, ucr1 | UCR1_RRDYEN, UCR1);
1886 imx_uart_writel(sport, ucr2 | UCR2_ATEN, UCR2);
1888 spin_unlock_irqrestore(&sport->port.lock, flags);
1893 static int imx_uart_poll_get_char(struct uart_port *port)
1895 struct imx_port *sport = (struct imx_port *)port;
1896 if (!(imx_uart_readl(sport, USR2) & USR2_RDR))
1897 return NO_POLL_CHAR;
1899 return imx_uart_readl(sport, URXD0) & URXD_RX_DATA;
1902 static void imx_uart_poll_put_char(struct uart_port *port, unsigned char c)
1904 struct imx_port *sport = (struct imx_port *)port;
1905 unsigned int status;
1909 status = imx_uart_readl(sport, USR1);
1910 } while (~status & USR1_TRDY);
1913 imx_uart_writel(sport, c, URTX0);
1917 status = imx_uart_readl(sport, USR2);
1918 } while (~status & USR2_TXDC);
1922 /* called with port.lock taken and irqs off or from .probe without locking */
1923 static int imx_uart_rs485_config(struct uart_port *port,
1924 struct serial_rs485 *rs485conf)
1926 struct imx_port *sport = (struct imx_port *)port;
1929 /* RTS is required to control the transmitter */
1930 if (!sport->have_rtscts && !sport->have_rtsgpio)
1931 rs485conf->flags &= ~SER_RS485_ENABLED;
1933 if (rs485conf->flags & SER_RS485_ENABLED) {
1934 /* Enable receiver if low-active RTS signal is requested */
1935 if (sport->have_rtscts && !sport->have_rtsgpio &&
1936 !(rs485conf->flags & SER_RS485_RTS_ON_SEND))
1937 rs485conf->flags |= SER_RS485_RX_DURING_TX;
1939 /* disable transmitter */
1940 ucr2 = imx_uart_readl(sport, UCR2);
1941 if (rs485conf->flags & SER_RS485_RTS_AFTER_SEND)
1942 imx_uart_rts_active(sport, &ucr2);
1944 imx_uart_rts_inactive(sport, &ucr2);
1945 imx_uart_writel(sport, ucr2, UCR2);
1948 /* Make sure Rx is enabled in case Tx is active with Rx disabled */
1949 if (!(rs485conf->flags & SER_RS485_ENABLED) ||
1950 rs485conf->flags & SER_RS485_RX_DURING_TX)
1951 imx_uart_start_rx(port);
1953 port->rs485 = *rs485conf;
1958 static const struct uart_ops imx_uart_pops = {
1959 .tx_empty = imx_uart_tx_empty,
1960 .set_mctrl = imx_uart_set_mctrl,
1961 .get_mctrl = imx_uart_get_mctrl,
1962 .stop_tx = imx_uart_stop_tx,
1963 .start_tx = imx_uart_start_tx,
1964 .stop_rx = imx_uart_stop_rx,
1965 .enable_ms = imx_uart_enable_ms,
1966 .break_ctl = imx_uart_break_ctl,
1967 .startup = imx_uart_startup,
1968 .shutdown = imx_uart_shutdown,
1969 .flush_buffer = imx_uart_flush_buffer,
1970 .set_termios = imx_uart_set_termios,
1971 .type = imx_uart_type,
1972 .config_port = imx_uart_config_port,
1973 .verify_port = imx_uart_verify_port,
1974 #if defined(CONFIG_CONSOLE_POLL)
1975 .poll_init = imx_uart_poll_init,
1976 .poll_get_char = imx_uart_poll_get_char,
1977 .poll_put_char = imx_uart_poll_put_char,
1981 static struct imx_port *imx_uart_ports[UART_NR];
1983 #if IS_ENABLED(CONFIG_SERIAL_IMX_CONSOLE)
1984 static void imx_uart_console_putchar(struct uart_port *port, int ch)
1986 struct imx_port *sport = (struct imx_port *)port;
1988 while (imx_uart_readl(sport, imx_uart_uts_reg(sport)) & UTS_TXFULL)
1991 imx_uart_writel(sport, ch, URTX0);
1995 * Interrupts are disabled on entering
1998 imx_uart_console_write(struct console *co, const char *s, unsigned int count)
2000 struct imx_port *sport = imx_uart_ports[co->index];
2001 struct imx_port_ucrs old_ucr;
2003 unsigned long flags = 0;
2007 retval = clk_enable(sport->clk_per);
2010 retval = clk_enable(sport->clk_ipg);
2012 clk_disable(sport->clk_per);
2016 if (sport->port.sysrq)
2018 else if (oops_in_progress)
2019 locked = spin_trylock_irqsave(&sport->port.lock, flags);
2021 spin_lock_irqsave(&sport->port.lock, flags);
2024 * First, save UCR1/2/3 and then disable interrupts
2026 imx_uart_ucrs_save(sport, &old_ucr);
2027 ucr1 = old_ucr.ucr1;
2029 if (imx_uart_is_imx1(sport))
2030 ucr1 |= IMX1_UCR1_UARTCLKEN;
2031 ucr1 |= UCR1_UARTEN;
2032 ucr1 &= ~(UCR1_TRDYEN | UCR1_RRDYEN | UCR1_RTSDEN);
2034 imx_uart_writel(sport, ucr1, UCR1);
2036 imx_uart_writel(sport, old_ucr.ucr2 | UCR2_TXEN, UCR2);
2038 uart_console_write(&sport->port, s, count, imx_uart_console_putchar);
2041 * Finally, wait for transmitter to become empty
2042 * and restore UCR1/2/3
2044 while (!(imx_uart_readl(sport, USR2) & USR2_TXDC));
2046 imx_uart_ucrs_restore(sport, &old_ucr);
2049 spin_unlock_irqrestore(&sport->port.lock, flags);
2051 clk_disable(sport->clk_ipg);
2052 clk_disable(sport->clk_per);
2056 * If the port was already initialised (eg, by a boot loader),
2057 * try to determine the current setup.
2060 imx_uart_console_get_options(struct imx_port *sport, int *baud,
2061 int *parity, int *bits)
2064 if (imx_uart_readl(sport, UCR1) & UCR1_UARTEN) {
2065 /* ok, the port was enabled */
2066 unsigned int ucr2, ubir, ubmr, uartclk;
2067 unsigned int baud_raw;
2068 unsigned int ucfr_rfdiv;
2070 ucr2 = imx_uart_readl(sport, UCR2);
2073 if (ucr2 & UCR2_PREN) {
2074 if (ucr2 & UCR2_PROE)
2085 ubir = imx_uart_readl(sport, UBIR) & 0xffff;
2086 ubmr = imx_uart_readl(sport, UBMR) & 0xffff;
2088 ucfr_rfdiv = (imx_uart_readl(sport, UFCR) & UFCR_RFDIV) >> 7;
2089 if (ucfr_rfdiv == 6)
2092 ucfr_rfdiv = 6 - ucfr_rfdiv;
2094 uartclk = clk_get_rate(sport->clk_per);
2095 uartclk /= ucfr_rfdiv;
2098 * The next code provides exact computation of
2099 * baud_raw = round(((uartclk/16) * (ubir + 1)) / (ubmr + 1))
2100 * without need of float support or long long division,
2101 * which would be required to prevent 32bit arithmetic overflow
2103 unsigned int mul = ubir + 1;
2104 unsigned int div = 16 * (ubmr + 1);
2105 unsigned int rem = uartclk % div;
2107 baud_raw = (uartclk / div) * mul;
2108 baud_raw += (rem * mul + div / 2) / div;
2109 *baud = (baud_raw + 50) / 100 * 100;
2112 if (*baud != baud_raw)
2113 dev_info(sport->port.dev, "Console IMX rounded baud rate from %d to %d\n",
2119 imx_uart_console_setup(struct console *co, char *options)
2121 struct imx_port *sport;
2129 * Check whether an invalid uart number has been specified, and
2130 * if so, search for the first available port that does have
2133 if (co->index == -1 || co->index >= ARRAY_SIZE(imx_uart_ports))
2135 sport = imx_uart_ports[co->index];
2139 /* For setting the registers, we only need to enable the ipg clock. */
2140 retval = clk_prepare_enable(sport->clk_ipg);
2145 uart_parse_options(options, &baud, &parity, &bits, &flow);
2147 imx_uart_console_get_options(sport, &baud, &parity, &bits);
2149 imx_uart_setup_ufcr(sport, TXTL_DEFAULT, RXTL_DEFAULT);
2151 retval = uart_set_options(&sport->port, co, baud, parity, bits, flow);
2153 clk_disable(sport->clk_ipg);
2155 clk_unprepare(sport->clk_ipg);
2159 retval = clk_prepare(sport->clk_per);
2161 clk_unprepare(sport->clk_ipg);
2167 static struct uart_driver imx_uart_uart_driver;
2168 static struct console imx_uart_console = {
2170 .write = imx_uart_console_write,
2171 .device = uart_console_device,
2172 .setup = imx_uart_console_setup,
2173 .flags = CON_PRINTBUFFER,
2175 .data = &imx_uart_uart_driver,
2178 #define IMX_CONSOLE &imx_uart_console
2181 #define IMX_CONSOLE NULL
2184 static struct uart_driver imx_uart_uart_driver = {
2185 .owner = THIS_MODULE,
2186 .driver_name = DRIVER_NAME,
2187 .dev_name = DEV_NAME,
2188 .major = SERIAL_IMX_MAJOR,
2189 .minor = MINOR_START,
2190 .nr = ARRAY_SIZE(imx_uart_ports),
2191 .cons = IMX_CONSOLE,
2196 * This function returns 1 iff pdev isn't a device instatiated by dt, 0 iff it
2197 * could successfully get all information from dt or a negative errno.
2199 static int imx_uart_probe_dt(struct imx_port *sport,
2200 struct platform_device *pdev)
2202 struct device_node *np = pdev->dev.of_node;
2205 sport->devdata = of_device_get_match_data(&pdev->dev);
2206 if (!sport->devdata)
2207 /* no device tree device */
2210 ret = of_alias_get_id(np, "serial");
2212 dev_err(&pdev->dev, "failed to get alias id, errno %d\n", ret);
2215 sport->port.line = ret;
2217 if (of_get_property(np, "uart-has-rtscts", NULL) ||
2218 of_get_property(np, "fsl,uart-has-rtscts", NULL) /* deprecated */)
2219 sport->have_rtscts = 1;
2221 if (of_get_property(np, "fsl,dte-mode", NULL))
2222 sport->dte_mode = 1;
2224 if (of_get_property(np, "rts-gpios", NULL))
2225 sport->have_rtsgpio = 1;
2227 if (of_get_property(np, "fsl,inverted-tx", NULL))
2228 sport->inverted_tx = 1;
2230 if (of_get_property(np, "fsl,inverted-rx", NULL))
2231 sport->inverted_rx = 1;
2236 static inline int imx_uart_probe_dt(struct imx_port *sport,
2237 struct platform_device *pdev)
2243 static void imx_uart_probe_pdata(struct imx_port *sport,
2244 struct platform_device *pdev)
2246 struct imxuart_platform_data *pdata = dev_get_platdata(&pdev->dev);
2248 sport->port.line = pdev->id;
2249 sport->devdata = (struct imx_uart_data *) pdev->id_entry->driver_data;
2254 if (pdata->flags & IMXUART_HAVE_RTSCTS)
2255 sport->have_rtscts = 1;
2258 static enum hrtimer_restart imx_trigger_start_tx(struct hrtimer *t)
2260 struct imx_port *sport = container_of(t, struct imx_port, trigger_start_tx);
2261 unsigned long flags;
2263 spin_lock_irqsave(&sport->port.lock, flags);
2264 if (sport->tx_state == WAIT_AFTER_RTS)
2265 imx_uart_start_tx(&sport->port);
2266 spin_unlock_irqrestore(&sport->port.lock, flags);
2268 return HRTIMER_NORESTART;
2271 static enum hrtimer_restart imx_trigger_stop_tx(struct hrtimer *t)
2273 struct imx_port *sport = container_of(t, struct imx_port, trigger_stop_tx);
2274 unsigned long flags;
2276 spin_lock_irqsave(&sport->port.lock, flags);
2277 if (sport->tx_state == WAIT_AFTER_SEND)
2278 imx_uart_stop_tx(&sport->port);
2279 spin_unlock_irqrestore(&sport->port.lock, flags);
2281 return HRTIMER_NORESTART;
2284 static int imx_uart_probe(struct platform_device *pdev)
2286 struct imx_port *sport;
2290 struct resource *res;
2291 int txirq, rxirq, rtsirq;
2293 sport = devm_kzalloc(&pdev->dev, sizeof(*sport), GFP_KERNEL);
2297 ret = imx_uart_probe_dt(sport, pdev);
2299 imx_uart_probe_pdata(sport, pdev);
2303 if (sport->port.line >= ARRAY_SIZE(imx_uart_ports)) {
2304 dev_err(&pdev->dev, "serial%d out of range\n",
2309 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
2310 base = devm_ioremap_resource(&pdev->dev, res);
2312 return PTR_ERR(base);
2314 rxirq = platform_get_irq(pdev, 0);
2317 txirq = platform_get_irq_optional(pdev, 1);
2318 rtsirq = platform_get_irq_optional(pdev, 2);
2320 sport->port.dev = &pdev->dev;
2321 sport->port.mapbase = res->start;
2322 sport->port.membase = base;
2323 sport->port.type = PORT_IMX,
2324 sport->port.iotype = UPIO_MEM;
2325 sport->port.irq = rxirq;
2326 sport->port.fifosize = 32;
2327 sport->port.has_sysrq = IS_ENABLED(CONFIG_SERIAL_IMX_CONSOLE);
2328 sport->port.ops = &imx_uart_pops;
2329 sport->port.rs485_config = imx_uart_rs485_config;
2330 sport->port.flags = UPF_BOOT_AUTOCONF;
2331 timer_setup(&sport->timer, imx_uart_timeout, 0);
2333 sport->gpios = mctrl_gpio_init(&sport->port, 0);
2334 if (IS_ERR(sport->gpios))
2335 return PTR_ERR(sport->gpios);
2337 sport->clk_ipg = devm_clk_get(&pdev->dev, "ipg");
2338 if (IS_ERR(sport->clk_ipg)) {
2339 ret = PTR_ERR(sport->clk_ipg);
2340 dev_err(&pdev->dev, "failed to get ipg clk: %d\n", ret);
2344 sport->clk_per = devm_clk_get(&pdev->dev, "per");
2345 if (IS_ERR(sport->clk_per)) {
2346 ret = PTR_ERR(sport->clk_per);
2347 dev_err(&pdev->dev, "failed to get per clk: %d\n", ret);
2351 sport->port.uartclk = clk_get_rate(sport->clk_per);
2353 /* For register access, we only need to enable the ipg clock. */
2354 ret = clk_prepare_enable(sport->clk_ipg);
2356 dev_err(&pdev->dev, "failed to enable per clk: %d\n", ret);
2360 /* initialize shadow register values */
2361 sport->ucr1 = readl(sport->port.membase + UCR1);
2362 sport->ucr2 = readl(sport->port.membase + UCR2);
2363 sport->ucr3 = readl(sport->port.membase + UCR3);
2364 sport->ucr4 = readl(sport->port.membase + UCR4);
2365 sport->ufcr = readl(sport->port.membase + UFCR);
2367 ret = uart_get_rs485_mode(&sport->port);
2369 clk_disable_unprepare(sport->clk_ipg);
2373 if (sport->port.rs485.flags & SER_RS485_ENABLED &&
2374 (!sport->have_rtscts && !sport->have_rtsgpio))
2375 dev_err(&pdev->dev, "no RTS control, disabling rs485\n");
2378 * If using the i.MX UART RTS/CTS control then the RTS (CTS_B)
2379 * signal cannot be set low during transmission in case the
2380 * receiver is off (limitation of the i.MX UART IP).
2382 if (sport->port.rs485.flags & SER_RS485_ENABLED &&
2383 sport->have_rtscts && !sport->have_rtsgpio &&
2384 (!(sport->port.rs485.flags & SER_RS485_RTS_ON_SEND) &&
2385 !(sport->port.rs485.flags & SER_RS485_RX_DURING_TX)))
2387 "low-active RTS not possible when receiver is off, enabling receiver\n");
2389 imx_uart_rs485_config(&sport->port, &sport->port.rs485);
2391 /* Disable interrupts before requesting them */
2392 ucr1 = imx_uart_readl(sport, UCR1);
2393 ucr1 &= ~(UCR1_ADEN | UCR1_TRDYEN | UCR1_IDEN | UCR1_RRDYEN | UCR1_RTSDEN);
2394 imx_uart_writel(sport, ucr1, UCR1);
2396 if (!imx_uart_is_imx1(sport) && sport->dte_mode) {
2398 * The DCEDTE bit changes the direction of DSR, DCD, DTR and RI
2399 * and influences if UCR3_RI and UCR3_DCD changes the level of RI
2400 * and DCD (when they are outputs) or enables the respective
2401 * irqs. So set this bit early, i.e. before requesting irqs.
2403 u32 ufcr = imx_uart_readl(sport, UFCR);
2404 if (!(ufcr & UFCR_DCEDTE))
2405 imx_uart_writel(sport, ufcr | UFCR_DCEDTE, UFCR);
2408 * Disable UCR3_RI and UCR3_DCD irqs. They are also not
2409 * enabled later because they cannot be cleared
2410 * (confirmed on i.MX25) which makes them unusable.
2412 imx_uart_writel(sport,
2413 IMX21_UCR3_RXDMUXSEL | UCR3_ADNIMP | UCR3_DSR,
2417 u32 ucr3 = UCR3_DSR;
2418 u32 ufcr = imx_uart_readl(sport, UFCR);
2419 if (ufcr & UFCR_DCEDTE)
2420 imx_uart_writel(sport, ufcr & ~UFCR_DCEDTE, UFCR);
2422 if (!imx_uart_is_imx1(sport))
2423 ucr3 |= IMX21_UCR3_RXDMUXSEL | UCR3_ADNIMP;
2424 imx_uart_writel(sport, ucr3, UCR3);
2427 clk_disable_unprepare(sport->clk_ipg);
2429 hrtimer_init(&sport->trigger_start_tx, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
2430 hrtimer_init(&sport->trigger_stop_tx, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
2431 sport->trigger_start_tx.function = imx_trigger_start_tx;
2432 sport->trigger_stop_tx.function = imx_trigger_stop_tx;
2435 * Allocate the IRQ(s) i.MX1 has three interrupts whereas later
2436 * chips only have one interrupt.
2439 ret = devm_request_irq(&pdev->dev, rxirq, imx_uart_rxint, 0,
2440 dev_name(&pdev->dev), sport);
2442 dev_err(&pdev->dev, "failed to request rx irq: %d\n",
2447 ret = devm_request_irq(&pdev->dev, txirq, imx_uart_txint, 0,
2448 dev_name(&pdev->dev), sport);
2450 dev_err(&pdev->dev, "failed to request tx irq: %d\n",
2455 ret = devm_request_irq(&pdev->dev, rtsirq, imx_uart_rtsint, 0,
2456 dev_name(&pdev->dev), sport);
2458 dev_err(&pdev->dev, "failed to request rts irq: %d\n",
2463 ret = devm_request_irq(&pdev->dev, rxirq, imx_uart_int, 0,
2464 dev_name(&pdev->dev), sport);
2466 dev_err(&pdev->dev, "failed to request irq: %d\n", ret);
2471 imx_uart_ports[sport->port.line] = sport;
2473 platform_set_drvdata(pdev, sport);
2475 return uart_add_one_port(&imx_uart_uart_driver, &sport->port);
2478 static int imx_uart_remove(struct platform_device *pdev)
2480 struct imx_port *sport = platform_get_drvdata(pdev);
2482 return uart_remove_one_port(&imx_uart_uart_driver, &sport->port);
2485 static void imx_uart_restore_context(struct imx_port *sport)
2487 unsigned long flags;
2489 spin_lock_irqsave(&sport->port.lock, flags);
2490 if (!sport->context_saved) {
2491 spin_unlock_irqrestore(&sport->port.lock, flags);
2495 imx_uart_writel(sport, sport->saved_reg[4], UFCR);
2496 imx_uart_writel(sport, sport->saved_reg[5], UESC);
2497 imx_uart_writel(sport, sport->saved_reg[6], UTIM);
2498 imx_uart_writel(sport, sport->saved_reg[7], UBIR);
2499 imx_uart_writel(sport, sport->saved_reg[8], UBMR);
2500 imx_uart_writel(sport, sport->saved_reg[9], IMX21_UTS);
2501 imx_uart_writel(sport, sport->saved_reg[0], UCR1);
2502 imx_uart_writel(sport, sport->saved_reg[1] | UCR2_SRST, UCR2);
2503 imx_uart_writel(sport, sport->saved_reg[2], UCR3);
2504 imx_uart_writel(sport, sport->saved_reg[3], UCR4);
2505 sport->context_saved = false;
2506 spin_unlock_irqrestore(&sport->port.lock, flags);
2509 static void imx_uart_save_context(struct imx_port *sport)
2511 unsigned long flags;
2513 /* Save necessary regs */
2514 spin_lock_irqsave(&sport->port.lock, flags);
2515 sport->saved_reg[0] = imx_uart_readl(sport, UCR1);
2516 sport->saved_reg[1] = imx_uart_readl(sport, UCR2);
2517 sport->saved_reg[2] = imx_uart_readl(sport, UCR3);
2518 sport->saved_reg[3] = imx_uart_readl(sport, UCR4);
2519 sport->saved_reg[4] = imx_uart_readl(sport, UFCR);
2520 sport->saved_reg[5] = imx_uart_readl(sport, UESC);
2521 sport->saved_reg[6] = imx_uart_readl(sport, UTIM);
2522 sport->saved_reg[7] = imx_uart_readl(sport, UBIR);
2523 sport->saved_reg[8] = imx_uart_readl(sport, UBMR);
2524 sport->saved_reg[9] = imx_uart_readl(sport, IMX21_UTS);
2525 sport->context_saved = true;
2526 spin_unlock_irqrestore(&sport->port.lock, flags);
2529 static void imx_uart_enable_wakeup(struct imx_port *sport, bool on)
2533 ucr3 = imx_uart_readl(sport, UCR3);
2535 imx_uart_writel(sport, USR1_AWAKE, USR1);
2536 ucr3 |= UCR3_AWAKEN;
2538 ucr3 &= ~UCR3_AWAKEN;
2540 imx_uart_writel(sport, ucr3, UCR3);
2542 if (sport->have_rtscts) {
2543 u32 ucr1 = imx_uart_readl(sport, UCR1);
2545 ucr1 |= UCR1_RTSDEN;
2547 ucr1 &= ~UCR1_RTSDEN;
2548 imx_uart_writel(sport, ucr1, UCR1);
2552 static int imx_uart_suspend_noirq(struct device *dev)
2554 struct imx_port *sport = dev_get_drvdata(dev);
2556 imx_uart_save_context(sport);
2558 clk_disable(sport->clk_ipg);
2560 pinctrl_pm_select_sleep_state(dev);
2565 static int imx_uart_resume_noirq(struct device *dev)
2567 struct imx_port *sport = dev_get_drvdata(dev);
2570 pinctrl_pm_select_default_state(dev);
2572 ret = clk_enable(sport->clk_ipg);
2576 imx_uart_restore_context(sport);
2581 static int imx_uart_suspend(struct device *dev)
2583 struct imx_port *sport = dev_get_drvdata(dev);
2586 uart_suspend_port(&imx_uart_uart_driver, &sport->port);
2587 disable_irq(sport->port.irq);
2589 ret = clk_prepare_enable(sport->clk_ipg);
2593 /* enable wakeup from i.MX UART */
2594 imx_uart_enable_wakeup(sport, true);
2599 static int imx_uart_resume(struct device *dev)
2601 struct imx_port *sport = dev_get_drvdata(dev);
2603 /* disable wakeup from i.MX UART */
2604 imx_uart_enable_wakeup(sport, false);
2606 uart_resume_port(&imx_uart_uart_driver, &sport->port);
2607 enable_irq(sport->port.irq);
2609 clk_disable_unprepare(sport->clk_ipg);
2614 static int imx_uart_freeze(struct device *dev)
2616 struct imx_port *sport = dev_get_drvdata(dev);
2618 uart_suspend_port(&imx_uart_uart_driver, &sport->port);
2620 return clk_prepare_enable(sport->clk_ipg);
2623 static int imx_uart_thaw(struct device *dev)
2625 struct imx_port *sport = dev_get_drvdata(dev);
2627 uart_resume_port(&imx_uart_uart_driver, &sport->port);
2629 clk_disable_unprepare(sport->clk_ipg);
2634 static const struct dev_pm_ops imx_uart_pm_ops = {
2635 .suspend_noirq = imx_uart_suspend_noirq,
2636 .resume_noirq = imx_uart_resume_noirq,
2637 .freeze_noirq = imx_uart_suspend_noirq,
2638 .restore_noirq = imx_uart_resume_noirq,
2639 .suspend = imx_uart_suspend,
2640 .resume = imx_uart_resume,
2641 .freeze = imx_uart_freeze,
2642 .thaw = imx_uart_thaw,
2643 .restore = imx_uart_thaw,
2646 static struct platform_driver imx_uart_platform_driver = {
2647 .probe = imx_uart_probe,
2648 .remove = imx_uart_remove,
2650 .id_table = imx_uart_devtype,
2653 .of_match_table = imx_uart_dt_ids,
2654 .pm = &imx_uart_pm_ops,
2658 static int __init imx_uart_init(void)
2660 int ret = uart_register_driver(&imx_uart_uart_driver);
2665 ret = platform_driver_register(&imx_uart_platform_driver);
2667 uart_unregister_driver(&imx_uart_uart_driver);
2672 static void __exit imx_uart_exit(void)
2674 platform_driver_unregister(&imx_uart_platform_driver);
2675 uart_unregister_driver(&imx_uart_uart_driver);
2678 module_init(imx_uart_init);
2679 module_exit(imx_uart_exit);
2681 MODULE_AUTHOR("Sascha Hauer");
2682 MODULE_DESCRIPTION("IMX generic serial port driver");
2683 MODULE_LICENSE("GPL");
2684 MODULE_ALIAS("platform:imx-uart");