sys/bus/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: src/sys/cam/scsi/scsi_all.h,v 1.14.2.5 2003/08/24 03:26:37 ken Exp $
  18  * $DragonFly: src/sys/bus/cam/scsi/scsi_all.h,v 1.7 2007/05/16 20:59:38 dillon Exp $
  19  */
  20
  21 /*
  22  * SCSI general  interface description
  23  */
  24
  25 #ifndef _SCSI_SCSI_ALL_H
  26 #define _SCSI_SCSI_ALL_H 1
  27
  28 #ifndef _SYS_CDEFS_H_
  29 #include <sys/cdefs.h>
  30 #endif
  31 #if !defined(_KERNEL) && !defined(_STDIO_H_)
  32 #include <stdio.h>      /* FILE for userland protos */
  33 #endif
  34
  35 #ifdef _KERNEL
  36 #include "opt_scsi.h"
  37 /*
  38  * This is the number of seconds we wait for devices to settle after a SCSI
  39  * bus reset.
  40  */
  41 #ifndef SCSI_DELAY
  42 #define SCSI_DELAY 2000
  43 #endif
  44 /*
  45  * If someone sets this to 0, we assume that they want the minimum
  46  * allowable bus settle delay.  All devices need _some_ sort of bus settle
  47  * delay, so we'll set it to a minimum value of 100ms.
  48  */
  49 #if (SCSI_DELAY == 0)
  50 #undef SCSI_DELAY
  51 #define SCSI_DELAY 100
  52 #endif
  53
  54 /*
  55  * Make sure the user isn't using seconds instead of milliseconds.
  56  */
  57 #if (SCSI_DELAY < 100)
  58 #error "SCSI_DELAY is in milliseconds, not seconds!  Please use a larger value"
  59 #endif
  60 #endif /* _KERNEL */
  61
  62 /*
  63  * SCSI command format
  64  */
  65
  66 /*
  67  * Define dome bits that are in ALL (or a lot of) scsi commands
  68  */
  69 #define SCSI_CTL_LINK           0x01
  70 #define SCSI_CTL_FLAG           0x02
  71 #define SCSI_CTL_VENDOR         0xC0
  72 #define SCSI_CMD_LUN            0xA0    /* these two should not be needed */
  73 #define SCSI_CMD_LUN_SHIFT      5       /* LUN in the cmd is no longer SCSI */
  74
  75 #define SCSI_MAX_CDBLEN         16      /*
  76                                          * 16 byte commands are in the
  77                                          * SCSI-3 spec
  78                                          */
  79 #if defined(CAM_MAX_CDBLEN) && (CAM_MAX_CDBLEN < SCSI_MAX_CDBLEN)
  80 #error "CAM_MAX_CDBLEN cannot be less than SCSI_MAX_CDBLEN"
  81 #endif
  82
  83 /* 6byte CDBs special case 0 length to be 256 */
  84 #define SCSI_CDB6_LEN(len)      ((len) == 0 ? 256 : len)
  85
  86 /*
  87  * This type defines actions to be taken when a particular sense code is
  88  * received.  Right now, these flags are only defined to take up 16 bits,
  89  * but can be expanded in the future if necessary.
  90  */
  91 typedef enum {
  92         SS_NOP      = 0x000000, /* Do nothing */
  93         SS_RETRY    = 0x010000, /* Retry the command */
  94         SS_FAIL     = 0x020000, /* Bail out */
  95         SS_START    = 0x030000, /* Send a Start Unit command to the device,
  96                                  * then retry the original command.
  97                                  */
  98         SS_TUR      = 0x040000, /* Send a Test Unit Ready command to the
  99                                  * device, then retry the original command.
 100                                  */
 101         SS_MANUAL   = 0x050000, /*
 102                                  * This error must be handled manually,
 103                                  * i.e. the code must look at the asc and
 104                                  * ascq values and determine the proper
 105                                  * course of action.
 106                                  */
 107         SS_TURSTART = 0x060000, /*
 108                                  * Send a Test Unit Ready command to the
 109                                  * device, and if that fails, send a start
 110                                  * unit.
 111                                  */
 112         SS_MASK     = 0xff0000
 113 } scsi_sense_action;
 114
 115 typedef enum {
 116         SSQ_NONE                = 0x0000,
 117         SSQ_DECREMENT_COUNT     = 0x0100,  /* Decrement the retry count */
 118         SSQ_MANY                = 0x0200,  /* send lots of recovery commands */
 119         SSQ_RANGE               = 0x0400,  /*
 120                                             * Yes, this is a hack.  Basically,
 121                                             * if this flag is set then it
 122                                             * represents an ascq range.  The
 123                                             * "correct" way to implement the
 124                                             * ranges might be to add a special
 125                                             * field to the sense code table,
 126                                             * but that would take up a lot of
 127                                             * additional space.  This solution
 128                                             * isn't as elegant, but is more
 129                                             * space efficient.
 130                                             */
 131         SSQ_PRINT_SENSE         = 0x0800,
 132         SSQ_MASK                = 0xff00
 133 } scsi_sense_action_qualifier;
 134
 135 /* Mask for error status values */
 136 #define SS_ERRMASK      0xff
 137
 138 /* The default error action */
 139 #define SS_DEF          SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE|EIO
 140
 141 /* Default error action, without an error return value */
 142 #define SS_NEDEF        SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE
 143
 144 /* Default error action, without sense printing or an error return value */
 145 #define SS_NEPDEF       SS_RETRY|SSQ_DECREMENT_COUNT
 146
 147 struct scsi_generic
 148 {
 149         u_int8_t opcode;
 150         u_int8_t bytes[11];
 151 };
 152
 153 struct scsi_request_sense
 154 {
 155         u_int8_t opcode;
 156         u_int8_t byte2;
 157         u_int8_t unused[2];
 158         u_int8_t length;
 159         u_int8_t control;
 160 };
 161
 162 struct scsi_test_unit_ready
 163 {
 164         u_int8_t opcode;
 165         u_int8_t byte2;
 166         u_int8_t unused[3];
 167         u_int8_t control;
 168 };
 169
 170 struct scsi_send_diag
 171 {
 172         u_int8_t opcode;
 173         u_int8_t byte2;
 174 #define SSD_UOL         0x01
 175 #define SSD_DOL         0x02
 176 #define SSD_SELFTEST    0x04
 177 #define SSD_PF          0x10
 178         u_int8_t unused[1];
 179         u_int8_t paramlen[2];
 180         u_int8_t control;
 181 };
 182
 183 struct scsi_sense
 184 {
 185         u_int8_t opcode;
 186         u_int8_t byte2;
 187         u_int8_t unused[2];
 188         u_int8_t length;
 189         u_int8_t control;
 190 };
 191
 192 struct scsi_inquiry
 193 {
 194         u_int8_t opcode;
 195         u_int8_t byte2;
 196 #define SI_EVPD 0x01
 197         u_int8_t page_code;
 198         u_int8_t reserved;
 199         u_int8_t length;
 200         u_int8_t control;
 201 };
 202
 203 struct scsi_mode_sense_6
 204 {
 205         u_int8_t opcode;
 206         u_int8_t byte2;
 207 #define SMS_DBD                         0x08
 208         u_int8_t page;
 209 #define SMS_PAGE_CODE                   0x3F
 210 #define SMS_VENDOR_SPECIFIC_PAGE        0x00
 211 #define SMS_DISCONNECT_RECONNECT_PAGE   0x02
 212 #define SMS_PERIPHERAL_DEVICE_PAGE      0x09
 213 #define SMS_CONTROL_MODE_PAGE           0x0A
 214 #define SMS_ALL_PAGES_PAGE              0x3F
 215 #define SMS_PAGE_CTRL_MASK              0xC0
 216 #define SMS_PAGE_CTRL_CURRENT           0x00
 217 #define SMS_PAGE_CTRL_CHANGEABLE        0x40
 218 #define SMS_PAGE_CTRL_DEFAULT           0x80
 219 #define SMS_PAGE_CTRL_SAVED             0xC0
 220         u_int8_t unused;
 221         u_int8_t length;
 222         u_int8_t control;
 223 };
 224
 225 struct scsi_mode_sense_10
 226 {
 227         u_int8_t opcode;
 228         u_int8_t byte2;         /* same bits as small version */
 229         u_int8_t page;          /* same bits as small version */
 230         u_int8_t unused[4];
 231         u_int8_t length[2];
 232         u_int8_t control;
 233 };
 234
 235 struct scsi_mode_select_6
 236 {
 237         u_int8_t opcode;
 238         u_int8_t byte2;
 239 #define SMS_SP  0x01
 240 #define SMS_PF  0x10
 241         u_int8_t unused[2];
 242         u_int8_t length;
 243         u_int8_t control;
 244 };
 245
 246 struct scsi_mode_select_10
 247 {
 248         u_int8_t opcode;
 249         u_int8_t byte2;         /* same bits as small version */
 250         u_int8_t unused[5];
 251         u_int8_t length[2];
 252         u_int8_t control;
 253 };
 254
 255 /*
 256  * When sending a mode select to a tape drive, the medium type must be 0.
 257  */
 258 struct scsi_mode_hdr_6
 259 {
 260         u_int8_t datalen;
 261         u_int8_t medium_type;
 262         u_int8_t dev_specific;
 263         u_int8_t block_descr_len;
 264 };
 265
 266 struct scsi_mode_hdr_10
 267 {
 268         u_int8_t datalen[2];
 269         u_int8_t medium_type;
 270         u_int8_t dev_specific;
 271         u_int8_t reserved[2];
 272         u_int8_t block_descr_len[2];
 273 };
 274
 275 struct scsi_mode_block_descr
 276 {
 277         u_int8_t density_code;
 278         u_int8_t num_blocks[3];
 279         u_int8_t reserved;
 280         u_int8_t block_len[3];
 281 };
 282
 283 struct scsi_control_page {
 284         u_int8_t page_code;
 285         u_int8_t page_length;
 286         u_int8_t rlec;
 287 #define SCB_RLEC                        0x01    /*Report Log Exception Cond*/
 288         u_int8_t queue_flags;
 289 #define SCP_QUEUE_ALG_MASK              0xF0
 290 #define SCP_QUEUE_ALG_RESTRICTED        0x00
 291 #define SCP_QUEUE_ALG_UNRESTRICTED      0x10
 292 #define SCP_QUEUE_ERR                   0x02    /*Queued I/O aborted for CACs*/
 293 #define SCP_QUEUE_DQUE                  0x01    /*Queued I/O disabled*/
 294         u_int8_t eca_and_aen;
 295 #define SCP_EECA                        0x80    /*Enable Extended CA*/
 296 #define SCP_RAENP                       0x04    /*Ready AEN Permission*/
 297 #define SCP_UAAENP                      0x02    /*UA AEN Permission*/
 298 #define SCP_EAENP                       0x01    /*Error AEN Permission*/
 299         u_int8_t reserved;
 300         u_int8_t aen_holdoff_period[2];
 301 };
 302
 303 struct scsi_reserve
 304 {
 305         u_int8_t opcode;
 306         u_int8_t byte2;
 307         u_int8_t unused[2];
 308         u_int8_t length;
 309         u_int8_t control;
 310 };
 311
 312 struct scsi_release
 313 {
 314         u_int8_t opcode;
 315         u_int8_t byte2;
 316         u_int8_t unused[2];
 317         u_int8_t length;
 318         u_int8_t control;
 319 };
 320
 321 struct scsi_prevent
 322 {
 323         u_int8_t opcode;
 324         u_int8_t byte2;
 325         u_int8_t unused[2];
 326         u_int8_t how;
 327         u_int8_t control;
 328 };
 329 #define PR_PREVENT 0x01
 330 #define PR_ALLOW   0x00
 331
 332 struct scsi_sync_cache
 333 {
 334         u_int8_t opcode;
 335         u_int8_t byte2;
 336         u_int8_t begin_lba[4];
 337         u_int8_t reserved;
 338         u_int8_t lb_count[2];
 339         u_int8_t control;
 340 };
 341
 342
 343 struct scsi_changedef
 344 {
 345         u_int8_t opcode;
 346         u_int8_t byte2;
 347         u_int8_t unused1;
 348         u_int8_t how;
 349         u_int8_t unused[4];
 350         u_int8_t datalen;
 351         u_int8_t control;
 352 };
 353
 354 struct scsi_read_buffer
 355 {
 356         u_int8_t opcode;
 357         u_int8_t byte2;
 358 #define RWB_MODE                0x07
 359 #define RWB_MODE_HDR_DATA       0x00
 360 #define RWB_MODE_DATA           0x02
 361 #define RWB_MODE_DOWNLOAD       0x04
 362 #define RWB_MODE_DOWNLOAD_SAVE  0x05
 363         u_int8_t buffer_id;
 364         u_int8_t offset[3];
 365         u_int8_t length[3];
 366         u_int8_t control;
 367 };
 368
 369 struct scsi_write_buffer
 370 {
 371         u_int8_t opcode;
 372         u_int8_t byte2;
 373         u_int8_t buffer_id;
 374         u_int8_t offset[3];
 375         u_int8_t length[3];
 376         u_int8_t control;
 377 };
 378
 379 struct scsi_rw_6
 380 {
 381         u_int8_t opcode;
 382         u_int8_t addr[3];
 383 /* only 5 bits are valid in the MSB address byte */
 384 #define SRW_TOPADDR     0x1F
 385         u_int8_t length;
 386         u_int8_t control;
 387 };
 388
 389 struct scsi_rw_10
 390 {
 391         u_int8_t opcode;
 392 #define SRW10_RELADDR   0x01
 393 /* EBP defined for WRITE(10) only */
 394 #define SRW10_EBP       0x04
 395 #define SRW10_FUA       0x08
 396 #define SRW10_DPO       0x10
 397         u_int8_t byte2;
 398         u_int8_t addr[4];
 399         u_int8_t reserved;
 400         u_int8_t length[2];
 401         u_int8_t control;
 402 };
 403
 404 struct scsi_rw_12
 405 {
 406         u_int8_t opcode;
 407 #define SRW12_RELADDR   0x01
 408 #define SRW12_FUA       0x08
 409 #define SRW12_DPO       0x10
 410         u_int8_t byte2;
 411         u_int8_t addr[4];
 412         u_int8_t length[4];
 413         u_int8_t reserved;
 414         u_int8_t control;
 415 };
 416
 417 struct scsi_rw_16
 418 {
 419         u_int8_t opcode;
 420 #define        SRW16_RELADDR   0x01
 421 #define        SRW16_FUA       0x08
 422 #define        SRW16_DPO       0x10
 423         u_int8_t byte2;
 424         u_int8_t addr[8];
 425         u_int8_t length[4];
 426         u_int8_t reserved;
 427         u_int8_t control;
 428 };
 429
 430
 431 struct scsi_start_stop_unit
 432 {
 433         u_int8_t opcode;
 434         u_int8_t byte2;
 435 #define SSS_IMMED               0x01
 436         u_int8_t reserved[2];
 437         u_int8_t how;
 438 #define SSS_START               0x01
 439 #define SSS_LOEJ                0x02
 440         u_int8_t control;
 441 };
 442
 443 #define SC_SCSI_1 0x01
 444 #define SC_SCSI_2 0x03
 445
 446 /*
 447  * Opcodes
 448  */
 449
 450 #define TEST_UNIT_READY         0x00
 451 #define REQUEST_SENSE           0x03
 452 #define READ_6                  0x08
 453 #define WRITE_6                 0x0a
 454 #define INQUIRY                 0x12
 455 #define MODE_SELECT_6           0x15
 456 #define MODE_SENSE_6            0x1a
 457 #define START_STOP_UNIT         0x1b
 458 #define START_STOP              0x1b
 459 #define RESERVE                 0x16
 460 #define RELEASE                 0x17
 461 #define RECEIVE_DIAGNOSTIC      0x1c
 462 #define SEND_DIAGNOSTIC         0x1d
 463 #define PREVENT_ALLOW           0x1e
 464 #define READ_CAPACITY           0x25
 465 #define READ_10                 0x28
 466 #define WRITE_10                0x2a
 467 #define POSITION_TO_ELEMENT     0x2b
 468 #define SYNCHRONIZE_CACHE       0x35
 469 #define WRITE_BUFFER            0x3b
 470 #define READ_BUFFER             0x3c
 471 #define CHANGE_DEFINITION       0x40
 472 #define MODE_SELECT_10          0x55
 473 #define MODE_SENSE_10           0x5A
 474 #define READ_16                 0x88
 475 #define WRITE_16                0x8a
 476 #define SERVICE_ACTION_IN       0x9e
 477 #define MOVE_MEDIUM             0xa5
 478 #define READ_12                 0xa8
 479 #define WRITE_12                0xaa
 480 #define READ_ELEMENT_STATUS     0xb8
 481
 482 /*
 483  * Device Types
 484  */
 485 #define T_DIRECT        0x00
 486 #define T_SEQUENTIAL    0x01
 487 #define T_PRINTER       0x02
 488 #define T_PROCESSOR     0x03
 489 #define T_WORM          0x04
 490 #define T_CDROM         0x05
 491 #define T_SCANNER       0x06
 492 #define T_OPTICAL       0x07
 493 #define T_CHANGER       0x08
 494 #define T_COMM          0x09
 495 #define T_ASC0          0x0a
 496 #define T_ASC1          0x0b
 497 #define T_STORARRAY     0x0c
 498 #define T_ENCLOSURE     0x0d
 499 #define T_RBC           0x0e
 500 #define T_OCRW          0x0f
 501 #define T_NODEVICE      0x1F
 502 #define T_ANY           0xFF    /* Used in Quirk table matches */
 503
 504 #define T_REMOV         1
 505 #define T_FIXED         0
 506
 507 /*
 508  * This length is the initial inquiry length used by the probe code, as
 509  * well as the legnth necessary for scsi_print_inquiry() to function
 510  * correctly.  If either use requires a different length in the future,
 511  * the two values should be de-coupled.
 512  */
 513 #define SHORT_INQUIRY_LENGTH    36
 514
 515 struct scsi_inquiry_data
 516 {
 517         u_int8_t device;
 518 #define SID_TYPE(inq_data) ((inq_data)->device & 0x1f)
 519 #define SID_QUAL(inq_data) (((inq_data)->device & 0xE0) >> 5)
 520 #define SID_QUAL_LU_CONNECTED   0x00    /* The specified peripheral device
 521                                          * type is currently connected to
 522                                          * logical unit.  If the target cannot
 523                                          * determine whether or not a physical
 524                                          * device is currently connected, it
 525                                          * shall also use this peripheral
 526                                          * qualifier when returning the INQUIRY
 527                                          * data.  This peripheral qualifier
 528                                          * does not mean that the device is
 529                                          * ready for access by the initiator.
 530                                          */
 531 #define SID_QUAL_LU_OFFLINE     0x01    /* The target is capable of supporting
 532                                          * the specified peripheral device type
 533                                          * on this logical unit; however, the
 534                                          * physical device is not currently
 535                                          * connected to this logical unit.
 536                                          */
 537 #define SID_QUAL_RSVD           0x02
 538 #define SID_QUAL_BAD_LU         0x03    /* The target is not capable of
 539                                          * supporting a physical device on
 540                                          * this logical unit. For this
 541                                          * peripheral qualifier the peripheral
 542                                          * device type shall be set to 1Fh to
 543                                          * provide compatibility with previous
 544                                          * versions of SCSI. All other
 545                                          * peripheral device type values are
 546                                          * reserved for this peripheral
 547                                          * qualifier.
 548                                          */
 549 #define SID_QUAL_IS_VENDOR_UNIQUE(inq_data) ((SID_QUAL(inq_data) & 0x08) != 0)
 550         u_int8_t dev_qual2;
 551 #define SID_QUAL2       0x7F
 552 #define SID_IS_REMOVABLE(inq_data) (((inq_data)->dev_qual2 & 0x80) != 0)
 553         u_int8_t version;
 554 #define SID_ANSI_REV(inq_data) ((inq_data)->version & 0x07)
 555 #define         SCSI_REV_0              0
 556 #define         SCSI_REV_CCS            1
 557 #define         SCSI_REV_2              2
 558 #define         SCSI_REV_3              3
 559 #define         SCSI_REV_SPC2           4
 560
 561 #define SID_ECMA        0x38
 562 #define SID_ISO         0xC0
 563         u_int8_t response_format;
 564 #define SID_AENC        0x80
 565 #define SID_TrmIOP      0x40
 566         u_int8_t additional_length;
 567         u_int8_t reserved[2];
 568         u_int8_t flags;
 569 #define SID_SftRe       0x01
 570 #define SID_CmdQue      0x02
 571 #define SID_Linked      0x08
 572 #define SID_Sync        0x10
 573 #define SID_WBus16      0x20
 574 #define SID_WBus32      0x40
 575 #define SID_RelAdr      0x80
 576 #define SID_VENDOR_SIZE   8
 577         char     vendor[SID_VENDOR_SIZE];
 578 #define SID_PRODUCT_SIZE  16
 579         char     product[SID_PRODUCT_SIZE];
 580 #define SID_REVISION_SIZE 4
 581         char     revision[SID_REVISION_SIZE];
 582         /*
 583          * The following fields were taken from SCSI Primary Commands - 2
 584          * (SPC-2) Revision 14, Dated 11 November 1999
 585          */
 586 #define SID_VENDOR_SPECIFIC_0_SIZE      20
 587         u_int8_t vendor_specific0[SID_VENDOR_SPECIFIC_0_SIZE];
 588         /*
 589          * An extension of SCSI Parallel Specific Values
 590          */
 591 #define SID_SPI_IUS             0x01
 592 #define SID_SPI_QAS             0x02
 593 #define SID_SPI_CLOCK_ST        0x00
 594 #define SID_SPI_CLOCK_DT        0x04
 595 #define SID_SPI_CLOCK_DT_ST     0x0C
 596         u_int8_t spi3data;
 597         u_int8_t reserved2;
 598         /*
 599          * Version Descriptors, stored 2 byte values.
 600          */
 601         u_int8_t version1[2];
 602         u_int8_t version2[2];
 603         u_int8_t version3[2];
 604         u_int8_t version4[2];
 605         u_int8_t version5[2];
 606         u_int8_t version6[2];
 607         u_int8_t version7[2];
 608         u_int8_t version8[2];
 609
 610         u_int8_t reserved3[22];
 611
 612 #define SID_VENDOR_SPECIFIC_1_SIZE      160
 613         u_int8_t vendor_specific1[SID_VENDOR_SPECIFIC_1_SIZE];
 614 };
 615
 616 struct scsi_vpd_unit_serial_number
 617 {
 618         u_int8_t device;
 619         u_int8_t page_code;
 620 #define SVPD_UNIT_SERIAL_NUMBER 0x80
 621         u_int8_t reserved;
 622         u_int8_t length; /* serial number length */
 623 #define SVPD_SERIAL_NUM_SIZE 251
 624         u_int8_t serial_num[SVPD_SERIAL_NUM_SIZE];
 625 };
 626
 627 struct scsi_read_capacity
 628 {
 629         u_int8_t opcode;
 630         u_int8_t byte2;
 631         u_int8_t addr[4];
 632         u_int8_t unused[3];
 633         u_int8_t control;
 634 };
 635
 636 struct scsi_read_capacity_16
 637 {
 638         uint8_t opcode;
 639 #define        SRC16_SERVICE_ACTION    0x10
 640         uint8_t service_action;
 641         uint8_t addr[8];
 642         uint8_t alloc_len[4];
 643 #define        SRC16_PMI               0x01
 644 #define        SRC16_RELADR            0x02
 645         uint8_t reladr;
 646         uint8_t control;
 647 };
 648
 649 struct scsi_read_capacity_data
 650 {
 651         u_int8_t addr[4];
 652         u_int8_t length[4];
 653 };
 654
 655 struct scsi_read_capacity_data_long
 656 {
 657         uint8_t addr[8];
 658         uint8_t length[4];
 659 };
 660
 661 struct scsi_sense_data
 662 {
 663         u_int8_t error_code;
 664 #define SSD_ERRCODE                     0x7F
 665 #define         SSD_CURRENT_ERROR       0x70
 666 #define         SSD_DEFERRED_ERROR      0x71
 667 #define SSD_ERRCODE_VALID       0x80
 668         u_int8_t segment;
 669         u_int8_t flags;
 670 #define SSD_KEY                         0x0F
 671 #define         SSD_KEY_NO_SENSE        0x00
 672 #define         SSD_KEY_RECOVERED_ERROR 0x01
 673 #define         SSD_KEY_NOT_READY       0x02
 674 #define         SSD_KEY_MEDIUM_ERROR    0x03
 675 #define         SSD_KEY_HARDWARE_ERROR  0x04
 676 #define         SSD_KEY_ILLEGAL_REQUEST 0x05
 677 #define         SSD_KEY_UNIT_ATTENTION  0x06
 678 #define         SSD_KEY_DATA_PROTECT    0x07
 679 #define         SSD_KEY_BLANK_CHECK     0x08
 680 #define         SSD_KEY_Vendor_Specific 0x09
 681 #define         SSD_KEY_COPY_ABORTED    0x0a
 682 #define         SSD_KEY_ABORTED_COMMAND 0x0b
 683 #define         SSD_KEY_EQUAL           0x0c
 684 #define         SSD_KEY_VOLUME_OVERFLOW 0x0d
 685 #define         SSD_KEY_MISCOMPARE      0x0e
 686 #define         SSD_KEY_RESERVED        0x0f
 687 #define SSD_ILI         0x20
 688 #define SSD_EOM         0x40
 689 #define SSD_FILEMARK    0x80
 690         u_int8_t info[4];
 691         u_int8_t extra_len;
 692         u_int8_t cmd_spec_info[4];
 693         u_int8_t add_sense_code;
 694         u_int8_t add_sense_code_qual;
 695         u_int8_t fru;
 696         u_int8_t sense_key_spec[3];
 697 #define SSD_SCS_VALID           0x80
 698 #define SSD_FIELDPTR_CMD        0x40
 699 #define SSD_BITPTR_VALID        0x08
 700 #define SSD_BITPTR_VALUE        0x07
 701 #define SSD_MIN_SIZE 18
 702         u_int8_t extra_bytes[14];
 703 #define SSD_FULL_SIZE sizeof(struct scsi_sense_data)
 704 };
 705
 706 struct scsi_mode_header_6
 707 {
 708         u_int8_t data_length;   /* Sense data length */
 709         u_int8_t medium_type;
 710         u_int8_t dev_spec;
 711         u_int8_t blk_desc_len;
 712 };
 713
 714 struct scsi_mode_header_10
 715 {
 716         u_int8_t data_length[2];/* Sense data length */
 717         u_int8_t medium_type;
 718         u_int8_t dev_spec;
 719         u_int8_t unused[2];
 720         u_int8_t blk_desc_len[2];
 721 };
 722
 723 struct scsi_mode_page_header
 724 {
 725         u_int8_t page_code;
 726         u_int8_t page_length;
 727 };
 728
 729 struct scsi_mode_blk_desc
 730 {
 731         u_int8_t density;
 732         u_int8_t nblocks[3];
 733         u_int8_t reserved;
 734         u_int8_t blklen[3];
 735 };
 736
 737 #define SCSI_DEFAULT_DENSITY    0x00    /* use 'default' density */
 738 #define SCSI_SAME_DENSITY       0x7f    /* use 'same' density- >= SCSI-2 only */
 739 /*
 740  * Status Byte
 741  */
 742 #define SCSI_STATUS_OK                  0x00
 743 #define SCSI_STATUS_CHECK_COND          0x02
 744 #define SCSI_STATUS_COND_MET            0x04
 745 #define SCSI_STATUS_BUSY                0x08
 746 #define SCSI_STATUS_INTERMED            0x10
 747 #define SCSI_STATUS_INTERMED_COND_MET   0x14
 748 #define SCSI_STATUS_RESERV_CONFLICT     0x18
 749 #define SCSI_STATUS_CMD_TERMINATED      0x22
 750 #define SCSI_STATUS_QUEUE_FULL          0x28
 751
 752 struct scsi_inquiry_pattern {
 753         u_int8_t   type;
 754         u_int8_t   media_type;
 755 #define SIP_MEDIA_REMOVABLE     0x01
 756 #define SIP_MEDIA_FIXED         0x02
 757         const char *vendor;
 758         const char *product;
 759         const char *revision;
 760 };
 761
 762 struct scsi_static_inquiry_pattern {
 763         u_int8_t   type;
 764         u_int8_t   media_type;
 765         char       vendor[SID_VENDOR_SIZE+1];
 766         char       product[SID_PRODUCT_SIZE+1];
 767         char       revision[SID_REVISION_SIZE+1];
 768 };
 769
 770 struct scsi_sense_quirk_entry {
 771         struct scsi_inquiry_pattern     inq_pat;
 772         int                             num_ascs;
 773         struct asc_table_entry          *asc_info;
 774 };
 775
 776 struct asc_table_entry {
 777         u_int8_t    asc;
 778         u_int8_t    ascq;
 779         u_int32_t   action;
 780 #if !defined(SCSI_NO_SENSE_STRINGS)
 781         const char *desc;
 782 #endif
 783 };
 784
 785 struct op_table_entry {
 786         u_int8_t    opcode;
 787         u_int16_t   opmask;
 788         const char  *desc;
 789 };
 790
 791 struct scsi_op_quirk_entry {
 792         struct scsi_inquiry_pattern     inq_pat;
 793         int                             num_ops;
 794         struct op_table_entry           *op_table;
 795 };
 796
 797
 798 struct ccb_scsiio;
 799 struct cam_periph;
 800 union  ccb;
 801 #ifndef _KERNEL
 802 struct cam_device;
 803 #endif
 804
 805 extern const char *scsi_sense_key_text[];
 806
 807 __BEGIN_DECLS
 808 const char *    scsi_sense_desc(int asc, int ascq,
 809                                 struct scsi_inquiry_data *inq_data);
 810 scsi_sense_action scsi_error_action(int asc, int ascq,
 811                                     struct scsi_inquiry_data *inq_data);
 812 #ifdef _KERNEL
 813
 814 void            scsi_sense_print(struct ccb_scsiio *csio);
 815 int             scsi_interpret_sense(union ccb *ccb,
 816                                      u_int32_t sense_flags,
 817                                      u_int32_t *relsim_flags,
 818                                      u_int32_t *reduction,
 819                                      u_int32_t *timeout,
 820                                      scsi_sense_action error_action);
 821 #else
 822
 823 char *          scsi_sense_string(struct cam_device *device,
 824                                   struct ccb_scsiio *csio,
 825                                   char *str, int str_len);
 826 void            scsi_sense_print(struct cam_device *device,
 827                                  struct ccb_scsiio *csio, FILE *ofile);
 828 int             scsi_interpret_sense(struct cam_device *device,
 829                                      union ccb *ccb,
 830                                      u_int32_t sense_flags,
 831                                      u_int32_t *relsim_flags,
 832                                      u_int32_t *reduction,
 833                                      u_int32_t *timeout,
 834                                      scsi_sense_action error_action);
 835 #endif /* _KERNEL */
 836
 837 #define SF_RETRY_UA     0x01
 838 #define SF_NO_PRINT     0x02
 839 #define SF_QUIET_IR     0x04    /* Be quiet about Illegal Request reponses */
 840 #define SF_PRINT_ALWAYS 0x08
 841 #define SF_RETRY_SELTO  0x10    /* Retry selection timeouts */
 842
 843
 844 const char *    scsi_op_desc(u_int16_t opcode,
 845                              struct scsi_inquiry_data *inq_data);
 846 char *          scsi_cdb_string(u_int8_t *cdb_ptr, char *cdb_string,
 847                                 size_t len);
 848
 849 void            scsi_print_inquiry(struct scsi_inquiry_data *inq_data);
 850
 851 u_int           scsi_calc_syncsrate(u_int period_factor);
 852 u_int           scsi_calc_syncparam(u_int period);
 853
 854 void            scsi_test_unit_ready(struct ccb_scsiio *csio, u_int32_t retries,
 855                                      void (*cbfcnp)(struct cam_periph *,
 856                                                     union ccb *),
 857                                      u_int8_t tag_action,
 858                                      u_int8_t sense_len, u_int32_t timeout);
 859
 860 void            scsi_request_sense(struct ccb_scsiio *csio, u_int32_t retries,
 861                                    void (*cbfcnp)(struct cam_periph *,
 862                                                   union ccb *),
 863                                    void *data_ptr, u_int8_t dxfer_len,
 864                                    u_int8_t tag_action, u_int8_t sense_len,
 865                                    u_int32_t timeout);
 866
 867 void            scsi_inquiry(struct ccb_scsiio *csio, u_int32_t retries,
 868                              void (*cbfcnp)(struct cam_periph *, union ccb *),
 869                              u_int8_t tag_action, u_int8_t *inq_buf,
 870                              u_int32_t inq_len, int evpd, u_int8_t page_code,
 871                              u_int8_t sense_len, u_int32_t timeout);
 872
 873 void            scsi_mode_sense(struct ccb_scsiio *csio, u_int32_t retries,
 874                                 void (*cbfcnp)(struct cam_periph *,
 875                                                union ccb *),
 876                                 u_int8_t tag_action, int dbd,
 877                                 u_int8_t page_code, u_int8_t page,
 878                                 u_int8_t *param_buf, u_int32_t param_len,
 879                                 u_int8_t sense_len, u_int32_t timeout);
 880 void            scsi_mode_sense_len(struct ccb_scsiio *csio, u_int32_t retries,
 881                                 void (*cbfcnp)(struct cam_periph *,
 882                                                 union ccb *),
 883                                 u_int8_t tag_action, int dbd,
 884                                 u_int8_t page_code, u_int8_t page,
 885                                 u_int8_t *param_buf, u_int32_t param_len,
 886                                 int minimum_cmd_size, u_int8_t sense_len,
 887                                 u_int32_t timeout);
 888
 889 void            scsi_mode_select(struct ccb_scsiio *csio, u_int32_t retries,
 890                                  void (*cbfcnp)(struct cam_periph *,
 891                                                 union ccb *),
 892                                  u_int8_t tag_action, int scsi_page_fmt,
 893                                  int save_pages, u_int8_t *param_buf,
 894                                  u_int32_t param_len, u_int8_t sense_len,
 895                                  u_int32_t timeout);
 896
 897 void            scsi_mode_select_len(struct ccb_scsiio *csio, u_int32_t retries,
 898                                 void (*cbfcnp)(struct cam_periph *,
 899                                                 union ccb *),
 900                                 u_int8_t tag_action, int scsi_page_fmt,
 901                                 int save_pages, u_int8_t *param_buf,
 902                                 u_int32_t param_len, int minimum_cmd_size,
 903                                 u_int8_t sense_len, u_int32_t timeout);
 904
 905 void            scsi_read_capacity(struct ccb_scsiio *csio, u_int32_t retries,
 906                                    void (*cbfcnp)(struct cam_periph *,
 907                                    union ccb *), u_int8_t tag_action,
 908                                    struct scsi_read_capacity_data *rcap_buf,
 909                                    u_int8_t sense_len, u_int32_t timeout);
 910 void            scsi_read_capacity_16(struct ccb_scsiio *csio, uint32_t retries,
 911                                     void (*cbfcnp)(struct cam_periph *,
 912                                     union ccb *), uint8_t tag_action,
 913                                     uint64_t lba, int reladr, int pmi,
 914                                     struct scsi_read_capacity_data_long
 915                                     *rcap_buf, uint8_t sense_len,
 916                                     uint32_t timeout);
 917
 918 void            scsi_prevent(struct ccb_scsiio *csio, u_int32_t retries,
 919                              void (*cbfcnp)(struct cam_periph *, union ccb *),
 920                              u_int8_t tag_action, u_int8_t action,
 921                              u_int8_t sense_len, u_int32_t timeout);
 922
 923 void            scsi_synchronize_cache(struct ccb_scsiio *csio,
 924                                        u_int32_t retries,
 925                                        void (*cbfcnp)(struct cam_periph *,
 926                                        union ccb *), u_int8_t tag_action,
 927                                        u_int32_t begin_lba, u_int16_t lb_count,
 928                                        u_int8_t sense_len, u_int32_t timeout);
 929
 930 void scsi_read_write(struct ccb_scsiio *csio, u_int32_t retries,
 931                      void (*cbfcnp)(struct cam_periph *, union ccb *),
 932                      u_int8_t tag_action, int readop, u_int8_t byte2,
 933                      int minimum_cmd_size, u_int64_t lba,
 934                      u_int32_t block_count, u_int8_t *data_ptr,
 935                      u_int32_t dxfer_len, u_int8_t sense_len,
 936                      u_int32_t timeout);
 937
 938 void scsi_start_stop(struct ccb_scsiio *csio, u_int32_t retries,
 939                      void (*cbfcnp)(struct cam_periph *, union ccb *),
 940                      u_int8_t tag_action, int start, int load_eject,
 941                      int immediate, u_int8_t sense_len, u_int32_t timeout);
 942
 943 int             scsi_inquiry_match(caddr_t inqbuffer, caddr_t table_entry);
 944 int             scsi_static_inquiry_match(caddr_t inqbuffer,
 945                                           caddr_t table_entry);
 946
 947 static __inline void scsi_extract_sense(struct scsi_sense_data *sense,
 948                                         int *error_code, int *sense_key,
 949                                         int *asc, int *ascq);
 950 static __inline void scsi_ulto2b(u_int32_t val, u_int8_t *bytes);
 951 static __inline void scsi_ulto3b(u_int32_t val, u_int8_t *bytes);
 952 static __inline void scsi_ulto4b(u_int32_t val, u_int8_t *bytes);
 953 static __inline void scsi_u64to8b(u_int64_t val, u_int8_t *bytes);
 954 static __inline u_int32_t scsi_2btoul(u_int8_t *bytes);
 955 static __inline u_int32_t scsi_3btoul(u_int8_t *bytes);
 956 static __inline int32_t scsi_3btol(u_int8_t *bytes);
 957 static __inline u_int32_t scsi_4btoul(u_int8_t *bytes);
 958 static __inline u_int64_t scsi_8btou64(u_int8_t *bytes);
 959 static __inline void *find_mode_page_6(struct scsi_mode_header_6 *mode_header);
 960 static __inline void *find_mode_page_10(struct scsi_mode_header_10 *mode_header);
 961
 962 static __inline void
 963 scsi_extract_sense(struct scsi_sense_data *sense, int *error_code,
 964                    int *sense_key, int *asc, int *ascq)
 965 {
 966         *error_code = sense->error_code & SSD_ERRCODE;
 967         *sense_key = sense->flags & SSD_KEY;
 968         *asc = (sense->extra_len >= 5) ? sense->add_sense_code : 0;
 969         *ascq = (sense->extra_len >= 6) ? sense->add_sense_code_qual : 0;
 970 }
 971
 972 static __inline void
 973 scsi_ulto2b(u_int32_t val, u_int8_t *bytes)
 974 {
 975
 976         bytes[0] = (val >> 8) & 0xff;
 977         bytes[1] = val & 0xff;
 978 }
 979
 980 static __inline void
 981 scsi_ulto3b(u_int32_t val, u_int8_t *bytes)
 982 {
 983
 984         bytes[0] = (val >> 16) & 0xff;
 985         bytes[1] = (val >> 8) & 0xff;
 986         bytes[2] = val & 0xff;
 987 }
 988
 989 static __inline void
 990 scsi_ulto4b(u_int32_t val, u_int8_t *bytes)
 991 {
 992
 993         bytes[0] = (val >> 24) & 0xff;
 994         bytes[1] = (val >> 16) & 0xff;
 995         bytes[2] = (val >> 8) & 0xff;
 996         bytes[3] = val & 0xff;
 997 }
 998
 999 static __inline void
