xref: /netbsd-src/sys/arch/x68k/include/z8530var.h (revision 02cb47cab231ebd863359e08e47b4a2356127b4c)
1 /*    $NetBSD: z8530var.h,v 1.9 2008/03/29 19:15:36 tsutsui 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 /*
44  * Copyright (c) 1998 Minoura Makoto
45  * All rights reserved.
46  *
47  * Redistribution and use in source and binary forms, with or without
48  * modification, are permitted provided that the following conditions
49  * are met:
50  * 1. Redistributions of source code must retain the above copyright
51  *    notice, this list of conditions and the following disclaimer.
52  * 2. Redistributions in binary form must reproduce the above copyright
53  *    notice, this list of conditions and the following disclaimer in the
54  *    documentation and/or other materials provided with the distribution.
55  * 3. All advertising materials mentioning features or use of this software
56  *    must display the following acknowledgement:
57  *      This product includes software developed by Minoura Makoto.
58  * 4. The name of the author may not be used to endorse or promote products
59  *    derived from this software without specific prior written permission
60  *
61  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
62  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
63  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
64  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
65  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
66  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
67  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
68  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
69  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
70  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
71  */
72 
73 /*
74  * Copyright (c) 1994 Gordon W. Ross
75  *
76  * This software was developed by the Computer Systems Engineering group
77  * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
78  * contributed to Berkeley.
79  *
80  * All advertising materials mentioning features or use of this software
81  * must display the following acknowledgement:
82  *	This product includes software developed by the University of
83  *	California, Lawrence Berkeley Laboratory.
84  *
85  * Redistribution and use in source and binary forms, with or without
86  * modification, are permitted provided that the following conditions
87  * are met:
88  * 1. Redistributions of source code must retain the above copyright
89  *    notice, this list of conditions and the following disclaimer.
90  * 2. Redistributions in binary form must reproduce the above copyright
91  *    notice, this list of conditions and the following disclaimer in the
92  *    documentation and/or other materials provided with the distribution.
93  * 3. All advertising materials mentioning features or use of this software
94  *    must display the following acknowledgement:
95  *	This product includes software developed by the University of
96  *	California, Berkeley and its contributors.
97  * 4. Neither the name of the University nor the names of its contributors
98  *    may be used to endorse or promote products derived from this software
99  *    without specific prior written permission.
100  *
101  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
102  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
103  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
104  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
105  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
106  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
107  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
108  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
109  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
110  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
111  * SUCH DAMAGE.
112  *
113  *	@(#)zsvar.h	8.1 (Berkeley) 6/11/93
114  */
115 
116 #include <machine/bus.h>
117 #include <dev/ic/z8530sc.h>
118 
119 
120 #define ZS_DELAY()			delay(2)
121 
122 /* The layout of this is hardware-dependent (padding, order). */
123 struct zschan {
124 	uint8_t		zc_xxx0;
125 	volatile uint8_t zc_csr;	/* ctrl,status, and indirect access */
126 	uint8_t		zc_xxx1;
127 	volatile uint8_t zc_data;	/* data */
128 };
129 struct zsdevice {
130 	/* Yes, they are backwards. */
131 	struct	zschan zs_chan_b;
132 	struct	zschan zs_chan_a;
133 };
134 
135 struct zsc_softc {
136 	device_t zsc_dev;		/* required first: base device */
137 	struct	zs_chanstate *zsc_cs[2];	/* channel A and B soft state */
138 	/* Machine-dependent part follows... */
139 	struct zs_chanstate  zsc_cs_store[2];
140 	struct zsdevice *zsc_addr;
141 	void *zsc_softintr_cookie;
142 };
143 
144 /*
145  * Functions to read and write individual registers in a channel.
146  * The ZS chip requires a 1.6 uSec. recovery time between accesses,
147  * and the Sun3 hardware does NOT take care of this for you.
148  * The delay is now handled inside the chip access functions.
149  * These could be inlines, but with the delay, speed is moot.
150  */
151 
152 uint8_t zs_read_reg(struct zs_chanstate *, uint8_t);
153 uint8_t zs_read_csr(struct zs_chanstate *);
154 uint8_t zs_read_data(struct zs_chanstate *);
155 
156 void  zs_write_reg(struct zs_chanstate *, uint8_t, uint8_t);
157 void  zs_write_csr(struct zs_chanstate *, uint8_t);
158 void  zs_write_data(struct zs_chanstate *, uint8_t);
159 
160 /*
161  * Physical address for built-in ZS.
162  */
163 #define ZSCN_PHYSADDR	0xe98004 /* for serial console */
164 #define ZSMS_PHYSADDR	0xe98000 /* for mouse */
165 
166 #define	IPL_ZS	IPL_SERIAL
167