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: releng/10.0/sys/cam/scsi/scsi_all.h 257049 2013-10-24 10:33:31Z mav $
18 */
19
20 /*
21 * SCSI general interface description
22 */
23
24 #ifndef _SCSI_SCSI_ALL_H
25 #define _SCSI_SCSI_ALL_H 1
26
27 #include <sys/cdefs.h>
28 #include <machine/stdarg.h>
29
30 #ifdef _KERNEL
31 /*
32 * This is the number of seconds we wait for devices to settle after a SCSI
33 * bus reset.
34 */
35 extern int scsi_delay;
36 #endif /* _KERNEL */
37
38 /*
39 * SCSI command format
40 */
41
42 /*
43 * Define dome bits that are in ALL (or a lot of) scsi commands
44 */
45 #define SCSI_CTL_LINK 0x01
46 #define SCSI_CTL_FLAG 0x02
47 #define SCSI_CTL_VENDOR 0xC0
48 #define SCSI_CMD_LUN 0xA0 /* these two should not be needed */
49 #define SCSI_CMD_LUN_SHIFT 5 /* LUN in the cmd is no longer SCSI */
50
51 #define SCSI_MAX_CDBLEN 16 /*
52 * 16 byte commands are in the
53 * SCSI-3 spec
54 */
55 #if defined(CAM_MAX_CDBLEN) && (CAM_MAX_CDBLEN < SCSI_MAX_CDBLEN)
56 #error "CAM_MAX_CDBLEN cannot be less than SCSI_MAX_CDBLEN"
57 #endif
58
59 /* 6byte CDBs special case 0 length to be 256 */
60 #define SCSI_CDB6_LEN(len) ((len) == 0 ? 256 : len)
61
62 /*
63 * This type defines actions to be taken when a particular sense code is
64 * received. Right now, these flags are only defined to take up 16 bits,
65 * but can be expanded in the future if necessary.
66 */
67 typedef enum {
68 SS_NOP = 0x000000, /* Do nothing */
69 SS_RETRY = 0x010000, /* Retry the command */
70 SS_FAIL = 0x020000, /* Bail out */
71 SS_START = 0x030000, /* Send a Start Unit command to the device,
72 * then retry the original command.
73 */
74 SS_TUR = 0x040000, /* Send a Test Unit Ready command to the
75 * device, then retry the original command.
76 */
77 SS_MASK = 0xff0000
78 } scsi_sense_action;
79
80 typedef enum {
81 SSQ_NONE = 0x0000,
82 SSQ_DECREMENT_COUNT = 0x0100, /* Decrement the retry count */
83 SSQ_MANY = 0x0200, /* send lots of recovery commands */
84 SSQ_RANGE = 0x0400, /*
85 * This table entry represents the
86 * end of a range of ASCQs that
87 * have identical error actions
88 * and text.
89 */
90 SSQ_PRINT_SENSE = 0x0800,
91 SSQ_UA = 0x1000, /* Broadcast UA. */
92 SSQ_RESCAN = 0x2000, /* Rescan target for LUNs. */
93 SSQ_LOST = 0x4000, /* Destroy the LUNs. */
94 SSQ_MASK = 0xff00
95 } scsi_sense_action_qualifier;
96
97 /* Mask for error status values */
98 #define SS_ERRMASK 0xff
99
100 /* The default, retyable, error action */
101 #define SS_RDEF SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE|EIO
102
103 /* The retyable, error action, with table specified error code */
104 #define SS_RET SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE
105
106 /* Fatal error action, with table specified error code */
107 #define SS_FATAL SS_FAIL|SSQ_PRINT_SENSE
108
109 struct scsi_generic
110 {
111 u_int8_t opcode;
112 u_int8_t bytes[11];
113 };
114
115 struct scsi_request_sense
116 {
117 u_int8_t opcode;
118 u_int8_t byte2;
119 #define SRS_DESC 0x01
120 u_int8_t unused[2];
121 u_int8_t length;
122 u_int8_t control;
123 };
124
125 struct scsi_test_unit_ready
126 {
127 u_int8_t opcode;
128 u_int8_t byte2;
129 u_int8_t unused[3];
130 u_int8_t control;
131 };
132
133 struct scsi_receive_diag {
134 uint8_t opcode;
135 uint8_t byte2;
136 #define SRD_PCV 0x01
137 uint8_t page_code;
138 uint8_t length[2];
139 uint8_t control;
140 };
141
142 struct scsi_send_diag {
143 uint8_t opcode;
144 uint8_t byte2;
145 #define SSD_UNITOFFL 0x01
146 #define SSD_DEVOFFL 0x02
147 #define SSD_SELFTEST 0x04
148 #define SSD_PF 0x10
149 #define SSD_SELF_TEST_CODE_MASK 0xE0
150 #define SSD_SELF_TEST_CODE_SHIFT 5
151 #define SSD_SELF_TEST_CODE_NONE 0x00
152 #define SSD_SELF_TEST_CODE_BG_SHORT 0x01
153 #define SSD_SELF_TEST_CODE_BG_EXTENDED 0x02
154 #define SSD_SELF_TEST_CODE_BG_ABORT 0x04
155 #define SSD_SELF_TEST_CODE_FG_SHORT 0x05
156 #define SSD_SELF_TEST_CODE_FG_EXTENDED 0x06
157 uint8_t reserved;
158 uint8_t length[2];
159 uint8_t control;
160 };
161
162 struct scsi_sense
163 {
164 u_int8_t opcode;
165 u_int8_t byte2;
166 u_int8_t unused[2];
167 u_int8_t length;
168 u_int8_t control;
169 };
170
171 struct scsi_inquiry
172 {
173 u_int8_t opcode;
174 u_int8_t byte2;
175 #define SI_EVPD 0x01
176 #define SI_CMDDT 0x02
177 u_int8_t page_code;
178 u_int8_t length[2];
179 u_int8_t control;
180 };
181
182 struct scsi_mode_sense_6
183 {
184 u_int8_t opcode;
185 u_int8_t byte2;
186 #define SMS_DBD 0x08
187 u_int8_t page;
188 #define SMS_PAGE_CODE 0x3F
189 #define SMS_VENDOR_SPECIFIC_PAGE 0x00
190 #define SMS_DISCONNECT_RECONNECT_PAGE 0x02
191 #define SMS_FORMAT_DEVICE_PAGE 0x03
192 #define SMS_GEOMETRY_PAGE 0x04
193 #define SMS_CACHE_PAGE 0x08
194 #define SMS_PERIPHERAL_DEVICE_PAGE 0x09
195 #define SMS_CONTROL_MODE_PAGE 0x0A
196 #define SMS_PROTO_SPECIFIC_PAGE 0x19
197 #define SMS_INFO_EXCEPTIONS_PAGE 0x1C
198 #define SMS_ALL_PAGES_PAGE 0x3F
199 #define SMS_PAGE_CTRL_MASK 0xC0
200 #define SMS_PAGE_CTRL_CURRENT 0x00
201 #define SMS_PAGE_CTRL_CHANGEABLE 0x40
202 #define SMS_PAGE_CTRL_DEFAULT 0x80
203 #define SMS_PAGE_CTRL_SAVED 0xC0
204 u_int8_t subpage;
205 #define SMS_SUBPAGE_PAGE_0 0x00
206 #define SMS_SUBPAGE_ALL 0xff
207 u_int8_t length;
208 u_int8_t control;
209 };
210
211 struct scsi_mode_sense_10
212 {
213 u_int8_t opcode;
214 u_int8_t byte2; /* same bits as small version */
215 #define SMS10_LLBAA 0x10
216 u_int8_t page; /* same bits as small version */
217 u_int8_t subpage;
218 u_int8_t unused[3];
219 u_int8_t length[2];
220 u_int8_t control;
221 };
222
223 struct scsi_mode_select_6
224 {
225 u_int8_t opcode;
226 u_int8_t byte2;
227 #define SMS_SP 0x01
228 #define SMS_PF 0x10
229 u_int8_t unused[2];
230 u_int8_t length;
231 u_int8_t control;
232 };
233
234 struct scsi_mode_select_10
235 {
236 u_int8_t opcode;
237 u_int8_t byte2; /* same bits as small version */
238 u_int8_t unused[5];
239 u_int8_t length[2];
240 u_int8_t control;
241 };
242
243 /*
244 * When sending a mode select to a tape drive, the medium type must be 0.
245 */
246 struct scsi_mode_hdr_6
247 {
248 u_int8_t datalen;
249 u_int8_t medium_type;
250 u_int8_t dev_specific;
251 u_int8_t block_descr_len;
252 };
253
254 struct scsi_mode_hdr_10
255 {
256 u_int8_t datalen[2];
257 u_int8_t medium_type;
258 u_int8_t dev_specific;
259 u_int8_t reserved[2];
260 u_int8_t block_descr_len[2];
261 };
262
263 struct scsi_mode_block_descr
264 {
265 u_int8_t density_code;
266 u_int8_t num_blocks[3];
267 u_int8_t reserved;
268 u_int8_t block_len[3];
269 };
270
271 struct scsi_per_res_in
272 {
273 u_int8_t opcode;
274 u_int8_t action;
275 #define SPRI_RK 0x00
276 #define SPRI_RR 0x01
277 #define SPRI_RC 0x02
278 #define SPRI_RS 0x03
279 u_int8_t reserved[5];
280 u_int8_t length[2];
281 u_int8_t control;
282 };
283
284 struct scsi_per_res_in_header
285 {
286 u_int8_t generation[4];
287 u_int8_t length[4];
288 };
289
290 struct scsi_per_res_key
291 {
292 u_int8_t key[8];
293 };
294
295 struct scsi_per_res_in_keys
296 {
297 struct scsi_per_res_in_header header;
298 struct scsi_per_res_key keys[0];
299 };
300
301 struct scsi_per_res_cap
302 {
303 uint8_t length[2];
304 uint8_t flags1;
305 #define SPRI_CRH 0x10
306 #define SPRI_SIP_C 0x08
307 #define SPRI_ATP_C 0x04
308 #define SPRI_PTPL_C 0x01
309 uint8_t flags2;
310 #define SPRI_TMV 0x80
311 #define SPRI_PTPL_A 0x01
312 uint8_t type_mask[2];
313 #define SPRI_TM_WR_EX_AR 0x8000
314 #define SPRI_TM_EX_AC_RO 0x4000
315 #define SPRI_TM_WR_EX_RO 0x2000
316 #define SPRI_TM_EX_AC 0x0800
317 #define SPRI_TM_WR_EX 0x0200
318 #define SPRI_TM_EX_AC_AR 0x0001
319 uint8_t reserved[2];
320 };
321
322 struct scsi_per_res_in_rsrv_data
323 {
324 uint8_t reservation[8];
325 uint8_t obsolete1[4];
326 uint8_t reserved;
327 uint8_t scopetype;
328 #define SPRT_WE 0x01
329 #define SPRT_EA 0x03
330 #define SPRT_WERO 0x05
331 #define SPRT_EARO 0x06
332 #define SPRT_WEAR 0x07
333 #define SPRT_EAAR 0x08
334 uint8_t obsolete2[2];
335 };
336
337 struct scsi_per_res_in_rsrv
338 {
339 struct scsi_per_res_in_header header;
340 struct scsi_per_res_in_rsrv_data data;
341 };
342
343 struct scsi_per_res_out
344 {
345 u_int8_t opcode;
346 u_int8_t action;
347 #define SPRO_REGISTER 0x00
348 #define SPRO_RESERVE 0x01
349 #define SPRO_RELEASE 0x02
350 #define SPRO_CLEAR 0x03
351 #define SPRO_PREEMPT 0x04
352 #define SPRO_PRE_ABO 0x05
353 #define SPRO_REG_IGNO 0x06
354 #define SPRO_REG_MOVE 0x07
355 #define SPRO_ACTION_MASK 0x1f
356 u_int8_t scope_type;
357 #define SPR_SCOPE_MASK 0xf0
358 #define SPR_LU_SCOPE 0x00
359 #define SPR_TYPE_MASK 0x0f
360 #define SPR_TYPE_WR_EX 0x01
361 #define SPR_TYPE_EX_AC 0x03
362 #define SPR_TYPE_WR_EX_RO 0x05
363 #define SPR_TYPE_EX_AC_RO 0x06
364 #define SPR_TYPE_WR_EX_AR 0x07
365 #define SPR_TYPE_EX_AC_AR 0x08
366 u_int8_t reserved[2];
367 u_int8_t length[4];
368 u_int8_t control;
369 };
370
371 struct scsi_per_res_out_parms
372 {
373 struct scsi_per_res_key res_key;
374 u_int8_t serv_act_res_key[8];
375 u_int8_t obsolete1[4];
376 u_int8_t flags;
377 #define SPR_SPEC_I_PT 0x08
378 #define SPR_ALL_TG_PT 0x04
379 #define SPR_APTPL 0x01
380 u_int8_t reserved1;
381 u_int8_t obsolete2[2];
382 };
383
384
385 struct scsi_log_sense
386 {
387 u_int8_t opcode;
388 u_int8_t byte2;
389 #define SLS_SP 0x01
390 #define SLS_PPC 0x02
391 u_int8_t page;
392 #define SLS_PAGE_CODE 0x3F
393 #define SLS_ALL_PAGES_PAGE 0x00
394 #define SLS_OVERRUN_PAGE 0x01
395 #define SLS_ERROR_WRITE_PAGE 0x02
396 #define SLS_ERROR_READ_PAGE 0x03
397 #define SLS_ERROR_READREVERSE_PAGE 0x04
398 #define SLS_ERROR_VERIFY_PAGE 0x05
399 #define SLS_ERROR_NONMEDIUM_PAGE 0x06
400 #define SLS_ERROR_LASTN_PAGE 0x07
401 #define SLS_SELF_TEST_PAGE 0x10
402 #define SLS_IE_PAGE 0x2f
403 #define SLS_PAGE_CTRL_MASK 0xC0
404 #define SLS_PAGE_CTRL_THRESHOLD 0x00
405 #define SLS_PAGE_CTRL_CUMULATIVE 0x40
406 #define SLS_PAGE_CTRL_THRESH_DEFAULT 0x80
407 #define SLS_PAGE_CTRL_CUMUL_DEFAULT 0xC0
408 u_int8_t reserved[2];
409 u_int8_t paramptr[2];
410 u_int8_t length[2];
411 u_int8_t control;
412 };
413
414 struct scsi_log_select
415 {
416 u_int8_t opcode;
417 u_int8_t byte2;
418 /* SLS_SP 0x01 */
419 #define SLS_PCR 0x02
420 u_int8_t page;
421 /* SLS_PAGE_CTRL_MASK 0xC0 */
422 /* SLS_PAGE_CTRL_THRESHOLD 0x00 */
423 /* SLS_PAGE_CTRL_CUMULATIVE 0x40 */
424 /* SLS_PAGE_CTRL_THRESH_DEFAULT 0x80 */
425 /* SLS_PAGE_CTRL_CUMUL_DEFAULT 0xC0 */
426 u_int8_t reserved[4];
427 u_int8_t length[2];
428 u_int8_t control;
429 };
430
431 struct scsi_log_header
432 {
433 u_int8_t page;
434 u_int8_t reserved;
435 u_int8_t datalen[2];
436 };
437
438 struct scsi_log_param_header {
439 u_int8_t param_code[2];
440 u_int8_t param_control;
441 #define SLP_LP 0x01
442 #define SLP_LBIN 0x02
443 #define SLP_TMC_MASK 0x0C
444 #define SLP_TMC_ALWAYS 0x00
445 #define SLP_TMC_EQUAL 0x04
446 #define SLP_TMC_NOTEQUAL 0x08
447 #define SLP_TMC_GREATER 0x0C
448 #define SLP_ETC 0x10
449 #define SLP_TSD 0x20
450 #define SLP_DS 0x40
451 #define SLP_DU 0x80
452 u_int8_t param_len;
453 };
454
455 struct scsi_control_page {
456 u_int8_t page_code;
457 u_int8_t page_length;
458 u_int8_t rlec;
459 #define SCP_RLEC 0x01 /*Report Log Exception Cond*/
460 #define SCP_GLTSD 0x02 /*Global Logging target
461 save disable */
462 #define SCP_DSENSE 0x04 /*Descriptor Sense */
463 #define SCP_DPICZ 0x08 /*Disable Prot. Info Check
464 if Prot. Field is Zero */
465 #define SCP_TMF_ONLY 0x10 /*TM Functions Only*/
466 #define SCP_TST_MASK 0xE0 /*Task Set Type Mask*/
467 #define SCP_TST_ONE 0x00 /*One Task Set*/
468 #define SCP_TST_SEPARATE 0x20 /*Separate Task Sets*/
469 u_int8_t queue_flags;
470 #define SCP_QUEUE_ALG_MASK 0xF0
471 #define SCP_QUEUE_ALG_RESTRICTED 0x00
472 #define SCP_QUEUE_ALG_UNRESTRICTED 0x10
473 #define SCP_QUEUE_ERR 0x02 /*Queued I/O aborted for CACs*/
474 #define SCP_QUEUE_DQUE 0x01 /*Queued I/O disabled*/
475 u_int8_t eca_and_aen;
476 #define SCP_EECA 0x80 /*Enable Extended CA*/
477 #define SCP_RAENP 0x04 /*Ready AEN Permission*/
478 #define SCP_UAAENP 0x02 /*UA AEN Permission*/
479 #define SCP_EAENP 0x01 /*Error AEN Permission*/
480 u_int8_t reserved;
481 u_int8_t aen_holdoff_period[2];
482 };
483
484 struct scsi_cache_page {
485 u_int8_t page_code;
486 #define SCHP_PAGE_SAVABLE 0x80 /* Page is savable */
487 u_int8_t page_length;
488 u_int8_t cache_flags;
489 #define SCHP_FLAGS_WCE 0x04 /* Write Cache Enable */
490 #define SCHP_FLAGS_MF 0x02 /* Multiplication factor */
491 #define SCHP_FLAGS_RCD 0x01 /* Read Cache Disable */
492 u_int8_t rw_cache_policy;
493 u_int8_t dis_prefetch[2];
494 u_int8_t min_prefetch[2];
495 u_int8_t max_prefetch[2];
496 u_int8_t max_prefetch_ceil[2];
497 };
498
499 /*
500 * XXX KDM
501 * Updated version of the cache page, as of SBC. Update this to SBC-3 and
502 * rationalize the two.
503 */
504 struct scsi_caching_page {
505 uint8_t page_code;
506 #define SMS_CACHING_PAGE 0x08
507 uint8_t page_length;
508 uint8_t flags1;
509 #define SCP_IC 0x80
510 #define SCP_ABPF 0x40
511 #define SCP_CAP 0x20
512 #define SCP_DISC 0x10
513 #define SCP_SIZE 0x08
514 #define SCP_WCE 0x04
515 #define SCP_MF 0x02
516 #define SCP_RCD 0x01
517 uint8_t ret_priority;
518 uint8_t disable_pf_transfer_len[2];
519 uint8_t min_prefetch[2];
520 uint8_t max_prefetch[2];
521 uint8_t max_pf_ceiling[2];
522 uint8_t flags2;
523 #define SCP_FSW 0x80
524 #define SCP_LBCSS 0x40
525 #define SCP_DRA 0x20
526 #define SCP_VS1 0x10
527 #define SCP_VS2 0x08
528 uint8_t cache_segments;
529 uint8_t cache_seg_size[2];
530 uint8_t reserved;
531 uint8_t non_cache_seg_size[3];
532 };
533
534 /*
535 * XXX KDM move this off to a vendor shim.
536 */
537 struct copan_power_subpage {
538 uint8_t page_code;
539 #define PWR_PAGE_CODE 0x00
540 uint8_t subpage;
541 #define PWR_SUBPAGE_CODE 0x02
542 uint8_t page_length[2];
543 uint8_t page_version;
544 #define PWR_VERSION 0x01
545 uint8_t total_luns;
546 uint8_t max_active_luns;
547 #define PWR_DFLT_MAX_LUNS 0x07
548 uint8_t reserved[25];
549 };
550
551 /*
552 * XXX KDM move this off to a vendor shim.
553 */
554 struct copan_aps_subpage {
555 uint8_t page_code;
556 #define APS_PAGE_CODE 0x00
557 uint8_t subpage;
558 #define APS_SUBPAGE_CODE 0x03
559 uint8_t page_length[2];
560 uint8_t page_version;
561 #define APS_VERSION 0x00
562 uint8_t lock_active;
563 #define APS_LOCK_ACTIVE 0x01
564 #define APS_LOCK_INACTIVE 0x00
565 uint8_t reserved[26];
566 };
567
568 /*
569 * XXX KDM move this off to a vendor shim.
570 */
571 struct copan_debugconf_subpage {
572 uint8_t page_code;
573 #define DBGCNF_PAGE_CODE 0x00
574 uint8_t subpage;
575 #define DBGCNF_SUBPAGE_CODE 0xF0
576 uint8_t page_length[2];
577 uint8_t page_version;
578 #define DBGCNF_VERSION 0x00
579 uint8_t ctl_time_io_secs[2];
580 };
581
582
583 struct scsi_info_exceptions_page {
584 u_int8_t page_code;
585 #define SIEP_PAGE_SAVABLE 0x80 /* Page is savable */
586 u_int8_t page_length;
587 u_int8_t info_flags;
588 #define SIEP_FLAGS_PERF 0x80
589 #define SIEP_FLAGS_EBF 0x20
590 #define SIEP_FLAGS_EWASC 0x10
591 #define SIEP_FLAGS_DEXCPT 0x08
592 #define SIEP_FLAGS_TEST 0x04
593 #define SIEP_FLAGS_EBACKERR 0x02
594 #define SIEP_FLAGS_LOGERR 0x01
595 u_int8_t mrie;
596 u_int8_t interval_timer[4];
597 u_int8_t report_count[4];
598 };
599
600 struct scsi_proto_specific_page {
601 u_int8_t page_code;
602 #define SPSP_PAGE_SAVABLE 0x80 /* Page is savable */
603 u_int8_t page_length;
604 u_int8_t protocol;
605 #define SPSP_PROTO_FC 0x00
606 #define SPSP_PROTO_SPI 0x01
607 #define SPSP_PROTO_SSA 0x02
608 #define SPSP_PROTO_1394 0x03
609 #define SPSP_PROTO_RDMA 0x04
610 #define SPSP_PROTO_ISCSI 0x05
611 #define SPSP_PROTO_SAS 0x06
612 #define SPSP_PROTO_ADT 0x07
613 #define SPSP_PROTO_ATA 0x08
614 #define SPSP_PROTO_NONE 0x0f
615 };
616
617 struct scsi_reserve
618 {
619 u_int8_t opcode;
620 u_int8_t byte2;
621 #define SR_EXTENT 0x01
622 #define SR_ID_MASK 0x0e
623 #define SR_3RDPTY 0x10
624 #define SR_LUN_MASK 0xe0
625 u_int8_t resv_id;
626 u_int8_t length[2];
627 u_int8_t control;
628 };
629
630 struct scsi_reserve_10 {
631 uint8_t opcode;
632 uint8_t byte2;
633 #define SR10_3RDPTY 0x10
634 #define SR10_LONGID 0x02
635 #define SR10_EXTENT 0x01
636 uint8_t resv_id;
637 uint8_t thirdparty_id;
638 uint8_t reserved[3];
639 uint8_t length[2];
640 uint8_t control;
641 };
642
643
644 struct scsi_release
645 {
646 u_int8_t opcode;
647 u_int8_t byte2;
648 u_int8_t resv_id;
649 u_int8_t unused[1];
650 u_int8_t length;
651 u_int8_t control;
652 };
653
654 struct scsi_release_10 {
655 uint8_t opcode;
656 uint8_t byte2;
657 uint8_t resv_id;
658 uint8_t thirdparty_id;
659 uint8_t reserved[3];
660 uint8_t length[2];
661 uint8_t control;
662 };
663
664 struct scsi_prevent
665 {
666 u_int8_t opcode;
667 u_int8_t byte2;
668 u_int8_t unused[2];
669 u_int8_t how;
670 u_int8_t control;
671 };
672 #define PR_PREVENT 0x01
673 #define PR_ALLOW 0x00
674
675 struct scsi_sync_cache
676 {
677 u_int8_t opcode;
678 u_int8_t byte2;
679 #define SSC_IMMED 0x02
680 #define SSC_RELADR 0x01
681 u_int8_t begin_lba[4];
682 u_int8_t reserved;
683 u_int8_t lb_count[2];
684 u_int8_t control;
685 };
686
687 struct scsi_sync_cache_16
688 {
689 uint8_t opcode;
690 uint8_t byte2;
691 uint8_t begin_lba[8];
692 uint8_t lb_count[4];
693 uint8_t reserved;
694 uint8_t control;
695 };
696
697 struct scsi_format {
698 uint8_t opcode;
699 uint8_t byte2;
700 #define SF_LONGLIST 0x20
701 #define SF_FMTDATA 0x10
702 #define SF_CMPLIST 0x08
703 #define SF_FORMAT_MASK 0x07
704 #define SF_FORMAT_BLOCK 0x00
705 #define SF_FORMAT_LONG_BLOCK 0x03
706 #define SF_FORMAT_BFI 0x04
707 #define SF_FORMAT_PHYS 0x05
708 uint8_t vendor;
709 uint8_t interleave[2];
710 uint8_t control;
711 };
712
713 struct scsi_format_header_short {
714 uint8_t reserved;
715 #define SF_DATA_FOV 0x80
716 #define SF_DATA_DPRY 0x40
717 #define SF_DATA_DCRT 0x20
718 #define SF_DATA_STPF 0x10
719 #define SF_DATA_IP 0x08
720 #define SF_DATA_DSP 0x04
721 #define SF_DATA_IMMED 0x02
722 #define SF_DATA_VS 0x01
723 uint8_t byte2;
724 uint8_t defect_list_len[2];
725 };
726
727 struct scsi_format_header_long {
728 uint8_t reserved;
729 uint8_t byte2;
730 uint8_t reserved2[2];
731 uint8_t defect_list_len[4];
732 };
733
734 struct scsi_changedef
735 {
736 u_int8_t opcode;
737 u_int8_t byte2;
738 u_int8_t unused1;
739 u_int8_t how;
740 u_int8_t unused[4];
741 u_int8_t datalen;
742 u_int8_t control;
743 };
744
745 struct scsi_read_buffer
746 {
747 u_int8_t opcode;
748 u_int8_t byte2;
749 #define RWB_MODE 0x07
750 #define RWB_MODE_HDR_DATA 0x00
751 #define RWB_MODE_VENDOR 0x01
752 #define RWB_MODE_DATA 0x02
753 #define RWB_MODE_DOWNLOAD 0x04
754 #define RWB_MODE_DOWNLOAD_SAVE 0x05
755 u_int8_t buffer_id;
756 u_int8_t offset[3];
757 u_int8_t length[3];
758 u_int8_t control;
759 };
760
761 struct scsi_write_buffer
762 {
763 u_int8_t opcode;
764 u_int8_t byte2;
765 u_int8_t buffer_id;
766 u_int8_t offset[3];
767 u_int8_t length[3];
768 u_int8_t control;
769 };
770
771 struct scsi_rw_6
772 {
773 u_int8_t opcode;
774 u_int8_t addr[3];
775 /* only 5 bits are valid in the MSB address byte */
776 #define SRW_TOPADDR 0x1F
777 u_int8_t length;
778 u_int8_t control;
779 };
780
781 struct scsi_rw_10
782 {
783 u_int8_t opcode;
784 #define SRW10_RELADDR 0x01
785 /* EBP defined for WRITE(10) only */
786 #define SRW10_EBP 0x04
787 #define SRW10_FUA 0x08
788 #define SRW10_DPO 0x10
789 u_int8_t byte2;
790 u_int8_t addr[4];
791 u_int8_t reserved;
792 u_int8_t length[2];
793 u_int8_t control;
794 };
795
796 struct scsi_rw_12
797 {
798 u_int8_t opcode;
799 #define SRW12_RELADDR 0x01
800 #define SRW12_FUA 0x08
801 #define SRW12_DPO 0x10
802 u_int8_t byte2;
803 u_int8_t addr[4];
804 u_int8_t length[4];
805 u_int8_t reserved;
806 u_int8_t control;
807 };
808
809 struct scsi_rw_16
810 {
811 u_int8_t opcode;
812 #define SRW16_RELADDR 0x01
813 #define SRW16_FUA 0x08
814 #define SRW16_DPO 0x10
815 u_int8_t byte2;
816 u_int8_t addr[8];
817 u_int8_t length[4];
818 u_int8_t reserved;
819 u_int8_t control;
820 };
821
822 struct scsi_write_same_10
823 {
824 uint8_t opcode;
825 uint8_t byte2;
826 #define SWS_LBDATA 0x02
827 #define SWS_PBDATA 0x04
828 #define SWS_UNMAP 0x08
829 #define SWS_ANCHOR 0x10
830 uint8_t addr[4];
831 uint8_t group;
832 uint8_t length[2];
833 uint8_t control;
834 };
835
836 struct scsi_write_same_16
837 {
838 uint8_t opcode;
839 uint8_t byte2;
840 uint8_t addr[8];
841 uint8_t length[4];
842 uint8_t group;
843 uint8_t control;
844 };
845
846 struct scsi_unmap
847 {
848 uint8_t opcode;
849 uint8_t byte2;
850 #define SU_ANCHOR 0x01
851 uint8_t reserved[4];
852 uint8_t group;
853 uint8_t length[2];
854 uint8_t control;
855 };
856
857 struct scsi_write_verify_10
858 {
859 uint8_t opcode;
860 uint8_t byte2;
861 #define SWV_BYTCHK 0x02
862 #define SWV_DPO 0x10
863 #define SWV_WRPROECT_MASK 0xe0
864 uint8_t addr[4];
865 uint8_t group;
866 uint8_t length[2];
867 uint8_t control;
868 };
869
870 struct scsi_write_verify_12
871 {
872 uint8_t opcode;
873 uint8_t byte2;
874 uint8_t addr[4];
875 uint8_t length[4];
876 uint8_t group;
877 uint8_t control;
878 };
879
880 struct scsi_write_verify_16
881 {
882 uint8_t opcode;
883 uint8_t byte2;
884 uint8_t addr[8];
885 uint8_t length[4];
886 uint8_t group;
887 uint8_t control;
888 };
889
890
891 struct scsi_start_stop_unit
892 {
893 u_int8_t opcode;
894 u_int8_t byte2;
895 #define SSS_IMMED 0x01
896 u_int8_t reserved[2];
897 u_int8_t how;
898 #define SSS_START 0x01
899 #define SSS_LOEJ 0x02
900 #define SSS_PC_MASK 0xf0
901 #define SSS_PC_START_VALID 0x00
902 #define SSS_PC_ACTIVE 0x10
903 #define SSS_PC_IDLE 0x20
904 #define SSS_PC_STANDBY 0x30
905 #define SSS_PC_LU_CONTROL 0x70
906 #define SSS_PC_FORCE_IDLE_0 0xa0
907 #define SSS_PC_FORCE_STANDBY_0 0xb0
908 u_int8_t control;
909 };
910
911 struct ata_pass_12 {
912 u_int8_t opcode;
913 u_int8_t protocol;
914 #define AP_PROTO_HARD_RESET (0x00 << 1)
915 #define AP_PROTO_SRST (0x01 << 1)
916 #define AP_PROTO_NON_DATA (0x03 << 1)
917 #define AP_PROTO_PIO_IN (0x04 << 1)
918 #define AP_PROTO_PIO_OUT (0x05 << 1)
919 #define AP_PROTO_DMA (0x06 << 1)
920 #define AP_PROTO_DMA_QUEUED (0x07 << 1)
921 #define AP_PROTO_DEVICE_DIAG (0x08 << 1)
922 #define AP_PROTO_DEVICE_RESET (0x09 << 1)
923 #define AP_PROTO_UDMA_IN (0x0a << 1)
924 #define AP_PROTO_UDMA_OUT (0x0b << 1)
925 #define AP_PROTO_FPDMA (0x0c << 1)
926 #define AP_PROTO_RESP_INFO (0x0f << 1)
927 #define AP_MULTI 0xe0
928 u_int8_t flags;
929 #define AP_T_LEN 0x03
930 #define AP_BB 0x04
931 #define AP_T_DIR 0x08
932 #define AP_CK_COND 0x20
933 #define AP_OFFLINE 0x60
934 u_int8_t features;
935 u_int8_t sector_count;
936 u_int8_t lba_low;
937 u_int8_t lba_mid;
938 u_int8_t lba_high;
939 u_int8_t device;
940 u_int8_t command;
941 u_int8_t reserved;
942 u_int8_t control;
943 };
944
945 struct scsi_maintenance_in
946 {
947 uint8_t opcode;
948 uint8_t byte2;
949 #define SERVICE_ACTION_MASK 0x1f
950 #define SA_RPRT_TRGT_GRP 0x0a
951 uint8_t reserved[4];
952 uint8_t length[4];
953 uint8_t reserved1;
954 uint8_t control;
955 };
956
957 struct ata_pass_16 {
958 u_int8_t opcode;
959 u_int8_t protocol;
960 #define AP_EXTEND 0x01
961 u_int8_t flags;
962 #define AP_FLAG_TLEN_NO_DATA (0 << 0)
963 #define AP_FLAG_TLEN_FEAT (1 << 0)
964 #define AP_FLAG_TLEN_SECT_CNT (2 << 0)
965 #define AP_FLAG_TLEN_STPSIU (3 << 0)
966 #define AP_FLAG_BYT_BLOK_BYTES (0 << 2)
967 #define AP_FLAG_BYT_BLOK_BLOCKS (1 << 2)
968 #define AP_FLAG_TDIR_TO_DEV (0 << 3)
969 #define AP_FLAG_TDIR_FROM_DEV (1 << 3)
970 #define AP_FLAG_CHK_COND (1 << 5)
971 u_int8_t features_ext;
972 u_int8_t features;
973 u_int8_t sector_count_ext;
974 u_int8_t sector_count;
975 u_int8_t lba_low_ext;
976 u_int8_t lba_low;
977 u_int8_t lba_mid_ext;
978 u_int8_t lba_mid;
979 u_int8_t lba_high_ext;
980 u_int8_t lba_high;
981 u_int8_t device;
982 u_int8_t command;
983 u_int8_t control;
984 };
985
986 #define SC_SCSI_1 0x01
987 #define SC_SCSI_2 0x03
988
989 /*
990 * Opcodes
991 */
992
993 #define TEST_UNIT_READY 0x00
994 #define REQUEST_SENSE 0x03
995 #define READ_6 0x08
996 #define WRITE_6 0x0A
997 #define INQUIRY 0x12
998 #define MODE_SELECT_6 0x15
999 #define MODE_SENSE_6 0x1A
1000 #define START_STOP_UNIT 0x1B
1001 #define START_STOP 0x1B
1002 #define RESERVE 0x16
1003 #define RELEASE 0x17
1004 #define RECEIVE_DIAGNOSTIC 0x1C
1005 #define SEND_DIAGNOSTIC 0x1D
1006 #define PREVENT_ALLOW 0x1E
1007 #define READ_CAPACITY 0x25
1008 #define READ_10 0x28
1009 #define WRITE_10 0x2A
1010 #define POSITION_TO_ELEMENT 0x2B
1011 #define WRITE_VERIFY_10 0x2E
1012 #define VERIFY_10 0x2F
1013 #define SYNCHRONIZE_CACHE 0x35
1014 #define READ_DEFECT_DATA_10 0x37
1015 #define WRITE_BUFFER 0x3B
1016 #define READ_BUFFER 0x3C
1017 #define CHANGE_DEFINITION 0x40
1018 #define WRITE_SAME_10 0x41
1019 #define UNMAP 0x42
1020 #define LOG_SELECT 0x4C
1021 #define LOG_SENSE 0x4D
1022 #define MODE_SELECT_10 0x55
1023 #define RESERVE_10 0x56
1024 #define RELEASE_10 0x57
1025 #define MODE_SENSE_10 0x5A
1026 #define PERSISTENT_RES_IN 0x5E
1027 #define PERSISTENT_RES_OUT 0x5F
1028 #define ATA_PASS_16 0x85
1029 #define READ_16 0x88
1030 #define WRITE_16 0x8A
1031 #define WRITE_VERIFY_16 0x8E
1032 #define SYNCHRONIZE_CACHE_16 0x91
1033 #define WRITE_SAME_16 0x93
1034 #define SERVICE_ACTION_IN 0x9E
1035 #define REPORT_LUNS 0xA0
1036 #define ATA_PASS_12 0xA1
1037 #define MAINTENANCE_IN 0xA3
1038 #define MAINTENANCE_OUT 0xA4
1039 #define MOVE_MEDIUM 0xA5
1040 #define READ_12 0xA8
1041 #define WRITE_12 0xAA
1042 #define WRITE_VERIFY_12 0xAE
1043 #define READ_ELEMENT_STATUS 0xB8
1044 #define READ_CD 0xBE
1045
1046 /* Maintenance In Service Action Codes */
1047 #define REPORT_IDENTIFYING_INFRMATION 0x05
1048 #define REPORT_TARGET_PORT_GROUPS 0x0A
1049 #define REPORT_ALIASES 0x0B
1050 #define REPORT_SUPPORTED_OPERATION_CODES 0x0C
1051 #define REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS 0x0D
1052 #define REPORT_PRIORITY 0x0E
1053 #define REPORT_TIMESTAMP 0x0F
1054 #define MANAGEMENT_PROTOCOL_IN 0x10
1055 /* Maintenance Out Service Action Codes */
1056 #define SET_IDENTIFY_INFORMATION 0x06
1057 #define SET_TARGET_PORT_GROUPS 0x0A
1058 #define CHANGE_ALIASES 0x0B
1059 #define SET_PRIORITY 0x0E
1060 #define SET_TIMESTAMP 0x0F
1061 #define MANGAEMENT_PROTOCOL_OUT 0x10
1062
1063 /*
1064 * Device Types
1065 */
1066 #define T_DIRECT 0x00
1067 #define T_SEQUENTIAL 0x01
1068 #define T_PRINTER 0x02
1069 #define T_PROCESSOR 0x03
1070 #define T_WORM 0x04
1071 #define T_CDROM 0x05
1072 #define T_SCANNER 0x06
1073 #define T_OPTICAL 0x07
1074 #define T_CHANGER 0x08
1075 #define T_COMM 0x09
1076 #define T_ASC0 0x0a
1077 #define T_ASC1 0x0b
1078 #define T_STORARRAY 0x0c
1079 #define T_ENCLOSURE 0x0d
1080 #define T_RBC 0x0e
1081 #define T_OCRW 0x0f
1082 #define T_OSD 0x11
1083 #define T_ADC 0x12
1084 #define T_NODEVICE 0x1f
1085 #define T_ANY 0xff /* Used in Quirk table matches */
1086
1087 #define T_REMOV 1
1088 #define T_FIXED 0
1089
1090 /*
1091 * This length is the initial inquiry length used by the probe code, as
1092 * well as the length necessary for scsi_print_inquiry() to function
1093 * correctly. If either use requires a different length in the future,
1094 * the two values should be de-coupled.
1095 */
1096 #define SHORT_INQUIRY_LENGTH 36
1097
1098 struct scsi_inquiry_data
1099 {
1100 u_int8_t device;
1101 #define SID_TYPE(inq_data) ((inq_data)->device & 0x1f)
1102 #define SID_QUAL(inq_data) (((inq_data)->device & 0xE0) >> 5)
1103 #define SID_QUAL_LU_CONNECTED 0x00 /*
1104 * The specified peripheral device
1105 * type is currently connected to
1106 * logical unit. If the target cannot
1107 * determine whether or not a physical
1108 * device is currently connected, it
1109 * shall also use this peripheral
1110 * qualifier when returning the INQUIRY
1111 * data. This peripheral qualifier
1112 * does not mean that the device is
1113 * ready for access by the initiator.
1114 */
1115 #define SID_QUAL_LU_OFFLINE 0x01 /*
1116 * The target is capable of supporting
1117 * the specified peripheral device type
1118 * on this logical unit; however, the
1119 * physical device is not currently
1120 * connected to this logical unit.
1121 */
1122 #define SID_QUAL_RSVD 0x02
1123 #define SID_QUAL_BAD_LU 0x03 /*
1124 * The target is not capable of
1125 * supporting a physical device on
1126 * this logical unit. For this
1127 * peripheral qualifier the peripheral
1128 * device type shall be set to 1Fh to
1129 * provide compatibility with previous
1130 * versions of SCSI. All other
1131 * peripheral device type values are
1132 * reserved for this peripheral
1133 * qualifier.
1134 */
1135 #define SID_QUAL_IS_VENDOR_UNIQUE(inq_data) ((SID_QUAL(inq_data) & 0x08) != 0)
1136 u_int8_t dev_qual2;
1137 #define SID_QUAL2 0x7F
1138 #define SID_IS_REMOVABLE(inq_data) (((inq_data)->dev_qual2 & 0x80) != 0)
1139 u_int8_t version;
1140 #define SID_ANSI_REV(inq_data) ((inq_data)->version & 0x07)
1141 #define SCSI_REV_0 0
1142 #define SCSI_REV_CCS 1
1143 #define SCSI_REV_2 2
1144 #define SCSI_REV_SPC 3
1145 #define SCSI_REV_SPC2 4
1146 #define SCSI_REV_SPC3 5
1147 #define SCSI_REV_SPC4 6
1148
1149 #define SID_ECMA 0x38
1150 #define SID_ISO 0xC0
1151 u_int8_t response_format;
1152 #define SID_AENC 0x80
1153 #define SID_TrmIOP 0x40
1154 #define SID_NormACA 0x20
1155 #define SID_HiSup 0x10
1156 u_int8_t additional_length;
1157 #define SID_ADDITIONAL_LENGTH(iqd) \
1158 ((iqd)->additional_length + \
1159 __offsetof(struct scsi_inquiry_data, additional_length) + 1)
1160 u_int8_t spc3_flags;
1161 #define SPC3_SID_PROTECT 0x01
1162 #define SPC3_SID_3PC 0x08
1163 #define SPC3_SID_TPGS_MASK 0x30
1164 #define SPC3_SID_TPGS_IMPLICIT 0x10
1165 #define SPC3_SID_TPGS_EXPLICIT 0x20
1166 #define SPC3_SID_ACC 0x40
1167 #define SPC3_SID_SCCS 0x80
1168 u_int8_t spc2_flags;
1169 #define SPC2_SID_ADDR16 0x01
1170 #define SPC2_SID_MChngr 0x08
1171 #define SPC2_SID_MultiP 0x10
1172 #define SPC2_SID_EncServ 0x40
1173 #define SPC2_SID_BQueue 0x80
1174
1175 #define INQ_DATA_TQ_ENABLED(iqd) \
1176 ((SID_ANSI_REV(iqd) < SCSI_REV_SPC2)? ((iqd)->flags & SID_CmdQue) : \
1177 (((iqd)->flags & SID_CmdQue) && !((iqd)->spc2_flags & SPC2_SID_BQueue)) || \
1178 (!((iqd)->flags & SID_CmdQue) && ((iqd)->spc2_flags & SPC2_SID_BQueue)))
1179
1180 u_int8_t flags;
1181 #define SID_SftRe 0x01
1182 #define SID_CmdQue 0x02
1183 #define SID_Linked 0x08
1184 #define SID_Sync 0x10
1185 #define SID_WBus16 0x20
1186 #define SID_WBus32 0x40
1187 #define SID_RelAdr 0x80
1188 #define SID_VENDOR_SIZE 8
1189 char vendor[SID_VENDOR_SIZE];
1190 #define SID_PRODUCT_SIZE 16
1191 char product[SID_PRODUCT_SIZE];
1192 #define SID_REVISION_SIZE 4
1193 char revision[SID_REVISION_SIZE];
1194 /*
1195 * The following fields were taken from SCSI Primary Commands - 2
1196 * (SPC-2) Revision 14, Dated 11 November 1999
1197 */
1198 #define SID_VENDOR_SPECIFIC_0_SIZE 20
1199 u_int8_t vendor_specific0[SID_VENDOR_SPECIFIC_0_SIZE];
1200 /*
1201 * An extension of SCSI Parallel Specific Values
1202 */
1203 #define SID_SPI_IUS 0x01
1204 #define SID_SPI_QAS 0x02
1205 #define SID_SPI_CLOCK_ST 0x00
1206 #define SID_SPI_CLOCK_DT 0x04
1207 #define SID_SPI_CLOCK_DT_ST 0x0C
1208 #define SID_SPI_MASK 0x0F
1209 u_int8_t spi3data;
1210 u_int8_t reserved2;
1211 /*
1212 * Version Descriptors, stored 2 byte values.
1213 */
1214 u_int8_t version1[2];
1215 u_int8_t version2[2];
1216 u_int8_t version3[2];
1217 u_int8_t version4[2];
1218 u_int8_t version5[2];
1219 u_int8_t version6[2];
1220 u_int8_t version7[2];
1221 u_int8_t version8[2];
1222
1223 u_int8_t reserved3[22];
1224
1225 #define SID_VENDOR_SPECIFIC_1_SIZE 160
1226 u_int8_t vendor_specific1[SID_VENDOR_SPECIFIC_1_SIZE];
1227 };
1228
1229 /*
1230 * This structure is more suited to initiator operation, because the
1231 * maximum number of supported pages is already allocated.
1232 */
1233 struct scsi_vpd_supported_page_list
1234 {
1235 u_int8_t device;
1236 u_int8_t page_code;
1237 #define SVPD_SUPPORTED_PAGE_LIST 0x00
1238 #define SVPD_SUPPORTED_PAGES_HDR_LEN 4
1239 u_int8_t reserved;
1240 u_int8_t length; /* number of VPD entries */
1241 #define SVPD_SUPPORTED_PAGES_SIZE 251
1242 u_int8_t list[SVPD_SUPPORTED_PAGES_SIZE];
1243 };
1244
1245 /*
1246 * This structure is more suited to target operation, because the
1247 * number of supported pages is left to the user to allocate.
1248 */
1249 struct scsi_vpd_supported_pages
1250 {
1251 u_int8_t device;
1252 u_int8_t page_code;
1253 u_int8_t reserved;
1254 #define SVPD_SUPPORTED_PAGES 0x00
1255 u_int8_t length;
1256 u_int8_t page_list[0];
1257 };
1258
1259
1260 struct scsi_vpd_unit_serial_number
1261 {
1262 u_int8_t device;
1263 u_int8_t page_code;
1264 #define SVPD_UNIT_SERIAL_NUMBER 0x80
1265 u_int8_t reserved;
1266 u_int8_t length; /* serial number length */
1267 #define SVPD_SERIAL_NUM_SIZE 251
1268 u_int8_t serial_num[SVPD_SERIAL_NUM_SIZE];
1269 };
1270
1271 struct scsi_vpd_device_id
1272 {
1273 u_int8_t device;
1274 u_int8_t page_code;
1275 #define SVPD_DEVICE_ID 0x83
1276 #define SVPD_DEVICE_ID_MAX_SIZE 252
1277 #define SVPD_DEVICE_ID_HDR_LEN \
1278 __offsetof(struct scsi_vpd_device_id, desc_list)
1279 u_int8_t length[2];
1280 u_int8_t desc_list[];
1281 };
1282
1283 struct scsi_vpd_id_descriptor
1284 {
1285 u_int8_t proto_codeset;
1286 #define SCSI_PROTO_FC 0x00
1287 #define SCSI_PROTO_SPI 0x01
1288 #define SCSI_PROTO_SSA 0x02
1289 #define SCSI_PROTO_1394 0x03
1290 #define SCSI_PROTO_RDMA 0x04
1291 #define SCSI_PROTO_ISCSI 0x05
1292 #define SCSI_PROTO_SAS 0x06
1293 #define SCSI_PROTO_ADT 0x07
1294 #define SCSI_PROTO_ATA 0x08
1295 #define SVPD_ID_PROTO_SHIFT 4
1296 #define SVPD_ID_CODESET_BINARY 0x01
1297 #define SVPD_ID_CODESET_ASCII 0x02
1298 #define SVPD_ID_CODESET_UTF8 0x03
1299 #define SVPD_ID_CODESET_MASK 0x0f
1300 u_int8_t id_type;
1301 #define SVPD_ID_PIV 0x80
1302 #define SVPD_ID_ASSOC_LUN 0x00
1303 #define SVPD_ID_ASSOC_PORT 0x10
1304 #define SVPD_ID_ASSOC_TARGET 0x20
1305 #define SVPD_ID_ASSOC_MASK 0x30
1306 #define SVPD_ID_TYPE_VENDOR 0x00
1307 #define SVPD_ID_TYPE_T10 0x01
1308 #define SVPD_ID_TYPE_EUI64 0x02
1309 #define SVPD_ID_TYPE_NAA 0x03
1310 #define SVPD_ID_TYPE_RELTARG 0x04
1311 #define SVPD_ID_TYPE_TPORTGRP 0x05
1312 #define SVPD_ID_TYPE_LUNGRP 0x06
1313 #define SVPD_ID_TYPE_MD5_LUN_ID 0x07
1314 #define SVPD_ID_TYPE_SCSI_NAME 0x08
1315 #define SVPD_ID_TYPE_MASK 0x0f
1316 u_int8_t reserved;
1317 u_int8_t length;
1318 #define SVPD_DEVICE_ID_DESC_HDR_LEN \
1319 __offsetof(struct scsi_vpd_id_descriptor, identifier)
1320 u_int8_t identifier[];
1321 };
1322
1323 struct scsi_vpd_id_t10
1324 {
1325 u_int8_t vendor[8];
1326 u_int8_t vendor_spec_id[0];
1327 };
1328
1329 struct scsi_vpd_id_eui64
1330 {
1331 u_int8_t ieee_company_id[3];
1332 u_int8_t extension_id[5];
1333 };
1334
1335 struct scsi_vpd_id_naa_basic
1336 {
1337 uint8_t naa;
1338 /* big endian, packed:
1339 uint8_t naa : 4;
1340 uint8_t naa_desig : 4;
1341 */
1342 #define SVPD_ID_NAA_NAA_SHIFT 4
1343 #define SVPD_ID_NAA_IEEE_EXT 0x02
1344 #define SVPD_ID_NAA_LOCAL_REG 0x03
1345 #define SVPD_ID_NAA_IEEE_REG 0x05
1346 #define SVPD_ID_NAA_IEEE_REG_EXT 0x06
1347 uint8_t naa_data[];
1348 };
1349
1350 struct scsi_vpd_id_naa_ieee_extended_id
1351 {
1352 uint8_t naa;
1353 uint8_t vendor_specific_id_a;
1354 uint8_t ieee_company_id[3];
1355 uint8_t vendor_specific_id_b[4];
1356 };
1357
1358 struct scsi_vpd_id_naa_local_reg
1359 {
1360 uint8_t naa;
1361 uint8_t local_value[7];
1362 };
1363
1364 struct scsi_vpd_id_naa_ieee_reg
1365 {
1366 uint8_t naa;
1367 uint8_t reg_value[7];
1368 /* big endian, packed:
1369 uint8_t naa_basic : 4;
1370 uint8_t ieee_company_id_0 : 4;
1371 uint8_t ieee_company_id_1[2];
1372 uint8_t ieee_company_id_2 : 4;
1373 uint8_t vendor_specific_id_0 : 4;
1374 uint8_t vendor_specific_id_1[4];
1375 */
1376 };
1377
1378 struct scsi_vpd_id_naa_ieee_reg_extended
1379 {
1380 uint8_t naa;
1381 uint8_t reg_value[15];
1382 /* big endian, packed:
1383 uint8_t naa_basic : 4;
1384 uint8_t ieee_company_id_0 : 4;
1385 uint8_t ieee_company_id_1[2];
1386 uint8_t ieee_company_id_2 : 4;
1387 uint8_t vendor_specific_id_0 : 4;
1388 uint8_t vendor_specific_id_1[4];
1389 uint8_t vendor_specific_id_ext[8];
1390 */
1391 };
1392
1393 struct scsi_vpd_id_rel_trgt_port_id
1394 {
1395 uint8_t obsolete[2];
1396 uint8_t rel_trgt_port_id[2];
1397 };
1398
1399 struct scsi_vpd_id_trgt_port_grp_id
1400 {
1401 uint8_t reserved[2];
1402 uint8_t trgt_port_grp[2];
1403 };
1404
1405 struct scsi_vpd_id_lun_grp_id
1406 {
1407 uint8_t reserved[2];
1408 uint8_t log_unit_grp[2];
1409 };
1410
1411 struct scsi_vpd_id_md5_lun_id
1412 {
1413 uint8_t lun_id[16];
1414 };
1415
1416 struct scsi_vpd_id_scsi_name
1417 {
1418 uint8_t name_string[256];
1419 };
1420
1421 struct scsi_service_action_in
1422 {
1423 uint8_t opcode;
1424 uint8_t service_action;
1425 uint8_t action_dependent[13];
1426 uint8_t control;
1427 };
1428
1429 struct scsi_diag_page {
1430 uint8_t page_code;
1431 uint8_t page_specific_flags;
1432 uint8_t length[2];
1433 uint8_t params[0];
1434 };
1435
1436 /*
1437 * ATA Information VPD Page based on
1438 * T10/2126-D Revision 04
1439 */
1440 #define SVPD_ATA_INFORMATION 0x89
1441
1442 /*
1443 * Block Device Characteristics VPD Page based on
1444 * T10/1799-D Revision 31
1445 */
1446 struct scsi_vpd_block_characteristics
1447 {
1448 u_int8_t device;
1449 u_int8_t page_code;
1450 #define SVPD_BDC 0xB1
1451 u_int8_t page_length[2];
1452 u_int8_t medium_rotation_rate[2];
1453 #define SVPD_BDC_RATE_NOT_REPORTED 0x00
1454 #define SVPD_BDC_RATE_NONE_ROTATING 0x01
1455 u_int8_t reserved1;
1456 u_int8_t nominal_form_factor;
1457 #define SVPD_BDC_FORM_NOT_REPORTED 0x00
1458 #define SVPD_BDC_FORM_5_25INCH 0x01
1459 #define SVPD_BDC_FORM_3_5INCH 0x02
1460 #define SVPD_BDC_FORM_2_5INCH 0x03
1461 #define SVPD_BDC_FORM_1_5INCH 0x04
1462 #define SVPD_BDC_FORM_LESSTHAN_1_5INCH 0x05
1463 u_int8_t reserved2[56];
1464 };
1465
1466 /*
1467 * Logical Block Provisioning VPD Page based on
1468 * T10/1799-D Revision 31
1469 */
1470 struct scsi_vpd_logical_block_prov
1471 {
1472 u_int8_t device;
1473 u_int8_t page_code;
1474 #define SVPD_LBP 0xB2
1475 u_int8_t page_length[2];
1476 #define SVPD_LBP_PL_BASIC 0x04
1477 u_int8_t threshold_exponent;
1478 u_int8_t flags;
1479 #define SVPD_LBP_UNMAP 0x80
1480 #define SVPD_LBP_WS16 0x40
1481 #define SVPD_LBP_WS10 0x20
1482 #define SVPD_LBP_RZ 0x04
1483 #define SVPD_LBP_ANC_SUP 0x02
1484 #define SVPD_LBP_DP 0x01
1485 u_int8_t prov_type;
1486 #define SVPD_LBP_RESOURCE 0x01
1487 #define SVPD_LBP_THIN 0x02
1488 u_int8_t reserved;
1489 /*
1490 * Provisioning Group Descriptor can be here if SVPD_LBP_DP is set
1491 * Its size can be determined from page_length - 4
1492 */
1493 };
1494
1495 /*
1496 * Block Limits VDP Page based on
1497 * T10/1799-D Revision 31
1498 */
1499 struct scsi_vpd_block_limits
1500 {
1501 u_int8_t device;
1502 u_int8_t page_code;
1503 #define SVPD_BLOCK_LIMITS 0xB0
1504 u_int8_t page_length[2];
1505 #define SVPD_BL_PL_BASIC 0x10
1506 #define SVPD_BL_PL_TP 0x3C
1507 u_int8_t reserved1;
1508 u_int8_t max_cmp_write_len;
1509 u_int8_t opt_txfer_len_grain[2];
1510 u_int8_t max_txfer_len[4];
1511 u_int8_t opt_txfer_len[4];
1512 u_int8_t max_prefetch[4];
1513 u_int8_t max_unmap_lba_cnt[4];
1514 u_int8_t max_unmap_blk_cnt[4];
1515 u_int8_t opt_unmap_grain[4];
1516 u_int8_t unmap_grain_align[4];
1517 u_int8_t max_write_same_length[8];
1518 u_int8_t reserved2[20];
1519 };
1520
1521 struct scsi_read_capacity
1522 {
1523 u_int8_t opcode;
1524 u_int8_t byte2;
1525 #define SRC_RELADR 0x01
1526 u_int8_t addr[4];
1527 u_int8_t unused[2];
1528 u_int8_t pmi;
1529 #define SRC_PMI 0x01
1530 u_int8_t control;
1531 };
1532
1533 struct scsi_read_capacity_16
1534 {
1535 uint8_t opcode;
1536 #define SRC16_SERVICE_ACTION 0x10
1537 uint8_t service_action;
1538 uint8_t addr[8];
1539 uint8_t alloc_len[4];
1540 #define SRC16_PMI 0x01
1541 #define SRC16_RELADR 0x02
1542 uint8_t reladr;
1543 uint8_t control;
1544 };
1545
1546 struct scsi_read_capacity_data
1547 {
1548 u_int8_t addr[4];
1549 u_int8_t length[4];
1550 };
1551
1552 struct scsi_read_capacity_data_long
1553 {
1554 uint8_t addr[8];
1555 uint8_t length[4];
1556 #define SRC16_PROT_EN 0x01
1557 #define SRC16_P_TYPE 0x0e
1558 #define SRC16_PTYPE_1 0x00
1559 #define SRC16_PTYPE_2 0x02
1560 #define SRC16_PTYPE_3 0x04
1561 uint8_t prot;
1562 #define SRC16_LBPPBE 0x0f
1563 #define SRC16_PI_EXPONENT 0xf0
1564 #define SRC16_PI_EXPONENT_SHIFT 4
1565 uint8_t prot_lbppbe;
1566 #define SRC16_LALBA 0x3f
1567 #define SRC16_LBPRZ 0x40
1568 #define SRC16_LBPME 0x80
1569 /*
1570 * Alternate versions of these macros that are intended for use on a 16-bit
1571 * version of the lalba_lbp field instead of the array of 2 8 bit numbers.
1572 */
1573 #define SRC16_LALBA_A 0x3fff
1574 #define SRC16_LBPRZ_A 0x4000
1575 #define SRC16_LBPME_A 0x8000
1576 uint8_t lalba_lbp[2];
1577 uint8_t reserved[16];
1578 };
1579
1580 struct scsi_report_luns
1581 {
1582 uint8_t opcode;
1583 uint8_t reserved1;
1584 #define RPL_REPORT_DEFAULT 0x00
1585 #define RPL_REPORT_WELLKNOWN 0x01
1586 #define RPL_REPORT_ALL 0x02
1587 uint8_t select_report;
1588 uint8_t reserved2[3];
1589 uint8_t length[4];
1590 uint8_t reserved3;
1591 uint8_t control;
1592 };
1593
1594 struct scsi_report_luns_lundata {
1595 uint8_t lundata[8];
1596 #define RPL_LUNDATA_PERIPH_BUS_MASK 0x3f
1597 #define RPL_LUNDATA_FLAT_LUN_MASK 0x3f
1598 #define RPL_LUNDATA_FLAT_LUN_BITS 0x06
1599 #define RPL_LUNDATA_LUN_TARG_MASK 0x3f
1600 #define RPL_LUNDATA_LUN_BUS_MASK 0xe0
1601 #define RPL_LUNDATA_LUN_LUN_MASK 0x1f
1602 #define RPL_LUNDATA_EXT_LEN_MASK 0x30
1603 #define RPL_LUNDATA_EXT_EAM_MASK 0x0f
1604 #define RPL_LUNDATA_EXT_EAM_WK 0x01
1605 #define RPL_LUNDATA_EXT_EAM_NOT_SPEC 0x0f
1606 #define RPL_LUNDATA_ATYP_MASK 0xc0 /* MBZ for type 0 lun */
1607 #define RPL_LUNDATA_ATYP_PERIPH 0x00
1608 #define RPL_LUNDATA_ATYP_FLAT 0x40
1609 #define RPL_LUNDATA_ATYP_LUN 0x80
1610 #define RPL_LUNDATA_ATYP_EXTLUN 0xc0
1611 };
1612
1613 struct scsi_report_luns_data {
1614 u_int8_t length[4]; /* length of LUN inventory, in bytes */
1615 u_int8_t reserved[4]; /* unused */
1616 /*
1617 * LUN inventory- we only support the type zero form for now.
1618 */
1619 struct scsi_report_luns_lundata luns[0];
1620 };
1621
1622 struct scsi_target_group
1623 {
1624 uint8_t opcode;
1625 uint8_t service_action;
1626 #define STG_PDF_LENGTH 0x00
1627 #define RPL_PDF_EXTENDED 0x20
1628 uint8_t reserved1[4];
1629 uint8_t length[4];
1630 uint8_t reserved2;
1631 uint8_t control;
1632 };
1633
1634 struct scsi_target_port_descriptor {
1635 uint8_t reserved[2];
1636 uint8_t relative_target_port_identifier[2];
1637 uint8_t desc_list[];
1638 };
1639
1640 struct scsi_target_port_group_descriptor {
1641 uint8_t pref_state;
1642 #define TPG_PRIMARY 0x80
1643 #define TPG_ASYMMETRIC_ACCESS_STATE_MASK 0xf
1644 #define TPG_ASYMMETRIC_ACCESS_OPTIMIZED 0x0
1645 #define TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED 0x1
1646 #define TPG_ASYMMETRIC_ACCESS_STANDBY 0x2
1647 #define TPG_ASYMMETRIC_ACCESS_UNAVAILABLE 0x3
1648 #define TPG_ASYMMETRIC_ACCESS_LBA_DEPENDENT 0x4
1649 #define TPG_ASYMMETRIC_ACCESS_OFFLINE 0xE
1650 #define TPG_ASYMMETRIC_ACCESS_TRANSITIONING 0xF
1651 uint8_t support;
1652 #define TPG_AO_SUP 0x01
1653 #define TPG_AN_SUP 0x02
1654 #define TPG_S_SUP 0x04
1655 #define TPG_U_SUP 0x08
1656 #define TPG_LBD_SUP 0x10
1657 #define TPG_O_SUP 0x40
1658 #define TPG_T_SUP 0x80
1659 uint8_t target_port_group[2];
1660 uint8_t reserved;
1661 uint8_t status;
1662 #define TPG_UNAVLBL 0
1663 #define TPG_SET_BY_STPG 0x01
1664 #define TPG_IMPLICIT 0x02
1665 uint8_t vendor_specific;
1666 uint8_t target_port_count;
1667 struct scsi_target_port_descriptor descriptors[];
1668 };
1669
1670 struct scsi_target_group_data {
1671 uint8_t length[4]; /* length of returned data, in bytes */
1672 struct scsi_target_port_group_descriptor groups[];
1673 };
1674
1675 struct scsi_target_group_data_extended {
1676 uint8_t length[4]; /* length of returned data, in bytes */
1677 uint8_t format_type; /* STG_PDF_LENGTH or RPL_PDF_EXTENDED */
1678 uint8_t implicit_transition_time;
1679 uint8_t reserved[2];
1680 struct scsi_target_port_group_descriptor groups[];
1681 };
1682
1683
1684 typedef enum {
1685 SSD_TYPE_NONE,
1686 SSD_TYPE_FIXED,
1687 SSD_TYPE_DESC
1688 } scsi_sense_data_type;
1689
1690 typedef enum {
1691 SSD_ELEM_NONE,
1692 SSD_ELEM_SKIP,
1693 SSD_ELEM_DESC,
1694 SSD_ELEM_SKS,
1695 SSD_ELEM_COMMAND,
1696 SSD_ELEM_INFO,
1697 SSD_ELEM_FRU,
1698 SSD_ELEM_STREAM,
1699 SSD_ELEM_MAX
1700 } scsi_sense_elem_type;
1701
1702
1703 struct scsi_sense_data
1704 {
1705 uint8_t error_code;
1706 /*
1707 * SPC-4 says that the maximum length of sense data is 252 bytes.
1708 * So this structure is exactly 252 bytes log.
1709 */
1710 #define SSD_FULL_SIZE 252
1711 uint8_t sense_buf[SSD_FULL_SIZE - 1];
1712 /*
1713 * XXX KDM is this still a reasonable minimum size?
1714 */
1715 #define SSD_MIN_SIZE 18
1716 /*
1717 * Maximum value for the extra_len field in the sense data.
1718 */
1719 #define SSD_EXTRA_MAX 244
1720 };
1721
1722 /*
1723 * Fixed format sense data.
1724 */
1725 struct scsi_sense_data_fixed
1726 {
1727 u_int8_t error_code;
1728 #define SSD_ERRCODE 0x7F
1729 #define SSD_CURRENT_ERROR 0x70
1730 #define SSD_DEFERRED_ERROR 0x71
1731 #define SSD_ERRCODE_VALID 0x80
1732 u_int8_t segment;
1733 u_int8_t flags;
1734 #define SSD_KEY 0x0F
1735 #define SSD_KEY_NO_SENSE 0x00
1736 #define SSD_KEY_RECOVERED_ERROR 0x01
1737 #define SSD_KEY_NOT_READY 0x02
1738 #define SSD_KEY_MEDIUM_ERROR 0x03
1739 #define SSD_KEY_HARDWARE_ERROR 0x04
1740 #define SSD_KEY_ILLEGAL_REQUEST 0x05
1741 #define SSD_KEY_UNIT_ATTENTION 0x06
1742 #define SSD_KEY_DATA_PROTECT 0x07
1743 #define SSD_KEY_BLANK_CHECK 0x08
1744 #define SSD_KEY_Vendor_Specific 0x09
1745 #define SSD_KEY_COPY_ABORTED 0x0a
1746 #define SSD_KEY_ABORTED_COMMAND 0x0b
1747 #define SSD_KEY_EQUAL 0x0c
1748 #define SSD_KEY_VOLUME_OVERFLOW 0x0d
1749 #define SSD_KEY_MISCOMPARE 0x0e
1750 #define SSD_KEY_COMPLETED 0x0f
1751 #define SSD_ILI 0x20
1752 #define SSD_EOM 0x40
1753 #define SSD_FILEMARK 0x80
1754 u_int8_t info[4];
1755 u_int8_t extra_len;
1756 u_int8_t cmd_spec_info[4];
1757 u_int8_t add_sense_code;
1758 u_int8_t add_sense_code_qual;
1759 u_int8_t fru;
1760 u_int8_t sense_key_spec[3];
1761 #define SSD_SCS_VALID 0x80
1762 #define SSD_FIELDPTR_CMD 0x40
1763 #define SSD_BITPTR_VALID 0x08
1764 #define SSD_BITPTR_VALUE 0x07
1765 u_int8_t extra_bytes[14];
1766 #define SSD_FIXED_IS_PRESENT(sense, length, field) \
1767 ((length >= (offsetof(struct scsi_sense_data_fixed, field) + \
1768 sizeof(sense->field))) ? 1 :0)
1769 #define SSD_FIXED_IS_FILLED(sense, field) \
1770 ((((offsetof(struct scsi_sense_data_fixed, field) + \
1771 sizeof(sense->field)) - \
1772 (offsetof(struct scsi_sense_data_fixed, extra_len) + \
1773 sizeof(sense->extra_len))) <= sense->extra_len) ? 1 : 0)
1774 };
1775
1776 /*
1777 * Descriptor format sense data definitions.
1778 * Introduced in SPC-3.
1779 */
1780 struct scsi_sense_data_desc
1781 {
1782 uint8_t error_code;
1783 #define SSD_DESC_CURRENT_ERROR 0x72
1784 #define SSD_DESC_DEFERRED_ERROR 0x73
1785 uint8_t sense_key;
1786 uint8_t add_sense_code;
1787 uint8_t add_sense_code_qual;
1788 uint8_t reserved[3];
1789 /*
1790 * Note that SPC-4, section 4.5.2.1 says that the extra_len field
1791 * must be less than or equal to 244.
1792 */
1793 uint8_t extra_len;
1794 uint8_t sense_desc[0];
1795 #define SSD_DESC_IS_PRESENT(sense, length, field) \
1796 ((length >= (offsetof(struct scsi_sense_data_desc, field) + \
1797 sizeof(sense->field))) ? 1 :0)
1798 };
1799
1800 struct scsi_sense_desc_header
1801 {
1802 uint8_t desc_type;
1803 uint8_t length;
1804 };
1805 /*
1806 * The information provide in the Information descriptor is device type or
1807 * command specific information, and defined in a command standard.
1808 *
1809 * Note that any changes to the field names or positions in this structure,
1810 * even reserved fields, should be accompanied by an examination of the
1811 * code in ctl_set_sense() that uses them.
1812 *
1813 * Maximum descriptors allowed: 1 (as of SPC-4)
1814 */
1815 struct scsi_sense_info
1816 {
1817 uint8_t desc_type;
1818 #define SSD_DESC_INFO 0x00
1819 uint8_t length;
1820 uint8_t byte2;
1821 #define SSD_INFO_VALID 0x80
1822 uint8_t reserved;
1823 uint8_t info[8];
1824 };
1825
1826 /*
1827 * Command-specific information depends on the command for which the
1828 * reported condition occured.
1829 *
1830 * Note that any changes to the field names or positions in this structure,
1831 * even reserved fields, should be accompanied by an examination of the
1832 * code in ctl_set_sense() that uses them.
1833 *
1834 * Maximum descriptors allowed: 1 (as of SPC-4)
1835 */
1836 struct scsi_sense_command
1837 {
1838 uint8_t desc_type;
1839 #define SSD_DESC_COMMAND 0x01
1840 uint8_t length;
1841 uint8_t reserved[2];
1842 uint8_t command_info[8];
1843 };
1844
1845 /*
1846 * Sense key specific descriptor. The sense key specific data format
1847 * depends on the sense key in question.
1848 *
1849 * Maximum descriptors allowed: 1 (as of SPC-4)
1850 */
1851 struct scsi_sense_sks
1852 {
1853 uint8_t desc_type;
1854 #define SSD_DESC_SKS 0x02
1855 uint8_t length;
1856 uint8_t reserved1[2];
1857 uint8_t sense_key_spec[3];
1858 #define SSD_SKS_VALID 0x80
1859 uint8_t reserved2;
1860 };
1861
1862 /*
1863 * This is used for the Illegal Request sense key (0x05) only.
1864 */
1865 struct scsi_sense_sks_field
1866 {
1867 uint8_t byte0;
1868 #define SSD_SKS_FIELD_VALID 0x80
1869 #define SSD_SKS_FIELD_CMD 0x40
1870 #define SSD_SKS_BPV 0x08
1871 #define SSD_SKS_BIT_VALUE 0x07
1872 uint8_t field[2];
1873 };
1874
1875
1876 /*
1877 * This is used for the Hardware Error (0x04), Medium Error (0x03) and
1878 * Recovered Error (0x01) sense keys.
1879 */
1880 struct scsi_sense_sks_retry
1881 {
1882 uint8_t byte0;
1883 #define SSD_SKS_RETRY_VALID 0x80
1884 uint8_t actual_retry_count[2];
1885 };
1886
1887 /*
1888 * Used with the NO Sense (0x00) or Not Ready (0x02) sense keys.
1889 */
1890 struct scsi_sense_sks_progress
1891 {
1892 uint8_t byte0;
1893 #define SSD_SKS_PROGRESS_VALID 0x80
1894 uint8_t progress[2];
1895 #define SSD_SKS_PROGRESS_DENOM 0x10000
1896 };
1897
1898 /*
1899 * Used with the Copy Aborted (0x0a) sense key.
1900 */
1901 struct scsi_sense_sks_segment
1902 {
1903 uint8_t byte0;
1904 #define SSD_SKS_SEGMENT_VALID 0x80
1905 #define SSD_SKS_SEGMENT_SD 0x20
1906 #define SSD_SKS_SEGMENT_BPV 0x08
1907 #define SSD_SKS_SEGMENT_BITPTR 0x07
1908 uint8_t field[2];
1909 };
1910
1911 /*
1912 * Used with the Unit Attention (0x06) sense key.
1913 *
1914 * This is currently used to indicate that the unit attention condition
1915 * queue has overflowed (when the overflow bit is set).
1916 */
1917 struct scsi_sense_sks_overflow
1918 {
1919 uint8_t byte0;
1920 #define SSD_SKS_OVERFLOW_VALID 0x80
1921 #define SSD_SKS_OVERFLOW_SET 0x01
1922 uint8_t reserved[2];
1923 };
1924
1925 /*
1926 * This specifies which component is associated with the sense data. There
1927 * is no standard meaning for the fru value.
1928 *
1929 * Maximum descriptors allowed: 1 (as of SPC-4)
1930 */
1931 struct scsi_sense_fru
1932 {
1933 uint8_t desc_type;
1934 #define SSD_DESC_FRU 0x03
1935 uint8_t length;
1936 uint8_t reserved;
1937 uint8_t fru;
1938 };
1939
1940 /*
1941 * Used for Stream commands, defined in SSC-4.
1942 *
1943 * Maximum descriptors allowed: 1 (as of SPC-4)
1944 */
1945
1946 struct scsi_sense_stream
1947 {
1948 uint8_t desc_type;
1949 #define SSD_DESC_STREAM 0x04
1950 uint8_t length;
1951 uint8_t reserved;
1952 uint8_t byte3;
1953 #define SSD_DESC_STREAM_FM 0x80
1954 #define SSD_DESC_STREAM_EOM 0x40
1955 #define SSD_DESC_STREAM_ILI 0x20
1956 };
1957
1958 /*
1959 * Used for Block commands, defined in SBC-3.
1960 *
1961 * This is currently (as of SBC-3) only used for the Incorrect Length
1962 * Indication (ILI) bit, which says that the data length requested in the
1963 * READ LONG or WRITE LONG command did not match the length of the logical
1964 * block.
1965 *
1966 * Maximum descriptors allowed: 1 (as of SPC-4)
1967 */
1968 struct scsi_sense_block
1969 {
1970 uint8_t desc_type;
1971 #define SSD_DESC_BLOCK 0x05
1972 uint8_t length;
1973 uint8_t reserved;
1974 uint8_t byte3;
1975 #define SSD_DESC_BLOCK_ILI 0x20
1976 };
1977
1978 /*
1979 * Used for Object-Based Storage Devices (OSD-3).
1980 *
1981 * Maximum descriptors allowed: 1 (as of SPC-4)
1982 */
1983 struct scsi_sense_osd_objid
1984 {
1985 uint8_t desc_type;
1986 #define SSD_DESC_OSD_OBJID 0x06
1987 uint8_t length;
1988 uint8_t reserved[6];
1989 /*
1990 * XXX KDM provide the bit definitions here? There are a lot of
1991 * them, and we don't have an OSD driver yet.
1992 */
1993 uint8_t not_init_cmds[4];
1994 uint8_t completed_cmds[4];
1995 uint8_t partition_id[8];
1996 uint8_t object_id[8];
1997 };
1998
1999 /*
2000 * Used for Object-Based Storage Devices (OSD-3).
2001 *
2002 * Maximum descriptors allowed: 1 (as of SPC-4)
2003 */
2004 struct scsi_sense_osd_integrity
2005 {
2006 uint8_t desc_type;
2007 #define SSD_DESC_OSD_INTEGRITY 0x07
2008 uint8_t length;
2009 uint8_t integ_check_val[32];
2010 };
2011
2012 /*
2013 * Used for Object-Based Storage Devices (OSD-3).
2014 *
2015 * Maximum descriptors allowed: 1 (as of SPC-4)
2016 */
2017 struct scsi_sense_osd_attr_id
2018 {
2019 uint8_t desc_type;
2020 #define SSD_DESC_OSD_ATTR_ID 0x08
2021 uint8_t length;
2022 uint8_t reserved[2];
2023 uint8_t attr_desc[0];
2024 };
2025
2026 /*
2027 * Used with Sense keys No Sense (0x00) and Not Ready (0x02).
2028 *
2029 * Maximum descriptors allowed: 32 (as of SPC-4)
2030 */
2031 struct scsi_sense_progress
2032 {
2033 uint8_t desc_type;
2034 #define SSD_DESC_PROGRESS 0x0a
2035 uint8_t length;
2036 uint8_t sense_key;
2037 uint8_t add_sense_code;
2038 uint8_t add_sense_code_qual;
2039 uint8_t reserved;
2040 uint8_t progress[2];
2041 };
2042
2043 /*
2044 * This is typically forwarded as the result of an EXTENDED COPY command.
2045 *
2046 * Maximum descriptors allowed: 2 (as of SPC-4)
2047 */
2048 struct scsi_sense_forwarded
2049 {
2050 uint8_t desc_type;
2051 #define SSD_DESC_FORWARDED 0x0c
2052 uint8_t length;
2053 uint8_t byte2;
2054 #define SSD_FORWARDED_FSDT 0x80
2055 #define SSD_FORWARDED_SDS_MASK 0x0f
2056 #define SSD_FORWARDED_SDS_UNK 0x00
2057 #define SSD_FORWARDED_SDS_EXSRC 0x01
2058 #define SSD_FORWARDED_SDS_EXDST 0x02
2059 };
2060
2061 /*
2062 * Vendor-specific sense descriptor. The desc_type field will be in the
2063 * range bewteen MIN and MAX inclusive.
2064 */
2065 struct scsi_sense_vendor
2066 {
2067 uint8_t desc_type;
2068 #define SSD_DESC_VENDOR_MIN 0x80
2069 #define SSD_DESC_VENDOR_MAX 0xff
2070 uint8_t length;
2071 uint8_t data[0];
2072 };
2073
2074 struct scsi_mode_header_6
2075 {
2076 u_int8_t data_length; /* Sense data length */
2077 u_int8_t medium_type;
2078 u_int8_t dev_spec;
2079 u_int8_t blk_desc_len;
2080 };
2081
2082 struct scsi_mode_header_10
2083 {
2084 u_int8_t data_length[2];/* Sense data length */
2085 u_int8_t medium_type;
2086 u_int8_t dev_spec;
2087 u_int8_t unused[2];
2088 u_int8_t blk_desc_len[2];
2089 };
2090
2091 struct scsi_mode_page_header
2092 {
2093 u_int8_t page_code;
2094 #define SMPH_PS 0x80
2095 #define SMPH_SPF 0x40
2096 #define SMPH_PC_MASK 0x3f
2097 u_int8_t page_length;
2098 };
2099
2100 struct scsi_mode_page_header_sp
2101 {
2102 uint8_t page_code;
2103 uint8_t subpage;
2104 uint8_t page_length[2];
2105 };
2106
2107
2108 struct scsi_mode_blk_desc
2109 {
2110 u_int8_t density;
2111 u_int8_t nblocks[3];
2112 u_int8_t reserved;
2113 u_int8_t blklen[3];
2114 };
2115
2116 #define SCSI_DEFAULT_DENSITY 0x00 /* use 'default' density */
2117 #define SCSI_SAME_DENSITY 0x7f /* use 'same' density- >= SCSI-2 only */
2118
2119
2120 /*
2121 * Status Byte
2122 */
2123 #define SCSI_STATUS_OK 0x00
2124 #define SCSI_STATUS_CHECK_COND 0x02
2125 #define SCSI_STATUS_COND_MET 0x04
2126 #define SCSI_STATUS_BUSY 0x08
2127 #define SCSI_STATUS_INTERMED 0x10
2128 #define SCSI_STATUS_INTERMED_COND_MET 0x14
2129 #define SCSI_STATUS_RESERV_CONFLICT 0x18
2130 #define SCSI_STATUS_CMD_TERMINATED 0x22 /* Obsolete in SAM-2 */
2131 #define SCSI_STATUS_QUEUE_FULL 0x28
2132 #define SCSI_STATUS_ACA_ACTIVE 0x30
2133 #define SCSI_STATUS_TASK_ABORTED 0x40
2134
2135 struct scsi_inquiry_pattern {
2136 u_int8_t type;
2137 u_int8_t media_type;
2138 #define SIP_MEDIA_REMOVABLE 0x01
2139 #define SIP_MEDIA_FIXED 0x02
2140 const char *vendor;
2141 const char *product;
2142 const char *revision;
2143 };
2144
2145 struct scsi_static_inquiry_pattern {
2146 u_int8_t type;
2147 u_int8_t media_type;
2148 char vendor[SID_VENDOR_SIZE+1];
2149 char product[SID_PRODUCT_SIZE+1];
2150 char revision[SID_REVISION_SIZE+1];
2151 };
2152
2153 struct scsi_sense_quirk_entry {
2154 struct scsi_inquiry_pattern inq_pat;
2155 int num_sense_keys;
2156 int num_ascs;
2157 struct sense_key_table_entry *sense_key_info;
2158 struct asc_table_entry *asc_info;
2159 };
2160
2161 struct sense_key_table_entry {
2162 u_int8_t sense_key;
2163 u_int32_t action;
2164 const char *desc;
2165 };
2166
2167 struct asc_table_entry {
2168 u_int8_t asc;
2169 u_int8_t ascq;
2170 u_int32_t action;
2171 const char *desc;
2172 };
2173
2174 struct op_table_entry {
2175 u_int8_t opcode;
2176 u_int32_t opmask;
2177 const char *desc;
2178 };
2179
2180 struct scsi_op_quirk_entry {
2181 struct scsi_inquiry_pattern inq_pat;
2182 int num_ops;
2183 struct op_table_entry *op_table;
2184 };
2185
2186 typedef enum {
2187 SSS_FLAG_NONE = 0x00,
2188 SSS_FLAG_PRINT_COMMAND = 0x01
2189 } scsi_sense_string_flags;
2190
2191 struct ccb_scsiio;
2192 struct cam_periph;
2193 union ccb;
2194 #ifndef _KERNEL
2195 struct cam_device;
2196 #endif
2197
2198 extern const char *scsi_sense_key_text[];
2199
2200 struct sbuf;
2201
2202 __BEGIN_DECLS
2203 void scsi_sense_desc(int sense_key, int asc, int ascq,
2204 struct scsi_inquiry_data *inq_data,
2205 const char **sense_key_desc, const char **asc_desc);
2206 scsi_sense_action scsi_error_action(struct ccb_scsiio* csio,
2207 struct scsi_inquiry_data *inq_data,
2208 u_int32_t sense_flags);
2209 const char * scsi_status_string(struct ccb_scsiio *csio);
2210
2211 void scsi_desc_iterate(struct scsi_sense_data_desc *sense, u_int sense_len,
2212 int (*iter_func)(struct scsi_sense_data_desc *sense,
2213 u_int, struct scsi_sense_desc_header *,
2214 void *), void *arg);
2215 uint8_t *scsi_find_desc(struct scsi_sense_data_desc *sense, u_int sense_len,
2216 uint8_t desc_type);
2217 void scsi_set_sense_data(struct scsi_sense_data *sense_data,
2218 scsi_sense_data_type sense_format, int current_error,
2219 int sense_key, int asc, int ascq, ...) ;
2220 void scsi_set_sense_data_va(struct scsi_sense_data *sense_data,
2221 scsi_sense_data_type sense_format,
2222 int current_error, int sense_key, int asc,
2223 int ascq, va_list ap);
2224 int scsi_get_sense_info(struct scsi_sense_data *sense_data, u_int sense_len,
2225 uint8_t info_type, uint64_t *info,
2226 int64_t *signed_info);
2227 int scsi_get_sks(struct scsi_sense_data *sense_data, u_int sense_len,
2228 uint8_t *sks);
2229 int scsi_get_block_info(struct scsi_sense_data *sense_data, u_int sense_len,
2230 struct scsi_inquiry_data *inq_data,
2231 uint8_t *block_bits);
2232 int scsi_get_stream_info(struct scsi_sense_data *sense_data, u_int sense_len,
2233 struct scsi_inquiry_data *inq_data,
2234 uint8_t *stream_bits);
2235 void scsi_info_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len,
2236 struct scsi_inquiry_data *inq_data, uint64_t info);
2237 void scsi_command_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len,
2238 struct scsi_inquiry_data *inq_data, uint64_t csi);
2239 void scsi_progress_sbuf(struct sbuf *sb, uint16_t progress);
2240 int scsi_sks_sbuf(struct sbuf *sb, int sense_key, uint8_t *sks);
2241 void scsi_fru_sbuf(struct sbuf *sb, uint64_t fru);
2242 void scsi_stream_sbuf(struct sbuf *sb, uint8_t stream_bits, uint64_t info);
2243 void scsi_block_sbuf(struct sbuf *sb, uint8_t block_bits, uint64_t info);
2244 void scsi_sense_info_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2245 u_int sense_len, uint8_t *cdb, int cdb_len,
2246 struct scsi_inquiry_data *inq_data,
2247 struct scsi_sense_desc_header *header);
2248
2249 void scsi_sense_command_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2250 u_int sense_len, uint8_t *cdb, int cdb_len,
2251 struct scsi_inquiry_data *inq_data,
2252 struct scsi_sense_desc_header *header);
2253 void scsi_sense_sks_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2254 u_int sense_len, uint8_t *cdb, int cdb_len,
2255 struct scsi_inquiry_data *inq_data,
2256 struct scsi_sense_desc_header *header);
2257 void scsi_sense_fru_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2258 u_int sense_len, uint8_t *cdb, int cdb_len,
2259 struct scsi_inquiry_data *inq_data,
2260 struct scsi_sense_desc_header *header);
2261 void scsi_sense_stream_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2262 u_int sense_len, uint8_t *cdb, int cdb_len,
2263 struct scsi_inquiry_data *inq_data,
2264 struct scsi_sense_desc_header *header);
2265 void scsi_sense_block_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2266 u_int sense_len, uint8_t *cdb, int cdb_len,
2267 struct scsi_inquiry_data *inq_data,
2268 struct scsi_sense_desc_header *header);
2269 void scsi_sense_progress_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2270 u_int sense_len, uint8_t *cdb, int cdb_len,
2271 struct scsi_inquiry_data *inq_data,
2272 struct scsi_sense_desc_header *header);
2273 void scsi_sense_generic_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2274 u_int sense_len, uint8_t *cdb, int cdb_len,
2275 struct scsi_inquiry_data *inq_data,
2276 struct scsi_sense_desc_header *header);
2277 void scsi_sense_desc_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2278 u_int sense_len, uint8_t *cdb, int cdb_len,
2279 struct scsi_inquiry_data *inq_data,
2280 struct scsi_sense_desc_header *header);
2281 scsi_sense_data_type scsi_sense_type(struct scsi_sense_data *sense_data);
2282
2283 void scsi_sense_only_sbuf(struct scsi_sense_data *sense, u_int sense_len,
2284 struct sbuf *sb, char *path_str,
2285 struct scsi_inquiry_data *inq_data, uint8_t *cdb,
2286 int cdb_len);
2287
2288 #ifdef _KERNEL
2289 int scsi_command_string(struct ccb_scsiio *csio, struct sbuf *sb);
2290 int scsi_sense_sbuf(struct ccb_scsiio *csio, struct sbuf *sb,
2291 scsi_sense_string_flags flags);
2292 char * scsi_sense_string(struct ccb_scsiio *csio,
2293 char *str, int str_len);
2294 void scsi_sense_print(struct ccb_scsiio *csio);
2295 int scsi_vpd_supported_page(struct cam_periph *periph,
2296 uint8_t page_id);
2297 #else /* _KERNEL */
2298 int scsi_command_string(struct cam_device *device,
2299 struct ccb_scsiio *csio, struct sbuf *sb);
2300 int scsi_sense_sbuf(struct cam_device *device,
2301 struct ccb_scsiio *csio, struct sbuf *sb,
2302 scsi_sense_string_flags flags);
2303 char * scsi_sense_string(struct cam_device *device,
2304 struct ccb_scsiio *csio,
2305 char *str, int str_len);
2306 void scsi_sense_print(struct cam_device *device,
2307 struct ccb_scsiio *csio, FILE *ofile);
2308 #endif /* _KERNEL */
2309
2310 const char * scsi_op_desc(u_int16_t opcode,
2311 struct scsi_inquiry_data *inq_data);
2312 char * scsi_cdb_string(u_int8_t *cdb_ptr, char *cdb_string,
2313 size_t len);
2314
2315 void scsi_print_inquiry(struct scsi_inquiry_data *inq_data);
2316 void scsi_print_inquiry_short(struct scsi_inquiry_data *inq_data);
2317
2318 u_int scsi_calc_syncsrate(u_int period_factor);
2319 u_int scsi_calc_syncparam(u_int period);
2320
2321 typedef int (*scsi_devid_checkfn_t)(uint8_t *);
2322 int scsi_devid_is_naa_ieee_reg(uint8_t *bufp);
2323 int scsi_devid_is_sas_target(uint8_t *bufp);
2324 int scsi_devid_is_lun_eui64(uint8_t *bufp);
2325 int scsi_devid_is_lun_naa(uint8_t *bufp);
2326 int scsi_devid_is_lun_name(uint8_t *bufp);
2327 int scsi_devid_is_lun_t10(uint8_t *bufp);
2328 struct scsi_vpd_id_descriptor *
2329 scsi_get_devid(struct scsi_vpd_device_id *id, uint32_t len,
2330 scsi_devid_checkfn_t ck_fn);
2331
2332 void scsi_test_unit_ready(struct ccb_scsiio *csio, u_int32_t retries,
2333 void (*cbfcnp)(struct cam_periph *,
2334 union ccb *),
2335 u_int8_t tag_action,
2336 u_int8_t sense_len, u_int32_t timeout);
2337
2338 void scsi_request_sense(struct ccb_scsiio *csio, u_int32_t retries,
2339 void (*cbfcnp)(struct cam_periph *,
2340 union ccb *),
2341 void *data_ptr, u_int8_t dxfer_len,
2342 u_int8_t tag_action, u_int8_t sense_len,
2343 u_int32_t timeout);
2344
2345 void scsi_inquiry(struct ccb_scsiio *csio, u_int32_t retries,
2346 void (*cbfcnp)(struct cam_periph *, union ccb *),
2347 u_int8_t tag_action, u_int8_t *inq_buf,
2348 u_int32_t inq_len, int evpd, u_int8_t page_code,
2349 u_int8_t sense_len, u_int32_t timeout);
2350
2351 void scsi_mode_sense(struct ccb_scsiio *csio, u_int32_t retries,
2352 void (*cbfcnp)(struct cam_periph *,
2353 union ccb *),
2354 u_int8_t tag_action, int dbd,
2355 u_int8_t page_code, u_int8_t page,
2356 u_int8_t *param_buf, u_int32_t param_len,
2357 u_int8_t sense_len, u_int32_t timeout);
2358
2359 void scsi_mode_sense_len(struct ccb_scsiio *csio, u_int32_t retries,
2360 void (*cbfcnp)(struct cam_periph *,
2361 union ccb *),
2362 u_int8_t tag_action, int dbd,
2363 u_int8_t page_code, u_int8_t page,
2364 u_int8_t *param_buf, u_int32_t param_len,
2365 int minimum_cmd_size, u_int8_t sense_len,
2366 u_int32_t timeout);
2367
2368 void scsi_mode_select(struct ccb_scsiio *csio, u_int32_t retries,
2369 void (*cbfcnp)(struct cam_periph *,
2370 union ccb *),
2371 u_int8_t tag_action, int scsi_page_fmt,
2372 int save_pages, u_int8_t *param_buf,
2373 u_int32_t param_len, u_int8_t sense_len,
2374 u_int32_t timeout);
2375
2376 void scsi_mode_select_len(struct ccb_scsiio *csio, u_int32_t retries,
2377 void (*cbfcnp)(struct cam_periph *,
2378 union ccb *),
2379 u_int8_t tag_action, int scsi_page_fmt,
2380 int save_pages, u_int8_t *param_buf,
2381 u_int32_t param_len, int minimum_cmd_size,
2382 u_int8_t sense_len, u_int32_t timeout);
2383
2384 void scsi_log_sense(struct ccb_scsiio *csio, u_int32_t retries,
2385 void (*cbfcnp)(struct cam_periph *, union ccb *),
2386 u_int8_t tag_action, u_int8_t page_code,
2387 u_int8_t page, int save_pages, int ppc,
2388 u_int32_t paramptr, u_int8_t *param_buf,
2389 u_int32_t param_len, u_int8_t sense_len,
2390 u_int32_t timeout);
2391
2392 void scsi_log_select(struct ccb_scsiio *csio, u_int32_t retries,
2393 void (*cbfcnp)(struct cam_periph *,
2394 union ccb *), u_int8_t tag_action,
2395 u_int8_t page_code, int save_pages,
2396 int pc_reset, u_int8_t *param_buf,
2397 u_int32_t param_len, u_int8_t sense_len,
2398 u_int32_t timeout);
2399
2400 void scsi_prevent(struct ccb_scsiio *csio, u_int32_t retries,
2401 void (*cbfcnp)(struct cam_periph *, union ccb *),
2402 u_int8_t tag_action, u_int8_t action,
2403 u_int8_t sense_len, u_int32_t timeout);
2404
2405 void scsi_read_capacity(struct ccb_scsiio *csio, u_int32_t retries,
2406 void (*cbfcnp)(struct cam_periph *,
2407 union ccb *), u_int8_t tag_action,
2408 struct scsi_read_capacity_data *,
2409 u_int8_t sense_len, u_int32_t timeout);
2410 void scsi_read_capacity_16(struct ccb_scsiio *csio, uint32_t retries,
2411 void (*cbfcnp)(struct cam_periph *,
2412 union ccb *), uint8_t tag_action,
2413 uint64_t lba, int reladr, int pmi,
2414 uint8_t *rcap_buf, int rcap_buf_len,
2415 uint8_t sense_len, uint32_t timeout);
2416
2417 void scsi_report_luns(struct ccb_scsiio *csio, u_int32_t retries,
2418 void (*cbfcnp)(struct cam_periph *,
2419 union ccb *), u_int8_t tag_action,
2420 u_int8_t select_report,
2421 struct scsi_report_luns_data *rpl_buf,
2422 u_int32_t alloc_len, u_int8_t sense_len,
2423 u_int32_t timeout);
2424
2425 void scsi_report_target_group(struct ccb_scsiio *csio, u_int32_t retries,
2426 void (*cbfcnp)(struct cam_periph *,
2427 union ccb *), u_int8_t tag_action,
2428 u_int8_t pdf,
2429 void *buf,
2430 u_int32_t alloc_len, u_int8_t sense_len,
2431 u_int32_t timeout);
2432
2433 void scsi_set_target_group(struct ccb_scsiio *csio, u_int32_t retries,
2434 void (*cbfcnp)(struct cam_periph *,
2435 union ccb *), u_int8_t tag_action, void *buf,
2436 u_int32_t alloc_len, u_int8_t sense_len,
2437 u_int32_t timeout);
2438
2439 void scsi_synchronize_cache(struct ccb_scsiio *csio,
2440 u_int32_t retries,
2441 void (*cbfcnp)(struct cam_periph *,
2442 union ccb *), u_int8_t tag_action,
2443 u_int32_t begin_lba, u_int16_t lb_count,
2444 u_int8_t sense_len, u_int32_t timeout);
2445
2446 void scsi_receive_diagnostic_results(struct ccb_scsiio *csio, u_int32_t retries,
2447 void (*cbfcnp)(struct cam_periph *,
2448 union ccb*),
2449 uint8_t tag_action, int pcv,
2450 uint8_t page_code, uint8_t *data_ptr,
2451 uint16_t allocation_length,
2452 uint8_t sense_len, uint32_t timeout);
2453
2454 void scsi_send_diagnostic(struct ccb_scsiio *csio, u_int32_t retries,
2455 void (*cbfcnp)(struct cam_periph *, union ccb *),
2456 uint8_t tag_action, int unit_offline,
2457 int device_offline, int self_test, int page_format,
2458 int self_test_code, uint8_t *data_ptr,
2459 uint16_t param_list_length, uint8_t sense_len,
2460 uint32_t timeout);
2461
2462 void scsi_read_buffer(struct ccb_scsiio *csio, u_int32_t retries,
2463 void (*cbfcnp)(struct cam_periph *, union ccb*),
2464 uint8_t tag_action, int mode,
2465 uint8_t buffer_id, u_int32_t offset,
2466 uint8_t *data_ptr, uint32_t allocation_length,
2467 uint8_t sense_len, uint32_t timeout);
2468
2469 void scsi_write_buffer(struct ccb_scsiio *csio, u_int32_t retries,
2470 void (*cbfcnp)(struct cam_periph *, union ccb *),
2471 uint8_t tag_action, int mode,
2472 uint8_t buffer_id, u_int32_t offset,
2473 uint8_t *data_ptr, uint32_t param_list_length,
2474 uint8_t sense_len, uint32_t timeout);
2475
2476 #define SCSI_RW_READ 0x0001
2477 #define SCSI_RW_WRITE 0x0002
2478 #define SCSI_RW_DIRMASK 0x0003
2479 #define SCSI_RW_BIO 0x1000
2480 void scsi_read_write(struct ccb_scsiio *csio, u_int32_t retries,
2481 void (*cbfcnp)(struct cam_periph *, union ccb *),
2482 u_int8_t tag_action, int readop, u_int8_t byte2,
2483 int minimum_cmd_size, u_int64_t lba,
2484 u_int32_t block_count, u_int8_t *data_ptr,
2485 u_int32_t dxfer_len, u_int8_t sense_len,
2486 u_int32_t timeout);
2487
2488 void scsi_write_same(struct ccb_scsiio *csio, u_int32_t retries,
2489 void (*cbfcnp)(struct cam_periph *, union ccb *),
2490 u_int8_t tag_action, u_int8_t byte2,
2491 int minimum_cmd_size, u_int64_t lba,
2492 u_int32_t block_count, u_int8_t *data_ptr,
2493 u_int32_t dxfer_len, u_int8_t sense_len,
2494 u_int32_t timeout);
2495
2496 void scsi_ata_identify(struct ccb_scsiio *csio, u_int32_t retries,
2497 void (*cbfcnp)(struct cam_periph *, union ccb *),
2498 u_int8_t tag_action, u_int8_t *data_ptr,
2499 u_int16_t dxfer_len, u_int8_t sense_len,
2500 u_int32_t timeout);
2501
2502 void scsi_ata_trim(struct ccb_scsiio *csio, u_int32_t retries,
2503 void (*cbfcnp)(struct cam_periph *, union ccb *),
2504 u_int8_t tag_action, u_int16_t block_count,
2505 u_int8_t *data_ptr, u_int16_t dxfer_len,
2506 u_int8_t sense_len, u_int32_t timeout);
2507
2508 void scsi_ata_pass_16(struct ccb_scsiio *csio, u_int32_t retries,
2509 void (*cbfcnp)(struct cam_periph *, union ccb *),
2510 u_int32_t flags, u_int8_t tag_action,
2511 u_int8_t protocol, u_int8_t ata_flags, u_int16_t features,
2512 u_int16_t sector_count, uint64_t lba, u_int8_t command,
2513 u_int8_t control, u_int8_t *data_ptr, u_int16_t dxfer_len,
2514 u_int8_t sense_len, u_int32_t timeout);
2515
2516 void scsi_unmap(struct ccb_scsiio *csio, u_int32_t retries,
2517 void (*cbfcnp)(struct cam_periph *, union ccb *),
2518 u_int8_t tag_action, u_int8_t byte2,
2519 u_int8_t *data_ptr, u_int16_t dxfer_len,
2520 u_int8_t sense_len, u_int32_t timeout);
2521
2522 void scsi_start_stop(struct ccb_scsiio *csio, u_int32_t retries,
2523 void (*cbfcnp)(struct cam_periph *, union ccb *),
2524 u_int8_t tag_action, int start, int load_eject,
2525 int immediate, u_int8_t sense_len, u_int32_t timeout);
2526
2527 int scsi_inquiry_match(caddr_t inqbuffer, caddr_t table_entry);
2528 int scsi_static_inquiry_match(caddr_t inqbuffer,
2529 caddr_t table_entry);
2530 int scsi_devid_match(uint8_t *rhs, size_t rhs_len,
2531 uint8_t *lhs, size_t lhs_len);
2532
2533 void scsi_extract_sense(struct scsi_sense_data *sense, int *error_code,
2534 int *sense_key, int *asc, int *ascq);
2535 int scsi_extract_sense_ccb(union ccb *ccb, int *error_code, int *sense_key,
2536 int *asc, int *ascq);
2537 void scsi_extract_sense_len(struct scsi_sense_data *sense,
2538 u_int sense_len, int *error_code, int *sense_key,
2539 int *asc, int *ascq, int show_errors);
2540 int scsi_get_sense_key(struct scsi_sense_data *sense, u_int sense_len,
2541 int show_errors);
2542 int scsi_get_asc(struct scsi_sense_data *sense, u_int sense_len,
2543 int show_errors);
2544 int scsi_get_ascq(struct scsi_sense_data *sense, u_int sense_len,
2545 int show_errors);
2546 static __inline void scsi_ulto2b(u_int32_t val, u_int8_t *bytes);
2547 static __inline void scsi_ulto3b(u_int32_t val, u_int8_t *bytes);
2548 static __inline void scsi_ulto4b(u_int32_t val, u_int8_t *bytes);
2549 static __inline void scsi_u64to8b(u_int64_t val, u_int8_t *bytes);
2550 static __inline uint32_t scsi_2btoul(const uint8_t *bytes);
2551 static __inline uint32_t scsi_3btoul(const uint8_t *bytes);
2552 static __inline int32_t scsi_3btol(const uint8_t *bytes);
2553 static __inline uint32_t scsi_4btoul(const uint8_t *bytes);
2554 static __inline uint64_t scsi_8btou64(const uint8_t *bytes);
2555 static __inline void *find_mode_page_6(struct scsi_mode_header_6 *mode_header);
2556 static __inline void *find_mode_page_10(struct scsi_mode_header_10 *mode_header);
2557
2558 static __inline void
2559 scsi_ulto2b(u_int32_t val, u_int8_t *bytes)
2560 {
2561
2562 bytes[0] = (val >> 8) & 0xff;
2563 bytes[1] = val & 0xff;
2564 }
2565
2566 static __inline void
2567 scsi_ulto3b(u_int32_t val, u_int8_t *bytes)
2568 {
2569
2570 bytes[0] = (val >> 16) & 0xff;
2571 bytes[1] = (val >> 8) & 0xff;
2572 bytes[2] = val & 0xff;
2573 }
2574
2575 static __inline void
2576 scsi_ulto4b(u_int32_t val, u_int8_t *bytes)
2577 {
2578
2579 bytes[0] = (val >> 24) & 0xff;
2580 bytes[1] = (val >> 16) & 0xff;
2581 bytes[2] = (val >> 8) & 0xff;
2582 bytes[3] = val & 0xff;
2583 }
2584
2585 static __inline void
2586 scsi_u64to8b(u_int64_t val, u_int8_t *bytes)
2587 {
2588
2589 bytes[0] = (val >> 56) & 0xff;
2590 bytes[1] = (val >> 48) & 0xff;
2591 bytes[2] = (val >> 40) & 0xff;
2592 bytes[3] = (val >> 32) & 0xff;
2593 bytes[4] = (val >> 24) & 0xff;
2594 bytes[5] = (val >> 16) & 0xff;
2595 bytes[6] = (val >> 8) & 0xff;
2596 bytes[7] = val & 0xff;
2597 }
2598
2599 static __inline uint32_t
2600 scsi_2btoul(const uint8_t *bytes)
2601 {
2602 uint32_t rv;
2603
2604 rv = (bytes[0] << 8) |
2605 bytes[1];
2606 return (rv);
2607 }
2608
2609 static __inline uint32_t
2610 scsi_3btoul(const uint8_t *bytes)
2611 {
2612 uint32_t rv;
2613
2614 rv = (bytes[0] << 16) |
2615 (bytes[1] << 8) |
2616 bytes[2];
2617 return (rv);
2618 }
2619
2620 static __inline int32_t
2621 scsi_3btol(const uint8_t *bytes)
2622 {
2623 uint32_t rc = scsi_3btoul(bytes);
2624
2625 if (rc & 0x00800000)
2626 rc |= 0xff000000;
2627
2628 return (int32_t) rc;
2629 }
2630
2631 static __inline uint32_t
2632 scsi_4btoul(const uint8_t *bytes)
2633 {
2634 uint32_t rv;
2635
2636 rv = (bytes[0] << 24) |
2637 (bytes[1] << 16) |
2638 (bytes[2] << 8) |
2639 bytes[3];
2640 return (rv);
2641 }
2642
2643 static __inline uint64_t
2644 scsi_8btou64(const uint8_t *bytes)
2645 {
2646 uint64_t rv;
2647
2648 rv = (((uint64_t)bytes[0]) << 56) |
2649 (((uint64_t)bytes[1]) << 48) |
2650 (((uint64_t)bytes[2]) << 40) |
2651 (((uint64_t)bytes[3]) << 32) |
2652 (((uint64_t)bytes[4]) << 24) |
2653 (((uint64_t)bytes[5]) << 16) |
2654 (((uint64_t)bytes[6]) << 8) |
2655 bytes[7];
2656 return (rv);
2657 }
2658
2659 /*
2660 * Given the pointer to a returned mode sense buffer, return a pointer to
2661 * the start of the first mode page.
2662 */
2663 static __inline void *
2664 find_mode_page_6(struct scsi_mode_header_6 *mode_header)
2665 {
2666 void *page_start;
2667
2668 page_start = (void *)((u_int8_t *)&mode_header[1] +
2669 mode_header->blk_desc_len);
2670
2671 return(page_start);
2672 }
2673
2674 static __inline void *
2675 find_mode_page_10(struct scsi_mode_header_10 *mode_header)
2676 {
2677 void *page_start;
2678
2679 page_start = (void *)((u_int8_t *)&mode_header[1] +
2680 scsi_2btoul(mode_header->blk_desc_len));
2681
2682 return(page_start);
2683 }
2684
2685 __END_DECLS
2686
2687 #endif /*_SCSI_SCSI_ALL_H*/
Cache object: 712a430a6c87fbd9bdb8c5dd4ed2f881
|