sys/dev/disk/isp/isp_freebsd.h

   1 /* $FreeBSD: src/sys/dev/isp/isp_freebsd.h,v 1.120 2011/11/06 00:44:40 mjacob Exp $ */
   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/cpu.h>
  48 #include <machine/stdarg.h>
  49
  50 #include <bus/cam/cam.h>
  51 #include <bus/cam/cam_debug.h>
  52 #include <bus/cam/cam_ccb.h>
  53 #include <bus/cam/cam_sim.h>
  54 #include <bus/cam/cam_xpt.h>
  55 #include <bus/cam/cam_xpt_sim.h>
  56 #include <bus/cam/cam_debug.h>
  57 #include <bus/cam/scsi/scsi_all.h>
  58 #include <bus/cam/scsi/scsi_message.h>
  59
  60 #include "opt_isp.h"
  61
  62 #define ISP_PLATFORM_VERSION_MAJOR      7
  63 #define ISP_PLATFORM_VERSION_MINOR      0
  64
  65 /*
  66  * Efficiency- get rid of SBus code && tests unless we need them.
  67  */
  68 #define ISP_SBUS_SUPPORTED      0
  69
  70 #define ISP_IFLAGS      INTR_MPSAFE
  71
  72 #ifdef  ISP_TARGET_MODE
  73 #define ISP_TARGET_FUNCTIONS    1
  74 #define ATPDPSIZE       4096
  75
  76 #include <dev/disk/isp/isp_target.h>
  77
  78 typedef struct {
  79         void *          next;
  80         uint32_t        orig_datalen;
  81         uint32_t        bytes_xfered;
  82         uint32_t        last_xframt;
  83         uint32_t        tag;
  84         uint32_t        lun;
  85         uint32_t        nphdl;
  86         uint32_t        sid;
  87         uint32_t        portid;
  88         uint32_t
  89                         oxid    : 16,
  90                         cdb0    : 8,
  91                                 : 1,
  92                         dead    : 1,
  93                         tattr   : 3,
  94                         state   : 3;
  95 } atio_private_data_t;
  96 #define ATPD_STATE_FREE                 0
  97 #define ATPD_STATE_ATIO                 1
  98 #define ATPD_STATE_CAM                  2
  99 #define ATPD_STATE_CTIO                 3
 100 #define ATPD_STATE_LAST_CTIO            4
 101 #define ATPD_STATE_PDON                 5
 102
 103 typedef union inot_private_data inot_private_data_t;
 104 union inot_private_data {
 105         inot_private_data_t *next;
 106         struct {
 107                 isp_notify_t nt;        /* must be first! */
 108                 uint8_t data[64];       /* sb QENTRY_LEN, but order of definitions is wrong */
 109                 uint32_t tag_id, seq_id;
 110         } rd;
 111 };
 112
 113 typedef struct tstate {
 114         SLIST_ENTRY(tstate) next;
 115         struct cam_path *owner;
 116         struct ccb_hdr_slist atios;
 117         struct ccb_hdr_slist inots;
 118         uint32_t hold;
 119         int atio_count;
 120         int inot_count;
 121         inot_private_data_t *   restart_queue;
 122         inot_private_data_t *   ntfree;
 123         inot_private_data_t     ntpool[ATPDPSIZE];
 124         atio_private_data_t *   atfree;
 125         atio_private_data_t     atpool[ATPDPSIZE];
 126 } tstate_t;
 127
 128 #define LUN_HASH_SIZE           32
 129 #define LUN_HASH_FUNC(lun)      ((lun) & (LUN_HASH_SIZE - 1))
 130
 131 #endif
 132
 133 /*
 134  * Per command info.
 135  */
 136 struct isp_pcmd {
 137         struct isp_pcmd *       next;
 138         bus_dmamap_t            dmap;   /* dma map for this command */
 139         struct ispsoftc *       isp;    /* containing isp */
 140         struct callout          wdog;   /* watchdog timer */
 141 };
 142 #define ISP_PCMD(ccb)           (ccb)->ccb_h.spriv_ptr1
 143 #define PISP_PCMD(ccb)          ((struct isp_pcmd *)ISP_PCMD(ccb))
 144
 145 /*
 146  * Per channel information
 147  */
 148 SLIST_HEAD(tslist, tstate);
 149
 150 struct isp_fc {
 151         struct cam_sim *sim;
 152         struct cam_path *path;
 153         struct ispsoftc *isp;
 154         struct thread *kthread;
 155         bus_dma_tag_t tdmat;
 156         bus_dmamap_t tdmap;
 157         uint64_t def_wwpn;
 158         uint64_t def_wwnn;
 159         uint32_t loop_down_time;
 160         uint32_t loop_down_limit;
 161         uint32_t gone_device_time;
 162         uint32_t
 163 #ifdef  ISP_TARGET_MODE
 164 #ifdef  ISP_INTERNAL_TARGET
 165                 proc_active     : 1,
 166 #endif
 167                 tm_luns_enabled : 1,
 168                 tm_enable_defer : 1,
 169                 tm_enabled      : 1,
 170 #endif
 171                 simqfrozen      : 3,
 172                 default_id      : 8,
 173                 hysteresis      : 8,
 174                 def_role        : 2,    /* default role */
 175                 gdt_running     : 1,
 176                 loop_dead       : 1,
 177                 fcbsy           : 1,
 178                 ready           : 1;
 179         struct callout ldt;     /* loop down timer */
 180         struct callout gdt;     /* gone device timer */
 181         struct task ltask;
 182         struct task gtask;
 183 #ifdef  ISP_TARGET_MODE
 184         struct tslist lun_hash[LUN_HASH_SIZE];
 185 #ifdef  ISP_INTERNAL_TARGET
 186         struct proc *           target_proc;
 187 #endif
 188 #endif
 189 };
 190
 191 struct isp_spi {
 192         struct cam_sim *sim;
 193         struct cam_path *path;
 194         uint32_t
 195 #ifdef  ISP_TARGET_MODE
 196 #ifdef  ISP_INTERNAL_TARGET
 197                 proc_active     : 1,
 198 #endif
 199                 tm_luns_enabled : 1,
 200                 tm_enable_defer : 1,
 201                 tm_enabled      : 1,
 202 #endif
 203                 simqfrozen      : 3,
 204                 def_role        : 2,
 205                 iid             : 4;
 206 #ifdef  ISP_TARGET_MODE
 207         struct tslist lun_hash[LUN_HASH_SIZE];
 208 #ifdef  ISP_INTERNAL_TARGET
 209         struct proc *           target_proc;
 210 #endif
 211 #endif
 212 };
 213
 214 struct isposinfo {
 215         /*
 216          * Linkage, locking, and identity
 217          */
 218         struct lock             lock;
 219         device_t                dev;
 220         struct cdev *           cdev;
 221         struct intr_config_hook ehook;
 222         struct cam_devq *       devq;
 223         struct sysctl_ctx_list  sysctl_ctx;
 224         struct sysctl_oid       *sysctl_tree;
 225
 226         /*
 227          * Firmware pointer
 228          */
 229         const struct firmware * fw;
 230
 231         /*
 232          * DMA related sdtuff
 233          */
 234         bus_space_tag_t         bus_tag;
 235         bus_dma_tag_t           dmat;
 236         bus_space_handle_t      bus_handle;
 237         bus_dma_tag_t           cdmat;
 238         bus_dmamap_t            cdmap;
 239
 240         /*
 241          * Command and transaction related related stuff
 242          */
 243         struct isp_pcmd *       pcmd_pool;
 244         struct isp_pcmd *       pcmd_free;
 245
 246         uint32_t
 247 #ifdef  ISP_TARGET_MODE
 248                 tmwanted        : 1,
 249                 tmbusy          : 1,
 250 #else
 251                                 : 2,
 252 #endif
 253                 forcemulti      : 1,
 254                 timer_active    : 1,
 255                 autoconf        : 1,
 256                 ehook_active    : 1,
 257                 disabled        : 1,
 258                 mbox_sleeping   : 1,
 259                 mbox_sleep_ok   : 1,
 260                 mboxcmd_done    : 1,
 261                 mboxbsy         : 1;
 262
 263         struct callout          tmo;    /* general timer */
 264
 265         /*
 266          * misc- needs to be sorted better XXXXXX
 267          */
 268         int                     framesize;
 269         int                     exec_throttle;
 270         int                     cont_max;
 271
 272 #ifdef  ISP_TARGET_MODE
 273         cam_status *            rptr;
 274 #endif
 275
 276         /*
 277          * Per-type private storage...
 278          */
 279         union {
 280                 struct isp_fc *fc;
 281                 struct isp_spi *spi;
 282                 void *ptr;
 283         } pc;
 284 };
 285 #define ISP_FC_PC(isp, chan)    (&(isp)->isp_osinfo.pc.fc[(chan)])
 286 #define ISP_SPI_PC(isp, chan)   (&(isp)->isp_osinfo.pc.spi[(chan)])
 287 #define ISP_GET_PC(isp, chan, tag, rslt)                \
 288         if (IS_SCSI(isp)) {                             \
 289                 rslt = ISP_SPI_PC(isp, chan)-> tag;     \
 290         } else {                                        \
 291                 rslt = ISP_FC_PC(isp, chan)-> tag;      \
 292         }
 293 #define ISP_GET_PC_ADDR(isp, chan, tag, rp)             \
 294         if (IS_SCSI(isp)) {                             \
 295                 rp = &ISP_SPI_PC(isp, chan)-> tag;      \
 296         } else {                                        \
 297                 rp = &ISP_FC_PC(isp, chan)-> tag;       \
 298         }
 299 #define ISP_SET_PC(isp, chan, tag, val)                 \
 300         if (IS_SCSI(isp)) {                             \
 301                 ISP_SPI_PC(isp, chan)-> tag = val;      \
 302         } else {                                        \
 303                 ISP_FC_PC(isp, chan)-> tag = val;       \
 304         }
 305
 306 #define isp_lock        isp_osinfo.lock
 307 #define isp_bus_tag     isp_osinfo.bus_tag
 308 #define isp_bus_handle  isp_osinfo.bus_handle
 309
 310 /*
 311  * Locking macros...
 312  */
 313 #define ISP_LOCK(isp)   lockmgr(&isp->isp_osinfo.lock, LK_EXCLUSIVE)
 314 #define ISP_UNLOCK(isp) lockmgr(&isp->isp_osinfo.lock, LK_RELEASE)
 315
 316 /*
 317  * Required Macros/Defines
 318  */
 319
 320 #define ISP_FC_SCRLEN           0x1000
 321
 322 #define ISP_MEMZERO(a, b)       memset(a, 0, b)
 323 #define ISP_MEMCPY              memcpy
 324 #define ISP_SNPRINTF            ksnprintf
 325 #define ISP_DELAY               DELAY
 326 #define ISP_SLEEP(isp, x)       DELAY(x)
 327
 328 #define ISP_MIN                 imin
 329
 330 #ifndef DIAGNOSTIC
 331 #define ISP_INLINE              __inline
 332 #else
 333 #define ISP_INLINE
 334 #endif
 335
 336 #define NANOTIME_T              struct timespec
 337 #define GET_NANOTIME            nanotime
 338 #define GET_NANOSEC(x)          ((x)->tv_sec * 1000000000 + (x)->tv_nsec)
 339 #define NANOTIME_SUB            isp_nanotime_sub
 340
 341 #define MAXISPREQUEST(isp)      ((IS_FC(isp) || IS_ULTRA2(isp))? 1024 : 256)
 342
 343 #define MEMORYBARRIER(isp, type, offset, size, chan)            \
 344 switch (type) {                                                 \
 345 case SYNC_SFORDEV:                                              \
 346 {                                                               \
 347         struct isp_fc *fc = ISP_FC_PC(isp, chan);               \
 348         bus_dmamap_sync(fc->tdmat, fc->tdmap,                   \
 349            BUS_DMASYNC_PREREAD | BUS_DMASYNC_PREWRITE);         \
 350         break;                                                  \
 351 }                                                               \
 352 case SYNC_REQUEST:                                              \
 353         bus_dmamap_sync(isp->isp_osinfo.cdmat,                  \
 354            isp->isp_osinfo.cdmap,                               \
 355            BUS_DMASYNC_PREREAD | BUS_DMASYNC_PREWRITE);         \
 356         break;                                                  \
 357 case SYNC_SFORCPU:                                              \
 358 {                                                               \
 359         struct isp_fc *fc = ISP_FC_PC(isp, chan);               \
 360         bus_dmamap_sync(fc->tdmat, fc->tdmap,                   \
 361            BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE);       \
 362         break;                                                  \
 363 }                                                               \
 364 case SYNC_RESULT:                                               \
 365         bus_dmamap_sync(isp->isp_osinfo.cdmat,                  \
 366            isp->isp_osinfo.cdmap,                               \
 367            BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE);       \
 368         break;                                                  \
 369 case SYNC_REG:                                                  \
 370         bus_space_barrier(isp->isp_osinfo.bus_tag,              \
 371             isp->isp_osinfo.bus_handle, offset, size,           \
 372             BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);  \
 373         break;                                                  \
 374 default:                                                        \
 375         break;                                                  \
 376 }
 377
 378 #define MBOX_ACQUIRE                    isp_mbox_acquire
 379 #define MBOX_WAIT_COMPLETE              isp_mbox_wait_complete
 380 #define MBOX_NOTIFY_COMPLETE            isp_mbox_notify_done
 381 #define MBOX_RELEASE                    isp_mbox_release
 382
 383 #define FC_SCRATCH_ACQUIRE              isp_fc_scratch_acquire
 384 #define FC_SCRATCH_RELEASE(isp, chan)   isp->isp_osinfo.pc.fc[chan].fcbsy = 0
 385
 386 #ifndef SCSI_GOOD
 387 #define SCSI_GOOD       SCSI_STATUS_OK
 388 #endif
 389 #ifndef SCSI_CHECK
 390 #define SCSI_CHECK      SCSI_STATUS_CHECK_COND
 391 #endif
 392 #ifndef SCSI_BUSY
 393 #define SCSI_BUSY       SCSI_STATUS_BUSY
 394 #endif
 395 #ifndef SCSI_QFULL
 396 #define SCSI_QFULL      SCSI_STATUS_QUEUE_FULL
 397 #endif
 398
 399 #define XS_T                    struct ccb_scsiio
 400 #define XS_DMA_ADDR_T           bus_addr_t
 401 #define XS_GET_DMA64_SEG(a, b, c)               \
 402 {                                               \
 403         ispds64_t *d = a;                       \
 404         bus_dma_segment_t *e = b;               \
 405         uint32_t f = c;                         \
 406         e += f;                                 \
 407         d->ds_base = DMA_LO32(e->ds_addr);      \
 408         d->ds_basehi = DMA_HI32(e->ds_addr);    \
 409         d->ds_count = e->ds_len;                \
 410 }
 411 #define XS_GET_DMA_SEG(a, b, c)                 \
 412 {                                               \
 413         ispds_t *d = a;                         \
 414         bus_dma_segment_t *e = b;               \
 415         uint32_t f = c;                         \
 416         e += f;                                 \
 417         d->ds_base = DMA_LO32(e->ds_addr);      \
 418         d->ds_count = e->ds_len;                \
 419 }
 420 #define XS_ISP(ccb)             cam_sim_softc(xpt_path_sim((ccb)->ccb_h.path))
 421 #define XS_CHANNEL(ccb)         cam_sim_bus(xpt_path_sim((ccb)->ccb_h.path))
 422 #define XS_TGT(ccb)             (ccb)->ccb_h.target_id
 423 #define XS_LUN(ccb)             (ccb)->ccb_h.target_lun
 424
 425 #define XS_CDBP(ccb)    \
 426         (((ccb)->ccb_h.flags & CAM_CDB_POINTER)? \
 427          (ccb)->cdb_io.cdb_ptr : (ccb)->cdb_io.cdb_bytes)
 428
 429 #define XS_CDBLEN(ccb)          (ccb)->cdb_len
 430 #define XS_XFRLEN(ccb)          (ccb)->dxfer_len
 431 #define XS_TIME(ccb)            (ccb)->ccb_h.timeout
 432 #define XS_GET_RESID(ccb)       (ccb)->resid
 433 #define XS_SET_RESID(ccb, r)    (ccb)->resid = r
 434 #define XS_STSP(ccb)            (&(ccb)->scsi_status)
 435 #define XS_SNSP(ccb)            (&(ccb)->sense_data)
 436
 437 #define XS_SNSLEN(ccb)          \
 438         imin((sizeof((ccb)->sense_data)), ccb->sense_len - ccb->sense_resid)
 439
 440 #define XS_SNSKEY(ccb)          (scsi_get_sense_key(&(ccb)->sense_data, \
 441                                  ccb->sense_len - ccb->sense_resid,     \
 442                                  /*show_errors*/ 1))
 443
 444 #define XS_SNSASC(ccb)          (scsi_get_asc(&(ccb)->sense_data,       \
 445                                  ccb->sense_len - ccb->sense_resid,     \
 446                                  /*show_errors*/ 1))
 447
 448 #define XS_SNSASCQ(ccb)         (scsi_get_ascq(&(ccb)->sense_data,      \
 449                                  ccb->sense_len - ccb->sense_resid,     \
 450                                  /*show_errors*/ 1))
 451 #define XS_TAG_P(ccb)   \
 452         (((ccb)->ccb_h.flags & CAM_TAG_ACTION_VALID) && \
 453          (ccb)->tag_action != CAM_TAG_ACTION_NONE)
 454
 455 #define XS_TAG_TYPE(ccb)        \
 456         ((ccb->tag_action == MSG_SIMPLE_Q_TAG)? REQFLAG_STAG : \
 457          ((ccb->tag_action == MSG_HEAD_OF_Q_TAG)? REQFLAG_HTAG : REQFLAG_OTAG))
 458
 459
 460 #define XS_SETERR(ccb, v)       (ccb)->ccb_h.status &= ~CAM_STATUS_MASK, \
 461                                 (ccb)->ccb_h.status |= v, \
 462                                 (ccb)->ccb_h.spriv_field0 |= ISP_SPRIV_ERRSET
 463
 464 #       define  HBA_NOERROR             CAM_REQ_INPROG
 465 #       define  HBA_BOTCH               CAM_UNREC_HBA_ERROR
 466 #       define  HBA_CMDTIMEOUT          CAM_CMD_TIMEOUT
 467 #       define  HBA_SELTIMEOUT          CAM_SEL_TIMEOUT
 468 #       define  HBA_TGTBSY              CAM_SCSI_STATUS_ERROR
 469 #       define  HBA_BUSRESET            CAM_SCSI_BUS_RESET
 470 #       define  HBA_ABORTED             CAM_REQ_ABORTED
 471 #       define  HBA_DATAOVR             CAM_DATA_RUN_ERR
 472 #       define  HBA_ARQFAIL             CAM_AUTOSENSE_FAIL
 473
 474
 475 #define XS_ERR(ccb)             ((ccb)->ccb_h.status & CAM_STATUS_MASK)
 476
 477 #define XS_NOERR(ccb)           \
 478         (((ccb)->ccb_h.spriv_field0 & ISP_SPRIV_ERRSET) == 0 || \
 479          ((ccb)->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_INPROG)
 480
 481 #define XS_INITERR(ccb)         \
 482         XS_SETERR(ccb, CAM_REQ_INPROG), (ccb)->ccb_h.spriv_field0 = 0
 483
 484 #define XS_SAVE_SENSE(xs, sense_ptr, slen)      do {                    \
 485                 (xs)->ccb_h.status |= CAM_AUTOSNS_VALID;                \
 486                 memset(&(xs)->sense_data, 0, sizeof((xs)->sense_data)); \
 487                 memcpy(&(xs)->sense_data, sense_ptr, imin(XS_SNSLEN(xs),\
 488                        slen));                                          \
 489                 if (slen < (xs)->sense_len)                             \
 490                         (xs)->sense_resid = (xs)->sense_len - slen;     \
 491         } while (0);
 492
 493 #define XS_SENSE_VALID(xs)      (((xs)->ccb_h.status & CAM_AUTOSNS_VALID) != 0)
 494
 495 #define DEFAULT_FRAMESIZE(isp)          isp->isp_osinfo.framesize
 496 #define DEFAULT_EXEC_THROTTLE(isp)      isp->isp_osinfo.exec_throttle
 497
 498 #define GET_DEFAULT_ROLE(isp, chan)     \
 499         (IS_FC(isp)? ISP_FC_PC(isp, chan)->def_role : ISP_SPI_PC(isp, chan)->def_role)
 500 #define SET_DEFAULT_ROLE(isp, chan, val)                \
 501         if (IS_FC(isp)) {                               \
 502                 ISP_FC_PC(isp, chan)->def_role = val;   \
 503         } else {                                        \
 504                 ISP_SPI_PC(isp, chan)->def_role = val;  \
 505         }
 506
 507 #define DEFAULT_IID(isp, chan)          isp->isp_osinfo.pc.spi[chan].iid
 508
 509 #define DEFAULT_LOOPID(x, chan)         isp->isp_osinfo.pc.fc[chan].default_id
 510
 511 #define DEFAULT_NODEWWN(isp, chan)      isp_default_wwn(isp, chan, 0, 1)
 512 #define DEFAULT_PORTWWN(isp, chan)      isp_default_wwn(isp, chan, 0, 0)
 513 #define ACTIVE_NODEWWN(isp, chan)       isp_default_wwn(isp, chan, 1, 1)
 514 #define ACTIVE_PORTWWN(isp, chan)       isp_default_wwn(isp, chan, 1, 0)
 515
 516
 517 #if     BYTE_ORDER == BIG_ENDIAN
 518 #ifdef  ISP_SBUS_SUPPORTED
 519 #define ISP_IOXPUT_8(isp, s, d)         *(d) = s
 520 #define ISP_IOXPUT_16(isp, s, d)                                \
 521         *(d) = (isp->isp_bustype == ISP_BT_SBUS)? s : bswap16(s)
 522 #define ISP_IOXPUT_32(isp, s, d)                                \
 523         *(d) = (isp->isp_bustype == ISP_BT_SBUS)? s : bswap32(s)
 524 #define ISP_IOXGET_8(isp, s, d)         d = (*((uint8_t *)s))
 525 #define ISP_IOXGET_16(isp, s, d)                                \
 526         d = (isp->isp_bustype == ISP_BT_SBUS)?                  \
 527         *((uint16_t *)s) : bswap16(*((uint16_t *)s))
 528 #define ISP_IOXGET_32(isp, s, d)                                \
 529         d = (isp->isp_bustype == ISP_BT_SBUS)?                  \
 530         *((uint32_t *)s) : bswap32(*((uint32_t *)s))
 531
 532 #else   /* ISP_SBUS_SUPPORTED */
 533 #define ISP_IOXPUT_8(isp, s, d)         *(d) = s
 534 #define ISP_IOXPUT_16(isp, s, d)        *(d) = bswap16(s)
 535 #define ISP_IOXPUT_32(isp, s, d)        *(d) = bswap32(s)
 536 #define ISP_IOXGET_8(isp, s, d)         d = (*((uint8_t *)s))
 537 #define ISP_IOXGET_16(isp, s, d)        d = bswap16(*((uint16_t *)s))
 538 #define ISP_IOXGET_32(isp, s, d)        d = bswap32(*((uint32_t *)s))
 539 #endif
 540 #define ISP_SWIZZLE_NVRAM_WORD(isp, rp) *rp = bswap16(*rp)
 541 #define ISP_SWIZZLE_NVRAM_LONG(isp, rp) *rp = bswap32(*rp)
 542
 543 #define ISP_IOZGET_8(isp, s, d)         d = (*((uint8_t *)s))
 544 #define ISP_IOZGET_16(isp, s, d)        d = (*((uint16_t *)s))
 545 #define ISP_IOZGET_32(isp, s, d)        d = (*((uint32_t *)s))
 546 #define ISP_IOZPUT_8(isp, s, d)         *(d) = s
 547 #define ISP_IOZPUT_16(isp, s, d)        *(d) = s
 548 #define ISP_IOZPUT_32(isp, s, d)        *(d) = s
 549
 550
 551 #else
 552 #define ISP_IOXPUT_8(isp, s, d)         *(d) = s
 553 #define ISP_IOXPUT_16(isp, s, d)        *(d) = s
 554 #define ISP_IOXPUT_32(isp, s, d)        *(d) = s
 555 #define ISP_IOXGET_8(isp, s, d)         d = *(s)
 556 #define ISP_IOXGET_16(isp, s, d)        d = *(s)
 557 #define ISP_IOXGET_32(isp, s, d)        d = *(s)
 558 #define ISP_SWIZZLE_NVRAM_WORD(isp, rp)
 559 #define ISP_SWIZZLE_NVRAM_LONG(isp, rp)
 560
 561 #define ISP_IOZPUT_8(isp, s, d)         *(d) = s
 562 #define ISP_IOZPUT_16(isp, s, d)        *(d) = bswap16(s)
 563 #define ISP_IOZPUT_32(isp, s, d)        *(d) = bswap32(s)
 564
 565 #define ISP_IOZGET_8(isp, s, d)         d = (*((uint8_t *)(s)))
 566 #define ISP_IOZGET_16(isp, s, d)        d = bswap16(*((uint16_t *)(s)))
 567 #define ISP_IOZGET_32(isp, s, d)        d = bswap32(*((uint32_t *)(s)))
 568
 569 #endif
 570
 571 #define ISP_SWAP16(isp, s)      bswap16(s)
 572 #define ISP_SWAP32(isp, s)      bswap32(s)
 573
 574 /*
 575  * Includes of common header files
 576  */
 577
 578 #include <dev/disk/isp/ispreg.h>
 579 #include <dev/disk/isp/ispvar.h>
 580 #include <dev/disk/isp/ispmbox.h>
 581
 582 /*
 583  * isp_osinfo definiitions && shorthand
 584  */
 585 #define SIMQFRZ_RESOURCE        0x1
 586 #define SIMQFRZ_LOOPDOWN        0x2
 587 #define SIMQFRZ_TIMED           0x4
 588
 589 #define isp_dev         isp_osinfo.dev
 590 #define isp_sysctl_ctx  isp_osinfo.sysctl_ctx
 591 #define isp_sysctl_tree isp_osinfo.sysctl_tree
 592
 593 /*
 594  * prototypes for isp_pci && isp_freebsd to share
 595  */
 596 extern int isp_attach(ispsoftc_t *);
 597 extern int isp_detach(ispsoftc_t *);
 598 extern void isp_uninit(ispsoftc_t *);
 599 extern uint64_t isp_default_wwn(ispsoftc_t *, int, int, int);
 600
 601 /*
 602  * driver global data
 603  */
 604 extern int isp_announced;
 605 extern int isp_fabric_hysteresis;
 606 extern int isp_loop_down_limit;
 607 extern int isp_gone_device_time;
 608 extern int isp_quickboot_time;
 609 extern int isp_autoconfig;
 610
 611 /*
 612  * Platform private flags
 613  */
 614 #define ISP_SPRIV_ERRSET        0x1
 615 #define ISP_SPRIV_TACTIVE       0x2
 616 #define ISP_SPRIV_DONE          0x8
 617 #define ISP_SPRIV_WPEND         0x10
 618
 619 #define XS_S_TACTIVE(sccb)      (sccb)->ccb_h.spriv_field0 |= ISP_SPRIV_TACTIVE
 620 #define XS_C_TACTIVE(sccb)      (sccb)->ccb_h.spriv_field0 &= ~ISP_SPRIV_TACTIVE
 621 #define XS_TACTIVE_P(sccb)      ((sccb)->ccb_h.spriv_field0 & ISP_SPRIV_TACTIVE)
 622
 623 #define XS_CMD_S_DONE(sccb)     (sccb)->ccb_h.spriv_field0 |= ISP_SPRIV_DONE
 624 #define XS_CMD_C_DONE(sccb)     (sccb)->ccb_h.spriv_field0 &= ~ISP_SPRIV_DONE
 625 #define XS_CMD_DONE_P(sccb)     ((sccb)->ccb_h.spriv_field0 & ISP_SPRIV_DONE)
 626
 627 #define XS_CMD_S_WPEND(sccb)    (sccb)->ccb_h.spriv_field0 |= ISP_SPRIV_WPEND
 628 #define XS_CMD_C_WPEND(sccb)    (sccb)->ccb_h.spriv_field0 &= ~ISP_SPRIV_WPEND
 629 #define XS_CMD_WPEND_P(sccb)    ((sccb)->ccb_h.spriv_field0 & ISP_SPRIV_WPEND)
 630
 631
 632 #define XS_CMD_S_CLEAR(sccb)    (sccb)->ccb_h.spriv_field0 = 0
 633
 634 /*
 635  * Platform Library Functions
 636  */
 637 void isp_prt(ispsoftc_t *, int level, const char *, ...) __printflike(3, 4);
 638 void isp_xs_prt(ispsoftc_t *, XS_T *, int level, const char *, ...) __printflike(4, 5);
 639 uint64_t isp_nanotime_sub(struct timespec *, struct timespec *);
 640 int isp_mbox_acquire(ispsoftc_t *);
 641 void isp_mbox_wait_complete(ispsoftc_t *, mbreg_t *);
 642 void isp_mbox_notify_done(ispsoftc_t *);
 643 void isp_mbox_release(ispsoftc_t *);
 644 int isp_fc_scratch_acquire(ispsoftc_t *, int);
 645 int isp_mstohz(int);
 646 void isp_platform_intr(void *);
 647 void isp_common_dmateardown(ispsoftc_t *, struct ccb_scsiio *, uint32_t);
 648
 649 /*
 650  * Platform Version specific defines
 651  */
 652 #define BUS_DMA_ROOTARG(x)      bus_get_dma_tag(x)
 653 #define isp_dma_tag_create(a, b, c, d, e, f, g, h, i, j, k, z)  \
 654         bus_dma_tag_create(a, b, c, d, e, f, g, h, i, j, k, z)
 655
 656 #define isp_setup_intr  bus_setup_intr
 657
 658 #define isp_sim_alloc(a, b, c, d, e, f, g, h)   \
 659         cam_sim_alloc(a, b, c, d, e, &(d)->isp_osinfo.lock, f, g, h)
 660
 661 /* Should be BUS_SPACE_MAXSIZE, but MAXPHYS is larger than BUS_SPACE_MAXSIZE */
 662 #define ISP_NSEGS ((MAXPHYS / PAGE_SIZE) + 1)
 663
 664 #define ISP_PATH_PRT(i, l, p, ...)                                      \
 665         if ((l) == ISP_LOGALL || ((l)& (i)->isp_dblev) != 0) {          \
 666                 xpt_print(p, __VA_ARGS__);                              \
 667         }
 668
 669 /*
 670  * Platform specific inline functions
 671  */
 672
 673 /*
 674  * ISP General Library functions
 675  */
 676
 677 #include <dev/disk/isp/isp_library.h>
 678
 679 #endif  /* _ISP_FREEBSD_H */