sys/dev/isp/isp_freebsd.h

root/sys/dev/isp/isp_freebsd.h
/*-
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Qlogic ISP SCSI Host Adapter FreeBSD Wrapper Definitions
 *
 * Copyright (c) 2009-2020 Alexander Motin <mav@FreeBSD.org>
 * Copyright (c) 1997-2008 by Matthew Jacob
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice immediately at the beginning of the file, without modification,
 *    this list of conditions, and the following disclaimer.
 * 2. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */
#ifndef _ISP_FREEBSD_H
#define _ISP_FREEBSD_H

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/endian.h>
#include <sys/jail.h>
#include <sys/lock.h>
#include <sys/kernel.h>
#include <sys/queue.h>
#include <sys/malloc.h>
#include <sys/mutex.h>
#include <sys/condvar.h>
#include <sys/rman.h>
#include <sys/stdarg.h>
#include <sys/sysctl.h>

#include <sys/proc.h>
#include <sys/bus.h>
#include <sys/taskqueue.h>

#include <machine/bus.h>
#include <machine/cpu.h>

#include <cam/cam.h>
#include <cam/cam_debug.h>
#include <cam/cam_ccb.h>
#include <cam/cam_sim.h>
#include <cam/cam_xpt.h>
#include <cam/cam_xpt_sim.h>
#include <cam/cam_debug.h>
#include <cam/scsi/scsi_all.h>
#include <cam/scsi/scsi_message.h>

#include "opt_ddb.h"
#include "opt_isp.h"

#define ISP_PLATFORM_VERSION_MAJOR      7
#define ISP_PLATFORM_VERSION_MINOR      10

#define ISP_IFLAGS      INTR_TYPE_CAM | INTR_ENTROPY | INTR_MPSAFE

#ifdef  ISP_TARGET_MODE
#define N_XCMDS         64
#define XCMD_SIZE       512
struct ispsoftc;
typedef union isp_ecmd {
        union isp_ecmd *        next;
        uint8_t                 data[XCMD_SIZE];
} isp_ecmd_t;
isp_ecmd_t *    isp_get_ecmd(struct ispsoftc *);
void            isp_put_ecmd(struct ispsoftc *, isp_ecmd_t *);

#define ATPDPSIZE       4096
#define ATPDPHASHSIZE   32
#define ATPDPHASH(x)    ((((x) >> 24) ^ ((x) >> 16) ^ ((x) >> 8) ^ (x)) &  \
                            ((ATPDPHASHSIZE) - 1))

#include <dev/isp/isp_target.h>
typedef struct atio_private_data {
        LIST_ENTRY(atio_private_data)   next;
        void *          ccb;
        uint32_t        tag;            /* typically f/w RX_ID */
        uint32_t        orig_datalen;
        uint32_t        bytes_xfered;
        uint32_t        bytes_in_transit;
        lun_id_t        lun;
        uint32_t        nphdl;
        uint32_t        sid;
        uint32_t        did;
        uint16_t        rxid;   /* wire rxid */
        uint16_t        oxid;   /* wire oxid */
        uint16_t        word3;  /* PRLI word3 params */
        uint16_t        ctcnt;  /* number of CTIOs currently active */
        uint8_t         seqno;  /* CTIO sequence number */
        uint8_t         cdb0;
        uint16_t        srr_notify_rcvd : 1,
                        sendst          : 1,
                        dead            : 1,
                        tattr           : 3,
                        state           : 3;
        void *          ests;
        /*
         * The current SRR notify copy
         */
        uint8_t         srr[64];        /*  sb QENTRY_LEN, but order of definitions is wrong */
        void *          srr_ccb;
        uint32_t        nsrr;
} atio_private_data_t;
#define ATPD_STATE_FREE                 0
#define ATPD_STATE_ATIO                 1
#define ATPD_STATE_CAM                  2
#define ATPD_STATE_CTIO                 3
#define ATPD_STATE_LAST_CTIO            4
#define ATPD_STATE_PDON                 5

