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