sys/dev/isp/ispvar.h

   1 /* $FreeBSD$ */
   2 /*-
   3  *  Copyright (c) 1997-2009 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 /*
  30  * Soft Definitions for for Qlogic ISP SCSI adapters.
  31  */
  32
  33 #ifndef _ISPVAR_H
  34 #define _ISPVAR_H
  35
  36 #if defined(__NetBSD__) || defined(__OpenBSD__)
  37 #include <dev/ic/isp_stds.h>
  38 #include <dev/ic/ispmbox.h>
  39 #endif
  40 #ifdef  __FreeBSD__
  41 #include <dev/isp/isp_stds.h>
  42 #include <dev/isp/ispmbox.h>
  43 #endif
  44 #ifdef  __linux__
  45 #include "isp_stds.h"
  46 #include "ispmbox.h"
  47 #endif
  48 #ifdef  __svr4__
  49 #include "isp_stds.h"
  50 #include "ispmbox.h"
  51 #endif
  52
  53 #define ISP_CORE_VERSION_MAJOR  6
  54 #define ISP_CORE_VERSION_MINOR  0
  55
  56 /*
  57  * Vector for bus specific code to provide specific services.
  58  */
  59 typedef struct ispsoftc ispsoftc_t;
  60 struct ispmdvec {
  61         int             (*dv_rd_isr) (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) (ispsoftc_t *, XS_T *, void *);
  66         void            (*dv_dmaclr) (ispsoftc_t *, XS_T *, uint32_t);
  67         void            (*dv_reset0) (ispsoftc_t *);
  68         void            (*dv_reset1) (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             512
  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
  85 /*
  86  * Macros to access ISP registers through bus specific layers-
  87  * mostly wrappers to vector through the mdvec structure.
  88  */
  89 #define ISP_READ_ISR(isp, isrp, semap, mbox0p)  \
  90         (*(isp)->isp_mdvec->dv_rd_isr)(isp, isrp, semap, mbox0p)
  91
  92 #define ISP_READ(isp, reg)      \
  93         (*(isp)->isp_mdvec->dv_rd_reg)((isp), (reg))
  94
  95 #define ISP_WRITE(isp, reg, val)        \
  96         (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), (val))
  97
  98 #define ISP_MBOXDMASETUP(isp)   \
  99         (*(isp)->isp_mdvec->dv_mbxdma)((isp))
 100
 101 #define ISP_DMASETUP(isp, xs, req)      \
 102         (*(isp)->isp_mdvec->dv_dmaset)((isp), (xs), (req))
 103
 104 #define ISP_DMAFREE(isp, xs, hndl)              \
 105         if ((isp)->isp_mdvec->dv_dmaclr)        \
 106             (*(isp)->isp_mdvec->dv_dmaclr)((isp), (xs), (hndl))
 107
 108 #define ISP_RESET0(isp) \
 109         if ((isp)->isp_mdvec->dv_reset0) (*(isp)->isp_mdvec->dv_reset0)((isp))
 110 #define ISP_RESET1(isp) \
 111         if ((isp)->isp_mdvec->dv_reset1) (*(isp)->isp_mdvec->dv_reset1)((isp))
 112 #define ISP_DUMPREGS(isp, m)    \
 113         if ((isp)->isp_mdvec->dv_dregs) (*(isp)->isp_mdvec->dv_dregs)((isp),(m))
 114
 115 #define ISP_SETBITS(isp, reg, val)      \
 116  (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) | (val))
 117
 118 #define ISP_CLRBITS(isp, reg, val)      \
 119  (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) & ~(val))
 120
 121 /*
 122  * The MEMORYBARRIER macro is defined per platform (to provide synchronization
 123  * on Request and Response Queues, Scratch DMA areas, and Registers)
 124  *
 125  * Defined Memory Barrier Synchronization Types
 126  */
 127 #define SYNC_REQUEST    0       /* request queue synchronization */
 128 #define SYNC_RESULT     1       /* result queue synchronization */
 129 #define SYNC_SFORDEV    2       /* scratch, sync for ISP */
 130 #define SYNC_SFORCPU    3       /* scratch, sync for CPU */
 131 #define SYNC_REG        4       /* for registers */
 132 #define SYNC_ATIOQ      5       /* atio result queue (24xx) */
 133
 134 /*
 135  * Request/Response Queue defines and macros.
 136  * The maximum is defined per platform (and can be based on board type).
 137  */
 138 /* This is the size of a queue entry (request and response) */
 139 #define QENTRY_LEN                      64
 140 /* Both request and result queue length must be a power of two */
 141 #define RQUEST_QUEUE_LEN(x)             MAXISPREQUEST(x)
 142 #ifdef  ISP_TARGET_MODE
 143 #define RESULT_QUEUE_LEN(x)             MAXISPREQUEST(x)
 144 #else
 145 #define RESULT_QUEUE_LEN(x)             \
 146         (((MAXISPREQUEST(x) >> 2) < 64)? 64 : MAXISPREQUEST(x) >> 2)
 147 #endif
 148 #define ISP_QUEUE_ENTRY(q, idx)         (((uint8_t *)q) + ((idx) * QENTRY_LEN))
 149 #define ISP_QUEUE_SIZE(n)               ((n) * QENTRY_LEN)
 150 #define ISP_NXT_QENTRY(idx, qlen)       (((idx) + 1) & ((qlen)-1))
 151 #define ISP_QFREE(in, out, qlen)        \
 152         ((in == out)? (qlen - 1) : ((in > out)? \
 153         ((qlen - 1) - (in - out)) : (out - in - 1)))
 154 #define ISP_QAVAIL(isp) \
 155         ISP_QFREE(isp->isp_reqidx, isp->isp_reqodx, RQUEST_QUEUE_LEN(isp))
 156
 157 #define ISP_ADD_REQUEST(isp, nxti)                                      \
 158         MEMORYBARRIER(isp, SYNC_REQUEST, isp->isp_reqidx, QENTRY_LEN);  \
 159         ISP_WRITE(isp, isp->isp_rqstinrp, nxti);                        \
 160         isp->isp_reqidx = nxti
 161
 162 #define ISP_SYNC_REQUEST(isp)                                                           \
 163         MEMORYBARRIER(isp, SYNC_REQUEST, isp->isp_reqidx, QENTRY_LEN);                  \
 164         isp->isp_reqidx = ISP_NXT_QENTRY(isp->isp_reqidx, RQUEST_QUEUE_LEN(isp));       \
 165         ISP_WRITE(isp, isp->isp_rqstinrp, isp->isp_reqidx)
 166
 167 /*
 168  * SCSI Specific Host Adapter Parameters- per bus, per target
 169  */
 170 typedef struct {
 171         uint32_t                                : 8,
 172                         update                  : 1,
 173                         sendmarker              : 1,
 174                         role                    : 2,
 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 /* Use this handle for the base for multi-id firmware SNS logins */
 248 #define NPH_SNS_HDLBASE         0x400
 249
 250 /* These are for 2K Login Firmware cards */
 251 #define NPH_RESERVED            0x7F0   /* begin of reserved N-port handles */
 252 #define NPH_MGT_ID              0x7FA   /* Management Server Special ID */
 253 #define NPH_SNS_ID              0x7FC   /* SNS Server Special ID */
 254 #define NPH_FABRIC_CTLR         0x7FD   /* Fabric Controller (0xFFFFFD) */
 255 #define NPH_FL_ID               0x7FE   /* F Port Special ID (0xFFFFFE) */
 256 #define NPH_IP_BCST             0x7ff   /* IP Broadcast Special ID (0xFFFFFF) */
 257 #define NPH_MAX_2K              0x800
 258
 259 /*
 260  * "Unassigned" handle to be used internally
 261  */
 262 #define NIL_HANDLE              0xffff
 263
 264 /*
 265  * Limit for devices on an arbitrated loop.
 266  */
 267 #define LOCAL_LOOP_LIM          126
 268
 269 /*
 270  * Limit for (2K login) N-port handle amounts
 271  */
 272 #define MAX_NPORT_HANDLE        2048
 273
 274 /*
 275  * Special Constants
 276  */
 277 #define INI_NONE                ((uint64_t) 0)
 278 #define ISP_NOCHAN              0xff
 279
 280 /*
 281  * Special Port IDs
 282  */
 283 #define MANAGEMENT_PORT_ID      0xFFFFFA
 284 #define SNS_PORT_ID             0xFFFFFC
 285 #define FABRIC_PORT_ID          0xFFFFFE
 286 #define PORT_ANY                0xFFFFFF
 287 #define PORT_NONE               0
 288 #define DOMAIN_CONTROLLER_BASE  0xFFFC00
 289 #define DOMAIN_CONTROLLER_END   0xFFFCFF
 290
 291
 292 /*
 293  * FC Port Database entry.
 294  *
 295  * It has a handle that the f/w uses to address commands to a device.
 296  * This handle's value may be assigned by the firmware (e.g., for local loop
 297  * devices) or by the driver (e.g., for fabric devices).
 298  *
 299  * It has a state. If the state if VALID, that means that we've logged into
 300  * the device. We also *may* have a initiator map index entry. This is a value
 301  * from 0..MAX_FC_TARG that is used to index into the isp_dev_map array. If
 302  * the value therein is non-zero, then that value minus one is used to index
 303  * into the Port Database to find the handle for forming commands. There is
 304  * back-index minus one value within to Port Database entry that tells us
 305  * which entry in isp_dev_map points to us (to avoid searching).
 306  *
 307  * Local loop devices the firmware automatically performs PLOGI on for us
 308  * (which is why that handle is imposed upon us). Fabric devices we assign
 309  * a handle to and perform the PLOGI on.
 310  *
 311  * When a PORT DATABASE CHANGED asynchronous event occurs, we mark all VALID
 312  * entries as PROBATIONAL. This allows us, if policy says to, just keep track
 313  * of devices whose handles change but are otherwise the same device (and
 314  * thus keep 'target' constant).
 315  *
 316  * In any case, we search all possible local loop handles. For each one that
 317  * has a port database entity returned, we search for any PROBATIONAL entry
 318  * that matches it and update as appropriate. Otherwise, as a new entry, we
 319  * find room for it in the Port Database. We *try* and use the handle as the
 320  * index to put it into the Database, but that's just an optimization. We mark
 321  * the entry VALID and make sure that the target index is updated and correct.
 322  *
 323  * When we get done searching the local loop, we then search similarily for
 324  * a list of devices we've gotten from the fabric name controller (if we're
 325  * on a fabric). VALID marking is also done similarily.
 326  *
 327  * When all of this is done, we can march through the database and clean up
 328  * any entry that is still PROBATIONAL (these represent devices which have
 329  * departed). Then we're done and can resume normal operations.
 330  *
 331  * Negative invariants that we try and test for are:
 332  *
 333  *  + There can never be two non-NIL entries with the same { Port, Node } WWN
 334  *    duples.
 335  *
 336  *  + There can never be two non-NIL entries with the same handle.
 337  *
 338  *  + There can never be two non-NIL entries which have the same dev_map_idx
 339  *    value.
 340  */
 341 typedef struct {
 342         /*
 343          * This is the handle that the firmware needs in order for us to
 344          * send commands to the device. For pre-24XX cards, this would be
 345          * the 'loopid'.
 346          */
 347         uint16_t        handle;
 348
 349         /*
 350          * The dev_map_idx, if nonzero, is the system virtual target ID (+1)
 351          * as a cross-reference with the isp_dev_map.
 352          *
 353          * A device is 'autologin' if the firmware automatically logs into
 354          * it (re-logins as needed). Basically, local private loop devices.
 355          *
 356          * The state is the current state of this entry.
 357          *
 358          * Role is Initiator, Target, Both
 359          *
 360          * Portid is obvious, as are node && port WWNs. The new_role and
 361          * new_portid is for when we are pending a change.
 362          *
 363          * The 'target_mode' tag means that this entry arrived via a
 364          * target mode command and is immune from normal flushing rules.
 365          * You should also never see anything with an initiator role
 366          * with this set.
 367          */
 368         uint16_t        dev_map_idx     : 12,
 369                         autologin       : 1,    /* F/W does PLOGI/PLOGO */
 370                         state           : 3;
 371         uint32_t        reserved        : 5,
 372                         target_mode     : 1,
 373                         roles           : 2,
 374                         portid          : 24;
 375         uint32_t
 376                         dirty           : 1,    /* commands have been run */
 377                         new_reserved    : 5,
 378                         new_roles       : 2,
 379                         new_portid      : 24;
 380         uint64_t        node_wwn;
 381         uint64_t        port_wwn;
 382 } fcportdb_t;
 383
 384 #define FC_PORTDB_STATE_NIL             0
 385 #define FC_PORTDB_STATE_PROBATIONAL     1
 386 #define FC_PORTDB_STATE_DEAD            2
 387 #define FC_PORTDB_STATE_CHANGED         3
 388 #define FC_PORTDB_STATE_NEW             4
 389 #define FC_PORTDB_STATE_PENDING_VALID   5
 390 #define FC_PORTDB_STATE_ZOMBIE          6
 391 #define FC_PORTDB_STATE_VALID           7
 392
 393 /*
 394  * FC card specific information
 395  *
 396  * This structure is replicated across multiple channels for multi-id
 397  * capapble chipsets, with some entities different on a per-channel basis.
 398  */
 399
 400 typedef struct {
 401         uint32_t
 402                                 link_active     : 1,
 403                                 npiv_fabric     : 1,
 404                                 inorder         : 1,
 405                                 sendmarker      : 1,
 406                                 role            : 2,
 407                                 isp_gbspeed     : 4,
 408                                 isp_loopstate   : 4,    /* Current Loop State */
 409                                 isp_fwstate     : 4,    /* ISP F/W state */
 410                                 isp_topo        : 3,    /* Connection Type */
 411                                 loop_seen_once  : 1;
 412
 413         uint32_t                                : 8,
 414                                 isp_portid      : 24;   /* S_ID */
 415
 416
 417         uint16_t                isp_fwoptions;
 418         uint16_t                isp_xfwoptions;
 419         uint16_t                isp_zfwoptions;
 420         uint16_t                isp_loopid;             /* hard loop id */
 421         uint16_t                isp_sns_hdl;            /* N-port handle for SNS */
 422         uint16_t                isp_lasthdl;            /* only valid for channel 0 */
 423         uint16_t                isp_maxalloc;
 424         uint8_t                 isp_retry_delay;
 425         uint8_t                 isp_retry_count;
 426
 427         /*
 428          * Current active WWNN/WWPN
 429          */
 430         uint64_t                isp_wwnn;
 431         uint64_t                isp_wwpn;
 432
 433         /*
 434          * NVRAM WWNN/WWPN
 435          */
 436         uint64_t                isp_wwnn_nvram;
 437         uint64_t                isp_wwpn_nvram;
 438
 439         /*
 440          * Our Port Data Base
 441          */
 442         fcportdb_t              portdb[MAX_FC_TARG];
 443
 444         /*
 445          * This maps system virtual 'target' id to a portdb entry.
 446          *
 447          * The mapping function is to take any non-zero entry and
 448          * subtract one to get the portdb index. This means that
 449          * entries which are zero are unmapped (i.e., don't exist).
 450          */
 451         uint16_t                isp_dev_map[MAX_FC_TARG];
 452
 453 #ifdef  ISP_TARGET_MODE
 454         /*
 455          * This maps N-Port Handle to portdb entry so we
 456          * don't have to search for every incoming command.
 457          *
 458          * The mapping function is to take any non-zero entry and
 459          * subtract one to get the portdb index. This means that
 460          * entries which are zero are unmapped (i.e., don't exist).
 461          */
 462         uint16_t                isp_tgt_map[MAX_NPORT_HANDLE];
 463 #endif
 464
 465         /*
 466          * Scratch DMA mapped in area to fetch Port Database stuff, etc.
 467          */
 468         void *                  isp_scratch;
 469         XS_DMA_ADDR_T           isp_scdma;
 470 } fcparam;
 471
 472 #define FW_CONFIG_WAIT          0
 473 #define FW_WAIT_AL_PA           1
 474 #define FW_WAIT_LOGIN           2
 475 #define FW_READY                3
 476 #define FW_LOSS_OF_SYNC         4
 477 #define FW_ERROR                5
 478 #define FW_REINIT               6
 479 #define FW_NON_PART             7
 480
 481 #define LOOP_NIL                0
 482 #define LOOP_LIP_RCVD           1
 483 #define LOOP_PDB_RCVD           2
 484 #define LOOP_SCANNING_LOOP      3
 485 #define LOOP_LSCAN_DONE         4
 486 #define LOOP_SCANNING_FABRIC    5
 487 #define LOOP_FSCAN_DONE         6
 488 #define LOOP_SYNCING_PDB        7
 489 #define LOOP_READY              8
 490
 491 #define TOPO_NL_PORT            0
 492 #define TOPO_FL_PORT            1
 493 #define TOPO_N_PORT             2
 494 #define TOPO_F_PORT             3
 495 #define TOPO_PTP_STUB           4
 496
 497 /*
 498  * Soft Structure per host adapter
 499  */
 500 struct ispsoftc {
 501         /*
 502          * Platform (OS) specific data
 503          */
 504         struct isposinfo        isp_osinfo;
 505
 506         /*
 507          * Pointer to bus specific functions and data
 508          */
 509         struct ispmdvec *       isp_mdvec;
 510
 511         /*
 512          * (Mostly) nonvolatile state. Board specific parameters
 513          * may contain some volatile state (e.g., current loop state).
 514          */
 515
 516         void *                  isp_param;      /* type specific */
 517         uint16_t                isp_fwrev[3];   /* Loaded F/W revision */
 518         uint16_t                isp_maxcmds;    /* max possible I/O cmds */
 519         uint8_t                 isp_type;       /* HBA Chip Type */
 520         uint8_t                 isp_revision;   /* HBA Chip H/W Revision */
 521         uint32_t                isp_maxluns;    /* maximum luns supported */
 522
 523         uint32_t                isp_clock       : 8,    /* input clock */
 524                                                 : 4,
 525                                 isp_port        : 1,    /* 23XX/24XX only */
 526                                 isp_open        : 1,    /* opened (ioctl) */
 527                                 isp_bustype     : 1,    /* SBus or PCI */
 528                                 isp_loaded_fw   : 1,    /* loaded firmware */
 529                                 isp_dblev       : 16;   /* debug log mask */
 530
 531         uint16_t                isp_fwattr;     /* firmware attributes */
 532         uint16_t                isp_nchan;      /* number of channels */
 533
 534         uint32_t                isp_confopts;   /* config options */
 535
 536         uint32_t                isp_rqstinrp;   /* register for REQINP */
 537         uint32_t                isp_rqstoutrp;  /* register for REQOUTP */
 538         uint32_t                isp_respinrp;   /* register for RESINP */
 539         uint32_t                isp_respoutrp;  /* register for RESOUTP */
 540
 541         /*
 542          * Instrumentation
 543          */
 544         uint64_t                isp_intcnt;             /* total int count */
 545         uint64_t                isp_intbogus;           /* spurious int count */
 546         uint64_t                isp_intmboxc;           /* mbox completions */
 547         uint64_t                isp_intoasync;          /* other async */
 548         uint64_t                isp_rsltccmplt;         /* CMDs on result q */
 549         uint64_t                isp_fphccmplt;          /* CMDs via fastpost */
 550         uint16_t                isp_rscchiwater;
 551         uint16_t                isp_fpcchiwater;
 552         NANOTIME_T              isp_init_time;          /* time were last initialized */
 553
 554         /*
 555          * Volatile state
 556          */
 557
 558         volatile uint32_t       :       8,
 559                                 :       2,
 560                 isp_dead        :       1,
 561                                 :       1,
 562                 isp_mboxbsy     :       1,      /* mailbox command active */
 563                 isp_state       :       3,
 564                 isp_nactive     :       16;     /* how many commands active */
 565         volatile uint32_t       isp_reqodx;     /* index of last ISP pickup */
 566         volatile uint32_t       isp_reqidx;     /* index of next request */
 567         volatile uint32_t       isp_residx;     /* index of next result */
 568         volatile uint32_t       isp_resodx;     /* index of next result */
 569         volatile uint32_t       isp_lasthdls;   /* last handle seed */
 570         volatile uint32_t       isp_obits;      /* mailbox command output */
 571         volatile uint32_t       isp_serno;      /* rolling serial number */
 572         volatile uint16_t       isp_mboxtmp[MAILBOX_STORAGE];
 573         volatile uint16_t       isp_lastmbxcmd; /* last mbox command sent */
 574         volatile uint16_t       isp_mbxwrk0;
 575         volatile uint16_t       isp_mbxwrk1;
 576         volatile uint16_t       isp_mbxwrk2;
 577         volatile uint16_t       isp_mbxwrk8;
 578         void *                  isp_mbxworkp;
 579
 580         /*
 581          * Active commands are stored here, indexed by handle functions.
 582          */
 583         XS_T **isp_xflist;
 584
 585 #ifdef  ISP_TARGET_MODE
 586         /*
 587          * Active target commands are stored here, indexed by handle functions.
 588          */
 589         void **isp_tgtlist;
 590 #endif
 591
 592         /*
 593          * request/result queue pointers and DMA handles for them.
 594          */
 595         void *                  isp_rquest;
 596         void *                  isp_result;
 597         XS_DMA_ADDR_T           isp_rquest_dma;
 598         XS_DMA_ADDR_T           isp_result_dma;
 599 #ifdef  ISP_TARGET_MODE
 600         /* for 24XX only */
 601         void *                  isp_atioq;
 602         XS_DMA_ADDR_T           isp_atioq_dma;
 603 #endif
 604 };
 605
 606 #define SDPARAM(isp, chan)      (&((sdparam *)(isp)->isp_param)[(chan)])
 607 #define FCPARAM(isp, chan)      (&((fcparam *)(isp)->isp_param)[(chan)])
 608
 609 #define ISP_SET_SENDMARKER(isp, chan, val)      \
 610     if (IS_FC(isp)) {                           \
 611         FCPARAM(isp, chan)->sendmarker = val;   \
 612     } else {                                    \
 613         SDPARAM(isp, chan)->sendmarker = val;   \
 614     }
 615
 616 #define ISP_TST_SENDMARKER(isp, chan)           \
 617     (IS_FC(isp)?                                \
 618         FCPARAM(isp, chan)->sendmarker != 0 :   \
 619         SDPARAM(isp, chan)->sendmarker != 0)
 620
 621 /*
 622  * ISP Driver Run States
 623  */
 624 #define ISP_NILSTATE    0
 625 #define ISP_CRASHED     1
 626 #define ISP_RESETSTATE  2
 627 #define ISP_INITSTATE   3
 628 #define ISP_RUNSTATE    4
 629
 630 /*
 631  * ISP Configuration Options
 632  */
 633 #define ISP_CFG_NORELOAD        0x80    /* don't download f/w */
 634 #define ISP_CFG_NONVRAM         0x40    /* ignore NVRAM */
 635 #define ISP_CFG_TWOGB           0x20    /* force 2GB connection (23XX only) */
 636 #define ISP_CFG_ONEGB           0x10    /* force 1GB connection (23XX only) */
 637 #define ISP_CFG_FULL_DUPLEX     0x01    /* Full Duplex (Fibre Channel only) */
 638 #define ISP_CFG_PORT_PREF       0x0C    /* Mask for Port Prefs (2200 only) */
 639 #define ISP_CFG_LPORT           0x00    /* prefer {N/F}L-Port connection */
 640 #define ISP_CFG_NPORT           0x04    /* prefer {N/F}-Port connection */
 641 #define ISP_CFG_NPORT_ONLY      0x08    /* insist on {N/F}-Port connection */
 642 #define ISP_CFG_LPORT_ONLY      0x0C    /* insist on {N/F}L-Port connection */
 643 #define ISP_CFG_OWNFSZ          0x400   /* override NVRAM frame size */
 644 #define ISP_CFG_OWNLOOPID       0x800   /* override NVRAM loopid */
 645 #define ISP_CFG_OWNEXCTHROTTLE  0x1000  /* override NVRAM execution throttle */
 646 #define ISP_CFG_FOURGB          0x2000  /* force 4GB connection (24XX only) */
 647
 648 /*
 649  * For each channel, the outer layers should know what role that channel
 650  * will take: ISP_ROLE_NONE, ISP_ROLE_INITIATOR, ISP_ROLE_TARGET,
 651  * ISP_ROLE_BOTH.
 652  *
 653  * If you set ISP_ROLE_NONE, the cards will be reset, new firmware loaded,
 654  * NVRAM read, and defaults set, but any further initialization (e.g.
 655  * INITIALIZE CONTROL BLOCK commands for 2X00 cards) won't be done.
 656  *
 657  * If INITIATOR MODE isn't set, attempts to run commands will be stopped
 658  * at isp_start and completed with the equivalent of SELECTION TIMEOUT.
 659  *
 660  * If TARGET MODE is set, it doesn't mean that the rest of target mode support
 661  * needs to be enabled, or will even work. What happens with the 2X00 cards
 662  * here is that if you have enabled it with TARGET MODE as part of the ICB
 663  * options, but you haven't given the f/w any ram resources for ATIOs or
 664  * Immediate Notifies, the f/w just handles what it can and you never see
 665  * anything. Basically, it sends a single byte of data (the first byte,
 666  * which you can set as part of the INITIALIZE CONTROL BLOCK command) for
 667  * INQUIRY, and sends back QUEUE FULL status for any other command.
 668  *
 669  */
 670 #define ISP_ROLE_NONE           0x0
 671 #define ISP_ROLE_TARGET         0x1
 672 #define ISP_ROLE_INITIATOR      0x2
 673 #define ISP_ROLE_BOTH           (ISP_ROLE_TARGET|ISP_ROLE_INITIATOR)
 674 #define ISP_ROLE_EITHER         ISP_ROLE_BOTH
 675 #ifndef ISP_DEFAULT_ROLES
 676 #define ISP_DEFAULT_ROLES       ISP_ROLE_INITIATOR
 677 #endif
 678
 679
 680 /*
 681  * Firmware related defines
 682  */
 683 #define ISP_CODE_ORG                    0x1000  /* default f/w code start */
 684 #define ISP_CODE_ORG_2300               0x0800  /* ..except for 2300s */
 685 #define ISP_CODE_ORG_2400               0x100000 /* ..and 2400s */
 686 #define ISP_FW_REV(maj, min, mic)       ((maj << 24) | (min << 16) | mic)
 687 #define ISP_FW_MAJOR(code)              ((code >> 24) & 0xff)
 688 #define ISP_FW_MINOR(code)              ((code >> 16) & 0xff)
 689 #define ISP_FW_MICRO(code)              ((code >>  8) & 0xff)
 690 #define ISP_FW_REVX(xp)                 ((xp[0]<<24) | (xp[1] << 16) | xp[2])
 691 #define ISP_FW_MAJORX(xp)               (xp[0])
 692 #define ISP_FW_MINORX(xp)               (xp[1])
 693 #define ISP_FW_MICROX(xp)               (xp[2])
 694 #define ISP_FW_NEWER_THAN(i, major, minor, micro)               \
 695  (ISP_FW_REVX((i)->isp_fwrev) > ISP_FW_REV(major, minor, micro))
 696 #define ISP_FW_OLDER_THAN(i, major, minor, micro)               \
 697  (ISP_FW_REVX((i)->isp_fwrev) < ISP_FW_REV(major, minor, micro))
 698
 699 /*
 700  * Bus (implementation) types
 701  */
 702 #define ISP_BT_PCI              0       /* PCI Implementations */
 703 #define ISP_BT_SBUS             1       /* SBus Implementations */
 704
 705 /*
 706  * If we have not otherwise defined SBus support away make sure
 707  * it is defined here such that the code is included as default
 708  */
 709 #ifndef ISP_SBUS_SUPPORTED
 710 #define ISP_SBUS_SUPPORTED      1
 711 #endif
 712
 713 /*
 714  * Chip Types
 715  */
 716 #define ISP_HA_SCSI             0xf
 717 #define ISP_HA_SCSI_UNKNOWN     0x1
 718 #define ISP_HA_SCSI_1020        0x2
 719 #define ISP_HA_SCSI_1020A       0x3
 720 #define ISP_HA_SCSI_1040        0x4
 721 #define ISP_HA_SCSI_1040A       0x5
 722 #define ISP_HA_SCSI_1040B       0x6
 723 #define ISP_HA_SCSI_1040C       0x7
 724 #define ISP_HA_SCSI_1240        0x8
 725 #define ISP_HA_SCSI_1080        0x9
 726 #define ISP_HA_SCSI_1280        0xa
 727 #define ISP_HA_SCSI_10160       0xb
 728 #define ISP_HA_SCSI_12160       0xc
 729 #define ISP_HA_FC               0xf0
 730 #define ISP_HA_FC_2100          0x10
 731 #define ISP_HA_FC_2200          0x20
 732 #define ISP_HA_FC_2300          0x30
 733 #define ISP_HA_FC_2312          0x40
 734 #define ISP_HA_FC_2322          0x50
 735 #define ISP_HA_FC_2400          0x60
 736 #define ISP_HA_FC_2500          0x70
 737
 738 #define IS_SCSI(isp)    (isp->isp_type & ISP_HA_SCSI)
 739 #define IS_1020(isp)    (isp->isp_type < ISP_HA_SCSI_1240)
 740 #define IS_1240(isp)    (isp->isp_type == ISP_HA_SCSI_1240)
 741 #define IS_1080(isp)    (isp->isp_type == ISP_HA_SCSI_1080)
 742 #define IS_1280(isp)    (isp->isp_type == ISP_HA_SCSI_1280)
 743 #define IS_10160(isp)   (isp->isp_type == ISP_HA_SCSI_10160)
 744 #define IS_12160(isp)   (isp->isp_type == ISP_HA_SCSI_12160)
 745
 746 #define IS_12X0(isp)    (IS_1240(isp) || IS_1280(isp))
 747 #define IS_1X160(isp)   (IS_10160(isp) || IS_12160(isp))
 748 #define IS_DUALBUS(isp) (IS_12X0(isp) || IS_12160(isp))
 749 #define IS_ULTRA2(isp)  (IS_1080(isp) || IS_1280(isp) || IS_1X160(isp))
 750 #define IS_ULTRA3(isp)  (IS_1X160(isp))
 751
 752 #define IS_FC(isp)      ((isp)->isp_type & ISP_HA_FC)
 753 #define IS_2100(isp)    ((isp)->isp_type == ISP_HA_FC_2100)
 754 #define IS_2200(isp)    ((isp)->isp_type == ISP_HA_FC_2200)
 755 #define IS_23XX(isp)    ((isp)->isp_type >= ISP_HA_FC_2300 && \
 756                                 (isp)->isp_type < ISP_HA_FC_2400)
 757 #define IS_2300(isp)    ((isp)->isp_type == ISP_HA_FC_2300)
 758 #define IS_2312(isp)    ((isp)->isp_type == ISP_HA_FC_2312)
 759 #define IS_2322(isp)    ((isp)->isp_type == ISP_HA_FC_2322)
 760 #define IS_24XX(isp)    ((isp)->isp_type >= ISP_HA_FC_2400)
 761 #define IS_25XX(isp)    ((isp)->isp_type >= ISP_HA_FC_2500)
 762
 763 /*
 764  * DMA related macros
 765  */
 766 #define DMA_WD3(x)      (((uint16_t)(((uint64_t)x) >> 48)) & 0xffff)
 767 #define DMA_WD2(x)      (((uint16_t)(((uint64_t)x) >> 32)) & 0xffff)
 768 #define DMA_WD1(x)      ((uint16_t)((x) >> 16) & 0xffff)
 769 #define DMA_WD0(x)      ((uint16_t)((x) & 0xffff))
 770
 771 #define DMA_LO32(x)     ((uint32_t) (x))
 772 #define DMA_HI32(x)     ((uint32_t)(((uint64_t)x) >> 32))
 773
 774 /*
 775  * Core System Function Prototypes
 776  */
 777
 778 /*
 779  * Reset Hardware. Totally. Assumes that you'll follow this with a call to isp_init.
 780  */
 781 void isp_reset(ispsoftc_t *, int);
 782
 783 /*
 784  * Initialize Hardware to known state
 785  */
 786 void isp_init(ispsoftc_t *);
 787
 788 /*
 789  * Reset the ISP and call completion for any orphaned commands.
 790  */
 791 void isp_reinit(ispsoftc_t *, int);
 792
 793 /*
 794  * Internal Interrupt Service Routine
 795  *
 796  * The outer layers do the spade work to get the appropriate status register,
 797  * semaphore register and first mailbox register (if appropriate). This also
 798  * means that most spurious/bogus interrupts not for us can be filtered first.
 799  */
 800 void isp_intr(ispsoftc_t *, uint32_t, uint16_t, uint16_t);
 801
 802
 803 /*
 804  * Command Entry Point- Platform Dependent layers call into this
 805  */
 806 int isp_start(XS_T *);
 807
 808 /* these values are what isp_start returns */
 809 #define CMD_COMPLETE    101     /* command completed */
 810 #define CMD_EAGAIN      102     /* busy- maybe retry later */
 811 #define CMD_QUEUED      103     /* command has been queued for execution */
 812 #define CMD_RQLATER     104     /* requeue this command later */
 813
 814 /*
 815  * Command Completion Point- Core layers call out from this with completed cmds
 816  */
 817 void isp_done(XS_T *);
 818
 819 /*
 820  * Platform Dependent to External to Internal Control Function
 821  *
 822  * Assumes locks are held on entry. You should note that with many of
 823  * these commands locks may be released while this function is called.
 824  *
 825  * ... ISPCTL_RESET_BUS, int channel);
 826  *        Reset BUS on this channel
 827  * ... ISPCTL_RESET_DEV, int channel, int target);
 828  *        Reset Device on this channel at this target.
 829  * ... ISPCTL_ABORT_CMD, XS_T *xs);
 830  *        Abort active transaction described by xs.
 831  * ... IPCTL_UPDATE_PARAMS);
 832  *        Update any operating parameters (speed, etc.)
 833  * ... ISPCTL_FCLINK_TEST, int channel);
 834  *        Test FC link status on this channel
 835  * ... ISPCTL_SCAN_FABRIC, int channel);
 836  *        Scan fabric on this channel
 837  * ... ISPCTL_SCAN_LOOP, int channel);
 838  *        Scan local loop on this channel
 839  * ... ISPCTL_PDB_SYNC, int channel);
 840  *        Synchronize port database on this channel
 841  * ... ISPCTL_SEND_LIP, int channel);
 842  *        Send a LIP on this channel
 843  * ... ISPCTL_GET_NAMES, int channel, int np, uint64_t *wwnn, uint64_t *wwpn)
 844  *        Get a WWNN/WWPN for this N-port handle on this channel
 845  * ... ISPCTL_RUN_MBOXCMD, mbreg_t *mbp)
 846  *        Run this mailbox command
 847  * ... ISPCTL_GET_PDB, int channel, int nphandle, isp_pdb_t *pdb)
 848  *        Get PDB on this channel for this N-port handle
 849  * ... ISPCTL_PLOGX, isp_plcmd_t *)
 850  *        Performa a port login/logout
 851  *
 852  * ISPCTL_PDB_SYNC is somewhat misnamed. It actually is the final step, in
 853  * order, of ISPCTL_FCLINK_TEST, ISPCTL_SCAN_FABRIC, and ISPCTL_SCAN_LOOP.
 854  * The main purpose of ISPCTL_PDB_SYNC is to complete management of logging
 855  * and logging out of fabric devices (if one is on a fabric) and then marking
 856  * the 'loop state' as being ready to now be used for sending commands to
 857  * devices. Originally fabric name server and local loop scanning were
 858  * part of this function. It's now been separated to allow for finer control.
 859  */
 860 typedef enum {
 861         ISPCTL_RESET_BUS,
 862         ISPCTL_RESET_DEV,
 863         ISPCTL_ABORT_CMD,
 864         ISPCTL_UPDATE_PARAMS,
 865         ISPCTL_FCLINK_TEST,
 866         ISPCTL_SCAN_FABRIC,
 867         ISPCTL_SCAN_LOOP,
 868         ISPCTL_PDB_SYNC,
 869         ISPCTL_SEND_LIP,
 870         ISPCTL_GET_NAMES,
 871         ISPCTL_RUN_MBOXCMD,
 872         ISPCTL_GET_PDB,
 873         ISPCTL_PLOGX
 874 } ispctl_t;
 875 int isp_control(ispsoftc_t *, ispctl_t, ...);
 876
 877 /*
 878  * Platform Dependent to Internal to External Control Function
 879  */
 880
 881 typedef enum {
 882         ISPASYNC_NEW_TGT_PARAMS,        /* SPI New Target Parameters */
 883         ISPASYNC_BUS_RESET,             /* All Bus Was Reset */
 884         ISPASYNC_LOOP_DOWN,             /* FC Loop Down */
 885         ISPASYNC_LOOP_UP,               /* FC Loop Up */
 886         ISPASYNC_LIP,                   /* FC LIP Received */
 887         ISPASYNC_LOOP_RESET,            /* FC Loop Reset Received */
 888         ISPASYNC_CHANGE_NOTIFY,         /* FC Change Notification */
 889         ISPASYNC_DEV_ARRIVED,           /* FC Device Arrived */
 890         ISPASYNC_DEV_CHANGED,           /* FC Device Changed */
 891         ISPASYNC_DEV_STAYED,            /* FC Device Stayed */
 892         ISPASYNC_DEV_GONE,              /* FC Device Departure */
 893         ISPASYNC_TARGET_NOTIFY,         /* All target async notification */
 894         ISPASYNC_TARGET_ACTION,         /* All target action requested */
 895         ISPASYNC_FW_CRASH,              /* All Firmware has crashed */
 896         ISPASYNC_FW_RESTARTED           /* All Firmware has been restarted */
 897 } ispasync_t;
 898 void isp_async(ispsoftc_t *, ispasync_t, ...);
 899
 900 #define ISPASYNC_CHANGE_PDB     0
 901 #define ISPASYNC_CHANGE_SNS     1
 902 #define ISPASYNC_CHANGE_OTHER   2
 903
 904 /*
 905  * Platform Dependent Error and Debug Printout
 906  *
 907  * Generally this is:
 908  *
 909  *    void isp_prt(ispsoftc_t *, int level, const char *, ...)
 910  *
 911  * but due to compiler differences on different platforms this won't be
 912  * formally done here. Instead, it goes in each platform definition file.
 913  */
 914
 915 #define ISP_LOGALL      0x0     /* log always */
 916 #define ISP_LOGCONFIG   0x1     /* log configuration messages */
 917 #define ISP_LOGINFO     0x2     /* log informational messages */
 918 #define ISP_LOGWARN     0x4     /* log warning messages */
 919 #define ISP_LOGERR      0x8     /* log error messages */
 920 #define ISP_LOGDEBUG0   0x10    /* log simple debug messages */
 921 #define ISP_LOGDEBUG1   0x20    /* log intermediate debug messages */
 922 #define ISP_LOGDEBUG2   0x40    /* log most debug messages */
 923 #define ISP_LOGDEBUG3   0x80    /* log high frequency debug messages */
 924 #define ISP_LOGSANCFG   0x100   /* log SAN configuration */
 925 #define ISP_LOGTINFO    0x1000  /* log informational messages (target mode) */
 926 #define ISP_LOGTDEBUG0  0x2000  /* log simple debug messages (target mode) */
 927 #define ISP_LOGTDEBUG1  0x4000  /* log intermediate debug messages (target) */
 928 #define ISP_LOGTDEBUG2  0x8000  /* log all debug messages (target) */
 929
 930 /*
 931  * Each Platform provides it's own isposinfo substructure of the ispsoftc
 932  * defined above.
 933  *
 934  * Each platform must also provide the following macros/defines:
 935  *
 936  *
 937  *      ISP_FC_SCRLEN                           FC scratch area DMA length
 938  *
 939  *      ISP_MEMZERO(dst, src)                   platform zeroing function
 940  *      ISP_MEMCPY(dst, src, count)             platform copying function
 941  *      ISP_SNPRINTF(buf, bufsize, fmt, ...)    snprintf
 942  *      ISP_DELAY(usecs)                        microsecond spindelay function
 943  *      ISP_SLEEP(isp, usecs)                   microsecond sleep function
 944  *
 945  *      ISP_INLINE                              ___inline or not- depending on how
 946  *                                              good your debugger is
 947  *
 948  *      NANOTIME_T                              nanosecond time type
 949  *
 950  *      GET_NANOTIME(NANOTIME_T *)              get current nanotime.
 951  *
 952  *      GET_NANOSEC(NANOTIME_T *)               get uint64_t from NANOTIME_T
 953  *
 954  *      NANOTIME_SUB(NANOTIME_T *, NANOTIME_T *)
 955  *                                              subtract two NANOTIME_T values
 956  *
 957  *      MAXISPREQUEST(ispsoftc_t *)             maximum request queue size
 958  *                                              for this particular board type
 959  *
 960  *      MEMORYBARRIER(ispsoftc_t *, barrier_type, offset, size)
 961  *
 962  *              Function/Macro the provides memory synchronization on
 963  *              various objects so that the ISP's and the system's view
 964  *              of the same object is consistent.
 965  *
 966  *      MBOX_ACQUIRE(ispsoftc_t *)              acquire lock on mailbox regs
 967  *      MBOX_WAIT_COMPLETE(ispsoftc_t *, mbreg_t *) wait for cmd to be done
 968  *      MBOX_NOTIFY_COMPLETE(ispsoftc_t *)      notification of mbox cmd donee
 969  *      MBOX_RELEASE(ispsoftc_t *)              release lock on mailbox regs
 970  *
 971  *      FC_SCRATCH_ACQUIRE(ispsoftc_t *, chan)  acquire lock on FC scratch area
 972  *                                              return -1 if you cannot
 973  *      FC_SCRATCH_RELEASE(ispsoftc_t *, chan)  acquire lock on FC scratch area
 974  *
 975  *      SCSI_GOOD       SCSI 'Good' Status
 976  *      SCSI_CHECK      SCSI 'Check Condition' Status
 977  *      SCSI_BUSY       SCSI 'Busy' Status
 978  *      SCSI_QFULL      SCSI 'Queue Full' Status
 979  *
 980  *      XS_T                    Platform SCSI transaction type (i.e., command for HBA)
 981  *      XS_DMA_ADDR_T           Platform PCI DMA Address Type
 982  *      XS_GET_DMA_SEG(..)      Get 32 bit dma segment list value
 983  *      XS_GET_DMA64_SEG(..)    Get 64 bit dma segment list value
 984  *      XS_ISP(xs)              gets an instance out of an XS_T
 985  *      XS_CHANNEL(xs)          gets the channel (bus # for DUALBUS cards) ""
 986  *      XS_TGT(xs)              gets the target ""
 987  *      XS_LUN(xs)              gets the lun ""
 988  *      XS_CDBP(xs)             gets a pointer to the scsi CDB ""
 989  *      XS_CDBLEN(xs)           gets the CDB's length ""
 990  *      XS_XFRLEN(xs)           gets the associated data transfer length ""
 991  *      XS_TIME(xs)             gets the time (in milliseconds) for this command
 992  *      XS_GET_RESID(xs)        gets the current residual count
 993  *      XS_GET_RESID(xs, resid) sets the current residual count
 994  *      XS_STSP(xs)             gets a pointer to the SCSI status byte ""
 995  *      XS_SNSP(xs)             gets a pointer to the associate sense data
 996  *      XS_SNSLEN(xs)           gets the length of sense data storage
 997  *      XS_SNSKEY(xs)           dereferences XS_SNSP to get the current stored Sense Key
 998  *      XS_TAG_P(xs)            predicate of whether this command should be tagged
 999  *      XS_TAG_TYPE(xs)         which type of tag to use
1000  *      XS_SETERR(xs)           set error state
1001  *
1002  *              HBA_NOERROR     command has no erros
1003  *              HBA_BOTCH       hba botched something
1004  *              HBA_CMDTIMEOUT  command timed out
1005  *              HBA_SELTIMEOUT  selection timed out (also port logouts for FC)
1006  *              HBA_TGTBSY      target returned a BUSY status
1007  *              HBA_BUSRESET    bus reset destroyed command
1008  *              HBA_ABORTED     command was aborted (by request)
1009  *              HBA_DATAOVR     a data overrun was detected
1010  *              HBA_ARQFAIL     Automatic Request Sense failed
1011  *
1012  *      XS_ERR(xs)      return current error state
1013  *      XS_NOERR(xs)    there is no error currently set
1014  *      XS_INITERR(xs)  initialize error state
1015  *
1016  *      XS_SAVE_SENSE(xs, sp, len)      save sense data
1017  *
1018  *      DEFAULT_FRAMESIZE(ispsoftc_t *)         Default Frame Size
1019  *      DEFAULT_EXEC_THROTTLE(ispsoftc_t *)     Default Execution Throttle
1020  *
1021  *      GET_DEFAULT_ROLE(ispsoftc_t *, int)     Get Default Role for a channel
1022  *      SET_DEFAULT_ROLE(ispsoftc_t *, int, int) Set Default Role for a channel
1023  *      DEFAULT_IID(ispsoftc_t *, int)          Default SCSI initiator ID
1024  *      DEFAULT_LOOPID(ispsoftc_t *, int)       Default FC Loop ID
1025  *
1026  *              These establish reasonable defaults for each platform.
1027  *              These must be available independent of card NVRAM and are
1028  *              to be used should NVRAM not be readable.
1029  *
1030  *      DEFAULT_NODEWWN(ispsoftc_t *, chan)     Default FC Node WWN to use
1031  *      DEFAULT_PORTWWN(ispsoftc_t *, chan)     Default FC Port WWN to use
1032  *
1033  *              These defines are hooks to allow the setting of node and
1034  *              port WWNs when NVRAM cannot be read or is to be overriden.
1035  *
1036  *      ACTIVE_NODEWWN(ispsoftc_t *, chan)      FC Node WWN to use
1037  *      ACTIVE_PORTWWN(ispsoftc_t *, chan)      FC Port WWN to use
1038  *
1039  *              After NVRAM is read, these will be invoked to get the
1040  *              node and port WWNs that will actually be used for this
1041  *              channel.
1042  *
1043  *
1044  *      ISP_IOXPUT_8(ispsoftc_t *, uint8_t srcval, uint8_t *dstptr)
1045  *      ISP_IOXPUT_16(ispsoftc_t *, uint16_t srcval, uint16_t *dstptr)
1046  *      ISP_IOXPUT_32(ispsoftc_t *, uint32_t srcval, uint32_t *dstptr)
1047  *
1048  *      ISP_IOXGET_8(ispsoftc_t *, uint8_t *srcptr, uint8_t dstrval)
1049  *      ISP_IOXGET_16(ispsoftc_t *, uint16_t *srcptr, uint16_t dstrval)
1050  *      ISP_IOXGET_32(ispsoftc_t *, uint32_t *srcptr, uint32_t dstrval)
1051  *
1052  *      ISP_SWIZZLE_NVRAM_WORD(ispsoftc_t *, uint16_t *)
1053  *      ISP_SWIZZLE_NVRAM_LONG(ispsoftc_t *, uint32_t *)
1054  *      ISP_SWAP16(ispsoftc_t *, uint16_t srcval)
1055  *      ISP_SWAP32(ispsoftc_t *, uint32_t srcval)
1056  */
1057
1058 #ifdef  ISP_TARGET_MODE
1059 /*
1060  * The functions below are for the publicly available
1061  * target mode functions that are internal to the Qlogic driver.
1062  */
1063
1064 /*
1065  * This function handles new response queue entry appropriate for target mode.
1066  */
1067 int isp_target_notify(ispsoftc_t *, void *, uint32_t *);
1068
1069 /*
1070  * This function externalizes the ability to acknowledge an Immediate Notify request.
1071  */
1072 int isp_notify_ack(ispsoftc_t *, void *);
1073
1074 /*
1075  * This function externalized acknowledging (success/fail) an ABTS frame
1076  */
1077 int isp_acknak_abts(ispsoftc_t *, void *, int);
1078
1079 /*
1080  * Enable/Disable/Modify a logical unit.
1081  * (softc, cmd, bus, tgt, lun, cmd_cnt, inotify_cnt)
1082  */
1083 #define DFLT_CMND_CNT   0xfe    /* unmonitored */
1084 #define DFLT_INOT_CNT   0xfe    /* unmonitored */
1085 int isp_lun_cmd(ispsoftc_t *, int, int, int, int, int);
1086
1087 /*
1088  * General request queue 'put' routine for target mode entries.
1089  */
1090 int isp_target_put_entry(ispsoftc_t *isp, void *);
1091
1092 /*
1093  * General routine to put back an ATIO entry-
1094  * used for replenishing f/w resource counts.
1095  * The argument is a pointer to a source ATIO
1096  * or ATIO2.
1097  */
1098 int isp_target_put_atio(ispsoftc_t *, void *);
1099
1100 /*
1101  * General routine to send a final CTIO for a command- used mostly for
1102  * local responses.
1103  */
1104 int isp_endcmd(ispsoftc_t *, ...);
1105 #define ECMD_SVALID     0x100
1106 #define ECMD_TERMINATE  0x200
1107
1108 /*
1109  * Handle an asynchronous event
1110  *
1111  * Return nonzero if the interrupt that generated this event has been dismissed.
1112  */
1113 int isp_target_async(ispsoftc_t *, int, int);
1114 #endif
1115 #endif  /* _ISPVAR_H */