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