#define ATPD_CCB_OUTSTANDING            16

#define ATPD_SEQ_MASK                   0x7f
#define ATPD_SEQ_NOTIFY_CAM             0x80
#define ATPD_SET_SEQNO(hdrp, atp)       ((isphdr_t *)hdrp)->rqs_seqno &= ~ATPD_SEQ_MASK, ((isphdr_t *)hdrp)->rqs_seqno |= (atp)->seqno
#define ATPD_GET_SEQNO(hdrp)            (((isphdr_t *)hdrp)->rqs_seqno & ATPD_SEQ_MASK)
#define ATPD_GET_NCAM(hdrp)             ((((isphdr_t *)hdrp)->rqs_seqno & ATPD_SEQ_NOTIFY_CAM) != 0)

typedef struct inot_private_data inot_private_data_t;
struct inot_private_data {
        STAILQ_ENTRY(inot_private_data) next;
        isp_notify_t nt;
        uint8_t data[64];       /* sb QENTRY_LEN, but order of definitions is wrong */
        uint32_t tag_id, seq_id;
};
typedef struct isp_timed_notify_ack {
        void *isp;
        void *not;
        uint8_t data[64];        /* sb QENTRY_LEN, but order of definitions is wrong */
        struct callout timer;
} isp_tna_t;

STAILQ_HEAD(ntpdlist, inot_private_data);
typedef struct tstate {
        SLIST_ENTRY(tstate)     next;
        lun_id_t                ts_lun;
        struct ccb_hdr_slist    atios;
        struct ccb_hdr_slist    inots;
        struct ntpdlist         restart_queue;
} tstate_t;

#define LUN_HASH_SIZE           32
#define LUN_HASH_FUNC(lun)      ((lun) & (LUN_HASH_SIZE - 1))

#endif

/*
 * Per command info.
 */
struct isp_pcmd {
        struct isp_pcmd *       next;
        bus_dmamap_t            dmap;           /* dma map for this command */
        struct callout          wdog;           /* watchdog timer */
        uint32_t                datalen;        /* data length for this command (target mode only) */
};
#define ISP_PCMD(ccb)           (ccb)->ccb_h.spriv_ptr1
#define PISP_PCMD(ccb)          ((struct isp_pcmd *)ISP_PCMD(ccb))

/*
 * Per nexus info.
 */
struct isp_nexus {
        uint64_t lun;                   /* LUN for target */
        uint32_t tgt;                   /* TGT for target */
        uint8_t crnseed;                /* next command reference number */
        struct isp_nexus *next;
};
#define NEXUS_HASH_WIDTH        32
#define INITIAL_NEXUS_COUNT     MAX_FC_TARG
#define NEXUS_HASH(tgt, lun)    ((tgt + lun) % NEXUS_HASH_WIDTH)

/*
 * Per channel information
 */
SLIST_HEAD(tslist, tstate);
TAILQ_HEAD(isp_ccbq, ccb_hdr);
LIST_HEAD(atpdlist, atio_private_data);

struct isp_fc {
        struct cam_sim *sim;
        struct cam_path *path;
        struct ispsoftc *isp;
        struct proc *kproc;
        bus_dmamap_t scmap;
        uint64_t def_wwpn;
        uint64_t def_wwnn;
        time_t loop_down_time;
        int loop_down_limit;
        int gone_device_time;
        /*
         * Per target/lun info- just to keep a per-ITL nexus crn count
         */
        struct isp_nexus *nexus_hash[NEXUS_HASH_WIDTH];
        struct isp_nexus *nexus_free_list;
        uint32_t
                simqfrozen      : 3,
                default_id      : 8,
                def_role        : 2,    /* default role */
                loop_seen_once  : 1,
                fcbsy           : 1,
                ready           : 1;
        struct callout gdt;     /* gone device timer */
        struct task gtask;
#ifdef  ISP_TARGET_MODE
        struct tslist           lun_hash[LUN_HASH_SIZE];
        struct isp_ccbq         waitq;          /* waiting CCBs */
        struct ntpdlist         ntfree;
        inot_private_data_t     ntpool[ATPDPSIZE];
        struct atpdlist         atfree;
        struct atpdlist         atused[ATPDPHASHSIZE];
        atio_private_data_t     atpool[ATPDPSIZE];
#if defined(DEBUG)
        unsigned int inject_lost_data_frame;
#endif
#endif
        int                     num_threads;
};

