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