aacraid.h revision 28713324a0f3c055186ecec27239673c36ba1de5
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;
489
490struct adapter_ops
491{
492	/* Low level operations */
493	void (*adapter_interrupt)(struct aac_dev *dev);
494	void (*adapter_notify)(struct aac_dev *dev, u32 event);
495	void (*adapter_disable_int)(struct aac_dev *dev);
496	void (*adapter_enable_int)(struct aac_dev *dev);
497	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);
498	int  (*adapter_check_health)(struct aac_dev *dev);
499	/* Transport operations */
500	int  (*adapter_ioremap)(struct aac_dev * dev, u32 size);
501	irqreturn_t (*adapter_intr)(int irq, void *dev_id);
502	/* Packet operations */
503	int  (*adapter_deliver)(struct fib * fib);
504	/* Administrative operations */
505	int  (*adapter_comm)(struct aac_dev * dev, int comm);
506};
507
508/*
509 *	Define which interrupt handler needs to be installed
510 */
511
512struct aac_driver_ident
513{
514	int 	(*init)(struct aac_dev *dev);
515	char *	name;
516	char *	vname;
517	char *	model;
518	u16	channels;
519	int	quirks;
520};
521/*
522 * Some adapter firmware needs communication memory
523 * below 2gig. This tells the init function to set the
524 * dma mask such that fib memory will be allocated where the
525 * adapter firmware can get to it.
526 */
527#define AAC_QUIRK_31BIT	0x0001
528
529/*
530 * Some adapter firmware, when the raid card's cache is turned off, can not
531 * split up scatter gathers in order to deal with the limits of the
532 * underlying CHIM. This limit is 34 scatter gather elements.
533 */
534#define AAC_QUIRK_34SG	0x0002
535
536/*
537 * This adapter is a slave (no Firmware)
538 */
539#define AAC_QUIRK_SLAVE 0x0004
540
541/*
542 * This adapter is a master.
543 */
544#define AAC_QUIRK_MASTER 0x0008
545
546/*
547 * Some adapter firmware perform poorly when it must split up scatter gathers
548 * in order to deal with the limits of the underlying CHIM. This limit in this
549 * class of adapters is 17 scatter gather elements.
550 */
551#define AAC_QUIRK_17SG	0x0010
552
553/*
554 *	The adapter interface specs all queues to be located in the same
555 *	physically contigous block. The host structure that defines the
556 *	commuication queues will assume they are each a separate physically
557 *	contigous memory region that will support them all being one big
558 *	contigous block.
559 *	There is a command and response queue for each level and direction of
560 *	commuication. These regions are accessed by both the host and adapter.
561 */
562
563struct aac_queue {
564	u64		 	logical;	/*address we give the adapter */
565	struct aac_entry	*base;		/*system virtual address */
566	struct aac_qhdr 	headers;       	/*producer,consumer q headers*/
567	u32	 		entries;	/*Number of queue entries */
568	wait_queue_head_t	qfull;		/*Event to wait on if q full */
569	wait_queue_head_t	cmdready;	/*Cmd ready from the adapter */
570                  /* This is only valid for adapter to host command queues. */
571	spinlock_t	 	*lock;		/* Spinlock for this queue must take this lock before accessing the lock */
572	spinlock_t		lockdata;	/* Actual lock (used only on one side of the lock) */
573	struct list_head 	cmdq;	   	/* A queue of FIBs which need to be prcessed by the FS thread. This is */
574                                		/* only valid for command queues which receive entries from the adapter. */
575	u32			numpending;	/* Number of entries on outstanding queue. */
576	struct aac_dev *	dev;		/* Back pointer to adapter structure */
577};
578
579/*
580 *	Message queues. The order here is important, see also the
581 *	queue type ordering
582 */
583
584struct aac_queue_block
585{
586	struct aac_queue queue[8];
587};
588
589/*
590 *	SaP1 Message Unit Registers
591 */
592
593struct sa_drawbridge_CSR {
594				/*	Offset 	|  Name */
595	__le32	reserved[10];	/*	00h-27h |  Reserved */
596	u8	LUT_Offset;	/*	28h	|  Lookup Table Offset */
597	u8	reserved1[3];	/* 	29h-2bh	|  Reserved */
598	__le32	LUT_Data;	/*	2ch	|  Looup Table Data */
599	__le32	reserved2[26];	/*	30h-97h	|  Reserved */
600	__le16	PRICLEARIRQ;	/*	98h	|  Primary Clear Irq */
601	__le16	SECCLEARIRQ;	/*	9ah	|  Secondary Clear Irq */
602	__le16	PRISETIRQ;	/*	9ch	|  Primary Set Irq */
603	__le16	SECSETIRQ;	/*	9eh	|  Secondary Set Irq */
604	__le16	PRICLEARIRQMASK;/*	a0h	|  Primary Clear Irq Mask */
605	__le16	SECCLEARIRQMASK;/*	a2h	|  Secondary Clear Irq Mask */
606	__le16	PRISETIRQMASK;	/*	a4h	|  Primary Set Irq Mask */
607	__le16	SECSETIRQMASK;	/*	a6h	|  Secondary Set Irq Mask */
608	__le32	MAILBOX0;	/*	a8h	|  Scratchpad 0 */
609	__le32	MAILBOX1;	/*	ach	|  Scratchpad 1 */
610	__le32	MAILBOX2;	/*	b0h	|  Scratchpad 2 */
611	__le32	MAILBOX3;	/*	b4h	|  Scratchpad 3 */
612	__le32	MAILBOX4;	/*	b8h	|  Scratchpad 4 */
613	__le32	MAILBOX5;	/*	bch	|  Scratchpad 5 */
614	__le32	MAILBOX6;	/*	c0h	|  Scratchpad 6 */
615	__le32	MAILBOX7;	/*	c4h	|  Scratchpad 7 */
616	__le32	ROM_Setup_Data;	/*	c8h 	|  Rom Setup and Data */
617	__le32	ROM_Control_Addr;/*	cch 	|  Rom Control and Address */
618	__le32	reserved3[12];	/*	d0h-ffh	|  reserved */
619	__le32	LUT[64];	/*    100h-1ffh	|  Lookup Table Entries */
620};
621
622#define Mailbox0	SaDbCSR.MAILBOX0
623#define Mailbox1	SaDbCSR.MAILBOX1
624#define Mailbox2	SaDbCSR.MAILBOX2
625#define Mailbox3	SaDbCSR.MAILBOX3
626#define Mailbox4	SaDbCSR.MAILBOX4
627#define Mailbox5	SaDbCSR.MAILBOX5
628#define Mailbox6	SaDbCSR.MAILBOX6
629#define Mailbox7	SaDbCSR.MAILBOX7
630
631#define DoorbellReg_p SaDbCSR.PRISETIRQ
632#define DoorbellReg_s SaDbCSR.SECSETIRQ
633#define DoorbellClrReg_p SaDbCSR.PRICLEARIRQ
634
635
636#define	DOORBELL_0	0x0001
637#define DOORBELL_1	0x0002
638#define DOORBELL_2	0x0004
639#define DOORBELL_3	0x0008
640#define DOORBELL_4	0x0010
641#define DOORBELL_5	0x0020
642#define DOORBELL_6	0x0040
643
644
645#define PrintfReady	DOORBELL_5
646#define PrintfDone	DOORBELL_5
647
648struct sa_registers {
649	struct sa_drawbridge_CSR	SaDbCSR;			/* 98h - c4h */
650};
651
652
653#define Sa_MINIPORT_REVISION			1
654
655#define sa_readw(AEP, CSR)		readl(&((AEP)->regs.sa->CSR))
656#define sa_readl(AEP,  CSR)		readl(&((AEP)->regs.sa->CSR))
657#define sa_writew(AEP, CSR, value)	writew(value, &((AEP)->regs.sa->CSR))
658#define sa_writel(AEP, CSR, value)	writel(value, &((AEP)->regs.sa->CSR))
659
660/*
661 *	Rx Message Unit Registers
662 */
663
664struct rx_mu_registers {
665			    /*	Local  | PCI*| Name */
666	__le32	ARSR;	    /*	1300h  | 00h | APIC Register Select Register */
667	__le32	reserved0;  /*	1304h  | 04h | Reserved */
668	__le32	AWR;	    /*	1308h  | 08h | APIC Window Register */
669	__le32	reserved1;  /*	130Ch  | 0Ch | Reserved */
670	__le32	IMRx[2];    /*	1310h  | 10h | Inbound Message Registers */
671	__le32	OMRx[2];    /*	1318h  | 18h | Outbound Message Registers */
672	__le32	IDR;	    /*	1320h  | 20h | Inbound Doorbell Register */
673	__le32	IISR;	    /*	1324h  | 24h | Inbound Interrupt
674						Status Register */
675	__le32	IIMR;	    /*	1328h  | 28h | Inbound Interrupt
676					 	Mask Register */
677	__le32	ODR;	    /*	132Ch  | 2Ch | Outbound Doorbell Register */
678	__le32	OISR;	    /*	1330h  | 30h | Outbound Interrupt
679						Status Register */
680	__le32	OIMR;	    /*	1334h  | 34h | Outbound Interrupt
681						Mask Register */
682	__le32	reserved2;  /*	1338h  | 38h | Reserved */
683	__le32	reserved3;  /*	133Ch  | 3Ch | Reserved */
684	__le32	InboundQueue;/*	1340h  | 40h | Inbound Queue Port relative to firmware */
685	__le32	OutboundQueue;/*1344h  | 44h | Outbound Queue Port relative to firmware */
686			    /* * Must access through ATU Inbound
687			     	 Translation Window */
688};
689
690struct rx_inbound {
691	__le32	Mailbox[8];
692};
693
694#define	INBOUNDDOORBELL_0	0x00000001
695#define INBOUNDDOORBELL_1	0x00000002
696#define INBOUNDDOORBELL_2	0x00000004
697#define INBOUNDDOORBELL_3	0x00000008
698#define INBOUNDDOORBELL_4	0x00000010
699#define INBOUNDDOORBELL_5	0x00000020
700#define INBOUNDDOORBELL_6	0x00000040
701
702#define	OUTBOUNDDOORBELL_0	0x00000001
703#define OUTBOUNDDOORBELL_1	0x00000002
704#define OUTBOUNDDOORBELL_2	0x00000004
705#define OUTBOUNDDOORBELL_3	0x00000008
706#define OUTBOUNDDOORBELL_4	0x00000010
707
708#define InboundDoorbellReg	MUnit.IDR
709#define OutboundDoorbellReg	MUnit.ODR
710
711struct rx_registers {
712	struct rx_mu_registers		MUnit;		/* 1300h - 1344h */
713	__le32				reserved1[2];	/* 1348h - 134ch */
714	struct rx_inbound		IndexRegs;
715};
716
717#define rx_readb(AEP, CSR)		readb(&((AEP)->regs.rx->CSR))
718#define rx_readl(AEP, CSR)		readl(&((AEP)->regs.rx->CSR))
719#define rx_writeb(AEP, CSR, value)	writeb(value, &((AEP)->regs.rx->CSR))
720#define rx_writel(AEP, CSR, value)	writel(value, &((AEP)->regs.rx->CSR))
721
722/*
723 *	Rkt Message Unit Registers (same as Rx, except a larger reserve region)
724 */
725
726#define rkt_mu_registers rx_mu_registers
727#define rkt_inbound rx_inbound
728
729struct rkt_registers {
730	struct rkt_mu_registers		MUnit;		 /* 1300h - 1344h */
731	__le32				reserved1[1006]; /* 1348h - 22fch */
732	struct rkt_inbound		IndexRegs;	 /* 2300h - */
733};
734
735#define rkt_readb(AEP, CSR)		readb(&((AEP)->regs.rkt->CSR))
736#define rkt_readl(AEP, CSR)		readl(&((AEP)->regs.rkt->CSR))
737#define rkt_writeb(AEP, CSR, value)	writeb(value, &((AEP)->regs.rkt->CSR))
738#define rkt_writel(AEP, CSR, value)	writel(value, &((AEP)->regs.rkt->CSR))
739
740typedef void (*fib_callback)(void *ctxt, struct fib *fibctx);
741
742struct aac_fib_context {
743	s16	 		type;		// used for verification of structure
744	s16	 		size;
745	u32			unique;		// unique value representing this context
746	ulong			jiffies;	// used for cleanup - dmb changed to ulong
747	struct list_head	next;		// used to link context's into a linked list
748	struct semaphore 	wait_sem;	// this is used to wait for the next fib to arrive.
749	int			wait;		// Set to true when thread is in WaitForSingleObject
750	unsigned long		count;		// total number of FIBs on FibList
751	struct list_head	fib_list;	// this holds fibs and their attachd hw_fibs
752};
753
754struct sense_data {
755	u8 error_code;		/* 70h (current errors), 71h(deferred errors) */
756	u8 valid:1;		/* A valid bit of one indicates that the information  */
757				/* field contains valid information as defined in the
758				 * SCSI-2 Standard.
759				 */
760	u8 segment_number;	/* Only used for COPY, COMPARE, or COPY AND VERIFY Commands */
761	u8 sense_key:4;		/* Sense Key */
762	u8 reserved:1;
763	u8 ILI:1;		/* Incorrect Length Indicator */
764	u8 EOM:1;		/* End Of Medium - reserved for random access devices */
765	u8 filemark:1;		/* Filemark - reserved for random access devices */
766
767	u8 information[4];	/* for direct-access devices, contains the unsigned
768				 * logical block address or residue associated with
769				 * the sense key
770				 */
771	u8 add_sense_len;	/* number of additional sense bytes to follow this field */
772	u8 cmnd_info[4];	/* not used */
773	u8 ASC;			/* Additional Sense Code */
774	u8 ASCQ;		/* Additional Sense Code Qualifier */
775	u8 FRUC;		/* Field Replaceable Unit Code - not used */
776	u8 bit_ptr:3;		/* indicates which byte of the CDB or parameter data
777				 * was in error
778				 */
779	u8 BPV:1;		/* bit pointer valid (BPV): 1- indicates that
780				 * the bit_ptr field has valid value
781				 */
782	u8 reserved2:2;
783	u8 CD:1;		/* command data bit: 1- illegal parameter in CDB.
784				 * 0- illegal parameter in data.
785				 */
786	u8 SKSV:1;
787	u8 field_ptr[2];	/* byte of the CDB or parameter data in error */
788};
789
790struct fsa_dev_info {
791	u64		last;
792	u64		size;
793	u32		type;
794	u32		config_waiting_on;
795	unsigned long	config_waiting_stamp;
796	u16		queue_depth;
797	u8		config_needed;
798	u8		valid;
799	u8		ro;
800	u8		locked;
801	u8		deleted;
802	char		devname[8];
803	struct sense_data sense_data;
804};
805
806struct fib {
807	void			*next;	/* this is used by the allocator */
808	s16			type;
809	s16			size;
810	/*
811	 *	The Adapter that this I/O is destined for.
812	 */
813	struct aac_dev 		*dev;
814	/*
815	 *	This is the event the sendfib routine will wait on if the
816	 *	caller did not pass one and this is synch io.
817	 */
818	struct semaphore 	event_wait;
819	spinlock_t		event_lock;
820
821	u32			done;	/* gets set to 1 when fib is complete */
822	fib_callback 		callback;
823	void 			*callback_data;
824	u32			flags; // u32 dmb was ulong
825	/*
826	 *	And for the internal issue/reply queues (we may be able
827	 *	to merge these two)
828	 */
829	struct list_head	fiblink;
830	void 			*data;
831	struct hw_fib		*hw_fib;		/* Actual shared object */
832	dma_addr_t		hw_fib_pa;		/* physical address of hw_fib*/
833};
834
835/*
836 *	Adapter Information Block
837 *
838 *	This is returned by the RequestAdapterInfo block
839 */
840
841struct aac_adapter_info
842{
843	__le32	platform;
844	__le32	cpu;
845	__le32	subcpu;
846	__le32	clock;
847	__le32	execmem;
848	__le32	buffermem;
849	__le32	totalmem;
850	__le32	kernelrev;
851	__le32	kernelbuild;
852	__le32	monitorrev;
853	__le32	monitorbuild;
854	__le32	hwrev;
855	__le32	hwbuild;
856	__le32	biosrev;
857	__le32	biosbuild;
858	__le32	cluster;
859	__le32	clusterchannelmask;
860	__le32	serial[2];
861	__le32	battery;
862	__le32	options;
863	__le32	OEM;
864};
865
866struct aac_supplement_adapter_info
867{
868	u8	AdapterTypeText[17+1];
869	u8	Pad[2];
870	__le32	FlashMemoryByteSize;
871	__le32	FlashImageId;
872	__le32	MaxNumberPorts;
873	__le32	Version;
874	__le32	FeatureBits;
875	u8	SlotNumber;
876	u8	ReservedPad0[0];
877	u8	BuildDate[12];
878	__le32	CurrentNumberPorts;
879	__le32	ReservedGrowth[24];
880};
881#define AAC_FEATURE_FALCON	0x00000010
882#define AAC_SIS_VERSION_V3	3
883#define AAC_SIS_SLOT_UNKNOWN	0xFF
884
885#define GetBusInfo 0x00000009
886struct aac_bus_info {
887	__le32	Command;	/* VM_Ioctl */
888	__le32	ObjType;	/* FT_DRIVE */
889	__le32	MethodId;	/* 1 = SCSI Layer */
890	__le32	ObjectId;	/* Handle */
891	__le32	CtlCmd;		/* GetBusInfo */
892};
893
894struct aac_bus_info_response {
895	__le32	Status;		/* ST_OK */
896	__le32	ObjType;
897	__le32	MethodId;	/* unused */
898	__le32	ObjectId;	/* unused */
899	__le32	CtlCmd;		/* unused */
900	__le32	ProbeComplete;
901	__le32	BusCount;
902	__le32	TargetsPerBus;
903	u8	InitiatorBusId[10];
904	u8	BusValid[10];
905};
906
907/*
908 * Battery platforms
909 */
910#define AAC_BAT_REQ_PRESENT	(1)
911#define AAC_BAT_REQ_NOTPRESENT	(2)
912#define AAC_BAT_OPT_PRESENT	(3)
913#define AAC_BAT_OPT_NOTPRESENT	(4)
914#define AAC_BAT_NOT_SUPPORTED	(5)
915/*
916 * cpu types
917 */
918#define AAC_CPU_SIMULATOR	(1)
919#define AAC_CPU_I960		(2)
920#define AAC_CPU_STRONGARM	(3)
921
922/*
923 * Supported Options
924 */
925#define AAC_OPT_SNAPSHOT		cpu_to_le32(1)
926#define AAC_OPT_CLUSTERS		cpu_to_le32(1<<1)
927#define AAC_OPT_WRITE_CACHE		cpu_to_le32(1<<2)
928#define AAC_OPT_64BIT_DATA		cpu_to_le32(1<<3)
929#define AAC_OPT_HOST_TIME_FIB		cpu_to_le32(1<<4)
930#define AAC_OPT_RAID50			cpu_to_le32(1<<5)
931#define AAC_OPT_4GB_WINDOW		cpu_to_le32(1<<6)
932#define AAC_OPT_SCSI_UPGRADEABLE 	cpu_to_le32(1<<7)
933#define AAC_OPT_SOFT_ERR_REPORT		cpu_to_le32(1<<8)
934#define AAC_OPT_SUPPORTED_RECONDITION 	cpu_to_le32(1<<9)
935#define AAC_OPT_SGMAP_HOST64		cpu_to_le32(1<<10)
936#define AAC_OPT_ALARM			cpu_to_le32(1<<11)
937#define AAC_OPT_NONDASD			cpu_to_le32(1<<12)
938#define AAC_OPT_SCSI_MANAGED    	cpu_to_le32(1<<13)
939#define AAC_OPT_RAID_SCSI_MODE		cpu_to_le32(1<<14)
940#define AAC_OPT_SUPPLEMENT_ADAPTER_INFO	cpu_to_le32(1<<16)
941#define AAC_OPT_NEW_COMM		cpu_to_le32(1<<17)
942#define AAC_OPT_NEW_COMM_64		cpu_to_le32(1<<18)
943
944struct aac_dev
945{
946	struct list_head	entry;
947	const char		*name;
948	int			id;
949
950	/*
951	 *	negotiated FIB settings
952	 */
953	unsigned		max_fib_size;
954	unsigned		sg_tablesize;
955
956	/*
957	 *	Map for 128 fib objects (64k)
958	 */
959	dma_addr_t		hw_fib_pa;
960	struct hw_fib		*hw_fib_va;
961	struct hw_fib		*aif_base_va;
962	/*
963	 *	Fib Headers
964	 */
965	struct fib              *fibs;
966
967	struct fib		*free_fib;
968	struct fib		*timeout_fib;
969	spinlock_t		fib_lock;
970
971	struct aac_queue_block *queues;
972	/*
973	 *	The user API will use an IOCTL to register itself to receive
974	 *	FIBs from the adapter.  The following list is used to keep
975	 *	track of all the threads that have requested these FIBs.  The
976	 *	mutex is used to synchronize access to all data associated
977	 *	with the adapter fibs.
978	 */
979	struct list_head	fib_list;
980
981	struct adapter_ops	a_ops;
982	unsigned long		fsrev;		/* Main driver's revision number */
983
984	unsigned		base_size;	/* Size of mapped in region */
985	struct aac_init		*init;		/* Holds initialization info to communicate with adapter */
986	dma_addr_t		init_pa; 	/* Holds physical address of the init struct */
987
988	struct pci_dev		*pdev;		/* Our PCI interface */
989	void *			printfbuf;	/* pointer to buffer used for printf's from the adapter */
990	void *			comm_addr;	/* Base address of Comm area */
991	dma_addr_t		comm_phys;	/* Physical Address of Comm area */
992	size_t			comm_size;
993
994	struct Scsi_Host	*scsi_host_ptr;
995	int			maximum_num_containers;
996	int			maximum_num_physicals;
997	int			maximum_num_channels;
998	struct fsa_dev_info	*fsa_dev;
999	struct task_struct	*thread;
1000	int			cardtype;
1001
1002	/*
1003	 *	The following is the device specific extension.
1004	 */
1005#if (!defined(AAC_MIN_FOOTPRINT_SIZE))
1006#	define AAC_MIN_FOOTPRINT_SIZE 8192
1007#endif
1008	union
1009	{
1010		struct sa_registers __iomem *sa;
1011		struct rx_registers __iomem *rx;
1012		struct rkt_registers __iomem *rkt;
1013	} regs;
1014	volatile void __iomem *base;
1015	volatile struct rx_inbound __iomem *IndexRegs;
1016	u32			OIMR; /* Mask Register Cache */
1017	/*
1018	 *	AIF thread states
1019	 */
1020	u32			aif_thread;
1021	struct aac_adapter_info adapter_info;
1022	struct aac_supplement_adapter_info supplement_adapter_info;
1023	/* These are in adapter info but they are in the io flow so
1024	 * lets break them out so we don't have to do an AND to check them
1025	 */
1026	u8			nondasd_support;
1027	u8			dac_support;
1028	u8			raid_scsi_mode;
1029	u8			comm_interface;
1030#	define AAC_COMM_PRODUCER 0
1031#	define AAC_COMM_MESSAGE  1
1032	/* macro side-effects BEWARE */
1033#	define			raw_io_interface \
1034	  init->InitStructRevision==cpu_to_le32(ADAPTER_INIT_STRUCT_REVISION_4)
1035	u8			raw_io_64;
1036	u8			printf_enabled;
1037	u8			in_reset;
1038};
1039
1040#define aac_adapter_interrupt(dev) \
1041	(dev)->a_ops.adapter_interrupt(dev)
1042
1043#define aac_adapter_notify(dev, event) \
1044	(dev)->a_ops.adapter_notify(dev, event)
1045
1046#define aac_adapter_disable_int(dev) \
1047	(dev)->a_ops.adapter_disable_int(dev)
1048
1049#define aac_adapter_enable_int(dev) \
1050	(dev)->a_ops.adapter_enable_int(dev)
1051
1052#define aac_adapter_sync_cmd(dev, command, p1, p2, p3, p4, p5, p6, status, r1, r2, r3, r4) \
1053	(dev)->a_ops.adapter_sync_cmd(dev, command, p1, p2, p3, p4, p5, p6, status, r1, r2, r3, r4)
1054
1055#define aac_adapter_check_health(dev) \
1056	(dev)->a_ops.adapter_check_health(dev)
1057
1058#define aac_adapter_ioremap(dev, size) \
1059	(dev)->a_ops.adapter_ioremap(dev, size)
1060
1061#define aac_adapter_deliver(fib) \
1062	((fib)->dev)->a_ops.adapter_deliver(fib)
1063
1064#define aac_adapter_comm(dev,comm) \
1065	(dev)->a_ops.adapter_comm(dev, comm)
1066
1067#define FIB_CONTEXT_FLAG_TIMED_OUT		(0x00000001)
1068
1069/*
1070 *	Define the command values
1071 */
1072
1073#define		Null			0
1074#define 	GetAttributes		1
1075#define 	SetAttributes		2
1076#define 	Lookup			3
1077#define 	ReadLink		4
1078#define 	Read			5
1079#define 	Write			6
1080#define		Create			7
1081#define		MakeDirectory		8
1082#define		SymbolicLink		9
1083#define		MakeNode		10
1084#define		Removex			11
1085#define		RemoveDirectoryx	12
1086#define		Rename			13
1087#define		Link			14
1088#define		ReadDirectory		15
1089#define		ReadDirectoryPlus	16
1090#define		FileSystemStatus	17
1091#define		FileSystemInfo		18
1092#define		PathConfigure		19
1093#define		Commit			20
1094#define		Mount			21
1095#define		UnMount			22
1096#define		Newfs			23
1097#define		FsCheck			24
1098#define		FsSync			25
1099#define		SimReadWrite		26
1100#define		SetFileSystemStatus	27
1101#define		BlockRead		28
1102#define		BlockWrite		29
1103#define		NvramIoctl		30
1104#define		FsSyncWait		31
1105#define		ClearArchiveBit		32
1106#define		SetAcl			33
1107#define		GetAcl			34
1108#define		AssignAcl		35
1109#define		FaultInsertion		36	/* Fault Insertion Command */
1110#define		CrazyCache		37	/* Crazycache */
1111
1112#define		MAX_FSACOMMAND_NUM	38
1113
1114
1115/*
1116 *	Define the status returns. These are very unixlike although
1117 *	most are not in fact used
1118 */
1119
1120#define		ST_OK		0
1121#define		ST_PERM		1
1122#define		ST_NOENT	2
1123#define		ST_IO		5
1124#define		ST_NXIO		6
1125#define		ST_E2BIG	7
1126#define		ST_ACCES	13
1127#define		ST_EXIST	17
1128#define		ST_XDEV		18
1129#define		ST_NODEV	19
1130#define		ST_NOTDIR	20
1131#define		ST_ISDIR	21
1132#define		ST_INVAL	22
1133#define		ST_FBIG		27
1134#define		ST_NOSPC	28
1135#define		ST_ROFS		30
1136#define		ST_MLINK	31
1137#define		ST_WOULDBLOCK	35
1138#define		ST_NAMETOOLONG	63
1139#define		ST_NOTEMPTY	66
1140#define		ST_DQUOT	69
1141#define		ST_STALE	70
1142#define		ST_REMOTE	71
1143#define		ST_BADHANDLE	10001
1144#define		ST_NOT_SYNC	10002
1145#define		ST_BAD_COOKIE	10003
1146#define		ST_NOTSUPP	10004
1147#define		ST_TOOSMALL	10005
1148#define		ST_SERVERFAULT	10006
1149#define		ST_BADTYPE	10007
1150#define		ST_JUKEBOX	10008
1151#define		ST_NOTMOUNTED	10009
1152#define		ST_MAINTMODE	10010
1153#define		ST_STALEACL	10011
1154
1155/*
1156 *	On writes how does the client want the data written.
1157 */
1158
1159#define	CACHE_CSTABLE		1
1160#define CACHE_UNSTABLE		2
1161
1162/*
1163 *	Lets the client know at which level the data was commited on
1164 *	a write request
1165 */
1166
1167#define	CMFILE_SYNCH_NVRAM	1
1168#define	CMDATA_SYNCH_NVRAM	2
1169#define	CMFILE_SYNCH		3
1170#define CMDATA_SYNCH		4
1171#define CMUNSTABLE		5
1172
1173struct aac_read
1174{
1175	__le32	 	command;
1176	__le32 		cid;
1177	__le32 		block;
1178	__le32 		count;
1179	struct sgmap	sg;	// Must be last in struct because it is variable
1180};
1181
1182struct aac_read64
1183{
1184	__le32	 	command;
1185	__le16 		cid;
1186	__le16 		sector_count;
1187	__le32 		block;
1188	__le16		pad;
1189	__le16		flags;
1190	struct sgmap64	sg;	// Must be last in struct because it is variable
1191};
1192
1193struct aac_read_reply
1194{
1195	__le32	 	status;
1196	__le32 		count;
1197};
1198
1199struct aac_write
1200{
1201	__le32		command;
1202	__le32 		cid;
1203	__le32 		block;
1204	__le32 		count;
1205	__le32	 	stable;	// Not used
1206	struct sgmap	sg;	// Must be last in struct because it is variable
1207};
1208
1209struct aac_write64
1210{
1211	__le32	 	command;
1212	__le16 		cid;
1213	__le16 		sector_count;
1214	__le32 		block;
1215	__le16		pad;
1216	__le16		flags;
1217	struct sgmap64	sg;	// Must be last in struct because it is variable
1218};
1219struct aac_write_reply
1220{
1221	__le32		status;
1222	__le32 		count;
1223	__le32		committed;
1224};
1225
1226struct aac_raw_io
1227{
1228	__le32		block[2];
1229	__le32		count;
1230	__le16		cid;
1231	__le16		flags;		/* 00 W, 01 R */
1232	__le16		bpTotal;	/* reserved for F/W use */
1233	__le16		bpComplete;	/* reserved for F/W use */
1234	struct sgmapraw	sg;
1235};
1236
1237#define CT_FLUSH_CACHE 129
1238struct aac_synchronize {
1239	__le32		command;	/* VM_ContainerConfig */
1240	__le32		type;		/* CT_FLUSH_CACHE */
1241	__le32		cid;
1242	__le32		parm1;
1243	__le32		parm2;
1244	__le32		parm3;
1245	__le32		parm4;
1246	__le32		count;	/* sizeof(((struct aac_synchronize_reply *)NULL)->data) */
1247};
1248
1249struct aac_synchronize_reply {
1250	__le32		dummy0;
1251	__le32		dummy1;
1252	__le32		status;	/* CT_OK */
1253	__le32		parm1;
1254	__le32		parm2;
1255	__le32		parm3;
1256	__le32		parm4;
1257	__le32		parm5;
1258	u8		data[16];
1259};
1260
1261struct aac_srb
1262{
1263	__le32		function;
1264	__le32		channel;
1265	__le32		id;
1266	__le32		lun;
1267	__le32		timeout;
1268	__le32		flags;
1269	__le32		count;		// Data xfer size
1270	__le32		retry_limit;
1271	__le32		cdb_size;
1272	u8		cdb[16];
1273	struct	sgmap	sg;
1274};
1275
1276/*
1277 * This and associated data structs are used by the
1278 * ioctl caller and are in cpu order.
1279 */
1280struct user_aac_srb
1281{
1282	u32		function;
1283	u32		channel;
1284	u32		id;
1285	u32		lun;
1286	u32		timeout;
1287	u32		flags;
1288	u32		count;		// Data xfer size
1289	u32		retry_limit;
1290	u32		cdb_size;
1291	u8		cdb[16];
1292	struct	user_sgmap	sg;
1293};
1294
1295#define		AAC_SENSE_BUFFERSIZE	 30
1296
1297struct aac_srb_reply
1298{
1299	__le32		status;
1300	__le32		srb_status;
1301	__le32		scsi_status;
1302	__le32		data_xfer_length;
1303	__le32		sense_data_size;
1304	u8		sense_data[AAC_SENSE_BUFFERSIZE]; // Can this be SCSI_SENSE_BUFFERSIZE
1305};
1306/*
1307 * SRB Flags
1308 */
1309#define		SRB_NoDataXfer		 0x0000
1310#define		SRB_DisableDisconnect	 0x0004
1311#define		SRB_DisableSynchTransfer 0x0008
1312#define 	SRB_BypassFrozenQueue	 0x0010
1313#define		SRB_DisableAutosense	 0x0020
1314#define		SRB_DataIn		 0x0040
1315#define 	SRB_DataOut		 0x0080
1316
1317/*
1318 * SRB Functions - set in aac_srb->function
1319 */
1320#define	SRBF_ExecuteScsi	0x0000
1321#define	SRBF_ClaimDevice	0x0001
1322#define	SRBF_IO_Control		0x0002
1323#define	SRBF_ReceiveEvent	0x0003
1324#define	SRBF_ReleaseQueue	0x0004
1325#define	SRBF_AttachDevice	0x0005
1326#define	SRBF_ReleaseDevice	0x0006
1327#define	SRBF_Shutdown		0x0007
1328#define	SRBF_Flush		0x0008
1329#define	SRBF_AbortCommand	0x0010
1330#define	SRBF_ReleaseRecovery	0x0011
1331#define	SRBF_ResetBus		0x0012
1332#define	SRBF_ResetDevice	0x0013
1333#define	SRBF_TerminateIO	0x0014
1334#define	SRBF_FlushQueue		0x0015
1335#define	SRBF_RemoveDevice	0x0016
1336#define	SRBF_DomainValidation	0x0017
1337
1338/*
1339 * SRB SCSI Status - set in aac_srb->scsi_status
1340 */
1341#define SRB_STATUS_PENDING                  0x00
1342#define SRB_STATUS_SUCCESS                  0x01
1343#define SRB_STATUS_ABORTED                  0x02
1344#define SRB_STATUS_ABORT_FAILED             0x03
1345#define SRB_STATUS_ERROR                    0x04
1346#define SRB_STATUS_BUSY                     0x05
1347#define SRB_STATUS_INVALID_REQUEST          0x06
1348#define SRB_STATUS_INVALID_PATH_ID          0x07
1349#define SRB_STATUS_NO_DEVICE                0x08
1350#define SRB_STATUS_TIMEOUT                  0x09
1351#define SRB_STATUS_SELECTION_TIMEOUT        0x0A
1352#define SRB_STATUS_COMMAND_TIMEOUT          0x0B
1353#define SRB_STATUS_MESSAGE_REJECTED         0x0D
1354#define SRB_STATUS_BUS_RESET                0x0E
1355#define SRB_STATUS_PARITY_ERROR             0x0F
1356#define SRB_STATUS_REQUEST_SENSE_FAILED     0x10
1357#define SRB_STATUS_NO_HBA                   0x11
1358#define SRB_STATUS_DATA_OVERRUN             0x12
1359#define SRB_STATUS_UNEXPECTED_BUS_FREE      0x13
1360#define SRB_STATUS_PHASE_SEQUENCE_FAILURE   0x14
1361#define SRB_STATUS_BAD_SRB_BLOCK_LENGTH     0x15
1362#define SRB_STATUS_REQUEST_FLUSHED          0x16
1363#define SRB_STATUS_DELAYED_RETRY	    0x17
1364#define SRB_STATUS_INVALID_LUN              0x20
1365#define SRB_STATUS_INVALID_TARGET_ID        0x21
1366#define SRB_STATUS_BAD_FUNCTION             0x22
1367#define SRB_STATUS_ERROR_RECOVERY           0x23
1368#define SRB_STATUS_NOT_STARTED		    0x24
1369#define SRB_STATUS_NOT_IN_USE		    0x30
1370#define SRB_STATUS_FORCE_ABORT		    0x31
1371#define SRB_STATUS_DOMAIN_VALIDATION_FAIL   0x32
1372
1373/*
1374 * Object-Server / Volume-Manager Dispatch Classes
1375 */
1376
1377#define		VM_Null			0
1378#define		VM_NameServe		1
1379#define		VM_ContainerConfig	2
1380#define		VM_Ioctl		3
1381#define		VM_FilesystemIoctl	4
1382#define		VM_CloseAll		5
1383#define		VM_CtBlockRead		6
1384#define		VM_CtBlockWrite		7
1385#define		VM_SliceBlockRead	8	/* raw access to configured "storage objects" */
1386#define		VM_SliceBlockWrite	9
1387#define		VM_DriveBlockRead	10	/* raw access to physical devices */
1388#define		VM_DriveBlockWrite	11
1389#define		VM_EnclosureMgt		12	/* enclosure management */
1390#define		VM_Unused		13	/* used to be diskset management */
1391#define		VM_CtBlockVerify	14
1392#define		VM_CtPerf		15	/* performance test */
1393#define		VM_CtBlockRead64	16
1394#define		VM_CtBlockWrite64	17
1395#define		VM_CtBlockVerify64	18
1396#define		VM_CtHostRead64		19
1397#define		VM_CtHostWrite64	20
1398#define		VM_DrvErrTblLog		21
1399#define		VM_NameServe64		22
1400
1401#define		MAX_VMCOMMAND_NUM	23	/* used for sizing stats array - leave last */
1402
1403/*
1404 *	Descriptive information (eg, vital stats)
1405 *	that a content manager might report.  The
1406 *	FileArray filesystem component is one example
1407 *	of a content manager.  Raw mode might be
1408 *	another.
1409 */
1410
1411struct aac_fsinfo {
1412	__le32  fsTotalSize;	/* Consumed by fs, incl. metadata */
1413	__le32  fsBlockSize;
1414	__le32  fsFragSize;
1415	__le32  fsMaxExtendSize;
1416	__le32  fsSpaceUnits;
1417	__le32  fsMaxNumFiles;
1418	__le32  fsNumFreeFiles;
1419	__le32  fsInodeDensity;
1420};	/* valid iff ObjType == FT_FILESYS && !(ContentState & FSCS_NOTCLEAN) */
1421
1422union aac_contentinfo {
1423	struct aac_fsinfo filesys;	/* valid iff ObjType == FT_FILESYS && !(ContentState & FSCS_NOTCLEAN) */
1424};
1425
1426/*
1427 *	Query for Container Configuration Status
1428 */
1429
1430#define CT_GET_CONFIG_STATUS 147
1431struct aac_get_config_status {
1432	__le32		command;	/* VM_ContainerConfig */
1433	__le32		type;		/* CT_GET_CONFIG_STATUS */
1434	__le32		parm1;
1435	__le32		parm2;
1436	__le32		parm3;
1437	__le32		parm4;
1438	__le32		parm5;
1439	__le32		count;	/* sizeof(((struct aac_get_config_status_resp *)NULL)->data) */
1440};
1441
1442#define CFACT_CONTINUE 0
1443#define CFACT_PAUSE    1
1444#define CFACT_ABORT    2
1445struct aac_get_config_status_resp {
1446	__le32		response; /* ST_OK */
1447	__le32		dummy0;
1448	__le32		status;	/* CT_OK */
1449	__le32		parm1;
1450	__le32		parm2;
1451	__le32		parm3;
1452	__le32		parm4;
1453	__le32		parm5;
1454	struct {
1455		__le32	action; /* CFACT_CONTINUE, CFACT_PAUSE or CFACT_ABORT */
1456		__le16	flags;
1457		__le16	count;
1458	}		data;
1459};
1460
1461/*
1462 *	Accept the configuration as-is
1463 */
1464
1465#define CT_COMMIT_CONFIG 152
1466
1467struct aac_commit_config {
1468	__le32		command;	/* VM_ContainerConfig */
1469	__le32		type;		/* CT_COMMIT_CONFIG */
1470};
1471
1472/*
1473 *	Query for Container Configuration Status
1474 */
1475
1476#define CT_GET_CONTAINER_COUNT 4
1477struct aac_get_container_count {
1478	__le32		command;	/* VM_ContainerConfig */
1479	__le32		type;		/* CT_GET_CONTAINER_COUNT */
1480};
1481
1482struct aac_get_container_count_resp {
1483	__le32		response; /* ST_OK */
1484	__le32		dummy0;
1485	__le32		MaxContainers;
1486	__le32		ContainerSwitchEntries;
1487	__le32		MaxPartitions;
1488};
1489
1490
1491/*
1492 *	Query for "mountable" objects, ie, objects that are typically
1493 *	associated with a drive letter on the client (host) side.
1494 */
1495
1496struct aac_mntent {
1497	__le32    		oid;
1498	u8			name[16];	/* if applicable */
1499	struct creation_info	create_info;	/* if applicable */
1500	__le32			capacity;
1501	__le32			vol;    	/* substrate structure */
1502	__le32			obj;	        /* FT_FILESYS,
1503						   FT_DATABASE, etc. */
1504	__le32			state;		/* unready for mounting,
1505						   readonly, etc. */
1506	union aac_contentinfo	fileinfo;	/* Info specific to content
1507						   manager (eg, filesystem) */
1508	__le32			altoid;		/* != oid <==> snapshot or
1509						   broken mirror exists */
1510	__le32			capacityhigh;
1511};
1512
1513#define FSCS_NOTCLEAN	0x0001  /* fsck is neccessary before mounting */
1514#define FSCS_READONLY	0x0002	/* possible result of broken mirror */
1515#define FSCS_HIDDEN	0x0004	/* should be ignored - set during a clear */
1516
1517struct aac_query_mount {
1518	__le32		command;
1519	__le32		type;
1520	__le32		count;
1521};
1522
1523struct aac_mount {
1524	__le32		status;
1525	__le32	   	type;           /* should be same as that requested */
1526	__le32		count;
1527	struct aac_mntent mnt[1];
1528};
1529
1530#define CT_READ_NAME 130
1531struct aac_get_name {
1532	__le32		command;	/* VM_ContainerConfig */
1533	__le32		type;		/* CT_READ_NAME */
1534	__le32		cid;
1535	__le32		parm1;
1536	__le32		parm2;
1537	__le32		parm3;
1538	__le32		parm4;
1539	__le32		count;	/* sizeof(((struct aac_get_name_resp *)NULL)->data) */
1540};
1541
1542struct aac_get_name_resp {
1543	__le32		dummy0;
1544	__le32		dummy1;
1545	__le32		status;	/* CT_OK */
1546	__le32		parm1;
1547	__le32		parm2;
1548	__le32		parm3;
1549	__le32		parm4;
1550	__le32		parm5;
1551	u8		data[16];
1552};
1553
1554/*
1555 * The following command is sent to shut down each container.
1556 */
1557
1558struct aac_close {
1559	__le32	command;
1560	__le32	cid;
1561};
1562
1563struct aac_query_disk
1564{
1565	s32	cnum;
1566	s32	bus;
1567	s32	id;
1568	s32	lun;
1569	u32	valid;
1570	u32	locked;
1571	u32	deleted;
1572	s32	instance;
1573	s8	name[10];
1574	u32	unmapped;
1575};
1576
1577struct aac_delete_disk {
1578	u32	disknum;
1579	u32	cnum;
1580};
1581
1582struct fib_ioctl
1583{
1584	u32	fibctx;
1585	s32	wait;
1586	char	__user *fib;
1587};
1588
1589struct revision
1590{
1591	u32 compat;
1592	__le32 version;
1593	__le32 build;
1594};
1595
1596
1597/*
1598 * 	Ugly - non Linux like ioctl coding for back compat.
1599 */
1600
1601#define CTL_CODE(function, method) (                 \
1602    (4<< 16) | ((function) << 2) | (method) \
1603)
1604
1605/*
1606 *	Define the method codes for how buffers are passed for I/O and FS
1607 *	controls
1608 */
1609
1610#define METHOD_BUFFERED                 0
1611#define METHOD_NEITHER                  3
1612
1613/*
1614 *	Filesystem ioctls
1615 */
1616
1617#define FSACTL_SENDFIB                  	CTL_CODE(2050, METHOD_BUFFERED)
1618#define FSACTL_SEND_RAW_SRB               	CTL_CODE(2067, METHOD_BUFFERED)
1619#define FSACTL_DELETE_DISK			0x163
1620#define FSACTL_QUERY_DISK			0x173
1621#define FSACTL_OPEN_GET_ADAPTER_FIB		CTL_CODE(2100, METHOD_BUFFERED)
1622#define FSACTL_GET_NEXT_ADAPTER_FIB		CTL_CODE(2101, METHOD_BUFFERED)
1623#define FSACTL_CLOSE_GET_ADAPTER_FIB		CTL_CODE(2102, METHOD_BUFFERED)
1624#define FSACTL_MINIPORT_REV_CHECK               CTL_CODE(2107, METHOD_BUFFERED)
1625#define FSACTL_GET_PCI_INFO               	CTL_CODE(2119, METHOD_BUFFERED)
1626#define FSACTL_FORCE_DELETE_DISK		CTL_CODE(2120, METHOD_NEITHER)
1627#define FSACTL_GET_CONTAINERS			2131
1628#define FSACTL_SEND_LARGE_FIB			CTL_CODE(2138, METHOD_BUFFERED)
1629
1630
1631struct aac_common
1632{
1633	/*
1634	 *	If this value is set to 1 then interrupt moderation will occur
1635	 *	in the base commuication support.
1636	 */
1637	u32 irq_mod;
1638	u32 peak_fibs;
1639	u32 zero_fibs;
1640	u32 fib_timeouts;
1641	/*
1642	 *	Statistical counters in debug mode
1643	 */
1644#ifdef DBG
1645	u32 FibsSent;
1646	u32 FibRecved;
1647	u32 NoResponseSent;
1648	u32 NoResponseRecved;
1649	u32 AsyncSent;
1650	u32 AsyncRecved;
1651	u32 NormalSent;
1652	u32 NormalRecved;
1653#endif
1654};
1655
1656extern struct aac_common aac_config;
1657
1658
1659/*
1660 *	The following macro is used when sending and receiving FIBs. It is
1661 *	only used for debugging.
1662 */
1663
1664#ifdef DBG
1665#define	FIB_COUNTER_INCREMENT(counter)		(counter)++
1666#else
1667#define	FIB_COUNTER_INCREMENT(counter)
1668#endif
1669
1670/*
1671 *	Adapter direct commands
1672 *	Monitor/Kernel API
1673 */
1674
1675#define	BREAKPOINT_REQUEST		0x00000004
1676#define	INIT_STRUCT_BASE_ADDRESS	0x00000005
1677#define READ_PERMANENT_PARAMETERS	0x0000000a
1678#define WRITE_PERMANENT_PARAMETERS	0x0000000b
1679#define HOST_CRASHING			0x0000000d
1680#define	SEND_SYNCHRONOUS_FIB		0x0000000c
1681#define COMMAND_POST_RESULTS		0x00000014
1682#define GET_ADAPTER_PROPERTIES		0x00000019
1683#define GET_DRIVER_BUFFER_PROPERTIES	0x00000023
1684#define RCV_TEMP_READINGS		0x00000025
1685#define GET_COMM_PREFERRED_SETTINGS	0x00000026
1686#define IOP_RESET			0x00001000
1687#define IOP_RESET_ALWAYS		0x00001001
1688#define RE_INIT_ADAPTER			0x000000ee
1689
1690/*
1691 *	Adapter Status Register
1692 *
1693 *  Phase Staus mailbox is 32bits:
1694 *	<31:16> = Phase Status
1695 *	<15:0>  = Phase
1696 *
1697 *	The adapter reports is present state through the phase.  Only
1698 *	a single phase should be ever be set.  Each phase can have multiple
1699 *	phase status bits to provide more detailed information about the
1700 *	state of the board.  Care should be taken to ensure that any phase
1701 *	status bits that are set when changing the phase are also valid
1702 *	for the new phase or be cleared out.  Adapter software (monitor,
1703 *	iflash, kernel) is responsible for properly maintining the phase
1704 *	status mailbox when it is running.
1705 *
1706 *	MONKER_API Phases
1707 *
1708 *	Phases are bit oriented.  It is NOT valid  to have multiple bits set
1709 */
1710
1711#define	SELF_TEST_FAILED		0x00000004
1712#define	MONITOR_PANIC			0x00000020
1713#define	KERNEL_UP_AND_RUNNING		0x00000080
1714#define	KERNEL_PANIC			0x00000100
1715
1716/*
1717 *	Doorbell bit defines
1718 */
1719
1720#define DoorBellSyncCmdAvailable	(1<<0)	/* Host -> Adapter */
1721#define DoorBellPrintfDone		(1<<5)	/* Host -> Adapter */
1722#define DoorBellAdapterNormCmdReady	(1<<1)	/* Adapter -> Host */
1723#define DoorBellAdapterNormRespReady	(1<<2)	/* Adapter -> Host */
1724#define DoorBellAdapterNormCmdNotFull	(1<<3)	/* Adapter -> Host */
1725#define DoorBellAdapterNormRespNotFull	(1<<4)	/* Adapter -> Host */
1726#define DoorBellPrintfReady		(1<<5)	/* Adapter -> Host */
1727
1728/*
1729 *	For FIB communication, we need all of the following things
1730 *	to send back to the user.
1731 */
1732
1733#define 	AifCmdEventNotify	1	/* Notify of event */
1734#define			AifEnConfigChange	3	/* Adapter configuration change */
1735#define			AifEnContainerChange	4	/* Container configuration change */
1736#define			AifEnDeviceFailure	5	/* SCSI device failed */
1737#define			AifEnAddContainer	15	/* A new array was created */
1738#define			AifEnDeleteContainer	16	/* A container was deleted */
1739#define			AifEnExpEvent		23	/* Firmware Event Log */
1740#define			AifExeFirmwarePanic	3	/* Firmware Event Panic */
1741#define			AifHighPriority		3	/* Highest Priority Event */
1742
1743#define		AifCmdJobProgress	2	/* Progress report */
1744#define			AifJobCtrZero	101	/* Array Zero progress */
1745#define			AifJobStsSuccess 1	/* Job completes */
1746#define			AifJobStsRunning 102	/* Job running */
1747#define		AifCmdAPIReport		3	/* Report from other user of API */
1748#define		AifCmdDriverNotify	4	/* Notify host driver of event */
1749#define			AifDenMorphComplete 200	/* A morph operation completed */
1750#define			AifDenVolumeExtendComplete 201 /* A volume extend completed */
1751#define		AifReqJobList		100	/* Gets back complete job list */
1752#define		AifReqJobsForCtr	101	/* Gets back jobs for specific container */
1753#define		AifReqJobsForScsi	102	/* Gets back jobs for specific SCSI device */
1754#define		AifReqJobReport		103	/* Gets back a specific job report or list of them */
1755#define		AifReqTerminateJob	104	/* Terminates job */
1756#define		AifReqSuspendJob	105	/* Suspends a job */
1757#define		AifReqResumeJob		106	/* Resumes a job */
1758#define		AifReqSendAPIReport	107	/* API generic report requests */
1759#define		AifReqAPIJobStart	108	/* Start a job from the API */
1760#define		AifReqAPIJobUpdate	109	/* Update a job report from the API */
1761#define		AifReqAPIJobFinish	110	/* Finish a job from the API */
1762
1763/*
1764 *	Adapter Initiated FIB command structures. Start with the adapter
1765 *	initiated FIBs that really come from the adapter, and get responded
1766 *	to by the host.
1767 */
1768
1769struct aac_aifcmd {
1770	__le32 command;		/* Tell host what type of notify this is */
1771	__le32 seqnum;		/* To allow ordering of reports (if necessary) */
1772	u8 data[1];		/* Undefined length (from kernel viewpoint) */
1773};
1774
1775/**
1776 * 	Convert capacity to cylinders
1777 *  	accounting for the fact capacity could be a 64 bit value
1778 *
1779 */
1780static inline u32 cap_to_cyls(sector_t capacity, u32 divisor)
1781{
1782	sector_div(capacity, divisor);
1783	return (u32)capacity;
1784}
1785
1786struct scsi_cmnd;
1787/* SCp.phase values */
1788#define AAC_OWNER_MIDLEVEL	0x101
1789#define AAC_OWNER_LOWLEVEL	0x102
1790#define AAC_OWNER_ERROR_HANDLER	0x103
1791#define AAC_OWNER_FIRMWARE	0x106
1792
1793const char *aac_driverinfo(struct Scsi_Host *);
1794struct fib *aac_fib_alloc(struct aac_dev *dev);
1795int aac_fib_setup(struct aac_dev *dev);
1796void aac_fib_map_free(struct aac_dev *dev);
1797void aac_fib_free(struct fib * context);
1798void aac_fib_init(struct fib * context);
1799void aac_printf(struct aac_dev *dev, u32 val);
1800int aac_fib_send(u16 command, struct fib * context, unsigned long size, int priority, int wait, int reply, fib_callback callback, void *ctxt);
1801int aac_consumer_get(struct aac_dev * dev, struct aac_queue * q, struct aac_entry **entry);
1802void aac_consumer_free(struct aac_dev * dev, struct aac_queue * q, u32 qnum);
1803int aac_fib_complete(struct fib * context);
1804#define fib_data(fibctx) ((void *)(fibctx)->hw_fib->data)
1805struct aac_dev *aac_init_adapter(struct aac_dev *dev);
1806int aac_get_config_status(struct aac_dev *dev, int commit_flag);
1807int aac_get_containers(struct aac_dev *dev);
1808int aac_scsi_cmd(struct scsi_cmnd *cmd);
1809int aac_dev_ioctl(struct aac_dev *dev, int cmd, void __user *arg);
1810int aac_do_ioctl(struct aac_dev * dev, int cmd, void __user *arg);
1811int aac_rx_init(struct aac_dev *dev);
1812int aac_rkt_init(struct aac_dev *dev);
1813int aac_sa_init(struct aac_dev *dev);
1814int aac_queue_get(struct aac_dev * dev, u32 * index, u32 qid, struct hw_fib * hw_fib, int wait, struct fib * fibptr, unsigned long *nonotify);
1815unsigned int aac_response_normal(struct aac_queue * q);
1816unsigned int aac_command_normal(struct aac_queue * q);
1817unsigned int aac_intr_normal(struct aac_dev * dev, u32 Index);
1818int aac_check_health(struct aac_dev * dev);
1819int aac_command_thread(void *data);
1820int aac_close_fib_context(struct aac_dev * dev, struct aac_fib_context *fibctx);
1821int aac_fib_adapter_complete(struct fib * fibptr, unsigned short size);
1822struct aac_driver_ident* aac_get_driver_ident(int devtype);
1823int aac_get_adapter_info(struct aac_dev* dev);
1824int aac_send_shutdown(struct aac_dev *dev);
1825int aac_probe_container(struct aac_dev *dev, int cid);
1826extern int numacb;
1827extern int acbsize;
1828extern char aac_driver_version[];
1829extern int startup_timeout;
1830extern int aif_timeout;
1831