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