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>
31 * This is the number of seconds we wait for devices to settle after a SCSI
34 extern int scsi_delay;
42 * Define dome bits that are in ALL (or a lot of) scsi commands
44 #define SCSI_CTL_LINK 0x01
45 #define SCSI_CTL_FLAG 0x02
46 #define SCSI_CTL_VENDOR 0xC0
47 #define SCSI_CMD_LUN 0xA0 /* these two should not be needed */
48 #define SCSI_CMD_LUN_SHIFT 5 /* LUN in the cmd is no longer SCSI */
50 #define SCSI_MAX_CDBLEN 16 /*
51 * 16 byte commands are in the
54 #if defined(CAM_MAX_CDBLEN) && (CAM_MAX_CDBLEN < SCSI_MAX_CDBLEN)
55 #error "CAM_MAX_CDBLEN cannot be less than SCSI_MAX_CDBLEN"
58 /* 6byte CDBs special case 0 length to be 256 */
59 #define SCSI_CDB6_LEN(len) ((len) == 0 ? 256 : len)
62 * This type defines actions to be taken when a particular sense code is
63 * received. Right now, these flags are only defined to take up 16 bits,
64 * but can be expanded in the future if necessary.
67 SS_NOP = 0x000000, /* Do nothing */
68 SS_RETRY = 0x010000, /* Retry the command */
69 SS_FAIL = 0x020000, /* Bail out */
70 SS_START = 0x030000, /* Send a Start Unit command to the device,
71 * then retry the original command.
73 SS_TUR = 0x040000, /* Send a Test Unit Ready command to the
74 * device, then retry the original command.
76 SS_REQSENSE = 0x050000, /* Send a RequestSense command to the
77 * device, then retry the original command.
84 SSQ_DECREMENT_COUNT = 0x0100, /* Decrement the retry count */
85 SSQ_MANY = 0x0200, /* send lots of recovery commands */
86 SSQ_RANGE = 0x0400, /*
87 * This table entry represents the
88 * end of a range of ASCQs that
89 * have identical error actions
92 SSQ_PRINT_SENSE = 0x0800,
94 } scsi_sense_action_qualifier;
96 /* Mask for error status values */
97 #define SS_ERRMASK 0xff
99 /* The default, retyable, error action */
100 #define SS_RDEF SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE|EIO
102 /* The retyable, error action, with table specified error code */
103 #define SS_RET SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE
105 /* Fatal error action, with table specified error code */
106 #define SS_FATAL SS_FAIL|SSQ_PRINT_SENSE
114 struct scsi_request_sense
123 struct scsi_test_unit_ready
131 struct scsi_send_diag
137 #define SSD_SELFTEST 0x04
140 u_int8_t paramlen[2];
164 struct scsi_mode_sense_6
170 #define SMS_PAGE_CODE 0x3F
171 #define SMS_VENDOR_SPECIFIC_PAGE 0x00
172 #define SMS_DISCONNECT_RECONNECT_PAGE 0x02
173 #define SMS_FORMAT_DEVICE_PAGE 0x03
174 #define SMS_GEOMETRY_PAGE 0x04
175 #define SMS_CACHE_PAGE 0x08
176 #define SMS_PERIPHERAL_DEVICE_PAGE 0x09
177 #define SMS_CONTROL_MODE_PAGE 0x0A
178 #define SMS_PROTO_SPECIFIC_PAGE 0x19
179 #define SMS_INFO_EXCEPTIONS_PAGE 0x1C
180 #define SMS_ALL_PAGES_PAGE 0x3F
181 #define SMS_PAGE_CTRL_MASK 0xC0
182 #define SMS_PAGE_CTRL_CURRENT 0x00
183 #define SMS_PAGE_CTRL_CHANGEABLE 0x40
184 #define SMS_PAGE_CTRL_DEFAULT 0x80
185 #define SMS_PAGE_CTRL_SAVED 0xC0
191 struct scsi_mode_sense_10
194 u_int8_t byte2; /* same bits as small version */
195 u_int8_t page; /* same bits as small version */
201 struct scsi_mode_select_6
212 struct scsi_mode_select_10
215 u_int8_t byte2; /* same bits as small version */
222 * When sending a mode select to a tape drive, the medium type must be 0.
224 struct scsi_mode_hdr_6
227 u_int8_t medium_type;
228 u_int8_t dev_specific;
229 u_int8_t block_descr_len;
232 struct scsi_mode_hdr_10
235 u_int8_t medium_type;
236 u_int8_t dev_specific;
237 u_int8_t reserved[2];
238 u_int8_t block_descr_len[2];
241 struct scsi_mode_block_descr
243 u_int8_t density_code;
244 u_int8_t num_blocks[3];
246 u_int8_t block_len[3];
249 struct scsi_log_sense
256 #define SLS_PAGE_CODE 0x3F
257 #define SLS_ALL_PAGES_PAGE 0x00
258 #define SLS_OVERRUN_PAGE 0x01
259 #define SLS_ERROR_WRITE_PAGE 0x02
260 #define SLS_ERROR_READ_PAGE 0x03
261 #define SLS_ERROR_READREVERSE_PAGE 0x04
262 #define SLS_ERROR_VERIFY_PAGE 0x05
263 #define SLS_ERROR_NONMEDIUM_PAGE 0x06
264 #define SLS_ERROR_LASTN_PAGE 0x07
265 #define SLS_SELF_TEST_PAGE 0x10
266 #define SLS_IE_PAGE 0x2f
267 #define SLS_PAGE_CTRL_MASK 0xC0
268 #define SLS_PAGE_CTRL_THRESHOLD 0x00
269 #define SLS_PAGE_CTRL_CUMULATIVE 0x40
270 #define SLS_PAGE_CTRL_THRESH_DEFAULT 0x80
271 #define SLS_PAGE_CTRL_CUMUL_DEFAULT 0xC0
272 u_int8_t reserved[2];
273 u_int8_t paramptr[2];
278 struct scsi_log_select
285 /* SLS_PAGE_CTRL_MASK 0xC0 */
286 /* SLS_PAGE_CTRL_THRESHOLD 0x00 */
287 /* SLS_PAGE_CTRL_CUMULATIVE 0x40 */
288 /* SLS_PAGE_CTRL_THRESH_DEFAULT 0x80 */
289 /* SLS_PAGE_CTRL_CUMUL_DEFAULT 0xC0 */
290 u_int8_t reserved[4];
295 struct scsi_log_header
302 struct scsi_log_param_header {
303 u_int8_t param_code[2];
304 u_int8_t param_control;
306 #define SLP_LBIN 0x02
307 #define SLP_TMC_MASK 0x0C
308 #define SLP_TMC_ALWAYS 0x00
309 #define SLP_TMC_EQUAL 0x04
310 #define SLP_TMC_NOTEQUAL 0x08
311 #define SLP_TMC_GREATER 0x0C
319 struct scsi_control_page {
321 u_int8_t page_length;
323 #define SCB_RLEC 0x01 /*Report Log Exception Cond*/
324 u_int8_t queue_flags;
325 #define SCP_QUEUE_ALG_MASK 0xF0
326 #define SCP_QUEUE_ALG_RESTRICTED 0x00
327 #define SCP_QUEUE_ALG_UNRESTRICTED 0x10
328 #define SCP_QUEUE_ERR 0x02 /*Queued I/O aborted for CACs*/
329 #define SCP_QUEUE_DQUE 0x01 /*Queued I/O disabled*/
330 u_int8_t eca_and_aen;
331 #define SCP_EECA 0x80 /*Enable Extended CA*/
332 #define SCP_RAENP 0x04 /*Ready AEN Permission*/
333 #define SCP_UAAENP 0x02 /*UA AEN Permission*/
334 #define SCP_EAENP 0x01 /*Error AEN Permission*/
336 u_int8_t aen_holdoff_period[2];
339 struct scsi_cache_page {
341 #define SCHP_PAGE_SAVABLE 0x80 /* Page is savable */
342 u_int8_t page_length;
343 u_int8_t cache_flags;
344 #define SCHP_FLAGS_WCE 0x04 /* Write Cache Enable */
345 #define SCHP_FLAGS_MF 0x02 /* Multiplication factor */
346 #define SCHP_FLAGS_RCD 0x01 /* Read Cache Disable */
347 u_int8_t rw_cache_policy;
348 u_int8_t dis_prefetch[2];
349 u_int8_t min_prefetch[2];
350 u_int8_t max_prefetch[2];
351 u_int8_t max_prefetch_ceil[2];
354 struct scsi_info_exceptions_page {
356 #define SIEP_PAGE_SAVABLE 0x80 /* Page is savable */
357 u_int8_t page_length;
359 #define SIEP_FLAGS_PERF 0x80
360 #define SIEP_FLAGS_EBF 0x20
361 #define SIEP_FLAGS_EWASC 0x10
362 #define SIEP_FLAGS_DEXCPT 0x08
363 #define SIEP_FLAGS_TEST 0x04
364 #define SIEP_FLAGS_EBACKERR 0x02
365 #define SIEP_FLAGS_LOGERR 0x01
367 u_int8_t interval_timer[4];
368 u_int8_t report_count[4];
371 struct scsi_proto_specific_page {
373 #define SPSP_PAGE_SAVABLE 0x80 /* Page is savable */
374 u_int8_t page_length;
376 #define SPSP_PROTO_FC 0x00
377 #define SPSP_PROTO_SPI 0x01
378 #define SPSP_PROTO_SSA 0x02
379 #define SPSP_PROTO_1394 0x03
380 #define SPSP_PROTO_RDMA 0x04
381 #define SPSP_PROTO_ISCSI 0x05
382 #define SPSP_PROTO_SAS 0x06
383 #define SPSP_PROTO_ADT 0x07
384 #define SPSP_PROTO_ATA 0x08
385 #define SPSP_PROTO_NONE 0x0f
414 #define PR_PREVENT 0x01
415 #define PR_ALLOW 0x00
417 struct scsi_sync_cache
421 u_int8_t begin_lba[4];
423 u_int8_t lb_count[2];
428 struct scsi_changedef
439 struct scsi_read_buffer
443 #define RWB_MODE 0x07
444 #define RWB_MODE_HDR_DATA 0x00
445 #define RWB_MODE_DATA 0x02
446 #define RWB_MODE_DOWNLOAD 0x04
447 #define RWB_MODE_DOWNLOAD_SAVE 0x05
454 struct scsi_write_buffer
468 /* only 5 bits are valid in the MSB address byte */
469 #define SRW_TOPADDR 0x1F
477 #define SRW10_RELADDR 0x01
478 /* EBP defined for WRITE(10) only */
479 #define SRW10_EBP 0x04
480 #define SRW10_FUA 0x08
481 #define SRW10_DPO 0x10
492 #define SRW12_RELADDR 0x01
493 #define SRW12_FUA 0x08
494 #define SRW12_DPO 0x10
505 #define SRW16_RELADDR 0x01
506 #define SRW16_FUA 0x08
507 #define SRW16_DPO 0x10
515 struct scsi_start_stop_unit
519 #define SSS_IMMED 0x01
520 u_int8_t reserved[2];
522 #define SSS_START 0x01
523 #define SSS_LOEJ 0x02
530 #define AP_MULTI 0xe0
532 #define AP_T_LEN 0x03
534 #define AP_T_DIR 0x08
535 #define AP_CK_COND 0x20
536 #define AP_OFFLINE 0x60
538 u_int8_t sector_count;
551 #define AP_EXTEND 0x01
553 u_int8_t features_ext;
555 u_int8_t sector_count_ext;
556 u_int8_t sector_count;
557 u_int8_t lba_low_ext;
559 u_int8_t lba_mid_ext;
561 u_int8_t lba_high_ext;
568 #define SC_SCSI_1 0x01
569 #define SC_SCSI_2 0x03
575 #define TEST_UNIT_READY 0x00
576 #define REQUEST_SENSE 0x03
580 #define MODE_SELECT_6 0x15
581 #define MODE_SENSE_6 0x1A
582 #define START_STOP_UNIT 0x1B
583 #define START_STOP 0x1B
586 #define RECEIVE_DIAGNOSTIC 0x1C
587 #define SEND_DIAGNOSTIC 0x1D
588 #define PREVENT_ALLOW 0x1E
589 #define READ_CAPACITY 0x25
591 #define WRITE_10 0x2A
592 #define POSITION_TO_ELEMENT 0x2B
593 #define SYNCHRONIZE_CACHE 0x35
594 #define READ_DEFECT_DATA_10 0x37
595 #define WRITE_BUFFER 0x3B
596 #define READ_BUFFER 0x3C
597 #define CHANGE_DEFINITION 0x40
598 #define LOG_SELECT 0x4C
599 #define LOG_SENSE 0x4D
600 #define MODE_SELECT_10 0x55
601 #define MODE_SENSE_10 0x5A
602 #define ATA_PASS_16 0x85
604 #define WRITE_16 0x8A
605 #define SERVICE_ACTION_IN 0x9E
606 #define REPORT_LUNS 0xA0
607 #define ATA_PASS_12 0xA1
608 #define MAINTENANCE_IN 0xA3
609 #define MAINTENANCE_OUT 0xA4
610 #define MOVE_MEDIUM 0xA5
612 #define WRITE_12 0xAA
613 #define READ_ELEMENT_STATUS 0xB8
615 /* Maintenance In Service Action Codes */
616 #define REPORT_IDENTIFYING_INFRMATION 0x05
617 #define REPORT_TARGET_PORT_GROUPS 0x0A
618 #define REPORT_ALIASES 0x0B
619 #define REPORT_SUPPORTED_OPERATION_CODES 0x0C
620 #define REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS 0x0D
621 #define REPORT_PRIORITY 0x0E
622 #define REPORT_TIMESTAMP 0x0F
623 #define MANAGEMENT_PROTOCOL_IN 0x10
624 /* Maintenance Out Service Action Codes */
625 #define SET_IDENTIFY_INFORMATION 0x06
626 #define SET_TARGET_PORT_GROUPS 0x0A
627 #define CHANGE_ALIASES 0x0B
628 #define SET_PRIORITY 0x0E
629 #define SET_TIMESTAMP 0x0F
630 #define MANGAEMENT_PROTOCOL_OUT 0x10
635 #define T_DIRECT 0x00
636 #define T_SEQUENTIAL 0x01
637 #define T_PRINTER 0x02
638 #define T_PROCESSOR 0x03
641 #define T_SCANNER 0x06
642 #define T_OPTICAL 0x07
643 #define T_CHANGER 0x08
647 #define T_STORARRAY 0x0c
648 #define T_ENCLOSURE 0x0d
653 #define T_NODEVICE 0x1f
654 #define T_ANY 0xff /* Used in Quirk table matches */
660 * This length is the initial inquiry length used by the probe code, as
661 * well as the legnth necessary for scsi_print_inquiry() to function
662 * correctly. If either use requires a different length in the future,
663 * the two values should be de-coupled.
665 #define SHORT_INQUIRY_LENGTH 36
667 struct scsi_inquiry_data
670 #define SID_TYPE(inq_data) ((inq_data)->device & 0x1f)
671 #define SID_QUAL(inq_data) (((inq_data)->device & 0xE0) >> 5)
672 #define SID_QUAL_LU_CONNECTED 0x00 /*
673 * The specified peripheral device
674 * type is currently connected to
675 * logical unit. If the target cannot
676 * determine whether or not a physical
677 * device is currently connected, it
678 * shall also use this peripheral
679 * qualifier when returning the INQUIRY
680 * data. This peripheral qualifier
681 * does not mean that the device is
682 * ready for access by the initiator.
684 #define SID_QUAL_LU_OFFLINE 0x01 /*
685 * The target is capable of supporting
686 * the specified peripheral device type
687 * on this logical unit; however, the
688 * physical device is not currently
689 * connected to this logical unit.
691 #define SID_QUAL_RSVD 0x02
692 #define SID_QUAL_BAD_LU 0x03 /*
693 * The target is not capable of
694 * supporting a physical device on
695 * this logical unit. For this
696 * peripheral qualifier the peripheral
697 * device type shall be set to 1Fh to
698 * provide compatibility with previous
699 * versions of SCSI. All other
700 * peripheral device type values are
701 * reserved for this peripheral
704 #define SID_QUAL_IS_VENDOR_UNIQUE(inq_data) ((SID_QUAL(inq_data) & 0x08) != 0)
706 #define SID_QUAL2 0x7F
707 #define SID_IS_REMOVABLE(inq_data) (((inq_data)->dev_qual2 & 0x80) != 0)
709 #define SID_ANSI_REV(inq_data) ((inq_data)->version & 0x07)
711 #define SCSI_REV_CCS 1
713 #define SCSI_REV_SPC 3
714 #define SCSI_REV_SPC2 4
715 #define SCSI_REV_SPC3 5
716 #define SCSI_REV_SPC4 6
718 #define SID_ECMA 0x38
720 u_int8_t response_format;
721 #define SID_AENC 0x80
722 #define SID_TrmIOP 0x40
723 u_int8_t additional_length;
724 #define SID_ADDITIONAL_LENGTH(iqd) \
725 ((iqd)->additional_length + \
726 offsetof(struct scsi_inquiry_data, additional_length) + 1)
728 #define SPC3_SID_PROTECT 0x01
729 #define SPC3_SID_3PC 0x08
730 #define SPC3_SID_TPGS_MASK 0x30
731 #define SPC3_SID_TPGS_IMPLICIT 0x10
732 #define SPC3_SID_TPGS_EXPLICIT 0x20
733 #define SPC3_SID_ACC 0x40
734 #define SPC3_SID_SCCS 0x80
736 #define SPC2_SID_MChngr 0x08
737 #define SPC2_SID_MultiP 0x10
738 #define SPC2_SID_EncServ 0x40
739 #define SPC2_SID_BQueue 0x80
741 #define INQ_DATA_TQ_ENABLED(iqd) \
742 ((SID_ANSI_REV(iqd) < SCSI_REV_SPC2)? ((iqd)->flags & SID_CmdQue) : \
743 (((iqd)->flags & SID_CmdQue) && !((iqd)->spc2_flags & SPC2_SID_BQueue)) || \
744 (!((iqd)->flags & SID_CmdQue) && ((iqd)->spc2_flags & SPC2_SID_BQueue)))
747 #define SID_SftRe 0x01
748 #define SID_CmdQue 0x02
749 #define SID_Linked 0x08
750 #define SID_Sync 0x10
751 #define SID_WBus16 0x20
752 #define SID_WBus32 0x40
753 #define SID_RelAdr 0x80
754 #define SID_VENDOR_SIZE 8
755 char vendor[SID_VENDOR_SIZE];
756 #define SID_PRODUCT_SIZE 16
757 char product[SID_PRODUCT_SIZE];
758 #define SID_REVISION_SIZE 4
759 char revision[SID_REVISION_SIZE];
761 * The following fields were taken from SCSI Primary Commands - 2
762 * (SPC-2) Revision 14, Dated 11 November 1999
764 #define SID_VENDOR_SPECIFIC_0_SIZE 20
765 u_int8_t vendor_specific0[SID_VENDOR_SPECIFIC_0_SIZE];
767 * An extension of SCSI Parallel Specific Values
769 #define SID_SPI_IUS 0x01
770 #define SID_SPI_QAS 0x02
771 #define SID_SPI_CLOCK_ST 0x00
772 #define SID_SPI_CLOCK_DT 0x04
773 #define SID_SPI_CLOCK_DT_ST 0x0C
774 #define SID_SPI_MASK 0x0F
778 * Version Descriptors, stored 2 byte values.
780 u_int8_t version1[2];
781 u_int8_t version2[2];
782 u_int8_t version3[2];
783 u_int8_t version4[2];
784 u_int8_t version5[2];
785 u_int8_t version6[2];
786 u_int8_t version7[2];
787 u_int8_t version8[2];
789 u_int8_t reserved3[22];
791 #define SID_VENDOR_SPECIFIC_1_SIZE 160
792 u_int8_t vendor_specific1[SID_VENDOR_SPECIFIC_1_SIZE];
795 struct scsi_vpd_supported_page_list
799 #define SVPD_SUPPORTED_PAGE_LIST 0x00
801 u_int8_t length; /* number of VPD entries */
802 #define SVPD_SUPPORTED_PAGES_SIZE 251
803 u_int8_t list[SVPD_SUPPORTED_PAGES_SIZE];
806 struct scsi_vpd_unit_serial_number
810 #define SVPD_UNIT_SERIAL_NUMBER 0x80
812 u_int8_t length; /* serial number length */
813 #define SVPD_SERIAL_NUM_SIZE 251
814 u_int8_t serial_num[SVPD_SERIAL_NUM_SIZE];
817 struct scsi_read_capacity
826 struct scsi_read_capacity_16
829 #define SRC16_SERVICE_ACTION 0x10
830 uint8_t service_action;
832 uint8_t alloc_len[4];
833 #define SRC16_PMI 0x01
834 #define SRC16_RELADR 0x02
839 struct scsi_read_capacity_data
845 struct scsi_read_capacity_data_long
851 struct scsi_report_luns
855 #define RPL_REPORT_DEFAULT 0x00
856 #define RPL_REPORT_WELLKNOWN 0x01
857 #define RPL_REPORT_ALL 0x02
858 uint8_t select_report;
859 uint8_t reserved2[3];
865 struct scsi_report_luns_data {
866 u_int8_t length[4]; /* length of LUN inventory, in bytes */
867 u_int8_t reserved[4]; /* unused */
869 * LUN inventory- we only support the type zero form for now.
875 #define RPL_LUNDATA_PERIPH_BUS_MASK 0x3f
876 #define RPL_LUNDATA_FLAT_LUN_MASK 0x3f
877 #define RPL_LUNDATA_LUN_TARG_MASK 0x3f
878 #define RPL_LUNDATA_LUN_BUS_MASK 0xe0
879 #define RPL_LUNDATA_LUN_LUN_MASK 0x1f
880 #define RPL_LUNDATA_EXT_LEN_MASK 0x30
881 #define RPL_LUNDATA_EXT_EAM_MASK 0x0f
882 #define RPL_LUNDATA_EXT_EAM_WK 0x01
883 #define RPL_LUNDATA_EXT_EAM_NOT_SPEC 0x0f
884 #define RPL_LUNDATA_ATYP_MASK 0xc0 /* MBZ for type 0 lun */
885 #define RPL_LUNDATA_ATYP_PERIPH 0x00
886 #define RPL_LUNDATA_ATYP_FLAT 0x40
887 #define RPL_LUNDATA_ATYP_LUN 0x80
888 #define RPL_LUNDATA_ATYP_EXTLUN 0xc0
890 struct scsi_target_group
893 uint8_t service_action;
894 #define STG_PDF_LENGTH 0x00
895 #define RPL_PDF_EXTENDED 0x20
896 uint8_t reserved1[4];
902 struct scsi_target_port_descriptor {
904 uint8_t relative_target_port_identifier[2];
908 struct scsi_target_port_group_descriptor {
910 #define TPG_PRIMARY 0x80
911 #define TPG_ASYMMETRIC_ACCESS_STATE_MASK 0xf
912 #define TPG_ASYMMETRIC_ACCESS_OPTIMIZED 0x0
913 #define TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED 0x1
914 #define TPG_ASYMMETRIC_ACCESS_STANDBY 0x2
915 #define TPG_ASYMMETRIC_ACCESS_UNAVAILABLE 0x3
916 #define TPG_ASYMMETRIC_ACCESS_LBA_DEPENDENT 0x4
917 #define TPG_ASYMMETRIC_ACCESS_OFFLINE 0xE
918 #define TPG_ASYMMETRIC_ACCESS_TRANSITIONING 0xF
920 #define TPG_AO_SUP 0x01
921 #define TPG_AN_SUP 0x02
922 #define TPG_S_SUP 0x04
923 #define TPG_U_SUP 0x08
924 #define TPG_LBD_SUP 0x10
925 #define TPG_O_SUP 0x40
926 #define TPG_T_SUP 0x80
927 uint8_t target_port_group[2];
930 uint8_t vendor_specific;
931 uint8_t target_port_count;
932 struct scsi_target_port_descriptor descriptors[];
935 struct scsi_target_group_data {
936 uint8_t length[4]; /* length of returned data, in bytes */
937 struct scsi_target_port_group_descriptor groups[];
940 struct scsi_target_group_data_extended {
941 uint8_t length[4]; /* length of returned data, in bytes */
942 uint8_t format_type; /* STG_PDF_LENGTH or RPL_PDF_EXTENDED */
943 uint8_t implicit_transition_time;
945 struct scsi_target_port_group_descriptor groups[];
949 struct scsi_sense_data
952 #define SSD_ERRCODE 0x7F
953 #define SSD_CURRENT_ERROR 0x70
954 #define SSD_DEFERRED_ERROR 0x71
955 #define SSD_ERRCODE_VALID 0x80
959 #define SSD_KEY_NO_SENSE 0x00
960 #define SSD_KEY_RECOVERED_ERROR 0x01
961 #define SSD_KEY_NOT_READY 0x02
962 #define SSD_KEY_MEDIUM_ERROR 0x03
963 #define SSD_KEY_HARDWARE_ERROR 0x04
964 #define SSD_KEY_ILLEGAL_REQUEST 0x05
965 #define SSD_KEY_UNIT_ATTENTION 0x06
966 #define SSD_KEY_DATA_PROTECT 0x07
967 #define SSD_KEY_BLANK_CHECK 0x08
968 #define SSD_KEY_Vendor_Specific 0x09
969 #define SSD_KEY_COPY_ABORTED 0x0a
970 #define SSD_KEY_ABORTED_COMMAND 0x0b
971 #define SSD_KEY_EQUAL 0x0c
972 #define SSD_KEY_VOLUME_OVERFLOW 0x0d
973 #define SSD_KEY_MISCOMPARE 0x0e
974 #define SSD_KEY_RESERVED 0x0f
977 #define SSD_FILEMARK 0x80
980 u_int8_t cmd_spec_info[4];
981 u_int8_t add_sense_code;
982 u_int8_t add_sense_code_qual;
984 u_int8_t sense_key_spec[3];
985 #define SSD_SCS_VALID 0x80
986 #define SSD_FIELDPTR_CMD 0x40
987 #define SSD_BITPTR_VALID 0x08
988 #define SSD_BITPTR_VALUE 0x07
989 #define SSD_MIN_SIZE 18
990 u_int8_t extra_bytes[14];
991 #define SSD_FULL_SIZE sizeof(struct scsi_sense_data)
994 struct scsi_mode_header_6
996 u_int8_t data_length; /* Sense data length */
997 u_int8_t medium_type;
999 u_int8_t blk_desc_len;
1002 struct scsi_mode_header_10
1004 u_int8_t data_length[2];/* Sense data length */
1005 u_int8_t medium_type;
1008 u_int8_t blk_desc_len[2];
1011 struct scsi_mode_page_header
1014 u_int8_t page_length;
1017 struct scsi_mode_blk_desc
1020 u_int8_t nblocks[3];
1025 #define SCSI_DEFAULT_DENSITY 0x00 /* use 'default' density */
1026 #define SCSI_SAME_DENSITY 0x7f /* use 'same' density- >= SCSI-2 only */
1032 #define SCSI_STATUS_OK 0x00
1033 #define SCSI_STATUS_CHECK_COND 0x02
1034 #define SCSI_STATUS_COND_MET 0x04
1035 #define SCSI_STATUS_BUSY 0x08
1036 #define SCSI_STATUS_INTERMED 0x10
1037 #define SCSI_STATUS_INTERMED_COND_MET 0x14
1038 #define SCSI_STATUS_RESERV_CONFLICT 0x18
1039 #define SCSI_STATUS_CMD_TERMINATED 0x22 /* Obsolete in SAM-2 */
1040 #define SCSI_STATUS_QUEUE_FULL 0x28
1041 #define SCSI_STATUS_ACA_ACTIVE 0x30
1042 #define SCSI_STATUS_TASK_ABORTED 0x40
1044 struct scsi_inquiry_pattern {
1046 u_int8_t media_type;
1047 #define SIP_MEDIA_REMOVABLE 0x01
1048 #define SIP_MEDIA_FIXED 0x02
1050 const char *product;
1051 const char *revision;
1054 struct scsi_static_inquiry_pattern {
1056 u_int8_t media_type;
1057 char vendor[SID_VENDOR_SIZE+1];
1058 char product[SID_PRODUCT_SIZE+1];
1059 char revision[SID_REVISION_SIZE+1];
1062 struct scsi_sense_quirk_entry {
1063 struct scsi_inquiry_pattern inq_pat;
1066 struct sense_key_table_entry *sense_key_info;
1067 struct asc_table_entry *asc_info;
1070 struct sense_key_table_entry {
1076 struct asc_table_entry {
1083 struct op_table_entry {
1089 struct scsi_op_quirk_entry {
1090 struct scsi_inquiry_pattern inq_pat;
1092 struct op_table_entry *op_table;
1096 SSS_FLAG_NONE = 0x00,
1097 SSS_FLAG_PRINT_COMMAND = 0x01
1098 } scsi_sense_string_flags;
1107 extern const char *scsi_sense_key_text[];
1112 void scsi_sense_desc(int sense_key, int asc, int ascq,
1113 struct scsi_inquiry_data *inq_data,
1114 const char **sense_key_desc, const char **asc_desc);
1115 scsi_sense_action scsi_error_action(struct ccb_scsiio* csio,
1116 struct scsi_inquiry_data *inq_data,
1117 u_int32_t sense_flags);
1118 const char * scsi_status_string(struct ccb_scsiio *csio);
1120 int scsi_command_string(struct ccb_scsiio *csio, struct sbuf *sb);
1121 int scsi_sense_sbuf(struct ccb_scsiio *csio, struct sbuf *sb,
1122 scsi_sense_string_flags flags);
1123 char * scsi_sense_string(struct ccb_scsiio *csio,
1124 char *str, int str_len);
1125 void scsi_sense_print(struct ccb_scsiio *csio);
1126 int scsi_interpret_sense(union ccb *ccb,
1127 u_int32_t sense_flags,
1128 u_int32_t *relsim_flags,
1129 u_int32_t *reduction,
1131 scsi_sense_action error_action);
1133 int scsi_command_string(struct cam_device *device,
1134 struct ccb_scsiio *csio, struct sbuf *sb);
1135 int scsi_sense_sbuf(struct cam_device *device,
1136 struct ccb_scsiio *csio, struct sbuf *sb,
1137 scsi_sense_string_flags flags);
1138 char * scsi_sense_string(struct cam_device *device,
1139 struct ccb_scsiio *csio,
1140 char *str, int str_len);
1141 void scsi_sense_print(struct cam_device *device,
1142 struct ccb_scsiio *csio, FILE *ofile);
1143 int scsi_interpret_sense(struct cam_device *device,
1145 u_int32_t sense_flags,
1146 u_int32_t *relsim_flags,
1147 u_int32_t *reduction,
1149 scsi_sense_action error_action);
1150 #endif /* _KERNEL */
1152 #define SF_RETRY_UA 0x01
1153 #define SF_NO_PRINT 0x02
1154 #define SF_QUIET_IR 0x04 /* Be quiet about Illegal Request reponses */
1155 #define SF_PRINT_ALWAYS 0x08
1158 const char * scsi_op_desc(u_int16_t opcode,
1159 struct scsi_inquiry_data *inq_data);
1160 char * scsi_cdb_string(u_int8_t *cdb_ptr, char *cdb_string,
1163 void scsi_print_inquiry(struct scsi_inquiry_data *inq_data);
1165 u_int scsi_calc_syncsrate(u_int period_factor);
1166 u_int scsi_calc_syncparam(u_int period);
1168 void scsi_test_unit_ready(struct ccb_scsiio *csio, u_int32_t retries,
1169 void (*cbfcnp)(struct cam_periph *,
1171 u_int8_t tag_action,
1172 u_int8_t sense_len, u_int32_t timeout);
1174 void scsi_request_sense(struct ccb_scsiio *csio, u_int32_t retries,
1175 void (*cbfcnp)(struct cam_periph *,
1177 void *data_ptr, u_int8_t dxfer_len,
1178 u_int8_t tag_action, u_int8_t sense_len,
1181 void scsi_inquiry(struct ccb_scsiio *csio, u_int32_t retries,
1182 void (*cbfcnp)(struct cam_periph *, union ccb *),
1183 u_int8_t tag_action, u_int8_t *inq_buf,
1184 u_int32_t inq_len, int evpd, u_int8_t page_code,
1185 u_int8_t sense_len, u_int32_t timeout);
1187 void scsi_mode_sense(struct ccb_scsiio *csio, u_int32_t retries,
1188 void (*cbfcnp)(struct cam_periph *,
1190 u_int8_t tag_action, int dbd,
1191 u_int8_t page_code, u_int8_t page,
1192 u_int8_t *param_buf, u_int32_t param_len,
1193 u_int8_t sense_len, u_int32_t timeout);
1195 void scsi_mode_sense_len(struct ccb_scsiio *csio, u_int32_t retries,
1196 void (*cbfcnp)(struct cam_periph *,
1198 u_int8_t tag_action, int dbd,
1199 u_int8_t page_code, u_int8_t page,
1200 u_int8_t *param_buf, u_int32_t param_len,
1201 int minimum_cmd_size, u_int8_t sense_len,
1204 void scsi_mode_select(struct ccb_scsiio *csio, u_int32_t retries,
1205 void (*cbfcnp)(struct cam_periph *,
1207 u_int8_t tag_action, int scsi_page_fmt,
1208 int save_pages, u_int8_t *param_buf,
1209 u_int32_t param_len, u_int8_t sense_len,
1212 void scsi_mode_select_len(struct ccb_scsiio *csio, u_int32_t retries,
1213 void (*cbfcnp)(struct cam_periph *,
1215 u_int8_t tag_action, int scsi_page_fmt,
1216 int save_pages, u_int8_t *param_buf,
1217 u_int32_t param_len, int minimum_cmd_size,
1218 u_int8_t sense_len, u_int32_t timeout);
1220 void scsi_log_sense(struct ccb_scsiio *csio, u_int32_t retries,
1221 void (*cbfcnp)(struct cam_periph *, union ccb *),
1222 u_int8_t tag_action, u_int8_t page_code,
1223 u_int8_t page, int save_pages, int ppc,
1224 u_int32_t paramptr, u_int8_t *param_buf,
1225 u_int32_t param_len, u_int8_t sense_len,
1228 void scsi_log_select(struct ccb_scsiio *csio, u_int32_t retries,
1229 void (*cbfcnp)(struct cam_periph *,
1230 union ccb *), u_int8_t tag_action,
1231 u_int8_t page_code, int save_pages,
1232 int pc_reset, u_int8_t *param_buf,
1233 u_int32_t param_len, u_int8_t sense_len,
1236 void scsi_prevent(struct ccb_scsiio *csio, u_int32_t retries,
1237 void (*cbfcnp)(struct cam_periph *, union ccb *),
1238 u_int8_t tag_action, u_int8_t action,
1239 u_int8_t sense_len, u_int32_t timeout);
1241 void scsi_read_capacity(struct ccb_scsiio *csio, u_int32_t retries,
1242 void (*cbfcnp)(struct cam_periph *,
1243 union ccb *), u_int8_t tag_action,
1244 struct scsi_read_capacity_data *,
1245 u_int8_t sense_len, u_int32_t timeout);
1246 void scsi_read_capacity_16(struct ccb_scsiio *csio, uint32_t retries,
1247 void (*cbfcnp)(struct cam_periph *,
1248 union ccb *), uint8_t tag_action,
1249 uint64_t lba, int reladr, int pmi,
1250 struct scsi_read_capacity_data_long
1251 *rcap_buf, uint8_t sense_len,
1254 void scsi_report_luns(struct ccb_scsiio *csio, u_int32_t retries,
1255 void (*cbfcnp)(struct cam_periph *,
1256 union ccb *), u_int8_t tag_action,
1257 u_int8_t select_report,
1258 struct scsi_report_luns_data *rpl_buf,
1259 u_int32_t alloc_len, u_int8_t sense_len,
1262 void scsi_report_target_group(struct ccb_scsiio *csio, u_int32_t retries,
1263 void (*cbfcnp)(struct cam_periph *,
1264 union ccb *), u_int8_t tag_action,
1267 u_int32_t alloc_len, u_int8_t sense_len,
1270 void scsi_set_target_group(struct ccb_scsiio *csio, u_int32_t retries,
1271 void (*cbfcnp)(struct cam_periph *,
1272 union ccb *), u_int8_t tag_action, void *buf,
1273 u_int32_t alloc_len, u_int8_t sense_len,
1276 void scsi_synchronize_cache(struct ccb_scsiio *csio,
1278 void (*cbfcnp)(struct cam_periph *,
1279 union ccb *), u_int8_t tag_action,
1280 u_int32_t begin_lba, u_int16_t lb_count,
1281 u_int8_t sense_len, u_int32_t timeout);
1283 void scsi_read_write(struct ccb_scsiio *csio, u_int32_t retries,
1284 void (*cbfcnp)(struct cam_periph *, union ccb *),
1285 u_int8_t tag_action, int readop, u_int8_t byte2,
1286 int minimum_cmd_size, u_int64_t lba,
1287 u_int32_t block_count, u_int8_t *data_ptr,
1288 u_int32_t dxfer_len, u_int8_t sense_len,
1291 void scsi_start_stop(struct ccb_scsiio *csio, u_int32_t retries,
1292 void (*cbfcnp)(struct cam_periph *, union ccb *),
1293 u_int8_t tag_action, int start, int load_eject,
1294 int immediate, u_int8_t sense_len, u_int32_t timeout);
1296 int scsi_inquiry_match(caddr_t inqbuffer, caddr_t table_entry);
1297 int scsi_static_inquiry_match(caddr_t inqbuffer,
1298 caddr_t table_entry);
1300 static __inline void scsi_extract_sense(struct scsi_sense_data *sense,
1301 int *error_code, int *sense_key,
1302 int *asc, int *ascq);
1303 static __inline void scsi_ulto2b(u_int32_t val, u_int8_t *bytes);
1304 static __inline void scsi_ulto3b(u_int32_t val, u_int8_t *bytes);
1305 static __inline void scsi_ulto4b(u_int32_t val, u_int8_t *bytes);
1306 static __inline void scsi_u64to8b(u_int64_t val, u_int8_t *bytes);
1307 static __inline u_int32_t scsi_2btoul(u_int8_t *bytes);
1308 static __inline u_int32_t scsi_3btoul(u_int8_t *bytes);
1309 static __inline int32_t scsi_3btol(u_int8_t *bytes);
1310 static __inline u_int32_t scsi_4btoul(u_int8_t *bytes);
1311 static __inline u_int64_t scsi_8btou64(u_int8_t *bytes);
1312 static __inline void *find_mode_page_6(struct scsi_mode_header_6 *mode_header);
1313 static __inline void *find_mode_page_10(struct scsi_mode_header_10 *mode_header);
1315 static __inline void scsi_extract_sense(struct scsi_sense_data *sense,
1316 int *error_code, int *sense_key,
1317 int *asc, int *ascq)
1319 *error_code = sense->error_code & SSD_ERRCODE;
1320 *sense_key = sense->flags & SSD_KEY;
1321 *asc = (sense->extra_len >= 5) ? sense->add_sense_code : 0;
1322 *ascq = (sense->extra_len >= 6) ? sense->add_sense_code_qual : 0;
1325 static __inline void
1326 scsi_ulto2b(u_int32_t val, u_int8_t *bytes)
1329 bytes[0] = (val >> 8) & 0xff;
1330 bytes[1] = val & 0xff;
1333 static __inline void
1334 scsi_ulto3b(u_int32_t val, u_int8_t *bytes)
1337 bytes[0] = (val >> 16) & 0xff;
1338 bytes[1] = (val >> 8) & 0xff;
1339 bytes[2] = val & 0xff;
1342 static __inline void
1343 scsi_ulto4b(u_int32_t val, u_int8_t *bytes)
1346 bytes[0] = (val >> 24) & 0xff;
1347 bytes[1] = (val >> 16) & 0xff;
1348 bytes[2] = (val >> 8) & 0xff;
1349 bytes[3] = val & 0xff;
1352 static __inline void
1353 scsi_u64to8b(u_int64_t val, u_int8_t *bytes)
1356 bytes[0] = (val >> 56) & 0xff;
1357 bytes[1] = (val >> 48) & 0xff;
1358 bytes[2] = (val >> 40) & 0xff;
1359 bytes[3] = (val >> 32) & 0xff;
1360 bytes[4] = (val >> 24) & 0xff;
1361 bytes[5] = (val >> 16) & 0xff;
1362 bytes[6] = (val >> 8) & 0xff;
1363 bytes[7] = val & 0xff;
1366 static __inline u_int32_t
1367 scsi_2btoul(u_int8_t *bytes)
1371 rv = (bytes[0] << 8) |
1376 static __inline u_int32_t
1377 scsi_3btoul(u_int8_t *bytes)
1381 rv = (bytes[0] << 16) |
1387 static __inline int32_t
1388 scsi_3btol(u_int8_t *bytes)
1390 u_int32_t rc = scsi_3btoul(bytes);
1392 if (rc & 0x00800000)
1395 return (int32_t) rc;
1398 static __inline u_int32_t
1399 scsi_4btoul(u_int8_t *bytes)
1403 rv = (bytes[0] << 24) |
1410 static __inline uint64_t
1411 scsi_8btou64(uint8_t *bytes)
1415 rv = (((uint64_t)bytes[0]) << 56) |
1416 (((uint64_t)bytes[1]) << 48) |
1417 (((uint64_t)bytes[2]) << 40) |
1418 (((uint64_t)bytes[3]) << 32) |
1419 (((uint64_t)bytes[4]) << 24) |
1420 (((uint64_t)bytes[5]) << 16) |
1421 (((uint64_t)bytes[6]) << 8) |
1427 * Given the pointer to a returned mode sense buffer, return a pointer to
1428 * the start of the first mode page.
1430 static __inline void *
1431 find_mode_page_6(struct scsi_mode_header_6 *mode_header)
1435 page_start = (void *)((u_int8_t *)&mode_header[1] +
1436 mode_header->blk_desc_len);
1441 static __inline void *
1442 find_mode_page_10(struct scsi_mode_header_10 *mode_header)
1446 page_start = (void *)((u_int8_t *)&mode_header[1] +
1447 scsi_2btoul(mode_header->blk_desc_len));
1454 #endif /*_SCSI_SCSI_ALL_H*/