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