drivers/message/fusion/mptbase.h

   1 /*
   2  *  linux/drivers/message/fusion/mptbase.h
   3  *      High performance SCSI + LAN / Fibre Channel device drivers.
   4  *      For use with PCI chip/adapter(s):
   5  *          LSIFC9xx/LSI409xx Fibre Channel
   6  *      running LSI Logic Fusion MPT (Message Passing Technology) firmware.
   7  *
   8  *  Credits:
   9  *     (see mptbase.c)
  10  *
  11  *  Copyright (c) 1999-2002 LSI Logic Corporation
  12  *  Originally By: Steven J. Ralston
  13  *  (mailto:sjralston1@netscape.net)
  14  *  (mailto:Pam.Delaney@lsil.com)
  15  *
  16  *  $Id: mptbase.h,v 1.1.1.1 2005/04/11 02:50:25 jack Exp $
  17  */
  18 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
  19 /*
  20     This program is free software; you can redistribute it and/or modify
  21     it under the terms of the GNU General Public License as published by
  22     the Free Software Foundation; version 2 of the License.
  23
  24     This program is distributed in the hope that it will be useful,
  25     but WITHOUT ANY WARRANTY; without even the implied warranty of
  26     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27     GNU General Public License for more details.
  28
  29     NO WARRANTY
  30     THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR
  31     CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT
  32     LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,
  33     MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is
  34     solely responsible for determining the appropriateness of using and
  35     distributing the Program and assumes all risks associated with its
  36     exercise of rights under this Agreement, including but not limited to
  37     the risks and costs of program errors, damage to or loss of data,
  38     programs or equipment, and unavailability or interruption of operations.
  39
  40     DISCLAIMER OF LIABILITY
  41     NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY
  42     DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  43     DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND
  44     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  45     TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  46     USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
  47     HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES
  48
  49     You should have received a copy of the GNU General Public License
  50     along with this program; if not, write to the Free Software
  51     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  52 */
  53
  54 #ifndef MPTBASE_H_INCLUDED
  55 #define MPTBASE_H_INCLUDED
  56 /*{-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
  57
  58 #include "linux_compat.h"       /* linux-2.2.x (vs. -2.4.x) tweaks */
  59 #include "scsi3.h"              /* SCSI defines */
  60
  61 #include "lsi/mpi_type.h"
  62 #include "lsi/mpi.h"            /* Fusion MPI(nterface) basic defs */
  63 #include "lsi/mpi_ioc.h"        /* Fusion MPT IOC(ontroller) defs */
  64 #include "lsi/mpi_cnfg.h"       /* IOC configuration support */
  65 #include "lsi/mpi_init.h"       /* SCSI Host (initiator) protocol support */
  66 #include "lsi/mpi_lan.h"        /* LAN over FC protocol support */
  67 #include "lsi/mpi_raid.h"       /* Integrated Mirroring support */
  68
  69 #include "lsi/mpi_fc.h"         /* Fibre Channel (lowlevel) support */
  70 #include "lsi/mpi_targ.h"       /* SCSI/FCP Target protcol support */
  71 #include "lsi/fc_log.h"
  72
  73 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
  74
  75 #ifndef MODULEAUTHOR
  76 #define MODULEAUTHOR    "LSI Logic Corporation"
  77 #endif
  78
  79 #ifndef COPYRIGHT
  80 #define COPYRIGHT       "Copyright (c) 1999-2002 " MODULEAUTHOR
  81 #endif
  82
  83 #define MPT_LINUX_VERSION_COMMON        "2.03.00"
  84 #define MPT_LINUX_PACKAGE_NAME          "@(#)mptlinux-2.03.00"
  85 #define WHAT_MAGIC_STRING               "@" "(" "#" ")"
  86
  87 #define show_mptmod_ver(s,ver)  \
  88         printk(KERN_INFO "%s %s\n", s, ver);
  89
  90 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
  91 /*
  92  *  Fusion MPT(linux) driver configurable stuff...
  93  */
  94 #define MPT_MAX_ADAPTERS                18
  95 #define MPT_MAX_PROTOCOL_DRIVERS        16
  96 #define MPT_MAX_BUS                     1
  97 #define MPT_MAX_FC_DEVICES              255
  98 #define MPT_MAX_SCSI_DEVICES            16
  99 #define MPT_LAST_LUN                    31
 100 #define MPT_SENSE_BUFFER_ALLOC          64
 101         /* allow for 256 max sense alloc, but only 255 max request */
 102 #if MPT_SENSE_BUFFER_ALLOC >= 256
 103 #       undef MPT_SENSE_BUFFER_ALLOC
 104 #       define MPT_SENSE_BUFFER_ALLOC   256
 105 #       define MPT_SENSE_BUFFER_SIZE    255
 106 #else
 107 #       define MPT_SENSE_BUFFER_SIZE    MPT_SENSE_BUFFER_ALLOC
 108 #endif
 109
 110 #define MPT_NAME_LENGTH                 32
 111
 112 #define MPT_PROCFS_MPTBASEDIR           "mpt"
 113                                                 /* chg it to "driver/fusion" ? */
 114 #define MPT_PROCFS_SUMMARY_ALL_NODE             MPT_PROCFS_MPTBASEDIR "/summary"
 115 #define MPT_PROCFS_SUMMARY_ALL_PATHNAME         "/proc/" MPT_PROCFS_SUMMARY_ALL_NODE
 116 #define MPT_FW_REV_MAGIC_ID_STRING              "FwRev="
 117
 118 #define  MPT_MAX_REQ_DEPTH              1023
 119 #define  MPT_DEFAULT_REQ_DEPTH          256
 120 #define  MPT_MIN_REQ_DEPTH              128
 121
 122 #define  MPT_MAX_REPLY_DEPTH            MPT_MAX_REQ_DEPTH
 123 #define  MPT_DEFAULT_REPLY_DEPTH        128
 124 #define  MPT_MIN_REPLY_DEPTH            8
 125 #define  MPT_MAX_REPLIES_PER_ISR        32
 126
 127 #define  MPT_MAX_FRAME_SIZE             128
 128 #define  MPT_DEFAULT_FRAME_SIZE         128
 129
 130 #define  MPT_SG_REQ_128_SCALE           1
 131 #define  MPT_SG_REQ_96_SCALE            2
 132 #define  MPT_SG_REQ_64_SCALE            4
 133
 134 #define  CAN_SLEEP                      1
 135 #define  NO_SLEEP                       0
 136
 137 /*
 138  * SCSI transfer rate defines.
 139  */
 140 #define MPT_ULTRA320                    0x08
 141 #define MPT_ULTRA160                    0x09
 142 #define MPT_ULTRA2                      0x0A
 143 #define MPT_ULTRA                       0x0C
 144 #define MPT_FAST                        0x19
 145 #define MPT_SCSI                        0x32
 146 #define MPT_ASYNC                       0xFF
 147
 148 #define MPT_NARROW                      0
 149 #define MPT_WIDE                        1
 150
 151 #ifdef __KERNEL__       /* { */
 152 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
 153
 154 #include <linux/proc_fs.h>
 155
 156 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
 157 /*
 158  * Attempt semi-consistent error & warning msgs across
 159  * MPT drivers.  NOTE: Users of these macro defs must
 160  * themselves define their own MYNAM.
 161  */
 162 #define MYIOC_s_INFO_FMT                KERN_INFO MYNAM ": %s: "
 163 #define MYIOC_s_NOTE_FMT                KERN_NOTICE MYNAM ": %s: "
 164 #define MYIOC_s_WARN_FMT                KERN_WARNING MYNAM ": %s: WARNING - "
 165 #define MYIOC_s_ERR_FMT                 KERN_ERR MYNAM ": %s: ERROR - "
 166
 167 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
 168 /*
 169  *  MPT protocol driver defs...
 170  */
 171 typedef enum {
 172         MPTBASE_DRIVER,         /* MPT base class */
 173         MPTCTL_DRIVER,          /* MPT ioctl class */
 174         MPTSCSIH_DRIVER,        /* MPT SCSI host (initiator) class */
 175         MPTLAN_DRIVER,          /* MPT LAN class */
 176         MPTSTM_DRIVER,          /* MPT SCSI target mode class */
 177         MPTDMP_DRIVER,          /* MPT Dynamic Multi-pathing class */
 178         MPTUNKNOWN_DRIVER
 179 } MPT_DRIVER_CLASS;
 180
 181 /*
 182  *  MPT adapter / port / bus / device info structures...
 183  */
 184
 185 typedef union _MPT_FRAME_TRACKER {
 186         struct {
 187                 struct _MPT_FRAME_HDR   *forw;
 188                 struct _MPT_FRAME_HDR   *back;
 189                 u32                      arg1;
 190                 u32                      pad;
 191                 void                    *argp1;
 192 #ifndef MPT_SCSI_USE_NEW_EH
 193                 void                    *argp2;
 194 #endif
 195         } linkage;
 196         /*
 197          * NOTE: When request frames are free, on the linkage structure
 198          * contets are valid.  All other values are invalid.
 199          * In particular, do NOT reply on offset [2]
 200          * (in words) being the * message context.
 201          * The message context must be reset (computed via base address
 202          * + an offset) prior to issuing any command.
 203          *
 204          * NOTE2: On non-32-bit systems, where pointers are LARGE,
 205          * using the linkage pointers destroys our sacred MsgContext
 206          * field contents.  But we don't care anymore because these
 207          * are now reset in mpt_put_msg_frame() just prior to sending
 208          * a request off to the IOC.
 209          */
 210         struct {
 211                 u32 __hdr[2];
 212                 /*
 213                  * The following _MUST_ match the location of the
 214                  * MsgContext field in the MPT message headers.
 215                  */
 216                 union {
 217                         u32              MsgContext;
 218                         struct {
 219                                 u16      req_idx;       /* Request index */
 220                                 u8       cb_idx;        /* callback function index */
 221                                 u8       rsvd;
 222                         } fld;
 223                 } msgctxu;
 224         } hwhdr;
 225         /*
 226          * Remark: 32 bit identifier:
 227          *  31-24: reserved
 228          *  23-16: call back index
 229          *  15-0 : request index
 230          */
 231 } MPT_FRAME_TRACKER;
 232
 233 /*
 234  *  We might want to view/access a frame as:
 235  *    1) generic request header
 236  *    2) SCSIIORequest
 237  *    3) SCSIIOReply
 238  *    4) MPIDefaultReply
 239  *    5) frame tracker
 240  */
 241 typedef struct _MPT_FRAME_HDR {
 242         union {
 243                 MPIHeader_t             hdr;
 244                 SCSIIORequest_t         scsireq;
 245                 SCSIIOReply_t           sreply;
 246                 MPIDefaultReply_t       reply;
 247                 MPT_FRAME_TRACKER       frame;
 248         } u;
 249 } MPT_FRAME_HDR;
 250
 251 #define MPT_REQ_MSGFLAGS_DROPME         0x80
 252
 253 /* Used for tracking the free request frames
 254  * and free reply frames.
 255  */
 256 typedef struct _MPT_Q_TRACKER {
 257         MPT_FRAME_HDR   *head;
 258         MPT_FRAME_HDR   *tail;
 259 } MPT_Q_TRACKER;
 260
 261
 262 typedef struct _MPT_SGL_HDR {
 263         SGESimple32_t    sge[1];
 264 } MPT_SGL_HDR;
 265
 266 typedef struct _MPT_SGL64_HDR {
 267         SGESimple64_t    sge[1];
 268 } MPT_SGL64_HDR;
 269
 270
 271 typedef struct _Q_ITEM {
 272         struct _Q_ITEM  *forw;
 273         struct _Q_ITEM  *back;
 274 } Q_ITEM;
 275
 276 typedef struct _Q_TRACKER {
 277         struct _Q_ITEM  *head;
 278         struct _Q_ITEM  *tail;
 279 } Q_TRACKER;
 280
 281 typedef struct _MPT_DONE_Q {
 282         struct _MPT_DONE_Q      *forw;
 283         struct _MPT_DONE_Q      *back;
 284         void                    *argp;
 285 } MPT_DONE_Q;
 286
 287 typedef struct _DONE_Q_TRACKER {
 288         MPT_DONE_Q      *head;
 289         MPT_DONE_Q      *tail;
 290 } DONE_Q_TRACKER;
 291
 292 /*
 293  *  Chip-specific stuff... FC929 delineates break between
 294  *  FC and Parallel SCSI parts. Do NOT re-order.
 295  */
 296
 297 typedef enum {
 298         FC919X = 0x0819,
 299         FC929X = 0x0829,
 300         FC909 = 0x0909,
 301         FC919 = 0x0919,
 302         FC929 = 0x0929,
 303         C1030 = 0x1030,
 304         FCUNK = 0xFBAD
 305 } CHIP_TYPE;
 306
 307 /*
 308  *  System interface register set
 309  */
 310
 311 typedef struct _SYSIF_REGS
 312 {
 313         u32     Doorbell;       /* 00     System<->IOC Doorbell reg  */
 314         u32     WriteSequence;  /* 04     Write Sequence register    */
 315         u32     Diagnostic;     /* 08     Diagnostic register        */
 316         u32     TestBase;       /* 0C     Test Base Address          */
 317         u32     DiagRwData;     /* 10     Read Write Data (fw download)   */
 318         u32     DiagRwAddress;  /* 14     Read Write Address (fw download)*/
 319         u32     Reserved1[6];   /* 18-2F  reserved for future use    */
 320         u32     IntStatus;      /* 30     Interrupt Status           */
 321         u32     IntMask;        /* 34     Interrupt Mask             */
 322         u32     Reserved2[2];   /* 38-3F  reserved for future use    */
 323         u32     RequestFifo;    /* 40     Request Post/Free FIFO     */
 324         u32     ReplyFifo;      /* 44     Reply   Post/Free FIFO     */
 325         u32     Reserved3[2];   /* 48-4F  reserved for future use    */
 326         u32     HostIndex;      /* 50     Host Index register        */
 327         u32     Reserved4[15];  /* 54-8F                             */
 328         u32     Fubar;          /* 90     For Fubar usage            */
 329         u32     Reserved5[27];  /* 94-FF                             */
 330 } SYSIF_REGS;
 331
 332 /*
 333  * NOTE: Use MPI_{DOORBELL,WRITESEQ,DIAG}_xxx defs in lsi/mpi.h
 334  * in conjunction with SYSIF_REGS accesses!
 335  */
 336
 337
 338 /*
 339  *      Dynamic Multi-Pathing specific stuff...
 340  */
 341 #define DMP_MAX_PATHS   8
 342
 343 typedef struct _PathInfo {
 344         u8               ioc;
 345         u8               target;
 346         u8               pad;
 347         u8               pflags;
 348 } PathInfo;
 349
 350 #define PATHINFO_FLAGS_OWNED            0x01
 351 #define PATHINFO_FLAGS_EXISTS           0x02
 352 #define PATHINFO_FLAGS_AVAILABLE        0x04
 353 #define PATHINFO_FLAGS_SECONDARY        0x08
 354
 355 #define PFLAGS_EXISTS_AND_AVAIL         (PATHINFO_FLAGS_EXISTS|PATHINFO_FLAGS_AVAILABLE)
 356 #define PFLAGS_AVAIL_AND_OWNED          (PATHINFO_FLAGS_AVAILABLE|PATHINFO_FLAGS_OWNED)
 357
 358 typedef struct _ScsiCmndTracker {
 359         void                    *head;
 360         void                    *tail;
 361 } ScsiCmndTracker;
 362
 363
 364 /*
 365  *      VirtDevice - FC LUN device or SCSI target device
 366  *      (used to be FCSCSI_TARGET)
 367  */
 368 typedef struct _VirtDevice {
 369         struct _VirtDevice      *forw;
 370         struct _VirtDevice      *back;
 371         rwlock_t                 VdevLock;
 372         int                      ref_cnt;
 373         u8                       tflags;
 374         u8                       ioc_id;
 375         u8                       target_id;
 376         u8                       bus_id;
 377         u8                       minSyncFactor; /* 0xFF is async */
 378         u8                       maxOffset;     /* 0 if async */
 379         u8                       maxWidth;      /* 0 if narrow, 1 if wide*/
 380         u8                       negoFlags;     /* bit field, 0 if WDTR/SDTR/QAS allowed */
 381         u8                       raidVolume;    /* set, if RAID Volume */
 382 #ifdef ABORT_FIX
 383         u8                       numAborts;
 384 #else
 385         u8                       rsvd;
 386 #endif
 387         u16                      rsvd1raid;
 388         int                      npaths;
 389         u16                      fc_phys_lun;
 390         u16                      fc_xlat_lun;
 391         int                      stall_detected;
 392         PathInfo                 path[DMP_MAX_PATHS];
 393         struct timer_list        stall_timer;
 394         struct timer_list        retry_timer;
 395         struct timer_list        gone_timer;
 396         ScsiCmndTracker          WaitQ;
 397         ScsiCmndTracker          SentQ;
 398         ScsiCmndTracker          DoneQ;
 399 //--- LUN split here?
 400 #ifdef MPT_SAVE_AUTOSENSE
 401         u8                       sense[SCSI_STD_SENSE_BYTES];           /* 18 */
 402         u8                       rsvd2[2];      /* alignment */
 403 #endif
 404         u32                      luns;          /* Max LUNs is 32 */
 405         u8                       inq_data[SCSI_STD_INQUIRY_BYTES];      /* 36 */
 406         u8                       pad0[4];
 407         u8                       inq00_data[20];
 408         u8                       pad1[4];
 409                 /* IEEE Registered Extended Identifier
 410                    obtained via INQUIRY VPD page 0x83 */
 411                 /* NOTE: Do not separate uniq_prepad and uniq_data
 412                    as they are treateed as a single entity in the code */
 413         u8                       uniq_prepad[8];
 414         u8                       uniq_data[20];
 415         u8                       pad2[4];
 416         u8                       inqC3_data[12];
 417         u8                       pad3[4];
 418         u8                       inqC9_data[12];
 419         u8                       pad4[4];
 420         u8                       dev_vol_name[64];
 421 } VirtDevice;
 422
 423 /*
 424  *  Fibre Channel (SCSI) target device and associated defines...
 425  */
 426 #define MPT_TARGET_DEFAULT_DV_STATUS    0
 427 #define MPT_TARGET_FLAGS_VALID_NEGO     0x01
 428 #define MPT_TARGET_FLAGS_VALID_INQUIRY  0x02
 429 #ifdef MPT_SAVE_AUTOSENSE
 430 #define MPT_TARGET_FLAGS_VALID_SENSE    0x04
 431 #endif
 432 #define MPT_TARGET_FLAGS_Q_YES          0x08
 433 #define MPT_TARGET_FLAGS_VALID_56       0x10
 434
 435 #define MPT_TARGET_NO_NEGO_WIDE         0x01
 436 #define MPT_TARGET_NO_NEGO_SYNC         0x02
 437 #define MPT_TARGET_NO_NEGO_QAS          0x04
 438
 439 typedef struct _VirtDevTracker {
 440         struct _VirtDevice      *head;
 441         struct _VirtDevice      *tail;
 442         rwlock_t                 VlistLock;
 443         int                      pad;
 444 } VirtDevTracker;
 445
 446
 447 /*
 448  *      /proc/mpt interface
 449  */
 450 typedef struct {
 451         const char      *name;
 452         mode_t           mode;
 453         int              pad;
 454         read_proc_t     *read_proc;
 455         write_proc_t    *write_proc;
 456 } mpt_proc_entry_t;
 457
 458 #define MPT_PROC_READ_RETURN(buf,start,offset,request,eof,len) \
 459 do { \
 460         len -= offset;                  \
 461         if (len < request) {            \
 462                 *eof = 1;               \
 463                 if (len <= 0)           \
 464                         return 0;       \
 465         } else                          \
 466                 len = request;          \
 467         *start = buf + offset;          \
 468         return len;                     \
 469 } while (0)
 470
 471
 472 /*
 473  *      IOCTL structure and associated defines
 474  */
 475
 476 #define MPT_IOCTL_STATUS_DID_IOCRESET   0x01    /* IOC Reset occurred on the current*/
 477 #define MPT_IOCTL_STATUS_RF_VALID       0x02    /* The Reply Frame is VALID */
 478 #define MPT_IOCTL_STATUS_TIMER_ACTIVE   0x04    /* The timer is running */
 479 #define MPT_IOCTL_STATUS_SENSE_VALID    0x08    /* Sense data is valid */
 480 #define MPT_IOCTL_STATUS_COMMAND_GOOD   0x10    /* Command Status GOOD */
 481 #define MPT_IOCTL_STATUS_TMTIMER_ACTIVE 0x20    /* The TM timer is running */
 482 #define MPT_IOCTL_STATUS_TM_FAILED      0x40    /* User TM request failed */
 483
 484 #define MPTCTL_RESET_OK                 0x01    /* Issue Bus Reset */
 485
 486 typedef struct _MPT_IOCTL {
 487         struct _MPT_ADAPTER     *ioc;
 488         struct timer_list        timer;         /* timer function for this adapter */
 489         u8                       ReplyFrame[MPT_DEFAULT_FRAME_SIZE];    /* reply frame data */
 490         u8                       sense[MPT_SENSE_BUFFER_ALLOC];
 491         int                      wait_done;     /* wake-up value for this ioc */
 492         u8                       rsvd;
 493         u8                       status;        /* current command status */
 494         u8                       reset;         /* 1 if bus reset allowed */
 495         u8                       target;        /* target for reset */
 496         void                    *tmPtr;
 497         struct timer_list        TMtimer;       /* timer function for this adapter */
 498 } MPT_IOCTL;
 499
 500 /*
 501  *  Event Structure and define
 502  */
 503 #define MPTCTL_EVENT_LOG_SIZE           (0x0000000A)
 504 typedef struct _mpt_ioctl_events {
 505         u32     event;          /* Specified by define above */
 506         u32     eventContext;   /* Index or counter */
 507         int     data[2];        /* First 8 bytes of Event Data */
 508 } MPT_IOCTL_EVENTS;
 509
 510 /*
 511  * CONFIGPARM status  defines
 512  */
 513 #define MPT_CONFIG_GOOD         MPI_IOCSTATUS_SUCCESS
 514 #define MPT_CONFIG_ERROR        0x002F
 515
 516 /*
 517  *      Substructure to store SCSI specific configuration page data
 518  */
 519                                                 /* dvStatus defines: */
 520 #define MPT_SCSICFG_NEGOTIATE           0x01    /* Negotiate on next IO */
 521 #define MPT_SCSICFG_NEED_DV             0x02    /* Schedule DV */
 522 #define MPT_SCSICFG_DV_PENDING          0x04    /* DV on this physical id pending */
 523 #define MPT_SCSICFG_DV_NOT_DONE         0x08    /* DV has not been performed */
 524 #define MPT_SCSICFG_BLK_NEGO            0x10    /* WriteSDP1 with WDTR and SDTR disabled */
 525
 526                                                 /* Args passed to writeSDP1: */
 527 #define MPT_SCSICFG_USE_NVRAM           0x01    /* WriteSDP1 using NVRAM */
 528 #define MPT_SCSICFG_ALL_IDS             0x02    /* WriteSDP1 to all IDS */
 529 /* #define MPT_SCSICFG_BLK_NEGO         0x10       WriteSDP1 with WDTR and SDTR disabled */
 530
 531 typedef struct _ScsiCfgData {
 532         int             *nvram;                 /* table of device NVRAM values */
 533         IOCPage3_t      *pIocPg3;               /* table of physical disks */
 534         u8               dvStatus[MPT_MAX_SCSI_DEVICES];
 535         int              isRaid;                /* bit field, 1 if RAID */
 536         u8               minSyncFactor;         /* 0xFF if async */
 537         u8               maxSyncOffset;         /* 0 if async */
 538         u8               maxBusWidth;           /* 0 if narrow, 1 if wide */
 539         u8               busType;               /* SE, LVD, HD */
 540         u8               sdp1version;           /* SDP1 version */
 541         u8               sdp1length;            /* SDP1 length  */
 542         u8               sdp0version;           /* SDP0 version */
 543         u8               sdp0length;            /* SDP0 length  */
 544         u8               dvScheduled;           /* 1 if scheduled */
 545         u8               forceDv;               /* 1 to force DV scheduling */
 546         u8               noQas;                 /* Disable QAS for this adapter */
 547         u8               rsvd[2];
 548 } ScsiCfgData;
 549
 550 typedef struct _fw_image {
 551         char            *fw;
 552         dma_addr_t       fw_dma;
 553         u32              size;
 554         u32              rsvd;
 555 } fw_image_t;
 556
 557 /*
 558  *  Adapter Structure - pci_dev specific. Maximum: MPT_MAX_ADAPTERS
 559  */
 560 typedef struct _MPT_ADAPTER
 561 {
 562         struct _MPT_ADAPTER     *forw;
 563         struct _MPT_ADAPTER     *back;
 564         int                      id;            /* Unique adapter id N {0,1,2,...} */
 565         int                      pci_irq;       /* This irq           */
 566         char                     name[MPT_NAME_LENGTH]; /* "iocN"             */
 567         char                    *prod_name;     /* "LSIFC9x9"         */
 568         volatile SYSIF_REGS     *chip;          /* == c8817000 (mmap) */
 569         volatile SYSIF_REGS     *pio_chip;      /* Programmed IO (downloadboot) */
 570         u32                      mem_phys;      /* == f4020000 (mmap) */
 571         u32                      pio_mem_phys;  /* Programmed IO (downloadboot) */
 572         int                      mem_size;      /* mmap memory size */
 573         int                      alloc_total;
 574         u32                      last_state;
 575         int                      active;
 576         u8                      *reply_alloc;   /* Reply frames alloc ptr */
 577         dma_addr_t               reply_alloc_dma;
 578         MPT_FRAME_HDR           *reply_frames;  /* Reply msg frames - rounded up! */
 579         dma_addr_t               reply_frames_dma;
 580         u32                      reply_frames_low_dma;
 581         int                      reply_depth;   /* Num Allocated reply frames */
 582         int                      reply_sz;      /* Reply frame size */
 583         CHIP_TYPE                chip_type;
 584                 /* We (host driver) get to manage our own RequestQueue! */
 585         u8                      *req_alloc;     /* Request frames alloc ptr */
 586         dma_addr_t               req_alloc_dma;
 587         MPT_FRAME_HDR           *req_frames;    /* Request msg frames - rounded up! */
 588         dma_addr_t               req_frames_dma;
 589         u32                      req_frames_low_dma;
 590         int                      req_depth;     /* Number of request frames */
 591         int                      req_sz;        /* Request frame size (bytes) */
 592         spinlock_t               FreeQlock;
 593         MPT_Q_TRACKER            FreeQ;
 594                 /* Pool of SCSI sense buffers for commands coming from
 595                  * the SCSI mid-layer.  We have one 256 byte sense buffer
 596                  * for each REQ entry.
 597                  */
 598         u8                      *sense_buf_pool;
 599         dma_addr_t               sense_buf_pool_dma;
 600         u32                      sense_buf_low_dma;
 601         int                      mtrr_reg;
 602         void                    *pcidev;        /* struct pci_dev pointer */
 603         u8                      *memmap;        /* mmap address */
 604         struct Scsi_Host        *sh;            /* Scsi Host pointer */
 605         ScsiCfgData             spi_data;       /* Scsi config. data */
 606         MPT_IOCTL               *ioctl;         /* ioctl data pointer */
 607         struct proc_dir_entry   *ioc_dentry;
 608         struct _MPT_ADAPTER     *alt_ioc;       /* ptr to 929 bound adapter port */
 609         spinlock_t               diagLock;      /* diagnostic reset lock */
 610         int                      diagPending;
 611         u32                      biosVersion;   /* BIOS version from IO Unit Page 2 */
 612         int                      eventTypes;    /* Event logging parameters */
 613         int                      eventContext;  /* Next event context */
 614         int                      eventLogSize;  /* Max number of cached events */
 615         struct _mpt_ioctl_events *events;       /* pointer to event log */
 616         fw_image_t              **cached_fw;    /* Pointer to FW SG List */
 617         Q_TRACKER                configQ;       /* linked list of config. requests */
 618         int                      num_fw_frags;  /* Number of SGE in FW SG List */
 619         int                      hs_reply_idx;
 620 #ifndef MFCNT
 621         u32                      pad0;
 622 #else
 623         u32                      mfcnt;
 624 #endif
 625         u32                      hs_req[MPT_MAX_FRAME_SIZE/sizeof(u32)];
 626         u16                      hs_reply[MPT_MAX_FRAME_SIZE/sizeof(u16)];
 627         IOCFactsReply_t          facts;
 628         PortFactsReply_t         pfacts[2];
 629         FCPortPage0_t            fc_port_page0[2];
 630         LANPage0_t               lan_cnfg_page0;
 631         LANPage1_t               lan_cnfg_page1;
 632         u8                       FirstWhoInit;
 633         u8                       upload_fw;     /* If set, do a fw upload */
 634         u8                       reload_fw;     /* Force a FW Reload on next reset */
 635         u8                       pad1[5];
 636 } MPT_ADAPTER;
 637
 638
 639 typedef struct _MPT_ADAPTER_TRACKER {
 640         MPT_ADAPTER     *head;
 641         MPT_ADAPTER     *tail;
 642 } MPT_ADAPTER_TRACKER;
 643
 644 /*
 645  *  New return value convention:
 646  *    1 = Ok to free associated request frame
 647  *    0 = not Ok ...
 648  */
 649 typedef int (*MPT_CALLBACK)(MPT_ADAPTER *ioc, MPT_FRAME_HDR *req, MPT_FRAME_HDR *reply);
 650 typedef int (*MPT_EVHANDLER)(MPT_ADAPTER *ioc, EventNotificationReply_t *evReply);
 651 typedef int (*MPT_RESETHANDLER)(MPT_ADAPTER *ioc, int reset_phase);
 652 /* reset_phase defs */
 653 #define MPT_IOC_PRE_RESET               0
 654 #define MPT_IOC_POST_RESET              1
 655
 656 /*
 657  * Invent MPT host event (super-set of MPI Events)
 658  * Fitted to 1030's 64-byte [max] request frame size
 659  */
 660 typedef struct _MPT_HOST_EVENT {
 661         EventNotificationReply_t         MpiEvent;      /* 8 32-bit words! */
 662         u32                              pad[6];
 663         void                            *next;
 664 } MPT_HOST_EVENT;
 665
 666 #define MPT_HOSTEVENT_IOC_BRINGUP       0x91
 667 #define MPT_HOSTEVENT_IOC_RECOVER       0x92
 668
 669 /* Define the generic types based on the size
 670  * of the dma_addr_t type.
 671  */
 672 typedef struct _mpt_sge {
 673         u32             FlagsLength;
 674         dma_addr_t      Address;
 675 } MptSge_t;
 676
 677 #define mpt_addr_size() \
 678         ((sizeof(dma_addr_t) == sizeof(u64)) ? MPI_SGE_FLAGS_64_BIT_ADDRESSING : \
 679                 MPI_SGE_FLAGS_32_BIT_ADDRESSING)
 680
 681 #define mpt_msg_flags() \
 682         ((sizeof(dma_addr_t) == sizeof(u64)) ? MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_64 : \
 683                 MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_32)
 684
 685 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
 686 /*
 687  *  Funky (private) macros...
 688  */
 689 #ifdef MPT_DEBUG
 690 #define dprintk(x)  printk x
 691 #else
 692 #define dprintk(x)
 693 #endif
 694
 695 #ifdef MPT_DEBUG_HANDSHAKE
 696 #define dhsprintk(x)  printk x
 697 #else
 698 #define dhsprintk(x)
 699 #endif
 700
 701 //#if defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
 702 #if defined(MPT_DEBUG_MSG_FRAME)
 703 #define dmfprintk(x)  printk x
 704 #else
 705 #define dmfprintk(x)
 706 #endif
 707
 708 #ifdef MPT_DEBUG_IRQ
 709 #define dirqprintk(x)  printk x
 710 #else
 711 #define dirqprintk(x)
 712 #endif
 713
 714 #ifdef MPT_DEBUG_SG
 715 #define dsgprintk(x)  printk x
 716 #else
 717 #define dsgprintk(x)
 718 #endif
 719
 720 #if defined(MPT_DEBUG_DL) || defined(MPT_DEBUG)
 721 #define ddlprintk(x)  printk x
 722 #else
 723 #define ddlprintk(x)
 724 #endif
 725
 726
 727 #ifdef MPT_DEBUG_DV
 728 #define ddvprintk(x)  printk x
 729 #else
 730 #define ddvprintk(x)
 731 #endif
 732
 733 #if defined(MPT_DEBUG_DV) || defined(MPT_DEBUG_DV_TINY)
 734 #define ddvtprintk(x)  printk x
 735 #else
 736 #define ddvtprintk(x)
 737 #endif
 738
 739 #ifdef MPT_DEBUG_IOCTL
 740 #define dctlprintk(x) printk x
 741 #else
 742 #define dctlprintk(x)
 743 #endif
 744
 745 #ifdef MPT_DEBUG_RESET
 746 #define dtmprintk(x) printk x
 747 #else
 748 #define dtmprintk(x)
 749 #endif
 750
 751 #ifdef MPT_DEBUG_NEH
 752 #define nehprintk(x) printk x
 753 #else
 754 #define nehprintk(x)
 755 #endif
 756
 757 #define MPT_INDEX_2_MFPTR(ioc,idx) \
 758         (MPT_FRAME_HDR*)( (u8*)(ioc)->req_frames + (ioc)->req_sz * (idx) )
 759
 760 #define MFPTR_2_MPT_INDEX(ioc,mf) \
 761         (int)( ((u8*)mf - (u8*)(ioc)->req_frames) / (ioc)->req_sz )
 762
 763 #define MPT_INDEX_2_RFPTR(ioc,idx) \
 764         (MPT_FRAME_HDR*)( (u8*)(ioc)->reply_frames + (ioc)->req_sz * (idx) )
 765
 766 #define Q_INIT(q,type)  (q)->head = (q)->tail = (type*)(q)
 767 #define Q_IS_EMPTY(q)   ((Q_ITEM*)(q)->head == (Q_ITEM*)(q))
 768
 769 #define Q_ADD_TAIL(qt,i,type) { \
 770         Q_TRACKER       *_qt = (Q_TRACKER*)(qt); \
 771         Q_ITEM          *oldTail = _qt->tail; \
 772         (i)->forw = (type*)_qt; \
 773         (i)->back = (type*)oldTail; \
 774         oldTail->forw = (Q_ITEM*)(i); \
 775         _qt->tail = (Q_ITEM*)(i); \
 776 }
 777
 778 #define Q_ADD_HEAD(qt,i,type) { \
 779         Q_TRACKER       *_qt = (Q_TRACKER*)(qt); \
 780         Q_ITEM          *oldHead = _qt->head; \
 781         (i)->forw = (type*)oldHead; \
 782         (i)->back = (type*)_qt; \
 783         oldHead->back = (Q_ITEM*)(i); \
 784         _qt->head = (Q_ITEM*)(i); \
 785 }
 786
 787 #define Q_DEL_ITEM(i) { \
 788         Q_ITEM  *_forw = (Q_ITEM*)(i)->forw; \
 789         Q_ITEM  *_back = (Q_ITEM*)(i)->back; \
 790         _back->forw = _forw; \
 791         _forw->back = _back; \
 792 }
 793
 794 #define SWAB4(value) \
 795         (u32)(   (((value) & 0x000000ff) << 24) \
 796                | (((value) & 0x0000ff00) << 8)  \
 797                | (((value) & 0x00ff0000) >> 8)  \
 798                | (((value) & 0xff000000) >> 24) )
 799
 800
 801 #if defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
 802 #define DBG_DUMP_REPLY_FRAME(mfp) \
 803         {       u32 *m = (u32 *)(mfp);                                  \
 804                 int  i, n = (le32_to_cpu(m[0]) & 0x00FF0000) >> 16;     \
 805                 printk(KERN_INFO " ");                                  \
 806                 for (i=0; i<n; i++)                                     \
 807                         printk(" %08x", le32_to_cpu(m[i]));             \
 808                 printk("\n");                                           \
 809         }
 810 #define DBG_DUMP_REQUEST_FRAME_HDR(mfp) \
 811         {       int  i, n = 3;                                          \
 812                 u32 *m = (u32 *)(mfp);                                  \
 813                 printk(KERN_INFO " ");                                  \
 814                 for (i=0; i<n; i++)                                     \
 815                         printk(" %08x", le32_to_cpu(m[i]));             \
 816                 printk("\n");                                           \
 817         }
 818 #else
 819 #define DBG_DUMP_REPLY_FRAME(mfp)
 820 #define DBG_DUMP_REQUEST_FRAME_HDR(mfp)
 821 #endif
 822
 823
 824 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
 825
 826 /*
 827  * MPT_SCSI_HOST defines - Used by the IOCTL and the SCSI drivers
 828  * Private to the driver.
 829  */
 830 /* LOCAL structure and fields used when processing
 831  * internally generated commands. These include:
 832  * bus scan, dv and config requests.
 833  */
 834 typedef struct _MPT_LOCAL_REPLY {
 835         ConfigPageHeader_t header;
 836         int     completion;
 837         u8      sense[SCSI_STD_SENSE_BYTES];
 838         u8      scsiStatus;
 839         u8      skip;
 840         u32     pad;
 841 } MPT_LOCAL_REPLY;
 842
 843 #define MPT_HOST_BUS_UNKNOWN            (0xFF)
 844 #define MPT_HOST_TOO_MANY_TM            (0x05)
 845 #define MPT_HOST_NVRAM_INVALID          (0xFFFFFFFF)
 846 #define MPT_HOST_NO_CHAIN               (0xFFFFFFFF)
 847 #define MPT_NVRAM_MASK_TIMEOUT          (0x000000FF)
 848 #define MPT_NVRAM_SYNC_MASK             (0x0000FF00)
 849 #define MPT_NVRAM_SYNC_SHIFT            (8)
 850 #define MPT_NVRAM_DISCONNECT_ENABLE     (0x00010000)
 851 #define MPT_NVRAM_ID_SCAN_ENABLE        (0x00020000)
 852 #define MPT_NVRAM_LUN_SCAN_ENABLE       (0x00040000)
 853 #define MPT_NVRAM_TAG_QUEUE_ENABLE      (0x00080000)
 854 #define MPT_NVRAM_WIDE_DISABLE          (0x00100000)
 855 #define MPT_NVRAM_BOOT_CHOICE           (0x00200000)
 856
 857 #ifdef MPT_SCSI_USE_NEW_EH
 858 /* The TM_STATE variable is used to provide strict single threading of TM
 859  * requests as well as communicate TM error conditions.
 860  */
 861 #define TM_STATE_NONE          (0)
 862 #define TM_STATE_IN_PROGRESS   (1)
 863 #define TM_STATE_ERROR         (2)
 864 #endif
 865
 866 typedef struct _MPT_SCSI_HOST {
 867         MPT_ADAPTER              *ioc;
 868         int                       port;
 869         u32                       pad0;
 870         struct scsi_cmnd        **ScsiLookup;
 871                 /* Pool of buffers for chaining. ReqToChain
 872                  * and ChainToChain track index of chain buffers.
 873                  * ChainBuffer (DMA) virt/phys addresses.
 874                  * FreeChainQ (lock) locking mechanisms.
 875                  */
 876         int                      *ReqToChain;
 877         int                      *ChainToChain;
 878         u8                       *ChainBuffer;
 879         dma_addr_t                ChainBufferDMA;
 880         MPT_Q_TRACKER             FreeChainQ;
 881         spinlock_t                FreeChainQlock;
 882         u32                       qtag_tick;
 883         VirtDevice              **Targets;
 884         MPT_LOCAL_REPLY          *pLocal;               /* used for internal commands */
 885         struct timer_list         timer;
 886         struct timer_list         TMtimer;              /* Timer for TM commands ONLY */
 887                 /* Pool of memory for holding SCpnts before doing
 888                  * OS callbacks. freeQ is the free pool.
 889                  */
 890         u8                       *memQ;
 891         DONE_Q_TRACKER            freeQ;
 892         DONE_Q_TRACKER            doneQ;                /* Holds Linux formmatted requests */
 893         DONE_Q_TRACKER            pendingQ;             /* Holds MPI formmatted requests */
 894         MPT_Q_TRACKER             taskQ;                /* TM request Q */
 895         spinlock_t                freedoneQlock;
 896         int                       taskQcnt;
 897         int                       num_chain;            /* Number of chain buffers */
 898         int                       max_sge;              /* Max No of SGE*/
 899         u8                        numTMrequests;
 900         u8                        tmPending;
 901         u8                        resetPending;
 902         u8                        is_spi;               /* Parallel SCSI i/f */
 903         u8                        negoNvram;            /* DV disabled, nego NVRAM */
 904         u8                        is_multipath;         /* Multi-path compatible */
 905 #ifdef MPT_SCSI_USE_NEW_EH
 906         u8                        tmState;
 907         u8                        rsvd[1];
 908 #else
 909         u8                        rsvd[2];
 910 #endif
 911         MPT_FRAME_HDR            *tmPtr;                /* Ptr to TM request*/
 912         MPT_FRAME_HDR            *cmdPtr;               /* Ptr to nonOS request */
 913         struct scsi_cmnd         *abortSCpnt;
 914         MPT_LOCAL_REPLY           localReply;           /* internal cmd reply struct */
 915         unsigned long             hard_resets;          /* driver forced bus resets count */
 916         unsigned long             soft_resets;          /* fw/external bus resets count */
 917         unsigned long             timeouts;             /* cmd timeouts */
 918 } MPT_SCSI_HOST;
 919
 920 /*
 921  *      Structure for overlaying onto scsi_cmnd->SCp area
 922  *      NOTE: SCp area is 36 bytes min, 44 bytes max?
 923  */
 924 typedef struct _scPrivate {
 925         struct scsi_cmnd        *forw;
 926         struct scsi_cmnd        *back;
 927         void                    *p1;
 928         void                    *p2;
 929         u8                       io_path_id;    /* DMP */
 930         u8                       pad[7];
 931 } scPrivate;
 932
 933 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
 934 /*
 935  *      More Dynamic Multi-Pathing stuff...
 936  */
 937
 938 /* Forward decl, a strange C thing, to prevent gcc compiler warnings */
 939 struct scsi_cmnd;
 940
 941 /*
 942  *      DMP service layer structure / API interface
 943  */
 944 typedef struct _DmpServices {
 945         VirtDevTracker    VdevList;
 946         struct semaphore *Daemon;
 947         int             (*ScsiPathSelect)
 948                                 (struct scsi_cmnd *, MPT_SCSI_HOST **hd, int *target, int *lun);
 949         int             (*DmpIoDoneChk)
 950                                 (MPT_SCSI_HOST *, struct scsi_cmnd *,
 951                                  SCSIIORequest_t *,
 952                                  SCSIIOReply_t *);
 953         void            (*mptscsih_scanVlist)
 954                                 (MPT_SCSI_HOST *, int portnum);
 955         int             (*ScsiAbort)
 956                                 (struct scsi_cmnd *);
 957         int             (*ScsiBusReset)
 958                                 (struct scsi_cmnd *);
 959 } DmpServices_t;
 960
 961 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
 962 /*
 963  * Generic structure passed to the base mpt_config function.
 964  */
 965 typedef struct _x_config_parms {
 966         Q_ITEM                   linkage;       /* linked list */
 967         struct timer_list        timer;         /* timer function for this request  */
 968         ConfigPageHeader_t      *hdr;
 969         dma_addr_t               physAddr;
 970         int                      wait_done;     /* wait for this request */
 971         u32                      pageAddr;      /* properly formatted */
 972         u8                       action;
 973         u8                       dir;
 974         u8                       timeout;       /* seconds */
 975         u8                       pad1;
 976         u16                      status;
 977         u16                      pad2;
 978 } CONFIGPARMS;
 979
 980 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
 981 /*
 982  *  Public entry points...
 983  */
 984 extern int       mpt_register(MPT_CALLBACK cbfunc, MPT_DRIVER_CLASS dclass);
 985 extern void      mpt_deregister(int cb_idx);
 986 extern int       mpt_event_register(int cb_idx, MPT_EVHANDLER ev_cbfunc);
 987 extern void      mpt_event_deregister(int cb_idx);
 988 extern int       mpt_reset_register(int cb_idx, MPT_RESETHANDLER reset_func);
 989 extern void      mpt_reset_deregister(int cb_idx);
 990 extern int       mpt_register_ascqops_strings(void *ascqTable, int ascqtbl_sz, const char **opsTable);
 991 extern void      mpt_deregister_ascqops_strings(void);
 992 extern MPT_FRAME_HDR    *mpt_get_msg_frame(int handle, int iocid);
 993 extern void      mpt_free_msg_frame(int handle, int iocid, MPT_FRAME_HDR *mf);
 994 extern void      mpt_put_msg_frame(int handle, int iocid, MPT_FRAME_HDR *mf);
 995 extern void      mpt_add_sge(char *pAddr, u32 flagslength, dma_addr_t dma_addr);
 996 extern void      mpt_add_chain(char *pAddr, u8 next, u16 length, dma_addr_t dma_addr);
 997
 998 extern int       mpt_send_handshake_request(int handle, int iocid, int reqBytes, u32 *req, int sleepFlag);
 999 extern int       mpt_handshake_req_reply_wait(MPT_ADAPTER *ioc, int reqBytes, u32 *req, int replyBytes, u16 *u16reply, int maxwait, int sleepFlag);
