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