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 David S. Miller (davem@davemloft.net)
15 #include <linux/module.h>
16 #include <linux/kernel.h>
17 #include <linux/sched.h>
18 #include <linux/errno.h>
19 #include <linux/delay.h>
20 #include <linux/tty.h>
21 #include <linux/tty_flip.h>
22 #include <linux/major.h>
23 #include <linux/string.h>
24 #include <linux/ptrace.h>
25 #include <linux/ioport.h>
26 #include <linux/slab.h>
27 #include <linux/circ_buf.h>
28 #include <linux/serial.h>
29 #include <linux/sysrq.h>
30 #include <linux/console.h>
31 #include <linux/spinlock.h>
33 #include <linux/serio.h>
35 #include <linux/init.h>
40 #include <asm/of_device.h>
42 #if defined(CONFIG_SERIAL_SUNZILOG_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
46 #include <linux/serial_core.h>
51 /* On 32-bit sparcs we need to delay after register accesses
52 * to accommodate sun4 systems, but we do not need to flush writes.
53 * On 64-bit sparc we only need to flush single writes to ensure
56 #ifndef CONFIG_SPARC64
57 #define ZSDELAY() udelay(5)
58 #define ZSDELAY_LONG() udelay(20)
59 #define ZS_WSYNC(channel) do { } while (0)
62 #define ZSDELAY_LONG()
63 #define ZS_WSYNC(__channel) \
64 readb(&((__channel)->control))
67 static int num_sunzilog;
68 #define NUM_SUNZILOG num_sunzilog
69 #define NUM_CHANNELS (NUM_SUNZILOG * 2)
71 #define KEYBOARD_LINE 0x2
72 #define MOUSE_LINE 0x3
74 #define ZS_CLOCK 4915200 /* Zilog input clock rate. */
75 #define ZS_CLOCK_DIVISOR 16 /* Divisor this driver uses. */
78 * We wrap our port structure around the generic uart_port.
80 struct uart_sunzilog_port {
81 struct uart_port port;
83 /* IRQ servicing chain. */
84 struct uart_sunzilog_port *next;
86 /* Current values of Zilog write registers. */
87 unsigned char curregs[NUM_ZSREGS];
90 #define SUNZILOG_FLAG_CONS_KEYB 0x00000001
91 #define SUNZILOG_FLAG_CONS_MOUSE 0x00000002
92 #define SUNZILOG_FLAG_IS_CONS 0x00000004
93 #define SUNZILOG_FLAG_IS_KGDB 0x00000008
94 #define SUNZILOG_FLAG_MODEM_STATUS 0x00000010
95 #define SUNZILOG_FLAG_IS_CHANNEL_A 0x00000020
96 #define SUNZILOG_FLAG_REGS_HELD 0x00000040
97 #define SUNZILOG_FLAG_TX_STOPPED 0x00000080
98 #define SUNZILOG_FLAG_TX_ACTIVE 0x00000100
102 unsigned char parity_mask;
103 unsigned char prev_status;
111 #define ZILOG_CHANNEL_FROM_PORT(PORT) ((struct zilog_channel __iomem *)((PORT)->membase))
112 #define UART_ZILOG(PORT) ((struct uart_sunzilog_port *)(PORT))
114 #define ZS_IS_KEYB(UP) ((UP)->flags & SUNZILOG_FLAG_CONS_KEYB)
115 #define ZS_IS_MOUSE(UP) ((UP)->flags & SUNZILOG_FLAG_CONS_MOUSE)
116 #define ZS_IS_CONS(UP) ((UP)->flags & SUNZILOG_FLAG_IS_CONS)
117 #define ZS_IS_KGDB(UP) ((UP)->flags & SUNZILOG_FLAG_IS_KGDB)
118 #define ZS_WANTS_MODEM_STATUS(UP) ((UP)->flags & SUNZILOG_FLAG_MODEM_STATUS)
119 #define ZS_IS_CHANNEL_A(UP) ((UP)->flags & SUNZILOG_FLAG_IS_CHANNEL_A)
120 #define ZS_REGS_HELD(UP) ((UP)->flags & SUNZILOG_FLAG_REGS_HELD)
121 #define ZS_TX_STOPPED(UP) ((UP)->flags & SUNZILOG_FLAG_TX_STOPPED)
122 #define ZS_TX_ACTIVE(UP) ((UP)->flags & SUNZILOG_FLAG_TX_ACTIVE)
124 /* Reading and writing Zilog8530 registers. The delays are to make this
125 * driver work on the Sun4 which needs a settling delay after each chip
126 * register access, other machines handle this in hardware via auxiliary
127 * flip-flops which implement the settle time we do in software.
129 * The port lock must be held and local IRQs must be disabled
130 * when {read,write}_zsreg is invoked.
132 static unsigned char read_zsreg(struct zilog_channel __iomem *channel,
135 unsigned char retval;
137 writeb(reg, &channel->control);
139 retval = readb(&channel->control);
145 static void write_zsreg(struct zilog_channel __iomem *channel,
146 unsigned char reg, unsigned char value)
148 writeb(reg, &channel->control);
150 writeb(value, &channel->control);
154 static void sunzilog_clear_fifo(struct zilog_channel __iomem *channel)
158 for (i = 0; i < 32; i++) {
159 unsigned char regval;
161 regval = readb(&channel->control);
163 if (regval & Rx_CH_AV)
166 regval = read_zsreg(channel, R1);
167 readb(&channel->data);
170 if (regval & (PAR_ERR | Rx_OVR | CRC_ERR)) {
171 writeb(ERR_RES, &channel->control);
178 /* This function must only be called when the TX is not busy. The UART
179 * port lock must be held and local interrupts disabled.
181 static void __load_zsregs(struct zilog_channel __iomem *channel, unsigned char *regs)
185 /* Let pending transmits finish. */
186 for (i = 0; i < 1000; i++) {
187 unsigned char stat = read_zsreg(channel, R1);
193 writeb(ERR_RES, &channel->control);
197 sunzilog_clear_fifo(channel);
199 /* Disable all interrupts. */
200 write_zsreg(channel, R1,
201 regs[R1] & ~(RxINT_MASK | TxINT_ENAB | EXT_INT_ENAB));
203 /* Set parity, sync config, stop bits, and clock divisor. */
204 write_zsreg(channel, R4, regs[R4]);
206 /* Set misc. TX/RX control bits. */
207 write_zsreg(channel, R10, regs[R10]);
209 /* Set TX/RX controls sans the enable bits. */
210 write_zsreg(channel, R3, regs[R3] & ~RxENAB);
211 write_zsreg(channel, R5, regs[R5] & ~TxENAB);
213 /* Synchronous mode config. */
214 write_zsreg(channel, R6, regs[R6]);
215 write_zsreg(channel, R7, regs[R7]);
217 /* Don't mess with the interrupt vector (R2, unused by us) and
218 * master interrupt control (R9). We make sure this is setup
219 * properly at probe time then never touch it again.
222 /* Disable baud generator. */
223 write_zsreg(channel, R14, regs[R14] & ~BRENAB);
225 /* Clock mode control. */
226 write_zsreg(channel, R11, regs[R11]);
228 /* Lower and upper byte of baud rate generator divisor. */
229 write_zsreg(channel, R12, regs[R12]);
230 write_zsreg(channel, R13, regs[R13]);
232 /* Now rewrite R14, with BRENAB (if set). */
233 write_zsreg(channel, R14, regs[R14]);
235 /* External status interrupt control. */
236 write_zsreg(channel, R15, regs[R15]);
238 /* Reset external status interrupts. */
239 write_zsreg(channel, R0, RES_EXT_INT);
240 write_zsreg(channel, R0, RES_EXT_INT);
242 /* Rewrite R3/R5, this time without enables masked. */
243 write_zsreg(channel, R3, regs[R3]);
244 write_zsreg(channel, R5, regs[R5]);
246 /* Rewrite R1, this time without IRQ enabled masked. */
247 write_zsreg(channel, R1, regs[R1]);
250 /* Reprogram the Zilog channel HW registers with the copies found in the
251 * software state struct. If the transmitter is busy, we defer this update
252 * until the next TX complete interrupt. Else, we do it right now.
254 * The UART port lock must be held and local interrupts disabled.
256 static void sunzilog_maybe_update_regs(struct uart_sunzilog_port *up,
257 struct zilog_channel __iomem *channel)
259 if (!ZS_REGS_HELD(up)) {
260 if (ZS_TX_ACTIVE(up)) {
261 up->flags |= SUNZILOG_FLAG_REGS_HELD;
263 __load_zsregs(channel, up->curregs);
268 static void sunzilog_change_mouse_baud(struct uart_sunzilog_port *up)
270 unsigned int cur_cflag = up->cflag;
274 up->cflag |= suncore_mouse_baud_cflag_next(cur_cflag, &new_baud);
276 brg = BPS_TO_BRG(new_baud, ZS_CLOCK / ZS_CLOCK_DIVISOR);
277 up->curregs[R12] = (brg & 0xff);
278 up->curregs[R13] = (brg >> 8) & 0xff;
279 sunzilog_maybe_update_regs(up, ZILOG_CHANNEL_FROM_PORT(&up->port));
282 static void sunzilog_kbdms_receive_chars(struct uart_sunzilog_port *up,
283 unsigned char ch, int is_break,
284 struct pt_regs *regs)
286 if (ZS_IS_KEYB(up)) {
287 /* Stop-A is handled by drivers/char/keyboard.c now. */
290 serio_interrupt(&up->serio, ch, 0, regs);
292 } else if (ZS_IS_MOUSE(up)) {
293 int ret = suncore_mouse_baud_detection(ch, is_break);
297 sunzilog_change_mouse_baud(up);
305 serio_interrupt(&up->serio, ch, 0, regs);
312 static struct tty_struct *
313 sunzilog_receive_chars(struct uart_sunzilog_port *up,
314 struct zilog_channel __iomem *channel,
315 struct pt_regs *regs)
317 struct tty_struct *tty;
318 unsigned char ch, r1, flag;
321 if (up->port.info != NULL && /* Unopened serial console */
322 up->port.info->tty != NULL) /* Keyboard || mouse */
323 tty = up->port.info->tty;
327 r1 = read_zsreg(channel, R1);
328 if (r1 & (PAR_ERR | Rx_OVR | CRC_ERR)) {
329 writeb(ERR_RES, &channel->control);
334 ch = readb(&channel->control);
337 /* This funny hack depends upon BRK_ABRT not interfering
338 * with the other bits we care about in R1.
343 if (!(ch & Rx_CH_AV))
346 ch = readb(&channel->data);
349 ch &= up->parity_mask;
351 if (unlikely(ZS_IS_KEYB(up)) || unlikely(ZS_IS_MOUSE(up))) {
352 sunzilog_kbdms_receive_chars(up, ch, 0, regs);
357 uart_handle_sysrq_char(&up->port, ch, regs);
361 /* A real serial line, record the character and status. */
363 up->port.icount.rx++;
364 if (r1 & (BRK_ABRT | PAR_ERR | Rx_OVR | CRC_ERR)) {
366 r1 &= ~(PAR_ERR | CRC_ERR);
367 up->port.icount.brk++;
368 if (uart_handle_break(&up->port))
371 else if (r1 & PAR_ERR)
372 up->port.icount.parity++;
373 else if (r1 & CRC_ERR)
374 up->port.icount.frame++;
376 up->port.icount.overrun++;
377 r1 &= up->port.read_status_mask;
380 else if (r1 & PAR_ERR)
382 else if (r1 & CRC_ERR)
385 if (uart_handle_sysrq_char(&up->port, ch, regs))
388 if (up->port.ignore_status_mask == 0xff ||
389 (r1 & up->port.ignore_status_mask) == 0) {
390 tty_insert_flip_char(tty, ch, flag);
393 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
399 static void sunzilog_status_handle(struct uart_sunzilog_port *up,
400 struct zilog_channel __iomem *channel,
401 struct pt_regs *regs)
403 unsigned char status;
405 status = readb(&channel->control);
408 writeb(RES_EXT_INT, &channel->control);
412 if (status & BRK_ABRT) {
414 sunzilog_kbdms_receive_chars(up, 0, 1, regs);
415 if (ZS_IS_CONS(up)) {
416 /* Wait for BREAK to deassert to avoid potentially
417 * confusing the PROM.
420 status = readb(&channel->control);
422 if (!(status & BRK_ABRT))
430 if (ZS_WANTS_MODEM_STATUS(up)) {
432 up->port.icount.dsr++;
434 /* The Zilog just gives us an interrupt when DCD/CTS/etc. change.
435 * But it does not tell us which bit has changed, we have to keep
436 * track of this ourselves.
438 if ((status ^ up->prev_status) ^ DCD)
439 uart_handle_dcd_change(&up->port,
441 if ((status ^ up->prev_status) ^ CTS)
442 uart_handle_cts_change(&up->port,
445 wake_up_interruptible(&up->port.info->delta_msr_wait);
448 up->prev_status = status;
451 static void sunzilog_transmit_chars(struct uart_sunzilog_port *up,
452 struct zilog_channel __iomem *channel)
454 struct circ_buf *xmit;
456 if (ZS_IS_CONS(up)) {
457 unsigned char status = readb(&channel->control);
460 /* TX still busy? Just wait for the next TX done interrupt.
462 * It can occur because of how we do serial console writes. It would
463 * be nice to transmit console writes just like we normally would for
464 * a TTY line. (ie. buffered and TX interrupt driven). That is not
465 * easy because console writes cannot sleep. One solution might be
466 * to poll on enough port->xmit space becomming free. -DaveM
468 if (!(status & Tx_BUF_EMP))
472 up->flags &= ~SUNZILOG_FLAG_TX_ACTIVE;
474 if (ZS_REGS_HELD(up)) {
475 __load_zsregs(channel, up->curregs);
476 up->flags &= ~SUNZILOG_FLAG_REGS_HELD;
479 if (ZS_TX_STOPPED(up)) {
480 up->flags &= ~SUNZILOG_FLAG_TX_STOPPED;
484 if (up->port.x_char) {
485 up->flags |= SUNZILOG_FLAG_TX_ACTIVE;
486 writeb(up->port.x_char, &channel->data);
490 up->port.icount.tx++;
495 if (up->port.info == NULL)
497 xmit = &up->port.info->xmit;
498 if (uart_circ_empty(xmit))
501 if (uart_tx_stopped(&up->port))
504 up->flags |= SUNZILOG_FLAG_TX_ACTIVE;
505 writeb(xmit->buf[xmit->tail], &channel->data);
509 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
510 up->port.icount.tx++;
512 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
513 uart_write_wakeup(&up->port);
518 writeb(RES_Tx_P, &channel->control);
523 static irqreturn_t sunzilog_interrupt(int irq, void *dev_id, struct pt_regs *regs)
525 struct uart_sunzilog_port *up = dev_id;
528 struct zilog_channel __iomem *channel
529 = ZILOG_CHANNEL_FROM_PORT(&up->port);
530 struct tty_struct *tty;
533 spin_lock(&up->port.lock);
534 r3 = read_zsreg(channel, R3);
538 if (r3 & (CHAEXT | CHATxIP | CHARxIP)) {
539 writeb(RES_H_IUS, &channel->control);
544 tty = sunzilog_receive_chars(up, channel, regs);
546 sunzilog_status_handle(up, channel, regs);
548 sunzilog_transmit_chars(up, channel);
550 spin_unlock(&up->port.lock);
553 tty_flip_buffer_push(tty);
557 channel = ZILOG_CHANNEL_FROM_PORT(&up->port);
559 spin_lock(&up->port.lock);
561 if (r3 & (CHBEXT | CHBTxIP | CHBRxIP)) {
562 writeb(RES_H_IUS, &channel->control);
567 tty = sunzilog_receive_chars(up, channel, regs);
569 sunzilog_status_handle(up, channel, regs);
571 sunzilog_transmit_chars(up, channel);
573 spin_unlock(&up->port.lock);
576 tty_flip_buffer_push(tty);
584 /* A convenient way to quickly get R0 status. The caller must _not_ hold the
585 * port lock, it is acquired here.
587 static __inline__ unsigned char sunzilog_read_channel_status(struct uart_port *port)
589 struct zilog_channel __iomem *channel;
590 unsigned char status;
592 channel = ZILOG_CHANNEL_FROM_PORT(port);
593 status = readb(&channel->control);
599 /* The port lock is not held. */
600 static unsigned int sunzilog_tx_empty(struct uart_port *port)
603 unsigned char status;
606 spin_lock_irqsave(&port->lock, flags);
608 status = sunzilog_read_channel_status(port);
610 spin_unlock_irqrestore(&port->lock, flags);
612 if (status & Tx_BUF_EMP)
620 /* The port lock is held and interrupts are disabled. */
621 static unsigned int sunzilog_get_mctrl(struct uart_port *port)
623 unsigned char status;
626 status = sunzilog_read_channel_status(port);
639 /* The port lock is held and interrupts are disabled. */
640 static void sunzilog_set_mctrl(struct uart_port *port, unsigned int mctrl)
642 struct uart_sunzilog_port *up = (struct uart_sunzilog_port *) port;
643 struct zilog_channel __iomem *channel = ZILOG_CHANNEL_FROM_PORT(port);
644 unsigned char set_bits, clear_bits;
646 set_bits = clear_bits = 0;
648 if (mctrl & TIOCM_RTS)
652 if (mctrl & TIOCM_DTR)
657 /* NOTE: Not subject to 'transmitter active' rule. */
658 up->curregs[R5] |= set_bits;
659 up->curregs[R5] &= ~clear_bits;
660 write_zsreg(channel, R5, up->curregs[R5]);
663 /* The port lock is held and interrupts are disabled. */
664 static void sunzilog_stop_tx(struct uart_port *port)
666 struct uart_sunzilog_port *up = (struct uart_sunzilog_port *) port;
668 up->flags |= SUNZILOG_FLAG_TX_STOPPED;
671 /* The port lock is held and interrupts are disabled. */
672 static void sunzilog_start_tx(struct uart_port *port)
674 struct uart_sunzilog_port *up = (struct uart_sunzilog_port *) port;
675 struct zilog_channel __iomem *channel = ZILOG_CHANNEL_FROM_PORT(port);
676 unsigned char status;
678 up->flags |= SUNZILOG_FLAG_TX_ACTIVE;
679 up->flags &= ~SUNZILOG_FLAG_TX_STOPPED;
681 status = readb(&channel->control);
684 /* TX busy? Just wait for the TX done interrupt. */
685 if (!(status & Tx_BUF_EMP))
688 /* Send the first character to jump-start the TX done
689 * IRQ sending engine.
692 writeb(port->x_char, &channel->data);
699 struct circ_buf *xmit = &port->info->xmit;
701 writeb(xmit->buf[xmit->tail], &channel->data);
705 xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
708 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
709 uart_write_wakeup(&up->port);
713 /* The port lock is held. */
714 static void sunzilog_stop_rx(struct uart_port *port)
716 struct uart_sunzilog_port *up = UART_ZILOG(port);
717 struct zilog_channel __iomem *channel;
722 channel = ZILOG_CHANNEL_FROM_PORT(port);
724 /* Disable all RX interrupts. */
725 up->curregs[R1] &= ~RxINT_MASK;
726 sunzilog_maybe_update_regs(up, channel);
729 /* The port lock is held. */
730 static void sunzilog_enable_ms(struct uart_port *port)
732 struct uart_sunzilog_port *up = (struct uart_sunzilog_port *) port;
733 struct zilog_channel __iomem *channel = ZILOG_CHANNEL_FROM_PORT(port);
734 unsigned char new_reg;
736 new_reg = up->curregs[R15] | (DCDIE | SYNCIE | CTSIE);
737 if (new_reg != up->curregs[R15]) {
738 up->curregs[R15] = new_reg;
740 /* NOTE: Not subject to 'transmitter active' rule. */
741 write_zsreg(channel, R15, up->curregs[R15]);
745 /* The port lock is not held. */
746 static void sunzilog_break_ctl(struct uart_port *port, int break_state)
748 struct uart_sunzilog_port *up = (struct uart_sunzilog_port *) port;
749 struct zilog_channel __iomem *channel = ZILOG_CHANNEL_FROM_PORT(port);
750 unsigned char set_bits, clear_bits, new_reg;
753 set_bits = clear_bits = 0;
758 clear_bits |= SND_BRK;
760 spin_lock_irqsave(&port->lock, flags);
762 new_reg = (up->curregs[R5] | set_bits) & ~clear_bits;
763 if (new_reg != up->curregs[R5]) {
764 up->curregs[R5] = new_reg;
766 /* NOTE: Not subject to 'transmitter active' rule. */
767 write_zsreg(channel, R5, up->curregs[R5]);
770 spin_unlock_irqrestore(&port->lock, flags);
773 static void __sunzilog_startup(struct uart_sunzilog_port *up)
775 struct zilog_channel __iomem *channel;
777 channel = ZILOG_CHANNEL_FROM_PORT(&up->port);
778 up->prev_status = readb(&channel->control);
780 /* Enable receiver and transmitter. */
781 up->curregs[R3] |= RxENAB;
782 up->curregs[R5] |= TxENAB;
784 up->curregs[R1] |= EXT_INT_ENAB | INT_ALL_Rx | TxINT_ENAB;
785 sunzilog_maybe_update_regs(up, channel);
788 static int sunzilog_startup(struct uart_port *port)
790 struct uart_sunzilog_port *up = UART_ZILOG(port);
796 spin_lock_irqsave(&port->lock, flags);
797 __sunzilog_startup(up);
798 spin_unlock_irqrestore(&port->lock, flags);
803 * The test for ZS_IS_CONS is explained by the following e-mail:
805 * From: Russell King <rmk@arm.linux.org.uk>
806 * Date: Sun, 8 Dec 2002 10:18:38 +0000
808 * On Sun, Dec 08, 2002 at 02:43:36AM -0500, Pete Zaitcev wrote:
809 * > I boot my 2.5 boxes using "console=ttyS0,9600" argument,
810 * > and I noticed that something is not right with reference
811 * > counting in this case. It seems that when the console
812 * > is open by kernel initially, this is not accounted
813 * > as an open, and uart_startup is not called.
815 * That is correct. We are unable to call uart_startup when the serial
816 * console is initialised because it may need to allocate memory (as
817 * request_irq does) and the memory allocators may not have been
820 * 1. initialise the port into a state where it can send characters in the
821 * console write method.
823 * 2. don't do the actual hardware shutdown in your shutdown() method (but
824 * do the normal software shutdown - ie, free irqs etc)
827 static void sunzilog_shutdown(struct uart_port *port)
829 struct uart_sunzilog_port *up = UART_ZILOG(port);
830 struct zilog_channel __iomem *channel;
836 spin_lock_irqsave(&port->lock, flags);
838 channel = ZILOG_CHANNEL_FROM_PORT(port);
840 /* Disable receiver and transmitter. */
841 up->curregs[R3] &= ~RxENAB;
842 up->curregs[R5] &= ~TxENAB;
844 /* Disable all interrupts and BRK assertion. */
845 up->curregs[R1] &= ~(EXT_INT_ENAB | TxINT_ENAB | RxINT_MASK);
846 up->curregs[R5] &= ~SND_BRK;
847 sunzilog_maybe_update_regs(up, channel);
849 spin_unlock_irqrestore(&port->lock, flags);
852 /* Shared by TTY driver and serial console setup. The port lock is held
853 * and local interrupts are disabled.
856 sunzilog_convert_to_zs(struct uart_sunzilog_port *up, unsigned int cflag,
857 unsigned int iflag, int brg)
860 up->curregs[R10] = NRZ;
861 up->curregs[R11] = TCBR | RCBR;
863 /* Program BAUD and clock source. */
864 up->curregs[R4] &= ~XCLK_MASK;
865 up->curregs[R4] |= X16CLK;
866 up->curregs[R12] = brg & 0xff;
867 up->curregs[R13] = (brg >> 8) & 0xff;
868 up->curregs[R14] = BRSRC | BRENAB;
870 /* Character size, stop bits, and parity. */
871 up->curregs[3] &= ~RxN_MASK;
872 up->curregs[5] &= ~TxN_MASK;
873 switch (cflag & CSIZE) {
875 up->curregs[3] |= Rx5;
876 up->curregs[5] |= Tx5;
877 up->parity_mask = 0x1f;
880 up->curregs[3] |= Rx6;
881 up->curregs[5] |= Tx6;
882 up->parity_mask = 0x3f;
885 up->curregs[3] |= Rx7;
886 up->curregs[5] |= Tx7;
887 up->parity_mask = 0x7f;
891 up->curregs[3] |= Rx8;
892 up->curregs[5] |= Tx8;
893 up->parity_mask = 0xff;
896 up->curregs[4] &= ~0x0c;
898 up->curregs[4] |= SB2;
900 up->curregs[4] |= SB1;
902 up->curregs[4] |= PAR_ENAB;
904 up->curregs[4] &= ~PAR_ENAB;
905 if (!(cflag & PARODD))
906 up->curregs[4] |= PAR_EVEN;
908 up->curregs[4] &= ~PAR_EVEN;
910 up->port.read_status_mask = Rx_OVR;
912 up->port.read_status_mask |= CRC_ERR | PAR_ERR;
913 if (iflag & (BRKINT | PARMRK))
914 up->port.read_status_mask |= BRK_ABRT;
916 up->port.ignore_status_mask = 0;
918 up->port.ignore_status_mask |= CRC_ERR | PAR_ERR;
919 if (iflag & IGNBRK) {
920 up->port.ignore_status_mask |= BRK_ABRT;
922 up->port.ignore_status_mask |= Rx_OVR;
925 if ((cflag & CREAD) == 0)
926 up->port.ignore_status_mask = 0xff;
929 /* The port lock is not held. */
931 sunzilog_set_termios(struct uart_port *port, struct termios *termios,
934 struct uart_sunzilog_port *up = (struct uart_sunzilog_port *) port;
938 baud = uart_get_baud_rate(port, termios, old, 1200, 76800);
940 spin_lock_irqsave(&up->port.lock, flags);
942 brg = BPS_TO_BRG(baud, ZS_CLOCK / ZS_CLOCK_DIVISOR);
944 sunzilog_convert_to_zs(up, termios->c_cflag, termios->c_iflag, brg);
946 if (UART_ENABLE_MS(&up->port, termios->c_cflag))
947 up->flags |= SUNZILOG_FLAG_MODEM_STATUS;
949 up->flags &= ~SUNZILOG_FLAG_MODEM_STATUS;
951 up->cflag = termios->c_cflag;
953 sunzilog_maybe_update_regs(up, ZILOG_CHANNEL_FROM_PORT(port));
955 uart_update_timeout(port, termios->c_cflag, baud);
957 spin_unlock_irqrestore(&up->port.lock, flags);
960 static const char *sunzilog_type(struct uart_port *port)
965 /* We do not request/release mappings of the registers here, this
966 * happens at early serial probe time.
968 static void sunzilog_release_port(struct uart_port *port)
972 static int sunzilog_request_port(struct uart_port *port)
977 /* These do not need to do anything interesting either. */
978 static void sunzilog_config_port(struct uart_port *port, int flags)
982 /* We do not support letting the user mess with the divisor, IRQ, etc. */
983 static int sunzilog_verify_port(struct uart_port *port, struct serial_struct *ser)
988 static struct uart_ops sunzilog_pops = {
989 .tx_empty = sunzilog_tx_empty,
990 .set_mctrl = sunzilog_set_mctrl,
991 .get_mctrl = sunzilog_get_mctrl,
992 .stop_tx = sunzilog_stop_tx,
993 .start_tx = sunzilog_start_tx,
994 .stop_rx = sunzilog_stop_rx,
995 .enable_ms = sunzilog_enable_ms,
996 .break_ctl = sunzilog_break_ctl,
997 .startup = sunzilog_startup,
998 .shutdown = sunzilog_shutdown,
999 .set_termios = sunzilog_set_termios,
1000 .type = sunzilog_type,
1001 .release_port = sunzilog_release_port,
1002 .request_port = sunzilog_request_port,
1003 .config_port = sunzilog_config_port,
1004 .verify_port = sunzilog_verify_port,
1007 static struct uart_sunzilog_port *sunzilog_port_table;
1008 static struct zilog_layout __iomem **sunzilog_chip_regs;
1010 static struct uart_sunzilog_port *sunzilog_irq_chain;
1012 static struct uart_driver sunzilog_reg = {
1013 .owner = THIS_MODULE,
1014 .driver_name = "ttyS",
1019 static int __init sunzilog_alloc_tables(void)
1021 struct uart_sunzilog_port *up;
1025 size = NUM_CHANNELS * sizeof(struct uart_sunzilog_port);
1026 sunzilog_port_table = kzalloc(size, GFP_KERNEL);
1027 if (!sunzilog_port_table)
1030 for (i = 0; i < NUM_CHANNELS; i++) {
1031 up = &sunzilog_port_table[i];
1033 spin_lock_init(&up->port.lock);
1036 sunzilog_irq_chain = up;
1038 if (i < NUM_CHANNELS - 1)
1044 size = NUM_SUNZILOG * sizeof(struct zilog_layout __iomem *);
1045 sunzilog_chip_regs = kzalloc(size, GFP_KERNEL);
1046 if (!sunzilog_chip_regs) {
1047 kfree(sunzilog_port_table);
1048 sunzilog_irq_chain = NULL;
1055 static void sunzilog_free_tables(void)
1057 kfree(sunzilog_port_table);
1058 sunzilog_irq_chain = NULL;
1059 kfree(sunzilog_chip_regs);
1062 #define ZS_PUT_CHAR_MAX_DELAY 2000 /* 10 ms */
1064 static void sunzilog_putchar(struct uart_port *port, int ch)
1066 struct zilog_channel *channel = ZILOG_CHANNEL_FROM_PORT(port);
1067 int loops = ZS_PUT_CHAR_MAX_DELAY;
1069 /* This is a timed polling loop so do not switch the explicit
1070 * udelay with ZSDELAY as that is a NOP on some platforms. -DaveM
1073 unsigned char val = readb(&channel->control);
1074 if (val & Tx_BUF_EMP) {
1081 writeb(ch, &channel->data);
1088 static DEFINE_SPINLOCK(sunzilog_serio_lock);
1090 static int sunzilog_serio_write(struct serio *serio, unsigned char ch)
1092 struct uart_sunzilog_port *up = serio->port_data;
1093 unsigned long flags;
1095 spin_lock_irqsave(&sunzilog_serio_lock, flags);
1097 sunzilog_putchar(&up->port, ch);
1099 spin_unlock_irqrestore(&sunzilog_serio_lock, flags);
1104 static int sunzilog_serio_open(struct serio *serio)
1106 struct uart_sunzilog_port *up = serio->port_data;
1107 unsigned long flags;
1110 spin_lock_irqsave(&sunzilog_serio_lock, flags);
1111 if (!up->serio_open) {
1116 spin_unlock_irqrestore(&sunzilog_serio_lock, flags);
1121 static void sunzilog_serio_close(struct serio *serio)
1123 struct uart_sunzilog_port *up = serio->port_data;
1124 unsigned long flags;
1126 spin_lock_irqsave(&sunzilog_serio_lock, flags);
1128 spin_unlock_irqrestore(&sunzilog_serio_lock, flags);
1131 #endif /* CONFIG_SERIO */
1133 #ifdef CONFIG_SERIAL_SUNZILOG_CONSOLE
1135 sunzilog_console_write(struct console *con, const char *s, unsigned int count)
1137 struct uart_sunzilog_port *up = &sunzilog_port_table[con->index];
1138 unsigned long flags;
1140 spin_lock_irqsave(&up->port.lock, flags);
1141 uart_console_write(&up->port, s, count, sunzilog_putchar);
1143 spin_unlock_irqrestore(&up->port.lock, flags);
1146 static int __init sunzilog_console_setup(struct console *con, char *options)
1148 struct uart_sunzilog_port *up = &sunzilog_port_table[con->index];
1149 unsigned long flags;
1152 printk(KERN_INFO "Console: ttyS%d (SunZilog zs%d)\n",
1153 (sunzilog_reg.minor - 64) + con->index, con->index);
1155 /* Get firmware console settings. */
1156 sunserial_console_termios(con);
1158 /* Firmware console speed is limited to 150-->38400 baud so
1159 * this hackish cflag thing is OK.
1161 switch (con->cflag & CBAUD) {
1162 case B150: baud = 150; break;
1163 case B300: baud = 300; break;
1164 case B600: baud = 600; break;
1165 case B1200: baud = 1200; break;
1166 case B2400: baud = 2400; break;
1167 case B4800: baud = 4800; break;
1168 default: case B9600: baud = 9600; break;
1169 case B19200: baud = 19200; break;
1170 case B38400: baud = 38400; break;
1173 brg = BPS_TO_BRG(baud, ZS_CLOCK / ZS_CLOCK_DIVISOR);
1175 spin_lock_irqsave(&up->port.lock, flags);
1177 up->curregs[R15] = BRKIE;
1178 sunzilog_convert_to_zs(up, con->cflag, 0, brg);
1180 sunzilog_set_mctrl(&up->port, TIOCM_DTR | TIOCM_RTS);
1181 __sunzilog_startup(up);
1183 spin_unlock_irqrestore(&up->port.lock, flags);
1188 static struct console sunzilog_console = {
1190 .write = sunzilog_console_write,
1191 .device = uart_console_device,
1192 .setup = sunzilog_console_setup,
1193 .flags = CON_PRINTBUFFER,
1195 .data = &sunzilog_reg,
1198 static inline struct console *SUNZILOG_CONSOLE(void)
1202 if (con_is_present())
1205 for (i = 0; i < NUM_CHANNELS; i++) {
1206 int this_minor = sunzilog_reg.minor + i;
1208 if ((this_minor - 64) == (serial_console - 1))
1211 if (i == NUM_CHANNELS)
1214 sunzilog_console.index = i;
1215 sunzilog_port_table[i].flags |= SUNZILOG_FLAG_IS_CONS;
1217 return &sunzilog_console;
1221 #define SUNZILOG_CONSOLE() (NULL)
1224 static void __init sunzilog_init_kbdms(struct uart_sunzilog_port *up, int channel)
1228 if (channel == KEYBOARD_LINE) {
1229 up->flags |= SUNZILOG_FLAG_CONS_KEYB;
1230 up->cflag = B1200 | CS8 | CLOCAL | CREAD;
1233 up->flags |= SUNZILOG_FLAG_CONS_MOUSE;
1234 up->cflag = B4800 | CS8 | CLOCAL | CREAD;
1238 up->curregs[R15] = BRKIE;
1239 brg = BPS_TO_BRG(baud, ZS_CLOCK / ZS_CLOCK_DIVISOR);
1240 sunzilog_convert_to_zs(up, up->cflag, 0, brg);
1241 sunzilog_set_mctrl(&up->port, TIOCM_DTR | TIOCM_RTS);
1242 __sunzilog_startup(up);
1246 static void __init sunzilog_register_serio(struct uart_sunzilog_port *up, int channel)
1248 struct serio *serio = &up->serio;
1250 serio->port_data = up;
1252 serio->id.type = SERIO_RS232;
1253 if (channel == KEYBOARD_LINE) {
1254 serio->id.proto = SERIO_SUNKBD;
1255 strlcpy(serio->name, "zskbd", sizeof(serio->name));
1257 serio->id.proto = SERIO_SUN;
1258 serio->id.extra = 1;
1259 strlcpy(serio->name, "zsms", sizeof(serio->name));
1261 strlcpy(serio->phys,
1262 (channel == KEYBOARD_LINE ? "zs/serio0" : "zs/serio1"),
1263 sizeof(serio->phys));
1265 serio->write = sunzilog_serio_write;
1266 serio->open = sunzilog_serio_open;
1267 serio->close = sunzilog_serio_close;
1268 serio->dev.parent = up->port.dev;
1270 serio_register_port(serio);
1274 static void __init sunzilog_init_hw(struct uart_sunzilog_port *up)
1276 struct zilog_channel __iomem *channel;
1277 unsigned long flags;
1280 channel = ZILOG_CHANNEL_FROM_PORT(&up->port);
1282 spin_lock_irqsave(&up->port.lock, flags);
1283 if (ZS_IS_CHANNEL_A(up)) {
1284 write_zsreg(channel, R9, FHWRES);
1286 (void) read_zsreg(channel, R0);
1289 if (up->port.line == KEYBOARD_LINE ||
1290 up->port.line == MOUSE_LINE) {
1291 sunzilog_init_kbdms(up, up->port.line);
1292 up->curregs[R9] |= (NV | MIE);
1293 write_zsreg(channel, R9, up->curregs[R9]);
1295 /* Normal serial TTY. */
1296 up->parity_mask = 0xff;
1297 up->curregs[R1] = EXT_INT_ENAB | INT_ALL_Rx | TxINT_ENAB;
1298 up->curregs[R4] = PAR_EVEN | X16CLK | SB1;
1299 up->curregs[R3] = RxENAB | Rx8;
1300 up->curregs[R5] = TxENAB | Tx8;
1301 up->curregs[R9] = NV | MIE;
1302 up->curregs[R10] = NRZ;
1303 up->curregs[R11] = TCBR | RCBR;
1305 brg = BPS_TO_BRG(baud, ZS_CLOCK / ZS_CLOCK_DIVISOR);
1306 up->curregs[R12] = (brg & 0xff);
1307 up->curregs[R13] = (brg >> 8) & 0xff;
1308 up->curregs[R14] = BRSRC | BRENAB;
1309 __load_zsregs(channel, up->curregs);
1310 write_zsreg(channel, R9, up->curregs[R9]);
1313 spin_unlock_irqrestore(&up->port.lock, flags);
1316 if (up->port.line == KEYBOARD_LINE || up->port.line == MOUSE_LINE)
1317 sunzilog_register_serio(up, up->port.line);
1321 static int __devinit zs_get_instance(struct device_node *dp)
1325 ret = of_getintprop_default(dp, "slave", -1);
1329 if (of_find_property(dp, "keyboard", NULL))
1337 static int zilog_irq = -1;
1339 static int __devinit zs_probe(struct of_device *dev, const struct of_device_id *match)
1341 struct of_device *op = to_of_device(&dev->dev);
1342 struct uart_sunzilog_port *up;
1343 struct zilog_layout __iomem *rp;
1344 int inst = zs_get_instance(dev->node);
1347 sunzilog_chip_regs[inst] = of_ioremap(&op->resource[0], 0,
1348 sizeof(struct zilog_layout),
1350 if (!sunzilog_chip_regs[inst])
1353 rp = sunzilog_chip_regs[inst];
1355 if (zilog_irq == -1) {
1356 zilog_irq = op->irqs[0];
1357 err = request_irq(zilog_irq, sunzilog_interrupt, SA_SHIRQ,
1358 "zs", sunzilog_irq_chain);
1360 of_iounmap(rp, sizeof(struct zilog_layout));
1366 up = &sunzilog_port_table[inst * 2];
1369 up[0].port.mapbase = op->resource[0].start + 0x00;
1370 up[0].port.membase = (void __iomem *) &rp->channelA;
1371 up[0].port.iotype = UPIO_MEM;
1372 up[0].port.irq = op->irqs[0];
1373 up[0].port.uartclk = ZS_CLOCK;
1374 up[0].port.fifosize = 1;
1375 up[0].port.ops = &sunzilog_pops;
1376 up[0].port.type = PORT_SUNZILOG;
1377 up[0].port.flags = 0;
1378 up[0].port.line = (inst * 2) + 0;
1379 up[0].port.dev = &op->dev;
1380 up[0].flags |= SUNZILOG_FLAG_IS_CHANNEL_A;
1382 up[0].flags |= SUNZILOG_FLAG_CONS_KEYB;
1383 sunzilog_init_hw(&up[0]);
1386 up[1].port.mapbase = op->resource[0].start + 0x04;
1387 up[1].port.membase = (void __iomem *) &rp->channelB;
1388 up[1].port.iotype = UPIO_MEM;
1389 up[1].port.irq = op->irqs[0];
1390 up[1].port.uartclk = ZS_CLOCK;
1391 up[1].port.fifosize = 1;
1392 up[1].port.ops = &sunzilog_pops;
1393 up[1].port.type = PORT_SUNZILOG;
1394 up[1].port.flags = 0;
1395 up[1].port.line = (inst * 2) + 1;
1396 up[1].port.dev = &op->dev;
1399 up[1].flags |= SUNZILOG_FLAG_CONS_MOUSE;
1400 sunzilog_init_hw(&up[1]);
1403 err = uart_add_one_port(&sunzilog_reg, &up[0].port);
1405 of_iounmap(rp, sizeof(struct zilog_layout));
1408 err = uart_add_one_port(&sunzilog_reg, &up[1].port);
1410 uart_remove_one_port(&sunzilog_reg, &up[0].port);
1411 of_iounmap(rp, sizeof(struct zilog_layout));
1416 dev_set_drvdata(&dev->dev, &up[0]);
1421 static void __devexit zs_remove_one(struct uart_sunzilog_port *up)
1423 if (ZS_IS_KEYB(up) || ZS_IS_MOUSE(up)) {
1425 serio_unregister_port(&up->serio);
1428 uart_remove_one_port(&sunzilog_reg, &up->port);
1431 static int __devexit zs_remove(struct of_device *dev)
1433 struct uart_sunzilog_port *up = dev_get_drvdata(&dev->dev);
1434 struct zilog_layout __iomem *regs;
1436 zs_remove_one(&up[0]);
1437 zs_remove_one(&up[1]);
1439 regs = sunzilog_chip_regs[up[0].port.line / 2];
1440 of_iounmap(regs, sizeof(struct zilog_layout));
1442 dev_set_drvdata(&dev->dev, NULL);
1447 static struct of_device_id zs_match[] = {
1453 MODULE_DEVICE_TABLE(of, zs_match);
1455 static struct of_platform_driver zs_driver = {
1457 .match_table = zs_match,
1459 .remove = __devexit_p(zs_remove),
1462 static int __init sunzilog_init(void)
1464 struct device_node *dp;
1468 for_each_node_by_name(dp, "zs")
1474 err = sunzilog_alloc_tables();
1478 /* Subtract 1 for keyboard, 1 for mouse. */
1479 uart_count = (NUM_SUNZILOG * 2) - 2;
1481 sunzilog_reg.nr = uart_count;
1482 sunzilog_reg.minor = sunserial_current_minor;
1483 err = uart_register_driver(&sunzilog_reg);
1485 sunzilog_free_tables();
1488 sunzilog_reg.tty_driver->name_base = sunzilog_reg.minor - 64;
1489 sunzilog_reg.cons = SUNZILOG_CONSOLE();
1491 sunserial_current_minor += uart_count;
1494 return of_register_driver(&zs_driver, &of_bus_type);
1497 static void __exit sunzilog_exit(void)
1499 of_unregister_driver(&zs_driver);
1501 if (zilog_irq != -1) {
1502 free_irq(zilog_irq, sunzilog_irq_chain);
1507 uart_unregister_driver(&sunzilog_reg);
1508 sunzilog_free_tables();
1512 module_init(sunzilog_init);
1513 module_exit(sunzilog_exit);
1515 MODULE_AUTHOR("David S. Miller");
1516 MODULE_DESCRIPTION("Sun Zilog serial port driver");
1517 MODULE_VERSION("2.0");
1518 MODULE_LICENSE("GPL");