1 /* $FreeBSD$ */ 2 /*- 3 * Qlogic ISP SCSI Host Adapter FreeBSD Wrapper Definitions 4 * 5 * Copyright (c) 1997-2008 by Matthew Jacob 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 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. 16 * 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 27 * SUCH DAMAGE. 28 */ 29 #ifndef _ISP_FREEBSD_H 30 #define _ISP_FREEBSD_H 31 32 #include <sys/param.h> 33 #include <sys/systm.h> 34 #include <sys/endian.h> 35 #include <sys/lock.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> 41 #include <sys/rman.h> 42 #include <sys/sysctl.h> 43 44 #include <sys/proc.h> 45 #include <sys/bus.h> 46 #include <sys/taskqueue.h> 47 48 #include <machine/bus.h> 49 #include <machine/cpu.h> 50 #include <machine/stdarg.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 65 #define ISP_PLATFORM_VERSION_MAJOR 7 66 #define ISP_PLATFORM_VERSION_MINOR 10 67 68 /* 69 * Efficiency- get rid of SBus code && tests unless we need them. 70 */ 71 #ifdef __sparc64__ 72 #define ISP_SBUS_SUPPORTED 1 73 #else 74 #define ISP_SBUS_SUPPORTED 0 75 #endif 76 77 #define ISP_IFLAGS INTR_TYPE_CAM | INTR_ENTROPY | INTR_MPSAFE 78 79 #define N_XCMDS 64 80 #define XCMD_SIZE 512 81 struct ispsoftc; 82 typedef union isp_ecmd { 83 union isp_ecmd * next; 84 uint8_t data[XCMD_SIZE]; 85 } isp_ecmd_t; 86 isp_ecmd_t * isp_get_ecmd(struct ispsoftc *); 87 void isp_put_ecmd(struct ispsoftc *, isp_ecmd_t *); 88 89 #ifdef ISP_TARGET_MODE 90 /* Not quite right, but there was no bump for this change */ 91 #if __FreeBSD_version < 225469 92 #define SDFIXED(x) (&x) 93 #else 94 #define SDFIXED(x) ((struct scsi_sense_data_fixed *)(&x)) 95 #endif 96 97 #define ISP_TARGET_FUNCTIONS 1 98 #define ATPDPSIZE 4096 99 #define ATPDPHASHSIZE 32 100 #define ATPDPHASH(x) ((((x) >> 24) ^ ((x) >> 16) ^ ((x) >> 8) ^ (x)) & \ 101 ((ATPDPHASHSIZE) - 1)) 102 103 #include <dev/isp/isp_target.h> 104 typedef struct atio_private_data { 105 LIST_ENTRY(atio_private_data) next; 106 uint32_t orig_datalen; 107 uint32_t bytes_xfered; 108 uint32_t bytes_in_transit; 109 uint32_t tag; /* typically f/w RX_ID */ 110 uint32_t lun; 111 uint32_t nphdl; 112 uint32_t sid; 113 uint32_t portid; 114 uint16_t rxid; /* wire rxid */ 115 uint16_t oxid; /* wire oxid */ 116 uint16_t word3; /* PRLI word3 params */ 117 uint16_t ctcnt; /* number of CTIOs currently active */ 118 uint8_t seqno; /* CTIO sequence number */ 119 uint32_t 120 srr_notify_rcvd : 1, 121 cdb0 : 8, 122 sendst : 1, 123 dead : 1, 124 tattr : 3, 125 state : 3; 126 void * ests; 127 /* 128 * The current SRR notify copy 129 */ 130 uint8_t srr[64]; /* sb QENTRY_LEN, but order of definitions is wrong */ 131 void * srr_ccb; 132 uint32_t nsrr; 133 } atio_private_data_t; 134 #define ATPD_STATE_FREE 0 135 #define ATPD_STATE_ATIO 1 136 #define ATPD_STATE_CAM 2 137 #define ATPD_STATE_CTIO 3 138 #define ATPD_STATE_LAST_CTIO 4 139 #define ATPD_STATE_PDON 5 140 141 #define ATPD_CCB_OUTSTANDING 16 142 143 #define ATPD_SEQ_MASK 0x7f 144 #define ATPD_SEQ_NOTIFY_CAM 0x80 145 #define ATPD_SET_SEQNO(hdrp, atp) ((isphdr_t *)hdrp)->rqs_seqno &= ~ATPD_SEQ_MASK, ((isphdr_t *)hdrp)->rqs_seqno |= (atp)->seqno 146 #define ATPD_GET_SEQNO(hdrp) (((isphdr_t *)hdrp)->rqs_seqno & ATPD_SEQ_MASK) 147 #define ATPD_GET_NCAM(hdrp) ((((isphdr_t *)hdrp)->rqs_seqno & ATPD_SEQ_NOTIFY_CAM) != 0) 148 149 typedef union inot_private_data inot_private_data_t; 150 union inot_private_data { 151 inot_private_data_t *next; 152 struct { 153 isp_notify_t nt; /* must be first! */ 154 uint8_t data[64]; /* sb QENTRY_LEN, but order of definitions is wrong */ 155 uint32_t tag_id, seq_id; 156 } rd; 157 }; 158 typedef struct isp_timed_notify_ack { 159 void *isp; 160 void *not; 161 uint8_t data[64]; /* sb QENTRY_LEN, but order of definitions is wrong */ 162 struct callout timer; 163 } isp_tna_t; 164 165 TAILQ_HEAD(isp_ccbq, ccb_hdr); 166 typedef struct tstate { 167 SLIST_ENTRY(tstate) next; 168 lun_id_t ts_lun; 169 struct cam_path *owner; 170 struct isp_ccbq waitq; /* waiting CCBs */ 171 struct ccb_hdr_slist atios; 172 struct ccb_hdr_slist inots; 173 uint32_t hold; 174 uint16_t atio_count; 175 uint16_t inot_count; 176 inot_private_data_t * restart_queue; 177 inot_private_data_t * ntfree; 178 inot_private_data_t ntpool[ATPDPSIZE]; 179 LIST_HEAD(, atio_private_data) atfree; 180 LIST_HEAD(, atio_private_data) atused[ATPDPHASHSIZE]; 181 atio_private_data_t atpool[ATPDPSIZE]; 182 } tstate_t; 183 184 #define LUN_HASH_SIZE 32 185 #define LUN_HASH_FUNC(lun) ((lun) & (LUN_HASH_SIZE - 1)) 186 187 #endif 188 189 /* 190 * Per command info. 191 */ 192 struct isp_pcmd { 193 struct isp_pcmd * next; 194 bus_dmamap_t dmap; /* dma map for this command */ 195 struct ispsoftc * isp; /* containing isp */ 196 struct callout wdog; /* watchdog timer */ 197 uint32_t datalen; /* data length for this command (target mode only) */ 198 uint8_t totslen; /* sense length on status response */ 199 uint8_t cumslen; /* sense length on status response */ 200 uint8_t crn; /* command reference number */ 201 }; 202 #define ISP_PCMD(ccb) (ccb)->ccb_h.spriv_ptr1 203 #define PISP_PCMD(ccb) ((struct isp_pcmd *)ISP_PCMD(ccb)) 204 205 /* 206 * Per nexus info. 207 */ 208 struct isp_nexus { 209 uint64_t lun; /* LUN for target */ 210 uint32_t tgt; /* TGT for target */ 211 uint8_t crnseed; /* next command reference number */ 212 struct isp_nexus *next; 213 }; 214 #define NEXUS_HASH_WIDTH 32 215 #define INITIAL_NEXUS_COUNT MAX_FC_TARG 216 #define NEXUS_HASH(tgt, lun) ((tgt + lun) % NEXUS_HASH_WIDTH) 217 218 /* 219 * Per channel information 220 */ 221 SLIST_HEAD(tslist, tstate); 222 223 struct isp_fc { 224 struct cam_sim *sim; 225 struct cam_path *path; 226 struct ispsoftc *isp; 227 struct proc *kproc; 228 bus_dma_tag_t tdmat; 229 bus_dmamap_t tdmap; 230 uint64_t def_wwpn; 231 uint64_t def_wwnn; 232 time_t loop_down_time; 233 int loop_down_limit; 234 int gone_device_time; 235 /* 236 * Per target/lun info- just to keep a per-ITL nexus crn count 237 */ 238 struct isp_nexus *nexus_hash[NEXUS_HASH_WIDTH]; 239 struct isp_nexus *nexus_free_list; 240 uint32_t 241 simqfrozen : 3, 242 default_id : 8, 243 def_role : 2, /* default role */ 244 gdt_running : 1, 245 loop_dead : 1, 246 loop_seen_once : 1, 247 fcbsy : 1, 248 ready : 1; 249 struct callout gdt; /* gone device timer */ 250 struct task gtask; 251 #ifdef ISP_TARGET_MODE 252 struct tslist lun_hash[LUN_HASH_SIZE]; 253 #if defined(DEBUG) 254 unsigned int inject_lost_data_frame; 255 #endif 256 #endif 257 int num_threads; 258 }; 259 260 struct isp_spi { 261 struct cam_sim *sim; 262 struct cam_path *path; 263 uint32_t 264 simqfrozen : 3, 265 iid : 4; 266 #ifdef ISP_TARGET_MODE 267 struct tslist lun_hash[LUN_HASH_SIZE]; 268 #endif 269 int num_threads; 270 }; 271 272 struct isposinfo { 273 /* 274 * Linkage, locking, and identity 275 */ 276 struct mtx lock; 277 device_t dev; 278 struct cdev * cdev; 279 struct intr_config_hook ehook; 280 struct cam_devq * devq; 281 282 /* 283 * Firmware pointer 284 */ 285 const struct firmware * fw; 286 287 /* 288 * DMA related sdtuff 289 */ 290 struct resource * regs; 291 struct resource * regs2; 292 bus_dma_tag_t dmat; 293 bus_dma_tag_t cdmat; 294 bus_dmamap_t cdmap; 295 296 /* 297 * Command and transaction related related stuff 298 */ 299 struct isp_pcmd * pcmd_pool; 300 struct isp_pcmd * pcmd_free; 301 302 uint32_t 303 #ifdef ISP_TARGET_MODE 304 tmwanted : 1, 305 tmbusy : 1, 306 #else 307 : 2, 308 #endif 309 sixtyfourbit : 1, /* sixtyfour bit platform */ 310 timer_active : 1, 311 autoconf : 1, 312 ehook_active : 1, 313 mbox_sleeping : 1, 314 mbox_sleep_ok : 1, 315 mboxcmd_done : 1, 316 mboxbsy : 1; 317 318 struct callout tmo; /* general timer */ 319 320 /* 321 * misc- needs to be sorted better XXXXXX 322 */ 323 int framesize; 324 int exec_throttle; 325 int cont_max; 326 327 bus_addr_t ecmd_dma; 328 isp_ecmd_t * ecmd_base; 329 isp_ecmd_t * ecmd_free; 330 331 /* 332 * Per-type private storage... 333 */ 334 union { 335 struct isp_fc *fc; 336 struct isp_spi *spi; 337 void *ptr; 338 } pc; 339 340 int is_exiting; 341 }; 342 #define ISP_FC_PC(isp, chan) (&(isp)->isp_osinfo.pc.fc[(chan)]) 343 #define ISP_SPI_PC(isp, chan) (&(isp)->isp_osinfo.pc.spi[(chan)]) 344 #define ISP_GET_PC(isp, chan, tag, rslt) \ 345 if (IS_SCSI(isp)) { \ 346 rslt = ISP_SPI_PC(isp, chan)-> tag; \ 347 } else { \ 348 rslt = ISP_FC_PC(isp, chan)-> tag; \ 349 } 350 #define ISP_GET_PC_ADDR(isp, chan, tag, rp) \ 351 if (IS_SCSI(isp)) { \ 352 rp = &ISP_SPI_PC(isp, chan)-> tag; \ 353 } else { \ 354 rp = &ISP_FC_PC(isp, chan)-> tag; \ 355 } 356 #define ISP_SET_PC(isp, chan, tag, val) \ 357 if (IS_SCSI(isp)) { \ 358 ISP_SPI_PC(isp, chan)-> tag = val; \ 359 } else { \ 360 ISP_FC_PC(isp, chan)-> tag = val; \ 361 } 362 363 #define FCP_NEXT_CRN isp_fcp_next_crn 364 #define isp_lock isp_osinfo.lock 365 #define isp_regs isp_osinfo.regs 366 #define isp_regs2 isp_osinfo.regs2 367 368 /* 369 * Locking macros... 370 */ 371 #define ISP_LOCK(isp) mtx_lock(&(isp)->isp_osinfo.lock) 372 #define ISP_UNLOCK(isp) mtx_unlock(&(isp)->isp_osinfo.lock) 373 #define ISP_ASSERT_LOCKED(isp) mtx_assert(&(isp)->isp_osinfo.lock, MA_OWNED) 374 375 /* 376 * Required Macros/Defines 377 */ 378 #define ISP_FC_SCRLEN 0x1000 379 380 #define ISP_MEMZERO(a, b) memset(a, 0, b) 381 #define ISP_MEMCPY memcpy 382 #define ISP_SNPRINTF snprintf 383 #define ISP_DELAY(x) DELAY(x) 384 #if __FreeBSD_version < 1000029 385 #define ISP_SLEEP(isp, x) msleep(&(isp)->isp_osinfo.is_exiting, \ 386 &(isp)->isp_osinfo.lock, 0, "isp_sleep", ((x) + tick - 1) / tick) 387 #else 388 #define ISP_SLEEP(isp, x) msleep_sbt(&(isp)->isp_osinfo.is_exiting, \ 389 &(isp)->isp_osinfo.lock, 0, "isp_sleep", (x) * SBT_1US, 0, 0) 390 #endif 391 392 #define ISP_MIN imin 393 394 #ifndef DIAGNOSTIC 395 #define ISP_INLINE __inline 396 #else 397 #define ISP_INLINE 398 #endif 399 400 #define NANOTIME_T struct timespec 401 #define GET_NANOTIME nanotime 402 #define GET_NANOSEC(x) ((x)->tv_sec * 1000000000 + (x)->tv_nsec) 403 #define NANOTIME_SUB isp_nanotime_sub 404 405 #define MAXISPREQUEST(isp) ((IS_FC(isp) || IS_ULTRA2(isp))? 1024 : 256) 406 407 #define MEMORYBARRIER(isp, type, offset, size, chan) \ 408 switch (type) { \ 409 case SYNC_SFORDEV: \ 410 { \ 411 struct isp_fc *fc = ISP_FC_PC(isp, chan); \ 412 bus_dmamap_sync(fc->tdmat, fc->tdmap, \ 413 BUS_DMASYNC_PREREAD | BUS_DMASYNC_PREWRITE); \ 414 break; \ 415 } \ 416 case SYNC_REQUEST: \ 417 bus_dmamap_sync(isp->isp_osinfo.cdmat, \ 418 isp->isp_osinfo.cdmap, \ 419 BUS_DMASYNC_PREREAD | BUS_DMASYNC_PREWRITE); \ 420 break; \ 421 case SYNC_SFORCPU: \ 422 { \ 423 struct isp_fc *fc = ISP_FC_PC(isp, chan); \ 424 bus_dmamap_sync(fc->tdmat, fc->tdmap, \ 425 BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE); \ 426 break; \ 427 } \ 428 case SYNC_RESULT: \ 429 bus_dmamap_sync(isp->isp_osinfo.cdmat, \ 430 isp->isp_osinfo.cdmap, \ 431 BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE); \ 432 break; \ 433 case SYNC_REG: \ 434 bus_barrier(isp->isp_osinfo.regs, offset, size, \ 435 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE); \ 436 break; \ 437 default: \ 438 break; \ 439 } 440 441 #define MEMORYBARRIERW(isp, type, offset, size, chan) \ 442 switch (type) { \ 443 case SYNC_SFORDEV: \ 444 { \ 445 struct isp_fc *fc = ISP_FC_PC(isp, chan); \ 446 bus_dmamap_sync(fc->tdmat, fc->tdmap, \ 447 BUS_DMASYNC_PREWRITE); \ 448 break; \ 449 } \ 450 case SYNC_REQUEST: \ 451 bus_dmamap_sync(isp->isp_osinfo.cdmat, \ 452 isp->isp_osinfo.cdmap, BUS_DMASYNC_PREWRITE); \ 453 break; \ 454 case SYNC_SFORCPU: \ 455 { \ 456 struct isp_fc *fc = ISP_FC_PC(isp, chan); \ 457 bus_dmamap_sync(fc->tdmat, fc->tdmap, \ 458 BUS_DMASYNC_POSTWRITE); \ 459 break; \ 460 } \ 461 case SYNC_RESULT: \ 462 bus_dmamap_sync(isp->isp_osinfo.cdmat, \ 463 isp->isp_osinfo.cdmap, BUS_DMASYNC_POSTWRITE); \ 464 break; \ 465 case SYNC_REG: \ 466 bus_barrier(isp->isp_osinfo.regs, offset, size, \ 467 BUS_SPACE_BARRIER_WRITE); \ 468 break; \ 469 default: \ 470 break; \ 471 } 472 473 #define MBOX_ACQUIRE isp_mbox_acquire 474 #define MBOX_WAIT_COMPLETE isp_mbox_wait_complete 475 #define MBOX_NOTIFY_COMPLETE isp_mbox_notify_done 476 #define MBOX_RELEASE isp_mbox_release 477 478 #define FC_SCRATCH_ACQUIRE isp_fc_scratch_acquire 479 #define FC_SCRATCH_RELEASE(isp, chan) isp->isp_osinfo.pc.fc[chan].fcbsy = 0 480 481 #ifndef SCSI_GOOD 482 #define SCSI_GOOD SCSI_STATUS_OK 483 #endif 484 #ifndef SCSI_CHECK 485 #define SCSI_CHECK SCSI_STATUS_CHECK_COND 486 #endif 487 #ifndef SCSI_BUSY 488 #define SCSI_BUSY SCSI_STATUS_BUSY 489 #endif 490 #ifndef SCSI_QFULL 491 #define SCSI_QFULL SCSI_STATUS_QUEUE_FULL 492 #endif 493 494 #define XS_T struct ccb_scsiio 495 #define XS_DMA_ADDR_T bus_addr_t 496 #define XS_GET_DMA64_SEG(a, b, c) \ 497 { \ 498 ispds64_t *d = a; \ 499 bus_dma_segment_t *e = b; \ 500 uint32_t f = c; \ 501 e += f; \ 502 d->ds_base = DMA_LO32(e->ds_addr); \ 503 d->ds_basehi = DMA_HI32(e->ds_addr); \ 504 d->ds_count = e->ds_len; \ 505 } 506 #define XS_GET_DMA_SEG(a, b, c) \ 507 { \ 508 ispds_t *d = a; \ 509 bus_dma_segment_t *e = b; \ 510 uint32_t f = c; \ 511 e += f; \ 512 d->ds_base = DMA_LO32(e->ds_addr); \ 513 d->ds_count = e->ds_len; \ 514 } 515 #define XS_ISP(ccb) cam_sim_softc(xpt_path_sim((ccb)->ccb_h.path)) 516 #define XS_CHANNEL(ccb) cam_sim_bus(xpt_path_sim((ccb)->ccb_h.path)) 517 #define XS_TGT(ccb) (ccb)->ccb_h.target_id 518 #define XS_LUN(ccb) (ccb)->ccb_h.target_lun 519 520 #define XS_CDBP(ccb) \ 521 (((ccb)->ccb_h.flags & CAM_CDB_POINTER)? \ 522 (ccb)->cdb_io.cdb_ptr : (ccb)->cdb_io.cdb_bytes) 523 524 #define XS_CDBLEN(ccb) (ccb)->cdb_len 525 #define XS_XFRLEN(ccb) (ccb)->dxfer_len 526 #define XS_TIME(ccb) (ccb)->ccb_h.timeout 527 #define XS_GET_RESID(ccb) (ccb)->resid 528 #define XS_SET_RESID(ccb, r) (ccb)->resid = r 529 #define XS_STSP(ccb) (&(ccb)->scsi_status) 530 #define XS_SNSP(ccb) (&(ccb)->sense_data) 531 532 #define XS_TOT_SNSLEN(ccb) ccb->sense_len 533 #define XS_CUR_SNSLEN(ccb) (ccb->sense_len - ccb->sense_resid) 534 535 #define XS_SNSKEY(ccb) (scsi_get_sense_key(&(ccb)->sense_data, \ 536 ccb->sense_len - ccb->sense_resid, 1)) 537 538 #define XS_SNSASC(ccb) (scsi_get_asc(&(ccb)->sense_data, \ 539 ccb->sense_len - ccb->sense_resid, 1)) 540 541 #define XS_SNSASCQ(ccb) (scsi_get_ascq(&(ccb)->sense_data, \ 542 ccb->sense_len - ccb->sense_resid, 1)) 543 #define XS_TAG_P(ccb) \ 544 (((ccb)->ccb_h.flags & CAM_TAG_ACTION_VALID) && \ 545 (ccb)->tag_action != CAM_TAG_ACTION_NONE) 546 547 #define XS_TAG_TYPE(ccb) \ 548 ((ccb->tag_action == MSG_SIMPLE_Q_TAG)? REQFLAG_STAG : \ 549 ((ccb->tag_action == MSG_HEAD_OF_Q_TAG)? REQFLAG_HTAG : REQFLAG_OTAG)) 550 551 552 #define XS_SETERR(ccb, v) (ccb)->ccb_h.status &= ~CAM_STATUS_MASK, \ 553 (ccb)->ccb_h.status |= v 554 555 # define HBA_NOERROR CAM_REQ_INPROG 556 # define HBA_BOTCH CAM_UNREC_HBA_ERROR 557 # define HBA_CMDTIMEOUT CAM_CMD_TIMEOUT 558 # define HBA_SELTIMEOUT CAM_SEL_TIMEOUT 559 # define HBA_TGTBSY CAM_SCSI_STATUS_ERROR 560 # define HBA_BUSRESET CAM_SCSI_BUS_RESET 561 # define HBA_ABORTED CAM_REQ_ABORTED 562 # define HBA_DATAOVR CAM_DATA_RUN_ERR 563 # define HBA_ARQFAIL CAM_AUTOSENSE_FAIL 564 565 566 #define XS_ERR(ccb) ((ccb)->ccb_h.status & CAM_STATUS_MASK) 567 568 #define XS_NOERR(ccb) (((ccb)->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_INPROG) 569 570 #define XS_INITERR(ccb) XS_SETERR(ccb, CAM_REQ_INPROG), ccb->sense_resid = ccb->sense_len 571 572 #define XS_SAVE_SENSE(xs, sense_ptr, totslen, slen) do { \ 573 uint32_t tlen = slen; \ 574 if (tlen > (xs)->sense_len) \ 575 tlen = (xs)->sense_len; \ 576 PISP_PCMD(xs)->totslen = imin((xs)->sense_len, totslen); \ 577 PISP_PCMD(xs)->cumslen = tlen; \ 578 memcpy(&(xs)->sense_data, sense_ptr, tlen); \ 579 (xs)->sense_resid = (xs)->sense_len - tlen; \ 580 (xs)->ccb_h.status |= CAM_AUTOSNS_VALID; \ 581 } while (0) 582 583 #define XS_SENSE_APPEND(xs, xsnsp, xsnsl) do { \ 584 uint32_t off = PISP_PCMD(xs)->cumslen; \ 585 uint8_t *ptr = &((uint8_t *)(&(xs)->sense_data))[off]; \ 586 uint32_t amt = imin(xsnsl, PISP_PCMD(xs)->totslen - off); \ 587 if (amt) { \ 588 memcpy(ptr, xsnsp, amt); \ 589 (xs)->sense_resid -= amt; \ 590 PISP_PCMD(xs)->cumslen += amt; \ 591 } \ 592 } while (0) 593 594 #define XS_SENSE_VALID(xs) (((xs)->ccb_h.status & CAM_AUTOSNS_VALID) != 0) 595 596 #define DEFAULT_FRAMESIZE(isp) isp->isp_osinfo.framesize 597 #define DEFAULT_EXEC_THROTTLE(isp) isp->isp_osinfo.exec_throttle 598 599 #define DEFAULT_ROLE(isp, chan) \ 600 (IS_FC(isp)? ISP_FC_PC(isp, chan)->def_role : ISP_ROLE_INITIATOR) 601 602 #define DEFAULT_IID(isp, chan) isp->isp_osinfo.pc.spi[chan].iid 603 604 #define DEFAULT_LOOPID(x, chan) isp->isp_osinfo.pc.fc[chan].default_id 605 606 #define DEFAULT_NODEWWN(isp, chan) isp_default_wwn(isp, chan, 0, 1) 607 #define DEFAULT_PORTWWN(isp, chan) isp_default_wwn(isp, chan, 0, 0) 608 #define ACTIVE_NODEWWN(isp, chan) isp_default_wwn(isp, chan, 1, 1) 609 #define ACTIVE_PORTWWN(isp, chan) isp_default_wwn(isp, chan, 1, 0) 610 611 612 #if BYTE_ORDER == BIG_ENDIAN 613 #ifdef ISP_SBUS_SUPPORTED 614 #define ISP_IOXPUT_8(isp, s, d) *(d) = s 615 #define ISP_IOXPUT_16(isp, s, d) \ 616 *(d) = (isp->isp_bustype == ISP_BT_SBUS)? s : bswap16(s) 617 #define ISP_IOXPUT_32(isp, s, d) \ 618 *(d) = (isp->isp_bustype == ISP_BT_SBUS)? s : bswap32(s) 619 #define ISP_IOXGET_8(isp, s, d) d = (*((uint8_t *)s)) 620 #define ISP_IOXGET_16(isp, s, d) \ 621 d = (isp->isp_bustype == ISP_BT_SBUS)? \ 622 *((uint16_t *)s) : bswap16(*((uint16_t *)s)) 623 #define ISP_IOXGET_32(isp, s, d) \ 624 d = (isp->isp_bustype == ISP_BT_SBUS)? \ 625 *((uint32_t *)s) : bswap32(*((uint32_t *)s)) 626 627 #else /* ISP_SBUS_SUPPORTED */ 628 #define ISP_IOXPUT_8(isp, s, d) *(d) = s 629 #define ISP_IOXPUT_16(isp, s, d) *(d) = bswap16(s) 630 #define ISP_IOXPUT_32(isp, s, d) *(d) = bswap32(s) 631 #define ISP_IOXGET_8(isp, s, d) d = (*((uint8_t *)s)) 632 #define ISP_IOXGET_16(isp, s, d) d = bswap16(*((uint16_t *)s)) 633 #define ISP_IOXGET_32(isp, s, d) d = bswap32(*((uint32_t *)s)) 634 #endif 635 #define ISP_SWIZZLE_NVRAM_WORD(isp, rp) *rp = bswap16(*rp) 636 #define ISP_SWIZZLE_NVRAM_LONG(isp, rp) *rp = bswap32(*rp) 637 638 #define ISP_IOZGET_8(isp, s, d) d = (*((uint8_t *)s)) 639 #define ISP_IOZGET_16(isp, s, d) d = (*((uint16_t *)s)) 640 #define ISP_IOZGET_32(isp, s, d) d = (*((uint32_t *)s)) 641 #define ISP_IOZPUT_8(isp, s, d) *(d) = s 642 #define ISP_IOZPUT_16(isp, s, d) *(d) = s 643 #define ISP_IOZPUT_32(isp, s, d) *(d) = s 644 645 646 #else 647 #define ISP_IOXPUT_8(isp, s, d) *(d) = s 648 #define ISP_IOXPUT_16(isp, s, d) *(d) = s 649 #define ISP_IOXPUT_32(isp, s, d) *(d) = s 650 #define ISP_IOXGET_8(isp, s, d) d = *(s) 651 #define ISP_IOXGET_16(isp, s, d) d = *(s) 652 #define ISP_IOXGET_32(isp, s, d) d = *(s) 653 #define ISP_SWIZZLE_NVRAM_WORD(isp, rp) 654 #define ISP_SWIZZLE_NVRAM_LONG(isp, rp) 655 656 #define ISP_IOZPUT_8(isp, s, d) *(d) = s 657 #define ISP_IOZPUT_16(isp, s, d) *(d) = bswap16(s) 658 #define ISP_IOZPUT_32(isp, s, d) *(d) = bswap32(s) 659 660 #define ISP_IOZGET_8(isp, s, d) d = (*((uint8_t *)(s))) 661 #define ISP_IOZGET_16(isp, s, d) d = bswap16(*((uint16_t *)(s))) 662 #define ISP_IOZGET_32(isp, s, d) d = bswap32(*((uint32_t *)(s))) 663 664 #endif 665 666 #define ISP_SWAP16(isp, s) bswap16(s) 667 #define ISP_SWAP32(isp, s) bswap32(s) 668 669 /* 670 * Includes of common header files 671 */ 672 673 #include <dev/isp/ispreg.h> 674 #include <dev/isp/ispvar.h> 675 #include <dev/isp/ispmbox.h> 676 677 /* 678 * isp_osinfo definiitions && shorthand 679 */ 680 #define SIMQFRZ_RESOURCE 0x1 681 #define SIMQFRZ_LOOPDOWN 0x2 682 #define SIMQFRZ_TIMED 0x4 683 684 #define isp_dev isp_osinfo.dev 685 686 /* 687 * prototypes for isp_pci && isp_freebsd to share 688 */ 689 extern int isp_attach(ispsoftc_t *); 690 extern int isp_detach(ispsoftc_t *); 691 extern void isp_uninit(ispsoftc_t *); 692 extern uint64_t isp_default_wwn(ispsoftc_t *, int, int, int); 693 694 /* 695 * driver global data 696 */ 697 extern int isp_announced; 698 extern int isp_loop_down_limit; 699 extern int isp_gone_device_time; 700 extern int isp_quickboot_time; 701 702 /* 703 * Platform private flags 704 */ 705 706 /* 707 * Platform Library Functions 708 */ 709 void isp_prt(ispsoftc_t *, int level, const char *, ...) __printflike(3, 4); 710 void isp_xs_prt(ispsoftc_t *, XS_T *, int level, const char *, ...) __printflike(4, 5); 711 uint64_t isp_nanotime_sub(struct timespec *, struct timespec *); 712 int isp_mbox_acquire(ispsoftc_t *); 713 void isp_mbox_wait_complete(ispsoftc_t *, mbreg_t *); 714 void isp_mbox_notify_done(ispsoftc_t *); 715 void isp_mbox_release(ispsoftc_t *); 716 int isp_fc_scratch_acquire(ispsoftc_t *, int); 717 int isp_mstohz(int); 718 void isp_platform_intr(void *); 719 void isp_common_dmateardown(ispsoftc_t *, struct ccb_scsiio *, uint32_t); 720 void isp_fcp_reset_crn(ispsoftc_t *, int, uint32_t, int); 721 int isp_fcp_next_crn(ispsoftc_t *, uint8_t *, XS_T *); 722 723 /* 724 * Platform Version specific defines 725 */ 726 #define BUS_DMA_ROOTARG(x) bus_get_dma_tag(x) 727 #define isp_dma_tag_create(a, b, c, d, e, f, g, h, i, j, k, z) \ 728 bus_dma_tag_create(a, b, c, d, e, f, g, h, i, j, k, \ 729 busdma_lock_mutex, &isp->isp_osinfo.lock, z) 730 731 #define isp_setup_intr bus_setup_intr 732 733 #define isp_sim_alloc(a, b, c, d, e, f, g, h) \ 734 cam_sim_alloc(a, b, c, d, e, &(d)->isp_osinfo.lock, f, g, h) 735 736 #define ISP_PATH_PRT(i, l, p, ...) \ 737 if ((l) == ISP_LOGALL || ((l)& (i)->isp_dblev) != 0) { \ 738 xpt_print(p, __VA_ARGS__); \ 739 } 740 741 /* 742 * Platform specific inline functions 743 */ 744 745 /* 746 * ISP General Library functions 747 */ 748 749 #include <dev/isp/isp_library.h> 750 751 #endif /* _ISP_FREEBSD_H */ 752