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