sys/dev/isp/isp_freebsd.h

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