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