4 * Home page of code is: http://smartmontools.sourceforge.net
6 * Copyright (C) 2002-8 Bruce Allen <smartmontools-support@lists.sourceforge.net>
7 * Copyright (C) 1999-2000 Michael Cornwell <cornwell@acm.org>
9 * Additional SCSI work:
10 * Copyright (C) 2003-13 Douglas Gilbert <dgilbert@interlog.com>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2, or (at your option)
17 * You should have received a copy of the GNU General Public License
18 * (for example COPYING); If not, see <http://www.gnu.org/licenses/>.
20 * This code was originally developed as a Senior Thesis by Michael Cornwell
21 * at the Concurrent Systems Laboratory (now part of the Storage Systems
22 * Research Center), Jack Baskin School of Engineering, University of
23 * California, Santa Cruz. http://ssrc.soe.ucsc.edu/
26 * In the SCSI world "SMART" is a dead or withdrawn standard. In recent
27 * SCSI standards (since SCSI-3) it goes under the awkward name of
28 * "Informational Exceptions" ["IE" or "IEC" (with the "C" for "control")].
29 * The relevant information is spread around several SCSI draft
30 * standards available at http://www.t10.org . Reference is made in the
31 * code to the following acronyms:
32 * - SAM [SCSI Architectural model, versions 2 or 3]
33 * - SPC [SCSI Primary commands, versions 2 or 3]
34 * - SBC [SCSI Block commands, versions 2]
36 * Some SCSI disk vendors have snippets of "SMART" information in their
48 #include "atacmds.h" // FIXME: for smart_command_set only
49 #include "dev_interface.h"
52 const char *scsicmds_c_cvsid
="$Id: scsicmds.cpp 3915 2014-06-19 18:24:57Z dpgilbert $"
55 // Print SCSI debug messages?
56 unsigned char scsi_debugmode
= 0;
58 supported_vpd_pages
* supported_vpd_pages_p
= NULL
;
61 supported_vpd_pages::supported_vpd_pages(scsi_device
* device
) : num_valid(0)
63 unsigned char b
[0xfc]; /* pre SPC-3 INQUIRY max response size */
66 memset(b
, 0, sizeof(b
));
67 if (device
&& (0 == scsiInquiryVpd(device
, SCSI_VPD_SUPPORTED_VPD_PAGES
,
69 num_valid
= (b
[2] << 8) + b
[3];
73 memcpy(pages
, b
+ 4, num_valid
);
78 supported_vpd_pages::is_supported(int vpd_page_num
) const
80 /* Supported VPD pages numbers start at offset 4 and should be in
81 * ascending order but don't assume that. */
82 for (int k
= 0; k
< num_valid
; ++k
) {
83 if (vpd_page_num
== pages
[k
])
89 /* output binary in hex and optionally ascii */
91 dStrHex(const char* str
, int len
, int no_ascii
)
97 const int bpstart
= 5;
98 const int cpstart
= 60;
103 if (len
<= 0) return;
106 k
= snprintf(buff
+1, sizeof(buff
)-1, "%.2x", a
);
108 if (bpos
>= ((bpstart
+ (9 * 3))))
111 for(i
= 0; i
< len
; i
++)
115 if (bpos
== (bpstart
+ (9 * 3)))
117 snprintf(buff
+bpos
, sizeof(buff
)-bpos
, "%.2x", (int)(unsigned char)c
);
118 buff
[bpos
+ 2] = ' ';
122 if ((c
< ' ') || (c
>= 0x7f))
126 if (cpos
> (cpstart
+15))
133 k
= snprintf(buff
+1, sizeof(buff
)-1, "%.2x", a
);
143 struct scsi_opcode_name
{
148 static struct scsi_opcode_name opcode_name_arr
[] = {
149 /* in ascending opcode order */
150 {TEST_UNIT_READY
, "test unit ready"}, /* 0x00 */
151 {REQUEST_SENSE
, "request sense"}, /* 0x03 */
152 {INQUIRY
, "inquiry"}, /* 0x12 */
153 {MODE_SELECT
, "mode select(6)"}, /* 0x15 */
154 {MODE_SENSE
, "mode sense(6)"}, /* 0x1a */
155 {START_STOP_UNIT
, "start stop unit"}, /* 0x1b */
156 {RECEIVE_DIAGNOSTIC
, "receive diagnostic"}, /* 0x1c */
157 {SEND_DIAGNOSTIC
, "send diagnostic"}, /* 0x1d */
158 {READ_CAPACITY_10
, "read capacity(10)"}, /* 0x25 */
159 {READ_DEFECT_10
, "read defect list(10)"}, /* 0x37 */
160 {LOG_SELECT
, "log select"}, /* 0x4c */
161 {LOG_SENSE
, "log sense"}, /* 0x4d */
162 {MODE_SELECT_10
, "mode select(10)"}, /* 0x55 */
163 {MODE_SENSE_10
, "mode sense(10)"}, /* 0x5a */
164 {SAT_ATA_PASSTHROUGH_16
, "ata pass-through(16)"}, /* 0x85 */
165 {READ_CAPACITY_16
, "read capacity(16)"}, /* 0x9e,0x10 */
166 {REPORT_LUNS
, "report luns"}, /* 0xa0 */
167 {SAT_ATA_PASSTHROUGH_12
, "ata pass-through(12)"}, /* 0xa1 */
168 {READ_DEFECT_12
, "read defect list(12)"}, /* 0xb7 */
171 static const char * vendor_specific
= "<vendor specific>";
173 /* Need to expand to take service action into account. For commands
174 * of interest the service action is in the 2nd command byte */
176 scsi_get_opcode_name(UINT8 opcode
)
179 int len
= sizeof(opcode_name_arr
) / sizeof(opcode_name_arr
[0]);
180 struct scsi_opcode_name
* onp
;
183 return vendor_specific
;
184 for (k
= 0; k
< len
; ++k
) {
185 onp
= &opcode_name_arr
[k
];
186 if (opcode
== onp
->opcode
)
188 else if (opcode
< onp
->opcode
)
195 scsi_do_sense_disect(const struct scsi_cmnd_io
* io_buf
,
196 struct scsi_sense_disect
* out
)
200 memset(out
, 0, sizeof(struct scsi_sense_disect
));
201 if (SCSI_STATUS_CHECK_CONDITION
== io_buf
->scsi_status
) {
202 resp_code
= (io_buf
->sensep
[0] & 0x7f);
203 out
->resp_code
= resp_code
;
204 if (resp_code
>= 0x72) {
205 out
->sense_key
= (io_buf
->sensep
[1] & 0xf);
206 out
->asc
= io_buf
->sensep
[2];
207 out
->ascq
= io_buf
->sensep
[3];
208 } else if (resp_code
>= 0x70) {
209 out
->sense_key
= (io_buf
->sensep
[2] & 0xf);
210 if (io_buf
->resp_sense_len
> 13) {
211 out
->asc
= io_buf
->sensep
[12];
212 out
->ascq
= io_buf
->sensep
[13];
219 scsiSimpleSenseFilter(const struct scsi_sense_disect
* sinfo
)
221 switch (sinfo
->sense_key
) {
222 case SCSI_SK_NO_SENSE
:
223 case SCSI_SK_RECOVERED_ERR
:
224 return SIMPLE_NO_ERROR
;
225 case SCSI_SK_NOT_READY
:
226 if (SCSI_ASC_NO_MEDIUM
== sinfo
->asc
)
227 return SIMPLE_ERR_NO_MEDIUM
;
228 else if (SCSI_ASC_NOT_READY
== sinfo
->asc
) {
229 if (0x1 == sinfo
->ascq
)
230 return SIMPLE_ERR_BECOMING_READY
;
232 return SIMPLE_ERR_NOT_READY
;
234 return SIMPLE_ERR_NOT_READY
;
235 case SCSI_SK_MEDIUM_ERROR
:
236 case SCSI_SK_HARDWARE_ERROR
:
237 return SIMPLE_ERR_MEDIUM_HARDWARE
;
238 case SCSI_SK_ILLEGAL_REQUEST
:
239 if (SCSI_ASC_UNKNOWN_OPCODE
== sinfo
->asc
)
240 return SIMPLE_ERR_BAD_OPCODE
;
241 else if (SCSI_ASC_INVALID_FIELD
== sinfo
->asc
)
242 return SIMPLE_ERR_BAD_FIELD
;
243 else if (SCSI_ASC_UNKNOWN_PARAM
== sinfo
->asc
)
244 return SIMPLE_ERR_BAD_PARAM
;
246 return SIMPLE_ERR_BAD_PARAM
; /* all other illegal request */
247 case SCSI_SK_UNIT_ATTENTION
:
248 return SIMPLE_ERR_TRY_AGAIN
;
249 case SCSI_SK_ABORTED_COMMAND
:
250 return SIMPLE_ERR_ABORTED_COMMAND
;
252 return SIMPLE_ERR_UNKNOWN
;
257 scsiErrString(int scsiErr
)
260 return strerror(-scsiErr
);
262 case SIMPLE_NO_ERROR
:
264 case SIMPLE_ERR_NOT_READY
:
265 return "device not ready";
266 case SIMPLE_ERR_BAD_OPCODE
:
267 return "unsupported scsi opcode";
268 case SIMPLE_ERR_BAD_FIELD
:
269 return "unsupported field in scsi command";
270 case SIMPLE_ERR_BAD_PARAM
:
271 return "badly formed scsi parameters";
272 case SIMPLE_ERR_BAD_RESP
:
273 return "scsi response fails sanity test";
274 case SIMPLE_ERR_NO_MEDIUM
:
275 return "no medium present";
276 case SIMPLE_ERR_BECOMING_READY
:
277 return "device will be ready soon";
278 case SIMPLE_ERR_TRY_AGAIN
:
279 return "unit attention reported, try again";
280 case SIMPLE_ERR_MEDIUM_HARDWARE
:
281 return "medium or hardware error (serious)";
282 case SIMPLE_ERR_UNKNOWN
:
283 return "unknown error (unexpected sense key)";
284 case SIMPLE_ERR_ABORTED_COMMAND
:
285 return "aborted command";
287 return "unknown error";
291 /* Iterates to next designation descriptor in the device identification
292 * VPD page. The 'initial_desig_desc' should point to start of first
293 * descriptor with 'page_len' being the number of valid bytes in that
294 * and following descriptors. To start, 'off' should point to a negative
295 * value, thereafter it should point to the value yielded by the previous
296 * call. If 0 returned then 'initial_desig_desc + *off' should be a valid
297 * descriptor; returns -1 if normal end condition and -2 for an abnormal
298 * termination. Matches association, designator_type and/or code_set when
299 * any of those values are greater than or equal to zero. */
301 scsi_vpd_dev_id_iter(const unsigned char * initial_desig_desc
, int page_len
,
302 int * off
, int m_assoc
, int m_desig_type
, int m_code_set
)
304 const unsigned char * ucp
;
305 int k
, c_set
, assoc
, desig_type
;
307 for (k
= *off
, ucp
= initial_desig_desc
; (k
+ 3) < page_len
; ) {
308 k
= (k
< 0) ? 0 : (k
+ ucp
[k
+ 3] + 4);
309 if ((k
+ 4) > page_len
)
311 c_set
= (ucp
[k
] & 0xf);
312 if ((m_code_set
>= 0) && (m_code_set
!= c_set
))
314 assoc
= ((ucp
[k
+ 1] >> 4) & 0x3);
315 if ((m_assoc
>= 0) && (m_assoc
!= assoc
))
317 desig_type
= (ucp
[k
+ 1] & 0xf);
318 if ((m_desig_type
>= 0) && (m_desig_type
!= desig_type
))
323 return (k
== page_len
) ? -1 : -2;
326 /* Decode VPD page 0x83 logical unit designator into a string. If both
327 * numeric address and SCSI name string present, prefer the former.
328 * Returns 0 on success, -1 on error with error string in s. */
330 scsi_decode_lu_dev_id(const unsigned char * b
, int blen
, char * s
, int slen
,
333 int m
, c_set
, assoc
, desig_type
, i_len
, naa
, off
, u
, have_scsi_ns
;
334 const unsigned char * ucp
;
335 const unsigned char * ip
;
348 while ((u
= scsi_vpd_dev_id_iter(b
, blen
, &off
, -1, -1, -1)) == 0) {
351 if ((off
+ i_len
+ 4) > blen
) {
352 snprintf(s
+si
, slen
-si
, "error: designator length");
355 assoc
= ((ucp
[1] >> 4) & 0x3);
356 if (transport
&& assoc
&& (ucp
[1] & 0x80) && (*transport
< 0))
357 *transport
= (ucp
[0] >> 4) & 0xf;
361 c_set
= (ucp
[0] & 0xf);
362 desig_type
= (ucp
[1] & 0xf);
364 switch (desig_type
) {
365 case 0: /* vendor specific */
366 case 1: /* T10 vendor identification */
368 case 2: /* EUI-64 based */
369 if ((8 != i_len
) && (12 != i_len
) && (16 != i_len
)) {
370 snprintf(s
+si
, slen
-si
, "error: EUI-64 length");
375 si
+= snprintf(s
+si
, slen
-si
, "0x");
376 for (m
= 0; m
< i_len
; ++m
)
377 si
+= snprintf(s
+si
, slen
-si
, "%02x", (unsigned int)ip
[m
]);
381 snprintf(s
+si
, slen
-si
, "error: NAA bad code_set");
384 naa
= (ip
[0] >> 4) & 0xff;
385 if ((naa
< 2) || (naa
> 6) || (4 == naa
)) {
386 snprintf(s
+si
, slen
-si
, "error: unexpected NAA");
391 if (2 == naa
) { /* NAA IEEE Extended */
393 snprintf(s
+si
, slen
-si
, "error: NAA 2 length");
396 si
+= snprintf(s
+si
, slen
-si
, "0x");
397 for (m
= 0; m
< 8; ++m
)
398 si
+= snprintf(s
+si
, slen
-si
, "%02x", (unsigned int)ip
[m
]);
399 } else if ((3 == naa
) || (5 == naa
)) {
400 /* NAA=3 Locally assigned; NAA=5 IEEE Registered */
402 snprintf(s
+si
, slen
-si
, "error: NAA 3 or 5 length");
405 si
+= snprintf(s
+si
, slen
-si
, "0x");
406 for (m
= 0; m
< 8; ++m
)
407 si
+= snprintf(s
+si
, slen
-si
, "%02x", (unsigned int)ip
[m
]);
408 } else if (6 == naa
) { /* NAA IEEE Registered extended */
410 snprintf(s
+si
, slen
-si
, "error: NAA 6 length");
413 si
+= snprintf(s
+si
, slen
-si
, "0x");
414 for (m
= 0; m
< 16; ++m
)
415 si
+= snprintf(s
+si
, slen
-si
, "%02x", (unsigned int)ip
[m
]);
418 case 4: /* Relative target port */
419 case 5: /* (primary) Target port group */
420 case 6: /* Logical unit group */
421 case 7: /* MD5 logical unit identifier */
423 case 8: /* SCSI name string */
425 snprintf(s
+si
, slen
-si
, "error: SCSI name string");
428 /* does %s print out UTF-8 ok?? */
430 si
+= snprintf(s
+si
, slen
-si
, "%s", (const char *)ip
);
434 default: /* reserved */
439 snprintf(s
+si
, slen
-si
, "error: bad structure");
445 /* Sends LOG SENSE command. Returns 0 if ok, 1 if device NOT READY, 2 if
446 command not supported, 3 if field (within command) not supported or
447 returns negated errno. SPC-3 sections 6.6 and 7.2 (rec 22a).
448 N.B. Sets PC==1 to fetch "current cumulative" log pages.
449 If known_resp_len > 0 then a single fetch is done for this response
450 length. If known_resp_len == 0 then twin fetches are performed, the
451 first to deduce the response length, then send the same command again
452 requesting the deduced response length. This protects certain fragile
453 HBAs. The twin fetch technique should not be used with the TapeAlert
454 log page since it clears its state flags after each fetch. */
456 scsiLogSense(scsi_device
* device
, int pagenum
, int subpagenum
, UINT8
*pBuf
,
457 int bufLen
, int known_resp_len
)
459 struct scsi_cmnd_io io_hdr
;
460 struct scsi_sense_disect sinfo
;
466 if (known_resp_len
> bufLen
)
468 if (known_resp_len
> 0)
469 pageLen
= known_resp_len
;
471 /* Starting twin fetch strategy: first fetch to find respone length */
473 if (pageLen
> bufLen
)
476 memset(pBuf
, 0, pageLen
);
478 memset(&io_hdr
, 0, sizeof(io_hdr
));
479 memset(cdb
, 0, sizeof(cdb
));
480 io_hdr
.dxfer_dir
= DXFER_FROM_DEVICE
;
481 io_hdr
.dxfer_len
= pageLen
;
482 io_hdr
.dxferp
= pBuf
;
484 cdb
[2] = 0x40 | (pagenum
& 0x3f); /* Page control (PC)==1 */
486 cdb
[7] = (pageLen
>> 8) & 0xff;
487 cdb
[8] = pageLen
& 0xff;
489 io_hdr
.cmnd_len
= sizeof(cdb
);
490 io_hdr
.sensep
= sense
;
491 io_hdr
.max_sense_len
= sizeof(sense
);
492 io_hdr
.timeout
= SCSI_TIMEOUT_DEFAULT
;
494 if (!device
->scsi_pass_through(&io_hdr
))
495 return -device
->get_errno();
496 scsi_do_sense_disect(&io_hdr
, &sinfo
);
497 if ((res
= scsiSimpleSenseFilter(&sinfo
)))
499 /* sanity check on response */
500 if ((SUPPORTED_LPAGES
!= pagenum
) && ((pBuf
[0] & 0x3f) != pagenum
))
501 return SIMPLE_ERR_BAD_RESP
;
502 if (0 == ((pBuf
[2] << 8) + pBuf
[3]))
503 return SIMPLE_ERR_BAD_RESP
;
504 pageLen
= (pBuf
[2] << 8) + pBuf
[3] + 4;
505 if (4 == pageLen
) /* why define a lpage with no payload? */
506 pageLen
= 252; /* some IBM tape drives don't like double fetch */
507 /* some SCSI HBA don't like "odd" length transfers */
510 if (pageLen
> bufLen
)
514 memset(&io_hdr
, 0, sizeof(io_hdr
));
515 memset(cdb
, 0, sizeof(cdb
));
516 io_hdr
.dxfer_dir
= DXFER_FROM_DEVICE
;
517 io_hdr
.dxfer_len
= pageLen
;
518 io_hdr
.dxferp
= pBuf
;
520 cdb
[2] = 0x40 | (pagenum
& 0x3f); /* Page control (PC)==1 */
521 cdb
[7] = (pageLen
>> 8) & 0xff;
522 cdb
[8] = pageLen
& 0xff;
524 io_hdr
.cmnd_len
= sizeof(cdb
);
525 io_hdr
.sensep
= sense
;
526 io_hdr
.max_sense_len
= sizeof(sense
);
527 io_hdr
.timeout
= SCSI_TIMEOUT_DEFAULT
;
529 if (!device
->scsi_pass_through(&io_hdr
))
530 return -device
->get_errno();
531 scsi_do_sense_disect(&io_hdr
, &sinfo
);
532 status
= scsiSimpleSenseFilter(&sinfo
);
535 /* sanity check on response */
536 if ((SUPPORTED_LPAGES
!= pagenum
) && ((pBuf
[0] & 0x3f) != pagenum
))
537 return SIMPLE_ERR_BAD_RESP
;
538 if (0 == ((pBuf
[2] << 8) + pBuf
[3]))
539 return SIMPLE_ERR_BAD_RESP
;
543 /* Sends a LOG SELECT command. Can be used to set log page values
544 * or reset one log page (or all of them) to its defaults (typically zero).
545 * Returns 0 if ok, 1 if NOT READY, 2 if command not supported, * 3 if
546 * field in command not supported, * 4 if bad parameter to command or
547 * returns negated errno. SPC-4 sections 6.5 and 7.2 (rev 20) */
549 scsiLogSelect(scsi_device
* device
, int pcr
, int sp
, int pc
, int pagenum
,
550 int subpagenum
, UINT8
*pBuf
, int bufLen
)
552 struct scsi_cmnd_io io_hdr
;
553 struct scsi_sense_disect sinfo
;
557 memset(&io_hdr
, 0, sizeof(io_hdr
));
558 memset(cdb
, 0, sizeof(cdb
));
559 io_hdr
.dxfer_dir
= DXFER_TO_DEVICE
;
560 io_hdr
.dxfer_len
= bufLen
;
561 io_hdr
.dxferp
= pBuf
;
563 cdb
[1] = (pcr
? 2 : 0) | (sp
? 1 : 0);
564 cdb
[2] = ((pc
<< 6) & 0xc0) | (pagenum
& 0x3f);
565 cdb
[3] = (subpagenum
& 0xff);
566 cdb
[7] = ((bufLen
>> 8) & 0xff);
567 cdb
[8] = (bufLen
& 0xff);
569 io_hdr
.cmnd_len
= sizeof(cdb
);
570 io_hdr
.sensep
= sense
;
571 io_hdr
.max_sense_len
= sizeof(sense
);
572 io_hdr
.timeout
= SCSI_TIMEOUT_DEFAULT
;
574 if (!device
->scsi_pass_through(&io_hdr
))
575 return -device
->get_errno();
576 scsi_do_sense_disect(&io_hdr
, &sinfo
);
577 return scsiSimpleSenseFilter(&sinfo
);
580 /* Send MODE SENSE (6 byte) command. Returns 0 if ok, 1 if NOT READY,
581 * 2 if command not supported (then MODE SENSE(10) should be supported),
582 * 3 if field in command not supported or returns negated errno.
583 * SPC-3 sections 6.9 and 7.4 (rev 22a) [mode subpage==0] */
585 scsiModeSense(scsi_device
* device
, int pagenum
, int subpagenum
, int pc
,
586 UINT8
*pBuf
, int bufLen
)
588 struct scsi_cmnd_io io_hdr
;
589 struct scsi_sense_disect sinfo
;
594 if ((bufLen
< 0) || (bufLen
> 255))
596 memset(&io_hdr
, 0, sizeof(io_hdr
));
597 memset(cdb
, 0, sizeof(cdb
));
598 io_hdr
.dxfer_dir
= DXFER_FROM_DEVICE
;
599 io_hdr
.dxfer_len
= bufLen
;
600 io_hdr
.dxferp
= pBuf
;
602 cdb
[2] = (pc
<< 6) | (pagenum
& 0x3f);
606 io_hdr
.cmnd_len
= sizeof(cdb
);
607 io_hdr
.sensep
= sense
;
608 io_hdr
.max_sense_len
= sizeof(sense
);
609 io_hdr
.timeout
= SCSI_TIMEOUT_DEFAULT
;
611 if (!device
->scsi_pass_through(&io_hdr
))
612 return -device
->get_errno();
613 scsi_do_sense_disect(&io_hdr
, &sinfo
);
614 status
= scsiSimpleSenseFilter(&sinfo
);
615 if (SIMPLE_ERR_TRY_AGAIN
== status
) {
616 if (!device
->scsi_pass_through(&io_hdr
))
617 return -device
->get_errno();
618 scsi_do_sense_disect(&io_hdr
, &sinfo
);
619 status
= scsiSimpleSenseFilter(&sinfo
);
621 if ((0 == status
) && (ALL_MODE_PAGES
!= pagenum
)) {
624 offset
= scsiModePageOffset(pBuf
, bufLen
, 0);
626 return SIMPLE_ERR_BAD_RESP
;
627 else if (pagenum
!= (pBuf
[offset
] & 0x3f))
628 return SIMPLE_ERR_BAD_RESP
;
633 /* Sends a 6 byte MODE SELECT command. Assumes given pBuf is the response
634 * from a corresponding 6 byte MODE SENSE command. Such a response should
635 * have a 4 byte header followed by 0 or more 8 byte block descriptors
636 * (normally 1) and then 1 mode page. Returns 0 if ok, 1 if NOT READY,
637 * 2 if command not supported (then MODE SELECT(10) may be supported),
638 * 3 if field in command not supported, 4 if bad parameter to command
639 * or returns negated errno. SPC-3 sections 6.7 and 7.4 (rev 22a) */
641 scsiModeSelect(scsi_device
* device
, int sp
, UINT8
*pBuf
, int bufLen
)
643 struct scsi_cmnd_io io_hdr
;
644 struct scsi_sense_disect sinfo
;
647 int pg_offset
, pg_len
, hdr_plus_1_pg
;
649 pg_offset
= 4 + pBuf
[3];
650 if (pg_offset
+ 2 >= bufLen
)
652 pg_len
= pBuf
[pg_offset
+ 1] + 2;
653 hdr_plus_1_pg
= pg_offset
+ pg_len
;
654 if (hdr_plus_1_pg
> bufLen
)
656 pBuf
[0] = 0; /* Length of returned mode sense data reserved for SELECT */
657 pBuf
[pg_offset
] &= 0x7f; /* Mask out PS bit from byte 0 of page data */
658 memset(&io_hdr
, 0, sizeof(io_hdr
));
659 memset(cdb
, 0, sizeof(cdb
));
660 io_hdr
.dxfer_dir
= DXFER_TO_DEVICE
;
661 io_hdr
.dxfer_len
= hdr_plus_1_pg
;
662 io_hdr
.dxferp
= pBuf
;
663 cdb
[0] = MODE_SELECT
;
664 cdb
[1] = 0x10 | (sp
& 1); /* set PF (page format) bit always */
665 cdb
[4] = hdr_plus_1_pg
; /* make sure only one page sent */
667 io_hdr
.cmnd_len
= sizeof(cdb
);
668 io_hdr
.sensep
= sense
;
669 io_hdr
.max_sense_len
= sizeof(sense
);
670 io_hdr
.timeout
= SCSI_TIMEOUT_DEFAULT
;
672 if (!device
->scsi_pass_through(&io_hdr
))
673 return -device
->get_errno();
674 scsi_do_sense_disect(&io_hdr
, &sinfo
);
675 return scsiSimpleSenseFilter(&sinfo
);
678 /* MODE SENSE (10 byte). Returns 0 if ok, 1 if NOT READY, 2 if command
679 * not supported (then MODE SENSE(6) might be supported), 3 if field in
680 * command not supported or returns negated errno.
681 * SPC-3 sections 6.10 and 7.4 (rev 22a) [mode subpage==0] */
683 scsiModeSense10(scsi_device
* device
, int pagenum
, int subpagenum
, int pc
,
684 UINT8
*pBuf
, int bufLen
)
686 struct scsi_cmnd_io io_hdr
;
687 struct scsi_sense_disect sinfo
;
692 memset(&io_hdr
, 0, sizeof(io_hdr
));
693 memset(cdb
, 0, sizeof(cdb
));
694 io_hdr
.dxfer_dir
= DXFER_FROM_DEVICE
;
695 io_hdr
.dxfer_len
= bufLen
;
696 io_hdr
.dxferp
= pBuf
;
697 cdb
[0] = MODE_SENSE_10
;
698 cdb
[2] = (pc
<< 6) | (pagenum
& 0x3f);
700 cdb
[7] = (bufLen
>> 8) & 0xff;
701 cdb
[8] = bufLen
& 0xff;
703 io_hdr
.cmnd_len
= sizeof(cdb
);
704 io_hdr
.sensep
= sense
;
705 io_hdr
.max_sense_len
= sizeof(sense
);
706 io_hdr
.timeout
= SCSI_TIMEOUT_DEFAULT
;
708 if (!device
->scsi_pass_through(&io_hdr
))
709 return -device
->get_errno();
710 scsi_do_sense_disect(&io_hdr
, &sinfo
);
711 status
= scsiSimpleSenseFilter(&sinfo
);
712 if (SIMPLE_ERR_TRY_AGAIN
== status
) {
713 if (!device
->scsi_pass_through(&io_hdr
))
714 return -device
->get_errno();
715 scsi_do_sense_disect(&io_hdr
, &sinfo
);
716 status
= scsiSimpleSenseFilter(&sinfo
);
718 if ((0 == status
) && (ALL_MODE_PAGES
!= pagenum
)) {
721 offset
= scsiModePageOffset(pBuf
, bufLen
, 1);
723 return SIMPLE_ERR_BAD_RESP
;
724 else if (pagenum
!= (pBuf
[offset
] & 0x3f))
725 return SIMPLE_ERR_BAD_RESP
;
730 /* Sends a 10 byte MODE SELECT command. Assumes given pBuf is the response
731 * from a corresponding 10 byte MODE SENSE command. Such a response should
732 * have a 8 byte header followed by 0 or more 8 byte block descriptors
733 * (normally 1) and then 1 mode page. Returns 0 if ok, 1 NOT REAFY, 2 if
734 * command not supported (then MODE SELECT(6) may be supported), 3 if field
735 * in command not supported, 4 if bad parameter to command or returns
736 * negated errno. SPC-3 sections 6.8 and 7.4 (rev 22a) */
738 scsiModeSelect10(scsi_device
* device
, int sp
, UINT8
*pBuf
, int bufLen
)
740 struct scsi_cmnd_io io_hdr
;
741 struct scsi_sense_disect sinfo
;
744 int pg_offset
, pg_len
, hdr_plus_1_pg
;
746 pg_offset
= 8 + (pBuf
[6] << 8) + pBuf
[7];
747 if (pg_offset
+ 2 >= bufLen
)
749 pg_len
= pBuf
[pg_offset
+ 1] + 2;
750 hdr_plus_1_pg
= pg_offset
+ pg_len
;
751 if (hdr_plus_1_pg
> bufLen
)
754 pBuf
[1] = 0; /* Length of returned mode sense data reserved for SELECT */
755 pBuf
[pg_offset
] &= 0x7f; /* Mask out PS bit from byte 0 of page data */
756 memset(&io_hdr
, 0, sizeof(io_hdr
));
757 memset(cdb
, 0, sizeof(cdb
));
758 io_hdr
.dxfer_dir
= DXFER_TO_DEVICE
;
759 io_hdr
.dxfer_len
= hdr_plus_1_pg
;
760 io_hdr
.dxferp
= pBuf
;
761 cdb
[0] = MODE_SELECT_10
;
762 cdb
[1] = 0x10 | (sp
& 1); /* set PF (page format) bit always */
763 cdb
[8] = hdr_plus_1_pg
; /* make sure only one page sent */
765 io_hdr
.cmnd_len
= sizeof(cdb
);
766 io_hdr
.sensep
= sense
;
767 io_hdr
.max_sense_len
= sizeof(sense
);
768 io_hdr
.timeout
= SCSI_TIMEOUT_DEFAULT
;
770 if (!device
->scsi_pass_through(&io_hdr
))
771 return -device
->get_errno();
772 scsi_do_sense_disect(&io_hdr
, &sinfo
);
773 return scsiSimpleSenseFilter(&sinfo
);
776 /* Standard INQUIRY returns 0 for ok, anything else is a major problem.
777 * bufLen should be 36 for unsafe devices (like USB mass storage stuff)
778 * otherwise they can lock up! SPC-3 sections 6.4 and 7.6 (rev 22a) */
780 scsiStdInquiry(scsi_device
* device
, UINT8
*pBuf
, int bufLen
)
782 struct scsi_sense_disect sinfo
;
783 struct scsi_cmnd_io io_hdr
;
787 if ((bufLen
< 0) || (bufLen
> 1023))
789 memset(&io_hdr
, 0, sizeof(io_hdr
));
790 memset(cdb
, 0, sizeof(cdb
));
791 io_hdr
.dxfer_dir
= DXFER_FROM_DEVICE
;
792 io_hdr
.dxfer_len
= bufLen
;
793 io_hdr
.dxferp
= pBuf
;
795 cdb
[3] = (bufLen
>> 8) & 0xff;
796 cdb
[4] = (bufLen
& 0xff);
798 io_hdr
.cmnd_len
= sizeof(cdb
);
799 io_hdr
.sensep
= sense
;
800 io_hdr
.max_sense_len
= sizeof(sense
);
801 io_hdr
.timeout
= SCSI_TIMEOUT_DEFAULT
;
803 if (!device
->scsi_pass_through(&io_hdr
))
804 return -device
->get_errno();
805 scsi_do_sense_disect(&io_hdr
, &sinfo
);
806 return scsiSimpleSenseFilter(&sinfo
);
809 /* INQUIRY to fetch Vital Page Data. Returns 0 if ok, 1 if NOT READY
810 * (unlikely), 2 if command not supported, 3 if field in command not
811 * supported, 5 if response indicates that EVPD bit ignored or returns
812 * negated errno. SPC-3 section 6.4 and 7.6 (rev 22a) */
814 scsiInquiryVpd(scsi_device
* device
, int vpd_page
, UINT8
*pBuf
, int bufLen
)
816 struct scsi_cmnd_io io_hdr
;
817 struct scsi_sense_disect sinfo
;
822 /* Assume SCSI_VPD_SUPPORTED_VPD_PAGES is first VPD page fetched */
823 if ((SCSI_VPD_SUPPORTED_VPD_PAGES
!= vpd_page
) &&
824 supported_vpd_pages_p
&&
825 (! supported_vpd_pages_p
->is_supported(vpd_page
)))
828 if ((bufLen
< 0) || (bufLen
> 1023))
831 memset(&io_hdr
, 0, sizeof(io_hdr
));
832 memset(cdb
, 0, sizeof(cdb
));
835 io_hdr
.dxfer_dir
= DXFER_FROM_DEVICE
;
836 io_hdr
.dxfer_len
= bufLen
;
837 io_hdr
.dxferp
= pBuf
;
839 cdb
[1] = 0x1; /* set EVPD bit (enable Vital Product Data) */
841 cdb
[3] = (bufLen
>> 8) & 0xff;
842 cdb
[4] = (bufLen
& 0xff);
844 io_hdr
.cmnd_len
= sizeof(cdb
);
845 io_hdr
.sensep
= sense
;
846 io_hdr
.max_sense_len
= sizeof(sense
);
847 io_hdr
.timeout
= SCSI_TIMEOUT_DEFAULT
;
849 if (!device
->scsi_pass_through(&io_hdr
))
850 return -device
->get_errno();
851 scsi_do_sense_disect(&io_hdr
, &sinfo
);
852 if ((SCSI_STATUS_CHECK_CONDITION
== io_hdr
.scsi_status
) &&
853 (SCSI_SK_ILLEGAL_REQUEST
== sinfo
.sense_key
) &&
854 (SCSI_ASC_INVALID_FIELD
== sinfo
.asc
) &&
856 bufLen
&= 0xff; /* make sure cdb[3] is 0 next time around */
860 if ((res
= scsiSimpleSenseFilter(&sinfo
)))
862 /* Guard against devices that ignore EVPD bit and do standard INQUIRY */
864 if (vpd_page
== pBuf
[1]) {
865 if ((0x80 == vpd_page
) && (bufLen
> 2) && (0x0 != pBuf
[2]))
866 return SIMPLE_ERR_BAD_RESP
;
868 return SIMPLE_ERR_BAD_RESP
;
873 /* REQUEST SENSE command. Returns 0 if ok, anything else major problem.
874 * SPC-3 section 6.27 (rev 22a) */
876 scsiRequestSense(scsi_device
* device
, struct scsi_sense_disect
* sense_info
)
878 struct scsi_cmnd_io io_hdr
;
885 memset(&io_hdr
, 0, sizeof(io_hdr
));
886 memset(cdb
, 0, sizeof(cdb
));
887 io_hdr
.dxfer_dir
= DXFER_FROM_DEVICE
;
888 io_hdr
.dxfer_len
= sizeof(buff
);
889 io_hdr
.dxferp
= buff
;
890 cdb
[0] = REQUEST_SENSE
;
891 cdb
[4] = sizeof(buff
);
893 io_hdr
.cmnd_len
= sizeof(cdb
);
894 io_hdr
.sensep
= sense
;
895 io_hdr
.max_sense_len
= sizeof(sense
);
896 io_hdr
.timeout
= SCSI_TIMEOUT_DEFAULT
;
898 if (!device
->scsi_pass_through(&io_hdr
))
899 return -device
->get_errno();
901 resp_code
= buff
[0] & 0x7f;
902 sense_info
->resp_code
= resp_code
;
903 sense_info
->sense_key
= buff
[2] & 0xf;
905 sense_info
->ascq
= 0;
906 if ((0x70 == resp_code
) || (0x71 == resp_code
)) {
909 sense_info
->asc
= buff
[12];
910 sense_info
->ascq
= buff
[13];
913 // fill progrss indicator, if available
914 sense_info
->progress
= -1;
916 const unsigned char * ucp
;
920 sk
= (buff
[2] & 0xf);
921 if ((sizeof(buff
) < 18) ||
922 ((SCSI_SK_NO_SENSE
!= sk
) && (SCSI_SK_NOT_READY
!= sk
))) {
925 if (buff
[15] & 0x80) { /* SKSV bit set */
926 sense_info
->progress
= (buff
[16] << 8) + buff
[17];
933 /* sense key specific progress (0x2) or progress descriptor (0xa) */
934 sk
= (buff
[1] & 0xf);
935 sk_pr
= (SCSI_SK_NO_SENSE
== sk
) || (SCSI_SK_NOT_READY
== sk
);
936 if (sk_pr
&& ((ucp
= sg_scsi_sense_desc_find(buff
, sizeof(buff
), 2))) &&
937 (0x6 == ucp
[1]) && (0x80 & ucp
[4])) {
938 sense_info
->progress
= (ucp
[5] << 8) + ucp
[6];
940 } else if (((ucp
= sg_scsi_sense_desc_find(buff
, sizeof(buff
), 0xa))) &&
942 sense_info
->progress
= (ucp
[6] << 8) + ucp
[7];
953 /* SEND DIAGNOSTIC command. Returns 0 if ok, 1 if NOT READY, 2 if command
954 * not supported, 3 if field in command not supported or returns negated
955 * errno. SPC-3 section 6.28 (rev 22a) */
957 scsiSendDiagnostic(scsi_device
* device
, int functioncode
, UINT8
*pBuf
,
960 struct scsi_cmnd_io io_hdr
;
961 struct scsi_sense_disect sinfo
;
965 memset(&io_hdr
, 0, sizeof(io_hdr
));
966 memset(cdb
, 0, sizeof(cdb
));
967 io_hdr
.dxfer_dir
= bufLen
? DXFER_TO_DEVICE
: DXFER_NONE
;
968 io_hdr
.dxfer_len
= bufLen
;
969 io_hdr
.dxferp
= pBuf
;
970 cdb
[0] = SEND_DIAGNOSTIC
;
971 if (SCSI_DIAG_DEF_SELF_TEST
== functioncode
)
972 cdb
[1] = 0x4; /* SelfTest bit */
973 else if (SCSI_DIAG_NO_SELF_TEST
!= functioncode
)
974 cdb
[1] = (functioncode
& 0x7) << 5; /* SelfTest _code_ */
975 else /* SCSI_DIAG_NO_SELF_TEST == functioncode */
976 cdb
[1] = 0x10; /* PF bit */
977 cdb
[3] = (bufLen
>> 8) & 0xff;
978 cdb
[4] = bufLen
& 0xff;
980 io_hdr
.cmnd_len
= sizeof(cdb
);
981 io_hdr
.sensep
= sense
;
982 io_hdr
.max_sense_len
= sizeof(sense
);
983 /* worst case is an extended foreground self test on a big disk */
984 io_hdr
.timeout
= SCSI_TIMEOUT_SELF_TEST
;
986 if (!device
->scsi_pass_through(&io_hdr
))
987 return -device
->get_errno();
988 scsi_do_sense_disect(&io_hdr
, &sinfo
);
989 return scsiSimpleSenseFilter(&sinfo
);
992 /* RECEIVE DIAGNOSTIC command. Returns 0 if ok, 1 if NOT READY, 2 if
993 * command not supported, 3 if field in command not supported or returns
994 * negated errno. SPC-3 section 6.18 (rev 22a) */
996 scsiReceiveDiagnostic(scsi_device
* device
, int pcv
, int pagenum
, UINT8
*pBuf
,
999 struct scsi_cmnd_io io_hdr
;
1000 struct scsi_sense_disect sinfo
;
1004 memset(&io_hdr
, 0, sizeof(io_hdr
));
1005 memset(cdb
, 0, sizeof(cdb
));
1006 io_hdr
.dxfer_dir
= DXFER_FROM_DEVICE
;
1007 io_hdr
.dxfer_len
= bufLen
;
1008 io_hdr
.dxferp
= pBuf
;
1009 cdb
[0] = RECEIVE_DIAGNOSTIC
;
1012 cdb
[3] = (bufLen
>> 8) & 0xff;
1013 cdb
[4] = bufLen
& 0xff;
1015 io_hdr
.cmnd_len
= sizeof(cdb
);
1016 io_hdr
.sensep
= sense
;
1017 io_hdr
.max_sense_len
= sizeof(sense
);
1018 io_hdr
.timeout
= SCSI_TIMEOUT_DEFAULT
;
1020 if (!device
->scsi_pass_through(&io_hdr
))
1021 return -device
->get_errno();
1022 scsi_do_sense_disect(&io_hdr
, &sinfo
);
1023 return scsiSimpleSenseFilter(&sinfo
);
1026 /* TEST UNIT READY command. SPC-3 section 6.33 (rev 22a) */
1028 _testunitready(scsi_device
* device
, struct scsi_sense_disect
* sinfo
)
1030 struct scsi_cmnd_io io_hdr
;
1034 memset(&io_hdr
, 0, sizeof(io_hdr
));
1035 memset(cdb
, 0, sizeof(cdb
));
1036 io_hdr
.dxfer_dir
= DXFER_NONE
;
1037 io_hdr
.dxfer_len
= 0;
1038 io_hdr
.dxferp
= NULL
;
1039 cdb
[0] = TEST_UNIT_READY
;
1041 io_hdr
.cmnd_len
= sizeof(cdb
);
1042 io_hdr
.sensep
= sense
;
1043 io_hdr
.max_sense_len
= sizeof(sense
);
1044 io_hdr
.timeout
= SCSI_TIMEOUT_DEFAULT
;
1046 if (!device
->scsi_pass_through(&io_hdr
))
1047 return -device
->get_errno();
1048 scsi_do_sense_disect(&io_hdr
, sinfo
);
1052 /* Returns 0 for device responds and media ready, 1 for device responds and
1053 media not ready, or returns a negated errno value */
1055 scsiTestUnitReady(scsi_device
* device
)
1057 struct scsi_sense_disect sinfo
;
1060 status
= _testunitready(device
, &sinfo
);
1063 status
= scsiSimpleSenseFilter(&sinfo
);
1064 if (SIMPLE_ERR_TRY_AGAIN
== status
) {
1065 /* power on reset, media changed, ok ... try again */
1066 status
= _testunitready(device
, &sinfo
);
1069 status
= scsiSimpleSenseFilter(&sinfo
);
1074 /* READ DEFECT (10) command. Returns 0 if ok, 1 if NOT READY, 2 if
1075 * command not supported, 3 if field in command not supported or returns
1076 * negated errno. SBC-2 section 5.12 (rev 16) */
1078 scsiReadDefect10(scsi_device
* device
, int req_plist
, int req_glist
,
1079 int dl_format
, UINT8
*pBuf
, int bufLen
)
1081 struct scsi_cmnd_io io_hdr
;
1082 struct scsi_sense_disect sinfo
;
1086 memset(&io_hdr
, 0, sizeof(io_hdr
));
1087 memset(cdb
, 0, sizeof(cdb
));
1088 io_hdr
.dxfer_dir
= DXFER_FROM_DEVICE
;
1089 io_hdr
.dxfer_len
= bufLen
;
1090 io_hdr
.dxferp
= pBuf
;
1091 cdb
[0] = READ_DEFECT_10
;
1092 cdb
[2] = (unsigned char)(((req_plist
<< 4) & 0x10) |
1093 ((req_glist
<< 3) & 0x8) | (dl_format
& 0x7));
1094 cdb
[7] = (bufLen
>> 8) & 0xff;
1095 cdb
[8] = bufLen
& 0xff;
1097 io_hdr
.cmnd_len
= sizeof(cdb
);
1098 io_hdr
.sensep
= sense
;
1099 io_hdr
.max_sense_len
= sizeof(sense
);
1100 io_hdr
.timeout
= SCSI_TIMEOUT_DEFAULT
;
1102 if (!device
->scsi_pass_through(&io_hdr
))
1103 return -device
->get_errno();
1104 scsi_do_sense_disect(&io_hdr
, &sinfo
);
1105 return scsiSimpleSenseFilter(&sinfo
);
1108 /* READ DEFECT (12) command. Returns 0 if ok, 1 if NOT READY, 2 if
1109 * command not supported, 3 if field in command not supported or returns
1110 * negated errno. SBC-3 section 5.18 (rev 35; vale Mark Evans) */
1112 scsiReadDefect12(scsi_device
* device
, int req_plist
, int req_glist
,
1113 int dl_format
, int addrDescIndex
, UINT8
*pBuf
, int bufLen
)
1115 struct scsi_cmnd_io io_hdr
;
1116 struct scsi_sense_disect sinfo
;
1120 memset(&io_hdr
, 0, sizeof(io_hdr
));
1121 memset(cdb
, 0, sizeof(cdb
));
1122 io_hdr
.dxfer_dir
= DXFER_FROM_DEVICE
;
1123 io_hdr
.dxfer_len
= bufLen
;
1124 io_hdr
.dxferp
= pBuf
;
1125 cdb
[0] = READ_DEFECT_12
;
1126 cdb
[1] = (unsigned char)(((req_plist
<< 4) & 0x10) |
1127 ((req_glist
<< 3) & 0x8) | (dl_format
& 0x7));
1128 cdb
[2] = (addrDescIndex
>> 24) & 0xff;
1129 cdb
[3] = (addrDescIndex
>> 16) & 0xff;
1130 cdb
[4] = (addrDescIndex
>> 8) & 0xff;
1131 cdb
[5] = addrDescIndex
& 0xff;
1132 cdb
[6] = (bufLen
>> 24) & 0xff;
1133 cdb
[7] = (bufLen
>> 16) & 0xff;
1134 cdb
[8] = (bufLen
>> 8) & 0xff;
1135 cdb
[9] = bufLen
& 0xff;
1137 io_hdr
.cmnd_len
= sizeof(cdb
);
1138 io_hdr
.sensep
= sense
;
1139 io_hdr
.max_sense_len
= sizeof(sense
);
1140 io_hdr
.timeout
= SCSI_TIMEOUT_DEFAULT
;
1142 if (!device
->scsi_pass_through(&io_hdr
))
1143 return -device
->get_errno();
1144 scsi_do_sense_disect(&io_hdr
, &sinfo
);
1145 return scsiSimpleSenseFilter(&sinfo
);
1148 /* READ CAPACITY (10) command. Returns 0 if ok, 1 if NOT READY, 2 if
1149 * command not supported, 3 if field in command not supported or returns
1150 * negated errno. SBC-3 section 5.15 (rev 26) */
1152 scsiReadCapacity10(scsi_device
* device
, unsigned int * last_lbap
,
1153 unsigned int * lb_sizep
)
1156 struct scsi_cmnd_io io_hdr
;
1157 struct scsi_sense_disect sinfo
;
1162 memset(&io_hdr
, 0, sizeof(io_hdr
));
1163 memset(cdb
, 0, sizeof(cdb
));
1164 memset(resp
, 0, sizeof(resp
));
1165 io_hdr
.dxfer_dir
= DXFER_FROM_DEVICE
;
1166 io_hdr
.dxfer_len
= sizeof(resp
);
1167 io_hdr
.dxferp
= resp
;
1168 cdb
[0] = READ_CAPACITY_10
;
1170 io_hdr
.cmnd_len
= sizeof(cdb
);
1171 io_hdr
.sensep
= sense
;
1172 io_hdr
.max_sense_len
= sizeof(sense
);
1173 io_hdr
.timeout
= SCSI_TIMEOUT_DEFAULT
;
1175 if (!device
->scsi_pass_through(&io_hdr
))
1176 return -device
->get_errno();
1177 scsi_do_sense_disect(&io_hdr
, &sinfo
);
1178 res
= scsiSimpleSenseFilter(&sinfo
);
1182 *last_lbap
= (resp
[0] << 24) | (resp
[1] << 16) | (resp
[2] << 8) |
1185 *lb_sizep
= (resp
[4] << 24) | (resp
[5] << 16) | (resp
[6] << 8) |
1190 /* READ CAPACITY (16) command. The bufLen argument should be 32. Returns 0
1191 * if ok, 1 if NOT READY, 2 if command not supported, 3 if field in command
1192 * not supported or returns negated errno. SBC-3 section 5.16 (rev 26) */
1194 scsiReadCapacity16(scsi_device
* device
, UINT8
*pBuf
, int bufLen
)
1196 struct scsi_cmnd_io io_hdr
;
1197 struct scsi_sense_disect sinfo
;
1201 memset(&io_hdr
, 0, sizeof(io_hdr
));
1202 memset(cdb
, 0, sizeof(cdb
));
1203 io_hdr
.dxfer_dir
= DXFER_FROM_DEVICE
;
1204 io_hdr
.dxfer_len
= bufLen
;
1205 io_hdr
.dxferp
= pBuf
;
1206 cdb
[0] = READ_CAPACITY_16
;
1207 cdb
[1] = SAI_READ_CAPACITY_16
;
1208 cdb
[10] = (bufLen
>> 24) & 0xff;
1209 cdb
[11] = (bufLen
>> 16) & 0xff;
1210 cdb
[12] = (bufLen
>> 8) & 0xff;
1211 cdb
[13] = bufLen
& 0xff;
1213 io_hdr
.cmnd_len
= sizeof(cdb
);
1214 io_hdr
.sensep
= sense
;
1215 io_hdr
.max_sense_len
= sizeof(sense
);
1216 io_hdr
.timeout
= SCSI_TIMEOUT_DEFAULT
;
1218 if (!device
->scsi_pass_through(&io_hdr
))
1219 return -device
->get_errno();
1220 scsi_do_sense_disect(&io_hdr
, &sinfo
);
1221 return scsiSimpleSenseFilter(&sinfo
);
1224 /* Return number of bytes of storage in 'device' or 0 if error. If
1225 * successful and lb_sizep is not NULL then the logical block size
1226 * in bytes is written to the location pointed to by lb_sizep. */
1228 scsiGetSize(scsi_device
* device
, unsigned int * lb_sizep
,
1229 int * lb_per_pb_expp
)
1231 unsigned int last_lba
= 0, lb_size
= 0;
1233 uint64_t ret_val
= 0;
1236 res
= scsiReadCapacity10(device
, &last_lba
, &lb_size
);
1239 pout("scsiGetSize: READ CAPACITY(10) failed, res=%d\n", res
);
1242 if (0xffffffff == last_lba
) {
1243 res
= scsiReadCapacity16(device
, rc16resp
, sizeof(rc16resp
));
1246 pout("scsiGetSize: READ CAPACITY(16) failed, res=%d\n", res
);
1249 for (k
= 0; k
< 8; ++k
) {
1252 ret_val
|= rc16resp
[k
+ 0];
1255 *lb_per_pb_expp
= (rc16resp
[13] & 0xf);
1259 *lb_per_pb_expp
= 0;
1262 *lb_sizep
= lb_size
;
1263 ++ret_val
; /* last_lba is origin 0 so need to bump to get number of */
1264 return ret_val
* lb_size
;
1267 /* Gets drive Protection and Logical/Physical block information. Writes
1268 * back bytes 12 to 31 from a READ CAPACITY 16 command to the rc16_12_31p
1269 * pointer. So rc16_12_31p should point to an array of 20 bytes. Returns 0
1270 * if ok, 1 if NOT READY, 2 if command not supported, 3 if field in command
1271 * not supported or returns negated errno. */
1273 scsiGetProtPBInfo(scsi_device
* device
, unsigned char * rc16_12_31p
)
1278 res
= scsiReadCapacity16(device
, rc16resp
, sizeof(rc16resp
));
1281 pout("scsiGetSize: READ CAPACITY(16) failed, res=%d\n", res
);
1285 memcpy(rc16_12_31p
, rc16resp
+ 12, 20);
1289 /* Offset into mode sense (6 or 10 byte) response that actual mode page
1290 * starts at (relative to resp[0]). Returns -1 if problem */
1292 scsiModePageOffset(const UINT8
* resp
, int len
, int modese_len
)
1294 int resp_len
, bd_len
;
1298 if (10 == modese_len
) {
1299 resp_len
= (resp
[0] << 8) + resp
[1] + 2;
1300 bd_len
= (resp
[6] << 8) + resp
[7];
1301 offset
= bd_len
+ 8;
1303 resp_len
= resp
[0] + 1;
1305 offset
= bd_len
+ 4;
1307 if ((offset
+ 2) > len
) {
1308 pout("scsiModePageOffset: raw_curr too small, offset=%d "
1309 "resp_len=%d bd_len=%d\n", offset
, resp_len
, bd_len
);
1311 } else if ((offset
+ 2) > resp_len
) {
1312 if ((resp_len
> 2) || scsi_debugmode
)
1313 pout("scsiModePageOffset: response length too short, "
1314 "resp_len=%d offset=%d bd_len=%d\n", resp_len
,
1322 /* IEC mode page byte 2 bit masks */
1323 #define DEXCPT_ENABLE 0x08
1324 #define EWASC_ENABLE 0x10
1325 #define DEXCPT_DISABLE 0xf7
1326 #define EWASC_DISABLE 0xef
1327 #define TEST_DISABLE 0xfb
1329 /* Fetches the Informational Exceptions Control mode page. First tries
1330 * the 6 byte MODE SENSE command and if that fails with an illegal opcode
1331 * tries a 10 byte MODE SENSE command. Returns 0 if successful, a positive
1332 * number if a known error (see SIMPLE_ERR_ ...) or a negative errno
1335 scsiFetchIECmpage(scsi_device
* device
, struct scsi_iec_mode_page
*iecp
,
1340 memset(iecp
, 0, sizeof(*iecp
));
1341 iecp
->modese_len
= modese_len
;
1342 iecp
->requestedCurrent
= 1;
1343 if (iecp
->modese_len
<= 6) {
1344 if ((err
= scsiModeSense(device
, INFORMATIONAL_EXCEPTIONS_CONTROL_PAGE
,
1345 0, MPAGE_CONTROL_CURRENT
,
1346 iecp
->raw_curr
, sizeof(iecp
->raw_curr
)))) {
1347 if (SIMPLE_ERR_BAD_OPCODE
== err
)
1348 iecp
->modese_len
= 10;
1350 iecp
->modese_len
= 0;
1353 } else if (0 == iecp
->modese_len
)
1354 iecp
->modese_len
= 6;
1356 if (10 == iecp
->modese_len
) {
1357 err
= scsiModeSense10(device
, INFORMATIONAL_EXCEPTIONS_CONTROL_PAGE
,
1358 0, MPAGE_CONTROL_CURRENT
,
1359 iecp
->raw_curr
, sizeof(iecp
->raw_curr
));
1361 iecp
->modese_len
= 0;
1365 iecp
->gotCurrent
= 1;
1366 iecp
->requestedChangeable
= 1;
1367 if (10 == iecp
->modese_len
)
1368 err
= scsiModeSense10(device
, INFORMATIONAL_EXCEPTIONS_CONTROL_PAGE
,
1369 0, MPAGE_CONTROL_CHANGEABLE
,
1370 iecp
->raw_chg
, sizeof(iecp
->raw_chg
));
1371 else if (6 == iecp
->modese_len
)
1372 err
= scsiModeSense(device
, INFORMATIONAL_EXCEPTIONS_CONTROL_PAGE
,
1373 0, MPAGE_CONTROL_CHANGEABLE
,
1374 iecp
->raw_chg
, sizeof(iecp
->raw_chg
));
1377 iecp
->gotChangeable
= 1;
1382 scsi_IsExceptionControlEnabled(const struct scsi_iec_mode_page
*iecp
)
1386 if (iecp
&& iecp
->gotCurrent
) {
1387 offset
= scsiModePageOffset(iecp
->raw_curr
, sizeof(iecp
->raw_curr
),
1390 return (iecp
->raw_curr
[offset
+ 2] & DEXCPT_ENABLE
) ? 0 : 1;
1398 scsi_IsWarningEnabled(const struct scsi_iec_mode_page
*iecp
)
1402 if (iecp
&& iecp
->gotCurrent
) {
1403 offset
= scsiModePageOffset(iecp
->raw_curr
, sizeof(iecp
->raw_curr
),
1406 return (iecp
->raw_curr
[offset
+ 2] & EWASC_ENABLE
) ? 1 : 0;
1413 /* set EWASC and clear PERF, EBF, DEXCPT TEST and LOGERR */
1414 #define SCSI_IEC_MP_BYTE2_ENABLED 0x10
1415 #define SCSI_IEC_MP_BYTE2_TEST_MASK 0x4
1416 /* exception/warning via an unrequested REQUEST SENSE command */
1417 #define SCSI_IEC_MP_MRIE 6
1418 #define SCSI_IEC_MP_INTERVAL_T 0
1419 #define SCSI_IEC_MP_REPORT_COUNT 1
1421 /* Try to set (or clear) both Exception Control and Warning in the IE
1422 * mode page subject to the "changeable" mask. The object pointed to
1423 * by iecp is (possibly) inaccurate after this call, therefore
1424 * scsiFetchIECmpage() should be called again if the IEC mode page
1425 * is to be re-examined.
1426 * When -r ioctl is invoked 3 or more time on 'smartctl -s on ...'
1427 * then set the TEST bit (causes asc,ascq pair of 0x5d,0xff). */
1429 scsiSetExceptionControlAndWarning(scsi_device
* device
, int enabled
,
1430 const struct scsi_iec_mode_page
*iecp
)
1432 int k
, offset
, resp_len
;
1434 UINT8 rout
[SCSI_IECMP_RAW_LEN
];
1435 int sp
, eCEnabled
, wEnabled
;
1437 if ((! iecp
) || (! iecp
->gotCurrent
))
1439 offset
= scsiModePageOffset(iecp
->raw_curr
, sizeof(iecp
->raw_curr
),
1443 memcpy(rout
, iecp
->raw_curr
, SCSI_IECMP_RAW_LEN
);
1444 /* mask out DPOFUA device specific (disk) parameter bit */
1445 if (10 == iecp
->modese_len
) {
1446 resp_len
= (rout
[0] << 8) + rout
[1] + 2;
1449 resp_len
= rout
[0] + 1;
1452 sp
= (rout
[offset
] & 0x80) ? 1 : 0; /* PS bit becomes 'SELECT's SP bit */
1454 rout
[offset
+ 2] = SCSI_IEC_MP_BYTE2_ENABLED
;
1455 if (scsi_debugmode
> 2)
1456 rout
[offset
+ 2] |= SCSI_IEC_MP_BYTE2_TEST_MASK
;
1457 rout
[offset
+ 3] = SCSI_IEC_MP_MRIE
;
1458 rout
[offset
+ 4] = (SCSI_IEC_MP_INTERVAL_T
>> 24) & 0xff;
1459 rout
[offset
+ 5] = (SCSI_IEC_MP_INTERVAL_T
>> 16) & 0xff;
1460 rout
[offset
+ 6] = (SCSI_IEC_MP_INTERVAL_T
>> 8) & 0xff;
1461 rout
[offset
+ 7] = SCSI_IEC_MP_INTERVAL_T
& 0xff;
1462 rout
[offset
+ 8] = (SCSI_IEC_MP_REPORT_COUNT
>> 24) & 0xff;
1463 rout
[offset
+ 9] = (SCSI_IEC_MP_REPORT_COUNT
>> 16) & 0xff;
1464 rout
[offset
+ 10] = (SCSI_IEC_MP_REPORT_COUNT
>> 8) & 0xff;
1465 rout
[offset
+ 11] = SCSI_IEC_MP_REPORT_COUNT
& 0xff;
1466 if (iecp
->gotChangeable
) {
1467 UINT8 chg2
= iecp
->raw_chg
[offset
+ 2];
1469 rout
[offset
+ 2] = chg2
? (rout
[offset
+ 2] & chg2
) :
1470 iecp
->raw_curr
[offset
+ 2];
1471 for (k
= 3; k
< 12; ++k
) {
1472 if (0 == iecp
->raw_chg
[offset
+ k
])
1473 rout
[offset
+ k
] = iecp
->raw_curr
[offset
+ k
];
1476 if (0 == memcmp(&rout
[offset
+ 2], &iecp
->raw_chg
[offset
+ 2], 10)) {
1477 if (scsi_debugmode
> 0)
1478 pout("scsiSetExceptionControlAndWarning: already enabled\n");
1481 } else { /* disabling Exception Control and (temperature) Warnings */
1482 eCEnabled
= (rout
[offset
+ 2] & DEXCPT_ENABLE
) ? 0 : 1;
1483 wEnabled
= (rout
[offset
+ 2] & EWASC_ENABLE
) ? 1 : 0;
1484 if ((! eCEnabled
) && (! wEnabled
)) {
1485 if (scsi_debugmode
> 0)
1486 pout("scsiSetExceptionControlAndWarning: already disabled\n");
1487 return 0; /* nothing to do, leave other setting alone */
1490 rout
[offset
+ 2] &= EWASC_DISABLE
;
1492 if (iecp
->gotChangeable
&&
1493 (iecp
->raw_chg
[offset
+ 2] & DEXCPT_ENABLE
))
1494 rout
[offset
+ 2] |= DEXCPT_ENABLE
;
1495 rout
[offset
+ 2] &= TEST_DISABLE
;/* clear TEST bit for spec */
1498 if (10 == iecp
->modese_len
)
1499 err
= scsiModeSelect10(device
, sp
, rout
, resp_len
);
1500 else if (6 == iecp
->modese_len
)
1501 err
= scsiModeSelect(device
, sp
, rout
, resp_len
);
1506 scsiGetTemp(scsi_device
* device
, UINT8
*currenttemp
, UINT8
*triptemp
)
1511 memset(tBuf
, 0, sizeof(tBuf
));
1512 if ((err
= scsiLogSense(device
, TEMPERATURE_LPAGE
, 0, tBuf
,
1513 sizeof(tBuf
), 0))) {
1516 pout("Log Sense for temperature failed [%s]\n", scsiErrString(err
));
1519 *currenttemp
= tBuf
[9];
1520 *triptemp
= tBuf
[15];
1524 /* Read informational exception log page or Request Sense response.
1525 * Fetching asc/ascq code potentially flagging an exception or warning.
1526 * Returns 0 if ok, else error number. A current temperature of 255
1527 * (Celsius) implies that the temperature not available. */
1529 scsiCheckIE(scsi_device
* device
, int hasIELogPage
, int hasTempLogPage
,
1530 UINT8
*asc
, UINT8
*ascq
, UINT8
*currenttemp
, UINT8
*triptemp
)
1533 struct scsi_sense_disect sense_info
;
1535 int temperatureSet
= 0;
1536 unsigned short pagesize
;
1537 UINT8 currTemp
, trTemp
;
1543 memset(tBuf
,0,sizeof(tBuf
)); // need to clear stack space of junk
1544 memset(&sense_info
, 0, sizeof(sense_info
));
1546 if ((err
= scsiLogSense(device
, IE_LPAGE
, 0, tBuf
,
1547 sizeof(tBuf
), 0))) {
1548 pout("Log Sense failed, IE page [%s]\n", scsiErrString(err
));
1551 // pull out page size from response, don't forget to add 4
1552 pagesize
= (unsigned short) ((tBuf
[2] << 8) | tBuf
[3]) + 4;
1553 if ((pagesize
< 4) || tBuf
[4] || tBuf
[5]) {
1554 pout("Log Sense failed, IE page, bad parameter code or length\n");
1555 return SIMPLE_ERR_BAD_PARAM
;
1558 sense_info
.asc
= tBuf
[8];
1559 sense_info
.ascq
= tBuf
[9];
1560 if (! hasTempLogPage
) {
1562 *currenttemp
= tBuf
[10];
1563 if (tBuf
[7] > 3) /* IBM extension in SMART (IE) lpage */
1564 *triptemp
= tBuf
[11];
1568 if (0 == sense_info
.asc
) {
1569 /* ties in with MRIE field of 6 in IEC mode page (0x1c) */
1570 if ((err
= scsiRequestSense(device
, &sense_info
))) {
1571 pout("Request Sense failed, [%s]\n", scsiErrString(err
));
1575 *asc
= sense_info
.asc
;
1576 *ascq
= sense_info
.ascq
;
1577 if ((! temperatureSet
) && hasTempLogPage
) {
1578 if (0 == scsiGetTemp(device
, &currTemp
, &trTemp
)) {
1579 *currenttemp
= currTemp
;
1586 // The first character (W, C, I) tells the severity
1587 static const char * TapeAlertsMessageTable
[]= {
1590 "W: The tape drive is having problems reading data. No data has been lost,\n"
1591 " but there has been a reduction in the performance of the tape.",
1593 "W: The tape drive is having problems writing data. No data has been lost,\n"
1594 " but there has been a reduction in the capacity of the tape.",
1596 "W: The operation has stopped because an error has occurred while reading\n"
1597 " or writing data that the drive cannot correct.",
1599 "C: Your data is at risk:\n"
1600 " 1. Copy any data you require from this tape. \n"
1601 " 2. Do not use this tape again.\n"
1602 " 3. Restart the operation with a different tape.",
1604 "C: The tape is damaged or the drive is faulty. Call the tape drive\n"
1605 " supplier helpline.",
1607 "C: The tape is from a faulty batch or the tape drive is faulty:\n"
1608 " 1. Use a good tape to test the drive.\n"
1609 " 2. If problem persists, call the tape drive supplier helpline.",
1611 "W: The tape cartridge has reached the end of its calculated useful life:\n"
1612 " 1. Copy data you need to another tape.\n"
1613 " 2. Discard the old tape.",
1615 "W: The tape cartridge is not data-grade. Any data you back up to the tape\n"
1616 " is at risk. Replace the cartridge with a data-grade tape.",
1618 "C: You are trying to write to a write-protected cartridge. Remove the\n"
1619 " write-protection or use another tape.",
1621 "I: You cannot eject the cartridge because the tape drive is in use. Wait\n"
1622 " until the operation is complete before ejecting the cartridge.",
1624 "I: The tape in the drive is a cleaning cartridge.",
1626 "I: You have tried to load a cartridge of a type which is not supported\n"
1629 "C: The operation has failed because the tape in the drive has experienced\n"
1630 " a mechanical failure:\n"
1631 " 1. Discard the old tape.\n"
1632 " 2. Restart the operation with a different tape.",
1634 "C: The operation has failed because the tape in the drive has experienced\n"
1635 " a mechanical failure:\n"
1636 " 1. Do not attempt to extract the tape cartridge\n"
1637 " 2. Call the tape drive supplier helpline.",
1639 "W: The memory in the tape cartridge has failed, which reduces\n"
1640 " performance. Do not use the cartridge for further write operations.",
1642 "C: The operation has failed because the tape cartridge was manually\n"
1643 " de-mounted while the tape drive was actively writing or reading.",
1645 "W: You have loaded a cartridge of a type that is read-only in this drive.\n"
1646 " The cartridge will appear as write-protected.",
1648 "W: The tape directory on the tape cartridge has been corrupted. File\n"
1649 " search performance will be degraded. The tape directory can be rebuilt\n"
1650 " by reading all the data on the cartridge.",
1652 "I: The tape cartridge is nearing the end of its calculated life. It is\n"
1653 " recommended that you:\n"
1654 " 1. Use another tape cartridge for your next backup.\n"
1655 " 2. Store this tape in a safe place in case you need to restore "
1658 "C: The tape drive needs cleaning:\n"
1659 " 1. If the operation has stopped, eject the tape and clean the drive.\n"
1660 " 2. If the operation has not stopped, wait for it to finish and then\n"
1661 " clean the drive.\n"
1662 " Check the tape drive users manual for device specific cleaning instructions.",
1664 "W: The tape drive is due for routine cleaning:\n"
1665 " 1. Wait for the current operation to finish.\n"
1666 " 2. The use a cleaning cartridge.\n"
1667 " Check the tape drive users manual for device specific cleaning instructions.",
1669 "C: The last cleaning cartridge used in the tape drive has worn out:\n"
1670 " 1. Discard the worn out cleaning cartridge.\n"
1671 " 2. Wait for the current operation to finish.\n"
1672 " 3. Then use a new cleaning cartridge.",
1674 "C: The last cleaning cartridge used in the tape drive was an invalid\n"
1676 " 1. Do not use this cleaning cartridge in this drive.\n"
1677 " 2. Wait for the current operation to finish.\n"
1678 " 3. Then use a new cleaning cartridge.",
1680 "W: The tape drive has requested a retention operation",
1682 "W: A redundant interface port on the tape drive has failed",
1684 "W: A tape drive cooling fan has failed",
1686 "W: A redundant power supply has failed inside the tape drive enclosure.\n"
1687 " Check the enclosure users manual for instructions on replacing the\n"
1688 " failed power supply.",
1690 "W: The tape drive power consumption is outside the specified range.",
1692 "W: Preventive maintenance of the tape drive is required. Check the tape\n"
1693 " drive users manual for device specific preventive maintenance\n"
1694 " tasks or call the tape drive supplier helpline.",
1696 "C: The tape drive has a hardware fault:\n"
1697 " 1. Eject the tape or magazine.\n"
1698 " 2. Reset the drive.\n"
1699 " 3. Restart the operation.",
1701 "C: The tape drive has a hardware fault:\n"
1702 " 1. Turn the tape drive off and then on again.\n"
1703 " 2. Restart the operation.\n"
1704 " 3. If the problem persists, call the tape drive supplier helpline.",
1706 "W: The tape drive has a problem with the application client interface:\n"
1707 " 1. Check the cables and cable connections.\n"
1708 " 2. Restart the operation.",
1710 "C: The operation has failed:\n"
1711 " 1. Eject the tape or magazine.\n"
1712 " 2. Insert the tape or magazine again.\n"
1713 " 3. Restart the operation.",
1715 "W: The firmware download has failed because you have tried to use the\n"
1716 " incorrect firmware for this tape drive. Obtain the correct\n"
1717 " firmware and try again.",
1719 "W: Environmental conditions inside the tape drive are outside the\n"
1720 " specified humidity range.",
1722 "W: Environmental conditions inside the tape drive are outside the\n"
1723 " specified temperature range.",
1725 "W: The voltage supply to the tape drive is outside the specified range.",
1727 "C: A hardware failure of the tape drive is predicted. Call the tape\n"
1728 " drive supplier helpline.",
1730 "W: The tape drive may have a hardware fault. Run extended diagnostics to\n"
1731 " verify and diagnose the problem. Check the tape drive users manual for\n"
1732 " device specific instructions on running extended diagnostic tests.",
1734 "C: The changer mechanism is having difficulty communicating with the tape\n"
1736 " 1. Turn the autoloader off then on.\n"
1737 " 2. Restart the operation.\n"
1738 " 3. If problem persists, call the tape drive supplier helpline.",
1740 "C: A tape has been left in the autoloader by a previous hardware fault:\n"
1741 " 1. Insert an empty magazine to clear the fault.\n"
1742 " 2. If the fault does not clear, turn the autoloader off and then\n"
1744 " 3. If the problem persists, call the tape drive supplier helpline.",
1746 "W: There is a problem with the autoloader mechanism.",
1748 "C: The operation has failed because the autoloader door is open:\n"
1749 " 1. Clear any obstructions from the autoloader door.\n"
1750 " 2. Eject the magazine and then insert it again.\n"
1751 " 3. If the fault does not clear, turn the autoloader off and then\n"
1753 " 4. If the problem persists, call the tape drive supplier helpline.",
1755 "C: The autoloader has a hardware fault:\n"
1756 " 1. Turn the autoloader off and then on again.\n"
1757 " 2. Restart the operation.\n"
1758 " 3. If the problem persists, call the tape drive supplier helpline.\n"
1759 " Check the autoloader users manual for device specific instructions\n"
1760 " on turning the device power on and off.",
1762 "C: The autoloader cannot operate without the magazine,\n"
1763 " 1. Insert the magazine into the autoloader.\n"
1764 " 2. Restart the operation.",
1766 "W: A hardware failure of the changer mechanism is predicted. Call the\n"
1767 " tape drive supplier helpline.",
1775 "W: Media statistics have been lost at some time in the past",
1777 "W: The tape directory on the tape cartridge just unloaded has been\n"
1778 " corrupted. File search performance will be degraded. The tape\n"
1779 " directory can be rebuilt by reading all the data.",
1781 "C: The tape just unloaded could not write its system area successfully:\n"
1782 " 1. Copy data to another tape cartridge.\n"
1783 " 2. Discard the old cartridge.",
1785 "C: The tape system are could not be read successfully at load time:\n"
1786 " 1. Copy data to another tape cartridge.\n",
1788 "C: The start or data could not be found on the tape:\n"
1789 " 1. Check you are using the correct format tape.\n"
1790 " 2. Discard the tape or return the tape to your supplier",
1792 "C: The operation has failed because the media cannot be loaded\n"
1794 " 1. Remove the cartridge, inspect it as specified in the product\n"
1795 " manual, and retry the operation.\n"
1796 " 2. If the problem persists, call the tape drive supplier help line.",
1798 "C: The operation has failed because the medium cannot be unloaded:\n"
1799 " 1. Do not attempt to extract the tape cartridge.\n"
1800 " 2. Call the tape driver supplier help line.",
1802 "C: The tape drive has a problem with the automation interface:\n"
1803 " 1. Check the power to the automation system.\n"
1804 " 2. Check the cables and cable connections.\n"
1805 " 3. Call the supplier help line if problem persists.",
1807 "W: The tape drive has reset itself due to a detected firmware\n"
1808 " fault. If problem persists, call the supplier help line.",
1812 scsiTapeAlertsTapeDevice(unsigned short code
)
1814 const int num
= sizeof(TapeAlertsMessageTable
) /
1815 sizeof(TapeAlertsMessageTable
[0]);
1817 return (code
< num
) ? TapeAlertsMessageTable
[code
] : "Unknown Alert";
1820 // The first character (W, C, I) tells the severity
1821 static const char * ChangerTapeAlertsMessageTable
[]= {
1824 "C: The library mechanism is having difficulty communicating with the\n"
1826 " 1. Turn the library off then on.\n"
1827 " 2. Restart the operation.\n"
1828 " 3. If the problem persists, call the library supplier help line.",
1830 "W: There is a problem with the library mechanism. If problem persists,\n"
1831 " call the library supplier help line.",
1833 "C: The library has a hardware fault:\n"
1834 " 1. Reset the library.\n"
1835 " 2. Restart the operation.\n"
1836 " Check the library users manual for device specific instructions on resetting\n"
1839 "C: The library has a hardware fault:\n"
1840 " 1. Turn the library off then on again.\n"
1841 " 2. Restart the operation.\n"
1842 " 3. If the problem persists, call the library supplier help line.\n"
1843 " Check the library users manual for device specific instructions on turning the\n"
1844 " device power on and off.",
1846 "W: The library mechanism may have a hardware fault.\n"
1847 " Run extended diagnostics to verify and diagnose the problem. Check the library\n"
1848 " users manual for device specific instructions on running extended diagnostic\n"
1851 "C: The library has a problem with the host interface:\n"
1852 " 1. Check the cables and connections.\n"
1853 " 2. Restart the operation.",
1855 "W: A hardware failure of the library is predicted. Call the library\n"
1856 " supplier help line.",
1858 "W: Preventive maintenance of the library is required.\n"
1859 " Check the library users manual for device specific preventative maintenance\n"
1860 " tasks, or call your library supplier help line.",
1862 "C: General environmental conditions inside the library are outside the\n"
1863 " specified humidity range.",
1865 "C: General environmental conditions inside the library are outside the\n"
1866 " specified temperature range.",
1868 "C: The voltage supply to the library is outside the specified range.\n"
1869 " There is a potential problem with the power supply or failure of\n"
1870 " a redundant power supply.",
1872 "C: A cartridge has been left inside the library by a previous hardware\n"
1874 " 1. Insert an empty magazine to clear the fault.\n"
1875 " 2. If the fault does not clear, turn the library off and then on again.\n"
1876 " 3. If the problem persists, call the library supplier help line.",
1878 "W: There is a potential problem with the drive ejecting cartridges or\n"
1879 " with the library mechanism picking a cartridge from a slot.\n"
1880 " 1. No action needs to be taken at this time.\n"
1881 " 2. If the problem persists, call the library supplier help line.",
1883 "W: There is a potential problem with the library mechanism placing a\n"
1884 " cartridge into a slot.\n"
1885 " 1. No action needs to be taken at this time.\n"
1886 " 2. If the problem persists, call the library supplier help line.",
1888 "W: There is a potential problem with the drive or the library mechanism\n"
1889 " loading cartridges, or an incompatible cartridge.",
1891 "C: The library has failed because the door is open:\n"
1892 " 1. Clear any obstructions from the library door.\n"
1893 " 2. Close the library door.\n"
1894 " 3. If the problem persists, call the library supplier help line.",
1896 "C: There is a mechanical problem with the library media import/export\n"
1899 "C: The library cannot operate without the magazine.\n"
1900 " 1. Insert the magazine into the library.\n"
1901 " 2. Restart the operation.",
1903 "W: Library security has been compromised.",
1905 "I: The library security mode has been changed.\n"
1906 " The library has either been put into secure mode, or the library has exited\n"
1907 " the secure mode.\n"
1908 " This is for information purposes only. No action is required.",
1910 "I: The library has been manually turned offline and is unavailable for use.",
1912 "I: A drive inside the library has been taken offline.\n"
1913 " This is for information purposes only. No action is required.",
1915 "W: There is a potential problem with the bar code label or the scanner\n"
1916 " hardware in the library mechanism.\n"
1917 " 1. No action needs to be taken at this time.\n"
1918 " 2. If the problem persists, call the library supplier help line.",
1920 "C: The library has detected an inconsistency in its inventory.\n"
1921 " 1. Redo the library inventory to correct inconsistency.\n"
1922 " 2. Restart the operation.\n"
1923 " Check the applications users manual or the hardware users manual for\n"
1924 " specific instructions on redoing the library inventory.",
1926 "W: A library operation has been attempted that is invalid at this time.",
1928 "W: A redundant interface port on the library has failed.",
1930 "W: A library cooling fan has failed.",
1932 "W: A redundant power supply has failed inside the library. Check the\n"
1933 " library users manual for instructions on replacing the failed power supply.",
1935 "W: The library power consumption is outside the specified range.",
1937 "C: A failure has occurred in the cartridge pass-through mechanism between\n"
1938 " two library modules.",
1940 "C: A cartridge has been left in the pass-through mechanism from a\n"
1941 " previous hardware fault. Check the library users guide for instructions on\n"
1942 " clearing this fault.",
1944 "I: The library was unable to read the bar code on a cartridge.",
1948 scsiTapeAlertsChangerDevice(unsigned short code
)
1950 const int num
= sizeof(ChangerTapeAlertsMessageTable
) /
1951 sizeof(ChangerTapeAlertsMessageTable
[0]);
1953 return (code
< num
) ? ChangerTapeAlertsMessageTable
[code
] : "Unknown Alert";
1957 /* this is a subset of the SCSI additional sense code strings indexed
1958 * by "ascq" for the case when asc==SCSI_ASC_IMPENDING_FAILURE (0x5d)
1960 static const char * strs_for_asc_5d
[] = {
1961 /* 0x00 */ "FAILURE PREDICTION THRESHOLD EXCEEDED",
1962 "MEDIA FAILURE PREDICTION THRESHOLD EXCEEDED",
1963 "LOGICAL UNIT FAILURE PREDICTION THRESHOLD EXCEEDED",
1964 "SPARE AREA EXHAUSTION PREDICTION THRESHOLD EXCEEDED",
1977 /* 0x10 */ "HARDWARE IMPENDING FAILURE GENERAL HARD DRIVE FAILURE",
1978 "HARDWARE IMPENDING FAILURE DRIVE ERROR RATE TOO HIGH",
1979 "HARDWARE IMPENDING FAILURE DATA ERROR RATE TOO HIGH",
1980 "HARDWARE IMPENDING FAILURE SEEK ERROR RATE TOO HIGH",
1981 "HARDWARE IMPENDING FAILURE TOO MANY BLOCK REASSIGNS",
1982 "HARDWARE IMPENDING FAILURE ACCESS TIMES TOO HIGH",
1983 "HARDWARE IMPENDING FAILURE START UNIT TIMES TOO HIGH",
1984 "HARDWARE IMPENDING FAILURE CHANNEL PARAMETRICS",
1985 "HARDWARE IMPENDING FAILURE CONTROLLER DETECTED",
1986 "HARDWARE IMPENDING FAILURE THROUGHPUT PERFORMANCE",
1987 "HARDWARE IMPENDING FAILURE SEEK TIME PERFORMANCE",
1988 "HARDWARE IMPENDING FAILURE SPIN-UP RETRY COUNT",
1989 "HARDWARE IMPENDING FAILURE DRIVE CALIBRATION RETRY COUNT",
1993 /* 0x20 */ "CONTROLLER IMPENDING FAILURE GENERAL HARD DRIVE FAILURE",
1994 "CONTROLLER IMPENDING FAILURE DRIVE ERROR RATE TOO HIGH",
1995 "CONTROLLER IMPENDING FAILURE DATA ERROR RATE TOO HIGH",
1996 "CONTROLLER IMPENDING FAILURE SEEK ERROR RATE TOO HIGH",
1997 "CONTROLLER IMPENDING FAILURE TOO MANY BLOCK REASSIGNS",
1998 "CONTROLLER IMPENDING FAILURE ACCESS TIMES TOO HIGH",
1999 "CONTROLLER IMPENDING FAILURE START UNIT TIMES TOO HIGH",
2000 "CONTROLLER IMPENDING FAILURE CHANNEL PARAMETRICS",
2001 "CONTROLLER IMPENDING FAILURE CONTROLLER DETECTED",
2002 "CONTROLLER IMPENDING FAILURE THROUGHPUT PERFORMANCE",
2003 "CONTROLLER IMPENDING FAILURE SEEK TIME PERFORMANCE",
2004 "CONTROLLER IMPENDING FAILURE SPIN-UP RETRY COUNT",
2005 "CONTROLLER IMPENDING FAILURE DRIVE CALIBRATION RETRY COUNT",
2009 /* 0x30 */ "DATA CHANNEL IMPENDING FAILURE GENERAL HARD DRIVE FAILURE",
2010 "DATA CHANNEL IMPENDING FAILURE DRIVE ERROR RATE TOO HIGH",
2011 "DATA CHANNEL IMPENDING FAILURE DATA ERROR RATE TOO HIGH",
2012 "DATA CHANNEL IMPENDING FAILURE SEEK ERROR RATE TOO HIGH",
2013 "DATA CHANNEL IMPENDING FAILURE TOO MANY BLOCK REASSIGNS",
2014 "DATA CHANNEL IMPENDING FAILURE ACCESS TIMES TOO HIGH",
2015 "DATA CHANNEL IMPENDING FAILURE START UNIT TIMES TOO HIGH",
2016 "DATA CHANNEL IMPENDING FAILURE CHANNEL PARAMETRICS",
2017 "DATA CHANNEL IMPENDING FAILURE CONTROLLER DETECTED",
2018 "DATA CHANNEL IMPENDING FAILURE THROUGHPUT PERFORMANCE",
2019 "DATA CHANNEL IMPENDING FAILURE SEEK TIME PERFORMANCE",
2020 "DATA CHANNEL IMPENDING FAILURE SPIN-UP RETRY COUNT",
2021 "DATA CHANNEL IMPENDING FAILURE DRIVE CALIBRATION RETRY COUNT",
2025 /* 0x40 */ "SERVO IMPENDING FAILURE GENERAL HARD DRIVE FAILURE",
2026 "SERVO IMPENDING FAILURE DRIVE ERROR RATE TOO HIGH",
2027 "SERVO IMPENDING FAILURE DATA ERROR RATE TOO HIGH",
2028 "SERVO IMPENDING FAILURE SEEK ERROR RATE TOO HIGH",
2029 "SERVO IMPENDING FAILURE TOO MANY BLOCK REASSIGNS",
2030 "SERVO IMPENDING FAILURE ACCESS TIMES TOO HIGH",
2031 "SERVO IMPENDING FAILURE START UNIT TIMES TOO HIGH",
2032 "SERVO IMPENDING FAILURE CHANNEL PARAMETRICS",
2033 "SERVO IMPENDING FAILURE CONTROLLER DETECTED",
2034 "SERVO IMPENDING FAILURE THROUGHPUT PERFORMANCE",
2035 "SERVO IMPENDING FAILURE SEEK TIME PERFORMANCE",
2036 "SERVO IMPENDING FAILURE SPIN-UP RETRY COUNT",
2037 "SERVO IMPENDING FAILURE DRIVE CALIBRATION RETRY COUNT",
2041 /* 0x50 */ "SPINDLE IMPENDING FAILURE GENERAL HARD DRIVE FAILURE",
2042 "SPINDLE IMPENDING FAILURE DRIVE ERROR RATE TOO HIGH",
2043 "SPINDLE IMPENDING FAILURE DATA ERROR RATE TOO HIGH",
2044 "SPINDLE IMPENDING FAILURE SEEK ERROR RATE TOO HIGH",
2045 "SPINDLE IMPENDING FAILURE TOO MANY BLOCK REASSIGNS",
2046 "SPINDLE IMPENDING FAILURE ACCESS TIMES TOO HIGH",
2047 "SPINDLE IMPENDING FAILURE START UNIT TIMES TOO HIGH",
2048 "SPINDLE IMPENDING FAILURE CHANNEL PARAMETRICS",
2049 "SPINDLE IMPENDING FAILURE CONTROLLER DETECTED",
2050 "SPINDLE IMPENDING FAILURE THROUGHPUT PERFORMANCE",
2051 "SPINDLE IMPENDING FAILURE SEEK TIME PERFORMANCE",
2052 "SPINDLE IMPENDING FAILURE SPIN-UP RETRY COUNT",
2053 "SPINDLE IMPENDING FAILURE DRIVE CALIBRATION RETRY COUNT",
2057 /* 0x60 */ "FIRMWARE IMPENDING FAILURE GENERAL HARD DRIVE FAILURE",
2058 "FIRMWARE IMPENDING FAILURE DRIVE ERROR RATE TOO HIGH",
2059 "FIRMWARE IMPENDING FAILURE DATA ERROR RATE TOO HIGH",
2060 "FIRMWARE IMPENDING FAILURE SEEK ERROR RATE TOO HIGH",
2061 "FIRMWARE IMPENDING FAILURE TOO MANY BLOCK REASSIGNS",
2062 "FIRMWARE IMPENDING FAILURE ACCESS TIMES TOO HIGH",
2063 "FIRMWARE IMPENDING FAILURE START UNIT TIMES TOO HIGH",
2064 "FIRMWARE IMPENDING FAILURE CHANNEL PARAMETRICS",
2065 "FIRMWARE IMPENDING FAILURE CONTROLLER DETECTED",
2066 "FIRMWARE IMPENDING FAILURE THROUGHPUT PERFORMANCE",
2067 "FIRMWARE IMPENDING FAILURE SEEK TIME PERFORMANCE",
2068 "FIRMWARE IMPENDING FAILURE SPIN-UP RETRY COUNT",
2069 /* 0x6c */ "FIRMWARE IMPENDING FAILURE DRIVE CALIBRATION RETRY COUNT"};
2072 /* this is a subset of the SCSI additional sense code strings indexed
2073 * * by "ascq" for the case when asc==SCSI_ASC_WARNING (0xb)
2075 static const char * strs_for_asc_b
[] = {
2076 /* 0x00 */ "WARNING",
2077 "WARNING - SPECIFIED TEMPERATURE EXCEEDED",
2078 "WARNING - ENCLOSURE DEGRADED"};
2080 static char spare_buff
[128];
2083 scsiGetIEString(UINT8 asc
, UINT8 ascq
)
2087 if (SCSI_ASC_IMPENDING_FAILURE
== asc
) {
2089 return "FAILURE PREDICTION THRESHOLD EXCEEDED (FALSE)";
2091 (sizeof(strs_for_asc_5d
) / sizeof(strs_for_asc_5d
[0]))) {
2092 rp
= strs_for_asc_5d
[ascq
];
2096 snprintf(spare_buff
, sizeof(spare_buff
),
2097 "FAILURE PREDICTION THRESHOLD EXCEEDED: ascq=0x%x", ascq
);
2099 } else if (SCSI_ASC_WARNING
== asc
) {
2100 if (ascq
< (sizeof(strs_for_asc_b
) / sizeof(strs_for_asc_b
[0]))) {
2101 rp
= strs_for_asc_b
[ascq
];
2105 snprintf(spare_buff
, sizeof(spare_buff
), "WARNING: ascq=0x%x", ascq
);
2108 return NULL
; /* not a IE additional sense code */
2112 /* This is not documented in t10.org, page 0x80 is vendor specific */
2113 /* Some IBM disks do an offline read-scan when they get this command. */
2115 scsiSmartIBMOfflineTest(scsi_device
* device
)
2120 memset(tBuf
, 0, sizeof(tBuf
));
2121 /* Build SMART Off-line Immediate Diag Header */
2122 tBuf
[0] = 0x80; /* Page Code */
2123 tBuf
[1] = 0x00; /* Reserved */
2124 tBuf
[2] = 0x00; /* Page Length MSB */
2125 tBuf
[3] = 0x04; /* Page Length LSB */
2126 tBuf
[4] = 0x03; /* SMART Revision */
2127 tBuf
[5] = 0x00; /* Reserved */
2128 tBuf
[6] = 0x00; /* Off-line Immediate Time MSB */
2129 tBuf
[7] = 0x00; /* Off-line Immediate Time LSB */
2130 res
= scsiSendDiagnostic(device
, SCSI_DIAG_NO_SELF_TEST
, tBuf
, 8);
2132 pout("IBM offline test failed [%s]\n", scsiErrString(res
));
2137 scsiSmartDefaultSelfTest(scsi_device
* device
)
2141 res
= scsiSendDiagnostic(device
, SCSI_DIAG_DEF_SELF_TEST
, NULL
, 0);
2143 pout("Default self test failed [%s]\n", scsiErrString(res
));
2148 scsiSmartShortSelfTest(scsi_device
* device
)
2152 res
= scsiSendDiagnostic(device
, SCSI_DIAG_BG_SHORT_SELF_TEST
, NULL
, 0);
2154 pout("Short offline self test failed [%s]\n", scsiErrString(res
));
2159 scsiSmartExtendSelfTest(scsi_device
* device
)
2163 res
= scsiSendDiagnostic(device
, SCSI_DIAG_BG_EXTENDED_SELF_TEST
, NULL
, 0);
2165 pout("Long (extended) offline self test failed [%s]\n",
2166 scsiErrString(res
));
2171 scsiSmartShortCapSelfTest(scsi_device
* device
)
2175 res
= scsiSendDiagnostic(device
, SCSI_DIAG_FG_SHORT_SELF_TEST
, NULL
, 0);
2177 pout("Short foreground self test failed [%s]\n", scsiErrString(res
));
2182 scsiSmartExtendCapSelfTest(scsi_device
* device
)
2186 res
= scsiSendDiagnostic(device
, SCSI_DIAG_FG_EXTENDED_SELF_TEST
, NULL
, 0);
2188 pout("Long (extended) foreground self test failed [%s]\n",
2189 scsiErrString(res
));
2194 scsiSmartSelfTestAbort(scsi_device
* device
)
2198 res
= scsiSendDiagnostic(device
, SCSI_DIAG_ABORT_SELF_TEST
, NULL
, 0);
2200 pout("Abort self test failed [%s]\n", scsiErrString(res
));
2204 /* Returns 0 and the expected duration of an extended self test (in seconds)
2205 if successful; any other return value indicates a failure. */
2207 scsiFetchExtendedSelfTestTime(scsi_device
* device
, int * durationSec
,
2210 int err
, offset
, res
;
2213 memset(buff
, 0, sizeof(buff
));
2214 if (modese_len
<= 6) {
2215 if ((err
= scsiModeSense(device
, CONTROL_MODE_PAGE
, 0,
2216 MPAGE_CONTROL_CURRENT
,
2217 buff
, sizeof(buff
)))) {
2218 if (SIMPLE_ERR_BAD_OPCODE
== err
)
2222 } else if (0 == modese_len
)
2225 if (10 == modese_len
) {
2226 err
= scsiModeSense10(device
, CONTROL_MODE_PAGE
, 0,
2227 MPAGE_CONTROL_CURRENT
,
2228 buff
, sizeof(buff
));
2232 offset
= scsiModePageOffset(buff
, sizeof(buff
), modese_len
);
2235 if (buff
[offset
+ 1] >= 0xa) {
2236 res
= (buff
[offset
+ 10] << 8) | buff
[offset
+ 11];
2245 scsiDecodeErrCounterPage(unsigned char * resp
, struct scsiErrorCounter
*ecp
)
2247 int k
, j
, num
, pl
, pc
;
2248 unsigned char * ucp
;
2252 memset(ecp
, 0, sizeof(*ecp
));
2253 num
= (resp
[2] << 8) | resp
[3];
2256 pc
= (ucp
[0] << 8) | ucp
[1];
2267 ullp
= &ecp
->counter
[pc
];
2270 ecp
->gotExtraPC
= 1;
2271 ullp
= &ecp
->counter
[7];
2276 if (k
> (int)sizeof(*ullp
)) {
2277 xp
+= (k
- sizeof(*ullp
));
2281 for (j
= 0; j
< k
; ++j
) {
2292 scsiDecodeNonMediumErrPage(unsigned char *resp
,
2293 struct scsiNonMediumError
*nmep
)
2295 int k
, j
, num
, pl
, pc
, szof
;
2296 unsigned char * ucp
;
2299 memset(nmep
, 0, sizeof(*nmep
));
2300 num
= (resp
[2] << 8) | resp
[3];
2302 szof
= sizeof(nmep
->counterPC0
);
2304 pc
= (ucp
[0] << 8) | ucp
[1];
2315 nmep
->counterPC0
= 0;
2316 for (j
= 0; j
< k
; ++j
) {
2318 nmep
->counterPC0
<<= 8;
2319 nmep
->counterPC0
|= xp
[j
];
2330 nmep
->counterTFE_H
= 0;
2331 for (j
= 0; j
< k
; ++j
) {
2333 nmep
->counterTFE_H
<<= 8;
2334 nmep
->counterTFE_H
|= xp
[j
];
2345 nmep
->counterPE_H
= 0;
2346 for (j
= 0; j
< k
; ++j
) {
2348 nmep
->counterPE_H
<<= 8;
2349 nmep
->counterPE_H
|= xp
[j
];
2353 nmep
->gotExtraPC
= 1;
2361 /* Counts number of failed self-tests. Also encodes the poweron_hour
2362 of the most recent failed self-test. Return value is negative if
2363 this function has a problem (typically -1), otherwise the bottom 8
2364 bits are the number of failed self tests and the 16 bits above that
2365 are the poweron hour of the most recent failure. Note: aborted self
2366 tests (typically by the user) and self tests in progress are not
2367 considered failures. See Working Draft SCSI Primary Commands - 3
2368 (SPC-3) section 7.2.10 T10/1416-D (rev 22a) */
2370 scsiCountFailedSelfTests(scsi_device
* fd
, int noisy
)
2372 int num
, k
, n
, err
, res
, fails
, fail_hour
;
2374 unsigned char resp
[LOG_RESP_SELF_TEST_LEN
];
2376 if ((err
= scsiLogSense(fd
, SELFTEST_RESULTS_LPAGE
, 0, resp
,
2377 LOG_RESP_SELF_TEST_LEN
, 0))) {
2379 pout("scsiCountSelfTests Failed [%s]\n", scsiErrString(err
));
2382 if ((resp
[0] & 0x3f) != SELFTEST_RESULTS_LPAGE
) {
2384 pout("Self-test Log Sense Failed, page mismatch\n");
2387 // compute page length
2388 num
= (resp
[2] << 8) + resp
[3];
2389 // Log sense page length 0x190 bytes
2392 pout("Self-test Log Sense length is 0x%x not 0x190 bytes\n", num
);
2397 // loop through the twenty possible entries
2398 for (k
= 0, ucp
= resp
+ 4; k
< 20; ++k
, ucp
+= 20 ) {
2400 // timestamp in power-on hours (or zero if test in progress)
2401 n
= (ucp
[6] << 8) | ucp
[7];
2403 // The spec says "all 20 bytes will be zero if no test" but
2404 // DG has found otherwise. So this is a heuristic.
2405 if ((0 == n
) && (0 == ucp
[4]))
2408 if ((res
> 2) && (res
< 8)) {
2411 fail_hour
= (ucp
[6] << 8) + ucp
[7];
2414 return (fail_hour
<< 8) + fails
;
2417 /* Returns 0 if able to read self test log page; then outputs 1 into
2418 *inProgress if self test still in progress, else outputs 0. */
2420 scsiSelfTestInProgress(scsi_device
* fd
, int * inProgress
)
2424 unsigned char resp
[LOG_RESP_SELF_TEST_LEN
];
2426 if (scsiLogSense(fd
, SELFTEST_RESULTS_LPAGE
, 0, resp
,
2427 LOG_RESP_SELF_TEST_LEN
, 0))
2429 if (resp
[0] != SELFTEST_RESULTS_LPAGE
)
2431 // compute page length
2432 num
= (resp
[2] << 8) + resp
[3];
2433 // Log sense page length 0x190 bytes
2439 *inProgress
= (0xf == (ucp
[4] & 0xf)) ? 1 : 0;
2443 /* Returns a negative value if failed to fetch Contol mode page or it was
2444 malformed. Returns 0 if GLTSD bit is zero and returns 1 if the GLTSD
2445 bit is set. Examines default mode page when current==0 else examines
2446 current mode page. */
2448 scsiFetchControlGLTSD(scsi_device
* device
, int modese_len
, int current
)
2452 int pc
= current
? MPAGE_CONTROL_CURRENT
: MPAGE_CONTROL_DEFAULT
;
2454 memset(buff
, 0, sizeof(buff
));
2455 if (modese_len
<= 6) {
2456 if ((err
= scsiModeSense(device
, CONTROL_MODE_PAGE
, 0, pc
,
2457 buff
, sizeof(buff
)))) {
2458 if (SIMPLE_ERR_BAD_OPCODE
== err
)
2462 } else if (0 == modese_len
)
2465 if (10 == modese_len
) {
2466 err
= scsiModeSense10(device
, CONTROL_MODE_PAGE
, 0, pc
,
2467 buff
, sizeof(buff
));
2471 offset
= scsiModePageOffset(buff
, sizeof(buff
), modese_len
);
2472 if ((offset
>= 0) && (buff
[offset
+ 1] >= 0xa))
2473 return (buff
[offset
+ 2] & 2) ? 1 : 0;
2477 /* Returns a negative value on error, 0 if unknown and 1 if SSD,
2478 * otherwise the positive returned value is the speed in rpm. First checks
2479 * the Block Device Characteristics VPD page and if that fails it tries the
2480 * RIGID_DISK_DRIVE_GEOMETRY_PAGE mode page. */
2483 scsiGetRPM(scsi_device
* device
, int modese_len
, int * form_factorp
,
2486 int err
, offset
, speed
;
2488 int pc
= MPAGE_CONTROL_DEFAULT
;
2490 memset(buff
, 0, sizeof(buff
));
2491 if ((0 == scsiInquiryVpd(device
, SCSI_VPD_BLOCK_DEVICE_CHARACTERISTICS
,
2492 buff
, sizeof(buff
))) &&
2493 (((buff
[2] << 8) + buff
[3]) > 2)) {
2494 speed
= (buff
[4] << 8) + buff
[5];
2496 *form_factorp
= buff
[7] & 0xf;
2498 *haw_zbcp
= !!(0x10 & buff
[8]);
2505 if (modese_len
<= 6) {
2506 if ((err
= scsiModeSense(device
, RIGID_DISK_DRIVE_GEOMETRY_PAGE
, 0, pc
,
2507 buff
, sizeof(buff
)))) {
2508 if (SIMPLE_ERR_BAD_OPCODE
== err
)
2512 } else if (0 == modese_len
)
2515 if (10 == modese_len
) {
2516 err
= scsiModeSense10(device
, RIGID_DISK_DRIVE_GEOMETRY_PAGE
, 0, pc
,
2517 buff
, sizeof(buff
));
2521 offset
= scsiModePageOffset(buff
, sizeof(buff
), modese_len
);
2522 return (buff
[offset
+ 20] << 8) | buff
[offset
+ 21];
2525 /* Returns a non-zero value in case of error, wcep/rcdp == -1 - get value,
2526 0 - clear bit, 1 - set bit */
2529 scsiGetSetCache(scsi_device
* device
, int modese_len
, short int * wcep
,
2532 int err
, offset
, resp_len
, sp
;
2533 UINT8 buff
[64], ch_buff
[64];
2534 short set_wce
= *wcep
;
2535 short set_rcd
= *rcdp
;
2537 memset(buff
, 0, sizeof(buff
));
2538 if (modese_len
<= 6) {
2539 if ((err
= scsiModeSense(device
, CACHING_PAGE
, 0, MPAGE_CONTROL_CURRENT
,
2540 buff
, sizeof(buff
)))) {
2541 if (SIMPLE_ERR_BAD_OPCODE
== err
)
2544 device
->set_err(EINVAL
, "SCSI MODE SENSE failed");
2547 } else if (0 == modese_len
)
2551 if (10 == modese_len
) {
2552 err
= scsiModeSense10(device
, CACHING_PAGE
, 0, MPAGE_CONTROL_CURRENT
,
2553 buff
, sizeof(buff
));
2555 device
->set_err(EINVAL
, "SCSI MODE SENSE failed");
2559 offset
= scsiModePageOffset(buff
, sizeof(buff
), modese_len
);
2560 if ((offset
< 0) || (buff
[offset
+ 1] < 0xa)) {
2561 device
->set_err(EINVAL
, "Bad response");
2562 return SIMPLE_ERR_BAD_RESP
;
2565 *wcep
= ((buff
[offset
+ 2] & 0x04) != 0);
2566 *rcdp
= ((buff
[offset
+ 2] & 0x01) != 0);
2568 if((*wcep
== set_wce
|| set_wce
== -1)
2569 && ((*rcdp
== set_rcd
) || set_rcd
== -1))
2570 return 0; // no changes needed or nothing to set
2572 if (modese_len
== 6)
2573 err
= scsiModeSense(device
, CACHING_PAGE
, 0,
2574 MPAGE_CONTROL_CHANGEABLE
,
2575 ch_buff
, sizeof(ch_buff
));
2577 err
= scsiModeSense10(device
, CACHING_PAGE
, 0,
2578 MPAGE_CONTROL_CHANGEABLE
,
2579 ch_buff
, sizeof(ch_buff
));
2581 device
->set_err(EINVAL
, "WCE/RCD bits not changable");
2586 if(set_wce
>= 0 && *wcep
!= set_wce
) {
2587 if (0 == (ch_buff
[offset
+ 2] & 0x04)) {
2588 device
->set_err(EINVAL
, "WCE bit not changable");
2592 buff
[offset
+ 2] |= 0x04; // set bit
2594 buff
[offset
+ 2] &= 0xfb; // clear bit
2597 if(set_rcd
>= 0 && *rcdp
!= set_rcd
) {
2598 if (0 == (ch_buff
[offset
+ 2] & 0x01)) {
2599 device
->set_err(EINVAL
, "RCD bit not changable");
2603 buff
[offset
+ 2] |= 0x01; // set bit
2605 buff
[offset
+ 2] &= 0xfe; // clear bit
2608 /* mask out DPOFUA device specific (disk) parameter bit */
2609 if (10 == modese_len
) {
2610 resp_len
= (buff
[0] << 8) + buff
[1] + 2;
2613 resp_len
= buff
[0] + 1;
2616 sp
= 0; /* Do not change saved values */
2617 if (10 == modese_len
)
2618 err
= scsiModeSelect10(device
, sp
, buff
, resp_len
);
2619 else if (6 == modese_len
)
2620 err
= scsiModeSelect(device
, sp
, buff
, resp_len
);
2622 device
->set_err(EINVAL
, "MODE SELECT command failed");
2627 /* Attempts to set or clear GLTSD bit in Control mode page. If enabled is
2628 0 attempts to clear GLTSD otherwise it attempts to set it. Returns 0 if
2629 successful, negative if low level error, > 0 if higher level error (e.g.
2630 SIMPLE_ERR_BAD_PARAM if GLTSD bit is not changeable). */
2632 scsiSetControlGLTSD(scsi_device
* device
, int enabled
, int modese_len
)
2634 int err
, offset
, resp_len
, sp
;
2638 memset(buff
, 0, sizeof(buff
));
2639 if (modese_len
<= 6) {
2640 if ((err
= scsiModeSense(device
, CONTROL_MODE_PAGE
, 0,
2641 MPAGE_CONTROL_CURRENT
,
2642 buff
, sizeof(buff
)))) {
2643 if (SIMPLE_ERR_BAD_OPCODE
== err
)
2647 } else if (0 == modese_len
)
2650 if (10 == modese_len
) {
2651 err
= scsiModeSense10(device
, CONTROL_MODE_PAGE
, 0,
2652 MPAGE_CONTROL_CURRENT
,
2653 buff
, sizeof(buff
));
2657 offset
= scsiModePageOffset(buff
, sizeof(buff
), modese_len
);
2658 if ((offset
< 0) || (buff
[offset
+ 1] < 0xa))
2659 return SIMPLE_ERR_BAD_RESP
;
2663 if (enabled
== (buff
[offset
+ 2] & 2))
2664 return 0; /* GLTSD already in wanted state so nothing to do */
2666 if (modese_len
== 6)
2667 err
= scsiModeSense(device
, CONTROL_MODE_PAGE
, 0,
2668 MPAGE_CONTROL_CHANGEABLE
,
2669 ch_buff
, sizeof(ch_buff
));
2671 err
= scsiModeSense10(device
, CONTROL_MODE_PAGE
, 0,
2672 MPAGE_CONTROL_CHANGEABLE
,
2673 ch_buff
, sizeof(ch_buff
));
2676 if (0 == (ch_buff
[offset
+ 2] & 2))
2677 return SIMPLE_ERR_BAD_PARAM
; /* GLTSD bit not changeable */
2679 /* mask out DPOFUA device specific (disk) parameter bit */
2680 if (10 == modese_len
) {
2681 resp_len
= (buff
[0] << 8) + buff
[1] + 2;
2684 resp_len
= buff
[0] + 1;
2687 sp
= (buff
[offset
] & 0x80) ? 1 : 0; /* PS bit becomes 'SELECT's SP bit */
2689 buff
[offset
+ 2] |= 0x2; /* set GLTSD bit */
2691 buff
[offset
+ 2] &= 0xfd; /* clear GLTSD bit */
2692 if (10 == modese_len
)
2693 err
= scsiModeSelect10(device
, sp
, buff
, resp_len
);
2694 else if (6 == modese_len
)
2695 err
= scsiModeSelect(device
, sp
, buff
, resp_len
);
2699 /* Returns a negative value if failed to fetch Protocol specific port mode
2700 page or it was malformed. Returns transport protocol identifier when
2703 scsiFetchTransportProtocol(scsi_device
* device
, int modese_len
)
2708 memset(buff
, 0, sizeof(buff
));
2709 if (modese_len
<= 6) {
2710 if ((err
= scsiModeSense(device
, PROTOCOL_SPECIFIC_PORT_PAGE
, 0,
2711 MPAGE_CONTROL_CURRENT
,
2712 buff
, sizeof(buff
)))) {
2713 if (SIMPLE_ERR_BAD_OPCODE
== err
)
2717 } else if (0 == modese_len
)
2720 if (10 == modese_len
) {
2721 err
= scsiModeSense10(device
, PROTOCOL_SPECIFIC_PORT_PAGE
, 0,
2722 MPAGE_CONTROL_CURRENT
,
2723 buff
, sizeof(buff
));
2727 offset
= scsiModePageOffset(buff
, sizeof(buff
), modese_len
);
2728 if ((offset
>= 0) && (buff
[offset
+ 1] > 1)) {
2729 if ((0 == (buff
[offset
] & 0x40)) && /* SPF==0 */
2730 (PROTOCOL_SPECIFIC_PORT_PAGE
== (buff
[offset
] & 0x3f)))
2731 return (buff
[offset
+ 2] & 0xf);
2736 const unsigned char *
2737 sg_scsi_sense_desc_find(const unsigned char * sensep
, int sense_len
,
2740 int add_sen_len
, add_len
, desc_len
, k
;
2741 const unsigned char * descp
;
2743 if ((sense_len
< 8) || (0 == (add_sen_len
= sensep
[7])))
2745 if ((sensep
[0] < 0x72) || (sensep
[0] > 0x73))
2747 add_sen_len
= (add_sen_len
< (sense_len
- 8)) ?
2748 add_sen_len
: (sense_len
- 8);
2750 for (desc_len
= 0, k
= 0; k
< add_sen_len
; k
+= desc_len
) {
2752 add_len
= (k
< (add_sen_len
- 1)) ? descp
[1]: -1;
2753 desc_len
= add_len
+ 2;
2754 if (descp
[0] == desc_type
)
2756 if (add_len
< 0) /* short descriptor ?? */
2762 // Convenience function for formatting strings from SCSI identify
2764 scsi_format_id_string(char * out
, const unsigned char * in
, int n
)
2767 n
= n
> 64 ? 64 : n
;
2768 strncpy(tmp
, (const char *)in
, n
);
2771 // Find the first non-space character (maybe none).
2774 for (i
= 0; tmp
[i
]; i
++)
2775 if (!isspace((int)tmp
[i
])) {
2781 // There are no non-space characters.
2786 // Find the last non-space character.
2787 for (i
= strlen(tmp
)-1; i
>= first
&& isspace((int)tmp
[i
]); i
--);
2790 strncpy(out
, tmp
+first
, last
-first
+1);
2791 out
[last
-first
+1] = '\0';