1 /* $NetBSD: scsipi_all.h,v 1.19 2001/05/22 15:14:24 bouyer Exp $ */ 2 3 /* 4 * SCSI and SCSI-like general interface description 5 */ 6 7 /* 8 * Largely written by Julian Elischer (julian@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@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 union { 87 struct { 88 u_int8_t unused; 89 u_int8_t length; 90 } scsi __attribute__((packed)); 91 struct { 92 u_int8_t length[2]; 93 } atapi __attribute__((packed)); 94 } u_len; 95 u_int8_t control; 96 } __attribute__((packed)); 97 98 #define MODE_SENSE_BIG 0x5A 99 struct scsipi_mode_sense_big { 100 u_int8_t opcode; 101 u_int8_t byte2; /* same bits as small version */ 102 u_int8_t page; /* same bits as small version */ 103 u_int8_t unused[4]; 104 u_int8_t length[2]; 105 u_int8_t control; 106 } __attribute__((packed)); 107 108 #define MODE_SELECT 0x15 109 struct scsipi_mode_select { 110 u_int8_t opcode; 111 u_int8_t byte2; 112 #define SMS_SP 0x01 /* save page */ 113 #define SMS_PF 0x10 114 u_int8_t unused; 115 union { 116 struct { 117 u_int8_t unused; 118 u_int8_t length; 119 } scsi __attribute__((packed)); 120 struct { 121 u_int8_t length[2]; 122 } atapi __attribute__((packed)); 123 } u_len; 124 u_int8_t control; 125 } __attribute__((packed)); 126 127 #define MODE_SELECT_BIG 0x55 128 struct scsipi_mode_select_big { 129 u_int8_t opcode; 130 u_int8_t byte2; /* same bits as small version */ 131 u_int8_t unused[5]; 132 u_int8_t length[2]; 133 u_int8_t control; 134 } __attribute__((packed)); 135 136 #define INQUIRY 0x12 137 struct scsipi_inquiry { 138 u_int8_t opcode; 139 u_int8_t byte2; 140 u_int8_t unused[2]; 141 u_int8_t length; 142 u_int8_t control; 143 } __attribute__((packed)); 144 145 #define PREVENT_ALLOW 0x1e 146 struct scsipi_prevent { 147 u_int8_t opcode; 148 u_int8_t byte2; 149 u_int8_t unused[2]; 150 u_int8_t how; 151 u_int8_t control; 152 } __attribute__((packed)); 153 #define PR_PREVENT 0x01 154 #define PR_ALLOW 0x00 155 156 /* 157 * inquiry and sense data format 158 */ 159 160 struct scsipi_sense_data { 161 /* 1*/ u_int8_t error_code; 162 #define SSD_ERRCODE 0x7F 163 #define SSD_ERRCODE_VALID 0x80 164 /* 2*/ u_int8_t segment; 165 /* 3*/ u_int8_t flags; 166 #define SSD_KEY 0x0F 167 #define SSD_ILI 0x20 168 #define SSD_EOM 0x40 169 #define SSD_FILEMARK 0x80 170 /* 7*/ u_int8_t info[4]; 171 /* 8*/ u_int8_t extra_len; 172 /*12*/ u_int8_t cmd_spec_info[4]; 173 /*13*/ u_int8_t add_sense_code; 174 /*14*/ u_int8_t add_sense_code_qual; 175 /*15*/ u_int8_t fru; 176 /*16*/ u_int8_t sense_key_spec_1; 177 #define SSD_SCS_VALID 0x80 178 /*17*/ u_int8_t sense_key_spec_2; 179 /*18*/ u_int8_t sense_key_spec_3; 180 /*32*/ u_int8_t extra_bytes[14]; 181 } __attribute__((packed)); 182 183 #define SKEY_NO_SENSE 0x00 184 #define SKEY_RECOVERED_ERROR 0x01 185 #define SKEY_NOT_READY 0x02 186 #define SKEY_MEDIUM_ERROR 0x03 187 #define SKEY_HARDWARE_ERROR 0x04 188 #define SKEY_ILLEGAL_REQUEST 0x05 189 #define SKEY_UNIT_ATTENTION 0x06 190 #define SKEY_WRITE_PROTECT 0x07 191 #define SKEY_BLANK_CHECK 0x08 192 #define SKEY_VENDOR_UNIQUE 0x09 193 #define SKEY_COPY_ABORTED 0x0A 194 #define SKEY_ABORTED_COMMAND 0x0B 195 #define SKEY_EQUAL 0x0C 196 #define SKEY_VOLUME_OVERFLOW 0x0D 197 #define SKEY_MISCOMPARE 0x0E 198 #define SKEY_RESERVED 0x0F 199 200 /* 201 * Sense bytes described by the extra_len tag start at cmd_spec_info, 202 * and can only continue up to the end of the structure we've defined 203 * (which is too short for some cases). 204 */ 205 #define ADD_BYTES_LIM(sp) \ 206 ((((int)(sp)->extra_len) < (int) sizeof(struct scsipi_sense_data) - 8)? \ 207 ((sp)->extra_len) : (sizeof (struct scsipi_sense_data) - 8)) 208 209 210 struct scsipi_sense_data_unextended { 211 /* 1*/ u_int8_t error_code; 212 /* 4*/ u_int8_t block[3]; 213 } __attribute__((packed)); 214 215 #define T_REMOV 1 /* device is removable */ 216 #define T_FIXED 0 /* device is not removable */ 217 218 /* 219 * According to SPC-2r16, in order to know if a U3W device support PPR, 220 * Inquiry Data structure should be at least 57 Bytes 221 */ 222 223 struct scsipi_inquiry_data { 224 /* 1*/ u_int8_t device; 225 #define SID_TYPE 0x1f /* device type mask */ 226 #define SID_QUAL 0xe0 /* device qualifier mask */ 227 #define SID_QUAL_LU_PRESENT 0x00 /* logical unit present */ 228 #define SID_QUAL_LU_NOTPRESENT 0x20 /* logical unit not present */ 229 #define SID_QUAL_reserved 0x40 230 #define SID_QUAL_LU_NOT_SUPP 0x60 /* logical unit not supported */ 231 232 #define T_DIRECT 0x00 /* direct access device */ 233 #define T_SEQUENTIAL 0x01 /* sequential access device */ 234 #define T_PRINTER 0x02 /* printer device */ 235 #define T_PROCESSOR 0x03 /* processor device */ 236 #define T_WORM 0x04 /* write once, read many device */ 237 #define T_CDROM 0x05 /* cd-rom device */ 238 #define T_SCANNER 0x06 /* scanner device */ 239 #define T_OPTICAL 0x07 /* optical memory device */ 240 #define T_CHANGER 0x08 /* medium changer device */ 241 #define T_COMM 0x09 /* communication device */ 242 #define T_IT8_1 0x0a /* Defined by ASC IT8... */ 243 #define T_IT8_2 0x0b /* ...(Graphic arts pre-press devices) */ 244 #define T_STORARRAY 0x0c /* storage array device */ 245 #define T_ENCLOSURE 0x0d /* enclosure services device */ 246 #define T_SIMPLE_DIRECT 0x0E /* Simplified direct-access device */ 247 #define T_OPTIC_CARD_RW 0x0F /* Optical card reader/writer device */ 248 #define T_OBJECT_STORED 0x11 /* Object-based Storage Device */ 249 #define T_NODEVICE 0x1f 250 251 u_int8_t dev_qual2; 252 #define SID_QUAL2 0x7F 253 #define SID_REMOVABLE 0x80 254 255 /* 3*/ u_int8_t version; 256 #define SID_ANSII 0x07 257 #define SID_ECMA 0x38 258 #define SID_ISO 0xC0 259 260 /* 4*/ u_int8_t response_format; 261 #define SID_RespDataFmt 0x0F 262 #define SID_FORMAT_SCSI1 0x00 /* SCSI-1 format */ 263 #define SID_FORMAT_CCS 0x01 /* SCSI CCS format */ 264 #define SID_FORMAT_ISO 0x02 /* ISO format */ 265 266 /* 5*/ u_int8_t additional_length; /* n-4 */ 267 /* 6*/ u_int8_t flags1; 268 #define SID_SCC 0x80 269 /* 7*/ u_int8_t flags2; 270 #define SID_Addr16 0x01 271 #define SID_MChngr 0x08 272 #define SID_MultiPort 0x10 273 #define SID_EncServ 0x40 274 #define SID_BasQue 0x80 275 /* 8*/ u_int8_t flags3; 276 #define SID_SftRe 0x01 277 #define SID_CmdQue 0x02 278 #define SID_Linked 0x08 279 #define SID_Sync 0x10 280 #define SID_WBus16 0x20 281 #define SID_WBus32 0x40 282 #define SID_RelAdr 0x80 283 /* 9*/ char vendor[8]; 284 /*17*/ char product[16]; 285 /*33*/ char revision[4]; 286 /*37*/ u_int8_t vendor_specific[20]; 287 /*57*/ u_int8_t flags4; 288 #define SID_IUS 0x01 289 #define SID_QAS 0x02 290 #define SID_Clocking 0x0C 291 #define SID_CLOCKING_ST_ONLY 0x00 292 #define SID_CLOCKING_DT_ONLY 0x04 293 #define SID_CLOCKING_SD_DT 0x0C 294 /*58*/ u_int8_t reserved; 295 /*59*/ char version_descriptor[8][2]; 296 } __attribute__((packed)); /* 74 Bytes */ 297 298 /* Data structures for mode select/mode sense */ 299 struct scsipi_mode_header { 300 u_int8_t data_length; /* Sense data length */ 301 u_int8_t medium_type; 302 u_int8_t dev_spec; 303 u_int8_t blk_desc_len; /* unused on ATAPI */ 304 } __attribute__((packed)); 305 306 struct scsipi_mode_header_big { 307 u_int8_t data_length[2]; /* Sense data length */ 308 u_int8_t medium_type; 309 u_int8_t dev_spec; 310 u_int8_t unused[2]; /* unused on ATAPI */ 311 u_int8_t blk_desc_len[2]; /* unused on ATAPI */ 312 } __attribute__((packed)); 313 314 315 #endif /* _DEV_SCSIPI_SCSIPI_ALL_H_ */ 316