sys/dev/isp/ispvar.h

   1 /* $FreeBSD$ */
   2 /*-
   3  *  Copyright (c) 1997-2007 by Matthew Jacob
   4  *  All rights reserved.
   5  *
   6  *  Redistribution and use in source and binary forms, with or without
   7  *  modification, are permitted provided that the following conditions
   8  *  are met:
   9  *
  10  *  1. Redistributions of source code must retain the above copyright
  11  *     notice, this list of conditions and the following disclaimer.
  12  *  2. Redistributions in binary form must reproduce the above copyright
  13  *     notice, this list of conditions and the following disclaimer in the
  14  *     documentation and/or other materials provided with the distribution.
  15  *
  16  *  THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  *  ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
  20  *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  *  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  *  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  *  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  *  SUCH DAMAGE.
  27  */
  28 /*
  29  * Soft Definitions for for Qlogic ISP SCSI adapters.
  30  */
  31
  32 #ifndef _ISPVAR_H
  33 #define _ISPVAR_H
  34
  35 #if defined(__NetBSD__) || defined(__OpenBSD__)
  36 #include <dev/ic/isp_stds.h>
  37 #include <dev/ic/ispmbox.h>
  38 #endif
  39 #ifdef  __FreeBSD__
  40 #include <dev/isp/isp_stds.h>
  41 #include <dev/isp/ispmbox.h>
  42 #endif
  43 #ifdef  __linux__
  44 #include "isp_stds.h"
  45 #include "ispmbox.h"
  46 #endif
  47 #ifdef  __svr4__
  48 #include "isp_stds.h"
  49 #include "ispmbox.h"
  50 #endif
  51
  52 #define ISP_CORE_VERSION_MAJOR  3
  53 #define ISP_CORE_VERSION_MINOR  0
  54
  55 /*
  56  * Vector for bus specific code to provide specific services.
  57  */
  58 typedef struct ispsoftc ispsoftc_t;
  59 struct ispmdvec {
  60         int             (*dv_rd_isr)
  61             (ispsoftc_t *, uint32_t *, uint16_t *, uint16_t *);
  62         uint32_t        (*dv_rd_reg) (ispsoftc_t *, int);
  63         void            (*dv_wr_reg) (ispsoftc_t *, int, uint32_t);
  64         int             (*dv_mbxdma) (ispsoftc_t *);
  65         int             (*dv_dmaset)
  66             (ispsoftc_t *, XS_T *, ispreq_t *, uint32_t *, uint32_t);
  67         void            (*dv_dmaclr) (ispsoftc_t *, XS_T *, uint32_t);
  68         void            (*dv_reset0) (ispsoftc_t *);
  69         void            (*dv_reset1) (ispsoftc_t *);
  70         void            (*dv_dregs) (ispsoftc_t *, const char *);
  71         const void *    dv_ispfw;       /* ptr to f/w */
  72         uint16_t        dv_conf1;
  73         uint16_t        dv_clock;       /* clock frequency */
  74 };
  75
  76 /*
  77  * Overall parameters
  78  */
  79 #define MAX_TARGETS             16
  80 #define MAX_FC_TARG             512
  81 #define ISP_MAX_TARGETS(isp)    (IS_FC(isp)? MAX_FC_TARG : MAX_TARGETS)
  82 #define ISP_MAX_LUNS(isp)       (isp)->isp_maxluns
  83
  84 /*
  85  * Macros to access ISP registers through bus specific layers-
  86  * mostly wrappers to vector through the mdvec structure.
  87  */
  88 #define ISP_READ_ISR(isp, isrp, semap, mbox0p)  \
  89         (*(isp)->isp_mdvec->dv_rd_isr)(isp, isrp, semap, mbox0p)
  90
  91 #define ISP_READ(isp, reg)      \
  92         (*(isp)->isp_mdvec->dv_rd_reg)((isp), (reg))
  93
  94 #define ISP_WRITE(isp, reg, val)        \
  95         (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), (val))
  96
  97 #define ISP_MBOXDMASETUP(isp)   \
  98         (*(isp)->isp_mdvec->dv_mbxdma)((isp))
  99
 100 #define ISP_DMASETUP(isp, xs, req, iptrp, optr) \
 101         (*(isp)->isp_mdvec->dv_dmaset)((isp), (xs), (req), (iptrp), (optr))
 102
 103 #define ISP_DMAFREE(isp, xs, hndl)              \
 104         if ((isp)->isp_mdvec->dv_dmaclr)        \
 105             (*(isp)->isp_mdvec->dv_dmaclr)((isp), (xs), (hndl))
 106
 107 #define ISP_RESET0(isp) \
 108         if ((isp)->isp_mdvec->dv_reset0) (*(isp)->isp_mdvec->dv_reset0)((isp))
 109 #define ISP_RESET1(isp) \
 110         if ((isp)->isp_mdvec->dv_reset1) (*(isp)->isp_mdvec->dv_reset1)((isp))
 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
 133 /*
 134  * Request/Response Queue defines and macros.
 135  * The maximum is defined per platform (and can be based on board type).
 136  */
 137 /* This is the size of a queue entry (request and response) */
 138 #define QENTRY_LEN                      64
 139 /* Both request and result queue length must be a power of two */
 140 #define RQUEST_QUEUE_LEN(x)             MAXISPREQUEST(x)
 141 #ifdef  ISP_TARGET_MODE
 142 #define RESULT_QUEUE_LEN(x)             MAXISPREQUEST(x)
 143 #else
 144 #define RESULT_QUEUE_LEN(x)             \
 145         (((MAXISPREQUEST(x) >> 2) < 64)? 64 : MAXISPREQUEST(x) >> 2)
 146 #endif
 147 #define ISP_QUEUE_ENTRY(q, idx)         (((uint8_t *)q) + ((idx) * QENTRY_LEN))
 148 #define ISP_QUEUE_SIZE(n)               ((n) * QENTRY_LEN)
 149 #define ISP_NXT_QENTRY(idx, qlen)       (((idx) + 1) & ((qlen)-1))
 150 #define ISP_QFREE(in, out, qlen)        \
 151         ((in == out)? (qlen - 1) : ((in > out)? \
 152         ((qlen - 1) - (in - out)) : (out - in - 1)))
 153 #define ISP_QAVAIL(isp) \
 154         ISP_QFREE(isp->isp_reqidx, isp->isp_reqodx, RQUEST_QUEUE_LEN(isp))
 155
 156 #define ISP_ADD_REQUEST(isp, nxti)                                      \
 157         MEMORYBARRIER(isp, SYNC_REQUEST, isp->isp_reqidx, QENTRY_LEN);  \
 158         ISP_WRITE(isp, isp->isp_rqstinrp, nxti);                        \
 159         isp->isp_reqidx = nxti
 160
 161 /*
 162  * SCSI Specific Host Adapter Parameters- per bus, per target
 163  */
 164 typedef struct {
 165         uint32_t                                : 10,
 166                         isp_bad_nvram           : 1,
 167                         isp_gotdparms           : 1,
 168                         isp_req_ack_active_neg  : 1,
 169                         isp_data_line_active_neg: 1,
 170                         isp_cmd_dma_burst_enable: 1,
 171                         isp_data_dma_burst_enabl: 1,
 172                         isp_fifo_threshold      : 3,
 173                         isp_ptisp               : 1,
 174                         isp_ultramode           : 1,
 175                         isp_diffmode            : 1,
 176                         isp_lvdmode             : 1,
 177                         isp_fast_mttr           : 1,    /* fast sram */
 178                         isp_initiator_id        : 4,
 179                         isp_async_data_setup    : 4;
 180         uint16_t        isp_selection_timeout;
 181         uint16_t        isp_max_queue_depth;
 182         uint8_t         isp_tag_aging;
 183         uint8_t         isp_bus_reset_delay;
 184         uint8_t         isp_retry_count;
 185         uint8_t         isp_retry_delay;
 186         struct {
 187                 uint32_t
 188                         exc_throttle    :       8,
 189                                         :       1,
 190                         dev_enable      :       1,      /* ignored */
 191                         dev_update      :       1,
 192                         dev_refresh     :       1,
 193                         actv_offset     :       4,
 194                         goal_offset     :       4,
 195                         nvrm_offset     :       4;
 196                 uint8_t         actv_period;    /* current sync period */
 197                 uint8_t         goal_period;    /* goal sync period */
 198                 uint8_t         nvrm_period;    /* nvram sync period */
 199                 uint16_t        actv_flags;     /* current device flags */
 200                 uint16_t        goal_flags;     /* goal device flags */
 201                 uint16_t        nvrm_flags;     /* nvram device flags */
 202         } isp_devparam[MAX_TARGETS];
 203 } sdparam;
 204
 205 /*
 206  * Device Flags
 207  */
 208 #define DPARM_DISC      0x8000
 209 #define DPARM_PARITY    0x4000
 210 #define DPARM_WIDE      0x2000
 211 #define DPARM_SYNC      0x1000
 212 #define DPARM_TQING     0x0800
 213 #define DPARM_ARQ       0x0400
 214 #define DPARM_QFRZ      0x0200
 215 #define DPARM_RENEG     0x0100
 216 #define DPARM_NARROW    0x0080
 217 #define DPARM_ASYNC     0x0040
 218 #define DPARM_PPR       0x0020
 219 #define DPARM_DEFAULT   (0xFF00 & ~DPARM_QFRZ)
 220 #define DPARM_SAFE_DFLT (DPARM_DEFAULT & ~(DPARM_WIDE|DPARM_SYNC|DPARM_TQING))
 221
 222 /* technically, not really correct, as they need to be rated based upon clock */
 223 #define ISP_80M_SYNCPARMS       0x0c09
 224 #define ISP_40M_SYNCPARMS       0x0c0a
 225 #define ISP_20M_SYNCPARMS       0x0c0c
 226 #define ISP_20M_SYNCPARMS_1040  0x080c
 227 #define ISP_10M_SYNCPARMS       0x0c19
 228 #define ISP_08M_SYNCPARMS       0x0c25
 229 #define ISP_05M_SYNCPARMS       0x0c32
 230 #define ISP_04M_SYNCPARMS       0x0c41
 231
 232 /*
 233  * Fibre Channel Specifics
 234  */
 235 /* These are for non-2K Login Firmware cards */
 236 #define FL_ID                   0x7e    /* FL_Port Special ID */
 237 #define SNS_ID                  0x80    /* SNS Server Special ID */
 238 #define NPH_MAX                 0xfe
 239
 240 /* These are for 2K Login Firmware cards */
 241 #define NPH_RESERVED            0x7F0   /* begin of reserved N-port handles */
 242 #define NPH_MGT_ID              0x7FA   /* Management Server Special ID */
 243 #define NPH_SNS_ID              0x7FC   /* SNS Server Special ID */
 244 #define NPH_FL_ID               0x7FE   /* FL Port Special ID */
 245 #define NPH_MAX_2K              0x800
 246
 247 /*
 248  * "Unassigned" handle to be used internally
 249  */
 250 #define NIL_HANDLE              0xffff
 251
 252 /*
 253  * Limit for devices on an arbitrated loop.
 254  */
 255 #define LOCAL_LOOP_LIM          126
 256
 257 /*
 258  * Special Port IDs
 259  */
 260 #define MANAGEMENT_PORT_ID      0xFFFFFA
 261 #define SNS_PORT_ID             0xFFFFFC
 262 #define FABRIC_PORT_ID          0xFFFFFE
 263
 264
 265 /*
 266  * FC Port Database entry.
 267  *
 268  * It has a handle that the f/w uses to address commands to a device.
 269  * This handle's value may be assigned by the firmware (e.g., for local loop
 270  * devices) or by the driver (e.g., for fabric devices).
 271  *
 272  * It has a state. If the state if VALID, that means that we've logged into
 273  * the device. We also *may* have a initiator map index entry. This is a value
 274  * from 0..MAX_FC_TARG that is used to index into the isp_ini_map array. If
 275  * the value therein is non-zero, then that value minus one is used to index
 276  * into the Port Database to find the handle for forming commands. There is
 277  * back-index minus one value within to Port Database entry that tells us
 278  * which entry in isp_ini_map points to us (to avoid searching).
 279  *
 280  * Local loop devices the firmware automatically performs PLOGI on for us
 281  * (which is why that handle is imposed upon us). Fabric devices we assign
 282  * a handle to and perform the PLOGI on.
 283  *
 284  * When a PORT DATABASE CHANGED asynchronous event occurs, we mark all VALID
 285  * entries as PROBATIONAL. This allows us, if policy says to, just keep track
 286  * of devices whose handles change but are otherwise the same device (and
 287  * thus keep 'target' constant).
 288  *
 289  * In any case, we search all possible local loop handles. For each one that
 290  * has a port database entity returned, we search for any PROBATIONAL entry
 291  * that matches it and update as appropriate. Otherwise, as a new entry, we
 292  * find room for it in the Port Database. We *try* and use the handle as the
 293  * index to put it into the Database, but that's just an optimization. We mark
 294  * the entry VALID and make sure that the target index is updated and correct.
 295  *
 296  * When we get done searching the local loop, we then search similarily for
 297  * a list of devices we've gotten from the fabric name controller (if we're
 298  * on a fabric). VALID marking is also done similarily.
 299  *
 300  * When all of this is done, we can march through the database and clean up
 301  * any entry that is still PROBATIONAL (these represent devices which have
 302  * departed). Then we're done and can resume normal operations.
 303  *
 304  * Negative invariants that we try and test for are:
 305  *
 306  *  + There can never be two non-NIL entries with the same { Port, Node } WWN
 307  *    duples.
 308  *
 309  *  + There can never be two non-NIL entries with the same handle.
 310  *
 311  *  + There can never be two non-NIL entries which have the same ini_map_idx
 312  *    value.
 313  */
 314 typedef struct {
 315         /*
 316          * This is the handle that the firmware needs in order for us to
 317          * send commands to the device. For pre-24XX cards, this would be
 318          * the 'loopid'.
 319          */
 320         uint16_t        handle;
 321         /*
 322          * The ini_map_idx, if nonzero, is the system virtual target ID (+1)
 323          * as a cross-reference with the isp_ini_map.
 324          *
 325          * A device is 'autologin' if the firmware automatically logs into
 326          * it (re-logins as needed). Basically, local private loop devices.
 327          *
 328          * The state is the current state of thsi entry.
 329          *
 330          * Role is Initiator, Target, Both
 331          *
 332          * Portid is obvious, as or node && port WWNs. The new_role and
 333          * new_portid is for when we are pending a change.
 334          */
 335         uint16_t        ini_map_idx     : 12,
 336                         autologin       : 1,    /* F/W does PLOGI/PLOGO */
 337                         state           : 3;
 338         uint32_t        reserved        : 6,
 339                         roles           : 2,
 340                         portid          : 24;
 341         uint32_t        new_reserved    : 6,
 342                         new_roles       : 2,
 343                         new_portid      : 24;
 344         uint64_t        node_wwn;
 345         uint64_t        port_wwn;
 346 } fcportdb_t;
 347
 348 #define FC_PORTDB_STATE_NIL             0
 349 #define FC_PORTDB_STATE_PROBATIONAL     1
 350 #define FC_PORTDB_STATE_DEAD            2
 351 #define FC_PORTDB_STATE_CHANGED         3
 352 #define FC_PORTDB_STATE_NEW             4
 353 #define FC_PORTDB_STATE_PENDING_VALID   5
 354 #define FC_PORTDB_STATE_ZOMBIE          6
 355 #define FC_PORTDB_STATE_VALID           7
 356
 357 /*
 358  * FC card specific information
 359  */
 360 typedef struct {
 361         uint32_t                                : 10,
 362                                 isp_tmode       : 1,
 363                                 isp_2klogin     : 1,
 364                                 isp_sccfw       : 1,
 365                                 isp_gbspeed     : 3,
 366                                                 : 1,
 367                                                 : 1,
 368                                 isp_gotdparms   : 1,
 369                                 isp_bad_nvram   : 1,
 370                                 isp_loopstate   : 4,    /* Current Loop State */
 371                                 isp_fwstate     : 4,    /* ISP F/W state */
 372                                 isp_topo        : 3,
 373                                 loop_seen_once  : 1;
 374         uint32_t                                : 8,
 375                                 isp_portid      : 24;   /* S_ID */
 376         uint16_t                isp_fwoptions;
 377         uint16_t                isp_xfwoptions;
 378         uint16_t                isp_zfwoptions;
 379         uint16_t                isp_loopid;     /* hard loop id */
 380         uint16_t                isp_fwattr;     /* firmware attributes */
 381         uint16_t                isp_execthrottle;
 382         uint8_t                 isp_retry_delay;
 383         uint8_t                 isp_retry_count;
 384         uint8_t                 isp_reserved;
 385         uint16_t                isp_maxalloc;
 386         uint16_t                isp_maxfrmlen;
 387         uint64_t                isp_wwnn_nvram;
 388         uint64_t                isp_wwpn_nvram;
 389
 390         /*
 391          * Our Port Data Base
 392          */
 393         fcportdb_t              portdb[MAX_FC_TARG];
 394
 395         /*
 396          * This maps system virtual 'target' id to a portdb entry.
 397          *
 398          * The mapping function is to take any non-zero entry and
 399          * subtract one to get the portdb index. This means that
 400          * entries which are zero are unmapped (i.e., don't exist).
 401          */
 402         uint16_t                isp_ini_map[MAX_FC_TARG];
 403
 404         /*
 405          * Scratch DMA mapped in area to fetch Port Database stuff, etc.
 406          */
 407         void *                  isp_scratch;
 408         XS_DMA_ADDR_T           isp_scdma;
 409 #ifdef  ISP_FW_CRASH_DUMP
 410         uint16_t *              isp_dump_data;
 411 #endif
 412 } fcparam;
 413
 414 #define FW_CONFIG_WAIT          0
 415 #define FW_WAIT_AL_PA           1
 416 #define FW_WAIT_LOGIN           2
 417 #define FW_READY                3
 418 #define FW_LOSS_OF_SYNC         4
 419 #define FW_ERROR                5
 420 #define FW_REINIT               6
 421 #define FW_NON_PART             7
 422
 423 #define LOOP_NIL                0
 424 #define LOOP_LIP_RCVD           1
 425 #define LOOP_PDB_RCVD           2
 426 #define LOOP_SCANNING_LOOP      3
 427 #define LOOP_LSCAN_DONE         4
 428 #define LOOP_SCANNING_FABRIC    5
 429 #define LOOP_FSCAN_DONE         6
 430 #define LOOP_SYNCING_PDB        7
 431 #define LOOP_READY              8
 432
 433 #define TOPO_NL_PORT            0
 434 #define TOPO_FL_PORT            1
 435 #define TOPO_N_PORT             2
 436 #define TOPO_F_PORT             3
 437 #define TOPO_PTP_STUB           4
 438
 439 /*
 440  * Soft Structure per host adapter
 441  */
 442 struct ispsoftc {
 443         /*
 444          * Platform (OS) specific data
 445          */
 446         struct isposinfo        isp_osinfo;
 447
 448         /*
 449          * Pointer to bus specific functions and data
 450          */
 451         struct ispmdvec *       isp_mdvec;
 452
 453         /*
 454          * (Mostly) nonvolatile state. Board specific parameters
 455          * may contain some volatile state (e.g., current loop state).
 456          */
 457
 458         void *                  isp_param;      /* type specific */
 459         uint16_t                isp_fwrev[3];   /* Loaded F/W revision */
 460         uint16_t                isp_romfw_rev[3]; /* PROM F/W revision */
 461         uint16_t                isp_maxcmds;    /* max possible I/O cmds */
 462         uint8_t                 isp_type;       /* HBA Chip Type */
 463         uint8_t                 isp_revision;   /* HBA Chip H/W Revision */
 464         uint32_t                isp_maxluns;    /* maximum luns supported */
 465
 466         uint32_t                isp_clock       : 8,    /* input clock */
 467                                                 : 4,
 468                                 isp_port        : 1,    /* 23XX/24XX only */
 469                                 isp_failed      : 1,    /* board failed */
 470                                 isp_open        : 1,    /* opened (ioctl) */
 471                                 isp_touched     : 1,    /* board ever seen? */
 472                                 isp_bustype     : 1,    /* SBus or PCI */
 473                                 isp_loaded_fw   : 1,    /* loaded firmware */
 474                                 isp_role        : 2,    /* roles supported */
 475                                 isp_dblev       : 12;   /* debug log mask */
 476
 477         uint32_t                isp_confopts;           /* config options */
 478
 479         uint32_t                isp_rqstinrp;   /* register for REQINP */
 480         uint32_t                isp_rqstoutrp;  /* register for REQOUTP */
 481         uint32_t                isp_respinrp;   /* register for RESINP */
 482         uint32_t                isp_respoutrp;  /* register for RESOUTP */
 483         uint32_t                isp_atioinrp;   /* register for ATIOINP */
 484         uint32_t                isp_atiooutrp;  /* register for ATIOOUTP */
 485
 486         /*
 487          * Instrumentation
 488          */
 489         uint64_t                isp_intcnt;             /* total int count */
 490         uint64_t                isp_intbogus;           /* spurious int count */
 491         uint64_t                isp_intmboxc;           /* mbox completions */
 492         uint64_t                isp_intoasync;          /* other async */
 493         uint64_t                isp_rsltccmplt;         /* CMDs on result q */
 494         uint64_t                isp_fphccmplt;          /* CMDs via fastpost */
 495         uint16_t                isp_rscchiwater;
 496         uint16_t                isp_fpcchiwater;
 497
 498         /*
 499          * Volatile state
 500          */
 501
 502         volatile uint32_t       :       8,
 503                 isp_mboxbsy     :       1,      /* mailbox command active */
 504                 isp_state       :       3,
 505                 isp_sendmarker  :       2,      /* send a marker entry */
 506                 isp_update      :       2,      /* update parameters */
 507                 isp_nactive     :       16;     /* how many commands active */
 508         volatile uint32_t       isp_reqodx;     /* index of last ISP pickup */
 509         volatile uint32_t       isp_reqidx;     /* index of next request */
 510         volatile uint32_t       isp_residx;     /* index of next result */
 511         volatile uint32_t       isp_resodx;     /* index of next result */
 512         volatile uint32_t       isp_rspbsy;
 513         volatile uint32_t       isp_lasthdls;   /* last handle seed */
 514         volatile uint32_t       isp_obits;      /* mailbox command output */
 515         volatile uint16_t       isp_mboxtmp[MAILBOX_STORAGE];
 516         volatile uint16_t       isp_lastmbxcmd; /* last mbox command sent */
 517         volatile uint16_t       isp_mbxwrk0;
 518         volatile uint16_t       isp_mbxwrk1;
 519         volatile uint16_t       isp_mbxwrk2;
 520         volatile uint16_t       isp_mbxwrk8;
 521         void *                  isp_mbxworkp;
 522
 523         /*
 524          * Active commands are stored here, indexed by handle functions.
 525          */
 526         XS_T **isp_xflist;
 527
 528 #ifdef  ISP_TARGET_MODE
 529         /*
 530          * Active target commands are stored here, indexed by handle function.
 531          */
 532         void **isp_tgtlist;
 533 #endif
 534
 535         /*
 536          * request/result queue pointers and DMA handles for them.
 537          */
 538         void *                  isp_rquest;
 539         void *                  isp_result;
 540         XS_DMA_ADDR_T           isp_rquest_dma;
 541         XS_DMA_ADDR_T           isp_result_dma;
 542 #ifdef  ISP_TARGET_MODE
 543         /* for 24XX only */
 544         void *                  isp_atioq;
 545         XS_DMA_ADDR_T           isp_atioq_dma;
 546 #endif
 547 };
 548
 549 #define SDPARAM(isp)    ((sdparam *) (isp)->isp_param)
 550 #define FCPARAM(isp)    ((fcparam *) (isp)->isp_param)
 551
 552 /*
 553  * ISP Driver Run States
 554  */
 555 #define ISP_NILSTATE    0
 556 #define ISP_CRASHED     1
 557 #define ISP_RESETSTATE  2
 558 #define ISP_INITSTATE   3
 559 #define ISP_RUNSTATE    4
 560
 561 /*
 562  * ISP Configuration Options
 563  */
 564 #define ISP_CFG_NORELOAD        0x80    /* don't download f/w */
 565 #define ISP_CFG_NONVRAM         0x40    /* ignore NVRAM */
 566 #define ISP_CFG_TWOGB           0x20    /* force 2GB connection (23XX only) */
 567 #define ISP_CFG_ONEGB           0x10    /* force 1GB connection (23XX only) */
 568 #define ISP_CFG_FULL_DUPLEX     0x01    /* Full Duplex (Fibre Channel only) */
 569 #define ISP_CFG_PORT_PREF       0x0C    /* Mask for Port Prefs (2200 only) */
 570 #define ISP_CFG_LPORT           0x00    /* prefer {N/F}L-Port connection */
 571 #define ISP_CFG_NPORT           0x04    /* prefer {N/F}-Port connection */
 572 #define ISP_CFG_NPORT_ONLY      0x08    /* insist on {N/F}-Port connection */
 573 #define ISP_CFG_LPORT_ONLY      0x0C    /* insist on {N/F}L-Port connection */
 574 #define ISP_CFG_OWNWWPN         0x100   /* override NVRAM wwpn */
 575 #define ISP_CFG_OWNWWNN         0x200   /* override NVRAM wwnn */
 576 #define ISP_CFG_OWNFSZ          0x400   /* override NVRAM frame size */
 577 #define ISP_CFG_OWNLOOPID       0x800   /* override NVRAM loopid */
 578 #define ISP_CFG_OWNEXCTHROTTLE  0x1000  /* override NVRAM execution throttle */
 579 #define ISP_CFG_FOURGB          0x2000  /* force 4GB connection (24XX only) */
 580
 581 /*
 582  * Prior to calling isp_reset for the first time, the outer layer
 583  * should set isp_role to one of NONE, INITIATOR, TARGET, BOTH.
 584  *
 585  * If you set ISP_ROLE_NONE, the cards will be reset, new firmware loaded,
 586  * NVRAM read, and defaults set, but any further initialization (e.g.
 587  * INITIALIZE CONTROL BLOCK commands for 2X00 cards) won't be done.
 588  *
 589  * If INITIATOR MODE isn't set, attempts to run commands will be stopped
 590  * at isp_start and completed with the moral equivalent of SELECTION TIMEOUT.
 591  *
 592  * If TARGET MODE is set, it doesn't mean that the rest of target mode support
 593  * needs to be enabled, or will even work. What happens with the 2X00 cards
 594  * here is that if you have enabled it with TARGET MODE as part of the ICB
 595  * options, but you haven't given the f/w any ram resources for ATIOs or
 596  * Immediate Notifies, the f/w just handles what it can and you never see
 597  * anything. Basically, it sends a single byte of data (the first byte,
 598  * which you can set as part of the INITIALIZE CONTROL BLOCK command) for
 599  * INQUIRY, and sends back QUEUE FULL status for any other command.
 600  *
 601  */
 602 #define ISP_ROLE_NONE           0x0
 603 #define ISP_ROLE_TARGET         0x1
 604 #define ISP_ROLE_INITIATOR      0x2
 605 #define ISP_ROLE_BOTH           (ISP_ROLE_TARGET|ISP_ROLE_INITIATOR)
 606 #define ISP_ROLE_EITHER         ISP_ROLE_BOTH
 607 #ifndef ISP_DEFAULT_ROLES
 608 #define ISP_DEFAULT_ROLES       ISP_ROLE_INITIATOR
 609 #endif
 610
 611
 612 /*
 613  * Firmware related defines
 614  */
 615 #define ISP_CODE_ORG                    0x1000  /* default f/w code start */
 616 #define ISP_CODE_ORG_2300               0x0800  /* ..except for 2300s */
 617 #define ISP_CODE_ORG_2400               0x100000 /* ..and 2400s */
 618 #define ISP_FW_REV(maj, min, mic)       ((maj << 24) | (min << 16) | mic)
 619 #define ISP_FW_MAJOR(code)              ((code >> 24) & 0xff)
 620 #define ISP_FW_MINOR(code)              ((code >> 16) & 0xff)
 621 #define ISP_FW_MICRO(code)              ((code >>  8) & 0xff)
 622 #define ISP_FW_REVX(xp)                 ((xp[0]<<24) | (xp[1] << 16) | xp[2])
 623 #define ISP_FW_MAJORX(xp)               (xp[0])
 624 #define ISP_FW_MINORX(xp)               (xp[1])
 625 #define ISP_FW_MICROX(xp)               (xp[2])
 626 #define ISP_FW_NEWER_THAN(i, major, minor, micro)               \
 627  (ISP_FW_REVX((i)->isp_fwrev) > ISP_FW_REV(major, minor, micro))
 628 #define ISP_FW_OLDER_THAN(i, major, minor, micro)               \
 629  (ISP_FW_REVX((i)->isp_fwrev) < ISP_FW_REV(major, minor, micro))
 630
 631 /*
 632  * Bus (implementation) types
 633  */
 634 #define ISP_BT_PCI              0       /* PCI Implementations */
 635 #define ISP_BT_SBUS             1       /* SBus Implementations */
 636
 637 /*
 638  * If we have not otherwise defined SBus support away make sure
 639  * it is defined here such that the code is included as default
 640  */
 641 #ifndef ISP_SBUS_SUPPORTED
 642 #define ISP_SBUS_SUPPORTED      1
 643 #endif
 644
 645 /*
 646  * Chip Types
 647  */
 648 #define ISP_HA_SCSI             0xf
 649 #define ISP_HA_SCSI_UNKNOWN     0x1
 650 #define ISP_HA_SCSI_1020        0x2
 651 #define ISP_HA_SCSI_1020A       0x3
 652 #define ISP_HA_SCSI_1040        0x4
 653 #define ISP_HA_SCSI_1040A       0x5
 654 #define ISP_HA_SCSI_1040B       0x6
 655 #define ISP_HA_SCSI_1040C       0x7
 656 #define ISP_HA_SCSI_1240        0x8
 657 #define ISP_HA_SCSI_1080        0x9
 658 #define ISP_HA_SCSI_1280        0xa
 659 #define ISP_HA_SCSI_10160       0xb
 660 #define ISP_HA_SCSI_12160       0xc
 661 #define ISP_HA_FC               0xf0
 662 #define ISP_HA_FC_2100          0x10
 663 #define ISP_HA_FC_2200          0x20
 664 #define ISP_HA_FC_2300          0x30
 665 #define ISP_HA_FC_2312          0x40
 666 #define ISP_HA_FC_2322          0x50
 667 #define ISP_HA_FC_2400          0x60
 668
 669 #define IS_SCSI(isp)    (isp->isp_type & ISP_HA_SCSI)
 670 #define IS_1240(isp)    (isp->isp_type == ISP_HA_SCSI_1240)
 671 #define IS_1080(isp)    (isp->isp_type == ISP_HA_SCSI_1080)
 672 #define IS_1280(isp)    (isp->isp_type == ISP_HA_SCSI_1280)
 673 #define IS_10160(isp)   (isp->isp_type == ISP_HA_SCSI_10160)
 674 #define IS_12160(isp)   (isp->isp_type == ISP_HA_SCSI_12160)
 675
 676 #define IS_12X0(isp)    (IS_1240(isp) || IS_1280(isp))
 677 #define IS_1X160(isp)   (IS_10160(isp) || IS_12160(isp))
 678 #define IS_DUALBUS(isp) (IS_12X0(isp) || IS_12160(isp))
 679 #define IS_ULTRA2(isp)  (IS_1080(isp) || IS_1280(isp) || IS_1X160(isp))
 680 #define IS_ULTRA3(isp)  (IS_1X160(isp))
 681
 682 #define IS_FC(isp)      ((isp)->isp_type & ISP_HA_FC)
 683 #define IS_2100(isp)    ((isp)->isp_type == ISP_HA_FC_2100)
 684 #define IS_2200(isp)    ((isp)->isp_type == ISP_HA_FC_2200)
 685 #define IS_23XX(isp)    ((isp)->isp_type >= ISP_HA_FC_2300 && \
 686                                 (isp)->isp_type < ISP_HA_FC_2400)
 687 #define IS_2300(isp)    ((isp)->isp_type == ISP_HA_FC_2300)
 688 #define IS_2312(isp)    ((isp)->isp_type == ISP_HA_FC_2312)
 689 #define IS_2322(isp)    ((isp)->isp_type == ISP_HA_FC_2322)
 690 #define IS_24XX(isp)    ((isp)->isp_type >= ISP_HA_FC_2400)
 691
 692 /*
 693  * DMA related macros
 694  */
 695 #define DMA_WD3(x)      (((uint16_t)(((uint64_t)x) >> 48)) & 0xffff)
 696 #define DMA_WD2(x)      (((uint16_t)(((uint64_t)x) >> 32)) & 0xffff)
 697 #define DMA_WD1(x)      ((uint16_t)((x) >> 16) & 0xffff)
 698 #define DMA_WD0(x)      ((uint16_t)((x) & 0xffff))
 699
 700 #define DMA_LO32(x)     ((uint32_t) (x))
 701 #define DMA_HI32(x)     ((uint32_t)(((uint64_t)x) >> 32))
 702
 703 /*
 704  * Core System Function Prototypes
 705  */
 706
 707 /*
 708  * Reset Hardware. Totally. Assumes that you'll follow this with
 709  * a call to isp_init.
 710  */
 711 void isp_reset(ispsoftc_t *);
 712
 713 /*
 714  * Initialize Hardware to known state
 715  */
 716 void isp_init(ispsoftc_t *);
 717
 718 /*
 719  * Reset the ISP and call completion for any orphaned commands.
 720  */
 721 void isp_reinit(ispsoftc_t *);
 722
 723 #ifdef  ISP_FW_CRASH_DUMP
 724 /*
 725  * Dump firmware entry point.
 726  */
 727 void isp_fw_dump(ispsoftc_t *isp);
 728 #endif
 729
 730 /*
 731  * Internal Interrupt Service Routine
 732  *
 733  * The outer layers do the spade work to get the appropriate status register,
 734  * semaphore register and first mailbox register (if appropriate). This also
 735  * means that most spurious/bogus interrupts not for us can be filtered first.
 736  */
 737 void isp_intr(ispsoftc_t *, uint32_t, uint16_t, uint16_t);
 738
 739
 740 /*
 741  * Command Entry Point- Platform Dependent layers call into this
 742  */
 743 int isp_start(XS_T *);
 744
 745 /* these values are what isp_start returns */
 746 #define CMD_COMPLETE    101     /* command completed */
 747 #define CMD_EAGAIN      102     /* busy- maybe retry later */
 748 #define CMD_QUEUED      103     /* command has been queued for execution */
 749 #define CMD_RQLATER     104     /* requeue this command later */
 750
 751 /*
 752  * Command Completion Point- Core layers call out from this with completed cmds
 753  */
 754 void isp_done(XS_T *);
 755
 756 /*
 757  * Platform Dependent to External to Internal Control Function
 758  *
 759  * Assumes locks are held on entry. You should note that with many of
 760  * these commands and locks may be released while this is occurring.
 761  *
 762  * A few notes about some of these functions:
 763  *
 764  * ISPCTL_FCLINK_TEST tests to make sure we have good fibre channel link.
 765  * The argument is a pointer to an integer which is the time, in microseconds,
 766  * we should wait to see whether we have good link. This test, if successful,
 767  * lets us know our connection topology and our Loop ID/AL_PA and so on.
 768  * You can't get anywhere without this.
 769  *
 770  * ISPCTL_SCAN_FABRIC queries the name server (if we're on a fabric) for
 771  * all entities using the FC Generic Services subcommand GET ALL NEXT.
 772  * For each found entity, an ISPASYNC_FABRICDEV event is generated (see
 773  * below).
 774  *
 775  * ISPCTL_SCAN_LOOP does a local loop scan. This is only done if the connection
 776  * topology is NL or FL port (private or public loop). Since the Qlogic f/w
 777  * 'automatically' manages local loop connections, this function essentially
 778  * notes the arrival, departure, and possible shuffling around of local loop
 779  * entities. Thus for each arrival and departure this generates an isp_async
 780  * event of ISPASYNC_PROMENADE (see below).
 781  *
 782  * ISPCTL_PDB_SYNC is somewhat misnamed. It actually is the final step, in
 783  * order, of ISPCTL_FCLINK_TEST, ISPCTL_SCAN_FABRIC, and ISPCTL_SCAN_LOOP.
 784  * The main purpose of ISPCTL_PDB_SYNC is to complete management of logging
 785  * and logging out of fabric devices (if one is on a fabric) and then marking
 786  * the 'loop state' as being ready to now be used for sending commands to
 787  * devices. Originally fabric name server and local loop scanning were
 788  * part of this function. It's now been separated to allow for finer control.
 789  */
 790 typedef enum {
 791         ISPCTL_RESET_BUS,               /* Reset Bus */
 792         ISPCTL_RESET_DEV,               /* Reset Device */
 793         ISPCTL_ABORT_CMD,               /* Abort Command */
 794         ISPCTL_UPDATE_PARAMS,           /* Update Operating Parameters (SCSI) */
 795         ISPCTL_FCLINK_TEST,             /* Test FC Link Status */
 796         ISPCTL_SCAN_FABRIC,             /* (Re)scan Fabric Name Server */
 797         ISPCTL_SCAN_LOOP,               /* (Re)scan Local Loop */
 798         ISPCTL_PDB_SYNC,                /* Synchronize Port Database */
 799         ISPCTL_SEND_LIP,                /* Send a LIP */
 800         ISPCTL_GET_PORTNAME,            /* get portname from an N-port handle */
 801         ISPCTL_RUN_MBOXCMD,             /* run a mailbox command */
 802         ISPCTL_TOGGLE_TMODE,            /* toggle target mode */
 803         ISPCTL_GET_PDB,                 /* get a single port database entry */
 804         ISPCTL_PLOGX                    /* do a port login/logout */
 805 } ispctl_t;
 806 int isp_control(ispsoftc_t *, ispctl_t, void *);
 807
 808
 809 /*
 810  * Platform Dependent to Internal to External Control Function
 811  * (each platform must provide such a function)
 812  *
 813  * Assumes locks are held.
 814  *
 815  * A few notes about some of these functions:
 816  *
 817  * ISPASYNC_CHANGE_NOTIFY notifies the outer layer that a change has
 818  * occurred that invalidates the list of fabric devices known and/or
 819  * the list of known loop devices. The argument passed is a pointer
 820  * whose values are defined below  (local loop change, name server
 821  * change, other). 'Other' may simply be a LIP, or a change in
 822  * connection topology.
 823  *
 824  * ISPASYNC_FABRIC_DEV announces the next element in a list of
 825  * fabric device names we're getting out of the name server. The
 826  * argument points to a GET ALL NEXT response structure. The list
 827  * is known to terminate with an entry that refers to ourselves.
 828  * One of the main purposes of this function is to allow outer
 829  * layers, which are OS dependent, to set policy as to which fabric
 830  * devices might actually be logged into (and made visible) later
 831  * at ISPCTL_PDB_SYNC time. Since there's a finite number of fabric
 832  * devices that we can log into (256 less 3 'reserved' for F-port
 833  * topologies), and fabrics can grow up to 8 million or so entries
 834  * (24 bits of Port Address, less a wad of reserved spaces), clearly
 835  * we had better let the OS determine login policy.
 836  *
 837  * ISPASYNC_PROMENADE has an argument that is a pointer to an integer which
 838  * is an index into the portdb in the softc ('target'). Whether that entry's
 839  * valid tag is set or not says whether something has arrived or departed.
 840  * The name refers to a favorite pastime of many city dwellers- watching
 841  * people come and go, talking of Michaelangelo, and so on..
 842  *
 843  * ISPASYNC_UNHANDLED_RESPONSE gives outer layers a chance to parse a
 844  * response queue entry not otherwise handled. The outer layer should
 845  * return non-zero if it handled it. The 'arg' points to an unmassaged
 846  * response queue entry.
 847  */
 848
 849 typedef enum {
 850         ISPASYNC_NEW_TGT_PARAMS,        /* New Target Parameters Negotiated */
 851         ISPASYNC_BUS_RESET,             /* Bus Was Reset */
 852         ISPASYNC_LOOP_DOWN,             /* FC Loop Down */
 853         ISPASYNC_LOOP_UP,               /* FC Loop Up */
 854         ISPASYNC_LIP,                   /* LIP Received */
 855         ISPASYNC_LOOP_RESET,            /* Loop Reset Received */
 856         ISPASYNC_CHANGE_NOTIFY,         /* FC Change Notification */
 857         ISPASYNC_DEV_ARRIVED,           /* FC Device Arrival */
 858         ISPASYNC_DEV_CHANGED,           /* FC Device Change */
 859         ISPASYNC_DEV_STAYED,            /* FC Device Stayed the Same */
 860         ISPASYNC_DEV_GONE,              /* FC Device Depart */
 861         ISPASYNC_TARGET_NOTIFY,         /* target asynchronous notification event */
 862         ISPASYNC_TARGET_ACTION,         /* target action requested */
 863         ISPASYNC_CONF_CHANGE,           /* Platform Configuration Change */
 864         ISPASYNC_UNHANDLED_RESPONSE,    /* Unhandled Response Entry */
 865         ISPASYNC_FW_CRASH,              /* Firmware has crashed */
 866         ISPASYNC_FW_DUMPED,             /* Firmware crashdump taken */
 867         ISPASYNC_FW_RESTARTED           /* Firmware has been restarted */
 868 } ispasync_t;
 869 int isp_async(ispsoftc_t *, ispasync_t, void *);
 870
 871 #define ISPASYNC_CHANGE_PDB     ((void *) 0)
 872 #define ISPASYNC_CHANGE_SNS     ((void *) 1)
 873 #define ISPASYNC_CHANGE_OTHER   ((void *) 2)
 874
 875 /*
 876  * Platform Dependent Error and Debug Printout
 877  *
 878  * Generally this is:
 879  *
 880  *    void isp_prt(ispsoftc_t *, int level, const char *, ...)
 881  *
 882  * but due to compiler differences on different platforms this won't be
 883  * formally done here. Instead, it goes in each platform definition file.
 884  */
 885
 886 #define ISP_LOGALL      0x0     /* log always */
 887 #define ISP_LOGCONFIG   0x1     /* log configuration messages */
 888 #define ISP_LOGINFO     0x2     /* log informational messages */
 889 #define ISP_LOGWARN     0x4     /* log warning messages */
 890 #define ISP_LOGERR      0x8     /* log error messages */
 891 #define ISP_LOGDEBUG0   0x10    /* log simple debug messages */
 892 #define ISP_LOGDEBUG1   0x20    /* log intermediate debug messages */
 893 #define ISP_LOGDEBUG2   0x40    /* log most debug messages */
 894 #define ISP_LOGDEBUG3   0x80    /* log high frequency debug messages */
 895 #define ISP_LOGSANCFG   0x100   /* log SAN configuration */
 896 #define ISP_LOGTDEBUG0  0x200   /* log simple debug messages (target mode) */
 897 #define ISP_LOGTDEBUG1  0x400   /* log intermediate debug messages (target) */
 898 #define ISP_LOGTDEBUG2  0x800   /* log all debug messages (target) */
 899
 900 /*
 901  * Each Platform provides it's own isposinfo substructure of the ispsoftc
 902  * defined above.
 903  *
 904  * Each platform must also provide the following macros/defines:
 905  *
 906  *
 907  *      ISP2100_SCRLEN  -       length for the Fibre Channel scratch DMA area
 908  *
 909  *      MEMZERO(dst, src)                       platform zeroing function
 910  *      MEMCPY(dst, src, count)                 platform copying function
 911  *      SNPRINTF(buf, bufsize, fmt, ...)        snprintf
 912  *      USEC_DELAY(usecs)                       microsecond spindelay function
 913  *      USEC_SLEEP(isp, usecs)                  microsecond sleep function
 914  *
 915  *      NANOTIME_T                              nanosecond time type
 916  *
 917  *      GET_NANOTIME(NANOTIME_T *)              get current nanotime.
 918  *
 919  *      GET_NANOSEC(NANOTIME_T *)               get uint64_t from NANOTIME_T
 920  *
 921  *      NANOTIME_SUB(NANOTIME_T *, NANOTIME_T *)
 922  *                                              subtract two NANOTIME_T values
 923  *
 924  *
 925  *      MAXISPREQUEST(ispsoftc_t *)     maximum request queue size
 926  *                                              for this particular board type
 927  *
 928  *      MEMORYBARRIER(ispsoftc_t *, barrier_type, offset, size)
 929  *
 930  *              Function/Macro the provides memory synchronization on
 931  *              various objects so that the ISP's and the system's view
 932  *              of the same object is consistent.
 933  *
 934  *      MBOX_ACQUIRE(ispsoftc_t *)              acquire lock on mailbox regs
 935  *      MBOX_WAIT_COMPLETE(ispsoftc_t *, mbreg_t *) wait for cmd to be done
 936  *      MBOX_NOTIFY_COMPLETE(ispsoftc_t *)      notification of mbox cmd donee
 937  *      MBOX_RELEASE(ispsoftc_t *)              release lock on mailbox regs
 938  *
 939  *      FC_SCRATCH_ACQUIRE(ispsoftc_t *)        acquire lock on FC scratch area
 940  *      FC_SCRATCH_RELEASE(ispsoftc_t *)        acquire lock on FC scratch area
 941  *
 942  *      SCSI_GOOD       SCSI 'Good' Status
 943  *      SCSI_CHECK      SCSI 'Check Condition' Status
 944  *      SCSI_BUSY       SCSI 'Busy' Status
 945  *      SCSI_QFULL      SCSI 'Queue Full' Status
 946  *
 947  *      XS_T            Platform SCSI transaction type (i.e., command for HBA)
 948  *      XS_DMA_ADDR_T   Platform PCI DMA Address Type
 949  *      XS_ISP(xs)      gets an instance out of an XS_T
 950  *      XS_CHANNEL(xs)  gets the channel (bus # for DUALBUS cards) ""
 951  *      XS_TGT(xs)      gets the target ""
 952  *      XS_LUN(xs)      gets the lun ""
 953  *      XS_CDBP(xs)     gets a pointer to the scsi CDB ""
 954  *      XS_CDBLEN(xs)   gets the CDB's length ""
 955  *      XS_XFRLEN(xs)   gets the associated data transfer length ""
 956  *      XS_TIME(xs)     gets the time (in milliseconds) for this command
 957  *      XS_RESID(xs)    gets the current residual count
 958  *      XS_STSP(xs)     gets a pointer to the SCSI status byte ""
 959  *      XS_SNSP(xs)     gets a pointer to the associate sense data
 960  *      XS_SNSLEN(xs)   gets the length of sense data storage
 961  *      XS_SNSKEY(xs)   dereferences XS_SNSP to get the current stored Sense Key
 962  *      XS_TAG_P(xs)    predicate of whether this command should be tagged
 963  *      XS_TAG_TYPE(xs) which type of tag to use
 964  *      XS_SETERR(xs)   set error state
 965  *
 966  *              HBA_NOERROR     command has no erros
 967  *              HBA_BOTCH       hba botched something
 968  *              HBA_CMDTIMEOUT  command timed out
 969  *              HBA_SELTIMEOUT  selection timed out (also port logouts for FC)
 970  *              HBA_TGTBSY      target returned a BUSY status
 971  *              HBA_BUSRESET    bus reset destroyed command
 972  *              HBA_ABORTED     command was aborted (by request)
 973  *              HBA_DATAOVR     a data overrun was detected
 974  *              HBA_ARQFAIL     Automatic Request Sense failed
 975  *
 976  *      XS_ERR(xs)      return current error state
 977  *      XS_NOERR(xs)    there is no error currently set
 978  *      XS_INITERR(xs)  initialize error state
 979  *
 980  *      XS_SAVE_SENSE(xs, sp, len)      save sense data
 981  *
 982  *      XS_SET_STATE_STAT(isp, sp, xs)  platform dependent interpreter of
 983  *                                      response queue entry status bits
 984  *
 985  *
 986  *      DEFAULT_IID(ispsoftc_t *)               Default SCSI initiator ID
 987  *      DEFAULT_LOOPID(ispsoftc_t *)            Default FC Loop ID
 988  *      DEFAULT_NODEWWN(ispsoftc_t *)           Default Node WWN
 989  *      DEFAULT_PORTWWN(ispsoftc_t *)           Default Port WWN
 990  *      DEFAULT_FRAMESIZE(ispsoftc_t *)         Default Frame Size
 991  *      DEFAULT_EXEC_THROTTLE(ispsoftc_t *) Default Execution Throttle
 992  *              These establish reasonable defaults for each platform.
 993  *              These must be available independent of card NVRAM and are
 994  *              to be used should NVRAM not be readable.
 995  *
 996  *      ISP_NODEWWN(ispsoftc_t *)               FC Node WWN to use
 997  *      ISP_PORTWWN(ispsoftc_t *)               FC Port WWN to use
 998  *
 999  *              These are to be used after NVRAM is read. The tags
1000  *              in fcparam.isp_ww{n,p}n_nvram reflect the values
1001  *              read from NVRAM (possibly corrected for card botches).
1002  *              Each platform can take that information and override
1003  *              it or ignore and return the Node and Port WWNs to be
1004  *              used when sending the Qlogic f/w the Initialization
1005  *              Control Block.
1006  *
1007  *      (XXX these do endian specific transformations- in transition XXX)
1008  *
1009  *      ISP_IOXPUT_8(ispsoftc_t *, uint8_t srcval, uint8_t *dstptr)
1010  *      ISP_IOXPUT_16(ispsoftc_t *, uint16_t srcval, uint16_t *dstptr)
1011  *      ISP_IOXPUT_32(ispsoftc_t *, uint32_t srcval, uint32_t *dstptr)
1012  *
1013  *      ISP_IOXGET_8(ispsoftc_t *, uint8_t *srcptr, uint8_t dstrval)
1014  *      ISP_IOXGET_16(ispsoftc_t *, uint16_t *srcptr, uint16_t dstrval)
1015  *      ISP_IOXGET_32(ispsoftc_t *, uint32_t *srcptr, uint32_t dstrval)
1016  *
1017  *      ISP_SWIZZLE_NVRAM_WORD(ispsoftc_t *, uint16_t *)
1018  *      ISP_SWIZZLE_NVRAM_LONG(ispsoftc_t *, uint32_t *)
1019  *      ISP_SWAP16(ispsoftc_t *, uint16_t srcval)
1020  *      ISP_SWAP32(ispsoftc_t *, uint32_t srcval)
1021  */
1022
1023 #endif  /* _ISPVAR_H */