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