2 * Largely written by Julian Elischer (julian@tfs.com)
3 * for TRW Financial Systems.
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.
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.
15 * Ported to run under 386BSD by Julian Elischer (julian@tfs.com) Sept 1992
21 * SCSI general interface description
24 #ifndef _SCSI_SCSI_ALL_H
25 #define _SCSI_SCSI_ALL_H 1
27 #include <sys/cdefs.h>
28 #include <machine/stdarg.h>
32 * This is the number of seconds we wait for devices to settle after a SCSI
35 extern int scsi_delay;
43 * Define dome bits that are in ALL (or a lot of) scsi commands
45 #define SCSI_CTL_LINK 0x01
46 #define SCSI_CTL_FLAG 0x02
47 #define SCSI_CTL_VENDOR 0xC0
48 #define SCSI_CMD_LUN 0xA0 /* these two should not be needed */
49 #define SCSI_CMD_LUN_SHIFT 5 /* LUN in the cmd is no longer SCSI */
51 #define SCSI_MAX_CDBLEN 16 /*
52 * 16 byte commands are in the
55 #if defined(CAM_MAX_CDBLEN) && (CAM_MAX_CDBLEN < SCSI_MAX_CDBLEN)
56 #error "CAM_MAX_CDBLEN cannot be less than SCSI_MAX_CDBLEN"
59 /* 6byte CDBs special case 0 length to be 256 */
60 #define SCSI_CDB6_LEN(len) ((len) == 0 ? 256 : len)
63 * This type defines actions to be taken when a particular sense code is
64 * received. Right now, these flags are only defined to take up 16 bits,
65 * but can be expanded in the future if necessary.
68 SS_NOP = 0x000000, /* Do nothing */
69 SS_RETRY = 0x010000, /* Retry the command */
70 SS_FAIL = 0x020000, /* Bail out */
71 SS_START = 0x030000, /* Send a Start Unit command to the device,
72 * then retry the original command.
74 SS_TUR = 0x040000, /* Send a Test Unit Ready command to the
75 * device, then retry the original command.
82 SSQ_DECREMENT_COUNT = 0x0100, /* Decrement the retry count */
83 SSQ_MANY = 0x0200, /* send lots of recovery commands */
84 SSQ_RANGE = 0x0400, /*
85 * This table entry represents the
86 * end of a range of ASCQs that
87 * have identical error actions
90 SSQ_PRINT_SENSE = 0x0800,
91 SSQ_UA = 0x1000, /* Broadcast UA. */
92 SSQ_RESCAN = 0x2000, /* Rescan target for LUNs. */
93 SSQ_LOST = 0x4000, /* Destroy the LUNs. */
95 } scsi_sense_action_qualifier;
97 /* Mask for error status values */
98 #define SS_ERRMASK 0xff
100 /* The default, retyable, error action */
101 #define SS_RDEF SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE|EIO
103 /* The retyable, error action, with table specified error code */
104 #define SS_RET SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE
106 /* Wait for transient error status to change */
107 #define SS_WAIT SS_TUR|SSQ_MANY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE
109 /* Fatal error action, with table specified error code */
110 #define SS_FATAL SS_FAIL|SSQ_PRINT_SENSE
118 struct scsi_request_sense
122 #define SRS_DESC 0x01
128 struct scsi_test_unit_ready
136 struct scsi_receive_diag {
145 struct scsi_send_diag {
148 #define SSD_UNITOFFL 0x01
149 #define SSD_DEVOFFL 0x02
150 #define SSD_SELFTEST 0x04
152 #define SSD_SELF_TEST_CODE_MASK 0xE0
153 #define SSD_SELF_TEST_CODE_SHIFT 5
154 #define SSD_SELF_TEST_CODE_NONE 0x00
155 #define SSD_SELF_TEST_CODE_BG_SHORT 0x01
156 #define SSD_SELF_TEST_CODE_BG_EXTENDED 0x02
157 #define SSD_SELF_TEST_CODE_BG_ABORT 0x04
158 #define SSD_SELF_TEST_CODE_FG_SHORT 0x05
159 #define SSD_SELF_TEST_CODE_FG_EXTENDED 0x06
179 #define SI_CMDDT 0x02
185 struct scsi_mode_sense_6
191 #define SMS_PAGE_CODE 0x3F
192 #define SMS_VENDOR_SPECIFIC_PAGE 0x00
193 #define SMS_DISCONNECT_RECONNECT_PAGE 0x02
194 #define SMS_FORMAT_DEVICE_PAGE 0x03
195 #define SMS_GEOMETRY_PAGE 0x04
196 #define SMS_CACHE_PAGE 0x08
197 #define SMS_PERIPHERAL_DEVICE_PAGE 0x09
198 #define SMS_CONTROL_MODE_PAGE 0x0A
199 #define SMS_PROTO_SPECIFIC_PAGE 0x19
200 #define SMS_INFO_EXCEPTIONS_PAGE 0x1C
201 #define SMS_ALL_PAGES_PAGE 0x3F
202 #define SMS_PAGE_CTRL_MASK 0xC0
203 #define SMS_PAGE_CTRL_CURRENT 0x00
204 #define SMS_PAGE_CTRL_CHANGEABLE 0x40
205 #define SMS_PAGE_CTRL_DEFAULT 0x80
206 #define SMS_PAGE_CTRL_SAVED 0xC0
208 #define SMS_SUBPAGE_PAGE_0 0x00
209 #define SMS_SUBPAGE_ALL 0xff
214 struct scsi_mode_sense_10
217 u_int8_t byte2; /* same bits as small version */
218 #define SMS10_LLBAA 0x10
219 u_int8_t page; /* same bits as small version */
226 struct scsi_mode_select_6
238 struct scsi_mode_select_10
241 u_int8_t byte2; /* same bits as small version */
248 * When sending a mode select to a tape drive, the medium type must be 0.
250 struct scsi_mode_hdr_6
253 u_int8_t medium_type;
254 u_int8_t dev_specific;
255 u_int8_t block_descr_len;
258 struct scsi_mode_hdr_10
261 u_int8_t medium_type;
262 u_int8_t dev_specific;
263 u_int8_t reserved[2];
264 u_int8_t block_descr_len[2];
267 struct scsi_mode_block_descr
269 u_int8_t density_code;
270 u_int8_t num_blocks[3];
272 u_int8_t block_len[3];
275 struct scsi_per_res_in
283 u_int8_t reserved[5];
285 #define SPRI_MAX_LEN 0xffff
289 struct scsi_per_res_in_header
291 u_int8_t generation[4];
295 struct scsi_per_res_key
300 struct scsi_per_res_in_keys
302 struct scsi_per_res_in_header header;
303 struct scsi_per_res_key keys[0];
306 struct scsi_per_res_cap
310 #define SPRI_RLR_C 0x80
311 #define SPRI_CRH 0x10
312 #define SPRI_SIP_C 0x08
313 #define SPRI_ATP_C 0x04
314 #define SPRI_PTPL_C 0x01
316 #define SPRI_TMV 0x80
317 #define SPRI_ALLOW_CMD_MASK 0x70
318 #define SPRI_ALLOW_CMD_SHIFT 4
319 #define SPRI_ALLOW_NA 0x00
320 #define SPRI_ALLOW_1 0x10
321 #define SPRI_ALLOW_2 0x20
322 #define SPRI_ALLOW_3 0x30
323 #define SPRI_ALLOW_4 0x40
324 #define SPRI_ALLOW_5 0x50
325 #define SPRI_PTPL_A 0x01
326 uint8_t type_mask[2];
327 #define SPRI_TM_WR_EX_AR 0x8000
328 #define SPRI_TM_EX_AC_RO 0x4000
329 #define SPRI_TM_WR_EX_RO 0x2000
330 #define SPRI_TM_EX_AC 0x0800
331 #define SPRI_TM_WR_EX 0x0200
332 #define SPRI_TM_EX_AC_AR 0x0001
336 struct scsi_per_res_in_rsrv_data
338 uint8_t reservation[8];
339 uint8_t scope_addr[4];
344 #define SPRT_WERO 0x05
345 #define SPRT_EARO 0x06
346 #define SPRT_WEAR 0x07
347 #define SPRT_EAAR 0x08
348 uint8_t extent_length[2];
351 struct scsi_per_res_in_rsrv
353 struct scsi_per_res_in_header header;
354 struct scsi_per_res_in_rsrv_data data;
357 struct scsi_per_res_in_full_desc
359 struct scsi_per_res_key res_key;
360 uint8_t reserved1[4];
362 #define SPRI_FULL_ALL_TG_PT 0x02
363 #define SPRI_FULL_R_HOLDER 0x01
365 uint8_t reserved2[4];
366 uint8_t rel_trgt_port_id[2];
367 uint8_t additional_length[4];
368 uint8_t transport_id[];
371 struct scsi_per_res_in_full
373 struct scsi_per_res_in_header header;
374 struct scsi_per_res_in_full_desc desc[];
377 struct scsi_per_res_out
381 #define SPRO_REGISTER 0x00
382 #define SPRO_RESERVE 0x01
383 #define SPRO_RELEASE 0x02
384 #define SPRO_CLEAR 0x03
385 #define SPRO_PREEMPT 0x04
386 #define SPRO_PRE_ABO 0x05
387 #define SPRO_REG_IGNO 0x06
388 #define SPRO_REG_MOVE 0x07
389 #define SPRO_REPL_LOST_RES 0x08
390 #define SPRO_ACTION_MASK 0x1f
392 #define SPR_SCOPE_MASK 0xf0
393 #define SPR_SCOPE_SHIFT 4
394 #define SPR_LU_SCOPE 0x00
395 #define SPR_EXTENT_SCOPE 0x10
396 #define SPR_ELEMENT_SCOPE 0x20
397 #define SPR_TYPE_MASK 0x0f
398 #define SPR_TYPE_RD_SHARED 0x00
399 #define SPR_TYPE_WR_EX 0x01
400 #define SPR_TYPE_RD_EX 0x02
401 #define SPR_TYPE_EX_AC 0x03
402 #define SPR_TYPE_SHARED 0x04
403 #define SPR_TYPE_WR_EX_RO 0x05
404 #define SPR_TYPE_EX_AC_RO 0x06
405 #define SPR_TYPE_WR_EX_AR 0x07
406 #define SPR_TYPE_EX_AC_AR 0x08
407 u_int8_t reserved[2];
412 struct scsi_per_res_out_parms
414 struct scsi_per_res_key res_key;
415 u_int8_t serv_act_res_key[8];
416 u_int8_t scope_spec_address[4];
418 #define SPR_SPEC_I_PT 0x08
419 #define SPR_ALL_TG_PT 0x04
420 #define SPR_APTPL 0x01
422 u_int8_t extent_length[2];
423 u_int8_t transport_id_list[];
426 struct scsi_per_res_out_trans_ids {
427 u_int8_t additional_length[4];
428 u_int8_t transport_ids[];
432 * Used with REGISTER AND MOVE serivce action of the PERSISTENT RESERVE OUT
435 struct scsi_per_res_reg_move
437 struct scsi_per_res_key res_key;
438 u_int8_t serv_act_res_key[8];
441 #define SPR_REG_MOVE_UNREG 0x02
442 #define SPR_REG_MOVE_APTPL 0x01
443 u_int8_t rel_trgt_port_id[2];
444 u_int8_t transport_id_length[4];
445 u_int8_t transport_id[];
448 struct scsi_transportid_header
450 uint8_t format_protocol;
451 #define SCSI_TRN_FORMAT_MASK 0xc0
452 #define SCSI_TRN_FORMAT_SHIFT 6
453 #define SCSI_TRN_PROTO_MASK 0x0f
456 struct scsi_transportid_fcp
458 uint8_t format_protocol;
459 #define SCSI_TRN_FCP_FORMAT_DEFAULT 0x00
460 uint8_t reserved1[7];
461 uint8_t n_port_name[8];
462 uint8_t reserved2[8];
465 struct scsi_transportid_spi
467 uint8_t format_protocol;
468 #define SCSI_TRN_SPI_FORMAT_DEFAULT 0x00
470 uint8_t scsi_addr[2];
472 uint8_t rel_trgt_port_id[2];
473 uint8_t reserved2[16];
476 struct scsi_transportid_1394
478 uint8_t format_protocol;
479 #define SCSI_TRN_1394_FORMAT_DEFAULT 0x00
480 uint8_t reserved1[7];
482 uint8_t reserved2[8];
485 struct scsi_transportid_rdma
487 uint8_t format_protocol;
488 #define SCSI_TRN_RDMA_FORMAT_DEFAULT 0x00
490 #define SCSI_TRN_RDMA_PORT_LEN 16
491 uint8_t initiator_port_id[SCSI_TRN_RDMA_PORT_LEN];
494 struct scsi_transportid_iscsi_device
496 uint8_t format_protocol;
497 #define SCSI_TRN_ISCSI_FORMAT_DEVICE 0x00
499 uint8_t additional_length[2];
500 uint8_t iscsi_name[];
503 struct scsi_transportid_iscsi_port
505 uint8_t format_protocol;
506 #define SCSI_TRN_ISCSI_FORMAT_PORT 0x40
508 uint8_t additional_length[2];
509 uint8_t iscsi_name[];
511 * Followed by a separator and iSCSI initiator session ID
515 struct scsi_transportid_sas
517 uint8_t format_protocol;
518 #define SCSI_TRN_SAS_FORMAT_DEFAULT 0x00
519 uint8_t reserved1[3];
520 uint8_t sas_address[8];
521 uint8_t reserved2[12];
524 struct scsi_sop_routing_id_norm {
527 #define SCSI_TRN_SOP_BUS_MAX 0xff
528 #define SCSI_TRN_SOP_DEV_MAX 0x1f
529 #define SCSI_TRN_SOP_DEV_MASK 0xf8
530 #define SCSI_TRN_SOP_DEV_SHIFT 3
531 #define SCSI_TRN_SOP_FUNC_NORM_MASK 0x07
532 #define SCSI_TRN_SOP_FUNC_NORM_MAX 0x07
535 struct scsi_sop_routing_id_alt {
538 #define SCSI_TRN_SOP_FUNC_ALT_MAX 0xff
541 struct scsi_transportid_sop
543 uint8_t format_protocol;
544 #define SCSI_TRN_SOP_FORMAT_DEFAULT 0x00
546 uint8_t routing_id[2];
547 uint8_t reserved2[20];
550 struct scsi_log_sense
557 #define SLS_PAGE_CODE 0x3F
558 #define SLS_SUPPORTED_PAGES_PAGE 0x00
559 #define SLS_OVERRUN_PAGE 0x01
560 #define SLS_ERROR_WRITE_PAGE 0x02
561 #define SLS_ERROR_READ_PAGE 0x03
562 #define SLS_ERROR_READREVERSE_PAGE 0x04
563 #define SLS_ERROR_VERIFY_PAGE 0x05
564 #define SLS_ERROR_NONMEDIUM_PAGE 0x06
565 #define SLS_ERROR_LASTN_PAGE 0x07
566 #define SLS_LOGICAL_BLOCK_PROVISIONING 0x0c
567 #define SLS_SELF_TEST_PAGE 0x10
568 #define SLS_SOLID_STATE_MEDIA 0x11
569 #define SLS_STAT_AND_PERF 0x19
570 #define SLS_IE_PAGE 0x2f
571 #define SLS_PAGE_CTRL_MASK 0xC0
572 #define SLS_PAGE_CTRL_THRESHOLD 0x00
573 #define SLS_PAGE_CTRL_CUMULATIVE 0x40
574 #define SLS_PAGE_CTRL_THRESH_DEFAULT 0x80
575 #define SLS_PAGE_CTRL_CUMUL_DEFAULT 0xC0
577 #define SLS_SUPPORTED_SUBPAGES_SUBPAGE 0xff
579 u_int8_t paramptr[2];
584 struct scsi_log_select
591 /* SLS_PAGE_CTRL_MASK 0xC0 */
592 /* SLS_PAGE_CTRL_THRESHOLD 0x00 */
593 /* SLS_PAGE_CTRL_CUMULATIVE 0x40 */
594 /* SLS_PAGE_CTRL_THRESH_DEFAULT 0x80 */
595 /* SLS_PAGE_CTRL_CUMUL_DEFAULT 0xC0 */
596 u_int8_t reserved[4];
601 struct scsi_log_header
604 #define SL_PAGE_CODE 0x3F
611 struct scsi_log_param_header {
612 u_int8_t param_code[2];
613 u_int8_t param_control;
615 #define SLP_LBIN 0x02
616 #define SLP_TMC_MASK 0x0C
617 #define SLP_TMC_ALWAYS 0x00
618 #define SLP_TMC_EQUAL 0x04
619 #define SLP_TMC_NOTEQUAL 0x08
620 #define SLP_TMC_GREATER 0x0C
628 struct scsi_log_media_pct_used {
629 struct scsi_log_param_header hdr;
630 #define SLP_SS_MEDIA_PCT_USED 0x0001
635 struct scsi_log_stat_and_perf {
636 struct scsi_log_param_header hdr;
637 #define SLP_SAP 0x0001
639 uint8_t write_num[8];
640 uint8_t recvieved_lba[8];
641 uint8_t transmitted_lba[8];
643 uint8_t write_int[8];
644 uint8_t weighted_num[8];
645 uint8_t weighted_int[8];
648 struct scsi_log_idle_time {
649 struct scsi_log_param_header hdr;
650 #define SLP_IT 0x0002
654 struct scsi_log_time_interval {
655 struct scsi_log_param_header hdr;
656 #define SLP_TI 0x0003
661 struct scsi_log_fua_stat_and_perf {
662 struct scsi_log_param_header hdr;
663 #define SLP_FUA_SAP 0x0004
664 uint8_t fua_read_num[8];
665 uint8_t fua_write_num[8];
666 uint8_t fuanv_read_num[8];
667 uint8_t fuanv_write_num[8];
668 uint8_t fua_read_int[8];
669 uint8_t fua_write_int[8];
670 uint8_t fuanv_read_int[8];
671 uint8_t fuanv_write_int[8];
674 struct scsi_log_informational_exceptions {
675 struct scsi_log_param_header hdr;
676 #define SLP_IE_GEN 0x0000
682 struct scsi_control_page {
684 u_int8_t page_length;
686 #define SCP_RLEC 0x01 /*Report Log Exception Cond*/
687 #define SCP_GLTSD 0x02 /*Global Logging target
689 #define SCP_DSENSE 0x04 /*Descriptor Sense */
690 #define SCP_DPICZ 0x08 /*Disable Prot. Info Check
691 if Prot. Field is Zero */
692 #define SCP_TMF_ONLY 0x10 /*TM Functions Only*/
693 #define SCP_TST_MASK 0xE0 /*Task Set Type Mask*/
694 #define SCP_TST_ONE 0x00 /*One Task Set*/
695 #define SCP_TST_SEPARATE 0x20 /*Separate Task Sets*/
696 u_int8_t queue_flags;
697 #define SCP_QUEUE_ALG_MASK 0xF0
698 #define SCP_QUEUE_ALG_RESTRICTED 0x00
699 #define SCP_QUEUE_ALG_UNRESTRICTED 0x10
700 #define SCP_NUAR 0x08 /*No UA on release*/
701 #define SCP_QUEUE_ERR 0x02 /*Queued I/O aborted for CACs*/
702 #define SCP_QUEUE_DQUE 0x01 /*Queued I/O disabled*/
703 u_int8_t eca_and_aen;
704 #define SCP_EECA 0x80 /*Enable Extended CA*/
705 #define SCP_RAC 0x40 /*Report a check*/
706 #define SCP_SWP 0x08 /*Software Write Protect*/
707 #define SCP_RAENP 0x04 /*Ready AEN Permission*/
708 #define SCP_UAAENP 0x02 /*UA AEN Permission*/
709 #define SCP_EAENP 0x01 /*Error AEN Permission*/
711 #define SCP_ATO 0x80 /*Application tag owner*/
712 #define SCP_TAS 0x40 /*Task aborted status*/
713 #define SCP_ATMPE 0x20 /*Application tag mode page*/
714 #define SCP_RWWP 0x10 /*Reject write without prot*/
715 u_int8_t aen_holdoff_period[2];
716 u_int8_t busy_timeout_period[2];
717 u_int8_t extended_selftest_completion_time[2];
720 struct scsi_control_ext_page {
722 #define SCEP_PAGE_CODE 0x0a
723 uint8_t subpage_code;
724 #define SCEP_SUBPAGE_CODE 0x01
725 uint8_t page_length[2];
727 #define SCEP_TCMOS 0x04 /* Timestamp Changeable by */
728 #define SCEP_SCSIP 0x02 /* SCSI Precedence (clock) */
729 #define SCEP_IALUAE 0x01 /* Implicit ALUA Enabled */
735 struct scsi_cache_page {
737 #define SCHP_PAGE_SAVABLE 0x80 /* Page is savable */
738 u_int8_t page_length;
739 u_int8_t cache_flags;
740 #define SCHP_FLAGS_WCE 0x04 /* Write Cache Enable */
741 #define SCHP_FLAGS_MF 0x02 /* Multiplication factor */
742 #define SCHP_FLAGS_RCD 0x01 /* Read Cache Disable */
743 u_int8_t rw_cache_policy;
744 u_int8_t dis_prefetch[2];
745 u_int8_t min_prefetch[2];
746 u_int8_t max_prefetch[2];
747 u_int8_t max_prefetch_ceil[2];
752 * Updated version of the cache page, as of SBC. Update this to SBC-3 and
753 * rationalize the two.
755 struct scsi_caching_page {
757 #define SMS_CACHING_PAGE 0x08
761 #define SCP_ABPF 0x40
763 #define SCP_DISC 0x10
764 #define SCP_SIZE 0x08
768 uint8_t ret_priority;
769 uint8_t disable_pf_transfer_len[2];
770 uint8_t min_prefetch[2];
771 uint8_t max_prefetch[2];
772 uint8_t max_pf_ceiling[2];
775 #define SCP_LBCSS 0x40
779 uint8_t cache_segments;
780 uint8_t cache_seg_size[2];
782 uint8_t non_cache_seg_size[3];
785 struct scsi_info_exceptions_page {
787 #define SIEP_PAGE_SAVABLE 0x80 /* Page is savable */
788 u_int8_t page_length;
790 #define SIEP_FLAGS_PERF 0x80
791 #define SIEP_FLAGS_EBF 0x20
792 #define SIEP_FLAGS_EWASC 0x10
793 #define SIEP_FLAGS_DEXCPT 0x08
794 #define SIEP_FLAGS_TEST 0x04
795 #define SIEP_FLAGS_EBACKERR 0x02
796 #define SIEP_FLAGS_LOGERR 0x01
798 #define SIEP_MRIE_NO 0x00
799 #define SIEP_MRIE_UA 0x02
800 #define SIEP_MRIE_REC_COND 0x03
801 #define SIEP_MRIE_REC_UNCOND 0x04
802 #define SIEP_MRIE_NO_SENSE 0x05
803 #define SIEP_MRIE_ON_REQ 0x06
804 u_int8_t interval_timer[4];
805 u_int8_t report_count[4];
808 struct scsi_logical_block_provisioning_page_descr {
810 #define SLBPPD_ENABLED 0x80
811 #define SLBPPD_TYPE_MASK 0x38
812 #define SLBPPD_ARMING_MASK 0x07
813 #define SLBPPD_ARMING_DEC 0x02
814 #define SLBPPD_ARMING_INC 0x01
820 struct scsi_logical_block_provisioning_page {
822 uint8_t subpage_code;
823 uint8_t page_length[2];
825 #define SLBPP_SITUA 0x01
826 uint8_t reserved[11];
827 struct scsi_logical_block_provisioning_page_descr descr[0];
831 * SCSI protocol identifier values, current as of SPC4r36l.
833 #define SCSI_PROTO_FC 0x00 /* Fibre Channel */
834 #define SCSI_PROTO_SPI 0x01 /* Parallel SCSI */
835 #define SCSI_PROTO_SSA 0x02 /* Serial Storage Arch. */
836 #define SCSI_PROTO_1394 0x03 /* IEEE 1394 (Firewire) */
837 #define SCSI_PROTO_RDMA 0x04 /* SCSI RDMA Protocol */
838 #define SCSI_PROTO_ISCSI 0x05 /* Internet SCSI */
839 #define SCSI_PROTO_iSCSI 0x05 /* Internet SCSI */
840 #define SCSI_PROTO_SAS 0x06 /* SAS Serial SCSI Protocol */
841 #define SCSI_PROTO_ADT 0x07 /* Automation/Drive Int. Trans. Prot.*/
842 #define SCSI_PROTO_ADITP 0x07 /* Automation/Drive Int. Trans. Prot.*/
843 #define SCSI_PROTO_ATA 0x08 /* AT Attachment Interface */
844 #define SCSI_PROTO_UAS 0x09 /* USB Atached SCSI */
845 #define SCSI_PROTO_SOP 0x0a /* SCSI over PCI Express */
846 #define SCSI_PROTO_NONE 0x0f /* No specific protocol */
848 struct scsi_proto_specific_page {
850 #define SPSP_PAGE_SAVABLE 0x80 /* Page is savable */
851 u_int8_t page_length;
853 #define SPSP_PROTO_FC SCSI_PROTO_FC
854 #define SPSP_PROTO_SPI SCSI_PROTO_SPI
855 #define SPSP_PROTO_SSA SCSI_PROTO_SSA
856 #define SPSP_PROTO_1394 SCSI_PROTO_1394
857 #define SPSP_PROTO_RDMA SCSI_PROTO_RDMA
858 #define SPSP_PROTO_ISCSI SCSI_PROTO_ISCSI
859 #define SPSP_PROTO_SAS SCSI_PROTO_SAS
860 #define SPSP_PROTO_ADT SCSI_PROTO_ADITP
861 #define SPSP_PROTO_ATA SCSI_PROTO_ATA
862 #define SPSP_PROTO_UAS SCSI_PROTO_UAS
863 #define SPSP_PROTO_SOP SCSI_PROTO_SOP
864 #define SPSP_PROTO_NONE SCSI_PROTO_NONE
871 #define SR_EXTENT 0x01
872 #define SR_ID_MASK 0x0e
873 #define SR_3RDPTY 0x10
874 #define SR_LUN_MASK 0xe0
880 struct scsi_reserve_10 {
883 #define SR10_3RDPTY 0x10
884 #define SR10_LONGID 0x02
885 #define SR10_EXTENT 0x01
887 uint8_t thirdparty_id;
904 struct scsi_release_10 {
908 uint8_t thirdparty_id;
922 #define PR_PREVENT 0x01
923 #define PR_ALLOW 0x00
925 struct scsi_sync_cache
929 #define SSC_IMMED 0x02
930 #define SSC_RELADR 0x01
931 u_int8_t begin_lba[4];
933 u_int8_t lb_count[2];
937 struct scsi_sync_cache_16
941 uint8_t begin_lba[8];
950 #define SF_LONGLIST 0x20
951 #define SF_FMTDATA 0x10
952 #define SF_CMPLIST 0x08
953 #define SF_FORMAT_MASK 0x07
954 #define SF_FORMAT_BLOCK 0x00
955 #define SF_FORMAT_LONG_BLOCK 0x03
956 #define SF_FORMAT_BFI 0x04
957 #define SF_FORMAT_PHYS 0x05
959 uint8_t interleave[2];
963 struct scsi_format_header_short {
965 #define SF_DATA_FOV 0x80
966 #define SF_DATA_DPRY 0x40
967 #define SF_DATA_DCRT 0x20
968 #define SF_DATA_STPF 0x10
969 #define SF_DATA_IP 0x08
970 #define SF_DATA_DSP 0x04
971 #define SF_DATA_IMMED 0x02
972 #define SF_DATA_VS 0x01
974 uint8_t defect_list_len[2];
977 struct scsi_format_header_long {
980 uint8_t reserved2[2];
981 uint8_t defect_list_len[4];
984 struct scsi_changedef
995 struct scsi_read_buffer
999 #define RWB_MODE 0x1F
1000 #define RWB_MODE_HDR_DATA 0x00
1001 #define RWB_MODE_VENDOR 0x01
1002 #define RWB_MODE_DATA 0x02
1003 #define RWB_MODE_DESCR 0x03
1004 #define RWB_MODE_DOWNLOAD 0x04
1005 #define RWB_MODE_DOWNLOAD_SAVE 0x05
1006 #define RWB_MODE_ECHO 0x0A
1007 #define RWB_MODE_ECHO_DESCR 0x0B
1008 #define RWB_MODE_ERROR_HISTORY 0x1C
1015 struct scsi_read_buffer_16
1025 struct scsi_write_buffer
1035 struct scsi_read_attribute
1038 u_int8_t service_action;
1039 #define SRA_SA_ATTR_VALUES 0x00
1040 #define SRA_SA_ATTR_LIST 0x01
1041 #define SRA_SA_LOG_VOL_LIST 0x02
1042 #define SRA_SA_PART_LIST 0x03
1043 #define SRA_SA_RESTRICTED 0x04
1044 #define SRA_SA_SUPPORTED_ATTRS 0x05
1045 #define SRA_SA_MASK 0x1f
1046 u_int8_t element[2];
1048 u_int8_t logical_volume;
1051 u_int8_t first_attribute[2];
1054 #define SRA_CACHE 0x01
1058 struct scsi_write_attribute
1062 #define SWA_WTC 0x01
1063 u_int8_t element[3];
1064 u_int8_t logical_volume;
1067 u_int8_t reserved2[2];
1074 struct scsi_read_attribute_values
1077 u_int8_t attribute_0[0];
1080 struct scsi_mam_attribute_header
1084 * Attributes obtained from SPC-4r36g (section 7.4.2.2) and
1085 * SSC-4r03 (section 4.2.21).
1087 #define SMA_ATTR_ID_DEVICE_MIN 0x0000
1089 #define SMA_ATTR_REM_CAP_PARTITION 0x0000
1090 #define SMA_ATTR_MAX_CAP_PARTITION 0x0001
1091 #define SMA_ATTR_TAPEALERT_FLAGS 0x0002
1092 #define SMA_ATTR_LOAD_COUNT 0x0003
1093 #define SMA_ATTR_MAM_SPACE_REMAINING 0x0004
1095 #define SMA_ATTR_DEV_ASSIGNING_ORG 0x0005
1096 #define SMA_ATTR_FORMAT_DENSITY_CODE 0x0006
1097 #define SMA_ATTR_INITIALIZATION_COUNT 0x0007
1098 #define SMA_ATTR_VOLUME_ID 0x0008
1099 #define SMA_ATTR_VOLUME_CHANGE_REF 0x0009
1101 #define SMA_ATTR_DEV_SERIAL_LAST_LOAD 0x020a
1102 #define SMA_ATTR_DEV_SERIAL_LAST_LOAD_1 0x020b
1103 #define SMA_ATTR_DEV_SERIAL_LAST_LOAD_2 0x020c
1104 #define SMA_ATTR_DEV_SERIAL_LAST_LOAD_3 0x020d
1106 #define SMA_ATTR_TOTAL_MB_WRITTEN_LT 0x0220
1107 #define SMA_ATTR_TOTAL_MB_READ_LT 0x0221
1108 #define SMA_ATTR_TOTAL_MB_WRITTEN_CUR 0x0222
1109 #define SMA_ATTR_TOTAL_MB_READ_CUR 0x0223
1110 #define SMA_ATTR_FIRST_ENC_BLOCK 0x0224
1111 #define SMA_ATTR_NEXT_UNENC_BLOCK 0x0225
1113 #define SMA_ATTR_MEDIUM_USAGE_HIST 0x0340
1114 #define SMA_ATTR_PART_USAGE_HIST 0x0341
1116 #define SMA_ATTR_ID_DEVICE_MAX 0x03ff
1118 #define SMA_ATTR_ID_MEDIUM_MIN 0x0400
1120 #define SMA_ATTR_MED_MANUF 0x0400
1121 #define SMA_ATTR_MED_SERIAL 0x0401
1123 #define SMA_ATTR_MED_LENGTH 0x0402
1124 #define SMA_ATTR_MED_WIDTH 0x0403
1125 #define SMA_ATTR_MED_ASSIGNING_ORG 0x0404
1126 #define SMA_ATTR_MED_DENSITY_CODE 0x0405
1128 #define SMA_ATTR_MED_MANUF_DATE 0x0406
1129 #define SMA_ATTR_MAM_CAPACITY 0x0407
1130 #define SMA_ATTR_MED_TYPE 0x0408
1131 #define SMA_ATTR_MED_TYPE_INFO 0x0409
1132 #define SMA_ATTR_MED_SERIAL_NUM 0x040a
1134 #define SMA_ATTR_ID_MEDIUM_MAX 0x07ff
1136 #define SMA_ATTR_ID_HOST_MIN 0x0800
1138 #define SMA_ATTR_APP_VENDOR 0x0800
1139 #define SMA_ATTR_APP_NAME 0x0801
1140 #define SMA_ATTR_APP_VERSION 0x0802
1141 #define SMA_ATTR_USER_MED_TEXT_LABEL 0x0803
1142 #define SMA_ATTR_LAST_WRITTEN_TIME 0x0804
1143 #define SMA_ATTR_TEXT_LOCAL_ID 0x0805
1144 #define SMA_ATTR_BARCODE 0x0806
1145 #define SMA_ATTR_HOST_OWNER_NAME 0x0807
1146 #define SMA_ATTR_MEDIA_POOL 0x0808
1147 #define SMA_ATTR_PART_USER_LABEL 0x0809
1148 #define SMA_ATTR_LOAD_UNLOAD_AT_PART 0x080a
1149 #define SMA_ATTR_APP_FORMAT_VERSION 0x080b
1150 #define SMA_ATTR_VOL_COHERENCY_INFO 0x080c
1152 #define SMA_ATTR_ID_HOST_MAX 0x0bff
1154 #define SMA_ATTR_VENDOR_DEVICE_MIN 0x0c00
1155 #define SMA_ATTR_VENDOR_DEVICE_MAX 0x0fff
1156 #define SMA_ATTR_VENDOR_MEDIUM_MIN 0x1000
1157 #define SMA_ATTR_VENDOR_MEDIUM_MAX 0x13ff
1158 #define SMA_ATTR_VENDOR_HOST_MIN 0x1400
1159 #define SMA_ATTR_VENDOR_HOST_MAX 0x17ff
1161 #define SMA_FORMAT_BINARY 0x00
1162 #define SMA_FORMAT_ASCII 0x01
1163 #define SMA_FORMAT_TEXT 0x02
1164 #define SMA_FORMAT_MASK 0x03
1165 #define SMA_READ_ONLY 0x80
1167 u_int8_t attribute[0];
1170 struct scsi_attrib_list_header {
1172 u_int8_t first_attr_0[0];
1175 struct scsi_attrib_lv_list {
1177 u_int8_t first_lv_number;
1178 u_int8_t num_logical_volumes;
1181 struct scsi_attrib_vendser {
1183 uint8_t serial_num[32];
1187 * These values are used to decode the Volume Coherency Information
1188 * Attribute (0x080c) for LTFS-format coherency information.
1189 * Although the Application Client Specific lengths are different for
1190 * Version 0 and Version 1, the data is in fact the same. The length
1191 * difference was due to a code bug.
1193 #define SCSI_LTFS_VER0_LEN 42
1194 #define SCSI_LTFS_VER1_LEN 43
1195 #define SCSI_LTFS_UUID_LEN 36
1196 #define SCSI_LTFS_STR_NAME "LTFS"
1197 #define SCSI_LTFS_STR_LEN 4
1200 SCSI_ATTR_FLAG_NONE = 0x00,
1201 SCSI_ATTR_FLAG_HEX = 0x01,
1202 SCSI_ATTR_FLAG_FP = 0x02,
1203 SCSI_ATTR_FLAG_DIV_10 = 0x04,
1204 SCSI_ATTR_FLAG_FP_1DIGIT = 0x08
1205 } scsi_attrib_flags;
1208 SCSI_ATTR_OUTPUT_NONE = 0x00,
1209 SCSI_ATTR_OUTPUT_TEXT_MASK = 0x03,
1210 SCSI_ATTR_OUTPUT_TEXT_RAW = 0x00,
1211 SCSI_ATTR_OUTPUT_TEXT_ESC = 0x01,
1212 SCSI_ATTR_OUTPUT_TEXT_RSV1 = 0x02,
1213 SCSI_ATTR_OUTPUT_TEXT_RSV2 = 0x03,
1214 SCSI_ATTR_OUTPUT_NONASCII_MASK = 0x0c,
1215 SCSI_ATTR_OUTPUT_NONASCII_TRIM = 0x00,
1216 SCSI_ATTR_OUTPUT_NONASCII_ESC = 0x04,
1217 SCSI_ATTR_OUTPUT_NONASCII_RAW = 0x08,
1218 SCSI_ATTR_OUTPUT_NONASCII_RSV1 = 0x0c,
1219 SCSI_ATTR_OUTPUT_FIELD_MASK = 0xf0,
1220 SCSI_ATTR_OUTPUT_FIELD_ALL = 0xf0,
1221 SCSI_ATTR_OUTPUT_FIELD_NONE = 0x00,
1222 SCSI_ATTR_OUTPUT_FIELD_DESC = 0x10,
1223 SCSI_ATTR_OUTPUT_FIELD_NUM = 0x20,
1224 SCSI_ATTR_OUTPUT_FIELD_SIZE = 0x40,
1225 SCSI_ATTR_OUTPUT_FIELD_RW = 0x80
1226 } scsi_attrib_output_flags;
1230 struct scsi_attrib_table_entry
1236 int (*to_str)(struct sbuf *sb, struct scsi_mam_attribute_header *hdr,
1237 uint32_t valid_len, uint32_t flags,
1238 uint32_t output_flags, char *error_str,
1240 int (*parse_str)(char *str, struct scsi_mam_attribute_header *hdr,
1241 uint32_t alloc_len, uint32_t flags, char *error_str,
1249 /* only 5 bits are valid in the MSB address byte */
1250 #define SRW_TOPADDR 0x1F
1258 #define SRW10_RELADDR 0x01
1259 /* EBP defined for WRITE(10) only */
1260 #define SRW10_EBP 0x04
1261 #define SRW10_FUA 0x08
1262 #define SRW10_DPO 0x10
1273 #define SRW12_RELADDR 0x01
1274 #define SRW12_FUA 0x08
1275 #define SRW12_DPO 0x10
1286 #define SRW16_RELADDR 0x01
1287 #define SRW16_FUA 0x08
1288 #define SRW16_DPO 0x10
1296 struct scsi_write_atomic_16
1301 uint8_t boundary[2];
1307 struct scsi_write_same_10
1311 #define SWS_LBDATA 0x02
1312 #define SWS_PBDATA 0x04
1313 #define SWS_UNMAP 0x08
1314 #define SWS_ANCHOR 0x10
1321 struct scsi_write_same_16
1325 #define SWS_NDOB 0x01
1336 #define SU_ANCHOR 0x01
1337 uint8_t reserved[4];
1343 struct scsi_unmap_header
1346 uint8_t desc_length[2];
1347 uint8_t reserved[4];
1350 struct scsi_unmap_desc
1354 uint8_t reserved[4];
1357 struct scsi_write_verify_10
1361 #define SWV_BYTCHK 0x02
1362 #define SWV_DPO 0x10
1363 #define SWV_WRPROECT_MASK 0xe0
1370 struct scsi_write_verify_12
1380 struct scsi_write_verify_16
1391 struct scsi_start_stop_unit
1395 #define SSS_IMMED 0x01
1396 u_int8_t reserved[2];
1398 #define SSS_START 0x01
1399 #define SSS_LOEJ 0x02
1400 #define SSS_PC_MASK 0xf0
1401 #define SSS_PC_START_VALID 0x00
1402 #define SSS_PC_ACTIVE 0x10
1403 #define SSS_PC_IDLE 0x20
1404 #define SSS_PC_STANDBY 0x30
1405 #define SSS_PC_LU_CONTROL 0x70
1406 #define SSS_PC_FORCE_IDLE_0 0xa0
1407 #define SSS_PC_FORCE_STANDBY_0 0xb0
1411 struct ata_pass_12 {
1414 #define AP_PROTO_HARD_RESET (0x00 << 1)
1415 #define AP_PROTO_SRST (0x01 << 1)
1416 #define AP_PROTO_NON_DATA (0x03 << 1)
1417 #define AP_PROTO_PIO_IN (0x04 << 1)
1418 #define AP_PROTO_PIO_OUT (0x05 << 1)
1419 #define AP_PROTO_DMA (0x06 << 1)
1420 #define AP_PROTO_DMA_QUEUED (0x07 << 1)
1421 #define AP_PROTO_DEVICE_DIAG (0x08 << 1)
1422 #define AP_PROTO_DEVICE_RESET (0x09 << 1)
1423 #define AP_PROTO_UDMA_IN (0x0a << 1)
1424 #define AP_PROTO_UDMA_OUT (0x0b << 1)
1425 #define AP_PROTO_FPDMA (0x0c << 1)
1426 #define AP_PROTO_RESP_INFO (0x0f << 1)
1427 #define AP_PROTO_MASK 0x1e
1428 #define AP_MULTI 0xe0
1430 #define AP_T_LEN 0x03
1432 #define AP_T_DIR 0x08
1433 #define AP_CK_COND 0x20
1434 #define AP_OFFLINE 0x60
1436 u_int8_t sector_count;
1446 struct scsi_maintenance_in
1450 #define SERVICE_ACTION_MASK 0x1f
1451 #define SA_RPRT_TRGT_GRP 0x0a
1452 uint8_t reserved[4];
1458 struct scsi_report_supported_opcodes
1461 uint8_t service_action;
1463 #define RSO_RCTD 0x80
1464 #define RSO_OPTIONS_MASK 0x07
1465 #define RSO_OPTIONS_ALL 0x00
1466 #define RSO_OPTIONS_OC 0x01
1467 #define RSO_OPTIONS_OC_SA 0x02
1468 #define RSO_OPTIONS_OC_ASA 0x03
1469 uint8_t requested_opcode;
1470 uint8_t requested_service_action[2];
1476 struct scsi_report_supported_opcodes_timeout
1480 uint8_t cmd_specific;
1481 uint8_t nominal_time[4];
1482 uint8_t recommended_time[4];
1485 struct scsi_report_supported_opcodes_descr
1489 uint8_t service_action[2];
1492 #define RSO_SERVACTV 0x01
1493 #define RSO_CTDP 0x02
1494 #define RSO_CDLP_MASK 0x0c
1495 #define RSO_CDLP_NO 0x00
1496 #define RSO_CDLP_A 0x04
1497 #define RSO_CDLP_B 0x08
1498 uint8_t cdb_length[2];
1499 struct scsi_report_supported_opcodes_timeout timeout[0];
1502 struct scsi_report_supported_opcodes_all
1505 struct scsi_report_supported_opcodes_descr descr[0];
1508 struct scsi_report_supported_opcodes_one
1512 #define RSO_ONE_CTDP 0x80
1513 #define RSO_ONE_CDLP_MASK 0x18
1514 #define RSO_ONE_CDLP_NO 0x00
1515 #define RSO_ONE_CDLP_A 0x08
1516 #define RSO_ONE_CDLP_B 0x10
1517 #define RSO_ONE_SUP_MASK 0x07
1518 #define RSO_ONE_SUP_UNAVAIL 0x00
1519 #define RSO_ONE_SUP_NOT_SUP 0x01
1520 #define RSO_ONE_SUP_AVAIL 0x03
1521 #define RSO_ONE_SUP_VENDOR 0x05
1522 uint8_t cdb_length[2];
1523 uint8_t cdb_usage[];
1526 struct scsi_report_supported_tmf
1529 uint8_t service_action;
1531 #define RST_REPD 0x80
1532 uint8_t reserved[3];
1538 struct scsi_report_supported_tmf_data
1541 #define RST_WAKES 0x01
1542 #define RST_TRS 0x02
1543 #define RST_QTS 0x04
1544 #define RST_LURS 0x08
1545 #define RST_CTSS 0x10
1546 #define RST_CACAS 0x20
1547 #define RST_ATSS 0x40
1548 #define RST_ATS 0x80
1550 #define RST_ITNRS 0x01
1551 #define RST_QTSS 0x02
1552 #define RST_QAES 0x04
1557 struct scsi_report_supported_tmf_ext_data
1564 #define RST_TMFTMOV 0x01
1567 #define RST_WAKETS 0x01
1568 #define RST_TRTS 0x02
1569 #define RST_QTTS 0x04
1570 #define RST_LURTS 0x08
1571 #define RST_CTSTS 0x10
1572 #define RST_CACATS 0x20
1573 #define RST_ATSTS 0x40
1574 #define RST_ATTS 0x80
1576 #define RST_ITNRTS 0x01
1577 #define RST_QTSTS 0x02
1578 #define RST_QAETS 0x04
1579 uint8_t long_timeout[4];
1580 uint8_t short_timeout[4];
1583 struct scsi_report_timestamp
1586 uint8_t service_action;
1587 uint8_t reserved[4];
1593 struct scsi_report_timestamp_data
1597 #define RTS_ORIG_MASK 0x00
1598 #define RTS_ORIG_ZERO 0x00
1599 #define RTS_ORIG_SET 0x02
1600 #define RTS_ORIG_OUTSIDE 0x03
1602 uint8_t timestamp[6];
1603 uint8_t reserve2[2];
1606 struct scsi_receive_copy_status_lid1
1609 uint8_t service_action;
1610 #define RCS_RCS_LID1 0x00
1611 uint8_t list_identifier;
1612 uint8_t reserved[7];
1618 struct scsi_receive_copy_status_lid1_data
1620 uint8_t available_data[4];
1621 uint8_t copy_command_status;
1622 #define RCS_CCS_INPROG 0x00
1623 #define RCS_CCS_COMPLETED 0x01
1624 #define RCS_CCS_ERROR 0x02
1625 uint8_t segments_processed[2];
1626 uint8_t transfer_count_units;
1627 #define RCS_TC_BYTES 0x00
1628 #define RCS_TC_KBYTES 0x01
1629 #define RCS_TC_MBYTES 0x02
1630 #define RCS_TC_GBYTES 0x03
1631 #define RCS_TC_TBYTES 0x04
1632 #define RCS_TC_PBYTES 0x05
1633 #define RCS_TC_EBYTES 0x06
1634 #define RCS_TC_LBAS 0xf1
1635 uint8_t transfer_count[4];
1638 struct scsi_receive_copy_failure_details
1641 uint8_t service_action;
1642 #define RCS_RCFD 0x04
1643 uint8_t list_identifier;
1644 uint8_t reserved[7];
1650 struct scsi_receive_copy_failure_details_data
1652 uint8_t available_data[4];
1653 uint8_t reserved[52];
1654 uint8_t copy_command_status;
1656 uint8_t sense_data_length[2];
1657 uint8_t sense_data[];
1660 struct scsi_receive_copy_status_lid4
1663 uint8_t service_action;
1664 #define RCS_RCS_LID4 0x05
1665 uint8_t list_identifier[4];
1666 uint8_t reserved[4];
1672 struct scsi_receive_copy_status_lid4_data
1674 uint8_t available_data[4];
1675 uint8_t response_to_service_action;
1676 uint8_t copy_command_status;
1677 #define RCS_CCS_COMPLETED_PROD 0x03
1678 #define RCS_CCS_COMPLETED_RESID 0x04
1679 #define RCS_CCS_INPROG_FGBG 0x10
1680 #define RCS_CCS_INPROG_FG 0x11
1681 #define RCS_CCS_INPROG_BG 0x12
1682 #define RCS_CCS_ABORTED 0x60
1683 uint8_t operation_counter[2];
1684 uint8_t estimated_status_update_delay[4];
1685 uint8_t extended_copy_completion_status;
1686 uint8_t length_of_the_sense_data_field;
1687 uint8_t sense_data_length;
1688 uint8_t transfer_count_units;
1689 uint8_t transfer_count[8];
1690 uint8_t segments_processed[2];
1691 uint8_t reserved[6];
1692 uint8_t sense_data[];
1695 struct scsi_receive_copy_operating_parameters
1698 uint8_t service_action;
1699 #define RCS_RCOP 0x03
1700 uint8_t reserved[8];
1706 struct scsi_receive_copy_operating_parameters_data
1710 #define RCOP_SNLID 0x01
1711 uint8_t reserved[3];
1712 uint8_t maximum_cscd_descriptor_count[2];
1713 uint8_t maximum_segment_descriptor_count[2];
1714 uint8_t maximum_descriptor_list_length[4];
1715 uint8_t maximum_segment_length[4];
1716 uint8_t maximum_inline_data_length[4];
1717 uint8_t held_data_limit[4];
1718 uint8_t maximum_stream_device_transfer_size[4];
1719 uint8_t reserved2[2];
1720 uint8_t total_concurrent_copies[2];
1721 uint8_t maximum_concurrent_copies;
1722 uint8_t data_segment_granularity;
1723 uint8_t inline_data_granularity;
1724 uint8_t held_data_granularity;
1725 uint8_t reserved3[3];
1726 uint8_t implemented_descriptor_list_length;
1727 uint8_t list_of_implemented_descriptor_type_codes[0];
1730 struct scsi_extended_copy
1733 uint8_t service_action;
1734 #define EC_EC_LID1 0x00
1735 #define EC_EC_LID4 0x01
1736 uint8_t reserved[8];
1742 struct scsi_ec_cscd_dtsp
1745 #define EC_CSCD_FIXED 0x01
1746 #define EC_CSCD_PAD 0x04
1747 uint8_t block_length[3];
1753 #define EC_CSCD_EXT 0xff
1756 #define EC_LUIDT_MASK 0xc0
1757 #define EC_LUIDT_LUN 0x00
1758 #define EC_LUIDT_PROXY_TOKEN 0x40
1759 uint8_t relative_initiator_port[2];
1760 uint8_t cscd_params[24];
1761 struct scsi_ec_cscd_dtsp dtsp;
1764 struct scsi_ec_cscd_id
1767 #define EC_CSCD_ID 0xe4
1769 uint8_t relative_initiator_port[2];
1774 uint8_t designator[20];
1775 struct scsi_ec_cscd_dtsp dtsp;
1778 struct scsi_ec_segment
1782 #define EC_SEG_DC 0x02
1783 #define EC_SEG_CAT 0x01
1784 uint8_t descr_length[2];
1788 struct scsi_ec_segment_b2b
1791 #define EC_SEG_B2B 0x02
1793 uint8_t descr_length[2];
1794 uint8_t src_cscd[2];
1795 uint8_t dst_cscd[2];
1796 uint8_t reserved[2];
1797 uint8_t number_of_blocks[2];
1802 struct scsi_ec_segment_verify
1805 #define EC_SEG_VERIFY 0x07
1807 uint8_t descr_length[2];
1808 uint8_t src_cscd[2];
1809 uint8_t reserved2[2];
1811 uint8_t reserved3[3];
1814 struct scsi_ec_segment_register_key
1817 #define EC_SEG_REGISTER_KEY 0x14
1819 uint8_t descr_length[2];
1820 uint8_t reserved2[2];
1821 uint8_t dst_cscd[2];
1823 uint8_t sa_res_key[8];
1824 uint8_t reserved3[4];
1827 struct scsi_extended_copy_lid1_data
1829 uint8_t list_identifier;
1831 #define EC_PRIORITY 0x07
1832 #define EC_LIST_ID_USAGE_MASK 0x18
1833 #define EC_LIST_ID_USAGE_FULL 0x08
1834 #define EC_LIST_ID_USAGE_NOHOLD 0x10
1835 #define EC_LIST_ID_USAGE_NONE 0x18
1837 uint8_t cscd_list_length[2];
1838 uint8_t reserved[4];
1839 uint8_t segment_list_length[4];
1840 uint8_t inline_data_length[4];
1844 struct scsi_extended_copy_lid4_data
1846 uint8_t list_format;
1847 #define EC_LIST_FORMAT 0x01
1849 uint8_t header_cscd_list_length[2];
1850 uint8_t reserved[11];
1852 #define EC_IMMED 0x01
1853 #define EC_G_SENSE 0x02
1854 uint8_t header_cscd_type_code;
1855 uint8_t reserved2[3];
1856 uint8_t list_identifier[4];
1857 uint8_t reserved3[18];
1858 uint8_t cscd_list_length[2];
1859 uint8_t segment_list_length[2];
1860 uint8_t inline_data_length[2];
1864 struct scsi_copy_operation_abort
1867 uint8_t service_action;
1869 uint8_t list_identifier[4];
1870 uint8_t reserved[9];
1874 struct scsi_populate_token
1877 uint8_t service_action;
1879 uint8_t reserved[4];
1880 uint8_t list_identifier[4];
1882 uint8_t group_number;
1886 struct scsi_range_desc
1890 uint8_t reserved[4];
1893 struct scsi_populate_token_data
1897 #define EC_PT_IMMED 0x01
1898 #define EC_PT_RTV 0x02
1900 uint8_t inactivity_timeout[4];
1901 uint8_t rod_type[4];
1902 uint8_t reserved2[2];
1903 uint8_t range_descriptor_length[2];
1904 struct scsi_range_desc desc[];
1907 struct scsi_write_using_token
1910 uint8_t service_action;
1912 uint8_t reserved[4];
1913 uint8_t list_identifier[4];
1915 uint8_t group_number;
1919 struct scsi_write_using_token_data
1923 #define EC_WUT_IMMED 0x01
1924 #define EC_WUT_DEL_TKN 0x02
1925 uint8_t reserved[5];
1926 uint8_t offset_into_rod[8];
1927 uint8_t rod_token[512];
1928 uint8_t reserved2[6];
1929 uint8_t range_descriptor_length[2];
1930 struct scsi_range_desc desc[];
1933 struct scsi_receive_rod_token_information
1936 uint8_t service_action;
1937 #define RCS_RRTI 0x07
1938 uint8_t list_identifier[4];
1939 uint8_t reserved[4];
1948 #define ROD_TYPE_INTERNAL 0x00000000
1949 #define ROD_TYPE_AUR 0x00010000
1950 #define ROD_TYPE_PIT_DEF 0x00800000
1951 #define ROD_TYPE_PIT_VULN 0x00800001
1952 #define ROD_TYPE_PIT_PERS 0x00800002
1953 #define ROD_TYPE_PIT_ANY 0x0080FFFF
1954 #define ROD_TYPE_BLOCK_ZERO 0xFFFF0001
1955 uint8_t reserved[2];
1960 struct scsi_report_all_rod_tokens
1963 uint8_t service_action;
1964 #define RCS_RART 0x08
1965 uint8_t reserved[8];
1971 struct scsi_report_all_rod_tokens_data
1973 uint8_t available_data[4];
1974 uint8_t reserved[4];
1975 uint8_t rod_management_token_list[];
1978 struct ata_pass_16 {
1981 #define AP_EXTEND 0x01
1983 #define AP_FLAG_TLEN_NO_DATA (0 << 0)
1984 #define AP_FLAG_TLEN_FEAT (1 << 0)
1985 #define AP_FLAG_TLEN_SECT_CNT (2 << 0)
1986 #define AP_FLAG_TLEN_STPSIU (3 << 0)
1987 #define AP_FLAG_BYT_BLOK_BYTES (0 << 2)
1988 #define AP_FLAG_BYT_BLOK_BLOCKS (1 << 2)
1989 #define AP_FLAG_TDIR_TO_DEV (0 << 3)
1990 #define AP_FLAG_TDIR_FROM_DEV (1 << 3)
1991 #define AP_FLAG_CHK_COND (1 << 5)
1992 u_int8_t features_ext;
1994 u_int8_t sector_count_ext;
1995 u_int8_t sector_count;
1996 u_int8_t lba_low_ext;
1998 u_int8_t lba_mid_ext;
2000 u_int8_t lba_high_ext;
2007 struct ata_pass_32 {
2010 uint8_t reserved1[5];
2012 uint8_t service_action[2];
2013 #define ATA_PASS_32_SA 0x1ff0
2016 uint8_t reserved2[2];
2018 uint8_t features[2];
2024 uint8_t auxiliary[4];
2028 #define SC_SCSI_1 0x01
2029 #define SC_SCSI_2 0x03
2035 #define TEST_UNIT_READY 0x00
2036 #define REQUEST_SENSE 0x03
2038 #define WRITE_6 0x0A
2039 #define INQUIRY 0x12
2040 #define MODE_SELECT_6 0x15
2041 #define MODE_SENSE_6 0x1A
2042 #define START_STOP_UNIT 0x1B
2043 #define START_STOP 0x1B
2044 #define RESERVE 0x16
2045 #define RELEASE 0x17
2046 #define RECEIVE_DIAGNOSTIC 0x1C
2047 #define SEND_DIAGNOSTIC 0x1D
2048 #define PREVENT_ALLOW 0x1E
2049 #define READ_CAPACITY 0x25
2050 #define READ_10 0x28
2051 #define WRITE_10 0x2A
2052 #define POSITION_TO_ELEMENT 0x2B
2053 #define WRITE_VERIFY_10 0x2E
2054 #define VERIFY_10 0x2F
2055 #define SYNCHRONIZE_CACHE 0x35
2056 #define READ_DEFECT_DATA_10 0x37
2057 #define WRITE_BUFFER 0x3B
2058 #define READ_BUFFER 0x3C
2059 #define CHANGE_DEFINITION 0x40
2060 #define WRITE_SAME_10 0x41
2062 #define LOG_SELECT 0x4C
2063 #define LOG_SENSE 0x4D
2064 #define MODE_SELECT_10 0x55
2065 #define RESERVE_10 0x56
2066 #define RELEASE_10 0x57
2067 #define MODE_SENSE_10 0x5A
2068 #define PERSISTENT_RES_IN 0x5E
2069 #define PERSISTENT_RES_OUT 0x5F
2070 #define EXTENDED_CDB 0x7E
2071 #define VARIABLE_LEN_CDB 0x7F
2072 #define EXTENDED_COPY 0x83
2073 #define RECEIVE_COPY_STATUS 0x84
2074 #define ATA_PASS_16 0x85
2075 #define READ_16 0x88
2076 #define COMPARE_AND_WRITE 0x89
2077 #define WRITE_16 0x8A
2078 #define READ_ATTRIBUTE 0x8C
2079 #define WRITE_ATTRIBUTE 0x8D
2080 #define WRITE_VERIFY_16 0x8E
2081 #define VERIFY_16 0x8F
2082 #define SYNCHRONIZE_CACHE_16 0x91
2083 #define WRITE_SAME_16 0x93
2084 #define READ_BUFFER_16 0x9B
2085 #define WRITE_ATOMIC_16 0x9C
2086 #define SERVICE_ACTION_IN 0x9E
2087 #define REPORT_LUNS 0xA0
2088 #define ATA_PASS_12 0xA1
2089 #define SECURITY_PROTOCOL_IN 0xA2
2090 #define MAINTENANCE_IN 0xA3
2091 #define MAINTENANCE_OUT 0xA4
2092 #define MOVE_MEDIUM 0xA5
2093 #define READ_12 0xA8
2094 #define WRITE_12 0xAA
2095 #define WRITE_VERIFY_12 0xAE
2096 #define VERIFY_12 0xAF
2097 #define SECURITY_PROTOCOL_OUT 0xB5
2098 #define READ_ELEMENT_STATUS 0xB8
2099 #define READ_CD 0xBE
2101 /* Maintenance In Service Action Codes */
2102 #define REPORT_IDENTIFYING_INFRMATION 0x05
2103 #define REPORT_TARGET_PORT_GROUPS 0x0A
2104 #define REPORT_ALIASES 0x0B
2105 #define REPORT_SUPPORTED_OPERATION_CODES 0x0C
2106 #define REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS 0x0D
2107 #define REPORT_PRIORITY 0x0E
2108 #define REPORT_TIMESTAMP 0x0F
2109 #define MANAGEMENT_PROTOCOL_IN 0x10
2110 /* Maintenance Out Service Action Codes */
2111 #define SET_IDENTIFY_INFORMATION 0x06
2112 #define SET_TARGET_PORT_GROUPS 0x0A
2113 #define CHANGE_ALIASES 0x0B
2114 #define SET_PRIORITY 0x0E
2115 #define SET_TIMESTAMP 0x0F
2116 #define MANGAEMENT_PROTOCOL_OUT 0x10
2121 #define T_DIRECT 0x00
2122 #define T_SEQUENTIAL 0x01
2123 #define T_PRINTER 0x02
2124 #define T_PROCESSOR 0x03
2126 #define T_CDROM 0x05
2127 #define T_SCANNER 0x06
2128 #define T_OPTICAL 0x07
2129 #define T_CHANGER 0x08
2133 #define T_STORARRAY 0x0c
2134 #define T_ENCLOSURE 0x0d
2139 #define T_ZBC_HM 0x14
2140 #define T_NODEVICE 0x1f
2141 #define T_ANY 0xff /* Used in Quirk table matches */
2147 * This length is the initial inquiry length used by the probe code, as
2148 * well as the length necessary for scsi_print_inquiry() to function
2149 * correctly. If either use requires a different length in the future,
2150 * the two values should be de-coupled.
2152 #define SHORT_INQUIRY_LENGTH 36
2154 struct scsi_inquiry_data
2157 #define SID_TYPE(inq_data) ((inq_data)->device & 0x1f)
2158 #define SID_QUAL(inq_data) (((inq_data)->device & 0xE0) >> 5)
2159 #define SID_QUAL_LU_CONNECTED 0x00 /*
2160 * The specified peripheral device
2161 * type is currently connected to
2162 * logical unit. If the target cannot
2163 * determine whether or not a physical
2164 * device is currently connected, it
2165 * shall also use this peripheral
2166 * qualifier when returning the INQUIRY
2167 * data. This peripheral qualifier
2168 * does not mean that the device is
2169 * ready for access by the initiator.
2171 #define SID_QUAL_LU_OFFLINE 0x01 /*
2172 * The target is capable of supporting
2173 * the specified peripheral device type
2174 * on this logical unit; however, the
2175 * physical device is not currently
2176 * connected to this logical unit.
2178 #define SID_QUAL_RSVD 0x02
2179 #define SID_QUAL_BAD_LU 0x03 /*
2180 * The target is not capable of
2181 * supporting a physical device on
2182 * this logical unit. For this
2183 * peripheral qualifier the peripheral
2184 * device type shall be set to 1Fh to
2185 * provide compatibility with previous
2186 * versions of SCSI. All other
2187 * peripheral device type values are
2188 * reserved for this peripheral
2191 #define SID_QUAL_IS_VENDOR_UNIQUE(inq_data) ((SID_QUAL(inq_data) & 0x04) != 0)
2193 #define SID_QUAL2 0x7F
2194 #define SID_LU_CONG 0x40
2195 #define SID_RMB 0x80
2196 #define SID_IS_REMOVABLE(inq_data) (((inq_data)->dev_qual2 & SID_RMB) != 0)
2198 #define SID_ANSI_REV(inq_data) ((inq_data)->version & 0x07)
2199 #define SCSI_REV_0 0
2200 #define SCSI_REV_CCS 1
2201 #define SCSI_REV_2 2
2202 #define SCSI_REV_SPC 3
2203 #define SCSI_REV_SPC2 4
2204 #define SCSI_REV_SPC3 5
2205 #define SCSI_REV_SPC4 6
2206 #define SCSI_REV_SPC5 7
2208 #define SID_ECMA 0x38
2209 #define SID_ISO 0xC0
2210 u_int8_t response_format;
2211 #define SID_AENC 0x80
2212 #define SID_TrmIOP 0x40
2213 #define SID_NormACA 0x20
2214 #define SID_HiSup 0x10
2215 u_int8_t additional_length;
2216 #define SID_ADDITIONAL_LENGTH(iqd) \
2217 ((iqd)->additional_length + \
2218 __offsetof(struct scsi_inquiry_data, additional_length) + 1)
2219 u_int8_t spc3_flags;
2220 #define SPC3_SID_PROTECT 0x01
2221 #define SPC3_SID_3PC 0x08
2222 #define SPC3_SID_TPGS_MASK 0x30
2223 #define SPC3_SID_TPGS_IMPLICIT 0x10
2224 #define SPC3_SID_TPGS_EXPLICIT 0x20
2225 #define SPC3_SID_ACC 0x40
2226 #define SPC3_SID_SCCS 0x80
2227 u_int8_t spc2_flags;
2228 #define SPC2_SID_ADDR16 0x01
2229 #define SPC2_SID_MChngr 0x08
2230 #define SPC2_SID_MultiP 0x10
2231 #define SPC2_SID_EncServ 0x40
2232 #define SPC2_SID_BQueue 0x80
2234 #define INQ_DATA_TQ_ENABLED(iqd) \
2235 ((SID_ANSI_REV(iqd) < SCSI_REV_SPC2)? ((iqd)->flags & SID_CmdQue) : \
2236 (((iqd)->flags & SID_CmdQue) && !((iqd)->spc2_flags & SPC2_SID_BQueue)) || \
2237 (!((iqd)->flags & SID_CmdQue) && ((iqd)->spc2_flags & SPC2_SID_BQueue)))
2240 #define SID_SftRe 0x01
2241 #define SID_CmdQue 0x02
2242 #define SID_Linked 0x08
2243 #define SID_Sync 0x10
2244 #define SID_WBus16 0x20
2245 #define SID_WBus32 0x40
2246 #define SID_RelAdr 0x80
2247 #define SID_VENDOR_SIZE 8
2248 char vendor[SID_VENDOR_SIZE];
2249 #define SID_PRODUCT_SIZE 16
2250 char product[SID_PRODUCT_SIZE];
2251 #define SID_REVISION_SIZE 4
2252 char revision[SID_REVISION_SIZE];
2254 * The following fields were taken from SCSI Primary Commands - 2
2255 * (SPC-2) Revision 14, Dated 11 November 1999
2257 #define SID_VENDOR_SPECIFIC_0_SIZE 20
2258 u_int8_t vendor_specific0[SID_VENDOR_SPECIFIC_0_SIZE];
2260 * An extension of SCSI Parallel Specific Values
2262 #define SID_SPI_IUS 0x01
2263 #define SID_SPI_QAS 0x02
2264 #define SID_SPI_CLOCK_ST 0x00
2265 #define SID_SPI_CLOCK_DT 0x04
2266 #define SID_SPI_CLOCK_DT_ST 0x0C
2267 #define SID_SPI_MASK 0x0F
2271 * Version Descriptors, stored 2 byte values.
2273 u_int8_t version1[2];
2274 u_int8_t version2[2];
2275 u_int8_t version3[2];
2276 u_int8_t version4[2];
2277 u_int8_t version5[2];
2278 u_int8_t version6[2];
2279 u_int8_t version7[2];
2280 u_int8_t version8[2];
2282 u_int8_t reserved3[22];
2284 #define SID_VENDOR_SPECIFIC_1_SIZE 160
2285 u_int8_t vendor_specific1[SID_VENDOR_SPECIFIC_1_SIZE];
2289 * This structure is more suited to initiator operation, because the
2290 * maximum number of supported pages is already allocated.
2292 struct scsi_vpd_supported_page_list
2296 #define SVPD_SUPPORTED_PAGE_LIST 0x00
2297 #define SVPD_SUPPORTED_PAGES_HDR_LEN 4
2299 u_int8_t length; /* number of VPD entries */
2300 #define SVPD_SUPPORTED_PAGES_SIZE 251
2301 u_int8_t list[SVPD_SUPPORTED_PAGES_SIZE];
2305 * This structure is more suited to target operation, because the
2306 * number of supported pages is left to the user to allocate.
2308 struct scsi_vpd_supported_pages
2313 #define SVPD_SUPPORTED_PAGES 0x00
2315 u_int8_t page_list[0];
2319 struct scsi_vpd_unit_serial_number
2323 #define SVPD_UNIT_SERIAL_NUMBER 0x80
2325 u_int8_t length; /* serial number length */
2326 #define SVPD_SERIAL_NUM_SIZE 251
2327 u_int8_t serial_num[SVPD_SERIAL_NUM_SIZE];
2330 struct scsi_vpd_device_id
2334 #define SVPD_DEVICE_ID 0x83
2335 #define SVPD_DEVICE_ID_MAX_SIZE 252
2336 #define SVPD_DEVICE_ID_HDR_LEN \
2337 __offsetof(struct scsi_vpd_device_id, desc_list)
2339 u_int8_t desc_list[];
2342 struct scsi_vpd_id_descriptor
2344 u_int8_t proto_codeset;
2346 * See the SCSI_PROTO definitions above for the protocols.
2348 #define SVPD_ID_PROTO_SHIFT 4
2349 #define SVPD_ID_CODESET_BINARY 0x01
2350 #define SVPD_ID_CODESET_ASCII 0x02
2351 #define SVPD_ID_CODESET_UTF8 0x03
2352 #define SVPD_ID_CODESET_MASK 0x0f
2354 #define SVPD_ID_PIV 0x80
2355 #define SVPD_ID_ASSOC_LUN 0x00
2356 #define SVPD_ID_ASSOC_PORT 0x10
2357 #define SVPD_ID_ASSOC_TARGET 0x20
2358 #define SVPD_ID_ASSOC_MASK 0x30
2359 #define SVPD_ID_TYPE_VENDOR 0x00
2360 #define SVPD_ID_TYPE_T10 0x01
2361 #define SVPD_ID_TYPE_EUI64 0x02
2362 #define SVPD_ID_TYPE_NAA 0x03
2363 #define SVPD_ID_TYPE_RELTARG 0x04
2364 #define SVPD_ID_TYPE_TPORTGRP 0x05
2365 #define SVPD_ID_TYPE_LUNGRP 0x06
2366 #define SVPD_ID_TYPE_MD5_LUN_ID 0x07
2367 #define SVPD_ID_TYPE_SCSI_NAME 0x08
2368 #define SVPD_ID_TYPE_PROTO 0x09
2369 #define SVPD_ID_TYPE_UUID 0x0a
2370 #define SVPD_ID_TYPE_MASK 0x0f
2373 #define SVPD_DEVICE_ID_DESC_HDR_LEN \
2374 __offsetof(struct scsi_vpd_id_descriptor, identifier)
2375 u_int8_t identifier[];
2378 struct scsi_vpd_id_t10
2381 u_int8_t vendor_spec_id[0];
2384 struct scsi_vpd_id_eui64
2386 u_int8_t ieee_company_id[3];
2387 u_int8_t extension_id[5];
2390 struct scsi_vpd_id_naa_basic
2393 /* big endian, packed:
2395 uint8_t naa_desig : 4;
2397 #define SVPD_ID_NAA_NAA_SHIFT 4
2398 #define SVPD_ID_NAA_IEEE_EXT 0x02
2399 #define SVPD_ID_NAA_LOCAL_REG 0x03
2400 #define SVPD_ID_NAA_IEEE_REG 0x05
2401 #define SVPD_ID_NAA_IEEE_REG_EXT 0x06
2405 struct scsi_vpd_id_naa_ieee_extended_id
2408 uint8_t vendor_specific_id_a;
2409 uint8_t ieee_company_id[3];
2410 uint8_t vendor_specific_id_b[4];
2413 struct scsi_vpd_id_naa_local_reg
2416 uint8_t local_value[7];
2419 struct scsi_vpd_id_naa_ieee_reg
2422 uint8_t reg_value[7];
2423 /* big endian, packed:
2424 uint8_t naa_basic : 4;
2425 uint8_t ieee_company_id_0 : 4;
2426 uint8_t ieee_company_id_1[2];
2427 uint8_t ieee_company_id_2 : 4;
2428 uint8_t vendor_specific_id_0 : 4;
2429 uint8_t vendor_specific_id_1[4];
2433 struct scsi_vpd_id_naa_ieee_reg_extended
2436 uint8_t reg_value[15];
2437 /* big endian, packed:
2438 uint8_t naa_basic : 4;
2439 uint8_t ieee_company_id_0 : 4;
2440 uint8_t ieee_company_id_1[2];
2441 uint8_t ieee_company_id_2 : 4;
2442 uint8_t vendor_specific_id_0 : 4;
2443 uint8_t vendor_specific_id_1[4];
2444 uint8_t vendor_specific_id_ext[8];
2448 struct scsi_vpd_id_rel_trgt_port_id
2450 uint8_t obsolete[2];
2451 uint8_t rel_trgt_port_id[2];
2454 struct scsi_vpd_id_trgt_port_grp_id
2456 uint8_t reserved[2];
2457 uint8_t trgt_port_grp[2];
2460 struct scsi_vpd_id_lun_grp_id
2462 uint8_t reserved[2];
2463 uint8_t log_unit_grp[2];
2466 struct scsi_vpd_id_md5_lun_id
2471 struct scsi_vpd_id_scsi_name
2473 uint8_t name_string[256];
2476 struct scsi_service_action_in
2479 uint8_t service_action;
2480 uint8_t action_dependent[13];
2484 struct scsi_vpd_extended_inquiry_data
2488 #define SVPD_EXTENDED_INQUIRY_DATA 0x86
2489 uint8_t page_length[2];
2492 /* These values are for direct access devices */
2493 #define SVPD_EID_AM_MASK 0xC0
2494 #define SVPD_EID_AM_DEFER 0x80
2495 #define SVPD_EID_AM_IMMED 0x40
2496 #define SVPD_EID_AM_UNDEFINED 0x00
2497 #define SVPD_EID_AM_RESERVED 0xc0
2498 #define SVPD_EID_SPT 0x38
2499 #define SVPD_EID_SPT_1 0x00
2500 #define SVPD_EID_SPT_12 0x08
2501 #define SVPD_EID_SPT_2 0x10
2502 #define SVPD_EID_SPT_13 0x18
2503 #define SVPD_EID_SPT_3 0x20
2504 #define SVPD_EID_SPT_23 0x28
2505 #define SVPD_EID_SPT_123 0x38
2507 /* These values are for sequential access devices */
2508 #define SVPD_EID_SA_SPT_LBP 0x08
2510 #define SVPD_EID_GRD_CHK 0x04
2511 #define SVPD_EID_APP_CHK 0x02
2512 #define SVPD_EID_REF_CHK 0x01
2515 #define SVPD_EID_UASK_SUP 0x20
2516 #define SVPD_EID_GROUP_SUP 0x10
2517 #define SVPD_EID_PRIOR_SUP 0x08
2518 #define SVPD_EID_HEADSUP 0x04
2519 #define SVPD_EID_ORDSUP 0x02
2520 #define SVPD_EID_SIMPSUP 0x01
2522 #define SVPD_EID_WU_SUP 0x08
2523 #define SVPD_EID_CRD_SUP 0x04
2524 #define SVPD_EID_NV_SUP 0x02
2525 #define SVPD_EID_V_SUP 0x01
2527 #define SVPD_EID_NO_PI_CHK 0x20
2528 #define SVPD_EID_P_I_I_SUP 0x10
2529 #define SVPD_EID_LUICLR 0x01
2531 #define SVPD_EID_LUCT_MASK 0xe0
2532 #define SVPD_EID_LUCT_NOT_REP 0x00
2533 #define SVPD_EID_LUCT_CONGL 0x20
2534 #define SVPD_EID_LUCT_GROUP 0x40
2535 #define SVPD_EID_R_SUP 0x10
2536 #define SVPD_EID_RTD_SUP 0x08
2537 #define SVPD_EID_HSSRELEF 0x02
2538 #define SVPD_EID_CBCS 0x01
2540 #define SVPD_EID_MULTI_I_T_FW 0x0F
2541 #define SVPD_EID_MC_VENDOR_SPEC 0x00
2542 #define SVPD_EID_MC_MODE_1 0x01
2543 #define SVPD_EID_MC_MODE_2 0x02
2544 #define SVPD_EID_MC_MODE_3 0x03
2547 #define SVPD_EID_POA_SUP 0x80
2548 #define SVPD_EID_HRA_SUP 0x40
2549 #define SVPD_EID_VSA_SUP 0x20
2550 uint8_t max_sense_length;
2552 #define SVPD_EID_IBS 0x80
2553 #define SVPD_EID_IAS 0x40
2554 #define SVPD_EID_SAC 0x04
2555 #define SVPD_EID_NRD1 0x02
2556 #define SVPD_EID_NRD0 0x01
2557 uint8_t reserved2[49];
2560 struct scsi_vpd_mode_page_policy_descr
2563 uint8_t subpage_code;
2565 #define SVPD_MPP_SHARED 0x00
2566 #define SVPD_MPP_PORT 0x01
2567 #define SVPD_MPP_I_T 0x03
2568 #define SVPD_MPP_MLUS 0x80
2572 struct scsi_vpd_mode_page_policy
2576 #define SVPD_MODE_PAGE_POLICY 0x87
2577 uint8_t page_length[2];
2578 struct scsi_vpd_mode_page_policy_descr descr[0];
2581 struct scsi_diag_page {
2583 uint8_t page_specific_flags;
2588 struct scsi_vpd_port_designation
2590 uint8_t reserved[2];
2591 uint8_t relative_port_id[2];
2592 uint8_t reserved2[2];
2593 uint8_t initiator_transportid_length[2];
2594 uint8_t initiator_transportid[0];
2597 struct scsi_vpd_port_designation_cont
2599 uint8_t reserved[2];
2600 uint8_t target_port_descriptors_length[2];
2601 struct scsi_vpd_id_descriptor target_port_descriptors[0];
2604 struct scsi_vpd_scsi_ports
2608 #define SVPD_SCSI_PORTS 0x88
2609 u_int8_t page_length[2];
2610 struct scsi_vpd_port_designation design[];
2614 * ATA Information VPD Page based on
2615 * T10/2126-D Revision 04
2617 #define SVPD_ATA_INFORMATION 0x89
2620 struct scsi_vpd_tpc_descriptor
2622 uint8_t desc_type[2];
2623 uint8_t desc_length[2];
2624 uint8_t parameters[];
2627 struct scsi_vpd_tpc_descriptor_bdrl
2629 uint8_t desc_type[2];
2630 #define SVPD_TPC_BDRL 0x0000
2631 uint8_t desc_length[2];
2632 uint8_t vendor_specific[6];
2633 uint8_t maximum_ranges[2];
2634 uint8_t maximum_inactivity_timeout[4];
2635 uint8_t default_inactivity_timeout[4];
2636 uint8_t maximum_token_transfer_size[8];
2637 uint8_t optimal_transfer_count[8];
2640 struct scsi_vpd_tpc_descriptor_sc_descr
2644 uint8_t supported_service_actions[0];
2647 struct scsi_vpd_tpc_descriptor_sc
2649 uint8_t desc_type[2];
2650 #define SVPD_TPC_SC 0x0001
2651 uint8_t desc_length[2];
2652 uint8_t list_length;
2653 struct scsi_vpd_tpc_descriptor_sc_descr descr[];
2656 struct scsi_vpd_tpc_descriptor_pd
2658 uint8_t desc_type[2];
2659 #define SVPD_TPC_PD 0x0004
2660 uint8_t desc_length[2];
2661 uint8_t reserved[4];
2662 uint8_t maximum_cscd_descriptor_count[2];
2663 uint8_t maximum_segment_descriptor_count[2];
2664 uint8_t maximum_descriptor_list_length[4];
2665 uint8_t maximum_inline_data_length[4];
2666 uint8_t reserved2[12];
2669 struct scsi_vpd_tpc_descriptor_sd
2671 uint8_t desc_type[2];
2672 #define SVPD_TPC_SD 0x0008
2673 uint8_t desc_length[2];
2674 uint8_t list_length;
2675 uint8_t supported_descriptor_codes[];
2678 struct scsi_vpd_tpc_descriptor_sdid
2680 uint8_t desc_type[2];
2681 #define SVPD_TPC_SDID 0x000C
2682 uint8_t desc_length[2];
2683 uint8_t list_length[2];
2684 uint8_t supported_descriptor_ids[];
2687 struct scsi_vpd_tpc_descriptor_rtf_block
2689 uint8_t type_format;
2690 #define SVPD_TPC_RTF_BLOCK 0x00
2692 uint8_t desc_length[2];
2693 uint8_t reserved2[2];
2694 uint8_t optimal_length_granularity[2];
2695 uint8_t maximum_bytes[8];
2696 uint8_t optimal_bytes[8];
2697 uint8_t optimal_bytes_to_token_per_segment[8];
2698 uint8_t optimal_bytes_from_token_per_segment[8];
2699 uint8_t reserved3[8];
2702 struct scsi_vpd_tpc_descriptor_rtf
2704 uint8_t desc_type[2];
2705 #define SVPD_TPC_RTF 0x0106
2706 uint8_t desc_length[2];
2707 uint8_t remote_tokens;
2708 uint8_t reserved[11];
2709 uint8_t minimum_token_lifetime[4];
2710 uint8_t maximum_token_lifetime[4];
2711 uint8_t maximum_token_inactivity_timeout[4];
2712 uint8_t reserved2[18];
2713 uint8_t type_specific_features_length[2];
2714 uint8_t type_specific_features[0];
2717 struct scsi_vpd_tpc_descriptor_srtd
2719 uint8_t rod_type[4];
2721 #define SVPD_TPC_SRTD_TOUT 0x01
2722 #define SVPD_TPC_SRTD_TIN 0x02
2723 #define SVPD_TPC_SRTD_ECPY 0x80
2725 uint8_t preference_indicator[2];
2726 uint8_t reserved2[56];
2729 struct scsi_vpd_tpc_descriptor_srt
2731 uint8_t desc_type[2];
2732 #define SVPD_TPC_SRT 0x0108
2733 uint8_t desc_length[2];
2734 uint8_t reserved[2];
2735 uint8_t rod_type_descriptors_length[2];
2736 uint8_t rod_type_descriptors[0];
2739 struct scsi_vpd_tpc_descriptor_gco
2741 uint8_t desc_type[2];
2742 #define SVPD_TPC_GCO 0x8001
2743 uint8_t desc_length[2];
2744 uint8_t total_concurrent_copies[4];
2745 uint8_t maximum_identified_concurrent_copies[4];
2746 uint8_t maximum_segment_length[4];
2747 uint8_t data_segment_granularity;
2748 uint8_t inline_data_granularity;
2749 uint8_t reserved[18];
2756 #define SVPD_SCSI_TPC 0x8F
2757 uint8_t page_length[2];
2758 struct scsi_vpd_tpc_descriptor descr[];
2762 * Block Device Characteristics VPD Page based on
2763 * T10/1799-D Revision 31
2765 struct scsi_vpd_block_characteristics
2769 #define SVPD_BDC 0xB1
2770 u_int8_t page_length[2];
2771 u_int8_t medium_rotation_rate[2];
2772 #define SVPD_BDC_RATE_NOT_REPORTED 0x00
2773 #define SVPD_BDC_RATE_NON_ROTATING 0x01
2775 u_int8_t nominal_form_factor;
2776 #define SVPD_BDC_FORM_NOT_REPORTED 0x00
2777 #define SVPD_BDC_FORM_5_25INCH 0x01
2778 #define SVPD_BDC_FORM_3_5INCH 0x02
2779 #define SVPD_BDC_FORM_2_5INCH 0x03
2780 #define SVPD_BDC_FORM_1_5INCH 0x04
2781 #define SVPD_BDC_FORM_LESSTHAN_1_5INCH 0x05
2782 u_int8_t reserved2[56];
2786 * Block Device Characteristics VPD Page
2788 struct scsi_vpd_block_device_characteristics
2792 #define SVPD_BDC 0xB1
2793 uint8_t page_length[2];
2794 uint8_t medium_rotation_rate[2];
2795 #define SVPD_NOT_REPORTED 0x0000
2796 #define SVPD_NON_ROTATING 0x0001
2797 uint8_t product_type;
2800 #define SVPD_VBULS 0x01
2801 #define SVPD_FUAB 0x02
2802 #define SVPD_ZBC_NR 0x00 /* Not Reported */
2803 #define SVPD_HAW_ZBC 0x10 /* Host Aware */
2804 #define SVPD_DM_ZBC 0x20 /* Drive Managed */
2805 #define SVPD_ZBC_MASK 0x30 /* Zoned mask */
2806 uint8_t reserved[55];
2809 #define SBDC_IS_PRESENT(bdc, length, field) \
2810 ((length >= offsetof(struct scsi_vpd_block_device_characteristics, \
2811 field) + sizeof(bdc->field)) ? 1 : 0)
2814 * Logical Block Provisioning VPD Page based on
2815 * T10/1799-D Revision 31
2817 struct scsi_vpd_logical_block_prov
2821 #define SVPD_LBP 0xB2
2822 u_int8_t page_length[2];
2823 #define SVPD_LBP_PL_BASIC 0x04
2824 u_int8_t threshold_exponent;
2826 #define SVPD_LBP_UNMAP 0x80
2827 #define SVPD_LBP_WS16 0x40
2828 #define SVPD_LBP_WS10 0x20
2829 #define SVPD_LBP_RZ 0x04
2830 #define SVPD_LBP_ANC_SUP 0x02
2831 #define SVPD_LBP_DP 0x01
2833 #define SVPD_LBP_RESOURCE 0x01
2834 #define SVPD_LBP_THIN 0x02
2837 * Provisioning Group Descriptor can be here if SVPD_LBP_DP is set
2838 * Its size can be determined from page_length - 4
2843 * Block Limits VDP Page based on SBC-4 Revision 2
2845 struct scsi_vpd_block_limits
2849 #define SVPD_BLOCK_LIMITS 0xB0
2850 u_int8_t page_length[2];
2851 #define SVPD_BL_PL_BASIC 0x10
2852 #define SVPD_BL_PL_TP 0x3C
2854 u_int8_t max_cmp_write_len;
2855 u_int8_t opt_txfer_len_grain[2];
2856 u_int8_t max_txfer_len[4];
2857 u_int8_t opt_txfer_len[4];
2858 u_int8_t max_prefetch[4];
2859 u_int8_t max_unmap_lba_cnt[4];
2860 u_int8_t max_unmap_blk_cnt[4];
2861 u_int8_t opt_unmap_grain[4];
2862 u_int8_t unmap_grain_align[4];
2863 u_int8_t max_write_same_length[8];
2864 u_int8_t max_atomic_transfer_length[4];
2865 u_int8_t atomic_alignment[4];
2866 u_int8_t atomic_transfer_length_granularity[4];
2867 u_int8_t max_atomic_transfer_length_with_atomic_boundary[4];
2868 u_int8_t max_atomic_boundary_size[4];
2872 * Zoned Block Device Characacteristics VPD page.
2873 * From ZBC-r04, dated August 12, 2015.
2875 struct scsi_vpd_zoned_bdc {
2878 #define SVPD_ZONED_BDC 0xB6
2879 uint8_t page_length[2];
2880 #define SVPD_ZBDC_PL 0x3C
2882 #define SVPD_ZBDC_URSWRZ 0x01
2883 uint8_t reserved1[3];
2884 uint8_t optimal_seq_zones[4];
2885 #define SVPD_ZBDC_OPT_SEQ_NR 0xffffffff
2886 uint8_t optimal_nonseq_zones[4];
2887 #define SVPD_ZBDC_OPT_NONSEQ_NR 0xffffffff
2888 uint8_t max_seq_req_zones[4];
2889 #define SVPD_ZBDC_MAX_SEQ_UNLIMITED 0xffffffff
2890 uint8_t reserved2[44];
2893 struct scsi_read_capacity
2897 #define SRC_RELADR 0x01
2901 #define SRC_PMI 0x01
2905 struct scsi_read_capacity_16
2908 #define SRC16_SERVICE_ACTION 0x10
2909 uint8_t service_action;
2911 uint8_t alloc_len[4];
2912 #define SRC16_PMI 0x01
2913 #define SRC16_RELADR 0x02
2918 struct scsi_read_capacity_data
2924 struct scsi_read_capacity_data_long
2928 #define SRC16_PROT_EN 0x01
2929 #define SRC16_P_TYPE 0x0e
2930 #define SRC16_PTYPE_1 0x00
2931 #define SRC16_PTYPE_2 0x02
2932 #define SRC16_PTYPE_3 0x04
2934 #define SRC16_LBPPBE 0x0f
2935 #define SRC16_PI_EXPONENT 0xf0
2936 #define SRC16_PI_EXPONENT_SHIFT 4
2937 uint8_t prot_lbppbe;
2938 #define SRC16_LALBA 0x3f
2939 #define SRC16_LBPRZ 0x40
2940 #define SRC16_LBPME 0x80
2942 * Alternate versions of these macros that are intended for use on a 16-bit
2943 * version of the lalba_lbp field instead of the array of 2 8 bit numbers.
2945 #define SRC16_LALBA_A 0x3fff
2946 #define SRC16_LBPRZ_A 0x4000
2947 #define SRC16_LBPME_A 0x8000
2948 uint8_t lalba_lbp[2];
2949 uint8_t reserved[16];
2952 struct scsi_get_lba_status
2955 #define SGLS_SERVICE_ACTION 0x12
2956 uint8_t service_action;
2958 uint8_t alloc_len[4];
2963 struct scsi_get_lba_status_data_descr
2968 uint8_t reserved[3];
2971 struct scsi_get_lba_status_data
2974 uint8_t reserved[4];
2975 struct scsi_get_lba_status_data_descr descr[];
2978 struct scsi_report_luns
2982 #define RPL_REPORT_DEFAULT 0x00
2983 #define RPL_REPORT_WELLKNOWN 0x01
2984 #define RPL_REPORT_ALL 0x02
2985 #define RPL_REPORT_ADMIN 0x10
2986 #define RPL_REPORT_NONSUBSID 0x11
2987 #define RPL_REPORT_CONGLOM 0x12
2988 uint8_t select_report;
2989 uint8_t reserved2[3];
2995 struct scsi_report_luns_lundata {
2997 #define RPL_LUNDATA_PERIPH_BUS_MASK 0x3f
2998 #define RPL_LUNDATA_FLAT_LUN_MASK 0x3f
2999 #define RPL_LUNDATA_FLAT_LUN_BITS 0x06
3000 #define RPL_LUNDATA_LUN_TARG_MASK 0x3f
3001 #define RPL_LUNDATA_LUN_BUS_MASK 0xe0
3002 #define RPL_LUNDATA_LUN_LUN_MASK 0x1f
3003 #define RPL_LUNDATA_EXT_LEN_MASK 0x30
3004 #define RPL_LUNDATA_EXT_EAM_MASK 0x0f
3005 #define RPL_LUNDATA_EXT_EAM_WK 0x01
3006 #define RPL_LUNDATA_EXT_EAM_NOT_SPEC 0x0f
3007 #define RPL_LUNDATA_ATYP_MASK 0xc0 /* MBZ for type 0 lun */
3008 #define RPL_LUNDATA_ATYP_PERIPH 0x00
3009 #define RPL_LUNDATA_ATYP_FLAT 0x40
3010 #define RPL_LUNDATA_ATYP_LUN 0x80
3011 #define RPL_LUNDATA_ATYP_EXTLUN 0xc0
3014 struct scsi_report_luns_data {
3015 u_int8_t length[4]; /* length of LUN inventory, in bytes */
3016 u_int8_t reserved[4]; /* unused */
3018 * LUN inventory- we only support the type zero form for now.
3020 struct scsi_report_luns_lundata luns[0];
3023 struct scsi_target_group
3026 uint8_t service_action;
3027 #define STG_PDF_MASK 0xe0
3028 #define STG_PDF_LENGTH 0x00
3029 #define STG_PDF_EXTENDED 0x20
3030 uint8_t reserved1[4];
3036 struct scsi_timestamp
3039 uint8_t service_action;
3040 uint8_t reserved1[4];
3046 struct scsi_set_timestamp_parameters
3048 uint8_t reserved1[4];
3049 uint8_t timestamp[6];
3050 uint8_t reserved2[2];
3053 struct scsi_report_timestamp_parameter_data
3056 uint8_t reserved1[2];
3057 uint8_t timestamp[6];
3058 uint8_t reserved2[2];
3061 struct scsi_target_port_descriptor {
3062 uint8_t reserved[2];
3063 uint8_t relative_target_port_identifier[2];
3064 uint8_t desc_list[];
3067 struct scsi_target_port_group_descriptor {
3069 #define TPG_PRIMARY 0x80
3070 #define TPG_ASYMMETRIC_ACCESS_STATE_MASK 0xf
3071 #define TPG_ASYMMETRIC_ACCESS_OPTIMIZED 0x0
3072 #define TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED 0x1
3073 #define TPG_ASYMMETRIC_ACCESS_STANDBY 0x2
3074 #define TPG_ASYMMETRIC_ACCESS_UNAVAILABLE 0x3
3075 #define TPG_ASYMMETRIC_ACCESS_LBA_DEPENDENT 0x4
3076 #define TPG_ASYMMETRIC_ACCESS_OFFLINE 0xE
3077 #define TPG_ASYMMETRIC_ACCESS_TRANSITIONING 0xF
3079 #define TPG_AO_SUP 0x01
3080 #define TPG_AN_SUP 0x02
3081 #define TPG_S_SUP 0x04
3082 #define TPG_U_SUP 0x08
3083 #define TPG_LBD_SUP 0x10
3084 #define TPG_O_SUP 0x40
3085 #define TPG_T_SUP 0x80
3086 uint8_t target_port_group[2];
3089 #define TPG_UNAVLBL 0
3090 #define TPG_SET_BY_STPG 0x01
3091 #define TPG_IMPLICIT 0x02
3092 uint8_t vendor_specific;
3093 uint8_t target_port_count;
3094 struct scsi_target_port_descriptor descriptors[];
3097 struct scsi_target_group_data {
3098 uint8_t length[4]; /* length of returned data, in bytes */
3099 struct scsi_target_port_group_descriptor groups[];
3102 struct scsi_target_group_data_extended {
3103 uint8_t length[4]; /* length of returned data, in bytes */
3104 uint8_t format_type; /* STG_PDF_LENGTH or STG_PDF_EXTENDED */
3105 uint8_t implicit_transition_time;
3106 uint8_t reserved[2];
3107 struct scsi_target_port_group_descriptor groups[];
3110 struct scsi_security_protocol_in
3113 uint8_t security_protocol;
3114 #define SPI_PROT_INFORMATION 0x00
3115 #define SPI_PROT_CBCS 0x07
3116 #define SPI_PROT_TAPE_DATA_ENC 0x20
3117 #define SPI_PROT_DATA_ENC_CONFIG 0x21
3118 #define SPI_PROT_SA_CREATE_CAP 0x40
3119 #define SPI_PROT_IKEV2_SCSI 0x41
3120 #define SPI_PROT_JEDEC_UFS 0xEC
3121 #define SPI_PROT_SDCARD_TFSSS 0xED
3122 #define SPI_PROT_AUTH_HOST_TRANSIENT 0xEE
3123 #define SPI_PROT_ATA_DEVICE_PASSWORD 0xEF
3124 uint8_t security_protocol_specific[2];
3126 #define SPI_INC_512 0x80
3133 struct scsi_security_protocol_out
3136 uint8_t security_protocol;
3137 uint8_t security_protocol_specific[2];
3139 #define SPO_INC_512 0x80
3150 } scsi_sense_data_type;
3162 } scsi_sense_elem_type;
3165 struct scsi_sense_data
3169 * SPC-4 says that the maximum length of sense data is 252 bytes.
3170 * So this structure is exactly 252 bytes log.
3172 #define SSD_FULL_SIZE 252
3173 uint8_t sense_buf[SSD_FULL_SIZE - 1];
3175 * XXX KDM is this still a reasonable minimum size?
3177 #define SSD_MIN_SIZE 18
3179 * Maximum value for the extra_len field in the sense data.
3181 #define SSD_EXTRA_MAX 244
3185 * Fixed format sense data.
3187 struct scsi_sense_data_fixed
3189 u_int8_t error_code;
3190 #define SSD_ERRCODE 0x7F
3191 #define SSD_CURRENT_ERROR 0x70
3192 #define SSD_DEFERRED_ERROR 0x71
3193 #define SSD_ERRCODE_VALID 0x80
3196 #define SSD_KEY 0x0F
3197 #define SSD_KEY_NO_SENSE 0x00
3198 #define SSD_KEY_RECOVERED_ERROR 0x01
3199 #define SSD_KEY_NOT_READY 0x02
3200 #define SSD_KEY_MEDIUM_ERROR 0x03
3201 #define SSD_KEY_HARDWARE_ERROR 0x04
3202 #define SSD_KEY_ILLEGAL_REQUEST 0x05
3203 #define SSD_KEY_UNIT_ATTENTION 0x06
3204 #define SSD_KEY_DATA_PROTECT 0x07
3205 #define SSD_KEY_BLANK_CHECK 0x08
3206 #define SSD_KEY_Vendor_Specific 0x09
3207 #define SSD_KEY_COPY_ABORTED 0x0a
3208 #define SSD_KEY_ABORTED_COMMAND 0x0b
3209 #define SSD_KEY_EQUAL 0x0c
3210 #define SSD_KEY_VOLUME_OVERFLOW 0x0d
3211 #define SSD_KEY_MISCOMPARE 0x0e
3212 #define SSD_KEY_COMPLETED 0x0f
3213 #define SSD_SDAT_OVFL 0x10
3214 #define SSD_ILI 0x20
3215 #define SSD_EOM 0x40
3216 #define SSD_FILEMARK 0x80
3219 u_int8_t cmd_spec_info[4];
3220 u_int8_t add_sense_code;
3221 u_int8_t add_sense_code_qual;
3223 u_int8_t sense_key_spec[3];
3224 #define SSD_SCS_VALID 0x80
3225 #define SSD_FIELDPTR_CMD 0x40
3226 #define SSD_BITPTR_VALID 0x08
3227 #define SSD_BITPTR_VALUE 0x07
3228 u_int8_t extra_bytes[14];
3229 #define SSD_FIXED_IS_PRESENT(sense, length, field) \
3230 ((length >= (offsetof(struct scsi_sense_data_fixed, field) + \
3231 sizeof(sense->field))) ? 1 :0)
3232 #define SSD_FIXED_IS_FILLED(sense, field) \
3233 ((((offsetof(struct scsi_sense_data_fixed, field) + \
3234 sizeof(sense->field)) - \
3235 (offsetof(struct scsi_sense_data_fixed, extra_len) + \
3236 sizeof(sense->extra_len))) <= sense->extra_len) ? 1 : 0)
3240 * Descriptor format sense data definitions.
3241 * Introduced in SPC-3.
3243 struct scsi_sense_data_desc
3246 #define SSD_DESC_CURRENT_ERROR 0x72
3247 #define SSD_DESC_DEFERRED_ERROR 0x73
3249 uint8_t add_sense_code;
3250 uint8_t add_sense_code_qual;
3252 #define SSDD_SDAT_OVFL 0x80
3253 uint8_t reserved[2];
3255 * Note that SPC-4, section 4.5.2.1 says that the extra_len field
3256 * must be less than or equal to 244.
3259 uint8_t sense_desc[0];
3260 #define SSD_DESC_IS_PRESENT(sense, length, field) \
3261 ((length >= (offsetof(struct scsi_sense_data_desc, field) + \
3262 sizeof(sense->field))) ? 1 :0)
3265 struct scsi_sense_desc_header
3271 * The information provide in the Information descriptor is device type or
3272 * command specific information, and defined in a command standard.
3274 * Note that any changes to the field names or positions in this structure,
3275 * even reserved fields, should be accompanied by an examination of the
3276 * code in ctl_set_sense() that uses them.
3278 * Maximum descriptors allowed: 1 (as of SPC-4)
3280 struct scsi_sense_info
3283 #define SSD_DESC_INFO 0x00
3286 #define SSD_INFO_VALID 0x80
3292 * Command-specific information depends on the command for which the
3293 * reported condition occurred.
3295 * Note that any changes to the field names or positions in this structure,
3296 * even reserved fields, should be accompanied by an examination of the
3297 * code in ctl_set_sense() that uses them.
3299 * Maximum descriptors allowed: 1 (as of SPC-4)
3301 struct scsi_sense_command
3304 #define SSD_DESC_COMMAND 0x01
3306 uint8_t reserved[2];
3307 uint8_t command_info[8];
3311 * Sense key specific descriptor. The sense key specific data format
3312 * depends on the sense key in question.
3314 * Maximum descriptors allowed: 1 (as of SPC-4)
3316 struct scsi_sense_sks
3319 #define SSD_DESC_SKS 0x02
3321 uint8_t reserved1[2];
3322 uint8_t sense_key_spec[3];
3323 #define SSD_SKS_VALID 0x80
3328 * This is used for the Illegal Request sense key (0x05) only.
3330 struct scsi_sense_sks_field
3333 #define SSD_SKS_FIELD_VALID 0x80
3334 #define SSD_SKS_FIELD_CMD 0x40
3335 #define SSD_SKS_BPV 0x08
3336 #define SSD_SKS_BIT_VALUE 0x07
3342 * This is used for the Hardware Error (0x04), Medium Error (0x03) and
3343 * Recovered Error (0x01) sense keys.
3345 struct scsi_sense_sks_retry
3348 #define SSD_SKS_RETRY_VALID 0x80
3349 uint8_t actual_retry_count[2];
3353 * Used with the NO Sense (0x00) or Not Ready (0x02) sense keys.
3355 struct scsi_sense_sks_progress
3358 #define SSD_SKS_PROGRESS_VALID 0x80
3359 uint8_t progress[2];
3360 #define SSD_SKS_PROGRESS_DENOM 0x10000
3364 * Used with the Copy Aborted (0x0a) sense key.
3366 struct scsi_sense_sks_segment
3369 #define SSD_SKS_SEGMENT_VALID 0x80
3370 #define SSD_SKS_SEGMENT_SD 0x20
3371 #define SSD_SKS_SEGMENT_BPV 0x08
3372 #define SSD_SKS_SEGMENT_BITPTR 0x07
3377 * Used with the Unit Attention (0x06) sense key.
3379 * This is currently used to indicate that the unit attention condition
3380 * queue has overflowed (when the overflow bit is set).
3382 struct scsi_sense_sks_overflow
3385 #define SSD_SKS_OVERFLOW_VALID 0x80
3386 #define SSD_SKS_OVERFLOW_SET 0x01
3387 uint8_t reserved[2];
3391 * This specifies which component is associated with the sense data. There
3392 * is no standard meaning for the fru value.
3394 * Maximum descriptors allowed: 1 (as of SPC-4)
3396 struct scsi_sense_fru
3399 #define SSD_DESC_FRU 0x03
3406 * Used for Stream commands, defined in SSC-4.
3408 * Maximum descriptors allowed: 1 (as of SPC-4)
3411 struct scsi_sense_stream
3414 #define SSD_DESC_STREAM 0x04
3418 #define SSD_DESC_STREAM_FM 0x80
3419 #define SSD_DESC_STREAM_EOM 0x40
3420 #define SSD_DESC_STREAM_ILI 0x20
3424 * Used for Block commands, defined in SBC-3.
3426 * This is currently (as of SBC-3) only used for the Incorrect Length
3427 * Indication (ILI) bit, which says that the data length requested in the
3428 * READ LONG or WRITE LONG command did not match the length of the logical
3431 * Maximum descriptors allowed: 1 (as of SPC-4)
3433 struct scsi_sense_block
3436 #define SSD_DESC_BLOCK 0x05
3440 #define SSD_DESC_BLOCK_ILI 0x20
3444 * Used for Object-Based Storage Devices (OSD-3).
3446 * Maximum descriptors allowed: 1 (as of SPC-4)
3448 struct scsi_sense_osd_objid
3451 #define SSD_DESC_OSD_OBJID 0x06
3453 uint8_t reserved[6];
3455 * XXX KDM provide the bit definitions here? There are a lot of
3456 * them, and we don't have an OSD driver yet.
3458 uint8_t not_init_cmds[4];
3459 uint8_t completed_cmds[4];
3460 uint8_t partition_id[8];
3461 uint8_t object_id[8];
3465 * Used for Object-Based Storage Devices (OSD-3).
3467 * Maximum descriptors allowed: 1 (as of SPC-4)
3469 struct scsi_sense_osd_integrity
3472 #define SSD_DESC_OSD_INTEGRITY 0x07
3474 uint8_t integ_check_val[32];
3478 * Used for Object-Based Storage Devices (OSD-3).
3480 * Maximum descriptors allowed: 1 (as of SPC-4)
3482 struct scsi_sense_osd_attr_id
3485 #define SSD_DESC_OSD_ATTR_ID 0x08
3487 uint8_t reserved[2];
3488 uint8_t attr_desc[0];
3492 * ATA Return descriptor, used for the SCSI ATA PASS-THROUGH(12), (16) and
3493 * (32) commands. Described in SAT-4r05.
3495 struct scsi_sense_ata_ret_desc
3498 #define SSD_DESC_ATA 0x09
3501 #define SSD_DESC_ATA_FLAG_EXTEND 0x01
3515 * Used with Sense keys No Sense (0x00) and Not Ready (0x02).
3517 * Maximum descriptors allowed: 32 (as of SPC-4)
3519 struct scsi_sense_progress
3522 #define SSD_DESC_PROGRESS 0x0a
3525 uint8_t add_sense_code;
3526 uint8_t add_sense_code_qual;
3528 uint8_t progress[2];
3532 * This is typically forwarded as the result of an EXTENDED COPY command.
3534 * Maximum descriptors allowed: 2 (as of SPC-4)
3536 struct scsi_sense_forwarded
3539 #define SSD_DESC_FORWARDED 0x0c
3542 #define SSD_FORWARDED_FSDT 0x80
3543 #define SSD_FORWARDED_SDS_MASK 0x0f
3544 #define SSD_FORWARDED_SDS_UNK 0x00
3545 #define SSD_FORWARDED_SDS_EXSRC 0x01
3546 #define SSD_FORWARDED_SDS_EXDST 0x02
3548 uint8_t sense_data[];
3552 * Vendor-specific sense descriptor. The desc_type field will be in the
3553 * range between MIN and MAX inclusive.
3555 struct scsi_sense_vendor
3558 #define SSD_DESC_VENDOR_MIN 0x80
3559 #define SSD_DESC_VENDOR_MAX 0xff
3564 struct scsi_mode_header_6
3566 u_int8_t data_length; /* Sense data length */
3567 u_int8_t medium_type;
3569 u_int8_t blk_desc_len;
3572 struct scsi_mode_header_10
3574 u_int8_t data_length[2];/* Sense data length */
3575 u_int8_t medium_type;
3578 u_int8_t blk_desc_len[2];
3581 struct scsi_mode_page_header
3584 #define SMPH_PS 0x80
3585 #define SMPH_SPF 0x40
3586 #define SMPH_PC_MASK 0x3f
3587 u_int8_t page_length;
3590 struct scsi_mode_page_header_sp
3594 uint8_t page_length[2];
3598 struct scsi_mode_blk_desc
3601 u_int8_t nblocks[3];
3606 #define SCSI_DEFAULT_DENSITY 0x00 /* use 'default' density */
3607 #define SCSI_SAME_DENSITY 0x7f /* use 'same' density- >= SCSI-2 only */
3613 #define SCSI_STATUS_OK 0x00
3614 #define SCSI_STATUS_CHECK_COND 0x02
3615 #define SCSI_STATUS_COND_MET 0x04
3616 #define SCSI_STATUS_BUSY 0x08
3617 #define SCSI_STATUS_INTERMED 0x10
3618 #define SCSI_STATUS_INTERMED_COND_MET 0x14
3619 #define SCSI_STATUS_RESERV_CONFLICT 0x18
3620 #define SCSI_STATUS_CMD_TERMINATED 0x22 /* Obsolete in SAM-2 */
3621 #define SCSI_STATUS_QUEUE_FULL 0x28
3622 #define SCSI_STATUS_ACA_ACTIVE 0x30
3623 #define SCSI_STATUS_TASK_ABORTED 0x40
3625 struct scsi_inquiry_pattern {
3627 u_int8_t media_type;
3628 #define SIP_MEDIA_REMOVABLE 0x01
3629 #define SIP_MEDIA_FIXED 0x02
3631 const char *product;
3632 const char *revision;
3635 struct scsi_static_inquiry_pattern {
3637 u_int8_t media_type;
3638 char vendor[SID_VENDOR_SIZE+1];
3639 char product[SID_PRODUCT_SIZE+1];
3640 char revision[SID_REVISION_SIZE+1];
3643 struct scsi_sense_quirk_entry {
3644 struct scsi_inquiry_pattern inq_pat;
3647 struct sense_key_table_entry *sense_key_info;
3648 struct asc_table_entry *asc_info;
3651 struct sense_key_table_entry {
3657 struct asc_table_entry {
3664 struct op_table_entry {
3670 struct scsi_op_quirk_entry {
3671 struct scsi_inquiry_pattern inq_pat;
3673 struct op_table_entry *op_table;
3677 SSS_FLAG_NONE = 0x00,
3678 SSS_FLAG_PRINT_COMMAND = 0x01
3679 } scsi_sense_string_flags;
3693 SCSI_NV_FLAG_NONE = 0x00,
3694 SCSI_NV_FLAG_IG_CASE = 0x01 /* Case insensitive comparison */
3704 extern const char *scsi_sense_key_text[];
3707 void scsi_sense_desc(int sense_key, int asc, int ascq,
3708 struct scsi_inquiry_data *inq_data,
3709 const char **sense_key_desc, const char **asc_desc);
3710 scsi_sense_action scsi_error_action(struct ccb_scsiio* csio,
3711 struct scsi_inquiry_data *inq_data,
3712 u_int32_t sense_flags);
3713 const char * scsi_status_string(struct ccb_scsiio *csio);
3715 void scsi_desc_iterate(struct scsi_sense_data_desc *sense, u_int sense_len,
3716 int (*iter_func)(struct scsi_sense_data_desc *sense,
3717 u_int, struct scsi_sense_desc_header *,
3718 void *), void *arg);
3719 uint8_t *scsi_find_desc(struct scsi_sense_data_desc *sense, u_int sense_len,
3721 void scsi_set_sense_data(struct scsi_sense_data *sense_data,
3722 scsi_sense_data_type sense_format, int current_error,
3723 int sense_key, int asc, int ascq, ...) ;
3724 void scsi_set_sense_data_len(struct scsi_sense_data *sense_data,
3725 u_int *sense_len, scsi_sense_data_type sense_format, int current_error,
3726 int sense_key, int asc, int ascq, ...) ;
3727 void scsi_set_sense_data_va(struct scsi_sense_data *sense_data,
3728 u_int *sense_len, scsi_sense_data_type sense_format,
3729 int current_error, int sense_key, int asc, int ascq, va_list ap);
3730 int scsi_get_sense_info(struct scsi_sense_data *sense_data, u_int sense_len,
3731 uint8_t info_type, uint64_t *info,
3732 int64_t *signed_info);
3733 int scsi_get_sks(struct scsi_sense_data *sense_data, u_int sense_len,
3735 int scsi_get_block_info(struct scsi_sense_data *sense_data, u_int sense_len,
3736 struct scsi_inquiry_data *inq_data,
3737 uint8_t *block_bits);
3738 int scsi_get_stream_info(struct scsi_sense_data *sense_data, u_int sense_len,
3739 struct scsi_inquiry_data *inq_data,
3740 uint8_t *stream_bits);
3741 void scsi_info_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len,
3742 struct scsi_inquiry_data *inq_data, uint64_t info);
3743 void scsi_command_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len,
3744 struct scsi_inquiry_data *inq_data, uint64_t csi);
3745 void scsi_progress_sbuf(struct sbuf *sb, uint16_t progress);
3746 int scsi_sks_sbuf(struct sbuf *sb, int sense_key, uint8_t *sks);
3747 void scsi_fru_sbuf(struct sbuf *sb, uint64_t fru);
3748 void scsi_stream_sbuf(struct sbuf *sb, uint8_t stream_bits, uint64_t info);
3749 void scsi_block_sbuf(struct sbuf *sb, uint8_t block_bits, uint64_t info);
3750 void scsi_sense_info_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3751 u_int sense_len, uint8_t *cdb, int cdb_len,
3752 struct scsi_inquiry_data *inq_data,
3753 struct scsi_sense_desc_header *header);
3755 void scsi_sense_command_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3756 u_int sense_len, uint8_t *cdb, int cdb_len,
3757 struct scsi_inquiry_data *inq_data,
3758 struct scsi_sense_desc_header *header);
3759 void scsi_sense_sks_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_fru_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_stream_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_block_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_progress_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_ata_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_forwarded_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_generic_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_desc_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 scsi_sense_data_type scsi_sense_type(struct scsi_sense_data *sense_data);
3797 void scsi_sense_only_sbuf(struct scsi_sense_data *sense, u_int sense_len,
3798 struct sbuf *sb, char *path_str,
3799 struct scsi_inquiry_data *inq_data, uint8_t *cdb,
3803 int scsi_command_string(struct ccb_scsiio *csio, struct sbuf *sb);
3804 int scsi_sense_sbuf(struct ccb_scsiio *csio, struct sbuf *sb,
3805 scsi_sense_string_flags flags);
3806 char * scsi_sense_string(struct ccb_scsiio *csio,
3807 char *str, int str_len);
3808 void scsi_sense_print(struct ccb_scsiio *csio);
3809 int scsi_vpd_supported_page(struct cam_periph *periph,
3812 int scsi_command_string(struct cam_device *device,
3813 struct ccb_scsiio *csio, struct sbuf *sb);
3814 int scsi_sense_sbuf(struct cam_device *device,
3815 struct ccb_scsiio *csio, struct sbuf *sb,
3816 scsi_sense_string_flags flags);
3817 char * scsi_sense_string(struct cam_device *device,
3818 struct ccb_scsiio *csio,
3819 char *str, int str_len);
3820 void scsi_sense_print(struct cam_device *device,
3821 struct ccb_scsiio *csio, FILE *ofile);
3822 #endif /* _KERNEL */
3824 const char * scsi_op_desc(u_int16_t opcode,
3825 struct scsi_inquiry_data *inq_data);
3826 char * scsi_cdb_string(u_int8_t *cdb_ptr, char *cdb_string,
3828 void scsi_cdb_sbuf(u_int8_t *cdb_ptr, struct sbuf *sb);
3830 void scsi_print_inquiry(struct scsi_inquiry_data *inq_data);
3831 void scsi_print_inquiry_sbuf(struct sbuf *sb,
3832 struct scsi_inquiry_data *inq_data);
3833 void scsi_print_inquiry_short(struct scsi_inquiry_data *inq_data);
3834 void scsi_print_inquiry_short_sbuf(struct sbuf *sb,
3835 struct scsi_inquiry_data *inq_data);
3837 u_int scsi_calc_syncsrate(u_int period_factor);
3838 u_int scsi_calc_syncparam(u_int period);
3840 typedef int (*scsi_devid_checkfn_t)(uint8_t *);
3841 int scsi_devid_is_naa_ieee_reg(uint8_t *bufp);
3842 int scsi_devid_is_sas_target(uint8_t *bufp);
3843 int scsi_devid_is_lun_eui64(uint8_t *bufp);
3844 int scsi_devid_is_lun_naa(uint8_t *bufp);
3845 int scsi_devid_is_lun_name(uint8_t *bufp);
3846 int scsi_devid_is_lun_t10(uint8_t *bufp);
3847 int scsi_devid_is_lun_md5(uint8_t *bufp);
3848 int scsi_devid_is_lun_uuid(uint8_t *bufp);
3849 int scsi_devid_is_port_naa(uint8_t *bufp);
3850 struct scsi_vpd_id_descriptor *
3851 scsi_get_devid(struct scsi_vpd_device_id *id, uint32_t len,
3852 scsi_devid_checkfn_t ck_fn);
3853 struct scsi_vpd_id_descriptor *
3854 scsi_get_devid_desc(struct scsi_vpd_id_descriptor *desc, uint32_t len,
3855 scsi_devid_checkfn_t ck_fn);
3857 int scsi_transportid_sbuf(struct sbuf *sb,
3858 struct scsi_transportid_header *hdr,
3859 uint32_t valid_len);
3861 const char * scsi_nv_to_str(struct scsi_nv *table, int num_table_entries,
3864 scsi_nv_status scsi_get_nv(struct scsi_nv *table, int num_table_entries,
3865 char *name, int *table_entry, scsi_nv_flags flags);
3867 int scsi_parse_transportid_64bit(int proto_id, char *id_str,
3868 struct scsi_transportid_header **hdr,
3869 unsigned int *alloc_len,
3871 struct malloc_type *type, int flags,
3873 char *error_str, int error_str_len);
3875 int scsi_parse_transportid_spi(char *id_str,
3876 struct scsi_transportid_header **hdr,
3877 unsigned int *alloc_len,
3879 struct malloc_type *type, int flags,
3881 char *error_str, int error_str_len);
3883 int scsi_parse_transportid_rdma(char *id_str,
3884 struct scsi_transportid_header **hdr,
3885 unsigned int *alloc_len,
3887 struct malloc_type *type, int flags,
3889 char *error_str, int error_str_len);
3891 int scsi_parse_transportid_iscsi(char *id_str,
3892 struct scsi_transportid_header **hdr,
3893 unsigned int *alloc_len,
3895 struct malloc_type *type, int flags,
3897 char *error_str,int error_str_len);
3899 int scsi_parse_transportid_sop(char *id_str,
3900 struct scsi_transportid_header **hdr,
3901 unsigned int *alloc_len,
3903 struct malloc_type *type, int flags,
3905 char *error_str,int error_str_len);
3907 int scsi_parse_transportid(char *transportid_str,
3908 struct scsi_transportid_header **hdr,
3909 unsigned int *alloc_len,
3911 struct malloc_type *type, int flags,
3913 char *error_str, int error_str_len);
3916 int scsi_attrib_volcoh_sbuf(struct sbuf *sb,
3917 struct scsi_mam_attribute_header *hdr,
3918 uint32_t valid_len, uint32_t flags,
3919 uint32_t output_flags, char *error_str,
3922 int scsi_attrib_vendser_sbuf(struct sbuf *sb,
3923 struct scsi_mam_attribute_header *hdr,
3924 uint32_t valid_len, uint32_t flags,
3925 uint32_t output_flags, char *error_str,
3928 int scsi_attrib_hexdump_sbuf(struct sbuf *sb,
3929 struct scsi_mam_attribute_header *hdr,
3930 uint32_t valid_len, uint32_t flags,
3931 uint32_t output_flags, char *error_str,
3934 int scsi_attrib_int_sbuf(struct sbuf *sb, struct scsi_mam_attribute_header *hdr,
3935 uint32_t valid_len, uint32_t flags,
3936 uint32_t output_flags, char *error_str,
3939 int scsi_attrib_ascii_sbuf(struct sbuf *sb,
3940 struct scsi_mam_attribute_header *hdr,
3941 uint32_t valid_len, uint32_t flags,
3942 uint32_t output_flags, char *error_str,
3945 int scsi_attrib_text_sbuf(struct sbuf *sb,
3946 struct scsi_mam_attribute_header *hdr,
3947 uint32_t valid_len, uint32_t flags,
3948 uint32_t output_flags, char *error_str,
3951 struct scsi_attrib_table_entry *scsi_find_attrib_entry(
3952 struct scsi_attrib_table_entry *table,
3953 size_t num_table_entries, uint32_t id);
3955 struct scsi_attrib_table_entry *scsi_get_attrib_entry(uint32_t id);
3957 int scsi_attrib_value_sbuf(struct sbuf *sb, uint32_t valid_len,
3958 struct scsi_mam_attribute_header *hdr,
3959 uint32_t output_flags, char *error_str,
3960 size_t error_str_len);
3962 void scsi_attrib_prefix_sbuf(struct sbuf *sb, uint32_t output_flags,
3963 struct scsi_mam_attribute_header *hdr,
3964 uint32_t valid_len, const char *desc);
3966 int scsi_attrib_sbuf(struct sbuf *sb, struct scsi_mam_attribute_header *hdr,
3968 struct scsi_attrib_table_entry *user_table,
3969 size_t num_user_entries, int prefer_user_table,
3970 uint32_t output_flags, char *error_str, int error_str_len);
3972 void scsi_test_unit_ready(struct ccb_scsiio *csio, u_int32_t retries,
3973 void (*cbfcnp)(struct cam_periph *,
3975 u_int8_t tag_action,
3976 u_int8_t sense_len, u_int32_t timeout);
3978 void scsi_request_sense(struct ccb_scsiio *csio, u_int32_t retries,
3979 void (*cbfcnp)(struct cam_periph *,
3981 void *data_ptr, u_int8_t dxfer_len,
3982 u_int8_t tag_action, u_int8_t sense_len,
3985 void scsi_inquiry(struct ccb_scsiio *csio, u_int32_t retries,
3986 void (*cbfcnp)(struct cam_periph *, union ccb *),
3987 u_int8_t tag_action, u_int8_t *inq_buf,
3988 u_int32_t inq_len, int evpd, u_int8_t page_code,
3989 u_int8_t sense_len, u_int32_t timeout);
3991 void scsi_mode_sense(struct ccb_scsiio *csio, u_int32_t retries,
3992 void (*cbfcnp)(struct cam_periph *, union ccb *),
3993 uint8_t tag_action, int dbd, uint8_t pc, uint8_t page,
3994 uint8_t *param_buf, uint32_t param_len,
3995 uint8_t sense_len, uint32_t timeout);
3997 void scsi_mode_sense_len(struct ccb_scsiio *csio, u_int32_t retries,
3998 void (*cbfcnp)(struct cam_periph *, union ccb *),
3999 uint8_t tag_action, int dbd, uint8_t pc, uint8_t page,
4000 uint8_t *param_buf, uint32_t param_len,
4001 int minimum_cmd_size, uint8_t sense_len, uint32_t timeout);
4003 void scsi_mode_sense_subpage(struct ccb_scsiio *csio,
4005 void (*cbfcnp)(struct cam_periph *, union ccb *),
4006 uint8_t tag_action, int dbd, uint8_t pc,
4007 uint8_t page, uint8_t subpage,
4008 uint8_t *param_buf, uint32_t param_len,
4009 int minimum_cmd_size, uint8_t sense_len, uint32_t timeout);
4011 void scsi_mode_select(struct ccb_scsiio *csio, u_int32_t retries,
4012 void (*cbfcnp)(struct cam_periph *,
4014 u_int8_t tag_action, int scsi_page_fmt,
4015 int save_pages, u_int8_t *param_buf,
4016 u_int32_t param_len, u_int8_t sense_len,
4019 void scsi_mode_select_len(struct ccb_scsiio *csio, u_int32_t retries,
4020 void (*cbfcnp)(struct cam_periph *,
4022 u_int8_t tag_action, int scsi_page_fmt,
4023 int save_pages, u_int8_t *param_buf,
4024 u_int32_t param_len, int minimum_cmd_size,
4025 u_int8_t sense_len, u_int32_t timeout);
4027 void scsi_log_sense(struct ccb_scsiio *csio, u_int32_t retries,
4028 void (*cbfcnp)(struct cam_periph *, union ccb *),
4029 u_int8_t tag_action, u_int8_t page_code,
4030 u_int8_t page, int save_pages, int ppc,
4031 u_int32_t paramptr, u_int8_t *param_buf,
4032 u_int32_t param_len, u_int8_t sense_len,
4035 void scsi_log_select(struct ccb_scsiio *csio, u_int32_t retries,
4036 void (*cbfcnp)(struct cam_periph *,
4037 union ccb *), u_int8_t tag_action,
4038 u_int8_t page_code, int save_pages,
4039 int pc_reset, u_int8_t *param_buf,
4040 u_int32_t param_len, u_int8_t sense_len,
4043 void scsi_prevent(struct ccb_scsiio *csio, u_int32_t retries,
4044 void (*cbfcnp)(struct cam_periph *, union ccb *),
4045 u_int8_t tag_action, u_int8_t action,
4046 u_int8_t sense_len, u_int32_t timeout);
4048 void scsi_read_capacity(struct ccb_scsiio *csio, u_int32_t retries,
4049 void (*cbfcnp)(struct cam_periph *,
4050 union ccb *), u_int8_t tag_action,
4051 struct scsi_read_capacity_data *,
4052 u_int8_t sense_len, u_int32_t timeout);
4053 void scsi_read_capacity_16(struct ccb_scsiio *csio, uint32_t retries,
4054 void (*cbfcnp)(struct cam_periph *,
4055 union ccb *), uint8_t tag_action,
4056 uint64_t lba, int reladr, int pmi,
4057 uint8_t *rcap_buf, int rcap_buf_len,
4058 uint8_t sense_len, uint32_t timeout);
4060 void scsi_report_luns(struct ccb_scsiio *csio, u_int32_t retries,
4061 void (*cbfcnp)(struct cam_periph *,
4062 union ccb *), u_int8_t tag_action,
4063 u_int8_t select_report,
4064 struct scsi_report_luns_data *rpl_buf,
4065 u_int32_t alloc_len, u_int8_t sense_len,
4068 void scsi_report_target_group(struct ccb_scsiio *csio, u_int32_t retries,
4069 void (*cbfcnp)(struct cam_periph *,
4070 union ccb *), u_int8_t tag_action,
4073 u_int32_t alloc_len, u_int8_t sense_len,
4076 void scsi_report_timestamp(struct ccb_scsiio *csio, u_int32_t retries,
4077 void (*cbfcnp)(struct cam_periph *,
4078 union ccb *), u_int8_t tag_action,
4081 u_int32_t alloc_len, u_int8_t sense_len,
4084 void scsi_set_target_group(struct ccb_scsiio *csio, u_int32_t retries,
4085 void (*cbfcnp)(struct cam_periph *,
4086 union ccb *), u_int8_t tag_action, void *buf,
4087 u_int32_t alloc_len, u_int8_t sense_len,
4090 void scsi_create_timestamp(uint8_t *timestamp_6b_buf,
4091 uint64_t timestamp);
4093 void scsi_set_timestamp(struct ccb_scsiio *csio, u_int32_t retries,
4094 void (*cbfcnp)(struct cam_periph *,
4095 union ccb *), u_int8_t tag_action,
4096 void *buf, u_int32_t alloc_len,
4097 u_int8_t sense_len, u_int32_t timeout);
4099 void scsi_synchronize_cache(struct ccb_scsiio *csio,
4101 void (*cbfcnp)(struct cam_periph *,
4102 union ccb *), u_int8_t tag_action,
4103 u_int32_t begin_lba, u_int16_t lb_count,
4104 u_int8_t sense_len, u_int32_t timeout);
4106 void scsi_receive_diagnostic_results(struct ccb_scsiio *csio, u_int32_t retries,
4107 void (*cbfcnp)(struct cam_periph *,
4109 uint8_t tag_action, int pcv,
4110 uint8_t page_code, uint8_t *data_ptr,
4111 uint16_t allocation_length,
4112 uint8_t sense_len, uint32_t timeout);
4114 void scsi_send_diagnostic(struct ccb_scsiio *csio, u_int32_t retries,
4115 void (*cbfcnp)(struct cam_periph *, union ccb *),
4116 uint8_t tag_action, int unit_offline,
4117 int device_offline, int self_test, int page_format,
4118 int self_test_code, uint8_t *data_ptr,
4119 uint16_t param_list_length, uint8_t sense_len,
4122 void scsi_read_buffer(struct ccb_scsiio *csio, u_int32_t retries,
4123 void (*cbfcnp)(struct cam_periph *, union ccb*),
4124 uint8_t tag_action, int mode,
4125 uint8_t buffer_id, u_int32_t offset,
4126 uint8_t *data_ptr, uint32_t allocation_length,
4127 uint8_t sense_len, uint32_t timeout);
4129 void scsi_write_buffer(struct ccb_scsiio *csio, u_int32_t retries,
4130 void (*cbfcnp)(struct cam_periph *, union ccb *),
4131 uint8_t tag_action, int mode,
4132 uint8_t buffer_id, u_int32_t offset,
4133 uint8_t *data_ptr, uint32_t param_list_length,
4134 uint8_t sense_len, uint32_t timeout);
4136 #define SCSI_RW_READ 0x0001
4137 #define SCSI_RW_WRITE 0x0002
4138 #define SCSI_RW_DIRMASK 0x0003
4139 #define SCSI_RW_BIO 0x1000
4140 void scsi_read_write(struct ccb_scsiio *csio, u_int32_t retries,
4141 void (*cbfcnp)(struct cam_periph *, union ccb *),
4142 u_int8_t tag_action, int readop, u_int8_t byte2,
4143 int minimum_cmd_size, u_int64_t lba,
4144 u_int32_t block_count, u_int8_t *data_ptr,
4145 u_int32_t dxfer_len, u_int8_t sense_len,
4148 void scsi_write_same(struct ccb_scsiio *csio, u_int32_t retries,
4149 void (*cbfcnp)(struct cam_periph *, union ccb *),
4150 u_int8_t tag_action, u_int8_t byte2,
4151 int minimum_cmd_size, u_int64_t lba,
4152 u_int32_t block_count, u_int8_t *data_ptr,
4153 u_int32_t dxfer_len, u_int8_t sense_len,
4156 void scsi_ata_identify(struct ccb_scsiio *csio, u_int32_t retries,
4157 void (*cbfcnp)(struct cam_periph *, union ccb *),
4158 u_int8_t tag_action, u_int8_t *data_ptr,
4159 u_int16_t dxfer_len, u_int8_t sense_len,
4162 void scsi_ata_trim(struct ccb_scsiio *csio, u_int32_t retries,
4163 void (*cbfcnp)(struct cam_periph *, union ccb *),
4164 u_int8_t tag_action, u_int16_t block_count,
4165 u_int8_t *data_ptr, u_int16_t dxfer_len,
4166 u_int8_t sense_len, u_int32_t timeout);
4168 int scsi_ata_read_log(struct ccb_scsiio *csio, uint32_t retries,
4169 void (*cbfcnp)(struct cam_periph *, union ccb *),
4170 uint8_t tag_action, uint32_t log_address,
4171 uint32_t page_number, uint16_t block_count,
4172 uint8_t protocol, uint8_t *data_ptr, uint32_t dxfer_len,
4173 uint8_t sense_len, uint32_t timeout);
4175 int scsi_ata_pass(struct ccb_scsiio *csio, uint32_t retries,
4176 void (*cbfcnp)(struct cam_periph *, union ccb *),
4177 uint32_t flags, uint8_t tag_action,
4178 uint8_t protocol, uint8_t ata_flags, uint16_t features,
4179 uint16_t sector_count, uint64_t lba, uint8_t command,
4180 uint8_t device, uint8_t icc, uint32_t auxiliary,
4181 uint8_t control, u_int8_t *data_ptr, uint32_t dxfer_len,
4182 uint8_t *cdb_storage, size_t cdb_storage_len,
4183 int minimum_cmd_size, u_int8_t sense_len, u_int32_t timeout);
4185 void scsi_ata_pass_16(struct ccb_scsiio *csio, u_int32_t retries,
4186 void (*cbfcnp)(struct cam_periph *, union ccb *),
4187 u_int32_t flags, u_int8_t tag_action,
4188 u_int8_t protocol, u_int8_t ata_flags, u_int16_t features,
4189 u_int16_t sector_count, uint64_t lba, u_int8_t command,
4190 u_int8_t control, u_int8_t *data_ptr, u_int16_t dxfer_len,
4191 u_int8_t sense_len, u_int32_t timeout);
4193 void scsi_unmap(struct ccb_scsiio *csio, u_int32_t retries,
4194 void (*cbfcnp)(struct cam_periph *, union ccb *),
4195 u_int8_t tag_action, u_int8_t byte2,
4196 u_int8_t *data_ptr, u_int16_t dxfer_len,
4197 u_int8_t sense_len, u_int32_t timeout);
4199 void scsi_start_stop(struct ccb_scsiio *csio, u_int32_t retries,
4200 void (*cbfcnp)(struct cam_periph *, union ccb *),
4201 u_int8_t tag_action, int start, int load_eject,
4202 int immediate, u_int8_t sense_len, u_int32_t timeout);
4203 void scsi_read_attribute(struct ccb_scsiio *csio, u_int32_t retries,
4204 void (*cbfcnp)(struct cam_periph *, union ccb *),
4205 u_int8_t tag_action, u_int8_t service_action,
4206 uint32_t element, u_int8_t elem_type,
4207 int logical_volume, int partition,
4208 u_int32_t first_attribute, int cache, u_int8_t *data_ptr,
4209 u_int32_t length, int sense_len, u_int32_t timeout);
4210 void scsi_write_attribute(struct ccb_scsiio *csio, u_int32_t retries,
4211 void (*cbfcnp)(struct cam_periph *, union ccb *),
4212 u_int8_t tag_action, uint32_t element,
4213 int logical_volume, int partition, int wtc, u_int8_t *data_ptr,
4214 u_int32_t length, int sense_len, u_int32_t timeout);
4216 void scsi_security_protocol_in(struct ccb_scsiio *csio, uint32_t retries,
4217 void (*cbfcnp)(struct cam_periph *, union ccb *),
4218 uint8_t tag_action, uint32_t security_protocol,
4219 uint32_t security_protocol_specific, int byte4,
4220 uint8_t *data_ptr, uint32_t dxfer_len,
4221 int sense_len, int timeout);
4223 void scsi_security_protocol_out(struct ccb_scsiio *csio, uint32_t retries,
4224 void (*cbfcnp)(struct cam_periph *,union ccb *),
4225 uint8_t tag_action, uint32_t security_protocol,
4226 uint32_t security_protocol_specific, int byte4,
4227 uint8_t *data_ptr, uint32_t dxfer_len,
4228 int sense_len, int timeout);
4230 void scsi_persistent_reserve_in(struct ccb_scsiio *csio, uint32_t retries,
4231 void (*cbfcnp)(struct cam_periph *,union ccb *),
4232 uint8_t tag_action, int service_action,
4233 uint8_t *data_ptr, uint32_t dxfer_len,
4234 int sense_len, int timeout);
4236 void scsi_persistent_reserve_out(struct ccb_scsiio *csio, uint32_t retries,
4237 void (*cbfcnp)(struct cam_periph *,
4239 uint8_t tag_action, int service_action,
4240 int scope, int res_type, uint8_t *data_ptr,
4241 uint32_t dxfer_len, int sense_len,
4244 void scsi_report_supported_opcodes(struct ccb_scsiio *csio, uint32_t retries,
4245 void (*cbfcnp)(struct cam_periph *,
4247 uint8_t tag_action, int options,
4248 int req_opcode, int req_service_action,
4249 uint8_t *data_ptr, uint32_t dxfer_len,
4250 int sense_len, int timeout);
4252 int scsi_inquiry_match(caddr_t inqbuffer, caddr_t table_entry);
4253 int scsi_static_inquiry_match(caddr_t inqbuffer,
4254 caddr_t table_entry);
4255 int scsi_devid_match(uint8_t *rhs, size_t rhs_len,
4256 uint8_t *lhs, size_t lhs_len);
4258 void scsi_extract_sense(struct scsi_sense_data *sense, int *error_code,
4259 int *sense_key, int *asc, int *ascq);
4260 int scsi_extract_sense_ccb(union ccb *ccb, int *error_code, int *sense_key,
4261 int *asc, int *ascq);
4262 void scsi_extract_sense_len(struct scsi_sense_data *sense,
4263 u_int sense_len, int *error_code, int *sense_key,
4264 int *asc, int *ascq, int show_errors);
4265 int scsi_get_sense_key(struct scsi_sense_data *sense, u_int sense_len,
4267 int scsi_get_asc(struct scsi_sense_data *sense, u_int sense_len,
4269 int scsi_get_ascq(struct scsi_sense_data *sense, u_int sense_len,
4271 static __inline void scsi_ulto2b(u_int32_t val, u_int8_t *bytes);
4272 static __inline void scsi_ulto3b(u_int32_t val, u_int8_t *bytes);
4273 static __inline void scsi_ulto4b(u_int32_t val, u_int8_t *bytes);
4274 static __inline void scsi_u64to8b(u_int64_t val, u_int8_t *bytes);
4275 static __inline uint32_t scsi_2btoul(const uint8_t *bytes);
4276 static __inline uint32_t scsi_3btoul(const uint8_t *bytes);
4277 static __inline int32_t scsi_3btol(const uint8_t *bytes);
4278 static __inline uint32_t scsi_4btoul(const uint8_t *bytes);
4279 static __inline uint64_t scsi_8btou64(const uint8_t *bytes);
4280 static __inline void *find_mode_page_6(struct scsi_mode_header_6 *mode_header);
4281 static __inline void *find_mode_page_10(struct scsi_mode_header_10 *mode_header);
4283 static __inline void
4284 scsi_ulto2b(u_int32_t val, u_int8_t *bytes)
4287 bytes[0] = (val >> 8) & 0xff;
4288 bytes[1] = val & 0xff;
4291 static __inline void
4292 scsi_ulto3b(u_int32_t val, u_int8_t *bytes)
4295 bytes[0] = (val >> 16) & 0xff;
4296 bytes[1] = (val >> 8) & 0xff;
4297 bytes[2] = val & 0xff;
4300 static __inline void
4301 scsi_ulto4b(u_int32_t val, u_int8_t *bytes)
4304 bytes[0] = (val >> 24) & 0xff;
4305 bytes[1] = (val >> 16) & 0xff;
4306 bytes[2] = (val >> 8) & 0xff;
4307 bytes[3] = val & 0xff;
4310 static __inline void
4311 scsi_u64to8b(u_int64_t val, u_int8_t *bytes)
4314 bytes[0] = (val >> 56) & 0xff;
4315 bytes[1] = (val >> 48) & 0xff;
4316 bytes[2] = (val >> 40) & 0xff;
4317 bytes[3] = (val >> 32) & 0xff;
4318 bytes[4] = (val >> 24) & 0xff;
4319 bytes[5] = (val >> 16) & 0xff;
4320 bytes[6] = (val >> 8) & 0xff;
4321 bytes[7] = val & 0xff;
4324 static __inline uint32_t
4325 scsi_2btoul(const uint8_t *bytes)
4329 rv = (bytes[0] << 8) |
4334 static __inline uint32_t
4335 scsi_3btoul(const uint8_t *bytes)
4339 rv = (bytes[0] << 16) |
4345 static __inline int32_t
4346 scsi_3btol(const uint8_t *bytes)
4348 uint32_t rc = scsi_3btoul(bytes);
4350 if (rc & 0x00800000)
4353 return (int32_t) rc;
4356 static __inline uint32_t
4357 scsi_4btoul(const uint8_t *bytes)
4361 rv = (bytes[0] << 24) |
4368 static __inline uint64_t
4369 scsi_8btou64(const uint8_t *bytes)
4373 rv = (((uint64_t)bytes[0]) << 56) |
4374 (((uint64_t)bytes[1]) << 48) |
4375 (((uint64_t)bytes[2]) << 40) |
4376 (((uint64_t)bytes[3]) << 32) |
4377 (((uint64_t)bytes[4]) << 24) |
4378 (((uint64_t)bytes[5]) << 16) |
4379 (((uint64_t)bytes[6]) << 8) |
4385 * Given the pointer to a returned mode sense buffer, return a pointer to
4386 * the start of the first mode page.
4388 static __inline void *
4389 find_mode_page_6(struct scsi_mode_header_6 *mode_header)
4393 page_start = (void *)((u_int8_t *)&mode_header[1] +
4394 mode_header->blk_desc_len);
4399 static __inline void *
4400 find_mode_page_10(struct scsi_mode_header_10 *mode_header)
4404 page_start = (void *)((u_int8_t *)&mode_header[1] +
4405 scsi_2btoul(mode_header->blk_desc_len));
4412 #endif /*_SCSI_SCSI_ALL_H*/