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