root/dev/ic/aacreg.h

INCLUDED FROM

DEFINITIONS

1. TestCommandResponse
2. TestAdapterCommand
3. LastTestCommand
4. ReinitHostNormCommandQueue
5. ReinitHostHighCommandQueue
6. ReinitHostHighRespQueue
7. ReinitHostNormRespQueue
8. ReinitAdapNormCommandQueue
9. ReinitAdapHighCommandQueue
10. ReinitAdapHighRespQueue
11. ReinitAdapNormRespQueue
12. InterfaceShutdown
13. DmaCommandFib
14. StartProfile
15. TermProfile
16. SpeedTest
17. TakeABreakPt
18. RequestPerfData
19. SetInterruptDefTimer
20. SetInterruptDefCount
21. GetInterruptDefStatus
22. LastCommCommand
23. NuFileSystem
24. UFS
25. HostFileSystem
26. LastFileSystemCommand
27. ContainerCommand
28. ContainerCommand64
29. ClusterCommand
30. ScsiPortCommand
31. AifRequest
32. CheckRevision
33. FsaHostShutdown
34. RequestAdapterInfo
35. IsAdapterPaused
36. SendHostTime
37. LastMiscCommand
38. AAC_FibCommands
39. CT_NONE
40. CT_VOLUME
41. CT_MIRROR
42. CT_STRIPE
43. CT_RAID5
44. CT_SSRW
45. CT_SSRO
46. CT_MORPH
47. CT_PASSTHRU
48. CT_RAID4
49. CT_RAID10
50. CT_RAID00
51. CT_VOLUME_OF_MIRRORS
52. CT_PSEUDO_RAID3
53. CT_RAID50
54. AAC_FSAVolType
55. FT_REG
56. FT_DIR
57. FT_BLK
58. FT_CHR
59. FT_LNK
60. FT_SOCK
61. FT_FIFO
62. FT_FILESYS
63. FT_DRIVE
64. FT_SLICE
65. FT_PARTITION
66. FT_VOLUME
67. FT_STRIPE
68. FT_MIRROR
69. FT_RAID5
70. FT_DATABASE
71. AAC_FType
72. RevApplication
73. RevDkiCli
74. RevNetService
75. RevApi
76. RevFileSysDriver
77. RevMiniportDriver
78. RevAdapterSW
79. RevMonitor
80. RevRemoteApi
81. RevComponent
82. CPU_NTSIM
83. CPU_I960
84. CPU_ARM
85. CPU_SPARC
86. CPU_POWERPC
87. CPU_ALPHA
88. CPU_P7
89. CPU_I960_RX
90. CPU__last
91. AAC_CpuType
92. CPUI960_JX
93. CPUI960_CX
94. CPUI960_HX
95. CPUI960_RX
96. CPUARM_SA110
97. CPUARM_xxx
98. CPUMPC_824x
99. CPUPPC_xxx
100. CPUI960_302
101. CPUSUBTYPE__last
102. AAC_CpuSubType
103. PLAT_NTSIM
104. PLAT_V3ADU
105. PLAT_CYCLONE
106. PLAT_CYCLONE_HD
107. PLAT_BATBOARD
108. PLAT_BATBOARD_HD
109. PLAT_YOLO
110. PLAT_COBRA
111. PLAT_ANAHEIM
112. PLAT_JALAPENO
113. PLAT_QUEENS
114. PLAT_JALAPENO_DELL
115. PLAT_POBLANO
116. PLAT_POBLANO_OPAL
117. PLAT_POBLANO_SL0
118. PLAT_POBLANO_SL1
119. PLAT_POBLANO_SL2
120. PLAT_POBLANO_XXX
121. PLAT_JALAPENO_P2
122. PLAT_HABANERO
123. PLAT__last
124. AAC_Platform
125. OEM_FLAVOR_ADAPTEC
126. OEM_FLAVOR_DELL
127. OEM_FLAVOR_HP
128. OEM_FLAVOR_IBM
129. OEM_FLAVOR_CPQ
130. OEM_FLAVOR_BRAND_X
131. OEM_FLAVOR_BRAND_Y
132. OEM_FLAVOR_BRAND_Z
133. OEM_FLAVOR__last
134. AAC_OemFlavor
135. PLATFORM_BAT_REQ_PRESENT
136. PLATFORM_BAT_REQ_NOTPRESENT
137. PLATFORM_BAT_OPT_PRESENT
138. PLATFORM_BAT_OPT_NOTPRESENT
139. PLATFORM_BAT_NOT_SUPPORTED
140. AAC_BatteryPlatform
141. NVSTATUS_DISABLED
142. NVSTATUS_ENABLED
143. NVSTATUS_ERROR
144. NVSTATUS_BATTERY
145. NVSTATUS_UNKNOWN
146. AAC_NVSTATUS
147. NVBATTSTATUS_NONE
148. NVBATTSTATUS_LOW
149. NVBATTSTATUS_OK
150. NVBATTSTATUS_RECONDITIONING
151. AAC_NVBATTSTATUS
152. NVBATT_TRANSITION_NONE
153. NVBATT_TRANSITION_LOW
154. NVBATT_TRANSITION_OK
155. AAC_NVBATT_TRANSITION
156. AifJobStsSuccess
157. AifJobStsFinished
158. AifJobStsAborted
159. AifJobStsFailed
160. AifJobStsLastReportMarker
161. AifJobStsSuspended
162. AifJobStsRunning
163. AAC_AifJobStatus
164. AifJobScsiMin
165. AifJobScsiZero
166. AifJobScsiVerify
167. AifJobScsiExercise
168. AifJobScsiVerifyRepair
169. AifJobScsiMax
170. AifJobCtrMin
171. AifJobCtrZero
172. AifJobCtrCopy
173. AifJobCtrCreateMirror
174. AifJobCtrMergeMirror
175. AifJobCtrScrubMirror
176. AifJobCtrRebuildRaid5
177. AifJobCtrScrubRaid5
178. AifJobCtrMorph
179. AifJobCtrPartCopy
180. AifJobCtrRebuildMirror
181. AifJobCtrCrazyCache
182. AifJobCtrMax
183. AifJobFsMin
184. AifJobFsCreate
185. AifJobFsVerify
186. AifJobFsExtend
187. AifJobFsMax
188. AifJobApiFormatNTFS
189. AifJobApiFormatFAT
190. AifJobApiUpdateSnapshot
191. AifJobApiFormatFAT32
192. AifJobApiMax
193. AifJobCtlContinuousCtrVerify
194. AifJobCtlMax
195. AAC_AifJobType
196. AifEnGeneric
197. AifEnTaskComplete
198. AifEnConfigChange
199. AifEnContainerChange
200. AifEnDeviceFailure
201. AifEnMirrorFailover
202. AifEnContainerEvent
203. AifEnFileSystemChange
204. AifEnConfigPause
205. AifEnConfigResume
206. AifEnFailoverChange
207. AifEnRAID5RebuildDone
208. AifEnEnclosureManagement
209. AifEnBatteryEvent
210. AifEnAddContainer
211. AifEnDeleteContainer
212. AifEnSMARTEvent
213. AifEnBatteryNeedsRecond
214. AifEnClusterEvent
215. AifEnDiskSetEvent
216. AifDriverNotifyStart
217. AifDenMorphComplete
218. AifDenVolumeExtendComplete
219. AAC_AifEventNotifyType
220. CLUSTER_NULL_EVENT
221. CLUSTER_PARTNER_NAME_EVENT
222. CLUSTER_PARTNER_NULL_NAME_EVENT
223. AAC_ClusterAifEvent
224. AifCmdEventNotify
225. AifCmdJobProgress
226. AifCmdAPIReport
227. AifCmdDriverNotify
228. AifReqJobList
229. AifReqJobsForCtr
230. AifReqJobsForScsi
231. AifReqJobReport
232. AifReqTerminateJob
233. AifReqSuspendJob
234. AifReqResumeJob
235. AifReqSendAPIReport
236. AifReqAPIJobStart
237. AifReqAPIJobUpdate
238. AifReqAPIJobFinish
239. AAC_AifCommand
240. Null
241. GetAttributes
242. SetAttributes
243. Lookup
244. ReadLink
245. Read
246. Write
247. Create
248. MakeDirectory
249. SymbolicLink
250. MakeNode
251. Removex
252. RemoveDirectory
253. Rename
254. Link
255. ReadDirectory
256. ReadDirectoryPlus
257. FileSystemStatus
258. FileSystemInfo
259. PathConfigure
260. Commit
261. Mount
262. UnMount
263. Newfs
264. FsCheck
265. FsSync
266. SimReadWrite
267. SetFileSystemStatus
268. BlockRead
269. BlockWrite
270. NvramIoctl
271. FsSyncWait
272. ClearArchiveBit
273. SetAcl
274. GetAcl
275. AssignAcl
276. FaultInsertion
277. CrazyCache
278. AAC_FSACommand
279. ST_OK
280. ST_PERM
281. ST_NOENT
282. ST_IO
283. ST_NXIO
284. ST_E2BIG
285. ST_ACCES
286. ST_EXIST
287. ST_XDEV
288. ST_NODEV
289. ST_NOTDIR
290. ST_ISDIR
291. ST_INVAL
292. ST_FBIG
293. ST_NOSPC
294. ST_ROFS
295. ST_MLINK
296. ST_WOULDBLOCK
297. ST_NAMETOOLONG
298. ST_NOTEMPTY
299. ST_DQUOT
300. ST_STALE
301. ST_REMOTE
302. ST_BADHANDLE
303. ST_NOT_SYNC
304. ST_BAD_COOKIE
305. ST_NOTSUPP
306. ST_TOOSMALL
307. ST_SERVERFAULT
308. ST_BADTYPE
309. ST_JUKEBOX
310. ST_NOTMOUNTED
311. ST_MAINTMODE
312. ST_STALEACL
313. AAC_FSAStatus
314. VM_Null
315. VM_NameServe
316. VM_ContainerConfig
317. VM_Ioctl
318. VM_FilesystemIoctl
319. VM_CloseAll
320. VM_CtBlockRead
321. VM_CtBlockWrite
322. VM_SliceBlockRead
323. VM_SliceBlockWrite
324. VM_DriveBlockRead
325. VM_DriveBlockWrite
326. VM_EnclosureMgt
327. VM_Unused
328. VM_CtBlockVerify
329. VM_CtPerf
330. VM_CtBlockRead64
331. VM_CtBlockWrite64
332. VM_CtBlockVerify64
333. VM_CtHostRead64
334. VM_CtHostWrite64
335. AAC_VMCommand
336. CSTABLE
337. CUNSTABLE
338. AAC_CacheLevel
339. CMFILE_SYNC_NVRAM
340. CMDATA_SYNC_NVRAM
341. CMFILE_SYNC
342. CMDATA_SYNC
343. CMUNSTABLE
344. AAC_CommitLevel

    1 /*      $OpenBSD: aacreg.h,v 1.8 2006/04/22 02:36:26 brad Exp $ */
    3 /*-
    4  * Copyright (c) 2000 Michael Smith
    5  * Copyright (c) 2000-2001 Scott Long
    6  * Copyright (c) 2000 BSDi
    7  * Copyright (c) 2001 Adaptec, Inc.
    8  * Copyright (c) 2000 Niklas Hallqvist
    9  * All rights reserved.
   10  *
   11  * Redistribution and use in source and binary forms, with or without
   12  * modification, are permitted provided that the following conditions
   13  * are met:
   14  * 1. Redistributions of source code must retain the above copyright
   15  *    notice, this list of conditions and the following disclaimer.
   16  * 2. Redistributions in binary form must reproduce the above copyright
   17  *    notice, this list of conditions and the following disclaimer in the
   18  *    documentation and/or other materials provided with the distribution.
   19  *
   20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
   21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
   24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   30  * SUCH DAMAGE.
   31  *
   32  *      $FreeBSD$
   33  */
   35 /*
   36  * Data structures defining the interface between the driver and the Adaptec
   37  * 'FSA' adapters.  Note that many field names and comments here are taken
   38  * verbatim from the Adaptec driver source in order to make comparing the
   39  * two slightly easier.
   40  */
   42 /*
   43  * Misc. magic numbers.
   44  */
   45 #define AAC_MAX_CONTAINERS      64
   46 #define AAC_BLOCK_SIZE          512
   48 /*
   49  * Communications interface.
   50  *
   51  * Where datastructure layouts are closely parallel to the Adaptec sample code,
   52  * retain their naming conventions (for now) to aid in cross-referencing.
   53  */
   55 /*
   56  * We establish 4 command queues and matching response queues.  Queues must
   57  * be 16-byte aligned, and are sized as follows:
   58  */
   59 #define AAC_HOST_NORM_CMD_ENTRIES       8       /* command adapter->host,
   60                                                  * normal priority */
   61 #define AAC_HOST_HIGH_CMD_ENTRIES       4       /* command adapter->host,
   62                                                  * high priority */
   63 #define AAC_ADAP_NORM_CMD_ENTRIES       512     /* command host->adapter,
   64                                                  * normal priority */
   65 #define AAC_ADAP_HIGH_CMD_ENTRIES       4       /* command host->adapter,
   66                                                  * high priority */
   67 #define AAC_HOST_NORM_RESP_ENTRIES      512     /* response, adapter->host,
   68                                                  * normal priority */
   69 #define AAC_HOST_HIGH_RESP_ENTRIES      4       /* response, adapter->host,
   70                                                  * high priority */
   71 #define AAC_ADAP_NORM_RESP_ENTRIES      8       /* response, host->adapter,
   72                                                  * normal priority */
   73 #define AAC_ADAP_HIGH_RESP_ENTRIES      4       /* response, host->adapter,
   74                                                  * high priority */
   76 #define AAC_TOTALQ_LENGTH       (AAC_HOST_HIGH_CMD_ENTRIES +    \
