sys/cam/scsi/scsi_all.h

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