sys/cam/scsi/scsi_all.h

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