1 /*- 2 * Largely written by Julian Elischer (julian@tfs.com) 3 * for TRW Financial Systems. 4 * 5 * TRW Financial Systems, in accordance with their agreement with Carnegie 6 * Mellon University, makes this software available to CMU to distribute 7 * or use in any manner that they see fit as long as this message is kept with 8 * the software. For this reason TFS also grants any other persons or 9 * organisations permission to use or modify this software. 10 * 11 * TFS supplies this software to be publicly redistributed 12 * on the understanding that TFS is not responsible for the correct 13 * functioning of this software in any circumstances. 14 * 15 * Ported to run under 386BSD by Julian Elischer (julian@tfs.com) Sept 1992 16 * 17 * $FreeBSD$ 18 */ 19 20 /* 21 * SCSI general interface description 22 */ 23 24 #ifndef _SCSI_SCSI_ALL_H 25 #define _SCSI_SCSI_ALL_H 1 26 27 #include <sys/cdefs.h> 28 29 #ifdef _KERNEL 30 /* 31 * This is the number of seconds we wait for devices to settle after a SCSI 32 * bus reset. 33 */ 34 extern int scsi_delay; 35 #endif /* _KERNEL */ 36 37 /* 38 * SCSI command format 39 */ 40 41 /* 42 * Define dome bits that are in ALL (or a lot of) scsi commands 43 */ 44 #define SCSI_CTL_LINK 0x01 45 #define SCSI_CTL_FLAG 0x02 46 #define SCSI_CTL_VENDOR 0xC0 47 #define SCSI_CMD_LUN 0xA0 /* these two should not be needed */ 48 #define SCSI_CMD_LUN_SHIFT 5 /* LUN in the cmd is no longer SCSI */ 49 50 #define SCSI_MAX_CDBLEN 16 /* 51 * 16 byte commands are in the 52 * SCSI-3 spec 53 */ 54 #if defined(CAM_MAX_CDBLEN) && (CAM_MAX_CDBLEN < SCSI_MAX_CDBLEN) 55 #error "CAM_MAX_CDBLEN cannot be less than SCSI_MAX_CDBLEN" 56 #endif 57 58 /* 6byte CDBs special case 0 length to be 256 */ 59 #define SCSI_CDB6_LEN(len) ((len) == 0 ? 256 : len) 60 61 /* 62 * This type defines actions to be taken when a particular sense code is 63 * received. Right now, these flags are only defined to take up 16 bits, 64 * but can be expanded in the future if necessary. 65 */ 66 typedef enum { 67 SS_NOP = 0x000000, /* Do nothing */ 68 SS_RETRY = 0x010000, /* Retry the command */ 69 SS_FAIL = 0x020000, /* Bail out */ 70 SS_START = 0x030000, /* Send a Start Unit command to the device, 71 * then retry the original command. 72 */ 73 SS_TUR = 0x040000, /* Send a Test Unit Ready command to the 74 * device, then retry the original command. 75 */ 76 SS_REQSENSE = 0x050000, /* Send a RequestSense command to the 77 * device, then retry the original command. 78 */ 79 SS_MASK = 0xff0000 80 } scsi_sense_action; 81 82 typedef enum { 83 SSQ_NONE = 0x0000, 84 SSQ_DECREMENT_COUNT = 0x0100, /* Decrement the retry count */ 85 SSQ_MANY = 0x0200, /* send lots of recovery commands */ 86 SSQ_RANGE = 0x0400, /* 87 * This table entry represents the 88 * end of a range of ASCQs that 89 * have identical error actions 90 * and text. 91 */ 92 SSQ_PRINT_SENSE = 0x0800, 93 SSQ_MASK = 0xff00 94 } scsi_sense_action_qualifier; 95 96 /* Mask for error status values */ 97 #define SS_ERRMASK 0xff 98 99 /* The default, retyable, error action */ 100 #define SS_RDEF SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE|EIO 101 102 /* The retyable, error action, with table specified error code */ 103 #define SS_RET SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE 104 105 /* Fatal error action, with table specified error code */ 106 #define SS_FATAL SS_FAIL|SSQ_PRINT_SENSE 107 108 struct scsi_generic 109 { 110 u_int8_t opcode; 111 u_int8_t bytes[11]; 112 }; 113 114 struct scsi_request_sense 115 { 116 u_int8_t opcode; 117 u_int8_t byte2; 118 u_int8_t unused[2]; 119 u_int8_t length; 120 u_int8_t control; 121 }; 122 123 struct scsi_test_unit_ready 124 { 125 u_int8_t opcode; 126 u_int8_t byte2; 127 u_int8_t unused[3]; 128 u_int8_t control; 129 }; 130 131 struct scsi_send_diag 132 { 133 u_int8_t opcode; 134 u_int8_t byte2; 135 #define SSD_UOL 0x01 136 #define SSD_DOL 0x02 137 #define SSD_SELFTEST 0x04 138 #define SSD_PF 0x10 139 u_int8_t unused[1]; 140 u_int8_t paramlen[2]; 141 u_int8_t control; 142 }; 143 144 struct scsi_sense 145 { 146 u_int8_t opcode; 147 u_int8_t byte2; 148 u_int8_t unused[2]; 149 u_int8_t length; 150 u_int8_t control; 151 }; 152 153 struct scsi_inquiry 154 { 155 u_int8_t opcode; 156 u_int8_t byte2; 157 #define SI_EVPD 0x01 158 u_int8_t page_code; 159 u_int8_t reserved; 160 u_int8_t length; 161 u_int8_t control; 162 }; 163 164 struct scsi_mode_sense_6 165 { 166 u_int8_t opcode; 167 u_int8_t byte2; 168 #define SMS_DBD 0x08 169 u_int8_t page; 170 #define SMS_PAGE_CODE 0x3F 171 #define SMS_VENDOR_SPECIFIC_PAGE 0x00 172 #define SMS_DISCONNECT_RECONNECT_PAGE 0x02 173 #define SMS_PERIPHERAL_DEVICE_PAGE 0x09 174 #define SMS_CONTROL_MODE_PAGE 0x0A 175 #define SMS_ALL_PAGES_PAGE 0x3F 176 #define SMS_PAGE_CTRL_MASK 0xC0 177 #define SMS_PAGE_CTRL_CURRENT 0x00 178 #define SMS_PAGE_CTRL_CHANGEABLE 0x40 179 #define SMS_PAGE_CTRL_DEFAULT 0x80 180 #define SMS_PAGE_CTRL_SAVED 0xC0 181 u_int8_t unused; 182 u_int8_t length; 183 u_int8_t control; 184 }; 185 186 struct scsi_mode_sense_10 187 { 188 u_int8_t opcode; 189 u_int8_t byte2; /* same bits as small version */ 190 u_int8_t page; /* same bits as small version */ 191 u_int8_t unused[4]; 192 u_int8_t length[2]; 193 u_int8_t control; 194 }; 195 196 struct scsi_mode_select_6 197 { 198 u_int8_t opcode; 199 u_int8_t byte2; 200 #define SMS_SP 0x01 201 #define SMS_PF 0x10 202 u_int8_t unused[2]; 203 u_int8_t length; 204 u_int8_t control; 205 }; 206 207 struct scsi_mode_select_10 208 { 209 u_int8_t opcode; 210 u_int8_t byte2; /* same bits as small version */ 211 u_int8_t unused[5]; 212 u_int8_t length[2]; 213 u_int8_t control; 214 }; 215 216 /* 217 * When sending a mode select to a tape drive, the medium type must be 0. 218 */ 219 struct scsi_mode_hdr_6 220 { 221 u_int8_t datalen; 222 u_int8_t medium_type; 223 u_int8_t dev_specific; 224 u_int8_t block_descr_len; 225 }; 226 227 struct scsi_mode_hdr_10 228 { 229 u_int8_t datalen[2]; 230 u_int8_t medium_type; 231 u_int8_t dev_specific; 232 u_int8_t reserved[2]; 233 u_int8_t block_descr_len[2]; 234 }; 235 236 struct scsi_mode_block_descr 237 { 238 u_int8_t density_code; 239 u_int8_t num_blocks[3]; 240 u_int8_t reserved; 241 u_int8_t block_len[3]; 242 }; 243 244 struct scsi_log_sense 245 { 246 u_int8_t opcode; 247 u_int8_t byte2; 248 #define SLS_SP 0x01 249 #define SLS_PPC 0x02 250 u_int8_t page; 251 #define SLS_PAGE_CODE 0x3F 252 #define SLS_ALL_PAGES_PAGE 0x00 253 #define SLS_OVERRUN_PAGE 0x01 254 #define SLS_ERROR_WRITE_PAGE 0x02 255 #define SLS_ERROR_READ_PAGE 0x03 256 #define SLS_ERROR_READREVERSE_PAGE 0x04 257 #define SLS_ERROR_VERIFY_PAGE 0x05 258 #define SLS_ERROR_NONMEDIUM_PAGE 0x06 259 #define SLS_ERROR_LASTN_PAGE 0x07 260 #define SLS_PAGE_CTRL_MASK 0xC0 261 #define SLS_PAGE_CTRL_THRESHOLD 0x00 262 #define SLS_PAGE_CTRL_CUMULATIVE 0x40 263 #define SLS_PAGE_CTRL_THRESH_DEFAULT 0x80 264 #define SLS_PAGE_CTRL_CUMUL_DEFAULT 0xC0 265 u_int8_t reserved[2]; 266 u_int8_t paramptr[2]; 267 u_int8_t length[2]; 268 u_int8_t control; 269 }; 270 271 struct scsi_log_select 272 { 273 u_int8_t opcode; 274 u_int8_t byte2; 275 /* SLS_SP 0x01 */ 276 #define SLS_PCR 0x02 277 u_int8_t page; 278 /* SLS_PAGE_CTRL_MASK 0xC0 */ 279 /* SLS_PAGE_CTRL_THRESHOLD 0x00 */ 280 /* SLS_PAGE_CTRL_CUMULATIVE 0x40 */ 281 /* SLS_PAGE_CTRL_THRESH_DEFAULT 0x80 */ 282 /* SLS_PAGE_CTRL_CUMUL_DEFAULT 0xC0 */ 283 u_int8_t reserved[4]; 284 u_int8_t length[2]; 285 u_int8_t control; 286 }; 287 288 struct scsi_log_header 289 { 290 u_int8_t page; 291 u_int8_t reserved; 292 u_int8_t datalen[2]; 293 }; 294 295 struct scsi_log_param_header { 296 u_int8_t param_code[2]; 297 u_int8_t param_control; 298 #define SLP_LP 0x01 299 #define SLP_LBIN 0x02 300 #define SLP_TMC_MASK 0x0C 301 #define SLP_TMC_ALWAYS 0x00 302 #define SLP_TMC_EQUAL 0x04 303 #define SLP_TMC_NOTEQUAL 0x08 304 #define SLP_TMC_GREATER 0x0C 305 #define SLP_ETC 0x10 306 #define SLP_TSD 0x20 307 #define SLP_DS 0x40 308 #define SLP_DU 0x80 309 u_int8_t param_len; 310 }; 311 312 struct scsi_control_page { 313 u_int8_t page_code; 314 u_int8_t page_length; 315 u_int8_t rlec; 316 #define SCB_RLEC 0x01 /*Report Log Exception Cond*/ 317 u_int8_t queue_flags; 318 #define SCP_QUEUE_ALG_MASK 0xF0 319 #define SCP_QUEUE_ALG_RESTRICTED 0x00 320 #define SCP_QUEUE_ALG_UNRESTRICTED 0x10 321 #define SCP_QUEUE_ERR 0x02 /*Queued I/O aborted for CACs*/ 322 #define SCP_QUEUE_DQUE 0x01 /*Queued I/O disabled*/ 323 u_int8_t eca_and_aen; 324 #define SCP_EECA 0x80 /*Enable Extended CA*/ 325 #define SCP_RAENP 0x04 /*Ready AEN Permission*/ 326 #define SCP_UAAENP 0x02 /*UA AEN Permission*/ 327 #define SCP_EAENP 0x01 /*Error AEN Permission*/ 328 u_int8_t reserved; 329 u_int8_t aen_holdoff_period[2]; 330 }; 331 332 struct scsi_reserve 333 { 334 u_int8_t opcode; 335 u_int8_t byte2; 336 u_int8_t unused[2]; 337 u_int8_t length; 338 u_int8_t control; 339 }; 340 341 struct scsi_release 342 { 343 u_int8_t opcode; 344 u_int8_t byte2; 345 u_int8_t unused[2]; 346 u_int8_t length; 347 u_int8_t control; 348 }; 349 350 struct scsi_prevent 351 { 352 u_int8_t opcode; 353 u_int8_t byte2; 354 u_int8_t unused[2]; 355 u_int8_t how; 356 u_int8_t control; 357 }; 358 #define PR_PREVENT 0x01 359 #define PR_ALLOW 0x00 360 361 struct scsi_sync_cache 362 { 363 u_int8_t opcode; 364 u_int8_t byte2; 365 u_int8_t begin_lba[4]; 366 u_int8_t reserved; 367 u_int8_t lb_count[2]; 368 u_int8_t control; 369 }; 370 371 372 struct scsi_changedef 373 { 374 u_int8_t opcode; 375 u_int8_t byte2; 376 u_int8_t unused1; 377 u_int8_t how; 378 u_int8_t unused[4]; 379 u_int8_t datalen; 380 u_int8_t control; 381 }; 382 383 struct scsi_read_buffer 384 { 385 u_int8_t opcode; 386 u_int8_t byte2; 387 #define RWB_MODE 0x07 388 #define RWB_MODE_HDR_DATA 0x00 389 #define RWB_MODE_DATA 0x02 390 #define RWB_MODE_DOWNLOAD 0x04 391 #define RWB_MODE_DOWNLOAD_SAVE 0x05 392 u_int8_t buffer_id; 393 u_int8_t offset[3]; 394 u_int8_t length[3]; 395 u_int8_t control; 396 }; 397 398 struct scsi_write_buffer 399 { 400 u_int8_t opcode; 401 u_int8_t byte2; 402 u_int8_t buffer_id; 403 u_int8_t offset[3]; 404 u_int8_t length[3]; 405 u_int8_t control; 406 }; 407 408 struct scsi_rw_6 409 { 410 u_int8_t opcode; 411 u_int8_t addr[3]; 412 /* only 5 bits are valid in the MSB address byte */ 413 #define SRW_TOPADDR 0x1F 414 u_int8_t length; 415 u_int8_t control; 416 }; 417 418 struct scsi_rw_10 419 { 420 u_int8_t opcode; 421 #define SRW10_RELADDR 0x01 422 /* EBP defined for WRITE(10) only */ 423 #define SRW10_EBP 0x04 424 #define SRW10_FUA 0x08 425 #define SRW10_DPO 0x10 426 u_int8_t byte2; 427 u_int8_t addr[4]; 428 u_int8_t reserved; 429 u_int8_t length[2]; 430 u_int8_t control; 431 }; 432 433 struct scsi_rw_12 434 { 435 u_int8_t opcode; 436 #define SRW12_RELADDR 0x01 437 #define SRW12_FUA 0x08 438 #define SRW12_DPO 0x10 439 u_int8_t byte2; 440 u_int8_t addr[4]; 441 u_int8_t length[4]; 442 u_int8_t reserved; 443 u_int8_t control; 444 }; 445 446 struct scsi_rw_16 447 { 448 u_int8_t opcode; 449 #define SRW16_RELADDR 0x01 450 #define SRW16_FUA 0x08 451 #define SRW16_DPO 0x10 452 u_int8_t byte2; 453 u_int8_t addr[8]; 454 u_int8_t length[4]; 455 u_int8_t reserved; 456 u_int8_t control; 457 }; 458 459 struct scsi_start_stop_unit 460 { 461 u_int8_t opcode; 462 u_int8_t byte2; 463 #define SSS_IMMED 0x01 464 u_int8_t reserved[2]; 465 u_int8_t how; 466 #define SSS_START 0x01 467 #define SSS_LOEJ 0x02 468 u_int8_t control; 469 }; 470 471 #define SC_SCSI_1 0x01 472 #define SC_SCSI_2 0x03 473 474 /* 475 * Opcodes 476 */ 477 478 #define TEST_UNIT_READY 0x00 479 #define REQUEST_SENSE 0x03 480 #define READ_6 0x08 481 #define WRITE_6 0x0a 482 #define INQUIRY 0x12 483 #define MODE_SELECT_6 0x15 484 #define MODE_SENSE_6 0x1a 485 #define START_STOP_UNIT 0x1b 486 #define START_STOP 0x1b 487 #define RESERVE 0x16 488 #define RELEASE 0x17 489 #define RECEIVE_DIAGNOSTIC 0x1c 490 #define SEND_DIAGNOSTIC 0x1d 491 #define PREVENT_ALLOW 0x1e 492 #define READ_CAPACITY 0x25 493 #define READ_10 0x28 494 #define WRITE_10 0x2a 495 #define POSITION_TO_ELEMENT 0x2b 496 #define SYNCHRONIZE_CACHE 0x35 497 #define WRITE_BUFFER 0x3b 498 #define READ_BUFFER 0x3c 499 #define CHANGE_DEFINITION 0x40 500 #define LOG_SELECT 0x4c 501 #define LOG_SENSE 0x4d 502 #define MODE_SELECT_10 0x55 503 #define MODE_SENSE_10 0x5A 504 #define READ_16 0x88 505 #define WRITE_16 0x8a 506 #define SERVICE_ACTION_IN 0x9e 507 #define REPORT_LUNS 0xA0 508 #define MOVE_MEDIUM 0xa5 509 #define READ_12 0xa8 510 #define WRITE_12 0xaa 511 #define READ_ELEMENT_STATUS 0xb8 512 513 514 /* 515 * Device Types 516 */ 517 #define T_DIRECT 0x00 518 #define T_SEQUENTIAL 0x01 519 #define T_PRINTER 0x02 520 #define T_PROCESSOR 0x03 521 #define T_WORM 0x04 522 #define T_CDROM 0x05 523 #define T_SCANNER 0x06 524 #define T_OPTICAL 0x07 525 #define T_CHANGER 0x08 526 #define T_COMM 0x09 527 #define T_ASC0 0x0a 528 #define T_ASC1 0x0b 529 #define T_STORARRAY 0x0c 530 #define T_ENCLOSURE 0x0d 531 #define T_RBC 0x0e 532 #define T_OCRW 0x0f 533 #define T_NODEVICE 0x1F 534 #define T_ANY 0xFF /* Used in Quirk table matches */ 535 536 #define T_REMOV 1 537 #define T_FIXED 0 538 539 /* 540 * This length is the initial inquiry length used by the probe code, as 541 * well as the legnth necessary for scsi_print_inquiry() to function 542 * correctly. If either use requires a different length in the future, 543 * the two values should be de-coupled. 544 */ 545 #define SHORT_INQUIRY_LENGTH 36 546 547 struct scsi_inquiry_data 548 { 549 u_int8_t device; 550 #define SID_TYPE(inq_data) ((inq_data)->device & 0x1f) 551 #define SID_QUAL(inq_data) (((inq_data)->device & 0xE0) >> 5) 552 #define SID_QUAL_LU_CONNECTED 0x00 /* 553 * The specified peripheral device 554 * type is currently connected to 555 * logical unit. If the target cannot 556 * determine whether or not a physical 557 * device is currently connected, it 558 * shall also use this peripheral 559 * qualifier when returning the INQUIRY 560 * data. This peripheral qualifier 561 * does not mean that the device is 562 * ready for access by the initiator. 563 */ 564 #define SID_QUAL_LU_OFFLINE 0x01 /* 565 * The target is capable of supporting 566 * the specified peripheral device type 567 * on this logical unit; however, the 568 * physical device is not currently 569 * connected to this logical unit. 570 */ 571 #define SID_QUAL_RSVD 0x02 572 #define SID_QUAL_BAD_LU 0x03 /* 573 * The target is not capable of 574 * supporting a physical device on 575 * this logical unit. For this 576 * peripheral qualifier the peripheral 577 * device type shall be set to 1Fh to 578 * provide compatibility with previous 579 * versions of SCSI. All other 580 * peripheral device type values are 581 * reserved for this peripheral 582 * qualifier. 583 */ 584 #define SID_QUAL_IS_VENDOR_UNIQUE(inq_data) ((SID_QUAL(inq_data) & 0x08) != 0) 585 u_int8_t dev_qual2; 586 #define SID_QUAL2 0x7F 587 #define SID_IS_REMOVABLE(inq_data) (((inq_data)->dev_qual2 & 0x80) != 0) 588 u_int8_t version; 589 #define SID_ANSI_REV(inq_data) ((inq_data)->version & 0x07) 590 #define SCSI_REV_0 0 591 #define SCSI_REV_CCS 1 592 #define SCSI_REV_2 2 593 #define SCSI_REV_SPC 3 594 #define SCSI_REV_SPC2 4 595 596 #define SID_ECMA 0x38 597 #define SID_ISO 0xC0 598 u_int8_t response_format; 599 #define SID_AENC 0x80 600 #define SID_TrmIOP 0x40 601 u_int8_t additional_length; 602 u_int8_t reserved; 603 u_int8_t spc2_flags; 604 #define SPC2_SID_MChngr 0x08 605 #define SPC2_SID_MultiP 0x10 606 #define SPC2_SID_EncServ 0x40 607 #define SPC2_SID_BQueue 0x80 608 609 #define INQ_DATA_TQ_ENABLED(iqd) \ 610 ((SID_ANSI_REV(iqd) < SCSI_REV_SPC2)? ((iqd)->flags & SID_CmdQue) : \ 611 (((iqd)->flags & SID_CmdQue) && !((iqd)->spc2_flags & SPC2_SID_BQueue)) || \ 612 (!((iqd)->flags & SID_CmdQue) && ((iqd)->spc2_flags & SPC2_SID_BQueue))) 613 614 u_int8_t flags; 615 #define SID_SftRe 0x01 616 #define SID_CmdQue 0x02 617 #define SID_Linked 0x08 618 #define SID_Sync 0x10 619 #define SID_WBus16 0x20 620 #define SID_WBus32 0x40 621 #define SID_RelAdr 0x80 622 #define SID_VENDOR_SIZE 8 623 char vendor[SID_VENDOR_SIZE]; 624 #define SID_PRODUCT_SIZE 16 625 char product[SID_PRODUCT_SIZE]; 626 #define SID_REVISION_SIZE 4 627 char revision[SID_REVISION_SIZE]; 628 /* 629 * The following fields were taken from SCSI Primary Commands - 2 630 * (SPC-2) Revision 14, Dated 11 November 1999 631 */ 632 #define SID_VENDOR_SPECIFIC_0_SIZE 20 633 u_int8_t vendor_specific0[SID_VENDOR_SPECIFIC_0_SIZE]; 634 /* 635 * An extension of SCSI Parallel Specific Values 636 */ 637 #define SID_SPI_IUS 0x01 638 #define SID_SPI_QAS 0x02 639 #define SID_SPI_CLOCK_ST 0x00 640 #define SID_SPI_CLOCK_DT 0x04 641 #define SID_SPI_CLOCK_DT_ST 0x0C 642 #define SID_SPI_MASK 0x0F 643 u_int8_t spi3data; 644 u_int8_t reserved2; 645 /* 646 * Version Descriptors, stored 2 byte values. 647 */ 648 u_int8_t version1[2]; 649 u_int8_t version2[2]; 650 u_int8_t version3[2]; 651 u_int8_t version4[2]; 652 u_int8_t version5[2]; 653 u_int8_t version6[2]; 654 u_int8_t version7[2]; 655 u_int8_t version8[2]; 656 657 u_int8_t reserved3[22]; 658 659 #define SID_VENDOR_SPECIFIC_1_SIZE 160 660 u_int8_t vendor_specific1[SID_VENDOR_SPECIFIC_1_SIZE]; 661 }; 662 663 struct scsi_vpd_unit_serial_number 664 { 665 u_int8_t device; 666 u_int8_t page_code; 667 #define SVPD_UNIT_SERIAL_NUMBER 0x80 668 u_int8_t reserved; 669 u_int8_t length; /* serial number length */ 670 #define SVPD_SERIAL_NUM_SIZE 251 671 u_int8_t serial_num[SVPD_SERIAL_NUM_SIZE]; 672 }; 673 674 struct scsi_read_capacity 675 { 676 u_int8_t opcode; 677 u_int8_t byte2; 678 u_int8_t addr[4]; 679 u_int8_t unused[3]; 680 u_int8_t control; 681 }; 682 683 struct scsi_read_capacity_16 684 { 685 uint8_t opcode; 686 #define SRC16_SERVICE_ACTION 0x10 687 uint8_t service_action; 688 uint8_t addr[8]; 689 uint8_t alloc_len[4]; 690 #define SRC16_PMI 0x01 691 #define SRC16_RELADR 0x02 692 uint8_t reladr; 693 uint8_t control; 694 }; 695 696 struct scsi_read_capacity_data 697 { 698 u_int8_t addr[4]; 699 u_int8_t length[4]; 700 }; 701 702 struct scsi_read_capacity_data_long 703 { 704 uint8_t addr[8]; 705 uint8_t length[4]; 706 }; 707 708 struct scsi_report_luns 709 { 710 uint8_t opcode; 711 uint8_t reserved1; 712 #define RPL_REPORT_DEFAULT 0x00 713 #define RPL_REPORT_WELLKNOWN 0x01 714 #define RPL_REPORT_ALL 0x02 715 uint8_t select_report; 716 uint8_t reserved2[3]; 717 uint8_t length[4]; 718 uint8_t reserved3; 719 uint8_t control; 720 }; 721 722 struct scsi_report_luns_data { 723 u_int8_t length[4]; /* length of LUN inventory, in bytes */ 724 u_int8_t reserved[4]; /* unused */ 725 /* 726 * LUN inventory- we only support the type zero form for now. 727 */ 728 struct { 729 u_int8_t lundata[8]; 730 } luns[0]; 731 }; 732 #define RPL_LUNDATA_PERIPH_BUS_MASK 0x3f 733 #define RPL_LUNDATA_FLAT_LUN_MASK 0x3f 734 #define RPL_LUNDATA_LUN_TARG_MASK 0x3f 735 #define RPL_LUNDATA_LUN_BUS_MASK 0xe0 736 #define RPL_LUNDATA_LUN_LUN_MASK 0x1f 737 #define RPL_LUNDATA_EXT_LEN_MASK 0x30 738 #define RPL_LUNDATA_EXT_EAM_MASK 0x0f 739 #define RPL_LUNDATA_EXT_EAM_WK 0x01 740 #define RPL_LUNDATA_EXT_EAM_NOT_SPEC 0x0f 741 #define RPL_LUNDATA_ATYP_MASK 0xc0 /* MBZ for type 0 lun */ 742 #define RPL_LUNDATA_ATYP_PERIPH 0x00 743 #define RPL_LUNDATA_ATYP_FLAT 0x40 744 #define RPL_LUNDATA_ATYP_LUN 0x80 745 #define RPL_LUNDATA_ATYP_EXTLUN 0xc0 746 747 748 struct scsi_sense_data 749 { 750 u_int8_t error_code; 751 #define SSD_ERRCODE 0x7F 752 #define SSD_CURRENT_ERROR 0x70 753 #define SSD_DEFERRED_ERROR 0x71 754 #define SSD_ERRCODE_VALID 0x80 755 u_int8_t segment; 756 u_int8_t flags; 757 #define SSD_KEY 0x0F 758 #define SSD_KEY_NO_SENSE 0x00 759 #define SSD_KEY_RECOVERED_ERROR 0x01 760 #define SSD_KEY_NOT_READY 0x02 761 #define SSD_KEY_MEDIUM_ERROR 0x03 762 #define SSD_KEY_HARDWARE_ERROR 0x04 763 #define SSD_KEY_ILLEGAL_REQUEST 0x05 764 #define SSD_KEY_UNIT_ATTENTION 0x06 765 #define SSD_KEY_DATA_PROTECT 0x07 766 #define SSD_KEY_BLANK_CHECK 0x08 767 #define SSD_KEY_Vendor_Specific 0x09 768 #define SSD_KEY_COPY_ABORTED 0x0a 769 #define SSD_KEY_ABORTED_COMMAND 0x0b 770 #define SSD_KEY_EQUAL 0x0c 771 #define SSD_KEY_VOLUME_OVERFLOW 0x0d 772 #define SSD_KEY_MISCOMPARE 0x0e 773 #define SSD_KEY_RESERVED 0x0f 774 #define SSD_ILI 0x20 775 #define SSD_EOM 0x40 776 #define SSD_FILEMARK 0x80 777 u_int8_t info[4]; 778 u_int8_t extra_len; 779 u_int8_t cmd_spec_info[4]; 780 u_int8_t add_sense_code; 781 u_int8_t add_sense_code_qual; 782 u_int8_t fru; 783 u_int8_t sense_key_spec[3]; 784 #define SSD_SCS_VALID 0x80 785 #define SSD_FIELDPTR_CMD 0x40 786 #define SSD_BITPTR_VALID 0x08 787 #define SSD_BITPTR_VALUE 0x07 788 #define SSD_MIN_SIZE 18 789 u_int8_t extra_bytes[14]; 790 #define SSD_FULL_SIZE sizeof(struct scsi_sense_data) 791 }; 792 793 struct scsi_mode_header_6 794 { 795 u_int8_t data_length; /* Sense data length */ 796 u_int8_t medium_type; 797 u_int8_t dev_spec; 798 u_int8_t blk_desc_len; 799 }; 800 801 struct scsi_mode_header_10 802 { 803 u_int8_t data_length[2];/* Sense data length */ 804 u_int8_t medium_type; 805 u_int8_t dev_spec; 806 u_int8_t unused[2]; 807 u_int8_t blk_desc_len[2]; 808 }; 809 810 struct scsi_mode_page_header 811 { 812 u_int8_t page_code; 813 u_int8_t page_length; 814 }; 815 816 struct scsi_mode_blk_desc 817 { 818 u_int8_t density; 819 u_int8_t nblocks[3]; 820 u_int8_t reserved; 821 u_int8_t blklen[3]; 822 }; 823 824 #define SCSI_DEFAULT_DENSITY 0x00 /* use 'default' density */ 825 #define SCSI_SAME_DENSITY 0x7f /* use 'same' density- >= SCSI-2 only */ 826 827 828 /* 829 * Status Byte 830 */ 831 #define SCSI_STATUS_OK 0x00 832 #define SCSI_STATUS_CHECK_COND 0x02 833 #define SCSI_STATUS_COND_MET 0x04 834 #define SCSI_STATUS_BUSY 0x08 835 #define SCSI_STATUS_INTERMED 0x10 836 #define SCSI_STATUS_INTERMED_COND_MET 0x14 837 #define SCSI_STATUS_RESERV_CONFLICT 0x18 838 #define SCSI_STATUS_CMD_TERMINATED 0x22 /* Obsolete in SAM-2 */ 839 #define SCSI_STATUS_QUEUE_FULL 0x28 840 #define SCSI_STATUS_ACA_ACTIVE 0x30 841 #define SCSI_STATUS_TASK_ABORTED 0x40 842 843 struct scsi_inquiry_pattern { 844 u_int8_t type; 845 u_int8_t media_type; 846 #define SIP_MEDIA_REMOVABLE 0x01 847 #define SIP_MEDIA_FIXED 0x02 848 const char *vendor; 849 const char *product; 850 const char *revision; 851 }; 852 853 struct scsi_static_inquiry_pattern { 854 u_int8_t type; 855 u_int8_t media_type; 856 char vendor[SID_VENDOR_SIZE+1]; 857 char product[SID_PRODUCT_SIZE+1]; 858 char revision[SID_REVISION_SIZE+1]; 859 }; 860 861 struct scsi_sense_quirk_entry { 862 struct scsi_inquiry_pattern inq_pat; 863 int num_sense_keys; 864 int num_ascs; 865 struct sense_key_table_entry *sense_key_info; 866 struct asc_table_entry *asc_info; 867 }; 868 869 struct sense_key_table_entry { 870 u_int8_t sense_key; 871 u_int32_t action; 872 const char *desc; 873 }; 874 875 struct asc_table_entry { 876 u_int8_t asc; 877 u_int8_t ascq; 878 u_int32_t action; 879 const char *desc; 880 }; 881 882 struct op_table_entry { 883 u_int8_t opcode; 884 u_int16_t opmask; 885 const char *desc; 886 }; 887 888 struct scsi_op_quirk_entry { 889 struct scsi_inquiry_pattern inq_pat; 890 int num_ops; 891 struct op_table_entry *op_table; 892 }; 893 894 typedef enum { 895 SSS_FLAG_NONE = 0x00, 896 SSS_FLAG_PRINT_COMMAND = 0x01 897 } scsi_sense_string_flags; 898 899 struct ccb_scsiio; 900 struct cam_periph; 901 union ccb; 902 #ifndef _KERNEL 903 struct cam_device; 904 #endif 905 906 extern const char *scsi_sense_key_text[]; 907 908 struct sbuf; 909 910 __BEGIN_DECLS 911 void scsi_sense_desc(int sense_key, int asc, int ascq, 912 struct scsi_inquiry_data *inq_data, 913 const char **sense_key_desc, const char **asc_desc); 914 scsi_sense_action scsi_error_action(struct ccb_scsiio* csio, 915 struct scsi_inquiry_data *inq_data, 916 u_int32_t sense_flags); 917 const char * scsi_status_string(struct ccb_scsiio *csio); 918 #ifdef _KERNEL 919 int scsi_command_string(struct ccb_scsiio *csio, struct sbuf *sb); 920 int scsi_sense_sbuf(struct ccb_scsiio *csio, struct sbuf *sb, 921 scsi_sense_string_flags flags); 922 char * scsi_sense_string(struct ccb_scsiio *csio, 923 char *str, int str_len); 924 void scsi_sense_print(struct ccb_scsiio *csio); 925 int scsi_interpret_sense(union ccb *ccb, 926 u_int32_t sense_flags, 927 u_int32_t *relsim_flags, 928 u_int32_t *reduction, 929 u_int32_t *timeout, 930 scsi_sense_action error_action); 931 #else /* _KERNEL */ 932 int scsi_command_string(struct cam_device *device, 933 struct ccb_scsiio *csio, struct sbuf *sb); 934 int scsi_sense_sbuf(struct cam_device *device, 935 struct ccb_scsiio *csio, struct sbuf *sb, 936 scsi_sense_string_flags flags); 937 char * scsi_sense_string(struct cam_device *device, 938 struct ccb_scsiio *csio, 939 char *str, int str_len); 940 void scsi_sense_print(struct cam_device *device, 941 struct ccb_scsiio *csio, FILE *ofile); 942 int scsi_interpret_sense(struct cam_device *device, 943 union ccb *ccb, 944 u_int32_t sense_flags, 945 u_int32_t *relsim_flags, 946 u_int32_t *reduction, 947 u_int32_t *timeout, 948 scsi_sense_action error_action); 949 #endif /* _KERNEL */ 950 951 #define SF_RETRY_UA 0x01 952 #define SF_NO_PRINT 0x02 953 #define SF_QUIET_IR 0x04 /* Be quiet about Illegal Request reponses */ 954 #define SF_PRINT_ALWAYS 0x08 955 956 957 const char * scsi_op_desc(u_int16_t opcode, 958 struct scsi_inquiry_data *inq_data); 959 char * scsi_cdb_string(u_int8_t *cdb_ptr, char *cdb_string, 960 size_t len); 961 962 void scsi_print_inquiry(struct scsi_inquiry_data *inq_data); 963 964 u_int scsi_calc_syncsrate(u_int period_factor); 965 u_int scsi_calc_syncparam(u_int period); 966 967 void scsi_test_unit_ready(struct ccb_scsiio *csio, u_int32_t retries, 968 void (*cbfcnp)(struct cam_periph *, 969 union ccb *), 970 u_int8_t tag_action, 971 u_int8_t sense_len, u_int32_t timeout); 972 973 void scsi_request_sense(struct ccb_scsiio *csio, u_int32_t retries, 974 void (*cbfcnp)(struct cam_periph *, 975 union ccb *), 976 void *data_ptr, u_int8_t dxfer_len, 977 u_int8_t tag_action, u_int8_t sense_len, 978 u_int32_t timeout); 979 980 void scsi_inquiry(struct ccb_scsiio *csio, u_int32_t retries, 981 void (*cbfcnp)(struct cam_periph *, union ccb *), 982 u_int8_t tag_action, u_int8_t *inq_buf, 983 u_int32_t inq_len, int evpd, u_int8_t page_code, 984 u_int8_t sense_len, u_int32_t timeout); 985 986 void scsi_mode_sense(struct ccb_scsiio *csio, u_int32_t retries, 987 void (*cbfcnp)(struct cam_periph *, 988 union ccb *), 989 u_int8_t tag_action, int dbd, 990 u_int8_t page_code, u_int8_t page, 991 u_int8_t *param_buf, u_int32_t param_len, 992 u_int8_t sense_len, u_int32_t timeout); 993 994 void scsi_mode_sense_len(struct ccb_scsiio *csio, u_int32_t retries, 995 void (*cbfcnp)(struct cam_periph *, 996 union ccb *), 997 u_int8_t tag_action, int dbd, 998 u_int8_t page_code, u_int8_t page, 999 u_int8_t *param_buf, u_int32_t param_len, 1000 int minimum_cmd_size, u_int8_t sense_len, 1001 u_int32_t timeout); 1002 1003 void scsi_mode_select(struct ccb_scsiio *csio, u_int32_t retries, 1004 void (*cbfcnp)(struct cam_periph *, 1005 union ccb *), 1006 u_int8_t tag_action, int scsi_page_fmt, 1007 int save_pages, u_int8_t *param_buf, 1008 u_int32_t param_len, u_int8_t sense_len, 1009 u_int32_t timeout); 1010 1011 void scsi_mode_select_len(struct ccb_scsiio *csio, u_int32_t retries, 1012 void (*cbfcnp)(struct cam_periph *, 1013 union ccb *), 1014 u_int8_t tag_action, int scsi_page_fmt, 1015 int save_pages, u_int8_t *param_buf, 1016 u_int32_t param_len, int minimum_cmd_size, 1017 u_int8_t sense_len, u_int32_t timeout); 1018 1019 void scsi_log_sense(struct ccb_scsiio *csio, u_int32_t retries, 1020 void (*cbfcnp)(struct cam_periph *, union ccb *), 1021 u_int8_t tag_action, u_int8_t page_code, 1022 u_int8_t page, int save_pages, int ppc, 1023 u_int32_t paramptr, u_int8_t *param_buf, 1024 u_int32_t param_len, u_int8_t sense_len, 1025 u_int32_t timeout); 1026 1027 void scsi_log_select(struct ccb_scsiio *csio, u_int32_t retries, 1028 void (*cbfcnp)(struct cam_periph *, 1029 union ccb *), u_int8_t tag_action, 1030 u_int8_t page_code, int save_pages, 1031 int pc_reset, u_int8_t *param_buf, 1032 u_int32_t param_len, u_int8_t sense_len, 1033 u_int32_t timeout); 1034 1035 void scsi_prevent(struct ccb_scsiio *csio, u_int32_t retries, 1036 void (*cbfcnp)(struct cam_periph *, union ccb *), 1037 u_int8_t tag_action, u_int8_t action, 1038 u_int8_t sense_len, u_int32_t timeout); 1039 1040 void scsi_read_capacity(struct ccb_scsiio *csio, u_int32_t retries, 1041 void (*cbfcnp)(struct cam_periph *, 1042 union ccb *), u_int8_t tag_action, 1043 struct scsi_read_capacity_data *, 1044 u_int8_t sense_len, u_int32_t timeout); 1045 void scsi_read_capacity_16(struct ccb_scsiio *csio, uint32_t retries, 1046 void (*cbfcnp)(struct cam_periph *, 1047 union ccb *), uint8_t tag_action, 1048 uint64_t lba, int reladr, int pmi, 1049 struct scsi_read_capacity_data_long 1050 *rcap_buf, uint8_t sense_len, 1051 uint32_t timeout); 1052 1053 void scsi_report_luns(struct ccb_scsiio *csio, u_int32_t retries, 1054 void (*cbfcnp)(struct cam_periph *, 1055 union ccb *), u_int8_t tag_action, 1056 u_int8_t select_report, 1057 struct scsi_report_luns_data *rpl_buf, 1058 u_int32_t alloc_len, u_int8_t sense_len, 1059 u_int32_t timeout); 1060 1061 void scsi_synchronize_cache(struct ccb_scsiio *csio, 1062 u_int32_t retries, 1063 void (*cbfcnp)(struct cam_periph *, 1064 union ccb *), u_int8_t tag_action, 1065 u_int32_t begin_lba, u_int16_t lb_count, 1066 u_int8_t sense_len, u_int32_t timeout); 1067 1068 void scsi_read_write(struct ccb_scsiio *csio, u_int32_t retries, 1069 void (*cbfcnp)(struct cam_periph *, union ccb *), 1070 u_int8_t tag_action, int readop, u_int8_t byte2, 1071 int minimum_cmd_size, u_int64_t lba, 1072 u_int32_t block_count, u_int8_t *data_ptr, 1073 u_int32_t dxfer_len, u_int8_t sense_len, 1074 u_int32_t timeout); 1075 1076 void scsi_start_stop(struct ccb_scsiio *csio, u_int32_t retries, 1077 void (*cbfcnp)(struct cam_periph *, union ccb *), 1078 u_int8_t tag_action, int start, int load_eject, 1079 int immediate, u_int8_t sense_len, u_int32_t timeout); 1080 1081 int scsi_inquiry_match(caddr_t inqbuffer, caddr_t table_entry); 1082 int scsi_static_inquiry_match(caddr_t inqbuffer, 1083 caddr_t table_entry); 1084 1085 static __inline void scsi_extract_sense(struct scsi_sense_data *sense, 1086 int *error_code, int *sense_key, 1087 int *asc, int *ascq); 1088 static __inline void scsi_ulto2b(u_int32_t val, u_int8_t *bytes); 1089 static __inline void scsi_ulto3b(u_int32_t val, u_int8_t *bytes); 1090 static __inline void scsi_ulto4b(u_int32_t val, u_int8_t *bytes); 1091 static __inline void scsi_u64to8b(u_int64_t val, u_int8_t *bytes); 1092 static __inline u_int32_t scsi_2btoul(u_int8_t *bytes); 1093 static __inline u_int32_t scsi_3btoul(u_int8_t *bytes); 1094 static __inline int32_t scsi_3btol(u_int8_t *bytes); 1095 static __inline u_int32_t scsi_4btoul(u_int8_t *bytes); 1096 static __inline u_int64_t scsi_8btou64(u_int8_t *bytes); 1097 static __inline void *find_mode_page_6(struct scsi_mode_header_6 *mode_header); 1098 static __inline void *find_mode_page_10(struct scsi_mode_header_10 *mode_header); 1099 1100 static __inline void scsi_extract_sense(struct scsi_sense_data *sense, 1101 int *error_code, int *sense_key, 1102 int *asc, int *ascq) 1103 { 1104 *error_code = sense->error_code & SSD_ERRCODE; 1105 *sense_key = sense->flags & SSD_KEY; 1106 *asc = (sense->extra_len >= 5) ? sense->add_sense_code : 0; 1107 *ascq = (sense->extra_len >= 6) ? sense->add_sense_code_qual : 0; 1108 } 1109 1110 static __inline void 1111 scsi_ulto2b(u_int32_t val, u_int8_t *bytes) 1112 { 1113 1114 bytes[0] = (val >> 8) & 0xff; 1115 bytes[1] = val & 0xff; 1116 } 1117 1118 static __inline void 1119 scsi_ulto3b(u_int32_t val, u_int8_t *bytes) 1120 { 1121 1122 bytes[0] = (val >> 16) & 0xff; 1123 bytes[1] = (val >> 8) & 0xff; 1124 bytes[2] = val & 0xff; 1125 } 1126 1127 static __inline void 1128 scsi_ulto4b(u_int32_t val, u_int8_t *bytes) 1129 { 1130 1131 bytes[0] = (val >> 24) & 0xff; 1132 bytes[1] = (val >> 16) & 0xff; 1133 bytes[2] = (val >> 8) & 0xff; 1134 bytes[3] = val & 0xff; 1135 } 1136 1137 static __inline void 1138 scsi_u64to8b(u_int64_t val, u_int8_t *bytes) 1139 { 1140 1141 bytes[0] = (val >> 56) & 0xff; 1142 bytes[1] = (val >> 48) & 0xff; 1143 bytes[2] = (val >> 40) & 0xff; 1144 bytes[3] = (val >> 32) & 0xff; 1145 bytes[4] = (val >> 24) & 0xff; 1146 bytes[5] = (val >> 16) & 0xff; 1147 bytes[6] = (val >> 8) & 0xff; 1148 bytes[7] = val & 0xff; 1149 } 1150 1151 static __inline u_int32_t 1152 scsi_2btoul(u_int8_t *bytes) 1153 { 1154 u_int32_t rv; 1155 1156 rv = (bytes[0] << 8) | 1157 bytes[1]; 1158 return (rv); 1159 } 1160 1161 static __inline u_int32_t 1162 scsi_3btoul(u_int8_t *bytes) 1163 { 1164 u_int32_t rv; 1165 1166 rv = (bytes[0] << 16) | 1167 (bytes[1] << 8) | 1168 bytes[2]; 1169 return (rv); 1170 } 1171 1172 static __inline int32_t 1173 scsi_3btol(u_int8_t *bytes) 1174 { 1175 u_int32_t rc = scsi_3btoul(bytes); 1176 1177 if (rc & 0x00800000) 1178 rc |= 0xff000000; 1179 1180 return (int32_t) rc; 1181 } 1182 1183 static __inline u_int32_t 1184 scsi_4btoul(u_int8_t *bytes) 1185 { 1186 u_int32_t rv; 1187 1188 rv = (bytes[0] << 24) | 1189 (bytes[1] << 16) | 1190 (bytes[2] << 8) | 1191 bytes[3]; 1192 return (rv); 1193 } 1194 1195 static __inline uint64_t 1196 scsi_8btou64(uint8_t *bytes) 1197 { 1198 uint64_t rv; 1199 1200 rv = (((uint64_t)bytes[0]) << 56) | 1201 (((uint64_t)bytes[1]) << 48) | 1202 (((uint64_t)bytes[2]) << 40) | 1203 (((uint64_t)bytes[3]) << 32) | 1204 (((uint64_t)bytes[4]) << 24) | 1205 (((uint64_t)bytes[5]) << 16) | 1206 (((uint64_t)bytes[6]) << 8) | 1207 bytes[7]; 1208 return (rv); 1209 } 1210 1211 /* 1212 * Given the pointer to a returned mode sense buffer, return a pointer to 1213 * the start of the first mode page. 1214 */ 1215 static __inline void * 1216 find_mode_page_6(struct scsi_mode_header_6 *mode_header) 1217 { 1218 void *page_start; 1219 1220 page_start = (void *)((u_int8_t *)&mode_header[1] + 1221 mode_header->blk_desc_len); 1222 1223 return(page_start); 1224 } 1225 1226 static __inline void * 1227 find_mode_page_10(struct scsi_mode_header_10 *mode_header) 1228 { 1229 void *page_start; 1230 1231 page_start = (void *)((u_int8_t *)&mode_header[1] + 1232 scsi_2btoul(mode_header->blk_desc_len)); 1233 1234 return(page_start); 1235 } 1236 1237 __END_DECLS 1238 1239 #endif /*_SCSI_SCSI_ALL_H*/ 1240