1 | /* SPDX-License-Identifier: GPL-2.0 */ |
2 | /* |
3 | * This header file contains public constants and structures used by |
4 | * both the SCSI initiator and the SCSI target code. |
5 | * |
6 | * For documentation on the OPCODES, MESSAGES, and SENSE values, |
7 | * please consult the SCSI standard. |
8 | */ |
9 | |
10 | #ifndef _SCSI_PROTO_H_ |
11 | #define _SCSI_PROTO_H_ |
12 | |
13 | #include <linux/types.h> |
14 | |
15 | /* |
16 | * SCSI opcodes |
17 | */ |
18 | |
19 | #define TEST_UNIT_READY 0x00 |
20 | #define REZERO_UNIT 0x01 |
21 | #define REQUEST_SENSE 0x03 |
22 | #define FORMAT_UNIT 0x04 |
23 | #define READ_BLOCK_LIMITS 0x05 |
24 | #define REASSIGN_BLOCKS 0x07 |
25 | #define INITIALIZE_ELEMENT_STATUS 0x07 |
26 | #define READ_6 0x08 |
27 | #define WRITE_6 0x0a |
28 | #define SEEK_6 0x0b |
29 | #define READ_REVERSE 0x0f |
30 | #define WRITE_FILEMARKS 0x10 |
31 | #define SPACE 0x11 |
32 | #define INQUIRY 0x12 |
33 | #define RECOVER_BUFFERED_DATA 0x14 |
34 | #define MODE_SELECT 0x15 |
35 | #define RESERVE 0x16 |
36 | #define RELEASE 0x17 |
37 | #define COPY 0x18 |
38 | #define ERASE 0x19 |
39 | #define MODE_SENSE 0x1a |
40 | #define START_STOP 0x1b |
41 | #define RECEIVE_DIAGNOSTIC 0x1c |
42 | #define SEND_DIAGNOSTIC 0x1d |
43 | #define ALLOW_MEDIUM_REMOVAL 0x1e |
44 | |
45 | #define READ_FORMAT_CAPACITIES 0x23 |
46 | #define SET_WINDOW 0x24 |
47 | #define READ_CAPACITY 0x25 |
48 | #define READ_10 0x28 |
49 | #define WRITE_10 0x2a |
50 | #define SEEK_10 0x2b |
51 | #define POSITION_TO_ELEMENT 0x2b |
52 | #define WRITE_VERIFY 0x2e |
53 | #define VERIFY 0x2f |
54 | #define SEARCH_HIGH 0x30 |
55 | #define SEARCH_EQUAL 0x31 |
56 | #define SEARCH_LOW 0x32 |
57 | #define SET_LIMITS 0x33 |
58 | #define PRE_FETCH 0x34 |
59 | #define READ_POSITION 0x34 |
60 | #define SYNCHRONIZE_CACHE 0x35 |
61 | #define LOCK_UNLOCK_CACHE 0x36 |
62 | #define READ_DEFECT_DATA 0x37 |
63 | #define MEDIUM_SCAN 0x38 |
64 | #define COMPARE 0x39 |
65 | #define COPY_VERIFY 0x3a |
66 | #define WRITE_BUFFER 0x3b |
67 | #define READ_BUFFER 0x3c |
68 | #define UPDATE_BLOCK 0x3d |
69 | #define READ_LONG 0x3e |
70 | #define WRITE_LONG 0x3f |
71 | #define CHANGE_DEFINITION 0x40 |
72 | #define WRITE_SAME 0x41 |
73 | #define UNMAP 0x42 |
74 | #define READ_TOC 0x43 |
75 | #define 0x44 |
76 | #define GET_EVENT_STATUS_NOTIFICATION 0x4a |
77 | #define LOG_SELECT 0x4c |
78 | #define LOG_SENSE 0x4d |
79 | #define XDWRITEREAD_10 0x53 |
80 | #define MODE_SELECT_10 0x55 |
81 | #define RESERVE_10 0x56 |
82 | #define RELEASE_10 0x57 |
83 | #define MODE_SENSE_10 0x5a |
84 | #define PERSISTENT_RESERVE_IN 0x5e |
85 | #define PERSISTENT_RESERVE_OUT 0x5f |
86 | #define VARIABLE_LENGTH_CMD 0x7f |
87 | #define REPORT_LUNS 0xa0 |
88 | #define SECURITY_PROTOCOL_IN 0xa2 |
89 | #define MAINTENANCE_IN 0xa3 |
90 | #define MAINTENANCE_OUT 0xa4 |
91 | #define MOVE_MEDIUM 0xa5 |
92 | #define EXCHANGE_MEDIUM 0xa6 |
93 | #define READ_12 0xa8 |
94 | #define SERVICE_ACTION_OUT_12 0xa9 |
95 | #define WRITE_12 0xaa |
96 | #define READ_MEDIA_SERIAL_NUMBER 0xab /* Obsolete with SPC-2 */ |
97 | #define SERVICE_ACTION_IN_12 0xab |
98 | #define WRITE_VERIFY_12 0xae |
99 | #define VERIFY_12 0xaf |
100 | #define SEARCH_HIGH_12 0xb0 |
101 | #define SEARCH_EQUAL_12 0xb1 |
102 | #define SEARCH_LOW_12 0xb2 |
103 | #define SECURITY_PROTOCOL_OUT 0xb5 |
104 | #define READ_ELEMENT_STATUS 0xb8 |
105 | #define SEND_VOLUME_TAG 0xb6 |
106 | #define WRITE_LONG_2 0xea |
107 | #define EXTENDED_COPY 0x83 |
108 | #define RECEIVE_COPY_RESULTS 0x84 |
109 | #define ACCESS_CONTROL_IN 0x86 |
110 | #define ACCESS_CONTROL_OUT 0x87 |
111 | #define READ_16 0x88 |
112 | #define COMPARE_AND_WRITE 0x89 |
113 | #define WRITE_16 0x8a |
114 | #define READ_ATTRIBUTE 0x8c |
115 | #define WRITE_ATTRIBUTE 0x8d |
116 | #define WRITE_VERIFY_16 0x8e |
117 | #define VERIFY_16 0x8f |
118 | #define SYNCHRONIZE_CACHE_16 0x91 |
119 | #define WRITE_SAME_16 0x93 |
120 | #define ZBC_OUT 0x94 |
121 | #define ZBC_IN 0x95 |
122 | #define SERVICE_ACTION_BIDIRECTIONAL 0x9d |
123 | #define SERVICE_ACTION_IN_16 0x9e |
124 | #define SERVICE_ACTION_OUT_16 0x9f |
125 | /* values for service action in */ |
126 | #define SAI_READ_CAPACITY_16 0x10 |
127 | #define SAI_GET_LBA_STATUS 0x12 |
128 | #define SAI_REPORT_REFERRALS 0x13 |
129 | /* values for maintenance in */ |
130 | #define MI_REPORT_IDENTIFYING_INFORMATION 0x05 |
131 | #define MI_REPORT_TARGET_PGS 0x0a |
132 | #define MI_REPORT_ALIASES 0x0b |
133 | #define MI_REPORT_SUPPORTED_OPERATION_CODES 0x0c |
134 | #define MI_REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS 0x0d |
135 | #define MI_REPORT_PRIORITY 0x0e |
136 | #define MI_REPORT_TIMESTAMP 0x0f |
137 | #define MI_MANAGEMENT_PROTOCOL_IN 0x10 |
138 | /* value for MI_REPORT_TARGET_PGS ext header */ |
139 | #define MI_EXT_HDR_PARAM_FMT 0x20 |
140 | /* values for maintenance out */ |
141 | #define MO_SET_IDENTIFYING_INFORMATION 0x06 |
142 | #define MO_SET_TARGET_PGS 0x0a |
143 | #define MO_CHANGE_ALIASES 0x0b |
144 | #define MO_SET_PRIORITY 0x0e |
145 | #define MO_SET_TIMESTAMP 0x0f |
146 | #define MO_MANAGEMENT_PROTOCOL_OUT 0x10 |
147 | /* values for ZBC_IN */ |
148 | #define ZI_REPORT_ZONES 0x00 |
149 | /* values for ZBC_OUT */ |
150 | #define ZO_CLOSE_ZONE 0x01 |
151 | #define ZO_FINISH_ZONE 0x02 |
152 | #define ZO_OPEN_ZONE 0x03 |
153 | #define ZO_RESET_WRITE_POINTER 0x04 |
154 | /* values for PR in service action */ |
155 | #define READ_KEYS 0x00 |
156 | #define READ_RESERVATION 0x01 |
157 | #define REPORT_CAPABILITES 0x02 |
158 | #define READ_FULL_STATUS 0x03 |
159 | /* values for variable length command */ |
160 | #define XDREAD_32 0x03 |
161 | #define XDWRITE_32 0x04 |
162 | #define XPWRITE_32 0x06 |
163 | #define XDWRITEREAD_32 0x07 |
164 | #define READ_32 0x09 |
165 | #define VERIFY_32 0x0a |
166 | #define WRITE_32 0x0b |
167 | #define WRITE_VERIFY_32 0x0c |
168 | #define WRITE_SAME_32 0x0d |
169 | #define ATA_32 0x1ff0 |
170 | |
171 | /* Values for T10/04-262r7 */ |
172 | #define ATA_16 0x85 /* 16-byte pass-thru */ |
173 | #define ATA_12 0xa1 /* 12-byte pass-thru */ |
174 | |
175 | /* Vendor specific CDBs start here */ |
176 | #define VENDOR_SPECIFIC_CDB 0xc0 |
177 | |
178 | /* |
179 | * SCSI command lengths |
180 | */ |
181 | |
182 | #define SCSI_MAX_VARLEN_CDB_SIZE 260 |
183 | |
184 | /* defined in T10 SCSI Primary Commands-2 (SPC2) */ |
185 | struct scsi_varlen_cdb_hdr { |
186 | __u8 opcode; /* opcode always == VARIABLE_LENGTH_CMD */ |
187 | __u8 control; |
188 | __u8 misc[5]; |
189 | __u8 additional_cdb_length; /* total cdb length - 8 */ |
190 | __be16 service_action; |
191 | /* service specific data follows */ |
192 | }; |
193 | |
194 | /* |
195 | * SCSI Architecture Model (SAM) Status codes. Taken from SAM-3 draft |
196 | * T10/1561-D Revision 4 Draft dated 7th November 2002. |
197 | */ |
198 | enum sam_status { |
199 | SAM_STAT_GOOD = 0x00, |
200 | SAM_STAT_CHECK_CONDITION = 0x02, |
201 | SAM_STAT_CONDITION_MET = 0x04, |
202 | SAM_STAT_BUSY = 0x08, |
203 | SAM_STAT_INTERMEDIATE = 0x10, |
204 | SAM_STAT_INTERMEDIATE_CONDITION_MET = 0x14, |
205 | SAM_STAT_RESERVATION_CONFLICT = 0x18, |
206 | SAM_STAT_COMMAND_TERMINATED = 0x22, /* obsolete in SAM-3 */ |
207 | SAM_STAT_TASK_SET_FULL = 0x28, |
208 | SAM_STAT_ACA_ACTIVE = 0x30, |
209 | SAM_STAT_TASK_ABORTED = 0x40, |
210 | }; |
211 | |
212 | #define STATUS_MASK 0xfe |
213 | |
214 | /* |
215 | * SENSE KEYS |
216 | */ |
217 | #define NO_SENSE 0x00 |
218 | #define RECOVERED_ERROR 0x01 |
219 | #define NOT_READY 0x02 |
220 | #define MEDIUM_ERROR 0x03 |
221 | #define HARDWARE_ERROR 0x04 |
222 | #define ILLEGAL_REQUEST 0x05 |
223 | #define UNIT_ATTENTION 0x06 |
224 | #define DATA_PROTECT 0x07 |
225 | #define BLANK_CHECK 0x08 |
226 | #define VENDOR_SPECIFIC 0x09 |
227 | #define COPY_ABORTED 0x0a |
228 | #define ABORTED_COMMAND 0x0b |
229 | #define VOLUME_OVERFLOW 0x0d |
230 | #define MISCOMPARE 0x0e |
231 | #define COMPLETED 0x0f |
232 | |
233 | /* |
234 | * DEVICE TYPES |
235 | * Please keep them in 0x%02x format for $MODALIAS to work |
236 | */ |
237 | |
238 | #define TYPE_DISK 0x00 |
239 | #define TYPE_TAPE 0x01 |
240 | #define TYPE_PRINTER 0x02 |
241 | #define TYPE_PROCESSOR 0x03 /* HP scanners use this */ |
242 | #define TYPE_WORM 0x04 /* Treated as ROM by our system */ |
243 | #define TYPE_ROM 0x05 |
244 | #define TYPE_SCANNER 0x06 |
245 | #define TYPE_MOD 0x07 /* Magneto-optical disk - |
246 | * - treated as TYPE_DISK */ |
247 | #define TYPE_MEDIUM_CHANGER 0x08 |
248 | #define TYPE_COMM 0x09 /* Communications device */ |
249 | #define TYPE_RAID 0x0c |
250 | #define TYPE_ENCLOSURE 0x0d /* Enclosure Services Device */ |
251 | #define TYPE_RBC 0x0e |
252 | #define TYPE_OSD 0x11 |
253 | #define TYPE_ZBC 0x14 |
254 | #define TYPE_WLUN 0x1e /* well-known logical unit */ |
255 | #define TYPE_NO_LUN 0x7f |
256 | |
257 | /* SCSI protocols; these are taken from SPC-3 section 7.5 */ |
258 | enum scsi_protocol { |
259 | SCSI_PROTOCOL_FCP = 0, /* Fibre Channel */ |
260 | SCSI_PROTOCOL_SPI = 1, /* parallel SCSI */ |
261 | SCSI_PROTOCOL_SSA = 2, /* Serial Storage Architecture - Obsolete */ |
262 | SCSI_PROTOCOL_SBP = 3, /* firewire */ |
263 | SCSI_PROTOCOL_SRP = 4, /* Infiniband RDMA */ |
264 | SCSI_PROTOCOL_ISCSI = 5, |
265 | SCSI_PROTOCOL_SAS = 6, |
266 | SCSI_PROTOCOL_ADT = 7, /* Media Changers */ |
267 | SCSI_PROTOCOL_ATA = 8, |
268 | SCSI_PROTOCOL_UNSPEC = 0xf, /* No specific protocol */ |
269 | }; |
270 | |
271 | /* |
272 | * ScsiLun: 8 byte LUN. |
273 | */ |
274 | struct scsi_lun { |
275 | __u8 scsi_lun[8]; |
276 | }; |
277 | |
278 | /* SPC asymmetric access states */ |
279 | #define SCSI_ACCESS_STATE_OPTIMAL 0x00 |
280 | #define SCSI_ACCESS_STATE_ACTIVE 0x01 |
281 | #define SCSI_ACCESS_STATE_STANDBY 0x02 |
282 | #define SCSI_ACCESS_STATE_UNAVAILABLE 0x03 |
283 | #define SCSI_ACCESS_STATE_LBA 0x04 |
284 | #define SCSI_ACCESS_STATE_OFFLINE 0x0e |
285 | #define SCSI_ACCESS_STATE_TRANSITIONING 0x0f |
286 | |
287 | /* Values for REPORT TARGET GROUP STATES */ |
288 | #define SCSI_ACCESS_STATE_MASK 0x0f |
289 | #define SCSI_ACCESS_STATE_PREFERRED 0x80 |
290 | |
291 | /* Reporting options for REPORT ZONES */ |
292 | enum zbc_zone_reporting_options { |
293 | ZBC_ZONE_REPORTING_OPTION_ALL = 0x00, |
294 | ZBC_ZONE_REPORTING_OPTION_EMPTY = 0x01, |
295 | ZBC_ZONE_REPORTING_OPTION_IMPLICIT_OPEN = 0x02, |
296 | ZBC_ZONE_REPORTING_OPTION_EXPLICIT_OPEN = 0x03, |
297 | ZBC_ZONE_REPORTING_OPTION_CLOSED = 0x04, |
298 | ZBC_ZONE_REPORTING_OPTION_FULL = 0x05, |
299 | ZBC_ZONE_REPORTING_OPTION_READONLY = 0x06, |
300 | ZBC_ZONE_REPORTING_OPTION_OFFLINE = 0x07, |
301 | /* 0x08 to 0x0f are reserved */ |
302 | ZBC_ZONE_REPORTING_OPTION_NEED_RESET_WP = 0x10, |
303 | ZBC_ZONE_REPORTING_OPTION_NON_SEQWRITE = 0x11, |
304 | /* 0x12 to 0x3e are reserved */ |
305 | ZBC_ZONE_REPORTING_OPTION_NON_WP = 0x3f, |
306 | }; |
307 | |
308 | #define ZBC_REPORT_ZONE_PARTIAL 0x80 |
309 | |
310 | /* Zone types of REPORT ZONES zone descriptors */ |
311 | enum zbc_zone_type { |
312 | ZBC_ZONE_TYPE_CONV = 0x1, |
313 | ZBC_ZONE_TYPE_SEQWRITE_REQ = 0x2, |
314 | ZBC_ZONE_TYPE_SEQWRITE_PREF = 0x3, |
315 | ZBC_ZONE_TYPE_SEQ_OR_BEFORE_REQ = 0x4, |
316 | ZBC_ZONE_TYPE_GAP = 0x5, |
317 | /* 0x6 to 0xf are reserved */ |
318 | }; |
319 | |
320 | /* Zone conditions of REPORT ZONES zone descriptors */ |
321 | enum zbc_zone_cond { |
322 | ZBC_ZONE_COND_NO_WP = 0x0, |
323 | ZBC_ZONE_COND_EMPTY = 0x1, |
324 | ZBC_ZONE_COND_IMP_OPEN = 0x2, |
325 | ZBC_ZONE_COND_EXP_OPEN = 0x3, |
326 | ZBC_ZONE_COND_CLOSED = 0x4, |
327 | /* 0x5 to 0xc are reserved */ |
328 | ZBC_ZONE_COND_READONLY = 0xd, |
329 | ZBC_ZONE_COND_FULL = 0xe, |
330 | ZBC_ZONE_COND_OFFLINE = 0xf, |
331 | }; |
332 | |
333 | enum zbc_zone_alignment_method { |
334 | ZBC_CONSTANT_ZONE_LENGTH = 0x1, |
335 | ZBC_CONSTANT_ZONE_START_OFFSET = 0x8, |
336 | }; |
337 | |
338 | /* Version descriptor values for INQUIRY */ |
339 | enum scsi_version_descriptor { |
340 | SCSI_VERSION_DESCRIPTOR_FCP4 = 0x0a40, |
341 | SCSI_VERSION_DESCRIPTOR_ISCSI = 0x0960, |
342 | SCSI_VERSION_DESCRIPTOR_SAM5 = 0x00a0, |
343 | SCSI_VERSION_DESCRIPTOR_SAS3 = 0x0c60, |
344 | SCSI_VERSION_DESCRIPTOR_SBC3 = 0x04c0, |
345 | SCSI_VERSION_DESCRIPTOR_SBP3 = 0x0980, |
346 | SCSI_VERSION_DESCRIPTOR_SPC4 = 0x0460, |
347 | SCSI_VERSION_DESCRIPTOR_SRP = 0x0940 |
348 | }; |
349 | |
350 | enum scsi_support_opcode { |
351 | SCSI_SUPPORT_NO_INFO = 0, |
352 | SCSI_SUPPORT_NOT_SUPPORTED = 1, |
353 | SCSI_SUPPORT_FULL = 3, |
354 | SCSI_SUPPORT_VENDOR = 5, |
355 | }; |
356 | |
357 | #define SCSI_CONTROL_MASK 0 |
358 | #define SCSI_GROUP_NUMBER_MASK 0 |
359 | |
360 | #endif /* _SCSI_PROTO_H_ */ |
361 | |