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         uint32_t
 174                 enabled         : 1,
 175                 atio_count      : 15,
 176                 inot_count      : 15;
 177         inot_private_data_t *   restart_queue;
 178         inot_private_data_t *   ntfree;
 179         inot_private_data_t     ntpool[ATPDPSIZE];
 180         LIST_HEAD(, atio_private_data)  atfree;
 181         LIST_HEAD(, atio_private_data)  atused[ATPDPHASHSIZE];
 182         atio_private_data_t     atpool[ATPDPSIZE];
 183 } tstate_t;
 184
 185 #define LUN_HASH_SIZE           32
 186 #define LUN_HASH_FUNC(lun)      ((lun) & (LUN_HASH_SIZE - 1))
 187
 188 #endif
 189
 190 /*
 191  * Per command info.
 192  */
 193 struct isp_pcmd {
 194         struct isp_pcmd *       next;
 195         bus_dmamap_t            dmap;           /* dma map for this command */
 196         struct ispsoftc *       isp;            /* containing isp */
 197         struct callout          wdog;           /* watchdog timer */
 198         uint32_t                datalen;        /* data length for this command (target mode only) */
 199         uint8_t                 totslen;        /* sense length on status response */
 200         uint8_t                 cumslen;        /* sense length on status response */
 201         uint8_t                 crn;            /* command reference number */
 202 };
 203 #define ISP_PCMD(ccb)           (ccb)->ccb_h.spriv_ptr1
 204 #define PISP_PCMD(ccb)          ((struct isp_pcmd *)ISP_PCMD(ccb))
 205
 206 /*
 207  * Per nexus info.
 208  */
 209 struct isp_nexus {
 210         struct isp_nexus *      next;
 211         uint32_t
 212                 crnseed :       8;      /* next command reference number */
 213         uint32_t
 214                 tgt     :       16,     /* TGT for target */
 215                 lun     :       16;     /* LUN for target */
 216 };
 217 #define NEXUS_HASH_WIDTH        32
 218 #define INITIAL_NEXUS_COUNT     MAX_FC_TARG
 219 #define NEXUS_HASH(tgt, lun)    ((tgt + lun) % NEXUS_HASH_WIDTH)
 220
 221 /*
 222  * Per channel information
 223  */
 224 SLIST_HEAD(tslist, tstate);
 225
 226 struct isp_fc {
 227         struct cam_sim *sim;
 228         struct cam_path *path;
 229         struct ispsoftc *isp;
 230         struct proc *kproc;
 231         bus_dma_tag_t tdmat;
 232         bus_dmamap_t tdmap;
 233         uint64_t def_wwpn;
 234         uint64_t def_wwnn;
 235         uint32_t loop_down_time;
 236         uint32_t loop_down_limit;
 237         uint32_t gone_device_time;
 238         /*
 239          * Per target/lun info- just to keep a per-ITL nexus crn count
 240          */
 241         struct isp_nexus *nexus_hash[NEXUS_HASH_WIDTH];
 242         struct isp_nexus *nexus_free_list;
 243         uint32_t
 244 #ifdef  ISP_TARGET_MODE
 245 #ifdef  ISP_INTERNAL_TARGET
 246                 proc_active     : 1,
 247 #endif
 248                 tm_luns_enabled : 1,
 249                 tm_enable_defer : 1,
 250                 tm_enabled      : 1,
 251 #endif
 252                 simqfrozen      : 3,
 253                 default_id      : 8,
 254                 hysteresis      : 8,
 255                 def_role        : 2,    /* default role */
 256                 gdt_running     : 1,
 257                 loop_dead       : 1,
 258                 fcbsy           : 1,
 259                 ready           : 1;
 260         struct callout ldt;     /* loop down timer */
 261         struct callout gdt;     /* gone device timer */
 262         struct task ltask;
 263         struct task gtask;
 264 #ifdef  ISP_TARGET_MODE
 265         struct tslist lun_hash[LUN_HASH_SIZE];
 266 #ifdef  ISP_INTERNAL_TARGET
 267         struct proc *           target_proc;
 268 #endif
 269 #if defined(DEBUG)
 270         unsigned int inject_lost_data_frame;
 271 #endif
 272 #endif
 273         int                     num_threads;
 274 };
 275
 276 struct isp_spi {
 277         struct cam_sim *sim;
 278         struct cam_path *path;
 279         uint32_t
 280 #ifdef  ISP_TARGET_MODE
 281 #ifdef  ISP_INTERNAL_TARGET
 282                 proc_active     : 1,
 283 #endif
 284                 tm_luns_enabled : 1,
 285                 tm_enable_defer : 1,
 286                 tm_enabled      : 1,
 287 #endif
 288                 simqfrozen      : 3,
 289                 def_role        : 2,
 290                 iid             : 4;
 291 #ifdef  ISP_TARGET_MODE
 292         struct tslist lun_hash[LUN_HASH_SIZE];
 293 #ifdef  ISP_INTERNAL_TARGET
 294         struct proc *           target_proc;
 295 #endif
 296 #endif
 297         int                     num_threads;
 298 };
 299
 300 struct isposinfo {
 301         /*
 302          * Linkage, locking, and identity
 303          */
 304         struct mtx              lock;
 305         device_t                dev;
 306         struct cdev *           cdev;
 307         struct intr_config_hook ehook;
 308         struct cam_devq *       devq;
 309
 310         /*
 311          * Firmware pointer
 312          */
 313         const struct firmware * fw;
 314
 315         /*
 316          * DMA related sdtuff
 317          */
 318         bus_space_tag_t         bus_tag;
 319         bus_dma_tag_t           dmat;
 320         bus_space_handle_t      bus_handle;
 321         bus_dma_tag_t           cdmat;
 322         bus_dmamap_t            cdmap;
 323
 324         /*
 325          * Command and transaction related related stuff
 326          */
 327         struct isp_pcmd *       pcmd_pool;
 328         struct isp_pcmd *       pcmd_free;
 329
 330         uint32_t
 331 #ifdef  ISP_TARGET_MODE
 332                 tmwanted        : 1,
 333                 tmbusy          : 1,
 334 #else
 335                                 : 2,
 336 #endif
 337                 sixtyfourbit    : 1,    /* sixtyfour bit platform */
 338                 timer_active    : 1,
 339                 autoconf        : 1,
 340                 ehook_active    : 1,
 341                 disabled        : 1,
 342                 mbox_sleeping   : 1,
 343                 mbox_sleep_ok   : 1,
 344                 mboxcmd_done    : 1,
 345                 mboxbsy         : 1;
 346
 347         struct callout          tmo;    /* general timer */
 348
 349         /*
 350          * misc- needs to be sorted better XXXXXX
 351          */
 352         int                     framesize;
 353         int                     exec_throttle;
 354         int                     cont_max;
 355
 356 #ifdef  ISP_TARGET_MODE
 357         cam_status *            rptr;
 358 #endif
 359
 360         bus_addr_t              ecmd_dma;
 361         isp_ecmd_t *            ecmd_base;
 362         isp_ecmd_t *            ecmd_free;
 363
 364         /*
 365          * Per-type private storage...
 366          */
 367         union {
 368                 struct isp_fc *fc;
 369                 struct isp_spi *spi;
 370                 void *ptr;
 371         } pc;
 372
 373         int                     is_exiting;
 374 };
 375 #define ISP_FC_PC(isp, chan)    (&(isp)->isp_osinfo.pc.fc[(chan)])
 376 #define ISP_SPI_PC(isp, chan)   (&(isp)->isp_osinfo.pc.spi[(chan)])
 377 #define ISP_GET_PC(isp, chan, tag, rslt)                \
 378         if (IS_SCSI(isp)) {                             \
 379                 rslt = ISP_SPI_PC(isp, chan)-> tag;     \
 380         } else {                                        \
 381                 rslt = ISP_FC_PC(isp, chan)-> tag;      \
 382         }
 383 #define ISP_GET_PC_ADDR(isp, chan, tag, rp)             \
 384         if (IS_SCSI(isp)) {                             \
 385                 rp = &ISP_SPI_PC(isp, chan)-> tag;      \
 386         } else {                                        \
 387                 rp = &ISP_FC_PC(isp, chan)-> tag;       \
 388         }
 389 #define ISP_SET_PC(isp, chan, tag, val)                 \
 390         if (IS_SCSI(isp)) {                             \
 391                 ISP_SPI_PC(isp, chan)-> tag = val;      \
 392         } else {                                        \
 393                 ISP_FC_PC(isp, chan)-> tag = val;       \
 394         }
 395
 396 #define FCP_NEXT_CRN    isp_fcp_next_crn
 397 #define isp_lock        isp_osinfo.lock
 398 #define isp_bus_tag     isp_osinfo.bus_tag
 399 #define isp_bus_handle  isp_osinfo.bus_handle
 400
 401 /*
 402  * Locking macros...
 403  */
 404 #define ISP_LOCK(isp)   mtx_lock(&(isp)->isp_osinfo.lock)
 405 #define ISP_UNLOCK(isp) mtx_unlock(&(isp)->isp_osinfo.lock)
 406 #define ISP_ASSERT_LOCKED(isp)  mtx_assert(&(isp)->isp_osinfo.lock, MA_OWNED)
 407
 408 /*
 409  * Required Macros/Defines
 410  */
 411 #define ISP_FC_SCRLEN           0x1000
 412
 413 #define ISP_MEMZERO(a, b)       memset(a, 0, b)
 414 #define ISP_MEMCPY              memcpy
 415 #define ISP_SNPRINTF            snprintf
 416 #define ISP_DELAY               DELAY
 417 #define ISP_SLEEP(isp, x)       DELAY(x)
 418
 419 #define ISP_MIN                 imin
 420
 421 #ifndef DIAGNOSTIC
 422 #define ISP_INLINE              __inline
 423 #else
 424 #define ISP_INLINE
 425 #endif
 426
 427 #define NANOTIME_T              struct timespec
 428 #define GET_NANOTIME            nanotime
 429 #define GET_NANOSEC(x)          ((x)->tv_sec * 1000000000 + (x)->tv_nsec)
 430 #define NANOTIME_SUB            isp_nanotime_sub
 431
 432 #define MAXISPREQUEST(isp)      ((IS_FC(isp) || IS_ULTRA2(isp))? 1024 : 256)
 433
 434 #define MEMORYBARRIER(isp, type, offset, size, chan)            \
 435 switch (type) {                                                 \
 436 case SYNC_SFORDEV:                                              \
 437 {                                                               \
 438         struct isp_fc *fc = ISP_FC_PC(isp, chan);               \
 439         bus_dmamap_sync(fc->tdmat, fc->tdmap,                   \
 440            BUS_DMASYNC_PREREAD | BUS_DMASYNC_PREWRITE);         \
 441         break;                                                  \
 442 }                                                               \
 443 case SYNC_REQUEST:                                              \
 444         bus_dmamap_sync(isp->isp_osinfo.cdmat,                  \
 445            isp->isp_osinfo.cdmap,                               \
 446            BUS_DMASYNC_PREREAD | BUS_DMASYNC_PREWRITE);         \
 447         break;                                                  \
 448 case SYNC_SFORCPU:                                              \
 449 {                                                               \
 450         struct isp_fc *fc = ISP_FC_PC(isp, chan);               \
 451         bus_dmamap_sync(fc->tdmat, fc->tdmap,                   \
 452            BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE);       \
 453         break;                                                  \
 454 }                                                               \
 455 case SYNC_RESULT:                                               \
 456         bus_dmamap_sync(isp->isp_osinfo.cdmat,                  \
 457            isp->isp_osinfo.cdmap,                               \
 458            BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE);       \
 459         break;                                                  \
 460 case SYNC_REG:                                                  \
 461         bus_space_barrier(isp->isp_osinfo.bus_tag,              \
 462             isp->isp_osinfo.bus_handle, offset, size,           \
 463             BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);  \
 464         break;                                                  \
 465 default:                                                        \
 466         break;                                                  \
 467 }
 468
 469 #define MEMORYBARRIERW(isp, type, offset, size, chan)           \
 470 switch (type) {                                                 \
 471 case SYNC_SFORDEV:                                              \
 472 {                                                               \
 473         struct isp_fc *fc = ISP_FC_PC(isp, chan);               \
 474         bus_dmamap_sync(fc->tdmat, fc->tdmap,                   \
 475            BUS_DMASYNC_PREWRITE);                               \
 476         break;                                                  \
 477 }                                                               \
 478 case SYNC_REQUEST:                                              \
 479         bus_dmamap_sync(isp->isp_osinfo.cdmat,                  \
 480            isp->isp_osinfo.cdmap, BUS_DMASYNC_PREWRITE);        \
 481         break;                                                  \
 482 case SYNC_SFORCPU:                                              \
 483 {                                                               \
 484         struct isp_fc *fc = ISP_FC_PC(isp, chan);               \
 485         bus_dmamap_sync(fc->tdmat, fc->tdmap,                   \
 486            BUS_DMASYNC_POSTWRITE);                              \
 487         break;                                                  \
 488 }                                                               \
 489 case SYNC_RESULT:                                               \
 490         bus_dmamap_sync(isp->isp_osinfo.cdmat,                  \
 491            isp->isp_osinfo.cdmap, BUS_DMASYNC_POSTWRITE);       \
 492         break;                                                  \
 493 case SYNC_REG:                                                  \
 494         bus_space_barrier(isp->isp_osinfo.bus_tag,              \
 495             isp->isp_osinfo.bus_handle, offset, size,           \
 496             BUS_SPACE_BARRIER_WRITE);                           \
 497         break;                                                  \
 498 default:                                                        \
 499         break;                                                  \
 500 }
 501
 502 #define MBOX_ACQUIRE                    isp_mbox_acquire
 503 #define MBOX_WAIT_COMPLETE              isp_mbox_wait_complete
 504 #define MBOX_NOTIFY_COMPLETE            isp_mbox_notify_done
 505 #define MBOX_RELEASE                    isp_mbox_release
 506
 507 #define FC_SCRATCH_ACQUIRE              isp_fc_scratch_acquire
 508 #define FC_SCRATCH_RELEASE(isp, chan)   isp->isp_osinfo.pc.fc[chan].fcbsy = 0
 509
 510 #ifndef SCSI_GOOD
 511 #define SCSI_GOOD       SCSI_STATUS_OK
 512 #endif
 513 #ifndef SCSI_CHECK
 514 #define SCSI_CHECK      SCSI_STATUS_CHECK_COND
 515 #endif
 516 #ifndef SCSI_BUSY
 517 #define SCSI_BUSY       SCSI_STATUS_BUSY
 518 #endif
 519 #ifndef SCSI_QFULL
 520 #define SCSI_QFULL      SCSI_STATUS_QUEUE_FULL
 521 #endif
 522
 523 #define XS_T                    struct ccb_scsiio
 524 #define XS_DMA_ADDR_T           bus_addr_t
 525 #define XS_GET_DMA64_SEG(a, b, c)               \
 526 {                                               \
 527         ispds64_t *d = a;                       \
 528         bus_dma_segment_t *e = b;               \
 529         uint32_t f = c;                         \
 530         e += f;                                 \
 531         d->ds_base = DMA_LO32(e->ds_addr);      \
 532         d->ds_basehi = DMA_HI32(e->ds_addr);    \
 533         d->ds_count = e->ds_len;                \
 534 }
 535 #define XS_GET_DMA_SEG(a, b, c)                 \
 536 {                                               \
 537         ispds_t *d = a;                         \
 538         bus_dma_segment_t *e = b;               \
 539         uint32_t f = c;                         \
 540         e += f;                                 \
 541         d->ds_base = DMA_LO32(e->ds_addr);      \
 542         d->ds_count = e->ds_len;                \
 543 }
 544 #define XS_ISP(ccb)             cam_sim_softc(xpt_path_sim((ccb)->ccb_h.path))
 545 #define XS_CHANNEL(ccb)         cam_sim_bus(xpt_path_sim((ccb)->ccb_h.path))
 546 #define XS_TGT(ccb)             (ccb)->ccb_h.target_id
 547 #define XS_LUN(ccb)             (uint32_t)((ccb)->ccb_h.target_lun)
 548
 549 #define XS_CDBP(ccb)    \
 550         (((ccb)->ccb_h.flags & CAM_CDB_POINTER)? \
 551          (ccb)->cdb_io.cdb_ptr : (ccb)->cdb_io.cdb_bytes)
 552
 553 #define XS_CDBLEN(ccb)          (ccb)->cdb_len
 554 #define XS_XFRLEN(ccb)          (ccb)->dxfer_len
 555 #define XS_TIME(ccb)            (ccb)->ccb_h.timeout
 556 #define XS_GET_RESID(ccb)       (ccb)->resid
 557 #define XS_SET_RESID(ccb, r)    (ccb)->resid = r
 558 #define XS_STSP(ccb)            (&(ccb)->scsi_status)
 559 #define XS_SNSP(ccb)            (&(ccb)->sense_data)
 560
 561 #define XS_TOT_SNSLEN(ccb)      ccb->sense_len
 562 #define XS_CUR_SNSLEN(ccb)      (ccb->sense_len - ccb->sense_resid)
 563
 564 #define XS_SNSKEY(ccb)          (scsi_get_sense_key(&(ccb)->sense_data, \
 565                                  ccb->sense_len - ccb->sense_resid, 1))
 566
 567 #define XS_SNSASC(ccb)          (scsi_get_asc(&(ccb)->sense_data,       \
 568                                  ccb->sense_len - ccb->sense_resid, 1))
 569
 570 #define XS_SNSASCQ(ccb)         (scsi_get_ascq(&(ccb)->sense_data,      \
 571                                  ccb->sense_len - ccb->sense_resid, 1))
 572 #define XS_TAG_P(ccb)   \
 573         (((ccb)->ccb_h.flags & CAM_TAG_ACTION_VALID) && \
 574          (ccb)->tag_action != CAM_TAG_ACTION_NONE)
 575
 576 #define XS_TAG_TYPE(ccb)        \
 577         ((ccb->tag_action == MSG_SIMPLE_Q_TAG)? REQFLAG_STAG : \
 578          ((ccb->tag_action == MSG_HEAD_OF_Q_TAG)? REQFLAG_HTAG : REQFLAG_OTAG))
 579
 580
 581 #define XS_SETERR(ccb, v)       (ccb)->ccb_h.status &= ~CAM_STATUS_MASK, \
 582                                 (ccb)->ccb_h.status |= v
 583
 584 #       define  HBA_NOERROR             CAM_REQ_INPROG
 585 #       define  HBA_BOTCH               CAM_UNREC_HBA_ERROR
 586 #       define  HBA_CMDTIMEOUT          CAM_CMD_TIMEOUT
 587 #       define  HBA_SELTIMEOUT          CAM_SEL_TIMEOUT
 588 #       define  HBA_TGTBSY              CAM_SCSI_STATUS_ERROR
 589 #       define  HBA_BUSRESET            CAM_SCSI_BUS_RESET
 590 #       define  HBA_ABORTED             CAM_REQ_ABORTED
 591 #       define  HBA_DATAOVR             CAM_DATA_RUN_ERR
 592 #       define  HBA_ARQFAIL             CAM_AUTOSENSE_FAIL
 593
 594
 595 #define XS_ERR(ccb)             ((ccb)->ccb_h.status & CAM_STATUS_MASK)
 596
 597 #define XS_NOERR(ccb)           (((ccb)->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_INPROG)
 598
 599 #define XS_INITERR(ccb)         XS_SETERR(ccb, CAM_REQ_INPROG), ccb->sense_resid = ccb->sense_len
 600
 601 #define XS_SAVE_SENSE(xs, sense_ptr, totslen, slen)     do {                    \
 602                 uint32_t tlen = slen;                                           \
 603                 if (tlen > (xs)->sense_len)                                     \
 604                         tlen = (xs)->sense_len;                                 \
 605                 PISP_PCMD(xs)->totslen = imin((xs)->sense_len, totslen);        \
 606                 PISP_PCMD(xs)->cumslen = tlen;                                  \
 607                 memcpy(&(xs)->sense_data, sense_ptr, tlen);                     \
 608                 (xs)->sense_resid = (xs)->sense_len - tlen;                     \
 609                 (xs)->ccb_h.status |= CAM_AUTOSNS_VALID;                        \
 610         } while (0)
 611
 612 #define XS_SENSE_APPEND(xs, xsnsp, xsnsl)       do {                            \
 613                 uint32_t off = PISP_PCMD(xs)->cumslen;                          \
 614                 uint8_t *ptr = &((uint8_t *)(&(xs)->sense_data))[off];          \
 615                 uint32_t amt = imin(xsnsl, PISP_PCMD(xs)->totslen - off);       \
 616                 if (amt) {                                                      \
 617                         memcpy(ptr, xsnsp, amt);                                \
 618                         (xs)->sense_resid -= amt;                               \
 619                         PISP_PCMD(xs)->cumslen += amt;                          \
 620                 }                                                               \
 621         } while (0)
 622
 623 #define XS_SENSE_VALID(xs)      (((xs)->ccb_h.status & CAM_AUTOSNS_VALID) != 0)
 624
 625 #define DEFAULT_FRAMESIZE(isp)          isp->isp_osinfo.framesize
 626 #define DEFAULT_EXEC_THROTTLE(isp)      isp->isp_osinfo.exec_throttle
 627
 628 #define GET_DEFAULT_ROLE(isp, chan)     \
 629         (IS_FC(isp)? ISP_FC_PC(isp, chan)->def_role : ISP_SPI_PC(isp, chan)->def_role)
 630 #define SET_DEFAULT_ROLE(isp, chan, val)                \
 631         if (IS_FC(isp)) {                               \
 632                 ISP_FC_PC(isp, chan)->def_role = val;   \
 633         } else {                                        \
 634                 ISP_SPI_PC(isp, chan)->def_role = val;  \
 635         }
 636
 637 #define DEFAULT_IID(isp, chan)          isp->isp_osinfo.pc.spi[chan].iid
 638
 639 #define DEFAULT_LOOPID(x, chan)         isp->isp_osinfo.pc.fc[chan].default_id
 640
 641 #define DEFAULT_NODEWWN(isp, chan)      isp_default_wwn(isp, chan, 0, 1)
 642 #define DEFAULT_PORTWWN(isp, chan)      isp_default_wwn(isp, chan, 0, 0)
 643 #define ACTIVE_NODEWWN(isp, chan)       isp_default_wwn(isp, chan, 1, 1)
 644 #define ACTIVE_PORTWWN(isp, chan)       isp_default_wwn(isp, chan, 1, 0)
 645
 646
 647 #if     BYTE_ORDER == BIG_ENDIAN
 648 #ifdef  ISP_SBUS_SUPPORTED
 649 #define ISP_IOXPUT_8(isp, s, d)         *(d) = s
 650 #define ISP_IOXPUT_16(isp, s, d)                                \
 651         *(d) = (isp->isp_bustype == ISP_BT_SBUS)? s : bswap16(s)
 652 #define ISP_IOXPUT_32(isp, s, d)                                \
 653         *(d) = (isp->isp_bustype == ISP_BT_SBUS)? s : bswap32(s)
 654 #define ISP_IOXGET_8(isp, s, d)         d = (*((uint8_t *)s))
 655 #define ISP_IOXGET_16(isp, s, d)                                \
 656         d = (isp->isp_bustype == ISP_BT_SBUS)?                  \
 657         *((uint16_t *)s) : bswap16(*((uint16_t *)s))
 658 #define ISP_IOXGET_32(isp, s, d)                                \
 659         d = (isp->isp_bustype == ISP_BT_SBUS)?                  \
 660         *((uint32_t *)s) : bswap32(*((uint32_t *)s))
 661
 662 #else   /* ISP_SBUS_SUPPORTED */
 663 #define ISP_IOXPUT_8(isp, s, d)         *(d) = s
 664 #define ISP_IOXPUT_16(isp, s, d)        *(d) = bswap16(s)
 665 #define ISP_IOXPUT_32(isp, s, d)        *(d) = bswap32(s)
 666 #define ISP_IOXGET_8(isp, s, d)         d = (*((uint8_t *)s))
 667 #define ISP_IOXGET_16(isp, s, d)        d = bswap16(*((uint16_t *)s))
 668 #define ISP_IOXGET_32(isp, s, d)        d = bswap32(*((uint32_t *)s))
 669 #endif
 670 #define ISP_SWIZZLE_NVRAM_WORD(isp, rp) *rp = bswap16(*rp)
 671 #define ISP_SWIZZLE_NVRAM_LONG(isp, rp) *rp = bswap32(*rp)
 672
 673 #define ISP_IOZGET_8(isp, s, d)         d = (*((uint8_t *)s))
 674 #define ISP_IOZGET_16(isp, s, d)        d = (*((uint16_t *)s))
 675 #define ISP_IOZGET_32(isp, s, d)        d = (*((uint32_t *)s))
 676 #define ISP_IOZPUT_8(isp, s, d)         *(d) = s
 677 #define ISP_IOZPUT_16(isp, s, d)        *(d) = s
 678 #define ISP_IOZPUT_32(isp, s, d)        *(d) = s
 679
 680
 681 #else
 682 #define ISP_IOXPUT_8(isp, s, d)         *(d) = s
 683 #define ISP_IOXPUT_16(isp, s, d)        *(d) = s
 684 #define ISP_IOXPUT_32(isp, s, d)        *(d) = s
 685 #define ISP_IOXGET_8(isp, s, d)         d = *(s)
 686 #define ISP_IOXGET_16(isp, s, d)        d = *(s)
 687 #define ISP_IOXGET_32(isp, s, d)        d = *(s)
 688 #define ISP_SWIZZLE_NVRAM_WORD(isp, rp)
 689 #define ISP_SWIZZLE_NVRAM_LONG(isp, rp)
 690
 691 #define ISP_IOZPUT_8(isp, s, d)         *(d) = s
 692 #define ISP_IOZPUT_16(isp, s, d)        *(d) = bswap16(s)
 693 #define ISP_IOZPUT_32(isp, s, d)        *(d) = bswap32(s)
 694
 695 #define ISP_IOZGET_8(isp, s, d)         d = (*((uint8_t *)(s)))
 696 #define ISP_IOZGET_16(isp, s, d)        d = bswap16(*((uint16_t *)(s)))
 697 #define ISP_IOZGET_32(isp, s, d)        d = bswap32(*((uint32_t *)(s)))
 698
 699 #endif
 700
 701 #define ISP_SWAP16(isp, s)      bswap16(s)
 702 #define ISP_SWAP32(isp, s)      bswap32(s)
 703
 704 /*
 705  * Includes of common header files
 706  */
 707
 708 #include <dev/isp/ispreg.h>
 709 #include <dev/isp/ispvar.h>
 710 #include <dev/isp/ispmbox.h>
 711
 712 /*
 713  * isp_osinfo definiitions && shorthand
 714  */
 715 #define SIMQFRZ_RESOURCE        0x1
 716 #define SIMQFRZ_LOOPDOWN        0x2
 717 #define SIMQFRZ_TIMED           0x4
 718
 719 #define isp_dev         isp_osinfo.dev
 720
 721 /*
 722  * prototypes for isp_pci && isp_freebsd to share
 723  */
 724 extern int isp_attach(ispsoftc_t *);
 725 extern int isp_detach(ispsoftc_t *);
 726 extern void isp_uninit(ispsoftc_t *);
 727 extern uint64_t isp_default_wwn(ispsoftc_t *, int, int, int);
 728
 729 /*
 730  * driver global data
 731  */
 732 extern int isp_announced;
 733 extern int isp_fabric_hysteresis;
 734 extern int isp_loop_down_limit;
 735 extern int isp_gone_device_time;
 736 extern int isp_quickboot_time;
 737 extern int isp_autoconfig;
 738
 739 /*
 740  * Platform private flags
 741  */
 742
 743 /*
 744  * Platform Library Functions
 745  */
 746 void isp_prt(ispsoftc_t *, int level, const char *, ...) __printflike(3, 4);
 747 void isp_xs_prt(ispsoftc_t *, XS_T *, int level, const char *, ...) __printflike(4, 5);
 748 uint64_t isp_nanotime_sub(struct timespec *, struct timespec *);
 749 int isp_mbox_acquire(ispsoftc_t *);
 750 void isp_mbox_wait_complete(ispsoftc_t *, mbreg_t *);
 751 void isp_mbox_notify_done(ispsoftc_t *);
 752 void isp_mbox_release(ispsoftc_t *);
 753 int isp_fc_scratch_acquire(ispsoftc_t *, int);
 754 int isp_mstohz(int);
 755 void isp_platform_intr(void *);
 756 void isp_common_dmateardown(ispsoftc_t *, struct ccb_scsiio *, uint32_t);
 757 void isp_fcp_reset_crn(struct isp_fc *, uint32_t, int);
 758 int isp_fcp_next_crn(ispsoftc_t *, uint8_t *, XS_T *);
 759
 760 /*
 761  * Platform Version specific defines
 762  */
 763 #define BUS_DMA_ROOTARG(x)      bus_get_dma_tag(x)
 764 #define isp_dma_tag_create(a, b, c, d, e, f, g, h, i, j, k, z)  \
 765         bus_dma_tag_create(a, b, c, d, e, f, g, h, i, j, k, \
 766         busdma_lock_mutex, &isp->isp_osinfo.lock, z)
 767
 768 #define isp_setup_intr  bus_setup_intr
 769
 770 #define isp_sim_alloc(a, b, c, d, e, f, g, h)   \
 771         cam_sim_alloc(a, b, c, d, e, &(d)->isp_osinfo.lock, f, g, h)
 772
 773 #define ISP_PATH_PRT(i, l, p, ...)                                      \
 774         if ((l) == ISP_LOGALL || ((l)& (i)->isp_dblev) != 0) {          \
 775                 xpt_print(p, __VA_ARGS__);                              \
 776         }
 777
 778 /*
 779  * Platform specific inline functions
 780  */
 781
 782 /*
 783  * ISP General Library functions
 784  */
 785
 786 #include <dev/isp/isp_library.h>
 787
 788 #endif  /* _ISP_FREEBSD_H */