sys/dev/ic/ispvar.h

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