sys/cam/scsi/scsi_all.h

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