xref: /openbmc/linux/drivers/scsi/hpsa_cmd.h (revision 9cfc5c90)
1 /*
2  *    Disk Array driver for HP Smart Array SAS controllers
3  *    Copyright 2014-2015 PMC-Sierra, Inc.
4  *    Copyright 2000,2009-2015 Hewlett-Packard Development Company, L.P.
5  *
6  *    This program is free software; you can redistribute it and/or modify
7  *    it under the terms of the GNU General Public License as published by
8  *    the Free Software Foundation; version 2 of the License.
9  *
10  *    This program is distributed in the hope that it will be useful,
11  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *    MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
13  *    NON INFRINGEMENT.  See the GNU General Public License for more details.
14  *
15  *    Questions/Comments/Bugfixes to storagedev@pmcs.com
16  *
17  */
18 #ifndef HPSA_CMD_H
19 #define HPSA_CMD_H
20 
21 /* general boundary defintions */
22 #define SENSEINFOBYTES          32 /* may vary between hbas */
23 #define SG_ENTRIES_IN_CMD	32 /* Max SG entries excluding chain blocks */
24 #define HPSA_SG_CHAIN		0x80000000
25 #define HPSA_SG_LAST		0x40000000
26 #define MAXREPLYQS              256
27 
28 /* Command Status value */
29 #define CMD_SUCCESS             0x0000
30 #define CMD_TARGET_STATUS       0x0001
31 #define CMD_DATA_UNDERRUN       0x0002
32 #define CMD_DATA_OVERRUN        0x0003
33 #define CMD_INVALID             0x0004
34 #define CMD_PROTOCOL_ERR        0x0005
35 #define CMD_HARDWARE_ERR        0x0006
36 #define CMD_CONNECTION_LOST     0x0007
37 #define CMD_ABORTED             0x0008
38 #define CMD_ABORT_FAILED        0x0009
39 #define CMD_UNSOLICITED_ABORT   0x000A
40 #define CMD_TIMEOUT             0x000B
41 #define CMD_UNABORTABLE		0x000C
42 #define CMD_TMF_STATUS		0x000D
43 #define CMD_IOACCEL_DISABLED	0x000E
44 #define CMD_CTLR_LOCKUP		0xffff
45 /* Note: CMD_CTLR_LOCKUP is not a value defined by the CISS spec
46  * it is a value defined by the driver that commands can be marked
47  * with when a controller lockup has been detected by the driver
48  */
49 
50 /* TMF function status values */
51 #define CISS_TMF_COMPLETE	0x00
52 #define CISS_TMF_INVALID_FRAME	0x02
53 #define CISS_TMF_NOT_SUPPORTED	0x04
54 #define CISS_TMF_FAILED		0x05
55 #define CISS_TMF_SUCCESS	0x08
56 #define CISS_TMF_WRONG_LUN	0x09
57 #define CISS_TMF_OVERLAPPED_TAG 0x0a
58 
59 /* Unit Attentions ASC's as defined for the MSA2012sa */
60 #define POWER_OR_RESET			0x29
61 #define STATE_CHANGED			0x2a
62 #define UNIT_ATTENTION_CLEARED		0x2f
63 #define LUN_FAILED			0x3e
64 #define REPORT_LUNS_CHANGED		0x3f
65 
66 /* Unit Attentions ASCQ's as defined for the MSA2012sa */
67 
68 	/* These ASCQ's defined for ASC = POWER_OR_RESET */
69 #define POWER_ON_RESET			0x00
70 #define POWER_ON_REBOOT			0x01
71 #define SCSI_BUS_RESET			0x02
72 #define MSA_TARGET_RESET		0x03
73 #define CONTROLLER_FAILOVER		0x04
74 #define TRANSCEIVER_SE			0x05
75 #define TRANSCEIVER_LVD			0x06
76 
77 	/* These ASCQ's defined for ASC = STATE_CHANGED */
78 #define RESERVATION_PREEMPTED		0x03
79 #define ASYM_ACCESS_CHANGED		0x06
80 #define LUN_CAPACITY_CHANGED		0x09
81 
82 /* transfer direction */
83 #define XFER_NONE               0x00
84 #define XFER_WRITE              0x01
85 #define XFER_READ               0x02
86 #define XFER_RSVD               0x03
87 
88 /* task attribute */
89 #define ATTR_UNTAGGED           0x00
90 #define ATTR_SIMPLE             0x04
91 #define ATTR_HEADOFQUEUE        0x05
92 #define ATTR_ORDERED            0x06
93 #define ATTR_ACA                0x07
94 
95 /* cdb type */
96 #define TYPE_CMD		0x00
97 #define TYPE_MSG		0x01
98 #define TYPE_IOACCEL2_CMD	0x81 /* 0x81 is not used by hardware */
99 
100 /* Message Types  */
101 #define HPSA_TASK_MANAGEMENT    0x00
102 #define HPSA_RESET              0x01
103 #define HPSA_SCAN               0x02
104 #define HPSA_NOOP               0x03
105 
106 #define HPSA_CTLR_RESET_TYPE    0x00
107 #define HPSA_BUS_RESET_TYPE     0x01
108 #define HPSA_TARGET_RESET_TYPE  0x03
109 #define HPSA_LUN_RESET_TYPE     0x04
110 #define HPSA_NEXUS_RESET_TYPE   0x05
111 
112 /* Task Management Functions */
113 #define HPSA_TMF_ABORT_TASK     0x00
114 #define HPSA_TMF_ABORT_TASK_SET 0x01
115 #define HPSA_TMF_CLEAR_ACA      0x02
116 #define HPSA_TMF_CLEAR_TASK_SET 0x03
117 #define HPSA_TMF_QUERY_TASK     0x04
118 #define HPSA_TMF_QUERY_TASK_SET 0x05
119 #define HPSA_TMF_QUERY_ASYNCEVENT 0x06
120 
121 
122 
123 /* config space register offsets */
124 #define CFG_VENDORID            0x00
125 #define CFG_DEVICEID            0x02
126 #define CFG_I2OBAR              0x10
127 #define CFG_MEM1BAR             0x14
128 
129 /* i2o space register offsets */
130 #define I2O_IBDB_SET            0x20
131 #define I2O_IBDB_CLEAR          0x70
132 #define I2O_INT_STATUS          0x30
133 #define I2O_INT_MASK            0x34
134 #define I2O_IBPOST_Q            0x40
135 #define I2O_OBPOST_Q            0x44
136 #define I2O_DMA1_CFG		0x214
137 
138 /* Configuration Table */
139 #define CFGTBL_ChangeReq        0x00000001l
140 #define CFGTBL_AccCmds          0x00000001l
141 #define DOORBELL_CTLR_RESET	0x00000004l
142 #define DOORBELL_CTLR_RESET2	0x00000020l
143 #define DOORBELL_CLEAR_EVENTS	0x00000040l
144 
145 #define CFGTBL_Trans_Simple     0x00000002l
146 #define CFGTBL_Trans_Performant 0x00000004l
147 #define CFGTBL_Trans_io_accel1	0x00000080l
148 #define CFGTBL_Trans_io_accel2	0x00000100l
149 #define CFGTBL_Trans_use_short_tags 0x20000000l
150 #define CFGTBL_Trans_enable_directed_msix (1 << 30)
151 
152 #define CFGTBL_BusType_Ultra2   0x00000001l
153 #define CFGTBL_BusType_Ultra3   0x00000002l
154 #define CFGTBL_BusType_Fibre1G  0x00000100l
155 #define CFGTBL_BusType_Fibre2G  0x00000200l
156 
157 /* VPD Inquiry types */
158 #define HPSA_VPD_SUPPORTED_PAGES        0x00
159 #define HPSA_VPD_LV_DEVICE_GEOMETRY     0xC1
160 #define HPSA_VPD_LV_IOACCEL_STATUS      0xC2
161 #define HPSA_VPD_LV_STATUS		0xC3
162 #define HPSA_VPD_HEADER_SZ              4
163 
164 /* Logical volume states */
165 #define HPSA_VPD_LV_STATUS_UNSUPPORTED			0xff
166 #define HPSA_LV_OK                                      0x0
167 #define HPSA_LV_NOT_AVAILABLE				0x0b
168 #define HPSA_LV_UNDERGOING_ERASE			0x0F
169 #define HPSA_LV_UNDERGOING_RPI				0x12
170 #define HPSA_LV_PENDING_RPI				0x13
171 #define HPSA_LV_ENCRYPTED_NO_KEY			0x14
172 #define HPSA_LV_PLAINTEXT_IN_ENCRYPT_ONLY_CONTROLLER	0x15
173 #define HPSA_LV_UNDERGOING_ENCRYPTION			0x16
174 #define HPSA_LV_UNDERGOING_ENCRYPTION_REKEYING		0x17
175 #define HPSA_LV_ENCRYPTED_IN_NON_ENCRYPTED_CONTROLLER	0x18
176 #define HPSA_LV_PENDING_ENCRYPTION			0x19
177 #define HPSA_LV_PENDING_ENCRYPTION_REKEYING		0x1A
178 
179 struct vals32 {
180 	u32   lower;
181 	u32   upper;
182 };
183 
184 union u64bit {
185 	struct vals32 val32;
186 	u64 val;
187 };
188 
189 /* FIXME this is a per controller value (barf!) */
190 #define HPSA_MAX_LUN 1024
191 #define HPSA_MAX_PHYS_LUN 1024
192 #define MAX_EXT_TARGETS 32
193 #define HPSA_MAX_DEVICES (HPSA_MAX_PHYS_LUN + HPSA_MAX_LUN + \
194 	MAX_EXT_TARGETS + 1) /* + 1 is for the controller itself */
195 
196 /* SCSI-3 Commands */
197 #pragma pack(1)
198 
199 #define HPSA_INQUIRY 0x12
200 struct InquiryData {
201 	u8 data_byte[36];
202 };
203 
204 #define HPSA_REPORT_LOG 0xc2    /* Report Logical LUNs */
205 #define HPSA_REPORT_PHYS 0xc3   /* Report Physical LUNs */
206 #define HPSA_REPORT_PHYS_EXTENDED 0x02
207 #define HPSA_CISS_READ	0xc0	/* CISS Read */
208 #define HPSA_GET_RAID_MAP 0xc8	/* CISS Get RAID Layout Map */
209 
210 #define RAID_MAP_MAX_ENTRIES   256
211 
212 struct raid_map_disk_data {
213 	u32   ioaccel_handle;         /**< Handle to access this disk via the
214 					*  I/O accelerator */
215 	u8    xor_mult[2];            /**< XOR multipliers for this position,
216 					*  valid for data disks only */
217 	u8    reserved[2];
218 };
219 
220 struct raid_map_data {
221 	__le32   structure_size;	/* Size of entire structure in bytes */
222 	__le32   volume_blk_size;	/* bytes / block in the volume */
223 	__le64   volume_blk_cnt;	/* logical blocks on the volume */
224 	u8    phys_blk_shift;		/* Shift factor to convert between
225 					 * units of logical blocks and physical
226 					 * disk blocks */
227 	u8    parity_rotation_shift;	/* Shift factor to convert between units
228 					 * of logical stripes and physical
229 					 * stripes */
230 	__le16   strip_size;		/* blocks used on each disk / stripe */
231 	__le64   disk_starting_blk;	/* First disk block used in volume */
232 	__le64   disk_blk_cnt;		/* disk blocks used by volume / disk */
233 	__le16   data_disks_per_row;	/* data disk entries / row in the map */
234 	__le16   metadata_disks_per_row;/* mirror/parity disk entries / row
235 					 * in the map */
236 	__le16   row_cnt;		/* rows in each layout map */
237 	__le16   layout_map_count;	/* layout maps (1 map per mirror/parity
238 					 * group) */
239 	__le16   flags;			/* Bit 0 set if encryption enabled */
240 #define RAID_MAP_FLAG_ENCRYPT_ON  0x01
241 	__le16   dekindex;		/* Data encryption key index. */
242 	u8    reserved[16];
243 	struct raid_map_disk_data data[RAID_MAP_MAX_ENTRIES];
244 };
245 
246 struct ReportLUNdata {
247 	u8 LUNListLength[4];
248 	u8 extended_response_flag;
249 	u8 reserved[3];
250 	u8 LUN[HPSA_MAX_LUN][8];
251 };
252 
253 struct ext_report_lun_entry {
254 	u8 lunid[8];
255 #define MASKED_DEVICE(x) ((x)[3] & 0xC0)
256 #define GET_BMIC_BUS(lunid) ((lunid)[7] & 0x3F)
257 #define GET_BMIC_LEVEL_TWO_TARGET(lunid) ((lunid)[6])
258 #define GET_BMIC_DRIVE_NUMBER(lunid) (((GET_BMIC_BUS((lunid)) - 1) << 8) + \
259 			GET_BMIC_LEVEL_TWO_TARGET((lunid)))
260 	u8 wwid[8];
261 	u8 device_type;
262 	u8 device_flags;
263 	u8 lun_count; /* multi-lun device, how many luns */
264 	u8 redundant_paths;
265 	u32 ioaccel_handle; /* ioaccel1 only uses lower 16 bits */
266 };
267 
268 struct ReportExtendedLUNdata {
269 	u8 LUNListLength[4];
270 	u8 extended_response_flag;
271 	u8 reserved[3];
272 	struct ext_report_lun_entry LUN[HPSA_MAX_PHYS_LUN];
273 };
274 
275 struct SenseSubsystem_info {
276 	u8 reserved[36];
277 	u8 portname[8];
278 	u8 reserved1[1108];
279 };
280 
281 /* BMIC commands */
282 #define BMIC_READ 0x26
283 #define BMIC_WRITE 0x27
284 #define BMIC_CACHE_FLUSH 0xc2
285 #define HPSA_CACHE_FLUSH 0x01	/* C2 was already being used by HPSA */
286 #define BMIC_FLASH_FIRMWARE 0xF7
287 #define BMIC_SENSE_CONTROLLER_PARAMETERS 0x64
288 #define BMIC_IDENTIFY_PHYSICAL_DEVICE 0x15
289 #define BMIC_IDENTIFY_CONTROLLER 0x11
290 #define BMIC_SET_DIAG_OPTIONS 0xF4
291 #define BMIC_SENSE_DIAG_OPTIONS 0xF5
292 #define HPSA_DIAG_OPTS_DISABLE_RLD_CACHING 0x40000000
293 #define BMIC_SENSE_SUBSYSTEM_INFORMATION 0x66
294 
295 /* Command List Structure */
296 union SCSI3Addr {
297 	struct {
298 		u8 Dev;
299 		u8 Bus:6;
300 		u8 Mode:2;        /* b00 */
301 	} PeripDev;
302 	struct {
303 		u8 DevLSB;
304 		u8 DevMSB:6;
305 		u8 Mode:2;        /* b01 */
306 	} LogDev;
307 	struct {
308 		u8 Dev:5;
309 		u8 Bus:3;
310 		u8 Targ:6;
311 		u8 Mode:2;        /* b10 */
312 	} LogUnit;
313 };
314 
315 struct PhysDevAddr {
316 	u32             TargetId:24;
317 	u32             Bus:6;
318 	u32             Mode:2;
319 	/* 2 level target device addr */
320 	union SCSI3Addr  Target[2];
321 };
322 
323 struct LogDevAddr {
324 	u32            VolId:30;
325 	u32            Mode:2;
326 	u8             reserved[4];
327 };
328 
329 union LUNAddr {
330 	u8               LunAddrBytes[8];
331 	union SCSI3Addr    SCSI3Lun[4];
332 	struct PhysDevAddr PhysDev;
333 	struct LogDevAddr  LogDev;
334 };
335 
336 struct CommandListHeader {
337 	u8              ReplyQueue;
338 	u8              SGList;
339 	__le16          SGTotal;
340 	__le64		tag;
341 	union LUNAddr     LUN;
342 };
343 
344 struct RequestBlock {
345 	u8   CDBLen;
346 	/*
347 	 * type_attr_dir:
348 	 * type: low 3 bits
349 	 * attr: middle 3 bits
350 	 * dir: high 2 bits
351 	 */
352 	u8	type_attr_dir;
353 #define TYPE_ATTR_DIR(t, a, d) ((((d) & 0x03) << 6) |\
354 				(((a) & 0x07) << 3) |\
355 				((t) & 0x07))
356 #define GET_TYPE(tad) ((tad) & 0x07)
357 #define GET_ATTR(tad) (((tad) >> 3) & 0x07)
358 #define GET_DIR(tad) (((tad) >> 6) & 0x03)
359 	u16  Timeout;
360 	u8   CDB[16];
361 };
362 
363 struct ErrDescriptor {
364 	__le64 Addr;
365 	__le32 Len;
366 };
367 
368 struct SGDescriptor {
369 	__le64 Addr;
370 	__le32 Len;
371 	__le32 Ext;
372 };
373 
374 union MoreErrInfo {
375 	struct {
376 		u8  Reserved[3];
377 		u8  Type;
378 		u32 ErrorInfo;
379 	} Common_Info;
380 	struct {
381 		u8  Reserved[2];
382 		u8  offense_size; /* size of offending entry */
383 		u8  offense_num;  /* byte # of offense 0-base */
384 		u32 offense_value;
385 	} Invalid_Cmd;
386 };
387 struct ErrorInfo {
388 	u8               ScsiStatus;
389 	u8               SenseLen;
390 	u16              CommandStatus;
391 	u32              ResidualCnt;
392 	union MoreErrInfo  MoreErrInfo;
393 	u8               SenseInfo[SENSEINFOBYTES];
394 };
395 /* Command types */
396 #define CMD_IOCTL_PEND  0x01
397 #define CMD_SCSI	0x03
398 #define CMD_IOACCEL1	0x04
399 #define CMD_IOACCEL2	0x05
400 #define IOACCEL2_TMF	0x06
401 
402 #define DIRECT_LOOKUP_SHIFT 4
403 #define DIRECT_LOOKUP_MASK (~((1 << DIRECT_LOOKUP_SHIFT) - 1))
404 
405 #define HPSA_ERROR_BIT          0x02
406 struct ctlr_info; /* defined in hpsa.h */
407 /* The size of this structure needs to be divisible by 128
408  * on all architectures.  The low 4 bits of the addresses
409  * are used as follows:
410  *
411  * bit 0: to device, used to indicate "performant mode" command
412  *        from device, indidcates error status.
413  * bit 1-3: to device, indicates block fetch table entry for
414  *          reducing DMA in fetching commands from host memory.
415  */
416 
417 #define COMMANDLIST_ALIGNMENT 128
418 struct CommandList {
419 	struct CommandListHeader Header;
420 	struct RequestBlock      Request;
421 	struct ErrDescriptor     ErrDesc;
422 	struct SGDescriptor      SG[SG_ENTRIES_IN_CMD];
423 	/* information associated with the command */
424 	u32			   busaddr; /* physical addr of this record */
425 	struct ErrorInfo *err_info; /* pointer to the allocated mem */
426 	struct ctlr_info	   *h;
427 	int			   cmd_type;
428 	long			   cmdindex;
429 	struct completion *waiting;
430 	struct scsi_cmnd *scsi_cmd;
431 	struct work_struct work;
432 
433 	/*
434 	 * For commands using either of the two "ioaccel" paths to
435 	 * bypass the RAID stack and go directly to the physical disk
436 	 * phys_disk is a pointer to the hpsa_scsi_dev_t to which the
437 	 * i/o is destined.  We need to store that here because the command
438 	 * may potentially encounter TASK SET FULL and need to be resubmitted
439 	 * For "normal" i/o's not using the "ioaccel" paths, phys_disk is
440 	 * not used.
441 	 */
442 	struct hpsa_scsi_dev_t *phys_disk;
443 
444 	int abort_pending;
445 	struct hpsa_scsi_dev_t *reset_pending;
446 	atomic_t refcount; /* Must be last to avoid memset in hpsa_cmd_init() */
447 } __aligned(COMMANDLIST_ALIGNMENT);
448 
449 /* Max S/G elements in I/O accelerator command */
450 #define IOACCEL1_MAXSGENTRIES           24
451 #define IOACCEL2_MAXSGENTRIES		28
452 
453 /*
454  * Structure for I/O accelerator (mode 1) commands.
455  * Note that this structure must be 128-byte aligned in size.
456  */
457 #define IOACCEL1_COMMANDLIST_ALIGNMENT 128
458 struct io_accel1_cmd {
459 	__le16 dev_handle;		/* 0x00 - 0x01 */
460 	u8  reserved1;			/* 0x02 */
461 	u8  function;			/* 0x03 */
462 	u8  reserved2[8];		/* 0x04 - 0x0B */
463 	u32 err_info;			/* 0x0C - 0x0F */
464 	u8  reserved3[2];		/* 0x10 - 0x11 */
465 	u8  err_info_len;		/* 0x12 */
466 	u8  reserved4;			/* 0x13 */
467 	u8  sgl_offset;			/* 0x14 */
468 	u8  reserved5[7];		/* 0x15 - 0x1B */
469 	__le32 transfer_len;		/* 0x1C - 0x1F */
470 	u8  reserved6[4];		/* 0x20 - 0x23 */
471 	__le16 io_flags;		/* 0x24 - 0x25 */
472 	u8  reserved7[14];		/* 0x26 - 0x33 */
473 	u8  LUN[8];			/* 0x34 - 0x3B */
474 	__le32 control;			/* 0x3C - 0x3F */
475 	u8  CDB[16];			/* 0x40 - 0x4F */
476 	u8  reserved8[16];		/* 0x50 - 0x5F */
477 	__le16 host_context_flags;	/* 0x60 - 0x61 */
478 	__le16 timeout_sec;		/* 0x62 - 0x63 */
479 	u8  ReplyQueue;			/* 0x64 */
480 	u8  reserved9[3];		/* 0x65 - 0x67 */
481 	__le64 tag;			/* 0x68 - 0x6F */
482 	__le64 host_addr;		/* 0x70 - 0x77 */
483 	u8  CISS_LUN[8];		/* 0x78 - 0x7F */
484 	struct SGDescriptor SG[IOACCEL1_MAXSGENTRIES];
485 } __aligned(IOACCEL1_COMMANDLIST_ALIGNMENT);
486 
487 #define IOACCEL1_FUNCTION_SCSIIO        0x00
488 #define IOACCEL1_SGLOFFSET              32
489 
490 #define IOACCEL1_IOFLAGS_IO_REQ         0x4000
491 #define IOACCEL1_IOFLAGS_CDBLEN_MASK    0x001F
492 #define IOACCEL1_IOFLAGS_CDBLEN_MAX     16
493 
494 #define IOACCEL1_CONTROL_NODATAXFER     0x00000000
495 #define IOACCEL1_CONTROL_DATA_OUT       0x01000000
496 #define IOACCEL1_CONTROL_DATA_IN        0x02000000
497 #define IOACCEL1_CONTROL_TASKPRIO_MASK  0x00007800
498 #define IOACCEL1_CONTROL_TASKPRIO_SHIFT 11
499 #define IOACCEL1_CONTROL_SIMPLEQUEUE    0x00000000
500 #define IOACCEL1_CONTROL_HEADOFQUEUE    0x00000100
501 #define IOACCEL1_CONTROL_ORDEREDQUEUE   0x00000200
502 #define IOACCEL1_CONTROL_ACA            0x00000400
503 
504 #define IOACCEL1_HCFLAGS_CISS_FORMAT    0x0013
505 
506 #define IOACCEL1_BUSADDR_CMDTYPE        0x00000060
507 
508 struct ioaccel2_sg_element {
509 	__le64 address;
510 	__le32 length;
511 	u8 reserved[3];
512 	u8 chain_indicator;
513 #define IOACCEL2_CHAIN 0x80
514 };
515 
516 /*
517  * SCSI Response Format structure for IO Accelerator Mode 2
518  */
519 struct io_accel2_scsi_response {
520 	u8 IU_type;
521 #define IOACCEL2_IU_TYPE_SRF			0x60
522 	u8 reserved1[3];
523 	u8 req_id[4];		/* request identifier */
524 	u8 reserved2[4];
525 	u8 serv_response;		/* service response */
526 #define IOACCEL2_SERV_RESPONSE_COMPLETE		0x000
527 #define IOACCEL2_SERV_RESPONSE_FAILURE		0x001
528 #define IOACCEL2_SERV_RESPONSE_TMF_COMPLETE	0x002
529 #define IOACCEL2_SERV_RESPONSE_TMF_SUCCESS	0x003
530 #define IOACCEL2_SERV_RESPONSE_TMF_REJECTED	0x004
531 #define IOACCEL2_SERV_RESPONSE_TMF_WRONG_LUN	0x005
532 	u8 status;			/* status */
533 #define IOACCEL2_STATUS_SR_TASK_COMP_GOOD	0x00
534 #define IOACCEL2_STATUS_SR_TASK_COMP_CHK_COND	0x02
535 #define IOACCEL2_STATUS_SR_TASK_COMP_BUSY	0x08
536 #define IOACCEL2_STATUS_SR_TASK_COMP_RES_CON	0x18
537 #define IOACCEL2_STATUS_SR_TASK_COMP_SET_FULL	0x28
538 #define IOACCEL2_STATUS_SR_TASK_COMP_ABORTED	0x40
539 #define IOACCEL2_STATUS_SR_IOACCEL_DISABLED	0x0E
540 #define IOACCEL2_STATUS_SR_IO_ERROR		0x01
541 #define IOACCEL2_STATUS_SR_IO_ABORTED		0x02
542 #define IOACCEL2_STATUS_SR_NO_PATH_TO_DEVICE	0x03
543 #define IOACCEL2_STATUS_SR_INVALID_DEVICE	0x04
544 #define IOACCEL2_STATUS_SR_UNDERRUN		0x51
545 #define IOACCEL2_STATUS_SR_OVERRUN		0x75
546 	u8 data_present;		/* low 2 bits */
547 #define IOACCEL2_NO_DATAPRESENT		0x000
548 #define IOACCEL2_RESPONSE_DATAPRESENT	0x001
549 #define IOACCEL2_SENSE_DATA_PRESENT	0x002
550 #define IOACCEL2_RESERVED		0x003
551 	u8 sense_data_len;		/* sense/response data length */
552 	u8 resid_cnt[4];		/* residual count */
553 	u8 sense_data_buff[32];		/* sense/response data buffer */
554 };
555 
556 /*
557  * Structure for I/O accelerator (mode 2 or m2) commands.
558  * Note that this structure must be 128-byte aligned in size.
559  */
560 #define IOACCEL2_COMMANDLIST_ALIGNMENT 128
561 struct io_accel2_cmd {
562 	u8  IU_type;			/* IU Type */
563 	u8  direction;			/* direction, memtype, and encryption */
564 #define IOACCEL2_DIRECTION_MASK		0x03 /* bits 0,1: direction  */
565 #define IOACCEL2_DIRECTION_MEMTYPE_MASK	0x04 /* bit 2: memtype source/dest */
566 					     /*     0b=PCIe, 1b=DDR */
567 #define IOACCEL2_DIRECTION_ENCRYPT_MASK	0x08 /* bit 3: encryption flag */
568 					     /*     0=off, 1=on */
569 	u8  reply_queue;		/* Reply Queue ID */
570 	u8  reserved1;			/* Reserved */
571 	__le32 scsi_nexus;		/* Device Handle */
572 	__le32 Tag;			/* cciss tag, lower 4 bytes only */
573 	__le32 tweak_lower;		/* Encryption tweak, lower 4 bytes */
574 	u8  cdb[16];			/* SCSI Command Descriptor Block */
575 	u8  cciss_lun[8];		/* 8 byte SCSI address */
576 	__le32 data_len;		/* Total bytes to transfer */
577 	u8  cmd_priority_task_attr;	/* priority and task attrs */
578 #define IOACCEL2_PRIORITY_MASK 0x78
579 #define IOACCEL2_ATTR_MASK 0x07
580 	u8  sg_count;			/* Number of sg elements */
581 	__le16 dekindex;		/* Data encryption key index */
582 	__le64 err_ptr;			/* Error Pointer */
583 	__le32 err_len;			/* Error Length*/
584 	__le32 tweak_upper;		/* Encryption tweak, upper 4 bytes */
585 	struct ioaccel2_sg_element sg[IOACCEL2_MAXSGENTRIES];
586 	struct io_accel2_scsi_response error_data;
587 } __aligned(IOACCEL2_COMMANDLIST_ALIGNMENT);
588 
589 /*
590  * defines for Mode 2 command struct
591  * FIXME: this can't be all I need mfm
592  */
593 #define IOACCEL2_IU_TYPE	0x40
594 #define IOACCEL2_IU_TMF_TYPE	0x41
595 #define IOACCEL2_DIR_NO_DATA	0x00
596 #define IOACCEL2_DIR_DATA_IN	0x01
597 #define IOACCEL2_DIR_DATA_OUT	0x02
598 #define IOACCEL2_TMF_ABORT	0x01
599 /*
600  * SCSI Task Management Request format for Accelerator Mode 2
601  */
602 struct hpsa_tmf_struct {
603 	u8 iu_type;		/* Information Unit Type */
604 	u8 reply_queue;		/* Reply Queue ID */
605 	u8 tmf;			/* Task Management Function */
606 	u8 reserved1;		/* byte 3 Reserved */
607 	__le32 it_nexus;	/* SCSI I-T Nexus */
608 	u8 lun_id[8];		/* LUN ID for TMF request */
609 	__le64 tag;		/* cciss tag associated w/ request */
610 	__le64 abort_tag;	/* cciss tag of SCSI cmd or TMF to abort */
611 	__le64 error_ptr;		/* Error Pointer */
612 	__le32 error_len;		/* Error Length */
613 } __aligned(IOACCEL2_COMMANDLIST_ALIGNMENT);
614 
615 /* Configuration Table Structure */
616 struct HostWrite {
617 	__le32		TransportRequest;
618 	__le32		command_pool_addr_hi;
619 	__le32		CoalIntDelay;
620 	__le32		CoalIntCount;
621 };
622 
623 #define SIMPLE_MODE     0x02
624 #define PERFORMANT_MODE 0x04
625 #define MEMQ_MODE       0x08
626 #define IOACCEL_MODE_1  0x80
627 
628 #define DRIVER_SUPPORT_UA_ENABLE        0x00000001
629 
630 struct CfgTable {
631 	u8		Signature[4];
632 	__le32		SpecValence;
633 	__le32		TransportSupport;
634 	__le32		TransportActive;
635 	struct HostWrite HostWrite;
636 	__le32		CmdsOutMax;
637 	__le32		BusTypes;
638 	__le32		TransMethodOffset;
639 	u8		ServerName[16];
640 	__le32		HeartBeat;
641 	__le32		driver_support;
642 #define			ENABLE_SCSI_PREFETCH		0x100
643 #define			ENABLE_UNIT_ATTN		0x01
644 	__le32		MaxScatterGatherElements;
645 	__le32		MaxLogicalUnits;
646 	__le32		MaxPhysicalDevices;
647 	__le32		MaxPhysicalDrivesPerLogicalUnit;
648 	__le32		MaxPerformantModeCommands;
649 	__le32		MaxBlockFetch;
650 	__le32		PowerConservationSupport;
651 	__le32		PowerConservationEnable;
652 	__le32		TMFSupportFlags;
653 	u8		TMFTagMask[8];
654 	u8		reserved[0x78 - 0x70];
655 	__le32		misc_fw_support;		/* offset 0x78 */
656 #define			MISC_FW_DOORBELL_RESET		0x02
657 #define			MISC_FW_DOORBELL_RESET2		0x010
658 #define			MISC_FW_RAID_OFFLOAD_BASIC	0x020
659 #define			MISC_FW_EVENT_NOTIFY		0x080
660 	u8		driver_version[32];
661 	__le32		max_cached_write_size;
662 	u8		driver_scratchpad[16];
663 	__le32		max_error_info_length;
664 	__le32		io_accel_max_embedded_sg_count;
665 	__le32		io_accel_request_size_offset;
666 	__le32		event_notify;
667 #define		HPSA_EVENT_NOTIFY_ACCEL_IO_PATH_STATE_CHANGE (1 << 30)
668 #define		HPSA_EVENT_NOTIFY_ACCEL_IO_PATH_CONFIG_CHANGE (1 << 31)
669 	__le32		clear_event_notify;
670 };
671 
672 #define NUM_BLOCKFETCH_ENTRIES 8
673 struct TransTable_struct {
674 	__le32		BlockFetch[NUM_BLOCKFETCH_ENTRIES];
675 	__le32		RepQSize;
676 	__le32		RepQCount;
677 	__le32		RepQCtrAddrLow32;
678 	__le32		RepQCtrAddrHigh32;
679 #define MAX_REPLY_QUEUES 64
680 	struct vals32  RepQAddr[MAX_REPLY_QUEUES];
681 };
682 
683 struct hpsa_pci_info {
684 	unsigned char	bus;
685 	unsigned char	dev_fn;
686 	unsigned short	domain;
687 	u32		board_id;
688 };
689 
690 struct bmic_identify_controller {
691 	u8	configured_logical_drive_count;	/* offset 0 */
692 	u8	pad1[153];
693 	__le16	extended_logical_unit_count;	/* offset 154 */
694 	u8	pad2[136];
695 	u8	controller_mode;	/* offset 292 */
696 	u8	pad3[32];
697 };
698 
699 
700 struct bmic_identify_physical_device {
701 	u8    scsi_bus;          /* SCSI Bus number on controller */
702 	u8    scsi_id;           /* SCSI ID on this bus */
703 	__le16 block_size;	     /* sector size in bytes */
704 	__le32 total_blocks;	     /* number for sectors on drive */
705 	__le32 reserved_blocks;   /* controller reserved (RIS) */
706 	u8    model[40];         /* Physical Drive Model */
707 	u8    serial_number[40]; /* Drive Serial Number */
708 	u8    firmware_revision[8]; /* drive firmware revision */
709 	u8    scsi_inquiry_bits; /* inquiry byte 7 bits */
710 	u8    compaq_drive_stamp; /* 0 means drive not stamped */
711 	u8    last_failure_reason;
712 #define BMIC_LAST_FAILURE_TOO_SMALL_IN_LOAD_CONFIG		0x01
713 #define BMIC_LAST_FAILURE_ERROR_ERASING_RIS			0x02
714 #define BMIC_LAST_FAILURE_ERROR_SAVING_RIS			0x03
715 #define BMIC_LAST_FAILURE_FAIL_DRIVE_COMMAND			0x04
716 #define BMIC_LAST_FAILURE_MARK_BAD_FAILED			0x05
717 #define BMIC_LAST_FAILURE_MARK_BAD_FAILED_IN_FINISH_REMAP	0x06
718 #define BMIC_LAST_FAILURE_TIMEOUT				0x07
719 #define BMIC_LAST_FAILURE_AUTOSENSE_FAILED			0x08
720 #define BMIC_LAST_FAILURE_MEDIUM_ERROR_1			0x09
721 #define BMIC_LAST_FAILURE_MEDIUM_ERROR_2			0x0a
722 #define BMIC_LAST_FAILURE_NOT_READY_BAD_SENSE			0x0b
723 #define BMIC_LAST_FAILURE_NOT_READY				0x0c
724 #define BMIC_LAST_FAILURE_HARDWARE_ERROR			0x0d
725 #define BMIC_LAST_FAILURE_ABORTED_COMMAND			0x0e
726 #define BMIC_LAST_FAILURE_WRITE_PROTECTED			0x0f
727 #define BMIC_LAST_FAILURE_SPIN_UP_FAILURE_IN_RECOVER		0x10
728 #define BMIC_LAST_FAILURE_REBUILD_WRITE_ERROR			0x11
729 #define BMIC_LAST_FAILURE_TOO_SMALL_IN_HOT_PLUG			0x12
730 #define BMIC_LAST_FAILURE_BUS_RESET_RECOVERY_ABORTED		0x13
731 #define BMIC_LAST_FAILURE_REMOVED_IN_HOT_PLUG			0x14
732 #define BMIC_LAST_FAILURE_INIT_REQUEST_SENSE_FAILED		0x15
733 #define BMIC_LAST_FAILURE_INIT_START_UNIT_FAILED		0x16
734 #define BMIC_LAST_FAILURE_INQUIRY_FAILED			0x17
735 #define BMIC_LAST_FAILURE_NON_DISK_DEVICE			0x18
736 #define BMIC_LAST_FAILURE_READ_CAPACITY_FAILED			0x19
737 #define BMIC_LAST_FAILURE_INVALID_BLOCK_SIZE			0x1a
738 #define BMIC_LAST_FAILURE_HOT_PLUG_REQUEST_SENSE_FAILED		0x1b
739 #define BMIC_LAST_FAILURE_HOT_PLUG_START_UNIT_FAILED		0x1c
740 #define BMIC_LAST_FAILURE_WRITE_ERROR_AFTER_REMAP		0x1d
741 #define BMIC_LAST_FAILURE_INIT_RESET_RECOVERY_ABORTED		0x1e
742 #define BMIC_LAST_FAILURE_DEFERRED_WRITE_ERROR			0x1f
743 #define BMIC_LAST_FAILURE_MISSING_IN_SAVE_RIS			0x20
744 #define BMIC_LAST_FAILURE_WRONG_REPLACE				0x21
745 #define BMIC_LAST_FAILURE_GDP_VPD_INQUIRY_FAILED		0x22
746 #define BMIC_LAST_FAILURE_GDP_MODE_SENSE_FAILED			0x23
747 #define BMIC_LAST_FAILURE_DRIVE_NOT_IN_48BIT_MODE		0x24
748 #define BMIC_LAST_FAILURE_DRIVE_TYPE_MIX_IN_HOT_PLUG		0x25
749 #define BMIC_LAST_FAILURE_DRIVE_TYPE_MIX_IN_LOAD_CFG		0x26
750 #define BMIC_LAST_FAILURE_PROTOCOL_ADAPTER_FAILED		0x27
751 #define BMIC_LAST_FAILURE_FAULTY_ID_BAY_EMPTY			0x28
752 #define BMIC_LAST_FAILURE_FAULTY_ID_BAY_OCCUPIED		0x29
753 #define BMIC_LAST_FAILURE_FAULTY_ID_INVALID_BAY			0x2a
754 #define BMIC_LAST_FAILURE_WRITE_RETRIES_FAILED			0x2b
755 
756 #define BMIC_LAST_FAILURE_SMART_ERROR_REPORTED			0x37
757 #define BMIC_LAST_FAILURE_PHY_RESET_FAILED			0x38
758 #define BMIC_LAST_FAILURE_ONLY_ONE_CTLR_CAN_SEE_DRIVE		0x40
759 #define BMIC_LAST_FAILURE_KC_VOLUME_FAILED			0x41
760 #define BMIC_LAST_FAILURE_UNEXPECTED_REPLACEMENT		0x42
761 #define BMIC_LAST_FAILURE_OFFLINE_ERASE				0x80
762 #define BMIC_LAST_FAILURE_OFFLINE_TOO_SMALL			0x81
763 #define BMIC_LAST_FAILURE_OFFLINE_DRIVE_TYPE_MIX		0x82
764 #define BMIC_LAST_FAILURE_OFFLINE_ERASE_COMPLETE		0x83
765 
766 	u8     flags;
767 	u8     more_flags;
768 	u8     scsi_lun;          /* SCSI LUN for phys drive */
769 	u8     yet_more_flags;
770 	u8     even_more_flags;
771 	__le32 spi_speed_rules;/* SPI Speed data:Ultra disable diagnose */
772 	u8     phys_connector[2];         /* connector number on controller */
773 	u8     phys_box_on_bus;  /* phys enclosure this drive resides */
774 	u8     phys_bay_in_box;  /* phys drv bay this drive resides */
775 	__le32 rpm;              /* Drive rotational speed in rpm */
776 	u8     device_type;       /* type of drive */
777 	u8     sata_version;     /* only valid when drive_type is SATA */
778 	__le64 big_total_block_count;
779 	__le64 ris_starting_lba;
780 	__le32 ris_size;
781 	u8     wwid[20];
782 	u8     controller_phy_map[32];
783 	__le16 phy_count;
784 	u8     phy_connected_dev_type[256];
785 	u8     phy_to_drive_bay_num[256];
786 	__le16 phy_to_attached_dev_index[256];
787 	u8     box_index;
788 	u8     reserved;
789 	__le16 extra_physical_drive_flags;
790 #define BMIC_PHYS_DRIVE_SUPPORTS_GAS_GAUGE(idphydrv) \
791 	(idphydrv->extra_physical_drive_flags & (1 << 10))
792 	u8     negotiated_link_rate[256];
793 	u8     phy_to_phy_map[256];
794 	u8     redundant_path_present_map;
795 	u8     redundant_path_failure_map;
796 	u8     active_path_number;
797 	__le16 alternate_paths_phys_connector[8];
798 	u8     alternate_paths_phys_box_on_port[8];
799 	u8     multi_lun_device_lun_count;
800 	u8     minimum_good_fw_revision[8];
801 	u8     unique_inquiry_bytes[20];
802 	u8     current_temperature_degreesC;
803 	u8     temperature_threshold_degreesC;
804 	u8     max_temperature_degreesC;
805 	u8     logical_blocks_per_phys_block_exp; /* phyblocksize = 512*2^exp */
806 	__le16 current_queue_depth_limit;
807 	u8     switch_name[10];
808 	__le16 switch_port;
809 	u8     alternate_paths_switch_name[40];
810 	u8     alternate_paths_switch_port[8];
811 	__le16 power_on_hours; /* valid only if gas gauge supported */
812 	__le16 percent_endurance_used; /* valid only if gas gauge supported. */
813 #define BMIC_PHYS_DRIVE_SSD_WEAROUT(idphydrv) \
814 	((idphydrv->percent_endurance_used & 0x80) || \
815 	 (idphydrv->percent_endurance_used > 10000))
816 	u8     drive_authentication;
817 #define BMIC_PHYS_DRIVE_AUTHENTICATED(idphydrv) \
818 	(idphydrv->drive_authentication == 0x80)
819 	u8     smart_carrier_authentication;
820 #define BMIC_SMART_CARRIER_AUTHENTICATION_SUPPORTED(idphydrv) \
821 	(idphydrv->smart_carrier_authentication != 0x0)
822 #define BMIC_SMART_CARRIER_AUTHENTICATED(idphydrv) \
823 	(idphydrv->smart_carrier_authentication == 0x01)
824 	u8     smart_carrier_app_fw_version;
825 	u8     smart_carrier_bootloader_fw_version;
826 	u8     encryption_key_name[64];
827 	__le32 misc_drive_flags;
828 	__le16 dek_index;
829 	u8     padding[112];
830 };
831 
832 struct bmic_sense_subsystem_info {
833 	u8	primary_slot_number;
834 	u8	reserved[3];
835 	u8	chasis_serial_number[32];
836 	u8	primary_world_wide_id[8];
837 	u8	primary_array_serial_number[32]; /* NULL terminated */
838 	u8	primary_cache_serial_number[32]; /* NULL terminated */
839 	u8	reserved_2[8];
840 	u8	secondary_array_serial_number[32];
841 	u8	secondary_cache_serial_number[32];
842 	u8	pad[332];
843 };
844 
845 #pragma pack()
846 #endif /* HPSA_CMD_H */
847