The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/dev/ic/ispvar.h

Version: -  FREEBSD  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

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

Cache object: a340e5f390c8b71d516b416d7c1bf8e3


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.