2 * Copyright (c) 2000 Michael Smith
3 * Copyright (c) 2000-2001 Scott Long
4 * Copyright (c) 2000 BSDi
5 * Copyright (c) 2001 Adaptec, Inc.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * Data structures defining the interface between the driver and the Adaptec
34 * 'FSA' adapters. Note that many field names and comments here are taken
35 * verbatim from the Adaptec driver source in order to make comparing the
36 * two slightly easier.
40 * Misc. magic numbers.
42 #define AAC_MAX_CONTAINERS 64
43 #define AAC_BLOCK_SIZE 512
46 * Communications interface.
48 * Where datastructure layouts are closely parallel to the Adaptec sample code,
49 * retain their naming conventions (for now) to aid in cross-referencing.
53 * We establish 4 command queues and matching response queues. Queues must
54 * be 16-byte aligned, and are sized as follows:
56 #define AAC_HOST_NORM_CMD_ENTRIES 8 /* command adapter->host,
58 #define AAC_HOST_HIGH_CMD_ENTRIES 4 /* command adapter->host,
60 #define AAC_ADAP_NORM_CMD_ENTRIES 512 /* command host->adapter,
62 #define AAC_ADAP_HIGH_CMD_ENTRIES 4 /* command host->adapter,
64 #define AAC_HOST_NORM_RESP_ENTRIES 512 /* response, adapter->host,
66 #define AAC_HOST_HIGH_RESP_ENTRIES 4 /* response, adapter->host,
68 #define AAC_ADAP_NORM_RESP_ENTRIES 8 /* response, host->adapter,
70 #define AAC_ADAP_HIGH_RESP_ENTRIES 4 /* response, host->adapter,
73 #define AAC_TOTALQ_LENGTH (AAC_HOST_HIGH_CMD_ENTRIES + \
74 AAC_HOST_NORM_CMD_ENTRIES + \
75 AAC_ADAP_HIGH_CMD_ENTRIES + \
76 AAC_ADAP_NORM_CMD_ENTRIES + \
77 AAC_HOST_HIGH_RESP_ENTRIES + \
78 AAC_HOST_NORM_RESP_ENTRIES + \
79 AAC_ADAP_HIGH_RESP_ENTRIES + \
80 AAC_ADAP_NORM_RESP_ENTRIES)
81 #define AAC_QUEUE_COUNT 8
82 #define AAC_QUEUE_ALIGN 16
84 struct aac_queue_entry {
85 u_int32_t aq_fib_size; /* FIB size in bytes */
86 u_int32_t aq_fib_addr; /* receiver-space address of the FIB */
89 #define AAC_PRODUCER_INDEX 0
90 #define AAC_CONSUMER_INDEX 1
93 * Table of queue indices and queues used to communicate with the
94 * controller. This structure must be aligned to AAC_QUEUE_ALIGN
96 struct aac_queue_table {
97 /* queue consumer/producer indexes (layout mandated by adapter) */
98 u_int32_t qt_qindex[AAC_QUEUE_COUNT][2];
100 /* queue entry structures (layout mandated by adapter) */
101 struct aac_queue_entry qt_HostNormCmdQueue [AAC_HOST_NORM_CMD_ENTRIES];
102 struct aac_queue_entry qt_HostHighCmdQueue [AAC_HOST_HIGH_CMD_ENTRIES];
103 struct aac_queue_entry qt_AdapNormCmdQueue [AAC_ADAP_NORM_CMD_ENTRIES];
104 struct aac_queue_entry qt_AdapHighCmdQueue [AAC_ADAP_HIGH_CMD_ENTRIES];
105 struct aac_queue_entry qt_HostNormRespQueue[AAC_HOST_NORM_RESP_ENTRIES];
106 struct aac_queue_entry qt_HostHighRespQueue[AAC_HOST_HIGH_RESP_ENTRIES];
107 struct aac_queue_entry qt_AdapNormRespQueue[AAC_ADAP_NORM_RESP_ENTRIES];
108 struct aac_queue_entry qt_AdapHighRespQueue[AAC_ADAP_HIGH_RESP_ENTRIES];
114 * Note that we base these at 0 in order to use them as array indices. Adaptec
115 * used base 1 for some unknown reason, and sorted them in a different order.
117 #define AAC_HOST_NORM_CMD_QUEUE 0
118 #define AAC_HOST_HIGH_CMD_QUEUE 1
119 #define AAC_ADAP_NORM_CMD_QUEUE 2
120 #define AAC_ADAP_HIGH_CMD_QUEUE 3
121 #define AAC_HOST_NORM_RESP_QUEUE 4
122 #define AAC_HOST_HIGH_RESP_QUEUE 5
123 #define AAC_ADAP_NORM_RESP_QUEUE 6
124 #define AAC_ADAP_HIGH_RESP_QUEUE 7
127 * List structure used to chain FIBs (used by the adapter - we hang FIBs off
128 * our private command structure and don't touch these)
130 struct aac_fib_list_entry {
136 * FIB (FSA Interface Block?); this is the datastructure passed between the host
139 struct aac_fib_header {
145 u_int16_t SenderSize;
146 u_int32_t SenderFibAddress;
147 u_int32_t ReceiverFibAddress;
148 u_int32_t SenderData;
151 u_int32_t ReceiverTimeStart;
152 u_int32_t ReceiverTimeDone;
154 struct aac_fib_list_entry FibLinks;
158 #define AAC_FIB_DATASIZE (512 - sizeof(struct aac_fib_header))
161 struct aac_fib_header Header;
162 u_int8_t data[AAC_FIB_DATASIZE];
169 TestCommandResponse = 1,
170 TestAdapterCommand = 2,
172 /* lowlevel and comm commands */
173 LastTestCommand = 100,
174 ReinitHostNormCommandQueue = 101,
175 ReinitHostHighCommandQueue = 102,
176 ReinitHostHighRespQueue = 103,
177 ReinitHostNormRespQueue = 104,
178 ReinitAdapNormCommandQueue = 105,
179 ReinitAdapHighCommandQueue = 107,
180 ReinitAdapHighRespQueue = 108,
181 ReinitAdapNormRespQueue = 109,
182 InterfaceShutdown = 110,
188 RequestPerfData = 125,
189 SetInterruptDefTimer= 126,
190 SetInterruptDefCount= 127,
191 GetInterruptDefStatus= 128,
192 LastCommCommand = 129,
194 /* filesystem commands */
197 HostFileSystem = 302,
198 LastFileSystemCommand = 303,
200 /* Container Commands */
201 ContainerCommand = 500,
202 ContainerCommand64 = 501,
205 /* Cluster Commands */
206 ClusterCommand = 550,
208 /* Scsi Port commands (scsi passthrough) */
209 ScsiPortCommand = 600,
210 ScsiPortCommandU64 = 601,
211 SataPortCommandU64 = 602,
212 SasSmpPassThrough = 603,
213 SasRequestPhyInfo = 612,
215 /* misc house keeping and generic adapter initiated commands */
218 FsaHostShutdown = 702,
219 RequestAdapterInfo = 703,
220 IsAdapterPaused = 704,
222 RequestSupplementAdapterInfo = 706, /* Supp. Info for set in UCC
223 * use only if supported
224 * (RequestAdapterInfo first) */
225 LastMiscCommand = 707,
227 OnLineDiagnostic = 800,
228 FduAdapterTest = 801,
229 RequestCompatibilityId = 802,
230 AdapterEnvironmentInfo = 803, /* temp. sensors */
231 NvsramEventLog = 900,
232 ResetNvsramEventLogPointers = 901,
233 EnableEventLog = 902,
234 DisableEventLog = 903,
235 EncryptedKeyTransportFIB= 904,
236 KeyableFeaturesFIB= 905
242 #define AAC_FIBTYPE_TFIB 1
243 #define AAC_FIBTYPE_TQE 2
244 #define AAC_FIBTYPE_TCTPERF 3
249 #define AAC_FIBSTATE_HOSTOWNED (1<<0) /* owned by the host */
250 #define AAC_FIBSTATE_ADAPTEROWNED (1<<1) /* owned by the adapter */
251 #define AAC_FIBSTATE_INITIALISED (1<<2) /* initialised */
252 #define AAC_FIBSTATE_EMPTY (1<<3) /* empty */
253 #define AAC_FIBSTATE_FROMPOOL (1<<4) /* allocated from pool */
254 #define AAC_FIBSTATE_FROMHOST (1<<5) /* sent from the host */
255 #define AAC_FIBSTATE_FROMADAP (1<<6) /* sent from the adapter */
256 #define AAC_FIBSTATE_REXPECTED (1<<7) /* response is expected */
257 #define AAC_FIBSTATE_RNOTEXPECTED (1<<8) /* response is not expected */
258 #define AAC_FIBSTATE_DONEADAP (1<<9) /* processed by the adapter */
259 #define AAC_FIBSTATE_DONEHOST (1<<10) /* processed by the host */
260 #define AAC_FIBSTATE_HIGH (1<<11) /* high priority */
261 #define AAC_FIBSTATE_NORM (1<<12) /* normal priority */
262 #define AAC_FIBSTATE_ASYNC (1<<13)
263 #define AAC_FIBSTATE_ASYNCIO (1<<13) /* to be removed */
264 #define AAC_FIBSTATE_PAGEFILEIO (1<<14) /* to be removed */
265 #define AAC_FIBSTATE_SHUTDOWN (1<<15)
266 #define AAC_FIBSTATE_LAZYWRITE (1<<16) /* to be removed */
267 #define AAC_FIBSTATE_ADAPMICROFIB (1<<17)
268 #define AAC_FIBSTATE_BIOSFIB (1<<18)
269 #define AAC_FIBSTATE_FAST_RESPONSE (1<<19) /* fast response capable */
270 #define AAC_FIBSTATE_APIFIB (1<<20)
275 #define AAC_ERROR_NORMAL 0x00
276 #define AAC_ERROR_PENDING 0x01
277 #define AAC_ERROR_FATAL 0x02
278 #define AAC_ERROR_INVALID_QUEUE 0x03
279 #define AAC_ERROR_NOENTRIES 0x04
280 #define AAC_ERROR_SENDFAILED 0x05
281 #define AAC_ERROR_INVALID_QUEUE_PRIORITY 0x06
282 #define AAC_ERROR_FIB_ALLOCATION_FAILED 0x07
283 #define AAC_ERROR_FIB_DEALLOCATION_FAILED 0x08
286 * Adapter Init Structure: this is passed to the adapter with the
287 * AAC_MONKER_INITSTRUCT command to point it at our control structures.
289 struct aac_adapter_init {
290 u_int32_t InitStructRevision;
291 #define AAC_INIT_STRUCT_REVISION 3
292 #define AAC_INIT_STRUCT_REVISION_4 4
293 u_int32_t MiniPortRevision;
294 #define AAC_INIT_STRUCT_MINIPORT_REVISION 1
295 u_int32_t FilesystemRevision;
296 u_int32_t CommHeaderAddress;
297 u_int32_t FastIoCommAreaAddress;
298 u_int32_t AdapterFibsPhysicalAddress;
299 u_int32_t AdapterFibsVirtualAddress;
300 u_int32_t AdapterFibsSize;
301 u_int32_t AdapterFibAlign;
302 u_int32_t PrintfBufferAddress;
303 u_int32_t PrintfBufferSize;
304 #define AAC_PAGE_SIZE 4096
305 u_int32_t HostPhysMemPages;
306 u_int32_t HostElapsedSeconds;
307 /* ADAPTER_INIT_STRUCT_REVISION_4 begins here */
308 u_int32_t InitFlags; /* flags for supported features */
309 #define INITFLAGS_NEW_COMM_SUPPORTED 1
310 u_int32_t MaxIoCommands; /* max outstanding commands */
311 u_int32_t MaxIoSize; /* largest I/O command */
312 u_int32_t MaxFibSize; /* largest FIB to adapter */
332 CT_RAID10, /* stripe of mirror */
333 CT_RAID00, /* stripe of stripe */
334 CT_VOLUME_OF_MIRRORS, /* volume of mirror */
335 CT_PSEUDO_RAID3, /* really raid4 */
336 CT_RAID50, /* stripe of raid5 */
337 CT_RAID5D, /* raid5 distributed hot-sparing */
339 CT_RAID1E, /* extended raid1 mirroring */
345 * Host-addressable object types
348 FT_REG = 1, /* regular file */
349 FT_DIR, /* directory */
350 FT_BLK, /* "block" device - reserved */
351 FT_CHR, /* "character special" device - reserved */
352 FT_LNK, /* symbolic link */
353 FT_SOCK, /* socket */
355 FT_FILESYS, /* ADAPTEC's "FSA"(tm) filesystem */
356 FT_DRIVE, /* physical disk - addressable in scsi by b/t/l */
357 FT_SLICE, /* virtual disk - raw volume - slice */
358 FT_PARTITION, /* FSA partition - carved out of a slice - building
359 * block for containers */
360 FT_VOLUME, /* Container - Volume Set */
361 FT_STRIPE, /* Container - Stripe Set */
362 FT_MIRROR, /* Container - Mirror Set */
363 FT_RAID5, /* Container - Raid 5 Set */
364 FT_DATABASE /* Storage object with "foreign" content manager */
368 * Host-side scatter/gather list for 32-bit commands.
370 struct aac_sg_entry {
372 u_int32_t SgByteCount;
375 struct aac_sg_entry64 {
377 u_int32_t SgByteCount;
380 struct aac_sg_entryraw {
381 u_int32_t Next; /* reserved for FW use */
382 u_int32_t Prev; /* reserved for FW use */
384 u_int32_t SgByteCount;
385 u_int32_t Flags; /* reserved for FW use */
388 struct aac_sg_table {
390 struct aac_sg_entry SgEntry[0];
394 * Host-side scatter/gather list for 64-bit commands.
396 struct aac_sg_table64 {
398 struct aac_sg_entry64 SgEntry64[0];
402 * s/g list for raw commands
404 struct aac_sg_tableraw {
406 struct aac_sg_entryraw SgEntryRaw[0];
410 * Container creation data
412 struct aac_container_creation {
413 u_int8_t ViaBuildNumber;
414 u_int8_t MicroSecond;
415 u_int8_t Via; /* 1 = FSU, 2 = API, etc. */
416 u_int8_t YearsSince1900;
417 u_int32_t Month:4; /* 1-12 */
418 u_int32_t Day:6; /* 1-32 */
419 u_int32_t Hour:6; /* 0-23 */
420 u_int32_t Minute:6; /* 0-59 */
421 u_int32_t Second:6; /* 0-59 */
422 u_int64_t ViaAdapterSerialNumber;
426 * Revision number handling
451 u_int32_t buildNumber;
455 * Adapter Information
527 OEM_FLAVOR_ADAPTEC = 1,
544 * XXX the aac-2622 with no battery present reports PLATFORM_BAT_OPT_PRESENT
548 PLATFORM_BAT_REQ_PRESENT = 1, /* BATTERY REQUIRED AND PRESENT */
549 PLATFORM_BAT_REQ_NOTPRESENT, /* BATTERY REQUIRED AND NOT PRESENT */
550 PLATFORM_BAT_OPT_PRESENT, /* BATTERY OPTIONAL AND PRESENT */
551 PLATFORM_BAT_OPT_NOTPRESENT, /* BATTERY OPTIONAL AND NOT PRESENT */
552 PLATFORM_BAT_NOT_SUPPORTED /* BATTERY NOT SUPPORTED */
553 } AAC_BatteryPlatform;
556 * options supported by this board
557 * there has to be a one to one mapping of these defines and the ones in
558 * fsaapi.h, search for FSA_SUPPORT_SNAPSHOT
560 #define AAC_SUPPORTED_SNAPSHOT 0x01
561 #define AAC_SUPPORTED_CLUSTERS 0x02
562 #define AAC_SUPPORTED_WRITE_CACHE 0x04
563 #define AAC_SUPPORTED_64BIT_DATA 0x08
564 #define AAC_SUPPORTED_HOST_TIME_FIB 0x10
565 #define AAC_SUPPORTED_RAID50 0x20
566 #define AAC_SUPPORTED_4GB_WINDOW 0x40
567 #define AAC_SUPPORTED_SCSI_UPGRADEABLE 0x80
568 #define AAC_SUPPORTED_SOFT_ERR_REPORT 0x100
569 #define AAC_SUPPORTED_NOT_RECONDITION 0x200
570 #define AAC_SUPPORTED_SGMAP_HOST64 0x400
571 #define AAC_SUPPORTED_ALARM 0x800
572 #define AAC_SUPPORTED_NONDASD 0x1000
573 #define AAC_SUPPORTED_SCSI_MANAGED 0x2000
574 #define AAC_SUPPORTED_RAID_SCSI_MODE 0x4000
575 #define AAC_SUPPORTED_SUPPLEMENT_ADAPTER_INFO 0x10000
576 #define AAC_SUPPORTED_NEW_COMM 0x20000
577 #define AAC_SUPPORTED_64BIT_ARRAYSIZE 0x40000
578 #define AAC_SUPPORTED_HEAT_SENSOR 0x80000
581 * Structure used to respond to a RequestAdapterInfo fib.
583 struct aac_adapter_info {
584 AAC_Platform PlatformBase; /* adapter type */
585 AAC_CpuType CpuArchitecture; /* adapter CPU type */
586 AAC_CpuSubType CpuVariant; /* adapter CPU subtype */
587 u_int32_t ClockSpeed; /* adapter CPU clockspeed */
588 u_int32_t ExecutionMem; /* adapter Execution Memory
590 u_int32_t BufferMem; /* adapter Data Memory */
591 u_int32_t TotalMem; /* adapter Total Memory */
592 struct FsaRevision KernelRevision; /* adapter Kernel Software
594 struct FsaRevision MonitorRevision; /* adapter Monitor/Diagnostic
595 * Software Revision */
596 struct FsaRevision HardwareRevision;/* TBD */
597 struct FsaRevision BIOSRevision; /* adapter BIOS Revision */
598 u_int32_t ClusteringEnabled;
599 u_int32_t ClusterChannelMask;
600 u_int64_t SerialNumber;
601 AAC_BatteryPlatform batteryPlatform;
602 u_int32_t SupportedOptions; /* supported features of this
604 AAC_OemFlavor OemVariant;
608 * Monitor/Kernel interface.
612 * Synchronous commands to the monitor/kernel.
614 #define AAC_MONKER_BREAKPOINT 0x04
615 #define AAC_MONKER_INITSTRUCT 0x05
616 #define AAC_MONKER_SYNCFIB 0x0c
617 #define AAC_MONKER_GETKERNVER 0x11
618 #define AAC_MONKER_POSTRESULTS 0x14
619 #define AAC_MONKER_GETINFO 0x19
620 #define AAC_MONKER_GETDRVPROP 0x23
621 #define AAC_MONKER_RCVTEMP 0x25
622 #define AAC_MONKER_GETCOMMPREF 0x26
623 #define AAC_MONKER_REINIT 0xee
626 * Adapter Status Register
628 * Phase Staus mailbox is 32bits:
629 * <31:16> = Phase Status
632 * The adapter reports its present state through the phase. Only
633 * a single phase should be ever be set. Each phase can have multiple
634 * phase status bits to provide more detailed information about the
635 * state of the adapter.
637 #define AAC_SELF_TEST_FAILED 0x00000004
638 #define AAC_MONITOR_PANIC 0x00000020
639 #define AAC_UP_AND_RUNNING 0x00000080
640 #define AAC_KERNEL_PANIC 0x00000100
643 * Data types relating to control and monitoring of the NVRAM/WriteCache
647 #define AAC_NFILESYS 24 /* maximum number of filesystems */
650 * NVRAM/Write Cache subsystem states
653 NVSTATUS_DISABLED = 0, /* present, clean, not being used */
654 NVSTATUS_ENABLED, /* present, possibly dirty, ready for use */
655 NVSTATUS_ERROR, /* present, dirty, contains dirty data */
656 NVSTATUS_BATTERY, /* present, bad or low battery, may contain
658 NVSTATUS_UNKNOWN /* for bad/missing device */
662 * NVRAM/Write Cache subsystem battery component states
666 NVBATTSTATUS_NONE = 0, /* battery has no power or is not present */
667 NVBATTSTATUS_LOW, /* battery is low on power */
668 NVBATTSTATUS_OK, /* battery is okay - normal operation possible
669 * only in this state */
670 NVBATTSTATUS_RECONDITIONING /* no battery present - reconditioning
675 * Battery transition type
678 NVBATT_TRANSITION_NONE = 0, /* battery now has no power or is not
680 NVBATT_TRANSITION_LOW, /* battery is now low on power */
681 NVBATT_TRANSITION_OK /* battery is now okay - normal
682 * operation possible only in this
684 } AAC_NVBATT_TRANSITION;
687 * NVRAM Info structure returned for NVRAM_GetInfo call
689 struct aac_nvramdevinfo {
690 u_int32_t NV_Enabled; /* write caching enabled */
691 u_int32_t NV_Error; /* device in error state */
692 u_int32_t NV_NDirty; /* count of dirty NVRAM buffers */
693 u_int32_t NV_NActive; /* count of NVRAM buffers being
697 struct aac_nvraminfo {
698 AAC_NVSTATUS NV_Status; /* nvram subsystem status */
699 AAC_NVBATTSTATUS NV_BattStatus; /* battery status */
700 u_int32_t NV_Size; /* size of WriteCache NVRAM in
702 u_int32_t NV_BufSize; /* size of NVRAM buffers in
704 u_int32_t NV_NBufs; /* number of NVRAM buffers */
705 u_int32_t NV_NDirty; /* Num dirty NVRAM buffers */
706 u_int32_t NV_NClean; /* Num clean NVRAM buffers */
707 u_int32_t NV_NActive; /* Num NVRAM buffers being
709 u_int32_t NV_NBrokered; /* Num brokered NVRAM buffers */
710 struct aac_nvramdevinfo NV_DevInfo[AAC_NFILESYS]; /* per device
712 u_int32_t NV_BattNeedsReconditioning; /* boolean */
713 u_int32_t NV_TotalSize; /* size of all non-volatile
714 * memories in bytes */
718 * Data types relating to adapter-initiated FIBs
720 * Based on types and structures in <aifstruc.h>
727 AifJobStsSuccess = 1,
731 AifJobStsLastReportMarker = 100, /* All prior mean last report */
737 AifJobScsiMin = 1, /* Minimum value for Scsi operation */
738 AifJobScsiZero, /* SCSI device clear operation */
739 AifJobScsiVerify, /* SCSI device Verify operation NO
741 AifJobScsiExercise, /* SCSI device Exercise operation */
742 AifJobScsiVerifyRepair, /* SCSI device Verify operation WITH
744 AifJobScsiWritePattern, /* write pattern */
745 AifJobScsiMax = 99, /* Max Scsi value */
746 AifJobCtrMin, /* Min Ctr op value */
747 AifJobCtrZero, /* Container clear operation */
748 AifJobCtrCopy, /* Container copy operation */
749 AifJobCtrCreateMirror, /* Container Create Mirror operation */
750 AifJobCtrMergeMirror, /* Container Merge Mirror operation */
751 AifJobCtrScrubMirror, /* Container Scrub Mirror operation */
752 AifJobCtrRebuildRaid5, /* Container Rebuild Raid5 operation */
753 AifJobCtrScrubRaid5, /* Container Scrub Raid5 operation */
754 AifJobCtrMorph, /* Container morph operation */
755 AifJobCtrPartCopy, /* Container Partition copy operation */
756 AifJobCtrRebuildMirror, /* Container Rebuild Mirror operation */
757 AifJobCtrCrazyCache, /* crazy cache */
758 AifJobCtrCopyback, /* Container Copyback operation */
759 AifJobCtrCompactRaid5D, /* Container Compaction operation */
760 AifJobCtrExpandRaid5D, /* Container Expansion operation */
761 AifJobCtrRebuildRaid6, /* Container Rebuild Raid6 operation */
762 AifJobCtrScrubRaid6, /* Container Scrub Raid6 operation */
763 AifJobCtrSSBackup, /* Container snapshot backup task */
764 AifJobCtrMax = 199, /* Max Ctr type operation */
765 AifJobFsMin, /* Min Fs type operation */
766 AifJobFsCreate, /* File System Create operation */
767 AifJobFsVerify, /* File System Verify operation */
768 AifJobFsExtend, /* File System Extend operation */
769 AifJobFsMax = 299, /* Max Fs type operation */
770 AifJobApiFormatNTFS, /* Format a drive to NTFS */
771 AifJobApiFormatFAT, /* Format a drive to FAT */
772 AifJobApiUpdateSnapshot, /* update the read/write half of a
774 AifJobApiFormatFAT32, /* Format a drive to FAT32 */
775 AifJobApiMax = 399, /* Max API type operation */
776 AifJobCtlContinuousCtrVerify, /* Adapter operation */
777 AifJobCtlMax = 499 /* Max Adapter type operation */
780 struct aac_AifContainers {
781 u_int32_t src; /* from/master */
782 u_int32_t dst; /* to/slave */
785 union aac_AifJobClient {
786 struct aac_AifContainers container; /* For Container and
787 * filesystem progress
789 int32_t scsi_dh; /* For SCSI progress
793 struct aac_AifJobDesc {
794 u_int32_t jobID; /* DO NOT FILL IN! Will be
795 * filled in by AIF */
796 AAC_AifJobType type; /* Operation that is being
798 union aac_AifJobClient client; /* Details */
801 struct aac_AifJobProgressReport {
802 struct aac_AifJobDesc jd;
803 AAC_AifJobStatus status;
805 u_int32_t currentTick;
806 u_int32_t jobSpecificData1;
807 u_int32_t jobSpecificData2;
814 /* General application notifies start here */
815 AifEnGeneric = 1, /* Generic notification */
816 AifEnTaskComplete, /* Task has completed */
817 AifEnConfigChange, /* Adapter config change occurred */
818 AifEnContainerChange, /* Adapter specific container
819 * configuration change */
820 AifEnDeviceFailure, /* SCSI device failed */
821 AifEnMirrorFailover, /* Mirror failover started */
822 AifEnContainerEvent, /* Significant container event */
823 AifEnFileSystemChange, /* File system changed */
824 AifEnConfigPause, /* Container pause event */
825 AifEnConfigResume, /* Container resume event */
826 AifEnFailoverChange, /* Failover space assignment changed */
827 AifEnRAID5RebuildDone, /* RAID5 rebuild finished */
828 AifEnEnclosureManagement, /* Enclosure management event */
829 AifEnBatteryEvent, /* Significant NV battery event */
830 AifEnAddContainer, /* A new container was created. */
831 AifEnDeleteContainer, /* A container was deleted. */
832 AifEnSMARTEvent, /* SMART Event */
833 AifEnBatteryNeedsRecond, /* The battery needs reconditioning */
834 AifEnClusterEvent, /* Some cluster event */
835 AifEnDiskSetEvent, /* A disk set event occured. */
836 AifDriverNotifyStart=199, /* Notifies for host driver go here */
837 /* Host driver notifications start here */
838 AifDenMorphComplete, /* A morph operation completed */
839 AifDenVolumeExtendComplete /* Volume expand operation completed */
840 } AAC_AifEventNotifyType;
842 struct aac_AifEnsGeneric {
843 char text[132]; /* Generic text */
846 struct aac_AifEnsDeviceFailure {
847 u_int32_t deviceHandle; /* SCSI device handle */
850 struct aac_AifEnsMirrorFailover {
851 u_int32_t container; /* Container with failed element */
852 u_int32_t failedSlice; /* Old slice which failed */
853 u_int32_t creatingSlice; /* New slice used for auto-create */
856 struct aac_AifEnsContainerChange {
857 u_int32_t container[2]; /* container that changed, -1 if no
861 struct aac_AifEnsContainerEvent {
862 u_int32_t container; /* container number */
863 u_int32_t eventType; /* event type */
866 struct aac_AifEnsEnclosureEvent {
867 u_int32_t empID; /* enclosure management proc number */
868 u_int32_t unitID; /* unitId, fan id, power supply id,
869 * slot id, tempsensor id. */
870 u_int32_t eventType; /* event type */
873 struct aac_AifEnsBatteryEvent {
874 AAC_NVBATT_TRANSITION transition_type; /* eg from low to ok */
875 AAC_NVBATTSTATUS current_state; /* current batt state */
876 AAC_NVBATTSTATUS prior_state; /* prev batt state */
879 struct aac_AifEnsDiskSetEvent {
886 CLUSTER_NULL_EVENT = 0,
887 CLUSTER_PARTNER_NAME_EVENT, /* change in partner hostname or
888 * adaptername from NULL to non-NULL */
889 /* (partner's agent may be up) */
890 CLUSTER_PARTNER_NULL_NAME_EVENT /* change in partner hostname or
891 * adaptername from non-null to NULL */
892 /* (partner has rebooted) */
893 } AAC_ClusterAifEvent;
895 struct aac_AifEnsClusterEvent {
896 AAC_ClusterAifEvent eventType;
899 struct aac_AifEventNotify {
900 AAC_AifEventNotifyType type;
902 struct aac_AifEnsGeneric EG;
903 struct aac_AifEnsDeviceFailure EDF;
904 struct aac_AifEnsMirrorFailover EMF;
905 struct aac_AifEnsContainerChange ECC;
906 struct aac_AifEnsContainerEvent ECE;
907 struct aac_AifEnsEnclosureEvent EEE;
908 struct aac_AifEnsBatteryEvent EBE;
909 struct aac_AifEnsDiskSetEvent EDS;
910 /* struct aac_AifEnsSMARTEvent ES;*/
911 struct aac_AifEnsClusterEvent ECLE;
916 * Adapter Initiated FIB command structures. Start with the adapter
917 * initiated FIBs that really come from the adapter, and get responded
920 #define AAC_AIF_REPORT_MAX_SIZE 64
923 AifCmdEventNotify = 1, /* Notify of event */
924 AifCmdJobProgress, /* Progress report */
925 AifCmdAPIReport, /* Report from other user of API */
926 AifCmdDriverNotify, /* Notify host driver of event */
927 AifReqJobList = 100, /* Gets back complete job list */
928 AifReqJobsForCtr, /* Gets back jobs for specific container */
929 AifReqJobsForScsi, /* Gets back jobs for specific SCSI device */
930 AifReqJobReport, /* Gets back a specific job report or list */
931 AifReqTerminateJob, /* Terminates job */
932 AifReqSuspendJob, /* Suspends a job */
933 AifReqResumeJob, /* Resumes a job */
934 AifReqSendAPIReport, /* API generic report requests */
935 AifReqAPIJobStart, /* Start a job from the API */
936 AifReqAPIJobUpdate, /* Update a job report from the API */
937 AifReqAPIJobFinish /* Finish a job from the API */
940 struct aac_aif_command {
941 AAC_AifCommand command; /* Tell host what type of
943 u_int32_t seqNumber; /* To allow ordering of
944 * reports (if necessary) */
946 struct aac_AifEventNotify EN; /* Event notify */
947 struct aac_AifJobProgressReport PR[1]; /* Progress report */
948 u_int8_t AR[AAC_AIF_REPORT_MAX_SIZE];
949 u_int8_t data[AAC_FIB_DATASIZE - 8];
954 * Filesystem commands/data
956 * The adapter has a very complex filesystem interface, most of which we ignore.
957 * (And which seems not to be implemented, anyway.)
1006 * Command status values
1027 ST_NAMETOOLONG = 63,
1032 ST_BADHANDLE = 10001,
1033 ST_NOT_SYNC = 10002,
1034 ST_BAD_COOKIE = 10003,
1036 ST_TOOSMALL = 10005,
1037 ST_SERVERFAULT = 10006,
1040 ST_NOTMOUNTED = 10009,
1041 ST_MAINTMODE = 10010,
1046 * Volume manager commands
1048 typedef enum _VM_COMMANDS {
1057 VM_SliceBlockRead, /* raw access to configured storage objects */
1059 VM_DriveBlockRead, /* raw access to physical devices */
1061 VM_EnclosureMgt, /* enclosure management */
1062 VM_Unused, /* used to be diskset management */
1064 VM_CtPerf, /* performance test */
1070 VM_DrvErrTblLog, /* drive error table/log type of command */
1075 * "mountable object"
1079 char FileSystemName[16];
1080 struct aac_container_creation CreateInfo;
1084 u_int32_t ContentState;
1085 #define FSCS_READONLY 0x0002 /* XXX need more information
1090 u_int32_t AlterEgoId;
1093 struct aac_mntinfo {
1099 struct aac_mntinforesp {
1102 u_int32_t MntRespCount;
1103 struct aac_mntobj MntTable[1];
1107 * Container shutdown command.
1109 struct aac_closecommand {
1111 u_int32_t ContainerId;
1115 * Container Config Command
1117 #define CT_GET_SCSI_METHOD 64
1124 struct aac_ctcfg_resp {
1133 #define AAC_SCSI_MAX_PORTS 10
1134 #define AAC_BUS_NO_EXIST 0
1135 #define AAC_BUS_VALID 1
1136 #define AAC_BUS_FAULTED 2
1137 #define AAC_BUS_DISABLED 3
1138 #define GetBusInfo 0x9
1140 struct aac_getbusinf {
1141 u_int32_t ProbeComplete;
1143 u_int32_t TargetsPerBus;
1144 u_int8_t InitiatorBusId[AAC_SCSI_MAX_PORTS];
1145 u_int8_t BusValid[AAC_SCSI_MAX_PORTS];
1148 struct aac_vmioctl {
1154 u_int32_t IoctlBuf[1]; /* Placeholder? */
1157 struct aac_vmi_businf_resp {
1163 struct aac_getbusinf BusInf;
1167 #define AAC_BTL_TO_HANDLE(b, t, l) \
1168 (((b & 0x3f) << 7) | ((l & 0x7) << 4) | (t & 0xf))
1170 #define AAC_BTL_TO_HANDLE(b, t, l) \
1171 ((((u_int32_t)b & 0x0f) << 24) | \
1172 (((u_int32_t)l & 0xff) << 16) | \
1173 ((u_int32_t)t & 0xffff))
1175 #define GetDeviceProbeInfo 0x5
1177 struct aac_vmi_devinfo_resp {
1183 u_int8_t VendorId[8];
1184 u_int8_t ProductId[16];
1185 u_int8_t ProductRev[4];
1192 u_int32_t reserved[2];
1193 u_int8_t VendorSpecific[20];
1195 u_int32_t AAC_Managed:1;
1197 u_int32_t reserved2:6;
1201 u_int32_t ultraEnable:1,
1213 }; /* Do not pack */
1215 #define ResetBus 0x16
1216 struct aac_resetbus {
1217 u_int32_t BusNumber;
1221 * Write 'stability' options.
1229 * Commit level response for a write request.
1232 CMFILE_SYNC_NVRAM = 1,
1240 * Block read/write operations.
1241 * These structures are packed into the 'data' area in the FIB.
1244 struct aac_blockread {
1245 u_int32_t Command; /* not FSACommand! */
1246 u_int32_t ContainerId;
1247 u_int32_t BlockNumber;
1248 u_int32_t ByteCount;
1249 struct aac_sg_table SgMap; /* variable size */
1252 struct aac_blockread64 {
1254 u_int16_t ContainerId;
1255 u_int16_t SectorCount;
1256 u_int32_t BlockNumber;
1259 struct aac_sg_table64 SgMap64;
1262 struct aac_blockread_response {
1264 u_int32_t ByteCount;
1267 struct aac_blockwrite {
1268 u_int32_t Command; /* not FSACommand! */
1269 u_int32_t ContainerId;
1270 u_int32_t BlockNumber;
1271 u_int32_t ByteCount;
1273 struct aac_sg_table SgMap; /* variable size */
1276 struct aac_blockwrite64 {
1277 u_int32_t Command; /* not FSACommand! */
1278 u_int16_t ContainerId;
1279 u_int16_t SectorCount;
1280 u_int32_t BlockNumber;
1283 struct aac_sg_table64 SgMap64; /* variable size */
1286 struct aac_blockwrite_response {
1288 u_int32_t ByteCount;
1289 u_int32_t Committed;
1293 u_int64_t BlockNumber;
1294 u_int32_t ByteCount;
1295 u_int16_t ContainerId;
1296 u_int16_t Flags; /* 0: W, 1: R */
1297 u_int16_t BpTotal; /* reserved for FW use */
1298 u_int16_t BpComplete; /* reserved for FW use */
1299 struct aac_sg_tableraw SgMapRaw; /* variable size */
1303 * Container shutdown command.
1305 struct aac_close_command {
1307 u_int32_t ContainerId;
1311 * SCSI Passthrough structures
1321 u_int32_t retry_limit;
1324 struct aac_sg_table sg_map32;
1328 AAC_SRB_FUNC_EXECUTE_SCSI = 0x00,
1329 AAC_SRB_FUNC_CLAIM_DEVICE,
1330 AAC_SRB_FUNC_IO_CONTROL,
1331 AAC_SRB_FUNC_RECEIVE_EVENT,
1332 AAC_SRB_FUNC_RELEASE_QUEUE,
1333 AAC_SRB_FUNC_ATTACH_DEVICE,
1334 AAC_SRB_FUNC_RELEASE_DEVICE,
1335 AAC_SRB_FUNC_SHUTDOWN,
1337 AAC_SRB_FUNC_ABORT_COMMAND = 0x10,
1338 AAC_SRB_FUNC_RELEASE_RECOVERY,
1339 AAC_SRB_FUNC_RESET_BUS,
1340 AAC_SRB_FUNC_RESET_DEVICE,
1341 AAC_SRB_FUNC_TERMINATE_IO,
1342 AAC_SRB_FUNC_FLUSH_QUEUE,
1343 AAC_SRB_FUNC_REMOVE_DEVICE,
1344 AAC_SRB_FUNC_DOMAIN_VALIDATION
1347 #define AAC_SRB_FLAGS_NO_DATA_XFER 0x0000
1348 #define AAC_SRB_FLAGS_DISABLE_DISCONNECT 0x0004
1349 #define AAC_SRB_FLAGS_DISABLE_SYNC_TRANSFER 0x0008
1350 #define AAC_SRB_FLAGS_BYPASS_FROZEN_QUEUE 0x0010
1351 #define AAC_SRB_FLAGS_DISABLE_AUTOSENSE 0x0020
1352 #define AAC_SRB_FLAGS_DATA_IN 0x0040
1353 #define AAC_SRB_FLAGS_DATA_OUT 0x0080
1354 #define AAC_SRB_FLAGS_UNSPECIFIED_DIRECTION \
1355 (AAC_SRB_FLAGS_DATA_IN | AAC_SRB_FLAGS_DATA_OUT)
1357 #define AAC_HOST_SENSE_DATA_MAX 30
1359 struct aac_srb_response {
1360 u_int32_t fib_status;
1361 u_int32_t srb_status;
1362 u_int32_t scsi_status;
1364 u_int32_t sense_len;
1365 u_int8_t sense[AAC_HOST_SENSE_DATA_MAX];
1369 * Status codes for SCSI passthrough commands. Since they are based on ASPI,
1370 * they also exactly match CAM status codes in both enumeration and meaning.
1371 * They seem to also be used as status codes for synchronous FIBs.
1374 AAC_SRB_STS_PENDING = 0x00,
1375 AAC_SRB_STS_SUCCESS,
1376 AAC_SRB_STS_ABORTED,
1377 AAC_SRB_STS_ABORT_FAILED,
1380 AAC_SRB_STS_INVALID_REQUEST,
1381 AAC_SRB_STS_INVALID_PATH_ID,
1382 AAC_SRB_STS_NO_DEVICE,
1383 AAC_SRB_STS_TIMEOUT,
1384 AAC_SRB_STS_SELECTION_TIMEOUT,
1385 AAC_SRB_STS_COMMAND_TIMEOUT,
1386 AAC_SRB_STS_MESSAGE_REJECTED = 0x0D,
1387 AAC_SRB_STS_BUS_RESET,
1388 AAC_SRB_STS_PARITY_ERROR,
1389 AAC_SRB_STS_REQUEST_SENSE_FAILED,
1391 AAC_SRB_STS_DATA_OVERRUN,
1392 AAC_SRB_STS_UNEXPECTED_BUS_FREE,
1393 AAC_SRB_STS_PHASE_SEQUENCE_FAILURE,
1394 AAC_SRB_STS_BAD_SRB_BLOCK_LENGTH,
1395 AAC_SRB_STS_REQUEST_FLUSHED,
1396 AAC_SRB_STS_INVALID_LUN = 0x20,
1397 AAC_SRB_STS_INVALID_TARGET_ID,
1398 AAC_SRB_STS_BAD_FUNCTION,
1399 AAC_SRB_STS_ERROR_RECOVERY
1403 * Register set for adapters based on the Falcon bridge and PPC core
1406 #define AAC_FA_DOORBELL0_CLEAR 0x00
1407 #define AAC_FA_DOORBELL1_CLEAR 0x02
1408 #define AAC_FA_DOORBELL0 0x04
1409 #define AAC_FA_DOORBELL1 0x06
1410 #define AAC_FA_MASK0_CLEAR 0x08
1411 #define AAC_FA_MASK1_CLEAR 0x0a
1412 #define AAC_FA_MASK0 0x0c
1413 #define AAC_FA_MASK1 0x0e
1414 #define AAC_FA_MAILBOX 0x10
1415 #define AAC_FA_FWSTATUS 0x2c /* Mailbox 7 */
1416 #define AAC_FA_INTSRC 0x900
1418 #define AAC_FA_HACK(sc) (void)AAC_GETREG4(sc, AAC_FA_INTSRC)
1421 * Register definitions for the Adaptec AAC-364 'Jalapeno I/II' adapters, based
1422 * on the SA110 'StrongArm'.
1425 #define AAC_SA_DOORBELL0_CLEAR 0x98 /* doorbell 0 (adapter->host) */
1426 #define AAC_SA_DOORBELL0_SET 0x9c
1427 #define AAC_SA_DOORBELL0 0x9c
1428 #define AAC_SA_MASK0_CLEAR 0xa0
1429 #define AAC_SA_MASK0_SET 0xa4
1431 #define AAC_SA_DOORBELL1_CLEAR 0x9a /* doorbell 1 (host->adapter) */
1432 #define AAC_SA_DOORBELL1_SET 0x9e
1433 #define AAC_SA_DOORBELL1 0x9e
1434 #define AAC_SA_MASK1_CLEAR 0xa2
1435 #define AAC_SA_MASK1_SET 0xa6
1437 #define AAC_SA_MAILBOX 0xa8 /* mailbox (20 bytes) */
1438 #define AAC_SA_FWSTATUS 0xc4
1441 * Register definitions for the Adaptec 'Pablano' adapters, based on the i960Rx,
1442 * and other related adapters.
1445 #define AAC_RX_IDBR 0x20 /* inbound doorbell register */
1446 #define AAC_RX_IISR 0x24 /* inbound interrupt status register */
1447 #define AAC_RX_IIMR 0x28 /* inbound interrupt mask register */
1448 #define AAC_RX_ODBR 0x2c /* outbound doorbell register */
1449 #define AAC_RX_OISR 0x30 /* outbound interrupt status register */
1450 #define AAC_RX_OIMR 0x34 /* outbound interrupt mask register */
1451 #define AAC_RX_IQUE 0x40 /* inbound queue */
1452 #define AAC_RX_OQUE 0x44 /* outbound queue */
1454 #define AAC_RX_MAILBOX 0x50 /* mailbox (20 bytes) */
1455 #define AAC_RX_FWSTATUS 0x6c
1458 * Register definitions for the Adaptec 'Rocket' RAID-On-Chip adapters.
1459 * Unsurprisingly, it's quite similar to the i960!
1462 #define AAC_RKT_IDBR 0x20 /* inbound doorbell register */
1463 #define AAC_RKT_IISR 0x24 /* inbound interrupt status register */
1464 #define AAC_RKT_IIMR 0x28 /* inbound interrupt mask register */
1465 #define AAC_RKT_ODBR 0x2c /* outbound doorbell register */
1466 #define AAC_RKT_OISR 0x30 /* outbound interrupt status register */
1467 #define AAC_RKT_OIMR 0x34 /* outbound interrupt mask register */
1468 #define AAC_RKT_IQUE 0x40 /* inbound queue */
1469 #define AAC_RKT_OQUE 0x44 /* outbound queue */
1471 #define AAC_RKT_MAILBOX 0x1000 /* mailbox */
1472 #define AAC_RKT_FWSTATUS 0x101c /* Firmware Status (mailbox 7) */
1475 * Common bit definitions for the doorbell registers.
1479 * Status bits in the doorbell registers.
1481 #define AAC_DB_SYNC_COMMAND (1<<0) /* send/completed synchronous FIB */
1482 #define AAC_DB_COMMAND_READY (1<<1) /* posted one or more commands */
1483 #define AAC_DB_RESPONSE_READY (1<<2) /* one or more commands complete */
1484 #define AAC_DB_COMMAND_NOT_FULL (1<<3) /* command queue not full */
1485 #define AAC_DB_RESPONSE_NOT_FULL (1<<4) /* response queue not full */
1488 * The adapter can request the host print a message by setting the
1489 * DB_PRINTF flag in DOORBELL0. The driver responds by collecting the
1490 * message from the printf buffer, clearing the DB_PRINTF flag in
1491 * DOORBELL0 and setting it in DOORBELL1.
1492 * (ODBR and IDBR respectively for the i960Rx adapters)
1494 #define AAC_DB_PRINTF (1<<5) /* adapter requests host printf */
1495 #define AAC_PRINTF_DONE (1<<5) /* Host completed printf processing */
1498 * Mask containing the interrupt bits we care about. We don't anticipate (or
1499 * want) interrupts not in this mask.
1501 #define AAC_DB_INTERRUPTS (AAC_DB_COMMAND_READY | \
1502 AAC_DB_RESPONSE_READY | \
1504 #define AAC_DB_INT_NEW_COMM 0x08