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
  29 #ifdef _KERNEL
  30 /*
  31  * This is the number of seconds we wait for devices to settle after a SCSI
  32  * bus reset.
  33  */
  34 extern int scsi_delay;
  35 #endif /* _KERNEL */
  36
  37 /*
  38  * SCSI command format
  39  */
  40
  41 /*
  42  * Define dome bits that are in ALL (or a lot of) scsi commands
  43  */
  44 #define SCSI_CTL_LINK           0x01
  45 #define SCSI_CTL_FLAG           0x02
  46 #define SCSI_CTL_VENDOR         0xC0
  47 #define SCSI_CMD_LUN            0xA0    /* these two should not be needed */
  48 #define SCSI_CMD_LUN_SHIFT      5       /* LUN in the cmd is no longer SCSI */
  49
  50 #define SCSI_MAX_CDBLEN         16      /*
  51                                          * 16 byte commands are in the
  52                                          * SCSI-3 spec
  53                                          */
  54 #if defined(CAM_MAX_CDBLEN) && (CAM_MAX_CDBLEN < SCSI_MAX_CDBLEN)
  55 #error "CAM_MAX_CDBLEN cannot be less than SCSI_MAX_CDBLEN"
  56 #endif
  57
  58 /* 6byte CDBs special case 0 length to be 256 */
  59 #define SCSI_CDB6_LEN(len)      ((len) == 0 ? 256 : len)
  60
  61 /*
  62  * This type defines actions to be taken when a particular sense code is
  63  * received.  Right now, these flags are only defined to take up 16 bits,
  64  * but can be expanded in the future if necessary.
  65  */
  66 typedef enum {
  67         SS_NOP      = 0x000000, /* Do nothing */
  68         SS_RETRY    = 0x010000, /* Retry the command */
  69         SS_FAIL     = 0x020000, /* Bail out */
  70         SS_START    = 0x030000, /* Send a Start Unit command to the device,
  71                                  * then retry the original command.
  72                                  */
  73         SS_TUR      = 0x040000, /* Send a Test Unit Ready command to the
  74                                  * device, then retry the original command.
  75                                  */
  76         SS_REQSENSE = 0x050000, /* Send a RequestSense command to the
  77                                  * device, then retry the original command.
  78                                  */
  79         SS_MASK     = 0xff0000
  80 } scsi_sense_action;
  81
  82 typedef enum {
  83         SSQ_NONE                = 0x0000,
  84         SSQ_DECREMENT_COUNT     = 0x0100,  /* Decrement the retry count */
  85         SSQ_MANY                = 0x0200,  /* send lots of recovery commands */
  86         SSQ_RANGE               = 0x0400,  /*
  87                                             * This table entry represents the
  88                                             * end of a range of ASCQs that
  89                                             * have identical error actions
  90                                             * and text.
  91                                             */
  92         SSQ_PRINT_SENSE         = 0x0800,
  93         SSQ_MASK                = 0xff00
  94 } scsi_sense_action_qualifier;
  95
  96 /* Mask for error status values */
  97 #define SS_ERRMASK      0xff
  98
  99 /* The default, retyable, error action */
 100 #define SS_RDEF         SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE|EIO
 101
 102 /* The retyable, error action, with table specified error code */
 103 #define SS_RET          SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE
 104
 105 /* Fatal error action, with table specified error code */
 106 #define SS_FATAL        SS_FAIL|SSQ_PRINT_SENSE
 107
 108 struct scsi_generic
 109 {
 110         u_int8_t opcode;
 111         u_int8_t bytes[11];
 112 };
 113
 114 struct scsi_request_sense
 115 {
 116         u_int8_t opcode;
 117         u_int8_t byte2;
 118         u_int8_t unused[2];
 119         u_int8_t length;
 120         u_int8_t control;
 121 };
 122
 123 struct scsi_test_unit_ready
 124 {
 125         u_int8_t opcode;
 126         u_int8_t byte2;
 127         u_int8_t unused[3];
 128         u_int8_t control;
 129 };
 130
 131 struct scsi_send_diag
 132 {
 133         u_int8_t opcode;
 134         u_int8_t byte2;
 135 #define SSD_UOL         0x01
 136 #define SSD_DOL         0x02
 137 #define SSD_SELFTEST    0x04
 138 #define SSD_PF          0x10
 139         u_int8_t unused[1];
 140         u_int8_t paramlen[2];
 141         u_int8_t control;
 142 };
 143
 144 struct scsi_sense
 145 {
 146         u_int8_t opcode;
 147         u_int8_t byte2;
 148         u_int8_t unused[2];
 149         u_int8_t length;
 150         u_int8_t control;
 151 };
 152
 153 struct scsi_inquiry
 154 {
 155         u_int8_t opcode;
 156         u_int8_t byte2;
 157 #define SI_EVPD 0x01
 158         u_int8_t page_code;
 159         u_int8_t reserved;
 160         u_int8_t length;
 161         u_int8_t control;
 162 };
 163
 164 struct scsi_mode_sense_6
 165 {
 166         u_int8_t opcode;
 167         u_int8_t byte2;
 168 #define SMS_DBD                         0x08
 169         u_int8_t page;
 170 #define SMS_PAGE_CODE                   0x3F
 171 #define SMS_VENDOR_SPECIFIC_PAGE        0x00
 172 #define SMS_DISCONNECT_RECONNECT_PAGE   0x02
 173 #define SMS_FORMAT_DEVICE_PAGE          0x03
 174 #define SMS_GEOMETRY_PAGE               0x04
 175 #define SMS_CACHE_PAGE                  0x08
 176 #define SMS_PERIPHERAL_DEVICE_PAGE      0x09
 177 #define SMS_CONTROL_MODE_PAGE           0x0A
 178 #define SMS_PROTO_SPECIFIC_PAGE         0x19
 179 #define SMS_INFO_EXCEPTIONS_PAGE        0x1C
 180 #define SMS_ALL_PAGES_PAGE              0x3F
 181 #define SMS_PAGE_CTRL_MASK              0xC0
 182 #define SMS_PAGE_CTRL_CURRENT           0x00
 183 #define SMS_PAGE_CTRL_CHANGEABLE        0x40
 184 #define SMS_PAGE_CTRL_DEFAULT           0x80
 185 #define SMS_PAGE_CTRL_SAVED             0xC0
 186         u_int8_t unused;
 187         u_int8_t length;
 188         u_int8_t control;
 189 };
 190
 191 struct scsi_mode_sense_10
 192 {
 193         u_int8_t opcode;
 194         u_int8_t byte2;         /* same bits as small version */
 195         u_int8_t page;          /* same bits as small version */
 196         u_int8_t unused[4];
 197         u_int8_t length[2];
 198         u_int8_t control;
 199 };
 200
 201 struct scsi_mode_select_6
 202 {
 203         u_int8_t opcode;
 204         u_int8_t byte2;
 205 #define SMS_SP  0x01
 206 #define SMS_PF  0x10
 207         u_int8_t unused[2];
 208         u_int8_t length;
 209         u_int8_t control;
 210 };
 211
 212 struct scsi_mode_select_10
 213 {
 214         u_int8_t opcode;
 215         u_int8_t byte2;         /* same bits as small version */
 216         u_int8_t unused[5];
 217         u_int8_t length[2];
 218         u_int8_t control;
 219 };
 220
 221 /*
 222  * When sending a mode select to a tape drive, the medium type must be 0.
 223  */
 224 struct scsi_mode_hdr_6
 225 {
 226         u_int8_t datalen;
 227         u_int8_t medium_type;
 228         u_int8_t dev_specific;
 229         u_int8_t block_descr_len;
 230 };
 231
 232 struct scsi_mode_hdr_10
 233 {
 234         u_int8_t datalen[2];
 235         u_int8_t medium_type;
 236         u_int8_t dev_specific;
 237         u_int8_t reserved[2];
 238         u_int8_t block_descr_len[2];
 239 };
 240
 241 struct scsi_mode_block_descr
 242 {
 243         u_int8_t density_code;
 244         u_int8_t num_blocks[3];
 245         u_int8_t reserved;
 246         u_int8_t block_len[3];
 247 };
 248
 249 struct scsi_log_sense
 250 {
 251         u_int8_t opcode;
 252         u_int8_t byte2;
 253 #define SLS_SP                          0x01
 254 #define SLS_PPC                         0x02
 255         u_int8_t page;
 256 #define SLS_PAGE_CODE                   0x3F
 257 #define SLS_ALL_PAGES_PAGE              0x00
 258 #define SLS_OVERRUN_PAGE                0x01
 259 #define SLS_ERROR_WRITE_PAGE            0x02
 260 #define SLS_ERROR_READ_PAGE             0x03
 261 #define SLS_ERROR_READREVERSE_PAGE      0x04
 262 #define SLS_ERROR_VERIFY_PAGE           0x05
 263 #define SLS_ERROR_NONMEDIUM_PAGE        0x06
 264 #define SLS_ERROR_LASTN_PAGE            0x07
 265 #define SLS_SELF_TEST_PAGE              0x10
 266 #define SLS_IE_PAGE                     0x2f
 267 #define SLS_PAGE_CTRL_MASK              0xC0
 268 #define SLS_PAGE_CTRL_THRESHOLD         0x00
 269 #define SLS_PAGE_CTRL_CUMULATIVE        0x40
 270 #define SLS_PAGE_CTRL_THRESH_DEFAULT    0x80
 271 #define SLS_PAGE_CTRL_CUMUL_DEFAULT     0xC0
 272         u_int8_t reserved[2];
 273         u_int8_t paramptr[2];
 274         u_int8_t length[2];
 275         u_int8_t control;
 276 };
 277
 278 struct scsi_log_select
 279 {
 280         u_int8_t opcode;
 281         u_int8_t byte2;
 282 /*      SLS_SP                          0x01 */
 283 #define SLS_PCR                         0x02
 284         u_int8_t page;
 285 /*      SLS_PAGE_CTRL_MASK              0xC0 */
 286 /*      SLS_PAGE_CTRL_THRESHOLD         0x00 */
 287 /*      SLS_PAGE_CTRL_CUMULATIVE        0x40 */
 288 /*      SLS_PAGE_CTRL_THRESH_DEFAULT    0x80 */
 289 /*      SLS_PAGE_CTRL_CUMUL_DEFAULT     0xC0 */
 290         u_int8_t reserved[4];
 291         u_int8_t length[2];
 292         u_int8_t control;
 293 };
 294
 295 struct scsi_log_header
 296 {
 297         u_int8_t page;
 298         u_int8_t reserved;
 299         u_int8_t datalen[2];
 300 };
 301
 302 struct scsi_log_param_header {
 303         u_int8_t param_code[2];
 304         u_int8_t param_control;
 305 #define SLP_LP                          0x01
 306 #define SLP_LBIN                        0x02
 307 #define SLP_TMC_MASK                    0x0C
 308 #define SLP_TMC_ALWAYS                  0x00
 309 #define SLP_TMC_EQUAL                   0x04
 310 #define SLP_TMC_NOTEQUAL                0x08
 311 #define SLP_TMC_GREATER                 0x0C
 312 #define SLP_ETC                         0x10
 313 #define SLP_TSD                         0x20
 314 #define SLP_DS                          0x40
 315 #define SLP_DU                          0x80
 316         u_int8_t param_len;
 317 };
 318
 319 struct scsi_control_page {
 320         u_int8_t page_code;
 321         u_int8_t page_length;
 322         u_int8_t rlec;
 323 #define SCB_RLEC                        0x01    /*Report Log Exception Cond*/
 324         u_int8_t queue_flags;
 325 #define SCP_QUEUE_ALG_MASK              0xF0
 326 #define SCP_QUEUE_ALG_RESTRICTED        0x00
 327 #define SCP_QUEUE_ALG_UNRESTRICTED      0x10
 328 #define SCP_QUEUE_ERR                   0x02    /*Queued I/O aborted for CACs*/
 329 #define SCP_QUEUE_DQUE                  0x01    /*Queued I/O disabled*/
 330         u_int8_t eca_and_aen;
 331 #define SCP_EECA                        0x80    /*Enable Extended CA*/
 332 #define SCP_RAENP                       0x04    /*Ready AEN Permission*/
 333 #define SCP_UAAENP                      0x02    /*UA AEN Permission*/
 334 #define SCP_EAENP                       0x01    /*Error AEN Permission*/
 335         u_int8_t reserved;
 336         u_int8_t aen_holdoff_period[2];
 337 };
 338
 339 struct scsi_cache_page {
 340         u_int8_t page_code;
 341 #define SCHP_PAGE_SAVABLE               0x80    /* Page is savable */
 342         u_int8_t page_length;
 343         u_int8_t cache_flags;
 344 #define SCHP_FLAGS_WCE                  0x04    /* Write Cache Enable */
 345 #define SCHP_FLAGS_MF                   0x02    /* Multiplication factor */
 346 #define SCHP_FLAGS_RCD                  0x01    /* Read Cache Disable */
 347         u_int8_t rw_cache_policy;
 348         u_int8_t dis_prefetch[2];
 349         u_int8_t min_prefetch[2];
 350         u_int8_t max_prefetch[2];
 351         u_int8_t max_prefetch_ceil[2];
 352 };
 353
 354 struct scsi_info_exceptions_page {
 355         u_int8_t page_code;
 356 #define SIEP_PAGE_SAVABLE               0x80    /* Page is savable */
 357         u_int8_t page_length;
 358         u_int8_t info_flags;
 359 #define SIEP_FLAGS_PERF                 0x80
 360 #define SIEP_FLAGS_EBF                  0x20
 361 #define SIEP_FLAGS_EWASC                0x10
 362 #define SIEP_FLAGS_DEXCPT               0x08
 363 #define SIEP_FLAGS_TEST                 0x04
 364 #define SIEP_FLAGS_EBACKERR             0x02
 365 #define SIEP_FLAGS_LOGERR               0x01
 366         u_int8_t mrie;
 367         u_int8_t interval_timer[4];
 368         u_int8_t report_count[4];
 369 };
 370
 371 struct scsi_proto_specific_page {
 372         u_int8_t page_code;
 373 #define SPSP_PAGE_SAVABLE               0x80    /* Page is savable */
 374         u_int8_t page_length;
 375         u_int8_t protocol;
 376 #define SPSP_PROTO_FC                   0x00
 377 #define SPSP_PROTO_SPI                  0x01
 378 #define SPSP_PROTO_SSA                  0x02
 379 #define SPSP_PROTO_1394                 0x03
 380 #define SPSP_PROTO_RDMA                 0x04
 381 #define SPSP_PROTO_ISCSI                0x05
 382 #define SPSP_PROTO_SAS                  0x06
 383 #define SPSP_PROTO_ADT                  0x07
 384 #define SPSP_PROTO_ATA                  0x08
 385 #define SPSP_PROTO_NONE                 0x0f
 386 };
 387
 388 struct scsi_reserve
 389 {
 390         u_int8_t opcode;
 391         u_int8_t byte2;
 392         u_int8_t unused[2];
 393         u_int8_t length;
 394         u_int8_t control;
 395 };
 396
 397 struct scsi_release
 398 {
 399         u_int8_t opcode;
 400         u_int8_t byte2;
 401         u_int8_t unused[2];
 402         u_int8_t length;
 403         u_int8_t control;
 404 };
 405
 406 struct scsi_prevent
 407 {
 408         u_int8_t opcode;
 409         u_int8_t byte2;
 410         u_int8_t unused[2];
 411         u_int8_t how;
 412         u_int8_t control;
 413 };
 414 #define PR_PREVENT 0x01
 415 #define PR_ALLOW   0x00
 416
 417 struct scsi_sync_cache
 418 {
 419         u_int8_t opcode;
 420         u_int8_t byte2;
 421         u_int8_t begin_lba[4];
 422         u_int8_t reserved;
 423         u_int8_t lb_count[2];
 424         u_int8_t control;
 425 };
 426
 427
 428 struct scsi_changedef
 429 {
 430         u_int8_t opcode;
 431         u_int8_t byte2;
 432         u_int8_t unused1;
 433         u_int8_t how;
 434         u_int8_t unused[4];
 435         u_int8_t datalen;
 436         u_int8_t control;
 437 };
 438
 439 struct scsi_read_buffer
 440 {
 441         u_int8_t opcode;
 442         u_int8_t byte2;
 443 #define RWB_MODE                0x07
 444 #define RWB_MODE_HDR_DATA       0x00
 445 #define RWB_MODE_DATA           0x02
 446 #define RWB_MODE_DOWNLOAD       0x04
 447 #define RWB_MODE_DOWNLOAD_SAVE  0x05
 448         u_int8_t buffer_id;
 449         u_int8_t offset[3];
 450         u_int8_t length[3];
 451         u_int8_t control;
 452 };
 453
 454 struct scsi_write_buffer
 455 {
 456         u_int8_t opcode;
 457         u_int8_t byte2;
 458         u_int8_t buffer_id;
 459         u_int8_t offset[3];
 460         u_int8_t length[3];
 461         u_int8_t control;
 462 };
 463
 464 struct scsi_rw_6
 465 {
 466         u_int8_t opcode;
 467         u_int8_t addr[3];
 468 /* only 5 bits are valid in the MSB address byte */
 469 #define SRW_TOPADDR     0x1F
 470         u_int8_t length;
 471         u_int8_t control;
 472 };
 473
 474 struct scsi_rw_10
 475 {
 476         u_int8_t opcode;
 477 #define SRW10_RELADDR   0x01
 478 /* EBP defined for WRITE(10) only */
 479 #define SRW10_EBP       0x04
 480 #define SRW10_FUA       0x08
 481 #define SRW10_DPO       0x10
 482         u_int8_t byte2;
 483         u_int8_t addr[4];
 484         u_int8_t reserved;
 485         u_int8_t length[2];
 486         u_int8_t control;
 487 };
 488
 489 struct scsi_rw_12
 490 {
 491         u_int8_t opcode;
 492 #define SRW12_RELADDR   0x01
 493 #define SRW12_FUA       0x08
 494 #define SRW12_DPO       0x10
 495         u_int8_t byte2;
 496         u_int8_t addr[4];
 497         u_int8_t length[4];
 498         u_int8_t reserved;
 499         u_int8_t control;
 500 };
 501
 502 struct scsi_rw_16
 503 {
 504         u_int8_t opcode;
 505 #define SRW16_RELADDR   0x01
 506 #define SRW16_FUA       0x08
 507 #define SRW16_DPO       0x10
 508         u_int8_t byte2;
 509         u_int8_t addr[8];
 510         u_int8_t length[4];
 511         u_int8_t reserved;
 512         u_int8_t control;
 513 };
 514
 515 struct scsi_start_stop_unit
 516 {
 517         u_int8_t opcode;
 518         u_int8_t byte2;
 519 #define SSS_IMMED               0x01
 520         u_int8_t reserved[2];
 521         u_int8_t how;
 522 #define SSS_START               0x01
 523 #define SSS_LOEJ                0x02
 524         u_int8_t control;
 525 };
 526
 527 struct ata_pass_12 {
 528         u_int8_t opcode;
 529         u_int8_t protocol;
 530 #define AP_MULTI        0xe0
 531         u_int8_t flags;
 532 #define AP_T_LEN        0x03
 533 #define AP_BB           0x04
 534 #define AP_T_DIR        0x08
 535 #define AP_CK_COND      0x20
 536 #define AP_OFFLINE      0x60
 537         u_int8_t features;
 538         u_int8_t sector_count;
 539         u_int8_t lba_low;
 540         u_int8_t lba_mid;
 541         u_int8_t lba_high;
 542         u_int8_t device;
 543         u_int8_t command;
 544         u_int8_t reserved;
 545         u_int8_t control;
 546 };
 547
 548 struct ata_pass_16 {
 549         u_int8_t opcode;
 550         u_int8_t protocol;
 551 #define AP_EXTEND       0x01
 552         u_int8_t flags;
 553         u_int8_t features_ext;
 554         u_int8_t features;
 555         u_int8_t sector_count_ext;
 556         u_int8_t sector_count;
 557         u_int8_t lba_low_ext;
 558         u_int8_t lba_low;
 559         u_int8_t lba_mid_ext;
 560         u_int8_t lba_mid;
 561         u_int8_t lba_high_ext;
 562         u_int8_t lba_high;
 563         u_int8_t device;
 564         u_int8_t command;
 565         u_int8_t control;
 566 };
 567
 568 #define SC_SCSI_1 0x01
 569 #define SC_SCSI_2 0x03
 570
 571 /*
 572  * Opcodes
 573  */
 574
 575 #define TEST_UNIT_READY         0x00
 576 #define REQUEST_SENSE           0x03
 577 #define READ_6                  0x08
 578 #define WRITE_6                 0x0A
 579 #define INQUIRY                 0x12
 580 #define MODE_SELECT_6           0x15
 581 #define MODE_SENSE_6            0x1A
 582 #define START_STOP_UNIT         0x1B
 583 #define START_STOP              0x1B
 584 #define RESERVE                 0x16
 585 #define RELEASE                 0x17
 586 #define RECEIVE_DIAGNOSTIC      0x1C
 587 #define SEND_DIAGNOSTIC         0x1D
 588 #define PREVENT_ALLOW           0x1E
 589 #define READ_CAPACITY           0x25
 590 #define READ_10                 0x28
 591 #define WRITE_10                0x2A
 592 #define POSITION_TO_ELEMENT     0x2B
 593 #define SYNCHRONIZE_CACHE       0x35
 594 #define READ_DEFECT_DATA_10     0x37
 595 #define WRITE_BUFFER            0x3B
 596 #define READ_BUFFER             0x3C
 597 #define CHANGE_DEFINITION       0x40
 598 #define LOG_SELECT              0x4C
 599 #define LOG_SENSE               0x4D
 600 #define MODE_SELECT_10          0x55
 601 #define MODE_SENSE_10           0x5A
 602 #define ATA_PASS_16             0x85
 603 #define READ_16                 0x88
 604 #define WRITE_16                0x8A
 605 #define SERVICE_ACTION_IN       0x9E
 606 #define REPORT_LUNS             0xA0
 607 #define ATA_PASS_12             0xA1
 608 #define MAINTENANCE_IN          0xA3
 609 #define MAINTENANCE_OUT         0xA4
 610 #define MOVE_MEDIUM             0xA5
 611 #define READ_12                 0xA8
 612 #define WRITE_12                0xAA
 613 #define READ_ELEMENT_STATUS     0xB8
 614
 615 /* Maintenance In Service Action Codes */
 616 #define REPORT_IDENTIFYING_INFRMATION           0x05
 617 #define REPORT_TARGET_PORT_GROUPS               0x0A
 618 #define REPORT_ALIASES                          0x0B
 619 #define REPORT_SUPPORTED_OPERATION_CODES        0x0C
 620 #define REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS      0x0D
 621 #define REPORT_PRIORITY                         0x0E
 622 #define REPORT_TIMESTAMP                        0x0F
 623 #define MANAGEMENT_PROTOCOL_IN                  0x10
 624 /* Maintenance Out Service Action Codes */
 625 #define SET_IDENTIFY_INFORMATION                0x06
 626 #define SET_TARGET_PORT_GROUPS                  0x0A
 627 #define CHANGE_ALIASES                          0x0B
 628 #define SET_PRIORITY                            0x0E
 629 #define SET_TIMESTAMP                           0x0F
 630 #define MANGAEMENT_PROTOCOL_OUT                 0x10
 631
 632 /*
 633  * Device Types
 634  */
 635 #define T_DIRECT        0x00
 636 #define T_SEQUENTIAL    0x01
 637 #define T_PRINTER       0x02
 638 #define T_PROCESSOR     0x03
 639 #define T_WORM          0x04
 640 #define T_CDROM         0x05
 641 #define T_SCANNER       0x06
 642 #define T_OPTICAL       0x07
 643 #define T_CHANGER       0x08
 644 #define T_COMM          0x09
 645 #define T_ASC0          0x0a
 646 #define T_ASC1          0x0b
 647 #define T_STORARRAY     0x0c
 648 #define T_ENCLOSURE     0x0d
 649 #define T_RBC           0x0e
 650 #define T_OCRW          0x0f
 651 #define T_OSD           0x11
 652 #define T_ADC           0x12
 653 #define T_NODEVICE      0x1f
 654 #define T_ANY           0xff    /* Used in Quirk table matches */
 655
 656 #define T_REMOV         1
 657 #define T_FIXED         0
 658
 659 /*
 660  * This length is the initial inquiry length used by the probe code, as
 661  * well as the legnth necessary for scsi_print_inquiry() to function
 662  * correctly.  If either use requires a different length in the future,
 663  * the two values should be de-coupled.
 664  */
 665 #define SHORT_INQUIRY_LENGTH    36
 666
 667 struct scsi_inquiry_data
 668 {
 669         u_int8_t device;
 670 #define SID_TYPE(inq_data) ((inq_data)->device & 0x1f)
 671 #define SID_QUAL(inq_data) (((inq_data)->device & 0xE0) >> 5)
 672 #define SID_QUAL_LU_CONNECTED   0x00    /*
 673                                          * The specified peripheral device
 674                                          * type is currently connected to
 675                                          * logical unit.  If the target cannot
 676                                          * determine whether or not a physical
 677                                          * device is currently connected, it
 678                                          * shall also use this peripheral
 679                                          * qualifier when returning the INQUIRY
 680                                          * data.  This peripheral qualifier
 681                                          * does not mean that the device is
 682                                          * ready for access by the initiator.
 683                                          */
 684 #define SID_QUAL_LU_OFFLINE     0x01    /*
 685                                          * The target is capable of supporting
 686                                          * the specified peripheral device type
 687                                          * on this logical unit; however, the
 688                                          * physical device is not currently
 689                                          * connected to this logical unit.
 690                                          */
 691 #define SID_QUAL_RSVD           0x02
 692 #define SID_QUAL_BAD_LU         0x03    /*
 693                                          * The target is not capable of
 694                                          * supporting a physical device on
 695                                          * this logical unit. For this
 696                                          * peripheral qualifier the peripheral
 697                                          * device type shall be set to 1Fh to
 698                                          * provide compatibility with previous
 699                                          * versions of SCSI. All other
 700                                          * peripheral device type values are
 701                                          * reserved for this peripheral
 702                                          * qualifier.
 703                                          */
 704 #define SID_QUAL_IS_VENDOR_UNIQUE(inq_data) ((SID_QUAL(inq_data) & 0x08) != 0)
 705         u_int8_t dev_qual2;
 706 #define SID_QUAL2       0x7F
 707 #define SID_IS_REMOVABLE(inq_data) (((inq_data)->dev_qual2 & 0x80) != 0)
 708         u_int8_t version;
 709 #define SID_ANSI_REV(inq_data) ((inq_data)->version & 0x07)
 710 #define         SCSI_REV_0              0
 711 #define         SCSI_REV_CCS            1
 712 #define         SCSI_REV_2              2
 713 #define         SCSI_REV_SPC            3
 714 #define         SCSI_REV_SPC2           4
 715 #define         SCSI_REV_SPC3           5
 716 #define         SCSI_REV_SPC4           6
 717
 718 #define SID_ECMA        0x38
 719 #define SID_ISO         0xC0
 720         u_int8_t response_format;
 721 #define SID_AENC        0x80
 722 #define SID_TrmIOP      0x40
 723         u_int8_t additional_length;
 724 #define SID_ADDITIONAL_LENGTH(iqd)                                      \
 725         ((iqd)->additional_length +                                     \
 726         offsetof(struct scsi_inquiry_data, additional_length) + 1)
 727         u_int8_t spc3_flags;
 728 #define SPC3_SID_PROTECT        0x01
 729 #define SPC3_SID_3PC            0x08
 730 #define SPC3_SID_TPGS_MASK      0x30
 731 #define SPC3_SID_TPGS_IMPLICIT  0x10
 732 #define SPC3_SID_TPGS_EXPLICIT  0x20
 733 #define SPC3_SID_ACC            0x40
 734 #define SPC3_SID_SCCS           0x80
 735         u_int8_t spc2_flags;
 736 #define SPC2_SID_MChngr         0x08
 737 #define SPC2_SID_MultiP         0x10
 738 #define SPC2_SID_EncServ        0x40
 739 #define SPC2_SID_BQueue         0x80
 740
 741 #define INQ_DATA_TQ_ENABLED(iqd)                                \
 742     ((SID_ANSI_REV(iqd) < SCSI_REV_SPC2)? ((iqd)->flags & SID_CmdQue) : \
 743     (((iqd)->flags & SID_CmdQue) && !((iqd)->spc2_flags & SPC2_SID_BQueue)) || \
 744     (!((iqd)->flags & SID_CmdQue) && ((iqd)->spc2_flags & SPC2_SID_BQueue)))
 745
 746         u_int8_t flags;
 747 #define SID_SftRe       0x01
 748 #define SID_CmdQue      0x02
 749 #define SID_Linked      0x08
 750 #define SID_Sync        0x10
 751 #define SID_WBus16      0x20
 752 #define SID_WBus32      0x40
 753 #define SID_RelAdr      0x80
 754 #define SID_VENDOR_SIZE   8
 755         char     vendor[SID_VENDOR_SIZE];
 756 #define SID_PRODUCT_SIZE  16
 757         char     product[SID_PRODUCT_SIZE];
 758 #define SID_REVISION_SIZE 4
 759         char     revision[SID_REVISION_SIZE];
 760         /*
 761          * The following fields were taken from SCSI Primary Commands - 2
 762          * (SPC-2) Revision 14, Dated 11 November 1999
 763          */
 764 #define SID_VENDOR_SPECIFIC_0_SIZE      20
 765         u_int8_t vendor_specific0[SID_VENDOR_SPECIFIC_0_SIZE];
 766         /*
 767          * An extension of SCSI Parallel Specific Values
 768          */
 769 #define SID_SPI_IUS             0x01
 770 #define SID_SPI_QAS             0x02
 771 #define SID_SPI_CLOCK_ST        0x00
 772 #define SID_SPI_CLOCK_DT        0x04
 773 #define SID_SPI_CLOCK_DT_ST     0x0C
 774 #define SID_SPI_MASK            0x0F
 775         u_int8_t spi3data;
 776         u_int8_t reserved2;
 777         /*
 778          * Version Descriptors, stored 2 byte values.
 779          */
 780         u_int8_t version1[2];
 781         u_int8_t version2[2];
 782         u_int8_t version3[2];
 783         u_int8_t version4[2];
 784         u_int8_t version5[2];
 785         u_int8_t version6[2];
 786         u_int8_t version7[2];
 787         u_int8_t version8[2];
 788
 789         u_int8_t reserved3[22];
 790
 791 #define SID_VENDOR_SPECIFIC_1_SIZE      160
 792         u_int8_t vendor_specific1[SID_VENDOR_SPECIFIC_1_SIZE];
 793 };
 794
 795 struct scsi_vpd_supported_page_list
 796 {
 797         u_int8_t device;
 798         u_int8_t page_code;
 799 #define SVPD_SUPPORTED_PAGE_LIST 0x00
 800         u_int8_t reserved;
 801         u_int8_t length;        /* number of VPD entries */
 802 #define SVPD_SUPPORTED_PAGES_SIZE       251
 803         u_int8_t list[SVPD_SUPPORTED_PAGES_SIZE];
 804 };
 805
 806 struct scsi_vpd_unit_serial_number
 807 {
 808         u_int8_t device;
 809         u_int8_t page_code;
 810 #define SVPD_UNIT_SERIAL_NUMBER 0x80
 811         u_int8_t reserved;
 812         u_int8_t length; /* serial number length */
 813 #define SVPD_SERIAL_NUM_SIZE 251
 814         u_int8_t serial_num[SVPD_SERIAL_NUM_SIZE];
 815 };
 816
 817 struct scsi_read_capacity
 818 {
 819         u_int8_t opcode;
 820         u_int8_t byte2;
 821         u_int8_t addr[4];
 822         u_int8_t unused[3];
 823         u_int8_t control;
 824 };
 825
 826 struct scsi_read_capacity_16
 827 {
 828         uint8_t opcode;
 829 #define SRC16_SERVICE_ACTION    0x10
 830         uint8_t service_action;
 831         uint8_t addr[8];
 832         uint8_t alloc_len[4];
 833 #define SRC16_PMI               0x01
 834 #define SRC16_RELADR            0x02
 835         uint8_t reladr;
 836         uint8_t control;
 837 };
 838
 839 struct scsi_read_capacity_data
 840 {
 841         u_int8_t addr[4];
 842         u_int8_t length[4];
 843 };
 844
 845 struct scsi_read_capacity_data_long
 846 {
 847         uint8_t addr[8];
 848         uint8_t length[4];
 849 };
 850
 851 struct scsi_report_luns
 852 {
 853         uint8_t opcode;
 854         uint8_t reserved1;
 855 #define RPL_REPORT_DEFAULT      0x00
 856 #define RPL_REPORT_WELLKNOWN    0x01
 857 #define RPL_REPORT_ALL          0x02
 858         uint8_t select_report;
 859         uint8_t reserved2[3];
 860         uint8_t length[4];
 861         uint8_t reserved3;
 862         uint8_t control;
 863 };
 864
 865 struct scsi_report_luns_data {
 866         u_int8_t length[4];     /* length of LUN inventory, in bytes */
 867         u_int8_t reserved[4];   /* unused */
 868         /*
 869          * LUN inventory- we only support the type zero form for now.
 870          */
 871         struct {
 872                 u_int8_t lundata[8];
 873         } luns[0];
 874 };
 875 #define RPL_LUNDATA_PERIPH_BUS_MASK     0x3f
 876 #define RPL_LUNDATA_FLAT_LUN_MASK       0x3f
 877 #define RPL_LUNDATA_LUN_TARG_MASK       0x3f
 878 #define RPL_LUNDATA_LUN_BUS_MASK        0xe0
 879 #define RPL_LUNDATA_LUN_LUN_MASK        0x1f
 880 #define RPL_LUNDATA_EXT_LEN_MASK        0x30
 881 #define RPL_LUNDATA_EXT_EAM_MASK        0x0f
 882 #define RPL_LUNDATA_EXT_EAM_WK          0x01
 883 #define RPL_LUNDATA_EXT_EAM_NOT_SPEC    0x0f
 884 #define RPL_LUNDATA_ATYP_MASK   0xc0    /* MBZ for type 0 lun */
 885 #define RPL_LUNDATA_ATYP_PERIPH 0x00
 886 #define RPL_LUNDATA_ATYP_FLAT   0x40
 887 #define RPL_LUNDATA_ATYP_LUN    0x80
 888 #define RPL_LUNDATA_ATYP_EXTLUN 0xc0
 889
 890 struct scsi_target_group
 891 {
 892         uint8_t opcode;
 893         uint8_t service_action;
 894 #define STG_PDF_LENGTH          0x00
 895 #define RPL_PDF_EXTENDED        0x20
 896         uint8_t reserved1[4];
 897         uint8_t length[4];
 898         uint8_t reserved2;
 899         uint8_t control;
 900 };
 901
 902 struct scsi_target_port_descriptor {
 903         uint8_t reserved[2];
 904         uint8_t relative_target_port_identifier[2];
 905         uint8_t desc_list[];
 906 };
 907
 908 struct scsi_target_port_group_descriptor {
 909         uint8_t pref_state;
 910 #define TPG_PRIMARY                             0x80
 911 #define TPG_ASYMMETRIC_ACCESS_STATE_MASK        0xf
 912 #define TPG_ASYMMETRIC_ACCESS_OPTIMIZED         0x0
 913 #define TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED      0x1
 914 #define TPG_ASYMMETRIC_ACCESS_STANDBY           0x2
 915 #define TPG_ASYMMETRIC_ACCESS_UNAVAILABLE       0x3
 916 #define TPG_ASYMMETRIC_ACCESS_LBA_DEPENDENT     0x4
 917 #define TPG_ASYMMETRIC_ACCESS_OFFLINE           0xE
 918 #define TPG_ASYMMETRIC_ACCESS_TRANSITIONING     0xF
 919         uint8_t support;
 920 #define TPG_AO_SUP      0x01
 921 #define TPG_AN_SUP      0x02
 922 #define TPG_S_SUP       0x04
 923 #define TPG_U_SUP       0x08
 924 #define TPG_LBD_SUP     0x10
 925 #define TPG_O_SUP       0x40
 926 #define TPG_T_SUP       0x80
 927         uint8_t target_port_group[2];
 928         uint8_t reserved;
 929         uint8_t status;
 930         uint8_t vendor_specific;
 931         uint8_t target_port_count;
 932         struct scsi_target_port_descriptor descriptors[];
 933 };
 934
 935 struct scsi_target_group_data {
 936         uint8_t length[4];      /* length of returned data, in bytes */
 937         struct scsi_target_port_group_descriptor groups[];
 938 };
 939
 940 struct scsi_target_group_data_extended {
 941         uint8_t length[4];      /* length of returned data, in bytes */
 942         uint8_t format_type;    /* STG_PDF_LENGTH or RPL_PDF_EXTENDED */
 943         uint8_t implicit_transition_time;
 944         uint8_t reserved[2];
 945         struct scsi_target_port_group_descriptor groups[];
 946 };
 947
 948
 949 struct scsi_sense_data
 950 {
 951         u_int8_t error_code;
 952 #define SSD_ERRCODE                     0x7F
 953 #define         SSD_CURRENT_ERROR       0x70
 954 #define         SSD_DEFERRED_ERROR      0x71
 955 #define SSD_ERRCODE_VALID       0x80
 956         u_int8_t segment;
 957         u_int8_t flags;
 958 #define SSD_KEY                         0x0F
 959 #define         SSD_KEY_NO_SENSE        0x00
 960 #define         SSD_KEY_RECOVERED_ERROR 0x01
 961 #define         SSD_KEY_NOT_READY       0x02
 962 #define         SSD_KEY_MEDIUM_ERROR    0x03
 963 #define         SSD_KEY_HARDWARE_ERROR  0x04
 964 #define         SSD_KEY_ILLEGAL_REQUEST 0x05
 965 #define         SSD_KEY_UNIT_ATTENTION  0x06
 966 #define         SSD_KEY_DATA_PROTECT    0x07
 967 #define         SSD_KEY_BLANK_CHECK     0x08
 968 #define         SSD_KEY_Vendor_Specific 0x09
 969 #define         SSD_KEY_COPY_ABORTED    0x0a
 970 #define         SSD_KEY_ABORTED_COMMAND 0x0b
 971 #define         SSD_KEY_EQUAL           0x0c
 972 #define         SSD_KEY_VOLUME_OVERFLOW 0x0d
 973 #define         SSD_KEY_MISCOMPARE      0x0e
 974 #define         SSD_KEY_RESERVED        0x0f
 975 #define SSD_ILI         0x20
 976 #define SSD_EOM         0x40
 977 #define SSD_FILEMARK    0x80
 978         u_int8_t info[4];
 979         u_int8_t extra_len;
 980         u_int8_t cmd_spec_info[4];
 981         u_int8_t add_sense_code;
 982         u_int8_t add_sense_code_qual;
 983         u_int8_t fru;
 984         u_int8_t sense_key_spec[3];
 985 #define SSD_SCS_VALID           0x80
 986 #define SSD_FIELDPTR_CMD        0x40
 987 #define SSD_BITPTR_VALID        0x08
 988 #define SSD_BITPTR_VALUE        0x07
 989 #define SSD_MIN_SIZE 18
 990         u_int8_t extra_bytes[14];
 991 #define SSD_FULL_SIZE sizeof(struct scsi_sense_data)
 992 };
 993
 994 struct scsi_mode_header_6
 995 {
 996         u_int8_t data_length;   /* Sense data length */
 997         u_int8_t medium_type;
 998         u_int8_t dev_spec;
 999         u_int8_t blk_desc_len;
1000 };
1001
1002 struct scsi_mode_header_10
1003 {
1004         u_int8_t data_length[2];/* Sense data length */
1005         u_int8_t medium_type;
1006         u_int8_t dev_spec;
1007         u_int8_t unused[2];
1008         u_int8_t blk_desc_len[2];
1009 };
1010
1011 struct scsi_mode_page_header
1012 {
1013         u_int8_t page_code;
1014         u_int8_t page_length;
1015 };
1016
1017 struct scsi_mode_blk_desc
1018 {
1019         u_int8_t density;
1020         u_int8_t nblocks[3];
1021         u_int8_t reserved;
1022         u_int8_t blklen[3];
1023 };
1024
1025 #define SCSI_DEFAULT_DENSITY    0x00    /* use 'default' density */
1026 #define SCSI_SAME_DENSITY       0x7f    /* use 'same' density- >= SCSI-2 only */
1027
1028
1029 /*
1030  * Status Byte
1031  */
1032 #define SCSI_STATUS_OK                  0x00
1033 #define SCSI_STATUS_CHECK_COND          0x02
1034 #define SCSI_STATUS_COND_MET            0x04
1035 #define SCSI_STATUS_BUSY                0x08
1036 #define SCSI_STATUS_INTERMED            0x10
1037 #define SCSI_STATUS_INTERMED_COND_MET   0x14
1038 #define SCSI_STATUS_RESERV_CONFLICT     0x18
1039 #define SCSI_STATUS_CMD_TERMINATED      0x22    /* Obsolete in SAM-2 */
1040 #define SCSI_STATUS_QUEUE_FULL          0x28
1041 #define SCSI_STATUS_ACA_ACTIVE          0x30
1042 #define SCSI_STATUS_TASK_ABORTED        0x40
1043
1044 struct scsi_inquiry_pattern {
1045         u_int8_t   type;
1046         u_int8_t   media_type;
1047 #define SIP_MEDIA_REMOVABLE     0x01
1048 #define SIP_MEDIA_FIXED         0x02
1049         const char *vendor;
1050         const char *product;
1051         const char *revision;
1052 };
1053
1054 struct scsi_static_inquiry_pattern {
1055         u_int8_t   type;
1056         u_int8_t   media_type;
1057         char       vendor[SID_VENDOR_SIZE+1];
1058         char       product[SID_PRODUCT_SIZE+1];
1059         char       revision[SID_REVISION_SIZE+1];
1060 };
1061
1062 struct scsi_sense_quirk_entry {
1063         struct scsi_inquiry_pattern     inq_pat;
1064         int                             num_sense_keys;
1065         int                             num_ascs;
1066         struct sense_key_table_entry    *sense_key_info;
1067         struct asc_table_entry          *asc_info;
1068 };
1069
1070 struct sense_key_table_entry {
1071         u_int8_t    sense_key;
1072         u_int32_t   action;
1073         const char *desc;
1074 };
1075
1076 struct asc_table_entry {
1077         u_int8_t    asc;
1078         u_int8_t    ascq;
1079         u_int32_t   action;
1080         const char *desc;
1081 };
1082
1083 struct op_table_entry {
1084         u_int8_t    opcode;
1085         u_int32_t   opmask;
1086         const char  *desc;
1087 };
1088
1089 struct scsi_op_quirk_entry {
1090         struct scsi_inquiry_pattern     inq_pat;
1091         int                             num_ops;
1092         struct op_table_entry           *op_table;
1093 };
1094
1095 typedef enum {
1096         SSS_FLAG_NONE           = 0x00,
1097         SSS_FLAG_PRINT_COMMAND  = 0x01
1098 } scsi_sense_string_flags;
1099
1100 struct ccb_scsiio;
1101 struct cam_periph;
1102 union  ccb;
1103 #ifndef _KERNEL
1104 struct cam_device;
1105 #endif
1106
1107 extern const char *scsi_sense_key_text[];
1108
1109 struct sbuf;
1110
1111 __BEGIN_DECLS
1112 void scsi_sense_desc(int sense_key, int asc, int ascq,
1113                      struct scsi_inquiry_data *inq_data,
1114                      const char **sense_key_desc, const char **asc_desc);
1115 scsi_sense_action scsi_error_action(struct ccb_scsiio* csio,
1116                                     struct scsi_inquiry_data *inq_data,
1117                                     u_int32_t sense_flags);
1118 const char *    scsi_status_string(struct ccb_scsiio *csio);
1119 #ifdef _KERNEL
1120 int             scsi_command_string(struct ccb_scsiio *csio, struct sbuf *sb);
1121 int             scsi_sense_sbuf(struct ccb_scsiio *csio, struct sbuf *sb,
1122                                 scsi_sense_string_flags flags);
1123 char *          scsi_sense_string(struct ccb_scsiio *csio,
1124                                   char *str, int str_len);
1125 void            scsi_sense_print(struct ccb_scsiio *csio);
1126 int             scsi_interpret_sense(union ccb *ccb,
1127                                      u_int32_t sense_flags,
1128                                      u_int32_t *relsim_flags,
1129                                      u_int32_t *reduction,
1130                                      u_int32_t *timeout,
1131                                      scsi_sense_action error_action);
1132 #else /* _KERNEL */
1133 int             scsi_command_string(struct cam_device *device,
1134                                     struct ccb_scsiio *csio, struct sbuf *sb);
1135 int             scsi_sense_sbuf(struct cam_device *device,
1136                                 struct ccb_scsiio *csio, struct sbuf *sb,
1137                                 scsi_sense_string_flags flags);
1138 char *          scsi_sense_string(struct cam_device *device,
1139                                   struct ccb_scsiio *csio,
1140                                   char *str, int str_len);
1141 void            scsi_sense_print(struct cam_device *device,
1142                                  struct ccb_scsiio *csio, FILE *ofile);
1143 int             scsi_interpret_sense(struct cam_device *device,
1144                                      union ccb *ccb,
1145                                      u_int32_t sense_flags,
1146                                      u_int32_t *relsim_flags,
1147                                      u_int32_t *reduction,
1148                                      u_int32_t *timeout,
1149                                      scsi_sense_action error_action);
1150 #endif /* _KERNEL */
1151
1152 #define SF_RETRY_UA     0x01
1153 #define SF_NO_PRINT     0x02
1154 #define SF_QUIET_IR     0x04    /* Be quiet about Illegal Request reponses */
1155 #define SF_PRINT_ALWAYS 0x08
1156
1157
1158 const char *    scsi_op_desc(u_int16_t opcode,
1159                              struct scsi_inquiry_data *inq_data);
1160 char *          scsi_cdb_string(u_int8_t *cdb_ptr, char *cdb_string,
1161                                 size_t len);
1162
1163 void            scsi_print_inquiry(struct scsi_inquiry_data *inq_data);
1164
1165 u_int           scsi_calc_syncsrate(u_int period_factor);
1166 u_int           scsi_calc_syncparam(u_int period);
1167
1168 void            scsi_test_unit_ready(struct ccb_scsiio *csio, u_int32_t retries,
1169                                      void (*cbfcnp)(struct cam_periph *,
1170                                                     union ccb *),
1171                                      u_int8_t tag_action,
1172                                      u_int8_t sense_len, u_int32_t timeout);
1173
1174 void            scsi_request_sense(struct ccb_scsiio *csio, u_int32_t retries,
1175                                    void (*cbfcnp)(struct cam_periph *,
1176                                                   union ccb *),
1177                                    void *data_ptr, u_int8_t dxfer_len,
1178                                    u_int8_t tag_action, u_int8_t sense_len,
1179                                    u_int32_t timeout);
1180
1181 void            scsi_inquiry(struct ccb_scsiio *csio, u_int32_t retries,
1182                              void (*cbfcnp)(struct cam_periph *, union ccb *),
1183                              u_int8_t tag_action, u_int8_t *inq_buf,
1184                              u_int32_t inq_len, int evpd, u_int8_t page_code,
1185                              u_int8_t sense_len, u_int32_t timeout);
1186
1187 void            scsi_mode_sense(struct ccb_scsiio *csio, u_int32_t retries,
1188                                 void (*cbfcnp)(struct cam_periph *,
1189                                                union ccb *),
1190                                 u_int8_t tag_action, int dbd,
1191                                 u_int8_t page_code, u_int8_t page,
1192                                 u_int8_t *param_buf, u_int32_t param_len,
1193                                 u_int8_t sense_len, u_int32_t timeout);
1194
1195 void            scsi_mode_sense_len(struct ccb_scsiio *csio, u_int32_t retries,
1196                                     void (*cbfcnp)(struct cam_periph *,
1197                                                    union ccb *),
1198                                     u_int8_t tag_action, int dbd,
1199                                     u_int8_t page_code, u_int8_t page,
1200                                     u_int8_t *param_buf, u_int32_t param_len,
1201                                     int minimum_cmd_size, u_int8_t sense_len,
1202                                     u_int32_t timeout);
1203
1204 void            scsi_mode_select(struct ccb_scsiio *csio, u_int32_t retries,
1205                                  void (*cbfcnp)(struct cam_periph *,
1206                                                 union ccb *),
1207                                  u_int8_t tag_action, int scsi_page_fmt,
1208                                  int save_pages, u_int8_t *param_buf,
1209                                  u_int32_t param_len, u_int8_t sense_len,
1210                                  u_int32_t timeout);
1211
1212 void            scsi_mode_select_len(struct ccb_scsiio *csio, u_int32_t retries,
1213                                      void (*cbfcnp)(struct cam_periph *,
1214                                                     union ccb *),
1215                                      u_int8_t tag_action, int scsi_page_fmt,
1216                                      int save_pages, u_int8_t *param_buf,
1217                                      u_int32_t param_len, int minimum_cmd_size,
1218                                      u_int8_t sense_len, u_int32_t timeout);
1219
1220 void            scsi_log_sense(struct ccb_scsiio *csio, u_int32_t retries,
1221                                void (*cbfcnp)(struct cam_periph *, union ccb *),
1222                                u_int8_t tag_action, u_int8_t page_code,
1223                                u_int8_t page, int save_pages, int ppc,
1224                                u_int32_t paramptr, u_int8_t *param_buf,
1225                                u_int32_t param_len, u_int8_t sense_len,
1226                                u_int32_t timeout);
1227
1228 void            scsi_log_select(struct ccb_scsiio *csio, u_int32_t retries,
1229                                 void (*cbfcnp)(struct cam_periph *,
1230                                 union ccb *), u_int8_t tag_action,
1231                                 u_int8_t page_code, int save_pages,
1232                                 int pc_reset, u_int8_t *param_buf,
1233                                 u_int32_t param_len, u_int8_t sense_len,
1234                                 u_int32_t timeout);
1235
1236 void            scsi_prevent(struct ccb_scsiio *csio, u_int32_t retries,
1237                              void (*cbfcnp)(struct cam_periph *, union ccb *),
1238                              u_int8_t tag_action, u_int8_t action,
1239                              u_int8_t sense_len, u_int32_t timeout);
1240
1241 void            scsi_read_capacity(struct ccb_scsiio *csio, u_int32_t retries,
1242                                    void (*cbfcnp)(struct cam_periph *,
1243                                    union ccb *), u_int8_t tag_action,
1244                                    struct scsi_read_capacity_data *,
1245                                    u_int8_t sense_len, u_int32_t timeout);
1246 void            scsi_read_capacity_16(struct ccb_scsiio *csio, uint32_t retries,
1247                                       void (*cbfcnp)(struct cam_periph *,
1248                                       union ccb *), uint8_t tag_action,
1249                                       uint64_t lba, int reladr, int pmi,
1250                                       struct scsi_read_capacity_data_long
1251                                       *rcap_buf, uint8_t sense_len,
1252                                       uint32_t timeout);
1253
1254 void            scsi_report_luns(struct ccb_scsiio *csio, u_int32_t retries,
1255                                  void (*cbfcnp)(struct cam_periph *,
1256                                  union ccb *), u_int8_t tag_action,
1257                                  u_int8_t select_report,
1258                                  struct scsi_report_luns_data *rpl_buf,
1259                                  u_int32_t alloc_len, u_int8_t sense_len,
1260                                  u_int32_t timeout);
1261
1262 void            scsi_report_target_group(struct ccb_scsiio *csio, u_int32_t retries,
1263                                  void (*cbfcnp)(struct cam_periph *,
1264                                  union ccb *), u_int8_t tag_action,
1265                                  u_int8_t pdf,
1266                                  void *buf,
1267                                  u_int32_t alloc_len, u_int8_t sense_len,
1268                                  u_int32_t timeout);
1269
1270 void            scsi_set_target_group(struct ccb_scsiio *csio, u_int32_t retries,
1271                                  void (*cbfcnp)(struct cam_periph *,
1272                                  union ccb *), u_int8_t tag_action, void *buf,
1273                                  u_int32_t alloc_len, u_int8_t sense_len,
1274                                  u_int32_t timeout);
1275
1276 void            scsi_synchronize_cache(struct ccb_scsiio *csio,
1277                                        u_int32_t retries,
1278                                        void (*cbfcnp)(struct cam_periph *,
1279                                        union ccb *), u_int8_t tag_action,
1280                                        u_int32_t begin_lba, u_int16_t lb_count,
1281                                        u_int8_t sense_len, u_int32_t timeout);
1282
1283 void scsi_read_write(struct ccb_scsiio *csio, u_int32_t retries,
1284                      void (*cbfcnp)(struct cam_periph *, union ccb *),
1285                      u_int8_t tag_action, int readop, u_int8_t byte2,
1286                      int minimum_cmd_size, u_int64_t lba,
1287                      u_int32_t block_count, u_int8_t *data_ptr,
1288                      u_int32_t dxfer_len, u_int8_t sense_len,
1289                      u_int32_t timeout);
1290
1291 void scsi_start_stop(struct ccb_scsiio *csio, u_int32_t retries,
1292                      void (*cbfcnp)(struct cam_periph *, union ccb *),
1293                      u_int8_t tag_action, int start, int load_eject,
1294                      int immediate, u_int8_t sense_len, u_int32_t timeout);
1295
1296 int             scsi_inquiry_match(caddr_t inqbuffer, caddr_t table_entry);
1297 int             scsi_static_inquiry_match(caddr_t inqbuffer,
1298                                           caddr_t table_entry);
1299
1300 static __inline void scsi_extract_sense(struct scsi_sense_data *sense,
1301                                         int *error_code, int *sense_key,
1302                                         int *asc, int *ascq);
1303 static __inline void scsi_ulto2b(u_int32_t val, u_int8_t *bytes);
1304 static __inline void scsi_ulto3b(u_int32_t val, u_int8_t *bytes);
1305 static __inline void scsi_ulto4b(u_int32_t val, u_int8_t *bytes);
1306 static __inline void scsi_u64to8b(u_int64_t val, u_int8_t *bytes);
1307 static __inline u_int32_t scsi_2btoul(u_int8_t *bytes);
1308 static __inline u_int32_t scsi_3btoul(u_int8_t *bytes);
1309 static __inline int32_t scsi_3btol(u_int8_t *bytes);
1310 static __inline u_int32_t scsi_4btoul(u_int8_t *bytes);
1311 static __inline u_int64_t scsi_8btou64(u_int8_t *bytes);
1312 static __inline void *find_mode_page_6(struct scsi_mode_header_6 *mode_header);
1313 static __inline void *find_mode_page_10(struct scsi_mode_header_10 *mode_header);
1314
1315 static __inline void scsi_extract_sense(struct scsi_sense_data *sense,
1316                                         int *error_code, int *sense_key,
1317                                         int *asc, int *ascq)
1318 {
1319         *error_code = sense->error_code & SSD_ERRCODE;
1320         *sense_key = sense->flags & SSD_KEY;
1321         *asc = (sense->extra_len >= 5) ? sense->add_sense_code : 0;
1322         *ascq = (sense->extra_len >= 6) ? sense->add_sense_code_qual : 0;
1323 }
1324
1325 static __inline void
1326 scsi_ulto2b(u_int32_t val, u_int8_t *bytes)
1327 {
1328
1329         bytes[0] = (val >> 8) & 0xff;
1330         bytes[1] = val & 0xff;
1331 }
1332
1333 static __inline void
1334 scsi_ulto3b(u_int32_t val, u_int8_t *bytes)
1335 {
1336
1337         bytes[0] = (val >> 16) & 0xff;
1338         bytes[1] = (val >> 8) & 0xff;
1339         bytes[2] = val & 0xff;
1340 }
1341
1342 static __inline void
1343 scsi_ulto4b(u_int32_t val, u_int8_t *bytes)
1344 {
1345
1346         bytes[0] = (val >> 24) & 0xff;
1347         bytes[1] = (val >> 16) & 0xff;
1348         bytes[2] = (val >> 8) & 0xff;
1349         bytes[3] = val & 0xff;
1350 }
1351
1352 static __inline void
1353 scsi_u64to8b(u_int64_t val, u_int8_t *bytes)
1354 {
1355
1356         bytes[0] = (val >> 56) & 0xff;
1357         bytes[1] = (val >> 48) & 0xff;
1358         bytes[2] = (val >> 40) & 0xff;
1359         bytes[3] = (val >> 32) & 0xff;
1360         bytes[4] = (val >> 24) & 0xff;
1361         bytes[5] = (val >> 16) & 0xff;
1362         bytes[6] = (val >> 8) & 0xff;
1363         bytes[7] = val & 0xff;
1364 }
1365
1366 static __inline u_int32_t
1367 scsi_2btoul(u_int8_t *bytes)
1368 {
1369         u_int32_t rv;
1370
1371         rv = (bytes[0] << 8) |
1372              bytes[1];
1373         return (rv);
1374 }
1375
1376 static __inline u_int32_t
1377 scsi_3btoul(u_int8_t *bytes)
1378 {
1379         u_int32_t rv;
1380
1381         rv = (bytes[0] << 16) |
1382              (bytes[1] << 8) |
1383              bytes[2];
1384         return (rv);
1385 }
1386
1387 static __inline int32_t
1388 scsi_3btol(u_int8_t *bytes)
1389 {
1390         u_int32_t rc = scsi_3btoul(bytes);
1391
1392         if (rc & 0x00800000)
1393                 rc |= 0xff000000;
1394
1395         return (int32_t) rc;
1396 }
1397
1398 static __inline u_int32_t
1399 scsi_4btoul(u_int8_t *bytes)
1400 {
1401         u_int32_t rv;
1402
1403         rv = (bytes[0] << 24) |
1404              (bytes[1] << 16) |
1405              (bytes[2] << 8) |
1406              bytes[3];
1407         return (rv);
1408 }
1409
1410 static __inline uint64_t
1411 scsi_8btou64(uint8_t *bytes)
1412 {
1413         uint64_t rv;
1414
1415         rv = (((uint64_t)bytes[0]) << 56) |
1416              (((uint64_t)bytes[1]) << 48) |
1417              (((uint64_t)bytes[2]) << 40) |
1418              (((uint64_t)bytes[3]) << 32) |
1419              (((uint64_t)bytes[4]) << 24) |
1420              (((uint64_t)bytes[5]) << 16) |
1421              (((uint64_t)bytes[6]) << 8) |
1422              bytes[7];
1423         return (rv);
1424 }
1425
1426 /*
1427  * Given the pointer to a returned mode sense buffer, return a pointer to
1428  * the start of the first mode page.
1429  */
1430 static __inline void *
1431 find_mode_page_6(struct scsi_mode_header_6 *mode_header)
1432 {
1433         void *page_start;
1434
1435         page_start = (void *)((u_int8_t *)&mode_header[1] +
1436                               mode_header->blk_desc_len);
1437
1438         return(page_start);
1439 }
1440
1441 static __inline void *
1442 find_mode_page_10(struct scsi_mode_header_10 *mode_header)
1443 {
1444         void *page_start;
1445
1446         page_start = (void *)((u_int8_t *)&mode_header[1] +
1447                                scsi_2btoul(mode_header->blk_desc_len));
1448
1449         return(page_start);
1450 }
1451
1452 __END_DECLS
1453
1454 #endif /*_SCSI_SCSI_ALL_H*/