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