sys/dev/isp/isp_freebsd.h

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