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