3 *
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
7 *
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
12 *
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 *
19 * CDDL HEADER END
20 */
21
22 /*
23 * Copyright (c) 2000 to 2009, LSI Corporation.
24 * All rights reserved.
25 *
26 * Redistribution and use in source and binary forms of all code within
27 * this file that is exclusively owned by LSI, with or without
28 * modification, is permitted provided that, in addition to the CDDL 1.0
29 * License requirements, the following conditions are met:
30 *
31 * Neither the name of the author nor the names of its contributors may be
32 * used to endorse or promote products derived from this software without
33 * specific prior written permission.
34 *
35 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
36 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
37 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
38 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
39 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
40 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
41 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
42 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
43 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
46 * DAMAGE.
47 */
48
49 /*
50 * Name: mpi2_init.h
51 * Title: MPI SCSI initiator mode messages and structures
52 * Creation Date: June 23, 2006
53 *
54 * mpi2_init.h Version: 02.00.07
55 *
56 * Version History
57 * ---------------
58 *
59 * Date Version Description
60 * -------- -------- ------------------------------------------------------
61 * 04-30-07 02.00.00 Corresponds to Fusion-MPT MPI Specification Rev A.
62 * 10-31-07 02.00.01 Fixed name for pMpi2SCSITaskManagementRequest_t.
63 * 12-18-07 02.00.02 Modified Task Management Target Reset Method defines.
64 * 02-29-08 02.00.03 Added Query Task Set and Query Unit Attention.
65 * 03-03-08 02.00.04 Fixed name of struct _MPI2_SCSI_TASK_MANAGE_REPLY.
66 * 05-21-08 02.00.05 Fixed typo in name of Mpi2SepRequest_t.
67 * 10-02-08 02.00.06 Removed Untagged and No Disconnect values from SCSI IO
68 * Control field Task Attribute flags.
69 * Moved LUN field defines to mpi2.h becasue they are
70 * common to many structures.
71 * 05-06-09 02.00.07 Changed task management type of Query Unit Attention to
72 * Query Asynchronous Event.
73 * Defined two new bits in the SlotStatus field of the SCSI
74 * Enclosure Processor Request and Reply.
75 * --------------------------------------------------------------------------
76 */
77
78 #ifndef MPI2_INIT_H
79 #define MPI2_INIT_H
80
81 /*****************************************************************************
82 *
83 * SCSI Initiator Messages
84 *
85 *****************************************************************************/
86
87 /****************************************************************************
88 * SCSI IO messages and associated structures
89 ****************************************************************************/
90
91 typedef struct
92 {
93 U8 CDB[20]; /* 0x00 */
94 U32 PrimaryReferenceTag; /* 0x14 */
95 U16 PrimaryApplicationTag; /* 0x18 */
96 U16 PrimaryApplicationTagMask; /* 0x1A */
97 U32 TransferLength; /* 0x1C */
98 } MPI2_SCSI_IO_CDB_EEDP32, MPI2_POINTER PTR_MPI2_SCSI_IO_CDB_EEDP32,
99 Mpi2ScsiIoCdbEedp32_t, MPI2_POINTER pMpi2ScsiIoCdbEedp32_t;
100
101 /* TBD: I don't think this is needed for MPI2/Gen2 */
102 #if 0
103 typedef struct
104 {
105 U8 CDB[16]; /* 0x00 */
106 U32 DataLength; /* 0x10 */
107 U32 PrimaryReferenceTag; /* 0x14 */
108 U16 PrimaryApplicationTag; /* 0x18 */
109 U16 PrimaryApplicationTagMask; /* 0x1A */
110 U32 TransferLength; /* 0x1C */
111 } MPI2_SCSI_IO32_CDB_EEDP16, MPI2_POINTER PTR_MPI2_SCSI_IO32_CDB_EEDP16,
112 Mpi2ScsiIo32CdbEedp16_t, MPI2_POINTER pMpi2ScsiIo32CdbEedp16_t;
113 #endif
114
115 typedef union
116 {
117 U8 CDB32[32];
118 MPI2_SCSI_IO_CDB_EEDP32 EEDP32;
119 MPI2_SGE_SIMPLE_UNION SGE;
120 } MPI2_SCSI_IO_CDB_UNION, MPI2_POINTER PTR_MPI2_SCSI_IO_CDB_UNION,
121 Mpi2ScsiIoCdb_t, MPI2_POINTER pMpi2ScsiIoCdb_t;
122
123 /* SCSI IO Request Message */
124 typedef struct _MPI2_SCSI_IO_REQUEST
125 {
126 U16 DevHandle; /* 0x00 */
127 U8 ChainOffset; /* 0x02 */
128 U8 Function; /* 0x03 */
129 U16 Reserved1; /* 0x04 */
130 U8 Reserved2; /* 0x06 */
131 U8 MsgFlags; /* 0x07 */
132 U8 VP_ID; /* 0x08 */
133 U8 VF_ID; /* 0x09 */
134 U16 Reserved3; /* 0x0A */
135 U32 SenseBufferLowAddress; /* 0x0C */
136 U16 SGLFlags; /* 0x10 */
137 U8 SenseBufferLength; /* 0x12 */
138 U8 Reserved4; /* 0x13 */
139 U8 SGLOffset0; /* 0x14 */
140 U8 SGLOffset1; /* 0x15 */
141 U8 SGLOffset2; /* 0x16 */
142 U8 SGLOffset3; /* 0x17 */
143 U32 SkipCount; /* 0x18 */
169
170 /* base values for Data Location Address Space */
171 #define MPI2_SCSIIO_SGLFLAGS_ADDR_MASK (0x0C)
172 #define MPI2_SCSIIO_SGLFLAGS_SYSTEM_ADDR (0x00)
173 #define MPI2_SCSIIO_SGLFLAGS_IOCDDR_ADDR (0x04)
174 #define MPI2_SCSIIO_SGLFLAGS_IOCPLB_ADDR (0x08)
175 #define MPI2_SCSIIO_SGLFLAGS_IOCPLBNTA_ADDR (0x0C)
176
177 /* base values for Type */
178 #define MPI2_SCSIIO_SGLFLAGS_TYPE_MASK (0x03)
179 #define MPI2_SCSIIO_SGLFLAGS_TYPE_MPI (0x00)
180 #define MPI2_SCSIIO_SGLFLAGS_TYPE_IEEE32 (0x01)
181 #define MPI2_SCSIIO_SGLFLAGS_TYPE_IEEE64 (0x02)
182
183 /* shift values for each sub-field */
184 #define MPI2_SCSIIO_SGLFLAGS_SGL3_SHIFT (12)
185 #define MPI2_SCSIIO_SGLFLAGS_SGL2_SHIFT (8)
186 #define MPI2_SCSIIO_SGLFLAGS_SGL1_SHIFT (4)
187 #define MPI2_SCSIIO_SGLFLAGS_SGL0_SHIFT (0)
188
189 /* SCSI IO IoFlags bits */
190
191 /* Large CDB Address Space */
192 #define MPI2_SCSIIO_CDB_ADDR_MASK (0x6000)
193 #define MPI2_SCSIIO_CDB_ADDR_SYSTEM (0x0000)
194 #define MPI2_SCSIIO_CDB_ADDR_IOCDDR (0x2000)
195 #define MPI2_SCSIIO_CDB_ADDR_IOCPLB (0x4000)
196 #define MPI2_SCSIIO_CDB_ADDR_IOCPLBNTA (0x6000)
197
198 #define MPI2_SCSIIO_IOFLAGS_LARGE_CDB (0x1000)
199 #define MPI2_SCSIIO_IOFLAGS_BIDIRECTIONAL (0x0800)
200 #define MPI2_SCSIIO_IOFLAGS_MULTICAST (0x0400)
201 #define MPI2_SCSIIO_IOFLAGS_CMD_DETERMINES_DATA_DIR (0x0200)
202 #define MPI2_SCSIIO_IOFLAGS_CDBLENGTH_MASK (0x01FF)
203
204 /* SCSI IO EEDPFlags bits */
205
206 #define MPI2_SCSIIO_EEDPFLAGS_INC_PRI_REFTAG (0x8000)
207 #define MPI2_SCSIIO_EEDPFLAGS_INC_SEC_REFTAG (0x4000)
208 #define MPI2_SCSIIO_EEDPFLAGS_INC_PRI_APPTAG (0x2000)
233 #define MPI2_SCSIIO_CONTROL_NODATATRANSFER (0x00000000)
234 #define MPI2_SCSIIO_CONTROL_WRITE (0x01000000)
235 #define MPI2_SCSIIO_CONTROL_READ (0x02000000)
236 #define MPI2_SCSIIO_CONTROL_BIDIRECTIONAL (0x03000000)
237
238 #define MPI2_SCSIIO_CONTROL_TASKPRI_MASK (0x00007800)
239 #define MPI2_SCSIIO_CONTROL_TASKPRI_SHIFT (11)
240
241 #define MPI2_SCSIIO_CONTROL_TASKATTRIBUTE_MASK (0x00000700)
242 #define MPI2_SCSIIO_CONTROL_SIMPLEQ (0x00000000)
243 #define MPI2_SCSIIO_CONTROL_HEADOFQ (0x00000100)
244 #define MPI2_SCSIIO_CONTROL_ORDEREDQ (0x00000200)
245 #define MPI2_SCSIIO_CONTROL_ACAQ (0x00000400)
246
247 #define MPI2_SCSIIO_CONTROL_TLR_MASK (0x000000C0)
248 #define MPI2_SCSIIO_CONTROL_NO_TLR (0x00000000)
249 #define MPI2_SCSIIO_CONTROL_TLR_ON (0x00000040)
250 #define MPI2_SCSIIO_CONTROL_TLR_OFF (0x00000080)
251
252
253 /* SCSI IO Error Reply Message */
254 typedef struct _MPI2_SCSI_IO_REPLY
255 {
256 U16 DevHandle; /* 0x00 */
257 U8 MsgLength; /* 0x02 */
258 U8 Function; /* 0x03 */
259 U16 Reserved1; /* 0x04 */
260 U8 Reserved2; /* 0x06 */
261 U8 MsgFlags; /* 0x07 */
262 U8 VP_ID; /* 0x08 */
263 U8 VF_ID; /* 0x09 */
264 U16 Reserved3; /* 0x0A */
265 U8 SCSIStatus; /* 0x0C */
266 U8 SCSIState; /* 0x0D */
267 U16 IOCStatus; /* 0x0E */
268 U32 IOCLogInfo; /* 0x10 */
269 U32 TransferCount; /* 0x14 */
270 U32 SenseCount; /* 0x18 */
271 U32 ResponseInfo; /* 0x1C */
272 U16 TaskTag; /* 0x20 */
282 #define MPI2_SCSI_STATUS_GOOD (0x00)
283 #define MPI2_SCSI_STATUS_CHECK_CONDITION (0x02)
284 #define MPI2_SCSI_STATUS_CONDITION_MET (0x04)
285 #define MPI2_SCSI_STATUS_BUSY (0x08)
286 #define MPI2_SCSI_STATUS_INTERMEDIATE (0x10)
287 #define MPI2_SCSI_STATUS_INTERMEDIATE_CONDMET (0x14)
288 #define MPI2_SCSI_STATUS_RESERVATION_CONFLICT (0x18)
289 #define MPI2_SCSI_STATUS_COMMAND_TERMINATED (0x22) /* obsolete */
290 #define MPI2_SCSI_STATUS_TASK_SET_FULL (0x28)
291 #define MPI2_SCSI_STATUS_ACA_ACTIVE (0x30)
292 #define MPI2_SCSI_STATUS_TASK_ABORTED (0x40)
293
294 /* SCSI IO Reply SCSIState flags */
295
296 #define MPI2_SCSI_STATE_RESPONSE_INFO_VALID (0x10)
297 #define MPI2_SCSI_STATE_TERMINATED (0x08)
298 #define MPI2_SCSI_STATE_NO_SCSI_STATUS (0x04)
299 #define MPI2_SCSI_STATE_AUTOSENSE_FAILED (0x02)
300 #define MPI2_SCSI_STATE_AUTOSENSE_VALID (0x01)
301
302 #define MPI2_SCSI_TASKTAG_UNKNOWN (0xFFFF)
303
304
305 /****************************************************************************
306 * SCSI Task Management messages
307 ****************************************************************************/
308
309 /* SCSI Task Management Request Message */
310 typedef struct _MPI2_SCSI_TASK_MANAGE_REQUEST
311 {
312 U16 DevHandle; /* 0x00 */
313 U8 ChainOffset; /* 0x02 */
314 U8 Function; /* 0x03 */
315 U8 Reserved1; /* 0x04 */
316 U8 TaskType; /* 0x05 */
317 U8 Reserved2; /* 0x06 */
318 U8 MsgFlags; /* 0x07 */
319 U8 VP_ID; /* 0x08 */
320 U8 VF_ID; /* 0x09 */
321 U16 Reserved3; /* 0x0A */
354
355
356
357 /* SCSI Task Management Reply Message */
358 typedef struct _MPI2_SCSI_TASK_MANAGE_REPLY
359 {
360 U16 DevHandle; /* 0x00 */
361 U8 MsgLength; /* 0x02 */
362 U8 Function; /* 0x03 */
363 U8 ResponseCode; /* 0x04 */
364 U8 TaskType; /* 0x05 */
365 U8 Reserved1; /* 0x06 */
366 U8 MsgFlags; /* 0x07 */
367 U8 VP_ID; /* 0x08 */
368 U8 VF_ID; /* 0x09 */
369 U16 Reserved2; /* 0x0A */
370 U16 Reserved3; /* 0x0C */
371 U16 IOCStatus; /* 0x0E */
372 U32 IOCLogInfo; /* 0x10 */
373 U32 TerminationCount; /* 0x14 */
374 } MPI2_SCSI_TASK_MANAGE_REPLY,
375 MPI2_POINTER PTR_MPI2_SCSI_TASK_MANAGE_REPLY,
376 Mpi2SCSITaskManagementReply_t, MPI2_POINTER pMpi2SCSIManagementReply_t;
377
378 /* ResponseCode values */
379
380 #define MPI2_SCSITASKMGMT_RSP_TM_COMPLETE (0x00)
381 #define MPI2_SCSITASKMGMT_RSP_INVALID_FRAME (0x02)
382 #define MPI2_SCSITASKMGMT_RSP_TM_NOT_SUPPORTED (0x04)
383 #define MPI2_SCSITASKMGMT_RSP_TM_FAILED (0x05)
384 #define MPI2_SCSITASKMGMT_RSP_TM_SUCCEEDED (0x08)
385 #define MPI2_SCSITASKMGMT_RSP_TM_INVALID_LUN (0x09)
386 #define MPI2_SCSITASKMGMT_RSP_IO_QUEUED_ON_IOC (0x80)
387
388
389 /****************************************************************************
390 * SCSI Enclosure Processor messages
391 ****************************************************************************/
392
393 /* SCSI Enclosure Processor Request Message */
394 typedef struct _MPI2_SEP_REQUEST
395 {
396 U16 DevHandle; /* 0x00 */
397 U8 ChainOffset; /* 0x02 */
398 U8 Function; /* 0x03 */
399 U8 Action; /* 0x04 */
400 U8 Flags; /* 0x05 */
401 U8 Reserved1; /* 0x06 */
402 U8 MsgFlags; /* 0x07 */
403 U8 VP_ID; /* 0x08 */
404 U8 VF_ID; /* 0x09 */
405 U16 Reserved2; /* 0x0A */
406 U32 SlotStatus; /* 0x0C */
407 U32 Reserved3; /* 0x10 */
|
3 *
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
7 *
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
12 *
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 *
19 * CDDL HEADER END
20 */
21
22 /*
23 * Copyright (c) 2000-2012 LSI Corporation.
24 *
25 * Redistribution and use in source and binary forms of all code within
26 * this file that is exclusively owned by LSI, with or without
27 * modification, is permitted provided that, in addition to the CDDL 1.0
28 * License requirements, the following conditions are met:
29 *
30 * Neither the name of the author nor the names of its contributors may be
31 * used to endorse or promote products derived from this software without
32 * specific prior written permission.
33 *
34 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
35 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
36 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
37 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
38 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
39 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
40 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
41 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
42 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
43 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
44 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
45 * DAMAGE.
46 */
47
48 /*
49 * Name: mpi2_init.h
50 * Title: MPI SCSI initiator mode messages and structures
51 * Creation Date: June 23, 2006
52 *
53 * mpi2_init.h Version: 02.00.xx
54 *
55 * NOTE: Names (typedefs, defines, etc.) beginning with an MPI25 or Mpi25
56 * prefix are for use only on MPI v2.5 products, and must not be used
57 * with MPI v2.0 products. Unless otherwise noted, names beginning with
58 * MPI2 or Mpi2 are for use with both MPI v2.0 and MPI v2.5 products.
59 *
60 * Version History
61 * ---------------
62 *
63 * Date Version Description
64 * -------- -------- ------------------------------------------------------
65 * 04-30-07 02.00.00 Corresponds to Fusion-MPT MPI Specification Rev A.
66 * 10-31-07 02.00.01 Fixed name for pMpi2SCSITaskManagementRequest_t.
67 * 12-18-07 02.00.02 Modified Task Management Target Reset Method defines.
68 * 02-29-08 02.00.03 Added Query Task Set and Query Unit Attention.
69 * 03-03-08 02.00.04 Fixed name of struct _MPI2_SCSI_TASK_MANAGE_REPLY.
70 * 05-21-08 02.00.05 Fixed typo in name of Mpi2SepRequest_t.
71 * 10-02-08 02.00.06 Removed Untagged and No Disconnect values from SCSI IO
72 * Control field Task Attribute flags.
73 * Moved LUN field defines to mpi2.h becasue they are
74 * common to many structures.
75 * 05-06-09 02.00.07 Changed task management type of Query Unit Attention to
76 * Query Asynchronous Event.
77 * Defined two new bits in the SlotStatus field of the SCSI
78 * Enclosure Processor Request and Reply.
79 * 10-28-09 02.00.08 Added defines for decoding the ResponseInfo bytes for
80 * both SCSI IO Error Reply and SCSI Task Management Reply.
81 * Added ResponseInfo field to MPI2_SCSI_TASK_MANAGE_REPLY.
82 * Added MPI2_SCSITASKMGMT_RSP_TM_OVERLAPPED_TAG define.
83 * 02-10-10 02.00.09 Removed unused structure that had "#if 0" around it.
84 * 05-12-10 02.00.10 Added optional vendor-unique region to SCSI IO Request.
85 * 11-10-10 02.00.11 Added MPI2_SCSIIO_NUM_SGLOFFSETS define.
86 * --------------------------------------------------------------------------
87 */
88
89 #ifndef MPI2_INIT_H
90 #define MPI2_INIT_H
91
92 /*****************************************************************************
93 *
94 * SCSI Initiator Messages
95 *
96 *****************************************************************************/
97
98 /****************************************************************************
99 * SCSI IO messages and associated structures
100 ****************************************************************************/
101
102 typedef struct
103 {
104 U8 CDB[20]; /* 0x00 */
105 U32 PrimaryReferenceTag; /* 0x14 */
106 U16 PrimaryApplicationTag; /* 0x18 */
107 U16 PrimaryApplicationTagMask; /* 0x1A */
108 U32 TransferLength; /* 0x1C */
109 } MPI2_SCSI_IO_CDB_EEDP32, MPI2_POINTER PTR_MPI2_SCSI_IO_CDB_EEDP32,
110 Mpi2ScsiIoCdbEedp32_t, MPI2_POINTER pMpi2ScsiIoCdbEedp32_t;
111
112 typedef union
113 {
114 U8 CDB32[32];
115 MPI2_SCSI_IO_CDB_EEDP32 EEDP32;
116 MPI2_SGE_SIMPLE_UNION SGE;
117 } MPI2_SCSI_IO_CDB_UNION, MPI2_POINTER PTR_MPI2_SCSI_IO_CDB_UNION,
118 Mpi2ScsiIoCdb_t, MPI2_POINTER pMpi2ScsiIoCdb_t;
119
120 /* MPI v2.0 SCSI IO Request Message */
121 typedef struct _MPI2_SCSI_IO_REQUEST
122 {
123 U16 DevHandle; /* 0x00 */
124 U8 ChainOffset; /* 0x02 */
125 U8 Function; /* 0x03 */
126 U16 Reserved1; /* 0x04 */
127 U8 Reserved2; /* 0x06 */
128 U8 MsgFlags; /* 0x07 */
129 U8 VP_ID; /* 0x08 */
130 U8 VF_ID; /* 0x09 */
131 U16 Reserved3; /* 0x0A */
132 U32 SenseBufferLowAddress; /* 0x0C */
133 U16 SGLFlags; /* 0x10 */
134 U8 SenseBufferLength; /* 0x12 */
135 U8 Reserved4; /* 0x13 */
136 U8 SGLOffset0; /* 0x14 */
137 U8 SGLOffset1; /* 0x15 */
138 U8 SGLOffset2; /* 0x16 */
139 U8 SGLOffset3; /* 0x17 */
140 U32 SkipCount; /* 0x18 */
166
167 /* base values for Data Location Address Space */
168 #define MPI2_SCSIIO_SGLFLAGS_ADDR_MASK (0x0C)
169 #define MPI2_SCSIIO_SGLFLAGS_SYSTEM_ADDR (0x00)
170 #define MPI2_SCSIIO_SGLFLAGS_IOCDDR_ADDR (0x04)
171 #define MPI2_SCSIIO_SGLFLAGS_IOCPLB_ADDR (0x08)
172 #define MPI2_SCSIIO_SGLFLAGS_IOCPLBNTA_ADDR (0x0C)
173
174 /* base values for Type */
175 #define MPI2_SCSIIO_SGLFLAGS_TYPE_MASK (0x03)
176 #define MPI2_SCSIIO_SGLFLAGS_TYPE_MPI (0x00)
177 #define MPI2_SCSIIO_SGLFLAGS_TYPE_IEEE32 (0x01)
178 #define MPI2_SCSIIO_SGLFLAGS_TYPE_IEEE64 (0x02)
179
180 /* shift values for each sub-field */
181 #define MPI2_SCSIIO_SGLFLAGS_SGL3_SHIFT (12)
182 #define MPI2_SCSIIO_SGLFLAGS_SGL2_SHIFT (8)
183 #define MPI2_SCSIIO_SGLFLAGS_SGL1_SHIFT (4)
184 #define MPI2_SCSIIO_SGLFLAGS_SGL0_SHIFT (0)
185
186 /* number of SGLOffset fields */
187 #define MPI2_SCSIIO_NUM_SGLOFFSETS (4)
188
189 /* SCSI IO IoFlags bits */
190
191 /* Large CDB Address Space */
192 #define MPI2_SCSIIO_CDB_ADDR_MASK (0x6000)
193 #define MPI2_SCSIIO_CDB_ADDR_SYSTEM (0x0000)
194 #define MPI2_SCSIIO_CDB_ADDR_IOCDDR (0x2000)
195 #define MPI2_SCSIIO_CDB_ADDR_IOCPLB (0x4000)
196 #define MPI2_SCSIIO_CDB_ADDR_IOCPLBNTA (0x6000)
197
198 #define MPI2_SCSIIO_IOFLAGS_LARGE_CDB (0x1000)
199 #define MPI2_SCSIIO_IOFLAGS_BIDIRECTIONAL (0x0800)
200 #define MPI2_SCSIIO_IOFLAGS_MULTICAST (0x0400)
201 #define MPI2_SCSIIO_IOFLAGS_CMD_DETERMINES_DATA_DIR (0x0200)
202 #define MPI2_SCSIIO_IOFLAGS_CDBLENGTH_MASK (0x01FF)
203
204 /* SCSI IO EEDPFlags bits */
205
206 #define MPI2_SCSIIO_EEDPFLAGS_INC_PRI_REFTAG (0x8000)
207 #define MPI2_SCSIIO_EEDPFLAGS_INC_SEC_REFTAG (0x4000)
208 #define MPI2_SCSIIO_EEDPFLAGS_INC_PRI_APPTAG (0x2000)
233 #define MPI2_SCSIIO_CONTROL_NODATATRANSFER (0x00000000)
234 #define MPI2_SCSIIO_CONTROL_WRITE (0x01000000)
235 #define MPI2_SCSIIO_CONTROL_READ (0x02000000)
236 #define MPI2_SCSIIO_CONTROL_BIDIRECTIONAL (0x03000000)
237
238 #define MPI2_SCSIIO_CONTROL_TASKPRI_MASK (0x00007800)
239 #define MPI2_SCSIIO_CONTROL_TASKPRI_SHIFT (11)
240
241 #define MPI2_SCSIIO_CONTROL_TASKATTRIBUTE_MASK (0x00000700)
242 #define MPI2_SCSIIO_CONTROL_SIMPLEQ (0x00000000)
243 #define MPI2_SCSIIO_CONTROL_HEADOFQ (0x00000100)
244 #define MPI2_SCSIIO_CONTROL_ORDEREDQ (0x00000200)
245 #define MPI2_SCSIIO_CONTROL_ACAQ (0x00000400)
246
247 #define MPI2_SCSIIO_CONTROL_TLR_MASK (0x000000C0)
248 #define MPI2_SCSIIO_CONTROL_NO_TLR (0x00000000)
249 #define MPI2_SCSIIO_CONTROL_TLR_ON (0x00000040)
250 #define MPI2_SCSIIO_CONTROL_TLR_OFF (0x00000080)
251
252
253 /* MPI v2.5 CDB field */
254 typedef union _MPI25_SCSI_IO_CDB_UNION
255 {
256 U8 CDB32[32];
257 MPI2_SCSI_IO_CDB_EEDP32 EEDP32;
258 MPI2_IEEE_SGE_SIMPLE64 SGE;
259 } MPI25_SCSI_IO_CDB_UNION, MPI2_POINTER PTR_MPI25_SCSI_IO_CDB_UNION,
260 Mpi25ScsiIoCdb_t, MPI2_POINTER pMpi25ScsiIoCdb_t;
261
262 /* MPI v2.5 SCSI IO Request Message */
263 typedef struct _MPI25_SCSI_IO_REQUEST
264 {
265 U16 DevHandle; /* 0x00 */
266 U8 ChainOffset; /* 0x02 */
267 U8 Function; /* 0x03 */
268 U16 Reserved1; /* 0x04 */
269 U8 Reserved2; /* 0x06 */
270 U8 MsgFlags; /* 0x07 */
271 U8 VP_ID; /* 0x08 */
272 U8 VF_ID; /* 0x09 */
273 U16 Reserved3; /* 0x0A */
274 U32 SenseBufferLowAddress; /* 0x0C */
275 U8 DMAFlags; /* 0x10 */
276 U8 Reserved5; /* 0x11 */
277 U8 SenseBufferLength; /* 0x12 */
278 U8 Reserved4; /* 0x13 */
279 U8 SGLOffset0; /* 0x14 */
280 U8 SGLOffset1; /* 0x15 */
281 U8 SGLOffset2; /* 0x16 */
282 U8 SGLOffset3; /* 0x17 */
283 U32 SkipCount; /* 0x18 */
284 U32 DataLength; /* 0x1C */
285 U32 BidirectionalDataLength; /* 0x20 */
286 U16 IoFlags; /* 0x24 */
287 U16 EEDPFlags; /* 0x26 */
288 U16 EEDPBlockSize; /* 0x28 */
289 U16 Reserved6; /* 0x2A */
290 U32 SecondaryReferenceTag; /* 0x2C */
291 U16 SecondaryApplicationTag; /* 0x30 */
292 U16 ApplicationTagTranslationMask; /* 0x32 */
293 U8 LUN[8]; /* 0x34 */
294 U32 Control; /* 0x3C */
295 MPI25_SCSI_IO_CDB_UNION CDB; /* 0x40 */
296
297 #ifdef MPI25_SCSI_IO_VENDOR_UNIQUE_REGION /* typically this is left undefined */
298 MPI25_SCSI_IO_VENDOR_UNIQUE VendorRegion;
299 #endif
300
301 MPI25_SGE_IO_UNION SGL; /* 0x60 */
302
303 } MPI25_SCSI_IO_REQUEST, MPI2_POINTER PTR_MPI25_SCSI_IO_REQUEST,
304 Mpi25SCSIIORequest_t, MPI2_POINTER pMpi25SCSIIORequest_t;
305
306 /* use MPI2_SCSIIO_MSGFLAGS_ defines for the MsgFlags field */
307
308 /* Defines for the DMAFlags field
309 * Each setting affects 4 SGLS, from SGL0 to SGL3.
310 * D = Data
311 * C = Cache DIF
312 * I = Interleaved
313 * H = Host DIF
314 */
315 #define MPI25_SCSIIO_DMAFLAGS_OP_MASK (0x0F)
316 #define MPI25_SCSIIO_DMAFLAGS_OP_D_D_D_D (0x00)
317 #define MPI25_SCSIIO_DMAFLAGS_OP_D_D_D_C (0x01)
318 #define MPI25_SCSIIO_DMAFLAGS_OP_D_D_D_I (0x02)
319 #define MPI25_SCSIIO_DMAFLAGS_OP_D_D_C_C (0x03)
320 #define MPI25_SCSIIO_DMAFLAGS_OP_D_D_C_I (0x04)
321 #define MPI25_SCSIIO_DMAFLAGS_OP_D_D_I_I (0x05)
322 #define MPI25_SCSIIO_DMAFLAGS_OP_D_C_C_C (0x06)
323 #define MPI25_SCSIIO_DMAFLAGS_OP_D_C_C_I (0x07)
324 #define MPI25_SCSIIO_DMAFLAGS_OP_D_C_I_I (0x08)
325 #define MPI25_SCSIIO_DMAFLAGS_OP_D_I_I_I (0x09)
326 #define MPI25_SCSIIO_DMAFLAGS_OP_D_H_D_D (0x0A)
327 #define MPI25_SCSIIO_DMAFLAGS_OP_D_H_D_C (0x0B)
328 #define MPI25_SCSIIO_DMAFLAGS_OP_D_H_D_I (0x0C)
329 #define MPI25_SCSIIO_DMAFLAGS_OP_D_H_C_C (0x0D)
330 #define MPI25_SCSIIO_DMAFLAGS_OP_D_H_C_I (0x0E)
331 #define MPI25_SCSIIO_DMAFLAGS_OP_D_H_I_I (0x0F)
332
333 /* number of SGLOffset fields */
334 #define MPI25_SCSIIO_NUM_SGLOFFSETS (4)
335
336 /* defines for the IoFlags field */
337 #define MPI25_SCSIIO_IOFLAGS_IO_PATH_MASK (0xC000)
338 #define MPI25_SCSIIO_IOFLAGS_NORMAL_PATH (0x0000)
339 #define MPI25_SCSIIO_IOFLAGS_FAST_PATH (0x4000)
340
341 #define MPI25_SCSIIO_IOFLAGS_LARGE_CDB (0x1000)
342 #define MPI25_SCSIIO_IOFLAGS_BIDIRECTIONAL (0x0800)
343 #define MPI25_SCSIIO_IOFLAGS_CMD_DETERMINES_DATA_DIR (0x0200)
344 #define MPI25_SCSIIO_IOFLAGS_CDBLENGTH_MASK (0x01FF)
345
346 /* MPI v2.5 defines for the EEDPFlags bits */
347 /* use MPI2_SCSIIO_EEDPFLAGS_ defines for the other EEDPFlags bits */
348 #define MPI25_SCSIIO_EEDPFLAGS_ESCAPE_MODE_MASK (0x00C0)
349 #define MPI25_SCSIIO_EEDPFLAGS_COMPATIBLE_MODE (0x0000)
350 #define MPI25_SCSIIO_EEDPFLAGS_DO_NOT_DISABLE_MODE (0x0040)
351 #define MPI25_SCSIIO_EEDPFLAGS_APPTAG_DISABLE_MODE (0x0080)
352 #define MPI25_SCSIIO_EEDPFLAGS_APPTAG_REFTAG_DISABLE_MODE (0x00C0)
353
354 #define MPI25_SCSIIO_EEDPFLAGS_HOST_GUARD_METHOD_MASK (0x0030)
355 #define MPI25_SCSIIO_EEDPFLAGS_T10_CRC_HOST_GUARD (0x0000)
356 #define MPI25_SCSIIO_EEDPFLAGS_IP_CHKSUM_HOST_GUARD (0x0010)
357
358 /* use MPI2_LUN_ defines from mpi2.h for the LUN field */
359
360 /* use MPI2_SCSIIO_CONTROL_ defines for the Control field */
361
362
363 /* NOTE: The SCSI IO Reply is the same for MPI 2.0 and MPI 2.5, so
364 * MPI2_SCSI_IO_REPLY is used for both.
365 */
366
367 /* SCSI IO Error Reply Message */
368 typedef struct _MPI2_SCSI_IO_REPLY
369 {
370 U16 DevHandle; /* 0x00 */
371 U8 MsgLength; /* 0x02 */
372 U8 Function; /* 0x03 */
373 U16 Reserved1; /* 0x04 */
374 U8 Reserved2; /* 0x06 */
375 U8 MsgFlags; /* 0x07 */
376 U8 VP_ID; /* 0x08 */
377 U8 VF_ID; /* 0x09 */
378 U16 Reserved3; /* 0x0A */
379 U8 SCSIStatus; /* 0x0C */
380 U8 SCSIState; /* 0x0D */
381 U16 IOCStatus; /* 0x0E */
382 U32 IOCLogInfo; /* 0x10 */
383 U32 TransferCount; /* 0x14 */
384 U32 SenseCount; /* 0x18 */
385 U32 ResponseInfo; /* 0x1C */
386 U16 TaskTag; /* 0x20 */
396 #define MPI2_SCSI_STATUS_GOOD (0x00)
397 #define MPI2_SCSI_STATUS_CHECK_CONDITION (0x02)
398 #define MPI2_SCSI_STATUS_CONDITION_MET (0x04)
399 #define MPI2_SCSI_STATUS_BUSY (0x08)
400 #define MPI2_SCSI_STATUS_INTERMEDIATE (0x10)
401 #define MPI2_SCSI_STATUS_INTERMEDIATE_CONDMET (0x14)
402 #define MPI2_SCSI_STATUS_RESERVATION_CONFLICT (0x18)
403 #define MPI2_SCSI_STATUS_COMMAND_TERMINATED (0x22) /* obsolete */
404 #define MPI2_SCSI_STATUS_TASK_SET_FULL (0x28)
405 #define MPI2_SCSI_STATUS_ACA_ACTIVE (0x30)
406 #define MPI2_SCSI_STATUS_TASK_ABORTED (0x40)
407
408 /* SCSI IO Reply SCSIState flags */
409
410 #define MPI2_SCSI_STATE_RESPONSE_INFO_VALID (0x10)
411 #define MPI2_SCSI_STATE_TERMINATED (0x08)
412 #define MPI2_SCSI_STATE_NO_SCSI_STATUS (0x04)
413 #define MPI2_SCSI_STATE_AUTOSENSE_FAILED (0x02)
414 #define MPI2_SCSI_STATE_AUTOSENSE_VALID (0x01)
415
416 /* masks and shifts for the ResponseInfo field */
417
418 #define MPI2_SCSI_RI_MASK_REASONCODE (0x000000FF)
419 #define MPI2_SCSI_RI_SHIFT_REASONCODE (0)
420
421 #define MPI2_SCSI_TASKTAG_UNKNOWN (0xFFFF)
422
423
424 /****************************************************************************
425 * SCSI Task Management messages
426 ****************************************************************************/
427
428 /* SCSI Task Management Request Message */
429 typedef struct _MPI2_SCSI_TASK_MANAGE_REQUEST
430 {
431 U16 DevHandle; /* 0x00 */
432 U8 ChainOffset; /* 0x02 */
433 U8 Function; /* 0x03 */
434 U8 Reserved1; /* 0x04 */
435 U8 TaskType; /* 0x05 */
436 U8 Reserved2; /* 0x06 */
437 U8 MsgFlags; /* 0x07 */
438 U8 VP_ID; /* 0x08 */
439 U8 VF_ID; /* 0x09 */
440 U16 Reserved3; /* 0x0A */
473
474
475
476 /* SCSI Task Management Reply Message */
477 typedef struct _MPI2_SCSI_TASK_MANAGE_REPLY
478 {
479 U16 DevHandle; /* 0x00 */
480 U8 MsgLength; /* 0x02 */
481 U8 Function; /* 0x03 */
482 U8 ResponseCode; /* 0x04 */
483 U8 TaskType; /* 0x05 */
484 U8 Reserved1; /* 0x06 */
485 U8 MsgFlags; /* 0x07 */
486 U8 VP_ID; /* 0x08 */
487 U8 VF_ID; /* 0x09 */
488 U16 Reserved2; /* 0x0A */
489 U16 Reserved3; /* 0x0C */
490 U16 IOCStatus; /* 0x0E */
491 U32 IOCLogInfo; /* 0x10 */
492 U32 TerminationCount; /* 0x14 */
493 U32 ResponseInfo; /* 0x18 */
494 } MPI2_SCSI_TASK_MANAGE_REPLY,
495 MPI2_POINTER PTR_MPI2_SCSI_TASK_MANAGE_REPLY,
496 Mpi2SCSITaskManagementReply_t, MPI2_POINTER pMpi2SCSIManagementReply_t;
497
498 /* ResponseCode values */
499
500 #define MPI2_SCSITASKMGMT_RSP_TM_COMPLETE (0x00)
501 #define MPI2_SCSITASKMGMT_RSP_INVALID_FRAME (0x02)
502 #define MPI2_SCSITASKMGMT_RSP_TM_NOT_SUPPORTED (0x04)
503 #define MPI2_SCSITASKMGMT_RSP_TM_FAILED (0x05)
504 #define MPI2_SCSITASKMGMT_RSP_TM_SUCCEEDED (0x08)
505 #define MPI2_SCSITASKMGMT_RSP_TM_INVALID_LUN (0x09)
506 #define MPI2_SCSITASKMGMT_RSP_TM_OVERLAPPED_TAG (0x0A)
507 #define MPI2_SCSITASKMGMT_RSP_IO_QUEUED_ON_IOC (0x80)
508
509 /* masks and shifts for the ResponseInfo field */
510
511 #define MPI2_SCSITASKMGMT_RI_MASK_REASONCODE (0x000000FF)
512 #define MPI2_SCSITASKMGMT_RI_SHIFT_REASONCODE (0)
513 #define MPI2_SCSITASKMGMT_RI_MASK_ARI2 (0x0000FF00)
514 #define MPI2_SCSITASKMGMT_RI_SHIFT_ARI2 (8)
515 #define MPI2_SCSITASKMGMT_RI_MASK_ARI1 (0x00FF0000)
516 #define MPI2_SCSITASKMGMT_RI_SHIFT_ARI1 (16)
517 #define MPI2_SCSITASKMGMT_RI_MASK_ARI0 (0xFF000000)
518 #define MPI2_SCSITASKMGMT_RI_SHIFT_ARI0 (24)
519
520
521 /****************************************************************************
522 * SCSI Enclosure Processor messages
523 ****************************************************************************/
524
525 /* SCSI Enclosure Processor Request Message */
526 typedef struct _MPI2_SEP_REQUEST
527 {
528 U16 DevHandle; /* 0x00 */
529 U8 ChainOffset; /* 0x02 */
530 U8 Function; /* 0x03 */
531 U8 Action; /* 0x04 */
532 U8 Flags; /* 0x05 */
533 U8 Reserved1; /* 0x06 */
534 U8 MsgFlags; /* 0x07 */
535 U8 VP_ID; /* 0x08 */
536 U8 VF_ID; /* 0x09 */
537 U16 Reserved2; /* 0x0A */
538 U32 SlotStatus; /* 0x0C */
539 U32 Reserved3; /* 0x10 */
|