1 /* $FreeBSD: src/sys/dev/isp/isp_freebsd.h,v 1.26.2.17 2002/10/11 17:35:11 mjacob Exp $ */ 2 /* $DragonFly: src/sys/dev/disk/isp/isp_freebsd.h,v 1.8 2006/12/20 18:14:38 dillon Exp $ */ 3 /* 4 * Qlogic ISP SCSI Host Adapter FreeBSD Wrapper Definitions 5 * Copyright (c) 1997, 1998, 1999, 2000, 2001, 2002 by Matthew Jacob 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice immediately at the beginning of the file, without modification, 12 * this list of conditions, and the following disclaimer. 13 * 2. The name of the author may not be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 20 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 #ifndef _ISP_FREEBSD_H 29 #define _ISP_FREEBSD_H 30 31 #define ISP_PLATFORM_VERSION_MAJOR 4 32 #define ISP_PLATFORM_VERSION_MINOR 16 33 34 #include <sys/param.h> 35 #include <sys/systm.h> 36 #include <sys/kernel.h> 37 #include <sys/queue.h> 38 #include <sys/malloc.h> 39 #include <sys/proc.h> 40 #include <sys/bus.h> 41 42 #include <sys/thread2.h> 43 #include <sys/mplock2.h> 44 45 #include <machine/clock.h> 46 #include <machine/cpu.h> 47 48 #include <bus/cam/cam.h> 49 #include <bus/cam/cam_debug.h> 50 #include <bus/cam/cam_ccb.h> 51 #include <bus/cam/cam_sim.h> 52 #include <bus/cam/cam_xpt.h> 53 #include <bus/cam/cam_xpt_sim.h> 54 #include <bus/cam/cam_debug.h> 55 #include <bus/cam/scsi/scsi_all.h> 56 #include <bus/cam/scsi/scsi_message.h> 57 58 #include "opt_ddb.h" 59 #include "opt_isp.h" 60 61 /* 62 * Not quite yet 63 */ 64 /* #define ISP_DAC_SUPPORTED 1 */ 65 66 /* 67 * Efficiency- get rid of SBus code && tests unless we need them. 68 */ 69 #if _MACHINE_ARCH == sparc64 70 #define ISP_SBUS_SUPPORTED 1 71 #else 72 #define ISP_SBUS_SUPPORTED 0 73 #endif 74 75 #define HANDLE_LOOPSTATE_IN_OUTER_LAYERS 1 76 77 typedef void ispfwfunc(int, int, int, u_int16_t **); 78 79 #ifdef ISP_TARGET_MODE 80 #define ISP_TARGET_FUNCTIONS 1 81 #define ATPDPSIZE 256 82 typedef struct { 83 u_int32_t orig_datalen; 84 u_int32_t bytes_xfered; 85 u_int32_t last_xframt; 86 u_int32_t tag : 16, 87 lun : 13, /* not enough */ 88 state : 3; 89 } atio_private_data_t; 90 #define ATPD_STATE_FREE 0 91 #define ATPD_STATE_ATIO 1 92 #define ATPD_STATE_CAM 2 93 #define ATPD_STATE_CTIO 3 94 #define ATPD_STATE_LAST_CTIO 4 95 #define ATPD_STATE_PDON 5 96 97 typedef struct tstate { 98 struct tstate *next; 99 struct cam_path *owner; 100 struct ccb_hdr_slist atios; 101 struct ccb_hdr_slist inots; 102 lun_id_t lun; 103 int bus; 104 u_int32_t hold; 105 int atio_count; 106 } tstate_t; 107 108 #define LUN_HASH_SIZE 32 109 #define LUN_HASH_FUNC(isp, port, lun) \ 110 ((IS_DUALBUS(isp)) ? \ 111 (((lun) & ((LUN_HASH_SIZE >> 1) - 1)) << (port)) : \ 112 ((lun) & (LUN_HASH_SIZE - 1))) 113 #endif 114 115 struct isposinfo { 116 struct ispsoftc * next; 117 u_int64_t default_port_wwn; 118 u_int64_t default_node_wwn; 119 u_int32_t default_id; 120 device_t dev; 121 struct cam_sim *sim; 122 struct cam_path *path; 123 struct cam_sim *sim2; 124 struct cam_path *path2; 125 struct intr_config_hook ehook; 126 u_int8_t : 1, 127 fcbsy : 1, 128 ktmature : 1, 129 mboxwaiting : 1, 130 intsok : 1, 131 simqfrozen : 3; 132 struct thread *kthread; 133 bus_dma_tag_t cdmat; 134 bus_dmamap_t cdmap; 135 #define isp_cdmat isp_osinfo.cdmat 136 #define isp_cdmap isp_osinfo.cdmap 137 #ifdef ISP_TARGET_MODE 138 #define TM_WANTED 0x80 139 #define TM_BUSY 0x40 140 #define TM_WILDCARD_ENABLED 0x02 141 #define TM_TMODE_ENABLED 0x01 142 u_int8_t tmflags[2]; /* two busses */ 143 u_int8_t rstatus[2]; /* two bussed */ 144 u_int16_t rollinfo; 145 tstate_t tsdflt[2]; /* two busses */ 146 tstate_t *lun_hash[LUN_HASH_SIZE]; 147 atio_private_data_t atpdp[ATPDPSIZE]; 148 #endif 149 }; 150 151 #define isp_lock isp_osinfo.lock 152 153 /* 154 * Locking macros... 155 */ 156 157 #define ISP_LOCK isp_lockspl 158 #define ISP_UNLOCK isp_unlockspl 159 #define ISPLOCK_2_CAMLOCK(x) 160 #define CAMLOCK_2_ISPLOCK(x) 161 162 /* 163 * Required Macros/Defines 164 */ 165 166 #define INLINE __inline 167 168 #define ISP2100_SCRLEN 0x800 169 170 #define MEMZERO bzero 171 #define MEMCPY(dst, src, amt) bcopy((src), (dst), (amt)) 172 #define SNPRINTF ksnprintf 173 #define USEC_DELAY DELAY 174 #define USEC_SLEEP(isp, x) \ 175 if (isp->isp_osinfo.intsok) \ 176 ISP_UNLOCK(isp); \ 177 DELAY(x); \ 178 if (isp->isp_osinfo.intsok) \ 179 ISP_LOCK(isp) 180 181 #define NANOTIME_T struct timespec 182 #define GET_NANOTIME nanotime 183 #define GET_NANOSEC(x) ((x)->tv_sec * 1000000000 + (x)->tv_nsec) 184 #define NANOTIME_SUB nanotime_sub 185 186 #define MAXISPREQUEST(isp) ((IS_FC(isp) || IS_ULTRA2(isp))? 1024 : 256) 187 188 #define MEMORYBARRIER(isp, type, offset, size) \ 189 switch (type) { \ 190 case SYNC_SFORDEV: \ 191 case SYNC_REQUEST: \ 192 bus_dmamap_sync(isp->isp_cdmat, isp->isp_cdmap, \ 193 BUS_DMASYNC_PREREAD | BUS_DMASYNC_PREWRITE); \ 194 break; \ 195 case SYNC_SFORCPU: \ 196 case SYNC_RESULT: \ 197 bus_dmamap_sync(isp->isp_cdmat, isp->isp_cdmap, \ 198 BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE); \ 199 break; \ 200 default: \ 201 break; \ 202 } 203 204 #define MBOX_ACQUIRE(isp) 205 #define MBOX_WAIT_COMPLETE isp_mbox_wait_complete 206 #define MBOX_NOTIFY_COMPLETE(isp) \ 207 if (isp->isp_osinfo.mboxwaiting) { \ 208 isp->isp_osinfo.mboxwaiting = 0; \ 209 wakeup(&isp->isp_mbxworkp); \ 210 } \ 211 isp->isp_mboxbsy = 0 212 #define MBOX_RELEASE(isp) 213 214 #define FC_SCRATCH_ACQUIRE(isp) \ 215 if (isp->isp_osinfo.fcbsy) { \ 216 isp_prt(isp, ISP_LOGWARN, \ 217 "FC scratch area busy (line %d)!", __LINE__); \ 218 } else \ 219 isp->isp_osinfo.fcbsy = 1 220 #define FC_SCRATCH_RELEASE(isp) isp->isp_osinfo.fcbsy = 0 221 222 #ifndef SCSI_GOOD 223 #define SCSI_GOOD SCSI_STATUS_OK 224 #endif 225 #ifndef SCSI_CHECK 226 #define SCSI_CHECK SCSI_STATUS_CHECK_COND 227 #endif 228 #ifndef SCSI_BUSY 229 #define SCSI_BUSY SCSI_STATUS_BUSY 230 #endif 231 #ifndef SCSI_QFULL 232 #define SCSI_QFULL SCSI_STATUS_QUEUE_FULL 233 #endif 234 235 #define XS_T struct ccb_scsiio 236 #define XS_ISP(ccb) ((struct ispsoftc *) (ccb)->ccb_h.spriv_ptr1) 237 #define XS_CHANNEL(ccb) cam_sim_bus(xpt_path_sim((ccb)->ccb_h.path)) 238 #define XS_TGT(ccb) (ccb)->ccb_h.target_id 239 #define XS_LUN(ccb) (ccb)->ccb_h.target_lun 240 241 #define XS_CDBP(ccb) \ 242 (((ccb)->ccb_h.flags & CAM_CDB_POINTER)? \ 243 (ccb)->cdb_io.cdb_ptr : (ccb)->cdb_io.cdb_bytes) 244 245 #define XS_CDBLEN(ccb) (ccb)->cdb_len 246 #define XS_XFRLEN(ccb) (ccb)->dxfer_len 247 #define XS_TIME(ccb) (ccb)->ccb_h.timeout 248 #define XS_RESID(ccb) (ccb)->resid 249 #define XS_STSP(ccb) (&(ccb)->scsi_status) 250 #define XS_SNSP(ccb) (&(ccb)->sense_data) 251 252 #define XS_SNSLEN(ccb) \ 253 imin((sizeof((ccb)->sense_data)), ccb->sense_len) 254 255 #define XS_SNSKEY(ccb) ((ccb)->sense_data.flags & 0xf) 256 #define XS_TAG_P(ccb) \ 257 (((ccb)->ccb_h.flags & CAM_TAG_ACTION_VALID) && \ 258 (ccb)->tag_action != CAM_TAG_ACTION_NONE) 259 260 #define XS_TAG_TYPE(ccb) \ 261 ((ccb->tag_action == MSG_SIMPLE_Q_TAG)? REQFLAG_STAG : \ 262 ((ccb->tag_action == MSG_HEAD_OF_Q_TAG)? REQFLAG_HTAG : REQFLAG_OTAG)) 263 264 265 #define XS_SETERR(ccb, v) (ccb)->ccb_h.status &= ~CAM_STATUS_MASK, \ 266 (ccb)->ccb_h.status |= v, \ 267 (ccb)->ccb_h.spriv_field0 |= ISP_SPRIV_ERRSET 268 269 # define HBA_NOERROR CAM_REQ_INPROG 270 # define HBA_BOTCH CAM_UNREC_HBA_ERROR 271 # define HBA_CMDTIMEOUT CAM_CMD_TIMEOUT 272 # define HBA_SELTIMEOUT CAM_SEL_TIMEOUT 273 # define HBA_TGTBSY CAM_SCSI_STATUS_ERROR 274 # define HBA_BUSRESET CAM_SCSI_BUS_RESET 275 # define HBA_ABORTED CAM_REQ_ABORTED 276 # define HBA_DATAOVR CAM_DATA_RUN_ERR 277 # define HBA_ARQFAIL CAM_AUTOSENSE_FAIL 278 279 280 #define XS_ERR(ccb) ((ccb)->ccb_h.status & CAM_STATUS_MASK) 281 282 #define XS_NOERR(ccb) \ 283 (((ccb)->ccb_h.spriv_field0 & ISP_SPRIV_ERRSET) == 0 || \ 284 ((ccb)->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_INPROG) 285 286 #define XS_INITERR(ccb) \ 287 XS_SETERR(ccb, CAM_REQ_INPROG), (ccb)->ccb_h.spriv_field0 = 0 288 289 #define XS_SAVE_SENSE(xs, sp) \ 290 (xs)->ccb_h.status |= CAM_AUTOSNS_VALID, \ 291 bcopy(sp->req_sense_data, &(xs)->sense_data, \ 292 imin(XS_SNSLEN(xs), sp->req_sense_len)) 293 294 #define XS_SET_STATE_STAT(a, b, c) 295 296 #define DEFAULT_IID(x) (isp)->isp_osinfo.default_id 297 #define DEFAULT_LOOPID(x) (isp)->isp_osinfo.default_id 298 #define DEFAULT_NODEWWN(isp) (isp)->isp_osinfo.default_node_wwn 299 #define DEFAULT_PORTWWN(isp) (isp)->isp_osinfo.default_port_wwn 300 #define ISP_NODEWWN(isp) FCPARAM(isp)->isp_nodewwn 301 #define ISP_PORTWWN(isp) FCPARAM(isp)->isp_portwwn 302 303 #if BYTE_ORDER == BIG_ENDIAN 304 #ifdef ISP_SBUS_SUPPORTED 305 #define ISP_IOXPUT_8(isp, s, d) *(d) = s 306 #define ISP_IOXPUT_16(isp, s, d) \ 307 *(d) = (isp->isp_bustype == ISP_BT_SBUS)? s : bswap16(s) 308 #define ISP_IOXPUT_32(isp, s, d) \ 309 *(d) = (isp->isp_bustype == ISP_BT_SBUS)? s : bswap32(s) 310 #define ISP_IOXGET_8(isp, s, d) d = (*((u_int8_t *)s)) 311 #define ISP_IOXGET_16(isp, s, d) \ 312 d = (isp->isp_bustype == ISP_BT_SBUS)? \ 313 *((u_int16_t *)s) : bswap16(*((u_int16_t *)s)) 314 #define ISP_IOXGET_32(isp, s, d) \ 315 d = (isp->isp_bustype == ISP_BT_SBUS)? \ 316 *((u_int32_t *)s) : bswap32(*((u_int32_t *)s)) 317 #else 318 #define ISP_IOXPUT_8(isp, s, d) *(d) = s 319 #define ISP_IOXPUT_16(isp, s, d) *(d) = bswap16(s) 320 #define ISP_IOXPUT_32(isp, s, d) *(d) = bswap32(s) 321 #define ISP_IOXGET_8(isp, s, d) d = (*((u_int8_t *)s)) 322 #define ISP_IOXGET_16(isp, s, d) d = bswap16(*((u_int16_t *)s)) 323 #define ISP_IOXGET_32(isp, s, d) d = bswap32(*((u_int32_t *)s)) 324 #endif 325 #define ISP_SWIZZLE_NVRAM_WORD(isp, rp) *rp = bswap16(*rp) 326 #else 327 #define ISP_IOXPUT_8(isp, s, d) *(d) = s 328 #define ISP_IOXPUT_16(isp, s, d) *(d) = s 329 #define ISP_IOXPUT_32(isp, s, d) *(d) = s 330 #define ISP_IOXGET_8(isp, s, d) d = *(s) 331 #define ISP_IOXGET_16(isp, s, d) d = *(s) 332 #define ISP_IOXGET_32(isp, s, d) d = *(s) 333 #define ISP_SWIZZLE_NVRAM_WORD(isp, rp) 334 #endif 335 336 /* 337 * Includes of common header files 338 */ 339 340 #include "ispreg.h" 341 #include "ispvar.h" 342 #include "ispmbox.h" 343 344 /* 345 * isp_osinfo definiitions && shorthand 346 */ 347 #define SIMQFRZ_RESOURCE 0x1 348 #define SIMQFRZ_LOOPDOWN 0x2 349 #define SIMQFRZ_TIMED 0x4 350 351 #define isp_sim isp_osinfo.sim 352 #define isp_path isp_osinfo.path 353 #define isp_sim2 isp_osinfo.sim2 354 #define isp_path2 isp_osinfo.path2 355 #define isp_dev isp_osinfo.dev 356 357 /* 358 * prototypes for isp_pci && isp_freebsd to share 359 */ 360 extern void isp_attach(struct ispsoftc *); 361 extern void isp_uninit(struct ispsoftc *); 362 363 /* 364 * Platform private flags 365 */ 366 #define ISP_SPRIV_ERRSET 0x1 367 #define ISP_SPRIV_INWDOG 0x2 368 #define ISP_SPRIV_GRACE 0x4 369 #define ISP_SPRIV_DONE 0x8 370 371 #define XS_CMD_S_WDOG(sccb) (sccb)->ccb_h.spriv_field0 |= ISP_SPRIV_INWDOG 372 #define XS_CMD_C_WDOG(sccb) (sccb)->ccb_h.spriv_field0 &= ~ISP_SPRIV_INWDOG 373 #define XS_CMD_WDOG_P(sccb) ((sccb)->ccb_h.spriv_field0 & ISP_SPRIV_INWDOG) 374 375 #define XS_CMD_S_GRACE(sccb) (sccb)->ccb_h.spriv_field0 |= ISP_SPRIV_GRACE 376 #define XS_CMD_C_GRACE(sccb) (sccb)->ccb_h.spriv_field0 &= ~ISP_SPRIV_GRACE 377 #define XS_CMD_GRACE_P(sccb) ((sccb)->ccb_h.spriv_field0 & ISP_SPRIV_GRACE) 378 379 #define XS_CMD_S_DONE(sccb) (sccb)->ccb_h.spriv_field0 |= ISP_SPRIV_DONE 380 #define XS_CMD_C_DONE(sccb) (sccb)->ccb_h.spriv_field0 &= ~ISP_SPRIV_DONE 381 #define XS_CMD_DONE_P(sccb) ((sccb)->ccb_h.spriv_field0 & ISP_SPRIV_DONE) 382 383 #define XS_CMD_S_CLEAR(sccb) (sccb)->ccb_h.spriv_field0 = 0 384 /* 385 * Platform specific inline functions 386 */ 387 static INLINE void isp_lockspl(struct ispsoftc *); 388 static INLINE void 389 isp_lockspl(struct ispsoftc *isp) 390 { 391 crit_enter(); 392 } 393 394 static INLINE void isp_unlockspl(struct ispsoftc *); 395 static INLINE void 396 isp_unlockspl(struct ispsoftc *isp) 397 { 398 crit_exit(); 399 } 400 401 static INLINE void isp_mbox_wait_complete(struct ispsoftc *); 402 static INLINE void 403 isp_mbox_wait_complete(struct ispsoftc *isp) 404 { 405 if (isp->isp_osinfo.intsok) { 406 int lim = ((isp->isp_mbxwrk0)? 120 : 20) * hz; 407 isp->isp_osinfo.mboxwaiting = 1; 408 (void) tsleep(&isp->isp_mbxworkp, 0, "isp_mboxwaiting", lim); 409 if (isp->isp_mboxbsy != 0) { 410 isp_prt(isp, ISP_LOGWARN, 411 "Interrupting Mailbox Command (0x%x) Timeout", 412 isp->isp_lastmbxcmd); 413 isp->isp_mboxbsy = 0; 414 } 415 isp->isp_osinfo.mboxwaiting = 0; 416 } else { 417 int lim = ((isp->isp_mbxwrk0)? 240 : 60) * 10000; 418 int j; 419 for (j = 0; j < lim; j++) { 420 u_int16_t isr, sema, mbox; 421 if (isp->isp_mboxbsy == 0) { 422 break; 423 } 424 if (ISP_READ_ISR(isp, &isr, &sema, &mbox)) { 425 isp_intr(isp, isr, sema, mbox); 426 if (isp->isp_mboxbsy == 0) { 427 break; 428 } 429 } 430 USEC_DELAY(500); 431 } 432 if (isp->isp_mboxbsy != 0) { 433 isp_prt(isp, ISP_LOGWARN, 434 "Polled Mailbox Command (0x%x) Timeout", 435 isp->isp_lastmbxcmd); 436 } 437 } 438 } 439 440 static INLINE u_int64_t nanotime_sub(struct timespec *, struct timespec *); 441 static INLINE u_int64_t 442 nanotime_sub(struct timespec *b, struct timespec *a) 443 { 444 u_int64_t elapsed; 445 struct timespec x = *b; 446 timespecsub(&x, a); 447 elapsed = GET_NANOSEC(&x); 448 if (elapsed == 0) 449 elapsed++; 450 return (elapsed); 451 } 452 453 static INLINE char *strncat(char *, const char *, size_t); 454 static INLINE char * 455 strncat(char *d, const char *s, size_t c) 456 { 457 char *t = d; 458 459 if (c) { 460 while (*d) 461 d++; 462 while ((*d++ = *s++)) { 463 if (--c == 0) { 464 *d = '\0'; 465 break; 466 } 467 } 468 } 469 return (t); 470 } 471 472 /* 473 * Common inline functions 474 */ 475 476 #include "isp_inline.h" 477 #endif /* _ISP_FREEBSD_H */ 478