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 #define SPRI_MAX_LEN 0xffff 285 u_int8_t control; 286 }; 287 288 struct scsi_per_res_in_header 289 { 290 u_int8_t generation[4]; 291 u_int8_t length[4]; 292 }; 293 294 struct scsi_per_res_key 295 { 296 u_int8_t key[8]; 297 }; 298 299 struct scsi_per_res_in_keys 300 { 301 struct scsi_per_res_in_header header; 302 struct scsi_per_res_key keys[0]; 303 }; 304 305 struct scsi_per_res_cap 306 { 307 uint8_t length[2]; 308 uint8_t flags1; 309 #define SPRI_RLR_C 0x80 310 #define SPRI_CRH 0x10 311 #define SPRI_SIP_C 0x08 312 #define SPRI_ATP_C 0x04 313 #define SPRI_PTPL_C 0x01 314 uint8_t flags2; 315 #define SPRI_TMV 0x80 316 #define SPRI_ALLOW_CMD_MASK 0x70 317 #define SPRI_ALLOW_CMD_SHIFT 4 318 #define SPRI_ALLOW_NA 0x00 319 #define SPRI_ALLOW_1 0x10 320 #define SPRI_ALLOW_2 0x20 321 #define SPRI_ALLOW_3 0x30 322 #define SPRI_ALLOW_4 0x40 323 #define SPRI_ALLOW_5 0x50 324 #define SPRI_PTPL_A 0x01 325 uint8_t type_mask[2]; 326 #define SPRI_TM_WR_EX_AR 0x8000 327 #define SPRI_TM_EX_AC_RO 0x4000 328 #define SPRI_TM_WR_EX_RO 0x2000 329 #define SPRI_TM_EX_AC 0x0800 330 #define SPRI_TM_WR_EX 0x0200 331 #define SPRI_TM_EX_AC_AR 0x0001 332 uint8_t reserved[2]; 333 }; 334 335 struct scsi_per_res_in_rsrv_data 336 { 337 uint8_t reservation[8]; 338 uint8_t scope_addr[4]; 339 uint8_t reserved; 340 uint8_t scopetype; 341 #define SPRT_WE 0x01 342 #define SPRT_EA 0x03 343 #define SPRT_WERO 0x05 344 #define SPRT_EARO 0x06 345 #define SPRT_WEAR 0x07 346 #define SPRT_EAAR 0x08 347 uint8_t extent_length[2]; 348 }; 349 350 struct scsi_per_res_in_rsrv 351 { 352 struct scsi_per_res_in_header header; 353 struct scsi_per_res_in_rsrv_data data; 354 }; 355 356 struct scsi_per_res_in_full_desc 357 { 358 struct scsi_per_res_key res_key; 359 uint8_t reserved1[4]; 360 uint8_t flags; 361 #define SPRI_FULL_ALL_TG_PT 0x02 362 #define SPRI_FULL_R_HOLDER 0x01 363 uint8_t scopetype; 364 uint8_t reserved2[4]; 365 uint8_t rel_trgt_port_id[2]; 366 uint8_t additional_length[4]; 367 uint8_t transport_id[]; 368 }; 369 370 struct scsi_per_res_in_full 371 { 372 struct scsi_per_res_in_header header; 373 struct scsi_per_res_in_full_desc desc[]; 374 }; 375 376 struct scsi_per_res_out 377 { 378 u_int8_t opcode; 379 u_int8_t action; 380 #define SPRO_REGISTER 0x00 381 #define SPRO_RESERVE 0x01 382 #define SPRO_RELEASE 0x02 383 #define SPRO_CLEAR 0x03 384 #define SPRO_PREEMPT 0x04 385 #define SPRO_PRE_ABO 0x05 386 #define SPRO_REG_IGNO 0x06 387 #define SPRO_REG_MOVE 0x07 388 #define SPRO_REPL_LOST_RES 0x08 389 #define SPRO_ACTION_MASK 0x1f 390 u_int8_t scope_type; 391 #define SPR_SCOPE_MASK 0xf0 392 #define SPR_SCOPE_SHIFT 4 393 #define SPR_LU_SCOPE 0x00 394 #define SPR_EXTENT_SCOPE 0x10 395 #define SPR_ELEMENT_SCOPE 0x20 396 #define SPR_TYPE_MASK 0x0f 397 #define SPR_TYPE_RD_SHARED 0x00 398 #define SPR_TYPE_WR_EX 0x01 399 #define SPR_TYPE_RD_EX 0x02 400 #define SPR_TYPE_EX_AC 0x03 401 #define SPR_TYPE_SHARED 0x04 402 #define SPR_TYPE_WR_EX_RO 0x05 403 #define SPR_TYPE_EX_AC_RO 0x06 404 #define SPR_TYPE_WR_EX_AR 0x07 405 #define SPR_TYPE_EX_AC_AR 0x08 406 u_int8_t reserved[2]; 407 u_int8_t length[4]; 408 u_int8_t control; 409 }; 410 411 struct scsi_per_res_out_parms 412 { 413 struct scsi_per_res_key res_key; 414 u_int8_t serv_act_res_key[8]; 415 u_int8_t scope_spec_address[4]; 416 u_int8_t flags; 417 #define SPR_SPEC_I_PT 0x08 418 #define SPR_ALL_TG_PT 0x04 419 #define SPR_APTPL 0x01 420 u_int8_t reserved1; 421 u_int8_t extent_length[2]; 422 u_int8_t transport_id_list[]; 423 }; 424 425 struct scsi_per_res_out_trans_ids { 426 u_int8_t additional_length[4]; 427 u_int8_t transport_ids[]; 428 }; 429 430 /* 431 * Used with REGISTER AND MOVE serivce action of the PERSISTENT RESERVE OUT 432 * command. 433 */ 434 struct scsi_per_res_reg_move 435 { 436 struct scsi_per_res_key res_key; 437 u_int8_t serv_act_res_key[8]; 438 u_int8_t reserved; 439 u_int8_t flags; 440 #define SPR_REG_MOVE_UNREG 0x02 441 #define SPR_REG_MOVE_APTPL 0x01 442 u_int8_t rel_trgt_port_id[2]; 443 u_int8_t transport_id_length[4]; 444 u_int8_t transport_id[]; 445 }; 446 447 struct scsi_transportid_header 448 { 449 uint8_t format_protocol; 450 #define SCSI_TRN_FORMAT_MASK 0xc0 451 #define SCSI_TRN_FORMAT_SHIFT 6 452 #define SCSI_TRN_PROTO_MASK 0x0f 453 }; 454 455 struct scsi_transportid_fcp 456 { 457 uint8_t format_protocol; 458 #define SCSI_TRN_FCP_FORMAT_DEFAULT 0x00 459 uint8_t reserved1[7]; 460 uint8_t n_port_name[8]; 461 uint8_t reserved2[8]; 462 }; 463 464 struct scsi_transportid_spi 465 { 466 uint8_t format_protocol; 467 #define SCSI_TRN_SPI_FORMAT_DEFAULT 0x00 468 uint8_t reserved1; 469 uint8_t scsi_addr[2]; 470 uint8_t obsolete[2]; 471 uint8_t rel_trgt_port_id[2]; 472 uint8_t reserved2[16]; 473 }; 474 475 struct scsi_transportid_1394 476 { 477 uint8_t format_protocol; 478 #define SCSI_TRN_1394_FORMAT_DEFAULT 0x00 479 uint8_t reserved1[7]; 480 uint8_t eui64[8]; 481 uint8_t reserved2[8]; 482 }; 483 484 struct scsi_transportid_rdma 485 { 486 uint8_t format_protocol; 487 #define SCSI_TRN_RDMA_FORMAT_DEFAULT 0x00 488 uint8_t reserved[7]; 489 #define SCSI_TRN_RDMA_PORT_LEN 16 490 uint8_t initiator_port_id[SCSI_TRN_RDMA_PORT_LEN]; 491 }; 492 493 struct scsi_transportid_iscsi_device 494 { 495 uint8_t format_protocol; 496 #define SCSI_TRN_ISCSI_FORMAT_DEVICE 0x00 497 uint8_t reserved; 498 uint8_t additional_length[2]; 499 uint8_t iscsi_name[]; 500 }; 501 502 struct scsi_transportid_iscsi_port 503 { 504 uint8_t format_protocol; 505 #define SCSI_TRN_ISCSI_FORMAT_PORT 0x40 506 uint8_t reserved; 507 uint8_t additional_length[2]; 508 uint8_t iscsi_name[]; 509 /* 510 * Followed by a separator and iSCSI initiator session ID 511 */ 512 }; 513 514 struct scsi_transportid_sas 515 { 516 uint8_t format_protocol; 517 #define SCSI_TRN_SAS_FORMAT_DEFAULT 0x00 518 uint8_t reserved1[3]; 519 uint8_t sas_address[8]; 520 uint8_t reserved2[12]; 521 }; 522 523 struct scsi_sop_routing_id_norm { 524 uint8_t bus; 525 uint8_t devfunc; 526 #define SCSI_TRN_SOP_BUS_MAX 0xff 527 #define SCSI_TRN_SOP_DEV_MAX 0x1f 528 #define SCSI_TRN_SOP_DEV_MASK 0xf8 529 #define SCSI_TRN_SOP_DEV_SHIFT 3 530 #define SCSI_TRN_SOP_FUNC_NORM_MASK 0x07 531 #define SCSI_TRN_SOP_FUNC_NORM_MAX 0x07 532 }; 533 534 struct scsi_sop_routing_id_alt { 535 uint8_t bus; 536 uint8_t function; 537 #define SCSI_TRN_SOP_FUNC_ALT_MAX 0xff 538 }; 539 540 struct scsi_transportid_sop 541 { 542 uint8_t format_protocol; 543 #define SCSI_TRN_SOP_FORMAT_DEFAULT 0x00 544 uint8_t reserved1; 545 uint8_t routing_id[2]; 546 uint8_t reserved2[20]; 547 }; 548 549 struct scsi_log_sense 550 { 551 u_int8_t opcode; 552 u_int8_t byte2; 553 #define SLS_SP 0x01 554 #define SLS_PPC 0x02 555 u_int8_t page; 556 #define SLS_PAGE_CODE 0x3F 557 #define SLS_SUPPORTED_PAGES_PAGE 0x00 558 #define SLS_OVERRUN_PAGE 0x01 559 #define SLS_ERROR_WRITE_PAGE 0x02 560 #define SLS_ERROR_READ_PAGE 0x03 561 #define SLS_ERROR_READREVERSE_PAGE 0x04 562 #define SLS_ERROR_VERIFY_PAGE 0x05 563 #define SLS_ERROR_NONMEDIUM_PAGE 0x06 564 #define SLS_ERROR_LASTN_PAGE 0x07 565 #define SLS_LOGICAL_BLOCK_PROVISIONING 0x0c 566 #define SLS_SELF_TEST_PAGE 0x10 567 #define SLS_STAT_AND_PERF 0x19 568 #define SLS_IE_PAGE 0x2f 569 #define SLS_PAGE_CTRL_MASK 0xC0 570 #define SLS_PAGE_CTRL_THRESHOLD 0x00 571 #define SLS_PAGE_CTRL_CUMULATIVE 0x40 572 #define SLS_PAGE_CTRL_THRESH_DEFAULT 0x80 573 #define SLS_PAGE_CTRL_CUMUL_DEFAULT 0xC0 574 u_int8_t subpage; 575 #define SLS_SUPPORTED_SUBPAGES_SUBPAGE 0xff 576 u_int8_t reserved; 577 u_int8_t paramptr[2]; 578 u_int8_t length[2]; 579 u_int8_t control; 580 }; 581 582 struct scsi_log_select 583 { 584 u_int8_t opcode; 585 u_int8_t byte2; 586 /* SLS_SP 0x01 */ 587 #define SLS_PCR 0x02 588 u_int8_t page; 589 /* SLS_PAGE_CTRL_MASK 0xC0 */ 590 /* SLS_PAGE_CTRL_THRESHOLD 0x00 */ 591 /* SLS_PAGE_CTRL_CUMULATIVE 0x40 */ 592 /* SLS_PAGE_CTRL_THRESH_DEFAULT 0x80 */ 593 /* SLS_PAGE_CTRL_CUMUL_DEFAULT 0xC0 */ 594 u_int8_t reserved[4]; 595 u_int8_t length[2]; 596 u_int8_t control; 597 }; 598 599 struct scsi_log_header 600 { 601 u_int8_t page; 602 #define SL_PAGE_CODE 0x3F 603 #define SL_SPF 0x40 604 #define SL_DS 0x80 605 u_int8_t subpage; 606 u_int8_t datalen[2]; 607 }; 608 609 struct scsi_log_param_header { 610 u_int8_t param_code[2]; 611 u_int8_t param_control; 612 #define SLP_LP 0x01 613 #define SLP_LBIN 0x02 614 #define SLP_TMC_MASK 0x0C 615 #define SLP_TMC_ALWAYS 0x00 616 #define SLP_TMC_EQUAL 0x04 617 #define SLP_TMC_NOTEQUAL 0x08 618 #define SLP_TMC_GREATER 0x0C 619 #define SLP_ETC 0x10 620 #define SLP_TSD 0x20 621 #define SLP_DS 0x40 622 #define SLP_DU 0x80 623 u_int8_t param_len; 624 }; 625 626 struct scsi_log_stat_and_perf { 627 struct scsi_log_param_header hdr; 628 #define SLP_SAP 0x0001 629 uint8_t read_num[8]; 630 uint8_t write_num[8]; 631 uint8_t recvieved_lba[8]; 632 uint8_t transmitted_lba[8]; 633 uint8_t read_int[8]; 634 uint8_t write_int[8]; 635 uint8_t weighted_num[8]; 636 uint8_t weighted_int[8]; 637 }; 638 639 struct scsi_log_idle_time { 640 struct scsi_log_param_header hdr; 641 #define SLP_IT 0x0002 642 uint8_t idle_int[8]; 643 }; 644 645 struct scsi_log_time_interval { 646 struct scsi_log_param_header hdr; 647 #define SLP_TI 0x0003 648 uint8_t exponent[4]; 649 uint8_t integer[4]; 650 }; 651 652 struct scsi_log_fua_stat_and_perf { 653 struct scsi_log_param_header hdr; 654 #define SLP_FUA_SAP 0x0004 655 uint8_t fua_read_num[8]; 656 uint8_t fua_write_num[8]; 657 uint8_t fuanv_read_num[8]; 658 uint8_t fuanv_write_num[8]; 659 uint8_t fua_read_int[8]; 660 uint8_t fua_write_int[8]; 661 uint8_t fuanv_read_int[8]; 662 uint8_t fuanv_write_int[8]; 663 }; 664 665 struct scsi_control_page { 666 u_int8_t page_code; 667 u_int8_t page_length; 668 u_int8_t rlec; 669 #define SCP_RLEC 0x01 /*Report Log Exception Cond*/ 670 #define SCP_GLTSD 0x02 /*Global Logging target 671 save disable */ 672 #define SCP_DSENSE 0x04 /*Descriptor Sense */ 673 #define SCP_DPICZ 0x08 /*Disable Prot. Info Check 674 if Prot. Field is Zero */ 675 #define SCP_TMF_ONLY 0x10 /*TM Functions Only*/ 676 #define SCP_TST_MASK 0xE0 /*Task Set Type Mask*/ 677 #define SCP_TST_ONE 0x00 /*One Task Set*/ 678 #define SCP_TST_SEPARATE 0x20 /*Separate Task Sets*/ 679 u_int8_t queue_flags; 680 #define SCP_QUEUE_ALG_MASK 0xF0 681 #define SCP_QUEUE_ALG_RESTRICTED 0x00 682 #define SCP_QUEUE_ALG_UNRESTRICTED 0x10 683 #define SCP_NUAR 0x08 /*No UA on release*/ 684 #define SCP_QUEUE_ERR 0x02 /*Queued I/O aborted for CACs*/ 685 #define SCP_QUEUE_DQUE 0x01 /*Queued I/O disabled*/ 686 u_int8_t eca_and_aen; 687 #define SCP_EECA 0x80 /*Enable Extended CA*/ 688 #define SCP_RAC 0x40 /*Report a check*/ 689 #define SCP_SWP 0x08 /*Software Write Protect*/ 690 #define SCP_RAENP 0x04 /*Ready AEN Permission*/ 691 #define SCP_UAAENP 0x02 /*UA AEN Permission*/ 692 #define SCP_EAENP 0x01 /*Error AEN Permission*/ 693 u_int8_t flags4; 694 #define SCP_ATO 0x80 /*Application tag owner*/ 695 #define SCP_TAS 0x40 /*Task aborted status*/ 696 #define SCP_ATMPE 0x20 /*Application tag mode page*/ 697 #define SCP_RWWP 0x10 /*Reject write without prot*/ 698 u_int8_t aen_holdoff_period[2]; 699 u_int8_t busy_timeout_period[2]; 700 u_int8_t extended_selftest_completion_time[2]; 701 }; 702 703 struct scsi_cache_page { 704 u_int8_t page_code; 705 #define SCHP_PAGE_SAVABLE 0x80 /* Page is savable */ 706 u_int8_t page_length; 707 u_int8_t cache_flags; 708 #define SCHP_FLAGS_WCE 0x04 /* Write Cache Enable */ 709 #define SCHP_FLAGS_MF 0x02 /* Multiplication factor */ 710 #define SCHP_FLAGS_RCD 0x01 /* Read Cache Disable */ 711 u_int8_t rw_cache_policy; 712 u_int8_t dis_prefetch[2]; 713 u_int8_t min_prefetch[2]; 714 u_int8_t max_prefetch[2]; 715 u_int8_t max_prefetch_ceil[2]; 716 }; 717 718 /* 719 * XXX KDM 720 * Updated version of the cache page, as of SBC. Update this to SBC-3 and 721 * rationalize the two. 722 */ 723 struct scsi_caching_page { 724 uint8_t page_code; 725 #define SMS_CACHING_PAGE 0x08 726 uint8_t page_length; 727 uint8_t flags1; 728 #define SCP_IC 0x80 729 #define SCP_ABPF 0x40 730 #define SCP_CAP 0x20 731 #define SCP_DISC 0x10 732 #define SCP_SIZE 0x08 733 #define SCP_WCE 0x04 734 #define SCP_MF 0x02 735 #define SCP_RCD 0x01 736 uint8_t ret_priority; 737 uint8_t disable_pf_transfer_len[2]; 738 uint8_t min_prefetch[2]; 739 uint8_t max_prefetch[2]; 740 uint8_t max_pf_ceiling[2]; 741 uint8_t flags2; 742 #define SCP_FSW 0x80 743 #define SCP_LBCSS 0x40 744 #define SCP_DRA 0x20 745 #define SCP_VS1 0x10 746 #define SCP_VS2 0x08 747 uint8_t cache_segments; 748 uint8_t cache_seg_size[2]; 749 uint8_t reserved; 750 uint8_t non_cache_seg_size[3]; 751 }; 752 753 /* 754 * XXX KDM move this off to a vendor shim. 755 */ 756 struct copan_debugconf_subpage { 757 uint8_t page_code; 758 #define DBGCNF_PAGE_CODE 0x00 759 uint8_t subpage; 760 #define DBGCNF_SUBPAGE_CODE 0xF0 761 uint8_t page_length[2]; 762 uint8_t page_version; 763 #define DBGCNF_VERSION 0x00 764 uint8_t ctl_time_io_secs[2]; 765 }; 766 767 768 struct scsi_info_exceptions_page { 769 u_int8_t page_code; 770 #define SIEP_PAGE_SAVABLE 0x80 /* Page is savable */ 771 u_int8_t page_length; 772 u_int8_t info_flags; 773 #define SIEP_FLAGS_PERF 0x80 774 #define SIEP_FLAGS_EBF 0x20 775 #define SIEP_FLAGS_EWASC 0x10 776 #define SIEP_FLAGS_DEXCPT 0x08 777 #define SIEP_FLAGS_TEST 0x04 778 #define SIEP_FLAGS_EBACKERR 0x02 779 #define SIEP_FLAGS_LOGERR 0x01 780 u_int8_t mrie; 781 u_int8_t interval_timer[4]; 782 u_int8_t report_count[4]; 783 }; 784 785 struct scsi_logical_block_provisioning_page_descr { 786 uint8_t flags; 787 #define SLBPPD_ENABLED 0x80 788 #define SLBPPD_TYPE_MASK 0x38 789 #define SLBPPD_ARMING_MASK 0x07 790 #define SLBPPD_ARMING_DEC 0x02 791 #define SLBPPD_ARMING_INC 0x01 792 uint8_t resource; 793 uint8_t reserved[2]; 794 uint8_t count[4]; 795 }; 796 797 struct scsi_logical_block_provisioning_page { 798 uint8_t page_code; 799 uint8_t subpage_code; 800 uint8_t page_length[2]; 801 uint8_t flags; 802 #define SLBPP_SITUA 0x01 803 uint8_t reserved[11]; 804 struct scsi_logical_block_provisioning_page_descr descr[0]; 805 }; 806 807 /* 808 * SCSI protocol identifier values, current as of SPC4r36l. 809 */ 810 #define SCSI_PROTO_FC 0x00 /* Fibre Channel */ 811 #define SCSI_PROTO_SPI 0x01 /* Parallel SCSI */ 812 #define SCSI_PROTO_SSA 0x02 /* Serial Storage Arch. */ 813 #define SCSI_PROTO_1394 0x03 /* IEEE 1394 (Firewire) */ 814 #define SCSI_PROTO_RDMA 0x04 /* SCSI RDMA Protocol */ 815 #define SCSI_PROTO_ISCSI 0x05 /* Internet SCSI */ 816 #define SCSI_PROTO_iSCSI 0x05 /* Internet SCSI */ 817 #define SCSI_PROTO_SAS 0x06 /* SAS Serial SCSI Protocol */ 818 #define SCSI_PROTO_ADT 0x07 /* Automation/Drive Int. Trans. Prot.*/ 819 #define SCSI_PROTO_ADITP 0x07 /* Automation/Drive Int. Trans. Prot.*/ 820 #define SCSI_PROTO_ATA 0x08 /* AT Attachment Interface */ 821 #define SCSI_PROTO_UAS 0x09 /* USB Atached SCSI */ 822 #define SCSI_PROTO_SOP 0x0a /* SCSI over PCI Express */ 823 #define SCSI_PROTO_NONE 0x0f /* No specific protocol */ 824 825 struct scsi_proto_specific_page { 826 u_int8_t page_code; 827 #define SPSP_PAGE_SAVABLE 0x80 /* Page is savable */ 828 u_int8_t page_length; 829 u_int8_t protocol; 830 #define SPSP_PROTO_FC SCSI_PROTO_FC 831 #define SPSP_PROTO_SPI SCSI_PROTO_SPI 832 #define SPSP_PROTO_SSA SCSI_PROTO_SSA 833 #define SPSP_PROTO_1394 SCSI_PROTO_1394 834 #define SPSP_PROTO_RDMA SCSI_PROTO_RDMA 835 #define SPSP_PROTO_ISCSI SCSI_PROTO_ISCSI 836 #define SPSP_PROTO_SAS SCSI_PROTO_SAS 837 #define SPSP_PROTO_ADT SCSI_PROTO_ADITP 838 #define SPSP_PROTO_ATA SCSI_PROTO_ATA 839 #define SPSP_PROTO_UAS SCSI_PROTO_UAS 840 #define SPSP_PROTO_SOP SCSI_PROTO_SOP 841 #define SPSP_PROTO_NONE SCSI_PROTO_NONE 842 }; 843 844 struct scsi_reserve 845 { 846 u_int8_t opcode; 847 u_int8_t byte2; 848 #define SR_EXTENT 0x01 849 #define SR_ID_MASK 0x0e 850 #define SR_3RDPTY 0x10 851 #define SR_LUN_MASK 0xe0 852 u_int8_t resv_id; 853 u_int8_t length[2]; 854 u_int8_t control; 855 }; 856 857 struct scsi_reserve_10 { 858 uint8_t opcode; 859 uint8_t byte2; 860 #define SR10_3RDPTY 0x10 861 #define SR10_LONGID 0x02 862 #define SR10_EXTENT 0x01 863 uint8_t resv_id; 864 uint8_t thirdparty_id; 865 uint8_t reserved[3]; 866 uint8_t length[2]; 867 uint8_t control; 868 }; 869 870 871 struct scsi_release 872 { 873 u_int8_t opcode; 874 u_int8_t byte2; 875 u_int8_t resv_id; 876 u_int8_t unused[1]; 877 u_int8_t length; 878 u_int8_t control; 879 }; 880 881 struct scsi_release_10 { 882 uint8_t opcode; 883 uint8_t byte2; 884 uint8_t resv_id; 885 uint8_t thirdparty_id; 886 uint8_t reserved[3]; 887 uint8_t length[2]; 888 uint8_t control; 889 }; 890 891 struct scsi_prevent 892 { 893 u_int8_t opcode; 894 u_int8_t byte2; 895 u_int8_t unused[2]; 896 u_int8_t how; 897 u_int8_t control; 898 }; 899 #define PR_PREVENT 0x01 900 #define PR_ALLOW 0x00 901 902 struct scsi_sync_cache 903 { 904 u_int8_t opcode; 905 u_int8_t byte2; 906 #define SSC_IMMED 0x02 907 #define SSC_RELADR 0x01 908 u_int8_t begin_lba[4]; 909 u_int8_t reserved; 910 u_int8_t lb_count[2]; 911 u_int8_t control; 912 }; 913 914 struct scsi_sync_cache_16 915 { 916 uint8_t opcode; 917 uint8_t byte2; 918 uint8_t begin_lba[8]; 919 uint8_t lb_count[4]; 920 uint8_t reserved; 921 uint8_t control; 922 }; 923 924 struct scsi_format { 925 uint8_t opcode; 926 uint8_t byte2; 927 #define SF_LONGLIST 0x20 928 #define SF_FMTDATA 0x10 929 #define SF_CMPLIST 0x08 930 #define SF_FORMAT_MASK 0x07 931 #define SF_FORMAT_BLOCK 0x00 932 #define SF_FORMAT_LONG_BLOCK 0x03 933 #define SF_FORMAT_BFI 0x04 934 #define SF_FORMAT_PHYS 0x05 935 uint8_t vendor; 936 uint8_t interleave[2]; 937 uint8_t control; 938 }; 939 940 struct scsi_format_header_short { 941 uint8_t reserved; 942 #define SF_DATA_FOV 0x80 943 #define SF_DATA_DPRY 0x40 944 #define SF_DATA_DCRT 0x20 945 #define SF_DATA_STPF 0x10 946 #define SF_DATA_IP 0x08 947 #define SF_DATA_DSP 0x04 948 #define SF_DATA_IMMED 0x02 949 #define SF_DATA_VS 0x01 950 uint8_t byte2; 951 uint8_t defect_list_len[2]; 952 }; 953 954 struct scsi_format_header_long { 955 uint8_t reserved; 956 uint8_t byte2; 957 uint8_t reserved2[2]; 958 uint8_t defect_list_len[4]; 959 }; 960 961 struct scsi_changedef 962 { 963 u_int8_t opcode; 964 u_int8_t byte2; 965 u_int8_t unused1; 966 u_int8_t how; 967 u_int8_t unused[4]; 968 u_int8_t datalen; 969 u_int8_t control; 970 }; 971 972 struct scsi_read_buffer 973 { 974 u_int8_t opcode; 975 u_int8_t byte2; 976 #define RWB_MODE 0x1F 977 #define RWB_MODE_HDR_DATA 0x00 978 #define RWB_MODE_VENDOR 0x01 979 #define RWB_MODE_DATA 0x02 980 #define RWB_MODE_DESCR 0x03 981 #define RWB_MODE_DOWNLOAD 0x04 982 #define RWB_MODE_DOWNLOAD_SAVE 0x05 983 #define RWB_MODE_ECHO 0x0A 984 #define RWB_MODE_ECHO_DESCR 0x0B 985 #define RWB_MODE_ERROR_HISTORY 0x1C 986 u_int8_t buffer_id; 987 u_int8_t offset[3]; 988 u_int8_t length[3]; 989 u_int8_t control; 990 }; 991 992 struct scsi_write_buffer 993 { 994 u_int8_t opcode; 995 u_int8_t byte2; 996 u_int8_t buffer_id; 997 u_int8_t offset[3]; 998 u_int8_t length[3]; 999 u_int8_t control; 1000 }; 1001 1002 struct scsi_read_attribute 1003 { 1004 u_int8_t opcode; 1005 u_int8_t service_action; 1006 #define SRA_SA_ATTR_VALUES 0x00 1007 #define SRA_SA_ATTR_LIST 0x01 1008 #define SRA_SA_LOG_VOL_LIST 0x02 1009 #define SRA_SA_PART_LIST 0x03 1010 #define SRA_SA_RESTRICTED 0x04 1011 #define SRA_SA_SUPPORTED_ATTRS 0x05 1012 #define SRA_SA_MASK 0x1f 1013 u_int8_t element[2]; 1014 u_int8_t elem_type; 1015 u_int8_t logical_volume; 1016 u_int8_t reserved1; 1017 u_int8_t partition; 1018 u_int8_t first_attribute[2]; 1019 u_int8_t length[4]; 1020 u_int8_t cache; 1021 #define SRA_CACHE 0x01 1022 u_int8_t control; 1023 }; 1024 1025 struct scsi_write_attribute 1026 { 1027 u_int8_t opcode; 1028 u_int8_t byte2; 1029 #define SWA_WTC 0x01 1030 u_int8_t element[3]; 1031 u_int8_t logical_volume; 1032 u_int8_t reserved1; 1033 u_int8_t partition; 1034 u_int8_t reserved2[2]; 1035 u_int8_t length[4]; 1036 u_int8_t reserved3; 1037 u_int8_t control; 1038 }; 1039 1040 1041 struct scsi_read_attribute_values 1042 { 1043 u_int8_t length[4]; 1044 u_int8_t attribute_0[0]; 1045 }; 1046 1047 struct scsi_mam_attribute_header 1048 { 1049 u_int8_t id[2]; 1050 /* 1051 * Attributes obtained from SPC-4r36g (section 7.4.2.2) and 1052 * SSC-4r03 (section 4.2.21). 1053 */ 1054 #define SMA_ATTR_ID_DEVICE_MIN 0x0000 1055 1056 #define SMA_ATTR_REM_CAP_PARTITION 0x0000 1057 #define SMA_ATTR_MAX_CAP_PARTITION 0x0001 1058 #define SMA_ATTR_TAPEALERT_FLAGS 0x0002 1059 #define SMA_ATTR_LOAD_COUNT 0x0003 1060 #define SMA_ATTR_MAM_SPACE_REMAINING 0x0004 1061 1062 #define SMA_ATTR_DEV_ASSIGNING_ORG 0x0005 1063 #define SMA_ATTR_FORMAT_DENSITY_CODE 0x0006 1064 #define SMA_ATTR_INITIALIZATION_COUNT 0x0007 1065 #define SMA_ATTR_VOLUME_ID 0x0008 1066 #define SMA_ATTR_VOLUME_CHANGE_REF 0x0009 1067 1068 #define SMA_ATTR_DEV_SERIAL_LAST_LOAD 0x020a 1069 #define SMA_ATTR_DEV_SERIAL_LAST_LOAD_1 0x020b 1070 #define SMA_ATTR_DEV_SERIAL_LAST_LOAD_2 0x020c 1071 #define SMA_ATTR_DEV_SERIAL_LAST_LOAD_3 0x020d 1072 1073 #define SMA_ATTR_TOTAL_MB_WRITTEN_LT 0x0220 1074 #define SMA_ATTR_TOTAL_MB_READ_LT 0x0221 1075 #define SMA_ATTR_TOTAL_MB_WRITTEN_CUR 0x0222 1076 #define SMA_ATTR_TOTAL_MB_READ_CUR 0x0223 1077 #define SMA_ATTR_FIRST_ENC_BLOCK 0x0224 1078 #define SMA_ATTR_NEXT_UNENC_BLOCK 0x0225 1079 1080 #define SMA_ATTR_MEDIUM_USAGE_HIST 0x0340 1081 #define SMA_ATTR_PART_USAGE_HIST 0x0341 1082 1083 #define SMA_ATTR_ID_DEVICE_MAX 0x03ff 1084 1085 #define SMA_ATTR_ID_MEDIUM_MIN 0x0400 1086 1087 #define SMA_ATTR_MED_MANUF 0x0400 1088 #define SMA_ATTR_MED_SERIAL 0x0401 1089 1090 #define SMA_ATTR_MED_LENGTH 0x0402 1091 #define SMA_ATTR_MED_WIDTH 0x0403 1092 #define SMA_ATTR_MED_ASSIGNING_ORG 0x0404 1093 #define SMA_ATTR_MED_DENSITY_CODE 0x0405 1094 1095 #define SMA_ATTR_MED_MANUF_DATE 0x0406 1096 #define SMA_ATTR_MAM_CAPACITY 0x0407 1097 #define SMA_ATTR_MED_TYPE 0x0408 1098 #define SMA_ATTR_MED_TYPE_INFO 0x0409 1099 #define SMA_ATTR_MED_SERIAL_NUM 0x040a 1100 1101 #define SMA_ATTR_ID_MEDIUM_MAX 0x07ff 1102 1103 #define SMA_ATTR_ID_HOST_MIN 0x0800 1104 1105 #define SMA_ATTR_APP_VENDOR 0x0800 1106 #define SMA_ATTR_APP_NAME 0x0801 1107 #define SMA_ATTR_APP_VERSION 0x0802 1108 #define SMA_ATTR_USER_MED_TEXT_LABEL 0x0803 1109 #define SMA_ATTR_LAST_WRITTEN_TIME 0x0804 1110 #define SMA_ATTR_TEXT_LOCAL_ID 0x0805 1111 #define SMA_ATTR_BARCODE 0x0806 1112 #define SMA_ATTR_HOST_OWNER_NAME 0x0807 1113 #define SMA_ATTR_MEDIA_POOL 0x0808 1114 #define SMA_ATTR_PART_USER_LABEL 0x0809 1115 #define SMA_ATTR_LOAD_UNLOAD_AT_PART 0x080a 1116 #define SMA_ATTR_APP_FORMAT_VERSION 0x080b 1117 #define SMA_ATTR_VOL_COHERENCY_INFO 0x080c 1118 1119 #define SMA_ATTR_ID_HOST_MAX 0x0bff 1120 1121 #define SMA_ATTR_VENDOR_DEVICE_MIN 0x0c00 1122 #define SMA_ATTR_VENDOR_DEVICE_MAX 0x0fff 1123 #define SMA_ATTR_VENDOR_MEDIUM_MIN 0x1000 1124 #define SMA_ATTR_VENDOR_MEDIUM_MAX 0x13ff 1125 #define SMA_ATTR_VENDOR_HOST_MIN 0x1400 1126 #define SMA_ATTR_VENDOR_HOST_MAX 0x17ff 1127 u_int8_t byte2; 1128 #define SMA_FORMAT_BINARY 0x00 1129 #define SMA_FORMAT_ASCII 0x01 1130 #define SMA_FORMAT_TEXT 0x02 1131 #define SMA_FORMAT_MASK 0x03 1132 #define SMA_READ_ONLY 0x80 1133 u_int8_t length[2]; 1134 u_int8_t attribute[0]; 1135 }; 1136 1137 struct scsi_attrib_list_header { 1138 u_int8_t length[4]; 1139 u_int8_t first_attr_0[0]; 1140 }; 1141 1142 struct scsi_attrib_lv_list { 1143 u_int8_t length[2]; 1144 u_int8_t first_lv_number; 1145 u_int8_t num_logical_volumes; 1146 }; 1147 1148 struct scsi_attrib_vendser { 1149 uint8_t vendor[8]; 1150 uint8_t serial_num[32]; 1151 }; 1152 1153 /* 1154 * These values are used to decode the Volume Coherency Information 1155 * Attribute (0x080c) for LTFS-format coherency information. 1156 * Although the Application Client Specific lengths are different for 1157 * Version 0 and Version 1, the data is in fact the same. The length 1158 * difference was due to a code bug. 1159 */ 1160 #define SCSI_LTFS_VER0_LEN 42 1161 #define SCSI_LTFS_VER1_LEN 43 1162 #define SCSI_LTFS_UUID_LEN 36 1163 #define SCSI_LTFS_STR_NAME "LTFS" 1164 #define SCSI_LTFS_STR_LEN 4 1165 1166 typedef enum { 1167 SCSI_ATTR_FLAG_NONE = 0x00, 1168 SCSI_ATTR_FLAG_HEX = 0x01, 1169 SCSI_ATTR_FLAG_FP = 0x02, 1170 SCSI_ATTR_FLAG_DIV_10 = 0x04, 1171 SCSI_ATTR_FLAG_FP_1DIGIT = 0x08 1172 } scsi_attrib_flags; 1173 1174 typedef enum { 1175 SCSI_ATTR_OUTPUT_NONE = 0x00, 1176 SCSI_ATTR_OUTPUT_TEXT_MASK = 0x03, 1177 SCSI_ATTR_OUTPUT_TEXT_RAW = 0x00, 1178 SCSI_ATTR_OUTPUT_TEXT_ESC = 0x01, 1179 SCSI_ATTR_OUTPUT_TEXT_RSV1 = 0x02, 1180 SCSI_ATTR_OUTPUT_TEXT_RSV2 = 0x03, 1181 SCSI_ATTR_OUTPUT_NONASCII_MASK = 0x0c, 1182 SCSI_ATTR_OUTPUT_NONASCII_TRIM = 0x00, 1183 SCSI_ATTR_OUTPUT_NONASCII_ESC = 0x04, 1184 SCSI_ATTR_OUTPUT_NONASCII_RAW = 0x08, 1185 SCSI_ATTR_OUTPUT_NONASCII_RSV1 = 0x0c, 1186 SCSI_ATTR_OUTPUT_FIELD_MASK = 0xf0, 1187 SCSI_ATTR_OUTPUT_FIELD_ALL = 0xf0, 1188 SCSI_ATTR_OUTPUT_FIELD_NONE = 0x00, 1189 SCSI_ATTR_OUTPUT_FIELD_DESC = 0x10, 1190 SCSI_ATTR_OUTPUT_FIELD_NUM = 0x20, 1191 SCSI_ATTR_OUTPUT_FIELD_SIZE = 0x40, 1192 SCSI_ATTR_OUTPUT_FIELD_RW = 0x80 1193 } scsi_attrib_output_flags; 1194 1195 struct sbuf; 1196 1197 struct scsi_attrib_table_entry 1198 { 1199 u_int32_t id; 1200 u_int32_t flags; 1201 const char *desc; 1202 const char *suffix; 1203 int (*to_str)(struct sbuf *sb, struct scsi_mam_attribute_header *hdr, 1204 uint32_t valid_len, uint32_t flags, 1205 uint32_t output_flags, char *error_str, 1206 int error_str_len); 1207 int (*parse_str)(char *str, struct scsi_mam_attribute_header *hdr, 1208 uint32_t alloc_len, uint32_t flags, char *error_str, 1209 int error_str_len); 1210 }; 1211 1212 struct scsi_rw_6 1213 { 1214 u_int8_t opcode; 1215 u_int8_t addr[3]; 1216 /* only 5 bits are valid in the MSB address byte */ 1217 #define SRW_TOPADDR 0x1F 1218 u_int8_t length; 1219 u_int8_t control; 1220 }; 1221 1222 struct scsi_rw_10 1223 { 1224 u_int8_t opcode; 1225 #define SRW10_RELADDR 0x01 1226 /* EBP defined for WRITE(10) only */ 1227 #define SRW10_EBP 0x04 1228 #define SRW10_FUA 0x08 1229 #define SRW10_DPO 0x10 1230 u_int8_t byte2; 1231 u_int8_t addr[4]; 1232 u_int8_t reserved; 1233 u_int8_t length[2]; 1234 u_int8_t control; 1235 }; 1236 1237 struct scsi_rw_12 1238 { 1239 u_int8_t opcode; 1240 #define SRW12_RELADDR 0x01 1241 #define SRW12_FUA 0x08 1242 #define SRW12_DPO 0x10 1243 u_int8_t byte2; 1244 u_int8_t addr[4]; 1245 u_int8_t length[4]; 1246 u_int8_t reserved; 1247 u_int8_t control; 1248 }; 1249 1250 struct scsi_rw_16 1251 { 1252 u_int8_t opcode; 1253 #define SRW16_RELADDR 0x01 1254 #define SRW16_FUA 0x08 1255 #define SRW16_DPO 0x10 1256 u_int8_t byte2; 1257 u_int8_t addr[8]; 1258 u_int8_t length[4]; 1259 u_int8_t reserved; 1260 u_int8_t control; 1261 }; 1262 1263 struct scsi_write_same_10 1264 { 1265 uint8_t opcode; 1266 uint8_t byte2; 1267 #define SWS_LBDATA 0x02 1268 #define SWS_PBDATA 0x04 1269 #define SWS_UNMAP 0x08 1270 #define SWS_ANCHOR 0x10 1271 uint8_t addr[4]; 1272 uint8_t group; 1273 uint8_t length[2]; 1274 uint8_t control; 1275 }; 1276 1277 struct scsi_write_same_16 1278 { 1279 uint8_t opcode; 1280 uint8_t byte2; 1281 #define SWS_NDOB 0x01 1282 uint8_t addr[8]; 1283 uint8_t length[4]; 1284 uint8_t group; 1285 uint8_t control; 1286 }; 1287 1288 struct scsi_unmap 1289 { 1290 uint8_t opcode; 1291 uint8_t byte2; 1292 #define SU_ANCHOR 0x01 1293 uint8_t reserved[4]; 1294 uint8_t group; 1295 uint8_t length[2]; 1296 uint8_t control; 1297 }; 1298 1299 struct scsi_unmap_header 1300 { 1301 uint8_t length[2]; 1302 uint8_t desc_length[2]; 1303 uint8_t reserved[4]; 1304 }; 1305 1306 struct scsi_unmap_desc 1307 { 1308 uint8_t lba[8]; 1309 uint8_t length[4]; 1310 uint8_t reserved[4]; 1311 }; 1312 1313 struct scsi_write_verify_10 1314 { 1315 uint8_t opcode; 1316 uint8_t byte2; 1317 #define SWV_BYTCHK 0x02 1318 #define SWV_DPO 0x10 1319 #define SWV_WRPROECT_MASK 0xe0 1320 uint8_t addr[4]; 1321 uint8_t group; 1322 uint8_t length[2]; 1323 uint8_t control; 1324 }; 1325 1326 struct scsi_write_verify_12 1327 { 1328 uint8_t opcode; 1329 uint8_t byte2; 1330 uint8_t addr[4]; 1331 uint8_t length[4]; 1332 uint8_t group; 1333 uint8_t control; 1334 }; 1335 1336 struct scsi_write_verify_16 1337 { 1338 uint8_t opcode; 1339 uint8_t byte2; 1340 uint8_t addr[8]; 1341 uint8_t length[4]; 1342 uint8_t group; 1343 uint8_t control; 1344 }; 1345 1346 1347 struct scsi_start_stop_unit 1348 { 1349 u_int8_t opcode; 1350 u_int8_t byte2; 1351 #define SSS_IMMED 0x01 1352 u_int8_t reserved[2]; 1353 u_int8_t how; 1354 #define SSS_START 0x01 1355 #define SSS_LOEJ 0x02 1356 #define SSS_PC_MASK 0xf0 1357 #define SSS_PC_START_VALID 0x00 1358 #define SSS_PC_ACTIVE 0x10 1359 #define SSS_PC_IDLE 0x20 1360 #define SSS_PC_STANDBY 0x30 1361 #define SSS_PC_LU_CONTROL 0x70 1362 #define SSS_PC_FORCE_IDLE_0 0xa0 1363 #define SSS_PC_FORCE_STANDBY_0 0xb0 1364 u_int8_t control; 1365 }; 1366 1367 struct ata_pass_12 { 1368 u_int8_t opcode; 1369 u_int8_t protocol; 1370 #define AP_PROTO_HARD_RESET (0x00 << 1) 1371 #define AP_PROTO_SRST (0x01 << 1) 1372 #define AP_PROTO_NON_DATA (0x03 << 1) 1373 #define AP_PROTO_PIO_IN (0x04 << 1) 1374 #define AP_PROTO_PIO_OUT (0x05 << 1) 1375 #define AP_PROTO_DMA (0x06 << 1) 1376 #define AP_PROTO_DMA_QUEUED (0x07 << 1) 1377 #define AP_PROTO_DEVICE_DIAG (0x08 << 1) 1378 #define AP_PROTO_DEVICE_RESET (0x09 << 1) 1379 #define AP_PROTO_UDMA_IN (0x0a << 1) 1380 #define AP_PROTO_UDMA_OUT (0x0b << 1) 1381 #define AP_PROTO_FPDMA (0x0c << 1) 1382 #define AP_PROTO_RESP_INFO (0x0f << 1) 1383 #define AP_MULTI 0xe0 1384 u_int8_t flags; 1385 #define AP_T_LEN 0x03 1386 #define AP_BB 0x04 1387 #define AP_T_DIR 0x08 1388 #define AP_CK_COND 0x20 1389 #define AP_OFFLINE 0x60 1390 u_int8_t features; 1391 u_int8_t sector_count; 1392 u_int8_t lba_low; 1393 u_int8_t lba_mid; 1394 u_int8_t lba_high; 1395 u_int8_t device; 1396 u_int8_t command; 1397 u_int8_t reserved; 1398 u_int8_t control; 1399 }; 1400 1401 struct scsi_maintenance_in 1402 { 1403 uint8_t opcode; 1404 uint8_t byte2; 1405 #define SERVICE_ACTION_MASK 0x1f 1406 #define SA_RPRT_TRGT_GRP 0x0a 1407 uint8_t reserved[4]; 1408 uint8_t length[4]; 1409 uint8_t reserved1; 1410 uint8_t control; 1411 }; 1412 1413 struct scsi_report_supported_opcodes 1414 { 1415 uint8_t opcode; 1416 uint8_t service_action; 1417 uint8_t options; 1418 #define RSO_RCTD 0x80 1419 #define RSO_OPTIONS_MASK 0x07 1420 #define RSO_OPTIONS_ALL 0x00 1421 #define RSO_OPTIONS_OC 0x01 1422 #define RSO_OPTIONS_OC_SA 0x02 1423 uint8_t requested_opcode; 1424 uint8_t requested_service_action[2]; 1425 uint8_t length[4]; 1426 uint8_t reserved1; 1427 uint8_t control; 1428 }; 1429 1430 struct scsi_report_supported_opcodes_timeout 1431 { 1432 uint8_t length[2]; 1433 uint8_t reserved; 1434 uint8_t cmd_specific; 1435 uint8_t nominal_time[4]; 1436 uint8_t recommended_time[4]; 1437 }; 1438 1439 struct scsi_report_supported_opcodes_descr 1440 { 1441 uint8_t opcode; 1442 uint8_t reserved; 1443 uint8_t service_action[2]; 1444 uint8_t reserved2; 1445 uint8_t flags; 1446 #define RSO_SERVACTV 0x01 1447 #define RSO_CTDP 0x02 1448 uint8_t cdb_length[2]; 1449 struct scsi_report_supported_opcodes_timeout timeout[0]; 1450 }; 1451 1452 struct scsi_report_supported_opcodes_all 1453 { 1454 uint8_t length[4]; 1455 struct scsi_report_supported_opcodes_descr descr[0]; 1456 }; 1457 1458 struct scsi_report_supported_opcodes_one 1459 { 1460 uint8_t reserved; 1461 uint8_t support; 1462 #define RSO_ONE_CTDP 0x80 1463 #define RSO_ONE_SUP_MASK 0x07 1464 #define RSO_ONE_SUP_UNAVAIL 0x00 1465 #define RSO_ONE_SUP_NOT_SUP 0x01 1466 #define RSO_ONE_SUP_AVAIL 0x03 1467 #define RSO_ONE_SUP_VENDOR 0x05 1468 uint8_t cdb_length[2]; 1469 uint8_t cdb_usage[]; 1470 }; 1471 1472 struct scsi_report_supported_tmf 1473 { 1474 uint8_t opcode; 1475 uint8_t service_action; 1476 uint8_t reserved[4]; 1477 uint8_t length[4]; 1478 uint8_t reserved1; 1479 uint8_t control; 1480 }; 1481 1482 struct scsi_report_supported_tmf_data 1483 { 1484 uint8_t byte1; 1485 #define RST_WAKES 0x01 1486 #define RST_TRS 0x02 1487 #define RST_QTS 0x04 1488 #define RST_LURS 0x08 1489 #define RST_CTSS 0x10 1490 #define RST_CACAS 0x20 1491 #define RST_ATSS 0x40 1492 #define RST_ATS 0x80 1493 uint8_t byte2; 1494 #define RST_ITNRS 0x01 1495 #define RST_QTSS 0x02 1496 #define RST_QAES 0x04 1497 uint8_t reserved[2]; 1498 }; 1499 1500 struct scsi_report_timestamp 1501 { 1502 uint8_t opcode; 1503 uint8_t service_action; 1504 uint8_t reserved[4]; 1505 uint8_t length[4]; 1506 uint8_t reserved1; 1507 uint8_t control; 1508 }; 1509 1510 struct scsi_report_timestamp_data 1511 { 1512 uint8_t length[2]; 1513 uint8_t origin; 1514 #define RTS_ORIG_MASK 0x00 1515 #define RTS_ORIG_ZERO 0x00 1516 #define RTS_ORIG_SET 0x02 1517 #define RTS_ORIG_OUTSIDE 0x03 1518 uint8_t reserved; 1519 uint8_t timestamp[6]; 1520 uint8_t reserve2[2]; 1521 }; 1522 1523 struct scsi_receive_copy_status_lid1 1524 { 1525 uint8_t opcode; 1526 uint8_t service_action; 1527 #define RCS_RCS_LID1 0x00 1528 uint8_t list_identifier; 1529 uint8_t reserved[7]; 1530 uint8_t length[4]; 1531 uint8_t reserved1; 1532 uint8_t control; 1533 }; 1534 1535 struct scsi_receive_copy_status_lid1_data 1536 { 1537 uint8_t available_data[4]; 1538 uint8_t copy_command_status; 1539 #define RCS_CCS_INPROG 0x00 1540 #define RCS_CCS_COMPLETED 0x01 1541 #define RCS_CCS_ERROR 0x02 1542 uint8_t segments_processed[2]; 1543 uint8_t transfer_count_units; 1544 #define RCS_TC_BYTES 0x00 1545 #define RCS_TC_KBYTES 0x01 1546 #define RCS_TC_MBYTES 0x02 1547 #define RCS_TC_GBYTES 0x03 1548 #define RCS_TC_TBYTES 0x04 1549 #define RCS_TC_PBYTES 0x05 1550 #define RCS_TC_EBYTES 0x06 1551 #define RCS_TC_LBAS 0xf1 1552 uint8_t transfer_count[4]; 1553 }; 1554 1555 struct scsi_receive_copy_failure_details 1556 { 1557 uint8_t opcode; 1558 uint8_t service_action; 1559 #define RCS_RCFD 0x04 1560 uint8_t list_identifier; 1561 uint8_t reserved[7]; 1562 uint8_t length[4]; 1563 uint8_t reserved1; 1564 uint8_t control; 1565 }; 1566 1567 struct scsi_receive_copy_failure_details_data 1568 { 1569 uint8_t available_data[4]; 1570 uint8_t reserved[52]; 1571 uint8_t copy_command_status; 1572 uint8_t reserved2; 1573 uint8_t sense_data_length[2]; 1574 uint8_t sense_data[]; 1575 }; 1576 1577 struct scsi_receive_copy_status_lid4 1578 { 1579 uint8_t opcode; 1580 uint8_t service_action; 1581 #define RCS_RCS_LID4 0x05 1582 uint8_t list_identifier[4]; 1583 uint8_t reserved[4]; 1584 uint8_t length[4]; 1585 uint8_t reserved1; 1586 uint8_t control; 1587 }; 1588 1589 struct scsi_receive_copy_status_lid4_data 1590 { 1591 uint8_t available_data[4]; 1592 uint8_t response_to_service_action; 1593 uint8_t copy_command_status; 1594 #define RCS_CCS_COMPLETED_PROD 0x03 1595 #define RCS_CCS_COMPLETED_RESID 0x04 1596 #define RCS_CCS_INPROG_FGBG 0x10 1597 #define RCS_CCS_INPROG_FG 0x11 1598 #define RCS_CCS_INPROG_BG 0x12 1599 #define RCS_CCS_ABORTED 0x60 1600 uint8_t operation_counter[2]; 1601 uint8_t estimated_status_update_delay[4]; 1602 uint8_t extended_copy_completion_status; 1603 uint8_t length_of_the_sense_data_field; 1604 uint8_t sense_data_length; 1605 uint8_t transfer_count_units; 1606 uint8_t transfer_count[8]; 1607 uint8_t segments_processed[2]; 1608 uint8_t reserved[6]; 1609 uint8_t sense_data[]; 1610 }; 1611 1612 struct scsi_receive_copy_operating_parameters 1613 { 1614 uint8_t opcode; 1615 uint8_t service_action; 1616 #define RCS_RCOP 0x03 1617 uint8_t reserved[8]; 1618 uint8_t length[4]; 1619 uint8_t reserved1; 1620 uint8_t control; 1621 }; 1622 1623 struct scsi_receive_copy_operating_parameters_data 1624 { 1625 uint8_t length[4]; 1626 uint8_t snlid; 1627 #define RCOP_SNLID 0x01 1628 uint8_t reserved[3]; 1629 uint8_t maximum_cscd_descriptor_count[2]; 1630 uint8_t maximum_segment_descriptor_count[2]; 1631 uint8_t maximum_descriptor_list_length[4]; 1632 uint8_t maximum_segment_length[4]; 1633 uint8_t maximum_inline_data_length[4]; 1634 uint8_t held_data_limit[4]; 1635 uint8_t maximum_stream_device_transfer_size[4]; 1636 uint8_t reserved2[2]; 1637 uint8_t total_concurrent_copies[2]; 1638 uint8_t maximum_concurrent_copies; 1639 uint8_t data_segment_granularity; 1640 uint8_t inline_data_granularity; 1641 uint8_t held_data_granularity; 1642 uint8_t reserved3[3]; 1643 uint8_t implemented_descriptor_list_length; 1644 uint8_t list_of_implemented_descriptor_type_codes[0]; 1645 }; 1646 1647 struct scsi_extended_copy 1648 { 1649 uint8_t opcode; 1650 uint8_t service_action; 1651 #define EC_EC_LID1 0x00 1652 #define EC_EC_LID4 0x01 1653 uint8_t reserved[8]; 1654 uint8_t length[4]; 1655 uint8_t reserved1; 1656 uint8_t control; 1657 }; 1658 1659 struct scsi_ec_cscd_dtsp 1660 { 1661 uint8_t flags; 1662 #define EC_CSCD_FIXED 0x01 1663 #define EC_CSCD_PAD 0x04 1664 uint8_t block_length[3]; 1665 }; 1666 1667 struct scsi_ec_cscd 1668 { 1669 uint8_t type_code; 1670 #define EC_CSCD_EXT 0xff 1671 uint8_t luidt_pdt; 1672 #define EC_NUL 0x20 1673 #define EC_LUIDT_MASK 0xc0 1674 #define EC_LUIDT_LUN 0x00 1675 #define EC_LUIDT_PROXY_TOKEN 0x40 1676 uint8_t relative_initiator_port[2]; 1677 uint8_t cscd_params[24]; 1678 struct scsi_ec_cscd_dtsp dtsp; 1679 }; 1680 1681 struct scsi_ec_cscd_id 1682 { 1683 uint8_t type_code; 1684 #define EC_CSCD_ID 0xe4 1685 uint8_t luidt_pdt; 1686 uint8_t relative_initiator_port[2]; 1687 uint8_t codeset; 1688 uint8_t id_type; 1689 uint8_t reserved; 1690 uint8_t length; 1691 uint8_t designator[20]; 1692 struct scsi_ec_cscd_dtsp dtsp; 1693 }; 1694 1695 struct scsi_ec_segment 1696 { 1697 uint8_t type_code; 1698 uint8_t flags; 1699 #define EC_SEG_DC 0x02 1700 #define EC_SEG_CAT 0x01 1701 uint8_t descr_length[2]; 1702 uint8_t params[]; 1703 }; 1704 1705 struct scsi_ec_segment_b2b 1706 { 1707 uint8_t type_code; 1708 #define EC_SEG_B2B 0x02 1709 uint8_t flags; 1710 uint8_t descr_length[2]; 1711 uint8_t src_cscd[2]; 1712 uint8_t dst_cscd[2]; 1713 uint8_t reserved[2]; 1714 uint8_t number_of_blocks[2]; 1715 uint8_t src_lba[8]; 1716 uint8_t dst_lba[8]; 1717 }; 1718 1719 struct scsi_ec_segment_verify 1720 { 1721 uint8_t type_code; 1722 #define EC_SEG_VERIFY 0x07 1723 uint8_t reserved; 1724 uint8_t descr_length[2]; 1725 uint8_t src_cscd[2]; 1726 uint8_t reserved2[2]; 1727 uint8_t tur; 1728 uint8_t reserved3[3]; 1729 }; 1730 1731 struct scsi_ec_segment_register_key 1732 { 1733 uint8_t type_code; 1734 #define EC_SEG_REGISTER_KEY 0x14 1735 uint8_t reserved; 1736 uint8_t descr_length[2]; 1737 uint8_t reserved2[2]; 1738 uint8_t dst_cscd[2]; 1739 uint8_t res_key[8]; 1740 uint8_t sa_res_key[8]; 1741 uint8_t reserved3[4]; 1742 }; 1743 1744 struct scsi_extended_copy_lid1_data 1745 { 1746 uint8_t list_identifier; 1747 uint8_t flags; 1748 #define EC_PRIORITY 0x07 1749 #define EC_LIST_ID_USAGE_MASK 0x18 1750 #define EC_LIST_ID_USAGE_FULL 0x08 1751 #define EC_LIST_ID_USAGE_NOHOLD 0x10 1752 #define EC_LIST_ID_USAGE_NONE 0x18 1753 #define EC_STR 0x20 1754 uint8_t cscd_list_length[2]; 1755 uint8_t reserved[4]; 1756 uint8_t segment_list_length[4]; 1757 uint8_t inline_data_length[4]; 1758 uint8_t data[]; 1759 }; 1760 1761 struct scsi_extended_copy_lid4_data 1762 { 1763 uint8_t list_format; 1764 #define EC_LIST_FORMAT 0x01 1765 uint8_t flags; 1766 uint8_t header_cscd_list_length[2]; 1767 uint8_t reserved[11]; 1768 uint8_t flags2; 1769 #define EC_IMMED 0x01 1770 #define EC_G_SENSE 0x02 1771 uint8_t header_cscd_type_code; 1772 uint8_t reserved2[3]; 1773 uint8_t list_identifier[4]; 1774 uint8_t reserved3[18]; 1775 uint8_t cscd_list_length[2]; 1776 uint8_t segment_list_length[2]; 1777 uint8_t inline_data_length[2]; 1778 uint8_t data[]; 1779 }; 1780 1781 struct scsi_copy_operation_abort 1782 { 1783 uint8_t opcode; 1784 uint8_t service_action; 1785 #define EC_COA 0x1c 1786 uint8_t list_identifier[4]; 1787 uint8_t reserved[9]; 1788 uint8_t control; 1789 }; 1790 1791 struct scsi_populate_token 1792 { 1793 uint8_t opcode; 1794 uint8_t service_action; 1795 #define EC_PT 0x10 1796 uint8_t reserved[4]; 1797 uint8_t list_identifier[4]; 1798 uint8_t length[4]; 1799 uint8_t group_number; 1800 uint8_t control; 1801 }; 1802 1803 struct scsi_range_desc 1804 { 1805 uint8_t lba[8]; 1806 uint8_t length[4]; 1807 uint8_t reserved[4]; 1808 }; 1809 1810 struct scsi_populate_token_data 1811 { 1812 uint8_t length[2]; 1813 uint8_t flags; 1814 #define EC_PT_IMMED 0x01 1815 #define EC_PT_RTV 0x02 1816 uint8_t reserved; 1817 uint8_t inactivity_timeout[4]; 1818 uint8_t rod_type[4]; 1819 uint8_t reserved2[2]; 1820 uint8_t range_descriptor_length[2]; 1821 struct scsi_range_desc desc[]; 1822 }; 1823 1824 struct scsi_write_using_token 1825 { 1826 uint8_t opcode; 1827 uint8_t service_action; 1828 #define EC_WUT 0x11 1829 uint8_t reserved[4]; 1830 uint8_t list_identifier[4]; 1831 uint8_t length[4]; 1832 uint8_t group_number; 1833 uint8_t control; 1834 }; 1835 1836 struct scsi_write_using_token_data 1837 { 1838 uint8_t length[2]; 1839 uint8_t flags; 1840 #define EC_WUT_IMMED 0x01 1841 #define EC_WUT_DEL_TKN 0x02 1842 uint8_t reserved[5]; 1843 uint8_t offset_into_rod[8]; 1844 uint8_t rod_token[512]; 1845 uint8_t reserved2[6]; 1846 uint8_t range_descriptor_length[2]; 1847 struct scsi_range_desc desc[]; 1848 }; 1849 1850 struct scsi_receive_rod_token_information 1851 { 1852 uint8_t opcode; 1853 uint8_t service_action; 1854 #define RCS_RRTI 0x07 1855 uint8_t list_identifier[4]; 1856 uint8_t reserved[4]; 1857 uint8_t length[4]; 1858 uint8_t reserved2; 1859 uint8_t control; 1860 }; 1861 1862 struct scsi_token 1863 { 1864 uint8_t type[4]; 1865 #define ROD_TYPE_INTERNAL 0x00000000 1866 #define ROD_TYPE_AUR 0x00010000 1867 #define ROD_TYPE_PIT_DEF 0x00800000 1868 #define ROD_TYPE_PIT_VULN 0x00800001 1869 #define ROD_TYPE_PIT_PERS 0x00800002 1870 #define ROD_TYPE_PIT_ANY 0x0080FFFF 1871 #define ROD_TYPE_BLOCK_ZERO 0xFFFF0001 1872 uint8_t reserved[2]; 1873 uint8_t length[2]; 1874 uint8_t body[0]; 1875 }; 1876 1877 struct scsi_report_all_rod_tokens 1878 { 1879 uint8_t opcode; 1880 uint8_t service_action; 1881 #define RCS_RART 0x08 1882 uint8_t reserved[8]; 1883 uint8_t length[4]; 1884 uint8_t reserved2; 1885 uint8_t control; 1886 }; 1887 1888 struct scsi_report_all_rod_tokens_data 1889 { 1890 uint8_t available_data[4]; 1891 uint8_t reserved[4]; 1892 uint8_t rod_management_token_list[]; 1893 }; 1894 1895 struct ata_pass_16 { 1896 u_int8_t opcode; 1897 u_int8_t protocol; 1898 #define AP_EXTEND 0x01 1899 u_int8_t flags; 1900 #define AP_FLAG_TLEN_NO_DATA (0 << 0) 1901 #define AP_FLAG_TLEN_FEAT (1 << 0) 1902 #define AP_FLAG_TLEN_SECT_CNT (2 << 0) 1903 #define AP_FLAG_TLEN_STPSIU (3 << 0) 1904 #define AP_FLAG_BYT_BLOK_BYTES (0 << 2) 1905 #define AP_FLAG_BYT_BLOK_BLOCKS (1 << 2) 1906 #define AP_FLAG_TDIR_TO_DEV (0 << 3) 1907 #define AP_FLAG_TDIR_FROM_DEV (1 << 3) 1908 #define AP_FLAG_CHK_COND (1 << 5) 1909 u_int8_t features_ext; 1910 u_int8_t features; 1911 u_int8_t sector_count_ext; 1912 u_int8_t sector_count; 1913 u_int8_t lba_low_ext; 1914 u_int8_t lba_low; 1915 u_int8_t lba_mid_ext; 1916 u_int8_t lba_mid; 1917 u_int8_t lba_high_ext; 1918 u_int8_t lba_high; 1919 u_int8_t device; 1920 u_int8_t command; 1921 u_int8_t control; 1922 }; 1923 1924 #define SC_SCSI_1 0x01 1925 #define SC_SCSI_2 0x03 1926 1927 /* 1928 * Opcodes 1929 */ 1930 1931 #define TEST_UNIT_READY 0x00 1932 #define REQUEST_SENSE 0x03 1933 #define READ_6 0x08 1934 #define WRITE_6 0x0A 1935 #define INQUIRY 0x12 1936 #define MODE_SELECT_6 0x15 1937 #define MODE_SENSE_6 0x1A 1938 #define START_STOP_UNIT 0x1B 1939 #define START_STOP 0x1B 1940 #define RESERVE 0x16 1941 #define RELEASE 0x17 1942 #define RECEIVE_DIAGNOSTIC 0x1C 1943 #define SEND_DIAGNOSTIC 0x1D 1944 #define PREVENT_ALLOW 0x1E 1945 #define READ_CAPACITY 0x25 1946 #define READ_10 0x28 1947 #define WRITE_10 0x2A 1948 #define POSITION_TO_ELEMENT 0x2B 1949 #define WRITE_VERIFY_10 0x2E 1950 #define VERIFY_10 0x2F 1951 #define SYNCHRONIZE_CACHE 0x35 1952 #define READ_DEFECT_DATA_10 0x37 1953 #define WRITE_BUFFER 0x3B 1954 #define READ_BUFFER 0x3C 1955 #define CHANGE_DEFINITION 0x40 1956 #define WRITE_SAME_10 0x41 1957 #define UNMAP 0x42 1958 #define LOG_SELECT 0x4C 1959 #define LOG_SENSE 0x4D 1960 #define MODE_SELECT_10 0x55 1961 #define RESERVE_10 0x56 1962 #define RELEASE_10 0x57 1963 #define MODE_SENSE_10 0x5A 1964 #define PERSISTENT_RES_IN 0x5E 1965 #define PERSISTENT_RES_OUT 0x5F 1966 #define EXTENDED_COPY 0x83 1967 #define RECEIVE_COPY_STATUS 0x84 1968 #define ATA_PASS_16 0x85 1969 #define READ_16 0x88 1970 #define COMPARE_AND_WRITE 0x89 1971 #define WRITE_16 0x8A 1972 #define READ_ATTRIBUTE 0x8C 1973 #define WRITE_ATTRIBUTE 0x8D 1974 #define WRITE_VERIFY_16 0x8E 1975 #define VERIFY_16 0x8F 1976 #define SYNCHRONIZE_CACHE_16 0x91 1977 #define WRITE_SAME_16 0x93 1978 #define WRITE_ATOMIC_16 0x9C 1979 #define SERVICE_ACTION_IN 0x9E 1980 #define REPORT_LUNS 0xA0 1981 #define ATA_PASS_12 0xA1 1982 #define SECURITY_PROTOCOL_IN 0xA2 1983 #define MAINTENANCE_IN 0xA3 1984 #define MAINTENANCE_OUT 0xA4 1985 #define MOVE_MEDIUM 0xA5 1986 #define READ_12 0xA8 1987 #define WRITE_12 0xAA 1988 #define WRITE_VERIFY_12 0xAE 1989 #define VERIFY_12 0xAF 1990 #define SECURITY_PROTOCOL_OUT 0xB5 1991 #define READ_ELEMENT_STATUS 0xB8 1992 #define READ_CD 0xBE 1993 1994 /* Maintenance In Service Action Codes */ 1995 #define REPORT_IDENTIFYING_INFRMATION 0x05 1996 #define REPORT_TARGET_PORT_GROUPS 0x0A 1997 #define REPORT_ALIASES 0x0B 1998 #define REPORT_SUPPORTED_OPERATION_CODES 0x0C 1999 #define REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS 0x0D 2000 #define REPORT_PRIORITY 0x0E 2001 #define REPORT_TIMESTAMP 0x0F 2002 #define MANAGEMENT_PROTOCOL_IN 0x10 2003 /* Maintenance Out Service Action Codes */ 2004 #define SET_IDENTIFY_INFORMATION 0x06 2005 #define SET_TARGET_PORT_GROUPS 0x0A 2006 #define CHANGE_ALIASES 0x0B 2007 #define SET_PRIORITY 0x0E 2008 #define SET_TIMESTAMP 0x0F 2009 #define MANGAEMENT_PROTOCOL_OUT 0x10 2010 2011 /* 2012 * Device Types 2013 */ 2014 #define T_DIRECT 0x00 2015 #define T_SEQUENTIAL 0x01 2016 #define T_PRINTER 0x02 2017 #define T_PROCESSOR 0x03 2018 #define T_WORM 0x04 2019 #define T_CDROM 0x05 2020 #define T_SCANNER 0x06 2021 #define T_OPTICAL 0x07 2022 #define T_CHANGER 0x08 2023 #define T_COMM 0x09 2024 #define T_ASC0 0x0a 2025 #define T_ASC1 0x0b 2026 #define T_STORARRAY 0x0c 2027 #define T_ENCLOSURE 0x0d 2028 #define T_RBC 0x0e 2029 #define T_OCRW 0x0f 2030 #define T_OSD 0x11 2031 #define T_ADC 0x12 2032 #define T_NODEVICE 0x1f 2033 #define T_ANY 0xff /* Used in Quirk table matches */ 2034 2035 #define T_REMOV 1 2036 #define T_FIXED 0 2037 2038 /* 2039 * This length is the initial inquiry length used by the probe code, as 2040 * well as the length necessary for scsi_print_inquiry() to function 2041 * correctly. If either use requires a different length in the future, 2042 * the two values should be de-coupled. 2043 */ 2044 #define SHORT_INQUIRY_LENGTH 36 2045 2046 struct scsi_inquiry_data 2047 { 2048 u_int8_t device; 2049 #define SID_TYPE(inq_data) ((inq_data)->device & 0x1f) 2050 #define SID_QUAL(inq_data) (((inq_data)->device & 0xE0) >> 5) 2051 #define SID_QUAL_LU_CONNECTED 0x00 /* 2052 * The specified peripheral device 2053 * type is currently connected to 2054 * logical unit. If the target cannot 2055 * determine whether or not a physical 2056 * device is currently connected, it 2057 * shall also use this peripheral 2058 * qualifier when returning the INQUIRY 2059 * data. This peripheral qualifier 2060 * does not mean that the device is 2061 * ready for access by the initiator. 2062 */ 2063 #define SID_QUAL_LU_OFFLINE 0x01 /* 2064 * The target is capable of supporting 2065 * the specified peripheral device type 2066 * on this logical unit; however, the 2067 * physical device is not currently 2068 * connected to this logical unit. 2069 */ 2070 #define SID_QUAL_RSVD 0x02 2071 #define SID_QUAL_BAD_LU 0x03 /* 2072 * The target is not capable of 2073 * supporting a physical device on 2074 * this logical unit. For this 2075 * peripheral qualifier the peripheral 2076 * device type shall be set to 1Fh to 2077 * provide compatibility with previous 2078 * versions of SCSI. All other 2079 * peripheral device type values are 2080 * reserved for this peripheral 2081 * qualifier. 2082 */ 2083 #define SID_QUAL_IS_VENDOR_UNIQUE(inq_data) ((SID_QUAL(inq_data) & 0x04) != 0) 2084 u_int8_t dev_qual2; 2085 #define SID_QUAL2 0x7F 2086 #define SID_LU_CONG 0x40 2087 #define SID_RMB 0x80 2088 #define SID_IS_REMOVABLE(inq_data) (((inq_data)->dev_qual2 & SID_RMB) != 0) 2089 u_int8_t version; 2090 #define SID_ANSI_REV(inq_data) ((inq_data)->version & 0x07) 2091 #define SCSI_REV_0 0 2092 #define SCSI_REV_CCS 1 2093 #define SCSI_REV_2 2 2094 #define SCSI_REV_SPC 3 2095 #define SCSI_REV_SPC2 4 2096 #define SCSI_REV_SPC3 5 2097 #define SCSI_REV_SPC4 6 2098 2099 #define SID_ECMA 0x38 2100 #define SID_ISO 0xC0 2101 u_int8_t response_format; 2102 #define SID_AENC 0x80 2103 #define SID_TrmIOP 0x40 2104 #define SID_NormACA 0x20 2105 #define SID_HiSup 0x10 2106 u_int8_t additional_length; 2107 #define SID_ADDITIONAL_LENGTH(iqd) \ 2108 ((iqd)->additional_length + \ 2109 __offsetof(struct scsi_inquiry_data, additional_length) + 1) 2110 u_int8_t spc3_flags; 2111 #define SPC3_SID_PROTECT 0x01 2112 #define SPC3_SID_3PC 0x08 2113 #define SPC3_SID_TPGS_MASK 0x30 2114 #define SPC3_SID_TPGS_IMPLICIT 0x10 2115 #define SPC3_SID_TPGS_EXPLICIT 0x20 2116 #define SPC3_SID_ACC 0x40 2117 #define SPC3_SID_SCCS 0x80 2118 u_int8_t spc2_flags; 2119 #define SPC2_SID_ADDR16 0x01 2120 #define SPC2_SID_MChngr 0x08 2121 #define SPC2_SID_MultiP 0x10 2122 #define SPC2_SID_EncServ 0x40 2123 #define SPC2_SID_BQueue 0x80 2124 2125 #define INQ_DATA_TQ_ENABLED(iqd) \ 2126 ((SID_ANSI_REV(iqd) < SCSI_REV_SPC2)? ((iqd)->flags & SID_CmdQue) : \ 2127 (((iqd)->flags & SID_CmdQue) && !((iqd)->spc2_flags & SPC2_SID_BQueue)) || \ 2128 (!((iqd)->flags & SID_CmdQue) && ((iqd)->spc2_flags & SPC2_SID_BQueue))) 2129 2130 u_int8_t flags; 2131 #define SID_SftRe 0x01 2132 #define SID_CmdQue 0x02 2133 #define SID_Linked 0x08 2134 #define SID_Sync 0x10 2135 #define SID_WBus16 0x20 2136 #define SID_WBus32 0x40 2137 #define SID_RelAdr 0x80 2138 #define SID_VENDOR_SIZE 8 2139 char vendor[SID_VENDOR_SIZE]; 2140 #define SID_PRODUCT_SIZE 16 2141 char product[SID_PRODUCT_SIZE]; 2142 #define SID_REVISION_SIZE 4 2143 char revision[SID_REVISION_SIZE]; 2144 /* 2145 * The following fields were taken from SCSI Primary Commands - 2 2146 * (SPC-2) Revision 14, Dated 11 November 1999 2147 */ 2148 #define SID_VENDOR_SPECIFIC_0_SIZE 20 2149 u_int8_t vendor_specific0[SID_VENDOR_SPECIFIC_0_SIZE]; 2150 /* 2151 * An extension of SCSI Parallel Specific Values 2152 */ 2153 #define SID_SPI_IUS 0x01 2154 #define SID_SPI_QAS 0x02 2155 #define SID_SPI_CLOCK_ST 0x00 2156 #define SID_SPI_CLOCK_DT 0x04 2157 #define SID_SPI_CLOCK_DT_ST 0x0C 2158 #define SID_SPI_MASK 0x0F 2159 u_int8_t spi3data; 2160 u_int8_t reserved2; 2161 /* 2162 * Version Descriptors, stored 2 byte values. 2163 */ 2164 u_int8_t version1[2]; 2165 u_int8_t version2[2]; 2166 u_int8_t version3[2]; 2167 u_int8_t version4[2]; 2168 u_int8_t version5[2]; 2169 u_int8_t version6[2]; 2170 u_int8_t version7[2]; 2171 u_int8_t version8[2]; 2172 2173 u_int8_t reserved3[22]; 2174 2175 #define SID_VENDOR_SPECIFIC_1_SIZE 160 2176 u_int8_t vendor_specific1[SID_VENDOR_SPECIFIC_1_SIZE]; 2177 }; 2178 2179 /* 2180 * This structure is more suited to initiator operation, because the 2181 * maximum number of supported pages is already allocated. 2182 */ 2183 struct scsi_vpd_supported_page_list 2184 { 2185 u_int8_t device; 2186 u_int8_t page_code; 2187 #define SVPD_SUPPORTED_PAGE_LIST 0x00 2188 #define SVPD_SUPPORTED_PAGES_HDR_LEN 4 2189 u_int8_t reserved; 2190 u_int8_t length; /* number of VPD entries */ 2191 #define SVPD_SUPPORTED_PAGES_SIZE 251 2192 u_int8_t list[SVPD_SUPPORTED_PAGES_SIZE]; 2193 }; 2194 2195 /* 2196 * This structure is more suited to target operation, because the 2197 * number of supported pages is left to the user to allocate. 2198 */ 2199 struct scsi_vpd_supported_pages 2200 { 2201 u_int8_t device; 2202 u_int8_t page_code; 2203 u_int8_t reserved; 2204 #define SVPD_SUPPORTED_PAGES 0x00 2205 u_int8_t length; 2206 u_int8_t page_list[0]; 2207 }; 2208 2209 2210 struct scsi_vpd_unit_serial_number 2211 { 2212 u_int8_t device; 2213 u_int8_t page_code; 2214 #define SVPD_UNIT_SERIAL_NUMBER 0x80 2215 u_int8_t reserved; 2216 u_int8_t length; /* serial number length */ 2217 #define SVPD_SERIAL_NUM_SIZE 251 2218 u_int8_t serial_num[SVPD_SERIAL_NUM_SIZE]; 2219 }; 2220 2221 struct scsi_vpd_device_id 2222 { 2223 u_int8_t device; 2224 u_int8_t page_code; 2225 #define SVPD_DEVICE_ID 0x83 2226 #define SVPD_DEVICE_ID_MAX_SIZE 252 2227 #define SVPD_DEVICE_ID_HDR_LEN \ 2228 __offsetof(struct scsi_vpd_device_id, desc_list) 2229 u_int8_t length[2]; 2230 u_int8_t desc_list[]; 2231 }; 2232 2233 struct scsi_vpd_id_descriptor 2234 { 2235 u_int8_t proto_codeset; 2236 /* 2237 * See the SCSI_PROTO definitions above for the protocols. 2238 */ 2239 #define SVPD_ID_PROTO_SHIFT 4 2240 #define SVPD_ID_CODESET_BINARY 0x01 2241 #define SVPD_ID_CODESET_ASCII 0x02 2242 #define SVPD_ID_CODESET_UTF8 0x03 2243 #define SVPD_ID_CODESET_MASK 0x0f 2244 u_int8_t id_type; 2245 #define SVPD_ID_PIV 0x80 2246 #define SVPD_ID_ASSOC_LUN 0x00 2247 #define SVPD_ID_ASSOC_PORT 0x10 2248 #define SVPD_ID_ASSOC_TARGET 0x20 2249 #define SVPD_ID_ASSOC_MASK 0x30 2250 #define SVPD_ID_TYPE_VENDOR 0x00 2251 #define SVPD_ID_TYPE_T10 0x01 2252 #define SVPD_ID_TYPE_EUI64 0x02 2253 #define SVPD_ID_TYPE_NAA 0x03 2254 #define SVPD_ID_TYPE_RELTARG 0x04 2255 #define SVPD_ID_TYPE_TPORTGRP 0x05 2256 #define SVPD_ID_TYPE_LUNGRP 0x06 2257 #define SVPD_ID_TYPE_MD5_LUN_ID 0x07 2258 #define SVPD_ID_TYPE_SCSI_NAME 0x08 2259 #define SVPD_ID_TYPE_MASK 0x0f 2260 u_int8_t reserved; 2261 u_int8_t length; 2262 #define SVPD_DEVICE_ID_DESC_HDR_LEN \ 2263 __offsetof(struct scsi_vpd_id_descriptor, identifier) 2264 u_int8_t identifier[]; 2265 }; 2266 2267 struct scsi_vpd_id_t10 2268 { 2269 u_int8_t vendor[8]; 2270 u_int8_t vendor_spec_id[0]; 2271 }; 2272 2273 struct scsi_vpd_id_eui64 2274 { 2275 u_int8_t ieee_company_id[3]; 2276 u_int8_t extension_id[5]; 2277 }; 2278 2279 struct scsi_vpd_id_naa_basic 2280 { 2281 uint8_t naa; 2282 /* big endian, packed: 2283 uint8_t naa : 4; 2284 uint8_t naa_desig : 4; 2285 */ 2286 #define SVPD_ID_NAA_NAA_SHIFT 4 2287 #define SVPD_ID_NAA_IEEE_EXT 0x02 2288 #define SVPD_ID_NAA_LOCAL_REG 0x03 2289 #define SVPD_ID_NAA_IEEE_REG 0x05 2290 #define SVPD_ID_NAA_IEEE_REG_EXT 0x06 2291 uint8_t naa_data[]; 2292 }; 2293 2294 struct scsi_vpd_id_naa_ieee_extended_id 2295 { 2296 uint8_t naa; 2297 uint8_t vendor_specific_id_a; 2298 uint8_t ieee_company_id[3]; 2299 uint8_t vendor_specific_id_b[4]; 2300 }; 2301 2302 struct scsi_vpd_id_naa_local_reg 2303 { 2304 uint8_t naa; 2305 uint8_t local_value[7]; 2306 }; 2307 2308 struct scsi_vpd_id_naa_ieee_reg 2309 { 2310 uint8_t naa; 2311 uint8_t reg_value[7]; 2312 /* big endian, packed: 2313 uint8_t naa_basic : 4; 2314 uint8_t ieee_company_id_0 : 4; 2315 uint8_t ieee_company_id_1[2]; 2316 uint8_t ieee_company_id_2 : 4; 2317 uint8_t vendor_specific_id_0 : 4; 2318 uint8_t vendor_specific_id_1[4]; 2319 */ 2320 }; 2321 2322 struct scsi_vpd_id_naa_ieee_reg_extended 2323 { 2324 uint8_t naa; 2325 uint8_t reg_value[15]; 2326 /* big endian, packed: 2327 uint8_t naa_basic : 4; 2328 uint8_t ieee_company_id_0 : 4; 2329 uint8_t ieee_company_id_1[2]; 2330 uint8_t ieee_company_id_2 : 4; 2331 uint8_t vendor_specific_id_0 : 4; 2332 uint8_t vendor_specific_id_1[4]; 2333 uint8_t vendor_specific_id_ext[8]; 2334 */ 2335 }; 2336 2337 struct scsi_vpd_id_rel_trgt_port_id 2338 { 2339 uint8_t obsolete[2]; 2340 uint8_t rel_trgt_port_id[2]; 2341 }; 2342 2343 struct scsi_vpd_id_trgt_port_grp_id 2344 { 2345 uint8_t reserved[2]; 2346 uint8_t trgt_port_grp[2]; 2347 }; 2348 2349 struct scsi_vpd_id_lun_grp_id 2350 { 2351 uint8_t reserved[2]; 2352 uint8_t log_unit_grp[2]; 2353 }; 2354 2355 struct scsi_vpd_id_md5_lun_id 2356 { 2357 uint8_t lun_id[16]; 2358 }; 2359 2360 struct scsi_vpd_id_scsi_name 2361 { 2362 uint8_t name_string[256]; 2363 }; 2364 2365 struct scsi_service_action_in 2366 { 2367 uint8_t opcode; 2368 uint8_t service_action; 2369 uint8_t action_dependent[13]; 2370 uint8_t control; 2371 }; 2372 2373 struct scsi_vpd_extended_inquiry_data 2374 { 2375 uint8_t device; 2376 uint8_t page_code; 2377 #define SVPD_EXTENDED_INQUIRY_DATA 0x86 2378 uint8_t page_length[2]; 2379 uint8_t flags1; 2380 2381 /* These values are for direct access devices */ 2382 #define SVPD_EID_AM_MASK 0xC0 2383 #define SVPD_EID_AM_DEFER 0x80 2384 #define SVPD_EID_AM_IMMED 0x40 2385 #define SVPD_EID_AM_UNDEFINED 0x00 2386 #define SVPD_EID_AM_RESERVED 0xc0 2387 #define SVPD_EID_SPT 0x38 2388 #define SVPD_EID_SPT_1 0x00 2389 #define SVPD_EID_SPT_12 0x08 2390 #define SVPD_EID_SPT_2 0x10 2391 #define SVPD_EID_SPT_13 0x18 2392 #define SVPD_EID_SPT_3 0x20 2393 #define SVPD_EID_SPT_23 0x28 2394 #define SVPD_EID_SPT_123 0x38 2395 2396 /* These values are for sequential access devices */ 2397 #define SVPD_EID_SA_SPT_LBP 0x08 2398 2399 #define SVPD_EID_GRD_CHK 0x04 2400 #define SVPD_EID_APP_CHK 0x02 2401 #define SVPD_EID_REF_CHK 0x01 2402 2403 uint8_t flags2; 2404 #define SVPD_EID_UASK_SUP 0x20 2405 #define SVPD_EID_GROUP_SUP 0x10 2406 #define SVPD_EID_PRIOR_SUP 0x08 2407 #define SVPD_EID_HEADSUP 0x04 2408 #define SVPD_EID_ORDSUP 0x02 2409 #define SVPD_EID_SIMPSUP 0x01 2410 uint8_t flags3; 2411 #define SVPD_EID_WU_SUP 0x08 2412 #define SVPD_EID_CRD_SUP 0x04 2413 #define SVPD_EID_NV_SUP 0x02 2414 #define SVPD_EID_V_SUP 0x01 2415 uint8_t flags4; 2416 #define SVPD_EID_P_I_I_SUP 0x10 2417 #define SVPD_EID_LUICLT 0x01 2418 uint8_t flags5; 2419 #define SVPD_EID_R_SUP 0x10 2420 #define SVPD_EID_CBCS 0x01 2421 uint8_t flags6; 2422 #define SVPD_EID_MULTI_I_T_FW 0x0F 2423 #define SVPD_EID_MC_VENDOR_SPEC 0x00 2424 #define SVPD_EID_MC_MODE_1 0x01 2425 #define SVPD_EID_MC_MODE_2 0x02 2426 #define SVPD_EID_MC_MODE_3 0x03 2427 uint8_t est[2]; 2428 uint8_t flags7; 2429 #define SVPD_EID_POA_SUP 0x80 2430 #define SVPD_EID_HRA_SUP 0x80 2431 #define SVPD_EID_VSA_SUP 0x80 2432 uint8_t max_sense_length; 2433 uint8_t reserved2[50]; 2434 }; 2435 2436 struct scsi_vpd_mode_page_policy_descr 2437 { 2438 uint8_t page_code; 2439 uint8_t subpage_code; 2440 uint8_t policy; 2441 #define SVPD_MPP_SHARED 0x00 2442 #define SVPD_MPP_PORT 0x01 2443 #define SVPD_MPP_I_T 0x03 2444 #define SVPD_MPP_MLUS 0x80 2445 uint8_t reserved; 2446 }; 2447 2448 struct scsi_vpd_mode_page_policy 2449 { 2450 uint8_t device; 2451 uint8_t page_code; 2452 #define SVPD_MODE_PAGE_POLICY 0x87 2453 uint8_t page_length[2]; 2454 struct scsi_vpd_mode_page_policy_descr descr[0]; 2455 }; 2456 2457 struct scsi_diag_page { 2458 uint8_t page_code; 2459 uint8_t page_specific_flags; 2460 uint8_t length[2]; 2461 uint8_t params[0]; 2462 }; 2463 2464 struct scsi_vpd_port_designation 2465 { 2466 uint8_t reserved[2]; 2467 uint8_t relative_port_id[2]; 2468 uint8_t reserved2[2]; 2469 uint8_t initiator_transportid_length[2]; 2470 uint8_t initiator_transportid[0]; 2471 }; 2472 2473 struct scsi_vpd_port_designation_cont 2474 { 2475 uint8_t reserved[2]; 2476 uint8_t target_port_descriptors_length[2]; 2477 struct scsi_vpd_id_descriptor target_port_descriptors[0]; 2478 }; 2479 2480 struct scsi_vpd_scsi_ports 2481 { 2482 u_int8_t device; 2483 u_int8_t page_code; 2484 #define SVPD_SCSI_PORTS 0x88 2485 u_int8_t page_length[2]; 2486 struct scsi_vpd_port_designation design[]; 2487 }; 2488 2489 /* 2490 * ATA Information VPD Page based on 2491 * T10/2126-D Revision 04 2492 */ 2493 #define SVPD_ATA_INFORMATION 0x89 2494 2495 2496 struct scsi_vpd_tpc_descriptor 2497 { 2498 uint8_t desc_type[2]; 2499 uint8_t desc_length[2]; 2500 uint8_t parameters[]; 2501 }; 2502 2503 struct scsi_vpd_tpc_descriptor_bdrl 2504 { 2505 uint8_t desc_type[2]; 2506 #define SVPD_TPC_BDRL 0x0000 2507 uint8_t desc_length[2]; 2508 uint8_t vendor_specific[6]; 2509 uint8_t maximum_ranges[2]; 2510 uint8_t maximum_inactivity_timeout[4]; 2511 uint8_t default_inactivity_timeout[4]; 2512 uint8_t maximum_token_transfer_size[8]; 2513 uint8_t optimal_transfer_count[8]; 2514 }; 2515 2516 struct scsi_vpd_tpc_descriptor_sc_descr 2517 { 2518 uint8_t opcode; 2519 uint8_t sa_length; 2520 uint8_t supported_service_actions[0]; 2521 }; 2522 2523 struct scsi_vpd_tpc_descriptor_sc 2524 { 2525 uint8_t desc_type[2]; 2526 #define SVPD_TPC_SC 0x0001 2527 uint8_t desc_length[2]; 2528 uint8_t list_length; 2529 struct scsi_vpd_tpc_descriptor_sc_descr descr[]; 2530 }; 2531 2532 struct scsi_vpd_tpc_descriptor_pd 2533 { 2534 uint8_t desc_type[2]; 2535 #define SVPD_TPC_PD 0x0004 2536 uint8_t desc_length[2]; 2537 uint8_t reserved[4]; 2538 uint8_t maximum_cscd_descriptor_count[2]; 2539 uint8_t maximum_segment_descriptor_count[2]; 2540 uint8_t maximum_descriptor_list_length[4]; 2541 uint8_t maximum_inline_data_length[4]; 2542 uint8_t reserved2[12]; 2543 }; 2544 2545 struct scsi_vpd_tpc_descriptor_sd 2546 { 2547 uint8_t desc_type[2]; 2548 #define SVPD_TPC_SD 0x0008 2549 uint8_t desc_length[2]; 2550 uint8_t list_length; 2551 uint8_t supported_descriptor_codes[]; 2552 }; 2553 2554 struct scsi_vpd_tpc_descriptor_sdid 2555 { 2556 uint8_t desc_type[2]; 2557 #define SVPD_TPC_SDID 0x000C 2558 uint8_t desc_length[2]; 2559 uint8_t list_length[2]; 2560 uint8_t supported_descriptor_ids[]; 2561 }; 2562 2563 struct scsi_vpd_tpc_descriptor_rtf_block 2564 { 2565 uint8_t type_format; 2566 #define SVPD_TPC_RTF_BLOCK 0x00 2567 uint8_t reserved; 2568 uint8_t desc_length[2]; 2569 uint8_t reserved2[2]; 2570 uint8_t optimal_length_granularity[2]; 2571 uint8_t maximum_bytes[8]; 2572 uint8_t optimal_bytes[8]; 2573 uint8_t optimal_bytes_to_token_per_segment[8]; 2574 uint8_t optimal_bytes_from_token_per_segment[8]; 2575 uint8_t reserved3[8]; 2576 }; 2577 2578 struct scsi_vpd_tpc_descriptor_rtf 2579 { 2580 uint8_t desc_type[2]; 2581 #define SVPD_TPC_RTF 0x0106 2582 uint8_t desc_length[2]; 2583 uint8_t remote_tokens; 2584 uint8_t reserved[11]; 2585 uint8_t minimum_token_lifetime[4]; 2586 uint8_t maximum_token_lifetime[4]; 2587 uint8_t maximum_token_inactivity_timeout[4]; 2588 uint8_t reserved2[18]; 2589 uint8_t type_specific_features_length[2]; 2590 uint8_t type_specific_features[0]; 2591 }; 2592 2593 struct scsi_vpd_tpc_descriptor_srtd 2594 { 2595 uint8_t rod_type[4]; 2596 uint8_t flags; 2597 #define SVPD_TPC_SRTD_TOUT 0x01 2598 #define SVPD_TPC_SRTD_TIN 0x02 2599 #define SVPD_TPC_SRTD_ECPY 0x80 2600 uint8_t reserved; 2601 uint8_t preference_indicator[2]; 2602 uint8_t reserved2[56]; 2603 }; 2604 2605 struct scsi_vpd_tpc_descriptor_srt 2606 { 2607 uint8_t desc_type[2]; 2608 #define SVPD_TPC_SRT 0x0108 2609 uint8_t desc_length[2]; 2610 uint8_t reserved[2]; 2611 uint8_t rod_type_descriptors_length[2]; 2612 uint8_t rod_type_descriptors[0]; 2613 }; 2614 2615 struct scsi_vpd_tpc_descriptor_gco 2616 { 2617 uint8_t desc_type[2]; 2618 #define SVPD_TPC_GCO 0x8001 2619 uint8_t desc_length[2]; 2620 uint8_t total_concurrent_copies[4]; 2621 uint8_t maximum_identified_concurrent_copies[4]; 2622 uint8_t maximum_segment_length[4]; 2623 uint8_t data_segment_granularity; 2624 uint8_t inline_data_granularity; 2625 uint8_t reserved[18]; 2626 }; 2627 2628 struct scsi_vpd_tpc 2629 { 2630 uint8_t device; 2631 uint8_t page_code; 2632 #define SVPD_SCSI_TPC 0x8F 2633 uint8_t page_length[2]; 2634 struct scsi_vpd_tpc_descriptor descr[]; 2635 }; 2636 2637 /* 2638 * Block Device Characteristics VPD Page based on 2639 * T10/1799-D Revision 31 2640 */ 2641 struct scsi_vpd_block_characteristics 2642 { 2643 u_int8_t device; 2644 u_int8_t page_code; 2645 #define SVPD_BDC 0xB1 2646 u_int8_t page_length[2]; 2647 u_int8_t medium_rotation_rate[2]; 2648 #define SVPD_BDC_RATE_NOT_REPORTED 0x00 2649 #define SVPD_BDC_RATE_NON_ROTATING 0x01 2650 u_int8_t reserved1; 2651 u_int8_t nominal_form_factor; 2652 #define SVPD_BDC_FORM_NOT_REPORTED 0x00 2653 #define SVPD_BDC_FORM_5_25INCH 0x01 2654 #define SVPD_BDC_FORM_3_5INCH 0x02 2655 #define SVPD_BDC_FORM_2_5INCH 0x03 2656 #define SVPD_BDC_FORM_1_5INCH 0x04 2657 #define SVPD_BDC_FORM_LESSTHAN_1_5INCH 0x05 2658 u_int8_t reserved2[56]; 2659 }; 2660 2661 /* 2662 * Block Device Characteristics VPD Page 2663 */ 2664 struct scsi_vpd_block_device_characteristics 2665 { 2666 uint8_t device; 2667 uint8_t page_code; 2668 #define SVPD_BDC 0xB1 2669 uint8_t page_length[2]; 2670 uint8_t medium_rotation_rate[2]; 2671 #define SVPD_NOT_REPORTED 0x0000 2672 #define SVPD_NON_ROTATING 0x0001 2673 uint8_t product_type; 2674 uint8_t wab_wac_ff; 2675 uint8_t flags; 2676 #define SVPD_VBULS 0x01 2677 #define SVPD_FUAB 0x02 2678 #define SVPD_HAW_ZBC 0x10 2679 uint8_t reserved[55]; 2680 }; 2681 2682 /* 2683 * Logical Block Provisioning VPD Page based on 2684 * T10/1799-D Revision 31 2685 */ 2686 struct scsi_vpd_logical_block_prov 2687 { 2688 u_int8_t device; 2689 u_int8_t page_code; 2690 #define SVPD_LBP 0xB2 2691 u_int8_t page_length[2]; 2692 #define SVPD_LBP_PL_BASIC 0x04 2693 u_int8_t threshold_exponent; 2694 u_int8_t flags; 2695 #define SVPD_LBP_UNMAP 0x80 2696 #define SVPD_LBP_WS16 0x40 2697 #define SVPD_LBP_WS10 0x20 2698 #define SVPD_LBP_RZ 0x04 2699 #define SVPD_LBP_ANC_SUP 0x02 2700 #define SVPD_LBP_DP 0x01 2701 u_int8_t prov_type; 2702 #define SVPD_LBP_RESOURCE 0x01 2703 #define SVPD_LBP_THIN 0x02 2704 u_int8_t reserved; 2705 /* 2706 * Provisioning Group Descriptor can be here if SVPD_LBP_DP is set 2707 * Its size can be determined from page_length - 4 2708 */ 2709 }; 2710 2711 /* 2712 * Block Limits VDP Page based on SBC-4 Revision 2 2713 */ 2714 struct scsi_vpd_block_limits 2715 { 2716 u_int8_t device; 2717 u_int8_t page_code; 2718 #define SVPD_BLOCK_LIMITS 0xB0 2719 u_int8_t page_length[2]; 2720 #define SVPD_BL_PL_BASIC 0x10 2721 #define SVPD_BL_PL_TP 0x3C 2722 u_int8_t reserved1; 2723 u_int8_t max_cmp_write_len; 2724 u_int8_t opt_txfer_len_grain[2]; 2725 u_int8_t max_txfer_len[4]; 2726 u_int8_t opt_txfer_len[4]; 2727 u_int8_t max_prefetch[4]; 2728 u_int8_t max_unmap_lba_cnt[4]; 2729 u_int8_t max_unmap_blk_cnt[4]; 2730 u_int8_t opt_unmap_grain[4]; 2731 u_int8_t unmap_grain_align[4]; 2732 u_int8_t max_write_same_length[8]; 2733 u_int8_t max_atomic_transfer_length[4]; 2734 u_int8_t atomic_alignment[4]; 2735 u_int8_t atomic_transfer_length_granularity[4]; 2736 u_int8_t reserved2[8]; 2737 }; 2738 2739 struct scsi_read_capacity 2740 { 2741 u_int8_t opcode; 2742 u_int8_t byte2; 2743 #define SRC_RELADR 0x01 2744 u_int8_t addr[4]; 2745 u_int8_t unused[2]; 2746 u_int8_t pmi; 2747 #define SRC_PMI 0x01 2748 u_int8_t control; 2749 }; 2750 2751 struct scsi_read_capacity_16 2752 { 2753 uint8_t opcode; 2754 #define SRC16_SERVICE_ACTION 0x10 2755 uint8_t service_action; 2756 uint8_t addr[8]; 2757 uint8_t alloc_len[4]; 2758 #define SRC16_PMI 0x01 2759 #define SRC16_RELADR 0x02 2760 uint8_t reladr; 2761 uint8_t control; 2762 }; 2763 2764 struct scsi_read_capacity_data 2765 { 2766 u_int8_t addr[4]; 2767 u_int8_t length[4]; 2768 }; 2769 2770 struct scsi_read_capacity_data_long 2771 { 2772 uint8_t addr[8]; 2773 uint8_t length[4]; 2774 #define SRC16_PROT_EN 0x01 2775 #define SRC16_P_TYPE 0x0e 2776 #define SRC16_PTYPE_1 0x00 2777 #define SRC16_PTYPE_2 0x02 2778 #define SRC16_PTYPE_3 0x04 2779 uint8_t prot; 2780 #define SRC16_LBPPBE 0x0f 2781 #define SRC16_PI_EXPONENT 0xf0 2782 #define SRC16_PI_EXPONENT_SHIFT 4 2783 uint8_t prot_lbppbe; 2784 #define SRC16_LALBA 0x3f 2785 #define SRC16_LBPRZ 0x40 2786 #define SRC16_LBPME 0x80 2787 /* 2788 * Alternate versions of these macros that are intended for use on a 16-bit 2789 * version of the lalba_lbp field instead of the array of 2 8 bit numbers. 2790 */ 2791 #define SRC16_LALBA_A 0x3fff 2792 #define SRC16_LBPRZ_A 0x4000 2793 #define SRC16_LBPME_A 0x8000 2794 uint8_t lalba_lbp[2]; 2795 uint8_t reserved[16]; 2796 }; 2797 2798 struct scsi_get_lba_status 2799 { 2800 uint8_t opcode; 2801 #define SGLS_SERVICE_ACTION 0x12 2802 uint8_t service_action; 2803 uint8_t addr[8]; 2804 uint8_t alloc_len[4]; 2805 uint8_t reserved; 2806 uint8_t control; 2807 }; 2808 2809 struct scsi_get_lba_status_data_descr 2810 { 2811 uint8_t addr[8]; 2812 uint8_t length[4]; 2813 uint8_t status; 2814 uint8_t reserved[3]; 2815 }; 2816 2817 struct scsi_get_lba_status_data 2818 { 2819 uint8_t length[4]; 2820 uint8_t reserved[4]; 2821 struct scsi_get_lba_status_data_descr descr[]; 2822 }; 2823 2824 struct scsi_report_luns 2825 { 2826 uint8_t opcode; 2827 uint8_t reserved1; 2828 #define RPL_REPORT_DEFAULT 0x00 2829 #define RPL_REPORT_WELLKNOWN 0x01 2830 #define RPL_REPORT_ALL 0x02 2831 uint8_t select_report; 2832 uint8_t reserved2[3]; 2833 uint8_t length[4]; 2834 uint8_t reserved3; 2835 uint8_t control; 2836 }; 2837 2838 struct scsi_report_luns_lundata { 2839 uint8_t lundata[8]; 2840 #define RPL_LUNDATA_PERIPH_BUS_MASK 0x3f 2841 #define RPL_LUNDATA_FLAT_LUN_MASK 0x3f 2842 #define RPL_LUNDATA_FLAT_LUN_BITS 0x06 2843 #define RPL_LUNDATA_LUN_TARG_MASK 0x3f 2844 #define RPL_LUNDATA_LUN_BUS_MASK 0xe0 2845 #define RPL_LUNDATA_LUN_LUN_MASK 0x1f 2846 #define RPL_LUNDATA_EXT_LEN_MASK 0x30 2847 #define RPL_LUNDATA_EXT_EAM_MASK 0x0f 2848 #define RPL_LUNDATA_EXT_EAM_WK 0x01 2849 #define RPL_LUNDATA_EXT_EAM_NOT_SPEC 0x0f 2850 #define RPL_LUNDATA_ATYP_MASK 0xc0 /* MBZ for type 0 lun */ 2851 #define RPL_LUNDATA_ATYP_PERIPH 0x00 2852 #define RPL_LUNDATA_ATYP_FLAT 0x40 2853 #define RPL_LUNDATA_ATYP_LUN 0x80 2854 #define RPL_LUNDATA_ATYP_EXTLUN 0xc0 2855 }; 2856 2857 struct scsi_report_luns_data { 2858 u_int8_t length[4]; /* length of LUN inventory, in bytes */ 2859 u_int8_t reserved[4]; /* unused */ 2860 /* 2861 * LUN inventory- we only support the type zero form for now. 2862 */ 2863 struct scsi_report_luns_lundata luns[0]; 2864 }; 2865 2866 struct scsi_target_group 2867 { 2868 uint8_t opcode; 2869 uint8_t service_action; 2870 #define STG_PDF_MASK 0xe0 2871 #define STG_PDF_LENGTH 0x00 2872 #define STG_PDF_EXTENDED 0x20 2873 uint8_t reserved1[4]; 2874 uint8_t length[4]; 2875 uint8_t reserved2; 2876 uint8_t control; 2877 }; 2878 2879 struct scsi_target_port_descriptor { 2880 uint8_t reserved[2]; 2881 uint8_t relative_target_port_identifier[2]; 2882 uint8_t desc_list[]; 2883 }; 2884 2885 struct scsi_target_port_group_descriptor { 2886 uint8_t pref_state; 2887 #define TPG_PRIMARY 0x80 2888 #define TPG_ASYMMETRIC_ACCESS_STATE_MASK 0xf 2889 #define TPG_ASYMMETRIC_ACCESS_OPTIMIZED 0x0 2890 #define TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED 0x1 2891 #define TPG_ASYMMETRIC_ACCESS_STANDBY 0x2 2892 #define TPG_ASYMMETRIC_ACCESS_UNAVAILABLE 0x3 2893 #define TPG_ASYMMETRIC_ACCESS_LBA_DEPENDENT 0x4 2894 #define TPG_ASYMMETRIC_ACCESS_OFFLINE 0xE 2895 #define TPG_ASYMMETRIC_ACCESS_TRANSITIONING 0xF 2896 uint8_t support; 2897 #define TPG_AO_SUP 0x01 2898 #define TPG_AN_SUP 0x02 2899 #define TPG_S_SUP 0x04 2900 #define TPG_U_SUP 0x08 2901 #define TPG_LBD_SUP 0x10 2902 #define TPG_O_SUP 0x40 2903 #define TPG_T_SUP 0x80 2904 uint8_t target_port_group[2]; 2905 uint8_t reserved; 2906 uint8_t status; 2907 #define TPG_UNAVLBL 0 2908 #define TPG_SET_BY_STPG 0x01 2909 #define TPG_IMPLICIT 0x02 2910 uint8_t vendor_specific; 2911 uint8_t target_port_count; 2912 struct scsi_target_port_descriptor descriptors[]; 2913 }; 2914 2915 struct scsi_target_group_data { 2916 uint8_t length[4]; /* length of returned data, in bytes */ 2917 struct scsi_target_port_group_descriptor groups[]; 2918 }; 2919 2920 struct scsi_target_group_data_extended { 2921 uint8_t length[4]; /* length of returned data, in bytes */ 2922 uint8_t format_type; /* STG_PDF_LENGTH or STG_PDF_EXTENDED */ 2923 uint8_t implicit_transition_time; 2924 uint8_t reserved[2]; 2925 struct scsi_target_port_group_descriptor groups[]; 2926 }; 2927 2928 struct scsi_security_protocol_in 2929 { 2930 uint8_t opcode; 2931 uint8_t security_protocol; 2932 #define SPI_PROT_INFORMATION 0x00 2933 #define SPI_PROT_CBCS 0x07 2934 #define SPI_PROT_TAPE_DATA_ENC 0x20 2935 #define SPI_PROT_DATA_ENC_CONFIG 0x21 2936 #define SPI_PROT_SA_CREATE_CAP 0x40 2937 #define SPI_PROT_IKEV2_SCSI 0x41 2938 #define SPI_PROT_JEDEC_UFS 0xEC 2939 #define SPI_PROT_SDCARD_TFSSS 0xED 2940 #define SPI_PROT_AUTH_HOST_TRANSIENT 0xEE 2941 #define SPI_PROT_ATA_DEVICE_PASSWORD 0xEF 2942 uint8_t security_protocol_specific[2]; 2943 uint8_t byte4; 2944 #define SPI_INC_512 0x80 2945 uint8_t reserved1; 2946 uint8_t length[4]; 2947 uint8_t reserved2; 2948 uint8_t control; 2949 }; 2950 2951 struct scsi_security_protocol_out 2952 { 2953 uint8_t opcode; 2954 uint8_t security_protocol; 2955 uint8_t security_protocol_specific[2]; 2956 uint8_t byte4; 2957 #define SPO_INC_512 0x80 2958 uint8_t reserved1; 2959 uint8_t length[4]; 2960 uint8_t reserved2; 2961 uint8_t control; 2962 }; 2963 2964 typedef enum { 2965 SSD_TYPE_NONE, 2966 SSD_TYPE_FIXED, 2967 SSD_TYPE_DESC 2968 } scsi_sense_data_type; 2969 2970 typedef enum { 2971 SSD_ELEM_NONE, 2972 SSD_ELEM_SKIP, 2973 SSD_ELEM_DESC, 2974 SSD_ELEM_SKS, 2975 SSD_ELEM_COMMAND, 2976 SSD_ELEM_INFO, 2977 SSD_ELEM_FRU, 2978 SSD_ELEM_STREAM, 2979 SSD_ELEM_MAX 2980 } scsi_sense_elem_type; 2981 2982 2983 struct scsi_sense_data 2984 { 2985 uint8_t error_code; 2986 /* 2987 * SPC-4 says that the maximum length of sense data is 252 bytes. 2988 * So this structure is exactly 252 bytes log. 2989 */ 2990 #define SSD_FULL_SIZE 252 2991 uint8_t sense_buf[SSD_FULL_SIZE - 1]; 2992 /* 2993 * XXX KDM is this still a reasonable minimum size? 2994 */ 2995 #define SSD_MIN_SIZE 18 2996 /* 2997 * Maximum value for the extra_len field in the sense data. 2998 */ 2999 #define SSD_EXTRA_MAX 244 3000 }; 3001 3002 /* 3003 * Fixed format sense data. 3004 */ 3005 struct scsi_sense_data_fixed 3006 { 3007 u_int8_t error_code; 3008 #define SSD_ERRCODE 0x7F 3009 #define SSD_CURRENT_ERROR 0x70 3010 #define SSD_DEFERRED_ERROR 0x71 3011 #define SSD_ERRCODE_VALID 0x80 3012 u_int8_t segment; 3013 u_int8_t flags; 3014 #define SSD_KEY 0x0F 3015 #define SSD_KEY_NO_SENSE 0x00 3016 #define SSD_KEY_RECOVERED_ERROR 0x01 3017 #define SSD_KEY_NOT_READY 0x02 3018 #define SSD_KEY_MEDIUM_ERROR 0x03 3019 #define SSD_KEY_HARDWARE_ERROR 0x04 3020 #define SSD_KEY_ILLEGAL_REQUEST 0x05 3021 #define SSD_KEY_UNIT_ATTENTION 0x06 3022 #define SSD_KEY_DATA_PROTECT 0x07 3023 #define SSD_KEY_BLANK_CHECK 0x08 3024 #define SSD_KEY_Vendor_Specific 0x09 3025 #define SSD_KEY_COPY_ABORTED 0x0a 3026 #define SSD_KEY_ABORTED_COMMAND 0x0b 3027 #define SSD_KEY_EQUAL 0x0c 3028 #define SSD_KEY_VOLUME_OVERFLOW 0x0d 3029 #define SSD_KEY_MISCOMPARE 0x0e 3030 #define SSD_KEY_COMPLETED 0x0f 3031 #define SSD_ILI 0x20 3032 #define SSD_EOM 0x40 3033 #define SSD_FILEMARK 0x80 3034 u_int8_t info[4]; 3035 u_int8_t extra_len; 3036 u_int8_t cmd_spec_info[4]; 3037 u_int8_t add_sense_code; 3038 u_int8_t add_sense_code_qual; 3039 u_int8_t fru; 3040 u_int8_t sense_key_spec[3]; 3041 #define SSD_SCS_VALID 0x80 3042 #define SSD_FIELDPTR_CMD 0x40 3043 #define SSD_BITPTR_VALID 0x08 3044 #define SSD_BITPTR_VALUE 0x07 3045 u_int8_t extra_bytes[14]; 3046 #define SSD_FIXED_IS_PRESENT(sense, length, field) \ 3047 ((length >= (offsetof(struct scsi_sense_data_fixed, field) + \ 3048 sizeof(sense->field))) ? 1 :0) 3049 #define SSD_FIXED_IS_FILLED(sense, field) \ 3050 ((((offsetof(struct scsi_sense_data_fixed, field) + \ 3051 sizeof(sense->field)) - \ 3052 (offsetof(struct scsi_sense_data_fixed, extra_len) + \ 3053 sizeof(sense->extra_len))) <= sense->extra_len) ? 1 : 0) 3054 }; 3055 3056 /* 3057 * Descriptor format sense data definitions. 3058 * Introduced in SPC-3. 3059 */ 3060 struct scsi_sense_data_desc 3061 { 3062 uint8_t error_code; 3063 #define SSD_DESC_CURRENT_ERROR 0x72 3064 #define SSD_DESC_DEFERRED_ERROR 0x73 3065 uint8_t sense_key; 3066 uint8_t add_sense_code; 3067 uint8_t add_sense_code_qual; 3068 uint8_t reserved[3]; 3069 /* 3070 * Note that SPC-4, section 4.5.2.1 says that the extra_len field 3071 * must be less than or equal to 244. 3072 */ 3073 uint8_t extra_len; 3074 uint8_t sense_desc[0]; 3075 #define SSD_DESC_IS_PRESENT(sense, length, field) \ 3076 ((length >= (offsetof(struct scsi_sense_data_desc, field) + \ 3077 sizeof(sense->field))) ? 1 :0) 3078 }; 3079 3080 struct scsi_sense_desc_header 3081 { 3082 uint8_t desc_type; 3083 uint8_t length; 3084 }; 3085 /* 3086 * The information provide in the Information descriptor is device type or 3087 * command specific information, and defined in a command standard. 3088 * 3089 * Note that any changes to the field names or positions in this structure, 3090 * even reserved fields, should be accompanied by an examination of the 3091 * code in ctl_set_sense() that uses them. 3092 * 3093 * Maximum descriptors allowed: 1 (as of SPC-4) 3094 */ 3095 struct scsi_sense_info 3096 { 3097 uint8_t desc_type; 3098 #define SSD_DESC_INFO 0x00 3099 uint8_t length; 3100 uint8_t byte2; 3101 #define SSD_INFO_VALID 0x80 3102 uint8_t reserved; 3103 uint8_t info[8]; 3104 }; 3105 3106 /* 3107 * Command-specific information depends on the command for which the 3108 * reported condition occured. 3109 * 3110 * Note that any changes to the field names or positions in this structure, 3111 * even reserved fields, should be accompanied by an examination of the 3112 * code in ctl_set_sense() that uses them. 3113 * 3114 * Maximum descriptors allowed: 1 (as of SPC-4) 3115 */ 3116 struct scsi_sense_command 3117 { 3118 uint8_t desc_type; 3119 #define SSD_DESC_COMMAND 0x01 3120 uint8_t length; 3121 uint8_t reserved[2]; 3122 uint8_t command_info[8]; 3123 }; 3124 3125 /* 3126 * Sense key specific descriptor. The sense key specific data format 3127 * depends on the sense key in question. 3128 * 3129 * Maximum descriptors allowed: 1 (as of SPC-4) 3130 */ 3131 struct scsi_sense_sks 3132 { 3133 uint8_t desc_type; 3134 #define SSD_DESC_SKS 0x02 3135 uint8_t length; 3136 uint8_t reserved1[2]; 3137 uint8_t sense_key_spec[3]; 3138 #define SSD_SKS_VALID 0x80 3139 uint8_t reserved2; 3140 }; 3141 3142 /* 3143 * This is used for the Illegal Request sense key (0x05) only. 3144 */ 3145 struct scsi_sense_sks_field 3146 { 3147 uint8_t byte0; 3148 #define SSD_SKS_FIELD_VALID 0x80 3149 #define SSD_SKS_FIELD_CMD 0x40 3150 #define SSD_SKS_BPV 0x08 3151 #define SSD_SKS_BIT_VALUE 0x07 3152 uint8_t field[2]; 3153 }; 3154 3155 3156 /* 3157 * This is used for the Hardware Error (0x04), Medium Error (0x03) and 3158 * Recovered Error (0x01) sense keys. 3159 */ 3160 struct scsi_sense_sks_retry 3161 { 3162 uint8_t byte0; 3163 #define SSD_SKS_RETRY_VALID 0x80 3164 uint8_t actual_retry_count[2]; 3165 }; 3166 3167 /* 3168 * Used with the NO Sense (0x00) or Not Ready (0x02) sense keys. 3169 */ 3170 struct scsi_sense_sks_progress 3171 { 3172 uint8_t byte0; 3173 #define SSD_SKS_PROGRESS_VALID 0x80 3174 uint8_t progress[2]; 3175 #define SSD_SKS_PROGRESS_DENOM 0x10000 3176 }; 3177 3178 /* 3179 * Used with the Copy Aborted (0x0a) sense key. 3180 */ 3181 struct scsi_sense_sks_segment 3182 { 3183 uint8_t byte0; 3184 #define SSD_SKS_SEGMENT_VALID 0x80 3185 #define SSD_SKS_SEGMENT_SD 0x20 3186 #define SSD_SKS_SEGMENT_BPV 0x08 3187 #define SSD_SKS_SEGMENT_BITPTR 0x07 3188 uint8_t field[2]; 3189 }; 3190 3191 /* 3192 * Used with the Unit Attention (0x06) sense key. 3193 * 3194 * This is currently used to indicate that the unit attention condition 3195 * queue has overflowed (when the overflow bit is set). 3196 */ 3197 struct scsi_sense_sks_overflow 3198 { 3199 uint8_t byte0; 3200 #define SSD_SKS_OVERFLOW_VALID 0x80 3201 #define SSD_SKS_OVERFLOW_SET 0x01 3202 uint8_t reserved[2]; 3203 }; 3204 3205 /* 3206 * This specifies which component is associated with the sense data. There 3207 * is no standard meaning for the fru value. 3208 * 3209 * Maximum descriptors allowed: 1 (as of SPC-4) 3210 */ 3211 struct scsi_sense_fru 3212 { 3213 uint8_t desc_type; 3214 #define SSD_DESC_FRU 0x03 3215 uint8_t length; 3216 uint8_t reserved; 3217 uint8_t fru; 3218 }; 3219 3220 /* 3221 * Used for Stream commands, defined in SSC-4. 3222 * 3223 * Maximum descriptors allowed: 1 (as of SPC-4) 3224 */ 3225 3226 struct scsi_sense_stream 3227 { 3228 uint8_t desc_type; 3229 #define SSD_DESC_STREAM 0x04 3230 uint8_t length; 3231 uint8_t reserved; 3232 uint8_t byte3; 3233 #define SSD_DESC_STREAM_FM 0x80 3234 #define SSD_DESC_STREAM_EOM 0x40 3235 #define SSD_DESC_STREAM_ILI 0x20 3236 }; 3237 3238 /* 3239 * Used for Block commands, defined in SBC-3. 3240 * 3241 * This is currently (as of SBC-3) only used for the Incorrect Length 3242 * Indication (ILI) bit, which says that the data length requested in the 3243 * READ LONG or WRITE LONG command did not match the length of the logical 3244 * block. 3245 * 3246 * Maximum descriptors allowed: 1 (as of SPC-4) 3247 */ 3248 struct scsi_sense_block 3249 { 3250 uint8_t desc_type; 3251 #define SSD_DESC_BLOCK 0x05 3252 uint8_t length; 3253 uint8_t reserved; 3254 uint8_t byte3; 3255 #define SSD_DESC_BLOCK_ILI 0x20 3256 }; 3257 3258 /* 3259 * Used for Object-Based Storage Devices (OSD-3). 3260 * 3261 * Maximum descriptors allowed: 1 (as of SPC-4) 3262 */ 3263 struct scsi_sense_osd_objid 3264 { 3265 uint8_t desc_type; 3266 #define SSD_DESC_OSD_OBJID 0x06 3267 uint8_t length; 3268 uint8_t reserved[6]; 3269 /* 3270 * XXX KDM provide the bit definitions here? There are a lot of 3271 * them, and we don't have an OSD driver yet. 3272 */ 3273 uint8_t not_init_cmds[4]; 3274 uint8_t completed_cmds[4]; 3275 uint8_t partition_id[8]; 3276 uint8_t object_id[8]; 3277 }; 3278 3279 /* 3280 * Used for Object-Based Storage Devices (OSD-3). 3281 * 3282 * Maximum descriptors allowed: 1 (as of SPC-4) 3283 */ 3284 struct scsi_sense_osd_integrity 3285 { 3286 uint8_t desc_type; 3287 #define SSD_DESC_OSD_INTEGRITY 0x07 3288 uint8_t length; 3289 uint8_t integ_check_val[32]; 3290 }; 3291 3292 /* 3293 * Used for Object-Based Storage Devices (OSD-3). 3294 * 3295 * Maximum descriptors allowed: 1 (as of SPC-4) 3296 */ 3297 struct scsi_sense_osd_attr_id 3298 { 3299 uint8_t desc_type; 3300 #define SSD_DESC_OSD_ATTR_ID 0x08 3301 uint8_t length; 3302 uint8_t reserved[2]; 3303 uint8_t attr_desc[0]; 3304 }; 3305 3306 /* 3307 * Used with Sense keys No Sense (0x00) and Not Ready (0x02). 3308 * 3309 * Maximum descriptors allowed: 32 (as of SPC-4) 3310 */ 3311 struct scsi_sense_progress 3312 { 3313 uint8_t desc_type; 3314 #define SSD_DESC_PROGRESS 0x0a 3315 uint8_t length; 3316 uint8_t sense_key; 3317 uint8_t add_sense_code; 3318 uint8_t add_sense_code_qual; 3319 uint8_t reserved; 3320 uint8_t progress[2]; 3321 }; 3322 3323 /* 3324 * This is typically forwarded as the result of an EXTENDED COPY command. 3325 * 3326 * Maximum descriptors allowed: 2 (as of SPC-4) 3327 */ 3328 struct scsi_sense_forwarded 3329 { 3330 uint8_t desc_type; 3331 #define SSD_DESC_FORWARDED 0x0c 3332 uint8_t length; 3333 uint8_t byte2; 3334 #define SSD_FORWARDED_FSDT 0x80 3335 #define SSD_FORWARDED_SDS_MASK 0x0f 3336 #define SSD_FORWARDED_SDS_UNK 0x00 3337 #define SSD_FORWARDED_SDS_EXSRC 0x01 3338 #define SSD_FORWARDED_SDS_EXDST 0x02 3339 }; 3340 3341 /* 3342 * Vendor-specific sense descriptor. The desc_type field will be in the 3343 * range bewteen MIN and MAX inclusive. 3344 */ 3345 struct scsi_sense_vendor 3346 { 3347 uint8_t desc_type; 3348 #define SSD_DESC_VENDOR_MIN 0x80 3349 #define SSD_DESC_VENDOR_MAX 0xff 3350 uint8_t length; 3351 uint8_t data[0]; 3352 }; 3353 3354 struct scsi_mode_header_6 3355 { 3356 u_int8_t data_length; /* Sense data length */ 3357 u_int8_t medium_type; 3358 u_int8_t dev_spec; 3359 u_int8_t blk_desc_len; 3360 }; 3361 3362 struct scsi_mode_header_10 3363 { 3364 u_int8_t data_length[2];/* Sense data length */ 3365 u_int8_t medium_type; 3366 u_int8_t dev_spec; 3367 u_int8_t unused[2]; 3368 u_int8_t blk_desc_len[2]; 3369 }; 3370 3371 struct scsi_mode_page_header 3372 { 3373 u_int8_t page_code; 3374 #define SMPH_PS 0x80 3375 #define SMPH_SPF 0x40 3376 #define SMPH_PC_MASK 0x3f 3377 u_int8_t page_length; 3378 }; 3379 3380 struct scsi_mode_page_header_sp 3381 { 3382 uint8_t page_code; 3383 uint8_t subpage; 3384 uint8_t page_length[2]; 3385 }; 3386 3387 3388 struct scsi_mode_blk_desc 3389 { 3390 u_int8_t density; 3391 u_int8_t nblocks[3]; 3392 u_int8_t reserved; 3393 u_int8_t blklen[3]; 3394 }; 3395 3396 #define SCSI_DEFAULT_DENSITY 0x00 /* use 'default' density */ 3397 #define SCSI_SAME_DENSITY 0x7f /* use 'same' density- >= SCSI-2 only */ 3398 3399 3400 /* 3401 * Status Byte 3402 */ 3403 #define SCSI_STATUS_OK 0x00 3404 #define SCSI_STATUS_CHECK_COND 0x02 3405 #define SCSI_STATUS_COND_MET 0x04 3406 #define SCSI_STATUS_BUSY 0x08 3407 #define SCSI_STATUS_INTERMED 0x10 3408 #define SCSI_STATUS_INTERMED_COND_MET 0x14 3409 #define SCSI_STATUS_RESERV_CONFLICT 0x18 3410 #define SCSI_STATUS_CMD_TERMINATED 0x22 /* Obsolete in SAM-2 */ 3411 #define SCSI_STATUS_QUEUE_FULL 0x28 3412 #define SCSI_STATUS_ACA_ACTIVE 0x30 3413 #define SCSI_STATUS_TASK_ABORTED 0x40 3414 3415 struct scsi_inquiry_pattern { 3416 u_int8_t type; 3417 u_int8_t media_type; 3418 #define SIP_MEDIA_REMOVABLE 0x01 3419 #define SIP_MEDIA_FIXED 0x02 3420 const char *vendor; 3421 const char *product; 3422 const char *revision; 3423 }; 3424 3425 struct scsi_static_inquiry_pattern { 3426 u_int8_t type; 3427 u_int8_t media_type; 3428 char vendor[SID_VENDOR_SIZE+1]; 3429 char product[SID_PRODUCT_SIZE+1]; 3430 char revision[SID_REVISION_SIZE+1]; 3431 }; 3432 3433 struct scsi_sense_quirk_entry { 3434 struct scsi_inquiry_pattern inq_pat; 3435 int num_sense_keys; 3436 int num_ascs; 3437 struct sense_key_table_entry *sense_key_info; 3438 struct asc_table_entry *asc_info; 3439 }; 3440 3441 struct sense_key_table_entry { 3442 u_int8_t sense_key; 3443 u_int32_t action; 3444 const char *desc; 3445 }; 3446 3447 struct asc_table_entry { 3448 u_int8_t asc; 3449 u_int8_t ascq; 3450 u_int32_t action; 3451 const char *desc; 3452 }; 3453 3454 struct op_table_entry { 3455 u_int8_t opcode; 3456 u_int32_t opmask; 3457 const char *desc; 3458 }; 3459 3460 struct scsi_op_quirk_entry { 3461 struct scsi_inquiry_pattern inq_pat; 3462 int num_ops; 3463 struct op_table_entry *op_table; 3464 }; 3465 3466 typedef enum { 3467 SSS_FLAG_NONE = 0x00, 3468 SSS_FLAG_PRINT_COMMAND = 0x01 3469 } scsi_sense_string_flags; 3470 3471 struct scsi_nv { 3472 const char *name; 3473 uint64_t value; 3474 }; 3475 3476 typedef enum { 3477 SCSI_NV_FOUND, 3478 SCSI_NV_AMBIGUOUS, 3479 SCSI_NV_NOT_FOUND 3480 } scsi_nv_status; 3481 3482 typedef enum { 3483 SCSI_NV_FLAG_NONE = 0x00, 3484 SCSI_NV_FLAG_IG_CASE = 0x01 /* Case insensitive comparison */ 3485 } scsi_nv_flags; 3486 3487 struct ccb_scsiio; 3488 struct cam_periph; 3489 union ccb; 3490 #ifndef _KERNEL 3491 struct cam_device; 3492 #endif 3493 3494 extern const char *scsi_sense_key_text[]; 3495 3496 __BEGIN_DECLS 3497 void scsi_sense_desc(int sense_key, int asc, int ascq, 3498 struct scsi_inquiry_data *inq_data, 3499 const char **sense_key_desc, const char **asc_desc); 3500 scsi_sense_action scsi_error_action(struct ccb_scsiio* csio, 3501 struct scsi_inquiry_data *inq_data, 3502 u_int32_t sense_flags); 3503 const char * scsi_status_string(struct ccb_scsiio *csio); 3504 3505 void scsi_desc_iterate(struct scsi_sense_data_desc *sense, u_int sense_len, 3506 int (*iter_func)(struct scsi_sense_data_desc *sense, 3507 u_int, struct scsi_sense_desc_header *, 3508 void *), void *arg); 3509 uint8_t *scsi_find_desc(struct scsi_sense_data_desc *sense, u_int sense_len, 3510 uint8_t desc_type); 3511 void scsi_set_sense_data(struct scsi_sense_data *sense_data, 3512 scsi_sense_data_type sense_format, int current_error, 3513 int sense_key, int asc, int ascq, ...) ; 3514 void scsi_set_sense_data_va(struct scsi_sense_data *sense_data, 3515 scsi_sense_data_type sense_format, 3516 int current_error, int sense_key, int asc, 3517 int ascq, va_list ap); 3518 int scsi_get_sense_info(struct scsi_sense_data *sense_data, u_int sense_len, 3519 uint8_t info_type, uint64_t *info, 3520 int64_t *signed_info); 3521 int scsi_get_sks(struct scsi_sense_data *sense_data, u_int sense_len, 3522 uint8_t *sks); 3523 int scsi_get_block_info(struct scsi_sense_data *sense_data, u_int sense_len, 3524 struct scsi_inquiry_data *inq_data, 3525 uint8_t *block_bits); 3526 int scsi_get_stream_info(struct scsi_sense_data *sense_data, u_int sense_len, 3527 struct scsi_inquiry_data *inq_data, 3528 uint8_t *stream_bits); 3529 void scsi_info_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len, 3530 struct scsi_inquiry_data *inq_data, uint64_t info); 3531 void scsi_command_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len, 3532 struct scsi_inquiry_data *inq_data, uint64_t csi); 3533 void scsi_progress_sbuf(struct sbuf *sb, uint16_t progress); 3534 int scsi_sks_sbuf(struct sbuf *sb, int sense_key, uint8_t *sks); 3535 void scsi_fru_sbuf(struct sbuf *sb, uint64_t fru); 3536 void scsi_stream_sbuf(struct sbuf *sb, uint8_t stream_bits, uint64_t info); 3537 void scsi_block_sbuf(struct sbuf *sb, uint8_t block_bits, uint64_t info); 3538 void scsi_sense_info_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 3539 u_int sense_len, uint8_t *cdb, int cdb_len, 3540 struct scsi_inquiry_data *inq_data, 3541 struct scsi_sense_desc_header *header); 3542 3543 void scsi_sense_command_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 3544 u_int sense_len, uint8_t *cdb, int cdb_len, 3545 struct scsi_inquiry_data *inq_data, 3546 struct scsi_sense_desc_header *header); 3547 void scsi_sense_sks_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 3548 u_int sense_len, uint8_t *cdb, int cdb_len, 3549 struct scsi_inquiry_data *inq_data, 3550 struct scsi_sense_desc_header *header); 3551 void scsi_sense_fru_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 3552 u_int sense_len, uint8_t *cdb, int cdb_len, 3553 struct scsi_inquiry_data *inq_data, 3554 struct scsi_sense_desc_header *header); 3555 void scsi_sense_stream_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 3556 u_int sense_len, uint8_t *cdb, int cdb_len, 3557 struct scsi_inquiry_data *inq_data, 3558 struct scsi_sense_desc_header *header); 3559 void scsi_sense_block_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 3560 u_int sense_len, uint8_t *cdb, int cdb_len, 3561 struct scsi_inquiry_data *inq_data, 3562 struct scsi_sense_desc_header *header); 3563 void scsi_sense_progress_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 3564 u_int sense_len, uint8_t *cdb, int cdb_len, 3565 struct scsi_inquiry_data *inq_data, 3566 struct scsi_sense_desc_header *header); 3567 void scsi_sense_generic_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 3568 u_int sense_len, uint8_t *cdb, int cdb_len, 3569 struct scsi_inquiry_data *inq_data, 3570 struct scsi_sense_desc_header *header); 3571 void scsi_sense_desc_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 3572 u_int sense_len, uint8_t *cdb, int cdb_len, 3573 struct scsi_inquiry_data *inq_data, 3574 struct scsi_sense_desc_header *header); 3575 scsi_sense_data_type scsi_sense_type(struct scsi_sense_data *sense_data); 3576 3577 void scsi_sense_only_sbuf(struct scsi_sense_data *sense, u_int sense_len, 3578 struct sbuf *sb, char *path_str, 3579 struct scsi_inquiry_data *inq_data, uint8_t *cdb, 3580 int cdb_len); 3581 3582 #ifdef _KERNEL 3583 int scsi_command_string(struct ccb_scsiio *csio, struct sbuf *sb); 3584 int scsi_sense_sbuf(struct ccb_scsiio *csio, struct sbuf *sb, 3585 scsi_sense_string_flags flags); 3586 char * scsi_sense_string(struct ccb_scsiio *csio, 3587 char *str, int str_len); 3588 void scsi_sense_print(struct ccb_scsiio *csio); 3589 int scsi_vpd_supported_page(struct cam_periph *periph, 3590 uint8_t page_id); 3591 #else /* _KERNEL */ 3592 int scsi_command_string(struct cam_device *device, 3593 struct ccb_scsiio *csio, struct sbuf *sb); 3594 int scsi_sense_sbuf(struct cam_device *device, 3595 struct ccb_scsiio *csio, struct sbuf *sb, 3596 scsi_sense_string_flags flags); 3597 char * scsi_sense_string(struct cam_device *device, 3598 struct ccb_scsiio *csio, 3599 char *str, int str_len); 3600 void scsi_sense_print(struct cam_device *device, 3601 struct ccb_scsiio *csio, FILE *ofile); 3602 #endif /* _KERNEL */ 3603 3604 const char * scsi_op_desc(u_int16_t opcode, 3605 struct scsi_inquiry_data *inq_data); 3606 char * scsi_cdb_string(u_int8_t *cdb_ptr, char *cdb_string, 3607 size_t len); 3608 3609 void scsi_print_inquiry(struct scsi_inquiry_data *inq_data); 3610 void scsi_print_inquiry_short(struct scsi_inquiry_data *inq_data); 3611 3612 u_int scsi_calc_syncsrate(u_int period_factor); 3613 u_int scsi_calc_syncparam(u_int period); 3614 3615 typedef int (*scsi_devid_checkfn_t)(uint8_t *); 3616 int scsi_devid_is_naa_ieee_reg(uint8_t *bufp); 3617 int scsi_devid_is_sas_target(uint8_t *bufp); 3618 int scsi_devid_is_lun_eui64(uint8_t *bufp); 3619 int scsi_devid_is_lun_naa(uint8_t *bufp); 3620 int scsi_devid_is_lun_name(uint8_t *bufp); 3621 int scsi_devid_is_lun_t10(uint8_t *bufp); 3622 struct scsi_vpd_id_descriptor * 3623 scsi_get_devid(struct scsi_vpd_device_id *id, uint32_t len, 3624 scsi_devid_checkfn_t ck_fn); 3625 struct scsi_vpd_id_descriptor * 3626 scsi_get_devid_desc(struct scsi_vpd_id_descriptor *desc, uint32_t len, 3627 scsi_devid_checkfn_t ck_fn); 3628 3629 int scsi_transportid_sbuf(struct sbuf *sb, 3630 struct scsi_transportid_header *hdr, 3631 uint32_t valid_len); 3632 3633 const char * scsi_nv_to_str(struct scsi_nv *table, int num_table_entries, 3634 uint64_t value); 3635 3636 scsi_nv_status scsi_get_nv(struct scsi_nv *table, int num_table_entries, 3637 char *name, int *table_entry, scsi_nv_flags flags); 3638 3639 int scsi_parse_transportid_64bit(int proto_id, char *id_str, 3640 struct scsi_transportid_header **hdr, 3641 unsigned int *alloc_len, 3642 #ifdef _KERNEL 3643 struct malloc_type *type, int flags, 3644 #endif 3645 char *error_str, int error_str_len); 3646 3647 int scsi_parse_transportid_spi(char *id_str, 3648 struct scsi_transportid_header **hdr, 3649 unsigned int *alloc_len, 3650 #ifdef _KERNEL 3651 struct malloc_type *type, int flags, 3652 #endif 3653 char *error_str, int error_str_len); 3654 3655 int scsi_parse_transportid_rdma(char *id_str, 3656 struct scsi_transportid_header **hdr, 3657 unsigned int *alloc_len, 3658 #ifdef _KERNEL 3659 struct malloc_type *type, int flags, 3660 #endif 3661 char *error_str, int error_str_len); 3662 3663 int scsi_parse_transportid_iscsi(char *id_str, 3664 struct scsi_transportid_header **hdr, 3665 unsigned int *alloc_len, 3666 #ifdef _KERNEL 3667 struct malloc_type *type, int flags, 3668 #endif 3669 char *error_str,int error_str_len); 3670 3671 int scsi_parse_transportid_sop(char *id_str, 3672 struct scsi_transportid_header **hdr, 3673 unsigned int *alloc_len, 3674 #ifdef _KERNEL 3675 struct malloc_type *type, int flags, 3676 #endif 3677 char *error_str,int error_str_len); 3678 3679 int scsi_parse_transportid(char *transportid_str, 3680 struct scsi_transportid_header **hdr, 3681 unsigned int *alloc_len, 3682 #ifdef _KERNEL 3683 struct malloc_type *type, int flags, 3684 #endif 3685 char *error_str, int error_str_len); 3686 3687 3688 int scsi_attrib_volcoh_sbuf(struct sbuf *sb, 3689 struct scsi_mam_attribute_header *hdr, 3690 uint32_t valid_len, uint32_t flags, 3691 uint32_t output_flags, char *error_str, 3692 int error_str_len); 3693 3694 int scsi_attrib_vendser_sbuf(struct sbuf *sb, 3695 struct scsi_mam_attribute_header *hdr, 3696 uint32_t valid_len, uint32_t flags, 3697 uint32_t output_flags, char *error_str, 3698 int error_str_len); 3699 3700 int scsi_attrib_hexdump_sbuf(struct sbuf *sb, 3701 struct scsi_mam_attribute_header *hdr, 3702 uint32_t valid_len, uint32_t flags, 3703 uint32_t output_flags, char *error_str, 3704 int error_str_len); 3705 3706 int scsi_attrib_int_sbuf(struct sbuf *sb, struct scsi_mam_attribute_header *hdr, 3707 uint32_t valid_len, uint32_t flags, 3708 uint32_t output_flags, char *error_str, 3709 int error_str_len); 3710 3711 int scsi_attrib_ascii_sbuf(struct sbuf *sb, 3712 struct scsi_mam_attribute_header *hdr, 3713 uint32_t valid_len, uint32_t flags, 3714 uint32_t output_flags, char *error_str, 3715 int error_str_len); 3716 3717 int scsi_attrib_text_sbuf(struct sbuf *sb, 3718 struct scsi_mam_attribute_header *hdr, 3719 uint32_t valid_len, uint32_t flags, 3720 uint32_t output_flags, char *error_str, 3721 int error_str_len); 3722 3723 struct scsi_attrib_table_entry *scsi_find_attrib_entry( 3724 struct scsi_attrib_table_entry *table, 3725 size_t num_table_entries, uint32_t id); 3726 3727 struct scsi_attrib_table_entry *scsi_get_attrib_entry(uint32_t id); 3728 3729 int scsi_attrib_value_sbuf(struct sbuf *sb, uint32_t valid_len, 3730 struct scsi_mam_attribute_header *hdr, 3731 uint32_t output_flags, char *error_str, 3732 size_t error_str_len); 3733 3734 void scsi_attrib_prefix_sbuf(struct sbuf *sb, uint32_t output_flags, 3735 struct scsi_mam_attribute_header *hdr, 3736 uint32_t valid_len, const char *desc); 3737 3738 int scsi_attrib_sbuf(struct sbuf *sb, struct scsi_mam_attribute_header *hdr, 3739 uint32_t valid_len, 3740 struct scsi_attrib_table_entry *user_table, 3741 size_t num_user_entries, int prefer_user_table, 3742 uint32_t output_flags, char *error_str, int error_str_len); 3743 3744 void scsi_test_unit_ready(struct ccb_scsiio *csio, u_int32_t retries, 3745 void (*cbfcnp)(struct cam_periph *, 3746 union ccb *), 3747 u_int8_t tag_action, 3748 u_int8_t sense_len, u_int32_t timeout); 3749 3750 void scsi_request_sense(struct ccb_scsiio *csio, u_int32_t retries, 3751 void (*cbfcnp)(struct cam_periph *, 3752 union ccb *), 3753 void *data_ptr, u_int8_t dxfer_len, 3754 u_int8_t tag_action, u_int8_t sense_len, 3755 u_int32_t timeout); 3756 3757 void scsi_inquiry(struct ccb_scsiio *csio, u_int32_t retries, 3758 void (*cbfcnp)(struct cam_periph *, union ccb *), 3759 u_int8_t tag_action, u_int8_t *inq_buf, 3760 u_int32_t inq_len, int evpd, u_int8_t page_code, 3761 u_int8_t sense_len, u_int32_t timeout); 3762 3763 void scsi_mode_sense(struct ccb_scsiio *csio, u_int32_t retries, 3764 void (*cbfcnp)(struct cam_periph *, 3765 union ccb *), 3766 u_int8_t tag_action, int dbd, 3767 u_int8_t page_code, u_int8_t page, 3768 u_int8_t *param_buf, u_int32_t param_len, 3769 u_int8_t sense_len, u_int32_t timeout); 3770 3771 void scsi_mode_sense_len(struct ccb_scsiio *csio, u_int32_t retries, 3772 void (*cbfcnp)(struct cam_periph *, 3773 union ccb *), 3774 u_int8_t tag_action, int dbd, 3775 u_int8_t page_code, u_int8_t page, 3776 u_int8_t *param_buf, u_int32_t param_len, 3777 int minimum_cmd_size, u_int8_t sense_len, 3778 u_int32_t timeout); 3779 3780 void scsi_mode_select(struct ccb_scsiio *csio, u_int32_t retries, 3781 void (*cbfcnp)(struct cam_periph *, 3782 union ccb *), 3783 u_int8_t tag_action, int scsi_page_fmt, 3784 int save_pages, u_int8_t *param_buf, 3785 u_int32_t param_len, u_int8_t sense_len, 3786 u_int32_t timeout); 3787 3788 void scsi_mode_select_len(struct ccb_scsiio *csio, u_int32_t retries, 3789 void (*cbfcnp)(struct cam_periph *, 3790 union ccb *), 3791 u_int8_t tag_action, int scsi_page_fmt, 3792 int save_pages, u_int8_t *param_buf, 3793 u_int32_t param_len, int minimum_cmd_size, 3794 u_int8_t sense_len, u_int32_t timeout); 3795 3796 void scsi_log_sense(struct ccb_scsiio *csio, u_int32_t retries, 3797 void (*cbfcnp)(struct cam_periph *, union ccb *), 3798 u_int8_t tag_action, u_int8_t page_code, 3799 u_int8_t page, int save_pages, int ppc, 3800 u_int32_t paramptr, u_int8_t *param_buf, 3801 u_int32_t param_len, u_int8_t sense_len, 3802 u_int32_t timeout); 3803 3804 void scsi_log_select(struct ccb_scsiio *csio, u_int32_t retries, 3805 void (*cbfcnp)(struct cam_periph *, 3806 union ccb *), u_int8_t tag_action, 3807 u_int8_t page_code, int save_pages, 3808 int pc_reset, u_int8_t *param_buf, 3809 u_int32_t param_len, u_int8_t sense_len, 3810 u_int32_t timeout); 3811 3812 void scsi_prevent(struct ccb_scsiio *csio, u_int32_t retries, 3813 void (*cbfcnp)(struct cam_periph *, union ccb *), 3814 u_int8_t tag_action, u_int8_t action, 3815 u_int8_t sense_len, u_int32_t timeout); 3816 3817 void scsi_read_capacity(struct ccb_scsiio *csio, u_int32_t retries, 3818 void (*cbfcnp)(struct cam_periph *, 3819 union ccb *), u_int8_t tag_action, 3820 struct scsi_read_capacity_data *, 3821 u_int8_t sense_len, u_int32_t timeout); 3822 void scsi_read_capacity_16(struct ccb_scsiio *csio, uint32_t retries, 3823 void (*cbfcnp)(struct cam_periph *, 3824 union ccb *), uint8_t tag_action, 3825 uint64_t lba, int reladr, int pmi, 3826 uint8_t *rcap_buf, int rcap_buf_len, 3827 uint8_t sense_len, uint32_t timeout); 3828 3829 void scsi_report_luns(struct ccb_scsiio *csio, u_int32_t retries, 3830 void (*cbfcnp)(struct cam_periph *, 3831 union ccb *), u_int8_t tag_action, 3832 u_int8_t select_report, 3833 struct scsi_report_luns_data *rpl_buf, 3834 u_int32_t alloc_len, u_int8_t sense_len, 3835 u_int32_t timeout); 3836 3837 void scsi_report_target_group(struct ccb_scsiio *csio, u_int32_t retries, 3838 void (*cbfcnp)(struct cam_periph *, 3839 union ccb *), u_int8_t tag_action, 3840 u_int8_t pdf, 3841 void *buf, 3842 u_int32_t alloc_len, u_int8_t sense_len, 3843 u_int32_t timeout); 3844 3845 void scsi_set_target_group(struct ccb_scsiio *csio, u_int32_t retries, 3846 void (*cbfcnp)(struct cam_periph *, 3847 union ccb *), u_int8_t tag_action, void *buf, 3848 u_int32_t alloc_len, u_int8_t sense_len, 3849 u_int32_t timeout); 3850 3851 void scsi_synchronize_cache(struct ccb_scsiio *csio, 3852 u_int32_t retries, 3853 void (*cbfcnp)(struct cam_periph *, 3854 union ccb *), u_int8_t tag_action, 3855 u_int32_t begin_lba, u_int16_t lb_count, 3856 u_int8_t sense_len, u_int32_t timeout); 3857 3858 void scsi_receive_diagnostic_results(struct ccb_scsiio *csio, u_int32_t retries, 3859 void (*cbfcnp)(struct cam_periph *, 3860 union ccb*), 3861 uint8_t tag_action, int pcv, 3862 uint8_t page_code, uint8_t *data_ptr, 3863 uint16_t allocation_length, 3864 uint8_t sense_len, uint32_t timeout); 3865 3866 void scsi_send_diagnostic(struct ccb_scsiio *csio, u_int32_t retries, 3867 void (*cbfcnp)(struct cam_periph *, union ccb *), 3868 uint8_t tag_action, int unit_offline, 3869 int device_offline, int self_test, int page_format, 3870 int self_test_code, uint8_t *data_ptr, 3871 uint16_t param_list_length, uint8_t sense_len, 3872 uint32_t timeout); 3873 3874 void scsi_read_buffer(struct ccb_scsiio *csio, u_int32_t retries, 3875 void (*cbfcnp)(struct cam_periph *, union ccb*), 3876 uint8_t tag_action, int mode, 3877 uint8_t buffer_id, u_int32_t offset, 3878 uint8_t *data_ptr, uint32_t allocation_length, 3879 uint8_t sense_len, uint32_t timeout); 3880 3881 void scsi_write_buffer(struct ccb_scsiio *csio, u_int32_t retries, 3882 void (*cbfcnp)(struct cam_periph *, union ccb *), 3883 uint8_t tag_action, int mode, 3884 uint8_t buffer_id, u_int32_t offset, 3885 uint8_t *data_ptr, uint32_t param_list_length, 3886 uint8_t sense_len, uint32_t timeout); 3887 3888 #define SCSI_RW_READ 0x0001 3889 #define SCSI_RW_WRITE 0x0002 3890 #define SCSI_RW_DIRMASK 0x0003 3891 #define SCSI_RW_BIO 0x1000 3892 void scsi_read_write(struct ccb_scsiio *csio, u_int32_t retries, 3893 void (*cbfcnp)(struct cam_periph *, union ccb *), 3894 u_int8_t tag_action, int readop, u_int8_t byte2, 3895 int minimum_cmd_size, u_int64_t lba, 3896 u_int32_t block_count, u_int8_t *data_ptr, 3897 u_int32_t dxfer_len, u_int8_t sense_len, 3898 u_int32_t timeout); 3899 3900 void scsi_write_same(struct ccb_scsiio *csio, u_int32_t retries, 3901 void (*cbfcnp)(struct cam_periph *, union ccb *), 3902 u_int8_t tag_action, u_int8_t byte2, 3903 int minimum_cmd_size, u_int64_t lba, 3904 u_int32_t block_count, u_int8_t *data_ptr, 3905 u_int32_t dxfer_len, u_int8_t sense_len, 3906 u_int32_t timeout); 3907 3908 void scsi_ata_identify(struct ccb_scsiio *csio, u_int32_t retries, 3909 void (*cbfcnp)(struct cam_periph *, union ccb *), 3910 u_int8_t tag_action, u_int8_t *data_ptr, 3911 u_int16_t dxfer_len, u_int8_t sense_len, 3912 u_int32_t timeout); 3913 3914 void scsi_ata_trim(struct ccb_scsiio *csio, u_int32_t retries, 3915 void (*cbfcnp)(struct cam_periph *, union ccb *), 3916 u_int8_t tag_action, u_int16_t block_count, 3917 u_int8_t *data_ptr, u_int16_t dxfer_len, 3918 u_int8_t sense_len, u_int32_t timeout); 3919 3920 void scsi_ata_pass_16(struct ccb_scsiio *csio, u_int32_t retries, 3921 void (*cbfcnp)(struct cam_periph *, union ccb *), 3922 u_int32_t flags, u_int8_t tag_action, 3923 u_int8_t protocol, u_int8_t ata_flags, u_int16_t features, 3924 u_int16_t sector_count, uint64_t lba, u_int8_t command, 3925 u_int8_t control, u_int8_t *data_ptr, u_int16_t dxfer_len, 3926 u_int8_t sense_len, u_int32_t timeout); 3927 3928 void scsi_unmap(struct ccb_scsiio *csio, u_int32_t retries, 3929 void (*cbfcnp)(struct cam_periph *, union ccb *), 3930 u_int8_t tag_action, u_int8_t byte2, 3931 u_int8_t *data_ptr, u_int16_t dxfer_len, 3932 u_int8_t sense_len, u_int32_t timeout); 3933 3934 void scsi_start_stop(struct ccb_scsiio *csio, u_int32_t retries, 3935 void (*cbfcnp)(struct cam_periph *, union ccb *), 3936 u_int8_t tag_action, int start, int load_eject, 3937 int immediate, u_int8_t sense_len, u_int32_t timeout); 3938 void scsi_read_attribute(struct ccb_scsiio *csio, u_int32_t retries, 3939 void (*cbfcnp)(struct cam_periph *, union ccb *), 3940 u_int8_t tag_action, u_int8_t service_action, 3941 uint32_t element, u_int8_t elem_type, 3942 int logical_volume, int partition, 3943 u_int32_t first_attribute, int cache, u_int8_t *data_ptr, 3944 u_int32_t length, int sense_len, u_int32_t timeout); 3945 void scsi_write_attribute(struct ccb_scsiio *csio, u_int32_t retries, 3946 void (*cbfcnp)(struct cam_periph *, union ccb *), 3947 u_int8_t tag_action, uint32_t element, 3948 int logical_volume, int partition, int wtc, u_int8_t *data_ptr, 3949 u_int32_t length, int sense_len, u_int32_t timeout); 3950 3951 void scsi_security_protocol_in(struct ccb_scsiio *csio, uint32_t retries, 3952 void (*cbfcnp)(struct cam_periph *, union ccb *), 3953 uint8_t tag_action, uint32_t security_protocol, 3954 uint32_t security_protocol_specific, int byte4, 3955 uint8_t *data_ptr, uint32_t dxfer_len, 3956 int sense_len, int timeout); 3957 3958 void scsi_security_protocol_out(struct ccb_scsiio *csio, uint32_t retries, 3959 void (*cbfcnp)(struct cam_periph *,union ccb *), 3960 uint8_t tag_action, uint32_t security_protocol, 3961 uint32_t security_protocol_specific, int byte4, 3962 uint8_t *data_ptr, uint32_t dxfer_len, 3963 int sense_len, int timeout); 3964 3965 void scsi_persistent_reserve_in(struct ccb_scsiio *csio, uint32_t retries, 3966 void (*cbfcnp)(struct cam_periph *,union ccb *), 3967 uint8_t tag_action, int service_action, 3968 uint8_t *data_ptr, uint32_t dxfer_len, 3969 int sense_len, int timeout); 3970 3971 void scsi_persistent_reserve_out(struct ccb_scsiio *csio, uint32_t retries, 3972 void (*cbfcnp)(struct cam_periph *, 3973 union ccb *), 3974 uint8_t tag_action, int service_action, 3975 int scope, int res_type, uint8_t *data_ptr, 3976 uint32_t dxfer_len, int sense_len, 3977 int timeout); 3978 3979 void scsi_report_supported_opcodes(struct ccb_scsiio *csio, uint32_t retries, 3980 void (*cbfcnp)(struct cam_periph *, 3981 union ccb *), 3982 uint8_t tag_action, int options, 3983 int req_opcode, int req_service_action, 3984 uint8_t *data_ptr, uint32_t dxfer_len, 3985 int sense_len, int timeout); 3986 3987 int scsi_inquiry_match(caddr_t inqbuffer, caddr_t table_entry); 3988 int scsi_static_inquiry_match(caddr_t inqbuffer, 3989 caddr_t table_entry); 3990 int scsi_devid_match(uint8_t *rhs, size_t rhs_len, 3991 uint8_t *lhs, size_t lhs_len); 3992 3993 void scsi_extract_sense(struct scsi_sense_data *sense, int *error_code, 3994 int *sense_key, int *asc, int *ascq); 3995 int scsi_extract_sense_ccb(union ccb *ccb, int *error_code, int *sense_key, 3996 int *asc, int *ascq); 3997 void scsi_extract_sense_len(struct scsi_sense_data *sense, 3998 u_int sense_len, int *error_code, int *sense_key, 3999 int *asc, int *ascq, int show_errors); 4000 int scsi_get_sense_key(struct scsi_sense_data *sense, u_int sense_len, 4001 int show_errors); 4002 int scsi_get_asc(struct scsi_sense_data *sense, u_int sense_len, 4003 int show_errors); 4004 int scsi_get_ascq(struct scsi_sense_data *sense, u_int sense_len, 4005 int show_errors); 4006 static __inline void scsi_ulto2b(u_int32_t val, u_int8_t *bytes); 4007 static __inline void scsi_ulto3b(u_int32_t val, u_int8_t *bytes); 4008 static __inline void scsi_ulto4b(u_int32_t val, u_int8_t *bytes); 4009 static __inline void scsi_u64to8b(u_int64_t val, u_int8_t *bytes); 4010 static __inline uint32_t scsi_2btoul(const uint8_t *bytes); 4011 static __inline uint32_t scsi_3btoul(const uint8_t *bytes); 4012 static __inline int32_t scsi_3btol(const uint8_t *bytes); 4013 static __inline uint32_t scsi_4btoul(const uint8_t *bytes); 4014 static __inline uint64_t scsi_8btou64(const uint8_t *bytes); 4015 static __inline void *find_mode_page_6(struct scsi_mode_header_6 *mode_header); 4016 static __inline void *find_mode_page_10(struct scsi_mode_header_10 *mode_header); 4017 4018 static __inline void 4019 scsi_ulto2b(u_int32_t val, u_int8_t *bytes) 4020 { 4021 4022 bytes[0] = (val >> 8) & 0xff; 4023 bytes[1] = val & 0xff; 4024 } 4025 4026 static __inline void 4027 scsi_ulto3b(u_int32_t val, u_int8_t *bytes) 4028 { 4029 4030 bytes[0] = (val >> 16) & 0xff; 4031 bytes[1] = (val >> 8) & 0xff; 4032 bytes[2] = val & 0xff; 4033 } 4034 4035 static __inline void 4036 scsi_ulto4b(u_int32_t val, u_int8_t *bytes) 4037 { 4038 4039 bytes[0] = (val >> 24) & 0xff; 4040 bytes[1] = (val >> 16) & 0xff; 4041 bytes[2] = (val >> 8) & 0xff; 4042 bytes[3] = val & 0xff; 4043 } 4044 4045 static __inline void 4046 scsi_u64to8b(u_int64_t val, u_int8_t *bytes) 4047 { 4048 4049 bytes[0] = (val >> 56) & 0xff; 4050 bytes[1] = (val >> 48) & 0xff; 4051 bytes[2] = (val >> 40) & 0xff; 4052 bytes[3] = (val >> 32) & 0xff; 4053 bytes[4] = (val >> 24) & 0xff; 4054 bytes[5] = (val >> 16) & 0xff; 4055 bytes[6] = (val >> 8) & 0xff; 4056 bytes[7] = val & 0xff; 4057 } 4058 4059 static __inline uint32_t 4060 scsi_2btoul(const uint8_t *bytes) 4061 { 4062 uint32_t rv; 4063 4064 rv = (bytes[0] << 8) | 4065 bytes[1]; 4066 return (rv); 4067 } 4068 4069 static __inline uint32_t 4070 scsi_3btoul(const uint8_t *bytes) 4071 { 4072 uint32_t rv; 4073 4074 rv = (bytes[0] << 16) | 4075 (bytes[1] << 8) | 4076 bytes[2]; 4077 return (rv); 4078 } 4079 4080 static __inline int32_t 4081 scsi_3btol(const uint8_t *bytes) 4082 { 4083 uint32_t rc = scsi_3btoul(bytes); 4084 4085 if (rc & 0x00800000) 4086 rc |= 0xff000000; 4087 4088 return (int32_t) rc; 4089 } 4090 4091 static __inline uint32_t 4092 scsi_4btoul(const uint8_t *bytes) 4093 { 4094 uint32_t rv; 4095 4096 rv = (bytes[0] << 24) | 4097 (bytes[1] << 16) | 4098 (bytes[2] << 8) | 4099 bytes[3]; 4100 return (rv); 4101 } 4102 4103 static __inline uint64_t 4104 scsi_8btou64(const uint8_t *bytes) 4105 { 4106 uint64_t rv; 4107 4108 rv = (((uint64_t)bytes[0]) << 56) | 4109 (((uint64_t)bytes[1]) << 48) | 4110 (((uint64_t)bytes[2]) << 40) | 4111 (((uint64_t)bytes[3]) << 32) | 4112 (((uint64_t)bytes[4]) << 24) | 4113 (((uint64_t)bytes[5]) << 16) | 4114 (((uint64_t)bytes[6]) << 8) | 4115 bytes[7]; 4116 return (rv); 4117 } 4118 4119 /* 4120 * Given the pointer to a returned mode sense buffer, return a pointer to 4121 * the start of the first mode page. 4122 */ 4123 static __inline void * 4124 find_mode_page_6(struct scsi_mode_header_6 *mode_header) 4125 { 4126 void *page_start; 4127 4128 page_start = (void *)((u_int8_t *)&mode_header[1] + 4129 mode_header->blk_desc_len); 4130 4131 return(page_start); 4132 } 4133 4134 static __inline void * 4135 find_mode_page_10(struct scsi_mode_header_10 *mode_header) 4136 { 4137 void *page_start; 4138 4139 page_start = (void *)((u_int8_t *)&mode_header[1] + 4140 scsi_2btoul(mode_header->blk_desc_len)); 4141 4142 return(page_start); 4143 } 4144 4145 __END_DECLS 4146 4147 #endif /*_SCSI_SCSI_ALL_H*/ 4148