xref: /openbmc/linux/drivers/message/fusion/mptbase.h (revision edb9068d0d7a3ba92f66b8c86cba625f3a439f64)
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: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 
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.05"
79 #define MPT_LINUX_PACKAGE_NAME		"@(#)mptlinux-3.04.05"
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 	char			 board_name[16];
542 	char			 board_assembly[16];
543 	char			 board_tracer[16];
544 	u16			 nvdata_version_persistent;
545 	u16			 nvdata_version_default;
546 	u8			 io_missing_delay;
547 	u8			 device_missing_delay;
548 	SYSIF_REGS __iomem	*chip;		/* == c8817000 (mmap) */
549 	SYSIF_REGS __iomem	*pio_chip;	/* Programmed IO (downloadboot) */
550 	u8			 bus_type;
551 	u32			 mem_phys;	/* == f4020000 (mmap) */
552 	u32			 pio_mem_phys;	/* Programmed IO (downloadboot) */
553 	int			 mem_size;	/* mmap memory size */
554 	int			 number_of_buses;
555 	int			 devices_per_bus;
556 	int			 alloc_total;
557 	u32			 last_state;
558 	int			 active;
559 	u8			*alloc;		/* frames alloc ptr */
560 	dma_addr_t		 alloc_dma;
561 	u32			 alloc_sz;
562 	MPT_FRAME_HDR		*reply_frames;	/* Reply msg frames - rounded up! */
563 	u32			 reply_frames_low_dma;
564 	int			 reply_depth;	/* Num Allocated reply frames */
565 	int			 reply_sz;	/* Reply frame size */
566 	int			 num_chain;	/* Number of chain buffers */
567 		/* Pool of buffers for chaining. ReqToChain
568 		 * and ChainToChain track index of chain buffers.
569 		 * ChainBuffer (DMA) virt/phys addresses.
570 		 * FreeChainQ (lock) locking mechanisms.
571 		 */
572 	int			*ReqToChain;
573 	int			*RequestNB;
574 	int			*ChainToChain;
575 	u8			*ChainBuffer;
576 	dma_addr_t		 ChainBufferDMA;
577 	struct list_head	 FreeChainQ;
578 	spinlock_t		 FreeChainQlock;
579 		/* We (host driver) get to manage our own RequestQueue! */
580 	dma_addr_t		 req_frames_dma;
581 	MPT_FRAME_HDR		*req_frames;	/* Request msg frames - rounded up! */
582 	u32			 req_frames_low_dma;
583 	int			 req_depth;	/* Number of request frames */
584 	int			 req_sz;	/* Request frame size (bytes) */
585 	spinlock_t		 FreeQlock;
586 	struct list_head	 FreeQ;
587 		/* Pool of SCSI sense buffers for commands coming from
588 		 * the SCSI mid-layer.  We have one 256 byte sense buffer
589 		 * for each REQ entry.
590 		 */
591 	u8			*sense_buf_pool;
592 	dma_addr_t		 sense_buf_pool_dma;
593 	u32			 sense_buf_low_dma;
594 	u8			*HostPageBuffer; /* SAS - host page buffer support */
595 	u32			HostPageBuffer_sz;
596 	dma_addr_t		HostPageBuffer_dma;
597 	int			 mtrr_reg;
598 	struct pci_dev		*pcidev;	/* struct pci_dev pointer */
599 	u8			__iomem *memmap;	/* mmap address */
600 	struct Scsi_Host	*sh;		/* Scsi Host pointer */
601 	SpiCfgData		spi_data;	/* Scsi config. data */
602 	RaidCfgData		raid_data;	/* Raid config. data */
603 	SasCfgData		sas_data;	/* Sas config. data */
604 	FcCfgData		fc_data;	/* Fc config. data */
605 	MPT_IOCTL		*ioctl;		/* ioctl data pointer */
606 	struct proc_dir_entry	*ioc_dentry;
607 	struct _MPT_ADAPTER	*alt_ioc;	/* ptr to 929 bound adapter port */
608 	spinlock_t		 diagLock;	/* diagnostic reset lock */
609 	int			 diagPending;
610 	u32			 biosVersion;	/* BIOS version from IO Unit Page 2 */
611 	int			 eventTypes;	/* Event logging parameters */
612 	int			 eventContext;	/* Next event context */
613 	int			 eventLogSize;	/* Max number of cached events */
614 	struct _mpt_ioctl_events *events;	/* pointer to event log */
615 	u8			*cached_fw;	/* Pointer to FW */
616 	dma_addr_t	 	cached_fw_dma;
617 	struct list_head	 configQ;	/* linked list of config. requests */
618 	int			 hs_reply_idx;
619 #ifndef MFCNT
620 	u32			 pad0;
621 #else
622 	u32			 mfcnt;
623 #endif
624 	u32			 NB_for_64_byte_frame;
625 	u32			 hs_req[MPT_MAX_FRAME_SIZE/sizeof(u32)];
626 	u16			 hs_reply[MPT_MAX_FRAME_SIZE/sizeof(u16)];
627 	IOCFactsReply_t		 facts;
628 	PortFactsReply_t	 pfacts[2];
629 	FCPortPage0_t		 fc_port_page0[2];
630 	struct timer_list	 persist_timer;	/* persist table timer */
631 	int			 persist_wait_done; /* persist completion flag */
632 	u8			 persist_reply_frame[MPT_DEFAULT_FRAME_SIZE]; /* persist reply */
633 	LANPage0_t		 lan_cnfg_page0;
634 	LANPage1_t		 lan_cnfg_page1;
635 
636 	u8			 ir_firmware; /* =1 if IR firmware detected */
637 	/*
638 	 * Description: errata_flag_1064
639 	 * If a PCIX read occurs within 1 or 2 cycles after the chip receives
640 	 * a split completion for a read data, an internal address pointer incorrectly
641 	 * increments by 32 bytes
642 	 */
643 	int			 errata_flag_1064;
644 	int			 aen_event_read_flag; /* flag to indicate event log was read*/
645 	u8			 FirstWhoInit;
646 	u8			 upload_fw;	/* If set, do a fw upload */
647 	u8			 reload_fw;	/* Force a FW Reload on next reset */
648 	u8			 NBShiftFactor;  /* NB Shift Factor based on Block Size (Facts)  */
649 	u8			 pad1[4];
650 	int			 DoneCtx;
651 	int			 TaskCtx;
652 	int			 InternalCtx;
653 	spinlock_t		 initializing_hba_lock;
654 	int 	 		 initializing_hba_lock_flag;
655 	struct list_head	 list;
656 	struct net_device	*netdev;
657 	struct list_head	 sas_topology;
658 	struct mutex		 sas_topology_mutex;
659 	struct mutex		 sas_discovery_mutex;
660 	u8			 sas_discovery_runtime;
661 	u8			 sas_discovery_ignore_events;
662 	u16			 handle;
663 	int			 sas_index; /* index refrencing */
664 	MPT_SAS_MGMT		 sas_mgmt;
665 	struct work_struct	 sas_persist_task;
666 
667 	struct work_struct	 fc_setup_reset_work;
668 	struct list_head	 fc_rports;
669 	spinlock_t		 fc_rescan_work_lock;
670 	struct work_struct	 fc_rescan_work;
671 	char			 fc_rescan_work_q_name[KOBJ_NAME_LEN];
672 	struct workqueue_struct *fc_rescan_work_q;
673 } MPT_ADAPTER;
674 
675 /*
676  *  New return value convention:
677  *    1 = Ok to free associated request frame
678  *    0 = not Ok ...
679  */
680 typedef int (*MPT_CALLBACK)(MPT_ADAPTER *ioc, MPT_FRAME_HDR *req, MPT_FRAME_HDR *reply);
681 typedef int (*MPT_EVHANDLER)(MPT_ADAPTER *ioc, EventNotificationReply_t *evReply);
682 typedef int (*MPT_RESETHANDLER)(MPT_ADAPTER *ioc, int reset_phase);
683 /* reset_phase defs */
684 #define MPT_IOC_PRE_RESET		0
685 #define MPT_IOC_POST_RESET		1
686 #define MPT_IOC_SETUP_RESET		2
687 
688 /*
689  * Invent MPT host event (super-set of MPI Events)
690  * Fitted to 1030's 64-byte [max] request frame size
691  */
692 typedef struct _MPT_HOST_EVENT {
693 	EventNotificationReply_t	 MpiEvent;	/* 8 32-bit words! */
694 	u32				 pad[6];
695 	void				*next;
696 } MPT_HOST_EVENT;
697 
698 #define MPT_HOSTEVENT_IOC_BRINGUP	0x91
699 #define MPT_HOSTEVENT_IOC_RECOVER	0x92
700 
701 /* Define the generic types based on the size
702  * of the dma_addr_t type.
703  */
704 typedef struct _mpt_sge {
705 	u32		FlagsLength;
706 	dma_addr_t	Address;
707 } MptSge_t;
708 
709 #define mpt_addr_size() \
710 	((sizeof(dma_addr_t) == sizeof(u64)) ? MPI_SGE_FLAGS_64_BIT_ADDRESSING : \
711 		MPI_SGE_FLAGS_32_BIT_ADDRESSING)
712 
713 #define mpt_msg_flags() \
714 	((sizeof(dma_addr_t) == sizeof(u64)) ? MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_64 : \
715 		MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_32)
716 
717 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
718 /*
719  *  Funky (private) macros...
720  */
721 #ifdef MPT_DEBUG
722 #define dprintk(x)  printk x
723 #else
724 #define dprintk(x)
725 #endif
726 
727 #ifdef MPT_DEBUG_INIT
728 #define dinitprintk(x)  printk x
729 #define DBG_DUMP_FW_REQUEST_FRAME(mfp) \
730 	{	int  i, n = 10;						\
731 		u32 *m = (u32 *)(mfp);					\
732 		printk(KERN_INFO " ");					\
733 		for (i=0; i<n; i++)					\
734 			printk(" %08x", le32_to_cpu(m[i]));		\
735 		printk("\n");						\
736 	}
737 #else
738 #define dinitprintk(x)
739 #define DBG_DUMP_FW_REQUEST_FRAME(mfp)
740 #endif
741 
742 #ifdef MPT_DEBUG_EXIT
743 #define dexitprintk(x)  printk x
744 #else
745 #define dexitprintk(x)
746 #endif
747 
748 #if defined MPT_DEBUG_FAIL || defined (MPT_DEBUG_SG)
749 #define dfailprintk(x) printk x
750 #else
751 #define dfailprintk(x)
752 #endif
753 
754 #ifdef MPT_DEBUG_HANDSHAKE
755 #define dhsprintk(x)  printk x
756 #else
757 #define dhsprintk(x)
758 #endif
759 
760 #if defined(MPT_DEBUG_EVENTS) || defined(MPT_DEBUG_VERBOSE_EVENTS)
761 #define devtprintk(x)  printk x
762 #else
763 #define devtprintk(x)
764 #endif
765 
766 #ifdef MPT_DEBUG_VERBOSE_EVENTS
767 #define devtverboseprintk(x)  printk x
768 #else
769 #define devtverboseprintk(x)
770 #endif
771 
772 #ifdef MPT_DEBUG_RESET
773 #define drsprintk(x)  printk x
774 #else
775 #define drsprintk(x)
776 #endif
777 
778 //#if defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
779 #if defined(MPT_DEBUG_MSG_FRAME)
780 #define dmfprintk(x)  printk x
781 #define DBG_DUMP_REQUEST_FRAME(mfp) \
782 	{	int  i, n = 24;						\
783 		u32 *m = (u32 *)(mfp);					\
784 		for (i=0; i<n; i++) {					\
785 			if (i && ((i%8)==0))				\
786 				printk("\n");				\
787 			printk("%08x ", le32_to_cpu(m[i]));		\
788 		}							\
789 		printk("\n");						\
790 	}
791 #else
792 #define dmfprintk(x)
793 #define DBG_DUMP_REQUEST_FRAME(mfp)
794 #endif
795 
796 #ifdef MPT_DEBUG_IRQ
797 #define dirqprintk(x)  printk x
798 #else
799 #define dirqprintk(x)
800 #endif
801 
802 #ifdef MPT_DEBUG_SG
803 #define dsgprintk(x)  printk x
804 #else
805 #define dsgprintk(x)
806 #endif
807 
808 #if defined(MPT_DEBUG_DL) || defined(MPT_DEBUG)
809 #define ddlprintk(x)  printk x
810 #else
811 #define ddlprintk(x)
812 #endif
813 
814 #ifdef MPT_DEBUG_DV
815 #define ddvprintk(x)  printk x
816 #else
817 #define ddvprintk(x)
818 #endif
819 
820 #if defined(MPT_DEBUG_DV) || defined(MPT_DEBUG_DV_TINY)
821 #define ddvtprintk(x)  printk x
822 #else
823 #define ddvtprintk(x)
824 #endif
825 
826 #ifdef MPT_DEBUG_IOCTL
827 #define dctlprintk(x) printk x
828 #else
829 #define dctlprintk(x)
830 #endif
831 
832 #ifdef MPT_DEBUG_REPLY
833 #define dreplyprintk(x) printk x
834 #else
835 #define dreplyprintk(x)
836 #endif
837 
838 #ifdef DMPT_DEBUG_FC
839 #define dfcprintk(x) printk x
840 #else
841 #define dfcprintk(x)
842 #endif
843 
844 #ifdef MPT_DEBUG_TM
845 #define dtmprintk(x) printk x
846 #define DBG_DUMP_TM_REQUEST_FRAME(mfp) \
847 	{	u32 *m = (u32 *)(mfp);					\
848 		int  i, n = 13;						\
849 		printk("TM_REQUEST:\n");				\
850 		for (i=0; i<n; i++) {					\
851 			if (i && ((i%8)==0))				\
852 				printk("\n");				\
853 			printk("%08x ", le32_to_cpu(m[i]));		\
854 		}							\
855 		printk("\n");						\
856 	}
857 #define DBG_DUMP_TM_REPLY_FRAME(mfp) \
858 	{	u32 *m = (u32 *)(mfp);					\
859 		int  i, n = (le32_to_cpu(m[0]) & 0x00FF0000) >> 16;	\
860 		printk("TM_REPLY MessageLength=%d:\n", n);		\
861 		for (i=0; i<n; i++) {					\
862 			if (i && ((i%8)==0))				\
863 				printk("\n");				\
864 			printk(" %08x", le32_to_cpu(m[i]));		\
865 		}							\
866 		printk("\n");						\
867 	}
868 #else
869 #define dtmprintk(x)
870 #define DBG_DUMP_TM_REQUEST_FRAME(mfp)
871 #define DBG_DUMP_TM_REPLY_FRAME(mfp)
872 #endif
873 
874 #if defined(MPT_DEBUG_CONFIG) || defined(MPT_DEBUG)
875 #define dcprintk(x) printk x
876 #else
877 #define dcprintk(x)
878 #endif
879 
880 #if defined(MPT_DEBUG_SCSI) || defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
881 #define dsprintk(x) printk x
882 #else
883 #define dsprintk(x)
884 #endif
885 
886 
887 #define MPT_INDEX_2_MFPTR(ioc,idx) \
888 	(MPT_FRAME_HDR*)( (u8*)(ioc)->req_frames + (ioc)->req_sz * (idx) )
889 
890 #define MFPTR_2_MPT_INDEX(ioc,mf) \
891 	(int)( ((u8*)mf - (u8*)(ioc)->req_frames) / (ioc)->req_sz )
892 
893 #define MPT_INDEX_2_RFPTR(ioc,idx) \
894 	(MPT_FRAME_HDR*)( (u8*)(ioc)->reply_frames + (ioc)->req_sz * (idx) )
895 
896 #if defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
897 #define DBG_DUMP_REPLY_FRAME(mfp) \
898 	{	u32 *m = (u32 *)(mfp);					\
899 		int  i, n = (le32_to_cpu(m[0]) & 0x00FF0000) >> 16;	\
900 		printk(KERN_INFO " ");					\
901 		for (i=0; i<n; i++)					\
902 			printk(" %08x", le32_to_cpu(m[i]));		\
903 		printk("\n");						\
904 	}
905 #define DBG_DUMP_REQUEST_FRAME_HDR(mfp) \
906 	{	int  i, n = 3;						\
907 		u32 *m = (u32 *)(mfp);					\
908 		printk(KERN_INFO " ");					\
909 		for (i=0; i<n; i++)					\
910 			printk(" %08x", le32_to_cpu(m[i]));		\
911 		printk("\n");						\
912 	}
913 #else
914 #define DBG_DUMP_REPLY_FRAME(mfp)
915 #define DBG_DUMP_REQUEST_FRAME_HDR(mfp)
916 #endif
917 
918 // debug sas wide ports
919 #ifdef MPT_DEBUG_SAS_WIDE
920 #define dsaswideprintk(x) printk x
921 #else
922 #define dsaswideprintk(x)
923 #endif
924 
925 
926 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
927 
928 #define SCSI_STD_SENSE_BYTES    18
929 #define SCSI_STD_INQUIRY_BYTES  36
930 #define SCSI_MAX_INQUIRY_BYTES  96
931 
932 /*
933  * MPT_SCSI_HOST defines - Used by the IOCTL and the SCSI drivers
934  * Private to the driver.
935  */
936 /* LOCAL structure and fields used when processing
937  * internally generated commands. These include:
938  * bus scan, dv and config requests.
939  */
940 typedef struct _MPT_LOCAL_REPLY {
941 	ConfigPageHeader_t header;
942 	int	completion;
943 	u8	sense[SCSI_STD_SENSE_BYTES];
944 	u8	scsiStatus;
945 	u8	skip;
946 	u32	pad;
947 } MPT_LOCAL_REPLY;
948 
949 #define MPT_HOST_BUS_UNKNOWN		(0xFF)
950 #define MPT_HOST_TOO_MANY_TM		(0x05)
951 #define MPT_HOST_NVRAM_INVALID		(0xFFFFFFFF)
952 #define MPT_HOST_NO_CHAIN		(0xFFFFFFFF)
953 #define MPT_NVRAM_MASK_TIMEOUT		(0x000000FF)
954 #define MPT_NVRAM_SYNC_MASK		(0x0000FF00)
955 #define MPT_NVRAM_SYNC_SHIFT		(8)
956 #define MPT_NVRAM_DISCONNECT_ENABLE	(0x00010000)
957 #define MPT_NVRAM_ID_SCAN_ENABLE	(0x00020000)
958 #define MPT_NVRAM_LUN_SCAN_ENABLE	(0x00040000)
959 #define MPT_NVRAM_TAG_QUEUE_ENABLE	(0x00080000)
960 #define MPT_NVRAM_WIDE_DISABLE		(0x00100000)
961 #define MPT_NVRAM_BOOT_CHOICE		(0x00200000)
962 
963 /* The TM_STATE variable is used to provide strict single threading of TM
964  * requests as well as communicate TM error conditions.
965  */
966 #define TM_STATE_NONE          (0)
967 #define	TM_STATE_IN_PROGRESS   (1)
968 #define	TM_STATE_ERROR	       (2)
969 
970 typedef enum {
971 	FC,
972 	SPI,
973 	SAS
974 } BUS_TYPE;
975 
976 typedef struct _MPT_SCSI_HOST {
977 	MPT_ADAPTER		 *ioc;
978 	int			  port;
979 	u32			  pad0;
980 	struct scsi_cmnd	**ScsiLookup;
981 	MPT_LOCAL_REPLY		 *pLocal;		/* used for internal commands */
982 	struct timer_list	  timer;
983 		/* Pool of memory for holding SCpnts before doing
984 		 * OS callbacks. freeQ is the free pool.
985 		 */
986 	u8			  tmPending;
987 	u8			  resetPending;
988 	u8			  negoNvram;		/* DV disabled, nego NVRAM */
989 	u8			  pad1;
990 	u8                        tmState;
991 	u8			  rsvd[2];
992 	MPT_FRAME_HDR		 *cmdPtr;		/* Ptr to nonOS request */
993 	struct scsi_cmnd	 *abortSCpnt;
994 	MPT_LOCAL_REPLY		  localReply;		/* internal cmd reply struct */
995 	unsigned long		  hard_resets;		/* driver forced bus resets count */
996 	unsigned long		  soft_resets;		/* fw/external bus resets count */
997 	unsigned long		  timeouts;		/* cmd timeouts */
998 	ushort			  sel_timeout[MPT_MAX_FC_DEVICES];
999 	char 			  *info_kbuf;
1000 	wait_queue_head_t	  scandv_waitq;
1001 	int			  scandv_wait_done;
1002 	long			  last_queue_full;
1003 	u16			  tm_iocstatus;
1004 	u16			  spi_pending;
1005 	struct list_head	  target_reset_list;
1006 } MPT_SCSI_HOST;
1007 
1008 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1009 /*
1010  *	More Dynamic Multi-Pathing stuff...
1011  */
1012 
1013 /* Forward decl, a strange C thing, to prevent gcc compiler warnings */
1014 struct scsi_cmnd;
1015 
1016 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1017 /*
1018  * Generic structure passed to the base mpt_config function.
1019  */
1020 typedef struct _x_config_parms {
1021 	struct list_head	 linkage;	/* linked list */
1022 	struct timer_list	 timer;		/* timer function for this request  */
1023 	union {
1024 		ConfigExtendedPageHeader_t	*ehdr;
1025 		ConfigPageHeader_t	*hdr;
1026 	} cfghdr;
1027 	dma_addr_t		 physAddr;
1028 	int			 wait_done;	/* wait for this request */
1029 	u32			 pageAddr;	/* properly formatted */
1030 	u8			 action;
1031 	u8			 dir;
1032 	u8			 timeout;	/* seconds */
1033 	u8			 pad1;
1034 	u16			 status;
1035 	u16			 pad2;
1036 } CONFIGPARMS;
1037 
1038 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1039 /*
1040  *  Public entry points...
1041  */
1042 extern int	 mpt_attach(struct pci_dev *pdev, const struct pci_device_id *id);
1043 extern void	 mpt_detach(struct pci_dev *pdev);
1044 #ifdef CONFIG_PM
1045 extern int	 mpt_suspend(struct pci_dev *pdev, pm_message_t state);
1046 extern int	 mpt_resume(struct pci_dev *pdev);
1047 #endif
1048 extern int	 mpt_register(MPT_CALLBACK cbfunc, MPT_DRIVER_CLASS dclass);
1049 extern void	 mpt_deregister(int cb_idx);
1050 extern int	 mpt_event_register(int cb_idx, MPT_EVHANDLER ev_cbfunc);
1051 extern void	 mpt_event_deregister(int cb_idx);
1052 extern int	 mpt_reset_register(int cb_idx, MPT_RESETHANDLER reset_func);
1053 extern void	 mpt_reset_deregister(int cb_idx);
1054 extern int	 mpt_device_driver_register(struct mpt_pci_driver * dd_cbfunc, int cb_idx);
1055 extern void	 mpt_device_driver_deregister(int cb_idx);
1056 extern MPT_FRAME_HDR	*mpt_get_msg_frame(int handle, MPT_ADAPTER *ioc);
1057 extern void	 mpt_free_msg_frame(MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);
1058 extern void	 mpt_put_msg_frame(int handle, MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);
1059 extern void	 mpt_add_sge(char *pAddr, u32 flagslength, dma_addr_t dma_addr);
1060 
1061 extern int	 mpt_send_handshake_request(int handle, MPT_ADAPTER *ioc, int reqBytes, u32 *req, int sleepFlag);
1062 extern int	 mpt_verify_adapter(int iocid, MPT_ADAPTER **iocpp);
1063 extern u32	 mpt_GetIocState(MPT_ADAPTER *ioc, int cooked);
1064 extern void	 mpt_print_ioc_summary(MPT_ADAPTER *ioc, char *buf, int *size, int len, int showlan);
1065 extern int	 mpt_HardResetHandler(MPT_ADAPTER *ioc, int sleepFlag);
1066 extern int	 mpt_config(MPT_ADAPTER *ioc, CONFIGPARMS *cfg);
1067 extern void	 mpt_alloc_fw_memory(MPT_ADAPTER *ioc, int size);
1068 extern void	 mpt_free_fw_memory(MPT_ADAPTER *ioc);
1069 extern int	 mpt_findImVolumes(MPT_ADAPTER *ioc);
1070 extern int	 mptbase_sas_persist_operation(MPT_ADAPTER *ioc, u8 persist_opcode);
1071 extern int	 mpt_raid_phys_disk_pg0(MPT_ADAPTER *ioc, u8 phys_disk_num, pRaidPhysDiskPage0_t phys_disk);
1072 
1073 /*
1074  *  Public data decl's...
1075  */
1076 extern struct list_head	  ioc_list;
1077 extern struct proc_dir_entry	*mpt_proc_root_dir;
1078 
1079 extern int		  mpt_lan_index;	/* needed by mptlan.c */
1080 extern int		  mpt_stm_index;	/* needed by mptstm.c */
1081 
1082 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1083 #endif		/* } __KERNEL__ */
1084 
1085 #if defined(__alpha__) || defined(__sparc_v9__) || defined(__ia64__) || defined(__x86_64__) || defined(__powerpc__)
1086 #define CAST_U32_TO_PTR(x)	((void *)(u64)x)
1087 #define CAST_PTR_TO_U32(x)	((u32)(u64)x)
1088 #else
1089 #define CAST_U32_TO_PTR(x)	((void *)x)
1090 #define CAST_PTR_TO_U32(x)	((u32)x)
1091 #endif
1092 
1093 #define MPT_PROTOCOL_FLAGS_c_c_c_c(pflags) \
1094 	((pflags) & MPI_PORTFACTS_PROTOCOL_INITIATOR)	? 'I' : 'i',	\
1095 	((pflags) & MPI_PORTFACTS_PROTOCOL_TARGET)	? 'T' : 't',	\
1096 	((pflags) & MPI_PORTFACTS_PROTOCOL_LAN)		? 'L' : 'l',	\
1097 	((pflags) & MPI_PORTFACTS_PROTOCOL_LOGBUSADDR)	? 'B' : 'b'
1098 
1099 /*
1100  *  Shifted SGE Defines - Use in SGE with FlagsLength member.
1101  *  Otherwise, use MPI_xxx defines (refer to "lsi/mpi.h" header).
1102  *  Defaults: 32 bit SGE, SYSTEM_ADDRESS if direction bit is 0, read
1103  */
1104 #define MPT_TRANSFER_IOC_TO_HOST		(0x00000000)
1105 #define MPT_TRANSFER_HOST_TO_IOC		(0x04000000)
1106 #define MPT_SGE_FLAGS_LAST_ELEMENT		(0x80000000)
1107 #define MPT_SGE_FLAGS_END_OF_BUFFER		(0x40000000)
1108 #define MPT_SGE_FLAGS_LOCAL_ADDRESS		(0x08000000)
1109 #define MPT_SGE_FLAGS_DIRECTION			(0x04000000)
1110 #define MPT_SGE_FLAGS_ADDRESSING		(mpt_addr_size() << MPI_SGE_FLAGS_SHIFT)
1111 #define MPT_SGE_FLAGS_END_OF_LIST		(0x01000000)
1112 
1113 #define MPT_SGE_FLAGS_TRANSACTION_ELEMENT	(0x00000000)
1114 #define MPT_SGE_FLAGS_SIMPLE_ELEMENT		(0x10000000)
1115 #define MPT_SGE_FLAGS_CHAIN_ELEMENT		(0x30000000)
1116 #define MPT_SGE_FLAGS_ELEMENT_MASK		(0x30000000)
1117 
1118 #define MPT_SGE_FLAGS_SSIMPLE_READ \
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_IOC_TO_HOST)
1125 #define MPT_SGE_FLAGS_SSIMPLE_WRITE \
1126 	(MPT_SGE_FLAGS_LAST_ELEMENT |	\
1127 	 MPT_SGE_FLAGS_END_OF_BUFFER |	\
1128 	 MPT_SGE_FLAGS_END_OF_LIST |	\
1129 	 MPT_SGE_FLAGS_SIMPLE_ELEMENT |	\
1130 	 MPT_SGE_FLAGS_ADDRESSING | \
1131 	 MPT_TRANSFER_HOST_TO_IOC)
1132 
1133 /*}-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1134 #endif
1135 
1136