1 /* sunzilog.c: Zilog serial driver for Sparc systems.
3 * Driver for Zilog serial chips found on Sun workstations and
4 * servers. This driver could actually be made more generic.
6 * This is based on the old drivers/sbus/char/zs.c code. A lot
7 * of code has been simply moved over directly from there but
8 * much has been rewritten. Credits therefore go out to Eddie
9 * C. Dost, Pete Zaitcev, Ted Ts'o and Alex Buell for their
12 * Copyright (C) 2002, 2006, 2007 David S. Miller (davem@davemloft.net)
15 #include <linux/module.h>
16 #include <linux/kernel.h>
17 #include <linux/errno.h>
18 #include <linux/delay.h>
19 #include <linux/tty.h>
20 #include <linux/tty_flip.h>
21 #include <linux/major.h>
22 #include <linux/string.h>
23 #include <linux/ptrace.h>
24 #include <linux/ioport.h>
25 #include <linux/slab.h>
26 #include <linux/circ_buf.h>
27 #include <linux/serial.h>
28 #include <linux/sysrq.h>
29 #include <linux/console.h>
30 #include <linux/spinlock.h>
32 #include <linux/serio.h>
34 #include <linux/init.h>
35 #include <linux/of_device.h>
41 #if defined(CONFIG_SERIAL_SUNZILOG_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
45 #include <linux/serial_core.h>
50 /* On 32-bit sparcs we need to delay after register accesses
51 * to accommodate sun4 systems, but we do not need to flush writes.
52 * On 64-bit sparc we only need to flush single writes to ensure
55 #ifndef CONFIG_SPARC64
56 #define ZSDELAY() udelay(5)
57 #define ZSDELAY_LONG() udelay(20)
58 #define ZS_WSYNC(channel) do { } while (0)
61 #define ZSDELAY_LONG()
62 #define ZS_WSYNC(__channel) \
63 readb(&((__channel)->control))
66 #define ZS_CLOCK 4915200 /* Zilog input clock rate. */
67 #define ZS_CLOCK_DIVISOR 16 /* Divisor this driver uses. */
70 * We wrap our port structure around the generic uart_port.
72 struct uart_sunzilog_port {
73 struct uart_port port;
75 /* IRQ servicing chain. */
76 struct uart_sunzilog_port *next;
78 /* Current values of Zilog write registers. */
79 unsigned char curregs[NUM_ZSREGS];
82 #define SUNZILOG_FLAG_CONS_KEYB 0x00000001
83 #define SUNZILOG_FLAG_CONS_MOUSE 0x00000002
84 #define SUNZILOG_FLAG_IS_CONS 0x00000004
85 #define SUNZILOG_FLAG_IS_KGDB 0x00000008
86 #define SUNZILOG_FLAG_MODEM_STATUS 0x00000010
87 #define SUNZILOG_FLAG_IS_CHANNEL_A 0x00000020
88 #define SUNZILOG_FLAG_REGS_HELD 0x00000040
89 #define SUNZILOG_FLAG_TX_STOPPED 0x00000080
90 #define SUNZILOG_FLAG_TX_ACTIVE 0x00000100
91 #define SUNZILOG_FLAG_ESCC 0x00000200
92 #define SUNZILOG_FLAG_ISR_HANDLER 0x00000400
96 unsigned char parity_mask;
97 unsigned char prev_status;
105 #define ZILOG_CHANNEL_FROM_PORT(PORT) ((struct zilog_channel __iomem *)((PORT)->membase))
106 #define UART_ZILOG(PORT) ((struct uart_sunzilog_port *)(PORT))
108 #define ZS_IS_KEYB(UP) ((UP)->flags & SUNZILOG_FLAG_CONS_KEYB)
109 #define ZS_IS_MOUSE(UP) ((UP)->flags & SUNZILOG_FLAG_CONS_MOUSE)
110 #define ZS_IS_CONS(UP) ((UP)->flags & SUNZILOG_FLAG_IS_CONS)
111 #define ZS_IS_KGDB(UP) ((UP)->flags & SUNZILOG_FLAG_IS_KGDB)
112 #define ZS_WANTS_MODEM_STATUS(UP) ((UP)->flags & SUNZILOG_FLAG_MODEM_STATUS)
113 #define ZS_IS_CHANNEL_A(UP) ((UP)->flags & SUNZILOG_FLAG_IS_CHANNEL_A)
114 #define ZS_REGS_HELD(UP) ((UP)->flags & SUNZILOG_FLAG_REGS_HELD)
115 #define ZS_TX_STOPPED(UP) ((UP)->flags & SUNZILOG_FLAG_TX_STOPPED)
116 #define ZS_TX_ACTIVE(UP) ((UP)->flags & SUNZILOG_FLAG_TX_ACTIVE)
118 /* Reading and writing Zilog8530 registers. The delays are to make this
119 * driver work on the Sun4 which needs a settling delay after each chip
120 * register access, other machines handle this in hardware via auxiliary
121 * flip-flops which implement the settle time we do in software.
123 * The port lock must be held and local IRQs must be disabled
124 * when {read,write}_zsreg is invoked.
126 static unsigned char read_zsreg(struct zilog_channel __iomem *channel,
129 unsigned char retval;
131 writeb(reg, &channel->control);
133 retval = readb(&channel->control);
139 static void write_zsreg(struct zilog_channel __iomem *channel,
140 unsigned char reg, unsigned char value)
142 writeb(reg, &channel->control);
144 writeb(value, &channel->control);
148 static void sunzilog_clear_fifo(struct zilog_channel __iomem *channel)
152 for (i = 0; i < 32; i++) {
153 unsigned char regval;
155 regval = readb(&channel->control);
157 if (regval & Rx_CH_AV)
160 regval = read_zsreg(channel, R1);
161 readb(&channel->data);
164 if (regval & (PAR_ERR | Rx_OVR | CRC_ERR)) {
165 writeb(ERR_RES, &channel->control);
172 /* This function must only be called when the TX is not busy. The UART
173 * port lock must be held and local interrupts disabled.
175 static int __load_zsregs(struct zilog_channel __iomem *channel, unsigned char *regs)
181 /* Let pending transmits finish. */
182 for (i = 0; i < 1000; i++) {
183 unsigned char stat = read_zsreg(channel, R1);
189 writeb(ERR_RES, &channel->control);
193 sunzilog_clear_fifo(channel);
195 /* Disable all interrupts. */
196 write_zsreg(channel, R1,
197 regs[R1] & ~(RxINT_MASK | TxINT_ENAB | EXT_INT_ENAB));
199 /* Set parity, sync config, stop bits, and clock divisor. */
200 write_zsreg(channel, R4, regs[R4]);
202 /* Set misc. TX/RX control bits. */
203 write_zsreg(channel, R10, regs[R10]);
205 /* Set TX/RX controls sans the enable bits. */
206 write_zsreg(channel, R3, regs[R3] & ~RxENAB);
207 write_zsreg(channel, R5, regs[R5] & ~TxENAB);
209 /* Synchronous mode config. */
210 write_zsreg(channel, R6, regs[R6]);
211 write_zsreg(channel, R7, regs[R7]);
213 /* Don't mess with the interrupt vector (R2, unused by us) and
214 * master interrupt control (R9). We make sure this is setup
215 * properly at probe time then never touch it again.
218 /* Disable baud generator. */
219 write_zsreg(channel, R14, regs[R14] & ~BRENAB);
221 /* Clock mode control. */
222 write_zsreg(channel, R11, regs[R11]);
224 /* Lower and upper byte of baud rate generator divisor. */
225 write_zsreg(channel, R12, regs[R12]);
226 write_zsreg(channel, R13, regs[R13]);
228 /* Now rewrite R14, with BRENAB (if set). */
229 write_zsreg(channel, R14, regs[R14]);
231 /* External status interrupt control. */
232 write_zsreg(channel, R15, (regs[R15] | WR7pEN) & ~FIFOEN);
234 /* ESCC Extension Register */
235 r15 = read_zsreg(channel, R15);
237 write_zsreg(channel, R7, regs[R7p]);
239 /* External status interrupt and FIFO control. */
240 write_zsreg(channel, R15, regs[R15] & ~WR7pEN);
243 /* Clear FIFO bit case it is an issue */
244 regs[R15] &= ~FIFOEN;
248 /* Reset external status interrupts. */
249 write_zsreg(channel, R0, RES_EXT_INT); /* First Latch */
250 write_zsreg(channel, R0, RES_EXT_INT); /* Second Latch */
252 /* Rewrite R3/R5, this time without enables masked. */
253 write_zsreg(channel, R3, regs[R3]);
254 write_zsreg(channel, R5, regs[R5]);
256 /* Rewrite R1, this time without IRQ enabled masked. */
257 write_zsreg(channel, R1, regs[R1]);
262 /* Reprogram the Zilog channel HW registers with the copies found in the
263 * software state struct. If the transmitter is busy, we defer this update
264 * until the next TX complete interrupt. Else, we do it right now.
266 * The UART port lock must be held and local interrupts disabled.
268 static void sunzilog_maybe_update_regs(struct uart_sunzilog_port *up,
269 struct zilog_channel __iomem *channel)
271 if (!ZS_REGS_HELD(up)) {
272 if (ZS_TX_ACTIVE(up)) {
273 up->flags |= SUNZILOG_FLAG_REGS_HELD;
275 __load_zsregs(channel, up->curregs);
280 static void sunzilog_change_mouse_baud(struct uart_sunzilog_port *up)
282 unsigned int cur_cflag = up->cflag;
286 up->cflag |= suncore_mouse_baud_cflag_next(cur_cflag, &new_baud);
288 brg = BPS_TO_BRG(new_baud, ZS_CLOCK / ZS_CLOCK_DIVISOR);
289 up->curregs[R12] = (brg & 0xff);
290 up->curregs[R13] = (brg >> 8) & 0xff;
291 sunzilog_maybe_update_regs(up, ZILOG_CHANNEL_FROM_PORT(&up->port));
294 static void sunzilog_kbdms_receive_chars(struct uart_sunzilog_port *up,
295 unsigned char ch, int is_break)
297 if (ZS_IS_KEYB(up)) {
298 /* Stop-A is handled by drivers/char/keyboard.c now. */
301 serio_interrupt(&up->serio, ch, 0);
303 } else if (ZS_IS_MOUSE(up)) {
304 int ret = suncore_mouse_baud_detection(ch, is_break);
308 sunzilog_change_mouse_baud(up);
316 serio_interrupt(&up->serio, ch, 0);
323 static struct tty_struct *
324 sunzilog_receive_chars(struct uart_sunzilog_port *up,
325 struct zilog_channel __iomem *channel)
327 struct tty_struct *tty;
328 unsigned char ch, r1, flag;
331 if (up->port.info != NULL && /* Unopened serial console */
332 up->port.info->port.tty != NULL) /* Keyboard || mouse */
333 tty = up->port.info->port.tty;
337 r1 = read_zsreg(channel, R1);
338 if (r1 & (PAR_ERR | Rx_OVR | CRC_ERR)) {
339 writeb(ERR_RES, &channel->control);
344 ch = readb(&channel->control);
347 /* This funny hack depends upon BRK_ABRT not interfering
348 * with the other bits we care about in R1.
353 if (!(ch & Rx_CH_AV))
356 ch = readb(&channel->data);
359 ch &= up->parity_mask;
361 if (unlikely(ZS_IS_KEYB(up)) || unlikely(ZS_IS_MOUSE(up))) {
362 sunzilog_kbdms_receive_chars(up, ch, 0);
367 uart_handle_sysrq_char(&up->port, ch);
371 /* A real serial line, record the character and status. */
373 up->port.icount.rx++;
374 if (r1 & (BRK_ABRT | PAR_ERR | Rx_OVR | CRC_ERR)) {
376 r1 &= ~(PAR_ERR | CRC_ERR);
377 up->port.icount.brk++;
378 if (uart_handle_break(&up->port))
381 else if (r1 & PAR_ERR)
382 up->port.icount.parity++;
383 else if (r1 & CRC_ERR)
384 up->port.icount.frame++;
386 up->port.icount.overrun++;
387 r1 &= up->port.read_status_mask;
390 else if (r1 & PAR_ERR)
392 else if (r1 & CRC_ERR)
395 if (uart_handle_sysrq_char(&up->port, ch))
398 if (up->port.ignore_status_mask == 0xff ||
399 (r1 & up->port.ignore_status_mask) == 0) {
400 tty_insert_flip_char(tty, ch, flag);
403 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
409 static void sunzilog_status_handle(struct uart_sunzilog_port *up,
410 struct zilog_channel __iomem *channel)
412 unsigned char status;
414 status = readb(&channel->control);
417 writeb(RES_EXT_INT, &channel->control);
421 if (status & BRK_ABRT) {
423 sunzilog_kbdms_receive_chars(up, 0, 1);
424 if (ZS_IS_CONS(up)) {
425 /* Wait for BREAK to deassert to avoid potentially
426 * confusing the PROM.
429 status = readb(&channel->control);
431 if (!(status & BRK_ABRT))
439 if (ZS_WANTS_MODEM_STATUS(up)) {
441 up->port.icount.dsr++;
443 /* The Zilog just gives us an interrupt when DCD/CTS/etc. change.
444 * But it does not tell us which bit has changed, we have to keep
445 * track of this ourselves.
447 if ((status ^ up->prev_status) ^ DCD)
448 uart_handle_dcd_change(&up->port,
450 if ((status ^ up->prev_status) ^ CTS)
451 uart_handle_cts_change(&up->port,
454 wake_up_interruptible(&up->port.info->delta_msr_wait);
457 up->prev_status = status;
460 static void sunzilog_transmit_chars(struct uart_sunzilog_port *up,
461 struct zilog_channel __iomem *channel)
463 struct circ_buf *xmit;
465 if (ZS_IS_CONS(up)) {
466 unsigned char status = readb(&channel->control);
469 /* TX still busy? Just wait for the next TX done interrupt.
471 * It can occur because of how we do serial console writes. It would
472 * be nice to transmit console writes just like we normally would for
473 * a TTY line. (ie. buffered and TX interrupt driven). That is not
474 * easy because console writes cannot sleep. One solution might be
475 * to poll on enough port->xmit space becomming free. -DaveM
477 if (!(status & Tx_BUF_EMP))
481 up->flags &= ~SUNZILOG_FLAG_TX_ACTIVE;
483 if (ZS_REGS_HELD(up)) {
484 __load_zsregs(channel, up->curregs);
485 up->flags &= ~SUNZILOG_FLAG_REGS_HELD;
488 if (ZS_TX_STOPPED(up)) {
489 up->flags &= ~SUNZILOG_FLAG_TX_STOPPED;
493 if (up->port.x_char) {
494 up->flags |= SUNZILOG_FLAG_TX_ACTIVE;
495 writeb(up->port.x_char, &channel->data);
499 up->port.icount.tx++;
504 if (up->port.info == NULL)
506 xmit = &up->port.info->xmit;
507 if (uart_circ_empty(xmit))
510 if (uart_tx_stopped(&up->port))
513 up->flags |= SUNZILOG_FLAG_TX_ACTIVE;
514 writeb(xmit->buf[xmit->tail], &channel->data);
518 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
519 up->port.icount.tx++;
521 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
522 uart_write_wakeup(&up->port);
527 writeb(RES_Tx_P, &channel->control);
532 static irqreturn_t sunzilog_interrupt(int irq, void *dev_id)
534 struct uart_sunzilog_port *up = dev_id;
537 struct zilog_channel __iomem *channel
538 = ZILOG_CHANNEL_FROM_PORT(&up->port);
539 struct tty_struct *tty;
542 spin_lock(&up->port.lock);
543 r3 = read_zsreg(channel, R3);
547 if (r3 & (CHAEXT | CHATxIP | CHARxIP)) {
548 writeb(RES_H_IUS, &channel->control);
553 tty = sunzilog_receive_chars(up, channel);
555 sunzilog_status_handle(up, channel);
557 sunzilog_transmit_chars(up, channel);
559 spin_unlock(&up->port.lock);
562 tty_flip_buffer_push(tty);
566 channel = ZILOG_CHANNEL_FROM_PORT(&up->port);
568 spin_lock(&up->port.lock);
570 if (r3 & (CHBEXT | CHBTxIP | CHBRxIP)) {
571 writeb(RES_H_IUS, &channel->control);
576 tty = sunzilog_receive_chars(up, channel);
578 sunzilog_status_handle(up, channel);
580 sunzilog_transmit_chars(up, channel);
582 spin_unlock(&up->port.lock);
585 tty_flip_buffer_push(tty);
593 /* A convenient way to quickly get R0 status. The caller must _not_ hold the
594 * port lock, it is acquired here.
596 static __inline__ unsigned char sunzilog_read_channel_status(struct uart_port *port)
598 struct zilog_channel __iomem *channel;
599 unsigned char status;
601 channel = ZILOG_CHANNEL_FROM_PORT(port);
602 status = readb(&channel->control);
608 /* The port lock is not held. */
609 static unsigned int sunzilog_tx_empty(struct uart_port *port)
612 unsigned char status;
615 spin_lock_irqsave(&port->lock, flags);
617 status = sunzilog_read_channel_status(port);
619 spin_unlock_irqrestore(&port->lock, flags);
621 if (status & Tx_BUF_EMP)
629 /* The port lock is held and interrupts are disabled. */
630 static unsigned int sunzilog_get_mctrl(struct uart_port *port)
632 unsigned char status;
635 status = sunzilog_read_channel_status(port);
648 /* The port lock is held and interrupts are disabled. */
649 static void sunzilog_set_mctrl(struct uart_port *port, unsigned int mctrl)
651 struct uart_sunzilog_port *up = (struct uart_sunzilog_port *) port;
652 struct zilog_channel __iomem *channel = ZILOG_CHANNEL_FROM_PORT(port);
653 unsigned char set_bits, clear_bits;
655 set_bits = clear_bits = 0;
657 if (mctrl & TIOCM_RTS)
661 if (mctrl & TIOCM_DTR)
666 /* NOTE: Not subject to 'transmitter active' rule. */
667 up->curregs[R5] |= set_bits;
668 up->curregs[R5] &= ~clear_bits;
669 write_zsreg(channel, R5, up->curregs[R5]);
672 /* The port lock is held and interrupts are disabled. */
673 static void sunzilog_stop_tx(struct uart_port *port)
675 struct uart_sunzilog_port *up = (struct uart_sunzilog_port *) port;
677 up->flags |= SUNZILOG_FLAG_TX_STOPPED;
680 /* The port lock is held and interrupts are disabled. */
681 static void sunzilog_start_tx(struct uart_port *port)
683 struct uart_sunzilog_port *up = (struct uart_sunzilog_port *) port;
684 struct zilog_channel __iomem *channel = ZILOG_CHANNEL_FROM_PORT(port);
685 unsigned char status;
687 up->flags |= SUNZILOG_FLAG_TX_ACTIVE;
688 up->flags &= ~SUNZILOG_FLAG_TX_STOPPED;
690 status = readb(&channel->control);
693 /* TX busy? Just wait for the TX done interrupt. */
694 if (!(status & Tx_BUF_EMP))
697 /* Send the first character to jump-start the TX done
698 * IRQ sending engine.
701 writeb(port->x_char, &channel->data);
708 struct circ_buf *xmit = &port->info->xmit;
710 writeb(xmit->buf[xmit->tail], &channel->data);
714 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
717 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
718 uart_write_wakeup(&up->port);
722 /* The port lock is held. */
723 static void sunzilog_stop_rx(struct uart_port *port)
725 struct uart_sunzilog_port *up = UART_ZILOG(port);
726 struct zilog_channel __iomem *channel;
731 channel = ZILOG_CHANNEL_FROM_PORT(port);
733 /* Disable all RX interrupts. */
734 up->curregs[R1] &= ~RxINT_MASK;
735 sunzilog_maybe_update_regs(up, channel);
738 /* The port lock is held. */
739 static void sunzilog_enable_ms(struct uart_port *port)
741 struct uart_sunzilog_port *up = (struct uart_sunzilog_port *) port;
742 struct zilog_channel __iomem *channel = ZILOG_CHANNEL_FROM_PORT(port);
743 unsigned char new_reg;
745 new_reg = up->curregs[R15] | (DCDIE | SYNCIE | CTSIE);
746 if (new_reg != up->curregs[R15]) {
747 up->curregs[R15] = new_reg;
749 /* NOTE: Not subject to 'transmitter active' rule. */
750 write_zsreg(channel, R15, up->curregs[R15] & ~WR7pEN);
754 /* The port lock is not held. */
755 static void sunzilog_break_ctl(struct uart_port *port, int break_state)
757 struct uart_sunzilog_port *up = (struct uart_sunzilog_port *) port;
758 struct zilog_channel __iomem *channel = ZILOG_CHANNEL_FROM_PORT(port);
759 unsigned char set_bits, clear_bits, new_reg;
762 set_bits = clear_bits = 0;
767 clear_bits |= SND_BRK;
769 spin_lock_irqsave(&port->lock, flags);
771 new_reg = (up->curregs[R5] | set_bits) & ~clear_bits;
772 if (new_reg != up->curregs[R5]) {
773 up->curregs[R5] = new_reg;
775 /* NOTE: Not subject to 'transmitter active' rule. */
776 write_zsreg(channel, R5, up->curregs[R5]);
779 spin_unlock_irqrestore(&port->lock, flags);
782 static void __sunzilog_startup(struct uart_sunzilog_port *up)
784 struct zilog_channel __iomem *channel;
786 channel = ZILOG_CHANNEL_FROM_PORT(&up->port);
787 up->prev_status = readb(&channel->control);
789 /* Enable receiver and transmitter. */
790 up->curregs[R3] |= RxENAB;
791 up->curregs[R5] |= TxENAB;
793 up->curregs[R1] |= EXT_INT_ENAB | INT_ALL_Rx | TxINT_ENAB;
794 sunzilog_maybe_update_regs(up, channel);
797 static int sunzilog_startup(struct uart_port *port)
799 struct uart_sunzilog_port *up = UART_ZILOG(port);
805 spin_lock_irqsave(&port->lock, flags);
806 __sunzilog_startup(up);
807 spin_unlock_irqrestore(&port->lock, flags);
812 * The test for ZS_IS_CONS is explained by the following e-mail:
814 * From: Russell King <rmk@arm.linux.org.uk>
815 * Date: Sun, 8 Dec 2002 10:18:38 +0000
817 * On Sun, Dec 08, 2002 at 02:43:36AM -0500, Pete Zaitcev wrote:
818 * > I boot my 2.5 boxes using "console=ttyS0,9600" argument,
819 * > and I noticed that something is not right with reference
820 * > counting in this case. It seems that when the console
821 * > is open by kernel initially, this is not accounted
822 * > as an open, and uart_startup is not called.
824 * That is correct. We are unable to call uart_startup when the serial
825 * console is initialised because it may need to allocate memory (as
826 * request_irq does) and the memory allocators may not have been
829 * 1. initialise the port into a state where it can send characters in the
830 * console write method.
832 * 2. don't do the actual hardware shutdown in your shutdown() method (but
833 * do the normal software shutdown - ie, free irqs etc)
836 static void sunzilog_shutdown(struct uart_port *port)
838 struct uart_sunzilog_port *up = UART_ZILOG(port);
839 struct zilog_channel __iomem *channel;
845 spin_lock_irqsave(&port->lock, flags);
847 channel = ZILOG_CHANNEL_FROM_PORT(port);
849 /* Disable receiver and transmitter. */
850 up->curregs[R3] &= ~RxENAB;
851 up->curregs[R5] &= ~TxENAB;
853 /* Disable all interrupts and BRK assertion. */
854 up->curregs[R1] &= ~(EXT_INT_ENAB | TxINT_ENAB | RxINT_MASK);
855 up->curregs[R5] &= ~SND_BRK;
856 sunzilog_maybe_update_regs(up, channel);
858 spin_unlock_irqrestore(&port->lock, flags);
861 /* Shared by TTY driver and serial console setup. The port lock is held
862 * and local interrupts are disabled.
865 sunzilog_convert_to_zs(struct uart_sunzilog_port *up, unsigned int cflag,
866 unsigned int iflag, int brg)
869 up->curregs[R10] = NRZ;
870 up->curregs[R11] = TCBR | RCBR;
872 /* Program BAUD and clock source. */
873 up->curregs[R4] &= ~XCLK_MASK;
874 up->curregs[R4] |= X16CLK;
875 up->curregs[R12] = brg & 0xff;
876 up->curregs[R13] = (brg >> 8) & 0xff;
877 up->curregs[R14] = BRSRC | BRENAB;
879 /* Character size, stop bits, and parity. */
880 up->curregs[R3] &= ~RxN_MASK;
881 up->curregs[R5] &= ~TxN_MASK;
882 switch (cflag & CSIZE) {
884 up->curregs[R3] |= Rx5;
885 up->curregs[R5] |= Tx5;
886 up->parity_mask = 0x1f;
889 up->curregs[R3] |= Rx6;
890 up->curregs[R5] |= Tx6;
891 up->parity_mask = 0x3f;
894 up->curregs[R3] |= Rx7;
895 up->curregs[R5] |= Tx7;
896 up->parity_mask = 0x7f;
900 up->curregs[R3] |= Rx8;
901 up->curregs[R5] |= Tx8;
902 up->parity_mask = 0xff;
905 up->curregs[R4] &= ~0x0c;
907 up->curregs[R4] |= SB2;
909 up->curregs[R4] |= SB1;
911 up->curregs[R4] |= PAR_ENAB;
913 up->curregs[R4] &= ~PAR_ENAB;
914 if (!(cflag & PARODD))
915 up->curregs[R4] |= PAR_EVEN;
917 up->curregs[R4] &= ~PAR_EVEN;
919 up->port.read_status_mask = Rx_OVR;
921 up->port.read_status_mask |= CRC_ERR | PAR_ERR;
922 if (iflag & (BRKINT | PARMRK))
923 up->port.read_status_mask |= BRK_ABRT;
925 up->port.ignore_status_mask = 0;
927 up->port.ignore_status_mask |= CRC_ERR | PAR_ERR;
928 if (iflag & IGNBRK) {
929 up->port.ignore_status_mask |= BRK_ABRT;
931 up->port.ignore_status_mask |= Rx_OVR;
934 if ((cflag & CREAD) == 0)
935 up->port.ignore_status_mask = 0xff;
938 /* The port lock is not held. */
940 sunzilog_set_termios(struct uart_port *port, struct ktermios *termios,
941 struct ktermios *old)
943 struct uart_sunzilog_port *up = (struct uart_sunzilog_port *) port;
947 baud = uart_get_baud_rate(port, termios, old, 1200, 76800);
949 spin_lock_irqsave(&up->port.lock, flags);
951 brg = BPS_TO_BRG(baud, ZS_CLOCK / ZS_CLOCK_DIVISOR);
953 sunzilog_convert_to_zs(up, termios->c_cflag, termios->c_iflag, brg);
955 if (UART_ENABLE_MS(&up->port, termios->c_cflag))
956 up->flags |= SUNZILOG_FLAG_MODEM_STATUS;
958 up->flags &= ~SUNZILOG_FLAG_MODEM_STATUS;
960 up->cflag = termios->c_cflag;
962 sunzilog_maybe_update_regs(up, ZILOG_CHANNEL_FROM_PORT(port));
964 uart_update_timeout(port, termios->c_cflag, baud);
966 spin_unlock_irqrestore(&up->port.lock, flags);
969 static const char *sunzilog_type(struct uart_port *port)
971 struct uart_sunzilog_port *up = UART_ZILOG(port);
973 return (up->flags & SUNZILOG_FLAG_ESCC) ? "zs (ESCC)" : "zs";
976 /* We do not request/release mappings of the registers here, this
977 * happens at early serial probe time.
979 static void sunzilog_release_port(struct uart_port *port)
983 static int sunzilog_request_port(struct uart_port *port)
988 /* These do not need to do anything interesting either. */
989 static void sunzilog_config_port(struct uart_port *port, int flags)
993 /* We do not support letting the user mess with the divisor, IRQ, etc. */
994 static int sunzilog_verify_port(struct uart_port *port, struct serial_struct *ser)
999 static struct uart_ops sunzilog_pops = {
1000 .tx_empty = sunzilog_tx_empty,
1001 .set_mctrl = sunzilog_set_mctrl,
1002 .get_mctrl = sunzilog_get_mctrl,
1003 .stop_tx = sunzilog_stop_tx,
1004 .start_tx = sunzilog_start_tx,
1005 .stop_rx = sunzilog_stop_rx,
1006 .enable_ms = sunzilog_enable_ms,
1007 .break_ctl = sunzilog_break_ctl,
1008 .startup = sunzilog_startup,
1009 .shutdown = sunzilog_shutdown,
1010 .set_termios = sunzilog_set_termios,
1011 .type = sunzilog_type,
1012 .release_port = sunzilog_release_port,
1013 .request_port = sunzilog_request_port,
1014 .config_port = sunzilog_config_port,
1015 .verify_port = sunzilog_verify_port,
1018 static int uart_chip_count;
1019 static struct uart_sunzilog_port *sunzilog_port_table;
1020 static struct zilog_layout __iomem **sunzilog_chip_regs;
1022 static struct uart_sunzilog_port *sunzilog_irq_chain;
1024 static struct uart_driver sunzilog_reg = {
1025 .owner = THIS_MODULE,
1026 .driver_name = "sunzilog",
1031 static int __init sunzilog_alloc_tables(int num_sunzilog)
1033 struct uart_sunzilog_port *up;
1035 int num_channels = num_sunzilog * 2;
1038 size = num_channels * sizeof(struct uart_sunzilog_port);
1039 sunzilog_port_table = kzalloc(size, GFP_KERNEL);
1040 if (!sunzilog_port_table)
1043 for (i = 0; i < num_channels; i++) {
1044 up = &sunzilog_port_table[i];
1046 spin_lock_init(&up->port.lock);
1049 sunzilog_irq_chain = up;
1051 if (i < num_channels - 1)
1057 size = num_sunzilog * sizeof(struct zilog_layout __iomem *);
1058 sunzilog_chip_regs = kzalloc(size, GFP_KERNEL);
1059 if (!sunzilog_chip_regs) {
1060 kfree(sunzilog_port_table);
1061 sunzilog_irq_chain = NULL;
1068 static void sunzilog_free_tables(void)
1070 kfree(sunzilog_port_table);
1071 sunzilog_irq_chain = NULL;
1072 kfree(sunzilog_chip_regs);
1075 #define ZS_PUT_CHAR_MAX_DELAY 2000 /* 10 ms */
1077 static void sunzilog_putchar(struct uart_port *port, int ch)
1079 struct zilog_channel __iomem *channel = ZILOG_CHANNEL_FROM_PORT(port);
1080 int loops = ZS_PUT_CHAR_MAX_DELAY;
1082 /* This is a timed polling loop so do not switch the explicit
1083 * udelay with ZSDELAY as that is a NOP on some platforms. -DaveM
1086 unsigned char val = readb(&channel->control);
1087 if (val & Tx_BUF_EMP) {
1094 writeb(ch, &channel->data);
1101 static DEFINE_SPINLOCK(sunzilog_serio_lock);
1103 static int sunzilog_serio_write(struct serio *serio, unsigned char ch)
1105 struct uart_sunzilog_port *up = serio->port_data;
1106 unsigned long flags;
1108 spin_lock_irqsave(&sunzilog_serio_lock, flags);
1110 sunzilog_putchar(&up->port, ch);
1112 spin_unlock_irqrestore(&sunzilog_serio_lock, flags);
1117 static int sunzilog_serio_open(struct serio *serio)
1119 struct uart_sunzilog_port *up = serio->port_data;
1120 unsigned long flags;
1123 spin_lock_irqsave(&sunzilog_serio_lock, flags);
1124 if (!up->serio_open) {
1129 spin_unlock_irqrestore(&sunzilog_serio_lock, flags);
1134 static void sunzilog_serio_close(struct serio *serio)
1136 struct uart_sunzilog_port *up = serio->port_data;
1137 unsigned long flags;
1139 spin_lock_irqsave(&sunzilog_serio_lock, flags);
1141 spin_unlock_irqrestore(&sunzilog_serio_lock, flags);
1144 #endif /* CONFIG_SERIO */
1146 #ifdef CONFIG_SERIAL_SUNZILOG_CONSOLE
1148 sunzilog_console_write(struct console *con, const char *s, unsigned int count)
1150 struct uart_sunzilog_port *up = &sunzilog_port_table[con->index];
1151 unsigned long flags;
1154 local_irq_save(flags);
1155 if (up->port.sysrq) {
1157 } else if (oops_in_progress) {
1158 locked = spin_trylock(&up->port.lock);
1160 spin_lock(&up->port.lock);
1162 uart_console_write(&up->port, s, count, sunzilog_putchar);
1166 spin_unlock(&up->port.lock);
1167 local_irq_restore(flags);
1170 static int __init sunzilog_console_setup(struct console *con, char *options)
1172 struct uart_sunzilog_port *up = &sunzilog_port_table[con->index];
1173 unsigned long flags;
1176 if (up->port.type != PORT_SUNZILOG)
1179 printk(KERN_INFO "Console: ttyS%d (SunZilog zs%d)\n",
1180 (sunzilog_reg.minor - 64) + con->index, con->index);
1182 /* Get firmware console settings. */
1183 sunserial_console_termios(con);
1185 /* Firmware console speed is limited to 150-->38400 baud so
1186 * this hackish cflag thing is OK.
1188 switch (con->cflag & CBAUD) {
1189 case B150: baud = 150; break;
1190 case B300: baud = 300; break;
1191 case B600: baud = 600; break;
1192 case B1200: baud = 1200; break;
1193 case B2400: baud = 2400; break;
1194 case B4800: baud = 4800; break;
1195 default: case B9600: baud = 9600; break;
1196 case B19200: baud = 19200; break;
1197 case B38400: baud = 38400; break;
1200 brg = BPS_TO_BRG(baud, ZS_CLOCK / ZS_CLOCK_DIVISOR);
1202 spin_lock_irqsave(&up->port.lock, flags);
1204 up->curregs[R15] |= BRKIE;
1205 sunzilog_convert_to_zs(up, con->cflag, 0, brg);
1207 sunzilog_set_mctrl(&up->port, TIOCM_DTR | TIOCM_RTS);
1208 __sunzilog_startup(up);
1210 spin_unlock_irqrestore(&up->port.lock, flags);
1215 static struct console sunzilog_console_ops = {
1217 .write = sunzilog_console_write,
1218 .device = uart_console_device,
1219 .setup = sunzilog_console_setup,
1220 .flags = CON_PRINTBUFFER,
1222 .data = &sunzilog_reg,
1225 static inline struct console *SUNZILOG_CONSOLE(void)
1227 return &sunzilog_console_ops;
1231 #define SUNZILOG_CONSOLE() (NULL)
1234 static void __devinit sunzilog_init_kbdms(struct uart_sunzilog_port *up)
1238 if (up->flags & SUNZILOG_FLAG_CONS_KEYB) {
1239 up->cflag = B1200 | CS8 | CLOCAL | CREAD;
1242 up->cflag = B4800 | CS8 | CLOCAL | CREAD;
1246 up->curregs[R15] |= BRKIE;
1247 brg = BPS_TO_BRG(baud, ZS_CLOCK / ZS_CLOCK_DIVISOR);
1248 sunzilog_convert_to_zs(up, up->cflag, 0, brg);
1249 sunzilog_set_mctrl(&up->port, TIOCM_DTR | TIOCM_RTS);
1250 __sunzilog_startup(up);
1254 static void __devinit sunzilog_register_serio(struct uart_sunzilog_port *up)
1256 struct serio *serio = &up->serio;
1258 serio->port_data = up;
1260 serio->id.type = SERIO_RS232;
1261 if (up->flags & SUNZILOG_FLAG_CONS_KEYB) {
1262 serio->id.proto = SERIO_SUNKBD;
1263 strlcpy(serio->name, "zskbd", sizeof(serio->name));
1265 serio->id.proto = SERIO_SUN;
1266 serio->id.extra = 1;
1267 strlcpy(serio->name, "zsms", sizeof(serio->name));
1269 strlcpy(serio->phys,
1270 ((up->flags & SUNZILOG_FLAG_CONS_KEYB) ?
1271 "zs/serio0" : "zs/serio1"),
1272 sizeof(serio->phys));
1274 serio->write = sunzilog_serio_write;
1275 serio->open = sunzilog_serio_open;
1276 serio->close = sunzilog_serio_close;
1277 serio->dev.parent = up->port.dev;
1279 serio_register_port(serio);
1283 static void __devinit sunzilog_init_hw(struct uart_sunzilog_port *up)
1285 struct zilog_channel __iomem *channel;
1286 unsigned long flags;
1289 channel = ZILOG_CHANNEL_FROM_PORT(&up->port);
1291 spin_lock_irqsave(&up->port.lock, flags);
1292 if (ZS_IS_CHANNEL_A(up)) {
1293 write_zsreg(channel, R9, FHWRES);
1295 (void) read_zsreg(channel, R0);
1298 if (up->flags & (SUNZILOG_FLAG_CONS_KEYB |
1299 SUNZILOG_FLAG_CONS_MOUSE)) {
1300 up->curregs[R1] = EXT_INT_ENAB | INT_ALL_Rx | TxINT_ENAB;
1301 up->curregs[R4] = PAR_EVEN | X16CLK | SB1;
1302 up->curregs[R3] = RxENAB | Rx8;
1303 up->curregs[R5] = TxENAB | Tx8;
1304 up->curregs[R6] = 0x00; /* SDLC Address */
1305 up->curregs[R7] = 0x7E; /* SDLC Flag */
1306 up->curregs[R9] = NV;
1307 up->curregs[R7p] = 0x00;
1308 sunzilog_init_kbdms(up);
1309 /* Only enable interrupts if an ISR handler available */
1310 if (up->flags & SUNZILOG_FLAG_ISR_HANDLER)
1311 up->curregs[R9] |= MIE;
1312 write_zsreg(channel, R9, up->curregs[R9]);
1314 /* Normal serial TTY. */
1315 up->parity_mask = 0xff;
1316 up->curregs[R1] = EXT_INT_ENAB | INT_ALL_Rx | TxINT_ENAB;
1317 up->curregs[R4] = PAR_EVEN | X16CLK | SB1;
1318 up->curregs[R3] = RxENAB | Rx8;
1319 up->curregs[R5] = TxENAB | Tx8;
1320 up->curregs[R6] = 0x00; /* SDLC Address */
1321 up->curregs[R7] = 0x7E; /* SDLC Flag */
1322 up->curregs[R9] = NV;
1323 up->curregs[R10] = NRZ;
1324 up->curregs[R11] = TCBR | RCBR;
1326 brg = BPS_TO_BRG(baud, ZS_CLOCK / ZS_CLOCK_DIVISOR);
1327 up->curregs[R12] = (brg & 0xff);
1328 up->curregs[R13] = (brg >> 8) & 0xff;
1329 up->curregs[R14] = BRSRC | BRENAB;
1330 up->curregs[R15] = FIFOEN; /* Use FIFO if on ESCC */
1331 up->curregs[R7p] = TxFIFO_LVL | RxFIFO_LVL;
1332 if (__load_zsregs(channel, up->curregs)) {
1333 up->flags |= SUNZILOG_FLAG_ESCC;
1335 /* Only enable interrupts if an ISR handler available */
1336 if (up->flags & SUNZILOG_FLAG_ISR_HANDLER)
1337 up->curregs[R9] |= MIE;
1338 write_zsreg(channel, R9, up->curregs[R9]);
1341 spin_unlock_irqrestore(&up->port.lock, flags);
1344 if (up->flags & (SUNZILOG_FLAG_CONS_KEYB |
1345 SUNZILOG_FLAG_CONS_MOUSE))
1346 sunzilog_register_serio(up);
1350 static int zilog_irq = -1;
1352 static int __devinit zs_probe(struct of_device *op, const struct of_device_id *match)
1354 static int kbm_inst, uart_inst;
1356 struct uart_sunzilog_port *up;
1357 struct zilog_layout __iomem *rp;
1358 int keyboard_mouse = 0;
1361 if (of_find_property(op->node, "keyboard", NULL))
1364 /* uarts must come before keyboards/mice */
1366 inst = uart_chip_count + kbm_inst;
1370 sunzilog_chip_regs[inst] = of_ioremap(&op->resource[0], 0,
1371 sizeof(struct zilog_layout),
1373 if (!sunzilog_chip_regs[inst])
1376 rp = sunzilog_chip_regs[inst];
1378 if (zilog_irq == -1)
1379 zilog_irq = op->irqs[0];
1381 up = &sunzilog_port_table[inst * 2];
1384 up[0].port.mapbase = op->resource[0].start + 0x00;
1385 up[0].port.membase = (void __iomem *) &rp->channelA;
1386 up[0].port.iotype = UPIO_MEM;
1387 up[0].port.irq = op->irqs[0];
1388 up[0].port.uartclk = ZS_CLOCK;
1389 up[0].port.fifosize = 1;
1390 up[0].port.ops = &sunzilog_pops;
1391 up[0].port.type = PORT_SUNZILOG;
1392 up[0].port.flags = 0;
1393 up[0].port.line = (inst * 2) + 0;
1394 up[0].port.dev = &op->dev;
1395 up[0].flags |= SUNZILOG_FLAG_IS_CHANNEL_A;
1397 up[0].flags |= SUNZILOG_FLAG_CONS_KEYB;
1398 sunzilog_init_hw(&up[0]);
1401 up[1].port.mapbase = op->resource[0].start + 0x04;
1402 up[1].port.membase = (void __iomem *) &rp->channelB;
1403 up[1].port.iotype = UPIO_MEM;
1404 up[1].port.irq = op->irqs[0];
1405 up[1].port.uartclk = ZS_CLOCK;
1406 up[1].port.fifosize = 1;
1407 up[1].port.ops = &sunzilog_pops;
1408 up[1].port.type = PORT_SUNZILOG;
1409 up[1].port.flags = 0;
1410 up[1].port.line = (inst * 2) + 1;
1411 up[1].port.dev = &op->dev;
1414 up[1].flags |= SUNZILOG_FLAG_CONS_MOUSE;
1415 sunzilog_init_hw(&up[1]);
1417 if (!keyboard_mouse) {
1418 if (sunserial_console_match(SUNZILOG_CONSOLE(), op->node,
1419 &sunzilog_reg, up[0].port.line))
1420 up->flags |= SUNZILOG_FLAG_IS_CONS;
1421 err = uart_add_one_port(&sunzilog_reg, &up[0].port);
1423 of_iounmap(&op->resource[0],
1424 rp, sizeof(struct zilog_layout));
1427 if (sunserial_console_match(SUNZILOG_CONSOLE(), op->node,
1428 &sunzilog_reg, up[1].port.line))
1429 up->flags |= SUNZILOG_FLAG_IS_CONS;
1430 err = uart_add_one_port(&sunzilog_reg, &up[1].port);
1432 uart_remove_one_port(&sunzilog_reg, &up[0].port);
1433 of_iounmap(&op->resource[0],
1434 rp, sizeof(struct zilog_layout));
1439 printk(KERN_INFO "%s: Keyboard at MMIO 0x%llx (irq = %d) "
1442 (unsigned long long) up[0].port.mapbase,
1443 op->irqs[0], sunzilog_type(&up[0].port));
1444 printk(KERN_INFO "%s: Mouse at MMIO 0x%llx (irq = %d) "
1447 (unsigned long long) up[1].port.mapbase,
1448 op->irqs[0], sunzilog_type(&up[1].port));
1452 dev_set_drvdata(&op->dev, &up[0]);
1457 static void __devexit zs_remove_one(struct uart_sunzilog_port *up)
1459 if (ZS_IS_KEYB(up) || ZS_IS_MOUSE(up)) {
1461 serio_unregister_port(&up->serio);
1464 uart_remove_one_port(&sunzilog_reg, &up->port);
1467 static int __devexit zs_remove(struct of_device *op)
1469 struct uart_sunzilog_port *up = dev_get_drvdata(&op->dev);
1470 struct zilog_layout __iomem *regs;
1472 zs_remove_one(&up[0]);
1473 zs_remove_one(&up[1]);
1475 regs = sunzilog_chip_regs[up[0].port.line / 2];
1476 of_iounmap(&op->resource[0], regs, sizeof(struct zilog_layout));
1478 dev_set_drvdata(&op->dev, NULL);
1483 static const struct of_device_id zs_match[] = {
1489 MODULE_DEVICE_TABLE(of, zs_match);
1491 static struct of_platform_driver zs_driver = {
1493 .match_table = zs_match,
1495 .remove = __devexit_p(zs_remove),
1498 static int __init sunzilog_init(void)
1500 struct device_node *dp;
1503 int num_sunzilog = 0;
1505 for_each_node_by_name(dp, "zs") {
1507 if (of_find_property(dp, "keyboard", NULL))
1512 err = sunzilog_alloc_tables(num_sunzilog);
1516 uart_chip_count = num_sunzilog - num_keybms;
1518 err = sunserial_register_minors(&sunzilog_reg,
1519 uart_chip_count * 2);
1521 goto out_free_tables;
1524 err = of_register_driver(&zs_driver, &of_bus_type);
1526 goto out_unregister_uart;
1528 if (zilog_irq != -1) {
1529 struct uart_sunzilog_port *up = sunzilog_irq_chain;
1530 err = request_irq(zilog_irq, sunzilog_interrupt, IRQF_SHARED,
1531 "zs", sunzilog_irq_chain);
1533 goto out_unregister_driver;
1535 /* Enable Interrupts */
1537 struct zilog_channel __iomem *channel;
1539 /* printk (KERN_INFO "Enable IRQ for ZILOG Hardware %p\n", up); */
1540 channel = ZILOG_CHANNEL_FROM_PORT(&up->port);
1541 up->flags |= SUNZILOG_FLAG_ISR_HANDLER;
1542 up->curregs[R9] |= MIE;
1543 write_zsreg(channel, R9, up->curregs[R9]);
1551 out_unregister_driver:
1552 of_unregister_driver(&zs_driver);
1554 out_unregister_uart:
1556 sunserial_unregister_minors(&sunzilog_reg, num_sunzilog);
1557 sunzilog_reg.cons = NULL;
1561 sunzilog_free_tables();
1565 static void __exit sunzilog_exit(void)
1567 of_unregister_driver(&zs_driver);
1569 if (zilog_irq != -1) {
1570 struct uart_sunzilog_port *up = sunzilog_irq_chain;
1572 /* Disable Interrupts */
1574 struct zilog_channel __iomem *channel;
1576 /* printk (KERN_INFO "Disable IRQ for ZILOG Hardware %p\n", up); */
1577 channel = ZILOG_CHANNEL_FROM_PORT(&up->port);
1578 up->flags &= ~SUNZILOG_FLAG_ISR_HANDLER;
1579 up->curregs[R9] &= ~MIE;
1580 write_zsreg(channel, R9, up->curregs[R9]);
1584 free_irq(zilog_irq, sunzilog_irq_chain);
1588 if (sunzilog_reg.nr) {
1589 sunserial_unregister_minors(&sunzilog_reg, sunzilog_reg.nr);
1590 sunzilog_free_tables();
1594 module_init(sunzilog_init);
1595 module_exit(sunzilog_exit);
1597 MODULE_AUTHOR("David S. Miller");
1598 MODULE_DESCRIPTION("Sun Zilog serial port driver");
1599 MODULE_VERSION("2.0");
1600 MODULE_LICENSE("GPL");