1 /* $NetBSD: scsi_sense.c,v 1.7 2008/02/11 20:29:15 dyoung Exp $ */
4 * Copyright (c) 1998 The NetBSD Foundation, Inc.
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Charles M. Hannum; Jason R. Thorpe of the Numerical Aerospace
9 * Simulation Facility, NASA Ames Research Center.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
34 * SCSI sense interpretation. Lifted from src/sys/dev/scsipi/scsi_verbose.c,
35 * and modified for userland.
37 * XXX THESE SHOULD BE IN A LIBRARY!
39 #include <sys/cdefs.h>
42 __RCSID("$NetBSD: scsi_sense.c,v 1.7 2008/02/11 20:29:15 dyoung Exp $");
46 #include <sys/param.h>
47 #include <sys/scsiio.h>
51 #include <dev/scsipi/scsipi_all.h>
52 #include <dev/scsipi/scsi_all.h>
53 #include <dev/scsipi/scsipiconf.h>
57 static const char *sense_keys
[16] = {
58 "No Additional Sense",
79 const char *description
;
81 { 0x00, 0x00, "No Additional Sense Information" },
82 { 0x00, 0x01, "Filemark Detected" },
83 { 0x00, 0x02, "End-Of-Partition/Medium Detected" },
84 { 0x00, 0x03, "Setmark Detected" },
85 { 0x00, 0x04, "Beginning-Of-Partition/Medium Detected" },
86 { 0x00, 0x05, "End-Of-Data Detected" },
87 { 0x00, 0x06, "I/O Process Terminated" },
88 { 0x00, 0x11, "Audio Play Operation In Progress" },
89 { 0x00, 0x12, "Audio Play Operation Paused" },
90 { 0x00, 0x13, "Audio Play Operation Successfully Completed" },
91 { 0x00, 0x14, "Audio Play Operation Stopped Due to Error" },
92 { 0x00, 0x15, "No Current Audio Status To Return" },
93 { 0x01, 0x00, "No Index/Sector Signal" },
94 { 0x02, 0x00, "No Seek Complete" },
95 { 0x03, 0x00, "Peripheral Device Write Fault" },
96 { 0x03, 0x01, "No Write Current" },
97 { 0x03, 0x02, "Excessive Write Errors" },
98 { 0x04, 0x00, "Logical Unit Not Ready, Cause Not Reportable" },
99 { 0x04, 0x01, "Logical Unit Is in Process Of Becoming Ready" },
100 { 0x04, 0x02, "Logical Unit Not Ready, Initialization Command Required" },
101 { 0x04, 0x03, "Logical Unit Not Ready, Manual Intervention Required" },
102 { 0x04, 0x04, "Logical Unit Not Ready, Format In Progress" },
103 { 0x05, 0x00, "Logical Unit Does Not Respond To Selection" },
104 { 0x06, 0x00, "No Reference Position Found" },
105 { 0x07, 0x00, "Multiple Peripheral Devices Selected" },
106 { 0x08, 0x00, "Logical Unit Communication Failure" },
107 { 0x08, 0x01, "Logical Unit Communication Timeout" },
108 { 0x08, 0x02, "Logical Unit Communication Parity Error" },
109 { 0x09, 0x00, "Track Following Error" },
110 { 0x09, 0x01, "Tracking Servo Failure" },
111 { 0x09, 0x02, "Focus Servo Failure" },
112 { 0x09, 0x03, "Spindle Servo Failure" },
113 { 0x0A, 0x00, "Error Log Overflow" },
114 { 0x0C, 0x00, "Write Error" },
115 { 0x0C, 0x01, "Write Error Recovered with Auto Reallocation" },
116 { 0x0C, 0x02, "Write Error - Auto Reallocate Failed" },
117 { 0x10, 0x00, "ID CRC Or ECC Error" },
118 { 0x11, 0x00, "Unrecovered Read Error" },
119 { 0x11, 0x01, "Read Retried Exhausted" },
120 { 0x11, 0x02, "Error Too Long To Correct" },
121 { 0x11, 0x03, "Multiple Read Errors" },
122 { 0x11, 0x04, "Unrecovered Read Error - Auto Reallocate Failed" },
123 { 0x11, 0x05, "L-EC Uncorrectable Error" },
124 { 0x11, 0x06, "CIRC Unrecovered Error" },
125 { 0x11, 0x07, "Data Resynchronization Error" },
126 { 0x11, 0x08, "Incomplete Block Found" },
127 { 0x11, 0x09, "No Gap Found" },
128 { 0x11, 0x0A, "Miscorrected Error" },
129 { 0x11, 0x0B, "Uncorrected Read Error - Recommend Reassignment" },
130 { 0x11, 0x0C, "Uncorrected Read Error - Recommend Rewrite the Data" },
131 { 0x12, 0x00, "Address Mark Not Found for ID Field" },
132 { 0x13, 0x00, "Address Mark Not Found for Data Field" },
133 { 0x14, 0x00, "Recorded Entity Not Found" },
134 { 0x14, 0x01, "Record Not Found" },
135 { 0x14, 0x02, "Filemark or Setmark Not Found" },
136 { 0x14, 0x03, "End-Of-Data Not Found" },
137 { 0x14, 0x04, "Block Sequence Error" },
138 { 0x15, 0x00, "Random Positioning Error" },
139 { 0x15, 0x01, "Mechanical Positioning Error" },
140 { 0x15, 0x02, "Positioning Error Detected By Read of Medium" },
141 { 0x16, 0x00, "Data Synchronization Mark Error" },
142 { 0x17, 0x00, "Recovered Data With No Error Correction Applied" },
143 { 0x17, 0x01, "Recovered Data With Retries" },
144 { 0x17, 0x02, "Recovered Data With Positive Head Offset" },
145 { 0x17, 0x03, "Recovered Data With Negative Head Offset" },
146 { 0x17, 0x04, "Recovered Data With Retries and/or CIRC Applied" },
147 { 0x17, 0x05, "Recovered Data Using Previous Sector ID" },
148 { 0x17, 0x06, "Recovered Data Without ECC - Data Auto-Reallocated" },
149 { 0x17, 0x07, "Recovered Data Without ECC - Recommend Reassignment" },
150 { 0x17, 0x08, "Recovered Data Without ECC - Recommend Rewrite" },
151 { 0x18, 0x00, "Recovered Data With Error Correction Applied" },
152 { 0x18, 0x01, "Recovered Data With Error Correction & Retries Applied" },
153 { 0x18, 0x02, "Recovered Data - Data Auto-Reallocated" },
154 { 0x18, 0x03, "Recovered Data With CIRC" },
155 { 0x18, 0x04, "Recovered Data With LEC" },
156 { 0x18, 0x05, "Recovered Data - Recommend Reassignment" },
157 { 0x18, 0x06, "Recovered Data - Recommend Rewrite" },
158 { 0x19, 0x00, "Defect List Error" },
159 { 0x19, 0x01, "Defect List Not Available" },
160 { 0x19, 0x02, "Defect List Error in Primary List" },
161 { 0x19, 0x03, "Defect List Error in Grown List" },
162 { 0x1A, 0x00, "Parameter List Length Error" },
163 { 0x1B, 0x00, "Synchronous Data Transfer Error" },
164 { 0x1C, 0x00, "Defect List Not Found" },
165 { 0x1C, 0x01, "Primary Defect List Not Found" },
166 { 0x1C, 0x02, "Grown Defect List Not Found" },
167 { 0x1D, 0x00, "Miscompare During Verify Operation" },
168 { 0x1E, 0x00, "Recovered ID with ECC" },
169 { 0x20, 0x00, "Invalid Command Operation Code" },
170 { 0x21, 0x00, "Logical Block Address Out of Range" },
171 { 0x21, 0x01, "Invalid Element Address" },
172 { 0x22, 0x00, "Illegal Function (Should 20 00, 24 00, or 26 00)" },
173 { 0x24, 0x00, "Illegal Field in CDB" },
174 { 0x25, 0x00, "Logical Unit Not Supported" },
175 { 0x26, 0x00, "Invalid Field In Parameter List" },
176 { 0x26, 0x01, "Parameter Not Supported" },
177 { 0x26, 0x02, "Parameter Value Invalid" },
178 { 0x26, 0x03, "Threshold Parameters Not Supported" },
179 { 0x27, 0x00, "Write Protected" },
180 { 0x28, 0x00, "Not Ready To Ready Transition (Medium May Have Changed)" },
181 { 0x28, 0x01, "Import Or Export Element Accessed" },
182 { 0x29, 0x00, "Power On, Reset, or Bus Device Reset Occurred" },
183 { 0x2A, 0x00, "Parameters Changed" },
184 { 0x2A, 0x01, "Mode Parameters Changed" },
185 { 0x2A, 0x02, "Log Parameters Changed" },
186 { 0x2B, 0x00, "Copy Cannot Execute Since Host Cannot Disconnect" },
187 { 0x2C, 0x00, "Command Sequence Error" },
188 { 0x2C, 0x01, "Too Many Windows Specified" },
189 { 0x2C, 0x02, "Invalid Combination of Windows Specified" },
190 { 0x2D, 0x00, "Overwrite Error On Update In Place" },
191 { 0x2F, 0x00, "Commands Cleared By Another Initiator" },
192 { 0x30, 0x00, "Incompatible Medium Installed" },
193 { 0x30, 0x01, "Cannot Read Medium - Unknown Format" },
194 { 0x30, 0x02, "Cannot Read Medium - Incompatible Format" },
195 { 0x30, 0x03, "Cleaning Cartridge Installed" },
196 { 0x31, 0x00, "Medium Format Corrupted" },
197 { 0x31, 0x01, "Format Command Failed" },
198 { 0x32, 0x00, "No Defect Spare Location Available" },
199 { 0x32, 0x01, "Defect List Update Failure" },
200 { 0x33, 0x00, "Tape Length Error" },
201 { 0x36, 0x00, "Ribbon, Ink, or Toner Failure" },
202 { 0x37, 0x00, "Rounded Parameter" },
203 { 0x39, 0x00, "Saving Parameters Not Supported" },
204 { 0x3A, 0x00, "Medium Not Present" },
205 { 0x3B, 0x00, "Positioning Error" },
206 { 0x3B, 0x01, "Tape Position Error At Beginning-of-Medium" },
207 { 0x3B, 0x02, "Tape Position Error At End-of-Medium" },
208 { 0x3B, 0x03, "Tape or Electronic Vertical Forms Unit Not Ready" },
209 { 0x3B, 0x04, "Slew Failure" },
210 { 0x3B, 0x05, "Paper Jam" },
211 { 0x3B, 0x06, "Failed To Sense Top-Of-Form" },
212 { 0x3B, 0x07, "Failed To Sense Bottom-Of-Form" },
213 { 0x3B, 0x08, "Reposition Error" },
214 { 0x3B, 0x09, "Read Past End Of Medium" },
215 { 0x3B, 0x0A, "Read Past Begining Of Medium" },
216 { 0x3B, 0x0B, "Position Past End Of Medium" },
217 { 0x3B, 0x0C, "Position Past Beginning Of Medium" },
218 { 0x3B, 0x0D, "Medium Destination Element Full" },
219 { 0x3B, 0x0E, "Medium Source Element Empty" },
220 { 0x3D, 0x00, "Invalid Bits In IDENTIFY Message" },
221 { 0x3E, 0x00, "Logical Unit Has Not Self-Configured Yet" },
222 { 0x3F, 0x00, "Target Operating Conditions Have Changed" },
223 { 0x3F, 0x01, "Microcode Has Changed" },
224 { 0x3F, 0x02, "Changed Operating Definition" },
225 { 0x3F, 0x03, "INQUIRY Data Has Changed" },
226 { 0x40, 0x00, "RAM FAILURE (Should Use 40 NN)" },
227 { 0x41, 0x00, "Data Path FAILURE (Should Use 40 NN)" },
228 { 0x42, 0x00, "Power-On or Self-Test FAILURE (Should Use 40 NN)" },
229 { 0x43, 0x00, "Message Error" },
230 { 0x44, 0x00, "Internal Target Failure" },
231 { 0x45, 0x00, "Select Or Reselect Failure" },
232 { 0x46, 0x00, "Unsuccessful Soft Reset" },
233 { 0x47, 0x00, "SCSI Parity Error" },
234 { 0x48, 0x00, "INITIATOR DETECTED ERROR Message Received" },
235 { 0x49, 0x00, "Invalid Message Error" },
236 { 0x4A, 0x00, "Command Phase Error" },
237 { 0x4B, 0x00, "Data Phase Error" },
238 { 0x4C, 0x00, "Logical Unit Failed Self-Configuration" },
239 { 0x4E, 0x00, "Overlapped Commands Attempted" },
240 { 0x50, 0x00, "Write Append Error" },
241 { 0x50, 0x01, "Write Append Position Error" },
242 { 0x50, 0x01, "Write Append Position Error" },
243 { 0x50, 0x02, "Position Error Related To Timing" },
244 { 0x51, 0x00, "Erase Failure" },
245 { 0x52, 0x00, "Cartridge Fault" },
246 { 0x53, 0x00, "Media Load or Eject Failed" },
247 { 0x53, 0x01, "Unload Tape Failure" },
248 { 0x53, 0x02, "Medium Removal Prevented" },
249 { 0x54, 0x00, "SCSI To Host System Interface Failure" },
250 { 0x55, 0x00, "System Resource Failure" },
251 { 0x57, 0x00, "Unable To Recover Table-Of-Contents" },
252 { 0x58, 0x00, "Generation Does Not Exist" },
253 { 0x59, 0x00, "Updated Block Read" },
254 { 0x5A, 0x00, "Operator Request or State Change Input (Unspecified)" },
255 { 0x5A, 0x01, "Operator Medium Removal Requested" },
256 { 0x5A, 0x02, "Operator Selected Write Protect" },
257 { 0x5A, 0x03, "Operator Selected Write Permit" },
258 { 0x5B, 0x00, "Log Exception" },
259 { 0x5B, 0x01, "Threshold Condition Met" },
260 { 0x5B, 0x02, "Log Counter At Maximum" },
261 { 0x5B, 0x03, "Log List Codes Exhausted" },
262 { 0x5C, 0x00, "RPL Status Change" },
263 { 0x5C, 0x01, "Spindles Synchronized" },
264 { 0x5C, 0x02, "Spindles Not Synchronized" },
265 { 0x60, 0x00, "Lamp Failure" },
266 { 0x61, 0x00, "Video Acquisition Error" },
267 { 0x61, 0x01, "Unable To Acquire Video" },
268 { 0x61, 0x02, "Out Of Focus" },
269 { 0x62, 0x00, "Scan Head Positioning Error" },
270 { 0x63, 0x00, "End Of User Area Encountered On This Track" },
271 { 0x64, 0x00, "Illegal Mode For This Track" },
275 static void asc2ascii(unsigned char, unsigned char, char *, size_t);
278 asc2ascii(unsigned char asc
, unsigned char ascq
, char *result
, size_t reslen
)
282 while (adesc
[i
].description
!= NULL
) {
283 if (adesc
[i
].asc
== asc
&& adesc
[i
].ascq
== ascq
)
287 if (adesc
[i
].description
== NULL
) {
288 if (asc
== 0x40 && ascq
!= 0)
289 (void) snprintf(result
, reslen
,
290 "Diagnostic Failure on Component 0x%02x",
293 (void) snprintf(result
, reslen
,
294 "ASC 0x%02x ASCQ 0x%02x",
295 asc
& 0xff, ascq
& 0xff);
297 (void) strlcpy(result
, adesc
[i
].description
, reslen
);
301 scsi_print_sense_data(const unsigned char *s
, int slen
, int verbosity
)
308 * Basics - print out SENSE KEY
310 printf(" SENSE KEY: %s", scsi_decode_sense(s
, 0, sbs
, sizeof(sbs
)));
313 * Print out, unqualified but aligned, FMK, EOM and ILI status.
319 if (s
[2] & SSD_FILEMARK
) {
320 printf("%c Filemark Detected", pad
);
323 if (s
[2] & SSD_EOM
) {
324 printf("%c EOM Detected", pad
);
328 printf("%c Incorrect Length Indicator Set", pad
);
332 * Now we should figure out, based upon device type, how
333 * to format the information field. Unfortunately, that's
334 * not convenient here, so we'll print it as a signed
337 info
= _4btol(&s
[3]);
339 printf("\n INFO FIELD: %d", info
);
342 * Now we check additional length to see whether there is
343 * more information to extract.
346 /* enough for command specific information? */
347 if (((unsigned int) s
[7]) < 4) {
351 info
= _4btol(&s
[8]);
353 printf("\n COMMAND INFO: %d (0x%x)", info
, info
);
356 * Decode ASC && ASCQ info, plus FRU, plus the rest...
359 cp
= scsi_decode_sense(s
, 1, sbs
, sizeof(sbs
));
361 printf("\n ASC/ASCQ: %s", cp
);
363 printf("\n FRU CODE: 0x%x", s
[14] & 0xff);
364 cp
= scsi_decode_sense(s
, 3, sbs
, sizeof(sbs
));
366 printf("\n SKSV: %s", cp
);
368 if (verbosity
== 0) {
374 * Now figure whether we should print any additional informtion.
376 * Where should we start from? If we had SKSV data,
377 * start from offset 18, else from offset 15.
379 * From that point until the end of the buffer, check for any
380 * nonzero data. If we have some, go back and print the lot,
381 * otherwise we're done.
387 for (j
= i
; j
< slen
; j
++)
393 printf("\n Additional Sense Information (byte %d out...):\n", i
);
395 printf("\n\t%2d:", i
);
398 printf("\n\t%2d:", i
);
407 printf("\n\t%2d:", i
);
409 printf(" 0x%02x", s
[i
] & 0xff);
418 scsi_decode_sense(const unsigned char *snsbuf
, int flag
, char *rqsbuf
,
426 if (flag
== 0 || flag
== 2 || flag
== 3)
427 skey
= snsbuf
[2] & 0xf;
428 if (flag
== 0) { /* Sense Key Only */
429 (void) strlcpy(rqsbuf
, sense_keys
[skey
], rqsbuflen
);
431 } else if (flag
== 1) { /* ASC/ASCQ Only */
432 asc2ascii(snsbuf
[12], snsbuf
[13], rqsbuf
, rqsbuflen
);
434 } else if (flag
== 2) { /* Sense Key && ASC/ASCQ */
435 asc2ascii(snsbuf
[12], snsbuf
[13], localbuf
, sizeof(localbuf
));
436 (void) snprintf(rqsbuf
, rqsbuflen
, "%s, %s", sense_keys
[skey
],
439 } else if (flag
== 3 && snsbuf
[7] >= 9 && (snsbuf
[15] & 0x80)) {
444 case SKEY_ILLEGAL_REQUEST
:
445 if (snsbuf
[15] & 0x8)
446 (void) snprintf(rqsbuf
, rqsbuflen
,
447 "Error in %s, Offset %d, bit %d",
448 (snsbuf
[15] & 0x40)? "CDB" : "Parameters",
449 (snsbuf
[16] & 0xff) << 8 |
450 (snsbuf
[17] & 0xff), snsbuf
[15] & 0x7);
452 (void) snprintf(rqsbuf
, rqsbuflen
,
453 "Error in %s, Offset %d",
454 (snsbuf
[15] & 0x40)? "CDB" : "Parameters",
455 (snsbuf
[16] & 0xff) << 8 |
456 (snsbuf
[17] & 0xff));
459 case SKEY_RECOVERED_ERROR
:
460 case SKEY_MEDIUM_ERROR
:
461 case SKEY_HARDWARE_ERROR
:
462 (void) snprintf(rqsbuf
, rqsbuflen
,
463 "Actual Retry Count: %d",
464 (snsbuf
[16] & 0xff) << 8 | (snsbuf
[17] & 0xff));
468 (void) snprintf(rqsbuf
, rqsbuflen
,
469 "Progress Indicator: %d",
470 (snsbuf
[16] & 0xff) << 8 | (snsbuf
[17] & 0xff));
481 scsi_print_sense(const char *name
, const scsireq_t
*req
, int verbosity
)
485 printf("%s: Check Condition on CDB:", name
);
486 for (i
= 0; i
< req
->cmdlen
; i
++)
487 printf(" %02x", req
->cmd
[i
]);
489 scsi_print_sense_data(req
->sense
, req
->senselen_used
, verbosity
);