Home | History | Annotate | Line # | Download | only in dev
zs.c revision 1.111.6.2
      1 /*	$NetBSD: zs.c,v 1.111.6.2 2009/06/09 17:50:34 snj 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.111.6.2 2009/06/09 17:50:34 snj 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 s, channel;
    399 	static int didintr, prevpri;
    400 #if (NKBD > 0) || (NMS > 0)
    401 	int ch0_is_cons = 0;
    402 #endif
    403 
    404 	memset(&zsc_args, 0, sizeof zsc_args);
    405 	if (zsd == NULL) {
    406 		aprint_error(": configuration incomplete\n");
    407 		return;
    408 	}
    409 
    410 	if (!didintr) {
    411 		zs_sicookie = softint_establish(SOFTINT_SERIAL, zssoft, NULL);
    412 		if (zs_sicookie == NULL) {
    413 			aprint_error(": cannot establish soft int handler\n");
    414 			return;
    415 		}
    416 	}
    417 	aprint_normal(" softpri %d\n", IPL_SOFTSERIAL);
    418 
    419 	/*
    420 	 * Initialize software state for each channel.
    421 	 */
    422 	for (channel = 0; channel < 2; channel++) {
    423 		struct zschan *zc;
    424 		struct device *child;
    425 		int hwflags;
    426 
    427 		zsc_args.channel = channel;
    428 		zsc_args.hwflags = 0;
    429 		cs = &zsc->zsc_cs_store[channel];
    430 		zsc->zsc_cs[channel] = cs;
    431 
    432 		zs_lock_init(cs);
    433 		cs->cs_channel = channel;
    434 		cs->cs_private = NULL;
    435 		cs->cs_ops = &zsops_null;
    436 		cs->cs_brg_clk = PCLK / 16;
    437 
    438 		zc = (channel == 0) ? &zsd->zs_chan_a : &zsd->zs_chan_b;
    439 
    440 		hwflags = zs_console_flags(zsc->zsc_promunit,
    441 						    zsc->zsc_node,
    442 						    channel);
    443 
    444 #if NWSKBD == 0
    445 		/* Not using wscons console, so always set console flags.*/
    446 		zsc_args.hwflags = hwflags;
    447 		if (zsc_args.hwflags & ZS_HWFLAG_CONSOLE) {
    448 			zsc_args.hwflags |= ZS_HWFLAG_USE_CONSDEV;
    449 			zsc_args.consdev = &zs_consdev;
    450 		}
    451 #else
    452 		/* If we are unit 1, then this is the "real" console.
    453 		 * Remember this in order to set up the keyboard and
    454 		 * mouse line disciplines for SUN4 machines below.
    455 		 * Also, don't set the console flags, otherwise we
    456 		 * tell zstty_attach() to attach as console.
    457 		 */
    458 		if (zsc->zsc_promunit == 1) {
    459 			if ((hwflags & ZS_HWFLAG_CONSOLE_INPUT) != 0 &&
    460 			    !channel) {
    461 #if (NKBD > 0) || (NMS > 0)
    462 				ch0_is_cons = 1;
    463 #endif
    464 			}
    465 		} else {
    466 			zsc_args.hwflags = hwflags;
    467 		}
    468 #endif
    469 		if ((zsc_args.hwflags & ZS_HWFLAG_CONSOLE_INPUT) != 0) {
    470 			zs_conschan_get = zc;
    471 		}
    472 		if ((zsc_args.hwflags & ZS_HWFLAG_CONSOLE_OUTPUT) != 0) {
    473 			zs_conschan_put = zc;
    474 		}
    475 		/* Childs need to set cn_dev, etc */
    476 
    477 		cs->cs_reg_csr  = &zc->zc_csr;
    478 		cs->cs_reg_data = &zc->zc_data;
    479 
    480 		bcopy(zs_init_reg, cs->cs_creg, 16);
    481 		bcopy(zs_init_reg, cs->cs_preg, 16);
    482 
    483 		/* XXX: Consult PROM properties for this?! */
    484 		cs->cs_defspeed = zs_get_speed(cs);
    485 		cs->cs_defcflag = zs_def_cflag;
    486 
    487 		/* Make these correspond to cs_defcflag (-crtscts) */
    488 		cs->cs_rr0_dcd = ZSRR0_DCD;
    489 		cs->cs_rr0_cts = 0;
    490 		cs->cs_wr5_dtr = ZSWR5_DTR | ZSWR5_RTS;
    491 		cs->cs_wr5_rts = 0;
    492 
    493 		/*
    494 		 * Clear the master interrupt enable.
    495 		 * The INTENA is common to both channels,
    496 		 * so just do it on the A channel.
    497 		 */
    498 		if (channel == 0) {
    499 			zs_write_reg(cs, 9, 0);
    500 		}
    501 
    502 		/*
    503 		 * Look for a child driver for this channel.
    504 		 * The child attach will setup the hardware.
    505 		 */
    506 
    507 		child = config_found(zsc->zsc_dev, &zsc_args, zs_print);
    508 		if (child == NULL) {
    509 			/* No sub-driver.  Just reset it. */
    510 			uint8_t reset = (channel == 0) ?
    511 				ZSWR9_A_RESET : ZSWR9_B_RESET;
    512 			s = splzs();
    513 			zs_write_reg(cs,  9, reset);
    514 			splx(s);
    515 		}
    516 #if (NKBD > 0) || (NMS > 0)
    517 		/*
    518 		 * If this was a zstty it has a keyboard
    519 		 * property on it we need to attach the
    520 		 * sunkbd and sunms line disciplines.
    521 		 * There are no properties on SUN4 machines.
    522 		 * For them, check if we have set the
    523 		 * ch0_is_cons variable above.
    524 		 */
    525 		if ((child != NULL) &&
    526 		    (device_is_a(child, "zstty")) && (
    527 		    (CPU_ISSUN4 && ch0_is_cons) || (!CPU_ISSUN4 &&
    528 		    (prom_getproplen(zsc->zsc_node, "keyboard") == 0))))
    529 		{
    530 			struct kbd_ms_tty_attach_args kma;
    531 			struct tty *tp = zstty_get_tty_from_dev(child);
    532 			kma.kmta_tp = tp;
    533 			kma.kmta_dev = tp->t_dev;
    534 			kma.kmta_consdev = zsc_args.consdev;
    535 
    536 			/* Attach 'em if we got 'em. */
    537 #if (NKBD > 0)
    538 			if (channel == 0) {
    539 				kma.kmta_name = "keyboard";
    540 				config_found(child, &kma, NULL);
    541 			}
    542 #endif
    543 #if (NMS > 0)
    544 			if (channel == 1) {
    545 				kma.kmta_name = "mouse";
    546 				config_found(child, &kma, NULL);
    547 			}
    548 #endif
    549 		}
    550 #endif
    551 	}
    552 
    553 	/*
    554 	 * Now safe to install interrupt handlers.  Note the arguments
    555 	 * to the interrupt handlers aren't used.  Note, we only do this
    556 	 * once since both SCCs interrupt at the same level and vector.
    557 	 */
    558 	if (!didintr) {
    559 		didintr = 1;
    560 		prevpri = pri;
    561 		bus_intr_establish(zsc->zsc_bustag, pri, IPL_SERIAL,
    562 				   zshard, NULL);
    563 	} else if (pri != prevpri)
    564 		panic("broken zs interrupt scheme");
    565 
    566 	evcnt_attach_dynamic(&zsc->zsc_intrcnt, EVCNT_TYPE_INTR, NULL,
    567 	    device_xname(zsc->zsc_dev), "intr");
    568 
    569 	/*
    570 	 * Set the master interrupt enable and interrupt vector.
    571 	 * (common to both channels, do it on A)
    572 	 */
    573 	cs = zsc->zsc_cs[0];
    574 	s = splhigh();
    575 	/* interrupt vector */
    576 	zs_write_reg(cs, 2, zs_init_reg[2]);
    577 	/* master interrupt control (enable) */
    578 	zs_write_reg(cs, 9, zs_init_reg[9]);
    579 	splx(s);
    580 
    581 #if 0
    582 	/*
    583 	 * XXX: L1A hack - We would like to be able to break into
    584 	 * the debugger during the rest of autoconfiguration, so
    585 	 * lower interrupts just enough to let zs interrupts in.
    586 	 * This is done after both zs devices are attached.
    587 	 */
    588 	if (zsc->zsc_promunit == 1) {
    589 		aprint_debug("zs1: enabling zs interrupts\n");
    590 		(void)splfd(); /* XXX: splzs - 1 */
    591 	}
    592 #endif
    593 
    594 }
    595 
    596 static int
    597 zs_print(void *aux, const char *name)
    598 {
    599 	struct zsc_attach_args *args = aux;
    600 
    601 	if (name != NULL)
    602 		aprint_normal("%s: ", name);
    603 
    604 	if (args->channel != -1)
    605 		aprint_normal(" channel %d", args->channel);
    606 
    607 	return (UNCONF);
    608 }
    609 
    610 static volatile int zssoftpending;
    611 
    612 /*
    613  * Our ZS chips all share a common, autovectored interrupt,
    614  * so we have to look at all of them on each interrupt.
    615  */
    616 static int
    617 zshard(void *arg)
    618 {
    619 	struct zsc_softc *zsc;
    620 	int unit, rr3, rval, softreq;
    621 
    622 	rval = softreq = 0;
    623 	for (unit = 0; unit < zs_cd.cd_ndevs; unit++) {
    624 		struct zs_chanstate *cs;
    625 
    626 		zsc = device_lookup_private(&zs_cd, unit);
    627 		if (zsc == NULL)
    628 			continue;
    629 		rr3 = zsc_intr_hard(zsc);
    630 		/* Count up the interrupts. */
    631 		if (rr3) {
    632 			rval |= rr3;
    633 			zsc->zsc_intrcnt.ev_count++;
    634 		}
    635 		if ((cs = zsc->zsc_cs[0]) != NULL)
    636 			softreq |= cs->cs_softreq;
    637 		if ((cs = zsc->zsc_cs[1]) != NULL)
    638 			softreq |= cs->cs_softreq;
    639 	}
    640 
    641 	/* We are at splzs here, so no need to lock. */
    642 	if (softreq && (zssoftpending == 0)) {
    643 		zssoftpending = 1;
    644 		softint_schedule(zs_sicookie);
    645 	}
    646 	return (rval);
    647 }
    648 
    649 /*
    650  * Similar scheme as for zshard (look at all of them)
    651  */
    652 static void
    653 zssoft(void *arg)
    654 {
    655 	struct zsc_softc *zsc;
    656 	int s, unit;
    657 
    658 	/* This is not the only ISR on this IPL. */
    659 	if (zssoftpending == 0)
    660 		return;
    661 
    662 	/*
    663 	 * The soft intr. bit will be set by zshard only if
    664 	 * the variable zssoftpending is zero.  The order of
    665 	 * these next two statements prevents our clearing
    666 	 * the soft intr bit just after zshard has set it.
    667 	 */
    668 	/* ienab_bic(IE_ZSSOFT); */
    669 	zssoftpending = 0;
    670 
    671 	/* Make sure we call the tty layer at spltty. */
    672 	s = spltty();
    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 	splx(s);
    680 }
    681 
    682 
    683 /*
    684  * Compute the current baud rate given a ZS channel.
    685  */
    686 static int
    687 zs_get_speed(struct zs_chanstate *cs)
    688 {
    689 	int tconst;
    690 
    691 	tconst = zs_read_reg(cs, 12);
    692 	tconst |= zs_read_reg(cs, 13) << 8;
    693 	return (TCONST_TO_BPS(cs->cs_brg_clk, tconst));
    694 }
    695 
    696 /*
    697  * MD functions for setting the baud rate and control modes.
    698  * bps - in bits per second
    699  */
    700 int
    701 zs_set_speed(struct zs_chanstate *cs, int bps)
    702 {
    703 	int tconst, real_bps;
    704 
    705 	if (bps == 0)
    706 		return (0);
    707 
    708 #ifdef	DIAGNOSTIC
    709 	if (cs->cs_brg_clk == 0)
    710 		panic("zs_set_speed");
    711 #endif
    712 
    713 	tconst = BPS_TO_TCONST(cs->cs_brg_clk, bps);
    714 	if (tconst < 0)
    715 		return (EINVAL);
    716 
    717 	/* Convert back to make sure we can do it. */
    718 	real_bps = TCONST_TO_BPS(cs->cs_brg_clk, tconst);
    719 
    720 	/* XXX - Allow some tolerance here? */
    721 	if (real_bps != bps)
    722 		return (EINVAL);
    723 
    724 	cs->cs_preg[12] = tconst;
    725 	cs->cs_preg[13] = tconst >> 8;
    726 
    727 	/* Caller will stuff the pending registers. */
    728 	return (0);
    729 }
    730 
    731 int
    732 zs_set_modes(struct zs_chanstate *cs, int cflag)
    733 {
    734 	int s;
    735 
    736 	/*
    737 	 * Output hardware flow control on the chip is horrendous:
    738 	 * if carrier detect drops, the receiver is disabled, and if
    739 	 * CTS drops, the transmitter is stoped IN MID CHARACTER!
    740 	 * Therefore, NEVER set the HFC bit, and instead use the
    741 	 * status interrupt to detect CTS changes.
    742 	 */
    743 	s = splzs();
    744 	cs->cs_rr0_pps = 0;
    745 	if ((cflag & (CLOCAL | MDMBUF)) != 0) {
    746 		cs->cs_rr0_dcd = 0;
    747 		if ((cflag & MDMBUF) == 0)
    748 			cs->cs_rr0_pps = ZSRR0_DCD;
    749 	} else
    750 		cs->cs_rr0_dcd = ZSRR0_DCD;
    751 	if ((cflag & CRTSCTS) != 0) {
    752 		cs->cs_wr5_dtr = ZSWR5_DTR;
    753 		cs->cs_wr5_rts = ZSWR5_RTS;
    754 		cs->cs_rr0_cts = ZSRR0_CTS;
    755 	} else if ((cflag & CDTRCTS) != 0) {
    756 		cs->cs_wr5_dtr = 0;
    757 		cs->cs_wr5_rts = ZSWR5_DTR;
    758 		cs->cs_rr0_cts = ZSRR0_CTS;
    759 	} else if ((cflag & MDMBUF) != 0) {
    760 		cs->cs_wr5_dtr = 0;
    761 		cs->cs_wr5_rts = ZSWR5_DTR;
    762 		cs->cs_rr0_cts = ZSRR0_DCD;
    763 	} else {
    764 		cs->cs_wr5_dtr = ZSWR5_DTR | ZSWR5_RTS;
    765 		cs->cs_wr5_rts = 0;
    766 		cs->cs_rr0_cts = 0;
    767 	}
    768 	splx(s);
    769 
    770 	/* Caller will stuff the pending registers. */
    771 	return (0);
    772 }
    773 
    774 
    775 /*
    776  * Read or write the chip with suitable delays.
    777  */
    778 
    779 uint8_t
    780 zs_read_reg(struct zs_chanstate *cs, uint8_t reg)
    781 {
    782 	uint8_t val;
    783 
    784 	*cs->cs_reg_csr = reg;
    785 	ZS_DELAY();
    786 	val = *cs->cs_reg_csr;
    787 	ZS_DELAY();
    788 	return (val);
    789 }
    790 
    791 void
    792 zs_write_reg(struct zs_chanstate *cs, uint8_t reg, uint8_t val)
    793 {
    794 
    795 	*cs->cs_reg_csr = reg;
    796 	ZS_DELAY();
    797 	*cs->cs_reg_csr = val;
    798 	ZS_DELAY();
    799 }
    800 
    801 uint8_t
    802 zs_read_csr(struct zs_chanstate *cs)
    803 {
    804 	uint8_t val;
    805 
    806 	val = *cs->cs_reg_csr;
    807 	ZS_DELAY();
    808 	return (val);
    809 }
    810 
    811 void
    812 zs_write_csr(struct zs_chanstate *cs, uint8_t val)
    813 {
    814 
    815 	*cs->cs_reg_csr = val;
    816 	ZS_DELAY();
    817 }
    818 
    819 uint8_t
    820 zs_read_data(struct zs_chanstate *cs)
    821 {
    822 	uint8_t val;
    823 
    824 	val = *cs->cs_reg_data;
    825 	ZS_DELAY();
    826 	return (val);
    827 }
    828 
    829 void
    830 zs_write_data(struct zs_chanstate *cs, uint8_t val)
    831 {
    832 
    833 	*cs->cs_reg_data = val;
    834 	ZS_DELAY();
    835 }
    836 
    837 /****************************************************************
    838  * Console support functions (Sun specific!)
    839  * Note: this code is allowed to know about the layout of
    840  * the chip registers, and uses that to keep things simple.
    841  * XXX - I think I like the mvme167 code better. -gwr
    842  ****************************************************************/
    843 
    844 /*
    845  * Handle user request to enter kernel debugger.
    846  */
    847 void
    848 zs_abort(struct zs_chanstate *cs)
    849 {
    850 	struct zschan *zc = zs_conschan_get;
    851 	int rr0;
    852 
    853 	/* Wait for end of break to avoid PROM abort. */
    854 	/* XXX - Limit the wait? */
    855 	do {
    856 		rr0 = zc->zc_csr;
    857 		ZS_DELAY();
    858 	} while (rr0 & ZSRR0_BREAK);
    859 
    860 #if defined(KGDB)
    861 	zskgdb(cs);
    862 #elif defined(DDB)
    863 	Debugger();
    864 #else
    865 	printf("stopping on keyboard abort\n");
    866 	callrom();
    867 #endif
    868 }
    869 
    870 int  zs_getc(void *);
    871 void zs_putc(void *, int);
    872 
    873 /*
    874  * Polled input char.
    875  */
    876 int
    877 zs_getc(void *arg)
    878 {
    879 	struct zschan *zc = arg;
    880 	int s, c, rr0;
    881 	u_int omid;
    882 
    883 	/* Temporarily direct interrupts at ourselves */
    884 	s = splhigh();
    885 	omid = setitr(cpuinfo.mid);
    886 
    887 	/* Wait for a character to arrive. */
    888 	do {
    889 		rr0 = zc->zc_csr;
    890 		ZS_DELAY();
    891 	} while ((rr0 & ZSRR0_RX_READY) == 0);
    892 
    893 	c = zc->zc_data;
    894 	ZS_DELAY();
    895 	setitr(omid);
    896 	splx(s);
    897 
    898 	/*
    899 	 * This is used by the kd driver to read scan codes,
    900 	 * so don't translate '\r' ==> '\n' here...
    901 	 */
    902 	return (c);
    903 }
    904 
    905 /*
    906  * Polled output char.
    907  */
    908 void
    909 zs_putc(void *arg, int c)
    910 {
    911 	struct zschan *zc = arg;
    912 	int s, rr0;
    913 	u_int omid;
    914 
    915 	/* Temporarily direct interrupts at ourselves */
    916 	s = splhigh();
    917 	omid = setitr(cpuinfo.mid);
    918 
    919 	/* Wait for transmitter to become ready. */
    920 	do {
    921 		rr0 = zc->zc_csr;
    922 		ZS_DELAY();
    923 	} while ((rr0 & ZSRR0_TX_READY) == 0);
    924 
    925 	/*
    926 	 * Send the next character.
    927 	 * Now you'd think that this could be followed by a ZS_DELAY()
    928 	 * just like all the other chip accesses, but it turns out that
    929 	 * the `transmit-ready' interrupt isn't de-asserted until
    930 	 * some period of time after the register write completes
    931 	 * (more than a couple instructions).  So to avoid stray
    932 	 * interrupts we put in the 2us delay regardless of CPU model.
    933 	 */
    934 	zc->zc_data = c;
    935 	delay(2);
    936 
    937 	setitr(omid);
    938 	splx(s);
    939 }
    940 
    941 /*****************************************************************/
    942 /*
    943  * Polled console input putchar.
    944  */
    945 static int
    946 zscngetc(dev_t dev)
    947 {
    948 
    949 	return (zs_getc(zs_conschan_get));
    950 }
    951 
    952 /*
    953  * Polled console output putchar.
    954  */
    955 static void
    956 zscnputc(dev_t dev, int c)
    957 {
    958 
    959 	zs_putc(zs_conschan_put, c);
    960 }
    961 
    962 static void
    963 zscnpollc(dev_t dev, int on)
    964 {
    965 
    966 	/* No action needed */
    967 }
    968 
    969 static int
    970 zs_console_flags(int promunit, int node, int channel)
    971 {
    972 	int cookie, flags = 0;
    973 
    974 	switch (prom_version()) {
    975 	case PROM_OLDMON:
    976 	case PROM_OBP_V0:
    977 		/*
    978 		 * Use `promunit' and `channel' to derive the PROM
    979 		 * stdio handles that correspond to this device.
    980 		 */
    981 		if (promunit == 0)
    982 			cookie = PROMDEV_TTYA + channel;
    983 		else if (promunit == 1 && channel == 0)
    984 			cookie = PROMDEV_KBD;
    985 		else
    986 			cookie = -1;
    987 
    988 		if (cookie == prom_stdin())
    989 			flags |= ZS_HWFLAG_CONSOLE_INPUT;
    990 
    991 		/*
    992 		 * Prevent the keyboard from matching the output device
    993 		 * (note that PROMDEV_KBD == PROMDEV_SCREEN == 0!).
    994 		 */
    995 		if (cookie != PROMDEV_KBD && cookie == prom_stdout())
    996 			flags |= ZS_HWFLAG_CONSOLE_OUTPUT;
    997 
    998 		break;
    999 
   1000 	case PROM_OBP_V2:
   1001 	case PROM_OBP_V3:
   1002 	case PROM_OPENFIRM:
   1003 
   1004 		/*
   1005 		 * Match the nodes and device arguments prepared by
   1006 		 * consinit() against our device node and channel.
   1007 		 * (The device argument is the part of the OBP path
   1008 		 * following the colon, as in `/obio/zs@0,100000:a')
   1009 		 */
   1010 
   1011 		/* Default to channel 0 if there are no explicit prom args */
   1012 		cookie = 0;
   1013 
   1014 		if (node == prom_stdin_node) {
   1015 			if (prom_stdin_args[0] != '\0')
   1016 				/* Translate (a,b) -> (0,1) */
   1017 				cookie = prom_stdin_args[0] - 'a';
   1018 
   1019 			if (channel == cookie)
   1020 				flags |= ZS_HWFLAG_CONSOLE_INPUT;
   1021 		}
   1022 
   1023 		if (node == prom_stdout_node) {
   1024 			if (prom_stdout_args[0] != '\0')
   1025 				/* Translate (a,b) -> (0,1) */
   1026 				cookie = prom_stdout_args[0] - 'a';
   1027 
   1028 			if (channel == cookie)
   1029 				flags |= ZS_HWFLAG_CONSOLE_OUTPUT;
   1030 		}
   1031 
   1032 		break;
   1033 
   1034 	default:
   1035 		break;
   1036 	}
   1037 
   1038 	return (flags);
   1039 }
   1040 
   1041 /*
   1042  * Power management hooks for zsopen() and zsclose().
   1043  * We use them to power on/off the ports, if necessary.
   1044  */
   1045 int
   1046 zs_enable(struct zs_chanstate *cs)
   1047 {
   1048 
   1049 	auxiotwoserialendis (ZS_ENABLE);
   1050 	cs->enabled = 1;
   1051 	return(0);
   1052 }
   1053 
   1054 void
   1055 zs_disable(struct zs_chanstate *cs)
   1056 {
   1057 
   1058 	auxiotwoserialendis (ZS_DISABLE);
   1059 	cs->enabled = 0;
   1060 }
   1061