sys/dev/isp/ispvar.h

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