sys/dev/isp/isp_freebsd.h

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