]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blob - drivers/scsi/aacraid/aacraid.h
projects / mirror_ubuntu-zesty-kernel.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Pull bugzilla-7880 into release branch
[mirror_ubuntu-zesty-kernel.git] / drivers / scsi / aacraid / aacraid.h
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 2447
16 # define AAC_DRIVER_BRANCH "-ms"
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
42 struct 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 */
65 struct sgentry {
66 __le32 addr; /* 32-bit address. */
67 __le32 count; /* Length. */
68 };
69
70 struct user_sgentry {
71 u32 addr; /* 32-bit address. */
72 u32 count; /* Length. */
73 };
74
75 struct sgentry64 {
76 __le32 addr[2]; /* 64-bit addr. 2 pieces for data alignment */
77 __le32 count; /* Length. */
78 };
79
80 struct user_sgentry64 {
81 u32 addr[2]; /* 64-bit addr. 2 pieces for data alignment */
82 u32 count; /* Length. */
83 };
84
85 struct 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
93 struct 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
108 struct sgmap {
109 __le32 count;
110 struct sgentry sg[1];
111 };
112
113 struct user_sgmap {
114 u32 count;
115 struct user_sgentry sg[1];
116 };
117
118 struct sgmap64 {
119 __le32 count;
120 struct sgentry64 sg[1];
121 };
122
123 struct user_sgmap64 {
124 u32 count;
125 struct user_sgentry64 sg[1];
126 };
127
128 struct sgmapraw {
129 __le32 count;
130 struct sgentryraw sg[1];
131 };
132
133 struct user_sgmapraw {
134 u32 count;
135 struct user_sgentryraw sg[1];
136 };
137
138 struct 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
197 struct 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
207 struct 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
255 enum 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
283 struct 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
305 struct 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
377 enum 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
410 struct 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
436 enum 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
451 struct aac_dev;
452 struct fib;
453 struct scsi_cmnd;
454
455 struct 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
482 struct 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
533 struct 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
554 struct aac_queue_block
555 {
556 struct aac_queue queue[8];
557 };
558
559 /*
560 * SaP1 Message Unit Registers
561 */
562
563 struct 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
618 struct 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
634 struct 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
660 struct 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
681 struct 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
699 struct 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
710 typedef void (*fib_callback)(void *ctxt, struct fib *fibctx);
711
712 struct 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
724 struct 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
760 struct 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
776 struct 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
811 struct 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
836 struct 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 SupportedOptions2;
864 __le32 ReservedGrowth[1];
865 };
866 #define AAC_FEATURE_FALCON 0x00000010
867 #define AAC_OPTION_MU_RESET 0x00000001
868 #define AAC_OPTION_IGNORE_RESET 0x00000002
869 #define AAC_SIS_VERSION_V3 3
870 #define AAC_SIS_SLOT_UNKNOWN 0xFF
871
872 #define GetBusInfo 0x00000009
873 struct aac_bus_info {
874 __le32 Command; /* VM_Ioctl */
875 __le32 ObjType; /* FT_DRIVE */
876 __le32 MethodId; /* 1 = SCSI Layer */
877 __le32 ObjectId; /* Handle */
878 __le32 CtlCmd; /* GetBusInfo */
879 };
880
881 struct aac_bus_info_response {
882 __le32 Status; /* ST_OK */
883 __le32 ObjType;
884 __le32 MethodId; /* unused */
885 __le32 ObjectId; /* unused */
886 __le32 CtlCmd; /* unused */
887 __le32 ProbeComplete;
888 __le32 BusCount;
889 __le32 TargetsPerBus;
890 u8 InitiatorBusId[10];
891 u8 BusValid[10];
892 };
893
894 /*
895 * Battery platforms
896 */
897 #define AAC_BAT_REQ_PRESENT (1)
898 #define AAC_BAT_REQ_NOTPRESENT (2)
899 #define AAC_BAT_OPT_PRESENT (3)
900 #define AAC_BAT_OPT_NOTPRESENT (4)
901 #define AAC_BAT_NOT_SUPPORTED (5)
902 /*
903 * cpu types
904 */
905 #define AAC_CPU_SIMULATOR (1)
906 #define AAC_CPU_I960 (2)
907 #define AAC_CPU_STRONGARM (3)
908
909 /*
910 * Supported Options
911 */
912 #define AAC_OPT_SNAPSHOT cpu_to_le32(1)
913 #define AAC_OPT_CLUSTERS cpu_to_le32(1<<1)
914 #define AAC_OPT_WRITE_CACHE cpu_to_le32(1<<2)
915 #define AAC_OPT_64BIT_DATA cpu_to_le32(1<<3)
916 #define AAC_OPT_HOST_TIME_FIB cpu_to_le32(1<<4)
917 #define AAC_OPT_RAID50 cpu_to_le32(1<<5)
918 #define AAC_OPT_4GB_WINDOW cpu_to_le32(1<<6)
919 #define AAC_OPT_SCSI_UPGRADEABLE cpu_to_le32(1<<7)
920 #define AAC_OPT_SOFT_ERR_REPORT cpu_to_le32(1<<8)
921 #define AAC_OPT_SUPPORTED_RECONDITION cpu_to_le32(1<<9)
922 #define AAC_OPT_SGMAP_HOST64 cpu_to_le32(1<<10)
923 #define AAC_OPT_ALARM cpu_to_le32(1<<11)
924 #define AAC_OPT_NONDASD cpu_to_le32(1<<12)
925 #define AAC_OPT_SCSI_MANAGED cpu_to_le32(1<<13)
926 #define AAC_OPT_RAID_SCSI_MODE cpu_to_le32(1<<14)
927 #define AAC_OPT_SUPPLEMENT_ADAPTER_INFO cpu_to_le32(1<<16)
928 #define AAC_OPT_NEW_COMM cpu_to_le32(1<<17)
929 #define AAC_OPT_NEW_COMM_64 cpu_to_le32(1<<18)
930
931 struct aac_dev
932 {
933 struct list_head entry;
934 const char *name;
935 int id;
936
937 /*
938 * negotiated FIB settings
939 */
940 unsigned max_fib_size;
941 unsigned sg_tablesize;
942
943 /*
944 * Map for 128 fib objects (64k)
945 */
946 dma_addr_t hw_fib_pa;
947 struct hw_fib *hw_fib_va;
948 struct hw_fib *aif_base_va;
949 /*
950 * Fib Headers
951 */
952 struct fib *fibs;
953
954 struct fib *free_fib;
955 spinlock_t fib_lock;
956
957 struct aac_queue_block *queues;
958 /*
959 * The user API will use an IOCTL to register itself to receive
960 * FIBs from the adapter. The following list is used to keep
961 * track of all the threads that have requested these FIBs. The
962 * mutex is used to synchronize access to all data associated
963 * with the adapter fibs.
964 */
965 struct list_head fib_list;
966
967 struct adapter_ops a_ops;
968 unsigned long fsrev; /* Main driver's revision number */
969
970 unsigned base_size; /* Size of mapped in region */
971 struct aac_init *init; /* Holds initialization info to communicate with adapter */
972 dma_addr_t init_pa; /* Holds physical address of the init struct */
973
974 struct pci_dev *pdev; /* Our PCI interface */
975 void * printfbuf; /* pointer to buffer used for printf's from the adapter */
976 void * comm_addr; /* Base address of Comm area */
977 dma_addr_t comm_phys; /* Physical Address of Comm area */
978 size_t comm_size;
979
980 struct Scsi_Host *scsi_host_ptr;
981 int maximum_num_containers;
982 int maximum_num_physicals;
983 int maximum_num_channels;
984 struct fsa_dev_info *fsa_dev;
985 struct task_struct *thread;
986 int cardtype;
987
988 /*
989 * The following is the device specific extension.
990 */
991 #if (!defined(AAC_MIN_FOOTPRINT_SIZE))
992 # define AAC_MIN_FOOTPRINT_SIZE 8192
993 #endif
994 union
995 {
996 struct sa_registers __iomem *sa;
997 struct rx_registers __iomem *rx;
998 struct rkt_registers __iomem *rkt;
999 } regs;
1000 volatile void __iomem *base;
1001 volatile struct rx_inbound __iomem *IndexRegs;
1002 u32 OIMR; /* Mask Register Cache */
1003 /*
1004 * AIF thread states
1005 */
1006 u32 aif_thread;
1007 struct aac_adapter_info adapter_info;
1008 struct aac_supplement_adapter_info supplement_adapter_info;
1009 /* These are in adapter info but they are in the io flow so
1010 * lets break them out so we don't have to do an AND to check them
1011 */
1012 u8 nondasd_support;
1013 u8 dac_support;
1014 u8 raid_scsi_mode;
1015 u8 comm_interface;
1016 # define AAC_COMM_PRODUCER 0
1017 # define AAC_COMM_MESSAGE 1
1018 /* macro side-effects BEWARE */
1019 # define raw_io_interface \
1020 init->InitStructRevision==cpu_to_le32(ADAPTER_INIT_STRUCT_REVISION_4)
1021 u8 raw_io_64;
1022 u8 printf_enabled;
1023 u8 in_reset;
1024 };
1025
1026 #define aac_adapter_interrupt(dev) \
1027 (dev)->a_ops.adapter_interrupt(dev)
1028
1029 #define aac_adapter_notify(dev, event) \
1030 (dev)->a_ops.adapter_notify(dev, event)
1031
1032 #define aac_adapter_disable_int(dev) \
1033 (dev)->a_ops.adapter_disable_int(dev)
1034
1035 #define aac_adapter_enable_int(dev) \
1036 (dev)->a_ops.adapter_enable_int(dev)
1037
1038 #define aac_adapter_sync_cmd(dev, command, p1, p2, p3, p4, p5, p6, status, r1, r2, r3, r4) \
1039 (dev)->a_ops.adapter_sync_cmd(dev, command, p1, p2, p3, p4, p5, p6, status, r1, r2, r3, r4)
1040
1041 #define aac_adapter_check_health(dev) \
1042 (dev)->a_ops.adapter_check_health(dev)
1043
1044 #define aac_adapter_restart(dev,bled) \
1045 (dev)->a_ops.adapter_restart(dev,bled)
1046
1047 #define aac_adapter_ioremap(dev, size) \
1048 (dev)->a_ops.adapter_ioremap(dev, size)
1049
1050 #define aac_adapter_deliver(fib) \
1051 ((fib)->dev)->a_ops.adapter_deliver(fib)
1052
1053 #define aac_adapter_bounds(dev,cmd,lba) \
1054 dev->a_ops.adapter_bounds(dev,cmd,lba)
1055
1056 #define aac_adapter_read(fib,cmd,lba,count) \
1057 ((fib)->dev)->a_ops.adapter_read(fib,cmd,lba,count)
1058
1059 #define aac_adapter_write(fib,cmd,lba,count,fua) \
1060 ((fib)->dev)->a_ops.adapter_write(fib,cmd,lba,count,fua)
1061
1062 #define aac_adapter_scsi(fib,cmd) \
1063 ((fib)->dev)->a_ops.adapter_scsi(fib,cmd)
1064
1065 #define aac_adapter_comm(dev,comm) \
1066 (dev)->a_ops.adapter_comm(dev, comm)
1067
1068 #define FIB_CONTEXT_FLAG_TIMED_OUT (0x00000001)
1069
1070 /*
1071 * Define the command values
1072 */
1073
1074 #define Null 0
1075 #define GetAttributes 1
1076 #define SetAttributes 2
1077 #define Lookup 3
1078 #define ReadLink 4
1079 #define Read 5
1080 #define Write 6
1081 #define Create 7
1082 #define MakeDirectory 8
1083 #define SymbolicLink 9
1084 #define MakeNode 10
1085 #define Removex 11
1086 #define RemoveDirectoryx 12
1087 #define Rename 13
1088 #define Link 14
1089 #define ReadDirectory 15
1090 #define ReadDirectoryPlus 16
1091 #define FileSystemStatus 17
1092 #define FileSystemInfo 18
1093 #define PathConfigure 19
1094 #define Commit 20
1095 #define Mount 21
1096 #define UnMount 22
1097 #define Newfs 23
1098 #define FsCheck 24
1099 #define FsSync 25
1100 #define SimReadWrite 26
1101 #define SetFileSystemStatus 27
1102 #define BlockRead 28
1103 #define BlockWrite 29
1104 #define NvramIoctl 30
1105 #define FsSyncWait 31
1106 #define ClearArchiveBit 32
1107 #define SetAcl 33
1108 #define GetAcl 34
1109 #define AssignAcl 35
1110 #define FaultInsertion 36 /* Fault Insertion Command */
1111 #define CrazyCache 37 /* Crazycache */
1112
1113 #define MAX_FSACOMMAND_NUM 38
1114
1115
1116 /*
1117 * Define the status returns. These are very unixlike although
1118 * most are not in fact used
1119 */
1120
1121 #define ST_OK 0
1122 #define ST_PERM 1
1123 #define ST_NOENT 2
1124 #define ST_IO 5
1125 #define ST_NXIO 6
1126 #define ST_E2BIG 7
1127 #define ST_ACCES 13
1128 #define ST_EXIST 17
1129 #define ST_XDEV 18
1130 #define ST_NODEV 19
1131 #define ST_NOTDIR 20
1132 #define ST_ISDIR 21
1133 #define ST_INVAL 22
1134 #define ST_FBIG 27
1135 #define ST_NOSPC 28
1136 #define ST_ROFS 30
1137 #define ST_MLINK 31
1138 #define ST_WOULDBLOCK 35
1139 #define ST_NAMETOOLONG 63
1140 #define ST_NOTEMPTY 66
1141 #define ST_DQUOT 69
1142 #define ST_STALE 70
1143 #define ST_REMOTE 71
1144 #define ST_BADHANDLE 10001
1145 #define ST_NOT_SYNC 10002
1146 #define ST_BAD_COOKIE 10003
1147 #define ST_NOTSUPP 10004
1148 #define ST_TOOSMALL 10005
1149 #define ST_SERVERFAULT 10006
1150 #define ST_BADTYPE 10007
1151 #define ST_JUKEBOX 10008
1152 #define ST_NOTMOUNTED 10009
1153 #define ST_MAINTMODE 10010
1154 #define ST_STALEACL 10011
1155
1156 /*
1157 * On writes how does the client want the data written.
1158 */
1159
1160 #define CACHE_CSTABLE 1
1161 #define CACHE_UNSTABLE 2
1162
1163 /*
1164 * Lets the client know at which level the data was commited on
1165 * a write request
1166 */
1167
1168 #define CMFILE_SYNCH_NVRAM 1
1169 #define CMDATA_SYNCH_NVRAM 2
1170 #define CMFILE_SYNCH 3
1171 #define CMDATA_SYNCH 4
1172 #define CMUNSTABLE 5
1173
1174 struct aac_read
1175 {
1176 __le32 command;
1177 __le32 cid;
1178 __le32 block;
1179 __le32 count;
1180 struct sgmap sg; // Must be last in struct because it is variable
1181 };
1182
1183 struct aac_read64
1184 {
1185 __le32 command;
1186 __le16 cid;
1187 __le16 sector_count;
1188 __le32 block;
1189 __le16 pad;
1190 __le16 flags;
1191 struct sgmap64 sg; // Must be last in struct because it is variable
1192 };
1193
1194 struct aac_read_reply
1195 {
1196 __le32 status;
1197 __le32 count;
1198 };
1199
1200 struct aac_write
1201 {
1202 __le32 command;
1203 __le32 cid;
1204 __le32 block;
1205 __le32 count;
1206 __le32 stable; // Not used
1207 struct sgmap sg; // Must be last in struct because it is variable
1208 };
1209
1210 struct aac_write64
1211 {
1212 __le32 command;
1213 __le16 cid;
1214 __le16 sector_count;
1215 __le32 block;
1216 __le16 pad;
1217 __le16 flags;
1218 #define IO_TYPE_WRITE 0x00000000
1219 #define IO_TYPE_READ 0x00000001
1220 #define IO_SUREWRITE 0x00000008
1221 struct sgmap64 sg; // Must be last in struct because it is variable
1222 };
1223 struct aac_write_reply
1224 {
1225 __le32 status;
1226 __le32 count;
1227 __le32 committed;
1228 };
1229
1230 struct aac_raw_io
1231 {
1232 __le32 block[2];
1233 __le32 count;
1234 __le16 cid;
1235 __le16 flags; /* 00 W, 01 R */
1236 __le16 bpTotal; /* reserved for F/W use */
1237 __le16 bpComplete; /* reserved for F/W use */
1238 struct sgmapraw sg;
1239 };
1240
1241 #define CT_FLUSH_CACHE 129
1242 struct aac_synchronize {
1243 __le32 command; /* VM_ContainerConfig */
1244 __le32 type; /* CT_FLUSH_CACHE */
1245 __le32 cid;
1246 __le32 parm1;
1247 __le32 parm2;
1248 __le32 parm3;
1249 __le32 parm4;
1250 __le32 count; /* sizeof(((struct aac_synchronize_reply *)NULL)->data) */
1251 };
1252
1253 struct aac_synchronize_reply {
1254 __le32 dummy0;
1255 __le32 dummy1;
1256 __le32 status; /* CT_OK */
1257 __le32 parm1;
1258 __le32 parm2;
1259 __le32 parm3;
1260 __le32 parm4;
1261 __le32 parm5;
1262 u8 data[16];
1263 };
1264
1265 #define CT_PAUSE_IO 65
1266 #define CT_RELEASE_IO 66
1267 struct aac_pause {
1268 __le32 command; /* VM_ContainerConfig */
1269 __le32 type; /* CT_PAUSE_IO */
1270 __le32 timeout; /* 10ms ticks */
1271 __le32 min;
1272 __le32 noRescan;
1273 __le32 parm3;
1274 __le32 parm4;
1275 __le32 count; /* sizeof(((struct aac_pause_reply *)NULL)->data) */
1276 };
1277
1278 struct aac_srb
1279 {
1280 __le32 function;
1281 __le32 channel;
1282 __le32 id;
1283 __le32 lun;
1284 __le32 timeout;
1285 __le32 flags;
1286 __le32 count; // Data xfer size
1287 __le32 retry_limit;
1288 __le32 cdb_size;
1289 u8 cdb[16];
1290 struct sgmap sg;
1291 };
1292
1293 /*
1294 * This and associated data structs are used by the
1295 * ioctl caller and are in cpu order.
1296 */
1297 struct user_aac_srb
1298 {
1299 u32 function;
1300 u32 channel;
1301 u32 id;
1302 u32 lun;
1303 u32 timeout;
1304 u32 flags;
1305 u32 count; // Data xfer size
1306 u32 retry_limit;
1307 u32 cdb_size;
1308 u8 cdb[16];
1309 struct user_sgmap sg;
1310 };
1311
1312 #define AAC_SENSE_BUFFERSIZE 30
1313
1314 struct aac_srb_reply
1315 {
1316 __le32 status;
1317 __le32 srb_status;
1318 __le32 scsi_status;
1319 __le32 data_xfer_length;
1320 __le32 sense_data_size;
1321 u8 sense_data[AAC_SENSE_BUFFERSIZE]; // Can this be SCSI_SENSE_BUFFERSIZE
1322 };
1323 /*
1324 * SRB Flags
1325 */
1326 #define SRB_NoDataXfer 0x0000
1327 #define SRB_DisableDisconnect 0x0004
1328 #define SRB_DisableSynchTransfer 0x0008
1329 #define SRB_BypassFrozenQueue 0x0010
1330 #define SRB_DisableAutosense 0x0020
1331 #define SRB_DataIn 0x0040
1332 #define SRB_DataOut 0x0080
1333
1334 /*
1335 * SRB Functions - set in aac_srb->function
1336 */
1337 #define SRBF_ExecuteScsi 0x0000
1338 #define SRBF_ClaimDevice 0x0001
1339 #define SRBF_IO_Control 0x0002
1340 #define SRBF_ReceiveEvent 0x0003
1341 #define SRBF_ReleaseQueue 0x0004
1342 #define SRBF_AttachDevice 0x0005
1343 #define SRBF_ReleaseDevice 0x0006
1344 #define SRBF_Shutdown 0x0007
1345 #define SRBF_Flush 0x0008
1346 #define SRBF_AbortCommand 0x0010
1347 #define SRBF_ReleaseRecovery 0x0011
1348 #define SRBF_ResetBus 0x0012
1349 #define SRBF_ResetDevice 0x0013
1350 #define SRBF_TerminateIO 0x0014
1351 #define SRBF_FlushQueue 0x0015
1352 #define SRBF_RemoveDevice 0x0016
1353 #define SRBF_DomainValidation 0x0017
1354
1355 /*
1356 * SRB SCSI Status - set in aac_srb->scsi_status
1357 */
1358 #define SRB_STATUS_PENDING 0x00
1359 #define SRB_STATUS_SUCCESS 0x01
1360 #define SRB_STATUS_ABORTED 0x02
1361 #define SRB_STATUS_ABORT_FAILED 0x03
1362 #define SRB_STATUS_ERROR 0x04
1363 #define SRB_STATUS_BUSY 0x05
1364 #define SRB_STATUS_INVALID_REQUEST 0x06
1365 #define SRB_STATUS_INVALID_PATH_ID 0x07
1366 #define SRB_STATUS_NO_DEVICE 0x08
1367 #define SRB_STATUS_TIMEOUT 0x09
1368 #define SRB_STATUS_SELECTION_TIMEOUT 0x0A
1369 #define SRB_STATUS_COMMAND_TIMEOUT 0x0B
1370 #define SRB_STATUS_MESSAGE_REJECTED 0x0D
1371 #define SRB_STATUS_BUS_RESET 0x0E
1372 #define SRB_STATUS_PARITY_ERROR 0x0F
1373 #define SRB_STATUS_REQUEST_SENSE_FAILED 0x10
1374 #define SRB_STATUS_NO_HBA 0x11
1375 #define SRB_STATUS_DATA_OVERRUN 0x12
1376 #define SRB_STATUS_UNEXPECTED_BUS_FREE 0x13
1377 #define SRB_STATUS_PHASE_SEQUENCE_FAILURE 0x14
1378 #define SRB_STATUS_BAD_SRB_BLOCK_LENGTH 0x15
1379 #define SRB_STATUS_REQUEST_FLUSHED 0x16
1380 #define SRB_STATUS_DELAYED_RETRY 0x17
1381 #define SRB_STATUS_INVALID_LUN 0x20
1382 #define SRB_STATUS_INVALID_TARGET_ID 0x21
1383 #define SRB_STATUS_BAD_FUNCTION 0x22
1384 #define SRB_STATUS_ERROR_RECOVERY 0x23
1385 #define SRB_STATUS_NOT_STARTED 0x24
1386 #define SRB_STATUS_NOT_IN_USE 0x30
1387 #define SRB_STATUS_FORCE_ABORT 0x31
1388 #define SRB_STATUS_DOMAIN_VALIDATION_FAIL 0x32
1389
1390 /*
1391 * Object-Server / Volume-Manager Dispatch Classes
1392 */
1393
1394 #define VM_Null 0
1395 #define VM_NameServe 1
1396 #define VM_ContainerConfig 2
1397 #define VM_Ioctl 3
1398 #define VM_FilesystemIoctl 4
1399 #define VM_CloseAll 5
1400 #define VM_CtBlockRead 6
1401 #define VM_CtBlockWrite 7
1402 #define VM_SliceBlockRead 8 /* raw access to configured "storage objects" */
1403 #define VM_SliceBlockWrite 9
1404 #define VM_DriveBlockRead 10 /* raw access to physical devices */
1405 #define VM_DriveBlockWrite 11
1406 #define VM_EnclosureMgt 12 /* enclosure management */
1407 #define VM_Unused 13 /* used to be diskset management */
1408 #define VM_CtBlockVerify 14
1409 #define VM_CtPerf 15 /* performance test */
1410 #define VM_CtBlockRead64 16
1411 #define VM_CtBlockWrite64 17
1412 #define VM_CtBlockVerify64 18
1413 #define VM_CtHostRead64 19
1414 #define VM_CtHostWrite64 20
1415 #define VM_DrvErrTblLog 21
1416 #define VM_NameServe64 22
1417
1418 #define MAX_VMCOMMAND_NUM 23 /* used for sizing stats array - leave last */
1419
1420 /*
1421 * Descriptive information (eg, vital stats)
1422 * that a content manager might report. The
1423 * FileArray filesystem component is one example
1424 * of a content manager. Raw mode might be
1425 * another.
1426 */
1427
1428 struct aac_fsinfo {
1429 __le32 fsTotalSize; /* Consumed by fs, incl. metadata */
1430 __le32 fsBlockSize;
1431 __le32 fsFragSize;
1432 __le32 fsMaxExtendSize;
1433 __le32 fsSpaceUnits;
1434 __le32 fsMaxNumFiles;
1435 __le32 fsNumFreeFiles;
1436 __le32 fsInodeDensity;
1437 }; /* valid iff ObjType == FT_FILESYS && !(ContentState & FSCS_NOTCLEAN) */
1438
1439 union aac_contentinfo {
1440 struct aac_fsinfo filesys; /* valid iff ObjType == FT_FILESYS && !(ContentState & FSCS_NOTCLEAN) */
1441 };
1442
1443 /*
1444 * Query for Container Configuration Status
1445 */
1446
1447 #define CT_GET_CONFIG_STATUS 147
1448 struct aac_get_config_status {
1449 __le32 command; /* VM_ContainerConfig */
1450 __le32 type; /* CT_GET_CONFIG_STATUS */
1451 __le32 parm1;
1452 __le32 parm2;
1453 __le32 parm3;
1454 __le32 parm4;
1455 __le32 parm5;
1456 __le32 count; /* sizeof(((struct aac_get_config_status_resp *)NULL)->data) */
1457 };
1458
1459 #define CFACT_CONTINUE 0
1460 #define CFACT_PAUSE 1
1461 #define CFACT_ABORT 2
1462 struct aac_get_config_status_resp {
1463 __le32 response; /* ST_OK */
1464 __le32 dummy0;
1465 __le32 status; /* CT_OK */
1466 __le32 parm1;
1467 __le32 parm2;
1468 __le32 parm3;
1469 __le32 parm4;
1470 __le32 parm5;
1471 struct {
1472 __le32 action; /* CFACT_CONTINUE, CFACT_PAUSE or CFACT_ABORT */
1473 __le16 flags;
1474 __le16 count;
1475 } data;
1476 };
1477
1478 /*
1479 * Accept the configuration as-is
1480 */
1481
1482 #define CT_COMMIT_CONFIG 152
1483
1484 struct aac_commit_config {
1485 __le32 command; /* VM_ContainerConfig */
1486 __le32 type; /* CT_COMMIT_CONFIG */
1487 };
1488
1489 /*
1490 * Query for Container Configuration Status
1491 */
1492
1493 #define CT_GET_CONTAINER_COUNT 4
1494 struct aac_get_container_count {
1495 __le32 command; /* VM_ContainerConfig */
1496 __le32 type; /* CT_GET_CONTAINER_COUNT */
1497 };
1498
1499 struct aac_get_container_count_resp {
1500 __le32 response; /* ST_OK */
1501 __le32 dummy0;
1502 __le32 MaxContainers;
1503 __le32 ContainerSwitchEntries;
1504 __le32 MaxPartitions;
1505 };
1506
1507
1508 /*
1509 * Query for "mountable" objects, ie, objects that are typically
1510 * associated with a drive letter on the client (host) side.
1511 */
1512
1513 struct aac_mntent {
1514 __le32 oid;
1515 u8 name[16]; /* if applicable */
1516 struct creation_info create_info; /* if applicable */
1517 __le32 capacity;
1518 __le32 vol; /* substrate structure */
1519 __le32 obj; /* FT_FILESYS, etc. */
1520 __le32 state; /* unready for mounting,
1521 readonly, etc. */
1522 union aac_contentinfo fileinfo; /* Info specific to content
1523 manager (eg, filesystem) */
1524 __le32 altoid; /* != oid <==> snapshot or
1525 broken mirror exists */
1526 __le32 capacityhigh;
1527 };
1528
1529 #define FSCS_NOTCLEAN 0x0001 /* fsck is neccessary before mounting */
1530 #define FSCS_READONLY 0x0002 /* possible result of broken mirror */
1531 #define FSCS_HIDDEN 0x0004 /* should be ignored - set during a clear */
1532
1533 struct aac_query_mount {
1534 __le32 command;
1535 __le32 type;
1536 __le32 count;
1537 };
1538
1539 struct aac_mount {
1540 __le32 status;
1541 __le32 type; /* should be same as that requested */
1542 __le32 count;
1543 struct aac_mntent mnt[1];
1544 };
1545
1546 #define CT_READ_NAME 130
1547 struct aac_get_name {
1548 __le32 command; /* VM_ContainerConfig */
1549 __le32 type; /* CT_READ_NAME */
1550 __le32 cid;
1551 __le32 parm1;
1552 __le32 parm2;
1553 __le32 parm3;
1554 __le32 parm4;
1555 __le32 count; /* sizeof(((struct aac_get_name_resp *)NULL)->data) */
1556 };
1557
1558 struct aac_get_name_resp {
1559 __le32 dummy0;
1560 __le32 dummy1;
1561 __le32 status; /* CT_OK */
1562 __le32 parm1;
1563 __le32 parm2;
1564 __le32 parm3;
1565 __le32 parm4;
1566 __le32 parm5;
1567 u8 data[16];
1568 };
1569
1570 /*
1571 * The following command is sent to shut down each container.
1572 */
1573
1574 struct aac_close {
1575 __le32 command;
1576 __le32 cid;
1577 };
1578
1579 struct aac_query_disk
1580 {
1581 s32 cnum;
1582 s32 bus;
1583 s32 id;
1584 s32 lun;
1585 u32 valid;
1586 u32 locked;
1587 u32 deleted;
1588 s32 instance;
1589 s8 name[10];
1590 u32 unmapped;
1591 };
1592
1593 struct aac_delete_disk {
1594 u32 disknum;
1595 u32 cnum;
1596 };
1597
1598 struct fib_ioctl
1599 {
1600 u32 fibctx;
1601 s32 wait;
1602 char __user *fib;
1603 };
1604
1605 struct revision
1606 {
1607 u32 compat;
1608 __le32 version;
1609 __le32 build;
1610 };
1611
1612
1613 /*
1614 * Ugly - non Linux like ioctl coding for back compat.
1615 */
1616
1617 #define CTL_CODE(function, method) ( \
1618 (4<< 16) | ((function) << 2) | (method) \
1619 )
1620
1621 /*
1622 * Define the method codes for how buffers are passed for I/O and FS
1623 * controls
1624 */
1625
1626 #define METHOD_BUFFERED 0
1627 #define METHOD_NEITHER 3
1628
1629 /*
1630 * Filesystem ioctls
1631 */
1632
1633 #define FSACTL_SENDFIB CTL_CODE(2050, METHOD_BUFFERED)
1634 #define FSACTL_SEND_RAW_SRB CTL_CODE(2067, METHOD_BUFFERED)
1635 #define FSACTL_DELETE_DISK 0x163
1636 #define FSACTL_QUERY_DISK 0x173
1637 #define FSACTL_OPEN_GET_ADAPTER_FIB CTL_CODE(2100, METHOD_BUFFERED)
1638 #define FSACTL_GET_NEXT_ADAPTER_FIB CTL_CODE(2101, METHOD_BUFFERED)
1639 #define FSACTL_CLOSE_GET_ADAPTER_FIB CTL_CODE(2102, METHOD_BUFFERED)
1640 #define FSACTL_MINIPORT_REV_CHECK CTL_CODE(2107, METHOD_BUFFERED)
1641 #define FSACTL_GET_PCI_INFO CTL_CODE(2119, METHOD_BUFFERED)
1642 #define FSACTL_FORCE_DELETE_DISK CTL_CODE(2120, METHOD_NEITHER)
1643 #define FSACTL_GET_CONTAINERS 2131
1644 #define FSACTL_SEND_LARGE_FIB CTL_CODE(2138, METHOD_BUFFERED)
1645
1646
1647 struct aac_common
1648 {
1649 /*
1650 * If this value is set to 1 then interrupt moderation will occur
1651 * in the base commuication support.
1652 */
1653 u32 irq_mod;
1654 u32 peak_fibs;
1655 u32 zero_fibs;
1656 u32 fib_timeouts;
1657 /*
1658 * Statistical counters in debug mode
1659 */
1660 #ifdef DBG
1661 u32 FibsSent;
1662 u32 FibRecved;
1663 u32 NoResponseSent;
1664 u32 NoResponseRecved;
1665 u32 AsyncSent;
1666 u32 AsyncRecved;
1667 u32 NormalSent;
1668 u32 NormalRecved;
1669 #endif
1670 };
1671
1672 extern struct aac_common aac_config;
1673
1674
1675 /*
1676 * The following macro is used when sending and receiving FIBs. It is
1677 * only used for debugging.
1678 */
1679
1680 #ifdef DBG
1681 #define FIB_COUNTER_INCREMENT(counter) (counter)++
1682 #else
1683 #define FIB_COUNTER_INCREMENT(counter)
1684 #endif
1685
1686 /*
1687 * Adapter direct commands
1688 * Monitor/Kernel API
1689 */
1690
1691 #define BREAKPOINT_REQUEST 0x00000004
1692 #define INIT_STRUCT_BASE_ADDRESS 0x00000005
1693 #define READ_PERMANENT_PARAMETERS 0x0000000a
1694 #define WRITE_PERMANENT_PARAMETERS 0x0000000b
1695 #define HOST_CRASHING 0x0000000d
1696 #define SEND_SYNCHRONOUS_FIB 0x0000000c
1697 #define COMMAND_POST_RESULTS 0x00000014
1698 #define GET_ADAPTER_PROPERTIES 0x00000019
1699 #define GET_DRIVER_BUFFER_PROPERTIES 0x00000023
1700 #define RCV_TEMP_READINGS 0x00000025
1701 #define GET_COMM_PREFERRED_SETTINGS 0x00000026
1702 #define IOP_RESET 0x00001000
1703 #define IOP_RESET_ALWAYS 0x00001001
1704 #define RE_INIT_ADAPTER 0x000000ee
1705
1706 /*
1707 * Adapter Status Register
1708 *
1709 * Phase Staus mailbox is 32bits:
1710 * <31:16> = Phase Status
1711 * <15:0> = Phase
1712 *
1713 * The adapter reports is present state through the phase. Only
1714 * a single phase should be ever be set. Each phase can have multiple
1715 * phase status bits to provide more detailed information about the
1716 * state of the board. Care should be taken to ensure that any phase
1717 * status bits that are set when changing the phase are also valid
1718 * for the new phase or be cleared out. Adapter software (monitor,
1719 * iflash, kernel) is responsible for properly maintining the phase
1720 * status mailbox when it is running.
1721 *
1722 * MONKER_API Phases
1723 *
1724 * Phases are bit oriented. It is NOT valid to have multiple bits set
1725 */
1726
1727 #define SELF_TEST_FAILED 0x00000004
1728 #define MONITOR_PANIC 0x00000020
1729 #define KERNEL_UP_AND_RUNNING 0x00000080
1730 #define KERNEL_PANIC 0x00000100
1731
1732 /*
1733 * Doorbell bit defines
1734 */
1735
1736 #define DoorBellSyncCmdAvailable (1<<0) /* Host -> Adapter */
1737 #define DoorBellPrintfDone (1<<5) /* Host -> Adapter */
1738 #define DoorBellAdapterNormCmdReady (1<<1) /* Adapter -> Host */
1739 #define DoorBellAdapterNormRespReady (1<<2) /* Adapter -> Host */
1740 #define DoorBellAdapterNormCmdNotFull (1<<3) /* Adapter -> Host */
1741 #define DoorBellAdapterNormRespNotFull (1<<4) /* Adapter -> Host */
1742 #define DoorBellPrintfReady (1<<5) /* Adapter -> Host */
1743
1744 /*
1745 * For FIB communication, we need all of the following things
1746 * to send back to the user.
1747 */
1748
1749 #define AifCmdEventNotify 1 /* Notify of event */
1750 #define AifEnConfigChange 3 /* Adapter configuration change */
1751 #define AifEnContainerChange 4 /* Container configuration change */
1752 #define AifEnDeviceFailure 5 /* SCSI device failed */
1753 #define AifEnAddContainer 15 /* A new array was created */
1754 #define AifEnDeleteContainer 16 /* A container was deleted */
1755 #define AifEnExpEvent 23 /* Firmware Event Log */
1756 #define AifExeFirmwarePanic 3 /* Firmware Event Panic */
1757 #define AifHighPriority 3 /* Highest Priority Event */
1758
1759 #define AifCmdJobProgress 2 /* Progress report */
1760 #define AifJobCtrZero 101 /* Array Zero progress */
1761 #define AifJobStsSuccess 1 /* Job completes */
1762 #define AifJobStsRunning 102 /* Job running */
1763 #define AifCmdAPIReport 3 /* Report from other user of API */
1764 #define AifCmdDriverNotify 4 /* Notify host driver of event */
1765 #define AifDenMorphComplete 200 /* A morph operation completed */
1766 #define AifDenVolumeExtendComplete 201 /* A volume extend completed */
1767 #define AifReqJobList 100 /* Gets back complete job list */
1768 #define AifReqJobsForCtr 101 /* Gets back jobs for specific container */
1769 #define AifReqJobsForScsi 102 /* Gets back jobs for specific SCSI device */
1770 #define AifReqJobReport 103 /* Gets back a specific job report or list of them */
1771 #define AifReqTerminateJob 104 /* Terminates job */
1772 #define AifReqSuspendJob 105 /* Suspends a job */
1773 #define AifReqResumeJob 106 /* Resumes a job */
1774 #define AifReqSendAPIReport 107 /* API generic report requests */
1775 #define AifReqAPIJobStart 108 /* Start a job from the API */
1776 #define AifReqAPIJobUpdate 109 /* Update a job report from the API */
1777 #define AifReqAPIJobFinish 110 /* Finish a job from the API */
1778
1779 /*
1780 * Adapter Initiated FIB command structures. Start with the adapter
1781 * initiated FIBs that really come from the adapter, and get responded
1782 * to by the host.
1783 */
1784
1785 struct aac_aifcmd {
1786 __le32 command; /* Tell host what type of notify this is */
1787 __le32 seqnum; /* To allow ordering of reports (if necessary) */
1788 u8 data[1]; /* Undefined length (from kernel viewpoint) */
1789 };
1790
1791 /**
1792 * Convert capacity to cylinders
1793 * accounting for the fact capacity could be a 64 bit value
1794 *
1795 */
1796 static inline u32 cap_to_cyls(sector_t capacity, u32 divisor)
1797 {
1798 sector_div(capacity, divisor);
1799 return (u32)capacity;
1800 }
1801
1802 /* SCp.phase values */
1803 #define AAC_OWNER_MIDLEVEL 0x101
1804 #define AAC_OWNER_LOWLEVEL 0x102
1805 #define AAC_OWNER_ERROR_HANDLER 0x103
1806 #define AAC_OWNER_FIRMWARE 0x106
1807
1808 const char *aac_driverinfo(struct Scsi_Host *);
1809 struct fib *aac_fib_alloc(struct aac_dev *dev);
1810 int aac_fib_setup(struct aac_dev *dev);
1811 void aac_fib_map_free(struct aac_dev *dev);
1812 void aac_fib_free(struct fib * context);
1813 void aac_fib_init(struct fib * context);
1814 void aac_printf(struct aac_dev *dev, u32 val);
1815 int aac_fib_send(u16 command, struct fib * context, unsigned long size, int priority, int wait, int reply, fib_callback callback, void *ctxt);
1816 int aac_consumer_get(struct aac_dev * dev, struct aac_queue * q, struct aac_entry **entry);
1817 void aac_consumer_free(struct aac_dev * dev, struct aac_queue * q, u32 qnum);
1818 int aac_fib_complete(struct fib * context);
1819 #define fib_data(fibctx) ((void *)(fibctx)->hw_fib_va->data)
1820 struct aac_dev *aac_init_adapter(struct aac_dev *dev);
1821 int aac_get_config_status(struct aac_dev *dev, int commit_flag);
1822 int aac_get_containers(struct aac_dev *dev);
1823 int aac_scsi_cmd(struct scsi_cmnd *cmd);
1824 int aac_dev_ioctl(struct aac_dev *dev, int cmd, void __user *arg);
1825 #ifndef shost_to_class
1826 #define shost_to_class(shost) &shost->shost_classdev
1827 #endif
1828 ssize_t aac_show_serial_number(struct class_device *class_dev, char *buf);
1829 int aac_do_ioctl(struct aac_dev * dev, int cmd, void __user *arg);
1830 int aac_rx_init(struct aac_dev *dev);
1831 int aac_rkt_init(struct aac_dev *dev);
1832 int aac_nark_init(struct aac_dev *dev);
1833 int aac_sa_init(struct aac_dev *dev);
1834 int aac_queue_get(struct aac_dev * dev, u32 * index, u32 qid, struct hw_fib * hw_fib, int wait, struct fib * fibptr, unsigned long *nonotify);
1835 unsigned int aac_response_normal(struct aac_queue * q);
1836 unsigned int aac_command_normal(struct aac_queue * q);
1837 unsigned int aac_intr_normal(struct aac_dev * dev, u32 Index);
1838 int aac_reset_adapter(struct aac_dev * dev, int forced);
1839 int aac_check_health(struct aac_dev * dev);
1840 int aac_command_thread(void *data);
1841 int aac_close_fib_context(struct aac_dev * dev, struct aac_fib_context *fibctx);
1842 int aac_fib_adapter_complete(struct fib * fibptr, unsigned short size);
1843 struct aac_driver_ident* aac_get_driver_ident(int devtype);
1844 int aac_get_adapter_info(struct aac_dev* dev);
1845 int aac_send_shutdown(struct aac_dev *dev);
1846 int aac_probe_container(struct aac_dev *dev, int cid);
1847 int _aac_rx_init(struct aac_dev *dev);
1848 int aac_rx_select_comm(struct aac_dev *dev, int comm);
1849 int aac_rx_deliver_producer(struct fib * fib);
1850 extern int numacb;
1851 extern int acbsize;
1852 extern char aac_driver_version[];
1853 extern int startup_timeout;
1854 extern int aif_timeout;
1855 extern int expose_physicals;
1856 extern int aac_reset_devices;
1857 extern int aac_commit;
1858 extern int update_interval;
1859 extern int check_interval;
1860 extern int check_reset;
ubuntu-zesty-kernel mirror