sys/cam/scsi/scsi_all.h

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