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