struct isposinfo {
        /*
         * Linkage, locking, and identity
         */
        struct mtx              lock;
        device_t                dev;
        struct cdev *           cdev;
        struct cam_devq *       devq;

        /*
         * Firmware pointer
         */
        const struct firmware * ispfw;

        /*
         * DMA related stuff
         */
        struct resource *       regs;
        struct resource *       regs2;
        bus_dma_tag_t           dmat;
        bus_dma_tag_t           reqdmat;
        bus_dma_tag_t           respdmat;
        bus_dma_tag_t           atiodmat;
        bus_dma_tag_t           iocbdmat;
        bus_dma_tag_t           scdmat;
        bus_dmamap_t            reqmap;
        bus_dmamap_t            respmap;
        bus_dmamap_t            atiomap;
        bus_dmamap_t            iocbmap;

        /*
         * Command and transaction related related stuff
         */
        struct isp_pcmd *       pcmd_pool;
        struct isp_pcmd *       pcmd_free;

        struct callout          tmo;    /* general timer */

        /*
         * misc- needs to be sorted better XXXXXX
         */
        int                     framesize;

#ifdef  ISP_TARGET_MODE
        bus_dma_tag_t           ecmd_dmat;
        bus_dmamap_t            ecmd_map;
        bus_addr_t              ecmd_dma;
        isp_ecmd_t *            ecmd_base;
        isp_ecmd_t *            ecmd_free;
#endif

        /*
         * Per-channel storage.
         */
        struct isp_fc           *fc;

        int                     is_exiting;
};
#define ISP_FC_PC(isp, chan)    (&(isp)->isp_osinfo.fc[(chan)])

#define FCP_NEXT_CRN    isp_fcp_next_crn
#define isp_lock        isp_osinfo.lock
#define isp_regs        isp_osinfo.regs
#define isp_regs2       isp_osinfo.regs2

/*
 * Locking macros...
 */
#define ISP_LOCK(isp)   mtx_lock(&(isp)->isp_lock)
#define ISP_UNLOCK(isp) mtx_unlock(&(isp)->isp_lock)
#define ISP_ASSERT_LOCKED(isp)  mtx_assert(&(isp)->isp_lock, MA_OWNED)

/*
 * Required Macros/Defines
 */
#define ISP_FC_SCRLEN           0x1000

#define ISP_MEMZERO(a, b)       memset(a, 0, b)
#define ISP_MEMCPY              memcpy
#define ISP_SNPRINTF            snprintf
#define ISP_DELAY(x)            DELAY(x)
#define ISP_SLEEP(isp, x)       msleep_sbt(&(isp)->isp_osinfo.is_exiting, \
    &(isp)->isp_lock, 0, "isp_sleep", (x) * SBT_1US, 0, 0)

#define ISP_MIN                 imin

#ifndef DIAGNOSTIC
#define ISP_INLINE              __inline
#else
#define ISP_INLINE
#endif

#define ISP_DMASETUP(isp, xs, req)      isp_dmasetup(isp, xs, req)
#define ISP_DMAFREE(isp, xs)            isp_dmafree(isp, xs)

#define NANOTIME_T              struct timespec
#define GET_NANOTIME            nanotime
#define GET_NANOSEC(x)          ((x)->tv_sec * 1000000000 + (x)->tv_nsec)
#define NANOTIME_SUB            isp_nanotime_sub

