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