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
17 * $FreeBSD: src/sys/cam/scsi/scsi_all.h,v 1.31 2008/08/07 17:25:05 jkim Exp $
21 * SCSI general interface description
24 #ifndef _SCSI_SCSI_ALL_H
25 #define _SCSI_SCSI_ALL_H 1
28 #include <sys/cdefs.h>
30 #if !defined(_KERNEL) && !defined(_STDIO_H_)
31 #include <stdio.h> /* FILE for userland protos */
36 * This is the number of milliseconds we wait for devices to settle after a SCSI
39 extern int scsi_delay
;
47 * Define dome bits that are in ALL (or a lot of) scsi commands
49 #define SCSI_CTL_LINK 0x01
50 #define SCSI_CTL_FLAG 0x02
51 #define SCSI_CTL_VENDOR 0xC0
52 #define SCSI_CMD_LUN 0xA0 /* these two should not be needed */
53 #define SCSI_CMD_LUN_SHIFT 5 /* LUN in the cmd is no longer SCSI */
55 #define SCSI_MAX_CDBLEN 16 /*
56 * 16 byte commands are in the
59 #if defined(CAM_MAX_CDBLEN) && (CAM_MAX_CDBLEN < SCSI_MAX_CDBLEN)
60 #error "CAM_MAX_CDBLEN cannot be less than SCSI_MAX_CDBLEN"
63 /* 6byte CDBs special case 0 length to be 256 */
64 #define SCSI_CDB6_LEN(len) ((len) == 0 ? 256 : len)
67 * This type defines actions to be taken when a particular sense code is
68 * received. Right now, these flags are only defined to take up 16 bits,
69 * but can be expanded in the future if necessary.
72 SS_NOP
= 0x000000, /* Do nothing */
73 SS_RETRY
= 0x010000, /* Retry the command */
74 SS_FAIL
= 0x020000, /* Bail out */
75 SS_START
= 0x030000, /* Send a Start Unit command to the device,
76 * then retry the original command.
78 SS_TUR
= 0x040000, /* Send a Test Unit Ready command to the
79 * device, then retry the original command.
81 SS_REQSENSE
= 0x050000, /* Send a RequestSense command to the
82 * device, then retry the original command.
89 SSQ_DECREMENT_COUNT
= 0x0100, /* Decrement the retry count */
90 SSQ_MANY
= 0x0200, /* send lots of recovery commands */
91 SSQ_RANGE
= 0x0400, /*
92 * This table entry represents the
93 * end of a range of ASCQs that
94 * have identical error actions
97 SSQ_PRINT_SENSE
= 0x0800,
99 } scsi_sense_action_qualifier
;
101 /* Mask for error status values */
102 #define SS_ERRMASK 0xff
104 /* The default, retyable, error action */
105 #define SS_RDEF SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE|EIO
107 /* The retyable, error action, with table specified error code */
108 #define SS_RET SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE
110 /* Fatal error action, with table specified error code */
111 #define SS_FATAL SS_FAIL|SSQ_PRINT_SENSE
119 struct scsi_request_sense
128 struct scsi_test_unit_ready
136 struct scsi_send_diag
142 #define SSD_SELFTEST 0x04
145 u_int8_t paramlen
[2];
169 struct scsi_mode_sense_6
175 #define SMS_PAGE_CODE 0x3F
176 #define SMS_VENDOR_SPECIFIC_PAGE 0x00
177 #define SMS_DISCONNECT_RECONNECT_PAGE 0x02
178 #define SMS_CACHE_PAGE 0x08
179 #define SMS_PERIPHERAL_DEVICE_PAGE 0x09
180 #define SMS_CONTROL_MODE_PAGE 0x0A
181 #define SMS_PROTO_SPECIFIC_PAGE 0x19
182 #define SMS_INFO_EXCEPTIONS_PAGE 0x1C
183 #define SMS_ALL_PAGES_PAGE 0x3F
184 #define SMS_PAGE_CTRL_MASK 0xC0
185 #define SMS_PAGE_CTRL_CURRENT 0x00
186 #define SMS_PAGE_CTRL_CHANGEABLE 0x40
187 #define SMS_PAGE_CTRL_DEFAULT 0x80
188 #define SMS_PAGE_CTRL_SAVED 0xC0
194 struct scsi_mode_sense_10
197 u_int8_t byte2
; /* same bits as small version */
198 u_int8_t page
; /* same bits as small version */
204 struct scsi_mode_select_6
215 struct scsi_mode_select_10
218 u_int8_t byte2
; /* same bits as small version */
225 * When sending a mode select to a tape drive, the medium type must be 0.
227 struct scsi_mode_hdr_6
230 u_int8_t medium_type
;
231 u_int8_t dev_specific
;
232 u_int8_t block_descr_len
;
235 struct scsi_mode_hdr_10
238 u_int8_t medium_type
;
239 u_int8_t dev_specific
;
240 u_int8_t reserved
[2];
241 u_int8_t block_descr_len
[2];
244 struct scsi_mode_block_descr
246 u_int8_t density_code
;
247 u_int8_t num_blocks
[3];
249 u_int8_t block_len
[3];
252 struct scsi_log_sense
259 #define SLS_PAGE_CODE 0x3F
260 #define SLS_ALL_PAGES_PAGE 0x00
261 #define SLS_OVERRUN_PAGE 0x01
262 #define SLS_ERROR_WRITE_PAGE 0x02
263 #define SLS_ERROR_READ_PAGE 0x03
264 #define SLS_ERROR_READREVERSE_PAGE 0x04
265 #define SLS_ERROR_VERIFY_PAGE 0x05
266 #define SLS_ERROR_NONMEDIUM_PAGE 0x06
267 #define SLS_ERROR_LASTN_PAGE 0x07
268 #define SLS_SELF_TEST_PAGE 0x10
269 #define SLS_IE_PAGE 0x2f
270 #define SLS_PAGE_CTRL_MASK 0xC0
271 #define SLS_PAGE_CTRL_THRESHOLD 0x00
272 #define SLS_PAGE_CTRL_CUMULATIVE 0x40
273 #define SLS_PAGE_CTRL_THRESH_DEFAULT 0x80
274 #define SLS_PAGE_CTRL_CUMUL_DEFAULT 0xC0
275 u_int8_t reserved
[2];
276 u_int8_t paramptr
[2];
281 struct scsi_log_select
288 /* SLS_PAGE_CTRL_MASK 0xC0 */
289 /* SLS_PAGE_CTRL_THRESHOLD 0x00 */
290 /* SLS_PAGE_CTRL_CUMULATIVE 0x40 */
291 /* SLS_PAGE_CTRL_THRESH_DEFAULT 0x80 */
292 /* SLS_PAGE_CTRL_CUMUL_DEFAULT 0xC0 */
293 u_int8_t reserved
[4];
298 struct scsi_log_header
305 struct scsi_log_param_header
{
306 u_int8_t param_code
[2];
307 u_int8_t param_control
;
309 #define SLP_LBIN 0x02
310 #define SLP_TMC_MASK 0x0C
311 #define SLP_TMC_ALWAYS 0x00
312 #define SLP_TMC_EQUAL 0x04
313 #define SLP_TMC_NOTEQUAL 0x08
314 #define SLP_TMC_GREATER 0x0C
322 struct scsi_control_page
{
324 u_int8_t page_length
;
326 #define SCB_RLEC 0x01 /*Report Log Exception Cond*/
327 u_int8_t queue_flags
;
328 #define SCP_QUEUE_ALG_MASK 0xF0
329 #define SCP_QUEUE_ALG_RESTRICTED 0x00
330 #define SCP_QUEUE_ALG_UNRESTRICTED 0x10
331 #define SCP_QUEUE_ERR 0x02 /*Queued I/O aborted for CACs*/
332 #define SCP_QUEUE_DQUE 0x01 /*Queued I/O disabled*/
333 u_int8_t eca_and_aen
;
334 #define SCP_EECA 0x80 /*Enable Extended CA*/
335 #define SCP_RAENP 0x04 /*Ready AEN Permission*/
336 #define SCP_UAAENP 0x02 /*UA AEN Permission*/
337 #define SCP_EAENP 0x01 /*Error AEN Permission*/
339 u_int8_t aen_holdoff_period
[2];
342 struct scsi_cache_page
{
344 #define SCHP_PAGE_SAVABLE 0x80 /* Page is savable */
345 u_int8_t page_length
;
346 u_int8_t cache_flags
;
347 #define SCHP_FLAGS_WCE 0x04 /* Write Cache Enable */
348 #define SCHP_FLAGS_MF 0x02 /* Multiplication factor */
349 #define SCHP_FLAGS_RCD 0x01 /* Read Cache Disable */
350 u_int8_t rw_cache_policy
;
351 u_int8_t dis_prefetch
[2];
352 u_int8_t min_prefetch
[2];
353 u_int8_t max_prefetch
[2];
354 u_int8_t max_prefetch_ceil
[2];
357 struct scsi_info_exceptions_page
{
359 #define SIEP_PAGE_SAVABLE 0x80 /* Page is savable */
360 u_int8_t page_length
;
362 #define SIEP_FLAGS_PERF 0x80
363 #define SIEP_FLAGS_EBF 0x20
364 #define SIEP_FLAGS_EWASC 0x10
365 #define SIEP_FLAGS_DEXCPT 0x08
366 #define SIEP_FLAGS_TEST 0x04
367 #define SIEP_FLAGS_EBACKERR 0x02
368 #define SIEP_FLAGS_LOGERR 0x01
370 u_int8_t interval_timer
[4];
371 u_int8_t report_count
[4];
374 struct scsi_proto_specific_page
{
376 #define SPSP_PAGE_SAVABLE 0x80 /* Page is savable */
377 u_int8_t page_length
;
379 #define SPSP_PROTO_FC 0x00
380 #define SPSP_PROTO_SPI 0x01
381 #define SPSP_PROTO_SSA 0x02
382 #define SPSP_PROTO_1394 0x03
383 #define SPSP_PROTO_RDMA 0x04
384 #define SPSP_PROTO_ISCSI 0x05
385 #define SPSP_PROTO_SAS 0x06
386 #define SPSP_PROTO_ADT 0x07
387 #define SPSP_PROTO_ATA 0x08
388 #define SPSP_PROTO_NONE 0x0f
417 #define PR_PREVENT 0x01
418 #define PR_ALLOW 0x00
420 struct scsi_sync_cache
424 u_int8_t begin_lba
[4];
426 u_int8_t lb_count
[2];
431 struct scsi_changedef
442 struct scsi_read_buffer
446 #define RWB_MODE 0x07
447 #define RWB_MODE_HDR_DATA 0x00
448 #define RWB_MODE_DATA 0x02
449 #define RWB_MODE_DOWNLOAD 0x04
450 #define RWB_MODE_DOWNLOAD_SAVE 0x05
457 struct scsi_write_buffer
471 /* only 5 bits are valid in the MSB address byte */
472 #define SRW_TOPADDR 0x1F
480 #define SRW10_RELADDR 0x01
481 /* EBP defined for WRITE(10) only */
482 #define SRW10_EBP 0x04
483 #define SRW10_FUA 0x08
484 #define SRW10_DPO 0x10
495 #define SRW12_RELADDR 0x01
496 #define SRW12_FUA 0x08
497 #define SRW12_DPO 0x10
508 #define SRW16_RELADDR 0x01
509 #define SRW16_FUA 0x08
510 #define SRW16_DPO 0x10
519 struct scsi_start_stop_unit
523 #define SSS_IMMED 0x01
524 u_int8_t reserved
[2];
526 #define SSS_START 0x01
527 #define SSS_LOEJ 0x02
534 #define AP_MULTI 0xe0
536 #define AP_T_LEN 0x03
538 #define AP_T_DIR 0x08
539 #define AP_CK_COND 0x20
540 #define AP_OFFLINE 0x60
542 u_int8_t sector_count
;
555 #define AP_EXTEND 0x01
557 u_int8_t features_ext
;
559 u_int8_t sector_count_ext
;
560 u_int8_t sector_count
;
561 u_int8_t lba_low_ext
;
563 u_int8_t lba_mid_ext
;
565 u_int8_t lba_high_ext
;
572 #define SC_SCSI_1 0x01
573 #define SC_SCSI_2 0x03
579 #define TEST_UNIT_READY 0x00
580 #define REQUEST_SENSE 0x03
584 #define MODE_SELECT_6 0x15
585 #define MODE_SENSE_6 0x1a
586 #define START_STOP_UNIT 0x1b
587 #define START_STOP 0x1b
590 #define RECEIVE_DIAGNOSTIC 0x1c
591 #define SEND_DIAGNOSTIC 0x1d
592 #define PREVENT_ALLOW 0x1e
593 #define READ_CAPACITY 0x25
595 #define WRITE_10 0x2a
596 #define POSITION_TO_ELEMENT 0x2b
597 #define SYNCHRONIZE_CACHE 0x35
598 #define READ_DEFECT_DATA_10 0x37
599 #define WRITE_BUFFER 0x3b
600 #define READ_BUFFER 0x3c
601 #define CHANGE_DEFINITION 0x40
603 #define LOG_SELECT 0x4c
604 #define LOG_SENSE 0x4d
605 #define MODE_SELECT_10 0x55
606 #define MODE_SENSE_10 0x5a
607 #define ATA_PASS_16 0x85
609 #define WRITE_16 0x8a
610 #define READ_CAPACITY_16 0x9e
611 #define SERVICE_ACTION_IN 0x9e
612 #define REPORT_LUNS 0xa0
613 #define ATA_PASS_12 0xa1
614 #define MOVE_MEDIUM 0xa5
616 #define WRITE_12 0xaa
617 #define READ_ELEMENT_STATUS 0xb8
622 #define T_DIRECT 0x00
623 #define T_SEQUENTIAL 0x01
624 #define T_PRINTER 0x02
625 #define T_PROCESSOR 0x03
628 #define T_SCANNER 0x06
629 #define T_OPTICAL 0x07
630 #define T_CHANGER 0x08
634 #define T_STORARRAY 0x0c
635 #define T_ENCLOSURE 0x0d
640 #define T_NODEVICE 0x1f
641 #define T_ANY 0xff /* Used in Quirk table matches */
647 * This length is the initial inquiry length used by the probe code, as
648 * well as the legnth necessary for scsi_print_inquiry() to function
649 * correctly. If either use requires a different length in the future,
650 * the two values should be de-coupled.
652 #define SHORT_INQUIRY_LENGTH 36
654 struct scsi_inquiry_data
657 #define SID_TYPE(inq_data) ((inq_data)->device & 0x1f)
658 #define SID_QUAL(inq_data) (((inq_data)->device & 0xE0) >> 5)
659 #define SID_QUAL_LU_CONNECTED 0x00 /*
660 * The specified peripheral device
661 * type is currently connected to
662 * logical unit. If the target cannot
663 * determine whether or not a physical
664 * device is currently connected, it
665 * shall also use this peripheral
666 * qualifier when returning the INQUIRY
667 * data. This peripheral qualifier
668 * does not mean that the device is
669 * ready for access by the initiator.
671 #define SID_QUAL_LU_OFFLINE 0x01 /*
672 * The target is capable of supporting
673 * the specified peripheral device type
674 * on this logical unit; however, the
675 * physical device is not currently
676 * connected to this logical unit.
678 #define SID_QUAL_RSVD 0x02
679 #define SID_QUAL_BAD_LU 0x03 /*
680 * The target is not capable of
681 * supporting a physical device on
682 * this logical unit. For this
683 * peripheral qualifier the peripheral
684 * device type shall be set to 1Fh to
685 * provide compatibility with previous
686 * versions of SCSI. All other
687 * peripheral device type values are
688 * reserved for this peripheral
691 #define SID_QUAL_IS_VENDOR_UNIQUE(inq_data) ((SID_QUAL(inq_data) & 0x08) != 0)
693 #define SID_QUAL2 0x7F
694 #define SID_IS_REMOVABLE(inq_data) (((inq_data)->dev_qual2 & 0x80) != 0)
696 #define SID_ANSI_REV(inq_data) ((inq_data)->version & 0x07)
698 #define SCSI_REV_CCS 1
700 #define SCSI_REV_SPC 3
701 #define SCSI_REV_SPC2 4
702 #define SCSI_REV_SPC3 5
704 #define SID_ECMA 0x38
706 u_int8_t response_format
;
707 #define SID_AENC 0x80
708 #define SID_TrmIOP 0x40
709 u_int8_t additional_length
;
710 #define SID_ADDITIONAL_LENGTH(iqd) \
711 ((iqd)->additional_length + \
712 offsetof(struct scsi_inquiry_data, additional_length) + 1)
715 #define SPC2_SID_MChngr 0x08
716 #define SPC2_SID_MultiP 0x10
717 #define SPC2_SID_EncServ 0x40
718 #define SPC2_SID_BQueue 0x80
720 #define INQ_DATA_TQ_ENABLED(iqd) \
721 ((SID_ANSI_REV(iqd) < SCSI_REV_SPC2)? ((iqd)->flags & SID_CmdQue) : \
722 (((iqd)->flags & SID_CmdQue) && !((iqd)->spc2_flags & SPC2_SID_BQueue)) || \
723 (!((iqd)->flags & SID_CmdQue) && ((iqd)->spc2_flags & SPC2_SID_BQueue)))
727 #define SID_SftRe 0x01
728 #define SID_CmdQue 0x02
729 #define SID_Linked 0x08
730 #define SID_Sync 0x10
731 #define SID_WBus16 0x20
732 #define SID_WBus32 0x40
733 #define SID_RelAdr 0x80
734 #define SID_VENDOR_SIZE 8
735 char vendor
[SID_VENDOR_SIZE
];
736 #define SID_PRODUCT_SIZE 16
737 char product
[SID_PRODUCT_SIZE
];
738 #define SID_REVISION_SIZE 4
739 char revision
[SID_REVISION_SIZE
];
741 * The following fields were taken from SCSI Primary Commands - 2
742 * (SPC-2) Revision 14, Dated 11 November 1999
744 #define SID_VENDOR_SPECIFIC_0_SIZE 20
745 u_int8_t vendor_specific0
[SID_VENDOR_SPECIFIC_0_SIZE
];
747 * An extension of SCSI Parallel Specific Values
749 #define SID_SPI_IUS 0x01
750 #define SID_SPI_QAS 0x02
751 #define SID_SPI_CLOCK_ST 0x00
752 #define SID_SPI_CLOCK_DT 0x04
753 #define SID_SPI_CLOCK_DT_ST 0x0C
754 #define SID_SPI_MASK 0x0F
758 * Version Descriptors, stored 2 byte values.
760 u_int8_t version1
[2];
761 u_int8_t version2
[2];
762 u_int8_t version3
[2];
763 u_int8_t version4
[2];
764 u_int8_t version5
[2];
765 u_int8_t version6
[2];
766 u_int8_t version7
[2];
767 u_int8_t version8
[2];
769 u_int8_t reserved3
[22];
771 #define SID_VENDOR_SPECIFIC_1_SIZE 160
772 u_int8_t vendor_specific1
[SID_VENDOR_SPECIFIC_1_SIZE
];
775 struct scsi_vpd_supported_page_list
779 #define SVPD_SUPPORTED_PAGE_LIST 0x00
781 u_int8_t length
; /* number of VPD entries */
782 #define SVPD_SUPPORTED_PAGES_SIZE 251
783 u_int8_t list
[SVPD_SUPPORTED_PAGES_SIZE
];
786 struct scsi_vpd_unit_serial_number
790 #define SVPD_UNIT_SERIAL_NUMBER 0x80
792 u_int8_t length
; /* serial number length */
793 #define SVPD_SERIAL_NUM_SIZE 251
794 u_int8_t serial_num
[SVPD_SERIAL_NUM_SIZE
];
797 struct scsi_vpd_unit_devid
801 #define SVPD_UNIT_DEVID 0x83
804 /* extended by variable array of scsi_vpd_devid_hdr */
807 struct scsi_vpd_devid_hdr
{
809 #define VPD_DEVID_PI(_f) (((_f) >> 4) & 0xf0)
810 #define VPD_DEVID_CODE(_f) (((_f) >> 0) & 0x0f)
811 #define VPD_DEVID_CODE_BINARY 0x1
812 #define VPD_DEVID_CODE_ASCII 0x2
813 #define VPD_DEVID_CODE_UTF8 0x3
815 #define VPD_DEVID_PIV 0x80
816 #define VPD_DEVID_ASSOC(_f) ((_f) & 0x30)
817 #define VPD_DEVID_ASSOC_LU 0x00
818 #define VPD_DEVID_ASSOC_PORT 0x10
819 #define VPD_DEVID_ASSOC_TARG 0x20
820 #define VPD_DEVID_TYPE(_f) ((_f) & 0x0f)
821 #define VPD_DEVID_TYPE_VENDOR 0x0
822 #define VPD_DEVID_TYPE_T10 0x1
823 #define VPD_DEVID_TYPE_EUI64 0x2
824 #define VPD_DEVID_TYPE_NAA 0x3
825 #define VPD_DEVID_TYPE_RELATIVE 0x4
826 #define VPD_DEVID_TYPE_PORT 0x5
827 #define VPD_DEVID_TYPE_LU 0x6
828 #define VPD_DEVID_TYPE_MD5 0x7
829 #define VPD_DEVID_TYPE_NAME 0x8
834 struct scsi_read_capacity
843 struct scsi_read_capacity_16
846 #define SRC16_SERVICE_ACTION 0x10
847 uint8_t service_action
;
849 uint8_t alloc_len
[4];
850 #define SRC16_PMI 0x01
851 #define SRC16_RELADR 0x02
856 struct scsi_read_capacity_data
862 struct scsi_read_capacity_data_16
866 u_int8_t p_type_prot
;
867 u_int8_t logical_per_phys
;
868 u_int8_t lowest_aligned
[2];
869 u_int8_t reserved
[16];
872 struct scsi_report_luns
876 #define RPL_REPORT_DEFAULT 0x00
877 #define RPL_REPORT_WELLKNOWN 0x01
878 #define RPL_REPORT_ALL 0x02
879 uint8_t select_report
;
880 uint8_t reserved2
[3];
886 struct scsi_report_luns_data
{
887 u_int8_t length
[4]; /* length of LUN inventory, in bytes */
888 u_int8_t reserved
[4]; /* unused */
890 * LUN inventory- we only support the type zero form for now.
896 #define RPL_LUNDATA_PERIPH_BUS_MASK 0x3f
897 #define RPL_LUNDATA_FLAT_LUN_MASK 0x3f
898 #define RPL_LUNDATA_LUN_TARG_MASK 0x3f
899 #define RPL_LUNDATA_LUN_BUS_MASK 0xe0
900 #define RPL_LUNDATA_LUN_LUN_MASK 0x1f
901 #define RPL_LUNDATA_EXT_LEN_MASK 0x30
902 #define RPL_LUNDATA_EXT_EAM_MASK 0x0f
903 #define RPL_LUNDATA_EXT_EAM_WK 0x01
904 #define RPL_LUNDATA_EXT_EAM_NOT_SPEC 0x0f
905 #define RPL_LUNDATA_ATYP_MASK 0xc0 /* MBZ for type 0 lun */
906 #define RPL_LUNDATA_ATYP_PERIPH 0x00
907 #define RPL_LUNDATA_ATYP_FLAT 0x40
908 #define RPL_LUNDATA_ATYP_LUN 0x80
909 #define RPL_LUNDATA_ATYP_EXTLUN 0xc0
911 struct scsi_sense_data
914 #define SSD_ERRCODE 0x7F
915 #define SSD_CURRENT_ERROR 0x70
916 #define SSD_DEFERRED_ERROR 0x71
917 #define SSD_ERRCODE_VALID 0x80
921 #define SSD_KEY_NO_SENSE 0x00
922 #define SSD_KEY_RECOVERED_ERROR 0x01
923 #define SSD_KEY_NOT_READY 0x02
924 #define SSD_KEY_MEDIUM_ERROR 0x03
925 #define SSD_KEY_HARDWARE_ERROR 0x04
926 #define SSD_KEY_ILLEGAL_REQUEST 0x05
927 #define SSD_KEY_UNIT_ATTENTION 0x06
928 #define SSD_KEY_DATA_PROTECT 0x07
929 #define SSD_KEY_BLANK_CHECK 0x08
930 #define SSD_KEY_Vendor_Specific 0x09
931 #define SSD_KEY_COPY_ABORTED 0x0a
932 #define SSD_KEY_ABORTED_COMMAND 0x0b
933 #define SSD_KEY_EQUAL 0x0c
934 #define SSD_KEY_VOLUME_OVERFLOW 0x0d
935 #define SSD_KEY_MISCOMPARE 0x0e
936 #define SSD_KEY_RESERVED 0x0f
939 #define SSD_FILEMARK 0x80
942 u_int8_t cmd_spec_info
[4];
943 u_int8_t add_sense_code
;
944 u_int8_t add_sense_code_qual
;
946 u_int8_t sense_key_spec
[3];
947 #define SSD_SCS_VALID 0x80
948 #define SSD_FIELDPTR_CMD 0x40
949 #define SSD_BITPTR_VALID 0x08
950 #define SSD_BITPTR_VALUE 0x07
951 #define SSD_MIN_SIZE 18
952 u_int8_t extra_bytes
[14];
953 #define SSD_FULL_SIZE sizeof(struct scsi_sense_data)
956 struct scsi_mode_header_6
958 u_int8_t data_length
; /* Sense data length */
959 u_int8_t medium_type
;
961 u_int8_t blk_desc_len
;
964 struct scsi_mode_header_10
966 u_int8_t data_length
[2];/* Sense data length */
967 u_int8_t medium_type
;
970 u_int8_t blk_desc_len
[2];
973 struct scsi_mode_page_header
976 u_int8_t page_length
;
979 struct scsi_mode_blk_desc
987 #define SCSI_DEFAULT_DENSITY 0x00 /* use 'default' density */
988 #define SCSI_SAME_DENSITY 0x7f /* use 'same' density- >= SCSI-2 only */
994 #define SCSI_STATUS_OK 0x00
995 #define SCSI_STATUS_CHECK_COND 0x02
996 #define SCSI_STATUS_COND_MET 0x04
997 #define SCSI_STATUS_BUSY 0x08
998 #define SCSI_STATUS_INTERMED 0x10
999 #define SCSI_STATUS_INTERMED_COND_MET 0x14
1000 #define SCSI_STATUS_RESERV_CONFLICT 0x18
1001 #define SCSI_STATUS_CMD_TERMINATED 0x22 /* Obsolete in SAM-2 */
1002 #define SCSI_STATUS_QUEUE_FULL 0x28
1003 #define SCSI_STATUS_ACA_ACTIVE 0x30
1004 #define SCSI_STATUS_TASK_ABORTED 0x40
1006 struct scsi_inquiry_pattern
{
1008 u_int8_t media_type
;
1009 #define SIP_MEDIA_REMOVABLE 0x01
1010 #define SIP_MEDIA_FIXED 0x02
1012 const char *product
;
1013 const char *revision
;
1016 struct scsi_static_inquiry_pattern
{
1018 u_int8_t media_type
;
1019 char vendor
[SID_VENDOR_SIZE
+1];
1020 char product
[SID_PRODUCT_SIZE
+1];
1021 char revision
[SID_REVISION_SIZE
+1];
1024 struct scsi_sense_quirk_entry
{
1025 struct scsi_inquiry_pattern inq_pat
;
1028 struct sense_key_table_entry
*sense_key_info
;
1029 struct asc_table_entry
*asc_info
;
1032 struct sense_key_table_entry
{
1038 struct asc_table_entry
{
1045 struct op_table_entry
{
1051 struct scsi_op_quirk_entry
{
1052 struct scsi_inquiry_pattern inq_pat
;
1054 struct op_table_entry
*op_table
;
1058 SSS_FLAG_NONE
= 0x00,
1059 SSS_FLAG_PRINT_COMMAND
= 0x01
1060 } scsi_sense_string_flags
;
1062 typedef union scsi_cdb
{
1063 struct scsi_generic generic
;
1064 struct scsi_sense sense
;
1065 struct scsi_test_unit_ready test_unit_ready
;
1066 struct scsi_send_diag send_diag
;
1067 struct scsi_inquiry inquiry
;
1068 struct scsi_mode_sense_6 mode_sense_6
;
1069 struct scsi_mode_sense_10 mode_sense_10
;
1070 struct scsi_mode_select_6 mode_select_6
;
1071 struct scsi_mode_select_10 mode_select_10
;
1072 struct scsi_log_sense log_sense
;
1073 struct scsi_log_select log_select
;
1074 struct scsi_reserve reserve
;
1075 struct scsi_release release
;
1076 struct scsi_prevent prevent
;
1077 struct scsi_sync_cache sync_cache
;
1078 struct scsi_changedef changedef
;
1079 struct scsi_read_buffer read_buffer
;
1080 struct scsi_write_buffer write_buffer
;
1081 struct scsi_rw_6 rw_6
;
1082 struct scsi_rw_10 rw_10
;
1083 struct scsi_rw_12 rw_12
;
1084 struct scsi_rw_16 rw_16
;
1085 struct scsi_start_stop_unit start_stop_unit
;
1086 struct ata_pass_12 ata_pass_12
;
1087 struct ata_pass_16 ata_pass_16
;
1088 struct scsi_read_capacity read_capacity
;
1089 struct scsi_read_capacity_16 read_capacity_16
;
1090 struct scsi_report_luns report_luns
;
1093 typedef union scsi_data
{
1094 struct scsi_mode_hdr_6 mode_hdr_6
;
1095 struct scsi_mode_hdr_10 mode_hdr_10
;
1096 struct scsi_mode_block_descr mode_block_descr
;
1097 struct scsi_log_header log_header
;
1098 struct scsi_log_param_header log_param_header
;
1099 struct scsi_control_page control_page
;
1100 struct scsi_cache_page cache_page
;
1101 struct scsi_info_exceptions_page info_exceptions_page
;
1102 struct scsi_proto_specific_page proto_specific_page
;
1103 struct scsi_inquiry_data inquiry_data
;
1104 struct scsi_vpd_supported_page_list vpd_supported_page_list
;
1105 struct scsi_vpd_unit_serial_number vpd_unit_serial_number
;
1106 struct scsi_vpd_unit_devid vpd_unit_devid
;
1107 struct scsi_read_capacity_data read_capacity_data
;
1108 struct scsi_read_capacity_data_16 read_capacity_data_16
;
1109 struct scsi_report_luns_data report_luns_data
;
1110 struct scsi_sense_data sense_data
;
1111 struct scsi_mode_header_6 mode_header_6
;
1112 struct scsi_mode_header_10 mode_header_10
;
1113 struct scsi_mode_page_header mode_page_header
;
1114 struct scsi_mode_blk_desc mode_blk_desc
;
1115 struct scsi_inquiry_pattern inquiry_pattern
;
1116 struct scsi_static_inquiry_pattern static_inquiry_pattern
;
1129 void scsi_sense_desc(int sense_key
, int asc
, int ascq
,
1130 struct scsi_inquiry_data
*inq_data
,
1131 const char **sense_key_desc
, const char **asc_desc
);
1132 scsi_sense_action
scsi_error_action(struct ccb_scsiio
* csio
,
1133 struct scsi_inquiry_data
*inq_data
,
1134 u_int32_t sense_flags
);
1135 const char * scsi_status_string(struct ccb_scsiio
*csio
);
1137 int scsi_command_string(struct ccb_scsiio
*csio
, struct sbuf
*sb
);
1138 int scsi_sense_sbuf(struct ccb_scsiio
*csio
, struct sbuf
*sb
,
1139 scsi_sense_string_flags flags
);
1140 char * scsi_sense_string(struct ccb_scsiio
*csio
,
1141 char *str
, int str_len
);
1142 void scsi_sense_print(struct ccb_scsiio
*csio
);
1143 int scsi_interpret_sense(union ccb
*ccb
,
1144 u_int32_t sense_flags
,
1145 u_int32_t
*relsim_flags
,
1146 u_int32_t
*reduction
,
1148 scsi_sense_action error_action
);
1150 int scsi_command_string(struct cam_device
*device
,
1151 struct ccb_scsiio
*csio
, struct sbuf
*sb
);
1152 int scsi_sense_sbuf(struct cam_device
*device
,
1153 struct ccb_scsiio
*csio
, struct sbuf
*sb
,
1154 scsi_sense_string_flags flags
);
1155 char * scsi_sense_string(struct cam_device
*device
,
1156 struct ccb_scsiio
*csio
,
1157 char *str
, int str_len
);
1158 void scsi_sense_print(struct cam_device
*device
,
1159 struct ccb_scsiio
*csio
, FILE *ofile
);
1160 int scsi_interpret_sense(struct cam_device
*device
,
1162 u_int32_t sense_flags
,
1163 u_int32_t
*relsim_flags
,
1164 u_int32_t
*reduction
,
1166 scsi_sense_action error_action
);
1167 #endif /* _KERNEL */
1169 #define SF_RETRY_UA 0x01
1170 #define SF_NO_PRINT 0x02
1171 #define SF_QUIET_IR 0x04 /* Be quiet about Illegal Request reponses */
1172 #define SF_PRINT_ALWAYS 0x08
1175 const char * scsi_op_desc(u_int16_t opcode
,
1176 struct scsi_inquiry_data
*inq_data
);
1177 char * scsi_cdb_string(u_int8_t
*cdb_ptr
, char *cdb_string
,
1180 void scsi_print_inquiry(struct scsi_inquiry_data
*inq_data
);
1182 u_int
scsi_calc_syncsrate(u_int period_factor
);
1183 u_int
scsi_calc_syncparam(u_int period
);
1185 void scsi_test_unit_ready(struct ccb_scsiio
*csio
, u_int32_t retries
,
1186 void (*cbfcnp
)(struct cam_periph
*,
1188 u_int8_t tag_action
,
1189 u_int8_t sense_len
, u_int32_t timeout
);
1191 void scsi_request_sense(struct ccb_scsiio
*csio
, u_int32_t retries
,
1192 void (*cbfcnp
)(struct cam_periph
*,
1194 void *data_ptr
, u_int8_t dxfer_len
,
1195 u_int8_t tag_action
, u_int8_t sense_len
,
1198 #ifndef CAM_NO_SCSI_INQUIRY /* hack for cdparanoia */
1199 void scsi_inquiry(struct ccb_scsiio
*csio
, u_int32_t retries
,
1200 void (*cbfcnp
)(struct cam_periph
*, union ccb
*),
1201 u_int8_t tag_action
, u_int8_t
*inq_buf
,
1202 u_int32_t inq_len
, int evpd
, u_int8_t page_code
,
1203 u_int8_t sense_len
, u_int32_t timeout
);
1206 void scsi_mode_sense(struct ccb_scsiio
*csio
, u_int32_t retries
,
1207 void (*cbfcnp
)(struct cam_periph
*,
1209 u_int8_t tag_action
, int dbd
,
1210 u_int8_t page_code
, u_int8_t page
,
1211 u_int8_t
*param_buf
, u_int32_t param_len
,
1212 u_int8_t sense_len
, u_int32_t timeout
);
1213 void scsi_mode_sense_len(struct ccb_scsiio
*csio
, u_int32_t retries
,
1214 void (*cbfcnp
)(struct cam_periph
*,
1216 u_int8_t tag_action
, int dbd
,
1217 u_int8_t page_code
, u_int8_t page
,
1218 u_int8_t
*param_buf
, u_int32_t param_len
,
1219 int minimum_cmd_size
, u_int8_t sense_len
,
1222 void scsi_mode_select(struct ccb_scsiio
*csio
, u_int32_t retries
,
1223 void (*cbfcnp
)(struct cam_periph
*,
1225 u_int8_t tag_action
, int scsi_page_fmt
,
1226 int save_pages
, u_int8_t
*param_buf
,
1227 u_int32_t param_len
, u_int8_t sense_len
,
1230 void scsi_mode_select_len(struct ccb_scsiio
*csio
, u_int32_t retries
,
1231 void (*cbfcnp
)(struct cam_periph
*,
1233 u_int8_t tag_action
, int scsi_page_fmt
,
1234 int save_pages
, u_int8_t
*param_buf
,
1235 u_int32_t param_len
, int minimum_cmd_size
,
1236 u_int8_t sense_len
, u_int32_t timeout
);
1238 void scsi_log_sense(struct ccb_scsiio
*csio
, u_int32_t retries
,
1239 void (*cbfcnp
)(struct cam_periph
*, union ccb
*),
1240 u_int8_t tag_action
, u_int8_t page_code
,
1241 u_int8_t page
, int save_pages
, int ppc
,
1242 u_int32_t paramptr
, u_int8_t
*param_buf
,
1243 u_int32_t param_len
, u_int8_t sense_len
,
1246 void scsi_log_select(struct ccb_scsiio
*csio
, u_int32_t retries
,
1247 void (*cbfcnp
)(struct cam_periph
*,
1248 union ccb
*), u_int8_t tag_action
,
1249 u_int8_t page_code
, int save_pages
,
1250 int pc_reset
, u_int8_t
*param_buf
,
1251 u_int32_t param_len
, u_int8_t sense_len
,
1254 void scsi_prevent(struct ccb_scsiio
*csio
, u_int32_t retries
,
1255 void (*cbfcnp
)(struct cam_periph
*, union ccb
*),
1256 u_int8_t tag_action
, u_int8_t action
,
1257 u_int8_t sense_len
, u_int32_t timeout
);
1259 void scsi_read_capacity(struct ccb_scsiio
*csio
, u_int32_t retries
,
1260 void (*cbfcnp
)(struct cam_periph
*,
1261 union ccb
*), u_int8_t tag_action
,
1262 struct scsi_read_capacity_data
*,
1263 u_int8_t sense_len
, u_int32_t timeout
);
1264 void scsi_read_capacity_16(struct ccb_scsiio
*csio
, uint32_t retries
,
1265 void (*cbfcnp
)(struct cam_periph
*,
1266 union ccb
*), uint8_t tag_action
,
1267 uint64_t lba
, int reladr
, int pmi
,
1268 struct scsi_read_capacity_data_16
1269 *rcap_buf
, uint8_t sense_len
,
1272 void scsi_report_luns(struct ccb_scsiio
*csio
, u_int32_t retries
,
1273 void (*cbfcnp
)(struct cam_periph
*,
1274 union ccb
*), u_int8_t tag_action
,
1275 u_int8_t select_report
,
1276 struct scsi_report_luns_data
*rpl_buf
,
1277 u_int32_t alloc_len
, u_int8_t sense_len
,
1280 void scsi_synchronize_cache(struct ccb_scsiio
*csio
,
1282 void (*cbfcnp
)(struct cam_periph
*,
1283 union ccb
*), u_int8_t tag_action
,
1284 u_int32_t begin_lba
, u_int16_t lb_count
,
1285 u_int8_t sense_len
, u_int32_t timeout
);
1287 void scsi_read_write(struct ccb_scsiio
*csio
, u_int32_t retries
,
1288 void (*cbfcnp
)(struct cam_periph
*, union ccb
*),
1289 u_int8_t tag_action
, int readop
, u_int8_t byte2
,
1290 int minimum_cmd_size
, u_int64_t lba
,
1291 u_int32_t block_count
, u_int8_t
*data_ptr
,
1292 u_int32_t dxfer_len
, u_int8_t sense_len
,
1295 void scsi_start_stop(struct ccb_scsiio
*csio
, u_int32_t retries
,
1296 void (*cbfcnp
)(struct cam_periph
*, union ccb
*),
1297 u_int8_t tag_action
, int start
, int load_eject
,
1298 int immediate
, u_int8_t sense_len
, u_int32_t timeout
);
1300 int scsi_inquiry_match(caddr_t inqbuffer
, caddr_t table_entry
);
1301 int scsi_static_inquiry_match(caddr_t inqbuffer
,
1302 caddr_t table_entry
);
1304 static __inline
void scsi_extract_sense(struct scsi_sense_data
*sense
,
1305 int *error_code
, int *sense_key
,
1306 int *asc
, int *ascq
);
1307 static __inline
void scsi_ulto2b(u_int32_t val
, u_int8_t
*bytes
);
1308 static __inline
void scsi_ulto3b(u_int32_t val
, u_int8_t
*bytes
);
1309 static __inline
void scsi_ulto4b(u_int32_t val
, u_int8_t
*bytes
);
1310 static __inline
void scsi_u64to8b(u_int64_t val
, u_int8_t
*bytes
);
1311 static __inline u_int32_t
scsi_2btoul(u_int8_t
*bytes
);
1312 static __inline u_int32_t
scsi_3btoul(u_int8_t
*bytes
);
1313 static __inline
int32_t scsi_3btol(u_int8_t
*bytes
);
1314 static __inline u_int32_t
scsi_4btoul(u_int8_t
*bytes
);
1315 static __inline __always_inline u_int64_t
scsi_8btou64(u_int8_t
*bytes
);
1316 static __inline
void *find_mode_page_6(struct scsi_mode_header_6
*mode_header
);
1317 static __inline
void *find_mode_page_10(struct scsi_mode_header_10
*mode_header
);
1319 static __inline
void
1320 scsi_extract_sense(struct scsi_sense_data
*sense
, int *error_code
,
1321 int *sense_key
, int *asc
, int *ascq
)
1323 *error_code
= sense
->error_code
& SSD_ERRCODE
;
1324 *sense_key
= sense
->flags
& SSD_KEY
;
1325 *asc
= (sense
->extra_len
>= 5) ? sense
->add_sense_code
: 0;
1326 *ascq
= (sense
->extra_len
>= 6) ? sense
->add_sense_code_qual
: 0;
1329 static __inline
void
1330 scsi_ulto2b(u_int32_t val
, u_int8_t
*bytes
)
1333 bytes
[0] = (val
>> 8) & 0xff;
1334 bytes
[1] = val
& 0xff;
1337 static __inline
void
1338 scsi_ulto3b(u_int32_t val
, u_int8_t
*bytes
)
1341 bytes
[0] = (val
>> 16) & 0xff;
1342 bytes
[1] = (val
>> 8) & 0xff;
1343 bytes
[2] = val
& 0xff;
1346 static __inline
void
1347 scsi_ulto4b(u_int32_t val
, u_int8_t
*bytes
)
1350 bytes
[0] = (val
>> 24) & 0xff;
1351 bytes
[1] = (val
>> 16) & 0xff;
1352 bytes
[2] = (val
>> 8) & 0xff;
1353 bytes
[3] = val
& 0xff;
1356 static __inline
void
1357 scsi_u64to8b(u_int64_t val
, u_int8_t
*bytes
)
1359 bytes
[0] = (val
>> 56) & 0xff;
1360 bytes
[1] = (val
>> 48) & 0xff;
1361 bytes
[2] = (val
>> 40) & 0xff;
1362 bytes
[3] = (val
>> 32) & 0xff;
1363 bytes
[4] = (val
>> 24) & 0xff;
1364 bytes
[5] = (val
>> 16) & 0xff;
1365 bytes
[6] = (val
>> 8) & 0xff;
1366 bytes
[7] = val
& 0xff;
1369 static __inline u_int32_t
1370 scsi_2btoul(u_int8_t
*bytes
)
1374 rv
= (bytes
[0] << 8) |
1379 static __inline __always_inline
uint64_t
1380 scsi_8btou64(uint8_t *bytes
)
1384 rv
= (((uint64_t)bytes
[0]) << 56) |
1385 (((uint64_t)bytes
[1]) << 48) |
1386 (((uint64_t)bytes
[2]) << 40) |
1387 (((uint64_t)bytes
[3]) << 32) |
1388 (((uint64_t)bytes
[4]) << 24) |
1389 (((uint64_t)bytes
[5]) << 16) |
1390 (((uint64_t)bytes
[6]) << 8) |
1395 static __inline u_int32_t
1396 scsi_3btoul(u_int8_t
*bytes
)
1400 rv
= (bytes
[0] << 16) |
1406 static __inline
int32_t
1407 scsi_3btol(u_int8_t
*bytes
)
1409 u_int32_t rc
= scsi_3btoul(bytes
);
1411 if (rc
& 0x00800000)
1414 return (int32_t) rc
;
1417 static __inline u_int32_t
1418 scsi_4btoul(u_int8_t
*bytes
)
1422 rv
= (bytes
[0] << 24) |
1430 * Given the pointer to a returned mode sense buffer, return a pointer to
1431 * the start of the first mode page.
1433 static __inline
void *
1434 find_mode_page_6(struct scsi_mode_header_6
*mode_header
)
1438 page_start
= (void *)((u_int8_t
*)&mode_header
[1] +
1439 mode_header
->blk_desc_len
);
1444 static __inline
void *
1445 find_mode_page_10(struct scsi_mode_header_10
*mode_header
)
1449 page_start
= (void *)((u_int8_t
*)&mode_header
[1] +
1450 scsi_2btoul(mode_header
->blk_desc_len
));
1457 #endif /*_SCSI_SCSI_ALL_H*/