1 /* 2 * Copyright 2004-2010, Haiku, Inc. All RightsReserved. 3 * Copyright 2002/03, Thomas Kurschel. All rights reserved. 4 * 5 * Distributed under the terms of the MIT License. 6 */ 7 #ifndef _SCSI_CMDS_H 8 #define _SCSI_CMDS_H 9 10 11 //! SCSI commands and their data structures and constants 12 13 14 #include <lendian_bitfield.h> 15 16 17 // Always keep in mind that SCSI is big-endian! 18 19 #define SCSI_STD_TIMEOUT 10 20 21 // SCSI device status (as the result of a command) 22 #define SCSI_STATUS_GOOD (0 << 1) 23 #define SCSI_STATUS_CHECK_CONDITION (1 << 1) // error occured 24 #define SCSI_STATUS_CONDITION_MET (2 << 1) 25 // "found" for SEARCH DATA and PREFETCH 26 #define SCSI_STATUS_BUSY (4 << 1) 27 // try again later (??? == QUEUE_FULL ???) 28 #define SCSI_STATUS_INTERMEDIATE (8 << 1) 29 // used by linked command only 30 #define SCSI_STATUS_INTERMEDIATE_COND_MET (10 << 1) // ditto 31 #define SCSI_STATUS_RESERVATION_CONFLICT (12 << 1) 32 // only if RESERVE/RELEASE is used 33 #define SCSI_STATUS_COMMAND_TERMINATED (17 << 1) 34 // aborted by TERMINATE I/O PROCESS 35 #define SCSI_STATUS_QUEUE_FULL (20 << 1) // queue full 36 37 #define SCSI_STATUS_MASK 0xfe 38 39 // SCSI sense key 40 #define SCSIS_KEY_NO_SENSE 0 41 #define SCSIS_KEY_RECOVERED_ERROR 1 42 #define SCSIS_KEY_NOT_READY 2 43 // operator intervention may be required 44 #define SCSIS_KEY_MEDIUM_ERROR 3 45 // can be set if source could be hardware error 46 #define SCSIS_KEY_HARDWARE_ERROR 4 47 #define SCSIS_KEY_ILLEGAL_REQUEST 5 // invalid command 48 #define SCSIS_KEY_UNIT_ATTENTION 6 49 // medium changed or target reset 50 #define SCSIS_KEY_DATA_PROTECT 7 // data access forbidden 51 #define SCSIS_KEY_BLANK_CHECK 8 52 // tried to read blank or to write non-blank medium 53 #define SCSIS_KEY_VENDOR_SPECIFIC 9 54 #define SCSIS_KEY_COPY_ABORTED 10 55 // error in COPY or COMPARE command 56 #define SCSIS_KEY_ABORTED_COMMAND 11 57 // aborted by target, retry *may* help 58 #define SCSIS_KEY_EQUAL 12 // during SEARCH: data found 59 #define SCSIS_KEY_VOLUME_OVERFLOW 13 60 // tried to write buffered data beyond end of medium 61 #define SCSIS_KEY_MISCOMPARE 14 62 #define SCSIS_KEY_RESERVED 15 63 64 // SCSI ASC and ASCQ data - (ASC << 8) | ASCQ 65 // all codes with bit 7 of ASC or ASCQ set are vendor-specific 66 #define SCSIS_ASC_NO_SENSE 0x0000 67 #define SCSIS_ASC_IO_PROC_TERMINATED 0x0006 68 #define SCSIS_ASC_AUDIO_PLAYING 0x0011 69 #define SCSIS_ASC_AUDIO_PAUSED 0x0012 70 #define SCSIS_ASC_AUDIO_COMPLETED 0x0013 71 #define SCSIS_ASC_AUDIO_ERROR 0x0014 72 // playing has stopped due to error 73 #define SCSIS_ASC_AUDIO_NO_STATUS 0x0015 74 #define SCSIS_ASC_NO_INDEX 0x0100 // no index/sector signal 75 #define SCSIS_ASC_NO_SEEK_CMP 0x0200 // ??? 76 #define SCSIS_ASC_WRITE_FAULT 0x0300 77 #define SCSIS_ASC_LUN_NOT_READY 0x0400 78 // LUN not ready, cause not reportable 79 #define SCSIS_ASC_LUN_BECOMING_READY 0x0401 80 // LUN in progress of becoming ready 81 #define SCSIS_ASC_LUN_NEED_INIT 0x0402 82 // LUN need initializing command 83 #define SCSIS_ASC_LUN_NEED_MANUAL_HELP 0x0403 84 // LUN needs manual intervention 85 #define SCSIS_ASC_LUN_FORMATTING 0x0404 86 // LUN format in progress 87 #define SCSIS_ASC_LUN_SEL_FAILED 0x0500 88 // LUN doesn't respond to selection 89 #define SCSIS_ASC_LUN_COM_FAILURE 0x0800 // LUN communication failure 90 #define SCSIS_ASC_LUN_TIMEOUT 0x0801 91 // LUN communication time-out 92 #define SCSIS_ASC_LUN_COM_PARITY 0x0802 93 // LUN communication parity failure 94 #define SCSIS_ASC_LUN_COM_CRC 0x0803 95 // LUN communication CRC failure (SCSI-3) 96 #define SCSIS_ASC_WRITE_ERR_AUTOREALLOC 0x0c01 97 // recovered by auto-reallocation 98 #define SCSIS_ASC_WRITE_ERR_AUTOREALLOC_FAILED 0x0c02 99 #define SCSIS_ASC_ECC_ERROR 0x1000 100 #define SCSIS_ASC_UNREC_READ_ERR 0x1100 // unrecovered read error 101 #define SCSIS_ASC_READ_RETRIES_EXH 0x1101 // read retries exhausted 102 #define SCSIS_ASC_UNREC_READ_ERR_AUTOREALLOC_FAILED 0x1104 103 // above + auto-reallocate failed 104 #define SCSIS_ASC_RECORD_NOT_FOUND 0x1401 105 #define SCSIS_ASC_RANDOM_POS_ERROR 0x1500 // random positioning error 106 #define SCSIS_ASC_POSITIONING_ERR 0x1501 107 // mechanical positioning error 108 #define SCSIS_ASC_POS_ERR_ON_READ 0x1502 109 // positioning error detected by reading 110 #define SCSIS_ASC_DATA_RECOV_NO_ERR_CORR 0x1700 111 // recovered with no error correction applied 112 #define SCSIS_ASC_DATA_RECOV_WITH_RETRIES 0x1701 113 #define SCSIS_ASC_DATA_RECOV_POS_HEAD_OFS 0x1702 114 // ?recovered with positive head offset 115 #define SCSIS_ASC_DATA_RECOV_NEG_HEAD_OFS 0x1703 116 // ?recovered with negative head offset 117 #define SCSIS_ASC_DATA_RECOV_WITH_RETRIES_CIRC 0x1704 118 // recovered with retries/CIRC 119 #define SCSIS_ASC_DATA_RECOV_PREV_SECT_ID 0x1705 120 // recovered using previous sector ID 121 #define SCSIS_ASC_DATA_RECOV_NO_ECC_AUTOREALLOC 0x1706 122 #define SCSIS_ASC_DATA_RECOV_NO_ECC_REASSIGN 0x1707 // reassign recommended 123 #define SCSIS_ASC_DATA_RECOV_NO_ECC_REWRITE 0x1708 // rewrite recommended 124 #define SCSIS_ASC_DATA_RECOV_WITH_CORR 0x1800 125 // recovered using error correction 126 #define SCSIS_ASC_DATA_RECOV_WITH_CORR_RETRIES 0x1801 127 // used error correction and retries 128 #define SCSIS_ASC_DATA_RECOV_AUTOREALLOC 0x1802 129 #define SCSIS_ASC_DATA_RECOV_CIRC 0x1803 // recovered using CIRC 130 #define SCSIS_ASC_DATA_RECOV_LEC 0x1804 // recovered using LEC 131 #define SCSIS_ASC_DATA_RECOV_REASSIGN 0x1805 // reassign recommended 132 #define SCSIS_ASC_DATA_RECOV_REWRITE 0x1806 // rewrite recommended 133 #define SCSIS_ASC_PARAM_LIST_LENGTH_ERR 0x1a00 // parameter list too short 134 #define SCSIS_ASC_ID_RECOV 0x1e00 // recoved ID with ECC 135 #define SCSIS_ASC_INV_OPCODE 0x2000 136 #define SCSIS_ASC_LBA_OOR 0x2100 // LBA out of range 137 #define SCSIS_ASC_ILL_FUNCTION 0x2200 138 // better use 0x2000/0x2400/0x2600 instead 139 #define SCSIS_ASC_INV_CDB_FIELD 0x2400 140 #define SCSIS_ASC_LUN_NOT_SUPPORTED 0x2500 141 #define SCSIS_ASC_INV_PARAM_LIST_FIELD 0x2600 142 #define SCSIS_ASC_PARAM_NOT_SUPPORTED 0x2601 143 #define SCSIS_ASC_PARAM_VALUE_INV 0x2602 144 #define SCSIS_ASC_WRITE_PROTECTED 0x2700 145 #define SCSIS_ASC_MEDIUM_CHANGED 0x2800 146 #define SCSIS_ASC_WAS_RESET 0x2900 147 // reset by power-on/bus reset/device reset 148 #define SCSIS_ASC_PARAMS_CHANGED 0x2a00 149 #define SCSIS_ASC_CAPACITY_DATA_HAS_CHANGED 0x2a09 150 #define SCSIS_ASC_MEDIUM_FORMAT_CORRUPTED 0x3100 151 #define SCSIS_ASC_ROUNDED_PARAM 0x3700 // parameter got rounded 152 #define SCSIS_ASC_NO_MEDIUM 0x3a00 // medium not present 153 #define SCSIS_ASC_INTERNAL_FAILURE 0x4400 154 #define SCSIS_ASC_SEL_FAILURE 0x4500 // select/reselect failure 155 #define SCSIS_ASC_UNSUCC_SOFT_RESET 0x4600 // unsuccessful soft reset 156 #define SCSIS_ASC_SCSI_PARITY_ERR 0x4700 // SCSI parity error 157 #define SCSIS_ASC_LOAD_EJECT_FAILED 0x5300 158 // media load or eject failed 159 #define SCSIS_ASC_REMOVAL_PREVENTED 0x5302 // medium removal prevented 160 #define SCSIS_ASC_REMOVAL_REQUESTED 0x5a01 161 // operator requests medium removal 162 163 // some scsi op-codes 164 #define SCSI_OP_TEST_UNIT_READY 0x00 165 #define SCSI_OP_REQUEST_SENSE 0x03 166 #define SCSI_OP_FORMAT 0x04 167 #define SCSI_OP_READ_6 0x08 168 #define SCSI_OP_WRITE_6 0x0a 169 #define SCSI_OP_INQUIRY 0x12 170 #define SCSI_OP_VERIFY_6 0x13 171 #define SCSI_OP_MODE_SELECT_6 0x15 172 #define SCSI_OP_RESERVE 0x16 173 #define SCSI_OP_RELEASE 0x17 174 #define SCSI_OP_MODE_SENSE_6 0x1a 175 #define SCSI_OP_START_STOP 0x1b 176 #define SCSI_OP_RECEIVE_DIAGNOSTIC 0x1c 177 #define SCSI_OP_SEND_DIAGNOSTIC 0x1d 178 #define SCSI_OP_PREVENT_ALLOW 0x1e 179 #define SCSI_OP_READ_CAPACITY 0x25 180 #define SCSI_OP_READ_10 0x28 181 #define SCSI_OP_WRITE_10 0x2a 182 #define SCSI_OP_POSITION_TO_ELEMENT 0x2b 183 #define SCSI_OP_VERIFY_10 0x2f 184 #define SCSI_OP_SYNCHRONIZE_CACHE 0x35 185 #define SCSI_OP_WRITE_BUFFER 0x3b 186 #define SCSI_OP_READ_BUFFER 0x3c 187 #define SCSI_OP_CHANGE_DEFINITION 0x40 188 #define SCSI_OP_READ_SUB_CHANNEL 0x42 189 #define SCSI_OP_READ_TOC 0x43 190 #define SCSI_OP_PLAY_MSF 0x47 191 #define SCSI_OP_PLAY_AUDIO_TRACK_INDEX 0x48 // obsolete, spec missing 192 #define SCSI_OP_PAUSE_RESUME 0x4b 193 #define SCSI_OP_STOP_PLAY 0x4e 194 #define SCSI_OP_MODE_SELECT_10 0x55 195 #define SCSI_OP_MODE_SENSE_10 0x5a 196 #define SCSI_OP_VARIABLE_LENGTH_CDB 0x7f 197 #define SCSI_OP_READ_16 0x88 198 #define SCSI_OP_WRITE_16 0x8a 199 #define SCSI_OP_VERIFY_16 0x8f 200 #define SCSI_OP_WRITE_SAME_16 0x93 201 #define SCSI_OP_SERVICE_ACTION_IN 0x9e 202 #define SCSI_OP_SERVICE_ACTION_OUT 0x9f 203 #define SCSI_OP_MOVE_MEDIUM 0xa5 204 #define SCSI_OP_READ_12 0xa8 205 #define SCSI_OP_WRITE_12 0xaa 206 #define SCSI_OP_VERIFY_12 0xaf 207 #define SCSI_OP_READ_ELEMENT_STATUS 0xb8 208 #define SCSI_OP_SCAN 0xba 209 #define SCSI_OP_READ_CD 0xbe 210 211 // Service-Action-In defines 212 #define SCSI_SAI_READ_CAPACITY_16 0x10 213 #define SCSI_SAI_READ_LONG 0x11 214 215 // Service-Action-Out defines 216 #define SCSI_SAO_WRITE_LONG 0x11 217 218 219 // INQUIRY 220 221 typedef struct scsi_cmd_inquiry { 222 uint8 opcode; 223 LBITFIELD8_3( 224 evpd : 1, // enhanced vital product data 225 _res1_1 : 4, 226 lun : 3 227 ); 228 uint8 page_code; 229 uint8 _res3; 230 uint8 allocation_length; 231 uint8 control; 232 } _PACKED scsi_cmd_inquiry; 233 234 typedef struct scsi_res_inquiry { 235 LBITFIELD8_2( 236 device_type : 5, 237 device_qualifier : 3 238 ); 239 LBITFIELD8_2( 240 device_type_modifier : 7, // obsolete, normally set to zero 241 removable_medium : 1 242 ); 243 LBITFIELD8_3( // 0 always means "not conforming" 244 ansi_version : 3, // 1 for SCSI-1, 2 for SCSI-2 etc. 245 ecma_version : 3, 246 iso_version : 2 247 ); 248 LBITFIELD8_4( 249 response_data_format : 4, // 2 = SCSI/2 compliant 250 _res3_4 : 2, 251 term_iop : 1, // 1 = supports TERMINATE I/O PROCESS 252 async_enc : 1 // processor devices only : 253 // Asynchronous Event Notification Capable 254 ); 255 uint8 additional_length; // total (whished) length = this + 4 256 uint8 _res5; 257 uint8 _res6; 258 LBITFIELD8_8( 259 soft_reset : 1, // 0 = soft reset leads to hard reset 260 cmd_queue : 1, // 1 = supports tagged command queuing 261 _res7_2 : 1, 262 linked : 1, // 1 = supports linked commands 263 sync : 1, // 1 = supports synchronous transfers 264 write_bus16 : 1, // 1 = supports 16 bit transfers 265 write_bus32 : 1, // 1 = supports 32 bit transfers 266 relative_address : 1 // 1 = supports relative addr. for linking 267 ); 268 char vendor_ident[8]; 269 char product_ident[16]; 270 char product_rev[4]; 271 272 // XPT doesn't return following data on XPT_GDEV_TYPE 273 uint8 vendor_spec[20]; 274 uint8 _res56[2]; 275 276 uint16 version_descriptor[8]; // array of supported standards, big endian 277 278 uint8 _res74[22]; 279 /* additional vendor specific data */ 280 } _PACKED scsi_res_inquiry; 281 282 enum scsi_peripheral_qualifier { 283 scsi_periph_qual_connected = 0, 284 scsi_periph_qual_not_connected = 2, 285 scsi_periph_qual_not_connectable = 3 286 // value 1 is reserved, values of 4 and above are vendor-specific 287 }; 288 289 enum scsi_device_type { 290 scsi_dev_direct_access = 0, 291 scsi_dev_sequential_access = 1, 292 scsi_dev_printer = 2, 293 scsi_dev_processor = 3, 294 scsi_dev_WORM = 4, 295 scsi_dev_CDROM = 5, 296 scsi_dev_scanner = 6, 297 scsi_dev_optical = 7, 298 scsi_dev_medium_changer = 8, 299 scsi_dev_communication = 9, 300 // 0xa - 0xb are graphics arts pre-press devices 301 // 0xc - 0x1e reserved 302 scsi_dev_storage_array = 0xc, 303 scsi_dev_enclosure_services = 0xd, 304 scsi_dev_simplified_direct_access = 0xe, 305 scsi_dev_optical_card = 0xf, 306 scsi_dev_unknown = 0x1f // used for scsi_periph_qual_not_connectable 307 }; 308 309 310 // vital product data: unit serial number page 311 312 #define SCSI_PAGE_USN 0x80 313 314 typedef struct scsi_page_usn { 315 LBITFIELD8_2( 316 device_type : 5, 317 device_qualifier : 3 318 ); 319 uint8 page_code; 320 uint8 _res2; 321 322 uint8 _page_length; // total size = this + 3 323 char psn[1]; // size according to page_length 324 } _PACKED scsi_page_usn; 325 326 // READ CAPACITY (10) 327 328 typedef struct scsi_cmd_read_capacity { 329 uint8 opcode; 330 LBITFIELD8_3( 331 relative_address : 1, // relative address 332 _res1_1 : 4, 333 lun : 3 334 ); 335 uint32 lba; 336 uint8 _res6[2]; 337 LBITFIELD8_2( 338 pmi : 1, // partial medium indicator 339 _res8_1 : 7 340 ); 341 uint8 control; 342 } _PACKED scsi_cmd_read_capacity; 343 344 typedef struct scsi_res_read_capacity { 345 uint32 lba; // big endian 346 uint32 block_size; // in bytes 347 } _PACKED scsi_res_read_capacity; 348 349 // READ CAPACITY (16) 350 351 typedef struct scsi_cmd_read_capacity_long { 352 uint8 opcode; 353 uint8 service_action; 354 uint64 lba; 355 uint32 alloc_length; 356 uint8 relative_address; 357 uint8 control; 358 } _PACKED scsi_cmd_read_capacity_long; 359 360 typedef struct scsi_res_read_capacity_long { 361 uint64 lba; // big endian 362 uint32 block_size; // in bytes 363 } _PACKED scsi_res_read_capacity_long; 364 365 366 // READ (6), WRITE (6) 367 368 typedef struct scsi_cmd_rw_6 { 369 uint8 opcode; 370 LBITFIELD8_2( 371 high_lba : 5, 372 lun : 3 373 ); 374 uint8 mid_lba; 375 uint8 low_lba; 376 uint8 length; // 0 = 256 blocks 377 uint8 control; 378 } _PACKED scsi_cmd_rw_6; 379 380 381 // READ (10), WRITE (10) 382 383 typedef struct scsi_cmd_rw_10 { 384 uint8 opcode; 385 LBITFIELD8_5( 386 relative_address : 1, // relative address 387 _res1_1 : 2, 388 force_unit_access : 1, // force unit access (1 = safe, cacheless access) 389 disable_page_out : 1, // disable page out (1 = not worth caching) 390 lun : 3 391 ); 392 uint32 lba; // big endian 393 uint8 _res6; 394 uint16 length; // 0 = no block 395 uint8 control; 396 } _PACKED scsi_cmd_rw_10; 397 398 399 // READ (12), WRITE (12) 400 401 typedef struct scsi_cmd_rw_12 { 402 uint8 opcode; 403 LBITFIELD8_5( 404 relative_address : 1, // relative address 405 _res1_1 : 2, 406 force_unit_access : 1, // force unit access (1 = safe, cacheless access) 407 disable_page_out : 1, // disable page out (1 = not worth caching) 408 lun : 3 409 ); 410 uint32 lba; // big endian 411 uint32 length; // 0 = no block 412 uint8 _res10; 413 uint8 control; 414 } _PACKED scsi_cmd_rw_12; 415 416 417 // READ (16), WRITE (16) 418 419 typedef struct scsi_cmd_rw_16 { 420 uint8 opcode; 421 LBITFIELD8_6( 422 _res1_0 : 1, 423 force_unit_access_non_volatile : 1, 424 _res1_2 : 1, 425 force_unit_access : 1, 426 disable_page_out : 1, 427 read_protect : 3 428 ); 429 uint64 lba; // big endian 430 uint32 length; 431 LBITFIELD8_3( 432 group_number : 5, 433 _res_14_5 : 2, 434 _res_14_7 : 1 435 ); 436 uint8 control; 437 } _PACKED scsi_cmd_rw_16; 438 439 440 // WRITE SAME (16) 441 442 typedef struct scsi_cmd_wsame_16 { 443 uint8 opcode; 444 LBITFIELD8_6( 445 _res1_0 : 1, 446 lb_data : 1, 447 pb_data : 1, 448 unmap : 1, 449 _res1_4 : 1, 450 write_protect : 3 451 ); 452 uint64 lba; 453 uint32 length; 454 LBITFIELD8_2( 455 group_number : 5, 456 _res14_5 : 3 457 ); 458 uint8 control; 459 } _PACKED scsi_cmd_wsame_16; 460 461 462 // REQUEST SENSE 463 464 typedef struct scsi_cmd_request_sense { 465 uint8 opcode; 466 LBITFIELD8_2( 467 _res1_0 : 5, 468 lun : 3 469 ); 470 uint8 _res2[2]; 471 uint8 allocation_length; 472 uint8 control; 473 } _PACKED scsi_cmd_request_sense; 474 475 476 // sense data structures 477 478 #define SCSIS_CURR_ERROR 0x70 479 #define SCSIS_DEFERRED_ERROR 0x71 480 481 typedef struct scsi_sense { 482 LBITFIELD8_2( 483 error_code : 7, 484 valid : 1 // 0 = not conforming to standard 485 ); 486 uint8 segment_number; // for COPY/COPY AND VERIFY/COMPARE 487 LBITFIELD8_5( 488 sense_key : 4, 489 res2_4 : 1, 490 ILI : 1, // incorrect length indicator - req. block 491 // length doesn't match physical block length 492 EOM : 1, // serial devices only 493 Filemark : 1 // optional for random access 494 ); 495 496 uint8 highest_inf; // device-type or command specific 497 uint8 high_inf; // device-type 0, 4, 5, 7: block address 498 uint8 mid_inf; // device-type 1, 2, 3: req length - act. length 499 uint8 low_inf; // (and others for sequential dev. and COPY cmds 500 501 uint8 add_sense_length; // total length = this + 7 502 503 uint8 highest_cmd_inf; 504 uint8 high_cmd_inf; 505 uint8 mid_cmd_inf; 506 uint8 low_cmd_inf; 507 uint8 asc; 508 uint8 ascq; // this can be zero if unsupported 509 uint8 unit_code; // != 0 to specify internal device unit 510 511 union { 512 struct { 513 LBITFIELD8_2( 514 high_key_spec : 7, 515 SKSV : 1 // 1 = sense key specific (byte 15-17) valid 516 ); 517 uint8 mid_key_spec; 518 uint8 low_key_spec; 519 } raw; 520 521 // ILLEGAL REQUEST 522 struct { 523 LBITFIELD8_5( 524 bit_pointer : 3, // points to (highest) invalid bit of parameter 525 BPV : 1, // 1 = bit_pointer is valid 526 res15_4 : 2, 527 c_d : 2, // 1 = error command, 0 = error in data 528 SKSV : 1 // s.a. 529 ); 530 uint8 high_field_pointer; // points to (highest) invalid byte of parameter 531 uint8 low_field_pointer; // (!using big endian, this means the first byte!) 532 } ill_request; 533 534 // access error (RECOVERED, HARDWARE or MEDIUM ERROR) 535 struct { 536 LBITFIELD8_2( 537 res15_0 : 7, 538 SKSV : 1 539 ); 540 uint8 high_retry_cnt; 541 uint8 low_retry_cnt; 542 } acc_error; 543 544 // format progress (if sense key = NOT READY) 545 struct { 546 LBITFIELD8_2( 547 res15_0 : 7, 548 SKSV : 1 549 ); 550 uint16 progress; // 0 = start, 0xffff = almost finished 551 } format_progress; 552 } sense_key_spec; 553 554 // starting with offset 18 there are additional sense byte 555 } _PACKED scsi_sense; 556 557 558 // PREVENT ALLOW 559 560 typedef struct scsi_cmd_prevent_allow { 561 uint8 opcode; 562 LBITFIELD8_2( 563 _res1_0 : 5, 564 lun : 3 565 ); 566 uint8 _res2[2]; 567 LBITFIELD8_2( 568 prevent : 1, // 1 - prevent medium removal, 0 - allow removal 569 _res4_1 : 7 570 ); 571 uint8 control; 572 } _PACKED scsi_cmd_prevent_allow; 573 574 // START STOP UNIT 575 576 typedef struct scsi_cmd_ssu { 577 uint8 opcode; 578 LBITFIELD8_3( 579 immediately : 1, // 1 - return immediately, 0 - return on completion 580 _res1_1 : 4, 581 lun : 3 582 ); 583 uint8 res2[2]; 584 LBITFIELD8_3( 585 start : 1, // 1 - load+start, i.e. allow, 0 - eject+stop, i.e. deny 586 load_eject : 1, // 1 - include loading/ejecting, 0 - only to allow/deny 587 _res4_2 : 6 588 ); 589 uint8 control; 590 } _PACKED scsi_cmd_ssu; 591 592 593 // MODE SELECT (6) 594 595 typedef struct scsi_cmd_mode_select_6 { 596 uint8 opcode; 597 LBITFIELD8_4( 598 save_pages : 1, // 1 = save pages to non-volatile memory 599 _res1_1 : 3, 600 pf : 1, // 0 = old SCSI-1; 1 = new SCSI-2 format 601 lun : 3 602 ); 603 uint8 _res2[2]; 604 uint8 param_list_length; // data size 605 uint8 control; 606 } _PACKED scsi_cmd_mode_select_6; 607 608 609 // MODE SENSE (6) 610 611 typedef struct scsi_cmd_mode_sense_6 { 612 uint8 opcode; 613 LBITFIELD8_4( 614 _res1_0 : 3, 615 disable_block_desc : 1, // disable block descriptors 616 _res1_4 : 1, 617 lun : 3 618 ); 619 LBITFIELD8_2( 620 page_code : 6, 621 page_control : 2 // page control field 622 ); 623 uint8 _res3; 624 uint8 allocation_length; // maximum amount of data 625 uint8 control; 626 } _PACKED scsi_cmd_mode_sense_6; 627 628 629 // MODE SELECT (10) 630 631 typedef struct scsi_cmd_mode_select_10 { 632 uint8 opcode; 633 LBITFIELD8_4( 634 save_pages : 1, // 1 = save pages to non-volatile memory 635 _res1_1 : 3, 636 pf : 1, // 0 = old SCSI-1; 1 = new SCSI-2 format 637 lun : 3 638 ); 639 uint8 _res2[5]; 640 uint16 param_list_length; // data size, big endian 641 uint8 control; 642 } _PACKED scsi_cmd_mode_select_10; 643 644 645 // MODE SENSE (10) 646 647 typedef struct scsi_cmd_mode_sense_10 { 648 uint8 opcode; 649 LBITFIELD8_4( 650 _res1_0 : 3, 651 disable_block_desc : 1, // disable block descriptors 652 _res1_4 : 1, 653 lun : 3 654 ); 655 LBITFIELD8_2( 656 page_code : 6, 657 page_control : 2 // page control field 658 ); 659 uint8 _res3[4]; 660 uint16 allocation_length; // maximum amount of data, big endian 661 uint8 control; 662 } _PACKED scsi_cmd_mode_sense_10; 663 664 // possible contents of page control (PC) 665 #define SCSI_MODE_SENSE_PC_CURRENT 0 666 #define SCSI_MODE_SENSE_PC_CHANGABLE 1 667 // changable field are filled with "1" 668 #define SCSI_MODE_SENSE_PC_DEFAULT 2 669 #define SCSI_MODE_SENSE_PC_SAVED 3 670 671 // special mode page indicating to return all mode pages 672 #define SCSI_MODEPAGE_ALL 0x3f 673 674 // header of mode data; followed by block descriptors and mode pages 675 typedef struct scsi_mode_param_header_6 { 676 uint8 mode_data_length; // total length excluding this byte 677 uint8 medium_type; 678 uint8 dev_spec_parameter; 679 uint8 block_desc_length; // total length of all transmitted block descriptors 680 } _PACKED scsi_mode_param_header_6; 681 682 typedef struct scsi_mode_param_header_10 { 683 uint16 mode_data_length; // total length excluding these two bytes 684 uint8 medium_type; 685 uint8 dev_spec_parameter; 686 uint8 _res4[2]; 687 uint16 block_desc_length; // total length of all transmitted block descriptors 688 } _PACKED scsi_mode_param_header_10; 689 690 691 // content of dev_spec_parameter for direct access devices 692 typedef struct scsi_mode_param_dev_spec_da { 693 LBITFIELD8_4( 694 _res0_0 : 4, 695 dpo_fua : 1, // 1 = supports DPO and FUA, see READ (10) (sense only) 696 _res0_6 : 1, 697 write_protected : 1 // write protected (sense only) 698 ); 699 } _PACKED scsi_mode_param_dev_spec_da; 700 701 typedef struct scsi_mode_param_block_desc { 702 uint8 density; // density code of area 703 uint8 high_numblocks; // size of this area in blocks 704 uint8 med_numblocks; // 0 = all remaining blocks 705 uint8 low_numblocks; 706 uint8 _res4; 707 uint8 high_blocklen; // block size 708 uint8 med_blocklen; 709 uint8 low_blocklen; 710 } _PACKED scsi_mode_param_block_desc; 711 712 713 // header of a mode pages 714 typedef struct scsi_modepage_header { 715 LBITFIELD8_3( 716 page_code : 6, 717 _res0_6 : 1, 718 PS : 1 // 1 = page can be saved (only valid for MODE SENSE) 719 ); 720 uint8 page_length; // size of page excluding this common header 721 } _PACKED scsi_modepage_header; 722 723 724 // control mode page 725 #define SCSI_MODEPAGE_CONTROL 0xa 726 727 typedef struct scsi_modepage_control { 728 scsi_modepage_header header; 729 LBITFIELD8_2( 730 RLEC : 1, // Report Log Exception Condition 731 res2_1 : 7 732 ); 733 LBITFIELD8_4( 734 DQue : 1, // disable Queuing 735 QErr : 1, // abort queued commands on contingent allegiance condition 736 res3_2 : 2, 737 QAM : 4 // Queue Algorithm Modifier 738 ); 739 LBITFIELD8_5( 740 EAENP : 1, // error AEN permission; true = send AEN on deferred error 741 // false = generate UA condition after deferred error 742 UAAENP : 1, // unit attention AEN permission; true = send AEN, 743 // false = generate UA condition (for everything but init.) 744 RAENP : 1, // ready AEN permission; true = send async event notification 745 // (AEN) instead of generating an Unit Attention (UA) Condition 746 // after initialization 747 res4_3 : 4, 748 EECA : 1 // enable Extended Contingent Allegiance 749 ); 750 uint8 res5; 751 uint8 high_AEN_holdoff; // ready AEN hold off period - delay in ms between 752 uint8 low_AEN_holdoff; // initialization and AEN 753 } scsi_modepage_control; 754 755 // values for QAM 756 #define SCSI_QAM_RESTRICTED 0 757 #define SCSI_QAM_UNRESTRICTED 1 758 // 2 - 7 reserved, 8 - 0xf vendor-specific 759 760 761 // CD audio control page 762 #define SCSI_MODEPAGE_AUDIO 0xe 763 764 typedef struct scsi_modepage_audio { 765 scsi_modepage_header header; 766 LBITFIELD8_4( 767 _res2_0 : 1, 768 stop_on_track_crossing : 1, // Stop On Track Crossing 769 // 0 - stop according transfer length, 1 - stop at end of track 770 immediately : 1, // must be one 771 _res2_3 : 5 772 ); 773 uint8 _res3[3]; 774 uint8 _obsolete6[2]; 775 struct { 776 LBITFIELD8_2( 777 channel : 4, // select channel to connect to this port 778 _res0_4 : 4 779 ); 780 uint8 volume; 781 } ports[4]; 782 } _PACKED scsi_modepage_audio; 783 784 // connection between output port and audio channel 785 #define SCSI_CHANNEL_SEL_MUTED 0 // mute port 786 #define SCSI_CHANNEL_SEL_CHANNEL0 1 // connect to channel 0 787 #define SCSI_CHANNEL_SEL_CHANNEL1 2 // connect to channel 1 788 #define SCSI_CHANNEL_SEL_CHANNEL0_1 3 // connect to channel 0 and channel 1 789 #define SCSI_CHANNEL_SEL_CHANNEL2 4 // connect to channel 2 790 #define SCSI_CHANNEL_SEL_CHANNEL3 8 // connect to channel 3 791 792 // TUR 793 794 typedef struct scsi_cmd_tur { 795 uint8 opcode; 796 LBITFIELD8_2( 797 _res1_0 : 5, 798 lun : 3 799 ); 800 uint8 _res3[3]; 801 uint8 control; 802 } _PACKED scsi_cmd_tur; 803 804 805 // READ_TOC 806 807 typedef struct scsi_cmd_read_toc { 808 uint8 opcode; 809 LBITFIELD8_4( 810 _res1_0 : 1, 811 time : 1, // true, to use MSF format, false for LBA format 812 _res1_2 : 3, 813 lun : 3 814 ); 815 LBITFIELD8_2( 816 format : 4, // see below 817 _res2_4 : 4 818 ); 819 uint8 _res3[3]; 820 uint8 track; // (starting) track 821 uint16 allocation_length; // maximum amount of data (big endian) 822 uint8 control; 823 } _PACKED scsi_cmd_read_toc; 824 825 // values of <format> in TOC command 826 #define SCSI_TOC_FORMAT_TOC 0 // all TOCs starting with <track> (0xaa for lead-out) 827 #define SCSI_TOC_FORMAT_SESSION_INFO 1 // Session info 828 #define SCSI_TOC_FORMAT_FULL_TOC 2 // all Q-channel data in TOC 829 #define SCSI_TOC_FORMAT_PMA 3 // Q-channel data in PMA area 830 #define SCSI_TOC_FORMAT_ATIP 4 // get ATIP data 831 #define SCSI_TOC_FORMAT_CD_TEXT 5 // get CD-Text from R/W-channel in lead-in 832 833 // general structure of response 834 typedef struct scsi_toc_general { 835 uint16 data_length; // big endian, total length - 2 836 uint8 first; // first track/session/reserved 837 uint8 last; // last one 838 // remainder are parameter list descriptors 839 } _PACKED scsi_toc_general; 840 841 // definition of CD-ROM LBA 842 typedef uint32 scsi_cd_lba; // big endian 843 844 // definition of CD-ROM MSF time 845 typedef struct scsi_cd_msf { 846 uint8 _reserved; 847 uint8 minute; 848 uint8 second; 849 uint8 frame; 850 } _PACKED scsi_cd_msf; 851 852 // definition of Track Number address format 853 typedef struct scsi_cd_track_number { 854 uint8 _res0[3]; 855 uint8 track; 856 } _PACKED scsi_cd_track_number; 857 858 // one track for SCSI_TOC_FORMAT_TOC 859 typedef struct scsi_toc_track { 860 uint8 _res0; 861 LBITFIELD8_2( 862 control : 4, 863 adr : 4 864 ); 865 uint8 track_number; // track number (hex) 866 uint8 _res3; 867 union { // start of track (time or LBA, see TIME of command) 868 scsi_cd_lba lba; 869 scsi_cd_msf time; 870 } start; 871 } _PACKED scsi_toc_track; 872 873 // possible value of ADR-field (described Q-channel content) 874 enum scsi_adr { 875 scsi_adr_none = 0, // no Q-channel mode info 876 scsi_adr_position = 1, // Q-channel encodes current position data 877 scsi_adr_mcn = 2, // Q-channel encodes Media Catalog Number 878 scsi_adr_isrc = 3 // Q-channel encodes ISRC 879 }; 880 881 // value of Q-channel control field (CONTROL) 882 enum scsi_q_control { 883 scsi_q_control_2audio = 0, // stereo audio 884 scsi_q_control_2audio_preemp = 1, // stereo audio with 50/15µs pre-emphasis 885 scsi_q_control_1audio = 8, // audio (reserved in CD-R/W) 886 scsi_q_control_1audio_preemp = 9, // audio with pre-emphasis (reserved in CD-R/W) 887 scsi_q_control_data_un_intr = 4, // data, recorded un-interrupted 888 scsi_q_control_data_incr = 5, // data, recorded incremental 889 scsi_q_control_ddcd = 4, // DDCD data 890 scsi_q_control_copy_perm = 2 // copy permitted (or-ed with value above) 891 }; 892 893 // format SCSI_TOC_FORMAT_TOC 894 typedef struct scsi_toc_toc { 895 uint16 data_length; // big endian, total length - 2 896 uint8 first_track; // first track 897 uint8 last_track; // last track 898 899 scsi_toc_track tracks[1]; // one entry per track 900 } _PACKED scsi_toc_toc; 901 902 903 // READ SUB-CHANNEL 904 905 typedef struct scsi_cmd_read_subchannel { 906 uint8 opcode; 907 LBITFIELD8_4( 908 _res1_0 : 1, 909 time : 1, // true, to use MSF format, false for LBA format 910 _res1_2 : 3, 911 lun : 3 912 ); 913 LBITFIELD8_3( 914 _res2_0 : 6, 915 subq : 1, // 1 - return Q sub-channel data 916 _res2_7 : 1 917 ); 918 uint8 parameter_list; // see below 919 uint8 _res4[2]; 920 uint8 track; // track number (hex) 921 uint16 allocation_length; // maximum amount of data, big endian 922 uint8 control; 923 } _PACKED scsi_cmd_read_subchannel; 924 925 // values of parameter_list 926 enum scsi_sub_channel_parameter_list { 927 scsi_sub_channel_parameter_list_cd_pos = 1, // CD current position 928 scsi_sub_channel_parameter_list_mcn = 2, // Media Catalog Number 929 scsi_sub_channel_parameter_list_isrc = 3 // Track International Standard Recording Code 930 }; 931 932 // header of response 933 typedef struct scsi_subchannel_data_header { 934 uint8 _res0; 935 uint8 audio_status; // see below 936 uint16 data_length; // total length - 4, big endian 937 } _PACKED scsi_subchannel_data_header; 938 939 // possible audio_status 940 enum scsi_audio_status { 941 scsi_audio_status_not_supported = 0, 942 scsi_audio_status_playing = 0x11, 943 scsi_audio_status_paused = 0x12, 944 scsi_audio_status_completed = 0x13, 945 scsi_audio_status_error_stop = 0x14, 946 scsi_audio_status_no_status = 0x15 947 }; 948 949 typedef struct scsi_cd_current_position { 950 uint8 format_code; // always 1 951 LBITFIELD8_2( 952 control : 4, // see scsi_q_control 953 adr : 4 // see scsi_adr 954 ); 955 uint8 track; 956 uint8 index; 957 union { // current position, relative to logical beginning 958 scsi_cd_lba lba; 959 scsi_cd_msf time; 960 } absolute_address; 961 union { // current position, relative to track 962 scsi_cd_lba lba; 963 scsi_cd_msf time; 964 } track_relative_address; 965 } _PACKED scsi_cd_current_position; 966 967 968 // PLAY AUDIO MSF 969 970 typedef struct scsi_cmd_play_msf { 971 uint8 opcode; 972 LBITFIELD8_2( 973 _res1_0 : 5, 974 lun : 3 975 ); 976 uint8 _res2; 977 uint8 start_minute; // start time 978 uint8 start_second; 979 uint8 start_frame; 980 uint8 end_minute; // end time (excluding) 981 uint8 end_second; 982 uint8 end_frame; 983 uint8 control; 984 } _PACKED scsi_cmd_play_msf; 985 986 987 // STOP AUDIO 988 989 typedef struct scsi_cmd_stop_play { 990 uint8 opcode; 991 LBITFIELD8_2( 992 _res1_0 : 5, 993 lun : 3 994 ); 995 uint8 _res2[7]; 996 uint8 control; 997 } _PACKED scsi_cmd_stop_play; 998 999 1000 // PAUSE/RESUME 1001 1002 typedef struct scsi_cmd_pause_resume { 1003 uint8 opcode; 1004 LBITFIELD8_2( 1005 _res1_0 : 5, 1006 lun : 3 1007 ); 1008 uint8 _res2[6]; 1009 LBITFIELD8_2( 1010 resume : 1, // 1 for resume, 0 for pause 1011 _res8_2 : 7 1012 ); 1013 uint8 control; 1014 } _PACKED scsi_cmd_pause_resume; 1015 1016 1017 // SCAN 1018 1019 typedef struct scsi_cmd_scan { 1020 uint8 opcode; 1021 LBITFIELD8_4( 1022 relative_address : 1, // must be zero 1023 _res1_1 : 3, 1024 direct : 1, // direction: 0 forward, 1 backward 1025 lun : 3 1026 ); 1027 union { // start of track (depends on <type>) 1028 scsi_cd_lba lba; 1029 scsi_cd_msf time; 1030 scsi_cd_track_number track_number; 1031 } start; 1032 uint8 _res6[3]; 1033 LBITFIELD8_2( 1034 res9_0 : 6, 1035 type : 2 // actual type of <start> (see below) 1036 ); 1037 uint8 _res10; 1038 uint8 control; 1039 } _PACKED scsi_cmd_scan; 1040 1041 // possible values for type 1042 enum scsi_scan_type { 1043 scsi_scan_lba = 0, 1044 scsi_scan_msf = 1, 1045 scsi_scan_tno = 2 1046 }; 1047 1048 1049 // READ_CD 1050 1051 typedef struct scsi_cmd_read_cd { 1052 uint8 opcode; 1053 LBITFIELD8_4( 1054 relative_address : 1, // must be zero 1055 _res1_1 : 1, 1056 sector_type : 3, // required sector type (1=CDDA) 1057 lun : 3 1058 ); 1059 scsi_cd_lba lba; 1060 uint8 high_length; 1061 uint8 mid_length; 1062 uint8 low_length; 1063 LBITFIELD8_6( 1064 _res9_0 : 1, 1065 error_field : 2, 1066 edc_ecc : 1, // include EDC/ECC; includes 8 byte padding for Mode 1 format 1067 user_data : 1, // if 1, include user data 1068 // (mode select block size is ignored) 1069 header_code : 2, 1070 sync : 1 // if 1, include sync field from sector 1071 ); 1072 LBITFIELD8_2( 1073 sub_channel_selection : 4, 1074 _res10_4 : 4 1075 ); 1076 uint8 control; 1077 } _PACKED scsi_cmd_read_cd; 1078 1079 // possible values for header_code 1080 enum scsi_read_cd_header_code { 1081 scsi_read_cd_header_none = 0, 1082 scsi_read_cd_header_hdr_only = 1, 1083 scsi_read_cd_header_sub_header_only = 2, 1084 scsi_read_cd_header_all_headers = 3, 1085 }; 1086 1087 // possible values for error_field 1088 enum scsi_read_cd_error_field { 1089 scsi_read_cd_error_none = 0, 1090 scsi_read_cd_error_c2_error = 1, // include 2352 bits indicating error in byte 1091 scsi_read_cd_error_c2_and_block_error = 2, // include or of C2 data plus pad byte 1092 }; 1093 1094 // possible values for sub_channel_selection 1095 enum scsi_read_cd_sub_channel_selection { 1096 scsi_read_cd_sub_channel_none = 0, 1097 scsi_read_cd_sub_channel_RAW = 1, 1098 scsi_read_cd_sub_channel_Q = 2, 1099 scsi_read_cd_sub_channel_P_W = 4 // R/W data, depending on CD capabilities 1100 // and Mechanism status page 1101 }; 1102 1103 // SYNCHRONIZE CACHE (10) 1104 1105 typedef struct scsi_cmd_sync_cache { 1106 uint8 opcode; 1107 LBITFIELD8_4( 1108 relative_address : 1, // must be zero 1109 immediately : 1, // 1 - return immediately, 0 - return on completion 1110 _res1_1 : 3, 1111 lun : 3 1112 ); 1113 scsi_cd_lba lba; 1114 uint8 _res2; 1115 uint16 block_count; // big endian 1116 uint8 control; 1117 } _PACKED scsi_cmd_sync_cache; 1118 1119 1120 #endif /* _SCSI_CMDS_H */ 1121