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