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