1
/* $Header: /SW/DRIVERS/FreeBSD/I2O.4.X/i2obscsi.h 14 4/30/01 12:57p Salyzyn $ */
2
/****************************************************************
3
* Copyright (c) 1996-2000 Distributed Processing Technology Corporation
4
* Copyright (c) 2000 Adaptec Corporation.
7
* Copyright 1999 I2O Special Interest Group (I2O SIG). All rights reserved.
10
* TERMS AND CONDITIONS OF USE
12
* Redistribution and use in source form, with or without modification, are
13
* permitted provided that redistributions of source code must retain the
14
* above copyright notice, this list of conditions and the following disclaimer.
16
* This software is provided `as is' by Distributed Processing Technology and
17
* any express or implied warranties, including, but not limited to, the
18
* implied warranties of merchantability and fitness for a particular purpose,
19
* are disclaimed. In no event shall Distributed Processing Technology be
20
* liable for any direct, indirect, incidental, special, exemplary or
21
* consequential damages (including, but not limited to, procurement of
22
* substitute goods or services; loss of use, data, or profits; or business
23
* interruptions) however caused and on any theory of liability, whether in
24
* contract, strict liability, or tort (including negligence or otherwise)
25
* arising in any way out of the use of this driver software, even if advised
26
* of the possibility of such damage.
28
* This header file, and any modifications of this header file, are provided
29
* contingent upon your agreement and adherence to the here-listed terms and
30
* conditions. By accepting and/or using this header file, you agree to abide
31
* by these terms and conditions and that these terms and conditions will be
32
* construed and governed in accordance with the laws of the State of California,
33
* without reference to conflict-of-law provisions. If you do not agree
34
* to these terms and conditions, please delete this file, and any copies,
35
* permanently, without making any use thereof.
37
* THIS HEADER FILE IS PROVIDED FREE OF CHARGE ON AN AS-IS BASIS WITHOUT
38
* WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
39
* TO IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
40
* PURPOSE. I2O SIG DOES NOT WARRANT THAT THIS HEADER FILE WILL MEET THE
41
* USER'S REQUIREMENTS OR THAT ITS OPERATION WILL BE UNINTERRUPTED OR
44
* I2O SIG DISCLAIMS ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF
45
* ANY PROPRIETARY RIGHTS, RELATING TO THE IMPLEMENTATION OF THE I2O
46
* SPECIFICATIONS. I2O SIG DOES NOT WARRANT OR REPRESENT THAT SUCH
47
* IMPLEMENTATIONS WILL NOT INFRINGE SUCH RIGHTS.
49
* THE USER OF THIS HEADER FILE SHALL HAVE NO RECOURSE TO I2O SIG FOR ANY
50
* ACTUAL OR CONSEQUENTIAL DAMAGES INCLUDING, BUT NOT LIMITED TO, LOST DATA
51
* OR LOST PROFITS ARISING OUT OF THE USE OR INABILITY TO USE THIS PROGRAM.
53
* I2O SIG grants the user of this header file a license to copy, distribute,
54
* and modify it, for any purpose, under the following terms. Any copying,
55
* distribution, or modification of this header file must not delete or alter
56
* the copyright notice of I2O SIG or any of these Terms and Conditions.
58
* Any distribution of this header file must not include a charge for the
59
* header file (unless such charges are strictly for the physical acts of
60
* copying or transferring copies). However, distribution of a product in
61
* which this header file is embedded may include a charge so long as any
62
* such charge does not include any charge for the header file itself.
64
* Any modification of this header file constitutes a derivative work based
65
* on this header file. Any distribution of such derivative work: (1) must
66
* include prominent notices that the header file has been changed from the
67
* original, together with the dates of any changes; (2) automatically includes
68
* this same license to the original header file from I2O SIG, without any
69
* restriction thereon from the distributing user; and (3) must include a
70
* grant of license of the modified file under the same terms and conditions
71
* as these Terms and Conditions.
73
* The I2O SIG Web site can be found at: http://www.i2osig.org
75
* The I2O SIG encourages you to deposit derivative works based on this
76
* header file at the I2O SIG Web site. Furthermore, to become a Registered
77
* Developer of the I2O SIG, sign up at the Web site or call 415.750.8352
79
****************************************************************/
81
#if !defined(I2O_BASE_SCSI_HDR)
82
#define I2O_BASE_SCSI_HDR
84
#if ((defined(KERNEL) || defined(_KERNEL)) && defined(__FreeBSD__))
85
# if (KERN_VERSION < 3)
86
# include "i386/pci/i2omsg.h" /* Include the Base Message file */
88
# include "dev/asr/i2omsg.h"
91
# include "i2omsg.h" /* Include the Base Message file */
95
#define I2OBSCSI_REV 1_5_1 /* Header file revision string */
99
/*****************************************************************************
101
* I2OBSCSI.h -- I2O Base SCSI Device Class Message defintion file
103
* This file contains information presented in Chapter 6, Section 6 & 7 of
104
* the I2O Specification.
106
* Revision History: (Revision History tracks the revision number of the I2O
109
* .92 - First marked revsion used for Proof of Concept.
110
* .93 - Change to match the rev .93 of the spec.
111
* .95 - Updated to Rev .95 of 2/5/96.
112
* 1.00 - Checked and Updated against spec version 1.00 4/9/96.
113
* 1.xx - Updated to the 1.x version of the I2O Specification on 11/11/96.
115
* 1) Removed duplicate device type definitions.
116
* 2) Added "DSC" to Detailed Status Code definitions.
117
* 3) Changed SCSI-3 LUN fields from U64 to U8 array.
118
* 1.xx 11/15/96 - Added #pragma statments for i960.
119
* 1.xx 11/20/96 - Changed duplicate Bus Scan structure to Bus Reset.
120
* 1.xx 12/05/96 - Added Auto Request Sense flag definition.
121
* 1.5d 03/06/97 - Update for spec. draft version 1.5d.
122
* 1) Converted SCSI bus adapter class to generic in i2oadptr.h.
123
* 2) Fixed DSC reference: changed from _BUS_SCAN to _BUS_RESET.
124
* 1.5d 03/031/97 - Made AutoSense flag definition consistent with spec.
125
* 1.5d 04/11/97 - Corrections from review cycle:
126
* 1) Corrected typo in I2O_SCSI_PERIPHERAL_TYPE_PARALLEL.
127
* 2) Corrected typo in I2O_SCSI_PORT_CONN_UNSHIELDED_P_HD.
128
* 1.5.1 05/02/97 - Corrections from review cycle:
129
* 1) Remove #include for i2omstor.h.
130
* 2) Add revision string.
131
* 3) Convert tabs to spaces.
134
*****************************************************************************/
139
Gets, reads, receives, etc. are all even numbered functions.
140
Sets, writes, sends, etc. are all odd numbered functions.
141
Functions that both send and receive data can be either but an attempt is made
142
to use the function number that indicates the greater transfer amount.
143
Functions that do not send or receive data use odd function numbers.
145
Some functions are synonyms like read, receive and send, write.
147
All common functions will have a code of less than 0x80.
148
Unique functions to a class will start at 0x80.
149
Executive Functions start at 0xA0.
151
Utility Message function codes range from 0 - 0x1f
152
Base Message function codes range from 0x20 - 0xfe
153
Private Message function code is 0xff.
161
SCSI Peripheral Class specific functions
163
Although the names are SCSI Peripheral class specific, the values
164
assigned are common with other classes when applicable.
167
#define I2O_SCSI_DEVICE_RESET 0x27
168
#define I2O_SCSI_SCB_ABORT 0x83
169
#define I2O_SCSI_SCB_EXEC 0x81
172
Detailed Status Codes for SCSI operations
174
The 16-bit Detailed Status Code field for SCSI operations is divided
175
into two separate 8-bit fields. The lower 8 bits are used to report
176
Device Status information. The upper 8 bits are used to report
177
Adapter Status information. The definitions for these two fields,
178
however, will be consistent with the standard reply message frame
179
structure declaration, which treats this as a single 16-bit field.
183
/* SCSI Device Completion Status Codes (defined by SCSI-2/3)*/
185
#define I2O_SCSI_DEVICE_DSC_MASK 0x00FF
187
#define I2O_SCSI_DSC_SUCCESS 0x0000
188
#define I2O_SCSI_DSC_CHECK_CONDITION 0x0002
189
#define I2O_SCSI_DSC_BUSY 0x0008
190
#define I2O_SCSI_DSC_RESERVATION_CONFLICT 0x0018
191
#define I2O_SCSI_DSC_COMMAND_TERMINATED 0x0022
192
#define I2O_SCSI_DSC_TASK_SET_FULL 0x0028
193
#define I2O_SCSI_DSC_ACA_ACTIVE 0x0030
195
/* SCSI Adapter Status Codes (based on CAM-1) */
197
#define I2O_SCSI_HBA_DSC_MASK 0xFF00
199
#define I2O_SCSI_HBA_DSC_SUCCESS 0x0000
201
#define I2O_SCSI_HBA_DSC_REQUEST_ABORTED 0x0200
202
#define I2O_SCSI_HBA_DSC_UNABLE_TO_ABORT 0x0300
203
#define I2O_SCSI_HBA_DSC_COMPLETE_WITH_ERROR 0x0400
204
#define I2O_SCSI_HBA_DSC_ADAPTER_BUSY 0x0500
205
#define I2O_SCSI_HBA_DSC_REQUEST_INVALID 0x0600
206
#define I2O_SCSI_HBA_DSC_PATH_INVALID 0x0700
207
#define I2O_SCSI_HBA_DSC_DEVICE_NOT_PRESENT 0x0800
208
#define I2O_SCSI_HBA_DSC_UNABLE_TO_TERMINATE 0x0900
209
#define I2O_SCSI_HBA_DSC_SELECTION_TIMEOUT 0x0A00
210
#define I2O_SCSI_HBA_DSC_COMMAND_TIMEOUT 0x0B00
212
#define I2O_SCSI_HBA_DSC_MR_MESSAGE_RECEIVED 0x0D00
213
#define I2O_SCSI_HBA_DSC_SCSI_BUS_RESET 0x0E00
214
#define I2O_SCSI_HBA_DSC_PARITY_ERROR_FAILURE 0x0F00
215
#define I2O_SCSI_HBA_DSC_AUTOSENSE_FAILED 0x1000
216
#define I2O_SCSI_HBA_DSC_NO_ADAPTER 0x1100
217
#define I2O_SCSI_HBA_DSC_DATA_OVERRUN 0x1200
218
#define I2O_SCSI_HBA_DSC_UNEXPECTED_BUS_FREE 0x1300
219
#define I2O_SCSI_HBA_DSC_SEQUENCE_FAILURE 0x1400
220
#define I2O_SCSI_HBA_DSC_REQUEST_LENGTH_ERROR 0x1500
221
#define I2O_SCSI_HBA_DSC_PROVIDE_FAILURE 0x1600
222
#define I2O_SCSI_HBA_DSC_BDR_MESSAGE_SENT 0x1700
223
#define I2O_SCSI_HBA_DSC_REQUEST_TERMINATED 0x1800
225
#define I2O_SCSI_HBA_DSC_IDE_MESSAGE_SENT 0x3300
226
#define I2O_SCSI_HBA_DSC_RESOURCE_UNAVAILABLE 0x3400
227
#define I2O_SCSI_HBA_DSC_UNACKNOWLEDGED_EVENT 0x3500
228
#define I2O_SCSI_HBA_DSC_MESSAGE_RECEIVED 0x3600
229
#define I2O_SCSI_HBA_DSC_INVALID_CDB 0x3700
230
#define I2O_SCSI_HBA_DSC_LUN_INVALID 0x3800
231
#define I2O_SCSI_HBA_DSC_SCSI_TID_INVALID 0x3900
232
#define I2O_SCSI_HBA_DSC_FUNCTION_UNAVAILABLE 0x3A00
233
#define I2O_SCSI_HBA_DSC_NO_NEXUS 0x3B00
234
#define I2O_SCSI_HBA_DSC_SCSI_IID_INVALID 0x3C00
235
#define I2O_SCSI_HBA_DSC_CDB_RECEIVED 0x3D00
236
#define I2O_SCSI_HBA_DSC_LUN_ALREADY_ENABLED 0x3E00
237
#define I2O_SCSI_HBA_DSC_BUS_BUSY 0x3F00
239
#define I2O_SCSI_HBA_DSC_QUEUE_FROZEN 0x4000
242
/****************************************************************************/
244
/* SCSI Peripheral Device Parameter Groups */
246
/****************************************************************************/
249
/* SCSI Configuration and Operating Structures and Defines */
252
#define I2O_SCSI_DEVICE_INFO_GROUP_NO 0x0000
253
#define I2O_SCSI_DEVICE_BUS_PORT_INFO_GROUP_NO 0x0001
256
/* - 0000h - SCSI Device Information Parameters Group defines */
260
#define I2O_SCSI_DEVICE_TYPE_DIRECT 0x00
261
#define I2O_SCSI_DEVICE_TYPE_SEQUENTIAL 0x01
262
#define I2O_SCSI_DEVICE_TYPE_PRINTER 0x02
263
#define I2O_SCSI_DEVICE_TYPE_PROCESSOR 0x03
264
#define I2O_SCSI_DEVICE_TYPE_WORM 0x04
265
#define I2O_SCSI_DEVICE_TYPE_CDROM 0x05
266
#define I2O_SCSI_DEVICE_TYPE_SCANNER 0x06
267
#define I2O_SCSI_DEVICE_TYPE_OPTICAL 0x07
268
#define I2O_SCSI_DEVICE_TYPE_MEDIA_CHANGER 0x08
269
#define I2O_SCSI_DEVICE_TYPE_COMM 0x09
270
#define I2O_SCSI_DEVICE_GRAPHICS_1 0x0A
271
#define I2O_SCSI_DEVICE_GRAPHICS_2 0x0B
272
#define I2O_SCSI_DEVICE_TYPE_ARRAY_CONT 0x0C
273
#define I2O_SCSI_DEVICE_TYPE_SES 0x0D
274
#define I2O_SCSI_DEVICE_TYPE_UNKNOWN 0x1F
278
#define I2O_SCSI_PERIPHERAL_TYPE_FLAG 0x01
279
#define I2O_SCSI_PERIPHERAL_TYPE_PARALLEL 0x00
280
#define I2O_SCSI_PERIPHERAL_TYPE_SERIAL 0x01
282
#define I2O_SCSI_RESERVED_FLAG 0x02
284
#define I2O_SCSI_DISCONNECT_FLAG 0x04
285
#define I2O_SCSI_DISABLE_DISCONNECT 0x00
286
#define I2O_SCSI_ENABLE_DISCONNECT 0x04
288
#define I2O_SCSI_MODE_MASK 0x18
289
#define I2O_SCSI_MODE_SET_DATA 0x00
290
#define I2O_SCSI_MODE_SET_DEFAULT 0x08
291
#define I2O_SCSI_MODE_SET_SAFEST 0x10
293
#define I2O_SCSI_DATA_WIDTH_MASK 0x60
294
#define I2O_SCSI_DATA_WIDTH_8 0x00
295
#define I2O_SCSI_DATA_WIDTH_16 0x20
296
#define I2O_SCSI_DATA_WIDTH_32 0x40
298
#define I2O_SCSI_SYNC_NEGOTIATION_FLAG 0x80
299
#define I2O_SCSI_DISABLE_SYNC_NEGOTIATION 0x00
300
#define I2O_SCSI_ENABLE_SYNC_NEGOTIATION 0x80
303
/* - 0001h - SCSI Device Bus Port Info Parameters Group defines */
307
#define I2O_SCSI_PORT_PHYS_OTHER 0x01
308
#define I2O_SCSI_PORT_PHYS_UNKNOWN 0x02
309
#define I2O_SCSI_PORT_PHYS_PARALLEL 0x03
310
#define I2O_SCSI_PORT_PHYS_FIBRE_CHANNEL 0x04
311
#define I2O_SCSI_PORT_PHYS_SERIAL_P1394 0x05
312
#define I2O_SCSI_PORT_PHYS_SERIAL_SSA 0x06
316
#define I2O_SCSI_PORT_ELEC_OTHER 0x01
317
#define I2O_SCSI_PORT_ELEC_UNKNOWN 0x02
318
#define I2O_SCSI_PORT_ELEC_SINGLE_ENDED 0x03
319
#define I2O_SCSI_PORT_ELEC_DIFFERENTIAL 0x04
320
#define I2O_SCSI_PORT_ELEC_LOW_VOLT_DIFF 0x05
321
#define I2O_SCSI_PORT_ELEC_OPTICAL 0x06
325
#define I2O_SCSI_PORT_ISOC_NO 0x00
326
#define I2O_SCSI_PORT_ISOC_YES 0x01
327
#define I2O_SCSI_PORT_ISOC_UNKNOWN 0x02
331
#define I2O_SCSI_PORT_CONN_OTHER 0x01
332
#define I2O_SCSI_PORT_CONN_UNKNOWN 0x02
333
#define I2O_SCSI_PORT_CONN_NONE 0x03
334
#define I2O_SCSI_PORT_CONN_SHIELDED_A_HD 0x04
335
#define I2O_SCSI_PORT_CONN_UNSHIELDED_A_HD 0x05
336
#define I2O_SCSI_PORT_CONN_SHIELDED_A_LD 0x06
337
#define I2O_SCSI_PORT_CONN_UNSHIELDED_A_LD 0x07
338
#define I2O_SCSI_PORT_CONN_SHIELDED_P_HD 0x08
339
#define I2O_SCSI_PORT_CONN_UNSHIELDED_P_HD 0x09
340
#define I2O_SCSI_PORT_CONN_SCA_I 0x0A
341
#define I2O_SCSI_PORT_CONN_SCA_II 0x0B
342
#define I2O_SCSI_PORT_CONN_FC_DB9 0x0C
343
#define I2O_SCSI_PORT_CONN_FC_FIBRE 0x0D
344
#define I2O_SCSI_PORT_CONN_FC_SCA_II_40 0x0E
345
#define I2O_SCSI_PORT_CONN_FC_SCA_II_20 0x0F
346
#define I2O_SCSI_PORT_CONN_FC_BNC 0x10
348
/* Connector Gender */
350
#define I2O_SCSI_PORT_CONN_GENDER_OTHER 0x01
351
#define I2O_SCSI_PORT_CONN_GENDER_UNKOWN 0x02
352
#define I2O_SCSI_PORT_CONN_GENDER_FEMALE 0x03
353
#define I2O_SCSI_PORT_CONN_GENDER_MALE 0x04
356
/* SCSI Device Group 0000h - Device Information Parameter Group */
358
typedef struct _I2O_SCSI_DEVICE_INFO_SCALAR {
363
U8 LunInfo[8]; /* SCSI-2 8-bit scalar LUN goes into offset 1 */
371
} I2O_SCSI_DEVICE_INFO_SCALAR, *PI2O_SCSI_DEVICE_INFO_SCALAR;
374
/* SCSI Device Group 0001h - Bus Port Information Parameter Group */
376
typedef struct _I2O_SCSI_BUS_PORT_INFO_SCALAR {
377
U8 PhysicalInterface;
378
U8 ElectricalInterface;
384
U32 MaxNumberDevices;
385
} I2O_SCSI_BUS_PORT_INFO_SCALAR, *PI2O_SCSI_BUS_PORT_INFO_SCALAR;
389
/****************************************************************************/
391
/* I2O SCSI Peripheral Event Indicator Assignment */
393
#define I2O_SCSI_EVENT_SCSI_SMART 0x00000010
396
/****************************************************************************/
398
/* SCSI Peripheral Class Specific Message Definitions */
400
/****************************************************************************/
403
/****************************************************************************/
405
/* I2O SCSI Peripheral Successful Completion Reply Message Frame */
407
typedef struct _I2O_SCSI_SUCCESS_REPLY_MESSAGE_FRAME {
408
I2O_SINGLE_REPLY_MESSAGE_FRAME StdReplyFrame;
410
} I2O_SCSI_SUCCESS_REPLY_MESSAGE_FRAME, *PI2O_SCSI_SUCCESS_REPLY_MESSAGE_FRAME;
413
/****************************************************************************/
415
/* I2O SCSI Peripheral Error Report Reply Message Frame */
418
#define I2O_SCSI_SENSE_DATA_SZ 44
420
#define I2O_SCSI_SENSE_DATA_SZ 40
423
typedef struct _I2O_SCSI_ERROR_REPLY_MESSAGE_FRAME {
424
I2O_SINGLE_REPLY_MESSAGE_FRAME StdReplyFrame;
426
U32 AutoSenseTransferCount;
427
U8 SenseData[I2O_SCSI_SENSE_DATA_SZ];
428
} I2O_SCSI_ERROR_REPLY_MESSAGE_FRAME, *PI2O_SCSI_ERROR_REPLY_MESSAGE_FRAME;
431
/****************************************************************************/
433
/* I2O SCSI Device Reset Message Frame */
435
typedef struct _I2O_SCSI_DEVICE_RESET_MESSAGE {
436
I2O_MESSAGE_FRAME StdMessageFrame;
437
I2O_TRANSACTION_CONTEXT TransactionContext;
438
} I2O_SCSI_DEVICE_RESET_MESSAGE, *PI2O_SCSI_DEVICE_RESET_MESSAGE;
441
/****************************************************************************/
443
/* I2O SCSI Control Block Abort Message Frame */
445
typedef struct _I2O_SCSI_SCB_ABORT_MESSAGE {
446
I2O_MESSAGE_FRAME StdMessageFrame;
447
I2O_TRANSACTION_CONTEXT TransactionContext;
448
I2O_TRANSACTION_CONTEXT TransactionContextToAbort;
449
} I2O_SCSI_SCB_ABORT_MESSAGE, *PI2O_SCSI_SCB_ABORT_MESSAGE;
452
/****************************************************************************/
454
/* I2O SCSI Control Block Execute Message Frame */
456
#define I2O_SCSI_CDB_LENGTH 16
458
typedef U16 I2O_SCB_FLAGS;
460
#define I2O_SCB_FLAG_XFER_DIR_MASK 0xC000
461
#define I2O_SCB_FLAG_NO_DATA_XFER 0x0000
462
#define I2O_SCB_FLAG_XFER_FROM_DEVICE 0x4000
463
#define I2O_SCB_FLAG_XFER_TO_DEVICE 0x8000
465
#define I2O_SCB_FLAG_ENABLE_DISCONNECT 0x2000
467
#define I2O_SCB_FLAG_TAG_TYPE_MASK 0x0380
468
#define I2O_SCB_FLAG_NO_TAG_QUEUEING 0x0000
469
#define I2O_SCB_FLAG_SIMPLE_QUEUE_TAG 0x0080
470
#define I2O_SCB_FLAG_HEAD_QUEUE_TAG 0x0100
471
#define I2O_SCB_FLAG_ORDERED_QUEUE_TAG 0x0180
472
#define I2O_SCB_FLAG_ACA_QUEUE_TAG 0x0200
474
#define I2O_SCB_FLAG_AUTOSENSE_MASK 0x0060
475
#define I2O_SCB_FLAG_DISABLE_AUTOSENSE 0x0000
476
#define I2O_SCB_FLAG_SENSE_DATA_IN_MESSAGE 0x0020
477
#define I2O_SCB_FLAG_SENSE_DATA_IN_BUFFER 0x0060
479
typedef struct _I2O_SCSI_SCB_EXECUTE_MESSAGE {
480
I2O_MESSAGE_FRAME StdMessageFrame;
481
I2O_TRANSACTION_CONTEXT TransactionContext;
484
I2O_SCB_FLAGS SCBFlags;
485
U8 CDB[I2O_SCSI_CDB_LENGTH];
488
} I2O_SCSI_SCB_EXECUTE_MESSAGE, *PI2O_SCSI_SCB_EXECUTE_MESSAGE;
495
#endif /* I2O_BASE_SCSI_HDR */
added
removed
raideng/i2obscsi.h