#define MEMORYBARRIER(isp, type, offset, size, chan)            \
switch (type) {                                                 \
case SYNC_REQUEST:                                              \
        bus_dmamap_sync(isp->isp_osinfo.reqdmat,                \
           isp->isp_osinfo.reqmap, BUS_DMASYNC_PREWRITE);       \
        break;                                                  \
case SYNC_RESULT:                                               \
        bus_dmamap_sync(isp->isp_osinfo.respdmat,               \
           isp->isp_osinfo.respmap, BUS_DMASYNC_POSTREAD);      \
        break;                                                  \
case SYNC_SFORDEV:                                              \
{                                                               \
        struct isp_fc *fc = ISP_FC_PC(isp, chan);               \
        bus_dmamap_sync(isp->isp_osinfo.scdmat, fc->scmap,      \
           BUS_DMASYNC_PREREAD | BUS_DMASYNC_PREWRITE);         \
        break;                                                  \
}                                                               \
case SYNC_SFORCPU:                                              \
{                                                               \
        struct isp_fc *fc = ISP_FC_PC(isp, chan);               \
        bus_dmamap_sync(isp->isp_osinfo.scdmat, fc->scmap,      \
           BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE);       \
        break;                                                  \
}                                                               \
case SYNC_REG:                                                  \
        bus_barrier(isp->isp_osinfo.regs, offset, size,         \
            BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);  \
        break;                                                  \
case SYNC_ATIOQ:                                                \
        bus_dmamap_sync(isp->isp_osinfo.atiodmat,               \
           isp->isp_osinfo.atiomap, BUS_DMASYNC_POSTREAD);      \
        break;                                                  \
case SYNC_IFORDEV:                                              \
        bus_dmamap_sync(isp->isp_osinfo.iocbdmat, isp->isp_osinfo.iocbmap, \
           BUS_DMASYNC_PREREAD | BUS_DMASYNC_PREWRITE);         \
        break;                                                  \
case SYNC_IFORCPU:                                              \
        bus_dmamap_sync(isp->isp_osinfo.iocbdmat, isp->isp_osinfo.iocbmap, \
           BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE);       \
        break;                                                  \
default:                                                        \
        break;                                                  \
}

#define MEMORYBARRIERW(isp, type, offset, size, chan)           \
switch (type) {                                                 \
case SYNC_REQUEST:                                              \
        bus_dmamap_sync(isp->isp_osinfo.reqdmat,                \
           isp->isp_osinfo.reqmap, BUS_DMASYNC_PREWRITE);       \
        break;                                                  \
case SYNC_SFORDEV:                                              \
{                                                               \
        struct isp_fc *fc = ISP_FC_PC(isp, chan);               \
        bus_dmamap_sync(isp->isp_osinfo.scdmat, fc->scmap,      \
           BUS_DMASYNC_PREWRITE);                               \
        break;                                                  \
}                                                               \
case SYNC_SFORCPU:                                              \
{                                                               \
        struct isp_fc *fc = ISP_FC_PC(isp, chan);               \
        bus_dmamap_sync(isp->isp_osinfo.scdmat, fc->scmap,      \
           BUS_DMASYNC_POSTWRITE);                              \
        break;                                                  \
}                                                               \
case SYNC_REG:                                                  \
        bus_barrier(isp->isp_osinfo.regs, offset, size,         \
            BUS_SPACE_BARRIER_WRITE);                           \
        break;                                                  \
case SYNC_IFORDEV:                                              \
        bus_dmamap_sync(isp->isp_osinfo.iocbdmat, isp->isp_osinfo.iocbmap, \
           BUS_DMASYNC_PREWRITE);                               \
        break;                                                  \
case SYNC_IFORCPU:                                              \
        bus_dmamap_sync(isp->isp_osinfo.iocbdmat, isp->isp_osinfo.iocbmap, \
           BUS_DMASYNC_POSTWRITE);                              \
        break;                                                  \
default:                                                        \
        break;                                                  \
}

