1 /* 2 * This header file contains public constants and structures used by 3 * the scsi code for linux. 4 * 5 * For documentation on the OPCODES, MESSAGES, and SENSE values, 6 * please consult the SCSI standard. 7 */ 8 #ifndef _SCSI_SCSI_H 9 #define _SCSI_SCSI_H 10 11 #include <linux/types.h> 12 13 /* 14 * The maximum sg list length SCSI can cope with 15 * (currently must be a power of 2 between 32 and 256) 16 */ 17 #define SCSI_MAX_PHYS_SEGMENTS MAX_PHYS_SEGMENTS 18 19 20 /* 21 * SCSI command lengths 22 */ 23 24 extern const unsigned char scsi_command_size[8]; 25 #define COMMAND_SIZE(opcode) scsi_command_size[((opcode) >> 5) & 7] 26 27 /* 28 * SCSI device types 29 */ 30 31 #define MAX_SCSI_DEVICE_CODE 14 32 extern const char *const scsi_device_types[MAX_SCSI_DEVICE_CODE]; 33 34 /* 35 * SCSI opcodes 36 */ 37 38 #define TEST_UNIT_READY 0x00 39 #define REZERO_UNIT 0x01 40 #define REQUEST_SENSE 0x03 41 #define FORMAT_UNIT 0x04 42 #define READ_BLOCK_LIMITS 0x05 43 #define REASSIGN_BLOCKS 0x07 44 #define INITIALIZE_ELEMENT_STATUS 0x07 45 #define READ_6 0x08 46 #define WRITE_6 0x0a 47 #define SEEK_6 0x0b 48 #define READ_REVERSE 0x0f 49 #define WRITE_FILEMARKS 0x10 50 #define SPACE 0x11 51 #define INQUIRY 0x12 52 #define RECOVER_BUFFERED_DATA 0x14 53 #define MODE_SELECT 0x15 54 #define RESERVE 0x16 55 #define RELEASE 0x17 56 #define COPY 0x18 57 #define ERASE 0x19 58 #define MODE_SENSE 0x1a 59 #define START_STOP 0x1b 60 #define RECEIVE_DIAGNOSTIC 0x1c 61 #define SEND_DIAGNOSTIC 0x1d 62 #define ALLOW_MEDIUM_REMOVAL 0x1e 63 64 #define SET_WINDOW 0x24 65 #define READ_CAPACITY 0x25 66 #define READ_10 0x28 67 #define WRITE_10 0x2a 68 #define SEEK_10 0x2b 69 #define POSITION_TO_ELEMENT 0x2b 70 #define WRITE_VERIFY 0x2e 71 #define VERIFY 0x2f 72 #define SEARCH_HIGH 0x30 73 #define SEARCH_EQUAL 0x31 74 #define SEARCH_LOW 0x32 75 #define SET_LIMITS 0x33 76 #define PRE_FETCH 0x34 77 #define READ_POSITION 0x34 78 #define SYNCHRONIZE_CACHE 0x35 79 #define LOCK_UNLOCK_CACHE 0x36 80 #define READ_DEFECT_DATA 0x37 81 #define MEDIUM_SCAN 0x38 82 #define COMPARE 0x39 83 #define COPY_VERIFY 0x3a 84 #define WRITE_BUFFER 0x3b 85 #define READ_BUFFER 0x3c 86 #define UPDATE_BLOCK 0x3d 87 #define READ_LONG 0x3e 88 #define WRITE_LONG 0x3f 89 #define CHANGE_DEFINITION 0x40 90 #define WRITE_SAME 0x41 91 #define READ_TOC 0x43 92 #define LOG_SELECT 0x4c 93 #define LOG_SENSE 0x4d 94 #define MODE_SELECT_10 0x55 95 #define RESERVE_10 0x56 96 #define RELEASE_10 0x57 97 #define MODE_SENSE_10 0x5a 98 #define PERSISTENT_RESERVE_IN 0x5e 99 #define PERSISTENT_RESERVE_OUT 0x5f 100 #define REPORT_LUNS 0xa0 101 #define MOVE_MEDIUM 0xa5 102 #define EXCHANGE_MEDIUM 0xa6 103 #define READ_12 0xa8 104 #define WRITE_12 0xaa 105 #define WRITE_VERIFY_12 0xae 106 #define SEARCH_HIGH_12 0xb0 107 #define SEARCH_EQUAL_12 0xb1 108 #define SEARCH_LOW_12 0xb2 109 #define READ_ELEMENT_STATUS 0xb8 110 #define SEND_VOLUME_TAG 0xb6 111 #define WRITE_LONG_2 0xea 112 #define READ_16 0x88 113 #define WRITE_16 0x8a 114 #define VERIFY_16 0x8f 115 #define SERVICE_ACTION_IN 0x9e 116 /* values for service action in */ 117 #define SAI_READ_CAPACITY_16 0x10 118 119 120 /* 121 * SCSI Architecture Model (SAM) Status codes. Taken from SAM-3 draft 122 * T10/1561-D Revision 4 Draft dated 7th November 2002. 123 */ 124 #define SAM_STAT_GOOD 0x00 125 #define SAM_STAT_CHECK_CONDITION 0x02 126 #define SAM_STAT_CONDITION_MET 0x04 127 #define SAM_STAT_BUSY 0x08 128 #define SAM_STAT_INTERMEDIATE 0x10 129 #define SAM_STAT_INTERMEDIATE_CONDITION_MET 0x14 130 #define SAM_STAT_RESERVATION_CONFLICT 0x18 131 #define SAM_STAT_COMMAND_TERMINATED 0x22 /* obsolete in SAM-3 */ 132 #define SAM_STAT_TASK_SET_FULL 0x28 133 #define SAM_STAT_ACA_ACTIVE 0x30 134 #define SAM_STAT_TASK_ABORTED 0x40 135 136 /** scsi_status_is_good - check the status return. 137 * 138 * @status: the status passed up from the driver (including host and 139 * driver components) 140 * 141 * This returns true for known good conditions that may be treated as 142 * command completed normally 143 */ 144 static inline int scsi_status_is_good(int status) 145 { 146 /* 147 * FIXME: bit0 is listed as reserved in SCSI-2, but is 148 * significant in SCSI-3. For now, we follow the SCSI-2 149 * behaviour and ignore reserved bits. 150 */ 151 status &= 0xfe; 152 return ((status == SAM_STAT_GOOD) || 153 (status == SAM_STAT_INTERMEDIATE) || 154 (status == SAM_STAT_INTERMEDIATE_CONDITION_MET) || 155 /* FIXME: this is obsolete in SAM-3 */ 156 (status == SAM_STAT_COMMAND_TERMINATED)); 157 } 158 159 /* 160 * Status codes. These are deprecated as they are shifted 1 bit right 161 * from those found in the SCSI standards. This causes confusion for 162 * applications that are ported to several OSes. Prefer SAM Status codes 163 * above. 164 */ 165 166 #define GOOD 0x00 167 #define CHECK_CONDITION 0x01 168 #define CONDITION_GOOD 0x02 169 #define BUSY 0x04 170 #define INTERMEDIATE_GOOD 0x08 171 #define INTERMEDIATE_C_GOOD 0x0a 172 #define RESERVATION_CONFLICT 0x0c 173 #define COMMAND_TERMINATED 0x11 174 #define QUEUE_FULL 0x14 175 #define ACA_ACTIVE 0x18 176 #define TASK_ABORTED 0x20 177 178 #define STATUS_MASK 0xfe 179 180 /* 181 * SENSE KEYS 182 */ 183 184 #define NO_SENSE 0x00 185 #define RECOVERED_ERROR 0x01 186 #define NOT_READY 0x02 187 #define MEDIUM_ERROR 0x03 188 #define HARDWARE_ERROR 0x04 189 #define ILLEGAL_REQUEST 0x05 190 #define UNIT_ATTENTION 0x06 191 #define DATA_PROTECT 0x07 192 #define BLANK_CHECK 0x08 193 #define COPY_ABORTED 0x0a 194 #define ABORTED_COMMAND 0x0b 195 #define VOLUME_OVERFLOW 0x0d 196 #define MISCOMPARE 0x0e 197 198 199 /* 200 * DEVICE TYPES 201 */ 202 203 #define TYPE_DISK 0x00 204 #define TYPE_TAPE 0x01 205 #define TYPE_PRINTER 0x02 206 #define TYPE_PROCESSOR 0x03 /* HP scanners use this */ 207 #define TYPE_WORM 0x04 /* Treated as ROM by our system */ 208 #define TYPE_ROM 0x05 209 #define TYPE_SCANNER 0x06 210 #define TYPE_MOD 0x07 /* Magneto-optical disk - 211 * - treated as TYPE_DISK */ 212 #define TYPE_MEDIUM_CHANGER 0x08 213 #define TYPE_COMM 0x09 /* Communications device */ 214 #define TYPE_ENCLOSURE 0x0d /* Enclosure Services Device */ 215 #define TYPE_RAID 0x0c 216 #define TYPE_RBC 0x0e 217 #define TYPE_NO_LUN 0x7f 218 219 /* 220 * standard mode-select header prepended to all mode-select commands 221 */ 222 223 struct ccs_modesel_head { 224 __u8 _r1; /* reserved */ 225 __u8 medium; /* device-specific medium type */ 226 __u8 _r2; /* reserved */ 227 __u8 block_desc_length; /* block descriptor length */ 228 __u8 density; /* device-specific density code */ 229 __u8 number_blocks_hi; /* number of blocks in this block desc */ 230 __u8 number_blocks_med; 231 __u8 number_blocks_lo; 232 __u8 _r3; 233 __u8 block_length_hi; /* block length for blocks in this desc */ 234 __u8 block_length_med; 235 __u8 block_length_lo; 236 }; 237 238 /* 239 * ScsiLun: 8 byte LUN. 240 */ 241 struct scsi_lun { 242 __u8 scsi_lun[8]; 243 }; 244 245 /* 246 * MESSAGE CODES 247 */ 248 249 #define COMMAND_COMPLETE 0x00 250 #define EXTENDED_MESSAGE 0x01 251 #define EXTENDED_MODIFY_DATA_POINTER 0x00 252 #define EXTENDED_SDTR 0x01 253 #define EXTENDED_EXTENDED_IDENTIFY 0x02 /* SCSI-I only */ 254 #define EXTENDED_WDTR 0x03 255 #define EXTENDED_PPR 0x04 256 #define EXTENDED_MODIFY_BIDI_DATA_PTR 0x05 257 #define SAVE_POINTERS 0x02 258 #define RESTORE_POINTERS 0x03 259 #define DISCONNECT 0x04 260 #define INITIATOR_ERROR 0x05 261 #define ABORT_TASK_SET 0x06 262 #define MESSAGE_REJECT 0x07 263 #define NOP 0x08 264 #define MSG_PARITY_ERROR 0x09 265 #define LINKED_CMD_COMPLETE 0x0a 266 #define LINKED_FLG_CMD_COMPLETE 0x0b 267 #define TARGET_RESET 0x0c 268 #define ABORT_TASK 0x0d 269 #define CLEAR_TASK_SET 0x0e 270 #define INITIATE_RECOVERY 0x0f /* SCSI-II only */ 271 #define RELEASE_RECOVERY 0x10 /* SCSI-II only */ 272 #define CLEAR_ACA 0x16 273 #define LOGICAL_UNIT_RESET 0x17 274 #define SIMPLE_QUEUE_TAG 0x20 275 #define HEAD_OF_QUEUE_TAG 0x21 276 #define ORDERED_QUEUE_TAG 0x22 277 #define IGNORE_WIDE_RESIDUE 0x23 278 #define ACA 0x24 279 #define QAS_REQUEST 0x55 280 281 /* Old SCSI2 names, don't use in new code */ 282 #define BUS_DEVICE_RESET TARGET_RESET 283 #define ABORT ABORT_TASK_SET 284 285 /* 286 * Host byte codes 287 */ 288 289 #define DID_OK 0x00 /* NO error */ 290 #define DID_NO_CONNECT 0x01 /* Couldn't connect before timeout period */ 291 #define DID_BUS_BUSY 0x02 /* BUS stayed busy through time out period */ 292 #define DID_TIME_OUT 0x03 /* TIMED OUT for other reason */ 293 #define DID_BAD_TARGET 0x04 /* BAD target. */ 294 #define DID_ABORT 0x05 /* Told to abort for some other reason */ 295 #define DID_PARITY 0x06 /* Parity error */ 296 #define DID_ERROR 0x07 /* Internal error */ 297 #define DID_RESET 0x08 /* Reset by somebody. */ 298 #define DID_BAD_INTR 0x09 /* Got an interrupt we weren't expecting. */ 299 #define DID_PASSTHROUGH 0x0a /* Force command past mid-layer */ 300 #define DID_SOFT_ERROR 0x0b /* The low level driver just wish a retry */ 301 #define DID_IMM_RETRY 0x0c /* Retry without decrementing retry count */ 302 #define DID_REQUEUE 0x0d /* Requeue command (no immediate retry) also 303 * without decrementing the retry count */ 304 #define DRIVER_OK 0x00 /* Driver status */ 305 306 /* 307 * These indicate the error that occurred, and what is available. 308 */ 309 310 #define DRIVER_BUSY 0x01 311 #define DRIVER_SOFT 0x02 312 #define DRIVER_MEDIA 0x03 313 #define DRIVER_ERROR 0x04 314 315 #define DRIVER_INVALID 0x05 316 #define DRIVER_TIMEOUT 0x06 317 #define DRIVER_HARD 0x07 318 #define DRIVER_SENSE 0x08 319 320 #define SUGGEST_RETRY 0x10 321 #define SUGGEST_ABORT 0x20 322 #define SUGGEST_REMAP 0x30 323 #define SUGGEST_DIE 0x40 324 #define SUGGEST_SENSE 0x80 325 #define SUGGEST_IS_OK 0xff 326 327 #define DRIVER_MASK 0x0f 328 #define SUGGEST_MASK 0xf0 329 330 /* 331 * Internal return values. 332 */ 333 334 #define NEEDS_RETRY 0x2001 335 #define SUCCESS 0x2002 336 #define FAILED 0x2003 337 #define QUEUED 0x2004 338 #define SOFT_ERROR 0x2005 339 #define ADD_TO_MLQUEUE 0x2006 340 #define TIMEOUT_ERROR 0x2007 341 342 /* 343 * Midlevel queue return values. 344 */ 345 #define SCSI_MLQUEUE_HOST_BUSY 0x1055 346 #define SCSI_MLQUEUE_DEVICE_BUSY 0x1056 347 #define SCSI_MLQUEUE_EH_RETRY 0x1057 348 349 /* 350 * Use these to separate status msg and our bytes 351 * 352 * These are set by: 353 * 354 * status byte = set from target device 355 * msg_byte = return status from host adapter itself. 356 * host_byte = set by low-level driver to indicate status. 357 * driver_byte = set by mid-level. 358 */ 359 #define status_byte(result) (((result) >> 1) & 0x7f) 360 #define msg_byte(result) (((result) >> 8) & 0xff) 361 #define host_byte(result) (((result) >> 16) & 0xff) 362 #define driver_byte(result) (((result) >> 24) & 0xff) 363 #define suggestion(result) (driver_byte(result) & SUGGEST_MASK) 364 365 #define sense_class(sense) (((sense) >> 4) & 0x7) 366 #define sense_error(sense) ((sense) & 0xf) 367 #define sense_valid(sense) ((sense) & 0x80); 368 369 /* 370 * default timeouts 371 */ 372 #define FORMAT_UNIT_TIMEOUT (2 * 60 * 60 * HZ) 373 #define START_STOP_TIMEOUT (60 * HZ) 374 #define MOVE_MEDIUM_TIMEOUT (5 * 60 * HZ) 375 #define READ_ELEMENT_STATUS_TIMEOUT (5 * 60 * HZ) 376 #define READ_DEFECT_DATA_TIMEOUT (60 * HZ ) 377 378 379 #define IDENTIFY_BASE 0x80 380 #define IDENTIFY(can_disconnect, lun) (IDENTIFY_BASE |\ 381 ((can_disconnect) ? 0x40 : 0) |\ 382 ((lun) & 0x07)) 383 384 /* 385 * struct scsi_device::scsi_level values. For SCSI devices other than those 386 * prior to SCSI-2 (i.e. over 12 years old) this value is (resp[2] + 1) 387 * where "resp" is a byte array of the response to an INQUIRY. The scsi_level 388 * variable is visible to the user via sysfs. 389 */ 390 391 #define SCSI_UNKNOWN 0 392 #define SCSI_1 1 393 #define SCSI_1_CCS 2 394 #define SCSI_2 3 395 #define SCSI_3 4 /* SPC */ 396 #define SCSI_SPC_2 5 397 #define SCSI_SPC_3 6 398 399 /* 400 * INQ PERIPHERAL QUALIFIERS 401 */ 402 #define SCSI_INQ_PQ_CON 0x00 403 #define SCSI_INQ_PQ_NOT_CON 0x01 404 #define SCSI_INQ_PQ_NOT_CAP 0x03 405 406 407 /* 408 * Here are some scsi specific ioctl commands which are sometimes useful. 409 * 410 * Note that include/linux/cdrom.h also defines IOCTL 0x5300 - 0x5395 411 */ 412 413 /* Used to obtain PUN and LUN info. Conflicts with CDROMAUDIOBUFSIZ */ 414 #define SCSI_IOCTL_GET_IDLUN 0x5382 415 416 /* 0x5383 and 0x5384 were used for SCSI_IOCTL_TAGGED_{ENABLE,DISABLE} */ 417 418 /* Used to obtain the host number of a device. */ 419 #define SCSI_IOCTL_PROBE_HOST 0x5385 420 421 /* Used to obtain the bus number for a device */ 422 #define SCSI_IOCTL_GET_BUS_NUMBER 0x5386 423 424 /* Used to obtain the PCI location of a device */ 425 #define SCSI_IOCTL_GET_PCI 0x5387 426 427 #endif /* _SCSI_SCSI_H */ 428