AAC_HOST_NORM_CMD_ENTRIES +    \
AAC_ADAP_HIGH_CMD_ENTRIES +    \
AAC_ADAP_NORM_CMD_ENTRIES +    \
AAC_HOST_HIGH_RESP_ENTRIES +   \
AAC_HOST_NORM_RESP_ENTRIES +   \
AAC_ADAP_HIGH_RESP_ENTRIES +   \
AAC_ADAP_NORM_RESP_ENTRIES)
   84 #define AAC_QUEUE_COUNT         8
   85 #define AAC_QUEUE_ALIGN         16
   87 struct aac_queue_entry {
u_int32_t       aq_fib_size;    /* FIB size in bytes */
u_int32_t       aq_fib_addr;    /* receiver-space address of the FIB */
   90 } __attribute__ ((__packed__));
   92 #define AAC_PRODUCER_INDEX      0
   93 #define AAC_CONSUMER_INDEX      1
   95 /*
   96  * Table of queue indices and queues used to communicate with the
   97  * controller.  This structure must be aligned to AAC_QUEUE_ALIGN
   98  */
   99 struct aac_queue_table {
  100         /* queue consumer/producer indexes (layout mandated by adapter) */
u_int32_t                       qt_qindex[AAC_QUEUE_COUNT][2];
  103         /* queue entry structures (layout mandated by adapter) */
  104         struct aac_queue_entry qt_HostNormCmdQueue [AAC_HOST_NORM_CMD_ENTRIES];
  105         struct aac_queue_entry qt_HostHighCmdQueue [AAC_HOST_HIGH_CMD_ENTRIES];
  106         struct aac_queue_entry qt_AdapNormCmdQueue [AAC_ADAP_NORM_CMD_ENTRIES];
  107         struct aac_queue_entry qt_AdapHighCmdQueue [AAC_ADAP_HIGH_CMD_ENTRIES];
  108         struct aac_queue_entry qt_HostNormRespQueue[AAC_HOST_NORM_RESP_ENTRIES];
  109         struct aac_queue_entry qt_HostHighRespQueue[AAC_HOST_HIGH_RESP_ENTRIES];
  110         struct aac_queue_entry qt_AdapNormRespQueue[AAC_ADAP_NORM_RESP_ENTRIES];
  111         struct aac_queue_entry qt_AdapHighRespQueue[AAC_ADAP_HIGH_RESP_ENTRIES];
  112 } __attribute__ ((__packed__));
  114 /*
  115  * Queue names
  116  *
  117  * Note that we base these at 0 in order to use them as array indices.  Adaptec
  118  * used base 1 for some unknown reason, and sorted them in a different order.
  119  */
  120 #define AAC_HOST_NORM_CMD_QUEUE         0
  121 #define AAC_HOST_HIGH_CMD_QUEUE         1
  122 #define AAC_ADAP_NORM_CMD_QUEUE         2
  123 #define AAC_ADAP_HIGH_CMD_QUEUE         3
  124 #define AAC_HOST_NORM_RESP_QUEUE        4
  125 #define AAC_HOST_HIGH_RESP_QUEUE        5
  126 #define AAC_ADAP_NORM_RESP_QUEUE        6
  127 #define AAC_ADAP_HIGH_RESP_QUEUE        7
  129 /*
  130  * List structure used to chain FIBs (used by the adapter - we hang FIBs off
  131  * our private command structure and don't touch these)
  132  */
  133 struct aac_fib_list_entry {
u_int32_t       Flink;
u_int32_t       Blink;
  136 } __attribute__ ((__packed__));
  138 /*
  139  * FIB (FSA Interface Block?); this is the datastructure passed between the host
  140  * and adapter.
  141  */
  142 struct aac_fib_header {
u_int32_t               XferState;
u_int16_t               Command;
u_int8_t                StructType;
u_int8_t                Flags;
u_int16_t               Size;
u_int16_t               SenderSize;
u_int32_t               SenderFibAddress;
u_int32_t               ReceiverFibAddress;
u_int32_t               SenderData;
  152         union {
  153                 struct {
u_int32_t       ReceiverTimeStart;
u_int32_t       ReceiverTimeDone;
  156                 } _s;
  157                 struct aac_fib_list_entry FibLinks;
  158         } _u;
  159 } __attribute__ ((__packed__));
  161 #define AAC_FIB_DATASIZE        (512 - sizeof(struct aac_fib_header))
  163 struct aac_fib {
  164         struct aac_fib_header   Header;
u_int8_t                        data[AAC_FIB_DATASIZE];
  166 } __attribute__ ((__packed__));
  168 /*
  169  * FIB commands
  170  */
  171 typedef enum {
  172         TestCommandResponse =           1,
  173         TestAdapterCommand =            2,
  175         /* lowlevel and comm commands */
  176         LastTestCommand =               100,
  177         ReinitHostNormCommandQueue =    101,
  178         ReinitHostHighCommandQueue =    102,
  179         ReinitHostHighRespQueue =       103,
  180         ReinitHostNormRespQueue =       104,
  181         ReinitAdapNormCommandQueue =    105,
  182         ReinitAdapHighCommandQueue =    107,
  183         ReinitAdapHighRespQueue =       108,
  184         ReinitAdapNormRespQueue =       109,
  185         InterfaceShutdown =             110,
  186         DmaCommandFib =                 120,
  187         StartProfile =                  121,
  188         TermProfile =                   122,
  189         SpeedTest =                     123,
  190         TakeABreakPt =                  124,
  191         RequestPerfData =               125,
  192         SetInterruptDefTimer=           126,
  193         SetInterruptDefCount=           127,
  194         GetInterruptDefStatus=          128,
  195         LastCommCommand =               129,
  197         /* filesystem commands */
  198         NuFileSystem =                  300,
  199         UFS =                           301,
  200         HostFileSystem =                302,
  201         LastFileSystemCommand =         303,
  203         /* Container Commands */
ContainerCommand =              500,
ContainerCommand64 =            501,
  207         /* Cluster Commands */
  208         ClusterCommand =                550,
  210         /* Scsi Port commands (scsi passthrough) */
  211         ScsiPortCommand =               600,
  213         /* misc house keeping and generic adapter initiated commands */
AifRequest =                    700,
  215         CheckRevision =                 701,
FsaHostShutdown =               702,
RequestAdapterInfo =            703,
  218         IsAdapterPaused =               704,
  219         SendHostTime =                  705,
  220         LastMiscCommand =               706
  221 } AAC_FibCommands;
  223 /*
  224  * FIB types
  225  */
  226 #define AAC_FIBTYPE_TFIB        1
  227 #define AAC_FIBTYPE_TQE         2
  228 #define AAC_FIBTYPE_TCTPERF     3
  230 /*
  231  * FIB transfer state
  232  */
  233 #define AAC_FIBSTATE_HOSTOWNED          (1<<0)  /* owned by the host */
  234 #define AAC_FIBSTATE_ADAPTEROWNED       (1<<1)  /* owned by the adapter */
  235 #define AAC_FIBSTATE_INITIALISED        (1<<2)  /* initialised */
  236 #define AAC_FIBSTATE_EMPTY              (1<<3)  /* empty */
  237 #define AAC_FIBSTATE_FROMPOOL           (1<<4)  /* allocated from pool */
  238 #define AAC_FIBSTATE_FROMHOST           (1<<5)  /* sent from the host */
  239 #define AAC_FIBSTATE_FROMADAP           (1<<6)  /* sent from the adapter */
  240 #define AAC_FIBSTATE_REXPECTED          (1<<7)  /* response is expected */
  241 #define AAC_FIBSTATE_RNOTEXPECTED       (1<<8)  /* response is not expected */
  242 #define AAC_FIBSTATE_DONEADAP           (1<<9)  /* processed by the adapter */
  243 #define AAC_FIBSTATE_DONEHOST           (1<<10) /* processed by the host */
  244 #define AAC_FIBSTATE_HIGH               (1<<11) /* high priority */
  245 #define AAC_FIBSTATE_NORM               (1<<12) /* normal priority */
  246 #define AAC_FIBSTATE_ASYNC              (1<<13)
  247 #define AAC_FIBSTATE_ASYNCIO            (1<<13) /* to be removed */
  248 #define AAC_FIBSTATE_PAGEFILEIO         (1<<14) /* to be removed */
  249 #define AAC_FIBSTATE_SHUTDOWN           (1<<15)
  250 #define AAC_FIBSTATE_LAZYWRITE          (1<<16) /* to be removed */
  251 #define AAC_FIBSTATE_ADAPMICROFIB       (1<<17)
  252 #define AAC_FIBSTATE_BIOSFIB            (1<<18)
  253 #define AAC_FIBSTATE_FAST_RESPONSE      (1<<19) /* fast response capable */
  254 #define AAC_FIBSTATE_APIFIB             (1<<20)
  256 /*
  257  * FIB error values
  258  */
  259 #define AAC_ERROR_NORMAL                        0x00
  260 #define AAC_ERROR_PENDING                       0x01
  261 #define AAC_ERROR_FATAL                         0x02
  262 #define AAC_ERROR_INVALID_QUEUE                 0x03
  263 #define AAC_ERROR_NOENTRIES                     0x04
  264 #define AAC_ERROR_SENDFAILED                    0x05
  265 #define AAC_ERROR_INVALID_QUEUE_PRIORITY        0x06
  266 #define AAC_ERROR_FIB_ALLOCATION_FAILED         0x07
  267 #define AAC_ERROR_FIB_DEALLOCATION_FAILED       0x08
  269 /*
  270  * Adapter Init Structure: this is passed to the adapter with the 
  271  * AAC_MONKER_INITSTRUCT command to point it at our control structures.
  272  */
  273 struct aac_adapter_init {
u_int32_t       InitStructRevision;
  275 #define AAC_INIT_STRUCT_REVISION                3
u_int32_t       MiniPortRevision;
  277 #define AAC_INIT_STRUCT_MINIPORT_REVISION       1
u_int32_t       FilesystemRevision;
u_int32_t       CommHeaderAddress;
u_int32_t       FastIoCommAreaAddress;
u_int32_t       AdapterFibsPhysicalAddress;
u_int32_t       AdapterFibsVirtualAddress;
u_int32_t       AdapterFibsSize;
u_int32_t       AdapterFibAlign;
u_int32_t       PrintfBufferAddress;
u_int32_t       PrintfBufferSize;
  287 #define AAC_PAGE_SIZE                           4096
u_int32_t       HostPhysMemPages;
u_int32_t       HostElapsedSeconds;
  290 } __attribute__ ((__packed__));
  292 /*
  293  * Shared data types
  294  */
  295 /*
  296  * Container types
  297  */
  298 typedef enum {
CT_NONE = 0,
CT_VOLUME,
CT_MIRROR,
CT_STRIPE,
CT_RAID5,
CT_SSRW,
CT_SSRO,
CT_MORPH,
CT_PASSTHRU,
CT_RAID4,
CT_RAID10,                  /* stripe of mirror */
CT_RAID00,                  /* stripe of stripe */
CT_VOLUME_OF_MIRRORS,       /* volume of mirror */
CT_PSEUDO_RAID3,            /* really raid4 */
  313         CT_RAID50,                  /* stripe of raid5 */
  314 } AAC_FSAVolType;
  316 /*
  317  * Host-addressable object types
  318  */
  319 typedef enum {
  320         FT_REG = 1,     /* regular file */
  321         FT_DIR,         /* directory */
  322         FT_BLK,         /* "block" device - reserved */
  323         FT_CHR,         /* "character special" device - reserved */
  324         FT_LNK,         /* symbolic link */
  325         FT_SOCK,        /* socket */
  326         FT_FIFO,        /* fifo */
FT_FILESYS,     /* ADAPTEC's "FSA"(tm) filesystem */
  328         FT_DRIVE,       /* physical disk - addressable in scsi by b/t/l */
  329         FT_SLICE,       /* virtual disk - raw volume - slice */
  330         FT_PARTITION,   /* FSA partition - carved out of a slice - building
  331                          * block for containers */
  332         FT_VOLUME,      /* Container - Volume Set */
  333         FT_STRIPE,      /* Container - Stripe Set */
  334         FT_MIRROR,      /* Container - Mirror Set */
  335         FT_RAID5,       /* Container - Raid 5 Set */
  336         FT_DATABASE     /* Storage object with "foreign" content manager */
  337 } AAC_FType;
  339 /*
  340  * Host-side scatter/gather list for 32-bit commands.
  341  */
  342 struct aac_sg_entry {
u_int32_t       SgAddress;
u_int32_t       SgByteCount;
  345 } __attribute__ ((__packed__));
  347 struct aac_sg_entry64 {
u_int64_t       SgAddress;
u_int32_t       SgByteCount;
  350 } __attribute__ ((__packed__));
  352 struct aac_sg_table {
u_int32_t               SgCount;
  354         struct aac_sg_entry     SgEntry[0];
  355 } __attribute__ ((__packed__));
  357 /*
  358  * Host-side scatter/gather list for 64-bit commands.
  359  */
  360 struct aac_sg_table64 {
u_int32_t       SgCount;
  362         struct aac_sg_entry64   SgEntry64[0];
  363 } __attribute__ ((__packed__));
  365 /*
  366  * Container creation data
  367  */
  368 struct aac_container_creation {
u_int8_t        ViaBuildNumber;
u_int8_t        MicroSecond;
u_int8_t        Via;            /* 1 = FSU, 2 = API, etc. */
u_int8_t        YearsSince1900;
u_int32_t       Month:4;        /* 1-12 */
u_int32_t       Day:6;          /* 1-32 */
u_int32_t       Hour:6;         /* 0-23 */
u_int32_t       Minute:6;       /* 0-59 */
u_int32_t       Second:6;       /* 0-59 */
u_int64_t       ViaAdapterSerialNumber;
  379 } __attribute__ ((__packed__));
  381 /*
  382  * Revision number handling
  383  */
  385 typedef enum {
  386         RevApplication = 1,
  387         RevDkiCli,
  388         RevNetService,
  389         RevApi,
  390         RevFileSysDriver,
  391         RevMiniportDriver,
  392         RevAdapterSW,
  393         RevMonitor,
  394         RevRemoteApi
  395 } RevComponent;
  397 struct FsaRevision {
  398         union {
  399                 struct {
u_int8_t        dash;
u_int8_t        type;
u_int8_t        minor;
u_int8_t        major;
  404                 } comp;
u_int32_t       ul;
  406         } external;
u_int32_t       buildNumber;
  408 }  __attribute__ ((__packed__));
  410 /*
  411  * Adapter Information
  412  */
  414 typedef enum {
  415         CPU_NTSIM = 1,
  416         CPU_I960,
  417         CPU_ARM,
  418         CPU_SPARC,
  419         CPU_POWERPC,
  420         CPU_ALPHA,
  421         CPU_P7,
  422         CPU_I960_RX,
  423         CPU__last
  424 } AAC_CpuType;  
  426 typedef enum {
CPUI960_JX = 1,
CPUI960_CX,
CPUI960_HX,
CPUI960_RX,
CPUARM_SA110,
CPUARM_xxx,
CPUMPC_824x,
CPUPPC_xxx,
CPUI960_302,
  436         CPUSUBTYPE__last
  437 } AAC_CpuSubType;
  439 typedef enum {
  440         PLAT_NTSIM = 1,
  441         PLAT_V3ADU,
  442         PLAT_CYCLONE,
  443         PLAT_CYCLONE_HD,
  444         PLAT_BATBOARD,
  445         PLAT_BATBOARD_HD,
  446         PLAT_YOLO,
  447         PLAT_COBRA,
  448         PLAT_ANAHEIM,
  449         PLAT_JALAPENO,
  450         PLAT_QUEENS,
  451         PLAT_JALAPENO_DELL,
  452         PLAT_POBLANO,
  453         PLAT_POBLANO_OPAL,
  454         PLAT_POBLANO_SL0,
  455         PLAT_POBLANO_SL1,
  456         PLAT_POBLANO_SL2,
  457         PLAT_POBLANO_XXX,
  458         PLAT_JALAPENO_P2,
  459         PLAT_HABANERO,
  460         PLAT__last
  461 } AAC_Platform;
  463 typedef enum {
  464         OEM_FLAVOR_ADAPTEC = 1,
  465         OEM_FLAVOR_DELL,
  466         OEM_FLAVOR_HP,
  467         OEM_FLAVOR_IBM,
  468         OEM_FLAVOR_CPQ,
  469         OEM_FLAVOR_BRAND_X,
  470         OEM_FLAVOR_BRAND_Y,
  471         OEM_FLAVOR_BRAND_Z,
  472         OEM_FLAVOR__last
  473 } AAC_OemFlavor;
  475 /*
  476  * XXX the aac-2622 with no battery present reports PLATFORM_BAT_OPT_PRESENT
  477  */
  478 typedef enum
  479 { 
PLATFORM_BAT_REQ_PRESENT = 1,   /* BATTERY REQUIRED AND PRESENT */
PLATFORM_BAT_REQ_NOTPRESENT,    /* BATTERY REQUIRED AND NOT PRESENT */
PLATFORM_BAT_OPT_PRESENT,       /* BATTERY OPTIONAL AND PRESENT */
PLATFORM_BAT_OPT_NOTPRESENT,    /* BATTERY OPTIONAL AND NOT PRESENT */
PLATFORM_BAT_NOT_SUPPORTED      /* BATTERY NOT SUPPORTED */
  485 } AAC_BatteryPlatform;
  487 /* 
  488  * options supported by this board
  489  * there has to be a one to one mapping of these defines and the ones in 
  490  * fsaapi.h, search for FSA_SUPPORT_SNAPSHOT
  491  */
  492 #define AAC_SUPPORTED_SNAPSHOT          0x01
  493 #define AAC_SUPPORTED_CLUSTERS          0x02
  494 #define AAC_SUPPORTED_WRITE_CACHE       0x04
  495 #define AAC_SUPPORTED_64BIT_DATA        0x08
  496 #define AAC_SUPPORTED_HOST_TIME_FIB     0x10
  497 #define AAC_SUPPORTED_RAID50            0x20
  498 #define AAC_SUPPORTED_4GB_WINDOW        0x40
  499 #define AAC_SUPPORTED_SCSI_UPGRADEABLE  0x80
  500 #define AAC_SUPPORTED_SOFT_ERR_REPORT   0x100
  501 #define AAC_SUPPORTED_NOT_RECONDITION   0x200
  502 #define AAC_SUPPORTED_SGMAP_HOST64      0x400
  503 #define AAC_SUPPORTED_ALARM             0x800
  504 #define AAC_SUPPORTED_NONDASD           0x1000
  506 /* 
  507  * Structure used to respond to a RequestAdapterInfo fib.
  508  */
  509 struct aac_adapter_info {
AAC_Platform            PlatformBase;    /* adapter type */
AAC_CpuType             CpuArchitecture; /* adapter CPU type */
AAC_CpuSubType          CpuVariant;      /* adapter CPU subtype */
u_int32_t               ClockSpeed;      /* adapter CPU clockspeed */
u_int32_t               ExecutionMem;    /* adapter Execution Memory
  515                                                   * size */
u_int32_t               BufferMem;       /* adapter Data Memory */
u_int32_t               TotalMem;        /* adapter Total Memory */
  518         struct FsaRevision      KernelRevision;  /* adapter Kernel Software
  519                                                   * Revision */
  520         struct FsaRevision      MonitorRevision; /* adapter Monitor/Diagnostic
  521                                                   * Software Revision */
  522         struct FsaRevision      HardwareRevision;/* TBD */
  523         struct FsaRevision      BIOSRevision;    /* adapter BIOS Revision */
u_int32_t               ClusteringEnabled;
u_int32_t               ClusterChannelMask;
u_int64_t               SerialNumber;
AAC_BatteryPlatform     batteryPlatform;
u_int32_t               SupportedOptions; /* supported features of this
  529                                                    * controller */
AAC_OemFlavor   OemVariant;
  531 } __attribute__ ((__packed__));
  533 /*
  534  * Monitor/Kernel interface.
  535  */
  537 /*
  538  * Synchronous commands to the monitor/kernel.
  539  */
  540 #define AAC_MONKER_INITSTRUCT   0x05
  541 #define AAC_MONKER_SYNCFIB      0x0c
  542 #define AAC_MONKER_GETKERNVER   0x11
  543 #define AAC_MONKER_GETINFO      0x19
  545 /*
  546  *  Adapter Status Register
  547  *
  548  *  Phase Staus mailbox is 32bits:
  549  *  <31:16> = Phase Status
  550  *  <15:0>  = Phase
  551  *
  552  *  The adapter reports its present state through the phase.  Only
  553  *  a single phase should be ever be set.  Each phase can have multiple
  554  *  phase status bits to provide more detailed information about the
  555  *  state of the adapter.
  556  */
  557 #define AAC_SELF_TEST_FAILED    0x00000004
  558 #define AAC_UP_AND_RUNNING      0x00000080
  559 #define AAC_KERNEL_PANIC        0x00000100
  561 /*
  562  * Data types relating to control and monitoring of the NVRAM/WriteCache 
  563  * subsystem.
  564  */
  566 #define AAC_NFILESYS    24      /* maximum number of filesystems */
  568 /*
  569  * NVRAM/Write Cache subsystem states
  570  */
  571 typedef enum {
  572         NVSTATUS_DISABLED = 0,  /* present, clean, not being used */
  573         NVSTATUS_ENABLED,       /* present, possibly dirty, ready for use */
  574         NVSTATUS_ERROR,         /* present, dirty, contains dirty data */
  575         NVSTATUS_BATTERY,       /* present, bad or low battery, may contain
  576                                  * dirty data */
  577         NVSTATUS_UNKNOWN        /* for bad/missing device */
  578 } AAC_NVSTATUS;
  580 /*
  581  * NVRAM/Write Cache subsystem battery component states
  582  *
  583  */
  584 typedef enum {
  585         NVBATTSTATUS_NONE = 0,  /* battery has no power or is not present */
  586         NVBATTSTATUS_LOW,       /* battery is low on power */
  587         NVBATTSTATUS_OK,        /* battery is okay - normal operation possible
  588                                  * only in this state */
  589         NVBATTSTATUS_RECONDITIONING     /* no battery present - reconditioning
  590                                          * in process */
  591 } AAC_NVBATTSTATUS;
  593 /*
  594  * Battery transition type
  595  */
  596 typedef enum {
  597         NVBATT_TRANSITION_NONE = 0,     /* battery now has no power or is not
  598                                          * present */
  599         NVBATT_TRANSITION_LOW,          /* battery is now low on power */
  600         NVBATT_TRANSITION_OK            /* battery is now okay - normal
  601                                          * operation possible only in this
  602                                          * state */
  603 } AAC_NVBATT_TRANSITION;
  605 /*
  606  * NVRAM Info structure returned for NVRAM_GetInfo call
  607  */
  608 struct aac_nvramdevinfo {
u_int32_t       NV_Enabled;     /* write caching enabled */
u_int32_t       NV_Error;       /* device in error state */
u_int32_t       NV_NDirty;      /* count of dirty NVRAM buffers */
u_int32_t       NV_NActive;     /* count of NVRAM buffers being
  613                                          * written */
  614 } __attribute__ ((__packed__));
  616 struct aac_nvraminfo {
AAC_NVSTATUS            NV_Status;      /* nvram subsystem status */
AAC_NVBATTSTATUS        NV_BattStatus;  /* battery status */
u_int32_t               NV_Size;        /* size of WriteCache NVRAM in
  620                                                  * bytes */
u_int32_t               NV_BufSize;     /* size of NVRAM buffers in
  622                                                  * bytes */
u_int32_t               NV_NBufs;       /* number of NVRAM buffers */
u_int32_t               NV_NDirty;      /* Num dirty NVRAM buffers */
u_int32_t               NV_NClean;      /* Num clean NVRAM buffers */
u_int32_t               NV_NActive;     /* Num NVRAM buffers being
  627                                                  * written */
u_int32_t               NV_NBrokered;   /* Num brokered NVRAM buffers */
  629         struct aac_nvramdevinfo NV_DevInfo[AAC_NFILESYS];       /* per device
  630                                                                  * info */
u_int32_t               NV_BattNeedsReconditioning;     /* boolean */
u_int32_t               NV_TotalSize;   /* size of all non-volatile
  633                                                  * memories in bytes */
  634 } __attribute__ ((__packed__));
  636 /*
  637  * Data types relating to adapter-initiated FIBs
  638  *
  639  * Based on types and structures in <aifstruc.h>
  640  */
  642 /*
  643  * Progress Reports
  644  */
  645 typedef enum {
AifJobStsSuccess = 1,
AifJobStsFinished,
AifJobStsAborted,
AifJobStsFailed,
  650         AifJobStsLastReportMarker = 100,        /* All prior mean last report */
AifJobStsSuspended,
AifJobStsRunning
  653 } AAC_AifJobStatus;
  655 typedef enum {
  656         AifJobScsiMin = 1,              /* Minimum value for Scsi operation */
AifJobScsiZero,                 /* SCSI device clear operation */
AifJobScsiVerify,               /* SCSI device Verify operation NO
  659                                          * REPAIR */
AifJobScsiExercise,             /* SCSI device Exercise operation */
AifJobScsiVerifyRepair,         /* SCSI device Verify operation WITH
  662                                          * repair */
  663         AifJobScsiMax = 99,             /* Max Scsi value */
  664         AifJobCtrMin,                   /* Min Ctr op value */
AifJobCtrZero,                  /* Container clear operation */
AifJobCtrCopy,                  /* Container copy operation */
AifJobCtrCreateMirror,          /* Container Create Mirror operation */
AifJobCtrMergeMirror,           /* Container Merge Mirror operation */
AifJobCtrScrubMirror,           /* Container Scrub Mirror operation */
AifJobCtrRebuildRaid5,          /* Container Rebuild Raid5 operation */
AifJobCtrScrubRaid5,            /* Container Scrub Raid5 operation */
AifJobCtrMorph,                 /* Container morph operation */
AifJobCtrPartCopy,              /* Container Partition copy operation */
AifJobCtrRebuildMirror,         /* Container Rebuild Mirror operation */
AifJobCtrCrazyCache,            /* crazy cache */
  676         AifJobCtrMax = 199,             /* Max Ctr type operation */
  677         AifJobFsMin,                    /* Min Fs type operation */
AifJobFsCreate,                 /* File System Create operation */
AifJobFsVerify,                 /* File System Verify operation */
AifJobFsExtend,                 /* File System Extend operation */
  681         AifJobFsMax = 299,              /* Max Fs type operation */
AifJobApiFormatNTFS,            /* Format a drive to NTFS */
AifJobApiFormatFAT,             /* Format a drive to FAT */
AifJobApiUpdateSnapshot,        /* update the read/write half of a
  685                                          * snapshot */
AifJobApiFormatFAT32,           /* Format a drive to FAT32 */
  687         AifJobApiMax = 399,             /* Max API type operation */
AifJobCtlContinuousCtrVerify,   /* Adapter operation */
  689         AifJobCtlMax = 499              /* Max Adapter type operation */
  690 } AAC_AifJobType;
  692 struct aac_AifContainers {
u_int32_t       src;            /* from/master */
u_int32_t       dst;            /* to/slave */
  695 } __attribute__ ((__packed__));
  697 union aac_AifJobClient {
  698         struct aac_AifContainers        container;      /* For Container and
  699                                                          * filesystem progress
  700                                                          * ops; */
int32_t                         scsi_dh;        /* For SCSI progress
  702                                                          * ops */
  703 };
  705 struct aac_AifJobDesc {
u_int32_t               jobID;          /* DO NOT FILL IN! Will be
  707                                                  * filled in by AIF */
AAC_AifJobType          type;           /* Operation that is being
  709                                                  * performed */
  710         union aac_AifJobClient  client;         /* Details */
  711 } __attribute__ ((__packed__));
  713 struct aac_AifJobProgressReport {
  714         struct aac_AifJobDesc   jd;
AAC_AifJobStatus        status;
u_int32_t               finalTick;
u_int32_t               currentTick;
u_int32_t               jobSpecificData1;
u_int32_t               jobSpecificData2;
  720 } __attribute__ ((__packed__));
  722 /*
  723  * Event Notification
  724  */
  725 typedef enum {
  726         /* General application notifies start here */
AifEnGeneric = 1,               /* Generic notification */
AifEnTaskComplete,              /* Task has completed */
AifEnConfigChange,              /* Adapter config change occurred */
AifEnContainerChange,           /* Adapter specific container 
  731                                          * configuration change */
AifEnDeviceFailure,             /* SCSI device failed */
AifEnMirrorFailover,            /* Mirror failover started */
AifEnContainerEvent,            /* Significant container event */
AifEnFileSystemChange,          /* File system changed */
AifEnConfigPause,               /* Container pause event */
AifEnConfigResume,              /* Container resume event */
AifEnFailoverChange,            /* Failover space assignment changed */
AifEnRAID5RebuildDone,          /* RAID5 rebuild finished */
AifEnEnclosureManagement,       /* Enclosure management event */
AifEnBatteryEvent,              /* Significant NV battery event */
AifEnAddContainer,              /* A new container was created. */
AifEnDeleteContainer,           /* A container was deleted. */
  744         AifEnSMARTEvent,                /* SMART Event */
AifEnBatteryNeedsRecond,        /* The battery needs reconditioning */
AifEnClusterEvent,              /* Some cluster event */
AifEnDiskSetEvent,              /* A disk set event occured. */
  748         AifDriverNotifyStart=199,       /* Notifies for host driver go here */
  749         /* Host driver notifications start here */
AifDenMorphComplete,            /* A morph operation completed */
AifDenVolumeExtendComplete      /* Volume expand operation completed */
  752 } AAC_AifEventNotifyType;
  754 struct aac_AifEnsGeneric {
  755         char    text[132];              /* Generic text */
  756 } __attribute__ ((__packed__));
  758 struct aac_AifEnsDeviceFailure {
u_int32_t       deviceHandle;   /* SCSI device handle */
  760 } __attribute__ ((__packed__));
  762 struct aac_AifEnsMirrorFailover {
u_int32_t       container;      /* Container with failed element */
u_int32_t       failedSlice;    /* Old slice which failed */
u_int32_t       creatingSlice;  /* New slice used for auto-create */
  766 } __attribute__ ((__packed__));
  768 struct aac_AifEnsContainerChange {
u_int32_t       container[2];   /* container that changed, -1 if no
  770                                          * container */
  771 } __attribute__ ((__packed__));
  773 struct aac_AifEnsContainerEvent {
u_int32_t       container;      /* container number  */
u_int32_t       eventType;      /* event type */
  776 } __attribute__ ((__packed__));
  778 struct aac_AifEnsEnclosureEvent {
u_int32_t       empID;          /* enclosure management proc number  */
u_int32_t       unitID;         /* unitId, fan id, power supply id,
  781                                          * slot id, tempsensor id.  */
u_int32_t       eventType;      /* event type */
  783 } __attribute__ ((__packed__));
  785 struct aac_AifEnsBatteryEvent {
AAC_NVBATT_TRANSITION   transition_type;        /* eg from low to ok */
AAC_NVBATTSTATUS        current_state;          /* current batt state */
AAC_NVBATTSTATUS        prior_state;            /* prev batt state */
  789 } __attribute__ ((__packed__));
  791 struct aac_AifEnsDiskSetEvent {
u_int32_t       eventType;
u_int64_t       DsNum;
u_int64_t       CreatorId;
  795 } __attribute__ ((__packed__));
  797 typedef enum {
  798         CLUSTER_NULL_EVENT = 0,
  799         CLUSTER_PARTNER_NAME_EVENT,     /* change in partner hostname or
  800                                          * adaptername from NULL to non-NULL */
  801         /* (partner's agent may be up) */
  802         CLUSTER_PARTNER_NULL_NAME_EVENT /* change in partner hostname or
  803                                          * adaptername from non-null to NULL */
  804         /* (partner has rebooted) */
  805 } AAC_ClusterAifEvent;
  807 struct aac_AifEnsClusterEvent {
AAC_ClusterAifEvent     eventType;
  809 } __attribute__ ((__packed__));
  811 struct aac_AifEventNotify {
AAC_AifEventNotifyType  type;
  813         union {
  814                 struct aac_AifEnsGeneric                EG;
  815                 struct aac_AifEnsDeviceFailure          EDF;
  816                 struct aac_AifEnsMirrorFailover         EMF;
  817                 struct aac_AifEnsContainerChange        ECC;
  818                 struct aac_AifEnsContainerEvent         ECE;
  819                 struct aac_AifEnsEnclosureEvent         EEE;
  820                 struct aac_AifEnsBatteryEvent           EBE;
  821                 struct aac_AifEnsDiskSetEvent           EDS;
  822 /*              struct aac_AifEnsSMARTEvent             ES;*/
  823                 struct aac_AifEnsClusterEvent           ECLE;
  824         } data;
  825 } __attribute__ ((__packed__));
  827 /*
  828  * Adapter Initiated FIB command structures. Start with the adapter
  829  * initiated FIBs that really come from the adapter, and get responded
  830  * to by the host. 
  831  */
  832 #define AAC_AIF_REPORT_MAX_SIZE 64
  834 typedef enum {
AifCmdEventNotify = 1,  /* Notify of event */
AifCmdJobProgress,      /* Progress report */
AifCmdAPIReport,        /* Report from other user of API */
AifCmdDriverNotify,     /* Notify host driver of event */
  839         AifReqJobList = 100,    /* Gets back complete job list */
  840         AifReqJobsForCtr,       /* Gets back jobs for specific container */
  841         AifReqJobsForScsi,      /* Gets back jobs for specific SCSI device */
  842         AifReqJobReport,        /* Gets back a specific job report or list */
  843         AifReqTerminateJob,     /* Terminates job */
  844         AifReqSuspendJob,       /* Suspends a job */
  845         AifReqResumeJob,        /* Resumes a job */
  846         AifReqSendAPIReport,    /* API generic report requests */
  847         AifReqAPIJobStart,      /* Start a job from the API */
  848         AifReqAPIJobUpdate,     /* Update a job report from the API */
  849         AifReqAPIJobFinish      /* Finish a job from the API */
  850 } AAC_AifCommand;
  852 struct aac_aif_command {
AAC_AifCommand  command;        /* Tell host what type of
  854                                          * notify this is */
u_int32_t       seqNumber;      /* To allow ordering of
  856                                          * reports (if necessary) */
  857         union {
  858                 struct aac_AifEventNotify       EN;     /* Event notify */
  859                 struct aac_AifJobProgressReport PR[1];  /* Progress report */
u_int8_t                        AR[AAC_AIF_REPORT_MAX_SIZE];
u_int8_t                        data[AAC_FIB_DATASIZE - 8];
  862         } data;
  863 } __attribute__ ((__packed__));
  865 /*
  866  * Filesystem commands/data
  867  *
  868  * The adapter has a very complex filesystem interface, most of which we ignore.
  869  * (And which seems not to be implemented, anyway.)
  870  */
  872 /*
  873  * FSA commands
  874  * (not used?)
  875  */
  876 typedef enum {
  877         Null = 0,
  878         GetAttributes,
  879         SetAttributes,
  880         Lookup,
  881         ReadLink,
  882         Read,
  883         Write,
Create,
  885         MakeDirectory,
  886         SymbolicLink,
  887         MakeNode,
  888         Removex,
  889         RemoveDirectory,
  890         Rename,
  891         Link,
  892         ReadDirectory,
  893         ReadDirectoryPlus,
  894         FileSystemStatus,
  895         FileSystemInfo,
  896         PathConfigure,
  897         Commit,
  898         Mount,
  899         UnMount,
  900         Newfs,
  901         FsCheck,
  902         FsSync,
  903         SimReadWrite,
  904         SetFileSystemStatus,
  905         BlockRead,
  906         BlockWrite,
  907         NvramIoctl,
  908         FsSyncWait,
  909         ClearArchiveBit,
  910         SetAcl,
  911         GetAcl,
  912         AssignAcl,
  913         FaultInsertion,
  914         CrazyCache
  915 } AAC_FSACommand;
  917 /*
  918  * Command status values
  919  */
  920 typedef enum {
ST_OK = 0,
  922         ST_PERM = 1,
  923         ST_NOENT = 2,
  924         ST_IO = 5,
  925         ST_NXIO = 6,
  926         ST_E2BIG = 7,
  927         ST_ACCES = 13,
  928         ST_EXIST = 17,
  929         ST_XDEV = 18,
  930         ST_NODEV = 19,
  931         ST_NOTDIR = 20,
  932         ST_ISDIR = 21,
  933         ST_INVAL = 22,
  934         ST_FBIG = 27,
  935         ST_NOSPC = 28,
  936         ST_ROFS = 30,
  937         ST_MLINK = 31,
  938         ST_WOULDBLOCK = 35,
  939         ST_NAMETOOLONG = 63,
  940         ST_NOTEMPTY = 66,
  941         ST_DQUOT = 69,
  942         ST_STALE = 70,
  943         ST_REMOTE = 71,
  944         ST_BADHANDLE = 10001,
  945         ST_NOT_SYNC = 10002,
  946         ST_BAD_COOKIE = 10003,
  947         ST_NOTSUPP = 10004,
  948         ST_TOOSMALL = 10005,
  949         ST_SERVERFAULT = 10006,
  950         ST_BADTYPE = 10007,
  951         ST_JUKEBOX = 10008,
  952         ST_NOTMOUNTED = 10009,
  953         ST_MAINTMODE = 10010,
  954         ST_STALEACL = 10011
  955 } AAC_FSAStatus;
  957 /*
  958  * Volume manager commands
  959  */
  960 typedef enum _VM_COMMANDS {
  961         VM_Null = 0,
VM_NameServe,
  963         VM_ContainerConfig,
  964         VM_Ioctl,
  965         VM_FilesystemIoctl,
VM_CloseAll,
VM_CtBlockRead,
VM_CtBlockWrite,
  969         VM_SliceBlockRead,       /* raw access to configured storage objects */
  970         VM_SliceBlockWrite,
  971         VM_DriveBlockRead,       /* raw access to physical devices */
  972         VM_DriveBlockWrite,
  973         VM_EnclosureMgt,         /* enclosure management */
  974         VM_Unused,               /* used to be diskset management */
  975         VM_CtBlockVerify,
  976         VM_CtPerf,               /* performance test */
  977         VM_CtBlockRead64,
  978         VM_CtBlockWrite64,
  979         VM_CtBlockVerify64,
VM_CtHostRead64,
VM_CtHostWrite64,
  982 } AAC_VMCommand;
  984 /*
  985  * "mountable object"
  986  */
  987 struct aac_mntobj {
u_int32_t                       ObjectId;
  989         char                            FileSystemName[16];
  990         struct aac_container_creation   CreateInfo;
u_int32_t                       Capacity;
u_int32_t                       VolType;
u_int32_t                       ObjType;
u_int32_t                       ContentState;
  995 #define FSCS_READONLY           0x0002          /* XXX need more information
  996                                                  * than this */
  997         union {
u_int32_t       pad[8];
  999         } ObjExtension;
u_int32_t                       AlterEgoId;
 1001 } __attribute__ ((__packed__));
 1003 struct aac_mntinfo {
u_int32_t               Command;
u_int32_t               MntType;
u_int32_t               MntCount;
 1007 } __attribute__ ((__packed__));
 1009 struct aac_mntinforesp {
u_int32_t               Status;
u_int32_t               MntType;
u_int32_t               MntRespCount;
 1013         struct aac_mntobj       MntTable[1];
 1014 } __attribute__ ((__packed__));
 1016 /*
 1017  * Container shutdown command.
 1018  */
 1019 struct aac_closecommand {
u_int32_t       Command;
u_int32_t       ContainerId;
 1022 } __attribute__ ((__packed__));
 1024 /*
 1025  * Container Config Command
 1026  */
 1027 #define CT_GET_SCSI_METHOD      64
 1028 struct aac_ctcfg {
u_int32_t               Command;
u_int32_t               cmd;
u_int32_t               param;
 1032 } __attribute__ ((__packed__));
 1034 struct aac_ctcfg_resp {
u_int32_t               Status;
u_int32_t               resp;
u_int32_t               param;
 1038 } __attribute__ ((__packed__));
 1040 /*
 1041  * 'Ioctl' commads
 1042  */
 1043 #define AAC_SCSI_MAX_PORTS      10
 1044 #define AAC_BUS_NO_EXIST        0
 1045 #define AAC_BUS_VALID           1
 1046 #define AAC_BUS_FAULTED         2
 1047 #define AAC_BUS_DISABLED        3
 1048 #define GetBusInfo              0x9
 1050 struct aac_getbusinf {
u_int32_t               ProbeComplete;
u_int32_t               BusCount;
u_int32_t               TargetsPerBus;
u_int8_t                InitiatorBusId[AAC_SCSI_MAX_PORTS];
u_int8_t                BusValid[AAC_SCSI_MAX_PORTS];
 1056 } __attribute__ ((__packed__));
 1058 struct aac_vmioctl {
u_int32_t               Command;
u_int32_t               ObjType;
u_int32_t               MethId;
u_int32_t               ObjId;
u_int32_t               IoctlCmd;
u_int32_t               IoctlBuf[1];    /* Placeholder? */
 1065 } __attribute__ ((__packed__));
 1067 struct aac_vmi_businf_resp {
u_int32_t               Status;
u_int32_t               ObjType;
u_int32_t               MethId;
u_int32_t               ObjId;
u_int32_t               IoctlCmd;
 1073         struct aac_getbusinf    BusInf;
 1074 } __attribute__ ((__packed__));
 1076 #define AAC_BTL_TO_HANDLE(b, t, l) \
 1077     (((b & 0x3f) << 7) | ((l & 0x7) << 4) | (t & 0xf))
 1078 #define GetDeviceProbeInfo 0x5
 1080 struct aac_vmi_devinfo_resp {
u_int32_t               Status;
u_int32_t               ObjType;
u_int32_t               MethId;
u_int32_t               ObjId;
u_int32_t               IoctlCmd;
u_int8_t                VendorId[8];
u_int8_t                ProductId[16];
u_int8_t                ProductRev[4];
u_int32_t               Inquiry7;
u_int32_t               align1;
u_int32_t               Inquiry0;
u_int32_t               align2;
u_int32_t               Inquiry1;
u_int32_t               align3;
u_int32_t               reserved[2];
u_int8_t                VendorSpecific[20];
u_int32_t               Smart:1;
u_int32_t               AAC_Managed:1;
u_int32_t               align4;
u_int32_t               reserved2:6;
u_int32_t               Bus;
u_int32_t               Target;
u_int32_t               Lun;
u_int32_t               ultraEnable:1,
disconnectEnable:1,
fast20EnabledW:1,
scamDevice:1,
scamTolerant:1,
setForSync:1,
setForWide:1,
syncDevice:1,
wideDevice:1,
reserved1:7,
ScsiRate:8,
ScsiOffset:8;
 1116 }; /* Do not pack */
 1118 #define ResetBus 0x16
 1119 struct aac_resetbus {
u_int32_t               BusNumber;
 1121 };
 1123 /*
 1124  * Write 'stability' options.
 1125  */
 1126 typedef enum {
CSTABLE = 1,
CUNSTABLE
 1129 } AAC_CacheLevel;
 1131 /*
 1132  * Commit level response for a write request.
 1133  */
 1134 typedef enum {
 1135         CMFILE_SYNC_NVRAM = 1,
 1136         CMDATA_SYNC_NVRAM,
 1137         CMFILE_SYNC,
 1138         CMDATA_SYNC,
 1139         CMUNSTABLE
 1140 } AAC_CommitLevel;
 1142 /*
 1143  * Block read/write operations.
 1144  * These structures are packed into the 'data' area in the FIB.
 1145  */
 1147 struct aac_blockread {
u_int32_t               Command;        /* not FSACommand! */
u_int32_t               ContainerId;
u_int32_t               BlockNumber;
u_int32_t               ByteCount;
 1152         struct aac_sg_table     SgMap;          /* variable size */
 1153 } __attribute__ ((__packed__));
 1155 struct aac_blockread64 {
u_int32_t               Command;
u_int16_t               ContainerId;
u_int16_t               SectorCount;
u_int32_t               BlockNumber;
u_int16_t               Pad;
u_int16_t               Flags;
 1162         struct aac_sg_table64   SgMap64;
 1163 } __attribute__ ((__packed__));
 1165 struct aac_blockread_response {
u_int32_t               Status;
u_int32_t               ByteCount;
 1168 } __attribute__ ((__packed__));
 1170 struct aac_blockwrite {
u_int32_t               Command;        /* not FSACommand! */
u_int32_t               ContainerId;
u_int32_t               BlockNumber;
u_int32_t               ByteCount;
u_int32_t               Stable;
 1176         struct aac_sg_table     SgMap;          /* variable size */
 1177 } __attribute__ ((__packed__));
 1179 struct aac_blockwrite64 {
u_int32_t               Command;        /* not FSACommand! */
u_int16_t               ContainerId;
u_int16_t               SectorCount;
u_int32_t               BlockNumber;
u_int16_t               Pad;
u_int16_t               Flags;
 1186         struct aac_sg_table64   SgMap64;        /* variable size */
 1187 } __attribute__ ((__packed__));
 1189 struct aac_blockwrite_response {
u_int32_t               Status;
u_int32_t               ByteCount;
u_int32_t               Committed;
 1193 } __attribute__ ((__packed__));
 1195 /*
 1196  * Container shutdown command.
 1197  */
 1198 struct aac_close_command {
u_int32_t               Command;
u_int32_t               ContainerId;
 1201 };
 1203 /*
 1204  * SCSI Passthrough structures
 1205  */
 1206 struct aac_srb32 {
u_int32_t               function;
u_int32_t               bus;
u_int32_t               target;
u_int32_t               lun;
u_int32_t               timeout;
u_int32_t               flags;
u_int32_t               data_len;
u_int32_t               retry_limit;
u_int32_t               cdb_len;
u_int8_t                cdb[16];
 1217         struct aac_sg_table     sg_map32;
 1218 };
 1220 enum {
AAC_SRB_FUNC_EXECUTE_SCSI       = 0x00,
AAC_SRB_FUNC_CLAIM_DEVICE,
AAC_SRB_FUNC_IO_CONTROL,
AAC_SRB_FUNC_RECEIVE_EVENT,
AAC_SRB_FUNC_RELEASE_QUEUE,
AAC_SRB_FUNC_ATTACH_DEVICE,
AAC_SRB_FUNC_RELEASE_DEVICE,
AAC_SRB_FUNC_SHUTDOWN,
AAC_SRB_FUNC_FLUSH,
AAC_SRB_FUNC_ABORT_COMMAND      = 0x10,
AAC_SRB_FUNC_RELEASE_RECOVERY,
AAC_SRB_FUNC_RESET_BUS,
AAC_SRB_FUNC_RESET_DEVICE,
AAC_SRB_FUNC_TERMINATE_IO,
AAC_SRB_FUNC_FLUSH_QUEUE,
AAC_SRB_FUNC_REMOVE_DEVICE,
AAC_SRB_FUNC_DOMAIN_VALIDATION
 1238 };
 1240 #define AAC_SRB_FLAGS_NO_DATA_XFER              0x0000
 1241 #define AAC_SRB_FLAGS_DISABLE_DISCONNECT        0x0004
 1242 #define AAC_SRB_FLAGS_DISABLE_SYNC_TRANSFER     0x0008
 1243 #define AAC_SRB_FLAGS_BYPASS_FROZEN_QUEUE       0x0010
 1244 #define AAC_SRB_FLAGS_DISABLE_AUTOSENSE         0x0020
 1245 #define AAC_SRB_FLAGS_DATA_IN                   0x0040
 1246 #define AAC_SRB_FLAGS_DATA_OUT                  0x0080
 1247 #define AAC_SRB_FLAGS_UNSPECIFIED_DIRECTION \
 1248                         (AAC_SRB_FLAGS_DATA_IN | AAC_SRB_FLAGS_DATA_OUT)
 1250 #define AAC_HOST_SENSE_DATA_MAX                 30
 1252 struct aac_srb_response {
u_int32_t       fib_status;
u_int32_t       srb_status;
u_int32_t       scsi_status;
u_int32_t       data_len;
u_int32_t       sense_len;
u_int8_t        sense[AAC_HOST_SENSE_DATA_MAX];
 1259 };
 1261 enum {
AAC_SRB_STS_PENDING                     = 0x00,
AAC_SRB_STS_SUCCESS,
AAC_SRB_STS_ABORTED,
AAC_SRB_STS_ABORT_FAILED,
AAC_SRB_STS_ERROR,
AAC_SRB_STS_BUSY,
AAC_SRB_STS_INVALID_REQUEST,
AAC_SRB_STS_INVALID_PATH_ID,
AAC_SRB_STS_NO_DEVICE,
AAC_SRB_STS_TIMEOUT,
AAC_SRB_STS_SELECTION_TIMEOUT,
AAC_SRB_STS_COMMAND_TIMEOUT,
AAC_SRB_STS_MESSAGE_REJECTED            = 0x0D,
AAC_SRB_STS_BUS_RESET,
AAC_SRB_STS_PARITY_ERROR,
AAC_SRB_STS_REQUEST_SENSE_FAILED,
AAC_SRB_STS_NO_HBA,
AAC_SRB_STS_DATA_OVERRUN,
AAC_SRB_STS_UNEXPECTED_BUS_FREE,
AAC_SRB_STS_PHASE_SEQUENCE_FAILURE,
AAC_SRB_STS_BAD_SRB_BLOCK_LENGTH,
AAC_SRB_STS_REQUEST_FLUSHED,
AAC_SRB_STS_INVALID_LUN                 = 0x20,
AAC_SRB_STS_INVALID_TARGET_ID,
AAC_SRB_STS_BAD_FUNCTION,
AAC_SRB_STS_ERROR_RECOVERY
 1288 };
 1290 /*
 1291  * Register set for adapters based on the Falcon bridge and PPC core
 1292  */
 1294 #define AAC_FA_DOORBELL0_CLEAR          0x00
 1295 #define AAC_FA_DOORBELL1_CLEAR          0x02
 1296 #define AAC_FA_DOORBELL0                0x04
 1297 #define AAC_FA_DOORBELL1                0x06
 1298 #define AAC_FA_MASK0_CLEAR              0x08
 1299 #define AAC_FA_MASK1_CLEAR              0x0a
 1300 #define AAC_FA_MASK0                    0x0c
 1301 #define AAC_FA_MASK1                    0x0e
 1302 #define AAC_FA_MAILBOX                  0x10
 1303 #define AAC_FA_FWSTATUS                 0x2c    /* Mailbox 7 */
 1304 #define AAC_FA_INTSRC                   0x900
 1306 #define AAC_FA_HACK(sc) (void)AAC_GETREG4(sc, AAC_FA_INTSRC)
 1308 /*
 1309  * Register definitions for the Adaptec AAC-364 'Jalapeno I/II' adapters, based
 1310  * on the SA110 'StrongArm'.
 1311  */
 1313 #define AAC_REGSIZE                     0x100
 1315 #define AAC_SA_DOORBELL0_CLEAR          0x98    /* doorbell 0 (adapter->host) */
 1316 #define AAC_SA_DOORBELL0_SET            0x9c
 1317 #define AAC_SA_DOORBELL0                0x9c
 1318 #define AAC_SA_MASK0_CLEAR              0xa0
 1319 #define AAC_SA_MASK0_SET                0xa4
 1321 #define AAC_SA_DOORBELL1_CLEAR          0x9a    /* doorbell 1 (host->adapter) */
 1322 #define AAC_SA_DOORBELL1_SET            0x9e
 1323 #define AAC_SA_DOORBELL1                0x9e
 1324 #define AAC_SA_MASK1_CLEAR              0xa2
 1325 #define AAC_SA_MASK1_SET                0xa6
 1327 #define AAC_SA_MAILBOX                  0xa8    /* mailbox (20 bytes) */
 1328 #define AAC_SA_FWSTATUS                 0xc4
 1330 /*
 1331  * Register definitions for the Adaptec 'Pablano' adapters, based on the i960Rx,
 1332  * and other related adapters.
 1333  */
 1335 #define AAC_RX_IDBR             0x20    /* inbound doorbell register */
 1336 #define AAC_RX_IISR             0x24    /* inbound interrupt status register */
 1337 #define AAC_RX_IIMR             0x28    /* inbound interrupt mask register */
 1338 #define AAC_RX_ODBR             0x2c    /* outbound doorbell register */
 1339 #define AAC_RX_OISR             0x30    /* outbound interrupt status register */
 1340 #define AAC_RX_OIMR             0x34    /* outbound interrupt mask register */
 1342 #define AAC_RX_MAILBOX          0x50    /* mailbox (20 bytes) */
 1343 #define AAC_RX_FWSTATUS         0x6c
 1345 /*
 1346  * Register definitions for the Adaptec 'Rocket' RAID-On-Chip adapters.
 1347  * Unsurprisingly, it's quite similar to the i960!
 1348  */
 1350 #define AAC_RKT_IDBR            0x20    /* inbound doorbell register */
 1351 #define AAC_RKT_IISR            0x24    /* inbound interrupt status register */
 1352 #define AAC_RKT_IIMR            0x28    /* inbound interrupt mask register */
 1353 #define AAC_RKT_ODBR            0x2c    /* outbound doorbell register */
 1354 #define AAC_RKT_OISR            0x30    /* outbound interrupt status register */
 1355 #define AAC_RKT_OIMR            0x34    /* outbound interrupt mask register */
 1357 #define AAC_RKT_MAILBOX         0x1000  /* mailbox */
 1358 #define AAC_RKT_FWSTATUS        0x101c  /* Firmware Status (mailbox 7) */
 1360 /*
 1361  * Common bit definitions for the doorbell registers.
 1362  */
 1364 /*
 1365  * Status bits in the doorbell registers.
 1366  */
 1367 #define AAC_DB_SYNC_COMMAND     (1<<0)  /* send/completed synchronous FIB */
 1368 #define AAC_DB_COMMAND_READY    (1<<1)  /* posted one or more commands */
 1369 #define AAC_DB_RESPONSE_READY   (1<<2)  /* one or more commands complete */
 1370 #define AAC_DB_COMMAND_NOT_FULL (1<<3)  /* command queue not full */
 1371 #define AAC_DB_RESPONSE_NOT_FULL (1<<4) /* response queue not full */
 1373 /*
 1374  * The adapter can request the host print a message by setting the
 1375  * DB_PRINTF flag in DOORBELL0.  The driver responds by collecting the
 1376  * message from the printf buffer, clearing the DB_PRINTF flag in 
 1377  * DOORBELL0 and setting it in DOORBELL1.
 1378  * (ODBR and IDBR respectively for the i960Rx adapters)
 1379  */
 1380 #define AAC_DB_PRINTF           (1<<5)  /* adapter requests host printf */
 1381 #define AAC_PRINTF_DONE         (1<<5)  /* Host completed printf processing */
 1383 /*
 1384  * Mask containing the interrupt bits we care about.  We don't anticipate (or
 1385  * want) interrupts not in this mask.
 1386  */
 1387 #define AAC_DB_INTERRUPTS       (AAC_DB_COMMAND_READY  |        \
AAC_DB_RESPONSE_READY |        \
AAC_DB_PRINTF)