sys/cam/scsi/scsi_all.h

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