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/kernel.h>
  53 #include <linux/pci.h>
  54
  55 #include "lsi/mpi_type.h"
  56 #include "lsi/mpi.h"            /* Fusion MPI(nterface) basic defs */
  57 #include "lsi/mpi_ioc.h"        /* Fusion MPT IOC(ontroller) defs */
  58 #include "lsi/mpi_cnfg.h"       /* IOC configuration support */
  59 #include "lsi/mpi_init.h"       /* SCSI Host (initiator) protocol support */
  60 #include "lsi/mpi_lan.h"        /* LAN over FC protocol support */
  61 #include "lsi/mpi_raid.h"       /* Integrated Mirroring support */
  62
  63 #include "lsi/mpi_fc.h"         /* Fibre Channel (lowlevel) support */
  64 #include "lsi/mpi_targ.h"       /* SCSI/FCP Target protcol support */
  65 #include "lsi/mpi_tool.h"       /* Tools support */
  66 #include "lsi/mpi_sas.h"        /* SAS support */
  67
  68 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
  69
  70 #ifndef MODULEAUTHOR
  71 #define MODULEAUTHOR    "LSI Logic Corporation"
  72 #endif
  73
  74 #ifndef COPYRIGHT
  75 #define COPYRIGHT       "Copyright (c) 1999-2005 " MODULEAUTHOR
  76 #endif
  77
  78 #define MPT_LINUX_VERSION_COMMON        "3.04.00"
  79 #define MPT_LINUX_PACKAGE_NAME          "@(#)mptlinux-3.04.00"
  80 #define WHAT_MAGIC_STRING               "@" "(" "#" ")"
  81
  82 #define show_mptmod_ver(s,ver)  \
  83         printk(KERN_INFO "%s %s\n", s, ver);
  84
  85 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
  86 /*
  87  *  Fusion MPT(linux) driver configurable stuff...
  88  */
  89 #define MPT_MAX_ADAPTERS                18
  90 #define MPT_MAX_PROTOCOL_DRIVERS        16
  91 #define MPT_MAX_BUS                     1       /* Do not change */
  92 #define MPT_MAX_FC_DEVICES              255
  93 #define MPT_MAX_SCSI_DEVICES            16
  94 #define MPT_LAST_LUN                    255
  95 #define MPT_SENSE_BUFFER_ALLOC          64
  96         /* allow for 256 max sense alloc, but only 255 max request */
  97 #if MPT_SENSE_BUFFER_ALLOC >= 256
  98 #       undef MPT_SENSE_BUFFER_ALLOC
  99 #       define MPT_SENSE_BUFFER_ALLOC   256
 100 #       define MPT_SENSE_BUFFER_SIZE    255
 101 #else
 102 #       define MPT_SENSE_BUFFER_SIZE    MPT_SENSE_BUFFER_ALLOC
 103 #endif
 104
 105 #define MPT_NAME_LENGTH                 32
 106
 107 #define MPT_PROCFS_MPTBASEDIR           "mpt"
 108                                                 /* chg it to "driver/fusion" ? */
 109 #define MPT_PROCFS_SUMMARY_ALL_NODE             MPT_PROCFS_MPTBASEDIR "/summary"
 110 #define MPT_PROCFS_SUMMARY_ALL_PATHNAME         "/proc/" MPT_PROCFS_SUMMARY_ALL_NODE
 111 #define MPT_FW_REV_MAGIC_ID_STRING              "FwRev="
 112
 113 #define  MPT_MAX_REQ_DEPTH              1023
 114 #define  MPT_DEFAULT_REQ_DEPTH          256
 115 #define  MPT_MIN_REQ_DEPTH              128
 116
 117 #define  MPT_MAX_REPLY_DEPTH            MPT_MAX_REQ_DEPTH
 118 #define  MPT_DEFAULT_REPLY_DEPTH        128
 119 #define  MPT_MIN_REPLY_DEPTH            8
 120 #define  MPT_MAX_REPLIES_PER_ISR        32
 121
 122 #define  MPT_MAX_FRAME_SIZE             128
 123 #define  MPT_DEFAULT_FRAME_SIZE         128
 124
 125 #define  MPT_REPLY_FRAME_SIZE           0x50  /* Must be a multiple of 8 */
 126
 127 #define  MPT_SG_REQ_128_SCALE           1
 128 #define  MPT_SG_REQ_96_SCALE            2
 129 #define  MPT_SG_REQ_64_SCALE            4
 130
 131 #define  CAN_SLEEP                      1
 132 #define  NO_SLEEP                       0
 133
 134 #define MPT_COALESCING_TIMEOUT          0x10
 135
 136 /*
 137  * SCSI transfer rate defines.
 138  */
 139 #define MPT_ULTRA320                    0x08
 140 #define MPT_ULTRA160                    0x09
 141 #define MPT_ULTRA2                      0x0A
 142 #define MPT_ULTRA                       0x0C
 143 #define MPT_FAST                        0x19
 144 #define MPT_SCSI                        0x32
 145 #define MPT_ASYNC                       0xFF
 146
 147 #define MPT_NARROW                      0
 148 #define MPT_WIDE                        1
 149
 150 #define C0_1030                         0x08
 151 #define XL_929                          0x01
 152
 153
 154 /*
 155  *      Try to keep these at 2^N-1
 156  */
 157 #define MPT_FC_CAN_QUEUE        127
 158 #define MPT_SCSI_CAN_QUEUE      127
 159
 160 /*
 161  * Set the MAX_SGE value based on user input.
 162  */
 163 #ifdef  CONFIG_FUSION_MAX_SGE
 164 #if     CONFIG_FUSION_MAX_SGE  < 16
 165 #define MPT_SCSI_SG_DEPTH       16
 166 #elif   CONFIG_FUSION_MAX_SGE  > 128
 167 #define MPT_SCSI_SG_DEPTH       128
 168 #else
 169 #define MPT_SCSI_SG_DEPTH       CONFIG_FUSION_MAX_SGE
 170 #endif
 171 #else
 172 #define MPT_SCSI_SG_DEPTH       40
 173 #endif
 174
 175 #ifdef __KERNEL__       /* { */
 176 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
 177
 178 #include <linux/proc_fs.h>
 179
 180 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
 181 /*
 182  * Attempt semi-consistent error & warning msgs across
 183  * MPT drivers.  NOTE: Users of these macro defs must
 184  * themselves define their own MYNAM.
 185  */
 186 #define MYIOC_s_INFO_FMT                KERN_INFO MYNAM ": %s: "
 187 #define MYIOC_s_NOTE_FMT                KERN_NOTICE MYNAM ": %s: "
 188 #define MYIOC_s_WARN_FMT                KERN_WARNING MYNAM ": %s: WARNING - "
 189 #define MYIOC_s_ERR_FMT                 KERN_ERR MYNAM ": %s: ERROR - "
 190
 191 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
 192 /*
 193  *  MPT protocol driver defs...
 194  */
 195 typedef enum {
 196         MPTBASE_DRIVER,         /* MPT base class */
 197         MPTCTL_DRIVER,          /* MPT ioctl class */
 198         MPTSPI_DRIVER,          /* MPT SPI host class */
 199         MPTFC_DRIVER,           /* MPT FC host class */
 200         MPTSAS_DRIVER,          /* MPT SAS host class */
 201         MPTLAN_DRIVER,          /* MPT LAN class */
 202         MPTSTM_DRIVER,          /* MPT SCSI target mode class */
 203         MPTUNKNOWN_DRIVER
 204 } MPT_DRIVER_CLASS;
 205
 206 struct mpt_pci_driver{
 207         int  (*probe) (struct pci_dev *dev, const struct pci_device_id *id);
 208         void (*remove) (struct pci_dev *dev);
 209 };
 210
 211 /*
 212  *  MPT adapter / port / bus / device info structures...
 213  */
 214
 215 typedef union _MPT_FRAME_TRACKER {
 216         struct {
 217                 struct list_head        list;
 218                 u32                      arg1;
 219                 u32                      pad;
 220                 void                    *argp1;
 221         } linkage;
 222         /*
 223          * NOTE: When request frames are free, on the linkage structure
 224          * contets are valid.  All other values are invalid.
 225          * In particular, do NOT reply on offset [2]
 226          * (in words) being the * message context.
 227          * The message context must be reset (computed via base address
 228          * + an offset) prior to issuing any command.
 229          *
 230          * NOTE2: On non-32-bit systems, where pointers are LARGE,
 231          * using the linkage pointers destroys our sacred MsgContext
 232          * field contents.  But we don't care anymore because these
 233          * are now reset in mpt_put_msg_frame() just prior to sending
 234          * a request off to the IOC.
 235          */
 236         struct {
 237                 u32 __hdr[2];
 238                 /*
 239                  * The following _MUST_ match the location of the
 240                  * MsgContext field in the MPT message headers.
 241                  */
 242                 union {
 243                         u32              MsgContext;
 244                         struct {
 245                                 u16      req_idx;       /* Request index */
 246                                 u8       cb_idx;        /* callback function index */
 247                                 u8       rsvd;
 248                         } fld;
 249                 } msgctxu;
 250         } hwhdr;
 251         /*
 252          * Remark: 32 bit identifier:
 253          *  31-24: reserved
 254          *  23-16: call back index
 255          *  15-0 : request index
 256          */
 257 } MPT_FRAME_TRACKER;
 258
 259 /*
 260  *  We might want to view/access a frame as:
 261  *    1) generic request header
 262  *    2) SCSIIORequest
 263  *    3) SCSIIOReply
 264  *    4) MPIDefaultReply
 265  *    5) frame tracker
 266  */
 267 typedef struct _MPT_FRAME_HDR {
 268         union {
 269                 MPIHeader_t             hdr;
 270                 SCSIIORequest_t         scsireq;
 271                 SCSIIOReply_t           sreply;
 272                 ConfigReply_t           configreply;
 273                 MPIDefaultReply_t       reply;
 274                 MPT_FRAME_TRACKER       frame;
 275         } u;
 276 } MPT_FRAME_HDR;
 277
 278 #define MPT_REQ_MSGFLAGS_DROPME         0x80
 279
 280 typedef struct _MPT_SGL_HDR {
 281         SGESimple32_t    sge[1];
 282 } MPT_SGL_HDR;
 283
 284 typedef struct _MPT_SGL64_HDR {
 285         SGESimple64_t    sge[1];
 286 } MPT_SGL64_HDR;
 287
 288 /*
 289  *  System interface register set
 290  */
 291
 292 typedef struct _SYSIF_REGS
 293 {
 294         u32     Doorbell;       /* 00     System<->IOC Doorbell reg  */
 295         u32     WriteSequence;  /* 04     Write Sequence register    */
 296         u32     Diagnostic;     /* 08     Diagnostic register        */
 297         u32     TestBase;       /* 0C     Test Base Address          */
 298         u32     DiagRwData;     /* 10     Read Write Data (fw download)   */
 299         u32     DiagRwAddress;  /* 14     Read Write Address (fw download)*/
 300         u32     Reserved1[6];   /* 18-2F  reserved for future use    */
 301         u32     IntStatus;      /* 30     Interrupt Status           */
 302         u32     IntMask;        /* 34     Interrupt Mask             */
 303         u32     Reserved2[2];   /* 38-3F  reserved for future use    */
 304         u32     RequestFifo;    /* 40     Request Post/Free FIFO     */
 305         u32     ReplyFifo;      /* 44     Reply   Post/Free FIFO     */
 306         u32     Reserved3[2];   /* 48-4F  reserved for future use    */
 307         u32     HostIndex;      /* 50     Host Index register        */
 308         u32     Reserved4[15];  /* 54-8F                             */
 309         u32     Fubar;          /* 90     For Fubar usage            */
 310         u32     Reserved5[1050];/* 94-10F8                           */
 311         u32     Reset_1078;     /* 10FC   Reset 1078                 */
 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         u8                       deleted;       /* target in process of being removed */
 346         u32                      num_luns;
 347         u32                      luns[8];               /* Max LUNs is 256 */
 348 } VirtTarget;
 349
 350 typedef struct _VirtDevice {
 351         VirtTarget              *vtarget;
 352         u8                       configured_lun;
 353         u32                      lun;
 354 } VirtDevice;
 355
 356 /*
 357  *  Fibre Channel (SCSI) target device and associated defines...
 358  */
 359 #define MPT_TARGET_DEFAULT_DV_STATUS    0x00
 360 #define MPT_TARGET_FLAGS_VALID_NEGO     0x01
 361 #define MPT_TARGET_FLAGS_VALID_INQUIRY  0x02
 362 #define MPT_TARGET_FLAGS_Q_YES          0x08
 363 #define MPT_TARGET_FLAGS_VALID_56       0x10
 364 #define MPT_TARGET_FLAGS_SAF_TE_ISSUED  0x20
 365 #define MPT_TARGET_FLAGS_RAID_COMPONENT 0x40
 366 #define MPT_TARGET_FLAGS_LED_ON         0x80
 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 mutex             ioctl_mutex;
 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 mutex             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_USE_NVRAM           0x01    /* WriteSDP1 using NVRAM */
 451 #define MPT_SCSICFG_ALL_IDS             0x02    /* WriteSDP1 to all IDS */
 452 /* #define MPT_SCSICFG_BLK_NEGO         0x10       WriteSDP1 with WDTR and SDTR disabled */
 453
 454 typedef struct _SpiCfgData {
 455         u32              PortFlags;
 456         int             *nvram;                 /* table of device NVRAM values */
 457         IOCPage4_t      *pIocPg4;               /* SEP devices addressing */
 458         dma_addr_t       IocPg4_dma;            /* Phys Addr of IOCPage4 data */
 459         int              IocPg4Sz;              /* IOCPage4 size */
 460         u8               minSyncFactor;         /* 0xFF if async */
 461         u8               maxSyncOffset;         /* 0 if async */
 462         u8               maxBusWidth;           /* 0 if narrow, 1 if wide */
 463         u8               busType;               /* SE, LVD, HD */
 464         u8               sdp1version;           /* SDP1 version */
 465         u8               sdp1length;            /* SDP1 length  */
 466         u8               sdp0version;           /* SDP0 version */
 467         u8               sdp0length;            /* SDP0 length  */
 468         u8               dvScheduled;           /* 1 if scheduled */
 469         u8               noQas;                 /* Disable QAS for this adapter */
 470         u8               Saf_Te;                /* 1 to force all Processors as
 471                                                  * SAF-TE if Inquiry data length
 472                                                  * is too short to check for SAF-TE
 473                                                  */
 474         u8               bus_reset;             /* 1 to allow bus reset */
 475         u8               rsvd[1];
 476 }SpiCfgData;
 477
 478 typedef struct _SasCfgData {
 479         u8               ptClear;               /* 1 to automatically clear the
 480                                                  * persistent table.
 481                                                  * 0 to disable
 482                                                  * automatic clearing.
 483                                                  */
 484 }SasCfgData;
 485
 486 typedef struct _RaidCfgData {
 487         IOCPage2_t      *pIocPg2;               /* table of Raid Volumes */
 488         IOCPage3_t      *pIocPg3;               /* table of physical disks */
 489         int              isRaid;                /* bit field, 1 if RAID */
 490 }RaidCfgData;
 491
 492 typedef struct _FcCfgData {
 493         /* will ultimately hold fc_port_page0 also */
 494         struct {
 495                 FCPortPage1_t   *data;
 496                 dma_addr_t       dma;
 497                 int              pg_sz;
 498         }                        fc_port_page1[2];
 499 } FcCfgData;
 500
 501 #define MPT_RPORT_INFO_FLAGS_REGISTERED 0x01    /* rport registered */
 502 #define MPT_RPORT_INFO_FLAGS_MISSING    0x02    /* missing from DevPage0 scan */
 503
 504 /*
 505  * data allocated for each fc rport device
 506  */
 507 struct mptfc_rport_info
 508 {
 509         struct list_head list;
 510         struct fc_rport *rport;
 511         struct scsi_target *starget;
 512         FCDevicePage0_t pg0;
 513         u8              flags;
 514 };
 515
 516 /*
 517  *  Adapter Structure - pci_dev specific. Maximum: MPT_MAX_ADAPTERS
 518  */
 519 typedef struct _MPT_ADAPTER
 520 {
 521         int                      id;            /* Unique adapter id N {0,1,2,...} */
 522         int                      pci_irq;       /* This irq           */
 523         char                     name[MPT_NAME_LENGTH]; /* "iocN"             */
 524         char                    *prod_name;     /* "LSIFC9x9"         */
 525         SYSIF_REGS __iomem      *chip;          /* == c8817000 (mmap) */
 526         SYSIF_REGS __iomem      *pio_chip;      /* Programmed IO (downloadboot) */
 527         u8                       bus_type;
 528         u32                      mem_phys;      /* == f4020000 (mmap) */
 529         u32                      pio_mem_phys;  /* Programmed IO (downloadboot) */
 530         int                      mem_size;      /* mmap memory size */
 531         int                      alloc_total;
 532         u32                      last_state;
 533         int                      active;
 534         u8                      *alloc;         /* frames alloc ptr */
 535         dma_addr_t               alloc_dma;
 536         u32                      alloc_sz;
 537         MPT_FRAME_HDR           *reply_frames;  /* Reply msg frames - rounded up! */
 538         u32                      reply_frames_low_dma;
 539         int                      reply_depth;   /* Num Allocated reply frames */
 540         int                      reply_sz;      /* Reply frame size */
 541         int                      num_chain;     /* Number of chain buffers */
 542                 /* Pool of buffers for chaining. ReqToChain
 543                  * and ChainToChain track index of chain buffers.
 544                  * ChainBuffer (DMA) virt/phys addresses.
 545                  * FreeChainQ (lock) locking mechanisms.
 546                  */
 547         int                     *ReqToChain;
 548         int                     *RequestNB;
 549         int                     *ChainToChain;
 550         u8                      *ChainBuffer;
 551         dma_addr_t               ChainBufferDMA;
 552         struct list_head         FreeChainQ;
 553         spinlock_t               FreeChainQlock;
 554                 /* We (host driver) get to manage our own RequestQueue! */
 555         dma_addr_t               req_frames_dma;
 556         MPT_FRAME_HDR           *req_frames;    /* Request msg frames - rounded up! */
 557         u32                      req_frames_low_dma;
 558         int                      req_depth;     /* Number of request frames */
 559         int                      req_sz;        /* Request frame size (bytes) */
 560         spinlock_t               FreeQlock;
 561         struct list_head         FreeQ;
 562                 /* Pool of SCSI sense buffers for commands coming from
 563                  * the SCSI mid-layer.  We have one 256 byte sense buffer
 564                  * for each REQ entry.
 565                  */
 566         u8                      *sense_buf_pool;
 567         dma_addr_t               sense_buf_pool_dma;
 568         u32                      sense_buf_low_dma;
 569         u8                      *HostPageBuffer; /* SAS - host page buffer support */
 570         u32                     HostPageBuffer_sz;
 571         dma_addr_t              HostPageBuffer_dma;
 572         int                      mtrr_reg;
 573         struct pci_dev          *pcidev;        /* struct pci_dev pointer */
 574         u8                      __iomem *memmap;        /* mmap address */
 575         struct Scsi_Host        *sh;            /* Scsi Host pointer */
 576         SpiCfgData              spi_data;       /* Scsi config. data */
 577         RaidCfgData             raid_data;      /* Raid config. data */
 578         SasCfgData              sas_data;       /* Sas config. data */
 579         FcCfgData               fc_data;        /* Fc config. data */
 580         MPT_IOCTL               *ioctl;         /* ioctl data pointer */
 581         struct proc_dir_entry   *ioc_dentry;
 582         struct _MPT_ADAPTER     *alt_ioc;       /* ptr to 929 bound adapter port */
 583         spinlock_t               diagLock;      /* diagnostic reset lock */
 584         int                      diagPending;
 585         u32                      biosVersion;   /* BIOS version from IO Unit Page 2 */
 586         int                      eventTypes;    /* Event logging parameters */
 587         int                      eventContext;  /* Next event context */
 588         int                      eventLogSize;  /* Max number of cached events */
 589         struct _mpt_ioctl_events *events;       /* pointer to event log */
 590         u8                      *cached_fw;     /* Pointer to FW */
 591         dma_addr_t              cached_fw_dma;
 592         struct list_head         configQ;       /* linked list of config. requests */
 593         int                      hs_reply_idx;
 594 #ifndef MFCNT
 595         u32                      pad0;
 596 #else
 597         u32                      mfcnt;
 598 #endif
 599         u32                      NB_for_64_byte_frame;
 600         u32                      hs_req[MPT_MAX_FRAME_SIZE/sizeof(u32)];
 601         u16                      hs_reply[MPT_MAX_FRAME_SIZE/sizeof(u16)];
 602         IOCFactsReply_t          facts;
 603         PortFactsReply_t         pfacts[2];
 604         FCPortPage0_t            fc_port_page0[2];
 605         struct timer_list        persist_timer; /* persist table timer */
 606         int                      persist_wait_done; /* persist completion flag */
 607         u8                       persist_reply_frame[MPT_DEFAULT_FRAME_SIZE]; /* persist reply */
 608         LANPage0_t               lan_cnfg_page0;
 609         LANPage1_t               lan_cnfg_page1;
 610         /*
 611          * Description: errata_flag_1064
 612          * If a PCIX read occurs within 1 or 2 cycles after the chip receives
 613          * a split completion for a read data, an internal address pointer incorrectly
 614          * increments by 32 bytes
 615          */
 616         int                      errata_flag_1064;
 617         int                      aen_event_read_flag; /* flag to indicate event log was read*/
 618         u8                       FirstWhoInit;
 619         u8                       upload_fw;     /* If set, do a fw upload */
 620         u8                       reload_fw;     /* Force a FW Reload on next reset */
 621         u8                       NBShiftFactor;  /* NB Shift Factor based on Block Size (Facts)  */
 622         u8                       pad1[4];
 623         int                      DoneCtx;
 624         int                      TaskCtx;
 625         int                      InternalCtx;
 626         spinlock_t               initializing_hba_lock;
 627         int                      initializing_hba_lock_flag;
 628         struct list_head         list;
 629         struct net_device       *netdev;
 630         struct list_head         sas_topology;
 631         struct mutex             sas_topology_mutex;
 632         struct mutex             sas_discovery_mutex;
 633         u8                       sas_discovery_runtime;
 634         u8                       sas_discovery_ignore_events;
 635         u16                      handle;
 636         int                      sas_index; /* index refrencing */
 637         MPT_SAS_MGMT             sas_mgmt;
 638         struct work_struct       sas_persist_task;
 639
 640         struct work_struct       fc_setup_reset_work;
 641         struct list_head         fc_rports;
 642         spinlock_t               fc_rescan_work_lock;
 643         int                      fc_rescan_work_count;
 644         struct work_struct       fc_rescan_work;
 645         char                     fc_rescan_work_q_name[KOBJ_NAME_LEN];
 646         struct workqueue_struct *fc_rescan_work_q;
 647 } MPT_ADAPTER;
 648
 649 /*
 650  *  New return value convention:
 651  *    1 = Ok to free associated request frame
 652  *    0 = not Ok ...
 653  */
 654 typedef int (*MPT_CALLBACK)(MPT_ADAPTER *ioc, MPT_FRAME_HDR *req, MPT_FRAME_HDR *reply);
 655 typedef int (*MPT_EVHANDLER)(MPT_ADAPTER *ioc, EventNotificationReply_t *evReply);
 656 typedef int (*MPT_RESETHANDLER)(MPT_ADAPTER *ioc, int reset_phase);
 657 /* reset_phase defs */
 658 #define MPT_IOC_PRE_RESET               0
 659 #define MPT_IOC_POST_RESET              1
 660 #define MPT_IOC_SETUP_RESET             2
 661
 662 /*
 663  * Invent MPT host event (super-set of MPI Events)
 664  * Fitted to 1030's 64-byte [max] request frame size
 665  */
 666 typedef struct _MPT_HOST_EVENT {
 667         EventNotificationReply_t         MpiEvent;      /* 8 32-bit words! */
 668         u32                              pad[6];
 669         void                            *next;
 670 } MPT_HOST_EVENT;
 671
 672 #define MPT_HOSTEVENT_IOC_BRINGUP       0x91
 673 #define MPT_HOSTEVENT_IOC_RECOVER       0x92
 674
 675 /* Define the generic types based on the size
 676  * of the dma_addr_t type.
 677  */
 678 typedef struct _mpt_sge {
 679         u32             FlagsLength;
 680         dma_addr_t      Address;
 681 } MptSge_t;
 682
 683 #define mpt_addr_size() \
 684         ((sizeof(dma_addr_t) == sizeof(u64)) ? MPI_SGE_FLAGS_64_BIT_ADDRESSING : \
 685                 MPI_SGE_FLAGS_32_BIT_ADDRESSING)
 686
 687 #define mpt_msg_flags() \
 688         ((sizeof(dma_addr_t) == sizeof(u64)) ? MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_64 : \
 689                 MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_32)
 690
 691 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
 692 /*
 693  *  Funky (private) macros...
 694  */
 695 #ifdef MPT_DEBUG
 696 #define dprintk(x)  printk x
 697 #else
 698 #define dprintk(x)
 699 #endif
 700
 701 #ifdef MPT_DEBUG_INIT
 702 #define dinitprintk(x)  printk x
 703 #define DBG_DUMP_FW_REQUEST_FRAME(mfp) \
 704         {       int  i, n = 10;                                         \
 705                 u32 *m = (u32 *)(mfp);                                  \
 706                 printk(KERN_INFO " ");                                  \
 707                 for (i=0; i<n; i++)                                     \
 708                         printk(" %08x", le32_to_cpu(m[i]));             \
 709                 printk("\n");                                           \
 710         }
 711 #else
 712 #define dinitprintk(x)
 713 #define DBG_DUMP_FW_REQUEST_FRAME(mfp)
 714 #endif
 715
 716 #ifdef MPT_DEBUG_EXIT
 717 #define dexitprintk(x)  printk x
 718 #else
 719 #define dexitprintk(x)
 720 #endif
 721
 722 #if defined MPT_DEBUG_FAIL || defined (MPT_DEBUG_SG)
 723 #define dfailprintk(x) printk x
 724 #else
 725 #define dfailprintk(x)
 726 #endif
 727
 728 #ifdef MPT_DEBUG_HANDSHAKE
 729 #define dhsprintk(x)  printk x
 730 #else
 731 #define dhsprintk(x)
 732 #endif
 733
 734 #if defined(MPT_DEBUG_EVENTS) || defined(MPT_DEBUG_VERBOSE_EVENTS)
 735 #define devtprintk(x)  printk x
 736 #else
 737 #define devtprintk(x)
 738 #endif
 739
 740 #ifdef MPT_DEBUG_VERBOSE_EVENTS
 741 #define devtverboseprintk(x)  printk x
 742 #else
 743 #define devtverboseprintk(x)
 744 #endif
 745
 746 #ifdef MPT_DEBUG_RESET
 747 #define drsprintk(x)  printk x
 748 #else
 749 #define drsprintk(x)
 750 #endif
 751
 752 //#if defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
 753 #if defined(MPT_DEBUG_MSG_FRAME)
 754 #define dmfprintk(x)  printk x
 755 #define DBG_DUMP_REQUEST_FRAME(mfp) \
 756         {       int  i, n = 24;                                         \
 757                 u32 *m = (u32 *)(mfp);                                  \
 758                 for (i=0; i<n; i++) {                                   \
 759                         if (i && ((i%8)==0))                            \
 760                                 printk("\n");                           \
 761                         printk("%08x ", le32_to_cpu(m[i]));             \
 762                 }                                                       \
 763                 printk("\n");                                           \
 764         }
 765 #else
 766 #define dmfprintk(x)
 767 #define DBG_DUMP_REQUEST_FRAME(mfp)
 768 #endif
 769
 770 #ifdef MPT_DEBUG_IRQ
 771 #define dirqprintk(x)  printk x
 772 #else
 773 #define dirqprintk(x)
 774 #endif
 775
 776 #ifdef MPT_DEBUG_SG
 777 #define dsgprintk(x)  printk x
 778 #else
 779 #define dsgprintk(x)
 780 #endif
 781
 782 #if defined(MPT_DEBUG_DL) || defined(MPT_DEBUG)
 783 #define ddlprintk(x)  printk x
 784 #else
 785 #define ddlprintk(x)
 786 #endif
 787
 788 #ifdef MPT_DEBUG_DV
 789 #define ddvprintk(x)  printk x
 790 #else
 791 #define ddvprintk(x)
 792 #endif
 793
 794 #ifdef MPT_DEBUG_NEGO
 795 #define dnegoprintk(x)  printk x
 796 #else
 797 #define dnegoprintk(x)
 798 #endif
 799
 800 #if defined(MPT_DEBUG_DV) || defined(MPT_DEBUG_DV_TINY)
 801 #define ddvtprintk(x)  printk x
 802 #else
 803 #define ddvtprintk(x)
 804 #endif
 805
 806 #ifdef MPT_DEBUG_IOCTL
 807 #define dctlprintk(x) printk x
 808 #else
 809 #define dctlprintk(x)
 810 #endif
 811
 812 #ifdef MPT_DEBUG_REPLY
 813 #define dreplyprintk(x) printk x
 814 #else
 815 #define dreplyprintk(x)
 816 #endif
 817
 818 #ifdef DMPT_DEBUG_FC
 819 #define dfcprintk(x) printk x
 820 #else
 821 #define dfcprintk(x)
 822 #endif
 823
 824 #ifdef MPT_DEBUG_TM
 825 #define dtmprintk(x) printk x
 826 #define DBG_DUMP_TM_REQUEST_FRAME(mfp) \
 827         {       u32 *m = (u32 *)(mfp);                                  \
 828                 int  i, n = 13;                                         \
 829                 printk("TM_REQUEST:\n");                                \
 830                 for (i=0; i<n; i++) {                                   \
 831                         if (i && ((i%8)==0))                            \
 832                                 printk("\n");                           \
 833                         printk("%08x ", le32_to_cpu(m[i]));             \
 834                 }                                                       \
 835                 printk("\n");                                           \
 836         }
 837 #define DBG_DUMP_TM_REPLY_FRAME(mfp) \
 838         {       u32 *m = (u32 *)(mfp);                                  \
 839                 int  i, n = (le32_to_cpu(m[0]) & 0x00FF0000) >> 16;     \
 840                 printk("TM_REPLY MessageLength=%d:\n", n);              \
 841                 for (i=0; i<n; i++) {                                   \
 842                         if (i && ((i%8)==0))                            \
 843                                 printk("\n");                           \
 844                         printk(" %08x", le32_to_cpu(m[i]));             \
 845                 }                                                       \
 846                 printk("\n");                                           \
 847         }
 848 #else
 849 #define dtmprintk(x)
 850 #define DBG_DUMP_TM_REQUEST_FRAME(mfp)
 851 #define DBG_DUMP_TM_REPLY_FRAME(mfp)
 852 #endif
 853
 854 #if defined(MPT_DEBUG_CONFIG) || defined(MPT_DEBUG)
 855 #define dcprintk(x) printk x
 856 #else
 857 #define dcprintk(x)
 858 #endif
 859
 860 #if defined(MPT_DEBUG_SCSI) || defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
 861 #define dsprintk(x) printk x
 862 #else
 863 #define dsprintk(x)
 864 #endif
 865
 866
 867 #define MPT_INDEX_2_MFPTR(ioc,idx) \
 868         (MPT_FRAME_HDR*)( (u8*)(ioc)->req_frames + (ioc)->req_sz * (idx) )
 869
 870 #define MFPTR_2_MPT_INDEX(ioc,mf) \
 871         (int)( ((u8*)mf - (u8*)(ioc)->req_frames) / (ioc)->req_sz )
 872
 873 #define MPT_INDEX_2_RFPTR(ioc,idx) \
 874         (MPT_FRAME_HDR*)( (u8*)(ioc)->reply_frames + (ioc)->req_sz * (idx) )
 875
 876 #if defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
 877 #define DBG_DUMP_REPLY_FRAME(mfp) \
 878         {       u32 *m = (u32 *)(mfp);                                  \
 879                 int  i, n = (le32_to_cpu(m[0]) & 0x00FF0000) >> 16;     \
 880                 printk(KERN_INFO " ");                                  \
 881                 for (i=0; i<n; i++)                                     \
 882                         printk(" %08x", le32_to_cpu(m[i]));             \
 883                 printk("\n");                                           \
 884         }
 885 #define DBG_DUMP_REQUEST_FRAME_HDR(mfp) \
 886         {       int  i, n = 3;                                          \
 887                 u32 *m = (u32 *)(mfp);                                  \
 888                 printk(KERN_INFO " ");                                  \
 889                 for (i=0; i<n; i++)                                     \
 890                         printk(" %08x", le32_to_cpu(m[i]));             \
 891                 printk("\n");                                           \
 892         }
 893 #else
 894 #define DBG_DUMP_REPLY_FRAME(mfp)
 895 #define DBG_DUMP_REQUEST_FRAME_HDR(mfp)
 896 #endif
 897
 898 // debug sas wide ports
 899 #ifdef MPT_DEBUG_SAS_WIDE
 900 #define dsaswideprintk(x) printk x
 901 #else
 902 #define dsaswideprintk(x)
 903 #endif
 904
 905
 906 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
 907
 908 #define SCSI_STD_SENSE_BYTES    18
 909 #define SCSI_STD_INQUIRY_BYTES  36
 910 #define SCSI_MAX_INQUIRY_BYTES  96
 911
 912 /*
 913  * MPT_SCSI_HOST defines - Used by the IOCTL and the SCSI drivers
 914  * Private to the driver.
 915  */
 916 /* LOCAL structure and fields used when processing
 917  * internally generated commands. These include:
 918  * bus scan, dv and config requests.
 919  */
 920 typedef struct _MPT_LOCAL_REPLY {
 921         ConfigPageHeader_t header;
 922         int     completion;
 923         u8      sense[SCSI_STD_SENSE_BYTES];
 924         u8      scsiStatus;
 925         u8      skip;
 926         u32     pad;
 927 } MPT_LOCAL_REPLY;
 928
 929 #define MPT_HOST_BUS_UNKNOWN            (0xFF)
 930 #define MPT_HOST_TOO_MANY_TM            (0x05)
 931 #define MPT_HOST_NVRAM_INVALID          (0xFFFFFFFF)
 932 #define MPT_HOST_NO_CHAIN               (0xFFFFFFFF)
 933 #define MPT_NVRAM_MASK_TIMEOUT          (0x000000FF)
 934 #define MPT_NVRAM_SYNC_MASK             (0x0000FF00)
 935 #define MPT_NVRAM_SYNC_SHIFT            (8)
 936 #define MPT_NVRAM_DISCONNECT_ENABLE     (0x00010000)
 937 #define MPT_NVRAM_ID_SCAN_ENABLE        (0x00020000)
 938 #define MPT_NVRAM_LUN_SCAN_ENABLE       (0x00040000)
 939 #define MPT_NVRAM_TAG_QUEUE_ENABLE      (0x00080000)
 940 #define MPT_NVRAM_WIDE_DISABLE          (0x00100000)
 941 #define MPT_NVRAM_BOOT_CHOICE           (0x00200000)
 942
 943 /* The TM_STATE variable is used to provide strict single threading of TM
 944  * requests as well as communicate TM error conditions.
 945  */
 946 #define TM_STATE_NONE          (0)
 947 #define TM_STATE_IN_PROGRESS   (1)
 948 #define TM_STATE_ERROR         (2)
 949
 950 typedef enum {
 951         FC,
 952         SPI,
 953         SAS
 954 } BUS_TYPE;
 955
 956 typedef struct _MPT_SCSI_HOST {
 957         MPT_ADAPTER              *ioc;
 958         int                       port;
 959         u32                       pad0;
 960         struct scsi_cmnd        **ScsiLookup;
 961         VirtTarget              **Targets;
 962         MPT_LOCAL_REPLY          *pLocal;               /* used for internal commands */
 963         struct timer_list         timer;
 964                 /* Pool of memory for holding SCpnts before doing
 965                  * OS callbacks. freeQ is the free pool.
 966                  */
 967         u8                        tmPending;
 968         u8                        resetPending;
 969         u8                        negoNvram;            /* DV disabled, nego NVRAM */
 970         u8                        pad1;
 971         u8                        tmState;
 972         u8                        rsvd[2];
 973         MPT_FRAME_HDR            *cmdPtr;               /* Ptr to nonOS request */
 974         struct scsi_cmnd         *abortSCpnt;
 975         MPT_LOCAL_REPLY           localReply;           /* internal cmd reply struct */
 976         unsigned long             hard_resets;          /* driver forced bus resets count */
 977         unsigned long             soft_resets;          /* fw/external bus resets count */
 978         unsigned long             timeouts;             /* cmd timeouts */
 979         ushort                    sel_timeout[MPT_MAX_FC_DEVICES];
 980         char                      *info_kbuf;
 981         wait_queue_head_t         scandv_waitq;
 982         int                       scandv_wait_done;
 983         long                      last_queue_full;
 984         u8                        mpt_pq_filter;
 985 } MPT_SCSI_HOST;
 986
 987 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
 988 /*
 989  *      More Dynamic Multi-Pathing stuff...
 990  */
 991
 992 /* Forward decl, a strange C thing, to prevent gcc compiler warnings */
 993 struct scsi_cmnd;
 994
 995 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
 996 /*
 997  * Generic structure passed to the base mpt_config function.
 998  */
 999 typedef struct _x_config_parms {
1000         struct list_head         linkage;       /* linked list */
1001         struct timer_list        timer;         /* timer function for this request  */
1002         union {
1003                 ConfigExtendedPageHeader_t      *ehdr;
1004                 ConfigPageHeader_t      *hdr;
1005         } cfghdr;
1006         dma_addr_t               physAddr;
1007         int                      wait_done;     /* wait for this request */
1008         u32                      pageAddr;      /* properly formatted */
1009         u8                       action;
1010         u8                       dir;
1011         u8                       timeout;       /* seconds */
1012         u8                       pad1;
1013         u16                      status;
1014         u16                      pad2;
1015 } CONFIGPARMS;
1016
1017 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1018 /*
1019  *  Public entry points...
1020  */
1021 extern int       mpt_attach(struct pci_dev *pdev, const struct pci_device_id *id);
1022 extern void      mpt_detach(struct pci_dev *pdev);
1023 #ifdef CONFIG_PM
1024 extern int       mpt_suspend(struct pci_dev *pdev, pm_message_t state);
1025 extern int       mpt_resume(struct pci_dev *pdev);
1026 #endif
1027 extern int       mpt_register(MPT_CALLBACK cbfunc, MPT_DRIVER_CLASS dclass);
1028 extern void      mpt_deregister(int cb_idx);
1029 extern int       mpt_event_register(int cb_idx, MPT_EVHANDLER ev_cbfunc);
1030 extern void      mpt_event_deregister(int cb_idx);
1031 extern int       mpt_reset_register(int cb_idx, MPT_RESETHANDLER reset_func);
1032 extern void      mpt_reset_deregister(int cb_idx);
1033 extern int       mpt_device_driver_register(struct mpt_pci_driver * dd_cbfunc, int cb_idx);
1034 extern void      mpt_device_driver_deregister(int cb_idx);
1035 extern MPT_FRAME_HDR    *mpt_get_msg_frame(int handle, MPT_ADAPTER *ioc);
1036 extern void      mpt_free_msg_frame(MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);
1037 extern void      mpt_put_msg_frame(int handle, MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);
1038 extern void      mpt_add_sge(char *pAddr, u32 flagslength, dma_addr_t dma_addr);
1039
1040 extern int       mpt_send_handshake_request(int handle, MPT_ADAPTER *ioc, int reqBytes, u32 *req, int sleepFlag);
1041 extern int       mpt_verify_adapter(int iocid, MPT_ADAPTER **iocpp);
1042 extern u32       mpt_GetIocState(MPT_ADAPTER *ioc, int cooked);
1043 extern void      mpt_print_ioc_summary(MPT_ADAPTER *ioc, char *buf, int *size, int len, int showlan);
1044 extern int       mpt_HardResetHandler(MPT_ADAPTER *ioc, int sleepFlag);
1045 extern int       mpt_config(MPT_ADAPTER *ioc, CONFIGPARMS *cfg);
1046 extern void      mpt_alloc_fw_memory(MPT_ADAPTER *ioc, int size);
1047 extern void      mpt_free_fw_memory(MPT_ADAPTER *ioc);
1048 extern int       mpt_findImVolumes(MPT_ADAPTER *ioc);
1049 extern int       mptbase_sas_persist_operation(MPT_ADAPTER *ioc, u8 persist_opcode);
1050
1051 /*
1052  *  Public data decl's...
1053  */
1054 extern struct list_head   ioc_list;
1055 extern struct proc_dir_entry    *mpt_proc_root_dir;
1056
1057 extern int                mpt_lan_index;        /* needed by mptlan.c */
1058 extern int                mpt_stm_index;        /* needed by mptstm.c */
1059
1060 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1061 #endif          /* } __KERNEL__ */
1062
1063 #if defined(__alpha__) || defined(__sparc_v9__) || defined(__ia64__) || defined(__x86_64__)
1064 #define CAST_U32_TO_PTR(x)      ((void *)(u64)x)
1065 #define CAST_PTR_TO_U32(x)      ((u32)(u64)x)
1066 #else
1067 #define CAST_U32_TO_PTR(x)      ((void *)x)
1068 #define CAST_PTR_TO_U32(x)      ((u32)x)
1069 #endif
1070
1071 #define MPT_PROTOCOL_FLAGS_c_c_c_c(pflags) \
1072         ((pflags) & MPI_PORTFACTS_PROTOCOL_INITIATOR)   ? 'I' : 'i',    \
1073         ((pflags) & MPI_PORTFACTS_PROTOCOL_TARGET)      ? 'T' : 't',    \
1074         ((pflags) & MPI_PORTFACTS_PROTOCOL_LAN)         ? 'L' : 'l',    \
1075         ((pflags) & MPI_PORTFACTS_PROTOCOL_LOGBUSADDR)  ? 'B' : 'b'
1076
1077 /*
1078  *  Shifted SGE Defines - Use in SGE with FlagsLength member.
1079  *  Otherwise, use MPI_xxx defines (refer to "lsi/mpi.h" header).
1080  *  Defaults: 32 bit SGE, SYSTEM_ADDRESS if direction bit is 0, read
1081  */
1082 #define MPT_TRANSFER_IOC_TO_HOST                (0x00000000)
1083 #define MPT_TRANSFER_HOST_TO_IOC                (0x04000000)
1084 #define MPT_SGE_FLAGS_LAST_ELEMENT              (0x80000000)
1085 #define MPT_SGE_FLAGS_END_OF_BUFFER             (0x40000000)
1086 #define MPT_SGE_FLAGS_LOCAL_ADDRESS             (0x08000000)
1087 #define MPT_SGE_FLAGS_DIRECTION                 (0x04000000)
1088 #define MPT_SGE_FLAGS_ADDRESSING                (mpt_addr_size() << MPI_SGE_FLAGS_SHIFT)
1089 #define MPT_SGE_FLAGS_END_OF_LIST               (0x01000000)
1090
1091 #define MPT_SGE_FLAGS_TRANSACTION_ELEMENT       (0x00000000)
1092 #define MPT_SGE_FLAGS_SIMPLE_ELEMENT            (0x10000000)
1093 #define MPT_SGE_FLAGS_CHAIN_ELEMENT             (0x30000000)
1094 #define MPT_SGE_FLAGS_ELEMENT_MASK              (0x30000000)
1095
1096 #define MPT_SGE_FLAGS_SSIMPLE_READ \
1097         (MPT_SGE_FLAGS_LAST_ELEMENT |   \
1098          MPT_SGE_FLAGS_END_OF_BUFFER |  \
1099          MPT_SGE_FLAGS_END_OF_LIST |    \
1100          MPT_SGE_FLAGS_SIMPLE_ELEMENT | \
1101          MPT_SGE_FLAGS_ADDRESSING | \
1102          MPT_TRANSFER_IOC_TO_HOST)
1103 #define MPT_SGE_FLAGS_SSIMPLE_WRITE \
1104         (MPT_SGE_FLAGS_LAST_ELEMENT |   \
1105          MPT_SGE_FLAGS_END_OF_BUFFER |  \
1106          MPT_SGE_FLAGS_END_OF_LIST |    \
1107          MPT_SGE_FLAGS_SIMPLE_ELEMENT | \
1108          MPT_SGE_FLAGS_ADDRESSING | \
1109          MPT_TRANSFER_HOST_TO_IOC)
1110
1111 /*}-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1112 #endif
1113