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