Home | History | Annotate | Line # | Download | only in scsipi
scsipi_all.h revision 1.23
      1 /*	$NetBSD: scsipi_all.h,v 1.23 2003/09/08 03:24:12 mycroft Exp $	*/
      2 
      3 /*
      4  * SCSI and SCSI-like general interface description
      5  */
      6 
      7 /*
      8  * Largely written by Julian Elischer (julian (at) tfs.com)
      9  * for TRW Financial Systems.
     10  *
     11  * TRW Financial Systems, in accordance with their agreement with Carnegie
     12  * Mellon University, makes this software available to CMU to distribute
     13  * or use in any manner that they see fit as long as this message is kept with
     14  * the software. For this reason TFS also grants any other persons or
     15  * organisations permission to use or modify this software.
     16  *
     17  * TFS supplies this software to be publicly redistributed
     18  * on the understanding that TFS is not responsible for the correct
     19  * functioning of this software in any circumstances.
     20  *
     21  * Ported to run under 386BSD by Julian Elischer (julian (at) tfs.com) Sept 1992
     22  */
     23 
     24 #ifndef _DEV_SCSIPI_SCSIPI_ALL_H_
     25 #define	_DEV_SCSIPI_SCSIPI_ALL_H_
     26 
     27 /*
     28  * SCSI-like command format and opcode
     29  */
     30 
     31 /*
     32  * Some basic, common SCSI command group definitions.
     33  */
     34 
     35 #define	CDB_GROUPID(cmd)        ((cmd >> 5) & 0x7)
     36 #define	CDB_GROUPID_0	0
     37 #define	CDB_GROUPID_1	1
     38 #define	CDB_GROUPID_2	2
     39 #define	CDB_GROUPID_3	3
     40 #define	CDB_GROUPID_4	4
     41 #define	CDB_GROUPID_5	5
     42 #define	CDB_GROUPID_6	6
     43 #define	CDB_GROUPID_7	7
     44 
     45 #define	CDB_GROUP0	6       /*  6-byte cdb's */
     46 #define	CDB_GROUP1	10      /* 10-byte cdb's */
     47 #define	CDB_GROUP2	10      /* 10-byte cdb's */
     48 #define	CDB_GROUP3	0       /* reserved */
     49 #define	CDB_GROUP4	16      /* 16-byte cdb's */
     50 #define	CDB_GROUP5	12      /* 12-byte cdb's */
     51 #define	CDB_GROUP6	0       /* vendor specific */
     52 #define	CDB_GROUP7	0       /* vendor specific */
     53 
     54 /*
     55  * Some basic, common SCSI commands
     56  */
     57 #define	TEST_UNIT_READY		0x00
     58 struct scsipi_test_unit_ready {
     59 	u_int8_t opcode;
     60 	u_int8_t byte2;
     61 	u_int8_t unused[3];
     62 	u_int8_t control;
     63 };
     64 
     65 #define	REQUEST_SENSE		0x03
     66 struct scsipi_sense {
     67 	u_int8_t opcode;
     68 	u_int8_t byte2;
     69 	u_int8_t unused[2];
     70 	u_int8_t length;
     71 	u_int8_t control;
     72 };
     73 
     74 #define	MODE_SENSE		0x1a
     75 struct scsipi_mode_sense {
     76 	u_int8_t opcode;
     77 	u_int8_t byte2;
     78 #define	SMS_DBD				0x08 /* disable block descriptors */
     79 	u_int8_t page;
     80 #define	SMS_PAGE_CODE 			0x3F
     81 #define	SMS_PAGE_CTRL 			0xC0
     82 #define	SMS_PAGE_CTRL_CURRENT 		0x00
     83 #define	SMS_PAGE_CTRL_CHANGEABLE 	0x40
     84 #define	SMS_PAGE_CTRL_DEFAULT 		0x80
     85 #define	SMS_PAGE_CTRL_SAVED 		0xC0
     86 	u_int8_t unused;
     87 	u_int8_t length;
     88 	u_int8_t control;
     89 } __attribute__((packed));
     90 
     91 #define	MODE_SENSE_BIG		0x5A
     92 struct scsipi_mode_sense_big {
     93 	u_int8_t opcode;
     94 	u_int8_t byte2;		/* same bits as small version */
     95 	u_int8_t page; 		/* same bits as small version */
     96 	u_int8_t unused[4];
     97 	u_int8_t length[2];
     98 	u_int8_t control;
     99 } __attribute__((packed));
    100 
    101 #define	MODE_SELECT		0x15
    102 struct scsipi_mode_select {
    103 	u_int8_t opcode;
    104 	u_int8_t byte2;
    105 #define	SMS_SP	0x01		/* save page */
    106 #define	SMS_PF	0x10		/* page format (0 = SCSI-1, 1 = SCSI-2) */
    107 	u_int8_t unused;
    108 	union {
    109 		struct {
    110 			u_int8_t unused;
    111 			u_int8_t length;
    112 		} scsi __attribute__((packed));
    113 		struct {
    114 			u_int8_t length[2];
    115 		} atapi __attribute__((packed));
    116 	} u_len;
    117 	u_int8_t control;
    118 } __attribute__((packed));
    119 
    120 #define	MODE_SELECT_BIG		0x55
    121 struct scsipi_mode_select_big {
    122 	u_int8_t opcode;
    123 	u_int8_t byte2;		/* same bits as small version */
    124 	u_int8_t unused[5];
    125 	u_int8_t length[2];
    126 	u_int8_t control;
    127 } __attribute__((packed));
    128 
    129 #define	INQUIRY			0x12
    130 struct scsipi_inquiry {
    131 	u_int8_t opcode;
    132 	u_int8_t byte2;
    133 	u_int8_t unused[2];
    134 	u_int8_t length;
    135 	u_int8_t control;
    136 } __attribute__((packed));
    137 
    138 #define START_STOP		0x1b
    139 struct scsipi_start_stop {
    140 	u_int8_t opcode;
    141 	u_int8_t byte2;
    142 	u_int8_t unused[2];
    143 	u_int8_t how;
    144 #define SSS_STOP		0x00
    145 #define SSS_START		0x01
    146 #define SSS_LOEJ		0x02
    147 	u_int8_t control;
    148 };
    149 
    150 #define	PREVENT_ALLOW		0x1e
    151 struct scsipi_prevent {
    152 	u_int8_t opcode;
    153 	u_int8_t byte2;
    154 	u_int8_t unused[2];
    155 	u_int8_t how;
    156 	u_int8_t control;
    157 } __attribute__((packed));
    158 #define	PR_PREVENT 0x01
    159 #define	PR_ALLOW   0x00
    160 
    161 /*
    162  * inquiry and sense data format
    163  */
    164 
    165 struct scsipi_sense_data {
    166 /* 1*/	u_int8_t error_code;
    167 #define	SSD_ERRCODE	0x7F
    168 #define	SSD_ERRCODE_VALID 0x80
    169 /* 2*/	u_int8_t segment;
    170 /* 3*/	u_int8_t flags;
    171 #define	SSD_KEY		0x0F
    172 #define	SSD_ILI		0x20
    173 #define	SSD_EOM		0x40
    174 #define	SSD_FILEMARK	0x80
    175 /* 7*/	u_int8_t info[4];
    176 /* 8*/	u_int8_t extra_len;
    177 /*12*/	u_int8_t cmd_spec_info[4];
    178 /*13*/	u_int8_t add_sense_code;
    179 /*14*/	u_int8_t add_sense_code_qual;
    180 /*15*/	u_int8_t fru;
    181 /*16*/	u_int8_t sense_key_spec_1;
    182 #define	SSD_SCS_VALID	0x80
    183 /*17*/	u_int8_t sense_key_spec_2;
    184 /*18*/	u_int8_t sense_key_spec_3;
    185 /*32*/	u_int8_t extra_bytes[14];
    186 } __attribute__((packed));
    187 
    188 #define	SKEY_NO_SENSE		0x00
    189 #define	SKEY_RECOVERED_ERROR	0x01
    190 #define	SKEY_NOT_READY		0x02
    191 #define	SKEY_MEDIUM_ERROR	0x03
    192 #define	SKEY_HARDWARE_ERROR	0x04
    193 #define	SKEY_ILLEGAL_REQUEST	0x05
    194 #define	SKEY_UNIT_ATTENTION	0x06
    195 #define	SKEY_WRITE_PROTECT	0x07
    196 #define	SKEY_BLANK_CHECK	0x08
    197 #define	SKEY_VENDOR_UNIQUE	0x09
    198 #define	SKEY_COPY_ABORTED	0x0A
    199 #define	SKEY_ABORTED_COMMAND	0x0B
    200 #define	SKEY_EQUAL		0x0C
    201 #define	SKEY_VOLUME_OVERFLOW	0x0D
    202 #define	SKEY_MISCOMPARE		0x0E
    203 #define	SKEY_RESERVED		0x0F
    204 
    205 /*
    206  * Sense bytes described by the extra_len tag start at cmd_spec_info,
    207  * and can only continue up to the end of the structure we've defined
    208  * (which is too short for some cases).
    209  */
    210 #define	ADD_BYTES_LIM(sp)	\
    211 	((((int)(sp)->extra_len) < (int) sizeof(struct scsipi_sense_data) - 8)? \
    212 	((sp)->extra_len) : (sizeof (struct scsipi_sense_data) - 8))
    213 
    214 
    215 struct scsipi_sense_data_unextended {
    216 /* 1*/	u_int8_t error_code;
    217 /* 4*/	u_int8_t block[3];
    218 } __attribute__((packed));
    219 
    220 #define	T_REMOV		1	/* device is removable */
    221 #define	T_FIXED		0	/* device is not removable */
    222 
    223 /*
    224  * According to SPC-2r16, in order to know if a U3W device support PPR,
    225  * Inquiry Data structure should be at least 57 Bytes
    226  */
    227 
    228 struct scsipi_inquiry_data {
    229 /* 1*/	u_int8_t device;
    230 #define	SID_TYPE		0x1f	/* device type mask */
    231 #define	SID_QUAL		0xe0	/* device qualifier mask */
    232 #define	SID_QUAL_LU_PRESENT	0x00	/* logical unit present */
    233 #define	SID_QUAL_LU_NOTPRESENT	0x20	/* logical unit not present */
    234 #define	SID_QUAL_reserved	0x40
    235 #define	SID_QUAL_LU_NOT_SUPP	0x60	/* logical unit not supported */
    236 
    237 #define	T_DIRECT		0x00	/* direct access device */
    238 #define	T_SEQUENTIAL		0x01	/* sequential access device */
    239 #define	T_PRINTER		0x02	/* printer device */
    240 #define	T_PROCESSOR		0x03	/* processor device */
    241 #define	T_WORM			0x04	/* write once, read many device */
    242 #define	T_CDROM			0x05	/* cd-rom device */
    243 #define	T_SCANNER 		0x06	/* scanner device */
    244 #define	T_OPTICAL 		0x07	/* optical memory device */
    245 #define	T_CHANGER		0x08	/* medium changer device */
    246 #define	T_COMM			0x09	/* communication device */
    247 #define	T_IT8_1			0x0a	/* Defined by ASC IT8... */
    248 #define	T_IT8_2			0x0b	/* ...(Graphic arts pre-press devices) */
    249 #define	T_STORARRAY		0x0c	/* storage array device */
    250 #define	T_ENCLOSURE		0x0d	/* enclosure services device */
    251 #define	T_SIMPLE_DIRECT		0x0E	/* Simplified direct-access device */
    252 #define	T_OPTIC_CARD_RW		0x0F	/* Optical card reader/writer device */
    253 #define	T_OBJECT_STORED		0x11	/* Object-based Storage Device */
    254 #define	T_NODEVICE		0x1f
    255 
    256 	u_int8_t dev_qual2;
    257 #define	SID_QUAL2		0x7F
    258 #define	SID_REMOVABLE		0x80
    259 
    260 /* 3*/	u_int8_t version;
    261 #define	SID_ANSII	0x07
    262 #define	SID_ECMA	0x38
    263 #define	SID_ISO		0xC0
    264 
    265 /* 4*/	u_int8_t response_format;
    266 #define	SID_RespDataFmt	0x0F
    267 #define	SID_FORMAT_SCSI1	0x00	/* SCSI-1 format */
    268 #define	SID_FORMAT_CCS		0x01	/* SCSI CCS format */
    269 #define	SID_FORMAT_ISO		0x02	/* ISO format */
    270 
    271 /* 5*/	u_int8_t additional_length;	/* n-4 */
    272 /* 6*/	u_int8_t flags1;
    273 #define	SID_SCC		0x80
    274 /* 7*/	u_int8_t flags2;
    275 #define	SID_Addr16	0x01
    276 #define SID_MChngr	0x08
    277 #define	SID_MultiPort	0x10
    278 #define	SID_EncServ	0x40
    279 #define	SID_BasQue	0x80
    280 /* 8*/	u_int8_t flags3;
    281 #define	SID_SftRe	0x01
    282 #define	SID_CmdQue	0x02
    283 #define	SID_Linked	0x08
    284 #define	SID_Sync	0x10
    285 #define	SID_WBus16	0x20
    286 #define	SID_WBus32	0x40
    287 #define	SID_RelAdr	0x80
    288 /* 9*/	char    vendor[8];
    289 /*17*/	char    product[16];
    290 /*33*/	char    revision[4];
    291 /*37*/	u_int8_t vendor_specific[20];
    292 /*57*/	u_int8_t flags4;
    293 #define        SID_IUS         0x01
    294 #define        SID_QAS         0x02
    295 #define        SID_Clocking    0x0C
    296 #define	SID_CLOCKING_ST_ONLY  0x00
    297 #define	SID_CLOCKING_DT_ONLY  0x04
    298 #define	SID_CLOCKING_SD_DT    0x0C
    299 /*58*/	u_int8_t reserved;
    300 /*59*/	char    version_descriptor[8][2];
    301 } __attribute__((packed)); /* 74 Bytes */
    302 
    303 /* Data structures for mode select/mode sense */
    304 struct scsipi_mode_header {
    305 	u_int8_t data_length;	/* Sense data length */
    306 	u_int8_t medium_type;
    307 	u_int8_t dev_spec;
    308 	u_int8_t blk_desc_len;	/* unused on ATAPI */
    309 } __attribute__((packed));
    310 
    311 struct scsipi_mode_header_big {
    312 	u_int8_t data_length[2];	/* Sense data length */
    313 	u_int8_t medium_type;
    314 	u_int8_t dev_spec;
    315 	u_int8_t unused[2];		/* unused on ATAPI */
    316 	u_int8_t blk_desc_len[2];	/* unused on ATAPI */
    317 } __attribute__((packed));
    318 
    319 /*
    320  * This part is common to all mode pages.
    321  */
    322 struct scsipi_mode_page_header {
    323 	u_int8_t pg_code;		/* page code */
    324 #define	PGCODE_MASK	0x3f		/* page code mask */
    325 #define	PGCODE_PS	0x80		/* page is savable */
    326 	u_int8_t pg_length;		/* page length (not including hdr) */
    327 } __attribute__((__packed__));
    328 
    329 #endif /* _DEV_SCSIPI_SCSIPI_ALL_H_ */
    330