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