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