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