3 * Qlogic ISP SCSI Host Adapter FreeBSD Wrapper Definitions
5 * Copyright (c) 1997-2008 by Matthew Jacob
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice immediately at the beginning of the file, without modification,
13 * this list of conditions, and the following disclaimer.
14 * 2. The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
21 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #ifndef _ISP_FREEBSD_H
30 #define _ISP_FREEBSD_H
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/endian.h>
36 #include <sys/kernel.h>
37 #include <sys/queue.h>
38 #include <sys/malloc.h>
39 #include <sys/mutex.h>
40 #include <sys/condvar.h>
45 #include <machine/bus.h>
46 #include <machine/cpu.h>
47 #include <machine/stdarg.h>
50 #include <cam/cam_debug.h>
51 #include <cam/cam_ccb.h>
52 #include <cam/cam_sim.h>
53 #include <cam/cam_xpt.h>
54 #include <cam/cam_xpt_sim.h>
55 #include <cam/cam_debug.h>
56 #include <cam/scsi/scsi_all.h>
57 #include <cam/scsi/scsi_message.h>
62 #define ISP_PLATFORM_VERSION_MAJOR 7
63 #define ISP_PLATFORM_VERSION_MINOR 0
66 * Efficiency- get rid of SBus code && tests unless we need them.
69 #define ISP_SBUS_SUPPORTED 1
71 #define ISP_SBUS_SUPPORTED 0
74 #define ISP_IFLAGS INTR_TYPE_CAM | INTR_ENTROPY | INTR_MPSAFE
76 #ifdef ISP_TARGET_MODE
77 #define ISP_TARGET_FUNCTIONS 1
78 #define ATPDPSIZE 4096
80 #include <dev/isp/isp_target.h>
84 uint32_t orig_datalen;
85 uint32_t bytes_xfered;
99 } atio_private_data_t;
100 #define ATPD_STATE_FREE 0
101 #define ATPD_STATE_ATIO 1
102 #define ATPD_STATE_CAM 2
103 #define ATPD_STATE_CTIO 3
104 #define ATPD_STATE_LAST_CTIO 4
105 #define ATPD_STATE_PDON 5
107 typedef union inot_private_data inot_private_data_t;
108 union inot_private_data {
109 inot_private_data_t *next;
111 isp_notify_t nt; /* must be first! */
112 uint8_t data[64]; /* sb QENTRY_LEN, but order of definitions is wrong */
113 uint32_t tag_id, seq_id;
117 typedef struct tstate {
118 SLIST_ENTRY(tstate) next;
119 struct cam_path *owner;
120 struct ccb_hdr_slist atios;
121 struct ccb_hdr_slist inots;
125 inot_private_data_t * restart_queue;
126 inot_private_data_t * ntfree;
127 inot_private_data_t ntpool[ATPDPSIZE];
128 atio_private_data_t * atfree;
129 atio_private_data_t atpool[ATPDPSIZE];
132 #define LUN_HASH_SIZE 32
133 #define LUN_HASH_FUNC(lun) ((lun) & (LUN_HASH_SIZE - 1))
141 struct isp_pcmd * next;
142 bus_dmamap_t dmap; /* dma map for this command */
143 struct ispsoftc * isp; /* containing isp */
144 struct callout wdog; /* watchdog timer */
146 #define ISP_PCMD(ccb) (ccb)->ccb_h.spriv_ptr1
147 #define PISP_PCMD(ccb) ((struct isp_pcmd *)ISP_PCMD(ccb))
150 * Per channel information
152 SLIST_HEAD(tslist, tstate);
156 struct cam_path *path;
157 struct ispsoftc *isp;
163 uint32_t loop_down_time;
164 uint32_t loop_down_limit;
165 uint32_t gone_device_time;
167 #ifdef ISP_TARGET_MODE
168 #ifdef ISP_INTERNAL_TARGET
178 def_role : 2, /* default role */
183 struct callout ldt; /* loop down timer */
184 struct callout gdt; /* gone device timer */
185 #ifdef ISP_TARGET_MODE
186 struct tslist lun_hash[LUN_HASH_SIZE];
187 #ifdef ISP_INTERNAL_TARGET
188 struct proc * target_proc;
195 struct cam_path *path;
197 #ifdef ISP_TARGET_MODE
198 #ifdef ISP_INTERNAL_TARGET
208 #ifdef ISP_TARGET_MODE
209 struct tslist lun_hash[LUN_HASH_SIZE];
210 #ifdef ISP_INTERNAL_TARGET
211 struct proc * target_proc;
218 * Linkage, locking, and identity
223 struct intr_config_hook ehook;
224 struct cam_devq * devq;
229 const struct firmware * fw;
234 bus_space_tag_t bus_tag;
236 bus_space_handle_t bus_handle;
241 * Command and transaction related related stuff
243 struct isp_pcmd * pcmd_pool;
244 struct isp_pcmd * pcmd_free;
247 #ifdef ISP_TARGET_MODE
263 struct callout tmo; /* general timer */
266 * misc- needs to be sorted better XXXXXX
272 #ifdef ISP_TARGET_MODE
277 * Per-type private storage...
285 #define ISP_FC_PC(isp, chan) (&(isp)->isp_osinfo.pc.fc[(chan)])
286 #define ISP_SPI_PC(isp, chan) (&(isp)->isp_osinfo.pc.spi[(chan)])
287 #define ISP_GET_PC(isp, chan, tag, rslt) \
288 if (IS_SCSI(isp)) { \
289 rslt = ISP_SPI_PC(isp, chan)-> tag; \
291 rslt = ISP_FC_PC(isp, chan)-> tag; \
293 #define ISP_GET_PC_ADDR(isp, chan, tag, rp) \
294 if (IS_SCSI(isp)) { \
295 rp = &ISP_SPI_PC(isp, chan)-> tag; \
297 rp = &ISP_FC_PC(isp, chan)-> tag; \
299 #define ISP_SET_PC(isp, chan, tag, val) \
300 if (IS_SCSI(isp)) { \
301 ISP_SPI_PC(isp, chan)-> tag = val; \
303 ISP_FC_PC(isp, chan)-> tag = val; \
306 #define isp_lock isp_osinfo.lock
307 #define isp_bus_tag isp_osinfo.bus_tag
308 #define isp_bus_handle isp_osinfo.bus_handle
313 #define ISP_LOCK(isp) mtx_lock(&isp->isp_osinfo.lock)
314 #define ISP_UNLOCK(isp) mtx_unlock(&isp->isp_osinfo.lock)
317 * Required Macros/Defines
320 #define ISP_FC_SCRLEN 0x1000
322 #define ISP_MEMZERO(a, b) memset(a, 0, b)
323 #define ISP_MEMCPY memcpy
324 #define ISP_SNPRINTF snprintf
325 #define ISP_DELAY DELAY
326 #define ISP_SLEEP(isp, x) DELAY(x)
329 #define ISP_INLINE __inline
334 #define NANOTIME_T struct timespec
335 #define GET_NANOTIME nanotime
336 #define GET_NANOSEC(x) ((x)->tv_sec * 1000000000 + (x)->tv_nsec)
337 #define NANOTIME_SUB isp_nanotime_sub
339 #define MAXISPREQUEST(isp) ((IS_FC(isp) || IS_ULTRA2(isp))? 1024 : 256)
341 #define MEMORYBARRIER(isp, type, offset, size) \
345 bus_dmamap_sync(isp->isp_osinfo.cdmat, \
346 isp->isp_osinfo.cdmap, \
347 BUS_DMASYNC_PREREAD | BUS_DMASYNC_PREWRITE); \
351 bus_dmamap_sync(isp->isp_osinfo.cdmat, \
352 isp->isp_osinfo.cdmap, \
353 BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE); \
356 bus_space_barrier(isp->isp_osinfo.bus_tag, \
357 isp->isp_osinfo.bus_handle, offset, size, \
358 BUS_SPACE_BARRIER_READ); \
364 #define MBOX_ACQUIRE isp_mbox_acquire
365 #define MBOX_WAIT_COMPLETE isp_mbox_wait_complete
366 #define MBOX_NOTIFY_COMPLETE isp_mbox_notify_done
367 #define MBOX_RELEASE isp_mbox_release
369 #define FC_SCRATCH_ACQUIRE isp_fc_scratch_acquire
370 #define FC_SCRATCH_RELEASE(isp, chan) isp->isp_osinfo.pc.fc[chan].fcbsy = 0
373 #define SCSI_GOOD SCSI_STATUS_OK
376 #define SCSI_CHECK SCSI_STATUS_CHECK_COND
379 #define SCSI_BUSY SCSI_STATUS_BUSY
382 #define SCSI_QFULL SCSI_STATUS_QUEUE_FULL
385 #define XS_T struct ccb_scsiio
386 #define XS_DMA_ADDR_T bus_addr_t
387 #define XS_GET_DMA64_SEG(a, b, c) \
390 bus_dma_segment_t *e = b; \
393 d->ds_base = DMA_LO32(e->ds_addr); \
394 d->ds_basehi = DMA_HI32(e->ds_addr); \
395 d->ds_count = e->ds_len; \
397 #define XS_GET_DMA_SEG(a, b, c) \
400 bus_dma_segment_t *e = b; \
403 d->ds_base = DMA_LO32(e->ds_addr); \
404 d->ds_count = e->ds_len; \
406 #define XS_ISP(ccb) cam_sim_softc(xpt_path_sim((ccb)->ccb_h.path))
407 #define XS_CHANNEL(ccb) cam_sim_bus(xpt_path_sim((ccb)->ccb_h.path))
408 #define XS_TGT(ccb) (ccb)->ccb_h.target_id
409 #define XS_LUN(ccb) (ccb)->ccb_h.target_lun
411 #define XS_CDBP(ccb) \
412 (((ccb)->ccb_h.flags & CAM_CDB_POINTER)? \
413 (ccb)->cdb_io.cdb_ptr : (ccb)->cdb_io.cdb_bytes)
415 #define XS_CDBLEN(ccb) (ccb)->cdb_len
416 #define XS_XFRLEN(ccb) (ccb)->dxfer_len
417 #define XS_TIME(ccb) (ccb)->ccb_h.timeout
418 #define XS_GET_RESID(ccb) (ccb)->resid
419 #define XS_SET_RESID(ccb, r) (ccb)->resid = r
420 #define XS_STSP(ccb) (&(ccb)->scsi_status)
421 #define XS_SNSP(ccb) (&(ccb)->sense_data)
423 #define XS_SNSLEN(ccb) \
424 imin((sizeof((ccb)->sense_data)), ccb->sense_len)
426 #define XS_SNSKEY(ccb) ((ccb)->sense_data.flags & 0xf)
427 #define XS_SNSASC(ccb) ((ccb)->sense_data.add_sense_code)
428 #define XS_SNSASCQ(ccb) ((ccb)->sense_data.add_sense_code_qual)
429 #define XS_TAG_P(ccb) \
430 (((ccb)->ccb_h.flags & CAM_TAG_ACTION_VALID) && \
431 (ccb)->tag_action != CAM_TAG_ACTION_NONE)
433 #define XS_TAG_TYPE(ccb) \
434 ((ccb->tag_action == MSG_SIMPLE_Q_TAG)? REQFLAG_STAG : \
435 ((ccb->tag_action == MSG_HEAD_OF_Q_TAG)? REQFLAG_HTAG : REQFLAG_OTAG))
438 #define XS_SETERR(ccb, v) (ccb)->ccb_h.status &= ~CAM_STATUS_MASK, \
439 (ccb)->ccb_h.status |= v, \
440 (ccb)->ccb_h.spriv_field0 |= ISP_SPRIV_ERRSET
442 # define HBA_NOERROR CAM_REQ_INPROG
443 # define HBA_BOTCH CAM_UNREC_HBA_ERROR
444 # define HBA_CMDTIMEOUT CAM_CMD_TIMEOUT
445 # define HBA_SELTIMEOUT CAM_SEL_TIMEOUT
446 # define HBA_TGTBSY CAM_SCSI_STATUS_ERROR
447 # define HBA_BUSRESET CAM_SCSI_BUS_RESET
448 # define HBA_ABORTED CAM_REQ_ABORTED
449 # define HBA_DATAOVR CAM_DATA_RUN_ERR
450 # define HBA_ARQFAIL CAM_AUTOSENSE_FAIL
453 #define XS_ERR(ccb) ((ccb)->ccb_h.status & CAM_STATUS_MASK)
455 #define XS_NOERR(ccb) \
456 (((ccb)->ccb_h.spriv_field0 & ISP_SPRIV_ERRSET) == 0 || \
457 ((ccb)->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_INPROG)
459 #define XS_INITERR(ccb) \
460 XS_SETERR(ccb, CAM_REQ_INPROG), (ccb)->ccb_h.spriv_field0 = 0
462 #define XS_SAVE_SENSE(xs, sense_ptr, sense_len) \
463 (xs)->ccb_h.status |= CAM_AUTOSNS_VALID; \
464 memcpy(&(xs)->sense_data, sense_ptr, imin(XS_SNSLEN(xs), sense_len))
466 #define XS_SENSE_VALID(xs) (((xs)->ccb_h.status & CAM_AUTOSNS_VALID) != 0)
468 #define DEFAULT_FRAMESIZE(isp) isp->isp_osinfo.framesize
469 #define DEFAULT_EXEC_THROTTLE(isp) isp->isp_osinfo.exec_throttle
471 #define GET_DEFAULT_ROLE(isp, chan) \
472 (IS_FC(isp)? ISP_FC_PC(isp, chan)->def_role : ISP_SPI_PC(isp, chan)->def_role)
473 #define SET_DEFAULT_ROLE(isp, chan, val) \
475 ISP_FC_PC(isp, chan)->def_role = val; \
477 ISP_SPI_PC(isp, chan)->def_role = val; \
480 #define DEFAULT_IID(isp, chan) isp->isp_osinfo.pc.spi[chan].iid
482 #define DEFAULT_LOOPID(x, chan) isp->isp_osinfo.pc.fc[chan].default_id
484 #define DEFAULT_NODEWWN(isp, chan) isp_default_wwn(isp, chan, 0, 1)
485 #define DEFAULT_PORTWWN(isp, chan) isp_default_wwn(isp, chan, 0, 0)
486 #define ACTIVE_NODEWWN(isp, chan) isp_default_wwn(isp, chan, 1, 1)
487 #define ACTIVE_PORTWWN(isp, chan) isp_default_wwn(isp, chan, 1, 0)
490 #if BYTE_ORDER == BIG_ENDIAN
491 #ifdef ISP_SBUS_SUPPORTED
492 #define ISP_IOXPUT_8(isp, s, d) *(d) = s
493 #define ISP_IOXPUT_16(isp, s, d) \
494 *(d) = (isp->isp_bustype == ISP_BT_SBUS)? s : bswap16(s)
495 #define ISP_IOXPUT_32(isp, s, d) \
496 *(d) = (isp->isp_bustype == ISP_BT_SBUS)? s : bswap32(s)
497 #define ISP_IOXGET_8(isp, s, d) d = (*((uint8_t *)s))
498 #define ISP_IOXGET_16(isp, s, d) \
499 d = (isp->isp_bustype == ISP_BT_SBUS)? \
500 *((uint16_t *)s) : bswap16(*((uint16_t *)s))
501 #define ISP_IOXGET_32(isp, s, d) \
502 d = (isp->isp_bustype == ISP_BT_SBUS)? \
503 *((uint32_t *)s) : bswap32(*((uint32_t *)s))
505 #else /* ISP_SBUS_SUPPORTED */
506 #define ISP_IOXPUT_8(isp, s, d) *(d) = s
507 #define ISP_IOXPUT_16(isp, s, d) *(d) = bswap16(s)
508 #define ISP_IOXPUT_32(isp, s, d) *(d) = bswap32(s)
509 #define ISP_IOXGET_8(isp, s, d) d = (*((uint8_t *)s))
510 #define ISP_IOXGET_16(isp, s, d) d = bswap16(*((uint16_t *)s))
511 #define ISP_IOXGET_32(isp, s, d) d = bswap32(*((uint32_t *)s))
513 #define ISP_SWIZZLE_NVRAM_WORD(isp, rp) *rp = bswap16(*rp)
514 #define ISP_SWIZZLE_NVRAM_LONG(isp, rp) *rp = bswap32(*rp)
516 #define ISP_IOZGET_8(isp, s, d) d = (*((uint8_t *)s))
517 #define ISP_IOZGET_16(isp, s, d) d = (*((uint16_t *)s))
518 #define ISP_IOZGET_32(isp, s, d) d = (*((uint32_t *)s))
519 #define ISP_IOZPUT_8(isp, s, d) *(d) = s
520 #define ISP_IOZPUT_16(isp, s, d) *(d) = s
521 #define ISP_IOZPUT_32(isp, s, d) *(d) = s
525 #define ISP_IOXPUT_8(isp, s, d) *(d) = s
526 #define ISP_IOXPUT_16(isp, s, d) *(d) = s
527 #define ISP_IOXPUT_32(isp, s, d) *(d) = s
528 #define ISP_IOXGET_8(isp, s, d) d = *(s)
529 #define ISP_IOXGET_16(isp, s, d) d = *(s)
530 #define ISP_IOXGET_32(isp, s, d) d = *(s)
531 #define ISP_SWIZZLE_NVRAM_WORD(isp, rp)
532 #define ISP_SWIZZLE_NVRAM_LONG(isp, rp)
534 #define ISP_IOZPUT_8(isp, s, d) *(d) = s
535 #define ISP_IOZPUT_16(isp, s, d) *(d) = bswap16(s)
536 #define ISP_IOZPUT_32(isp, s, d) *(d) = bswap32(s)
538 #define ISP_IOZGET_8(isp, s, d) d = (*((uint8_t *)(s)))
539 #define ISP_IOZGET_16(isp, s, d) d = bswap16(*((uint16_t *)(s)))
540 #define ISP_IOZGET_32(isp, s, d) d = bswap32(*((uint32_t *)(s)))
544 #define ISP_SWAP16(isp, s) bswap16(s)
545 #define ISP_SWAP32(isp, s) bswap32(s)
548 * Includes of common header files
551 #include <dev/isp/ispreg.h>
552 #include <dev/isp/ispvar.h>
553 #include <dev/isp/ispmbox.h>
556 * isp_osinfo definiitions && shorthand
558 #define SIMQFRZ_RESOURCE 0x1
559 #define SIMQFRZ_LOOPDOWN 0x2
560 #define SIMQFRZ_TIMED 0x4
562 #define isp_dev isp_osinfo.dev
565 * prototypes for isp_pci && isp_freebsd to share
567 extern int isp_attach(ispsoftc_t *);
568 extern void isp_detach(ispsoftc_t *);
569 extern void isp_uninit(ispsoftc_t *);
570 extern uint64_t isp_default_wwn(ispsoftc_t *, int, int, int);
575 extern int isp_announced;
576 extern int isp_fabric_hysteresis;
577 extern int isp_loop_down_limit;
578 extern int isp_gone_device_time;
579 extern int isp_quickboot_time;
580 extern int isp_autoconfig;
583 * Platform private flags
585 #define ISP_SPRIV_ERRSET 0x1
586 #define ISP_SPRIV_DONE 0x8
588 #define XS_CMD_S_DONE(sccb) (sccb)->ccb_h.spriv_field0 |= ISP_SPRIV_DONE
589 #define XS_CMD_C_DONE(sccb) (sccb)->ccb_h.spriv_field0 &= ~ISP_SPRIV_DONE
590 #define XS_CMD_DONE_P(sccb) ((sccb)->ccb_h.spriv_field0 & ISP_SPRIV_DONE)
592 #define XS_CMD_S_CLEAR(sccb) (sccb)->ccb_h.spriv_field0 = 0
595 * Platform Library Functions
597 void isp_prt(ispsoftc_t *, int level, const char *, ...) __printflike(3, 4);
598 void isp_xs_prt(ispsoftc_t *, XS_T *, int level, const char *, ...) __printflike(4, 5);
599 uint64_t isp_nanotime_sub(struct timespec *, struct timespec *);
600 int isp_mbox_acquire(ispsoftc_t *);
601 void isp_mbox_wait_complete(ispsoftc_t *, mbreg_t *);
602 void isp_mbox_notify_done(ispsoftc_t *);
603 void isp_mbox_release(ispsoftc_t *);
604 int isp_fc_scratch_acquire(ispsoftc_t *, int);
606 void isp_platform_intr(void *);
607 void isp_common_dmateardown(ispsoftc_t *, struct ccb_scsiio *, uint32_t);
610 * Platform Version specific defines
612 #define BUS_DMA_ROOTARG(x) bus_get_dma_tag(x)
613 #define isp_dma_tag_create(a, b, c, d, e, f, g, h, i, j, k, z) \
614 bus_dma_tag_create(a, b, c, d, e, f, g, h, i, j, k, \
615 busdma_lock_mutex, &isp->isp_osinfo.lock, z)
617 #define isp_setup_intr bus_setup_intr
619 #define isp_sim_alloc(a, b, c, d, e, f, g, h) \
620 cam_sim_alloc(a, b, c, d, e, &(d)->isp_osinfo.lock, f, g, h)
622 /* Should be BUS_SPACE_MAXSIZE, but MAXPHYS is larger than BUS_SPACE_MAXSIZE */
623 #define ISP_NSEGS ((MAXPHYS / PAGE_SIZE) + 1)
625 #define ISP_PATH_PRT(i, l, p, ...) \
626 if ((l) == ISP_LOGALL || ((l)& (i)->isp_dblev) != 0) { \
627 xpt_print(p, __VA_ARGS__); \
631 * Platform specific inline functions
635 * ISP General Library functions
638 #include <dev/isp/isp_library.h>
640 #endif /* _ISP_FREEBSD_H */