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