24d60128bfe63bfe19fe00eb602b4690546d3677
[linux-2.6.git] / 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 Fusion MPT (Message Passing Technology) firmware.
7  *
8  *  Copyright (c) 1999-2008 LSI Corporation
9  *  (mailto:DL-MPTFusionLinux@lsi.com)
10  *
11  */
12 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
13 /*
14     This program is free software; you can redistribute it and/or modify
15     it under the terms of the GNU General Public License as published by
16     the Free Software Foundation; version 2 of the License.
17
18     This program is distributed in the hope that it will be useful,
19     but WITHOUT ANY WARRANTY; without even the implied warranty of
20     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21     GNU General Public License for more details.
22
23     NO WARRANTY
24     THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR
25     CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT
26     LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,
27     MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is
28     solely responsible for determining the appropriateness of using and
29     distributing the Program and assumes all risks associated with its
30     exercise of rights under this Agreement, including but not limited to
31     the risks and costs of program errors, damage to or loss of data,
32     programs or equipment, and unavailability or interruption of operations.
33
34     DISCLAIMER OF LIABILITY
35     NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY
36     DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37     DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND
38     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
39     TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
40     USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
41     HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES
42
43     You should have received a copy of the GNU General Public License
44     along with this program; if not, write to the Free Software
45     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
46 */
47
48 #ifndef MPTBASE_H_INCLUDED
49 #define MPTBASE_H_INCLUDED
50 /*{-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
51
52 #include <linux/kernel.h>
53 #include <linux/pci.h>
54 #include <linux/mutex.h>
55
56 #include "lsi/mpi_type.h"
57 #include "lsi/mpi.h"            /* Fusion MPI(nterface) basic defs */
58 #include "lsi/mpi_ioc.h"        /* Fusion MPT IOC(ontroller) defs */
59 #include "lsi/mpi_cnfg.h"       /* IOC configuration support */
60 #include "lsi/mpi_init.h"       /* SCSI Host (initiator) protocol support */
61 #include "lsi/mpi_lan.h"        /* LAN over FC protocol support */
62 #include "lsi/mpi_raid.h"       /* Integrated Mirroring support */
63
64 #include "lsi/mpi_fc.h"         /* Fibre Channel (lowlevel) support */
65 #include "lsi/mpi_targ.h"       /* SCSI/FCP Target protcol support */
66 #include "lsi/mpi_tool.h"       /* Tools support */
67 #include "lsi/mpi_sas.h"        /* SAS support */
68
69 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
70
71 #ifndef MODULEAUTHOR
72 #define MODULEAUTHOR    "LSI Corporation"
73 #endif
74
75 #ifndef COPYRIGHT
76 #define COPYRIGHT       "Copyright (c) 1999-2008 " MODULEAUTHOR
77 #endif
78
79 #define MPT_LINUX_VERSION_COMMON        "3.04.08"
80 #define MPT_LINUX_PACKAGE_NAME          "@(#)mptlinux-3.04.08"
81 #define WHAT_MAGIC_STRING               "@" "(" "#" ")"
82
83 #define show_mptmod_ver(s,ver)  \
84         printk(KERN_INFO "%s %s\n", s, ver);
85
86 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
87 /*
88  *  Fusion MPT(linux) driver configurable stuff...
89  */
90 #define MPT_MAX_ADAPTERS                18
91 #define MPT_MAX_PROTOCOL_DRIVERS        16
92 #define MPT_MAX_BUS                     1       /* Do not change */
93 #define MPT_MAX_FC_DEVICES              255
94 #define MPT_MAX_SCSI_DEVICES            16
95 #define MPT_LAST_LUN                    255
96 #define MPT_SENSE_BUFFER_ALLOC          64
97         /* allow for 256 max sense alloc, but only 255 max request */
98 #if MPT_SENSE_BUFFER_ALLOC >= 256
99 #       undef MPT_SENSE_BUFFER_ALLOC
100 #       define MPT_SENSE_BUFFER_ALLOC   256
101 #       define MPT_SENSE_BUFFER_SIZE    255
102 #else
103 #       define MPT_SENSE_BUFFER_SIZE    MPT_SENSE_BUFFER_ALLOC
104 #endif
105
106 #define MPT_NAME_LENGTH                 32
107
108 #define MPT_PROCFS_MPTBASEDIR           "mpt"
109                                                 /* chg it to "driver/fusion" ? */
110 #define MPT_PROCFS_SUMMARY_ALL_NODE             MPT_PROCFS_MPTBASEDIR "/summary"
111 #define MPT_PROCFS_SUMMARY_ALL_PATHNAME         "/proc/" MPT_PROCFS_SUMMARY_ALL_NODE
112 #define MPT_FW_REV_MAGIC_ID_STRING              "FwRev="
113
114 #define  MPT_MAX_REQ_DEPTH              1023
115 #define  MPT_DEFAULT_REQ_DEPTH          256
116 #define  MPT_MIN_REQ_DEPTH              128
117
118 #define  MPT_MAX_REPLY_DEPTH            MPT_MAX_REQ_DEPTH
119 #define  MPT_DEFAULT_REPLY_DEPTH        128
120 #define  MPT_MIN_REPLY_DEPTH            8
121 #define  MPT_MAX_REPLIES_PER_ISR        32
122
123 #define  MPT_MAX_FRAME_SIZE             128
124 #define  MPT_DEFAULT_FRAME_SIZE         128
125
126 #define  MPT_REPLY_FRAME_SIZE           0x50  /* Must be a multiple of 8 */
127
128 #define  MPT_SG_REQ_128_SCALE           1
129 #define  MPT_SG_REQ_96_SCALE            2
130 #define  MPT_SG_REQ_64_SCALE            4
131
132 #define  CAN_SLEEP                      1
133 #define  NO_SLEEP                       0
134
135 #define MPT_COALESCING_TIMEOUT          0x10
136
137
138 /*
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 /* debug print string length used for events and iocstatus */
178 # define EVENT_DESCR_STR_SZ             100
179
180 #define MPT_POLLING_INTERVAL            1000    /* in milliseconds */
181
182 #ifdef __KERNEL__       /* { */
183 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
184
185 #include <linux/proc_fs.h>
186
187 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
188 /*
189  * Attempt semi-consistent error & warning msgs across
190  * MPT drivers.  NOTE: Users of these macro defs must
191  * themselves define their own MYNAM.
192  */
193 #define MYIOC_s_FMT                     MYNAM ": %s: "
194 #define MYIOC_s_DEBUG_FMT               KERN_DEBUG MYNAM ": %s: "
195 #define MYIOC_s_INFO_FMT                KERN_INFO MYNAM ": %s: "
196 #define MYIOC_s_NOTE_FMT                KERN_NOTICE MYNAM ": %s: "
197 #define MYIOC_s_WARN_FMT                KERN_WARNING MYNAM ": %s: WARNING - "
198 #define MYIOC_s_ERR_FMT                 KERN_ERR MYNAM ": %s: ERROR - "
199
200 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
201 /*
202  *  ATTO UL4D associated structures and defines
203  */
204 #define ATTOFLAG_DISC     0x0001
205 #define ATTOFLAG_TAGGED   0x0002
206 #define ATTOFLAG_WIDE_ENB 0x0008
207 #define ATTOFLAG_ID_ENB   0x0010
208 #define ATTOFLAG_LUN_ENB  0x0060
209
210 typedef struct _ATTO_DEVICE_INFO
211 {
212         u8      Offset;                                 /* 00h */
213         u8      Period;                                 /* 01h */
214         u16     ATTOFlags;                              /* 02h */
215 } ATTO_DEVICE_INFO, MPI_POINTER PTR_ATTO_DEVICE_INFO,
216   ATTODeviceInfo_t, MPI_POINTER pATTODeviceInfo_t;
217
218 typedef struct _ATTO_CONFIG_PAGE_SCSI_PORT_2
219 {
220         CONFIG_PAGE_HEADER      Header;                 /* 00h */
221         u16                     PortFlags;              /* 04h */
222         u16                     Unused1;                /* 06h */
223         u32                     Unused2;                /* 08h */
224         ATTO_DEVICE_INFO        DeviceSettings[16];     /* 0Ch */
225 } fATTO_CONFIG_PAGE_SCSI_PORT_2, MPI_POINTER PTR_ATTO_CONFIG_PAGE_SCSI_PORT_2,
226   ATTO_SCSIPortPage2_t, MPI_POINTER pATTO_SCSIPortPage2_t;
227
228
229 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
230 /*
231  *  MPT protocol driver defs...
232  */
233 typedef enum {
234         MPTBASE_DRIVER,         /* MPT base class */
235         MPTCTL_DRIVER,          /* MPT ioctl class */
236         MPTSPI_DRIVER,          /* MPT SPI host class */
237         MPTFC_DRIVER,           /* MPT FC host class */
238         MPTSAS_DRIVER,          /* MPT SAS host class */
239         MPTLAN_DRIVER,          /* MPT LAN class */
240         MPTSTM_DRIVER,          /* MPT SCSI target mode class */
241         MPTUNKNOWN_DRIVER
242 } MPT_DRIVER_CLASS;
243
244 struct mpt_pci_driver{
245         int  (*probe) (struct pci_dev *dev, const struct pci_device_id *id);
246         void (*remove) (struct pci_dev *dev);
247 };
248
249 /*
250  *  MPT adapter / port / bus / device info structures...
251  */
252
253 typedef union _MPT_FRAME_TRACKER {
254         struct {
255                 struct list_head        list;
256                 u32                      arg1;
257                 u32                      pad;
258                 void                    *argp1;
259         } linkage;
260         /*
261          * NOTE: When request frames are free, on the linkage structure
262          * contets are valid.  All other values are invalid.
263          * In particular, do NOT reply on offset [2]
264          * (in words) being the * message context.
265          * The message context must be reset (computed via base address
266          * + an offset) prior to issuing any command.
267          *
268          * NOTE2: On non-32-bit systems, where pointers are LARGE,
269          * using the linkage pointers destroys our sacred MsgContext
270          * field contents.  But we don't care anymore because these
271          * are now reset in mpt_put_msg_frame() just prior to sending
272          * a request off to the IOC.
273          */
274         struct {
275                 u32 __hdr[2];
276                 /*
277                  * The following _MUST_ match the location of the
278                  * MsgContext field in the MPT message headers.
279                  */
280                 union {
281                         u32              MsgContext;
282                         struct {
283                                 u16      req_idx;       /* Request index */
284                                 u8       cb_idx;        /* callback function index */
285                                 u8       rsvd;
286                         } fld;
287                 } msgctxu;
288         } hwhdr;
289         /*
290          * Remark: 32 bit identifier:
291          *  31-24: reserved
292          *  23-16: call back index
293          *  15-0 : request index
294          */
295 } MPT_FRAME_TRACKER;
296
297 /*
298  *  We might want to view/access a frame as:
299  *    1) generic request header
300  *    2) SCSIIORequest
301  *    3) SCSIIOReply
302  *    4) MPIDefaultReply
303  *    5) frame tracker
304  */
305 typedef struct _MPT_FRAME_HDR {
306         union {
307                 MPIHeader_t             hdr;
308                 SCSIIORequest_t         scsireq;
309                 SCSIIOReply_t           sreply;
310                 ConfigReply_t           configreply;
311                 MPIDefaultReply_t       reply;
312                 MPT_FRAME_TRACKER       frame;
313         } u;
314 } MPT_FRAME_HDR;
315
316 #define MPT_REQ_MSGFLAGS_DROPME         0x80
317
318 typedef struct _MPT_SGL_HDR {
319         SGESimple32_t    sge[1];
320 } MPT_SGL_HDR;
321
322 typedef struct _MPT_SGL64_HDR {
323         SGESimple64_t    sge[1];
324 } MPT_SGL64_HDR;
325
326 /*
327  *  System interface register set
328  */
329
330 typedef struct _SYSIF_REGS
331 {
332         u32     Doorbell;       /* 00     System<->IOC Doorbell reg  */
333         u32     WriteSequence;  /* 04     Write Sequence register    */
334         u32     Diagnostic;     /* 08     Diagnostic register        */
335         u32     TestBase;       /* 0C     Test Base Address          */
336         u32     DiagRwData;     /* 10     Read Write Data (fw download)   */
337         u32     DiagRwAddress;  /* 14     Read Write Address (fw download)*/
338         u32     Reserved1[6];   /* 18-2F  reserved for future use    */
339         u32     IntStatus;      /* 30     Interrupt Status           */
340         u32     IntMask;        /* 34     Interrupt Mask             */
341         u32     Reserved2[2];   /* 38-3F  reserved for future use    */
342         u32     RequestFifo;    /* 40     Request Post/Free FIFO     */
343         u32     ReplyFifo;      /* 44     Reply   Post/Free FIFO     */
344         u32     RequestHiPriFifo; /* 48   Hi Priority Request FIFO   */
345         u32     Reserved3;      /* 4C-4F  reserved for future use    */
346         u32     HostIndex;      /* 50     Host Index register        */
347         u32     Reserved4[15];  /* 54-8F                             */
348         u32     Fubar;          /* 90     For Fubar usage            */
349         u32     Reserved5[1050];/* 94-10F8                           */
350         u32     Reset_1078;     /* 10FC   Reset 1078                 */
351 } SYSIF_REGS;
352
353 /*
354  * NOTE: Use MPI_{DOORBELL,WRITESEQ,DIAG}_xxx defs in lsi/mpi.h
355  * in conjunction with SYSIF_REGS accesses!
356  */
357
358
359 /*
360  *      Dynamic Multi-Pathing specific stuff...
361  */
362
363 /* VirtTarget negoFlags field */
364 #define MPT_TARGET_NO_NEGO_WIDE         0x01
365 #define MPT_TARGET_NO_NEGO_SYNC         0x02
366 #define MPT_TARGET_NO_NEGO_QAS          0x04
367 #define MPT_TAPE_NEGO_IDP               0x08
368
369 /*
370  *      VirtDevice - FC LUN device or SCSI target device
371  */
372 typedef struct _VirtTarget {
373         struct scsi_target      *starget;
374         u8                       tflags;
375         u8                       ioc_id;
376         u8                       id;
377         u8                       channel;
378         u8                       minSyncFactor; /* 0xFF is async */
379         u8                       maxOffset;     /* 0 if async */
380         u8                       maxWidth;      /* 0 if narrow, 1 if wide */
381         u8                       negoFlags;     /* bit field, see above */
382         u8                       raidVolume;    /* set, if RAID Volume */
383         u8                       type;          /* byte 0 of Inquiry data */
384         u8                       deleted;       /* target in process of being removed */
385         u32                      num_luns;
386 } VirtTarget;
387
388 typedef struct _VirtDevice {
389         VirtTarget              *vtarget;
390         u8                       configured_lun;
391         int                      lun;
392 } VirtDevice;
393
394 /*
395  *  Fibre Channel (SCSI) target device and associated defines...
396  */
397 #define MPT_TARGET_DEFAULT_DV_STATUS    0x00
398 #define MPT_TARGET_FLAGS_VALID_NEGO     0x01
399 #define MPT_TARGET_FLAGS_VALID_INQUIRY  0x02
400 #define MPT_TARGET_FLAGS_Q_YES          0x08
401 #define MPT_TARGET_FLAGS_VALID_56       0x10
402 #define MPT_TARGET_FLAGS_SAF_TE_ISSUED  0x20
403 #define MPT_TARGET_FLAGS_RAID_COMPONENT 0x40
404 #define MPT_TARGET_FLAGS_LED_ON         0x80
405
406 /*
407  *      /proc/mpt interface
408  */
409 typedef struct {
410         const char      *name;
411         mode_t           mode;
412         int              pad;
413         read_proc_t     *read_proc;
414         write_proc_t    *write_proc;
415 } mpt_proc_entry_t;
416
417 #define MPT_PROC_READ_RETURN(buf,start,offset,request,eof,len) \
418 do { \
419         len -= offset;                  \
420         if (len < request) {            \
421                 *eof = 1;               \
422                 if (len <= 0)           \
423                         return 0;       \
424         } else                          \
425                 len = request;          \
426         *start = buf + offset;          \
427         return len;                     \
428 } while (0)
429
430
431 /*
432  *      IOCTL structure and associated defines
433  */
434
435 #define MPTCTL_RESET_OK                 0x01    /* Issue Bus Reset */
436
437 #define MPT_MGMT_STATUS_RF_VALID        0x01    /* The Reply Frame is VALID */
438 #define MPT_MGMT_STATUS_COMMAND_GOOD    0x02    /* Command Status GOOD */
439 #define MPT_MGMT_STATUS_PENDING         0x04    /* command is pending */
440 #define MPT_MGMT_STATUS_DID_IOCRESET    0x08    /* IOC Reset occurred
441                                                    on the current*/
442 #define MPT_MGMT_STATUS_SENSE_VALID     0x10    /* valid sense info */
443 #define MPT_MGMT_STATUS_TIMER_ACTIVE    0x20    /* obsolete */
444 #define MPT_MGMT_STATUS_FREE_MF         0x40    /* free the mf from
445                                                    complete routine */
446
447 #define INITIALIZE_MGMT_STATUS(status) \
448         status = MPT_MGMT_STATUS_PENDING;
449 #define CLEAR_MGMT_STATUS(status) \
450         status = 0;
451 #define CLEAR_MGMT_PENDING_STATUS(status) \
452         status &= ~MPT_MGMT_STATUS_PENDING;
453 #define SET_MGMT_MSG_CONTEXT(msg_context, value) \
454         msg_context = value;
455
456 typedef struct _MPT_MGMT {
457         struct mutex             mutex;
458         struct completion        done;
459         u8                       reply[MPT_DEFAULT_FRAME_SIZE]; /* reply frame data */
460         u8                       sense[MPT_SENSE_BUFFER_ALLOC];
461         u8                       status;        /* current command status */
462         int                      completion_code;
463         u32                      msg_context;
464 } MPT_MGMT;
465
466 /*
467  *  Event Structure and define
468  */
469 #define MPTCTL_EVENT_LOG_SIZE           (0x000000032)
470 typedef struct _mpt_ioctl_events {
471         u32     event;          /* Specified by define above */
472         u32     eventContext;   /* Index or counter */
473         u32     data[2];        /* First 8 bytes of Event Data */
474 } MPT_IOCTL_EVENTS;
475
476 /*
477  * CONFIGPARM status  defines
478  */
479 #define MPT_CONFIG_GOOD         MPI_IOCSTATUS_SUCCESS
480 #define MPT_CONFIG_ERROR        0x002F
481
482 /*
483  *      Substructure to store SCSI specific configuration page data
484  */
485                                                 /* dvStatus defines: */
486 #define MPT_SCSICFG_USE_NVRAM           0x01    /* WriteSDP1 using NVRAM */
487 #define MPT_SCSICFG_ALL_IDS             0x02    /* WriteSDP1 to all IDS */
488 /* #define MPT_SCSICFG_BLK_NEGO         0x10       WriteSDP1 with WDTR and SDTR disabled */
489
490 typedef struct _SpiCfgData {
491         u32              PortFlags;
492         int             *nvram;                 /* table of device NVRAM values */
493         IOCPage4_t      *pIocPg4;               /* SEP devices addressing */
494         dma_addr_t       IocPg4_dma;            /* Phys Addr of IOCPage4 data */
495         int              IocPg4Sz;              /* IOCPage4 size */
496         u8               minSyncFactor;         /* 0xFF if async */
497         u8               maxSyncOffset;         /* 0 if async */
498         u8               maxBusWidth;           /* 0 if narrow, 1 if wide */
499         u8               busType;               /* SE, LVD, HD */
500         u8               sdp1version;           /* SDP1 version */
501         u8               sdp1length;            /* SDP1 length  */
502         u8               sdp0version;           /* SDP0 version */
503         u8               sdp0length;            /* SDP0 length  */
504         u8               dvScheduled;           /* 1 if scheduled */
505         u8               noQas;                 /* Disable QAS for this adapter */
506         u8               Saf_Te;                /* 1 to force all Processors as
507                                                  * SAF-TE if Inquiry data length
508                                                  * is too short to check for SAF-TE
509                                                  */
510         u8               bus_reset;             /* 1 to allow bus reset */
511         u8               rsvd[1];
512 }SpiCfgData;
513
514 typedef struct _SasCfgData {
515         u8               ptClear;               /* 1 to automatically clear the
516                                                  * persistent table.
517                                                  * 0 to disable
518                                                  * automatic clearing.
519                                                  */
520 }SasCfgData;
521
522 /*
523  * Inactive volume link list of raid component data
524  * @inactive_list
525  */
526 struct inactive_raid_component_info {
527         struct   list_head list;
528         u8               volumeID;              /* volume target id */
529         u8               volumeBus;             /* volume channel */
530         IOC_3_PHYS_DISK  d;                     /* phys disk info */
531 };
532
533 typedef struct _RaidCfgData {
534         IOCPage2_t      *pIocPg2;               /* table of Raid Volumes */
535         IOCPage3_t      *pIocPg3;               /* table of physical disks */
536         struct mutex    inactive_list_mutex;
537         struct list_head        inactive_list; /* link list for physical
538                                                 disk that belong in
539                                                 inactive volumes */
540 }RaidCfgData;
541
542 typedef struct _FcCfgData {
543         /* will ultimately hold fc_port_page0 also */
544         struct {
545                 FCPortPage1_t   *data;
546                 dma_addr_t       dma;
547                 int              pg_sz;
548         }                        fc_port_page1[2];
549 } FcCfgData;
550
551 #define MPT_RPORT_INFO_FLAGS_REGISTERED 0x01    /* rport registered */
552 #define MPT_RPORT_INFO_FLAGS_MISSING    0x02    /* missing from DevPage0 scan */
553
554 /*
555  * data allocated for each fc rport device
556  */
557 struct mptfc_rport_info
558 {
559         struct list_head list;
560         struct fc_rport *rport;
561         struct scsi_target *starget;
562         FCDevicePage0_t pg0;
563         u8              flags;
564 };
565
566 typedef void (*MPT_ADD_SGE)(void *pAddr, u32 flagslength, dma_addr_t dma_addr);
567 typedef void (*MPT_ADD_CHAIN)(void *pAddr, u8 next, u16 length,
568                 dma_addr_t dma_addr);
569
570 /*
571  *  Adapter Structure - pci_dev specific. Maximum: MPT_MAX_ADAPTERS
572  */
573 typedef struct _MPT_ADAPTER
574 {
575         int                      id;            /* Unique adapter id N {0,1,2,...} */
576         int                      pci_irq;       /* This irq           */
577         char                     name[MPT_NAME_LENGTH]; /* "iocN"             */
578         char                     prod_name[MPT_NAME_LENGTH];    /* "LSIFC9x9"         */
579         char                     board_name[16];
580         char                     board_assembly[16];
581         char                     board_tracer[16];
582         u16                      nvdata_version_persistent;
583         u16                      nvdata_version_default;
584         int                      debug_level;
585         u8                       io_missing_delay;
586         u8                       device_missing_delay;
587         SYSIF_REGS __iomem      *chip;          /* == c8817000 (mmap) */
588         SYSIF_REGS __iomem      *pio_chip;      /* Programmed IO (downloadboot) */
589         u8                       bus_type;
590         u32                      mem_phys;      /* == f4020000 (mmap) */
591         u32                      pio_mem_phys;  /* Programmed IO (downloadboot) */
592         int                      mem_size;      /* mmap memory size */
593         int                      number_of_buses;
594         int                      devices_per_bus;
595         int                      alloc_total;
596         u32                      last_state;
597         int                      active;
598         u8                      *alloc;         /* frames alloc ptr */
599         dma_addr_t               alloc_dma;
600         u32                      alloc_sz;
601         MPT_FRAME_HDR           *reply_frames;  /* Reply msg frames - rounded up! */
602         u32                      reply_frames_low_dma;
603         int                      reply_depth;   /* Num Allocated reply frames */
604         int                      reply_sz;      /* Reply frame size */
605         int                      num_chain;     /* Number of chain buffers */
606         MPT_ADD_SGE              add_sge;       /* Pointer to add_sge
607                                                    function */
608         MPT_ADD_CHAIN            add_chain;     /* Pointer to add_chain
609                                                    function */
610                 /* Pool of buffers for chaining. ReqToChain
611                  * and ChainToChain track index of chain buffers.
612                  * ChainBuffer (DMA) virt/phys addresses.
613                  * FreeChainQ (lock) locking mechanisms.
614                  */
615         int                     *ReqToChain;
616         int                     *RequestNB;
617         int                     *ChainToChain;
618         u8                      *ChainBuffer;
619         dma_addr_t               ChainBufferDMA;
620         struct list_head         FreeChainQ;
621         spinlock_t               FreeChainQlock;
622                 /* We (host driver) get to manage our own RequestQueue! */
623         dma_addr_t               req_frames_dma;
624         MPT_FRAME_HDR           *req_frames;    /* Request msg frames - rounded up! */
625         u32                      req_frames_low_dma;
626         int                      req_depth;     /* Number of request frames */
627         int                      req_sz;        /* Request frame size (bytes) */
628         spinlock_t               FreeQlock;
629         struct list_head         FreeQ;
630                 /* Pool of SCSI sense buffers for commands coming from
631                  * the SCSI mid-layer.  We have one 256 byte sense buffer
632                  * for each REQ entry.
633                  */
634         u8                      *sense_buf_pool;
635         dma_addr_t               sense_buf_pool_dma;
636         u32                      sense_buf_low_dma;
637         u8                      *HostPageBuffer; /* SAS - host page buffer support */
638         u32                     HostPageBuffer_sz;
639         dma_addr_t              HostPageBuffer_dma;
640         int                      mtrr_reg;
641         struct pci_dev          *pcidev;        /* struct pci_dev pointer */
642         int                     bars;           /* bitmask of BAR's that must be configured */
643         int                     msi_enable;
644         u8                      __iomem *memmap;        /* mmap address */
645         struct Scsi_Host        *sh;            /* Scsi Host pointer */
646         SpiCfgData              spi_data;       /* Scsi config. data */
647         RaidCfgData             raid_data;      /* Raid config. data */
648         SasCfgData              sas_data;       /* Sas config. data */
649         FcCfgData               fc_data;        /* Fc config. data */
650         struct proc_dir_entry   *ioc_dentry;
651         struct _MPT_ADAPTER     *alt_ioc;       /* ptr to 929 bound adapter port */
652         u32                      biosVersion;   /* BIOS version from IO Unit Page 2 */
653         int                      eventTypes;    /* Event logging parameters */
654         int                      eventContext;  /* Next event context */
655         int                      eventLogSize;  /* Max number of cached events */
656         struct _mpt_ioctl_events *events;       /* pointer to event log */
657         u8                      *cached_fw;     /* Pointer to FW */
658         dma_addr_t              cached_fw_dma;
659         int                      hs_reply_idx;
660 #ifndef MFCNT
661         u32                      pad0;
662 #else
663         u32                      mfcnt;
664 #endif
665         u32                      NB_for_64_byte_frame;
666         u32                      hs_req[MPT_MAX_FRAME_SIZE/sizeof(u32)];
667         u16                      hs_reply[MPT_MAX_FRAME_SIZE/sizeof(u16)];
668         IOCFactsReply_t          facts;
669         PortFactsReply_t         pfacts[2];
670         FCPortPage0_t            fc_port_page0[2];
671         LANPage0_t               lan_cnfg_page0;
672         LANPage1_t               lan_cnfg_page1;
673
674         u8                       ir_firmware; /* =1 if IR firmware detected */
675         /*
676          * Description: errata_flag_1064
677          * If a PCIX read occurs within 1 or 2 cycles after the chip receives
678          * a split completion for a read data, an internal address pointer incorrectly
679          * increments by 32 bytes
680          */
681         int                      errata_flag_1064;
682         int                      aen_event_read_flag; /* flag to indicate event log was read*/
683         u8                       FirstWhoInit;
684         u8                       upload_fw;     /* If set, do a fw upload */
685         u8                       reload_fw;     /* Force a FW Reload on next reset */
686         u8                       NBShiftFactor;  /* NB Shift Factor based on Block Size (Facts)  */
687         u8                       pad1[4];
688         u8                       DoneCtx;
689         u8                       TaskCtx;
690         u8                       InternalCtx;
691         spinlock_t               initializing_hba_lock;
692         int                      initializing_hba_lock_flag;
693         struct list_head         list;
694         struct net_device       *netdev;
695         struct list_head         sas_topology;
696         struct mutex             sas_topology_mutex;
697         struct mutex             sas_discovery_mutex;
698         u8                       sas_discovery_runtime;
699         u8                       sas_discovery_ignore_events;
700         u8                       sas_discovery_quiesce_io;
701         int                      sas_index; /* index refrencing */
702         MPT_MGMT                 sas_mgmt;
703         MPT_MGMT                 mptbase_cmds; /* for sending config pages */
704         MPT_MGMT                 internal_cmds;
705         MPT_MGMT                 taskmgmt_cmds;
706         MPT_MGMT                 ioctl_cmds;
707         spinlock_t               taskmgmt_lock; /* diagnostic reset lock */
708         int                      taskmgmt_in_progress;
709         u8                       taskmgmt_quiesce_io;
710         u8                       ioc_reset_in_progress;
711         struct work_struct       sas_persist_task;
712
713         struct work_struct       fc_setup_reset_work;
714         struct list_head         fc_rports;
715         struct work_struct       fc_lsc_work;
716         u8                       fc_link_speed[2];
717         spinlock_t               fc_rescan_work_lock;
718         struct work_struct       fc_rescan_work;
719         char                     fc_rescan_work_q_name[20];
720         struct workqueue_struct *fc_rescan_work_q;
721         struct scsi_cmnd        **ScsiLookup;
722         spinlock_t                scsi_lookup_lock;
723         u64                     dma_mask;
724         char                     reset_work_q_name[20];
725         struct workqueue_struct *reset_work_q;
726         struct delayed_work      fault_reset_work;
727         spinlock_t               fault_reset_work_lock;
728
729         u8                      sg_addr_size;
730         u8                      SGE_size;
731
732 } MPT_ADAPTER;
733
734 /*
735  *  New return value convention:
736  *    1 = Ok to free associated request frame
737  *    0 = not Ok ...
738  */
739 typedef int (*MPT_CALLBACK)(MPT_ADAPTER *ioc, MPT_FRAME_HDR *req, MPT_FRAME_HDR *reply);
740 typedef int (*MPT_EVHANDLER)(MPT_ADAPTER *ioc, EventNotificationReply_t *evReply);
741 typedef int (*MPT_RESETHANDLER)(MPT_ADAPTER *ioc, int reset_phase);
742 /* reset_phase defs */
743 #define MPT_IOC_PRE_RESET               0
744 #define MPT_IOC_POST_RESET              1
745 #define MPT_IOC_SETUP_RESET             2
746
747 /*
748  * Invent MPT host event (super-set of MPI Events)
749  * Fitted to 1030's 64-byte [max] request frame size
750  */
751 typedef struct _MPT_HOST_EVENT {
752         EventNotificationReply_t         MpiEvent;      /* 8 32-bit words! */
753         u32                              pad[6];
754         void                            *next;
755 } MPT_HOST_EVENT;
756
757 #define MPT_HOSTEVENT_IOC_BRINGUP       0x91
758 #define MPT_HOSTEVENT_IOC_RECOVER       0x92
759
760 /* Define the generic types based on the size
761  * of the dma_addr_t type.
762  */
763 typedef struct _mpt_sge {
764         u32             FlagsLength;
765         dma_addr_t      Address;
766 } MptSge_t;
767
768
769 #define mpt_msg_flags(ioc) \
770         (ioc->sg_addr_size == sizeof(u64)) ?            \
771         MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_64 :             \
772         MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_32
773
774 #define MPT_SGE_FLAGS_64_BIT_ADDRESSING \
775         (MPI_SGE_FLAGS_64_BIT_ADDRESSING << MPI_SGE_FLAGS_SHIFT)
776
777 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
778 /*
779  *  Funky (private) macros...
780  */
781 #include "mptdebug.h"
782
783 #define MPT_INDEX_2_MFPTR(ioc,idx) \
784         (MPT_FRAME_HDR*)( (u8*)(ioc)->req_frames + (ioc)->req_sz * (idx) )
785
786 #define MFPTR_2_MPT_INDEX(ioc,mf) \
787         (int)( ((u8*)mf - (u8*)(ioc)->req_frames) / (ioc)->req_sz )
788
789 #define MPT_INDEX_2_RFPTR(ioc,idx) \
790         (MPT_FRAME_HDR*)( (u8*)(ioc)->reply_frames + (ioc)->req_sz * (idx) )
791
792 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
793
794 #define SCSI_STD_SENSE_BYTES    18
795 #define SCSI_STD_INQUIRY_BYTES  36
796 #define SCSI_MAX_INQUIRY_BYTES  96
797
798 /*
799  * MPT_SCSI_HOST defines - Used by the IOCTL and the SCSI drivers
800  * Private to the driver.
801  */
802 /* LOCAL structure and fields used when processing
803  * internally generated commands. These include:
804  * bus scan, dv and config requests.
805  */
806 typedef struct _MPT_LOCAL_REPLY {
807         ConfigPageHeader_t header;
808         int     completion;
809         u8      sense[SCSI_STD_SENSE_BYTES];
810         u8      scsiStatus;
811         u8      skip;
812         u32     pad;
813 } MPT_LOCAL_REPLY;
814
815 #define MPT_HOST_BUS_UNKNOWN            (0xFF)
816 #define MPT_HOST_TOO_MANY_TM            (0x05)
817 #define MPT_HOST_NVRAM_INVALID          (0xFFFFFFFF)
818 #define MPT_HOST_NO_CHAIN               (0xFFFFFFFF)
819 #define MPT_NVRAM_MASK_TIMEOUT          (0x000000FF)
820 #define MPT_NVRAM_SYNC_MASK             (0x0000FF00)
821 #define MPT_NVRAM_SYNC_SHIFT            (8)
822 #define MPT_NVRAM_DISCONNECT_ENABLE     (0x00010000)
823 #define MPT_NVRAM_ID_SCAN_ENABLE        (0x00020000)
824 #define MPT_NVRAM_LUN_SCAN_ENABLE       (0x00040000)
825 #define MPT_NVRAM_TAG_QUEUE_ENABLE      (0x00080000)
826 #define MPT_NVRAM_WIDE_DISABLE          (0x00100000)
827 #define MPT_NVRAM_BOOT_CHOICE           (0x00200000)
828
829 /* The TM_STATE variable is used to provide strict single threading of TM
830  * requests as well as communicate TM error conditions.
831  */
832 #define TM_STATE_NONE          (0)
833 #define TM_STATE_IN_PROGRESS   (1)
834 #define TM_STATE_ERROR         (2)
835
836 typedef enum {
837         FC,
838         SPI,
839         SAS
840 } BUS_TYPE;
841
842 typedef struct _MPT_SCSI_HOST {
843         MPT_ADAPTER              *ioc;
844         int                       port;
845         u32                       pad0;
846         MPT_LOCAL_REPLY          *pLocal;               /* used for internal commands */
847         struct timer_list         timer;
848                 /* Pool of memory for holding SCpnts before doing
849                  * OS callbacks. freeQ is the free pool.
850                  */
851         u8                        negoNvram;            /* DV disabled, nego NVRAM */
852         u8                        pad1;
853         u8                        rsvd[2];
854         MPT_FRAME_HDR            *cmdPtr;               /* Ptr to nonOS request */
855         struct scsi_cmnd         *abortSCpnt;
856         MPT_LOCAL_REPLY           localReply;           /* internal cmd reply struct */
857         unsigned long             hard_resets;          /* driver forced bus resets count */
858         unsigned long             soft_resets;          /* fw/external bus resets count */
859         unsigned long             timeouts;             /* cmd timeouts */
860         ushort                    sel_timeout[MPT_MAX_FC_DEVICES];
861         char                      *info_kbuf;
862         long                      last_queue_full;
863         u16                       tm_iocstatus;
864         u16                       spi_pending;
865         struct list_head          target_reset_list;
866 } MPT_SCSI_HOST;
867
868 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
869 /*
870  *      More Dynamic Multi-Pathing stuff...
871  */
872
873 /* Forward decl, a strange C thing, to prevent gcc compiler warnings */
874 struct scsi_cmnd;
875
876 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
877 /*
878  * Generic structure passed to the base mpt_config function.
879  */
880 typedef struct _x_config_parms {
881         union {
882                 ConfigExtendedPageHeader_t      *ehdr;
883                 ConfigPageHeader_t      *hdr;
884         } cfghdr;
885         dma_addr_t               physAddr;
886         u32                      pageAddr;      /* properly formatted */
887         u16                      status;
888         u8                       action;
889         u8                       dir;
890         u8                       timeout;       /* seconds */
891 } CONFIGPARMS;
892
893 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
894 /*
895  *  Public entry points...
896  */
897 extern int       mpt_attach(struct pci_dev *pdev, const struct pci_device_id *id);
898 extern void      mpt_detach(struct pci_dev *pdev);
899 #ifdef CONFIG_PM
900 extern int       mpt_suspend(struct pci_dev *pdev, pm_message_t state);
901 extern int       mpt_resume(struct pci_dev *pdev);
902 #endif
903 extern u8        mpt_register(MPT_CALLBACK cbfunc, MPT_DRIVER_CLASS dclass);
904 extern void      mpt_deregister(u8 cb_idx);
905 extern int       mpt_event_register(u8 cb_idx, MPT_EVHANDLER ev_cbfunc);
906 extern void      mpt_event_deregister(u8 cb_idx);
907 extern int       mpt_reset_register(u8 cb_idx, MPT_RESETHANDLER reset_func);
908 extern void      mpt_reset_deregister(u8 cb_idx);
909 extern int       mpt_device_driver_register(struct mpt_pci_driver * dd_cbfunc, u8 cb_idx);
910 extern void      mpt_device_driver_deregister(u8 cb_idx);
911 extern MPT_FRAME_HDR    *mpt_get_msg_frame(u8 cb_idx, MPT_ADAPTER *ioc);
912 extern void      mpt_free_msg_frame(MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);
913 extern void      mpt_put_msg_frame(u8 cb_idx, MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);
914 extern void      mpt_put_msg_frame_hi_pri(u8 cb_idx, MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);
915
916 extern int       mpt_send_handshake_request(u8 cb_idx, MPT_ADAPTER *ioc, int reqBytes, u32 *req, int sleepFlag);
917 extern int       mpt_verify_adapter(int iocid, MPT_ADAPTER **iocpp);
918 extern u32       mpt_GetIocState(MPT_ADAPTER *ioc, int cooked);
919 extern void      mpt_print_ioc_summary(MPT_ADAPTER *ioc, char *buf, int *size, int len, int showlan);
920 extern int       mpt_HardResetHandler(MPT_ADAPTER *ioc, int sleepFlag);
921 extern int       mpt_config(MPT_ADAPTER *ioc, CONFIGPARMS *cfg);
922 extern int       mpt_alloc_fw_memory(MPT_ADAPTER *ioc, int size);
923 extern void      mpt_free_fw_memory(MPT_ADAPTER *ioc);
924 extern int       mpt_findImVolumes(MPT_ADAPTER *ioc);
925 extern int       mptbase_sas_persist_operation(MPT_ADAPTER *ioc, u8 persist_opcode);
926 extern int       mpt_raid_phys_disk_pg0(MPT_ADAPTER *ioc, u8 phys_disk_num, pRaidPhysDiskPage0_t phys_disk);
927 extern int       mpt_set_taskmgmt_in_progress_flag(MPT_ADAPTER *ioc);
928 extern void      mpt_clear_taskmgmt_in_progress_flag(MPT_ADAPTER *ioc);
929 extern void     mpt_halt_firmware(MPT_ADAPTER *ioc);
930
931
932 /*
933  *  Public data decl's...
934  */
935 extern struct list_head   ioc_list;
936 extern int mpt_fwfault_debug;
937
938 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
939 #endif          /* } __KERNEL__ */
940
941 #ifdef CONFIG_64BIT
942 #define CAST_U32_TO_PTR(x)      ((void *)(u64)x)
943 #define CAST_PTR_TO_U32(x)      ((u32)(u64)x)
944 #else
945 #define CAST_U32_TO_PTR(x)      ((void *)x)
946 #define CAST_PTR_TO_U32(x)      ((u32)x)
947 #endif
948
949 #define MPT_PROTOCOL_FLAGS_c_c_c_c(pflags) \
950         ((pflags) & MPI_PORTFACTS_PROTOCOL_INITIATOR)   ? 'I' : 'i',    \
951         ((pflags) & MPI_PORTFACTS_PROTOCOL_TARGET)      ? 'T' : 't',    \
952         ((pflags) & MPI_PORTFACTS_PROTOCOL_LAN)         ? 'L' : 'l',    \
953         ((pflags) & MPI_PORTFACTS_PROTOCOL_LOGBUSADDR)  ? 'B' : 'b'
954
955 /*
956  *  Shifted SGE Defines - Use in SGE with FlagsLength member.
957  *  Otherwise, use MPI_xxx defines (refer to "lsi/mpi.h" header).
958  *  Defaults: 32 bit SGE, SYSTEM_ADDRESS if direction bit is 0, read
959  */
960 #define MPT_TRANSFER_IOC_TO_HOST                (0x00000000)
961 #define MPT_TRANSFER_HOST_TO_IOC                (0x04000000)
962 #define MPT_SGE_FLAGS_LAST_ELEMENT              (0x80000000)
963 #define MPT_SGE_FLAGS_END_OF_BUFFER             (0x40000000)
964 #define MPT_SGE_FLAGS_LOCAL_ADDRESS             (0x08000000)
965 #define MPT_SGE_FLAGS_DIRECTION                 (0x04000000)
966 #define MPT_SGE_FLAGS_END_OF_LIST               (0x01000000)
967
968 #define MPT_SGE_FLAGS_TRANSACTION_ELEMENT       (0x00000000)
969 #define MPT_SGE_FLAGS_SIMPLE_ELEMENT            (0x10000000)
970 #define MPT_SGE_FLAGS_CHAIN_ELEMENT             (0x30000000)
971 #define MPT_SGE_FLAGS_ELEMENT_MASK              (0x30000000)
972
973 #define MPT_SGE_FLAGS_SSIMPLE_READ \
974         (MPT_SGE_FLAGS_LAST_ELEMENT |   \
975          MPT_SGE_FLAGS_END_OF_BUFFER |  \
976          MPT_SGE_FLAGS_END_OF_LIST |    \
977          MPT_SGE_FLAGS_SIMPLE_ELEMENT | \
978          MPT_TRANSFER_IOC_TO_HOST)
979 #define MPT_SGE_FLAGS_SSIMPLE_WRITE \
980         (MPT_SGE_FLAGS_LAST_ELEMENT |   \
981          MPT_SGE_FLAGS_END_OF_BUFFER |  \
982          MPT_SGE_FLAGS_END_OF_LIST |    \
983          MPT_SGE_FLAGS_SIMPLE_ELEMENT | \
984          MPT_TRANSFER_HOST_TO_IOC)
985
986 /*}-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
987 #endif
988