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