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