xref: /netbsd-src/sys/arch/sparc/dev/esp_obio.c (revision 267197ec1eebfcb9810ea27a89625b6ddf68e3e7)
1 /*	$NetBSD: esp_obio.c,v 1.21 2008/02/12 17:30:58 joerg Exp $	*/
2 
3 /*-
4  * Copyright (c) 1997, 1998 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Charles M. Hannum; Jason R. Thorpe of the Numerical Aerospace
9  * Simulation Facility, NASA Ames Research Center; Paul Kranenburg.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *	This product includes software developed by the NetBSD
22  *	Foundation, Inc. and its contributors.
23  * 4. Neither the name of The NetBSD Foundation nor the names of its
24  *    contributors may be used to endorse or promote products derived
25  *    from this software without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37  * POSSIBILITY OF SUCH DAMAGE.
38  */
39 
40 #include <sys/cdefs.h>
41 __KERNEL_RCSID(0, "$NetBSD: esp_obio.c,v 1.21 2008/02/12 17:30:58 joerg Exp $");
42 
43 #include <sys/types.h>
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #include <sys/kernel.h>
47 #include <sys/errno.h>
48 #include <sys/device.h>
49 #include <sys/buf.h>
50 
51 #include <dev/scsipi/scsi_all.h>
52 #include <dev/scsipi/scsipi_all.h>
53 #include <dev/scsipi/scsiconf.h>
54 #include <dev/scsipi/scsi_message.h>
55 
56 #include <machine/bus.h>
57 #include <machine/autoconf.h>
58 #include <machine/intr.h>
59 
60 #include <dev/ic/lsi64854reg.h>
61 #include <dev/ic/lsi64854var.h>
62 
63 #include <dev/ic/ncr53c9xreg.h>
64 #include <dev/ic/ncr53c9xvar.h>
65 
66 #include <dev/sbus/sbusvar.h>
67 
68 struct esp_softc {
69 	struct ncr53c9x_softc sc_ncr53c9x;	/* glue to MI code */
70 	bus_space_tag_t		sc_bustag;
71 	bus_dma_tag_t		sc_dmatag;
72 	bus_space_handle_t	sc_reg;		/* the registers */
73 	struct lsi64854_softc	*sc_dma;	/* pointer to my dma */
74 };
75 
76 
77 int	espmatch_obio(struct device *, struct cfdata *, void *);
78 void	espattach_obio(struct device *, struct device *, void *);
79 
80 /* Linkup to the rest of the kernel */
81 CFATTACH_DECL(esp_obio, sizeof(struct esp_softc),
82     espmatch_obio, espattach_obio, NULL, NULL);
83 
84 /*
85  * Functions and the switch for the MI code.
86  */
87 static u_char	esp_read_reg(struct ncr53c9x_softc *, int);
88 static void	esp_write_reg(struct ncr53c9x_softc *, int, u_char);
89 static int	esp_dma_isintr(struct ncr53c9x_softc *);
90 static void	esp_dma_reset(struct ncr53c9x_softc *);
91 static int	esp_dma_intr(struct ncr53c9x_softc *);
92 static int	esp_dma_setup(struct ncr53c9x_softc *, void **,
93 				    size_t *, int, size_t *);
94 static void	esp_dma_go(struct ncr53c9x_softc *);
95 static void	esp_dma_stop(struct ncr53c9x_softc *);
96 static int	esp_dma_isactive(struct ncr53c9x_softc *);
97 
98 static struct ncr53c9x_glue esp_obio_glue = {
99 	esp_read_reg,
100 	esp_write_reg,
101 	esp_dma_isintr,
102 	esp_dma_reset,
103 	esp_dma_intr,
104 	esp_dma_setup,
105 	esp_dma_go,
106 	esp_dma_stop,
107 	esp_dma_isactive,
108 	NULL,			/* gl_clear_latched_intr */
109 };
110 
111 int
112 espmatch_obio(struct device *parent, struct cfdata *cf, void *aux)
113 {
114 	union obio_attach_args *uoba = aux;
115 	struct obio4_attach_args *oba;
116 
117 	if (uoba->uoba_isobio4 == 0)
118 		return (0);
119 
120 	oba = &uoba->uoba_oba4;
121 	return (bus_space_probe(oba->oba_bustag, oba->oba_paddr,
122 				1,	/* probe size */
123 				0,	/* offset */
124 				0,	/* flags */
125 				NULL, NULL));
126 }
127 
128 void
129 espattach_obio(struct device *parent, struct device *self, void *aux)
130 {
131 	device_t dma_dev;
132 	union obio_attach_args *uoba = aux;
133 	struct obio4_attach_args *oba = &uoba->uoba_oba4;
134 	struct esp_softc *esc = (void *)self;
135 	struct ncr53c9x_softc *sc = &esc->sc_ncr53c9x;
136 
137 	esc->sc_bustag = oba->oba_bustag;
138 	esc->sc_dmatag = oba->oba_dmatag;
139 
140 	sc->sc_id = 7;
141 	sc->sc_freq = 24000000;
142 
143 	/*
144 	 * Find the DMA by poking around the dma device structures and
145 	 * set the reverse pointer.
146 	 */
147 	dma_dev = device_find_by_driver_unit("dma", device_unit(self));
148 	if (dma_dev == NULL)
149 		panic("%s: no corresponding DMA device", device_xname(self));
150 	esc->sc_dma = device_private(dma_dev);
151 	esc->sc_dma->sc_client = sc;
152 
153 	if (bus_space_map(oba->oba_bustag, oba->oba_paddr,
154 			  16,	/* size (of ncr53c9xreg) */
155 			  BUS_SPACE_MAP_LINEAR,
156 			  &esc->sc_reg) != 0) {
157 		printf("%s @ obio: cannot map registers\n", self->dv_xname);
158 		return;
159 	}
160 
161 	/*
162 	 * Set up glue for MI code early; we use some of it here.
163 	 */
164 	sc->sc_glue = &esp_obio_glue;
165 
166 	/* gimme MHz */
167 	sc->sc_freq /= 1000000;
168 
169 	/*
170 	 * XXX More of this should be in ncr53c9x_attach(), but
171 	 * XXX should we really poke around the chip that much in
172 	 * XXX the MI code?  Think about this more...
173 	 */
174 
175 	/*
176 	 * It is necessary to try to load the 2nd config register here,
177 	 * to find out what rev the esp chip is, else the ncr53c9x_reset
178 	 * will not set up the defaults correctly.
179 	 */
180 	sc->sc_cfg1 = sc->sc_id | NCRCFG1_PARENB;
181 	sc->sc_cfg2 = NCRCFG2_SCSI2 | NCRCFG2_RPE;
182 	sc->sc_cfg3 = NCRCFG3_CDB;
183 	NCR_WRITE_REG(sc, NCR_CFG2, sc->sc_cfg2);
184 
185 	if ((NCR_READ_REG(sc, NCR_CFG2) & ~NCRCFG2_RSVD) !=
186 	    (NCRCFG2_SCSI2 | NCRCFG2_RPE)) {
187 		sc->sc_rev = NCR_VARIANT_ESP100;
188 	} else {
189 		sc->sc_cfg2 = NCRCFG2_SCSI2;
190 		NCR_WRITE_REG(sc, NCR_CFG2, sc->sc_cfg2);
191 		sc->sc_cfg3 = 0;
192 		NCR_WRITE_REG(sc, NCR_CFG3, sc->sc_cfg3);
193 		sc->sc_cfg3 = (NCRCFG3_CDB | NCRCFG3_FCLK);
194 		NCR_WRITE_REG(sc, NCR_CFG3, sc->sc_cfg3);
195 		if (NCR_READ_REG(sc, NCR_CFG3) !=
196 		    (NCRCFG3_CDB | NCRCFG3_FCLK)) {
197 			sc->sc_rev = NCR_VARIANT_ESP100A;
198 		} else {
199 			/* NCRCFG2_FE enables > 64K transfers */
200 			sc->sc_cfg2 |= NCRCFG2_FE;
201 			sc->sc_cfg3 = 0;
202 			NCR_WRITE_REG(sc, NCR_CFG3, sc->sc_cfg3);
203 			sc->sc_rev = NCR_VARIANT_ESP200;
204 		}
205 	}
206 
207 	/*
208 	 * XXX minsync and maxxfer _should_ be set up in MI code,
209 	 * XXX but it appears to have some dependency on what sort
210 	 * XXX of DMA we're hooked up to, etc.
211 	 */
212 
213 	/*
214 	 * This is the value used to start sync negotiations
215 	 * Note that the NCR register "SYNCTP" is programmed
216 	 * in "clocks per byte", and has a minimum value of 4.
217 	 * The SCSI period used in negotiation is one-fourth
218 	 * of the time (in nanoseconds) needed to transfer one byte.
219 	 * Since the chip's clock is given in MHz, we have the following
220 	 * formula: 4 * period = (1000 / freq) * 4
221 	 */
222 	sc->sc_minsync = 1000 / sc->sc_freq;
223 
224 	/*
225 	 * Alas, we must now modify the value a bit, because it's
226 	 * only valid when can switch on FASTCLK and FASTSCSI bits
227 	 * in config register 3...
228 	 */
229 	switch (sc->sc_rev) {
230 	case NCR_VARIANT_ESP100:
231 		sc->sc_maxxfer = 64 * 1024;
232 		sc->sc_minsync = 0;	/* No synch on old chip? */
233 		break;
234 
235 	case NCR_VARIANT_ESP100A:
236 		sc->sc_maxxfer = 64 * 1024;
237 		/* Min clocks/byte is 5 */
238 		sc->sc_minsync = ncr53c9x_cpb2stp(sc, 5);
239 		break;
240 
241 	case NCR_VARIANT_ESP200:
242 		sc->sc_maxxfer = 16 * 1024 * 1024;
243 		/* XXX - do actually set FAST* bits */
244 		break;
245 	}
246 
247 	/* Establish interrupt channel */
248 	bus_intr_establish(esc->sc_bustag, oba->oba_pri, IPL_BIO,
249 			   ncr53c9x_intr, sc);
250 
251 	/* register interrupt stats */
252 	evcnt_attach_dynamic(&sc->sc_intrcnt, EVCNT_TYPE_INTR, NULL,
253 	    sc->sc_dev.dv_xname, "intr");
254 
255 	/* Do the common parts of attachment. */
256 	sc->sc_adapter.adapt_minphys = minphys;
257 	sc->sc_adapter.adapt_request = ncr53c9x_scsipi_request;
258 	ncr53c9x_attach(sc);
259 	sc->sc_features |= NCR_F_DMASELECT;
260 }
261 
262 /*
263  * Glue functions.
264  */
265 
266 static u_char
267 esp_read_reg(struct ncr53c9x_softc *sc, int reg)
268 {
269 	struct esp_softc *esc = (struct esp_softc *)sc;
270 
271 	return (bus_space_read_1(esc->sc_bustag, esc->sc_reg, reg * 4));
272 }
273 
274 static void
275 esp_write_reg(struct ncr53c9x_softc *sc, int reg, u_char v)
276 {
277 	struct esp_softc *esc = (struct esp_softc *)sc;
278 
279 	bus_space_write_1(esc->sc_bustag, esc->sc_reg, reg * 4, v);
280 }
281 
282 static int
283 esp_dma_isintr(struct ncr53c9x_softc *sc)
284 {
285 	struct esp_softc *esc = (struct esp_softc *)sc;
286 
287 	return (DMA_ISINTR(esc->sc_dma));
288 }
289 
290 static void
291 esp_dma_reset(struct ncr53c9x_softc *sc)
292 {
293 	struct esp_softc *esc = (struct esp_softc *)sc;
294 
295 	DMA_RESET(esc->sc_dma);
296 }
297 
298 static int
299 esp_dma_intr(struct ncr53c9x_softc *sc)
300 {
301 	struct esp_softc *esc = (struct esp_softc *)sc;
302 
303 	return (DMA_INTR(esc->sc_dma));
304 }
305 
306 static int
307 esp_dma_setup(struct ncr53c9x_softc *sc, void **addr, size_t *len,
308 	      int datain, size_t *dmasize)
309 {
310 	struct esp_softc *esc = (struct esp_softc *)sc;
311 
312 	return (DMA_SETUP(esc->sc_dma, addr, len, datain, dmasize));
313 }
314 
315 static void
316 esp_dma_go(struct ncr53c9x_softc *sc)
317 {
318 	struct esp_softc *esc = (struct esp_softc *)sc;
319 
320 	DMA_GO(esc->sc_dma);
321 }
322 
323 static void
324 esp_dma_stop(struct ncr53c9x_softc *sc)
325 {
326 	struct esp_softc *esc = (struct esp_softc *)sc;
327 	uint32_t csr;
328 
329 	csr = L64854_GCSR(esc->sc_dma);
330 	csr &= ~D_EN_DMA;
331 	L64854_SCSR(esc->sc_dma, csr);
332 }
333 
334 static int
335 esp_dma_isactive(struct ncr53c9x_softc *sc)
336 {
337 	struct esp_softc *esc = (struct esp_softc *)sc;
338 
339 	return (DMA_ISACTIVE(esc->sc_dma));
340 }
341