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