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.09"
  80 #define MPT_LINUX_PACKAGE_NAME          "@(#)mptlinux-3.03.09"
  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           0x50  /* 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         struct scsi_target      *starget;
 335         u8                       tflags;
 336         u8                       ioc_id;
 337         u8                       target_id;
 338         u8                       bus_id;
 339         u8                       minSyncFactor; /* 0xFF is async */
 340         u8                       maxOffset;     /* 0 if async */
 341         u8                       maxWidth;      /* 0 if narrow, 1 if wide */
 342         u8                       negoFlags;     /* bit field, see above */
 343         u8                       raidVolume;    /* set, if RAID Volume */
 344         u8                       type;          /* byte 0 of Inquiry data */
 345         u32                      num_luns;
 346         u32                      luns[8];               /* Max LUNs is 256 */
 347 } VirtTarget;
 348
 349 typedef struct _VirtDevice {
 350         VirtTarget              *vtarget;
 351         u8                       configured_lun;
 352         u32                      lun;
 353 } VirtDevice;
 354
 355 /*
 356  *  Fibre Channel (SCSI) target device and associated defines...
 357  */
 358 #define MPT_TARGET_DEFAULT_DV_STATUS    0x00
 359 #define MPT_TARGET_FLAGS_VALID_NEGO     0x01
 360 #define MPT_TARGET_FLAGS_VALID_INQUIRY  0x02
 361 #define MPT_TARGET_FLAGS_Q_YES          0x08
 362 #define MPT_TARGET_FLAGS_VALID_56       0x10
 363 #define MPT_TARGET_FLAGS_SAF_TE_ISSUED  0x20
 364 #define MPT_TARGET_FLAGS_RAID_COMPONENT 0x40
 365
 366 /*
 367  *      /proc/mpt interface
 368  */
 369 typedef struct {
 370         const char      *name;
 371         mode_t           mode;
 372         int              pad;
 373         read_proc_t     *read_proc;
 374         write_proc_t    *write_proc;
 375 } mpt_proc_entry_t;
 376
 377 #define MPT_PROC_READ_RETURN(buf,start,offset,request,eof,len) \
 378 do { \
 379         len -= offset;                  \
 380         if (len < request) {            \
 381                 *eof = 1;               \
 382                 if (len <= 0)           \
 383                         return 0;       \
 384         } else                          \
 385                 len = request;          \
 386         *start = buf + offset;          \
 387         return len;                     \
 388 } while (0)
 389
 390
 391 /*
 392  *      IOCTL structure and associated defines
 393  */
 394
 395 #define MPT_IOCTL_STATUS_DID_IOCRESET   0x01    /* IOC Reset occurred on the current*/
 396 #define MPT_IOCTL_STATUS_RF_VALID       0x02    /* The Reply Frame is VALID */
 397 #define MPT_IOCTL_STATUS_TIMER_ACTIVE   0x04    /* The timer is running */
 398 #define MPT_IOCTL_STATUS_SENSE_VALID    0x08    /* Sense data is valid */
 399 #define MPT_IOCTL_STATUS_COMMAND_GOOD   0x10    /* Command Status GOOD */
 400 #define MPT_IOCTL_STATUS_TMTIMER_ACTIVE 0x20    /* The TM timer is running */
 401 #define MPT_IOCTL_STATUS_TM_FAILED      0x40    /* User TM request failed */
 402
 403 #define MPTCTL_RESET_OK                 0x01    /* Issue Bus Reset */
 404
 405 typedef struct _MPT_IOCTL {
 406         struct _MPT_ADAPTER     *ioc;
 407         u8                       ReplyFrame[MPT_DEFAULT_FRAME_SIZE];    /* reply frame data */
 408         u8                       sense[MPT_SENSE_BUFFER_ALLOC];
 409         int                      wait_done;     /* wake-up value for this ioc */
 410         u8                       rsvd;
 411         u8                       status;        /* current command status */
 412         u8                       reset;         /* 1 if bus reset allowed */
 413         u8                       target;        /* target for reset */
 414         struct mutex             ioctl_mutex;
 415 } MPT_IOCTL;
 416
 417 #define MPT_SAS_MGMT_STATUS_RF_VALID    0x02    /* The Reply Frame is VALID */
 418 #define MPT_SAS_MGMT_STATUS_COMMAND_GOOD        0x10    /* Command Status GOOD */
 419 #define MPT_SAS_MGMT_STATUS_TM_FAILED   0x40    /* User TM request failed */
 420
 421 typedef struct _MPT_SAS_MGMT {
 422         struct mutex             mutex;
 423         struct completion        done;
 424         u8                       reply[MPT_DEFAULT_FRAME_SIZE]; /* reply frame data */
 425         u8                       status;        /* current command status */
 426 }MPT_SAS_MGMT;
 427
 428 /*
 429  *  Event Structure and define
 430  */
 431 #define MPTCTL_EVENT_LOG_SIZE           (0x000000032)
 432 typedef struct _mpt_ioctl_events {
 433         u32     event;          /* Specified by define above */
 434         u32     eventContext;   /* Index or counter */
 435         int     data[2];        /* First 8 bytes of Event Data */
 436 } MPT_IOCTL_EVENTS;
 437
 438 /*
 439  * CONFIGPARM status  defines
 440  */
 441 #define MPT_CONFIG_GOOD         MPI_IOCSTATUS_SUCCESS
 442 #define MPT_CONFIG_ERROR        0x002F
 443
 444 /*
 445  *      Substructure to store SCSI specific configuration page data
 446  */
 447                                                 /* dvStatus defines: */
 448 #define MPT_SCSICFG_USE_NVRAM           0x01    /* WriteSDP1 using NVRAM */
 449 #define MPT_SCSICFG_ALL_IDS             0x02    /* WriteSDP1 to all IDS */
 450 /* #define MPT_SCSICFG_BLK_NEGO         0x10       WriteSDP1 with WDTR and SDTR disabled */
 451
 452 typedef struct _SpiCfgData {
 453         u32              PortFlags;
 454         int             *nvram;                 /* table of device NVRAM values */
 455         IOCPage4_t      *pIocPg4;               /* SEP devices addressing */
 456         dma_addr_t       IocPg4_dma;            /* Phys Addr of IOCPage4 data */
 457         int              IocPg4Sz;              /* IOCPage4 size */
 458         u8               minSyncFactor;         /* 0xFF if async */
 459         u8               maxSyncOffset;         /* 0 if async */
 460         u8               maxBusWidth;           /* 0 if narrow, 1 if wide */
 461         u8               busType;               /* SE, LVD, HD */
 462         u8               sdp1version;           /* SDP1 version */
 463         u8               sdp1length;            /* SDP1 length  */
 464         u8               sdp0version;           /* SDP0 version */
 465         u8               sdp0length;            /* SDP0 length  */
 466         u8               dvScheduled;           /* 1 if scheduled */
 467         u8               noQas;                 /* Disable QAS for this adapter */
 468         u8               Saf_Te;                /* 1 to force all Processors as
 469                                                  * SAF-TE if Inquiry data length
 470                                                  * is too short to check for SAF-TE
 471                                                  */
 472         u8               bus_reset;             /* 1 to allow bus reset */
 473         u8               rsvd[1];
 474 }SpiCfgData;
 475
 476 typedef struct _SasCfgData {
 477         u8               ptClear;               /* 1 to automatically clear the
 478                                                  * persistent table.
 479                                                  * 0 to disable
 480                                                  * automatic clearing.
 481                                                  */
 482 }SasCfgData;
 483
 484 typedef struct _RaidCfgData {
 485         IOCPage2_t      *pIocPg2;               /* table of Raid Volumes */
 486         IOCPage3_t      *pIocPg3;               /* table of physical disks */
 487         int              isRaid;                /* bit field, 1 if RAID */
 488 }RaidCfgData;
 489
 490 #define MPT_RPORT_INFO_FLAGS_REGISTERED 0x01    /* rport registered */
 491 #define MPT_RPORT_INFO_FLAGS_MISSING    0x02    /* missing from DevPage0 scan */
 492
 493 /*
 494  * data allocated for each fc rport device
 495  */
 496 struct mptfc_rport_info
 497 {
 498         struct list_head list;
 499         struct fc_rport *rport;
 500         struct scsi_target *starget;
 501         FCDevicePage0_t pg0;
 502         u8              flags;
 503 };
 504
 505 /*
 506  *  Adapter Structure - pci_dev specific. Maximum: MPT_MAX_ADAPTERS
 507  */
 508 typedef struct _MPT_ADAPTER
 509 {
 510         int                      id;            /* Unique adapter id N {0,1,2,...} */
 511         int                      pci_irq;       /* This irq           */
 512         char                     name[MPT_NAME_LENGTH]; /* "iocN"             */
 513         char                    *prod_name;     /* "LSIFC9x9"         */
 514         SYSIF_REGS __iomem      *chip;          /* == c8817000 (mmap) */
 515         SYSIF_REGS __iomem      *pio_chip;      /* Programmed IO (downloadboot) */
 516         u8                       bus_type;
 517         u32                      mem_phys;      /* == f4020000 (mmap) */
 518         u32                      pio_mem_phys;  /* Programmed IO (downloadboot) */
 519         int                      mem_size;      /* mmap memory size */
 520         int                      alloc_total;
 521         u32                      last_state;
 522         int                      active;
 523         u8                      *alloc;         /* frames alloc ptr */
 524         dma_addr_t               alloc_dma;
 525         u32                      alloc_sz;
 526         MPT_FRAME_HDR           *reply_frames;  /* Reply msg frames - rounded up! */
 527         u32                      reply_frames_low_dma;
 528         int                      reply_depth;   /* Num Allocated reply frames */
 529         int                      reply_sz;      /* Reply frame size */
 530         int                      num_chain;     /* Number of chain buffers */
 531                 /* Pool of buffers for chaining. ReqToChain
 532                  * and ChainToChain track index of chain buffers.
 533                  * ChainBuffer (DMA) virt/phys addresses.
 534                  * FreeChainQ (lock) locking mechanisms.
 535                  */
 536         int                     *ReqToChain;
 537         int                     *RequestNB;
 538         int                     *ChainToChain;
 539         u8                      *ChainBuffer;
 540         dma_addr_t               ChainBufferDMA;
 541         struct list_head         FreeChainQ;
 542         spinlock_t               FreeChainQlock;
 543                 /* We (host driver) get to manage our own RequestQueue! */
 544         dma_addr_t               req_frames_dma;
 545         MPT_FRAME_HDR           *req_frames;    /* Request msg frames - rounded up! */
 546         u32                      req_frames_low_dma;
 547         int                      req_depth;     /* Number of request frames */
 548         int                      req_sz;        /* Request frame size (bytes) */
 549         spinlock_t               FreeQlock;
 550         struct list_head         FreeQ;
 551                 /* Pool of SCSI sense buffers for commands coming from
 552                  * the SCSI mid-layer.  We have one 256 byte sense buffer
 553                  * for each REQ entry.
 554                  */
 555         u8                      *sense_buf_pool;
 556         dma_addr_t               sense_buf_pool_dma;
 557         u32                      sense_buf_low_dma;
 558         u8                      *HostPageBuffer; /* SAS - host page buffer support */
 559         u32                     HostPageBuffer_sz;
 560         dma_addr_t              HostPageBuffer_dma;
 561         int                      mtrr_reg;
 562         struct pci_dev          *pcidev;        /* struct pci_dev pointer */
 563         u8                      __iomem *memmap;        /* mmap address */
 564         struct Scsi_Host        *sh;            /* Scsi Host pointer */
 565         SpiCfgData              spi_data;       /* Scsi config. data */
 566         RaidCfgData             raid_data;      /* Raid config. data */
 567         SasCfgData              sas_data;       /* Sas config. data */
 568         MPT_IOCTL               *ioctl;         /* ioctl data pointer */
 569         struct proc_dir_entry   *ioc_dentry;
 570         struct _MPT_ADAPTER     *alt_ioc;       /* ptr to 929 bound adapter port */
 571         spinlock_t               diagLock;      /* diagnostic reset lock */
 572         int                      diagPending;
 573         u32                      biosVersion;   /* BIOS version from IO Unit Page 2 */
 574         int                      eventTypes;    /* Event logging parameters */
 575         int                      eventContext;  /* Next event context */
 576         int                      eventLogSize;  /* Max number of cached events */
 577         struct _mpt_ioctl_events *events;       /* pointer to event log */
 578         u8                      *cached_fw;     /* Pointer to FW */
 579         dma_addr_t              cached_fw_dma;
 580         struct list_head         configQ;       /* linked list of config. requests */
 581         int                      hs_reply_idx;
 582 #ifndef MFCNT
 583         u32                      pad0;
 584 #else
 585         u32                      mfcnt;
 586 #endif
 587         u32                      NB_for_64_byte_frame;
 588         u32                      hs_req[MPT_MAX_FRAME_SIZE/sizeof(u32)];
 589         u16                      hs_reply[MPT_MAX_FRAME_SIZE/sizeof(u16)];
 590         IOCFactsReply_t          facts;
 591         PortFactsReply_t         pfacts[2];
 592         FCPortPage0_t            fc_port_page0[2];
 593         struct timer_list        persist_timer; /* persist table timer */
 594         int                      persist_wait_done; /* persist completion flag */
 595         u8                       persist_reply_frame[MPT_DEFAULT_FRAME_SIZE]; /* persist reply */
 596         LANPage0_t               lan_cnfg_page0;
 597         LANPage1_t               lan_cnfg_page1;
 598         /*
 599          * Description: errata_flag_1064
 600          * If a PCIX read occurs within 1 or 2 cycles after the chip receives
 601          * a split completion for a read data, an internal address pointer incorrectly
 602          * increments by 32 bytes
 603          */
 604         int                      errata_flag_1064;
 605         int                      aen_event_read_flag; /* flag to indicate event log was read*/
 606         u8                       FirstWhoInit;
 607         u8                       upload_fw;     /* If set, do a fw upload */
 608         u8                       reload_fw;     /* Force a FW Reload on next reset */
 609         u8                       NBShiftFactor;  /* NB Shift Factor based on Block Size (Facts)  */
 610         u8                       pad1[4];
 611         int                      DoneCtx;
 612         int                      TaskCtx;
 613         int                      InternalCtx;
 614         spinlock_t               initializing_hba_lock;
 615         int                      initializing_hba_lock_flag;
 616         struct list_head         list;
 617         struct net_device       *netdev;
 618         struct list_head         sas_topology;
 619         struct mutex             sas_topology_mutex;
 620         struct mutex             sas_discovery_mutex;
 621         u8                       sas_discovery_runtime;
 622         u8                       sas_discovery_ignore_events;
 623         int                      sas_index; /* index refrencing */
 624         MPT_SAS_MGMT             sas_mgmt;
 625         int                      num_ports;
 626         struct work_struct       mptscsih_persistTask;
 627
 628         struct list_head         fc_rports;
 629         spinlock_t               fc_rescan_work_lock;
 630         int                      fc_rescan_work_count;
 631         struct work_struct       fc_rescan_work;
 632         char                     fc_rescan_work_q_name[KOBJ_NAME_LEN];
 633         struct workqueue_struct *fc_rescan_work_q;
 634 } MPT_ADAPTER;
 635
 636 /*
 637  *  New return value convention:
 638  *    1 = Ok to free associated request frame
 639  *    0 = not Ok ...
 640  */
 641 typedef int (*MPT_CALLBACK)(MPT_ADAPTER *ioc, MPT_FRAME_HDR *req, MPT_FRAME_HDR *reply);
 642 typedef int (*MPT_EVHANDLER)(MPT_ADAPTER *ioc, EventNotificationReply_t *evReply);
 643 typedef int (*MPT_RESETHANDLER)(MPT_ADAPTER *ioc, int reset_phase);
 644 /* reset_phase defs */
 645 #define MPT_IOC_PRE_RESET               0
 646 #define MPT_IOC_POST_RESET              1
 647 #define MPT_IOC_SETUP_RESET             2
 648
 649 /*
 650  * Invent MPT host event (super-set of MPI Events)
 651  * Fitted to 1030's 64-byte [max] request frame size
 652  */
 653 typedef struct _MPT_HOST_EVENT {
 654         EventNotificationReply_t         MpiEvent;      /* 8 32-bit words! */
 655         u32                              pad[6];
 656         void                            *next;
 657 } MPT_HOST_EVENT;
 658
 659 #define MPT_HOSTEVENT_IOC_BRINGUP       0x91
 660 #define MPT_HOSTEVENT_IOC_RECOVER       0x92
 661
 662 /* Define the generic types based on the size
 663  * of the dma_addr_t type.
 664  */
 665 typedef struct _mpt_sge {
 666         u32             FlagsLength;
 667         dma_addr_t      Address;
 668 } MptSge_t;
 669
 670 #define mpt_addr_size() \
 671         ((sizeof(dma_addr_t) == sizeof(u64)) ? MPI_SGE_FLAGS_64_BIT_ADDRESSING : \
 672                 MPI_SGE_FLAGS_32_BIT_ADDRESSING)
 673
 674 #define mpt_msg_flags() \
 675         ((sizeof(dma_addr_t) == sizeof(u64)) ? MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_64 : \
 676                 MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_32)
 677
 678 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
 679 /*
 680  *  Funky (private) macros...
 681  */
 682 #ifdef MPT_DEBUG
 683 #define dprintk(x)  printk x
 684 #else
 685 #define dprintk(x)
 686 #endif
 687
 688 #ifdef MPT_DEBUG_INIT
 689 #define dinitprintk(x)  printk x
 690 #define DBG_DUMP_FW_REQUEST_FRAME(mfp) \
 691         {       int  i, n = 10;                                         \
 692                 u32 *m = (u32 *)(mfp);                                  \
 693                 printk(KERN_INFO " ");                                  \
 694                 for (i=0; i<n; i++)                                     \
 695                         printk(" %08x", le32_to_cpu(m[i]));             \
 696                 printk("\n");                                           \
 697         }
 698 #else
 699 #define dinitprintk(x)
 700 #define DBG_DUMP_FW_REQUEST_FRAME(mfp)
 701 #endif
 702
 703 #ifdef MPT_DEBUG_EXIT
 704 #define dexitprintk(x)  printk x
 705 #else
 706 #define dexitprintk(x)
 707 #endif
 708
 709 #if defined MPT_DEBUG_FAIL || defined (MPT_DEBUG_SG)
 710 #define dfailprintk(x) printk x
 711 #else
 712 #define dfailprintk(x)
 713 #endif
 714
 715 #ifdef MPT_DEBUG_HANDSHAKE
 716 #define dhsprintk(x)  printk x
 717 #else
 718 #define dhsprintk(x)
 719 #endif
 720
 721 #if defined(MPT_DEBUG_EVENTS) || defined(MPT_DEBUG_VERBOSE_EVENTS)
 722 #define devtprintk(x)  printk x
 723 #else
 724 #define devtprintk(x)
 725 #endif
 726
 727 #ifdef MPT_DEBUG_VERBOSE_EVENTS
 728 #define devtverboseprintk(x)  printk x
 729 #else
 730 #define devtverboseprintk(x)
 731 #endif
 732
 733 #ifdef MPT_DEBUG_RESET
 734 #define drsprintk(x)  printk x
 735 #else
 736 #define drsprintk(x)
 737 #endif
 738
 739 //#if defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
 740 #if defined(MPT_DEBUG_MSG_FRAME)
 741 #define dmfprintk(x)  printk x
 742 #define DBG_DUMP_REQUEST_FRAME(mfp) \
 743         {       int  i, n = 24;                                         \
 744                 u32 *m = (u32 *)(mfp);                                  \
 745                 for (i=0; i<n; i++) {                                   \
 746                         if (i && ((i%8)==0))                            \
 747                                 printk("\n");                           \
 748                         printk("%08x ", le32_to_cpu(m[i]));             \
 749                 }                                                       \
 750                 printk("\n");                                           \
 751         }
 752 #else
 753 #define dmfprintk(x)
 754 #define DBG_DUMP_REQUEST_FRAME(mfp)
 755 #endif
 756
 757 #ifdef MPT_DEBUG_IRQ
 758 #define dirqprintk(x)  printk x
 759 #else
 760 #define dirqprintk(x)
 761 #endif
 762
 763 #ifdef MPT_DEBUG_SG
 764 #define dsgprintk(x)  printk x
 765 #else
 766 #define dsgprintk(x)
 767 #endif
 768
 769 #if defined(MPT_DEBUG_DL) || defined(MPT_DEBUG)
 770 #define ddlprintk(x)  printk x
 771 #else
 772 #define ddlprintk(x)
 773 #endif
 774
 775 #ifdef MPT_DEBUG_DV
 776 #define ddvprintk(x)  printk x
 777 #else
 778 #define ddvprintk(x)
 779 #endif
 780
 781 #ifdef MPT_DEBUG_NEGO
 782 #define dnegoprintk(x)  printk x
 783 #else
 784 #define dnegoprintk(x)
 785 #endif
 786
 787 #if defined(MPT_DEBUG_DV) || defined(MPT_DEBUG_DV_TINY)
 788 #define ddvtprintk(x)  printk x
 789 #else
 790 #define ddvtprintk(x)
 791 #endif
 792
 793 #ifdef MPT_DEBUG_IOCTL
 794 #define dctlprintk(x) printk x
 795 #else
 796 #define dctlprintk(x)
 797 #endif
 798
 799 #ifdef MPT_DEBUG_REPLY
 800 #define dreplyprintk(x) printk x
 801 #else
 802 #define dreplyprintk(x)
 803 #endif
 804
 805 #ifdef DMPT_DEBUG_FC
 806 #define dfcprintk(x) printk x
 807 #else
 808 #define dfcprintk(x)
 809 #endif
 810
 811 #ifdef MPT_DEBUG_TM
 812 #define dtmprintk(x) printk x
 813 #define DBG_DUMP_TM_REQUEST_FRAME(mfp) \
 814         {       u32 *m = (u32 *)(mfp);                                  \
 815                 int  i, n = 13;                                         \
 816                 printk("TM_REQUEST:\n");                                \
 817                 for (i=0; i<n; i++) {                                   \
 818                         if (i && ((i%8)==0))                            \
 819                                 printk("\n");                           \
 820                         printk("%08x ", le32_to_cpu(m[i]));             \
 821                 }                                                       \
 822                 printk("\n");                                           \
 823         }
 824 #define DBG_DUMP_TM_REPLY_FRAME(mfp) \
 825         {       u32 *m = (u32 *)(mfp);                                  \
 826                 int  i, n = (le32_to_cpu(m[0]) & 0x00FF0000) >> 16;     \
 827                 printk("TM_REPLY MessageLength=%d:\n", n);              \
 828                 for (i=0; i<n; i++) {                                   \
 829                         if (i && ((i%8)==0))                            \
 830                                 printk("\n");                           \
 831                         printk(" %08x", le32_to_cpu(m[i]));             \
 832                 }                                                       \
 833                 printk("\n");                                           \
 834         }
 835 #else
 836 #define dtmprintk(x)
 837 #define DBG_DUMP_TM_REQUEST_FRAME(mfp)
 838 #define DBG_DUMP_TM_REPLY_FRAME(mfp)
 839 #endif
 840
 841 #if defined(MPT_DEBUG_CONFIG) || defined(MPT_DEBUG)
 842 #define dcprintk(x) printk x
 843 #else
 844 #define dcprintk(x)
 845 #endif
 846
 847 #if defined(MPT_DEBUG_SCSI) || defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
 848 #define dsprintk(x) printk x
 849 #else
 850 #define dsprintk(x)
 851 #endif
 852
 853
 854 #define MPT_INDEX_2_MFPTR(ioc,idx) \
 855         (MPT_FRAME_HDR*)( (u8*)(ioc)->req_frames + (ioc)->req_sz * (idx) )
 856
 857 #define MFPTR_2_MPT_INDEX(ioc,mf) \
 858         (int)( ((u8*)mf - (u8*)(ioc)->req_frames) / (ioc)->req_sz )
 859
 860 #define MPT_INDEX_2_RFPTR(ioc,idx) \
 861         (MPT_FRAME_HDR*)( (u8*)(ioc)->reply_frames + (ioc)->req_sz * (idx) )
 862
 863 #if defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
 864 #define DBG_DUMP_REPLY_FRAME(mfp) \
 865         {       u32 *m = (u32 *)(mfp);                                  \
 866                 int  i, n = (le32_to_cpu(m[0]) & 0x00FF0000) >> 16;     \
 867                 printk(KERN_INFO " ");                                  \
 868                 for (i=0; i<n; i++)                                     \
 869                         printk(" %08x", le32_to_cpu(m[i]));             \
 870                 printk("\n");                                           \
 871         }
 872 #define DBG_DUMP_REQUEST_FRAME_HDR(mfp) \
 873         {       int  i, n = 3;                                          \
 874                 u32 *m = (u32 *)(mfp);                                  \
 875                 printk(KERN_INFO " ");                                  \
 876                 for (i=0; i<n; i++)                                     \
 877                         printk(" %08x", le32_to_cpu(m[i]));             \
 878                 printk("\n");                                           \
 879         }
 880 #else
 881 #define DBG_DUMP_REPLY_FRAME(mfp)
 882 #define DBG_DUMP_REQUEST_FRAME_HDR(mfp)
 883 #endif
 884
 885
 886 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
 887
 888 #define SCSI_STD_SENSE_BYTES    18
 889 #define SCSI_STD_INQUIRY_BYTES  36
 890 #define SCSI_MAX_INQUIRY_BYTES  96
 891
 892 /*
 893  * MPT_SCSI_HOST defines - Used by the IOCTL and the SCSI drivers
 894  * Private to the driver.
 895  */
 896 /* LOCAL structure and fields used when processing
 897  * internally generated commands. These include:
 898  * bus scan, dv and config requests.
 899  */
 900 typedef struct _MPT_LOCAL_REPLY {
 901         ConfigPageHeader_t header;
 902         int     completion;
 903         u8      sense[SCSI_STD_SENSE_BYTES];
 904         u8      scsiStatus;
 905         u8      skip;
 906         u32     pad;
 907 } MPT_LOCAL_REPLY;
 908
 909 #define MPT_HOST_BUS_UNKNOWN            (0xFF)
 910 #define MPT_HOST_TOO_MANY_TM            (0x05)
 911 #define MPT_HOST_NVRAM_INVALID          (0xFFFFFFFF)
 912 #define MPT_HOST_NO_CHAIN               (0xFFFFFFFF)
 913 #define MPT_NVRAM_MASK_TIMEOUT          (0x000000FF)
 914 #define MPT_NVRAM_SYNC_MASK             (0x0000FF00)
 915 #define MPT_NVRAM_SYNC_SHIFT            (8)
 916 #define MPT_NVRAM_DISCONNECT_ENABLE     (0x00010000)
 917 #define MPT_NVRAM_ID_SCAN_ENABLE        (0x00020000)
 918 #define MPT_NVRAM_LUN_SCAN_ENABLE       (0x00040000)
 919 #define MPT_NVRAM_TAG_QUEUE_ENABLE      (0x00080000)
 920 #define MPT_NVRAM_WIDE_DISABLE          (0x00100000)
 921 #define MPT_NVRAM_BOOT_CHOICE           (0x00200000)
 922
 923 /* The TM_STATE variable is used to provide strict single threading of TM
 924  * requests as well as communicate TM error conditions.
 925  */
 926 #define TM_STATE_NONE          (0)
 927 #define TM_STATE_IN_PROGRESS   (1)
 928 #define TM_STATE_ERROR         (2)
 929
 930 typedef enum {
 931         FC,
 932         SPI,
 933         SAS
 934 } BUS_TYPE;
 935
 936 typedef struct _MPT_SCSI_HOST {
 937         MPT_ADAPTER              *ioc;
 938         int                       port;
 939         u32                       pad0;
 940         struct scsi_cmnd        **ScsiLookup;
 941         VirtTarget              **Targets;
 942         MPT_LOCAL_REPLY          *pLocal;               /* used for internal commands */
 943         struct timer_list         timer;
 944                 /* Pool of memory for holding SCpnts before doing
 945                  * OS callbacks. freeQ is the free pool.
 946                  */
 947         u8                        tmPending;
 948         u8                        resetPending;
 949         u8                        negoNvram;            /* DV disabled, nego NVRAM */
 950         u8                        pad1;
 951         u8                        tmState;
 952         u8                        rsvd[2];
 953         MPT_FRAME_HDR            *cmdPtr;               /* Ptr to nonOS request */
 954         struct scsi_cmnd         *abortSCpnt;
 955         MPT_LOCAL_REPLY           localReply;           /* internal cmd reply struct */
 956         unsigned long             hard_resets;          /* driver forced bus resets count */
 957         unsigned long             soft_resets;          /* fw/external bus resets count */
 958         unsigned long             timeouts;             /* cmd timeouts */
 959         ushort                    sel_timeout[MPT_MAX_FC_DEVICES];
 960         char                      *info_kbuf;
 961         wait_queue_head_t         scandv_waitq;
 962         int                       scandv_wait_done;
 963         long                      last_queue_full;
 964         u8                        mpt_pq_filter;
 965 } MPT_SCSI_HOST;
 966
 967 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
 968 /*
 969  *      More Dynamic Multi-Pathing stuff...
 970  */
 971
 972 /* Forward decl, a strange C thing, to prevent gcc compiler warnings */
 973 struct scsi_cmnd;
 974
 975 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
 976 /*
 977  * Generic structure passed to the base mpt_config function.
 978  */
 979 typedef struct _x_config_parms {
 980         struct list_head         linkage;       /* linked list */
 981         struct timer_list        timer;         /* timer function for this request  */
 982         union {
 983                 ConfigExtendedPageHeader_t      *ehdr;
 984                 ConfigPageHeader_t      *hdr;
 985         } cfghdr;
 986         dma_addr_t               physAddr;
 987         int                      wait_done;     /* wait for this request */
 988         u32                      pageAddr;      /* properly formatted */
 989         u8                       action;
 990         u8                       dir;
 991         u8                       timeout;       /* seconds */
 992         u8                       pad1;
 993         u16                      status;
 994         u16                      pad2;
 995 } CONFIGPARMS;
 996
 997 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
 998 /*
 999  *  Public entry points...
1000  */
1001 extern int       mpt_attach(struct pci_dev *pdev, const struct pci_device_id *id);
1002 extern void      mpt_detach(struct pci_dev *pdev);
1003 #ifdef CONFIG_PM
1004 extern int       mpt_suspend(struct pci_dev *pdev, pm_message_t state);
1005 extern int       mpt_resume(struct pci_dev *pdev);
1006 #endif
1007 extern int       mpt_register(MPT_CALLBACK cbfunc, MPT_DRIVER_CLASS dclass);
1008 extern void      mpt_deregister(int cb_idx);
1009 extern int       mpt_event_register(int cb_idx, MPT_EVHANDLER ev_cbfunc);
1010 extern void      mpt_event_deregister(int cb_idx);
1011 extern int       mpt_reset_register(int cb_idx, MPT_RESETHANDLER reset_func);
1012 extern void      mpt_reset_deregister(int cb_idx);
1013 extern int       mpt_device_driver_register(struct mpt_pci_driver * dd_cbfunc, int cb_idx);
1014 extern void      mpt_device_driver_deregister(int cb_idx);
1015 extern MPT_FRAME_HDR    *mpt_get_msg_frame(int handle, MPT_ADAPTER *ioc);
1016 extern void      mpt_free_msg_frame(MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);
1017 extern void      mpt_put_msg_frame(int handle, MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);
1018 extern void      mpt_add_sge(char *pAddr, u32 flagslength, dma_addr_t dma_addr);
1019
1020 extern int       mpt_send_handshake_request(int handle, MPT_ADAPTER *ioc, int reqBytes, u32 *req, int sleepFlag);
1021 extern int       mpt_verify_adapter(int iocid, MPT_ADAPTER **iocpp);
1022 extern u32       mpt_GetIocState(MPT_ADAPTER *ioc, int cooked);
1023 extern void      mpt_print_ioc_summary(MPT_ADAPTER *ioc, char *buf, int *size, int len, int showlan);
1024 extern int       mpt_HardResetHandler(MPT_ADAPTER *ioc, int sleepFlag);
1025 extern int       mpt_config(MPT_ADAPTER *ioc, CONFIGPARMS *cfg);
1026 extern void      mpt_alloc_fw_memory(MPT_ADAPTER *ioc, int size);
1027 extern void      mpt_free_fw_memory(MPT_ADAPTER *ioc);
1028 extern int       mpt_findImVolumes(MPT_ADAPTER *ioc);
1029 extern int       mptbase_sas_persist_operation(MPT_ADAPTER *ioc, u8 persist_opcode);
1030 extern int       mptbase_GetFcPortPage0(MPT_ADAPTER *ioc, int portnum);
1031
1032 /*
1033  *  Public data decl's...
1034  */
1035 extern struct list_head   ioc_list;
1036 extern struct proc_dir_entry    *mpt_proc_root_dir;
1037
1038 extern int                mpt_lan_index;        /* needed by mptlan.c */
1039 extern int                mpt_stm_index;        /* needed by mptstm.c */
1040
1041 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1042 #endif          /* } __KERNEL__ */
1043
1044 #if defined(__alpha__) || defined(__sparc_v9__) || defined(__ia64__) || defined(__x86_64__)
1045 #define CAST_U32_TO_PTR(x)      ((void *)(u64)x)
1046 #define CAST_PTR_TO_U32(x)      ((u32)(u64)x)
1047 #else
1048 #define CAST_U32_TO_PTR(x)      ((void *)x)
1049 #define CAST_PTR_TO_U32(x)      ((u32)x)
1050 #endif
1051
1052 #define MPT_PROTOCOL_FLAGS_c_c_c_c(pflags) \
1053         ((pflags) & MPI_PORTFACTS_PROTOCOL_INITIATOR)   ? 'I' : 'i',    \
1054         ((pflags) & MPI_PORTFACTS_PROTOCOL_TARGET)      ? 'T' : 't',    \
1055         ((pflags) & MPI_PORTFACTS_PROTOCOL_LAN)         ? 'L' : 'l',    \
1056         ((pflags) & MPI_PORTFACTS_PROTOCOL_LOGBUSADDR)  ? 'B' : 'b'
1057
1058 /*
1059  *  Shifted SGE Defines - Use in SGE with FlagsLength member.
1060  *  Otherwise, use MPI_xxx defines (refer to "lsi/mpi.h" header).
1061  *  Defaults: 32 bit SGE, SYSTEM_ADDRESS if direction bit is 0, read
1062  */
1063 #define MPT_TRANSFER_IOC_TO_HOST                (0x00000000)
1064 #define MPT_TRANSFER_HOST_TO_IOC                (0x04000000)
1065 #define MPT_SGE_FLAGS_LAST_ELEMENT              (0x80000000)
1066 #define MPT_SGE_FLAGS_END_OF_BUFFER             (0x40000000)
1067 #define MPT_SGE_FLAGS_LOCAL_ADDRESS             (0x08000000)
1068 #define MPT_SGE_FLAGS_DIRECTION                 (0x04000000)
1069 #define MPT_SGE_FLAGS_ADDRESSING                (mpt_addr_size() << MPI_SGE_FLAGS_SHIFT)
1070 #define MPT_SGE_FLAGS_END_OF_LIST               (0x01000000)
1071
1072 #define MPT_SGE_FLAGS_TRANSACTION_ELEMENT       (0x00000000)
1073 #define MPT_SGE_FLAGS_SIMPLE_ELEMENT            (0x10000000)
1074 #define MPT_SGE_FLAGS_CHAIN_ELEMENT             (0x30000000)
1075 #define MPT_SGE_FLAGS_ELEMENT_MASK              (0x30000000)
1076
1077 #define MPT_SGE_FLAGS_SSIMPLE_READ \
1078         (MPT_SGE_FLAGS_LAST_ELEMENT |   \
1079          MPT_SGE_FLAGS_END_OF_BUFFER |  \
1080          MPT_SGE_FLAGS_END_OF_LIST |    \
1081          MPT_SGE_FLAGS_SIMPLE_ELEMENT | \
1082          MPT_SGE_FLAGS_ADDRESSING | \
1083          MPT_TRANSFER_IOC_TO_HOST)
1084 #define MPT_SGE_FLAGS_SSIMPLE_WRITE \
1085         (MPT_SGE_FLAGS_LAST_ELEMENT |   \
1086          MPT_SGE_FLAGS_END_OF_BUFFER |  \
1087          MPT_SGE_FLAGS_END_OF_LIST |    \
1088          MPT_SGE_FLAGS_SIMPLE_ELEMENT | \
1089          MPT_SGE_FLAGS_ADDRESSING | \
1090          MPT_TRANSFER_HOST_TO_IOC)
1091
1092 /*}-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1093 #endif
1094