sys/cam/scsi/scsi_all.h

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