sys/cam/scsi/scsi_all.h

   1 /*-
   2  * Largely written by Julian Elischer (julian@tfs.com)
   3  * for TRW Financial Systems.
   4  *
   5  * TRW Financial Systems, in accordance with their agreement with Carnegie
   6  * Mellon University, makes this software available to CMU to distribute
   7  * or use in any manner that they see fit as long as this message is kept with
   8  * the software. For this reason TFS also grants any other persons or
   9  * organisations permission to use or modify this software.
  10  *
  11  * TFS supplies this software to be publicly redistributed
  12  * on the understanding that TFS is not responsible for the correct
  13  * functioning of this software in any circumstances.
  14  *
  15  * Ported to run under 386BSD by Julian Elischer (julian@tfs.com) Sept 1992
  16  *
  17  * $FreeBSD$
  18  */
  19
  20 /*
  21  * SCSI general  interface description
  22  */
  23
  24 #ifndef _SCSI_SCSI_ALL_H
  25 #define _SCSI_SCSI_ALL_H 1
  26
  27 #include <sys/cdefs.h>
  28 #include <machine/stdarg.h>
  29
  30 #ifdef _KERNEL
  31 /*
  32  * This is the number of seconds we wait for devices to settle after a SCSI
  33  * bus reset.
  34  */
  35 extern int scsi_delay;
  36 #endif /* _KERNEL */
  37
  38 /*
  39  * SCSI command format
  40  */
  41
  42 /*
  43  * Define dome bits that are in ALL (or a lot of) scsi commands
  44  */
  45 #define SCSI_CTL_LINK           0x01
  46 #define SCSI_CTL_FLAG           0x02
  47 #define SCSI_CTL_VENDOR         0xC0
  48 #define SCSI_CMD_LUN            0xA0    /* these two should not be needed */
  49 #define SCSI_CMD_LUN_SHIFT      5       /* LUN in the cmd is no longer SCSI */
  50
  51 #define SCSI_MAX_CDBLEN         16      /*
  52                                          * 16 byte commands are in the
  53                                          * SCSI-3 spec
  54                                          */
  55 #if defined(CAM_MAX_CDBLEN) && (CAM_MAX_CDBLEN < SCSI_MAX_CDBLEN)
  56 #error "CAM_MAX_CDBLEN cannot be less than SCSI_MAX_CDBLEN"
  57 #endif
  58
  59 /* 6byte CDBs special case 0 length to be 256 */
  60 #define SCSI_CDB6_LEN(len)      ((len) == 0 ? 256 : len)
  61
  62 /*
  63  * This type defines actions to be taken when a particular sense code is
  64  * received.  Right now, these flags are only defined to take up 16 bits,
  65  * but can be expanded in the future if necessary.
  66  */
  67 typedef enum {
  68         SS_NOP      = 0x000000, /* Do nothing */
  69         SS_RETRY    = 0x010000, /* Retry the command */
  70         SS_FAIL     = 0x020000, /* Bail out */
  71         SS_START    = 0x030000, /* Send a Start Unit command to the device,
  72                                  * then retry the original command.
  73                                  */
  74         SS_TUR      = 0x040000, /* Send a Test Unit Ready command to the
  75                                  * device, then retry the original command.
  76                                  */
  77         SS_MASK     = 0xff0000
  78 } scsi_sense_action;
  79
  80 typedef enum {
  81         SSQ_NONE                = 0x0000,
  82         SSQ_DECREMENT_COUNT     = 0x0100,  /* Decrement the retry count */
  83         SSQ_MANY                = 0x0200,  /* send lots of recovery commands */
  84         SSQ_RANGE               = 0x0400,  /*
  85                                             * This table entry represents the
  86                                             * end of a range of ASCQs that
  87                                             * have identical error actions
  88                                             * and text.
  89                                             */
  90         SSQ_PRINT_SENSE         = 0x0800,
  91         SSQ_UA                  = 0x1000,  /* Broadcast UA. */
  92         SSQ_RESCAN              = 0x2000,  /* Rescan target for LUNs. */
  93         SSQ_LOST                = 0x4000,  /* Destroy the LUNs. */
  94         SSQ_MASK                = 0xff00
  95 } scsi_sense_action_qualifier;
  96
  97 /* Mask for error status values */
  98 #define SS_ERRMASK      0xff
  99
 100 /* The default, retyable, error action */
 101 #define SS_RDEF         SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE|EIO
 102
 103 /* The retyable, error action, with table specified error code */
 104 #define SS_RET          SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE
 105
 106 /* Wait for transient error status to change */
 107 #define SS_WAIT         SS_TUR|SSQ_MANY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE
 108
 109 /* Fatal error action, with table specified error code */
 110 #define SS_FATAL        SS_FAIL|SSQ_PRINT_SENSE
 111
 112 struct scsi_generic
 113 {
 114         u_int8_t opcode;
 115         u_int8_t bytes[11];
 116 };
 117
 118 struct scsi_request_sense
 119 {
 120         u_int8_t opcode;
 121         u_int8_t byte2;
 122 #define SRS_DESC        0x01
 123         u_int8_t unused[2];
 124         u_int8_t length;
 125         u_int8_t control;
 126 };
 127
 128 struct scsi_test_unit_ready
 129 {
 130         u_int8_t opcode;
 131         u_int8_t byte2;
 132         u_int8_t unused[3];
 133         u_int8_t control;
 134 };
 135
 136 struct scsi_receive_diag {
 137         uint8_t opcode;
 138         uint8_t byte2;
 139 #define SRD_PCV         0x01
 140         uint8_t page_code;
 141         uint8_t length[2];
 142         uint8_t control;
 143 };
 144
 145 struct scsi_send_diag {
 146         uint8_t opcode;
 147         uint8_t byte2;
 148 #define SSD_UNITOFFL                            0x01
 149 #define SSD_DEVOFFL                             0x02
 150 #define SSD_SELFTEST                            0x04
 151 #define SSD_PF                                  0x10
 152 #define SSD_SELF_TEST_CODE_MASK                 0xE0
 153 #define SSD_SELF_TEST_CODE_SHIFT                5
 154 #define         SSD_SELF_TEST_CODE_NONE         0x00
 155 #define         SSD_SELF_TEST_CODE_BG_SHORT     0x01
 156 #define         SSD_SELF_TEST_CODE_BG_EXTENDED  0x02
 157 #define         SSD_SELF_TEST_CODE_BG_ABORT     0x04
 158 #define         SSD_SELF_TEST_CODE_FG_SHORT     0x05
 159 #define         SSD_SELF_TEST_CODE_FG_EXTENDED  0x06
 160         uint8_t reserved;
 161         uint8_t length[2];
 162         uint8_t control;
 163 };
 164
 165 struct scsi_sense
 166 {
 167         u_int8_t opcode;
 168         u_int8_t byte2;
 169         u_int8_t unused[2];
 170         u_int8_t length;
 171         u_int8_t control;
 172 };
 173
 174 struct scsi_inquiry
 175 {
 176         u_int8_t opcode;
 177         u_int8_t byte2;
 178 #define SI_EVPD         0x01
 179 #define SI_CMDDT        0x02
 180         u_int8_t page_code;
 181         u_int8_t length[2];
 182         u_int8_t control;
 183 };
 184
 185 struct scsi_mode_sense_6
 186 {
 187         u_int8_t opcode;
 188         u_int8_t byte2;
 189 #define SMS_DBD                         0x08
 190         u_int8_t page;
 191 #define SMS_PAGE_CODE                   0x3F
 192 #define SMS_VENDOR_SPECIFIC_PAGE        0x00
 193 #define SMS_DISCONNECT_RECONNECT_PAGE   0x02
 194 #define SMS_FORMAT_DEVICE_PAGE          0x03
 195 #define SMS_GEOMETRY_PAGE               0x04
 196 #define SMS_CACHE_PAGE                  0x08
 197 #define SMS_PERIPHERAL_DEVICE_PAGE      0x09
 198 #define SMS_CONTROL_MODE_PAGE           0x0A
 199 #define SMS_PROTO_SPECIFIC_PAGE         0x19
 200 #define SMS_INFO_EXCEPTIONS_PAGE        0x1C
 201 #define SMS_ALL_PAGES_PAGE              0x3F
 202 #define SMS_PAGE_CTRL_MASK              0xC0
 203 #define SMS_PAGE_CTRL_CURRENT           0x00
 204 #define SMS_PAGE_CTRL_CHANGEABLE        0x40
 205 #define SMS_PAGE_CTRL_DEFAULT           0x80
 206 #define SMS_PAGE_CTRL_SAVED             0xC0
 207         u_int8_t subpage;
 208 #define SMS_SUBPAGE_PAGE_0              0x00
 209 #define SMS_SUBPAGE_ALL                 0xff
 210         u_int8_t length;
 211         u_int8_t control;
 212 };
 213
 214 struct scsi_mode_sense_10
 215 {
 216         u_int8_t opcode;
 217         u_int8_t byte2;         /* same bits as small version */
 218 #define SMS10_LLBAA                     0x10
 219         u_int8_t page;          /* same bits as small version */
 220         u_int8_t subpage;
 221         u_int8_t unused[3];
 222         u_int8_t length[2];
 223         u_int8_t control;
 224 };
 225
 226 struct scsi_mode_select_6
 227 {
 228         u_int8_t opcode;
 229         u_int8_t byte2;
 230 #define SMS_SP  0x01
 231 #define SMS_PF  0x10
 232         u_int8_t unused[2];
 233         u_int8_t length;
 234         u_int8_t control;
 235 };
 236
 237 struct scsi_mode_select_10
 238 {
 239         u_int8_t opcode;
 240         u_int8_t byte2;         /* same bits as small version */
 241         u_int8_t unused[5];
 242         u_int8_t length[2];
 243         u_int8_t control;
 244 };
 245
 246 /*
 247  * When sending a mode select to a tape drive, the medium type must be 0.
 248  */
 249 struct scsi_mode_hdr_6
 250 {
 251         u_int8_t datalen;
 252         u_int8_t medium_type;
 253         u_int8_t dev_specific;
 254         u_int8_t block_descr_len;
 255 };
 256
 257 struct scsi_mode_hdr_10
 258 {
 259         u_int8_t datalen[2];
 260         u_int8_t medium_type;
 261         u_int8_t dev_specific;
 262         u_int8_t reserved[2];
 263         u_int8_t block_descr_len[2];
 264 };
 265
 266 struct scsi_mode_block_descr
 267 {
 268         u_int8_t density_code;
 269         u_int8_t num_blocks[3];
 270         u_int8_t reserved;
 271         u_int8_t block_len[3];
 272 };
 273
 274 struct scsi_per_res_in
 275 {
 276         u_int8_t opcode;
 277         u_int8_t action;
 278 #define SPRI_RK 0x00
 279 #define SPRI_RR 0x01
 280 #define SPRI_RC 0x02
 281 #define SPRI_RS 0x03
 282         u_int8_t reserved[5];
 283         u_int8_t length[2];
 284 #define SPRI_MAX_LEN            0xffff
 285         u_int8_t control;
 286 };
 287
 288 struct scsi_per_res_in_header
 289 {
 290         u_int8_t generation[4];
 291         u_int8_t length[4];
 292 };
 293
 294 struct scsi_per_res_key
 295 {
 296         u_int8_t key[8];
 297 };
 298
 299 struct scsi_per_res_in_keys
 300 {
 301         struct scsi_per_res_in_header header;
 302         struct scsi_per_res_key keys[0];
 303 };
 304
 305 struct scsi_per_res_cap
 306 {
 307         uint8_t length[2];
 308         uint8_t flags1;
 309 #define SPRI_RLR_C              0x80
 310 #define SPRI_CRH                0x10
 311 #define SPRI_SIP_C              0x08
 312 #define SPRI_ATP_C              0x04
 313 #define SPRI_PTPL_C             0x01
 314         uint8_t flags2;
 315 #define SPRI_TMV                0x80
 316 #define SPRI_ALLOW_CMD_MASK     0x70
 317 #define SPRI_ALLOW_CMD_SHIFT    4
 318 #define SPRI_ALLOW_NA           0x00
 319 #define SPRI_ALLOW_1            0x10
 320 #define SPRI_ALLOW_2            0x20
 321 #define SPRI_ALLOW_3            0x30
 322 #define SPRI_ALLOW_4            0x40
 323 #define SPRI_ALLOW_5            0x50
 324 #define SPRI_PTPL_A             0x01
 325         uint8_t type_mask[2];
 326 #define SPRI_TM_WR_EX_AR        0x8000
 327 #define SPRI_TM_EX_AC_RO        0x4000
 328 #define SPRI_TM_WR_EX_RO        0x2000
 329 #define SPRI_TM_EX_AC           0x0800
 330 #define SPRI_TM_WR_EX           0x0200
 331 #define SPRI_TM_EX_AC_AR        0x0001
 332         uint8_t reserved[2];
 333 };
 334
 335 struct scsi_per_res_in_rsrv_data
 336 {
 337         uint8_t reservation[8];
 338         uint8_t scope_addr[4];
 339         uint8_t reserved;
 340         uint8_t scopetype;
 341 #define SPRT_WE    0x01
 342 #define SPRT_EA    0x03
 343 #define SPRT_WERO  0x05
 344 #define SPRT_EARO  0x06
 345 #define SPRT_WEAR  0x07
 346 #define SPRT_EAAR  0x08
 347         uint8_t extent_length[2];
 348 };
 349
 350 struct scsi_per_res_in_rsrv
 351 {
 352         struct scsi_per_res_in_header header;
 353         struct scsi_per_res_in_rsrv_data data;
 354 };
 355
 356 struct scsi_per_res_in_full_desc
 357 {
 358         struct scsi_per_res_key res_key;
 359         uint8_t reserved1[4];
 360         uint8_t flags;
 361 #define SPRI_FULL_ALL_TG_PT     0x02
 362 #define SPRI_FULL_R_HOLDER      0x01
 363         uint8_t scopetype;
 364         uint8_t reserved2[4];
 365         uint8_t rel_trgt_port_id[2];
 366         uint8_t additional_length[4];
 367         uint8_t transport_id[];
 368 };
 369
 370 struct scsi_per_res_in_full
 371 {
 372         struct scsi_per_res_in_header header;
 373         struct scsi_per_res_in_full_desc desc[];
 374 };
 375
 376 struct scsi_per_res_out
 377 {
 378         u_int8_t opcode;
 379         u_int8_t action;
 380 #define SPRO_REGISTER           0x00
 381 #define SPRO_RESERVE            0x01
 382 #define SPRO_RELEASE            0x02
 383 #define SPRO_CLEAR              0x03
 384 #define SPRO_PREEMPT            0x04
 385 #define SPRO_PRE_ABO            0x05
 386 #define SPRO_REG_IGNO           0x06
 387 #define SPRO_REG_MOVE           0x07
 388 #define SPRO_REPL_LOST_RES      0x08
 389 #define SPRO_ACTION_MASK        0x1f
 390         u_int8_t scope_type;
 391 #define SPR_SCOPE_MASK          0xf0
 392 #define SPR_SCOPE_SHIFT         4
 393 #define SPR_LU_SCOPE            0x00
 394 #define SPR_EXTENT_SCOPE        0x10
 395 #define SPR_ELEMENT_SCOPE       0x20
 396 #define SPR_TYPE_MASK           0x0f
 397 #define SPR_TYPE_RD_SHARED      0x00
 398 #define SPR_TYPE_WR_EX          0x01
 399 #define SPR_TYPE_RD_EX          0x02
 400 #define SPR_TYPE_EX_AC          0x03
 401 #define SPR_TYPE_SHARED         0x04
 402 #define SPR_TYPE_WR_EX_RO       0x05
 403 #define SPR_TYPE_EX_AC_RO       0x06
 404 #define SPR_TYPE_WR_EX_AR       0x07
 405 #define SPR_TYPE_EX_AC_AR       0x08
 406         u_int8_t reserved[2];
 407         u_int8_t length[4];
 408         u_int8_t control;
 409 };
 410
 411 struct scsi_per_res_out_parms
 412 {
 413         struct scsi_per_res_key res_key;
 414         u_int8_t serv_act_res_key[8];
 415         u_int8_t scope_spec_address[4];
 416         u_int8_t flags;
 417 #define SPR_SPEC_I_PT           0x08
 418 #define SPR_ALL_TG_PT           0x04
 419 #define SPR_APTPL               0x01
 420         u_int8_t reserved1;
 421         u_int8_t extent_length[2];
 422         u_int8_t transport_id_list[];
 423 };
 424
 425 struct scsi_per_res_out_trans_ids {
 426         u_int8_t additional_length[4];
 427         u_int8_t transport_ids[];
 428 };
 429
 430 /*
 431  * Used with REGISTER AND MOVE serivce action of the PERSISTENT RESERVE OUT
 432  * command.
 433  */
 434 struct scsi_per_res_reg_move
 435 {
 436         struct scsi_per_res_key res_key;
 437         u_int8_t serv_act_res_key[8];
 438         u_int8_t reserved;
 439         u_int8_t flags;
 440 #define SPR_REG_MOVE_UNREG      0x02
 441 #define SPR_REG_MOVE_APTPL      0x01
 442         u_int8_t rel_trgt_port_id[2];
 443         u_int8_t transport_id_length[4];
 444         u_int8_t transport_id[];
 445 };
 446
 447 struct scsi_transportid_header
 448 {
 449         uint8_t format_protocol;
 450 #define SCSI_TRN_FORMAT_MASK            0xc0
 451 #define SCSI_TRN_FORMAT_SHIFT           6
 452 #define SCSI_TRN_PROTO_MASK             0x0f
 453 };
 454
 455 struct scsi_transportid_fcp
 456 {
 457         uint8_t format_protocol;
 458 #define SCSI_TRN_FCP_FORMAT_DEFAULT     0x00
 459         uint8_t reserved1[7];
 460         uint8_t n_port_name[8];
 461         uint8_t reserved2[8];
 462 };
 463
 464 struct scsi_transportid_spi
 465 {
 466         uint8_t format_protocol;
 467 #define SCSI_TRN_SPI_FORMAT_DEFAULT     0x00
 468         uint8_t reserved1;
 469         uint8_t scsi_addr[2];
 470         uint8_t obsolete[2];
 471         uint8_t rel_trgt_port_id[2];
 472         uint8_t reserved2[16];
 473 };
 474
 475 struct scsi_transportid_1394
 476 {
 477         uint8_t format_protocol;
 478 #define SCSI_TRN_1394_FORMAT_DEFAULT    0x00
 479         uint8_t reserved1[7];
 480         uint8_t eui64[8];
 481         uint8_t reserved2[8];
 482 };
 483
 484 struct scsi_transportid_rdma
 485 {
 486         uint8_t format_protocol;
 487 #define SCSI_TRN_RDMA_FORMAT_DEFAULT    0x00
 488         uint8_t reserved[7];
 489 #define SCSI_TRN_RDMA_PORT_LEN          16
 490         uint8_t initiator_port_id[SCSI_TRN_RDMA_PORT_LEN];
 491 };
 492
 493 struct scsi_transportid_iscsi_device
 494 {
 495         uint8_t format_protocol;
 496 #define SCSI_TRN_ISCSI_FORMAT_DEVICE    0x00
 497         uint8_t reserved;
 498         uint8_t additional_length[2];
 499         uint8_t iscsi_name[];
 500 };
 501
 502 struct scsi_transportid_iscsi_port
 503 {
 504         uint8_t format_protocol;
 505 #define SCSI_TRN_ISCSI_FORMAT_PORT      0x40
 506         uint8_t reserved;
 507         uint8_t additional_length[2];
 508         uint8_t iscsi_name[];
 509         /*
 510          * Followed by a separator and iSCSI initiator session ID
 511          */
 512 };
 513
 514 struct scsi_transportid_sas
 515 {
 516         uint8_t format_protocol;
 517 #define SCSI_TRN_SAS_FORMAT_DEFAULT     0x00
 518         uint8_t reserved1[3];
 519         uint8_t sas_address[8];
 520         uint8_t reserved2[12];
 521 };
 522
 523 struct scsi_sop_routing_id_norm {
 524         uint8_t bus;
 525         uint8_t devfunc;
 526 #define SCSI_TRN_SOP_BUS_MAX            0xff
 527 #define SCSI_TRN_SOP_DEV_MAX            0x1f
 528 #define SCSI_TRN_SOP_DEV_MASK           0xf8
 529 #define SCSI_TRN_SOP_DEV_SHIFT          3
 530 #define SCSI_TRN_SOP_FUNC_NORM_MASK     0x07
 531 #define SCSI_TRN_SOP_FUNC_NORM_MAX      0x07
 532 };
 533
 534 struct scsi_sop_routing_id_alt {
 535         uint8_t bus;
 536         uint8_t function;
 537 #define SCSI_TRN_SOP_FUNC_ALT_MAX       0xff
 538 };
 539
 540 struct scsi_transportid_sop
 541 {
 542         uint8_t format_protocol;
 543 #define SCSI_TRN_SOP_FORMAT_DEFAULT     0x00
 544         uint8_t reserved1;
 545         uint8_t routing_id[2];
 546         uint8_t reserved2[20];
 547 };
 548
 549 struct scsi_log_sense
 550 {
 551         u_int8_t opcode;
 552         u_int8_t byte2;
 553 #define SLS_SP                          0x01
 554 #define SLS_PPC                         0x02
 555         u_int8_t page;
 556 #define SLS_PAGE_CODE                   0x3F
 557 #define SLS_SUPPORTED_PAGES_PAGE        0x00
 558 #define SLS_OVERRUN_PAGE                0x01
 559 #define SLS_ERROR_WRITE_PAGE            0x02
 560 #define SLS_ERROR_READ_PAGE             0x03
 561 #define SLS_ERROR_READREVERSE_PAGE      0x04
 562 #define SLS_ERROR_VERIFY_PAGE           0x05
 563 #define SLS_ERROR_NONMEDIUM_PAGE        0x06
 564 #define SLS_ERROR_LASTN_PAGE            0x07
 565 #define SLS_LOGICAL_BLOCK_PROVISIONING  0x0c
 566 #define SLS_SELF_TEST_PAGE              0x10
 567 #define SLS_STAT_AND_PERF               0x19
 568 #define SLS_IE_PAGE                     0x2f
 569 #define SLS_PAGE_CTRL_MASK              0xC0
 570 #define SLS_PAGE_CTRL_THRESHOLD         0x00
 571 #define SLS_PAGE_CTRL_CUMULATIVE        0x40
 572 #define SLS_PAGE_CTRL_THRESH_DEFAULT    0x80
 573 #define SLS_PAGE_CTRL_CUMUL_DEFAULT     0xC0
 574         u_int8_t subpage;
 575 #define SLS_SUPPORTED_SUBPAGES_SUBPAGE  0xff
 576         u_int8_t reserved;
 577         u_int8_t paramptr[2];
 578         u_int8_t length[2];
 579         u_int8_t control;
 580 };
 581
 582 struct scsi_log_select
 583 {
 584         u_int8_t opcode;
 585         u_int8_t byte2;
 586 /*      SLS_SP                          0x01 */
 587 #define SLS_PCR                         0x02
 588         u_int8_t page;
 589 /*      SLS_PAGE_CTRL_MASK              0xC0 */
 590 /*      SLS_PAGE_CTRL_THRESHOLD         0x00 */
 591 /*      SLS_PAGE_CTRL_CUMULATIVE        0x40 */
 592 /*      SLS_PAGE_CTRL_THRESH_DEFAULT    0x80 */
 593 /*      SLS_PAGE_CTRL_CUMUL_DEFAULT     0xC0 */
 594         u_int8_t reserved[4];
 595         u_int8_t length[2];
 596         u_int8_t control;
 597 };
 598
 599 struct scsi_log_header
 600 {
 601         u_int8_t page;
 602 #define SL_PAGE_CODE                    0x3F
 603 #define SL_SPF                          0x40
 604 #define SL_DS                           0x80
 605         u_int8_t subpage;
 606         u_int8_t datalen[2];
 607 };
 608
 609 struct scsi_log_param_header {
 610         u_int8_t param_code[2];
 611         u_int8_t param_control;
 612 #define SLP_LP                          0x01
 613 #define SLP_LBIN                        0x02
 614 #define SLP_TMC_MASK                    0x0C
 615 #define SLP_TMC_ALWAYS                  0x00
 616 #define SLP_TMC_EQUAL                   0x04
 617 #define SLP_TMC_NOTEQUAL                0x08
 618 #define SLP_TMC_GREATER                 0x0C
 619 #define SLP_ETC                         0x10
 620 #define SLP_TSD                         0x20
 621 #define SLP_DS                          0x40
 622 #define SLP_DU                          0x80
 623         u_int8_t param_len;
 624 };
 625
 626 struct scsi_log_stat_and_perf {
 627         struct scsi_log_param_header hdr;
 628 #define SLP_SAP                         0x0001
 629         uint8_t read_num[8];
 630         uint8_t write_num[8];
 631         uint8_t recvieved_lba[8];
 632         uint8_t transmitted_lba[8];
 633         uint8_t read_int[8];
 634         uint8_t write_int[8];
 635         uint8_t weighted_num[8];
 636         uint8_t weighted_int[8];
 637 };
 638
 639 struct scsi_log_idle_time {
 640         struct scsi_log_param_header hdr;
 641 #define SLP_IT                          0x0002
 642         uint8_t idle_int[8];
 643 };
 644
 645 struct scsi_log_time_interval {
 646         struct scsi_log_param_header hdr;
 647 #define SLP_TI                          0x0003
 648         uint8_t exponent[4];
 649         uint8_t integer[4];
 650 };
 651
 652 struct scsi_log_fua_stat_and_perf {
 653         struct scsi_log_param_header hdr;
 654 #define SLP_FUA_SAP                     0x0004
 655         uint8_t fua_read_num[8];
 656         uint8_t fua_write_num[8];
 657         uint8_t fuanv_read_num[8];
 658         uint8_t fuanv_write_num[8];
 659         uint8_t fua_read_int[8];
 660         uint8_t fua_write_int[8];
 661         uint8_t fuanv_read_int[8];
 662         uint8_t fuanv_write_int[8];
 663 };
 664
 665 struct scsi_control_page {
 666         u_int8_t page_code;
 667         u_int8_t page_length;
 668         u_int8_t rlec;
 669 #define SCP_RLEC                        0x01    /*Report Log Exception Cond*/
 670 #define SCP_GLTSD                       0x02    /*Global Logging target
 671                                                   save disable */
 672 #define SCP_DSENSE                      0x04    /*Descriptor Sense */
 673 #define SCP_DPICZ                       0x08    /*Disable Prot. Info Check
 674                                                   if Prot. Field is Zero */
 675 #define SCP_TMF_ONLY                    0x10    /*TM Functions Only*/
 676 #define SCP_TST_MASK                    0xE0    /*Task Set Type Mask*/
 677 #define SCP_TST_ONE                     0x00    /*One Task Set*/
 678 #define SCP_TST_SEPARATE                0x20    /*Separate Task Sets*/
 679         u_int8_t queue_flags;
 680 #define SCP_QUEUE_ALG_MASK              0xF0
 681 #define SCP_QUEUE_ALG_RESTRICTED        0x00
 682 #define SCP_QUEUE_ALG_UNRESTRICTED      0x10
 683 #define SCP_NUAR                        0x08    /*No UA on release*/
 684 #define SCP_QUEUE_ERR                   0x02    /*Queued I/O aborted for CACs*/
 685 #define SCP_QUEUE_DQUE                  0x01    /*Queued I/O disabled*/
 686         u_int8_t eca_and_aen;
 687 #define SCP_EECA                        0x80    /*Enable Extended CA*/
 688 #define SCP_RAC                         0x40    /*Report a check*/
 689 #define SCP_SWP                         0x08    /*Software Write Protect*/
 690 #define SCP_RAENP                       0x04    /*Ready AEN Permission*/
 691 #define SCP_UAAENP                      0x02    /*UA AEN Permission*/
 692 #define SCP_EAENP                       0x01    /*Error AEN Permission*/
 693         u_int8_t flags4;
 694 #define SCP_ATO                         0x80    /*Application tag owner*/
 695 #define SCP_TAS                         0x40    /*Task aborted status*/
 696 #define SCP_ATMPE                       0x20    /*Application tag mode page*/
 697 #define SCP_RWWP                        0x10    /*Reject write without prot*/
 698         u_int8_t aen_holdoff_period[2];
 699         u_int8_t busy_timeout_period[2];
 700         u_int8_t extended_selftest_completion_time[2];
 701 };
 702
 703 struct scsi_cache_page {
 704         u_int8_t page_code;
 705 #define SCHP_PAGE_SAVABLE               0x80    /* Page is savable */
 706         u_int8_t page_length;
 707         u_int8_t cache_flags;
 708 #define SCHP_FLAGS_WCE                  0x04    /* Write Cache Enable */
 709 #define SCHP_FLAGS_MF                   0x02    /* Multiplication factor */
 710 #define SCHP_FLAGS_RCD                  0x01    /* Read Cache Disable */
 711         u_int8_t rw_cache_policy;
 712         u_int8_t dis_prefetch[2];
 713         u_int8_t min_prefetch[2];
 714         u_int8_t max_prefetch[2];
 715         u_int8_t max_prefetch_ceil[2];
 716 };
 717
 718 /*
 719  * XXX KDM
 720  * Updated version of the cache page, as of SBC.  Update this to SBC-3 and
 721  * rationalize the two.
 722  */
 723 struct scsi_caching_page {
 724         uint8_t page_code;
 725 #define SMS_CACHING_PAGE                0x08
 726         uint8_t page_length;
 727         uint8_t flags1;
 728 #define SCP_IC          0x80
 729 #define SCP_ABPF        0x40
 730 #define SCP_CAP         0x20
 731 #define SCP_DISC        0x10
 732 #define SCP_SIZE        0x08
 733 #define SCP_WCE         0x04
 734 #define SCP_MF          0x02
 735 #define SCP_RCD         0x01
 736         uint8_t ret_priority;
 737         uint8_t disable_pf_transfer_len[2];
 738         uint8_t min_prefetch[2];
 739         uint8_t max_prefetch[2];
 740         uint8_t max_pf_ceiling[2];
 741         uint8_t flags2;
 742 #define SCP_FSW         0x80
 743 #define SCP_LBCSS       0x40
 744 #define SCP_DRA         0x20
 745 #define SCP_VS1         0x10
 746 #define SCP_VS2         0x08
 747         uint8_t cache_segments;
 748         uint8_t cache_seg_size[2];
 749         uint8_t reserved;
 750         uint8_t non_cache_seg_size[3];
 751 };
 752
 753 /*
 754  * XXX KDM move this off to a vendor shim.
 755  */
 756 struct copan_debugconf_subpage {
 757         uint8_t page_code;
 758 #define DBGCNF_PAGE_CODE                0x00
 759         uint8_t subpage;
 760 #define DBGCNF_SUBPAGE_CODE     0xF0
 761         uint8_t page_length[2];
 762         uint8_t page_version;
 763 #define DBGCNF_VERSION                  0x00
 764         uint8_t ctl_time_io_secs[2];
 765 };
 766
 767
 768 struct scsi_info_exceptions_page {
 769         u_int8_t page_code;
 770 #define SIEP_PAGE_SAVABLE               0x80    /* Page is savable */
 771         u_int8_t page_length;
 772         u_int8_t info_flags;
 773 #define SIEP_FLAGS_PERF                 0x80
 774 #define SIEP_FLAGS_EBF                  0x20
 775 #define SIEP_FLAGS_EWASC                0x10
 776 #define SIEP_FLAGS_DEXCPT               0x08
 777 #define SIEP_FLAGS_TEST                 0x04
 778 #define SIEP_FLAGS_EBACKERR             0x02
 779 #define SIEP_FLAGS_LOGERR               0x01
 780         u_int8_t mrie;
 781         u_int8_t interval_timer[4];
 782         u_int8_t report_count[4];
 783 };
 784
 785 struct scsi_logical_block_provisioning_page_descr {
 786         uint8_t flags;
 787 #define SLBPPD_ENABLED          0x80
 788 #define SLBPPD_TYPE_MASK        0x38
 789 #define SLBPPD_ARMING_MASK      0x07
 790 #define SLBPPD_ARMING_DEC       0x02
 791 #define SLBPPD_ARMING_INC       0x01
 792         uint8_t resource;
 793         uint8_t reserved[2];
 794         uint8_t count[4];
 795 };
 796
 797 struct scsi_logical_block_provisioning_page {
 798         uint8_t page_code;
 799         uint8_t subpage_code;
 800         uint8_t page_length[2];
 801         uint8_t flags;
 802 #define SLBPP_SITUA             0x01
 803         uint8_t reserved[11];
 804         struct scsi_logical_block_provisioning_page_descr descr[0];
 805 };
 806
 807 /*
 808  * SCSI protocol identifier values, current as of SPC4r36l.
 809  */
 810 #define SCSI_PROTO_FC           0x00    /* Fibre Channel */
 811 #define SCSI_PROTO_SPI          0x01    /* Parallel SCSI */
 812 #define SCSI_PROTO_SSA          0x02    /* Serial Storage Arch. */
 813 #define SCSI_PROTO_1394         0x03    /* IEEE 1394 (Firewire) */
 814 #define SCSI_PROTO_RDMA         0x04    /* SCSI RDMA Protocol */
 815 #define SCSI_PROTO_ISCSI        0x05    /* Internet SCSI */
 816 #define SCSI_PROTO_iSCSI        0x05    /* Internet SCSI */
 817 #define SCSI_PROTO_SAS          0x06    /* SAS Serial SCSI Protocol */
 818 #define SCSI_PROTO_ADT          0x07    /* Automation/Drive Int. Trans. Prot.*/
 819 #define SCSI_PROTO_ADITP        0x07    /* Automation/Drive Int. Trans. Prot.*/
 820 #define SCSI_PROTO_ATA          0x08    /* AT Attachment Interface */
 821 #define SCSI_PROTO_UAS          0x09    /* USB Atached SCSI */
 822 #define SCSI_PROTO_SOP          0x0a    /* SCSI over PCI Express */
 823 #define SCSI_PROTO_NONE         0x0f    /* No specific protocol */
 824
 825 struct scsi_proto_specific_page {
 826         u_int8_t page_code;
 827 #define SPSP_PAGE_SAVABLE               0x80    /* Page is savable */
 828         u_int8_t page_length;
 829         u_int8_t protocol;
 830 #define SPSP_PROTO_FC                   SCSI_PROTO_FC
 831 #define SPSP_PROTO_SPI                  SCSI_PROTO_SPI
 832 #define SPSP_PROTO_SSA                  SCSI_PROTO_SSA
 833 #define SPSP_PROTO_1394                 SCSI_PROTO_1394
 834 #define SPSP_PROTO_RDMA                 SCSI_PROTO_RDMA
 835 #define SPSP_PROTO_ISCSI                SCSI_PROTO_ISCSI
 836 #define SPSP_PROTO_SAS                  SCSI_PROTO_SAS
 837 #define SPSP_PROTO_ADT                  SCSI_PROTO_ADITP
 838 #define SPSP_PROTO_ATA                  SCSI_PROTO_ATA
 839 #define SPSP_PROTO_UAS                  SCSI_PROTO_UAS
 840 #define SPSP_PROTO_SOP                  SCSI_PROTO_SOP
 841 #define SPSP_PROTO_NONE                 SCSI_PROTO_NONE
 842 };
 843
 844 struct scsi_reserve
 845 {
 846         u_int8_t opcode;
 847         u_int8_t byte2;
 848 #define SR_EXTENT       0x01
 849 #define SR_ID_MASK      0x0e
 850 #define SR_3RDPTY       0x10
 851 #define SR_LUN_MASK     0xe0
 852         u_int8_t resv_id;
 853         u_int8_t length[2];
 854         u_int8_t control;
 855 };
 856
 857 struct scsi_reserve_10 {
 858         uint8_t opcode;
 859         uint8_t byte2;
 860 #define SR10_3RDPTY     0x10
 861 #define SR10_LONGID     0x02
 862 #define SR10_EXTENT     0x01
 863         uint8_t resv_id;
 864         uint8_t thirdparty_id;
 865         uint8_t reserved[3];
 866         uint8_t length[2];
 867         uint8_t control;
 868 };
 869
 870
 871 struct scsi_release
 872 {
 873         u_int8_t opcode;
 874         u_int8_t byte2;
 875         u_int8_t resv_id;
 876         u_int8_t unused[1];
 877         u_int8_t length;
 878         u_int8_t control;
 879 };
 880
 881 struct scsi_release_10 {
 882         uint8_t opcode;
 883         uint8_t byte2;
 884         uint8_t resv_id;
 885         uint8_t thirdparty_id;
 886         uint8_t reserved[3];
 887         uint8_t length[2];
 888         uint8_t control;
 889 };
 890
 891 struct scsi_prevent
 892 {
 893         u_int8_t opcode;
 894         u_int8_t byte2;
 895         u_int8_t unused[2];
 896         u_int8_t how;
 897         u_int8_t control;
 898 };
 899 #define PR_PREVENT 0x01
 900 #define PR_ALLOW   0x00
 901
 902 struct scsi_sync_cache
 903 {
 904         u_int8_t opcode;
 905         u_int8_t byte2;
 906 #define SSC_IMMED       0x02
 907 #define SSC_RELADR      0x01
 908         u_int8_t begin_lba[4];
 909         u_int8_t reserved;
 910         u_int8_t lb_count[2];
 911         u_int8_t control;
 912 };
 913
 914 struct scsi_sync_cache_16
 915 {
 916         uint8_t opcode;
 917         uint8_t byte2;
 918         uint8_t begin_lba[8];
 919         uint8_t lb_count[4];
 920         uint8_t reserved;
 921         uint8_t control;
 922 };
 923
 924 struct scsi_format {
 925         uint8_t opcode;
 926         uint8_t byte2;
 927 #define SF_LONGLIST             0x20
 928 #define SF_FMTDATA              0x10
 929 #define SF_CMPLIST              0x08
 930 #define SF_FORMAT_MASK          0x07
 931 #define SF_FORMAT_BLOCK         0x00
 932 #define SF_FORMAT_LONG_BLOCK    0x03
 933 #define SF_FORMAT_BFI           0x04
 934 #define SF_FORMAT_PHYS          0x05
 935         uint8_t vendor;
 936         uint8_t interleave[2];
 937         uint8_t control;
 938 };
 939
 940 struct scsi_format_header_short {
 941         uint8_t reserved;
 942 #define SF_DATA_FOV     0x80
 943 #define SF_DATA_DPRY    0x40
 944 #define SF_DATA_DCRT    0x20
 945 #define SF_DATA_STPF    0x10
 946 #define SF_DATA_IP      0x08
 947 #define SF_DATA_DSP     0x04
 948 #define SF_DATA_IMMED   0x02
 949 #define SF_DATA_VS      0x01
 950         uint8_t byte2;
 951         uint8_t defect_list_len[2];
 952 };
 953
 954 struct scsi_format_header_long {
 955         uint8_t reserved;
 956         uint8_t byte2;
 957         uint8_t reserved2[2];
 958         uint8_t defect_list_len[4];
 959 };
 960
 961 struct scsi_changedef
 962 {
 963         u_int8_t opcode;
 964         u_int8_t byte2;
 965         u_int8_t unused1;
 966         u_int8_t how;
 967         u_int8_t unused[4];
 968         u_int8_t datalen;
 969         u_int8_t control;
 970 };
 971
 972 struct scsi_read_buffer
 973 {
 974         u_int8_t opcode;
 975         u_int8_t byte2;
 976 #define RWB_MODE                0x1F
 977 #define RWB_MODE_HDR_DATA       0x00
 978 #define RWB_MODE_VENDOR         0x01
 979 #define RWB_MODE_DATA           0x02
 980 #define RWB_MODE_DESCR          0x03
 981 #define RWB_MODE_DOWNLOAD       0x04
 982 #define RWB_MODE_DOWNLOAD_SAVE  0x05
 983 #define RWB_MODE_ECHO           0x0A
 984 #define RWB_MODE_ECHO_DESCR     0x0B
 985 #define RWB_MODE_ERROR_HISTORY  0x1C
 986         u_int8_t buffer_id;
 987         u_int8_t offset[3];
 988         u_int8_t length[3];
 989         u_int8_t control;
 990 };
 991
 992 struct scsi_write_buffer
 993 {
 994         u_int8_t opcode;
 995         u_int8_t byte2;
 996         u_int8_t buffer_id;
 997         u_int8_t offset[3];
 998         u_int8_t length[3];
 999         u_int8_t control;
1000 };
1001
1002 struct scsi_read_attribute
1003 {
1004         u_int8_t opcode;
1005         u_int8_t service_action;
1006 #define SRA_SA_ATTR_VALUES              0x00
1007 #define SRA_SA_ATTR_LIST                0x01
1008 #define SRA_SA_LOG_VOL_LIST             0x02
1009 #define SRA_SA_PART_LIST                0x03
1010 #define SRA_SA_RESTRICTED               0x04
1011 #define SRA_SA_SUPPORTED_ATTRS          0x05
1012 #define SRA_SA_MASK                     0x1f
1013         u_int8_t element[2];
1014         u_int8_t elem_type;
1015         u_int8_t logical_volume;
1016         u_int8_t reserved1;
1017         u_int8_t partition;
1018         u_int8_t first_attribute[2];
1019         u_int8_t length[4];
1020         u_int8_t cache;
1021 #define SRA_CACHE                       0x01
1022         u_int8_t control;
1023 };
1024
1025 struct scsi_write_attribute
1026 {
1027         u_int8_t opcode;
1028         u_int8_t byte2;
1029 #define SWA_WTC                         0x01
1030         u_int8_t element[3];
1031         u_int8_t logical_volume;
1032         u_int8_t reserved1;
1033         u_int8_t partition;
1034         u_int8_t reserved2[2];
1035         u_int8_t length[4];
1036         u_int8_t reserved3;
1037         u_int8_t control;
1038 };
1039
1040
1041 struct scsi_read_attribute_values
1042 {
1043         u_int8_t length[4];
1044         u_int8_t attribute_0[0];
1045 };
1046
1047 struct scsi_mam_attribute_header
1048 {
1049         u_int8_t id[2];
1050         /*
1051          * Attributes obtained from SPC-4r36g (section 7.4.2.2) and
1052          * SSC-4r03 (section 4.2.21).
1053          */
1054 #define SMA_ATTR_ID_DEVICE_MIN          0x0000
1055
1056 #define SMA_ATTR_REM_CAP_PARTITION      0x0000
1057 #define SMA_ATTR_MAX_CAP_PARTITION      0x0001
1058 #define SMA_ATTR_TAPEALERT_FLAGS        0x0002
1059 #define SMA_ATTR_LOAD_COUNT             0x0003
1060 #define SMA_ATTR_MAM_SPACE_REMAINING    0x0004
1061
1062 #define SMA_ATTR_DEV_ASSIGNING_ORG      0x0005
1063 #define SMA_ATTR_FORMAT_DENSITY_CODE    0x0006
1064 #define SMA_ATTR_INITIALIZATION_COUNT   0x0007
1065 #define SMA_ATTR_VOLUME_ID              0x0008
1066 #define SMA_ATTR_VOLUME_CHANGE_REF      0x0009
1067
1068 #define SMA_ATTR_DEV_SERIAL_LAST_LOAD   0x020a
1069 #define SMA_ATTR_DEV_SERIAL_LAST_LOAD_1 0x020b
1070 #define SMA_ATTR_DEV_SERIAL_LAST_LOAD_2 0x020c
1071 #define SMA_ATTR_DEV_SERIAL_LAST_LOAD_3 0x020d
1072
1073 #define SMA_ATTR_TOTAL_MB_WRITTEN_LT    0x0220
1074 #define SMA_ATTR_TOTAL_MB_READ_LT       0x0221
1075 #define SMA_ATTR_TOTAL_MB_WRITTEN_CUR   0x0222
1076 #define SMA_ATTR_TOTAL_MB_READ_CUR      0x0223
1077 #define SMA_ATTR_FIRST_ENC_BLOCK        0x0224
1078 #define SMA_ATTR_NEXT_UNENC_BLOCK       0x0225
1079
1080 #define SMA_ATTR_MEDIUM_USAGE_HIST      0x0340
1081 #define SMA_ATTR_PART_USAGE_HIST        0x0341
1082
1083 #define SMA_ATTR_ID_DEVICE_MAX          0x03ff
1084
1085 #define SMA_ATTR_ID_MEDIUM_MIN          0x0400
1086
1087 #define SMA_ATTR_MED_MANUF              0x0400
1088 #define SMA_ATTR_MED_SERIAL             0x0401
1089
1090 #define SMA_ATTR_MED_LENGTH             0x0402
1091 #define SMA_ATTR_MED_WIDTH              0x0403
1092 #define SMA_ATTR_MED_ASSIGNING_ORG      0x0404
1093 #define SMA_ATTR_MED_DENSITY_CODE       0x0405
1094
1095 #define SMA_ATTR_MED_MANUF_DATE         0x0406
1096 #define SMA_ATTR_MAM_CAPACITY           0x0407
1097 #define SMA_ATTR_MED_TYPE               0x0408
1098 #define SMA_ATTR_MED_TYPE_INFO          0x0409
1099 #define SMA_ATTR_MED_SERIAL_NUM         0x040a
1100
1101 #define SMA_ATTR_ID_MEDIUM_MAX          0x07ff
1102
1103 #define SMA_ATTR_ID_HOST_MIN            0x0800
1104
1105 #define SMA_ATTR_APP_VENDOR             0x0800
1106 #define SMA_ATTR_APP_NAME               0x0801
1107 #define SMA_ATTR_APP_VERSION            0x0802
1108 #define SMA_ATTR_USER_MED_TEXT_LABEL    0x0803
1109 #define SMA_ATTR_LAST_WRITTEN_TIME      0x0804
1110 #define SMA_ATTR_TEXT_LOCAL_ID          0x0805
1111 #define SMA_ATTR_BARCODE                0x0806
1112 #define SMA_ATTR_HOST_OWNER_NAME        0x0807
1113 #define SMA_ATTR_MEDIA_POOL             0x0808
1114 #define SMA_ATTR_PART_USER_LABEL        0x0809
1115 #define SMA_ATTR_LOAD_UNLOAD_AT_PART    0x080a
1116 #define SMA_ATTR_APP_FORMAT_VERSION     0x080b
1117 #define SMA_ATTR_VOL_COHERENCY_INFO     0x080c
1118
1119 #define SMA_ATTR_ID_HOST_MAX            0x0bff
1120
1121 #define SMA_ATTR_VENDOR_DEVICE_MIN      0x0c00
1122 #define SMA_ATTR_VENDOR_DEVICE_MAX      0x0fff
1123 #define SMA_ATTR_VENDOR_MEDIUM_MIN      0x1000
1124 #define SMA_ATTR_VENDOR_MEDIUM_MAX      0x13ff
1125 #define SMA_ATTR_VENDOR_HOST_MIN        0x1400
1126 #define SMA_ATTR_VENDOR_HOST_MAX        0x17ff
1127         u_int8_t byte2;
1128 #define SMA_FORMAT_BINARY       0x00
1129 #define SMA_FORMAT_ASCII        0x01
1130 #define SMA_FORMAT_TEXT         0x02
1131 #define SMA_FORMAT_MASK         0x03
1132 #define SMA_READ_ONLY           0x80
1133         u_int8_t length[2];
1134         u_int8_t attribute[0];
1135 };
1136
1137 struct scsi_attrib_list_header {
1138         u_int8_t length[4];
1139         u_int8_t first_attr_0[0];
1140 };
1141
1142 struct scsi_attrib_lv_list {
1143         u_int8_t length[2];
1144         u_int8_t first_lv_number;
1145         u_int8_t num_logical_volumes;
1146 };
1147
1148 struct scsi_attrib_vendser {
1149         uint8_t vendor[8];
1150         uint8_t serial_num[32];
1151 };
1152
1153 /*
1154  * These values are used to decode the Volume Coherency Information
1155  * Attribute (0x080c) for LTFS-format coherency information.
1156  * Although the Application Client Specific lengths are different for
1157  * Version 0 and Version 1, the data is in fact the same.  The length
1158  * difference was due to a code bug.
1159  */
1160 #define SCSI_LTFS_VER0_LEN      42
1161 #define SCSI_LTFS_VER1_LEN      43
1162 #define SCSI_LTFS_UUID_LEN      36
1163 #define SCSI_LTFS_STR_NAME      "LTFS"
1164 #define SCSI_LTFS_STR_LEN       4
1165
1166 typedef enum {
1167         SCSI_ATTR_FLAG_NONE             = 0x00,
1168         SCSI_ATTR_FLAG_HEX              = 0x01,
1169         SCSI_ATTR_FLAG_FP               = 0x02,
1170         SCSI_ATTR_FLAG_DIV_10           = 0x04,
1171         SCSI_ATTR_FLAG_FP_1DIGIT        = 0x08
1172 } scsi_attrib_flags;
1173
1174 typedef enum {
1175         SCSI_ATTR_OUTPUT_NONE           = 0x00,
1176         SCSI_ATTR_OUTPUT_TEXT_MASK      = 0x03,
1177         SCSI_ATTR_OUTPUT_TEXT_RAW       = 0x00,
1178         SCSI_ATTR_OUTPUT_TEXT_ESC       = 0x01,
1179         SCSI_ATTR_OUTPUT_TEXT_RSV1      = 0x02,
1180         SCSI_ATTR_OUTPUT_TEXT_RSV2      = 0x03,
1181         SCSI_ATTR_OUTPUT_NONASCII_MASK  = 0x0c,
1182         SCSI_ATTR_OUTPUT_NONASCII_TRIM  = 0x00,
1183         SCSI_ATTR_OUTPUT_NONASCII_ESC   = 0x04,
1184         SCSI_ATTR_OUTPUT_NONASCII_RAW   = 0x08,
1185         SCSI_ATTR_OUTPUT_NONASCII_RSV1  = 0x0c,
1186         SCSI_ATTR_OUTPUT_FIELD_MASK     = 0xf0,
1187         SCSI_ATTR_OUTPUT_FIELD_ALL      = 0xf0,
1188         SCSI_ATTR_OUTPUT_FIELD_NONE     = 0x00,
1189         SCSI_ATTR_OUTPUT_FIELD_DESC     = 0x10,
1190         SCSI_ATTR_OUTPUT_FIELD_NUM      = 0x20,
1191         SCSI_ATTR_OUTPUT_FIELD_SIZE     = 0x40,
1192         SCSI_ATTR_OUTPUT_FIELD_RW       = 0x80
1193 } scsi_attrib_output_flags;
1194
1195 struct sbuf;
1196
1197 struct scsi_attrib_table_entry
1198 {
1199         u_int32_t id;
1200         u_int32_t flags;
1201         const char *desc;
1202         const char *suffix;
1203         int (*to_str)(struct sbuf *sb, struct scsi_mam_attribute_header *hdr,
1204                       uint32_t valid_len, uint32_t flags,
1205                       uint32_t output_flags, char *error_str,
1206                       int error_str_len);
1207         int (*parse_str)(char *str, struct scsi_mam_attribute_header *hdr,
1208                          uint32_t alloc_len, uint32_t flags, char *error_str,
1209                          int error_str_len);
1210 };
1211
1212 struct scsi_rw_6
1213 {
1214         u_int8_t opcode;
1215         u_int8_t addr[3];
1216 /* only 5 bits are valid in the MSB address byte */
1217 #define SRW_TOPADDR     0x1F
1218         u_int8_t length;
1219         u_int8_t control;
1220 };
1221
1222 struct scsi_rw_10
1223 {
1224         u_int8_t opcode;
1225 #define SRW10_RELADDR   0x01
1226 /* EBP defined for WRITE(10) only */
1227 #define SRW10_EBP       0x04
1228 #define SRW10_FUA       0x08
1229 #define SRW10_DPO       0x10
1230         u_int8_t byte2;
1231         u_int8_t addr[4];
1232         u_int8_t reserved;
1233         u_int8_t length[2];
1234         u_int8_t control;
1235 };
1236
1237 struct scsi_rw_12
1238 {
1239         u_int8_t opcode;
1240 #define SRW12_RELADDR   0x01
1241 #define SRW12_FUA       0x08
1242 #define SRW12_DPO       0x10
1243         u_int8_t byte2;
1244         u_int8_t addr[4];
1245         u_int8_t length[4];
1246         u_int8_t reserved;
1247         u_int8_t control;
1248 };
1249
1250 struct scsi_rw_16
1251 {
1252         u_int8_t opcode;
1253 #define SRW16_RELADDR   0x01
1254 #define SRW16_FUA       0x08
1255 #define SRW16_DPO       0x10
1256         u_int8_t byte2;
1257         u_int8_t addr[8];
1258         u_int8_t length[4];
1259         u_int8_t reserved;
1260         u_int8_t control;
1261 };
1262
1263 struct scsi_write_same_10
1264 {
1265         uint8_t opcode;
1266         uint8_t byte2;
1267 #define SWS_LBDATA      0x02
1268 #define SWS_PBDATA      0x04
1269 #define SWS_UNMAP       0x08
1270 #define SWS_ANCHOR      0x10
1271         uint8_t addr[4];
1272         uint8_t group;
1273         uint8_t length[2];
1274         uint8_t control;
1275 };
1276
1277 struct scsi_write_same_16
1278 {
1279         uint8_t opcode;
1280         uint8_t byte2;
1281 #define SWS_NDOB        0x01
1282         uint8_t addr[8];
1283         uint8_t length[4];
1284         uint8_t group;
1285         uint8_t control;
1286 };
1287
1288 struct scsi_unmap
1289 {
1290         uint8_t opcode;
1291         uint8_t byte2;
1292 #define SU_ANCHOR       0x01
1293         uint8_t reserved[4];
1294         uint8_t group;
1295         uint8_t length[2];
1296         uint8_t control;
1297 };
1298
1299 struct scsi_unmap_header
1300 {
1301         uint8_t length[2];
1302         uint8_t desc_length[2];
1303         uint8_t reserved[4];
1304 };
1305
1306 struct scsi_unmap_desc
1307 {
1308         uint8_t lba[8];
1309         uint8_t length[4];
1310         uint8_t reserved[4];
1311 };
1312
1313 struct scsi_write_verify_10
1314 {
1315         uint8_t opcode;
1316         uint8_t byte2;
1317 #define SWV_BYTCHK              0x02
1318 #define SWV_DPO                 0x10
1319 #define SWV_WRPROECT_MASK       0xe0
1320         uint8_t addr[4];
1321         uint8_t group;
1322         uint8_t length[2];
1323         uint8_t control;
1324 };
1325
1326 struct scsi_write_verify_12
1327 {
1328         uint8_t opcode;
1329         uint8_t byte2;
1330         uint8_t addr[4];
1331         uint8_t length[4];
1332         uint8_t group;
1333         uint8_t control;
1334 };
1335
1336 struct scsi_write_verify_16
1337 {
1338         uint8_t opcode;
1339         uint8_t byte2;
1340         uint8_t addr[8];
1341         uint8_t length[4];
1342         uint8_t group;
1343         uint8_t control;
1344 };
1345
1346
1347 struct scsi_start_stop_unit
1348 {
1349         u_int8_t opcode;
1350         u_int8_t byte2;
1351 #define SSS_IMMED               0x01
1352         u_int8_t reserved[2];
1353         u_int8_t how;
1354 #define SSS_START               0x01
1355 #define SSS_LOEJ                0x02
1356 #define SSS_PC_MASK             0xf0
1357 #define SSS_PC_START_VALID      0x00
1358 #define SSS_PC_ACTIVE           0x10
1359 #define SSS_PC_IDLE             0x20
1360 #define SSS_PC_STANDBY          0x30
1361 #define SSS_PC_LU_CONTROL       0x70
1362 #define SSS_PC_FORCE_IDLE_0     0xa0
1363 #define SSS_PC_FORCE_STANDBY_0  0xb0
1364         u_int8_t control;
1365 };
1366
1367 struct ata_pass_12 {
1368         u_int8_t opcode;
1369         u_int8_t protocol;
1370 #define AP_PROTO_HARD_RESET     (0x00 << 1)
1371 #define AP_PROTO_SRST           (0x01 << 1)
1372 #define AP_PROTO_NON_DATA       (0x03 << 1)
1373 #define AP_PROTO_PIO_IN         (0x04 << 1)
1374 #define AP_PROTO_PIO_OUT        (0x05 << 1)
1375 #define AP_PROTO_DMA            (0x06 << 1)
1376 #define AP_PROTO_DMA_QUEUED     (0x07 << 1)
1377 #define AP_PROTO_DEVICE_DIAG    (0x08 << 1)
1378 #define AP_PROTO_DEVICE_RESET   (0x09 << 1)
1379 #define AP_PROTO_UDMA_IN        (0x0a << 1)
1380 #define AP_PROTO_UDMA_OUT       (0x0b << 1)
1381 #define AP_PROTO_FPDMA          (0x0c << 1)
1382 #define AP_PROTO_RESP_INFO      (0x0f << 1)
1383 #define AP_MULTI        0xe0
1384         u_int8_t flags;
1385 #define AP_T_LEN        0x03
1386 #define AP_BB           0x04
1387 #define AP_T_DIR        0x08
1388 #define AP_CK_COND      0x20
1389 #define AP_OFFLINE      0x60
1390         u_int8_t features;
1391         u_int8_t sector_count;
1392         u_int8_t lba_low;
1393         u_int8_t lba_mid;
1394         u_int8_t lba_high;
1395         u_int8_t device;
1396         u_int8_t command;
1397         u_int8_t reserved;
1398         u_int8_t control;
1399 };
1400
1401 struct scsi_maintenance_in
1402 {
1403         uint8_t  opcode;
1404         uint8_t  byte2;
1405 #define SERVICE_ACTION_MASK  0x1f
1406 #define SA_RPRT_TRGT_GRP     0x0a
1407         uint8_t  reserved[4];
1408         uint8_t  length[4];
1409         uint8_t  reserved1;
1410         uint8_t  control;
1411 };
1412
1413 struct scsi_report_supported_opcodes
1414 {
1415         uint8_t  opcode;
1416         uint8_t  service_action;
1417         uint8_t  options;
1418 #define RSO_RCTD                0x80
1419 #define RSO_OPTIONS_MASK        0x07
1420 #define RSO_OPTIONS_ALL         0x00
1421 #define RSO_OPTIONS_OC          0x01
1422 #define RSO_OPTIONS_OC_SA       0x02
1423         uint8_t  requested_opcode;
1424         uint8_t  requested_service_action[2];
1425         uint8_t  length[4];
1426         uint8_t  reserved1;
1427         uint8_t  control;
1428 };
1429
1430 struct scsi_report_supported_opcodes_timeout
1431 {
1432         uint8_t  length[2];
1433         uint8_t  reserved;
1434         uint8_t  cmd_specific;
1435         uint8_t  nominal_time[4];
1436         uint8_t  recommended_time[4];
1437 };
1438
1439 struct scsi_report_supported_opcodes_descr
1440 {
1441         uint8_t  opcode;
1442         uint8_t  reserved;
1443         uint8_t  service_action[2];
1444         uint8_t  reserved2;
1445         uint8_t  flags;
1446 #define RSO_SERVACTV            0x01
1447 #define RSO_CTDP                0x02
1448         uint8_t  cdb_length[2];
1449         struct scsi_report_supported_opcodes_timeout timeout[0];
1450 };
1451
1452 struct scsi_report_supported_opcodes_all
1453 {
1454         uint8_t  length[4];
1455         struct scsi_report_supported_opcodes_descr descr[0];
1456 };
1457
1458 struct scsi_report_supported_opcodes_one
1459 {
1460         uint8_t  reserved;
1461         uint8_t  support;
1462 #define RSO_ONE_CTDP            0x80
1463 #define RSO_ONE_SUP_MASK        0x07
1464 #define RSO_ONE_SUP_UNAVAIL     0x00
1465 #define RSO_ONE_SUP_NOT_SUP     0x01
1466 #define RSO_ONE_SUP_AVAIL       0x03
1467 #define RSO_ONE_SUP_VENDOR      0x05
1468         uint8_t  cdb_length[2];
1469         uint8_t  cdb_usage[];
1470 };
1471
1472 struct scsi_report_supported_tmf
1473 {
1474         uint8_t  opcode;
1475         uint8_t  service_action;
1476         uint8_t  reserved[4];
1477         uint8_t  length[4];
1478         uint8_t  reserved1;
1479         uint8_t  control;
1480 };
1481
1482 struct scsi_report_supported_tmf_data
1483 {
1484         uint8_t  byte1;
1485 #define RST_WAKES               0x01
1486 #define RST_TRS                 0x02
1487 #define RST_QTS                 0x04
1488 #define RST_LURS                0x08
1489 #define RST_CTSS                0x10
1490 #define RST_CACAS               0x20
1491 #define RST_ATSS                0x40
1492 #define RST_ATS                 0x80
1493         uint8_t  byte2;
1494 #define RST_ITNRS               0x01
1495 #define RST_QTSS                0x02
1496 #define RST_QAES                0x04
1497         uint8_t  reserved[2];
1498 };
1499
1500 struct scsi_report_timestamp
1501 {
1502         uint8_t  opcode;
1503         uint8_t  service_action;
1504         uint8_t  reserved[4];
1505         uint8_t  length[4];
1506         uint8_t  reserved1;
1507         uint8_t  control;
1508 };
1509
1510 struct scsi_report_timestamp_data
1511 {
1512         uint8_t  length[2];
1513         uint8_t  origin;
1514 #define RTS_ORIG_MASK           0x00
1515 #define RTS_ORIG_ZERO           0x00
1516 #define RTS_ORIG_SET            0x02
1517 #define RTS_ORIG_OUTSIDE        0x03
1518         uint8_t  reserved;
1519         uint8_t  timestamp[6];
1520         uint8_t  reserve2[2];
1521 };
1522
1523 struct scsi_receive_copy_status_lid1
1524 {
1525         uint8_t  opcode;
1526         uint8_t  service_action;
1527 #define RCS_RCS_LID1            0x00
1528         uint8_t  list_identifier;
1529         uint8_t  reserved[7];
1530         uint8_t  length[4];
1531         uint8_t  reserved1;
1532         uint8_t  control;
1533 };
1534
1535 struct scsi_receive_copy_status_lid1_data
1536 {
1537         uint8_t  available_data[4];
1538         uint8_t  copy_command_status;
1539 #define RCS_CCS_INPROG          0x00
1540 #define RCS_CCS_COMPLETED       0x01
1541 #define RCS_CCS_ERROR           0x02
1542         uint8_t  segments_processed[2];
1543         uint8_t  transfer_count_units;
1544 #define RCS_TC_BYTES            0x00
1545 #define RCS_TC_KBYTES           0x01
1546 #define RCS_TC_MBYTES           0x02
1547 #define RCS_TC_GBYTES           0x03
1548 #define RCS_TC_TBYTES           0x04
1549 #define RCS_TC_PBYTES           0x05
1550 #define RCS_TC_EBYTES           0x06
1551 #define RCS_TC_LBAS             0xf1
1552         uint8_t  transfer_count[4];
1553 };
1554
1555 struct scsi_receive_copy_failure_details
1556 {
1557         uint8_t  opcode;
1558         uint8_t  service_action;
1559 #define RCS_RCFD                0x04
1560         uint8_t  list_identifier;
1561         uint8_t  reserved[7];
1562         uint8_t  length[4];
1563         uint8_t  reserved1;
1564         uint8_t  control;
1565 };
1566
1567 struct scsi_receive_copy_failure_details_data
1568 {
1569         uint8_t  available_data[4];
1570         uint8_t  reserved[52];
1571         uint8_t  copy_command_status;
1572         uint8_t  reserved2;
1573         uint8_t  sense_data_length[2];
1574         uint8_t  sense_data[];
1575 };
1576
1577 struct scsi_receive_copy_status_lid4
1578 {
1579         uint8_t  opcode;
1580         uint8_t  service_action;
1581 #define RCS_RCS_LID4            0x05
1582         uint8_t  list_identifier[4];
1583         uint8_t  reserved[4];
1584         uint8_t  length[4];
1585         uint8_t  reserved1;
1586         uint8_t  control;
1587 };
1588
1589 struct scsi_receive_copy_status_lid4_data
1590 {
1591         uint8_t  available_data[4];
1592         uint8_t  response_to_service_action;
1593         uint8_t  copy_command_status;
1594 #define RCS_CCS_COMPLETED_PROD  0x03
1595 #define RCS_CCS_COMPLETED_RESID 0x04
1596 #define RCS_CCS_INPROG_FGBG     0x10
1597 #define RCS_CCS_INPROG_FG       0x11
1598 #define RCS_CCS_INPROG_BG       0x12
1599 #define RCS_CCS_ABORTED         0x60
1600         uint8_t  operation_counter[2];
1601         uint8_t  estimated_status_update_delay[4];
1602         uint8_t  extended_copy_completion_status;
1603         uint8_t  length_of_the_sense_data_field;
1604         uint8_t  sense_data_length;
1605         uint8_t  transfer_count_units;
1606         uint8_t  transfer_count[8];
1607         uint8_t  segments_processed[2];
1608         uint8_t  reserved[6];
1609         uint8_t  sense_data[];
1610 };
1611
1612 struct scsi_receive_copy_operating_parameters
1613 {
1614         uint8_t  opcode;
1615         uint8_t  service_action;
1616 #define RCS_RCOP                0x03
1617         uint8_t  reserved[8];
1618         uint8_t  length[4];
1619         uint8_t  reserved1;
1620         uint8_t  control;
1621 };
1622
1623 struct scsi_receive_copy_operating_parameters_data
1624 {
1625         uint8_t  length[4];
1626         uint8_t  snlid;
1627 #define RCOP_SNLID              0x01
1628         uint8_t  reserved[3];
1629         uint8_t  maximum_cscd_descriptor_count[2];
1630         uint8_t  maximum_segment_descriptor_count[2];
1631         uint8_t  maximum_descriptor_list_length[4];
1632         uint8_t  maximum_segment_length[4];
1633         uint8_t  maximum_inline_data_length[4];
1634         uint8_t  held_data_limit[4];
1635         uint8_t  maximum_stream_device_transfer_size[4];
1636         uint8_t  reserved2[2];
1637         uint8_t  total_concurrent_copies[2];
1638         uint8_t  maximum_concurrent_copies;
1639         uint8_t  data_segment_granularity;
1640         uint8_t  inline_data_granularity;
1641         uint8_t  held_data_granularity;
1642         uint8_t  reserved3[3];
1643         uint8_t  implemented_descriptor_list_length;
1644         uint8_t  list_of_implemented_descriptor_type_codes[0];
1645 };
1646
1647 struct scsi_extended_copy
1648 {
1649         uint8_t  opcode;
1650         uint8_t  service_action;
1651 #define EC_EC_LID1              0x00
1652 #define EC_EC_LID4              0x01
1653         uint8_t  reserved[8];
1654         uint8_t  length[4];
1655         uint8_t  reserved1;
1656         uint8_t  control;
1657 };
1658
1659 struct scsi_ec_cscd_dtsp
1660 {
1661         uint8_t  flags;
1662 #define EC_CSCD_FIXED           0x01
1663 #define EC_CSCD_PAD             0x04
1664         uint8_t  block_length[3];
1665 };
1666
1667 struct scsi_ec_cscd
1668 {
1669         uint8_t  type_code;
1670 #define EC_CSCD_EXT             0xff
1671         uint8_t  luidt_pdt;
1672 #define EC_LUIDT_MASK           0xc0
1673 #define EC_LUIDT_LUN            0x00
1674 #define EC_LUIDT_PROXY_TOKEN    0x40
1675         uint8_t  relative_initiator_port[2];
1676         uint8_t  cscd_params[24];
1677         struct scsi_ec_cscd_dtsp dtsp;
1678 };
1679
1680 struct scsi_ec_cscd_id
1681 {
1682         uint8_t  type_code;
1683 #define EC_CSCD_ID              0xe4
1684         uint8_t  luidt_pdt;
1685         uint8_t  relative_initiator_port[2];
1686         uint8_t  codeset;
1687         uint8_t  id_type;
1688         uint8_t  reserved;
1689         uint8_t  length;
1690         uint8_t  designator[20];
1691         struct scsi_ec_cscd_dtsp dtsp;
1692 };
1693
1694 struct scsi_ec_segment
1695 {
1696         uint8_t  type_code;
1697         uint8_t  flags;
1698 #define EC_SEG_DC               0x02
1699 #define EC_SEG_CAT              0x01
1700         uint8_t  descr_length[2];
1701         uint8_t  params[];
1702 };
1703
1704 struct scsi_ec_segment_b2b
1705 {
1706         uint8_t  type_code;
1707 #define EC_SEG_B2B              0x02
1708         uint8_t  flags;
1709         uint8_t  descr_length[2];
1710         uint8_t  src_cscd[2];
1711         uint8_t  dst_cscd[2];
1712         uint8_t  reserved[2];
1713         uint8_t  number_of_blocks[2];
1714         uint8_t  src_lba[8];
1715         uint8_t  dst_lba[8];
1716 };
1717
1718 struct scsi_ec_segment_verify
1719 {
1720         uint8_t  type_code;
1721 #define EC_SEG_VERIFY           0x07
1722         uint8_t  reserved;
1723         uint8_t  descr_length[2];
1724         uint8_t  src_cscd[2];
1725         uint8_t  reserved2[2];
1726         uint8_t  tur;
1727         uint8_t  reserved3[3];
1728 };
1729
1730 struct scsi_ec_segment_register_key
1731 {
1732         uint8_t  type_code;
1733 #define EC_SEG_REGISTER_KEY     0x14
1734         uint8_t  reserved;
1735         uint8_t  descr_length[2];
1736         uint8_t  reserved2[2];
1737         uint8_t  dst_cscd[2];
1738         uint8_t  res_key[8];
1739         uint8_t  sa_res_key[8];
1740         uint8_t  reserved3[4];
1741 };
1742
1743 struct scsi_extended_copy_lid1_data
1744 {
1745         uint8_t  list_identifier;
1746         uint8_t  flags;
1747 #define EC_PRIORITY             0x07
1748 #define EC_LIST_ID_USAGE_MASK   0x18
1749 #define EC_LIST_ID_USAGE_FULL   0x08
1750 #define EC_LIST_ID_USAGE_NOHOLD 0x10
1751 #define EC_LIST_ID_USAGE_NONE   0x18
1752 #define EC_STR                  0x20
1753         uint8_t  cscd_list_length[2];
1754         uint8_t  reserved[4];
1755         uint8_t  segment_list_length[4];
1756         uint8_t  inline_data_length[4];
1757         uint8_t  data[];
1758 };
1759
1760 struct scsi_extended_copy_lid4_data
1761 {
1762         uint8_t  list_format;
1763 #define EC_LIST_FORMAT          0x01
1764         uint8_t  flags;
1765         uint8_t  header_cscd_list_length[2];
1766         uint8_t  reserved[11];
1767         uint8_t  flags2;
1768 #define EC_IMMED                0x01
1769 #define EC_G_SENSE              0x02
1770         uint8_t  header_cscd_type_code;
1771         uint8_t  reserved2[3];
1772         uint8_t  list_identifier[4];
1773         uint8_t  reserved3[18];
1774         uint8_t  cscd_list_length[2];
1775         uint8_t  segment_list_length[2];
1776         uint8_t  inline_data_length[2];
1777         uint8_t  data[];
1778 };
1779
1780 struct scsi_copy_operation_abort
1781 {
1782         uint8_t  opcode;
1783         uint8_t  service_action;
1784 #define EC_COA                  0x1c
1785         uint8_t  list_identifier[4];
1786         uint8_t  reserved[9];
1787         uint8_t  control;
1788 };
1789
1790 struct scsi_populate_token
1791 {
1792         uint8_t  opcode;
1793         uint8_t  service_action;
1794 #define EC_PT                   0x10
1795         uint8_t  reserved[4];
1796         uint8_t  list_identifier[4];
1797         uint8_t  length[4];
1798         uint8_t  group_number;
1799         uint8_t  control;
1800 };
1801
1802 struct scsi_range_desc
1803 {
1804         uint8_t lba[8];
1805         uint8_t length[4];
1806         uint8_t reserved[4];
1807 };
1808
1809 struct scsi_populate_token_data
1810 {
1811         uint8_t  length[2];
1812         uint8_t  flags;
1813 #define EC_PT_IMMED                     0x01
1814 #define EC_PT_RTV                       0x02
1815         uint8_t  reserved;
1816         uint8_t  inactivity_timeout[4];
1817         uint8_t  rod_type[4];
1818         uint8_t  reserved2[2];
1819         uint8_t  range_descriptor_length[2];
1820         struct scsi_range_desc desc[];
1821 };
1822
1823 struct scsi_write_using_token
1824 {
1825         uint8_t  opcode;
1826         uint8_t  service_action;
1827 #define EC_WUT                  0x11
1828         uint8_t  reserved[4];
1829         uint8_t  list_identifier[4];
1830         uint8_t  length[4];
1831         uint8_t  group_number;
1832         uint8_t  control;
1833 };
1834
1835 struct scsi_write_using_token_data
1836 {
1837         uint8_t  length[2];
1838         uint8_t  flags;
1839 #define EC_WUT_IMMED                    0x01
1840 #define EC_WUT_DEL_TKN                  0x02
1841         uint8_t  reserved[5];
1842         uint8_t  offset_into_rod[8];
1843         uint8_t  rod_token[512];
1844         uint8_t  reserved2[6];
1845         uint8_t  range_descriptor_length[2];
1846         struct scsi_range_desc desc[];
1847 };
1848
1849 struct scsi_receive_rod_token_information
1850 {
1851         uint8_t  opcode;
1852         uint8_t  service_action;
1853 #define RCS_RRTI                0x07
1854         uint8_t  list_identifier[4];
1855         uint8_t  reserved[4];
1856         uint8_t  length[4];
1857         uint8_t  reserved2;
1858         uint8_t  control;
1859 };
1860
1861 struct scsi_token
1862 {
1863         uint8_t  type[4];
1864 #define ROD_TYPE_INTERNAL       0x00000000
1865 #define ROD_TYPE_AUR            0x00010000
1866 #define ROD_TYPE_PIT_DEF        0x00800000
1867 #define ROD_TYPE_PIT_VULN       0x00800001
1868 #define ROD_TYPE_PIT_PERS       0x00800002
1869 #define ROD_TYPE_PIT_ANY        0x0080FFFF
1870 #define ROD_TYPE_BLOCK_ZERO     0xFFFF0001
1871         uint8_t  reserved[2];
1872         uint8_t  length[2];
1873         uint8_t  body[0];
1874 };
1875
1876 struct scsi_report_all_rod_tokens
1877 {
1878         uint8_t  opcode;
1879         uint8_t  service_action;
1880 #define RCS_RART                0x08
1881         uint8_t  reserved[8];
1882         uint8_t  length[4];
1883         uint8_t  reserved2;
1884         uint8_t  control;
1885 };
1886
1887 struct scsi_report_all_rod_tokens_data
1888 {
1889         uint8_t  available_data[4];
1890         uint8_t  reserved[4];
1891         uint8_t  rod_management_token_list[];
1892 };
1893
1894 struct ata_pass_16 {
1895         u_int8_t opcode;
1896         u_int8_t protocol;
1897 #define AP_EXTEND       0x01
1898         u_int8_t flags;
1899 #define AP_FLAG_TLEN_NO_DATA    (0 << 0)
1900 #define AP_FLAG_TLEN_FEAT       (1 << 0)
1901 #define AP_FLAG_TLEN_SECT_CNT   (2 << 0)
1902 #define AP_FLAG_TLEN_STPSIU     (3 << 0)
1903 #define AP_FLAG_BYT_BLOK_BYTES  (0 << 2)
1904 #define AP_FLAG_BYT_BLOK_BLOCKS (1 << 2)
1905 #define AP_FLAG_TDIR_TO_DEV     (0 << 3)
1906 #define AP_FLAG_TDIR_FROM_DEV   (1 << 3)
1907 #define AP_FLAG_CHK_COND        (1 << 5)
1908         u_int8_t features_ext;
1909         u_int8_t features;
1910         u_int8_t sector_count_ext;
1911         u_int8_t sector_count;
1912         u_int8_t lba_low_ext;
1913         u_int8_t lba_low;
1914         u_int8_t lba_mid_ext;
1915         u_int8_t lba_mid;
1916         u_int8_t lba_high_ext;
1917         u_int8_t lba_high;
1918         u_int8_t device;
1919         u_int8_t command;
1920         u_int8_t control;
1921 };
1922
1923 #define SC_SCSI_1 0x01
1924 #define SC_SCSI_2 0x03
1925
1926 /*
1927  * Opcodes
1928  */
1929
1930 #define TEST_UNIT_READY         0x00
1931 #define REQUEST_SENSE           0x03
1932 #define READ_6                  0x08
1933 #define WRITE_6                 0x0A
1934 #define INQUIRY                 0x12
1935 #define MODE_SELECT_6           0x15
1936 #define MODE_SENSE_6            0x1A
1937 #define START_STOP_UNIT         0x1B
1938 #define START_STOP              0x1B
1939 #define RESERVE                 0x16
1940 #define RELEASE                 0x17
1941 #define RECEIVE_DIAGNOSTIC      0x1C
1942 #define SEND_DIAGNOSTIC         0x1D
1943 #define PREVENT_ALLOW           0x1E
1944 #define READ_CAPACITY           0x25
1945 #define READ_10                 0x28
1946 #define WRITE_10                0x2A
1947 #define POSITION_TO_ELEMENT     0x2B
1948 #define WRITE_VERIFY_10         0x2E
1949 #define VERIFY_10               0x2F
1950 #define SYNCHRONIZE_CACHE       0x35
1951 #define READ_DEFECT_DATA_10     0x37
1952 #define WRITE_BUFFER            0x3B
1953 #define READ_BUFFER             0x3C
1954 #define CHANGE_DEFINITION       0x40
1955 #define WRITE_SAME_10           0x41
1956 #define UNMAP                   0x42
1957 #define LOG_SELECT              0x4C
1958 #define LOG_SENSE               0x4D
1959 #define MODE_SELECT_10          0x55
1960 #define RESERVE_10              0x56
1961 #define RELEASE_10              0x57
1962 #define MODE_SENSE_10           0x5A
1963 #define PERSISTENT_RES_IN       0x5E
1964 #define PERSISTENT_RES_OUT      0x5F
1965 #define EXTENDED_COPY           0x83
1966 #define RECEIVE_COPY_STATUS     0x84
1967 #define ATA_PASS_16             0x85
1968 #define READ_16                 0x88
1969 #define COMPARE_AND_WRITE       0x89
1970 #define WRITE_16                0x8A
1971 #define READ_ATTRIBUTE          0x8C
1972 #define WRITE_ATTRIBUTE         0x8D
1973 #define WRITE_VERIFY_16         0x8E
1974 #define VERIFY_16               0x8F
1975 #define SYNCHRONIZE_CACHE_16    0x91
1976 #define WRITE_SAME_16           0x93
1977 #define WRITE_ATOMIC_16         0x9C
1978 #define SERVICE_ACTION_IN       0x9E
1979 #define REPORT_LUNS             0xA0
1980 #define ATA_PASS_12             0xA1
1981 #define SECURITY_PROTOCOL_IN    0xA2
1982 #define MAINTENANCE_IN          0xA3
1983 #define MAINTENANCE_OUT         0xA4
1984 #define MOVE_MEDIUM             0xA5
1985 #define READ_12                 0xA8
1986 #define WRITE_12                0xAA
1987 #define WRITE_VERIFY_12         0xAE
1988 #define VERIFY_12               0xAF
1989 #define SECURITY_PROTOCOL_OUT   0xB5
1990 #define READ_ELEMENT_STATUS     0xB8
1991 #define READ_CD                 0xBE
1992
1993 /* Maintenance In Service Action Codes */
1994 #define REPORT_IDENTIFYING_INFRMATION           0x05
1995 #define REPORT_TARGET_PORT_GROUPS               0x0A
1996 #define REPORT_ALIASES                          0x0B
1997 #define REPORT_SUPPORTED_OPERATION_CODES        0x0C
1998 #define REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS      0x0D
1999 #define REPORT_PRIORITY                         0x0E
2000 #define REPORT_TIMESTAMP                        0x0F
2001 #define MANAGEMENT_PROTOCOL_IN                  0x10
2002 /* Maintenance Out Service Action Codes */
2003 #define SET_IDENTIFY_INFORMATION                0x06
2004 #define SET_TARGET_PORT_GROUPS                  0x0A
2005 #define CHANGE_ALIASES                          0x0B
2006 #define SET_PRIORITY                            0x0E
2007 #define SET_TIMESTAMP                           0x0F
2008 #define MANGAEMENT_PROTOCOL_OUT                 0x10
2009
2010 /*
2011  * Device Types
2012  */
2013 #define T_DIRECT        0x00
2014 #define T_SEQUENTIAL    0x01
2015 #define T_PRINTER       0x02
2016 #define T_PROCESSOR     0x03
2017 #define T_WORM          0x04
2018 #define T_CDROM         0x05
2019 #define T_SCANNER       0x06
2020 #define T_OPTICAL       0x07
2021 #define T_CHANGER       0x08
2022 #define T_COMM          0x09
2023 #define T_ASC0          0x0a
2024 #define T_ASC1          0x0b
2025 #define T_STORARRAY     0x0c
2026 #define T_ENCLOSURE     0x0d
2027 #define T_RBC           0x0e
2028 #define T_OCRW          0x0f
2029 #define T_OSD           0x11
2030 #define T_ADC           0x12
2031 #define T_NODEVICE      0x1f
2032 #define T_ANY           0xff    /* Used in Quirk table matches */
2033
2034 #define T_REMOV         1
2035 #define T_FIXED         0
2036
2037 /*
2038  * This length is the initial inquiry length used by the probe code, as
2039  * well as the length necessary for scsi_print_inquiry() to function
2040  * correctly.  If either use requires a different length in the future,
2041  * the two values should be de-coupled.
2042  */
2043 #define SHORT_INQUIRY_LENGTH    36
2044
2045 struct scsi_inquiry_data
2046 {
2047         u_int8_t device;
2048 #define SID_TYPE(inq_data) ((inq_data)->device & 0x1f)
2049 #define SID_QUAL(inq_data) (((inq_data)->device & 0xE0) >> 5)
2050 #define SID_QUAL_LU_CONNECTED   0x00    /*
2051                                          * The specified peripheral device
2052                                          * type is currently connected to
2053                                          * logical unit.  If the target cannot
2054                                          * determine whether or not a physical
2055                                          * device is currently connected, it
2056                                          * shall also use this peripheral
2057                                          * qualifier when returning the INQUIRY
2058                                          * data.  This peripheral qualifier
2059                                          * does not mean that the device is
2060                                          * ready for access by the initiator.
2061                                          */
2062 #define SID_QUAL_LU_OFFLINE     0x01    /*
2063                                          * The target is capable of supporting
2064                                          * the specified peripheral device type
2065                                          * on this logical unit; however, the
2066                                          * physical device is not currently
2067                                          * connected to this logical unit.
2068                                          */
2069 #define SID_QUAL_RSVD           0x02
2070 #define SID_QUAL_BAD_LU         0x03    /*
2071                                          * The target is not capable of
2072                                          * supporting a physical device on
2073                                          * this logical unit. For this
2074                                          * peripheral qualifier the peripheral
2075                                          * device type shall be set to 1Fh to
2076                                          * provide compatibility with previous
2077                                          * versions of SCSI. All other
2078                                          * peripheral device type values are
2079                                          * reserved for this peripheral
2080                                          * qualifier.
2081                                          */
2082 #define SID_QUAL_IS_VENDOR_UNIQUE(inq_data) ((SID_QUAL(inq_data) & 0x04) != 0)
2083         u_int8_t dev_qual2;
2084 #define SID_QUAL2       0x7F
2085 #define SID_LU_CONG     0x40
2086 #define SID_RMB         0x80
2087 #define SID_IS_REMOVABLE(inq_data) (((inq_data)->dev_qual2 & SID_RMB) != 0)
2088         u_int8_t version;
2089 #define SID_ANSI_REV(inq_data) ((inq_data)->version & 0x07)
2090 #define         SCSI_REV_0              0
2091 #define         SCSI_REV_CCS            1
2092 #define         SCSI_REV_2              2
2093 #define         SCSI_REV_SPC            3
2094 #define         SCSI_REV_SPC2           4
2095 #define         SCSI_REV_SPC3           5
2096 #define         SCSI_REV_SPC4           6
2097
2098 #define SID_ECMA        0x38
2099 #define SID_ISO         0xC0
2100         u_int8_t response_format;
2101 #define SID_AENC        0x80
2102 #define SID_TrmIOP      0x40
2103 #define SID_NormACA     0x20
2104 #define SID_HiSup       0x10
2105         u_int8_t additional_length;
2106 #define SID_ADDITIONAL_LENGTH(iqd)                                      \
2107         ((iqd)->additional_length +                                     \
2108         __offsetof(struct scsi_inquiry_data, additional_length) + 1)
2109         u_int8_t spc3_flags;
2110 #define SPC3_SID_PROTECT        0x01
2111 #define SPC3_SID_3PC            0x08
2112 #define SPC3_SID_TPGS_MASK      0x30
2113 #define SPC3_SID_TPGS_IMPLICIT  0x10
2114 #define SPC3_SID_TPGS_EXPLICIT  0x20
2115 #define SPC3_SID_ACC            0x40
2116 #define SPC3_SID_SCCS           0x80
2117         u_int8_t spc2_flags;
2118 #define SPC2_SID_ADDR16         0x01
2119 #define SPC2_SID_MChngr         0x08
2120 #define SPC2_SID_MultiP         0x10
2121 #define SPC2_SID_EncServ        0x40
2122 #define SPC2_SID_BQueue         0x80
2123
2124 #define INQ_DATA_TQ_ENABLED(iqd)                                \
2125     ((SID_ANSI_REV(iqd) < SCSI_REV_SPC2)? ((iqd)->flags & SID_CmdQue) : \
2126     (((iqd)->flags & SID_CmdQue) && !((iqd)->spc2_flags & SPC2_SID_BQueue)) || \
2127     (!((iqd)->flags & SID_CmdQue) && ((iqd)->spc2_flags & SPC2_SID_BQueue)))
2128
2129         u_int8_t flags;
2130 #define SID_SftRe       0x01
2131 #define SID_CmdQue      0x02
2132 #define SID_Linked      0x08
2133 #define SID_Sync        0x10
2134 #define SID_WBus16      0x20
2135 #define SID_WBus32      0x40
2136 #define SID_RelAdr      0x80
2137 #define SID_VENDOR_SIZE   8
2138         char     vendor[SID_VENDOR_SIZE];
2139 #define SID_PRODUCT_SIZE  16
2140         char     product[SID_PRODUCT_SIZE];
2141 #define SID_REVISION_SIZE 4
2142         char     revision[SID_REVISION_SIZE];
2143         /*
2144          * The following fields were taken from SCSI Primary Commands - 2
2145          * (SPC-2) Revision 14, Dated 11 November 1999
2146          */
2147 #define SID_VENDOR_SPECIFIC_0_SIZE      20
2148         u_int8_t vendor_specific0[SID_VENDOR_SPECIFIC_0_SIZE];
2149         /*
2150          * An extension of SCSI Parallel Specific Values
2151          */
2152 #define SID_SPI_IUS             0x01
2153 #define SID_SPI_QAS             0x02
2154 #define SID_SPI_CLOCK_ST        0x00
2155 #define SID_SPI_CLOCK_DT        0x04
2156 #define SID_SPI_CLOCK_DT_ST     0x0C
2157 #define SID_SPI_MASK            0x0F
2158         u_int8_t spi3data;
2159         u_int8_t reserved2;
2160         /*
2161          * Version Descriptors, stored 2 byte values.
2162          */
2163         u_int8_t version1[2];
2164         u_int8_t version2[2];
2165         u_int8_t version3[2];
2166         u_int8_t version4[2];
2167         u_int8_t version5[2];
2168         u_int8_t version6[2];
2169         u_int8_t version7[2];
2170         u_int8_t version8[2];
2171
2172         u_int8_t reserved3[22];
2173
2174 #define SID_VENDOR_SPECIFIC_1_SIZE      160
2175         u_int8_t vendor_specific1[SID_VENDOR_SPECIFIC_1_SIZE];
2176 };
2177
2178 /*
2179  * This structure is more suited to initiator operation, because the
2180  * maximum number of supported pages is already allocated.
2181  */
2182 struct scsi_vpd_supported_page_list
2183 {
2184         u_int8_t device;
2185         u_int8_t page_code;
2186 #define SVPD_SUPPORTED_PAGE_LIST        0x00
2187 #define SVPD_SUPPORTED_PAGES_HDR_LEN    4
2188         u_int8_t reserved;
2189         u_int8_t length;        /* number of VPD entries */
2190 #define SVPD_SUPPORTED_PAGES_SIZE       251
2191         u_int8_t list[SVPD_SUPPORTED_PAGES_SIZE];
2192 };
2193
2194 /*
2195  * This structure is more suited to target operation, because the
2196  * number of supported pages is left to the user to allocate.
2197  */
2198 struct scsi_vpd_supported_pages
2199 {
2200         u_int8_t device;
2201         u_int8_t page_code;
2202         u_int8_t reserved;
2203 #define SVPD_SUPPORTED_PAGES    0x00
2204         u_int8_t length;
2205         u_int8_t page_list[0];
2206 };
2207
2208
2209 struct scsi_vpd_unit_serial_number
2210 {
2211         u_int8_t device;
2212         u_int8_t page_code;
2213 #define SVPD_UNIT_SERIAL_NUMBER 0x80
2214         u_int8_t reserved;
2215         u_int8_t length; /* serial number length */
2216 #define SVPD_SERIAL_NUM_SIZE 251
2217         u_int8_t serial_num[SVPD_SERIAL_NUM_SIZE];
2218 };
2219
2220 struct scsi_vpd_device_id
2221 {
2222         u_int8_t device;
2223         u_int8_t page_code;
2224 #define SVPD_DEVICE_ID                  0x83
2225 #define SVPD_DEVICE_ID_MAX_SIZE         252
2226 #define SVPD_DEVICE_ID_HDR_LEN \
2227     __offsetof(struct scsi_vpd_device_id, desc_list)
2228         u_int8_t length[2];
2229         u_int8_t desc_list[];
2230 };
2231
2232 struct scsi_vpd_id_descriptor
2233 {
2234         u_int8_t        proto_codeset;
2235         /*
2236          * See the SCSI_PROTO definitions above for the protocols.
2237          */
2238 #define SVPD_ID_PROTO_SHIFT     4
2239 #define SVPD_ID_CODESET_BINARY  0x01
2240 #define SVPD_ID_CODESET_ASCII   0x02
2241 #define SVPD_ID_CODESET_UTF8    0x03
2242 #define SVPD_ID_CODESET_MASK    0x0f
2243         u_int8_t        id_type;
2244 #define SVPD_ID_PIV             0x80
2245 #define SVPD_ID_ASSOC_LUN       0x00
2246 #define SVPD_ID_ASSOC_PORT      0x10
2247 #define SVPD_ID_ASSOC_TARGET    0x20
2248 #define SVPD_ID_ASSOC_MASK      0x30
2249 #define SVPD_ID_TYPE_VENDOR     0x00
2250 #define SVPD_ID_TYPE_T10        0x01
2251 #define SVPD_ID_TYPE_EUI64      0x02
2252 #define SVPD_ID_TYPE_NAA        0x03
2253 #define SVPD_ID_TYPE_RELTARG    0x04
2254 #define SVPD_ID_TYPE_TPORTGRP   0x05
2255 #define SVPD_ID_TYPE_LUNGRP     0x06
2256 #define SVPD_ID_TYPE_MD5_LUN_ID 0x07
2257 #define SVPD_ID_TYPE_SCSI_NAME  0x08
2258 #define SVPD_ID_TYPE_MASK       0x0f
2259         u_int8_t        reserved;
2260         u_int8_t        length;
2261 #define SVPD_DEVICE_ID_DESC_HDR_LEN \
2262     __offsetof(struct scsi_vpd_id_descriptor, identifier)
2263         u_int8_t        identifier[];
2264 };
2265
2266 struct scsi_vpd_id_t10
2267 {
2268         u_int8_t        vendor[8];
2269         u_int8_t        vendor_spec_id[0];
2270 };
2271
2272 struct scsi_vpd_id_eui64
2273 {
2274         u_int8_t        ieee_company_id[3];
2275         u_int8_t        extension_id[5];
2276 };
2277
2278 struct scsi_vpd_id_naa_basic
2279 {
2280         uint8_t naa;
2281         /* big endian, packed:
2282         uint8_t naa : 4;
2283         uint8_t naa_desig : 4;
2284         */
2285 #define SVPD_ID_NAA_NAA_SHIFT           4
2286 #define SVPD_ID_NAA_IEEE_EXT            0x02
2287 #define SVPD_ID_NAA_LOCAL_REG           0x03
2288 #define SVPD_ID_NAA_IEEE_REG            0x05
2289 #define SVPD_ID_NAA_IEEE_REG_EXT        0x06
2290         uint8_t naa_data[];
2291 };
2292
2293 struct scsi_vpd_id_naa_ieee_extended_id
2294 {
2295         uint8_t naa;
2296         uint8_t vendor_specific_id_a;
2297         uint8_t ieee_company_id[3];
2298         uint8_t vendor_specific_id_b[4];
2299 };
2300
2301 struct scsi_vpd_id_naa_local_reg
2302 {
2303         uint8_t naa;
2304         uint8_t local_value[7];
2305 };
2306
2307 struct scsi_vpd_id_naa_ieee_reg
2308 {
2309         uint8_t naa;
2310         uint8_t reg_value[7];
2311         /* big endian, packed:
2312         uint8_t naa_basic : 4;
2313         uint8_t ieee_company_id_0 : 4;
2314         uint8_t ieee_company_id_1[2];
2315         uint8_t ieee_company_id_2 : 4;
2316         uint8_t vendor_specific_id_0 : 4;
2317         uint8_t vendor_specific_id_1[4];
2318         */
2319 };
2320
2321 struct scsi_vpd_id_naa_ieee_reg_extended
2322 {
2323         uint8_t naa;
2324         uint8_t reg_value[15];
2325         /* big endian, packed:
2326         uint8_t naa_basic : 4;
2327         uint8_t ieee_company_id_0 : 4;
2328         uint8_t ieee_company_id_1[2];
2329         uint8_t ieee_company_id_2 : 4;
2330         uint8_t vendor_specific_id_0 : 4;
2331         uint8_t vendor_specific_id_1[4];
2332         uint8_t vendor_specific_id_ext[8];
2333         */
2334 };
2335
2336 struct scsi_vpd_id_rel_trgt_port_id
2337 {
2338         uint8_t obsolete[2];
2339         uint8_t rel_trgt_port_id[2];
2340 };
2341
2342 struct scsi_vpd_id_trgt_port_grp_id
2343 {
2344         uint8_t reserved[2];
2345         uint8_t trgt_port_grp[2];
2346 };
2347
2348 struct scsi_vpd_id_lun_grp_id
2349 {
2350         uint8_t reserved[2];
2351         uint8_t log_unit_grp[2];
2352 };
2353
2354 struct scsi_vpd_id_md5_lun_id
2355 {
2356         uint8_t lun_id[16];
2357 };
2358
2359 struct scsi_vpd_id_scsi_name
2360 {
2361         uint8_t name_string[256];
2362 };
2363
2364 struct scsi_service_action_in
2365 {
2366         uint8_t opcode;
2367         uint8_t service_action;
2368         uint8_t action_dependent[13];
2369         uint8_t control;
2370 };
2371
2372 struct scsi_vpd_extended_inquiry_data
2373 {
2374         uint8_t device;
2375         uint8_t page_code;
2376 #define SVPD_EXTENDED_INQUIRY_DATA      0x86
2377         uint8_t page_length[2];
2378         uint8_t flags1;
2379
2380         /* These values are for direct access devices */
2381 #define SVPD_EID_AM_MASK        0xC0
2382 #define SVPD_EID_AM_DEFER       0x80
2383 #define SVPD_EID_AM_IMMED       0x40
2384 #define SVPD_EID_AM_UNDEFINED   0x00
2385 #define SVPD_EID_AM_RESERVED    0xc0
2386 #define SVPD_EID_SPT            0x38
2387 #define SVPD_EID_SPT_1          0x00
2388 #define SVPD_EID_SPT_12         0x08
2389 #define SVPD_EID_SPT_2          0x10
2390 #define SVPD_EID_SPT_13         0x18
2391 #define SVPD_EID_SPT_3          0x20
2392 #define SVPD_EID_SPT_23         0x28
2393 #define SVPD_EID_SPT_123        0x38
2394
2395         /* These values are for sequential access devices */
2396 #define SVPD_EID_SA_SPT_LBP     0x08
2397
2398 #define SVPD_EID_GRD_CHK        0x04
2399 #define SVPD_EID_APP_CHK        0x02
2400 #define SVPD_EID_REF_CHK        0x01
2401
2402         uint8_t flags2;
2403 #define SVPD_EID_UASK_SUP       0x20
2404 #define SVPD_EID_GROUP_SUP      0x10
2405 #define SVPD_EID_PRIOR_SUP      0x08
2406 #define SVPD_EID_HEADSUP        0x04
2407 #define SVPD_EID_ORDSUP         0x02
2408 #define SVPD_EID_SIMPSUP        0x01
2409         uint8_t flags3;
2410 #define SVPD_EID_WU_SUP         0x08
2411 #define SVPD_EID_CRD_SUP        0x04
2412 #define SVPD_EID_NV_SUP         0x02
2413 #define SVPD_EID_V_SUP          0x01
2414         uint8_t flags4;
2415 #define SVPD_EID_P_I_I_SUP      0x10
2416 #define SVPD_EID_LUICLT         0x01
2417         uint8_t flags5;
2418 #define SVPD_EID_R_SUP          0x10
2419 #define SVPD_EID_CBCS           0x01
2420         uint8_t flags6;
2421 #define SVPD_EID_MULTI_I_T_FW   0x0F
2422 #define SVPD_EID_MC_VENDOR_SPEC 0x00
2423 #define SVPD_EID_MC_MODE_1      0x01
2424 #define SVPD_EID_MC_MODE_2      0x02
2425 #define SVPD_EID_MC_MODE_3      0x03
2426         uint8_t est[2];
2427         uint8_t flags7;
2428 #define SVPD_EID_POA_SUP        0x80
2429 #define SVPD_EID_HRA_SUP        0x80
2430 #define SVPD_EID_VSA_SUP        0x80
2431         uint8_t max_sense_length;
2432         uint8_t reserved2[50];
2433 };
2434
2435 struct scsi_vpd_mode_page_policy_descr
2436 {
2437         uint8_t page_code;
2438         uint8_t subpage_code;
2439         uint8_t policy;
2440 #define SVPD_MPP_SHARED         0x00
2441 #define SVPD_MPP_PORT           0x01
2442 #define SVPD_MPP_I_T            0x03
2443 #define SVPD_MPP_MLUS           0x80
2444         uint8_t reserved;
2445 };
2446
2447 struct scsi_vpd_mode_page_policy
2448 {
2449         uint8_t device;
2450         uint8_t page_code;
2451 #define SVPD_MODE_PAGE_POLICY   0x87
2452         uint8_t page_length[2];
2453         struct scsi_vpd_mode_page_policy_descr descr[0];
2454 };
2455
2456 struct scsi_diag_page {
2457         uint8_t page_code;
2458         uint8_t page_specific_flags;
2459         uint8_t length[2];
2460         uint8_t params[0];
2461 };
2462
2463 struct scsi_vpd_port_designation
2464 {
2465         uint8_t reserved[2];
2466         uint8_t relative_port_id[2];
2467         uint8_t reserved2[2];
2468         uint8_t initiator_transportid_length[2];
2469         uint8_t initiator_transportid[0];
2470 };
2471
2472 struct scsi_vpd_port_designation_cont
2473 {
2474         uint8_t reserved[2];
2475         uint8_t target_port_descriptors_length[2];
2476         struct scsi_vpd_id_descriptor target_port_descriptors[0];
2477 };
2478
2479 struct scsi_vpd_scsi_ports
2480 {
2481         u_int8_t device;
2482         u_int8_t page_code;
2483 #define SVPD_SCSI_PORTS         0x88
2484         u_int8_t page_length[2];
2485         struct scsi_vpd_port_designation design[];
2486 };
2487
2488 /*
2489  * ATA Information VPD Page based on
2490  * T10/2126-D Revision 04
2491  */
2492 #define SVPD_ATA_INFORMATION            0x89
2493
2494
2495 struct scsi_vpd_tpc_descriptor
2496 {
2497         uint8_t desc_type[2];
2498         uint8_t desc_length[2];
2499         uint8_t parameters[];
2500 };
2501
2502 struct scsi_vpd_tpc_descriptor_bdrl
2503 {
2504         uint8_t desc_type[2];
2505 #define SVPD_TPC_BDRL                   0x0000
2506         uint8_t desc_length[2];
2507         uint8_t vendor_specific[6];
2508         uint8_t maximum_ranges[2];
2509         uint8_t maximum_inactivity_timeout[4];
2510         uint8_t default_inactivity_timeout[4];
2511         uint8_t maximum_token_transfer_size[8];
2512         uint8_t optimal_transfer_count[8];
2513 };
2514
2515 struct scsi_vpd_tpc_descriptor_sc_descr
2516 {
2517         uint8_t opcode;
2518         uint8_t sa_length;
2519         uint8_t supported_service_actions[0];
2520 };
2521
2522 struct scsi_vpd_tpc_descriptor_sc
2523 {
2524         uint8_t desc_type[2];
2525 #define SVPD_TPC_SC                     0x0001
2526         uint8_t desc_length[2];
2527         uint8_t list_length;
2528         struct scsi_vpd_tpc_descriptor_sc_descr descr[];
2529 };
2530
2531 struct scsi_vpd_tpc_descriptor_pd
2532 {
2533         uint8_t desc_type[2];
2534 #define SVPD_TPC_PD                     0x0004
2535         uint8_t desc_length[2];
2536         uint8_t reserved[4];
2537         uint8_t maximum_cscd_descriptor_count[2];
2538         uint8_t maximum_segment_descriptor_count[2];
2539         uint8_t maximum_descriptor_list_length[4];
2540         uint8_t maximum_inline_data_length[4];
2541         uint8_t reserved2[12];
2542 };
2543
2544 struct scsi_vpd_tpc_descriptor_sd
2545 {
2546         uint8_t desc_type[2];
2547 #define SVPD_TPC_SD                     0x0008
2548         uint8_t desc_length[2];
2549         uint8_t list_length;
2550         uint8_t supported_descriptor_codes[];
2551 };
2552
2553 struct scsi_vpd_tpc_descriptor_sdid
2554 {
2555         uint8_t desc_type[2];
2556 #define SVPD_TPC_SDID                   0x000C
2557         uint8_t desc_length[2];
2558         uint8_t list_length[2];
2559         uint8_t supported_descriptor_ids[];
2560 };
2561
2562 struct scsi_vpd_tpc_descriptor_rtf_block
2563 {
2564         uint8_t type_format;
2565 #define SVPD_TPC_RTF_BLOCK                      0x00
2566         uint8_t reserved;
2567         uint8_t desc_length[2];
2568         uint8_t reserved2[2];
2569         uint8_t optimal_length_granularity[2];
2570         uint8_t maximum_bytes[8];
2571         uint8_t optimal_bytes[8];
2572         uint8_t optimal_bytes_to_token_per_segment[8];
2573         uint8_t optimal_bytes_from_token_per_segment[8];
2574         uint8_t reserved3[8];
2575 };
2576
2577 struct scsi_vpd_tpc_descriptor_rtf
2578 {
2579         uint8_t desc_type[2];
2580 #define SVPD_TPC_RTF                    0x0106
2581         uint8_t desc_length[2];
2582         uint8_t remote_tokens;
2583         uint8_t reserved[11];
2584         uint8_t minimum_token_lifetime[4];
2585         uint8_t maximum_token_lifetime[4];
2586         uint8_t maximum_token_inactivity_timeout[4];
2587         uint8_t reserved2[18];
2588         uint8_t type_specific_features_length[2];
2589         uint8_t type_specific_features[0];
2590 };
2591
2592 struct scsi_vpd_tpc_descriptor_srtd
2593 {
2594         uint8_t rod_type[4];
2595         uint8_t flags;
2596 #define SVPD_TPC_SRTD_TOUT              0x01
2597 #define SVPD_TPC_SRTD_TIN               0x02
2598 #define SVPD_TPC_SRTD_ECPY              0x80
2599         uint8_t reserved;
2600         uint8_t preference_indicator[2];
2601         uint8_t reserved2[56];
2602 };
2603
2604 struct scsi_vpd_tpc_descriptor_srt
2605 {
2606         uint8_t desc_type[2];
2607 #define SVPD_TPC_SRT                    0x0108
2608         uint8_t desc_length[2];
2609         uint8_t reserved[2];
2610         uint8_t rod_type_descriptors_length[2];
2611         uint8_t rod_type_descriptors[0];
2612 };
2613
2614 struct scsi_vpd_tpc_descriptor_gco
2615 {
2616         uint8_t desc_type[2];
2617 #define SVPD_TPC_GCO                    0x8001
2618         uint8_t desc_length[2];
2619         uint8_t total_concurrent_copies[4];
2620         uint8_t maximum_identified_concurrent_copies[4];
2621         uint8_t maximum_segment_length[4];
2622         uint8_t data_segment_granularity;
2623         uint8_t inline_data_granularity;
2624         uint8_t reserved[18];
2625 };
2626
2627 struct scsi_vpd_tpc
2628 {
2629         uint8_t device;
2630         uint8_t page_code;
2631 #define SVPD_SCSI_TPC                   0x8F
2632         uint8_t page_length[2];
2633         struct scsi_vpd_tpc_descriptor descr[];
2634 };
2635
2636 /*
2637  * Block Device Characteristics VPD Page based on
2638  * T10/1799-D Revision 31
2639  */
2640 struct scsi_vpd_block_characteristics
2641 {
2642         u_int8_t device;
2643         u_int8_t page_code;
2644 #define SVPD_BDC                        0xB1
2645         u_int8_t page_length[2];
2646         u_int8_t medium_rotation_rate[2];
2647 #define SVPD_BDC_RATE_NOT_REPORTED      0x00
2648 #define SVPD_BDC_RATE_NON_ROTATING      0x01
2649         u_int8_t reserved1;
2650         u_int8_t nominal_form_factor;
2651 #define SVPD_BDC_FORM_NOT_REPORTED      0x00
2652 #define SVPD_BDC_FORM_5_25INCH          0x01
2653 #define SVPD_BDC_FORM_3_5INCH           0x02
2654 #define SVPD_BDC_FORM_2_5INCH           0x03
2655 #define SVPD_BDC_FORM_1_5INCH           0x04
2656 #define SVPD_BDC_FORM_LESSTHAN_1_5INCH  0x05
2657         u_int8_t reserved2[56];
2658 };
2659
2660 /*
2661  * Block Device Characteristics VPD Page
2662  */
2663 struct scsi_vpd_block_device_characteristics
2664 {
2665         uint8_t device;
2666         uint8_t page_code;
2667 #define SVPD_BDC                0xB1
2668         uint8_t page_length[2];
2669         uint8_t medium_rotation_rate[2];
2670 #define SVPD_NOT_REPORTED       0x0000
2671 #define SVPD_NON_ROTATING       0x0001
2672         uint8_t product_type;
2673         uint8_t wab_wac_ff;
2674         uint8_t flags;
2675 #define SVPD_VBULS              0x01
2676 #define SVPD_FUAB               0x02
2677 #define SVPD_HAW_ZBC            0x10
2678         uint8_t reserved[55];
2679 };
2680
2681 /*
2682  * Logical Block Provisioning VPD Page based on
2683  * T10/1799-D Revision 31
2684  */
2685 struct scsi_vpd_logical_block_prov
2686 {
2687         u_int8_t device;
2688         u_int8_t page_code;
2689 #define SVPD_LBP                0xB2
2690         u_int8_t page_length[2];
2691 #define SVPD_LBP_PL_BASIC       0x04
2692         u_int8_t threshold_exponent;
2693         u_int8_t flags;
2694 #define SVPD_LBP_UNMAP          0x80
2695 #define SVPD_LBP_WS16           0x40
2696 #define SVPD_LBP_WS10           0x20
2697 #define SVPD_LBP_RZ             0x04
2698 #define SVPD_LBP_ANC_SUP        0x02
2699 #define SVPD_LBP_DP             0x01
2700         u_int8_t prov_type;
2701 #define SVPD_LBP_RESOURCE       0x01
2702 #define SVPD_LBP_THIN           0x02
2703         u_int8_t reserved;
2704         /*
2705          * Provisioning Group Descriptor can be here if SVPD_LBP_DP is set
2706          * Its size can be determined from page_length - 4
2707          */
2708 };
2709
2710 /*
2711  * Block Limits VDP Page based on SBC-4 Revision 2
2712  */
2713 struct scsi_vpd_block_limits
2714 {
2715         u_int8_t device;
2716         u_int8_t page_code;
2717 #define SVPD_BLOCK_LIMITS       0xB0
2718         u_int8_t page_length[2];
2719 #define SVPD_BL_PL_BASIC        0x10
2720 #define SVPD_BL_PL_TP           0x3C
2721         u_int8_t reserved1;
2722         u_int8_t max_cmp_write_len;
2723         u_int8_t opt_txfer_len_grain[2];
2724         u_int8_t max_txfer_len[4];
2725         u_int8_t opt_txfer_len[4];
2726         u_int8_t max_prefetch[4];
2727         u_int8_t max_unmap_lba_cnt[4];
2728         u_int8_t max_unmap_blk_cnt[4];
2729         u_int8_t opt_unmap_grain[4];
2730         u_int8_t unmap_grain_align[4];
2731         u_int8_t max_write_same_length[8];
2732         u_int8_t max_atomic_transfer_length[4];
2733         u_int8_t atomic_alignment[4];
2734         u_int8_t atomic_transfer_length_granularity[4];
2735         u_int8_t reserved2[8];
2736 };
2737
2738 struct scsi_read_capacity
2739 {
2740         u_int8_t opcode;
2741         u_int8_t byte2;
2742 #define SRC_RELADR      0x01
2743         u_int8_t addr[4];
2744         u_int8_t unused[2];
2745         u_int8_t pmi;
2746 #define SRC_PMI         0x01
2747         u_int8_t control;
2748 };
2749
2750 struct scsi_read_capacity_16
2751 {
2752         uint8_t opcode;
2753 #define SRC16_SERVICE_ACTION    0x10
2754         uint8_t service_action;
2755         uint8_t addr[8];
2756         uint8_t alloc_len[4];
2757 #define SRC16_PMI               0x01
2758 #define SRC16_RELADR            0x02
2759         uint8_t reladr;
2760         uint8_t control;
2761 };
2762
2763 struct scsi_read_capacity_data
2764 {
2765         u_int8_t addr[4];
2766         u_int8_t length[4];
2767 };
2768
2769 struct scsi_read_capacity_data_long
2770 {
2771         uint8_t addr[8];
2772         uint8_t length[4];
2773 #define SRC16_PROT_EN           0x01
2774 #define SRC16_P_TYPE            0x0e
2775 #define SRC16_PTYPE_1           0x00
2776 #define SRC16_PTYPE_2           0x02
2777 #define SRC16_PTYPE_3           0x04
2778         uint8_t prot;
2779 #define SRC16_LBPPBE            0x0f
2780 #define SRC16_PI_EXPONENT       0xf0
2781 #define SRC16_PI_EXPONENT_SHIFT 4
2782         uint8_t prot_lbppbe;
2783 #define SRC16_LALBA             0x3f
2784 #define SRC16_LBPRZ             0x40
2785 #define SRC16_LBPME             0x80
2786 /*
2787  * Alternate versions of these macros that are intended for use on a 16-bit
2788  * version of the lalba_lbp field instead of the array of 2 8 bit numbers.
2789  */
2790 #define SRC16_LALBA_A           0x3fff
2791 #define SRC16_LBPRZ_A           0x4000
2792 #define SRC16_LBPME_A           0x8000
2793         uint8_t lalba_lbp[2];
2794         uint8_t reserved[16];
2795 };
2796
2797 struct scsi_get_lba_status
2798 {
2799         uint8_t opcode;
2800 #define SGLS_SERVICE_ACTION     0x12
2801         uint8_t service_action;
2802         uint8_t addr[8];
2803         uint8_t alloc_len[4];
2804         uint8_t reserved;
2805         uint8_t control;
2806 };
2807
2808 struct scsi_get_lba_status_data_descr
2809 {
2810         uint8_t addr[8];
2811         uint8_t length[4];
2812         uint8_t status;
2813         uint8_t reserved[3];
2814 };
2815
2816 struct scsi_get_lba_status_data
2817 {
2818         uint8_t length[4];
2819         uint8_t reserved[4];
2820         struct scsi_get_lba_status_data_descr descr[];
2821 };
2822
2823 struct scsi_report_luns
2824 {
2825         uint8_t opcode;
2826         uint8_t reserved1;
2827 #define RPL_REPORT_DEFAULT      0x00
2828 #define RPL_REPORT_WELLKNOWN    0x01
2829 #define RPL_REPORT_ALL          0x02
2830         uint8_t select_report;
2831         uint8_t reserved2[3];
2832         uint8_t length[4];
2833         uint8_t reserved3;
2834         uint8_t control;
2835 };
2836
2837 struct scsi_report_luns_lundata {
2838         uint8_t lundata[8];
2839 #define RPL_LUNDATA_PERIPH_BUS_MASK     0x3f
2840 #define RPL_LUNDATA_FLAT_LUN_MASK       0x3f
2841 #define RPL_LUNDATA_FLAT_LUN_BITS       0x06
2842 #define RPL_LUNDATA_LUN_TARG_MASK       0x3f
2843 #define RPL_LUNDATA_LUN_BUS_MASK        0xe0
2844 #define RPL_LUNDATA_LUN_LUN_MASK        0x1f
2845 #define RPL_LUNDATA_EXT_LEN_MASK        0x30
2846 #define RPL_LUNDATA_EXT_EAM_MASK        0x0f
2847 #define RPL_LUNDATA_EXT_EAM_WK          0x01
2848 #define RPL_LUNDATA_EXT_EAM_NOT_SPEC    0x0f
2849 #define RPL_LUNDATA_ATYP_MASK   0xc0    /* MBZ for type 0 lun */
2850 #define RPL_LUNDATA_ATYP_PERIPH 0x00
2851 #define RPL_LUNDATA_ATYP_FLAT   0x40
2852 #define RPL_LUNDATA_ATYP_LUN    0x80
2853 #define RPL_LUNDATA_ATYP_EXTLUN 0xc0
2854 };
2855
2856 struct scsi_report_luns_data {
2857         u_int8_t length[4];     /* length of LUN inventory, in bytes */
2858         u_int8_t reserved[4];   /* unused */
2859         /*
2860          * LUN inventory- we only support the type zero form for now.
2861          */
2862         struct scsi_report_luns_lundata luns[0];
2863 };
2864
2865 struct scsi_target_group
2866 {
2867         uint8_t opcode;
2868         uint8_t service_action;
2869 #define STG_PDF_MASK            0xe0
2870 #define STG_PDF_LENGTH          0x00
2871 #define STG_PDF_EXTENDED        0x20
2872         uint8_t reserved1[4];
2873         uint8_t length[4];
2874         uint8_t reserved2;
2875         uint8_t control;
2876 };
2877
2878 struct scsi_target_port_descriptor {
2879         uint8_t reserved[2];
2880         uint8_t relative_target_port_identifier[2];
2881         uint8_t desc_list[];
2882 };
2883
2884 struct scsi_target_port_group_descriptor {
2885         uint8_t pref_state;
2886 #define TPG_PRIMARY                             0x80
2887 #define TPG_ASYMMETRIC_ACCESS_STATE_MASK        0xf
2888 #define TPG_ASYMMETRIC_ACCESS_OPTIMIZED         0x0
2889 #define TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED      0x1
2890 #define TPG_ASYMMETRIC_ACCESS_STANDBY           0x2
2891 #define TPG_ASYMMETRIC_ACCESS_UNAVAILABLE       0x3
2892 #define TPG_ASYMMETRIC_ACCESS_LBA_DEPENDENT     0x4
2893 #define TPG_ASYMMETRIC_ACCESS_OFFLINE           0xE
2894 #define TPG_ASYMMETRIC_ACCESS_TRANSITIONING     0xF
2895         uint8_t support;
2896 #define TPG_AO_SUP      0x01
2897 #define TPG_AN_SUP      0x02
2898 #define TPG_S_SUP       0x04
2899 #define TPG_U_SUP       0x08
2900 #define TPG_LBD_SUP     0x10
2901 #define TPG_O_SUP       0x40
2902 #define TPG_T_SUP       0x80
2903         uint8_t target_port_group[2];
2904         uint8_t reserved;
2905         uint8_t status;
2906 #define TPG_UNAVLBL      0
2907 #define TPG_SET_BY_STPG  0x01
2908 #define TPG_IMPLICIT     0x02
2909         uint8_t vendor_specific;
2910         uint8_t target_port_count;
2911         struct scsi_target_port_descriptor descriptors[];
2912 };
2913
2914 struct scsi_target_group_data {
2915         uint8_t length[4];      /* length of returned data, in bytes */
2916         struct scsi_target_port_group_descriptor groups[];
2917 };
2918
2919 struct scsi_target_group_data_extended {
2920         uint8_t length[4];      /* length of returned data, in bytes */
2921         uint8_t format_type;    /* STG_PDF_LENGTH or STG_PDF_EXTENDED */
2922         uint8_t implicit_transition_time;
2923         uint8_t reserved[2];
2924         struct scsi_target_port_group_descriptor groups[];
2925 };
2926
2927 struct scsi_security_protocol_in
2928 {
2929         uint8_t opcode;
2930         uint8_t security_protocol;
2931 #define SPI_PROT_INFORMATION            0x00
2932 #define SPI_PROT_CBCS                   0x07
2933 #define SPI_PROT_TAPE_DATA_ENC          0x20
2934 #define SPI_PROT_DATA_ENC_CONFIG        0x21
2935 #define SPI_PROT_SA_CREATE_CAP          0x40
2936 #define SPI_PROT_IKEV2_SCSI             0x41
2937 #define SPI_PROT_JEDEC_UFS              0xEC
2938 #define SPI_PROT_SDCARD_TFSSS           0xED
2939 #define SPI_PROT_AUTH_HOST_TRANSIENT    0xEE
2940 #define SPI_PROT_ATA_DEVICE_PASSWORD    0xEF
2941         uint8_t security_protocol_specific[2];
2942         uint8_t byte4;
2943 #define SPI_INC_512     0x80
2944         uint8_t reserved1;
2945         uint8_t length[4];
2946         uint8_t reserved2;
2947         uint8_t control;
2948 };
2949
2950 struct scsi_security_protocol_out
2951 {
2952         uint8_t opcode;
2953         uint8_t security_protocol;
2954         uint8_t security_protocol_specific[2];
2955         uint8_t byte4;
2956 #define SPO_INC_512     0x80
2957         uint8_t reserved1;
2958         uint8_t length[4];
2959         uint8_t reserved2;
2960         uint8_t control;
2961 };
2962
2963 typedef enum {
2964         SSD_TYPE_NONE,
2965         SSD_TYPE_FIXED,
2966         SSD_TYPE_DESC
2967 } scsi_sense_data_type;
2968
2969 typedef enum {
2970         SSD_ELEM_NONE,
2971         SSD_ELEM_SKIP,
2972         SSD_ELEM_DESC,
2973         SSD_ELEM_SKS,
2974         SSD_ELEM_COMMAND,
2975         SSD_ELEM_INFO,
2976         SSD_ELEM_FRU,
2977         SSD_ELEM_STREAM,
2978         SSD_ELEM_MAX
2979 } scsi_sense_elem_type;
2980
2981
2982 struct scsi_sense_data
2983 {
2984         uint8_t error_code;
2985         /*
2986          * SPC-4 says that the maximum length of sense data is 252 bytes.
2987          * So this structure is exactly 252 bytes log.
2988          */
2989 #define SSD_FULL_SIZE 252
2990         uint8_t sense_buf[SSD_FULL_SIZE - 1];
2991         /*
2992          * XXX KDM is this still a reasonable minimum size?
2993          */
2994 #define SSD_MIN_SIZE 18
2995         /*
2996          * Maximum value for the extra_len field in the sense data.
2997          */
2998 #define SSD_EXTRA_MAX 244
2999 };
3000
3001 /*
3002  * Fixed format sense data.
3003  */
3004 struct scsi_sense_data_fixed
3005 {
3006         u_int8_t error_code;
3007 #define SSD_ERRCODE                     0x7F
3008 #define         SSD_CURRENT_ERROR       0x70
3009 #define         SSD_DEFERRED_ERROR      0x71
3010 #define SSD_ERRCODE_VALID       0x80
3011         u_int8_t segment;
3012         u_int8_t flags;
3013 #define SSD_KEY                         0x0F
3014 #define         SSD_KEY_NO_SENSE        0x00
3015 #define         SSD_KEY_RECOVERED_ERROR 0x01
3016 #define         SSD_KEY_NOT_READY       0x02
3017 #define         SSD_KEY_MEDIUM_ERROR    0x03
3018 #define         SSD_KEY_HARDWARE_ERROR  0x04
3019 #define         SSD_KEY_ILLEGAL_REQUEST 0x05
3020 #define         SSD_KEY_UNIT_ATTENTION  0x06
3021 #define         SSD_KEY_DATA_PROTECT    0x07
3022 #define         SSD_KEY_BLANK_CHECK     0x08
3023 #define         SSD_KEY_Vendor_Specific 0x09
3024 #define         SSD_KEY_COPY_ABORTED    0x0a
3025 #define         SSD_KEY_ABORTED_COMMAND 0x0b
3026 #define         SSD_KEY_EQUAL           0x0c
3027 #define         SSD_KEY_VOLUME_OVERFLOW 0x0d
3028 #define         SSD_KEY_MISCOMPARE      0x0e
3029 #define         SSD_KEY_COMPLETED       0x0f
3030 #define SSD_ILI         0x20
3031 #define SSD_EOM         0x40
3032 #define SSD_FILEMARK    0x80
3033         u_int8_t info[4];
3034         u_int8_t extra_len;
3035         u_int8_t cmd_spec_info[4];
3036         u_int8_t add_sense_code;
3037         u_int8_t add_sense_code_qual;
3038         u_int8_t fru;
3039         u_int8_t sense_key_spec[3];
3040 #define SSD_SCS_VALID           0x80
3041 #define SSD_FIELDPTR_CMD        0x40
3042 #define SSD_BITPTR_VALID        0x08
3043 #define SSD_BITPTR_VALUE        0x07
3044         u_int8_t extra_bytes[14];
3045 #define SSD_FIXED_IS_PRESENT(sense, length, field)                      \
3046         ((length >= (offsetof(struct scsi_sense_data_fixed, field) +    \
3047         sizeof(sense->field))) ? 1 :0)
3048 #define SSD_FIXED_IS_FILLED(sense, field)                               \
3049         ((((offsetof(struct scsi_sense_data_fixed, field) +             \
3050         sizeof(sense->field)) -                                         \
3051         (offsetof(struct scsi_sense_data_fixed, extra_len) +            \
3052         sizeof(sense->extra_len))) <= sense->extra_len) ? 1 : 0)
3053 };
3054
3055 /*
3056  * Descriptor format sense data definitions.
3057  * Introduced in SPC-3.
3058  */
3059 struct scsi_sense_data_desc
3060 {
3061         uint8_t error_code;
3062 #define SSD_DESC_CURRENT_ERROR  0x72
3063 #define SSD_DESC_DEFERRED_ERROR 0x73
3064         uint8_t sense_key;
3065         uint8_t add_sense_code;
3066         uint8_t add_sense_code_qual;
3067         uint8_t reserved[3];
3068         /*
3069          * Note that SPC-4, section 4.5.2.1 says that the extra_len field
3070          * must be less than or equal to 244.
3071          */
3072         uint8_t extra_len;
3073         uint8_t sense_desc[0];
3074 #define SSD_DESC_IS_PRESENT(sense, length, field)                       \
3075         ((length >= (offsetof(struct scsi_sense_data_desc, field) +     \
3076         sizeof(sense->field))) ? 1 :0)
3077 };
3078
3079 struct scsi_sense_desc_header
3080 {
3081         uint8_t desc_type;
3082         uint8_t length;
3083 };
3084 /*
3085  * The information provide in the Information descriptor is device type or
3086  * command specific information, and defined in a command standard.
3087  *
3088  * Note that any changes to the field names or positions in this structure,
3089  * even reserved fields, should be accompanied by an examination of the
3090  * code in ctl_set_sense() that uses them.
3091  *
3092  * Maximum descriptors allowed: 1 (as of SPC-4)
3093  */
3094 struct scsi_sense_info
3095 {
3096         uint8_t desc_type;
3097 #define SSD_DESC_INFO   0x00
3098         uint8_t length;
3099         uint8_t byte2;
3100 #define SSD_INFO_VALID  0x80
3101         uint8_t reserved;
3102         uint8_t info[8];
3103 };
3104
3105 /*
3106  * Command-specific information depends on the command for which the
3107  * reported condition occured.
3108  *
3109  * Note that any changes to the field names or positions in this structure,
3110  * even reserved fields, should be accompanied by an examination of the
3111  * code in ctl_set_sense() that uses them.
3112  *
3113  * Maximum descriptors allowed: 1 (as of SPC-4)
3114  */
3115 struct scsi_sense_command
3116 {
3117         uint8_t desc_type;
3118 #define SSD_DESC_COMMAND        0x01
3119         uint8_t length;
3120         uint8_t reserved[2];
3121         uint8_t command_info[8];
3122 };
3123
3124 /*
3125  * Sense key specific descriptor.  The sense key specific data format
3126  * depends on the sense key in question.
3127  *
3128  * Maximum descriptors allowed: 1 (as of SPC-4)
3129  */
3130 struct scsi_sense_sks
3131 {
3132         uint8_t desc_type;
3133 #define SSD_DESC_SKS            0x02
3134         uint8_t length;
3135         uint8_t reserved1[2];
3136         uint8_t sense_key_spec[3];
3137 #define SSD_SKS_VALID           0x80
3138         uint8_t reserved2;
3139 };
3140
3141 /*
3142  * This is used for the Illegal Request sense key (0x05) only.
3143  */
3144 struct scsi_sense_sks_field
3145 {
3146         uint8_t byte0;
3147 #define SSD_SKS_FIELD_VALID     0x80
3148 #define SSD_SKS_FIELD_CMD       0x40
3149 #define SSD_SKS_BPV             0x08
3150 #define SSD_SKS_BIT_VALUE       0x07
3151         uint8_t field[2];
3152 };
3153
3154
3155 /*
3156  * This is used for the Hardware Error (0x04), Medium Error (0x03) and
3157  * Recovered Error (0x01) sense keys.
3158  */
3159 struct scsi_sense_sks_retry
3160 {
3161         uint8_t byte0;
3162 #define SSD_SKS_RETRY_VALID     0x80
3163         uint8_t actual_retry_count[2];
3164 };
3165
3166 /*
3167  * Used with the NO Sense (0x00) or Not Ready (0x02) sense keys.
3168  */
3169 struct scsi_sense_sks_progress
3170 {
3171         uint8_t byte0;
3172 #define SSD_SKS_PROGRESS_VALID  0x80
3173         uint8_t progress[2];
3174 #define SSD_SKS_PROGRESS_DENOM  0x10000
3175 };
3176
3177 /*
3178  * Used with the Copy Aborted (0x0a) sense key.
3179  */
3180 struct scsi_sense_sks_segment
3181 {
3182         uint8_t byte0;
3183 #define SSD_SKS_SEGMENT_VALID   0x80
3184 #define SSD_SKS_SEGMENT_SD      0x20
3185 #define SSD_SKS_SEGMENT_BPV     0x08
3186 #define SSD_SKS_SEGMENT_BITPTR  0x07
3187         uint8_t field[2];
3188 };
3189
3190 /*
3191  * Used with the Unit Attention (0x06) sense key.
3192  *
3193  * This is currently used to indicate that the unit attention condition
3194  * queue has overflowed (when the overflow bit is set).
3195  */
3196 struct scsi_sense_sks_overflow
3197 {
3198         uint8_t byte0;
3199 #define SSD_SKS_OVERFLOW_VALID  0x80
3200 #define SSD_SKS_OVERFLOW_SET    0x01
3201         uint8_t reserved[2];
3202 };
3203
3204 /*
3205  * This specifies which component is associated with the sense data.  There
3206  * is no standard meaning for the fru value.
3207  *
3208  * Maximum descriptors allowed: 1 (as of SPC-4)
3209  */
3210 struct scsi_sense_fru
3211 {
3212         uint8_t desc_type;
3213 #define SSD_DESC_FRU            0x03
3214         uint8_t length;
3215         uint8_t reserved;
3216         uint8_t fru;
3217 };
3218
3219 /*
3220  * Used for Stream commands, defined in SSC-4.
3221  *
3222  * Maximum descriptors allowed: 1 (as of SPC-4)
3223  */
3224
3225 struct scsi_sense_stream
3226 {
3227         uint8_t desc_type;
3228 #define SSD_DESC_STREAM         0x04
3229         uint8_t length;
3230         uint8_t reserved;
3231         uint8_t byte3;
3232 #define SSD_DESC_STREAM_FM      0x80
3233 #define SSD_DESC_STREAM_EOM     0x40
3234 #define SSD_DESC_STREAM_ILI     0x20
3235 };
3236
3237 /*
3238  * Used for Block commands, defined in SBC-3.
3239  *
3240  * This is currently (as of SBC-3) only used for the Incorrect Length
3241  * Indication (ILI) bit, which says that the data length requested in the
3242  * READ LONG or WRITE LONG command did not match the length of the logical
3243  * block.
3244  *
3245  * Maximum descriptors allowed: 1 (as of SPC-4)
3246  */
3247 struct scsi_sense_block
3248 {
3249         uint8_t desc_type;
3250 #define SSD_DESC_BLOCK          0x05
3251         uint8_t length;
3252         uint8_t reserved;
3253         uint8_t byte3;
3254 #define SSD_DESC_BLOCK_ILI      0x20
3255 };
3256
3257 /*
3258  * Used for Object-Based Storage Devices (OSD-3).
3259  *
3260  * Maximum descriptors allowed: 1 (as of SPC-4)
3261  */
3262 struct scsi_sense_osd_objid
3263 {
3264         uint8_t desc_type;
3265 #define SSD_DESC_OSD_OBJID      0x06
3266         uint8_t length;
3267         uint8_t reserved[6];
3268         /*
3269          * XXX KDM provide the bit definitions here?  There are a lot of
3270          * them, and we don't have an OSD driver yet.
3271          */
3272         uint8_t not_init_cmds[4];
3273         uint8_t completed_cmds[4];
3274         uint8_t partition_id[8];
3275         uint8_t object_id[8];
3276 };
3277
3278 /*
3279  * Used for Object-Based Storage Devices (OSD-3).
3280  *
3281  * Maximum descriptors allowed: 1 (as of SPC-4)
3282  */
3283 struct scsi_sense_osd_integrity
3284 {
3285         uint8_t desc_type;
3286 #define SSD_DESC_OSD_INTEGRITY  0x07
3287         uint8_t length;
3288         uint8_t integ_check_val[32];
3289 };
3290
3291 /*
3292  * Used for Object-Based Storage Devices (OSD-3).
3293  *
3294  * Maximum descriptors allowed: 1 (as of SPC-4)
3295  */
3296 struct scsi_sense_osd_attr_id
3297 {
3298         uint8_t desc_type;
3299 #define SSD_DESC_OSD_ATTR_ID    0x08
3300         uint8_t length;
3301         uint8_t reserved[2];
3302         uint8_t attr_desc[0];
3303 };
3304
3305 /*
3306  * Used with Sense keys No Sense (0x00) and Not Ready (0x02).
3307  *
3308  * Maximum descriptors allowed: 32 (as of SPC-4)
3309  */
3310 struct scsi_sense_progress
3311 {
3312         uint8_t desc_type;
3313 #define SSD_DESC_PROGRESS       0x0a
3314         uint8_t length;
3315         uint8_t sense_key;
3316         uint8_t add_sense_code;
3317         uint8_t add_sense_code_qual;
3318         uint8_t reserved;
3319         uint8_t progress[2];
3320 };
3321
3322 /*
3323  * This is typically forwarded as the result of an EXTENDED COPY command.
3324  *
3325  * Maximum descriptors allowed: 2 (as of SPC-4)
3326  */
3327 struct scsi_sense_forwarded
3328 {
3329         uint8_t desc_type;
3330 #define SSD_DESC_FORWARDED      0x0c
3331         uint8_t length;
3332         uint8_t byte2;
3333 #define SSD_FORWARDED_FSDT      0x80
3334 #define SSD_FORWARDED_SDS_MASK  0x0f
3335 #define SSD_FORWARDED_SDS_UNK   0x00
3336 #define SSD_FORWARDED_SDS_EXSRC 0x01
3337 #define SSD_FORWARDED_SDS_EXDST 0x02
3338 };
3339
3340 /*
3341  * Vendor-specific sense descriptor.  The desc_type field will be in the
3342  * range bewteen MIN and MAX inclusive.
3343  */
3344 struct scsi_sense_vendor
3345 {
3346         uint8_t desc_type;
3347 #define SSD_DESC_VENDOR_MIN     0x80
3348 #define SSD_DESC_VENDOR_MAX     0xff
3349         uint8_t length;
3350         uint8_t data[0];
3351 };
3352
3353 struct scsi_mode_header_6
3354 {
3355         u_int8_t data_length;   /* Sense data length */
3356         u_int8_t medium_type;
3357         u_int8_t dev_spec;
3358         u_int8_t blk_desc_len;
3359 };
3360
3361 struct scsi_mode_header_10
3362 {
3363         u_int8_t data_length[2];/* Sense data length */
3364         u_int8_t medium_type;
3365         u_int8_t dev_spec;
3366         u_int8_t unused[2];
3367         u_int8_t blk_desc_len[2];
3368 };
3369
3370 struct scsi_mode_page_header
3371 {
3372         u_int8_t page_code;
3373 #define SMPH_PS         0x80
3374 #define SMPH_SPF        0x40
3375 #define SMPH_PC_MASK    0x3f
3376         u_int8_t page_length;
3377 };
3378
3379 struct scsi_mode_page_header_sp
3380 {
3381         uint8_t page_code;
3382         uint8_t subpage;
3383         uint8_t page_length[2];
3384 };
3385
3386
3387 struct scsi_mode_blk_desc
3388 {
3389         u_int8_t density;
3390         u_int8_t nblocks[3];
3391         u_int8_t reserved;
3392         u_int8_t blklen[3];
3393 };
3394
3395 #define SCSI_DEFAULT_DENSITY    0x00    /* use 'default' density */
3396 #define SCSI_SAME_DENSITY       0x7f    /* use 'same' density- >= SCSI-2 only */
3397
3398
3399 /*
3400  * Status Byte
3401  */
3402 #define SCSI_STATUS_OK                  0x00
3403 #define SCSI_STATUS_CHECK_COND          0x02
3404 #define SCSI_STATUS_COND_MET            0x04
3405 #define SCSI_STATUS_BUSY                0x08
3406 #define SCSI_STATUS_INTERMED            0x10
3407 #define SCSI_STATUS_INTERMED_COND_MET   0x14
3408 #define SCSI_STATUS_RESERV_CONFLICT     0x18
3409 #define SCSI_STATUS_CMD_TERMINATED      0x22    /* Obsolete in SAM-2 */
3410 #define SCSI_STATUS_QUEUE_FULL          0x28
3411 #define SCSI_STATUS_ACA_ACTIVE          0x30
3412 #define SCSI_STATUS_TASK_ABORTED        0x40
3413
3414 struct scsi_inquiry_pattern {
3415         u_int8_t   type;
3416         u_int8_t   media_type;
3417 #define SIP_MEDIA_REMOVABLE     0x01
3418 #define SIP_MEDIA_FIXED         0x02
3419         const char *vendor;
3420         const char *product;
3421         const char *revision;
3422 };
3423
3424 struct scsi_static_inquiry_pattern {
3425         u_int8_t   type;
3426         u_int8_t   media_type;
3427         char       vendor[SID_VENDOR_SIZE+1];
3428         char       product[SID_PRODUCT_SIZE+1];
3429         char       revision[SID_REVISION_SIZE+1];
3430 };
3431
3432 struct scsi_sense_quirk_entry {
3433         struct scsi_inquiry_pattern     inq_pat;
3434         int                             num_sense_keys;
3435         int                             num_ascs;
3436         struct sense_key_table_entry    *sense_key_info;
3437         struct asc_table_entry          *asc_info;
3438 };
3439
3440 struct sense_key_table_entry {
3441         u_int8_t    sense_key;
3442         u_int32_t   action;
3443         const char *desc;
3444 };
3445
3446 struct asc_table_entry {
3447         u_int8_t    asc;
3448         u_int8_t    ascq;
3449         u_int32_t   action;
3450         const char *desc;
3451 };
3452
3453 struct op_table_entry {
3454         u_int8_t    opcode;
3455         u_int32_t   opmask;
3456         const char  *desc;
3457 };
3458
3459 struct scsi_op_quirk_entry {
3460         struct scsi_inquiry_pattern     inq_pat;
3461         int                             num_ops;
3462         struct op_table_entry           *op_table;
3463 };
3464
3465 typedef enum {
3466         SSS_FLAG_NONE           = 0x00,
3467         SSS_FLAG_PRINT_COMMAND  = 0x01
3468 } scsi_sense_string_flags;
3469
3470 struct scsi_nv {
3471         const char *name;
3472         uint64_t value;
3473 };
3474
3475 typedef enum {
3476         SCSI_NV_FOUND,
3477         SCSI_NV_AMBIGUOUS,
3478         SCSI_NV_NOT_FOUND
3479 } scsi_nv_status;
3480
3481 typedef enum {
3482         SCSI_NV_FLAG_NONE       = 0x00,
3483         SCSI_NV_FLAG_IG_CASE    = 0x01  /* Case insensitive comparison */
3484 } scsi_nv_flags;
3485
3486 struct ccb_scsiio;
3487 struct cam_periph;
3488 union  ccb;
3489 #ifndef _KERNEL
3490 struct cam_device;
3491 #endif
3492
3493 extern const char *scsi_sense_key_text[];
3494
3495 __BEGIN_DECLS
3496 void scsi_sense_desc(int sense_key, int asc, int ascq,
3497                      struct scsi_inquiry_data *inq_data,
3498                      const char **sense_key_desc, const char **asc_desc);
3499 scsi_sense_action scsi_error_action(struct ccb_scsiio* csio,
3500                                     struct scsi_inquiry_data *inq_data,
3501                                     u_int32_t sense_flags);
3502 const char *    scsi_status_string(struct ccb_scsiio *csio);
3503
3504 void scsi_desc_iterate(struct scsi_sense_data_desc *sense, u_int sense_len,
3505                        int (*iter_func)(struct scsi_sense_data_desc *sense,
3506                                         u_int, struct scsi_sense_desc_header *,
3507                                         void *), void *arg);
3508 uint8_t *scsi_find_desc(struct scsi_sense_data_desc *sense, u_int sense_len,
3509                         uint8_t desc_type);
3510 void scsi_set_sense_data(struct scsi_sense_data *sense_data,
3511                          scsi_sense_data_type sense_format, int current_error,
3512                          int sense_key, int asc, int ascq, ...) ;
3513 void scsi_set_sense_data_va(struct scsi_sense_data *sense_data,
3514                             scsi_sense_data_type sense_format,
3515                             int current_error, int sense_key, int asc,
3516                             int ascq, va_list ap);
3517 int scsi_get_sense_info(struct scsi_sense_data *sense_data, u_int sense_len,
3518                         uint8_t info_type, uint64_t *info,
3519                         int64_t *signed_info);
3520 int scsi_get_sks(struct scsi_sense_data *sense_data, u_int sense_len,
3521                  uint8_t *sks);
3522 int scsi_get_block_info(struct scsi_sense_data *sense_data, u_int sense_len,
3523                         struct scsi_inquiry_data *inq_data,
3524                         uint8_t *block_bits);
3525 int scsi_get_stream_info(struct scsi_sense_data *sense_data, u_int sense_len,
3526                          struct scsi_inquiry_data *inq_data,
3527                          uint8_t *stream_bits);
3528 void scsi_info_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len,
3529                     struct scsi_inquiry_data *inq_data, uint64_t info);
3530 void scsi_command_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len,
3531                        struct scsi_inquiry_data *inq_data, uint64_t csi);
3532 void scsi_progress_sbuf(struct sbuf *sb, uint16_t progress);
3533 int scsi_sks_sbuf(struct sbuf *sb, int sense_key, uint8_t *sks);
3534 void scsi_fru_sbuf(struct sbuf *sb, uint64_t fru);
3535 void scsi_stream_sbuf(struct sbuf *sb, uint8_t stream_bits, uint64_t info);
3536 void scsi_block_sbuf(struct sbuf *sb, uint8_t block_bits, uint64_t info);
3537 void scsi_sense_info_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3538                           u_int sense_len, uint8_t *cdb, int cdb_len,
3539                           struct scsi_inquiry_data *inq_data,
3540                           struct scsi_sense_desc_header *header);
3541
3542 void scsi_sense_command_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3543                              u_int sense_len, uint8_t *cdb, int cdb_len,
3544                              struct scsi_inquiry_data *inq_data,
3545                              struct scsi_sense_desc_header *header);
3546 void scsi_sense_sks_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3547                          u_int sense_len, uint8_t *cdb, int cdb_len,
3548                          struct scsi_inquiry_data *inq_data,
3549                          struct scsi_sense_desc_header *header);
3550 void scsi_sense_fru_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3551                          u_int sense_len, uint8_t *cdb, int cdb_len,
3552                          struct scsi_inquiry_data *inq_data,
3553                          struct scsi_sense_desc_header *header);
3554 void scsi_sense_stream_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3555                             u_int sense_len, uint8_t *cdb, int cdb_len,
3556                             struct scsi_inquiry_data *inq_data,
3557                             struct scsi_sense_desc_header *header);
3558 void scsi_sense_block_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3559                            u_int sense_len, uint8_t *cdb, int cdb_len,
3560                            struct scsi_inquiry_data *inq_data,
3561                            struct scsi_sense_desc_header *header);
3562 void scsi_sense_progress_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3563                               u_int sense_len, uint8_t *cdb, int cdb_len,
3564                               struct scsi_inquiry_data *inq_data,
3565                               struct scsi_sense_desc_header *header);
3566 void scsi_sense_generic_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3567                              u_int sense_len, uint8_t *cdb, int cdb_len,
3568                              struct scsi_inquiry_data *inq_data,
3569                              struct scsi_sense_desc_header *header);
3570 void scsi_sense_desc_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3571                           u_int sense_len, uint8_t *cdb, int cdb_len,
3572                           struct scsi_inquiry_data *inq_data,
3573                           struct scsi_sense_desc_header *header);
3574 scsi_sense_data_type scsi_sense_type(struct scsi_sense_data *sense_data);
3575
3576 void scsi_sense_only_sbuf(struct scsi_sense_data *sense, u_int sense_len,
3577                           struct sbuf *sb, char *path_str,
3578                           struct scsi_inquiry_data *inq_data, uint8_t *cdb,
3579                           int cdb_len);
3580
3581 #ifdef _KERNEL
3582 int             scsi_command_string(struct ccb_scsiio *csio, struct sbuf *sb);
3583 int             scsi_sense_sbuf(struct ccb_scsiio *csio, struct sbuf *sb,
3584                                 scsi_sense_string_flags flags);
3585 char *          scsi_sense_string(struct ccb_scsiio *csio,
3586                                   char *str, int str_len);
3587 void            scsi_sense_print(struct ccb_scsiio *csio);
3588 int             scsi_vpd_supported_page(struct cam_periph *periph,
3589                                         uint8_t page_id);
3590 #else /* _KERNEL */
3591 int             scsi_command_string(struct cam_device *device,
3592                                     struct ccb_scsiio *csio, struct sbuf *sb);
3593 int             scsi_sense_sbuf(struct cam_device *device,
3594                                 struct ccb_scsiio *csio, struct sbuf *sb,
3595                                 scsi_sense_string_flags flags);
3596 char *          scsi_sense_string(struct cam_device *device,
3597                                   struct ccb_scsiio *csio,
3598                                   char *str, int str_len);
3599 void            scsi_sense_print(struct cam_device *device,
3600                                  struct ccb_scsiio *csio, FILE *ofile);
3601 #endif /* _KERNEL */
3602
3603 const char *    scsi_op_desc(u_int16_t opcode,
3604                              struct scsi_inquiry_data *inq_data);
3605 char *          scsi_cdb_string(u_int8_t *cdb_ptr, char *cdb_string,
3606                                 size_t len);
3607
3608 void            scsi_print_inquiry(struct scsi_inquiry_data *inq_data);
3609 void            scsi_print_inquiry_short(struct scsi_inquiry_data *inq_data);
3610
3611 u_int           scsi_calc_syncsrate(u_int period_factor);
3612 u_int           scsi_calc_syncparam(u_int period);
3613
3614 typedef int     (*scsi_devid_checkfn_t)(uint8_t *);
3615 int             scsi_devid_is_naa_ieee_reg(uint8_t *bufp);
3616 int             scsi_devid_is_sas_target(uint8_t *bufp);
3617 int             scsi_devid_is_lun_eui64(uint8_t *bufp);
3618 int             scsi_devid_is_lun_naa(uint8_t *bufp);
3619 int             scsi_devid_is_lun_name(uint8_t *bufp);
3620 int             scsi_devid_is_lun_t10(uint8_t *bufp);
3621 struct scsi_vpd_id_descriptor *
3622                 scsi_get_devid(struct scsi_vpd_device_id *id, uint32_t len,
3623                                scsi_devid_checkfn_t ck_fn);
3624 struct scsi_vpd_id_descriptor *
3625                 scsi_get_devid_desc(struct scsi_vpd_id_descriptor *desc, uint32_t len,
3626                                scsi_devid_checkfn_t ck_fn);
3627
3628 int             scsi_transportid_sbuf(struct sbuf *sb,
3629                                       struct scsi_transportid_header *hdr,
3630                                       uint32_t valid_len);
3631
3632 const char *    scsi_nv_to_str(struct scsi_nv *table, int num_table_entries,
3633                                uint64_t value);
3634
3635 scsi_nv_status  scsi_get_nv(struct scsi_nv *table, int num_table_entries,
3636                             char *name, int *table_entry, scsi_nv_flags flags);
3637
3638 int     scsi_parse_transportid_64bit(int proto_id, char *id_str,
3639                                      struct scsi_transportid_header **hdr,
3640                                      unsigned int *alloc_len,
3641 #ifdef _KERNEL
3642                                      struct malloc_type *type, int flags,
3643 #endif
3644                                      char *error_str, int error_str_len);
3645
3646 int     scsi_parse_transportid_spi(char *id_str,
3647                                    struct scsi_transportid_header **hdr,
3648                                    unsigned int *alloc_len,
3649 #ifdef _KERNEL
3650                                    struct malloc_type *type, int flags,
3651 #endif
3652                                    char *error_str, int error_str_len);
3653
3654 int     scsi_parse_transportid_rdma(char *id_str,
3655                                     struct scsi_transportid_header **hdr,
3656                                     unsigned int *alloc_len,
3657 #ifdef _KERNEL
3658                                     struct malloc_type *type, int flags,
3659 #endif
3660                                     char *error_str, int error_str_len);
3661
3662 int     scsi_parse_transportid_iscsi(char *id_str,
3663                                      struct scsi_transportid_header **hdr,
3664                                      unsigned int *alloc_len,
3665 #ifdef _KERNEL
3666                                      struct malloc_type *type, int flags,
3667 #endif
3668                                      char *error_str,int error_str_len);
3669
3670 int     scsi_parse_transportid_sop(char *id_str,
3671                                    struct scsi_transportid_header **hdr,
3672                                    unsigned int *alloc_len,
3673 #ifdef _KERNEL
3674                                    struct malloc_type *type, int flags,
3675 #endif
3676                                    char *error_str,int error_str_len);
3677
3678 int     scsi_parse_transportid(char *transportid_str,
3679                                struct scsi_transportid_header **hdr,
3680                                unsigned int *alloc_len,
3681 #ifdef _KERNEL
3682                                struct malloc_type *type, int flags,
3683 #endif
3684                                char *error_str, int error_str_len);
3685
3686
3687 int scsi_attrib_volcoh_sbuf(struct sbuf *sb,
3688                             struct scsi_mam_attribute_header *hdr,
3689                             uint32_t valid_len, uint32_t flags,
3690                             uint32_t output_flags, char *error_str,
3691                             int error_str_len);
3692
3693 int scsi_attrib_vendser_sbuf(struct sbuf *sb,
3694                              struct scsi_mam_attribute_header *hdr,
3695                              uint32_t valid_len, uint32_t flags,
3696                              uint32_t output_flags, char *error_str,
3697                              int error_str_len);
3698
3699 int scsi_attrib_hexdump_sbuf(struct sbuf *sb,
3700                              struct scsi_mam_attribute_header *hdr,
3701                              uint32_t valid_len, uint32_t flags,
3702                              uint32_t output_flags, char *error_str,
3703                              int error_str_len);
3704
3705 int scsi_attrib_int_sbuf(struct sbuf *sb, struct scsi_mam_attribute_header *hdr,
3706                          uint32_t valid_len, uint32_t flags,
3707                          uint32_t output_flags, char *error_str,
3708                          int error_str_len);
3709
3710 int scsi_attrib_ascii_sbuf(struct sbuf *sb,
3711                            struct scsi_mam_attribute_header *hdr,
3712                            uint32_t valid_len, uint32_t flags,
3713                            uint32_t output_flags, char *error_str,
3714                            int error_str_len);
3715
3716 int scsi_attrib_text_sbuf(struct sbuf *sb,
3717                           struct scsi_mam_attribute_header *hdr,
3718                           uint32_t valid_len, uint32_t flags,
3719                           uint32_t output_flags, char *error_str,
3720                           int error_str_len);
3721
3722 struct scsi_attrib_table_entry *scsi_find_attrib_entry(
3723                         struct scsi_attrib_table_entry *table,
3724                         size_t num_table_entries, uint32_t id);
3725
3726 struct scsi_attrib_table_entry *scsi_get_attrib_entry(uint32_t id);
3727
3728 int scsi_attrib_value_sbuf(struct sbuf *sb, uint32_t valid_len,
3729                            struct scsi_mam_attribute_header *hdr,
3730                            uint32_t output_flags, char *error_str,
3731                            size_t error_str_len);
3732
3733 void scsi_attrib_prefix_sbuf(struct sbuf *sb, uint32_t output_flags,
3734                              struct scsi_mam_attribute_header *hdr,
3735                              uint32_t valid_len, const char *desc);
3736
3737 int scsi_attrib_sbuf(struct sbuf *sb, struct scsi_mam_attribute_header *hdr,
3738                      uint32_t valid_len,
3739                      struct scsi_attrib_table_entry *user_table,
3740                      size_t num_user_entries, int prefer_user_table,
3741                      uint32_t output_flags, char *error_str, int error_str_len);
3742
3743 void            scsi_test_unit_ready(struct ccb_scsiio *csio, u_int32_t retries,
3744                                      void (*cbfcnp)(struct cam_periph *,
3745                                                     union ccb *),
3746                                      u_int8_t tag_action,
3747                                      u_int8_t sense_len, u_int32_t timeout);
3748
3749 void            scsi_request_sense(struct ccb_scsiio *csio, u_int32_t retries,
3750                                    void (*cbfcnp)(struct cam_periph *,
3751                                                   union ccb *),
3752                                    void *data_ptr, u_int8_t dxfer_len,
3753                                    u_int8_t tag_action, u_int8_t sense_len,
3754                                    u_int32_t timeout);
3755
3756 void            scsi_inquiry(struct ccb_scsiio *csio, u_int32_t retries,
3757                              void (*cbfcnp)(struct cam_periph *, union ccb *),
3758                              u_int8_t tag_action, u_int8_t *inq_buf,
3759                              u_int32_t inq_len, int evpd, u_int8_t page_code,
3760                              u_int8_t sense_len, u_int32_t timeout);
3761
3762 void            scsi_mode_sense(struct ccb_scsiio *csio, u_int32_t retries,
3763                                 void (*cbfcnp)(struct cam_periph *,
3764                                                union ccb *),
3765                                 u_int8_t tag_action, int dbd,
3766                                 u_int8_t page_code, u_int8_t page,
3767                                 u_int8_t *param_buf, u_int32_t param_len,
3768                                 u_int8_t sense_len, u_int32_t timeout);
3769
3770 void            scsi_mode_sense_len(struct ccb_scsiio *csio, u_int32_t retries,
3771                                     void (*cbfcnp)(struct cam_periph *,
3772                                                    union ccb *),
3773                                     u_int8_t tag_action, int dbd,
3774                                     u_int8_t page_code, u_int8_t page,
3775                                     u_int8_t *param_buf, u_int32_t param_len,
3776                                     int minimum_cmd_size, u_int8_t sense_len,
3777                                     u_int32_t timeout);
3778
3779 void            scsi_mode_select(struct ccb_scsiio *csio, u_int32_t retries,
3780                                  void (*cbfcnp)(struct cam_periph *,
3781                                                 union ccb *),
3782                                  u_int8_t tag_action, int scsi_page_fmt,
3783                                  int save_pages, u_int8_t *param_buf,
3784                                  u_int32_t param_len, u_int8_t sense_len,
3785                                  u_int32_t timeout);
3786
3787 void            scsi_mode_select_len(struct ccb_scsiio *csio, u_int32_t retries,
3788                                      void (*cbfcnp)(struct cam_periph *,
3789                                                     union ccb *),
3790                                      u_int8_t tag_action, int scsi_page_fmt,
3791                                      int save_pages, u_int8_t *param_buf,
3792                                      u_int32_t param_len, int minimum_cmd_size,
3793                                      u_int8_t sense_len, u_int32_t timeout);
3794
3795 void            scsi_log_sense(struct ccb_scsiio *csio, u_int32_t retries,
3796                                void (*cbfcnp)(struct cam_periph *, union ccb *),
3797                                u_int8_t tag_action, u_int8_t page_code,
3798                                u_int8_t page, int save_pages, int ppc,
3799                                u_int32_t paramptr, u_int8_t *param_buf,
3800                                u_int32_t param_len, u_int8_t sense_len,
3801                                u_int32_t timeout);
3802
3803 void            scsi_log_select(struct ccb_scsiio *csio, u_int32_t retries,
3804                                 void (*cbfcnp)(struct cam_periph *,
3805                                 union ccb *), u_int8_t tag_action,
3806                                 u_int8_t page_code, int save_pages,
3807                                 int pc_reset, u_int8_t *param_buf,
3808                                 u_int32_t param_len, u_int8_t sense_len,
3809                                 u_int32_t timeout);
3810
3811 void            scsi_prevent(struct ccb_scsiio *csio, u_int32_t retries,
3812                              void (*cbfcnp)(struct cam_periph *, union ccb *),
3813                              u_int8_t tag_action, u_int8_t action,
3814                              u_int8_t sense_len, u_int32_t timeout);
3815
3816 void            scsi_read_capacity(struct ccb_scsiio *csio, u_int32_t retries,
3817                                    void (*cbfcnp)(struct cam_periph *,
3818                                    union ccb *), u_int8_t tag_action,
3819                                    struct scsi_read_capacity_data *,
3820                                    u_int8_t sense_len, u_int32_t timeout);
3821 void            scsi_read_capacity_16(struct ccb_scsiio *csio, uint32_t retries,
3822                                       void (*cbfcnp)(struct cam_periph *,
3823                                       union ccb *), uint8_t tag_action,
3824                                       uint64_t lba, int reladr, int pmi,
3825                                       uint8_t *rcap_buf, int rcap_buf_len,
3826                                       uint8_t sense_len, uint32_t timeout);
3827
3828 void            scsi_report_luns(struct ccb_scsiio *csio, u_int32_t retries,
3829                                  void (*cbfcnp)(struct cam_periph *,
3830                                  union ccb *), u_int8_t tag_action,
3831                                  u_int8_t select_report,
3832                                  struct scsi_report_luns_data *rpl_buf,
3833                                  u_int32_t alloc_len, u_int8_t sense_len,
3834                                  u_int32_t timeout);
3835
3836 void            scsi_report_target_group(struct ccb_scsiio *csio, u_int32_t retries,
3837                                  void (*cbfcnp)(struct cam_periph *,
3838                                  union ccb *), u_int8_t tag_action,
3839                                  u_int8_t pdf,
3840                                  void *buf,
3841                                  u_int32_t alloc_len, u_int8_t sense_len,
3842                                  u_int32_t timeout);
3843
3844 void            scsi_set_target_group(struct ccb_scsiio *csio, u_int32_t retries,
3845                                  void (*cbfcnp)(struct cam_periph *,
3846                                  union ccb *), u_int8_t tag_action, void *buf,
3847                                  u_int32_t alloc_len, u_int8_t sense_len,
3848                                  u_int32_t timeout);
3849
3850 void            scsi_synchronize_cache(struct ccb_scsiio *csio,
3851                                        u_int32_t retries,
3852                                        void (*cbfcnp)(struct cam_periph *,
3853                                        union ccb *), u_int8_t tag_action,
3854                                        u_int32_t begin_lba, u_int16_t lb_count,
3855                                        u_int8_t sense_len, u_int32_t timeout);
3856
3857 void scsi_receive_diagnostic_results(struct ccb_scsiio *csio, u_int32_t retries,
3858                                      void (*cbfcnp)(struct cam_periph *,
3859                                                     union ccb*),
3860                                      uint8_t tag_action, int pcv,
3861                                      uint8_t page_code, uint8_t *data_ptr,
3862                                      uint16_t allocation_length,
3863                                      uint8_t sense_len, uint32_t timeout);
3864
3865 void scsi_send_diagnostic(struct ccb_scsiio *csio, u_int32_t retries,
3866                           void (*cbfcnp)(struct cam_periph *, union ccb *),
3867                           uint8_t tag_action, int unit_offline,
3868                           int device_offline, int self_test, int page_format,
3869                           int self_test_code, uint8_t *data_ptr,
3870                           uint16_t param_list_length, uint8_t sense_len,
3871                           uint32_t timeout);
3872
3873 void scsi_read_buffer(struct ccb_scsiio *csio, u_int32_t retries,
3874                         void (*cbfcnp)(struct cam_periph *, union ccb*),
3875                         uint8_t tag_action, int mode,
3876                         uint8_t buffer_id, u_int32_t offset,
3877                         uint8_t *data_ptr, uint32_t allocation_length,
3878                         uint8_t sense_len, uint32_t timeout);
3879
3880 void scsi_write_buffer(struct ccb_scsiio *csio, u_int32_t retries,
3881                         void (*cbfcnp)(struct cam_periph *, union ccb *),
3882                         uint8_t tag_action, int mode,
3883                         uint8_t buffer_id, u_int32_t offset,
3884                         uint8_t *data_ptr, uint32_t param_list_length,
3885                         uint8_t sense_len, uint32_t timeout);
3886
3887 #define SCSI_RW_READ    0x0001
3888 #define SCSI_RW_WRITE   0x0002
3889 #define SCSI_RW_DIRMASK 0x0003
3890 #define SCSI_RW_BIO     0x1000
3891 void scsi_read_write(struct ccb_scsiio *csio, u_int32_t retries,
3892                      void (*cbfcnp)(struct cam_periph *, union ccb *),
3893                      u_int8_t tag_action, int readop, u_int8_t byte2,
3894                      int minimum_cmd_size, u_int64_t lba,
3895                      u_int32_t block_count, u_int8_t *data_ptr,
3896                      u_int32_t dxfer_len, u_int8_t sense_len,
3897                      u_int32_t timeout);
3898
3899 void scsi_write_same(struct ccb_scsiio *csio, u_int32_t retries,
3900                      void (*cbfcnp)(struct cam_periph *, union ccb *),
3901                      u_int8_t tag_action, u_int8_t byte2,
3902                      int minimum_cmd_size, u_int64_t lba,
3903                      u_int32_t block_count, u_int8_t *data_ptr,
3904                      u_int32_t dxfer_len, u_int8_t sense_len,
3905                      u_int32_t timeout);
3906
3907 void scsi_ata_identify(struct ccb_scsiio *csio, u_int32_t retries,
3908                        void (*cbfcnp)(struct cam_periph *, union ccb *),
3909                        u_int8_t tag_action, u_int8_t *data_ptr,
3910                        u_int16_t dxfer_len, u_int8_t sense_len,
3911                        u_int32_t timeout);
3912
3913 void scsi_ata_trim(struct ccb_scsiio *csio, u_int32_t retries,
3914                    void (*cbfcnp)(struct cam_periph *, union ccb *),
3915                    u_int8_t tag_action, u_int16_t block_count,
3916                    u_int8_t *data_ptr, u_int16_t dxfer_len,
3917                    u_int8_t sense_len, u_int32_t timeout);
3918
3919 void scsi_ata_pass_16(struct ccb_scsiio *csio, u_int32_t retries,
3920                       void (*cbfcnp)(struct cam_periph *, union ccb *),
3921                       u_int32_t flags, u_int8_t tag_action,
3922                       u_int8_t protocol, u_int8_t ata_flags, u_int16_t features,
3923                       u_int16_t sector_count, uint64_t lba, u_int8_t command,
3924                       u_int8_t control, u_int8_t *data_ptr, u_int16_t dxfer_len,
3925                       u_int8_t sense_len, u_int32_t timeout);
3926
3927 void scsi_unmap(struct ccb_scsiio *csio, u_int32_t retries,
3928                 void (*cbfcnp)(struct cam_periph *, union ccb *),
3929                 u_int8_t tag_action, u_int8_t byte2,
3930                 u_int8_t *data_ptr, u_int16_t dxfer_len,
3931                 u_int8_t sense_len, u_int32_t timeout);
3932
3933 void scsi_start_stop(struct ccb_scsiio *csio, u_int32_t retries,
3934                      void (*cbfcnp)(struct cam_periph *, union ccb *),
3935                      u_int8_t tag_action, int start, int load_eject,
3936                      int immediate, u_int8_t sense_len, u_int32_t timeout);
3937 void scsi_read_attribute(struct ccb_scsiio *csio, u_int32_t retries,
3938                          void (*cbfcnp)(struct cam_periph *, union ccb *),
3939                          u_int8_t tag_action, u_int8_t service_action,
3940                          uint32_t element, u_int8_t elem_type,
3941                          int logical_volume, int partition,
3942                          u_int32_t first_attribute, int cache, u_int8_t *data_ptr,
3943                          u_int32_t length, int sense_len, u_int32_t timeout);
3944 void scsi_write_attribute(struct ccb_scsiio *csio, u_int32_t retries,
3945                           void (*cbfcnp)(struct cam_periph *, union ccb *),
3946                           u_int8_t tag_action, uint32_t element,
3947                           int logical_volume, int partition, int wtc, u_int8_t *data_ptr,
3948                           u_int32_t length, int sense_len, u_int32_t timeout);
3949
3950 void scsi_security_protocol_in(struct ccb_scsiio *csio, uint32_t retries,
3951                                void (*cbfcnp)(struct cam_periph *, union ccb *),
3952                                uint8_t tag_action, uint32_t security_protocol,
3953                                uint32_t security_protocol_specific, int byte4,
3954                                uint8_t *data_ptr, uint32_t dxfer_len,
3955                                int sense_len, int timeout);
3956
3957 void scsi_security_protocol_out(struct ccb_scsiio *csio, uint32_t retries,
3958                                 void (*cbfcnp)(struct cam_periph *,union ccb *),
3959                                 uint8_t tag_action, uint32_t security_protocol,
3960                                 uint32_t security_protocol_specific, int byte4,
3961                                 uint8_t *data_ptr, uint32_t dxfer_len,
3962                                 int sense_len, int timeout);
3963
3964 void scsi_persistent_reserve_in(struct ccb_scsiio *csio, uint32_t retries,
3965                                 void (*cbfcnp)(struct cam_periph *,union ccb *),
3966                                 uint8_t tag_action, int service_action,
3967                                 uint8_t *data_ptr, uint32_t dxfer_len,
3968                                 int sense_len, int timeout);
3969
3970 void scsi_persistent_reserve_out(struct ccb_scsiio *csio, uint32_t retries,
3971                                  void (*cbfcnp)(struct cam_periph *,
3972                                        union ccb *),
3973                                  uint8_t tag_action, int service_action,
3974                                  int scope, int res_type, uint8_t *data_ptr,
3975                                  uint32_t dxfer_len, int sense_len,
3976                                  int timeout);
3977
3978 void scsi_report_supported_opcodes(struct ccb_scsiio *csio, uint32_t retries,
3979                                    void (*cbfcnp)(struct cam_periph *,
3980                                                   union ccb *),
3981                                    uint8_t tag_action, int options,
3982                                    int req_opcode, int req_service_action,
3983                                    uint8_t *data_ptr, uint32_t dxfer_len,
3984                                    int sense_len, int timeout);
3985
3986 int             scsi_inquiry_match(caddr_t inqbuffer, caddr_t table_entry);
3987 int             scsi_static_inquiry_match(caddr_t inqbuffer,
3988                                           caddr_t table_entry);
3989 int             scsi_devid_match(uint8_t *rhs, size_t rhs_len,
3990                                  uint8_t *lhs, size_t lhs_len);
3991
3992 void scsi_extract_sense(struct scsi_sense_data *sense, int *error_code,
3993                         int *sense_key, int *asc, int *ascq);
3994 int scsi_extract_sense_ccb(union ccb *ccb, int *error_code, int *sense_key,
3995                            int *asc, int *ascq);
3996 void scsi_extract_sense_len(struct scsi_sense_data *sense,
3997                             u_int sense_len, int *error_code, int *sense_key,
3998                             int *asc, int *ascq, int show_errors);
3999 int scsi_get_sense_key(struct scsi_sense_data *sense, u_int sense_len,
4000                        int show_errors);
4001 int scsi_get_asc(struct scsi_sense_data *sense, u_int sense_len,
4002                  int show_errors);
4003 int scsi_get_ascq(struct scsi_sense_data *sense, u_int sense_len,
4004                   int show_errors);
4005 static __inline void scsi_ulto2b(u_int32_t val, u_int8_t *bytes);
4006 static __inline void scsi_ulto3b(u_int32_t val, u_int8_t *bytes);
4007 static __inline void scsi_ulto4b(u_int32_t val, u_int8_t *bytes);
4008 static __inline void scsi_u64to8b(u_int64_t val, u_int8_t *bytes);
4009 static __inline uint32_t scsi_2btoul(const uint8_t *bytes);
4010 static __inline uint32_t scsi_3btoul(const uint8_t *bytes);
4011 static __inline int32_t scsi_3btol(const uint8_t *bytes);
4012 static __inline uint32_t scsi_4btoul(const uint8_t *bytes);
4013 static __inline uint64_t scsi_8btou64(const uint8_t *bytes);
4014 static __inline void *find_mode_page_6(struct scsi_mode_header_6 *mode_header);
4015 static __inline void *find_mode_page_10(struct scsi_mode_header_10 *mode_header);
4016
4017 static __inline void
4018 scsi_ulto2b(u_int32_t val, u_int8_t *bytes)
4019 {
4020
4021         bytes[0] = (val >> 8) & 0xff;
4022         bytes[1] = val & 0xff;
4023 }
4024
4025 static __inline void
4026 scsi_ulto3b(u_int32_t val, u_int8_t *bytes)
4027 {
4028
4029         bytes[0] = (val >> 16) & 0xff;
4030         bytes[1] = (val >> 8) & 0xff;
4031         bytes[2] = val & 0xff;
4032 }
4033
4034 static __inline void
4035 scsi_ulto4b(u_int32_t val, u_int8_t *bytes)
4036 {
4037
4038         bytes[0] = (val >> 24) & 0xff;
4039         bytes[1] = (val >> 16) & 0xff;
4040         bytes[2] = (val >> 8) & 0xff;
4041         bytes[3] = val & 0xff;
4042 }
4043
4044 static __inline void
4045 scsi_u64to8b(u_int64_t val, u_int8_t *bytes)
4046 {
4047
4048         bytes[0] = (val >> 56) & 0xff;
4049         bytes[1] = (val >> 48) & 0xff;
4050         bytes[2] = (val >> 40) & 0xff;
4051         bytes[3] = (val >> 32) & 0xff;
4052         bytes[4] = (val >> 24) & 0xff;
4053         bytes[5] = (val >> 16) & 0xff;
4054         bytes[6] = (val >> 8) & 0xff;
4055         bytes[7] = val & 0xff;
4056 }
4057
4058 static __inline uint32_t
4059 scsi_2btoul(const uint8_t *bytes)
4060 {
4061         uint32_t rv;
4062
4063         rv = (bytes[0] << 8) |
4064              bytes[1];
4065         return (rv);
4066 }
4067
4068 static __inline uint32_t
4069 scsi_3btoul(const uint8_t *bytes)
4070 {
4071         uint32_t rv;
4072
4073         rv = (bytes[0] << 16) |
4074              (bytes[1] << 8) |
4075              bytes[2];
4076         return (rv);
4077 }
4078
4079 static __inline int32_t
4080 scsi_3btol(const uint8_t *bytes)
4081 {
4082         uint32_t rc = scsi_3btoul(bytes);
4083
4084         if (rc & 0x00800000)
4085                 rc |= 0xff000000;
4086
4087         return (int32_t) rc;
4088 }
4089
4090 static __inline uint32_t
4091 scsi_4btoul(const uint8_t *bytes)
4092 {
4093         uint32_t rv;
4094
4095         rv = (bytes[0] << 24) |
4096              (bytes[1] << 16) |
4097              (bytes[2] << 8) |
4098              bytes[3];
4099         return (rv);
4100 }
4101
4102 static __inline uint64_t
4103 scsi_8btou64(const uint8_t *bytes)
4104 {
4105         uint64_t rv;
4106
4107         rv = (((uint64_t)bytes[0]) << 56) |
4108              (((uint64_t)bytes[1]) << 48) |
4109              (((uint64_t)bytes[2]) << 40) |
4110              (((uint64_t)bytes[3]) << 32) |
4111              (((uint64_t)bytes[4]) << 24) |
4112              (((uint64_t)bytes[5]) << 16) |
4113              (((uint64_t)bytes[6]) << 8) |
4114              bytes[7];
4115         return (rv);
4116 }
4117
4118 /*
4119  * Given the pointer to a returned mode sense buffer, return a pointer to
4120  * the start of the first mode page.
4121  */
4122 static __inline void *
4123 find_mode_page_6(struct scsi_mode_header_6 *mode_header)
4124 {
4125         void *page_start;
4126
4127         page_start = (void *)((u_int8_t *)&mode_header[1] +
4128                               mode_header->blk_desc_len);
4129
4130         return(page_start);
4131 }
4132
4133 static __inline void *
4134 find_mode_page_10(struct scsi_mode_header_10 *mode_header)
4135 {
4136         void *page_start;
4137
4138         page_start = (void *)((u_int8_t *)&mode_header[1] +
4139                                scsi_2btoul(mode_header->blk_desc_len));
4140
4141         return(page_start);
4142 }
4143
4144 __END_DECLS
4145
4146 #endif /*_SCSI_SCSI_ALL_H*/