scsi_all.h revision 268700
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 268700 2014-07-15 17:26:43Z 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_PTPL_A 0x01 321 uint8_t type_mask[2]; 322#define SPRI_TM_WR_EX_AR 0x8000 323#define SPRI_TM_EX_AC_RO 0x4000 324#define SPRI_TM_WR_EX_RO 0x2000 325#define SPRI_TM_EX_AC 0x0800 326#define SPRI_TM_WR_EX 0x0200 327#define SPRI_TM_EX_AC_AR 0x0001 328 uint8_t reserved[2]; 329}; 330 331struct scsi_per_res_in_rsrv_data 332{ 333 uint8_t reservation[8]; 334 uint8_t scope_addr[4]; 335 uint8_t reserved; 336 uint8_t scopetype; 337#define SPRT_WE 0x01 338#define SPRT_EA 0x03 339#define SPRT_WERO 0x05 340#define SPRT_EARO 0x06 341#define SPRT_WEAR 0x07 342#define SPRT_EAAR 0x08 343 uint8_t extent_length[2]; 344}; 345 346struct scsi_per_res_in_rsrv 347{ 348 struct scsi_per_res_in_header header; 349 struct scsi_per_res_in_rsrv_data data; 350}; 351 352struct scsi_per_res_in_full_desc 353{ 354 struct scsi_per_res_key res_key; 355 uint8_t reserved1[4]; 356 uint8_t flags; 357#define SPRI_FULL_ALL_TG_PT 0x02 358#define SPRI_FULL_R_HOLDER 0x01 359 uint8_t scopetype; 360 uint8_t reserved2[4]; 361 uint8_t rel_trgt_port_id[2]; 362 uint8_t additional_length[4]; 363 uint8_t transport_id[]; 364}; 365 366struct scsi_per_res_in_full 367{ 368 struct scsi_per_res_in_header header; 369 struct scsi_per_res_in_full_desc desc[]; 370}; 371 372struct scsi_per_res_out 373{ 374 u_int8_t opcode; 375 u_int8_t action; 376#define SPRO_REGISTER 0x00 377#define SPRO_RESERVE 0x01 378#define SPRO_RELEASE 0x02 379#define SPRO_CLEAR 0x03 380#define SPRO_PREEMPT 0x04 381#define SPRO_PRE_ABO 0x05 382#define SPRO_REG_IGNO 0x06 383#define SPRO_REG_MOVE 0x07 384#define SPRO_REPL_LOST_RES 0x08 385#define SPRO_ACTION_MASK 0x1f 386 u_int8_t scope_type; 387#define SPR_SCOPE_MASK 0xf0 388#define SPR_SCOPE_SHIFT 4 389#define SPR_LU_SCOPE 0x00 390#define SPR_EXTENT_SCOPE 0x10 391#define SPR_ELEMENT_SCOPE 0x20 392#define SPR_TYPE_MASK 0x0f 393#define SPR_TYPE_RD_SHARED 0x00 394#define SPR_TYPE_WR_EX 0x01 395#define SPR_TYPE_RD_EX 0x02 396#define SPR_TYPE_EX_AC 0x03 397#define SPR_TYPE_SHARED 0x04 398#define SPR_TYPE_WR_EX_RO 0x05 399#define SPR_TYPE_EX_AC_RO 0x06 400#define SPR_TYPE_WR_EX_AR 0x07 401#define SPR_TYPE_EX_AC_AR 0x08 402 u_int8_t reserved[2]; 403 u_int8_t length[4]; 404 u_int8_t control; 405}; 406 407struct scsi_per_res_out_parms 408{ 409 struct scsi_per_res_key res_key; 410 u_int8_t serv_act_res_key[8]; 411 u_int8_t scope_spec_address[4]; 412 u_int8_t flags; 413#define SPR_SPEC_I_PT 0x08 414#define SPR_ALL_TG_PT 0x04 415#define SPR_APTPL 0x01 416 u_int8_t reserved1; 417 u_int8_t extent_length[2]; 418 u_int8_t transport_id_list[]; 419}; 420 421struct scsi_per_res_out_trans_ids { 422 u_int8_t additional_length[4]; 423 u_int8_t transport_ids[]; 424}; 425 426/* 427 * Used with REGISTER AND MOVE serivce action of the PERSISTENT RESERVE OUT 428 * command. 429 */ 430struct scsi_per_res_reg_move 431{ 432 struct scsi_per_res_key res_key; 433 u_int8_t serv_act_res_key[8]; 434 u_int8_t reserved; 435 u_int8_t flags; 436#define SPR_REG_MOVE_UNREG 0x02 437#define SPR_REG_MOVE_APTPL 0x01 438 u_int8_t rel_trgt_port_id[2]; 439 u_int8_t transport_id_length[4]; 440 u_int8_t transport_id[]; 441}; 442 443struct scsi_transportid_header 444{ 445 uint8_t format_protocol; 446#define SCSI_TRN_FORMAT_MASK 0xc0 447#define SCSI_TRN_FORMAT_SHIFT 6 448#define SCSI_TRN_PROTO_MASK 0x0f 449}; 450 451struct scsi_transportid_fcp 452{ 453 uint8_t format_protocol; 454#define SCSI_TRN_FCP_FORMAT_DEFAULT 0x00 455 uint8_t reserved1[7]; 456 uint8_t n_port_name[8]; 457 uint8_t reserved2[8]; 458}; 459 460struct scsi_transportid_spi 461{ 462 uint8_t format_protocol; 463#define SCSI_TRN_SPI_FORMAT_DEFAULT 0x00 464 uint8_t reserved1; 465 uint8_t scsi_addr[2]; 466 uint8_t obsolete[2]; 467 uint8_t rel_trgt_port_id[2]; 468 uint8_t reserved2[16]; 469}; 470 471struct scsi_transportid_1394 472{ 473 uint8_t format_protocol; 474#define SCSI_TRN_1394_FORMAT_DEFAULT 0x00 475 uint8_t reserved1[7]; 476 uint8_t eui64[8]; 477 uint8_t reserved2[8]; 478}; 479 480struct scsi_transportid_rdma 481{ 482 uint8_t format_protocol; 483#define SCSI_TRN_RDMA_FORMAT_DEFAULT 0x00 484 uint8_t reserved[7]; 485#define SCSI_TRN_RDMA_PORT_LEN 16 486 uint8_t initiator_port_id[SCSI_TRN_RDMA_PORT_LEN]; 487}; 488 489struct scsi_transportid_iscsi_device 490{ 491 uint8_t format_protocol; 492#define SCSI_TRN_ISCSI_FORMAT_DEVICE 0x00 493 uint8_t reserved; 494 uint8_t additional_length[2]; 495 uint8_t iscsi_name[]; 496}; 497 498struct scsi_transportid_iscsi_port 499{ 500 uint8_t format_protocol; 501#define SCSI_TRN_ISCSI_FORMAT_PORT 0x40 502 uint8_t reserved; 503 uint8_t additional_length[2]; 504 uint8_t iscsi_name[]; 505 /* 506 * Followed by a separator and iSCSI initiator session ID 507 */ 508}; 509 510struct scsi_transportid_sas 511{ 512 uint8_t format_protocol; 513#define SCSI_TRN_SAS_FORMAT_DEFAULT 0x00 514 uint8_t reserved1[3]; 515 uint8_t sas_address[8]; 516 uint8_t reserved2[12]; 517}; 518 519struct scsi_sop_routing_id_norm { 520 uint8_t bus; 521 uint8_t devfunc; 522#define SCSI_TRN_SOP_BUS_MAX 0xff 523#define SCSI_TRN_SOP_DEV_MAX 0x1f 524#define SCSI_TRN_SOP_DEV_MASK 0xf8 525#define SCSI_TRN_SOP_DEV_SHIFT 3 526#define SCSI_TRN_SOP_FUNC_NORM_MASK 0x07 527#define SCSI_TRN_SOP_FUNC_NORM_MAX 0x07 528}; 529 530struct scsi_sop_routing_id_alt { 531 uint8_t bus; 532 uint8_t function; 533#define SCSI_TRN_SOP_FUNC_ALT_MAX 0xff 534}; 535 536struct scsi_transportid_sop 537{ 538 uint8_t format_protocol; 539#define SCSI_TRN_SOP_FORMAT_DEFAULT 0x00 540 uint8_t reserved1; 541 uint8_t routing_id[2]; 542 uint8_t reserved2[20]; 543}; 544 545struct scsi_log_sense 546{ 547 u_int8_t opcode; 548 u_int8_t byte2; 549#define SLS_SP 0x01 550#define SLS_PPC 0x02 551 u_int8_t page; 552#define SLS_PAGE_CODE 0x3F 553#define SLS_ALL_PAGES_PAGE 0x00 554#define SLS_OVERRUN_PAGE 0x01 555#define SLS_ERROR_WRITE_PAGE 0x02 556#define SLS_ERROR_READ_PAGE 0x03 557#define SLS_ERROR_READREVERSE_PAGE 0x04 558#define SLS_ERROR_VERIFY_PAGE 0x05 559#define SLS_ERROR_NONMEDIUM_PAGE 0x06 560#define SLS_ERROR_LASTN_PAGE 0x07 561#define SLS_SELF_TEST_PAGE 0x10 562#define SLS_IE_PAGE 0x2f 563#define SLS_PAGE_CTRL_MASK 0xC0 564#define SLS_PAGE_CTRL_THRESHOLD 0x00 565#define SLS_PAGE_CTRL_CUMULATIVE 0x40 566#define SLS_PAGE_CTRL_THRESH_DEFAULT 0x80 567#define SLS_PAGE_CTRL_CUMUL_DEFAULT 0xC0 568 u_int8_t reserved[2]; 569 u_int8_t paramptr[2]; 570 u_int8_t length[2]; 571 u_int8_t control; 572}; 573 574struct scsi_log_select 575{ 576 u_int8_t opcode; 577 u_int8_t byte2; 578/* SLS_SP 0x01 */ 579#define SLS_PCR 0x02 580 u_int8_t page; 581/* SLS_PAGE_CTRL_MASK 0xC0 */ 582/* SLS_PAGE_CTRL_THRESHOLD 0x00 */ 583/* SLS_PAGE_CTRL_CUMULATIVE 0x40 */ 584/* SLS_PAGE_CTRL_THRESH_DEFAULT 0x80 */ 585/* SLS_PAGE_CTRL_CUMUL_DEFAULT 0xC0 */ 586 u_int8_t reserved[4]; 587 u_int8_t length[2]; 588 u_int8_t control; 589}; 590 591struct scsi_log_header 592{ 593 u_int8_t page; 594 u_int8_t reserved; 595 u_int8_t datalen[2]; 596}; 597 598struct scsi_log_param_header { 599 u_int8_t param_code[2]; 600 u_int8_t param_control; 601#define SLP_LP 0x01 602#define SLP_LBIN 0x02 603#define SLP_TMC_MASK 0x0C 604#define SLP_TMC_ALWAYS 0x00 605#define SLP_TMC_EQUAL 0x04 606#define SLP_TMC_NOTEQUAL 0x08 607#define SLP_TMC_GREATER 0x0C 608#define SLP_ETC 0x10 609#define SLP_TSD 0x20 610#define SLP_DS 0x40 611#define SLP_DU 0x80 612 u_int8_t param_len; 613}; 614 615struct scsi_control_page { 616 u_int8_t page_code; 617 u_int8_t page_length; 618 u_int8_t rlec; 619#define SCP_RLEC 0x01 /*Report Log Exception Cond*/ 620#define SCP_GLTSD 0x02 /*Global Logging target 621 save disable */ 622#define SCP_DSENSE 0x04 /*Descriptor Sense */ 623#define SCP_DPICZ 0x08 /*Disable Prot. Info Check 624 if Prot. Field is Zero */ 625#define SCP_TMF_ONLY 0x10 /*TM Functions Only*/ 626#define SCP_TST_MASK 0xE0 /*Task Set Type Mask*/ 627#define SCP_TST_ONE 0x00 /*One Task Set*/ 628#define SCP_TST_SEPARATE 0x20 /*Separate Task Sets*/ 629 u_int8_t queue_flags; 630#define SCP_QUEUE_ALG_MASK 0xF0 631#define SCP_QUEUE_ALG_RESTRICTED 0x00 632#define SCP_QUEUE_ALG_UNRESTRICTED 0x10 633#define SCP_NUAR 0x08 /*No UA on release*/ 634#define SCP_QUEUE_ERR 0x02 /*Queued I/O aborted for CACs*/ 635#define SCP_QUEUE_DQUE 0x01 /*Queued I/O disabled*/ 636 u_int8_t eca_and_aen; 637#define SCP_EECA 0x80 /*Enable Extended CA*/ 638#define SCP_RAC 0x40 /*Report a check*/ 639#define SCP_SWP 0x08 /*Software Write Protect*/ 640#define SCP_RAENP 0x04 /*Ready AEN Permission*/ 641#define SCP_UAAENP 0x02 /*UA AEN Permission*/ 642#define SCP_EAENP 0x01 /*Error AEN Permission*/ 643 u_int8_t flags4; 644#define SCP_ATO 0x80 /*Application tag owner*/ 645#define SCP_TAS 0x40 /*Task aborted status*/ 646#define SCP_ATMPE 0x20 /*Application tag mode page*/ 647#define SCP_RWWP 0x10 /*Reject write without prot*/ 648 u_int8_t aen_holdoff_period[2]; 649 u_int8_t busy_timeout_period[2]; 650 u_int8_t extended_selftest_completion_time[2]; 651}; 652 653struct scsi_cache_page { 654 u_int8_t page_code; 655#define SCHP_PAGE_SAVABLE 0x80 /* Page is savable */ 656 u_int8_t page_length; 657 u_int8_t cache_flags; 658#define SCHP_FLAGS_WCE 0x04 /* Write Cache Enable */ 659#define SCHP_FLAGS_MF 0x02 /* Multiplication factor */ 660#define SCHP_FLAGS_RCD 0x01 /* Read Cache Disable */ 661 u_int8_t rw_cache_policy; 662 u_int8_t dis_prefetch[2]; 663 u_int8_t min_prefetch[2]; 664 u_int8_t max_prefetch[2]; 665 u_int8_t max_prefetch_ceil[2]; 666}; 667 668/* 669 * XXX KDM 670 * Updated version of the cache page, as of SBC. Update this to SBC-3 and 671 * rationalize the two. 672 */ 673struct scsi_caching_page { 674 uint8_t page_code; 675#define SMS_CACHING_PAGE 0x08 676 uint8_t page_length; 677 uint8_t flags1; 678#define SCP_IC 0x80 679#define SCP_ABPF 0x40 680#define SCP_CAP 0x20 681#define SCP_DISC 0x10 682#define SCP_SIZE 0x08 683#define SCP_WCE 0x04 684#define SCP_MF 0x02 685#define SCP_RCD 0x01 686 uint8_t ret_priority; 687 uint8_t disable_pf_transfer_len[2]; 688 uint8_t min_prefetch[2]; 689 uint8_t max_prefetch[2]; 690 uint8_t max_pf_ceiling[2]; 691 uint8_t flags2; 692#define SCP_FSW 0x80 693#define SCP_LBCSS 0x40 694#define SCP_DRA 0x20 695#define SCP_VS1 0x10 696#define SCP_VS2 0x08 697 uint8_t cache_segments; 698 uint8_t cache_seg_size[2]; 699 uint8_t reserved; 700 uint8_t non_cache_seg_size[3]; 701}; 702 703/* 704 * XXX KDM move this off to a vendor shim. 705 */ 706struct copan_power_subpage { 707 uint8_t page_code; 708#define PWR_PAGE_CODE 0x00 709 uint8_t subpage; 710#define PWR_SUBPAGE_CODE 0x02 711 uint8_t page_length[2]; 712 uint8_t page_version; 713#define PWR_VERSION 0x01 714 uint8_t total_luns; 715 uint8_t max_active_luns; 716#define PWR_DFLT_MAX_LUNS 0x07 717 uint8_t reserved[25]; 718}; 719 720/* 721 * XXX KDM move this off to a vendor shim. 722 */ 723struct copan_aps_subpage { 724 uint8_t page_code; 725#define APS_PAGE_CODE 0x00 726 uint8_t subpage; 727#define APS_SUBPAGE_CODE 0x03 728 uint8_t page_length[2]; 729 uint8_t page_version; 730#define APS_VERSION 0x00 731 uint8_t lock_active; 732#define APS_LOCK_ACTIVE 0x01 733#define APS_LOCK_INACTIVE 0x00 734 uint8_t reserved[26]; 735}; 736 737/* 738 * XXX KDM move this off to a vendor shim. 739 */ 740struct copan_debugconf_subpage { 741 uint8_t page_code; 742#define DBGCNF_PAGE_CODE 0x00 743 uint8_t subpage; 744#define DBGCNF_SUBPAGE_CODE 0xF0 745 uint8_t page_length[2]; 746 uint8_t page_version; 747#define DBGCNF_VERSION 0x00 748 uint8_t ctl_time_io_secs[2]; 749}; 750 751 752struct scsi_info_exceptions_page { 753 u_int8_t page_code; 754#define SIEP_PAGE_SAVABLE 0x80 /* Page is savable */ 755 u_int8_t page_length; 756 u_int8_t info_flags; 757#define SIEP_FLAGS_PERF 0x80 758#define SIEP_FLAGS_EBF 0x20 759#define SIEP_FLAGS_EWASC 0x10 760#define SIEP_FLAGS_DEXCPT 0x08 761#define SIEP_FLAGS_TEST 0x04 762#define SIEP_FLAGS_EBACKERR 0x02 763#define SIEP_FLAGS_LOGERR 0x01 764 u_int8_t mrie; 765 u_int8_t interval_timer[4]; 766 u_int8_t report_count[4]; 767}; 768 769/* 770 * SCSI protocol identifier values, current as of SPC4r36l. 771 */ 772#define SCSI_PROTO_FC 0x00 /* Fibre Channel */ 773#define SCSI_PROTO_SPI 0x01 /* Parallel SCSI */ 774#define SCSI_PROTO_SSA 0x02 /* Serial Storage Arch. */ 775#define SCSI_PROTO_1394 0x03 /* IEEE 1394 (Firewire) */ 776#define SCSI_PROTO_RDMA 0x04 /* SCSI RDMA Protocol */ 777#define SCSI_PROTO_ISCSI 0x05 /* Internet SCSI */ 778#define SCSI_PROTO_iSCSI 0x05 /* Internet SCSI */ 779#define SCSI_PROTO_SAS 0x06 /* SAS Serial SCSI Protocol */ 780#define SCSI_PROTO_ADT 0x07 /* Automation/Drive Int. Trans. Prot.*/ 781#define SCSI_PROTO_ADITP 0x07 /* Automation/Drive Int. Trans. Prot.*/ 782#define SCSI_PROTO_ATA 0x08 /* AT Attachment Interface */ 783#define SCSI_PROTO_UAS 0x09 /* USB Atached SCSI */ 784#define SCSI_PROTO_SOP 0x0a /* SCSI over PCI Express */ 785#define SCSI_PROTO_NONE 0x0f /* No specific protocol */ 786 787struct scsi_proto_specific_page { 788 u_int8_t page_code; 789#define SPSP_PAGE_SAVABLE 0x80 /* Page is savable */ 790 u_int8_t page_length; 791 u_int8_t protocol; 792#define SPSP_PROTO_FC SCSI_PROTO_FC 793#define SPSP_PROTO_SPI SCSI_PROTO_SPI 794#define SPSP_PROTO_SSA SCSI_PROTO_SSA 795#define SPSP_PROTO_1394 SCSI_PROTO_1394 796#define SPSP_PROTO_RDMA SCSI_PROTO_RDMA 797#define SPSP_PROTO_ISCSI SCSI_PROTO_ISCSI 798#define SPSP_PROTO_SAS SCSI_PROTO_SAS 799#define SPSP_PROTO_ADT SCSI_PROTO_ADITP 800#define SPSP_PROTO_ATA SCSI_PROTO_ATA 801#define SPSP_PROTO_UAS SCSI_PROTO_UAS 802#define SPSP_PROTO_SOP SCSI_PROTO_SOP 803#define SPSP_PROTO_NONE SCSI_PROTO_NONE 804}; 805 806struct scsi_reserve 807{ 808 u_int8_t opcode; 809 u_int8_t byte2; 810#define SR_EXTENT 0x01 811#define SR_ID_MASK 0x0e 812#define SR_3RDPTY 0x10 813#define SR_LUN_MASK 0xe0 814 u_int8_t resv_id; 815 u_int8_t length[2]; 816 u_int8_t control; 817}; 818 819struct scsi_reserve_10 { 820 uint8_t opcode; 821 uint8_t byte2; 822#define SR10_3RDPTY 0x10 823#define SR10_LONGID 0x02 824#define SR10_EXTENT 0x01 825 uint8_t resv_id; 826 uint8_t thirdparty_id; 827 uint8_t reserved[3]; 828 uint8_t length[2]; 829 uint8_t control; 830}; 831 832 833struct scsi_release 834{ 835 u_int8_t opcode; 836 u_int8_t byte2; 837 u_int8_t resv_id; 838 u_int8_t unused[1]; 839 u_int8_t length; 840 u_int8_t control; 841}; 842 843struct scsi_release_10 { 844 uint8_t opcode; 845 uint8_t byte2; 846 uint8_t resv_id; 847 uint8_t thirdparty_id; 848 uint8_t reserved[3]; 849 uint8_t length[2]; 850 uint8_t control; 851}; 852 853struct scsi_prevent 854{ 855 u_int8_t opcode; 856 u_int8_t byte2; 857 u_int8_t unused[2]; 858 u_int8_t how; 859 u_int8_t control; 860}; 861#define PR_PREVENT 0x01 862#define PR_ALLOW 0x00 863 864struct scsi_sync_cache 865{ 866 u_int8_t opcode; 867 u_int8_t byte2; 868#define SSC_IMMED 0x02 869#define SSC_RELADR 0x01 870 u_int8_t begin_lba[4]; 871 u_int8_t reserved; 872 u_int8_t lb_count[2]; 873 u_int8_t control; 874}; 875 876struct scsi_sync_cache_16 877{ 878 uint8_t opcode; 879 uint8_t byte2; 880 uint8_t begin_lba[8]; 881 uint8_t lb_count[4]; 882 uint8_t reserved; 883 uint8_t control; 884}; 885 886struct scsi_format { 887 uint8_t opcode; 888 uint8_t byte2; 889#define SF_LONGLIST 0x20 890#define SF_FMTDATA 0x10 891#define SF_CMPLIST 0x08 892#define SF_FORMAT_MASK 0x07 893#define SF_FORMAT_BLOCK 0x00 894#define SF_FORMAT_LONG_BLOCK 0x03 895#define SF_FORMAT_BFI 0x04 896#define SF_FORMAT_PHYS 0x05 897 uint8_t vendor; 898 uint8_t interleave[2]; 899 uint8_t control; 900}; 901 902struct scsi_format_header_short { 903 uint8_t reserved; 904#define SF_DATA_FOV 0x80 905#define SF_DATA_DPRY 0x40 906#define SF_DATA_DCRT 0x20 907#define SF_DATA_STPF 0x10 908#define SF_DATA_IP 0x08 909#define SF_DATA_DSP 0x04 910#define SF_DATA_IMMED 0x02 911#define SF_DATA_VS 0x01 912 uint8_t byte2; 913 uint8_t defect_list_len[2]; 914}; 915 916struct scsi_format_header_long { 917 uint8_t reserved; 918 uint8_t byte2; 919 uint8_t reserved2[2]; 920 uint8_t defect_list_len[4]; 921}; 922 923struct scsi_changedef 924{ 925 u_int8_t opcode; 926 u_int8_t byte2; 927 u_int8_t unused1; 928 u_int8_t how; 929 u_int8_t unused[4]; 930 u_int8_t datalen; 931 u_int8_t control; 932}; 933 934struct scsi_read_buffer 935{ 936 u_int8_t opcode; 937 u_int8_t byte2; 938#define RWB_MODE 0x1F 939#define RWB_MODE_HDR_DATA 0x00 940#define RWB_MODE_VENDOR 0x01 941#define RWB_MODE_DATA 0x02 942#define RWB_MODE_DESCR 0x03 943#define RWB_MODE_DOWNLOAD 0x04 944#define RWB_MODE_DOWNLOAD_SAVE 0x05 945#define RWB_MODE_ECHO 0x0A 946#define RWB_MODE_ECHO_DESCR 0x0B 947#define RWB_MODE_ERROR_HISTORY 0x1C 948 u_int8_t buffer_id; 949 u_int8_t offset[3]; 950 u_int8_t length[3]; 951 u_int8_t control; 952}; 953 954struct scsi_write_buffer 955{ 956 u_int8_t opcode; 957 u_int8_t byte2; 958 u_int8_t buffer_id; 959 u_int8_t offset[3]; 960 u_int8_t length[3]; 961 u_int8_t control; 962}; 963 964struct scsi_rw_6 965{ 966 u_int8_t opcode; 967 u_int8_t addr[3]; 968/* only 5 bits are valid in the MSB address byte */ 969#define SRW_TOPADDR 0x1F 970 u_int8_t length; 971 u_int8_t control; 972}; 973 974struct scsi_rw_10 975{ 976 u_int8_t opcode; 977#define SRW10_RELADDR 0x01 978/* EBP defined for WRITE(10) only */ 979#define SRW10_EBP 0x04 980#define SRW10_FUA 0x08 981#define SRW10_DPO 0x10 982 u_int8_t byte2; 983 u_int8_t addr[4]; 984 u_int8_t reserved; 985 u_int8_t length[2]; 986 u_int8_t control; 987}; 988 989struct scsi_rw_12 990{ 991 u_int8_t opcode; 992#define SRW12_RELADDR 0x01 993#define SRW12_FUA 0x08 994#define SRW12_DPO 0x10 995 u_int8_t byte2; 996 u_int8_t addr[4]; 997 u_int8_t length[4]; 998 u_int8_t reserved; 999 u_int8_t control; 1000}; 1001 1002struct scsi_rw_16 1003{ 1004 u_int8_t opcode; 1005#define SRW16_RELADDR 0x01 1006#define SRW16_FUA 0x08 1007#define SRW16_DPO 0x10 1008 u_int8_t byte2; 1009 u_int8_t addr[8]; 1010 u_int8_t length[4]; 1011 u_int8_t reserved; 1012 u_int8_t control; 1013}; 1014 1015struct scsi_write_same_10 1016{ 1017 uint8_t opcode; 1018 uint8_t byte2; 1019#define SWS_LBDATA 0x02 1020#define SWS_PBDATA 0x04 1021#define SWS_UNMAP 0x08 1022#define SWS_ANCHOR 0x10 1023 uint8_t addr[4]; 1024 uint8_t group; 1025 uint8_t length[2]; 1026 uint8_t control; 1027}; 1028 1029struct scsi_write_same_16 1030{ 1031 uint8_t opcode; 1032 uint8_t byte2; 1033 uint8_t addr[8]; 1034 uint8_t length[4]; 1035 uint8_t group; 1036 uint8_t control; 1037}; 1038 1039struct scsi_unmap 1040{ 1041 uint8_t opcode; 1042 uint8_t byte2; 1043#define SU_ANCHOR 0x01 1044 uint8_t reserved[4]; 1045 uint8_t group; 1046 uint8_t length[2]; 1047 uint8_t control; 1048}; 1049 1050struct scsi_unmap_header 1051{ 1052 uint8_t length[2]; 1053 uint8_t desc_length[2]; 1054 uint8_t reserved[4]; 1055}; 1056 1057struct scsi_unmap_desc 1058{ 1059 uint8_t lba[8]; 1060 uint8_t length[4]; 1061 uint8_t reserved[4]; 1062}; 1063 1064struct scsi_write_verify_10 1065{ 1066 uint8_t opcode; 1067 uint8_t byte2; 1068#define SWV_BYTCHK 0x02 1069#define SWV_DPO 0x10 1070#define SWV_WRPROECT_MASK 0xe0 1071 uint8_t addr[4]; 1072 uint8_t group; 1073 uint8_t length[2]; 1074 uint8_t control; 1075}; 1076 1077struct scsi_write_verify_12 1078{ 1079 uint8_t opcode; 1080 uint8_t byte2; 1081 uint8_t addr[4]; 1082 uint8_t length[4]; 1083 uint8_t group; 1084 uint8_t control; 1085}; 1086 1087struct scsi_write_verify_16 1088{ 1089 uint8_t opcode; 1090 uint8_t byte2; 1091 uint8_t addr[8]; 1092 uint8_t length[4]; 1093 uint8_t group; 1094 uint8_t control; 1095}; 1096 1097 1098struct scsi_start_stop_unit 1099{ 1100 u_int8_t opcode; 1101 u_int8_t byte2; 1102#define SSS_IMMED 0x01 1103 u_int8_t reserved[2]; 1104 u_int8_t how; 1105#define SSS_START 0x01 1106#define SSS_LOEJ 0x02 1107#define SSS_PC_MASK 0xf0 1108#define SSS_PC_START_VALID 0x00 1109#define SSS_PC_ACTIVE 0x10 1110#define SSS_PC_IDLE 0x20 1111#define SSS_PC_STANDBY 0x30 1112#define SSS_PC_LU_CONTROL 0x70 1113#define SSS_PC_FORCE_IDLE_0 0xa0 1114#define SSS_PC_FORCE_STANDBY_0 0xb0 1115 u_int8_t control; 1116}; 1117 1118struct ata_pass_12 { 1119 u_int8_t opcode; 1120 u_int8_t protocol; 1121#define AP_PROTO_HARD_RESET (0x00 << 1) 1122#define AP_PROTO_SRST (0x01 << 1) 1123#define AP_PROTO_NON_DATA (0x03 << 1) 1124#define AP_PROTO_PIO_IN (0x04 << 1) 1125#define AP_PROTO_PIO_OUT (0x05 << 1) 1126#define AP_PROTO_DMA (0x06 << 1) 1127#define AP_PROTO_DMA_QUEUED (0x07 << 1) 1128#define AP_PROTO_DEVICE_DIAG (0x08 << 1) 1129#define AP_PROTO_DEVICE_RESET (0x09 << 1) 1130#define AP_PROTO_UDMA_IN (0x0a << 1) 1131#define AP_PROTO_UDMA_OUT (0x0b << 1) 1132#define AP_PROTO_FPDMA (0x0c << 1) 1133#define AP_PROTO_RESP_INFO (0x0f << 1) 1134#define AP_MULTI 0xe0 1135 u_int8_t flags; 1136#define AP_T_LEN 0x03 1137#define AP_BB 0x04 1138#define AP_T_DIR 0x08 1139#define AP_CK_COND 0x20 1140#define AP_OFFLINE 0x60 1141 u_int8_t features; 1142 u_int8_t sector_count; 1143 u_int8_t lba_low; 1144 u_int8_t lba_mid; 1145 u_int8_t lba_high; 1146 u_int8_t device; 1147 u_int8_t command; 1148 u_int8_t reserved; 1149 u_int8_t control; 1150}; 1151 1152struct scsi_maintenance_in 1153{ 1154 uint8_t opcode; 1155 uint8_t byte2; 1156#define SERVICE_ACTION_MASK 0x1f 1157#define SA_RPRT_TRGT_GRP 0x0a 1158 uint8_t reserved[4]; 1159 uint8_t length[4]; 1160 uint8_t reserved1; 1161 uint8_t control; 1162}; 1163 1164struct scsi_report_supported_opcodes 1165{ 1166 uint8_t opcode; 1167 uint8_t service_action; 1168 uint8_t options; 1169#define RSO_RCTD 0x80 1170#define RSO_OPTIONS_MASK 0x07 1171#define RSO_OPTIONS_ALL 0x00 1172#define RSO_OPTIONS_OC 0x01 1173#define RSO_OPTIONS_OC_SA 0x02 1174 uint8_t requested_opcode; 1175 uint8_t requested_service_action[2]; 1176 uint8_t length[4]; 1177 uint8_t reserved1; 1178 uint8_t control; 1179}; 1180 1181struct scsi_report_supported_opcodes_timeout 1182{ 1183 uint8_t length[2]; 1184 uint8_t reserved; 1185 uint8_t cmd_specific; 1186 uint8_t nominal_time[4]; 1187 uint8_t recommended_time[4]; 1188}; 1189 1190struct scsi_report_supported_opcodes_descr 1191{ 1192 uint8_t opcode; 1193 uint8_t reserved; 1194 uint8_t service_action[2]; 1195 uint8_t reserved2; 1196 uint8_t flags; 1197#define RSO_SERVACTV 0x01 1198#define RSO_CTDP 0x02 1199 uint8_t cdb_length[2]; 1200 struct scsi_report_supported_opcodes_timeout timeout[0]; 1201}; 1202 1203struct scsi_report_supported_opcodes_all 1204{ 1205 uint8_t length[4]; 1206 struct scsi_report_supported_opcodes_descr descr[0]; 1207}; 1208 1209struct scsi_report_supported_opcodes_one 1210{ 1211 uint8_t reserved; 1212 uint8_t support; 1213#define RSO_ONE_CTDP 0x80 1214 uint8_t cdb_length[2]; 1215 uint8_t cdb_usage[]; 1216}; 1217 1218struct scsi_report_supported_tmf 1219{ 1220 uint8_t opcode; 1221 uint8_t service_action; 1222 uint8_t reserved[4]; 1223 uint8_t length[4]; 1224 uint8_t reserved1; 1225 uint8_t control; 1226}; 1227 1228struct scsi_report_supported_tmf_data 1229{ 1230 uint8_t byte1; 1231#define RST_WAKES 0x01 1232#define RST_TRS 0x02 1233#define RST_QTS 0x04 1234#define RST_LURS 0x08 1235#define RST_CTSS 0x10 1236#define RST_CACAS 0x20 1237#define RST_ATSS 0x40 1238#define RST_ATS 0x80 1239 uint8_t byte2; 1240#define RST_ITNRS 0x01 1241#define RST_QTSS 0x02 1242#define RST_QAES 0x04 1243 uint8_t reserved[2]; 1244}; 1245 1246struct scsi_report_timestamp 1247{ 1248 uint8_t opcode; 1249 uint8_t service_action; 1250 uint8_t reserved[4]; 1251 uint8_t length[4]; 1252 uint8_t reserved1; 1253 uint8_t control; 1254}; 1255 1256struct scsi_report_timestamp_data 1257{ 1258 uint8_t length[2]; 1259 uint8_t origin; 1260#define RTS_ORIG_MASK 0x00 1261#define RTS_ORIG_ZERO 0x00 1262#define RTS_ORIG_SET 0x02 1263#define RTS_ORIG_OUTSIDE 0x03 1264 uint8_t reserved; 1265 uint8_t timestamp[6]; 1266 uint8_t reserve2[2]; 1267}; 1268 1269struct ata_pass_16 { 1270 u_int8_t opcode; 1271 u_int8_t protocol; 1272#define AP_EXTEND 0x01 1273 u_int8_t flags; 1274#define AP_FLAG_TLEN_NO_DATA (0 << 0) 1275#define AP_FLAG_TLEN_FEAT (1 << 0) 1276#define AP_FLAG_TLEN_SECT_CNT (2 << 0) 1277#define AP_FLAG_TLEN_STPSIU (3 << 0) 1278#define AP_FLAG_BYT_BLOK_BYTES (0 << 2) 1279#define AP_FLAG_BYT_BLOK_BLOCKS (1 << 2) 1280#define AP_FLAG_TDIR_TO_DEV (0 << 3) 1281#define AP_FLAG_TDIR_FROM_DEV (1 << 3) 1282#define AP_FLAG_CHK_COND (1 << 5) 1283 u_int8_t features_ext; 1284 u_int8_t features; 1285 u_int8_t sector_count_ext; 1286 u_int8_t sector_count; 1287 u_int8_t lba_low_ext; 1288 u_int8_t lba_low; 1289 u_int8_t lba_mid_ext; 1290 u_int8_t lba_mid; 1291 u_int8_t lba_high_ext; 1292 u_int8_t lba_high; 1293 u_int8_t device; 1294 u_int8_t command; 1295 u_int8_t control; 1296}; 1297 1298#define SC_SCSI_1 0x01 1299#define SC_SCSI_2 0x03 1300 1301/* 1302 * Opcodes 1303 */ 1304 1305#define TEST_UNIT_READY 0x00 1306#define REQUEST_SENSE 0x03 1307#define READ_6 0x08 1308#define WRITE_6 0x0A 1309#define INQUIRY 0x12 1310#define MODE_SELECT_6 0x15 1311#define MODE_SENSE_6 0x1A 1312#define START_STOP_UNIT 0x1B 1313#define START_STOP 0x1B 1314#define RESERVE 0x16 1315#define RELEASE 0x17 1316#define RECEIVE_DIAGNOSTIC 0x1C 1317#define SEND_DIAGNOSTIC 0x1D 1318#define PREVENT_ALLOW 0x1E 1319#define READ_CAPACITY 0x25 1320#define READ_10 0x28 1321#define WRITE_10 0x2A 1322#define POSITION_TO_ELEMENT 0x2B 1323#define WRITE_VERIFY_10 0x2E 1324#define VERIFY_10 0x2F 1325#define SYNCHRONIZE_CACHE 0x35 1326#define READ_DEFECT_DATA_10 0x37 1327#define WRITE_BUFFER 0x3B 1328#define READ_BUFFER 0x3C 1329#define CHANGE_DEFINITION 0x40 1330#define WRITE_SAME_10 0x41 1331#define UNMAP 0x42 1332#define LOG_SELECT 0x4C 1333#define LOG_SENSE 0x4D 1334#define MODE_SELECT_10 0x55 1335#define RESERVE_10 0x56 1336#define RELEASE_10 0x57 1337#define MODE_SENSE_10 0x5A 1338#define PERSISTENT_RES_IN 0x5E 1339#define PERSISTENT_RES_OUT 0x5F 1340#define ATA_PASS_16 0x85 1341#define READ_16 0x88 1342#define COMPARE_AND_WRITE 0x89 1343#define WRITE_16 0x8A 1344#define WRITE_VERIFY_16 0x8E 1345#define VERIFY_16 0x8F 1346#define SYNCHRONIZE_CACHE_16 0x91 1347#define WRITE_SAME_16 0x93 1348#define SERVICE_ACTION_IN 0x9E 1349#define REPORT_LUNS 0xA0 1350#define ATA_PASS_12 0xA1 1351#define MAINTENANCE_IN 0xA3 1352#define MAINTENANCE_OUT 0xA4 1353#define MOVE_MEDIUM 0xA5 1354#define READ_12 0xA8 1355#define WRITE_12 0xAA 1356#define WRITE_VERIFY_12 0xAE 1357#define VERIFY_12 0xAF 1358#define READ_ELEMENT_STATUS 0xB8 1359#define READ_CD 0xBE 1360 1361/* Maintenance In Service Action Codes */ 1362#define REPORT_IDENTIFYING_INFRMATION 0x05 1363#define REPORT_TARGET_PORT_GROUPS 0x0A 1364#define REPORT_ALIASES 0x0B 1365#define REPORT_SUPPORTED_OPERATION_CODES 0x0C 1366#define REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS 0x0D 1367#define REPORT_PRIORITY 0x0E 1368#define REPORT_TIMESTAMP 0x0F 1369#define MANAGEMENT_PROTOCOL_IN 0x10 1370/* Maintenance Out Service Action Codes */ 1371#define SET_IDENTIFY_INFORMATION 0x06 1372#define SET_TARGET_PORT_GROUPS 0x0A 1373#define CHANGE_ALIASES 0x0B 1374#define SET_PRIORITY 0x0E 1375#define SET_TIMESTAMP 0x0F 1376#define MANGAEMENT_PROTOCOL_OUT 0x10 1377 1378/* 1379 * Device Types 1380 */ 1381#define T_DIRECT 0x00 1382#define T_SEQUENTIAL 0x01 1383#define T_PRINTER 0x02 1384#define T_PROCESSOR 0x03 1385#define T_WORM 0x04 1386#define T_CDROM 0x05 1387#define T_SCANNER 0x06 1388#define T_OPTICAL 0x07 1389#define T_CHANGER 0x08 1390#define T_COMM 0x09 1391#define T_ASC0 0x0a 1392#define T_ASC1 0x0b 1393#define T_STORARRAY 0x0c 1394#define T_ENCLOSURE 0x0d 1395#define T_RBC 0x0e 1396#define T_OCRW 0x0f 1397#define T_OSD 0x11 1398#define T_ADC 0x12 1399#define T_NODEVICE 0x1f 1400#define T_ANY 0xff /* Used in Quirk table matches */ 1401 1402#define T_REMOV 1 1403#define T_FIXED 0 1404 1405/* 1406 * This length is the initial inquiry length used by the probe code, as 1407 * well as the length necessary for scsi_print_inquiry() to function 1408 * correctly. If either use requires a different length in the future, 1409 * the two values should be de-coupled. 1410 */ 1411#define SHORT_INQUIRY_LENGTH 36 1412 1413struct scsi_inquiry_data 1414{ 1415 u_int8_t device; 1416#define SID_TYPE(inq_data) ((inq_data)->device & 0x1f) 1417#define SID_QUAL(inq_data) (((inq_data)->device & 0xE0) >> 5) 1418#define SID_QUAL_LU_CONNECTED 0x00 /* 1419 * The specified peripheral device 1420 * type is currently connected to 1421 * logical unit. If the target cannot 1422 * determine whether or not a physical 1423 * device is currently connected, it 1424 * shall also use this peripheral 1425 * qualifier when returning the INQUIRY 1426 * data. This peripheral qualifier 1427 * does not mean that the device is 1428 * ready for access by the initiator. 1429 */ 1430#define SID_QUAL_LU_OFFLINE 0x01 /* 1431 * The target is capable of supporting 1432 * the specified peripheral device type 1433 * on this logical unit; however, the 1434 * physical device is not currently 1435 * connected to this logical unit. 1436 */ 1437#define SID_QUAL_RSVD 0x02 1438#define SID_QUAL_BAD_LU 0x03 /* 1439 * The target is not capable of 1440 * supporting a physical device on 1441 * this logical unit. For this 1442 * peripheral qualifier the peripheral 1443 * device type shall be set to 1Fh to 1444 * provide compatibility with previous 1445 * versions of SCSI. All other 1446 * peripheral device type values are 1447 * reserved for this peripheral 1448 * qualifier. 1449 */ 1450#define SID_QUAL_IS_VENDOR_UNIQUE(inq_data) ((SID_QUAL(inq_data) & 0x08) != 0) 1451 u_int8_t dev_qual2; 1452#define SID_QUAL2 0x7F 1453#define SID_IS_REMOVABLE(inq_data) (((inq_data)->dev_qual2 & 0x80) != 0) 1454 u_int8_t version; 1455#define SID_ANSI_REV(inq_data) ((inq_data)->version & 0x07) 1456#define SCSI_REV_0 0 1457#define SCSI_REV_CCS 1 1458#define SCSI_REV_2 2 1459#define SCSI_REV_SPC 3 1460#define SCSI_REV_SPC2 4 1461#define SCSI_REV_SPC3 5 1462#define SCSI_REV_SPC4 6 1463 1464#define SID_ECMA 0x38 1465#define SID_ISO 0xC0 1466 u_int8_t response_format; 1467#define SID_AENC 0x80 1468#define SID_TrmIOP 0x40 1469#define SID_NormACA 0x20 1470#define SID_HiSup 0x10 1471 u_int8_t additional_length; 1472#define SID_ADDITIONAL_LENGTH(iqd) \ 1473 ((iqd)->additional_length + \ 1474 __offsetof(struct scsi_inquiry_data, additional_length) + 1) 1475 u_int8_t spc3_flags; 1476#define SPC3_SID_PROTECT 0x01 1477#define SPC3_SID_3PC 0x08 1478#define SPC3_SID_TPGS_MASK 0x30 1479#define SPC3_SID_TPGS_IMPLICIT 0x10 1480#define SPC3_SID_TPGS_EXPLICIT 0x20 1481#define SPC3_SID_ACC 0x40 1482#define SPC3_SID_SCCS 0x80 1483 u_int8_t spc2_flags; 1484#define SPC2_SID_ADDR16 0x01 1485#define SPC2_SID_MChngr 0x08 1486#define SPC2_SID_MultiP 0x10 1487#define SPC2_SID_EncServ 0x40 1488#define SPC2_SID_BQueue 0x80 1489 1490#define INQ_DATA_TQ_ENABLED(iqd) \ 1491 ((SID_ANSI_REV(iqd) < SCSI_REV_SPC2)? ((iqd)->flags & SID_CmdQue) : \ 1492 (((iqd)->flags & SID_CmdQue) && !((iqd)->spc2_flags & SPC2_SID_BQueue)) || \ 1493 (!((iqd)->flags & SID_CmdQue) && ((iqd)->spc2_flags & SPC2_SID_BQueue))) 1494 1495 u_int8_t flags; 1496#define SID_SftRe 0x01 1497#define SID_CmdQue 0x02 1498#define SID_Linked 0x08 1499#define SID_Sync 0x10 1500#define SID_WBus16 0x20 1501#define SID_WBus32 0x40 1502#define SID_RelAdr 0x80 1503#define SID_VENDOR_SIZE 8 1504 char vendor[SID_VENDOR_SIZE]; 1505#define SID_PRODUCT_SIZE 16 1506 char product[SID_PRODUCT_SIZE]; 1507#define SID_REVISION_SIZE 4 1508 char revision[SID_REVISION_SIZE]; 1509 /* 1510 * The following fields were taken from SCSI Primary Commands - 2 1511 * (SPC-2) Revision 14, Dated 11 November 1999 1512 */ 1513#define SID_VENDOR_SPECIFIC_0_SIZE 20 1514 u_int8_t vendor_specific0[SID_VENDOR_SPECIFIC_0_SIZE]; 1515 /* 1516 * An extension of SCSI Parallel Specific Values 1517 */ 1518#define SID_SPI_IUS 0x01 1519#define SID_SPI_QAS 0x02 1520#define SID_SPI_CLOCK_ST 0x00 1521#define SID_SPI_CLOCK_DT 0x04 1522#define SID_SPI_CLOCK_DT_ST 0x0C 1523#define SID_SPI_MASK 0x0F 1524 u_int8_t spi3data; 1525 u_int8_t reserved2; 1526 /* 1527 * Version Descriptors, stored 2 byte values. 1528 */ 1529 u_int8_t version1[2]; 1530 u_int8_t version2[2]; 1531 u_int8_t version3[2]; 1532 u_int8_t version4[2]; 1533 u_int8_t version5[2]; 1534 u_int8_t version6[2]; 1535 u_int8_t version7[2]; 1536 u_int8_t version8[2]; 1537 1538 u_int8_t reserved3[22]; 1539 1540#define SID_VENDOR_SPECIFIC_1_SIZE 160 1541 u_int8_t vendor_specific1[SID_VENDOR_SPECIFIC_1_SIZE]; 1542}; 1543 1544/* 1545 * This structure is more suited to initiator operation, because the 1546 * maximum number of supported pages is already allocated. 1547 */ 1548struct scsi_vpd_supported_page_list 1549{ 1550 u_int8_t device; 1551 u_int8_t page_code; 1552#define SVPD_SUPPORTED_PAGE_LIST 0x00 1553#define SVPD_SUPPORTED_PAGES_HDR_LEN 4 1554 u_int8_t reserved; 1555 u_int8_t length; /* number of VPD entries */ 1556#define SVPD_SUPPORTED_PAGES_SIZE 251 1557 u_int8_t list[SVPD_SUPPORTED_PAGES_SIZE]; 1558}; 1559 1560/* 1561 * This structure is more suited to target operation, because the 1562 * number of supported pages is left to the user to allocate. 1563 */ 1564struct scsi_vpd_supported_pages 1565{ 1566 u_int8_t device; 1567 u_int8_t page_code; 1568 u_int8_t reserved; 1569#define SVPD_SUPPORTED_PAGES 0x00 1570 u_int8_t length; 1571 u_int8_t page_list[0]; 1572}; 1573 1574 1575struct scsi_vpd_unit_serial_number 1576{ 1577 u_int8_t device; 1578 u_int8_t page_code; 1579#define SVPD_UNIT_SERIAL_NUMBER 0x80 1580 u_int8_t reserved; 1581 u_int8_t length; /* serial number length */ 1582#define SVPD_SERIAL_NUM_SIZE 251 1583 u_int8_t serial_num[SVPD_SERIAL_NUM_SIZE]; 1584}; 1585 1586struct scsi_vpd_device_id 1587{ 1588 u_int8_t device; 1589 u_int8_t page_code; 1590#define SVPD_DEVICE_ID 0x83 1591#define SVPD_DEVICE_ID_MAX_SIZE 252 1592#define SVPD_DEVICE_ID_HDR_LEN \ 1593 __offsetof(struct scsi_vpd_device_id, desc_list) 1594 u_int8_t length[2]; 1595 u_int8_t desc_list[]; 1596}; 1597 1598struct scsi_vpd_id_descriptor 1599{ 1600 u_int8_t proto_codeset; 1601 /* 1602 * See the SCSI_PROTO definitions above for the protocols. 1603 */ 1604#define SVPD_ID_PROTO_SHIFT 4 1605#define SVPD_ID_CODESET_BINARY 0x01 1606#define SVPD_ID_CODESET_ASCII 0x02 1607#define SVPD_ID_CODESET_UTF8 0x03 1608#define SVPD_ID_CODESET_MASK 0x0f 1609 u_int8_t id_type; 1610#define SVPD_ID_PIV 0x80 1611#define SVPD_ID_ASSOC_LUN 0x00 1612#define SVPD_ID_ASSOC_PORT 0x10 1613#define SVPD_ID_ASSOC_TARGET 0x20 1614#define SVPD_ID_ASSOC_MASK 0x30 1615#define SVPD_ID_TYPE_VENDOR 0x00 1616#define SVPD_ID_TYPE_T10 0x01 1617#define SVPD_ID_TYPE_EUI64 0x02 1618#define SVPD_ID_TYPE_NAA 0x03 1619#define SVPD_ID_TYPE_RELTARG 0x04 1620#define SVPD_ID_TYPE_TPORTGRP 0x05 1621#define SVPD_ID_TYPE_LUNGRP 0x06 1622#define SVPD_ID_TYPE_MD5_LUN_ID 0x07 1623#define SVPD_ID_TYPE_SCSI_NAME 0x08 1624#define SVPD_ID_TYPE_MASK 0x0f 1625 u_int8_t reserved; 1626 u_int8_t length; 1627#define SVPD_DEVICE_ID_DESC_HDR_LEN \ 1628 __offsetof(struct scsi_vpd_id_descriptor, identifier) 1629 u_int8_t identifier[]; 1630}; 1631 1632struct scsi_vpd_id_t10 1633{ 1634 u_int8_t vendor[8]; 1635 u_int8_t vendor_spec_id[0]; 1636}; 1637 1638struct scsi_vpd_id_eui64 1639{ 1640 u_int8_t ieee_company_id[3]; 1641 u_int8_t extension_id[5]; 1642}; 1643 1644struct scsi_vpd_id_naa_basic 1645{ 1646 uint8_t naa; 1647 /* big endian, packed: 1648 uint8_t naa : 4; 1649 uint8_t naa_desig : 4; 1650 */ 1651#define SVPD_ID_NAA_NAA_SHIFT 4 1652#define SVPD_ID_NAA_IEEE_EXT 0x02 1653#define SVPD_ID_NAA_LOCAL_REG 0x03 1654#define SVPD_ID_NAA_IEEE_REG 0x05 1655#define SVPD_ID_NAA_IEEE_REG_EXT 0x06 1656 uint8_t naa_data[]; 1657}; 1658 1659struct scsi_vpd_id_naa_ieee_extended_id 1660{ 1661 uint8_t naa; 1662 uint8_t vendor_specific_id_a; 1663 uint8_t ieee_company_id[3]; 1664 uint8_t vendor_specific_id_b[4]; 1665}; 1666 1667struct scsi_vpd_id_naa_local_reg 1668{ 1669 uint8_t naa; 1670 uint8_t local_value[7]; 1671}; 1672 1673struct scsi_vpd_id_naa_ieee_reg 1674{ 1675 uint8_t naa; 1676 uint8_t reg_value[7]; 1677 /* big endian, packed: 1678 uint8_t naa_basic : 4; 1679 uint8_t ieee_company_id_0 : 4; 1680 uint8_t ieee_company_id_1[2]; 1681 uint8_t ieee_company_id_2 : 4; 1682 uint8_t vendor_specific_id_0 : 4; 1683 uint8_t vendor_specific_id_1[4]; 1684 */ 1685}; 1686 1687struct scsi_vpd_id_naa_ieee_reg_extended 1688{ 1689 uint8_t naa; 1690 uint8_t reg_value[15]; 1691 /* big endian, packed: 1692 uint8_t naa_basic : 4; 1693 uint8_t ieee_company_id_0 : 4; 1694 uint8_t ieee_company_id_1[2]; 1695 uint8_t ieee_company_id_2 : 4; 1696 uint8_t vendor_specific_id_0 : 4; 1697 uint8_t vendor_specific_id_1[4]; 1698 uint8_t vendor_specific_id_ext[8]; 1699 */ 1700}; 1701 1702struct scsi_vpd_id_rel_trgt_port_id 1703{ 1704 uint8_t obsolete[2]; 1705 uint8_t rel_trgt_port_id[2]; 1706}; 1707 1708struct scsi_vpd_id_trgt_port_grp_id 1709{ 1710 uint8_t reserved[2]; 1711 uint8_t trgt_port_grp[2]; 1712}; 1713 1714struct scsi_vpd_id_lun_grp_id 1715{ 1716 uint8_t reserved[2]; 1717 uint8_t log_unit_grp[2]; 1718}; 1719 1720struct scsi_vpd_id_md5_lun_id 1721{ 1722 uint8_t lun_id[16]; 1723}; 1724 1725struct scsi_vpd_id_scsi_name 1726{ 1727 uint8_t name_string[256]; 1728}; 1729 1730struct scsi_service_action_in 1731{ 1732 uint8_t opcode; 1733 uint8_t service_action; 1734 uint8_t action_dependent[13]; 1735 uint8_t control; 1736}; 1737 1738struct scsi_diag_page { 1739 uint8_t page_code; 1740 uint8_t page_specific_flags; 1741 uint8_t length[2]; 1742 uint8_t params[0]; 1743}; 1744 1745struct scsi_vpd_port_designation 1746{ 1747 uint8_t reserved[2]; 1748 uint8_t relative_port_id[2]; 1749 uint8_t reserved2[2]; 1750 uint8_t initiator_transportid_length[2]; 1751 uint8_t initiator_transportid[0]; 1752}; 1753 1754struct scsi_vpd_port_designation_cont 1755{ 1756 uint8_t reserved[2]; 1757 uint8_t target_port_descriptors_length[2]; 1758 struct scsi_vpd_id_descriptor target_port_descriptors[0]; 1759}; 1760 1761struct scsi_vpd_scsi_ports 1762{ 1763 u_int8_t device; 1764 u_int8_t page_code; 1765#define SVPD_SCSI_PORTS 0x88 1766 u_int8_t page_length[2]; 1767 struct scsi_vpd_port_designation design[]; 1768}; 1769 1770/* 1771 * ATA Information VPD Page based on 1772 * T10/2126-D Revision 04 1773 */ 1774#define SVPD_ATA_INFORMATION 0x89 1775 1776/* 1777 * Block Device Characteristics VPD Page based on 1778 * T10/1799-D Revision 31 1779 */ 1780struct scsi_vpd_block_characteristics 1781{ 1782 u_int8_t device; 1783 u_int8_t page_code; 1784#define SVPD_BDC 0xB1 1785 u_int8_t page_length[2]; 1786 u_int8_t medium_rotation_rate[2]; 1787#define SVPD_BDC_RATE_NOT_REPORTED 0x00 1788#define SVPD_BDC_RATE_NONE_ROTATING 0x01 1789 u_int8_t reserved1; 1790 u_int8_t nominal_form_factor; 1791#define SVPD_BDC_FORM_NOT_REPORTED 0x00 1792#define SVPD_BDC_FORM_5_25INCH 0x01 1793#define SVPD_BDC_FORM_3_5INCH 0x02 1794#define SVPD_BDC_FORM_2_5INCH 0x03 1795#define SVPD_BDC_FORM_1_5INCH 0x04 1796#define SVPD_BDC_FORM_LESSTHAN_1_5INCH 0x05 1797 u_int8_t reserved2[56]; 1798}; 1799 1800/* 1801 * Logical Block Provisioning VPD Page based on 1802 * T10/1799-D Revision 31 1803 */ 1804struct scsi_vpd_logical_block_prov 1805{ 1806 u_int8_t device; 1807 u_int8_t page_code; 1808#define SVPD_LBP 0xB2 1809 u_int8_t page_length[2]; 1810#define SVPD_LBP_PL_BASIC 0x04 1811 u_int8_t threshold_exponent; 1812 u_int8_t flags; 1813#define SVPD_LBP_UNMAP 0x80 1814#define SVPD_LBP_WS16 0x40 1815#define SVPD_LBP_WS10 0x20 1816#define SVPD_LBP_RZ 0x04 1817#define SVPD_LBP_ANC_SUP 0x02 1818#define SVPD_LBP_DP 0x01 1819 u_int8_t prov_type; 1820#define SVPD_LBP_RESOURCE 0x01 1821#define SVPD_LBP_THIN 0x02 1822 u_int8_t reserved; 1823 /* 1824 * Provisioning Group Descriptor can be here if SVPD_LBP_DP is set 1825 * Its size can be determined from page_length - 4 1826 */ 1827}; 1828 1829/* 1830 * Block Limits VDP Page based on 1831 * T10/1799-D Revision 31 1832 */ 1833struct scsi_vpd_block_limits 1834{ 1835 u_int8_t device; 1836 u_int8_t page_code; 1837#define SVPD_BLOCK_LIMITS 0xB0 1838 u_int8_t page_length[2]; 1839#define SVPD_BL_PL_BASIC 0x10 1840#define SVPD_BL_PL_TP 0x3C 1841 u_int8_t reserved1; 1842 u_int8_t max_cmp_write_len; 1843 u_int8_t opt_txfer_len_grain[2]; 1844 u_int8_t max_txfer_len[4]; 1845 u_int8_t opt_txfer_len[4]; 1846 u_int8_t max_prefetch[4]; 1847 u_int8_t max_unmap_lba_cnt[4]; 1848 u_int8_t max_unmap_blk_cnt[4]; 1849 u_int8_t opt_unmap_grain[4]; 1850 u_int8_t unmap_grain_align[4]; 1851 u_int8_t max_write_same_length[8]; 1852 u_int8_t reserved2[20]; 1853}; 1854 1855struct scsi_read_capacity 1856{ 1857 u_int8_t opcode; 1858 u_int8_t byte2; 1859#define SRC_RELADR 0x01 1860 u_int8_t addr[4]; 1861 u_int8_t unused[2]; 1862 u_int8_t pmi; 1863#define SRC_PMI 0x01 1864 u_int8_t control; 1865}; 1866 1867struct scsi_read_capacity_16 1868{ 1869 uint8_t opcode; 1870#define SRC16_SERVICE_ACTION 0x10 1871 uint8_t service_action; 1872 uint8_t addr[8]; 1873 uint8_t alloc_len[4]; 1874#define SRC16_PMI 0x01 1875#define SRC16_RELADR 0x02 1876 uint8_t reladr; 1877 uint8_t control; 1878}; 1879 1880struct scsi_read_capacity_data 1881{ 1882 u_int8_t addr[4]; 1883 u_int8_t length[4]; 1884}; 1885 1886struct scsi_read_capacity_data_long 1887{ 1888 uint8_t addr[8]; 1889 uint8_t length[4]; 1890#define SRC16_PROT_EN 0x01 1891#define SRC16_P_TYPE 0x0e 1892#define SRC16_PTYPE_1 0x00 1893#define SRC16_PTYPE_2 0x02 1894#define SRC16_PTYPE_3 0x04 1895 uint8_t prot; 1896#define SRC16_LBPPBE 0x0f 1897#define SRC16_PI_EXPONENT 0xf0 1898#define SRC16_PI_EXPONENT_SHIFT 4 1899 uint8_t prot_lbppbe; 1900#define SRC16_LALBA 0x3f 1901#define SRC16_LBPRZ 0x40 1902#define SRC16_LBPME 0x80 1903/* 1904 * Alternate versions of these macros that are intended for use on a 16-bit 1905 * version of the lalba_lbp field instead of the array of 2 8 bit numbers. 1906 */ 1907#define SRC16_LALBA_A 0x3fff 1908#define SRC16_LBPRZ_A 0x4000 1909#define SRC16_LBPME_A 0x8000 1910 uint8_t lalba_lbp[2]; 1911 uint8_t reserved[16]; 1912}; 1913 1914struct scsi_report_luns 1915{ 1916 uint8_t opcode; 1917 uint8_t reserved1; 1918#define RPL_REPORT_DEFAULT 0x00 1919#define RPL_REPORT_WELLKNOWN 0x01 1920#define RPL_REPORT_ALL 0x02 1921 uint8_t select_report; 1922 uint8_t reserved2[3]; 1923 uint8_t length[4]; 1924 uint8_t reserved3; 1925 uint8_t control; 1926}; 1927 1928struct scsi_report_luns_lundata { 1929 uint8_t lundata[8]; 1930#define RPL_LUNDATA_PERIPH_BUS_MASK 0x3f 1931#define RPL_LUNDATA_FLAT_LUN_MASK 0x3f 1932#define RPL_LUNDATA_FLAT_LUN_BITS 0x06 1933#define RPL_LUNDATA_LUN_TARG_MASK 0x3f 1934#define RPL_LUNDATA_LUN_BUS_MASK 0xe0 1935#define RPL_LUNDATA_LUN_LUN_MASK 0x1f 1936#define RPL_LUNDATA_EXT_LEN_MASK 0x30 1937#define RPL_LUNDATA_EXT_EAM_MASK 0x0f 1938#define RPL_LUNDATA_EXT_EAM_WK 0x01 1939#define RPL_LUNDATA_EXT_EAM_NOT_SPEC 0x0f 1940#define RPL_LUNDATA_ATYP_MASK 0xc0 /* MBZ for type 0 lun */ 1941#define RPL_LUNDATA_ATYP_PERIPH 0x00 1942#define RPL_LUNDATA_ATYP_FLAT 0x40 1943#define RPL_LUNDATA_ATYP_LUN 0x80 1944#define RPL_LUNDATA_ATYP_EXTLUN 0xc0 1945}; 1946 1947struct scsi_report_luns_data { 1948 u_int8_t length[4]; /* length of LUN inventory, in bytes */ 1949 u_int8_t reserved[4]; /* unused */ 1950 /* 1951 * LUN inventory- we only support the type zero form for now. 1952 */ 1953 struct scsi_report_luns_lundata luns[0]; 1954}; 1955 1956struct scsi_target_group 1957{ 1958 uint8_t opcode; 1959 uint8_t service_action; 1960#define STG_PDF_MASK 0xe0 1961#define STG_PDF_LENGTH 0x00 1962#define STG_PDF_EXTENDED 0x20 1963 uint8_t reserved1[4]; 1964 uint8_t length[4]; 1965 uint8_t reserved2; 1966 uint8_t control; 1967}; 1968 1969struct scsi_target_port_descriptor { 1970 uint8_t reserved[2]; 1971 uint8_t relative_target_port_identifier[2]; 1972 uint8_t desc_list[]; 1973}; 1974 1975struct scsi_target_port_group_descriptor { 1976 uint8_t pref_state; 1977#define TPG_PRIMARY 0x80 1978#define TPG_ASYMMETRIC_ACCESS_STATE_MASK 0xf 1979#define TPG_ASYMMETRIC_ACCESS_OPTIMIZED 0x0 1980#define TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED 0x1 1981#define TPG_ASYMMETRIC_ACCESS_STANDBY 0x2 1982#define TPG_ASYMMETRIC_ACCESS_UNAVAILABLE 0x3 1983#define TPG_ASYMMETRIC_ACCESS_LBA_DEPENDENT 0x4 1984#define TPG_ASYMMETRIC_ACCESS_OFFLINE 0xE 1985#define TPG_ASYMMETRIC_ACCESS_TRANSITIONING 0xF 1986 uint8_t support; 1987#define TPG_AO_SUP 0x01 1988#define TPG_AN_SUP 0x02 1989#define TPG_S_SUP 0x04 1990#define TPG_U_SUP 0x08 1991#define TPG_LBD_SUP 0x10 1992#define TPG_O_SUP 0x40 1993#define TPG_T_SUP 0x80 1994 uint8_t target_port_group[2]; 1995 uint8_t reserved; 1996 uint8_t status; 1997#define TPG_UNAVLBL 0 1998#define TPG_SET_BY_STPG 0x01 1999#define TPG_IMPLICIT 0x02 2000 uint8_t vendor_specific; 2001 uint8_t target_port_count; 2002 struct scsi_target_port_descriptor descriptors[]; 2003}; 2004 2005struct scsi_target_group_data { 2006 uint8_t length[4]; /* length of returned data, in bytes */ 2007 struct scsi_target_port_group_descriptor groups[]; 2008}; 2009 2010struct scsi_target_group_data_extended { 2011 uint8_t length[4]; /* length of returned data, in bytes */ 2012 uint8_t format_type; /* STG_PDF_LENGTH or STG_PDF_EXTENDED */ 2013 uint8_t implicit_transition_time; 2014 uint8_t reserved[2]; 2015 struct scsi_target_port_group_descriptor groups[]; 2016}; 2017 2018 2019typedef enum { 2020 SSD_TYPE_NONE, 2021 SSD_TYPE_FIXED, 2022 SSD_TYPE_DESC 2023} scsi_sense_data_type; 2024 2025typedef enum { 2026 SSD_ELEM_NONE, 2027 SSD_ELEM_SKIP, 2028 SSD_ELEM_DESC, 2029 SSD_ELEM_SKS, 2030 SSD_ELEM_COMMAND, 2031 SSD_ELEM_INFO, 2032 SSD_ELEM_FRU, 2033 SSD_ELEM_STREAM, 2034 SSD_ELEM_MAX 2035} scsi_sense_elem_type; 2036 2037 2038struct scsi_sense_data 2039{ 2040 uint8_t error_code; 2041 /* 2042 * SPC-4 says that the maximum length of sense data is 252 bytes. 2043 * So this structure is exactly 252 bytes log. 2044 */ 2045#define SSD_FULL_SIZE 252 2046 uint8_t sense_buf[SSD_FULL_SIZE - 1]; 2047 /* 2048 * XXX KDM is this still a reasonable minimum size? 2049 */ 2050#define SSD_MIN_SIZE 18 2051 /* 2052 * Maximum value for the extra_len field in the sense data. 2053 */ 2054#define SSD_EXTRA_MAX 244 2055}; 2056 2057/* 2058 * Fixed format sense data. 2059 */ 2060struct scsi_sense_data_fixed 2061{ 2062 u_int8_t error_code; 2063#define SSD_ERRCODE 0x7F 2064#define SSD_CURRENT_ERROR 0x70 2065#define SSD_DEFERRED_ERROR 0x71 2066#define SSD_ERRCODE_VALID 0x80 2067 u_int8_t segment; 2068 u_int8_t flags; 2069#define SSD_KEY 0x0F 2070#define SSD_KEY_NO_SENSE 0x00 2071#define SSD_KEY_RECOVERED_ERROR 0x01 2072#define SSD_KEY_NOT_READY 0x02 2073#define SSD_KEY_MEDIUM_ERROR 0x03 2074#define SSD_KEY_HARDWARE_ERROR 0x04 2075#define SSD_KEY_ILLEGAL_REQUEST 0x05 2076#define SSD_KEY_UNIT_ATTENTION 0x06 2077#define SSD_KEY_DATA_PROTECT 0x07 2078#define SSD_KEY_BLANK_CHECK 0x08 2079#define SSD_KEY_Vendor_Specific 0x09 2080#define SSD_KEY_COPY_ABORTED 0x0a 2081#define SSD_KEY_ABORTED_COMMAND 0x0b 2082#define SSD_KEY_EQUAL 0x0c 2083#define SSD_KEY_VOLUME_OVERFLOW 0x0d 2084#define SSD_KEY_MISCOMPARE 0x0e 2085#define SSD_KEY_COMPLETED 0x0f 2086#define SSD_ILI 0x20 2087#define SSD_EOM 0x40 2088#define SSD_FILEMARK 0x80 2089 u_int8_t info[4]; 2090 u_int8_t extra_len; 2091 u_int8_t cmd_spec_info[4]; 2092 u_int8_t add_sense_code; 2093 u_int8_t add_sense_code_qual; 2094 u_int8_t fru; 2095 u_int8_t sense_key_spec[3]; 2096#define SSD_SCS_VALID 0x80 2097#define SSD_FIELDPTR_CMD 0x40 2098#define SSD_BITPTR_VALID 0x08 2099#define SSD_BITPTR_VALUE 0x07 2100 u_int8_t extra_bytes[14]; 2101#define SSD_FIXED_IS_PRESENT(sense, length, field) \ 2102 ((length >= (offsetof(struct scsi_sense_data_fixed, field) + \ 2103 sizeof(sense->field))) ? 1 :0) 2104#define SSD_FIXED_IS_FILLED(sense, field) \ 2105 ((((offsetof(struct scsi_sense_data_fixed, field) + \ 2106 sizeof(sense->field)) - \ 2107 (offsetof(struct scsi_sense_data_fixed, extra_len) + \ 2108 sizeof(sense->extra_len))) <= sense->extra_len) ? 1 : 0) 2109}; 2110 2111/* 2112 * Descriptor format sense data definitions. 2113 * Introduced in SPC-3. 2114 */ 2115struct scsi_sense_data_desc 2116{ 2117 uint8_t error_code; 2118#define SSD_DESC_CURRENT_ERROR 0x72 2119#define SSD_DESC_DEFERRED_ERROR 0x73 2120 uint8_t sense_key; 2121 uint8_t add_sense_code; 2122 uint8_t add_sense_code_qual; 2123 uint8_t reserved[3]; 2124 /* 2125 * Note that SPC-4, section 4.5.2.1 says that the extra_len field 2126 * must be less than or equal to 244. 2127 */ 2128 uint8_t extra_len; 2129 uint8_t sense_desc[0]; 2130#define SSD_DESC_IS_PRESENT(sense, length, field) \ 2131 ((length >= (offsetof(struct scsi_sense_data_desc, field) + \ 2132 sizeof(sense->field))) ? 1 :0) 2133}; 2134 2135struct scsi_sense_desc_header 2136{ 2137 uint8_t desc_type; 2138 uint8_t length; 2139}; 2140/* 2141 * The information provide in the Information descriptor is device type or 2142 * command specific information, and defined in a command standard. 2143 * 2144 * Note that any changes to the field names or positions in this structure, 2145 * even reserved fields, should be accompanied by an examination of the 2146 * code in ctl_set_sense() that uses them. 2147 * 2148 * Maximum descriptors allowed: 1 (as of SPC-4) 2149 */ 2150struct scsi_sense_info 2151{ 2152 uint8_t desc_type; 2153#define SSD_DESC_INFO 0x00 2154 uint8_t length; 2155 uint8_t byte2; 2156#define SSD_INFO_VALID 0x80 2157 uint8_t reserved; 2158 uint8_t info[8]; 2159}; 2160 2161/* 2162 * Command-specific information depends on the command for which the 2163 * reported condition occured. 2164 * 2165 * Note that any changes to the field names or positions in this structure, 2166 * even reserved fields, should be accompanied by an examination of the 2167 * code in ctl_set_sense() that uses them. 2168 * 2169 * Maximum descriptors allowed: 1 (as of SPC-4) 2170 */ 2171struct scsi_sense_command 2172{ 2173 uint8_t desc_type; 2174#define SSD_DESC_COMMAND 0x01 2175 uint8_t length; 2176 uint8_t reserved[2]; 2177 uint8_t command_info[8]; 2178}; 2179 2180/* 2181 * Sense key specific descriptor. The sense key specific data format 2182 * depends on the sense key in question. 2183 * 2184 * Maximum descriptors allowed: 1 (as of SPC-4) 2185 */ 2186struct scsi_sense_sks 2187{ 2188 uint8_t desc_type; 2189#define SSD_DESC_SKS 0x02 2190 uint8_t length; 2191 uint8_t reserved1[2]; 2192 uint8_t sense_key_spec[3]; 2193#define SSD_SKS_VALID 0x80 2194 uint8_t reserved2; 2195}; 2196 2197/* 2198 * This is used for the Illegal Request sense key (0x05) only. 2199 */ 2200struct scsi_sense_sks_field 2201{ 2202 uint8_t byte0; 2203#define SSD_SKS_FIELD_VALID 0x80 2204#define SSD_SKS_FIELD_CMD 0x40 2205#define SSD_SKS_BPV 0x08 2206#define SSD_SKS_BIT_VALUE 0x07 2207 uint8_t field[2]; 2208}; 2209 2210 2211/* 2212 * This is used for the Hardware Error (0x04), Medium Error (0x03) and 2213 * Recovered Error (0x01) sense keys. 2214 */ 2215struct scsi_sense_sks_retry 2216{ 2217 uint8_t byte0; 2218#define SSD_SKS_RETRY_VALID 0x80 2219 uint8_t actual_retry_count[2]; 2220}; 2221 2222/* 2223 * Used with the NO Sense (0x00) or Not Ready (0x02) sense keys. 2224 */ 2225struct scsi_sense_sks_progress 2226{ 2227 uint8_t byte0; 2228#define SSD_SKS_PROGRESS_VALID 0x80 2229 uint8_t progress[2]; 2230#define SSD_SKS_PROGRESS_DENOM 0x10000 2231}; 2232 2233/* 2234 * Used with the Copy Aborted (0x0a) sense key. 2235 */ 2236struct scsi_sense_sks_segment 2237{ 2238 uint8_t byte0; 2239#define SSD_SKS_SEGMENT_VALID 0x80 2240#define SSD_SKS_SEGMENT_SD 0x20 2241#define SSD_SKS_SEGMENT_BPV 0x08 2242#define SSD_SKS_SEGMENT_BITPTR 0x07 2243 uint8_t field[2]; 2244}; 2245 2246/* 2247 * Used with the Unit Attention (0x06) sense key. 2248 * 2249 * This is currently used to indicate that the unit attention condition 2250 * queue has overflowed (when the overflow bit is set). 2251 */ 2252struct scsi_sense_sks_overflow 2253{ 2254 uint8_t byte0; 2255#define SSD_SKS_OVERFLOW_VALID 0x80 2256#define SSD_SKS_OVERFLOW_SET 0x01 2257 uint8_t reserved[2]; 2258}; 2259 2260/* 2261 * This specifies which component is associated with the sense data. There 2262 * is no standard meaning for the fru value. 2263 * 2264 * Maximum descriptors allowed: 1 (as of SPC-4) 2265 */ 2266struct scsi_sense_fru 2267{ 2268 uint8_t desc_type; 2269#define SSD_DESC_FRU 0x03 2270 uint8_t length; 2271 uint8_t reserved; 2272 uint8_t fru; 2273}; 2274 2275/* 2276 * Used for Stream commands, defined in SSC-4. 2277 * 2278 * Maximum descriptors allowed: 1 (as of SPC-4) 2279 */ 2280 2281struct scsi_sense_stream 2282{ 2283 uint8_t desc_type; 2284#define SSD_DESC_STREAM 0x04 2285 uint8_t length; 2286 uint8_t reserved; 2287 uint8_t byte3; 2288#define SSD_DESC_STREAM_FM 0x80 2289#define SSD_DESC_STREAM_EOM 0x40 2290#define SSD_DESC_STREAM_ILI 0x20 2291}; 2292 2293/* 2294 * Used for Block commands, defined in SBC-3. 2295 * 2296 * This is currently (as of SBC-3) only used for the Incorrect Length 2297 * Indication (ILI) bit, which says that the data length requested in the 2298 * READ LONG or WRITE LONG command did not match the length of the logical 2299 * block. 2300 * 2301 * Maximum descriptors allowed: 1 (as of SPC-4) 2302 */ 2303struct scsi_sense_block 2304{ 2305 uint8_t desc_type; 2306#define SSD_DESC_BLOCK 0x05 2307 uint8_t length; 2308 uint8_t reserved; 2309 uint8_t byte3; 2310#define SSD_DESC_BLOCK_ILI 0x20 2311}; 2312 2313/* 2314 * Used for Object-Based Storage Devices (OSD-3). 2315 * 2316 * Maximum descriptors allowed: 1 (as of SPC-4) 2317 */ 2318struct scsi_sense_osd_objid 2319{ 2320 uint8_t desc_type; 2321#define SSD_DESC_OSD_OBJID 0x06 2322 uint8_t length; 2323 uint8_t reserved[6]; 2324 /* 2325 * XXX KDM provide the bit definitions here? There are a lot of 2326 * them, and we don't have an OSD driver yet. 2327 */ 2328 uint8_t not_init_cmds[4]; 2329 uint8_t completed_cmds[4]; 2330 uint8_t partition_id[8]; 2331 uint8_t object_id[8]; 2332}; 2333 2334/* 2335 * Used for Object-Based Storage Devices (OSD-3). 2336 * 2337 * Maximum descriptors allowed: 1 (as of SPC-4) 2338 */ 2339struct scsi_sense_osd_integrity 2340{ 2341 uint8_t desc_type; 2342#define SSD_DESC_OSD_INTEGRITY 0x07 2343 uint8_t length; 2344 uint8_t integ_check_val[32]; 2345}; 2346 2347/* 2348 * Used for Object-Based Storage Devices (OSD-3). 2349 * 2350 * Maximum descriptors allowed: 1 (as of SPC-4) 2351 */ 2352struct scsi_sense_osd_attr_id 2353{ 2354 uint8_t desc_type; 2355#define SSD_DESC_OSD_ATTR_ID 0x08 2356 uint8_t length; 2357 uint8_t reserved[2]; 2358 uint8_t attr_desc[0]; 2359}; 2360 2361/* 2362 * Used with Sense keys No Sense (0x00) and Not Ready (0x02). 2363 * 2364 * Maximum descriptors allowed: 32 (as of SPC-4) 2365 */ 2366struct scsi_sense_progress 2367{ 2368 uint8_t desc_type; 2369#define SSD_DESC_PROGRESS 0x0a 2370 uint8_t length; 2371 uint8_t sense_key; 2372 uint8_t add_sense_code; 2373 uint8_t add_sense_code_qual; 2374 uint8_t reserved; 2375 uint8_t progress[2]; 2376}; 2377 2378/* 2379 * This is typically forwarded as the result of an EXTENDED COPY command. 2380 * 2381 * Maximum descriptors allowed: 2 (as of SPC-4) 2382 */ 2383struct scsi_sense_forwarded 2384{ 2385 uint8_t desc_type; 2386#define SSD_DESC_FORWARDED 0x0c 2387 uint8_t length; 2388 uint8_t byte2; 2389#define SSD_FORWARDED_FSDT 0x80 2390#define SSD_FORWARDED_SDS_MASK 0x0f 2391#define SSD_FORWARDED_SDS_UNK 0x00 2392#define SSD_FORWARDED_SDS_EXSRC 0x01 2393#define SSD_FORWARDED_SDS_EXDST 0x02 2394}; 2395 2396/* 2397 * Vendor-specific sense descriptor. The desc_type field will be in the 2398 * range bewteen MIN and MAX inclusive. 2399 */ 2400struct scsi_sense_vendor 2401{ 2402 uint8_t desc_type; 2403#define SSD_DESC_VENDOR_MIN 0x80 2404#define SSD_DESC_VENDOR_MAX 0xff 2405 uint8_t length; 2406 uint8_t data[0]; 2407}; 2408 2409struct scsi_mode_header_6 2410{ 2411 u_int8_t data_length; /* Sense data length */ 2412 u_int8_t medium_type; 2413 u_int8_t dev_spec; 2414 u_int8_t blk_desc_len; 2415}; 2416 2417struct scsi_mode_header_10 2418{ 2419 u_int8_t data_length[2];/* Sense data length */ 2420 u_int8_t medium_type; 2421 u_int8_t dev_spec; 2422 u_int8_t unused[2]; 2423 u_int8_t blk_desc_len[2]; 2424}; 2425 2426struct scsi_mode_page_header 2427{ 2428 u_int8_t page_code; 2429#define SMPH_PS 0x80 2430#define SMPH_SPF 0x40 2431#define SMPH_PC_MASK 0x3f 2432 u_int8_t page_length; 2433}; 2434 2435struct scsi_mode_page_header_sp 2436{ 2437 uint8_t page_code; 2438 uint8_t subpage; 2439 uint8_t page_length[2]; 2440}; 2441 2442 2443struct scsi_mode_blk_desc 2444{ 2445 u_int8_t density; 2446 u_int8_t nblocks[3]; 2447 u_int8_t reserved; 2448 u_int8_t blklen[3]; 2449}; 2450 2451#define SCSI_DEFAULT_DENSITY 0x00 /* use 'default' density */ 2452#define SCSI_SAME_DENSITY 0x7f /* use 'same' density- >= SCSI-2 only */ 2453 2454 2455/* 2456 * Status Byte 2457 */ 2458#define SCSI_STATUS_OK 0x00 2459#define SCSI_STATUS_CHECK_COND 0x02 2460#define SCSI_STATUS_COND_MET 0x04 2461#define SCSI_STATUS_BUSY 0x08 2462#define SCSI_STATUS_INTERMED 0x10 2463#define SCSI_STATUS_INTERMED_COND_MET 0x14 2464#define SCSI_STATUS_RESERV_CONFLICT 0x18 2465#define SCSI_STATUS_CMD_TERMINATED 0x22 /* Obsolete in SAM-2 */ 2466#define SCSI_STATUS_QUEUE_FULL 0x28 2467#define SCSI_STATUS_ACA_ACTIVE 0x30 2468#define SCSI_STATUS_TASK_ABORTED 0x40 2469 2470struct scsi_inquiry_pattern { 2471 u_int8_t type; 2472 u_int8_t media_type; 2473#define SIP_MEDIA_REMOVABLE 0x01 2474#define SIP_MEDIA_FIXED 0x02 2475 const char *vendor; 2476 const char *product; 2477 const char *revision; 2478}; 2479 2480struct scsi_static_inquiry_pattern { 2481 u_int8_t type; 2482 u_int8_t media_type; 2483 char vendor[SID_VENDOR_SIZE+1]; 2484 char product[SID_PRODUCT_SIZE+1]; 2485 char revision[SID_REVISION_SIZE+1]; 2486}; 2487 2488struct scsi_sense_quirk_entry { 2489 struct scsi_inquiry_pattern inq_pat; 2490 int num_sense_keys; 2491 int num_ascs; 2492 struct sense_key_table_entry *sense_key_info; 2493 struct asc_table_entry *asc_info; 2494}; 2495 2496struct sense_key_table_entry { 2497 u_int8_t sense_key; 2498 u_int32_t action; 2499 const char *desc; 2500}; 2501 2502struct asc_table_entry { 2503 u_int8_t asc; 2504 u_int8_t ascq; 2505 u_int32_t action; 2506 const char *desc; 2507}; 2508 2509struct op_table_entry { 2510 u_int8_t opcode; 2511 u_int32_t opmask; 2512 const char *desc; 2513}; 2514 2515struct scsi_op_quirk_entry { 2516 struct scsi_inquiry_pattern inq_pat; 2517 int num_ops; 2518 struct op_table_entry *op_table; 2519}; 2520 2521typedef enum { 2522 SSS_FLAG_NONE = 0x00, 2523 SSS_FLAG_PRINT_COMMAND = 0x01 2524} scsi_sense_string_flags; 2525 2526struct scsi_nv { 2527 const char *name; 2528 uint64_t value; 2529}; 2530 2531typedef enum { 2532 SCSI_NV_FOUND, 2533 SCSI_NV_AMBIGUOUS, 2534 SCSI_NV_NOT_FOUND 2535} scsi_nv_status; 2536 2537typedef enum { 2538 SCSI_NV_FLAG_NONE = 0x00, 2539 SCSI_NV_FLAG_IG_CASE = 0x01 /* Case insensitive comparison */ 2540} scsi_nv_flags; 2541 2542struct ccb_scsiio; 2543struct cam_periph; 2544union ccb; 2545#ifndef _KERNEL 2546struct cam_device; 2547#endif 2548 2549extern const char *scsi_sense_key_text[]; 2550 2551struct sbuf; 2552 2553__BEGIN_DECLS 2554void scsi_sense_desc(int sense_key, int asc, int ascq, 2555 struct scsi_inquiry_data *inq_data, 2556 const char **sense_key_desc, const char **asc_desc); 2557scsi_sense_action scsi_error_action(struct ccb_scsiio* csio, 2558 struct scsi_inquiry_data *inq_data, 2559 u_int32_t sense_flags); 2560const char * scsi_status_string(struct ccb_scsiio *csio); 2561 2562void scsi_desc_iterate(struct scsi_sense_data_desc *sense, u_int sense_len, 2563 int (*iter_func)(struct scsi_sense_data_desc *sense, 2564 u_int, struct scsi_sense_desc_header *, 2565 void *), void *arg); 2566uint8_t *scsi_find_desc(struct scsi_sense_data_desc *sense, u_int sense_len, 2567 uint8_t desc_type); 2568void scsi_set_sense_data(struct scsi_sense_data *sense_data, 2569 scsi_sense_data_type sense_format, int current_error, 2570 int sense_key, int asc, int ascq, ...) ; 2571void scsi_set_sense_data_va(struct scsi_sense_data *sense_data, 2572 scsi_sense_data_type sense_format, 2573 int current_error, int sense_key, int asc, 2574 int ascq, va_list ap); 2575int scsi_get_sense_info(struct scsi_sense_data *sense_data, u_int sense_len, 2576 uint8_t info_type, uint64_t *info, 2577 int64_t *signed_info); 2578int scsi_get_sks(struct scsi_sense_data *sense_data, u_int sense_len, 2579 uint8_t *sks); 2580int scsi_get_block_info(struct scsi_sense_data *sense_data, u_int sense_len, 2581 struct scsi_inquiry_data *inq_data, 2582 uint8_t *block_bits); 2583int scsi_get_stream_info(struct scsi_sense_data *sense_data, u_int sense_len, 2584 struct scsi_inquiry_data *inq_data, 2585 uint8_t *stream_bits); 2586void scsi_info_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len, 2587 struct scsi_inquiry_data *inq_data, uint64_t info); 2588void scsi_command_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len, 2589 struct scsi_inquiry_data *inq_data, uint64_t csi); 2590void scsi_progress_sbuf(struct sbuf *sb, uint16_t progress); 2591int scsi_sks_sbuf(struct sbuf *sb, int sense_key, uint8_t *sks); 2592void scsi_fru_sbuf(struct sbuf *sb, uint64_t fru); 2593void scsi_stream_sbuf(struct sbuf *sb, uint8_t stream_bits, uint64_t info); 2594void scsi_block_sbuf(struct sbuf *sb, uint8_t block_bits, uint64_t info); 2595void scsi_sense_info_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 2596 u_int sense_len, uint8_t *cdb, int cdb_len, 2597 struct scsi_inquiry_data *inq_data, 2598 struct scsi_sense_desc_header *header); 2599 2600void scsi_sense_command_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 2601 u_int sense_len, uint8_t *cdb, int cdb_len, 2602 struct scsi_inquiry_data *inq_data, 2603 struct scsi_sense_desc_header *header); 2604void scsi_sense_sks_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 2605 u_int sense_len, uint8_t *cdb, int cdb_len, 2606 struct scsi_inquiry_data *inq_data, 2607 struct scsi_sense_desc_header *header); 2608void scsi_sense_fru_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 2609 u_int sense_len, uint8_t *cdb, int cdb_len, 2610 struct scsi_inquiry_data *inq_data, 2611 struct scsi_sense_desc_header *header); 2612void scsi_sense_stream_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 2613 u_int sense_len, uint8_t *cdb, int cdb_len, 2614 struct scsi_inquiry_data *inq_data, 2615 struct scsi_sense_desc_header *header); 2616void scsi_sense_block_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 2617 u_int sense_len, uint8_t *cdb, int cdb_len, 2618 struct scsi_inquiry_data *inq_data, 2619 struct scsi_sense_desc_header *header); 2620void scsi_sense_progress_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 2621 u_int sense_len, uint8_t *cdb, int cdb_len, 2622 struct scsi_inquiry_data *inq_data, 2623 struct scsi_sense_desc_header *header); 2624void scsi_sense_generic_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 2625 u_int sense_len, uint8_t *cdb, int cdb_len, 2626 struct scsi_inquiry_data *inq_data, 2627 struct scsi_sense_desc_header *header); 2628void scsi_sense_desc_sbuf(struct sbuf *sb, struct scsi_sense_data *sense, 2629 u_int sense_len, uint8_t *cdb, int cdb_len, 2630 struct scsi_inquiry_data *inq_data, 2631 struct scsi_sense_desc_header *header); 2632scsi_sense_data_type scsi_sense_type(struct scsi_sense_data *sense_data); 2633 2634void scsi_sense_only_sbuf(struct scsi_sense_data *sense, u_int sense_len, 2635 struct sbuf *sb, char *path_str, 2636 struct scsi_inquiry_data *inq_data, uint8_t *cdb, 2637 int cdb_len); 2638 2639#ifdef _KERNEL 2640int scsi_command_string(struct ccb_scsiio *csio, struct sbuf *sb); 2641int scsi_sense_sbuf(struct ccb_scsiio *csio, struct sbuf *sb, 2642 scsi_sense_string_flags flags); 2643char * scsi_sense_string(struct ccb_scsiio *csio, 2644 char *str, int str_len); 2645void scsi_sense_print(struct ccb_scsiio *csio); 2646int scsi_vpd_supported_page(struct cam_periph *periph, 2647 uint8_t page_id); 2648#else /* _KERNEL */ 2649int scsi_command_string(struct cam_device *device, 2650 struct ccb_scsiio *csio, struct sbuf *sb); 2651int scsi_sense_sbuf(struct cam_device *device, 2652 struct ccb_scsiio *csio, struct sbuf *sb, 2653 scsi_sense_string_flags flags); 2654char * scsi_sense_string(struct cam_device *device, 2655 struct ccb_scsiio *csio, 2656 char *str, int str_len); 2657void scsi_sense_print(struct cam_device *device, 2658 struct ccb_scsiio *csio, FILE *ofile); 2659#endif /* _KERNEL */ 2660 2661const char * scsi_op_desc(u_int16_t opcode, 2662 struct scsi_inquiry_data *inq_data); 2663char * scsi_cdb_string(u_int8_t *cdb_ptr, char *cdb_string, 2664 size_t len); 2665 2666void scsi_print_inquiry(struct scsi_inquiry_data *inq_data); 2667void scsi_print_inquiry_short(struct scsi_inquiry_data *inq_data); 2668 2669u_int scsi_calc_syncsrate(u_int period_factor); 2670u_int scsi_calc_syncparam(u_int period); 2671 2672typedef int (*scsi_devid_checkfn_t)(uint8_t *); 2673int scsi_devid_is_naa_ieee_reg(uint8_t *bufp); 2674int scsi_devid_is_sas_target(uint8_t *bufp); 2675int scsi_devid_is_lun_eui64(uint8_t *bufp); 2676int scsi_devid_is_lun_naa(uint8_t *bufp); 2677int scsi_devid_is_lun_name(uint8_t *bufp); 2678int scsi_devid_is_lun_t10(uint8_t *bufp); 2679struct scsi_vpd_id_descriptor * 2680 scsi_get_devid(struct scsi_vpd_device_id *id, uint32_t len, 2681 scsi_devid_checkfn_t ck_fn); 2682 2683int scsi_transportid_sbuf(struct sbuf *sb, 2684 struct scsi_transportid_header *hdr, 2685 uint32_t valid_len); 2686 2687const char * scsi_nv_to_str(struct scsi_nv *table, int num_table_entries, 2688 uint64_t value); 2689 2690scsi_nv_status scsi_get_nv(struct scsi_nv *table, int num_table_entries, 2691 char *name, int *table_entry, scsi_nv_flags flags); 2692 2693int scsi_parse_transportid_64bit(int proto_id, char *id_str, 2694 struct scsi_transportid_header **hdr, 2695 unsigned int *alloc_len, 2696#ifdef _KERNEL 2697 struct malloc_type *type, int flags, 2698#endif 2699 char *error_str, int error_str_len); 2700 2701int scsi_parse_transportid_spi(char *id_str, 2702 struct scsi_transportid_header **hdr, 2703 unsigned int *alloc_len, 2704#ifdef _KERNEL 2705 struct malloc_type *type, int flags, 2706#endif 2707 char *error_str, int error_str_len); 2708 2709int scsi_parse_transportid_rdma(char *id_str, 2710 struct scsi_transportid_header **hdr, 2711 unsigned int *alloc_len, 2712#ifdef _KERNEL 2713 struct malloc_type *type, int flags, 2714#endif 2715 char *error_str, int error_str_len); 2716 2717int scsi_parse_transportid_iscsi(char *id_str, 2718 struct scsi_transportid_header **hdr, 2719 unsigned int *alloc_len, 2720#ifdef _KERNEL 2721 struct malloc_type *type, int flags, 2722#endif 2723 char *error_str,int error_str_len); 2724 2725int scsi_parse_transportid_sop(char *id_str, 2726 struct scsi_transportid_header **hdr, 2727 unsigned int *alloc_len, 2728#ifdef _KERNEL 2729 struct malloc_type *type, int flags, 2730#endif 2731 char *error_str,int error_str_len); 2732 2733int scsi_parse_transportid(char *transportid_str, 2734 struct scsi_transportid_header **hdr, 2735 unsigned int *alloc_len, 2736#ifdef _KERNEL 2737 struct malloc_type *type, int flags, 2738#endif 2739 char *error_str, int error_str_len); 2740 2741void scsi_test_unit_ready(struct ccb_scsiio *csio, u_int32_t retries, 2742 void (*cbfcnp)(struct cam_periph *, 2743 union ccb *), 2744 u_int8_t tag_action, 2745 u_int8_t sense_len, u_int32_t timeout); 2746 2747void scsi_request_sense(struct ccb_scsiio *csio, u_int32_t retries, 2748 void (*cbfcnp)(struct cam_periph *, 2749 union ccb *), 2750 void *data_ptr, u_int8_t dxfer_len, 2751 u_int8_t tag_action, u_int8_t sense_len, 2752 u_int32_t timeout); 2753 2754void scsi_inquiry(struct ccb_scsiio *csio, u_int32_t retries, 2755 void (*cbfcnp)(struct cam_periph *, union ccb *), 2756 u_int8_t tag_action, u_int8_t *inq_buf, 2757 u_int32_t inq_len, int evpd, u_int8_t page_code, 2758 u_int8_t sense_len, u_int32_t timeout); 2759 2760void scsi_mode_sense(struct ccb_scsiio *csio, u_int32_t retries, 2761 void (*cbfcnp)(struct cam_periph *, 2762 union ccb *), 2763 u_int8_t tag_action, int dbd, 2764 u_int8_t page_code, u_int8_t page, 2765 u_int8_t *param_buf, u_int32_t param_len, 2766 u_int8_t sense_len, u_int32_t timeout); 2767 2768void scsi_mode_sense_len(struct ccb_scsiio *csio, u_int32_t retries, 2769 void (*cbfcnp)(struct cam_periph *, 2770 union ccb *), 2771 u_int8_t tag_action, int dbd, 2772 u_int8_t page_code, u_int8_t page, 2773 u_int8_t *param_buf, u_int32_t param_len, 2774 int minimum_cmd_size, u_int8_t sense_len, 2775 u_int32_t timeout); 2776 2777void scsi_mode_select(struct ccb_scsiio *csio, u_int32_t retries, 2778 void (*cbfcnp)(struct cam_periph *, 2779 union ccb *), 2780 u_int8_t tag_action, int scsi_page_fmt, 2781 int save_pages, u_int8_t *param_buf, 2782 u_int32_t param_len, u_int8_t sense_len, 2783 u_int32_t timeout); 2784 2785void scsi_mode_select_len(struct ccb_scsiio *csio, u_int32_t retries, 2786 void (*cbfcnp)(struct cam_periph *, 2787 union ccb *), 2788 u_int8_t tag_action, int scsi_page_fmt, 2789 int save_pages, u_int8_t *param_buf, 2790 u_int32_t param_len, int minimum_cmd_size, 2791 u_int8_t sense_len, u_int32_t timeout); 2792 2793void scsi_log_sense(struct ccb_scsiio *csio, u_int32_t retries, 2794 void (*cbfcnp)(struct cam_periph *, union ccb *), 2795 u_int8_t tag_action, u_int8_t page_code, 2796 u_int8_t page, int save_pages, int ppc, 2797 u_int32_t paramptr, u_int8_t *param_buf, 2798 u_int32_t param_len, u_int8_t sense_len, 2799 u_int32_t timeout); 2800 2801void scsi_log_select(struct ccb_scsiio *csio, u_int32_t retries, 2802 void (*cbfcnp)(struct cam_periph *, 2803 union ccb *), u_int8_t tag_action, 2804 u_int8_t page_code, int save_pages, 2805 int pc_reset, u_int8_t *param_buf, 2806 u_int32_t param_len, u_int8_t sense_len, 2807 u_int32_t timeout); 2808 2809void scsi_prevent(struct ccb_scsiio *csio, u_int32_t retries, 2810 void (*cbfcnp)(struct cam_periph *, union ccb *), 2811 u_int8_t tag_action, u_int8_t action, 2812 u_int8_t sense_len, u_int32_t timeout); 2813 2814void scsi_read_capacity(struct ccb_scsiio *csio, u_int32_t retries, 2815 void (*cbfcnp)(struct cam_periph *, 2816 union ccb *), u_int8_t tag_action, 2817 struct scsi_read_capacity_data *, 2818 u_int8_t sense_len, u_int32_t timeout); 2819void scsi_read_capacity_16(struct ccb_scsiio *csio, uint32_t retries, 2820 void (*cbfcnp)(struct cam_periph *, 2821 union ccb *), uint8_t tag_action, 2822 uint64_t lba, int reladr, int pmi, 2823 uint8_t *rcap_buf, int rcap_buf_len, 2824 uint8_t sense_len, uint32_t timeout); 2825 2826void scsi_report_luns(struct ccb_scsiio *csio, u_int32_t retries, 2827 void (*cbfcnp)(struct cam_periph *, 2828 union ccb *), u_int8_t tag_action, 2829 u_int8_t select_report, 2830 struct scsi_report_luns_data *rpl_buf, 2831 u_int32_t alloc_len, u_int8_t sense_len, 2832 u_int32_t timeout); 2833 2834void scsi_report_target_group(struct ccb_scsiio *csio, u_int32_t retries, 2835 void (*cbfcnp)(struct cam_periph *, 2836 union ccb *), u_int8_t tag_action, 2837 u_int8_t pdf, 2838 void *buf, 2839 u_int32_t alloc_len, u_int8_t sense_len, 2840 u_int32_t timeout); 2841 2842void scsi_set_target_group(struct ccb_scsiio *csio, u_int32_t retries, 2843 void (*cbfcnp)(struct cam_periph *, 2844 union ccb *), u_int8_t tag_action, void *buf, 2845 u_int32_t alloc_len, u_int8_t sense_len, 2846 u_int32_t timeout); 2847 2848void scsi_synchronize_cache(struct ccb_scsiio *csio, 2849 u_int32_t retries, 2850 void (*cbfcnp)(struct cam_periph *, 2851 union ccb *), u_int8_t tag_action, 2852 u_int32_t begin_lba, u_int16_t lb_count, 2853 u_int8_t sense_len, u_int32_t timeout); 2854 2855void scsi_receive_diagnostic_results(struct ccb_scsiio *csio, u_int32_t retries, 2856 void (*cbfcnp)(struct cam_periph *, 2857 union ccb*), 2858 uint8_t tag_action, int pcv, 2859 uint8_t page_code, uint8_t *data_ptr, 2860 uint16_t allocation_length, 2861 uint8_t sense_len, uint32_t timeout); 2862 2863void scsi_send_diagnostic(struct ccb_scsiio *csio, u_int32_t retries, 2864 void (*cbfcnp)(struct cam_periph *, union ccb *), 2865 uint8_t tag_action, int unit_offline, 2866 int device_offline, int self_test, int page_format, 2867 int self_test_code, uint8_t *data_ptr, 2868 uint16_t param_list_length, uint8_t sense_len, 2869 uint32_t timeout); 2870 2871void scsi_read_buffer(struct ccb_scsiio *csio, u_int32_t retries, 2872 void (*cbfcnp)(struct cam_periph *, union ccb*), 2873 uint8_t tag_action, int mode, 2874 uint8_t buffer_id, u_int32_t offset, 2875 uint8_t *data_ptr, uint32_t allocation_length, 2876 uint8_t sense_len, uint32_t timeout); 2877 2878void scsi_write_buffer(struct ccb_scsiio *csio, u_int32_t retries, 2879 void (*cbfcnp)(struct cam_periph *, union ccb *), 2880 uint8_t tag_action, int mode, 2881 uint8_t buffer_id, u_int32_t offset, 2882 uint8_t *data_ptr, uint32_t param_list_length, 2883 uint8_t sense_len, uint32_t timeout); 2884 2885#define SCSI_RW_READ 0x0001 2886#define SCSI_RW_WRITE 0x0002 2887#define SCSI_RW_DIRMASK 0x0003 2888#define SCSI_RW_BIO 0x1000 2889void scsi_read_write(struct ccb_scsiio *csio, u_int32_t retries, 2890 void (*cbfcnp)(struct cam_periph *, union ccb *), 2891 u_int8_t tag_action, int readop, u_int8_t byte2, 2892 int minimum_cmd_size, u_int64_t lba, 2893 u_int32_t block_count, u_int8_t *data_ptr, 2894 u_int32_t dxfer_len, u_int8_t sense_len, 2895 u_int32_t timeout); 2896 2897void scsi_write_same(struct ccb_scsiio *csio, u_int32_t retries, 2898 void (*cbfcnp)(struct cam_periph *, union ccb *), 2899 u_int8_t tag_action, u_int8_t byte2, 2900 int minimum_cmd_size, u_int64_t lba, 2901 u_int32_t block_count, u_int8_t *data_ptr, 2902 u_int32_t dxfer_len, u_int8_t sense_len, 2903 u_int32_t timeout); 2904 2905void scsi_ata_identify(struct ccb_scsiio *csio, u_int32_t retries, 2906 void (*cbfcnp)(struct cam_periph *, union ccb *), 2907 u_int8_t tag_action, u_int8_t *data_ptr, 2908 u_int16_t dxfer_len, u_int8_t sense_len, 2909 u_int32_t timeout); 2910 2911void scsi_ata_trim(struct ccb_scsiio *csio, u_int32_t retries, 2912 void (*cbfcnp)(struct cam_periph *, union ccb *), 2913 u_int8_t tag_action, u_int16_t block_count, 2914 u_int8_t *data_ptr, u_int16_t dxfer_len, 2915 u_int8_t sense_len, u_int32_t timeout); 2916 2917void scsi_ata_pass_16(struct ccb_scsiio *csio, u_int32_t retries, 2918 void (*cbfcnp)(struct cam_periph *, union ccb *), 2919 u_int32_t flags, u_int8_t tag_action, 2920 u_int8_t protocol, u_int8_t ata_flags, u_int16_t features, 2921 u_int16_t sector_count, uint64_t lba, u_int8_t command, 2922 u_int8_t control, u_int8_t *data_ptr, u_int16_t dxfer_len, 2923 u_int8_t sense_len, u_int32_t timeout); 2924 2925void scsi_unmap(struct ccb_scsiio *csio, u_int32_t retries, 2926 void (*cbfcnp)(struct cam_periph *, union ccb *), 2927 u_int8_t tag_action, u_int8_t byte2, 2928 u_int8_t *data_ptr, u_int16_t dxfer_len, 2929 u_int8_t sense_len, u_int32_t timeout); 2930 2931void scsi_start_stop(struct ccb_scsiio *csio, u_int32_t retries, 2932 void (*cbfcnp)(struct cam_periph *, union ccb *), 2933 u_int8_t tag_action, int start, int load_eject, 2934 int immediate, u_int8_t sense_len, u_int32_t timeout); 2935 2936void scsi_persistent_reserve_in(struct ccb_scsiio *csio, uint32_t retries, 2937 void (*cbfcnp)(struct cam_periph *,union ccb *), 2938 uint8_t tag_action, int service_action, 2939 uint8_t *data_ptr, uint32_t dxfer_len, 2940 int sense_len, int timeout); 2941 2942void scsi_persistent_reserve_out(struct ccb_scsiio *csio, uint32_t retries, 2943 void (*cbfcnp)(struct cam_periph *, 2944 union ccb *), 2945 uint8_t tag_action, int service_action, 2946 int scope, int res_type, uint8_t *data_ptr, 2947 uint32_t dxfer_len, int sense_len, 2948 int timeout); 2949 2950int scsi_inquiry_match(caddr_t inqbuffer, caddr_t table_entry); 2951int scsi_static_inquiry_match(caddr_t inqbuffer, 2952 caddr_t table_entry); 2953int scsi_devid_match(uint8_t *rhs, size_t rhs_len, 2954 uint8_t *lhs, size_t lhs_len); 2955 2956void scsi_extract_sense(struct scsi_sense_data *sense, int *error_code, 2957 int *sense_key, int *asc, int *ascq); 2958int scsi_extract_sense_ccb(union ccb *ccb, int *error_code, int *sense_key, 2959 int *asc, int *ascq); 2960void scsi_extract_sense_len(struct scsi_sense_data *sense, 2961 u_int sense_len, int *error_code, int *sense_key, 2962 int *asc, int *ascq, int show_errors); 2963int scsi_get_sense_key(struct scsi_sense_data *sense, u_int sense_len, 2964 int show_errors); 2965int scsi_get_asc(struct scsi_sense_data *sense, u_int sense_len, 2966 int show_errors); 2967int scsi_get_ascq(struct scsi_sense_data *sense, u_int sense_len, 2968 int show_errors); 2969static __inline void scsi_ulto2b(u_int32_t val, u_int8_t *bytes); 2970static __inline void scsi_ulto3b(u_int32_t val, u_int8_t *bytes); 2971static __inline void scsi_ulto4b(u_int32_t val, u_int8_t *bytes); 2972static __inline void scsi_u64to8b(u_int64_t val, u_int8_t *bytes); 2973static __inline uint32_t scsi_2btoul(const uint8_t *bytes); 2974static __inline uint32_t scsi_3btoul(const uint8_t *bytes); 2975static __inline int32_t scsi_3btol(const uint8_t *bytes); 2976static __inline uint32_t scsi_4btoul(const uint8_t *bytes); 2977static __inline uint64_t scsi_8btou64(const uint8_t *bytes); 2978static __inline void *find_mode_page_6(struct scsi_mode_header_6 *mode_header); 2979static __inline void *find_mode_page_10(struct scsi_mode_header_10 *mode_header); 2980 2981static __inline void 2982scsi_ulto2b(u_int32_t val, u_int8_t *bytes) 2983{ 2984 2985 bytes[0] = (val >> 8) & 0xff; 2986 bytes[1] = val & 0xff; 2987} 2988 2989static __inline void 2990scsi_ulto3b(u_int32_t val, u_int8_t *bytes) 2991{ 2992 2993 bytes[0] = (val >> 16) & 0xff; 2994 bytes[1] = (val >> 8) & 0xff; 2995 bytes[2] = val & 0xff; 2996} 2997 2998static __inline void 2999scsi_ulto4b(u_int32_t val, u_int8_t *bytes) 3000{ 3001 3002 bytes[0] = (val >> 24) & 0xff; 3003 bytes[1] = (val >> 16) & 0xff; 3004 bytes[2] = (val >> 8) & 0xff; 3005 bytes[3] = val & 0xff; 3006} 3007 3008static __inline void 3009scsi_u64to8b(u_int64_t val, u_int8_t *bytes) 3010{ 3011 3012 bytes[0] = (val >> 56) & 0xff; 3013 bytes[1] = (val >> 48) & 0xff; 3014 bytes[2] = (val >> 40) & 0xff; 3015 bytes[3] = (val >> 32) & 0xff; 3016 bytes[4] = (val >> 24) & 0xff; 3017 bytes[5] = (val >> 16) & 0xff; 3018 bytes[6] = (val >> 8) & 0xff; 3019 bytes[7] = val & 0xff; 3020} 3021 3022static __inline uint32_t 3023scsi_2btoul(const uint8_t *bytes) 3024{ 3025 uint32_t rv; 3026 3027 rv = (bytes[0] << 8) | 3028 bytes[1]; 3029 return (rv); 3030} 3031 3032static __inline uint32_t 3033scsi_3btoul(const uint8_t *bytes) 3034{ 3035 uint32_t rv; 3036 3037 rv = (bytes[0] << 16) | 3038 (bytes[1] << 8) | 3039 bytes[2]; 3040 return (rv); 3041} 3042 3043static __inline int32_t 3044scsi_3btol(const uint8_t *bytes) 3045{ 3046 uint32_t rc = scsi_3btoul(bytes); 3047 3048 if (rc & 0x00800000) 3049 rc |= 0xff000000; 3050 3051 return (int32_t) rc; 3052} 3053 3054static __inline uint32_t 3055scsi_4btoul(const uint8_t *bytes) 3056{ 3057 uint32_t rv; 3058 3059 rv = (bytes[0] << 24) | 3060 (bytes[1] << 16) | 3061 (bytes[2] << 8) | 3062 bytes[3]; 3063 return (rv); 3064} 3065 3066static __inline uint64_t 3067scsi_8btou64(const uint8_t *bytes) 3068{ 3069 uint64_t rv; 3070 3071 rv = (((uint64_t)bytes[0]) << 56) | 3072 (((uint64_t)bytes[1]) << 48) | 3073 (((uint64_t)bytes[2]) << 40) | 3074 (((uint64_t)bytes[3]) << 32) | 3075 (((uint64_t)bytes[4]) << 24) | 3076 (((uint64_t)bytes[5]) << 16) | 3077 (((uint64_t)bytes[6]) << 8) | 3078 bytes[7]; 3079 return (rv); 3080} 3081 3082/* 3083 * Given the pointer to a returned mode sense buffer, return a pointer to 3084 * the start of the first mode page. 3085 */ 3086static __inline void * 3087find_mode_page_6(struct scsi_mode_header_6 *mode_header) 3088{ 3089 void *page_start; 3090 3091 page_start = (void *)((u_int8_t *)&mode_header[1] + 3092 mode_header->blk_desc_len); 3093 3094 return(page_start); 3095} 3096 3097static __inline void * 3098find_mode_page_10(struct scsi_mode_header_10 *mode_header) 3099{ 3100 void *page_start; 3101 3102 page_start = (void *)((u_int8_t *)&mode_header[1] + 3103 scsi_2btoul(mode_header->blk_desc_len)); 3104 3105 return(page_start); 3106} 3107 3108__END_DECLS 3109 3110#endif /*_SCSI_SCSI_ALL_H*/ 3111