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$ 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 #include <machine/stdarg.h> 29 30 #ifdef _KERNEL 31 /* 32 * This is the number of seconds we wait for devices to settle after a SCSI 33 * bus reset. 34 */ 35 extern int scsi_delay; 36 #endif /* _KERNEL */ 37 38 /* 39 * SCSI command format 40 */ 41 42 /* 43 * Define dome bits that are in ALL (or a lot of) scsi commands 44 */ 45 #define SCSI_CTL_LINK 0x01 46 #define SCSI_CTL_FLAG 0x02 47 #define SCSI_CTL_VENDOR 0xC0 48 #define SCSI_CMD_LUN 0xA0 /* these two should not be needed */ 49 #define SCSI_CMD_LUN_SHIFT 5 /* LUN in the cmd is no longer SCSI */ 50 51 #define SCSI_MAX_CDBLEN 16 /* 52 * 16 byte commands are in the 53 * SCSI-3 spec 54 */ 55 #if defined(CAM_MAX_CDBLEN) && (CAM_MAX_CDBLEN < SCSI_MAX_CDBLEN) 56 #error "CAM_MAX_CDBLEN cannot be less than SCSI_MAX_CDBLEN" 57 #endif 58 59 /* 6byte CDBs special case 0 length to be 256 */ 60 #define SCSI_CDB6_LEN(len) ((len) == 0 ? 256 : len) 61 62 /* 63 * This type defines actions to be taken when a particular sense code is 64 * received. Right now, these flags are only defined to take up 16 bits, 65 * but can be expanded in the future if necessary. 66 */ 67 typedef enum { 68 SS_NOP = 0x000000, /* Do nothing */ 69 SS_RETRY = 0x010000, /* Retry the command */ 70 SS_FAIL = 0x020000, /* Bail out */ 71 SS_START = 0x030000, /* Send a Start Unit command to the device, 72 * then retry the original command. 73 */ 74 SS_TUR = 0x040000, /* Send a Test Unit Ready command to the 75 * device, then retry the original command. 76 */ 77 SS_MASK = 0xff0000 78 } scsi_sense_action; 79 80 typedef enum { 81 SSQ_NONE = 0x0000, 82 SSQ_DECREMENT_COUNT = 0x0100, /* Decrement the retry count */ 83 SSQ_MANY = 0x0200, /* send lots of recovery commands */ 84 SSQ_RANGE = 0x0400, /* 85 * This table entry represents the 86 * end of a range of ASCQs that 87 * have identical error actions 88 * and text. 89 */ 90 SSQ_PRINT_SENSE = 0x0800, 91 SSQ_UA = 0x1000, /* Broadcast UA. */ 92 SSQ_RESCAN = 0x2000, /* Rescan target for LUNs. */ 93 SSQ_LOST = 0x4000, /* Destroy the LUNs. */ 94 SSQ_MASK = 0xff00 95 } scsi_sense_action_qualifier; 96 97 /* Mask for error status values */ 98 #define SS_ERRMASK 0xff 99 100 /* The default, retyable, error action */ 101 #define SS_RDEF SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE|EIO 102 103 /* The retyable, error action, with table specified error code */ 104 #define SS_RET SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE 105 106 /* Wait for transient error status to change */ 107 #define SS_WAIT SS_TUR|SSQ_MANY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE 108 109 /* Fatal error action, with table specified error code */ 110 #define SS_FATAL SS_FAIL|SSQ_PRINT_SENSE 111 112 struct scsi_generic 113 { 114 u_int8_t opcode; 115 u_int8_t bytes[11]; 116 }; 117 118 struct scsi_request_sense 119 { 120 u_int8_t opcode; 121 u_int8_t byte2; 122 #define SRS_DESC 0x01 123 u_int8_t unused[2]; 124 u_int8_t length; 125 u_int8_t control; 126 }; 127 128 struct scsi_test_unit_ready 129 { 130 u_int8_t opcode; 131 u_int8_t byte2; 132 u_int8_t unused[3]; 133 u_int8_t control; 134 }; 135 136 struct scsi_receive_diag { 137 uint8_t opcode; 138 uint8_t byte2; 139 #define SRD_PCV 0x01 140 uint8_t page_code; 141 uint8_t length[2]; 142 uint8_t control; 143 }; 144 145 struct scsi_send_diag { 146 uint8_t opcode; 147 uint8_t byte2; 148 #define SSD_UNITOFFL 0x01 149 #define SSD_DEVOFFL 0x02 150 #define SSD_SELFTEST 0x04 151 #define SSD_PF 0x10 152 #define SSD_SELF_TEST_CODE_MASK 0xE0 153 #define SSD_SELF_TEST_CODE_SHIFT 5 154 #define SSD_SELF_TEST_CODE_NONE 0x00 155 #define SSD_SELF_TEST_CODE_BG_SHORT 0x01 156 #define SSD_SELF_TEST_CODE_BG_EXTENDED 0x02 157 #define SSD_SELF_TEST_CODE_BG_ABORT 0x04 158 #define SSD_SELF_TEST_CODE_FG_SHORT 0x05 159 #define SSD_SELF_TEST_CODE_FG_EXTENDED 0x06 160 uint8_t reserved; 161 uint8_t length[2]; 162 uint8_t control; 163 }; 164 165 struct scsi_sense 166 { 167 u_int8_t opcode; 168 u_int8_t byte2; 169 u_int8_t unused[2]; 170 u_int8_t length; 171 u_int8_t control; 172 }; 173 174 struct scsi_inquiry 175 { 176 u_int8_t opcode; 177 u_int8_t byte2; 178 #define SI_EVPD 0x01 179 #define SI_CMDDT 0x02 180 u_int8_t page_code; 181 u_int8_t length[2]; 182 u_int8_t control; 183 }; 184 185 struct scsi_mode_sense_6 186 { 187 u_int8_t opcode; 188 u_int8_t byte2; 189 #define SMS_DBD 0x08 190 u_int8_t page; 191 #define SMS_PAGE_CODE 0x3F 192 #define SMS_VENDOR_SPECIFIC_PAGE 0x00 193 #define SMS_DISCONNECT_RECONNECT_PAGE 0x02 194 #define SMS_FORMAT_DEVICE_PAGE 0x03 195 #define SMS_GEOMETRY_PAGE 0x04 196 #define SMS_CACHE_PAGE 0x08 197 #define SMS_PERIPHERAL_DEVICE_PAGE 0x09 198 #define SMS_CONTROL_MODE_PAGE 0x0A 199 #define SMS_PROTO_SPECIFIC_PAGE 0x19 200 #define SMS_INFO_EXCEPTIONS_PAGE 0x1C 201 #define SMS_ALL_PAGES_PAGE 0x3F 202 #define SMS_PAGE_CTRL_MASK 0xC0 203 #define SMS_PAGE_CTRL_CURRENT 0x00 204 #define SMS_PAGE_CTRL_CHANGEABLE 0x40 205 #define SMS_PAGE_CTRL_DEFAULT 0x80 206 #define SMS_PAGE_CTRL_SAVED 0xC0 207 u_int8_t subpage; 208 #define SMS_SUBPAGE_PAGE_0 0x00 209 #define SMS_SUBPAGE_ALL 0xff 210 u_int8_t length; 211 u_int8_t control; 212 }; 213 214 struct scsi_mode_sense_10 215 { 216 u_int8_t opcode; 217 u_int8_t byte2; /* same bits as small version */ 218 #define SMS10_LLBAA 0x10 219 u_int8_t page; /* same bits as small version */ 220 u_int8_t subpage; 221 u_int8_t unused[3]; 222 u_int8_t length[2]; 223 u_int8_t control; 224 }; 225 226 struct scsi_mode_select_6 227 { 228 u_int8_t opcode; 229 u_int8_t byte2; 230 #define SMS_SP 0x01 231 #define SMS_PF 0x10 232 u_int8_t unused[2]; 233 u_int8_t length; 234 u_int8_t control; 235 }; 236 237 struct scsi_mode_select_10 238 { 239 u_int8_t opcode; 240 u_int8_t byte2; /* same bits as small version */ 241 u_int8_t unused[5]; 242 u_int8_t length[2]; 243 u_int8_t control; 244 }; 245 246 /* 247 * When sending a mode select to a tape drive, the medium type must be 0. 248 */ 249 struct scsi_mode_hdr_6 250 { 251 u_int8_t datalen; 252 u_int8_t medium_type; 253 u_int8_t dev_specific; 254 u_int8_t block_descr_len; 255 }; 256 257 struct scsi_mode_hdr_10 258 { 259 u_int8_t datalen[2]; 260 u_int8_t medium_type; 261 u_int8_t dev_specific; 262 u_int8_t reserved[2]; 263 u_int8_t block_descr_len[2]; 264 }; 265 266 struct scsi_mode_block_descr 267 { 268 u_int8_t density_code; 269 u_int8_t num_blocks[3]; 270 u_int8_t reserved; 271 u_int8_t block_len[3]; 272 }; 273 274 struct scsi_per_res_in 275 { 276 u_int8_t opcode; 277 u_int8_t action; 278 #define SPRI_RK 0x00 279 #define SPRI_RR 0x01 280 #define SPRI_RC 0x02 281 #define SPRI_RS 0x03 282 u_int8_t reserved[5]; 283 u_int8_t length[2]; 284 u_int8_t control; 285 }; 286 287 struct scsi_per_res_in_header 288 { 289 u_int8_t generation[4]; 290 u_int8_t length[4]; 291 }; 292 293 struct scsi_per_res_key 294 { 295 u_int8_t key[8]; 296 }; 297 298 struct scsi_per_res_in_keys 299 { 300 struct scsi_per_res_in_header header; 301 struct scsi_per_res_key keys[0]; 302 }; 303 304 struct scsi_per_res_cap 305 { 306 uint8_t length[2]; 307 uint8_t flags1; 308 #define SPRI_CRH 0x10 309 #define SPRI_SIP_C 0x08 310 #define SPRI_ATP_C 0x04 311 #define SPRI_PTPL_C 0x01 312 uint8_t flags2; 313 #define SPRI_TMV 0x80 314 #define SPRI_PTPL_A 0x01 315 uint8_t type_mask[2]; 316 #define SPRI_TM_WR_EX_AR 0x8000 317 #define SPRI_TM_EX_AC_RO 0x4000 318 #define SPRI_TM_WR_EX_RO 0x2000 319 #define SPRI_TM_EX_AC 0x0800 320 #define SPRI_TM_WR_EX 0x0200 321 #define SPRI_TM_EX_AC_AR 0x0001 322 uint8_t reserved[2]; 323 }; 324 325 struct scsi_per_res_in_rsrv_data 326 { 327 uint8_t reservation[8]; 328 uint8_t obsolete1[4]; 329 uint8_t reserved; 330 uint8_t scopetype; 331 #define SPRT_WE 0x01 332 #define SPRT_EA 0x03 333 #define SPRT_WERO 0x05 334 #define SPRT_EARO 0x06 335 #define SPRT_WEAR 0x07 336 #define SPRT_EAAR 0x08 337 uint8_t obsolete2[2]; 338 }; 339 340 struct scsi_per_res_in_rsrv 341 { 342 struct scsi_per_res_in_header header; 343 struct scsi_per_res_in_rsrv_data data; 344 }; 345 346 struct scsi_per_res_out 347 { 348 u_int8_t opcode; 349 u_int8_t action; 350 #define SPRO_REGISTER 0x00 351 #define SPRO_RESERVE 0x01 352 #define SPRO_RELEASE 0x02 353 #define SPRO_CLEAR 0x03 354 #define SPRO_PREEMPT 0x04 355 #define SPRO_PRE_ABO 0x05 356 #define SPRO_REG_IGNO 0x06 357 #define SPRO_REG_MOVE 0x07 358 #define SPRO_ACTION_MASK 0x1f 359 u_int8_t scope_type; 360 #define SPR_SCOPE_MASK 0xf0 361 #define SPR_LU_SCOPE 0x00 362 #define SPR_TYPE_MASK 0x0f 363 #define SPR_TYPE_WR_EX 0x01 364 #define SPR_TYPE_EX_AC 0x03 365 #define SPR_TYPE_WR_EX_RO 0x05 366 #define SPR_TYPE_EX_AC_RO 0x06 367 #define SPR_TYPE_WR_EX_AR 0x07 368 #define SPR_TYPE_EX_AC_AR 0x08 369 u_int8_t reserved[2]; 370 u_int8_t length[4]; 371 u_int8_t control; 372 }; 373 374 struct scsi_per_res_out_parms 375 { 376 struct scsi_per_res_key res_key; 377 u_int8_t serv_act_res_key[8]; 378 u_int8_t obsolete1[4]; 379 u_int8_t flags; 380 #define SPR_SPEC_I_PT 0x08 381 #define SPR_ALL_TG_PT 0x04 382 #define SPR_APTPL 0x01 383 u_int8_t reserved1; 384 u_int8_t obsolete2[2]; 385 }; 386 387 388 struct scsi_log_sense 389 { 390 u_int8_t opcode; 391 u_int8_t byte2; 392 #define SLS_SP 0x01 393 #define SLS_PPC 0x02 394 u_int8_t page; 395 #define SLS_PAGE_CODE 0x3F 396 #define SLS_ALL_PAGES_PAGE 0x00 397 #define SLS_OVERRUN_PAGE 0x01 398 #define SLS_ERROR_WRITE_PAGE 0x02 399 #define SLS_ERROR_READ_PAGE 0x03 400 #define SLS_ERROR_READREVERSE_PAGE 0x04 401 #define SLS_ERROR_VERIFY_PAGE 0x05 402 #define SLS_ERROR_NONMEDIUM_PAGE 0x06 403 #define SLS_ERROR_LASTN_PAGE 0x07 404 #define SLS_SELF_TEST_PAGE 0x10 405 #define SLS_IE_PAGE 0x2f 406 #define SLS_PAGE_CTRL_MASK 0xC0 407 #define SLS_PAGE_CTRL_THRESHOLD 0x00 408 #define SLS_PAGE_CTRL_CUMULATIVE 0x40 409 #define SLS_PAGE_CTRL_THRESH_DEFAULT 0x80 410 #define SLS_PAGE_CTRL_CUMUL_DEFAULT 0xC0 411 u_int8_t reserved[2]; 412 u_int8_t paramptr[2]; 413 u_int8_t length[2]; 414 u_int8_t control; 415 }; 416 417 struct scsi_log_select 418 { 419 u_int8_t opcode; 420 u_int8_t byte2; 421 /* SLS_SP 0x01 */ 422 #define SLS_PCR 0x02 423 u_int8_t page; 424 /* SLS_PAGE_CTRL_MASK 0xC0 */ 425 /* SLS_PAGE_CTRL_THRESHOLD 0x00 */ 426 /* SLS_PAGE_CTRL_CUMULATIVE 0x40 */ 427 /* SLS_PAGE_CTRL_THRESH_DEFAULT 0x80 */ 428 /* SLS_PAGE_CTRL_CUMUL_DEFAULT 0xC0 */ 429 u_int8_t reserved[4]; 430 u_int8_t length[2]; 431 u_int8_t control; 432 }; 433 434 struct scsi_log_header 435 { 436 u_int8_t page; 437 u_int8_t reserved; 438 u_int8_t datalen[2]; 439 }; 440 441 struct scsi_log_param_header { 442 u_int8_t param_code[2]; 443 u_int8_t param_control; 444 #define SLP_LP 0x01 445 #define SLP_LBIN 0x02 446 #define SLP_TMC_MASK 0x0C 447 #define SLP_TMC_ALWAYS 0x00 448 #define SLP_TMC_EQUAL 0x04 449 #define SLP_TMC_NOTEQUAL 0x08 450 #define SLP_TMC_GREATER 0x0C 451 #define SLP_ETC 0x10 452 #define SLP_TSD 0x20 453 #define SLP_DS 0x40 454 #define SLP_DU 0x80 455 u_int8_t param_len; 456 }; 457 458 struct scsi_control_page { 459 u_int8_t page_code; 460 u_int8_t page_length; 461 u_int8_t rlec; 462 #define SCP_RLEC 0x01 /*Report Log Exception Cond*/ 463 #define SCP_GLTSD 0x02 /*Global Logging target 464 save disable */ 465 #define SCP_DSENSE 0x04 /*Descriptor Sense */ 466 #define SCP_DPICZ 0x08 /*Disable Prot. Info Check 467 if Prot. Field is Zero */ 468 #define SCP_TMF_ONLY 0x10 /*TM Functions Only*/ 469 #define SCP_TST_MASK 0xE0 /*Task Set Type Mask*/ 470 #define SCP_TST_ONE 0x00 /*One Task Set*/ 471 #define SCP_TST_SEPARATE 0x20 /*Separate Task Sets*/ 472 u_int8_t queue_flags; 473 #define SCP_QUEUE_ALG_MASK 0xF0 474 #define SCP_QUEUE_ALG_RESTRICTED 0x00 475 #define SCP_QUEUE_ALG_UNRESTRICTED 0x10 476 #define SCP_QUEUE_ERR 0x02 /*Queued I/O aborted for CACs*/ 477 #define SCP_QUEUE_DQUE 0x01 /*Queued I/O disabled*/ 478 u_int8_t eca_and_aen; 479 #define SCP_EECA 0x80 /*Enable Extended CA*/ 480 #define SCP_RAENP 0x04 /*Ready AEN Permission*/ 481 #define SCP_UAAENP 0x02 /*UA AEN Permission*/ 482 #define SCP_EAENP 0x01 /*Error AEN Permission*/ 483 u_int8_t reserved; 484 u_int8_t aen_holdoff_period[2]; 485 }; 486 487 struct scsi_cache_page { 488 u_int8_t page_code; 489 #define SCHP_PAGE_SAVABLE 0x80 /* Page is savable */ 490 u_int8_t page_length; 491 u_int8_t cache_flags; 492 #define SCHP_FLAGS_WCE 0x04 /* Write Cache Enable */ 493 #define SCHP_FLAGS_MF 0x02 /* Multiplication factor */ 494 #define SCHP_FLAGS_RCD 0x01 /* Read Cache Disable */ 495 u_int8_t rw_cache_policy; 496 u_int8_t dis_prefetch[2]; 497 u_int8_t min_prefetch[2]; 498 u_int8_t max_prefetch[2]; 499 u_int8_t max_prefetch_ceil[2]; 500 }; 501 502 /* 503 * XXX KDM 504 * Updated version of the cache page, as of SBC. Update this to SBC-3 and 505 * rationalize the two. 506 */ 507 struct scsi_caching_page { 508 uint8_t page_code; 509 #define SMS_CACHING_PAGE 0x08 510 uint8_t page_length; 511 uint8_t flags1; 512 #define SCP_IC 0x80 513 #define SCP_ABPF 0x40 514 #define SCP_CAP 0x20 515 #define SCP_DISC 0x10 516 #define SCP_SIZE 0x08 517 #define SCP_WCE 0x04 518 #define SCP_MF 0x02 519 #define SCP_RCD 0x01 520 uint8_t ret_priority; 521 uint8_t disable_pf_transfer_len[2]; 522 uint8_t min_prefetch[2]; 523 uint8_t max_prefetch[2]; 524 uint8_t max_pf_ceiling[2]; 525 uint8_t flags2; 526 #define SCP_FSW 0x80 527 #define SCP_LBCSS 0x40 528 #define SCP_DRA 0x20 529 #define SCP_VS1 0x10 530 #define SCP_VS2 0x08 531 uint8_t cache_segments; 532 uint8_t cache_seg_size[2]; 533 uint8_t reserved; 534 uint8_t non_cache_seg_size[3]; 535 }; 536 537 /* 538 * XXX KDM move this off to a vendor shim. 539 */ 540 struct copan_power_subpage { 541 uint8_t page_code; 542 #define PWR_PAGE_CODE 0x00 543 uint8_t subpage; 544 #define PWR_SUBPAGE_CODE 0x02 545 uint8_t page_length[2]; 546 uint8_t page_version; 547 #define PWR_VERSION 0x01 548 uint8_t total_luns; 549 uint8_t max_active_luns; 550 #define PWR_DFLT_MAX_LUNS 0x07 551 uint8_t reserved[25]; 552 }; 553 554 /* 555 * XXX KDM move this off to a vendor shim. 556 */ 557 struct copan_aps_subpage { 558 uint8_t page_code; 559 #define APS_PAGE_CODE 0x00 560 uint8_t subpage; 561 #define APS_SUBPAGE_CODE 0x03 562 uint8_t page_length[2]; 563 uint8_t page_version; 564 #define APS_VERSION 0x00 565 uint8_t lock_active; 566 #define APS_LOCK_ACTIVE 0x01 567 #define APS_LOCK_INACTIVE 0x00 568 uint8_t reserved[26]; 569 }; 570 571 /* 572 * XXX KDM move this off to a vendor shim. 573 */ 574 struct copan_debugconf_subpage { 575 uint8_t page_code; 576 #define DBGCNF_PAGE_CODE 0x00 577 uint8_t subpage; 578 #define DBGCNF_SUBPAGE_CODE 0xF0 579 uint8_t page_length[2]; 580 uint8_t page_version; 581 #define DBGCNF_VERSION 0x00 582 uint8_t ctl_time_io_secs[2]; 583 }; 584 585 586 struct scsi_info_exceptions_page { 587 u_int8_t page_code; 588 #define SIEP_PAGE_SAVABLE 0x80 /* Page is savable */ 589 u_int8_t page_length; 590 u_int8_t info_flags; 591 #define SIEP_FLAGS_PERF 0x80 592 #define SIEP_FLAGS_EBF 0x20 593 #define SIEP_FLAGS_EWASC 0x10 594 #define SIEP_FLAGS_DEXCPT 0x08 595 #define SIEP_FLAGS_TEST 0x04 596 #define SIEP_FLAGS_EBACKERR 0x02 597 #define SIEP_FLAGS_LOGERR 0x01 598 u_int8_t mrie; 599 u_int8_t interval_timer[4]; 600 u_int8_t report_count[4]; 601 }; 602 603 struct scsi_proto_specific_page { 604 u_int8_t page_code; 605 #define SPSP_PAGE_SAVABLE 0x80 /* Page is savable */ 606 u_int8_t page_length; 607 u_int8_t protocol; 608 #define SPSP_PROTO_FC 0x00 609 #define SPSP_PROTO_SPI 0x01 610 #define SPSP_PROTO_SSA 0x02 611 #define SPSP_PROTO_1394 0x03 612 #define SPSP_PROTO_RDMA 0x04 613 #define SPSP_PROTO_ISCSI 0x05 614 #define SPSP_PROTO_SAS 0x06 615 #define SPSP_PROTO_ADT 0x07 616 #define SPSP_PROTO_ATA 0x08 617 #define SPSP_PROTO_NONE 0x0f 618 }; 619 620 struct scsi_reserve 621 { 622 u_int8_t opcode; 623 u_int8_t byte2; 624 #define SR_EXTENT 0x01 625 #define SR_ID_MASK 0x0e 626 #define SR_3RDPTY 0x10 627 #define SR_LUN_MASK 0xe0 628 u_int8_t resv_id; 629 u_int8_t length[2]; 630 u_int8_t control; 631 }; 632 633 struct scsi_reserve_10 { 634 uint8_t opcode; 635 uint8_t byte2; 636 #define SR10_3RDPTY 0x10 637 #define SR10_LONGID 0x02 638 #define SR10_EXTENT 0x01 639 uint8_t resv_id; 640 uint8_t thirdparty_id; 641 uint8_t reserved[3]; 642 uint8_t length[2]; 643 uint8_t control; 644 }; 645 646 647 struct scsi_release 648 { 649 u_int8_t opcode; 650 u_int8_t byte2; 651 u_int8_t resv_id; 652 u_int8_t unused[1]; 653 u_int8_t length; 654 u_int8_t control; 655 }; 656 657 struct scsi_release_10 { 658 uint8_t opcode; 659 uint8_t byte2; 660 uint8_t resv_id; 661 uint8_t thirdparty_id; 662 uint8_t reserved[3]; 663 uint8_t length[2]; 664 uint8_t control; 665 }; 666 667 struct scsi_prevent 668 { 669 u_int8_t opcode; 670 u_int8_t byte2; 671 u_int8_t unused[2]; 672 u_int8_t how; 673 u_int8_t control; 674 }; 675 #define PR_PREVENT 0x01 676 #define PR_ALLOW 0x00 677 678 struct scsi_sync_cache 679 { 680 u_int8_t opcode; 681 u_int8_t byte2; 682 #define SSC_IMMED 0x02 683 #define SSC_RELADR 0x01 684 u_int8_t begin_lba[4]; 685 u_int8_t reserved; 686 u_int8_t lb_count[2]; 687 u_int8_t control; 688 }; 689 690 struct scsi_sync_cache_16 691 { 692 uint8_t opcode; 693 uint8_t byte2; 694 uint8_t begin_lba[8]; 695 uint8_t lb_count[4]; 696 uint8_t reserved; 697 uint8_t control; 698 }; 699 700 struct scsi_format { 701 uint8_t opcode; 702 uint8_t byte2; 703 #define SF_LONGLIST 0x20 704 #define SF_FMTDATA 0x10 705 #define SF_CMPLIST 0x08 706 #define SF_FORMAT_MASK 0x07 707 #define SF_FORMAT_BLOCK 0x00 708 #define SF_FORMAT_LONG_BLOCK 0x03 709 #define SF_FORMAT_BFI 0x04 710 #define SF_FORMAT_PHYS 0x05 711 uint8_t vendor; 712 uint8_t interleave[2]; 713 uint8_t control; 714 }; 715 716 struct scsi_format_header_short { 717 uint8_t reserved; 718 #define SF_DATA_FOV 0x80 719 #define SF_DATA_DPRY 0x40 720 #define SF_DATA_DCRT 0x20 721 #define SF_DATA_STPF 0x10 722 #define SF_DATA_IP 0x08 723 #define SF_DATA_DSP 0x04 724 #define SF_DATA_IMMED 0x02 725 #define SF_DATA_VS 0x01 726 uint8_t byte2; 727 uint8_t defect_list_len[2]; 728 }; 729 730 struct scsi_format_header_long { 731 uint8_t reserved; 732 uint8_t byte2; 733 uint8_t reserved2[2]; 734 uint8_t defect_list_len[4]; 735 }; 736 737 struct scsi_changedef 738 { 739 u_int8_t opcode; 740 u_int8_t byte2; 741 u_int8_t unused1; 742 u_int8_t how; 743 u_int8_t unused[4]; 744 u_int8_t datalen; 745 u_int8_t control; 746 }; 747 748 struct scsi_read_buffer 749 { 750 u_int8_t opcode; 751 u_int8_t byte2; 752 #define RWB_MODE 0x07 753 #define RWB_MODE_HDR_DATA 0x00 754 #define RWB_MODE_VENDOR 0x01 755 #define RWB_MODE_DATA 0x02 756 #define RWB_MODE_DOWNLOAD 0x04 757 #define RWB_MODE_DOWNLOAD_SAVE 0x05 758 u_int8_t buffer_id; 759 u_int8_t offset[3]; 760 u_int8_t length[3]; 761 u_int8_t control; 762 }; 763 764 struct scsi_write_buffer 765 { 766 u_int8_t opcode; 767 u_int8_t byte2; 768 u_int8_t buffer_id; 769 u_int8_t offset[3]; 770 u_int8_t length[3]; 771 u_int8_t control; 772 }; 773 774 struct scsi_rw_6 775 { 776 u_int8_t opcode; 777 u_int8_t addr[3]; 778 /* only 5 bits are valid in the MSB address byte */ 779 #define SRW_TOPADDR 0x1F 780 u_int8_t length; 781 u_int8_t control; 782 }; 783 784 struct scsi_rw_10 785 { 786 u_int8_t opcode; 787 #define SRW10_RELADDR 0x01 788 /* EBP defined for WRITE(10) only */ 789 #define SRW10_EBP 0x04 790 #define SRW10_FUA 0x08 791 #define SRW10_DPO 0x10 792 u_int8_t byte2; 793 u_int8_t addr[4]; 794 u_int8_t reserved; 795 u_int8_t length[2]; 796 u_int8_t control; 797 }; 798 799 struct scsi_rw_12 800 { 801 u_int8_t opcode; 802 #define SRW12_RELADDR 0x01 803 #define SRW12_FUA 0x08 804 #define SRW12_DPO 0x10 805 u_int8_t byte2; 806 u_int8_t addr[4]; 807 u_int8_t length[4]; 808 u_int8_t reserved; 809 u_int8_t control; 810 }; 811 812 struct scsi_rw_16 813 { 814 u_int8_t opcode; 815 #define SRW16_RELADDR 0x01 816 #define SRW16_FUA 0x08 817 #define SRW16_DPO 0x10 818 u_int8_t byte2; 819 u_int8_t addr[8]; 820 u_int8_t length[4]; 821 u_int8_t reserved; 822 u_int8_t control; 823 }; 824 825 struct scsi_write_same_10 826 { 827 uint8_t opcode; 828 uint8_t byte2; 829 #define SWS_LBDATA 0x02 830 #define SWS_PBDATA 0x04 831 #define SWS_UNMAP 0x08 832 #define SWS_ANCHOR 0x10 833 uint8_t addr[4]; 834 uint8_t group; 835 uint8_t length[2]; 836 uint8_t control; 837 }; 838 839 struct scsi_write_same_16 840 { 841 uint8_t opcode; 842 uint8_t byte2; 843 uint8_t addr[8]; 844 uint8_t length[4]; 845 uint8_t group; 846 uint8_t control; 847 }; 848 849 struct scsi_unmap 850 { 851 uint8_t opcode; 852 uint8_t byte2; 853 #define SU_ANCHOR 0x01 854 uint8_t reserved[4]; 855 uint8_t group; 856 uint8_t length[2]; 857 uint8_t control; 858 }; 859 860 struct scsi_write_verify_10 861 { 862 uint8_t opcode; 863 uint8_t byte2; 864 #define SWV_BYTCHK 0x02 865 #define SWV_DPO 0x10 866 #define SWV_WRPROECT_MASK 0xe0 867 uint8_t addr[4]; 868 uint8_t group; 869 uint8_t length[2]; 870 uint8_t control; 871 }; 872 873 struct scsi_write_verify_12 874 { 875 uint8_t opcode; 876 uint8_t byte2; 877 uint8_t addr[4]; 878 uint8_t length[4]; 879 uint8_t group; 880 uint8_t control; 881 }; 882 883 struct scsi_write_verify_16 884 { 885 uint8_t opcode; 886 uint8_t byte2; 887 uint8_t addr[8]; 888 uint8_t length[4]; 889 uint8_t group; 890 uint8_t control; 891 }; 892 893 894 struct scsi_start_stop_unit 895 { 896 u_int8_t opcode; 897 u_int8_t byte2; 898 #define SSS_IMMED 0x01 899 u_int8_t reserved[2]; 900 u_int8_t how; 901 #define SSS_START 0x01 902 #define SSS_LOEJ 0x02 903 #define SSS_PC_MASK 0xf0 904 #define SSS_PC_START_VALID 0x00 905 #define SSS_PC_ACTIVE 0x10 906 #define SSS_PC_IDLE 0x20 907 #define SSS_PC_STANDBY 0x30 908 #define SSS_PC_LU_CONTROL 0x70 909 #define SSS_PC_FORCE_IDLE_0 0xa0 910 #define SSS_PC_FORCE_STANDBY_0 0xb0 911 u_int8_t control; 912 }; 913 914 struct ata_pass_12 { 915 u_int8_t opcode; 916 u_int8_t protocol; 917 #define AP_PROTO_HARD_RESET (0x00 << 1) 918 #define AP_PROTO_SRST (0x01 << 1) 919 #define AP_PROTO_NON_DATA (0x03 << 1) 920 #define AP_PROTO_PIO_IN (0x04 << 1) 921 #define AP_PROTO_PIO_OUT (0x05 << 1) 922 #define AP_PROTO_DMA (0x06 << 1) 923 #define AP_PROTO_DMA_QUEUED (0x07 << 1) 924 #define AP_PROTO_DEVICE_DIAG (0x08 << 1) 925 #define AP_PROTO_DEVICE_RESET (0x09 << 1) 926 #define AP_PROTO_UDMA_IN (0x0a << 1) 927 #define AP_PROTO_UDMA_OUT (0x0b << 1) 928 #define AP_PROTO_FPDMA (0x0c << 1) 929 #define AP_PROTO_RESP_INFO (0x0f << 1) 930 #define AP_MULTI 0xe0 931 u_int8_t flags; 932 #define AP_T_LEN 0x03 933 #define AP_BB 0x04 934 #define AP_T_DIR 0x08 935 #define AP_CK_COND 0x20 936 #define AP_OFFLINE 0x60 937 u_int8_t features; 938 u_int8_t sector_count; 939 u_int8_t lba_low; 940 u_int8_t lba_mid; 941 u_int8_t lba_high; 942 u_int8_t device; 943 u_int8_t command; 944 u_int8_t reserved; 945 u_int8_t control; 946 }; 947 948 struct scsi_maintenance_in 949 { 950 uint8_t opcode; 951 uint8_t byte2; 952 #define SERVICE_ACTION_MASK 0x1f 953 #define SA_RPRT_TRGT_GRP 0x0a 954 uint8_t reserved[4]; 955 uint8_t length[4]; 956 uint8_t reserved1; 957 uint8_t control; 958 }; 959 960 struct ata_pass_16 { 961 u_int8_t opcode; 962 u_int8_t protocol; 963 #define AP_EXTEND 0x01 964 u_int8_t flags; 965 #define AP_FLAG_TLEN_NO_DATA (0 << 0) 966 #define AP_FLAG_TLEN_FEAT (1 << 0) 967 #define AP_FLAG_TLEN_SECT_CNT (2 << 0) 968 #define AP_FLAG_TLEN_STPSIU (3 << 0) 969 #define AP_FLAG_BYT_BLOK_BYTES (0 << 2) 970 #define AP_FLAG_BYT_BLOK_BLOCKS (1 << 2) 971 #define AP_FLAG_TDIR_TO_DEV (0 << 3) 972 #define AP_FLAG_TDIR_FROM_DEV (1 << 3) 973 #define AP_FLAG_CHK_COND (1 << 5) 974 u_int8_t features_ext; 975 u_int8_t features; 976 u_int8_t sector_count_ext; 977 u_int8_t sector_count; 978 u_int8_t lba_low_ext; 979 u_int8_t lba_low; 980 u_int8_t lba_mid_ext; 981 u_int8_t lba_mid; 982 u_int8_t lba_high_ext; 983 u_int8_t lba_high; 984 u_int8_t device; 985 u_int8_t command; 986 u_int8_t control; 987 }; 988 989 #define SC_SCSI_1 0x01 990 #define SC_SCSI_2 0x03 991 992 /* 993 * Opcodes 994 */ 995 996 #define TEST_UNIT_READY 0x00 997 #define REQUEST_SENSE 0x03 998 #define READ_6 0x08 999 #define WRITE_6 0x0A 1000 #define INQUIRY 0x12 1001 #define MODE_SELECT_6 0x15 1002 #define MODE_SENSE_6 0x1A 1003 #define START_STOP_UNIT 0x1B 1004 #define START_STOP 0x1B 1005 #define RESERVE 0x16 1006 #define RELEASE 0x17 1007 #define RECEIVE_DIAGNOSTIC 0x1C 1008 #define SEND_DIAGNOSTIC 0x1D 1009 #define PREVENT_ALLOW 0x1E 1010 #define READ_CAPACITY 0x25 1011 #define READ_10 0x28 1012 #define WRITE_10 0x2A 1013 #define POSITION_TO_ELEMENT 0x2B 1014 #define WRITE_VERIFY_10 0x2E 1015 #define VERIFY_10 0x2F 1016 #define SYNCHRONIZE_CACHE 0x35 1017 #define READ_DEFECT_DATA_10 0x37 1018 #define WRITE_BUFFER 0x3B 1019 #define READ_BUFFER 0x3C 1020 #define CHANGE_DEFINITION 0x40 1021 #define WRITE_SAME_10 0x41 1022 #define UNMAP 0x42 1023 #define LOG_SELECT 0x4C 1024 #define LOG_SENSE 0x4D 1025 #define MODE_SELECT_10 0x55 1026 #define RESERVE_10 0x56 1027 #define RELEASE_10 0x57 1028 #define MODE_SENSE_10 0x5A 1029 #define PERSISTENT_RES_IN 0x5E 1030 #define PERSISTENT_RES_OUT 0x5F 1031 #define ATA_PASS_16 0x85 1032 #define READ_16 0x88 1033 #define WRITE_16 0x8A 1034 #define WRITE_VERIFY_16 0x8E 1035 #define SYNCHRONIZE_CACHE_16 0x91 1036 #define WRITE_SAME_16 0x93 1037 #define SERVICE_ACTION_IN 0x9E 1038 #define REPORT_LUNS 0xA0 1039 #define ATA_PASS_12 0xA1 1040 #define MAINTENANCE_IN 0xA3 1041 #define MAINTENANCE_OUT 0xA4 1042 #define MOVE_MEDIUM 0xA5 1043 #define READ_12 0xA8 1044 #define WRITE_12 0xAA 1045 #define WRITE_VERIFY_12 0xAE 1046 #define READ_ELEMENT_STATUS 0xB8 1047 #define READ_CD 0xBE 1048 1049 /* Maintenance In Service Action Codes */ 1050 #define REPORT_IDENTIFYING_INFRMATION 0x05 1051 #define REPORT_TARGET_PORT_GROUPS 0x0A 1052 #define REPORT_ALIASES 0x0B 1053 #define REPORT_SUPPORTED_OPERATION_CODES 0x0C 1054 #define REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS 0x0D 1055 #define REPORT_PRIORITY 0x0E 1056 #define REPORT_TIMESTAMP 0x0F 1057 #define MANAGEMENT_PROTOCOL_IN 0x10 1058 /* Maintenance Out Service Action Codes */ 1059 #define SET_IDENTIFY_INFORMATION 0x06 1060 #define SET_TARGET_PORT_GROUPS 0x0A 1061 #define CHANGE_ALIASES 0x0B 1062 #define SET_PRIORITY 0x0E 1063 #define SET_TIMESTAMP 0x0F 1064 #define MANGAEMENT_PROTOCOL_OUT 0x10 1065 1066 /* 1067 * Device Types 1068 */ 1069 #define T_DIRECT 0x00 1070 #define T_SEQUENTIAL 0x01 1071 #define T_PRINTER 0x02 1072 #define T_PROCESSOR 0x03 1073 #define T_WORM 0x04 1074 #define T_CDROM 0x05 1075 #define T_SCANNER 0x06 1076 #define T_OPTICAL 0x07 1077 #define T_CHANGER 0x08 1078 #define T_COMM 0x09 1079 #define T_ASC0 0x0a 1080 #define T_ASC1 0x0b 1081 #define T_STORARRAY 0x0c 1082 #define T_ENCLOSURE 0x0d 1083 #define T_RBC 0x0e 1084 #define T_OCRW 0x0f 1085 #define T_OSD 0x11 1086 #define T_ADC 0x12 1087 #define T_NODEVICE 0x1f 1088 #define T_ANY 0xff /* Used in Quirk table matches */ 1089 1090 #define T_REMOV 1 1091 #define T_FIXED 0 1092 1093 /* 1094 * This length is the initial inquiry length used by the probe code, as 1095 * well as the length necessary for scsi_print_inquiry() to function 1096 * correctly. If either use requires a different length in the future, 1097 * the two values should be de-coupled. 1098 */ 1099 #define SHORT_INQUIRY_LENGTH 36 1100 1101 struct scsi_inquiry_data 1102 { 1103 u_int8_t device; 1104 #define SID_TYPE(inq_data) ((inq_data)->device & 0x1f) 1105 #define SID_QUAL(inq_data) (((inq_data)->device & 0xE0) >> 5) 1106 #define SID_QUAL_LU_CONNECTED 0x00 /* 1107 * The specified peripheral device 1108 * type is currently connected to 1109 * logical unit. If the target cannot 1110 * determine whether or not a physical 1111 * device is currently connected, it 1112 * shall also use this peripheral 1113 * qualifier when returning the INQUIRY 1114 * data. This peripheral qualifier 1115 * does not mean that the device is 1116 * ready for access by the initiator. 1117 */ 1118 #define SID_QUAL_LU_OFFLINE 0x01 /* 1119 * The target is capable of supporting 1120 * the specified peripheral device type 1121 * on this logical unit; however, the 1122 * physical device is not currently 1123 * connected to this logical unit. 1124 */ 1125 #define SID_QUAL_RSVD 0x02 1126 #define SID_QUAL_BAD_LU 0x03 /* 1127 * The target is not capable of 1128 * supporting a physical device on 1129 * this logical unit. For this 1130 * peripheral qualifier the peripheral 1131 * device type shall be set to 1Fh to 1132 * provide compatibility with previous 1133 * versions of SCSI. All other 1134 * peripheral device type values are 1135 * reserved for this peripheral 1136 * qualifier. 1137 */ 1138 #define SID_QUAL_IS_VENDOR_UNIQUE(inq_data) ((SID_QUAL(inq_data) & 0x04) != 0) 1139 u_int8_t dev_qual2; 1140 #define SID_QUAL2 0x7F 1141 #define SID_IS_REMOVABLE(inq_data) (((inq_data)->dev_qual2 & 0x80) != 0) 1142 u_int8_t version; 1143 #define SID_ANSI_REV(inq_data) ((inq_data)->version & 0x07) 1144 #define SCSI_REV_0 0 1145 #define SCSI_REV_CCS 1 1146 #define SCSI_REV_2 2 1147 #define SCSI_REV_SPC 3 1148 #define SCSI_REV_SPC2 4 1149 #define SCSI_REV_SPC3 5 1150 #define SCSI_REV_SPC4 6 1151 1152 #define SID_ECMA 0x38 1153 #define SID_ISO 0xC0 1154 u_int8_t response_format; 1155 #define SID_AENC 0x80 1156 #define SID_TrmIOP 0x40 1157 #define SID_NormACA 0x20 1158 #define SID_HiSup 0x10 1159 u_int8_t additional_length; 1160 #define SID_ADDITIONAL_LENGTH(iqd) \ 1161 ((iqd)->additional_length + \ 1162 __offsetof(struct scsi_inquiry_data, additional_length) + 1) 1163 u_int8_t spc3_flags; 1164 #define SPC3_SID_PROTECT 0x01 1165 #define SPC3_SID_3PC 0x08 1166 #define SPC3_SID_TPGS_MASK 0x30 1167 #define SPC3_SID_TPGS_IMPLICIT 0x10 1168 #define SPC3_SID_TPGS_EXPLICIT 0x20 1169 #define SPC3_SID_ACC 0x40 1170 #define SPC3_SID_SCCS 0x80 1171 u_int8_t spc2_flags; 1172 #define SPC2_SID_ADDR16 0x01 1173 #define SPC2_SID_MChngr 0x08 1174 #define SPC2_SID_MultiP 0x10 1175 #define SPC2_SID_EncServ 0x40 1176 #define SPC2_SID_BQueue 0x80 1177 1178 #define INQ_DATA_TQ_ENABLED(iqd) \ 1179 ((SID_ANSI_REV(iqd) < SCSI_REV_SPC2)? ((iqd)->flags & SID_CmdQue) : \ 1180 (((iqd)->flags & SID_CmdQue) && !((iqd)->spc2_flags & SPC2_SID_BQueue)) || \ 1181 (!((iqd)->flags & SID_CmdQue) && ((iqd)->spc2_flags & SPC2_SID_BQueue))) 1182 1183 u_int8_t flags; 1184 #define SID_SftRe 0x01 1185 #define SID_CmdQue 0x02 1186 #define SID_Linked 0x08 1187 #define SID_Sync 0x10 1188 #define SID_WBus16 0x20 1189 #define SID_WBus32 0x40 1190 #define SID_RelAdr 0x80 1191 #define SID_VENDOR_SIZE 8 1192 char vendor[SID_VENDOR_SIZE]; 1193 #define SID_PRODUCT_SIZE 16 1194 char product[SID_PRODUCT_SIZE]; 1195 #define SID_REVISION_SIZE 4 1196 char revision[SID_REVISION_SIZE]; 1197 /* 1198 * The following fields were taken from SCSI Primary Commands - 2 1199 * (SPC-2) Revision 14, Dated 11 November 1999 1200 */ 1201 #define SID_VENDOR_SPECIFIC_0_SIZE 20 1202 u_int8_t vendor_specific0[SID_VENDOR_SPECIFIC_0_SIZE]; 1203 /* 1204 * An extension of SCSI Parallel Specific Values 1205 */ 1206 #define SID_SPI_IUS 0x01 1207 #define SID_SPI_QAS 0x02 1208 #define SID_SPI_CLOCK_ST 0x00 1209 #define SID_SPI_CLOCK_DT 0x04 1210 #define SID_SPI_CLOCK_DT_ST 0x0C 1211 #define SID_SPI_MASK 0x0F 1212 u_int8_t spi3data; 1213 u_int8_t reserved2; 1214 /* 1215 * Version Descriptors, stored 2 byte values. 1216 */ 1217 u_int8_t version1[2]; 1218 u_int8_t version2[2]; 1219 u_int8_t version3[2]; 1220 u_int8_t version4[2]; 1221 u_int8_t version5[2]; 1222 u_int8_t version6[2]; 1223 u_int8_t version7[2]; 1224 u_int8_t version8[2]; 1225 1226 u_int8_t reserved3[22]; 1227 1228 #define SID_VENDOR_SPECIFIC_1_SIZE 160 1229 u_int8_t vendor_specific1[SID_VENDOR_SPECIFIC_1_SIZE]; 1230 }; 1231 1232 /* 1233 * This structure is more suited to initiator operation, because the 1234 * maximum number of supported pages is already allocated. 1235 */ 1236 struct scsi_vpd_supported_page_list 1237 { 1238 u_int8_t device; 1239 u_int8_t page_code; 1240 #define SVPD_SUPPORTED_PAGE_LIST 0x00 1241 #define SVPD_SUPPORTED_PAGES_HDR_LEN 4 1242 u_int8_t reserved; 1243 u_int8_t length; /* number of VPD entries */ 1244 #define SVPD_SUPPORTED_PAGES_SIZE 251 1245 u_int8_t list[SVPD_SUPPORTED_PAGES_SIZE]; 1246 }; 1247 1248 /* 1249 * This structure is more suited to target operation, because the 1250 * number of supported pages is left to the user to allocate. 1251 */ 1252 struct scsi_vpd_supported_pages 1253 { 1254 u_int8_t device; 1255 u_int8_t page_code; 1256 u_int8_t reserved; 1257 #define SVPD_SUPPORTED_PAGES 0x00 1258 u_int8_t length; 1259 u_int8_t page_list[0]; 1260 }; 1261 1262 1263 struct scsi_vpd_unit_serial_number 1264 { 1265 u_int8_t device; 1266 u_int8_t page_code; 1267 #define SVPD_UNIT_SERIAL_NUMBER 0x80 1268 u_int8_t reserved; 1269 u_int8_t length; /* serial number length */ 1270 #define SVPD_SERIAL_NUM_SIZE 251 1271 u_int8_t serial_num[SVPD_SERIAL_NUM_SIZE]; 1272 }; 1273 1274 struct scsi_vpd_device_id 1275 { 1276 u_int8_t device; 1277 u_int8_t page_code; 1278 #define SVPD_DEVICE_ID 0x83 1279 #define SVPD_DEVICE_ID_MAX_SIZE 252 1280 #define SVPD_DEVICE_ID_HDR_LEN \ 1281 __offsetof(struct scsi_vpd_device_id, desc_list) 1282 u_int8_t length[2]; 1283 u_int8_t desc_list[]; 1284 }; 1285 1286 struct scsi_vpd_id_descriptor 1287 { 1288 u_int8_t proto_codeset; 1289 #define SCSI_PROTO_FC 0x00 1290 #define SCSI_PROTO_SPI 0x01 1291 #define SCSI_PROTO_SSA 0x02 1292 #define SCSI_PROTO_1394 0x03 1293 #define SCSI_PROTO_RDMA 0x04 1294 #define SCSI_PROTO_iSCSI 0x05 1295 #define SCSI_PROTO_SAS 0x06 1296 #define SCSI_PROTO_ADT 0x07 1297 #define SCSI_PROTO_ATA 0x08 1298 #define SVPD_ID_PROTO_SHIFT 4 1299 #define SVPD_ID_CODESET_BINARY 0x01 1300 #define SVPD_ID_CODESET_ASCII 0x02 1301 #define SVPD_ID_CODESET_UTF8 0x03 1302 #define SVPD_ID_CODESET_MASK 0x0f 1303 u_int8_t id_type; 1304 #define SVPD_ID_PIV 0x80 1305 #define SVPD_ID_ASSOC_LUN 0x00 1306 #define SVPD_ID_ASSOC_PORT 0x10 1307 #define SVPD_ID_ASSOC_TARGET 0x20 1308 #define SVPD_ID_ASSOC_MASK 0x30 1309 #define SVPD_ID_TYPE_VENDOR 0x00 1310 #define SVPD_ID_TYPE_T10 0x01 1311 #define SVPD_ID_TYPE_EUI64 0x02 1312 #define SVPD_ID_TYPE_NAA 0x03 1313 #define SVPD_ID_TYPE_RELTARG 0x04 1314 #define SVPD_ID_TYPE_TPORTGRP 0x05 1315 #define SVPD_ID_TYPE_LUNGRP 0x06 1316 #define SVPD_ID_TYPE_MD5_LUN_ID 0x07 1317 #define SVPD_ID_TYPE_SCSI_NAME 0x08 1318 #define SVPD_ID_TYPE_MASK 0x0f 1319 u_int8_t reserved; 1320 u_int8_t length; 1321 #define SVPD_DEVICE_ID_DESC_HDR_LEN \ 1322 __offsetof(struct scsi_vpd_id_descriptor, identifier) 1323 u_int8_t identifier[]; 1324 }; 1325 1326 struct scsi_vpd_id_t10 1327 { 1328 u_int8_t vendor[8]; 1329 u_int8_t vendor_spec_id[0]; 1330 }; 1331 1332 struct scsi_vpd_id_eui64 1333 { 1334 u_int8_t ieee_company_id[3]; 1335 u_int8_t extension_id[5]; 1336 }; 1337 1338 struct scsi_vpd_id_naa_basic 1339 { 1340 uint8_t naa; 1341 /* big endian, packed: 1342 uint8_t naa : 4; 1343 uint8_t naa_desig : 4; 1344 */ 1345 #define SVPD_ID_NAA_NAA_SHIFT 4 1346 #define SVPD_ID_NAA_IEEE_EXT 0x02 1347 #define SVPD_ID_NAA_LOCAL_REG 0x03 1348 #define SVPD_ID_NAA_IEEE_REG 0x05 1349 #define SVPD_ID_NAA_IEEE_REG_EXT 0x06 1350 uint8_t naa_data[]; 1351 }; 1352 1353 struct scsi_vpd_id_naa_ieee_extended_id 1354 { 1355 uint8_t naa; 1356 uint8_t vendor_specific_id_a; 1357 uint8_t ieee_company_id[3]; 1358 uint8_t vendor_specific_id_b[4]; 1359 }; 1360 1361 struct scsi_vpd_id_naa_local_reg 1362 { 1363 uint8_t naa; 1364 uint8_t local_value[7]; 1365 }; 1366 1367 struct scsi_vpd_id_naa_ieee_reg 1368 { 1369 uint8_t naa; 1370 uint8_t reg_value[7]; 1371 /* big endian, packed: 1372 uint8_t naa_basic : 4; 1373 uint8_t ieee_company_id_0 : 4; 1374 uint8_t ieee_company_id_1[2]; 1375 uint8_t ieee_company_id_2 : 4; 1376 uint8_t vendor_specific_id_0 : 4; 1377 uint8_t vendor_specific_id_1[4]; 1378 */ 1379 }; 1380 1381 struct scsi_vpd_id_naa_ieee_reg_extended 1382 { 1383 uint8_t naa; 1384 uint8_t reg_value[15]; 1385 /* big endian, packed: 1386 uint8_t naa_basic : 4; 1387 uint8_t ieee_company_id_0 : 4; 1388 uint8_t ieee_company_id_1[2]; 1389 uint8_t ieee_company_id_2 : 4; 1390 uint8_t vendor_specific_id_0 : 4; 1391 uint8_t vendor_specific_id_1[4]; 1392 uint8_t vendor_specific_id_ext[8]; 1393 */ 1394 }; 1395 1396 struct scsi_vpd_id_rel_trgt_port_id 1397 { 1398 uint8_t obsolete[2]; 1399 uint8_t rel_trgt_port_id[2]; 1400 }; 1401 1402 struct scsi_vpd_id_trgt_port_grp_id 1403 { 1404 uint8_t reserved[2]; 1405 uint8_t trgt_port_grp[2]; 1406 }; 1407 1408 struct scsi_vpd_id_lun_grp_id 1409 { 1410 uint8_t reserved[2]; 1411 uint8_t log_unit_grp[2]; 1412 }; 1413 1414 struct scsi_vpd_id_md5_lun_id 1415 { 1416 uint8_t lun_id[16]; 1417 }; 1418 1419 struct scsi_vpd_id_scsi_name 1420 { 1421 uint8_t name_string[256]; 1422 }; 1423 1424 struct scsi_service_action_in 1425 { 1426 uint8_t opcode; 1427 uint8_t service_action; 1428 uint8_t action_dependent[13]; 1429 uint8_t control; 1430 }; 1431 1432 struct scsi_diag_page { 1433 uint8_t page_code; 1434 uint8_t page_specific_flags; 1435 uint8_t length[2]; 1436 uint8_t params[0]; 1437 }; 1438 1439 /* 1440 * ATA Information VPD Page based on 1441 * T10/2126-D Revision 04 1442 */ 1443 #define SVPD_ATA_INFORMATION 0x89 1444 1445 /* 1446 * Block Device Characteristics VPD Page based on 1447 * T10/1799-D Revision 31 1448 */ 1449 struct scsi_vpd_block_characteristics 1450 { 1451 u_int8_t device; 1452 u_int8_t page_code; 1453 #define SVPD_BDC 0xB1 1454 u_int8_t page_length[2]; 1455 u_int8_t medium_rotation_rate[2]; 1456 #define SVPD_BDC_RATE_NOT_REPORTED 0x00 1457 #define SVPD_BDC_RATE_NONE_ROTATING 0x01 1458 u_int8_t reserved1; 1459 u_int8_t nominal_form_factor; 1460 #define SVPD_BDC_FORM_NOT_REPORTED 0x00 1461 #define SVPD_BDC_FORM_5_25INCH 0x01 1462 #define SVPD_BDC_FORM_3_5INCH 0x02 1463 #define SVPD_BDC_FORM_2_5INCH 0x03 1464 #define SVPD_BDC_FORM_1_5INCH 0x04 1465 #define SVPD_BDC_FORM_LESSTHAN_1_5INCH 0x05 1466 u_int8_t reserved2[56]; 1467 }; 1468 1469 /* 1470 * Logical Block Provisioning VPD Page based on 1471 * T10/1799-D Revision 31 1472 */ 1473 struct scsi_vpd_logical_block_prov 1474 { 1475 u_int8_t device; 1476 u_int8_t page_code; 1477 #define SVPD_LBP 0xB2 1478 u_int8_t page_length[2]; 1479 #define SVPD_LBP_PL_BASIC 0x04 1480 u_int8_t threshold_exponent; 1481 u_int8_t flags; 1482 #define SVPD_LBP_UNMAP 0x80 1483 #define SVPD_LBP_WS16 0x40 1484 #define SVPD_LBP_WS10 0x20 1485 #define SVPD_LBP_RZ 0x04 1486 #define SVPD_LBP_ANC_SUP 0x02 1487 #define SVPD_LBP_DP 0x01 1488 u_int8_t prov_type; 1489 #define SVPD_LBP_RESOURCE 0x01 1490 #define SVPD_LBP_THIN 0x02 1491 u_int8_t reserved; 1492 /* 1493 * Provisioning Group Descriptor can be here if SVPD_LBP_DP is set 1494 * Its size can be determined from page_length - 4 1495 */ 1496 }; 1497 1498 /* 1499 * Block Limits VDP Page based on 1500 * T10/1799-D Revision 31 1501 */ 1502 struct scsi_vpd_block_limits 1503 { 1504 u_int8_t device; 1505 u_int8_t page_code; 1506 #define SVPD_BLOCK_LIMITS 0xB0 1507 u_int8_t page_length[2]; 1508 #define SVPD_BL_PL_BASIC 0x10 1509 #define SVPD_BL_PL_TP 0x3C 1510 u_int8_t reserved1; 1511 u_int8_t max_cmp_write_len; 1512 u_int8_t opt_txfer_len_grain[2]; 1513 u_int8_t max_txfer_len[4]; 1514 u_int8_t opt_txfer_len[4]; 1515 u_int8_t max_prefetch[4]; 1516 u_int8_t max_unmap_lba_cnt[4]; 1517 u_int8_t max_unmap_blk_cnt[4]; 1518 u_int8_t opt_unmap_grain[4]; 1519 u_int8_t unmap_grain_align[4]; 1520 u_int8_t max_write_same_length[8]; 1521 u_int8_t reserved2[20]; 1522 }; 1523 1524 struct scsi_read_capacity 1525 { 1526 u_int8_t opcode; 1527 u_int8_t byte2; 1528 #define SRC_RELADR 0x01 1529 u_int8_t addr[4]; 1530 u_int8_t unused[2]; 1531 u_int8_t pmi; 1532 #define SRC_PMI 0x01 1533 u_int8_t control; 1534 }; 1535 1536 struct scsi_read_capacity_16 1537 { 1538 uint8_t opcode; 1539 #define SRC16_SERVICE_ACTION 0x10 1540 uint8_t service_action; 1541 uint8_t addr[8]; 1542 uint8_t alloc_len[4]; 1543 #define SRC16_PMI 0x01 1544 #define SRC16_RELADR 0x02 1545 uint8_t reladr; 1546 uint8_t control; 1547 }; 1548 1549 struct scsi_read_capacity_data 1550 { 1551 u_int8_t addr[4]; 1552 u_int8_t length[4]; 1553 }; 1554 1555 struct scsi_read_capacity_data_long 1556 { 1557 uint8_t addr[8]; 1558 uint8_t length[4]; 1559 #define SRC16_PROT_EN 0x01 1560 #define SRC16_P_TYPE 0x0e 1561 #define SRC16_PTYPE_1 0x00 1562 #define SRC16_PTYPE_2 0x02 1563 #define SRC16_PTYPE_3 0x04 1564 uint8_t prot; 1565 #define SRC16_LBPPBE 0x0f 1566 #define SRC16_PI_EXPONENT 0xf0 1567 #define SRC16_PI_EXPONENT_SHIFT 4 1568 uint8_t prot_lbppbe; 1569 #define SRC16_LALBA 0x3f 1570 #define SRC16_LBPRZ 0x40 1571 #define SRC16_LBPME 0x80 1572 /* 1573 * Alternate versions of these macros that are intended for use on a 16-bit 1574 * version of the lalba_lbp field instead of the array of 2 8 bit numbers. 1575 */ 1576 #define SRC16_LALBA_A 0x3fff 1577 #define SRC16_LBPRZ_A 0x4000 1578 #define SRC16_LBPME_A 0x8000 1579 uint8_t lalba_lbp[2]; 1580 }; 1581 1582 struct scsi_report_luns 1583 { 1584 uint8_t opcode; 1585 uint8_t reserved1; 1586 #define RPL_REPORT_DEFAULT 0x00 1587 #define RPL_REPORT_WELLKNOWN 0x01 1588 #define RPL_REPORT_ALL 0x02 1589 uint8_t select_report; 1590 uint8_t reserved2[3]; 1591 uint8_t length[4]; 1592 uint8_t reserved3; 1593 uint8_t control; 1594 }; 1595 1596 struct scsi_report_luns_lundata { 1597 uint8_t lundata[8]; 1598 #define RPL_LUNDATA_PERIPH_BUS_MASK 0x3f 1599 #define RPL_LUNDATA_FLAT_LUN_MASK 0x3f 1600 #define RPL_LUNDATA_FLAT_LUN_BITS 0x06 1601 #define RPL_LUNDATA_LUN_TARG_MASK 0x3f 1602 #define RPL_LUNDATA_LUN_BUS_MASK 0xe0 1603 #define RPL_LUNDATA_LUN_LUN_MASK 0x1f 1604 #define RPL_LUNDATA_EXT_LEN_MASK 0x30 1605 #define RPL_LUNDATA_EXT_EAM_MASK 0x0f 1606 #define RPL_LUNDATA_EXT_EAM_WK 0x01 1607 #define RPL_LUNDATA_EXT_EAM_NOT_SPEC 0x0f 1608 #define RPL_LUNDATA_ATYP_MASK 0xc0 /* MBZ for type 0 lun */ 1609 #define RPL_LUNDATA_ATYP_PERIPH 0x00 1610 #define RPL_LUNDATA_ATYP_FLAT 0x40 1611 #define RPL_LUNDATA_ATYP_LUN 0x80 1612 #define RPL_LUNDATA_ATYP_EXTLUN 0xc0 1613 }; 1614 1615 struct scsi_report_luns_data { 1616 u_int8_t length[4]; /* length of LUN inventory, in bytes */ 1617 u_int8_t reserved[4]; /* unused */ 1618 /* 1619 * LUN inventory- we only support the type zero form for now. 1620 */ 1621 struct scsi_report_luns_lundata luns[0]; 1622 }; 1623 1624 struct scsi_target_group 1625 { 1626 uint8_t opcode; 1627 uint8_t service_action; 1628 #define STG_PDF_LENGTH 0x00 1629 #define RPL_PDF_EXTENDED 0x20 1630 uint8_t reserved1[4]; 1631 uint8_t length[4]; 1632 uint8_t reserved2; 1633 uint8_t control; 1634 }; 1635 1636 struct scsi_target_port_descriptor { 1637 uint8_t reserved[2]; 1638 uint8_t relative_target_port_identifier[2]; 1639 uint8_t desc_list[]; 1640 }; 1641 1642 struct scsi_target_port_group_descriptor { 1643 uint8_t pref_state; 1644 #define TPG_PRIMARY 0x80 1645 #define TPG_ASYMMETRIC_ACCESS_STATE_MASK 0xf 1646 #define TPG_ASYMMETRIC_ACCESS_OPTIMIZED 0x0 1647 #define TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED 0x1 1648 #define TPG_ASYMMETRIC_ACCESS_STANDBY 0x2 1649 #define TPG_ASYMMETRIC_ACCESS_UNAVAILABLE 0x3 1650 #define TPG_ASYMMETRIC_ACCESS_LBA_DEPENDENT 0x4 1651 #define TPG_ASYMMETRIC_ACCESS_OFFLINE 0xE 1652 #define TPG_ASYMMETRIC_ACCESS_TRANSITIONING 0xF 1653 uint8_t support; 1654 #define TPG_AO_SUP 0x01 1655 #define TPG_AN_SUP 0x02 1656 #define TPG_S_SUP 0x04 1657 #define TPG_U_SUP 0x08 1658 #define TPG_LBD_SUP 0x10 1659 #define TPG_O_SUP 0x40 1660 #define TPG_T_SUP 0x80 1661 uint8_t target_port_group[2]; 1662 uint8_t reserved; 1663 uint8_t status; 1664 #define TPG_UNAVLBL 0 1665 #define TPG_SET_BY_STPG 0x01 1666 #define TPG_IMPLICIT 0x02 1667 uint8_t vendor_specific; 1668 uint8_t target_port_count; 1669 struct scsi_target_port_descriptor descriptors[]; 1670 }; 1671 1672 struct scsi_target_group_data { 1673 uint8_t length[4]; /* length of returned data, in bytes */ 1674 struct scsi_target_port_group_descriptor groups[]; 1675 }; 1676 1677 struct scsi_target_group_data_extended { 1678 uint8_t length[4]; /* length of returned data, in bytes */ 1679 uint8_t format_type; /* STG_PDF_LENGTH or RPL_PDF_EXTENDED */ 1680 uint8_t implicit_transition_time; 1681 uint8_t reserved[2]; 1682 struct scsi_target_port_group_descriptor groups[]; 1683 }; 1684 1685 1686 typedef enum { 1687 SSD_TYPE_NONE, 1688 SSD_TYPE_FIXED, 1689 SSD_TYPE_DESC 1690 } scsi_sense_data_type; 1691 1692 typedef enum { 1693 SSD_ELEM_NONE, 1694 SSD_ELEM_SKIP, 1695 SSD_ELEM_DESC, 1696 SSD_ELEM_SKS, 1697 SSD_ELEM_COMMAND, 1698 SSD_ELEM_INFO, 1699 SSD_ELEM_FRU, 1700 SSD_ELEM_STREAM, 1701 SSD_ELEM_MAX 1702 } scsi_sense_elem_type; 1703 1704 1705 struct scsi_sense_data 1706 { 1707 uint8_t error_code; 1708 /* 1709 * SPC-4 says that the maximum length of sense data is 252 bytes. 1710 * So this structure is exactly 252 bytes log. 1711 */ 1712 #define SSD_FULL_SIZE 252 1713 uint8_t sense_buf[SSD_FULL_SIZE - 1]; 1714 /* 1715 * XXX KDM is this still a reasonable minimum size? 1716 */ 1717 #define SSD_MIN_SIZE 18 1718 /* 1719 * Maximum value for the extra_len field in the sense data. 1720 */ 1721 #define SSD_EXTRA_MAX 244 1722 }; 1723 1724 /* 1725 * Fixed format sense data. 1726 */ 1727 struct scsi_sense_data_fixed 1728 { 1729 u_int8_t error_code; 1730 #define SSD_ERRCODE 0x7F 1731 #define SSD_CURRENT_ERROR 0x70 1732 #define SSD_DEFERRED_ERROR 0x71 1733 #define SSD_ERRCODE_VALID 0x80 1734 u_int8_t segment; 1735 u_int8_t flags; 1736 #define SSD_KEY 0x0F 1737 #define SSD_KEY_NO_SENSE 0x00 1738 #define SSD_KEY_RECOVERED_ERROR 0x01 1739 #define SSD_KEY_NOT_READY 0x02 1740 #define SSD_KEY_MEDIUM_ERROR 0x03 1741 #define SSD_KEY_HARDWARE_ERROR 0x04 1742 #define SSD_KEY_ILLEGAL_REQUEST 0x05 1743 #define SSD_KEY_UNIT_ATTENTION 0x06 1744 #define SSD_KEY_DATA_PROTECT 0x07 1745 #define SSD_KEY_BLANK_CHECK 0x08 1746 #define SSD_KEY_Vendor_Specific 0x09 1747 #define SSD_KEY_COPY_ABORTED 0x0a 1748 #define SSD_KEY_ABORTED_COMMAND 0x0b 1749 #define SSD_KEY_EQUAL 0x0c 1750 #define SSD_KEY_VOLUME_OVERFLOW 0x0d 1751 #define SSD_KEY_MISCOMPARE 0x0e 1752 #define SSD_KEY_COMPLETED 0x0f 1753 #define SSD_ILI 0x20 1754 #define SSD_EOM 0x40 1755 #define SSD_FILEMARK 0x80 1756 u_int8_t info[4]; 1757 u_int8_t extra_len; 1758 u_int8_t cmd_spec_info[4]; 1759 u_int8_t add_sense_code; 1760 u_int8_t add_sense_code_qual; 1761 u_int8_t fru; 1762 u_int8_t sense_key_spec[3]; 1763 #define SSD_SCS_VALID 0x80 1764 #define SSD_FIELDPTR_CMD 0x40 1765 #define SSD_BITPTR_VALID 0x08 1766 #define SSD_BITPTR_VALUE 0x07 1767 u_int8_t extra_bytes[14]; 1768 #define SSD_FIXED_IS_PRESENT(sense, length, field) \ 1769 ((length >= (offsetof(struct scsi_sense_data_fixed, field) + \ 1770 sizeof(sense->field))) ? 1 :0) 1771 #define SSD_FIXED_IS_FILLED(sense, field) \ 1772 ((((offsetof(struct scsi_sense_data_fixed, field) + \ 1773 sizeof(sense->field)) - \ 1774 (offsetof(struct scsi_sense_data_fixed, extra_len) + \ 1775 sizeof(sense->extra_len))) <= sense->extra_len) ? 1 : 0) 1776 }; 1777 1778 /* 1779 * Descriptor format sense data definitions. 1780 * Introduced in SPC-3. 1781 */ 1782 struct scsi_sense_data_desc 1783 { 1784 uint8_t error_code; 1785 #define SSD_DESC_CURRENT_ERROR 0x72 1786 #define SSD_DESC_DEFERRED_ERROR 0x73 1787 uint8_t sense_key; 1788 uint8_t add_sense_code; 1789 uint8_t add_sense_code_qual; 1790 uint8_t reserved[3]; 1791 /* 1792 * Note that SPC-4, section 4.5.2.1 says that the extra_len field 1793 * must be less than or equal to 244. 1794 */ 1795 uint8_t extra_len; 1796 uint8_t sense_desc[0]; 1797 #define SSD_DESC_IS_PRESENT(sense, length, field) \ 1798 ((length >= (offsetof(struct scsi_sense_data_desc, field) + \ 1799 sizeof(sense->field))) ? 1 :0) 1800 }; 1801 1802 struct scsi_sense_desc_header 1803 { 1804 uint8_t desc_type; 1805 uint8_t length; 1806 }; 1807 /* 1808 * The information provide in the Information descriptor is device type or 1809 * command specific information, and defined in a command standard. 1810 * 1811 * Note that any changes to the field names or positions in this structure, 1812 * even reserved fields, should be accompanied by an examination of the 1813 * code in ctl_set_sense() that uses them. 1814 * 1815 * Maximum descriptors allowed: 1 (as of SPC-4) 1816 */ 1817 struct scsi_sense_info 1818 { 1819 uint8_t desc_type; 1820 #define SSD_DESC_INFO 0x00 1821 uint8_t length; 1822 uint8_t byte2; 1823 #define SSD_INFO_VALID 0x80 1824 uint8_t reserved; 1825 uint8_t info[8]; 1826 }; 1827 1828 /* 1829 * Command-specific information depends on the command for which the 1830 * reported condition occured. 1831 * 1832 * Note that any changes to the field names or positions in this structure, 1833 * even reserved fields, should be accompanied by an examination of the 1834 * code in ctl_set_sense() that uses them. 1835 * 1836 * Maximum descriptors allowed: 1 (as of SPC-4) 1837 */ 1838 struct scsi_sense_command 1839 { 1840 uint8_t desc_type; 1841 #define SSD_DESC_COMMAND 0x01 1842 uint8_t length; 1843 uint8_t reserved[2]; 1844 uint8_t command_info[8]; 1845 }; 1846 1847 /* 1848 * Sense key specific descriptor. The sense key specific data format 1849 * depends on the sense key in question. 1850 * 1851 * Maximum descriptors allowed: 1 (as of SPC-4) 1852 */ 1853 struct scsi_sense_sks 1854 { 1855 uint8_t desc_type; 1856 #define SSD_DESC_SKS 0x02 1857 uint8_t length; 1858 uint8_t reserved1[2]; 1859 uint8_t sense_key_spec[3]; 1860 #define SSD_SKS_VALID 0x80 1861 uint8_t reserved2; 1862 }; 1863 1864 /* 1865 * This is used for the Illegal Request sense key (0x05) only. 1866 */ 1867 struct scsi_sense_sks_field 1868 { 1869 uint8_t byte0; 1870 #define SSD_SKS_FIELD_VALID 0x80 1871 #define SSD_SKS_FIELD_CMD 0x40 1872 #define SSD_SKS_BPV 0x08 1873 #define SSD_SKS_BIT_VALUE 0x07 1874 uint8_t field[2]; 1875 }; 1876 1877 1878 /* 1879 * This is used for the Hardware Error (0x04), Medium Error (0x03) and 1880 * Recovered Error (0x01) sense keys. 1881 */ 1882 struct scsi_sense_sks_retry 1883 { 1884 uint8_t byte0; 1885 #define SSD_SKS_RETRY_VALID 0x80 1886 uint8_t actual_retry_count[2]; 1887 }; 1888 1889 /* 1890 * Used with the NO Sense (0x00) or Not Ready (0x02) sense keys. 1891 */ 1892 struct scsi_sense_sks_progress 1893 { 1894 uint8_t byte0; 1895 #define SSD_SKS_PROGRESS_VALID 0x80 1896 uint8_t progress[2]; 1897 #define SSD_SKS_PROGRESS_DENOM 0x10000 1898 }; 1899 1900 /* 1901 * Used with the Copy Aborted (0x0a) sense key. 1902 */ 1903 struct scsi_sense_sks_segment 1904 { 1905 uint8_t byte0; 1906 #define SSD_SKS_SEGMENT_VALID 0x80 1907 #define SSD_SKS_SEGMENT_SD 0x20 1908 #define SSD_SKS_SEGMENT_BPV 0x08 1909 #define SSD_SKS_SEGMENT_BITPTR 0x07 1910 uint8_t field[2]; 1911 }; 1912 1913 /* 1914 * Used with the Unit Attention (0x06) sense key. 1915 * 1916 * This is currently used to indicate that the unit attention condition 1917 * queue has overflowed (when the overflow bit is set). 1918 */ 1919 struct scsi_sense_sks_overflow 1920 { 1921 uint8_t byte0; 1922 #define SSD_SKS_OVERFLOW_VALID 0x80 1923 #define SSD_SKS_OVERFLOW_SET 0x01 1924 uint8_t reserved[2]; 1925 }; 1926 1927 /* 1928 * This specifies which component is associated with the sense data. There 1929 * is no standard meaning for the fru value. 1930 * 1931 * Maximum descriptors allowed: 1 (as of SPC-4) 1932 */ 1933 struct scsi_sense_fru 1934 { 1935 uint8_t desc_type; 1936 #define SSD_DESC_FRU 0x03 1937 uint8_t length; 1938 uint8_t reserved; 1939 uint8_t fru; 1940 }; 1941 1942 /* 1943 * Used for Stream commands, defined in SSC-4. 1944 * 1945 * Maximum descriptors allowed: 1 (as of SPC-4) 1946 */ 1947 1948 struct scsi_sense_stream 1949 { 1950 uint8_t desc_type; 1951 #define SSD_DESC_STREAM 0x04 1952 uint8_t length; 1953 uint8_t reserved; 1954 uint8_t byte3; 1955 #define SSD_DESC_STREAM_FM 0x80 1956 #define SSD_DESC_STREAM_EOM 0x40 1957 #define SSD_DESC_STREAM_ILI 0x20 1958 }; 1959 1960 /* 1961 * Used for Block commands, defined in SBC-3. 1962 * 1963 * This is currently (as of SBC-3) only used for the Incorrect Length 1964 * Indication (ILI) bit, which says that the data length requested in the 1965 * READ LONG or WRITE LONG command did not match the length of the logical 1966 * block. 1967 * 1968 * Maximum descriptors allowed: 1 (as of SPC-4) 1969 */ 1970 struct scsi_sense_block 1971 { 1972 uint8_t desc_type; 1973 #define SSD_DESC_BLOCK 0x05 1974 uint8_t length; 1975 uint8_t reserved; 1976 uint8_t byte3; 1977 #define SSD_DESC_BLOCK_ILI 0x20 1978 }; 1979 1980 /* 1981 * Used for Object-Based Storage Devices (OSD-3). 1982 * 1983 * Maximum descriptors allowed: 1 (as of SPC-4) 1984 */ 1985 struct scsi_sense_osd_objid 1986 { 1987 uint8_t desc_type; 1988 #define SSD_DESC_OSD_OBJID 0x06 1989 uint8_t length; 1990 uint8_t reserved[6]; 1991 /* 1992 * XXX KDM provide the bit definitions here? There are a lot of 1993 * them, and we don't have an OSD driver yet. 1994 */ 1995 uint8_t not_init_cmds[4]; 1996 uint8_t completed_cmds[4]; 1997 uint8_t partition_id[8]; 1998 uint8_t object_id[8]; 1999 }; 2000 2001 /* 2002 * Used for Object-Based Storage Devices (OSD-3). 2003 * 2004 * Maximum descriptors allowed: 1 (as of SPC-4) 2005 */ 2006 struct scsi_sense_osd_integrity 2007 { 2008 uint8_t desc_type; 2009 #define SSD_DESC_OSD_INTEGRITY 0x07 2010 uint8_t length; 2011 uint8_t integ_check_val[32]; 2012 }; 2013 2014 /* 2015 * Used for Object-Based Storage Devices (OSD-3). 2016 * 2017 * Maximum descriptors allowed: 1 (as of SPC-4) 2018 */ 2019 struct scsi_sense_osd_attr_id 2020 { 2021 uint8_t desc_type; 2022 #define SSD_DESC_OSD_ATTR_ID 0x08 2023 uint8_t length; 2024 uint8_t reserved[2]; 2025 uint8_t attr_desc[0]; 2026 }; 2027 2028 /* 2029 * Used with Sense keys No Sense (0x00) and Not Ready (0x02). 2030 * 2031 * Maximum descriptors allowed: 32 (as of SPC-4) 2032 */ 2033 struct scsi_sense_progress 2034 { 2035 uint8_t desc_type; 2036 #define SSD_DESC_PROGRESS 0x0a 2037 uint8_t length; 2038 uint8_t sense_key; 2039 uint8_t add_sense_code; 2040 uint8_t add_sense_code_qual; 2041 uint8_t reserved; 2042 uint8_t progress[2]; 2043 }; 2044 2045 /* 2046 * This is typically forwarded as the result of an EXTENDED COPY command. 2047 * 2048 * Maximum descriptors allowed: 2 (as of SPC-4) 2049 */ 2050 struct scsi_sense_forwarded 2051 { 2052 uint8_t desc_type; 2053 #define SSD_DESC_FORWARDED 0x0c 2054 uint8_t length; 2055 uint8_t byte2; 2056 #define SSD_FORWARDED_FSDT 0x80 2057 #define SSD_FORWARDED_SDS_MASK 0x0f 2058 #define SSD_FORWARDED_SDS_UNK 0x00 2059 #define SSD_FORWARDED_SDS_EXSRC 0x01 2060 #define SSD_FORWARDED_SDS_EXDST 0x02 2061 }; 2062 2063 /* 2064 * Vendor-specific sense descriptor. The desc_type field will be in the 2065 * range bewteen MIN and MAX inclusive. 2066 */ 2067 struct scsi_sense_vendor 2068 { 2069 uint8_t desc_type; 2070 #define SSD_DESC_VENDOR_MIN 0x80 2071 #define SSD_DESC_VENDOR_MAX 0xff 2072 uint8_t length; 2073 uint8_t data[0]; 2074 }; 2075 2076 struct scsi_mode_header_6 2077 { 2078 u_int8_t data_length; /* Sense data length */ 2079 u_int8_t medium_type; 2080 u_int8_t dev_spec; 2081 u_int8_t blk_desc_len; 2082 }; 2083 2084 struct scsi_mode_header_10 2085 { 2086 u_int8_t data_length[2];/* Sense data length */ 2087 u_int8_t medium_type; 2088 u_int8_t dev_spec; 2089 u_int8_t unused[2]; 2090 u_int8_t blk_desc_len[2]; 2091 }; 2092 2093 struct scsi_mode_page_header 2094 { 2095 u_int8_t page_code; 2096 #define SMPH_PS 0x80 2097 #define SMPH_SPF 0x40 2098 #define SMPH_PC_MASK 0x3f 2099 u_int8_t page_length; 2100 }; 2101 2102 struct scsi_mode_page_header_sp 2103 { 2104 uint8_t page_code; 2105 uint8_t subpage; 2106 uint8_t page_length[2]; 2107 }; 2108 2109 2110 struct scsi_mode_blk_desc 2111 { 2112 u_int8_t density; 2113 u_int8_t nblocks[3]; 2114 u_int8_t reserved; 2115 u_int8_t blklen[3]; 2116 }; 2117 2118 #define SCSI_DEFAULT_DENSITY 0x00 /* use 'default' density */ 2119 #define SCSI_SAME_DENSITY 0x7f /* use 'same' density- >= SCSI-2 only */ 2120 2121 2122 /* 2123 * Status Byte 2124 */ 2125 #define SCSI_STATUS_OK 0x00 2126 #define SCSI_STATUS_CHECK_COND 0x02 2127 #define SCSI_STATUS_COND_MET 0x04 2128 #define SCSI_STATUS_BUSY 0x08 2129 #define SCSI_STATUS_INTERMED 0x10 2130 #define SCSI_STATUS_INTERMED_COND_MET 0x14 2131 #define SCSI_STATUS_RESERV_CONFLICT 0x18 2132 #define SCSI_STATUS_CMD_TERMINATED 0x22 /* Obsolete in SAM-2 */ 2133 #define SCSI_STATUS_QUEUE_FULL 0x28 2134 #define SCSI_STATUS_ACA_ACTIVE 0x30 2135 #define SCSI_STATUS_TASK_ABORTED 0x40 2136 2137 struct scsi_inquiry_pattern { 2138 u_int8_t type; 2139 u_int8_t media_type; 2140 #define SIP_MEDIA_REMOVABLE 0x01 2141 #define SIP_MEDIA_FIXED 0x02 2142 const char *vendor; 2143 const char *product; 2144 const char *revision; 2145 }; 2146 2147 struct scsi_static_inquiry_pattern { 2148 u_int8_t type; 2149 u_int8_t media_type; 2150 char vendor[SID_VENDOR_SIZE+1]; 2151 char product[SID_PRODUCT_SIZE+1]; 2152 char revision[SID_REVISION_SIZE+1]; 2153 }; 2154 2155 struct scsi_sense_quirk_entry { 2156 struct scsi_inquiry_pattern inq_pat; 2157 int num_sense_keys; 2158 int num_ascs; 2159 struct sense_key_table_entry *sense_key_info; 2160 struct asc_table_entry *asc_info; 2161 }; 2162 2163 struct sense_key_table_entry { 2164 u_int8_t sense_key; 2165 u_int32_t action; 2166 const char *desc; 2167 }; 2168 2169 struct asc_table_entry { 2170 u_int8_t asc; 2171 u_int8_t ascq; 2172 u_int32_t action; 2173 const char *desc; 2174 }; 2175 2176 struct op_table_entry { 2177 u_int8_t opcode; 2178 u_int32_t opmask; 2179 const char *desc; 2180 }; 2181 2182 struct scsi_op_quirk_entry { 2183 struct scsi_inquiry_pattern inq_pat; 2184 int num_ops; 2185 struct op_table_entry *op_table; 2186 }; 2187 2188 typedef enum { 2189 SSS_FLAG_NONE = 0x00, 2190 SSS_FLAG_PRINT_COMMAND = 0x01 2191 } scsi_sense_string_flags; 2192 2193 struct ccb_scsiio; 2194 struct cam_periph; 2195 union ccb; 2196 #ifndef _KERNEL 2197 struct cam_device; 2198 #endif 2199 2200 extern const char *scsi_sense_key_text[]; 2201 2202 struct sbuf; 2203 2204 __BEGIN_DECLS 2205 void scsi_sense_desc(int sense_key, int asc, int ascq, 2206 struct scsi_inquiry_data *inq_data, 2207 const char **sense_key_desc, const char **asc_desc); 2208 scsi_sense_action scsi_error_action(struct ccb_scsiio* csio, 2209 struct scsi_inquiry_data *inq_data, 2210 u_int32_t sense_flags); 2211 const char * scsi_status_string(struct ccb_scsiio *csio); 2212 2213 void scsi_desc_iterate(struct scsi_sense_data_desc *sense, u_int sense_len, 2214 int (*iter_func)(struct scsi_sense_data_desc *sense, 2215 u_int, struct scsi_sense_desc_header *, 2216 void *), void *arg); 2217 uint8_t *scsi_find_desc(struct scsi_sense_data_desc *sense, u_int sense_len, 2218 uint8_t desc_type); 2219 void scsi_set_sense_data(struct scsi_sense_data *sense_data, 2220 scsi_sense_data_type sense_format, int current_error, 2221 int sense_key, int asc, int ascq, ...) ; 2222 void scsi_set_sense_data_va(struct scsi_sense_data *sense_data, 2223 scsi_sense_data_type sense_format, 2224 int current_error, int sense_key, int asc, 2225 int ascq, va_list ap); 2226 int scsi_get_sense_info(struct scsi_sense_data *sense_data, u_int sense_len, 2227 uint8_t info_type, uint64_t *info, 2228 int64_t *signed_info); 2229 int scsi_get_sks(struct scsi_sense_data *sense_data, u_int sense_len, 2230 uint8_t *sks); 2231 int scsi_get_block_info(struct scsi_sense_data *sense_data, u_int sense_len, 2232 struct scsi_inquiry_data *inq_data, 2233 uint8_t *block_bits); 2234 int scsi_get_stream_info(struct scsi_sense_data *sense_data, u_int sense_len, 2235 struct scsi_inquiry_data *inq_data, 2236 uint8_t *stream_bits); 2237 void scsi_info_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len, 2238 struct scsi_inquiry_data *inq_data, uint64_t info); 2239 void scsi_command_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len, 2240 struct scsi_inquiry_data *inq_data, uint64_t csi); 2241 void scsi_progress_sbuf(struct sbuf *sb, uint16_t progress); 2242 int scsi_sks_sbuf(struct sbuf *sb, int sense_key, uint8_t *sks); 2243 void scsi_fru_sbuf(struct sbuf *sb, uint64_t fru); 2244 void scsi_stream_sbuf(struct sbuf *sb, uint8_t stream_bits, uint64_t info); 2245 void scsi_block_sbuf(struct sbuf *sb, uint8_t block_bits, uint64_t info); 2246 void scsi_sense_info_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 2247 u_int sense_len, uint8_t *cdb, int cdb_len, 2248 struct scsi_inquiry_data *inq_data, 2249 struct scsi_sense_desc_header *header); 2250 2251 void scsi_sense_command_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 2252 u_int sense_len, uint8_t *cdb, int cdb_len, 2253 struct scsi_inquiry_data *inq_data, 2254 struct scsi_sense_desc_header *header); 2255 void scsi_sense_sks_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 2256 u_int sense_len, uint8_t *cdb, int cdb_len, 2257 struct scsi_inquiry_data *inq_data, 2258 struct scsi_sense_desc_header *header); 2259 void scsi_sense_fru_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 2260 u_int sense_len, uint8_t *cdb, int cdb_len, 2261 struct scsi_inquiry_data *inq_data, 2262 struct scsi_sense_desc_header *header); 2263 void scsi_sense_stream_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 2264 u_int sense_len, uint8_t *cdb, int cdb_len, 2265 struct scsi_inquiry_data *inq_data, 2266 struct scsi_sense_desc_header *header); 2267 void scsi_sense_block_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 2268 u_int sense_len, uint8_t *cdb, int cdb_len, 2269 struct scsi_inquiry_data *inq_data, 2270 struct scsi_sense_desc_header *header); 2271 void scsi_sense_progress_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 2272 u_int sense_len, uint8_t *cdb, int cdb_len, 2273 struct scsi_inquiry_data *inq_data, 2274 struct scsi_sense_desc_header *header); 2275 void scsi_sense_generic_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 2276 u_int sense_len, uint8_t *cdb, int cdb_len, 2277 struct scsi_inquiry_data *inq_data, 2278 struct scsi_sense_desc_header *header); 2279 void scsi_sense_desc_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 2280 u_int sense_len, uint8_t *cdb, int cdb_len, 2281 struct scsi_inquiry_data *inq_data, 2282 struct scsi_sense_desc_header *header); 2283 scsi_sense_data_type scsi_sense_type(struct scsi_sense_data *sense_data); 2284 2285 void scsi_sense_only_sbuf(struct scsi_sense_data *sense, u_int sense_len, 2286 struct sbuf *sb, char *path_str, 2287 struct scsi_inquiry_data *inq_data, uint8_t *cdb, 2288 int cdb_len); 2289 2290 #ifdef _KERNEL 2291 int scsi_command_string(struct ccb_scsiio *csio, struct sbuf *sb); 2292 int scsi_sense_sbuf(struct ccb_scsiio *csio, struct sbuf *sb, 2293 scsi_sense_string_flags flags); 2294 char * scsi_sense_string(struct ccb_scsiio *csio, 2295 char *str, int str_len); 2296 void scsi_sense_print(struct ccb_scsiio *csio); 2297 int scsi_vpd_supported_page(struct cam_periph *periph, 2298 uint8_t page_id); 2299 #else /* _KERNEL */ 2300 int scsi_command_string(struct cam_device *device, 2301 struct ccb_scsiio *csio, struct sbuf *sb); 2302 int scsi_sense_sbuf(struct cam_device *device, 2303 struct ccb_scsiio *csio, struct sbuf *sb, 2304 scsi_sense_string_flags flags); 2305 char * scsi_sense_string(struct cam_device *device, 2306 struct ccb_scsiio *csio, 2307 char *str, int str_len); 2308 void scsi_sense_print(struct cam_device *device, 2309 struct ccb_scsiio *csio, FILE *ofile); 2310 #endif /* _KERNEL */ 2311 2312 const char * scsi_op_desc(u_int16_t opcode, 2313 struct scsi_inquiry_data *inq_data); 2314 char * scsi_cdb_string(u_int8_t *cdb_ptr, char *cdb_string, 2315 size_t len); 2316 2317 void scsi_print_inquiry(struct scsi_inquiry_data *inq_data); 2318 void scsi_print_inquiry_short(struct scsi_inquiry_data *inq_data); 2319 2320 u_int scsi_calc_syncsrate(u_int period_factor); 2321 u_int scsi_calc_syncparam(u_int period); 2322 2323 typedef int (*scsi_devid_checkfn_t)(uint8_t *); 2324 int scsi_devid_is_naa_ieee_reg(uint8_t *bufp); 2325 int scsi_devid_is_sas_target(uint8_t *bufp); 2326 int scsi_devid_is_lun_eui64(uint8_t *bufp); 2327 int scsi_devid_is_lun_naa(uint8_t *bufp); 2328 int scsi_devid_is_lun_name(uint8_t *bufp); 2329 int scsi_devid_is_lun_t10(uint8_t *bufp); 2330 struct scsi_vpd_id_descriptor * 2331 scsi_get_devid(struct scsi_vpd_device_id *id, uint32_t len, 2332 scsi_devid_checkfn_t ck_fn); 2333 2334 void scsi_test_unit_ready(struct ccb_scsiio *csio, u_int32_t retries, 2335 void (*cbfcnp)(struct cam_periph *, 2336 union ccb *), 2337 u_int8_t tag_action, 2338 u_int8_t sense_len, u_int32_t timeout); 2339 2340 void scsi_request_sense(struct ccb_scsiio *csio, u_int32_t retries, 2341 void (*cbfcnp)(struct cam_periph *, 2342 union ccb *), 2343 void *data_ptr, u_int8_t dxfer_len, 2344 u_int8_t tag_action, u_int8_t sense_len, 2345 u_int32_t timeout); 2346 2347 void scsi_inquiry(struct ccb_scsiio *csio, u_int32_t retries, 2348 void (*cbfcnp)(struct cam_periph *, union ccb *), 2349 u_int8_t tag_action, u_int8_t *inq_buf, 2350 u_int32_t inq_len, int evpd, u_int8_t page_code, 2351 u_int8_t sense_len, u_int32_t timeout); 2352 2353 void scsi_mode_sense(struct ccb_scsiio *csio, u_int32_t retries, 2354 void (*cbfcnp)(struct cam_periph *, 2355 union ccb *), 2356 u_int8_t tag_action, int dbd, 2357 u_int8_t page_code, u_int8_t page, 2358 u_int8_t *param_buf, u_int32_t param_len, 2359 u_int8_t sense_len, u_int32_t timeout); 2360 2361 void scsi_mode_sense_len(struct ccb_scsiio *csio, u_int32_t retries, 2362 void (*cbfcnp)(struct cam_periph *, 2363 union ccb *), 2364 u_int8_t tag_action, int dbd, 2365 u_int8_t page_code, u_int8_t page, 2366 u_int8_t *param_buf, u_int32_t param_len, 2367 int minimum_cmd_size, u_int8_t sense_len, 2368 u_int32_t timeout); 2369 2370 void scsi_mode_select(struct ccb_scsiio *csio, u_int32_t retries, 2371 void (*cbfcnp)(struct cam_periph *, 2372 union ccb *), 2373 u_int8_t tag_action, int scsi_page_fmt, 2374 int save_pages, u_int8_t *param_buf, 2375 u_int32_t param_len, u_int8_t sense_len, 2376 u_int32_t timeout); 2377 2378 void scsi_mode_select_len(struct ccb_scsiio *csio, u_int32_t retries, 2379 void (*cbfcnp)(struct cam_periph *, 2380 union ccb *), 2381 u_int8_t tag_action, int scsi_page_fmt, 2382 int save_pages, u_int8_t *param_buf, 2383 u_int32_t param_len, int minimum_cmd_size, 2384 u_int8_t sense_len, u_int32_t timeout); 2385 2386 void scsi_log_sense(struct ccb_scsiio *csio, u_int32_t retries, 2387 void (*cbfcnp)(struct cam_periph *, union ccb *), 2388 u_int8_t tag_action, u_int8_t page_code, 2389 u_int8_t page, int save_pages, int ppc, 2390 u_int32_t paramptr, u_int8_t *param_buf, 2391 u_int32_t param_len, u_int8_t sense_len, 2392 u_int32_t timeout); 2393 2394 void scsi_log_select(struct ccb_scsiio *csio, u_int32_t retries, 2395 void (*cbfcnp)(struct cam_periph *, 2396 union ccb *), u_int8_t tag_action, 2397 u_int8_t page_code, int save_pages, 2398 int pc_reset, u_int8_t *param_buf, 2399 u_int32_t param_len, u_int8_t sense_len, 2400 u_int32_t timeout); 2401 2402 void scsi_prevent(struct ccb_scsiio *csio, u_int32_t retries, 2403 void (*cbfcnp)(struct cam_periph *, union ccb *), 2404 u_int8_t tag_action, u_int8_t action, 2405 u_int8_t sense_len, u_int32_t timeout); 2406 2407 void scsi_read_capacity(struct ccb_scsiio *csio, u_int32_t retries, 2408 void (*cbfcnp)(struct cam_periph *, 2409 union ccb *), u_int8_t tag_action, 2410 struct scsi_read_capacity_data *, 2411 u_int8_t sense_len, u_int32_t timeout); 2412 void scsi_read_capacity_16(struct ccb_scsiio *csio, uint32_t retries, 2413 void (*cbfcnp)(struct cam_periph *, 2414 union ccb *), uint8_t tag_action, 2415 uint64_t lba, int reladr, int pmi, 2416 struct scsi_read_capacity_data_long 2417 *rcap_buf, uint8_t sense_len, 2418 uint32_t timeout); 2419 2420 void scsi_report_luns(struct ccb_scsiio *csio, u_int32_t retries, 2421 void (*cbfcnp)(struct cam_periph *, 2422 union ccb *), u_int8_t tag_action, 2423 u_int8_t select_report, 2424 struct scsi_report_luns_data *rpl_buf, 2425 u_int32_t alloc_len, u_int8_t sense_len, 2426 u_int32_t timeout); 2427 2428 void scsi_report_target_group(struct ccb_scsiio *csio, u_int32_t retries, 2429 void (*cbfcnp)(struct cam_periph *, 2430 union ccb *), u_int8_t tag_action, 2431 u_int8_t pdf, 2432 void *buf, 2433 u_int32_t alloc_len, u_int8_t sense_len, 2434 u_int32_t timeout); 2435 2436 void scsi_set_target_group(struct ccb_scsiio *csio, u_int32_t retries, 2437 void (*cbfcnp)(struct cam_periph *, 2438 union ccb *), u_int8_t tag_action, void *buf, 2439 u_int32_t alloc_len, u_int8_t sense_len, 2440 u_int32_t timeout); 2441 2442 void scsi_synchronize_cache(struct ccb_scsiio *csio, 2443 u_int32_t retries, 2444 void (*cbfcnp)(struct cam_periph *, 2445 union ccb *), u_int8_t tag_action, 2446 u_int32_t begin_lba, u_int16_t lb_count, 2447 u_int8_t sense_len, u_int32_t timeout); 2448 2449 void scsi_receive_diagnostic_results(struct ccb_scsiio *csio, u_int32_t retries, 2450 void (*cbfcnp)(struct cam_periph *, 2451 union ccb*), 2452 uint8_t tag_action, int pcv, 2453 uint8_t page_code, uint8_t *data_ptr, 2454 uint16_t allocation_length, 2455 uint8_t sense_len, uint32_t timeout); 2456 2457 void scsi_send_diagnostic(struct ccb_scsiio *csio, u_int32_t retries, 2458 void (*cbfcnp)(struct cam_periph *, union ccb *), 2459 uint8_t tag_action, int unit_offline, 2460 int device_offline, int self_test, int page_format, 2461 int self_test_code, uint8_t *data_ptr, 2462 uint16_t param_list_length, uint8_t sense_len, 2463 uint32_t timeout); 2464 2465 void scsi_read_buffer(struct ccb_scsiio *csio, u_int32_t retries, 2466 void (*cbfcnp)(struct cam_periph *, union ccb*), 2467 uint8_t tag_action, int mode, 2468 uint8_t buffer_id, u_int32_t offset, 2469 uint8_t *data_ptr, uint32_t allocation_length, 2470 uint8_t sense_len, uint32_t timeout); 2471 2472 void scsi_write_buffer(struct ccb_scsiio *csio, u_int32_t retries, 2473 void (*cbfcnp)(struct cam_periph *, union ccb *), 2474 uint8_t tag_action, int mode, 2475 uint8_t buffer_id, u_int32_t offset, 2476 uint8_t *data_ptr, uint32_t param_list_length, 2477 uint8_t sense_len, uint32_t timeout); 2478 2479 #define SCSI_RW_READ 0x0001 2480 #define SCSI_RW_WRITE 0x0002 2481 #define SCSI_RW_DIRMASK 0x0003 2482 #define SCSI_RW_BIO 0x1000 2483 void scsi_read_write(struct ccb_scsiio *csio, u_int32_t retries, 2484 void (*cbfcnp)(struct cam_periph *, union ccb *), 2485 u_int8_t tag_action, int readop, u_int8_t byte2, 2486 int minimum_cmd_size, u_int64_t lba, 2487 u_int32_t block_count, u_int8_t *data_ptr, 2488 u_int32_t dxfer_len, u_int8_t sense_len, 2489 u_int32_t timeout); 2490 2491 void scsi_write_same(struct ccb_scsiio *csio, u_int32_t retries, 2492 void (*cbfcnp)(struct cam_periph *, union ccb *), 2493 u_int8_t tag_action, u_int8_t byte2, 2494 int minimum_cmd_size, u_int64_t lba, 2495 u_int32_t block_count, u_int8_t *data_ptr, 2496 u_int32_t dxfer_len, u_int8_t sense_len, 2497 u_int32_t timeout); 2498 2499 void scsi_ata_identify(struct ccb_scsiio *csio, u_int32_t retries, 2500 void (*cbfcnp)(struct cam_periph *, union ccb *), 2501 u_int8_t tag_action, u_int8_t *data_ptr, 2502 u_int16_t dxfer_len, u_int8_t sense_len, 2503 u_int32_t timeout); 2504 2505 void scsi_ata_trim(struct ccb_scsiio *csio, u_int32_t retries, 2506 void (*cbfcnp)(struct cam_periph *, union ccb *), 2507 u_int8_t tag_action, u_int16_t block_count, 2508 u_int8_t *data_ptr, u_int16_t dxfer_len, 2509 u_int8_t sense_len, u_int32_t timeout); 2510 2511 void scsi_ata_pass_16(struct ccb_scsiio *csio, u_int32_t retries, 2512 void (*cbfcnp)(struct cam_periph *, union ccb *), 2513 u_int32_t flags, u_int8_t tag_action, 2514 u_int8_t protocol, u_int8_t ata_flags, u_int16_t features, 2515 u_int16_t sector_count, uint64_t lba, u_int8_t command, 2516 u_int8_t control, u_int8_t *data_ptr, u_int16_t dxfer_len, 2517 u_int8_t sense_len, u_int32_t timeout); 2518 2519 void scsi_unmap(struct ccb_scsiio *csio, u_int32_t retries, 2520 void (*cbfcnp)(struct cam_periph *, union ccb *), 2521 u_int8_t tag_action, u_int8_t byte2, 2522 u_int8_t *data_ptr, u_int16_t dxfer_len, 2523 u_int8_t sense_len, u_int32_t timeout); 2524 2525 void scsi_start_stop(struct ccb_scsiio *csio, u_int32_t retries, 2526 void (*cbfcnp)(struct cam_periph *, union ccb *), 2527 u_int8_t tag_action, int start, int load_eject, 2528 int immediate, u_int8_t sense_len, u_int32_t timeout); 2529 2530 int scsi_inquiry_match(caddr_t inqbuffer, caddr_t table_entry); 2531 int scsi_static_inquiry_match(caddr_t inqbuffer, 2532 caddr_t table_entry); 2533 int scsi_devid_match(uint8_t *rhs, size_t rhs_len, 2534 uint8_t *lhs, size_t lhs_len); 2535 2536 void scsi_extract_sense(struct scsi_sense_data *sense, int *error_code, 2537 int *sense_key, int *asc, int *ascq); 2538 int scsi_extract_sense_ccb(union ccb *ccb, int *error_code, int *sense_key, 2539 int *asc, int *ascq); 2540 void scsi_extract_sense_len(struct scsi_sense_data *sense, 2541 u_int sense_len, int *error_code, int *sense_key, 2542 int *asc, int *ascq, int show_errors); 2543 int scsi_get_sense_key(struct scsi_sense_data *sense, u_int sense_len, 2544 int show_errors); 2545 int scsi_get_asc(struct scsi_sense_data *sense, u_int sense_len, 2546 int show_errors); 2547 int scsi_get_ascq(struct scsi_sense_data *sense, u_int sense_len, 2548 int show_errors); 2549 static __inline void scsi_ulto2b(u_int32_t val, u_int8_t *bytes); 2550 static __inline void scsi_ulto3b(u_int32_t val, u_int8_t *bytes); 2551 static __inline void scsi_ulto4b(u_int32_t val, u_int8_t *bytes); 2552 static __inline void scsi_u64to8b(u_int64_t val, u_int8_t *bytes); 2553 static __inline uint32_t scsi_2btoul(const uint8_t *bytes); 2554 static __inline uint32_t scsi_3btoul(const uint8_t *bytes); 2555 static __inline int32_t scsi_3btol(const uint8_t *bytes); 2556 static __inline uint32_t scsi_4btoul(const uint8_t *bytes); 2557 static __inline uint64_t scsi_8btou64(const uint8_t *bytes); 2558 static __inline void *find_mode_page_6(struct scsi_mode_header_6 *mode_header); 2559 static __inline void *find_mode_page_10(struct scsi_mode_header_10 *mode_header); 2560 2561 static __inline void 2562 scsi_ulto2b(u_int32_t val, u_int8_t *bytes) 2563 { 2564 2565 bytes[0] = (val >> 8) & 0xff; 2566 bytes[1] = val & 0xff; 2567 } 2568 2569 static __inline void 2570 scsi_ulto3b(u_int32_t val, u_int8_t *bytes) 2571 { 2572 2573 bytes[0] = (val >> 16) & 0xff; 2574 bytes[1] = (val >> 8) & 0xff; 2575 bytes[2] = val & 0xff; 2576 } 2577 2578 static __inline void 2579 scsi_ulto4b(u_int32_t val, u_int8_t *bytes) 2580 { 2581 2582 bytes[0] = (val >> 24) & 0xff; 2583 bytes[1] = (val >> 16) & 0xff; 2584 bytes[2] = (val >> 8) & 0xff; 2585 bytes[3] = val & 0xff; 2586 } 2587 2588 static __inline void 2589 scsi_u64to8b(u_int64_t val, u_int8_t *bytes) 2590 { 2591 2592 bytes[0] = (val >> 56) & 0xff; 2593 bytes[1] = (val >> 48) & 0xff; 2594 bytes[2] = (val >> 40) & 0xff; 2595 bytes[3] = (val >> 32) & 0xff; 2596 bytes[4] = (val >> 24) & 0xff; 2597 bytes[5] = (val >> 16) & 0xff; 2598 bytes[6] = (val >> 8) & 0xff; 2599 bytes[7] = val & 0xff; 2600 } 2601 2602 static __inline uint32_t 2603 scsi_2btoul(const uint8_t *bytes) 2604 { 2605 uint32_t rv; 2606 2607 rv = (bytes[0] << 8) | 2608 bytes[1]; 2609 return (rv); 2610 } 2611 2612 static __inline uint32_t 2613 scsi_3btoul(const uint8_t *bytes) 2614 { 2615 uint32_t rv; 2616 2617 rv = (bytes[0] << 16) | 2618 (bytes[1] << 8) | 2619 bytes[2]; 2620 return (rv); 2621 } 2622 2623 static __inline int32_t 2624 scsi_3btol(const uint8_t *bytes) 2625 { 2626 uint32_t rc = scsi_3btoul(bytes); 2627 2628 if (rc & 0x00800000) 2629 rc |= 0xff000000; 2630 2631 return (int32_t) rc; 2632 } 2633 2634 static __inline uint32_t 2635 scsi_4btoul(const uint8_t *bytes) 2636 { 2637 uint32_t rv; 2638 2639 rv = (bytes[0] << 24) | 2640 (bytes[1] << 16) | 2641 (bytes[2] << 8) | 2642 bytes[3]; 2643 return (rv); 2644 } 2645 2646 static __inline uint64_t 2647 scsi_8btou64(const uint8_t *bytes) 2648 { 2649 uint64_t rv; 2650 2651 rv = (((uint64_t)bytes[0]) << 56) | 2652 (((uint64_t)bytes[1]) << 48) | 2653 (((uint64_t)bytes[2]) << 40) | 2654 (((uint64_t)bytes[3]) << 32) | 2655 (((uint64_t)bytes[4]) << 24) | 2656 (((uint64_t)bytes[5]) << 16) | 2657 (((uint64_t)bytes[6]) << 8) | 2658 bytes[7]; 2659 return (rv); 2660 } 2661 2662 /* 2663 * Given the pointer to a returned mode sense buffer, return a pointer to 2664 * the start of the first mode page. 2665 */ 2666 static __inline void * 2667 find_mode_page_6(struct scsi_mode_header_6 *mode_header) 2668 { 2669 void *page_start; 2670 2671 page_start = (void *)((u_int8_t *)&mode_header[1] + 2672 mode_header->blk_desc_len); 2673 2674 return(page_start); 2675 } 2676 2677 static __inline void * 2678 find_mode_page_10(struct scsi_mode_header_10 *mode_header) 2679 { 2680 void *page_start; 2681 2682 page_start = (void *)((u_int8_t *)&mode_header[1] + 2683 scsi_2btoul(mode_header->blk_desc_len)); 2684 2685 return(page_start); 2686 } 2687 2688 __END_DECLS 2689 2690 #endif /*_SCSI_SCSI_ALL_H*/
Cache object: 928f747b6d4e0c5b2f02901bcc66e40f
[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]