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