#define FC_SCRATCH_ACQUIRE              isp_fc_scratch_acquire
#define FC_SCRATCH_RELEASE(isp, chan)   ISP_FC_PC(isp, chan)->fcbsy = 0

#ifndef SCSI_GOOD
#define SCSI_GOOD       SCSI_STATUS_OK
#endif
#ifndef SCSI_CHECK
#define SCSI_CHECK      SCSI_STATUS_CHECK_COND
#endif
#ifndef SCSI_BUSY
#define SCSI_BUSY       SCSI_STATUS_BUSY
#endif
#ifndef SCSI_QFULL
#define SCSI_QFULL      SCSI_STATUS_QUEUE_FULL
#endif

#define XS_T                    struct ccb_scsiio
#define XS_DMA_ADDR_T           bus_addr_t
#define XS_GET_DMA64_SEG(a, b, c)               \
{                                               \
        ispds64_t *d = a;                       \
        bus_dma_segment_t *e = b;               \
        uint32_t f = c;                         \
        e += f;                                 \
        d->ds_base = DMA_LO32(e->ds_addr);      \
        d->ds_basehi = DMA_HI32(e->ds_addr);    \
        d->ds_count = e->ds_len;                \
}
#define XS_ISP(ccb)             cam_sim_softc(xpt_path_sim((ccb)->ccb_h.path))
#define XS_CHANNEL(ccb)         cam_sim_bus(xpt_path_sim((ccb)->ccb_h.path))
#define XS_TGT(ccb)             (ccb)->ccb_h.target_id
#define XS_LUN(ccb)             (ccb)->ccb_h.target_lun

#define XS_CDBP(ccb)    \
        (((ccb)->ccb_h.flags & CAM_CDB_POINTER)? \
         (ccb)->cdb_io.cdb_ptr : (ccb)->cdb_io.cdb_bytes)

#define XS_CDBLEN(ccb)          (ccb)->cdb_len
#define XS_XFRLEN(ccb)          (ccb)->dxfer_len
#define XS_XFRIN(ccb)           (((ccb)->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_IN)
#define XS_XFROUT(ccb)          (((ccb)->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_OUT)
#define XS_TIME(ccb)    \
        (((ccb)->ccb_h.timeout > 0xffff * 1000 - 999) ? 0 : \
          (((ccb)->ccb_h.timeout + 999) / 1000))
#define XS_GET_RESID(ccb)       (ccb)->resid
#define XS_SET_RESID(ccb, r)    (ccb)->resid = r
#define XS_STSP(ccb)            (&(ccb)->scsi_status)
#define XS_SNSP(ccb)            (&(ccb)->sense_data)

#define XS_TOT_SNSLEN(ccb)      ccb->sense_len
#define XS_CUR_SNSLEN(ccb)      (ccb->sense_len - ccb->sense_resid)

#define XS_SNSKEY(ccb)          (scsi_get_sense_key(&(ccb)->sense_data, \
                                 ccb->sense_len - ccb->sense_resid, 1))

#define XS_SNSASC(ccb)          (scsi_get_asc(&(ccb)->sense_data,       \
                                 ccb->sense_len - ccb->sense_resid, 1))

#define XS_SNSASCQ(ccb)         (scsi_get_ascq(&(ccb)->sense_data,      \
                                 ccb->sense_len - ccb->sense_resid, 1))
#define XS_TAG_P(ccb)   \
        (((ccb)->ccb_h.flags & CAM_TAG_ACTION_VALID) && \
         (ccb)->tag_action != CAM_TAG_ACTION_NONE)

#define XS_TAG_TYPE(ccb)                                \
        ((ccb->tag_action == MSG_HEAD_OF_QUEUE_TASK)? FCP_CMND_TASK_ATTR_HEAD:\
         ((ccb->tag_action == MSG_ORDERED_TASK) ? FCP_CMND_TASK_ATTR_ORDERED :\
         ((ccb->tag_action == MSG_ACA_TASK) ? FCP_CMND_TASK_ATTR_ACA :  \
          FCP_CMND_TASK_ATTR_SIMPLE)))