1000 extern int       mpt_verify_adapter(int iocid, MPT_ADAPTER **iocpp);
1001 extern MPT_ADAPTER      *mpt_adapter_find_first(void);
1002 extern MPT_ADAPTER      *mpt_adapter_find_next(MPT_ADAPTER *prev);
1003 extern u32       mpt_GetIocState(MPT_ADAPTER *ioc, int cooked);
1004 extern void      mpt_print_ioc_summary(MPT_ADAPTER *ioc, char *buf, int *size, int len, int showlan);
1005 extern int       mpt_HardResetHandler(MPT_ADAPTER *ioc, int sleepFlag);
1006 extern int       mpt_config(MPT_ADAPTER *ioc, CONFIGPARMS *cfg);
1007 extern void     *mpt_alloc_fw_memory(MPT_ADAPTER *ioc, int size, int *frags, int *alloc_sz);
1008 extern void      mpt_free_fw_memory(MPT_ADAPTER *ioc, fw_image_t **alt_img);
1009
1010 /*
1011  *  Public data decl's...
1012  */
1013 extern MPT_ADAPTER              *mpt_adapters[MPT_MAX_ADAPTERS];
1014 extern struct proc_dir_entry    *mpt_proc_root_dir;
1015 extern DmpServices_t            *DmpService;
1016
1017 extern int                mpt_lan_index;        /* needed by mptlan.c */
1018 extern int                mpt_stm_index;        /* needed by mptstm.c */
1019
1020 extern void              *mpt_v_ASCQ_TablePtr;
1021 extern const char       **mpt_ScsiOpcodesPtr;
1022 extern int                mpt_ASCQ_TableSz;
1023
1024 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1025 #endif          /* } __KERNEL__ */
1026
1027 /*
1028  *  More (public) macros...
1029  */
1030 #ifndef MIN
1031 #define MIN(a, b)   (((a) < (b)) ? (a) : (b))
1032 #endif
1033 #ifndef MAX
1034 #define MAX(a, b)   (((a) > (b)) ? (a) : (b))
1035 #endif
1036
1037 #ifndef offsetof
1038 #define offsetof(t, m)  ((size_t) (&((t *)0)->m))
1039 #endif
1040
1041 #if defined(__alpha__) || defined(__sparc_v9__) || defined(__ia64__)
1042 #define CAST_U32_TO_PTR(x)      ((void *)(u64)x)
1043 #define CAST_PTR_TO_U32(x)      ((u32)(u64)x)
1044 #else
1045 #define CAST_U32_TO_PTR(x)      ((void *)x)
1046 #define CAST_PTR_TO_U32(x)      ((u32)x)
1047 #endif
1048
1049 #define MPT_PROTOCOL_FLAGS_c_c_c_c(pflags) \
1050         ((pflags) & MPI_PORTFACTS_PROTOCOL_INITIATOR)   ? 'I' : 'i',    \
1051         ((pflags) & MPI_PORTFACTS_PROTOCOL_TARGET)      ? 'T' : 't',    \
1052         ((pflags) & MPI_PORTFACTS_PROTOCOL_LAN)         ? 'L' : 'l',    \
1053         ((pflags) & MPI_PORTFACTS_PROTOCOL_LOGBUSADDR)  ? 'B' : 'b'
1054
1055 /*
1056  *  Shifted SGE Defines - Use in SGE with FlagsLength member.
1057  *  Otherwise, use MPI_xxx defines (refer to "lsi/mpi.h" header).
1058  *  Defaults: 32 bit SGE, SYSTEM_ADDRESS if direction bit is 0, read
1059  */
1060 #define MPT_TRANSFER_IOC_TO_HOST                (0x00000000)
1061 #define MPT_TRANSFER_HOST_TO_IOC                (0x04000000)
1062 #define MPT_SGE_FLAGS_LAST_ELEMENT              (0x80000000)
1063 #define MPT_SGE_FLAGS_END_OF_BUFFER             (0x40000000)
1064 #define MPT_SGE_FLAGS_LOCAL_ADDRESS             (0x08000000)
1065 #define MPT_SGE_FLAGS_DIRECTION                 (0x04000000)
1066 #define MPT_SGE_FLAGS_ADDRESSING                (mpt_addr_size() << MPI_SGE_FLAGS_SHIFT)
1067 #define MPT_SGE_FLAGS_END_OF_LIST               (0x01000000)
1068
1069 #define MPT_SGE_FLAGS_TRANSACTION_ELEMENT       (0x00000000)
1070 #define MPT_SGE_FLAGS_SIMPLE_ELEMENT            (0x10000000)
1071 #define MPT_SGE_FLAGS_CHAIN_ELEMENT             (0x30000000)
1072 #define MPT_SGE_FLAGS_ELEMENT_MASK              (0x30000000)
1073
1074 #define MPT_SGE_FLAGS_SSIMPLE_READ \
1075         (MPT_SGE_FLAGS_LAST_ELEMENT |   \
1076          MPT_SGE_FLAGS_END_OF_BUFFER |  \
1077          MPT_SGE_FLAGS_END_OF_LIST |    \
1078          MPT_SGE_FLAGS_SIMPLE_ELEMENT | \
1079          MPT_SGE_FLAGS_ADDRESSING | \
1080          MPT_TRANSFER_IOC_TO_HOST)
1081 #define MPT_SGE_FLAGS_SSIMPLE_WRITE \
1082         (MPT_SGE_FLAGS_LAST_ELEMENT |   \
1083          MPT_SGE_FLAGS_END_OF_BUFFER |  \
1084          MPT_SGE_FLAGS_END_OF_LIST |    \
1085          MPT_SGE_FLAGS_SIMPLE_ELEMENT | \
1086          MPT_SGE_FLAGS_ADDRESSING | \
1087          MPT_TRANSFER_HOST_TO_IOC)
1088
1089 /*}-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1090 #endif
1091