blob: 309860c9ac3322d82381feaf52c107f19bf85c1f [file] [log] [blame]
Alexander Martinz8ca5ed62016-11-25 17:06:10 +01001/*-
2 * Largely written by Julian Elischer (julian@tfs.com)
3 * for TRW Financial Systems.
4 *
5 * TRW Financial Systems, in accordance with their agreement with Carnegie
6 * Mellon University, makes this software available to CMU to distribute
7 * or use in any manner that they see fit as long as this message is kept with
8 * the software. For this reason TFS also grants any other persons or
9 * organisations permission to use or modify this software.
10 *
11 * TFS supplies this software to be publicly redistributed
12 * on the understanding that TFS is not responsible for the correct
13 * functioning of this software in any circumstances.
14 *
15 * Ported to run under 386BSD by Julian Elischer (julian@tfs.com) Sept 1992
16 *
17 * $FreeBSD$
18 */
19
20/*
21 * SCSI general interface description
22 */
23
24#ifndef _SCSI_SCSI_ALL_H
25#define _SCSI_SCSI_ALL_H 1
26
27#include <sys/cdefs.h>
28
29#ifdef _KERNEL
30/*
31 * This is the number of seconds we wait for devices to settle after a SCSI
32 * bus reset.
33 */
34extern int scsi_delay;
35#endif /* _KERNEL */
36
37/*
38 * SCSI command format
39 */
40
41/*
42 * Define dome bits that are in ALL (or a lot of) scsi commands
43 */
44#define SCSI_CTL_LINK 0x01
45#define SCSI_CTL_FLAG 0x02
46#define SCSI_CTL_VENDOR 0xC0
47#define SCSI_CMD_LUN 0xA0 /* these two should not be needed */
48#define SCSI_CMD_LUN_SHIFT 5 /* LUN in the cmd is no longer SCSI */
49
50#define SCSI_MAX_CDBLEN 16 /*
51 * 16 byte commands are in the
52 * SCSI-3 spec
53 */
54#if defined(CAM_MAX_CDBLEN) && (CAM_MAX_CDBLEN < SCSI_MAX_CDBLEN)
55#error "CAM_MAX_CDBLEN cannot be less than SCSI_MAX_CDBLEN"
56#endif
57
58/* 6byte CDBs special case 0 length to be 256 */
59#define SCSI_CDB6_LEN(len) ((len) == 0 ? 256 : len)
60
61/*
62 * This type defines actions to be taken when a particular sense code is
63 * received. Right now, these flags are only defined to take up 16 bits,
64 * but can be expanded in the future if necessary.
65 */
66typedef enum {
67 SS_NOP = 0x000000, /* Do nothing */
68 SS_RETRY = 0x010000, /* Retry the command */
69 SS_FAIL = 0x020000, /* Bail out */
70 SS_START = 0x030000, /* Send a Start Unit command to the device,
71 * then retry the original command.
72 */
73 SS_TUR = 0x040000, /* Send a Test Unit Ready command to the
74 * device, then retry the original command.
75 */
76 SS_MASK = 0xff0000
77} scsi_sense_action;
78
79typedef enum {
80 SSQ_NONE = 0x0000,
81 SSQ_DECREMENT_COUNT = 0x0100, /* Decrement the retry count */
82 SSQ_MANY = 0x0200, /* send lots of recovery commands */
83 SSQ_RANGE = 0x0400, /*
84 * This table entry represents the
85 * end of a range of ASCQs that
86 * have identical error actions
87 * and text.
88 */
89 SSQ_PRINT_SENSE = 0x0800,
90 SSQ_UA = 0x1000, /* Broadcast UA. */
91 SSQ_RESCAN = 0x2000, /* Rescan target for LUNs. */
92 SSQ_LOST = 0x4000, /* Destroy the LUNs. */
93 SSQ_MASK = 0xff00
94} scsi_sense_action_qualifier;
95
96/* Mask for error status values */
97#define SS_ERRMASK 0xff
98
99/* The default, retyable, error action */
100#define SS_RDEF SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE|EIO
101
102/* The retyable, error action, with table specified error code */
103#define SS_RET SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE
104
105/* Wait for transient error status to change */
106#define SS_WAIT SS_TUR|SSQ_MANY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE
107
108/* Fatal error action, with table specified error code */
109#define SS_FATAL SS_FAIL|SSQ_PRINT_SENSE
110
111struct scsi_generic
112{
113 u_int8_t opcode;
114 u_int8_t bytes[11];
115};
116
117struct scsi_request_sense
118{
119 u_int8_t opcode;
120 u_int8_t byte2;
121#define SRS_DESC 0x01
122 u_int8_t unused[2];
123 u_int8_t length;
124 u_int8_t control;
125};
126
127struct scsi_test_unit_ready
128{
129 u_int8_t opcode;
130 u_int8_t byte2;
131 u_int8_t unused[3];
132 u_int8_t control;
133};
134
135struct scsi_receive_diag {
136 uint8_t opcode;
137 uint8_t byte2;
138#define SRD_PCV 0x01
139 uint8_t page_code;
140 uint8_t length[2];
141 uint8_t control;
142};
143
144struct scsi_send_diag {
145 uint8_t opcode;
146 uint8_t byte2;
147#define SSD_UNITOFFL 0x01
148#define SSD_DEVOFFL 0x02
149#define SSD_SELFTEST 0x04
150#define SSD_PF 0x10
151#define SSD_SELF_TEST_CODE_MASK 0xE0
152#define SSD_SELF_TEST_CODE_SHIFT 5
153#define SSD_SELF_TEST_CODE_NONE 0x00
154#define SSD_SELF_TEST_CODE_BG_SHORT 0x01
155#define SSD_SELF_TEST_CODE_BG_EXTENDED 0x02
156#define SSD_SELF_TEST_CODE_BG_ABORT 0x04
157#define SSD_SELF_TEST_CODE_FG_SHORT 0x05
158#define SSD_SELF_TEST_CODE_FG_EXTENDED 0x06
159 uint8_t reserved;
160 uint8_t length[2];
161 uint8_t control;
162};
163
164struct scsi_sense
165{
166 u_int8_t opcode;
167 u_int8_t byte2;
168 u_int8_t unused[2];
169 u_int8_t length;
170 u_int8_t control;
171};
172
173struct scsi_inquiry
174{
175 u_int8_t opcode;
176 u_int8_t byte2;
177#define SI_EVPD 0x01
178#define SI_CMDDT 0x02
179 u_int8_t page_code;
180 u_int8_t length[2];
181 u_int8_t control;
182};
183
184struct scsi_mode_sense_6
185{
186 u_int8_t opcode;
187 u_int8_t byte2;
188#define SMS_DBD 0x08
189 u_int8_t page;
190#define SMS_PAGE_CODE 0x3F
191#define SMS_VENDOR_SPECIFIC_PAGE 0x00
192#define SMS_DISCONNECT_RECONNECT_PAGE 0x02
193#define SMS_FORMAT_DEVICE_PAGE 0x03
194#define SMS_GEOMETRY_PAGE 0x04
195#define SMS_CACHE_PAGE 0x08
196#define SMS_PERIPHERAL_DEVICE_PAGE 0x09
197#define SMS_CONTROL_MODE_PAGE 0x0A
198#define SMS_PROTO_SPECIFIC_PAGE 0x19
199#define SMS_INFO_EXCEPTIONS_PAGE 0x1C
200#define SMS_ALL_PAGES_PAGE 0x3F
201#define SMS_PAGE_CTRL_MASK 0xC0
202#define SMS_PAGE_CTRL_CURRENT 0x00
203#define SMS_PAGE_CTRL_CHANGEABLE 0x40
204#define SMS_PAGE_CTRL_DEFAULT 0x80
205#define SMS_PAGE_CTRL_SAVED 0xC0
206 u_int8_t subpage;
207#define SMS_SUBPAGE_PAGE_0 0x00
208#define SMS_SUBPAGE_ALL 0xff
209 u_int8_t length;
210 u_int8_t control;
211};
212
213struct scsi_mode_sense_10
214{
215 u_int8_t opcode;
216 u_int8_t byte2; /* same bits as small version */
217#define SMS10_LLBAA 0x10
218 u_int8_t page; /* same bits as small version */
219 u_int8_t subpage;
220 u_int8_t unused[3];
221 u_int8_t length[2];
222 u_int8_t control;
223};
224
225struct scsi_mode_select_6
226{
227 u_int8_t opcode;
228 u_int8_t byte2;
229#define SMS_SP 0x01
230#define SMS_PF 0x10
231 u_int8_t unused[2];
232 u_int8_t length;
233 u_int8_t control;
234};
235
236struct scsi_mode_select_10
237{
238 u_int8_t opcode;
239 u_int8_t byte2; /* same bits as small version */
240 u_int8_t unused[5];
241 u_int8_t length[2];
242 u_int8_t control;
243};
244
245/*
246 * When sending a mode select to a tape drive, the medium type must be 0.
247 */
248struct scsi_mode_hdr_6
249{
250 u_int8_t datalen;
251 u_int8_t medium_type;
252 u_int8_t dev_specific;
253 u_int8_t block_descr_len;
254};
255
256struct scsi_mode_hdr_10
257{
258 u_int8_t datalen[2];
259 u_int8_t medium_type;
260 u_int8_t dev_specific;
261 u_int8_t reserved[2];
262 u_int8_t block_descr_len[2];
263};
264
265struct scsi_mode_block_descr
266{
267 u_int8_t density_code;
268 u_int8_t num_blocks[3];
269 u_int8_t reserved;
270 u_int8_t block_len[3];
271};
272
273struct scsi_per_res_in
274{
275 u_int8_t opcode;
276 u_int8_t action;
277#define SPRI_RK 0x00
278#define SPRI_RR 0x01
279#define SPRI_RC 0x02
280#define SPRI_RS 0x03
281 u_int8_t reserved[5];
282 u_int8_t length[2];
283#define SPRI_MAX_LEN 0xffff
284 u_int8_t control;
285};
286
287struct scsi_per_res_in_header
288{
289 u_int8_t generation[4];
290 u_int8_t length[4];
291};
292
293struct scsi_per_res_key
294{
295 u_int8_t key[8];
296};
297
298struct scsi_per_res_in_keys
299{
300 struct scsi_per_res_in_header header;
301 struct scsi_per_res_key keys[0];
302};
303
304struct scsi_per_res_cap
305{
306 uint8_t length[2];
307 uint8_t flags1;
308#define SPRI_RLR_C 0x80
309#define SPRI_CRH 0x10
310#define SPRI_SIP_C 0x08
311#define SPRI_ATP_C 0x04
312#define SPRI_PTPL_C 0x01
313 uint8_t flags2;
314#define SPRI_TMV 0x80
315#define SPRI_ALLOW_CMD_MASK 0x70
316#define SPRI_ALLOW_CMD_SHIFT 4
317#define SPRI_ALLOW_NA 0x00
318#define SPRI_ALLOW_1 0x10
319#define SPRI_ALLOW_2 0x20
320#define SPRI_ALLOW_3 0x30
321#define SPRI_ALLOW_4 0x40
322#define SPRI_ALLOW_5 0x50
323#define SPRI_PTPL_A 0x01
324 uint8_t type_mask[2];
325#define SPRI_TM_WR_EX_AR 0x8000
326#define SPRI_TM_EX_AC_RO 0x4000
327#define SPRI_TM_WR_EX_RO 0x2000
328#define SPRI_TM_EX_AC 0x0800
329#define SPRI_TM_WR_EX 0x0200
330#define SPRI_TM_EX_AC_AR 0x0001
331 uint8_t reserved[2];
332};
333
334struct scsi_per_res_in_rsrv_data
335{
336 uint8_t reservation[8];
337 uint8_t scope_addr[4];
338 uint8_t reserved;
339 uint8_t scopetype;
340#define SPRT_WE 0x01
341#define SPRT_EA 0x03
342#define SPRT_WERO 0x05
343#define SPRT_EARO 0x06
344#define SPRT_WEAR 0x07
345#define SPRT_EAAR 0x08
346 uint8_t extent_length[2];
347};
348
349struct scsi_per_res_in_rsrv
350{
351 struct scsi_per_res_in_header header;
352 struct scsi_per_res_in_rsrv_data data;
353};
354
355struct scsi_per_res_in_full_desc
356{
357 struct scsi_per_res_key res_key;
358 uint8_t reserved1[4];
359 uint8_t flags;
360#define SPRI_FULL_ALL_TG_PT 0x02
361#define SPRI_FULL_R_HOLDER 0x01
362 uint8_t scopetype;
363 uint8_t reserved2[4];
364 uint8_t rel_trgt_port_id[2];
365 uint8_t additional_length[4];
366 uint8_t transport_id[];
367};
368
369struct scsi_per_res_in_full
370{
371 struct scsi_per_res_in_header header;
372 struct scsi_per_res_in_full_desc desc[];
373};
374
375struct scsi_per_res_out
376{
377 u_int8_t opcode;
378 u_int8_t action;
379#define SPRO_REGISTER 0x00
380#define SPRO_RESERVE 0x01
381#define SPRO_RELEASE 0x02
382#define SPRO_CLEAR 0x03
383#define SPRO_PREEMPT 0x04
384#define SPRO_PRE_ABO 0x05
385#define SPRO_REG_IGNO 0x06
386#define SPRO_REG_MOVE 0x07
387#define SPRO_REPL_LOST_RES 0x08
388#define SPRO_ACTION_MASK 0x1f
389 u_int8_t scope_type;
390#define SPR_SCOPE_MASK 0xf0
391#define SPR_SCOPE_SHIFT 4
392#define SPR_LU_SCOPE 0x00
393#define SPR_EXTENT_SCOPE 0x10
394#define SPR_ELEMENT_SCOPE 0x20
395#define SPR_TYPE_MASK 0x0f
396#define SPR_TYPE_RD_SHARED 0x00
397#define SPR_TYPE_WR_EX 0x01
398#define SPR_TYPE_RD_EX 0x02
399#define SPR_TYPE_EX_AC 0x03
400#define SPR_TYPE_SHARED 0x04
401#define SPR_TYPE_WR_EX_RO 0x05
402#define SPR_TYPE_EX_AC_RO 0x06
403#define SPR_TYPE_WR_EX_AR 0x07
404#define SPR_TYPE_EX_AC_AR 0x08
405 u_int8_t reserved[2];
406 u_int8_t length[4];
407 u_int8_t control;
408};
409
410struct scsi_per_res_out_parms
411{
412 struct scsi_per_res_key res_key;
413 u_int8_t serv_act_res_key[8];
414 u_int8_t scope_spec_address[4];
415 u_int8_t flags;
416#define SPR_SPEC_I_PT 0x08
417#define SPR_ALL_TG_PT 0x04
418#define SPR_APTPL 0x01
419 u_int8_t reserved1;
420 u_int8_t extent_length[2];
421 u_int8_t transport_id_list[];
422};
423
424struct scsi_per_res_out_trans_ids {
425 u_int8_t additional_length[4];
426 u_int8_t transport_ids[];
427};
428
429/*
430 * Used with REGISTER AND MOVE serivce action of the PERSISTENT RESERVE OUT
431 * command.
432 */
433struct scsi_per_res_reg_move
434{
435 struct scsi_per_res_key res_key;
436 u_int8_t serv_act_res_key[8];
437 u_int8_t reserved;
438 u_int8_t flags;
439#define SPR_REG_MOVE_UNREG 0x02
440#define SPR_REG_MOVE_APTPL 0x01
441 u_int8_t rel_trgt_port_id[2];
442 u_int8_t transport_id_length[4];
443 u_int8_t transport_id[];
444};
445
446struct scsi_transportid_header
447{
448 uint8_t format_protocol;
449#define SCSI_TRN_FORMAT_MASK 0xc0
450#define SCSI_TRN_FORMAT_SHIFT 6
451#define SCSI_TRN_PROTO_MASK 0x0f
452};
453
454struct scsi_transportid_fcp
455{
456 uint8_t format_protocol;
457#define SCSI_TRN_FCP_FORMAT_DEFAULT 0x00
458 uint8_t reserved1[7];
459 uint8_t n_port_name[8];
460 uint8_t reserved2[8];
461};
462
463struct scsi_transportid_spi
464{
465 uint8_t format_protocol;
466#define SCSI_TRN_SPI_FORMAT_DEFAULT 0x00
467 uint8_t reserved1;
468 uint8_t scsi_addr[2];
469 uint8_t obsolete[2];
470 uint8_t rel_trgt_port_id[2];
471 uint8_t reserved2[16];
472};
473
474struct scsi_transportid_1394
475{
476 uint8_t format_protocol;
477#define SCSI_TRN_1394_FORMAT_DEFAULT 0x00
478 uint8_t reserved1[7];
479 uint8_t eui64[8];
480 uint8_t reserved2[8];
481};
482
483struct scsi_transportid_rdma
484{
485 uint8_t format_protocol;
486#define SCSI_TRN_RDMA_FORMAT_DEFAULT 0x00
487 uint8_t reserved[7];
488#define SCSI_TRN_RDMA_PORT_LEN 16
489 uint8_t initiator_port_id[SCSI_TRN_RDMA_PORT_LEN];
490};
491
492struct scsi_transportid_iscsi_device
493{
494 uint8_t format_protocol;
495#define SCSI_TRN_ISCSI_FORMAT_DEVICE 0x00
496 uint8_t reserved;
497 uint8_t additional_length[2];
498 uint8_t iscsi_name[];
499};
500
501struct scsi_transportid_iscsi_port
502{
503 uint8_t format_protocol;
504#define SCSI_TRN_ISCSI_FORMAT_PORT 0x40
505 uint8_t reserved;
506 uint8_t additional_length[2];
507 uint8_t iscsi_name[];
508 /*
509 * Followed by a separator and iSCSI initiator session ID
510 */
511};
512
513struct scsi_transportid_sas
514{
515 uint8_t format_protocol;
516#define SCSI_TRN_SAS_FORMAT_DEFAULT 0x00
517 uint8_t reserved1[3];
518 uint8_t sas_address[8];
519 uint8_t reserved2[12];
520};
521
522struct scsi_sop_routing_id_norm {
523 uint8_t bus;
524 uint8_t devfunc;
525#define SCSI_TRN_SOP_BUS_MAX 0xff
526#define SCSI_TRN_SOP_DEV_MAX 0x1f
527#define SCSI_TRN_SOP_DEV_MASK 0xf8
528#define SCSI_TRN_SOP_DEV_SHIFT 3
529#define SCSI_TRN_SOP_FUNC_NORM_MASK 0x07
530#define SCSI_TRN_SOP_FUNC_NORM_MAX 0x07
531};
532
533struct scsi_sop_routing_id_alt {
534 uint8_t bus;
535 uint8_t function;
536#define SCSI_TRN_SOP_FUNC_ALT_MAX 0xff
537};
538
539struct scsi_transportid_sop
540{
541 uint8_t format_protocol;
542#define SCSI_TRN_SOP_FORMAT_DEFAULT 0x00
543 uint8_t reserved1;
544 uint8_t routing_id[2];
545 uint8_t reserved2[20];
546};
547
548struct scsi_log_sense
549{
550 u_int8_t opcode;
551 u_int8_t byte2;
552#define SLS_SP 0x01
553#define SLS_PPC 0x02
554 u_int8_t page;
555#define SLS_PAGE_CODE 0x3F
556#define SLS_SUPPORTED_PAGES_PAGE 0x00
557#define SLS_OVERRUN_PAGE 0x01
558#define SLS_ERROR_WRITE_PAGE 0x02
559#define SLS_ERROR_READ_PAGE 0x03
560#define SLS_ERROR_READREVERSE_PAGE 0x04
561#define SLS_ERROR_VERIFY_PAGE 0x05
562#define SLS_ERROR_NONMEDIUM_PAGE 0x06
563#define SLS_ERROR_LASTN_PAGE 0x07
564#define SLS_LOGICAL_BLOCK_PROVISIONING 0x0c
565#define SLS_SELF_TEST_PAGE 0x10
566#define SLS_STAT_AND_PERF 0x19
567#define SLS_IE_PAGE 0x2f
568#define SLS_PAGE_CTRL_MASK 0xC0
569#define SLS_PAGE_CTRL_THRESHOLD 0x00
570#define SLS_PAGE_CTRL_CUMULATIVE 0x40
571#define SLS_PAGE_CTRL_THRESH_DEFAULT 0x80
572#define SLS_PAGE_CTRL_CUMUL_DEFAULT 0xC0
573 u_int8_t subpage;
574#define SLS_SUPPORTED_SUBPAGES_SUBPAGE 0xff
575 u_int8_t reserved;
576 u_int8_t paramptr[2];
577 u_int8_t length[2];
578 u_int8_t control;
579};
580
581struct scsi_log_select
582{
583 u_int8_t opcode;
584 u_int8_t byte2;
585/* SLS_SP 0x01 */
586#define SLS_PCR 0x02
587 u_int8_t page;
588/* SLS_PAGE_CTRL_MASK 0xC0 */
589/* SLS_PAGE_CTRL_THRESHOLD 0x00 */
590/* SLS_PAGE_CTRL_CUMULATIVE 0x40 */
591/* SLS_PAGE_CTRL_THRESH_DEFAULT 0x80 */
592/* SLS_PAGE_CTRL_CUMUL_DEFAULT 0xC0 */
593 u_int8_t reserved[4];
594 u_int8_t length[2];
595 u_int8_t control;
596};
597
598struct scsi_log_header
599{
600 u_int8_t page;
601#define SL_PAGE_CODE 0x3F
602#define SL_SPF 0x40
603#define SL_DS 0x80
604 u_int8_t subpage;
605 u_int8_t datalen[2];
606};
607
608struct scsi_log_param_header {
609 u_int8_t param_code[2];
610 u_int8_t param_control;
611#define SLP_LP 0x01
612#define SLP_LBIN 0x02
613#define SLP_TMC_MASK 0x0C
614#define SLP_TMC_ALWAYS 0x00
615#define SLP_TMC_EQUAL 0x04
616#define SLP_TMC_NOTEQUAL 0x08
617#define SLP_TMC_GREATER 0x0C
618#define SLP_ETC 0x10
619#define SLP_TSD 0x20
620#define SLP_DS 0x40
621#define SLP_DU 0x80
622 u_int8_t param_len;
623};
624
625struct scsi_log_stat_and_perf {
626 struct scsi_log_param_header hdr;
627#define SLP_SAP 0x0001
628 uint8_t read_num[8];
629 uint8_t write_num[8];
630 uint8_t recvieved_lba[8];
631 uint8_t transmitted_lba[8];
632 uint8_t read_int[8];
633 uint8_t write_int[8];
634 uint8_t weighted_num[8];
635 uint8_t weighted_int[8];
636};
637
638struct scsi_log_idle_time {
639 struct scsi_log_param_header hdr;
640#define SLP_IT 0x0002
641 uint8_t idle_int[8];
642};
643
644struct scsi_log_time_interval {
645 struct scsi_log_param_header hdr;
646#define SLP_TI 0x0003
647 uint8_t exponent[4];
648 uint8_t integer[4];
649};
650
651struct scsi_log_fua_stat_and_perf {
652 struct scsi_log_param_header hdr;
653#define SLP_FUA_SAP 0x0004
654 uint8_t fua_read_num[8];
655 uint8_t fua_write_num[8];
656 uint8_t fuanv_read_num[8];
657 uint8_t fuanv_write_num[8];
658 uint8_t fua_read_int[8];
659 uint8_t fua_write_int[8];
660 uint8_t fuanv_read_int[8];
661 uint8_t fuanv_write_int[8];
662};
663
664struct scsi_control_page {
665 u_int8_t page_code;
666 u_int8_t page_length;
667 u_int8_t rlec;
668#define SCP_RLEC 0x01 /*Report Log Exception Cond*/
669#define SCP_GLTSD 0x02 /*Global Logging target
670 save disable */
671#define SCP_DSENSE 0x04 /*Descriptor Sense */
672#define SCP_DPICZ 0x08 /*Disable Prot. Info Check
673 if Prot. Field is Zero */
674#define SCP_TMF_ONLY 0x10 /*TM Functions Only*/
675#define SCP_TST_MASK 0xE0 /*Task Set Type Mask*/
676#define SCP_TST_ONE 0x00 /*One Task Set*/
677#define SCP_TST_SEPARATE 0x20 /*Separate Task Sets*/
678 u_int8_t queue_flags;
679#define SCP_QUEUE_ALG_MASK 0xF0
680#define SCP_QUEUE_ALG_RESTRICTED 0x00
681#define SCP_QUEUE_ALG_UNRESTRICTED 0x10
682#define SCP_NUAR 0x08 /*No UA on release*/
683#define SCP_QUEUE_ERR 0x02 /*Queued I/O aborted for CACs*/
684#define SCP_QUEUE_DQUE 0x01 /*Queued I/O disabled*/
685 u_int8_t eca_and_aen;
686#define SCP_EECA 0x80 /*Enable Extended CA*/
687#define SCP_RAC 0x40 /*Report a check*/
688#define SCP_SWP 0x08 /*Software Write Protect*/
689#define SCP_RAENP 0x04 /*Ready AEN Permission*/
690#define SCP_UAAENP 0x02 /*UA AEN Permission*/
691#define SCP_EAENP 0x01 /*Error AEN Permission*/
692 u_int8_t flags4;
693#define SCP_ATO 0x80 /*Application tag owner*/
694#define SCP_TAS 0x40 /*Task aborted status*/
695#define SCP_ATMPE 0x20 /*Application tag mode page*/
696#define SCP_RWWP 0x10 /*Reject write without prot*/
697 u_int8_t aen_holdoff_period[2];
698 u_int8_t busy_timeout_period[2];
699 u_int8_t extended_selftest_completion_time[2];
700};
701
702struct scsi_control_ext_page {
703 uint8_t page_code;
704 uint8_t subpage_code;
705 uint8_t page_length[2];
706 uint8_t flags;
707#define SCEP_TCMOS 0x04 /* Timestamp Changeable by */
708#define SCEP_SCSIP 0x02 /* SCSI Precedence (clock) */
709#define SCEP_IALUAE 0x01 /* Implicit ALUA Enabled */
710 uint8_t prio;
711 uint8_t max_sense;
712 uint8_t reserve[25];
713};
714
715struct scsi_cache_page {
716 u_int8_t page_code;
717#define SCHP_PAGE_SAVABLE 0x80 /* Page is savable */
718 u_int8_t page_length;
719 u_int8_t cache_flags;
720#define SCHP_FLAGS_WCE 0x04 /* Write Cache Enable */
721#define SCHP_FLAGS_MF 0x02 /* Multiplication factor */
722#define SCHP_FLAGS_RCD 0x01 /* Read Cache Disable */
723 u_int8_t rw_cache_policy;
724 u_int8_t dis_prefetch[2];
725 u_int8_t min_prefetch[2];
726 u_int8_t max_prefetch[2];
727 u_int8_t max_prefetch_ceil[2];
728};
729
730/*
731 * XXX KDM
732 * Updated version of the cache page, as of SBC. Update this to SBC-3 and
733 * rationalize the two.
734 */
735struct scsi_caching_page {
736 uint8_t page_code;
737#define SMS_CACHING_PAGE 0x08
738 uint8_t page_length;
739 uint8_t flags1;
740#define SCP_IC 0x80
741#define SCP_ABPF 0x40
742#define SCP_CAP 0x20
743#define SCP_DISC 0x10
744#define SCP_SIZE 0x08
745#define SCP_WCE 0x04
746#define SCP_MF 0x02
747#define SCP_RCD 0x01
748 uint8_t ret_priority;
749 uint8_t disable_pf_transfer_len[2];
750 uint8_t min_prefetch[2];
751 uint8_t max_prefetch[2];
752 uint8_t max_pf_ceiling[2];
753 uint8_t flags2;
754#define SCP_FSW 0x80
755#define SCP_LBCSS 0x40
756#define SCP_DRA 0x20
757#define SCP_VS1 0x10
758#define SCP_VS2 0x08
759 uint8_t cache_segments;
760 uint8_t cache_seg_size[2];
761 uint8_t reserved;
762 uint8_t non_cache_seg_size[3];
763};
764
765/*
766 * XXX KDM move this off to a vendor shim.
767 */
768struct copan_debugconf_subpage {
769 uint8_t page_code;
770#define DBGCNF_PAGE_CODE 0x00
771 uint8_t subpage;
772#define DBGCNF_SUBPAGE_CODE 0xF0
773 uint8_t page_length[2];
774 uint8_t page_version;
775#define DBGCNF_VERSION 0x00
776 uint8_t ctl_time_io_secs[2];
777};
778
779
780struct scsi_info_exceptions_page {
781 u_int8_t page_code;
782#define SIEP_PAGE_SAVABLE 0x80 /* Page is savable */
783 u_int8_t page_length;
784 u_int8_t info_flags;
785#define SIEP_FLAGS_PERF 0x80
786#define SIEP_FLAGS_EBF 0x20
787#define SIEP_FLAGS_EWASC 0x10
788#define SIEP_FLAGS_DEXCPT 0x08
789#define SIEP_FLAGS_TEST 0x04
790#define SIEP_FLAGS_EBACKERR 0x02
791#define SIEP_FLAGS_LOGERR 0x01
792 u_int8_t mrie;
793 u_int8_t interval_timer[4];
794 u_int8_t report_count[4];
795};
796
797struct scsi_logical_block_provisioning_page_descr {
798 uint8_t flags;
799#define SLBPPD_ENABLED 0x80
800#define SLBPPD_TYPE_MASK 0x38
801#define SLBPPD_ARMING_MASK 0x07
802#define SLBPPD_ARMING_DEC 0x02
803#define SLBPPD_ARMING_INC 0x01
804 uint8_t resource;
805 uint8_t reserved[2];
806 uint8_t count[4];
807};
808
809struct scsi_logical_block_provisioning_page {
810 uint8_t page_code;
811 uint8_t subpage_code;
812 uint8_t page_length[2];
813 uint8_t flags;
814#define SLBPP_SITUA 0x01
815 uint8_t reserved[11];
816 struct scsi_logical_block_provisioning_page_descr descr[0];
817};
818
819/*
820 * SCSI protocol identifier values, current as of SPC4r36l.
821 */
822#define SCSI_PROTO_FC 0x00 /* Fibre Channel */
823#define SCSI_PROTO_SPI 0x01 /* Parallel SCSI */
824#define SCSI_PROTO_SSA 0x02 /* Serial Storage Arch. */
825#define SCSI_PROTO_1394 0x03 /* IEEE 1394 (Firewire) */
826#define SCSI_PROTO_RDMA 0x04 /* SCSI RDMA Protocol */
827#define SCSI_PROTO_ISCSI 0x05 /* Internet SCSI */
828#define SCSI_PROTO_iSCSI 0x05 /* Internet SCSI */
829#define SCSI_PROTO_SAS 0x06 /* SAS Serial SCSI Protocol */
830#define SCSI_PROTO_ADT 0x07 /* Automation/Drive Int. Trans. Prot.*/
831#define SCSI_PROTO_ADITP 0x07 /* Automation/Drive Int. Trans. Prot.*/
832#define SCSI_PROTO_ATA 0x08 /* AT Attachment Interface */
833#define SCSI_PROTO_UAS 0x09 /* USB Atached SCSI */
834#define SCSI_PROTO_SOP 0x0a /* SCSI over PCI Express */
835#define SCSI_PROTO_NONE 0x0f /* No specific protocol */
836
837struct scsi_proto_specific_page {
838 u_int8_t page_code;
839#define SPSP_PAGE_SAVABLE 0x80 /* Page is savable */
840 u_int8_t page_length;
841 u_int8_t protocol;
842#define SPSP_PROTO_FC SCSI_PROTO_FC
843#define SPSP_PROTO_SPI SCSI_PROTO_SPI
844#define SPSP_PROTO_SSA SCSI_PROTO_SSA
845#define SPSP_PROTO_1394 SCSI_PROTO_1394
846#define SPSP_PROTO_RDMA SCSI_PROTO_RDMA
847#define SPSP_PROTO_ISCSI SCSI_PROTO_ISCSI
848#define SPSP_PROTO_SAS SCSI_PROTO_SAS
849#define SPSP_PROTO_ADT SCSI_PROTO_ADITP
850#define SPSP_PROTO_ATA SCSI_PROTO_ATA
851#define SPSP_PROTO_UAS SCSI_PROTO_UAS
852#define SPSP_PROTO_SOP SCSI_PROTO_SOP
853#define SPSP_PROTO_NONE SCSI_PROTO_NONE
854};
855
856struct scsi_reserve
857{
858 u_int8_t opcode;
859 u_int8_t byte2;
860#define SR_EXTENT 0x01
861#define SR_ID_MASK 0x0e
862#define SR_3RDPTY 0x10
863#define SR_LUN_MASK 0xe0
864 u_int8_t resv_id;
865 u_int8_t length[2];
866 u_int8_t control;
867};
868
869struct scsi_reserve_10 {
870 uint8_t opcode;
871 uint8_t byte2;
872#define SR10_3RDPTY 0x10
873#define SR10_LONGID 0x02
874#define SR10_EXTENT 0x01
875 uint8_t resv_id;
876 uint8_t thirdparty_id;
877 uint8_t reserved[3];
878 uint8_t length[2];
879 uint8_t control;
880};
881
882
883struct scsi_release
884{
885 u_int8_t opcode;
886 u_int8_t byte2;
887 u_int8_t resv_id;
888 u_int8_t unused[1];
889 u_int8_t length;
890 u_int8_t control;
891};
892
893struct scsi_release_10 {
894 uint8_t opcode;
895 uint8_t byte2;
896 uint8_t resv_id;
897 uint8_t thirdparty_id;
898 uint8_t reserved[3];
899 uint8_t length[2];
900 uint8_t control;
901};
902
903struct scsi_prevent
904{
905 u_int8_t opcode;
906 u_int8_t byte2;
907 u_int8_t unused[2];
908 u_int8_t how;
909 u_int8_t control;
910};
911#define PR_PREVENT 0x01
912#define PR_ALLOW 0x00
913
914struct scsi_sync_cache
915{
916 u_int8_t opcode;
917 u_int8_t byte2;
918#define SSC_IMMED 0x02
919#define SSC_RELADR 0x01
920 u_int8_t begin_lba[4];
921 u_int8_t reserved;
922 u_int8_t lb_count[2];
923 u_int8_t control;
924};
925
926struct scsi_sync_cache_16
927{
928 uint8_t opcode;
929 uint8_t byte2;
930 uint8_t begin_lba[8];
931 uint8_t lb_count[4];
932 uint8_t reserved;
933 uint8_t control;
934};
935
936struct scsi_format {
937 uint8_t opcode;
938 uint8_t byte2;
939#define SF_LONGLIST 0x20
940#define SF_FMTDATA 0x10
941#define SF_CMPLIST 0x08
942#define SF_FORMAT_MASK 0x07
943#define SF_FORMAT_BLOCK 0x00
944#define SF_FORMAT_LONG_BLOCK 0x03
945#define SF_FORMAT_BFI 0x04
946#define SF_FORMAT_PHYS 0x05
947 uint8_t vendor;
948 uint8_t interleave[2];
949 uint8_t control;
950};
951
952struct scsi_format_header_short {
953 uint8_t reserved;
954#define SF_DATA_FOV 0x80
955#define SF_DATA_DPRY 0x40
956#define SF_DATA_DCRT 0x20
957#define SF_DATA_STPF 0x10
958#define SF_DATA_IP 0x08
959#define SF_DATA_DSP 0x04
960#define SF_DATA_IMMED 0x02
961#define SF_DATA_VS 0x01
962 uint8_t byte2;
963 uint8_t defect_list_len[2];
964};
965
966struct scsi_format_header_long {
967 uint8_t reserved;
968 uint8_t byte2;
969 uint8_t reserved2[2];
970 uint8_t defect_list_len[4];
971};
972
973struct scsi_changedef
974{
975 u_int8_t opcode;
976 u_int8_t byte2;
977 u_int8_t unused1;
978 u_int8_t how;
979 u_int8_t unused[4];
980 u_int8_t datalen;
981 u_int8_t control;
982};
983
984struct scsi_read_buffer
985{
986 u_int8_t opcode;
987 u_int8_t byte2;
988#define RWB_MODE 0x1F
989#define RWB_MODE_HDR_DATA 0x00
990#define RWB_MODE_VENDOR 0x01
991#define RWB_MODE_DATA 0x02
992#define RWB_MODE_DESCR 0x03
993#define RWB_MODE_DOWNLOAD 0x04
994#define RWB_MODE_DOWNLOAD_SAVE 0x05
995#define RWB_MODE_ECHO 0x0A
996#define RWB_MODE_ECHO_DESCR 0x0B
997#define RWB_MODE_ERROR_HISTORY 0x1C
998 u_int8_t buffer_id;
999 u_int8_t offset[3];
1000 u_int8_t length[3];
1001 u_int8_t control;
1002};
1003
1004struct scsi_read_buffer_16
1005{
1006 uint8_t opcode;
1007 uint8_t byte2;
1008 uint8_t offset[8];
1009 uint8_t length[4];
1010 uint8_t buffer_id;
1011 uint8_t control;
1012};
1013
1014struct scsi_write_buffer
1015{
1016 u_int8_t opcode;
1017 u_int8_t byte2;
1018 u_int8_t buffer_id;
1019 u_int8_t offset[3];
1020 u_int8_t length[3];
1021 u_int8_t control;
1022};
1023
1024struct scsi_read_attribute
1025{
1026 u_int8_t opcode;
1027 u_int8_t service_action;
1028#define SRA_SA_ATTR_VALUES 0x00
1029#define SRA_SA_ATTR_LIST 0x01
1030#define SRA_SA_LOG_VOL_LIST 0x02
1031#define SRA_SA_PART_LIST 0x03
1032#define SRA_SA_RESTRICTED 0x04
1033#define SRA_SA_SUPPORTED_ATTRS 0x05
1034#define SRA_SA_MASK 0x1f
1035 u_int8_t element[2];
1036 u_int8_t elem_type;
1037 u_int8_t logical_volume;
1038 u_int8_t reserved1;
1039 u_int8_t partition;
1040 u_int8_t first_attribute[2];
1041 u_int8_t length[4];
1042 u_int8_t cache;
1043#define SRA_CACHE 0x01
1044 u_int8_t control;
1045};
1046
1047struct scsi_write_attribute
1048{
1049 u_int8_t opcode;
1050 u_int8_t byte2;
1051#define SWA_WTC 0x01
1052 u_int8_t element[3];
1053 u_int8_t logical_volume;
1054 u_int8_t reserved1;
1055 u_int8_t partition;
1056 u_int8_t reserved2[2];
1057 u_int8_t length[4];
1058 u_int8_t reserved3;
1059 u_int8_t control;
1060};
1061
1062
1063struct scsi_read_attribute_values
1064{
1065 u_int8_t length[4];
1066 u_int8_t attribute_0[0];
1067};
1068
1069struct scsi_mam_attribute_header
1070{
1071 u_int8_t id[2];
1072 /*
1073 * Attributes obtained from SPC-4r36g (section 7.4.2.2) and
1074 * SSC-4r03 (section 4.2.21).
1075 */
1076#define SMA_ATTR_ID_DEVICE_MIN 0x0000
1077
1078#define SMA_ATTR_REM_CAP_PARTITION 0x0000
1079#define SMA_ATTR_MAX_CAP_PARTITION 0x0001
1080#define SMA_ATTR_TAPEALERT_FLAGS 0x0002
1081#define SMA_ATTR_LOAD_COUNT 0x0003
1082#define SMA_ATTR_MAM_SPACE_REMAINING 0x0004
1083
1084#define SMA_ATTR_DEV_ASSIGNING_ORG 0x0005
1085#define SMA_ATTR_FORMAT_DENSITY_CODE 0x0006
1086#define SMA_ATTR_INITIALIZATION_COUNT 0x0007
1087#define SMA_ATTR_VOLUME_ID 0x0008
1088#define SMA_ATTR_VOLUME_CHANGE_REF 0x0009
1089
1090#define SMA_ATTR_DEV_SERIAL_LAST_LOAD 0x020a
1091#define SMA_ATTR_DEV_SERIAL_LAST_LOAD_1 0x020b
1092#define SMA_ATTR_DEV_SERIAL_LAST_LOAD_2 0x020c
1093#define SMA_ATTR_DEV_SERIAL_LAST_LOAD_3 0x020d
1094
1095#define SMA_ATTR_TOTAL_MB_WRITTEN_LT 0x0220
1096#define SMA_ATTR_TOTAL_MB_READ_LT 0x0221
1097#define SMA_ATTR_TOTAL_MB_WRITTEN_CUR 0x0222
1098#define SMA_ATTR_TOTAL_MB_READ_CUR 0x0223
1099#define SMA_ATTR_FIRST_ENC_BLOCK 0x0224
1100#define SMA_ATTR_NEXT_UNENC_BLOCK 0x0225
1101
1102#define SMA_ATTR_MEDIUM_USAGE_HIST 0x0340
1103#define SMA_ATTR_PART_USAGE_HIST 0x0341
1104
1105#define SMA_ATTR_ID_DEVICE_MAX 0x03ff
1106
1107#define SMA_ATTR_ID_MEDIUM_MIN 0x0400
1108
1109#define SMA_ATTR_MED_MANUF 0x0400
1110#define SMA_ATTR_MED_SERIAL 0x0401
1111
1112#define SMA_ATTR_MED_LENGTH 0x0402
1113#define SMA_ATTR_MED_WIDTH 0x0403
1114#define SMA_ATTR_MED_ASSIGNING_ORG 0x0404
1115#define SMA_ATTR_MED_DENSITY_CODE 0x0405
1116
1117#define SMA_ATTR_MED_MANUF_DATE 0x0406
1118#define SMA_ATTR_MAM_CAPACITY 0x0407
1119#define SMA_ATTR_MED_TYPE 0x0408
1120#define SMA_ATTR_MED_TYPE_INFO 0x0409
1121#define SMA_ATTR_MED_SERIAL_NUM 0x040a
1122
1123#define SMA_ATTR_ID_MEDIUM_MAX 0x07ff
1124
1125#define SMA_ATTR_ID_HOST_MIN 0x0800
1126
1127#define SMA_ATTR_APP_VENDOR 0x0800
1128#define SMA_ATTR_APP_NAME 0x0801
1129#define SMA_ATTR_APP_VERSION 0x0802
1130#define SMA_ATTR_USER_MED_TEXT_LABEL 0x0803
1131#define SMA_ATTR_LAST_WRITTEN_TIME 0x0804
1132#define SMA_ATTR_TEXT_LOCAL_ID 0x0805
1133#define SMA_ATTR_BARCODE 0x0806
1134#define SMA_ATTR_HOST_OWNER_NAME 0x0807
1135#define SMA_ATTR_MEDIA_POOL 0x0808
1136#define SMA_ATTR_PART_USER_LABEL 0x0809
1137#define SMA_ATTR_LOAD_UNLOAD_AT_PART 0x080a
1138#define SMA_ATTR_APP_FORMAT_VERSION 0x080b
1139#define SMA_ATTR_VOL_COHERENCY_INFO 0x080c
1140
1141#define SMA_ATTR_ID_HOST_MAX 0x0bff
1142
1143#define SMA_ATTR_VENDOR_DEVICE_MIN 0x0c00
1144#define SMA_ATTR_VENDOR_DEVICE_MAX 0x0fff
1145#define SMA_ATTR_VENDOR_MEDIUM_MIN 0x1000
1146#define SMA_ATTR_VENDOR_MEDIUM_MAX 0x13ff
1147#define SMA_ATTR_VENDOR_HOST_MIN 0x1400
1148#define SMA_ATTR_VENDOR_HOST_MAX 0x17ff
1149 u_int8_t byte2;
1150#define SMA_FORMAT_BINARY 0x00
1151#define SMA_FORMAT_ASCII 0x01
1152#define SMA_FORMAT_TEXT 0x02
1153#define SMA_FORMAT_MASK 0x03
1154#define SMA_READ_ONLY 0x80
1155 u_int8_t length[2];
1156 u_int8_t attribute[0];
1157};
1158
1159struct scsi_attrib_list_header {
1160 u_int8_t length[4];
1161 u_int8_t first_attr_0[0];
1162};
1163
1164struct scsi_attrib_lv_list {
1165 u_int8_t length[2];
1166 u_int8_t first_lv_number;
1167 u_int8_t num_logical_volumes;
1168};
1169
1170struct scsi_attrib_vendser {
1171 uint8_t vendor[8];
1172 uint8_t serial_num[32];
1173};
1174
1175/*
1176 * These values are used to decode the Volume Coherency Information
1177 * Attribute (0x080c) for LTFS-format coherency information.
1178 * Although the Application Client Specific lengths are different for
1179 * Version 0 and Version 1, the data is in fact the same. The length
1180 * difference was due to a code bug.
1181 */
1182#define SCSI_LTFS_VER0_LEN 42
1183#define SCSI_LTFS_VER1_LEN 43
1184#define SCSI_LTFS_UUID_LEN 36
1185#define SCSI_LTFS_STR_NAME "LTFS"
1186#define SCSI_LTFS_STR_LEN 4
1187
1188typedef enum {
1189 SCSI_ATTR_FLAG_NONE = 0x00,
1190 SCSI_ATTR_FLAG_HEX = 0x01,
1191 SCSI_ATTR_FLAG_FP = 0x02,
1192 SCSI_ATTR_FLAG_DIV_10 = 0x04,
1193 SCSI_ATTR_FLAG_FP_1DIGIT = 0x08
1194} scsi_attrib_flags;
1195
1196typedef enum {
1197 SCSI_ATTR_OUTPUT_NONE = 0x00,
1198 SCSI_ATTR_OUTPUT_TEXT_MASK = 0x03,
1199 SCSI_ATTR_OUTPUT_TEXT_RAW = 0x00,
1200 SCSI_ATTR_OUTPUT_TEXT_ESC = 0x01,
1201 SCSI_ATTR_OUTPUT_TEXT_RSV1 = 0x02,
1202 SCSI_ATTR_OUTPUT_TEXT_RSV2 = 0x03,
1203 SCSI_ATTR_OUTPUT_NONASCII_MASK = 0x0c,
1204 SCSI_ATTR_OUTPUT_NONASCII_TRIM = 0x00,
1205 SCSI_ATTR_OUTPUT_NONASCII_ESC = 0x04,
1206 SCSI_ATTR_OUTPUT_NONASCII_RAW = 0x08,
1207 SCSI_ATTR_OUTPUT_NONASCII_RSV1 = 0x0c,
1208 SCSI_ATTR_OUTPUT_FIELD_MASK = 0xf0,
1209 SCSI_ATTR_OUTPUT_FIELD_ALL = 0xf0,
1210 SCSI_ATTR_OUTPUT_FIELD_NONE = 0x00,
1211 SCSI_ATTR_OUTPUT_FIELD_DESC = 0x10,
1212 SCSI_ATTR_OUTPUT_FIELD_NUM = 0x20,
1213 SCSI_ATTR_OUTPUT_FIELD_SIZE = 0x40,
1214 SCSI_ATTR_OUTPUT_FIELD_RW = 0x80
1215} scsi_attrib_output_flags;
1216
1217struct sbuf;
1218
1219struct scsi_attrib_table_entry
1220{
1221 u_int32_t id;
1222 u_int32_t flags;
1223 const char *desc;
1224 const char *suffix;
1225 int (*to_str)(struct sbuf *sb, struct scsi_mam_attribute_header *hdr,
1226 uint32_t valid_len, uint32_t flags,
1227 uint32_t output_flags, char *error_str,
1228 int error_str_len);
1229 int (*parse_str)(char *str, struct scsi_mam_attribute_header *hdr,
1230 uint32_t alloc_len, uint32_t flags, char *error_str,
1231 int error_str_len);
1232};
1233
1234struct scsi_rw_6
1235{
1236 u_int8_t opcode;
1237 u_int8_t addr[3];
1238/* only 5 bits are valid in the MSB address byte */
1239#define SRW_TOPADDR 0x1F
1240 u_int8_t length;
1241 u_int8_t control;
1242};
1243
1244struct scsi_rw_10
1245{
1246 u_int8_t opcode;
1247#define SRW10_RELADDR 0x01
1248/* EBP defined for WRITE(10) only */
1249#define SRW10_EBP 0x04
1250#define SRW10_FUA 0x08
1251#define SRW10_DPO 0x10
1252 u_int8_t byte2;
1253 u_int8_t addr[4];
1254 u_int8_t reserved;
1255 u_int8_t length[2];
1256 u_int8_t control;
1257};
1258
1259struct scsi_rw_12
1260{
1261 u_int8_t opcode;
1262#define SRW12_RELADDR 0x01
1263#define SRW12_FUA 0x08
1264#define SRW12_DPO 0x10
1265 u_int8_t byte2;
1266 u_int8_t addr[4];
1267 u_int8_t length[4];
1268 u_int8_t reserved;
1269 u_int8_t control;
1270};
1271
1272struct scsi_rw_16
1273{
1274 u_int8_t opcode;
1275#define SRW16_RELADDR 0x01
1276#define SRW16_FUA 0x08
1277#define SRW16_DPO 0x10
1278 u_int8_t byte2;
1279 u_int8_t addr[8];
1280 u_int8_t length[4];
1281 u_int8_t reserved;
1282 u_int8_t control;
1283};
1284
1285struct scsi_write_atomic_16
1286{
1287 uint8_t opcode;
1288 uint8_t byte2;
1289 uint8_t addr[8];
1290 uint8_t boundary[2];
1291 uint8_t length[2];
1292 uint8_t group;
1293 uint8_t control;
1294};
1295
1296struct scsi_write_same_10
1297{
1298 uint8_t opcode;
1299 uint8_t byte2;
1300#define SWS_LBDATA 0x02
1301#define SWS_PBDATA 0x04
1302#define SWS_UNMAP 0x08
1303#define SWS_ANCHOR 0x10
1304 uint8_t addr[4];
1305 uint8_t group;
1306 uint8_t length[2];
1307 uint8_t control;
1308};
1309
1310struct scsi_write_same_16
1311{
1312 uint8_t opcode;
1313 uint8_t byte2;
1314#define SWS_NDOB 0x01
1315 uint8_t addr[8];
1316 uint8_t length[4];
1317 uint8_t group;
1318 uint8_t control;
1319};
1320
1321struct scsi_unmap
1322{
1323 uint8_t opcode;
1324 uint8_t byte2;
1325#define SU_ANCHOR 0x01
1326 uint8_t reserved[4];
1327 uint8_t group;
1328 uint8_t length[2];
1329 uint8_t control;
1330};
1331
1332struct scsi_unmap_header
1333{
1334 uint8_t length[2];
1335 uint8_t desc_length[2];
1336 uint8_t reserved[4];
1337};
1338
1339struct scsi_unmap_desc
1340{
1341 uint8_t lba[8];
1342 uint8_t length[4];
1343 uint8_t reserved[4];
1344};
1345
1346struct scsi_write_verify_10
1347{
1348 uint8_t opcode;
1349 uint8_t byte2;
1350#define SWV_BYTCHK 0x02
1351#define SWV_DPO 0x10
1352#define SWV_WRPROECT_MASK 0xe0
1353 uint8_t addr[4];
1354 uint8_t group;
1355 uint8_t length[2];
1356 uint8_t control;
1357};
1358
1359struct scsi_write_verify_12
1360{
1361 uint8_t opcode;
1362 uint8_t byte2;
1363 uint8_t addr[4];
1364 uint8_t length[4];
1365 uint8_t group;
1366 uint8_t control;
1367};
1368
1369struct scsi_write_verify_16
1370{
1371 uint8_t opcode;
1372 uint8_t byte2;
1373 uint8_t addr[8];
1374 uint8_t length[4];
1375 uint8_t group;
1376 uint8_t control;
1377};
1378
1379
1380struct scsi_start_stop_unit
1381{
1382 u_int8_t opcode;
1383 u_int8_t byte2;
1384#define SSS_IMMED 0x01
1385 u_int8_t reserved[2];
1386 u_int8_t how;
1387#define SSS_START 0x01
1388#define SSS_LOEJ 0x02
1389#define SSS_PC_MASK 0xf0
1390#define SSS_PC_START_VALID 0x00
1391#define SSS_PC_ACTIVE 0x10
1392#define SSS_PC_IDLE 0x20
1393#define SSS_PC_STANDBY 0x30
1394#define SSS_PC_LU_CONTROL 0x70
1395#define SSS_PC_FORCE_IDLE_0 0xa0
1396#define SSS_PC_FORCE_STANDBY_0 0xb0
1397 u_int8_t control;
1398};
1399
1400struct ata_pass_12 {
1401 u_int8_t opcode;
1402 u_int8_t protocol;
1403#define AP_PROTO_HARD_RESET (0x00 << 1)
1404#define AP_PROTO_SRST (0x01 << 1)
1405#define AP_PROTO_NON_DATA (0x03 << 1)
1406#define AP_PROTO_PIO_IN (0x04 << 1)
1407#define AP_PROTO_PIO_OUT (0x05 << 1)
1408#define AP_PROTO_DMA (0x06 << 1)
1409#define AP_PROTO_DMA_QUEUED (0x07 << 1)
1410#define AP_PROTO_DEVICE_DIAG (0x08 << 1)
1411#define AP_PROTO_DEVICE_RESET (0x09 << 1)
1412#define AP_PROTO_UDMA_IN (0x0a << 1)
1413#define AP_PROTO_UDMA_OUT (0x0b << 1)
1414#define AP_PROTO_FPDMA (0x0c << 1)
1415#define AP_PROTO_RESP_INFO (0x0f << 1)
1416#define AP_PROTO_MASK 0x1e
1417#define AP_MULTI 0xe0
1418 u_int8_t flags;
1419#define AP_T_LEN 0x03
1420#define AP_BB 0x04
1421#define AP_T_DIR 0x08
1422#define AP_CK_COND 0x20
1423#define AP_OFFLINE 0x60
1424 u_int8_t features;
1425 u_int8_t sector_count;
1426 u_int8_t lba_low;
1427 u_int8_t lba_mid;
1428 u_int8_t lba_high;
1429 u_int8_t device;
1430 u_int8_t command;
1431 u_int8_t reserved;
1432 u_int8_t control;
1433};
1434
1435struct scsi_maintenance_in
1436{
1437 uint8_t opcode;
1438 uint8_t byte2;
1439#define SERVICE_ACTION_MASK 0x1f
1440#define SA_RPRT_TRGT_GRP 0x0a
1441 uint8_t reserved[4];
1442 uint8_t length[4];
1443 uint8_t reserved1;
1444 uint8_t control;
1445};
1446
1447struct scsi_report_supported_opcodes
1448{
1449 uint8_t opcode;
1450 uint8_t service_action;
1451 uint8_t options;
1452#define RSO_RCTD 0x80
1453#define RSO_OPTIONS_MASK 0x07
1454#define RSO_OPTIONS_ALL 0x00
1455#define RSO_OPTIONS_OC 0x01
1456#define RSO_OPTIONS_OC_SA 0x02
1457 uint8_t requested_opcode;
1458 uint8_t requested_service_action[2];
1459 uint8_t length[4];
1460 uint8_t reserved1;
1461 uint8_t control;
1462};
1463
1464struct scsi_report_supported_opcodes_timeout
1465{
1466 uint8_t length[2];
1467 uint8_t reserved;
1468 uint8_t cmd_specific;
1469 uint8_t nominal_time[4];
1470 uint8_t recommended_time[4];
1471};
1472
1473struct scsi_report_supported_opcodes_descr
1474{
1475 uint8_t opcode;
1476 uint8_t reserved;
1477 uint8_t service_action[2];
1478 uint8_t reserved2;
1479 uint8_t flags;
1480#define RSO_SERVACTV 0x01
1481#define RSO_CTDP 0x02
1482 uint8_t cdb_length[2];
1483 struct scsi_report_supported_opcodes_timeout timeout[0];
1484};
1485
1486struct scsi_report_supported_opcodes_all
1487{
1488 uint8_t length[4];
1489 struct scsi_report_supported_opcodes_descr descr[0];
1490};
1491
1492struct scsi_report_supported_opcodes_one
1493{
1494 uint8_t reserved;
1495 uint8_t support;
1496#define RSO_ONE_CTDP 0x80
1497#define RSO_ONE_SUP_MASK 0x07
1498#define RSO_ONE_SUP_UNAVAIL 0x00
1499#define RSO_ONE_SUP_NOT_SUP 0x01
1500#define RSO_ONE_SUP_AVAIL 0x03
1501#define RSO_ONE_SUP_VENDOR 0x05
1502 uint8_t cdb_length[2];
1503 uint8_t cdb_usage[];
1504};
1505
1506struct scsi_report_supported_tmf
1507{
1508 uint8_t opcode;
1509 uint8_t service_action;
1510 uint8_t reserved[4];
1511 uint8_t length[4];
1512 uint8_t reserved1;
1513 uint8_t control;
1514};
1515
1516struct scsi_report_supported_tmf_data
1517{
1518 uint8_t byte1;
1519#define RST_WAKES 0x01
1520#define RST_TRS 0x02
1521#define RST_QTS 0x04
1522#define RST_LURS 0x08
1523#define RST_CTSS 0x10
1524#define RST_CACAS 0x20
1525#define RST_ATSS 0x40
1526#define RST_ATS 0x80
1527 uint8_t byte2;
1528#define RST_ITNRS 0x01
1529#define RST_QTSS 0x02
1530#define RST_QAES 0x04
1531 uint8_t reserved[2];
1532};
1533
1534struct scsi_report_timestamp
1535{
1536 uint8_t opcode;
1537 uint8_t service_action;
1538 uint8_t reserved[4];
1539 uint8_t length[4];
1540 uint8_t reserved1;
1541 uint8_t control;
1542};
1543
1544struct scsi_report_timestamp_data
1545{
1546 uint8_t length[2];
1547 uint8_t origin;
1548#define RTS_ORIG_MASK 0x00
1549#define RTS_ORIG_ZERO 0x00
1550#define RTS_ORIG_SET 0x02
1551#define RTS_ORIG_OUTSIDE 0x03
1552 uint8_t reserved;
1553 uint8_t timestamp[6];
1554 uint8_t reserve2[2];
1555};
1556
1557struct scsi_receive_copy_status_lid1
1558{
1559 uint8_t opcode;
1560 uint8_t service_action;
1561#define RCS_RCS_LID1 0x00
1562 uint8_t list_identifier;
1563 uint8_t reserved[7];
1564 uint8_t length[4];
1565 uint8_t reserved1;
1566 uint8_t control;
1567};
1568
1569struct scsi_receive_copy_status_lid1_data
1570{
1571 uint8_t available_data[4];
1572 uint8_t copy_command_status;
1573#define RCS_CCS_INPROG 0x00
1574#define RCS_CCS_COMPLETED 0x01
1575#define RCS_CCS_ERROR 0x02
1576 uint8_t segments_processed[2];
1577 uint8_t transfer_count_units;
1578#define RCS_TC_BYTES 0x00
1579#define RCS_TC_KBYTES 0x01
1580#define RCS_TC_MBYTES 0x02
1581#define RCS_TC_GBYTES 0x03
1582#define RCS_TC_TBYTES 0x04
1583#define RCS_TC_PBYTES 0x05
1584#define RCS_TC_EBYTES 0x06
1585#define RCS_TC_LBAS 0xf1
1586 uint8_t transfer_count[4];
1587};
1588
1589struct scsi_receive_copy_failure_details
1590{
1591 uint8_t opcode;
1592 uint8_t service_action;
1593#define RCS_RCFD 0x04
1594 uint8_t list_identifier;
1595 uint8_t reserved[7];
1596 uint8_t length[4];
1597 uint8_t reserved1;
1598 uint8_t control;
1599};
1600
1601struct scsi_receive_copy_failure_details_data
1602{
1603 uint8_t available_data[4];
1604 uint8_t reserved[52];
1605 uint8_t copy_command_status;
1606 uint8_t reserved2;
1607 uint8_t sense_data_length[2];
1608 uint8_t sense_data[];
1609};
1610
1611struct scsi_receive_copy_status_lid4
1612{
1613 uint8_t opcode;
1614 uint8_t service_action;
1615#define RCS_RCS_LID4 0x05
1616 uint8_t list_identifier[4];
1617 uint8_t reserved[4];
1618 uint8_t length[4];
1619 uint8_t reserved1;
1620 uint8_t control;
1621};
1622
1623struct scsi_receive_copy_status_lid4_data
1624{
1625 uint8_t available_data[4];
1626 uint8_t response_to_service_action;
1627 uint8_t copy_command_status;
1628#define RCS_CCS_COMPLETED_PROD 0x03
1629#define RCS_CCS_COMPLETED_RESID 0x04
1630#define RCS_CCS_INPROG_FGBG 0x10
1631#define RCS_CCS_INPROG_FG 0x11
1632#define RCS_CCS_INPROG_BG 0x12
1633#define RCS_CCS_ABORTED 0x60
1634 uint8_t operation_counter[2];
1635 uint8_t estimated_status_update_delay[4];
1636 uint8_t extended_copy_completion_status;
1637 uint8_t length_of_the_sense_data_field;
1638 uint8_t sense_data_length;
1639 uint8_t transfer_count_units;
1640 uint8_t transfer_count[8];
1641 uint8_t segments_processed[2];
1642 uint8_t reserved[6];
1643 uint8_t sense_data[];
1644};
1645
1646struct scsi_receive_copy_operating_parameters
1647{
1648 uint8_t opcode;
1649 uint8_t service_action;
1650#define RCS_RCOP 0x03
1651 uint8_t reserved[8];
1652 uint8_t length[4];
1653 uint8_t reserved1;
1654 uint8_t control;
1655};
1656
1657struct scsi_receive_copy_operating_parameters_data
1658{
1659 uint8_t length[4];
1660 uint8_t snlid;
1661#define RCOP_SNLID 0x01
1662 uint8_t reserved[3];
1663 uint8_t maximum_cscd_descriptor_count[2];
1664 uint8_t maximum_segment_descriptor_count[2];
1665 uint8_t maximum_descriptor_list_length[4];
1666 uint8_t maximum_segment_length[4];
1667 uint8_t maximum_inline_data_length[4];
1668 uint8_t held_data_limit[4];
1669 uint8_t maximum_stream_device_transfer_size[4];
1670 uint8_t reserved2[2];
1671 uint8_t total_concurrent_copies[2];
1672 uint8_t maximum_concurrent_copies;
1673 uint8_t data_segment_granularity;
1674 uint8_t inline_data_granularity;
1675 uint8_t held_data_granularity;
1676 uint8_t reserved3[3];
1677 uint8_t implemented_descriptor_list_length;
1678 uint8_t list_of_implemented_descriptor_type_codes[0];
1679};
1680
1681struct scsi_extended_copy
1682{
1683 uint8_t opcode;
1684 uint8_t service_action;
1685#define EC_EC_LID1 0x00
1686#define EC_EC_LID4 0x01
1687 uint8_t reserved[8];
1688 uint8_t length[4];
1689 uint8_t reserved1;
1690 uint8_t control;
1691};
1692
1693struct scsi_ec_cscd_dtsp
1694{
1695 uint8_t flags;
1696#define EC_CSCD_FIXED 0x01
1697#define EC_CSCD_PAD 0x04
1698 uint8_t block_length[3];
1699};
1700
1701struct scsi_ec_cscd
1702{
1703 uint8_t type_code;
1704#define EC_CSCD_EXT 0xff
1705 uint8_t luidt_pdt;
1706#define EC_NUL 0x20
1707#define EC_LUIDT_MASK 0xc0
1708#define EC_LUIDT_LUN 0x00
1709#define EC_LUIDT_PROXY_TOKEN 0x40
1710 uint8_t relative_initiator_port[2];
1711 uint8_t cscd_params[24];
1712 struct scsi_ec_cscd_dtsp dtsp;
1713};
1714
1715struct scsi_ec_cscd_id
1716{
1717 uint8_t type_code;
1718#define EC_CSCD_ID 0xe4
1719 uint8_t luidt_pdt;
1720 uint8_t relative_initiator_port[2];
1721 uint8_t codeset;
1722 uint8_t id_type;
1723 uint8_t reserved;
1724 uint8_t length;
1725 uint8_t designator[20];
1726 struct scsi_ec_cscd_dtsp dtsp;
1727};
1728
1729struct scsi_ec_segment
1730{
1731 uint8_t type_code;
1732 uint8_t flags;
1733#define EC_SEG_DC 0x02
1734#define EC_SEG_CAT 0x01
1735 uint8_t descr_length[2];
1736 uint8_t params[];
1737};
1738
1739struct scsi_ec_segment_b2b
1740{
1741 uint8_t type_code;
1742#define EC_SEG_B2B 0x02
1743 uint8_t flags;
1744 uint8_t descr_length[2];
1745 uint8_t src_cscd[2];
1746 uint8_t dst_cscd[2];
1747 uint8_t reserved[2];
1748 uint8_t number_of_blocks[2];
1749 uint8_t src_lba[8];
1750 uint8_t dst_lba[8];
1751};
1752
1753struct scsi_ec_segment_verify
1754{
1755 uint8_t type_code;
1756#define EC_SEG_VERIFY 0x07
1757 uint8_t reserved;
1758 uint8_t descr_length[2];
1759 uint8_t src_cscd[2];
1760 uint8_t reserved2[2];
1761 uint8_t tur;
1762 uint8_t reserved3[3];
1763};
1764
1765struct scsi_ec_segment_register_key
1766{
1767 uint8_t type_code;
1768#define EC_SEG_REGISTER_KEY 0x14
1769 uint8_t reserved;
1770 uint8_t descr_length[2];
1771 uint8_t reserved2[2];
1772 uint8_t dst_cscd[2];
1773 uint8_t res_key[8];
1774 uint8_t sa_res_key[8];
1775 uint8_t reserved3[4];
1776};
1777
1778struct scsi_extended_copy_lid1_data
1779{
1780 uint8_t list_identifier;
1781 uint8_t flags;
1782#define EC_PRIORITY 0x07
1783#define EC_LIST_ID_USAGE_MASK 0x18
1784#define EC_LIST_ID_USAGE_FULL 0x08
1785#define EC_LIST_ID_USAGE_NOHOLD 0x10
1786#define EC_LIST_ID_USAGE_NONE 0x18
1787#define EC_STR 0x20
1788 uint8_t cscd_list_length[2];
1789 uint8_t reserved[4];
1790 uint8_t segment_list_length[4];
1791 uint8_t inline_data_length[4];
1792 uint8_t data[];
1793};
1794
1795struct scsi_extended_copy_lid4_data
1796{
1797 uint8_t list_format;
1798#define EC_LIST_FORMAT 0x01
1799 uint8_t flags;
1800 uint8_t header_cscd_list_length[2];
1801 uint8_t reserved[11];
1802 uint8_t flags2;
1803#define EC_IMMED 0x01
1804#define EC_G_SENSE 0x02
1805 uint8_t header_cscd_type_code;
1806 uint8_t reserved2[3];
1807 uint8_t list_identifier[4];
1808 uint8_t reserved3[18];
1809 uint8_t cscd_list_length[2];
1810 uint8_t segment_list_length[2];
1811 uint8_t inline_data_length[2];
1812 uint8_t data[];
1813};
1814
1815struct scsi_copy_operation_abort
1816{
1817 uint8_t opcode;
1818 uint8_t service_action;
1819#define EC_COA 0x1c
1820 uint8_t list_identifier[4];
1821 uint8_t reserved[9];
1822 uint8_t control;
1823};
1824
1825struct scsi_populate_token
1826{
1827 uint8_t opcode;
1828 uint8_t service_action;
1829#define EC_PT 0x10
1830 uint8_t reserved[4];
1831 uint8_t list_identifier[4];
1832 uint8_t length[4];
1833 uint8_t group_number;
1834 uint8_t control;
1835};
1836
1837struct scsi_range_desc
1838{
1839 uint8_t lba[8];
1840 uint8_t length[4];
1841 uint8_t reserved[4];
1842};
1843
1844struct scsi_populate_token_data
1845{
1846 uint8_t length[2];
1847 uint8_t flags;
1848#define EC_PT_IMMED 0x01
1849#define EC_PT_RTV 0x02
1850 uint8_t reserved;
1851 uint8_t inactivity_timeout[4];
1852 uint8_t rod_type[4];
1853 uint8_t reserved2[2];
1854 uint8_t range_descriptor_length[2];
1855 struct scsi_range_desc desc[];
1856};
1857
1858struct scsi_write_using_token
1859{
1860 uint8_t opcode;
1861 uint8_t service_action;
1862#define EC_WUT 0x11
1863 uint8_t reserved[4];
1864 uint8_t list_identifier[4];
1865 uint8_t length[4];
1866 uint8_t group_number;
1867 uint8_t control;
1868};
1869
1870struct scsi_write_using_token_data
1871{
1872 uint8_t length[2];
1873 uint8_t flags;
1874#define EC_WUT_IMMED 0x01
1875#define EC_WUT_DEL_TKN 0x02
1876 uint8_t reserved[5];
1877 uint8_t offset_into_rod[8];
1878 uint8_t rod_token[512];
1879 uint8_t reserved2[6];
1880 uint8_t range_descriptor_length[2];
1881 struct scsi_range_desc desc[];
1882};
1883
1884struct scsi_receive_rod_token_information
1885{
1886 uint8_t opcode;
1887 uint8_t service_action;
1888#define RCS_RRTI 0x07
1889 uint8_t list_identifier[4];
1890 uint8_t reserved[4];
1891 uint8_t length[4];
1892 uint8_t reserved2;
1893 uint8_t control;
1894};
1895
1896struct scsi_token
1897{
1898 uint8_t type[4];
1899#define ROD_TYPE_INTERNAL 0x00000000
1900#define ROD_TYPE_AUR 0x00010000
1901#define ROD_TYPE_PIT_DEF 0x00800000
1902#define ROD_TYPE_PIT_VULN 0x00800001
1903#define ROD_TYPE_PIT_PERS 0x00800002
1904#define ROD_TYPE_PIT_ANY 0x0080FFFF
1905#define ROD_TYPE_BLOCK_ZERO 0xFFFF0001
1906 uint8_t reserved[2];
1907 uint8_t length[2];
1908 uint8_t body[0];
1909};
1910
1911struct scsi_report_all_rod_tokens
1912{
1913 uint8_t opcode;
1914 uint8_t service_action;
1915#define RCS_RART 0x08
1916 uint8_t reserved[8];
1917 uint8_t length[4];
1918 uint8_t reserved2;
1919 uint8_t control;
1920};
1921
1922struct scsi_report_all_rod_tokens_data
1923{
1924 uint8_t available_data[4];
1925 uint8_t reserved[4];
1926 uint8_t rod_management_token_list[];
1927};
1928
1929struct ata_pass_16 {
1930 u_int8_t opcode;
1931 u_int8_t protocol;
1932#define AP_EXTEND 0x01
1933 u_int8_t flags;
1934#define AP_FLAG_TLEN_NO_DATA (0 << 0)
1935#define AP_FLAG_TLEN_FEAT (1 << 0)
1936#define AP_FLAG_TLEN_SECT_CNT (2 << 0)
1937#define AP_FLAG_TLEN_STPSIU (3 << 0)
1938#define AP_FLAG_BYT_BLOK_BYTES (0 << 2)
1939#define AP_FLAG_BYT_BLOK_BLOCKS (1 << 2)
1940#define AP_FLAG_TDIR_TO_DEV (0 << 3)
1941#define AP_FLAG_TDIR_FROM_DEV (1 << 3)
1942#define AP_FLAG_CHK_COND (1 << 5)
1943 u_int8_t features_ext;
1944 u_int8_t features;
1945 u_int8_t sector_count_ext;
1946 u_int8_t sector_count;
1947 u_int8_t lba_low_ext;
1948 u_int8_t lba_low;
1949 u_int8_t lba_mid_ext;
1950 u_int8_t lba_mid;
1951 u_int8_t lba_high_ext;
1952 u_int8_t lba_high;
1953 u_int8_t device;
1954 u_int8_t command;
1955 u_int8_t control;
1956};
1957
1958struct ata_pass_32 {
1959 uint8_t opcode;
1960 uint8_t control;
1961 uint8_t reserved1[5];
1962 uint8_t length;
1963 uint8_t service_action[2];
1964#define ATA_PASS_32_SA 0x1ff0
1965 uint8_t protocol;
1966 uint8_t flags;
1967 uint8_t reserved2[2];
1968 uint8_t lba[6];
1969 uint8_t features[2];
1970 uint8_t count[2];
1971 uint8_t device;
1972 uint8_t command;
1973 uint8_t reserved3;
1974 uint8_t icc;
1975 uint8_t auxiliary[4];
1976};
1977
1978
1979#define SC_SCSI_1 0x01
1980#define SC_SCSI_2 0x03
1981
1982/*
1983 * Opcodes
1984 */
1985
1986#define TEST_UNIT_READY 0x00
1987#define REQUEST_SENSE 0x03
1988#define READ_6 0x08
1989#define WRITE_6 0x0A
1990#define INQUIRY 0x12
1991#define MODE_SELECT_6 0x15
1992#define MODE_SENSE_6 0x1A
1993#define START_STOP_UNIT 0x1B
1994#define START_STOP 0x1B
1995#define RESERVE 0x16
1996#define RELEASE 0x17
1997#define RECEIVE_DIAGNOSTIC 0x1C
1998#define SEND_DIAGNOSTIC 0x1D
1999#define PREVENT_ALLOW 0x1E
2000#define READ_CAPACITY 0x25
2001#define READ_10 0x28
2002#define WRITE_10 0x2A
2003#define POSITION_TO_ELEMENT 0x2B
2004#define WRITE_VERIFY_10 0x2E
2005#define VERIFY_10 0x2F
2006#define SYNCHRONIZE_CACHE 0x35
2007#define READ_DEFECT_DATA_10 0x37
2008#define WRITE_BUFFER 0x3B
2009#define READ_BUFFER 0x3C
2010#define CHANGE_DEFINITION 0x40
2011#define WRITE_SAME_10 0x41
2012#define UNMAP 0x42
2013#define LOG_SELECT 0x4C
2014#define LOG_SENSE 0x4D
2015#define MODE_SELECT_10 0x55
2016#define RESERVE_10 0x56
2017#define RELEASE_10 0x57
2018#define MODE_SENSE_10 0x5A
2019#define PERSISTENT_RES_IN 0x5E
2020#define PERSISTENT_RES_OUT 0x5F
2021#define EXTENDED_CDB 0x7E
2022#define VARIABLE_LEN_CDB 0x7F
2023#define EXTENDED_COPY 0x83
2024#define RECEIVE_COPY_STATUS 0x84
2025#define ATA_PASS_16 0x85
2026#define READ_16 0x88
2027#define COMPARE_AND_WRITE 0x89
2028#define WRITE_16 0x8A
2029#define READ_ATTRIBUTE 0x8C
2030#define WRITE_ATTRIBUTE 0x8D
2031#define WRITE_VERIFY_16 0x8E
2032#define VERIFY_16 0x8F
2033#define SYNCHRONIZE_CACHE_16 0x91
2034#define WRITE_SAME_16 0x93
2035#define READ_BUFFER_16 0x9B
2036#define WRITE_ATOMIC_16 0x9C
2037#define SERVICE_ACTION_IN 0x9E
2038#define REPORT_LUNS 0xA0
2039#define ATA_PASS_12 0xA1
2040#define SECURITY_PROTOCOL_IN 0xA2
2041#define MAINTENANCE_IN 0xA3
2042#define MAINTENANCE_OUT 0xA4
2043#define MOVE_MEDIUM 0xA5
2044#define READ_12 0xA8
2045#define WRITE_12 0xAA
2046#define WRITE_VERIFY_12 0xAE
2047#define VERIFY_12 0xAF
2048#define SECURITY_PROTOCOL_OUT 0xB5
2049#define READ_ELEMENT_STATUS 0xB8
2050#define READ_CD 0xBE
2051
2052/* Maintenance In Service Action Codes */
2053#define REPORT_IDENTIFYING_INFRMATION 0x05
2054#define REPORT_TARGET_PORT_GROUPS 0x0A
2055#define REPORT_ALIASES 0x0B
2056#define REPORT_SUPPORTED_OPERATION_CODES 0x0C
2057#define REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS 0x0D
2058#define REPORT_PRIORITY 0x0E
2059#define REPORT_TIMESTAMP 0x0F
2060#define MANAGEMENT_PROTOCOL_IN 0x10
2061/* Maintenance Out Service Action Codes */
2062#define SET_IDENTIFY_INFORMATION 0x06
2063#define SET_TARGET_PORT_GROUPS 0x0A
2064#define CHANGE_ALIASES 0x0B
2065#define SET_PRIORITY 0x0E
2066#define SET_TIMESTAMP 0x0F
2067#define MANGAEMENT_PROTOCOL_OUT 0x10
2068
2069/*
2070 * Device Types
2071 */
2072#define T_DIRECT 0x00
2073#define T_SEQUENTIAL 0x01
2074#define T_PRINTER 0x02
2075#define T_PROCESSOR 0x03
2076#define T_WORM 0x04
2077#define T_CDROM 0x05
2078#define T_SCANNER 0x06
2079#define T_OPTICAL 0x07
2080#define T_CHANGER 0x08
2081#define T_COMM 0x09
2082#define T_ASC0 0x0a
2083#define T_ASC1 0x0b
2084#define T_STORARRAY 0x0c
2085#define T_ENCLOSURE 0x0d
2086#define T_RBC 0x0e
2087#define T_OCRW 0x0f
2088#define T_OSD 0x11
2089#define T_ADC 0x12
2090#define T_ZBC_HM 0x14
2091#define T_NODEVICE 0x1f
2092#define T_ANY 0xff /* Used in Quirk table matches */
2093
2094#define T_REMOV 1
2095#define T_FIXED 0
2096
2097/*
2098 * This length is the initial inquiry length used by the probe code, as
2099 * well as the length necessary for scsi_print_inquiry() to function
2100 * correctly. If either use requires a different length in the future,
2101 * the two values should be de-coupled.
2102 */
2103#define SHORT_INQUIRY_LENGTH 36
2104
2105struct scsi_inquiry_data
2106{
2107 u_int8_t device;
2108#define SID_TYPE(inq_data) ((inq_data)->device & 0x1f)
2109#define SID_QUAL(inq_data) (((inq_data)->device & 0xE0) >> 5)
2110#define SID_QUAL_LU_CONNECTED 0x00 /*
2111 * The specified peripheral device
2112 * type is currently connected to
2113 * logical unit. If the target cannot
2114 * determine whether or not a physical
2115 * device is currently connected, it
2116 * shall also use this peripheral
2117 * qualifier when returning the INQUIRY
2118 * data. This peripheral qualifier
2119 * does not mean that the device is
2120 * ready for access by the initiator.
2121 */
2122#define SID_QUAL_LU_OFFLINE 0x01 /*
2123 * The target is capable of supporting
2124 * the specified peripheral device type
2125 * on this logical unit; however, the
2126 * physical device is not currently
2127 * connected to this logical unit.
2128 */
2129#define SID_QUAL_RSVD 0x02
2130#define SID_QUAL_BAD_LU 0x03 /*
2131 * The target is not capable of
2132 * supporting a physical device on
2133 * this logical unit. For this
2134 * peripheral qualifier the peripheral
2135 * device type shall be set to 1Fh to
2136 * provide compatibility with previous
2137 * versions of SCSI. All other
2138 * peripheral device type values are
2139 * reserved for this peripheral
2140 * qualifier.
2141 */
2142#define SID_QUAL_IS_VENDOR_UNIQUE(inq_data) ((SID_QUAL(inq_data) & 0x04) != 0)
2143 u_int8_t dev_qual2;
2144#define SID_QUAL2 0x7F
2145#define SID_LU_CONG 0x40
2146#define SID_RMB 0x80
2147#define SID_IS_REMOVABLE(inq_data) (((inq_data)->dev_qual2 & SID_RMB) != 0)
2148 u_int8_t version;
2149#define SID_ANSI_REV(inq_data) ((inq_data)->version & 0x07)
2150#define SCSI_REV_0 0
2151#define SCSI_REV_CCS 1
2152#define SCSI_REV_2 2
2153#define SCSI_REV_SPC 3
2154#define SCSI_REV_SPC2 4
2155#define SCSI_REV_SPC3 5
2156#define SCSI_REV_SPC4 6
2157
2158#define SID_ECMA 0x38
2159#define SID_ISO 0xC0
2160 u_int8_t response_format;
2161#define SID_AENC 0x80
2162#define SID_TrmIOP 0x40
2163#define SID_NormACA 0x20
2164#define SID_HiSup 0x10
2165 u_int8_t additional_length;
2166#define SID_ADDITIONAL_LENGTH(iqd) \
2167 ((iqd)->additional_length + \
2168 __offsetof(struct scsi_inquiry_data, additional_length) + 1)
2169 u_int8_t spc3_flags;
2170#define SPC3_SID_PROTECT 0x01
2171#define SPC3_SID_3PC 0x08
2172#define SPC3_SID_TPGS_MASK 0x30
2173#define SPC3_SID_TPGS_IMPLICIT 0x10
2174#define SPC3_SID_TPGS_EXPLICIT 0x20
2175#define SPC3_SID_ACC 0x40
2176#define SPC3_SID_SCCS 0x80
2177 u_int8_t spc2_flags;
2178#define SPC2_SID_ADDR16 0x01
2179#define SPC2_SID_MChngr 0x08
2180#define SPC2_SID_MultiP 0x10
2181#define SPC2_SID_EncServ 0x40
2182#define SPC2_SID_BQueue 0x80
2183
2184#define INQ_DATA_TQ_ENABLED(iqd) \
2185 ((SID_ANSI_REV(iqd) < SCSI_REV_SPC2)? ((iqd)->flags & SID_CmdQue) : \
2186 (((iqd)->flags & SID_CmdQue) && !((iqd)->spc2_flags & SPC2_SID_BQueue)) || \
2187 (!((iqd)->flags & SID_CmdQue) && ((iqd)->spc2_flags & SPC2_SID_BQueue)))
2188
2189 u_int8_t flags;
2190#define SID_SftRe 0x01
2191#define SID_CmdQue 0x02
2192#define SID_Linked 0x08
2193#define SID_Sync 0x10
2194#define SID_WBus16 0x20
2195#define SID_WBus32 0x40
2196#define SID_RelAdr 0x80
2197#define SID_VENDOR_SIZE 8
2198 char vendor[SID_VENDOR_SIZE];
2199#define SID_PRODUCT_SIZE 16
2200 char product[SID_PRODUCT_SIZE];
2201#define SID_REVISION_SIZE 4
2202 char revision[SID_REVISION_SIZE];
2203 /*
2204 * The following fields were taken from SCSI Primary Commands - 2
2205 * (SPC-2) Revision 14, Dated 11 November 1999
2206 */
2207#define SID_VENDOR_SPECIFIC_0_SIZE 20
2208 u_int8_t vendor_specific0[SID_VENDOR_SPECIFIC_0_SIZE];
2209 /*
2210 * An extension of SCSI Parallel Specific Values
2211 */
2212#define SID_SPI_IUS 0x01
2213#define SID_SPI_QAS 0x02
2214#define SID_SPI_CLOCK_ST 0x00
2215#define SID_SPI_CLOCK_DT 0x04
2216#define SID_SPI_CLOCK_DT_ST 0x0C
2217#define SID_SPI_MASK 0x0F
2218 u_int8_t spi3data;
2219 u_int8_t reserved2;
2220 /*
2221 * Version Descriptors, stored 2 byte values.
2222 */
2223 u_int8_t version1[2];
2224 u_int8_t version2[2];
2225 u_int8_t version3[2];
2226 u_int8_t version4[2];
2227 u_int8_t version5[2];
2228 u_int8_t version6[2];
2229 u_int8_t version7[2];
2230 u_int8_t version8[2];
2231
2232 u_int8_t reserved3[22];
2233
2234#define SID_VENDOR_SPECIFIC_1_SIZE 160
2235 u_int8_t vendor_specific1[SID_VENDOR_SPECIFIC_1_SIZE];
2236};
2237
2238/*
2239 * This structure is more suited to initiator operation, because the
2240 * maximum number of supported pages is already allocated.
2241 */
2242struct scsi_vpd_supported_page_list
2243{
2244 u_int8_t device;
2245 u_int8_t page_code;
2246#define SVPD_SUPPORTED_PAGE_LIST 0x00
2247#define SVPD_SUPPORTED_PAGES_HDR_LEN 4
2248 u_int8_t reserved;
2249 u_int8_t length; /* number of VPD entries */
2250#define SVPD_SUPPORTED_PAGES_SIZE 251
2251 u_int8_t list[SVPD_SUPPORTED_PAGES_SIZE];
2252};
2253
2254/*
2255 * This structure is more suited to target operation, because the
2256 * number of supported pages is left to the user to allocate.
2257 */
2258struct scsi_vpd_supported_pages
2259{
2260 u_int8_t device;
2261 u_int8_t page_code;
2262 u_int8_t reserved;
2263#define SVPD_SUPPORTED_PAGES 0x00
2264 u_int8_t length;
2265 u_int8_t page_list[0];
2266};
2267
2268
2269struct scsi_vpd_unit_serial_number
2270{
2271 u_int8_t device;
2272 u_int8_t page_code;
2273#define SVPD_UNIT_SERIAL_NUMBER 0x80
2274 u_int8_t reserved;
2275 u_int8_t length; /* serial number length */
2276#define SVPD_SERIAL_NUM_SIZE 251
2277 u_int8_t serial_num[SVPD_SERIAL_NUM_SIZE];
2278};
2279
2280struct scsi_vpd_device_id
2281{
2282 u_int8_t device;
2283 u_int8_t page_code;
2284#define SVPD_DEVICE_ID 0x83
2285#define SVPD_DEVICE_ID_MAX_SIZE 252
2286#define SVPD_DEVICE_ID_HDR_LEN \
2287 __offsetof(struct scsi_vpd_device_id, desc_list)
2288 u_int8_t length[2];
2289 u_int8_t desc_list[];
2290};
2291
2292struct scsi_vpd_id_descriptor
2293{
2294 u_int8_t proto_codeset;
2295 /*
2296 * See the SCSI_PROTO definitions above for the protocols.
2297 */
2298#define SVPD_ID_PROTO_SHIFT 4
2299#define SVPD_ID_CODESET_BINARY 0x01
2300#define SVPD_ID_CODESET_ASCII 0x02
2301#define SVPD_ID_CODESET_UTF8 0x03
2302#define SVPD_ID_CODESET_MASK 0x0f
2303 u_int8_t id_type;
2304#define SVPD_ID_PIV 0x80
2305#define SVPD_ID_ASSOC_LUN 0x00
2306#define SVPD_ID_ASSOC_PORT 0x10
2307#define SVPD_ID_ASSOC_TARGET 0x20
2308#define SVPD_ID_ASSOC_MASK 0x30
2309#define SVPD_ID_TYPE_VENDOR 0x00
2310#define SVPD_ID_TYPE_T10 0x01
2311#define SVPD_ID_TYPE_EUI64 0x02
2312#define SVPD_ID_TYPE_NAA 0x03
2313#define SVPD_ID_TYPE_RELTARG 0x04
2314#define SVPD_ID_TYPE_TPORTGRP 0x05
2315#define SVPD_ID_TYPE_LUNGRP 0x06
2316#define SVPD_ID_TYPE_MD5_LUN_ID 0x07
2317#define SVPD_ID_TYPE_SCSI_NAME 0x08
2318#define SVPD_ID_TYPE_PROTO 0x09
2319#define SVPD_ID_TYPE_UUID 0x0a
2320#define SVPD_ID_TYPE_MASK 0x0f
2321 u_int8_t reserved;
2322 u_int8_t length;
2323#define SVPD_DEVICE_ID_DESC_HDR_LEN \
2324 __offsetof(struct scsi_vpd_id_descriptor, identifier)
2325 u_int8_t identifier[];
2326};
2327
2328struct scsi_vpd_id_t10
2329{
2330 u_int8_t vendor[8];
2331 u_int8_t vendor_spec_id[0];
2332};
2333
2334struct scsi_vpd_id_eui64
2335{
2336 u_int8_t ieee_company_id[3];
2337 u_int8_t extension_id[5];
2338};
2339
2340struct scsi_vpd_id_naa_basic
2341{
2342 uint8_t naa;
2343 /* big endian, packed:
2344 uint8_t naa : 4;
2345 uint8_t naa_desig : 4;
2346 */
2347#define SVPD_ID_NAA_NAA_SHIFT 4
2348#define SVPD_ID_NAA_IEEE_EXT 0x02
2349#define SVPD_ID_NAA_LOCAL_REG 0x03
2350#define SVPD_ID_NAA_IEEE_REG 0x05
2351#define SVPD_ID_NAA_IEEE_REG_EXT 0x06
2352 uint8_t naa_data[];
2353};
2354
2355struct scsi_vpd_id_naa_ieee_extended_id
2356{
2357 uint8_t naa;
2358 uint8_t vendor_specific_id_a;
2359 uint8_t ieee_company_id[3];
2360 uint8_t vendor_specific_id_b[4];
2361};
2362
2363struct scsi_vpd_id_naa_local_reg
2364{
2365 uint8_t naa;
2366 uint8_t local_value[7];
2367};
2368
2369struct scsi_vpd_id_naa_ieee_reg
2370{
2371 uint8_t naa;
2372 uint8_t reg_value[7];
2373 /* big endian, packed:
2374 uint8_t naa_basic : 4;
2375 uint8_t ieee_company_id_0 : 4;
2376 uint8_t ieee_company_id_1[2];
2377 uint8_t ieee_company_id_2 : 4;
2378 uint8_t vendor_specific_id_0 : 4;
2379 uint8_t vendor_specific_id_1[4];
2380 */
2381};
2382
2383struct scsi_vpd_id_naa_ieee_reg_extended
2384{
2385 uint8_t naa;
2386 uint8_t reg_value[15];
2387 /* big endian, packed:
2388 uint8_t naa_basic : 4;
2389 uint8_t ieee_company_id_0 : 4;
2390 uint8_t ieee_company_id_1[2];
2391 uint8_t ieee_company_id_2 : 4;
2392 uint8_t vendor_specific_id_0 : 4;
2393 uint8_t vendor_specific_id_1[4];
2394 uint8_t vendor_specific_id_ext[8];
2395 */
2396};
2397
2398struct scsi_vpd_id_rel_trgt_port_id
2399{
2400 uint8_t obsolete[2];
2401 uint8_t rel_trgt_port_id[2];
2402};
2403
2404struct scsi_vpd_id_trgt_port_grp_id
2405{
2406 uint8_t reserved[2];
2407 uint8_t trgt_port_grp[2];
2408};
2409
2410struct scsi_vpd_id_lun_grp_id
2411{
2412 uint8_t reserved[2];
2413 uint8_t log_unit_grp[2];
2414};
2415
2416struct scsi_vpd_id_md5_lun_id
2417{
2418 uint8_t lun_id[16];
2419};
2420
2421struct scsi_vpd_id_scsi_name
2422{
2423 uint8_t name_string[256];
2424};
2425
2426struct scsi_service_action_in
2427{
2428 uint8_t opcode;
2429 uint8_t service_action;
2430 uint8_t action_dependent[13];
2431 uint8_t control;
2432};
2433
2434struct scsi_vpd_extended_inquiry_data
2435{
2436 uint8_t device;
2437 uint8_t page_code;
2438#define SVPD_EXTENDED_INQUIRY_DATA 0x86
2439 uint8_t page_length[2];
2440 uint8_t flags1;
2441
2442 /* These values are for direct access devices */
2443#define SVPD_EID_AM_MASK 0xC0
2444#define SVPD_EID_AM_DEFER 0x80
2445#define SVPD_EID_AM_IMMED 0x40
2446#define SVPD_EID_AM_UNDEFINED 0x00
2447#define SVPD_EID_AM_RESERVED 0xc0
2448#define SVPD_EID_SPT 0x38
2449#define SVPD_EID_SPT_1 0x00
2450#define SVPD_EID_SPT_12 0x08
2451#define SVPD_EID_SPT_2 0x10
2452#define SVPD_EID_SPT_13 0x18
2453#define SVPD_EID_SPT_3 0x20
2454#define SVPD_EID_SPT_23 0x28
2455#define SVPD_EID_SPT_123 0x38
2456
2457 /* These values are for sequential access devices */
2458#define SVPD_EID_SA_SPT_LBP 0x08
2459
2460#define SVPD_EID_GRD_CHK 0x04
2461#define SVPD_EID_APP_CHK 0x02
2462#define SVPD_EID_REF_CHK 0x01
2463
2464 uint8_t flags2;
2465#define SVPD_EID_UASK_SUP 0x20
2466#define SVPD_EID_GROUP_SUP 0x10
2467#define SVPD_EID_PRIOR_SUP 0x08
2468#define SVPD_EID_HEADSUP 0x04
2469#define SVPD_EID_ORDSUP 0x02
2470#define SVPD_EID_SIMPSUP 0x01
2471 uint8_t flags3;
2472#define SVPD_EID_WU_SUP 0x08
2473#define SVPD_EID_CRD_SUP 0x04
2474#define SVPD_EID_NV_SUP 0x02
2475#define SVPD_EID_V_SUP 0x01
2476 uint8_t flags4;
2477#define SVPD_EID_P_I_I_SUP 0x10
2478#define SVPD_EID_LUICLT 0x01
2479 uint8_t flags5;
2480#define SVPD_EID_R_SUP 0x10
2481#define SVPD_EID_CBCS 0x01
2482 uint8_t flags6;
2483#define SVPD_EID_MULTI_I_T_FW 0x0F
2484#define SVPD_EID_MC_VENDOR_SPEC 0x00
2485#define SVPD_EID_MC_MODE_1 0x01
2486#define SVPD_EID_MC_MODE_2 0x02
2487#define SVPD_EID_MC_MODE_3 0x03
2488 uint8_t est[2];
2489 uint8_t flags7;
2490#define SVPD_EID_POA_SUP 0x80
2491#define SVPD_EID_HRA_SUP 0x80
2492#define SVPD_EID_VSA_SUP 0x80
2493 uint8_t max_sense_length;
2494 uint8_t reserved2[50];
2495};
2496
2497struct scsi_vpd_mode_page_policy_descr
2498{
2499 uint8_t page_code;
2500 uint8_t subpage_code;
2501 uint8_t policy;
2502#define SVPD_MPP_SHARED 0x00
2503#define SVPD_MPP_PORT 0x01
2504#define SVPD_MPP_I_T 0x03
2505#define SVPD_MPP_MLUS 0x80
2506 uint8_t reserved;
2507};
2508
2509struct scsi_vpd_mode_page_policy
2510{
2511 uint8_t device;
2512 uint8_t page_code;
2513#define SVPD_MODE_PAGE_POLICY 0x87
2514 uint8_t page_length[2];
2515 struct scsi_vpd_mode_page_policy_descr descr[0];
2516};
2517
2518struct scsi_diag_page {
2519 uint8_t page_code;
2520 uint8_t page_specific_flags;
2521 uint8_t length[2];
2522 uint8_t params[0];
2523};
2524
2525struct scsi_vpd_port_designation
2526{
2527 uint8_t reserved[2];
2528 uint8_t relative_port_id[2];
2529 uint8_t reserved2[2];
2530 uint8_t initiator_transportid_length[2];
2531 uint8_t initiator_transportid[0];
2532};
2533
2534struct scsi_vpd_port_designation_cont
2535{
2536 uint8_t reserved[2];
2537 uint8_t target_port_descriptors_length[2];
2538 struct scsi_vpd_id_descriptor target_port_descriptors[0];
2539};
2540
2541struct scsi_vpd_scsi_ports
2542{
2543 u_int8_t device;
2544 u_int8_t page_code;
2545#define SVPD_SCSI_PORTS 0x88
2546 u_int8_t page_length[2];
2547 struct scsi_vpd_port_designation design[];
2548};
2549
2550/*
2551 * ATA Information VPD Page based on
2552 * T10/2126-D Revision 04
2553 */
2554#define SVPD_ATA_INFORMATION 0x89
2555
2556
2557struct scsi_vpd_tpc_descriptor
2558{
2559 uint8_t desc_type[2];
2560 uint8_t desc_length[2];
2561 uint8_t parameters[];
2562};
2563
2564struct scsi_vpd_tpc_descriptor_bdrl
2565{
2566 uint8_t desc_type[2];
2567#define SVPD_TPC_BDRL 0x0000
2568 uint8_t desc_length[2];
2569 uint8_t vendor_specific[6];
2570 uint8_t maximum_ranges[2];
2571 uint8_t maximum_inactivity_timeout[4];
2572 uint8_t default_inactivity_timeout[4];
2573 uint8_t maximum_token_transfer_size[8];
2574 uint8_t optimal_transfer_count[8];
2575};
2576
2577struct scsi_vpd_tpc_descriptor_sc_descr
2578{
2579 uint8_t opcode;
2580 uint8_t sa_length;
2581 uint8_t supported_service_actions[0];
2582};
2583
2584struct scsi_vpd_tpc_descriptor_sc
2585{
2586 uint8_t desc_type[2];
2587#define SVPD_TPC_SC 0x0001
2588 uint8_t desc_length[2];
2589 uint8_t list_length;
2590 struct scsi_vpd_tpc_descriptor_sc_descr descr[];
2591};
2592
2593struct scsi_vpd_tpc_descriptor_pd
2594{
2595 uint8_t desc_type[2];
2596#define SVPD_TPC_PD 0x0004
2597 uint8_t desc_length[2];
2598 uint8_t reserved[4];
2599 uint8_t maximum_cscd_descriptor_count[2];
2600 uint8_t maximum_segment_descriptor_count[2];
2601 uint8_t maximum_descriptor_list_length[4];
2602 uint8_t maximum_inline_data_length[4];
2603 uint8_t reserved2[12];
2604};
2605
2606struct scsi_vpd_tpc_descriptor_sd
2607{
2608 uint8_t desc_type[2];
2609#define SVPD_TPC_SD 0x0008
2610 uint8_t desc_length[2];
2611 uint8_t list_length;
2612 uint8_t supported_descriptor_codes[];
2613};
2614
2615struct scsi_vpd_tpc_descriptor_sdid
2616{
2617 uint8_t desc_type[2];
2618#define SVPD_TPC_SDID 0x000C
2619 uint8_t desc_length[2];
2620 uint8_t list_length[2];
2621 uint8_t supported_descriptor_ids[];
2622};
2623
2624struct scsi_vpd_tpc_descriptor_rtf_block
2625{
2626 uint8_t type_format;
2627#define SVPD_TPC_RTF_BLOCK 0x00
2628 uint8_t reserved;
2629 uint8_t desc_length[2];
2630 uint8_t reserved2[2];
2631 uint8_t optimal_length_granularity[2];
2632 uint8_t maximum_bytes[8];
2633 uint8_t optimal_bytes[8];
2634 uint8_t optimal_bytes_to_token_per_segment[8];
2635 uint8_t optimal_bytes_from_token_per_segment[8];
2636 uint8_t reserved3[8];
2637};
2638
2639struct scsi_vpd_tpc_descriptor_rtf
2640{
2641 uint8_t desc_type[2];
2642#define SVPD_TPC_RTF 0x0106
2643 uint8_t desc_length[2];
2644 uint8_t remote_tokens;
2645 uint8_t reserved[11];
2646 uint8_t minimum_token_lifetime[4];
2647 uint8_t maximum_token_lifetime[4];
2648 uint8_t maximum_token_inactivity_timeout[4];
2649 uint8_t reserved2[18];
2650 uint8_t type_specific_features_length[2];
2651 uint8_t type_specific_features[0];
2652};
2653
2654struct scsi_vpd_tpc_descriptor_srtd
2655{
2656 uint8_t rod_type[4];
2657 uint8_t flags;
2658#define SVPD_TPC_SRTD_TOUT 0x01
2659#define SVPD_TPC_SRTD_TIN 0x02
2660#define SVPD_TPC_SRTD_ECPY 0x80
2661 uint8_t reserved;
2662 uint8_t preference_indicator[2];
2663 uint8_t reserved2[56];
2664};
2665
2666struct scsi_vpd_tpc_descriptor_srt
2667{
2668 uint8_t desc_type[2];
2669#define SVPD_TPC_SRT 0x0108
2670 uint8_t desc_length[2];
2671 uint8_t reserved[2];
2672 uint8_t rod_type_descriptors_length[2];
2673 uint8_t rod_type_descriptors[0];
2674};
2675
2676struct scsi_vpd_tpc_descriptor_gco
2677{
2678 uint8_t desc_type[2];
2679#define SVPD_TPC_GCO 0x8001
2680 uint8_t desc_length[2];
2681 uint8_t total_concurrent_copies[4];
2682 uint8_t maximum_identified_concurrent_copies[4];
2683 uint8_t maximum_segment_length[4];
2684 uint8_t data_segment_granularity;
2685 uint8_t inline_data_granularity;
2686 uint8_t reserved[18];
2687};
2688
2689struct scsi_vpd_tpc
2690{
2691 uint8_t device;
2692 uint8_t page_code;
2693#define SVPD_SCSI_TPC 0x8F
2694 uint8_t page_length[2];
2695 struct scsi_vpd_tpc_descriptor descr[];
2696};
2697
2698/*
2699 * Block Device Characteristics VPD Page based on
2700 * T10/1799-D Revision 31
2701 */
2702struct scsi_vpd_block_characteristics
2703{
2704 u_int8_t device;
2705 u_int8_t page_code;
2706#define SVPD_BDC 0xB1
2707 u_int8_t page_length[2];
2708 u_int8_t medium_rotation_rate[2];
2709#define SVPD_BDC_RATE_NOT_REPORTED 0x00
2710#define SVPD_BDC_RATE_NON_ROTATING 0x01
2711 u_int8_t reserved1;
2712 u_int8_t nominal_form_factor;
2713#define SVPD_BDC_FORM_NOT_REPORTED 0x00
2714#define SVPD_BDC_FORM_5_25INCH 0x01
2715#define SVPD_BDC_FORM_3_5INCH 0x02
2716#define SVPD_BDC_FORM_2_5INCH 0x03
2717#define SVPD_BDC_FORM_1_5INCH 0x04
2718#define SVPD_BDC_FORM_LESSTHAN_1_5INCH 0x05
2719 u_int8_t reserved2[56];
2720};
2721
2722/*
2723 * Block Device Characteristics VPD Page
2724 */
2725struct scsi_vpd_block_device_characteristics
2726{
2727 uint8_t device;
2728 uint8_t page_code;
2729#define SVPD_BDC 0xB1
2730 uint8_t page_length[2];
2731 uint8_t medium_rotation_rate[2];
2732#define SVPD_NOT_REPORTED 0x0000
2733#define SVPD_NON_ROTATING 0x0001
2734 uint8_t product_type;
2735 uint8_t wab_wac_ff;
2736 uint8_t flags;
2737#define SVPD_VBULS 0x01
2738#define SVPD_FUAB 0x02
2739#define SVPD_ZBC_NR 0x00 /* Not Reported */
2740#define SVPD_HAW_ZBC 0x10 /* Host Aware */
2741#define SVPD_DM_ZBC 0x20 /* Drive Managed */
2742#define SVPD_ZBC_MASK 0x30 /* Zoned mask */
2743 uint8_t reserved[55];
2744};
2745
2746#define SBDC_IS_PRESENT(bdc, length, field) \
2747 ((length >= offsetof(struct scsi_vpd_block_device_characteristics, \
2748 field) + sizeof(bdc->field)) ? 1 : 0)
2749
2750/*
2751 * Logical Block Provisioning VPD Page based on
2752 * T10/1799-D Revision 31
2753 */
2754struct scsi_vpd_logical_block_prov
2755{
2756 u_int8_t device;
2757 u_int8_t page_code;
2758#define SVPD_LBP 0xB2
2759 u_int8_t page_length[2];
2760#define SVPD_LBP_PL_BASIC 0x04
2761 u_int8_t threshold_exponent;
2762 u_int8_t flags;
2763#define SVPD_LBP_UNMAP 0x80
2764#define SVPD_LBP_WS16 0x40
2765#define SVPD_LBP_WS10 0x20
2766#define SVPD_LBP_RZ 0x04
2767#define SVPD_LBP_ANC_SUP 0x02
2768#define SVPD_LBP_DP 0x01
2769 u_int8_t prov_type;
2770#define SVPD_LBP_RESOURCE 0x01
2771#define SVPD_LBP_THIN 0x02
2772 u_int8_t reserved;
2773 /*
2774 * Provisioning Group Descriptor can be here if SVPD_LBP_DP is set
2775 * Its size can be determined from page_length - 4
2776 */
2777};
2778
2779/*
2780 * Block Limits VDP Page based on SBC-4 Revision 2
2781 */
2782struct scsi_vpd_block_limits
2783{
2784 u_int8_t device;
2785 u_int8_t page_code;
2786#define SVPD_BLOCK_LIMITS 0xB0
2787 u_int8_t page_length[2];
2788#define SVPD_BL_PL_BASIC 0x10
2789#define SVPD_BL_PL_TP 0x3C
2790 u_int8_t reserved1;
2791 u_int8_t max_cmp_write_len;
2792 u_int8_t opt_txfer_len_grain[2];
2793 u_int8_t max_txfer_len[4];
2794 u_int8_t opt_txfer_len[4];
2795 u_int8_t max_prefetch[4];
2796 u_int8_t max_unmap_lba_cnt[4];
2797 u_int8_t max_unmap_blk_cnt[4];
2798 u_int8_t opt_unmap_grain[4];
2799 u_int8_t unmap_grain_align[4];
2800 u_int8_t max_write_same_length[8];
2801 u_int8_t max_atomic_transfer_length[4];
2802 u_int8_t atomic_alignment[4];
2803 u_int8_t atomic_transfer_length_granularity[4];
2804 u_int8_t max_atomic_transfer_length_with_atomic_boundary[4];
2805 u_int8_t max_atomic_boundary_size[4];
2806};
2807
2808/*
2809 * Zoned Block Device Characacteristics VPD page.
2810 * From ZBC-r04, dated August 12, 2015.
2811 */
2812struct scsi_vpd_zoned_bdc {
2813 uint8_t device;
2814 uint8_t page_code;
2815#define SVPD_ZONED_BDC 0xB6
2816 uint8_t page_length[2];
2817#define SVPD_ZBDC_PL 0x3C
2818 uint8_t flags;
2819#define SVPD_ZBDC_URSWRZ 0x01
2820 uint8_t reserved1[3];
2821 uint8_t optimal_seq_zones[4];
2822#define SVPD_ZBDC_OPT_SEQ_NR 0xffffffff
2823 uint8_t optimal_nonseq_zones[4];
2824#define SVPD_ZBDC_OPT_NONSEQ_NR 0xffffffff
2825 uint8_t max_seq_req_zones[4];
2826#define SVPD_ZBDC_MAX_SEQ_UNLIMITED 0xffffffff
2827 uint8_t reserved2[44];
2828};
2829
2830struct scsi_read_capacity
2831{
2832 u_int8_t opcode;
2833 u_int8_t byte2;
2834#define SRC_RELADR 0x01
2835 u_int8_t addr[4];
2836 u_int8_t unused[2];
2837 u_int8_t pmi;
2838#define SRC_PMI 0x01
2839 u_int8_t control;
2840};
2841
2842struct scsi_read_capacity_16
2843{
2844 uint8_t opcode;
2845#define SRC16_SERVICE_ACTION 0x10
2846 uint8_t service_action;
2847 uint8_t addr[8];
2848 uint8_t alloc_len[4];
2849#define SRC16_PMI 0x01
2850#define SRC16_RELADR 0x02
2851 uint8_t reladr;
2852 uint8_t control;
2853};
2854
2855struct scsi_read_capacity_data
2856{
2857 u_int8_t addr[4];
2858 u_int8_t length[4];
2859};
2860
2861struct scsi_read_capacity_data_long
2862{
2863 uint8_t addr[8];
2864 uint8_t length[4];
2865#define SRC16_PROT_EN 0x01
2866#define SRC16_P_TYPE 0x0e
2867#define SRC16_PTYPE_1 0x00
2868#define SRC16_PTYPE_2 0x02
2869#define SRC16_PTYPE_3 0x04
2870 uint8_t prot;
2871#define SRC16_LBPPBE 0x0f
2872#define SRC16_PI_EXPONENT 0xf0
2873#define SRC16_PI_EXPONENT_SHIFT 4
2874 uint8_t prot_lbppbe;
2875#define SRC16_LALBA 0x3f
2876#define SRC16_LBPRZ 0x40
2877#define SRC16_LBPME 0x80
2878/*
2879 * Alternate versions of these macros that are intended for use on a 16-bit
2880 * version of the lalba_lbp field instead of the array of 2 8 bit numbers.
2881 */
2882#define SRC16_LALBA_A 0x3fff
2883#define SRC16_LBPRZ_A 0x4000
2884#define SRC16_LBPME_A 0x8000
2885 uint8_t lalba_lbp[2];
2886 uint8_t reserved[16];
2887};
2888
2889struct scsi_get_lba_status
2890{
2891 uint8_t opcode;
2892#define SGLS_SERVICE_ACTION 0x12
2893 uint8_t service_action;
2894 uint8_t addr[8];
2895 uint8_t alloc_len[4];
2896 uint8_t reserved;
2897 uint8_t control;
2898};
2899
2900struct scsi_get_lba_status_data_descr
2901{
2902 uint8_t addr[8];
2903 uint8_t length[4];
2904 uint8_t status;
2905 uint8_t reserved[3];
2906};
2907
2908struct scsi_get_lba_status_data
2909{
2910 uint8_t length[4];
2911 uint8_t reserved[4];
2912 struct scsi_get_lba_status_data_descr descr[];
2913};
2914
2915struct scsi_report_luns
2916{
2917 uint8_t opcode;
2918 uint8_t reserved1;
2919#define RPL_REPORT_DEFAULT 0x00
2920#define RPL_REPORT_WELLKNOWN 0x01
2921#define RPL_REPORT_ALL 0x02
2922#define RPL_REPORT_ADMIN 0x10
2923#define RPL_REPORT_NONSUBSID 0x11
2924#define RPL_REPORT_CONGLOM 0x12
2925 uint8_t select_report;
2926 uint8_t reserved2[3];
2927 uint8_t length[4];
2928 uint8_t reserved3;
2929 uint8_t control;
2930};
2931
2932struct scsi_report_luns_lundata {
2933 uint8_t lundata[8];
2934#define RPL_LUNDATA_PERIPH_BUS_MASK 0x3f
2935#define RPL_LUNDATA_FLAT_LUN_MASK 0x3f
2936#define RPL_LUNDATA_FLAT_LUN_BITS 0x06
2937#define RPL_LUNDATA_LUN_TARG_MASK 0x3f
2938#define RPL_LUNDATA_LUN_BUS_MASK 0xe0
2939#define RPL_LUNDATA_LUN_LUN_MASK 0x1f
2940#define RPL_LUNDATA_EXT_LEN_MASK 0x30
2941#define RPL_LUNDATA_EXT_EAM_MASK 0x0f
2942#define RPL_LUNDATA_EXT_EAM_WK 0x01
2943#define RPL_LUNDATA_EXT_EAM_NOT_SPEC 0x0f
2944#define RPL_LUNDATA_ATYP_MASK 0xc0 /* MBZ for type 0 lun */
2945#define RPL_LUNDATA_ATYP_PERIPH 0x00
2946#define RPL_LUNDATA_ATYP_FLAT 0x40
2947#define RPL_LUNDATA_ATYP_LUN 0x80
2948#define RPL_LUNDATA_ATYP_EXTLUN 0xc0
2949};
2950
2951struct scsi_report_luns_data {
2952 u_int8_t length[4]; /* length of LUN inventory, in bytes */
2953 u_int8_t reserved[4]; /* unused */
2954 /*
2955 * LUN inventory- we only support the type zero form for now.
2956 */
2957 struct scsi_report_luns_lundata luns[0];
2958};
2959
2960struct scsi_target_group
2961{
2962 uint8_t opcode;
2963 uint8_t service_action;
2964#define STG_PDF_MASK 0xe0
2965#define STG_PDF_LENGTH 0x00
2966#define STG_PDF_EXTENDED 0x20
2967 uint8_t reserved1[4];
2968 uint8_t length[4];
2969 uint8_t reserved2;
2970 uint8_t control;
2971};
2972
2973struct scsi_target_port_descriptor {
2974 uint8_t reserved[2];
2975 uint8_t relative_target_port_identifier[2];
2976 uint8_t desc_list[];
2977};
2978
2979struct scsi_target_port_group_descriptor {
2980 uint8_t pref_state;
2981#define TPG_PRIMARY 0x80
2982#define TPG_ASYMMETRIC_ACCESS_STATE_MASK 0xf
2983#define TPG_ASYMMETRIC_ACCESS_OPTIMIZED 0x0
2984#define TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED 0x1
2985#define TPG_ASYMMETRIC_ACCESS_STANDBY 0x2
2986#define TPG_ASYMMETRIC_ACCESS_UNAVAILABLE 0x3
2987#define TPG_ASYMMETRIC_ACCESS_LBA_DEPENDENT 0x4
2988#define TPG_ASYMMETRIC_ACCESS_OFFLINE 0xE
2989#define TPG_ASYMMETRIC_ACCESS_TRANSITIONING 0xF
2990 uint8_t support;
2991#define TPG_AO_SUP 0x01
2992#define TPG_AN_SUP 0x02
2993#define TPG_S_SUP 0x04
2994#define TPG_U_SUP 0x08
2995#define TPG_LBD_SUP 0x10
2996#define TPG_O_SUP 0x40
2997#define TPG_T_SUP 0x80
2998 uint8_t target_port_group[2];
2999 uint8_t reserved;
3000 uint8_t status;
3001#define TPG_UNAVLBL 0
3002#define TPG_SET_BY_STPG 0x01
3003#define TPG_IMPLICIT 0x02
3004 uint8_t vendor_specific;
3005 uint8_t target_port_count;
3006 struct scsi_target_port_descriptor descriptors[];
3007};
3008
3009struct scsi_target_group_data {
3010 uint8_t length[4]; /* length of returned data, in bytes */
3011 struct scsi_target_port_group_descriptor groups[];
3012};
3013
3014struct scsi_target_group_data_extended {
3015 uint8_t length[4]; /* length of returned data, in bytes */
3016 uint8_t format_type; /* STG_PDF_LENGTH or STG_PDF_EXTENDED */
3017 uint8_t implicit_transition_time;
3018 uint8_t reserved[2];
3019 struct scsi_target_port_group_descriptor groups[];
3020};
3021
3022struct scsi_security_protocol_in
3023{
3024 uint8_t opcode;
3025 uint8_t security_protocol;
3026#define SPI_PROT_INFORMATION 0x00
3027#define SPI_PROT_CBCS 0x07
3028#define SPI_PROT_TAPE_DATA_ENC 0x20
3029#define SPI_PROT_DATA_ENC_CONFIG 0x21
3030#define SPI_PROT_SA_CREATE_CAP 0x40
3031#define SPI_PROT_IKEV2_SCSI 0x41
3032#define SPI_PROT_JEDEC_UFS 0xEC
3033#define SPI_PROT_SDCARD_TFSSS 0xED
3034#define SPI_PROT_AUTH_HOST_TRANSIENT 0xEE
3035#define SPI_PROT_ATA_DEVICE_PASSWORD 0xEF
3036 uint8_t security_protocol_specific[2];
3037 uint8_t byte4;
3038#define SPI_INC_512 0x80
3039 uint8_t reserved1;
3040 uint8_t length[4];
3041 uint8_t reserved2;
3042 uint8_t control;
3043};
3044
3045struct scsi_security_protocol_out
3046{
3047 uint8_t opcode;
3048 uint8_t security_protocol;
3049 uint8_t security_protocol_specific[2];
3050 uint8_t byte4;
3051#define SPO_INC_512 0x80
3052 uint8_t reserved1;
3053 uint8_t length[4];
3054 uint8_t reserved2;
3055 uint8_t control;
3056};
3057
3058typedef enum {
3059 SSD_TYPE_NONE,
3060 SSD_TYPE_FIXED,
3061 SSD_TYPE_DESC
3062} scsi_sense_data_type;
3063
3064typedef enum {
3065 SSD_ELEM_NONE,
3066 SSD_ELEM_SKIP,
3067 SSD_ELEM_DESC,
3068 SSD_ELEM_SKS,
3069 SSD_ELEM_COMMAND,
3070 SSD_ELEM_INFO,
3071 SSD_ELEM_FRU,
3072 SSD_ELEM_STREAM,
3073 SSD_ELEM_MAX
3074} scsi_sense_elem_type;
3075
3076
3077struct scsi_sense_data
3078{
3079 uint8_t error_code;
3080 /*
3081 * SPC-4 says that the maximum length of sense data is 252 bytes.
3082 * So this structure is exactly 252 bytes log.
3083 */
3084#define SSD_FULL_SIZE 252
3085 uint8_t sense_buf[SSD_FULL_SIZE - 1];
3086 /*
3087 * XXX KDM is this still a reasonable minimum size?
3088 */
3089#define SSD_MIN_SIZE 18
3090 /*
3091 * Maximum value for the extra_len field in the sense data.
3092 */
3093#define SSD_EXTRA_MAX 244
3094};
3095
3096/*
3097 * Fixed format sense data.
3098 */
3099struct scsi_sense_data_fixed
3100{
3101 u_int8_t error_code;
3102#define SSD_ERRCODE 0x7F
3103#define SSD_CURRENT_ERROR 0x70
3104#define SSD_DEFERRED_ERROR 0x71
3105#define SSD_ERRCODE_VALID 0x80
3106 u_int8_t segment;
3107 u_int8_t flags;
3108#define SSD_KEY 0x0F
3109#define SSD_KEY_NO_SENSE 0x00
3110#define SSD_KEY_RECOVERED_ERROR 0x01
3111#define SSD_KEY_NOT_READY 0x02
3112#define SSD_KEY_MEDIUM_ERROR 0x03
3113#define SSD_KEY_HARDWARE_ERROR 0x04
3114#define SSD_KEY_ILLEGAL_REQUEST 0x05
3115#define SSD_KEY_UNIT_ATTENTION 0x06
3116#define SSD_KEY_DATA_PROTECT 0x07
3117#define SSD_KEY_BLANK_CHECK 0x08
3118#define SSD_KEY_Vendor_Specific 0x09
3119#define SSD_KEY_COPY_ABORTED 0x0a
3120#define SSD_KEY_ABORTED_COMMAND 0x0b
3121#define SSD_KEY_EQUAL 0x0c
3122#define SSD_KEY_VOLUME_OVERFLOW 0x0d
3123#define SSD_KEY_MISCOMPARE 0x0e
3124#define SSD_KEY_COMPLETED 0x0f
3125#define SSD_ILI 0x20
3126#define SSD_EOM 0x40
3127#define SSD_FILEMARK 0x80
3128 u_int8_t info[4];
3129 u_int8_t extra_len;
3130 u_int8_t cmd_spec_info[4];
3131 u_int8_t add_sense_code;
3132 u_int8_t add_sense_code_qual;
3133 u_int8_t fru;
3134 u_int8_t sense_key_spec[3];
3135#define SSD_SCS_VALID 0x80
3136#define SSD_FIELDPTR_CMD 0x40
3137#define SSD_BITPTR_VALID 0x08
3138#define SSD_BITPTR_VALUE 0x07
3139 u_int8_t extra_bytes[14];
3140#define SSD_FIXED_IS_PRESENT(sense, length, field) \
3141 ((length >= (offsetof(struct scsi_sense_data_fixed, field) + \
3142 sizeof(sense->field))) ? 1 :0)
3143#define SSD_FIXED_IS_FILLED(sense, field) \
3144 ((((offsetof(struct scsi_sense_data_fixed, field) + \
3145 sizeof(sense->field)) - \
3146 (offsetof(struct scsi_sense_data_fixed, extra_len) + \
3147 sizeof(sense->extra_len))) <= sense->extra_len) ? 1 : 0)
3148};
3149
3150/*
3151 * Descriptor format sense data definitions.
3152 * Introduced in SPC-3.
3153 */
3154struct scsi_sense_data_desc
3155{
3156 uint8_t error_code;
3157#define SSD_DESC_CURRENT_ERROR 0x72
3158#define SSD_DESC_DEFERRED_ERROR 0x73
3159 uint8_t sense_key;
3160 uint8_t add_sense_code;
3161 uint8_t add_sense_code_qual;
3162 uint8_t reserved[3];
3163 /*
3164 * Note that SPC-4, section 4.5.2.1 says that the extra_len field
3165 * must be less than or equal to 244.
3166 */
3167 uint8_t extra_len;
3168 uint8_t sense_desc[0];
3169#define SSD_DESC_IS_PRESENT(sense, length, field) \
3170 ((length >= (offsetof(struct scsi_sense_data_desc, field) + \
3171 sizeof(sense->field))) ? 1 :0)
3172};
3173
3174struct scsi_sense_desc_header
3175{
3176 uint8_t desc_type;
3177 uint8_t length;
3178};
3179/*
3180 * The information provide in the Information descriptor is device type or
3181 * command specific information, and defined in a command standard.
3182 *
3183 * Note that any changes to the field names or positions in this structure,
3184 * even reserved fields, should be accompanied by an examination of the
3185 * code in ctl_set_sense() that uses them.
3186 *
3187 * Maximum descriptors allowed: 1 (as of SPC-4)
3188 */
3189struct scsi_sense_info
3190{
3191 uint8_t desc_type;
3192#define SSD_DESC_INFO 0x00
3193 uint8_t length;
3194 uint8_t byte2;
3195#define SSD_INFO_VALID 0x80
3196 uint8_t reserved;
3197 uint8_t info[8];
3198};
3199
3200/*
3201 * Command-specific information depends on the command for which the
3202 * reported condition occurred.
3203 *
3204 * Note that any changes to the field names or positions in this structure,
3205 * even reserved fields, should be accompanied by an examination of the
3206 * code in ctl_set_sense() that uses them.
3207 *
3208 * Maximum descriptors allowed: 1 (as of SPC-4)
3209 */
3210struct scsi_sense_command
3211{
3212 uint8_t desc_type;
3213#define SSD_DESC_COMMAND 0x01
3214 uint8_t length;
3215 uint8_t reserved[2];
3216 uint8_t command_info[8];
3217};
3218
3219/*
3220 * Sense key specific descriptor. The sense key specific data format
3221 * depends on the sense key in question.
3222 *
3223 * Maximum descriptors allowed: 1 (as of SPC-4)
3224 */
3225struct scsi_sense_sks
3226{
3227 uint8_t desc_type;
3228#define SSD_DESC_SKS 0x02
3229 uint8_t length;
3230 uint8_t reserved1[2];
3231 uint8_t sense_key_spec[3];
3232#define SSD_SKS_VALID 0x80
3233 uint8_t reserved2;
3234};
3235
3236/*
3237 * This is used for the Illegal Request sense key (0x05) only.
3238 */
3239struct scsi_sense_sks_field
3240{
3241 uint8_t byte0;
3242#define SSD_SKS_FIELD_VALID 0x80
3243#define SSD_SKS_FIELD_CMD 0x40
3244#define SSD_SKS_BPV 0x08
3245#define SSD_SKS_BIT_VALUE 0x07
3246 uint8_t field[2];
3247};
3248
3249
3250/*
3251 * This is used for the Hardware Error (0x04), Medium Error (0x03) and
3252 * Recovered Error (0x01) sense keys.
3253 */
3254struct scsi_sense_sks_retry
3255{
3256 uint8_t byte0;
3257#define SSD_SKS_RETRY_VALID 0x80
3258 uint8_t actual_retry_count[2];
3259};
3260
3261/*
3262 * Used with the NO Sense (0x00) or Not Ready (0x02) sense keys.
3263 */
3264struct scsi_sense_sks_progress
3265{
3266 uint8_t byte0;
3267#define SSD_SKS_PROGRESS_VALID 0x80
3268 uint8_t progress[2];
3269#define SSD_SKS_PROGRESS_DENOM 0x10000
3270};
3271
3272/*
3273 * Used with the Copy Aborted (0x0a) sense key.
3274 */
3275struct scsi_sense_sks_segment
3276{
3277 uint8_t byte0;
3278#define SSD_SKS_SEGMENT_VALID 0x80
3279#define SSD_SKS_SEGMENT_SD 0x20
3280#define SSD_SKS_SEGMENT_BPV 0x08
3281#define SSD_SKS_SEGMENT_BITPTR 0x07
3282 uint8_t field[2];
3283};
3284
3285/*
3286 * Used with the Unit Attention (0x06) sense key.
3287 *
3288 * This is currently used to indicate that the unit attention condition
3289 * queue has overflowed (when the overflow bit is set).
3290 */
3291struct scsi_sense_sks_overflow
3292{
3293 uint8_t byte0;
3294#define SSD_SKS_OVERFLOW_VALID 0x80
3295#define SSD_SKS_OVERFLOW_SET 0x01
3296 uint8_t reserved[2];
3297};
3298
3299/*
3300 * This specifies which component is associated with the sense data. There
3301 * is no standard meaning for the fru value.
3302 *
3303 * Maximum descriptors allowed: 1 (as of SPC-4)
3304 */
3305struct scsi_sense_fru
3306{
3307 uint8_t desc_type;
3308#define SSD_DESC_FRU 0x03
3309 uint8_t length;
3310 uint8_t reserved;
3311 uint8_t fru;
3312};
3313
3314/*
3315 * Used for Stream commands, defined in SSC-4.
3316 *
3317 * Maximum descriptors allowed: 1 (as of SPC-4)
3318 */
3319
3320struct scsi_sense_stream
3321{
3322 uint8_t desc_type;
3323#define SSD_DESC_STREAM 0x04
3324 uint8_t length;
3325 uint8_t reserved;
3326 uint8_t byte3;
3327#define SSD_DESC_STREAM_FM 0x80
3328#define SSD_DESC_STREAM_EOM 0x40
3329#define SSD_DESC_STREAM_ILI 0x20
3330};
3331
3332/*
3333 * Used for Block commands, defined in SBC-3.
3334 *
3335 * This is currently (as of SBC-3) only used for the Incorrect Length
3336 * Indication (ILI) bit, which says that the data length requested in the
3337 * READ LONG or WRITE LONG command did not match the length of the logical
3338 * block.
3339 *
3340 * Maximum descriptors allowed: 1 (as of SPC-4)
3341 */
3342struct scsi_sense_block
3343{
3344 uint8_t desc_type;
3345#define SSD_DESC_BLOCK 0x05
3346 uint8_t length;
3347 uint8_t reserved;
3348 uint8_t byte3;
3349#define SSD_DESC_BLOCK_ILI 0x20
3350};
3351
3352/*
3353 * Used for Object-Based Storage Devices (OSD-3).
3354 *
3355 * Maximum descriptors allowed: 1 (as of SPC-4)
3356 */
3357struct scsi_sense_osd_objid
3358{
3359 uint8_t desc_type;
3360#define SSD_DESC_OSD_OBJID 0x06
3361 uint8_t length;
3362 uint8_t reserved[6];
3363 /*
3364 * XXX KDM provide the bit definitions here? There are a lot of
3365 * them, and we don't have an OSD driver yet.
3366 */
3367 uint8_t not_init_cmds[4];
3368 uint8_t completed_cmds[4];
3369 uint8_t partition_id[8];
3370 uint8_t object_id[8];
3371};
3372
3373/*
3374 * Used for Object-Based Storage Devices (OSD-3).
3375 *
3376 * Maximum descriptors allowed: 1 (as of SPC-4)
3377 */
3378struct scsi_sense_osd_integrity
3379{
3380 uint8_t desc_type;
3381#define SSD_DESC_OSD_INTEGRITY 0x07
3382 uint8_t length;
3383 uint8_t integ_check_val[32];
3384};
3385
3386/*
3387 * Used for Object-Based Storage Devices (OSD-3).
3388 *
3389 * Maximum descriptors allowed: 1 (as of SPC-4)
3390 */
3391struct scsi_sense_osd_attr_id
3392{
3393 uint8_t desc_type;
3394#define SSD_DESC_OSD_ATTR_ID 0x08
3395 uint8_t length;
3396 uint8_t reserved[2];
3397 uint8_t attr_desc[0];
3398};
3399
3400/*
3401 * ATA Return descriptor, used for the SCSI ATA PASS-THROUGH(12), (16) and
3402 * (32) commands. Described in SAT-4r05.
3403 */
3404struct scsi_sense_ata_ret_desc
3405{
3406 uint8_t desc_type;
3407#define SSD_DESC_ATA 0x09
3408 uint8_t length;
3409 uint8_t flags;
3410#define SSD_DESC_ATA_FLAG_EXTEND 0x01
3411 uint8_t error;
3412 uint8_t count_15_8;
3413 uint8_t count_7_0;
3414 uint8_t lba_31_24;
3415 uint8_t lba_7_0;
3416 uint8_t lba_39_32;
3417 uint8_t lba_15_8;
3418 uint8_t lba_47_40;
3419 uint8_t lba_23_16;
3420 uint8_t device;
3421 uint8_t status;
3422};
3423/*
3424 * Used with Sense keys No Sense (0x00) and Not Ready (0x02).
3425 *
3426 * Maximum descriptors allowed: 32 (as of SPC-4)
3427 */
3428struct scsi_sense_progress
3429{
3430 uint8_t desc_type;
3431#define SSD_DESC_PROGRESS 0x0a
3432 uint8_t length;
3433 uint8_t sense_key;
3434 uint8_t add_sense_code;
3435 uint8_t add_sense_code_qual;
3436 uint8_t reserved;
3437 uint8_t progress[2];
3438};
3439
3440/*
3441 * This is typically forwarded as the result of an EXTENDED COPY command.
3442 *
3443 * Maximum descriptors allowed: 2 (as of SPC-4)
3444 */
3445struct scsi_sense_forwarded
3446{
3447 uint8_t desc_type;
3448#define SSD_DESC_FORWARDED 0x0c
3449 uint8_t length;
3450 uint8_t byte2;
3451#define SSD_FORWARDED_FSDT 0x80
3452#define SSD_FORWARDED_SDS_MASK 0x0f
3453#define SSD_FORWARDED_SDS_UNK 0x00
3454#define SSD_FORWARDED_SDS_EXSRC 0x01
3455#define SSD_FORWARDED_SDS_EXDST 0x02
3456};
3457
3458/*
3459 * Vendor-specific sense descriptor. The desc_type field will be in the
3460 * range between MIN and MAX inclusive.
3461 */
3462struct scsi_sense_vendor
3463{
3464 uint8_t desc_type;
3465#define SSD_DESC_VENDOR_MIN 0x80
3466#define SSD_DESC_VENDOR_MAX 0xff
3467 uint8_t length;
3468 uint8_t data[0];
3469};
3470
3471struct scsi_mode_header_6
3472{
3473 u_int8_t data_length; /* Sense data length */
3474 u_int8_t medium_type;
3475 u_int8_t dev_spec;
3476 u_int8_t blk_desc_len;
3477};
3478
3479struct scsi_mode_header_10
3480{
3481 u_int8_t data_length[2];/* Sense data length */
3482 u_int8_t medium_type;
3483 u_int8_t dev_spec;
3484 u_int8_t unused[2];
3485 u_int8_t blk_desc_len[2];
3486};
3487
3488struct scsi_mode_page_header
3489{
3490 u_int8_t page_code;
3491#define SMPH_PS 0x80
3492#define SMPH_SPF 0x40
3493#define SMPH_PC_MASK 0x3f
3494 u_int8_t page_length;
3495};
3496
3497struct scsi_mode_page_header_sp
3498{
3499 uint8_t page_code;
3500 uint8_t subpage;
3501 uint8_t page_length[2];
3502};
3503
3504
3505struct scsi_mode_blk_desc
3506{
3507 u_int8_t density;
3508 u_int8_t nblocks[3];
3509 u_int8_t reserved;
3510 u_int8_t blklen[3];
3511};
3512
3513#define SCSI_DEFAULT_DENSITY 0x00 /* use 'default' density */
3514#define SCSI_SAME_DENSITY 0x7f /* use 'same' density- >= SCSI-2 only */
3515
3516
3517/*
3518 * Status Byte
3519 */
3520#define SCSI_STATUS_OK 0x00
3521#define SCSI_STATUS_CHECK_COND 0x02
3522#define SCSI_STATUS_COND_MET 0x04
3523#define SCSI_STATUS_BUSY 0x08
3524#define SCSI_STATUS_INTERMED 0x10
3525#define SCSI_STATUS_INTERMED_COND_MET 0x14
3526#define SCSI_STATUS_RESERV_CONFLICT 0x18
3527#define SCSI_STATUS_CMD_TERMINATED 0x22 /* Obsolete in SAM-2 */
3528#define SCSI_STATUS_QUEUE_FULL 0x28
3529#define SCSI_STATUS_ACA_ACTIVE 0x30
3530#define SCSI_STATUS_TASK_ABORTED 0x40
3531
3532struct scsi_inquiry_pattern {
3533 u_int8_t type;
3534 u_int8_t media_type;
3535#define SIP_MEDIA_REMOVABLE 0x01
3536#define SIP_MEDIA_FIXED 0x02
3537 const char *vendor;
3538 const char *product;
3539 const char *revision;
3540};
3541
3542struct scsi_static_inquiry_pattern {
3543 u_int8_t type;
3544 u_int8_t media_type;
3545 char vendor[SID_VENDOR_SIZE+1];
3546 char product[SID_PRODUCT_SIZE+1];
3547 char revision[SID_REVISION_SIZE+1];
3548};
3549
3550struct scsi_sense_quirk_entry {
3551 struct scsi_inquiry_pattern inq_pat;
3552 int num_sense_keys;
3553 int num_ascs;
3554 struct sense_key_table_entry *sense_key_info;
3555 struct asc_table_entry *asc_info;
3556};
3557
3558struct sense_key_table_entry {
3559 u_int8_t sense_key;
3560 u_int32_t action;
3561 const char *desc;
3562};
3563
3564struct asc_table_entry {
3565 u_int8_t asc;
3566 u_int8_t ascq;
3567 u_int32_t action;
3568 const char *desc;
3569};
3570
3571struct op_table_entry {
3572 u_int8_t opcode;
3573 u_int32_t opmask;
3574 const char *desc;
3575};
3576
3577struct scsi_op_quirk_entry {
3578 struct scsi_inquiry_pattern inq_pat;
3579 int num_ops;
3580 struct op_table_entry *op_table;
3581};
3582
3583typedef enum {
3584 SSS_FLAG_NONE = 0x00,
3585 SSS_FLAG_PRINT_COMMAND = 0x01
3586} scsi_sense_string_flags;
3587
3588struct scsi_nv {
3589 const char *name;
3590 uint64_t value;
3591};
3592
3593typedef enum {
3594 SCSI_NV_FOUND,
3595 SCSI_NV_AMBIGUOUS,
3596 SCSI_NV_NOT_FOUND
3597} scsi_nv_status;
3598
3599typedef enum {
3600 SCSI_NV_FLAG_NONE = 0x00,
3601 SCSI_NV_FLAG_IG_CASE = 0x01 /* Case insensitive comparison */
3602} scsi_nv_flags;
3603
3604struct ccb_scsiio;
3605struct cam_periph;
3606union ccb;
3607#ifndef _KERNEL
3608struct cam_device;
3609#endif
3610
3611extern const char *scsi_sense_key_text[];
3612
3613__BEGIN_DECLS
3614void scsi_sense_desc(int sense_key, int asc, int ascq,
3615 struct scsi_inquiry_data *inq_data,
3616 const char **sense_key_desc, const char **asc_desc);
3617scsi_sense_action scsi_error_action(struct ccb_scsiio* csio,
3618 struct scsi_inquiry_data *inq_data,
3619 u_int32_t sense_flags);
3620const char * scsi_status_string(struct ccb_scsiio *csio);
3621
3622void scsi_desc_iterate(struct scsi_sense_data_desc *sense, u_int sense_len,
3623 int (*iter_func)(struct scsi_sense_data_desc *sense,
3624 u_int, struct scsi_sense_desc_header *,
3625 void *), void *arg);
3626uint8_t *scsi_find_desc(struct scsi_sense_data_desc *sense, u_int sense_len,
3627 uint8_t desc_type);
3628void scsi_set_sense_data(struct scsi_sense_data *sense_data,
3629 scsi_sense_data_type sense_format, int current_error,
3630 int sense_key, int asc, int ascq, ...) ;
3631void scsi_set_sense_data_va(struct scsi_sense_data *sense_data,
3632 scsi_sense_data_type sense_format,
3633 int current_error, int sense_key, int asc,
3634 int ascq, va_list ap);
3635int scsi_get_sense_info(struct scsi_sense_data *sense_data, u_int sense_len,
3636 uint8_t info_type, uint64_t *info,
3637 int64_t *signed_info);
3638int scsi_get_sks(struct scsi_sense_data *sense_data, u_int sense_len,
3639 uint8_t *sks);
3640int scsi_get_block_info(struct scsi_sense_data *sense_data, u_int sense_len,
3641 struct scsi_inquiry_data *inq_data,
3642 uint8_t *block_bits);
3643int scsi_get_stream_info(struct scsi_sense_data *sense_data, u_int sense_len,
3644 struct scsi_inquiry_data *inq_data,
3645 uint8_t *stream_bits);
3646void scsi_info_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len,
3647 struct scsi_inquiry_data *inq_data, uint64_t info);
3648void scsi_command_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len,
3649 struct scsi_inquiry_data *inq_data, uint64_t csi);
3650void scsi_progress_sbuf(struct sbuf *sb, uint16_t progress);
3651int scsi_sks_sbuf(struct sbuf *sb, int sense_key, uint8_t *sks);
3652void scsi_fru_sbuf(struct sbuf *sb, uint64_t fru);
3653void scsi_stream_sbuf(struct sbuf *sb, uint8_t stream_bits, uint64_t info);
3654void scsi_block_sbuf(struct sbuf *sb, uint8_t block_bits, uint64_t info);
3655void scsi_sense_info_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3656 u_int sense_len, uint8_t *cdb, int cdb_len,
3657 struct scsi_inquiry_data *inq_data,
3658 struct scsi_sense_desc_header *header);
3659
3660void scsi_sense_command_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3661 u_int sense_len, uint8_t *cdb, int cdb_len,
3662 struct scsi_inquiry_data *inq_data,
3663 struct scsi_sense_desc_header *header);
3664void scsi_sense_sks_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3665 u_int sense_len, uint8_t *cdb, int cdb_len,
3666 struct scsi_inquiry_data *inq_data,
3667 struct scsi_sense_desc_header *header);
3668void scsi_sense_fru_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3669 u_int sense_len, uint8_t *cdb, int cdb_len,
3670 struct scsi_inquiry_data *inq_data,
3671 struct scsi_sense_desc_header *header);
3672void scsi_sense_stream_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3673 u_int sense_len, uint8_t *cdb, int cdb_len,
3674 struct scsi_inquiry_data *inq_data,
3675 struct scsi_sense_desc_header *header);
3676void scsi_sense_block_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3677 u_int sense_len, uint8_t *cdb, int cdb_len,
3678 struct scsi_inquiry_data *inq_data,
3679 struct scsi_sense_desc_header *header);
3680void scsi_sense_progress_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3681 u_int sense_len, uint8_t *cdb, int cdb_len,
3682 struct scsi_inquiry_data *inq_data,
3683 struct scsi_sense_desc_header *header);
3684void scsi_sense_generic_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3685 u_int sense_len, uint8_t *cdb, int cdb_len,
3686 struct scsi_inquiry_data *inq_data,
3687 struct scsi_sense_desc_header *header);
3688void scsi_sense_desc_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3689 u_int sense_len, uint8_t *cdb, int cdb_len,
3690 struct scsi_inquiry_data *inq_data,
3691 struct scsi_sense_desc_header *header);
3692scsi_sense_data_type scsi_sense_type(struct scsi_sense_data *sense_data);
3693
3694void scsi_sense_only_sbuf(struct scsi_sense_data *sense, u_int sense_len,
3695 struct sbuf *sb, char *path_str,
3696 struct scsi_inquiry_data *inq_data, uint8_t *cdb,
3697 int cdb_len);
3698
3699#ifdef _KERNEL
3700int scsi_command_string(struct ccb_scsiio *csio, struct sbuf *sb);
3701int scsi_sense_sbuf(struct ccb_scsiio *csio, struct sbuf *sb,
3702 scsi_sense_string_flags flags);
3703char * scsi_sense_string(struct ccb_scsiio *csio,
3704 char *str, int str_len);
3705void scsi_sense_print(struct ccb_scsiio *csio);
3706int scsi_vpd_supported_page(struct cam_periph *periph,
3707 uint8_t page_id);
3708#else /* _KERNEL */
3709int scsi_command_string(struct cam_device *device,
3710 struct ccb_scsiio *csio, struct sbuf *sb);
3711int scsi_sense_sbuf(struct cam_device *device,
3712 struct ccb_scsiio *csio, struct sbuf *sb,
3713 scsi_sense_string_flags flags);
3714char * scsi_sense_string(struct cam_device *device,
3715 struct ccb_scsiio *csio,
3716 char *str, int str_len);
3717void scsi_sense_print(struct cam_device *device,
3718 struct ccb_scsiio *csio, FILE *ofile);
3719#endif /* _KERNEL */
3720
3721const char * scsi_op_desc(u_int16_t opcode,
3722 struct scsi_inquiry_data *inq_data);
3723char * scsi_cdb_string(u_int8_t *cdb_ptr, char *cdb_string,
3724 size_t len);
3725void scsi_cdb_sbuf(u_int8_t *cdb_ptr, struct sbuf *sb);
3726
3727void scsi_print_inquiry(struct scsi_inquiry_data *inq_data);
3728void scsi_print_inquiry_short(struct scsi_inquiry_data *inq_data);
3729
3730u_int scsi_calc_syncsrate(u_int period_factor);
3731u_int scsi_calc_syncparam(u_int period);
3732
3733typedef int (*scsi_devid_checkfn_t)(uint8_t *);
3734int scsi_devid_is_naa_ieee_reg(uint8_t *bufp);
3735int scsi_devid_is_sas_target(uint8_t *bufp);
3736int scsi_devid_is_lun_eui64(uint8_t *bufp);
3737int scsi_devid_is_lun_naa(uint8_t *bufp);
3738int scsi_devid_is_lun_name(uint8_t *bufp);
3739int scsi_devid_is_lun_t10(uint8_t *bufp);
3740int scsi_devid_is_port_naa(uint8_t *bufp);
3741struct scsi_vpd_id_descriptor *
3742 scsi_get_devid(struct scsi_vpd_device_id *id, uint32_t len,
3743 scsi_devid_checkfn_t ck_fn);
3744struct scsi_vpd_id_descriptor *
3745 scsi_get_devid_desc(struct scsi_vpd_id_descriptor *desc, uint32_t len,
3746 scsi_devid_checkfn_t ck_fn);
3747
3748int scsi_transportid_sbuf(struct sbuf *sb,
3749 struct scsi_transportid_header *hdr,
3750 uint32_t valid_len);
3751
3752const char * scsi_nv_to_str(struct scsi_nv *table, int num_table_entries,
3753 uint64_t value);
3754
3755scsi_nv_status scsi_get_nv(struct scsi_nv *table, int num_table_entries,
3756 char *name, int *table_entry, scsi_nv_flags flags);
3757
3758int scsi_parse_transportid_64bit(int proto_id, char *id_str,
3759 struct scsi_transportid_header **hdr,
3760 unsigned int *alloc_len,
3761#ifdef _KERNEL
3762 struct malloc_type *type, int flags,
3763#endif
3764 char *error_str, int error_str_len);
3765
3766int scsi_parse_transportid_spi(char *id_str,
3767 struct scsi_transportid_header **hdr,
3768 unsigned int *alloc_len,
3769#ifdef _KERNEL
3770 struct malloc_type *type, int flags,
3771#endif
3772 char *error_str, int error_str_len);
3773
3774int scsi_parse_transportid_rdma(char *id_str,
3775 struct scsi_transportid_header **hdr,
3776 unsigned int *alloc_len,
3777#ifdef _KERNEL
3778 struct malloc_type *type, int flags,
3779#endif
3780 char *error_str, int error_str_len);
3781
3782int scsi_parse_transportid_iscsi(char *id_str,
3783 struct scsi_transportid_header **hdr,
3784 unsigned int *alloc_len,
3785#ifdef _KERNEL
3786 struct malloc_type *type, int flags,
3787#endif
3788 char *error_str,int error_str_len);
3789
3790int scsi_parse_transportid_sop(char *id_str,
3791 struct scsi_transportid_header **hdr,
3792 unsigned int *alloc_len,
3793#ifdef _KERNEL
3794 struct malloc_type *type, int flags,
3795#endif
3796 char *error_str,int error_str_len);
3797
3798int scsi_parse_transportid(char *transportid_str,
3799 struct scsi_transportid_header **hdr,
3800 unsigned int *alloc_len,
3801#ifdef _KERNEL
3802 struct malloc_type *type, int flags,
3803#endif
3804 char *error_str, int error_str_len);
3805
3806
3807int scsi_attrib_volcoh_sbuf(struct sbuf *sb,
3808 struct scsi_mam_attribute_header *hdr,
3809 uint32_t valid_len, uint32_t flags,
3810 uint32_t output_flags, char *error_str,
3811 int error_str_len);
3812
3813int scsi_attrib_vendser_sbuf(struct sbuf *sb,
3814 struct scsi_mam_attribute_header *hdr,
3815 uint32_t valid_len, uint32_t flags,
3816 uint32_t output_flags, char *error_str,
3817 int error_str_len);
3818
3819int scsi_attrib_hexdump_sbuf(struct sbuf *sb,
3820 struct scsi_mam_attribute_header *hdr,
3821 uint32_t valid_len, uint32_t flags,
3822 uint32_t output_flags, char *error_str,
3823 int error_str_len);
3824
3825int scsi_attrib_int_sbuf(struct sbuf *sb, struct scsi_mam_attribute_header *hdr,
3826 uint32_t valid_len, uint32_t flags,
3827 uint32_t output_flags, char *error_str,
3828 int error_str_len);
3829
3830int scsi_attrib_ascii_sbuf(struct sbuf *sb,
3831 struct scsi_mam_attribute_header *hdr,
3832 uint32_t valid_len, uint32_t flags,
3833 uint32_t output_flags, char *error_str,
3834 int error_str_len);
3835
3836int scsi_attrib_text_sbuf(struct sbuf *sb,
3837 struct scsi_mam_attribute_header *hdr,
3838 uint32_t valid_len, uint32_t flags,
3839 uint32_t output_flags, char *error_str,
3840 int error_str_len);
3841
3842struct scsi_attrib_table_entry *scsi_find_attrib_entry(
3843 struct scsi_attrib_table_entry *table,
3844 size_t num_table_entries, uint32_t id);
3845
3846struct scsi_attrib_table_entry *scsi_get_attrib_entry(uint32_t id);
3847
3848int scsi_attrib_value_sbuf(struct sbuf *sb, uint32_t valid_len,
3849 struct scsi_mam_attribute_header *hdr,
3850 uint32_t output_flags, char *error_str,
3851 size_t error_str_len);
3852
3853void scsi_attrib_prefix_sbuf(struct sbuf *sb, uint32_t output_flags,
3854 struct scsi_mam_attribute_header *hdr,
3855 uint32_t valid_len, const char *desc);
3856
3857int scsi_attrib_sbuf(struct sbuf *sb, struct scsi_mam_attribute_header *hdr,
3858 uint32_t valid_len,
3859 struct scsi_attrib_table_entry *user_table,
3860 size_t num_user_entries, int prefer_user_table,
3861 uint32_t output_flags, char *error_str, int error_str_len);
3862
3863void scsi_test_unit_ready(struct ccb_scsiio *csio, u_int32_t retries,
3864 void (*cbfcnp)(struct cam_periph *,
3865 union ccb *),
3866 u_int8_t tag_action,
3867 u_int8_t sense_len, u_int32_t timeout);
3868
3869void scsi_request_sense(struct ccb_scsiio *csio, u_int32_t retries,
3870 void (*cbfcnp)(struct cam_periph *,
3871 union ccb *),
3872 void *data_ptr, u_int8_t dxfer_len,
3873 u_int8_t tag_action, u_int8_t sense_len,
3874 u_int32_t timeout);
3875
3876void scsi_inquiry(struct ccb_scsiio *csio, u_int32_t retries,
3877 void (*cbfcnp)(struct cam_periph *, union ccb *),
3878 u_int8_t tag_action, u_int8_t *inq_buf,
3879 u_int32_t inq_len, int evpd, u_int8_t page_code,
3880 u_int8_t sense_len, u_int32_t timeout);
3881
3882void scsi_mode_sense(struct ccb_scsiio *csio, u_int32_t retries,
3883 void (*cbfcnp)(struct cam_periph *,
3884 union ccb *),
3885 u_int8_t tag_action, int dbd,
3886 u_int8_t page_code, u_int8_t page,
3887 u_int8_t *param_buf, u_int32_t param_len,
3888 u_int8_t sense_len, u_int32_t timeout);
3889
3890void scsi_mode_sense_len(struct ccb_scsiio *csio, u_int32_t retries,
3891 void (*cbfcnp)(struct cam_periph *,
3892 union ccb *),
3893 u_int8_t tag_action, int dbd,
3894 u_int8_t page_code, u_int8_t page,
3895 u_int8_t *param_buf, u_int32_t param_len,
3896 int minimum_cmd_size, u_int8_t sense_len,
3897 u_int32_t timeout);
3898
3899void scsi_mode_select(struct ccb_scsiio *csio, u_int32_t retries,
3900 void (*cbfcnp)(struct cam_periph *,
3901 union ccb *),
3902 u_int8_t tag_action, int scsi_page_fmt,
3903 int save_pages, u_int8_t *param_buf,
3904 u_int32_t param_len, u_int8_t sense_len,
3905 u_int32_t timeout);
3906
3907void scsi_mode_select_len(struct ccb_scsiio *csio, u_int32_t retries,
3908 void (*cbfcnp)(struct cam_periph *,
3909 union ccb *),
3910 u_int8_t tag_action, int scsi_page_fmt,
3911 int save_pages, u_int8_t *param_buf,
3912 u_int32_t param_len, int minimum_cmd_size,
3913 u_int8_t sense_len, u_int32_t timeout);
3914
3915void scsi_log_sense(struct ccb_scsiio *csio, u_int32_t retries,
3916 void (*cbfcnp)(struct cam_periph *, union ccb *),
3917 u_int8_t tag_action, u_int8_t page_code,
3918 u_int8_t page, int save_pages, int ppc,
3919 u_int32_t paramptr, u_int8_t *param_buf,
3920 u_int32_t param_len, u_int8_t sense_len,
3921 u_int32_t timeout);
3922
3923void scsi_log_select(struct ccb_scsiio *csio, u_int32_t retries,
3924 void (*cbfcnp)(struct cam_periph *,
3925 union ccb *), u_int8_t tag_action,
3926 u_int8_t page_code, int save_pages,
3927 int pc_reset, u_int8_t *param_buf,
3928 u_int32_t param_len, u_int8_t sense_len,
3929 u_int32_t timeout);
3930
3931void scsi_prevent(struct ccb_scsiio *csio, u_int32_t retries,
3932 void (*cbfcnp)(struct cam_periph *, union ccb *),
3933 u_int8_t tag_action, u_int8_t action,
3934 u_int8_t sense_len, u_int32_t timeout);
3935
3936void scsi_read_capacity(struct ccb_scsiio *csio, u_int32_t retries,
3937 void (*cbfcnp)(struct cam_periph *,
3938 union ccb *), u_int8_t tag_action,
3939 struct scsi_read_capacity_data *,
3940 u_int8_t sense_len, u_int32_t timeout);
3941void scsi_read_capacity_16(struct ccb_scsiio *csio, uint32_t retries,
3942 void (*cbfcnp)(struct cam_periph *,
3943 union ccb *), uint8_t tag_action,
3944 uint64_t lba, int reladr, int pmi,
3945 uint8_t *rcap_buf, int rcap_buf_len,
3946 uint8_t sense_len, uint32_t timeout);
3947
3948void scsi_report_luns(struct ccb_scsiio *csio, u_int32_t retries,
3949 void (*cbfcnp)(struct cam_periph *,
3950 union ccb *), u_int8_t tag_action,
3951 u_int8_t select_report,
3952 struct scsi_report_luns_data *rpl_buf,
3953 u_int32_t alloc_len, u_int8_t sense_len,
3954 u_int32_t timeout);
3955
3956void scsi_report_target_group(struct ccb_scsiio *csio, u_int32_t retries,
3957 void (*cbfcnp)(struct cam_periph *,
3958 union ccb *), u_int8_t tag_action,
3959 u_int8_t pdf,
3960 void *buf,
3961 u_int32_t alloc_len, u_int8_t sense_len,
3962 u_int32_t timeout);
3963
3964void scsi_set_target_group(struct ccb_scsiio *csio, u_int32_t retries,
3965 void (*cbfcnp)(struct cam_periph *,
3966 union ccb *), u_int8_t tag_action, void *buf,
3967 u_int32_t alloc_len, u_int8_t sense_len,
3968 u_int32_t timeout);
3969
3970void scsi_synchronize_cache(struct ccb_scsiio *csio,
3971 u_int32_t retries,
3972 void (*cbfcnp)(struct cam_periph *,
3973 union ccb *), u_int8_t tag_action,
3974 u_int32_t begin_lba, u_int16_t lb_count,
3975 u_int8_t sense_len, u_int32_t timeout);
3976
3977void scsi_receive_diagnostic_results(struct ccb_scsiio *csio, u_int32_t retries,
3978 void (*cbfcnp)(struct cam_periph *,
3979 union ccb*),
3980 uint8_t tag_action, int pcv,
3981 uint8_t page_code, uint8_t *data_ptr,
3982 uint16_t allocation_length,
3983 uint8_t sense_len, uint32_t timeout);
3984
3985void scsi_send_diagnostic(struct ccb_scsiio *csio, u_int32_t retries,
3986 void (*cbfcnp)(struct cam_periph *, union ccb *),
3987 uint8_t tag_action, int unit_offline,
3988 int device_offline, int self_test, int page_format,
3989 int self_test_code, uint8_t *data_ptr,
3990 uint16_t param_list_length, uint8_t sense_len,
3991 uint32_t timeout);
3992
3993void scsi_read_buffer(struct ccb_scsiio *csio, u_int32_t retries,
3994 void (*cbfcnp)(struct cam_periph *, union ccb*),
3995 uint8_t tag_action, int mode,
3996 uint8_t buffer_id, u_int32_t offset,
3997 uint8_t *data_ptr, uint32_t allocation_length,
3998 uint8_t sense_len, uint32_t timeout);
3999
4000void scsi_write_buffer(struct ccb_scsiio *csio, u_int32_t retries,
4001 void (*cbfcnp)(struct cam_periph *, union ccb *),
4002 uint8_t tag_action, int mode,
4003 uint8_t buffer_id, u_int32_t offset,
4004 uint8_t *data_ptr, uint32_t param_list_length,
4005 uint8_t sense_len, uint32_t timeout);
4006
4007#define SCSI_RW_READ 0x0001
4008#define SCSI_RW_WRITE 0x0002
4009#define SCSI_RW_DIRMASK 0x0003
4010#define SCSI_RW_BIO 0x1000
4011void scsi_read_write(struct ccb_scsiio *csio, u_int32_t retries,
4012 void (*cbfcnp)(struct cam_periph *, union ccb *),
4013 u_int8_t tag_action, int readop, u_int8_t byte2,
4014 int minimum_cmd_size, u_int64_t lba,
4015 u_int32_t block_count, u_int8_t *data_ptr,
4016 u_int32_t dxfer_len, u_int8_t sense_len,
4017 u_int32_t timeout);
4018
4019void scsi_write_same(struct ccb_scsiio *csio, u_int32_t retries,
4020 void (*cbfcnp)(struct cam_periph *, union ccb *),
4021 u_int8_t tag_action, u_int8_t byte2,
4022 int minimum_cmd_size, u_int64_t lba,
4023 u_int32_t block_count, u_int8_t *data_ptr,
4024 u_int32_t dxfer_len, u_int8_t sense_len,
4025 u_int32_t timeout);
4026
4027void scsi_ata_identify(struct ccb_scsiio *csio, u_int32_t retries,
4028 void (*cbfcnp)(struct cam_periph *, union ccb *),
4029 u_int8_t tag_action, u_int8_t *data_ptr,
4030 u_int16_t dxfer_len, u_int8_t sense_len,
4031 u_int32_t timeout);
4032
4033void scsi_ata_trim(struct ccb_scsiio *csio, u_int32_t retries,
4034 void (*cbfcnp)(struct cam_periph *, union ccb *),
4035 u_int8_t tag_action, u_int16_t block_count,
4036 u_int8_t *data_ptr, u_int16_t dxfer_len,
4037 u_int8_t sense_len, u_int32_t timeout);
4038
4039int scsi_ata_read_log(struct ccb_scsiio *csio, uint32_t retries,
4040 void (*cbfcnp)(struct cam_periph *, union ccb *),
4041 uint8_t tag_action, uint32_t log_address,
4042 uint32_t page_number, uint16_t block_count,
4043 uint8_t protocol, uint8_t *data_ptr, uint32_t dxfer_len,
4044 uint8_t sense_len, uint32_t timeout);
4045
4046int scsi_ata_pass(struct ccb_scsiio *csio, uint32_t retries,
4047 void (*cbfcnp)(struct cam_periph *, union ccb *),
4048 uint32_t flags, uint8_t tag_action,
4049 uint8_t protocol, uint8_t ata_flags, uint16_t features,
4050 uint16_t sector_count, uint64_t lba, uint8_t command,
4051 uint8_t device, uint8_t icc, uint32_t auxiliary,
4052 uint8_t control, u_int8_t *data_ptr, uint32_t dxfer_len,
4053 uint8_t *cdb_storage, size_t cdb_storage_len,
4054 int minimum_cmd_size, u_int8_t sense_len, u_int32_t timeout);
4055
4056void scsi_ata_pass_16(struct ccb_scsiio *csio, u_int32_t retries,
4057 void (*cbfcnp)(struct cam_periph *, union ccb *),
4058 u_int32_t flags, u_int8_t tag_action,
4059 u_int8_t protocol, u_int8_t ata_flags, u_int16_t features,
4060 u_int16_t sector_count, uint64_t lba, u_int8_t command,
4061 u_int8_t control, u_int8_t *data_ptr, u_int16_t dxfer_len,
4062 u_int8_t sense_len, u_int32_t timeout);
4063
4064void scsi_unmap(struct ccb_scsiio *csio, u_int32_t retries,
4065 void (*cbfcnp)(struct cam_periph *, union ccb *),
4066 u_int8_t tag_action, u_int8_t byte2,
4067 u_int8_t *data_ptr, u_int16_t dxfer_len,
4068 u_int8_t sense_len, u_int32_t timeout);
4069
4070void scsi_start_stop(struct ccb_scsiio *csio, u_int32_t retries,
4071 void (*cbfcnp)(struct cam_periph *, union ccb *),
4072 u_int8_t tag_action, int start, int load_eject,
4073 int immediate, u_int8_t sense_len, u_int32_t timeout);
4074void scsi_read_attribute(struct ccb_scsiio *csio, u_int32_t retries,
4075 void (*cbfcnp)(struct cam_periph *, union ccb *),
4076 u_int8_t tag_action, u_int8_t service_action,
4077 uint32_t element, u_int8_t elem_type,
4078 int logical_volume, int partition,
4079 u_int32_t first_attribute, int cache, u_int8_t *data_ptr,
4080 u_int32_t length, int sense_len, u_int32_t timeout);
4081void scsi_write_attribute(struct ccb_scsiio *csio, u_int32_t retries,
4082 void (*cbfcnp)(struct cam_periph *, union ccb *),
4083 u_int8_t tag_action, uint32_t element,
4084 int logical_volume, int partition, int wtc, u_int8_t *data_ptr,
4085 u_int32_t length, int sense_len, u_int32_t timeout);
4086
4087void scsi_security_protocol_in(struct ccb_scsiio *csio, uint32_t retries,
4088 void (*cbfcnp)(struct cam_periph *, union ccb *),
4089 uint8_t tag_action, uint32_t security_protocol,
4090 uint32_t security_protocol_specific, int byte4,
4091 uint8_t *data_ptr, uint32_t dxfer_len,
4092 int sense_len, int timeout);
4093
4094void scsi_security_protocol_out(struct ccb_scsiio *csio, uint32_t retries,
4095 void (*cbfcnp)(struct cam_periph *,union ccb *),
4096 uint8_t tag_action, uint32_t security_protocol,
4097 uint32_t security_protocol_specific, int byte4,
4098 uint8_t *data_ptr, uint32_t dxfer_len,
4099 int sense_len, int timeout);
4100
4101void scsi_persistent_reserve_in(struct ccb_scsiio *csio, uint32_t retries,
4102 void (*cbfcnp)(struct cam_periph *,union ccb *),
4103 uint8_t tag_action, int service_action,
4104 uint8_t *data_ptr, uint32_t dxfer_len,
4105 int sense_len, int timeout);
4106
4107void scsi_persistent_reserve_out(struct ccb_scsiio *csio, uint32_t retries,
4108 void (*cbfcnp)(struct cam_periph *,
4109 union ccb *),
4110 uint8_t tag_action, int service_action,
4111 int scope, int res_type, uint8_t *data_ptr,
4112 uint32_t dxfer_len, int sense_len,
4113 int timeout);
4114
4115void scsi_report_supported_opcodes(struct ccb_scsiio *csio, uint32_t retries,
4116 void (*cbfcnp)(struct cam_periph *,
4117 union ccb *),
4118 uint8_t tag_action, int options,
4119 int req_opcode, int req_service_action,
4120 uint8_t *data_ptr, uint32_t dxfer_len,
4121 int sense_len, int timeout);
4122
4123int scsi_inquiry_match(caddr_t inqbuffer, caddr_t table_entry);
4124int scsi_static_inquiry_match(caddr_t inqbuffer,
4125 caddr_t table_entry);
4126int scsi_devid_match(uint8_t *rhs, size_t rhs_len,
4127 uint8_t *lhs, size_t lhs_len);
4128
4129void scsi_extract_sense(struct scsi_sense_data *sense, int *error_code,
4130 int *sense_key, int *asc, int *ascq);
4131int scsi_extract_sense_ccb(union ccb *ccb, int *error_code, int *sense_key,
4132 int *asc, int *ascq);
4133void scsi_extract_sense_len(struct scsi_sense_data *sense,
4134 u_int sense_len, int *error_code, int *sense_key,
4135 int *asc, int *ascq, int show_errors);
4136int scsi_get_sense_key(struct scsi_sense_data *sense, u_int sense_len,
4137 int show_errors);
4138int scsi_get_asc(struct scsi_sense_data *sense, u_int sense_len,
4139 int show_errors);
4140int scsi_get_ascq(struct scsi_sense_data *sense, u_int sense_len,
4141 int show_errors);
4142static __inline void scsi_ulto2b(u_int32_t val, u_int8_t *bytes);
4143static __inline void scsi_ulto3b(u_int32_t val, u_int8_t *bytes);
4144static __inline void scsi_ulto4b(u_int32_t val, u_int8_t *bytes);
4145static __inline void scsi_u64to8b(u_int64_t val, u_int8_t *bytes);
4146static __inline uint32_t scsi_2btoul(const uint8_t *bytes);
4147static __inline uint32_t scsi_3btoul(const uint8_t *bytes);
4148static __inline int32_t scsi_3btol(const uint8_t *bytes);
4149static __inline uint32_t scsi_4btoul(const uint8_t *bytes);
4150static __inline uint64_t scsi_8btou64(const uint8_t *bytes);
4151static __inline void *find_mode_page_6(struct scsi_mode_header_6 *mode_header);
4152static __inline void *find_mode_page_10(struct scsi_mode_header_10 *mode_header);
4153
4154static __inline void
4155scsi_ulto2b(u_int32_t val, u_int8_t *bytes)
4156{
4157
4158 bytes[0] = (val >> 8) & 0xff;
4159 bytes[1] = val & 0xff;
4160}
4161
4162static __inline void
4163scsi_ulto3b(u_int32_t val, u_int8_t *bytes)
4164{
4165
4166 bytes[0] = (val >> 16) & 0xff;
4167 bytes[1] = (val >> 8) & 0xff;
4168 bytes[2] = val & 0xff;
4169}
4170
4171static __inline void
4172scsi_ulto4b(u_int32_t val, u_int8_t *bytes)
4173{
4174
4175 bytes[0] = (val >> 24) & 0xff;
4176 bytes[1] = (val >> 16) & 0xff;
4177 bytes[2] = (val >> 8) & 0xff;
4178 bytes[3] = val & 0xff;
4179}
4180
4181static __inline void
4182scsi_u64to8b(u_int64_t val, u_int8_t *bytes)
4183{
4184
4185 bytes[0] = (val >> 56) & 0xff;
4186 bytes[1] = (val >> 48) & 0xff;
4187 bytes[2] = (val >> 40) & 0xff;
4188 bytes[3] = (val >> 32) & 0xff;
4189 bytes[4] = (val >> 24) & 0xff;
4190 bytes[5] = (val >> 16) & 0xff;
4191 bytes[6] = (val >> 8) & 0xff;
4192 bytes[7] = val & 0xff;
4193}
4194
4195static __inline uint32_t
4196scsi_2btoul(const uint8_t *bytes)
4197{
4198 uint32_t rv;
4199
4200 rv = (bytes[0] << 8) |
4201 bytes[1];
4202 return (rv);
4203}
4204
4205static __inline uint32_t
4206scsi_3btoul(const uint8_t *bytes)
4207{
4208 uint32_t rv;
4209
4210 rv = (bytes[0] << 16) |
4211 (bytes[1] << 8) |
4212 bytes[2];
4213 return (rv);
4214}
4215
4216static __inline int32_t
4217scsi_3btol(const uint8_t *bytes)
4218{
4219 uint32_t rc = scsi_3btoul(bytes);
4220
4221 if (rc & 0x00800000)
4222 rc |= 0xff000000;
4223
4224 return (int32_t) rc;
4225}
4226
4227static __inline uint32_t
4228scsi_4btoul(const uint8_t *bytes)
4229{
4230 uint32_t rv;
4231
4232 rv = (bytes[0] << 24) |
4233 (bytes[1] << 16) |
4234 (bytes[2] << 8) |
4235 bytes[3];
4236 return (rv);
4237}
4238
4239static __inline uint64_t
4240scsi_8btou64(const uint8_t *bytes)
4241{
4242 uint64_t rv;
4243
4244 rv = (((uint64_t)bytes[0]) << 56) |
4245 (((uint64_t)bytes[1]) << 48) |
4246 (((uint64_t)bytes[2]) << 40) |
4247 (((uint64_t)bytes[3]) << 32) |
4248 (((uint64_t)bytes[4]) << 24) |
4249 (((uint64_t)bytes[5]) << 16) |
4250 (((uint64_t)bytes[6]) << 8) |
4251 bytes[7];
4252 return (rv);
4253}
4254
4255/*
4256 * Given the pointer to a returned mode sense buffer, return a pointer to
4257 * the start of the first mode page.
4258 */
4259static __inline void *
4260find_mode_page_6(struct scsi_mode_header_6 *mode_header)
4261{
4262 void *page_start;
4263
4264 page_start = (void *)((u_int8_t *)&mode_header[1] +
4265 mode_header->blk_desc_len);
4266
4267 return(page_start);
4268}
4269
4270static __inline void *
4271find_mode_page_10(struct scsi_mode_header_10 *mode_header)
4272{
4273 void *page_start;
4274
4275 page_start = (void *)((u_int8_t *)&mode_header[1] +
4276 scsi_2btoul(mode_header->blk_desc_len));
4277
4278 return(page_start);
4279}
4280
4281__END_DECLS
4282
4283#endif /*_SCSI_SCSI_ALL_H*/