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 /* Fatal error action, with table specified error code */
107 #define SS_FATAL SS_FAIL|SSQ_PRINT_SENSE
115 struct scsi_request_sense
119 #define SRS_DESC 0x01
125 struct scsi_test_unit_ready
133 struct scsi_receive_diag {
142 struct scsi_send_diag {
145 #define SSD_UNITOFFL 0x01
146 #define SSD_DEVOFFL 0x02
147 #define SSD_SELFTEST 0x04
149 #define SSD_SELF_TEST_CODE_MASK 0xE0
150 #define SSD_SELF_TEST_CODE_SHIFT 5
151 #define SSD_SELF_TEST_CODE_NONE 0x00
152 #define SSD_SELF_TEST_CODE_BG_SHORT 0x01
153 #define SSD_SELF_TEST_CODE_BG_EXTENDED 0x02
154 #define SSD_SELF_TEST_CODE_BG_ABORT 0x04
155 #define SSD_SELF_TEST_CODE_FG_SHORT 0x05
156 #define SSD_SELF_TEST_CODE_FG_EXTENDED 0x06
176 #define SI_CMDDT 0x02
182 struct scsi_mode_sense_6
188 #define SMS_PAGE_CODE 0x3F
189 #define SMS_VENDOR_SPECIFIC_PAGE 0x00
190 #define SMS_DISCONNECT_RECONNECT_PAGE 0x02
191 #define SMS_FORMAT_DEVICE_PAGE 0x03
192 #define SMS_GEOMETRY_PAGE 0x04
193 #define SMS_CACHE_PAGE 0x08
194 #define SMS_PERIPHERAL_DEVICE_PAGE 0x09
195 #define SMS_CONTROL_MODE_PAGE 0x0A
196 #define SMS_PROTO_SPECIFIC_PAGE 0x19
197 #define SMS_INFO_EXCEPTIONS_PAGE 0x1C
198 #define SMS_ALL_PAGES_PAGE 0x3F
199 #define SMS_PAGE_CTRL_MASK 0xC0
200 #define SMS_PAGE_CTRL_CURRENT 0x00
201 #define SMS_PAGE_CTRL_CHANGEABLE 0x40
202 #define SMS_PAGE_CTRL_DEFAULT 0x80
203 #define SMS_PAGE_CTRL_SAVED 0xC0
205 #define SMS_SUBPAGE_PAGE_0 0x00
206 #define SMS_SUBPAGE_ALL 0xff
211 struct scsi_mode_sense_10
214 u_int8_t byte2; /* same bits as small version */
215 #define SMS10_LLBAA 0x10
216 u_int8_t page; /* same bits as small version */
223 struct scsi_mode_select_6
234 struct scsi_mode_select_10
237 u_int8_t byte2; /* same bits as small version */
244 * When sending a mode select to a tape drive, the medium type must be 0.
246 struct scsi_mode_hdr_6
249 u_int8_t medium_type;
250 u_int8_t dev_specific;
251 u_int8_t block_descr_len;
254 struct scsi_mode_hdr_10
257 u_int8_t medium_type;
258 u_int8_t dev_specific;
259 u_int8_t reserved[2];
260 u_int8_t block_descr_len[2];
263 struct scsi_mode_block_descr
265 u_int8_t density_code;
266 u_int8_t num_blocks[3];
268 u_int8_t block_len[3];
271 struct scsi_per_res_in
279 u_int8_t reserved[5];
284 struct scsi_per_res_in_header
286 u_int8_t generation[4];
290 struct scsi_per_res_key
295 struct scsi_per_res_in_keys
297 struct scsi_per_res_in_header header;
298 struct scsi_per_res_key keys[0];
301 struct scsi_per_res_cap
305 #define SPRI_CRH 0x10
306 #define SPRI_SIP_C 0x08
307 #define SPRI_ATP_C 0x04
308 #define SPRI_PTPL_C 0x01
310 #define SPRI_TMV 0x80
311 #define SPRI_PTPL_A 0x01
312 uint8_t type_mask[2];
313 #define SPRI_TM_WR_EX_AR 0x8000
314 #define SPRI_TM_EX_AC_RO 0x4000
315 #define SPRI_TM_WR_EX_RO 0x2000
316 #define SPRI_TM_EX_AC 0x0800
317 #define SPRI_TM_WR_EX 0x0200
318 #define SPRI_TM_EX_AC_AR 0x0001
322 struct scsi_per_res_in_rsrv_data
324 uint8_t reservation[8];
325 uint8_t obsolete1[4];
330 #define SPRT_WERO 0x05
331 #define SPRT_EARO 0x06
332 #define SPRT_WEAR 0x07
333 #define SPRT_EAAR 0x08
334 uint8_t obsolete2[2];
337 struct scsi_per_res_in_rsrv
339 struct scsi_per_res_in_header header;
340 struct scsi_per_res_in_rsrv_data data;
343 struct scsi_per_res_out
347 #define SPRO_REGISTER 0x00
348 #define SPRO_RESERVE 0x01
349 #define SPRO_RELEASE 0x02
350 #define SPRO_CLEAR 0x03
351 #define SPRO_PREEMPT 0x04
352 #define SPRO_PRE_ABO 0x05
353 #define SPRO_REG_IGNO 0x06
354 #define SPRO_REG_MOVE 0x07
355 #define SPRO_ACTION_MASK 0x1f
357 #define SPR_SCOPE_MASK 0xf0
358 #define SPR_LU_SCOPE 0x00
359 #define SPR_TYPE_MASK 0x0f
360 #define SPR_TYPE_WR_EX 0x01
361 #define SPR_TYPE_EX_AC 0x03
362 #define SPR_TYPE_WR_EX_RO 0x05
363 #define SPR_TYPE_EX_AC_RO 0x06
364 #define SPR_TYPE_WR_EX_AR 0x07
365 #define SPR_TYPE_EX_AC_AR 0x08
366 u_int8_t reserved[2];
371 struct scsi_per_res_out_parms
373 struct scsi_per_res_key res_key;
374 u_int8_t serv_act_res_key[8];
375 u_int8_t obsolete1[4];
377 #define SPR_SPEC_I_PT 0x08
378 #define SPR_ALL_TG_PT 0x04
379 #define SPR_APTPL 0x01
381 u_int8_t obsolete2[2];
385 struct scsi_log_sense
392 #define SLS_PAGE_CODE 0x3F
393 #define SLS_ALL_PAGES_PAGE 0x00
394 #define SLS_OVERRUN_PAGE 0x01
395 #define SLS_ERROR_WRITE_PAGE 0x02
396 #define SLS_ERROR_READ_PAGE 0x03
397 #define SLS_ERROR_READREVERSE_PAGE 0x04
398 #define SLS_ERROR_VERIFY_PAGE 0x05
399 #define SLS_ERROR_NONMEDIUM_PAGE 0x06
400 #define SLS_ERROR_LASTN_PAGE 0x07
401 #define SLS_SELF_TEST_PAGE 0x10
402 #define SLS_IE_PAGE 0x2f
403 #define SLS_PAGE_CTRL_MASK 0xC0
404 #define SLS_PAGE_CTRL_THRESHOLD 0x00
405 #define SLS_PAGE_CTRL_CUMULATIVE 0x40
406 #define SLS_PAGE_CTRL_THRESH_DEFAULT 0x80
407 #define SLS_PAGE_CTRL_CUMUL_DEFAULT 0xC0
408 u_int8_t reserved[2];
409 u_int8_t paramptr[2];
414 struct scsi_log_select
421 /* SLS_PAGE_CTRL_MASK 0xC0 */
422 /* SLS_PAGE_CTRL_THRESHOLD 0x00 */
423 /* SLS_PAGE_CTRL_CUMULATIVE 0x40 */
424 /* SLS_PAGE_CTRL_THRESH_DEFAULT 0x80 */
425 /* SLS_PAGE_CTRL_CUMUL_DEFAULT 0xC0 */
426 u_int8_t reserved[4];
431 struct scsi_log_header
438 struct scsi_log_param_header {
439 u_int8_t param_code[2];
440 u_int8_t param_control;
442 #define SLP_LBIN 0x02
443 #define SLP_TMC_MASK 0x0C
444 #define SLP_TMC_ALWAYS 0x00
445 #define SLP_TMC_EQUAL 0x04
446 #define SLP_TMC_NOTEQUAL 0x08
447 #define SLP_TMC_GREATER 0x0C
455 struct scsi_control_page {
457 u_int8_t page_length;
459 #define SCP_RLEC 0x01 /*Report Log Exception Cond*/
460 #define SCP_GLTSD 0x02 /*Global Logging target
462 #define SCP_DSENSE 0x04 /*Descriptor Sense */
463 #define SCP_DPICZ 0x08 /*Disable Prot. Info Check
464 if Prot. Field is Zero */
465 #define SCP_TMF_ONLY 0x10 /*TM Functions Only*/
466 #define SCP_TST_MASK 0xE0 /*Task Set Type Mask*/
467 #define SCP_TST_ONE 0x00 /*One Task Set*/
468 #define SCP_TST_SEPARATE 0x20 /*Separate Task Sets*/
469 u_int8_t queue_flags;
470 #define SCP_QUEUE_ALG_MASK 0xF0
471 #define SCP_QUEUE_ALG_RESTRICTED 0x00
472 #define SCP_QUEUE_ALG_UNRESTRICTED 0x10
473 #define SCP_QUEUE_ERR 0x02 /*Queued I/O aborted for CACs*/
474 #define SCP_QUEUE_DQUE 0x01 /*Queued I/O disabled*/
475 u_int8_t eca_and_aen;
476 #define SCP_EECA 0x80 /*Enable Extended CA*/
477 #define SCP_RAENP 0x04 /*Ready AEN Permission*/
478 #define SCP_UAAENP 0x02 /*UA AEN Permission*/
479 #define SCP_EAENP 0x01 /*Error AEN Permission*/
481 u_int8_t aen_holdoff_period[2];
484 struct scsi_cache_page {
486 #define SCHP_PAGE_SAVABLE 0x80 /* Page is savable */
487 u_int8_t page_length;
488 u_int8_t cache_flags;
489 #define SCHP_FLAGS_WCE 0x04 /* Write Cache Enable */
490 #define SCHP_FLAGS_MF 0x02 /* Multiplication factor */
491 #define SCHP_FLAGS_RCD 0x01 /* Read Cache Disable */
492 u_int8_t rw_cache_policy;
493 u_int8_t dis_prefetch[2];
494 u_int8_t min_prefetch[2];
495 u_int8_t max_prefetch[2];
496 u_int8_t max_prefetch_ceil[2];
501 * Updated version of the cache page, as of SBC. Update this to SBC-3 and
502 * rationalize the two.
504 struct scsi_caching_page {
506 #define SMS_CACHING_PAGE 0x08
510 #define SCP_ABPF 0x40
512 #define SCP_DISC 0x10
513 #define SCP_SIZE 0x08
517 uint8_t ret_priority;
518 uint8_t disable_pf_transfer_len[2];
519 uint8_t min_prefetch[2];
520 uint8_t max_prefetch[2];
521 uint8_t max_pf_ceiling[2];
524 #define SCP_LBCSS 0x40
528 uint8_t cache_segments;
529 uint8_t cache_seg_size[2];
531 uint8_t non_cache_seg_size[3];
535 * XXX KDM move this off to a vendor shim.
537 struct copan_power_subpage {
539 #define PWR_PAGE_CODE 0x00
541 #define PWR_SUBPAGE_CODE 0x02
542 uint8_t page_length[2];
543 uint8_t page_version;
544 #define PWR_VERSION 0x01
546 uint8_t max_active_luns;
547 #define PWR_DFLT_MAX_LUNS 0x07
548 uint8_t reserved[25];
552 * XXX KDM move this off to a vendor shim.
554 struct copan_aps_subpage {
556 #define APS_PAGE_CODE 0x00
558 #define APS_SUBPAGE_CODE 0x03
559 uint8_t page_length[2];
560 uint8_t page_version;
561 #define APS_VERSION 0x00
563 #define APS_LOCK_ACTIVE 0x01
564 #define APS_LOCK_INACTIVE 0x00
565 uint8_t reserved[26];
569 * XXX KDM move this off to a vendor shim.
571 struct copan_debugconf_subpage {
573 #define DBGCNF_PAGE_CODE 0x00
575 #define DBGCNF_SUBPAGE_CODE 0xF0
576 uint8_t page_length[2];
577 uint8_t page_version;
578 #define DBGCNF_VERSION 0x00
579 uint8_t ctl_time_io_secs[2];
583 struct scsi_info_exceptions_page {
585 #define SIEP_PAGE_SAVABLE 0x80 /* Page is savable */
586 u_int8_t page_length;
588 #define SIEP_FLAGS_PERF 0x80
589 #define SIEP_FLAGS_EBF 0x20
590 #define SIEP_FLAGS_EWASC 0x10
591 #define SIEP_FLAGS_DEXCPT 0x08
592 #define SIEP_FLAGS_TEST 0x04
593 #define SIEP_FLAGS_EBACKERR 0x02
594 #define SIEP_FLAGS_LOGERR 0x01
596 u_int8_t interval_timer[4];
597 u_int8_t report_count[4];
600 struct scsi_proto_specific_page {
602 #define SPSP_PAGE_SAVABLE 0x80 /* Page is savable */
603 u_int8_t page_length;
605 #define SPSP_PROTO_FC 0x00
606 #define SPSP_PROTO_SPI 0x01
607 #define SPSP_PROTO_SSA 0x02
608 #define SPSP_PROTO_1394 0x03
609 #define SPSP_PROTO_RDMA 0x04
610 #define SPSP_PROTO_ISCSI 0x05
611 #define SPSP_PROTO_SAS 0x06
612 #define SPSP_PROTO_ADT 0x07
613 #define SPSP_PROTO_ATA 0x08
614 #define SPSP_PROTO_NONE 0x0f
621 #define SR_EXTENT 0x01
622 #define SR_ID_MASK 0x0e
623 #define SR_3RDPTY 0x10
624 #define SR_LUN_MASK 0xe0
630 struct scsi_reserve_10 {
633 #define SR10_3RDPTY 0x10
634 #define SR10_LONGID 0x02
635 #define SR10_EXTENT 0x01
637 uint8_t thirdparty_id;
654 struct scsi_release_10 {
658 uint8_t thirdparty_id;
672 #define PR_PREVENT 0x01
673 #define PR_ALLOW 0x00
675 struct scsi_sync_cache
679 #define SSC_IMMED 0x02
680 #define SSC_RELADR 0x01
681 u_int8_t begin_lba[4];
683 u_int8_t lb_count[2];
687 struct scsi_sync_cache_16
691 uint8_t begin_lba[8];
700 #define SF_LONGLIST 0x20
701 #define SF_FMTDATA 0x10
702 #define SF_CMPLIST 0x08
703 #define SF_FORMAT_MASK 0x07
704 #define SF_FORMAT_BLOCK 0x00
705 #define SF_FORMAT_LONG_BLOCK 0x03
706 #define SF_FORMAT_BFI 0x04
707 #define SF_FORMAT_PHYS 0x05
709 uint8_t interleave[2];
713 struct scsi_format_header_short {
715 #define SF_DATA_FOV 0x80
716 #define SF_DATA_DPRY 0x40
717 #define SF_DATA_DCRT 0x20
718 #define SF_DATA_STPF 0x10
719 #define SF_DATA_IP 0x08
720 #define SF_DATA_DSP 0x04
721 #define SF_DATA_IMMED 0x02
722 #define SF_DATA_VS 0x01
724 uint8_t defect_list_len[2];
727 struct scsi_format_header_long {
730 uint8_t reserved2[2];
731 uint8_t defect_list_len[4];
734 struct scsi_changedef
745 struct scsi_read_buffer
749 #define RWB_MODE 0x07
750 #define RWB_MODE_HDR_DATA 0x00
751 #define RWB_MODE_VENDOR 0x01
752 #define RWB_MODE_DATA 0x02
753 #define RWB_MODE_DOWNLOAD 0x04
754 #define RWB_MODE_DOWNLOAD_SAVE 0x05
761 struct scsi_write_buffer
775 /* only 5 bits are valid in the MSB address byte */
776 #define SRW_TOPADDR 0x1F
784 #define SRW10_RELADDR 0x01
785 /* EBP defined for WRITE(10) only */
786 #define SRW10_EBP 0x04
787 #define SRW10_FUA 0x08
788 #define SRW10_DPO 0x10
799 #define SRW12_RELADDR 0x01
800 #define SRW12_FUA 0x08
801 #define SRW12_DPO 0x10
812 #define SRW16_RELADDR 0x01
813 #define SRW16_FUA 0x08
814 #define SRW16_DPO 0x10
822 struct scsi_write_same_10
826 #define SWS_LBDATA 0x02
827 #define SWS_PBDATA 0x04
828 #define SWS_UNMAP 0x08
829 #define SWS_ANCHOR 0x10
836 struct scsi_write_same_16
850 #define SU_ANCHOR 0x01
857 struct scsi_write_verify_10
861 #define SWV_BYTCHK 0x02
863 #define SWV_WRPROECT_MASK 0xe0
870 struct scsi_write_verify_12
880 struct scsi_write_verify_16
891 struct scsi_start_stop_unit
895 #define SSS_IMMED 0x01
896 u_int8_t reserved[2];
898 #define SSS_START 0x01
899 #define SSS_LOEJ 0x02
900 #define SSS_PC_MASK 0xf0
901 #define SSS_PC_START_VALID 0x00
902 #define SSS_PC_ACTIVE 0x10
903 #define SSS_PC_IDLE 0x20
904 #define SSS_PC_STANDBY 0x30
905 #define SSS_PC_LU_CONTROL 0x70
906 #define SSS_PC_FORCE_IDLE_0 0xa0
907 #define SSS_PC_FORCE_STANDBY_0 0xb0
914 #define AP_PROTO_HARD_RESET (0x00 << 1)
915 #define AP_PROTO_SRST (0x01 << 1)
916 #define AP_PROTO_NON_DATA (0x03 << 1)
917 #define AP_PROTO_PIO_IN (0x04 << 1)
918 #define AP_PROTO_PIO_OUT (0x05 << 1)
919 #define AP_PROTO_DMA (0x06 << 1)
920 #define AP_PROTO_DMA_QUEUED (0x07 << 1)
921 #define AP_PROTO_DEVICE_DIAG (0x08 << 1)
922 #define AP_PROTO_DEVICE_RESET (0x09 << 1)
923 #define AP_PROTO_UDMA_IN (0x0a << 1)
924 #define AP_PROTO_UDMA_OUT (0x0b << 1)
925 #define AP_PROTO_FPDMA (0x0c << 1)
926 #define AP_PROTO_RESP_INFO (0x0f << 1)
927 #define AP_MULTI 0xe0
929 #define AP_T_LEN 0x03
931 #define AP_T_DIR 0x08
932 #define AP_CK_COND 0x20
933 #define AP_OFFLINE 0x60
935 u_int8_t sector_count;
945 struct scsi_maintenance_in
949 #define SERVICE_ACTION_MASK 0x1f
950 #define SA_RPRT_TRGT_GRP 0x0a
960 #define AP_EXTEND 0x01
962 #define AP_FLAG_TLEN_NO_DATA (0 << 0)
963 #define AP_FLAG_TLEN_FEAT (1 << 0)
964 #define AP_FLAG_TLEN_SECT_CNT (2 << 0)
965 #define AP_FLAG_TLEN_STPSIU (3 << 0)
966 #define AP_FLAG_BYT_BLOK_BYTES (0 << 2)
967 #define AP_FLAG_BYT_BLOK_BLOCKS (1 << 2)
968 #define AP_FLAG_TDIR_TO_DEV (0 << 3)
969 #define AP_FLAG_TDIR_FROM_DEV (1 << 3)
970 #define AP_FLAG_CHK_COND (1 << 5)
971 u_int8_t features_ext;
973 u_int8_t sector_count_ext;
974 u_int8_t sector_count;
975 u_int8_t lba_low_ext;
977 u_int8_t lba_mid_ext;
979 u_int8_t lba_high_ext;
986 #define SC_SCSI_1 0x01
987 #define SC_SCSI_2 0x03
993 #define TEST_UNIT_READY 0x00
994 #define REQUEST_SENSE 0x03
998 #define MODE_SELECT_6 0x15
999 #define MODE_SENSE_6 0x1A
1000 #define START_STOP_UNIT 0x1B
1001 #define START_STOP 0x1B
1002 #define RESERVE 0x16
1003 #define RELEASE 0x17
1004 #define RECEIVE_DIAGNOSTIC 0x1C
1005 #define SEND_DIAGNOSTIC 0x1D
1006 #define PREVENT_ALLOW 0x1E
1007 #define READ_CAPACITY 0x25
1008 #define READ_10 0x28
1009 #define WRITE_10 0x2A
1010 #define POSITION_TO_ELEMENT 0x2B
1011 #define WRITE_VERIFY_10 0x2E
1012 #define VERIFY_10 0x2F
1013 #define SYNCHRONIZE_CACHE 0x35
1014 #define READ_DEFECT_DATA_10 0x37
1015 #define WRITE_BUFFER 0x3B
1016 #define READ_BUFFER 0x3C
1017 #define CHANGE_DEFINITION 0x40
1018 #define WRITE_SAME_10 0x41
1020 #define LOG_SELECT 0x4C
1021 #define LOG_SENSE 0x4D
1022 #define MODE_SELECT_10 0x55
1023 #define RESERVE_10 0x56
1024 #define RELEASE_10 0x57
1025 #define MODE_SENSE_10 0x5A
1026 #define PERSISTENT_RES_IN 0x5E
1027 #define PERSISTENT_RES_OUT 0x5F
1028 #define ATA_PASS_16 0x85
1029 #define READ_16 0x88
1030 #define WRITE_16 0x8A
1031 #define WRITE_VERIFY_16 0x8E
1032 #define SYNCHRONIZE_CACHE_16 0x91
1033 #define WRITE_SAME_16 0x93
1034 #define SERVICE_ACTION_IN 0x9E
1035 #define REPORT_LUNS 0xA0
1036 #define ATA_PASS_12 0xA1
1037 #define MAINTENANCE_IN 0xA3
1038 #define MAINTENANCE_OUT 0xA4
1039 #define MOVE_MEDIUM 0xA5
1040 #define READ_12 0xA8
1041 #define WRITE_12 0xAA
1042 #define WRITE_VERIFY_12 0xAE
1043 #define READ_ELEMENT_STATUS 0xB8
1044 #define READ_CD 0xBE
1046 /* Maintenance In Service Action Codes */
1047 #define REPORT_IDENTIFYING_INFRMATION 0x05
1048 #define REPORT_TARGET_PORT_GROUPS 0x0A
1049 #define REPORT_ALIASES 0x0B
1050 #define REPORT_SUPPORTED_OPERATION_CODES 0x0C
1051 #define REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS 0x0D
1052 #define REPORT_PRIORITY 0x0E
1053 #define REPORT_TIMESTAMP 0x0F
1054 #define MANAGEMENT_PROTOCOL_IN 0x10
1055 /* Maintenance Out Service Action Codes */
1056 #define SET_IDENTIFY_INFORMATION 0x06
1057 #define SET_TARGET_PORT_GROUPS 0x0A
1058 #define CHANGE_ALIASES 0x0B
1059 #define SET_PRIORITY 0x0E
1060 #define SET_TIMESTAMP 0x0F
1061 #define MANGAEMENT_PROTOCOL_OUT 0x10
1066 #define T_DIRECT 0x00
1067 #define T_SEQUENTIAL 0x01
1068 #define T_PRINTER 0x02
1069 #define T_PROCESSOR 0x03
1071 #define T_CDROM 0x05
1072 #define T_SCANNER 0x06
1073 #define T_OPTICAL 0x07
1074 #define T_CHANGER 0x08
1078 #define T_STORARRAY 0x0c
1079 #define T_ENCLOSURE 0x0d
1084 #define T_NODEVICE 0x1f
1085 #define T_ANY 0xff /* Used in Quirk table matches */
1091 * This length is the initial inquiry length used by the probe code, as
1092 * well as the length necessary for scsi_print_inquiry() to function
1093 * correctly. If either use requires a different length in the future,
1094 * the two values should be de-coupled.
1096 #define SHORT_INQUIRY_LENGTH 36
1098 struct scsi_inquiry_data
1101 #define SID_TYPE(inq_data) ((inq_data)->device & 0x1f)
1102 #define SID_QUAL(inq_data) (((inq_data)->device & 0xE0) >> 5)
1103 #define SID_QUAL_LU_CONNECTED 0x00 /*
1104 * The specified peripheral device
1105 * type is currently connected to
1106 * logical unit. If the target cannot
1107 * determine whether or not a physical
1108 * device is currently connected, it
1109 * shall also use this peripheral
1110 * qualifier when returning the INQUIRY
1111 * data. This peripheral qualifier
1112 * does not mean that the device is
1113 * ready for access by the initiator.
1115 #define SID_QUAL_LU_OFFLINE 0x01 /*
1116 * The target is capable of supporting
1117 * the specified peripheral device type
1118 * on this logical unit; however, the
1119 * physical device is not currently
1120 * connected to this logical unit.
1122 #define SID_QUAL_RSVD 0x02
1123 #define SID_QUAL_BAD_LU 0x03 /*
1124 * The target is not capable of
1125 * supporting a physical device on
1126 * this logical unit. For this
1127 * peripheral qualifier the peripheral
1128 * device type shall be set to 1Fh to
1129 * provide compatibility with previous
1130 * versions of SCSI. All other
1131 * peripheral device type values are
1132 * reserved for this peripheral
1135 #define SID_QUAL_IS_VENDOR_UNIQUE(inq_data) ((SID_QUAL(inq_data) & 0x08) != 0)
1137 #define SID_QUAL2 0x7F
1138 #define SID_IS_REMOVABLE(inq_data) (((inq_data)->dev_qual2 & 0x80) != 0)
1140 #define SID_ANSI_REV(inq_data) ((inq_data)->version & 0x07)
1141 #define SCSI_REV_0 0
1142 #define SCSI_REV_CCS 1
1143 #define SCSI_REV_2 2
1144 #define SCSI_REV_SPC 3
1145 #define SCSI_REV_SPC2 4
1146 #define SCSI_REV_SPC3 5
1147 #define SCSI_REV_SPC4 6
1149 #define SID_ECMA 0x38
1150 #define SID_ISO 0xC0
1151 u_int8_t response_format;
1152 #define SID_AENC 0x80
1153 #define SID_TrmIOP 0x40
1154 #define SID_NormACA 0x20
1155 #define SID_HiSup 0x10
1156 u_int8_t additional_length;
1157 #define SID_ADDITIONAL_LENGTH(iqd) \
1158 ((iqd)->additional_length + \
1159 __offsetof(struct scsi_inquiry_data, additional_length) + 1)
1160 u_int8_t spc3_flags;
1161 #define SPC3_SID_PROTECT 0x01
1162 #define SPC3_SID_3PC 0x08
1163 #define SPC3_SID_TPGS_MASK 0x30
1164 #define SPC3_SID_TPGS_IMPLICIT 0x10
1165 #define SPC3_SID_TPGS_EXPLICIT 0x20
1166 #define SPC3_SID_ACC 0x40
1167 #define SPC3_SID_SCCS 0x80
1168 u_int8_t spc2_flags;
1169 #define SPC2_SID_ADDR16 0x01
1170 #define SPC2_SID_MChngr 0x08
1171 #define SPC2_SID_MultiP 0x10
1172 #define SPC2_SID_EncServ 0x40
1173 #define SPC2_SID_BQueue 0x80
1175 #define INQ_DATA_TQ_ENABLED(iqd) \
1176 ((SID_ANSI_REV(iqd) < SCSI_REV_SPC2)? ((iqd)->flags & SID_CmdQue) : \
1177 (((iqd)->flags & SID_CmdQue) && !((iqd)->spc2_flags & SPC2_SID_BQueue)) || \
1178 (!((iqd)->flags & SID_CmdQue) && ((iqd)->spc2_flags & SPC2_SID_BQueue)))
1181 #define SID_SftRe 0x01
1182 #define SID_CmdQue 0x02
1183 #define SID_Linked 0x08
1184 #define SID_Sync 0x10
1185 #define SID_WBus16 0x20
1186 #define SID_WBus32 0x40
1187 #define SID_RelAdr 0x80
1188 #define SID_VENDOR_SIZE 8
1189 char vendor[SID_VENDOR_SIZE];
1190 #define SID_PRODUCT_SIZE 16
1191 char product[SID_PRODUCT_SIZE];
1192 #define SID_REVISION_SIZE 4
1193 char revision[SID_REVISION_SIZE];
1195 * The following fields were taken from SCSI Primary Commands - 2
1196 * (SPC-2) Revision 14, Dated 11 November 1999
1198 #define SID_VENDOR_SPECIFIC_0_SIZE 20
1199 u_int8_t vendor_specific0[SID_VENDOR_SPECIFIC_0_SIZE];
1201 * An extension of SCSI Parallel Specific Values
1203 #define SID_SPI_IUS 0x01
1204 #define SID_SPI_QAS 0x02
1205 #define SID_SPI_CLOCK_ST 0x00
1206 #define SID_SPI_CLOCK_DT 0x04
1207 #define SID_SPI_CLOCK_DT_ST 0x0C
1208 #define SID_SPI_MASK 0x0F
1212 * Version Descriptors, stored 2 byte values.
1214 u_int8_t version1[2];
1215 u_int8_t version2[2];
1216 u_int8_t version3[2];
1217 u_int8_t version4[2];
1218 u_int8_t version5[2];
1219 u_int8_t version6[2];
1220 u_int8_t version7[2];
1221 u_int8_t version8[2];
1223 u_int8_t reserved3[22];
1225 #define SID_VENDOR_SPECIFIC_1_SIZE 160
1226 u_int8_t vendor_specific1[SID_VENDOR_SPECIFIC_1_SIZE];
1230 * This structure is more suited to initiator operation, because the
1231 * maximum number of supported pages is already allocated.
1233 struct scsi_vpd_supported_page_list
1237 #define SVPD_SUPPORTED_PAGE_LIST 0x00
1238 #define SVPD_SUPPORTED_PAGES_HDR_LEN 4
1240 u_int8_t length; /* number of VPD entries */
1241 #define SVPD_SUPPORTED_PAGES_SIZE 251
1242 u_int8_t list[SVPD_SUPPORTED_PAGES_SIZE];
1246 * This structure is more suited to target operation, because the
1247 * number of supported pages is left to the user to allocate.
1249 struct scsi_vpd_supported_pages
1254 #define SVPD_SUPPORTED_PAGES 0x00
1256 u_int8_t page_list[0];
1260 struct scsi_vpd_unit_serial_number
1264 #define SVPD_UNIT_SERIAL_NUMBER 0x80
1266 u_int8_t length; /* serial number length */
1267 #define SVPD_SERIAL_NUM_SIZE 251
1268 u_int8_t serial_num[SVPD_SERIAL_NUM_SIZE];
1271 struct scsi_vpd_device_id
1275 #define SVPD_DEVICE_ID 0x83
1276 #define SVPD_DEVICE_ID_MAX_SIZE 252
1277 #define SVPD_DEVICE_ID_HDR_LEN \
1278 __offsetof(struct scsi_vpd_device_id, desc_list)
1280 u_int8_t desc_list[];
1283 struct scsi_vpd_id_descriptor
1285 u_int8_t proto_codeset;
1286 #define SCSI_PROTO_FC 0x00
1287 #define SCSI_PROTO_SPI 0x01
1288 #define SCSI_PROTO_SSA 0x02
1289 #define SCSI_PROTO_1394 0x03
1290 #define SCSI_PROTO_RDMA 0x04
1291 #define SCSI_PROTO_iSCSI 0x05
1292 #define SCSI_PROTO_SAS 0x06
1293 #define SCSI_PROTO_ADT 0x07
1294 #define SCSI_PROTO_ATA 0x08
1295 #define SVPD_ID_PROTO_SHIFT 4
1296 #define SVPD_ID_CODESET_BINARY 0x01
1297 #define SVPD_ID_CODESET_ASCII 0x02
1298 #define SVPD_ID_CODESET_UTF8 0x03
1299 #define SVPD_ID_CODESET_MASK 0x0f
1301 #define SVPD_ID_PIV 0x80
1302 #define SVPD_ID_ASSOC_LUN 0x00
1303 #define SVPD_ID_ASSOC_PORT 0x10
1304 #define SVPD_ID_ASSOC_TARGET 0x20
1305 #define SVPD_ID_ASSOC_MASK 0x30
1306 #define SVPD_ID_TYPE_VENDOR 0x00
1307 #define SVPD_ID_TYPE_T10 0x01
1308 #define SVPD_ID_TYPE_EUI64 0x02
1309 #define SVPD_ID_TYPE_NAA 0x03
1310 #define SVPD_ID_TYPE_RELTARG 0x04
1311 #define SVPD_ID_TYPE_TPORTGRP 0x05
1312 #define SVPD_ID_TYPE_LUNGRP 0x06
1313 #define SVPD_ID_TYPE_MD5_LUN_ID 0x07
1314 #define SVPD_ID_TYPE_SCSI_NAME 0x08
1315 #define SVPD_ID_TYPE_MASK 0x0f
1318 #define SVPD_DEVICE_ID_DESC_HDR_LEN \
1319 __offsetof(struct scsi_vpd_id_descriptor, identifier)
1320 u_int8_t identifier[];
1323 struct scsi_vpd_id_t10
1326 u_int8_t vendor_spec_id[0];
1329 struct scsi_vpd_id_eui64
1331 u_int8_t ieee_company_id[3];
1332 u_int8_t extension_id[5];
1335 struct scsi_vpd_id_naa_basic
1338 /* big endian, packed:
1340 uint8_t naa_desig : 4;
1342 #define SVPD_ID_NAA_NAA_SHIFT 4
1343 #define SVPD_ID_NAA_IEEE_EXT 0x02
1344 #define SVPD_ID_NAA_LOCAL_REG 0x03
1345 #define SVPD_ID_NAA_IEEE_REG 0x05
1346 #define SVPD_ID_NAA_IEEE_REG_EXT 0x06
1350 struct scsi_vpd_id_naa_ieee_extended_id
1353 uint8_t vendor_specific_id_a;
1354 uint8_t ieee_company_id[3];
1355 uint8_t vendor_specific_id_b[4];
1358 struct scsi_vpd_id_naa_local_reg
1361 uint8_t local_value[7];
1364 struct scsi_vpd_id_naa_ieee_reg
1367 uint8_t reg_value[7];
1368 /* big endian, packed:
1369 uint8_t naa_basic : 4;
1370 uint8_t ieee_company_id_0 : 4;
1371 uint8_t ieee_company_id_1[2];
1372 uint8_t ieee_company_id_2 : 4;
1373 uint8_t vendor_specific_id_0 : 4;
1374 uint8_t vendor_specific_id_1[4];
1378 struct scsi_vpd_id_naa_ieee_reg_extended
1381 uint8_t reg_value[15];
1382 /* big endian, packed:
1383 uint8_t naa_basic : 4;
1384 uint8_t ieee_company_id_0 : 4;
1385 uint8_t ieee_company_id_1[2];
1386 uint8_t ieee_company_id_2 : 4;
1387 uint8_t vendor_specific_id_0 : 4;
1388 uint8_t vendor_specific_id_1[4];
1389 uint8_t vendor_specific_id_ext[8];
1393 struct scsi_vpd_id_rel_trgt_port_id
1395 uint8_t obsolete[2];
1396 uint8_t rel_trgt_port_id[2];
1399 struct scsi_vpd_id_trgt_port_grp_id
1401 uint8_t reserved[2];
1402 uint8_t trgt_port_grp[2];
1405 struct scsi_vpd_id_lun_grp_id
1407 uint8_t reserved[2];
1408 uint8_t log_unit_grp[2];
1411 struct scsi_vpd_id_md5_lun_id
1416 struct scsi_vpd_id_scsi_name
1418 uint8_t name_string[256];
1421 struct scsi_service_action_in
1424 uint8_t service_action;
1425 uint8_t action_dependent[13];
1429 struct scsi_diag_page {
1431 uint8_t page_specific_flags;
1437 * ATA Information VPD Page based on
1438 * T10/2126-D Revision 04
1440 #define SVPD_ATA_INFORMATION 0x89
1443 * Block Device Characteristics VPD Page based on
1444 * T10/1799-D Revision 31
1446 struct scsi_vpd_block_characteristics
1450 #define SVPD_BDC 0xB1
1451 u_int8_t page_length[2];
1452 u_int8_t medium_rotation_rate[2];
1453 #define SVPD_BDC_RATE_NOT_REPORTED 0x00
1454 #define SVPD_BDC_RATE_NONE_ROTATING 0x01
1456 u_int8_t nominal_form_factor;
1457 #define SVPD_BDC_FORM_NOT_REPORTED 0x00
1458 #define SVPD_BDC_FORM_5_25INCH 0x01
1459 #define SVPD_BDC_FORM_3_5INCH 0x02
1460 #define SVPD_BDC_FORM_2_5INCH 0x03
1461 #define SVPD_BDC_FORM_1_5INCH 0x04
1462 #define SVPD_BDC_FORM_LESSTHAN_1_5INCH 0x05
1463 u_int8_t reserved2[56];
1467 * Logical Block Provisioning VPD Page based on
1468 * T10/1799-D Revision 31
1470 struct scsi_vpd_logical_block_prov
1474 #define SVPD_LBP 0xB2
1475 u_int8_t page_length[2];
1476 #define SVPD_LBP_PL_BASIC 0x04
1477 u_int8_t threshold_exponent;
1479 #define SVPD_LBP_UNMAP 0x80
1480 #define SVPD_LBP_WS16 0x40
1481 #define SVPD_LBP_WS10 0x20
1482 #define SVPD_LBP_RZ 0x04
1483 #define SVPD_LBP_ANC_SUP 0x02
1484 #define SVPD_LBP_DP 0x01
1486 #define SVPD_LBP_RESOURCE 0x01
1487 #define SVPD_LBP_THIN 0x02
1490 * Provisioning Group Descriptor can be here if SVPD_LBP_DP is set
1491 * Its size can be determined from page_length - 4
1496 * Block Limits VDP Page based on
1497 * T10/1799-D Revision 31
1499 struct scsi_vpd_block_limits
1503 #define SVPD_BLOCK_LIMITS 0xB0
1504 u_int8_t page_length[2];
1505 #define SVPD_BL_PL_BASIC 0x10
1506 #define SVPD_BL_PL_TP 0x3C
1508 u_int8_t max_cmp_write_len;
1509 u_int8_t opt_txfer_len_grain[2];
1510 u_int8_t max_txfer_len[4];
1511 u_int8_t opt_txfer_len[4];
1512 u_int8_t max_prefetch[4];
1513 u_int8_t max_unmap_lba_cnt[4];
1514 u_int8_t max_unmap_blk_cnt[4];
1515 u_int8_t opt_unmap_grain[4];
1516 u_int8_t unmap_grain_align[4];
1517 u_int8_t max_write_same_length[8];
1518 u_int8_t reserved2[20];
1521 struct scsi_read_capacity
1525 #define SRC_RELADR 0x01
1529 #define SRC_PMI 0x01
1533 struct scsi_read_capacity_16
1536 #define SRC16_SERVICE_ACTION 0x10
1537 uint8_t service_action;
1539 uint8_t alloc_len[4];
1540 #define SRC16_PMI 0x01
1541 #define SRC16_RELADR 0x02
1546 struct scsi_read_capacity_data
1552 struct scsi_read_capacity_data_long
1556 #define SRC16_PROT_EN 0x01
1557 #define SRC16_P_TYPE 0x0e
1558 #define SRC16_PTYPE_1 0x00
1559 #define SRC16_PTYPE_2 0x02
1560 #define SRC16_PTYPE_3 0x04
1562 #define SRC16_LBPPBE 0x0f
1563 #define SRC16_PI_EXPONENT 0xf0
1564 #define SRC16_PI_EXPONENT_SHIFT 4
1565 uint8_t prot_lbppbe;
1566 #define SRC16_LALBA 0x3f
1567 #define SRC16_LBPRZ 0x40
1568 #define SRC16_LBPME 0x80
1570 * Alternate versions of these macros that are intended for use on a 16-bit
1571 * version of the lalba_lbp field instead of the array of 2 8 bit numbers.
1573 #define SRC16_LALBA_A 0x3fff
1574 #define SRC16_LBPRZ_A 0x4000
1575 #define SRC16_LBPME_A 0x8000
1576 uint8_t lalba_lbp[2];
1579 struct scsi_report_luns
1583 #define RPL_REPORT_DEFAULT 0x00
1584 #define RPL_REPORT_WELLKNOWN 0x01
1585 #define RPL_REPORT_ALL 0x02
1586 uint8_t select_report;
1587 uint8_t reserved2[3];
1593 struct scsi_report_luns_lundata {
1595 #define RPL_LUNDATA_PERIPH_BUS_MASK 0x3f
1596 #define RPL_LUNDATA_FLAT_LUN_MASK 0x3f
1597 #define RPL_LUNDATA_FLAT_LUN_BITS 0x06
1598 #define RPL_LUNDATA_LUN_TARG_MASK 0x3f
1599 #define RPL_LUNDATA_LUN_BUS_MASK 0xe0
1600 #define RPL_LUNDATA_LUN_LUN_MASK 0x1f
1601 #define RPL_LUNDATA_EXT_LEN_MASK 0x30
1602 #define RPL_LUNDATA_EXT_EAM_MASK 0x0f
1603 #define RPL_LUNDATA_EXT_EAM_WK 0x01
1604 #define RPL_LUNDATA_EXT_EAM_NOT_SPEC 0x0f
1605 #define RPL_LUNDATA_ATYP_MASK 0xc0 /* MBZ for type 0 lun */
1606 #define RPL_LUNDATA_ATYP_PERIPH 0x00
1607 #define RPL_LUNDATA_ATYP_FLAT 0x40
1608 #define RPL_LUNDATA_ATYP_LUN 0x80
1609 #define RPL_LUNDATA_ATYP_EXTLUN 0xc0
1612 struct scsi_report_luns_data {
1613 u_int8_t length[4]; /* length of LUN inventory, in bytes */
1614 u_int8_t reserved[4]; /* unused */
1616 * LUN inventory- we only support the type zero form for now.
1618 struct scsi_report_luns_lundata luns[0];
1621 struct scsi_target_group
1624 uint8_t service_action;
1625 #define STG_PDF_LENGTH 0x00
1626 #define RPL_PDF_EXTENDED 0x20
1627 uint8_t reserved1[4];
1633 struct scsi_target_port_descriptor {
1634 uint8_t reserved[2];
1635 uint8_t relative_target_port_identifier[2];
1636 uint8_t desc_list[];
1639 struct scsi_target_port_group_descriptor {
1641 #define TPG_PRIMARY 0x80
1642 #define TPG_ASYMMETRIC_ACCESS_STATE_MASK 0xf
1643 #define TPG_ASYMMETRIC_ACCESS_OPTIMIZED 0x0
1644 #define TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED 0x1
1645 #define TPG_ASYMMETRIC_ACCESS_STANDBY 0x2
1646 #define TPG_ASYMMETRIC_ACCESS_UNAVAILABLE 0x3
1647 #define TPG_ASYMMETRIC_ACCESS_LBA_DEPENDENT 0x4
1648 #define TPG_ASYMMETRIC_ACCESS_OFFLINE 0xE
1649 #define TPG_ASYMMETRIC_ACCESS_TRANSITIONING 0xF
1651 #define TPG_AO_SUP 0x01
1652 #define TPG_AN_SUP 0x02
1653 #define TPG_S_SUP 0x04
1654 #define TPG_U_SUP 0x08
1655 #define TPG_LBD_SUP 0x10
1656 #define TPG_O_SUP 0x40
1657 #define TPG_T_SUP 0x80
1658 uint8_t target_port_group[2];
1661 #define TPG_UNAVLBL 0
1662 #define TPG_SET_BY_STPG 0x01
1663 #define TPG_IMPLICIT 0x02
1664 uint8_t vendor_specific;
1665 uint8_t target_port_count;
1666 struct scsi_target_port_descriptor descriptors[];
1669 struct scsi_target_group_data {
1670 uint8_t length[4]; /* length of returned data, in bytes */
1671 struct scsi_target_port_group_descriptor groups[];
1674 struct scsi_target_group_data_extended {
1675 uint8_t length[4]; /* length of returned data, in bytes */
1676 uint8_t format_type; /* STG_PDF_LENGTH or RPL_PDF_EXTENDED */
1677 uint8_t implicit_transition_time;
1678 uint8_t reserved[2];
1679 struct scsi_target_port_group_descriptor groups[];
1687 } scsi_sense_data_type;
1699 } scsi_sense_elem_type;
1702 struct scsi_sense_data
1706 * SPC-4 says that the maximum length of sense data is 252 bytes.
1707 * So this structure is exactly 252 bytes log.
1709 #define SSD_FULL_SIZE 252
1710 uint8_t sense_buf[SSD_FULL_SIZE - 1];
1712 * XXX KDM is this still a reasonable minimum size?
1714 #define SSD_MIN_SIZE 18
1716 * Maximum value for the extra_len field in the sense data.
1718 #define SSD_EXTRA_MAX 244
1722 * Fixed format sense data.
1724 struct scsi_sense_data_fixed
1726 u_int8_t error_code;
1727 #define SSD_ERRCODE 0x7F
1728 #define SSD_CURRENT_ERROR 0x70
1729 #define SSD_DEFERRED_ERROR 0x71
1730 #define SSD_ERRCODE_VALID 0x80
1733 #define SSD_KEY 0x0F
1734 #define SSD_KEY_NO_SENSE 0x00
1735 #define SSD_KEY_RECOVERED_ERROR 0x01
1736 #define SSD_KEY_NOT_READY 0x02
1737 #define SSD_KEY_MEDIUM_ERROR 0x03
1738 #define SSD_KEY_HARDWARE_ERROR 0x04
1739 #define SSD_KEY_ILLEGAL_REQUEST 0x05
1740 #define SSD_KEY_UNIT_ATTENTION 0x06
1741 #define SSD_KEY_DATA_PROTECT 0x07
1742 #define SSD_KEY_BLANK_CHECK 0x08
1743 #define SSD_KEY_Vendor_Specific 0x09
1744 #define SSD_KEY_COPY_ABORTED 0x0a
1745 #define SSD_KEY_ABORTED_COMMAND 0x0b
1746 #define SSD_KEY_EQUAL 0x0c
1747 #define SSD_KEY_VOLUME_OVERFLOW 0x0d
1748 #define SSD_KEY_MISCOMPARE 0x0e
1749 #define SSD_KEY_COMPLETED 0x0f
1750 #define SSD_ILI 0x20
1751 #define SSD_EOM 0x40
1752 #define SSD_FILEMARK 0x80
1755 u_int8_t cmd_spec_info[4];
1756 u_int8_t add_sense_code;
1757 u_int8_t add_sense_code_qual;
1759 u_int8_t sense_key_spec[3];
1760 #define SSD_SCS_VALID 0x80
1761 #define SSD_FIELDPTR_CMD 0x40
1762 #define SSD_BITPTR_VALID 0x08
1763 #define SSD_BITPTR_VALUE 0x07
1764 u_int8_t extra_bytes[14];
1765 #define SSD_FIXED_IS_PRESENT(sense, length, field) \
1766 ((length >= (offsetof(struct scsi_sense_data_fixed, field) + \
1767 sizeof(sense->field))) ? 1 :0)
1768 #define SSD_FIXED_IS_FILLED(sense, field) \
1769 ((((offsetof(struct scsi_sense_data_fixed, field) + \
1770 sizeof(sense->field)) - \
1771 (offsetof(struct scsi_sense_data_fixed, extra_len) + \
1772 sizeof(sense->extra_len))) <= sense->extra_len) ? 1 : 0)
1776 * Descriptor format sense data definitions.
1777 * Introduced in SPC-3.
1779 struct scsi_sense_data_desc
1782 #define SSD_DESC_CURRENT_ERROR 0x72
1783 #define SSD_DESC_DEFERRED_ERROR 0x73
1785 uint8_t add_sense_code;
1786 uint8_t add_sense_code_qual;
1787 uint8_t reserved[3];
1789 * Note that SPC-4, section 4.5.2.1 says that the extra_len field
1790 * must be less than or equal to 244.
1793 uint8_t sense_desc[0];
1794 #define SSD_DESC_IS_PRESENT(sense, length, field) \
1795 ((length >= (offsetof(struct scsi_sense_data_desc, field) + \
1796 sizeof(sense->field))) ? 1 :0)
1799 struct scsi_sense_desc_header
1805 * The information provide in the Information descriptor is device type or
1806 * command specific information, and defined in a command standard.
1808 * Note that any changes to the field names or positions in this structure,
1809 * even reserved fields, should be accompanied by an examination of the
1810 * code in ctl_set_sense() that uses them.
1812 * Maximum descriptors allowed: 1 (as of SPC-4)
1814 struct scsi_sense_info
1817 #define SSD_DESC_INFO 0x00
1820 #define SSD_INFO_VALID 0x80
1826 * Command-specific information depends on the command for which the
1827 * reported condition occured.
1829 * Note that any changes to the field names or positions in this structure,
1830 * even reserved fields, should be accompanied by an examination of the
1831 * code in ctl_set_sense() that uses them.
1833 * Maximum descriptors allowed: 1 (as of SPC-4)
1835 struct scsi_sense_command
1838 #define SSD_DESC_COMMAND 0x01
1840 uint8_t reserved[2];
1841 uint8_t command_info[8];
1845 * Sense key specific descriptor. The sense key specific data format
1846 * depends on the sense key in question.
1848 * Maximum descriptors allowed: 1 (as of SPC-4)
1850 struct scsi_sense_sks
1853 #define SSD_DESC_SKS 0x02
1855 uint8_t reserved1[2];
1856 uint8_t sense_key_spec[3];
1857 #define SSD_SKS_VALID 0x80
1862 * This is used for the Illegal Request sense key (0x05) only.
1864 struct scsi_sense_sks_field
1867 #define SSD_SKS_FIELD_VALID 0x80
1868 #define SSD_SKS_FIELD_CMD 0x40
1869 #define SSD_SKS_BPV 0x08
1870 #define SSD_SKS_BIT_VALUE 0x07
1876 * This is used for the Hardware Error (0x04), Medium Error (0x03) and
1877 * Recovered Error (0x01) sense keys.
1879 struct scsi_sense_sks_retry
1882 #define SSD_SKS_RETRY_VALID 0x80
1883 uint8_t actual_retry_count[2];
1887 * Used with the NO Sense (0x00) or Not Ready (0x02) sense keys.
1889 struct scsi_sense_sks_progress
1892 #define SSD_SKS_PROGRESS_VALID 0x80
1893 uint8_t progress[2];
1894 #define SSD_SKS_PROGRESS_DENOM 0x10000
1898 * Used with the Copy Aborted (0x0a) sense key.
1900 struct scsi_sense_sks_segment
1903 #define SSD_SKS_SEGMENT_VALID 0x80
1904 #define SSD_SKS_SEGMENT_SD 0x20
1905 #define SSD_SKS_SEGMENT_BPV 0x08
1906 #define SSD_SKS_SEGMENT_BITPTR 0x07
1911 * Used with the Unit Attention (0x06) sense key.
1913 * This is currently used to indicate that the unit attention condition
1914 * queue has overflowed (when the overflow bit is set).
1916 struct scsi_sense_sks_overflow
1919 #define SSD_SKS_OVERFLOW_VALID 0x80
1920 #define SSD_SKS_OVERFLOW_SET 0x01
1921 uint8_t reserved[2];
1925 * This specifies which component is associated with the sense data. There
1926 * is no standard meaning for the fru value.
1928 * Maximum descriptors allowed: 1 (as of SPC-4)
1930 struct scsi_sense_fru
1933 #define SSD_DESC_FRU 0x03
1940 * Used for Stream commands, defined in SSC-4.
1942 * Maximum descriptors allowed: 1 (as of SPC-4)
1945 struct scsi_sense_stream
1948 #define SSD_DESC_STREAM 0x04
1952 #define SSD_DESC_STREAM_FM 0x80
1953 #define SSD_DESC_STREAM_EOM 0x40
1954 #define SSD_DESC_STREAM_ILI 0x20
1958 * Used for Block commands, defined in SBC-3.
1960 * This is currently (as of SBC-3) only used for the Incorrect Length
1961 * Indication (ILI) bit, which says that the data length requested in the
1962 * READ LONG or WRITE LONG command did not match the length of the logical
1965 * Maximum descriptors allowed: 1 (as of SPC-4)
1967 struct scsi_sense_block
1970 #define SSD_DESC_BLOCK 0x05
1974 #define SSD_DESC_BLOCK_ILI 0x20
1978 * Used for Object-Based Storage Devices (OSD-3).
1980 * Maximum descriptors allowed: 1 (as of SPC-4)
1982 struct scsi_sense_osd_objid
1985 #define SSD_DESC_OSD_OBJID 0x06
1987 uint8_t reserved[6];
1989 * XXX KDM provide the bit definitions here? There are a lot of
1990 * them, and we don't have an OSD driver yet.
1992 uint8_t not_init_cmds[4];
1993 uint8_t completed_cmds[4];
1994 uint8_t partition_id[8];
1995 uint8_t object_id[8];
1999 * Used for Object-Based Storage Devices (OSD-3).
2001 * Maximum descriptors allowed: 1 (as of SPC-4)
2003 struct scsi_sense_osd_integrity
2006 #define SSD_DESC_OSD_INTEGRITY 0x07
2008 uint8_t integ_check_val[32];
2012 * Used for Object-Based Storage Devices (OSD-3).
2014 * Maximum descriptors allowed: 1 (as of SPC-4)
2016 struct scsi_sense_osd_attr_id
2019 #define SSD_DESC_OSD_ATTR_ID 0x08
2021 uint8_t reserved[2];
2022 uint8_t attr_desc[0];
2026 * Used with Sense keys No Sense (0x00) and Not Ready (0x02).
2028 * Maximum descriptors allowed: 32 (as of SPC-4)
2030 struct scsi_sense_progress
2033 #define SSD_DESC_PROGRESS 0x0a
2036 uint8_t add_sense_code;
2037 uint8_t add_sense_code_qual;
2039 uint8_t progress[2];
2043 * This is typically forwarded as the result of an EXTENDED COPY command.
2045 * Maximum descriptors allowed: 2 (as of SPC-4)
2047 struct scsi_sense_forwarded
2050 #define SSD_DESC_FORWARDED 0x0c
2053 #define SSD_FORWARDED_FSDT 0x80
2054 #define SSD_FORWARDED_SDS_MASK 0x0f
2055 #define SSD_FORWARDED_SDS_UNK 0x00
2056 #define SSD_FORWARDED_SDS_EXSRC 0x01
2057 #define SSD_FORWARDED_SDS_EXDST 0x02
2061 * Vendor-specific sense descriptor. The desc_type field will be in the
2062 * range bewteen MIN and MAX inclusive.
2064 struct scsi_sense_vendor
2067 #define SSD_DESC_VENDOR_MIN 0x80
2068 #define SSD_DESC_VENDOR_MAX 0xff
2073 struct scsi_mode_header_6
2075 u_int8_t data_length; /* Sense data length */
2076 u_int8_t medium_type;
2078 u_int8_t blk_desc_len;
2081 struct scsi_mode_header_10
2083 u_int8_t data_length[2];/* Sense data length */
2084 u_int8_t medium_type;
2087 u_int8_t blk_desc_len[2];
2090 struct scsi_mode_page_header
2093 #define SMPH_PS 0x80
2094 #define SMPH_SPF 0x40
2095 #define SMPH_PC_MASK 0x3f
2096 u_int8_t page_length;
2099 struct scsi_mode_page_header_sp
2103 uint8_t page_length[2];
2107 struct scsi_mode_blk_desc
2110 u_int8_t nblocks[3];
2115 #define SCSI_DEFAULT_DENSITY 0x00 /* use 'default' density */
2116 #define SCSI_SAME_DENSITY 0x7f /* use 'same' density- >= SCSI-2 only */
2122 #define SCSI_STATUS_OK 0x00
2123 #define SCSI_STATUS_CHECK_COND 0x02
2124 #define SCSI_STATUS_COND_MET 0x04
2125 #define SCSI_STATUS_BUSY 0x08
2126 #define SCSI_STATUS_INTERMED 0x10
2127 #define SCSI_STATUS_INTERMED_COND_MET 0x14
2128 #define SCSI_STATUS_RESERV_CONFLICT 0x18
2129 #define SCSI_STATUS_CMD_TERMINATED 0x22 /* Obsolete in SAM-2 */
2130 #define SCSI_STATUS_QUEUE_FULL 0x28
2131 #define SCSI_STATUS_ACA_ACTIVE 0x30
2132 #define SCSI_STATUS_TASK_ABORTED 0x40
2134 struct scsi_inquiry_pattern {
2136 u_int8_t media_type;
2137 #define SIP_MEDIA_REMOVABLE 0x01
2138 #define SIP_MEDIA_FIXED 0x02
2140 const char *product;
2141 const char *revision;
2144 struct scsi_static_inquiry_pattern {
2146 u_int8_t media_type;
2147 char vendor[SID_VENDOR_SIZE+1];
2148 char product[SID_PRODUCT_SIZE+1];
2149 char revision[SID_REVISION_SIZE+1];
2152 struct scsi_sense_quirk_entry {
2153 struct scsi_inquiry_pattern inq_pat;
2156 struct sense_key_table_entry *sense_key_info;
2157 struct asc_table_entry *asc_info;
2160 struct sense_key_table_entry {
2166 struct asc_table_entry {
2173 struct op_table_entry {
2179 struct scsi_op_quirk_entry {
2180 struct scsi_inquiry_pattern inq_pat;
2182 struct op_table_entry *op_table;
2186 SSS_FLAG_NONE = 0x00,
2187 SSS_FLAG_PRINT_COMMAND = 0x01
2188 } scsi_sense_string_flags;
2197 extern const char *scsi_sense_key_text[];
2202 void scsi_sense_desc(int sense_key, int asc, int ascq,
2203 struct scsi_inquiry_data *inq_data,
2204 const char **sense_key_desc, const char **asc_desc);
2205 scsi_sense_action scsi_error_action(struct ccb_scsiio* csio,
2206 struct scsi_inquiry_data *inq_data,
2207 u_int32_t sense_flags);
2208 const char * scsi_status_string(struct ccb_scsiio *csio);
2210 void scsi_desc_iterate(struct scsi_sense_data_desc *sense, u_int sense_len,
2211 int (*iter_func)(struct scsi_sense_data_desc *sense,
2212 u_int, struct scsi_sense_desc_header *,
2213 void *), void *arg);
2214 uint8_t *scsi_find_desc(struct scsi_sense_data_desc *sense, u_int sense_len,
2216 void scsi_set_sense_data(struct scsi_sense_data *sense_data,
2217 scsi_sense_data_type sense_format, int current_error,
2218 int sense_key, int asc, int ascq, ...) ;
2219 void scsi_set_sense_data_va(struct scsi_sense_data *sense_data,
2220 scsi_sense_data_type sense_format,
2221 int current_error, int sense_key, int asc,
2222 int ascq, va_list ap);
2223 int scsi_get_sense_info(struct scsi_sense_data *sense_data, u_int sense_len,
2224 uint8_t info_type, uint64_t *info,
2225 int64_t *signed_info);
2226 int scsi_get_sks(struct scsi_sense_data *sense_data, u_int sense_len,
2228 int scsi_get_block_info(struct scsi_sense_data *sense_data, u_int sense_len,
2229 struct scsi_inquiry_data *inq_data,
2230 uint8_t *block_bits);
2231 int scsi_get_stream_info(struct scsi_sense_data *sense_data, u_int sense_len,
2232 struct scsi_inquiry_data *inq_data,
2233 uint8_t *stream_bits);
2234 void scsi_info_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len,
2235 struct scsi_inquiry_data *inq_data, uint64_t info);
2236 void scsi_command_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len,
2237 struct scsi_inquiry_data *inq_data, uint64_t csi);
2238 void scsi_progress_sbuf(struct sbuf *sb, uint16_t progress);
2239 int scsi_sks_sbuf(struct sbuf *sb, int sense_key, uint8_t *sks);
2240 void scsi_fru_sbuf(struct sbuf *sb, uint64_t fru);
2241 void scsi_stream_sbuf(struct sbuf *sb, uint8_t stream_bits, uint64_t info);
2242 void scsi_block_sbuf(struct sbuf *sb, uint8_t block_bits, uint64_t info);
2243 void scsi_sense_info_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2244 u_int sense_len, uint8_t *cdb, int cdb_len,
2245 struct scsi_inquiry_data *inq_data,
2246 struct scsi_sense_desc_header *header);
2248 void scsi_sense_command_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2249 u_int sense_len, uint8_t *cdb, int cdb_len,
2250 struct scsi_inquiry_data *inq_data,
2251 struct scsi_sense_desc_header *header);
2252 void scsi_sense_sks_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2253 u_int sense_len, uint8_t *cdb, int cdb_len,
2254 struct scsi_inquiry_data *inq_data,
2255 struct scsi_sense_desc_header *header);
2256 void scsi_sense_fru_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2257 u_int sense_len, uint8_t *cdb, int cdb_len,
2258 struct scsi_inquiry_data *inq_data,
2259 struct scsi_sense_desc_header *header);
2260 void scsi_sense_stream_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2261 u_int sense_len, uint8_t *cdb, int cdb_len,
2262 struct scsi_inquiry_data *inq_data,
2263 struct scsi_sense_desc_header *header);
2264 void scsi_sense_block_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2265 u_int sense_len, uint8_t *cdb, int cdb_len,
2266 struct scsi_inquiry_data *inq_data,
2267 struct scsi_sense_desc_header *header);
2268 void scsi_sense_progress_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2269 u_int sense_len, uint8_t *cdb, int cdb_len,
2270 struct scsi_inquiry_data *inq_data,
2271 struct scsi_sense_desc_header *header);
2272 void scsi_sense_generic_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2273 u_int sense_len, uint8_t *cdb, int cdb_len,
2274 struct scsi_inquiry_data *inq_data,
2275 struct scsi_sense_desc_header *header);
2276 void scsi_sense_desc_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2277 u_int sense_len, uint8_t *cdb, int cdb_len,
2278 struct scsi_inquiry_data *inq_data,
2279 struct scsi_sense_desc_header *header);
2280 scsi_sense_data_type scsi_sense_type(struct scsi_sense_data *sense_data);
2282 void scsi_sense_only_sbuf(struct scsi_sense_data *sense, u_int sense_len,
2283 struct sbuf *sb, char *path_str,
2284 struct scsi_inquiry_data *inq_data, uint8_t *cdb,
2288 int scsi_command_string(struct ccb_scsiio *csio, struct sbuf *sb);
2289 int scsi_sense_sbuf(struct ccb_scsiio *csio, struct sbuf *sb,
2290 scsi_sense_string_flags flags);
2291 char * scsi_sense_string(struct ccb_scsiio *csio,
2292 char *str, int str_len);
2293 void scsi_sense_print(struct ccb_scsiio *csio);
2294 int scsi_vpd_supported_page(struct cam_periph *periph,
2297 int scsi_command_string(struct cam_device *device,
2298 struct ccb_scsiio *csio, struct sbuf *sb);
2299 int scsi_sense_sbuf(struct cam_device *device,
2300 struct ccb_scsiio *csio, struct sbuf *sb,
2301 scsi_sense_string_flags flags);
2302 char * scsi_sense_string(struct cam_device *device,
2303 struct ccb_scsiio *csio,
2304 char *str, int str_len);
2305 void scsi_sense_print(struct cam_device *device,
2306 struct ccb_scsiio *csio, FILE *ofile);
2307 #endif /* _KERNEL */
2309 const char * scsi_op_desc(u_int16_t opcode,
2310 struct scsi_inquiry_data *inq_data);
2311 char * scsi_cdb_string(u_int8_t *cdb_ptr, char *cdb_string,
2314 void scsi_print_inquiry(struct scsi_inquiry_data *inq_data);
2315 void scsi_print_inquiry_short(struct scsi_inquiry_data *inq_data);
2317 u_int scsi_calc_syncsrate(u_int period_factor);
2318 u_int scsi_calc_syncparam(u_int period);
2320 typedef int (*scsi_devid_checkfn_t)(uint8_t *);
2321 int scsi_devid_is_naa_ieee_reg(uint8_t *bufp);
2322 int scsi_devid_is_sas_target(uint8_t *bufp);
2323 int scsi_devid_is_lun_eui64(uint8_t *bufp);
2324 int scsi_devid_is_lun_naa(uint8_t *bufp);
2325 int scsi_devid_is_lun_name(uint8_t *bufp);
2326 int scsi_devid_is_lun_t10(uint8_t *bufp);
2327 struct scsi_vpd_id_descriptor *
2328 scsi_get_devid(struct scsi_vpd_device_id *id, uint32_t len,
2329 scsi_devid_checkfn_t ck_fn);
2331 void scsi_test_unit_ready(struct ccb_scsiio *csio, u_int32_t retries,
2332 void (*cbfcnp)(struct cam_periph *,
2334 u_int8_t tag_action,
2335 u_int8_t sense_len, u_int32_t timeout);
2337 void scsi_request_sense(struct ccb_scsiio *csio, u_int32_t retries,
2338 void (*cbfcnp)(struct cam_periph *,
2340 void *data_ptr, u_int8_t dxfer_len,
2341 u_int8_t tag_action, u_int8_t sense_len,
2344 void scsi_inquiry(struct ccb_scsiio *csio, u_int32_t retries,
2345 void (*cbfcnp)(struct cam_periph *, union ccb *),
2346 u_int8_t tag_action, u_int8_t *inq_buf,
2347 u_int32_t inq_len, int evpd, u_int8_t page_code,
2348 u_int8_t sense_len, u_int32_t timeout);
2350 void scsi_mode_sense(struct ccb_scsiio *csio, u_int32_t retries,
2351 void (*cbfcnp)(struct cam_periph *,
2353 u_int8_t tag_action, int dbd,
2354 u_int8_t page_code, u_int8_t page,
2355 u_int8_t *param_buf, u_int32_t param_len,
2356 u_int8_t sense_len, u_int32_t timeout);
2358 void scsi_mode_sense_len(struct ccb_scsiio *csio, u_int32_t retries,
2359 void (*cbfcnp)(struct cam_periph *,
2361 u_int8_t tag_action, int dbd,
2362 u_int8_t page_code, u_int8_t page,
2363 u_int8_t *param_buf, u_int32_t param_len,
2364 int minimum_cmd_size, u_int8_t sense_len,
2367 void scsi_mode_select(struct ccb_scsiio *csio, u_int32_t retries,
2368 void (*cbfcnp)(struct cam_periph *,
2370 u_int8_t tag_action, int scsi_page_fmt,
2371 int save_pages, u_int8_t *param_buf,
2372 u_int32_t param_len, u_int8_t sense_len,
2375 void scsi_mode_select_len(struct ccb_scsiio *csio, u_int32_t retries,
2376 void (*cbfcnp)(struct cam_periph *,
2378 u_int8_t tag_action, int scsi_page_fmt,
2379 int save_pages, u_int8_t *param_buf,
2380 u_int32_t param_len, int minimum_cmd_size,
2381 u_int8_t sense_len, u_int32_t timeout);
2383 void scsi_log_sense(struct ccb_scsiio *csio, u_int32_t retries,
2384 void (*cbfcnp)(struct cam_periph *, union ccb *),
2385 u_int8_t tag_action, u_int8_t page_code,
2386 u_int8_t page, int save_pages, int ppc,
2387 u_int32_t paramptr, u_int8_t *param_buf,
2388 u_int32_t param_len, u_int8_t sense_len,
2391 void scsi_log_select(struct ccb_scsiio *csio, u_int32_t retries,
2392 void (*cbfcnp)(struct cam_periph *,
2393 union ccb *), u_int8_t tag_action,
2394 u_int8_t page_code, int save_pages,
2395 int pc_reset, u_int8_t *param_buf,
2396 u_int32_t param_len, u_int8_t sense_len,
2399 void scsi_prevent(struct ccb_scsiio *csio, u_int32_t retries,
2400 void (*cbfcnp)(struct cam_periph *, union ccb *),
2401 u_int8_t tag_action, u_int8_t action,
2402 u_int8_t sense_len, u_int32_t timeout);
2404 void scsi_read_capacity(struct ccb_scsiio *csio, u_int32_t retries,
2405 void (*cbfcnp)(struct cam_periph *,
2406 union ccb *), u_int8_t tag_action,
2407 struct scsi_read_capacity_data *,
2408 u_int8_t sense_len, u_int32_t timeout);
2409 void scsi_read_capacity_16(struct ccb_scsiio *csio, uint32_t retries,
2410 void (*cbfcnp)(struct cam_periph *,
2411 union ccb *), uint8_t tag_action,
2412 uint64_t lba, int reladr, int pmi,
2413 struct scsi_read_capacity_data_long
2414 *rcap_buf, uint8_t sense_len,
2417 void scsi_report_luns(struct ccb_scsiio *csio, u_int32_t retries,
2418 void (*cbfcnp)(struct cam_periph *,
2419 union ccb *), u_int8_t tag_action,
2420 u_int8_t select_report,
2421 struct scsi_report_luns_data *rpl_buf,
2422 u_int32_t alloc_len, u_int8_t sense_len,
2425 void scsi_report_target_group(struct ccb_scsiio *csio, u_int32_t retries,
2426 void (*cbfcnp)(struct cam_periph *,
2427 union ccb *), u_int8_t tag_action,
2430 u_int32_t alloc_len, u_int8_t sense_len,
2433 void scsi_set_target_group(struct ccb_scsiio *csio, u_int32_t retries,
2434 void (*cbfcnp)(struct cam_periph *,
2435 union ccb *), u_int8_t tag_action, void *buf,
2436 u_int32_t alloc_len, u_int8_t sense_len,
2439 void scsi_synchronize_cache(struct ccb_scsiio *csio,
2441 void (*cbfcnp)(struct cam_periph *,
2442 union ccb *), u_int8_t tag_action,
2443 u_int32_t begin_lba, u_int16_t lb_count,
2444 u_int8_t sense_len, u_int32_t timeout);
2446 void scsi_receive_diagnostic_results(struct ccb_scsiio *csio, u_int32_t retries,
2447 void (*cbfcnp)(struct cam_periph *,
2449 uint8_t tag_action, int pcv,
2450 uint8_t page_code, uint8_t *data_ptr,
2451 uint16_t allocation_length,
2452 uint8_t sense_len, uint32_t timeout);
2454 void scsi_send_diagnostic(struct ccb_scsiio *csio, u_int32_t retries,
2455 void (*cbfcnp)(struct cam_periph *, union ccb *),
2456 uint8_t tag_action, int unit_offline,
2457 int device_offline, int self_test, int page_format,
2458 int self_test_code, uint8_t *data_ptr,
2459 uint16_t param_list_length, uint8_t sense_len,
2462 void scsi_read_buffer(struct ccb_scsiio *csio, u_int32_t retries,
2463 void (*cbfcnp)(struct cam_periph *, union ccb*),
2464 uint8_t tag_action, int mode,
2465 uint8_t buffer_id, u_int32_t offset,
2466 uint8_t *data_ptr, uint32_t allocation_length,
2467 uint8_t sense_len, uint32_t timeout);
2469 void scsi_write_buffer(struct ccb_scsiio *csio, u_int32_t retries,
2470 void (*cbfcnp)(struct cam_periph *, union ccb *),
2471 uint8_t tag_action, int mode,
2472 uint8_t buffer_id, u_int32_t offset,
2473 uint8_t *data_ptr, uint32_t param_list_length,
2474 uint8_t sense_len, uint32_t timeout);
2476 #define SCSI_RW_READ 0x0001
2477 #define SCSI_RW_WRITE 0x0002
2478 #define SCSI_RW_DIRMASK 0x0003
2479 #define SCSI_RW_BIO 0x1000
2480 void scsi_read_write(struct ccb_scsiio *csio, u_int32_t retries,
2481 void (*cbfcnp)(struct cam_periph *, union ccb *),
2482 u_int8_t tag_action, int readop, u_int8_t byte2,
2483 int minimum_cmd_size, u_int64_t lba,
2484 u_int32_t block_count, u_int8_t *data_ptr,
2485 u_int32_t dxfer_len, u_int8_t sense_len,
2488 void scsi_write_same(struct ccb_scsiio *csio, u_int32_t retries,
2489 void (*cbfcnp)(struct cam_periph *, union ccb *),
2490 u_int8_t tag_action, u_int8_t byte2,
2491 int minimum_cmd_size, u_int64_t lba,
2492 u_int32_t block_count, u_int8_t *data_ptr,
2493 u_int32_t dxfer_len, u_int8_t sense_len,
2496 void scsi_ata_identify(struct ccb_scsiio *csio, u_int32_t retries,
2497 void (*cbfcnp)(struct cam_periph *, union ccb *),
2498 u_int8_t tag_action, u_int8_t *data_ptr,
2499 u_int16_t dxfer_len, u_int8_t sense_len,
2502 void scsi_ata_trim(struct ccb_scsiio *csio, u_int32_t retries,
2503 void (*cbfcnp)(struct cam_periph *, union ccb *),
2504 u_int8_t tag_action, u_int16_t block_count,
2505 u_int8_t *data_ptr, u_int16_t dxfer_len,
2506 u_int8_t sense_len, u_int32_t timeout);
2508 void scsi_ata_pass_16(struct ccb_scsiio *csio, u_int32_t retries,
2509 void (*cbfcnp)(struct cam_periph *, union ccb *),
2510 u_int32_t flags, u_int8_t tag_action,
2511 u_int8_t protocol, u_int8_t ata_flags, u_int16_t features,
2512 u_int16_t sector_count, uint64_t lba, u_int8_t command,
2513 u_int8_t control, u_int8_t *data_ptr, u_int16_t dxfer_len,
2514 u_int8_t sense_len, u_int32_t timeout);
2516 void scsi_unmap(struct ccb_scsiio *csio, u_int32_t retries,
2517 void (*cbfcnp)(struct cam_periph *, union ccb *),
2518 u_int8_t tag_action, u_int8_t byte2,
2519 u_int8_t *data_ptr, u_int16_t dxfer_len,
2520 u_int8_t sense_len, u_int32_t timeout);
2522 void scsi_start_stop(struct ccb_scsiio *csio, u_int32_t retries,
2523 void (*cbfcnp)(struct cam_periph *, union ccb *),
2524 u_int8_t tag_action, int start, int load_eject,
2525 int immediate, u_int8_t sense_len, u_int32_t timeout);
2527 int scsi_inquiry_match(caddr_t inqbuffer, caddr_t table_entry);
2528 int scsi_static_inquiry_match(caddr_t inqbuffer,
2529 caddr_t table_entry);
2530 int scsi_devid_match(uint8_t *rhs, size_t rhs_len,
2531 uint8_t *lhs, size_t lhs_len);
2533 void scsi_extract_sense(struct scsi_sense_data *sense, int *error_code,
2534 int *sense_key, int *asc, int *ascq);
2535 int scsi_extract_sense_ccb(union ccb *ccb, int *error_code, int *sense_key,
2536 int *asc, int *ascq);
2537 void scsi_extract_sense_len(struct scsi_sense_data *sense,
2538 u_int sense_len, int *error_code, int *sense_key,
2539 int *asc, int *ascq, int show_errors);
2540 int scsi_get_sense_key(struct scsi_sense_data *sense, u_int sense_len,
2542 int scsi_get_asc(struct scsi_sense_data *sense, u_int sense_len,
2544 int scsi_get_ascq(struct scsi_sense_data *sense, u_int sense_len,
2546 static __inline void scsi_ulto2b(u_int32_t val, u_int8_t *bytes);
2547 static __inline void scsi_ulto3b(u_int32_t val, u_int8_t *bytes);
2548 static __inline void scsi_ulto4b(u_int32_t val, u_int8_t *bytes);
2549 static __inline void scsi_u64to8b(u_int64_t val, u_int8_t *bytes);
2550 static __inline uint32_t scsi_2btoul(const uint8_t *bytes);
2551 static __inline uint32_t scsi_3btoul(const uint8_t *bytes);
2552 static __inline int32_t scsi_3btol(const uint8_t *bytes);
2553 static __inline uint32_t scsi_4btoul(const uint8_t *bytes);
2554 static __inline uint64_t scsi_8btou64(const uint8_t *bytes);
2555 static __inline void *find_mode_page_6(struct scsi_mode_header_6 *mode_header);
2556 static __inline void *find_mode_page_10(struct scsi_mode_header_10 *mode_header);
2558 static __inline void
2559 scsi_ulto2b(u_int32_t val, u_int8_t *bytes)
2562 bytes[0] = (val >> 8) & 0xff;
2563 bytes[1] = val & 0xff;
2566 static __inline void
2567 scsi_ulto3b(u_int32_t val, u_int8_t *bytes)
2570 bytes[0] = (val >> 16) & 0xff;
2571 bytes[1] = (val >> 8) & 0xff;
2572 bytes[2] = val & 0xff;
2575 static __inline void
2576 scsi_ulto4b(u_int32_t val, u_int8_t *bytes)
2579 bytes[0] = (val >> 24) & 0xff;
2580 bytes[1] = (val >> 16) & 0xff;
2581 bytes[2] = (val >> 8) & 0xff;
2582 bytes[3] = val & 0xff;
2585 static __inline void
2586 scsi_u64to8b(u_int64_t val, u_int8_t *bytes)
2589 bytes[0] = (val >> 56) & 0xff;
2590 bytes[1] = (val >> 48) & 0xff;
2591 bytes[2] = (val >> 40) & 0xff;
2592 bytes[3] = (val >> 32) & 0xff;
2593 bytes[4] = (val >> 24) & 0xff;
2594 bytes[5] = (val >> 16) & 0xff;
2595 bytes[6] = (val >> 8) & 0xff;
2596 bytes[7] = val & 0xff;
2599 static __inline uint32_t
2600 scsi_2btoul(const uint8_t *bytes)
2604 rv = (bytes[0] << 8) |
2609 static __inline uint32_t
2610 scsi_3btoul(const uint8_t *bytes)
2614 rv = (bytes[0] << 16) |
2620 static __inline int32_t
2621 scsi_3btol(const uint8_t *bytes)
2623 uint32_t rc = scsi_3btoul(bytes);
2625 if (rc & 0x00800000)
2628 return (int32_t) rc;
2631 static __inline uint32_t
2632 scsi_4btoul(const uint8_t *bytes)
2636 rv = (bytes[0] << 24) |
2643 static __inline uint64_t
2644 scsi_8btou64(const uint8_t *bytes)
2648 rv = (((uint64_t)bytes[0]) << 56) |
2649 (((uint64_t)bytes[1]) << 48) |
2650 (((uint64_t)bytes[2]) << 40) |
2651 (((uint64_t)bytes[3]) << 32) |
2652 (((uint64_t)bytes[4]) << 24) |
2653 (((uint64_t)bytes[5]) << 16) |
2654 (((uint64_t)bytes[6]) << 8) |
2660 * Given the pointer to a returned mode sense buffer, return a pointer to
2661 * the start of the first mode page.
2663 static __inline void *
2664 find_mode_page_6(struct scsi_mode_header_6 *mode_header)
2668 page_start = (void *)((u_int8_t *)&mode_header[1] +
2669 mode_header->blk_desc_len);
2674 static __inline void *
2675 find_mode_page_10(struct scsi_mode_header_10 *mode_header)
2679 page_start = (void *)((u_int8_t *)&mode_header[1] +
2680 scsi_2btoul(mode_header->blk_desc_len));
2687 #endif /*_SCSI_SCSI_ALL_H*/