xref: /dragonfly/sys/bus/cam/scsi/scsi_all.h (revision 36a3d1d6)
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: src/sys/cam/scsi/scsi_all.h,v 1.31 2008/08/07 17:25:05 jkim Exp $
18  * $DragonFly: src/sys/bus/cam/scsi/scsi_all.h,v 1.15 2008/08/23 22:27:27 pavalos Exp $
19  */
20 
21 /*
22  * SCSI general  interface description
23  */
24 
25 #ifndef	_SCSI_SCSI_ALL_H
26 #define _SCSI_SCSI_ALL_H 1
27 
28 #ifndef _SYS_CDEFS_H_
29 #include <sys/cdefs.h>
30 #endif
31 #if !defined(_KERNEL) && !defined(_STDIO_H_)
32 #include <stdio.h>	/* FILE for userland protos */
33 #endif
34 
35 #ifdef _KERNEL
36 /*
37  * This is the number of milliseconds we wait for devices to settle after a SCSI
38  * bus reset.
39  */
40 extern int scsi_delay;
41 #endif /* _KERNEL */
42 
43 /*
44  * SCSI command format
45  */
46 
47 /*
48  * Define dome bits that are in ALL (or a lot of) scsi commands
49  */
50 #define SCSI_CTL_LINK		0x01
51 #define SCSI_CTL_FLAG		0x02
52 #define SCSI_CTL_VENDOR		0xC0
53 #define	SCSI_CMD_LUN		0xA0	/* these two should not be needed */
54 #define	SCSI_CMD_LUN_SHIFT	5	/* LUN in the cmd is no longer SCSI */
55 
56 #define SCSI_MAX_CDBLEN		16	/*
57 					 * 16 byte commands are in the
58 					 * SCSI-3 spec
59 					 */
60 #if defined(CAM_MAX_CDBLEN) && (CAM_MAX_CDBLEN < SCSI_MAX_CDBLEN)
61 #error "CAM_MAX_CDBLEN cannot be less than SCSI_MAX_CDBLEN"
62 #endif
63 
64 /* 6byte CDBs special case 0 length to be 256 */
65 #define SCSI_CDB6_LEN(len)	((len) == 0 ? 256 : len)
66 
67 /*
68  * This type defines actions to be taken when a particular sense code is
69  * received.  Right now, these flags are only defined to take up 16 bits,
70  * but can be expanded in the future if necessary.
71  */
72 typedef enum {
73 	SS_NOP      = 0x000000,	/* Do nothing */
74 	SS_RETRY    = 0x010000,	/* Retry the command */
75 	SS_FAIL     = 0x020000,	/* Bail out */
76 	SS_START    = 0x030000,	/* Send a Start Unit command to the device,
77 				 * then retry the original command.
78 				 */
79 	SS_TUR      = 0x040000,	/* Send a Test Unit Ready command to the
80 				 * device, then retry the original command.
81 				 */
82 	SS_REQSENSE = 0x050000,	/* Send a RequestSense command to the
83 				 * device, then retry the original command.
84 				 */
85 	SS_MASK     = 0xff0000
86 } scsi_sense_action;
87 
88 typedef enum {
89 	SSQ_NONE		= 0x0000,
90 	SSQ_DECREMENT_COUNT	= 0x0100,  /* Decrement the retry count */
91 	SSQ_MANY		= 0x0200,  /* send lots of recovery commands */
92 	SSQ_RANGE		= 0x0400,  /*
93 					    * This table entry represents the
94 					    * end of a range of ASCQs that
95 					    * have identical error actions
96 					    * and text.
97 					    */
98 	SSQ_PRINT_SENSE		= 0x0800,
99 	SSQ_MASK		= 0xff00
100 } scsi_sense_action_qualifier;
101 
102 /* Mask for error status values */
103 #define SS_ERRMASK	0xff
104 
105 /* The default, retyable, error action */
106 #define SS_RDEF		SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE|EIO
107 
108 /* The retyable, error action, with table specified error code */
109 #define SS_RET		SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE
110 
111 /* Fatal error action, with table specified error code */
112 #define SS_FATAL	SS_FAIL|SSQ_PRINT_SENSE
113 
114 struct scsi_generic
115 {
116 	u_int8_t opcode;
117 	u_int8_t bytes[11];
118 };
119 
120 struct scsi_request_sense
121 {
122 	u_int8_t opcode;
123 	u_int8_t byte2;
124 	u_int8_t unused[2];
125 	u_int8_t length;
126 	u_int8_t control;
127 };
128 
129 struct scsi_test_unit_ready
130 {
131 	u_int8_t opcode;
132 	u_int8_t byte2;
133 	u_int8_t unused[3];
134 	u_int8_t control;
135 };
136 
137 struct scsi_send_diag
138 {
139 	u_int8_t opcode;
140 	u_int8_t byte2;
141 #define	SSD_UOL		0x01
142 #define	SSD_DOL		0x02
143 #define	SSD_SELFTEST	0x04
144 #define	SSD_PF		0x10
145 	u_int8_t unused[1];
146 	u_int8_t paramlen[2];
147 	u_int8_t control;
148 };
149 
150 struct scsi_sense
151 {
152 	u_int8_t opcode;
153 	u_int8_t byte2;
154 	u_int8_t unused[2];
155 	u_int8_t length;
156 	u_int8_t control;
157 };
158 
159 struct scsi_inquiry
160 {
161 	u_int8_t opcode;
162 	u_int8_t byte2;
163 #define	SI_EVPD 0x01
164 	u_int8_t page_code;
165 	u_int8_t reserved;
166 	u_int8_t length;
167 	u_int8_t control;
168 };
169 
170 struct scsi_mode_sense_6
171 {
172 	u_int8_t opcode;
173 	u_int8_t byte2;
174 #define	SMS_DBD				0x08
175 	u_int8_t page;
176 #define	SMS_PAGE_CODE 			0x3F
177 #define SMS_VENDOR_SPECIFIC_PAGE	0x00
178 #define SMS_DISCONNECT_RECONNECT_PAGE	0x02
179 #define SMS_CACHE_PAGE			0x08
180 #define SMS_PERIPHERAL_DEVICE_PAGE	0x09
181 #define SMS_CONTROL_MODE_PAGE		0x0A
182 #define SMS_PROTO_SPECIFIC_PAGE		0x19
183 #define SMS_INFO_EXCEPTIONS_PAGE	0x1C
184 #define SMS_ALL_PAGES_PAGE		0x3F
185 #define	SMS_PAGE_CTRL_MASK		0xC0
186 #define	SMS_PAGE_CTRL_CURRENT 		0x00
187 #define	SMS_PAGE_CTRL_CHANGEABLE 	0x40
188 #define	SMS_PAGE_CTRL_DEFAULT 		0x80
189 #define	SMS_PAGE_CTRL_SAVED 		0xC0
190 	u_int8_t unused;
191 	u_int8_t length;
192 	u_int8_t control;
193 };
194 
195 struct scsi_mode_sense_10
196 {
197 	u_int8_t opcode;
198 	u_int8_t byte2;		/* same bits as small version */
199 	u_int8_t page; 		/* same bits as small version */
200 	u_int8_t unused[4];
201 	u_int8_t length[2];
202 	u_int8_t control;
203 };
204 
205 struct scsi_mode_select_6
206 {
207 	u_int8_t opcode;
208 	u_int8_t byte2;
209 #define	SMS_SP	0x01
210 #define	SMS_PF	0x10
211 	u_int8_t unused[2];
212 	u_int8_t length;
213 	u_int8_t control;
214 };
215 
216 struct scsi_mode_select_10
217 {
218 	u_int8_t opcode;
219 	u_int8_t byte2;		/* same bits as small version */
220 	u_int8_t unused[5];
221 	u_int8_t length[2];
222 	u_int8_t control;
223 };
224 
225 /*
226  * When sending a mode select to a tape drive, the medium type must be 0.
227  */
228 struct scsi_mode_hdr_6
229 {
230 	u_int8_t datalen;
231 	u_int8_t medium_type;
232 	u_int8_t dev_specific;
233 	u_int8_t block_descr_len;
234 };
235 
236 struct scsi_mode_hdr_10
237 {
238 	u_int8_t datalen[2];
239 	u_int8_t medium_type;
240 	u_int8_t dev_specific;
241 	u_int8_t reserved[2];
242 	u_int8_t block_descr_len[2];
243 };
244 
245 struct scsi_mode_block_descr
246 {
247 	u_int8_t density_code;
248 	u_int8_t num_blocks[3];
249 	u_int8_t reserved;
250 	u_int8_t block_len[3];
251 };
252 
253 struct scsi_log_sense
254 {
255 	u_int8_t opcode;
256 	u_int8_t byte2;
257 #define	SLS_SP				0x01
258 #define	SLS_PPC				0x02
259 	u_int8_t page;
260 #define	SLS_PAGE_CODE 			0x3F
261 #define	SLS_ALL_PAGES_PAGE		0x00
262 #define	SLS_OVERRUN_PAGE		0x01
263 #define	SLS_ERROR_WRITE_PAGE		0x02
264 #define	SLS_ERROR_READ_PAGE		0x03
265 #define	SLS_ERROR_READREVERSE_PAGE	0x04
266 #define	SLS_ERROR_VERIFY_PAGE		0x05
267 #define	SLS_ERROR_NONMEDIUM_PAGE	0x06
268 #define	SLS_ERROR_LASTN_PAGE		0x07
269 #define SLS_SELF_TEST_PAGE		0x10
270 #define SLS_IE_PAGE			0x2f
271 #define	SLS_PAGE_CTRL_MASK		0xC0
272 #define	SLS_PAGE_CTRL_THRESHOLD		0x00
273 #define	SLS_PAGE_CTRL_CUMULATIVE	0x40
274 #define	SLS_PAGE_CTRL_THRESH_DEFAULT	0x80
275 #define	SLS_PAGE_CTRL_CUMUL_DEFAULT	0xC0
276 	u_int8_t reserved[2];
277 	u_int8_t paramptr[2];
278 	u_int8_t length[2];
279 	u_int8_t control;
280 };
281 
282 struct scsi_log_select
283 {
284 	u_int8_t opcode;
285 	u_int8_t byte2;
286 /*	SLS_SP				0x01 */
287 #define	SLS_PCR				0x02
288 	u_int8_t page;
289 /*	SLS_PAGE_CTRL_MASK		0xC0 */
290 /*	SLS_PAGE_CTRL_THRESHOLD		0x00 */
291 /*	SLS_PAGE_CTRL_CUMULATIVE	0x40 */
292 /*	SLS_PAGE_CTRL_THRESH_DEFAULT	0x80 */
293 /*	SLS_PAGE_CTRL_CUMUL_DEFAULT	0xC0 */
294 	u_int8_t reserved[4];
295 	u_int8_t length[2];
296 	u_int8_t control;
297 };
298 
299 struct scsi_log_header
300 {
301 	u_int8_t page;
302 	u_int8_t reserved;
303 	u_int8_t datalen[2];
304 };
305 
306 struct scsi_log_param_header {
307 	u_int8_t param_code[2];
308 	u_int8_t param_control;
309 #define	SLP_LP				0x01
310 #define	SLP_LBIN			0x02
311 #define	SLP_TMC_MASK			0x0C
312 #define	SLP_TMC_ALWAYS			0x00
313 #define	SLP_TMC_EQUAL			0x04
314 #define	SLP_TMC_NOTEQUAL		0x08
315 #define	SLP_TMC_GREATER			0x0C
316 #define	SLP_ETC				0x10
317 #define	SLP_TSD				0x20
318 #define	SLP_DS				0x40
319 #define	SLP_DU				0x80
320 	u_int8_t param_len;
321 };
322 
323 struct scsi_control_page {
324 	u_int8_t page_code;
325 	u_int8_t page_length;
326 	u_int8_t rlec;
327 #define SCB_RLEC			0x01	/*Report Log Exception Cond*/
328 	u_int8_t queue_flags;
329 #define SCP_QUEUE_ALG_MASK		0xF0
330 #define SCP_QUEUE_ALG_RESTRICTED	0x00
331 #define SCP_QUEUE_ALG_UNRESTRICTED	0x10
332 #define SCP_QUEUE_ERR			0x02	/*Queued I/O aborted for CACs*/
333 #define SCP_QUEUE_DQUE			0x01	/*Queued I/O disabled*/
334 	u_int8_t eca_and_aen;
335 #define SCP_EECA			0x80	/*Enable Extended CA*/
336 #define SCP_RAENP			0x04	/*Ready AEN Permission*/
337 #define SCP_UAAENP			0x02	/*UA AEN Permission*/
338 #define SCP_EAENP			0x01	/*Error AEN Permission*/
339 	u_int8_t reserved;
340 	u_int8_t aen_holdoff_period[2];
341 };
342 
343 struct scsi_cache_page {
344 	u_int8_t page_code;
345 #define SCHP_PAGE_SAVABLE		0x80	/* Page is savable */
346 	u_int8_t page_length;
347 	u_int8_t cache_flags;
348 #define SCHP_FLAGS_WCE			0x04	/* Write Cache Enable */
349 #define SCHP_FLAGS_MF			0x02	/* Multiplication factor */
350 #define SCHP_FLAGS_RCD			0x01	/* Read Cache Disable */
351 	u_int8_t rw_cache_policy;
352 	u_int8_t dis_prefetch[2];
353 	u_int8_t min_prefetch[2];
354 	u_int8_t max_prefetch[2];
355 	u_int8_t max_prefetch_ceil[2];
356 };
357 
358 struct scsi_info_exceptions_page {
359 	u_int8_t page_code;
360 #define SIEP_PAGE_SAVABLE		0x80	/* Page is savable */
361 	u_int8_t page_length;
362 	u_int8_t info_flags;
363 #define SIEP_FLAGS_PERF			0x80
364 #define SIEP_FLAGS_EBF			0x20
365 #define SIEP_FLAGS_EWASC		0x10
366 #define SIEP_FLAGS_DEXCPT		0x08
367 #define SIEP_FLAGS_TEST			0x04
368 #define SIEP_FLAGS_EBACKERR		0x02
369 #define SIEP_FLAGS_LOGERR		0x01
370 	u_int8_t mrie;
371 	u_int8_t interval_timer[4];
372 	u_int8_t report_count[4];
373 };
374 
375 struct scsi_proto_specific_page {
376 	u_int8_t page_code;
377 #define SPSP_PAGE_SAVABLE		0x80	/* Page is savable */
378 	u_int8_t page_length;
379 	u_int8_t protocol;
380 #define SPSP_PROTO_FC			0x00
381 #define SPSP_PROTO_SPI			0x01
382 #define SPSP_PROTO_SSA			0x02
383 #define SPSP_PROTO_1394			0x03
384 #define SPSP_PROTO_RDMA			0x04
385 #define SPSP_PROTO_ISCSI		0x05
386 #define SPSP_PROTO_SAS			0x06
387 #define SPSP_PROTO_ADT			0x07
388 #define SPSP_PROTO_ATA			0x08
389 #define SPSP_PROTO_NONE			0x0f
390 };
391 
392 struct scsi_reserve
393 {
394 	u_int8_t opcode;
395 	u_int8_t byte2;
396 	u_int8_t unused[2];
397 	u_int8_t length;
398 	u_int8_t control;
399 };
400 
401 struct scsi_release
402 {
403 	u_int8_t opcode;
404 	u_int8_t byte2;
405 	u_int8_t unused[2];
406 	u_int8_t length;
407 	u_int8_t control;
408 };
409 
410 struct scsi_prevent
411 {
412 	u_int8_t opcode;
413 	u_int8_t byte2;
414 	u_int8_t unused[2];
415 	u_int8_t how;
416 	u_int8_t control;
417 };
418 #define	PR_PREVENT 0x01
419 #define PR_ALLOW   0x00
420 
421 struct scsi_sync_cache
422 {
423 	u_int8_t opcode;
424 	u_int8_t byte2;
425 	u_int8_t begin_lba[4];
426 	u_int8_t reserved;
427 	u_int8_t lb_count[2];
428 	u_int8_t control;
429 };
430 
431 
432 struct scsi_changedef
433 {
434 	u_int8_t opcode;
435 	u_int8_t byte2;
436 	u_int8_t unused1;
437 	u_int8_t how;
438 	u_int8_t unused[4];
439 	u_int8_t datalen;
440 	u_int8_t control;
441 };
442 
443 struct scsi_read_buffer
444 {
445 	u_int8_t opcode;
446 	u_int8_t byte2;
447 #define	RWB_MODE		0x07
448 #define	RWB_MODE_HDR_DATA	0x00
449 #define	RWB_MODE_DATA		0x02
450 #define	RWB_MODE_DOWNLOAD	0x04
451 #define	RWB_MODE_DOWNLOAD_SAVE	0x05
452         u_int8_t buffer_id;
453         u_int8_t offset[3];
454         u_int8_t length[3];
455         u_int8_t control;
456 };
457 
458 struct scsi_write_buffer
459 {
460 	u_int8_t opcode;
461 	u_int8_t byte2;
462 	u_int8_t buffer_id;
463 	u_int8_t offset[3];
464 	u_int8_t length[3];
465 	u_int8_t control;
466 };
467 
468 struct scsi_rw_6
469 {
470 	u_int8_t opcode;
471 	u_int8_t addr[3];
472 /* only 5 bits are valid in the MSB address byte */
473 #define	SRW_TOPADDR	0x1F
474 	u_int8_t length;
475 	u_int8_t control;
476 };
477 
478 struct scsi_rw_10
479 {
480 	u_int8_t opcode;
481 #define	SRW10_RELADDR	0x01
482 /* EBP defined for WRITE(10) only */
483 #define SRW10_EBP	0x04
484 #define SRW10_FUA	0x08
485 #define	SRW10_DPO	0x10
486 	u_int8_t byte2;
487 	u_int8_t addr[4];
488 	u_int8_t reserved;
489 	u_int8_t length[2];
490 	u_int8_t control;
491 };
492 
493 struct scsi_rw_12
494 {
495 	u_int8_t opcode;
496 #define	SRW12_RELADDR	0x01
497 #define SRW12_FUA	0x08
498 #define	SRW12_DPO	0x10
499 	u_int8_t byte2;
500 	u_int8_t addr[4];
501 	u_int8_t length[4];
502 	u_int8_t reserved;
503 	u_int8_t control;
504 };
505 
506 struct scsi_rw_16
507 {
508 	u_int8_t opcode;
509 #define        SRW16_RELADDR   0x01
510 #define        SRW16_FUA       0x08
511 #define        SRW16_DPO       0x10
512 	u_int8_t byte2;
513 	u_int8_t addr[8];
514 	u_int8_t length[4];
515 	u_int8_t reserved;
516 	u_int8_t control;
517 };
518 
519 
520 struct scsi_start_stop_unit
521 {
522 	u_int8_t opcode;
523 	u_int8_t byte2;
524 #define	SSS_IMMED		0x01
525 	u_int8_t reserved[2];
526 	u_int8_t how;
527 #define	SSS_START		0x01
528 #define	SSS_LOEJ		0x02
529 	u_int8_t control;
530 };
531 
532 struct ata_pass_12 {
533 	u_int8_t opcode;
534 	u_int8_t protocol;
535 #define AP_MULTI	0xe0
536 	u_int8_t flags;
537 #define AP_T_LEN	0x03
538 #define AP_BB		0x04
539 #define AP_T_DIR	0x08
540 #define AP_CK_COND	0x20
541 #define AP_OFFLINE	0x60
542 	u_int8_t features;
543 	u_int8_t sector_count;
544 	u_int8_t lba_low;
545 	u_int8_t lba_mid;
546 	u_int8_t lba_high;
547 	u_int8_t device;
548 	u_int8_t command;
549 	u_int8_t reserved;
550 	u_int8_t control;
551 };
552 
553 struct ata_pass_16 {
554 	u_int8_t opcode;
555 	u_int8_t protocol;
556 #define AP_EXTEND	0x01
557 	u_int8_t flags;
558 	u_int8_t features_ext;
559 	u_int8_t features;
560 	u_int8_t sector_count_ext;
561 	u_int8_t sector_count;
562 	u_int8_t lba_low_ext;
563 	u_int8_t lba_low;
564 	u_int8_t lba_mid_ext;
565 	u_int8_t lba_mid;
566 	u_int8_t lba_high_ext;
567 	u_int8_t lba_high;
568 	u_int8_t device;
569 	u_int8_t command;
570 	u_int8_t control;
571 };
572 
573 #define SC_SCSI_1 0x01
574 #define SC_SCSI_2 0x03
575 
576 /*
577  * Opcodes
578  */
579 
580 #define	TEST_UNIT_READY		0x00
581 #define REQUEST_SENSE		0x03
582 #define	READ_6			0x08
583 #define WRITE_6			0x0a
584 #define INQUIRY			0x12
585 #define MODE_SELECT_6		0x15
586 #define MODE_SENSE_6		0x1a
587 #define START_STOP_UNIT		0x1b
588 #define START_STOP		0x1b
589 #define RESERVE      		0x16
590 #define RELEASE      		0x17
591 #define	RECEIVE_DIAGNOSTIC	0x1c
592 #define	SEND_DIAGNOSTIC		0x1d
593 #define PREVENT_ALLOW		0x1e
594 #define	READ_CAPACITY		0x25
595 #define	READ_10			0x28
596 #define WRITE_10		0x2a
597 #define POSITION_TO_ELEMENT	0x2b
598 #define	SYNCHRONIZE_CACHE	0x35
599 #define	READ_DEFECT_DATA_10	0x37
600 #define	WRITE_BUFFER            0x3b
601 #define	READ_BUFFER             0x3c
602 #define	CHANGE_DEFINITION	0x40
603 #define	LOG_SELECT		0x4c
604 #define	LOG_SENSE		0x4d
605 #define	MODE_SELECT_10		0x55
606 #define	MODE_SENSE_10		0x5a
607 #define	ATA_PASS_16		0x85
608 #define READ_16			0x88
609 #define WRITE_16		0x8a
610 #define READ_CAPACITY_16	0x9e
611 #define SERVICE_ACTION_IN	0x9e
612 #define REPORT_LUNS		0xa0
613 #define	ATA_PASS_12		0xa1
614 #define MOVE_MEDIUM     	0xa5
615 #define READ_12			0xa8
616 #define WRITE_12		0xaa
617 #define READ_ELEMENT_STATUS	0xb8
618 
619 /*
620  * Device Types
621  */
622 #define	T_DIRECT	0x00
623 #define	T_SEQUENTIAL	0x01
624 #define	T_PRINTER	0x02
625 #define	T_PROCESSOR	0x03
626 #define	T_WORM		0x04
627 #define	T_CDROM		0x05
628 #define	T_SCANNER	0x06
629 #define	T_OPTICAL 	0x07
630 #define	T_CHANGER	0x08
631 #define	T_COMM		0x09
632 #define	T_ASC0		0x0a
633 #define	T_ASC1		0x0b
634 #define	T_STORARRAY	0x0c
635 #define	T_ENCLOSURE	0x0d
636 #define	T_RBC		0x0e
637 #define	T_OCRW		0x0f
638 #define	T_OSD		0x11
639 #define	T_ADC		0x12
640 #define	T_NODEVICE	0x1f
641 #define	T_ANY		0xff	/* Used in Quirk table matches */
642 
643 #define T_REMOV		1
644 #define	T_FIXED		0
645 
646 /*
647  * This length is the initial inquiry length used by the probe code, as
648  * well as the legnth necessary for scsi_print_inquiry() to function
649  * correctly.  If either use requires a different length in the future,
650  * the two values should be de-coupled.
651  */
652 #define	SHORT_INQUIRY_LENGTH	36
653 
654 struct scsi_inquiry_data
655 {
656 	u_int8_t device;
657 #define	SID_TYPE(inq_data) ((inq_data)->device & 0x1f)
658 #define	SID_QUAL(inq_data) (((inq_data)->device & 0xE0) >> 5)
659 #define	SID_QUAL_LU_CONNECTED	0x00	/*
660 					 * The specified peripheral device
661 					 * type is currently connected to
662 					 * logical unit.  If the target cannot
663 					 * determine whether or not a physical
664 					 * device is currently connected, it
665 					 * shall also use this peripheral
666 					 * qualifier when returning the INQUIRY
667 					 * data.  This peripheral qualifier
668 					 * does not mean that the device is
669 					 * ready for access by the initiator.
670 					 */
671 #define	SID_QUAL_LU_OFFLINE	0x01	/*
672 					 * The target is capable of supporting
673 					 * the specified peripheral device type
674 					 * on this logical unit; however, the
675 					 * physical device is not currently
676 					 * connected to this logical unit.
677 					 */
678 #define SID_QUAL_RSVD		0x02
679 #define	SID_QUAL_BAD_LU		0x03	/*
680 					 * The target is not capable of
681 					 * supporting a physical device on
682 					 * this logical unit. For this
683 					 * peripheral qualifier the peripheral
684 					 * device type shall be set to 1Fh to
685 					 * provide compatibility with previous
686 					 * versions of SCSI. All other
687 					 * peripheral device type values are
688 					 * reserved for this peripheral
689 					 * qualifier.
690 					 */
691 #define	SID_QUAL_IS_VENDOR_UNIQUE(inq_data) ((SID_QUAL(inq_data) & 0x08) != 0)
692 	u_int8_t dev_qual2;
693 #define	SID_QUAL2	0x7F
694 #define	SID_IS_REMOVABLE(inq_data) (((inq_data)->dev_qual2 & 0x80) != 0)
695 	u_int8_t version;
696 #define SID_ANSI_REV(inq_data) ((inq_data)->version & 0x07)
697 #define		SCSI_REV_0		0
698 #define		SCSI_REV_CCS		1
699 #define		SCSI_REV_2		2
700 #define		SCSI_REV_SPC		3
701 #define		SCSI_REV_SPC2		4
702 #define		SCSI_REV_SPC3		5
703 
704 #define SID_ECMA	0x38
705 #define SID_ISO		0xC0
706 	u_int8_t response_format;
707 #define SID_AENC	0x80
708 #define SID_TrmIOP	0x40
709 	u_int8_t additional_length;
710 #define	SID_ADDITIONAL_LENGTH(iqd)					\
711 	((iqd)->additional_length +					\
712 	offsetof(struct scsi_inquiry_data, additional_length) + 1)
713 	u_int8_t reserved;
714 	u_int8_t spc2_flags;
715 #define SPC2_SID_MChngr 	0x08
716 #define SPC2_SID_MultiP 	0x10
717 #define SPC2_SID_EncServ	0x40
718 #define SPC2_SID_BQueue		0x80
719 
720 #define INQ_DATA_TQ_ENABLED(iqd)				\
721     ((SID_ANSI_REV(iqd) < SCSI_REV_SPC2)? ((iqd)->flags & SID_CmdQue) :	\
722     (((iqd)->flags & SID_CmdQue) && !((iqd)->spc2_flags & SPC2_SID_BQueue)) || \
723     (!((iqd)->flags & SID_CmdQue) && ((iqd)->spc2_flags & SPC2_SID_BQueue)))
724 
725 
726 	u_int8_t flags;
727 #define	SID_SftRe	0x01
728 #define	SID_CmdQue	0x02
729 #define	SID_Linked	0x08
730 #define	SID_Sync	0x10
731 #define	SID_WBus16	0x20
732 #define	SID_WBus32	0x40
733 #define	SID_RelAdr	0x80
734 #define SID_VENDOR_SIZE   8
735 	char	 vendor[SID_VENDOR_SIZE];
736 #define SID_PRODUCT_SIZE  16
737 	char	 product[SID_PRODUCT_SIZE];
738 #define SID_REVISION_SIZE 4
739 	char	 revision[SID_REVISION_SIZE];
740 	/*
741 	 * The following fields were taken from SCSI Primary Commands - 2
742 	 * (SPC-2) Revision 14, Dated 11 November 1999
743 	 */
744 #define	SID_VENDOR_SPECIFIC_0_SIZE	20
745 	u_int8_t vendor_specific0[SID_VENDOR_SPECIFIC_0_SIZE];
746 	/*
747 	 * An extension of SCSI Parallel Specific Values
748 	 */
749 #define	SID_SPI_IUS		0x01
750 #define	SID_SPI_QAS		0x02
751 #define	SID_SPI_CLOCK_ST	0x00
752 #define	SID_SPI_CLOCK_DT	0x04
753 #define	SID_SPI_CLOCK_DT_ST	0x0C
754 #define	SID_SPI_MASK		0x0F
755 	u_int8_t spi3data;
756 	u_int8_t reserved2;
757 	/*
758 	 * Version Descriptors, stored 2 byte values.
759 	 */
760 	u_int8_t version1[2];
761 	u_int8_t version2[2];
762 	u_int8_t version3[2];
763 	u_int8_t version4[2];
764 	u_int8_t version5[2];
765 	u_int8_t version6[2];
766 	u_int8_t version7[2];
767 	u_int8_t version8[2];
768 
769 	u_int8_t reserved3[22];
770 
771 #define	SID_VENDOR_SPECIFIC_1_SIZE	160
772 	u_int8_t vendor_specific1[SID_VENDOR_SPECIFIC_1_SIZE];
773 };
774 
775 struct scsi_vpd_supported_page_list
776 {
777 	u_int8_t device;
778 	u_int8_t page_code;
779 #define SVPD_SUPPORTED_PAGE_LIST 0x00
780 	u_int8_t reserved;
781 	u_int8_t length;	/* number of VPD entries */
782 #define SVPD_SUPPORTED_PAGES_SIZE	251
783 	u_int8_t list[SVPD_SUPPORTED_PAGES_SIZE];
784 };
785 
786 struct scsi_vpd_unit_serial_number
787 {
788 	u_int8_t device;
789 	u_int8_t page_code;
790 #define SVPD_UNIT_SERIAL_NUMBER	0x80
791 	u_int8_t reserved;
792 	u_int8_t length; /* serial number length */
793 #define SVPD_SERIAL_NUM_SIZE 251
794 	u_int8_t serial_num[SVPD_SERIAL_NUM_SIZE];
795 };
796 
797 struct scsi_vpd_unit_devid
798 {
799 	u_int8_t device;
800 	u_int8_t page_code;
801 #define SVPD_UNIT_DEVID	0x83
802 	u_int8_t reserved;
803 	u_int8_t length;
804 	/* extended by variable array of scsi_vpd_devid_hdr */
805 };
806 
807 struct scsi_vpd_devid_hdr {
808 	u_int8_t pi_code;
809 #define VPD_DEVID_PI(_f)	(((_f) >> 4) & 0xf0)
810 #define VPD_DEVID_CODE(_f)	(((_f) >> 0) & 0x0f)
811 #define VPD_DEVID_CODE_BINARY		0x1
812 #define VPD_DEVID_CODE_ASCII		0x2
813 #define VPD_DEVID_CODE_UTF8		0x3
814 	u_int8_t flags;
815 #define VPD_DEVID_PIV		0x80
816 #define VPD_DEVID_ASSOC(_f)	((_f) & 0x30)
817 #define VPD_DEVID_ASSOC_LU		0x00
818 #define VPD_DEVID_ASSOC_PORT		0x10
819 #define VPD_DEVID_ASSOC_TARG		0x20
820 #define VPD_DEVID_TYPE(_f)	((_f) & 0x0f)
821 #define VPD_DEVID_TYPE_VENDOR		0x0
822 #define VPD_DEVID_TYPE_T10		0x1
823 #define VPD_DEVID_TYPE_EUI64		0x2
824 #define VPD_DEVID_TYPE_NAA		0x3
825 #define VPD_DEVID_TYPE_RELATIVE		0x4
826 #define VPD_DEVID_TYPE_PORT		0x5
827 #define VPD_DEVID_TYPE_LU		0x6
828 #define VPD_DEVID_TYPE_MD5		0x7
829 #define VPD_DEVID_TYPE_NAME		0x8
830 	u_int8_t reserved;
831 	u_int8_t len;
832 };
833 
834 struct scsi_read_capacity
835 {
836 	u_int8_t opcode;
837 	u_int8_t byte2;
838 	u_int8_t addr[4];
839 	u_int8_t unused[3];
840 	u_int8_t control;
841 };
842 
843 struct scsi_read_capacity_16
844 {
845 	uint8_t opcode;
846 #define        SRC16_SERVICE_ACTION    0x10
847 	uint8_t service_action;
848 	uint8_t addr[8];
849 	uint8_t alloc_len[4];
850 #define        SRC16_PMI               0x01
851 #define        SRC16_RELADR            0x02
852 	uint8_t reladr;
853 	uint8_t control;
854 };
855 
856 struct scsi_read_capacity_data
857 {
858 	u_int8_t addr[4];
859 	u_int8_t length[4];
860 };
861 
862 struct scsi_read_capacity_data_16
863 {
864 	uint8_t addr[8];
865 	uint8_t length[4];
866 	u_int8_t p_type_prot;
867 	u_int8_t logical_per_phys;
868 	u_int8_t lowest_aligned[2];
869 	u_int8_t reserved[16];
870 };
871 
872 struct scsi_report_luns
873 {
874 	uint8_t opcode;
875 	uint8_t reserved1;
876 #define	RPL_REPORT_DEFAULT	0x00
877 #define	RPL_REPORT_WELLKNOWN	0x01
878 #define	RPL_REPORT_ALL		0x02
879 	uint8_t select_report;
880 	uint8_t reserved2[3];
881 	uint8_t length[4];
882 	uint8_t reserved3;
883 	uint8_t control;
884 };
885 
886 struct scsi_report_luns_data {
887 	u_int8_t length[4];	/* length of LUN inventory, in bytes */
888 	u_int8_t reserved[4];	/* unused */
889 	/*
890 	 * LUN inventory- we only support the type zero form for now.
891 	 */
892 	struct {
893 		u_int8_t lundata[8];
894 	} luns[0];
895 };
896 #define	RPL_LUNDATA_PERIPH_BUS_MASK	0x3f
897 #define	RPL_LUNDATA_FLAT_LUN_MASK	0x3f
898 #define	RPL_LUNDATA_LUN_TARG_MASK	0x3f
899 #define	RPL_LUNDATA_LUN_BUS_MASK	0xe0
900 #define	RPL_LUNDATA_LUN_LUN_MASK	0x1f
901 #define	RPL_LUNDATA_EXT_LEN_MASK	0x30
902 #define	RPL_LUNDATA_EXT_EAM_MASK	0x0f
903 #define	RPL_LUNDATA_EXT_EAM_WK		0x01
904 #define	RPL_LUNDATA_EXT_EAM_NOT_SPEC	0x0f
905 #define	RPL_LUNDATA_ATYP_MASK	0xc0	/* MBZ for type 0 lun */
906 #define	RPL_LUNDATA_ATYP_PERIPH	0x00
907 #define	RPL_LUNDATA_ATYP_FLAT	0x40
908 #define	RPL_LUNDATA_ATYP_LUN	0x80
909 #define	RPL_LUNDATA_ATYP_EXTLUN	0xc0
910 
911 struct scsi_sense_data
912 {
913 	u_int8_t error_code;
914 #define	SSD_ERRCODE			0x7F
915 #define		SSD_CURRENT_ERROR	0x70
916 #define		SSD_DEFERRED_ERROR	0x71
917 #define	SSD_ERRCODE_VALID	0x80
918 	u_int8_t segment;
919 	u_int8_t flags;
920 #define	SSD_KEY				0x0F
921 #define		SSD_KEY_NO_SENSE	0x00
922 #define		SSD_KEY_RECOVERED_ERROR	0x01
923 #define		SSD_KEY_NOT_READY	0x02
924 #define		SSD_KEY_MEDIUM_ERROR	0x03
925 #define		SSD_KEY_HARDWARE_ERROR	0x04
926 #define		SSD_KEY_ILLEGAL_REQUEST	0x05
927 #define		SSD_KEY_UNIT_ATTENTION	0x06
928 #define		SSD_KEY_DATA_PROTECT	0x07
929 #define		SSD_KEY_BLANK_CHECK	0x08
930 #define		SSD_KEY_Vendor_Specific	0x09
931 #define		SSD_KEY_COPY_ABORTED	0x0a
932 #define		SSD_KEY_ABORTED_COMMAND	0x0b
933 #define		SSD_KEY_EQUAL		0x0c
934 #define		SSD_KEY_VOLUME_OVERFLOW	0x0d
935 #define		SSD_KEY_MISCOMPARE	0x0e
936 #define		SSD_KEY_RESERVED	0x0f
937 #define	SSD_ILI		0x20
938 #define	SSD_EOM		0x40
939 #define	SSD_FILEMARK	0x80
940 	u_int8_t info[4];
941 	u_int8_t extra_len;
942 	u_int8_t cmd_spec_info[4];
943 	u_int8_t add_sense_code;
944 	u_int8_t add_sense_code_qual;
945 	u_int8_t fru;
946 	u_int8_t sense_key_spec[3];
947 #define	SSD_SCS_VALID		0x80
948 #define SSD_FIELDPTR_CMD	0x40
949 #define SSD_BITPTR_VALID	0x08
950 #define SSD_BITPTR_VALUE	0x07
951 #define SSD_MIN_SIZE 18
952 	u_int8_t extra_bytes[14];
953 #define SSD_FULL_SIZE sizeof(struct scsi_sense_data)
954 };
955 
956 struct scsi_mode_header_6
957 {
958 	u_int8_t data_length;	/* Sense data length */
959 	u_int8_t medium_type;
960 	u_int8_t dev_spec;
961 	u_int8_t blk_desc_len;
962 };
963 
964 struct scsi_mode_header_10
965 {
966 	u_int8_t data_length[2];/* Sense data length */
967 	u_int8_t medium_type;
968 	u_int8_t dev_spec;
969 	u_int8_t unused[2];
970 	u_int8_t blk_desc_len[2];
971 };
972 
973 struct scsi_mode_page_header
974 {
975 	u_int8_t page_code;
976 	u_int8_t page_length;
977 };
978 
979 struct scsi_mode_blk_desc
980 {
981 	u_int8_t density;
982 	u_int8_t nblocks[3];
983 	u_int8_t reserved;
984 	u_int8_t blklen[3];
985 };
986 
987 #define	SCSI_DEFAULT_DENSITY	0x00	/* use 'default' density */
988 #define	SCSI_SAME_DENSITY	0x7f	/* use 'same' density- >= SCSI-2 only */
989 
990 
991 /*
992  * Status Byte
993  */
994 #define	SCSI_STATUS_OK			0x00
995 #define	SCSI_STATUS_CHECK_COND		0x02
996 #define	SCSI_STATUS_COND_MET		0x04
997 #define	SCSI_STATUS_BUSY		0x08
998 #define SCSI_STATUS_INTERMED		0x10
999 #define SCSI_STATUS_INTERMED_COND_MET	0x14
1000 #define SCSI_STATUS_RESERV_CONFLICT	0x18
1001 #define SCSI_STATUS_CMD_TERMINATED	0x22	/* Obsolete in SAM-2 */
1002 #define SCSI_STATUS_QUEUE_FULL		0x28
1003 #define SCSI_STATUS_ACA_ACTIVE		0x30
1004 #define SCSI_STATUS_TASK_ABORTED	0x40
1005 
1006 struct scsi_inquiry_pattern {
1007 	u_int8_t   type;
1008 	u_int8_t   media_type;
1009 #define	SIP_MEDIA_REMOVABLE	0x01
1010 #define	SIP_MEDIA_FIXED		0x02
1011 	const char *vendor;
1012 	const char *product;
1013 	const char *revision;
1014 };
1015 
1016 struct scsi_static_inquiry_pattern {
1017 	u_int8_t   type;
1018 	u_int8_t   media_type;
1019 	char       vendor[SID_VENDOR_SIZE+1];
1020 	char       product[SID_PRODUCT_SIZE+1];
1021 	char       revision[SID_REVISION_SIZE+1];
1022 };
1023 
1024 struct scsi_sense_quirk_entry {
1025 	struct scsi_inquiry_pattern	inq_pat;
1026 	int				num_sense_keys;
1027 	int				num_ascs;
1028 	struct sense_key_table_entry	*sense_key_info;
1029 	struct asc_table_entry		*asc_info;
1030 };
1031 
1032 struct sense_key_table_entry {
1033 	u_int8_t    sense_key;
1034 	u_int32_t   action;
1035 	const char *desc;
1036 };
1037 
1038 struct asc_table_entry {
1039 	u_int8_t    asc;
1040 	u_int8_t    ascq;
1041 	u_int32_t   action;
1042 	const char *desc;
1043 };
1044 
1045 struct op_table_entry {
1046 	u_int8_t    opcode;
1047 	u_int32_t   opmask;
1048 	const char  *desc;
1049 };
1050 
1051 struct scsi_op_quirk_entry {
1052 	struct scsi_inquiry_pattern	inq_pat;
1053 	int				num_ops;
1054 	struct op_table_entry		*op_table;
1055 };
1056 
1057 typedef enum {
1058 	SSS_FLAG_NONE		= 0x00,
1059 	SSS_FLAG_PRINT_COMMAND	= 0x01
1060 } scsi_sense_string_flags;
1061 
1062 typedef union scsi_cdb {
1063 	struct scsi_generic		generic;
1064 	struct scsi_sense		sense;
1065 	struct scsi_test_unit_ready	test_unit_ready;
1066 	struct scsi_send_diag		send_diag;
1067 	struct scsi_inquiry		inquiry;
1068 	struct scsi_mode_sense_6	mode_sense_6;
1069 	struct scsi_mode_sense_10	mode_sense_10;
1070 	struct scsi_mode_select_6	mode_select_6;
1071 	struct scsi_mode_select_10	mode_select_10;
1072 	struct scsi_log_sense		log_sense;
1073 	struct scsi_log_select		log_select;
1074 	struct scsi_reserve		reserve;
1075 	struct scsi_release		release;
1076 	struct scsi_prevent		prevent;
1077 	struct scsi_sync_cache		sync_cache;
1078 	struct scsi_changedef		changedef;
1079 	struct scsi_read_buffer		read_buffer;
1080 	struct scsi_write_buffer	write_buffer;
1081 	struct scsi_rw_6		rw_6;
1082 	struct scsi_rw_10		rw_10;
1083 	struct scsi_rw_12		rw_12;
1084 	struct scsi_rw_16		rw_16;
1085 	struct scsi_start_stop_unit	start_stop_unit;
1086 	struct ata_pass_12 		ata_pass_12;
1087 	struct ata_pass_16 		ata_pass_16;
1088 	struct scsi_read_capacity	read_capacity;
1089 	struct scsi_read_capacity_16	read_capacity_16;
1090 	struct scsi_report_luns		report_luns;
1091 } *scsi_cdb_t;
1092 
1093 typedef union scsi_data {
1094 	struct scsi_mode_hdr_6			mode_hdr_6;
1095 	struct scsi_mode_hdr_10			mode_hdr_10;
1096 	struct scsi_mode_block_descr		mode_block_descr;
1097 	struct scsi_log_header			log_header;
1098 	struct scsi_log_param_header		log_param_header;
1099 	struct scsi_control_page		control_page;
1100 	struct scsi_cache_page			cache_page;
1101 	struct scsi_info_exceptions_page	info_exceptions_page;
1102 	struct scsi_proto_specific_page		proto_specific_page;
1103 	struct scsi_inquiry_data		inquiry_data;
1104 	struct scsi_vpd_supported_page_list	vpd_supported_page_list;
1105 	struct scsi_vpd_unit_serial_number	vpd_unit_serial_number;
1106 	struct scsi_vpd_unit_devid		vpd_unit_devid;
1107 	struct scsi_read_capacity_data		read_capacity_data;
1108 	struct scsi_read_capacity_data_16	read_capacity_data_16;
1109 	struct scsi_report_luns_data		report_luns_data;
1110 	struct scsi_sense_data			sense_data;
1111 	struct scsi_mode_header_6		mode_header_6;
1112 	struct scsi_mode_header_10		mode_header_10;
1113 	struct scsi_mode_page_header		mode_page_header;
1114 	struct scsi_mode_blk_desc		mode_blk_desc;
1115 	struct scsi_inquiry_pattern		inquiry_pattern;
1116 	struct scsi_static_inquiry_pattern	static_inquiry_pattern;
1117 } *scsi_data_t;
1118 
1119 struct ccb_scsiio;
1120 struct cam_periph;
1121 union  ccb;
1122 #ifndef _KERNEL
1123 struct cam_device;
1124 #endif
1125 
1126 extern const char *scsi_sense_key_text[];
1127 
1128 struct sbuf;
1129 
1130 __BEGIN_DECLS
1131 void scsi_sense_desc(int sense_key, int asc, int ascq,
1132 		     struct scsi_inquiry_data *inq_data,
1133 		     const char **sense_key_desc, const char **asc_desc);
1134 scsi_sense_action scsi_error_action(struct ccb_scsiio* csio,
1135 				    struct scsi_inquiry_data *inq_data,
1136 				    u_int32_t sense_flags);
1137 const char *	scsi_status_string(struct ccb_scsiio *csio);
1138 #ifdef _KERNEL
1139 int		scsi_command_string(struct ccb_scsiio *csio, struct sbuf *sb);
1140 int		scsi_sense_sbuf(struct ccb_scsiio *csio, struct sbuf *sb,
1141 				scsi_sense_string_flags flags);
1142 char *		scsi_sense_string(struct ccb_scsiio *csio,
1143 				  char *str, int str_len);
1144 void		scsi_sense_print(struct ccb_scsiio *csio);
1145 int		scsi_interpret_sense(union ccb *ccb,
1146 				     u_int32_t sense_flags,
1147 				     u_int32_t *relsim_flags,
1148 				     u_int32_t *reduction,
1149 				     u_int32_t *timeout,
1150 				     scsi_sense_action error_action);
1151 #else
1152 int		scsi_command_string(struct cam_device *device,
1153 				    struct ccb_scsiio *csio, struct sbuf *sb);
1154 int		scsi_sense_sbuf(struct cam_device *device,
1155 				struct ccb_scsiio *csio, struct sbuf *sb,
1156 				scsi_sense_string_flags flags);
1157 char *		scsi_sense_string(struct cam_device *device,
1158 				  struct ccb_scsiio *csio,
1159 				  char *str, int str_len);
1160 void		scsi_sense_print(struct cam_device *device,
1161 				 struct ccb_scsiio *csio, FILE *ofile);
1162 int		scsi_interpret_sense(struct cam_device *device,
1163 				     union ccb *ccb,
1164 				     u_int32_t sense_flags,
1165 				     u_int32_t *relsim_flags,
1166 				     u_int32_t *reduction,
1167 				     u_int32_t *timeout,
1168 				     scsi_sense_action error_action);
1169 #endif /* _KERNEL */
1170 
1171 #define	SF_RETRY_UA	0x01
1172 #define SF_NO_PRINT	0x02
1173 #define SF_QUIET_IR	0x04	/* Be quiet about Illegal Request reponses */
1174 #define SF_PRINT_ALWAYS	0x08
1175 
1176 
1177 const char *	scsi_op_desc(u_int16_t opcode,
1178 			     struct scsi_inquiry_data *inq_data);
1179 char *		scsi_cdb_string(u_int8_t *cdb_ptr, char *cdb_string,
1180 				size_t len);
1181 
1182 void		scsi_print_inquiry(struct scsi_inquiry_data *inq_data);
1183 
1184 u_int		scsi_calc_syncsrate(u_int period_factor);
1185 u_int		scsi_calc_syncparam(u_int period);
1186 
1187 void		scsi_test_unit_ready(struct ccb_scsiio *csio, u_int32_t retries,
1188 				     void (*cbfcnp)(struct cam_periph *,
1189 						    union ccb *),
1190 				     u_int8_t tag_action,
1191 				     u_int8_t sense_len, u_int32_t timeout);
1192 
1193 void		scsi_request_sense(struct ccb_scsiio *csio, u_int32_t retries,
1194 				   void (*cbfcnp)(struct cam_periph *,
1195 						  union ccb *),
1196 				   void *data_ptr, u_int8_t dxfer_len,
1197 				   u_int8_t tag_action, u_int8_t sense_len,
1198 				   u_int32_t timeout);
1199 
1200 #ifndef CAM_NO_SCSI_INQUIRY	/* hack for cdparanoia */
1201 void		scsi_inquiry(struct ccb_scsiio *csio, u_int32_t retries,
1202 			     void (*cbfcnp)(struct cam_periph *, union ccb *),
1203 			     u_int8_t tag_action, u_int8_t *inq_buf,
1204 			     u_int32_t inq_len, int evpd, u_int8_t page_code,
1205 			     u_int8_t sense_len, u_int32_t timeout);
1206 #endif
1207 
1208 void		scsi_mode_sense(struct ccb_scsiio *csio, u_int32_t retries,
1209 				void (*cbfcnp)(struct cam_periph *,
1210 					       union ccb *),
1211 				u_int8_t tag_action, int dbd,
1212 				u_int8_t page_code, u_int8_t page,
1213 				u_int8_t *param_buf, u_int32_t param_len,
1214 				u_int8_t sense_len, u_int32_t timeout);
1215 void		scsi_mode_sense_len(struct ccb_scsiio *csio, u_int32_t retries,
1216 				void (*cbfcnp)(struct cam_periph *,
1217 						union ccb *),
1218 				u_int8_t tag_action, int dbd,
1219 				u_int8_t page_code, u_int8_t page,
1220 				u_int8_t *param_buf, u_int32_t param_len,
1221 				int minimum_cmd_size, u_int8_t sense_len,
1222 				u_int32_t timeout);
1223 
1224 void		scsi_mode_select(struct ccb_scsiio *csio, u_int32_t retries,
1225 				 void (*cbfcnp)(struct cam_periph *,
1226 						union ccb *),
1227 				 u_int8_t tag_action, int scsi_page_fmt,
1228 				 int save_pages, u_int8_t *param_buf,
1229 				 u_int32_t param_len, u_int8_t sense_len,
1230 				 u_int32_t timeout);
1231 
1232 void		scsi_mode_select_len(struct ccb_scsiio *csio, u_int32_t retries,
1233 				void (*cbfcnp)(struct cam_periph *,
1234 						union ccb *),
1235 				u_int8_t tag_action, int scsi_page_fmt,
1236 				int save_pages, u_int8_t *param_buf,
1237 				u_int32_t param_len, int minimum_cmd_size,
1238 				u_int8_t sense_len, u_int32_t timeout);
1239 
1240 void		scsi_log_sense(struct ccb_scsiio *csio, u_int32_t retries,
1241 			       void (*cbfcnp)(struct cam_periph *, union ccb *),
1242 			       u_int8_t tag_action, u_int8_t page_code,
1243 			       u_int8_t page, int save_pages, int ppc,
1244 			       u_int32_t paramptr, u_int8_t *param_buf,
1245 			       u_int32_t param_len, u_int8_t sense_len,
1246 			       u_int32_t timeout);
1247 
1248 void		scsi_log_select(struct ccb_scsiio *csio, u_int32_t retries,
1249 				void (*cbfcnp)(struct cam_periph *,
1250 				union ccb *), u_int8_t tag_action,
1251 				u_int8_t page_code, int save_pages,
1252 				int pc_reset, u_int8_t *param_buf,
1253 				u_int32_t param_len, u_int8_t sense_len,
1254 				u_int32_t timeout);
1255 
1256 void		scsi_prevent(struct ccb_scsiio *csio, u_int32_t retries,
1257 			     void (*cbfcnp)(struct cam_periph *, union ccb *),
1258 			     u_int8_t tag_action, u_int8_t action,
1259 			     u_int8_t sense_len, u_int32_t timeout);
1260 
1261 void		scsi_read_capacity(struct ccb_scsiio *csio, u_int32_t retries,
1262 				   void (*cbfcnp)(struct cam_periph *,
1263 				   union ccb *), u_int8_t tag_action,
1264 				   struct scsi_read_capacity_data *,
1265 				   u_int8_t sense_len, u_int32_t timeout);
1266 void		scsi_read_capacity_16(struct ccb_scsiio *csio, uint32_t retries,
1267 				    void (*cbfcnp)(struct cam_periph *,
1268 				    union ccb *), uint8_t tag_action,
1269 				    uint64_t lba, int reladr, int pmi,
1270 				    struct scsi_read_capacity_data_16
1271 				    *rcap_buf, uint8_t sense_len,
1272 				    uint32_t timeout);
1273 
1274 void		scsi_report_luns(struct ccb_scsiio *csio, u_int32_t retries,
1275 				 void (*cbfcnp)(struct cam_periph *,
1276 				 union ccb *), u_int8_t tag_action,
1277 				 u_int8_t select_report,
1278 				 struct scsi_report_luns_data *rpl_buf,
1279 				 u_int32_t alloc_len, u_int8_t sense_len,
1280 				 u_int32_t timeout);
1281 
1282 void		scsi_synchronize_cache(struct ccb_scsiio *csio,
1283 				       u_int32_t retries,
1284 				       void (*cbfcnp)(struct cam_periph *,
1285 				       union ccb *), u_int8_t tag_action,
1286 				       u_int32_t begin_lba, u_int16_t lb_count,
1287 				       u_int8_t sense_len, u_int32_t timeout);
1288 
1289 void scsi_read_write(struct ccb_scsiio *csio, u_int32_t retries,
1290 		     void (*cbfcnp)(struct cam_periph *, union ccb *),
1291 		     u_int8_t tag_action, int readop, u_int8_t byte2,
1292 		     int minimum_cmd_size, u_int64_t lba,
1293 		     u_int32_t block_count, u_int8_t *data_ptr,
1294 		     u_int32_t dxfer_len, u_int8_t sense_len,
1295 		     u_int32_t timeout);
1296 
1297 void scsi_start_stop(struct ccb_scsiio *csio, u_int32_t retries,
1298 		     void (*cbfcnp)(struct cam_periph *, union ccb *),
1299 		     u_int8_t tag_action, int start, int load_eject,
1300 		     int immediate, u_int8_t sense_len, u_int32_t timeout);
1301 
1302 int		scsi_inquiry_match(caddr_t inqbuffer, caddr_t table_entry);
1303 int		scsi_static_inquiry_match(caddr_t inqbuffer,
1304 					  caddr_t table_entry);
1305 
1306 static __inline void scsi_extract_sense(struct scsi_sense_data *sense,
1307 					int *error_code, int *sense_key,
1308 					int *asc, int *ascq);
1309 static __inline void scsi_ulto2b(u_int32_t val, u_int8_t *bytes);
1310 static __inline void scsi_ulto3b(u_int32_t val, u_int8_t *bytes);
1311 static __inline void scsi_ulto4b(u_int32_t val, u_int8_t *bytes);
1312 static __inline void scsi_u64to8b(u_int64_t val, u_int8_t *bytes);
1313 static __inline u_int32_t scsi_2btoul(u_int8_t *bytes);
1314 static __inline u_int32_t scsi_3btoul(u_int8_t *bytes);
1315 static __inline int32_t scsi_3btol(u_int8_t *bytes);
1316 static __inline u_int32_t scsi_4btoul(u_int8_t *bytes);
1317 static __inline u_int64_t scsi_8btou64(u_int8_t *bytes);
1318 static __inline void *find_mode_page_6(struct scsi_mode_header_6 *mode_header);
1319 static __inline void *find_mode_page_10(struct scsi_mode_header_10 *mode_header);
1320 
1321 static __inline void
1322 scsi_extract_sense(struct scsi_sense_data *sense, int *error_code,
1323 		   int *sense_key, int *asc, int *ascq)
1324 {
1325 	*error_code = sense->error_code & SSD_ERRCODE;
1326 	*sense_key = sense->flags & SSD_KEY;
1327 	*asc = (sense->extra_len >= 5) ? sense->add_sense_code : 0;
1328 	*ascq = (sense->extra_len >= 6) ? sense->add_sense_code_qual : 0;
1329 }
1330 
1331 static __inline void
1332 scsi_ulto2b(u_int32_t val, u_int8_t *bytes)
1333 {
1334 
1335 	bytes[0] = (val >> 8) & 0xff;
1336 	bytes[1] = val & 0xff;
1337 }
1338 
1339 static __inline void
1340 scsi_ulto3b(u_int32_t val, u_int8_t *bytes)
1341 {
1342 
1343 	bytes[0] = (val >> 16) & 0xff;
1344 	bytes[1] = (val >> 8) & 0xff;
1345 	bytes[2] = val & 0xff;
1346 }
1347 
1348 static __inline void
1349 scsi_ulto4b(u_int32_t val, u_int8_t *bytes)
1350 {
1351 
1352 	bytes[0] = (val >> 24) & 0xff;
1353 	bytes[1] = (val >> 16) & 0xff;
1354 	bytes[2] = (val >> 8) & 0xff;
1355 	bytes[3] = val & 0xff;
1356 }
1357 
1358 static __inline void
1359 scsi_u64to8b(u_int64_t val, u_int8_t *bytes)
1360 {
1361 	bytes[0] = (val >> 56) & 0xff;
1362 	bytes[1] = (val >> 48) & 0xff;
1363 	bytes[2] = (val >> 40) & 0xff;
1364 	bytes[3] = (val >> 32) & 0xff;
1365 	bytes[4] = (val >> 24) & 0xff;
1366 	bytes[5] = (val >> 16) & 0xff;
1367 	bytes[6] = (val >> 8) & 0xff;
1368 	bytes[7] = val & 0xff;
1369 }
1370 
1371 static __inline u_int32_t
1372 scsi_2btoul(u_int8_t *bytes)
1373 {
1374 	u_int32_t rv;
1375 
1376 	rv = (bytes[0] << 8) |
1377 	     bytes[1];
1378 	return (rv);
1379 }
1380 
1381 static __inline uint64_t
1382 scsi_8btou64(uint8_t *bytes)
1383 {
1384 	uint64_t rv;
1385 
1386 	rv = (((uint64_t)bytes[0]) << 56) |
1387 	     (((uint64_t)bytes[1]) << 48) |
1388 	     (((uint64_t)bytes[2]) << 40) |
1389 	     (((uint64_t)bytes[3]) << 32) |
1390 	     (((uint64_t)bytes[4]) << 24) |
1391 	     (((uint64_t)bytes[5]) << 16) |
1392 	     (((uint64_t)bytes[6]) << 8) |
1393 	     bytes[7];
1394 	return (rv);
1395 }
1396 
1397 static __inline u_int32_t
1398 scsi_3btoul(u_int8_t *bytes)
1399 {
1400 	u_int32_t rv;
1401 
1402 	rv = (bytes[0] << 16) |
1403 	     (bytes[1] << 8) |
1404 	     bytes[2];
1405 	return (rv);
1406 }
1407 
1408 static __inline int32_t
1409 scsi_3btol(u_int8_t *bytes)
1410 {
1411 	u_int32_t rc = scsi_3btoul(bytes);
1412 
1413 	if (rc & 0x00800000)
1414 		rc |= 0xff000000;
1415 
1416 	return (int32_t) rc;
1417 }
1418 
1419 static __inline u_int32_t
1420 scsi_4btoul(u_int8_t *bytes)
1421 {
1422 	u_int32_t rv;
1423 
1424 	rv = (bytes[0] << 24) |
1425 	     (bytes[1] << 16) |
1426 	     (bytes[2] << 8) |
1427 	     bytes[3];
1428 	return (rv);
1429 }
1430 
1431 /*
1432  * Given the pointer to a returned mode sense buffer, return a pointer to
1433  * the start of the first mode page.
1434  */
1435 static __inline void *
1436 find_mode_page_6(struct scsi_mode_header_6 *mode_header)
1437 {
1438 	void *page_start;
1439 
1440 	page_start = (void *)((u_int8_t *)&mode_header[1] +
1441 			      mode_header->blk_desc_len);
1442 
1443 	return(page_start);
1444 }
1445 
1446 static __inline void *
1447 find_mode_page_10(struct scsi_mode_header_10 *mode_header)
1448 {
1449 	void *page_start;
1450 
1451 	page_start = (void *)((u_int8_t *)&mode_header[1] +
1452 			       scsi_2btoul(mode_header->blk_desc_len));
1453 
1454 	return(page_start);
1455 }
1456 
1457 __END_DECLS
1458 
1459 #endif /*_SCSI_SCSI_ALL_H*/
1460