Loading...
1// SPDX-License-Identifier: GPL-2.0+
2/*
3 * Driver for SA11x0 serial ports
4 *
5 * Based on drivers/char/serial.c, by Linus Torvalds, Theodore Ts'o.
6 *
7 * Copyright (C) 2000 Deep Blue Solutions Ltd.
8 */
9
10#if defined(CONFIG_SERIAL_SA1100_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
11#define SUPPORT_SYSRQ
12#endif
13
14#include <linux/module.h>
15#include <linux/ioport.h>
16#include <linux/init.h>
17#include <linux/console.h>
18#include <linux/sysrq.h>
19#include <linux/platform_data/sa11x0-serial.h>
20#include <linux/platform_device.h>
21#include <linux/tty.h>
22#include <linux/tty_flip.h>
23#include <linux/serial_core.h>
24#include <linux/serial.h>
25#include <linux/io.h>
26
27#include <asm/irq.h>
28#include <mach/hardware.h>
29#include <mach/irqs.h>
30
31/* We've been assigned a range on the "Low-density serial ports" major */
32#define SERIAL_SA1100_MAJOR 204
33#define MINOR_START 5
34
35#define NR_PORTS 3
36
37#define SA1100_ISR_PASS_LIMIT 256
38
39/*
40 * Convert from ignore_status_mask or read_status_mask to UTSR[01]
41 */
42#define SM_TO_UTSR0(x) ((x) & 0xff)
43#define SM_TO_UTSR1(x) ((x) >> 8)
44#define UTSR0_TO_SM(x) ((x))
45#define UTSR1_TO_SM(x) ((x) << 8)
46
47#define UART_GET_UTCR0(sport) __raw_readl((sport)->port.membase + UTCR0)
48#define UART_GET_UTCR1(sport) __raw_readl((sport)->port.membase + UTCR1)
49#define UART_GET_UTCR2(sport) __raw_readl((sport)->port.membase + UTCR2)
50#define UART_GET_UTCR3(sport) __raw_readl((sport)->port.membase + UTCR3)
51#define UART_GET_UTSR0(sport) __raw_readl((sport)->port.membase + UTSR0)
52#define UART_GET_UTSR1(sport) __raw_readl((sport)->port.membase + UTSR1)
53#define UART_GET_CHAR(sport) __raw_readl((sport)->port.membase + UTDR)
54
55#define UART_PUT_UTCR0(sport,v) __raw_writel((v),(sport)->port.membase + UTCR0)
56#define UART_PUT_UTCR1(sport,v) __raw_writel((v),(sport)->port.membase + UTCR1)
57#define UART_PUT_UTCR2(sport,v) __raw_writel((v),(sport)->port.membase + UTCR2)
58#define UART_PUT_UTCR3(sport,v) __raw_writel((v),(sport)->port.membase + UTCR3)
59#define UART_PUT_UTSR0(sport,v) __raw_writel((v),(sport)->port.membase + UTSR0)
60#define UART_PUT_UTSR1(sport,v) __raw_writel((v),(sport)->port.membase + UTSR1)
61#define UART_PUT_CHAR(sport,v) __raw_writel((v),(sport)->port.membase + UTDR)
62
63/*
64 * This is the size of our serial port register set.
65 */
66#define UART_PORT_SIZE 0x24
67
68/*
69 * This determines how often we check the modem status signals
70 * for any change. They generally aren't connected to an IRQ
71 * so we have to poll them. We also check immediately before
72 * filling the TX fifo incase CTS has been dropped.
73 */
74#define MCTRL_TIMEOUT (250*HZ/1000)
75
76struct sa1100_port {
77 struct uart_port port;
78 struct timer_list timer;
79 unsigned int old_status;
80};
81
82/*
83 * Handle any change of modem status signal since we were last called.
84 */
85static void sa1100_mctrl_check(struct sa1100_port *sport)
86{
87 unsigned int status, changed;
88
89 status = sport->port.ops->get_mctrl(&sport->port);
90 changed = status ^ sport->old_status;
91
92 if (changed == 0)
93 return;
94
95 sport->old_status = status;
96
97 if (changed & TIOCM_RI)
98 sport->port.icount.rng++;
99 if (changed & TIOCM_DSR)
100 sport->port.icount.dsr++;
101 if (changed & TIOCM_CAR)
102 uart_handle_dcd_change(&sport->port, status & TIOCM_CAR);
103 if (changed & TIOCM_CTS)
104 uart_handle_cts_change(&sport->port, status & TIOCM_CTS);
105
106 wake_up_interruptible(&sport->port.state->port.delta_msr_wait);
107}
108
109/*
110 * This is our per-port timeout handler, for checking the
111 * modem status signals.
112 */
113static void sa1100_timeout(struct timer_list *t)
114{
115 struct sa1100_port *sport = from_timer(sport, t, timer);
116 unsigned long flags;
117
118 if (sport->port.state) {
119 spin_lock_irqsave(&sport->port.lock, flags);
120 sa1100_mctrl_check(sport);
121 spin_unlock_irqrestore(&sport->port.lock, flags);
122
123 mod_timer(&sport->timer, jiffies + MCTRL_TIMEOUT);
124 }
125}
126
127/*
128 * interrupts disabled on entry
129 */
130static void sa1100_stop_tx(struct uart_port *port)
131{
132 struct sa1100_port *sport =
133 container_of(port, struct sa1100_port, port);
134 u32 utcr3;
135
136 utcr3 = UART_GET_UTCR3(sport);
137 UART_PUT_UTCR3(sport, utcr3 & ~UTCR3_TIE);
138 sport->port.read_status_mask &= ~UTSR0_TO_SM(UTSR0_TFS);
139}
140
141/*
142 * port locked and interrupts disabled
143 */
144static void sa1100_start_tx(struct uart_port *port)
145{
146 struct sa1100_port *sport =
147 container_of(port, struct sa1100_port, port);
148 u32 utcr3;
149
150 utcr3 = UART_GET_UTCR3(sport);
151 sport->port.read_status_mask |= UTSR0_TO_SM(UTSR0_TFS);
152 UART_PUT_UTCR3(sport, utcr3 | UTCR3_TIE);
153}
154
155/*
156 * Interrupts enabled
157 */
158static void sa1100_stop_rx(struct uart_port *port)
159{
160 struct sa1100_port *sport =
161 container_of(port, struct sa1100_port, port);
162 u32 utcr3;
163
164 utcr3 = UART_GET_UTCR3(sport);
165 UART_PUT_UTCR3(sport, utcr3 & ~UTCR3_RIE);
166}
167
168/*
169 * Set the modem control timer to fire immediately.
170 */
171static void sa1100_enable_ms(struct uart_port *port)
172{
173 struct sa1100_port *sport =
174 container_of(port, struct sa1100_port, port);
175
176 mod_timer(&sport->timer, jiffies);
177}
178
179static void
180sa1100_rx_chars(struct sa1100_port *sport)
181{
182 unsigned int status, ch, flg;
183
184 status = UTSR1_TO_SM(UART_GET_UTSR1(sport)) |
185 UTSR0_TO_SM(UART_GET_UTSR0(sport));
186 while (status & UTSR1_TO_SM(UTSR1_RNE)) {
187 ch = UART_GET_CHAR(sport);
188
189 sport->port.icount.rx++;
190
191 flg = TTY_NORMAL;
192
193 /*
194 * note that the error handling code is
195 * out of the main execution path
196 */
197 if (status & UTSR1_TO_SM(UTSR1_PRE | UTSR1_FRE | UTSR1_ROR)) {
198 if (status & UTSR1_TO_SM(UTSR1_PRE))
199 sport->port.icount.parity++;
200 else if (status & UTSR1_TO_SM(UTSR1_FRE))
201 sport->port.icount.frame++;
202 if (status & UTSR1_TO_SM(UTSR1_ROR))
203 sport->port.icount.overrun++;
204
205 status &= sport->port.read_status_mask;
206
207 if (status & UTSR1_TO_SM(UTSR1_PRE))
208 flg = TTY_PARITY;
209 else if (status & UTSR1_TO_SM(UTSR1_FRE))
210 flg = TTY_FRAME;
211
212#ifdef SUPPORT_SYSRQ
213 sport->port.sysrq = 0;
214#endif
215 }
216
217 if (uart_handle_sysrq_char(&sport->port, ch))
218 goto ignore_char;
219
220 uart_insert_char(&sport->port, status, UTSR1_TO_SM(UTSR1_ROR), ch, flg);
221
222 ignore_char:
223 status = UTSR1_TO_SM(UART_GET_UTSR1(sport)) |
224 UTSR0_TO_SM(UART_GET_UTSR0(sport));
225 }
226
227 spin_unlock(&sport->port.lock);
228 tty_flip_buffer_push(&sport->port.state->port);
229 spin_lock(&sport->port.lock);
230}
231
232static void sa1100_tx_chars(struct sa1100_port *sport)
233{
234 struct circ_buf *xmit = &sport->port.state->xmit;
235
236 if (sport->port.x_char) {
237 UART_PUT_CHAR(sport, sport->port.x_char);
238 sport->port.icount.tx++;
239 sport->port.x_char = 0;
240 return;
241 }
242
243 /*
244 * Check the modem control lines before
245 * transmitting anything.
246 */
247 sa1100_mctrl_check(sport);
248
249 if (uart_circ_empty(xmit) || uart_tx_stopped(&sport->port)) {
250 sa1100_stop_tx(&sport->port);
251 return;
252 }
253
254 /*
255 * Tried using FIFO (not checking TNF) for fifo fill:
256 * still had the '4 bytes repeated' problem.
257 */
258 while (UART_GET_UTSR1(sport) & UTSR1_TNF) {
259 UART_PUT_CHAR(sport, xmit->buf[xmit->tail]);
260 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
261 sport->port.icount.tx++;
262 if (uart_circ_empty(xmit))
263 break;
264 }
265
266 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
267 uart_write_wakeup(&sport->port);
268
269 if (uart_circ_empty(xmit))
270 sa1100_stop_tx(&sport->port);
271}
272
273static irqreturn_t sa1100_int(int irq, void *dev_id)
274{
275 struct sa1100_port *sport = dev_id;
276 unsigned int status, pass_counter = 0;
277
278 spin_lock(&sport->port.lock);
279 status = UART_GET_UTSR0(sport);
280 status &= SM_TO_UTSR0(sport->port.read_status_mask) | ~UTSR0_TFS;
281 do {
282 if (status & (UTSR0_RFS | UTSR0_RID)) {
283 /* Clear the receiver idle bit, if set */
284 if (status & UTSR0_RID)
285 UART_PUT_UTSR0(sport, UTSR0_RID);
286 sa1100_rx_chars(sport);
287 }
288
289 /* Clear the relevant break bits */
290 if (status & (UTSR0_RBB | UTSR0_REB))
291 UART_PUT_UTSR0(sport, status & (UTSR0_RBB | UTSR0_REB));
292
293 if (status & UTSR0_RBB)
294 sport->port.icount.brk++;
295
296 if (status & UTSR0_REB)
297 uart_handle_break(&sport->port);
298
299 if (status & UTSR0_TFS)
300 sa1100_tx_chars(sport);
301 if (pass_counter++ > SA1100_ISR_PASS_LIMIT)
302 break;
303 status = UART_GET_UTSR0(sport);
304 status &= SM_TO_UTSR0(sport->port.read_status_mask) |
305 ~UTSR0_TFS;
306 } while (status & (UTSR0_TFS | UTSR0_RFS | UTSR0_RID));
307 spin_unlock(&sport->port.lock);
308
309 return IRQ_HANDLED;
310}
311
312/*
313 * Return TIOCSER_TEMT when transmitter is not busy.
314 */
315static unsigned int sa1100_tx_empty(struct uart_port *port)
316{
317 struct sa1100_port *sport =
318 container_of(port, struct sa1100_port, port);
319
320 return UART_GET_UTSR1(sport) & UTSR1_TBY ? 0 : TIOCSER_TEMT;
321}
322
323static unsigned int sa1100_get_mctrl(struct uart_port *port)
324{
325 return TIOCM_CTS | TIOCM_DSR | TIOCM_CAR;
326}
327
328static void sa1100_set_mctrl(struct uart_port *port, unsigned int mctrl)
329{
330}
331
332/*
333 * Interrupts always disabled.
334 */
335static void sa1100_break_ctl(struct uart_port *port, int break_state)
336{
337 struct sa1100_port *sport =
338 container_of(port, struct sa1100_port, port);
339 unsigned long flags;
340 unsigned int utcr3;
341
342 spin_lock_irqsave(&sport->port.lock, flags);
343 utcr3 = UART_GET_UTCR3(sport);
344 if (break_state == -1)
345 utcr3 |= UTCR3_BRK;
346 else
347 utcr3 &= ~UTCR3_BRK;
348 UART_PUT_UTCR3(sport, utcr3);
349 spin_unlock_irqrestore(&sport->port.lock, flags);
350}
351
352static int sa1100_startup(struct uart_port *port)
353{
354 struct sa1100_port *sport =
355 container_of(port, struct sa1100_port, port);
356 int retval;
357
358 /*
359 * Allocate the IRQ
360 */
361 retval = request_irq(sport->port.irq, sa1100_int, 0,
362 "sa11x0-uart", sport);
363 if (retval)
364 return retval;
365
366 /*
367 * Finally, clear and enable interrupts
368 */
369 UART_PUT_UTSR0(sport, -1);
370 UART_PUT_UTCR3(sport, UTCR3_RXE | UTCR3_TXE | UTCR3_RIE);
371
372 /*
373 * Enable modem status interrupts
374 */
375 spin_lock_irq(&sport->port.lock);
376 sa1100_enable_ms(&sport->port);
377 spin_unlock_irq(&sport->port.lock);
378
379 return 0;
380}
381
382static void sa1100_shutdown(struct uart_port *port)
383{
384 struct sa1100_port *sport =
385 container_of(port, struct sa1100_port, port);
386
387 /*
388 * Stop our timer.
389 */
390 del_timer_sync(&sport->timer);
391
392 /*
393 * Free the interrupt
394 */
395 free_irq(sport->port.irq, sport);
396
397 /*
398 * Disable all interrupts, port and break condition.
399 */
400 UART_PUT_UTCR3(sport, 0);
401}
402
403static void
404sa1100_set_termios(struct uart_port *port, struct ktermios *termios,
405 struct ktermios *old)
406{
407 struct sa1100_port *sport =
408 container_of(port, struct sa1100_port, port);
409 unsigned long flags;
410 unsigned int utcr0, old_utcr3, baud, quot;
411 unsigned int old_csize = old ? old->c_cflag & CSIZE : CS8;
412
413 /*
414 * We only support CS7 and CS8.
415 */
416 while ((termios->c_cflag & CSIZE) != CS7 &&
417 (termios->c_cflag & CSIZE) != CS8) {
418 termios->c_cflag &= ~CSIZE;
419 termios->c_cflag |= old_csize;
420 old_csize = CS8;
421 }
422
423 if ((termios->c_cflag & CSIZE) == CS8)
424 utcr0 = UTCR0_DSS;
425 else
426 utcr0 = 0;
427
428 if (termios->c_cflag & CSTOPB)
429 utcr0 |= UTCR0_SBS;
430 if (termios->c_cflag & PARENB) {
431 utcr0 |= UTCR0_PE;
432 if (!(termios->c_cflag & PARODD))
433 utcr0 |= UTCR0_OES;
434 }
435
436 /*
437 * Ask the core to calculate the divisor for us.
438 */
439 baud = uart_get_baud_rate(port, termios, old, 0, port->uartclk/16);
440 quot = uart_get_divisor(port, baud);
441
442 spin_lock_irqsave(&sport->port.lock, flags);
443
444 sport->port.read_status_mask &= UTSR0_TO_SM(UTSR0_TFS);
445 sport->port.read_status_mask |= UTSR1_TO_SM(UTSR1_ROR);
446 if (termios->c_iflag & INPCK)
447 sport->port.read_status_mask |=
448 UTSR1_TO_SM(UTSR1_FRE | UTSR1_PRE);
449 if (termios->c_iflag & (BRKINT | PARMRK))
450 sport->port.read_status_mask |=
451 UTSR0_TO_SM(UTSR0_RBB | UTSR0_REB);
452
453 /*
454 * Characters to ignore
455 */
456 sport->port.ignore_status_mask = 0;
457 if (termios->c_iflag & IGNPAR)
458 sport->port.ignore_status_mask |=
459 UTSR1_TO_SM(UTSR1_FRE | UTSR1_PRE);
460 if (termios->c_iflag & IGNBRK) {
461 sport->port.ignore_status_mask |=
462 UTSR0_TO_SM(UTSR0_RBB | UTSR0_REB);
463 /*
464 * If we're ignoring parity and break indicators,
465 * ignore overruns too (for real raw support).
466 */
467 if (termios->c_iflag & IGNPAR)
468 sport->port.ignore_status_mask |=
469 UTSR1_TO_SM(UTSR1_ROR);
470 }
471
472 del_timer_sync(&sport->timer);
473
474 /*
475 * Update the per-port timeout.
476 */
477 uart_update_timeout(port, termios->c_cflag, baud);
478
479 /*
480 * disable interrupts and drain transmitter
481 */
482 old_utcr3 = UART_GET_UTCR3(sport);
483 UART_PUT_UTCR3(sport, old_utcr3 & ~(UTCR3_RIE | UTCR3_TIE));
484
485 while (UART_GET_UTSR1(sport) & UTSR1_TBY)
486 barrier();
487
488 /* then, disable everything */
489 UART_PUT_UTCR3(sport, 0);
490
491 /* set the parity, stop bits and data size */
492 UART_PUT_UTCR0(sport, utcr0);
493
494 /* set the baud rate */
495 quot -= 1;
496 UART_PUT_UTCR1(sport, ((quot & 0xf00) >> 8));
497 UART_PUT_UTCR2(sport, (quot & 0xff));
498
499 UART_PUT_UTSR0(sport, -1);
500
501 UART_PUT_UTCR3(sport, old_utcr3);
502
503 if (UART_ENABLE_MS(&sport->port, termios->c_cflag))
504 sa1100_enable_ms(&sport->port);
505
506 spin_unlock_irqrestore(&sport->port.lock, flags);
507}
508
509static const char *sa1100_type(struct uart_port *port)
510{
511 struct sa1100_port *sport =
512 container_of(port, struct sa1100_port, port);
513
514 return sport->port.type == PORT_SA1100 ? "SA1100" : NULL;
515}
516
517/*
518 * Release the memory region(s) being used by 'port'.
519 */
520static void sa1100_release_port(struct uart_port *port)
521{
522 struct sa1100_port *sport =
523 container_of(port, struct sa1100_port, port);
524
525 release_mem_region(sport->port.mapbase, UART_PORT_SIZE);
526}
527
528/*
529 * Request the memory region(s) being used by 'port'.
530 */
531static int sa1100_request_port(struct uart_port *port)
532{
533 struct sa1100_port *sport =
534 container_of(port, struct sa1100_port, port);
535
536 return request_mem_region(sport->port.mapbase, UART_PORT_SIZE,
537 "sa11x0-uart") != NULL ? 0 : -EBUSY;
538}
539
540/*
541 * Configure/autoconfigure the port.
542 */
543static void sa1100_config_port(struct uart_port *port, int flags)
544{
545 struct sa1100_port *sport =
546 container_of(port, struct sa1100_port, port);
547
548 if (flags & UART_CONFIG_TYPE &&
549 sa1100_request_port(&sport->port) == 0)
550 sport->port.type = PORT_SA1100;
551}
552
553/*
554 * Verify the new serial_struct (for TIOCSSERIAL).
555 * The only change we allow are to the flags and type, and
556 * even then only between PORT_SA1100 and PORT_UNKNOWN
557 */
558static int
559sa1100_verify_port(struct uart_port *port, struct serial_struct *ser)
560{
561 struct sa1100_port *sport =
562 container_of(port, struct sa1100_port, port);
563 int ret = 0;
564
565 if (ser->type != PORT_UNKNOWN && ser->type != PORT_SA1100)
566 ret = -EINVAL;
567 if (sport->port.irq != ser->irq)
568 ret = -EINVAL;
569 if (ser->io_type != SERIAL_IO_MEM)
570 ret = -EINVAL;
571 if (sport->port.uartclk / 16 != ser->baud_base)
572 ret = -EINVAL;
573 if ((void *)sport->port.mapbase != ser->iomem_base)
574 ret = -EINVAL;
575 if (sport->port.iobase != ser->port)
576 ret = -EINVAL;
577 if (ser->hub6 != 0)
578 ret = -EINVAL;
579 return ret;
580}
581
582static struct uart_ops sa1100_pops = {
583 .tx_empty = sa1100_tx_empty,
584 .set_mctrl = sa1100_set_mctrl,
585 .get_mctrl = sa1100_get_mctrl,
586 .stop_tx = sa1100_stop_tx,
587 .start_tx = sa1100_start_tx,
588 .stop_rx = sa1100_stop_rx,
589 .enable_ms = sa1100_enable_ms,
590 .break_ctl = sa1100_break_ctl,
591 .startup = sa1100_startup,
592 .shutdown = sa1100_shutdown,
593 .set_termios = sa1100_set_termios,
594 .type = sa1100_type,
595 .release_port = sa1100_release_port,
596 .request_port = sa1100_request_port,
597 .config_port = sa1100_config_port,
598 .verify_port = sa1100_verify_port,
599};
600
601static struct sa1100_port sa1100_ports[NR_PORTS];
602
603/*
604 * Setup the SA1100 serial ports. Note that we don't include the IrDA
605 * port here since we have our own SIR/FIR driver (see drivers/net/irda)
606 *
607 * Note also that we support "console=ttySAx" where "x" is either 0 or 1.
608 * Which serial port this ends up being depends on the machine you're
609 * running this kernel on. I'm not convinced that this is a good idea,
610 * but that's the way it traditionally works.
611 *
612 * Note that NanoEngine UART3 becomes UART2, and UART2 is no longer
613 * used here.
614 */
615static void __init sa1100_init_ports(void)
616{
617 static int first = 1;
618 int i;
619
620 if (!first)
621 return;
622 first = 0;
623
624 for (i = 0; i < NR_PORTS; i++) {
625 sa1100_ports[i].port.uartclk = 3686400;
626 sa1100_ports[i].port.ops = &sa1100_pops;
627 sa1100_ports[i].port.fifosize = 8;
628 sa1100_ports[i].port.line = i;
629 sa1100_ports[i].port.iotype = UPIO_MEM;
630 timer_setup(&sa1100_ports[i].timer, sa1100_timeout, 0);
631 }
632
633 /*
634 * make transmit lines outputs, so that when the port
635 * is closed, the output is in the MARK state.
636 */
637 PPDR |= PPC_TXD1 | PPC_TXD3;
638 PPSR |= PPC_TXD1 | PPC_TXD3;
639}
640
641void sa1100_register_uart_fns(struct sa1100_port_fns *fns)
642{
643 if (fns->get_mctrl)
644 sa1100_pops.get_mctrl = fns->get_mctrl;
645 if (fns->set_mctrl)
646 sa1100_pops.set_mctrl = fns->set_mctrl;
647
648 sa1100_pops.pm = fns->pm;
649 /*
650 * FIXME: fns->set_wake is unused - this should be called from
651 * the suspend() callback if device_may_wakeup(dev)) is set.
652 */
653}
654
655void __init sa1100_register_uart(int idx, int port)
656{
657 if (idx >= NR_PORTS) {
658 printk(KERN_ERR "%s: bad index number %d\n", __func__, idx);
659 return;
660 }
661
662 switch (port) {
663 case 1:
664 sa1100_ports[idx].port.membase = (void __iomem *)&Ser1UTCR0;
665 sa1100_ports[idx].port.mapbase = _Ser1UTCR0;
666 sa1100_ports[idx].port.irq = IRQ_Ser1UART;
667 sa1100_ports[idx].port.flags = UPF_BOOT_AUTOCONF;
668 break;
669
670 case 2:
671 sa1100_ports[idx].port.membase = (void __iomem *)&Ser2UTCR0;
672 sa1100_ports[idx].port.mapbase = _Ser2UTCR0;
673 sa1100_ports[idx].port.irq = IRQ_Ser2ICP;
674 sa1100_ports[idx].port.flags = UPF_BOOT_AUTOCONF;
675 break;
676
677 case 3:
678 sa1100_ports[idx].port.membase = (void __iomem *)&Ser3UTCR0;
679 sa1100_ports[idx].port.mapbase = _Ser3UTCR0;
680 sa1100_ports[idx].port.irq = IRQ_Ser3UART;
681 sa1100_ports[idx].port.flags = UPF_BOOT_AUTOCONF;
682 break;
683
684 default:
685 printk(KERN_ERR "%s: bad port number %d\n", __func__, port);
686 }
687}
688
689
690#ifdef CONFIG_SERIAL_SA1100_CONSOLE
691static void sa1100_console_putchar(struct uart_port *port, int ch)
692{
693 struct sa1100_port *sport =
694 container_of(port, struct sa1100_port, port);
695
696 while (!(UART_GET_UTSR1(sport) & UTSR1_TNF))
697 barrier();
698 UART_PUT_CHAR(sport, ch);
699}
700
701/*
702 * Interrupts are disabled on entering
703 */
704static void
705sa1100_console_write(struct console *co, const char *s, unsigned int count)
706{
707 struct sa1100_port *sport = &sa1100_ports[co->index];
708 unsigned int old_utcr3, status;
709
710 /*
711 * First, save UTCR3 and then disable interrupts
712 */
713 old_utcr3 = UART_GET_UTCR3(sport);
714 UART_PUT_UTCR3(sport, (old_utcr3 & ~(UTCR3_RIE | UTCR3_TIE)) |
715 UTCR3_TXE);
716
717 uart_console_write(&sport->port, s, count, sa1100_console_putchar);
718
719 /*
720 * Finally, wait for transmitter to become empty
721 * and restore UTCR3
722 */
723 do {
724 status = UART_GET_UTSR1(sport);
725 } while (status & UTSR1_TBY);
726 UART_PUT_UTCR3(sport, old_utcr3);
727}
728
729/*
730 * If the port was already initialised (eg, by a boot loader),
731 * try to determine the current setup.
732 */
733static void __init
734sa1100_console_get_options(struct sa1100_port *sport, int *baud,
735 int *parity, int *bits)
736{
737 unsigned int utcr3;
738
739 utcr3 = UART_GET_UTCR3(sport) & (UTCR3_RXE | UTCR3_TXE);
740 if (utcr3 == (UTCR3_RXE | UTCR3_TXE)) {
741 /* ok, the port was enabled */
742 unsigned int utcr0, quot;
743
744 utcr0 = UART_GET_UTCR0(sport);
745
746 *parity = 'n';
747 if (utcr0 & UTCR0_PE) {
748 if (utcr0 & UTCR0_OES)
749 *parity = 'e';
750 else
751 *parity = 'o';
752 }
753
754 if (utcr0 & UTCR0_DSS)
755 *bits = 8;
756 else
757 *bits = 7;
758
759 quot = UART_GET_UTCR2(sport) | UART_GET_UTCR1(sport) << 8;
760 quot &= 0xfff;
761 *baud = sport->port.uartclk / (16 * (quot + 1));
762 }
763}
764
765static int __init
766sa1100_console_setup(struct console *co, char *options)
767{
768 struct sa1100_port *sport;
769 int baud = 9600;
770 int bits = 8;
771 int parity = 'n';
772 int flow = 'n';
773
774 /*
775 * Check whether an invalid uart number has been specified, and
776 * if so, search for the first available port that does have
777 * console support.
778 */
779 if (co->index == -1 || co->index >= NR_PORTS)
780 co->index = 0;
781 sport = &sa1100_ports[co->index];
782
783 if (options)
784 uart_parse_options(options, &baud, &parity, &bits, &flow);
785 else
786 sa1100_console_get_options(sport, &baud, &parity, &bits);
787
788 return uart_set_options(&sport->port, co, baud, parity, bits, flow);
789}
790
791static struct uart_driver sa1100_reg;
792static struct console sa1100_console = {
793 .name = "ttySA",
794 .write = sa1100_console_write,
795 .device = uart_console_device,
796 .setup = sa1100_console_setup,
797 .flags = CON_PRINTBUFFER,
798 .index = -1,
799 .data = &sa1100_reg,
800};
801
802static int __init sa1100_rs_console_init(void)
803{
804 sa1100_init_ports();
805 register_console(&sa1100_console);
806 return 0;
807}
808console_initcall(sa1100_rs_console_init);
809
810#define SA1100_CONSOLE &sa1100_console
811#else
812#define SA1100_CONSOLE NULL
813#endif
814
815static struct uart_driver sa1100_reg = {
816 .owner = THIS_MODULE,
817 .driver_name = "ttySA",
818 .dev_name = "ttySA",
819 .major = SERIAL_SA1100_MAJOR,
820 .minor = MINOR_START,
821 .nr = NR_PORTS,
822 .cons = SA1100_CONSOLE,
823};
824
825static int sa1100_serial_suspend(struct platform_device *dev, pm_message_t state)
826{
827 struct sa1100_port *sport = platform_get_drvdata(dev);
828
829 if (sport)
830 uart_suspend_port(&sa1100_reg, &sport->port);
831
832 return 0;
833}
834
835static int sa1100_serial_resume(struct platform_device *dev)
836{
837 struct sa1100_port *sport = platform_get_drvdata(dev);
838
839 if (sport)
840 uart_resume_port(&sa1100_reg, &sport->port);
841
842 return 0;
843}
844
845static int sa1100_serial_probe(struct platform_device *dev)
846{
847 struct resource *res = dev->resource;
848 int i;
849
850 for (i = 0; i < dev->num_resources; i++, res++)
851 if (res->flags & IORESOURCE_MEM)
852 break;
853
854 if (i < dev->num_resources) {
855 for (i = 0; i < NR_PORTS; i++) {
856 if (sa1100_ports[i].port.mapbase != res->start)
857 continue;
858
859 sa1100_ports[i].port.dev = &dev->dev;
860 uart_add_one_port(&sa1100_reg, &sa1100_ports[i].port);
861 platform_set_drvdata(dev, &sa1100_ports[i]);
862 break;
863 }
864 }
865
866 return 0;
867}
868
869static int sa1100_serial_remove(struct platform_device *pdev)
870{
871 struct sa1100_port *sport = platform_get_drvdata(pdev);
872
873 if (sport)
874 uart_remove_one_port(&sa1100_reg, &sport->port);
875
876 return 0;
877}
878
879static struct platform_driver sa11x0_serial_driver = {
880 .probe = sa1100_serial_probe,
881 .remove = sa1100_serial_remove,
882 .suspend = sa1100_serial_suspend,
883 .resume = sa1100_serial_resume,
884 .driver = {
885 .name = "sa11x0-uart",
886 },
887};
888
889static int __init sa1100_serial_init(void)
890{
891 int ret;
892
893 printk(KERN_INFO "Serial: SA11x0 driver\n");
894
895 sa1100_init_ports();
896
897 ret = uart_register_driver(&sa1100_reg);
898 if (ret == 0) {
899 ret = platform_driver_register(&sa11x0_serial_driver);
900 if (ret)
901 uart_unregister_driver(&sa1100_reg);
902 }
903 return ret;
904}
905
906static void __exit sa1100_serial_exit(void)
907{
908 platform_driver_unregister(&sa11x0_serial_driver);
909 uart_unregister_driver(&sa1100_reg);
910}
911
912module_init(sa1100_serial_init);
913module_exit(sa1100_serial_exit);
914
915MODULE_AUTHOR("Deep Blue Solutions Ltd");
916MODULE_DESCRIPTION("SA1100 generic serial port driver");
917MODULE_LICENSE("GPL");
918MODULE_ALIAS_CHARDEV_MAJOR(SERIAL_SA1100_MAJOR);
919MODULE_ALIAS("platform:sa11x0-uart");
1// SPDX-License-Identifier: GPL-2.0+
2/*
3 * Driver for SA11x0 serial ports
4 *
5 * Based on drivers/char/serial.c, by Linus Torvalds, Theodore Ts'o.
6 *
7 * Copyright (C) 2000 Deep Blue Solutions Ltd.
8 */
9
10#include <linux/module.h>
11#include <linux/ioport.h>
12#include <linux/init.h>
13#include <linux/console.h>
14#include <linux/sysrq.h>
15#include <linux/platform_data/sa11x0-serial.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/io.h>
22
23#include <asm/irq.h>
24#include <mach/hardware.h>
25#include <mach/irqs.h>
26
27#include "serial_mctrl_gpio.h"
28
29/* We've been assigned a range on the "Low-density serial ports" major */
30#define SERIAL_SA1100_MAJOR 204
31#define MINOR_START 5
32
33#define NR_PORTS 3
34
35#define SA1100_ISR_PASS_LIMIT 256
36
37/*
38 * Convert from ignore_status_mask or read_status_mask to UTSR[01]
39 */
40#define SM_TO_UTSR0(x) ((x) & 0xff)
41#define SM_TO_UTSR1(x) ((x) >> 8)
42#define UTSR0_TO_SM(x) ((x))
43#define UTSR1_TO_SM(x) ((x) << 8)
44
45#define UART_GET_UTCR0(sport) __raw_readl((sport)->port.membase + UTCR0)
46#define UART_GET_UTCR1(sport) __raw_readl((sport)->port.membase + UTCR1)
47#define UART_GET_UTCR2(sport) __raw_readl((sport)->port.membase + UTCR2)
48#define UART_GET_UTCR3(sport) __raw_readl((sport)->port.membase + UTCR3)
49#define UART_GET_UTSR0(sport) __raw_readl((sport)->port.membase + UTSR0)
50#define UART_GET_UTSR1(sport) __raw_readl((sport)->port.membase + UTSR1)
51#define UART_GET_CHAR(sport) __raw_readl((sport)->port.membase + UTDR)
52
53#define UART_PUT_UTCR0(sport,v) __raw_writel((v),(sport)->port.membase + UTCR0)
54#define UART_PUT_UTCR1(sport,v) __raw_writel((v),(sport)->port.membase + UTCR1)
55#define UART_PUT_UTCR2(sport,v) __raw_writel((v),(sport)->port.membase + UTCR2)
56#define UART_PUT_UTCR3(sport,v) __raw_writel((v),(sport)->port.membase + UTCR3)
57#define UART_PUT_UTSR0(sport,v) __raw_writel((v),(sport)->port.membase + UTSR0)
58#define UART_PUT_UTSR1(sport,v) __raw_writel((v),(sport)->port.membase + UTSR1)
59#define UART_PUT_CHAR(sport,v) __raw_writel((v),(sport)->port.membase + UTDR)
60
61/*
62 * This is the size of our serial port register set.
63 */
64#define UART_PORT_SIZE 0x24
65
66/*
67 * This determines how often we check the modem status signals
68 * for any change. They generally aren't connected to an IRQ
69 * so we have to poll them. We also check immediately before
70 * filling the TX fifo incase CTS has been dropped.
71 */
72#define MCTRL_TIMEOUT (250*HZ/1000)
73
74struct sa1100_port {
75 struct uart_port port;
76 struct timer_list timer;
77 unsigned int old_status;
78 struct mctrl_gpios *gpios;
79};
80
81/*
82 * Handle any change of modem status signal since we were last called.
83 */
84static void sa1100_mctrl_check(struct sa1100_port *sport)
85{
86 unsigned int status, changed;
87
88 status = sport->port.ops->get_mctrl(&sport->port);
89 changed = status ^ sport->old_status;
90
91 if (changed == 0)
92 return;
93
94 sport->old_status = status;
95
96 if (changed & TIOCM_RI)
97 sport->port.icount.rng++;
98 if (changed & TIOCM_DSR)
99 sport->port.icount.dsr++;
100 if (changed & TIOCM_CAR)
101 uart_handle_dcd_change(&sport->port, status & TIOCM_CAR);
102 if (changed & TIOCM_CTS)
103 uart_handle_cts_change(&sport->port, status & TIOCM_CTS);
104
105 wake_up_interruptible(&sport->port.state->port.delta_msr_wait);
106}
107
108/*
109 * This is our per-port timeout handler, for checking the
110 * modem status signals.
111 */
112static void sa1100_timeout(struct timer_list *t)
113{
114 struct sa1100_port *sport = from_timer(sport, t, timer);
115 unsigned long flags;
116
117 if (sport->port.state) {
118 spin_lock_irqsave(&sport->port.lock, flags);
119 sa1100_mctrl_check(sport);
120 spin_unlock_irqrestore(&sport->port.lock, flags);
121
122 mod_timer(&sport->timer, jiffies + MCTRL_TIMEOUT);
123 }
124}
125
126/*
127 * interrupts disabled on entry
128 */
129static void sa1100_stop_tx(struct uart_port *port)
130{
131 struct sa1100_port *sport =
132 container_of(port, struct sa1100_port, port);
133 u32 utcr3;
134
135 utcr3 = UART_GET_UTCR3(sport);
136 UART_PUT_UTCR3(sport, utcr3 & ~UTCR3_TIE);
137 sport->port.read_status_mask &= ~UTSR0_TO_SM(UTSR0_TFS);
138}
139
140/*
141 * port locked and interrupts disabled
142 */
143static void sa1100_start_tx(struct uart_port *port)
144{
145 struct sa1100_port *sport =
146 container_of(port, struct sa1100_port, port);
147 u32 utcr3;
148
149 utcr3 = UART_GET_UTCR3(sport);
150 sport->port.read_status_mask |= UTSR0_TO_SM(UTSR0_TFS);
151 UART_PUT_UTCR3(sport, utcr3 | UTCR3_TIE);
152}
153
154/*
155 * Interrupts enabled
156 */
157static void sa1100_stop_rx(struct uart_port *port)
158{
159 struct sa1100_port *sport =
160 container_of(port, struct sa1100_port, port);
161 u32 utcr3;
162
163 utcr3 = UART_GET_UTCR3(sport);
164 UART_PUT_UTCR3(sport, utcr3 & ~UTCR3_RIE);
165}
166
167/*
168 * Set the modem control timer to fire immediately.
169 */
170static void sa1100_enable_ms(struct uart_port *port)
171{
172 struct sa1100_port *sport =
173 container_of(port, struct sa1100_port, port);
174
175 mod_timer(&sport->timer, jiffies);
176
177 mctrl_gpio_enable_ms(sport->gpios);
178}
179
180static void
181sa1100_rx_chars(struct sa1100_port *sport)
182{
183 unsigned int status, ch, flg;
184
185 status = UTSR1_TO_SM(UART_GET_UTSR1(sport)) |
186 UTSR0_TO_SM(UART_GET_UTSR0(sport));
187 while (status & UTSR1_TO_SM(UTSR1_RNE)) {
188 ch = UART_GET_CHAR(sport);
189
190 sport->port.icount.rx++;
191
192 flg = TTY_NORMAL;
193
194 /*
195 * note that the error handling code is
196 * out of the main execution path
197 */
198 if (status & UTSR1_TO_SM(UTSR1_PRE | UTSR1_FRE | UTSR1_ROR)) {
199 if (status & UTSR1_TO_SM(UTSR1_PRE))
200 sport->port.icount.parity++;
201 else if (status & UTSR1_TO_SM(UTSR1_FRE))
202 sport->port.icount.frame++;
203 if (status & UTSR1_TO_SM(UTSR1_ROR))
204 sport->port.icount.overrun++;
205
206 status &= sport->port.read_status_mask;
207
208 if (status & UTSR1_TO_SM(UTSR1_PRE))
209 flg = TTY_PARITY;
210 else if (status & UTSR1_TO_SM(UTSR1_FRE))
211 flg = TTY_FRAME;
212
213 sport->port.sysrq = 0;
214 }
215
216 if (uart_handle_sysrq_char(&sport->port, ch))
217 goto ignore_char;
218
219 uart_insert_char(&sport->port, status, UTSR1_TO_SM(UTSR1_ROR), ch, flg);
220
221 ignore_char:
222 status = UTSR1_TO_SM(UART_GET_UTSR1(sport)) |
223 UTSR0_TO_SM(UART_GET_UTSR0(sport));
224 }
225
226 tty_flip_buffer_push(&sport->port.state->port);
227}
228
229static void sa1100_tx_chars(struct sa1100_port *sport)
230{
231 u8 ch;
232
233 /*
234 * Check the modem control lines before
235 * transmitting anything.
236 */
237 sa1100_mctrl_check(sport);
238
239 uart_port_tx(&sport->port, ch,
240 UART_GET_UTSR1(sport) & UTSR1_TNF,
241 UART_PUT_CHAR(sport, ch));
242}
243
244static irqreturn_t sa1100_int(int irq, void *dev_id)
245{
246 struct sa1100_port *sport = dev_id;
247 unsigned int status, pass_counter = 0;
248
249 spin_lock(&sport->port.lock);
250 status = UART_GET_UTSR0(sport);
251 status &= SM_TO_UTSR0(sport->port.read_status_mask) | ~UTSR0_TFS;
252 do {
253 if (status & (UTSR0_RFS | UTSR0_RID)) {
254 /* Clear the receiver idle bit, if set */
255 if (status & UTSR0_RID)
256 UART_PUT_UTSR0(sport, UTSR0_RID);
257 sa1100_rx_chars(sport);
258 }
259
260 /* Clear the relevant break bits */
261 if (status & (UTSR0_RBB | UTSR0_REB))
262 UART_PUT_UTSR0(sport, status & (UTSR0_RBB | UTSR0_REB));
263
264 if (status & UTSR0_RBB)
265 sport->port.icount.brk++;
266
267 if (status & UTSR0_REB)
268 uart_handle_break(&sport->port);
269
270 if (status & UTSR0_TFS)
271 sa1100_tx_chars(sport);
272 if (pass_counter++ > SA1100_ISR_PASS_LIMIT)
273 break;
274 status = UART_GET_UTSR0(sport);
275 status &= SM_TO_UTSR0(sport->port.read_status_mask) |
276 ~UTSR0_TFS;
277 } while (status & (UTSR0_TFS | UTSR0_RFS | UTSR0_RID));
278 spin_unlock(&sport->port.lock);
279
280 return IRQ_HANDLED;
281}
282
283/*
284 * Return TIOCSER_TEMT when transmitter is not busy.
285 */
286static unsigned int sa1100_tx_empty(struct uart_port *port)
287{
288 struct sa1100_port *sport =
289 container_of(port, struct sa1100_port, port);
290
291 return UART_GET_UTSR1(sport) & UTSR1_TBY ? 0 : TIOCSER_TEMT;
292}
293
294static unsigned int sa1100_get_mctrl(struct uart_port *port)
295{
296 struct sa1100_port *sport =
297 container_of(port, struct sa1100_port, port);
298 int ret = TIOCM_CTS | TIOCM_DSR | TIOCM_CAR;
299
300 mctrl_gpio_get(sport->gpios, &ret);
301
302 return ret;
303}
304
305static void sa1100_set_mctrl(struct uart_port *port, unsigned int mctrl)
306{
307 struct sa1100_port *sport =
308 container_of(port, struct sa1100_port, port);
309
310 mctrl_gpio_set(sport->gpios, mctrl);
311}
312
313/*
314 * Interrupts always disabled.
315 */
316static void sa1100_break_ctl(struct uart_port *port, int break_state)
317{
318 struct sa1100_port *sport =
319 container_of(port, struct sa1100_port, port);
320 unsigned long flags;
321 unsigned int utcr3;
322
323 spin_lock_irqsave(&sport->port.lock, flags);
324 utcr3 = UART_GET_UTCR3(sport);
325 if (break_state == -1)
326 utcr3 |= UTCR3_BRK;
327 else
328 utcr3 &= ~UTCR3_BRK;
329 UART_PUT_UTCR3(sport, utcr3);
330 spin_unlock_irqrestore(&sport->port.lock, flags);
331}
332
333static int sa1100_startup(struct uart_port *port)
334{
335 struct sa1100_port *sport =
336 container_of(port, struct sa1100_port, port);
337 int retval;
338
339 /*
340 * Allocate the IRQ
341 */
342 retval = request_irq(sport->port.irq, sa1100_int, 0,
343 "sa11x0-uart", sport);
344 if (retval)
345 return retval;
346
347 /*
348 * Finally, clear and enable interrupts
349 */
350 UART_PUT_UTSR0(sport, -1);
351 UART_PUT_UTCR3(sport, UTCR3_RXE | UTCR3_TXE | UTCR3_RIE);
352
353 /*
354 * Enable modem status interrupts
355 */
356 spin_lock_irq(&sport->port.lock);
357 sa1100_enable_ms(&sport->port);
358 spin_unlock_irq(&sport->port.lock);
359
360 return 0;
361}
362
363static void sa1100_shutdown(struct uart_port *port)
364{
365 struct sa1100_port *sport =
366 container_of(port, struct sa1100_port, port);
367
368 /*
369 * Stop our timer.
370 */
371 del_timer_sync(&sport->timer);
372
373 /*
374 * Free the interrupt
375 */
376 free_irq(sport->port.irq, sport);
377
378 /*
379 * Disable all interrupts, port and break condition.
380 */
381 UART_PUT_UTCR3(sport, 0);
382}
383
384static void
385sa1100_set_termios(struct uart_port *port, struct ktermios *termios,
386 const struct ktermios *old)
387{
388 struct sa1100_port *sport =
389 container_of(port, struct sa1100_port, port);
390 unsigned long flags;
391 unsigned int utcr0, old_utcr3, baud, quot;
392 unsigned int old_csize = old ? old->c_cflag & CSIZE : CS8;
393
394 /*
395 * We only support CS7 and CS8.
396 */
397 while ((termios->c_cflag & CSIZE) != CS7 &&
398 (termios->c_cflag & CSIZE) != CS8) {
399 termios->c_cflag &= ~CSIZE;
400 termios->c_cflag |= old_csize;
401 old_csize = CS8;
402 }
403
404 if ((termios->c_cflag & CSIZE) == CS8)
405 utcr0 = UTCR0_DSS;
406 else
407 utcr0 = 0;
408
409 if (termios->c_cflag & CSTOPB)
410 utcr0 |= UTCR0_SBS;
411 if (termios->c_cflag & PARENB) {
412 utcr0 |= UTCR0_PE;
413 if (!(termios->c_cflag & PARODD))
414 utcr0 |= UTCR0_OES;
415 }
416
417 /*
418 * Ask the core to calculate the divisor for us.
419 */
420 baud = uart_get_baud_rate(port, termios, old, 0, port->uartclk/16);
421 quot = uart_get_divisor(port, baud);
422
423 del_timer_sync(&sport->timer);
424
425 spin_lock_irqsave(&sport->port.lock, flags);
426
427 sport->port.read_status_mask &= UTSR0_TO_SM(UTSR0_TFS);
428 sport->port.read_status_mask |= UTSR1_TO_SM(UTSR1_ROR);
429 if (termios->c_iflag & INPCK)
430 sport->port.read_status_mask |=
431 UTSR1_TO_SM(UTSR1_FRE | UTSR1_PRE);
432 if (termios->c_iflag & (BRKINT | PARMRK))
433 sport->port.read_status_mask |=
434 UTSR0_TO_SM(UTSR0_RBB | UTSR0_REB);
435
436 /*
437 * Characters to ignore
438 */
439 sport->port.ignore_status_mask = 0;
440 if (termios->c_iflag & IGNPAR)
441 sport->port.ignore_status_mask |=
442 UTSR1_TO_SM(UTSR1_FRE | UTSR1_PRE);
443 if (termios->c_iflag & IGNBRK) {
444 sport->port.ignore_status_mask |=
445 UTSR0_TO_SM(UTSR0_RBB | UTSR0_REB);
446 /*
447 * If we're ignoring parity and break indicators,
448 * ignore overruns too (for real raw support).
449 */
450 if (termios->c_iflag & IGNPAR)
451 sport->port.ignore_status_mask |=
452 UTSR1_TO_SM(UTSR1_ROR);
453 }
454
455 /*
456 * Update the per-port timeout.
457 */
458 uart_update_timeout(port, termios->c_cflag, baud);
459
460 /*
461 * disable interrupts and drain transmitter
462 */
463 old_utcr3 = UART_GET_UTCR3(sport);
464 UART_PUT_UTCR3(sport, old_utcr3 & ~(UTCR3_RIE | UTCR3_TIE));
465
466 while (UART_GET_UTSR1(sport) & UTSR1_TBY)
467 barrier();
468
469 /* then, disable everything */
470 UART_PUT_UTCR3(sport, 0);
471
472 /* set the parity, stop bits and data size */
473 UART_PUT_UTCR0(sport, utcr0);
474
475 /* set the baud rate */
476 quot -= 1;
477 UART_PUT_UTCR1(sport, ((quot & 0xf00) >> 8));
478 UART_PUT_UTCR2(sport, (quot & 0xff));
479
480 UART_PUT_UTSR0(sport, -1);
481
482 UART_PUT_UTCR3(sport, old_utcr3);
483
484 if (UART_ENABLE_MS(&sport->port, termios->c_cflag))
485 sa1100_enable_ms(&sport->port);
486
487 spin_unlock_irqrestore(&sport->port.lock, flags);
488}
489
490static const char *sa1100_type(struct uart_port *port)
491{
492 struct sa1100_port *sport =
493 container_of(port, struct sa1100_port, port);
494
495 return sport->port.type == PORT_SA1100 ? "SA1100" : NULL;
496}
497
498/*
499 * Release the memory region(s) being used by 'port'.
500 */
501static void sa1100_release_port(struct uart_port *port)
502{
503 struct sa1100_port *sport =
504 container_of(port, struct sa1100_port, port);
505
506 release_mem_region(sport->port.mapbase, UART_PORT_SIZE);
507}
508
509/*
510 * Request the memory region(s) being used by 'port'.
511 */
512static int sa1100_request_port(struct uart_port *port)
513{
514 struct sa1100_port *sport =
515 container_of(port, struct sa1100_port, port);
516
517 return request_mem_region(sport->port.mapbase, UART_PORT_SIZE,
518 "sa11x0-uart") != NULL ? 0 : -EBUSY;
519}
520
521/*
522 * Configure/autoconfigure the port.
523 */
524static void sa1100_config_port(struct uart_port *port, int flags)
525{
526 struct sa1100_port *sport =
527 container_of(port, struct sa1100_port, port);
528
529 if (flags & UART_CONFIG_TYPE &&
530 sa1100_request_port(&sport->port) == 0)
531 sport->port.type = PORT_SA1100;
532}
533
534/*
535 * Verify the new serial_struct (for TIOCSSERIAL).
536 * The only change we allow are to the flags and type, and
537 * even then only between PORT_SA1100 and PORT_UNKNOWN
538 */
539static int
540sa1100_verify_port(struct uart_port *port, struct serial_struct *ser)
541{
542 struct sa1100_port *sport =
543 container_of(port, struct sa1100_port, port);
544 int ret = 0;
545
546 if (ser->type != PORT_UNKNOWN && ser->type != PORT_SA1100)
547 ret = -EINVAL;
548 if (sport->port.irq != ser->irq)
549 ret = -EINVAL;
550 if (ser->io_type != SERIAL_IO_MEM)
551 ret = -EINVAL;
552 if (sport->port.uartclk / 16 != ser->baud_base)
553 ret = -EINVAL;
554 if ((void *)sport->port.mapbase != ser->iomem_base)
555 ret = -EINVAL;
556 if (sport->port.iobase != ser->port)
557 ret = -EINVAL;
558 if (ser->hub6 != 0)
559 ret = -EINVAL;
560 return ret;
561}
562
563static struct uart_ops sa1100_pops = {
564 .tx_empty = sa1100_tx_empty,
565 .set_mctrl = sa1100_set_mctrl,
566 .get_mctrl = sa1100_get_mctrl,
567 .stop_tx = sa1100_stop_tx,
568 .start_tx = sa1100_start_tx,
569 .stop_rx = sa1100_stop_rx,
570 .enable_ms = sa1100_enable_ms,
571 .break_ctl = sa1100_break_ctl,
572 .startup = sa1100_startup,
573 .shutdown = sa1100_shutdown,
574 .set_termios = sa1100_set_termios,
575 .type = sa1100_type,
576 .release_port = sa1100_release_port,
577 .request_port = sa1100_request_port,
578 .config_port = sa1100_config_port,
579 .verify_port = sa1100_verify_port,
580};
581
582static struct sa1100_port sa1100_ports[NR_PORTS];
583
584/*
585 * Setup the SA1100 serial ports. Note that we don't include the IrDA
586 * port here since we have our own SIR/FIR driver (see drivers/net/irda)
587 *
588 * Note also that we support "console=ttySAx" where "x" is either 0 or 1.
589 * Which serial port this ends up being depends on the machine you're
590 * running this kernel on. I'm not convinced that this is a good idea,
591 * but that's the way it traditionally works.
592 *
593 * Note that NanoEngine UART3 becomes UART2, and UART2 is no longer
594 * used here.
595 */
596static void __init sa1100_init_ports(void)
597{
598 static int first = 1;
599 int i;
600
601 if (!first)
602 return;
603 first = 0;
604
605 for (i = 0; i < NR_PORTS; i++) {
606 sa1100_ports[i].port.uartclk = 3686400;
607 sa1100_ports[i].port.ops = &sa1100_pops;
608 sa1100_ports[i].port.fifosize = 8;
609 sa1100_ports[i].port.line = i;
610 sa1100_ports[i].port.iotype = UPIO_MEM;
611 timer_setup(&sa1100_ports[i].timer, sa1100_timeout, 0);
612 }
613
614 /*
615 * make transmit lines outputs, so that when the port
616 * is closed, the output is in the MARK state.
617 */
618 PPDR |= PPC_TXD1 | PPC_TXD3;
619 PPSR |= PPC_TXD1 | PPC_TXD3;
620}
621
622void sa1100_register_uart_fns(struct sa1100_port_fns *fns)
623{
624 if (fns->get_mctrl)
625 sa1100_pops.get_mctrl = fns->get_mctrl;
626 if (fns->set_mctrl)
627 sa1100_pops.set_mctrl = fns->set_mctrl;
628
629 sa1100_pops.pm = fns->pm;
630 /*
631 * FIXME: fns->set_wake is unused - this should be called from
632 * the suspend() callback if device_may_wakeup(dev)) is set.
633 */
634}
635
636void __init sa1100_register_uart(int idx, int port)
637{
638 if (idx >= NR_PORTS) {
639 printk(KERN_ERR "%s: bad index number %d\n", __func__, idx);
640 return;
641 }
642
643 switch (port) {
644 case 1:
645 sa1100_ports[idx].port.membase = (void __iomem *)&Ser1UTCR0;
646 sa1100_ports[idx].port.mapbase = _Ser1UTCR0;
647 sa1100_ports[idx].port.irq = IRQ_Ser1UART;
648 sa1100_ports[idx].port.flags = UPF_BOOT_AUTOCONF;
649 break;
650
651 case 2:
652 sa1100_ports[idx].port.membase = (void __iomem *)&Ser2UTCR0;
653 sa1100_ports[idx].port.mapbase = _Ser2UTCR0;
654 sa1100_ports[idx].port.irq = IRQ_Ser2ICP;
655 sa1100_ports[idx].port.flags = UPF_BOOT_AUTOCONF;
656 break;
657
658 case 3:
659 sa1100_ports[idx].port.membase = (void __iomem *)&Ser3UTCR0;
660 sa1100_ports[idx].port.mapbase = _Ser3UTCR0;
661 sa1100_ports[idx].port.irq = IRQ_Ser3UART;
662 sa1100_ports[idx].port.flags = UPF_BOOT_AUTOCONF;
663 break;
664
665 default:
666 printk(KERN_ERR "%s: bad port number %d\n", __func__, port);
667 }
668}
669
670
671#ifdef CONFIG_SERIAL_SA1100_CONSOLE
672static void sa1100_console_putchar(struct uart_port *port, unsigned char ch)
673{
674 struct sa1100_port *sport =
675 container_of(port, struct sa1100_port, port);
676
677 while (!(UART_GET_UTSR1(sport) & UTSR1_TNF))
678 barrier();
679 UART_PUT_CHAR(sport, ch);
680}
681
682/*
683 * Interrupts are disabled on entering
684 */
685static void
686sa1100_console_write(struct console *co, const char *s, unsigned int count)
687{
688 struct sa1100_port *sport = &sa1100_ports[co->index];
689 unsigned int old_utcr3, status;
690
691 /*
692 * First, save UTCR3 and then disable interrupts
693 */
694 old_utcr3 = UART_GET_UTCR3(sport);
695 UART_PUT_UTCR3(sport, (old_utcr3 & ~(UTCR3_RIE | UTCR3_TIE)) |
696 UTCR3_TXE);
697
698 uart_console_write(&sport->port, s, count, sa1100_console_putchar);
699
700 /*
701 * Finally, wait for transmitter to become empty
702 * and restore UTCR3
703 */
704 do {
705 status = UART_GET_UTSR1(sport);
706 } while (status & UTSR1_TBY);
707 UART_PUT_UTCR3(sport, old_utcr3);
708}
709
710/*
711 * If the port was already initialised (eg, by a boot loader),
712 * try to determine the current setup.
713 */
714static void __init
715sa1100_console_get_options(struct sa1100_port *sport, int *baud,
716 int *parity, int *bits)
717{
718 unsigned int utcr3;
719
720 utcr3 = UART_GET_UTCR3(sport) & (UTCR3_RXE | UTCR3_TXE);
721 if (utcr3 == (UTCR3_RXE | UTCR3_TXE)) {
722 /* ok, the port was enabled */
723 unsigned int utcr0, quot;
724
725 utcr0 = UART_GET_UTCR0(sport);
726
727 *parity = 'n';
728 if (utcr0 & UTCR0_PE) {
729 if (utcr0 & UTCR0_OES)
730 *parity = 'e';
731 else
732 *parity = 'o';
733 }
734
735 if (utcr0 & UTCR0_DSS)
736 *bits = 8;
737 else
738 *bits = 7;
739
740 quot = UART_GET_UTCR2(sport) | UART_GET_UTCR1(sport) << 8;
741 quot &= 0xfff;
742 *baud = sport->port.uartclk / (16 * (quot + 1));
743 }
744}
745
746static int __init
747sa1100_console_setup(struct console *co, char *options)
748{
749 struct sa1100_port *sport;
750 int baud = 9600;
751 int bits = 8;
752 int parity = 'n';
753 int flow = 'n';
754
755 /*
756 * Check whether an invalid uart number has been specified, and
757 * if so, search for the first available port that does have
758 * console support.
759 */
760 if (co->index == -1 || co->index >= NR_PORTS)
761 co->index = 0;
762 sport = &sa1100_ports[co->index];
763
764 if (options)
765 uart_parse_options(options, &baud, &parity, &bits, &flow);
766 else
767 sa1100_console_get_options(sport, &baud, &parity, &bits);
768
769 return uart_set_options(&sport->port, co, baud, parity, bits, flow);
770}
771
772static struct uart_driver sa1100_reg;
773static struct console sa1100_console = {
774 .name = "ttySA",
775 .write = sa1100_console_write,
776 .device = uart_console_device,
777 .setup = sa1100_console_setup,
778 .flags = CON_PRINTBUFFER,
779 .index = -1,
780 .data = &sa1100_reg,
781};
782
783static int __init sa1100_rs_console_init(void)
784{
785 sa1100_init_ports();
786 register_console(&sa1100_console);
787 return 0;
788}
789console_initcall(sa1100_rs_console_init);
790
791#define SA1100_CONSOLE &sa1100_console
792#else
793#define SA1100_CONSOLE NULL
794#endif
795
796static struct uart_driver sa1100_reg = {
797 .owner = THIS_MODULE,
798 .driver_name = "ttySA",
799 .dev_name = "ttySA",
800 .major = SERIAL_SA1100_MAJOR,
801 .minor = MINOR_START,
802 .nr = NR_PORTS,
803 .cons = SA1100_CONSOLE,
804};
805
806static int sa1100_serial_suspend(struct platform_device *dev, pm_message_t state)
807{
808 struct sa1100_port *sport = platform_get_drvdata(dev);
809
810 if (sport)
811 uart_suspend_port(&sa1100_reg, &sport->port);
812
813 return 0;
814}
815
816static int sa1100_serial_resume(struct platform_device *dev)
817{
818 struct sa1100_port *sport = platform_get_drvdata(dev);
819
820 if (sport)
821 uart_resume_port(&sa1100_reg, &sport->port);
822
823 return 0;
824}
825
826static int sa1100_serial_add_one_port(struct sa1100_port *sport, struct platform_device *dev)
827{
828 sport->port.dev = &dev->dev;
829 sport->port.has_sysrq = IS_ENABLED(CONFIG_SERIAL_SA1100_CONSOLE);
830
831 // mctrl_gpio_init() requires that the GPIO driver supports interrupts,
832 // but we need to support GPIO drivers for hardware that has no such
833 // interrupts. Use mctrl_gpio_init_noauto() instead.
834 sport->gpios = mctrl_gpio_init_noauto(sport->port.dev, 0);
835 if (IS_ERR(sport->gpios)) {
836 int err = PTR_ERR(sport->gpios);
837
838 dev_err(sport->port.dev, "failed to get mctrl gpios: %d\n",
839 err);
840
841 if (err == -EPROBE_DEFER)
842 return err;
843
844 sport->gpios = NULL;
845 }
846
847 platform_set_drvdata(dev, sport);
848
849 return uart_add_one_port(&sa1100_reg, &sport->port);
850}
851
852static int sa1100_serial_probe(struct platform_device *dev)
853{
854 struct resource *res;
855 int i;
856
857 res = platform_get_resource(dev, IORESOURCE_MEM, 0);
858 if (!res)
859 return -EINVAL;
860
861 for (i = 0; i < NR_PORTS; i++)
862 if (sa1100_ports[i].port.mapbase == res->start)
863 break;
864 if (i == NR_PORTS)
865 return -ENODEV;
866
867 sa1100_serial_add_one_port(&sa1100_ports[i], dev);
868
869 return 0;
870}
871
872static int sa1100_serial_remove(struct platform_device *pdev)
873{
874 struct sa1100_port *sport = platform_get_drvdata(pdev);
875
876 if (sport)
877 uart_remove_one_port(&sa1100_reg, &sport->port);
878
879 return 0;
880}
881
882static struct platform_driver sa11x0_serial_driver = {
883 .probe = sa1100_serial_probe,
884 .remove = sa1100_serial_remove,
885 .suspend = sa1100_serial_suspend,
886 .resume = sa1100_serial_resume,
887 .driver = {
888 .name = "sa11x0-uart",
889 },
890};
891
892static int __init sa1100_serial_init(void)
893{
894 int ret;
895
896 printk(KERN_INFO "Serial: SA11x0 driver\n");
897
898 sa1100_init_ports();
899
900 ret = uart_register_driver(&sa1100_reg);
901 if (ret == 0) {
902 ret = platform_driver_register(&sa11x0_serial_driver);
903 if (ret)
904 uart_unregister_driver(&sa1100_reg);
905 }
906 return ret;
907}
908
909static void __exit sa1100_serial_exit(void)
910{
911 platform_driver_unregister(&sa11x0_serial_driver);
912 uart_unregister_driver(&sa1100_reg);
913}
914
915module_init(sa1100_serial_init);
916module_exit(sa1100_serial_exit);
917
918MODULE_AUTHOR("Deep Blue Solutions Ltd");
919MODULE_DESCRIPTION("SA1100 generic serial port driver");
920MODULE_LICENSE("GPL");
921MODULE_ALIAS_CHARDEV_MAJOR(SERIAL_SA1100_MAJOR);
922MODULE_ALIAS("platform:sa11x0-uart");