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_PTPL_A             0x01
 321         uint8_t type_mask[2];
 322 #define SPRI_TM_WR_EX_AR        0x8000
 323 #define SPRI_TM_EX_AC_RO        0x4000
 324 #define SPRI_TM_WR_EX_RO        0x2000
 325 #define SPRI_TM_EX_AC           0x0800
 326 #define SPRI_TM_WR_EX           0x0200
 327 #define SPRI_TM_EX_AC_AR        0x0001
 328         uint8_t reserved[2];
 329 };
 330
 331 struct scsi_per_res_in_rsrv_data
 332 {
 333         uint8_t reservation[8];
 334         uint8_t scope_addr[4];
 335         uint8_t reserved;
 336         uint8_t scopetype;
 337 #define SPRT_WE    0x01
 338 #define SPRT_EA    0x03
 339 #define SPRT_WERO  0x05
 340 #define SPRT_EARO  0x06
 341 #define SPRT_WEAR  0x07
 342 #define SPRT_EAAR  0x08
 343         uint8_t extent_length[2];
 344 };
 345
 346 struct scsi_per_res_in_rsrv
 347 {
 348         struct scsi_per_res_in_header header;
 349         struct scsi_per_res_in_rsrv_data data;
 350 };
 351
 352 struct scsi_per_res_in_full_desc
 353 {
 354         struct scsi_per_res_key res_key;
 355         uint8_t reserved1[4];
 356         uint8_t flags;
 357 #define SPRI_FULL_ALL_TG_PT     0x02
 358 #define SPRI_FULL_R_HOLDER      0x01
 359         uint8_t scopetype;
 360         uint8_t reserved2[4];
 361         uint8_t rel_trgt_port_id[2];
 362         uint8_t additional_length[4];
 363         uint8_t transport_id[];
 364 };
 365
 366 struct scsi_per_res_in_full
 367 {
 368         struct scsi_per_res_in_header header;
 369         struct scsi_per_res_in_full_desc desc[];
 370 };
 371
 372 struct scsi_per_res_out
 373 {
 374         u_int8_t opcode;
 375         u_int8_t action;
 376 #define SPRO_REGISTER           0x00
 377 #define SPRO_RESERVE            0x01
 378 #define SPRO_RELEASE            0x02
 379 #define SPRO_CLEAR              0x03
 380 #define SPRO_PREEMPT            0x04
 381 #define SPRO_PRE_ABO            0x05
 382 #define SPRO_REG_IGNO           0x06
 383 #define SPRO_REG_MOVE           0x07
 384 #define SPRO_REPL_LOST_RES      0x08
 385 #define SPRO_ACTION_MASK        0x1f
 386         u_int8_t scope_type;
 387 #define SPR_SCOPE_MASK          0xf0
 388 #define SPR_SCOPE_SHIFT         4
 389 #define SPR_LU_SCOPE            0x00
 390 #define SPR_EXTENT_SCOPE        0x10
 391 #define SPR_ELEMENT_SCOPE       0x20
 392 #define SPR_TYPE_MASK           0x0f
 393 #define SPR_TYPE_RD_SHARED      0x00
 394 #define SPR_TYPE_WR_EX          0x01
 395 #define SPR_TYPE_RD_EX          0x02
 396 #define SPR_TYPE_EX_AC          0x03
 397 #define SPR_TYPE_SHARED         0x04
 398 #define SPR_TYPE_WR_EX_RO       0x05
 399 #define SPR_TYPE_EX_AC_RO       0x06
 400 #define SPR_TYPE_WR_EX_AR       0x07
 401 #define SPR_TYPE_EX_AC_AR       0x08
 402         u_int8_t reserved[2];
 403         u_int8_t length[4];
 404         u_int8_t control;
 405 };
 406
 407 struct scsi_per_res_out_parms
 408 {
 409         struct scsi_per_res_key res_key;
 410         u_int8_t serv_act_res_key[8];
 411         u_int8_t scope_spec_address[4];
 412         u_int8_t flags;
 413 #define SPR_SPEC_I_PT           0x08
 414 #define SPR_ALL_TG_PT           0x04
 415 #define SPR_APTPL               0x01
 416         u_int8_t reserved1;
 417         u_int8_t extent_length[2];
 418         u_int8_t transport_id_list[];
 419 };
 420
 421 struct scsi_per_res_out_trans_ids {
 422         u_int8_t additional_length[4];
 423         u_int8_t transport_ids[];
 424 };
 425
 426 /*
 427  * Used with REGISTER AND MOVE serivce action of the PERSISTENT RESERVE OUT
 428  * command.
 429  */
 430 struct scsi_per_res_reg_move
 431 {
 432         struct scsi_per_res_key res_key;
 433         u_int8_t serv_act_res_key[8];
 434         u_int8_t reserved;
 435         u_int8_t flags;
 436 #define SPR_REG_MOVE_UNREG      0x02
 437 #define SPR_REG_MOVE_APTPL      0x01
 438         u_int8_t rel_trgt_port_id[2];
 439         u_int8_t transport_id_length[4];
 440         u_int8_t transport_id[];
 441 };
 442
 443 struct scsi_transportid_header
 444 {
 445         uint8_t format_protocol;
 446 #define SCSI_TRN_FORMAT_MASK            0xc0
 447 #define SCSI_TRN_FORMAT_SHIFT           6
 448 #define SCSI_TRN_PROTO_MASK             0x0f
 449 };
 450
 451 struct scsi_transportid_fcp
 452 {
 453         uint8_t format_protocol;
 454 #define SCSI_TRN_FCP_FORMAT_DEFAULT     0x00
 455         uint8_t reserved1[7];
 456         uint8_t n_port_name[8];
 457         uint8_t reserved2[8];
 458 };
 459
 460 struct scsi_transportid_spi
 461 {
 462         uint8_t format_protocol;
 463 #define SCSI_TRN_SPI_FORMAT_DEFAULT     0x00
 464         uint8_t reserved1;
 465         uint8_t scsi_addr[2];
 466         uint8_t obsolete[2];
 467         uint8_t rel_trgt_port_id[2];
 468         uint8_t reserved2[16];
 469 };
 470
 471 struct scsi_transportid_1394
 472 {
 473         uint8_t format_protocol;
 474 #define SCSI_TRN_1394_FORMAT_DEFAULT    0x00
 475         uint8_t reserved1[7];
 476         uint8_t eui64[8];
 477         uint8_t reserved2[8];
 478 };
 479
 480 struct scsi_transportid_rdma
 481 {
 482         uint8_t format_protocol;
 483 #define SCSI_TRN_RDMA_FORMAT_DEFAULT    0x00
 484         uint8_t reserved[7];
 485 #define SCSI_TRN_RDMA_PORT_LEN          16
 486         uint8_t initiator_port_id[SCSI_TRN_RDMA_PORT_LEN];
 487 };
 488
 489 struct scsi_transportid_iscsi_device
 490 {
 491         uint8_t format_protocol;
 492 #define SCSI_TRN_ISCSI_FORMAT_DEVICE    0x00
 493         uint8_t reserved;
 494         uint8_t additional_length[2];
 495         uint8_t iscsi_name[];
 496 };
 497
 498 struct scsi_transportid_iscsi_port
 499 {
 500         uint8_t format_protocol;
 501 #define SCSI_TRN_ISCSI_FORMAT_PORT      0x40
 502         uint8_t reserved;
 503         uint8_t additional_length[2];
 504         uint8_t iscsi_name[];
 505         /*
 506          * Followed by a separator and iSCSI initiator session ID
 507          */
 508 };
 509
 510 struct scsi_transportid_sas
 511 {
 512         uint8_t format_protocol;
 513 #define SCSI_TRN_SAS_FORMAT_DEFAULT     0x00
 514         uint8_t reserved1[3];
 515         uint8_t sas_address[8];
 516         uint8_t reserved2[12];
 517 };
 518
 519 struct scsi_sop_routing_id_norm {
 520         uint8_t bus;
 521         uint8_t devfunc;
 522 #define SCSI_TRN_SOP_BUS_MAX            0xff
 523 #define SCSI_TRN_SOP_DEV_MAX            0x1f
 524 #define SCSI_TRN_SOP_DEV_MASK           0xf8
 525 #define SCSI_TRN_SOP_DEV_SHIFT          3
 526 #define SCSI_TRN_SOP_FUNC_NORM_MASK     0x07
 527 #define SCSI_TRN_SOP_FUNC_NORM_MAX      0x07
 528 };
 529
 530 struct scsi_sop_routing_id_alt {
 531         uint8_t bus;
 532         uint8_t function;
 533 #define SCSI_TRN_SOP_FUNC_ALT_MAX       0xff
 534 };
 535
 536 struct scsi_transportid_sop
 537 {
 538         uint8_t format_protocol;
 539 #define SCSI_TRN_SOP_FORMAT_DEFAULT     0x00
 540         uint8_t reserved1;
 541         uint8_t routing_id[2];
 542         uint8_t reserved2[20];
 543 };
 544
 545 struct scsi_log_sense
 546 {
 547         u_int8_t opcode;
 548         u_int8_t byte2;
 549 #define SLS_SP                          0x01
 550 #define SLS_PPC                         0x02
 551         u_int8_t page;
 552 #define SLS_PAGE_CODE                   0x3F
 553 #define SLS_ALL_PAGES_PAGE              0x00
 554 #define SLS_OVERRUN_PAGE                0x01
 555 #define SLS_ERROR_WRITE_PAGE            0x02
 556 #define SLS_ERROR_READ_PAGE             0x03
 557 #define SLS_ERROR_READREVERSE_PAGE      0x04
 558 #define SLS_ERROR_VERIFY_PAGE           0x05
 559 #define SLS_ERROR_NONMEDIUM_PAGE        0x06
 560 #define SLS_ERROR_LASTN_PAGE            0x07
 561 #define SLS_SELF_TEST_PAGE              0x10
 562 #define SLS_IE_PAGE                     0x2f
 563 #define SLS_PAGE_CTRL_MASK              0xC0
 564 #define SLS_PAGE_CTRL_THRESHOLD         0x00
 565 #define SLS_PAGE_CTRL_CUMULATIVE        0x40
 566 #define SLS_PAGE_CTRL_THRESH_DEFAULT    0x80
 567 #define SLS_PAGE_CTRL_CUMUL_DEFAULT     0xC0
 568         u_int8_t reserved[2];
 569         u_int8_t paramptr[2];
 570         u_int8_t length[2];
 571         u_int8_t control;
 572 };
 573
 574 struct scsi_log_select
 575 {
 576         u_int8_t opcode;
 577         u_int8_t byte2;
 578 /*      SLS_SP                          0x01 */
 579 #define SLS_PCR                         0x02
 580         u_int8_t page;
 581 /*      SLS_PAGE_CTRL_MASK              0xC0 */
 582 /*      SLS_PAGE_CTRL_THRESHOLD         0x00 */
 583 /*      SLS_PAGE_CTRL_CUMULATIVE        0x40 */
 584 /*      SLS_PAGE_CTRL_THRESH_DEFAULT    0x80 */
 585 /*      SLS_PAGE_CTRL_CUMUL_DEFAULT     0xC0 */
 586         u_int8_t reserved[4];
 587         u_int8_t length[2];
 588         u_int8_t control;
 589 };
 590
 591 struct scsi_log_header
 592 {
 593         u_int8_t page;
 594         u_int8_t reserved;
 595         u_int8_t datalen[2];
 596 };
 597
 598 struct scsi_log_param_header {
 599         u_int8_t param_code[2];
 600         u_int8_t param_control;
 601 #define SLP_LP                          0x01
 602 #define SLP_LBIN                        0x02
 603 #define SLP_TMC_MASK                    0x0C
 604 #define SLP_TMC_ALWAYS                  0x00
 605 #define SLP_TMC_EQUAL                   0x04
 606 #define SLP_TMC_NOTEQUAL                0x08
 607 #define SLP_TMC_GREATER                 0x0C
 608 #define SLP_ETC                         0x10
 609 #define SLP_TSD                         0x20
 610 #define SLP_DS                          0x40
 611 #define SLP_DU                          0x80
 612         u_int8_t param_len;
 613 };
 614
 615 struct scsi_control_page {
 616         u_int8_t page_code;
 617         u_int8_t page_length;
 618         u_int8_t rlec;
 619 #define SCP_RLEC                        0x01    /*Report Log Exception Cond*/
 620 #define SCP_GLTSD                       0x02    /*Global Logging target
 621                                                   save disable */
 622 #define SCP_DSENSE                      0x04    /*Descriptor Sense */
 623 #define SCP_DPICZ                       0x08    /*Disable Prot. Info Check
 624                                                   if Prot. Field is Zero */
 625 #define SCP_TMF_ONLY                    0x10    /*TM Functions Only*/
 626 #define SCP_TST_MASK                    0xE0    /*Task Set Type Mask*/
 627 #define SCP_TST_ONE                     0x00    /*One Task Set*/
 628 #define SCP_TST_SEPARATE                0x20    /*Separate Task Sets*/
 629         u_int8_t queue_flags;
 630 #define SCP_QUEUE_ALG_MASK              0xF0
 631 #define SCP_QUEUE_ALG_RESTRICTED        0x00
 632 #define SCP_QUEUE_ALG_UNRESTRICTED      0x10
 633 #define SCP_QUEUE_ERR                   0x02    /*Queued I/O aborted for CACs*/
 634 #define SCP_QUEUE_DQUE                  0x01    /*Queued I/O disabled*/
 635         u_int8_t eca_and_aen;
 636 #define SCP_EECA                        0x80    /*Enable Extended CA*/
 637 #define SCP_RAENP                       0x04    /*Ready AEN Permission*/
 638 #define SCP_UAAENP                      0x02    /*UA AEN Permission*/
 639 #define SCP_EAENP                       0x01    /*Error AEN Permission*/
 640         u_int8_t reserved;
 641         u_int8_t aen_holdoff_period[2];
 642 };
 643
 644 struct scsi_cache_page {
 645         u_int8_t page_code;
 646 #define SCHP_PAGE_SAVABLE               0x80    /* Page is savable */
 647         u_int8_t page_length;
 648         u_int8_t cache_flags;
 649 #define SCHP_FLAGS_WCE                  0x04    /* Write Cache Enable */
 650 #define SCHP_FLAGS_MF                   0x02    /* Multiplication factor */
 651 #define SCHP_FLAGS_RCD                  0x01    /* Read Cache Disable */
 652         u_int8_t rw_cache_policy;
 653         u_int8_t dis_prefetch[2];
 654         u_int8_t min_prefetch[2];
 655         u_int8_t max_prefetch[2];
 656         u_int8_t max_prefetch_ceil[2];
 657 };
 658
 659 /*
 660  * XXX KDM
 661  * Updated version of the cache page, as of SBC.  Update this to SBC-3 and
 662  * rationalize the two.
 663  */
 664 struct scsi_caching_page {
 665         uint8_t page_code;
 666 #define SMS_CACHING_PAGE                0x08
 667         uint8_t page_length;
 668         uint8_t flags1;
 669 #define SCP_IC          0x80
 670 #define SCP_ABPF        0x40
 671 #define SCP_CAP         0x20
 672 #define SCP_DISC        0x10
 673 #define SCP_SIZE        0x08
 674 #define SCP_WCE         0x04
 675 #define SCP_MF          0x02
 676 #define SCP_RCD         0x01
 677         uint8_t ret_priority;
 678         uint8_t disable_pf_transfer_len[2];
 679         uint8_t min_prefetch[2];
 680         uint8_t max_prefetch[2];
 681         uint8_t max_pf_ceiling[2];
 682         uint8_t flags2;
 683 #define SCP_FSW         0x80
 684 #define SCP_LBCSS       0x40
 685 #define SCP_DRA         0x20
 686 #define SCP_VS1         0x10
 687 #define SCP_VS2         0x08
 688         uint8_t cache_segments;
 689         uint8_t cache_seg_size[2];
 690         uint8_t reserved;
 691         uint8_t non_cache_seg_size[3];
 692 };
 693
 694 /*
 695  * XXX KDM move this off to a vendor shim.
 696  */
 697 struct copan_power_subpage {
 698         uint8_t page_code;
 699 #define PWR_PAGE_CODE           0x00
 700         uint8_t subpage;
 701 #define PWR_SUBPAGE_CODE        0x02
 702         uint8_t page_length[2];
 703         uint8_t page_version;
 704 #define PWR_VERSION                 0x01
 705         uint8_t total_luns;
 706         uint8_t max_active_luns;
 707 #define PWR_DFLT_MAX_LUNS           0x07
 708         uint8_t reserved[25];
 709 };
 710
 711 /*
 712  * XXX KDM move this off to a vendor shim.
 713  */
 714 struct copan_aps_subpage {
 715         uint8_t page_code;
 716 #define APS_PAGE_CODE           0x00
 717         uint8_t subpage;
 718 #define APS_SUBPAGE_CODE        0x03
 719         uint8_t page_length[2];
 720         uint8_t page_version;
 721 #define APS_VERSION                 0x00
 722         uint8_t lock_active;
 723 #define APS_LOCK_ACTIVE     0x01
 724 #define APS_LOCK_INACTIVE       0x00
 725         uint8_t reserved[26];
 726 };
 727
 728 /*
 729  * XXX KDM move this off to a vendor shim.
 730  */
 731 struct copan_debugconf_subpage {
 732         uint8_t page_code;
 733 #define DBGCNF_PAGE_CODE                0x00
 734         uint8_t subpage;
 735 #define DBGCNF_SUBPAGE_CODE     0xF0
 736         uint8_t page_length[2];
 737         uint8_t page_version;
 738 #define DBGCNF_VERSION                  0x00
 739         uint8_t ctl_time_io_secs[2];
 740 };
 741
 742
 743 struct scsi_info_exceptions_page {
 744         u_int8_t page_code;
 745 #define SIEP_PAGE_SAVABLE               0x80    /* Page is savable */
 746         u_int8_t page_length;
 747         u_int8_t info_flags;
 748 #define SIEP_FLAGS_PERF                 0x80
 749 #define SIEP_FLAGS_EBF                  0x20
 750 #define SIEP_FLAGS_EWASC                0x10
 751 #define SIEP_FLAGS_DEXCPT               0x08
 752 #define SIEP_FLAGS_TEST                 0x04
 753 #define SIEP_FLAGS_EBACKERR             0x02
 754 #define SIEP_FLAGS_LOGERR               0x01
 755         u_int8_t mrie;
 756         u_int8_t interval_timer[4];
 757         u_int8_t report_count[4];
 758 };
 759
 760 /*
 761  * SCSI protocol identifier values, current as of SPC4r36l.
 762  */
 763 #define SCSI_PROTO_FC           0x00    /* Fibre Channel */
 764 #define SCSI_PROTO_SPI          0x01    /* Parallel SCSI */
 765 #define SCSI_PROTO_SSA          0x02    /* Serial Storage Arch. */
 766 #define SCSI_PROTO_1394         0x03    /* IEEE 1394 (Firewire) */
 767 #define SCSI_PROTO_RDMA         0x04    /* SCSI RDMA Protocol */
 768 #define SCSI_PROTO_ISCSI        0x05    /* Internet SCSI */
 769 #define SCSI_PROTO_iSCSI        0x05    /* Internet SCSI */
 770 #define SCSI_PROTO_SAS          0x06    /* SAS Serial SCSI Protocol */
 771 #define SCSI_PROTO_ADT          0x07    /* Automation/Drive Int. Trans. Prot.*/
 772 #define SCSI_PROTO_ADITP        0x07    /* Automation/Drive Int. Trans. Prot.*/
 773 #define SCSI_PROTO_ATA          0x08    /* AT Attachment Interface */
 774 #define SCSI_PROTO_UAS          0x09    /* USB Atached SCSI */
 775 #define SCSI_PROTO_SOP          0x0a    /* SCSI over PCI Express */
 776 #define SCSI_PROTO_NONE         0x0f    /* No specific protocol */
 777
 778 struct scsi_proto_specific_page {
 779         u_int8_t page_code;
 780 #define SPSP_PAGE_SAVABLE               0x80    /* Page is savable */
 781         u_int8_t page_length;
 782         u_int8_t protocol;
 783 #define SPSP_PROTO_FC                   SCSI_PROTO_FC
 784 #define SPSP_PROTO_SPI                  SCSI_PROTO_SPI
 785 #define SPSP_PROTO_SSA                  SCSI_PROTO_SSA
 786 #define SPSP_PROTO_1394                 SCSI_PROTO_1394
 787 #define SPSP_PROTO_RDMA                 SCSI_PROTO_RDMA
 788 #define SPSP_PROTO_ISCSI                SCSI_PROTO_ISCSI
 789 #define SPSP_PROTO_SAS                  SCSI_PROTO_SAS
 790 #define SPSP_PROTO_ADT                  SCSI_PROTO_ADITP
 791 #define SPSP_PROTO_ATA                  SCSI_PROTO_ATA
 792 #define SPSP_PROTO_UAS                  SCSI_PROTO_UAS
 793 #define SPSP_PROTO_SOP                  SCSI_PROTO_SOP
 794 #define SPSP_PROTO_NONE                 SCSI_PROTO_NONE
 795 };
 796
 797 struct scsi_reserve
 798 {
 799         u_int8_t opcode;
 800         u_int8_t byte2;
 801 #define SR_EXTENT       0x01
 802 #define SR_ID_MASK      0x0e
 803 #define SR_3RDPTY       0x10
 804 #define SR_LUN_MASK     0xe0
 805         u_int8_t resv_id;
 806         u_int8_t length[2];
 807         u_int8_t control;
 808 };
 809
 810 struct scsi_reserve_10 {
 811         uint8_t opcode;
 812         uint8_t byte2;
 813 #define SR10_3RDPTY     0x10
 814 #define SR10_LONGID     0x02
 815 #define SR10_EXTENT     0x01
 816         uint8_t resv_id;
 817         uint8_t thirdparty_id;
 818         uint8_t reserved[3];
 819         uint8_t length[2];
 820         uint8_t control;
 821 };
 822
 823
 824 struct scsi_release
 825 {
 826         u_int8_t opcode;
 827         u_int8_t byte2;
 828         u_int8_t resv_id;
 829         u_int8_t unused[1];
 830         u_int8_t length;
 831         u_int8_t control;
 832 };
 833
 834 struct scsi_release_10 {
 835         uint8_t opcode;
 836         uint8_t byte2;
 837         uint8_t resv_id;
 838         uint8_t thirdparty_id;
 839         uint8_t reserved[3];
 840         uint8_t length[2];
 841         uint8_t control;
 842 };
 843
 844 struct scsi_prevent
 845 {
 846         u_int8_t opcode;
 847         u_int8_t byte2;
 848         u_int8_t unused[2];
 849         u_int8_t how;
 850         u_int8_t control;
 851 };
 852 #define PR_PREVENT 0x01
 853 #define PR_ALLOW   0x00
 854
 855 struct scsi_sync_cache
 856 {
 857         u_int8_t opcode;
 858         u_int8_t byte2;
 859 #define SSC_IMMED       0x02
 860 #define SSC_RELADR      0x01
 861         u_int8_t begin_lba[4];
 862         u_int8_t reserved;
 863         u_int8_t lb_count[2];
 864         u_int8_t control;
 865 };
 866
 867 struct scsi_sync_cache_16
 868 {
 869         uint8_t opcode;
 870         uint8_t byte2;
 871         uint8_t begin_lba[8];
 872         uint8_t lb_count[4];
 873         uint8_t reserved;
 874         uint8_t control;
 875 };
 876
 877 struct scsi_format {
 878         uint8_t opcode;
 879         uint8_t byte2;
 880 #define SF_LONGLIST             0x20
 881 #define SF_FMTDATA              0x10
 882 #define SF_CMPLIST              0x08
 883 #define SF_FORMAT_MASK          0x07
 884 #define SF_FORMAT_BLOCK         0x00
 885 #define SF_FORMAT_LONG_BLOCK    0x03
 886 #define SF_FORMAT_BFI           0x04
 887 #define SF_FORMAT_PHYS          0x05
 888         uint8_t vendor;
 889         uint8_t interleave[2];
 890         uint8_t control;
 891 };
 892
 893 struct scsi_format_header_short {
 894         uint8_t reserved;
 895 #define SF_DATA_FOV     0x80
 896 #define SF_DATA_DPRY    0x40
 897 #define SF_DATA_DCRT    0x20
 898 #define SF_DATA_STPF    0x10
 899 #define SF_DATA_IP      0x08
 900 #define SF_DATA_DSP     0x04
 901 #define SF_DATA_IMMED   0x02
 902 #define SF_DATA_VS      0x01
 903         uint8_t byte2;
 904         uint8_t defect_list_len[2];
 905 };
 906
 907 struct scsi_format_header_long {
 908         uint8_t reserved;
 909         uint8_t byte2;
 910         uint8_t reserved2[2];
 911         uint8_t defect_list_len[4];
 912 };
 913
 914 struct scsi_changedef
 915 {
 916         u_int8_t opcode;
 917         u_int8_t byte2;
 918         u_int8_t unused1;
 919         u_int8_t how;
 920         u_int8_t unused[4];
 921         u_int8_t datalen;
 922         u_int8_t control;
 923 };
 924
 925 struct scsi_read_buffer
 926 {
 927         u_int8_t opcode;
 928         u_int8_t byte2;
 929 #define RWB_MODE                0x1F
 930 #define RWB_MODE_HDR_DATA       0x00
 931 #define RWB_MODE_VENDOR         0x01
 932 #define RWB_MODE_DATA           0x02
 933 #define RWB_MODE_DESCR          0x03
 934 #define RWB_MODE_DOWNLOAD       0x04
 935 #define RWB_MODE_DOWNLOAD_SAVE  0x05
 936 #define RWB_MODE_ECHO           0x0A
 937 #define RWB_MODE_ECHO_DESCR     0x0B
 938 #define RWB_MODE_ERROR_HISTORY  0x1C
 939         u_int8_t buffer_id;
 940         u_int8_t offset[3];
 941         u_int8_t length[3];
 942         u_int8_t control;
 943 };
 944
 945 struct scsi_write_buffer
 946 {
 947         u_int8_t opcode;
 948         u_int8_t byte2;
 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_rw_6
 956 {
 957         u_int8_t opcode;
 958         u_int8_t addr[3];
 959 /* only 5 bits are valid in the MSB address byte */
 960 #define SRW_TOPADDR     0x1F
 961         u_int8_t length;
 962         u_int8_t control;
 963 };
 964
 965 struct scsi_rw_10
 966 {
 967         u_int8_t opcode;
 968 #define SRW10_RELADDR   0x01
 969 /* EBP defined for WRITE(10) only */
 970 #define SRW10_EBP       0x04
 971 #define SRW10_FUA       0x08
 972 #define SRW10_DPO       0x10
 973         u_int8_t byte2;
 974         u_int8_t addr[4];
 975         u_int8_t reserved;
 976         u_int8_t length[2];
 977         u_int8_t control;
 978 };
 979
 980 struct scsi_rw_12
 981 {
 982         u_int8_t opcode;
 983 #define SRW12_RELADDR   0x01
 984 #define SRW12_FUA       0x08
 985 #define SRW12_DPO       0x10
 986         u_int8_t byte2;
 987         u_int8_t addr[4];
 988         u_int8_t length[4];
 989         u_int8_t reserved;
 990         u_int8_t control;
 991 };
 992
 993 struct scsi_rw_16
 994 {
 995         u_int8_t opcode;
 996 #define SRW16_RELADDR   0x01
 997 #define SRW16_FUA       0x08
 998 #define SRW16_DPO       0x10
 999         u_int8_t byte2;
1000         u_int8_t addr[8];
1001         u_int8_t length[4];
1002         u_int8_t reserved;
1003         u_int8_t control;
1004 };
1005
1006 struct scsi_write_same_10
1007 {
1008         uint8_t opcode;
1009         uint8_t byte2;
1010 #define SWS_LBDATA      0x02
1011 #define SWS_PBDATA      0x04
1012 #define SWS_UNMAP       0x08
1013 #define SWS_ANCHOR      0x10
1014         uint8_t addr[4];
1015         uint8_t group;
1016         uint8_t length[2];
1017         uint8_t control;
1018 };
1019
1020 struct scsi_write_same_16
1021 {
1022         uint8_t opcode;
1023         uint8_t byte2;
1024         uint8_t addr[8];
1025         uint8_t length[4];
1026         uint8_t group;
1027         uint8_t control;
1028 };
1029
1030 struct scsi_unmap
1031 {
1032         uint8_t opcode;
1033         uint8_t byte2;
1034 #define SU_ANCHOR       0x01
1035         uint8_t reserved[4];
1036         uint8_t group;
1037         uint8_t length[2];
1038         uint8_t control;
1039 };
1040
1041 struct scsi_unmap_header
1042 {
1043         uint8_t length[2];
1044         uint8_t desc_length[2];
1045         uint8_t reserved[4];
1046 };
1047
1048 struct scsi_unmap_desc
1049 {
1050         uint8_t lba[8];
1051         uint8_t length[4];
1052         uint8_t reserved[4];
1053 };
1054
1055 struct scsi_write_verify_10
1056 {
1057         uint8_t opcode;
1058         uint8_t byte2;
1059 #define SWV_BYTCHK              0x02
1060 #define SWV_DPO                 0x10
1061 #define SWV_WRPROECT_MASK       0xe0
1062         uint8_t addr[4];
1063         uint8_t group;
1064         uint8_t length[2];
1065         uint8_t control;
1066 };
1067
1068 struct scsi_write_verify_12
1069 {
1070         uint8_t opcode;
1071         uint8_t byte2;
1072         uint8_t addr[4];
1073         uint8_t length[4];
1074         uint8_t group;
1075         uint8_t control;
1076 };
1077
1078 struct scsi_write_verify_16
1079 {
1080         uint8_t opcode;
1081         uint8_t byte2;
1082         uint8_t addr[8];
1083         uint8_t length[4];
1084         uint8_t group;
1085         uint8_t control;
1086 };
1087
1088
1089 struct scsi_start_stop_unit
1090 {
1091         u_int8_t opcode;
1092         u_int8_t byte2;
1093 #define SSS_IMMED               0x01
1094         u_int8_t reserved[2];
1095         u_int8_t how;
1096 #define SSS_START               0x01
1097 #define SSS_LOEJ                0x02
1098 #define SSS_PC_MASK             0xf0
1099 #define SSS_PC_START_VALID      0x00
1100 #define SSS_PC_ACTIVE           0x10
1101 #define SSS_PC_IDLE             0x20
1102 #define SSS_PC_STANDBY          0x30
1103 #define SSS_PC_LU_CONTROL       0x70
1104 #define SSS_PC_FORCE_IDLE_0     0xa0
1105 #define SSS_PC_FORCE_STANDBY_0  0xb0
1106         u_int8_t control;
1107 };
1108
1109 struct ata_pass_12 {
1110         u_int8_t opcode;
1111         u_int8_t protocol;
1112 #define AP_PROTO_HARD_RESET     (0x00 << 1)
1113 #define AP_PROTO_SRST           (0x01 << 1)
1114 #define AP_PROTO_NON_DATA       (0x03 << 1)
1115 #define AP_PROTO_PIO_IN         (0x04 << 1)
1116 #define AP_PROTO_PIO_OUT        (0x05 << 1)
1117 #define AP_PROTO_DMA            (0x06 << 1)
1118 #define AP_PROTO_DMA_QUEUED     (0x07 << 1)
1119 #define AP_PROTO_DEVICE_DIAG    (0x08 << 1)
1120 #define AP_PROTO_DEVICE_RESET   (0x09 << 1)
1121 #define AP_PROTO_UDMA_IN        (0x0a << 1)
1122 #define AP_PROTO_UDMA_OUT       (0x0b << 1)
1123 #define AP_PROTO_FPDMA          (0x0c << 1)
1124 #define AP_PROTO_RESP_INFO      (0x0f << 1)
1125 #define AP_MULTI        0xe0
1126         u_int8_t flags;
1127 #define AP_T_LEN        0x03
1128 #define AP_BB           0x04
1129 #define AP_T_DIR        0x08
1130 #define AP_CK_COND      0x20
1131 #define AP_OFFLINE      0x60
1132         u_int8_t features;
1133         u_int8_t sector_count;
1134         u_int8_t lba_low;
1135         u_int8_t lba_mid;
1136         u_int8_t lba_high;
1137         u_int8_t device;
1138         u_int8_t command;
1139         u_int8_t reserved;
1140         u_int8_t control;
1141 };
1142
1143 struct scsi_maintenance_in
1144 {
1145         uint8_t  opcode;
1146         uint8_t  byte2;
1147 #define SERVICE_ACTION_MASK  0x1f
1148 #define SA_RPRT_TRGT_GRP     0x0a
1149         uint8_t  reserved[4];
1150         uint8_t  length[4];
1151         uint8_t  reserved1;
1152         uint8_t  control;
1153 };
1154
1155 struct scsi_report_supported_opcodes
1156 {
1157         uint8_t  opcode;
1158         uint8_t  service_action;
1159         uint8_t  options;
1160 #define RSO_RCTD                0x80
1161 #define RSO_OPTIONS_MASK        0x07
1162 #define RSO_OPTIONS_ALL         0x00
1163 #define RSO_OPTIONS_OC          0x01
1164 #define RSO_OPTIONS_OC_SA       0x02
1165         uint8_t  requested_opcode;
1166         uint8_t  requested_service_action[2];
1167         uint8_t  length[4];
1168         uint8_t  reserved1;
1169         uint8_t  control;
1170 };
1171
1172 struct scsi_report_supported_opcodes_timeout
1173 {
1174         uint8_t  length[2];
1175         uint8_t  reserved;
1176         uint8_t  cmd_specific;
1177         uint8_t  nominal_time[4];
1178         uint8_t  recommended_time[4];
1179 };
1180
1181 struct scsi_report_supported_opcodes_descr
1182 {
1183         uint8_t  opcode;
1184         uint8_t  reserved;
1185         uint8_t  service_action[2];
1186         uint8_t  reserved2;
1187         uint8_t  flags;
1188 #define RSO_SERVACTV            0x01
1189 #define RSO_CTDP                0x02
1190         uint8_t  cdb_length[2];
1191         struct scsi_report_supported_opcodes_timeout timeout[0];
1192 };
1193
1194 struct scsi_report_supported_opcodes_all
1195 {
1196         uint8_t  length[4];
1197         struct scsi_report_supported_opcodes_descr descr[0];
1198 };
1199
1200 struct scsi_report_supported_opcodes_one
1201 {
1202         uint8_t  reserved;
1203         uint8_t  support;
1204 #define RSO_ONE_CTDP            0x80
1205         uint8_t  cdb_length[2];
1206         uint8_t  cdb_usage[];
1207 };
1208
1209 struct scsi_report_supported_tmf
1210 {
1211         uint8_t  opcode;
1212         uint8_t  service_action;
1213         uint8_t  reserved[4];
1214         uint8_t  length[4];
1215         uint8_t  reserved1;
1216         uint8_t  control;
1217 };
1218
1219 struct scsi_report_supported_tmf_data
1220 {
1221         uint8_t  byte1;
1222 #define RST_WAKES               0x01
1223 #define RST_TRS                 0x02
1224 #define RST_QTS                 0x04
1225 #define RST_LURS                0x08
1226 #define RST_CTSS                0x10
1227 #define RST_CACAS               0x20
1228 #define RST_ATSS                0x40
1229 #define RST_ATS                 0x80
1230         uint8_t  byte2;
1231 #define RST_ITNRS               0x01
1232 #define RST_QTSS                0x02
1233 #define RST_QAES                0x04
1234         uint8_t  reserved[2];
1235 };
1236
1237 struct scsi_report_timestamp
1238 {
1239         uint8_t  opcode;
1240         uint8_t  service_action;
1241         uint8_t  reserved[4];
1242         uint8_t  length[4];
1243         uint8_t  reserved1;
1244         uint8_t  control;
1245 };
1246
1247 struct scsi_report_timestamp_data
1248 {
1249         uint8_t  length[2];
1250         uint8_t  origin;
1251 #define RTS_ORIG_MASK           0x00
1252 #define RTS_ORIG_ZERO           0x00
1253 #define RTS_ORIG_SET            0x02
1254 #define RTS_ORIG_OUTSIDE        0x03
1255         uint8_t  reserved;
1256         uint8_t  timestamp[6];
1257         uint8_t  reserve2[2];
1258 };
1259
1260 struct ata_pass_16 {
1261         u_int8_t opcode;
1262         u_int8_t protocol;
1263 #define AP_EXTEND       0x01
1264         u_int8_t flags;
1265 #define AP_FLAG_TLEN_NO_DATA    (0 << 0)
1266 #define AP_FLAG_TLEN_FEAT       (1 << 0)
1267 #define AP_FLAG_TLEN_SECT_CNT   (2 << 0)
1268 #define AP_FLAG_TLEN_STPSIU     (3 << 0)
1269 #define AP_FLAG_BYT_BLOK_BYTES  (0 << 2)
1270 #define AP_FLAG_BYT_BLOK_BLOCKS (1 << 2)
1271 #define AP_FLAG_TDIR_TO_DEV     (0 << 3)
1272 #define AP_FLAG_TDIR_FROM_DEV   (1 << 3)
1273 #define AP_FLAG_CHK_COND        (1 << 5)
1274         u_int8_t features_ext;
1275         u_int8_t features;
1276         u_int8_t sector_count_ext;
1277         u_int8_t sector_count;
1278         u_int8_t lba_low_ext;
1279         u_int8_t lba_low;
1280         u_int8_t lba_mid_ext;
1281         u_int8_t lba_mid;
1282         u_int8_t lba_high_ext;
1283         u_int8_t lba_high;
1284         u_int8_t device;
1285         u_int8_t command;
1286         u_int8_t control;
1287 };
1288
1289 #define SC_SCSI_1 0x01
1290 #define SC_SCSI_2 0x03
1291
1292 /*
1293  * Opcodes
1294  */
1295
1296 #define TEST_UNIT_READY         0x00
1297 #define REQUEST_SENSE           0x03
1298 #define READ_6                  0x08
1299 #define WRITE_6                 0x0A
1300 #define INQUIRY                 0x12
1301 #define MODE_SELECT_6           0x15
1302 #define MODE_SENSE_6            0x1A
1303 #define START_STOP_UNIT         0x1B
1304 #define START_STOP              0x1B
1305 #define RESERVE                 0x16
1306 #define RELEASE                 0x17
1307 #define RECEIVE_DIAGNOSTIC      0x1C
1308 #define SEND_DIAGNOSTIC         0x1D
1309 #define PREVENT_ALLOW           0x1E
1310 #define READ_CAPACITY           0x25
1311 #define READ_10                 0x28
1312 #define WRITE_10                0x2A
1313 #define POSITION_TO_ELEMENT     0x2B
1314 #define WRITE_VERIFY_10         0x2E
1315 #define VERIFY_10               0x2F
1316 #define SYNCHRONIZE_CACHE       0x35
1317 #define READ_DEFECT_DATA_10     0x37
1318 #define WRITE_BUFFER            0x3B
1319 #define READ_BUFFER             0x3C
1320 #define CHANGE_DEFINITION       0x40
1321 #define WRITE_SAME_10           0x41
1322 #define UNMAP                   0x42
1323 #define LOG_SELECT              0x4C
1324 #define LOG_SENSE               0x4D
1325 #define MODE_SELECT_10          0x55
1326 #define RESERVE_10              0x56
1327 #define RELEASE_10              0x57
1328 #define MODE_SENSE_10           0x5A
1329 #define PERSISTENT_RES_IN       0x5E
1330 #define PERSISTENT_RES_OUT      0x5F
1331 #define ATA_PASS_16             0x85
1332 #define READ_16                 0x88
1333 #define COMPARE_AND_WRITE       0x89
1334 #define WRITE_16                0x8A
1335 #define WRITE_VERIFY_16         0x8E
1336 #define VERIFY_16               0x8F
1337 #define SYNCHRONIZE_CACHE_16    0x91
1338 #define WRITE_SAME_16           0x93
1339 #define SERVICE_ACTION_IN       0x9E
1340 #define REPORT_LUNS             0xA0
1341 #define ATA_PASS_12             0xA1
1342 #define MAINTENANCE_IN          0xA3
1343 #define MAINTENANCE_OUT         0xA4
1344 #define MOVE_MEDIUM             0xA5
1345 #define READ_12                 0xA8
1346 #define WRITE_12                0xAA
1347 #define WRITE_VERIFY_12         0xAE
1348 #define VERIFY_12               0xAF
1349 #define READ_ELEMENT_STATUS     0xB8
1350 #define READ_CD                 0xBE
1351
1352 /* Maintenance In Service Action Codes */
1353 #define REPORT_IDENTIFYING_INFRMATION           0x05
1354 #define REPORT_TARGET_PORT_GROUPS               0x0A
1355 #define REPORT_ALIASES                          0x0B
1356 #define REPORT_SUPPORTED_OPERATION_CODES        0x0C
1357 #define REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS      0x0D
1358 #define REPORT_PRIORITY                         0x0E
1359 #define REPORT_TIMESTAMP                        0x0F
1360 #define MANAGEMENT_PROTOCOL_IN                  0x10
1361 /* Maintenance Out Service Action Codes */
1362 #define SET_IDENTIFY_INFORMATION                0x06
1363 #define SET_TARGET_PORT_GROUPS                  0x0A
1364 #define CHANGE_ALIASES                          0x0B
1365 #define SET_PRIORITY                            0x0E
1366 #define SET_TIMESTAMP                           0x0F
1367 #define MANGAEMENT_PROTOCOL_OUT                 0x10
1368
1369 /*
1370  * Device Types
1371  */
1372 #define T_DIRECT        0x00
1373 #define T_SEQUENTIAL    0x01
1374 #define T_PRINTER       0x02
1375 #define T_PROCESSOR     0x03
1376 #define T_WORM          0x04
1377 #define T_CDROM         0x05
1378 #define T_SCANNER       0x06
1379 #define T_OPTICAL       0x07
1380 #define T_CHANGER       0x08
1381 #define T_COMM          0x09
1382 #define T_ASC0          0x0a
1383 #define T_ASC1          0x0b
1384 #define T_STORARRAY     0x0c
1385 #define T_ENCLOSURE     0x0d
1386 #define T_RBC           0x0e
1387 #define T_OCRW          0x0f
1388 #define T_OSD           0x11
1389 #define T_ADC           0x12
1390 #define T_NODEVICE      0x1f
1391 #define T_ANY           0xff    /* Used in Quirk table matches */
1392
1393 #define T_REMOV         1
1394 #define T_FIXED         0
1395
1396 /*
1397  * This length is the initial inquiry length used by the probe code, as
1398  * well as the length necessary for scsi_print_inquiry() to function
1399  * correctly.  If either use requires a different length in the future,
1400  * the two values should be de-coupled.
1401  */
1402 #define SHORT_INQUIRY_LENGTH    36
1403
1404 struct scsi_inquiry_data
1405 {
1406         u_int8_t device;
1407 #define SID_TYPE(inq_data) ((inq_data)->device & 0x1f)
1408 #define SID_QUAL(inq_data) (((inq_data)->device & 0xE0) >> 5)
1409 #define SID_QUAL_LU_CONNECTED   0x00    /*
1410                                          * The specified peripheral device
1411                                          * type is currently connected to
1412                                          * logical unit.  If the target cannot
1413                                          * determine whether or not a physical
1414                                          * device is currently connected, it
1415                                          * shall also use this peripheral
1416                                          * qualifier when returning the INQUIRY
1417                                          * data.  This peripheral qualifier
1418                                          * does not mean that the device is
1419                                          * ready for access by the initiator.
1420                                          */
1421 #define SID_QUAL_LU_OFFLINE     0x01    /*
1422                                          * The target is capable of supporting
1423                                          * the specified peripheral device type
1424                                          * on this logical unit; however, the
1425                                          * physical device is not currently
1426                                          * connected to this logical unit.
1427                                          */
1428 #define SID_QUAL_RSVD           0x02
1429 #define SID_QUAL_BAD_LU         0x03    /*
1430                                          * The target is not capable of
1431                                          * supporting a physical device on
1432                                          * this logical unit. For this
1433                                          * peripheral qualifier the peripheral
1434                                          * device type shall be set to 1Fh to
1435                                          * provide compatibility with previous
1436                                          * versions of SCSI. All other
1437                                          * peripheral device type values are
1438                                          * reserved for this peripheral
1439                                          * qualifier.
1440                                          */
1441 #define SID_QUAL_IS_VENDOR_UNIQUE(inq_data) ((SID_QUAL(inq_data) & 0x08) != 0)
1442         u_int8_t dev_qual2;
1443 #define SID_QUAL2       0x7F
1444 #define SID_IS_REMOVABLE(inq_data) (((inq_data)->dev_qual2 & 0x80) != 0)
1445         u_int8_t version;
1446 #define SID_ANSI_REV(inq_data) ((inq_data)->version & 0x07)
1447 #define         SCSI_REV_0              0
1448 #define         SCSI_REV_CCS            1
1449 #define         SCSI_REV_2              2
1450 #define         SCSI_REV_SPC            3
1451 #define         SCSI_REV_SPC2           4
1452 #define         SCSI_REV_SPC3           5
1453 #define         SCSI_REV_SPC4           6
1454
1455 #define SID_ECMA        0x38
1456 #define SID_ISO         0xC0
1457         u_int8_t response_format;
1458 #define SID_AENC        0x80
1459 #define SID_TrmIOP      0x40
1460 #define SID_NormACA     0x20
1461 #define SID_HiSup       0x10
1462         u_int8_t additional_length;
1463 #define SID_ADDITIONAL_LENGTH(iqd)                                      \
1464         ((iqd)->additional_length +                                     \
1465         __offsetof(struct scsi_inquiry_data, additional_length) + 1)
1466         u_int8_t spc3_flags;
1467 #define SPC3_SID_PROTECT        0x01
1468 #define SPC3_SID_3PC            0x08
1469 #define SPC3_SID_TPGS_MASK      0x30
1470 #define SPC3_SID_TPGS_IMPLICIT  0x10
1471 #define SPC3_SID_TPGS_EXPLICIT  0x20
1472 #define SPC3_SID_ACC            0x40
1473 #define SPC3_SID_SCCS           0x80
1474         u_int8_t spc2_flags;
1475 #define SPC2_SID_ADDR16         0x01
1476 #define SPC2_SID_MChngr         0x08
1477 #define SPC2_SID_MultiP         0x10
1478 #define SPC2_SID_EncServ        0x40
1479 #define SPC2_SID_BQueue         0x80
1480
1481 #define INQ_DATA_TQ_ENABLED(iqd)                                \
1482     ((SID_ANSI_REV(iqd) < SCSI_REV_SPC2)? ((iqd)->flags & SID_CmdQue) : \
1483     (((iqd)->flags & SID_CmdQue) && !((iqd)->spc2_flags & SPC2_SID_BQueue)) || \
1484     (!((iqd)->flags & SID_CmdQue) && ((iqd)->spc2_flags & SPC2_SID_BQueue)))
1485
1486         u_int8_t flags;
1487 #define SID_SftRe       0x01
1488 #define SID_CmdQue      0x02
1489 #define SID_Linked      0x08
1490 #define SID_Sync        0x10
1491 #define SID_WBus16      0x20
1492 #define SID_WBus32      0x40
1493 #define SID_RelAdr      0x80
1494 #define SID_VENDOR_SIZE   8
1495         char     vendor[SID_VENDOR_SIZE];
1496 #define SID_PRODUCT_SIZE  16
1497         char     product[SID_PRODUCT_SIZE];
1498 #define SID_REVISION_SIZE 4
1499         char     revision[SID_REVISION_SIZE];
1500         /*
1501          * The following fields were taken from SCSI Primary Commands - 2
1502          * (SPC-2) Revision 14, Dated 11 November 1999
1503          */
1504 #define SID_VENDOR_SPECIFIC_0_SIZE      20
1505         u_int8_t vendor_specific0[SID_VENDOR_SPECIFIC_0_SIZE];
1506         /*
1507          * An extension of SCSI Parallel Specific Values
1508          */
1509 #define SID_SPI_IUS             0x01
1510 #define SID_SPI_QAS             0x02
1511 #define SID_SPI_CLOCK_ST        0x00
1512 #define SID_SPI_CLOCK_DT        0x04
1513 #define SID_SPI_CLOCK_DT_ST     0x0C
1514 #define SID_SPI_MASK            0x0F
1515         u_int8_t spi3data;
1516         u_int8_t reserved2;
1517         /*
1518          * Version Descriptors, stored 2 byte values.
1519          */
1520         u_int8_t version1[2];
1521         u_int8_t version2[2];
1522         u_int8_t version3[2];
1523         u_int8_t version4[2];
1524         u_int8_t version5[2];
1525         u_int8_t version6[2];
1526         u_int8_t version7[2];
1527         u_int8_t version8[2];
1528
1529         u_int8_t reserved3[22];
1530
1531 #define SID_VENDOR_SPECIFIC_1_SIZE      160
1532         u_int8_t vendor_specific1[SID_VENDOR_SPECIFIC_1_SIZE];
1533 };
1534
1535 /*
1536  * This structure is more suited to initiator operation, because the
1537  * maximum number of supported pages is already allocated.
1538  */
1539 struct scsi_vpd_supported_page_list
1540 {
1541         u_int8_t device;
1542         u_int8_t page_code;
1543 #define SVPD_SUPPORTED_PAGE_LIST        0x00
1544 #define SVPD_SUPPORTED_PAGES_HDR_LEN    4
1545         u_int8_t reserved;
1546         u_int8_t length;        /* number of VPD entries */
1547 #define SVPD_SUPPORTED_PAGES_SIZE       251
1548         u_int8_t list[SVPD_SUPPORTED_PAGES_SIZE];
1549 };
1550
1551 /*
1552  * This structure is more suited to target operation, because the
1553  * number of supported pages is left to the user to allocate.
1554  */
1555 struct scsi_vpd_supported_pages
1556 {
1557         u_int8_t device;
1558         u_int8_t page_code;
1559         u_int8_t reserved;
1560 #define SVPD_SUPPORTED_PAGES    0x00
1561         u_int8_t length;
1562         u_int8_t page_list[0];
1563 };
1564
1565
1566 struct scsi_vpd_unit_serial_number
1567 {
1568         u_int8_t device;
1569         u_int8_t page_code;
1570 #define SVPD_UNIT_SERIAL_NUMBER 0x80
1571         u_int8_t reserved;
1572         u_int8_t length; /* serial number length */
1573 #define SVPD_SERIAL_NUM_SIZE 251
1574         u_int8_t serial_num[SVPD_SERIAL_NUM_SIZE];
1575 };
1576
1577 struct scsi_vpd_device_id
1578 {
1579         u_int8_t device;
1580         u_int8_t page_code;
1581 #define SVPD_DEVICE_ID                  0x83
1582 #define SVPD_DEVICE_ID_MAX_SIZE         252
1583 #define SVPD_DEVICE_ID_HDR_LEN \
1584     __offsetof(struct scsi_vpd_device_id, desc_list)
1585         u_int8_t length[2];
1586         u_int8_t desc_list[];
1587 };
1588
1589 struct scsi_vpd_id_descriptor
1590 {
1591         u_int8_t        proto_codeset;
1592         /*
1593          * See the SCSI_PROTO definitions above for the protocols.
1594          */
1595 #define SVPD_ID_PROTO_SHIFT     4
1596 #define SVPD_ID_CODESET_BINARY  0x01
1597 #define SVPD_ID_CODESET_ASCII   0x02
1598 #define SVPD_ID_CODESET_UTF8    0x03
1599 #define SVPD_ID_CODESET_MASK    0x0f
1600         u_int8_t        id_type;
1601 #define SVPD_ID_PIV             0x80
1602 #define SVPD_ID_ASSOC_LUN       0x00
1603 #define SVPD_ID_ASSOC_PORT      0x10
1604 #define SVPD_ID_ASSOC_TARGET    0x20
1605 #define SVPD_ID_ASSOC_MASK      0x30
1606 #define SVPD_ID_TYPE_VENDOR     0x00
1607 #define SVPD_ID_TYPE_T10        0x01
1608 #define SVPD_ID_TYPE_EUI64      0x02
1609 #define SVPD_ID_TYPE_NAA        0x03
1610 #define SVPD_ID_TYPE_RELTARG    0x04
1611 #define SVPD_ID_TYPE_TPORTGRP   0x05
1612 #define SVPD_ID_TYPE_LUNGRP     0x06
1613 #define SVPD_ID_TYPE_MD5_LUN_ID 0x07
1614 #define SVPD_ID_TYPE_SCSI_NAME  0x08
1615 #define SVPD_ID_TYPE_MASK       0x0f
1616         u_int8_t        reserved;
1617         u_int8_t        length;
1618 #define SVPD_DEVICE_ID_DESC_HDR_LEN \
1619     __offsetof(struct scsi_vpd_id_descriptor, identifier)
1620         u_int8_t        identifier[];
1621 };
1622
1623 struct scsi_vpd_id_t10
1624 {
1625         u_int8_t        vendor[8];
1626         u_int8_t        vendor_spec_id[0];
1627 };
1628
1629 struct scsi_vpd_id_eui64
1630 {
1631         u_int8_t        ieee_company_id[3];
1632         u_int8_t        extension_id[5];
1633 };
1634
1635 struct scsi_vpd_id_naa_basic
1636 {
1637         uint8_t naa;
1638         /* big endian, packed:
1639         uint8_t naa : 4;
1640         uint8_t naa_desig : 4;
1641         */
1642 #define SVPD_ID_NAA_NAA_SHIFT           4
1643 #define SVPD_ID_NAA_IEEE_EXT            0x02
1644 #define SVPD_ID_NAA_LOCAL_REG           0x03
1645 #define SVPD_ID_NAA_IEEE_REG            0x05
1646 #define SVPD_ID_NAA_IEEE_REG_EXT        0x06
1647         uint8_t naa_data[];
1648 };
1649
1650 struct scsi_vpd_id_naa_ieee_extended_id
1651 {
1652         uint8_t naa;
1653         uint8_t vendor_specific_id_a;
1654         uint8_t ieee_company_id[3];
1655         uint8_t vendor_specific_id_b[4];
1656 };
1657
1658 struct scsi_vpd_id_naa_local_reg
1659 {
1660         uint8_t naa;
1661         uint8_t local_value[7];
1662 };
1663
1664 struct scsi_vpd_id_naa_ieee_reg
1665 {
1666         uint8_t naa;
1667         uint8_t reg_value[7];
1668         /* big endian, packed:
1669         uint8_t naa_basic : 4;
1670         uint8_t ieee_company_id_0 : 4;
1671         uint8_t ieee_company_id_1[2];
1672         uint8_t ieee_company_id_2 : 4;
1673         uint8_t vendor_specific_id_0 : 4;
1674         uint8_t vendor_specific_id_1[4];
1675         */
1676 };
1677
1678 struct scsi_vpd_id_naa_ieee_reg_extended
1679 {
1680         uint8_t naa;
1681         uint8_t reg_value[15];
1682         /* big endian, packed:
1683         uint8_t naa_basic : 4;
1684         uint8_t ieee_company_id_0 : 4;
1685         uint8_t ieee_company_id_1[2];
1686         uint8_t ieee_company_id_2 : 4;
1687         uint8_t vendor_specific_id_0 : 4;
1688         uint8_t vendor_specific_id_1[4];
1689         uint8_t vendor_specific_id_ext[8];
1690         */
1691 };
1692
1693 struct scsi_vpd_id_rel_trgt_port_id
1694 {
1695         uint8_t obsolete[2];
1696         uint8_t rel_trgt_port_id[2];
1697 };
1698
1699 struct scsi_vpd_id_trgt_port_grp_id
1700 {
1701         uint8_t reserved[2];
1702         uint8_t trgt_port_grp[2];
1703 };
1704
1705 struct scsi_vpd_id_lun_grp_id
1706 {
1707         uint8_t reserved[2];
1708         uint8_t log_unit_grp[2];
1709 };
1710
1711 struct scsi_vpd_id_md5_lun_id
1712 {
1713         uint8_t lun_id[16];
1714 };
1715
1716 struct scsi_vpd_id_scsi_name
1717 {
1718         uint8_t name_string[256];
1719 };
1720
1721 struct scsi_service_action_in
1722 {
1723         uint8_t opcode;
1724         uint8_t service_action;
1725         uint8_t action_dependent[13];
1726         uint8_t control;
1727 };
1728
1729 struct scsi_diag_page {
1730         uint8_t page_code;
1731         uint8_t page_specific_flags;
1732         uint8_t length[2];
1733         uint8_t params[0];
1734 };
1735
1736 struct scsi_vpd_port_designation
1737 {
1738         uint8_t reserved[2];
1739         uint8_t relative_port_id[2];
1740         uint8_t reserved2[2];
1741         uint8_t initiator_transportid_length[2];
1742         uint8_t initiator_transportid[0];
1743 };
1744
1745 struct scsi_vpd_port_designation_cont
1746 {
1747         uint8_t reserved[2];
1748         uint8_t target_port_descriptors_length[2];
1749         struct scsi_vpd_id_descriptor target_port_descriptors[0];
1750 };
1751
1752 struct scsi_vpd_scsi_ports
1753 {
1754         u_int8_t device;
1755         u_int8_t page_code;
1756 #define SVPD_SCSI_PORTS         0x88
1757         u_int8_t page_length[2];
1758         struct scsi_vpd_port_designation design[];
1759 };
1760
1761 /*
1762  * ATA Information VPD Page based on
1763  * T10/2126-D Revision 04
1764  */
1765 #define SVPD_ATA_INFORMATION            0x89
1766
1767 /*
1768  * Block Device Characteristics VPD Page based on
1769  * T10/1799-D Revision 31
1770  */
1771 struct scsi_vpd_block_characteristics
1772 {
1773         u_int8_t device;
1774         u_int8_t page_code;
1775 #define SVPD_BDC                        0xB1
1776         u_int8_t page_length[2];
1777         u_int8_t medium_rotation_rate[2];
1778 #define SVPD_BDC_RATE_NOT_REPORTED      0x00
1779 #define SVPD_BDC_RATE_NON_ROTATING      0x01
1780         u_int8_t reserved1;
1781         u_int8_t nominal_form_factor;
1782 #define SVPD_BDC_FORM_NOT_REPORTED      0x00
1783 #define SVPD_BDC_FORM_5_25INCH          0x01
1784 #define SVPD_BDC_FORM_3_5INCH           0x02
1785 #define SVPD_BDC_FORM_2_5INCH           0x03
1786 #define SVPD_BDC_FORM_1_5INCH           0x04
1787 #define SVPD_BDC_FORM_LESSTHAN_1_5INCH  0x05
1788         u_int8_t reserved2[56];
1789 };
1790
1791 /*
1792  * Logical Block Provisioning VPD Page based on
1793  * T10/1799-D Revision 31
1794  */
1795 struct scsi_vpd_logical_block_prov
1796 {
1797         u_int8_t device;
1798         u_int8_t page_code;
1799 #define SVPD_LBP                0xB2
1800         u_int8_t page_length[2];
1801 #define SVPD_LBP_PL_BASIC       0x04
1802         u_int8_t threshold_exponent;
1803         u_int8_t flags;
1804 #define SVPD_LBP_UNMAP          0x80
1805 #define SVPD_LBP_WS16           0x40
1806 #define SVPD_LBP_WS10           0x20
1807 #define SVPD_LBP_RZ             0x04
1808 #define SVPD_LBP_ANC_SUP        0x02
1809 #define SVPD_LBP_DP             0x01
1810         u_int8_t prov_type;
1811 #define SVPD_LBP_RESOURCE       0x01
1812 #define SVPD_LBP_THIN           0x02
1813         u_int8_t reserved;
1814         /*
1815          * Provisioning Group Descriptor can be here if SVPD_LBP_DP is set
1816          * Its size can be determined from page_length - 4
1817          */
1818 };
1819
1820 /*
1821  * Block Limits VDP Page based on
1822  * T10/1799-D Revision 31
1823  */
1824 struct scsi_vpd_block_limits
1825 {
1826         u_int8_t device;
1827         u_int8_t page_code;
1828 #define SVPD_BLOCK_LIMITS       0xB0
1829         u_int8_t page_length[2];
1830 #define SVPD_BL_PL_BASIC        0x10
1831 #define SVPD_BL_PL_TP           0x3C
1832         u_int8_t reserved1;
1833         u_int8_t max_cmp_write_len;
1834         u_int8_t opt_txfer_len_grain[2];
1835         u_int8_t max_txfer_len[4];
1836         u_int8_t opt_txfer_len[4];
1837         u_int8_t max_prefetch[4];
1838         u_int8_t max_unmap_lba_cnt[4];
1839         u_int8_t max_unmap_blk_cnt[4];
1840         u_int8_t opt_unmap_grain[4];
1841         u_int8_t unmap_grain_align[4];
1842         u_int8_t max_write_same_length[8];
1843         u_int8_t reserved2[20];
1844 };
1845
1846 struct scsi_read_capacity
1847 {
1848         u_int8_t opcode;
1849         u_int8_t byte2;
1850 #define SRC_RELADR      0x01
1851         u_int8_t addr[4];
1852         u_int8_t unused[2];
1853         u_int8_t pmi;
1854 #define SRC_PMI         0x01
1855         u_int8_t control;
1856 };
1857
1858 struct scsi_read_capacity_16
1859 {
1860         uint8_t opcode;
1861 #define SRC16_SERVICE_ACTION    0x10
1862         uint8_t service_action;
1863         uint8_t addr[8];
1864         uint8_t alloc_len[4];
1865 #define SRC16_PMI               0x01
1866 #define SRC16_RELADR            0x02
1867         uint8_t reladr;
1868         uint8_t control;
1869 };
1870
1871 struct scsi_read_capacity_data
1872 {
1873         u_int8_t addr[4];
1874         u_int8_t length[4];
1875 };
1876
1877 struct scsi_read_capacity_data_long
1878 {
1879         uint8_t addr[8];
1880         uint8_t length[4];
1881 #define SRC16_PROT_EN           0x01
1882 #define SRC16_P_TYPE            0x0e
1883 #define SRC16_PTYPE_1           0x00
1884 #define SRC16_PTYPE_2           0x02
1885 #define SRC16_PTYPE_3           0x04
1886         uint8_t prot;
1887 #define SRC16_LBPPBE            0x0f
1888 #define SRC16_PI_EXPONENT       0xf0
1889 #define SRC16_PI_EXPONENT_SHIFT 4
1890         uint8_t prot_lbppbe;
1891 #define SRC16_LALBA             0x3f
1892 #define SRC16_LBPRZ             0x40
1893 #define SRC16_LBPME             0x80
1894 /*
1895  * Alternate versions of these macros that are intended for use on a 16-bit
1896  * version of the lalba_lbp field instead of the array of 2 8 bit numbers.
1897  */
1898 #define SRC16_LALBA_A           0x3fff
1899 #define SRC16_LBPRZ_A           0x4000
1900 #define SRC16_LBPME_A           0x8000
1901         uint8_t lalba_lbp[2];
1902         uint8_t reserved[16];
1903 };
1904
1905 struct scsi_report_luns
1906 {
1907         uint8_t opcode;
1908         uint8_t reserved1;
1909 #define RPL_REPORT_DEFAULT      0x00
1910 #define RPL_REPORT_WELLKNOWN    0x01
1911 #define RPL_REPORT_ALL          0x02
1912         uint8_t select_report;
1913         uint8_t reserved2[3];
1914         uint8_t length[4];
1915         uint8_t reserved3;
1916         uint8_t control;
1917 };
1918
1919 struct scsi_report_luns_lundata {
1920         uint8_t lundata[8];
1921 #define RPL_LUNDATA_PERIPH_BUS_MASK     0x3f
1922 #define RPL_LUNDATA_FLAT_LUN_MASK       0x3f
1923 #define RPL_LUNDATA_FLAT_LUN_BITS       0x06
1924 #define RPL_LUNDATA_LUN_TARG_MASK       0x3f
1925 #define RPL_LUNDATA_LUN_BUS_MASK        0xe0
1926 #define RPL_LUNDATA_LUN_LUN_MASK        0x1f
1927 #define RPL_LUNDATA_EXT_LEN_MASK        0x30
1928 #define RPL_LUNDATA_EXT_EAM_MASK        0x0f
1929 #define RPL_LUNDATA_EXT_EAM_WK          0x01
1930 #define RPL_LUNDATA_EXT_EAM_NOT_SPEC    0x0f
1931 #define RPL_LUNDATA_ATYP_MASK   0xc0    /* MBZ for type 0 lun */
1932 #define RPL_LUNDATA_ATYP_PERIPH 0x00
1933 #define RPL_LUNDATA_ATYP_FLAT   0x40
1934 #define RPL_LUNDATA_ATYP_LUN    0x80
1935 #define RPL_LUNDATA_ATYP_EXTLUN 0xc0
1936 };
1937
1938 struct scsi_report_luns_data {
1939         u_int8_t length[4];     /* length of LUN inventory, in bytes */
1940         u_int8_t reserved[4];   /* unused */
1941         /*
1942          * LUN inventory- we only support the type zero form for now.
1943          */
1944         struct scsi_report_luns_lundata luns[0];
1945 };
1946
1947 struct scsi_target_group
1948 {
1949         uint8_t opcode;
1950         uint8_t service_action;
1951 #define STG_PDF_MASK            0xe0
1952 #define STG_PDF_LENGTH          0x00
1953 #define STG_PDF_EXTENDED        0x20
1954         uint8_t reserved1[4];
1955         uint8_t length[4];
1956         uint8_t reserved2;
1957         uint8_t control;
1958 };
1959
1960 struct scsi_target_port_descriptor {
1961         uint8_t reserved[2];
1962         uint8_t relative_target_port_identifier[2];
1963         uint8_t desc_list[];
1964 };
1965
1966 struct scsi_target_port_group_descriptor {
1967         uint8_t pref_state;
1968 #define TPG_PRIMARY                             0x80
1969 #define TPG_ASYMMETRIC_ACCESS_STATE_MASK        0xf
1970 #define TPG_ASYMMETRIC_ACCESS_OPTIMIZED         0x0
1971 #define TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED      0x1
1972 #define TPG_ASYMMETRIC_ACCESS_STANDBY           0x2
1973 #define TPG_ASYMMETRIC_ACCESS_UNAVAILABLE       0x3
1974 #define TPG_ASYMMETRIC_ACCESS_LBA_DEPENDENT     0x4
1975 #define TPG_ASYMMETRIC_ACCESS_OFFLINE           0xE
1976 #define TPG_ASYMMETRIC_ACCESS_TRANSITIONING     0xF
1977         uint8_t support;
1978 #define TPG_AO_SUP      0x01
1979 #define TPG_AN_SUP      0x02
1980 #define TPG_S_SUP       0x04
1981 #define TPG_U_SUP       0x08
1982 #define TPG_LBD_SUP     0x10
1983 #define TPG_O_SUP       0x40
1984 #define TPG_T_SUP       0x80
1985         uint8_t target_port_group[2];
1986         uint8_t reserved;
1987         uint8_t status;
1988 #define TPG_UNAVLBL      0
1989 #define TPG_SET_BY_STPG  0x01
1990 #define TPG_IMPLICIT     0x02
1991         uint8_t vendor_specific;
1992         uint8_t target_port_count;
1993         struct scsi_target_port_descriptor descriptors[];
1994 };
1995
1996 struct scsi_target_group_data {
1997         uint8_t length[4];      /* length of returned data, in bytes */
1998         struct scsi_target_port_group_descriptor groups[];
1999 };
2000
2001 struct scsi_target_group_data_extended {
2002         uint8_t length[4];      /* length of returned data, in bytes */
2003         uint8_t format_type;    /* STG_PDF_LENGTH or STG_PDF_EXTENDED */
2004         uint8_t implicit_transition_time;
2005         uint8_t reserved[2];
2006         struct scsi_target_port_group_descriptor groups[];
2007 };
2008
2009
2010 typedef enum {
2011         SSD_TYPE_NONE,
2012         SSD_TYPE_FIXED,
2013         SSD_TYPE_DESC
2014 } scsi_sense_data_type;
2015
2016 typedef enum {
2017         SSD_ELEM_NONE,
2018         SSD_ELEM_SKIP,
2019         SSD_ELEM_DESC,
2020         SSD_ELEM_SKS,
2021         SSD_ELEM_COMMAND,
2022         SSD_ELEM_INFO,
2023         SSD_ELEM_FRU,
2024         SSD_ELEM_STREAM,
2025         SSD_ELEM_MAX
2026 } scsi_sense_elem_type;
2027
2028
2029 struct scsi_sense_data
2030 {
2031         uint8_t error_code;
2032         /*
2033          * SPC-4 says that the maximum length of sense data is 252 bytes.
2034          * So this structure is exactly 252 bytes log.
2035          */
2036 #define SSD_FULL_SIZE 252
2037         uint8_t sense_buf[SSD_FULL_SIZE - 1];
2038         /*
2039          * XXX KDM is this still a reasonable minimum size?
2040          */
2041 #define SSD_MIN_SIZE 18
2042         /*
2043          * Maximum value for the extra_len field in the sense data.
2044          */
2045 #define SSD_EXTRA_MAX 244
2046 };
2047
2048 /*
2049  * Fixed format sense data.
2050  */
2051 struct scsi_sense_data_fixed
2052 {
2053         u_int8_t error_code;
2054 #define SSD_ERRCODE                     0x7F
2055 #define         SSD_CURRENT_ERROR       0x70
2056 #define         SSD_DEFERRED_ERROR      0x71
2057 #define SSD_ERRCODE_VALID       0x80
2058         u_int8_t segment;
2059         u_int8_t flags;
2060 #define SSD_KEY                         0x0F
2061 #define         SSD_KEY_NO_SENSE        0x00
2062 #define         SSD_KEY_RECOVERED_ERROR 0x01
2063 #define         SSD_KEY_NOT_READY       0x02
2064 #define         SSD_KEY_MEDIUM_ERROR    0x03
2065 #define         SSD_KEY_HARDWARE_ERROR  0x04
2066 #define         SSD_KEY_ILLEGAL_REQUEST 0x05
2067 #define         SSD_KEY_UNIT_ATTENTION  0x06
2068 #define         SSD_KEY_DATA_PROTECT    0x07
2069 #define         SSD_KEY_BLANK_CHECK     0x08
2070 #define         SSD_KEY_Vendor_Specific 0x09
2071 #define         SSD_KEY_COPY_ABORTED    0x0a
2072 #define         SSD_KEY_ABORTED_COMMAND 0x0b
2073 #define         SSD_KEY_EQUAL           0x0c
2074 #define         SSD_KEY_VOLUME_OVERFLOW 0x0d
2075 #define         SSD_KEY_MISCOMPARE      0x0e
2076 #define         SSD_KEY_COMPLETED       0x0f
2077 #define SSD_ILI         0x20
2078 #define SSD_EOM         0x40
2079 #define SSD_FILEMARK    0x80
2080         u_int8_t info[4];
2081         u_int8_t extra_len;
2082         u_int8_t cmd_spec_info[4];
2083         u_int8_t add_sense_code;
2084         u_int8_t add_sense_code_qual;
2085         u_int8_t fru;
2086         u_int8_t sense_key_spec[3];
2087 #define SSD_SCS_VALID           0x80
2088 #define SSD_FIELDPTR_CMD        0x40
2089 #define SSD_BITPTR_VALID        0x08
2090 #define SSD_BITPTR_VALUE        0x07
2091         u_int8_t extra_bytes[14];
2092 #define SSD_FIXED_IS_PRESENT(sense, length, field)                      \
2093         ((length >= (offsetof(struct scsi_sense_data_fixed, field) +    \
2094         sizeof(sense->field))) ? 1 :0)
2095 #define SSD_FIXED_IS_FILLED(sense, field)                               \
2096         ((((offsetof(struct scsi_sense_data_fixed, field) +             \
2097         sizeof(sense->field)) -                                         \
2098         (offsetof(struct scsi_sense_data_fixed, extra_len) +            \
2099         sizeof(sense->extra_len))) <= sense->extra_len) ? 1 : 0)
2100 };
2101
2102 /*
2103  * Descriptor format sense data definitions.
2104  * Introduced in SPC-3.
2105  */
2106 struct scsi_sense_data_desc
2107 {
2108         uint8_t error_code;
2109 #define SSD_DESC_CURRENT_ERROR  0x72
2110 #define SSD_DESC_DEFERRED_ERROR 0x73
2111         uint8_t sense_key;
2112         uint8_t add_sense_code;
2113         uint8_t add_sense_code_qual;
2114         uint8_t reserved[3];
2115         /*
2116          * Note that SPC-4, section 4.5.2.1 says that the extra_len field
2117          * must be less than or equal to 244.
2118          */
2119         uint8_t extra_len;
2120         uint8_t sense_desc[0];
2121 #define SSD_DESC_IS_PRESENT(sense, length, field)                       \
2122         ((length >= (offsetof(struct scsi_sense_data_desc, field) +     \
2123         sizeof(sense->field))) ? 1 :0)
2124 };
2125
2126 struct scsi_sense_desc_header
2127 {
2128         uint8_t desc_type;
2129         uint8_t length;
2130 };
2131 /*
2132  * The information provide in the Information descriptor is device type or
2133  * command specific information, and defined in a command standard.
2134  *
2135  * Note that any changes to the field names or positions in this structure,
2136  * even reserved fields, should be accompanied by an examination of the
2137  * code in ctl_set_sense() that uses them.
2138  *
2139  * Maximum descriptors allowed: 1 (as of SPC-4)
2140  */
2141 struct scsi_sense_info
2142 {
2143         uint8_t desc_type;
2144 #define SSD_DESC_INFO   0x00
2145         uint8_t length;
2146         uint8_t byte2;
2147 #define SSD_INFO_VALID  0x80
2148         uint8_t reserved;
2149         uint8_t info[8];
2150 };
2151
2152 /*
2153  * Command-specific information depends on the command for which the
2154  * reported condition occured.
2155  *
2156  * Note that any changes to the field names or positions in this structure,
2157  * even reserved fields, should be accompanied by an examination of the
2158  * code in ctl_set_sense() that uses them.
2159  *
2160  * Maximum descriptors allowed: 1 (as of SPC-4)
2161  */
2162 struct scsi_sense_command
2163 {
2164         uint8_t desc_type;
2165 #define SSD_DESC_COMMAND        0x01
2166         uint8_t length;
2167         uint8_t reserved[2];
2168         uint8_t command_info[8];
2169 };
2170
2171 /*
2172  * Sense key specific descriptor.  The sense key specific data format
2173  * depends on the sense key in question.
2174  *
2175  * Maximum descriptors allowed: 1 (as of SPC-4)
2176  */
2177 struct scsi_sense_sks
2178 {
2179         uint8_t desc_type;
2180 #define SSD_DESC_SKS            0x02
2181         uint8_t length;
2182         uint8_t reserved1[2];
2183         uint8_t sense_key_spec[3];
2184 #define SSD_SKS_VALID           0x80
2185         uint8_t reserved2;
2186 };
2187
2188 /*
2189  * This is used for the Illegal Request sense key (0x05) only.
2190  */
2191 struct scsi_sense_sks_field
2192 {
2193         uint8_t byte0;
2194 #define SSD_SKS_FIELD_VALID     0x80
2195 #define SSD_SKS_FIELD_CMD       0x40
2196 #define SSD_SKS_BPV             0x08
2197 #define SSD_SKS_BIT_VALUE       0x07
2198         uint8_t field[2];
2199 };
2200
2201
2202 /*
2203  * This is used for the Hardware Error (0x04), Medium Error (0x03) and
2204  * Recovered Error (0x01) sense keys.
2205  */
2206 struct scsi_sense_sks_retry
2207 {
2208         uint8_t byte0;
2209 #define SSD_SKS_RETRY_VALID     0x80
2210         uint8_t actual_retry_count[2];
2211 };
2212
2213 /*
2214  * Used with the NO Sense (0x00) or Not Ready (0x02) sense keys.
2215  */
2216 struct scsi_sense_sks_progress
2217 {
2218         uint8_t byte0;
2219 #define SSD_SKS_PROGRESS_VALID  0x80
2220         uint8_t progress[2];
2221 #define SSD_SKS_PROGRESS_DENOM  0x10000
2222 };
2223
2224 /*
2225  * Used with the Copy Aborted (0x0a) sense key.
2226  */
2227 struct scsi_sense_sks_segment
2228 {
2229         uint8_t byte0;
2230 #define SSD_SKS_SEGMENT_VALID   0x80
2231 #define SSD_SKS_SEGMENT_SD      0x20
2232 #define SSD_SKS_SEGMENT_BPV     0x08
2233 #define SSD_SKS_SEGMENT_BITPTR  0x07
2234         uint8_t field[2];
2235 };
2236
2237 /*
2238  * Used with the Unit Attention (0x06) sense key.
2239  *
2240  * This is currently used to indicate that the unit attention condition
2241  * queue has overflowed (when the overflow bit is set).
2242  */
2243 struct scsi_sense_sks_overflow
2244 {
2245         uint8_t byte0;
2246 #define SSD_SKS_OVERFLOW_VALID  0x80
2247 #define SSD_SKS_OVERFLOW_SET    0x01
2248         uint8_t reserved[2];
2249 };
2250
2251 /*
2252  * This specifies which component is associated with the sense data.  There
2253  * is no standard meaning for the fru value.
2254  *
2255  * Maximum descriptors allowed: 1 (as of SPC-4)
2256  */
2257 struct scsi_sense_fru
2258 {
2259         uint8_t desc_type;
2260 #define SSD_DESC_FRU            0x03
2261         uint8_t length;
2262         uint8_t reserved;
2263         uint8_t fru;
2264 };
2265
2266 /*
2267  * Used for Stream commands, defined in SSC-4.
2268  *
2269  * Maximum descriptors allowed: 1 (as of SPC-4)
2270  */
2271
2272 struct scsi_sense_stream
2273 {
2274         uint8_t desc_type;
2275 #define SSD_DESC_STREAM         0x04
2276         uint8_t length;
2277         uint8_t reserved;
2278         uint8_t byte3;
2279 #define SSD_DESC_STREAM_FM      0x80
2280 #define SSD_DESC_STREAM_EOM     0x40
2281 #define SSD_DESC_STREAM_ILI     0x20
2282 };
2283
2284 /*
2285  * Used for Block commands, defined in SBC-3.
2286  *
2287  * This is currently (as of SBC-3) only used for the Incorrect Length
2288  * Indication (ILI) bit, which says that the data length requested in the
2289  * READ LONG or WRITE LONG command did not match the length of the logical
2290  * block.
2291  *
2292  * Maximum descriptors allowed: 1 (as of SPC-4)
2293  */
2294 struct scsi_sense_block
2295 {
2296         uint8_t desc_type;
2297 #define SSD_DESC_BLOCK          0x05
2298         uint8_t length;
2299         uint8_t reserved;
2300         uint8_t byte3;
2301 #define SSD_DESC_BLOCK_ILI      0x20
2302 };
2303
2304 /*
2305  * Used for Object-Based Storage Devices (OSD-3).
2306  *
2307  * Maximum descriptors allowed: 1 (as of SPC-4)
2308  */
2309 struct scsi_sense_osd_objid
2310 {
2311         uint8_t desc_type;
2312 #define SSD_DESC_OSD_OBJID      0x06
2313         uint8_t length;
2314         uint8_t reserved[6];
2315         /*
2316          * XXX KDM provide the bit definitions here?  There are a lot of
2317          * them, and we don't have an OSD driver yet.
2318          */
2319         uint8_t not_init_cmds[4];
2320         uint8_t completed_cmds[4];
2321         uint8_t partition_id[8];
2322         uint8_t object_id[8];
2323 };
2324
2325 /*
2326  * Used for Object-Based Storage Devices (OSD-3).
2327  *
2328  * Maximum descriptors allowed: 1 (as of SPC-4)
2329  */
2330 struct scsi_sense_osd_integrity
2331 {
2332         uint8_t desc_type;
2333 #define SSD_DESC_OSD_INTEGRITY  0x07
2334         uint8_t length;
2335         uint8_t integ_check_val[32];
2336 };
2337
2338 /*
2339  * Used for Object-Based Storage Devices (OSD-3).
2340  *
2341  * Maximum descriptors allowed: 1 (as of SPC-4)
2342  */
2343 struct scsi_sense_osd_attr_id
2344 {
2345         uint8_t desc_type;
2346 #define SSD_DESC_OSD_ATTR_ID    0x08
2347         uint8_t length;
2348         uint8_t reserved[2];
2349         uint8_t attr_desc[0];
2350 };
2351
2352 /*
2353  * Used with Sense keys No Sense (0x00) and Not Ready (0x02).
2354  *
2355  * Maximum descriptors allowed: 32 (as of SPC-4)
2356  */
2357 struct scsi_sense_progress
2358 {
2359         uint8_t desc_type;
2360 #define SSD_DESC_PROGRESS       0x0a
2361         uint8_t length;
2362         uint8_t sense_key;
2363         uint8_t add_sense_code;
2364         uint8_t add_sense_code_qual;
2365         uint8_t reserved;
2366         uint8_t progress[2];
2367 };
2368
2369 /*
2370  * This is typically forwarded as the result of an EXTENDED COPY command.
2371  *
2372  * Maximum descriptors allowed: 2 (as of SPC-4)
2373  */
2374 struct scsi_sense_forwarded
2375 {
2376         uint8_t desc_type;
2377 #define SSD_DESC_FORWARDED      0x0c
2378         uint8_t length;
2379         uint8_t byte2;
2380 #define SSD_FORWARDED_FSDT      0x80
2381 #define SSD_FORWARDED_SDS_MASK  0x0f
2382 #define SSD_FORWARDED_SDS_UNK   0x00
2383 #define SSD_FORWARDED_SDS_EXSRC 0x01
2384 #define SSD_FORWARDED_SDS_EXDST 0x02
2385 };
2386
2387 /*
2388  * Vendor-specific sense descriptor.  The desc_type field will be in the
2389  * range bewteen MIN and MAX inclusive.
2390  */
2391 struct scsi_sense_vendor
2392 {
2393         uint8_t desc_type;
2394 #define SSD_DESC_VENDOR_MIN     0x80
2395 #define SSD_DESC_VENDOR_MAX     0xff
2396         uint8_t length;
2397         uint8_t data[0];
2398 };
2399
2400 struct scsi_mode_header_6
2401 {
2402         u_int8_t data_length;   /* Sense data length */
2403         u_int8_t medium_type;
2404         u_int8_t dev_spec;
2405         u_int8_t blk_desc_len;
2406 };
2407
2408 struct scsi_mode_header_10
2409 {
2410         u_int8_t data_length[2];/* Sense data length */
2411         u_int8_t medium_type;
2412         u_int8_t dev_spec;
2413         u_int8_t unused[2];
2414         u_int8_t blk_desc_len[2];
2415 };
2416
2417 struct scsi_mode_page_header
2418 {
2419         u_int8_t page_code;
2420 #define SMPH_PS         0x80
2421 #define SMPH_SPF        0x40
2422 #define SMPH_PC_MASK    0x3f
2423         u_int8_t page_length;
2424 };
2425
2426 struct scsi_mode_page_header_sp
2427 {
2428         uint8_t page_code;
2429         uint8_t subpage;
2430         uint8_t page_length[2];
2431 };
2432
2433
2434 struct scsi_mode_blk_desc
2435 {
2436         u_int8_t density;
2437         u_int8_t nblocks[3];
2438         u_int8_t reserved;
2439         u_int8_t blklen[3];
2440 };
2441
2442 #define SCSI_DEFAULT_DENSITY    0x00    /* use 'default' density */
2443 #define SCSI_SAME_DENSITY       0x7f    /* use 'same' density- >= SCSI-2 only */
2444
2445
2446 /*
2447  * Status Byte
2448  */
2449 #define SCSI_STATUS_OK                  0x00
2450 #define SCSI_STATUS_CHECK_COND          0x02
2451 #define SCSI_STATUS_COND_MET            0x04
2452 #define SCSI_STATUS_BUSY                0x08
2453 #define SCSI_STATUS_INTERMED            0x10
2454 #define SCSI_STATUS_INTERMED_COND_MET   0x14
2455 #define SCSI_STATUS_RESERV_CONFLICT     0x18
2456 #define SCSI_STATUS_CMD_TERMINATED      0x22    /* Obsolete in SAM-2 */
2457 #define SCSI_STATUS_QUEUE_FULL          0x28
2458 #define SCSI_STATUS_ACA_ACTIVE          0x30
2459 #define SCSI_STATUS_TASK_ABORTED        0x40
2460
2461 struct scsi_inquiry_pattern {
2462         u_int8_t   type;
2463         u_int8_t   media_type;
2464 #define SIP_MEDIA_REMOVABLE     0x01
2465 #define SIP_MEDIA_FIXED         0x02
2466         const char *vendor;
2467         const char *product;
2468         const char *revision;
2469 };
2470
2471 struct scsi_static_inquiry_pattern {
2472         u_int8_t   type;
2473         u_int8_t   media_type;
2474         char       vendor[SID_VENDOR_SIZE+1];
2475         char       product[SID_PRODUCT_SIZE+1];
2476         char       revision[SID_REVISION_SIZE+1];
2477 };
2478
2479 struct scsi_sense_quirk_entry {
2480         struct scsi_inquiry_pattern     inq_pat;
2481         int                             num_sense_keys;
2482         int                             num_ascs;
2483         struct sense_key_table_entry    *sense_key_info;
2484         struct asc_table_entry          *asc_info;
2485 };
2486
2487 struct sense_key_table_entry {
2488         u_int8_t    sense_key;
2489         u_int32_t   action;
2490         const char *desc;
2491 };
2492
2493 struct asc_table_entry {
2494         u_int8_t    asc;
2495         u_int8_t    ascq;
2496         u_int32_t   action;
2497         const char *desc;
2498 };
2499
2500 struct op_table_entry {
2501         u_int8_t    opcode;
2502         u_int32_t   opmask;
2503         const char  *desc;
2504 };
2505
2506 struct scsi_op_quirk_entry {
2507         struct scsi_inquiry_pattern     inq_pat;
2508         int                             num_ops;
2509         struct op_table_entry           *op_table;
2510 };
2511
2512 typedef enum {
2513         SSS_FLAG_NONE           = 0x00,
2514         SSS_FLAG_PRINT_COMMAND  = 0x01
2515 } scsi_sense_string_flags;
2516
2517 struct scsi_nv {
2518         const char *name;
2519         uint64_t value;
2520 };
2521
2522 typedef enum {
2523         SCSI_NV_FOUND,
2524         SCSI_NV_AMBIGUOUS,
2525         SCSI_NV_NOT_FOUND
2526 } scsi_nv_status;
2527
2528 typedef enum {
2529         SCSI_NV_FLAG_NONE       = 0x00,
2530         SCSI_NV_FLAG_IG_CASE    = 0x01  /* Case insensitive comparison */
2531 } scsi_nv_flags;
2532
2533 struct ccb_scsiio;
2534 struct cam_periph;
2535 union  ccb;
2536 #ifndef _KERNEL
2537 struct cam_device;
2538 #endif
2539
2540 extern const char *scsi_sense_key_text[];
2541
2542 struct sbuf;
2543
2544 __BEGIN_DECLS
2545 void scsi_sense_desc(int sense_key, int asc, int ascq,
2546                      struct scsi_inquiry_data *inq_data,
2547                      const char **sense_key_desc, const char **asc_desc);
2548 scsi_sense_action scsi_error_action(struct ccb_scsiio* csio,
2549                                     struct scsi_inquiry_data *inq_data,
2550                                     u_int32_t sense_flags);
2551 const char *    scsi_status_string(struct ccb_scsiio *csio);
2552
2553 void scsi_desc_iterate(struct scsi_sense_data_desc *sense, u_int sense_len,
2554                        int (*iter_func)(struct scsi_sense_data_desc *sense,
2555                                         u_int, struct scsi_sense_desc_header *,
2556                                         void *), void *arg);
2557 uint8_t *scsi_find_desc(struct scsi_sense_data_desc *sense, u_int sense_len,
2558                         uint8_t desc_type);
2559 void scsi_set_sense_data(struct scsi_sense_data *sense_data,
2560                          scsi_sense_data_type sense_format, int current_error,
2561                          int sense_key, int asc, int ascq, ...) ;
2562 void scsi_set_sense_data_va(struct scsi_sense_data *sense_data,
2563                             scsi_sense_data_type sense_format,
2564                             int current_error, int sense_key, int asc,
2565                             int ascq, va_list ap);
2566 int scsi_get_sense_info(struct scsi_sense_data *sense_data, u_int sense_len,
2567                         uint8_t info_type, uint64_t *info,
2568                         int64_t *signed_info);
2569 int scsi_get_sks(struct scsi_sense_data *sense_data, u_int sense_len,
2570                  uint8_t *sks);
2571 int scsi_get_block_info(struct scsi_sense_data *sense_data, u_int sense_len,
2572                         struct scsi_inquiry_data *inq_data,
2573                         uint8_t *block_bits);
2574 int scsi_get_stream_info(struct scsi_sense_data *sense_data, u_int sense_len,
2575                          struct scsi_inquiry_data *inq_data,
2576                          uint8_t *stream_bits);
2577 void scsi_info_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len,
2578                     struct scsi_inquiry_data *inq_data, uint64_t info);
2579 void scsi_command_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len,
2580                        struct scsi_inquiry_data *inq_data, uint64_t csi);
2581 void scsi_progress_sbuf(struct sbuf *sb, uint16_t progress);
2582 int scsi_sks_sbuf(struct sbuf *sb, int sense_key, uint8_t *sks);
2583 void scsi_fru_sbuf(struct sbuf *sb, uint64_t fru);
2584 void scsi_stream_sbuf(struct sbuf *sb, uint8_t stream_bits, uint64_t info);
2585 void scsi_block_sbuf(struct sbuf *sb, uint8_t block_bits, uint64_t info);
2586 void scsi_sense_info_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2587                           u_int sense_len, uint8_t *cdb, int cdb_len,
2588                           struct scsi_inquiry_data *inq_data,
2589                           struct scsi_sense_desc_header *header);
2590
2591 void scsi_sense_command_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2592                              u_int sense_len, uint8_t *cdb, int cdb_len,
2593                              struct scsi_inquiry_data *inq_data,
2594                              struct scsi_sense_desc_header *header);
2595 void scsi_sense_sks_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2596                          u_int sense_len, uint8_t *cdb, int cdb_len,
2597                          struct scsi_inquiry_data *inq_data,
2598                          struct scsi_sense_desc_header *header);
2599 void scsi_sense_fru_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2600                          u_int sense_len, uint8_t *cdb, int cdb_len,
2601                          struct scsi_inquiry_data *inq_data,
2602                          struct scsi_sense_desc_header *header);
2603 void scsi_sense_stream_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2604                             u_int sense_len, uint8_t *cdb, int cdb_len,
2605                             struct scsi_inquiry_data *inq_data,
2606                             struct scsi_sense_desc_header *header);
2607 void scsi_sense_block_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2608                            u_int sense_len, uint8_t *cdb, int cdb_len,
2609                            struct scsi_inquiry_data *inq_data,
2610                            struct scsi_sense_desc_header *header);
2611 void scsi_sense_progress_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2612                               u_int sense_len, uint8_t *cdb, int cdb_len,
2613                               struct scsi_inquiry_data *inq_data,
2614                               struct scsi_sense_desc_header *header);
2615 void scsi_sense_generic_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2616                              u_int sense_len, uint8_t *cdb, int cdb_len,
2617                              struct scsi_inquiry_data *inq_data,
2618                              struct scsi_sense_desc_header *header);
2619 void scsi_sense_desc_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2620                           u_int sense_len, uint8_t *cdb, int cdb_len,
2621                           struct scsi_inquiry_data *inq_data,
2622                           struct scsi_sense_desc_header *header);
2623 scsi_sense_data_type scsi_sense_type(struct scsi_sense_data *sense_data);
2624
2625 void scsi_sense_only_sbuf(struct scsi_sense_data *sense, u_int sense_len,
2626                           struct sbuf *sb, char *path_str,
2627                           struct scsi_inquiry_data *inq_data, uint8_t *cdb,
2628                           int cdb_len);
2629
2630 #ifdef _KERNEL
2631 int             scsi_command_string(struct ccb_scsiio *csio, struct sbuf *sb);
2632 int             scsi_sense_sbuf(struct ccb_scsiio *csio, struct sbuf *sb,
2633                                 scsi_sense_string_flags flags);
2634 char *          scsi_sense_string(struct ccb_scsiio *csio,
2635                                   char *str, int str_len);
2636 void            scsi_sense_print(struct ccb_scsiio *csio);
2637 int             scsi_vpd_supported_page(struct cam_periph *periph,
2638                                         uint8_t page_id);
2639 #else /* _KERNEL */
2640 int             scsi_command_string(struct cam_device *device,
2641                                     struct ccb_scsiio *csio, struct sbuf *sb);
2642 int             scsi_sense_sbuf(struct cam_device *device,
2643                                 struct ccb_scsiio *csio, struct sbuf *sb,
2644                                 scsi_sense_string_flags flags);
2645 char *          scsi_sense_string(struct cam_device *device,
2646                                   struct ccb_scsiio *csio,
2647                                   char *str, int str_len);
2648 void            scsi_sense_print(struct cam_device *device,
2649                                  struct ccb_scsiio *csio, FILE *ofile);
2650 #endif /* _KERNEL */
2651
2652 const char *    scsi_op_desc(u_int16_t opcode,
2653                              struct scsi_inquiry_data *inq_data);
2654 char *          scsi_cdb_string(u_int8_t *cdb_ptr, char *cdb_string,
2655                                 size_t len);
2656
2657 void            scsi_print_inquiry(struct scsi_inquiry_data *inq_data);
2658 void            scsi_print_inquiry_short(struct scsi_inquiry_data *inq_data);
2659
2660 u_int           scsi_calc_syncsrate(u_int period_factor);
2661 u_int           scsi_calc_syncparam(u_int period);
2662
2663 typedef int     (*scsi_devid_checkfn_t)(uint8_t *);
2664 int             scsi_devid_is_naa_ieee_reg(uint8_t *bufp);
2665 int             scsi_devid_is_sas_target(uint8_t *bufp);
2666 int             scsi_devid_is_lun_eui64(uint8_t *bufp);
2667 int             scsi_devid_is_lun_naa(uint8_t *bufp);
2668 int             scsi_devid_is_lun_name(uint8_t *bufp);
2669 int             scsi_devid_is_lun_t10(uint8_t *bufp);
2670 struct scsi_vpd_id_descriptor *
2671                 scsi_get_devid(struct scsi_vpd_device_id *id, uint32_t len,
2672                                scsi_devid_checkfn_t ck_fn);
2673
2674 int             scsi_transportid_sbuf(struct sbuf *sb,
2675                                       struct scsi_transportid_header *hdr,
2676                                       uint32_t valid_len);
2677
2678 const char *    scsi_nv_to_str(struct scsi_nv *table, int num_table_entries,
2679                                uint64_t value);
2680
2681 scsi_nv_status  scsi_get_nv(struct scsi_nv *table, int num_table_entries,
2682                             char *name, int *table_entry, scsi_nv_flags flags);
2683
2684 int     scsi_parse_transportid_64bit(int proto_id, char *id_str,
2685                                      struct scsi_transportid_header **hdr,
2686                                      unsigned int *alloc_len,
2687 #ifdef _KERNEL
2688                                      struct malloc_type *type, int flags,
2689 #endif
2690                                      char *error_str, int error_str_len);
2691
2692 int     scsi_parse_transportid_spi(char *id_str,
2693                                    struct scsi_transportid_header **hdr,
2694                                    unsigned int *alloc_len,
2695 #ifdef _KERNEL
2696                                    struct malloc_type *type, int flags,
2697 #endif
2698                                    char *error_str, int error_str_len);
2699
2700 int     scsi_parse_transportid_rdma(char *id_str,
2701                                     struct scsi_transportid_header **hdr,
2702                                     unsigned int *alloc_len,
2703 #ifdef _KERNEL
2704                                     struct malloc_type *type, int flags,
2705 #endif
2706                                     char *error_str, int error_str_len);
2707
2708 int     scsi_parse_transportid_iscsi(char *id_str,
2709                                      struct scsi_transportid_header **hdr,
2710                                      unsigned int *alloc_len,
2711 #ifdef _KERNEL
2712                                      struct malloc_type *type, int flags,
2713 #endif
2714                                      char *error_str,int error_str_len);
2715
2716 int     scsi_parse_transportid_sop(char *id_str,
2717                                    struct scsi_transportid_header **hdr,
2718                                    unsigned int *alloc_len,
2719 #ifdef _KERNEL
2720                                    struct malloc_type *type, int flags,
2721 #endif
2722                                    char *error_str,int error_str_len);
2723
2724 int     scsi_parse_transportid(char *transportid_str,
2725                                struct scsi_transportid_header **hdr,
2726                                unsigned int *alloc_len,
2727 #ifdef _KERNEL
2728                                struct malloc_type *type, int flags,
2729 #endif
2730                                char *error_str, int error_str_len);
2731
2732 void            scsi_test_unit_ready(struct ccb_scsiio *csio, u_int32_t retries,
2733                                      void (*cbfcnp)(struct cam_periph *,
2734                                                     union ccb *),
2735                                      u_int8_t tag_action,
2736                                      u_int8_t sense_len, u_int32_t timeout);
2737
2738 void            scsi_request_sense(struct ccb_scsiio *csio, u_int32_t retries,
2739                                    void (*cbfcnp)(struct cam_periph *,
2740                                                   union ccb *),
2741                                    void *data_ptr, u_int8_t dxfer_len,
2742                                    u_int8_t tag_action, u_int8_t sense_len,
2743                                    u_int32_t timeout);
2744
2745 void            scsi_inquiry(struct ccb_scsiio *csio, u_int32_t retries,
2746                              void (*cbfcnp)(struct cam_periph *, union ccb *),
2747                              u_int8_t tag_action, u_int8_t *inq_buf,
2748                              u_int32_t inq_len, int evpd, u_int8_t page_code,
2749                              u_int8_t sense_len, u_int32_t timeout);
2750
2751 void            scsi_mode_sense(struct ccb_scsiio *csio, u_int32_t retries,
2752                                 void (*cbfcnp)(struct cam_periph *,
2753                                                union ccb *),
2754                                 u_int8_t tag_action, int dbd,
2755                                 u_int8_t page_code, u_int8_t page,
2756                                 u_int8_t *param_buf, u_int32_t param_len,
2757                                 u_int8_t sense_len, u_int32_t timeout);
2758
2759 void            scsi_mode_sense_len(struct ccb_scsiio *csio, u_int32_t retries,
2760                                     void (*cbfcnp)(struct cam_periph *,
2761                                                    union ccb *),
2762                                     u_int8_t tag_action, int dbd,
2763                                     u_int8_t page_code, u_int8_t page,
2764                                     u_int8_t *param_buf, u_int32_t param_len,
2765                                     int minimum_cmd_size, u_int8_t sense_len,
2766                                     u_int32_t timeout);
2767
2768 void            scsi_mode_select(struct ccb_scsiio *csio, u_int32_t retries,
2769                                  void (*cbfcnp)(struct cam_periph *,
2770                                                 union ccb *),
2771                                  u_int8_t tag_action, int scsi_page_fmt,
2772                                  int save_pages, u_int8_t *param_buf,
2773                                  u_int32_t param_len, u_int8_t sense_len,
2774                                  u_int32_t timeout);
2775
2776 void            scsi_mode_select_len(struct ccb_scsiio *csio, u_int32_t retries,
2777                                      void (*cbfcnp)(struct cam_periph *,
2778                                                     union ccb *),
2779                                      u_int8_t tag_action, int scsi_page_fmt,
2780                                      int save_pages, u_int8_t *param_buf,
2781                                      u_int32_t param_len, int minimum_cmd_size,
2782                                      u_int8_t sense_len, u_int32_t timeout);
2783
2784 void            scsi_log_sense(struct ccb_scsiio *csio, u_int32_t retries,
2785                                void (*cbfcnp)(struct cam_periph *, union ccb *),
2786                                u_int8_t tag_action, u_int8_t page_code,
2787                                u_int8_t page, int save_pages, int ppc,
2788                                u_int32_t paramptr, u_int8_t *param_buf,
2789                                u_int32_t param_len, u_int8_t sense_len,
2790                                u_int32_t timeout);
2791
2792 void            scsi_log_select(struct ccb_scsiio *csio, u_int32_t retries,
2793                                 void (*cbfcnp)(struct cam_periph *,
2794                                 union ccb *), u_int8_t tag_action,
2795                                 u_int8_t page_code, int save_pages,
2796                                 int pc_reset, u_int8_t *param_buf,
2797                                 u_int32_t param_len, u_int8_t sense_len,
2798                                 u_int32_t timeout);
2799
2800 void            scsi_prevent(struct ccb_scsiio *csio, u_int32_t retries,
2801                              void (*cbfcnp)(struct cam_periph *, union ccb *),
2802                              u_int8_t tag_action, u_int8_t action,
2803                              u_int8_t sense_len, u_int32_t timeout);
2804
2805 void            scsi_read_capacity(struct ccb_scsiio *csio, u_int32_t retries,
2806                                    void (*cbfcnp)(struct cam_periph *,
2807                                    union ccb *), u_int8_t tag_action,
2808                                    struct scsi_read_capacity_data *,
2809                                    u_int8_t sense_len, u_int32_t timeout);
2810 void            scsi_read_capacity_16(struct ccb_scsiio *csio, uint32_t retries,
2811                                       void (*cbfcnp)(struct cam_periph *,
2812                                       union ccb *), uint8_t tag_action,
2813                                       uint64_t lba, int reladr, int pmi,
2814                                       uint8_t *rcap_buf, int rcap_buf_len,
2815                                       uint8_t sense_len, uint32_t timeout);
2816
2817 void            scsi_report_luns(struct ccb_scsiio *csio, u_int32_t retries,
2818                                  void (*cbfcnp)(struct cam_periph *,
2819                                  union ccb *), u_int8_t tag_action,
2820                                  u_int8_t select_report,
2821                                  struct scsi_report_luns_data *rpl_buf,
2822                                  u_int32_t alloc_len, u_int8_t sense_len,
2823                                  u_int32_t timeout);
2824
2825 void            scsi_report_target_group(struct ccb_scsiio *csio, u_int32_t retries,
2826                                  void (*cbfcnp)(struct cam_periph *,
2827                                  union ccb *), u_int8_t tag_action,
2828                                  u_int8_t pdf,
2829                                  void *buf,
2830                                  u_int32_t alloc_len, u_int8_t sense_len,
2831                                  u_int32_t timeout);
2832
2833 void            scsi_set_target_group(struct ccb_scsiio *csio, u_int32_t retries,
2834                                  void (*cbfcnp)(struct cam_periph *,
2835                                  union ccb *), u_int8_t tag_action, void *buf,
2836                                  u_int32_t alloc_len, u_int8_t sense_len,
2837                                  u_int32_t timeout);
2838
2839 void            scsi_synchronize_cache(struct ccb_scsiio *csio,
2840                                        u_int32_t retries,
2841                                        void (*cbfcnp)(struct cam_periph *,
2842                                        union ccb *), u_int8_t tag_action,
2843                                        u_int32_t begin_lba, u_int16_t lb_count,
2844                                        u_int8_t sense_len, u_int32_t timeout);
2845
2846 void scsi_receive_diagnostic_results(struct ccb_scsiio *csio, u_int32_t retries,
2847                                      void (*cbfcnp)(struct cam_periph *,
2848                                                     union ccb*),
2849                                      uint8_t tag_action, int pcv,
2850                                      uint8_t page_code, uint8_t *data_ptr,
2851                                      uint16_t allocation_length,
2852                                      uint8_t sense_len, uint32_t timeout);
2853
2854 void scsi_send_diagnostic(struct ccb_scsiio *csio, u_int32_t retries,
2855                           void (*cbfcnp)(struct cam_periph *, union ccb *),
2856                           uint8_t tag_action, int unit_offline,
2857                           int device_offline, int self_test, int page_format,
2858                           int self_test_code, uint8_t *data_ptr,
2859                           uint16_t param_list_length, uint8_t sense_len,
2860                           uint32_t timeout);
2861
2862 void scsi_read_buffer(struct ccb_scsiio *csio, u_int32_t retries,
2863                         void (*cbfcnp)(struct cam_periph *, union ccb*),
2864                         uint8_t tag_action, int mode,
2865                         uint8_t buffer_id, u_int32_t offset,
2866                         uint8_t *data_ptr, uint32_t allocation_length,
2867                         uint8_t sense_len, uint32_t timeout);
2868
2869 void scsi_write_buffer(struct ccb_scsiio *csio, u_int32_t retries,
2870                         void (*cbfcnp)(struct cam_periph *, union ccb *),
2871                         uint8_t tag_action, int mode,
2872                         uint8_t buffer_id, u_int32_t offset,
2873                         uint8_t *data_ptr, uint32_t param_list_length,
2874                         uint8_t sense_len, uint32_t timeout);
2875
2876 #define SCSI_RW_READ    0x0001
2877 #define SCSI_RW_WRITE   0x0002
2878 #define SCSI_RW_DIRMASK 0x0003
2879 #define SCSI_RW_BIO     0x1000
2880 void scsi_read_write(struct ccb_scsiio *csio, u_int32_t retries,
2881                      void (*cbfcnp)(struct cam_periph *, union ccb *),
2882                      u_int8_t tag_action, int readop, u_int8_t byte2,
2883                      int minimum_cmd_size, u_int64_t lba,
2884                      u_int32_t block_count, u_int8_t *data_ptr,
2885                      u_int32_t dxfer_len, u_int8_t sense_len,
2886                      u_int32_t timeout);
2887
2888 void scsi_write_same(struct ccb_scsiio *csio, u_int32_t retries,
2889                      void (*cbfcnp)(struct cam_periph *, union ccb *),
2890                      u_int8_t tag_action, u_int8_t byte2,
2891                      int minimum_cmd_size, u_int64_t lba,
2892                      u_int32_t block_count, u_int8_t *data_ptr,
2893                      u_int32_t dxfer_len, u_int8_t sense_len,
2894                      u_int32_t timeout);
2895
2896 void scsi_ata_identify(struct ccb_scsiio *csio, u_int32_t retries,
2897                        void (*cbfcnp)(struct cam_periph *, union ccb *),
2898                        u_int8_t tag_action, u_int8_t *data_ptr,
2899                        u_int16_t dxfer_len, u_int8_t sense_len,
2900                        u_int32_t timeout);
2901
2902 void scsi_ata_trim(struct ccb_scsiio *csio, u_int32_t retries,
2903                    void (*cbfcnp)(struct cam_periph *, union ccb *),
2904                    u_int8_t tag_action, u_int16_t block_count,
2905                    u_int8_t *data_ptr, u_int16_t dxfer_len,
2906                    u_int8_t sense_len, u_int32_t timeout);
2907
2908 void scsi_ata_pass_16(struct ccb_scsiio *csio, u_int32_t retries,
2909                       void (*cbfcnp)(struct cam_periph *, union ccb *),
2910                       u_int32_t flags, u_int8_t tag_action,
2911                       u_int8_t protocol, u_int8_t ata_flags, u_int16_t features,
2912                       u_int16_t sector_count, uint64_t lba, u_int8_t command,
2913                       u_int8_t control, u_int8_t *data_ptr, u_int16_t dxfer_len,
2914                       u_int8_t sense_len, u_int32_t timeout);
2915
2916 void scsi_unmap(struct ccb_scsiio *csio, u_int32_t retries,
2917                 void (*cbfcnp)(struct cam_periph *, union ccb *),
2918                 u_int8_t tag_action, u_int8_t byte2,
2919                 u_int8_t *data_ptr, u_int16_t dxfer_len,
2920                 u_int8_t sense_len, u_int32_t timeout);
2921
2922 void scsi_start_stop(struct ccb_scsiio *csio, u_int32_t retries,
2923                      void (*cbfcnp)(struct cam_periph *, union ccb *),
2924                      u_int8_t tag_action, int start, int load_eject,
2925                      int immediate, u_int8_t sense_len, u_int32_t timeout);
2926
2927 void scsi_persistent_reserve_in(struct ccb_scsiio *csio, uint32_t retries,
2928                                 void (*cbfcnp)(struct cam_periph *,union ccb *),
2929                                 uint8_t tag_action, int service_action,
2930                                 uint8_t *data_ptr, uint32_t dxfer_len,
2931                                 int sense_len, int timeout);
2932
2933 void scsi_persistent_reserve_out(struct ccb_scsiio *csio, uint32_t retries,
2934                                  void (*cbfcnp)(struct cam_periph *,
2935                                        union ccb *),
2936                                  uint8_t tag_action, int service_action,
2937                                  int scope, int res_type, uint8_t *data_ptr,
2938                                  uint32_t dxfer_len, int sense_len,
2939                                  int timeout);
2940
2941 int             scsi_inquiry_match(caddr_t inqbuffer, caddr_t table_entry);
2942 int             scsi_static_inquiry_match(caddr_t inqbuffer,
2943                                           caddr_t table_entry);
2944 int             scsi_devid_match(uint8_t *rhs, size_t rhs_len,
2945                                  uint8_t *lhs, size_t lhs_len);
2946
2947 void scsi_extract_sense(struct scsi_sense_data *sense, int *error_code,
2948                         int *sense_key, int *asc, int *ascq);
2949 int scsi_extract_sense_ccb(union ccb *ccb, int *error_code, int *sense_key,
2950                            int *asc, int *ascq);
2951 void scsi_extract_sense_len(struct scsi_sense_data *sense,
2952                             u_int sense_len, int *error_code, int *sense_key,
2953                             int *asc, int *ascq, int show_errors);
2954 int scsi_get_sense_key(struct scsi_sense_data *sense, u_int sense_len,
2955                        int show_errors);
2956 int scsi_get_asc(struct scsi_sense_data *sense, u_int sense_len,
2957                  int show_errors);
2958 int scsi_get_ascq(struct scsi_sense_data *sense, u_int sense_len,
2959                   int show_errors);
2960 static __inline void scsi_ulto2b(u_int32_t val, u_int8_t *bytes);
2961 static __inline void scsi_ulto3b(u_int32_t val, u_int8_t *bytes);
2962 static __inline void scsi_ulto4b(u_int32_t val, u_int8_t *bytes);
2963 static __inline void scsi_u64to8b(u_int64_t val, u_int8_t *bytes);
2964 static __inline uint32_t scsi_2btoul(const uint8_t *bytes);
2965 static __inline uint32_t scsi_3btoul(const uint8_t *bytes);
2966 static __inline int32_t scsi_3btol(const uint8_t *bytes);
2967 static __inline uint32_t scsi_4btoul(const uint8_t *bytes);
2968 static __inline uint64_t scsi_8btou64(const uint8_t *bytes);
2969 static __inline void *find_mode_page_6(struct scsi_mode_header_6 *mode_header);
2970 static __inline void *find_mode_page_10(struct scsi_mode_header_10 *mode_header);
2971
2972 static __inline void
2973 scsi_ulto2b(u_int32_t val, u_int8_t *bytes)
2974 {
2975
2976         bytes[0] = (val >> 8) & 0xff;
2977         bytes[1] = val & 0xff;
2978 }
2979
2980 static __inline void
2981 scsi_ulto3b(u_int32_t val, u_int8_t *bytes)
2982 {
2983
2984         bytes[0] = (val >> 16) & 0xff;
2985         bytes[1] = (val >> 8) & 0xff;
2986         bytes[2] = val & 0xff;
2987 }
2988
2989 static __inline void
2990 scsi_ulto4b(u_int32_t val, u_int8_t *bytes)
2991 {
2992
2993         bytes[0] = (val >> 24) & 0xff;
2994         bytes[1] = (val >> 16) & 0xff;
2995         bytes[2] = (val >> 8) & 0xff;
2996         bytes[3] = val & 0xff;
2997 }
2998
2999 static __inline void
3000 scsi_u64to8b(u_int64_t val, u_int8_t *bytes)
3001 {
3002
3003         bytes[0] = (val >> 56) & 0xff;
3004         bytes[1] = (val >> 48) & 0xff;
3005         bytes[2] = (val >> 40) & 0xff;
3006         bytes[3] = (val >> 32) & 0xff;
3007         bytes[4] = (val >> 24) & 0xff;
3008         bytes[5] = (val >> 16) & 0xff;
3009         bytes[6] = (val >> 8) & 0xff;
3010         bytes[7] = val & 0xff;
3011 }
3012
3013 static __inline uint32_t
3014 scsi_2btoul(const uint8_t *bytes)
3015 {
3016         uint32_t rv;
3017
3018         rv = (bytes[0] << 8) |
3019              bytes[1];
3020         return (rv);
3021 }
3022
3023 static __inline uint32_t
3024 scsi_3btoul(const uint8_t *bytes)
3025 {
3026         uint32_t rv;
3027
3028         rv = (bytes[0] << 16) |
3029              (bytes[1] << 8) |
3030              bytes[2];
3031         return (rv);
3032 }
3033
3034 static __inline int32_t
3035 scsi_3btol(const uint8_t *bytes)
3036 {
3037         uint32_t rc = scsi_3btoul(bytes);
3038
3039         if (rc & 0x00800000)
3040                 rc |= 0xff000000;
3041
3042         return (int32_t) rc;
3043 }
3044
3045 static __inline uint32_t
3046 scsi_4btoul(const uint8_t *bytes)
3047 {
3048         uint32_t rv;
3049
3050         rv = (bytes[0] << 24) |
3051              (bytes[1] << 16) |
3052              (bytes[2] << 8) |
3053              bytes[3];
3054         return (rv);
3055 }
3056
3057 static __inline uint64_t
3058 scsi_8btou64(const uint8_t *bytes)
3059 {
3060         uint64_t rv;
3061
3062         rv = (((uint64_t)bytes[0]) << 56) |
3063              (((uint64_t)bytes[1]) << 48) |
3064              (((uint64_t)bytes[2]) << 40) |
3065              (((uint64_t)bytes[3]) << 32) |
3066              (((uint64_t)bytes[4]) << 24) |
3067              (((uint64_t)bytes[5]) << 16) |
3068              (((uint64_t)bytes[6]) << 8) |
3069              bytes[7];
3070         return (rv);
3071 }
3072
3073 /*
3074  * Given the pointer to a returned mode sense buffer, return a pointer to
3075  * the start of the first mode page.
3076  */
3077 static __inline void *
3078 find_mode_page_6(struct scsi_mode_header_6 *mode_header)
3079 {
3080         void *page_start;
3081
3082         page_start = (void *)((u_int8_t *)&mode_header[1] +
3083                               mode_header->blk_desc_len);
3084
3085         return(page_start);
3086 }
3087
3088 static __inline void *
3089 find_mode_page_10(struct scsi_mode_header_10 *mode_header)
3090 {
3091         void *page_start;
3092
3093         page_start = (void *)((u_int8_t *)&mode_header[1] +
3094                                scsi_2btoul(mode_header->blk_desc_len));
3095
3096         return(page_start);
3097 }
3098
3099 __END_DECLS
3100
3101 #endif /*_SCSI_SCSI_ALL_H*/