blob: eaa7fdaa2e9df7de844008a5699075cff1740bfe [file] [log] [blame]
Stephen M. Cameronedd16362009-12-08 14:09:11 -08001/*
2 * Disk Array driver for HP Smart Array SAS controllers
Scott Teel51c35132014-02-18 13:57:26 -06003 * Copyright 2000, 2014 Hewlett-Packard Development Company, L.P.
Stephen M. Cameronedd16362009-12-08 14:09:11 -08004 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; version 2 of the License.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
12 * NON INFRINGEMENT. See the GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17 *
18 * Questions/Comments/Bugfixes to iss_storagedev@hp.com
19 *
20 */
21#ifndef HPSA_CMD_H
22#define HPSA_CMD_H
23
24/* general boundary defintions */
25#define SENSEINFOBYTES 32 /* may vary between hbas */
Stephen M. Camerond66ae082012-01-19 14:00:48 -060026#define SG_ENTRIES_IN_CMD 32 /* Max SG entries excluding chain blocks */
Stephen M. Cameron33a2ffc2010-02-25 14:03:27 -060027#define HPSA_SG_CHAIN 0x80000000
Matt Gatese1d9cbf2014-02-18 13:55:12 -060028#define HPSA_SG_LAST 0x40000000
Stephen M. Cameronedd16362009-12-08 14:09:11 -080029#define MAXREPLYQS 256
30
31/* Command Status value */
32#define CMD_SUCCESS 0x0000
33#define CMD_TARGET_STATUS 0x0001
34#define CMD_DATA_UNDERRUN 0x0002
35#define CMD_DATA_OVERRUN 0x0003
36#define CMD_INVALID 0x0004
37#define CMD_PROTOCOL_ERR 0x0005
38#define CMD_HARDWARE_ERR 0x0006
39#define CMD_CONNECTION_LOST 0x0007
40#define CMD_ABORTED 0x0008
41#define CMD_ABORT_FAILED 0x0009
42#define CMD_UNSOLICITED_ABORT 0x000A
43#define CMD_TIMEOUT 0x000B
44#define CMD_UNABORTABLE 0x000C
Stephen M. Cameron283b4a92014-02-18 13:55:33 -060045#define CMD_IOACCEL_DISABLED 0x000E
46
Stephen M. Cameronedd16362009-12-08 14:09:11 -080047
48/* Unit Attentions ASC's as defined for the MSA2012sa */
49#define POWER_OR_RESET 0x29
50#define STATE_CHANGED 0x2a
51#define UNIT_ATTENTION_CLEARED 0x2f
52#define LUN_FAILED 0x3e
53#define REPORT_LUNS_CHANGED 0x3f
54
55/* Unit Attentions ASCQ's as defined for the MSA2012sa */
56
57 /* These ASCQ's defined for ASC = POWER_OR_RESET */
58#define POWER_ON_RESET 0x00
59#define POWER_ON_REBOOT 0x01
60#define SCSI_BUS_RESET 0x02
61#define MSA_TARGET_RESET 0x03
62#define CONTROLLER_FAILOVER 0x04
63#define TRANSCEIVER_SE 0x05
64#define TRANSCEIVER_LVD 0x06
65
66 /* These ASCQ's defined for ASC = STATE_CHANGED */
67#define RESERVATION_PREEMPTED 0x03
68#define ASYM_ACCESS_CHANGED 0x06
69#define LUN_CAPACITY_CHANGED 0x09
70
71/* transfer direction */
72#define XFER_NONE 0x00
73#define XFER_WRITE 0x01
74#define XFER_READ 0x02
75#define XFER_RSVD 0x03
76
77/* task attribute */
78#define ATTR_UNTAGGED 0x00
79#define ATTR_SIMPLE 0x04
80#define ATTR_HEADOFQUEUE 0x05
81#define ATTR_ORDERED 0x06
82#define ATTR_ACA 0x07
83
84/* cdb type */
Scott Teel54b6e9e2014-02-18 13:56:45 -060085#define TYPE_CMD 0x00
86#define TYPE_MSG 0x01
87#define TYPE_IOACCEL2_CMD 0x81 /* 0x81 is not used by hardware */
Stephen M. Cameronedd16362009-12-08 14:09:11 -080088
Stephen M. Cameron75167d22012-05-01 11:42:51 -050089/* Message Types */
90#define HPSA_TASK_MANAGEMENT 0x00
91#define HPSA_RESET 0x01
92#define HPSA_SCAN 0x02
93#define HPSA_NOOP 0x03
94
95#define HPSA_CTLR_RESET_TYPE 0x00
96#define HPSA_BUS_RESET_TYPE 0x01
97#define HPSA_TARGET_RESET_TYPE 0x03
98#define HPSA_LUN_RESET_TYPE 0x04
99#define HPSA_NEXUS_RESET_TYPE 0x05
100
101/* Task Management Functions */
102#define HPSA_TMF_ABORT_TASK 0x00
103#define HPSA_TMF_ABORT_TASK_SET 0x01
104#define HPSA_TMF_CLEAR_ACA 0x02
105#define HPSA_TMF_CLEAR_TASK_SET 0x03
106#define HPSA_TMF_QUERY_TASK 0x04
107#define HPSA_TMF_QUERY_TASK_SET 0x05
108#define HPSA_TMF_QUERY_ASYNCEVENT 0x06
109
110
111
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800112/* config space register offsets */
113#define CFG_VENDORID 0x00
114#define CFG_DEVICEID 0x02
115#define CFG_I2OBAR 0x10
116#define CFG_MEM1BAR 0x14
117
118/* i2o space register offsets */
119#define I2O_IBDB_SET 0x20
120#define I2O_IBDB_CLEAR 0x70
121#define I2O_INT_STATUS 0x30
122#define I2O_INT_MASK 0x34
123#define I2O_IBPOST_Q 0x40
124#define I2O_OBPOST_Q 0x44
125#define I2O_DMA1_CFG 0x214
126
127/* Configuration Table */
128#define CFGTBL_ChangeReq 0x00000001l
129#define CFGTBL_AccCmds 0x00000001l
Stephen M. Cameron1df85522010-06-16 13:51:40 -0500130#define DOORBELL_CTLR_RESET 0x00000004l
Stephen M. Cameroncf0b08d2011-05-03 14:59:46 -0500131#define DOORBELL_CTLR_RESET2 0x00000020l
Stephen M. Cameron76438d02014-02-18 13:55:43 -0600132#define DOORBELL_CLEAR_EVENTS 0x00000040l
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800133
134#define CFGTBL_Trans_Simple 0x00000002l
Don Brace303932f2010-02-04 08:42:40 -0600135#define CFGTBL_Trans_Performant 0x00000004l
Matt Gatese1f7de02014-02-18 13:55:17 -0600136#define CFGTBL_Trans_io_accel1 0x00000080l
Stephen M. Cameron1f7cee82014-02-18 13:56:09 -0600137#define CFGTBL_Trans_io_accel2 0x00000100l
Stephen M. Cameron960a30e2011-02-15 15:33:03 -0600138#define CFGTBL_Trans_use_short_tags 0x20000000l
Matt Gates254f7962012-05-01 11:43:06 -0500139#define CFGTBL_Trans_enable_directed_msix (1 << 30)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800140
141#define CFGTBL_BusType_Ultra2 0x00000001l
142#define CFGTBL_BusType_Ultra3 0x00000002l
143#define CFGTBL_BusType_Fibre1G 0x00000100l
144#define CFGTBL_BusType_Fibre2G 0x00000200l
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600145
146/* VPD Inquiry types */
Stephen M. Cameron1b70150a2014-02-18 13:57:16 -0600147#define HPSA_VPD_SUPPORTED_PAGES 0x00
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600148#define HPSA_VPD_LV_DEVICE_GEOMETRY 0xC1
149#define HPSA_VPD_LV_IOACCEL_STATUS 0xC2
Stephen M. Cameron1b70150a2014-02-18 13:57:16 -0600150#define HPSA_VPD_HEADER_SZ 4
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600151
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800152struct vals32 {
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600153 u32 lower;
154 u32 upper;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800155};
156
157union u64bit {
158 struct vals32 val32;
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600159 u64 val;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800160};
161
162/* FIXME this is a per controller value (barf!) */
Scott Teelb7ec0212011-10-26 16:21:12 -0500163#define HPSA_MAX_LUN 1024
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800164#define HPSA_MAX_PHYS_LUN 1024
Scott Teelaca4a522012-01-19 14:01:19 -0600165#define MAX_EXT_TARGETS 32
Scott Teelb7ec0212011-10-26 16:21:12 -0500166#define HPSA_MAX_DEVICES (HPSA_MAX_PHYS_LUN + HPSA_MAX_LUN + \
Scott Teelaca4a522012-01-19 14:01:19 -0600167 MAX_EXT_TARGETS + 1) /* + 1 is for the controller itself */
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800168
169/* SCSI-3 Commands */
170#pragma pack(1)
171
172#define HPSA_INQUIRY 0x12
173struct InquiryData {
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600174 u8 data_byte[36];
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800175};
176
177#define HPSA_REPORT_LOG 0xc2 /* Report Logical LUNs */
178#define HPSA_REPORT_PHYS 0xc3 /* Report Physical LUNs */
Matt Gatesa93aa1f2014-02-18 13:55:07 -0600179#define HPSA_REPORT_PHYS_EXTENDED 0x02
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600180#define HPSA_CISS_READ 0xc0 /* CISS Read */
181#define HPSA_GET_RAID_MAP 0xc8 /* CISS Get RAID Layout Map */
182
183#define RAID_MAP_MAX_ENTRIES 256
184
185struct raid_map_disk_data {
186 u32 ioaccel_handle; /**< Handle to access this disk via the
187 * I/O accelerator */
188 u8 xor_mult[2]; /**< XOR multipliers for this position,
189 * valid for data disks only */
190 u8 reserved[2];
191};
192
193struct raid_map_data {
194 u32 structure_size; /* Size of entire structure in bytes */
195 u32 volume_blk_size; /* bytes / block in the volume */
196 u64 volume_blk_cnt; /* logical blocks on the volume */
197 u8 phys_blk_shift; /* Shift factor to convert between
198 * units of logical blocks and physical
199 * disk blocks */
200 u8 parity_rotation_shift; /* Shift factor to convert between units
201 * of logical stripes and physical
202 * stripes */
203 u16 strip_size; /* blocks used on each disk / stripe */
204 u64 disk_starting_blk; /* First disk block used in volume */
205 u64 disk_blk_cnt; /* disk blocks used by volume / disk */
206 u16 data_disks_per_row; /* data disk entries / row in the map */
207 u16 metadata_disks_per_row; /* mirror/parity disk entries / row
208 * in the map */
209 u16 row_cnt; /* rows in each layout map */
210 u16 layout_map_count; /* layout maps (1 map per mirror/parity
211 * group) */
Scott Teeldd0e19f2014-02-18 13:57:31 -0600212 u16 flags; /* Bit 0 set if encryption enabled */
213#define RAID_MAP_FLAG_ENCRYPT_ON 0x01
214 u16 dekindex; /* Data encryption key index. */
215 u8 reserved[16];
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600216 struct raid_map_disk_data data[RAID_MAP_MAX_ENTRIES];
217};
218
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800219struct ReportLUNdata {
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600220 u8 LUNListLength[4];
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600221 u8 extended_response_flag;
222 u8 reserved[3];
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600223 u8 LUN[HPSA_MAX_LUN][8];
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800224};
225
226struct ReportExtendedLUNdata {
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600227 u8 LUNListLength[4];
228 u8 extended_response_flag;
229 u8 reserved[3];
230 u8 LUN[HPSA_MAX_LUN][24];
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800231};
232
233struct SenseSubsystem_info {
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600234 u8 reserved[36];
235 u8 portname[8];
236 u8 reserved1[1108];
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800237};
238
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800239/* BMIC commands */
240#define BMIC_READ 0x26
241#define BMIC_WRITE 0x27
242#define BMIC_CACHE_FLUSH 0xc2
243#define HPSA_CACHE_FLUSH 0x01 /* C2 was already being used by HPSA */
Stephen M. Camerone85c5972012-05-01 11:43:42 -0500244#define BMIC_FLASH_FIRMWARE 0xF7
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800245
246/* Command List Structure */
247union SCSI3Addr {
248 struct {
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600249 u8 Dev;
250 u8 Bus:6;
251 u8 Mode:2; /* b00 */
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800252 } PeripDev;
253 struct {
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600254 u8 DevLSB;
255 u8 DevMSB:6;
256 u8 Mode:2; /* b01 */
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800257 } LogDev;
258 struct {
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600259 u8 Dev:5;
260 u8 Bus:3;
261 u8 Targ:6;
262 u8 Mode:2; /* b10 */
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800263 } LogUnit;
264};
265
266struct PhysDevAddr {
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600267 u32 TargetId:24;
268 u32 Bus:6;
269 u32 Mode:2;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800270 /* 2 level target device addr */
271 union SCSI3Addr Target[2];
272};
273
274struct LogDevAddr {
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600275 u32 VolId:30;
276 u32 Mode:2;
277 u8 reserved[4];
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800278};
279
280union LUNAddr {
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600281 u8 LunAddrBytes[8];
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800282 union SCSI3Addr SCSI3Lun[4];
283 struct PhysDevAddr PhysDev;
284 struct LogDevAddr LogDev;
285};
286
287struct CommandListHeader {
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600288 u8 ReplyQueue;
289 u8 SGList;
290 u16 SGTotal;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800291 struct vals32 Tag;
292 union LUNAddr LUN;
293};
294
295struct RequestBlock {
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600296 u8 CDBLen;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800297 struct {
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600298 u8 Type:3;
299 u8 Attribute:3;
300 u8 Direction:2;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800301 } Type;
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600302 u16 Timeout;
303 u8 CDB[16];
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800304};
305
306struct ErrDescriptor {
307 struct vals32 Addr;
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600308 u32 Len;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800309};
310
311struct SGDescriptor {
312 struct vals32 Addr;
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600313 u32 Len;
314 u32 Ext;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800315};
316
317union MoreErrInfo {
318 struct {
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600319 u8 Reserved[3];
320 u8 Type;
321 u32 ErrorInfo;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800322 } Common_Info;
323 struct {
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600324 u8 Reserved[2];
325 u8 offense_size; /* size of offending entry */
326 u8 offense_num; /* byte # of offense 0-base */
327 u32 offense_value;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800328 } Invalid_Cmd;
329};
330struct ErrorInfo {
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600331 u8 ScsiStatus;
332 u8 SenseLen;
333 u16 CommandStatus;
334 u32 ResidualCnt;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800335 union MoreErrInfo MoreErrInfo;
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600336 u8 SenseInfo[SENSEINFOBYTES];
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800337};
338/* Command types */
339#define CMD_IOCTL_PEND 0x01
340#define CMD_SCSI 0x03
Matt Gatese1f7de02014-02-18 13:55:17 -0600341#define CMD_IOACCEL1 0x04
Mike Millerb66cc252014-02-18 13:56:04 -0600342#define CMD_IOACCEL2 0x05
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800343
Don Brace303932f2010-02-04 08:42:40 -0600344#define DIRECT_LOOKUP_SHIFT 5
345#define DIRECT_LOOKUP_BIT 0x10
Stephen M. Camerond896f3f2011-01-06 14:47:53 -0600346#define DIRECT_LOOKUP_MASK (~((1 << DIRECT_LOOKUP_SHIFT) - 1))
Don Brace303932f2010-02-04 08:42:40 -0600347
348#define HPSA_ERROR_BIT 0x02
349struct ctlr_info; /* defined in hpsa.h */
350/* The size of this structure needs to be divisible by 32
351 * on all architectures because low 5 bits of the addresses
352 * are used as follows:
353 *
354 * bit 0: to device, used to indicate "performant mode" command
355 * from device, indidcates error status.
356 * bit 1-3: to device, indicates block fetch table entry for
357 * reducing DMA in fetching commands from host memory.
358 * bit 4: used to indicate whether tag is "direct lookup" (index),
359 * or a bus address.
360 */
361
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800362struct CommandList {
363 struct CommandListHeader Header;
364 struct RequestBlock Request;
365 struct ErrDescriptor ErrDesc;
Stephen M. Camerond66ae082012-01-19 14:00:48 -0600366 struct SGDescriptor SG[SG_ENTRIES_IN_CMD];
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800367 /* information associated with the command */
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600368 u32 busaddr; /* physical addr of this record */
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800369 struct ErrorInfo *err_info; /* pointer to the allocated mem */
370 struct ctlr_info *h;
371 int cmd_type;
372 long cmdindex;
Stephen M. Cameron9e0fc762011-02-15 15:32:48 -0600373 struct list_head list;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800374 struct request *rq;
375 struct completion *waiting;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800376 void *scsi_cmd;
Don Brace303932f2010-02-04 08:42:40 -0600377
378/* on 64 bit architectures, to get this to be 32-byte-aligned
Stephen M. Camerondb61bfc2010-02-25 14:03:22 -0600379 * it so happens we need PAD_64 bytes of padding, on 32 bit systems,
380 * we need PAD_32 bytes of padding (see below). This does that.
381 * If it happens that 64 bit and 32 bit systems need different
382 * padding, PAD_32 and PAD_64 can be set independently, and.
383 * the code below will do the right thing.
Don Brace303932f2010-02-04 08:42:40 -0600384 */
Stephen M. Camerondb61bfc2010-02-25 14:03:22 -0600385#define IS_32_BIT ((8 - sizeof(long))/4)
386#define IS_64_BIT (!IS_32_BIT)
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600387#define PAD_32 (36)
Stephen M. Cameron43aebfa2010-02-25 14:03:32 -0600388#define PAD_64 (4)
Stephen M. Camerondb61bfc2010-02-25 14:03:22 -0600389#define COMMANDLIST_PAD (IS_32_BIT * PAD_32 + IS_64_BIT * PAD_64)
Don Brace303932f2010-02-04 08:42:40 -0600390 u8 pad[COMMANDLIST_PAD];
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800391};
392
Matt Gatese1f7de02014-02-18 13:55:17 -0600393/* Max S/G elements in I/O accelerator command */
394#define IOACCEL1_MAXSGENTRIES 24
Mike Millerb66cc252014-02-18 13:56:04 -0600395#define IOACCEL2_MAXSGENTRIES 28
Matt Gatese1f7de02014-02-18 13:55:17 -0600396
397/*
398 * Structure for I/O accelerator (mode 1) commands.
399 * Note that this structure must be 128-byte aligned in size.
400 */
401struct io_accel1_cmd {
402 u16 dev_handle; /* 0x00 - 0x01 */
403 u8 reserved1; /* 0x02 */
404 u8 function; /* 0x03 */
405 u8 reserved2[8]; /* 0x04 - 0x0B */
406 u32 err_info; /* 0x0C - 0x0F */
407 u8 reserved3[2]; /* 0x10 - 0x11 */
408 u8 err_info_len; /* 0x12 */
409 u8 reserved4; /* 0x13 */
410 u8 sgl_offset; /* 0x14 */
411 u8 reserved5[7]; /* 0x15 - 0x1B */
412 u32 transfer_len; /* 0x1C - 0x1F */
413 u8 reserved6[4]; /* 0x20 - 0x23 */
414 u16 io_flags; /* 0x24 - 0x25 */
415 u8 reserved7[14]; /* 0x26 - 0x33 */
416 u8 LUN[8]; /* 0x34 - 0x3B */
417 u32 control; /* 0x3C - 0x3F */
418 u8 CDB[16]; /* 0x40 - 0x4F */
419 u8 reserved8[16]; /* 0x50 - 0x5F */
420 u16 host_context_flags; /* 0x60 - 0x61 */
421 u16 timeout_sec; /* 0x62 - 0x63 */
422 u8 ReplyQueue; /* 0x64 */
423 u8 reserved9[3]; /* 0x65 - 0x67 */
424 struct vals32 Tag; /* 0x68 - 0x6F */
425 struct vals32 host_addr; /* 0x70 - 0x77 */
426 u8 CISS_LUN[8]; /* 0x78 - 0x7F */
427 struct SGDescriptor SG[IOACCEL1_MAXSGENTRIES];
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600428#define IOACCEL1_PAD_64 0
429#define IOACCEL1_PAD_32 0
430#define IOACCEL1_PAD (IS_32_BIT * IOACCEL1_PAD_32 + \
431 IS_64_BIT * IOACCEL1_PAD_64)
432 u8 pad[IOACCEL1_PAD];
Matt Gatese1f7de02014-02-18 13:55:17 -0600433};
434
435#define IOACCEL1_FUNCTION_SCSIIO 0x00
436#define IOACCEL1_SGLOFFSET 32
437
438#define IOACCEL1_IOFLAGS_IO_REQ 0x4000
439#define IOACCEL1_IOFLAGS_CDBLEN_MASK 0x001F
440#define IOACCEL1_IOFLAGS_CDBLEN_MAX 16
441
442#define IOACCEL1_CONTROL_NODATAXFER 0x00000000
443#define IOACCEL1_CONTROL_DATA_OUT 0x01000000
444#define IOACCEL1_CONTROL_DATA_IN 0x02000000
445#define IOACCEL1_CONTROL_TASKPRIO_MASK 0x00007800
446#define IOACCEL1_CONTROL_TASKPRIO_SHIFT 11
447#define IOACCEL1_CONTROL_SIMPLEQUEUE 0x00000000
448#define IOACCEL1_CONTROL_HEADOFQUEUE 0x00000100
449#define IOACCEL1_CONTROL_ORDEREDQUEUE 0x00000200
450#define IOACCEL1_CONTROL_ACA 0x00000400
451
452#define IOACCEL1_HCFLAGS_CISS_FORMAT 0x0013
453
454#define IOACCEL1_BUSADDR_CMDTYPE 0x00000060
455
Mike Millerb66cc252014-02-18 13:56:04 -0600456struct ioaccel2_sg_element {
457 u64 address;
458 u32 length;
459 u8 reserved[3];
460 u8 chain_indicator;
461#define IOACCEL2_CHAIN 0x80
462};
463
464/*
465 * SCSI Response Format structure for IO Accelerator Mode 2
466 */
467struct io_accel2_scsi_response {
468 u8 IU_type;
469#define IOACCEL2_IU_TYPE_SRF 0x60
470 u8 reserved1[3];
471 u8 req_id[4]; /* request identifier */
472 u8 reserved2[4];
473 u8 serv_response; /* service response */
474#define IOACCEL2_SERV_RESPONSE_COMPLETE 0x000
475#define IOACCEL2_SERV_RESPONSE_FAILURE 0x001
476#define IOACCEL2_SERV_RESPONSE_TMF_COMPLETE 0x002
477#define IOACCEL2_SERV_RESPONSE_TMF_SUCCESS 0x003
478#define IOACCEL2_SERV_RESPONSE_TMF_REJECTED 0x004
479#define IOACCEL2_SERV_RESPONSE_TMF_WRONG_LUN 0x005
480 u8 status; /* status */
481#define IOACCEL2_STATUS_SR_TASK_COMP_GOOD 0x00
482#define IOACCEL2_STATUS_SR_TASK_COMP_CHK_COND 0x02
483#define IOACCEL2_STATUS_SR_TASK_COMP_BUSY 0x08
484#define IOACCEL2_STATUS_SR_TASK_COMP_RES_CON 0x18
485#define IOACCEL2_STATUS_SR_TASK_COMP_SET_FULL 0x28
486#define IOACCEL2_STATUS_SR_TASK_COMP_ABORTED 0x40
Scott Teelc3497752014-02-18 13:56:34 -0600487#define IOACCEL2_STATUS_SR_IOACCEL_DISABLED 0x0E
Mike Millerb66cc252014-02-18 13:56:04 -0600488 u8 data_present; /* low 2 bits */
489#define IOACCEL2_NO_DATAPRESENT 0x000
490#define IOACCEL2_RESPONSE_DATAPRESENT 0x001
491#define IOACCEL2_SENSE_DATA_PRESENT 0x002
492#define IOACCEL2_RESERVED 0x003
493 u8 sense_data_len; /* sense/response data length */
494 u8 resid_cnt[4]; /* residual count */
495 u8 sense_data_buff[32]; /* sense/response data buffer */
496};
497
498#define IOACCEL2_64_PAD 76
499#define IOACCEL2_32_PAD 76
500#define IOACCEL2_PAD (IS_32_BIT * IOACCEL2_32_PAD + \
501 IS_64_BIT * IOACCEL2_64_PAD)
502/*
503 * Structure for I/O accelerator (mode 2 or m2) commands.
504 * Note that this structure must be 128-byte aligned in size.
505 */
506struct io_accel2_cmd {
507 u8 IU_type; /* IU Type */
Scott Teeldd0e19f2014-02-18 13:57:31 -0600508 u8 direction; /* direction, memtype, and encryption */
509#define IOACCEL2_DIRECTION_MASK 0x03 /* bits 0,1: direction */
510#define IOACCEL2_DIRECTION_MEMTYPE_MASK 0x04 /* bit 2: memtype source/dest */
511 /* 0b=PCIe, 1b=DDR */
512#define IOACCEL2_DIRECTION_ENCRYPT_MASK 0x08 /* bit 3: encryption flag */
513 /* 0=off, 1=on */
Mike Millerb66cc252014-02-18 13:56:04 -0600514 u8 reply_queue; /* Reply Queue ID */
515 u8 reserved1; /* Reserved */
516 u32 scsi_nexus; /* Device Handle */
Scott Teeldd0e19f2014-02-18 13:57:31 -0600517 u32 Tag; /* cciss tag, lower 4 bytes only */
518 u32 tweak_lower; /* Encryption tweak, lower 4 bytes */
Mike Millerb66cc252014-02-18 13:56:04 -0600519 u8 cdb[16]; /* SCSI Command Descriptor Block */
520 u8 cciss_lun[8]; /* 8 byte SCSI address */
521 u32 data_len; /* Total bytes to transfer */
522 u8 cmd_priority_task_attr; /* priority and task attrs */
523#define IOACCEL2_PRIORITY_MASK 0x78
524#define IOACCEL2_ATTR_MASK 0x07
525 u8 sg_count; /* Number of sg elements */
Scott Teeldd0e19f2014-02-18 13:57:31 -0600526 u16 dekindex; /* Data encryption key index */
Mike Millerb66cc252014-02-18 13:56:04 -0600527 u64 err_ptr; /* Error Pointer */
528 u32 err_len; /* Error Length*/
Scott Teeldd0e19f2014-02-18 13:57:31 -0600529 u32 tweak_upper; /* Encryption tweak, upper 4 bytes */
Mike Millerb66cc252014-02-18 13:56:04 -0600530 struct ioaccel2_sg_element sg[IOACCEL2_MAXSGENTRIES];
531 struct io_accel2_scsi_response error_data;
532 u8 pad[IOACCEL2_PAD];
533};
534
535/*
536 * defines for Mode 2 command struct
537 * FIXME: this can't be all I need mfm
538 */
539#define IOACCEL2_IU_TYPE 0x40
Scott Teel54b6e9e2014-02-18 13:56:45 -0600540#define IOACCEL2_IU_TMF_TYPE 0x41
Mike Millerb66cc252014-02-18 13:56:04 -0600541#define IOACCEL2_DIR_NO_DATA 0x00
542#define IOACCEL2_DIR_DATA_IN 0x01
543#define IOACCEL2_DIR_DATA_OUT 0x02
544/*
545 * SCSI Task Management Request format for Accelerator Mode 2
546 */
547struct hpsa_tmf_struct {
548 u8 iu_type; /* Information Unit Type */
549 u8 reply_queue; /* Reply Queue ID */
550 u8 tmf; /* Task Management Function */
551 u8 reserved1; /* byte 3 Reserved */
552 u32 it_nexus; /* SCSI I-T Nexus */
553 u8 lun_id[8]; /* LUN ID for TMF request */
554 struct vals32 Tag; /* cciss tag associated w/ request */
555 struct vals32 abort_tag;/* cciss tag of SCSI cmd or task to abort */
556 u64 error_ptr; /* Error Pointer */
557 u32 error_len; /* Error Length */
558};
559
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800560/* Configuration Table Structure */
561struct HostWrite {
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600562 u32 TransportRequest;
Stephen M. Cameronb9af4932014-02-18 13:56:29 -0600563 u32 command_pool_addr_hi;
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600564 u32 CoalIntDelay;
565 u32 CoalIntCount;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800566};
567
Don Brace303932f2010-02-04 08:42:40 -0600568#define SIMPLE_MODE 0x02
569#define PERFORMANT_MODE 0x04
570#define MEMQ_MODE 0x08
Matt Gatese1f7de02014-02-18 13:55:17 -0600571#define IOACCEL_MODE_1 0x80
Don Brace303932f2010-02-04 08:42:40 -0600572
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600573#define DRIVER_SUPPORT_UA_ENABLE 0x00000001
574
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800575struct CfgTable {
Don Brace303932f2010-02-04 08:42:40 -0600576 u8 Signature[4];
577 u32 SpecValence;
578 u32 TransportSupport;
579 u32 TransportActive;
580 struct HostWrite HostWrite;
581 u32 CmdsOutMax;
582 u32 BusTypes;
583 u32 TransMethodOffset;
584 u8 ServerName[16];
585 u32 HeartBeat;
Stephen M. Cameron97a5e982013-12-04 17:10:16 -0600586 u32 driver_support;
587#define ENABLE_SCSI_PREFETCH 0x100
Stephen M. Cameron28e13442013-12-04 17:10:21 -0600588#define ENABLE_UNIT_ATTN 0x01
Don Brace303932f2010-02-04 08:42:40 -0600589 u32 MaxScatterGatherElements;
590 u32 MaxLogicalUnits;
591 u32 MaxPhysicalDevices;
592 u32 MaxPhysicalDrivesPerLogicalUnit;
593 u32 MaxPerformantModeCommands;
Stephen M. Cameron75167d22012-05-01 11:42:51 -0500594 u32 MaxBlockFetch;
595 u32 PowerConservationSupport;
596 u32 PowerConservationEnable;
597 u32 TMFSupportFlags;
598 u8 TMFTagMask[8];
599 u8 reserved[0x78 - 0x70];
Stephen M. Cameron1df85522010-06-16 13:51:40 -0500600 u32 misc_fw_support; /* offset 0x78 */
601#define MISC_FW_DOORBELL_RESET (0x02)
Stephen M. Cameroncf0b08d2011-05-03 14:59:46 -0500602#define MISC_FW_DOORBELL_RESET2 (0x010)
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600603#define MISC_FW_RAID_OFFLOAD_BASIC (0x020)
604#define MISC_FW_EVENT_NOTIFY (0x080)
Stephen M. Cameron580ada32011-05-03 14:59:10 -0500605 u8 driver_version[32];
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600606 u32 max_cached_write_size;
607 u8 driver_scratchpad[16];
608 u32 max_error_info_length;
609 u32 io_accel_max_embedded_sg_count;
610 u32 io_accel_request_size_offset;
611 u32 event_notify;
Stephen M. Cameron76438d02014-02-18 13:55:43 -0600612#define HPSA_EVENT_NOTIFY_ACCEL_IO_PATH_STATE_CHANGE (1 << 30)
613#define HPSA_EVENT_NOTIFY_ACCEL_IO_PATH_CONFIG_CHANGE (1 << 31)
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600614 u32 clear_event_notify;
Don Brace303932f2010-02-04 08:42:40 -0600615};
616
617#define NUM_BLOCKFETCH_ENTRIES 8
618struct TransTable_struct {
619 u32 BlockFetch[NUM_BLOCKFETCH_ENTRIES];
620 u32 RepQSize;
621 u32 RepQCount;
622 u32 RepQCtrAddrLow32;
623 u32 RepQCtrAddrHigh32;
Matt Gates254f7962012-05-01 11:43:06 -0500624#define MAX_REPLY_QUEUES 8
625 struct vals32 RepQAddr[MAX_REPLY_QUEUES];
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800626};
627
628struct hpsa_pci_info {
629 unsigned char bus;
630 unsigned char dev_fn;
631 unsigned short domain;
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600632 u32 board_id;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800633};
634
635#pragma pack()
636#endif /* HPSA_CMD_H */