#define XS_PRIORITY(ccb)        (ccb)->priority

#define XS_SETERR(ccb, v)       (ccb)->ccb_h.status &= ~CAM_STATUS_MASK, \
                                (ccb)->ccb_h.status |= v

#       define  HBA_NOERROR             CAM_REQ_INPROG
#       define  HBA_BOTCH               CAM_UNREC_HBA_ERROR
#       define  HBA_CMDTIMEOUT          CAM_CMD_TIMEOUT
#       define  HBA_SELTIMEOUT          CAM_SEL_TIMEOUT
#       define  HBA_TGTBSY              CAM_SCSI_STATUS_ERROR
#       define  HBA_REQINVAL            CAM_REQ_INVALID
#       define  HBA_BUSRESET            CAM_SCSI_BUS_RESET
#       define  HBA_ABORTED             CAM_REQ_ABORTED
#       define  HBA_DATAOVR             CAM_DATA_RUN_ERR
#       define  HBA_ARQFAIL             CAM_AUTOSENSE_FAIL


#define XS_ERR(ccb)             ((ccb)->ccb_h.status & CAM_STATUS_MASK)

#define XS_NOERR(ccb)           (((ccb)->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_INPROG)

#define XS_INITERR(ccb)         XS_SETERR(ccb, CAM_REQ_INPROG), ccb->sense_resid = ccb->sense_len

#define XS_SAVE_SENSE(xs, sp, len)      do {                            \
                uint32_t amt = min(len, (xs)->sense_len);               \
                memcpy(&(xs)->sense_data, sp, amt);                     \
                (xs)->sense_resid = (xs)->sense_len - amt;              \
                (xs)->ccb_h.status |= CAM_AUTOSNS_VALID;                \
        } while (0)

#define XS_SENSE_APPEND(xs, sp, len)    do {                            \
                uint8_t *ptr = (uint8_t *)(&(xs)->sense_data) +         \
                    ((xs)->sense_len - (xs)->sense_resid);              \
                uint32_t amt = min((len), (xs)->sense_resid);           \
                memcpy(ptr, sp, amt);                                   \
                (xs)->sense_resid -= amt;                               \
        } while (0)

#define XS_SENSE_VALID(xs)      (((xs)->ccb_h.status & CAM_AUTOSNS_VALID) != 0)

#define DEFAULT_FRAMESIZE(isp)          isp->isp_osinfo.framesize

#define DEFAULT_ROLE(isp, chan)         ISP_FC_PC(isp, chan)->def_role

#define DEFAULT_LOOPID(isp, chan)       ISP_FC_PC(isp, chan)->default_id

#define DEFAULT_NODEWWN(isp, chan)      isp_default_wwn(isp, chan, 0, 1)
#define DEFAULT_PORTWWN(isp, chan)      isp_default_wwn(isp, chan, 0, 0)
#define ACTIVE_NODEWWN(isp, chan)       isp_default_wwn(isp, chan, 1, 1)
#define ACTIVE_PORTWWN(isp, chan)       isp_default_wwn(isp, chan, 1, 0)


#if     BYTE_ORDER == BIG_ENDIAN
#define ISP_IOXPUT_8(isp, s, d)         *(d) = s
#define ISP_IOXPUT_16(isp, s, d)        *(d) = bswap16(s)
#define ISP_IOXPUT_32(isp, s, d)        *(d) = bswap32(s)
#define ISP_IOXGET_8(isp, s, d)         d = (*((uint8_t *)s))
#define ISP_IOXGET_16(isp, s, d)        d = bswap16(*((uint16_t *)s))
#define ISP_IOXGET_32(isp, s, d)        d = bswap32(*((uint32_t *)s))
#define ISP_SWIZZLE_NVRAM_WORD(isp, rp) *rp = bswap16(*rp)
#define ISP_SWIZZLE_NVRAM_LONG(isp, rp) *rp = bswap32(*rp)

