Home | History | Annotate | Line # | Download | only in dev
zs.c revision 1.115
      1 /*	$NetBSD: zs.c,v 1.115 2009/05/22 03:51:30 mrg Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 1996 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Gordon W. Ross.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     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.
     18  *
     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.
     30  */
     31 
     32 /*
     33  * Zilog Z8530 Dual UART driver (machine-dependent part)
     34  *
     35  * Runs two serial lines per chip using slave drivers.
     36  * Plain tty/async lines use the zs_async slave.
     37  * Sun keyboard/mouse uses the zs_kbd/zs_ms slaves.
     38  */
     39 
     40 #include <sys/cdefs.h>
     41 __KERNEL_RCSID(0, "$NetBSD: zs.c,v 1.115 2009/05/22 03:51:30 mrg Exp $");
     42 
     43 #include "opt_ddb.h"
     44 #include "opt_kgdb.h"
     45 #include "opt_sparc_arch.h"
     46 
     47 #include <sys/param.h>
     48 #include <sys/systm.h>
     49 #include <sys/conf.h>
     50 #include <sys/device.h>
     51 #include <sys/file.h>
     52 #include <sys/ioctl.h>
     53 #include <sys/kernel.h>
     54 #include <sys/proc.h>
     55 #include <sys/tty.h>
     56 #include <sys/time.h>
     57 #include <sys/syslog.h>
     58 #include <sys/intr.h>
     59 
     60 #include <machine/bsd_openprom.h>
     61 #include <machine/autoconf.h>
     62 #include <machine/eeprom.h>
     63 #include <machine/psl.h>
     64 #include <machine/z8530var.h>
     65 
     66 #include <dev/cons.h>
     67 #include <dev/ic/z8530reg.h>
     68 
     69 #include <sparc/sparc/vaddrs.h>
     70 #include <sparc/sparc/auxreg.h>
     71 #include <sparc/sparc/auxiotwo.h>
     72 #include <sparc/dev/cons.h>
     73 #include <dev/sun/kbd_ms_ttyvar.h>
     74 
     75 #include "kbd.h"
     76 #include "ms.h"
     77 #include "wskbd.h"
     78 
     79 /*
     80  * Some warts needed by z8530tty.c -
     81  * The default parity REALLY needs to be the same as the PROM uses,
     82  * or you can not see messages done with printf during boot-up...
     83  */
     84 int zs_def_cflag = (CREAD | CS8 | HUPCL);
     85 
     86 /*
     87  * The Sun provides a 4.9152 MHz clock to the ZS chips.
     88  */
     89 #define PCLK	(9600 * 512)	/* PCLK pin input clock rate */
     90 
     91 #define	ZS_DELAY()		(CPU_ISSUN4C ? (0) : delay(2))
     92 
     93 /* The layout of this is hardware-dependent (padding, order). */
     94 struct zschan {
     95 	volatile uint8_t zc_csr;	/* ctrl,status, and indirect access */
     96 	uint8_t		zc_xxx0;
     97 	volatile uint8_t zc_data;	/* data */
     98 	uint8_t		zc_xxx1;
     99 };
    100 struct zsdevice {
    101 	/* Yes, they are backwards. */
    102 	struct	zschan zs_chan_b;
    103 	struct	zschan zs_chan_a;
    104 };
    105 
    106 /* ZS channel used as the console device (if any) */
    107 void *zs_conschan_get, *zs_conschan_put;
    108 
    109 static uint8_t zs_init_reg[16] = {
    110 	0,	/* 0: CMD (reset, etc.) */
    111 	0,	/* 1: No interrupts yet. */
    112 	0,	/* 2: IVECT */
    113 	ZSWR3_RX_8 | ZSWR3_RX_ENABLE,
    114 	ZSWR4_CLK_X16 | ZSWR4_ONESB | ZSWR4_EVENP,
    115 	ZSWR5_TX_8 | ZSWR5_TX_ENABLE,
    116 	0,	/* 6: TXSYNC/SYNCLO */
    117 	0,	/* 7: RXSYNC/SYNCHI */
    118 	0,	/* 8: alias for data port */
    119 	ZSWR9_MASTER_IE | ZSWR9_NO_VECTOR,
    120 	0,	/*10: Misc. TX/RX control bits */
    121 	ZSWR11_TXCLK_BAUD | ZSWR11_RXCLK_BAUD,
    122 	((PCLK/32)/9600)-2,	/*12: BAUDLO (default=9600) */
    123 	0,			/*13: BAUDHI (default=9600) */
    124 	ZSWR14_BAUD_ENA | ZSWR14_BAUD_FROM_PCLK,
    125 	ZSWR15_BREAK_IE,
    126 };
    127 
    128 /* Console ops */
    129 static int  zscngetc(dev_t);
    130 static void zscnputc(dev_t, int);
    131 static void zscnpollc(dev_t, int);
    132 
    133 struct consdev zs_consdev = {
    134 	NULL,
    135 	NULL,
    136 	zscngetc,
    137 	zscnputc,
    138 	zscnpollc,
    139 	NULL,
    140 };
    141 
    142 
    143 /****************************************************************
    144  * Autoconfig
    145  ****************************************************************/
    146 
    147 /* Definition of the driver for autoconfig. */
    148 static int  zs_match_mainbus(device_t, cfdata_t, void *);
    149 static int  zs_match_obio(device_t, cfdata_t, void *);
    150 static void zs_attach_mainbus(device_t, device_t, void *);
    151 static void zs_attach_obio(device_t, device_t, void *);
    152 
    153 #if defined(SUN4D)
    154 #include <sparc/dev/bootbusvar.h>
    155 
    156 static int  zs_match_bootbus(device_t, cfdata_t, void *);
    157 static void zs_attach_bootbus(device_t, device_t, void *);
    158 
    159 CFATTACH_DECL_NEW(zs_bootbus, sizeof(struct zsc_softc),
    160     zs_match_bootbus, zs_attach_bootbus, NULL, NULL);
    161 #endif /* SUN4D */
    162 
    163 static void zs_attach(struct zsc_softc *, struct zsdevice *, int);
    164 static int  zs_print(void *, const char *name);
    165 
    166 CFATTACH_DECL_NEW(zs_mainbus, sizeof(struct zsc_softc),
    167     zs_match_mainbus, zs_attach_mainbus, NULL, NULL);
    168 
    169 CFATTACH_DECL_NEW(zs_obio, sizeof(struct zsc_softc),
    170     zs_match_obio, zs_attach_obio, NULL, NULL);
    171 
    172 extern struct cfdriver zs_cd;
    173 
    174 /* softintr(9) cookie, shared by all instances of this driver */
    175 static void *zs_sicookie;
    176 
    177 /* Interrupt handlers. */
    178 static int zshard(void *);
    179 static void zssoft(void *);
    180 
    181 static int zs_get_speed(struct zs_chanstate *);
    182 
    183 /* Console device support */
    184 static int zs_console_flags(int, int, int);
    185 
    186 /* Power management hooks */
    187 int  zs_enable(struct zs_chanstate *);
    188 void zs_disable(struct zs_chanstate *);
    189 
    190 
    191 /* XXX from dev/ic/z8530tty.c */
    192 extern struct tty *zstty_get_tty_from_dev(struct device *);
    193 
    194 /*
    195  * Is the zs chip present?
    196  */
    197 static int
    198 zs_match_mainbus(device_t parent, cfdata_t cf, void *aux)
    199 {
    200 	struct mainbus_attach_args *ma = aux;
    201 
    202 	if (strcmp(cf->cf_name, ma->ma_name) != 0)
    203 		return (0);
    204 
    205 	return (1);
    206 }
    207 
    208 static int
    209 zs_match_obio(device_t parent, cfdata_t cf, void *aux)
    210 {
    211 	union obio_attach_args *uoba = aux;
    212 	struct obio4_attach_args *oba;
    213 
    214 	if (uoba->uoba_isobio4 == 0) {
    215 		struct sbus_attach_args *sa = &uoba->uoba_sbus;
    216 
    217 		if (strcmp(cf->cf_name, sa->sa_name) != 0)
    218 			return (0);
    219 
    220 		return (1);
    221 	}
    222 
    223 	oba = &uoba->uoba_oba4;
    224 	return (bus_space_probe(oba->oba_bustag, oba->oba_paddr,
    225 			        1, 0, 0, NULL, NULL));
    226 }
    227 
    228 #if defined(SUN4D)
    229 static int
    230 zs_match_bootbus(device_t parent, cfdata_t cf, void *aux)
    231 {
    232 	struct bootbus_attach_args *baa = aux;
    233 
    234 	return (strcmp(cf->cf_name, baa->ba_name) == 0);
    235 }
    236 #endif /* SUN4D */
    237 
    238 static void
    239 zs_attach_mainbus(device_t parent, device_t self, void *aux)
    240 {
    241 	struct zsc_softc *zsc = device_private(self);
    242 	struct mainbus_attach_args *ma = aux;
    243 
    244 	zsc->zsc_dev = self;
    245 	zsc->zsc_bustag = ma->ma_bustag;
    246 	zsc->zsc_dmatag = ma->ma_dmatag;
    247 	zsc->zsc_promunit = prom_getpropint(ma->ma_node, "slave", -2);
    248 	zsc->zsc_node = ma->ma_node;
    249 
    250 	/*
    251 	 * For machines with zs on mainbus (all sun4c models), we expect
    252 	 * the device registers to be mapped by the PROM.
    253 	 */
    254 	zs_attach(zsc, ma->ma_promvaddr, ma->ma_pri);
    255 }
    256 
    257 static void
    258 zs_attach_obio(device_t parent, device_t self, void *aux)
    259 {
    260 	struct zsc_softc *zsc = device_private(self);
    261 	union obio_attach_args *uoba = aux;
    262 
    263 	zsc->zsc_dev = self;
    264 
    265 	if (uoba->uoba_isobio4 == 0) {
    266 		struct sbus_attach_args *sa = &uoba->uoba_sbus;
    267 		void *va;
    268 		struct zs_chanstate *cs;
    269 		int channel;
    270 
    271 		if (sa->sa_nintr == 0) {
    272 			aprint_error(": no interrupt lines\n");
    273 			return;
    274 		}
    275 
    276 		/*
    277 		 * Some sun4m models (Javastations) may not map the zs device.
    278 		 */
    279 		if (sa->sa_npromvaddrs > 0)
    280 			va = (void *)sa->sa_promvaddr;
    281 		else {
    282 			bus_space_handle_t bh;
    283 
    284 			if (sbus_bus_map(sa->sa_bustag,
    285 					 sa->sa_slot,
    286 					 sa->sa_offset,
    287 					 sa->sa_size,
    288 					 BUS_SPACE_MAP_LINEAR, &bh) != 0) {
    289 				aprint_error(": cannot map zs registers\n");
    290 				return;
    291 			}
    292 			va = (void *)bh;
    293 		}
    294 
    295 		/*
    296 		 * Check if power state can be set, e.g. Tadpole 3GX
    297 		 */
    298 		if (prom_getpropint(sa->sa_node, "pwr-on-auxio2", 0)) {
    299 			aprint_normal(": powered via auxio2");
    300 			for (channel = 0; channel < 2; channel++) {
    301 				cs = &zsc->zsc_cs_store[channel];
    302 				cs->enable = zs_enable;
    303 				cs->disable = zs_disable;
    304 			}
    305 		}
    306 
    307 		zsc->zsc_bustag = sa->sa_bustag;
    308 		zsc->zsc_dmatag = sa->sa_dmatag;
    309 		zsc->zsc_promunit = prom_getpropint(sa->sa_node, "slave", -2);
    310 		zsc->zsc_node = sa->sa_node;
    311 		zs_attach(zsc, va, sa->sa_pri);
    312 	} else {
    313 		struct obio4_attach_args *oba = &uoba->uoba_oba4;
    314 		bus_space_handle_t bh;
    315 		bus_addr_t paddr = oba->oba_paddr;
    316 
    317 		/*
    318 		 * As for zs on mainbus, we require a PROM mapping.
    319 		 */
    320 		if (bus_space_map(oba->oba_bustag,
    321 				  paddr,
    322 				  sizeof(struct zsdevice),
    323 				  BUS_SPACE_MAP_LINEAR | OBIO_BUS_MAP_USE_ROM,
    324 				  &bh) != 0) {
    325 			aprint_error(": cannot map zs registers\n");
    326 			return;
    327 		}
    328 		zsc->zsc_bustag = oba->oba_bustag;
    329 		zsc->zsc_dmatag = oba->oba_dmatag;
    330 		/*
    331 		 * Find prom unit by physical address
    332 		 * We're just comparing the address (not the iospace) here
    333 		 */
    334 		paddr = BUS_ADDR_PADDR(paddr);
    335 		if (cpuinfo.cpu_type == CPUTYP_4_100)
    336 			/*
    337 			 * On the sun4/100, the top-most 4 bits are zero
    338 			 * on obio addresses; force them to 1's for the
    339 			 * sake of the comparison here.
    340 			 */
    341 			paddr |= 0xf0000000;
    342 		zsc->zsc_promunit =
    343 			(paddr == 0xf1000000) ? 0 :
    344 			(paddr == 0xf0000000) ? 1 :
    345 			(paddr == 0xe0000000) ? 2 : -2;
    346 
    347 		zs_attach(zsc, (void *)bh, oba->oba_pri);
    348 	}
    349 }
    350 
    351 #if defined(SUN4D)
    352 static void
    353 zs_attach_bootbus(device_t parent, device_t self, void *aux)
    354 {
    355 	struct zsc_softc *zsc = device_private(self);
    356 	struct bootbus_attach_args *baa = aux;
    357 	void *va;
    358 
    359 	zsc->zsc_dev = self;
    360 
    361 	if (baa->ba_nintr == 0) {
    362 		aprint_error(": no interrupt lines\n");
    363 		return;
    364 	}
    365 
    366 	if (baa->ba_npromvaddrs > 0)
    367 		va = (void *) baa->ba_promvaddrs;
    368 	else {
    369 		bus_space_handle_t bh;
    370 
    371 		if (bus_space_map(baa->ba_bustag,
    372 		    BUS_ADDR(baa->ba_slot, baa->ba_offset),
    373 		    baa->ba_size, BUS_SPACE_MAP_LINEAR, &bh) != 0) {
    374 			aprint_error(": cannot map zs registers\n");
    375 			return;
    376 		}
    377 		va = (void *) bh;
    378 	}
    379 
    380 	zsc->zsc_bustag = baa->ba_bustag;
    381 	zsc->zsc_promunit = prom_getpropint(baa->ba_node, "slave", -2);
    382 	zsc->zsc_node = baa->ba_node;
    383 	zs_attach(zsc, va, baa->ba_intr[0].oi_pri);
    384 }
    385 #endif /* SUN4D */
    386 
    387 /*
    388  * Attach a found zs.
    389  *
    390  * USE ROM PROPERTIES port-a-ignore-cd AND port-b-ignore-cd FOR
    391  * SOFT CARRIER, AND keyboard PROPERTY FOR KEYBOARD/MOUSE?
    392  */
    393 static void
    394 zs_attach(struct zsc_softc *zsc, struct zsdevice *zsd, int pri)
    395 {
    396 	struct zsc_attach_args zsc_args;
    397 	struct zs_chanstate *cs;
    398 	int channel;
    399 	static int didintr, prevpri;
    400 #if (NKBD > 0) || (NMS > 0)
    401 	int ch0_is_cons = 0;
    402 #endif
    403 
    404 	if (zsd == NULL) {
    405 		aprint_error(": configuration incomplete\n");
    406 		return;
    407 	}
    408 
    409 	if (!didintr) {
    410 		zs_sicookie = softint_establish(SOFTINT_SERIAL, zssoft, NULL);
    411 		if (zs_sicookie == NULL) {
    412 			aprint_error(": cannot establish soft int handler\n");
    413 			return;
    414 		}
    415 	}
    416 	aprint_normal(" softpri %d\n", IPL_SOFTSERIAL);
    417 
    418 	/*
    419 	 * Initialize software state for each channel.
    420 	 */
    421 	for (channel = 0; channel < 2; channel++) {
    422 		struct zschan *zc;
    423 		struct device *child;
    424 		int hwflags;
    425 
    426 		zsc_args.channel = channel;
    427 		cs = &zsc->zsc_cs_store[channel];
    428 		zsc->zsc_cs[channel] = cs;
    429 
    430 		zs_lock_init(cs);
    431 		cs->cs_channel = channel;
    432 		cs->cs_private = NULL;
    433 		cs->cs_ops = &zsops_null;
    434 		cs->cs_brg_clk = PCLK / 16;
    435 
    436 		zc = (channel == 0) ? &zsd->zs_chan_a : &zsd->zs_chan_b;
    437 
    438 		hwflags = zs_console_flags(zsc->zsc_promunit,
    439 						    zsc->zsc_node,
    440 						    channel);
    441 
    442 #if NWSKBD == 0
    443 		/* Not using wscons console, so always set console flags.*/
    444 		zsc_args.hwflags = hwflags;
    445 		if (zsc_args.hwflags & ZS_HWFLAG_CONSOLE) {
    446 			zsc_args.hwflags |= ZS_HWFLAG_USE_CONSDEV;
    447 			zsc_args.consdev = &zs_consdev;
    448 		}
    449 #else
    450 		/* If we are unit 1, then this is the "real" console.
    451 		 * Remember this in order to set up the keyboard and
    452 		 * mouse line disciplines for SUN4 machines below.
    453 		 * Also, don't set the console flags, otherwise we
    454 		 * tell zstty_attach() to attach as console.
    455 		 */
    456 		if (zsc->zsc_promunit == 1) {
    457 			if ((hwflags & ZS_HWFLAG_CONSOLE_INPUT) != 0 &&
    458 			    !channel) {
    459 #if (NKBD > 0) || (NMS > 0)
    460 				ch0_is_cons = 1;
    461 #endif
    462 			}
    463 		} else {
    464 			zsc_args.hwflags = hwflags;
    465 		}
    466 #endif
    467 		if ((zsc_args.hwflags & ZS_HWFLAG_CONSOLE_INPUT) != 0) {
    468 			zs_conschan_get = zc;
    469 		}
    470 		if ((zsc_args.hwflags & ZS_HWFLAG_CONSOLE_OUTPUT) != 0) {
    471 			zs_conschan_put = zc;
    472 		}
    473 		/* Childs need to set cn_dev, etc */
    474 
    475 		cs->cs_reg_csr  = &zc->zc_csr;
    476 		cs->cs_reg_data = &zc->zc_data;
    477 
    478 		memcpy(cs->cs_creg, zs_init_reg, 16);
    479 		memcpy(cs->cs_preg, zs_init_reg, 16);
    480 
    481 		/* XXX: Consult PROM properties for this?! */
    482 		cs->cs_defspeed = zs_get_speed(cs);
    483 		cs->cs_defcflag = zs_def_cflag;
    484 
    485 		/* Make these correspond to cs_defcflag (-crtscts) */
    486 		cs->cs_rr0_dcd = ZSRR0_DCD;
    487 		cs->cs_rr0_cts = 0;
    488 		cs->cs_wr5_dtr = ZSWR5_DTR | ZSWR5_RTS;
    489 		cs->cs_wr5_rts = 0;
    490 
    491 		/*
    492 		 * Clear the master interrupt enable.
    493 		 * The INTENA is common to both channels,
    494 		 * so just do it on the A channel.
    495 		 */
    496 		if (channel == 0) {
    497 			zs_write_reg(cs, 9, 0);
    498 		}
    499 
    500 		/*
    501 		 * Look for a child driver for this channel.
    502 		 * The child attach will setup the hardware.
    503 		 */
    504 
    505 		child = config_found(zsc->zsc_dev, &zsc_args, zs_print);
    506 		if (child == NULL) {
    507 			/* No sub-driver.  Just reset it. */
    508 			uint8_t reset = (channel == 0) ?
    509 				ZSWR9_A_RESET : ZSWR9_B_RESET;
    510 			zs_lock_chan(cs);
    511 			zs_write_reg(cs,  9, reset);
    512 			zs_unlock_chan(cs);
    513 		}
    514 #if (NKBD > 0) || (NMS > 0)
    515 		/*
    516 		 * If this was a zstty it has a keyboard
    517 		 * property on it we need to attach the
    518 		 * sunkbd and sunms line disciplines.
    519 		 * There are no properties on SUN4 machines.
    520 		 * For them, check if we have set the
    521 		 * ch0_is_cons variable above.
    522 		 */
    523 		if ((child != NULL) &&
    524 		    (device_is_a(child, "zstty")) && (
    525 		    (CPU_ISSUN4 && ch0_is_cons) || (!CPU_ISSUN4 &&
    526 		    (prom_getproplen(zsc->zsc_node, "keyboard") == 0))))
    527 		{
    528 			struct kbd_ms_tty_attach_args kma;
    529 			struct tty *tp = zstty_get_tty_from_dev(child);
    530 			kma.kmta_tp = tp;
    531 			kma.kmta_dev = tp->t_dev;
    532 			kma.kmta_consdev = zsc_args.consdev;
    533 
    534 			/* Attach 'em if we got 'em. */
    535 #if (NKBD > 0)
    536 			if (channel == 0) {
    537 				kma.kmta_name = "keyboard";
    538 				config_found(child, &kma, NULL);
    539 			}
    540 #endif
    541 #if (NMS > 0)
    542 			if (channel == 1) {
    543 				kma.kmta_name = "mouse";
    544 				config_found(child, &kma, NULL);
    545 			}
    546 #endif
    547 		}
    548 #endif
    549 	}
    550 
    551 	/*
    552 	 * Now safe to install interrupt handlers.  Note the arguments
    553 	 * to the interrupt handlers aren't used.  Note, we only do this
    554 	 * once since both SCCs interrupt at the same level and vector.
    555 	 */
    556 	if (!didintr) {
    557 		didintr = 1;
    558 		prevpri = pri;
    559 		bus_intr_establish(zsc->zsc_bustag, pri, IPL_SERIAL,
    560 				   zshard, NULL);
    561 	} else if (pri != prevpri)
    562 		panic("broken zs interrupt scheme");
    563 
    564 	evcnt_attach_dynamic(&zsc->zsc_intrcnt, EVCNT_TYPE_INTR, NULL,
    565 	    device_xname(zsc->zsc_dev), "intr");
    566 
    567 	/*
    568 	 * Set the master interrupt enable and interrupt vector.
    569 	 * (common to both channels, do it on A)
    570 	 */
    571 	cs = zsc->zsc_cs[0];
    572 	zs_lock_chan(cs);
    573 	/* interrupt vector */
    574 	zs_write_reg(cs, 2, zs_init_reg[2]);
    575 	/* master interrupt control (enable) */
    576 	zs_write_reg(cs, 9, zs_init_reg[9]);
    577 	zs_unlock_chan(cs);
    578 
    579 #if 0
    580 	/*
    581 	 * XXX: L1A hack - We would like to be able to break into
    582 	 * the debugger during the rest of autoconfiguration, so
    583 	 * lower interrupts just enough to let zs interrupts in.
    584 	 * This is done after both zs devices are attached.
    585 	 */
    586 	if (zsc->zsc_promunit == 1) {
    587 		aprint_debug("zs1: enabling zs interrupts\n");
    588 		(void)splfd(); /* XXX: splzs - 1 */
    589 	}
    590 #endif
    591 
    592 }
    593 
    594 static int
    595 zs_print(void *aux, const char *name)
    596 {
    597 	struct zsc_attach_args *args = aux;
    598 
    599 	if (name != NULL)
    600 		aprint_normal("%s: ", name);
    601 
    602 	if (args->channel != -1)
    603 		aprint_normal(" channel %d", args->channel);
    604 
    605 	return (UNCONF);
    606 }
    607 
    608 static volatile int zssoftpending;
    609 
    610 /*
    611  * Our ZS chips all share a common, autovectored interrupt,
    612  * so we have to look at all of them on each interrupt.
    613  */
    614 static int
    615 zshard(void *arg)
    616 {
    617 	struct zsc_softc *zsc;
    618 	int unit, rr3, rval, softreq;
    619 
    620 	rval = softreq = 0;
    621 	for (unit = 0; unit < zs_cd.cd_ndevs; unit++) {
    622 		struct zs_chanstate *cs;
    623 
    624 		zsc = device_lookup_private(&zs_cd, unit);
    625 		if (zsc == NULL)
    626 			continue;
    627 		rr3 = zsc_intr_hard(zsc);
    628 		/* Count up the interrupts. */
    629 		if (rr3) {
    630 			rval |= rr3;
    631 			zsc->zsc_intrcnt.ev_count++;
    632 		}
    633 		if ((cs = zsc->zsc_cs[0]) != NULL)
    634 			softreq |= cs->cs_softreq;
    635 		if ((cs = zsc->zsc_cs[1]) != NULL)
    636 			softreq |= cs->cs_softreq;
    637 	}
    638 
    639 	/* We are at splzs here, so no need to lock. */
    640 	if (softreq && (zssoftpending == 0)) {
    641 		zssoftpending = 1;
    642 		softint_schedule(zs_sicookie);
    643 	}
    644 	return (rval);
    645 }
    646 
    647 /*
    648  * Similar scheme as for zshard (look at all of them)
    649  */
    650 static void
    651 zssoft(void *arg)
    652 {
    653 	struct zsc_softc *zsc;
    654 	int unit;
    655 
    656 	/* This is not the only ISR on this IPL. */
    657 	if (zssoftpending == 0)
    658 		return;
    659 
    660 	/*
    661 	 * The soft intr. bit will be set by zshard only if
    662 	 * the variable zssoftpending is zero.  The order of
    663 	 * these next two statements prevents our clearing
    664 	 * the soft intr bit just after zshard has set it.
    665 	 */
    666 	/* ienab_bic(IE_ZSSOFT); */
    667 	zssoftpending = 0;
    668 
    669 #if 0 /* not yet */
    670 	/* Make sure we call the tty layer with tty_lock held. */
    671 	mutex_spin_enter(&tty_lock);
    672 #endif
    673 	for (unit = 0; unit < zs_cd.cd_ndevs; unit++) {
    674 		zsc = device_lookup_private(&zs_cd, unit);
    675 		if (zsc == NULL)
    676 			continue;
    677 		(void)zsc_intr_soft(zsc);
    678 	}
    679 #if 0 /* not yet */
    680 	mutex_spin_exit(&tty_lock);
    681 #endif
    682 }
    683 
    684 
    685 /*
    686  * Compute the current baud rate given a ZS channel.
    687  */
    688 static int
    689 zs_get_speed(struct zs_chanstate *cs)
    690 {
    691 	int tconst;
    692 
    693 	tconst = zs_read_reg(cs, 12);
    694 	tconst |= zs_read_reg(cs, 13) << 8;
    695 	return (TCONST_TO_BPS(cs->cs_brg_clk, tconst));
    696 }
    697 
    698 /*
    699  * MD functions for setting the baud rate and control modes.
    700  * bps - in bits per second
    701  */
    702 int
    703 zs_set_speed(struct zs_chanstate *cs, int bps)
    704 {
    705 	int tconst, real_bps;
    706 
    707 	if (bps == 0)
    708 		return (0);
    709 
    710 #ifdef	DIAGNOSTIC
    711 	if (cs->cs_brg_clk == 0)
    712 		panic("zs_set_speed");
    713 #endif
    714 
    715 	tconst = BPS_TO_TCONST(cs->cs_brg_clk, bps);
    716 	if (tconst < 0)
    717 		return (EINVAL);
    718 
    719 	/* Convert back to make sure we can do it. */
    720 	real_bps = TCONST_TO_BPS(cs->cs_brg_clk, tconst);
    721 
    722 	/* XXX - Allow some tolerance here? */
    723 	if (real_bps != bps)
    724 		return (EINVAL);
    725 
    726 	cs->cs_preg[12] = tconst;
    727 	cs->cs_preg[13] = tconst >> 8;
    728 
    729 	/* Caller will stuff the pending registers. */
    730 	return (0);
    731 }
    732 
    733 int
    734 zs_set_modes(struct zs_chanstate *cs, int cflag)
    735 {
    736 
    737 	/*
    738 	 * Output hardware flow control on the chip is horrendous:
    739 	 * if carrier detect drops, the receiver is disabled, and if
    740 	 * CTS drops, the transmitter is stoped IN MID CHARACTER!
    741 	 * Therefore, NEVER set the HFC bit, and instead use the
    742 	 * status interrupt to detect CTS changes.
    743 	 */
    744 	zs_lock_chan(cs);
    745 	cs->cs_rr0_pps = 0;
    746 	if ((cflag & (CLOCAL | MDMBUF)) != 0) {
    747 		cs->cs_rr0_dcd = 0;
    748 		if ((cflag & MDMBUF) == 0)
    749 			cs->cs_rr0_pps = ZSRR0_DCD;
    750 	} else
    751 		cs->cs_rr0_dcd = ZSRR0_DCD;
    752 	if ((cflag & CRTSCTS) != 0) {
    753 		cs->cs_wr5_dtr = ZSWR5_DTR;
    754 		cs->cs_wr5_rts = ZSWR5_RTS;
    755 		cs->cs_rr0_cts = ZSRR0_CTS;
    756 	} else if ((cflag & CDTRCTS) != 0) {
    757 		cs->cs_wr5_dtr = 0;
    758 		cs->cs_wr5_rts = ZSWR5_DTR;
    759 		cs->cs_rr0_cts = ZSRR0_CTS;
    760 	} else if ((cflag & MDMBUF) != 0) {
    761 		cs->cs_wr5_dtr = 0;
    762 		cs->cs_wr5_rts = ZSWR5_DTR;
    763 		cs->cs_rr0_cts = ZSRR0_DCD;
    764 	} else {
    765 		cs->cs_wr5_dtr = ZSWR5_DTR | ZSWR5_RTS;
    766 		cs->cs_wr5_rts = 0;
    767 		cs->cs_rr0_cts = 0;
    768 	}
    769 	zs_unlock_chan(cs);
    770 
    771 	/* Caller will stuff the pending registers. */
    772 	return (0);
    773 }
    774 
    775 
    776 /*
    777  * Read or write the chip with suitable delays.
    778  */
    779 
    780 uint8_t
    781 zs_read_reg(struct zs_chanstate *cs, uint8_t reg)
    782 {
    783 	uint8_t val;
    784 
    785 	*cs->cs_reg_csr = reg;
    786 	ZS_DELAY();
    787 	val = *cs->cs_reg_csr;
    788 	ZS_DELAY();
    789 	return (val);
    790 }
    791 
    792 void
    793 zs_write_reg(struct zs_chanstate *cs, uint8_t reg, uint8_t val)
    794 {
    795 
    796 	*cs->cs_reg_csr = reg;
    797 	ZS_DELAY();
    798 	*cs->cs_reg_csr = val;
    799 	ZS_DELAY();
    800 }
    801 
    802 uint8_t
    803 zs_read_csr(struct zs_chanstate *cs)
    804 {
    805 	uint8_t val;
    806 
    807 	val = *cs->cs_reg_csr;
    808 	ZS_DELAY();
    809 	return (val);
    810 }
    811 
    812 void
    813 zs_write_csr(struct zs_chanstate *cs, uint8_t val)
    814 {
    815 
    816 	*cs->cs_reg_csr = val;
    817 	ZS_DELAY();
    818 }
    819 
    820 uint8_t
    821 zs_read_data(struct zs_chanstate *cs)
    822 {
    823 	uint8_t val;
    824 
    825 	val = *cs->cs_reg_data;
    826 	ZS_DELAY();
    827 	return (val);
    828 }
    829 
    830 void
    831 zs_write_data(struct zs_chanstate *cs, uint8_t val)
    832 {
    833 
    834 	*cs->cs_reg_data = val;
    835 	ZS_DELAY();
    836 }
    837 
    838 /****************************************************************
    839  * Console support functions (Sun specific!)
    840  * Note: this code is allowed to know about the layout of
    841  * the chip registers, and uses that to keep things simple.
    842  * XXX - I think I like the mvme167 code better. -gwr
    843  ****************************************************************/
    844 
    845 /*
    846  * Handle user request to enter kernel debugger.
    847  */
    848 void
    849 zs_abort(struct zs_chanstate *cs)
    850 {
    851 	struct zschan *zc = zs_conschan_get;
    852 	int rr0;
    853 
    854 	/* Wait for end of break to avoid PROM abort. */
    855 	/* XXX - Limit the wait? */
    856 	do {
    857 		rr0 = zc->zc_csr;
    858 		ZS_DELAY();
    859 	} while (rr0 & ZSRR0_BREAK);
    860 
    861 #if defined(KGDB)
    862 	zskgdb(cs);
    863 #elif defined(DDB)
    864 	Debugger();
    865 #else
    866 	printf("stopping on keyboard abort\n");
    867 	callrom();
    868 #endif
    869 }
    870 
    871 int  zs_getc(void *);
    872 void zs_putc(void *, int);
    873 
    874 /*
    875  * Polled input char.
    876  */
    877 int
    878 zs_getc(void *arg)
    879 {
    880 	struct zschan *zc = arg;
    881 	int s, c, rr0;
    882 	u_int omid;
    883 
    884 	/* Temporarily direct interrupts at ourselves */
    885 	s = splhigh();
    886 	omid = setitr(cpuinfo.mid);
    887 
    888 	/* Wait for a character to arrive. */
    889 	do {
    890 		rr0 = zc->zc_csr;
    891 		ZS_DELAY();
    892 	} while ((rr0 & ZSRR0_RX_READY) == 0);
    893 
    894 	c = zc->zc_data;
    895 	ZS_DELAY();
    896 	setitr(omid);
    897 	splx(s);
    898 
    899 	/*
    900 	 * This is used by the kd driver to read scan codes,
    901 	 * so don't translate '\r' ==> '\n' here...
    902 	 */
    903 	return (c);
    904 }
    905 
    906 /*
    907  * Polled output char.
    908  */
    909 void
    910 zs_putc(void *arg, int c)
    911 {
    912 	struct zschan *zc = arg;
    913 	int s, rr0;
    914 	u_int omid;
    915 
    916 	/* Temporarily direct interrupts at ourselves */
    917 	s = splhigh();
    918 	omid = setitr(cpuinfo.mid);
    919 
    920 	/* Wait for transmitter to become ready. */
    921 	do {
    922 		rr0 = zc->zc_csr;
    923 		ZS_DELAY();
    924 	} while ((rr0 & ZSRR0_TX_READY) == 0);
    925 
    926 	/*
    927 	 * Send the next character.
    928 	 * Now you'd think that this could be followed by a ZS_DELAY()
    929 	 * just like all the other chip accesses, but it turns out that
    930 	 * the `transmit-ready' interrupt isn't de-asserted until
    931 	 * some period of time after the register write completes
    932 	 * (more than a couple instructions).  So to avoid stray
    933 	 * interrupts we put in the 2us delay regardless of CPU model.
    934 	 */
    935 	zc->zc_data = c;
    936 	delay(2);
    937 
    938 	setitr(omid);
    939 	splx(s);
    940 }
    941 
    942 /*****************************************************************/
    943 /*
    944  * Polled console input putchar.
    945  */
    946 static int
    947 zscngetc(dev_t dev)
    948 {
    949 
    950 	return (zs_getc(zs_conschan_get));
    951 }
    952 
    953 /*
    954  * Polled console output putchar.
    955  */
    956 static void
    957 zscnputc(dev_t dev, int c)
    958 {
    959 
    960 	zs_putc(zs_conschan_put, c);
    961 }
    962 
    963 static void
    964 zscnpollc(dev_t dev, int on)
    965 {
    966 
    967 	/* No action needed */
    968 }
    969 
    970 static int
    971 zs_console_flags(int promunit, int node, int channel)
    972 {
    973 	int cookie, flags = 0;
    974 
    975 	switch (prom_version()) {
    976 	case PROM_OLDMON:
    977 	case PROM_OBP_V0:
    978 		/*
    979 		 * Use `promunit' and `channel' to derive the PROM
    980 		 * stdio handles that correspond to this device.
    981 		 */
    982 		if (promunit == 0)
    983 			cookie = PROMDEV_TTYA + channel;
    984 		else if (promunit == 1 && channel == 0)
    985 			cookie = PROMDEV_KBD;
    986 		else
    987 			cookie = -1;
    988 
    989 		if (cookie == prom_stdin())
    990 			flags |= ZS_HWFLAG_CONSOLE_INPUT;
    991 
    992 		/*
    993 		 * Prevent the keyboard from matching the output device
    994 		 * (note that PROMDEV_KBD == PROMDEV_SCREEN == 0!).
    995 		 */
    996 		if (cookie != PROMDEV_KBD && cookie == prom_stdout())
    997 			flags |= ZS_HWFLAG_CONSOLE_OUTPUT;
    998 
    999 		break;
   1000 
   1001 	case PROM_OBP_V2:
   1002 	case PROM_OBP_V3:
   1003 	case PROM_OPENFIRM:
   1004 
   1005 		/*
   1006 		 * Match the nodes and device arguments prepared by
   1007 		 * consinit() against our device node and channel.
   1008 		 * (The device argument is the part of the OBP path
   1009 		 * following the colon, as in `/obio/zs@0,100000:a')
   1010 		 */
   1011 
   1012 		/* Default to channel 0 if there are no explicit prom args */
   1013 		cookie = 0;
   1014 
   1015 		if (node == prom_stdin_node) {
   1016 			if (prom_stdin_args[0] != '\0')
   1017 				/* Translate (a,b) -> (0,1) */
   1018 				cookie = prom_stdin_args[0] - 'a';
   1019 
   1020 			if (channel == cookie)
   1021 				flags |= ZS_HWFLAG_CONSOLE_INPUT;
   1022 		}
   1023 
   1024 		if (node == prom_stdout_node) {
   1025 			if (prom_stdout_args[0] != '\0')
   1026 				/* Translate (a,b) -> (0,1) */
   1027 				cookie = prom_stdout_args[0] - 'a';
   1028 
   1029 			if (channel == cookie)
   1030 				flags |= ZS_HWFLAG_CONSOLE_OUTPUT;
   1031 		}
   1032 
   1033 		break;
   1034 
   1035 	default:
   1036 		break;
   1037 	}
   1038 
   1039 	return (flags);
   1040 }
   1041 
   1042 /*
   1043  * Power management hooks for zsopen() and zsclose().
   1044  * We use them to power on/off the ports, if necessary.
   1045  */
   1046 int
   1047 zs_enable(struct zs_chanstate *cs)
   1048 {
   1049 
   1050 	auxiotwoserialendis (ZS_ENABLE);
   1051 	cs->enabled = 1;
   1052 	return(0);
   1053 }
   1054 
   1055 void
   1056 zs_disable(struct zs_chanstate *cs)
   1057 {
   1058 
   1059 	auxiotwoserialendis (ZS_DISABLE);
   1060 	cs->enabled = 0;
   1061 }
   1062