Loading...
1// SPDX-License-Identifier: GPL-2.0+
2/*
3 * st-asc.c: ST Asynchronous serial controller (ASC) driver
4 *
5 * Copyright (C) 2003-2013 STMicroelectronics (R&D) Limited
6 */
7
8#include <linux/module.h>
9#include <linux/serial.h>
10#include <linux/console.h>
11#include <linux/sysrq.h>
12#include <linux/pinctrl/consumer.h>
13#include <linux/platform_device.h>
14#include <linux/io.h>
15#include <linux/irq.h>
16#include <linux/tty.h>
17#include <linux/tty_flip.h>
18#include <linux/delay.h>
19#include <linux/spinlock.h>
20#include <linux/of.h>
21#include <linux/of_platform.h>
22#include <linux/serial_core.h>
23#include <linux/clk.h>
24#include <linux/gpio/consumer.h>
25
26#define DRIVER_NAME "st-asc"
27#define ASC_SERIAL_NAME "ttyAS"
28#define ASC_FIFO_SIZE 16
29#define ASC_MAX_PORTS 8
30
31/* Pinctrl states */
32#define DEFAULT 0
33#define NO_HW_FLOWCTRL 1
34
35struct asc_port {
36 struct uart_port port;
37 struct gpio_desc *rts;
38 struct clk *clk;
39 struct pinctrl *pinctrl;
40 struct pinctrl_state *states[2];
41 unsigned int hw_flow_control:1;
42 unsigned int force_m1:1;
43};
44
45static struct asc_port asc_ports[ASC_MAX_PORTS];
46static struct uart_driver asc_uart_driver;
47
48/*---- UART Register definitions ------------------------------*/
49
50/* Register offsets */
51
52#define ASC_BAUDRATE 0x00
53#define ASC_TXBUF 0x04
54#define ASC_RXBUF 0x08
55#define ASC_CTL 0x0C
56#define ASC_INTEN 0x10
57#define ASC_STA 0x14
58#define ASC_GUARDTIME 0x18
59#define ASC_TIMEOUT 0x1C
60#define ASC_TXRESET 0x20
61#define ASC_RXRESET 0x24
62#define ASC_RETRIES 0x28
63
64/* ASC_RXBUF */
65#define ASC_RXBUF_PE 0x100
66#define ASC_RXBUF_FE 0x200
67/*
68 * Some of status comes from higher bits of the character and some come from
69 * the status register. Combining both of them in to single status using dummy
70 * bits.
71 */
72#define ASC_RXBUF_DUMMY_RX 0x10000
73#define ASC_RXBUF_DUMMY_BE 0x20000
74#define ASC_RXBUF_DUMMY_OE 0x40000
75
76/* ASC_CTL */
77
78#define ASC_CTL_MODE_MSK 0x0007
79#define ASC_CTL_MODE_8BIT 0x0001
80#define ASC_CTL_MODE_7BIT_PAR 0x0003
81#define ASC_CTL_MODE_9BIT 0x0004
82#define ASC_CTL_MODE_8BIT_WKUP 0x0005
83#define ASC_CTL_MODE_8BIT_PAR 0x0007
84#define ASC_CTL_STOP_MSK 0x0018
85#define ASC_CTL_STOP_HALFBIT 0x0000
86#define ASC_CTL_STOP_1BIT 0x0008
87#define ASC_CTL_STOP_1_HALFBIT 0x0010
88#define ASC_CTL_STOP_2BIT 0x0018
89#define ASC_CTL_PARITYODD 0x0020
90#define ASC_CTL_LOOPBACK 0x0040
91#define ASC_CTL_RUN 0x0080
92#define ASC_CTL_RXENABLE 0x0100
93#define ASC_CTL_SCENABLE 0x0200
94#define ASC_CTL_FIFOENABLE 0x0400
95#define ASC_CTL_CTSENABLE 0x0800
96#define ASC_CTL_BAUDMODE 0x1000
97
98/* ASC_GUARDTIME */
99
100#define ASC_GUARDTIME_MSK 0x00FF
101
102/* ASC_INTEN */
103
104#define ASC_INTEN_RBE 0x0001
105#define ASC_INTEN_TE 0x0002
106#define ASC_INTEN_THE 0x0004
107#define ASC_INTEN_PE 0x0008
108#define ASC_INTEN_FE 0x0010
109#define ASC_INTEN_OE 0x0020
110#define ASC_INTEN_TNE 0x0040
111#define ASC_INTEN_TOI 0x0080
112#define ASC_INTEN_RHF 0x0100
113
114/* ASC_RETRIES */
115
116#define ASC_RETRIES_MSK 0x00FF
117
118/* ASC_RXBUF */
119
120#define ASC_RXBUF_MSK 0x03FF
121
122/* ASC_STA */
123
124#define ASC_STA_RBF 0x0001
125#define ASC_STA_TE 0x0002
126#define ASC_STA_THE 0x0004
127#define ASC_STA_PE 0x0008
128#define ASC_STA_FE 0x0010
129#define ASC_STA_OE 0x0020
130#define ASC_STA_TNE 0x0040
131#define ASC_STA_TOI 0x0080
132#define ASC_STA_RHF 0x0100
133#define ASC_STA_TF 0x0200
134#define ASC_STA_NKD 0x0400
135
136/* ASC_TIMEOUT */
137
138#define ASC_TIMEOUT_MSK 0x00FF
139
140/* ASC_TXBUF */
141
142#define ASC_TXBUF_MSK 0x01FF
143
144/*---- Inline function definitions ---------------------------*/
145
146static inline struct asc_port *to_asc_port(struct uart_port *port)
147{
148 return container_of(port, struct asc_port, port);
149}
150
151static inline u32 asc_in(struct uart_port *port, u32 offset)
152{
153#ifdef readl_relaxed
154 return readl_relaxed(port->membase + offset);
155#else
156 return readl(port->membase + offset);
157#endif
158}
159
160static inline void asc_out(struct uart_port *port, u32 offset, u32 value)
161{
162#ifdef writel_relaxed
163 writel_relaxed(value, port->membase + offset);
164#else
165 writel(value, port->membase + offset);
166#endif
167}
168
169/*
170 * Some simple utility functions to enable and disable interrupts.
171 * Note that these need to be called with interrupts disabled.
172 */
173static inline void asc_disable_tx_interrupts(struct uart_port *port)
174{
175 u32 intenable = asc_in(port, ASC_INTEN) & ~ASC_INTEN_THE;
176 asc_out(port, ASC_INTEN, intenable);
177 (void)asc_in(port, ASC_INTEN); /* Defeat bus write posting */
178}
179
180static inline void asc_enable_tx_interrupts(struct uart_port *port)
181{
182 u32 intenable = asc_in(port, ASC_INTEN) | ASC_INTEN_THE;
183 asc_out(port, ASC_INTEN, intenable);
184}
185
186static inline void asc_disable_rx_interrupts(struct uart_port *port)
187{
188 u32 intenable = asc_in(port, ASC_INTEN) & ~ASC_INTEN_RBE;
189 asc_out(port, ASC_INTEN, intenable);
190 (void)asc_in(port, ASC_INTEN); /* Defeat bus write posting */
191}
192
193static inline void asc_enable_rx_interrupts(struct uart_port *port)
194{
195 u32 intenable = asc_in(port, ASC_INTEN) | ASC_INTEN_RBE;
196 asc_out(port, ASC_INTEN, intenable);
197}
198
199static inline u32 asc_txfifo_is_empty(struct uart_port *port)
200{
201 return asc_in(port, ASC_STA) & ASC_STA_TE;
202}
203
204static inline u32 asc_txfifo_is_half_empty(struct uart_port *port)
205{
206 return asc_in(port, ASC_STA) & ASC_STA_THE;
207}
208
209static inline const char *asc_port_name(struct uart_port *port)
210{
211 return to_platform_device(port->dev)->name;
212}
213
214/*----------------------------------------------------------------------*/
215
216/*
217 * This section contains code to support the use of the ASC as a
218 * generic serial port.
219 */
220
221static inline unsigned asc_hw_txroom(struct uart_port *port)
222{
223 u32 status = asc_in(port, ASC_STA);
224
225 if (status & ASC_STA_THE)
226 return port->fifosize / 2;
227 else if (!(status & ASC_STA_TF))
228 return 1;
229
230 return 0;
231}
232
233/*
234 * Start transmitting chars.
235 * This is called from both interrupt and task level.
236 * Either way interrupts are disabled.
237 */
238static void asc_transmit_chars(struct uart_port *port)
239{
240 u8 ch;
241
242 uart_port_tx_limited(port, ch, asc_hw_txroom(port),
243 true,
244 asc_out(port, ASC_TXBUF, ch),
245 ({}));
246}
247
248static void asc_receive_chars(struct uart_port *port)
249{
250 struct tty_port *tport = &port->state->port;
251 unsigned long status, mode;
252 unsigned long c = 0;
253 u8 flag;
254 bool ignore_pe = false;
255
256 /*
257 * Datasheet states: If the MODE field selects an 8-bit frame then
258 * this [parity error] bit is undefined. Software should ignore this
259 * bit when reading 8-bit frames.
260 */
261 mode = asc_in(port, ASC_CTL) & ASC_CTL_MODE_MSK;
262 if (mode == ASC_CTL_MODE_8BIT || mode == ASC_CTL_MODE_8BIT_PAR)
263 ignore_pe = true;
264
265 if (irqd_is_wakeup_set(irq_get_irq_data(port->irq)))
266 pm_wakeup_event(tport->tty->dev, 0);
267
268 while ((status = asc_in(port, ASC_STA)) & ASC_STA_RBF) {
269 c = asc_in(port, ASC_RXBUF) | ASC_RXBUF_DUMMY_RX;
270 flag = TTY_NORMAL;
271 port->icount.rx++;
272
273 if (status & ASC_STA_OE || c & ASC_RXBUF_FE ||
274 (c & ASC_RXBUF_PE && !ignore_pe)) {
275
276 if (c & ASC_RXBUF_FE) {
277 if (c == (ASC_RXBUF_FE | ASC_RXBUF_DUMMY_RX)) {
278 port->icount.brk++;
279 if (uart_handle_break(port))
280 continue;
281 c |= ASC_RXBUF_DUMMY_BE;
282 } else {
283 port->icount.frame++;
284 }
285 } else if (c & ASC_RXBUF_PE) {
286 port->icount.parity++;
287 }
288 /*
289 * Reading any data from the RX FIFO clears the
290 * overflow error condition.
291 */
292 if (status & ASC_STA_OE) {
293 port->icount.overrun++;
294 c |= ASC_RXBUF_DUMMY_OE;
295 }
296
297 c &= port->read_status_mask;
298
299 if (c & ASC_RXBUF_DUMMY_BE)
300 flag = TTY_BREAK;
301 else if (c & ASC_RXBUF_PE)
302 flag = TTY_PARITY;
303 else if (c & ASC_RXBUF_FE)
304 flag = TTY_FRAME;
305 }
306
307 if (uart_handle_sysrq_char(port, c & 0xff))
308 continue;
309
310 uart_insert_char(port, c, ASC_RXBUF_DUMMY_OE, c & 0xff, flag);
311 }
312
313 /* Tell the rest of the system the news. New characters! */
314 tty_flip_buffer_push(tport);
315}
316
317static irqreturn_t asc_interrupt(int irq, void *ptr)
318{
319 struct uart_port *port = ptr;
320 u32 status;
321
322 uart_port_lock(port);
323
324 status = asc_in(port, ASC_STA);
325
326 if (status & ASC_STA_RBF) {
327 /* Receive FIFO not empty */
328 asc_receive_chars(port);
329 }
330
331 if ((status & ASC_STA_THE) &&
332 (asc_in(port, ASC_INTEN) & ASC_INTEN_THE)) {
333 /* Transmitter FIFO at least half empty */
334 asc_transmit_chars(port);
335 }
336
337 uart_port_unlock(port);
338
339 return IRQ_HANDLED;
340}
341
342/*----------------------------------------------------------------------*/
343
344/*
345 * UART Functions
346 */
347
348static unsigned int asc_tx_empty(struct uart_port *port)
349{
350 return asc_txfifo_is_empty(port) ? TIOCSER_TEMT : 0;
351}
352
353static void asc_set_mctrl(struct uart_port *port, unsigned int mctrl)
354{
355 struct asc_port *ascport = to_asc_port(port);
356
357 /*
358 * This routine is used for seting signals of: DTR, DCD, CTS and RTS.
359 * We use ASC's hardware for CTS/RTS when hardware flow-control is
360 * enabled, however if the RTS line is required for another purpose,
361 * commonly controlled using HUP from userspace, then we need to toggle
362 * it manually, using GPIO.
363 *
364 * Some boards also have DTR and DCD implemented using PIO pins, code to
365 * do this should be hooked in here.
366 */
367
368 if (!ascport->rts)
369 return;
370
371 /* If HW flow-control is enabled, we can't fiddle with the RTS line */
372 if (asc_in(port, ASC_CTL) & ASC_CTL_CTSENABLE)
373 return;
374
375 gpiod_set_value(ascport->rts, mctrl & TIOCM_RTS);
376}
377
378static unsigned int asc_get_mctrl(struct uart_port *port)
379{
380 /*
381 * This routine is used for geting signals of: DTR, DCD, DSR, RI,
382 * and CTS/RTS
383 */
384 return TIOCM_CAR | TIOCM_DSR | TIOCM_CTS;
385}
386
387/* There are probably characters waiting to be transmitted. */
388static void asc_start_tx(struct uart_port *port)
389{
390 struct circ_buf *xmit = &port->state->xmit;
391
392 if (!uart_circ_empty(xmit))
393 asc_enable_tx_interrupts(port);
394}
395
396/* Transmit stop */
397static void asc_stop_tx(struct uart_port *port)
398{
399 asc_disable_tx_interrupts(port);
400}
401
402/* Receive stop */
403static void asc_stop_rx(struct uart_port *port)
404{
405 asc_disable_rx_interrupts(port);
406}
407
408/* Handle breaks - ignored by us */
409static void asc_break_ctl(struct uart_port *port, int break_state)
410{
411 /* Nothing here yet .. */
412}
413
414/*
415 * Enable port for reception.
416 */
417static int asc_startup(struct uart_port *port)
418{
419 if (request_irq(port->irq, asc_interrupt, 0,
420 asc_port_name(port), port)) {
421 dev_err(port->dev, "cannot allocate irq.\n");
422 return -ENODEV;
423 }
424
425 asc_transmit_chars(port);
426 asc_enable_rx_interrupts(port);
427
428 return 0;
429}
430
431static void asc_shutdown(struct uart_port *port)
432{
433 asc_disable_tx_interrupts(port);
434 asc_disable_rx_interrupts(port);
435 free_irq(port->irq, port);
436}
437
438static void asc_pm(struct uart_port *port, unsigned int state,
439 unsigned int oldstate)
440{
441 struct asc_port *ascport = to_asc_port(port);
442 unsigned long flags;
443 u32 ctl;
444
445 switch (state) {
446 case UART_PM_STATE_ON:
447 clk_prepare_enable(ascport->clk);
448 break;
449 case UART_PM_STATE_OFF:
450 /*
451 * Disable the ASC baud rate generator, which is as close as
452 * we can come to turning it off. Note this is not called with
453 * the port spinlock held.
454 */
455 uart_port_lock_irqsave(port, &flags);
456 ctl = asc_in(port, ASC_CTL) & ~ASC_CTL_RUN;
457 asc_out(port, ASC_CTL, ctl);
458 uart_port_unlock_irqrestore(port, flags);
459 clk_disable_unprepare(ascport->clk);
460 break;
461 }
462}
463
464static void asc_set_termios(struct uart_port *port, struct ktermios *termios,
465 const struct ktermios *old)
466{
467 struct asc_port *ascport = to_asc_port(port);
468 struct gpio_desc *gpiod;
469 unsigned int baud;
470 u32 ctrl_val;
471 tcflag_t cflag;
472 unsigned long flags;
473
474 /* Update termios to reflect hardware capabilities */
475 termios->c_cflag &= ~(CMSPAR |
476 (ascport->hw_flow_control ? 0 : CRTSCTS));
477
478 port->uartclk = clk_get_rate(ascport->clk);
479
480 baud = uart_get_baud_rate(port, termios, old, 0, port->uartclk/16);
481 cflag = termios->c_cflag;
482
483 uart_port_lock_irqsave(port, &flags);
484
485 /* read control register */
486 ctrl_val = asc_in(port, ASC_CTL);
487
488 /* stop serial port and reset value */
489 asc_out(port, ASC_CTL, (ctrl_val & ~ASC_CTL_RUN));
490 ctrl_val = ASC_CTL_RXENABLE | ASC_CTL_FIFOENABLE;
491
492 /* reset fifo rx & tx */
493 asc_out(port, ASC_TXRESET, 1);
494 asc_out(port, ASC_RXRESET, 1);
495
496 /* set character length */
497 if ((cflag & CSIZE) == CS7) {
498 ctrl_val |= ASC_CTL_MODE_7BIT_PAR;
499 cflag |= PARENB;
500 } else {
501 ctrl_val |= (cflag & PARENB) ? ASC_CTL_MODE_8BIT_PAR :
502 ASC_CTL_MODE_8BIT;
503 cflag &= ~CSIZE;
504 cflag |= CS8;
505 }
506 termios->c_cflag = cflag;
507
508 /* set stop bit */
509 ctrl_val |= (cflag & CSTOPB) ? ASC_CTL_STOP_2BIT : ASC_CTL_STOP_1BIT;
510
511 /* odd parity */
512 if (cflag & PARODD)
513 ctrl_val |= ASC_CTL_PARITYODD;
514
515 /* hardware flow control */
516 if ((cflag & CRTSCTS)) {
517 ctrl_val |= ASC_CTL_CTSENABLE;
518
519 /* If flow-control selected, stop handling RTS manually */
520 if (ascport->rts) {
521 devm_gpiod_put(port->dev, ascport->rts);
522 ascport->rts = NULL;
523
524 pinctrl_select_state(ascport->pinctrl,
525 ascport->states[DEFAULT]);
526 }
527 } else {
528 /* If flow-control disabled, it's safe to handle RTS manually */
529 if (!ascport->rts && ascport->states[NO_HW_FLOWCTRL]) {
530 pinctrl_select_state(ascport->pinctrl,
531 ascport->states[NO_HW_FLOWCTRL]);
532
533 gpiod = devm_gpiod_get(port->dev, "rts", GPIOD_OUT_LOW);
534 if (!IS_ERR(gpiod)) {
535 gpiod_set_consumer_name(gpiod,
536 port->dev->of_node->name);
537 ascport->rts = gpiod;
538 }
539 }
540 }
541
542 if ((baud < 19200) && !ascport->force_m1) {
543 asc_out(port, ASC_BAUDRATE, (port->uartclk / (16 * baud)));
544 } else {
545 /*
546 * MODE 1: recommended for high bit rates (above 19.2K)
547 *
548 * baudrate * 16 * 2^16
549 * ASCBaudRate = ------------------------
550 * inputclock
551 *
552 * To keep maths inside 64bits, we divide inputclock by 16.
553 */
554 u64 dividend = (u64)baud * (1 << 16);
555
556 do_div(dividend, port->uartclk / 16);
557 asc_out(port, ASC_BAUDRATE, dividend);
558 ctrl_val |= ASC_CTL_BAUDMODE;
559 }
560
561 uart_update_timeout(port, cflag, baud);
562
563 ascport->port.read_status_mask = ASC_RXBUF_DUMMY_OE;
564 if (termios->c_iflag & INPCK)
565 ascport->port.read_status_mask |= ASC_RXBUF_FE | ASC_RXBUF_PE;
566 if (termios->c_iflag & (IGNBRK | BRKINT | PARMRK))
567 ascport->port.read_status_mask |= ASC_RXBUF_DUMMY_BE;
568
569 /*
570 * Characters to ignore
571 */
572 ascport->port.ignore_status_mask = 0;
573 if (termios->c_iflag & IGNPAR)
574 ascport->port.ignore_status_mask |= ASC_RXBUF_FE | ASC_RXBUF_PE;
575 if (termios->c_iflag & IGNBRK) {
576 ascport->port.ignore_status_mask |= ASC_RXBUF_DUMMY_BE;
577 /*
578 * If we're ignoring parity and break indicators,
579 * ignore overruns too (for real raw support).
580 */
581 if (termios->c_iflag & IGNPAR)
582 ascport->port.ignore_status_mask |= ASC_RXBUF_DUMMY_OE;
583 }
584
585 /*
586 * Ignore all characters if CREAD is not set.
587 */
588 if (!(termios->c_cflag & CREAD))
589 ascport->port.ignore_status_mask |= ASC_RXBUF_DUMMY_RX;
590
591 /* Set the timeout */
592 asc_out(port, ASC_TIMEOUT, 20);
593
594 /* write final value and enable port */
595 asc_out(port, ASC_CTL, (ctrl_val | ASC_CTL_RUN));
596
597 uart_port_unlock_irqrestore(port, flags);
598}
599
600static const char *asc_type(struct uart_port *port)
601{
602 return (port->type == PORT_ASC) ? DRIVER_NAME : NULL;
603}
604
605static void asc_release_port(struct uart_port *port)
606{
607}
608
609static int asc_request_port(struct uart_port *port)
610{
611 return 0;
612}
613
614/*
615 * Called when the port is opened, and UPF_BOOT_AUTOCONF flag is set
616 * Set type field if successful
617 */
618static void asc_config_port(struct uart_port *port, int flags)
619{
620 if ((flags & UART_CONFIG_TYPE))
621 port->type = PORT_ASC;
622}
623
624static int
625asc_verify_port(struct uart_port *port, struct serial_struct *ser)
626{
627 /* No user changeable parameters */
628 return -EINVAL;
629}
630
631#ifdef CONFIG_CONSOLE_POLL
632/*
633 * Console polling routines for writing and reading from the uart while
634 * in an interrupt or debug context (i.e. kgdb).
635 */
636
637static int asc_get_poll_char(struct uart_port *port)
638{
639 if (!(asc_in(port, ASC_STA) & ASC_STA_RBF))
640 return NO_POLL_CHAR;
641
642 return asc_in(port, ASC_RXBUF);
643}
644
645static void asc_put_poll_char(struct uart_port *port, unsigned char c)
646{
647 while (!asc_txfifo_is_half_empty(port))
648 cpu_relax();
649 asc_out(port, ASC_TXBUF, c);
650}
651
652#endif /* CONFIG_CONSOLE_POLL */
653
654/*---------------------------------------------------------------------*/
655
656static const struct uart_ops asc_uart_ops = {
657 .tx_empty = asc_tx_empty,
658 .set_mctrl = asc_set_mctrl,
659 .get_mctrl = asc_get_mctrl,
660 .start_tx = asc_start_tx,
661 .stop_tx = asc_stop_tx,
662 .stop_rx = asc_stop_rx,
663 .break_ctl = asc_break_ctl,
664 .startup = asc_startup,
665 .shutdown = asc_shutdown,
666 .set_termios = asc_set_termios,
667 .type = asc_type,
668 .release_port = asc_release_port,
669 .request_port = asc_request_port,
670 .config_port = asc_config_port,
671 .verify_port = asc_verify_port,
672 .pm = asc_pm,
673#ifdef CONFIG_CONSOLE_POLL
674 .poll_get_char = asc_get_poll_char,
675 .poll_put_char = asc_put_poll_char,
676#endif /* CONFIG_CONSOLE_POLL */
677};
678
679static int asc_init_port(struct asc_port *ascport,
680 struct platform_device *pdev)
681{
682 struct uart_port *port = &ascport->port;
683 struct resource *res;
684 int ret;
685
686 port->iotype = UPIO_MEM;
687 port->flags = UPF_BOOT_AUTOCONF;
688 port->ops = &asc_uart_ops;
689 port->fifosize = ASC_FIFO_SIZE;
690 port->dev = &pdev->dev;
691 port->irq = platform_get_irq(pdev, 0);
692 port->has_sysrq = IS_ENABLED(CONFIG_SERIAL_ST_ASC_CONSOLE);
693
694 port->membase = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
695 if (IS_ERR(port->membase))
696 return PTR_ERR(port->membase);
697 port->mapbase = res->start;
698
699 spin_lock_init(&port->lock);
700
701 ascport->clk = devm_clk_get(&pdev->dev, NULL);
702
703 if (WARN_ON(IS_ERR(ascport->clk)))
704 return -EINVAL;
705 /* ensure that clk rate is correct by enabling the clk */
706 ret = clk_prepare_enable(ascport->clk);
707 if (ret)
708 return ret;
709 ascport->port.uartclk = clk_get_rate(ascport->clk);
710 WARN_ON(ascport->port.uartclk == 0);
711 clk_disable_unprepare(ascport->clk);
712
713 ascport->pinctrl = devm_pinctrl_get(&pdev->dev);
714 if (IS_ERR(ascport->pinctrl)) {
715 ret = PTR_ERR(ascport->pinctrl);
716 dev_err(&pdev->dev, "Failed to get Pinctrl: %d\n", ret);
717 return ret;
718 }
719
720 ascport->states[DEFAULT] =
721 pinctrl_lookup_state(ascport->pinctrl, "default");
722 if (IS_ERR(ascport->states[DEFAULT])) {
723 ret = PTR_ERR(ascport->states[DEFAULT]);
724 dev_err(&pdev->dev,
725 "Failed to look up Pinctrl state 'default': %d\n", ret);
726 return ret;
727 }
728
729 /* "no-hw-flowctrl" state is optional */
730 ascport->states[NO_HW_FLOWCTRL] =
731 pinctrl_lookup_state(ascport->pinctrl, "no-hw-flowctrl");
732 if (IS_ERR(ascport->states[NO_HW_FLOWCTRL]))
733 ascport->states[NO_HW_FLOWCTRL] = NULL;
734
735 return 0;
736}
737
738static struct asc_port *asc_of_get_asc_port(struct platform_device *pdev)
739{
740 struct device_node *np = pdev->dev.of_node;
741 int id;
742
743 if (!np)
744 return NULL;
745
746 id = of_alias_get_id(np, "serial");
747 if (id < 0)
748 id = of_alias_get_id(np, ASC_SERIAL_NAME);
749
750 if (id < 0)
751 id = 0;
752
753 if (WARN_ON(id >= ASC_MAX_PORTS))
754 return NULL;
755
756 asc_ports[id].hw_flow_control = of_property_read_bool(np,
757 "uart-has-rtscts");
758 asc_ports[id].force_m1 = of_property_read_bool(np, "st,force-m1");
759 asc_ports[id].port.line = id;
760 asc_ports[id].rts = NULL;
761
762 return &asc_ports[id];
763}
764
765#ifdef CONFIG_OF
766static const struct of_device_id asc_match[] = {
767 { .compatible = "st,asc", },
768 {},
769};
770
771MODULE_DEVICE_TABLE(of, asc_match);
772#endif
773
774static int asc_serial_probe(struct platform_device *pdev)
775{
776 int ret;
777 struct asc_port *ascport;
778
779 ascport = asc_of_get_asc_port(pdev);
780 if (!ascport)
781 return -ENODEV;
782
783 ret = asc_init_port(ascport, pdev);
784 if (ret)
785 return ret;
786
787 ret = uart_add_one_port(&asc_uart_driver, &ascport->port);
788 if (ret)
789 return ret;
790
791 platform_set_drvdata(pdev, &ascport->port);
792
793 return 0;
794}
795
796static void asc_serial_remove(struct platform_device *pdev)
797{
798 struct uart_port *port = platform_get_drvdata(pdev);
799
800 uart_remove_one_port(&asc_uart_driver, port);
801}
802
803#ifdef CONFIG_PM_SLEEP
804static int asc_serial_suspend(struct device *dev)
805{
806 struct uart_port *port = dev_get_drvdata(dev);
807
808 return uart_suspend_port(&asc_uart_driver, port);
809}
810
811static int asc_serial_resume(struct device *dev)
812{
813 struct uart_port *port = dev_get_drvdata(dev);
814
815 return uart_resume_port(&asc_uart_driver, port);
816}
817
818#endif /* CONFIG_PM_SLEEP */
819
820/*----------------------------------------------------------------------*/
821
822#ifdef CONFIG_SERIAL_ST_ASC_CONSOLE
823static void asc_console_putchar(struct uart_port *port, unsigned char ch)
824{
825 unsigned int timeout = 1000000;
826
827 /* Wait for upto 1 second in case flow control is stopping us. */
828 while (--timeout && !asc_txfifo_is_half_empty(port))
829 udelay(1);
830
831 asc_out(port, ASC_TXBUF, ch);
832}
833
834/*
835 * Print a string to the serial port trying not to disturb
836 * any possible real use of the port...
837 */
838
839static void asc_console_write(struct console *co, const char *s, unsigned count)
840{
841 struct uart_port *port = &asc_ports[co->index].port;
842 unsigned long flags;
843 unsigned long timeout = 1000000;
844 int locked = 1;
845 u32 intenable;
846
847 if (port->sysrq)
848 locked = 0; /* asc_interrupt has already claimed the lock */
849 else if (oops_in_progress)
850 locked = uart_port_trylock_irqsave(port, &flags);
851 else
852 uart_port_lock_irqsave(port, &flags);
853
854 /*
855 * Disable interrupts so we don't get the IRQ line bouncing
856 * up and down while interrupts are disabled.
857 */
858 intenable = asc_in(port, ASC_INTEN);
859 asc_out(port, ASC_INTEN, 0);
860 (void)asc_in(port, ASC_INTEN); /* Defeat bus write posting */
861
862 uart_console_write(port, s, count, asc_console_putchar);
863
864 while (--timeout && !asc_txfifo_is_empty(port))
865 udelay(1);
866
867 asc_out(port, ASC_INTEN, intenable);
868
869 if (locked)
870 uart_port_unlock_irqrestore(port, flags);
871}
872
873static int asc_console_setup(struct console *co, char *options)
874{
875 struct asc_port *ascport;
876 int baud = 115200;
877 int bits = 8;
878 int parity = 'n';
879 int flow = 'n';
880
881 if (co->index >= ASC_MAX_PORTS)
882 return -ENODEV;
883
884 ascport = &asc_ports[co->index];
885
886 /*
887 * This driver does not support early console initialization
888 * (use ARM early printk support instead), so we only expect
889 * this to be called during the uart port registration when the
890 * driver gets probed and the port should be mapped at that point.
891 */
892 if (ascport->port.mapbase == 0 || ascport->port.membase == NULL)
893 return -ENXIO;
894
895 if (options)
896 uart_parse_options(options, &baud, &parity, &bits, &flow);
897
898 return uart_set_options(&ascport->port, co, baud, parity, bits, flow);
899}
900
901static struct console asc_console = {
902 .name = ASC_SERIAL_NAME,
903 .device = uart_console_device,
904 .write = asc_console_write,
905 .setup = asc_console_setup,
906 .flags = CON_PRINTBUFFER,
907 .index = -1,
908 .data = &asc_uart_driver,
909};
910
911#define ASC_SERIAL_CONSOLE (&asc_console)
912
913#else
914#define ASC_SERIAL_CONSOLE NULL
915#endif /* CONFIG_SERIAL_ST_ASC_CONSOLE */
916
917static struct uart_driver asc_uart_driver = {
918 .owner = THIS_MODULE,
919 .driver_name = DRIVER_NAME,
920 .dev_name = ASC_SERIAL_NAME,
921 .major = 0,
922 .minor = 0,
923 .nr = ASC_MAX_PORTS,
924 .cons = ASC_SERIAL_CONSOLE,
925};
926
927static const struct dev_pm_ops asc_serial_pm_ops = {
928 SET_SYSTEM_SLEEP_PM_OPS(asc_serial_suspend, asc_serial_resume)
929};
930
931static struct platform_driver asc_serial_driver = {
932 .probe = asc_serial_probe,
933 .remove_new = asc_serial_remove,
934 .driver = {
935 .name = DRIVER_NAME,
936 .pm = &asc_serial_pm_ops,
937 .of_match_table = of_match_ptr(asc_match),
938 },
939};
940
941static int __init asc_init(void)
942{
943 int ret;
944 static const char banner[] __initconst =
945 KERN_INFO "STMicroelectronics ASC driver initialized\n";
946
947 printk(banner);
948
949 ret = uart_register_driver(&asc_uart_driver);
950 if (ret)
951 return ret;
952
953 ret = platform_driver_register(&asc_serial_driver);
954 if (ret)
955 uart_unregister_driver(&asc_uart_driver);
956
957 return ret;
958}
959
960static void __exit asc_exit(void)
961{
962 platform_driver_unregister(&asc_serial_driver);
963 uart_unregister_driver(&asc_uart_driver);
964}
965
966module_init(asc_init);
967module_exit(asc_exit);
968
969MODULE_ALIAS("platform:" DRIVER_NAME);
970MODULE_AUTHOR("STMicroelectronics (R&D) Limited");
971MODULE_DESCRIPTION("STMicroelectronics ASC serial port driver");
972MODULE_LICENSE("GPL");
1// SPDX-License-Identifier: GPL-2.0+
2/*
3 * st-asc.c: ST Asynchronous serial controller (ASC) driver
4 *
5 * Copyright (C) 2003-2013 STMicroelectronics (R&D) Limited
6 */
7
8#if defined(CONFIG_SERIAL_ST_ASC_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
9#define SUPPORT_SYSRQ
10#endif
11
12#include <linux/module.h>
13#include <linux/serial.h>
14#include <linux/console.h>
15#include <linux/sysrq.h>
16#include <linux/pinctrl/consumer.h>
17#include <linux/platform_device.h>
18#include <linux/io.h>
19#include <linux/irq.h>
20#include <linux/tty.h>
21#include <linux/tty_flip.h>
22#include <linux/delay.h>
23#include <linux/spinlock.h>
24#include <linux/pm_runtime.h>
25#include <linux/of.h>
26#include <linux/of_platform.h>
27#include <linux/serial_core.h>
28#include <linux/clk.h>
29#include <linux/gpio/consumer.h>
30
31#define DRIVER_NAME "st-asc"
32#define ASC_SERIAL_NAME "ttyAS"
33#define ASC_FIFO_SIZE 16
34#define ASC_MAX_PORTS 8
35
36/* Pinctrl states */
37#define DEFAULT 0
38#define NO_HW_FLOWCTRL 1
39
40struct asc_port {
41 struct uart_port port;
42 struct gpio_desc *rts;
43 struct clk *clk;
44 struct pinctrl *pinctrl;
45 struct pinctrl_state *states[2];
46 unsigned int hw_flow_control:1;
47 unsigned int force_m1:1;
48};
49
50static struct asc_port asc_ports[ASC_MAX_PORTS];
51static struct uart_driver asc_uart_driver;
52
53/*---- UART Register definitions ------------------------------*/
54
55/* Register offsets */
56
57#define ASC_BAUDRATE 0x00
58#define ASC_TXBUF 0x04
59#define ASC_RXBUF 0x08
60#define ASC_CTL 0x0C
61#define ASC_INTEN 0x10
62#define ASC_STA 0x14
63#define ASC_GUARDTIME 0x18
64#define ASC_TIMEOUT 0x1C
65#define ASC_TXRESET 0x20
66#define ASC_RXRESET 0x24
67#define ASC_RETRIES 0x28
68
69/* ASC_RXBUF */
70#define ASC_RXBUF_PE 0x100
71#define ASC_RXBUF_FE 0x200
72/**
73 * Some of status comes from higher bits of the character and some come from
74 * the status register. Combining both of them in to single status using dummy
75 * bits.
76 */
77#define ASC_RXBUF_DUMMY_RX 0x10000
78#define ASC_RXBUF_DUMMY_BE 0x20000
79#define ASC_RXBUF_DUMMY_OE 0x40000
80
81/* ASC_CTL */
82
83#define ASC_CTL_MODE_MSK 0x0007
84#define ASC_CTL_MODE_8BIT 0x0001
85#define ASC_CTL_MODE_7BIT_PAR 0x0003
86#define ASC_CTL_MODE_9BIT 0x0004
87#define ASC_CTL_MODE_8BIT_WKUP 0x0005
88#define ASC_CTL_MODE_8BIT_PAR 0x0007
89#define ASC_CTL_STOP_MSK 0x0018
90#define ASC_CTL_STOP_HALFBIT 0x0000
91#define ASC_CTL_STOP_1BIT 0x0008
92#define ASC_CTL_STOP_1_HALFBIT 0x0010
93#define ASC_CTL_STOP_2BIT 0x0018
94#define ASC_CTL_PARITYODD 0x0020
95#define ASC_CTL_LOOPBACK 0x0040
96#define ASC_CTL_RUN 0x0080
97#define ASC_CTL_RXENABLE 0x0100
98#define ASC_CTL_SCENABLE 0x0200
99#define ASC_CTL_FIFOENABLE 0x0400
100#define ASC_CTL_CTSENABLE 0x0800
101#define ASC_CTL_BAUDMODE 0x1000
102
103/* ASC_GUARDTIME */
104
105#define ASC_GUARDTIME_MSK 0x00FF
106
107/* ASC_INTEN */
108
109#define ASC_INTEN_RBE 0x0001
110#define ASC_INTEN_TE 0x0002
111#define ASC_INTEN_THE 0x0004
112#define ASC_INTEN_PE 0x0008
113#define ASC_INTEN_FE 0x0010
114#define ASC_INTEN_OE 0x0020
115#define ASC_INTEN_TNE 0x0040
116#define ASC_INTEN_TOI 0x0080
117#define ASC_INTEN_RHF 0x0100
118
119/* ASC_RETRIES */
120
121#define ASC_RETRIES_MSK 0x00FF
122
123/* ASC_RXBUF */
124
125#define ASC_RXBUF_MSK 0x03FF
126
127/* ASC_STA */
128
129#define ASC_STA_RBF 0x0001
130#define ASC_STA_TE 0x0002
131#define ASC_STA_THE 0x0004
132#define ASC_STA_PE 0x0008
133#define ASC_STA_FE 0x0010
134#define ASC_STA_OE 0x0020
135#define ASC_STA_TNE 0x0040
136#define ASC_STA_TOI 0x0080
137#define ASC_STA_RHF 0x0100
138#define ASC_STA_TF 0x0200
139#define ASC_STA_NKD 0x0400
140
141/* ASC_TIMEOUT */
142
143#define ASC_TIMEOUT_MSK 0x00FF
144
145/* ASC_TXBUF */
146
147#define ASC_TXBUF_MSK 0x01FF
148
149/*---- Inline function definitions ---------------------------*/
150
151static inline struct asc_port *to_asc_port(struct uart_port *port)
152{
153 return container_of(port, struct asc_port, port);
154}
155
156static inline u32 asc_in(struct uart_port *port, u32 offset)
157{
158#ifdef readl_relaxed
159 return readl_relaxed(port->membase + offset);
160#else
161 return readl(port->membase + offset);
162#endif
163}
164
165static inline void asc_out(struct uart_port *port, u32 offset, u32 value)
166{
167#ifdef writel_relaxed
168 writel_relaxed(value, port->membase + offset);
169#else
170 writel(value, port->membase + offset);
171#endif
172}
173
174/*
175 * Some simple utility functions to enable and disable interrupts.
176 * Note that these need to be called with interrupts disabled.
177 */
178static inline void asc_disable_tx_interrupts(struct uart_port *port)
179{
180 u32 intenable = asc_in(port, ASC_INTEN) & ~ASC_INTEN_THE;
181 asc_out(port, ASC_INTEN, intenable);
182 (void)asc_in(port, ASC_INTEN); /* Defeat bus write posting */
183}
184
185static inline void asc_enable_tx_interrupts(struct uart_port *port)
186{
187 u32 intenable = asc_in(port, ASC_INTEN) | ASC_INTEN_THE;
188 asc_out(port, ASC_INTEN, intenable);
189}
190
191static inline void asc_disable_rx_interrupts(struct uart_port *port)
192{
193 u32 intenable = asc_in(port, ASC_INTEN) & ~ASC_INTEN_RBE;
194 asc_out(port, ASC_INTEN, intenable);
195 (void)asc_in(port, ASC_INTEN); /* Defeat bus write posting */
196}
197
198static inline void asc_enable_rx_interrupts(struct uart_port *port)
199{
200 u32 intenable = asc_in(port, ASC_INTEN) | ASC_INTEN_RBE;
201 asc_out(port, ASC_INTEN, intenable);
202}
203
204static inline u32 asc_txfifo_is_empty(struct uart_port *port)
205{
206 return asc_in(port, ASC_STA) & ASC_STA_TE;
207}
208
209static inline u32 asc_txfifo_is_half_empty(struct uart_port *port)
210{
211 return asc_in(port, ASC_STA) & ASC_STA_THE;
212}
213
214static inline const char *asc_port_name(struct uart_port *port)
215{
216 return to_platform_device(port->dev)->name;
217}
218
219/*----------------------------------------------------------------------*/
220
221/*
222 * This section contains code to support the use of the ASC as a
223 * generic serial port.
224 */
225
226static inline unsigned asc_hw_txroom(struct uart_port *port)
227{
228 u32 status = asc_in(port, ASC_STA);
229
230 if (status & ASC_STA_THE)
231 return port->fifosize / 2;
232 else if (!(status & ASC_STA_TF))
233 return 1;
234
235 return 0;
236}
237
238/*
239 * Start transmitting chars.
240 * This is called from both interrupt and task level.
241 * Either way interrupts are disabled.
242 */
243static void asc_transmit_chars(struct uart_port *port)
244{
245 struct circ_buf *xmit = &port->state->xmit;
246 int txroom;
247 unsigned char c;
248
249 txroom = asc_hw_txroom(port);
250
251 if ((txroom != 0) && port->x_char) {
252 c = port->x_char;
253 port->x_char = 0;
254 asc_out(port, ASC_TXBUF, c);
255 port->icount.tx++;
256 txroom = asc_hw_txroom(port);
257 }
258
259 if (uart_tx_stopped(port)) {
260 /*
261 * We should try and stop the hardware here, but I
262 * don't think the ASC has any way to do that.
263 */
264 asc_disable_tx_interrupts(port);
265 return;
266 }
267
268 if (uart_circ_empty(xmit)) {
269 asc_disable_tx_interrupts(port);
270 return;
271 }
272
273 if (txroom == 0)
274 return;
275
276 do {
277 c = xmit->buf[xmit->tail];
278 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
279 asc_out(port, ASC_TXBUF, c);
280 port->icount.tx++;
281 txroom--;
282 } while ((txroom > 0) && (!uart_circ_empty(xmit)));
283
284 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
285 uart_write_wakeup(port);
286
287 if (uart_circ_empty(xmit))
288 asc_disable_tx_interrupts(port);
289}
290
291static void asc_receive_chars(struct uart_port *port)
292{
293 struct tty_port *tport = &port->state->port;
294 unsigned long status, mode;
295 unsigned long c = 0;
296 char flag;
297 bool ignore_pe = false;
298
299 /*
300 * Datasheet states: If the MODE field selects an 8-bit frame then
301 * this [parity error] bit is undefined. Software should ignore this
302 * bit when reading 8-bit frames.
303 */
304 mode = asc_in(port, ASC_CTL) & ASC_CTL_MODE_MSK;
305 if (mode == ASC_CTL_MODE_8BIT || mode == ASC_CTL_MODE_8BIT_PAR)
306 ignore_pe = true;
307
308 if (irqd_is_wakeup_set(irq_get_irq_data(port->irq)))
309 pm_wakeup_event(tport->tty->dev, 0);
310
311 while ((status = asc_in(port, ASC_STA)) & ASC_STA_RBF) {
312 c = asc_in(port, ASC_RXBUF) | ASC_RXBUF_DUMMY_RX;
313 flag = TTY_NORMAL;
314 port->icount.rx++;
315
316 if (status & ASC_STA_OE || c & ASC_RXBUF_FE ||
317 (c & ASC_RXBUF_PE && !ignore_pe)) {
318
319 if (c & ASC_RXBUF_FE) {
320 if (c == (ASC_RXBUF_FE | ASC_RXBUF_DUMMY_RX)) {
321 port->icount.brk++;
322 if (uart_handle_break(port))
323 continue;
324 c |= ASC_RXBUF_DUMMY_BE;
325 } else {
326 port->icount.frame++;
327 }
328 } else if (c & ASC_RXBUF_PE) {
329 port->icount.parity++;
330 }
331 /*
332 * Reading any data from the RX FIFO clears the
333 * overflow error condition.
334 */
335 if (status & ASC_STA_OE) {
336 port->icount.overrun++;
337 c |= ASC_RXBUF_DUMMY_OE;
338 }
339
340 c &= port->read_status_mask;
341
342 if (c & ASC_RXBUF_DUMMY_BE)
343 flag = TTY_BREAK;
344 else if (c & ASC_RXBUF_PE)
345 flag = TTY_PARITY;
346 else if (c & ASC_RXBUF_FE)
347 flag = TTY_FRAME;
348 }
349
350 if (uart_handle_sysrq_char(port, c & 0xff))
351 continue;
352
353 uart_insert_char(port, c, ASC_RXBUF_DUMMY_OE, c & 0xff, flag);
354 }
355
356 /* Tell the rest of the system the news. New characters! */
357 tty_flip_buffer_push(tport);
358}
359
360static irqreturn_t asc_interrupt(int irq, void *ptr)
361{
362 struct uart_port *port = ptr;
363 u32 status;
364
365 spin_lock(&port->lock);
366
367 status = asc_in(port, ASC_STA);
368
369 if (status & ASC_STA_RBF) {
370 /* Receive FIFO not empty */
371 asc_receive_chars(port);
372 }
373
374 if ((status & ASC_STA_THE) &&
375 (asc_in(port, ASC_INTEN) & ASC_INTEN_THE)) {
376 /* Transmitter FIFO at least half empty */
377 asc_transmit_chars(port);
378 }
379
380 spin_unlock(&port->lock);
381
382 return IRQ_HANDLED;
383}
384
385/*----------------------------------------------------------------------*/
386
387/*
388 * UART Functions
389 */
390
391static unsigned int asc_tx_empty(struct uart_port *port)
392{
393 return asc_txfifo_is_empty(port) ? TIOCSER_TEMT : 0;
394}
395
396static void asc_set_mctrl(struct uart_port *port, unsigned int mctrl)
397{
398 struct asc_port *ascport = to_asc_port(port);
399
400 /*
401 * This routine is used for seting signals of: DTR, DCD, CTS and RTS.
402 * We use ASC's hardware for CTS/RTS when hardware flow-control is
403 * enabled, however if the RTS line is required for another purpose,
404 * commonly controlled using HUP from userspace, then we need to toggle
405 * it manually, using GPIO.
406 *
407 * Some boards also have DTR and DCD implemented using PIO pins, code to
408 * do this should be hooked in here.
409 */
410
411 if (!ascport->rts)
412 return;
413
414 /* If HW flow-control is enabled, we can't fiddle with the RTS line */
415 if (asc_in(port, ASC_CTL) & ASC_CTL_CTSENABLE)
416 return;
417
418 gpiod_set_value(ascport->rts, mctrl & TIOCM_RTS);
419}
420
421static unsigned int asc_get_mctrl(struct uart_port *port)
422{
423 /*
424 * This routine is used for geting signals of: DTR, DCD, DSR, RI,
425 * and CTS/RTS
426 */
427 return TIOCM_CAR | TIOCM_DSR | TIOCM_CTS;
428}
429
430/* There are probably characters waiting to be transmitted. */
431static void asc_start_tx(struct uart_port *port)
432{
433 struct circ_buf *xmit = &port->state->xmit;
434
435 if (!uart_circ_empty(xmit))
436 asc_enable_tx_interrupts(port);
437}
438
439/* Transmit stop */
440static void asc_stop_tx(struct uart_port *port)
441{
442 asc_disable_tx_interrupts(port);
443}
444
445/* Receive stop */
446static void asc_stop_rx(struct uart_port *port)
447{
448 asc_disable_rx_interrupts(port);
449}
450
451/* Handle breaks - ignored by us */
452static void asc_break_ctl(struct uart_port *port, int break_state)
453{
454 /* Nothing here yet .. */
455}
456
457/*
458 * Enable port for reception.
459 */
460static int asc_startup(struct uart_port *port)
461{
462 if (request_irq(port->irq, asc_interrupt, 0,
463 asc_port_name(port), port)) {
464 dev_err(port->dev, "cannot allocate irq.\n");
465 return -ENODEV;
466 }
467
468 asc_transmit_chars(port);
469 asc_enable_rx_interrupts(port);
470
471 return 0;
472}
473
474static void asc_shutdown(struct uart_port *port)
475{
476 asc_disable_tx_interrupts(port);
477 asc_disable_rx_interrupts(port);
478 free_irq(port->irq, port);
479}
480
481static void asc_pm(struct uart_port *port, unsigned int state,
482 unsigned int oldstate)
483{
484 struct asc_port *ascport = to_asc_port(port);
485 unsigned long flags = 0;
486 u32 ctl;
487
488 switch (state) {
489 case UART_PM_STATE_ON:
490 clk_prepare_enable(ascport->clk);
491 break;
492 case UART_PM_STATE_OFF:
493 /*
494 * Disable the ASC baud rate generator, which is as close as
495 * we can come to turning it off. Note this is not called with
496 * the port spinlock held.
497 */
498 spin_lock_irqsave(&port->lock, flags);
499 ctl = asc_in(port, ASC_CTL) & ~ASC_CTL_RUN;
500 asc_out(port, ASC_CTL, ctl);
501 spin_unlock_irqrestore(&port->lock, flags);
502 clk_disable_unprepare(ascport->clk);
503 break;
504 }
505}
506
507static void asc_set_termios(struct uart_port *port, struct ktermios *termios,
508 struct ktermios *old)
509{
510 struct asc_port *ascport = to_asc_port(port);
511 struct device_node *np = port->dev->of_node;
512 struct gpio_desc *gpiod;
513 unsigned int baud;
514 u32 ctrl_val;
515 tcflag_t cflag;
516 unsigned long flags;
517
518 /* Update termios to reflect hardware capabilities */
519 termios->c_cflag &= ~(CMSPAR |
520 (ascport->hw_flow_control ? 0 : CRTSCTS));
521
522 port->uartclk = clk_get_rate(ascport->clk);
523
524 baud = uart_get_baud_rate(port, termios, old, 0, port->uartclk/16);
525 cflag = termios->c_cflag;
526
527 spin_lock_irqsave(&port->lock, flags);
528
529 /* read control register */
530 ctrl_val = asc_in(port, ASC_CTL);
531
532 /* stop serial port and reset value */
533 asc_out(port, ASC_CTL, (ctrl_val & ~ASC_CTL_RUN));
534 ctrl_val = ASC_CTL_RXENABLE | ASC_CTL_FIFOENABLE;
535
536 /* reset fifo rx & tx */
537 asc_out(port, ASC_TXRESET, 1);
538 asc_out(port, ASC_RXRESET, 1);
539
540 /* set character length */
541 if ((cflag & CSIZE) == CS7) {
542 ctrl_val |= ASC_CTL_MODE_7BIT_PAR;
543 } else {
544 ctrl_val |= (cflag & PARENB) ? ASC_CTL_MODE_8BIT_PAR :
545 ASC_CTL_MODE_8BIT;
546 }
547
548 /* set stop bit */
549 ctrl_val |= (cflag & CSTOPB) ? ASC_CTL_STOP_2BIT : ASC_CTL_STOP_1BIT;
550
551 /* odd parity */
552 if (cflag & PARODD)
553 ctrl_val |= ASC_CTL_PARITYODD;
554
555 /* hardware flow control */
556 if ((cflag & CRTSCTS)) {
557 ctrl_val |= ASC_CTL_CTSENABLE;
558
559 /* If flow-control selected, stop handling RTS manually */
560 if (ascport->rts) {
561 devm_gpiod_put(port->dev, ascport->rts);
562 ascport->rts = NULL;
563
564 pinctrl_select_state(ascport->pinctrl,
565 ascport->states[DEFAULT]);
566 }
567 } else {
568 /* If flow-control disabled, it's safe to handle RTS manually */
569 if (!ascport->rts && ascport->states[NO_HW_FLOWCTRL]) {
570 pinctrl_select_state(ascport->pinctrl,
571 ascport->states[NO_HW_FLOWCTRL]);
572
573 gpiod = devm_fwnode_get_gpiod_from_child(port->dev,
574 "rts",
575 &np->fwnode,
576 GPIOD_OUT_LOW,
577 np->name);
578 if (!IS_ERR(gpiod))
579 ascport->rts = gpiod;
580 }
581 }
582
583 if ((baud < 19200) && !ascport->force_m1) {
584 asc_out(port, ASC_BAUDRATE, (port->uartclk / (16 * baud)));
585 } else {
586 /*
587 * MODE 1: recommended for high bit rates (above 19.2K)
588 *
589 * baudrate * 16 * 2^16
590 * ASCBaudRate = ------------------------
591 * inputclock
592 *
593 * To keep maths inside 64bits, we divide inputclock by 16.
594 */
595 u64 dividend = (u64)baud * (1 << 16);
596
597 do_div(dividend, port->uartclk / 16);
598 asc_out(port, ASC_BAUDRATE, dividend);
599 ctrl_val |= ASC_CTL_BAUDMODE;
600 }
601
602 uart_update_timeout(port, cflag, baud);
603
604 ascport->port.read_status_mask = ASC_RXBUF_DUMMY_OE;
605 if (termios->c_iflag & INPCK)
606 ascport->port.read_status_mask |= ASC_RXBUF_FE | ASC_RXBUF_PE;
607 if (termios->c_iflag & (IGNBRK | BRKINT | PARMRK))
608 ascport->port.read_status_mask |= ASC_RXBUF_DUMMY_BE;
609
610 /*
611 * Characters to ignore
612 */
613 ascport->port.ignore_status_mask = 0;
614 if (termios->c_iflag & IGNPAR)
615 ascport->port.ignore_status_mask |= ASC_RXBUF_FE | ASC_RXBUF_PE;
616 if (termios->c_iflag & IGNBRK) {
617 ascport->port.ignore_status_mask |= ASC_RXBUF_DUMMY_BE;
618 /*
619 * If we're ignoring parity and break indicators,
620 * ignore overruns too (for real raw support).
621 */
622 if (termios->c_iflag & IGNPAR)
623 ascport->port.ignore_status_mask |= ASC_RXBUF_DUMMY_OE;
624 }
625
626 /*
627 * Ignore all characters if CREAD is not set.
628 */
629 if (!(termios->c_cflag & CREAD))
630 ascport->port.ignore_status_mask |= ASC_RXBUF_DUMMY_RX;
631
632 /* Set the timeout */
633 asc_out(port, ASC_TIMEOUT, 20);
634
635 /* write final value and enable port */
636 asc_out(port, ASC_CTL, (ctrl_val | ASC_CTL_RUN));
637
638 spin_unlock_irqrestore(&port->lock, flags);
639}
640
641static const char *asc_type(struct uart_port *port)
642{
643 return (port->type == PORT_ASC) ? DRIVER_NAME : NULL;
644}
645
646static void asc_release_port(struct uart_port *port)
647{
648}
649
650static int asc_request_port(struct uart_port *port)
651{
652 return 0;
653}
654
655/*
656 * Called when the port is opened, and UPF_BOOT_AUTOCONF flag is set
657 * Set type field if successful
658 */
659static void asc_config_port(struct uart_port *port, int flags)
660{
661 if ((flags & UART_CONFIG_TYPE))
662 port->type = PORT_ASC;
663}
664
665static int
666asc_verify_port(struct uart_port *port, struct serial_struct *ser)
667{
668 /* No user changeable parameters */
669 return -EINVAL;
670}
671
672#ifdef CONFIG_CONSOLE_POLL
673/*
674 * Console polling routines for writing and reading from the uart while
675 * in an interrupt or debug context (i.e. kgdb).
676 */
677
678static int asc_get_poll_char(struct uart_port *port)
679{
680 if (!(asc_in(port, ASC_STA) & ASC_STA_RBF))
681 return NO_POLL_CHAR;
682
683 return asc_in(port, ASC_RXBUF);
684}
685
686static void asc_put_poll_char(struct uart_port *port, unsigned char c)
687{
688 while (!asc_txfifo_is_half_empty(port))
689 cpu_relax();
690 asc_out(port, ASC_TXBUF, c);
691}
692
693#endif /* CONFIG_CONSOLE_POLL */
694
695/*---------------------------------------------------------------------*/
696
697static const struct uart_ops asc_uart_ops = {
698 .tx_empty = asc_tx_empty,
699 .set_mctrl = asc_set_mctrl,
700 .get_mctrl = asc_get_mctrl,
701 .start_tx = asc_start_tx,
702 .stop_tx = asc_stop_tx,
703 .stop_rx = asc_stop_rx,
704 .break_ctl = asc_break_ctl,
705 .startup = asc_startup,
706 .shutdown = asc_shutdown,
707 .set_termios = asc_set_termios,
708 .type = asc_type,
709 .release_port = asc_release_port,
710 .request_port = asc_request_port,
711 .config_port = asc_config_port,
712 .verify_port = asc_verify_port,
713 .pm = asc_pm,
714#ifdef CONFIG_CONSOLE_POLL
715 .poll_get_char = asc_get_poll_char,
716 .poll_put_char = asc_put_poll_char,
717#endif /* CONFIG_CONSOLE_POLL */
718};
719
720static int asc_init_port(struct asc_port *ascport,
721 struct platform_device *pdev)
722{
723 struct uart_port *port = &ascport->port;
724 struct resource *res;
725 int ret;
726
727 port->iotype = UPIO_MEM;
728 port->flags = UPF_BOOT_AUTOCONF;
729 port->ops = &asc_uart_ops;
730 port->fifosize = ASC_FIFO_SIZE;
731 port->dev = &pdev->dev;
732 port->irq = platform_get_irq(pdev, 0);
733
734 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
735 port->membase = devm_ioremap_resource(&pdev->dev, res);
736 if (IS_ERR(port->membase))
737 return PTR_ERR(port->membase);
738 port->mapbase = res->start;
739
740 spin_lock_init(&port->lock);
741
742 ascport->clk = devm_clk_get(&pdev->dev, NULL);
743
744 if (WARN_ON(IS_ERR(ascport->clk)))
745 return -EINVAL;
746 /* ensure that clk rate is correct by enabling the clk */
747 clk_prepare_enable(ascport->clk);
748 ascport->port.uartclk = clk_get_rate(ascport->clk);
749 WARN_ON(ascport->port.uartclk == 0);
750 clk_disable_unprepare(ascport->clk);
751
752 ascport->pinctrl = devm_pinctrl_get(&pdev->dev);
753 if (IS_ERR(ascport->pinctrl)) {
754 ret = PTR_ERR(ascport->pinctrl);
755 dev_err(&pdev->dev, "Failed to get Pinctrl: %d\n", ret);
756 return ret;
757 }
758
759 ascport->states[DEFAULT] =
760 pinctrl_lookup_state(ascport->pinctrl, "default");
761 if (IS_ERR(ascport->states[DEFAULT])) {
762 ret = PTR_ERR(ascport->states[DEFAULT]);
763 dev_err(&pdev->dev,
764 "Failed to look up Pinctrl state 'default': %d\n", ret);
765 return ret;
766 }
767
768 /* "no-hw-flowctrl" state is optional */
769 ascport->states[NO_HW_FLOWCTRL] =
770 pinctrl_lookup_state(ascport->pinctrl, "no-hw-flowctrl");
771 if (IS_ERR(ascport->states[NO_HW_FLOWCTRL]))
772 ascport->states[NO_HW_FLOWCTRL] = NULL;
773
774 return 0;
775}
776
777static struct asc_port *asc_of_get_asc_port(struct platform_device *pdev)
778{
779 struct device_node *np = pdev->dev.of_node;
780 int id;
781
782 if (!np)
783 return NULL;
784
785 id = of_alias_get_id(np, "serial");
786 if (id < 0)
787 id = of_alias_get_id(np, ASC_SERIAL_NAME);
788
789 if (id < 0)
790 id = 0;
791
792 if (WARN_ON(id >= ASC_MAX_PORTS))
793 return NULL;
794
795 asc_ports[id].hw_flow_control = of_property_read_bool(np,
796 "uart-has-rtscts");
797 asc_ports[id].force_m1 = of_property_read_bool(np, "st,force_m1");
798 asc_ports[id].port.line = id;
799 asc_ports[id].rts = NULL;
800
801 return &asc_ports[id];
802}
803
804#ifdef CONFIG_OF
805static const struct of_device_id asc_match[] = {
806 { .compatible = "st,asc", },
807 {},
808};
809
810MODULE_DEVICE_TABLE(of, asc_match);
811#endif
812
813static int asc_serial_probe(struct platform_device *pdev)
814{
815 int ret;
816 struct asc_port *ascport;
817
818 ascport = asc_of_get_asc_port(pdev);
819 if (!ascport)
820 return -ENODEV;
821
822 ret = asc_init_port(ascport, pdev);
823 if (ret)
824 return ret;
825
826 ret = uart_add_one_port(&asc_uart_driver, &ascport->port);
827 if (ret)
828 return ret;
829
830 platform_set_drvdata(pdev, &ascport->port);
831
832 return 0;
833}
834
835static int asc_serial_remove(struct platform_device *pdev)
836{
837 struct uart_port *port = platform_get_drvdata(pdev);
838
839 return uart_remove_one_port(&asc_uart_driver, port);
840}
841
842#ifdef CONFIG_PM_SLEEP
843static int asc_serial_suspend(struct device *dev)
844{
845 struct platform_device *pdev = to_platform_device(dev);
846 struct uart_port *port = platform_get_drvdata(pdev);
847
848 return uart_suspend_port(&asc_uart_driver, port);
849}
850
851static int asc_serial_resume(struct device *dev)
852{
853 struct platform_device *pdev = to_platform_device(dev);
854 struct uart_port *port = platform_get_drvdata(pdev);
855
856 return uart_resume_port(&asc_uart_driver, port);
857}
858
859#endif /* CONFIG_PM_SLEEP */
860
861/*----------------------------------------------------------------------*/
862
863#ifdef CONFIG_SERIAL_ST_ASC_CONSOLE
864static void asc_console_putchar(struct uart_port *port, int ch)
865{
866 unsigned int timeout = 1000000;
867
868 /* Wait for upto 1 second in case flow control is stopping us. */
869 while (--timeout && !asc_txfifo_is_half_empty(port))
870 udelay(1);
871
872 asc_out(port, ASC_TXBUF, ch);
873}
874
875/*
876 * Print a string to the serial port trying not to disturb
877 * any possible real use of the port...
878 */
879
880static void asc_console_write(struct console *co, const char *s, unsigned count)
881{
882 struct uart_port *port = &asc_ports[co->index].port;
883 unsigned long flags;
884 unsigned long timeout = 1000000;
885 int locked = 1;
886 u32 intenable;
887
888 if (port->sysrq)
889 locked = 0; /* asc_interrupt has already claimed the lock */
890 else if (oops_in_progress)
891 locked = spin_trylock_irqsave(&port->lock, flags);
892 else
893 spin_lock_irqsave(&port->lock, flags);
894
895 /*
896 * Disable interrupts so we don't get the IRQ line bouncing
897 * up and down while interrupts are disabled.
898 */
899 intenable = asc_in(port, ASC_INTEN);
900 asc_out(port, ASC_INTEN, 0);
901 (void)asc_in(port, ASC_INTEN); /* Defeat bus write posting */
902
903 uart_console_write(port, s, count, asc_console_putchar);
904
905 while (--timeout && !asc_txfifo_is_empty(port))
906 udelay(1);
907
908 asc_out(port, ASC_INTEN, intenable);
909
910 if (locked)
911 spin_unlock_irqrestore(&port->lock, flags);
912}
913
914static int asc_console_setup(struct console *co, char *options)
915{
916 struct asc_port *ascport;
917 int baud = 115200;
918 int bits = 8;
919 int parity = 'n';
920 int flow = 'n';
921
922 if (co->index >= ASC_MAX_PORTS)
923 return -ENODEV;
924
925 ascport = &asc_ports[co->index];
926
927 /*
928 * This driver does not support early console initialization
929 * (use ARM early printk support instead), so we only expect
930 * this to be called during the uart port registration when the
931 * driver gets probed and the port should be mapped at that point.
932 */
933 if (ascport->port.mapbase == 0 || ascport->port.membase == NULL)
934 return -ENXIO;
935
936 if (options)
937 uart_parse_options(options, &baud, &parity, &bits, &flow);
938
939 return uart_set_options(&ascport->port, co, baud, parity, bits, flow);
940}
941
942static struct console asc_console = {
943 .name = ASC_SERIAL_NAME,
944 .device = uart_console_device,
945 .write = asc_console_write,
946 .setup = asc_console_setup,
947 .flags = CON_PRINTBUFFER,
948 .index = -1,
949 .data = &asc_uart_driver,
950};
951
952#define ASC_SERIAL_CONSOLE (&asc_console)
953
954#else
955#define ASC_SERIAL_CONSOLE NULL
956#endif /* CONFIG_SERIAL_ST_ASC_CONSOLE */
957
958static struct uart_driver asc_uart_driver = {
959 .owner = THIS_MODULE,
960 .driver_name = DRIVER_NAME,
961 .dev_name = ASC_SERIAL_NAME,
962 .major = 0,
963 .minor = 0,
964 .nr = ASC_MAX_PORTS,
965 .cons = ASC_SERIAL_CONSOLE,
966};
967
968static const struct dev_pm_ops asc_serial_pm_ops = {
969 SET_SYSTEM_SLEEP_PM_OPS(asc_serial_suspend, asc_serial_resume)
970};
971
972static struct platform_driver asc_serial_driver = {
973 .probe = asc_serial_probe,
974 .remove = asc_serial_remove,
975 .driver = {
976 .name = DRIVER_NAME,
977 .pm = &asc_serial_pm_ops,
978 .of_match_table = of_match_ptr(asc_match),
979 },
980};
981
982static int __init asc_init(void)
983{
984 int ret;
985 static const char banner[] __initconst =
986 KERN_INFO "STMicroelectronics ASC driver initialized\n";
987
988 printk(banner);
989
990 ret = uart_register_driver(&asc_uart_driver);
991 if (ret)
992 return ret;
993
994 ret = platform_driver_register(&asc_serial_driver);
995 if (ret)
996 uart_unregister_driver(&asc_uart_driver);
997
998 return ret;
999}
1000
1001static void __exit asc_exit(void)
1002{
1003 platform_driver_unregister(&asc_serial_driver);
1004 uart_unregister_driver(&asc_uart_driver);
1005}
1006
1007module_init(asc_init);
1008module_exit(asc_exit);
1009
1010MODULE_ALIAS("platform:" DRIVER_NAME);
1011MODULE_AUTHOR("STMicroelectronics (R&D) Limited");
1012MODULE_DESCRIPTION("STMicroelectronics ASC serial port driver");
1013MODULE_LICENSE("GPL");