1 /* $NetBSD: si.c,v 1.39 1998/01/12 20:32:25 thorpej 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 void 143 si_attach(sc) 144 struct si_softc *sc; 145 { 146 struct ncr5380_softc *ncr_sc = (void *)sc; 147 volatile struct si_regs *regs = sc->sc_regs; 148 int i; 149 150 /* 151 * Support the "options" (config file flags). 152 * Disconnect/reselect is a per-target mask. 153 * Interrupts and DMA are per-controller. 154 */ 155 ncr_sc->sc_no_disconnect = 156 (sc->sc_options & SI_NO_DISCONNECT); 157 ncr_sc->sc_parity_disable = 158 (sc->sc_options & SI_NO_PARITY_CHK) >> 8; 159 if (sc->sc_options & SI_FORCE_POLLING) 160 ncr_sc->sc_flags |= NCR5380_FORCE_POLLING; 161 162 #if 1 /* XXX - Temporary */ 163 /* XXX - In case we think DMA is completely broken... */ 164 if (sc->sc_options & SI_DISABLE_DMA) { 165 /* Override this function pointer. */ 166 ncr_sc->sc_dma_alloc = NULL; 167 } 168 #endif 169 ncr_sc->sc_min_dma_len = MIN_DMA_LEN; 170 171 /* 172 * Fill in the prototype scsi_link. 173 */ 174 ncr_sc->sc_link.scsipi_scsi.channel = SCSI_CHANNEL_ONLY_ONE; 175 ncr_sc->sc_link.adapter_softc = sc; 176 ncr_sc->sc_link.scsipi_scsi.adapter_target = 7; 177 ncr_sc->sc_link.adapter = &si_ops; 178 ncr_sc->sc_link.device = &si_dev; 179 ncr_sc->sc_link.type = BUS_SCSI; 180 181 #ifdef DEBUG 182 if (si_debug) 183 printf("si: Set TheSoftC=%p TheRegs=%p\n", sc, regs); 184 ncr_sc->sc_link.flags |= si_link_flags; 185 #endif 186 187 /* 188 * Initialize fields used by the MI code 189 */ 190 ncr_sc->sci_r0 = ®s->sci.sci_r0; 191 ncr_sc->sci_r1 = ®s->sci.sci_r1; 192 ncr_sc->sci_r2 = ®s->sci.sci_r2; 193 ncr_sc->sci_r3 = ®s->sci.sci_r3; 194 ncr_sc->sci_r4 = ®s->sci.sci_r4; 195 ncr_sc->sci_r5 = ®s->sci.sci_r5; 196 ncr_sc->sci_r6 = ®s->sci.sci_r6; 197 ncr_sc->sci_r7 = ®s->sci.sci_r7; 198 199 /* 200 * Allocate DMA handles. 201 */ 202 i = SCI_OPENINGS * sizeof(struct si_dma_handle); 203 sc->sc_dma = (struct si_dma_handle *) 204 malloc(i, M_DEVBUF, M_WAITOK); 205 if (sc->sc_dma == NULL) 206 panic("si: dvma_malloc failed\n"); 207 for (i = 0; i < SCI_OPENINGS; i++) 208 sc->sc_dma[i].dh_flags = 0; 209 210 /* 211 * Initialize si board itself. 212 */ 213 ncr5380_init(ncr_sc); 214 ncr5380_reset_scsibus(ncr_sc); 215 config_found(&(ncr_sc->sc_dev), &(ncr_sc->sc_link), scsiprint); 216 } 217 218 static void 219 si_minphys(struct buf *bp) 220 { 221 if (bp->b_bcount > MAX_DMA_LEN) { 222 #ifdef DEBUG 223 if (si_debug) { 224 printf("si_minphys len = 0x%x.\n", bp->b_bcount); 225 Debugger(); 226 } 227 #endif 228 bp->b_bcount = MAX_DMA_LEN; 229 } 230 return (minphys(bp)); 231 } 232 233 234 #define CSR_WANT (SI_CSR_SBC_IP | SI_CSR_DMA_IP | \ 235 SI_CSR_DMA_CONFLICT | SI_CSR_DMA_BUS_ERR ) 236 237 int 238 si_intr(void *arg) 239 { 240 struct si_softc *sc = arg; 241 volatile struct si_regs *si = sc->sc_regs; 242 int dma_error, claimed; 243 u_short csr; 244 245 claimed = 0; 246 dma_error = 0; 247 248 /* SBC interrupt? DMA interrupt? */ 249 csr = si->si_csr; 250 NCR_TRACE("si_intr: csr=0x%x\n", csr); 251 252 if (csr & SI_CSR_DMA_CONFLICT) { 253 dma_error |= SI_CSR_DMA_CONFLICT; 254 printf("si_intr: DMA conflict\n"); 255 } 256 if (csr & SI_CSR_DMA_BUS_ERR) { 257 dma_error |= SI_CSR_DMA_BUS_ERR; 258 printf("si_intr: DMA bus error\n"); 259 } 260 if (dma_error) { 261 if (sc->ncr_sc.sc_state & NCR_DOINGDMA) 262 sc->ncr_sc.sc_state |= NCR_ABORTING; 263 /* Make sure we will call the main isr. */ 264 csr |= SI_CSR_DMA_IP; 265 } 266 267 if (csr & (SI_CSR_SBC_IP | SI_CSR_DMA_IP)) { 268 claimed = ncr5380_intr(&sc->ncr_sc); 269 #ifdef DEBUG 270 if (!claimed) { 271 printf("si_intr: spurious from SBC\n"); 272 if (si_debug & 4) { 273 Debugger(); /* XXX */ 274 } 275 } 276 #endif 277 /* Yes, we DID cause this interrupt. */ 278 claimed = 1; 279 } 280 281 return (claimed); 282 } 283 284 285 /***************************************************************** 286 * Common functions for DMA 287 ****************************************************************/ 288 289 /* 290 * Allocate a DMA handle and put it in sc->sc_dma. Prepare 291 * for DMA transfer. On the Sun3, this means mapping the buffer 292 * into DVMA space. dvma_mapin() flushes the cache for us. 293 */ 294 void 295 si_dma_alloc(ncr_sc) 296 struct ncr5380_softc *ncr_sc; 297 { 298 struct si_softc *sc = (struct si_softc *)ncr_sc; 299 struct sci_req *sr = ncr_sc->sc_current; 300 struct scsipi_xfer *xs = sr->sr_xs; 301 struct si_dma_handle *dh; 302 int i, xlen; 303 u_long addr; 304 305 #ifdef DIAGNOSTIC 306 if (sr->sr_dma_hand != NULL) 307 panic("si_dma_alloc: already have DMA handle"); 308 #endif 309 310 addr = (u_long) ncr_sc->sc_dataptr; 311 xlen = ncr_sc->sc_datalen; 312 313 /* If the DMA start addr is misaligned then do PIO */ 314 if ((addr & 1) || (xlen & 1)) { 315 printf("si_dma_alloc: misaligned.\n"); 316 return; 317 } 318 319 /* Make sure our caller checked sc_min_dma_len. */ 320 if (xlen < MIN_DMA_LEN) 321 panic("si_dma_alloc: xlen=0x%x\n", xlen); 322 323 /* 324 * Never attempt single transfers of more than 63k, because 325 * our count register may be only 16 bits (an OBIO adapter). 326 * This should never happen since already bounded by minphys(). 327 * XXX - Should just segment these... 328 */ 329 if (xlen > MAX_DMA_LEN) { 330 printf("si_dma_alloc: excessive xlen=0x%x\n", xlen); 331 Debugger(); 332 ncr_sc->sc_datalen = xlen = MAX_DMA_LEN; 333 } 334 335 /* Find free DMA handle. Guaranteed to find one since we have 336 as many DMA handles as the driver has processes. */ 337 for (i = 0; i < SCI_OPENINGS; i++) { 338 if ((sc->sc_dma[i].dh_flags & SIDH_BUSY) == 0) 339 goto found; 340 } 341 panic("si: no free DMA handles."); 342 found: 343 344 dh = &sc->sc_dma[i]; 345 dh->dh_flags = SIDH_BUSY; 346 dh->dh_addr = (u_char*) addr; 347 dh->dh_maplen = xlen; 348 dh->dh_dvma = 0; 349 350 /* Copy the "write" flag for convenience. */ 351 if (xs->flags & SCSI_DATA_OUT) 352 dh->dh_flags |= SIDH_OUT; 353 354 #if 0 355 /* 356 * Some machines might not need to remap B_PHYS buffers. 357 * The sun3 does not map B_PHYS buffers into DVMA space, 358 * (they are mapped into normal KV space) so on the sun3 359 * we must always remap to a DVMA address here. Re-map is 360 * cheap anyway, because it's done by segments, not pages. 361 */ 362 if (xs->bp && (xs->bp->b_flags & B_PHYS)) 363 dh->dh_flags |= SIDH_PHYS; 364 #endif 365 366 dh->dh_dvma = dvma_mapin((char *)addr, xlen, 0); 367 if (!dh->dh_dvma) { 368 /* Can't remap segment */ 369 printf("si_dma_alloc: can't remap %p/0x%x\n", 370 dh->dh_addr, dh->dh_maplen); 371 dh->dh_flags = 0; 372 return; 373 } 374 375 /* success */ 376 sr->sr_dma_hand = dh; 377 378 return; 379 } 380 381 382 void 383 si_dma_free(ncr_sc) 384 struct ncr5380_softc *ncr_sc; 385 { 386 struct sci_req *sr = ncr_sc->sc_current; 387 struct si_dma_handle *dh = sr->sr_dma_hand; 388 389 #ifdef DIAGNOSTIC 390 if (dh == NULL) 391 panic("si_dma_free: no DMA handle"); 392 #endif 393 394 if (ncr_sc->sc_state & NCR_DOINGDMA) 395 panic("si_dma_free: free while in progress"); 396 397 if (dh->dh_flags & SIDH_BUSY) { 398 /* XXX - Should separate allocation and mapping. */ 399 /* Give back the DVMA space. */ 400 dvma_mapout(dh->dh_dvma, dh->dh_maplen); 401 dh->dh_dvma = 0; 402 dh->dh_flags = 0; 403 } 404 sr->sr_dma_hand = NULL; 405 } 406 407 408 #define CSR_MASK (SI_CSR_SBC_IP | SI_CSR_DMA_IP | \ 409 SI_CSR_DMA_CONFLICT | SI_CSR_DMA_BUS_ERR) 410 #define POLL_TIMO 50000 /* X100 = 5 sec. */ 411 412 /* 413 * Poll (spin-wait) for DMA completion. 414 * Called right after xx_dma_start(), and 415 * xx_dma_stop() will be called next. 416 * Same for either VME or OBIO. 417 */ 418 void 419 si_dma_poll(ncr_sc) 420 struct ncr5380_softc *ncr_sc; 421 { 422 struct si_softc *sc = (struct si_softc *)ncr_sc; 423 struct sci_req *sr = ncr_sc->sc_current; 424 volatile struct si_regs *si = sc->sc_regs; 425 int tmo; 426 427 /* Make sure DMA started successfully. */ 428 if (ncr_sc->sc_state & NCR_ABORTING) 429 return; 430 431 /* 432 * XXX: The Sun driver waits for ~SI_CSR_DMA_ACTIVE here 433 * XXX: (on obio) or even worse (on vme) a 10mS. delay! 434 * XXX: I really doubt that is necessary... 435 */ 436 437 /* Wait for any "dma complete" or error bits. */ 438 tmo = POLL_TIMO; 439 for (;;) { 440 if (si->si_csr & CSR_MASK) 441 break; 442 if (--tmo <= 0) { 443 printf("si: DMA timeout (while polling)\n"); 444 /* Indicate timeout as MI code would. */ 445 sr->sr_flags |= SR_OVERDUE; 446 break; 447 } 448 delay(100); 449 } 450 NCR_TRACE("si_dma_poll: waited %d\n", 451 POLL_TIMO - tmo); 452 453 #ifdef DEBUG 454 if (si_debug & 2) { 455 printf("si_dma_poll: done, csr=0x%x\n", si->si_csr); 456 } 457 #endif 458 } 459 460