1000 scsi_u64to8b(u_int64_t val, u_int8_t *bytes)
1001 {
1002         bytes[0] = (val >> 56) & 0xff;
1003         bytes[1] = (val >> 48) & 0xff;
1004         bytes[2] = (val >> 40) & 0xff;
1005         bytes[3] = (val >> 32) & 0xff;
1006         bytes[4] = (val >> 24) & 0xff;
1007         bytes[5] = (val >> 16) & 0xff;
1008         bytes[6] = (val >> 8) & 0xff;
1009         bytes[7] = val & 0xff;
1010 }
1011
1012 static __inline u_int32_t
1013 scsi_2btoul(u_int8_t *bytes)
1014 {
1015         u_int32_t rv;
1016
1017         rv = (bytes[0] << 8) |
1018              bytes[1];
1019         return (rv);
1020 }
1021
1022 static __inline uint64_t
1023 scsi_8btou64(uint8_t *bytes)
1024 {
1025         uint64_t rv;
1026
1027         rv = (((uint64_t)bytes[0]) << 56) |
1028              (((uint64_t)bytes[1]) << 48) |
1029              (((uint64_t)bytes[2]) << 40) |
1030              (((uint64_t)bytes[3]) << 32) |
1031              (((uint64_t)bytes[4]) << 24) |
1032              (((uint64_t)bytes[5]) << 16) |
1033              (((uint64_t)bytes[6]) << 8) |
1034              bytes[7];
1035         return (rv);
1036 }
1037
1038 static __inline u_int32_t
1039 scsi_3btoul(u_int8_t *bytes)
1040 {
1041         u_int32_t rv;
1042
1043         rv = (bytes[0] << 16) |
1044              (bytes[1] << 8) |
1045              bytes[2];
1046         return (rv);
1047 }
1048
1049 static __inline int32_t
1050 scsi_3btol(u_int8_t *bytes)
1051 {
1052         u_int32_t rc = scsi_3btoul(bytes);
1053
1054         if (rc & 0x00800000)
1055                 rc |= 0xff000000;
1056
1057         return (int32_t) rc;
1058 }
1059
1060 static __inline u_int32_t
1061 scsi_4btoul(u_int8_t *bytes)
1062 {
1063         u_int32_t rv;
1064
1065         rv = (bytes[0] << 24) |
1066              (bytes[1] << 16) |
1067              (bytes[2] << 8) |
1068              bytes[3];
1069         return (rv);
1070 }
1071
1072 /*
1073  * Given the pointer to a returned mode sense buffer, return a pointer to
1074  * the start of the first mode page.
1075  */
1076 static __inline void *
1077 find_mode_page_6(struct scsi_mode_header_6 *mode_header)
1078 {
1079         void *page_start;
1080
1081         page_start = (void *)((u_int8_t *)&mode_header[1] +
1082                               mode_header->blk_desc_len);
1083
1084         return(page_start);
1085 }
1086
1087 static __inline void *
1088 find_mode_page_10(struct scsi_mode_header_10 *mode_header)
1089 {
1090         void *page_start;
1091
1092         page_start = (void *)((u_int8_t *)&mode_header[1] +
1093                                scsi_2btoul(mode_header->blk_desc_len));
1094
1095         return(page_start);
1096 }
1097
1098 __END_DECLS
1099
1100 #endif /*_SCSI_SCSI_ALL_H*/