aacraid.h revision 8418852d11f0bbaeebeedd4243560d8fdc85410d 
1#if (!defined(dprintk))
2# define dprintk(x)
3#endif
4/* eg: if (nblank(dprintk(x))) */
5#define _nblank(x) #x
6#define nblank(x) _nblank(x)[0]
7
8#include <linux/interrupt.h>
9
10/*------------------------------------------------------------------------------
11 *              D E F I N E S
12 *----------------------------------------------------------------------------*/
13
14#ifndef AAC_DRIVER_BUILD
15# define AAC_DRIVER_BUILD 2423
16# define AAC_DRIVER_BRANCH "-mh3"
17#endif
18#define MAXIMUM_NUM_CONTAINERS	32
19
20#define AAC_NUM_MGT_FIB         8
21#define AAC_NUM_IO_FIB		(512 - AAC_NUM_MGT_FIB)
22#define AAC_NUM_FIB		(AAC_NUM_IO_FIB + AAC_NUM_MGT_FIB)
23
24#define AAC_MAX_LUN		(8)
25
26#define AAC_MAX_HOSTPHYSMEMPAGES (0xfffff)
27#define AAC_MAX_32BIT_SGBCOUNT	((unsigned short)256)
28
29/*
30 * These macros convert from physical channels to virtual channels
31 */
32#define CONTAINER_CHANNEL		(0)
33#define CONTAINER_TO_CHANNEL(cont)	(CONTAINER_CHANNEL)
34#define CONTAINER_TO_ID(cont)		(cont)
35#define CONTAINER_TO_LUN(cont)		(0)
36
37#define aac_phys_to_logical(x)  (x+1)
38#define aac_logical_to_phys(x)  (x?x-1:0)
39
40/* #define AAC_DETAILED_STATUS_INFO */
41
42struct diskparm
43{
44	int heads;
45	int sectors;
46	int cylinders;
47};
48
49
50/*
51 *	DON'T CHANGE THE ORDER, this is set by the firmware
52 */
53
54#define		CT_NONE			0
55#define		CT_VOLUME		1
56#define		CT_MIRROR		2
57#define		CT_STRIPE		3
58#define		CT_RAID5		4
59#define		CT_SSRW			5
60#define		CT_SSRO			6
61#define		CT_MORPH		7
62#define		CT_PASSTHRU		8
63#define		CT_RAID4		9
64#define		CT_RAID10		10	/* stripe of mirror */
65#define		CT_RAID00		11	/* stripe of stripe */
66#define		CT_VOLUME_OF_MIRRORS	12	/* volume of mirror */
67#define		CT_PSEUDO_RAID		13	/* really raid4 */
68#define		CT_LAST_VOLUME_TYPE	14
69#define 	CT_OK        		218
70
71/*
72 *	Types of objects addressable in some fashion by the client.
73 *	This is a superset of those objects handled just by the filesystem
74 *	and includes "raw" objects that an administrator would use to
75 *	configure containers and filesystems.
76 */
77
78#define		FT_REG		1	/* regular file */
79#define		FT_DIR		2	/* directory */
80#define		FT_BLK		3	/* "block" device - reserved */
81#define		FT_CHR		4	/* "character special" device - reserved */
82#define		FT_LNK		5	/* symbolic link */
83#define		FT_SOCK		6	/* socket */
84#define		FT_FIFO		7	/* fifo */
85#define		FT_FILESYS	8	/* ADAPTEC's "FSA"(tm) filesystem */
86#define		FT_DRIVE	9	/* physical disk - addressable in scsi by bus/id/lun */
87#define		FT_SLICE	10	/* virtual disk - raw volume - slice */
88#define		FT_PARTITION	11	/* FSA partition - carved out of a slice - building block for containers */
89#define		FT_VOLUME	12	/* Container - Volume Set */
90#define		FT_STRIPE	13	/* Container - Stripe Set */
91#define		FT_MIRROR	14	/* Container - Mirror Set */
92#define		FT_RAID5	15	/* Container - Raid 5 Set */
93#define		FT_DATABASE	16	/* Storage object with "foreign" content manager */
94
95/*
96 *	Host side memory scatter gather list
97 *	Used by the adapter for read, write, and readdirplus operations
98 *	We have separate 32 and 64 bit version because even
99 *	on 64 bit systems not all cards support the 64 bit version
100 */
101struct sgentry {
102	__le32	addr;	/* 32-bit address. */
103	__le32	count;	/* Length. */
104};
105
106struct user_sgentry {
107	u32	addr;	/* 32-bit address. */
108	u32	count;	/* Length. */
109};
110
111struct sgentry64 {
112	__le32	addr[2];	/* 64-bit addr. 2 pieces for data alignment */
113	__le32	count;	/* Length. */
114};
115
116struct user_sgentry64 {
117	u32	addr[2];	/* 64-bit addr. 2 pieces for data alignment */
118	u32	count;	/* Length. */
119};
120
121struct sgentryraw {
122	__le32		next;	/* reserved for F/W use */
123	__le32		prev;	/* reserved for F/W use */
124	__le32		addr[2];
125	__le32		count;
126	__le32		flags;	/* reserved for F/W use */
127};
128
129struct user_sgentryraw {
130	u32		next;	/* reserved for F/W use */
131	u32		prev;	/* reserved for F/W use */
132	u32		addr[2];
133	u32		count;
134	u32		flags;	/* reserved for F/W use */
135};
136
137/*
138 *	SGMAP
139 *
140 *	This is the SGMAP structure for all commands that use
141 *	32-bit addressing.
142 */
143
144struct sgmap {
145	__le32		count;
146	struct sgentry	sg[1];
147};
148
149struct user_sgmap {
150	u32		count;
151	struct user_sgentry	sg[1];
152};
153
154struct sgmap64 {
155	__le32		count;
156	struct sgentry64 sg[1];
157};
158
159struct user_sgmap64 {
160	u32		count;
161	struct user_sgentry64 sg[1];
162};
163
164struct sgmapraw {
165	__le32		  count;
166	struct sgentryraw sg[1];
167};
168
169struct user_sgmapraw {
170	u32		  count;
171	struct user_sgentryraw sg[1];
172};
173
174struct creation_info
175{
176	u8 		buildnum;		/* e.g., 588 */
177	u8 		usec;			/* e.g., 588 */
178	u8	 	via;			/* e.g., 1 = FSU,
179						 * 	 2 = API
180						 */
181	u8	 	year;		 	/* e.g., 1997 = 97 */
182	__le32		date;			/*
183						 * unsigned 	Month		:4;	// 1 - 12
184						 * unsigned 	Day		:6;	// 1 - 32
185						 * unsigned 	Hour		:6;	// 0 - 23
186						 * unsigned 	Minute		:6;	// 0 - 60
187						 * unsigned 	Second		:6;	// 0 - 60
188						 */
189	__le32		serial[2];			/* e.g., 0x1DEADB0BFAFAF001 */
190};
191
192
193/*
194 *	Define all the constants needed for the communication interface
195 */
196
197/*
198 *	Define how many queue entries each queue will have and the total
199 *	number of entries for the entire communication interface. Also define
200 *	how many queues we support.
201 *
202 *	This has to match the controller
203 */
204
205#define NUMBER_OF_COMM_QUEUES  8   // 4 command; 4 response
206#define HOST_HIGH_CMD_ENTRIES  4
207#define HOST_NORM_CMD_ENTRIES  8
208#define ADAP_HIGH_CMD_ENTRIES  4
209#define ADAP_NORM_CMD_ENTRIES  512
210#define HOST_HIGH_RESP_ENTRIES 4
211#define HOST_NORM_RESP_ENTRIES 512
212#define ADAP_HIGH_RESP_ENTRIES 4
213#define ADAP_NORM_RESP_ENTRIES 8
214
215#define TOTAL_QUEUE_ENTRIES  \
216    (HOST_NORM_CMD_ENTRIES + HOST_HIGH_CMD_ENTRIES + ADAP_NORM_CMD_ENTRIES + ADAP_HIGH_CMD_ENTRIES + \
217	    HOST_NORM_RESP_ENTRIES + HOST_HIGH_RESP_ENTRIES + ADAP_NORM_RESP_ENTRIES + ADAP_HIGH_RESP_ENTRIES)
218
219
220/*
221 *	Set the queues on a 16 byte alignment
222 */
223
224#define QUEUE_ALIGNMENT		16
225
226/*
227 *	The queue headers define the Communication Region queues. These
228 *	are physically contiguous and accessible by both the adapter and the
229 *	host. Even though all queue headers are in the same contiguous block
230 *	they will be represented as individual units in the data structures.
231 */
232
233struct aac_entry {
234	__le32 size; /* Size in bytes of Fib which this QE points to */
235	__le32 addr; /* Receiver address of the FIB */
236};
237
238/*
239 *	The adapter assumes the ProducerIndex and ConsumerIndex are grouped
240 *	adjacently and in that order.
241 */
242
243struct aac_qhdr {
244	__le64 header_addr;/* Address to hand the adapter to access
245			      to this queue head */
246	__le32 *producer; /* The producer index for this queue (host address) */
247	__le32 *consumer; /* The consumer index for this queue (host address) */
248};
249
250/*
251 *	Define all the events which the adapter would like to notify
252 *	the host of.
253 */
254
255#define		HostNormCmdQue		1	/* Change in host normal priority command queue */
256#define		HostHighCmdQue		2	/* Change in host high priority command queue */
257#define		HostNormRespQue		3	/* Change in host normal priority response queue */
258#define		HostHighRespQue		4	/* Change in host high priority response queue */
259#define		AdapNormRespNotFull	5
260#define		AdapHighRespNotFull	6
261#define		AdapNormCmdNotFull	7
262#define		AdapHighCmdNotFull	8
263#define		SynchCommandComplete	9
264#define		AdapInternalError	0xfe    /* The adapter detected an internal error shutting down */
265
266/*
267 *	Define all the events the host wishes to notify the
268 *	adapter of. The first four values much match the Qid the
269 *	corresponding queue.
270 */
271
272#define		AdapNormCmdQue		2
273#define		AdapHighCmdQue		3
274#define		AdapNormRespQue		6
275#define		AdapHighRespQue		7
276#define		HostShutdown		8
277#define		HostPowerFail		9
278#define		FatalCommError		10
279#define		HostNormRespNotFull	11
280#define		HostHighRespNotFull	12
281#define		HostNormCmdNotFull	13
282#define		HostHighCmdNotFull	14
283#define		FastIo			15
284#define		AdapPrintfDone		16
285
286/*
287 *	Define all the queues that the adapter and host use to communicate
288 *	Number them to match the physical queue layout.
289 */
290
291enum aac_queue_types {
292        HostNormCmdQueue = 0,	/* Adapter to host normal priority command traffic */
293        HostHighCmdQueue,	/* Adapter to host high priority command traffic */
294        AdapNormCmdQueue,	/* Host to adapter normal priority command traffic */
295        AdapHighCmdQueue,	/* Host to adapter high priority command traffic */
296        HostNormRespQueue,	/* Adapter to host normal priority response traffic */
297        HostHighRespQueue,	/* Adapter to host high priority response traffic */
298        AdapNormRespQueue,	/* Host to adapter normal priority response traffic */
299        AdapHighRespQueue	/* Host to adapter high priority response traffic */
300};
301
302/*
303 *	Assign type values to the FSA communication data structures
304 */
305
306#define		FIB_MAGIC	0x0001
307
308/*
309 *	Define the priority levels the FSA communication routines support.
310 */
311
312#define		FsaNormal	1
313
314/*
315 * Define the FIB. The FIB is the where all the requested data and
316 * command information are put to the application on the FSA adapter.
317 */
318
319struct aac_fibhdr {
320	__le32 XferState;	/* Current transfer state for this CCB */
321	__le16 Command;		/* Routing information for the destination */
322	u8 StructType;		/* Type FIB */
323	u8 Flags;		/* Flags for FIB */
324	__le16 Size;		/* Size of this FIB in bytes */
325	__le16 SenderSize;	/* Size of the FIB in the sender
326				   (for response sizing) */
327	__le32 SenderFibAddress;  /* Host defined data in the FIB */
328	__le32 ReceiverFibAddress;/* Logical address of this FIB for
329				     the adapter */
330	u32 SenderData;		/* Place holder for the sender to store data */
331	union {
332		struct {
333		    __le32 _ReceiverTimeStart; 	/* Timestamp for
334						   receipt of fib */
335		    __le32 _ReceiverTimeDone;	/* Timestamp for
336						   completion of fib */
337		} _s;
338	} _u;
339};
340
341struct hw_fib {
342	struct aac_fibhdr header;
343	u8 data[512-sizeof(struct aac_fibhdr)];	// Command specific data
344};
345
346/*
347 *	FIB commands
348 */
349
350#define 	TestCommandResponse		1
351#define		TestAdapterCommand		2
352/*
353 *	Lowlevel and comm commands
354 */
355#define		LastTestCommand			100
356#define		ReinitHostNormCommandQueue	101
357#define		ReinitHostHighCommandQueue	102
358#define		ReinitHostHighRespQueue		103
359#define		ReinitHostNormRespQueue		104
360#define		ReinitAdapNormCommandQueue	105
361#define		ReinitAdapHighCommandQueue	107
362#define		ReinitAdapHighRespQueue		108
363#define		ReinitAdapNormRespQueue		109
364#define		InterfaceShutdown		110
365#define		DmaCommandFib			120
366#define		StartProfile			121
367#define		TermProfile			122
368#define		SpeedTest			123
369#define		TakeABreakPt			124
370#define		RequestPerfData			125
371#define		SetInterruptDefTimer		126
372#define		SetInterruptDefCount		127
373#define		GetInterruptDefStatus		128
374#define		LastCommCommand			129
375/*
376 *	Filesystem commands
377 */
378#define		NuFileSystem			300
379#define		UFS				301
380#define		HostFileSystem			302
381#define		LastFileSystemCommand		303
382/*
383 *	Container Commands
384 */
385#define		ContainerCommand		500
386#define		ContainerCommand64		501
387#define		ContainerRawIo			502
388/*
389 *	Cluster Commands
390 */
391#define		ClusterCommand	 		550
392/*
393 *	Scsi Port commands (scsi passthrough)
394 */
395#define		ScsiPortCommand			600
396#define		ScsiPortCommand64		601
397/*
398 *	Misc house keeping and generic adapter initiated commands
399 */
400#define		AifRequest			700
401#define		CheckRevision			701
402#define		FsaHostShutdown			702
403#define		RequestAdapterInfo		703
404#define		IsAdapterPaused			704
405#define		SendHostTime			705
406#define		RequestSupplementAdapterInfo	706
407#define		LastMiscCommand			707
408
409/*
410 * Commands that will target the failover level on the FSA adapter
411 */
412
413enum fib_xfer_state {
414	HostOwned 			= (1<<0),
415	AdapterOwned 			= (1<<1),
416	FibInitialized 			= (1<<2),
417	FibEmpty 			= (1<<3),
418	AllocatedFromPool 		= (1<<4),
419	SentFromHost 			= (1<<5),
420	SentFromAdapter 		= (1<<6),
421	ResponseExpected 		= (1<<7),
422	NoResponseExpected 		= (1<<8),
423	AdapterProcessed 		= (1<<9),
424	HostProcessed 			= (1<<10),
425	HighPriority 			= (1<<11),
426	NormalPriority 			= (1<<12),
427	Async				= (1<<13),
428	AsyncIo				= (1<<13),	// rpbfix: remove with new regime
429	PageFileIo			= (1<<14),	// rpbfix: remove with new regime
430	ShutdownRequest			= (1<<15),
431	LazyWrite			= (1<<16),	// rpbfix: remove with new regime
432	AdapterMicroFib			= (1<<17),
433	BIOSFibPath			= (1<<18),
434	FastResponseCapable		= (1<<19),
435	ApiFib				= (1<<20)	// Its an API Fib.
436};
437
438/*
439 *	The following defines needs to be updated any time there is an
440 *	incompatible change made to the aac_init structure.
441 */
442
443#define ADAPTER_INIT_STRUCT_REVISION		3
444#define ADAPTER_INIT_STRUCT_REVISION_4		4 // rocket science
445
446struct aac_init
447{
448	__le32	InitStructRevision;
449	__le32	MiniPortRevision;
450	__le32	fsrev;
451	__le32	CommHeaderAddress;
452	__le32	FastIoCommAreaAddress;
453	__le32	AdapterFibsPhysicalAddress;
454	__le32	AdapterFibsVirtualAddress;
455	__le32	AdapterFibsSize;
456	__le32	AdapterFibAlign;
457	__le32	printfbuf;
458	__le32	printfbufsiz;
459	__le32	HostPhysMemPages;   /* number of 4k pages of host
460				       physical memory */
461	__le32	HostElapsedSeconds; /* number of seconds since 1970. */
462	/*
463	 * ADAPTER_INIT_STRUCT_REVISION_4 begins here
464	 */
465	__le32	InitFlags;	/* flags for supported features */
466#define INITFLAGS_NEW_COMM_SUPPORTED	0x00000001
467	__le32	MaxIoCommands;	/* max outstanding commands */
468	__le32	MaxIoSize;	/* largest I/O command */
469	__le32	MaxFibSize;	/* largest FIB to adapter */
470};
471
472enum aac_log_level {
473	LOG_AAC_INIT			= 10,
474	LOG_AAC_INFORMATIONAL		= 20,
475	LOG_AAC_WARNING			= 30,
476	LOG_AAC_LOW_ERROR		= 40,
477	LOG_AAC_MEDIUM_ERROR		= 50,
478	LOG_AAC_HIGH_ERROR		= 60,
479	LOG_AAC_PANIC			= 70,
480	LOG_AAC_DEBUG			= 80,
481	LOG_AAC_WINDBG_PRINT		= 90
482};
483
484#define FSAFS_NTC_GET_ADAPTER_FIB_CONTEXT	0x030b
485#define FSAFS_NTC_FIB_CONTEXT			0x030c
486
487struct aac_dev;
488struct fib;
489struct scsi_cmnd;
490
491struct adapter_ops
492{
493	/* Low level operations */
494	void (*adapter_interrupt)(struct aac_dev *dev);
495	void (*adapter_notify)(struct aac_dev *dev, u32 event);
496	void (*adapter_disable_int)(struct aac_dev *dev);
497	void (*adapter_enable_int)(struct aac_dev *dev);
498	int  (*adapter_sync_cmd)(struct aac_dev *dev, u32 command, u32 p1, u32 p2, u32 p3, u32 p4, u32 p5, u32 p6, u32 *status, u32 *r1, u32 *r2, u32 *r3, u32 *r4);
499	int  (*adapter_check_health)(struct aac_dev *dev);
500	int  (*adapter_restart)(struct aac_dev *dev, int bled);
501	/* Transport operations */
502	int  (*adapter_ioremap)(struct aac_dev * dev, u32 size);
503	irqreturn_t (*adapter_intr)(int irq, void *dev_id);
504	/* Packet operations */
505	int  (*adapter_deliver)(struct fib * fib);
506	int  (*adapter_bounds)(struct aac_dev * dev, struct scsi_cmnd * cmd, u64 lba);
507	int  (*adapter_read)(struct fib * fib, struct scsi_cmnd * cmd, u64 lba, u32 count);
508	int  (*adapter_write)(struct fib * fib, struct scsi_cmnd * cmd, u64 lba, u32 count);
509	int  (*adapter_scsi)(struct fib * fib, struct scsi_cmnd * cmd);
510	/* Administrative operations */
511	int  (*adapter_comm)(struct aac_dev * dev, int comm);
512};
513
514/*
515 *	Define which interrupt handler needs to be installed
516 */
517
518struct aac_driver_ident
519{
520	int 	(*init)(struct aac_dev *dev);
521	char *	name;
522	char *	vname;
523	char *	model;
524	u16	channels;
525	int	quirks;
526};
527/*
528 * Some adapter firmware needs communication memory
529 * below 2gig. This tells the init function to set the
530 * dma mask such that fib memory will be allocated where the
531 * adapter firmware can get to it.
532 */
533#define AAC_QUIRK_31BIT	0x0001
534
535/*
536 * Some adapter firmware, when the raid card's cache is turned off, can not
537 * split up scatter gathers in order to deal with the limits of the
538 * underlying CHIM. This limit is 34 scatter gather elements.
539 */
540#define AAC_QUIRK_34SG	0x0002
541
542/*
543 * This adapter is a slave (no Firmware)
544 */
545#define AAC_QUIRK_SLAVE 0x0004
546
547/*
548 * This adapter is a master.
549 */
550#define AAC_QUIRK_MASTER 0x0008
551
552/*
553 * Some adapter firmware perform poorly when it must split up scatter gathers
554 * in order to deal with the limits of the underlying CHIM. This limit in this
555 * class of adapters is 17 scatter gather elements.
556 */
557#define AAC_QUIRK_17SG	0x0010
558
559/*
560 *	The adapter interface specs all queues to be located in the same
561 *	physically contigous block. The host structure that defines the
562 *	commuication queues will assume they are each a separate physically
563 *	contigous memory region that will support them all being one big
564 *	contigous block.
565 *	There is a command and response queue for each level and direction of
566 *	commuication. These regions are accessed by both the host and adapter.
567 */
568
569struct aac_queue {
570	u64		 	logical;	/*address we give the adapter */
571	struct aac_entry	*base;		/*system virtual address */
572	struct aac_qhdr 	headers;       	/*producer,consumer q headers*/
573	u32	 		entries;	/*Number of queue entries */
574	wait_queue_head_t	qfull;		/*Event to wait on if q full */
575	wait_queue_head_t	cmdready;	/*Cmd ready from the adapter */
576                  /* This is only valid for adapter to host command queues. */
577	spinlock_t	 	*lock;		/* Spinlock for this queue must take this lock before accessing the lock */
578	spinlock_t		lockdata;	/* Actual lock (used only on one side of the lock) */
579	struct list_head 	cmdq;	   	/* A queue of FIBs which need to be prcessed by the FS thread. This is */
580                                		/* only valid for command queues which receive entries from the adapter. */
581	u32			numpending;	/* Number of entries on outstanding queue. */
582	struct aac_dev *	dev;		/* Back pointer to adapter structure */
583};
584
585/*
586 *	Message queues. The order here is important, see also the
587 *	queue type ordering
588 */
589
590struct aac_queue_block
591{
592	struct aac_queue queue[8];
593};
594
595/*
596 *	SaP1 Message Unit Registers
597 */
598
599struct sa_drawbridge_CSR {
600				/*	Offset 	|  Name */
601	__le32	reserved[10];	/*	00h-27h |  Reserved */
602	u8	LUT_Offset;	/*	28h	|  Lookup Table Offset */
603	u8	reserved1[3];	/* 	29h-2bh	|  Reserved */
604	__le32	LUT_Data;	/*	2ch	|  Looup Table Data */
605	__le32	reserved2[26];	/*	30h-97h	|  Reserved */
606	__le16	PRICLEARIRQ;	/*	98h	|  Primary Clear Irq */
607	__le16	SECCLEARIRQ;	/*	9ah	|  Secondary Clear Irq */
608	__le16	PRISETIRQ;	/*	9ch	|  Primary Set Irq */
609	__le16	SECSETIRQ;	/*	9eh	|  Secondary Set Irq */
610	__le16	PRICLEARIRQMASK;/*	a0h	|  Primary Clear Irq Mask */
611	__le16	SECCLEARIRQMASK;/*	a2h	|  Secondary Clear Irq Mask */
612	__le16	PRISETIRQMASK;	/*	a4h	|  Primary Set Irq Mask */
613	__le16	SECSETIRQMASK;	/*	a6h	|  Secondary Set Irq Mask */
614	__le32	MAILBOX0;	/*	a8h	|  Scratchpad 0 */
615	__le32	MAILBOX1;	/*	ach	|  Scratchpad 1 */
616	__le32	MAILBOX2;	/*	b0h	|  Scratchpad 2 */
617	__le32	MAILBOX3;	/*	b4h	|  Scratchpad 3 */
618	__le32	MAILBOX4;	/*	b8h	|  Scratchpad 4 */
619	__le32	MAILBOX5;	/*	bch	|  Scratchpad 5 */
620	__le32	MAILBOX6;	/*	c0h	|  Scratchpad 6 */
621	__le32	MAILBOX7;	/*	c4h	|  Scratchpad 7 */
622	__le32	ROM_Setup_Data;	/*	c8h 	|  Rom Setup and Data */
623	__le32	ROM_Control_Addr;/*	cch 	|  Rom Control and Address */
624	__le32	reserved3[12];	/*	d0h-ffh	|  reserved */
625	__le32	LUT[64];	/*    100h-1ffh	|  Lookup Table Entries */
626};
627
628#define Mailbox0	SaDbCSR.MAILBOX0
629#define Mailbox1	SaDbCSR.MAILBOX1
630#define Mailbox2	SaDbCSR.MAILBOX2
631#define Mailbox3	SaDbCSR.MAILBOX3
632#define Mailbox4	SaDbCSR.MAILBOX4
633#define Mailbox5	SaDbCSR.MAILBOX5
634#define Mailbox6	SaDbCSR.MAILBOX6
635#define Mailbox7	SaDbCSR.MAILBOX7
636
637#define DoorbellReg_p SaDbCSR.PRISETIRQ
638#define DoorbellReg_s SaDbCSR.SECSETIRQ
639#define DoorbellClrReg_p SaDbCSR.PRICLEARIRQ
640
641
642#define	DOORBELL_0	0x0001
643#define DOORBELL_1	0x0002
644#define DOORBELL_2	0x0004
645#define DOORBELL_3	0x0008
646#define DOORBELL_4	0x0010
647#define DOORBELL_5	0x0020
648#define DOORBELL_6	0x0040
649
650
651#define PrintfReady	DOORBELL_5
652#define PrintfDone	DOORBELL_5
653
654struct sa_registers {
655	struct sa_drawbridge_CSR	SaDbCSR;			/* 98h - c4h */
656};
657
658
659#define Sa_MINIPORT_REVISION			1
660
661#define sa_readw(AEP, CSR)		readl(&((AEP)->regs.sa->CSR))
662#define sa_readl(AEP,  CSR)		readl(&((AEP)->regs.sa->CSR))
663#define sa_writew(AEP, CSR, value)	writew(value, &((AEP)->regs.sa->CSR))
664#define sa_writel(AEP, CSR, value)	writel(value, &((AEP)->regs.sa->CSR))
665
666/*
667 *	Rx Message Unit Registers
668 */
669
670struct rx_mu_registers {
671			    /*	Local  | PCI*| Name */
672	__le32	ARSR;	    /*	1300h  | 00h | APIC Register Select Register */
673	__le32	reserved0;  /*	1304h  | 04h | Reserved */
674	__le32	AWR;	    /*	1308h  | 08h | APIC Window Register */
675	__le32	reserved1;  /*	130Ch  | 0Ch | Reserved */
676	__le32	IMRx[2];    /*	1310h  | 10h | Inbound Message Registers */
677	__le32	OMRx[2];    /*	1318h  | 18h | Outbound Message Registers */
678	__le32	IDR;	    /*	1320h  | 20h | Inbound Doorbell Register */
679	__le32	IISR;	    /*	1324h  | 24h | Inbound Interrupt
680						Status Register */
681	__le32	IIMR;	    /*	1328h  | 28h | Inbound Interrupt
682					 	Mask Register */
683	__le32	ODR;	    /*	132Ch  | 2Ch | Outbound Doorbell Register */
684	__le32	OISR;	    /*	1330h  | 30h | Outbound Interrupt
685						Status Register */
686	__le32	OIMR;	    /*	1334h  | 34h | Outbound Interrupt
687						Mask Register */
688	__le32	reserved2;  /*	1338h  | 38h | Reserved */
689	__le32	reserved3;  /*	133Ch  | 3Ch | Reserved */
690	__le32	InboundQueue;/*	1340h  | 40h | Inbound Queue Port relative to firmware */
691	__le32	OutboundQueue;/*1344h  | 44h | Outbound Queue Port relative to firmware */
692			    /* * Must access through ATU Inbound
693			     	 Translation Window */
694};
695
696struct rx_inbound {
697	__le32	Mailbox[8];
698};
699
700#define	INBOUNDDOORBELL_0	0x00000001
701#define INBOUNDDOORBELL_1	0x00000002
702#define INBOUNDDOORBELL_2	0x00000004
703#define INBOUNDDOORBELL_3	0x00000008
704#define INBOUNDDOORBELL_4	0x00000010
705#define INBOUNDDOORBELL_5	0x00000020
706#define INBOUNDDOORBELL_6	0x00000040
707
708#define	OUTBOUNDDOORBELL_0	0x00000001
709#define OUTBOUNDDOORBELL_1	0x00000002
710#define OUTBOUNDDOORBELL_2	0x00000004
711#define OUTBOUNDDOORBELL_3	0x00000008
712#define OUTBOUNDDOORBELL_4	0x00000010
713
714#define InboundDoorbellReg	MUnit.IDR
715#define OutboundDoorbellReg	MUnit.ODR
716
717struct rx_registers {
718	struct rx_mu_registers		MUnit;		/* 1300h - 1344h */
719	__le32				reserved1[2];	/* 1348h - 134ch */
720	struct rx_inbound		IndexRegs;
721};
722
723#define rx_readb(AEP, CSR)		readb(&((AEP)->regs.rx->CSR))
724#define rx_readl(AEP, CSR)		readl(&((AEP)->regs.rx->CSR))
725#define rx_writeb(AEP, CSR, value)	writeb(value, &((AEP)->regs.rx->CSR))
726#define rx_writel(AEP, CSR, value)	writel(value, &((AEP)->regs.rx->CSR))
727
728/*
729 *	Rkt Message Unit Registers (same as Rx, except a larger reserve region)
730 */
731
732#define rkt_mu_registers rx_mu_registers
733#define rkt_inbound rx_inbound
734
735struct rkt_registers {
736	struct rkt_mu_registers		MUnit;		 /* 1300h - 1344h */
737	__le32				reserved1[1006]; /* 1348h - 22fch */
738	struct rkt_inbound		IndexRegs;	 /* 2300h - */
739};
740
741#define rkt_readb(AEP, CSR)		readb(&((AEP)->regs.rkt->CSR))
742#define rkt_readl(AEP, CSR)		readl(&((AEP)->regs.rkt->CSR))
743#define rkt_writeb(AEP, CSR, value)	writeb(value, &((AEP)->regs.rkt->CSR))
744#define rkt_writel(AEP, CSR, value)	writel(value, &((AEP)->regs.rkt->CSR))
745
746typedef void (*fib_callback)(void *ctxt, struct fib *fibctx);
747
748struct aac_fib_context {
749	s16	 		type;		// used for verification of structure
750	s16	 		size;
751	u32			unique;		// unique value representing this context
752	ulong			jiffies;	// used for cleanup - dmb changed to ulong
753	struct list_head	next;		// used to link context's into a linked list
754	struct semaphore 	wait_sem;	// this is used to wait for the next fib to arrive.
755	int			wait;		// Set to true when thread is in WaitForSingleObject
756	unsigned long		count;		// total number of FIBs on FibList
757	struct list_head	fib_list;	// this holds fibs and their attachd hw_fibs
758};
759
760struct sense_data {
761	u8 error_code;		/* 70h (current errors), 71h(deferred errors) */
762	u8 valid:1;		/* A valid bit of one indicates that the information  */
763				/* field contains valid information as defined in the
764				 * SCSI-2 Standard.
765				 */
766	u8 segment_number;	/* Only used for COPY, COMPARE, or COPY AND VERIFY Commands */
767	u8 sense_key:4;		/* Sense Key */
768	u8 reserved:1;
769	u8 ILI:1;		/* Incorrect Length Indicator */
770	u8 EOM:1;		/* End Of Medium - reserved for random access devices */
771	u8 filemark:1;		/* Filemark - reserved for random access devices */
772
773	u8 information[4];	/* for direct-access devices, contains the unsigned
774				 * logical block address or residue associated with
775				 * the sense key
776				 */
777	u8 add_sense_len;	/* number of additional sense bytes to follow this field */
778	u8 cmnd_info[4];	/* not used */
779	u8 ASC;			/* Additional Sense Code */
780	u8 ASCQ;		/* Additional Sense Code Qualifier */
781	u8 FRUC;		/* Field Replaceable Unit Code - not used */
782	u8 bit_ptr:3;		/* indicates which byte of the CDB or parameter data
783				 * was in error
784				 */
785	u8 BPV:1;		/* bit pointer valid (BPV): 1- indicates that
786				 * the bit_ptr field has valid value
787				 */
788	u8 reserved2:2;
789	u8 CD:1;		/* command data bit: 1- illegal parameter in CDB.
790				 * 0- illegal parameter in data.
791				 */
792	u8 SKSV:1;
793	u8 field_ptr[2];	/* byte of the CDB or parameter data in error */
794};
795
796struct fsa_dev_info {
797	u64		last;
798	u64		size;
799	u32		type;
800	u32		config_waiting_on;
801	unsigned long	config_waiting_stamp;
802	u16		queue_depth;
803	u8		config_needed;
804	u8		valid;
805	u8		ro;
806	u8		locked;
807	u8		deleted;
808	char		devname[8];
809	struct sense_data sense_data;
810};
811
812struct fib {
813	void			*next;	/* this is used by the allocator */
814	s16			type;
815	s16			size;
816	/*
817	 *	The Adapter that this I/O is destined for.
818	 */
819	struct aac_dev 		*dev;
820	/*
821	 *	This is the event the sendfib routine will wait on if the
822	 *	caller did not pass one and this is synch io.
823	 */
824	struct semaphore 	event_wait;
825	spinlock_t		event_lock;
826
827	u32			done;	/* gets set to 1 when fib is complete */
828	fib_callback 		callback;
829	void 			*callback_data;
830	u32			flags; // u32 dmb was ulong
831	/*
832	 *	And for the internal issue/reply queues (we may be able
833	 *	to merge these two)
834	 */
835	struct list_head	fiblink;
836	void 			*data;
837	struct hw_fib		*hw_fib;		/* Actual shared object */
838	dma_addr_t		hw_fib_pa;		/* physical address of hw_fib*/
839};
840
841/*
842 *	Adapter Information Block
843 *
844 *	This is returned by the RequestAdapterInfo block
845 */
846
847struct aac_adapter_info
848{
849	__le32	platform;
850	__le32	cpu;
851	__le32	subcpu;
852	__le32	clock;
853	__le32	execmem;
854	__le32	buffermem;
855	__le32	totalmem;
856	__le32	kernelrev;
857	__le32	kernelbuild;
858	__le32	monitorrev;
859	__le32	monitorbuild;
860	__le32	hwrev;
861	__le32	hwbuild;
862	__le32	biosrev;
863	__le32	biosbuild;
864	__le32	cluster;
865	__le32	clusterchannelmask;
866	__le32	serial[2];
867	__le32	battery;
868	__le32	options;
869	__le32	OEM;
870};
871
872struct aac_supplement_adapter_info
873{
874	u8	AdapterTypeText[17+1];
875	u8	Pad[2];
876	__le32	FlashMemoryByteSize;
877	__le32	FlashImageId;
878	__le32	MaxNumberPorts;
879	__le32	Version;
880	__le32	FeatureBits;
881	u8	SlotNumber;
882	u8	ReservedPad0[0];
883	u8	BuildDate[12];
884	__le32	CurrentNumberPorts;
885	__le32	ReservedGrowth[24];
886};
887#define AAC_FEATURE_FALCON	0x00000010
888#define AAC_SIS_VERSION_V3	3
889#define AAC_SIS_SLOT_UNKNOWN	0xFF
890
891#define GetBusInfo 0x00000009
892struct aac_bus_info {
893	__le32	Command;	/* VM_Ioctl */
894	__le32	ObjType;	/* FT_DRIVE */
895	__le32	MethodId;	/* 1 = SCSI Layer */
896	__le32	ObjectId;	/* Handle */
897	__le32	CtlCmd;		/* GetBusInfo */
898};
899
900struct aac_bus_info_response {
901	__le32	Status;		/* ST_OK */
902	__le32	ObjType;
903	__le32	MethodId;	/* unused */
904	__le32	ObjectId;	/* unused */
905	__le32	CtlCmd;		/* unused */
906	__le32	ProbeComplete;
907	__le32	BusCount;
908	__le32	TargetsPerBus;
909	u8	InitiatorBusId[10];
910	u8	BusValid[10];
911};
912
913/*
914 * Battery platforms
915 */
916#define AAC_BAT_REQ_PRESENT	(1)
917#define AAC_BAT_REQ_NOTPRESENT	(2)
918#define AAC_BAT_OPT_PRESENT	(3)
919#define AAC_BAT_OPT_NOTPRESENT	(4)
920#define AAC_BAT_NOT_SUPPORTED	(5)
921/*
922 * cpu types
923 */
924#define AAC_CPU_SIMULATOR	(1)
925#define AAC_CPU_I960		(2)
926#define AAC_CPU_STRONGARM	(3)
927
928/*
929 * Supported Options
930 */
931#define AAC_OPT_SNAPSHOT		cpu_to_le32(1)
932#define AAC_OPT_CLUSTERS		cpu_to_le32(1<<1)
933#define AAC_OPT_WRITE_CACHE		cpu_to_le32(1<<2)
934#define AAC_OPT_64BIT_DATA		cpu_to_le32(1<<3)
935#define AAC_OPT_HOST_TIME_FIB		cpu_to_le32(1<<4)
936#define AAC_OPT_RAID50			cpu_to_le32(1<<5)
937#define AAC_OPT_4GB_WINDOW		cpu_to_le32(1<<6)
938#define AAC_OPT_SCSI_UPGRADEABLE 	cpu_to_le32(1<<7)
939#define AAC_OPT_SOFT_ERR_REPORT		cpu_to_le32(1<<8)
940#define AAC_OPT_SUPPORTED_RECONDITION 	cpu_to_le32(1<<9)
941#define AAC_OPT_SGMAP_HOST64		cpu_to_le32(1<<10)
942#define AAC_OPT_ALARM			cpu_to_le32(1<<11)
943#define AAC_OPT_NONDASD			cpu_to_le32(1<<12)
944#define AAC_OPT_SCSI_MANAGED    	cpu_to_le32(1<<13)
945#define AAC_OPT_RAID_SCSI_MODE		cpu_to_le32(1<<14)
946#define AAC_OPT_SUPPLEMENT_ADAPTER_INFO	cpu_to_le32(1<<16)
947#define AAC_OPT_NEW_COMM		cpu_to_le32(1<<17)
948#define AAC_OPT_NEW_COMM_64		cpu_to_le32(1<<18)
949
950struct aac_dev
951{
952	struct list_head	entry;
953	const char		*name;
954	int			id;
955
956	/*
957	 *	negotiated FIB settings
958	 */
959	unsigned		max_fib_size;
960	unsigned		sg_tablesize;
961
962	/*
963	 *	Map for 128 fib objects (64k)
964	 */
965	dma_addr_t		hw_fib_pa;
966	struct hw_fib		*hw_fib_va;
967	struct hw_fib		*aif_base_va;
968	/*
969	 *	Fib Headers
970	 */
971	struct fib              *fibs;
972
973	struct fib		*free_fib;
974	struct fib		*timeout_fib;
975	spinlock_t		fib_lock;
976
977	struct aac_queue_block *queues;
978	/*
979	 *	The user API will use an IOCTL to register itself to receive
980	 *	FIBs from the adapter.  The following list is used to keep
981	 *	track of all the threads that have requested these FIBs.  The
982	 *	mutex is used to synchronize access to all data associated
983	 *	with the adapter fibs.
984	 */
985	struct list_head	fib_list;
986
987	struct adapter_ops	a_ops;
988	unsigned long		fsrev;		/* Main driver's revision number */
989
990	unsigned		base_size;	/* Size of mapped in region */
991	struct aac_init		*init;		/* Holds initialization info to communicate with adapter */
992	dma_addr_t		init_pa; 	/* Holds physical address of the init struct */
993
994	struct pci_dev		*pdev;		/* Our PCI interface */
995	void *			printfbuf;	/* pointer to buffer used for printf's from the adapter */
996	void *			comm_addr;	/* Base address of Comm area */
997	dma_addr_t		comm_phys;	/* Physical Address of Comm area */
998	size_t			comm_size;
999
1000	struct Scsi_Host	*scsi_host_ptr;
1001	int			maximum_num_containers;
1002	int			maximum_num_physicals;
1003	int			maximum_num_channels;
1004	struct fsa_dev_info	*fsa_dev;
1005	struct task_struct	*thread;
1006	int			cardtype;
1007
1008	/*
1009	 *	The following is the device specific extension.
1010	 */
1011#if (!defined(AAC_MIN_FOOTPRINT_SIZE))
1012#	define AAC_MIN_FOOTPRINT_SIZE 8192
1013#endif
1014	union
1015	{
1016		struct sa_registers __iomem *sa;
1017		struct rx_registers __iomem *rx;
1018		struct rkt_registers __iomem *rkt;
1019	} regs;
1020	volatile void __iomem *base;
1021	volatile struct rx_inbound __iomem *IndexRegs;
1022	u32			OIMR; /* Mask Register Cache */
1023	/*
1024	 *	AIF thread states
1025	 */
1026	u32			aif_thread;
1027	struct aac_adapter_info adapter_info;
1028	struct aac_supplement_adapter_info supplement_adapter_info;
1029	/* These are in adapter info but they are in the io flow so
1030	 * lets break them out so we don't have to do an AND to check them
1031	 */
1032	u8			nondasd_support;
1033	u8			dac_support;
1034	u8			raid_scsi_mode;
1035	u8			comm_interface;
1036#	define AAC_COMM_PRODUCER 0
1037#	define AAC_COMM_MESSAGE  1
1038	/* macro side-effects BEWARE */
1039#	define			raw_io_interface \
1040	  init->InitStructRevision==cpu_to_le32(ADAPTER_INIT_STRUCT_REVISION_4)
1041	u8			raw_io_64;
1042	u8			printf_enabled;
1043	u8			in_reset;
1044};
1045
1046#define aac_adapter_interrupt(dev) \
1047	(dev)->a_ops.adapter_interrupt(dev)
1048
1049#define aac_adapter_notify(dev, event) \
1050	(dev)->a_ops.adapter_notify(dev, event)
1051
1052#define aac_adapter_disable_int(dev) \
1053	(dev)->a_ops.adapter_disable_int(dev)
1054
1055#define aac_adapter_enable_int(dev) \
1056	(dev)->a_ops.adapter_enable_int(dev)
1057
1058#define aac_adapter_sync_cmd(dev, command, p1, p2, p3, p4, p5, p6, status, r1, r2, r3, r4) \
1059	(dev)->a_ops.adapter_sync_cmd(dev, command, p1, p2, p3, p4, p5, p6, status, r1, r2, r3, r4)
1060
1061#define aac_adapter_check_health(dev) \
1062	(dev)->a_ops.adapter_check_health(dev)
1063
1064#define aac_adapter_restart(dev,bled) \
1065	(dev)->a_ops.adapter_restart(dev,bled)
1066
1067#define aac_adapter_ioremap(dev, size) \
1068	(dev)->a_ops.adapter_ioremap(dev, size)
1069
1070#define aac_adapter_deliver(fib) \
1071	((fib)->dev)->a_ops.adapter_deliver(fib)
1072
1073#define aac_adapter_bounds(dev,cmd,lba) \
1074	dev->a_ops.adapter_bounds(dev,cmd,lba)
1075
1076#define aac_adapter_read(fib,cmd,lba,count) \
1077	((fib)->dev)->a_ops.adapter_read(fib,cmd,lba,count)
1078
1079#define aac_adapter_write(fib,cmd,lba,count) \
1080	((fib)->dev)->a_ops.adapter_write(fib,cmd,lba,count)
1081
1082#define aac_adapter_scsi(fib,cmd) \
1083	((fib)->dev)->a_ops.adapter_scsi(fib,cmd)
1084
1085#define aac_adapter_comm(dev,comm) \
1086	(dev)->a_ops.adapter_comm(dev, comm)
1087
1088#define FIB_CONTEXT_FLAG_TIMED_OUT		(0x00000001)
1089
1090/*
1091 *	Define the command values
1092 */
1093
1094#define		Null			0
1095#define 	GetAttributes		1
1096#define 	SetAttributes		2
1097#define 	Lookup			3
1098#define 	ReadLink		4
1099#define 	Read			5
1100#define 	Write			6
1101#define		Create			7
1102#define		MakeDirectory		8
1103#define		SymbolicLink		9
1104#define		MakeNode		10
1105#define		Removex			11
1106#define		RemoveDirectoryx	12
1107#define		Rename			13
1108#define		Link			14
1109#define		ReadDirectory		15
1110#define		ReadDirectoryPlus	16
1111#define		FileSystemStatus	17
1112#define		FileSystemInfo		18
1113#define		PathConfigure		19
1114#define		Commit			20
1115#define		Mount			21
1116#define		UnMount			22
1117#define		Newfs			23
1118#define		FsCheck			24
1119#define		FsSync			25
1120#define		SimReadWrite		26
1121#define		SetFileSystemStatus	27
1122#define		BlockRead		28
1123#define		BlockWrite		29
1124#define		NvramIoctl		30
1125#define		FsSyncWait		31
1126#define		ClearArchiveBit		32
1127#define		SetAcl			33
1128#define		GetAcl			34
1129#define		AssignAcl		35
1130#define		FaultInsertion		36	/* Fault Insertion Command */
1131#define		CrazyCache		37	/* Crazycache */
1132
1133#define		MAX_FSACOMMAND_NUM	38
1134
1135
1136/*
1137 *	Define the status returns. These are very unixlike although
1138 *	most are not in fact used
1139 */
1140
1141#define		ST_OK		0
1142#define		ST_PERM		1
1143#define		ST_NOENT	2
1144#define		ST_IO		5
1145#define		ST_NXIO		6
1146#define		ST_E2BIG	7
1147#define		ST_ACCES	13
1148#define		ST_EXIST	17
1149#define		ST_XDEV		18
1150#define		ST_NODEV	19
1151#define		ST_NOTDIR	20
1152#define		ST_ISDIR	21
1153#define		ST_INVAL	22
1154#define		ST_FBIG		27
1155#define		ST_NOSPC	28
1156#define		ST_ROFS		30
1157#define		ST_MLINK	31
1158#define		ST_WOULDBLOCK	35
1159#define		ST_NAMETOOLONG	63
1160#define		ST_NOTEMPTY	66
1161#define		ST_DQUOT	69
1162#define		ST_STALE	70
1163#define		ST_REMOTE	71
1164#define		ST_BADHANDLE	10001
1165#define		ST_NOT_SYNC	10002
1166#define		ST_BAD_COOKIE	10003
1167#define		ST_NOTSUPP	10004
1168#define		ST_TOOSMALL	10005
1169#define		ST_SERVERFAULT	10006
1170#define		ST_BADTYPE	10007
1171#define		ST_JUKEBOX	10008
1172#define		ST_NOTMOUNTED	10009
1173#define		ST_MAINTMODE	10010
1174#define		ST_STALEACL	10011
1175
1176/*
1177 *	On writes how does the client want the data written.
1178 */
1179
1180#define	CACHE_CSTABLE		1
1181#define CACHE_UNSTABLE		2
1182
1183/*
1184 *	Lets the client know at which level the data was commited on
1185 *	a write request
1186 */
1187
1188#define	CMFILE_SYNCH_NVRAM	1
1189#define	CMDATA_SYNCH_NVRAM	2
1190#define	CMFILE_SYNCH		3
1191#define CMDATA_SYNCH		4
1192#define CMUNSTABLE		5
1193
1194struct aac_read
1195{
1196	__le32	 	command;
1197	__le32 		cid;
1198	__le32 		block;
1199	__le32 		count;
1200	struct sgmap	sg;	// Must be last in struct because it is variable
1201};
1202
1203struct aac_read64
1204{
1205	__le32	 	command;
1206	__le16 		cid;
1207	__le16 		sector_count;
1208	__le32 		block;
1209	__le16		pad;
1210	__le16		flags;
1211	struct sgmap64	sg;	// Must be last in struct because it is variable
1212};
1213
1214struct aac_read_reply
1215{
1216	__le32	 	status;
1217	__le32 		count;
1218};
1219
1220struct aac_write
1221{
1222	__le32		command;
1223	__le32 		cid;
1224	__le32 		block;
1225	__le32 		count;
1226	__le32	 	stable;	// Not used
1227	struct sgmap	sg;	// Must be last in struct because it is variable
1228};
1229
1230struct aac_write64
1231{
1232	__le32	 	command;
1233	__le16 		cid;
1234	__le16 		sector_count;
1235	__le32 		block;
1236	__le16		pad;
1237	__le16		flags;
1238	struct sgmap64	sg;	// Must be last in struct because it is variable
1239};
1240struct aac_write_reply
1241{
1242	__le32		status;
1243	__le32 		count;
1244	__le32		committed;
1245};
1246
1247struct aac_raw_io
1248{
1249	__le32		block[2];
1250	__le32		count;
1251	__le16		cid;
1252	__le16		flags;		/* 00 W, 01 R */
1253	__le16		bpTotal;	/* reserved for F/W use */
1254	__le16		bpComplete;	/* reserved for F/W use */
1255	struct sgmapraw	sg;
1256};
1257
1258#define CT_FLUSH_CACHE 129
1259struct aac_synchronize {
1260	__le32		command;	/* VM_ContainerConfig */
1261	__le32		type;		/* CT_FLUSH_CACHE */
1262	__le32		cid;
1263	__le32		parm1;
1264	__le32		parm2;
1265	__le32		parm3;
1266	__le32		parm4;
1267	__le32		count;	/* sizeof(((struct aac_synchronize_reply *)NULL)->data) */
1268};
1269
1270struct aac_synchronize_reply {
1271	__le32		dummy0;
1272	__le32		dummy1;
1273	__le32		status;	/* CT_OK */
1274	__le32		parm1;
1275	__le32		parm2;
1276	__le32		parm3;
1277	__le32		parm4;
1278	__le32		parm5;
1279	u8		data[16];
1280};
1281
1282struct aac_srb
1283{
1284	__le32		function;
1285	__le32		channel;
1286	__le32		id;
1287	__le32		lun;
1288	__le32		timeout;
1289	__le32		flags;
1290	__le32		count;		// Data xfer size
1291	__le32		retry_limit;
1292	__le32		cdb_size;
1293	u8		cdb[16];
1294	struct	sgmap	sg;
1295};
1296
1297/*
1298 * This and associated data structs are used by the
1299 * ioctl caller and are in cpu order.
1300 */
1301struct user_aac_srb
1302{
1303	u32		function;
1304	u32		channel;
1305	u32		id;
1306	u32		lun;
1307	u32		timeout;
1308	u32		flags;
1309	u32		count;		// Data xfer size
1310	u32		retry_limit;
1311	u32		cdb_size;
1312	u8		cdb[16];
1313	struct	user_sgmap	sg;
1314};
1315
1316#define		AAC_SENSE_BUFFERSIZE	 30
1317
1318struct aac_srb_reply
1319{
1320	__le32		status;
1321	__le32		srb_status;
1322	__le32		scsi_status;
1323	__le32		data_xfer_length;
1324	__le32		sense_data_size;
1325	u8		sense_data[AAC_SENSE_BUFFERSIZE]; // Can this be SCSI_SENSE_BUFFERSIZE
1326};
1327/*
1328 * SRB Flags
1329 */
1330#define		SRB_NoDataXfer		 0x0000
1331#define		SRB_DisableDisconnect	 0x0004
1332#define		SRB_DisableSynchTransfer 0x0008
1333#define 	SRB_BypassFrozenQueue	 0x0010
1334#define		SRB_DisableAutosense	 0x0020
1335#define		SRB_DataIn		 0x0040
1336#define 	SRB_DataOut		 0x0080
1337
1338/*
1339 * SRB Functions - set in aac_srb->function
1340 */
1341#define	SRBF_ExecuteScsi	0x0000
1342#define	SRBF_ClaimDevice	0x0001
1343#define	SRBF_IO_Control		0x0002
1344#define	SRBF_ReceiveEvent	0x0003
1345#define	SRBF_ReleaseQueue	0x0004
1346#define	SRBF_AttachDevice	0x0005
1347#define	SRBF_ReleaseDevice	0x0006
1348#define	SRBF_Shutdown		0x0007
1349#define	SRBF_Flush		0x0008
1350#define	SRBF_AbortCommand	0x0010
1351#define	SRBF_ReleaseRecovery	0x0011
1352#define	SRBF_ResetBus		0x0012
1353#define	SRBF_ResetDevice	0x0013
1354#define	SRBF_TerminateIO	0x0014
1355#define	SRBF_FlushQueue		0x0015
1356#define	SRBF_RemoveDevice	0x0016
1357#define	SRBF_DomainValidation	0x0017
1358
1359/*
1360 * SRB SCSI Status - set in aac_srb->scsi_status
1361 */
1362#define SRB_STATUS_PENDING                  0x00
1363#define SRB_STATUS_SUCCESS                  0x01
1364#define SRB_STATUS_ABORTED                  0x02
1365#define SRB_STATUS_ABORT_FAILED             0x03
1366#define SRB_STATUS_ERROR                    0x04
1367#define SRB_STATUS_BUSY                     0x05
1368#define SRB_STATUS_INVALID_REQUEST          0x06
1369#define SRB_STATUS_INVALID_PATH_ID          0x07
1370#define SRB_STATUS_NO_DEVICE                0x08
1371#define SRB_STATUS_TIMEOUT                  0x09
1372#define SRB_STATUS_SELECTION_TIMEOUT        0x0A
1373#define SRB_STATUS_COMMAND_TIMEOUT          0x0B
1374#define SRB_STATUS_MESSAGE_REJECTED         0x0D
1375#define SRB_STATUS_BUS_RESET                0x0E
1376#define SRB_STATUS_PARITY_ERROR             0x0F
1377#define SRB_STATUS_REQUEST_SENSE_FAILED     0x10
1378#define SRB_STATUS_NO_HBA                   0x11
1379#define SRB_STATUS_DATA_OVERRUN             0x12
1380#define SRB_STATUS_UNEXPECTED_BUS_FREE      0x13
1381#define SRB_STATUS_PHASE_SEQUENCE_FAILURE   0x14
1382#define SRB_STATUS_BAD_SRB_BLOCK_LENGTH     0x15
1383#define SRB_STATUS_REQUEST_FLUSHED          0x16
1384#define SRB_STATUS_DELAYED_RETRY	    0x17
1385#define SRB_STATUS_INVALID_LUN              0x20
1386#define SRB_STATUS_INVALID_TARGET_ID        0x21
1387#define SRB_STATUS_BAD_FUNCTION             0x22
1388#define SRB_STATUS_ERROR_RECOVERY           0x23
1389#define SRB_STATUS_NOT_STARTED		    0x24
1390#define SRB_STATUS_NOT_IN_USE		    0x30
1391#define SRB_STATUS_FORCE_ABORT		    0x31
1392#define SRB_STATUS_DOMAIN_VALIDATION_FAIL   0x32
1393
1394/*
1395 * Object-Server / Volume-Manager Dispatch Classes
1396 */
1397
1398#define		VM_Null			0
1399#define		VM_NameServe		1
1400#define		VM_ContainerConfig	2
1401#define		VM_Ioctl		3
1402#define		VM_FilesystemIoctl	4
1403#define		VM_CloseAll		5
1404#define		VM_CtBlockRead		6
1405#define		VM_CtBlockWrite		7
1406#define		VM_SliceBlockRead	8	/* raw access to configured "storage objects" */
1407#define		VM_SliceBlockWrite	9
1408#define		VM_DriveBlockRead	10	/* raw access to physical devices */
1409#define		VM_DriveBlockWrite	11
1410#define		VM_EnclosureMgt		12	/* enclosure management */
1411#define		VM_Unused		13	/* used to be diskset management */
1412#define		VM_CtBlockVerify	14
1413#define		VM_CtPerf		15	/* performance test */
1414#define		VM_CtBlockRead64	16
1415#define		VM_CtBlockWrite64	17
1416#define		VM_CtBlockVerify64	18
1417#define		VM_CtHostRead64		19
1418#define		VM_CtHostWrite64	20
1419#define		VM_DrvErrTblLog		21
1420#define		VM_NameServe64		22
1421
1422#define		MAX_VMCOMMAND_NUM	23	/* used for sizing stats array - leave last */
1423
1424/*
1425 *	Descriptive information (eg, vital stats)
1426 *	that a content manager might report.  The
1427 *	FileArray filesystem component is one example
1428 *	of a content manager.  Raw mode might be
1429 *	another.
1430 */
1431
1432struct aac_fsinfo {
1433	__le32  fsTotalSize;	/* Consumed by fs, incl. metadata */
1434	__le32  fsBlockSize;
1435	__le32  fsFragSize;
1436	__le32  fsMaxExtendSize;
1437	__le32  fsSpaceUnits;
1438	__le32  fsMaxNumFiles;
1439	__le32  fsNumFreeFiles;
1440	__le32  fsInodeDensity;
1441};	/* valid iff ObjType == FT_FILESYS && !(ContentState & FSCS_NOTCLEAN) */
1442
1443union aac_contentinfo {
1444	struct aac_fsinfo filesys;	/* valid iff ObjType == FT_FILESYS && !(ContentState & FSCS_NOTCLEAN) */
1445};
1446
1447/*
1448 *	Query for Container Configuration Status
1449 */
1450
1451#define CT_GET_CONFIG_STATUS 147
1452struct aac_get_config_status {
1453	__le32		command;	/* VM_ContainerConfig */
1454	__le32		type;		/* CT_GET_CONFIG_STATUS */
1455	__le32		parm1;
1456	__le32		parm2;
1457	__le32		parm3;
1458	__le32		parm4;
1459	__le32		parm5;
1460	__le32		count;	/* sizeof(((struct aac_get_config_status_resp *)NULL)->data) */
1461};
1462
1463#define CFACT_CONTINUE 0
1464#define CFACT_PAUSE    1
1465#define CFACT_ABORT    2
1466struct aac_get_config_status_resp {
1467	__le32		response; /* ST_OK */
1468	__le32		dummy0;
1469	__le32		status;	/* CT_OK */
1470	__le32		parm1;
1471	__le32		parm2;
1472	__le32		parm3;
1473	__le32		parm4;
1474	__le32		parm5;
1475	struct {
1476		__le32	action; /* CFACT_CONTINUE, CFACT_PAUSE or CFACT_ABORT */
1477		__le16	flags;
1478		__le16	count;
1479	}		data;
1480};
1481
1482/*
1483 *	Accept the configuration as-is
1484 */
1485
1486#define CT_COMMIT_CONFIG 152
1487
1488struct aac_commit_config {
1489	__le32		command;	/* VM_ContainerConfig */
1490	__le32		type;		/* CT_COMMIT_CONFIG */
1491};
1492
1493/*
1494 *	Query for Container Configuration Status
1495 */
1496
1497#define CT_GET_CONTAINER_COUNT 4
1498struct aac_get_container_count {
1499	__le32		command;	/* VM_ContainerConfig */
1500	__le32		type;		/* CT_GET_CONTAINER_COUNT */
1501};
1502
1503struct aac_get_container_count_resp {
1504	__le32		response; /* ST_OK */
1505	__le32		dummy0;
1506	__le32		MaxContainers;
1507	__le32		ContainerSwitchEntries;
1508	__le32		MaxPartitions;
1509};
1510
1511
1512/*
1513 *	Query for "mountable" objects, ie, objects that are typically
1514 *	associated with a drive letter on the client (host) side.
1515 */
1516
1517struct aac_mntent {
1518	__le32    		oid;
1519	u8			name[16];	/* if applicable */
1520	struct creation_info	create_info;	/* if applicable */
1521	__le32			capacity;
1522	__le32			vol;    	/* substrate structure */
1523	__le32			obj;	        /* FT_FILESYS,
1524						   FT_DATABASE, etc. */
1525	__le32			state;		/* unready for mounting,
1526						   readonly, etc. */
1527	union aac_contentinfo	fileinfo;	/* Info specific to content
1528						   manager (eg, filesystem) */
1529	__le32			altoid;		/* != oid <==> snapshot or
1530						   broken mirror exists */
1531	__le32			capacityhigh;
1532};
1533
1534#define FSCS_NOTCLEAN	0x0001  /* fsck is neccessary before mounting */
1535#define FSCS_READONLY	0x0002	/* possible result of broken mirror */
1536#define FSCS_HIDDEN	0x0004	/* should be ignored - set during a clear */
1537
1538struct aac_query_mount {
1539	__le32		command;
1540	__le32		type;
1541	__le32		count;
1542};
1543
1544struct aac_mount {
1545	__le32		status;
1546	__le32	   	type;           /* should be same as that requested */
1547	__le32		count;
1548	struct aac_mntent mnt[1];
1549};
1550
1551#define CT_READ_NAME 130
1552struct aac_get_name {
1553	__le32		command;	/* VM_ContainerConfig */
1554	__le32		type;		/* CT_READ_NAME */
1555	__le32		cid;
1556	__le32		parm1;
1557	__le32		parm2;
1558	__le32		parm3;
1559	__le32		parm4;
1560	__le32		count;	/* sizeof(((struct aac_get_name_resp *)NULL)->data) */
1561};
1562
1563struct aac_get_name_resp {
1564	__le32		dummy0;
1565	__le32		dummy1;
1566	__le32		status;	/* CT_OK */
1567	__le32		parm1;
1568	__le32		parm2;
1569	__le32		parm3;
1570	__le32		parm4;
1571	__le32		parm5;
1572	u8		data[16];
1573};
1574
1575/*
1576 * The following command is sent to shut down each container.
1577 */
1578
1579struct aac_close {
1580	__le32	command;
1581	__le32	cid;
1582};
1583
1584struct aac_query_disk
1585{
1586	s32	cnum;
1587	s32	bus;
1588	s32	id;
1589	s32	lun;
1590	u32	valid;
1591	u32	locked;
1592	u32	deleted;
1593	s32	instance;
1594	s8	name[10];
1595	u32	unmapped;
1596};
1597
1598struct aac_delete_disk {
1599	u32	disknum;
1600	u32	cnum;
1601};
1602
1603struct fib_ioctl
1604{
1605	u32	fibctx;
1606	s32	wait;
1607	char	__user *fib;
1608};
1609
1610struct revision
1611{
1612	u32 compat;
1613	__le32 version;
1614	__le32 build;
1615};
1616
1617
1618/*
1619 * 	Ugly - non Linux like ioctl coding for back compat.
1620 */
1621
1622#define CTL_CODE(function, method) (                 \
1623    (4<< 16) | ((function) << 2) | (method) \
1624)
1625
1626/*
1627 *	Define the method codes for how buffers are passed for I/O and FS
1628 *	controls
1629 */
1630
1631#define METHOD_BUFFERED                 0
1632#define METHOD_NEITHER                  3
1633
1634/*
1635 *	Filesystem ioctls
1636 */
1637
1638#define FSACTL_SENDFIB                  	CTL_CODE(2050, METHOD_BUFFERED)
1639#define FSACTL_SEND_RAW_SRB               	CTL_CODE(2067, METHOD_BUFFERED)
1640#define FSACTL_DELETE_DISK			0x163
1641#define FSACTL_QUERY_DISK			0x173
1642#define FSACTL_OPEN_GET_ADAPTER_FIB		CTL_CODE(2100, METHOD_BUFFERED)
1643#define FSACTL_GET_NEXT_ADAPTER_FIB		CTL_CODE(2101, METHOD_BUFFERED)
1644#define FSACTL_CLOSE_GET_ADAPTER_FIB		CTL_CODE(2102, METHOD_BUFFERED)
1645#define FSACTL_MINIPORT_REV_CHECK               CTL_CODE(2107, METHOD_BUFFERED)
1646#define FSACTL_GET_PCI_INFO               	CTL_CODE(2119, METHOD_BUFFERED)
1647#define FSACTL_FORCE_DELETE_DISK		CTL_CODE(2120, METHOD_NEITHER)
1648#define FSACTL_GET_CONTAINERS			2131
1649#define FSACTL_SEND_LARGE_FIB			CTL_CODE(2138, METHOD_BUFFERED)
1650
1651
1652struct aac_common
1653{
1654	/*
1655	 *	If this value is set to 1 then interrupt moderation will occur
1656	 *	in the base commuication support.
1657	 */
1658	u32 irq_mod;
1659	u32 peak_fibs;
1660	u32 zero_fibs;
1661	u32 fib_timeouts;
1662	/*
1663	 *	Statistical counters in debug mode
1664	 */
1665#ifdef DBG
1666	u32 FibsSent;
1667	u32 FibRecved;
1668	u32 NoResponseSent;
1669	u32 NoResponseRecved;
1670	u32 AsyncSent;
1671	u32 AsyncRecved;
1672	u32 NormalSent;
1673	u32 NormalRecved;
1674#endif
1675};
1676
1677extern struct aac_common aac_config;
1678
1679
1680/*
1681 *	The following macro is used when sending and receiving FIBs. It is
1682 *	only used for debugging.
1683 */
1684
1685#ifdef DBG
1686#define	FIB_COUNTER_INCREMENT(counter)		(counter)++
1687#else
1688#define	FIB_COUNTER_INCREMENT(counter)
1689#endif
1690
1691/*
1692 *	Adapter direct commands
1693 *	Monitor/Kernel API
1694 */
1695
1696#define	BREAKPOINT_REQUEST		0x00000004
1697#define	INIT_STRUCT_BASE_ADDRESS	0x00000005
1698#define READ_PERMANENT_PARAMETERS	0x0000000a
1699#define WRITE_PERMANENT_PARAMETERS	0x0000000b
1700#define HOST_CRASHING			0x0000000d
1701#define	SEND_SYNCHRONOUS_FIB		0x0000000c
1702#define COMMAND_POST_RESULTS		0x00000014
1703#define GET_ADAPTER_PROPERTIES		0x00000019
1704#define GET_DRIVER_BUFFER_PROPERTIES	0x00000023
1705#define RCV_TEMP_READINGS		0x00000025
1706#define GET_COMM_PREFERRED_SETTINGS	0x00000026
1707#define IOP_RESET			0x00001000
1708#define IOP_RESET_ALWAYS		0x00001001
1709#define RE_INIT_ADAPTER			0x000000ee
1710
1711/*
1712 *	Adapter Status Register
1713 *
1714 *  Phase Staus mailbox is 32bits:
1715 *	<31:16> = Phase Status
1716 *	<15:0>  = Phase
1717 *
1718 *	The adapter reports is present state through the phase.  Only
1719 *	a single phase should be ever be set.  Each phase can have multiple
1720 *	phase status bits to provide more detailed information about the
1721 *	state of the board.  Care should be taken to ensure that any phase
1722 *	status bits that are set when changing the phase are also valid
1723 *	for the new phase or be cleared out.  Adapter software (monitor,
1724 *	iflash, kernel) is responsible for properly maintining the phase
1725 *	status mailbox when it is running.
1726 *
1727 *	MONKER_API Phases
1728 *
1729 *	Phases are bit oriented.  It is NOT valid  to have multiple bits set
1730 */
1731
1732#define	SELF_TEST_FAILED		0x00000004
1733#define	MONITOR_PANIC			0x00000020
1734#define	KERNEL_UP_AND_RUNNING		0x00000080
1735#define	KERNEL_PANIC			0x00000100
1736
1737/*
1738 *	Doorbell bit defines
1739 */
1740
1741#define DoorBellSyncCmdAvailable	(1<<0)	/* Host -> Adapter */
1742#define DoorBellPrintfDone		(1<<5)	/* Host -> Adapter */
1743#define DoorBellAdapterNormCmdReady	(1<<1)	/* Adapter -> Host */
1744#define DoorBellAdapterNormRespReady	(1<<2)	/* Adapter -> Host */
1745#define DoorBellAdapterNormCmdNotFull	(1<<3)	/* Adapter -> Host */
1746#define DoorBellAdapterNormRespNotFull	(1<<4)	/* Adapter -> Host */
1747#define DoorBellPrintfReady		(1<<5)	/* Adapter -> Host */
1748
1749/*
1750 *	For FIB communication, we need all of the following things
1751 *	to send back to the user.
1752 */
1753
1754#define 	AifCmdEventNotify	1	/* Notify of event */
1755#define			AifEnConfigChange	3	/* Adapter configuration change */
1756#define			AifEnContainerChange	4	/* Container configuration change */
1757#define			AifEnDeviceFailure	5	/* SCSI device failed */
1758#define			AifEnAddContainer	15	/* A new array was created */
1759#define			AifEnDeleteContainer	16	/* A container was deleted */
1760#define			AifEnExpEvent		23	/* Firmware Event Log */
1761#define			AifExeFirmwarePanic	3	/* Firmware Event Panic */
1762#define			AifHighPriority		3	/* Highest Priority Event */
1763
1764#define		AifCmdJobProgress	2	/* Progress report */
1765#define			AifJobCtrZero	101	/* Array Zero progress */
1766#define			AifJobStsSuccess 1	/* Job completes */
1767#define			AifJobStsRunning 102	/* Job running */
1768#define		AifCmdAPIReport		3	/* Report from other user of API */
1769#define		AifCmdDriverNotify	4	/* Notify host driver of event */
1770#define			AifDenMorphComplete 200	/* A morph operation completed */
1771#define			AifDenVolumeExtendComplete 201 /* A volume extend completed */
1772#define		AifReqJobList		100	/* Gets back complete job list */
1773#define		AifReqJobsForCtr	101	/* Gets back jobs for specific container */
1774#define		AifReqJobsForScsi	102	/* Gets back jobs for specific SCSI device */
1775#define		AifReqJobReport		103	/* Gets back a specific job report or list of them */
1776#define		AifReqTerminateJob	104	/* Terminates job */
1777#define		AifReqSuspendJob	105	/* Suspends a job */
1778#define		AifReqResumeJob		106	/* Resumes a job */
1779#define		AifReqSendAPIReport	107	/* API generic report requests */
1780#define		AifReqAPIJobStart	108	/* Start a job from the API */
1781#define		AifReqAPIJobUpdate	109	/* Update a job report from the API */
1782#define		AifReqAPIJobFinish	110	/* Finish a job from the API */
1783
1784/*
1785 *	Adapter Initiated FIB command structures. Start with the adapter
1786 *	initiated FIBs that really come from the adapter, and get responded
1787 *	to by the host.
1788 */
1789
1790struct aac_aifcmd {
1791	__le32 command;		/* Tell host what type of notify this is */
1792	__le32 seqnum;		/* To allow ordering of reports (if necessary) */
1793	u8 data[1];		/* Undefined length (from kernel viewpoint) */
1794};
1795
1796/**
1797 * 	Convert capacity to cylinders
1798 *  	accounting for the fact capacity could be a 64 bit value
1799 *
1800 */
1801static inline u32 cap_to_cyls(sector_t capacity, u32 divisor)
1802{
1803	sector_div(capacity, divisor);
1804	return (u32)capacity;
1805}
1806
1807/* SCp.phase values */
1808#define AAC_OWNER_MIDLEVEL	0x101
1809#define AAC_OWNER_LOWLEVEL	0x102
1810#define AAC_OWNER_ERROR_HANDLER	0x103
1811#define AAC_OWNER_FIRMWARE	0x106
1812
1813const char *aac_driverinfo(struct Scsi_Host *);
1814struct fib *aac_fib_alloc(struct aac_dev *dev);
1815int aac_fib_setup(struct aac_dev *dev);
1816void aac_fib_map_free(struct aac_dev *dev);
1817void aac_fib_free(struct fib * context);
1818void aac_fib_init(struct fib * context);
1819void aac_printf(struct aac_dev *dev, u32 val);
1820int aac_fib_send(u16 command, struct fib * context, unsigned long size, int priority, int wait, int reply, fib_callback callback, void *ctxt);
1821int aac_consumer_get(struct aac_dev * dev, struct aac_queue * q, struct aac_entry **entry);
1822void aac_consumer_free(struct aac_dev * dev, struct aac_queue * q, u32 qnum);
1823int aac_fib_complete(struct fib * context);
1824#define fib_data(fibctx) ((void *)(fibctx)->hw_fib->data)
1825struct aac_dev *aac_init_adapter(struct aac_dev *dev);
1826int aac_get_config_status(struct aac_dev *dev, int commit_flag);
1827int aac_get_containers(struct aac_dev *dev);
1828int aac_scsi_cmd(struct scsi_cmnd *cmd);
1829int aac_dev_ioctl(struct aac_dev *dev, int cmd, void __user *arg);
1830int aac_do_ioctl(struct aac_dev * dev, int cmd, void __user *arg);
1831int aac_rx_init(struct aac_dev *dev);
1832int aac_rkt_init(struct aac_dev *dev);
1833int aac_nark_init(struct aac_dev *dev);
1834int aac_sa_init(struct aac_dev *dev);
1835int aac_queue_get(struct aac_dev * dev, u32 * index, u32 qid, struct hw_fib * hw_fib, int wait, struct fib * fibptr, unsigned long *nonotify);
1836unsigned int aac_response_normal(struct aac_queue * q);
1837unsigned int aac_command_normal(struct aac_queue * q);
1838unsigned int aac_intr_normal(struct aac_dev * dev, u32 Index);
1839int aac_check_health(struct aac_dev * dev);
1840int aac_command_thread(void *data);
1841int aac_close_fib_context(struct aac_dev * dev, struct aac_fib_context *fibctx);
1842int aac_fib_adapter_complete(struct fib * fibptr, unsigned short size);
1843struct aac_driver_ident* aac_get_driver_ident(int devtype);
1844int aac_get_adapter_info(struct aac_dev* dev);
1845int aac_send_shutdown(struct aac_dev *dev);
1846int aac_probe_container(struct aac_dev *dev, int cid);
1847extern int numacb;
1848extern int acbsize;
1849extern char aac_driver_version[];
1850extern int startup_timeout;
1851extern int aif_timeout;
1852