1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) Maxime Coquelin 2015
4 * Copyright (C) STMicroelectronics SA 2017
8 * Inspired by st-asc.c from STMicroelectronics (c)
11 #include <linux/clk.h>
12 #include <linux/console.h>
13 #include <linux/delay.h>
14 #include <linux/dma-direction.h>
15 #include <linux/dmaengine.h>
16 #include <linux/dma-mapping.h>
18 #include <linux/iopoll.h>
19 #include <linux/irq.h>
20 #include <linux/module.h>
22 #include <linux/of_platform.h>
23 #include <linux/pinctrl/consumer.h>
24 #include <linux/platform_device.h>
25 #include <linux/pm_runtime.h>
26 #include <linux/pm_wakeirq.h>
27 #include <linux/serial_core.h>
28 #include <linux/serial.h>
29 #include <linux/spinlock.h>
30 #include <linux/sysrq.h>
31 #include <linux/tty_flip.h>
32 #include <linux/tty.h>
34 #include "serial_mctrl_gpio.h"
35 #include "stm32-usart.h"
37 static void stm32_stop_tx(struct uart_port *port);
38 static void stm32_transmit_chars(struct uart_port *port);
40 static inline struct stm32_port *to_stm32_port(struct uart_port *port)
42 return container_of(port, struct stm32_port, port);
45 static void stm32_set_bits(struct uart_port *port, u32 reg, u32 bits)
49 val = readl_relaxed(port->membase + reg);
51 writel_relaxed(val, port->membase + reg);
54 static void stm32_clr_bits(struct uart_port *port, u32 reg, u32 bits)
58 val = readl_relaxed(port->membase + reg);
60 writel_relaxed(val, port->membase + reg);
63 static void stm32_config_reg_rs485(u32 *cr1, u32 *cr3, u32 delay_ADE,
64 u32 delay_DDE, u32 baud)
67 u32 rs485_deat_dedt_max = (USART_CR1_DEAT_MASK >> USART_CR1_DEAT_SHIFT);
70 *cr3 |= USART_CR3_DEM;
71 over8 = *cr1 & USART_CR1_OVER8;
74 rs485_deat_dedt = delay_ADE * baud * 8;
76 rs485_deat_dedt = delay_ADE * baud * 16;
78 rs485_deat_dedt = DIV_ROUND_CLOSEST(rs485_deat_dedt, 1000);
79 rs485_deat_dedt = rs485_deat_dedt > rs485_deat_dedt_max ?
80 rs485_deat_dedt_max : rs485_deat_dedt;
81 rs485_deat_dedt = (rs485_deat_dedt << USART_CR1_DEAT_SHIFT) &
83 *cr1 |= rs485_deat_dedt;
86 rs485_deat_dedt = delay_DDE * baud * 8;
88 rs485_deat_dedt = delay_DDE * baud * 16;
90 rs485_deat_dedt = DIV_ROUND_CLOSEST(rs485_deat_dedt, 1000);
91 rs485_deat_dedt = rs485_deat_dedt > rs485_deat_dedt_max ?
92 rs485_deat_dedt_max : rs485_deat_dedt;
93 rs485_deat_dedt = (rs485_deat_dedt << USART_CR1_DEDT_SHIFT) &
95 *cr1 |= rs485_deat_dedt;
98 static int stm32_config_rs485(struct uart_port *port,
99 struct serial_rs485 *rs485conf)
101 struct stm32_port *stm32_port = to_stm32_port(port);
102 struct stm32_usart_offsets *ofs = &stm32_port->info->ofs;
103 struct stm32_usart_config *cfg = &stm32_port->info->cfg;
104 u32 usartdiv, baud, cr1, cr3;
107 stm32_clr_bits(port, ofs->cr1, BIT(cfg->uart_enable_bit));
109 port->rs485 = *rs485conf;
111 rs485conf->flags |= SER_RS485_RX_DURING_TX;
113 if (rs485conf->flags & SER_RS485_ENABLED) {
114 cr1 = readl_relaxed(port->membase + ofs->cr1);
115 cr3 = readl_relaxed(port->membase + ofs->cr3);
116 usartdiv = readl_relaxed(port->membase + ofs->brr);
117 usartdiv = usartdiv & GENMASK(15, 0);
118 over8 = cr1 & USART_CR1_OVER8;
121 usartdiv = usartdiv | (usartdiv & GENMASK(4, 0))
122 << USART_BRR_04_R_SHIFT;
124 baud = DIV_ROUND_CLOSEST(port->uartclk, usartdiv);
125 stm32_config_reg_rs485(&cr1, &cr3,
126 rs485conf->delay_rts_before_send,
127 rs485conf->delay_rts_after_send, baud);
129 if (rs485conf->flags & SER_RS485_RTS_ON_SEND) {
130 cr3 &= ~USART_CR3_DEP;
131 rs485conf->flags &= ~SER_RS485_RTS_AFTER_SEND;
133 cr3 |= USART_CR3_DEP;
134 rs485conf->flags |= SER_RS485_RTS_AFTER_SEND;
137 writel_relaxed(cr3, port->membase + ofs->cr3);
138 writel_relaxed(cr1, port->membase + ofs->cr1);
140 stm32_clr_bits(port, ofs->cr3, USART_CR3_DEM | USART_CR3_DEP);
141 stm32_clr_bits(port, ofs->cr1,
142 USART_CR1_DEDT_MASK | USART_CR1_DEAT_MASK);
145 stm32_set_bits(port, ofs->cr1, BIT(cfg->uart_enable_bit));
150 static int stm32_init_rs485(struct uart_port *port,
151 struct platform_device *pdev)
153 struct serial_rs485 *rs485conf = &port->rs485;
155 rs485conf->flags = 0;
156 rs485conf->delay_rts_before_send = 0;
157 rs485conf->delay_rts_after_send = 0;
159 if (!pdev->dev.of_node)
162 return uart_get_rs485_mode(port);
165 static int stm32_pending_rx(struct uart_port *port, u32 *sr, int *last_res,
168 struct stm32_port *stm32_port = to_stm32_port(port);
169 struct stm32_usart_offsets *ofs = &stm32_port->info->ofs;
170 enum dma_status status;
171 struct dma_tx_state state;
173 *sr = readl_relaxed(port->membase + ofs->isr);
175 if (threaded && stm32_port->rx_ch) {
176 status = dmaengine_tx_status(stm32_port->rx_ch,
177 stm32_port->rx_ch->cookie,
179 if ((status == DMA_IN_PROGRESS) &&
180 (*last_res != state.residue))
184 } else if (*sr & USART_SR_RXNE) {
190 static unsigned long stm32_get_char(struct uart_port *port, u32 *sr,
193 struct stm32_port *stm32_port = to_stm32_port(port);
194 struct stm32_usart_offsets *ofs = &stm32_port->info->ofs;
197 if (stm32_port->rx_ch) {
198 c = stm32_port->rx_buf[RX_BUF_L - (*last_res)--];
199 if ((*last_res) == 0)
200 *last_res = RX_BUF_L;
202 c = readl_relaxed(port->membase + ofs->rdr);
203 /* apply RDR data mask */
204 c &= stm32_port->rdr_mask;
210 static void stm32_receive_chars(struct uart_port *port, bool threaded)
212 struct tty_port *tport = &port->state->port;
213 struct stm32_port *stm32_port = to_stm32_port(port);
214 struct stm32_usart_offsets *ofs = &stm32_port->info->ofs;
219 if (irqd_is_wakeup_set(irq_get_irq_data(port->irq)))
220 pm_wakeup_event(tport->tty->dev, 0);
222 while (stm32_pending_rx(port, &sr, &stm32_port->last_res, threaded)) {
223 sr |= USART_SR_DUMMY_RX;
227 * Status bits has to be cleared before reading the RDR:
228 * In FIFO mode, reading the RDR will pop the next data
229 * (if any) along with its status bits into the SR.
230 * Not doing so leads to misalignement between RDR and SR,
231 * and clear status bits of the next rx data.
233 * Clear errors flags for stm32f7 and stm32h7 compatible
234 * devices. On stm32f4 compatible devices, the error bit is
235 * cleared by the sequence [read SR - read DR].
237 if ((sr & USART_SR_ERR_MASK) && ofs->icr != UNDEF_REG)
238 writel_relaxed(sr & USART_SR_ERR_MASK,
239 port->membase + ofs->icr);
241 c = stm32_get_char(port, &sr, &stm32_port->last_res);
243 if (sr & USART_SR_ERR_MASK) {
244 if (sr & USART_SR_ORE) {
245 port->icount.overrun++;
246 } else if (sr & USART_SR_PE) {
247 port->icount.parity++;
248 } else if (sr & USART_SR_FE) {
249 /* Break detection if character is null */
252 if (uart_handle_break(port))
255 port->icount.frame++;
259 sr &= port->read_status_mask;
261 if (sr & USART_SR_PE) {
263 } else if (sr & USART_SR_FE) {
271 if (uart_handle_sysrq_char(port, c))
273 uart_insert_char(port, sr, USART_SR_ORE, c, flag);
276 spin_unlock(&port->lock);
277 tty_flip_buffer_push(tport);
278 spin_lock(&port->lock);
281 static void stm32_tx_dma_complete(void *arg)
283 struct uart_port *port = arg;
284 struct stm32_port *stm32port = to_stm32_port(port);
285 struct stm32_usart_offsets *ofs = &stm32port->info->ofs;
287 stm32_clr_bits(port, ofs->cr3, USART_CR3_DMAT);
288 stm32port->tx_dma_busy = false;
290 /* Let's see if we have pending data to send */
291 stm32_transmit_chars(port);
294 static void stm32_tx_interrupt_enable(struct uart_port *port)
296 struct stm32_port *stm32_port = to_stm32_port(port);
297 struct stm32_usart_offsets *ofs = &stm32_port->info->ofs;
300 * Enables TX FIFO threashold irq when FIFO is enabled,
301 * or TX empty irq when FIFO is disabled
303 if (stm32_port->fifoen)
304 stm32_set_bits(port, ofs->cr3, USART_CR3_TXFTIE);
306 stm32_set_bits(port, ofs->cr1, USART_CR1_TXEIE);
309 static void stm32_tx_interrupt_disable(struct uart_port *port)
311 struct stm32_port *stm32_port = to_stm32_port(port);
312 struct stm32_usart_offsets *ofs = &stm32_port->info->ofs;
314 if (stm32_port->fifoen)
315 stm32_clr_bits(port, ofs->cr3, USART_CR3_TXFTIE);
317 stm32_clr_bits(port, ofs->cr1, USART_CR1_TXEIE);
320 static void stm32_transmit_chars_pio(struct uart_port *port)
322 struct stm32_port *stm32_port = to_stm32_port(port);
323 struct stm32_usart_offsets *ofs = &stm32_port->info->ofs;
324 struct circ_buf *xmit = &port->state->xmit;
326 if (stm32_port->tx_dma_busy) {
327 stm32_clr_bits(port, ofs->cr3, USART_CR3_DMAT);
328 stm32_port->tx_dma_busy = false;
331 while (!uart_circ_empty(xmit)) {
332 /* Check that TDR is empty before filling FIFO */
333 if (!(readl_relaxed(port->membase + ofs->isr) & USART_SR_TXE))
335 writel_relaxed(xmit->buf[xmit->tail], port->membase + ofs->tdr);
336 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
340 /* rely on TXE irq (mask or unmask) for sending remaining data */
341 if (uart_circ_empty(xmit))
342 stm32_tx_interrupt_disable(port);
344 stm32_tx_interrupt_enable(port);
347 static void stm32_transmit_chars_dma(struct uart_port *port)
349 struct stm32_port *stm32port = to_stm32_port(port);
350 struct stm32_usart_offsets *ofs = &stm32port->info->ofs;
351 struct circ_buf *xmit = &port->state->xmit;
352 struct dma_async_tx_descriptor *desc = NULL;
354 unsigned int count, i;
356 if (stm32port->tx_dma_busy)
359 stm32port->tx_dma_busy = true;
361 count = uart_circ_chars_pending(xmit);
363 if (count > TX_BUF_L)
366 if (xmit->tail < xmit->head) {
367 memcpy(&stm32port->tx_buf[0], &xmit->buf[xmit->tail], count);
369 size_t one = UART_XMIT_SIZE - xmit->tail;
376 memcpy(&stm32port->tx_buf[0], &xmit->buf[xmit->tail], one);
378 memcpy(&stm32port->tx_buf[one], &xmit->buf[0], two);
381 desc = dmaengine_prep_slave_single(stm32port->tx_ch,
382 stm32port->tx_dma_buf,
388 for (i = count; i > 0; i--)
389 stm32_transmit_chars_pio(port);
393 desc->callback = stm32_tx_dma_complete;
394 desc->callback_param = port;
396 /* Push current DMA TX transaction in the pending queue */
397 cookie = dmaengine_submit(desc);
399 /* Issue pending DMA TX requests */
400 dma_async_issue_pending(stm32port->tx_ch);
402 stm32_set_bits(port, ofs->cr3, USART_CR3_DMAT);
404 xmit->tail = (xmit->tail + count) & (UART_XMIT_SIZE - 1);
405 port->icount.tx += count;
408 static void stm32_transmit_chars(struct uart_port *port)
410 struct stm32_port *stm32_port = to_stm32_port(port);
411 struct stm32_usart_offsets *ofs = &stm32_port->info->ofs;
412 struct circ_buf *xmit = &port->state->xmit;
415 if (stm32_port->tx_dma_busy)
416 stm32_clr_bits(port, ofs->cr3, USART_CR3_DMAT);
417 writel_relaxed(port->x_char, port->membase + ofs->tdr);
420 if (stm32_port->tx_dma_busy)
421 stm32_set_bits(port, ofs->cr3, USART_CR3_DMAT);
425 if (uart_circ_empty(xmit) || uart_tx_stopped(port)) {
426 stm32_tx_interrupt_disable(port);
430 if (ofs->icr == UNDEF_REG)
431 stm32_clr_bits(port, ofs->isr, USART_SR_TC);
433 writel_relaxed(USART_ICR_TCCF, port->membase + ofs->icr);
435 if (stm32_port->tx_ch)
436 stm32_transmit_chars_dma(port);
438 stm32_transmit_chars_pio(port);
440 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
441 uart_write_wakeup(port);
443 if (uart_circ_empty(xmit))
444 stm32_tx_interrupt_disable(port);
447 static irqreturn_t stm32_interrupt(int irq, void *ptr)
449 struct uart_port *port = ptr;
450 struct stm32_port *stm32_port = to_stm32_port(port);
451 struct stm32_usart_offsets *ofs = &stm32_port->info->ofs;
454 spin_lock(&port->lock);
456 sr = readl_relaxed(port->membase + ofs->isr);
458 if ((sr & USART_SR_RTOF) && ofs->icr != UNDEF_REG)
459 writel_relaxed(USART_ICR_RTOCF,
460 port->membase + ofs->icr);
462 if ((sr & USART_SR_WUF) && (ofs->icr != UNDEF_REG))
463 writel_relaxed(USART_ICR_WUCF,
464 port->membase + ofs->icr);
466 if ((sr & USART_SR_RXNE) && !(stm32_port->rx_ch))
467 stm32_receive_chars(port, false);
469 if ((sr & USART_SR_TXE) && !(stm32_port->tx_ch))
470 stm32_transmit_chars(port);
472 spin_unlock(&port->lock);
474 if (stm32_port->rx_ch)
475 return IRQ_WAKE_THREAD;
480 static irqreturn_t stm32_threaded_interrupt(int irq, void *ptr)
482 struct uart_port *port = ptr;
483 struct stm32_port *stm32_port = to_stm32_port(port);
485 spin_lock(&port->lock);
487 if (stm32_port->rx_ch)
488 stm32_receive_chars(port, true);
490 spin_unlock(&port->lock);
495 static unsigned int stm32_tx_empty(struct uart_port *port)
497 struct stm32_port *stm32_port = to_stm32_port(port);
498 struct stm32_usart_offsets *ofs = &stm32_port->info->ofs;
500 return readl_relaxed(port->membase + ofs->isr) & USART_SR_TXE;
503 static void stm32_set_mctrl(struct uart_port *port, unsigned int mctrl)
505 struct stm32_port *stm32_port = to_stm32_port(port);
506 struct stm32_usart_offsets *ofs = &stm32_port->info->ofs;
508 if ((mctrl & TIOCM_RTS) && (port->status & UPSTAT_AUTORTS))
509 stm32_set_bits(port, ofs->cr3, USART_CR3_RTSE);
511 stm32_clr_bits(port, ofs->cr3, USART_CR3_RTSE);
513 mctrl_gpio_set(stm32_port->gpios, mctrl);
516 static unsigned int stm32_get_mctrl(struct uart_port *port)
518 struct stm32_port *stm32_port = to_stm32_port(port);
521 /* This routine is used to get signals of: DCD, DSR, RI, and CTS */
522 ret = TIOCM_CAR | TIOCM_DSR | TIOCM_CTS;
524 return mctrl_gpio_get(stm32_port->gpios, &ret);
527 static void stm32_enable_ms(struct uart_port *port)
529 mctrl_gpio_enable_ms(to_stm32_port(port)->gpios);
532 static void stm32_disable_ms(struct uart_port *port)
534 mctrl_gpio_disable_ms(to_stm32_port(port)->gpios);
538 static void stm32_stop_tx(struct uart_port *port)
540 stm32_tx_interrupt_disable(port);
543 /* There are probably characters waiting to be transmitted. */
544 static void stm32_start_tx(struct uart_port *port)
546 struct circ_buf *xmit = &port->state->xmit;
548 if (uart_circ_empty(xmit))
551 stm32_transmit_chars(port);
554 /* Throttle the remote when input buffer is about to overflow. */
555 static void stm32_throttle(struct uart_port *port)
557 struct stm32_port *stm32_port = to_stm32_port(port);
558 struct stm32_usart_offsets *ofs = &stm32_port->info->ofs;
561 spin_lock_irqsave(&port->lock, flags);
562 stm32_clr_bits(port, ofs->cr1, stm32_port->cr1_irq);
563 if (stm32_port->cr3_irq)
564 stm32_clr_bits(port, ofs->cr3, stm32_port->cr3_irq);
566 spin_unlock_irqrestore(&port->lock, flags);
569 /* Unthrottle the remote, the input buffer can now accept data. */
570 static void stm32_unthrottle(struct uart_port *port)
572 struct stm32_port *stm32_port = to_stm32_port(port);
573 struct stm32_usart_offsets *ofs = &stm32_port->info->ofs;
576 spin_lock_irqsave(&port->lock, flags);
577 stm32_set_bits(port, ofs->cr1, stm32_port->cr1_irq);
578 if (stm32_port->cr3_irq)
579 stm32_set_bits(port, ofs->cr3, stm32_port->cr3_irq);
581 spin_unlock_irqrestore(&port->lock, flags);
585 static void stm32_stop_rx(struct uart_port *port)
587 struct stm32_port *stm32_port = to_stm32_port(port);
588 struct stm32_usart_offsets *ofs = &stm32_port->info->ofs;
590 stm32_clr_bits(port, ofs->cr1, stm32_port->cr1_irq);
591 if (stm32_port->cr3_irq)
592 stm32_clr_bits(port, ofs->cr3, stm32_port->cr3_irq);
596 /* Handle breaks - ignored by us */
597 static void stm32_break_ctl(struct uart_port *port, int break_state)
601 static int stm32_startup(struct uart_port *port)
603 struct stm32_port *stm32_port = to_stm32_port(port);
604 struct stm32_usart_offsets *ofs = &stm32_port->info->ofs;
605 const char *name = to_platform_device(port->dev)->name;
609 ret = request_threaded_irq(port->irq, stm32_interrupt,
610 stm32_threaded_interrupt,
611 IRQF_NO_SUSPEND, name, port);
616 if (ofs->rqr != UNDEF_REG)
617 stm32_set_bits(port, ofs->rqr, USART_RQR_RXFRQ);
619 /* Tx and RX FIFO configuration */
620 if (stm32_port->fifoen) {
621 val = readl_relaxed(port->membase + ofs->cr3);
622 val &= ~(USART_CR3_TXFTCFG_MASK | USART_CR3_RXFTCFG_MASK);
623 val |= USART_CR3_TXFTCFG_HALF << USART_CR3_TXFTCFG_SHIFT;
624 val |= USART_CR3_RXFTCFG_HALF << USART_CR3_RXFTCFG_SHIFT;
625 writel_relaxed(val, port->membase + ofs->cr3);
628 /* RX FIFO enabling */
629 val = stm32_port->cr1_irq | USART_CR1_RE;
630 if (stm32_port->fifoen)
631 val |= USART_CR1_FIFOEN;
632 stm32_set_bits(port, ofs->cr1, val);
637 static void stm32_shutdown(struct uart_port *port)
639 struct stm32_port *stm32_port = to_stm32_port(port);
640 struct stm32_usart_offsets *ofs = &stm32_port->info->ofs;
641 struct stm32_usart_config *cfg = &stm32_port->info->cfg;
645 /* Disable modem control interrupts */
646 stm32_disable_ms(port);
648 val = USART_CR1_TXEIE | USART_CR1_TE;
649 val |= stm32_port->cr1_irq | USART_CR1_RE;
650 val |= BIT(cfg->uart_enable_bit);
651 if (stm32_port->fifoen)
652 val |= USART_CR1_FIFOEN;
654 ret = readl_relaxed_poll_timeout(port->membase + ofs->isr,
655 isr, (isr & USART_SR_TC),
659 dev_err(port->dev, "transmission complete not set\n");
661 stm32_clr_bits(port, ofs->cr1, val);
663 free_irq(port->irq, port);
666 static unsigned int stm32_get_databits(struct ktermios *termios)
670 tcflag_t cflag = termios->c_cflag;
672 switch (cflag & CSIZE) {
674 * CSIZE settings are not necessarily supported in hardware.
675 * CSIZE unsupported configurations are handled here to set word length
676 * to 8 bits word as default configuration and to print debug message.
687 /* default including CS8 */
696 static void stm32_set_termios(struct uart_port *port, struct ktermios *termios,
697 struct ktermios *old)
699 struct stm32_port *stm32_port = to_stm32_port(port);
700 struct stm32_usart_offsets *ofs = &stm32_port->info->ofs;
701 struct stm32_usart_config *cfg = &stm32_port->info->cfg;
702 struct serial_rs485 *rs485conf = &port->rs485;
703 unsigned int baud, bits;
704 u32 usartdiv, mantissa, fraction, oversampling;
705 tcflag_t cflag = termios->c_cflag;
709 if (!stm32_port->hw_flow_control)
712 baud = uart_get_baud_rate(port, termios, old, 0, port->uartclk / 8);
714 spin_lock_irqsave(&port->lock, flags);
716 /* Stop serial port and reset value */
717 writel_relaxed(0, port->membase + ofs->cr1);
719 /* flush RX & TX FIFO */
720 if (ofs->rqr != UNDEF_REG)
721 stm32_set_bits(port, ofs->rqr,
722 USART_RQR_TXFRQ | USART_RQR_RXFRQ);
724 cr1 = USART_CR1_TE | USART_CR1_RE;
725 if (stm32_port->fifoen)
726 cr1 |= USART_CR1_FIFOEN;
728 cr3 = readl_relaxed(port->membase + ofs->cr3);
729 cr3 &= USART_CR3_TXFTIE | USART_CR3_RXFTCFG_MASK | USART_CR3_RXFTIE
730 | USART_CR3_TXFTCFG_MASK;
733 cr2 |= USART_CR2_STOP_2B;
735 bits = stm32_get_databits(termios);
736 stm32_port->rdr_mask = (BIT(bits) - 1);
738 if (cflag & PARENB) {
740 cr1 |= USART_CR1_PCE;
744 * Word length configuration:
745 * CS8 + parity, 9 bits word aka [M1:M0] = 0b01
746 * CS7 or (CS6 + parity), 7 bits word aka [M1:M0] = 0b10
747 * CS8 or (CS7 + parity), 8 bits word aka [M1:M0] = 0b00
748 * M0 and M1 already cleared by cr1 initialization.
752 else if ((bits == 7) && cfg->has_7bits_data)
755 dev_dbg(port->dev, "Unsupported data bits config: %u bits\n"
758 if (ofs->rtor != UNDEF_REG && (stm32_port->rx_ch ||
759 stm32_port->fifoen)) {
761 bits = bits + 3; /* 1 start bit + 2 stop bits */
763 bits = bits + 2; /* 1 start bit + 1 stop bit */
765 /* RX timeout irq to occur after last stop bit + bits */
766 stm32_port->cr1_irq = USART_CR1_RTOIE;
767 writel_relaxed(bits, port->membase + ofs->rtor);
768 cr2 |= USART_CR2_RTOEN;
769 /* Not using dma, enable fifo threshold irq */
770 if (!stm32_port->rx_ch)
771 stm32_port->cr3_irq = USART_CR3_RXFTIE;
774 cr1 |= stm32_port->cr1_irq;
775 cr3 |= stm32_port->cr3_irq;
780 port->status &= ~(UPSTAT_AUTOCTS | UPSTAT_AUTORTS);
781 if (cflag & CRTSCTS) {
782 port->status |= UPSTAT_AUTOCTS | UPSTAT_AUTORTS;
783 cr3 |= USART_CR3_CTSE | USART_CR3_RTSE;
786 /* Handle modem control interrupts */
787 if (UART_ENABLE_MS(port, termios->c_cflag))
788 stm32_enable_ms(port);
790 stm32_disable_ms(port);
792 usartdiv = DIV_ROUND_CLOSEST(port->uartclk, baud);
795 * The USART supports 16 or 8 times oversampling.
796 * By default we prefer 16 times oversampling, so that the receiver
797 * has a better tolerance to clock deviations.
798 * 8 times oversampling is only used to achieve higher speeds.
802 cr1 |= USART_CR1_OVER8;
803 stm32_set_bits(port, ofs->cr1, USART_CR1_OVER8);
806 cr1 &= ~USART_CR1_OVER8;
807 stm32_clr_bits(port, ofs->cr1, USART_CR1_OVER8);
810 mantissa = (usartdiv / oversampling) << USART_BRR_DIV_M_SHIFT;
811 fraction = usartdiv % oversampling;
812 writel_relaxed(mantissa | fraction, port->membase + ofs->brr);
814 uart_update_timeout(port, cflag, baud);
816 port->read_status_mask = USART_SR_ORE;
817 if (termios->c_iflag & INPCK)
818 port->read_status_mask |= USART_SR_PE | USART_SR_FE;
819 if (termios->c_iflag & (IGNBRK | BRKINT | PARMRK))
820 port->read_status_mask |= USART_SR_FE;
822 /* Characters to ignore */
823 port->ignore_status_mask = 0;
824 if (termios->c_iflag & IGNPAR)
825 port->ignore_status_mask = USART_SR_PE | USART_SR_FE;
826 if (termios->c_iflag & IGNBRK) {
827 port->ignore_status_mask |= USART_SR_FE;
829 * If we're ignoring parity and break indicators,
830 * ignore overruns too (for real raw support).
832 if (termios->c_iflag & IGNPAR)
833 port->ignore_status_mask |= USART_SR_ORE;
836 /* Ignore all characters if CREAD is not set */
837 if ((termios->c_cflag & CREAD) == 0)
838 port->ignore_status_mask |= USART_SR_DUMMY_RX;
840 if (stm32_port->rx_ch)
841 cr3 |= USART_CR3_DMAR;
843 if (rs485conf->flags & SER_RS485_ENABLED) {
844 stm32_config_reg_rs485(&cr1, &cr3,
845 rs485conf->delay_rts_before_send,
846 rs485conf->delay_rts_after_send, baud);
847 if (rs485conf->flags & SER_RS485_RTS_ON_SEND) {
848 cr3 &= ~USART_CR3_DEP;
849 rs485conf->flags &= ~SER_RS485_RTS_AFTER_SEND;
851 cr3 |= USART_CR3_DEP;
852 rs485conf->flags |= SER_RS485_RTS_AFTER_SEND;
856 cr3 &= ~(USART_CR3_DEM | USART_CR3_DEP);
857 cr1 &= ~(USART_CR1_DEDT_MASK | USART_CR1_DEAT_MASK);
860 writel_relaxed(cr3, port->membase + ofs->cr3);
861 writel_relaxed(cr2, port->membase + ofs->cr2);
862 writel_relaxed(cr1, port->membase + ofs->cr1);
864 stm32_set_bits(port, ofs->cr1, BIT(cfg->uart_enable_bit));
865 spin_unlock_irqrestore(&port->lock, flags);
868 static const char *stm32_type(struct uart_port *port)
870 return (port->type == PORT_STM32) ? DRIVER_NAME : NULL;
873 static void stm32_release_port(struct uart_port *port)
877 static int stm32_request_port(struct uart_port *port)
882 static void stm32_config_port(struct uart_port *port, int flags)
884 if (flags & UART_CONFIG_TYPE)
885 port->type = PORT_STM32;
889 stm32_verify_port(struct uart_port *port, struct serial_struct *ser)
891 /* No user changeable parameters */
895 static void stm32_pm(struct uart_port *port, unsigned int state,
896 unsigned int oldstate)
898 struct stm32_port *stm32port = container_of(port,
899 struct stm32_port, port);
900 struct stm32_usart_offsets *ofs = &stm32port->info->ofs;
901 struct stm32_usart_config *cfg = &stm32port->info->cfg;
902 unsigned long flags = 0;
905 case UART_PM_STATE_ON:
906 pm_runtime_get_sync(port->dev);
908 case UART_PM_STATE_OFF:
909 spin_lock_irqsave(&port->lock, flags);
910 stm32_clr_bits(port, ofs->cr1, BIT(cfg->uart_enable_bit));
911 spin_unlock_irqrestore(&port->lock, flags);
912 pm_runtime_put_sync(port->dev);
917 static const struct uart_ops stm32_uart_ops = {
918 .tx_empty = stm32_tx_empty,
919 .set_mctrl = stm32_set_mctrl,
920 .get_mctrl = stm32_get_mctrl,
921 .stop_tx = stm32_stop_tx,
922 .start_tx = stm32_start_tx,
923 .throttle = stm32_throttle,
924 .unthrottle = stm32_unthrottle,
925 .stop_rx = stm32_stop_rx,
926 .enable_ms = stm32_enable_ms,
927 .break_ctl = stm32_break_ctl,
928 .startup = stm32_startup,
929 .shutdown = stm32_shutdown,
930 .set_termios = stm32_set_termios,
933 .release_port = stm32_release_port,
934 .request_port = stm32_request_port,
935 .config_port = stm32_config_port,
936 .verify_port = stm32_verify_port,
939 static int stm32_init_port(struct stm32_port *stm32port,
940 struct platform_device *pdev)
942 struct uart_port *port = &stm32port->port;
943 struct resource *res;
946 port->iotype = UPIO_MEM;
947 port->flags = UPF_BOOT_AUTOCONF;
948 port->ops = &stm32_uart_ops;
949 port->dev = &pdev->dev;
950 port->fifosize = stm32port->info->cfg.fifosize;
951 port->has_sysrq = IS_ENABLED(CONFIG_SERIAL_STM32_CONSOLE);
953 ret = platform_get_irq(pdev, 0);
955 return ret ? : -ENODEV;
958 port->rs485_config = stm32_config_rs485;
960 ret = stm32_init_rs485(port, pdev);
964 if (stm32port->info->cfg.has_wakeup) {
965 stm32port->wakeirq = platform_get_irq(pdev, 1);
966 if (stm32port->wakeirq <= 0 && stm32port->wakeirq != -ENXIO)
967 return stm32port->wakeirq ? : -ENODEV;
970 stm32port->fifoen = stm32port->info->cfg.has_fifo;
972 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
973 port->membase = devm_ioremap_resource(&pdev->dev, res);
974 if (IS_ERR(port->membase))
975 return PTR_ERR(port->membase);
976 port->mapbase = res->start;
978 spin_lock_init(&port->lock);
980 stm32port->clk = devm_clk_get(&pdev->dev, NULL);
981 if (IS_ERR(stm32port->clk))
982 return PTR_ERR(stm32port->clk);
984 /* Ensure that clk rate is correct by enabling the clk */
985 ret = clk_prepare_enable(stm32port->clk);
989 stm32port->port.uartclk = clk_get_rate(stm32port->clk);
990 if (!stm32port->port.uartclk) {
995 stm32port->gpios = mctrl_gpio_init(&stm32port->port, 0);
996 if (IS_ERR(stm32port->gpios)) {
997 ret = PTR_ERR(stm32port->gpios);
1001 /* Both CTS/RTS gpios and "st,hw-flow-ctrl" should not be specified */
1002 if (stm32port->hw_flow_control) {
1003 if (mctrl_gpio_to_gpiod(stm32port->gpios, UART_GPIO_CTS) ||
1004 mctrl_gpio_to_gpiod(stm32port->gpios, UART_GPIO_RTS)) {
1005 dev_err(&pdev->dev, "Conflicting RTS/CTS config\n");
1014 clk_disable_unprepare(stm32port->clk);
1019 static struct stm32_port *stm32_of_get_stm32_port(struct platform_device *pdev)
1021 struct device_node *np = pdev->dev.of_node;
1027 id = of_alias_get_id(np, "serial");
1029 dev_err(&pdev->dev, "failed to get alias id, errno %d\n", id);
1033 if (WARN_ON(id >= STM32_MAX_PORTS))
1036 stm32_ports[id].hw_flow_control = of_property_read_bool(np,
1038 stm32_ports[id].port.line = id;
1039 stm32_ports[id].cr1_irq = USART_CR1_RXNEIE;
1040 stm32_ports[id].cr3_irq = 0;
1041 stm32_ports[id].last_res = RX_BUF_L;
1042 return &stm32_ports[id];
1046 static const struct of_device_id stm32_match[] = {
1047 { .compatible = "st,stm32-uart", .data = &stm32f4_info},
1048 { .compatible = "st,stm32f7-uart", .data = &stm32f7_info},
1049 { .compatible = "st,stm32h7-uart", .data = &stm32h7_info},
1053 MODULE_DEVICE_TABLE(of, stm32_match);
1056 static int stm32_of_dma_rx_probe(struct stm32_port *stm32port,
1057 struct platform_device *pdev)
1059 struct stm32_usart_offsets *ofs = &stm32port->info->ofs;
1060 struct uart_port *port = &stm32port->port;
1061 struct device *dev = &pdev->dev;
1062 struct dma_slave_config config;
1063 struct dma_async_tx_descriptor *desc = NULL;
1064 dma_cookie_t cookie;
1067 /* Request DMA RX channel */
1068 stm32port->rx_ch = dma_request_slave_channel(dev, "rx");
1069 if (!stm32port->rx_ch) {
1070 dev_info(dev, "rx dma alloc failed\n");
1073 stm32port->rx_buf = dma_alloc_coherent(&pdev->dev, RX_BUF_L,
1074 &stm32port->rx_dma_buf,
1076 if (!stm32port->rx_buf) {
1081 /* Configure DMA channel */
1082 memset(&config, 0, sizeof(config));
1083 config.src_addr = port->mapbase + ofs->rdr;
1084 config.src_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
1086 ret = dmaengine_slave_config(stm32port->rx_ch, &config);
1088 dev_err(dev, "rx dma channel config failed\n");
1093 /* Prepare a DMA cyclic transaction */
1094 desc = dmaengine_prep_dma_cyclic(stm32port->rx_ch,
1095 stm32port->rx_dma_buf,
1096 RX_BUF_L, RX_BUF_P, DMA_DEV_TO_MEM,
1097 DMA_PREP_INTERRUPT);
1099 dev_err(dev, "rx dma prep cyclic failed\n");
1104 /* No callback as dma buffer is drained on usart interrupt */
1105 desc->callback = NULL;
1106 desc->callback_param = NULL;
1108 /* Push current DMA transaction in the pending queue */
1109 cookie = dmaengine_submit(desc);
1111 /* Issue pending DMA requests */
1112 dma_async_issue_pending(stm32port->rx_ch);
1117 dma_free_coherent(&pdev->dev,
1118 RX_BUF_L, stm32port->rx_buf,
1119 stm32port->rx_dma_buf);
1122 dma_release_channel(stm32port->rx_ch);
1123 stm32port->rx_ch = NULL;
1128 static int stm32_of_dma_tx_probe(struct stm32_port *stm32port,
1129 struct platform_device *pdev)
1131 struct stm32_usart_offsets *ofs = &stm32port->info->ofs;
1132 struct uart_port *port = &stm32port->port;
1133 struct device *dev = &pdev->dev;
1134 struct dma_slave_config config;
1137 stm32port->tx_dma_busy = false;
1139 /* Request DMA TX channel */
1140 stm32port->tx_ch = dma_request_slave_channel(dev, "tx");
1141 if (!stm32port->tx_ch) {
1142 dev_info(dev, "tx dma alloc failed\n");
1145 stm32port->tx_buf = dma_alloc_coherent(&pdev->dev, TX_BUF_L,
1146 &stm32port->tx_dma_buf,
1148 if (!stm32port->tx_buf) {
1153 /* Configure DMA channel */
1154 memset(&config, 0, sizeof(config));
1155 config.dst_addr = port->mapbase + ofs->tdr;
1156 config.dst_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
1158 ret = dmaengine_slave_config(stm32port->tx_ch, &config);
1160 dev_err(dev, "tx dma channel config failed\n");
1168 dma_free_coherent(&pdev->dev,
1169 TX_BUF_L, stm32port->tx_buf,
1170 stm32port->tx_dma_buf);
1173 dma_release_channel(stm32port->tx_ch);
1174 stm32port->tx_ch = NULL;
1179 static int stm32_serial_probe(struct platform_device *pdev)
1181 const struct of_device_id *match;
1182 struct stm32_port *stm32port;
1185 stm32port = stm32_of_get_stm32_port(pdev);
1189 match = of_match_device(stm32_match, &pdev->dev);
1190 if (match && match->data)
1191 stm32port->info = (struct stm32_usart_info *)match->data;
1195 ret = stm32_init_port(stm32port, pdev);
1199 if (stm32port->wakeirq > 0) {
1200 ret = device_init_wakeup(&pdev->dev, true);
1204 ret = dev_pm_set_dedicated_wake_irq(&pdev->dev,
1205 stm32port->wakeirq);
1209 device_set_wakeup_enable(&pdev->dev, false);
1212 ret = uart_add_one_port(&stm32_usart_driver, &stm32port->port);
1216 ret = stm32_of_dma_rx_probe(stm32port, pdev);
1218 dev_info(&pdev->dev, "interrupt mode used for rx (no dma)\n");
1220 ret = stm32_of_dma_tx_probe(stm32port, pdev);
1222 dev_info(&pdev->dev, "interrupt mode used for tx (no dma)\n");
1224 platform_set_drvdata(pdev, &stm32port->port);
1226 pm_runtime_get_noresume(&pdev->dev);
1227 pm_runtime_set_active(&pdev->dev);
1228 pm_runtime_enable(&pdev->dev);
1229 pm_runtime_put_sync(&pdev->dev);
1234 if (stm32port->wakeirq > 0)
1235 dev_pm_clear_wake_irq(&pdev->dev);
1238 if (stm32port->wakeirq > 0)
1239 device_init_wakeup(&pdev->dev, false);
1242 clk_disable_unprepare(stm32port->clk);
1247 static int stm32_serial_remove(struct platform_device *pdev)
1249 struct uart_port *port = platform_get_drvdata(pdev);
1250 struct stm32_port *stm32_port = to_stm32_port(port);
1251 struct stm32_usart_offsets *ofs = &stm32_port->info->ofs;
1254 pm_runtime_get_sync(&pdev->dev);
1256 stm32_clr_bits(port, ofs->cr3, USART_CR3_DMAR);
1258 if (stm32_port->rx_ch)
1259 dma_release_channel(stm32_port->rx_ch);
1261 if (stm32_port->rx_dma_buf)
1262 dma_free_coherent(&pdev->dev,
1263 RX_BUF_L, stm32_port->rx_buf,
1264 stm32_port->rx_dma_buf);
1266 stm32_clr_bits(port, ofs->cr3, USART_CR3_DMAT);
1268 if (stm32_port->tx_ch)
1269 dma_release_channel(stm32_port->tx_ch);
1271 if (stm32_port->tx_dma_buf)
1272 dma_free_coherent(&pdev->dev,
1273 TX_BUF_L, stm32_port->tx_buf,
1274 stm32_port->tx_dma_buf);
1276 if (stm32_port->wakeirq > 0) {
1277 dev_pm_clear_wake_irq(&pdev->dev);
1278 device_init_wakeup(&pdev->dev, false);
1281 clk_disable_unprepare(stm32_port->clk);
1283 err = uart_remove_one_port(&stm32_usart_driver, port);
1285 pm_runtime_disable(&pdev->dev);
1286 pm_runtime_put_noidle(&pdev->dev);
1292 #ifdef CONFIG_SERIAL_STM32_CONSOLE
1293 static void stm32_console_putchar(struct uart_port *port, int ch)
1295 struct stm32_port *stm32_port = to_stm32_port(port);
1296 struct stm32_usart_offsets *ofs = &stm32_port->info->ofs;
1298 while (!(readl_relaxed(port->membase + ofs->isr) & USART_SR_TXE))
1301 writel_relaxed(ch, port->membase + ofs->tdr);
1304 static void stm32_console_write(struct console *co, const char *s, unsigned cnt)
1306 struct uart_port *port = &stm32_ports[co->index].port;
1307 struct stm32_port *stm32_port = to_stm32_port(port);
1308 struct stm32_usart_offsets *ofs = &stm32_port->info->ofs;
1309 struct stm32_usart_config *cfg = &stm32_port->info->cfg;
1310 unsigned long flags;
1311 u32 old_cr1, new_cr1;
1314 local_irq_save(flags);
1317 else if (oops_in_progress)
1318 locked = spin_trylock(&port->lock);
1320 spin_lock(&port->lock);
1322 /* Save and disable interrupts, enable the transmitter */
1323 old_cr1 = readl_relaxed(port->membase + ofs->cr1);
1324 new_cr1 = old_cr1 & ~USART_CR1_IE_MASK;
1325 new_cr1 |= USART_CR1_TE | BIT(cfg->uart_enable_bit);
1326 writel_relaxed(new_cr1, port->membase + ofs->cr1);
1328 uart_console_write(port, s, cnt, stm32_console_putchar);
1330 /* Restore interrupt state */
1331 writel_relaxed(old_cr1, port->membase + ofs->cr1);
1334 spin_unlock(&port->lock);
1335 local_irq_restore(flags);
1338 static int stm32_console_setup(struct console *co, char *options)
1340 struct stm32_port *stm32port;
1346 if (co->index >= STM32_MAX_PORTS)
1349 stm32port = &stm32_ports[co->index];
1352 * This driver does not support early console initialization
1353 * (use ARM early printk support instead), so we only expect
1354 * this to be called during the uart port registration when the
1355 * driver gets probed and the port should be mapped at that point.
1357 if (stm32port->port.mapbase == 0 || stm32port->port.membase == NULL)
1361 uart_parse_options(options, &baud, &parity, &bits, &flow);
1363 return uart_set_options(&stm32port->port, co, baud, parity, bits, flow);
1366 static struct console stm32_console = {
1367 .name = STM32_SERIAL_NAME,
1368 .device = uart_console_device,
1369 .write = stm32_console_write,
1370 .setup = stm32_console_setup,
1371 .flags = CON_PRINTBUFFER,
1373 .data = &stm32_usart_driver,
1376 #define STM32_SERIAL_CONSOLE (&stm32_console)
1379 #define STM32_SERIAL_CONSOLE NULL
1380 #endif /* CONFIG_SERIAL_STM32_CONSOLE */
1382 static struct uart_driver stm32_usart_driver = {
1383 .driver_name = DRIVER_NAME,
1384 .dev_name = STM32_SERIAL_NAME,
1387 .nr = STM32_MAX_PORTS,
1388 .cons = STM32_SERIAL_CONSOLE,
1391 static void __maybe_unused stm32_serial_enable_wakeup(struct uart_port *port,
1394 struct stm32_port *stm32_port = to_stm32_port(port);
1395 struct stm32_usart_offsets *ofs = &stm32_port->info->ofs;
1396 struct stm32_usart_config *cfg = &stm32_port->info->cfg;
1399 if (stm32_port->wakeirq <= 0)
1403 stm32_clr_bits(port, ofs->cr1, BIT(cfg->uart_enable_bit));
1404 stm32_set_bits(port, ofs->cr1, USART_CR1_UESM);
1405 val = readl_relaxed(port->membase + ofs->cr3);
1406 val &= ~USART_CR3_WUS_MASK;
1407 /* Enable Wake up interrupt from low power on start bit */
1408 val |= USART_CR3_WUS_START_BIT | USART_CR3_WUFIE;
1409 writel_relaxed(val, port->membase + ofs->cr3);
1410 stm32_set_bits(port, ofs->cr1, BIT(cfg->uart_enable_bit));
1412 stm32_clr_bits(port, ofs->cr1, USART_CR1_UESM);
1416 static int __maybe_unused stm32_serial_suspend(struct device *dev)
1418 struct uart_port *port = dev_get_drvdata(dev);
1420 uart_suspend_port(&stm32_usart_driver, port);
1422 if (device_may_wakeup(dev))
1423 stm32_serial_enable_wakeup(port, true);
1425 stm32_serial_enable_wakeup(port, false);
1428 * When "no_console_suspend" is enabled, keep the pinctrl default state
1429 * and rely on bootloader stage to restore this state upon resume.
1430 * Otherwise, apply the idle or sleep states depending on wakeup
1433 if (console_suspend_enabled || !uart_console(port)) {
1434 if (device_may_wakeup(dev))
1435 pinctrl_pm_select_idle_state(dev);
1437 pinctrl_pm_select_sleep_state(dev);
1443 static int __maybe_unused stm32_serial_resume(struct device *dev)
1445 struct uart_port *port = dev_get_drvdata(dev);
1447 pinctrl_pm_select_default_state(dev);
1449 if (device_may_wakeup(dev))
1450 stm32_serial_enable_wakeup(port, false);
1452 return uart_resume_port(&stm32_usart_driver, port);
1455 static int __maybe_unused stm32_serial_runtime_suspend(struct device *dev)
1457 struct uart_port *port = dev_get_drvdata(dev);
1458 struct stm32_port *stm32port = container_of(port,
1459 struct stm32_port, port);
1461 clk_disable_unprepare(stm32port->clk);
1466 static int __maybe_unused stm32_serial_runtime_resume(struct device *dev)
1468 struct uart_port *port = dev_get_drvdata(dev);
1469 struct stm32_port *stm32port = container_of(port,
1470 struct stm32_port, port);
1472 return clk_prepare_enable(stm32port->clk);
1475 static const struct dev_pm_ops stm32_serial_pm_ops = {
1476 SET_RUNTIME_PM_OPS(stm32_serial_runtime_suspend,
1477 stm32_serial_runtime_resume, NULL)
1478 SET_SYSTEM_SLEEP_PM_OPS(stm32_serial_suspend, stm32_serial_resume)
1481 static struct platform_driver stm32_serial_driver = {
1482 .probe = stm32_serial_probe,
1483 .remove = stm32_serial_remove,
1485 .name = DRIVER_NAME,
1486 .pm = &stm32_serial_pm_ops,
1487 .of_match_table = of_match_ptr(stm32_match),
1491 static int __init usart_init(void)
1493 static char banner[] __initdata = "STM32 USART driver initialized";
1496 pr_info("%s\n", banner);
1498 ret = uart_register_driver(&stm32_usart_driver);
1502 ret = platform_driver_register(&stm32_serial_driver);
1504 uart_unregister_driver(&stm32_usart_driver);
1509 static void __exit usart_exit(void)
1511 platform_driver_unregister(&stm32_serial_driver);
1512 uart_unregister_driver(&stm32_usart_driver);
1515 module_init(usart_init);
1516 module_exit(usart_exit);
1518 MODULE_ALIAS("platform:" DRIVER_NAME);
1519 MODULE_DESCRIPTION("STMicroelectronics STM32 serial port driver");
1520 MODULE_LICENSE("GPL v2");