blob: a2e68d21efe345374ed32e4972b1b2edfa5a06c1 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef CCISS_CMD_H
2#define CCISS_CMD_H
dann frazier429c42c2010-02-17 16:55:11 -07003
4#include <linux/cciss_defs.h>
5
dann frazierb0284612010-02-17 16:53:31 -07006/* DEFINES */
Linus Torvalds1da177e2005-04-16 15:20:36 -07007#define CISS_VERSION "1.00"
8
dann frazierb0284612010-02-17 16:53:31 -07009/* general boundary definitions */
Don Brace5c07a312009-11-12 12:50:01 -060010#define MAXSGENTRIES 32
11#define CCISS_SG_CHAIN 0x80000000
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#define MAXREPLYQS 256
13
Mike Miller0a9279c2009-04-02 12:50:55 -070014/* Unit Attentions ASC's as defined for the MSA2012sa */
15#define POWER_OR_RESET 0x29
16#define STATE_CHANGED 0x2a
17#define UNIT_ATTENTION_CLEARED 0x2f
18#define LUN_FAILED 0x3e
19#define REPORT_LUNS_CHANGED 0x3f
20
21/* Unit Attentions ASCQ's as defined for the MSA2012sa */
22
23 /* These ASCQ's defined for ASC = POWER_OR_RESET */
24#define POWER_ON_RESET 0x00
25#define POWER_ON_REBOOT 0x01
26#define SCSI_BUS_RESET 0x02
27#define MSA_TARGET_RESET 0x03
28#define CONTROLLER_FAILOVER 0x04
29#define TRANSCEIVER_SE 0x05
30#define TRANSCEIVER_LVD 0x06
31
32 /* These ASCQ's defined for ASC = STATE_CHANGED */
33#define RESERVATION_PREEMPTED 0x03
34#define ASYM_ACCESS_CHANGED 0x06
35#define LUN_CAPACITY_CHANGED 0x09
36
dann frazierb0284612010-02-17 16:53:31 -070037/* config space register offsets */
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#define CFG_VENDORID 0x00
39#define CFG_DEVICEID 0x02
40#define CFG_I2OBAR 0x10
41#define CFG_MEM1BAR 0x14
42
dann frazierb0284612010-02-17 16:53:31 -070043/* i2o space register offsets */
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#define I2O_IBDB_SET 0x20
45#define I2O_IBDB_CLEAR 0x70
46#define I2O_INT_STATUS 0x30
47#define I2O_INT_MASK 0x34
48#define I2O_IBPOST_Q 0x40
49#define I2O_OBPOST_Q 0x44
Mike Millerf92e2f52006-12-06 20:35:04 -080050#define I2O_DMA1_CFG 0x214
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
dann frazierb0284612010-02-17 16:53:31 -070052/* Configuration Table */
Linus Torvalds1da177e2005-04-16 15:20:36 -070053#define CFGTBL_ChangeReq 0x00000001l
54#define CFGTBL_AccCmds 0x00000001l
Stephen M. Camerona6528d02010-07-19 13:46:22 -050055#define DOORBELL_CTLR_RESET 0x00000004l
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
57#define CFGTBL_Trans_Simple 0x00000002l
Mike Miller5e216152010-06-02 12:58:06 -070058#define CFGTBL_Trans_Performant 0x00000004l
Stephen M. Cameron0498cc22011-03-12 10:02:16 +010059#define CFGTBL_Trans_use_short_tags 0x20000000l
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
61#define CFGTBL_BusType_Ultra2 0x00000001l
62#define CFGTBL_BusType_Ultra3 0x00000002l
63#define CFGTBL_BusType_Fibre1G 0x00000100l
64#define CFGTBL_BusType_Fibre2G 0x00000200l
65typedef struct _vals32
66{
67 __u32 lower;
68 __u32 upper;
69} vals32;
70
71typedef union _u64bit
72{
73 vals32 val32;
74 __u64 val;
75} u64bit;
76
dann frazierb0284612010-02-17 16:53:31 -070077/* Type defs used in the following structs */
Linus Torvalds1da177e2005-04-16 15:20:36 -070078#define QWORD vals32
79
dann frazierb0284612010-02-17 16:53:31 -070080/* STRUCTURES */
Linus Torvalds1da177e2005-04-16 15:20:36 -070081#define CISS_MAX_PHYS_LUN 1024
dann frazierb0284612010-02-17 16:53:31 -070082/* SCSI-3 Cmmands */
Linus Torvalds1da177e2005-04-16 15:20:36 -070083
84#pragma pack(1)
85
86#define CISS_INQUIRY 0x12
dann frazierb0284612010-02-17 16:53:31 -070087/* Date returned */
Linus Torvalds1da177e2005-04-16 15:20:36 -070088typedef struct _InquiryData_struct
89{
90 BYTE data_byte[36];
91} InquiryData_struct;
92
93#define CISS_REPORT_LOG 0xc2 /* Report Logical LUNs */
94#define CISS_REPORT_PHYS 0xc3 /* Report Physical LUNs */
dann frazierb0284612010-02-17 16:53:31 -070095/* Data returned */
Linus Torvalds1da177e2005-04-16 15:20:36 -070096typedef struct _ReportLUNdata_struct
97{
98 BYTE LUNListLength[4];
99 DWORD reserved;
100 BYTE LUN[CISS_MAX_LUN][8];
101} ReportLunData_struct;
102
103#define CCISS_READ_CAPACITY 0x25 /* Read Capacity */
104typedef struct _ReadCapdata_struct
105{
dann frazierb0284612010-02-17 16:53:31 -0700106 BYTE total_size[4]; /* Total size in blocks */
107 BYTE block_size[4]; /* Size of blocks in bytes */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108} ReadCapdata_struct;
109
Mike Miller (OS Dev)00988a32006-09-30 23:27:23 -0700110#define CCISS_READ_CAPACITY_16 0x9e /* Read Capacity 16 */
111
112/* service action to differentiate a 16 byte read capacity from
113 other commands that use the 0x9e SCSI op code */
114
115#define CCISS_READ_CAPACITY_16_SERVICE_ACT 0x10
116
117typedef struct _ReadCapdata_struct_16
118{
119 BYTE total_size[8]; /* Total size in blocks */
120 BYTE block_size[4]; /* Size of blocks in bytes */
121 BYTE prot_en:1; /* protection enable bit */
122 BYTE rto_en:1; /* reference tag own enable bit */
123 BYTE reserved:6; /* reserved bits */
124 BYTE reserved2[18]; /* reserved bytes per spec */
125} ReadCapdata_struct_16;
126
127/* Define the supported read/write commands for cciss based controllers */
128
129#define CCISS_READ_10 0x28 /* Read(10) */
130#define CCISS_WRITE_10 0x2a /* Write(10) */
131#define CCISS_READ_16 0x88 /* Read(16) */
132#define CCISS_WRITE_16 0x8a /* Write(16) */
133
134/* Define the CDB lengths supported by cciss based controllers */
135
136#define CDB_LEN10 10
137#define CDB_LEN16 16
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
dann frazierb0284612010-02-17 16:53:31 -0700139/* BMIC commands */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140#define BMIC_READ 0x26
141#define BMIC_WRITE 0x27
142#define BMIC_CACHE_FLUSH 0xc2
dann frazierb0284612010-02-17 16:53:31 -0700143#define CCISS_CACHE_FLUSH 0x01 /* C2 was already being used by CCISS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144
dann frazierb0284612010-02-17 16:53:31 -0700145/* Command List Structure */
scameron@beardog.cca.cpqcorp.netb57695f2009-06-08 16:02:17 -0500146#define CTLR_LUNID "\0\0\0\0\0\0\0\0"
147
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148typedef struct _CommandListHeader_struct {
149 BYTE ReplyQueue;
150 BYTE SGList;
151 HWORD SGTotal;
152 QWORD Tag;
153 LUNAddr_struct LUN;
154} CommandListHeader_struct;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155typedef struct _ErrDescriptor_struct {
156 QWORD Addr;
157 DWORD Len;
158} ErrDescriptor_struct;
159typedef struct _SGDescriptor_struct {
160 QWORD Addr;
161 DWORD Len;
162 DWORD Ext;
163} SGDescriptor_struct;
164
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165/* Command types */
166#define CMD_RWREQ 0x00
167#define CMD_IOCTL_PEND 0x01
168#define CMD_SCSI 0x03
169#define CMD_MSG_DONE 0x04
170#define CMD_MSG_TIMEOUT 0x05
Hannes Reineckeb59e64d2009-07-02 22:02:06 +0200171#define CMD_MSG_STALE 0xff
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172
Stephen M. Cameron1b7d0d22010-02-26 16:01:17 -0600173/* This structure needs to be divisible by COMMANDLIST_ALIGNMENT
174 * because low bits of the address are used to to indicate that
175 * whether the tag contains an index or an address. PAD_32 and
176 * PAD_64 can be adjusted independently as needed for 32-bit
177 * and 64-bits systems.
Mike Miller33079b22005-09-13 01:25:22 -0700178 */
Mike Miller5e216152010-06-02 12:58:06 -0700179#define COMMANDLIST_ALIGNMENT (32)
Stephen M. Cameron58daa9c2010-02-26 16:01:12 -0600180#define IS_64_BIT ((sizeof(long) - 4)/4)
181#define IS_32_BIT (!IS_64_BIT)
Mike Millerf3bcb142010-06-11 13:13:36 +0200182#define PAD_32 (0)
Stephen M. Cameron58daa9c2010-02-26 16:01:12 -0600183#define PAD_64 (4)
184#define PADSIZE (IS_32_BIT * PAD_32 + IS_64_BIT * PAD_64)
Mike Miller5e216152010-06-02 12:58:06 -0700185#define DIRECT_LOOKUP_BIT 0x10
186#define DIRECT_LOOKUP_SHIFT 5
187
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188typedef struct _CommandList_struct {
189 CommandListHeader_struct Header;
190 RequestBlock_struct Request;
191 ErrDescriptor_struct ErrDesc;
192 SGDescriptor_struct SG[MAXSGENTRIES];
193 /* information associated with the command */
194 __u32 busaddr; /* physical address of this record */
195 ErrorInfo_struct * err_info; /* pointer to the allocated mem */
196 int ctlr;
197 int cmd_type;
Mike Miller33079b22005-09-13 01:25:22 -0700198 long cmdindex;
Jens Axboee6e1ee92011-01-10 21:50:33 +0100199 struct list_head list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 struct request * rq;
201 struct completion *waiting;
202 int retry_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203 void * scsi_cmd;
Mike Miller5e216152010-06-02 12:58:06 -0700204 char pad[PADSIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205} CommandList_struct;
206
dann frazierb0284612010-02-17 16:53:31 -0700207/* Configuration Table Structure */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208typedef struct _HostWrite_struct {
209 DWORD TransportRequest;
210 DWORD Reserved;
211 DWORD CoalIntDelay;
212 DWORD CoalIntCount;
213} HostWrite_struct;
214
215typedef struct _CfgTable_struct {
216 BYTE Signature[4];
217 DWORD SpecValence;
Mike Miller5e216152010-06-02 12:58:06 -0700218#define SIMPLE_MODE 0x02
219#define PERFORMANT_MODE 0x04
220#define MEMQ_MODE 0x08
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 DWORD TransportSupport;
222 DWORD TransportActive;
223 HostWrite_struct HostWrite;
224 DWORD CmdsOutMax;
225 DWORD BusTypes;
Mike Miller5e216152010-06-02 12:58:06 -0700226 DWORD TransMethodOffset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 BYTE ServerName[16];
228 DWORD HeartBeat;
229 DWORD SCSI_Prefetch;
Don Brace5c07a312009-11-12 12:50:01 -0600230 DWORD MaxSGElements;
231 DWORD MaxLogicalUnits;
232 DWORD MaxPhysicalDrives;
233 DWORD MaxPhysicalDrivesPerLogicalUnit;
Mike Miller5e216152010-06-02 12:58:06 -0700234 DWORD MaxPerformantModeCommands;
Stephen M. Camerona6528d02010-07-19 13:46:22 -0500235 u8 reserved[0x78 - 0x58];
236 u32 misc_fw_support; /* offset 0x78 */
237#define MISC_FW_DOORBELL_RESET (0x02)
Stephen M. Cameron62710ae2011-05-03 14:53:00 -0500238 u8 driver_version[32];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239} CfgTable_struct;
Mike Miller5e216152010-06-02 12:58:06 -0700240
241struct TransTable_struct {
242 u32 BlockFetch0;
243 u32 BlockFetch1;
244 u32 BlockFetch2;
245 u32 BlockFetch3;
246 u32 BlockFetch4;
247 u32 BlockFetch5;
248 u32 BlockFetch6;
249 u32 BlockFetch7;
250 u32 RepQSize;
251 u32 RepQCount;
252 u32 RepQCtrAddrLow32;
253 u32 RepQCtrAddrHigh32;
254 u32 RepQAddr0Low32;
255 u32 RepQAddr0High32;
256};
257
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258#pragma pack()
dann frazierb0284612010-02-17 16:53:31 -0700259#endif /* CCISS_CMD_H */