sio16.c revision 1.22
1/*	$NetBSD: sio16.c,v 1.22 2009/09/17 16:28:12 tsutsui 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.22 2009/09/17 16:28:12 tsutsui 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(device_t, cfdata_t, void *);
68static void	sio16_attach(device_t, device_t, 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
77	/* sbus information */
78	bus_space_tag_t	sc_tag;			/* bus tag for below */
79	bus_space_handle_t sc_configreg;	/* configuration register */
80	bus_space_handle_t sc_reg[2];		/* cd180 register sets */
81	bus_space_handle_t sc_ack;		/* interrupt acknowledgement */
82#define	SIO16_1600SE	0x00000001
83
84	u_int           sc_clk;
85
86	/* cd180 information */
87	int		sc_ncd180;
88
89};
90
91CFATTACH_DECL(siosixteen, sizeof(struct sio16_softc),
92    sio16_match, sio16_attach, NULL, NULL);
93
94struct sio16_attach_args {
95	bus_space_tag_t		cd_tag;
96	bus_space_handle_t	cd_handle;
97	u_char			(*cd_ackfunc)(void *, int);
98	void			*cd_ackfunc_arg;
99	u_int			cd_osc;
100};
101
102/*
103 * device match routine:  is there an sio16 present?
104 *
105 * note that we can not put "sio16" in the cfdriver, as this is an
106 * illegal name, so we have to hard code it here.
107 */
108#define	SIO16_ROM_NAME	"sio16"
109int
110sio16_match(device_t parent, cfdata_t cf, void *aux)
111{
112	struct sbus_attach_args *sa = aux;
113
114	/* does the prom think i'm an sio16? */
115	if (strcmp(SIO16_ROM_NAME, sa->sa_name) != 0)
116		return (0);
117
118	return (1);
119}
120
121/*
122 * device attach routine:  go attach all sub devices.
123 */
124void
125sio16_attach(device_t parent, device_t self, void *aux)
126{
127	struct sbus_attach_args *sa = aux;
128	struct sio16_softc *sc = (struct sio16_softc *)self;
129	bus_space_handle_t h;
130	char *mode, *model;
131	int i;
132
133	if (sa->sa_nreg != 4)
134		panic("sio16_attach: got %d registers intead of 4",
135		    sa->sa_nreg);
136
137	/* copy our bus tag, we will need it */
138	sc->sc_tag = sa->sa_bustag;
139
140	/*
141	 * sio16 has 4 register mappings.  a single byte configuration
142	 * register, 2 128 byte regions for the cd180 registers, and
143	 * a 4 byte region for interrupt acknowledgement.
144	 */
145	if (sbus_bus_map(sa->sa_bustag,
146			 sa->sa_reg[0].oa_space,
147			 sa->sa_reg[0].oa_base,
148			 sa->sa_reg[0].oa_size,
149			 0, &h) != 0) {
150		printf("%s at sbus: can not map registers 0\n",
151		    device_xname(self));
152		return;
153	}
154	sc->sc_configreg = h;
155	if (sbus_bus_map(sa->sa_bustag,
156			 sa->sa_reg[1].sbr_slot,
157			 sa->sa_reg[1].sbr_offset,
158			 sa->sa_reg[1].sbr_size,
159			 0, &h) != 0) {
160		printf("%s at sbus: can not map registers 1\n",
161		    device_xname(self));
162		return;
163	}
164	sc->sc_reg[0] = h;
165	if (sbus_bus_map(sa->sa_bustag,
166			 sa->sa_reg[2].sbr_slot,
167			 sa->sa_reg[2].sbr_offset,
168			 sa->sa_reg[2].sbr_size,
169			 0, &h) != 0) {
170		printf("%s at sbus: can not map registers 2\n",
171		    device_xname(self));
172		return;
173	}
174	sc->sc_reg[1] = h;
175	if (sbus_bus_map(sa->sa_bustag,
176			 sa->sa_reg[3].sbr_slot,
177			 sa->sa_reg[3].sbr_offset,
178			 sa->sa_reg[3].sbr_size,
179			 0, &h) != 0) {
180		printf("%s at sbus: can not map registers 3\n",
181		    device_xname(self));
182		return;
183	}
184	sc->sc_ack = h;
185
186	mode = prom_getpropstring(sa->sa_node, "mode");
187	if (mode)
188		printf(", %s mode", mode);
189
190	/* get the clock frequency */
191	sc->sc_clk = prom_getpropint(sa->sa_node, "clk", 24000);
192
193	model = prom_getpropstring(sa->sa_node, "model");
194	if (model == 0) {
195		printf(", no model property, bailing\n");
196		return;
197	}
198
199	/* are we an 1600se? */
200	if (strcmp(model, "1600se") == 0) {
201		printf(", 16 channels");
202		sc->sc_ncd180 = 2;
203	} else {
204		printf(", don't know model %s, bailing\n", model);
205		return;
206	}
207
208	/* establish interrupt channel */
209	(void)bus_intr_establish(sa->sa_bustag, sa->sa_pri, IPL_TTY,
210	    cd18xx_hardintr, sc);
211
212	/* reset the board, and turn on interrupts and I/O */
213	bus_space_write_1(sa->sa_bustag, sc->sc_configreg, 0, 0);
214	delay(100);
215	bus_space_write_1(sa->sa_bustag, sc->sc_configreg, 0,
216	    SIO16_CONFIGREG_ENABLE_IO | SIO16_CONFIGREG_ENABLE_IRQ |
217	    (((sa->sa_pri) & 0x0f) >> 2));
218	delay(10000);
219
220	printf("\n");
221
222	/* finally, configure the clcd's underneath */
223	for (i = 0; i < sc->sc_ncd180; i++) {
224		struct sio16_attach_args cd;
225
226		cd.cd_tag = sa->sa_bustag;
227		cd.cd_osc = sc->sc_clk * 100;
228		cd.cd_handle = (bus_space_handle_t)sc->sc_reg[i];
229		cd.cd_ackfunc = sio16_ackfunc;
230		cd.cd_ackfunc_arg = sc;
231		(void)config_found(self, (void *)&cd, NULL);
232	}
233}
234
235/*
236 * note that the addresses used in this function match those assigned
237 * in clcd_attach() below, or the various service match routines.
238 */
239u_char
240sio16_ackfunc(void *v, int who)
241{
242	struct sio16_softc *sc = v;
243	bus_size_t addr;
244
245	switch (who) {
246	case CD18xx_INTRACK_RxINT:
247	case CD18xx_INTRACK_REINT:
248		addr = SIO16_RINT_ACK;
249		break;
250	case CD18xx_INTRACK_TxINT:
251		addr = SIO16_TINT_ACK;
252		break;
253	case CD18xx_INTRACK_MxINT:
254		addr = SIO16_MINT_ACK;
255		break;
256	default:
257		panic("%s: sio16_ackfunc: unknown ackfunc %d",
258		    device_xname(&sc->sc_dev), who);
259	}
260	return (bus_space_read_1(sc->sc_tag, sc->sc_ack, addr));
261}
262
263/*
264 * we attach two `clcd' instances per 1600se, that each call the
265 * backend cd18xx driver for help.
266 */
267static int	clcd_match(device_t, cfdata_t, void *);
268static void	clcd_attach(device_t, device_t, void *);
269
270CFATTACH_DECL(clcd, sizeof(struct cd18xx_softc),
271    clcd_match, clcd_attach, NULL, NULL);
272
273static int
274clcd_match(device_t parent, cfdata_t cf, void *aux)
275{
276
277	/* XXX */
278	return 1;
279}
280
281static void
282clcd_attach(device_t parent, device_t self, void *aux)
283{
284	struct cd18xx_softc *sc = (struct cd18xx_softc *)self;
285	struct sio16_attach_args *args = aux;
286
287	sc->sc_tag = args->cd_tag;
288	sc->sc_handle = args->cd_handle;
289	sc->sc_osc = args->cd_osc;
290	sc->sc_ackfunc = args->cd_ackfunc;
291	sc->sc_ackfunc_arg = args->cd_ackfunc_arg;
292	sc->sc_msmr = SIO16_MINT_ACK;
293	sc->sc_tsmr = SIO16_TINT_ACK;
294	sc->sc_rsmr = SIO16_RINT_ACK;
295
296	/* call the common code */
297	cd18xx_attach(sc);
298}
299