1 /* $NetBSD: zs.c,v 1.35 2008/06/13 12:27:26 cegger Exp $ */
4 * Copyright (c) 1996, 2000 The NetBSD Foundation, Inc.
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Gordon W. Ross and Wayne Knowles
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
33 * Zilog Z8530 Dual UART driver (machine-dependent part)
35 * Runs two serial lines per chip using slave drivers.
36 * Plain tty/async lines use the zs_async slave.
39 #include <sys/cdefs.h>
40 __KERNEL_RCSID(0, "$NetBSD: zs.c,v 1.35 2008/06/13 12:27:26 cegger Exp $");
45 #include <sys/param.h>
46 #include <sys/systm.h>
48 #include <sys/device.h>
50 #include <sys/ioctl.h>
51 #include <sys/kernel.h>
55 #include <sys/syslog.h>
59 #include <machine/machtype.h>
60 #include <machine/autoconf.h>
61 #include <machine/z8530var.h>
64 #include <dev/ic/z8530reg.h>
66 #include <sgimips/hpc/hpcvar.h>
67 #include <sgimips/hpc/hpcreg.h>
69 #include <dev/arcbios/arcbios.h>
70 #include <dev/arcbios/arcbiosvar.h>
75 * Some warts needed by z8530tty.c -
76 * The default parity REALLY needs to be the same as the PROM uses,
77 * or you can not see messages done with printf during boot-up...
79 int zs_def_cflag
= (CREAD
| CS8
| HUPCL
);
81 #define PCLK 3672000 /* PCLK pin input clock rate */
84 #define ZS_DEFSPEED 9600
88 * Define interrupt levels.
92 /* SGI shouldn't need ZS_DELAY() as recovery time is done in hardware? */
93 #define ZS_DELAY() delay(3)
95 /* The layout of this is hardware-dependent (padding, order). */
98 volatile uint8_t zc_csr
; /* ctrl,status, and indirect access */
100 volatile uint8_t zc_data
; /* data */
104 struct zschan zs_chan_b
;
105 struct zschan zs_chan_a
;
108 /* Return the byte offset of element within a structure */
109 #define OFFSET(struct_def, el) ((size_t)&((struct_def *)0)->el)
111 #define ZS_CHAN_A OFFSET(struct zsdevice, zs_chan_a)
112 #define ZS_CHAN_B OFFSET(struct zsdevice, zs_chan_b)
114 #define ZS_REG_DATA 1
115 static int zs_chan_offset
[] = {ZS_CHAN_A
, ZS_CHAN_B
};
117 static void zscnprobe (struct consdev
*);
118 static void zscninit (struct consdev
*);
119 static int zscngetc (dev_t
);
120 static void zscnputc (dev_t
, int);
121 static void zscnpollc (dev_t
, int);
123 static int cons_port
;
125 struct consdev zs_cn
= {
138 /* Flags from cninit() */
139 static int zs_consunit
= -1;
140 static int zs_conschan
= -1;
142 /* Default speed for all channels */
143 static int zs_defspeed
= ZS_DEFSPEED
;
144 static volatile int zssoftpending
;
146 static uint8_t zs_init_reg
[16] = {
147 0, /* 0: CMD (reset, etc.) */
148 0, /* 1: No interrupts yet. */
149 ZSHARD_PRI
, /* 2: IVECT */
150 ZSWR3_RX_8
| ZSWR3_RX_ENABLE
,
151 ZSWR4_CLK_X16
| ZSWR4_ONESB
,
152 ZSWR5_TX_8
| ZSWR5_TX_ENABLE
,
153 0, /* 6: TXSYNC/SYNCLO */
154 0, /* 7: RXSYNC/SYNCHI */
155 0, /* 8: alias for data port */
157 0, /*10: Misc. TX/RX control bits */
158 ZSWR11_TXCLK_BAUD
| ZSWR11_RXCLK_BAUD
| ZSWR11_TRXC_OUT_ENA
,
159 BPS_TO_TCONST(PCLK
/16, ZS_DEFSPEED
), /*12: BAUDLO (default=9600) */
160 0, /*13: BAUDHI (default=9600) */
166 /****************************************************************
168 ****************************************************************/
170 /* Definition of the driver for autoconfig. */
171 static int zs_hpc_match(device_t
, cfdata_t
, void *);
172 static void zs_hpc_attach(device_t
, device_t
, void *);
173 static int zs_print(void *, const char *name
);
175 CFATTACH_DECL_NEW(zsc_hpc
, sizeof(struct zsc_softc
),
176 zs_hpc_match
, zs_hpc_attach
, NULL
, NULL
);
178 static int zshard (void *);
179 void zssoft (void *);
180 static int zs_get_speed (struct zs_chanstate
*);
181 struct zschan
*zs_get_chan_addr (int zs_unit
, int channel
);
182 int zs_getc (void *);
183 void zs_putc (void *, int);
186 * Is the zs chip present?
189 zs_hpc_match(device_t parent
, cfdata_t cf
, void *aux
)
191 struct hpc_attach_args
*ha
= aux
;
193 if (strcmp(ha
->ha_name
, cf
->cf_name
) == 0)
202 * Match slave number to zs unit number, so that misconfiguration will
203 * not set up the keyboard as ttya, etc.
206 zs_hpc_attach(device_t parent
, device_t self
, void *aux
)
208 struct zsc_softc
*zsc
= device_private(self
);
209 struct hpc_attach_args
*haa
= aux
;
210 struct zsc_attach_args zsc_args
;
211 struct zs_chanstate
*cs
;
212 struct zs_channel
*ch
;
213 int zs_unit
, channel
, err
, s
;
214 const char *promconsdev
;
216 promconsdev
= ARCBIOS
->GetEnvironmentVariable("ConsoleOut");
219 zsc
->zsc_bustag
= haa
->ha_st
;
220 if ((err
= bus_space_subregion(haa
->ha_st
, haa
->ha_sh
,
221 haa
->ha_devoff
, 0x10,
222 &zsc
->zsc_base
)) != 0) {
223 aprint_error(": unable to map 85c30 registers, error = %d\n",
228 zs_unit
= device_unit(self
);
232 * Initialize software state for each channel.
234 * Done in reverse order of channels since the first serial port
235 * is actually attached to the *second* channel, and vice versa.
236 * Doing it this way should force a 'zstty*' to attach zstty0 to
237 * channel 1 and zstty1 to channel 0. They couldn't have wired
238 * it up in a more sensible fashion, could they?
240 for (channel
= 1; channel
>= 0; channel
--) {
241 zsc_args
.channel
= channel
;
242 ch
= &zsc
->zsc_cs_store
[channel
];
243 cs
= zsc
->zsc_cs
[channel
] = (struct zs_chanstate
*)ch
;
246 cs
->cs_reg_csr
= NULL
;
247 cs
->cs_reg_data
= NULL
;
248 cs
->cs_channel
= channel
;
249 cs
->cs_private
= NULL
;
250 cs
->cs_ops
= &zsops_null
;
251 cs
->cs_brg_clk
= PCLK
/ 16;
253 if (bus_space_subregion(zsc
->zsc_bustag
, zsc
->zsc_base
,
254 zs_chan_offset
[channel
],
255 sizeof(struct zschan
),
256 &ch
->cs_regs
) != 0) {
257 aprint_error_dev(self
, "cannot map regs\n");
260 ch
->cs_bustag
= zsc
->zsc_bustag
;
262 memcpy(cs
->cs_creg
, zs_init_reg
, 16);
263 memcpy(cs
->cs_preg
, zs_init_reg
, 16);
265 zsc_args
.hwflags
= 0;
266 zsc_args
.consdev
= NULL
;
268 if (zs_consunit
== -1 && zs_conschan
== -1) {
270 * If this channel is being used by the PROM console,
271 * pass the generic zs driver a 'no reset' flag so the
272 * channel gets left in the appropriate state after
275 * Note: the channel mappings are swapped.
277 if (promconsdev
!= NULL
&&
278 strlen(promconsdev
) == 9 &&
279 strncmp(promconsdev
, "serial", 6) == 0 &&
280 (promconsdev
[7] == '0' || promconsdev
[7] == '1')) {
281 if (promconsdev
[7] == '1' && channel
== 0)
282 zsc_args
.hwflags
|= ZS_HWFLAG_NORESET
;
283 else if (promconsdev
[7] == '0' && channel
== 1)
284 zsc_args
.hwflags
|= ZS_HWFLAG_NORESET
;
288 /* If console, don't stomp speed, let zstty know */
289 if (zs_unit
== zs_consunit
&& channel
== zs_conschan
) {
290 zsc_args
.consdev
= &zs_cn
;
291 zsc_args
.hwflags
= ZS_HWFLAG_CONSOLE
;
293 cs
->cs_defspeed
= zs_get_speed(cs
);
295 cs
->cs_defspeed
= zs_defspeed
;
297 cs
->cs_defcflag
= zs_def_cflag
;
299 /* Make these correspond to cs_defcflag (-crtscts) */
300 cs
->cs_rr0_dcd
= ZSRR0_DCD
;
302 cs
->cs_wr5_dtr
= ZSWR5_DTR
| ZSWR5_RTS
;
306 * Clear the master interrupt enable.
307 * The INTENA is common to both channels,
308 * so just do it on the A channel.
311 zs_write_reg(cs
, 9, 0);
314 * Look for a child driver for this channel.
315 * The child attach will setup the hardware.
317 if (!config_found(self
, (void *)&zsc_args
, zs_print
)) {
318 /* No sub-driver. Just reset it. */
319 uint8_t reset
= (channel
== 0) ?
320 ZSWR9_A_RESET
: ZSWR9_B_RESET
;
323 zs_write_reg(cs
, 9, reset
);
329 zsc
->sc_si
= softint_establish(SOFTINT_SERIAL
, zssoft
, zsc
);
330 cpu_intr_establish(haa
->ha_irq
, IPL_TTY
, zshard
, NULL
);
332 evcnt_attach_dynamic(&zsc
->zsc_intrcnt
, EVCNT_TYPE_INTR
, NULL
,
333 device_xname(self
), "intr");
336 * Set the master interrupt enable and interrupt vector.
337 * (common to both channels, do it on A)
341 /* interrupt vector */
342 zs_write_reg(cs
, 2, zs_init_reg
[2]);
343 /* master interrupt control (enable) */
344 zs_write_reg(cs
, 9, zs_init_reg
[9]);
349 zs_print(void *aux
, const char *name
)
351 struct zsc_attach_args
*args
= aux
;
354 aprint_normal("%s: ", name
);
356 if (args
->channel
!= -1)
357 aprint_normal(" channel %d", args
->channel
);
363 * Our ZS chips all share a common, autovectored interrupt,
364 * so we have to look at all of them on each interrupt.
369 register struct zsc_softc
*zsc
;
370 register int rr3
, unit
, rval
, softreq
;
373 for (unit
= 0; unit
< zsc_cd
.cd_ndevs
; unit
++) {
374 zsc
= device_lookup_private(&zsc_cd
, unit
);
378 zsc
->zsc_intrcnt
.ev_count
++;
379 while ((rr3
= zsc_intr_hard(zsc
))) {
383 softreq
= zsc
->zsc_cs
[0]->cs_softreq
;
384 softreq
|= zsc
->zsc_cs
[1]->cs_softreq
;
385 if (softreq
&& (zssoftpending
== 0)) {
387 softint_schedule(zsc
->sc_si
);
394 * Similar scheme as for zshard (look at all of them)
399 register struct zsc_softc
*zsc
;
400 register int s
, unit
;
402 /* This is not the only ISR on this IPL. */
403 if (zssoftpending
== 0)
407 * The soft intr. bit will be set by zshard only if
408 * the variable zssoftpending is zero. The order of
409 * these next two statements prevents our clearing
410 * the soft intr bit just after zshard has set it.
412 /*isr_soft_clear(ZSSOFT_PRI);*/
415 /* Make sure we call the tty layer at spltty. */
417 for (unit
= 0; unit
< zsc_cd
.cd_ndevs
; unit
++) {
418 zsc
= device_lookup_private(&zsc_cd
, unit
);
421 (void) zsc_intr_soft(zsc
);
429 * Compute the current baud rate given a ZS channel.
432 zs_get_speed(struct zs_chanstate
*cs
)
436 tconst
= zs_read_reg(cs
, 12);
437 tconst
|= zs_read_reg(cs
, 13) << 8;
438 return (TCONST_TO_BPS(cs
->cs_brg_clk
, tconst
));
442 * MD functions for setting the baud rate and control modes.
445 zs_set_speed(struct zs_chanstate
*cs
, int bps
)
447 int tconst
, real_bps
;
450 while (!(zs_read_csr(cs
) & ZSRR0_TX_READY
))
453 /* Wait for transmit buffer to empty */
459 if (cs
->cs_brg_clk
== 0)
460 panic("zs_set_speed");
463 tconst
= BPS_TO_TCONST(cs
->cs_brg_clk
, bps
);
467 /* Convert back to make sure we can do it. */
468 real_bps
= TCONST_TO_BPS(cs
->cs_brg_clk
, tconst
);
470 /* XXX - Allow some tolerance here? */
476 cs
->cs_preg
[12] = tconst
;
477 cs
->cs_preg
[13] = tconst
>> 8;
479 /* Caller will stuff the pending registers. */
484 zs_set_modes(struct zs_chanstate
*cs
, int cflag
)
489 * Output hardware flow control on the chip is horrendous:
490 * if carrier detect drops, the receiver is disabled, and if
491 * CTS drops, the transmitter is stoped IN MID CHARACTER!
492 * Therefore, NEVER set the HFC bit, and instead use the
493 * status interrupt to detect CTS changes.
497 if ((cflag
& (CLOCAL
| MDMBUF
)) != 0) {
499 if ((cflag
& MDMBUF
) == 0)
500 cs
->cs_rr0_pps
= ZSRR0_DCD
;
502 cs
->cs_rr0_dcd
= ZSRR0_DCD
;
503 if ((cflag
& CRTSCTS
) != 0) {
504 cs
->cs_wr5_dtr
= ZSWR5_DTR
;
505 cs
->cs_wr5_rts
= ZSWR5_RTS
;
506 cs
->cs_rr0_cts
= ZSRR0_CTS
;
507 } else if ((cflag
& MDMBUF
) != 0) {
509 cs
->cs_wr5_rts
= ZSWR5_DTR
;
510 cs
->cs_rr0_cts
= ZSRR0_DCD
;
512 cs
->cs_wr5_dtr
= ZSWR5_DTR
| ZSWR5_RTS
;
518 /* Caller will stuff the pending registers. */
524 * Read or write the chip with suitable delays.
528 zs_read_reg(struct zs_chanstate
*cs
, uint8_t reg
)
531 struct zs_channel
*zsc
= (struct zs_channel
*)cs
;
533 bus_space_write_1(zsc
->cs_bustag
, zsc
->cs_regs
, ZS_REG_CSR
, reg
);
535 val
= bus_space_read_1(zsc
->cs_bustag
, zsc
->cs_regs
, ZS_REG_CSR
);
541 zs_write_reg(struct zs_chanstate
*cs
, uint8_t reg
, uint8_t val
)
543 struct zs_channel
*zsc
= (struct zs_channel
*)cs
;
545 bus_space_write_1(zsc
->cs_bustag
, zsc
->cs_regs
, ZS_REG_CSR
, reg
);
547 bus_space_write_1(zsc
->cs_bustag
, zsc
->cs_regs
, ZS_REG_CSR
, val
);
552 zs_read_csr(struct zs_chanstate
*cs
)
554 struct zs_channel
*zsc
= (struct zs_channel
*)cs
;
557 val
= bus_space_read_1(zsc
->cs_bustag
, zsc
->cs_regs
, ZS_REG_CSR
);
563 zs_write_csr(struct zs_chanstate
*cs
, uint8_t val
)
565 struct zs_channel
*zsc
= (struct zs_channel
*)cs
;
567 bus_space_write_1(zsc
->cs_bustag
, zsc
->cs_regs
, ZS_REG_CSR
, val
);
572 zs_read_data(struct zs_chanstate
*cs
)
574 struct zs_channel
*zsc
= (struct zs_channel
*)cs
;
577 val
= bus_space_read_1(zsc
->cs_bustag
, zsc
->cs_regs
, ZS_REG_DATA
);
583 zs_write_data(struct zs_chanstate
*cs
, uint8_t val
)
585 struct zs_channel
*zsc
= (struct zs_channel
*)cs
;
587 bus_space_write_1(zsc
->cs_bustag
, zsc
->cs_regs
, ZS_REG_DATA
, val
);
592 zs_abort(struct zs_chanstate
*cs
)
602 /*********************************************************/
603 /* Polled character I/O functions for console and KGDB */
604 /*********************************************************/
607 zs_get_chan_addr(int zs_unit
, int channel
)
609 static int dumped_addr
= 0;
610 struct zsdevice
*addr
;
615 if (zs_unit
== 2 && (mach_subtype
== MACH_SGI_IP12_4D_3X
||
616 mach_subtype
== MACH_SGI_IP12_VIP12
)) {
617 addr
= (struct zsdevice
*)
618 MIPS_PHYS_TO_KSEG1(0x1fb80d20);
625 addr
= (struct zsdevice
*)
626 MIPS_PHYS_TO_KSEG1(0x1fb80d00);
627 } else if (zs_unit
== 1) {
628 addr
= (struct zsdevice
*)
629 MIPS_PHYS_TO_KSEG1(0x1fb80d10);
631 panic("zs_get_chan_addr: bad zs_unit %d\n", zs_unit
);
637 panic("zs_get_chan_addr zs_unit != 0 on IP%d",
640 addr
= (struct zsdevice
*) MIPS_PHYS_TO_KSEG1(0x1fbd9830);
644 panic("zs_get_chan_addr: unsupported IP%d", mach_type
);
648 * We need to swap serial ports to match reality on
649 * non-keyboard channels.
651 if (mach_type
== MACH_SGI_IP22
) {
653 zc
= &addr
->zs_chan_b
;
655 zc
= &addr
->zs_chan_a
;
659 zc
= &addr
->zs_chan_a
;
661 zc
= &addr
->zs_chan_b
;
664 zc
= &addr
->zs_chan_b
;
666 zc
= &addr
->zs_chan_a
;
670 if (dumped_addr
== 0) {
672 aprint_debug("zs unit %d, channel %d had address %p\n",
673 zs_unit
, channel
, zc
);
682 register volatile struct zschan
*zc
= arg
;
683 register int s
, c
, rr0
;
686 /* Wait for a character to arrive. */
690 } while ((rr0
& ZSRR0_RX_READY
) == 0);
700 * Polled output char.
703 zs_putc(void *arg
, int c
)
705 register volatile struct zschan
*zc
= arg
;
709 /* Wait for transmitter to become ready. */
713 } while ((rr0
& ZSRR0_TX_READY
) == 0);
721 /***************************************************************/
723 zscnprobe(struct consdev
*cn
)
728 zscninit(struct consdev
*cn
)
730 extern const struct cdevsw zstty_cdevsw
;
733 if ((consdev
= ARCBIOS
->GetEnvironmentVariable("ConsoleOut")) == NULL
)
734 panic("zscninit without valid ARCS ConsoleOut setting!");
736 if (strlen(consdev
) != 9 ||
737 strncmp(consdev
, "serial", 6) != 0)
738 panic("zscninit with ARCS console not set to serial!");
740 cons_port
= consdev
[7] - '0';
744 * If your IP12 serial console goes missing after consinit(),
745 * try flipping this the other way 'round. If there are some
746 * IP12 machines that actually require this, we'll be in for
747 * a lot of funnies once again...
749 if (mach_type
== MACH_SGI_IP12
)
750 cons_port
= 1 - cons_port
;
753 cn
->cn_dev
= makedev(cdevsw_lookup_major(&zstty_cdevsw
), cons_port
);
754 cn
->cn_pri
= CN_REMOTE
;
756 /* Mark this unit as the console */
759 /* SGI hardware wires serial port 1 to channel B, port 2 to A */
774 zs
= zs_get_chan_addr(1, cons_port
);
779 zs
= zs_get_chan_addr(0, cons_port
);
787 zscnputc(dev_t dev
, int c
)
794 zs
= zs_get_chan_addr(1, cons_port
);
799 zs
= zs_get_chan_addr(0, cons_port
);
807 zscnpollc(dev_t dev
, int on
)