si.c revision 1.37.2.1 1 /* $NetBSD: si.c,v 1.37.2.1 1997/10/29 00:32:02 mellon Exp $ */
2
3 /*-
4 * Copyright (c) 1996 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Adam Glass, David Jones, and Gordon W. Ross.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the NetBSD
21 * Foundation, Inc. and its contributors.
22 * 4. Neither the name of The NetBSD Foundation nor the names of its
23 * contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 * POSSIBILITY OF SUCH DAMAGE.
37 */
38
39 /*
40 * This file contains only the machine-dependent parts of the
41 * Sun3 SCSI driver. (Autoconfig stuff and DMA functions.)
42 * The machine-independent parts are in ncr5380sbc.c
43 *
44 * Supported hardware includes:
45 * Sun SCSI-3 on OBIO (Sun3/50,Sun3/60)
46 * Sun SCSI-3 on VME (Sun3/160,Sun3/260)
47 *
48 * Could be made to support the Sun3/E if someone wanted to.
49 *
50 * Note: Both supported variants of the Sun SCSI-3 adapter have
51 * some really unusual "features" for this driver to deal with,
52 * generally related to the DMA engine. The OBIO variant will
53 * ignore any attempt to write the FIFO count register while the
54 * SCSI bus is in DATA_IN or DATA_OUT phase. This is dealt with
55 * by setting the FIFO count early in COMMAND or MSG_IN phase.
56 *
57 * The VME variant has a bit to enable or disable the DMA engine,
58 * but that bit also gates the interrupt line from the NCR5380!
59 * Therefore, in order to get any interrupt from the 5380, (i.e.
60 * for reselect) one must clear the DMA engine transfer count and
61 * then enable DMA. This has the further complication that you
62 * CAN NOT touch the NCR5380 while the DMA enable bit is set, so
63 * we have to turn DMA back off before we even look at the 5380.
64 *
65 * What wonderfully whacky hardware this is!
66 *
67 * Credits, history:
68 *
69 * David Jones wrote the initial version of this module, which
70 * included support for the VME adapter only. (no reselection).
71 *
72 * Gordon Ross added support for the OBIO adapter, and re-worked
73 * both the VME and OBIO code to support disconnect/reselect.
74 * (Required figuring out the hardware "features" noted above.)
75 *
76 * The autoconfiguration boilerplate came from Adam Glass.
77 */
78
79 #include <sys/param.h>
80 #include <sys/systm.h>
81 #include <sys/errno.h>
82 #include <sys/kernel.h>
83 #include <sys/malloc.h>
84 #include <sys/device.h>
85 #include <sys/buf.h>
86 #include <sys/proc.h>
87 #include <sys/user.h>
88
89 #include <dev/scsipi/scsi_all.h>
90 #include <dev/scsipi/scsipi_all.h>
91 #include <dev/scsipi/scsipi_debug.h>
92 #include <dev/scsipi/scsiconf.h>
93
94 #include <machine/autoconf.h>
95 #include <machine/dvma.h>
96
97 /* #define DEBUG XXX */
98
99 #include <dev/ic/ncr5380reg.h>
100 #include <dev/ic/ncr5380var.h>
101
102 #include "sireg.h"
103 #include "sivar.h"
104
105 /*
106 * Transfers smaller than this are done using PIO
107 * (on assumption they're not worth DMA overhead)
108 */
109 #define MIN_DMA_LEN 128
110
111 int si_debug = 0;
112 #ifdef DEBUG
113 static int si_link_flags = 0 /* | SDEV_DB2 */ ;
114 #endif
115
116 /* How long to wait for DMA before declaring an error. */
117 int si_dma_intr_timo = 500; /* ticks (sec. X 100) */
118
119 static void si_minphys __P((struct buf *));
120
121 static struct scsipi_adapter si_ops = {
122 ncr5380_scsi_cmd, /* scsi_cmd() */
123 si_minphys, /* scsi_minphys() */
124 NULL, /* open_target_lu() */
125 NULL, /* close_target_lu() */
126 };
127
128 /* This is copied from julian's bt driver */
129 /* "so we have a default dev struct for our link struct." */
130 static struct scsipi_device si_dev = {
131 NULL, /* Use default error handler. */
132 NULL, /* Use default start handler. */
133 NULL, /* Use default async handler. */
134 NULL, /* Use default "done" routine. */
135 };
136
137 /*
138 * New-style autoconfig attachment. The cfattach
139 * structures are in si_obio.c and si_vme.c
140 */
141
142 struct cfdriver si_cd = {
143 NULL, "si", DV_DULL
144 };
145
146
147 void
148 si_attach(sc)
149 struct si_softc *sc;
150 {
151 struct ncr5380_softc *ncr_sc = (void *)sc;
152 volatile struct si_regs *regs = sc->sc_regs;
153 int i;
154
155 /*
156 * Support the "options" (config file flags).
157 * Disconnect/reselect is a per-target mask.
158 * Interrupts and DMA are per-controller.
159 */
160 ncr_sc->sc_no_disconnect =
161 (sc->sc_options & SI_NO_DISCONNECT);
162 ncr_sc->sc_parity_disable =
163 (sc->sc_options & SI_NO_PARITY_CHK) >> 8;
164 if (sc->sc_options & SI_FORCE_POLLING)
165 ncr_sc->sc_flags |= NCR5380_FORCE_POLLING;
166
167 #if 1 /* XXX - Temporary */
168 /* XXX - In case we think DMA is completely broken... */
169 if (sc->sc_options & SI_DISABLE_DMA) {
170 /* Override this function pointer. */
171 ncr_sc->sc_dma_alloc = NULL;
172 }
173 #endif
174 ncr_sc->sc_min_dma_len = MIN_DMA_LEN;
175
176 /*
177 * Fill in the prototype scsi_link.
178 */
179 ncr_sc->sc_link.scsipi_scsi.channel = SCSI_CHANNEL_ONLY_ONE;
180 ncr_sc->sc_link.adapter_softc = sc;
181 ncr_sc->sc_link.scsipi_scsi.adapter_target = 7;
182 ncr_sc->sc_link.adapter = &si_ops;
183 ncr_sc->sc_link.device = &si_dev;
184 ncr_sc->sc_link.type = BUS_SCSI;
185
186 #ifdef DEBUG
187 if (si_debug)
188 printf("si: Set TheSoftC=%p TheRegs=%p\n", sc, regs);
189 ncr_sc->sc_link.flags |= si_link_flags;
190 #endif
191
192 /*
193 * Initialize fields used by the MI code
194 */
195 ncr_sc->sci_r0 = ®s->sci.sci_r0;
196 ncr_sc->sci_r1 = ®s->sci.sci_r1;
197 ncr_sc->sci_r2 = ®s->sci.sci_r2;
198 ncr_sc->sci_r3 = ®s->sci.sci_r3;
199 ncr_sc->sci_r4 = ®s->sci.sci_r4;
200 ncr_sc->sci_r5 = ®s->sci.sci_r5;
201 ncr_sc->sci_r6 = ®s->sci.sci_r6;
202 ncr_sc->sci_r7 = ®s->sci.sci_r7;
203
204 /*
205 * Allocate DMA handles.
206 */
207 i = SCI_OPENINGS * sizeof(struct si_dma_handle);
208 sc->sc_dma = (struct si_dma_handle *)
209 malloc(i, M_DEVBUF, M_WAITOK);
210 if (sc->sc_dma == NULL)
211 panic("si: dvma_malloc failed\n");
212 for (i = 0; i < SCI_OPENINGS; i++)
213 sc->sc_dma[i].dh_flags = 0;
214
215 /*
216 * Initialize si board itself.
217 */
218 ncr5380_init(ncr_sc);
219 ncr5380_reset_scsibus(ncr_sc);
220 config_found(&(ncr_sc->sc_dev), &(ncr_sc->sc_link), scsiprint);
221 }
222
223 static void
224 si_minphys(struct buf *bp)
225 {
226 if (bp->b_bcount > MAX_DMA_LEN) {
227 #ifdef DEBUG
228 if (si_debug) {
229 printf("si_minphys len = 0x%x.\n", bp->b_bcount);
230 Debugger();
231 }
232 #endif
233 bp->b_bcount = MAX_DMA_LEN;
234 }
235 return (minphys(bp));
236 }
237
238
239 #define CSR_WANT (SI_CSR_SBC_IP | SI_CSR_DMA_IP | \
240 SI_CSR_DMA_CONFLICT | SI_CSR_DMA_BUS_ERR )
241
242 int
243 si_intr(void *arg)
244 {
245 struct si_softc *sc = arg;
246 volatile struct si_regs *si = sc->sc_regs;
247 int dma_error, claimed;
248 u_short csr;
249
250 claimed = 0;
251 dma_error = 0;
252
253 /* SBC interrupt? DMA interrupt? */
254 csr = si->si_csr;
255 NCR_TRACE("si_intr: csr=0x%x\n", csr);
256
257 if (csr & SI_CSR_DMA_CONFLICT) {
258 dma_error |= SI_CSR_DMA_CONFLICT;
259 printf("si_intr: DMA conflict\n");
260 }
261 if (csr & SI_CSR_DMA_BUS_ERR) {
262 dma_error |= SI_CSR_DMA_BUS_ERR;
263 printf("si_intr: DMA bus error\n");
264 }
265 if (dma_error) {
266 if (sc->ncr_sc.sc_state & NCR_DOINGDMA)
267 sc->ncr_sc.sc_state |= NCR_ABORTING;
268 /* Make sure we will call the main isr. */
269 csr |= SI_CSR_DMA_IP;
270 }
271
272 if (csr & (SI_CSR_SBC_IP | SI_CSR_DMA_IP)) {
273 claimed = ncr5380_intr(&sc->ncr_sc);
274 #ifdef DEBUG
275 if (!claimed) {
276 printf("si_intr: spurious from SBC\n");
277 if (si_debug & 4) {
278 Debugger(); /* XXX */
279 }
280 }
281 #endif
282 /* Yes, we DID cause this interrupt. */
283 claimed = 1;
284 }
285
286 return (claimed);
287 }
288
289
290 /*****************************************************************
291 * Common functions for DMA
292 ****************************************************************/
293
294 /*
295 * Allocate a DMA handle and put it in sc->sc_dma. Prepare
296 * for DMA transfer. On the Sun3, this means mapping the buffer
297 * into DVMA space. dvma_mapin() flushes the cache for us.
298 */
299 void
300 si_dma_alloc(ncr_sc)
301 struct ncr5380_softc *ncr_sc;
302 {
303 struct si_softc *sc = (struct si_softc *)ncr_sc;
304 struct sci_req *sr = ncr_sc->sc_current;
305 struct scsipi_xfer *xs = sr->sr_xs;
306 struct si_dma_handle *dh;
307 int i, xlen;
308 u_long addr;
309
310 #ifdef DIAGNOSTIC
311 if (sr->sr_dma_hand != NULL)
312 panic("si_dma_alloc: already have DMA handle");
313 #endif
314
315 addr = (u_long) ncr_sc->sc_dataptr;
316 xlen = ncr_sc->sc_datalen;
317
318 /* If the DMA start addr is misaligned then do PIO */
319 if ((addr & 1) || (xlen & 1)) {
320 printf("si_dma_alloc: misaligned.\n");
321 return;
322 }
323
324 /* Make sure our caller checked sc_min_dma_len. */
325 if (xlen < MIN_DMA_LEN)
326 panic("si_dma_alloc: xlen=0x%x\n", xlen);
327
328 /*
329 * Never attempt single transfers of more than 63k, because
330 * our count register may be only 16 bits (an OBIO adapter).
331 * This should never happen since already bounded by minphys().
332 * XXX - Should just segment these...
333 */
334 if (xlen > MAX_DMA_LEN) {
335 printf("si_dma_alloc: excessive xlen=0x%x\n", xlen);
336 Debugger();
337 ncr_sc->sc_datalen = xlen = MAX_DMA_LEN;
338 }
339
340 /* Find free DMA handle. Guaranteed to find one since we have
341 as many DMA handles as the driver has processes. */
342 for (i = 0; i < SCI_OPENINGS; i++) {
343 if ((sc->sc_dma[i].dh_flags & SIDH_BUSY) == 0)
344 goto found;
345 }
346 panic("si: no free DMA handles.");
347 found:
348
349 dh = &sc->sc_dma[i];
350 dh->dh_flags = SIDH_BUSY;
351 dh->dh_addr = (u_char*) addr;
352 dh->dh_maplen = xlen;
353 dh->dh_dvma = 0;
354
355 /* Copy the "write" flag for convenience. */
356 if (xs->flags & SCSI_DATA_OUT)
357 dh->dh_flags |= SIDH_OUT;
358
359 #if 0
360 /*
361 * Some machines might not need to remap B_PHYS buffers.
362 * The sun3 does not map B_PHYS buffers into DVMA space,
363 * (they are mapped into normal KV space) so on the sun3
364 * we must always remap to a DVMA address here. Re-map is
365 * cheap anyway, because it's done by segments, not pages.
366 */
367 if (xs->bp && (xs->bp->b_flags & B_PHYS))
368 dh->dh_flags |= SIDH_PHYS;
369 #endif
370
371 dh->dh_dvma = dvma_mapin((char *)addr, xlen, 0);
372 if (!dh->dh_dvma) {
373 /* Can't remap segment */
374 printf("si_dma_alloc: can't remap %p/0x%x\n",
375 dh->dh_addr, dh->dh_maplen);
376 dh->dh_flags = 0;
377 return;
378 }
379
380 /* success */
381 sr->sr_dma_hand = dh;
382
383 return;
384 }
385
386
387 void
388 si_dma_free(ncr_sc)
389 struct ncr5380_softc *ncr_sc;
390 {
391 struct sci_req *sr = ncr_sc->sc_current;
392 struct si_dma_handle *dh = sr->sr_dma_hand;
393
394 #ifdef DIAGNOSTIC
395 if (dh == NULL)
396 panic("si_dma_free: no DMA handle");
397 #endif
398
399 if (ncr_sc->sc_state & NCR_DOINGDMA)
400 panic("si_dma_free: free while in progress");
401
402 if (dh->dh_flags & SIDH_BUSY) {
403 /* XXX - Should separate allocation and mapping. */
404 /* Give back the DVMA space. */
405 dvma_mapout(dh->dh_dvma, dh->dh_maplen);
406 dh->dh_dvma = 0;
407 dh->dh_flags = 0;
408 }
409 sr->sr_dma_hand = NULL;
410 }
411
412
413 #define CSR_MASK (SI_CSR_SBC_IP | SI_CSR_DMA_IP | \
414 SI_CSR_DMA_CONFLICT | SI_CSR_DMA_BUS_ERR)
415 #define POLL_TIMO 50000 /* X100 = 5 sec. */
416
417 /*
418 * Poll (spin-wait) for DMA completion.
419 * Called right after xx_dma_start(), and
420 * xx_dma_stop() will be called next.
421 * Same for either VME or OBIO.
422 */
423 void
424 si_dma_poll(ncr_sc)
425 struct ncr5380_softc *ncr_sc;
426 {
427 struct si_softc *sc = (struct si_softc *)ncr_sc;
428 struct sci_req *sr = ncr_sc->sc_current;
429 volatile struct si_regs *si = sc->sc_regs;
430 int tmo;
431
432 /* Make sure DMA started successfully. */
433 if (ncr_sc->sc_state & NCR_ABORTING)
434 return;
435
436 /*
437 * XXX: The Sun driver waits for ~SI_CSR_DMA_ACTIVE here
438 * XXX: (on obio) or even worse (on vme) a 10mS. delay!
439 * XXX: I really doubt that is necessary...
440 */
441
442 /* Wait for any "dma complete" or error bits. */
443 tmo = POLL_TIMO;
444 for (;;) {
445 if (si->si_csr & CSR_MASK)
446 break;
447 if (--tmo <= 0) {
448 printf("si: DMA timeout (while polling)\n");
449 /* Indicate timeout as MI code would. */
450 sr->sr_flags |= SR_OVERDUE;
451 break;
452 }
453 delay(100);
454 }
455 NCR_TRACE("si_dma_poll: waited %d\n",
456 POLL_TIMO - tmo);
457
458 #ifdef DEBUG
459 if (si_debug & 2) {
460 printf("si_dma_poll: done, csr=0x%x\n", si->si_csr);
461 }
462 #endif
463 }
464
465