xref: /netbsd-src/sys/arch/sun2/dev/zsvar.h (revision 4f7c8158b18ae7a1cc532919b313dc53bf0a16d6)
1 /*	$NetBSD: zsvar.h,v 1.9 2020/03/13 01:48:16 rin Exp $	*/
2 
3 /*
4  * Copyright (c) 1992, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This software was developed by the Computer Systems Engineering group
8  * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
9  * contributed to Berkeley.
10  *
11  * All advertising materials mentioning features or use of this software
12  * must display the following acknowledgement:
13  *	This product includes software developed by the University of
14  *	California, Lawrence Berkeley Laboratory.
15  *
16  * Redistribution and use in source and binary forms, with or without
17  * modification, are permitted provided that the following conditions
18  * are met:
19  * 1. Redistributions of source code must retain the above copyright
20  *    notice, this list of conditions and the following disclaimer.
21  * 2. Redistributions in binary form must reproduce the above copyright
22  *    notice, this list of conditions and the following disclaimer in the
23  *    documentation and/or other materials provided with the distribution.
24  * 3. Neither the name of the University nor the names of its contributors
25  *    may be used to endorse or promote products derived from this software
26  *    without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38  * SUCH DAMAGE.
39  *
40  *	@(#)zsvar.h	8.1 (Berkeley) 6/11/93
41  */
42 
43 #include <machine/bus.h>
44 #include <dev/ic/z8530sc.h>
45 #include <sun2/dev/zsreg.h>
46 
47 #ifdef _KERNEL_OPT
48 #include "kbd.h"
49 #endif
50 
51 #if NKBD > 0
52 /*
53  * Need to override cn_console_dev() for zstty and zskbd.
54  */
55 extern struct consdev *cn_hw;
56 #undef cn_isconsole
57 #define cn_isconsole(d)	((d) == cn_tab->cn_dev || (d) == cn_hw->cn_dev)
58 #endif
59 
60 struct zsc_softc {
61 	device_t		zsc_dev;	/* base device */
62 	bus_space_tag_t		zsc_bustag;	/* bus space/DMA tags */
63 	bus_dma_tag_t		zsc_dmatag;
64 	struct zs_chanstate	*zsc_cs[2];	/* channel A and B soft state */
65 
66 	/* Machine-dependent part follows... */
67 	void			*zsc_softintr;
68 	int			zsc_promunit;	/* PROM's view of zs devices */
69 	int			zsc_node;	/* PROM node, if any */
70 	struct evcnt		zsc_intrcnt;	/* count interrupts */
71 	struct zs_chanstate	zsc_cs_store[2];
72 };
73 
74 /* MI function to attach a zs. */
75 void zs_attach(struct zsc_softc *, struct zsdevice *, int);
76 
77 /* MD function to get any console flags for a zs. */
78 int zs_console_flags(int, int, int);
79 
80 /* MD function that says what is attached to a zs. */
81 #define ZS_PERIPHERAL_UNKNOWN	0
82 #define ZS_PERIPHERAL_SUNKBD	1
83 #define ZS_PERIPHERAL_SUNMS	2
84 
85 /*
86  * Functions to read and write individual registers in a channel.
87  * The ZS chip requires a 1.6 uSec. recovery time between accesses.
88  * On the SparcStation the recovery time is handled in hardware.
89  * On the older Sun[234] machines it isn't, and software must do it.
90  *
91  * However, it *is* a problem on some Sun4m's (i.e. the SS20) (XXX: why?).
92  * Thus we leave in the delay (done in the functions below).
93  * XXX: (ABB) Think about this more.
94  *
95  * The functions below could be macros instead if we are concerned
96  * about the function call overhead where ZS_DELAY does nothing.
97  */
98 
99 uint8_t zs_read_reg(struct zs_chanstate *, uint8_t);
100 uint8_t zs_read_csr(struct zs_chanstate *);
101 uint8_t zs_read_data(struct zs_chanstate *);
102 
103 void  zs_write_reg(struct zs_chanstate *, uint8_t, uint8_t);
104 void  zs_write_csr(struct zs_chanstate *, uint8_t);
105 void  zs_write_data(struct zs_chanstate *, uint8_t);
106 
107 /* Everyone has splzs() in <machine/intr.h> */
108 
109 /* We want to call it "zs" instead of "zsc" (sigh). */
110 #ifndef ZSCCF_CHANNEL
111 #define ZSCCF_CHANNEL 0
112 #define ZSCCF_CHANNEL_DEFAULT -1
113 #endif
114