1 /* $NetBSD: scsi_spc.h,v 1.3 2005/12/11 12:23:50 christos Exp $ */
4 * Copyright (c) 2005 The NetBSD Foundation, Inc.
7 * This code is derived from software contributed to The NetBSD Foundation
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
33 * SCSI Primary Commands (SPC) --
34 * Commands for all device types
38 * Largely written by Julian Elischer (julian@tfs.com)
39 * for TRW Financial Systems.
41 * TRW Financial Systems, in accordance with their agreement with Carnegie
42 * Mellon University, makes this software available to CMU to distribute
43 * or use in any manner that they see fit as long as this message is kept with
44 * the software. For this reason TFS also grants any other persons or
45 * organisations permission to use or modify this software.
47 * TFS supplies this software to be publicly redistributed
48 * on the understanding that TFS is not responsible for the correct
49 * functioning of this software in any circumstances.
51 * Ported to run under 386BSD by Julian Elischer (julian@tfs.com) Sept 1992
54 #ifndef _DEV_SCSIPI_SCSI_SPC_H_
55 #define _DEV_SCSIPI_SCSI_SPC_H_
77 #define SCSI_MODE_SELECT_6 0x15
78 struct scsi_mode_select_6
{
81 #define SMS_SP 0x01 /* save page */
82 #define SMS_PF 0x10 /* page format (0 = SCSI-1, 1 = SCSI-2) */
88 #define SCSI_MODE_SELECT_10 0x55
89 struct scsi_mode_select_10
{
91 uint8_t byte2
; /* see MODE SELECT (6) */
101 #define SCSI_MODE_SENSE_6 0x1a
102 struct scsi_mode_sense_6
{
105 #define SMS_DBD 0x08 /* disable block descriptors */
107 #define SMS_PAGE_MASK 0x3f
108 #define SMS_PCTRL_MASK 0xc0
109 #define SMS_PCTRL_CURRENT 0x00
110 #define SMS_PCTRL_CHANGEABLE 0x40
111 #define SMS_PCTRL_DEFAULT 0x80
112 #define SMS_PCTRL_SAVED 0xc0
118 #define SCSI_MODE_SENSE_10 0x5a
119 struct scsi_mode_sense_10
{
121 uint8_t byte2
; /* see MODE SENSE (6) */
122 #define SMS_LLBAA 0x10
123 uint8_t page
; /* See MODE SENSE (6) */
131 * 0x00 Vendor-specific (does not require page format)
132 * 0x01 - 0x1f Device-type-specific pages
133 * 0x20 - 0x3e Vendor-specific (page format required)
134 * 0x3f Return all mode pages
136 #define SMS_PAGE_ALL_PAGES 0x3f
139 * Mode parameters are returned in the following format:
141 * Mode parameter header
142 * Block descriptor(s) [zero or more]
143 * Page(s) [zero or more, variable-length]
146 struct scsi_mode_parameter_header_6
{
150 uint8_t blk_desc_len
; /* unused on ATAPI */
153 struct scsi_mode_parameter_header_10
{
154 uint8_t data_length
[2];
158 #define SMPH_LONGLBA 0x01
160 uint8_t blk_desc_len
[2];
163 struct scsi_general_block_descriptor
{
170 struct scsi_da_block_descriptor
{
176 struct scsi_longlba_block_descriptor
{
184 * Header common to all mode parameter pages.
186 struct scsi_mode_page_header
{
188 #define PGCODE_MASK 0x3f /* page code mask */
189 #define PGCODE_PS 0x80 /* page is saveable */
190 uint8_t pg_length
; /* page length (not including header) */
196 #define SCSI_CONTROL_MODE_PAGE 0x0a
197 struct scsi_control_mode_page
{
198 uint8_t pg_code
; /* 0x0a */
199 uint8_t pg_length
; /* 0x0a */
201 #define SCMP_RLEC 0x01 /* report log exception condition */
202 #define SCMP_GLTSD 0x02 /* global logging target save disable */
203 #define SCMP_TST_mask 0x7 /* task set type */
204 #define SCMP_TST_shift 5
205 #define SCMP_TST_ALL_INIT 0 /* per LU for all initiators */
206 #define SCMP_TST_PER_INIT 1 /* per initiator per LU */
207 uint8_t queue_params
;
208 #define SCMP_DQue 0x01 /* disable queueing */
209 #define SCMP_QErr_mask 0x3 /* queue error management */
210 #define SCMP_QErr_shift 1
211 #define SCMP_QAM_mask 0xf /* queue algorithm modifier */
212 #define SCMP_QAM_shift 4
213 #define SCMP_QAM_RESTRICTED 0x0 /* restricted reordering allowed */
214 #define SCMP_QAM_UNRESTRICTED 0x1 /* unrestricted reordering allowed */
215 /* 0x2 - 0x7 Reserved */
216 /* 0x8 - 0xf Vendor-specific */
218 #define SCMP_EAERP 0x01
219 #define SCMP_UAAERP 0x02
220 #define SCMP_RAERP 0x04
221 #define SCMP_SWP 0x08
222 #define SCMP_RAC 0x40
223 #define SCMP_TAS 0x80
225 #define SCMP_AM_mask 0x7 /* autload mode */
226 #define SCMP_AM_FULL 0
227 #define SCMP_AM_AUXMEM 1
228 #define SCMP_AM_NOLOAD 2
229 uint8_t rahp
[2]; /* ready aer holdoff period */
230 uint8_t btp
[2]; /* busy timeout period */
231 uint8_t estct
[2]; /* extended self-test completion time */
235 * Disconnect-reconnect page
237 #define SCSI_DISCONNECT_RECONNECT_PAGE 0x02
238 struct scsi_disconnect_reconnect_page
{
239 uint8_t pg_code
; /* 0x02 */
240 uint8_t pg_length
; /* 0x0e */
241 uint8_t buffer_full_ratio
;
242 uint8_t buffer_empty_ratio
;
243 uint8_t bus_inactivity_limit
[2];
244 uint8_t disconnect_time_limit
[2];
245 uint8_t connect_time_limit
[2];
246 uint8_t maximum_burst_size
[2];
248 #define SDRP_DTDC_mask 0x7 /* data transfer disconnect control */
249 #define SDRP_DImm 0x08
250 #define SDRP_FA_mask 0x7
251 #define SDRP_FA_shift 4
252 #define SDRP_EMDP 0x80
254 uint8_t first_burst_size
[2];
258 * Informational exceptions control page
260 #define SCSI_INFORMATIONAL_EXCEPTIONS_CONTROL_PAGE 0x1c
261 struct scsi_informational_exceptions_control_page
{
262 uint8_t pg_code
; /* 0x1c */
263 uint8_t pg_length
; /* 0x0a */
265 #define SIECP_LogErr 0x01
266 #define SIECP_TEST 0x04
267 #define SIECP_DExcpt 0x08
268 #define SIECP_EWasc 0x10
269 #define SIECP_EBF 0x20
270 #define SIECP_PERF 0x80
272 #define SIECP_MRIE_mask 0xf /* method of reporting
273 informational exceptions */
274 #define SIECP_MRIE_NO_REPORTING 0x00
275 #define SIECP_MRIE_ASYNC_EVENT 0x01
276 #define SIECP_MRIE_UNIT_ATN 0x02
277 #define SIECP_MRIE_COND_RECOV_ERR 0x03
278 #define SIECP_MRIE_UNCOND_RECOV_ERR 0x04
279 #define SIECP_MRIE_NO_SENSE 0x05
280 #define SIECP_MRIE_ON_REQUEST 0x06
281 /* 0x07 - 0x0b reserved */
282 /* 0x0c - 0x0f Vendor-specific */
283 uint8_t interval_timer
[2];
284 uint8_t report_count
[2];
288 * Power condition page
290 #define SCSI_POWER_CONDITION_PAGE 0x1a
291 struct scsi_power_condition_page
{
292 uint8_t pg_code
; /* 0x1a */
293 uint8_t pg_length
; /* 0x0a */
296 #define SPCP_STANDBY 0x01
297 #define SPCP_IDLE 0x02
298 uint8_t idle_timer
[2]; /* 100ms increments */
299 uint8_t standby_timer
[2]; /* 100ms increments */
303 * Protocol specific LUN page
305 #define SCSI_PROTOCOL_SPECIFIC_LUN_PAGE 0x18
306 struct scsi_protocol_specific_lun_page
{
307 uint8_t pg_code
; /* 0x18 */
308 uint8_t pg_length
; /* variable */
310 #define SPSLP_PROTOCOL_mask 0xf
311 #define SPSLP_PROTOCOL_FCP 0x00 /* Fibre Channel */
312 #define SPSLP_PROTOCOL_SPI 0x01 /* parallel SCSI */
313 #define SPSLP_PROTOCOL_SSA 0x02 /* SSA-S2P or SSA-S3P */
314 #define SPSLP_PROTOCOL_SBP2 0x03 /* IEEE 1394 */
315 #define SPSLP_PROTOCOL_SRP 0x04 /* SCSI RDMA */
316 #define SPSLP_PROTOCOL_ISCSI 0x05 /* iSCSI */
317 /* protocol specific mode parameters follow */
321 * Protocol specific port page
323 #define SCSI_PROTOCOL_SPECIFIC_PORT_PAGE 0x19
324 struct scsi_protocol_specific_port_page
{
325 uint8_t pg_code
; /* 0x18 */
326 uint8_t pg_length
; /* variable */
327 uint8_t byte3
; /* see SCSI PROTOCOL SPECIFIC LUN PAGE */
328 /* protocol specific mode parameters follow */
332 * PERSISTENT RESERVE IN
336 * PERSISTENT RESERVE OUT
340 * PREVENT ALLOW MEDIUM REMOVAL
343 #define SCSI_PREVENT_ALLOW_MEDIUM_REMOVAL 0x1e
344 struct scsi_prevent_allow_medium_removal
{
349 #define SPAMR_ALLOW 0x00
350 #define SPAMR_PREVENT_DT 0x01
351 #define SPAMR_PREVENT_MC 0x02
352 #define SPAMR_PREVENT_ALL 0x03
361 * RECEIVE COPY RESULTS
365 * RECEIVE DIAGNOSTIC RESULTS
372 #define SCSI_RESERVE_6 0x16
373 #define SCSI_RELEASE_6 0x17
374 struct scsi_reserve_release_6
{
382 #define SCSI_RESERVE_10 0x56
383 #define SCSI_RELEASE_10 0x57
384 struct scsi_reserve_release_10
{
387 #define SR_LongID 0x02
388 #define SR_3rdPty 0x10
390 uint8_t thirdpartyid
;
396 struct scsi_reserve_release_10_idparam
{
397 uint8_t thirdpartyid
[8];
401 * REPORT DEVICE IDENTIFIER
412 #define SCSI_REQUEST_SENSE 0x03
413 struct scsi_request_sense
{
421 struct scsi_sense_data
{
422 /* 1*/ uint8_t response_code
;
423 #define SSD_RCODE(x) ((x) & 0x7f)
424 #define SSD_RCODE_CURRENT 0x70
425 #define SSD_RCODE_DEFERRED 0x71
426 #define SSD_RCODE_VALID 0x80
427 /* 2*/ uint8_t segment
; /* obsolete */
428 /* 3*/ uint8_t flags
;
429 #define SSD_SENSE_KEY(x) ((x) & 0x0f)
432 #define SSD_FILEMARK 0x80
433 /* 7*/ uint8_t info
[4];
434 /* 8*/ uint8_t extra_len
;
435 /*12*/ uint8_t csi
[4];
440 uint8_t sks_bytes
[3];
442 /* ILLEGAL REQUEST */
445 #define SSD_SKS_FP_BIT(x) ((x) & 0x7)
446 #define SSD_SKS_FP_BPV 0x08
447 #define SSK_SKS_FP_CD 0x40 /* 1=command, 0=data */
451 /* RECOVERED ERROR, HARDWARE ERROR, MEDIUM ERROR */
455 } actual_retry_count
;
457 /* NOT READY, NO SENSE */
461 } progress_indication
;
466 #define SSD_SKS_SP_BIT(x) ((x) & 0x7)
467 #define SSD_SKS_SP_BPV 0x08
468 #define SSD_SKS_SP_SD 0x20 /* 0=param list, 1=segment desc */
472 #define SSD_SKSV 0x80 /* byte0 of sks field */
473 /*32*/ uint8_t extra_bytes
[14]; /* really variable length */
477 * Sense bytes described by the extra_len field start at csi[], and can
478 * only continue up to the end of the 32-byte sense structure that we
479 * have defined (which might be too short for some cases).
481 #define SSD_ADD_BYTES_LIM(sp) \
482 ((((int)(sp)->extra_len) < (int)sizeof(struct scsi_sense_data) - 8) ? \
483 (sp)->extra_len : sizeof(struct scsi_sense_data) - 8)
485 #define SKEY_NO_SENSE 0x00
486 #define SKEY_RECOVERED_ERROR 0x01
487 #define SKEY_NOT_READY 0x02
488 #define SKEY_MEDIUM_ERROR 0x03
489 #define SKEY_HARDWARE_ERROR 0x04
490 #define SKEY_ILLEGAL_REQUEST 0x05
491 #define SKEY_UNIT_ATTENTION 0x06
492 #define SKEY_DATA_PROTECT 0x07
493 #define SKEY_BLANK_CHECK 0x08
494 #define SKEY_VENDOR_SPECIFIC 0x09
495 #define SKEY_COPY_ABORTED 0x0a
496 #define SKEY_ABORTED_COMMAND 0x0b
497 #define SKEY_EQUAL 0x0c /* obsolete */
498 #define SKEY_VOLUME_OVERFLOW 0x0d
499 #define SKEY_MISCOMPARE 0x0e
502 /* XXX This is not described in SPC-2. */
503 struct scsi_sense_data_unextended
{
504 uint8_t response_code
;
512 #define SCSI_SEND_DIAGNOSTIC 0x1d
513 struct scsi_send_diagnostic
{
516 #define SSD_UnitOffL 0x01
517 #define SSD_DevOffL 0x02
518 #define SSD_SelfTest 0x04 /* standard self-test */
519 #define SSD_PF 0x10 /* results in page format */
520 #define SSD_CODE(x) ((x) << 5)
524 * 0 This value shall be used when the SelfTest bit is
525 * set to one or if the SEND DIAGNOSTIC command is not
526 * invoking one of the other self-test functions such
527 * as enclosure services or the Translate Address page.
529 * 1 Background short self-test. Parameter length is 0.
531 * 2 Background extended self-test. Parameter length is 0.
533 * 4 Abort background self-test. Parameter length is 0.
535 * 5 Foreground short self-test. Parameter length is 0.
537 * 6 Foreground extended self-test. Parameter length is 0.
545 * SET DEVICE IDENTIFIER
552 #define SCSI_TEST_UNIT_READY 0x00
553 struct scsi_test_unit_ready
{
564 #endif /* _DEV_SCSIPI_SCSI_SPC_H_ */