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/8.3/sys/cam/scsi/scsi_all.h 230015 2012-01-12 15:02:51Z 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
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 MAINTENANCE_IN 0xA3
609 #define MAINTENANCE_OUT 0xA4
610 #define MOVE_MEDIUM 0xA5
611 #define READ_12 0xA8
612 #define WRITE_12 0xAA
613 #define READ_ELEMENT_STATUS 0xB8
614 #define READ_CD 0xBE
615
616 /* Maintenance In Service Action Codes */
617 #define REPORT_IDENTIFYING_INFRMATION 0x05
618 #define REPORT_TARGET_PORT_GROUPS 0x0A
619 #define REPORT_ALIASES 0x0B
620 #define REPORT_SUPPORTED_OPERATION_CODES 0x0C
621 #define REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS 0x0D
622 #define REPORT_PRIORITY 0x0E
623 #define REPORT_TIMESTAMP 0x0F
624 #define MANAGEMENT_PROTOCOL_IN 0x10
625 /* Maintenance Out Service Action Codes */
626 #define SET_IDENTIFY_INFORMATION 0x06
627 #define SET_TARGET_PORT_GROUPS 0x0A
628 #define CHANGE_ALIASES 0x0B
629 #define SET_PRIORITY 0x0E
630 #define SET_TIMESTAMP 0x0F
631 #define MANGAEMENT_PROTOCOL_OUT 0x10
632
633 /*
634 * Device Types
635 */
636 #define T_DIRECT 0x00
637 #define T_SEQUENTIAL 0x01
638 #define T_PRINTER 0x02
639 #define T_PROCESSOR 0x03
640 #define T_WORM 0x04
641 #define T_CDROM 0x05
642 #define T_SCANNER 0x06
643 #define T_OPTICAL 0x07
644 #define T_CHANGER 0x08
645 #define T_COMM 0x09
646 #define T_ASC0 0x0a
647 #define T_ASC1 0x0b
648 #define T_STORARRAY 0x0c
649 #define T_ENCLOSURE 0x0d
650 #define T_RBC 0x0e
651 #define T_OCRW 0x0f
652 #define T_OSD 0x11
653 #define T_ADC 0x12
654 #define T_NODEVICE 0x1f
655 #define T_ANY 0xff /* Used in Quirk table matches */
656
657 #define T_REMOV 1
658 #define T_FIXED 0
659
660 /*
661 * This length is the initial inquiry length used by the probe code, as
662 * well as the legnth necessary for scsi_print_inquiry() to function
663 * correctly. If either use requires a different length in the future,
664 * the two values should be de-coupled.
665 */
666 #define SHORT_INQUIRY_LENGTH 36
667
668 struct scsi_inquiry_data
669 {
670 u_int8_t device;
671 #define SID_TYPE(inq_data) ((inq_data)->device & 0x1f)
672 #define SID_QUAL(inq_data) (((inq_data)->device & 0xE0) >> 5)
673 #define SID_QUAL_LU_CONNECTED 0x00 /*
674 * The specified peripheral device
675 * type is currently connected to
676 * logical unit. If the target cannot
677 * determine whether or not a physical
678 * device is currently connected, it
679 * shall also use this peripheral
680 * qualifier when returning the INQUIRY
681 * data. This peripheral qualifier
682 * does not mean that the device is
683 * ready for access by the initiator.
684 */
685 #define SID_QUAL_LU_OFFLINE 0x01 /*
686 * The target is capable of supporting
687 * the specified peripheral device type
688 * on this logical unit; however, the
689 * physical device is not currently
690 * connected to this logical unit.
691 */
692 #define SID_QUAL_RSVD 0x02
693 #define SID_QUAL_BAD_LU 0x03 /*
694 * The target is not capable of
695 * supporting a physical device on
696 * this logical unit. For this
697 * peripheral qualifier the peripheral
698 * device type shall be set to 1Fh to
699 * provide compatibility with previous
700 * versions of SCSI. All other
701 * peripheral device type values are
702 * reserved for this peripheral
703 * qualifier.
704 */
705 #define SID_QUAL_IS_VENDOR_UNIQUE(inq_data) ((SID_QUAL(inq_data) & 0x08) != 0)
706 u_int8_t dev_qual2;
707 #define SID_QUAL2 0x7F
708 #define SID_IS_REMOVABLE(inq_data) (((inq_data)->dev_qual2 & 0x80) != 0)
709 u_int8_t version;
710 #define SID_ANSI_REV(inq_data) ((inq_data)->version & 0x07)
711 #define SCSI_REV_0 0
712 #define SCSI_REV_CCS 1
713 #define SCSI_REV_2 2
714 #define SCSI_REV_SPC 3
715 #define SCSI_REV_SPC2 4
716 #define SCSI_REV_SPC3 5
717 #define SCSI_REV_SPC4 6
718
719 #define SID_ECMA 0x38
720 #define SID_ISO 0xC0
721 u_int8_t response_format;
722 #define SID_AENC 0x80
723 #define SID_TrmIOP 0x40
724 u_int8_t additional_length;
725 #define SID_ADDITIONAL_LENGTH(iqd) \
726 ((iqd)->additional_length + \
727 offsetof(struct scsi_inquiry_data, additional_length) + 1)
728 u_int8_t spc3_flags;
729 #define SPC3_SID_PROTECT 0x01
730 #define SPC3_SID_3PC 0x08
731 #define SPC3_SID_TPGS_MASK 0x30
732 #define SPC3_SID_TPGS_IMPLICIT 0x10
733 #define SPC3_SID_TPGS_EXPLICIT 0x20
734 #define SPC3_SID_ACC 0x40
735 #define SPC3_SID_SCCS 0x80
736 u_int8_t spc2_flags;
737 #define SPC2_SID_MChngr 0x08
738 #define SPC2_SID_MultiP 0x10
739 #define SPC2_SID_EncServ 0x40
740 #define SPC2_SID_BQueue 0x80
741
742 #define INQ_DATA_TQ_ENABLED(iqd) \
743 ((SID_ANSI_REV(iqd) < SCSI_REV_SPC2)? ((iqd)->flags & SID_CmdQue) : \
744 (((iqd)->flags & SID_CmdQue) && !((iqd)->spc2_flags & SPC2_SID_BQueue)) || \
745 (!((iqd)->flags & SID_CmdQue) && ((iqd)->spc2_flags & SPC2_SID_BQueue)))
746
747 u_int8_t flags;
748 #define SID_SftRe 0x01
749 #define SID_CmdQue 0x02
750 #define SID_Linked 0x08
751 #define SID_Sync 0x10
752 #define SID_WBus16 0x20
753 #define SID_WBus32 0x40
754 #define SID_RelAdr 0x80
755 #define SID_VENDOR_SIZE 8
756 char vendor[SID_VENDOR_SIZE];
757 #define SID_PRODUCT_SIZE 16
758 char product[SID_PRODUCT_SIZE];
759 #define SID_REVISION_SIZE 4
760 char revision[SID_REVISION_SIZE];
761 /*
762 * The following fields were taken from SCSI Primary Commands - 2
763 * (SPC-2) Revision 14, Dated 11 November 1999
764 */
765 #define SID_VENDOR_SPECIFIC_0_SIZE 20
766 u_int8_t vendor_specific0[SID_VENDOR_SPECIFIC_0_SIZE];
767 /*
768 * An extension of SCSI Parallel Specific Values
769 */
770 #define SID_SPI_IUS 0x01
771 #define SID_SPI_QAS 0x02
772 #define SID_SPI_CLOCK_ST 0x00
773 #define SID_SPI_CLOCK_DT 0x04
774 #define SID_SPI_CLOCK_DT_ST 0x0C
775 #define SID_SPI_MASK 0x0F
776 u_int8_t spi3data;
777 u_int8_t reserved2;
778 /*
779 * Version Descriptors, stored 2 byte values.
780 */
781 u_int8_t version1[2];
782 u_int8_t version2[2];
783 u_int8_t version3[2];
784 u_int8_t version4[2];
785 u_int8_t version5[2];
786 u_int8_t version6[2];
787 u_int8_t version7[2];
788 u_int8_t version8[2];
789
790 u_int8_t reserved3[22];
791
792 #define SID_VENDOR_SPECIFIC_1_SIZE 160
793 u_int8_t vendor_specific1[SID_VENDOR_SPECIFIC_1_SIZE];
794 };
795
796 struct scsi_vpd_supported_page_list
797 {
798 u_int8_t device;
799 u_int8_t page_code;
800 #define SVPD_SUPPORTED_PAGE_LIST 0x00
801 u_int8_t reserved;
802 u_int8_t length; /* number of VPD entries */
803 #define SVPD_SUPPORTED_PAGES_SIZE 251
804 u_int8_t list[SVPD_SUPPORTED_PAGES_SIZE];
805 };
806
807 struct scsi_vpd_unit_serial_number
808 {
809 u_int8_t device;
810 u_int8_t page_code;
811 #define SVPD_UNIT_SERIAL_NUMBER 0x80
812 u_int8_t reserved;
813 u_int8_t length; /* serial number length */
814 #define SVPD_SERIAL_NUM_SIZE 251
815 u_int8_t serial_num[SVPD_SERIAL_NUM_SIZE];
816 };
817
818 struct scsi_read_capacity
819 {
820 u_int8_t opcode;
821 u_int8_t byte2;
822 u_int8_t addr[4];
823 u_int8_t unused[3];
824 u_int8_t control;
825 };
826
827 struct scsi_read_capacity_16
828 {
829 uint8_t opcode;
830 #define SRC16_SERVICE_ACTION 0x10
831 uint8_t service_action;
832 uint8_t addr[8];
833 uint8_t alloc_len[4];
834 #define SRC16_PMI 0x01
835 #define SRC16_RELADR 0x02
836 uint8_t reladr;
837 uint8_t control;
838 };
839
840 struct scsi_read_capacity_data
841 {
842 u_int8_t addr[4];
843 u_int8_t length[4];
844 };
845
846 struct scsi_read_capacity_data_long
847 {
848 uint8_t addr[8];
849 uint8_t length[4];
850 };
851
852 struct scsi_report_luns
853 {
854 uint8_t opcode;
855 uint8_t reserved1;
856 #define RPL_REPORT_DEFAULT 0x00
857 #define RPL_REPORT_WELLKNOWN 0x01
858 #define RPL_REPORT_ALL 0x02
859 uint8_t select_report;
860 uint8_t reserved2[3];
861 uint8_t length[4];
862 uint8_t reserved3;
863 uint8_t control;
864 };
865
866 struct scsi_report_luns_data {
867 u_int8_t length[4]; /* length of LUN inventory, in bytes */
868 u_int8_t reserved[4]; /* unused */
869 /*
870 * LUN inventory- we only support the type zero form for now.
871 */
872 struct {
873 u_int8_t lundata[8];
874 } luns[0];
875 };
876 #define RPL_LUNDATA_PERIPH_BUS_MASK 0x3f
877 #define RPL_LUNDATA_FLAT_LUN_MASK 0x3f
878 #define RPL_LUNDATA_LUN_TARG_MASK 0x3f
879 #define RPL_LUNDATA_LUN_BUS_MASK 0xe0
880 #define RPL_LUNDATA_LUN_LUN_MASK 0x1f
881 #define RPL_LUNDATA_EXT_LEN_MASK 0x30
882 #define RPL_LUNDATA_EXT_EAM_MASK 0x0f
883 #define RPL_LUNDATA_EXT_EAM_WK 0x01
884 #define RPL_LUNDATA_EXT_EAM_NOT_SPEC 0x0f
885 #define RPL_LUNDATA_ATYP_MASK 0xc0 /* MBZ for type 0 lun */
886 #define RPL_LUNDATA_ATYP_PERIPH 0x00
887 #define RPL_LUNDATA_ATYP_FLAT 0x40
888 #define RPL_LUNDATA_ATYP_LUN 0x80
889 #define RPL_LUNDATA_ATYP_EXTLUN 0xc0
890
891 struct scsi_target_group
892 {
893 uint8_t opcode;
894 uint8_t service_action;
895 #define STG_PDF_LENGTH 0x00
896 #define RPL_PDF_EXTENDED 0x20
897 uint8_t reserved1[4];
898 uint8_t length[4];
899 uint8_t reserved2;
900 uint8_t control;
901 };
902
903 struct scsi_target_port_descriptor {
904 uint8_t reserved[2];
905 uint8_t relative_target_port_identifier[2];
906 uint8_t desc_list[];
907 };
908
909 struct scsi_target_port_group_descriptor {
910 uint8_t pref_state;
911 #define TPG_PRIMARY 0x80
912 #define TPG_ASYMMETRIC_ACCESS_STATE_MASK 0xf
913 #define TPG_ASYMMETRIC_ACCESS_OPTIMIZED 0x0
914 #define TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED 0x1
915 #define TPG_ASYMMETRIC_ACCESS_STANDBY 0x2
916 #define TPG_ASYMMETRIC_ACCESS_UNAVAILABLE 0x3
917 #define TPG_ASYMMETRIC_ACCESS_LBA_DEPENDENT 0x4
918 #define TPG_ASYMMETRIC_ACCESS_OFFLINE 0xE
919 #define TPG_ASYMMETRIC_ACCESS_TRANSITIONING 0xF
920 uint8_t support;
921 #define TPG_AO_SUP 0x01
922 #define TPG_AN_SUP 0x02
923 #define TPG_S_SUP 0x04
924 #define TPG_U_SUP 0x08
925 #define TPG_LBD_SUP 0x10
926 #define TPG_O_SUP 0x40
927 #define TPG_T_SUP 0x80
928 uint8_t target_port_group[2];
929 uint8_t reserved;
930 uint8_t status;
931 uint8_t vendor_specific;
932 uint8_t target_port_count;
933 struct scsi_target_port_descriptor descriptors[];
934 };
935
936 struct scsi_target_group_data {
937 uint8_t length[4]; /* length of returned data, in bytes */
938 struct scsi_target_port_group_descriptor groups[];
939 };
940
941 struct scsi_target_group_data_extended {
942 uint8_t length[4]; /* length of returned data, in bytes */
943 uint8_t format_type; /* STG_PDF_LENGTH or RPL_PDF_EXTENDED */
944 uint8_t implicit_transition_time;
945 uint8_t reserved[2];
946 struct scsi_target_port_group_descriptor groups[];
947 };
948
949
950 struct scsi_sense_data
951 {
952 u_int8_t error_code;
953 #define SSD_ERRCODE 0x7F
954 #define SSD_CURRENT_ERROR 0x70
955 #define SSD_DEFERRED_ERROR 0x71
956 #define SSD_ERRCODE_VALID 0x80
957 u_int8_t segment;
958 u_int8_t flags;
959 #define SSD_KEY 0x0F
960 #define SSD_KEY_NO_SENSE 0x00
961 #define SSD_KEY_RECOVERED_ERROR 0x01
962 #define SSD_KEY_NOT_READY 0x02
963 #define SSD_KEY_MEDIUM_ERROR 0x03
964 #define SSD_KEY_HARDWARE_ERROR 0x04
965 #define SSD_KEY_ILLEGAL_REQUEST 0x05
966 #define SSD_KEY_UNIT_ATTENTION 0x06
967 #define SSD_KEY_DATA_PROTECT 0x07
968 #define SSD_KEY_BLANK_CHECK 0x08
969 #define SSD_KEY_Vendor_Specific 0x09
970 #define SSD_KEY_COPY_ABORTED 0x0a
971 #define SSD_KEY_ABORTED_COMMAND 0x0b
972 #define SSD_KEY_EQUAL 0x0c
973 #define SSD_KEY_VOLUME_OVERFLOW 0x0d
974 #define SSD_KEY_MISCOMPARE 0x0e
975 #define SSD_KEY_RESERVED 0x0f
976 #define SSD_ILI 0x20
977 #define SSD_EOM 0x40
978 #define SSD_FILEMARK 0x80
979 u_int8_t info[4];
980 u_int8_t extra_len;
981 u_int8_t cmd_spec_info[4];
982 u_int8_t add_sense_code;
983 u_int8_t add_sense_code_qual;
984 u_int8_t fru;
985 u_int8_t sense_key_spec[3];
986 #define SSD_SCS_VALID 0x80
987 #define SSD_FIELDPTR_CMD 0x40
988 #define SSD_BITPTR_VALID 0x08
989 #define SSD_BITPTR_VALUE 0x07
990 #define SSD_MIN_SIZE 18
991 u_int8_t extra_bytes[14];
992 #define SSD_FULL_SIZE sizeof(struct scsi_sense_data)
993 };
994
995 struct scsi_mode_header_6
996 {
997 u_int8_t data_length; /* Sense data length */
998 u_int8_t medium_type;
999 u_int8_t dev_spec;
1000 u_int8_t blk_desc_len;
1001 };
1002
1003 struct scsi_mode_header_10
1004 {
1005 u_int8_t data_length[2];/* Sense data length */
1006 u_int8_t medium_type;
1007 u_int8_t dev_spec;
1008 u_int8_t unused[2];
1009 u_int8_t blk_desc_len[2];
1010 };
1011
1012 struct scsi_mode_page_header
1013 {
1014 u_int8_t page_code;
1015 u_int8_t page_length;
1016 };
1017
1018 struct scsi_mode_blk_desc
1019 {
1020 u_int8_t density;
1021 u_int8_t nblocks[3];
1022 u_int8_t reserved;
1023 u_int8_t blklen[3];
1024 };
1025
1026 #define SCSI_DEFAULT_DENSITY 0x00 /* use 'default' density */
1027 #define SCSI_SAME_DENSITY 0x7f /* use 'same' density- >= SCSI-2 only */
1028
1029
1030 /*
1031 * Status Byte
1032 */
1033 #define SCSI_STATUS_OK 0x00
1034 #define SCSI_STATUS_CHECK_COND 0x02
1035 #define SCSI_STATUS_COND_MET 0x04
1036 #define SCSI_STATUS_BUSY 0x08
1037 #define SCSI_STATUS_INTERMED 0x10
1038 #define SCSI_STATUS_INTERMED_COND_MET 0x14
1039 #define SCSI_STATUS_RESERV_CONFLICT 0x18
1040 #define SCSI_STATUS_CMD_TERMINATED 0x22 /* Obsolete in SAM-2 */
1041 #define SCSI_STATUS_QUEUE_FULL 0x28
1042 #define SCSI_STATUS_ACA_ACTIVE 0x30
1043 #define SCSI_STATUS_TASK_ABORTED 0x40
1044
1045 struct scsi_inquiry_pattern {
1046 u_int8_t type;
1047 u_int8_t media_type;
1048 #define SIP_MEDIA_REMOVABLE 0x01
1049 #define SIP_MEDIA_FIXED 0x02
1050 const char *vendor;
1051 const char *product;
1052 const char *revision;
1053 };
1054
1055 struct scsi_static_inquiry_pattern {
1056 u_int8_t type;
1057 u_int8_t media_type;
1058 char vendor[SID_VENDOR_SIZE+1];
1059 char product[SID_PRODUCT_SIZE+1];
1060 char revision[SID_REVISION_SIZE+1];
1061 };
1062
1063 struct scsi_sense_quirk_entry {
1064 struct scsi_inquiry_pattern inq_pat;
1065 int num_sense_keys;
1066 int num_ascs;
1067 struct sense_key_table_entry *sense_key_info;
1068 struct asc_table_entry *asc_info;
1069 };
1070
1071 struct sense_key_table_entry {
1072 u_int8_t sense_key;
1073 u_int32_t action;
1074 const char *desc;
1075 };
1076
1077 struct asc_table_entry {
1078 u_int8_t asc;
1079 u_int8_t ascq;
1080 u_int32_t action;
1081 const char *desc;
1082 };
1083
1084 struct op_table_entry {
1085 u_int8_t opcode;
1086 u_int32_t opmask;
1087 const char *desc;
1088 };
1089
1090 struct scsi_op_quirk_entry {
1091 struct scsi_inquiry_pattern inq_pat;
1092 int num_ops;
1093 struct op_table_entry *op_table;
1094 };
1095
1096 typedef enum {
1097 SSS_FLAG_NONE = 0x00,
1098 SSS_FLAG_PRINT_COMMAND = 0x01
1099 } scsi_sense_string_flags;
1100
1101 struct ccb_scsiio;
1102 struct cam_periph;
1103 union ccb;
1104 #ifndef _KERNEL
1105 struct cam_device;
1106 #endif
1107
1108 extern const char *scsi_sense_key_text[];
1109
1110 struct sbuf;
1111
1112 __BEGIN_DECLS
1113 void scsi_sense_desc(int sense_key, int asc, int ascq,
1114 struct scsi_inquiry_data *inq_data,
1115 const char **sense_key_desc, const char **asc_desc);
1116 scsi_sense_action scsi_error_action(struct ccb_scsiio* csio,
1117 struct scsi_inquiry_data *inq_data,
1118 u_int32_t sense_flags);
1119 const char * scsi_status_string(struct ccb_scsiio *csio);
1120 #ifdef _KERNEL
1121 int scsi_command_string(struct ccb_scsiio *csio, struct sbuf *sb);
1122 int scsi_sense_sbuf(struct ccb_scsiio *csio, struct sbuf *sb,
1123 scsi_sense_string_flags flags);
1124 char * scsi_sense_string(struct ccb_scsiio *csio,
1125 char *str, int str_len);
1126 void scsi_sense_print(struct ccb_scsiio *csio);
1127 int scsi_interpret_sense(union ccb *ccb,
1128 u_int32_t sense_flags,
1129 u_int32_t *relsim_flags,
1130 u_int32_t *reduction,
1131 u_int32_t *timeout,
1132 scsi_sense_action error_action);
1133 #else /* _KERNEL */
1134 int scsi_command_string(struct cam_device *device,
1135 struct ccb_scsiio *csio, struct sbuf *sb);
1136 int scsi_sense_sbuf(struct cam_device *device,
1137 struct ccb_scsiio *csio, struct sbuf *sb,
1138 scsi_sense_string_flags flags);
1139 char * scsi_sense_string(struct cam_device *device,
1140 struct ccb_scsiio *csio,
1141 char *str, int str_len);
1142 void scsi_sense_print(struct cam_device *device,
1143 struct ccb_scsiio *csio, FILE *ofile);
1144 int scsi_interpret_sense(struct cam_device *device,
1145 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 #endif /* _KERNEL */
1152
1153 #define SF_RETRY_UA 0x01
1154 #define SF_NO_PRINT 0x02
1155 #define SF_QUIET_IR 0x04 /* Be quiet about Illegal Request reponses */
1156 #define SF_PRINT_ALWAYS 0x08
1157
1158
1159 const char * scsi_op_desc(u_int16_t opcode,
1160 struct scsi_inquiry_data *inq_data);
1161 char * scsi_cdb_string(u_int8_t *cdb_ptr, char *cdb_string,
1162 size_t len);
1163
1164 void scsi_print_inquiry(struct scsi_inquiry_data *inq_data);
1165
1166 u_int scsi_calc_syncsrate(u_int period_factor);
1167 u_int scsi_calc_syncparam(u_int period);
1168
1169 void scsi_test_unit_ready(struct ccb_scsiio *csio, u_int32_t retries,
1170 void (*cbfcnp)(struct cam_periph *,
1171 union ccb *),
1172 u_int8_t tag_action,
1173 u_int8_t sense_len, u_int32_t timeout);
1174
1175 void scsi_request_sense(struct ccb_scsiio *csio, u_int32_t retries,
1176 void (*cbfcnp)(struct cam_periph *,
1177 union ccb *),
1178 void *data_ptr, u_int8_t dxfer_len,
1179 u_int8_t tag_action, u_int8_t sense_len,
1180 u_int32_t timeout);
1181
1182 void scsi_inquiry(struct ccb_scsiio *csio, u_int32_t retries,
1183 void (*cbfcnp)(struct cam_periph *, union ccb *),
1184 u_int8_t tag_action, u_int8_t *inq_buf,
1185 u_int32_t inq_len, int evpd, u_int8_t page_code,
1186 u_int8_t sense_len, u_int32_t timeout);
1187
1188 void scsi_mode_sense(struct ccb_scsiio *csio, u_int32_t retries,
1189 void (*cbfcnp)(struct cam_periph *,
1190 union ccb *),
1191 u_int8_t tag_action, int dbd,
1192 u_int8_t page_code, u_int8_t page,
1193 u_int8_t *param_buf, u_int32_t param_len,
1194 u_int8_t sense_len, u_int32_t timeout);
1195
1196 void scsi_mode_sense_len(struct ccb_scsiio *csio, u_int32_t retries,
1197 void (*cbfcnp)(struct cam_periph *,
1198 union ccb *),
1199 u_int8_t tag_action, int dbd,
1200 u_int8_t page_code, u_int8_t page,
1201 u_int8_t *param_buf, u_int32_t param_len,
1202 int minimum_cmd_size, u_int8_t sense_len,
1203 u_int32_t timeout);
1204
1205 void scsi_mode_select(struct ccb_scsiio *csio, u_int32_t retries,
1206 void (*cbfcnp)(struct cam_periph *,
1207 union ccb *),
1208 u_int8_t tag_action, int scsi_page_fmt,
1209 int save_pages, u_int8_t *param_buf,
1210 u_int32_t param_len, u_int8_t sense_len,
1211 u_int32_t timeout);
1212
1213 void scsi_mode_select_len(struct ccb_scsiio *csio, u_int32_t retries,
1214 void (*cbfcnp)(struct cam_periph *,
1215 union ccb *),
1216 u_int8_t tag_action, int scsi_page_fmt,
1217 int save_pages, u_int8_t *param_buf,
1218 u_int32_t param_len, int minimum_cmd_size,
1219 u_int8_t sense_len, u_int32_t timeout);
1220
1221 void scsi_log_sense(struct ccb_scsiio *csio, u_int32_t retries,
1222 void (*cbfcnp)(struct cam_periph *, union ccb *),
1223 u_int8_t tag_action, u_int8_t page_code,
1224 u_int8_t page, int save_pages, int ppc,
1225 u_int32_t paramptr, u_int8_t *param_buf,
1226 u_int32_t param_len, u_int8_t sense_len,
1227 u_int32_t timeout);
1228
1229 void scsi_log_select(struct ccb_scsiio *csio, u_int32_t retries,
1230 void (*cbfcnp)(struct cam_periph *,
1231 union ccb *), u_int8_t tag_action,
1232 u_int8_t page_code, int save_pages,
1233 int pc_reset, u_int8_t *param_buf,
1234 u_int32_t param_len, u_int8_t sense_len,
1235 u_int32_t timeout);
1236
1237 void scsi_prevent(struct ccb_scsiio *csio, u_int32_t retries,
1238 void (*cbfcnp)(struct cam_periph *, union ccb *),
1239 u_int8_t tag_action, u_int8_t action,
1240 u_int8_t sense_len, u_int32_t timeout);
1241
1242 void scsi_read_capacity(struct ccb_scsiio *csio, u_int32_t retries,
1243 void (*cbfcnp)(struct cam_periph *,
1244 union ccb *), u_int8_t tag_action,
1245 struct scsi_read_capacity_data *,
1246 u_int8_t sense_len, u_int32_t timeout);
1247 void scsi_read_capacity_16(struct ccb_scsiio *csio, uint32_t retries,
1248 void (*cbfcnp)(struct cam_periph *,
1249 union ccb *), uint8_t tag_action,
1250 uint64_t lba, int reladr, int pmi,
1251 struct scsi_read_capacity_data_long
1252 *rcap_buf, uint8_t sense_len,
1253 uint32_t timeout);
1254
1255 void scsi_report_luns(struct ccb_scsiio *csio, u_int32_t retries,
1256 void (*cbfcnp)(struct cam_periph *,
1257 union ccb *), u_int8_t tag_action,
1258 u_int8_t select_report,
1259 struct scsi_report_luns_data *rpl_buf,
1260 u_int32_t alloc_len, u_int8_t sense_len,
1261 u_int32_t timeout);
1262
1263 void scsi_report_target_group(struct ccb_scsiio *csio, u_int32_t retries,
1264 void (*cbfcnp)(struct cam_periph *,
1265 union ccb *), u_int8_t tag_action,
1266 u_int8_t pdf,
1267 void *buf,
1268 u_int32_t alloc_len, u_int8_t sense_len,
1269 u_int32_t timeout);
1270
1271 void scsi_set_target_group(struct ccb_scsiio *csio, u_int32_t retries,
1272 void (*cbfcnp)(struct cam_periph *,
1273 union ccb *), u_int8_t tag_action, void *buf,
1274 u_int32_t alloc_len, u_int8_t sense_len,
1275 u_int32_t timeout);
1276
1277 void scsi_synchronize_cache(struct ccb_scsiio *csio,
1278 u_int32_t retries,
1279 void (*cbfcnp)(struct cam_periph *,
1280 union ccb *), u_int8_t tag_action,
1281 u_int32_t begin_lba, u_int16_t lb_count,
1282 u_int8_t sense_len, u_int32_t timeout);
1283
1284 void scsi_read_write(struct ccb_scsiio *csio, u_int32_t retries,
1285 void (*cbfcnp)(struct cam_periph *, union ccb *),
1286 u_int8_t tag_action, int readop, u_int8_t byte2,
1287 int minimum_cmd_size, u_int64_t lba,
1288 u_int32_t block_count, u_int8_t *data_ptr,
1289 u_int32_t dxfer_len, u_int8_t sense_len,
1290 u_int32_t timeout);
1291
1292 void scsi_start_stop(struct ccb_scsiio *csio, u_int32_t retries,
1293 void (*cbfcnp)(struct cam_periph *, union ccb *),
1294 u_int8_t tag_action, int start, int load_eject,
1295 int immediate, u_int8_t sense_len, u_int32_t timeout);
1296
1297 int scsi_inquiry_match(caddr_t inqbuffer, caddr_t table_entry);
1298 int scsi_static_inquiry_match(caddr_t inqbuffer,
1299 caddr_t table_entry);
1300
1301 static __inline void scsi_extract_sense(struct scsi_sense_data *sense,
1302 int *error_code, int *sense_key,
1303 int *asc, int *ascq);
1304 static __inline void scsi_ulto2b(u_int32_t val, u_int8_t *bytes);
1305 static __inline void scsi_ulto3b(u_int32_t val, u_int8_t *bytes);
1306 static __inline void scsi_ulto4b(u_int32_t val, u_int8_t *bytes);
1307 static __inline void scsi_u64to8b(u_int64_t val, u_int8_t *bytes);
1308 static __inline u_int32_t scsi_2btoul(u_int8_t *bytes);
1309 static __inline u_int32_t scsi_3btoul(u_int8_t *bytes);
1310 static __inline int32_t scsi_3btol(u_int8_t *bytes);
1311 static __inline u_int32_t scsi_4btoul(u_int8_t *bytes);
1312 static __inline u_int64_t scsi_8btou64(u_int8_t *bytes);
1313 static __inline void *find_mode_page_6(struct scsi_mode_header_6 *mode_header);
1314 static __inline void *find_mode_page_10(struct scsi_mode_header_10 *mode_header);
1315
1316 static __inline void scsi_extract_sense(struct scsi_sense_data *sense,
1317 int *error_code, int *sense_key,
1318 int *asc, int *ascq)
1319 {
1320 *error_code = sense->error_code & SSD_ERRCODE;
1321 *sense_key = sense->flags & SSD_KEY;
1322 *asc = (sense->extra_len >= 5) ? sense->add_sense_code : 0;
1323 *ascq = (sense->extra_len >= 6) ? sense->add_sense_code_qual : 0;
1324 }
1325
1326 static __inline void
1327 scsi_ulto2b(u_int32_t val, u_int8_t *bytes)
1328 {
1329
1330 bytes[0] = (val >> 8) & 0xff;
1331 bytes[1] = val & 0xff;
1332 }
1333
1334 static __inline void
1335 scsi_ulto3b(u_int32_t val, u_int8_t *bytes)
1336 {
1337
1338 bytes[0] = (val >> 16) & 0xff;
1339 bytes[1] = (val >> 8) & 0xff;
1340 bytes[2] = val & 0xff;
1341 }
1342
1343 static __inline void
1344 scsi_ulto4b(u_int32_t val, u_int8_t *bytes)
1345 {
1346
1347 bytes[0] = (val >> 24) & 0xff;
1348 bytes[1] = (val >> 16) & 0xff;
1349 bytes[2] = (val >> 8) & 0xff;
1350 bytes[3] = val & 0xff;
1351 }
1352
1353 static __inline void
1354 scsi_u64to8b(u_int64_t val, u_int8_t *bytes)
1355 {
1356
1357 bytes[0] = (val >> 56) & 0xff;
1358 bytes[1] = (val >> 48) & 0xff;
1359 bytes[2] = (val >> 40) & 0xff;
1360 bytes[3] = (val >> 32) & 0xff;
1361 bytes[4] = (val >> 24) & 0xff;
1362 bytes[5] = (val >> 16) & 0xff;
1363 bytes[6] = (val >> 8) & 0xff;
1364 bytes[7] = val & 0xff;
1365 }
1366
1367 static __inline u_int32_t
1368 scsi_2btoul(u_int8_t *bytes)
1369 {
1370 u_int32_t rv;
1371
1372 rv = (bytes[0] << 8) |
1373 bytes[1];
1374 return (rv);
1375 }
1376
1377 static __inline u_int32_t
1378 scsi_3btoul(u_int8_t *bytes)
1379 {
1380 u_int32_t rv;
1381
1382 rv = (bytes[0] << 16) |
1383 (bytes[1] << 8) |
1384 bytes[2];
1385 return (rv);
1386 }
1387
1388 static __inline int32_t
1389 scsi_3btol(u_int8_t *bytes)
1390 {
1391 u_int32_t rc = scsi_3btoul(bytes);
1392
1393 if (rc & 0x00800000)
1394 rc |= 0xff000000;
1395
1396 return (int32_t) rc;
1397 }
1398
1399 static __inline u_int32_t
1400 scsi_4btoul(u_int8_t *bytes)
1401 {
1402 u_int32_t rv;
1403
1404 rv = (bytes[0] << 24) |
1405 (bytes[1] << 16) |
1406 (bytes[2] << 8) |
1407 bytes[3];
1408 return (rv);
1409 }
1410
1411 static __inline uint64_t
1412 scsi_8btou64(uint8_t *bytes)
1413 {
1414 uint64_t rv;
1415
1416 rv = (((uint64_t)bytes[0]) << 56) |
1417 (((uint64_t)bytes[1]) << 48) |
1418 (((uint64_t)bytes[2]) << 40) |
1419 (((uint64_t)bytes[3]) << 32) |
1420 (((uint64_t)bytes[4]) << 24) |
1421 (((uint64_t)bytes[5]) << 16) |
1422 (((uint64_t)bytes[6]) << 8) |
1423 bytes[7];
1424 return (rv);
1425 }
1426
1427 /*
1428 * Given the pointer to a returned mode sense buffer, return a pointer to
1429 * the start of the first mode page.
1430 */
1431 static __inline void *
1432 find_mode_page_6(struct scsi_mode_header_6 *mode_header)
1433 {
1434 void *page_start;
1435
1436 page_start = (void *)((u_int8_t *)&mode_header[1] +
1437 mode_header->blk_desc_len);
1438
1439 return(page_start);
1440 }
1441
1442 static __inline void *
1443 find_mode_page_10(struct scsi_mode_header_10 *mode_header)
1444 {
1445 void *page_start;
1446
1447 page_start = (void *)((u_int8_t *)&mode_header[1] +
1448 scsi_2btoul(mode_header->blk_desc_len));
1449
1450 return(page_start);
1451 }
1452
1453 __END_DECLS
1454
1455 #endif /*_SCSI_SCSI_ALL_H*/
Cache object: c16fe6b3da155bcb8234c533ad7d191a
|