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