2 * Copyright (c) 1997-2006 by Matthew Jacob
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice immediately at the beginning of the file, without modification,
10 * this list of conditions, and the following disclaimer.
11 * 2. The name of the author may not be used to endorse or promote products
12 * derived from this software without specific prior written permission.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
18 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SBus specific probe and attach routines for Qlogic ISP SCSI adapters.
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/linker.h>
37 #include <sys/firmware.h>
39 #include <sys/kernel.h>
40 #include <sys/module.h>
41 #include <sys/resource.h>
43 #include <dev/ofw/ofw_bus.h>
44 #include <dev/ofw/openfirm.h>
46 #include <machine/bus.h>
47 #include <machine/ofw_machdep.h>
48 #include <machine/resource.h>
50 #include <sparc64/sbus/sbusvar.h>
52 #include <dev/isp/isp_freebsd.h>
54 static uint32_t isp_sbus_rd_reg(ispsoftc_t *, int);
55 static void isp_sbus_wr_reg(ispsoftc_t *, int, uint32_t);
56 static int isp_sbus_rd_isr(ispsoftc_t *, uint16_t *, uint16_t *, uint16_t *);
57 static int isp_sbus_mbxdma(ispsoftc_t *);
58 static int isp_sbus_dmasetup(ispsoftc_t *, XS_T *, void *);
61 static void isp_sbus_reset0(ispsoftc_t *);
62 static void isp_sbus_reset1(ispsoftc_t *);
63 static void isp_sbus_dumpregs(ispsoftc_t *, const char *);
65 static struct ispmdvec mdvec = {
71 isp_common_dmateardown,
76 BIU_BURST_ENABLE|BIU_PCI_CONF1_FIFO_64
79 static int isp_sbus_probe (device_t);
80 static int isp_sbus_attach (device_t);
81 static int isp_sbus_detach (device_t);
84 #define ISP_SBD(isp) ((struct isp_sbussoftc *)isp)->sbus_dev
85 struct isp_sbussoftc {
88 struct resource * regs;
93 int16_t sbus_poff[_NREG_BLKS];
95 struct isp_spi sbus_spi;
96 struct ispmdvec sbus_mdvec;
100 static device_method_t isp_sbus_methods[] = {
101 /* Device interface */
102 DEVMETHOD(device_probe, isp_sbus_probe),
103 DEVMETHOD(device_attach, isp_sbus_attach),
104 DEVMETHOD(device_detach, isp_sbus_detach),
108 static driver_t isp_sbus_driver = {
109 "isp", isp_sbus_methods, sizeof (struct isp_sbussoftc)
111 static devclass_t isp_devclass;
112 DRIVER_MODULE(isp, sbus, isp_sbus_driver, isp_devclass, 0, 0);
113 MODULE_DEPEND(isp, cam, 1, 1, 1);
114 MODULE_DEPEND(isp, firmware, 1, 1, 1);
117 isp_sbus_probe(device_t dev)
120 const char *name = ofw_bus_get_name(dev);
121 if (strcmp(name, "SUNW,isp") == 0 ||
122 strcmp(name, "QLGC,isp") == 0 ||
123 strcmp(name, "ptisp") == 0 ||
124 strcmp(name, "PTI,ptisp") == 0) {
130 if (isp_announced == 0 && bootverbose) {
131 printf("Qlogic ISP Driver, FreeBSD Version %d.%d, "
132 "Core Version %d.%d\n",
133 ISP_PLATFORM_VERSION_MAJOR, ISP_PLATFORM_VERSION_MINOR,
134 ISP_CORE_VERSION_MAJOR, ISP_CORE_VERSION_MINOR);
141 isp_sbus_attach(device_t dev)
143 int tval, isp_debug, role, ispburst, default_id;
144 struct isp_sbussoftc *sbs;
145 ispsoftc_t *isp = NULL;
149 sbs = device_get_softc(dev);
151 device_printf(dev, "cannot get softc\n");
156 sbs->sbus_mdvec = mdvec;
159 * Figure out if we're supposed to skip this one.
160 * If we are, we actually go to ISP_ROLE_NONE.
164 if (resource_int_value(device_get_name(dev), device_get_unit(dev),
165 "disable", &tval) == 0 && tval) {
166 device_printf(dev, "device is disabled\n");
167 /* but return 0 so the !$)$)*!$*) unit isn't reused */
172 if (resource_int_value(device_get_name(dev), device_get_unit(dev),
173 "role", &role) == 0 &&
174 ((role & ~(ISP_ROLE_INITIATOR|ISP_ROLE_TARGET)) == 0)) {
175 device_printf(dev, "setting role to 0x%x\n", role);
177 role = ISP_DEFAULT_ROLES;
180 sbs->irq = sbs->regs = NULL;
181 sbs->rgd = sbs->iqd = 0;
183 sbs->regs = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &sbs->rgd,
185 if (sbs->regs == NULL) {
186 device_printf(dev, "unable to map registers\n");
190 sbs->sbus_poff[BIU_BLOCK >> _BLK_REG_SHFT] = BIU_REGS_OFF;
191 sbs->sbus_poff[MBOX_BLOCK >> _BLK_REG_SHFT] = SBUS_MBOX_REGS_OFF;
192 sbs->sbus_poff[SXP_BLOCK >> _BLK_REG_SHFT] = SBUS_SXP_REGS_OFF;
193 sbs->sbus_poff[RISC_BLOCK >> _BLK_REG_SHFT] = SBUS_RISC_REGS_OFF;
194 sbs->sbus_poff[DMA_BLOCK >> _BLK_REG_SHFT] = DMA_REGS_OFF;
195 isp = &sbs->sbus_isp;
196 isp->isp_bus_tag = rman_get_bustag(sbs->regs);
197 isp->isp_bus_handle = rman_get_bushandle(sbs->regs);
198 isp->isp_mdvec = &sbs->sbus_mdvec;
199 isp->isp_bustype = ISP_BT_SBUS;
200 isp->isp_type = ISP_HA_SCSI_UNKNOWN;
201 isp->isp_param = &sbs->sbus_param;
202 isp->isp_osinfo.pc.ptr = &sbs->sbus_spi;
203 isp->isp_revision = 0; /* XXX */
206 ISP_SET_PC(isp, 0, def_role, role);
209 * Get the clock frequency and convert it from HZ to MHz,
210 * rounding up. This defaults to 25MHz if there isn't a
211 * device specific one in the OFW device tree.
213 sbs->sbus_mdvec.dv_clock = (sbus_get_clockfreq(dev) + 500000)/1000000;
216 * Now figure out what the proper burst sizes, etc., to use.
217 * Unfortunately, there is no ddi_dma_burstsizes here which
218 * walks up the tree finding the limiting burst size node (if
219 * any). We just use what's here for isp.
221 ispburst = sbus_get_burstsz(dev);
223 ispburst = SBUS_BURST_32 - 1;
225 sbs->sbus_mdvec.dv_conf1 = 0;
226 if (ispburst & (1 << 5)) {
227 sbs->sbus_mdvec.dv_conf1 = BIU_SBUS_CONF1_FIFO_32;
228 } else if (ispburst & (1 << 4)) {
229 sbs->sbus_mdvec.dv_conf1 = BIU_SBUS_CONF1_FIFO_16;
230 } else if (ispburst & (1 << 3)) {
231 sbs->sbus_mdvec.dv_conf1 =
232 BIU_SBUS_CONF1_BURST8 | BIU_SBUS_CONF1_FIFO_8;
234 if (sbs->sbus_mdvec.dv_conf1) {
235 sbs->sbus_mdvec.dv_conf1 |= BIU_BURST_ENABLE;
239 * We don't trust NVRAM on SBus cards
241 isp->isp_confopts |= ISP_CFG_NONVRAM;
244 * Mark things if we're a PTI SBus adapter.
246 if (strcmp("PTI,ptisp", ofw_bus_get_name(dev)) == 0 ||
247 strcmp("ptisp", ofw_bus_get_name(dev)) == 0) {
248 SDPARAM(isp, 0)->isp_ptisp = 1;
251 isp->isp_osinfo.fw = firmware_get("isp_1000");
252 if (isp->isp_osinfo.fw) {
257 stupid.cp = isp->isp_osinfo.fw->data;
258 isp->isp_mdvec->dv_ispfw = stupid.sp;
262 if (resource_int_value(device_get_name(dev), device_get_unit(dev),
263 "fwload_disable", &tval) == 0 && tval != 0) {
264 isp->isp_confopts |= ISP_CFG_NORELOAD;
268 if (resource_int_value(device_get_name(dev), device_get_unit(dev),
269 "iid", &tval) == 0) {
271 isp->isp_confopts |= ISP_CFG_OWNLOOPID;
273 if (default_id == -1) {
274 default_id = OF_getscsinitid(dev);
276 ISP_SPI_PC(isp, 0)->iid = default_id;
279 (void) resource_int_value(device_get_name(dev), device_get_unit(dev),
280 "debug", &isp_debug);
282 /* Make sure the lock is set up. */
283 mtx_init(&isp->isp_osinfo.lock, "isp", NULL, MTX_DEF);
286 sbs->irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &sbs->iqd,
287 RF_ACTIVE | RF_SHAREABLE);
288 if (sbs->irq == NULL) {
289 device_printf(dev, "could not allocate interrupt\n");
293 if (isp_setup_intr(dev, sbs->irq, ISP_IFLAGS, NULL, isp_platform_intr,
295 device_printf(dev, "could not setup interrupt\n");
301 * Set up logging levels.
304 isp->isp_dblev = isp_debug;
306 isp->isp_dblev = ISP_LOGWARN|ISP_LOGERR;
309 isp->isp_dblev |= ISP_LOGCONFIG|ISP_LOGINFO;
313 * Make sure we're in reset state.
316 if (isp_reinit(isp, 1) != 0) {
322 if (isp_attach(isp)) {
332 if (sbs && ints_setup) {
333 (void) bus_teardown_intr(dev, sbs->irq, sbs->ih);
336 if (sbs && sbs->irq) {
337 bus_release_resource(dev, SYS_RES_IRQ, sbs->iqd, sbs->irq);
340 if (locksetup && isp) {
341 mtx_destroy(&isp->isp_osinfo.lock);
345 (void) bus_release_resource(dev, SYS_RES_MEMORY, sbs->rgd,
352 isp_sbus_detach(device_t dev)
354 struct isp_sbussoftc *sbs;
358 sbs = device_get_softc(dev);
362 isp = (ispsoftc_t *) sbs;
363 status = isp_detach(isp);
369 (void) bus_teardown_intr(dev, sbs->irq, sbs->ih);
372 mtx_destroy(&isp->isp_osinfo.lock);
373 (void) bus_release_resource(dev, SYS_RES_IRQ, sbs->iqd, sbs->irq);
374 (void) bus_release_resource(dev, SYS_RES_MEMORY, sbs->rgd, sbs->regs);
378 #define IspVirt2Off(a, x) \
379 (((struct isp_sbussoftc *)a)->sbus_poff[((x) & _BLK_REG_MASK) >> \
380 _BLK_REG_SHFT] + ((x) & 0xff))
382 #define BXR2(sbc, off) \
383 bus_space_read_2(isp->isp_bus_tag, isp->isp_bus_handle, off)
386 isp_sbus_rd_isr(ispsoftc_t *isp, uint16_t *isrp, uint16_t *semap, uint16_t *info)
390 isr = BXR2(sbc, IspVirt2Off(isp, BIU_ISR));
391 sema = BXR2(sbc, IspVirt2Off(isp, BIU_SEMA));
392 isp_prt(isp, ISP_LOGDEBUG3, "ISR 0x%x SEMA 0x%x", isr, sema);
393 isr &= INT_PENDING_MASK(isp);
394 sema &= BIU_SEMA_LOCK;
395 if (isr == 0 && sema == 0) {
399 if ((*semap = sema) != 0)
400 *info = BXR2(sbc, IspVirt2Off(isp, OUTMAILBOX0));
405 isp_sbus_rd_reg(ispsoftc_t *isp, int regoff)
408 struct isp_sbussoftc *sbs = (struct isp_sbussoftc *) isp;
409 int offset = sbs->sbus_poff[(regoff & _BLK_REG_MASK) >> _BLK_REG_SHFT];
410 offset += (regoff & 0xff);
411 rval = bus_space_read_2(isp->isp_bus_tag, isp->isp_bus_handle, offset);
412 isp_prt(isp, ISP_LOGDEBUG3,
413 "isp_sbus_rd_reg(off %x) = %x", regoff, rval);
418 isp_sbus_wr_reg(ispsoftc_t *isp, int regoff, uint32_t val)
420 struct isp_sbussoftc *sbs = (struct isp_sbussoftc *) isp;
421 int offset = sbs->sbus_poff[(regoff & _BLK_REG_MASK) >> _BLK_REG_SHFT];
422 offset += (regoff & 0xff);
423 isp_prt(isp, ISP_LOGDEBUG3,
424 "isp_sbus_wr_reg(off %x) = %x", regoff, val);
425 bus_space_write_2(isp->isp_bus_tag, isp->isp_bus_handle, offset, val);
426 MEMORYBARRIER(isp, SYNC_REG, offset, 2, -1);
434 static void imc(void *, bus_dma_segment_t *, int, int);
437 imc(void *arg, bus_dma_segment_t *segs, int nseg, int error)
439 struct imush *imushp = (struct imush *) arg;
441 imushp->error = error;
443 ispsoftc_t *isp =imushp->isp;
444 bus_addr_t addr = segs->ds_addr;
446 isp->isp_rquest_dma = addr;
447 addr += ISP_QUEUE_SIZE(RQUEST_QUEUE_LEN(isp));
448 isp->isp_result_dma = addr;
453 isp_sbus_mbxdma(ispsoftc_t *isp)
461 * Already been here? If so, leave...
463 if (isp->isp_rquest) {
469 len = sizeof (struct isp_pcmd) * isp->isp_maxcmds;
470 isp->isp_osinfo.pcmd_pool = (struct isp_pcmd *)
471 malloc(len, M_DEVBUF, M_WAITOK | M_ZERO);
472 if (isp->isp_osinfo.pcmd_pool == NULL) {
473 isp_prt(isp, ISP_LOGERR, "cannot alloc pcmd pool");
478 len = sizeof (isp_hdl_t *) * isp->isp_maxcmds;
479 isp->isp_xflist = (isp_hdl_t *) malloc(len, M_DEVBUF, M_WAITOK | M_ZERO);
480 if (isp->isp_xflist == NULL) {
481 isp_prt(isp, ISP_LOGERR, "cannot alloc xflist array");
485 for (len = 0; len < isp->isp_maxcmds - 1; len++) {
486 isp->isp_xflist[len].cmd = &isp->isp_xflist[len+1];
488 isp->isp_xffree = isp->isp_xflist;
489 len = sizeof (bus_dmamap_t) * isp->isp_maxcmds;
491 if (isp_dma_tag_create(BUS_DMA_ROOTARG(ISP_SBD(isp)), 1,
492 BUS_SPACE_MAXADDR_24BIT+1, BUS_SPACE_MAXADDR_32BIT,
493 BUS_SPACE_MAXADDR_32BIT, NULL, NULL, BUS_SPACE_MAXSIZE_32BIT,
494 ISP_NSEG_MAX, BUS_SPACE_MAXADDR_24BIT, 0, &isp->isp_osinfo.dmat)) {
495 isp_prt(isp, ISP_LOGERR, "could not create master dma tag");
496 free(isp->isp_osinfo.pcmd_pool, M_DEVBUF);
497 free(isp->isp_xflist, M_DEVBUF);
503 * Allocate and map the request, result queues, plus FC scratch area.
505 len = ISP_QUEUE_SIZE(RQUEST_QUEUE_LEN(isp));
506 len += ISP_QUEUE_SIZE(RESULT_QUEUE_LEN(isp));
508 if (isp_dma_tag_create(isp->isp_osinfo.dmat, QENTRY_LEN,
509 BUS_SPACE_MAXADDR_24BIT+1, BUS_SPACE_MAXADDR_32BIT,
510 BUS_SPACE_MAXADDR_32BIT, NULL, NULL, len, 1,
511 BUS_SPACE_MAXADDR_24BIT, 0, &isp->isp_osinfo.cdmat)) {
512 isp_prt(isp, ISP_LOGERR,
513 "cannot create a dma tag for control spaces");
514 free(isp->isp_osinfo.pcmd_pool, M_DEVBUF);
515 free(isp->isp_xflist, M_DEVBUF);
520 if (bus_dmamem_alloc(isp->isp_osinfo.cdmat, (void **)&base, BUS_DMA_NOWAIT | BUS_DMA_COHERENT,
521 &isp->isp_osinfo.cdmap) != 0) {
522 isp_prt(isp, ISP_LOGERR,
523 "cannot allocate %d bytes of CCB memory", len);
524 bus_dma_tag_destroy(isp->isp_osinfo.cdmat);
525 free(isp->isp_osinfo.pcmd_pool, M_DEVBUF);
526 free(isp->isp_xflist, M_DEVBUF);
531 for (i = 0; i < isp->isp_maxcmds; i++) {
532 struct isp_pcmd *pcmd = &isp->isp_osinfo.pcmd_pool[i];
533 error = bus_dmamap_create(isp->isp_osinfo.dmat, 0, &pcmd->dmap);
535 isp_prt(isp, ISP_LOGERR,
536 "error %d creating per-cmd DMA maps", error);
538 bus_dmamap_destroy(isp->isp_osinfo.dmat,
539 isp->isp_osinfo.pcmd_pool[i].dmap);
543 callout_init_mtx(&pcmd->wdog, &isp->isp_osinfo.lock, 0);
544 if (i == isp->isp_maxcmds-1) {
547 pcmd->next = &isp->isp_osinfo.pcmd_pool[i+1];
550 isp->isp_osinfo.pcmd_free = &isp->isp_osinfo.pcmd_pool[0];
554 bus_dmamap_load(isp->isp_osinfo.cdmat, isp->isp_osinfo.cdmap, base, len, imc, &im, 0);
556 isp_prt(isp, ISP_LOGERR,
557 "error %d loading dma map for control areas", im.error);
561 isp->isp_rquest = base;
562 base += ISP_QUEUE_SIZE(RQUEST_QUEUE_LEN(isp));
563 isp->isp_result = base;
568 bus_dmamem_free(isp->isp_osinfo.cdmat, base, isp->isp_osinfo.cdmap);
569 bus_dma_tag_destroy(isp->isp_osinfo.cdmat);
570 free(isp->isp_xflist, M_DEVBUF);
571 free(isp->isp_osinfo.pcmd_pool, M_DEVBUF);
572 isp->isp_rquest = NULL;
580 void *rq; /* original request */
585 #define MUSHERR_NOQENTRIES -2
587 static void dma2(void *, bus_dma_segment_t *, int, int);
590 dma2(void *arg, bus_dma_segment_t *dm_segs, int nseg, int error)
594 struct ccb_scsiio *csio;
603 csio = mp->cmd_token;
607 if ((csio->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_IN) {
608 bus_dmamap_sync(isp->isp_osinfo.dmat, PISP_PCMD(csio)->dmap, BUS_DMASYNC_PREREAD);
609 ddir = ISP_FROM_DEVICE;
610 } else if ((csio->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_OUT) {
611 bus_dmamap_sync(isp->isp_osinfo.dmat, PISP_PCMD(csio)->dmap, BUS_DMASYNC_PREWRITE);
612 ddir = ISP_TO_DEVICE;
622 if (isp_send_cmd(isp, rq, dm_segs, nseg, XS_XFRLEN(csio), ddir, NULL) != CMD_QUEUED) {
623 mp->error = MUSHERR_NOQENTRIES;
628 isp_sbus_dmasetup(ispsoftc_t *isp, struct ccb_scsiio *csio, void *ff)
631 void (*eptr)(void *, bus_dma_segment_t *, int, int);
636 mp->cmd_token = csio;
643 error = bus_dmamap_load_ccb(isp->isp_osinfo.dmat,
644 PISP_PCMD(csio)->dmap, (union ccb *)csio, eptr, mp, 0);
645 if (error == EINPROGRESS) {
646 bus_dmamap_unload(isp->isp_osinfo.dmat, PISP_PCMD(csio)->dmap);
648 isp_prt(isp, ISP_LOGERR,
649 "deferred dma allocation not supported");
650 } else if (error && mp->error == 0) {
652 isp_prt(isp, ISP_LOGERR, "error %d in dma mapping code", error);
657 int retval = CMD_COMPLETE;
658 if (mp->error == MUSHERR_NOQENTRIES) {
660 } else if (mp->error == EFBIG) {
661 XS_SETERR(csio, CAM_REQ_TOO_BIG);
662 } else if (mp->error == EINVAL) {
663 XS_SETERR(csio, CAM_REQ_INVALID);
665 XS_SETERR(csio, CAM_UNREC_HBA_ERROR);
673 isp_sbus_reset0(ispsoftc_t *isp)
675 ISP_DISABLE_INTS(isp);
679 isp_sbus_reset1(ispsoftc_t *isp)
681 ISP_ENABLE_INTS(isp);
685 isp_sbus_dumpregs(ispsoftc_t *isp, const char *msg)
688 printf("%s: %s\n", device_get_nameunit(isp->isp_dev), msg);
690 printf("%s:\n", device_get_nameunit(isp->isp_dev));
691 printf(" biu_conf1=%x", ISP_READ(isp, BIU_CONF1));
692 printf(" biu_icr=%x biu_isr=%x biu_sema=%x ", ISP_READ(isp, BIU_ICR),
693 ISP_READ(isp, BIU_ISR), ISP_READ(isp, BIU_SEMA));
694 printf("risc_hccr=%x\n", ISP_READ(isp, HCCR));
697 ISP_WRITE(isp, HCCR, HCCR_CMD_PAUSE);
698 printf(" cdma_conf=%x cdma_sts=%x cdma_fifostat=%x\n",
699 ISP_READ(isp, CDMA_CONF), ISP_READ(isp, CDMA_STATUS),
700 ISP_READ(isp, CDMA_FIFO_STS));
701 printf(" ddma_conf=%x ddma_sts=%x ddma_fifostat=%x\n",
702 ISP_READ(isp, DDMA_CONF), ISP_READ(isp, DDMA_STATUS),
703 ISP_READ(isp, DDMA_FIFO_STS));
704 printf(" sxp_int=%x sxp_gross=%x sxp(scsi_ctrl)=%x\n",
705 ISP_READ(isp, SXP_INTERRUPT),
706 ISP_READ(isp, SXP_GROSS_ERR),
707 ISP_READ(isp, SXP_PINS_CTRL));
708 ISP_WRITE(isp, HCCR, HCCR_CMD_RELEASE);
709 printf(" mbox regs: %x %x %x %x %x\n",
710 ISP_READ(isp, OUTMAILBOX0), ISP_READ(isp, OUTMAILBOX1),
711 ISP_READ(isp, OUTMAILBOX2), ISP_READ(isp, OUTMAILBOX3),
712 ISP_READ(isp, OUTMAILBOX4));