sys/cam/scsi/scsi_all.h

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