sys/dev/isp/ispvar.h

   1 /* $FreeBSD$ */
   2 /*-
   3  *  Copyright (c) 2009-2017 Alexander Motin <mav@FreeBSD.org>
   4  *  Copyright (c) 1997-2009 by Matthew Jacob
   5  *  All rights reserved.
   6  *
   7  *  Redistribution and use in source and binary forms, with or without
   8  *  modification, are permitted provided that the following conditions
   9  *  are met:
  10  *
  11  *  1. Redistributions of source code must retain the above copyright
  12  *     notice, this list of conditions and the following disclaimer.
  13  *  2. Redistributions in binary form must reproduce the above copyright
  14  *     notice, this list of conditions and the following disclaimer in the
  15  *     documentation and/or other materials provided with the distribution.
  16  *
  17  *  THIS SOFTWARE IS PROVIDED BY 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 AUTHOR OR CONTRIBUTORS BE LIABLE
  21  *  FOR 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  */
  30 /*
  31  * Soft Definitions for for Qlogic ISP SCSI adapters.
  32  */
  33
  34 #ifndef _ISPVAR_H
  35 #define _ISPVAR_H
  36
  37 #if defined(__NetBSD__) || defined(__OpenBSD__)
  38 #include <dev/ic/isp_stds.h>
  39 #include <dev/ic/ispmbox.h>
  40 #endif
  41 #ifdef  __FreeBSD__
  42 #include <dev/isp/isp_stds.h>
  43 #include <dev/isp/ispmbox.h>
  44 #endif
  45 #ifdef  __linux__
  46 #include "isp_stds.h"
  47 #include "ispmbox.h"
  48 #endif
  49 #ifdef  __svr4__
  50 #include "isp_stds.h"
  51 #include "ispmbox.h"
  52 #endif
  53
  54 #define ISP_CORE_VERSION_MAJOR  7
  55 #define ISP_CORE_VERSION_MINOR  0
  56
  57 /*
  58  * Vector for bus specific code to provide specific services.
  59  */
  60 typedef struct ispsoftc ispsoftc_t;
  61 struct ispmdvec {
  62         void            (*dv_run_isr) (ispsoftc_t *);
  63         uint32_t        (*dv_rd_reg) (ispsoftc_t *, int);
  64         void            (*dv_wr_reg) (ispsoftc_t *, int, uint32_t);
  65         int             (*dv_mbxdma) (ispsoftc_t *);
  66         int             (*dv_dmaset) (ispsoftc_t *, XS_T *, void *);
  67         void            (*dv_dmaclr) (ispsoftc_t *, XS_T *, uint32_t);
  68         int             (*dv_irqsetup) (ispsoftc_t *);
  69         void            (*dv_dregs) (ispsoftc_t *, const char *);
  70         const void *    dv_ispfw;       /* ptr to f/w */
  71         uint16_t        dv_conf1;
  72         uint16_t        dv_clock;       /* clock frequency */
  73 };
  74
  75 /*
  76  * Overall parameters
  77  */
  78 #define MAX_TARGETS             16
  79 #ifndef MAX_FC_TARG
  80 #define MAX_FC_TARG             1024
  81 #endif
  82 #define ISP_MAX_TARGETS(isp)    (IS_FC(isp)? MAX_FC_TARG : MAX_TARGETS)
  83 #define ISP_MAX_LUNS(isp)       (isp)->isp_maxluns
  84 #define ISP_MAX_IRQS            3
  85
  86 /*
  87  * Macros to access ISP registers through bus specific layers-
  88  * mostly wrappers to vector through the mdvec structure.
  89  */
  90 #define ISP_RUN_ISR(isp)        \
  91         (*(isp)->isp_mdvec->dv_run_isr)(isp)
  92
  93 #define ISP_READ(isp, reg)      \
  94         (*(isp)->isp_mdvec->dv_rd_reg)((isp), (reg))
  95
  96 #define ISP_WRITE(isp, reg, val)        \
  97         (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), (val))
  98
  99 #define ISP_MBOXDMASETUP(isp)   \
 100         (*(isp)->isp_mdvec->dv_mbxdma)((isp))
 101
 102 #define ISP_DMASETUP(isp, xs, req)      \
 103         (*(isp)->isp_mdvec->dv_dmaset)((isp), (xs), (req))
 104
 105 #define ISP_DMAFREE(isp, xs, hndl)              \
 106         if ((isp)->isp_mdvec->dv_dmaclr)        \
 107             (*(isp)->isp_mdvec->dv_dmaclr)((isp), (xs), (hndl))
 108
 109 #define ISP_IRQSETUP(isp)       \
 110         (((isp)->isp_mdvec->dv_irqsetup) ? (*(isp)->isp_mdvec->dv_irqsetup)(isp) : 0)
 111 #define ISP_DUMPREGS(isp, m)    \
 112         if ((isp)->isp_mdvec->dv_dregs) (*(isp)->isp_mdvec->dv_dregs)((isp),(m))
 113
 114 #define ISP_SETBITS(isp, reg, val)      \
 115  (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) | (val))
 116
 117 #define ISP_CLRBITS(isp, reg, val)      \
 118  (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) & ~(val))
 119
 120 /*
 121  * The MEMORYBARRIER macro is defined per platform (to provide synchronization
 122  * on Request and Response Queues, Scratch DMA areas, and Registers)
 123  *
 124  * Defined Memory Barrier Synchronization Types
 125  */
 126 #define SYNC_REQUEST    0       /* request queue synchronization */
 127 #define SYNC_RESULT     1       /* result queue synchronization */
 128 #define SYNC_SFORDEV    2       /* scratch, sync for ISP */
 129 #define SYNC_SFORCPU    3       /* scratch, sync for CPU */
 130 #define SYNC_REG        4       /* for registers */
 131 #define SYNC_ATIOQ      5       /* atio result queue (24xx) */
 132 #define SYNC_IFORDEV    6       /* synchrounous IOCB, sync for ISP */
 133 #define SYNC_IFORCPU    7       /* synchrounous IOCB, sync for CPU */
 134
 135 /*
 136  * Request/Response Queue defines and macros.
 137  * The maximum is defined per platform (and can be based on board type).
 138  */
 139 /* This is the size of a queue entry (request and response) */
 140 #define QENTRY_LEN                      64
 141 /* Both request and result queue length must be a power of two */
 142 #define RQUEST_QUEUE_LEN(x)             MAXISPREQUEST(x)
 143 #ifdef  ISP_TARGET_MODE
 144 #define RESULT_QUEUE_LEN(x)             MAXISPREQUEST(x)
 145 #else
 146 #define RESULT_QUEUE_LEN(x)             \
 147         (((MAXISPREQUEST(x) >> 2) < 64)? 64 : MAXISPREQUEST(x) >> 2)
 148 #endif
 149 #define ISP_QUEUE_ENTRY(q, idx)         (((uint8_t *)q) + ((idx) * QENTRY_LEN))
 150 #define ISP_QUEUE_SIZE(n)               ((n) * QENTRY_LEN)
 151 #define ISP_NXT_QENTRY(idx, qlen)       (((idx) + 1) & ((qlen)-1))
 152 #define ISP_QFREE(in, out, qlen)        \
 153         ((in == out)? (qlen - 1) : ((in > out)? \
 154         ((qlen - 1) - (in - out)) : (out - in - 1)))
 155 #define ISP_QAVAIL(isp) \
 156         ISP_QFREE(isp->isp_reqidx, isp->isp_reqodx, RQUEST_QUEUE_LEN(isp))
 157
 158 #define ISP_ADD_REQUEST(isp, nxti)                                              \
 159         MEMORYBARRIER(isp, SYNC_REQUEST, isp->isp_reqidx, QENTRY_LEN, -1);      \
 160         ISP_WRITE(isp, isp->isp_rqstinrp, nxti);                                \
 161         isp->isp_reqidx = nxti
 162
 163 #define ISP_SYNC_REQUEST(isp)                                                           \
 164         MEMORYBARRIER(isp, SYNC_REQUEST, isp->isp_reqidx, QENTRY_LEN, -1);              \
 165         isp->isp_reqidx = ISP_NXT_QENTRY(isp->isp_reqidx, RQUEST_QUEUE_LEN(isp));       \
 166         ISP_WRITE(isp, isp->isp_rqstinrp, isp->isp_reqidx)
 167
 168 /*
 169  * SCSI Specific Host Adapter Parameters- per bus, per target
 170  */
 171 typedef struct {
 172         uint32_t                                : 8,
 173                         update                  : 1,
 174                         sendmarker              : 1,
 175                         isp_req_ack_active_neg  : 1,
 176                         isp_data_line_active_neg: 1,
 177                         isp_cmd_dma_burst_enable: 1,
 178                         isp_data_dma_burst_enabl: 1,
 179                         isp_fifo_threshold      : 3,
 180                         isp_ptisp               : 1,
 181                         isp_ultramode           : 1,
 182                         isp_diffmode            : 1,
 183                         isp_lvdmode             : 1,
 184                         isp_fast_mttr           : 1,    /* fast sram */
 185                         isp_initiator_id        : 4,
 186                         isp_async_data_setup    : 4;
 187         uint16_t        isp_selection_timeout;
 188         uint16_t        isp_max_queue_depth;
 189         uint8_t         isp_tag_aging;
 190         uint8_t         isp_bus_reset_delay;
 191         uint8_t         isp_retry_count;
 192         uint8_t         isp_retry_delay;
 193         struct {
 194                 uint32_t
 195                         exc_throttle    :       8,
 196                                         :       1,
 197                         dev_enable      :       1,      /* ignored */
 198                         dev_update      :       1,
 199                         dev_refresh     :       1,
 200                         actv_offset     :       4,
 201                         goal_offset     :       4,
 202                         nvrm_offset     :       4;
 203                 uint8_t         actv_period;    /* current sync period */
 204                 uint8_t         goal_period;    /* goal sync period */
 205                 uint8_t         nvrm_period;    /* nvram sync period */
 206                 uint16_t        actv_flags;     /* current device flags */
 207                 uint16_t        goal_flags;     /* goal device flags */
 208                 uint16_t        nvrm_flags;     /* nvram device flags */
 209         } isp_devparam[MAX_TARGETS];
 210 } sdparam;
 211
 212 /*
 213  * Device Flags
 214  */
 215 #define DPARM_DISC      0x8000
 216 #define DPARM_PARITY    0x4000
 217 #define DPARM_WIDE      0x2000
 218 #define DPARM_SYNC      0x1000
 219 #define DPARM_TQING     0x0800
 220 #define DPARM_ARQ       0x0400
 221 #define DPARM_QFRZ      0x0200
 222 #define DPARM_RENEG     0x0100
 223 #define DPARM_NARROW    0x0080
 224 #define DPARM_ASYNC     0x0040
 225 #define DPARM_PPR       0x0020
 226 #define DPARM_DEFAULT   (0xFF00 & ~DPARM_QFRZ)
 227 #define DPARM_SAFE_DFLT (DPARM_DEFAULT & ~(DPARM_WIDE|DPARM_SYNC|DPARM_TQING))
 228
 229 /* technically, not really correct, as they need to be rated based upon clock */
 230 #define ISP_80M_SYNCPARMS       0x0c09
 231 #define ISP_40M_SYNCPARMS       0x0c0a
 232 #define ISP_20M_SYNCPARMS       0x0c0c
 233 #define ISP_20M_SYNCPARMS_1040  0x080c
 234 #define ISP_10M_SYNCPARMS       0x0c19
 235 #define ISP_08M_SYNCPARMS       0x0c25
 236 #define ISP_05M_SYNCPARMS       0x0c32
 237 #define ISP_04M_SYNCPARMS       0x0c41
 238
 239 /*
 240  * Fibre Channel Specifics
 241  */
 242 /* These are for non-2K Login Firmware cards */
 243 #define FL_ID                   0x7e    /* FL_Port Special ID */
 244 #define SNS_ID                  0x80    /* SNS Server Special ID */
 245 #define NPH_MAX                 0xfe
 246
 247 /* These are for 2K Login Firmware cards */
 248 #define NPH_RESERVED            0x7F0   /* begin of reserved N-port handles */
 249 #define NPH_MGT_ID              0x7FA   /* Management Server Special ID */
 250 #define NPH_SNS_ID              0x7FC   /* SNS Server Special ID */
 251 #define NPH_FABRIC_CTLR         0x7FD   /* Fabric Controller (0xFFFFFD) */
 252 #define NPH_FL_ID               0x7FE   /* F Port Special ID (0xFFFFFE) */
 253 #define NPH_IP_BCST             0x7FF   /* IP Broadcast Special ID (0xFFFFFF) */
 254 #define NPH_MAX_2K              0x800
 255
 256 /*
 257  * "Unassigned" handle to be used internally
 258  */
 259 #define NIL_HANDLE              0xffff
 260
 261 /*
 262  * Limit for devices on an arbitrated loop.
 263  */
 264 #define LOCAL_LOOP_LIM          126
 265
 266 /*
 267  * Limit for (2K login) N-port handle amounts
 268  */
 269 #define MAX_NPORT_HANDLE        2048
 270
 271 /*
 272  * Special Constants
 273  */
 274 #define INI_NONE                ((uint64_t) 0)
 275 #define ISP_NOCHAN              0xff
 276
 277 /*
 278  * Special Port IDs
 279  */
 280 #define MANAGEMENT_PORT_ID      0xFFFFFA
 281 #define SNS_PORT_ID             0xFFFFFC
 282 #define FABRIC_PORT_ID          0xFFFFFE
 283 #define PORT_ANY                0xFFFFFF
 284 #define PORT_NONE               0
 285 #define VALID_PORT(port)        (port != PORT_NONE && port != PORT_ANY)
 286 #define DOMAIN_CONTROLLER_BASE  0xFFFC00
 287 #define DOMAIN_CONTROLLER_END   0xFFFCFF
 288
 289 /*
 290  * Command Handles
 291  *
 292  * Most QLogic initiator or target have 32 bit handles associated with them.
 293  * We want to have a quick way to index back and forth between a local SCSI
 294  * command context and what the firmware is passing back to us. We also
 295  * want to avoid working on stale information. This structure handles both
 296  * at the expense of some local memory.
 297  *
 298  * The handle is architected thusly:
 299  *
 300  *      0 means "free handle"
 301  *      bits  0..12 index commands
 302  *      bits 13..15 bits index usage
 303  *      bits 16..31 contain a rolling sequence
 304  *
 305  *
 306  */
 307 typedef struct {
 308         void *          cmd;    /* associated command context */
 309         uint32_t        handle; /* handle associated with this command */
 310 } isp_hdl_t;
 311 #define ISP_HANDLE_FREE         0x00000000
 312 #define ISP_HANDLE_CMD_MASK     0x00001fff
 313 #define ISP_HANDLE_USAGE_MASK   0x0000e000
 314 #define ISP_HANDLE_USAGE_SHIFT  13
 315 #define ISP_H2HT(hdl)   ((hdl & ISP_HANDLE_USAGE_MASK) >> ISP_HANDLE_USAGE_SHIFT)
 316 #       define  ISP_HANDLE_NONE         0
 317 #       define  ISP_HANDLE_INITIATOR    1
 318 #       define  ISP_HANDLE_TARGET       2
 319 #       define  ISP_HANDLE_CTRL         3
 320 #define ISP_HANDLE_SEQ_MASK     0xffff0000
 321 #define ISP_HANDLE_SEQ_SHIFT    16
 322 #define ISP_H2SEQ(hdl)  ((hdl & ISP_HANDLE_SEQ_MASK) >> ISP_HANDLE_SEQ_SHIFT)
 323 #define ISP_VALID_HANDLE(c, hdl)        \
 324         ((ISP_H2HT(hdl) == ISP_HANDLE_INITIATOR || \
 325           ISP_H2HT(hdl) == ISP_HANDLE_TARGET || \
 326           ISP_H2HT(hdl) == ISP_HANDLE_CTRL) && \
 327          ((hdl) & ISP_HANDLE_CMD_MASK) < (c)->isp_maxcmds && \
 328          (hdl) == ((c)->isp_xflist[(hdl) & ISP_HANDLE_CMD_MASK].handle))
 329 #define ISP_BAD_HANDLE_INDEX    0xffffffff
 330
 331
 332 /*
 333  * FC Port Database entry.
 334  *
 335  * It has a handle that the f/w uses to address commands to a device.
 336  * This handle's value may be assigned by the firmware (e.g., for local loop
 337  * devices) or by the driver (e.g., for fabric devices).
 338  *
 339  * It has a state. If the state if VALID, that means that we've logged into
 340  * the device.
 341  *
 342  * Local loop devices the firmware automatically performs PLOGI on for us
 343  * (which is why that handle is imposed upon us). Fabric devices we assign
 344  * a handle to and perform the PLOGI on.
 345  *
 346  * When a PORT DATABASE CHANGED asynchronous event occurs, we mark all VALID
 347  * entries as PROBATIONAL. This allows us, if policy says to, just keep track
 348  * of devices whose handles change but are otherwise the same device (and
 349  * thus keep 'target' constant).
 350  *
 351  * In any case, we search all possible local loop handles. For each one that
 352  * has a port database entity returned, we search for any PROBATIONAL entry
 353  * that matches it and update as appropriate. Otherwise, as a new entry, we
 354  * find room for it in the Port Database. We *try* and use the handle as the
 355  * index to put it into the Database, but that's just an optimization. We mark
 356  * the entry VALID and make sure that the target index is updated and correct.
 357  *
 358  * When we get done searching the local loop, we then search similarly for
 359  * a list of devices we've gotten from the fabric name controller (if we're
 360  * on a fabric). VALID marking is also done similarly.
 361  *
 362  * When all of this is done, we can march through the database and clean up
 363  * any entry that is still PROBATIONAL (these represent devices which have
 364  * departed). Then we're done and can resume normal operations.
 365  *
 366  * Negative invariants that we try and test for are:
 367  *
 368  *  + There can never be two non-NIL entries with the same { Port, Node } WWN
 369  *    duples.
 370  *
 371  *  + There can never be two non-NIL entries with the same handle.
 372  */
 373 typedef struct {
 374         /*
 375          * This is the handle that the firmware needs in order for us to
 376          * send commands to the device. For pre-24XX cards, this would be
 377          * the 'loopid'.
 378          */
 379         uint16_t        handle;
 380
 381         /*
 382          * PRLI word 3 parameters contains role as well as other things.
 383          *
 384          * The state is the current state of this entry.
 385          *
 386          * The is_target is the current state of target on this port.
 387          *
 388          * The is_initiator is the current state of initiator on this port.
 389          *
 390          * Portid is obvious, as are node && port WWNs. The new_role and
 391          * new_portid is for when we are pending a change.
 392          */
 393         uint16_t        prli_word3;             /* PRLI parameters */
 394         uint16_t        new_prli_word3;         /* Incoming new PRLI parameters */
 395         uint16_t                        : 12,
 396                         probational     : 1,
 397                         state           : 3;
 398         uint32_t                        : 6,
 399                         is_target       : 1,
 400                         is_initiator    : 1,
 401                         portid          : 24;
 402         uint32_t
 403                                         : 8,
 404                         new_portid      : 24;
 405         uint64_t        node_wwn;
 406         uint64_t        port_wwn;
 407         uint32_t        gone_timer;
 408 } fcportdb_t;
 409
 410 #define FC_PORTDB_STATE_NIL             0       /* Empty DB slot */
 411 #define FC_PORTDB_STATE_DEAD            1       /* Was valid, but no more. */
 412 #define FC_PORTDB_STATE_CHANGED         2       /* Was valid, but changed. */
 413 #define FC_PORTDB_STATE_NEW             3       /* Logged in, not announced. */
 414 #define FC_PORTDB_STATE_ZOMBIE          4       /* Invalid, but announced. */
 415 #define FC_PORTDB_STATE_VALID           5       /* Valid */
 416
 417 #define FC_PORTDB_TGT(isp, bus, pdb)            (int)(lp - FCPARAM(isp, bus)->portdb)
 418
 419 /*
 420  * FC card specific information
 421  *
 422  * This structure is replicated across multiple channels for multi-id
 423  * capapble chipsets, with some entities different on a per-channel basis.
 424  */
 425
 426 typedef struct {
 427         int                     isp_gbspeed;            /* Connection speed */
 428         int                     isp_linkstate;          /* Link state */
 429         int                     isp_fwstate;            /* ISP F/W state */
 430         int                     isp_loopstate;          /* Loop State */
 431         int                     isp_topo;               /* Connection Type */
 432
 433         uint32_t                                : 4,
 434                                 fctape_enabled  : 1,
 435                                 sendmarker      : 1,
 436                                 role            : 2,
 437                                 isp_portid      : 24;   /* S_ID */
 438
 439         uint16_t                isp_fwoptions;
 440         uint16_t                isp_xfwoptions;
 441         uint16_t                isp_zfwoptions;
 442         uint16_t                isp_loopid;             /* hard loop id */
 443         uint16_t                isp_sns_hdl;            /* N-port handle for SNS */
 444         uint16_t                isp_lasthdl;            /* only valid for channel 0 */
 445         uint16_t                isp_maxalloc;
 446         uint16_t                isp_fabric_params;
 447         uint16_t                isp_login_hdl;          /* Logging in handle */
 448         uint8_t                 isp_retry_delay;
 449         uint8_t                 isp_retry_count;
 450         int                     isp_use_gft_id;         /* Use GFT_ID */
 451         int                     isp_use_gff_id;         /* Use GFF_ID */
 452
 453         /*
 454          * Current active WWNN/WWPN
 455          */
 456         uint64_t                isp_wwnn;
 457         uint64_t                isp_wwpn;
 458
 459         /*
 460          * NVRAM WWNN/WWPN
 461          */
 462         uint64_t                isp_wwnn_nvram;
 463         uint64_t                isp_wwpn_nvram;
 464
 465         /*
 466          * Our Port Data Base
 467          */
 468         fcportdb_t              portdb[MAX_FC_TARG];
 469
 470         /*
 471          * Scratch DMA mapped in area to fetch Port Database stuff, etc.
 472          */
 473         void *                  isp_scratch;
 474         XS_DMA_ADDR_T           isp_scdma;
 475
 476         uint8_t                 isp_scanscratch[ISP_FC_SCRLEN];
 477 } fcparam;
 478
 479 #define FW_CONFIG_WAIT          0
 480 #define FW_WAIT_LINK            1
 481 #define FW_WAIT_LOGIN           2
 482 #define FW_READY                3
 483 #define FW_LOSS_OF_SYNC         4
 484 #define FW_ERROR                5
 485 #define FW_REINIT               6
 486 #define FW_NON_PART             7
 487
 488 #define LOOP_NIL                0
 489 #define LOOP_HAVE_LINK          1
 490 #define LOOP_HAVE_ADDR          2
 491 #define LOOP_TESTING_LINK       3
 492 #define LOOP_LTEST_DONE         4
 493 #define LOOP_SCANNING_LOOP      5
 494 #define LOOP_LSCAN_DONE         6
 495 #define LOOP_SCANNING_FABRIC    7
 496 #define LOOP_FSCAN_DONE         8
 497 #define LOOP_SYNCING_PDB        9
 498 #define LOOP_READY              10
 499
 500 #define TOPO_NL_PORT            0
 501 #define TOPO_FL_PORT            1
 502 #define TOPO_N_PORT             2
 503 #define TOPO_F_PORT             3
 504 #define TOPO_PTP_STUB           4
 505
 506 #define TOPO_IS_FABRIC(x)       ((x) == TOPO_FL_PORT || (x) == TOPO_F_PORT)
 507
 508 #define FCP_AL_DA_ALL           0xFF
 509 #define FCP_AL_PA(fcp) ((uint8_t)(fcp->isp_portid))
 510 #define FCP_IS_DEST_ALPD(fcp, alpd) (FCP_AL_PA((fcp)) == FCP_AL_DA_ALL || FCP_AL_PA((fcp)) == alpd)
 511
 512 /*
 513  * Soft Structure per host adapter
 514  */
 515 struct ispsoftc {
 516         /*
 517          * Platform (OS) specific data
 518          */
 519         struct isposinfo        isp_osinfo;
 520
 521         /*
 522          * Pointer to bus specific functions and data
 523          */
 524         struct ispmdvec *       isp_mdvec;
 525
 526         /*
 527          * (Mostly) nonvolatile state. Board specific parameters
 528          * may contain some volatile state (e.g., current loop state).
 529          */
 530
 531         void *                  isp_param;      /* type specific */
 532         uint64_t                isp_fwattr;     /* firmware attributes */
 533         uint16_t                isp_fwrev[3];   /* Loaded F/W revision */
 534         uint16_t                isp_maxcmds;    /* max possible I/O cmds */
 535         uint8_t                 isp_type;       /* HBA Chip Type */
 536         uint8_t                 isp_revision;   /* HBA Chip H/W Revision */
 537         uint8_t                 isp_nirq;       /* number of IRQs */
 538         uint16_t                isp_nchan;      /* number of channels */
 539         uint32_t                isp_maxluns;    /* maximum luns supported */
 540
 541         uint32_t                isp_clock       : 8,    /* input clock */
 542                                                 : 5,
 543                                 isp_port        : 1,    /* 23XX/24XX only */
 544                                 isp_bustype     : 1,    /* SBus or PCI */
 545                                 isp_loaded_fw   : 1,    /* loaded firmware */
 546                                 isp_dblev       : 16;   /* debug log mask */
 547
 548
 549         uint32_t                isp_confopts;   /* config options */
 550
 551         uint32_t                isp_rqstinrp;   /* register for REQINP */
 552         uint32_t                isp_rqstoutrp;  /* register for REQOUTP */
 553         uint32_t                isp_respinrp;   /* register for RESINP */
 554         uint32_t                isp_respoutrp;  /* register for RESOUTP */
 555
 556         /*
 557          * Volatile state
 558          */
 559
 560         volatile u_int          isp_mboxbsy;    /* mailbox command active */
 561         volatile u_int          isp_state;
 562         volatile mbreg_t        isp_curmbx;     /* currently active mailbox command */
 563         volatile uint32_t       isp_reqodx;     /* index of last ISP pickup */
 564         volatile uint32_t       isp_reqidx;     /* index of next request */
 565         volatile uint32_t       isp_residx;     /* index of last ISP write */
 566         volatile uint32_t       isp_resodx;     /* index of next result */
 567         volatile uint32_t       isp_atioodx;    /* index of next ATIO */
 568         volatile uint32_t       isp_obits;      /* mailbox command output */
 569         volatile uint32_t       isp_serno;      /* rolling serial number */
 570         volatile uint16_t       isp_mboxtmp[MAX_MAILBOX];
 571         volatile uint16_t       isp_lastmbxcmd; /* last mbox command sent */
 572         volatile uint16_t       isp_seqno;      /* running sequence number */
 573
 574         /*
 575          * Active commands are stored here, indexed by handle functions.
 576          */
 577         isp_hdl_t               *isp_xflist;
 578         isp_hdl_t               *isp_xffree;
 579
 580         /*
 581          * DMA mapped in area for synchronous IOCB requests.
 582          */
 583         void *                  isp_iocb;
 584         XS_DMA_ADDR_T           isp_iocb_dma;
 585
 586         /*
 587          * request/result queue pointers and DMA handles for them.
 588          */
 589         void *                  isp_rquest;
 590         void *                  isp_result;
 591         XS_DMA_ADDR_T           isp_rquest_dma;
 592         XS_DMA_ADDR_T           isp_result_dma;
 593 #ifdef  ISP_TARGET_MODE
 594         /* for 24XX only */
 595         void *                  isp_atioq;
 596         XS_DMA_ADDR_T           isp_atioq_dma;
 597 #endif
 598 };
 599
 600 #define SDPARAM(isp, chan)      (&((sdparam *)(isp)->isp_param)[(chan)])
 601 #define FCPARAM(isp, chan)      (&((fcparam *)(isp)->isp_param)[(chan)])
 602
 603 #define ISP_SET_SENDMARKER(isp, chan, val)      \
 604     if (IS_FC(isp)) {                           \
 605         FCPARAM(isp, chan)->sendmarker = val;   \
 606     } else {                                    \
 607         SDPARAM(isp, chan)->sendmarker = val;   \
 608     }
 609
 610 #define ISP_TST_SENDMARKER(isp, chan)           \
 611     (IS_FC(isp)?                                \
 612         FCPARAM(isp, chan)->sendmarker != 0 :   \
 613         SDPARAM(isp, chan)->sendmarker != 0)
 614
 615 /*
 616  * ISP Driver Run States
 617  */
 618 #define ISP_NILSTATE    0
 619 #define ISP_CRASHED     1
 620 #define ISP_RESETSTATE  2
 621 #define ISP_INITSTATE   3
 622 #define ISP_RUNSTATE    4
 623
 624 /*
 625  * ISP Runtime Configuration Options
 626  */
 627 #define ISP_CFG_FULL_DUPLEX     0x01    /* Full Duplex (Fibre Channel only) */
 628 #define ISP_CFG_PORT_PREF       0x0e    /* Mask for Port Prefs (all FC except 2100) */
 629 #define ISP_CFG_PORT_DEF        0x00    /* prefer connection type from NVRAM */
 630 #define ISP_CFG_LPORT_ONLY      0x02    /* insist on {N/F}L-Port connection */
 631 #define ISP_CFG_NPORT_ONLY      0x04    /* insist on {N/F}-Port connection */
 632 #define ISP_CFG_LPORT           0x06    /* prefer {N/F}L-Port connection */
 633 #define ISP_CFG_NPORT           0x08    /* prefer {N/F}-Port connection */
 634 #define ISP_CFG_1GB             0x10    /* force 1GB connection (23XX only) */
 635 #define ISP_CFG_2GB             0x20    /* force 2GB connection (23XX only) */
 636 #define ISP_CFG_NORELOAD        0x80    /* don't download f/w */
 637 #define ISP_CFG_NONVRAM         0x40    /* ignore NVRAM */
 638 #define ISP_CFG_NOFCTAPE        0x100   /* disable FC-Tape */
 639 #define ISP_CFG_FCTAPE          0x200   /* enable FC-Tape */
 640 #define ISP_CFG_OWNFSZ          0x400   /* override NVRAM frame size */
 641 #define ISP_CFG_OWNLOOPID       0x800   /* override NVRAM loopid */
 642 #define ISP_CFG_OWNEXCTHROTTLE  0x1000  /* override NVRAM execution throttle */
 643 #define ISP_CFG_4GB             0x2000  /* force 4GB connection (24XX only) */
 644 #define ISP_CFG_8GB             0x4000  /* force 8GB connection (25XX only) */
 645 #define ISP_CFG_16GB            0x8000  /* force 16GB connection (82XX only) */
 646
 647 /*
 648  * For each channel, the outer layers should know what role that channel
 649  * will take: ISP_ROLE_NONE, ISP_ROLE_INITIATOR, ISP_ROLE_TARGET,
 650  * ISP_ROLE_BOTH.
 651  *
 652  * If you set ISP_ROLE_NONE, the cards will be reset, new firmware loaded,
 653  * NVRAM read, and defaults set, but any further initialization (e.g.
 654  * INITIALIZE CONTROL BLOCK commands for 2X00 cards) won't be done.
 655  *
 656  * If INITIATOR MODE isn't set, attempts to run commands will be stopped
 657  * at isp_start and completed with the equivalent of SELECTION TIMEOUT.
 658  *
 659  * If TARGET MODE is set, it doesn't mean that the rest of target mode support
 660  * needs to be enabled, or will even work. What happens with the 2X00 cards
 661  * here is that if you have enabled it with TARGET MODE as part of the ICB
 662  * options, but you haven't given the f/w any ram resources for ATIOs or
 663  * Immediate Notifies, the f/w just handles what it can and you never see
 664  * anything. Basically, it sends a single byte of data (the first byte,
 665  * which you can set as part of the INITIALIZE CONTROL BLOCK command) for
 666  * INQUIRY, and sends back QUEUE FULL status for any other command.
 667  *
 668  */
 669 #define ISP_ROLE_NONE           0x0
 670 #define ISP_ROLE_TARGET         0x1
 671 #define ISP_ROLE_INITIATOR      0x2
 672 #define ISP_ROLE_BOTH           (ISP_ROLE_TARGET|ISP_ROLE_INITIATOR)
 673 #define ISP_ROLE_EITHER         ISP_ROLE_BOTH
 674 #ifndef ISP_DEFAULT_ROLES
 675 /*
 676  * Counterintuitively, we prefer to default to role 'none'
 677  * if we are enable target mode support. This gives us the
 678  * maximum flexibility as to which port will do what.
 679  */
 680 #ifdef  ISP_TARGET_MODE
 681 #define ISP_DEFAULT_ROLES       ISP_ROLE_NONE
 682 #else
 683 #define ISP_DEFAULT_ROLES       ISP_ROLE_INITIATOR
 684 #endif
 685 #endif
 686
 687
 688 /*
 689  * Firmware related defines
 690  */
 691 #define ISP_CODE_ORG                    0x1000  /* default f/w code start */
 692 #define ISP_CODE_ORG_2300               0x0800  /* ..except for 2300s */
 693 #define ISP_CODE_ORG_2400               0x100000 /* ..and 2400s */
 694 #define ISP_FW_REV(maj, min, mic)       ((maj << 24) | (min << 16) | mic)
 695 #define ISP_FW_MAJOR(code)              ((code >> 24) & 0xff)
 696 #define ISP_FW_MINOR(code)              ((code >> 16) & 0xff)
 697 #define ISP_FW_MICRO(code)              ((code >>  8) & 0xff)
 698 #define ISP_FW_REVX(xp)                 ((xp[0]<<24) | (xp[1] << 16) | xp[2])
 699 #define ISP_FW_MAJORX(xp)               (xp[0])
 700 #define ISP_FW_MINORX(xp)               (xp[1])
 701 #define ISP_FW_MICROX(xp)               (xp[2])
 702 #define ISP_FW_NEWER_THAN(i, major, minor, micro)               \
 703  (ISP_FW_REVX((i)->isp_fwrev) > ISP_FW_REV(major, minor, micro))
 704 #define ISP_FW_OLDER_THAN(i, major, minor, micro)               \
 705  (ISP_FW_REVX((i)->isp_fwrev) < ISP_FW_REV(major, minor, micro))
 706
 707 /*
 708  * Bus (implementation) types
 709  */
 710 #define ISP_BT_PCI              0       /* PCI Implementations */
 711 #define ISP_BT_SBUS             1       /* SBus Implementations */
 712
 713 /*
 714  * If we have not otherwise defined SBus support away make sure
 715  * it is defined here such that the code is included as default
 716  */
 717 #ifndef ISP_SBUS_SUPPORTED
 718 #define ISP_SBUS_SUPPORTED      1
 719 #endif
 720
 721 /*
 722  * Chip Types
 723  */
 724 #define ISP_HA_SCSI             0xf
 725 #define ISP_HA_SCSI_UNKNOWN     0x1
 726 #define ISP_HA_SCSI_1020        0x2
 727 #define ISP_HA_SCSI_1020A       0x3
 728 #define ISP_HA_SCSI_1040        0x4
 729 #define ISP_HA_SCSI_1040A       0x5
 730 #define ISP_HA_SCSI_1040B       0x6
 731 #define ISP_HA_SCSI_1040C       0x7
 732 #define ISP_HA_SCSI_1240        0x8
 733 #define ISP_HA_SCSI_1080        0x9
 734 #define ISP_HA_SCSI_1280        0xa
 735 #define ISP_HA_SCSI_10160       0xb
 736 #define ISP_HA_SCSI_12160       0xc
 737 #define ISP_HA_FC               0xf0
 738 #define ISP_HA_FC_2100          0x10
 739 #define ISP_HA_FC_2200          0x20
 740 #define ISP_HA_FC_2300          0x30
 741 #define ISP_HA_FC_2312          0x40
 742 #define ISP_HA_FC_2322          0x50
 743 #define ISP_HA_FC_2400          0x60
 744 #define ISP_HA_FC_2500          0x70
 745 #define ISP_HA_FC_2600          0x80
 746
 747 #define IS_SCSI(isp)    (isp->isp_type & ISP_HA_SCSI)
 748 #define IS_1020(isp)    (isp->isp_type < ISP_HA_SCSI_1240)
 749 #define IS_1240(isp)    (isp->isp_type == ISP_HA_SCSI_1240)
 750 #define IS_1080(isp)    (isp->isp_type == ISP_HA_SCSI_1080)
 751 #define IS_1280(isp)    (isp->isp_type == ISP_HA_SCSI_1280)
 752 #define IS_10160(isp)   (isp->isp_type == ISP_HA_SCSI_10160)
 753 #define IS_12160(isp)   (isp->isp_type == ISP_HA_SCSI_12160)
 754
 755 #define IS_12X0(isp)    (IS_1240(isp) || IS_1280(isp))
 756 #define IS_1X160(isp)   (IS_10160(isp) || IS_12160(isp))
 757 #define IS_DUALBUS(isp) (IS_12X0(isp) || IS_12160(isp))
 758 #define IS_ULTRA2(isp)  (IS_1080(isp) || IS_1280(isp) || IS_1X160(isp))
 759 #define IS_ULTRA3(isp)  (IS_1X160(isp))
 760
 761 #define IS_FC(isp)      ((isp)->isp_type & ISP_HA_FC)
 762 #define IS_2100(isp)    ((isp)->isp_type == ISP_HA_FC_2100)
 763 #define IS_2200(isp)    ((isp)->isp_type == ISP_HA_FC_2200)
 764 #define IS_23XX(isp)    ((isp)->isp_type >= ISP_HA_FC_2300 && \
 765                                 (isp)->isp_type < ISP_HA_FC_2400)
 766 #define IS_2300(isp)    ((isp)->isp_type == ISP_HA_FC_2300)
 767 #define IS_2312(isp)    ((isp)->isp_type == ISP_HA_FC_2312)
 768 #define IS_2322(isp)    ((isp)->isp_type == ISP_HA_FC_2322)
 769 #define IS_24XX(isp)    ((isp)->isp_type >= ISP_HA_FC_2400)
 770 #define IS_25XX(isp)    ((isp)->isp_type >= ISP_HA_FC_2500)
 771 #define IS_26XX(isp)    ((isp)->isp_type >= ISP_HA_FC_2600)
 772
 773 /*
 774  * DMA related macros
 775  */
 776 #define DMA_WD3(x)      (((uint16_t)(((uint64_t)x) >> 48)) & 0xffff)
 777 #define DMA_WD2(x)      (((uint16_t)(((uint64_t)x) >> 32)) & 0xffff)
 778 #define DMA_WD1(x)      ((uint16_t)((x) >> 16) & 0xffff)
 779 #define DMA_WD0(x)      ((uint16_t)((x) & 0xffff))
 780
 781 #define DMA_LO32(x)     ((uint32_t) (x))
 782 #define DMA_HI32(x)     ((uint32_t)(((uint64_t)x) >> 32))
 783
 784 /*
 785  * Core System Function Prototypes
 786  */
 787
 788 /*
 789  * Reset Hardware. Totally. Assumes that you'll follow this with a call to isp_init.
 790  */
 791 void isp_reset(ispsoftc_t *, int);
 792
 793 /*
 794  * Initialize Hardware to known state
 795  */
 796 void isp_init(ispsoftc_t *);
 797
 798 /*
 799  * Reset the ISP and call completion for any orphaned commands.
 800  */
 801 int isp_reinit(ispsoftc_t *, int);
 802
 803 /*
 804  * Shutdown hardware after use.
 805  */
 806 void isp_shutdown(ispsoftc_t *);
 807
 808 /*
 809  * Internal Interrupt Service Routine
 810  */
 811 #ifdef  ISP_TARGET_MODE
 812 void isp_intr_atioq(ispsoftc_t *);
 813 #endif
 814 void isp_intr_async(ispsoftc_t *, uint16_t event);
 815 void isp_intr_mbox(ispsoftc_t *, uint16_t mbox0);
 816 void isp_intr_respq(ispsoftc_t *);
 817
 818
 819 /*
 820  * Command Entry Point- Platform Dependent layers call into this
 821  */
 822 int isp_start(XS_T *);
 823
 824 /* these values are what isp_start returns */
 825 #define CMD_COMPLETE    101     /* command completed */
 826 #define CMD_EAGAIN      102     /* busy- maybe retry later */
 827 #define CMD_QUEUED      103     /* command has been queued for execution */
 828 #define CMD_RQLATER     104     /* requeue this command later */
 829
 830 /*
 831  * Command Completion Point- Core layers call out from this with completed cmds
 832  */
 833 void isp_done(XS_T *);
 834
 835 /*
 836  * Platform Dependent to External to Internal Control Function
 837  *
 838  * Assumes locks are held on entry. You should note that with many of
 839  * these commands locks may be released while this function is called.
 840  *
 841  * ... ISPCTL_RESET_BUS, int channel);
 842  *        Reset BUS on this channel
 843  * ... ISPCTL_RESET_DEV, int channel, int target);
 844  *        Reset Device on this channel at this target.
 845  * ... ISPCTL_ABORT_CMD, XS_T *xs);
 846  *        Abort active transaction described by xs.
 847  * ... IPCTL_UPDATE_PARAMS);
 848  *        Update any operating parameters (speed, etc.)
 849  * ... ISPCTL_FCLINK_TEST, int channel);
 850  *        Test FC link status on this channel
 851  * ... ISPCTL_SCAN_LOOP, int channel);
 852  *        Scan local loop on this channel
 853  * ... ISPCTL_SCAN_FABRIC, int channel);
 854  *        Scan fabric on this channel
 855  * ... ISPCTL_PDB_SYNC, int channel);
 856  *        Synchronize port database on this channel
 857  * ... ISPCTL_SEND_LIP, int channel);
 858  *        Send a LIP on this channel
 859  * ... ISPCTL_GET_NAMES, int channel, int np, uint64_t *wwnn, uint64_t *wwpn)
 860  *        Get a WWNN/WWPN for this N-port handle on this channel
 861  * ... ISPCTL_RUN_MBOXCMD, mbreg_t *mbp)
 862  *        Run this mailbox command
 863  * ... ISPCTL_GET_PDB, int channel, int nphandle, isp_pdb_t *pdb)
 864  *        Get PDB on this channel for this N-port handle
 865  * ... ISPCTL_PLOGX, isp_plcmd_t *)
 866  *        Performa a port login/logout
 867  * ... ISPCTL_CHANGE_ROLE, int channel, int role);
 868  *        Change role of specified channel
 869  *
 870  * ISPCTL_PDB_SYNC is somewhat misnamed. It actually is the final step, in
 871  * order, of ISPCTL_FCLINK_TEST, ISPCTL_SCAN_LOOP, and ISPCTL_SCAN_FABRIC.
 872  * The main purpose of ISPCTL_PDB_SYNC is to complete management of logging
 873  * and logging out of fabric devices (if one is on a fabric) and then marking
 874  * the 'loop state' as being ready to now be used for sending commands to
 875  * devices.
 876  */
 877 typedef enum {
 878         ISPCTL_RESET_BUS,
 879         ISPCTL_RESET_DEV,
 880         ISPCTL_ABORT_CMD,
 881         ISPCTL_UPDATE_PARAMS,
 882         ISPCTL_FCLINK_TEST,
 883         ISPCTL_SCAN_FABRIC,
 884         ISPCTL_SCAN_LOOP,
 885         ISPCTL_PDB_SYNC,
 886         ISPCTL_SEND_LIP,
 887         ISPCTL_GET_NAMES,
 888         ISPCTL_RUN_MBOXCMD,
 889         ISPCTL_GET_PDB,
 890         ISPCTL_PLOGX,
 891         ISPCTL_CHANGE_ROLE
 892 } ispctl_t;
 893 int isp_control(ispsoftc_t *, ispctl_t, ...);
 894
 895 /*
 896  * Platform Dependent to Internal to External Control Function
 897  */
 898
 899 typedef enum {
 900         ISPASYNC_NEW_TGT_PARAMS,        /* SPI New Target Parameters */
 901         ISPASYNC_BUS_RESET,             /* All Bus Was Reset */
 902         ISPASYNC_LOOP_DOWN,             /* FC Loop Down */
 903         ISPASYNC_LOOP_UP,               /* FC Loop Up */
 904         ISPASYNC_LIP,                   /* FC LIP Received */
 905         ISPASYNC_LOOP_RESET,            /* FC Loop Reset Received */
 906         ISPASYNC_CHANGE_NOTIFY,         /* FC Change Notification */
 907         ISPASYNC_DEV_ARRIVED,           /* FC Device Arrived */
 908         ISPASYNC_DEV_CHANGED,           /* FC Device Changed */
 909         ISPASYNC_DEV_STAYED,            /* FC Device Stayed */
 910         ISPASYNC_DEV_GONE,              /* FC Device Departure */
 911         ISPASYNC_TARGET_NOTIFY,         /* All target async notification */
 912         ISPASYNC_TARGET_NOTIFY_ACK,     /* All target notify ack required */
 913         ISPASYNC_TARGET_ACTION,         /* All target action requested */
 914         ISPASYNC_FW_CRASH,              /* All Firmware has crashed */
 915         ISPASYNC_FW_RESTARTED           /* All Firmware has been restarted */
 916 } ispasync_t;
 917 void isp_async(ispsoftc_t *, ispasync_t, ...);
 918
 919 #define ISPASYNC_CHANGE_PDB     0
 920 #define ISPASYNC_CHANGE_SNS     1
 921 #define ISPASYNC_CHANGE_OTHER   2
 922
 923 /*
 924  * Platform Dependent Error and Debug Printout
 925  *
 926  * Two required functions for each platform must be provided:
 927  *
 928  *    void isp_prt(ispsoftc_t *, int level, const char *, ...)
 929  *    void isp_xs_prt(ispsoftc_t *, XS_T *, int level, const char *, ...)
 930  *
 931  * but due to compiler differences on different platforms this won't be
 932  * formally defined here. Instead, they go in each platform definition file.
 933  */
 934
 935 #define ISP_LOGALL      0x0     /* log always */
 936 #define ISP_LOGCONFIG   0x1     /* log configuration messages */
 937 #define ISP_LOGINFO     0x2     /* log informational messages */
 938 #define ISP_LOGWARN     0x4     /* log warning messages */
 939 #define ISP_LOGERR      0x8     /* log error messages */
 940 #define ISP_LOGDEBUG0   0x10    /* log simple debug messages */
 941 #define ISP_LOGDEBUG1   0x20    /* log intermediate debug messages */
 942 #define ISP_LOGDEBUG2   0x40    /* log most debug messages */
 943 #define ISP_LOGDEBUG3   0x80    /* log high frequency debug messages */
 944 #define ISP_LOG_SANCFG  0x100   /* log SAN configuration */
 945 #define ISP_LOG_CWARN   0x200   /* log SCSI command "warnings" (e.g., check conditions) */
 946 #define ISP_LOG_WARN1   0x400   /* log WARNS we might be interested at some time */
 947 #define ISP_LOGTINFO    0x1000  /* log informational messages (target mode) */
 948 #define ISP_LOGTDEBUG0  0x2000  /* log simple debug messages (target mode) */
 949 #define ISP_LOGTDEBUG1  0x4000  /* log intermediate debug messages (target) */
 950 #define ISP_LOGTDEBUG2  0x8000  /* log all debug messages (target) */
 951
 952 /*
 953  * Each Platform provides it's own isposinfo substructure of the ispsoftc
 954  * defined above.
 955  *
 956  * Each platform must also provide the following macros/defines:
 957  *
 958  *
 959  *      ISP_FC_SCRLEN                           FC scratch area DMA length
 960  *
 961  *      ISP_MEMZERO(dst, src)                   platform zeroing function
 962  *      ISP_MEMCPY(dst, src, count)             platform copying function
 963  *      ISP_SNPRINTF(buf, bufsize, fmt, ...)    snprintf
 964  *      ISP_DELAY(usecs)                        microsecond spindelay function
 965  *      ISP_SLEEP(isp, usecs)                   microsecond sleep function
 966  *
 967  *      ISP_INLINE                              ___inline or not- depending on how
 968  *                                              good your debugger is
 969  *      ISP_MIN                                 shorthand for ((a) < (b))? (a) : (b)
 970  *
 971  *      NANOTIME_T                              nanosecond time type
 972  *
 973  *      GET_NANOTIME(NANOTIME_T *)              get current nanotime.
 974  *
 975  *      GET_NANOSEC(NANOTIME_T *)               get uint64_t from NANOTIME_T
 976  *
 977  *      NANOTIME_SUB(NANOTIME_T *, NANOTIME_T *)
 978  *                                              subtract two NANOTIME_T values
 979  *
 980  *      MAXISPREQUEST(ispsoftc_t *)             maximum request queue size
 981  *                                              for this particular board type
 982  *
 983  *      MEMORYBARRIER(ispsoftc_t *, barrier_type, offset, size, chan)
 984  *
 985  *              Function/Macro the provides memory synchronization on
 986  *              various objects so that the ISP's and the system's view
 987  *              of the same object is consistent.
 988  *
 989  *      MBOX_ACQUIRE(ispsoftc_t *)              acquire lock on mailbox regs
 990  *      MBOX_WAIT_COMPLETE(ispsoftc_t *, mbreg_t *) wait for cmd to be done
 991  *      MBOX_NOTIFY_COMPLETE(ispsoftc_t *)      notification of mbox cmd donee
 992  *      MBOX_RELEASE(ispsoftc_t *)              release lock on mailbox regs
 993  *
 994  *      FC_SCRATCH_ACQUIRE(ispsoftc_t *, chan)  acquire lock on FC scratch area
 995  *                                              return -1 if you cannot
 996  *      FC_SCRATCH_RELEASE(ispsoftc_t *, chan)  acquire lock on FC scratch area
 997  *
 998  *      FCP_NEXT_CRN(ispsoftc_t *, XS_T *, rslt, channel, target, lun)  generate the next command reference number. XS_T * may be null.
 999  *
1000  *      SCSI_GOOD       SCSI 'Good' Status
1001  *      SCSI_CHECK      SCSI 'Check Condition' Status
1002  *      SCSI_BUSY       SCSI 'Busy' Status
1003  *      SCSI_QFULL      SCSI 'Queue Full' Status
1004  *
1005  *      XS_T                    Platform SCSI transaction type (i.e., command for HBA)
1006  *      XS_DMA_ADDR_T           Platform PCI DMA Address Type
1007  *      XS_GET_DMA_SEG(..)      Get 32 bit dma segment list value
1008  *      XS_GET_DMA64_SEG(..)    Get 64 bit dma segment list value
1009  *      XS_NEED_DMA64_SEG(..)   dma segment needs 64 bit storage
1010  *      XS_ISP(xs)              gets an instance out of an XS_T
1011  *      XS_CHANNEL(xs)          gets the channel (bus # for DUALBUS cards) ""
1012  *      XS_TGT(xs)              gets the target ""
1013  *      XS_LUN(xs)              gets the lun ""
1014  *      XS_CDBP(xs)             gets a pointer to the scsi CDB ""
1015  *      XS_CDBLEN(xs)           gets the CDB's length ""
1016  *      XS_XFRLEN(xs)           gets the associated data transfer length ""
1017  *      XS_TIME(xs)             gets the time (in seconds) for this command
1018  *      XS_GET_RESID(xs)        gets the current residual count
1019  *      XS_GET_RESID(xs, resid) sets the current residual count
1020  *      XS_STSP(xs)             gets a pointer to the SCSI status byte ""
1021  *      XS_SNSP(xs)             gets a pointer to the associate sense data
1022  *      XS_TOT_SNSLEN(xs)       gets the total length of sense data storage
1023  *      XS_CUR_SNSLEN(xs)       gets the currently used length of sense data storage
1024  *      XS_SNSKEY(xs)           dereferences XS_SNSP to get the current stored Sense Key
1025  *      XS_SNSASC(xs)           dereferences XS_SNSP to get the current stored Additional Sense Code
1026  *      XS_SNSASCQ(xs)          dereferences XS_SNSP to get the current stored Additional Sense Code Qualifier
1027  *      XS_TAG_P(xs)            predicate of whether this command should be tagged
1028  *      XS_TAG_TYPE(xs)         which type of tag to use
1029  *      XS_SETERR(xs)           set error state
1030  *
1031  *              HBA_NOERROR     command has no erros
1032  *              HBA_BOTCH       hba botched something
1033  *              HBA_CMDTIMEOUT  command timed out
1034  *              HBA_SELTIMEOUT  selection timed out (also port logouts for FC)
1035  *              HBA_TGTBSY      target returned a BUSY status
1036  *              HBA_BUSRESET    bus reset destroyed command
1037  *              HBA_ABORTED     command was aborted (by request)
1038  *              HBA_DATAOVR     a data overrun was detected
1039  *              HBA_ARQFAIL     Automatic Request Sense failed
1040  *
1041  *      XS_ERR(xs)      return current error state
1042  *      XS_NOERR(xs)    there is no error currently set
1043  *      XS_INITERR(xs)  initialize error state
1044  *
1045  *      XS_SAVE_SENSE(xs, sp, len)      save sense data
1046  *      XS_APPEND_SENSE(xs, sp, len)    append more sense data
1047  *
1048  *      XS_SENSE_VALID(xs)              indicates whether sense is valid
1049  *
1050  *      DEFAULT_FRAMESIZE(ispsoftc_t *)         Default Frame Size
1051  *      DEFAULT_EXEC_THROTTLE(ispsoftc_t *)     Default Execution Throttle
1052  *
1053  *      DEFAULT_ROLE(ispsoftc_t *, int)         Get Default Role for a channel
1054  *      DEFAULT_IID(ispsoftc_t *, int)          Default SCSI initiator ID
1055  *      DEFAULT_LOOPID(ispsoftc_t *, int)       Default FC Loop ID
1056  *
1057  *              These establish reasonable defaults for each platform.
1058  *              These must be available independent of card NVRAM and are
1059  *              to be used should NVRAM not be readable.
1060  *
1061  *      DEFAULT_NODEWWN(ispsoftc_t *, chan)     Default FC Node WWN to use
1062  *      DEFAULT_PORTWWN(ispsoftc_t *, chan)     Default FC Port WWN to use
1063  *
1064  *              These defines are hooks to allow the setting of node and
1065  *              port WWNs when NVRAM cannot be read or is to be overriden.
1066  *
1067  *      ACTIVE_NODEWWN(ispsoftc_t *, chan)      FC Node WWN to use
1068  *      ACTIVE_PORTWWN(ispsoftc_t *, chan)      FC Port WWN to use
1069  *
1070  *              After NVRAM is read, these will be invoked to get the
1071  *              node and port WWNs that will actually be used for this
1072  *              channel.
1073  *
1074  *
1075  *      ISP_IOXPUT_8(ispsoftc_t *, uint8_t srcval, uint8_t *dstptr)
1076  *      ISP_IOXPUT_16(ispsoftc_t *, uint16_t srcval, uint16_t *dstptr)
1077  *      ISP_IOXPUT_32(ispsoftc_t *, uint32_t srcval, uint32_t *dstptr)
1078  *
1079  *      ISP_IOXGET_8(ispsoftc_t *, uint8_t *srcptr, uint8_t dstrval)
1080  *      ISP_IOXGET_16(ispsoftc_t *, uint16_t *srcptr, uint16_t dstrval)
1081  *      ISP_IOXGET_32(ispsoftc_t *, uint32_t *srcptr, uint32_t dstrval)
1082  *
1083  *      ISP_SWIZZLE_NVRAM_WORD(ispsoftc_t *, uint16_t *)
1084  *      ISP_SWIZZLE_NVRAM_LONG(ispsoftc_t *, uint32_t *)
1085  *      ISP_SWAP16(ispsoftc_t *, uint16_t srcval)
1086  *      ISP_SWAP32(ispsoftc_t *, uint32_t srcval)
1087  */
1088
1089 #ifdef  ISP_TARGET_MODE
1090 /*
1091  * The functions below are for the publicly available
1092  * target mode functions that are internal to the Qlogic driver.
1093  */
1094
1095 /*
1096  * This function handles new response queue entry appropriate for target mode.
1097  */
1098 int isp_target_notify(ispsoftc_t *, void *, uint32_t *);
1099
1100 /*
1101  * This function externalizes the ability to acknowledge an Immediate Notify request.
1102  */
1103 int isp_notify_ack(ispsoftc_t *, void *);
1104
1105 /*
1106  * This function externalized acknowledging (success/fail) an ABTS frame
1107  */
1108 int isp_acknak_abts(ispsoftc_t *, void *, int);
1109
1110 /*
1111  * General request queue 'put' routine for target mode entries.
1112  */
1113 int isp_target_put_entry(ispsoftc_t *isp, void *);
1114
1115 /*
1116  * General routine to put back an ATIO entry-
1117  * used for replenishing f/w resource counts.
1118  * The argument is a pointer to a source ATIO
1119  * or ATIO2.
1120  */
1121 int isp_target_put_atio(ispsoftc_t *, void *);
1122
1123 /*
1124  * General routine to send a final CTIO for a command- used mostly for
1125  * local responses.
1126  */
1127 int isp_endcmd(ispsoftc_t *, ...);
1128 #define ECMD_SVALID     0x100
1129 #define ECMD_RVALID     0x200
1130 #define ECMD_TERMINATE  0x400
1131
1132 /*
1133  * Handle an asynchronous event
1134  */
1135 void isp_target_async(ispsoftc_t *, int, int);
1136 #endif
1137 #endif  /* _ISPVAR_H */