Home | History | Annotate | Line # | Download | only in apbus
zs_ap.c revision 1.23
      1 /*	$NetBSD: zs_ap.c,v 1.23 2007/11/26 23:29:36 ad 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/cdefs.h>
     48 __KERNEL_RCSID(0, "$NetBSD: zs_ap.c,v 1.23 2007/11/26 23:29:36 ad Exp $");
     49 
     50 #include <sys/param.h>
     51 #include <sys/systm.h>
     52 #include <sys/device.h>
     53 #include <sys/tty.h>
     54 #include <sys/conf.h>
     55 #include <sys/cpu.h>
     56 #include <sys/intr.h>
     57 
     58 #include <machine/adrsmap.h>
     59 #include <machine/z8530var.h>
     60 
     61 #include <dev/cons.h>
     62 #include <dev/ic/z8530reg.h>
     63 
     64 #include <newsmips/apbus/apbusvar.h>
     65 
     66 #include "zsc.h"	/* NZSC */
     67 #define NZS NZSC
     68 
     69 /* Make life easier for the initialized arrays here. */
     70 #if NZS < 2
     71 #undef  NZS
     72 #define NZS 2
     73 #endif
     74 
     75 #define PORTB_XPORT	0x00000000
     76 #define PORTB_RPORT	0x00010000
     77 #define PORTA_XPORT	0x00020000
     78 #define PORTA_RPORT	0x00030000
     79 #define   DMA_MODE_REG		3
     80 #define     DMA_ENABLE		0x01	/* DMA enable */
     81 #define     DMA_DIR_DM		0x00	/* device to memory */
     82 #define     DMA_DIR_MD		0x02	/* memory to device */
     83 #define     DMA_EXTRDY		0x08	/* DMA external ready */
     84 #define PORTB_OFFSET	0x00040000
     85 #define PORTA_OFFSET	0x00050000
     86 #define   PORT_CTL		2
     87 #define     PORTCTL_RI		0x01
     88 #define     PORTCTL_DSR		0x02
     89 #define     PORTCTL_DTR		0x04
     90 #define   PORT_SEL		3
     91 #define     PORTSEL_LOCALTALK	0x01
     92 #define     PORTSEL_RS232C	0x02
     93 #define ESCC_REG	0x00060000
     94 #define   ESCCREG_INTSTAT	0
     95 #define     INTSTAT_SCC		0x01
     96 #define   ESCCREG_INTMASK	1
     97 #define     INTMASK_SCC		0x01
     98 
     99 extern int zs_def_cflag;
    100 extern void (*zs_delay)(void);
    101 
    102 /*
    103  * The news5000 provides a 9.8304 MHz clock to the ZS chips.
    104  */
    105 #define PCLK	(9600 * 1024)	/* PCLK pin input clock rate */
    106 
    107 #define ZS_DELAY()	DELAY(2)
    108 
    109 /* The layout of this is hardware-dependent (padding, order). */
    110 struct zschan {
    111 	volatile u_char pad1[3];
    112 	volatile u_char zc_csr;		/* ctrl,status, and indirect access */
    113 	volatile u_char pad2[3];
    114 	volatile u_char zc_data;	/* data */
    115 };
    116 
    117 static void *zsaddr[NZS];
    118 
    119 /* Flags from cninit() */
    120 static int zs_hwflags[NZS][2];
    121 
    122 /* Default speed for all channels */
    123 static int zs_defspeed = 9600;
    124 
    125 static u_char zs_init_reg[16] = {
    126 	0,	/* 0: CMD (reset, etc.) */
    127 	0,	/* 1: No interrupts yet. */
    128 	0,	/* IVECT */
    129 	ZSWR3_RX_8 | ZSWR3_RX_ENABLE,
    130 	ZSWR4_CLK_X16 | ZSWR4_ONESB | ZSWR4_EVENP,
    131 	ZSWR5_TX_8 | ZSWR5_TX_ENABLE,
    132 	0,	/* 6: TXSYNC/SYNCLO */
    133 	0,	/* 7: RXSYNC/SYNCHI */
    134 	0,	/* 8: alias for data port */
    135 	ZSWR9_MASTER_IE,
    136 	0,	/*10: Misc. TX/RX control bits */
    137 	ZSWR11_TXCLK_BAUD | ZSWR11_RXCLK_BAUD,
    138 	((PCLK/32)/9600)-2,	/*12: BAUDLO (default=9600) */
    139 	0,			/*13: BAUDHI (default=9600) */
    140 	ZSWR14_BAUD_ENA | ZSWR14_BAUD_FROM_PCLK,
    141 	ZSWR15_BREAK_IE,
    142 };
    143 
    144 static struct zschan * zs_get_chan_addr(int, int);
    145 static void zs_ap_delay(void);
    146 static int zshard_ap(void *);
    147 static int zs_getc(void *);
    148 static void zs_putc(void *, int);
    149 
    150 struct zschan *
    151 zs_get_chan_addr(int zs_unit, int channel)
    152 {
    153 	void *addr;
    154 	struct zschan *zc;
    155 
    156 	if (zs_unit >= NZS)
    157 		return NULL;
    158 	addr = zsaddr[zs_unit];
    159 	if (addr == NULL)
    160 		return NULL;
    161 	if (channel == 0) {
    162 		zc = (void *)((char *)addr + PORTA_OFFSET);
    163 	} else {
    164 		zc = (void *)((char *)addr + PORTB_OFFSET);
    165 	}
    166 	return zc;
    167 }
    168 
    169 void
    170 zs_ap_delay(void)
    171 {
    172 
    173 	ZS_DELAY();
    174 }
    175 
    176 /****************************************************************
    177  * Autoconfig
    178  ****************************************************************/
    179 
    180 /* Definition of the driver for autoconfig. */
    181 int zs_ap_match(struct device *, struct cfdata *, void *);
    182 void zs_ap_attach(struct device *, struct device *, void *);
    183 
    184 CFATTACH_DECL(zsc_ap, sizeof(struct zsc_softc),
    185     zs_ap_match, zs_ap_attach, NULL, NULL);
    186 
    187 /*
    188  * Is the zs chip present?
    189  */
    190 int
    191 zs_ap_match(struct device *parent, struct cfdata *cf, void *aux)
    192 {
    193 	struct apbus_attach_args *apa = aux;
    194 
    195 	if (strcmp("esccf", apa->apa_name) != 0)
    196 		return 0;
    197 
    198 	return 1;
    199 }
    200 
    201 /*
    202  * Attach a found zs.
    203  *
    204  * Match slave number to zs unit number, so that misconfiguration will
    205  * not set up the keyboard as ttya, etc.
    206  */
    207 void
    208 zs_ap_attach(struct device *parent, struct device *self, void *aux)
    209 {
    210 	struct zsc_softc *zsc = (void *)self;
    211 	struct apbus_attach_args *apa = aux;
    212 	struct zsc_attach_args zsc_args;
    213 	volatile struct zschan *zc;
    214 	struct zs_chanstate *cs;
    215 	int s, zs_unit, channel;
    216 	volatile u_int *txBfifo = (void *)(apa->apa_hwbase + PORTB_XPORT);
    217 	volatile u_int *rxBfifo = (void *)(apa->apa_hwbase + PORTB_RPORT);
    218 	volatile u_int *txAfifo = (void *)(apa->apa_hwbase + PORTA_XPORT);
    219 	volatile u_int *rxAfifo = (void *)(apa->apa_hwbase + PORTA_RPORT);
    220 	volatile u_int *portBctl = (void *)(apa->apa_hwbase + PORTB_OFFSET);
    221 	volatile u_int *portActl = (void *)(apa->apa_hwbase + PORTA_OFFSET);
    222 	volatile u_int *esccregs = (void *)(apa->apa_hwbase + ESCC_REG);
    223 	static int didintr;
    224 
    225 	zs_unit = device_unit(&zsc->zsc_dev);
    226 	zsaddr[zs_unit] = (void *)apa->apa_hwbase;
    227 
    228 	printf(" slot%d addr 0x%lx\n", apa->apa_slotno, apa->apa_hwbase);
    229 
    230 	txAfifo[DMA_MODE_REG] = rxAfifo[DMA_MODE_REG] = DMA_EXTRDY;
    231 	txBfifo[DMA_MODE_REG] = rxBfifo[DMA_MODE_REG] = DMA_EXTRDY;
    232 
    233 	/* assert DTR */			/* XXX */
    234 	portBctl[PORT_CTL] = portActl[PORT_CTL] = PORTCTL_DTR;
    235 
    236 	/* select RS-232C (ch1 only) */
    237 	portActl[PORT_SEL] = PORTSEL_RS232C;
    238 
    239 	/* enable SCC interrupts */
    240 	esccregs[ESCCREG_INTMASK] = INTMASK_SCC;
    241 
    242 	zs_delay = zs_ap_delay;
    243 
    244 	/*
    245 	 * Initialize software state for each channel.
    246 	 */
    247 	for (channel = 0; channel < 2; channel++) {
    248 		zsc_args.channel = channel;
    249 		zsc_args.hwflags = zs_hwflags[zs_unit][channel];
    250 		cs = &zsc->zsc_cs_store[channel];
    251 		zsc->zsc_cs[channel] = cs;
    252 
    253 		zs_lock_init(cs);
    254 		cs->cs_channel = channel;
    255 		cs->cs_private = NULL;
    256 		cs->cs_ops = &zsops_null;
    257 		cs->cs_brg_clk = PCLK / 16;
    258 
    259 		zc = zs_get_chan_addr(zs_unit, channel);
    260 		cs->cs_reg_csr  = &zc->zc_csr;
    261 		cs->cs_reg_data = &zc->zc_data;
    262 
    263 		memcpy(cs->cs_creg, zs_init_reg, 16);
    264 		memcpy(cs->cs_preg, zs_init_reg, 16);
    265 
    266 		/* XXX: Get these from the EEPROM instead? */
    267 		/* XXX: See the mvme167 code.  Better. */
    268 		if (zsc_args.hwflags & ZS_HWFLAG_CONSOLE)
    269 			cs->cs_defspeed = zs_get_speed(cs);
    270 		else
    271 			cs->cs_defspeed = zs_defspeed;
    272 		cs->cs_defcflag = zs_def_cflag;
    273 
    274 		/* Make these correspond to cs_defcflag (-crtscts) */
    275 		cs->cs_rr0_dcd = ZSRR0_DCD;
    276 		cs->cs_rr0_cts = 0;
    277 		cs->cs_wr5_dtr = ZSWR5_DTR | ZSWR5_RTS;
    278 		cs->cs_wr5_rts = 0;
    279 
    280 		/*
    281 		 * Clear the master interrupt enable.
    282 		 * The INTENA is common to both channels,
    283 		 * so just do it on the A channel.
    284 		 */
    285 		if (channel == 0) {
    286 			zs_write_reg(cs, 9, 0);
    287 		}
    288 
    289 		/*
    290 		 * Look for a child driver for this channel.
    291 		 * The child attach will setup the hardware.
    292 		 */
    293 		if (!config_found(self, (void *)&zsc_args, zs_print)) {
    294 			/* No sub-driver.  Just reset it. */
    295 			u_char reset = (channel == 0) ?
    296 				ZSWR9_A_RESET : ZSWR9_B_RESET;
    297 			s = splhigh();
    298 			zs_write_reg(cs, 9, reset);
    299 			splx(s);
    300 		}
    301 	}
    302 
    303 	/*
    304 	 * Now safe to install interrupt handlers.  Note the arguments
    305 	 * to the interrupt handlers aren't used.  Note, we only do this
    306 	 * once since both SCCs interrupt at the same level and vector.
    307 	 */
    308 	if (!didintr) {
    309 		didintr = 1;
    310 
    311 		zsc->zsc_si = softint_establish(SOFTINT_SERIAL, zssoft, zsc);
    312 		apbus_intr_establish(1, /* interrupt level ( 0 or 1 ) */
    313 				     NEWS5000_INT1_SCC,
    314 				     0, /* priority */
    315 				     zshard_ap, zsc,
    316 				     apa->apa_name, apa->apa_ctlnum);
    317 	}
    318 	/* XXX; evcnt_attach() ? */
    319 
    320 #if 0
    321 {
    322 	u_int x;
    323 
    324 	/* determine SCC/ESCC type */
    325 	x = zs_read_reg(cs, 15);
    326 	zs_write_reg(cs, 15, x | ZSWR15_ENABLE_ENHANCED);
    327 
    328 	if (zs_read_reg(cs, 15) & ZSWR15_ENABLE_ENHANCED) { /* ESCC Z85230 */
    329 		zs_write_reg(cs, 7, ZSWR7P_EXTEND_READ | ZSWR7P_TX_FIFO);
    330 	}
    331 }
    332 #endif
    333 
    334 	/*
    335 	 * Set the master interrupt enable and interrupt vector.
    336 	 * (common to both channels, do it on A)
    337 	 */
    338 	cs = zsc->zsc_cs[0];
    339 	s = splhigh();
    340 	/* interrupt vector */
    341 	zs_write_reg(cs, 2, zs_init_reg[2]);
    342 	/* master interrupt control (enable) */
    343 	zs_write_reg(cs, 9, zs_init_reg[9]);
    344 	splx(s);
    345 }
    346 
    347 static int
    348 zshard_ap(void *arg)
    349 {
    350 
    351 	zshard(arg);
    352 	return 1;
    353 }
    354 
    355 /*
    356  * Polled input char.
    357  */
    358 int
    359 zs_getc(void *arg)
    360 {
    361 	volatile struct zschan *zc = arg;
    362 	int s, c, rr0;
    363 
    364 	s = splhigh();
    365 	/* Wait for a character to arrive. */
    366 	do {
    367 		rr0 = zc->zc_csr;
    368 		ZS_DELAY();
    369 	} while ((rr0 & ZSRR0_RX_READY) == 0);
    370 
    371 	c = zc->zc_data;
    372 	ZS_DELAY();
    373 	splx(s);
    374 
    375 	/*
    376 	 * This is used by the kd driver to read scan codes,
    377 	 * so don't translate '\r' ==> '\n' here...
    378 	 */
    379 	return c;
    380 }
    381 
    382 /*
    383  * Polled output char.
    384  */
    385 void
    386 zs_putc(void *arg, int c)
    387 {
    388 	volatile struct zschan *zc = arg;
    389 	int s, rr0;
    390 
    391 	s = splhigh();
    392 	/* Wait for transmitter to become ready. */
    393 	do {
    394 		rr0 = zc->zc_csr;
    395 		ZS_DELAY();
    396 	} while ((rr0 & ZSRR0_TX_READY) == 0);
    397 
    398 	zc->zc_data = c;
    399 	ZS_DELAY();
    400 	splx(s);
    401 }
    402 
    403 /*****************************************************************/
    404 
    405 static void zscnprobe(struct consdev *);
    406 static void zscninit(struct consdev *);
    407 static int  zscngetc(dev_t);
    408 static void zscnputc(dev_t, int);
    409 
    410 struct consdev consdev_zs_ap = {
    411 	zscnprobe,
    412 	zscninit,
    413 	zscngetc,
    414 	zscnputc,
    415 	nullcnpollc,
    416 	NULL,
    417 	NULL,
    418 	NULL,
    419 	NODEV,
    420 	CN_DEAD
    421 };
    422 
    423 static void
    424 zscnprobe(struct consdev *cn)
    425 {
    426 }
    427 
    428 static void
    429 zscninit(struct consdev *cn)
    430 {
    431 	extern const struct cdevsw zstty_cdevsw;
    432 
    433 	cn->cn_dev = makedev(cdevsw_lookup_major(&zstty_cdevsw), 0);
    434 	cn->cn_pri = CN_REMOTE;
    435 	zs_hwflags[0][0] = ZS_HWFLAG_CONSOLE;
    436 }
    437 
    438 static int
    439 zscngetc(dev_t dev)
    440 {
    441 
    442 	return zs_getc((void *)NEWS5000_SCCPORT0A);
    443 }
    444 
    445 static void
    446 zscnputc(dev_t dev, int c)
    447 {
    448 
    449 	zs_putc((void *)NEWS5000_SCCPORT0A, c);
    450 }
    451