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