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