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