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