sio16.c revision 1.20
1/*	$NetBSD: sio16.c,v 1.20 2009/05/12 13:20:06 cegger Exp $	*/
2
3/*
4 * Copyright (c) 1998, 2001 Matthew R. Green
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29/*
30 * aurora technologies nova16 driver.  this board is an sbus card with
31 * an external 16 port serial box.  there are two cirrus logic cd180
32 * 8 port serial chips used in the implementation.
33 *
34 * thanks go to Oliver Aldulea <oli@morcov.bv.ro> for writing the
35 * linux driver of this that helped clear up a couple of issues.
36 */
37
38#include <sys/cdefs.h>
39__KERNEL_RCSID(0, "$NetBSD: sio16.c,v 1.20 2009/05/12 13:20:06 cegger Exp $");
40
41#include <sys/param.h>
42#include <sys/conf.h>
43#include <sys/device.h>
44#include <sys/systm.h>
45
46#include <machine/autoconf.h>
47
48#include <dev/ic/cd18xxvar.h>
49#include <dev/ic/cd18xxreg.h>
50
51#include "ioconf.h"
52#include "locators.h"
53
54/* 1600se configuration register bits */
55#define SIO16_CONFIGREG_ENABLE_IO    8
56#define SIO16_CONFIGREG_ENABLE_IRQ   4
57
58/* 1600se interrupt ackknowledge register bytes */
59#define	SIO16_MINT_ACK		1	/* modem interrupt acknowledge */
60#define	SIO16_TINT_ACK		2	/* tx interrupt acknowledge */
61#define	SIO16_RINT_ACK		3	/* rx interrupt acknowledge */
62
63/*
64 * device cfattach and cfdriver definitions, plus the routine we pass
65 * to the cd18xx code or interrupt acknowledgement.
66 */
67static int	sio16_match(struct device *, cfdata_t, void *);
68static void	sio16_attach(struct device *, struct device *, void *);
69static u_char	sio16_ackfunc(void *, int who);
70
71/*
72 * define the sio16 per-device softc.
73 */
74struct sio16_softc {
75	struct device	sc_dev;			/* must be first */
76	struct sbusdev	sc_sd;			/* for sbus drivers */
77
78	/* sbus information */
79	bus_space_tag_t	sc_tag;			/* bus tag for below */
80	bus_space_handle_t sc_configreg;	/* configuration register */
81	bus_space_handle_t sc_reg[2];		/* cd180 register sets */
82	bus_space_handle_t sc_ack;		/* interrupt acknowledgement */
83#define	SIO16_1600SE	0x00000001
84
85	u_int           sc_clk;
86
87	/* cd180 information */
88	int		sc_ncd180;
89
90};
91
92CFATTACH_DECL(siosixteen, sizeof(struct sio16_softc),
93    sio16_match, sio16_attach, NULL, NULL);
94
95struct sio16_attach_args {
96	bus_space_tag_t		cd_tag;
97	bus_space_handle_t	cd_handle;
98	u_char			(*cd_ackfunc)(void *, int);
99	void			*cd_ackfunc_arg;
100	u_int			cd_osc;
101};
102
103/*
104 * device match routine:  is there an sio16 present?
105 *
106 * note that we can not put "sio16" in the cfdriver, as this is an
107 * illegal name, so we have to hard code it here.
108 */
109#define	SIO16_ROM_NAME	"sio16"
110int
111sio16_match(struct device *parent, cfdata_t cf, void *aux)
112{
113	struct sbus_attach_args *sa = aux;
114
115	/* does the prom think i'm an sio16? */
116	if (strcmp(SIO16_ROM_NAME, sa->sa_name) != 0)
117		return (0);
118
119	return (1);
120}
121
122/*
123 * device attach routine:  go attach all sub devices.
124 */
125void
126sio16_attach(struct device *parent, struct device *self, void *aux)
127{
128	struct sbus_attach_args *sa = aux;
129	struct sio16_softc *sc = (struct sio16_softc *)self;
130	bus_space_handle_t h;
131	char *mode, *model;
132	int i;
133
134	if (sa->sa_nreg != 4)
135		panic("sio16_attach: got %d registers intead of 4",
136		    sa->sa_nreg);
137
138	/* copy our bus tag, we will need it */
139	sc->sc_tag = sa->sa_bustag;
140
141	/*
142	 * sio16 has 4 register mappings.  a single byte configuration
143	 * register, 2 128 byte regions for the cd180 registers, and
144	 * a 4 byte region for interrupt acknowledgement.
145	 */
146	if (sbus_bus_map(sa->sa_bustag,
147			 sa->sa_reg[0].oa_space,
148			 sa->sa_reg[0].oa_base,
149			 sa->sa_reg[0].oa_size,
150			 0, &h) != 0) {
151		printf("%s at sbus: can not map registers 0\n",
152		    device_xname(self));
153		return;
154	}
155	sc->sc_configreg = h;
156	if (sbus_bus_map(sa->sa_bustag,
157			 sa->sa_reg[1].sbr_slot,
158			 sa->sa_reg[1].sbr_offset,
159			 sa->sa_reg[1].sbr_size,
160			 0, &h) != 0) {
161		printf("%s at sbus: can not map registers 1\n",
162		    device_xname(self));
163		return;
164	}
165	sc->sc_reg[0] = h;
166	if (sbus_bus_map(sa->sa_bustag,
167			 sa->sa_reg[2].sbr_slot,
168			 sa->sa_reg[2].sbr_offset,
169			 sa->sa_reg[2].sbr_size,
170			 0, &h) != 0) {
171		printf("%s at sbus: can not map registers 2\n",
172		    device_xname(self));
173		return;
174	}
175	sc->sc_reg[1] = h;
176	if (sbus_bus_map(sa->sa_bustag,
177			 sa->sa_reg[3].sbr_slot,
178			 sa->sa_reg[3].sbr_offset,
179			 sa->sa_reg[3].sbr_size,
180			 0, &h) != 0) {
181		printf("%s at sbus: can not map registers 3\n",
182		    device_xname(self));
183		return;
184	}
185	sc->sc_ack = h;
186
187	mode = prom_getpropstring(sa->sa_node, "mode");
188	if (mode)
189		printf(", %s mode", mode);
190
191	/* get the clock frequency */
192	sc->sc_clk = prom_getpropint(sa->sa_node, "clk", 24000);
193
194	model = prom_getpropstring(sa->sa_node, "model");
195	if (model == 0) {
196		printf(", no model property, bailing\n");
197		return;
198	}
199
200	/* are we an 1600se? */
201	if (strcmp(model, "1600se") == 0) {
202		printf(", 16 channels");
203		sc->sc_ncd180 = 2;
204	} else {
205		printf(", don't know model %s, bailing\n", model);
206		return;
207	}
208
209	/* set up our sbus connections */
210	sbus_establish(&sc->sc_sd, &sc->sc_dev);
211
212	/* establish interrupt channel */
213	(void)bus_intr_establish(sa->sa_bustag, sa->sa_pri, IPL_TTY,
214	    cd18xx_hardintr, sc);
215
216	/* reset the board, and turn on interrupts and I/O */
217	bus_space_write_1(sa->sa_bustag, sc->sc_configreg, 0, 0);
218	delay(100);
219	bus_space_write_1(sa->sa_bustag, sc->sc_configreg, 0,
220	    SIO16_CONFIGREG_ENABLE_IO | SIO16_CONFIGREG_ENABLE_IRQ |
221	    (((sa->sa_pri) & 0x0f) >> 2));
222	delay(10000);
223
224	printf("\n");
225
226	/* finally, configure the clcd's underneath */
227	for (i = 0; i < sc->sc_ncd180; i++) {
228		struct sio16_attach_args cd;
229
230		cd.cd_tag = sa->sa_bustag;
231		cd.cd_osc = sc->sc_clk * 100;
232		cd.cd_handle = (bus_space_handle_t)sc->sc_reg[i];
233		cd.cd_ackfunc = sio16_ackfunc;
234		cd.cd_ackfunc_arg = sc;
235		(void)config_found(self, (void *)&cd, NULL);
236	}
237}
238
239/*
240 * note that the addresses used in this function match those assigned
241 * in clcd_attach() below, or the various service match routines.
242 */
243u_char
244sio16_ackfunc(void *v, int who)
245{
246	struct sio16_softc *sc = v;
247	bus_size_t addr;
248
249	switch (who) {
250	case CD18xx_INTRACK_RxINT:
251	case CD18xx_INTRACK_REINT:
252		addr = SIO16_RINT_ACK;
253		break;
254	case CD18xx_INTRACK_TxINT:
255		addr = SIO16_TINT_ACK;
256		break;
257	case CD18xx_INTRACK_MxINT:
258		addr = SIO16_MINT_ACK;
259		break;
260	default:
261		panic("%s: sio16_ackfunc: unknown ackfunc %d",
262		    device_xname(&sc->sc_dev), who);
263	}
264	return (bus_space_read_1(sc->sc_tag, sc->sc_ack, addr));
265}
266
267/*
268 * we attach two `clcd' instances per 1600se, that each call the
269 * backend cd18xx driver for help.
270 */
271static int	clcd_match(struct device *, cfdata_t, void *);
272static void	clcd_attach(struct device *, struct device *, void *);
273
274CFATTACH_DECL(clcd, sizeof(struct cd18xx_softc),
275    clcd_match, clcd_attach, NULL, NULL);
276
277static int
278clcd_match(struct device *parent, cfdata_t cf, void *aux)
279{
280
281	/* XXX */
282	return 1;
283}
284
285static void
286clcd_attach(struct device *parent, struct device *self, void *aux)
287{
288	struct cd18xx_softc *sc = (struct cd18xx_softc *)self;
289	struct sio16_attach_args *args = aux;
290
291	sc->sc_tag = args->cd_tag;
292	sc->sc_handle = args->cd_handle;
293	sc->sc_osc = args->cd_osc;
294	sc->sc_ackfunc = args->cd_ackfunc;
295	sc->sc_ackfunc_arg = args->cd_ackfunc_arg;
296	sc->sc_msmr = SIO16_MINT_ACK;
297	sc->sc_tsmr = SIO16_TINT_ACK;
298	sc->sc_rsmr = SIO16_RINT_ACK;
299
300	/* call the common code */
301	cd18xx_attach(sc);
302}
303