Home | History | Annotate | Line # | Download | only in dev
zs_hb.c revision 1.9
      1 /*	$NetBSD: zs_hb.c,v 1.9 2003/02/10 11:38:31 tsutsui 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  * 3. All advertising materials mentioning features or use of this software
     19  *    must display the following acknowledgement:
     20  *        This product includes software developed by the NetBSD
     21  *        Foundation, Inc. and its contributors.
     22  * 4. Neither the name of The NetBSD Foundation nor the names of its
     23  *    contributors may be used to endorse or promote products derived
     24  *    from this software without specific prior written permission.
     25  *
     26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     36  * POSSIBILITY OF SUCH DAMAGE.
     37  */
     38 
     39 /*
     40  * Zilog Z8530 Dual UART driver (machine-dependent part)
     41  *
     42  * Runs two serial lines per chip using slave drivers.
     43  * Plain tty/async lines use the zs_async slave.
     44  * Sun keyboard/mouse uses the zs_kbd/zs_ms slaves.
     45  */
     46 
     47 #include <sys/param.h>
     48 #include <sys/systm.h>
     49 #include <sys/device.h>
     50 #include <sys/tty.h>
     51 #include <sys/conf.h>
     52 #include <sys/lock.h>
     53 
     54 #include <machine/adrsmap.h>
     55 #include <machine/autoconf.h>
     56 #include <machine/cpu.h>
     57 #include <machine/z8530var.h>
     58 
     59 #include <dev/cons.h>
     60 #include <dev/ic/z8530reg.h>
     61 
     62 #include "zsc.h"	/* NZSC */
     63 #define NZS NZSC
     64 
     65 /* Make life easier for the initialized arrays here. */
     66 #if NZS < 2
     67 #undef  NZS
     68 #define NZS 2
     69 #endif
     70 
     71 #define ZSCFLAG_EX	0x01	/* expansion board */
     72 
     73 /*
     74  * The news3400 provides a 4.9152 MHz clock to the ZS chips.
     75  */
     76 #define PCLK	(9600 * 512)	/* PCLK pin input clock rate */
     77 #define PCLK_EX	(9600 * 384)
     78 
     79 /*
     80  * Define interrupt levels.
     81  */
     82 #define ZSHARD_PRI 64
     83 
     84 #define ZS_DELAY() {(void)*(volatile char *)INTEN1; delay(2);}
     85 
     86 /* The layout of this is hardware-dependent (padding, order). */
     87 struct zschan {
     88 	volatile u_char	zc_csr;		/* ctrl,status, and indirect access */
     89 	volatile u_char	zc_data;	/* data */
     90 };
     91 struct zsdevice {
     92 	/* Yes, they are backwards. */
     93 	struct	zschan zs_chan_b;
     94 	struct	zschan zs_chan_a;
     95 };
     96 
     97 extern int zs_def_cflag;
     98 extern void (*zs_delay) __P((void));
     99 
    100 static struct zsdevice *zsaddr[NZS];
    101 
    102 /* Flags from cninit() */
    103 static int zs_hwflags[NZS][2];
    104 
    105 /* Default speed for all channels */
    106 static int zs_defspeed = 9600;
    107 
    108 static u_char zs_init_reg[16] = {
    109 	0,	/* 0: CMD (reset, etc.) */
    110 	0,	/* 1: No interrupts yet. */
    111 	ZSHARD_PRI,	/* IVECT */
    112 	ZSWR3_RX_8 | ZSWR3_RX_ENABLE,
    113 	ZSWR4_CLK_X16 | ZSWR4_ONESB | ZSWR4_EVENP,
    114 	ZSWR5_TX_8 | ZSWR5_TX_ENABLE,
    115 	0,	/* 6: TXSYNC/SYNCLO */
    116 	0,	/* 7: RXSYNC/SYNCHI */
    117 	0,	/* 8: alias for data port */
    118 	ZSWR9_MASTER_IE,
    119 	0,	/*10: Misc. TX/RX control bits */
    120 	ZSWR11_TXCLK_BAUD | ZSWR11_RXCLK_BAUD,
    121 	((PCLK/32)/9600)-2,	/*12: BAUDLO (default=9600) */
    122 	0,			/*13: BAUDHI (default=9600) */
    123 	ZSWR14_BAUD_ENA | ZSWR14_BAUD_FROM_PCLK,
    124 	ZSWR15_BREAK_IE,
    125 };
    126 
    127 static struct zschan * zs_get_chan_addr __P((int, int));
    128 static void zs_hb_delay __P((void));
    129 static int zshard_hb __P((void *));
    130 static int zs_getc __P((void *));
    131 static void zs_putc __P((void *, int));
    132 int zshard __P((void *));
    133 int zs_get_speed __P((struct zs_chanstate *));
    134 
    135 struct zschan *
    136 zs_get_chan_addr(zs_unit, channel)
    137 	int zs_unit, channel;
    138 {
    139 	struct zsdevice *addr;
    140 	struct zschan *zc;
    141 
    142 	if (zs_unit >= NZS)
    143 		return NULL;
    144 	addr = zsaddr[zs_unit];
    145 	if (addr == NULL)
    146 		return NULL;
    147 	if (channel == 0) {
    148 		zc = &addr->zs_chan_a;
    149 	} else {
    150 		zc = &addr->zs_chan_b;
    151 	}
    152 	return (zc);
    153 }
    154 
    155 void
    156 zs_hb_delay()
    157 {
    158 	ZS_DELAY();
    159 }
    160 
    161 /****************************************************************
    162  * Autoconfig
    163  ****************************************************************/
    164 
    165 /* Definition of the driver for autoconfig. */
    166 int zs_hb_match __P((struct device *, struct cfdata *, void *));
    167 void zs_hb_attach __P((struct device *, struct device *, void *));
    168 int zs_print __P((void *, const char *name));
    169 
    170 CFATTACH_DECL(zsc_hb, sizeof(struct zsc_softc),
    171     zs_hb_match, zs_hb_attach, NULL, NULL);
    172 
    173 /*
    174  * Is the zs chip present?
    175  */
    176 int
    177 zs_hb_match(parent, cf, aux)
    178 	struct device *parent;
    179 	struct cfdata *cf;
    180 	void *aux;
    181 {
    182 	struct confargs *ca = aux;
    183 
    184 	if (strcmp(ca->ca_name, "zsc"))
    185 		return 0;
    186 
    187 	/* This returns -1 on a fault (bus error). */
    188 	if (badaddr((char *)cf->cf_addr, 1))
    189 		return 0;
    190 
    191 	return 1;
    192 }
    193 
    194 /*
    195  * Attach a found zs.
    196  *
    197  * Match slave number to zs unit number, so that misconfiguration will
    198  * not set up the keyboard as ttya, etc.
    199  */
    200 void
    201 zs_hb_attach(parent, self, aux)
    202 	struct device *parent;
    203 	struct device *self;
    204 	void *aux;
    205 {
    206 	struct zsc_softc *zsc = (void *)self;
    207 	/* struct confargs *ca = aux; */
    208 	struct zsc_attach_args zsc_args;
    209 	volatile struct zschan *zc;
    210 	struct zs_chanstate *cs;
    211 	int s, zs_unit, channel, intlevel;
    212 	static int didintr;
    213 
    214 	zs_unit = zsc->zsc_dev.dv_unit;
    215 	intlevel = zsc->zsc_dev.dv_cfdata->cf_level;
    216 	zsaddr[zs_unit] = (void *)zsc->zsc_dev.dv_cfdata->cf_addr;
    217 
    218 	if (intlevel == -1) {
    219 #if 0
    220 		printf(": interrupt level not configured\n");
    221 		return;
    222 #else
    223 		printf(": interrupt level not configured; using");
    224 		intlevel = 1;
    225 #endif
    226 	}
    227 
    228 	printf(" level %d\n", intlevel);
    229 
    230 	zs_delay = zs_hb_delay;
    231 
    232 	/*
    233 	 * Initialize software state for each channel.
    234 	 */
    235 	for (channel = 0; channel < 2; channel++) {
    236 		zsc_args.channel = channel;
    237 		zsc_args.hwflags = zs_hwflags[zs_unit][channel];
    238 		cs = &zsc->zsc_cs_store[channel];
    239 		zsc->zsc_cs[channel] = cs;
    240 
    241 		simple_lock_init(&cs->cs_lock);
    242 		cs->cs_channel = channel;
    243 		cs->cs_private = NULL;
    244 		cs->cs_ops = &zsops_null;
    245 		if ((zsc->zsc_dev.dv_cfdata->cf_flags & ZSCFLAG_EX) == 0)
    246 			cs->cs_brg_clk = PCLK / 16;
    247 		else
    248 			cs->cs_brg_clk = PCLK_EX / 16;
    249 
    250 		zc = zs_get_chan_addr(zs_unit, channel);
    251 		cs->cs_reg_csr  = &zc->zc_csr;
    252 		cs->cs_reg_data = &zc->zc_data;
    253 
    254 		bcopy(zs_init_reg, cs->cs_creg, 16);
    255 		bcopy(zs_init_reg, cs->cs_preg, 16);
    256 
    257 		/* XXX: Get these from the EEPROM instead? */
    258 		/* XXX: See the mvme167 code.  Better. */
    259 		if (zsc_args.hwflags & ZS_HWFLAG_CONSOLE)
    260 			cs->cs_defspeed = zs_get_speed(cs);
    261 		else
    262 			cs->cs_defspeed = zs_defspeed;
    263 		cs->cs_defcflag = zs_def_cflag;
    264 
    265 		/* Make these correspond to cs_defcflag (-crtscts) */
    266 		cs->cs_rr0_dcd = ZSRR0_DCD;
    267 		cs->cs_rr0_cts = 0;
    268 		cs->cs_wr5_dtr = ZSWR5_DTR | ZSWR5_RTS;
    269 		cs->cs_wr5_rts = 0;
    270 
    271 		/*
    272 		 * Clear the master interrupt enable.
    273 		 * The INTENA is common to both channels,
    274 		 * so just do it on the A channel.
    275 		 */
    276 		if (channel == 0) {
    277 			zs_write_reg(cs, 9, 0);
    278 		}
    279 
    280 		/*
    281 		 * Look for a child driver for this channel.
    282 		 * The child attach will setup the hardware.
    283 		 */
    284 		if (!config_found(self, (void *)&zsc_args, zs_print)) {
    285 			/* No sub-driver.  Just reset it. */
    286 			u_char reset = (channel == 0) ?
    287 				ZSWR9_A_RESET : ZSWR9_B_RESET;
    288 			s = splhigh();
    289 			zs_write_reg(cs, 9, reset);
    290 			splx(s);
    291 		}
    292 	}
    293 
    294 	/*
    295 	 * Now safe to install interrupt handlers.  Note the arguments
    296 	 * to the interrupt handlers aren't used.  Note, we only do this
    297 	 * once since both SCCs interrupt at the same level and vector.
    298 	 */
    299 	if (!didintr) {
    300 		didintr = 1;
    301 
    302 		hb_intr_establish(intlevel, IPL_SERIAL, zshard_hb, NULL);
    303 	}
    304 	/* XXX; evcnt_attach() ? */
    305 
    306 	/*
    307 	 * Set the master interrupt enable and interrupt vector.
    308 	 * (common to both channels, do it on A)
    309 	 */
    310 	cs = zsc->zsc_cs[0];
    311 	s = splhigh();
    312 	/* interrupt vector */
    313 	zs_write_reg(cs, 2, zs_init_reg[2]);
    314 	/* master interrupt control (enable) */
    315 	zs_write_reg(cs, 9, zs_init_reg[9]);
    316 	splx(s);
    317 }
    318 
    319 /*
    320  * Our ZS chips all share a common, autovectored interrupt,
    321  * so we have to look at all of them on each interrupt.
    322  */
    323 static int
    324 zshard_hb(arg)
    325 	void *arg;
    326 {
    327 	(void) *(volatile u_char *)SCCVECT;
    328 
    329 	return zshard(arg);
    330 }
    331 
    332 /*
    333  * Polled input char.
    334  */
    335 int
    336 zs_getc(arg)
    337 	void *arg;
    338 {
    339 	register volatile struct zschan *zc = arg;
    340 	register int s, c, rr0;
    341 
    342 	s = splhigh();
    343 	/* Wait for a character to arrive. */
    344 	do {
    345 		rr0 = zc->zc_csr;
    346 		ZS_DELAY();
    347 	} while ((rr0 & ZSRR0_RX_READY) == 0);
    348 
    349 	c = zc->zc_data;
    350 	ZS_DELAY();
    351 	splx(s);
    352 
    353 	/*
    354 	 * This is used by the kd driver to read scan codes,
    355 	 * so don't translate '\r' ==> '\n' here...
    356 	 */
    357 	return (c);
    358 }
    359 
    360 /*
    361  * Polled output char.
    362  */
    363 void
    364 zs_putc(arg, c)
    365 	void *arg;
    366 	int c;
    367 {
    368 	register volatile struct zschan *zc = arg;
    369 	register int s, rr0;
    370 
    371 	s = splhigh();
    372 	/* Wait for transmitter to become ready. */
    373 	do {
    374 		rr0 = zc->zc_csr;
    375 		ZS_DELAY();
    376 	} while ((rr0 & ZSRR0_TX_READY) == 0);
    377 
    378 	zc->zc_data = c;
    379 	ZS_DELAY();
    380 	splx(s);
    381 }
    382 
    383 /*****************************************************************/
    384 
    385 static void zscnprobe __P((struct consdev *));
    386 static void zscninit __P((struct consdev *));
    387 static int  zscngetc __P((dev_t));
    388 static void zscnputc __P((dev_t, int));
    389 static void zscnpollc __P((dev_t, int));
    390 
    391 struct consdev consdev_zs = {
    392 	zscnprobe,
    393 	zscninit,
    394 	zscngetc,
    395 	zscnputc,
    396 	zscnpollc,
    397 	NULL,
    398 };
    399 
    400 void
    401 zscnprobe(cn)
    402 	struct consdev *cn;
    403 {
    404 }
    405 
    406 void
    407 zscninit(cn)
    408 	struct consdev *cn;
    409 {
    410 	extern const struct cdevsw zstty_cdevsw;
    411 
    412 	cn->cn_dev = makedev(cdevsw_lookup_major(&zstty_cdevsw), 0);
    413 	cn->cn_pri = CN_REMOTE;
    414 	zs_hwflags[0][0] = ZS_HWFLAG_CONSOLE;
    415 }
    416 
    417 int
    418 zscngetc(dev)
    419 	dev_t dev;
    420 {
    421 	return zs_getc((void *)SCCPORT0A);
    422 }
    423 
    424 void
    425 zscnputc(dev, c)
    426 	dev_t dev;
    427 	int c;
    428 {
    429 	zs_putc((void *)SCCPORT0A, c);
    430 }
    431 
    432 void
    433 zscnpollc(dev, on)
    434 	dev_t dev;
    435 	int on;
    436 {
    437 }
    438