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