sys/cam/scsi/scsi_all.h

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