#define ISP_IOZGET_8(isp, s, d)         d = (*((uint8_t *)s))
#define ISP_IOZGET_16(isp, s, d)        d = (*((uint16_t *)s))
#define ISP_IOZGET_32(isp, s, d)        d = (*((uint32_t *)s))
#define ISP_IOZPUT_8(isp, s, d)         *(d) = s
#define ISP_IOZPUT_16(isp, s, d)        *(d) = s
#define ISP_IOZPUT_32(isp, s, d)        *(d) = s

#else
#define ISP_IOXPUT_8(isp, s, d)         *(d) = s
#define ISP_IOXPUT_16(isp, s, d)        *(d) = s
#define ISP_IOXPUT_32(isp, s, d)        *(d) = s
#define ISP_IOXGET_8(isp, s, d)         d = *(s)
#define ISP_IOXGET_16(isp, s, d)        d = *(s)
#define ISP_IOXGET_32(isp, s, d)        d = *(s)
#define ISP_SWIZZLE_NVRAM_WORD(isp, rp)
#define ISP_SWIZZLE_NVRAM_LONG(isp, rp)

#define ISP_IOZPUT_8(isp, s, d)         *(d) = s
#define ISP_IOZPUT_16(isp, s, d)        *(d) = bswap16(s)
#define ISP_IOZPUT_32(isp, s, d)        *(d) = bswap32(s)
#define ISP_IOZGET_8(isp, s, d)         d = (*((uint8_t *)(s)))
#define ISP_IOZGET_16(isp, s, d)        d = bswap16(*((uint16_t *)(s)))
#define ISP_IOZGET_32(isp, s, d)        d = bswap32(*((uint32_t *)(s)))
#endif

#define ISP_SWAP16(isp, s)      bswap16(s)
#define ISP_SWAP32(isp, s)      bswap32(s)

/*
 * Includes of common header files
 */

#include <dev/isp/ispreg.h>
#include <dev/isp/ispvar.h>
#include <dev/isp/ispmbox.h>

/*
 * isp_osinfo definiitions && shorthand
 */
#define SIMQFRZ_RESOURCE        0x1
#define SIMQFRZ_LOOPDOWN        0x2
#define SIMQFRZ_TIMED           0x4

#define isp_dev         isp_osinfo.dev

/*
 * prototypes for isp_pci && isp_freebsd to share
 */
extern int isp_attach(ispsoftc_t *);
extern int isp_detach(ispsoftc_t *);
extern uint64_t isp_default_wwn(ispsoftc_t *, int, int, int);

/*
 * driver global data
 */
extern int isp_announced;
extern int isp_loop_down_limit;
extern int isp_gone_device_time;
extern int isp_quickboot_time;

/*
 * Platform Library Functions
 */
void isp_prt(ispsoftc_t *, int level, const char *, ...) __printflike(3, 4);
void isp_xs_prt(ispsoftc_t *, XS_T *, int level, const char *, ...) __printflike(4, 5);
uint64_t isp_nanotime_sub(struct timespec *, struct timespec *);
int isp_fc_scratch_acquire(ispsoftc_t *, int);
void isp_platform_intr(void *);
void isp_platform_intr_resp(void *);
void isp_platform_intr_atio(void *);
int isp_dmasetup(ispsoftc_t *, XS_T *, void *);
void isp_dmafree(ispsoftc_t *, struct ccb_scsiio *);
void isp_fcp_reset_crn(ispsoftc_t *, int, uint32_t, int);
int isp_fcp_next_crn(ispsoftc_t *, uint8_t *, XS_T *);

/*
 * Platform Version specific defines
 */
#define ISP_PATH_PRT(i, l, p, ...)                                      \
        if ((l) == ISP_LOGALL || ((l)& (i)->isp_dblev) != 0) {          \
                xpt_print(p, __VA_ARGS__);                              \
        }

/*
 * ISP General Library functions
 */

#include <dev/isp/isp_library.h>

#endif  /* _ISP_FREEBSD_H */