1 /* $FreeBSD$ */ 2 /* 3 * Qlogic ISP SCSI Host Adapter FreeBSD Wrapper Definitions (CAM version) 4 *--------------------------------------- 5 * Copyright (c) 1997, 1998, 1999 by Matthew Jacob 6 * NASA/Ames Research Center 7 * All rights reserved. 8 *--------------------------------------- 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 immediately at the beginning of the file, without modification, 15 * 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. The name of the author may not be used to endorse or promote products 20 * derived from this software without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 26 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 * SUCH DAMAGE. 33 */ 34 #ifndef _ISP_FREEBSD_H 35 #define _ISP_FREEBSD_H 36 37 #define ISP_PLATFORM_VERSION_MAJOR 4 38 #define ISP_PLATFORM_VERSION_MINOR 2 39 40 41 #include <sys/param.h> 42 #include <sys/param.h> 43 #include <sys/systm.h> 44 #include <sys/kernel.h> 45 #include <sys/queue.h> 46 47 #include <machine/bus_memio.h> 48 #include <machine/bus_pio.h> 49 #include <machine/bus.h> 50 #include <machine/clock.h> 51 52 #include <cam/cam.h> 53 #include <cam/cam_debug.h> 54 #include <cam/cam_ccb.h> 55 #include <cam/cam_sim.h> 56 #include <cam/cam_xpt.h> 57 #include <cam/cam_xpt_sim.h> 58 #include <cam/cam_debug.h> 59 #include <cam/scsi/scsi_all.h> 60 #include <cam/scsi/scsi_message.h> 61 62 #include "opt_ddb.h" 63 #include "opt_isp.h" 64 #ifdef SCSI_ISP_FABRIC 65 #define ISP2100_FABRIC 1 66 #define ISP2100_SCRLEN 0x400 67 #else 68 #define ISP2100_SCRLEN 0x100 69 #endif 70 #ifdef SCSI_ISP_SCCLUN 71 #define ISP2100_SCCLUN 1 72 #endif 73 74 #ifndef SCSI_CHECK 75 #define SCSI_CHECK SCSI_STATUS_CHECK_COND 76 #endif 77 #ifndef SCSI_BUSY 78 #define SCSI_BUSY SCSI_STATUS_BUSY 79 #endif 80 #ifndef SCSI_QFULL 81 #define SCSI_QFULL SCSI_STATUS_QUEUE_FULL 82 #endif 83 84 #define ISP_SCSI_XFER_T struct ccb_scsiio 85 86 #ifdef ISP_TARGET_MODE 87 typedef struct tstate { 88 struct tstate *next; 89 struct cam_path *owner; 90 struct ccb_hdr_slist atios; 91 struct ccb_hdr_slist inots; 92 lun_id_t lun; 93 u_int32_t hold; 94 } tstate_t; 95 96 /* 97 * This should work very well for 100% of parallel SCSI cases, 100% 98 * of non-SCCLUN FC cases, and hopefully some larger fraction of the 99 * SCCLUN FC cases. Basically, we index by the low 5 bits of lun and 100 * then linear search. This has to be reasonably zippy, but not crucially 101 * so. 102 */ 103 #define LUN_HASH_SIZE 32 104 #define LUN_HASH_FUNC(lun) ((lun) & 0x1f) 105 106 #endif 107 108 struct isposinfo { 109 struct ispsoftc * next; 110 u_int64_t default_wwn; 111 char name[8]; 112 int unit; 113 struct cam_sim *sim; 114 struct cam_path *path; 115 struct cam_sim *sim2; 116 struct cam_path *path2; 117 volatile char simqfrozen; 118 #ifdef ISP_TARGET_MODE 119 #define TM_WANTED 0x01 120 #define TM_BUSY 0x02 121 #define TM_TMODE_ENABLED 0x80 122 u_int8_t tmflags; 123 u_int8_t rstatus; 124 u_int16_t rollinfo; 125 tstate_t tsdflt; 126 tstate_t *lun_hash[LUN_HASH_SIZE]; 127 #endif 128 }; 129 #define SIMQFRZ_RESOURCE 0x1 130 #define SIMQFRZ_LOOPDOWN 0x2 131 #define SIMQFRZ_TIMED 0x4 132 133 #define isp_sim isp_osinfo.sim 134 #define isp_path isp_osinfo.path 135 #define isp_sim2 isp_osinfo.sim2 136 #define isp_path2 isp_osinfo.path2 137 #define isp_unit isp_osinfo.unit 138 #define isp_name isp_osinfo.name 139 140 #define MAXISPREQUEST 256 141 142 #include <dev/isp/ispreg.h> 143 #include <dev/isp/ispvar.h> 144 #include <dev/isp/ispmbox.h> 145 146 #define DFLT_DBLEVEL isp_debug 147 extern int isp_debug; 148 #define ISP_LOCKVAL_DECL int isp_spl_save 149 #define ISP_ILOCKVAL_DECL ISP_LOCKVAL_DECL 150 #define ISP_UNLOCK(isp) (void) splx(isp_spl_save) 151 #define ISP_LOCK(isp) isp_spl_save = splcam() 152 #define ISP_ILOCK(isp) ISP_LOCK(isp) 153 #define ISP_IUNLOCK(isp) ISP_UNLOCK(isp) 154 #define IMASK cam_imask 155 156 #define XS_NULL(ccb) ccb == NULL 157 #define XS_ISP(ccb) ((struct ispsoftc *) (ccb)->ccb_h.spriv_ptr1) 158 159 #define XS_LUN(ccb) (ccb)->ccb_h.target_lun 160 #define XS_TGT(ccb) (ccb)->ccb_h.target_id 161 #define XS_CHANNEL(ccb) cam_sim_bus(xpt_path_sim((ccb)->ccb_h.path)) 162 #define XS_RESID(ccb) (ccb)->resid 163 #define XS_XFRLEN(ccb) (ccb)->dxfer_len 164 #define XS_CDBLEN(ccb) (ccb)->cdb_len 165 #define XS_CDBP(ccb) (((ccb)->ccb_h.flags & CAM_CDB_POINTER)? \ 166 (ccb)->cdb_io.cdb_ptr : (ccb)->cdb_io.cdb_bytes) 167 #define XS_STS(ccb) (ccb)->scsi_status 168 #define XS_TIME(ccb) (ccb)->ccb_h.timeout 169 #define XS_SNSP(ccb) (&(ccb)->sense_data) 170 #define XS_SNSLEN(ccb) \ 171 imin((sizeof((ccb)->sense_data)), ccb->sense_len) 172 #define XS_SNSKEY(ccb) ((ccb)->sense_data.flags & 0xf) 173 174 /* 175 * A little tricky- HBA_NOERROR is "in progress" so 176 * that XS_CMD_DONE can transition this to CAM_REQ_CMP. 177 */ 178 #define HBA_NOERROR CAM_REQ_INPROG 179 #define HBA_BOTCH CAM_UNREC_HBA_ERROR 180 #define HBA_CMDTIMEOUT CAM_CMD_TIMEOUT 181 #define HBA_SELTIMEOUT CAM_SEL_TIMEOUT 182 #define HBA_TGTBSY CAM_SCSI_STATUS_ERROR 183 #define HBA_BUSRESET CAM_SCSI_BUS_RESET 184 #define HBA_ABORTED CAM_REQ_ABORTED 185 #define HBA_DATAOVR CAM_DATA_RUN_ERR 186 #define HBA_ARQFAIL CAM_AUTOSENSE_FAIL 187 188 #define XS_SNS_IS_VALID(ccb) ((ccb)->ccb_h.status |= CAM_AUTOSNS_VALID) 189 #define XS_IS_SNS_VALID(ccb) (((ccb)->ccb_h.status & CAM_AUTOSNS_VALID) != 0) 190 191 #define XS_INITERR(ccb) \ 192 (ccb)->ccb_h.status &= ~CAM_STATUS_MASK, \ 193 (ccb)->ccb_h.status |= CAM_REQ_INPROG, \ 194 (ccb)->ccb_h.spriv_field0 = CAM_REQ_INPROG 195 #define XS_SETERR(ccb, v) (ccb)->ccb_h.spriv_field0 = v 196 #define XS_ERR(ccb) (ccb)->ccb_h.spriv_field0 197 #define XS_NOERR(ccb) \ 198 ((ccb)->ccb_h.spriv_field0 == CAM_REQ_INPROG) 199 200 extern void isp_done(struct ccb_scsiio *); 201 #define XS_CMD_DONE(sccb) isp_done(sccb) 202 203 #define XS_IS_CMD_DONE(ccb) \ 204 (((ccb)->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_INPROG) 205 206 /* 207 * Can we tag? 208 */ 209 #define XS_CANTAG(ccb) (((ccb)->ccb_h.flags & CAM_TAG_ACTION_VALID) \ 210 && (ccb)->tag_action != CAM_TAG_ACTION_NONE) 211 /* 212 * And our favorite tag is.... 213 */ 214 #define XS_KINDOF_TAG(ccb) \ 215 ((ccb->tag_action == MSG_SIMPLE_Q_TAG)? REQFLAG_STAG : \ 216 ((ccb->tag_action == MSG_HEAD_OF_Q_TAG)? REQFLAG_HTAG : REQFLAG_OTAG)) 217 218 #define CMD_COMPLETE 0 219 #define CMD_EAGAIN 1 220 #define CMD_QUEUED 2 221 #define CMD_RQLATER 3 222 #define STOP_WATCHDOG(f, s) 223 224 extern void isp_attach(struct ispsoftc *); 225 extern void isp_uninit(struct ispsoftc *); 226 227 #define MEMZERO bzero 228 #define MEMCPY(dst, src, amt) bcopy((src), (dst), (amt)) 229 #ifdef __alpha__ 230 #define MemoryBarrier alpha_mb 231 #else 232 #define MemoryBarrier() 233 #endif 234 235 236 #define DMA_MSW(x) (((x) >> 16) & 0xffff) 237 #define DMA_LSW(x) (((x) & 0xffff)) 238 239 #define ISP_UNSWIZZLE_AND_COPY_PDBP(isp, dest, src) \ 240 bcopy(src, dest, sizeof (isp_pdb_t)) 241 #define ISP_SWIZZLE_ICB(a, b) 242 #define ISP_SWIZZLE_REQUEST(a, b) 243 #define ISP_UNSWIZZLE_RESPONSE(a, b) 244 #define ISP_SWIZZLE_SNS_REQ(a, b) 245 #define ISP_UNSWIZZLE_SNS_RSP(a, b, c) 246 247 #define IDPRINTF(lev, x) if (isp->isp_dblev >= (u_int8_t) lev) printf x 248 #define PRINTF printf 249 #define CFGPRINTF if (bootverbose || DFLT_DBLEVEL > 1) printf 250 251 #define SYS_DELAY(x) DELAY(x) 252 253 #define FC_FW_READY_DELAY (5 * 1000000) 254 #define DEFAULT_LOOPID(x) 109 255 #define DEFAULT_WWN(x) (x)->isp_osinfo.default_wwn 256 257 #define INLINE __inline 258 #include <dev/isp/isp_inline.h> 259 #endif /* _ISP_FREEBSD_H */ 260