Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)
[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]
FreeBSD/Linux Kernel Cross Reference
sys/cam/scsi/scsi_all.h
Version:
- FREEBSD - FREEBSD-13-STABLE - FREEBSD-13-0 - FREEBSD-12-STABLE - FREEBSD-12-0 - FREEBSD-11-STABLE - FREEBSD-11-0 - FREEBSD-10-STABLE - FREEBSD-10-0 - FREEBSD-9-STABLE - FREEBSD-9-0 - FREEBSD-8-STABLE - FREEBSD-8-0 - FREEBSD-7-STABLE - FREEBSD-7-0 - FREEBSD-6-STABLE - FREEBSD-6-0 - FREEBSD-5-STABLE - FREEBSD-5-0 - FREEBSD-4-STABLE - FREEBSD-3-STABLE - FREEBSD22 - l41 - OPENBSD - linux-2.6 - MK84 - PLAN9 - xnu-8792
SearchContext: - none - 3 - 10
SearchContext: - none - 3 - 10
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: releng/5.0/sys/cam/scsi/scsi_all.h 104681 2002-10-08 17:12:44Z ken $ 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 #define SRW10_FUA 0x08 423 #define SRW10_DPO 0x10 424 u_int8_t byte2; 425 u_int8_t addr[4]; 426 u_int8_t reserved; 427 u_int8_t length[2]; 428 u_int8_t control; 429 }; 430 431 struct scsi_rw_12 432 { 433 u_int8_t opcode; 434 #define SRW12_RELADDR 0x01 435 #define SRW12_FUA 0x08 436 #define SRW12_DPO 0x10 437 u_int8_t byte2; 438 u_int8_t addr[4]; 439 u_int8_t length[4]; 440 u_int8_t reserved; 441 u_int8_t control; 442 }; 443 444 struct scsi_start_stop_unit 445 { 446 u_int8_t opcode; 447 u_int8_t byte2; 448 #define SSS_IMMED 0x01 449 u_int8_t reserved[2]; 450 u_int8_t how; 451 #define SSS_START 0x01 452 #define SSS_LOEJ 0x02 453 u_int8_t control; 454 }; 455 456 #define SC_SCSI_1 0x01 457 #define SC_SCSI_2 0x03 458 459 /* 460 * Opcodes 461 */ 462 463 #define TEST_UNIT_READY 0x00 464 #define REQUEST_SENSE 0x03 465 #define READ_6 0x08 466 #define WRITE_6 0x0a 467 #define INQUIRY 0x12 468 #define MODE_SELECT_6 0x15 469 #define MODE_SENSE_6 0x1a 470 #define START_STOP_UNIT 0x1b 471 #define START_STOP 0x1b 472 #define RESERVE 0x16 473 #define RELEASE 0x17 474 #define RECEIVE_DIAGNOSTIC 0x1c 475 #define SEND_DIAGNOSTIC 0x1d 476 #define PREVENT_ALLOW 0x1e 477 #define READ_CAPACITY 0x25 478 #define READ_10 0x28 479 #define WRITE_10 0x2a 480 #define POSITION_TO_ELEMENT 0x2b 481 #define SYNCHRONIZE_CACHE 0x35 482 #define WRITE_BUFFER 0x3b 483 #define READ_BUFFER 0x3c 484 #define CHANGE_DEFINITION 0x40 485 #define LOG_SELECT 0x4c 486 #define LOG_SENSE 0x4d 487 #define MODE_SELECT_10 0x55 488 #define MODE_SENSE_10 0x5A 489 #define REPORT_LUNS 0xA0 490 #define MOVE_MEDIUM 0xa5 491 #define READ_12 0xa8 492 #define WRITE_12 0xaa 493 #define READ_ELEMENT_STATUS 0xb8 494 495 496 /* 497 * Device Types 498 */ 499 #define T_DIRECT 0x00 500 #define T_SEQUENTIAL 0x01 501 #define T_PRINTER 0x02 502 #define T_PROCESSOR 0x03 503 #define T_WORM 0x04 504 #define T_CDROM 0x05 505 #define T_SCANNER 0x06 506 #define T_OPTICAL 0x07 507 #define T_CHANGER 0x08 508 #define T_COMM 0x09 509 #define T_ASC0 0x0a 510 #define T_ASC1 0x0b 511 #define T_STORARRAY 0x0c 512 #define T_ENCLOSURE 0x0d 513 #define T_RBC 0x0e 514 #define T_OCRW 0x0f 515 #define T_NODEVICE 0x1F 516 #define T_ANY 0xFF /* Used in Quirk table matches */ 517 518 #define T_REMOV 1 519 #define T_FIXED 0 520 521 /* 522 * This length is the initial inquiry length used by the probe code, as 523 * well as the legnth necessary for scsi_print_inquiry() to function 524 * correctly. If either use requires a different length in the future, 525 * the two values should be de-coupled. 526 */ 527 #define SHORT_INQUIRY_LENGTH 36 528 529 struct scsi_inquiry_data 530 { 531 u_int8_t device; 532 #define SID_TYPE(inq_data) ((inq_data)->device & 0x1f) 533 #define SID_QUAL(inq_data) (((inq_data)->device & 0xE0) >> 5) 534 #define SID_QUAL_LU_CONNECTED 0x00 /* 535 * The specified peripheral device 536 * type is currently connected to 537 * logical unit. If the target cannot 538 * determine whether or not a physical 539 * device is currently connected, it 540 * shall also use this peripheral 541 * qualifier when returning the INQUIRY 542 * data. This peripheral qualifier 543 * does not mean that the device is 544 * ready for access by the initiator. 545 */ 546 #define SID_QUAL_LU_OFFLINE 0x01 /* 547 * The target is capable of supporting 548 * the specified peripheral device type 549 * on this logical unit; however, the 550 * physical device is not currently 551 * connected to this logical unit. 552 */ 553 #define SID_QUAL_RSVD 0x02 554 #define SID_QUAL_BAD_LU 0x03 /* 555 * The target is not capable of 556 * supporting a physical device on 557 * this logical unit. For this 558 * peripheral qualifier the peripheral 559 * device type shall be set to 1Fh to 560 * provide compatibility with previous 561 * versions of SCSI. All other 562 * peripheral device type values are 563 * reserved for this peripheral 564 * qualifier. 565 */ 566 #define SID_QUAL_IS_VENDOR_UNIQUE(inq_data) ((SID_QUAL(inq_data) & 0x08) != 0) 567 u_int8_t dev_qual2; 568 #define SID_QUAL2 0x7F 569 #define SID_IS_REMOVABLE(inq_data) (((inq_data)->dev_qual2 & 0x80) != 0) 570 u_int8_t version; 571 #define SID_ANSI_REV(inq_data) ((inq_data)->version & 0x07) 572 #define SCSI_REV_0 0 573 #define SCSI_REV_CCS 1 574 #define SCSI_REV_2 2 575 #define SCSI_REV_SPC 3 576 #define SCSI_REV_SPC2 4 577 578 #define SID_ECMA 0x38 579 #define SID_ISO 0xC0 580 u_int8_t response_format; 581 #define SID_AENC 0x80 582 #define SID_TrmIOP 0x40 583 u_int8_t additional_length; 584 u_int8_t reserved[2]; 585 u_int8_t flags; 586 #define SID_SftRe 0x01 587 #define SID_CmdQue 0x02 588 #define SID_Linked 0x08 589 #define SID_Sync 0x10 590 #define SID_WBus16 0x20 591 #define SID_WBus32 0x40 592 #define SID_RelAdr 0x80 593 #define SID_VENDOR_SIZE 8 594 char vendor[SID_VENDOR_SIZE]; 595 #define SID_PRODUCT_SIZE 16 596 char product[SID_PRODUCT_SIZE]; 597 #define SID_REVISION_SIZE 4 598 char revision[SID_REVISION_SIZE]; 599 /* 600 * The following fields were taken from SCSI Primary Commands - 2 601 * (SPC-2) Revision 14, Dated 11 November 1999 602 */ 603 #define SID_VENDOR_SPECIFIC_0_SIZE 20 604 u_int8_t vendor_specific0[SID_VENDOR_SPECIFIC_0_SIZE]; 605 /* 606 * An extension of SCSI Parallel Specific Values 607 */ 608 #define SID_SPI_IUS 0x01 609 #define SID_SPI_QAS 0x02 610 #define SID_SPI_CLOCK_ST 0x00 611 #define SID_SPI_CLOCK_DT 0x04 612 #define SID_SPI_CLOCK_DT_ST 0x0C 613 #define SID_SPI_MASK 0x0F 614 u_int8_t spi3data; 615 u_int8_t reserved2; 616 /* 617 * Version Descriptors, stored 2 byte values. 618 */ 619 u_int8_t version1[2]; 620 u_int8_t version2[2]; 621 u_int8_t version3[2]; 622 u_int8_t version4[2]; 623 u_int8_t version5[2]; 624 u_int8_t version6[2]; 625 u_int8_t version7[2]; 626 u_int8_t version8[2]; 627 628 u_int8_t reserved3[22]; 629 630 #define SID_VENDOR_SPECIFIC_1_SIZE 160 631 u_int8_t vendor_specific1[SID_VENDOR_SPECIFIC_1_SIZE]; 632 }; 633 634 struct scsi_vpd_unit_serial_number 635 { 636 u_int8_t device; 637 u_int8_t page_code; 638 #define SVPD_UNIT_SERIAL_NUMBER 0x80 639 u_int8_t reserved; 640 u_int8_t length; /* serial number length */ 641 #define SVPD_SERIAL_NUM_SIZE 251 642 u_int8_t serial_num[SVPD_SERIAL_NUM_SIZE]; 643 }; 644 645 struct scsi_read_capacity 646 { 647 u_int8_t opcode; 648 u_int8_t byte2; 649 u_int8_t addr[4]; 650 u_int8_t unused[3]; 651 u_int8_t control; 652 }; 653 654 struct scsi_read_capacity_data 655 { 656 u_int8_t addr[4]; 657 u_int8_t length[4]; 658 }; 659 660 struct scsi_report_luns 661 { 662 u_int8_t opcode; 663 u_int8_t byte2; 664 u_int8_t unused[3]; 665 u_int8_t addr[4]; 666 u_int8_t control; 667 }; 668 669 struct scsi_report_luns_data { 670 u_int8_t length[4]; /* length of LUN inventory, in bytes */ 671 u_int8_t reserved[4]; /* unused */ 672 /* 673 * LUN inventory- we only support the type zero form for now. 674 */ 675 struct { 676 u_int8_t lundata[8]; 677 } luns[1]; 678 }; 679 #define RPL_LUNDATA_ATYP_MASK 0xc0 /* MBZ for type 0 lun */ 680 #define RPL_LUNDATA_T0LUN 1 /* @ lundata[1] */ 681 682 683 struct scsi_sense_data 684 { 685 u_int8_t error_code; 686 #define SSD_ERRCODE 0x7F 687 #define SSD_CURRENT_ERROR 0x70 688 #define SSD_DEFERRED_ERROR 0x71 689 #define SSD_ERRCODE_VALID 0x80 690 u_int8_t segment; 691 u_int8_t flags; 692 #define SSD_KEY 0x0F 693 #define SSD_KEY_NO_SENSE 0x00 694 #define SSD_KEY_RECOVERED_ERROR 0x01 695 #define SSD_KEY_NOT_READY 0x02 696 #define SSD_KEY_MEDIUM_ERROR 0x03 697 #define SSD_KEY_HARDWARE_ERROR 0x04 698 #define SSD_KEY_ILLEGAL_REQUEST 0x05 699 #define SSD_KEY_UNIT_ATTENTION 0x06 700 #define SSD_KEY_DATA_PROTECT 0x07 701 #define SSD_KEY_BLANK_CHECK 0x08 702 #define SSD_KEY_Vendor_Specific 0x09 703 #define SSD_KEY_COPY_ABORTED 0x0a 704 #define SSD_KEY_ABORTED_COMMAND 0x0b 705 #define SSD_KEY_EQUAL 0x0c 706 #define SSD_KEY_VOLUME_OVERFLOW 0x0d 707 #define SSD_KEY_MISCOMPARE 0x0e 708 #define SSD_KEY_RESERVED 0x0f 709 #define SSD_ILI 0x20 710 #define SSD_EOM 0x40 711 #define SSD_FILEMARK 0x80 712 u_int8_t info[4]; 713 u_int8_t extra_len; 714 u_int8_t cmd_spec_info[4]; 715 u_int8_t add_sense_code; 716 u_int8_t add_sense_code_qual; 717 u_int8_t fru; 718 u_int8_t sense_key_spec[3]; 719 #define SSD_SCS_VALID 0x80 720 #define SSD_FIELDPTR_CMD 0x40 721 #define SSD_BITPTR_VALID 0x08 722 #define SSD_BITPTR_VALUE 0x07 723 #define SSD_MIN_SIZE 18 724 u_int8_t extra_bytes[14]; 725 #define SSD_FULL_SIZE sizeof(struct scsi_sense_data) 726 }; 727 728 struct scsi_mode_header_6 729 { 730 u_int8_t data_length; /* Sense data length */ 731 u_int8_t medium_type; 732 u_int8_t dev_spec; 733 u_int8_t blk_desc_len; 734 }; 735 736 struct scsi_mode_header_10 737 { 738 u_int8_t data_length[2];/* Sense data length */ 739 u_int8_t medium_type; 740 u_int8_t dev_spec; 741 u_int8_t unused[2]; 742 u_int8_t blk_desc_len[2]; 743 }; 744 745 struct scsi_mode_page_header 746 { 747 u_int8_t page_code; 748 u_int8_t page_length; 749 }; 750 751 struct scsi_mode_blk_desc 752 { 753 u_int8_t density; 754 u_int8_t nblocks[3]; 755 u_int8_t reserved; 756 u_int8_t blklen[3]; 757 }; 758 759 #define SCSI_DEFAULT_DENSITY 0x00 /* use 'default' density */ 760 #define SCSI_SAME_DENSITY 0x7f /* use 'same' density- >= SCSI-2 only */ 761 762 763 /* 764 * Status Byte 765 */ 766 #define SCSI_STATUS_OK 0x00 767 #define SCSI_STATUS_CHECK_COND 0x02 768 #define SCSI_STATUS_COND_MET 0x04 769 #define SCSI_STATUS_BUSY 0x08 770 #define SCSI_STATUS_INTERMED 0x10 771 #define SCSI_STATUS_INTERMED_COND_MET 0x14 772 #define SCSI_STATUS_RESERV_CONFLICT 0x18 773 #define SCSI_STATUS_CMD_TERMINATED 0x22 /* Obsolete in SAM-2 */ 774 #define SCSI_STATUS_QUEUE_FULL 0x28 775 #define SCSI_STATUS_ACA_ACTIVE 0x30 776 #define SCSI_STATUS_TASK_ABORTED 0x40 777 778 struct scsi_inquiry_pattern { 779 u_int8_t type; 780 u_int8_t media_type; 781 #define SIP_MEDIA_REMOVABLE 0x01 782 #define SIP_MEDIA_FIXED 0x02 783 const char *vendor; 784 const char *product; 785 const char *revision; 786 }; 787 788 struct scsi_static_inquiry_pattern { 789 u_int8_t type; 790 u_int8_t media_type; 791 char vendor[SID_VENDOR_SIZE+1]; 792 char product[SID_PRODUCT_SIZE+1]; 793 char revision[SID_REVISION_SIZE+1]; 794 }; 795 796 struct scsi_sense_quirk_entry { 797 struct scsi_inquiry_pattern inq_pat; 798 int num_sense_keys; 799 int num_ascs; 800 struct sense_key_table_entry *sense_key_info; 801 struct asc_table_entry *asc_info; 802 }; 803 804 struct sense_key_table_entry { 805 u_int8_t sense_key; 806 u_int32_t action; 807 const char *desc; 808 }; 809 810 struct asc_table_entry { 811 u_int8_t asc; 812 u_int8_t ascq; 813 u_int32_t action; 814 const char *desc; 815 }; 816 817 struct op_table_entry { 818 u_int8_t opcode; 819 u_int16_t opmask; 820 const char *desc; 821 }; 822 823 struct scsi_op_quirk_entry { 824 struct scsi_inquiry_pattern inq_pat; 825 int num_ops; 826 struct op_table_entry *op_table; 827 }; 828 829 typedef enum { 830 SSS_FLAG_NONE = 0x00, 831 SSS_FLAG_PRINT_COMMAND = 0x01 832 } scsi_sense_string_flags; 833 834 struct ccb_scsiio; 835 struct cam_periph; 836 union ccb; 837 #ifndef _KERNEL 838 struct cam_device; 839 #endif 840 841 extern const char *scsi_sense_key_text[]; 842 843 struct sbuf; 844 845 __BEGIN_DECLS 846 void scsi_sense_desc(int sense_key, int asc, int ascq, 847 struct scsi_inquiry_data *inq_data, 848 const char **sense_key_desc, const char **asc_desc); 849 scsi_sense_action scsi_error_action(struct ccb_scsiio* csio, 850 struct scsi_inquiry_data *inq_data, 851 u_int32_t sense_flags); 852 const char * scsi_status_string(struct ccb_scsiio *csio); 853 #ifdef _KERNEL 854 int scsi_command_string(struct ccb_scsiio *csio, struct sbuf *sb); 855 int scsi_sense_sbuf(struct ccb_scsiio *csio, struct sbuf *sb, 856 scsi_sense_string_flags flags); 857 char * scsi_sense_string(struct ccb_scsiio *csio, 858 char *str, int str_len); 859 void scsi_sense_print(struct ccb_scsiio *csio); 860 int scsi_interpret_sense(union ccb *ccb, 861 u_int32_t sense_flags, 862 u_int32_t *relsim_flags, 863 u_int32_t *reduction, 864 u_int32_t *timeout, 865 scsi_sense_action error_action); 866 #else /* _KERNEL */ 867 int scsi_command_string(struct cam_device *device, 868 struct ccb_scsiio *csio, struct sbuf *sb); 869 int scsi_sense_sbuf(struct cam_device *device, 870 struct ccb_scsiio *csio, struct sbuf *sb, 871 scsi_sense_string_flags flags); 872 char * scsi_sense_string(struct cam_device *device, 873 struct ccb_scsiio *csio, 874 char *str, int str_len); 875 void scsi_sense_print(struct cam_device *device, 876 struct ccb_scsiio *csio, FILE *ofile); 877 int scsi_interpret_sense(struct cam_device *device, 878 union ccb *ccb, 879 u_int32_t sense_flags, 880 u_int32_t *relsim_flags, 881 u_int32_t *reduction, 882 u_int32_t *timeout, 883 scsi_sense_action error_action); 884 #endif /* _KERNEL */ 885 886 #define SF_RETRY_UA 0x01 887 #define SF_NO_PRINT 0x02 888 #define SF_QUIET_IR 0x04 /* Be quiet about Illegal Request reponses */ 889 #define SF_PRINT_ALWAYS 0x08 890 891 892 const char * scsi_op_desc(u_int16_t opcode, 893 struct scsi_inquiry_data *inq_data); 894 char * scsi_cdb_string(u_int8_t *cdb_ptr, char *cdb_string, 895 size_t len); 896 897 void scsi_print_inquiry(struct scsi_inquiry_data *inq_data); 898 899 u_int scsi_calc_syncsrate(u_int period_factor); 900 u_int scsi_calc_syncparam(u_int period); 901 902 void scsi_test_unit_ready(struct ccb_scsiio *csio, u_int32_t retries, 903 void (*cbfcnp)(struct cam_periph *, 904 union ccb *), 905 u_int8_t tag_action, 906 u_int8_t sense_len, u_int32_t timeout); 907 908 void scsi_request_sense(struct ccb_scsiio *csio, u_int32_t retries, 909 void (*cbfcnp)(struct cam_periph *, 910 union ccb *), 911 void *data_ptr, u_int8_t dxfer_len, 912 u_int8_t tag_action, u_int8_t sense_len, 913 u_int32_t timeout); 914 915 void scsi_inquiry(struct ccb_scsiio *csio, u_int32_t retries, 916 void (*cbfcnp)(struct cam_periph *, union ccb *), 917 u_int8_t tag_action, u_int8_t *inq_buf, 918 u_int32_t inq_len, int evpd, u_int8_t page_code, 919 u_int8_t sense_len, u_int32_t timeout); 920 921 void scsi_mode_sense(struct ccb_scsiio *csio, u_int32_t retries, 922 void (*cbfcnp)(struct cam_periph *, 923 union ccb *), 924 u_int8_t tag_action, int dbd, 925 u_int8_t page_code, u_int8_t page, 926 u_int8_t *param_buf, u_int32_t param_len, 927 u_int8_t sense_len, u_int32_t timeout); 928 929 void scsi_mode_select(struct ccb_scsiio *csio, u_int32_t retries, 930 void (*cbfcnp)(struct cam_periph *, 931 union ccb *), 932 u_int8_t tag_action, int scsi_page_fmt, 933 int save_pages, u_int8_t *param_buf, 934 u_int32_t param_len, u_int8_t sense_len, 935 u_int32_t timeout); 936 937 void scsi_log_sense(struct ccb_scsiio *csio, u_int32_t retries, 938 void (*cbfcnp)(struct cam_periph *, union ccb *), 939 u_int8_t tag_action, u_int8_t page_code, 940 u_int8_t page, int save_pages, int ppc, 941 u_int32_t paramptr, u_int8_t *param_buf, 942 u_int32_t param_len, u_int8_t sense_len, 943 u_int32_t timeout); 944 945 void scsi_log_select(struct ccb_scsiio *csio, u_int32_t retries, 946 void (*cbfcnp)(struct cam_periph *, 947 union ccb *), u_int8_t tag_action, 948 u_int8_t page_code, int save_pages, 949 int pc_reset, u_int8_t *param_buf, 950 u_int32_t param_len, u_int8_t sense_len, 951 u_int32_t timeout); 952 953 void scsi_prevent(struct ccb_scsiio *csio, u_int32_t retries, 954 void (*cbfcnp)(struct cam_periph *, union ccb *), 955 u_int8_t tag_action, u_int8_t action, 956 u_int8_t sense_len, u_int32_t timeout); 957 958 void scsi_read_capacity(struct ccb_scsiio *csio, u_int32_t retries, 959 void (*cbfcnp)(struct cam_periph *, 960 union ccb *), u_int8_t tag_action, 961 struct scsi_read_capacity_data *, 962 u_int8_t sense_len, u_int32_t timeout); 963 964 void scsi_report_luns(struct ccb_scsiio *csio, u_int32_t retries, 965 void (*cbfcnp)(struct cam_periph *, 966 union ccb *), u_int8_t tag_action, 967 struct scsi_report_luns_data *, 968 u_int32_t alloc_len, u_int8_t sense_len, 969 u_int32_t timeout); 970 971 void scsi_synchronize_cache(struct ccb_scsiio *csio, 972 u_int32_t retries, 973 void (*cbfcnp)(struct cam_periph *, 974 union ccb *), u_int8_t tag_action, 975 u_int32_t begin_lba, u_int16_t lb_count, 976 u_int8_t sense_len, u_int32_t timeout); 977 978 void scsi_read_write(struct ccb_scsiio *csio, u_int32_t retries, 979 void (*cbfcnp)(struct cam_periph *, union ccb *), 980 u_int8_t tag_action, int readop, u_int8_t byte2, 981 int minimum_cmd_size, u_int32_t lba, 982 u_int32_t block_count, u_int8_t *data_ptr, 983 u_int32_t dxfer_len, u_int8_t sense_len, 984 u_int32_t timeout); 985 986 void scsi_start_stop(struct ccb_scsiio *csio, u_int32_t retries, 987 void (*cbfcnp)(struct cam_periph *, union ccb *), 988 u_int8_t tag_action, int start, int load_eject, 989 int immediate, u_int8_t sense_len, u_int32_t timeout); 990 991 int scsi_inquiry_match(caddr_t inqbuffer, caddr_t table_entry); 992 int scsi_static_inquiry_match(caddr_t inqbuffer, 993 caddr_t table_entry); 994 995 static __inline void scsi_extract_sense(struct scsi_sense_data *sense, 996 int *error_code, int *sense_key, 997 int *asc, int *ascq); 998 static __inline void scsi_ulto2b(u_int32_t val, u_int8_t *bytes); 999 static __inline void scsi_ulto3b(u_int32_t val, u_int8_t *bytes); 1000 static __inline void scsi_ulto4b(u_int32_t val, u_int8_t *bytes); 1001 static __inline u_int32_t scsi_2btoul(u_int8_t *bytes); 1002 static __inline u_int32_t scsi_3btoul(u_int8_t *bytes); 1003 static __inline int32_t scsi_3btol(u_int8_t *bytes); 1004 static __inline u_int32_t scsi_4btoul(u_int8_t *bytes); 1005 static __inline void *find_mode_page_6(struct scsi_mode_header_6 *mode_header); 1006 static __inline void *find_mode_page_10(struct scsi_mode_header_10 *mode_header); 1007 1008 static __inline void scsi_extract_sense(struct scsi_sense_data *sense, 1009 int *error_code, int *sense_key, 1010 int *asc, int *ascq) 1011 { 1012 *error_code = sense->error_code & SSD_ERRCODE; 1013 *sense_key = sense->flags & SSD_KEY; 1014 *asc = (sense->extra_len >= 5) ? sense->add_sense_code : 0; 1015 *ascq = (sense->extra_len >= 6) ? sense->add_sense_code_qual : 0; 1016 } 1017 1018 static __inline void 1019 scsi_ulto2b(u_int32_t val, u_int8_t *bytes) 1020 { 1021 1022 bytes[0] = (val >> 8) & 0xff; 1023 bytes[1] = val & 0xff; 1024 } 1025 1026 static __inline void 1027 scsi_ulto3b(u_int32_t val, u_int8_t *bytes) 1028 { 1029 1030 bytes[0] = (val >> 16) & 0xff; 1031 bytes[1] = (val >> 8) & 0xff; 1032 bytes[2] = val & 0xff; 1033 } 1034 1035 static __inline void 1036 scsi_ulto4b(u_int32_t val, u_int8_t *bytes) 1037 { 1038 1039 bytes[0] = (val >> 24) & 0xff; 1040 bytes[1] = (val >> 16) & 0xff; 1041 bytes[2] = (val >> 8) & 0xff; 1042 bytes[3] = val & 0xff; 1043 } 1044 1045 static __inline u_int32_t 1046 scsi_2btoul(u_int8_t *bytes) 1047 { 1048 u_int32_t rv; 1049 1050 rv = (bytes[0] << 8) | 1051 bytes[1]; 1052 return (rv); 1053 } 1054 1055 static __inline u_int32_t 1056 scsi_3btoul(u_int8_t *bytes) 1057 { 1058 u_int32_t rv; 1059 1060 rv = (bytes[0] << 16) | 1061 (bytes[1] << 8) | 1062 bytes[2]; 1063 return (rv); 1064 } 1065 1066 static __inline int32_t 1067 scsi_3btol(u_int8_t *bytes) 1068 { 1069 u_int32_t rc = scsi_3btoul(bytes); 1070 1071 if (rc & 0x00800000) 1072 rc |= 0xff000000; 1073 1074 return (int32_t) rc; 1075 } 1076 1077 static __inline u_int32_t 1078 scsi_4btoul(u_int8_t *bytes) 1079 { 1080 u_int32_t rv; 1081 1082 rv = (bytes[0] << 24) | 1083 (bytes[1] << 16) | 1084 (bytes[2] << 8) | 1085 bytes[3]; 1086 return (rv); 1087 } 1088 1089 /* 1090 * Given the pointer to a returned mode sense buffer, return a pointer to 1091 * the start of the first mode page. 1092 */ 1093 static __inline void * 1094 find_mode_page_6(struct scsi_mode_header_6 *mode_header) 1095 { 1096 void *page_start; 1097 1098 page_start = (void *)((u_int8_t *)&mode_header[1] + 1099 mode_header->blk_desc_len); 1100 1101 return(page_start); 1102 } 1103 1104 static __inline void * 1105 find_mode_page_10(struct scsi_mode_header_10 *mode_header) 1106 { 1107 void *page_start; 1108 1109 page_start = (void *)((u_int8_t *)&mode_header[1] + 1110 scsi_2btoul(mode_header->blk_desc_len)); 1111 1112 return(page_start); 1113 } 1114 1115 __END_DECLS 1116 1117 #endif /*_SCSI_SCSI_ALL_H*/
Cache object: 23f1a9acf19bc80d63f0265952fcf101
[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]