1 /*-
2 * Implementation of Utility functions for all SCSI device types.
3 *
4 * Copyright (c) 1997, 1998, 1999 Justin T. Gibbs.
5 * Copyright (c) 1997, 1998, 2003 Kenneth D. Merry.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions, and the following disclaimer,
13 * without modification, immediately at the beginning of the file.
14 * 2. The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
21 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 */
29
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
32
33 #include <sys/param.h>
34 #include <sys/types.h>
35 #include <sys/stdint.h>
36
37 #ifdef _KERNEL
38 #include <opt_scsi.h>
39
40 #include <sys/systm.h>
41 #include <sys/libkern.h>
42 #include <sys/kernel.h>
43 #include <sys/lock.h>
44 #include <sys/malloc.h>
45 #include <sys/mutex.h>
46 #include <sys/sysctl.h>
47 #include <sys/ctype.h>
48 #else
49 #include <errno.h>
50 #include <stdio.h>
51 #include <stdlib.h>
52 #include <string.h>
53 #include <ctype.h>
54 #endif
55
56 #include <cam/cam.h>
57 #include <cam/cam_ccb.h>
58 #include <cam/cam_queue.h>
59 #include <cam/cam_xpt.h>
60 #include <cam/scsi/scsi_all.h>
61 #include <sys/ata.h>
62 #include <sys/sbuf.h>
63
64 #ifdef _KERNEL
65 #include <cam/cam_periph.h>
66 #include <cam/cam_xpt_sim.h>
67 #include <cam/cam_xpt_periph.h>
68 #include <cam/cam_xpt_internal.h>
69 #else
70 #include <camlib.h>
71 #include <stddef.h>
72
73 #ifndef FALSE
74 #define FALSE 0
75 #endif /* FALSE */
76 #ifndef TRUE
77 #define TRUE 1
78 #endif /* TRUE */
79 #define ERESTART -1 /* restart syscall */
80 #define EJUSTRETURN -2 /* don't modify regs, just return */
81 #endif /* !_KERNEL */
82
83 /*
84 * This is the default number of milliseconds we wait for devices to settle
85 * after a SCSI bus reset.
86 */
87 #ifndef SCSI_DELAY
88 #define SCSI_DELAY 2000
89 #endif
90 /*
91 * All devices need _some_ sort of bus settle delay, so we'll set it to
92 * a minimum value of 100ms. Note that this is pertinent only for SPI-
93 * not transport like Fibre Channel or iSCSI where 'delay' is completely
94 * meaningless.
95 */
96 #ifndef SCSI_MIN_DELAY
97 #define SCSI_MIN_DELAY 100
98 #endif
99 /*
100 * Make sure the user isn't using seconds instead of milliseconds.
101 */
102 #if (SCSI_DELAY < SCSI_MIN_DELAY && SCSI_DELAY != 0)
103 #error "SCSI_DELAY is in milliseconds, not seconds! Please use a larger value"
104 #endif
105
106 int scsi_delay;
107
108 static int ascentrycomp(const void *key, const void *member);
109 static int senseentrycomp(const void *key, const void *member);
110 static void fetchtableentries(int sense_key, int asc, int ascq,
111 struct scsi_inquiry_data *,
112 const struct sense_key_table_entry **,
113 const struct asc_table_entry **);
114
115 #ifdef _KERNEL
116 static void init_scsi_delay(void);
117 static int sysctl_scsi_delay(SYSCTL_HANDLER_ARGS);
118 static int set_scsi_delay(int delay);
119 #endif
120
121 #if !defined(SCSI_NO_OP_STRINGS)
122
123 #define D (1 << T_DIRECT)
124 #define T (1 << T_SEQUENTIAL)
125 #define L (1 << T_PRINTER)
126 #define P (1 << T_PROCESSOR)
127 #define W (1 << T_WORM)
128 #define R (1 << T_CDROM)
129 #define O (1 << T_OPTICAL)
130 #define M (1 << T_CHANGER)
131 #define A (1 << T_STORARRAY)
132 #define E (1 << T_ENCLOSURE)
133 #define B (1 << T_RBC)
134 #define K (1 << T_OCRW)
135 #define V (1 << T_ADC)
136 #define F (1 << T_OSD)
137 #define S (1 << T_SCANNER)
138 #define C (1 << T_COMM)
139
140 #define ALL (D | T | L | P | W | R | O | M | A | E | B | K | V | F | S | C)
141
142 static struct op_table_entry plextor_cd_ops[] = {
143 { 0xD8, R, "CD-DA READ" }
144 };
145
146 static struct scsi_op_quirk_entry scsi_op_quirk_table[] = {
147 {
148 /*
149 * I believe that 0xD8 is the Plextor proprietary command
150 * to read CD-DA data. I'm not sure which Plextor CDROM
151 * models support the command, though. I know for sure
152 * that the 4X, 8X, and 12X models do, and presumably the
153 * 12-20X does. I don't know about any earlier models,
154 * though. If anyone has any more complete information,
155 * feel free to change this quirk entry.
156 */
157 {T_CDROM, SIP_MEDIA_REMOVABLE, "PLEXTOR", "CD-ROM PX*", "*"},
158 nitems(plextor_cd_ops),
159 plextor_cd_ops
160 }
161 };
162
163 static struct op_table_entry scsi_op_codes[] = {
164 /*
165 * From: http://www.t10.org/lists/op-num.txt
166 * Modifications by Kenneth Merry (ken@FreeBSD.ORG)
167 * and Jung-uk Kim (jkim@FreeBSD.org)
168 *
169 * Note: order is important in this table, scsi_op_desc() currently
170 * depends on the opcodes in the table being in order to save
171 * search time.
172 * Note: scanner and comm. devices are carried over from the previous
173 * version because they were removed in the latest spec.
174 */
175 /* File: OP-NUM.TXT
176 *
177 * SCSI Operation Codes
178 * Numeric Sorted Listing
179 * as of 5/26/15
180 *
181 * D - DIRECT ACCESS DEVICE (SBC-2) device column key
182 * .T - SEQUENTIAL ACCESS DEVICE (SSC-2) -----------------
183 * . L - PRINTER DEVICE (SSC) M = Mandatory
184 * . P - PROCESSOR DEVICE (SPC) O = Optional
185 * . .W - WRITE ONCE READ MULTIPLE DEVICE (SBC-2) V = Vendor spec.
186 * . . R - CD/DVE DEVICE (MMC-3) Z = Obsolete
187 * . . O - OPTICAL MEMORY DEVICE (SBC-2)
188 * . . .M - MEDIA CHANGER DEVICE (SMC-2)
189 * . . . A - STORAGE ARRAY DEVICE (SCC-2)
190 * . . . .E - ENCLOSURE SERVICES DEVICE (SES)
191 * . . . .B - SIMPLIFIED DIRECT-ACCESS DEVICE (RBC)
192 * . . . . K - OPTICAL CARD READER/WRITER DEVICE (OCRW)
193 * . . . . V - AUTOMATION/DRIVE INTERFACE (ADC)
194 * . . . . .F - OBJECT-BASED STORAGE (OSD)
195 * OP DTLPWROMAEBKVF Description
196 * -- -------------- ---------------------------------------------- */
197 /* 00 MMMMMMMMMMMMMM TEST UNIT READY */
198 { 0x00, ALL, "TEST UNIT READY" },
199 /* 01 M REWIND */
200 { 0x01, T, "REWIND" },
201 /* 01 Z V ZZZZ REZERO UNIT */
202 { 0x01, D | W | R | O | M, "REZERO UNIT" },
203 /* 02 VVVVVV V */
204 /* 03 MMMMMMMMMMOMMM REQUEST SENSE */
205 { 0x03, ALL, "REQUEST SENSE" },
206 /* 04 M OO FORMAT UNIT */
207 { 0x04, D | R | O, "FORMAT UNIT" },
208 /* 04 O FORMAT MEDIUM */
209 { 0x04, T, "FORMAT MEDIUM" },
210 /* 04 O FORMAT */
211 { 0x04, L, "FORMAT" },
212 /* 05 VMVVVV V READ BLOCK LIMITS */
213 { 0x05, T, "READ BLOCK LIMITS" },
214 /* 06 VVVVVV V */
215 /* 07 OVV O OV REASSIGN BLOCKS */
216 { 0x07, D | W | O, "REASSIGN BLOCKS" },
217 /* 07 O INITIALIZE ELEMENT STATUS */
218 { 0x07, M, "INITIALIZE ELEMENT STATUS" },
219 /* 08 MOV O OV READ(6) */
220 { 0x08, D | T | W | O, "READ(6)" },
221 /* 08 O RECEIVE */
222 { 0x08, P, "RECEIVE" },
223 /* 08 GET MESSAGE(6) */
224 { 0x08, C, "GET MESSAGE(6)" },
225 /* 09 VVVVVV V */
226 /* 0A OO O OV WRITE(6) */
227 { 0x0A, D | T | W | O, "WRITE(6)" },
228 /* 0A M SEND(6) */
229 { 0x0A, P, "SEND(6)" },
230 /* 0A SEND MESSAGE(6) */
231 { 0x0A, C, "SEND MESSAGE(6)" },
232 /* 0A M PRINT */
233 { 0x0A, L, "PRINT" },
234 /* 0B Z ZOZV SEEK(6) */
235 { 0x0B, D | W | R | O, "SEEK(6)" },
236 /* 0B O SET CAPACITY */
237 { 0x0B, T, "SET CAPACITY" },
238 /* 0B O SLEW AND PRINT */
239 { 0x0B, L, "SLEW AND PRINT" },
240 /* 0C VVVVVV V */
241 /* 0D VVVVVV V */
242 /* 0E VVVVVV V */
243 /* 0F VOVVVV V READ REVERSE(6) */
244 { 0x0F, T, "READ REVERSE(6)" },
245 /* 10 VM VVV WRITE FILEMARKS(6) */
246 { 0x10, T, "WRITE FILEMARKS(6)" },
247 /* 10 O SYNCHRONIZE BUFFER */
248 { 0x10, L, "SYNCHRONIZE BUFFER" },
249 /* 11 VMVVVV SPACE(6) */
250 { 0x11, T, "SPACE(6)" },
251 /* 12 MMMMMMMMMMMMMM INQUIRY */
252 { 0x12, ALL, "INQUIRY" },
253 /* 13 V VVVV */
254 /* 13 O VERIFY(6) */
255 { 0x13, T, "VERIFY(6)" },
256 /* 14 VOOVVV RECOVER BUFFERED DATA */
257 { 0x14, T | L, "RECOVER BUFFERED DATA" },
258 /* 15 OMO O OOOO OO MODE SELECT(6) */
259 { 0x15, ALL & ~(P | R | B | F), "MODE SELECT(6)" },
260 /* 16 ZZMZO OOOZ O RESERVE(6) */
261 { 0x16, ALL & ~(R | B | V | F | C), "RESERVE(6)" },
262 /* 16 Z RESERVE ELEMENT(6) */
263 { 0x16, M, "RESERVE ELEMENT(6)" },
264 /* 17 ZZMZO OOOZ O RELEASE(6) */
265 { 0x17, ALL & ~(R | B | V | F | C), "RELEASE(6)" },
266 /* 17 Z RELEASE ELEMENT(6) */
267 { 0x17, M, "RELEASE ELEMENT(6)" },
268 /* 18 ZZZZOZO Z COPY */
269 { 0x18, D | T | L | P | W | R | O | K | S, "COPY" },
270 /* 19 VMVVVV ERASE(6) */
271 { 0x19, T, "ERASE(6)" },
272 /* 1A OMO O OOOO OO MODE SENSE(6) */
273 { 0x1A, ALL & ~(P | R | B | F), "MODE SENSE(6)" },
274 /* 1B O OOO O MO O START STOP UNIT */
275 { 0x1B, D | W | R | O | A | B | K | F, "START STOP UNIT" },
276 /* 1B O M LOAD UNLOAD */
277 { 0x1B, T | V, "LOAD UNLOAD" },
278 /* 1B SCAN */
279 { 0x1B, S, "SCAN" },
280 /* 1B O STOP PRINT */
281 { 0x1B, L, "STOP PRINT" },
282 /* 1B O OPEN/CLOSE IMPORT/EXPORT ELEMENT */
283 { 0x1B, M, "OPEN/CLOSE IMPORT/EXPORT ELEMENT" },
284 /* 1C OOOOO OOOM OOO RECEIVE DIAGNOSTIC RESULTS */
285 { 0x1C, ALL & ~(R | B), "RECEIVE DIAGNOSTIC RESULTS" },
286 /* 1D MMMMM MMOM MMM SEND DIAGNOSTIC */
287 { 0x1D, ALL & ~(R | B), "SEND DIAGNOSTIC" },
288 /* 1E OO OOOO O O PREVENT ALLOW MEDIUM REMOVAL */
289 { 0x1E, D | T | W | R | O | M | K | F, "PREVENT ALLOW MEDIUM REMOVAL" },
290 /* 1F */
291 /* 20 V VVV V */
292 /* 21 V VVV V */
293 /* 22 V VVV V */
294 /* 23 V V V V */
295 /* 23 O READ FORMAT CAPACITIES */
296 { 0x23, R, "READ FORMAT CAPACITIES" },
297 /* 24 V VV SET WINDOW */
298 { 0x24, S, "SET WINDOW" },
299 /* 25 M M M M READ CAPACITY(10) */
300 { 0x25, D | W | O | B, "READ CAPACITY(10)" },
301 /* 25 O READ CAPACITY */
302 { 0x25, R, "READ CAPACITY" },
303 /* 25 M READ CARD CAPACITY */
304 { 0x25, K, "READ CARD CAPACITY" },
305 /* 25 GET WINDOW */
306 { 0x25, S, "GET WINDOW" },
307 /* 26 V VV */
308 /* 27 V VV */
309 /* 28 M MOM MM READ(10) */
310 { 0x28, D | W | R | O | B | K | S, "READ(10)" },
311 /* 28 GET MESSAGE(10) */
312 { 0x28, C, "GET MESSAGE(10)" },
313 /* 29 V VVO READ GENERATION */
314 { 0x29, O, "READ GENERATION" },
315 /* 2A O MOM MO WRITE(10) */
316 { 0x2A, D | W | R | O | B | K, "WRITE(10)" },
317 /* 2A SEND(10) */
318 { 0x2A, S, "SEND(10)" },
319 /* 2A SEND MESSAGE(10) */
320 { 0x2A, C, "SEND MESSAGE(10)" },
321 /* 2B Z OOO O SEEK(10) */
322 { 0x2B, D | W | R | O | K, "SEEK(10)" },
323 /* 2B O LOCATE(10) */
324 { 0x2B, T, "LOCATE(10)" },
325 /* 2B O POSITION TO ELEMENT */
326 { 0x2B, M, "POSITION TO ELEMENT" },
327 /* 2C V OO ERASE(10) */
328 { 0x2C, R | O, "ERASE(10)" },
329 /* 2D O READ UPDATED BLOCK */
330 { 0x2D, O, "READ UPDATED BLOCK" },
331 /* 2D V */
332 /* 2E O OOO MO WRITE AND VERIFY(10) */
333 { 0x2E, D | W | R | O | B | K, "WRITE AND VERIFY(10)" },
334 /* 2F O OOO VERIFY(10) */
335 { 0x2F, D | W | R | O, "VERIFY(10)" },
336 /* 30 Z ZZZ SEARCH DATA HIGH(10) */
337 { 0x30, D | W | R | O, "SEARCH DATA HIGH(10)" },
338 /* 31 Z ZZZ SEARCH DATA EQUAL(10) */
339 { 0x31, D | W | R | O, "SEARCH DATA EQUAL(10)" },
340 /* 31 OBJECT POSITION */
341 { 0x31, S, "OBJECT POSITION" },
342 /* 32 Z ZZZ SEARCH DATA LOW(10) */
343 { 0x32, D | W | R | O, "SEARCH DATA LOW(10)" },
344 /* 33 Z OZO SET LIMITS(10) */
345 { 0x33, D | W | R | O, "SET LIMITS(10)" },
346 /* 34 O O O O PRE-FETCH(10) */
347 { 0x34, D | W | O | K, "PRE-FETCH(10)" },
348 /* 34 M READ POSITION */
349 { 0x34, T, "READ POSITION" },
350 /* 34 GET DATA BUFFER STATUS */
351 { 0x34, S, "GET DATA BUFFER STATUS" },
352 /* 35 O OOO MO SYNCHRONIZE CACHE(10) */
353 { 0x35, D | W | R | O | B | K, "SYNCHRONIZE CACHE(10)" },
354 /* 36 Z O O O LOCK UNLOCK CACHE(10) */
355 { 0x36, D | W | O | K, "LOCK UNLOCK CACHE(10)" },
356 /* 37 O O READ DEFECT DATA(10) */
357 { 0x37, D | O, "READ DEFECT DATA(10)" },
358 /* 37 O INITIALIZE ELEMENT STATUS WITH RANGE */
359 { 0x37, M, "INITIALIZE ELEMENT STATUS WITH RANGE" },
360 /* 38 O O O MEDIUM SCAN */
361 { 0x38, W | O | K, "MEDIUM SCAN" },
362 /* 39 ZZZZOZO Z COMPARE */
363 { 0x39, D | T | L | P | W | R | O | K | S, "COMPARE" },
364 /* 3A ZZZZOZO Z COPY AND VERIFY */
365 { 0x3A, D | T | L | P | W | R | O | K | S, "COPY AND VERIFY" },
366 /* 3B OOOOOOOOOOMOOO WRITE BUFFER */
367 { 0x3B, ALL, "WRITE BUFFER" },
368 /* 3C OOOOOOOOOO OOO READ BUFFER */
369 { 0x3C, ALL & ~(B), "READ BUFFER" },
370 /* 3D O UPDATE BLOCK */
371 { 0x3D, O, "UPDATE BLOCK" },
372 /* 3E O O O READ LONG(10) */
373 { 0x3E, D | W | O, "READ LONG(10)" },
374 /* 3F O O O WRITE LONG(10) */
375 { 0x3F, D | W | O, "WRITE LONG(10)" },
376 /* 40 ZZZZOZOZ CHANGE DEFINITION */
377 { 0x40, D | T | L | P | W | R | O | M | S | C, "CHANGE DEFINITION" },
378 /* 41 O WRITE SAME(10) */
379 { 0x41, D, "WRITE SAME(10)" },
380 /* 42 O UNMAP */
381 { 0x42, D, "UNMAP" },
382 /* 42 O READ SUB-CHANNEL */
383 { 0x42, R, "READ SUB-CHANNEL" },
384 /* 43 O READ TOC/PMA/ATIP */
385 { 0x43, R, "READ TOC/PMA/ATIP" },
386 /* 44 M M REPORT DENSITY SUPPORT */
387 { 0x44, T | V, "REPORT DENSITY SUPPORT" },
388 /* 44 READ HEADER */
389 /* 45 O PLAY AUDIO(10) */
390 { 0x45, R, "PLAY AUDIO(10)" },
391 /* 46 M GET CONFIGURATION */
392 { 0x46, R, "GET CONFIGURATION" },
393 /* 47 O PLAY AUDIO MSF */
394 { 0x47, R, "PLAY AUDIO MSF" },
395 /* 48 O SANITIZE */
396 { 0x48, D, "SANITIZE" },
397 /* 49 */
398 /* 4A M GET EVENT STATUS NOTIFICATION */
399 { 0x4A, R, "GET EVENT STATUS NOTIFICATION" },
400 /* 4B O PAUSE/RESUME */
401 { 0x4B, R, "PAUSE/RESUME" },
402 /* 4C OOOOO OOOO OOO LOG SELECT */
403 { 0x4C, ALL & ~(R | B), "LOG SELECT" },
404 /* 4D OOOOO OOOO OMO LOG SENSE */
405 { 0x4D, ALL & ~(R | B), "LOG SENSE" },
406 /* 4E O STOP PLAY/SCAN */
407 { 0x4E, R, "STOP PLAY/SCAN" },
408 /* 4F */
409 /* 50 O XDWRITE(10) */
410 { 0x50, D, "XDWRITE(10)" },
411 /* 51 O XPWRITE(10) */
412 { 0x51, D, "XPWRITE(10)" },
413 /* 51 O READ DISC INFORMATION */
414 { 0x51, R, "READ DISC INFORMATION" },
415 /* 52 O XDREAD(10) */
416 { 0x52, D, "XDREAD(10)" },
417 /* 52 O READ TRACK INFORMATION */
418 { 0x52, R, "READ TRACK INFORMATION" },
419 /* 53 O RESERVE TRACK */
420 { 0x53, R, "RESERVE TRACK" },
421 /* 54 O SEND OPC INFORMATION */
422 { 0x54, R, "SEND OPC INFORMATION" },
423 /* 55 OOO OMOOOOMOMO MODE SELECT(10) */
424 { 0x55, ALL & ~(P), "MODE SELECT(10)" },
425 /* 56 ZZMZO OOOZ RESERVE(10) */
426 { 0x56, ALL & ~(R | B | K | V | F | C), "RESERVE(10)" },
427 /* 56 Z RESERVE ELEMENT(10) */
428 { 0x56, M, "RESERVE ELEMENT(10)" },
429 /* 57 ZZMZO OOOZ RELEASE(10) */
430 { 0x57, ALL & ~(R | B | K | V | F | C), "RELEASE(10)" },
431 /* 57 Z RELEASE ELEMENT(10) */
432 { 0x57, M, "RELEASE ELEMENT(10)" },
433 /* 58 O REPAIR TRACK */
434 { 0x58, R, "REPAIR TRACK" },
435 /* 59 */
436 /* 5A OOO OMOOOOMOMO MODE SENSE(10) */
437 { 0x5A, ALL & ~(P), "MODE SENSE(10)" },
438 /* 5B O CLOSE TRACK/SESSION */
439 { 0x5B, R, "CLOSE TRACK/SESSION" },
440 /* 5C O READ BUFFER CAPACITY */
441 { 0x5C, R, "READ BUFFER CAPACITY" },
442 /* 5D O SEND CUE SHEET */
443 { 0x5D, R, "SEND CUE SHEET" },
444 /* 5E OOOOO OOOO M PERSISTENT RESERVE IN */
445 { 0x5E, ALL & ~(R | B | K | V | C), "PERSISTENT RESERVE IN" },
446 /* 5F OOOOO OOOO M PERSISTENT RESERVE OUT */
447 { 0x5F, ALL & ~(R | B | K | V | C), "PERSISTENT RESERVE OUT" },
448 /* 7E OO O OOOO O extended CDB */
449 { 0x7E, D | T | R | M | A | E | B | V, "extended CDB" },
450 /* 7F O M variable length CDB (more than 16 bytes) */
451 { 0x7F, D | F, "variable length CDB (more than 16 bytes)" },
452 /* 80 Z XDWRITE EXTENDED(16) */
453 { 0x80, D, "XDWRITE EXTENDED(16)" },
454 /* 80 M WRITE FILEMARKS(16) */
455 { 0x80, T, "WRITE FILEMARKS(16)" },
456 /* 81 Z REBUILD(16) */
457 { 0x81, D, "REBUILD(16)" },
458 /* 81 O READ REVERSE(16) */
459 { 0x81, T, "READ REVERSE(16)" },
460 /* 82 Z REGENERATE(16) */
461 { 0x82, D, "REGENERATE(16)" },
462 /* 83 OOOOO O OO EXTENDED COPY */
463 { 0x83, D | T | L | P | W | O | K | V, "EXTENDED COPY" },
464 /* 84 OOOOO O OO RECEIVE COPY RESULTS */
465 { 0x84, D | T | L | P | W | O | K | V, "RECEIVE COPY RESULTS" },
466 /* 85 O O O ATA COMMAND PASS THROUGH(16) */
467 { 0x85, D | R | B, "ATA COMMAND PASS THROUGH(16)" },
468 /* 86 OO OO OOOOOOO ACCESS CONTROL IN */
469 { 0x86, ALL & ~(L | R | F), "ACCESS CONTROL IN" },
470 /* 87 OO OO OOOOOOO ACCESS CONTROL OUT */
471 { 0x87, ALL & ~(L | R | F), "ACCESS CONTROL OUT" },
472 /* 88 MM O O O READ(16) */
473 { 0x88, D | T | W | O | B, "READ(16)" },
474 /* 89 O COMPARE AND WRITE*/
475 { 0x89, D, "COMPARE AND WRITE" },
476 /* 8A OM O O O WRITE(16) */
477 { 0x8A, D | T | W | O | B, "WRITE(16)" },
478 /* 8B O ORWRITE */
479 { 0x8B, D, "ORWRITE" },
480 /* 8C OO O OO O M READ ATTRIBUTE */
481 { 0x8C, D | T | W | O | M | B | V, "READ ATTRIBUTE" },
482 /* 8D OO O OO O O WRITE ATTRIBUTE */
483 { 0x8D, D | T | W | O | M | B | V, "WRITE ATTRIBUTE" },
484 /* 8E O O O O WRITE AND VERIFY(16) */
485 { 0x8E, D | W | O | B, "WRITE AND VERIFY(16)" },
486 /* 8F OO O O O VERIFY(16) */
487 { 0x8F, D | T | W | O | B, "VERIFY(16)" },
488 /* 90 O O O O PRE-FETCH(16) */
489 { 0x90, D | W | O | B, "PRE-FETCH(16)" },
490 /* 91 O O O O SYNCHRONIZE CACHE(16) */
491 { 0x91, D | W | O | B, "SYNCHRONIZE CACHE(16)" },
492 /* 91 O SPACE(16) */
493 { 0x91, T, "SPACE(16)" },
494 /* 92 Z O O LOCK UNLOCK CACHE(16) */
495 { 0x92, D | W | O, "LOCK UNLOCK CACHE(16)" },
496 /* 92 O LOCATE(16) */
497 { 0x92, T, "LOCATE(16)" },
498 /* 93 O WRITE SAME(16) */
499 { 0x93, D, "WRITE SAME(16)" },
500 /* 93 M ERASE(16) */
501 { 0x93, T, "ERASE(16)" },
502 /* 94 O ZBC OUT */
503 { 0x94, ALL, "ZBC OUT" },
504 /* 95 O ZBC IN */
505 { 0x95, ALL, "ZBC IN" },
506 /* 96 */
507 /* 97 */
508 /* 98 */
509 /* 99 */
510 /* 9A O WRITE STREAM(16) */
511 { 0x9A, D, "WRITE STREAM(16)" },
512 /* 9B OOOOOOOOOO OOO READ BUFFER(16) */
513 { 0x9B, ALL & ~(B) , "READ BUFFER(16)" },
514 /* 9C O WRITE ATOMIC(16) */
515 { 0x9C, D, "WRITE ATOMIC(16)" },
516 /* 9D SERVICE ACTION BIDIRECTIONAL */
517 { 0x9D, ALL, "SERVICE ACTION BIDIRECTIONAL" },
518 /* XXX KDM ALL for this? op-num.txt defines it for none.. */
519 /* 9E SERVICE ACTION IN(16) */
520 { 0x9E, ALL, "SERVICE ACTION IN(16)" },
521 /* 9F M SERVICE ACTION OUT(16) */
522 { 0x9F, ALL, "SERVICE ACTION OUT(16)" },
523 /* A0 MMOOO OMMM OMO REPORT LUNS */
524 { 0xA0, ALL & ~(R | B), "REPORT LUNS" },
525 /* A1 O BLANK */
526 { 0xA1, R, "BLANK" },
527 /* A1 O O ATA COMMAND PASS THROUGH(12) */
528 { 0xA1, D | B, "ATA COMMAND PASS THROUGH(12)" },
529 /* A2 OO O O SECURITY PROTOCOL IN */
530 { 0xA2, D | T | R | V, "SECURITY PROTOCOL IN" },
531 /* A3 OOO O OOMOOOM MAINTENANCE (IN) */
532 { 0xA3, ALL & ~(P | R | F), "MAINTENANCE (IN)" },
533 /* A3 O SEND KEY */
534 { 0xA3, R, "SEND KEY" },
535 /* A4 OOO O OOOOOOO MAINTENANCE (OUT) */
536 { 0xA4, ALL & ~(P | R | F), "MAINTENANCE (OUT)" },
537 /* A4 O REPORT KEY */
538 { 0xA4, R, "REPORT KEY" },
539 /* A5 O O OM MOVE MEDIUM */
540 { 0xA5, T | W | O | M, "MOVE MEDIUM" },
541 /* A5 O PLAY AUDIO(12) */
542 { 0xA5, R, "PLAY AUDIO(12)" },
543 /* A6 O EXCHANGE MEDIUM */
544 { 0xA6, M, "EXCHANGE MEDIUM" },
545 /* A6 O LOAD/UNLOAD C/DVD */
546 { 0xA6, R, "LOAD/UNLOAD C/DVD" },
547 /* A7 ZZ O O MOVE MEDIUM ATTACHED */
548 { 0xA7, D | T | W | O, "MOVE MEDIUM ATTACHED" },
549 /* A7 O SET READ AHEAD */
550 { 0xA7, R, "SET READ AHEAD" },
551 /* A8 O OOO READ(12) */
552 { 0xA8, D | W | R | O, "READ(12)" },
553 /* A8 GET MESSAGE(12) */
554 { 0xA8, C, "GET MESSAGE(12)" },
555 /* A9 O SERVICE ACTION OUT(12) */
556 { 0xA9, V, "SERVICE ACTION OUT(12)" },
557 /* AA O OOO WRITE(12) */
558 { 0xAA, D | W | R | O, "WRITE(12)" },
559 /* AA SEND MESSAGE(12) */
560 { 0xAA, C, "SEND MESSAGE(12)" },
561 /* AB O O SERVICE ACTION IN(12) */
562 { 0xAB, R | V, "SERVICE ACTION IN(12)" },
563 /* AC O ERASE(12) */
564 { 0xAC, O, "ERASE(12)" },
565 /* AC O GET PERFORMANCE */
566 { 0xAC, R, "GET PERFORMANCE" },
567 /* AD O READ DVD STRUCTURE */
568 { 0xAD, R, "READ DVD STRUCTURE" },
569 /* AE O O O WRITE AND VERIFY(12) */
570 { 0xAE, D | W | O, "WRITE AND VERIFY(12)" },
571 /* AF O OZO VERIFY(12) */
572 { 0xAF, D | W | R | O, "VERIFY(12)" },
573 /* B0 ZZZ SEARCH DATA HIGH(12) */
574 { 0xB0, W | R | O, "SEARCH DATA HIGH(12)" },
575 /* B1 ZZZ SEARCH DATA EQUAL(12) */
576 { 0xB1, W | R | O, "SEARCH DATA EQUAL(12)" },
577 /* B2 ZZZ SEARCH DATA LOW(12) */
578 { 0xB2, W | R | O, "SEARCH DATA LOW(12)" },
579 /* B3 Z OZO SET LIMITS(12) */
580 { 0xB3, D | W | R | O, "SET LIMITS(12)" },
581 /* B4 ZZ OZO READ ELEMENT STATUS ATTACHED */
582 { 0xB4, D | T | W | R | O, "READ ELEMENT STATUS ATTACHED" },
583 /* B5 OO O O SECURITY PROTOCOL OUT */
584 { 0xB5, D | T | R | V, "SECURITY PROTOCOL OUT" },
585 /* B5 O REQUEST VOLUME ELEMENT ADDRESS */
586 { 0xB5, M, "REQUEST VOLUME ELEMENT ADDRESS" },
587 /* B6 O SEND VOLUME TAG */
588 { 0xB6, M, "SEND VOLUME TAG" },
589 /* B6 O SET STREAMING */
590 { 0xB6, R, "SET STREAMING" },
591 /* B7 O O READ DEFECT DATA(12) */
592 { 0xB7, D | O, "READ DEFECT DATA(12)" },
593 /* B8 O OZOM READ ELEMENT STATUS */
594 { 0xB8, T | W | R | O | M, "READ ELEMENT STATUS" },
595 /* B9 O READ CD MSF */
596 { 0xB9, R, "READ CD MSF" },
597 /* BA O O OOMO REDUNDANCY GROUP (IN) */
598 { 0xBA, D | W | O | M | A | E, "REDUNDANCY GROUP (IN)" },
599 /* BA O SCAN */
600 { 0xBA, R, "SCAN" },
601 /* BB O O OOOO REDUNDANCY GROUP (OUT) */
602 { 0xBB, D | W | O | M | A | E, "REDUNDANCY GROUP (OUT)" },
603 /* BB O SET CD SPEED */
604 { 0xBB, R, "SET CD SPEED" },
605 /* BC O O OOMO SPARE (IN) */
606 { 0xBC, D | W | O | M | A | E, "SPARE (IN)" },
607 /* BD O O OOOO SPARE (OUT) */
608 { 0xBD, D | W | O | M | A | E, "SPARE (OUT)" },
609 /* BD O MECHANISM STATUS */
610 { 0xBD, R, "MECHANISM STATUS" },
611 /* BE O O OOMO VOLUME SET (IN) */
612 { 0xBE, D | W | O | M | A | E, "VOLUME SET (IN)" },
613 /* BE O READ CD */
614 { 0xBE, R, "READ CD" },
615 /* BF O O OOOO VOLUME SET (OUT) */
616 { 0xBF, D | W | O | M | A | E, "VOLUME SET (OUT)" },
617 /* BF O SEND DVD STRUCTURE */
618 { 0xBF, R, "SEND DVD STRUCTURE" }
619 };
620
621 const char *
scsi_op_desc(u_int16_t opcode,struct scsi_inquiry_data * inq_data)622 scsi_op_desc(u_int16_t opcode, struct scsi_inquiry_data *inq_data)
623 {
624 caddr_t match;
625 int i, j;
626 u_int32_t opmask;
627 u_int16_t pd_type;
628 int num_ops[2];
629 struct op_table_entry *table[2];
630 int num_tables;
631
632 /*
633 * If we've got inquiry data, use it to determine what type of
634 * device we're dealing with here. Otherwise, assume direct
635 * access.
636 */
637 if (inq_data == NULL) {
638 pd_type = T_DIRECT;
639 match = NULL;
640 } else {
641 pd_type = SID_TYPE(inq_data);
642
643 match = cam_quirkmatch((caddr_t)inq_data,
644 (caddr_t)scsi_op_quirk_table,
645 nitems(scsi_op_quirk_table),
646 sizeof(*scsi_op_quirk_table),
647 scsi_inquiry_match);
648 }
649
650 if (match != NULL) {
651 table[0] = ((struct scsi_op_quirk_entry *)match)->op_table;
652 num_ops[0] = ((struct scsi_op_quirk_entry *)match)->num_ops;
653 table[1] = scsi_op_codes;
654 num_ops[1] = nitems(scsi_op_codes);
655 num_tables = 2;
656 } else {
657 /*
658 * If this is true, we have a vendor specific opcode that
659 * wasn't covered in the quirk table.
660 */
661 if ((opcode > 0xBF) || ((opcode > 0x5F) && (opcode < 0x80)))
662 return("Vendor Specific Command");
663
664 table[0] = scsi_op_codes;
665 num_ops[0] = nitems(scsi_op_codes);
666 num_tables = 1;
667 }
668
669 /* RBC is 'Simplified' Direct Access Device */
670 if (pd_type == T_RBC)
671 pd_type = T_DIRECT;
672
673 /*
674 * Host managed drives are direct access for the most part.
675 */
676 if (pd_type == T_ZBC_HM)
677 pd_type = T_DIRECT;
678
679 /* Map NODEVICE to Direct Access Device to handle REPORT LUNS, etc. */
680 if (pd_type == T_NODEVICE)
681 pd_type = T_DIRECT;
682
683 opmask = 1 << pd_type;
684
685 for (j = 0; j < num_tables; j++) {
686 for (i = 0;i < num_ops[j] && table[j][i].opcode <= opcode; i++){
687 if ((table[j][i].opcode == opcode)
688 && ((table[j][i].opmask & opmask) != 0))
689 return(table[j][i].desc);
690 }
691 }
692
693 /*
694 * If we can't find a match for the command in the table, we just
695 * assume it's a vendor specifc command.
696 */
697 return("Vendor Specific Command");
698
699 }
700
701 #else /* SCSI_NO_OP_STRINGS */
702
703 const char *
scsi_op_desc(u_int16_t opcode,struct scsi_inquiry_data * inq_data)704 scsi_op_desc(u_int16_t opcode, struct scsi_inquiry_data *inq_data)
705 {
706 return("");
707 }
708
709 #endif
710
711
712 #if !defined(SCSI_NO_SENSE_STRINGS)
713 #define SST(asc, ascq, action, desc) \
714 asc, ascq, action, desc
715 #else
716 const char empty_string[] = "";
717
718 #define SST(asc, ascq, action, desc) \
719 asc, ascq, action, empty_string
720 #endif
721
722 const struct sense_key_table_entry sense_key_table[] =
723 {
724 { SSD_KEY_NO_SENSE, SS_NOP, "NO SENSE" },
725 { SSD_KEY_RECOVERED_ERROR, SS_NOP|SSQ_PRINT_SENSE, "RECOVERED ERROR" },
726 { SSD_KEY_NOT_READY, SS_RDEF, "NOT READY" },
727 { SSD_KEY_MEDIUM_ERROR, SS_RDEF, "MEDIUM ERROR" },
728 { SSD_KEY_HARDWARE_ERROR, SS_RDEF, "HARDWARE FAILURE" },
729 { SSD_KEY_ILLEGAL_REQUEST, SS_FATAL|EINVAL, "ILLEGAL REQUEST" },
730 { SSD_KEY_UNIT_ATTENTION, SS_FATAL|ENXIO, "UNIT ATTENTION" },
731 { SSD_KEY_DATA_PROTECT, SS_FATAL|EACCES, "DATA PROTECT" },
732 { SSD_KEY_BLANK_CHECK, SS_FATAL|ENOSPC, "BLANK CHECK" },
733 { SSD_KEY_Vendor_Specific, SS_FATAL|EIO, "Vendor Specific" },
734 { SSD_KEY_COPY_ABORTED, SS_FATAL|EIO, "COPY ABORTED" },
735 { SSD_KEY_ABORTED_COMMAND, SS_RDEF, "ABORTED COMMAND" },
736 { SSD_KEY_EQUAL, SS_NOP, "EQUAL" },
737 { SSD_KEY_VOLUME_OVERFLOW, SS_FATAL|EIO, "VOLUME OVERFLOW" },
738 { SSD_KEY_MISCOMPARE, SS_NOP, "MISCOMPARE" },
739 { SSD_KEY_COMPLETED, SS_NOP, "COMPLETED" }
740 };
741
742 static struct asc_table_entry quantum_fireball_entries[] = {
743 { SST(0x04, 0x0b, SS_START | SSQ_DECREMENT_COUNT | ENXIO,
744 "Logical unit not ready, initializing cmd. required") }
745 };
746
747 static struct asc_table_entry sony_mo_entries[] = {
748 { SST(0x04, 0x00, SS_START | SSQ_DECREMENT_COUNT | ENXIO,
749 "Logical unit not ready, cause not reportable") }
750 };
751
752 static struct asc_table_entry hgst_entries[] = {
753 { SST(0x04, 0xF0, SS_RDEF,
754 "Vendor Unique - Logical Unit Not Ready") },
755 { SST(0x0A, 0x01, SS_RDEF,
756 "Unrecovered Super Certification Log Write Error") },
757 { SST(0x0A, 0x02, SS_RDEF,
758 "Unrecovered Super Certification Log Read Error") },
759 { SST(0x15, 0x03, SS_RDEF,
760 "Unrecovered Sector Error") },
761 { SST(0x3E, 0x04, SS_RDEF,
762 "Unrecovered Self-Test Hard-Cache Test Fail") },
763 { SST(0x3E, 0x05, SS_RDEF,
764 "Unrecovered Self-Test OTF-Cache Fail") },
765 { SST(0x40, 0x00, SS_RDEF,
766 "Unrecovered SAT No Buffer Overflow Error") },
767 { SST(0x40, 0x01, SS_RDEF,
768 "Unrecovered SAT Buffer Overflow Error") },
769 { SST(0x40, 0x02, SS_RDEF,
770 "Unrecovered SAT No Buffer Overflow With ECS Fault") },
771 { SST(0x40, 0x03, SS_RDEF,
772 "Unrecovered SAT Buffer Overflow With ECS Fault") },
773 { SST(0x40, 0x81, SS_RDEF,
774 "DRAM Failure") },
775 { SST(0x44, 0x0B, SS_RDEF,
776 "Vendor Unique - Internal Target Failure") },
777 { SST(0x44, 0xF2, SS_RDEF,
778 "Vendor Unique - Internal Target Failure") },
779 { SST(0x44, 0xF6, SS_RDEF,
780 "Vendor Unique - Internal Target Failure") },
781 { SST(0x44, 0xF9, SS_RDEF,
782 "Vendor Unique - Internal Target Failure") },
783 { SST(0x44, 0xFA, SS_RDEF,
784 "Vendor Unique - Internal Target Failure") },
785 { SST(0x5D, 0x22, SS_RDEF,
786 "Extreme Over-Temperature Warning") },
787 { SST(0x5D, 0x50, SS_RDEF,
788 "Load/Unload cycle Count Warning") },
789 { SST(0x81, 0x00, SS_RDEF,
790 "Vendor Unique - Internal Logic Error") },
791 { SST(0x85, 0x00, SS_RDEF,
792 "Vendor Unique - Internal Key Seed Error") },
793 };
794
795 static struct asc_table_entry seagate_entries[] = {
796 { SST(0x04, 0xF0, SS_RDEF,
797 "Logical Unit Not Ready, super certify in Progress") },
798 { SST(0x08, 0x86, SS_RDEF,
799 "Write Fault Data Corruption") },
800 { SST(0x09, 0x0D, SS_RDEF,
801 "Tracking Failure") },
802 { SST(0x09, 0x0E, SS_RDEF,
803 "ETF Failure") },
804 { SST(0x0B, 0x5D, SS_RDEF,
805 "Pre-SMART Warning") },
806 { SST(0x0B, 0x85, SS_RDEF,
807 "5V Voltage Warning") },
808 { SST(0x0B, 0x8C, SS_RDEF,
809 "12V Voltage Warning") },
810 { SST(0x0C, 0xFF, SS_RDEF,
811 "Write Error - Too many error recovery revs") },
812 { SST(0x11, 0xFF, SS_RDEF,
813 "Unrecovered Read Error - Too many error recovery revs") },
814 { SST(0x19, 0x0E, SS_RDEF,
815 "Fewer than 1/2 defect list copies") },
816 { SST(0x20, 0xF3, SS_RDEF,
817 "Illegal CDB linked to skip mask cmd") },
818 { SST(0x24, 0xF0, SS_RDEF,
819 "Illegal byte in CDB, LBA not matching") },
820 { SST(0x24, 0xF1, SS_RDEF,
821 "Illegal byte in CDB, LEN not matching") },
822 { SST(0x24, 0xF2, SS_RDEF,
823 "Mask not matching transfer length") },
824 { SST(0x24, 0xF3, SS_RDEF,
825 "Drive formatted without plist") },
826 { SST(0x26, 0x95, SS_RDEF,
827 "Invalid Field Parameter - CAP File") },
828 { SST(0x26, 0x96, SS_RDEF,
829 "Invalid Field Parameter - RAP File") },
830 { SST(0x26, 0x97, SS_RDEF,
831 "Invalid Field Parameter - TMS Firmware Tag") },
832 { SST(0x26, 0x98, SS_RDEF,
833 "Invalid Field Parameter - Check Sum") },
834 { SST(0x26, 0x99, SS_RDEF,
835 "Invalid Field Parameter - Firmware Tag") },
836 { SST(0x29, 0x08, SS_RDEF,
837 "Write Log Dump data") },
838 { SST(0x29, 0x09, SS_RDEF,
839 "Write Log Dump data") },
840 { SST(0x29, 0x0A, SS_RDEF,
841 "Reserved disk space") },
842 { SST(0x29, 0x0B, SS_RDEF,
843 "SDBP") },
844 { SST(0x29, 0x0C, SS_RDEF,
845 "SDBP") },
846 { SST(0x31, 0x91, SS_RDEF,
847 "Format Corrupted World Wide Name (WWN) is Invalid") },
848 { SST(0x32, 0x03, SS_RDEF,
849 "Defect List - Length exceeds Command Allocated Length") },
850 { SST(0x33, 0x00, SS_RDEF,
851 "Flash not ready for access") },
852 { SST(0x3F, 0x70, SS_RDEF,
853 "Invalid RAP block") },
854 { SST(0x3F, 0x71, SS_RDEF,
855 "RAP/ETF mismatch") },
856 { SST(0x3F, 0x90, SS_RDEF,
857 "Invalid CAP block") },
858 { SST(0x3F, 0x91, SS_RDEF,
859 "World Wide Name (WWN) Mismatch") },
860 { SST(0x40, 0x01, SS_RDEF,
861 "DRAM Parity Error") },
862 { SST(0x40, 0x02, SS_RDEF,
863 "DRAM Parity Error") },
864 { SST(0x42, 0x0A, SS_RDEF,
865 "Loopback Test") },
866 { SST(0x42, 0x0B, SS_RDEF,
867 "Loopback Test") },
868 { SST(0x44, 0xF2, SS_RDEF,
869 "Compare error during data integrity check") },
870 { SST(0x44, 0xF6, SS_RDEF,
871 "Unrecoverable error during data integrity check") },
872 { SST(0x47, 0x80, SS_RDEF,
873 "Fibre Channel Sequence Error") },
874 { SST(0x4E, 0x01, SS_RDEF,
875 "Information Unit Too Short") },
876 { SST(0x80, 0x00, SS_RDEF,
877 "General Firmware Error / Command Timeout") },
878 { SST(0x80, 0x01, SS_RDEF,
879 "Command Timeout") },
880 { SST(0x80, 0x02, SS_RDEF,
881 "Command Timeout") },
882 { SST(0x80, 0x80, SS_RDEF,
883 "FC FIFO Error During Read Transfer") },
884 { SST(0x80, 0x81, SS_RDEF,
885 "FC FIFO Error During Write Transfer") },
886 { SST(0x80, 0x82, SS_RDEF,
887 "DISC FIFO Error During Read Transfer") },
888 { SST(0x80, 0x83, SS_RDEF,
889 "DISC FIFO Error During Write Transfer") },
890 { SST(0x80, 0x84, SS_RDEF,
891 "LBA Seeded LRC Error on Read") },
892 { SST(0x80, 0x85, SS_RDEF,
893 "LBA Seeded LRC Error on Write") },
894 { SST(0x80, 0x86, SS_RDEF,
895 "IOEDC Error on Read") },
896 { SST(0x80, 0x87, SS_RDEF,
897 "IOEDC Error on Write") },
898 { SST(0x80, 0x88, SS_RDEF,
899 "Host Parity Check Failed") },
900 { SST(0x80, 0x89, SS_RDEF,
901 "IOEDC error on read detected by formatter") },
902 { SST(0x80, 0x8A, SS_RDEF,
903 "Host Parity Errors / Host FIFO Initialization Failed") },
904 { SST(0x80, 0x8B, SS_RDEF,
905 "Host Parity Errors") },
906 { SST(0x80, 0x8C, SS_RDEF,
907 "Host Parity Errors") },
908 { SST(0x80, 0x8D, SS_RDEF,
909 "Host Parity Errors") },
910 { SST(0x81, 0x00, SS_RDEF,
911 "LA Check Failed") },
912 { SST(0x82, 0x00, SS_RDEF,
913 "Internal client detected insufficient buffer") },
914 { SST(0x84, 0x00, SS_RDEF,
915 "Scheduled Diagnostic And Repair") },
916 };
917
918 static struct scsi_sense_quirk_entry sense_quirk_table[] = {
919 {
920 /*
921 * XXX The Quantum Fireball ST and SE like to return 0x04 0x0b
922 * when they really should return 0x04 0x02.
923 */
924 {T_DIRECT, SIP_MEDIA_FIXED, "QUANTUM", "FIREBALL S*", "*"},
925 /*num_sense_keys*/0,
926 nitems(quantum_fireball_entries),
927 /*sense key entries*/NULL,
928 quantum_fireball_entries
929 },
930 {
931 /*
932 * This Sony MO drive likes to return 0x04, 0x00 when it
933 * isn't spun up.
934 */
935 {T_DIRECT, SIP_MEDIA_REMOVABLE, "SONY", "SMO-*", "*"},
936 /*num_sense_keys*/0,
937 nitems(sony_mo_entries),
938 /*sense key entries*/NULL,
939 sony_mo_entries
940 },
941 {
942 /*
943 * HGST vendor-specific error codes
944 */
945 {T_DIRECT, SIP_MEDIA_FIXED, "HGST", "*", "*"},
946 /*num_sense_keys*/0,
947 nitems(hgst_entries),
948 /*sense key entries*/NULL,
949 hgst_entries
950 },
951 {
952 /*
953 * SEAGATE vendor-specific error codes
954 */
955 {T_DIRECT, SIP_MEDIA_FIXED, "SEAGATE", "*", "*"},
956 /*num_sense_keys*/0,
957 nitems(seagate_entries),
958 /*sense key entries*/NULL,
959 seagate_entries
960 }
961 };
962
963 const u_int sense_quirk_table_size = nitems(sense_quirk_table);
964
965 static struct asc_table_entry asc_table[] = {
966 /*
967 * From: http://www.t10.org/lists/asc-num.txt
968 * Modifications by Jung-uk Kim (jkim@FreeBSD.org)
969 */
970 /*
971 * File: ASC-NUM.TXT
972 *
973 * SCSI ASC/ASCQ Assignments
974 * Numeric Sorted Listing
975 * as of 8/12/15
976 *
977 * D - DIRECT ACCESS DEVICE (SBC-2) device column key
978 * .T - SEQUENTIAL ACCESS DEVICE (SSC) -------------------
979 * . L - PRINTER DEVICE (SSC) blank = reserved
980 * . P - PROCESSOR DEVICE (SPC) not blank = allowed
981 * . .W - WRITE ONCE READ MULTIPLE DEVICE (SBC-2)
982 * . . R - CD DEVICE (MMC)
983 * . . O - OPTICAL MEMORY DEVICE (SBC-2)
984 * . . .M - MEDIA CHANGER DEVICE (SMC)
985 * . . . A - STORAGE ARRAY DEVICE (SCC)
986 * . . . E - ENCLOSURE SERVICES DEVICE (SES)
987 * . . . .B - SIMPLIFIED DIRECT-ACCESS DEVICE (RBC)
988 * . . . . K - OPTICAL CARD READER/WRITER DEVICE (OCRW)
989 * . . . . V - AUTOMATION/DRIVE INTERFACE (ADC)
990 * . . . . .F - OBJECT-BASED STORAGE (OSD)
991 * DTLPWROMAEBKVF
992 * ASC ASCQ Action
993 * Description
994 */
995 /* DTLPWROMAEBKVF */
996 { SST(0x00, 0x00, SS_NOP,
997 "No additional sense information") },
998 /* T */
999 { SST(0x00, 0x01, SS_RDEF,
1000 "Filemark detected") },
1001 /* T */
1002 { SST(0x00, 0x02, SS_RDEF,
1003 "End-of-partition/medium detected") },
1004 /* T */
1005 { SST(0x00, 0x03, SS_RDEF,
1006 "Setmark detected") },
1007 /* T */
1008 { SST(0x00, 0x04, SS_RDEF,
1009 "Beginning-of-partition/medium detected") },
1010 /* TL */
1011 { SST(0x00, 0x05, SS_RDEF,
1012 "End-of-data detected") },
1013 /* DTLPWROMAEBKVF */
1014 { SST(0x00, 0x06, SS_RDEF,
1015 "I/O process terminated") },
1016 /* T */
1017 { SST(0x00, 0x07, SS_RDEF, /* XXX TBD */
1018 "Programmable early warning detected") },
1019 /* R */
1020 { SST(0x00, 0x11, SS_FATAL | EBUSY,
1021 "Audio play operation in progress") },
1022 /* R */
1023 { SST(0x00, 0x12, SS_NOP,
1024 "Audio play operation paused") },
1025 /* R */
1026 { SST(0x00, 0x13, SS_NOP,
1027 "Audio play operation successfully completed") },
1028 /* R */
1029 { SST(0x00, 0x14, SS_RDEF,
1030 "Audio play operation stopped due to error") },
1031 /* R */
1032 { SST(0x00, 0x15, SS_NOP,
1033 "No current audio status to return") },
1034 /* DTLPWROMAEBKVF */
1035 { SST(0x00, 0x16, SS_FATAL | EBUSY,
1036 "Operation in progress") },
1037 /* DTL WROMAEBKVF */
1038 { SST(0x00, 0x17, SS_RDEF,
1039 "Cleaning requested") },
1040 /* T */
1041 { SST(0x00, 0x18, SS_RDEF, /* XXX TBD */
1042 "Erase operation in progress") },
1043 /* T */
1044 { SST(0x00, 0x19, SS_RDEF, /* XXX TBD */
1045 "Locate operation in progress") },
1046 /* T */
1047 { SST(0x00, 0x1A, SS_RDEF, /* XXX TBD */
1048 "Rewind operation in progress") },
1049 /* T */
1050 { SST(0x00, 0x1B, SS_RDEF, /* XXX TBD */
1051 "Set capacity operation in progress") },
1052 /* T */
1053 { SST(0x00, 0x1C, SS_RDEF, /* XXX TBD */
1054 "Verify operation in progress") },
1055 /* DT B */
1056 { SST(0x00, 0x1D, SS_NOP,
1057 "ATA pass through information available") },
1058 /* DT R MAEBKV */
1059 { SST(0x00, 0x1E, SS_RDEF, /* XXX TBD */
1060 "Conflicting SA creation request") },
1061 /* DT B */
1062 { SST(0x00, 0x1F, SS_RDEF, /* XXX TBD */
1063 "Logical unit transitioning to another power condition") },
1064 /* DT P B */
1065 { SST(0x00, 0x20, SS_NOP,
1066 "Extended copy information available") },
1067 /* D */
1068 { SST(0x00, 0x21, SS_RDEF, /* XXX TBD */
1069 "Atomic command aborted due to ACA") },
1070 /* D W O BK */
1071 { SST(0x01, 0x00, SS_RDEF,
1072 "No index/sector signal") },
1073 /* D WRO BK */
1074 { SST(0x02, 0x00, SS_RDEF,
1075 "No seek complete") },
1076 /* DTL W O BK */
1077 { SST(0x03, 0x00, SS_RDEF,
1078 "Peripheral device write fault") },
1079 /* T */
1080 { SST(0x03, 0x01, SS_RDEF,
1081 "No write current") },
1082 /* T */
1083 { SST(0x03, 0x02, SS_RDEF,
1084 "Excessive write errors") },
1085 /* DTLPWROMAEBKVF */
1086 { SST(0x04, 0x00, SS_RDEF,
1087 "Logical unit not ready, cause not reportable") },
1088 /* DTLPWROMAEBKVF */
1089 { SST(0x04, 0x01, SS_WAIT | EBUSY,
1090 "Logical unit is in process of becoming ready") },
1091 /* DTLPWROMAEBKVF */
1092 { SST(0x04, 0x02, SS_START | SSQ_DECREMENT_COUNT | ENXIO,
1093 "Logical unit not ready, initializing command required") },
1094 /* DTLPWROMAEBKVF */
1095 { SST(0x04, 0x03, SS_FATAL | ENXIO,
1096 "Logical unit not ready, manual intervention required") },
1097 /* DTL RO B */
1098 { SST(0x04, 0x04, SS_FATAL | EBUSY,
1099 "Logical unit not ready, format in progress") },
1100 /* DT W O A BK F */
1101 { SST(0x04, 0x05, SS_FATAL | EBUSY,
1102 "Logical unit not ready, rebuild in progress") },
1103 /* DT W O A BK */
1104 { SST(0x04, 0x06, SS_FATAL | EBUSY,
1105 "Logical unit not ready, recalculation in progress") },
1106 /* DTLPWROMAEBKVF */
1107 { SST(0x04, 0x07, SS_FATAL | EBUSY,
1108 "Logical unit not ready, operation in progress") },
1109 /* R */
1110 { SST(0x04, 0x08, SS_FATAL | EBUSY,
1111 "Logical unit not ready, long write in progress") },
1112 /* DTLPWROMAEBKVF */
1113 { SST(0x04, 0x09, SS_FATAL | EBUSY,
1114 "Logical unit not ready, self-test in progress") },
1115 /* DTLPWROMAEBKVF */
1116 { SST(0x04, 0x0A, SS_WAIT | ENXIO,
1117 "Logical unit not accessible, asymmetric access state transition")},
1118 /* DTLPWROMAEBKVF */
1119 { SST(0x04, 0x0B, SS_FATAL | ENXIO,
1120 "Logical unit not accessible, target port in standby state") },
1121 /* DTLPWROMAEBKVF */
1122 { SST(0x04, 0x0C, SS_FATAL | ENXIO,
1123 "Logical unit not accessible, target port in unavailable state") },
1124 /* F */
1125 { SST(0x04, 0x0D, SS_RDEF, /* XXX TBD */
1126 "Logical unit not ready, structure check required") },
1127 /* DTL WR MAEBKVF */
1128 { SST(0x04, 0x0E, SS_RDEF, /* XXX TBD */
1129 "Logical unit not ready, security session in progress") },
1130 /* DT WROM B */
1131 { SST(0x04, 0x10, SS_FATAL | ENODEV,
1132 "Logical unit not ready, auxiliary memory not accessible") },
1133 /* DT WRO AEB VF */
1134 { SST(0x04, 0x11, SS_WAIT | ENXIO,
1135 "Logical unit not ready, notify (enable spinup) required") },
1136 /* M V */
1137 { SST(0x04, 0x12, SS_FATAL | ENXIO,
1138 "Logical unit not ready, offline") },
1139 /* DT R MAEBKV */
1140 { SST(0x04, 0x13, SS_WAIT | EBUSY,
1141 "Logical unit not ready, SA creation in progress") },
1142 /* D B */
1143 { SST(0x04, 0x14, SS_WAIT | ENOSPC,
1144 "Logical unit not ready, space allocation in progress") },
1145 /* M */
1146 { SST(0x04, 0x15, SS_FATAL | ENXIO,
1147 "Logical unit not ready, robotics disabled") },
1148 /* M */
1149 { SST(0x04, 0x16, SS_FATAL | ENXIO,
1150 "Logical unit not ready, configuration required") },
1151 /* M */
1152 { SST(0x04, 0x17, SS_FATAL | ENXIO,
1153 "Logical unit not ready, calibration required") },
1154 /* M */
1155 { SST(0x04, 0x18, SS_FATAL | ENXIO,
1156 "Logical unit not ready, a door is open") },
1157 /* M */
1158 { SST(0x04, 0x19, SS_FATAL | ENODEV,
1159 "Logical unit not ready, operating in sequential mode") },
1160 /* DT B */
1161 { SST(0x04, 0x1A, SS_WAIT | EBUSY,
1162 "Logical unit not ready, START/STOP UNIT command in progress") },
1163 /* D B */
1164 { SST(0x04, 0x1B, SS_WAIT | EBUSY,
1165 "Logical unit not ready, sanitize in progress") },
1166 /* DT MAEB */
1167 { SST(0x04, 0x1C, SS_RDEF, /* XXX TBD */
1168 "Logical unit not ready, additional power use not yet granted") },
1169 /* D */
1170 { SST(0x04, 0x1D, SS_WAIT | EBUSY,
1171 "Logical unit not ready, configuration in progress") },
1172 /* D */
1173 { SST(0x04, 0x1E, SS_FATAL | ENXIO,
1174 "Logical unit not ready, microcode activation required") },
1175 /* DTLPWROMAEBKVF */
1176 { SST(0x04, 0x1F, SS_FATAL | ENXIO,
1177 "Logical unit not ready, microcode download required") },
1178 /* DTLPWROMAEBKVF */
1179 { SST(0x04, 0x20, SS_FATAL | ENXIO,
1180 "Logical unit not ready, logical unit reset required") },
1181 /* DTLPWROMAEBKVF */
1182 { SST(0x04, 0x21, SS_FATAL | ENXIO,
1183 "Logical unit not ready, hard reset required") },
1184 /* DTLPWROMAEBKVF */
1185 { SST(0x04, 0x22, SS_FATAL | ENXIO,
1186 "Logical unit not ready, power cycle required") },
1187 /* D */
1188 { SST(0x04, 0x23, SS_FATAL | ENXIO,
1189 "Logical unit not ready, affiliation required") },
1190 /* D */
1191 { SST(0x04, 0x24, SS_FATAL | EBUSY,
1192 "Depopulation in progress") },
1193 /* DTL WROMAEBKVF */
1194 { SST(0x05, 0x00, SS_RDEF,
1195 "Logical unit does not respond to selection") },
1196 /* D WROM BK */
1197 { SST(0x06, 0x00, SS_RDEF,
1198 "No reference position found") },
1199 /* DTL WROM BK */
1200 { SST(0x07, 0x00, SS_RDEF,
1201 "Multiple peripheral devices selected") },
1202 /* DTL WROMAEBKVF */
1203 { SST(0x08, 0x00, SS_RDEF,
1204 "Logical unit communication failure") },
1205 /* DTL WROMAEBKVF */
1206 { SST(0x08, 0x01, SS_RDEF,
1207 "Logical unit communication time-out") },
1208 /* DTL WROMAEBKVF */
1209 { SST(0x08, 0x02, SS_RDEF,
1210 "Logical unit communication parity error") },
1211 /* DT ROM BK */
1212 { SST(0x08, 0x03, SS_RDEF,
1213 "Logical unit communication CRC error (Ultra-DMA/32)") },
1214 /* DTLPWRO K */
1215 { SST(0x08, 0x04, SS_RDEF, /* XXX TBD */
1216 "Unreachable copy target") },
1217 /* DT WRO B */
1218 { SST(0x09, 0x00, SS_RDEF,
1219 "Track following error") },
1220 /* WRO K */
1221 { SST(0x09, 0x01, SS_RDEF,
1222 "Tracking servo failure") },
1223 /* WRO K */
1224 { SST(0x09, 0x02, SS_RDEF,
1225 "Focus servo failure") },
1226 /* WRO */
1227 { SST(0x09, 0x03, SS_RDEF,
1228 "Spindle servo failure") },
1229 /* DT WRO B */
1230 { SST(0x09, 0x04, SS_RDEF,
1231 "Head select fault") },
1232 /* DT RO B */
1233 { SST(0x09, 0x05, SS_RDEF,
1234 "Vibration induced tracking error") },
1235 /* DTLPWROMAEBKVF */
1236 { SST(0x0A, 0x00, SS_FATAL | ENOSPC,
1237 "Error log overflow") },
1238 /* DTLPWROMAEBKVF */
1239 { SST(0x0B, 0x00, SS_NOP | SSQ_PRINT_SENSE,
1240 "Warning") },
1241 /* DTLPWROMAEBKVF */
1242 { SST(0x0B, 0x01, SS_NOP | SSQ_PRINT_SENSE,
1243 "Warning - specified temperature exceeded") },
1244 /* DTLPWROMAEBKVF */
1245 { SST(0x0B, 0x02, SS_NOP | SSQ_PRINT_SENSE,
1246 "Warning - enclosure degraded") },
1247 /* DTLPWROMAEBKVF */
1248 { SST(0x0B, 0x03, SS_NOP | SSQ_PRINT_SENSE,
1249 "Warning - background self-test failed") },
1250 /* DTLPWRO AEBKVF */
1251 { SST(0x0B, 0x04, SS_NOP | SSQ_PRINT_SENSE,
1252 "Warning - background pre-scan detected medium error") },
1253 /* DTLPWRO AEBKVF */
1254 { SST(0x0B, 0x05, SS_NOP | SSQ_PRINT_SENSE,
1255 "Warning - background medium scan detected medium error") },
1256 /* DTLPWROMAEBKVF */
1257 { SST(0x0B, 0x06, SS_NOP | SSQ_PRINT_SENSE,
1258 "Warning - non-volatile cache now volatile") },
1259 /* DTLPWROMAEBKVF */
1260 { SST(0x0B, 0x07, SS_NOP | SSQ_PRINT_SENSE,
1261 "Warning - degraded power to non-volatile cache") },
1262 /* DTLPWROMAEBKVF */
1263 { SST(0x0B, 0x08, SS_NOP | SSQ_PRINT_SENSE,
1264 "Warning - power loss expected") },
1265 /* D */
1266 { SST(0x0B, 0x09, SS_NOP | SSQ_PRINT_SENSE,
1267 "Warning - device statistics notification available") },
1268 /* DTLPWROMAEBKVF */
1269 { SST(0x0B, 0x0A, SS_NOP | SSQ_PRINT_SENSE,
1270 "Warning - High critical temperature limit exceeded") },
1271 /* DTLPWROMAEBKVF */
1272 { SST(0x0B, 0x0B, SS_NOP | SSQ_PRINT_SENSE,
1273 "Warning - Low critical temperature limit exceeded") },
1274 /* DTLPWROMAEBKVF */
1275 { SST(0x0B, 0x0C, SS_NOP | SSQ_PRINT_SENSE,
1276 "Warning - High operating temperature limit exceeded") },
1277 /* DTLPWROMAEBKVF */
1278 { SST(0x0B, 0x0D, SS_NOP | SSQ_PRINT_SENSE,
1279 "Warning - Low operating temperature limit exceeded") },
1280 /* DTLPWROMAEBKVF */
1281 { SST(0x0B, 0x0E, SS_NOP | SSQ_PRINT_SENSE,
1282 "Warning - High citical humidity limit exceeded") },
1283 /* DTLPWROMAEBKVF */
1284 { SST(0x0B, 0x0F, SS_NOP | SSQ_PRINT_SENSE,
1285 "Warning - Low citical humidity limit exceeded") },
1286 /* DTLPWROMAEBKVF */
1287 { SST(0x0B, 0x10, SS_NOP | SSQ_PRINT_SENSE,
1288 "Warning - High operating humidity limit exceeded") },
1289 /* DTLPWROMAEBKVF */
1290 { SST(0x0B, 0x11, SS_NOP | SSQ_PRINT_SENSE,
1291 "Warning - Low operating humidity limit exceeded") },
1292 /* T R */
1293 { SST(0x0C, 0x00, SS_RDEF,
1294 "Write error") },
1295 /* K */
1296 { SST(0x0C, 0x01, SS_NOP | SSQ_PRINT_SENSE,
1297 "Write error - recovered with auto reallocation") },
1298 /* D W O BK */
1299 { SST(0x0C, 0x02, SS_RDEF,
1300 "Write error - auto reallocation failed") },
1301 /* D W O BK */
1302 { SST(0x0C, 0x03, SS_RDEF,
1303 "Write error - recommend reassignment") },
1304 /* DT W O B */
1305 { SST(0x0C, 0x04, SS_RDEF,
1306 "Compression check miscompare error") },
1307 /* DT W O B */
1308 { SST(0x0C, 0x05, SS_RDEF,
1309 "Data expansion occurred during compression") },
1310 /* DT W O B */
1311 { SST(0x0C, 0x06, SS_RDEF,
1312 "Block not compressible") },
1313 /* R */
1314 { SST(0x0C, 0x07, SS_RDEF,
1315 "Write error - recovery needed") },
1316 /* R */
1317 { SST(0x0C, 0x08, SS_RDEF,
1318 "Write error - recovery failed") },
1319 /* R */
1320 { SST(0x0C, 0x09, SS_RDEF,
1321 "Write error - loss of streaming") },
1322 /* R */
1323 { SST(0x0C, 0x0A, SS_RDEF,
1324 "Write error - padding blocks added") },
1325 /* DT WROM B */
1326 { SST(0x0C, 0x0B, SS_RDEF, /* XXX TBD */
1327 "Auxiliary memory write error") },
1328 /* DTLPWRO AEBKVF */
1329 { SST(0x0C, 0x0C, SS_RDEF, /* XXX TBD */
1330 "Write error - unexpected unsolicited data") },
1331 /* DTLPWRO AEBKVF */
1332 { SST(0x0C, 0x0D, SS_RDEF, /* XXX TBD */
1333 "Write error - not enough unsolicited data") },
1334 /* DT W O BK */
1335 { SST(0x0C, 0x0E, SS_RDEF, /* XXX TBD */
1336 "Multiple write errors") },
1337 /* R */
1338 { SST(0x0C, 0x0F, SS_RDEF, /* XXX TBD */
1339 "Defects in error window") },
1340 /* D */
1341 { SST(0x0C, 0x10, SS_RDEF, /* XXX TBD */
1342 "Incomplete multiple atomic write operations") },
1343 /* D */
1344 { SST(0x0C, 0x11, SS_RDEF, /* XXX TBD */
1345 "Write error - recovery scan needed") },
1346 /* D */
1347 { SST(0x0C, 0x12, SS_RDEF, /* XXX TBD */
1348 "Write error - insufficient zone resources") },
1349 /* DTLPWRO A K */
1350 { SST(0x0D, 0x00, SS_RDEF, /* XXX TBD */
1351 "Error detected by third party temporary initiator") },
1352 /* DTLPWRO A K */
1353 { SST(0x0D, 0x01, SS_RDEF, /* XXX TBD */
1354 "Third party device failure") },
1355 /* DTLPWRO A K */
1356 { SST(0x0D, 0x02, SS_RDEF, /* XXX TBD */
1357 "Copy target device not reachable") },
1358 /* DTLPWRO A K */
1359 { SST(0x0D, 0x03, SS_RDEF, /* XXX TBD */
1360 "Incorrect copy target device type") },
1361 /* DTLPWRO A K */
1362 { SST(0x0D, 0x04, SS_RDEF, /* XXX TBD */
1363 "Copy target device data underrun") },
1364 /* DTLPWRO A K */
1365 { SST(0x0D, 0x05, SS_RDEF, /* XXX TBD */
1366 "Copy target device data overrun") },
1367 /* DT PWROMAEBK F */
1368 { SST(0x0E, 0x00, SS_RDEF, /* XXX TBD */
1369 "Invalid information unit") },
1370 /* DT PWROMAEBK F */
1371 { SST(0x0E, 0x01, SS_RDEF, /* XXX TBD */
1372 "Information unit too short") },
1373 /* DT PWROMAEBK F */
1374 { SST(0x0E, 0x02, SS_RDEF, /* XXX TBD */
1375 "Information unit too long") },
1376 /* DT P R MAEBK F */
1377 { SST(0x0E, 0x03, SS_FATAL | EINVAL,
1378 "Invalid field in command information unit") },
1379 /* D W O BK */
1380 { SST(0x10, 0x00, SS_RDEF,
1381 "ID CRC or ECC error") },
1382 /* DT W O */
1383 { SST(0x10, 0x01, SS_RDEF, /* XXX TBD */
1384 "Logical block guard check failed") },
1385 /* DT W O */
1386 { SST(0x10, 0x02, SS_RDEF, /* XXX TBD */
1387 "Logical block application tag check failed") },
1388 /* DT W O */
1389 { SST(0x10, 0x03, SS_RDEF, /* XXX TBD */
1390 "Logical block reference tag check failed") },
1391 /* T */
1392 { SST(0x10, 0x04, SS_RDEF, /* XXX TBD */
1393 "Logical block protection error on recovered buffer data") },
1394 /* T */
1395 { SST(0x10, 0x05, SS_RDEF, /* XXX TBD */
1396 "Logical block protection method error") },
1397 /* DT WRO BK */
1398 { SST(0x11, 0x00, SS_FATAL|EIO,
1399 "Unrecovered read error") },
1400 /* DT WRO BK */
1401 { SST(0x11, 0x01, SS_FATAL|EIO,
1402 "Read retries exhausted") },
1403 /* DT WRO BK */
1404 { SST(0x11, 0x02, SS_FATAL|EIO,
1405 "Error too long to correct") },
1406 /* DT W O BK */
1407 { SST(0x11, 0x03, SS_FATAL|EIO,
1408 "Multiple read errors") },
1409 /* D W O BK */
1410 { SST(0x11, 0x04, SS_FATAL|EIO,
1411 "Unrecovered read error - auto reallocate failed") },
1412 /* WRO B */
1413 { SST(0x11, 0x05, SS_FATAL|EIO,
1414 "L-EC uncorrectable error") },
1415 /* WRO B */
1416 { SST(0x11, 0x06, SS_FATAL|EIO,
1417 "CIRC unrecovered error") },
1418 /* W O B */
1419 { SST(0x11, 0x07, SS_RDEF,
1420 "Data re-synchronization error") },
1421 /* T */
1422 { SST(0x11, 0x08, SS_RDEF,
1423 "Incomplete block read") },
1424 /* T */
1425 { SST(0x11, 0x09, SS_RDEF,
1426 "No gap found") },
1427 /* DT O BK */
1428 { SST(0x11, 0x0A, SS_RDEF,
1429 "Miscorrected error") },
1430 /* D W O BK */
1431 { SST(0x11, 0x0B, SS_FATAL|EIO,
1432 "Unrecovered read error - recommend reassignment") },
1433 /* D W O BK */
1434 { SST(0x11, 0x0C, SS_FATAL|EIO,
1435 "Unrecovered read error - recommend rewrite the data") },
1436 /* DT WRO B */
1437 { SST(0x11, 0x0D, SS_RDEF,
1438 "De-compression CRC error") },
1439 /* DT WRO B */
1440 { SST(0x11, 0x0E, SS_RDEF,
1441 "Cannot decompress using declared algorithm") },
1442 /* R */
1443 { SST(0x11, 0x0F, SS_RDEF,
1444 "Error reading UPC/EAN number") },
1445 /* R */
1446 { SST(0x11, 0x10, SS_RDEF,
1447 "Error reading ISRC number") },
1448 /* R */
1449 { SST(0x11, 0x11, SS_RDEF,
1450 "Read error - loss of streaming") },
1451 /* DT WROM B */
1452 { SST(0x11, 0x12, SS_RDEF, /* XXX TBD */
1453 "Auxiliary memory read error") },
1454 /* DTLPWRO AEBKVF */
1455 { SST(0x11, 0x13, SS_RDEF, /* XXX TBD */
1456 "Read error - failed retransmission request") },
1457 /* D */
1458 { SST(0x11, 0x14, SS_RDEF, /* XXX TBD */
1459 "Read error - LBA marked bad by application client") },
1460 /* D */
1461 { SST(0x11, 0x15, SS_FATAL | EIO,
1462 "Write after sanitize required") },
1463 /* D W O BK */
1464 { SST(0x12, 0x00, SS_RDEF,
1465 "Address mark not found for ID field") },
1466 /* D W O BK */
1467 { SST(0x13, 0x00, SS_RDEF,
1468 "Address mark not found for data field") },
1469 /* DTL WRO BK */
1470 { SST(0x14, 0x00, SS_RDEF,
1471 "Recorded entity not found") },
1472 /* DT WRO BK */
1473 { SST(0x14, 0x01, SS_RDEF,
1474 "Record not found") },
1475 /* T */
1476 { SST(0x14, 0x02, SS_RDEF,
1477 "Filemark or setmark not found") },
1478 /* T */
1479 { SST(0x14, 0x03, SS_RDEF,
1480 "End-of-data not found") },
1481 /* T */
1482 { SST(0x14, 0x04, SS_RDEF,
1483 "Block sequence error") },
1484 /* DT W O BK */
1485 { SST(0x14, 0x05, SS_RDEF,
1486 "Record not found - recommend reassignment") },
1487 /* DT W O BK */
1488 { SST(0x14, 0x06, SS_RDEF,
1489 "Record not found - data auto-reallocated") },
1490 /* T */
1491 { SST(0x14, 0x07, SS_RDEF, /* XXX TBD */
1492 "Locate operation failure") },
1493 /* DTL WROM BK */
1494 { SST(0x15, 0x00, SS_RDEF,
1495 "Random positioning error") },
1496 /* DTL WROM BK */
1497 { SST(0x15, 0x01, SS_RDEF,
1498 "Mechanical positioning error") },
1499 /* DT WRO BK */
1500 { SST(0x15, 0x02, SS_RDEF,
1501 "Positioning error detected by read of medium") },
1502 /* D W O BK */
1503 { SST(0x16, 0x00, SS_RDEF,
1504 "Data synchronization mark error") },
1505 /* D W O BK */
1506 { SST(0x16, 0x01, SS_RDEF,
1507 "Data sync error - data rewritten") },
1508 /* D W O BK */
1509 { SST(0x16, 0x02, SS_RDEF,
1510 "Data sync error - recommend rewrite") },
1511 /* D W O BK */
1512 { SST(0x16, 0x03, SS_NOP | SSQ_PRINT_SENSE,
1513 "Data sync error - data auto-reallocated") },
1514 /* D W O BK */
1515 { SST(0x16, 0x04, SS_RDEF,
1516 "Data sync error - recommend reassignment") },
1517 /* DT WRO BK */
1518 { SST(0x17, 0x00, SS_NOP | SSQ_PRINT_SENSE,
1519 "Recovered data with no error correction applied") },
1520 /* DT WRO BK */
1521 { SST(0x17, 0x01, SS_NOP | SSQ_PRINT_SENSE,
1522 "Recovered data with retries") },
1523 /* DT WRO BK */
1524 { SST(0x17, 0x02, SS_NOP | SSQ_PRINT_SENSE,
1525 "Recovered data with positive head offset") },
1526 /* DT WRO BK */
1527 { SST(0x17, 0x03, SS_NOP | SSQ_PRINT_SENSE,
1528 "Recovered data with negative head offset") },
1529 /* WRO B */
1530 { SST(0x17, 0x04, SS_NOP | SSQ_PRINT_SENSE,
1531 "Recovered data with retries and/or CIRC applied") },
1532 /* D WRO BK */
1533 { SST(0x17, 0x05, SS_NOP | SSQ_PRINT_SENSE,
1534 "Recovered data using previous sector ID") },
1535 /* D W O BK */
1536 { SST(0x17, 0x06, SS_NOP | SSQ_PRINT_SENSE,
1537 "Recovered data without ECC - data auto-reallocated") },
1538 /* D WRO BK */
1539 { SST(0x17, 0x07, SS_NOP | SSQ_PRINT_SENSE,
1540 "Recovered data without ECC - recommend reassignment") },
1541 /* D WRO BK */
1542 { SST(0x17, 0x08, SS_NOP | SSQ_PRINT_SENSE,
1543 "Recovered data without ECC - recommend rewrite") },
1544 /* D WRO BK */
1545 { SST(0x17, 0x09, SS_NOP | SSQ_PRINT_SENSE,
1546 "Recovered data without ECC - data rewritten") },
1547 /* DT WRO BK */
1548 { SST(0x18, 0x00, SS_NOP | SSQ_PRINT_SENSE,
1549 "Recovered data with error correction applied") },
1550 /* D WRO BK */
1551 { SST(0x18, 0x01, SS_NOP | SSQ_PRINT_SENSE,
1552 "Recovered data with error corr. & retries applied") },
1553 /* D WRO BK */
1554 { SST(0x18, 0x02, SS_NOP | SSQ_PRINT_SENSE,
1555 "Recovered data - data auto-reallocated") },
1556 /* R */
1557 { SST(0x18, 0x03, SS_NOP | SSQ_PRINT_SENSE,
1558 "Recovered data with CIRC") },
1559 /* R */
1560 { SST(0x18, 0x04, SS_NOP | SSQ_PRINT_SENSE,
1561 "Recovered data with L-EC") },
1562 /* D WRO BK */
1563 { SST(0x18, 0x05, SS_NOP | SSQ_PRINT_SENSE,
1564 "Recovered data - recommend reassignment") },
1565 /* D WRO BK */
1566 { SST(0x18, 0x06, SS_NOP | SSQ_PRINT_SENSE,
1567 "Recovered data - recommend rewrite") },
1568 /* D W O BK */
1569 { SST(0x18, 0x07, SS_NOP | SSQ_PRINT_SENSE,
1570 "Recovered data with ECC - data rewritten") },
1571 /* R */
1572 { SST(0x18, 0x08, SS_RDEF, /* XXX TBD */
1573 "Recovered data with linking") },
1574 /* D O K */
1575 { SST(0x19, 0x00, SS_RDEF,
1576 "Defect list error") },
1577 /* D O K */
1578 { SST(0x19, 0x01, SS_RDEF,
1579 "Defect list not available") },
1580 /* D O K */
1581 { SST(0x19, 0x02, SS_RDEF,
1582 "Defect list error in primary list") },
1583 /* D O K */
1584 { SST(0x19, 0x03, SS_RDEF,
1585 "Defect list error in grown list") },
1586 /* DTLPWROMAEBKVF */
1587 { SST(0x1A, 0x00, SS_RDEF,
1588 "Parameter list length error") },
1589 /* DTLPWROMAEBKVF */
1590 { SST(0x1B, 0x00, SS_RDEF,
1591 "Synchronous data transfer error") },
1592 /* D O BK */
1593 { SST(0x1C, 0x00, SS_RDEF,
1594 "Defect list not found") },
1595 /* D O BK */
1596 { SST(0x1C, 0x01, SS_RDEF,
1597 "Primary defect list not found") },
1598 /* D O BK */
1599 { SST(0x1C, 0x02, SS_RDEF,
1600 "Grown defect list not found") },
1601 /* DT WRO BK */
1602 { SST(0x1D, 0x00, SS_FATAL,
1603 "Miscompare during verify operation") },
1604 /* D B */
1605 { SST(0x1D, 0x01, SS_RDEF, /* XXX TBD */
1606 "Miscomparable verify of unmapped LBA") },
1607 /* D W O BK */
1608 { SST(0x1E, 0x00, SS_NOP | SSQ_PRINT_SENSE,
1609 "Recovered ID with ECC correction") },
1610 /* D O K */
1611 { SST(0x1F, 0x00, SS_RDEF,
1612 "Partial defect list transfer") },
1613 /* DTLPWROMAEBKVF */
1614 { SST(0x20, 0x00, SS_FATAL | EINVAL,
1615 "Invalid command operation code") },
1616 /* DT PWROMAEBK */
1617 { SST(0x20, 0x01, SS_RDEF, /* XXX TBD */
1618 "Access denied - initiator pending-enrolled") },
1619 /* DT PWROMAEBK */
1620 { SST(0x20, 0x02, SS_FATAL | EPERM,
1621 "Access denied - no access rights") },
1622 /* DT PWROMAEBK */
1623 { SST(0x20, 0x03, SS_RDEF, /* XXX TBD */
1624 "Access denied - invalid mgmt ID key") },
1625 /* T */
1626 { SST(0x20, 0x04, SS_RDEF, /* XXX TBD */
1627 "Illegal command while in write capable state") },
1628 /* T */
1629 { SST(0x20, 0x05, SS_RDEF, /* XXX TBD */
1630 "Obsolete") },
1631 /* T */
1632 { SST(0x20, 0x06, SS_RDEF, /* XXX TBD */
1633 "Illegal command while in explicit address mode") },
1634 /* T */
1635 { SST(0x20, 0x07, SS_RDEF, /* XXX TBD */
1636 "Illegal command while in implicit address mode") },
1637 /* DT PWROMAEBK */
1638 { SST(0x20, 0x08, SS_RDEF, /* XXX TBD */
1639 "Access denied - enrollment conflict") },
1640 /* DT PWROMAEBK */
1641 { SST(0x20, 0x09, SS_RDEF, /* XXX TBD */
1642 "Access denied - invalid LU identifier") },
1643 /* DT PWROMAEBK */
1644 { SST(0x20, 0x0A, SS_RDEF, /* XXX TBD */
1645 "Access denied - invalid proxy token") },
1646 /* DT PWROMAEBK */
1647 { SST(0x20, 0x0B, SS_RDEF, /* XXX TBD */
1648 "Access denied - ACL LUN conflict") },
1649 /* T */
1650 { SST(0x20, 0x0C, SS_FATAL | EINVAL,
1651 "Illegal command when not in append-only mode") },
1652 /* DT WRO BK */
1653 { SST(0x21, 0x00, SS_FATAL | EINVAL,
1654 "Logical block address out of range") },
1655 /* DT WROM BK */
1656 { SST(0x21, 0x01, SS_FATAL | EINVAL,
1657 "Invalid element address") },
1658 /* R */
1659 { SST(0x21, 0x02, SS_RDEF, /* XXX TBD */
1660 "Invalid address for write") },
1661 /* R */
1662 { SST(0x21, 0x03, SS_RDEF, /* XXX TBD */
1663 "Invalid write crossing layer jump") },
1664 /* D */
1665 { SST(0x21, 0x04, SS_RDEF, /* XXX TBD */
1666 "Unaligned write command") },
1667 /* D */
1668 { SST(0x21, 0x05, SS_RDEF, /* XXX TBD */
1669 "Write boundary violation") },
1670 /* D */
1671 { SST(0x21, 0x06, SS_RDEF, /* XXX TBD */
1672 "Attempt to read invalid data") },
1673 /* D */
1674 { SST(0x21, 0x07, SS_RDEF, /* XXX TBD */
1675 "Read boundary violation") },
1676 /* D */
1677 { SST(0x22, 0x00, SS_FATAL | EINVAL,
1678 "Illegal function (use 20 00, 24 00, or 26 00)") },
1679 /* DT P B */
1680 { SST(0x23, 0x00, SS_FATAL | EINVAL,
1681 "Invalid token operation, cause not reportable") },
1682 /* DT P B */
1683 { SST(0x23, 0x01, SS_FATAL | EINVAL,
1684 "Invalid token operation, unsupported token type") },
1685 /* DT P B */
1686 { SST(0x23, 0x02, SS_FATAL | EINVAL,
1687 "Invalid token operation, remote token usage not supported") },
1688 /* DT P B */
1689 { SST(0x23, 0x03, SS_FATAL | EINVAL,
1690 "Invalid token operation, remote ROD token creation not supported") },
1691 /* DT P B */
1692 { SST(0x23, 0x04, SS_FATAL | EINVAL,
1693 "Invalid token operation, token unknown") },
1694 /* DT P B */
1695 { SST(0x23, 0x05, SS_FATAL | EINVAL,
1696 "Invalid token operation, token corrupt") },
1697 /* DT P B */
1698 { SST(0x23, 0x06, SS_FATAL | EINVAL,
1699 "Invalid token operation, token revoked") },
1700 /* DT P B */
1701 { SST(0x23, 0x07, SS_FATAL | EINVAL,
1702 "Invalid token operation, token expired") },
1703 /* DT P B */
1704 { SST(0x23, 0x08, SS_FATAL | EINVAL,
1705 "Invalid token operation, token cancelled") },
1706 /* DT P B */
1707 { SST(0x23, 0x09, SS_FATAL | EINVAL,
1708 "Invalid token operation, token deleted") },
1709 /* DT P B */
1710 { SST(0x23, 0x0A, SS_FATAL | EINVAL,
1711 "Invalid token operation, invalid token length") },
1712 /* DTLPWROMAEBKVF */
1713 { SST(0x24, 0x00, SS_FATAL | EINVAL,
1714 "Invalid field in CDB") },
1715 /* DTLPWRO AEBKVF */
1716 { SST(0x24, 0x01, SS_RDEF, /* XXX TBD */
1717 "CDB decryption error") },
1718 /* T */
1719 { SST(0x24, 0x02, SS_RDEF, /* XXX TBD */
1720 "Obsolete") },
1721 /* T */
1722 { SST(0x24, 0x03, SS_RDEF, /* XXX TBD */
1723 "Obsolete") },
1724 /* F */
1725 { SST(0x24, 0x04, SS_RDEF, /* XXX TBD */
1726 "Security audit value frozen") },
1727 /* F */
1728 { SST(0x24, 0x05, SS_RDEF, /* XXX TBD */
1729 "Security working key frozen") },
1730 /* F */
1731 { SST(0x24, 0x06, SS_RDEF, /* XXX TBD */
1732 "NONCE not unique") },
1733 /* F */
1734 { SST(0x24, 0x07, SS_RDEF, /* XXX TBD */
1735 "NONCE timestamp out of range") },
1736 /* DT R MAEBKV */
1737 { SST(0x24, 0x08, SS_RDEF, /* XXX TBD */
1738 "Invalid XCDB") },
1739 /* DTLPWROMAEBKVF */
1740 { SST(0x25, 0x00, SS_FATAL | ENXIO | SSQ_LOST,
1741 "Logical unit not supported") },
1742 /* DTLPWROMAEBKVF */
1743 { SST(0x26, 0x00, SS_FATAL | EINVAL,
1744 "Invalid field in parameter list") },
1745 /* DTLPWROMAEBKVF */
1746 { SST(0x26, 0x01, SS_FATAL | EINVAL,
1747 "Parameter not supported") },
1748 /* DTLPWROMAEBKVF */
1749 { SST(0x26, 0x02, SS_FATAL | EINVAL,
1750 "Parameter value invalid") },
1751 /* DTLPWROMAE K */
1752 { SST(0x26, 0x03, SS_FATAL | EINVAL,
1753 "Threshold parameters not supported") },
1754 /* DTLPWROMAEBKVF */
1755 { SST(0x26, 0x04, SS_FATAL | EINVAL,
1756 "Invalid release of persistent reservation") },
1757 /* DTLPWRO A BK */
1758 { SST(0x26, 0x05, SS_RDEF, /* XXX TBD */
1759 "Data decryption error") },
1760 /* DTLPWRO K */
1761 { SST(0x26, 0x06, SS_FATAL | EINVAL,
1762 "Too many target descriptors") },
1763 /* DTLPWRO K */
1764 { SST(0x26, 0x07, SS_FATAL | EINVAL,
1765 "Unsupported target descriptor type code") },
1766 /* DTLPWRO K */
1767 { SST(0x26, 0x08, SS_FATAL | EINVAL,
1768 "Too many segment descriptors") },
1769 /* DTLPWRO K */
1770 { SST(0x26, 0x09, SS_FATAL | EINVAL,
1771 "Unsupported segment descriptor type code") },
1772 /* DTLPWRO K */
1773 { SST(0x26, 0x0A, SS_FATAL | EINVAL,
1774 "Unexpected inexact segment") },
1775 /* DTLPWRO K */
1776 { SST(0x26, 0x0B, SS_FATAL | EINVAL,
1777 "Inline data length exceeded") },
1778 /* DTLPWRO K */
1779 { SST(0x26, 0x0C, SS_FATAL | EINVAL,
1780 "Invalid operation for copy source or destination") },
1781 /* DTLPWRO K */
1782 { SST(0x26, 0x0D, SS_FATAL | EINVAL,
1783 "Copy segment granularity violation") },
1784 /* DT PWROMAEBK */
1785 { SST(0x26, 0x0E, SS_RDEF, /* XXX TBD */
1786 "Invalid parameter while port is enabled") },
1787 /* F */
1788 { SST(0x26, 0x0F, SS_RDEF, /* XXX TBD */
1789 "Invalid data-out buffer integrity check value") },
1790 /* T */
1791 { SST(0x26, 0x10, SS_RDEF, /* XXX TBD */
1792 "Data decryption key fail limit reached") },
1793 /* T */
1794 { SST(0x26, 0x11, SS_RDEF, /* XXX TBD */
1795 "Incomplete key-associated data set") },
1796 /* T */
1797 { SST(0x26, 0x12, SS_RDEF, /* XXX TBD */
1798 "Vendor specific key reference not found") },
1799 /* D */
1800 { SST(0x26, 0x13, SS_RDEF, /* XXX TBD */
1801 "Application tag mode page is invalid") },
1802 /* DT WRO BK */
1803 { SST(0x27, 0x00, SS_FATAL | EACCES,
1804 "Write protected") },
1805 /* DT WRO BK */
1806 { SST(0x27, 0x01, SS_FATAL | EACCES,
1807 "Hardware write protected") },
1808 /* DT WRO BK */
1809 { SST(0x27, 0x02, SS_FATAL | EACCES,
1810 "Logical unit software write protected") },
1811 /* T R */
1812 { SST(0x27, 0x03, SS_FATAL | EACCES,
1813 "Associated write protect") },
1814 /* T R */
1815 { SST(0x27, 0x04, SS_FATAL | EACCES,
1816 "Persistent write protect") },
1817 /* T R */
1818 { SST(0x27, 0x05, SS_FATAL | EACCES,
1819 "Permanent write protect") },
1820 /* R F */
1821 { SST(0x27, 0x06, SS_RDEF, /* XXX TBD */
1822 "Conditional write protect") },
1823 /* D B */
1824 { SST(0x27, 0x07, SS_FATAL | ENOSPC,
1825 "Space allocation failed write protect") },
1826 /* D */
1827 { SST(0x27, 0x08, SS_FATAL | EACCES,
1828 "Zone is read only") },
1829 /* DTLPWROMAEBKVF */
1830 { SST(0x28, 0x00, SS_FATAL | ENXIO,
1831 "Not ready to ready change, medium may have changed") },
1832 /* DT WROM B */
1833 { SST(0x28, 0x01, SS_FATAL | ENXIO,
1834 "Import or export element accessed") },
1835 /* R */
1836 { SST(0x28, 0x02, SS_RDEF, /* XXX TBD */
1837 "Format-layer may have changed") },
1838 /* M */
1839 { SST(0x28, 0x03, SS_RDEF, /* XXX TBD */
1840 "Import/export element accessed, medium changed") },
1841 /*
1842 * XXX JGibbs - All of these should use the same errno, but I don't
1843 * think ENXIO is the correct choice. Should we borrow from
1844 * the networking errnos? ECONNRESET anyone?
1845 */
1846 /* DTLPWROMAEBKVF */
1847 { SST(0x29, 0x00, SS_FATAL | ENXIO,
1848 "Power on, reset, or bus device reset occurred") },
1849 /* DTLPWROMAEBKVF */
1850 { SST(0x29, 0x01, SS_RDEF,
1851 "Power on occurred") },
1852 /* DTLPWROMAEBKVF */
1853 { SST(0x29, 0x02, SS_RDEF,
1854 "SCSI bus reset occurred") },
1855 /* DTLPWROMAEBKVF */
1856 { SST(0x29, 0x03, SS_RDEF,
1857 "Bus device reset function occurred") },
1858 /* DTLPWROMAEBKVF */
1859 { SST(0x29, 0x04, SS_RDEF,
1860 "Device internal reset") },
1861 /* DTLPWROMAEBKVF */
1862 { SST(0x29, 0x05, SS_RDEF,
1863 "Transceiver mode changed to single-ended") },
1864 /* DTLPWROMAEBKVF */
1865 { SST(0x29, 0x06, SS_RDEF,
1866 "Transceiver mode changed to LVD") },
1867 /* DTLPWROMAEBKVF */
1868 { SST(0x29, 0x07, SS_RDEF, /* XXX TBD */
1869 "I_T nexus loss occurred") },
1870 /* DTL WROMAEBKVF */
1871 { SST(0x2A, 0x00, SS_RDEF,
1872 "Parameters changed") },
1873 /* DTL WROMAEBKVF */
1874 { SST(0x2A, 0x01, SS_RDEF,
1875 "Mode parameters changed") },
1876 /* DTL WROMAE K */
1877 { SST(0x2A, 0x02, SS_RDEF,
1878 "Log parameters changed") },
1879 /* DTLPWROMAE K */
1880 { SST(0x2A, 0x03, SS_RDEF,
1881 "Reservations preempted") },
1882 /* DTLPWROMAE */
1883 { SST(0x2A, 0x04, SS_RDEF, /* XXX TBD */
1884 "Reservations released") },
1885 /* DTLPWROMAE */
1886 { SST(0x2A, 0x05, SS_RDEF, /* XXX TBD */
1887 "Registrations preempted") },
1888 /* DTLPWROMAEBKVF */
1889 { SST(0x2A, 0x06, SS_RDEF, /* XXX TBD */
1890 "Asymmetric access state changed") },
1891 /* DTLPWROMAEBKVF */
1892 { SST(0x2A, 0x07, SS_RDEF, /* XXX TBD */
1893 "Implicit asymmetric access state transition failed") },
1894 /* DT WROMAEBKVF */
1895 { SST(0x2A, 0x08, SS_RDEF, /* XXX TBD */
1896 "Priority changed") },
1897 /* D */
1898 { SST(0x2A, 0x09, SS_RDEF, /* XXX TBD */
1899 "Capacity data has changed") },
1900 /* DT */
1901 { SST(0x2A, 0x0A, SS_RDEF, /* XXX TBD */
1902 "Error history I_T nexus cleared") },
1903 /* DT */
1904 { SST(0x2A, 0x0B, SS_RDEF, /* XXX TBD */
1905 "Error history snapshot released") },
1906 /* F */
1907 { SST(0x2A, 0x0C, SS_RDEF, /* XXX TBD */
1908 "Error recovery attributes have changed") },
1909 /* T */
1910 { SST(0x2A, 0x0D, SS_RDEF, /* XXX TBD */
1911 "Data encryption capabilities changed") },
1912 /* DT M E V */
1913 { SST(0x2A, 0x10, SS_RDEF, /* XXX TBD */
1914 "Timestamp changed") },
1915 /* T */
1916 { SST(0x2A, 0x11, SS_RDEF, /* XXX TBD */
1917 "Data encryption parameters changed by another I_T nexus") },
1918 /* T */
1919 { SST(0x2A, 0x12, SS_RDEF, /* XXX TBD */
1920 "Data encryption parameters changed by vendor specific event") },
1921 /* T */
1922 { SST(0x2A, 0x13, SS_RDEF, /* XXX TBD */
1923 "Data encryption key instance counter has changed") },
1924 /* DT R MAEBKV */
1925 { SST(0x2A, 0x14, SS_RDEF, /* XXX TBD */
1926 "SA creation capabilities data has changed") },
1927 /* T M V */
1928 { SST(0x2A, 0x15, SS_RDEF, /* XXX TBD */
1929 "Medium removal prevention preempted") },
1930 /* DTLPWRO K */
1931 { SST(0x2B, 0x00, SS_RDEF,
1932 "Copy cannot execute since host cannot disconnect") },
1933 /* DTLPWROMAEBKVF */
1934 { SST(0x2C, 0x00, SS_RDEF,
1935 "Command sequence error") },
1936 /* */
1937 { SST(0x2C, 0x01, SS_RDEF,
1938 "Too many windows specified") },
1939 /* */
1940 { SST(0x2C, 0x02, SS_RDEF,
1941 "Invalid combination of windows specified") },
1942 /* R */
1943 { SST(0x2C, 0x03, SS_RDEF,
1944 "Current program area is not empty") },
1945 /* R */
1946 { SST(0x2C, 0x04, SS_RDEF,
1947 "Current program area is empty") },
1948 /* B */
1949 { SST(0x2C, 0x05, SS_RDEF, /* XXX TBD */
1950 "Illegal power condition request") },
1951 /* R */
1952 { SST(0x2C, 0x06, SS_RDEF, /* XXX TBD */
1953 "Persistent prevent conflict") },
1954 /* DTLPWROMAEBKVF */
1955 { SST(0x2C, 0x07, SS_RDEF, /* XXX TBD */
1956 "Previous busy status") },
1957 /* DTLPWROMAEBKVF */
1958 { SST(0x2C, 0x08, SS_RDEF, /* XXX TBD */
1959 "Previous task set full status") },
1960 /* DTLPWROM EBKVF */
1961 { SST(0x2C, 0x09, SS_RDEF, /* XXX TBD */
1962 "Previous reservation conflict status") },
1963 /* F */
1964 { SST(0x2C, 0x0A, SS_RDEF, /* XXX TBD */
1965 "Partition or collection contains user objects") },
1966 /* T */
1967 { SST(0x2C, 0x0B, SS_RDEF, /* XXX TBD */
1968 "Not reserved") },
1969 /* D */
1970 { SST(0x2C, 0x0C, SS_RDEF, /* XXX TBD */
1971 "ORWRITE generation does not match") },
1972 /* D */
1973 { SST(0x2C, 0x0D, SS_RDEF, /* XXX TBD */
1974 "Reset write pointer not allowed") },
1975 /* D */
1976 { SST(0x2C, 0x0E, SS_RDEF, /* XXX TBD */
1977 "Zone is offline") },
1978 /* D */
1979 { SST(0x2C, 0x0F, SS_RDEF, /* XXX TBD */
1980 "Stream not open") },
1981 /* D */
1982 { SST(0x2C, 0x10, SS_RDEF, /* XXX TBD */
1983 "Unwritten data in zone") },
1984 /* T */
1985 { SST(0x2D, 0x00, SS_RDEF,
1986 "Overwrite error on update in place") },
1987 /* R */
1988 { SST(0x2E, 0x00, SS_RDEF, /* XXX TBD */
1989 "Insufficient time for operation") },
1990 /* D */
1991 { SST(0x2E, 0x01, SS_RDEF, /* XXX TBD */
1992 "Command timeout before processing") },
1993 /* D */
1994 { SST(0x2E, 0x02, SS_RDEF, /* XXX TBD */
1995 "Command timeout during processing") },
1996 /* D */
1997 { SST(0x2E, 0x03, SS_RDEF, /* XXX TBD */
1998 "Command timeout during processing due to error recovery") },
1999 /* DTLPWROMAEBKVF */
2000 { SST(0x2F, 0x00, SS_RDEF,
2001 "Commands cleared by another initiator") },
2002 /* D */
2003 { SST(0x2F, 0x01, SS_RDEF, /* XXX TBD */
2004 "Commands cleared by power loss notification") },
2005 /* DTLPWROMAEBKVF */
2006 { SST(0x2F, 0x02, SS_RDEF, /* XXX TBD */
2007 "Commands cleared by device server") },
2008 /* DTLPWROMAEBKVF */
2009 { SST(0x2F, 0x03, SS_RDEF, /* XXX TBD */
2010 "Some commands cleared by queuing layer event") },
2011 /* DT WROM BK */
2012 { SST(0x30, 0x00, SS_RDEF,
2013 "Incompatible medium installed") },
2014 /* DT WRO BK */
2015 { SST(0x30, 0x01, SS_RDEF,
2016 "Cannot read medium - unknown format") },
2017 /* DT WRO BK */
2018 { SST(0x30, 0x02, SS_RDEF,
2019 "Cannot read medium - incompatible format") },
2020 /* DT R K */
2021 { SST(0x30, 0x03, SS_RDEF,
2022 "Cleaning cartridge installed") },
2023 /* DT WRO BK */
2024 { SST(0x30, 0x04, SS_RDEF,
2025 "Cannot write medium - unknown format") },
2026 /* DT WRO BK */
2027 { SST(0x30, 0x05, SS_RDEF,
2028 "Cannot write medium - incompatible format") },
2029 /* DT WRO B */
2030 { SST(0x30, 0x06, SS_RDEF,
2031 "Cannot format medium - incompatible medium") },
2032 /* DTL WROMAEBKVF */
2033 { SST(0x30, 0x07, SS_RDEF,
2034 "Cleaning failure") },
2035 /* R */
2036 { SST(0x30, 0x08, SS_RDEF,
2037 "Cannot write - application code mismatch") },
2038 /* R */
2039 { SST(0x30, 0x09, SS_RDEF,
2040 "Current session not fixated for append") },
2041 /* DT WRO AEBK */
2042 { SST(0x30, 0x0A, SS_RDEF, /* XXX TBD */
2043 "Cleaning request rejected") },
2044 /* T */
2045 { SST(0x30, 0x0C, SS_RDEF, /* XXX TBD */
2046 "WORM medium - overwrite attempted") },
2047 /* T */
2048 { SST(0x30, 0x0D, SS_RDEF, /* XXX TBD */
2049 "WORM medium - integrity check") },
2050 /* R */
2051 { SST(0x30, 0x10, SS_RDEF, /* XXX TBD */
2052 "Medium not formatted") },
2053 /* M */
2054 { SST(0x30, 0x11, SS_RDEF, /* XXX TBD */
2055 "Incompatible volume type") },
2056 /* M */
2057 { SST(0x30, 0x12, SS_RDEF, /* XXX TBD */
2058 "Incompatible volume qualifier") },
2059 /* M */
2060 { SST(0x30, 0x13, SS_RDEF, /* XXX TBD */
2061 "Cleaning volume expired") },
2062 /* DT WRO BK */
2063 { SST(0x31, 0x00, SS_FATAL | ENXIO,
2064 "Medium format corrupted") },
2065 /* D L RO B */
2066 { SST(0x31, 0x01, SS_RDEF,
2067 "Format command failed") },
2068 /* R */
2069 { SST(0x31, 0x02, SS_RDEF, /* XXX TBD */
2070 "Zoned formatting failed due to spare linking") },
2071 /* D B */
2072 { SST(0x31, 0x03, SS_FATAL | EIO,
2073 "SANITIZE command failed") },
2074 /* D W O BK */
2075 { SST(0x32, 0x00, SS_RDEF,
2076 "No defect spare location available") },
2077 /* D W O BK */
2078 { SST(0x32, 0x01, SS_RDEF,
2079 "Defect list update failure") },
2080 /* T */
2081 { SST(0x33, 0x00, SS_RDEF,
2082 "Tape length error") },
2083 /* DTLPWROMAEBKVF */
2084 { SST(0x34, 0x00, SS_RDEF,
2085 "Enclosure failure") },
2086 /* DTLPWROMAEBKVF */
2087 { SST(0x35, 0x00, SS_RDEF,
2088 "Enclosure services failure") },
2089 /* DTLPWROMAEBKVF */
2090 { SST(0x35, 0x01, SS_RDEF,
2091 "Unsupported enclosure function") },
2092 /* DTLPWROMAEBKVF */
2093 { SST(0x35, 0x02, SS_RDEF,
2094 "Enclosure services unavailable") },
2095 /* DTLPWROMAEBKVF */
2096 { SST(0x35, 0x03, SS_RDEF,
2097 "Enclosure services transfer failure") },
2098 /* DTLPWROMAEBKVF */
2099 { SST(0x35, 0x04, SS_RDEF,
2100 "Enclosure services transfer refused") },
2101 /* DTL WROMAEBKVF */
2102 { SST(0x35, 0x05, SS_RDEF, /* XXX TBD */
2103 "Enclosure services checksum error") },
2104 /* L */
2105 { SST(0x36, 0x00, SS_RDEF,
2106 "Ribbon, ink, or toner failure") },
2107 /* DTL WROMAEBKVF */
2108 { SST(0x37, 0x00, SS_RDEF,
2109 "Rounded parameter") },
2110 /* B */
2111 { SST(0x38, 0x00, SS_RDEF, /* XXX TBD */
2112 "Event status notification") },
2113 /* B */
2114 { SST(0x38, 0x02, SS_RDEF, /* XXX TBD */
2115 "ESN - power management class event") },
2116 /* B */
2117 { SST(0x38, 0x04, SS_RDEF, /* XXX TBD */
2118 "ESN - media class event") },
2119 /* B */
2120 { SST(0x38, 0x06, SS_RDEF, /* XXX TBD */
2121 "ESN - device busy class event") },
2122 /* D */
2123 { SST(0x38, 0x07, SS_RDEF, /* XXX TBD */
2124 "Thin provisioning soft threshold reached") },
2125 /* DTL WROMAE K */
2126 { SST(0x39, 0x00, SS_RDEF,
2127 "Saving parameters not supported") },
2128 /* DTL WROM BK */
2129 { SST(0x3A, 0x00, SS_FATAL | ENXIO,
2130 "Medium not present") },
2131 /* DT WROM BK */
2132 { SST(0x3A, 0x01, SS_FATAL | ENXIO,
2133 "Medium not present - tray closed") },
2134 /* DT WROM BK */
2135 { SST(0x3A, 0x02, SS_FATAL | ENXIO,
2136 "Medium not present - tray open") },
2137 /* DT WROM B */
2138 { SST(0x3A, 0x03, SS_RDEF, /* XXX TBD */
2139 "Medium not present - loadable") },
2140 /* DT WRO B */
2141 { SST(0x3A, 0x04, SS_RDEF, /* XXX TBD */
2142 "Medium not present - medium auxiliary memory accessible") },
2143 /* TL */
2144 { SST(0x3B, 0x00, SS_RDEF,
2145 "Sequential positioning error") },
2146 /* T */
2147 { SST(0x3B, 0x01, SS_RDEF,
2148 "Tape position error at beginning-of-medium") },
2149 /* T */
2150 { SST(0x3B, 0x02, SS_RDEF,
2151 "Tape position error at end-of-medium") },
2152 /* L */
2153 { SST(0x3B, 0x03, SS_RDEF,
2154 "Tape or electronic vertical forms unit not ready") },
2155 /* L */
2156 { SST(0x3B, 0x04, SS_RDEF,
2157 "Slew failure") },
2158 /* L */
2159 { SST(0x3B, 0x05, SS_RDEF,
2160 "Paper jam") },
2161 /* L */
2162 { SST(0x3B, 0x06, SS_RDEF,
2163 "Failed to sense top-of-form") },
2164 /* L */
2165 { SST(0x3B, 0x07, SS_RDEF,
2166 "Failed to sense bottom-of-form") },
2167 /* T */
2168 { SST(0x3B, 0x08, SS_RDEF,
2169 "Reposition error") },
2170 /* */
2171 { SST(0x3B, 0x09, SS_RDEF,
2172 "Read past end of medium") },
2173 /* */
2174 { SST(0x3B, 0x0A, SS_RDEF,
2175 "Read past beginning of medium") },
2176 /* */
2177 { SST(0x3B, 0x0B, SS_RDEF,
2178 "Position past end of medium") },
2179 /* T */
2180 { SST(0x3B, 0x0C, SS_RDEF,
2181 "Position past beginning of medium") },
2182 /* DT WROM BK */
2183 { SST(0x3B, 0x0D, SS_FATAL | ENOSPC,
2184 "Medium destination element full") },
2185 /* DT WROM BK */
2186 { SST(0x3B, 0x0E, SS_RDEF,
2187 "Medium source element empty") },
2188 /* R */
2189 { SST(0x3B, 0x0F, SS_RDEF,
2190 "End of medium reached") },
2191 /* DT WROM BK */
2192 { SST(0x3B, 0x11, SS_RDEF,
2193 "Medium magazine not accessible") },
2194 /* DT WROM BK */
2195 { SST(0x3B, 0x12, SS_RDEF,
2196 "Medium magazine removed") },
2197 /* DT WROM BK */
2198 { SST(0x3B, 0x13, SS_RDEF,
2199 "Medium magazine inserted") },
2200 /* DT WROM BK */
2201 { SST(0x3B, 0x14, SS_RDEF,
2202 "Medium magazine locked") },
2203 /* DT WROM BK */
2204 { SST(0x3B, 0x15, SS_RDEF,
2205 "Medium magazine unlocked") },
2206 /* R */
2207 { SST(0x3B, 0x16, SS_RDEF, /* XXX TBD */
2208 "Mechanical positioning or changer error") },
2209 /* F */
2210 { SST(0x3B, 0x17, SS_RDEF, /* XXX TBD */
2211 "Read past end of user object") },
2212 /* M */
2213 { SST(0x3B, 0x18, SS_RDEF, /* XXX TBD */
2214 "Element disabled") },
2215 /* M */
2216 { SST(0x3B, 0x19, SS_RDEF, /* XXX TBD */
2217 "Element enabled") },
2218 /* M */
2219 { SST(0x3B, 0x1A, SS_RDEF, /* XXX TBD */
2220 "Data transfer device removed") },
2221 /* M */
2222 { SST(0x3B, 0x1B, SS_RDEF, /* XXX TBD */
2223 "Data transfer device inserted") },
2224 /* T */
2225 { SST(0x3B, 0x1C, SS_RDEF, /* XXX TBD */
2226 "Too many logical objects on partition to support operation") },
2227 /* DTLPWROMAE K */
2228 { SST(0x3D, 0x00, SS_RDEF,
2229 "Invalid bits in IDENTIFY message") },
2230 /* DTLPWROMAEBKVF */
2231 { SST(0x3E, 0x00, SS_RDEF,
2232 "Logical unit has not self-configured yet") },
2233 /* DTLPWROMAEBKVF */
2234 { SST(0x3E, 0x01, SS_RDEF,
2235 "Logical unit failure") },
2236 /* DTLPWROMAEBKVF */
2237 { SST(0x3E, 0x02, SS_RDEF,
2238 "Timeout on logical unit") },
2239 /* DTLPWROMAEBKVF */
2240 { SST(0x3E, 0x03, SS_RDEF, /* XXX TBD */
2241 "Logical unit failed self-test") },
2242 /* DTLPWROMAEBKVF */
2243 { SST(0x3E, 0x04, SS_RDEF, /* XXX TBD */
2244 "Logical unit unable to update self-test log") },
2245 /* DTLPWROMAEBKVF */
2246 { SST(0x3F, 0x00, SS_RDEF,
2247 "Target operating conditions have changed") },
2248 /* DTLPWROMAEBKVF */
2249 { SST(0x3F, 0x01, SS_RDEF,
2250 "Microcode has been changed") },
2251 /* DTLPWROM BK */
2252 { SST(0x3F, 0x02, SS_RDEF,
2253 "Changed operating definition") },
2254 /* DTLPWROMAEBKVF */
2255 { SST(0x3F, 0x03, SS_RDEF,
2256 "INQUIRY data has changed") },
2257 /* DT WROMAEBK */
2258 { SST(0x3F, 0x04, SS_RDEF,
2259 "Component device attached") },
2260 /* DT WROMAEBK */
2261 { SST(0x3F, 0x05, SS_RDEF,
2262 "Device identifier changed") },
2263 /* DT WROMAEB */
2264 { SST(0x3F, 0x06, SS_RDEF,
2265 "Redundancy group created or modified") },
2266 /* DT WROMAEB */
2267 { SST(0x3F, 0x07, SS_RDEF,
2268 "Redundancy group deleted") },
2269 /* DT WROMAEB */
2270 { SST(0x3F, 0x08, SS_RDEF,
2271 "Spare created or modified") },
2272 /* DT WROMAEB */
2273 { SST(0x3F, 0x09, SS_RDEF,
2274 "Spare deleted") },
2275 /* DT WROMAEBK */
2276 { SST(0x3F, 0x0A, SS_RDEF,
2277 "Volume set created or modified") },
2278 /* DT WROMAEBK */
2279 { SST(0x3F, 0x0B, SS_RDEF,
2280 "Volume set deleted") },
2281 /* DT WROMAEBK */
2282 { SST(0x3F, 0x0C, SS_RDEF,
2283 "Volume set deassigned") },
2284 /* DT WROMAEBK */
2285 { SST(0x3F, 0x0D, SS_RDEF,
2286 "Volume set reassigned") },
2287 /* DTLPWROMAE */
2288 { SST(0x3F, 0x0E, SS_RDEF | SSQ_RESCAN ,
2289 "Reported LUNs data has changed") },
2290 /* DTLPWROMAEBKVF */
2291 { SST(0x3F, 0x0F, SS_RDEF, /* XXX TBD */
2292 "Echo buffer overwritten") },
2293 /* DT WROM B */
2294 { SST(0x3F, 0x10, SS_RDEF, /* XXX TBD */
2295 "Medium loadable") },
2296 /* DT WROM B */
2297 { SST(0x3F, 0x11, SS_RDEF, /* XXX TBD */
2298 "Medium auxiliary memory accessible") },
2299 /* DTLPWR MAEBK F */
2300 { SST(0x3F, 0x12, SS_RDEF, /* XXX TBD */
2301 "iSCSI IP address added") },
2302 /* DTLPWR MAEBK F */
2303 { SST(0x3F, 0x13, SS_RDEF, /* XXX TBD */
2304 "iSCSI IP address removed") },
2305 /* DTLPWR MAEBK F */
2306 { SST(0x3F, 0x14, SS_RDEF, /* XXX TBD */
2307 "iSCSI IP address changed") },
2308 /* DTLPWR MAEBK */
2309 { SST(0x3F, 0x15, SS_RDEF, /* XXX TBD */
2310 "Inspect referrals sense descriptors") },
2311 /* DTLPWROMAEBKVF */
2312 { SST(0x3F, 0x16, SS_RDEF, /* XXX TBD */
2313 "Microcode has been changed without reset") },
2314 /* D */
2315 { SST(0x3F, 0x17, SS_RDEF, /* XXX TBD */
2316 "Zone transition to full") },
2317 /* D */
2318 { SST(0x40, 0x00, SS_RDEF,
2319 "RAM failure") }, /* deprecated - use 40 NN instead */
2320 /* DTLPWROMAEBKVF */
2321 { SST(0x40, 0x80, SS_RDEF,
2322 "Diagnostic failure: ASCQ = Component ID") },
2323 /* DTLPWROMAEBKVF */
2324 { SST(0x40, 0xFF, SS_RDEF | SSQ_RANGE,
2325 NULL) }, /* Range 0x80->0xFF */
2326 /* D */
2327 { SST(0x41, 0x00, SS_RDEF,
2328 "Data path failure") }, /* deprecated - use 40 NN instead */
2329 /* D */
2330 { SST(0x42, 0x00, SS_RDEF,
2331 "Power-on or self-test failure") },
2332 /* deprecated - use 40 NN instead */
2333 /* DTLPWROMAEBKVF */
2334 { SST(0x43, 0x00, SS_RDEF,
2335 "Message error") },
2336 /* DTLPWROMAEBKVF */
2337 { SST(0x44, 0x00, SS_FATAL | EIO,
2338 "Internal target failure") },
2339 /* DT P MAEBKVF */
2340 { SST(0x44, 0x01, SS_RDEF, /* XXX TBD */
2341 "Persistent reservation information lost") },
2342 /* DT B */
2343 { SST(0x44, 0x71, SS_RDEF, /* XXX TBD */
2344 "ATA device failed set features") },
2345 /* DTLPWROMAEBKVF */
2346 { SST(0x45, 0x00, SS_RDEF,
2347 "Select or reselect failure") },
2348 /* DTLPWROM BK */
2349 { SST(0x46, 0x00, SS_RDEF,
2350 "Unsuccessful soft reset") },
2351 /* DTLPWROMAEBKVF */
2352 { SST(0x47, 0x00, SS_RDEF,
2353 "SCSI parity error") },
2354 /* DTLPWROMAEBKVF */
2355 { SST(0x47, 0x01, SS_RDEF, /* XXX TBD */
2356 "Data phase CRC error detected") },
2357 /* DTLPWROMAEBKVF */
2358 { SST(0x47, 0x02, SS_RDEF, /* XXX TBD */
2359 "SCSI parity error detected during ST data phase") },
2360 /* DTLPWROMAEBKVF */
2361 { SST(0x47, 0x03, SS_RDEF, /* XXX TBD */
2362 "Information unit iuCRC error detected") },
2363 /* DTLPWROMAEBKVF */
2364 { SST(0x47, 0x04, SS_RDEF, /* XXX TBD */
2365 "Asynchronous information protection error detected") },
2366 /* DTLPWROMAEBKVF */
2367 { SST(0x47, 0x05, SS_RDEF, /* XXX TBD */
2368 "Protocol service CRC error") },
2369 /* DT MAEBKVF */
2370 { SST(0x47, 0x06, SS_RDEF, /* XXX TBD */
2371 "PHY test function in progress") },
2372 /* DT PWROMAEBK */
2373 { SST(0x47, 0x7F, SS_RDEF, /* XXX TBD */
2374 "Some commands cleared by iSCSI protocol event") },
2375 /* DTLPWROMAEBKVF */
2376 { SST(0x48, 0x00, SS_RDEF,
2377 "Initiator detected error message received") },
2378 /* DTLPWROMAEBKVF */
2379 { SST(0x49, 0x00, SS_RDEF,
2380 "Invalid message error") },
2381 /* DTLPWROMAEBKVF */
2382 { SST(0x4A, 0x00, SS_RDEF,
2383 "Command phase error") },
2384 /* DTLPWROMAEBKVF */
2385 { SST(0x4B, 0x00, SS_RDEF,
2386 "Data phase error") },
2387 /* DT PWROMAEBK */
2388 { SST(0x4B, 0x01, SS_RDEF, /* XXX TBD */
2389 "Invalid target port transfer tag received") },
2390 /* DT PWROMAEBK */
2391 { SST(0x4B, 0x02, SS_RDEF, /* XXX TBD */
2392 "Too much write data") },
2393 /* DT PWROMAEBK */
2394 { SST(0x4B, 0x03, SS_RDEF, /* XXX TBD */
2395 "ACK/NAK timeout") },
2396 /* DT PWROMAEBK */
2397 { SST(0x4B, 0x04, SS_RDEF, /* XXX TBD */
2398 "NAK received") },
2399 /* DT PWROMAEBK */
2400 { SST(0x4B, 0x05, SS_RDEF, /* XXX TBD */
2401 "Data offset error") },
2402 /* DT PWROMAEBK */
2403 { SST(0x4B, 0x06, SS_RDEF, /* XXX TBD */
2404 "Initiator response timeout") },
2405 /* DT PWROMAEBK F */
2406 { SST(0x4B, 0x07, SS_RDEF, /* XXX TBD */
2407 "Connection lost") },
2408 /* DT PWROMAEBK F */
2409 { SST(0x4B, 0x08, SS_RDEF, /* XXX TBD */
2410 "Data-in buffer overflow - data buffer size") },
2411 /* DT PWROMAEBK F */
2412 { SST(0x4B, 0x09, SS_RDEF, /* XXX TBD */
2413 "Data-in buffer overflow - data buffer descriptor area") },
2414 /* DT PWROMAEBK F */
2415 { SST(0x4B, 0x0A, SS_RDEF, /* XXX TBD */
2416 "Data-in buffer error") },
2417 /* DT PWROMAEBK F */
2418 { SST(0x4B, 0x0B, SS_RDEF, /* XXX TBD */
2419 "Data-out buffer overflow - data buffer size") },
2420 /* DT PWROMAEBK F */
2421 { SST(0x4B, 0x0C, SS_RDEF, /* XXX TBD */
2422 "Data-out buffer overflow - data buffer descriptor area") },
2423 /* DT PWROMAEBK F */
2424 { SST(0x4B, 0x0D, SS_RDEF, /* XXX TBD */
2425 "Data-out buffer error") },
2426 /* DT PWROMAEBK F */
2427 { SST(0x4B, 0x0E, SS_RDEF, /* XXX TBD */
2428 "PCIe fabric error") },
2429 /* DT PWROMAEBK F */
2430 { SST(0x4B, 0x0F, SS_RDEF, /* XXX TBD */
2431 "PCIe completion timeout") },
2432 /* DT PWROMAEBK F */
2433 { SST(0x4B, 0x10, SS_RDEF, /* XXX TBD */
2434 "PCIe completer abort") },
2435 /* DT PWROMAEBK F */
2436 { SST(0x4B, 0x11, SS_RDEF, /* XXX TBD */
2437 "PCIe poisoned TLP received") },
2438 /* DT PWROMAEBK F */
2439 { SST(0x4B, 0x12, SS_RDEF, /* XXX TBD */
2440 "PCIe ECRC check failed") },
2441 /* DT PWROMAEBK F */
2442 { SST(0x4B, 0x13, SS_RDEF, /* XXX TBD */
2443 "PCIe unsupported request") },
2444 /* DT PWROMAEBK F */
2445 { SST(0x4B, 0x14, SS_RDEF, /* XXX TBD */
2446 "PCIe ACS violation") },
2447 /* DT PWROMAEBK F */
2448 { SST(0x4B, 0x15, SS_RDEF, /* XXX TBD */
2449 "PCIe TLP prefix blocket") },
2450 /* DTLPWROMAEBKVF */
2451 { SST(0x4C, 0x00, SS_RDEF,
2452 "Logical unit failed self-configuration") },
2453 /* DTLPWROMAEBKVF */
2454 { SST(0x4D, 0x00, SS_RDEF,
2455 "Tagged overlapped commands: ASCQ = Queue tag ID") },
2456 /* DTLPWROMAEBKVF */
2457 { SST(0x4D, 0xFF, SS_RDEF | SSQ_RANGE,
2458 NULL) }, /* Range 0x00->0xFF */
2459 /* DTLPWROMAEBKVF */
2460 { SST(0x4E, 0x00, SS_RDEF,
2461 "Overlapped commands attempted") },
2462 /* T */
2463 { SST(0x50, 0x00, SS_RDEF,
2464 "Write append error") },
2465 /* T */
2466 { SST(0x50, 0x01, SS_RDEF,
2467 "Write append position error") },
2468 /* T */
2469 { SST(0x50, 0x02, SS_RDEF,
2470 "Position error related to timing") },
2471 /* T RO */
2472 { SST(0x51, 0x00, SS_RDEF,
2473 "Erase failure") },
2474 /* R */
2475 { SST(0x51, 0x01, SS_RDEF, /* XXX TBD */
2476 "Erase failure - incomplete erase operation detected") },
2477 /* T */
2478 { SST(0x52, 0x00, SS_RDEF,
2479 "Cartridge fault") },
2480 /* DTL WROM BK */
2481 { SST(0x53, 0x00, SS_RDEF,
2482 "Media load or eject failed") },
2483 /* T */
2484 { SST(0x53, 0x01, SS_RDEF,
2485 "Unload tape failure") },
2486 /* DT WROM BK */
2487 { SST(0x53, 0x02, SS_RDEF,
2488 "Medium removal prevented") },
2489 /* M */
2490 { SST(0x53, 0x03, SS_RDEF, /* XXX TBD */
2491 "Medium removal prevented by data transfer element") },
2492 /* T */
2493 { SST(0x53, 0x04, SS_RDEF, /* XXX TBD */
2494 "Medium thread or unthread failure") },
2495 /* M */
2496 { SST(0x53, 0x05, SS_RDEF, /* XXX TBD */
2497 "Volume identifier invalid") },
2498 /* T */
2499 { SST(0x53, 0x06, SS_RDEF, /* XXX TBD */
2500 "Volume identifier missing") },
2501 /* M */
2502 { SST(0x53, 0x07, SS_RDEF, /* XXX TBD */
2503 "Duplicate volume identifier") },
2504 /* M */
2505 { SST(0x53, 0x08, SS_RDEF, /* XXX TBD */
2506 "Element status unknown") },
2507 /* M */
2508 { SST(0x53, 0x09, SS_RDEF, /* XXX TBD */
2509 "Data transfer device error - load failed") },
2510 /* M */
2511 { SST(0x53, 0x0A, SS_RDEF, /* XXX TBD */
2512 "Data transfer device error - unload failed") },
2513 /* M */
2514 { SST(0x53, 0x0B, SS_RDEF, /* XXX TBD */
2515 "Data transfer device error - unload missing") },
2516 /* M */
2517 { SST(0x53, 0x0C, SS_RDEF, /* XXX TBD */
2518 "Data transfer device error - eject failed") },
2519 /* M */
2520 { SST(0x53, 0x0D, SS_RDEF, /* XXX TBD */
2521 "Data transfer device error - library communication failed") },
2522 /* P */
2523 { SST(0x54, 0x00, SS_RDEF,
2524 "SCSI to host system interface failure") },
2525 /* P */
2526 { SST(0x55, 0x00, SS_RDEF,
2527 "System resource failure") },
2528 /* D O BK */
2529 { SST(0x55, 0x01, SS_FATAL | ENOSPC,
2530 "System buffer full") },
2531 /* DTLPWROMAE K */
2532 { SST(0x55, 0x02, SS_RDEF, /* XXX TBD */
2533 "Insufficient reservation resources") },
2534 /* DTLPWROMAE K */
2535 { SST(0x55, 0x03, SS_RDEF, /* XXX TBD */
2536 "Insufficient resources") },
2537 /* DTLPWROMAE K */
2538 { SST(0x55, 0x04, SS_RDEF, /* XXX TBD */
2539 "Insufficient registration resources") },
2540 /* DT PWROMAEBK */
2541 { SST(0x55, 0x05, SS_RDEF, /* XXX TBD */
2542 "Insufficient access control resources") },
2543 /* DT WROM B */
2544 { SST(0x55, 0x06, SS_RDEF, /* XXX TBD */
2545 "Auxiliary memory out of space") },
2546 /* F */
2547 { SST(0x55, 0x07, SS_RDEF, /* XXX TBD */
2548 "Quota error") },
2549 /* T */
2550 { SST(0x55, 0x08, SS_RDEF, /* XXX TBD */
2551 "Maximum number of supplemental decryption keys exceeded") },
2552 /* M */
2553 { SST(0x55, 0x09, SS_RDEF, /* XXX TBD */
2554 "Medium auxiliary memory not accessible") },
2555 /* M */
2556 { SST(0x55, 0x0A, SS_RDEF, /* XXX TBD */
2557 "Data currently unavailable") },
2558 /* DTLPWROMAEBKVF */
2559 { SST(0x55, 0x0B, SS_RDEF, /* XXX TBD */
2560 "Insufficient power for operation") },
2561 /* DT P B */
2562 { SST(0x55, 0x0C, SS_RDEF, /* XXX TBD */
2563 "Insufficient resources to create ROD") },
2564 /* DT P B */
2565 { SST(0x55, 0x0D, SS_RDEF, /* XXX TBD */
2566 "Insufficient resources to create ROD token") },
2567 /* D */
2568 { SST(0x55, 0x0E, SS_RDEF, /* XXX TBD */
2569 "Insufficient zone resources") },
2570 /* D */
2571 { SST(0x55, 0x0F, SS_RDEF, /* XXX TBD */
2572 "Insufficient zone resources to complete write") },
2573 /* D */
2574 { SST(0x55, 0x10, SS_RDEF, /* XXX TBD */
2575 "Maximum number of streams open") },
2576 /* R */
2577 { SST(0x57, 0x00, SS_RDEF,
2578 "Unable to recover table-of-contents") },
2579 /* O */
2580 { SST(0x58, 0x00, SS_RDEF,
2581 "Generation does not exist") },
2582 /* O */
2583 { SST(0x59, 0x00, SS_RDEF,
2584 "Updated block read") },
2585 /* DTLPWRO BK */
2586 { SST(0x5A, 0x00, SS_RDEF,
2587 "Operator request or state change input") },
2588 /* DT WROM BK */
2589 { SST(0x5A, 0x01, SS_RDEF,
2590 "Operator medium removal request") },
2591 /* DT WRO A BK */
2592 { SST(0x5A, 0x02, SS_RDEF,
2593 "Operator selected write protect") },
2594 /* DT WRO A BK */
2595 { SST(0x5A, 0x03, SS_RDEF,
2596 "Operator selected write permit") },
2597 /* DTLPWROM K */
2598 { SST(0x5B, 0x00, SS_RDEF,
2599 "Log exception") },
2600 /* DTLPWROM K */
2601 { SST(0x5B, 0x01, SS_RDEF,
2602 "Threshold condition met") },
2603 /* DTLPWROM K */
2604 { SST(0x5B, 0x02, SS_RDEF,
2605 "Log counter at maximum") },
2606 /* DTLPWROM K */
2607 { SST(0x5B, 0x03, SS_RDEF,
2608 "Log list codes exhausted") },
2609 /* D O */
2610 { SST(0x5C, 0x00, SS_RDEF,
2611 "RPL status change") },
2612 /* D O */
2613 { SST(0x5C, 0x01, SS_NOP | SSQ_PRINT_SENSE,
2614 "Spindles synchronized") },
2615 /* D O */
2616 { SST(0x5C, 0x02, SS_RDEF,
2617 "Spindles not synchronized") },
2618 /* DTLPWROMAEBKVF */
2619 { SST(0x5D, 0x00, SS_NOP | SSQ_PRINT_SENSE,
2620 "Failure prediction threshold exceeded") },
2621 /* R B */
2622 { SST(0x5D, 0x01, SS_NOP | SSQ_PRINT_SENSE,
2623 "Media failure prediction threshold exceeded") },
2624 /* R */
2625 { SST(0x5D, 0x02, SS_NOP | SSQ_PRINT_SENSE,
2626 "Logical unit failure prediction threshold exceeded") },
2627 /* R */
2628 { SST(0x5D, 0x03, SS_NOP | SSQ_PRINT_SENSE,
2629 "Spare area exhaustion prediction threshold exceeded") },
2630 /* D B */
2631 { SST(0x5D, 0x10, SS_NOP | SSQ_PRINT_SENSE,
2632 "Hardware impending failure general hard drive failure") },
2633 /* D B */
2634 { SST(0x5D, 0x11, SS_NOP | SSQ_PRINT_SENSE,
2635 "Hardware impending failure drive error rate too high") },
2636 /* D B */
2637 { SST(0x5D, 0x12, SS_NOP | SSQ_PRINT_SENSE,
2638 "Hardware impending failure data error rate too high") },
2639 /* D B */
2640 { SST(0x5D, 0x13, SS_NOP | SSQ_PRINT_SENSE,
2641 "Hardware impending failure seek error rate too high") },
2642 /* D B */
2643 { SST(0x5D, 0x14, SS_NOP | SSQ_PRINT_SENSE,
2644 "Hardware impending failure too many block reassigns") },
2645 /* D B */
2646 { SST(0x5D, 0x15, SS_NOP | SSQ_PRINT_SENSE,
2647 "Hardware impending failure access times too high") },
2648 /* D B */
2649 { SST(0x5D, 0x16, SS_NOP | SSQ_PRINT_SENSE,
2650 "Hardware impending failure start unit times too high") },
2651 /* D B */
2652 { SST(0x5D, 0x17, SS_NOP | SSQ_PRINT_SENSE,
2653 "Hardware impending failure channel parametrics") },
2654 /* D B */
2655 { SST(0x5D, 0x18, SS_NOP | SSQ_PRINT_SENSE,
2656 "Hardware impending failure controller detected") },
2657 /* D B */
2658 { SST(0x5D, 0x19, SS_NOP | SSQ_PRINT_SENSE,
2659 "Hardware impending failure throughput performance") },
2660 /* D B */
2661 { SST(0x5D, 0x1A, SS_NOP | SSQ_PRINT_SENSE,
2662 "Hardware impending failure seek time performance") },
2663 /* D B */
2664 { SST(0x5D, 0x1B, SS_NOP | SSQ_PRINT_SENSE,
2665 "Hardware impending failure spin-up retry count") },
2666 /* D B */
2667 { SST(0x5D, 0x1C, SS_NOP | SSQ_PRINT_SENSE,
2668 "Hardware impending failure drive calibration retry count") },
2669 /* D B */
2670 { SST(0x5D, 0x1D, SS_NOP | SSQ_PRINT_SENSE,
2671 "Hardware impending failure power loss protection circuit") },
2672 /* D B */
2673 { SST(0x5D, 0x20, SS_NOP | SSQ_PRINT_SENSE,
2674 "Controller impending failure general hard drive failure") },
2675 /* D B */
2676 { SST(0x5D, 0x21, SS_NOP | SSQ_PRINT_SENSE,
2677 "Controller impending failure drive error rate too high") },
2678 /* D B */
2679 { SST(0x5D, 0x22, SS_NOP | SSQ_PRINT_SENSE,
2680 "Controller impending failure data error rate too high") },
2681 /* D B */
2682 { SST(0x5D, 0x23, SS_NOP | SSQ_PRINT_SENSE,
2683 "Controller impending failure seek error rate too high") },
2684 /* D B */
2685 { SST(0x5D, 0x24, SS_NOP | SSQ_PRINT_SENSE,
2686 "Controller impending failure too many block reassigns") },
2687 /* D B */
2688 { SST(0x5D, 0x25, SS_NOP | SSQ_PRINT_SENSE,
2689 "Controller impending failure access times too high") },
2690 /* D B */
2691 { SST(0x5D, 0x26, SS_NOP | SSQ_PRINT_SENSE,
2692 "Controller impending failure start unit times too high") },
2693 /* D B */
2694 { SST(0x5D, 0x27, SS_NOP | SSQ_PRINT_SENSE,
2695 "Controller impending failure channel parametrics") },
2696 /* D B */
2697 { SST(0x5D, 0x28, SS_NOP | SSQ_PRINT_SENSE,
2698 "Controller impending failure controller detected") },
2699 /* D B */
2700 { SST(0x5D, 0x29, SS_NOP | SSQ_PRINT_SENSE,
2701 "Controller impending failure throughput performance") },
2702 /* D B */
2703 { SST(0x5D, 0x2A, SS_NOP | SSQ_PRINT_SENSE,
2704 "Controller impending failure seek time performance") },
2705 /* D B */
2706 { SST(0x5D, 0x2B, SS_NOP | SSQ_PRINT_SENSE,
2707 "Controller impending failure spin-up retry count") },
2708 /* D B */
2709 { SST(0x5D, 0x2C, SS_NOP | SSQ_PRINT_SENSE,
2710 "Controller impending failure drive calibration retry count") },
2711 /* D B */
2712 { SST(0x5D, 0x30, SS_NOP | SSQ_PRINT_SENSE,
2713 "Data channel impending failure general hard drive failure") },
2714 /* D B */
2715 { SST(0x5D, 0x31, SS_NOP | SSQ_PRINT_SENSE,
2716 "Data channel impending failure drive error rate too high") },
2717 /* D B */
2718 { SST(0x5D, 0x32, SS_NOP | SSQ_PRINT_SENSE,
2719 "Data channel impending failure data error rate too high") },
2720 /* D B */
2721 { SST(0x5D, 0x33, SS_NOP | SSQ_PRINT_SENSE,
2722 "Data channel impending failure seek error rate too high") },
2723 /* D B */
2724 { SST(0x5D, 0x34, SS_NOP | SSQ_PRINT_SENSE,
2725 "Data channel impending failure too many block reassigns") },
2726 /* D B */
2727 { SST(0x5D, 0x35, SS_NOP | SSQ_PRINT_SENSE,
2728 "Data channel impending failure access times too high") },
2729 /* D B */
2730 { SST(0x5D, 0x36, SS_NOP | SSQ_PRINT_SENSE,
2731 "Data channel impending failure start unit times too high") },
2732 /* D B */
2733 { SST(0x5D, 0x37, SS_NOP | SSQ_PRINT_SENSE,
2734 "Data channel impending failure channel parametrics") },
2735 /* D B */
2736 { SST(0x5D, 0x38, SS_NOP | SSQ_PRINT_SENSE,
2737 "Data channel impending failure controller detected") },
2738 /* D B */
2739 { SST(0x5D, 0x39, SS_NOP | SSQ_PRINT_SENSE,
2740 "Data channel impending failure throughput performance") },
2741 /* D B */
2742 { SST(0x5D, 0x3A, SS_NOP | SSQ_PRINT_SENSE,
2743 "Data channel impending failure seek time performance") },
2744 /* D B */
2745 { SST(0x5D, 0x3B, SS_NOP | SSQ_PRINT_SENSE,
2746 "Data channel impending failure spin-up retry count") },
2747 /* D B */
2748 { SST(0x5D, 0x3C, SS_NOP | SSQ_PRINT_SENSE,
2749 "Data channel impending failure drive calibration retry count") },
2750 /* D B */
2751 { SST(0x5D, 0x40, SS_NOP | SSQ_PRINT_SENSE,
2752 "Servo impending failure general hard drive failure") },
2753 /* D B */
2754 { SST(0x5D, 0x41, SS_NOP | SSQ_PRINT_SENSE,
2755 "Servo impending failure drive error rate too high") },
2756 /* D B */
2757 { SST(0x5D, 0x42, SS_NOP | SSQ_PRINT_SENSE,
2758 "Servo impending failure data error rate too high") },
2759 /* D B */
2760 { SST(0x5D, 0x43, SS_NOP | SSQ_PRINT_SENSE,
2761 "Servo impending failure seek error rate too high") },
2762 /* D B */
2763 { SST(0x5D, 0x44, SS_NOP | SSQ_PRINT_SENSE,
2764 "Servo impending failure too many block reassigns") },
2765 /* D B */
2766 { SST(0x5D, 0x45, SS_NOP | SSQ_PRINT_SENSE,
2767 "Servo impending failure access times too high") },
2768 /* D B */
2769 { SST(0x5D, 0x46, SS_NOP | SSQ_PRINT_SENSE,
2770 "Servo impending failure start unit times too high") },
2771 /* D B */
2772 { SST(0x5D, 0x47, SS_NOP | SSQ_PRINT_SENSE,
2773 "Servo impending failure channel parametrics") },
2774 /* D B */
2775 { SST(0x5D, 0x48, SS_NOP | SSQ_PRINT_SENSE,
2776 "Servo impending failure controller detected") },
2777 /* D B */
2778 { SST(0x5D, 0x49, SS_NOP | SSQ_PRINT_SENSE,
2779 "Servo impending failure throughput performance") },
2780 /* D B */
2781 { SST(0x5D, 0x4A, SS_NOP | SSQ_PRINT_SENSE,
2782 "Servo impending failure seek time performance") },
2783 /* D B */
2784 { SST(0x5D, 0x4B, SS_NOP | SSQ_PRINT_SENSE,
2785 "Servo impending failure spin-up retry count") },
2786 /* D B */
2787 { SST(0x5D, 0x4C, SS_NOP | SSQ_PRINT_SENSE,
2788 "Servo impending failure drive calibration retry count") },
2789 /* D B */
2790 { SST(0x5D, 0x50, SS_NOP | SSQ_PRINT_SENSE,
2791 "Spindle impending failure general hard drive failure") },
2792 /* D B */
2793 { SST(0x5D, 0x51, SS_NOP | SSQ_PRINT_SENSE,
2794 "Spindle impending failure drive error rate too high") },
2795 /* D B */
2796 { SST(0x5D, 0x52, SS_NOP | SSQ_PRINT_SENSE,
2797 "Spindle impending failure data error rate too high") },
2798 /* D B */
2799 { SST(0x5D, 0x53, SS_NOP | SSQ_PRINT_SENSE,
2800 "Spindle impending failure seek error rate too high") },
2801 /* D B */
2802 { SST(0x5D, 0x54, SS_NOP | SSQ_PRINT_SENSE,
2803 "Spindle impending failure too many block reassigns") },
2804 /* D B */
2805 { SST(0x5D, 0x55, SS_NOP | SSQ_PRINT_SENSE,
2806 "Spindle impending failure access times too high") },
2807 /* D B */
2808 { SST(0x5D, 0x56, SS_NOP | SSQ_PRINT_SENSE,
2809 "Spindle impending failure start unit times too high") },
2810 /* D B */
2811 { SST(0x5D, 0x57, SS_NOP | SSQ_PRINT_SENSE,
2812 "Spindle impending failure channel parametrics") },
2813 /* D B */
2814 { SST(0x5D, 0x58, SS_NOP | SSQ_PRINT_SENSE,
2815 "Spindle impending failure controller detected") },
2816 /* D B */
2817 { SST(0x5D, 0x59, SS_NOP | SSQ_PRINT_SENSE,
2818 "Spindle impending failure throughput performance") },
2819 /* D B */
2820 { SST(0x5D, 0x5A, SS_NOP | SSQ_PRINT_SENSE,
2821 "Spindle impending failure seek time performance") },
2822 /* D B */
2823 { SST(0x5D, 0x5B, SS_NOP | SSQ_PRINT_SENSE,
2824 "Spindle impending failure spin-up retry count") },
2825 /* D B */
2826 { SST(0x5D, 0x5C, SS_NOP | SSQ_PRINT_SENSE,
2827 "Spindle impending failure drive calibration retry count") },
2828 /* D B */
2829 { SST(0x5D, 0x60, SS_NOP | SSQ_PRINT_SENSE,
2830 "Firmware impending failure general hard drive failure") },
2831 /* D B */
2832 { SST(0x5D, 0x61, SS_NOP | SSQ_PRINT_SENSE,
2833 "Firmware impending failure drive error rate too high") },
2834 /* D B */
2835 { SST(0x5D, 0x62, SS_NOP | SSQ_PRINT_SENSE,
2836 "Firmware impending failure data error rate too high") },
2837 /* D B */
2838 { SST(0x5D, 0x63, SS_NOP | SSQ_PRINT_SENSE,
2839 "Firmware impending failure seek error rate too high") },
2840 /* D B */
2841 { SST(0x5D, 0x64, SS_NOP | SSQ_PRINT_SENSE,
2842 "Firmware impending failure too many block reassigns") },
2843 /* D B */
2844 { SST(0x5D, 0x65, SS_NOP | SSQ_PRINT_SENSE,
2845 "Firmware impending failure access times too high") },
2846 /* D B */
2847 { SST(0x5D, 0x66, SS_NOP | SSQ_PRINT_SENSE,
2848 "Firmware impending failure start unit times too high") },
2849 /* D B */
2850 { SST(0x5D, 0x67, SS_NOP | SSQ_PRINT_SENSE,
2851 "Firmware impending failure channel parametrics") },
2852 /* D B */
2853 { SST(0x5D, 0x68, SS_NOP | SSQ_PRINT_SENSE,
2854 "Firmware impending failure controller detected") },
2855 /* D B */
2856 { SST(0x5D, 0x69, SS_NOP | SSQ_PRINT_SENSE,
2857 "Firmware impending failure throughput performance") },
2858 /* D B */
2859 { SST(0x5D, 0x6A, SS_NOP | SSQ_PRINT_SENSE,
2860 "Firmware impending failure seek time performance") },
2861 /* D B */
2862 { SST(0x5D, 0x6B, SS_NOP | SSQ_PRINT_SENSE,
2863 "Firmware impending failure spin-up retry count") },
2864 /* D B */
2865 { SST(0x5D, 0x6C, SS_NOP | SSQ_PRINT_SENSE,
2866 "Firmware impending failure drive calibration retry count") },
2867 /* D B */
2868 { SST(0x5D, 0x73, SS_NOP | SSQ_PRINT_SENSE,
2869 "Media impending failure endurance limit met") },
2870 /* DTLPWROMAEBKVF */
2871 { SST(0x5D, 0xFF, SS_NOP | SSQ_PRINT_SENSE,
2872 "Failure prediction threshold exceeded (false)") },
2873 /* DTLPWRO A K */
2874 { SST(0x5E, 0x00, SS_RDEF,
2875 "Low power condition on") },
2876 /* DTLPWRO A K */
2877 { SST(0x5E, 0x01, SS_RDEF,
2878 "Idle condition activated by timer") },
2879 /* DTLPWRO A K */
2880 { SST(0x5E, 0x02, SS_RDEF,
2881 "Standby condition activated by timer") },
2882 /* DTLPWRO A K */
2883 { SST(0x5E, 0x03, SS_RDEF,
2884 "Idle condition activated by command") },
2885 /* DTLPWRO A K */
2886 { SST(0x5E, 0x04, SS_RDEF,
2887 "Standby condition activated by command") },
2888 /* DTLPWRO A K */
2889 { SST(0x5E, 0x05, SS_RDEF,
2890 "Idle-B condition activated by timer") },
2891 /* DTLPWRO A K */
2892 { SST(0x5E, 0x06, SS_RDEF,
2893 "Idle-B condition activated by command") },
2894 /* DTLPWRO A K */
2895 { SST(0x5E, 0x07, SS_RDEF,
2896 "Idle-C condition activated by timer") },
2897 /* DTLPWRO A K */
2898 { SST(0x5E, 0x08, SS_RDEF,
2899 "Idle-C condition activated by command") },
2900 /* DTLPWRO A K */
2901 { SST(0x5E, 0x09, SS_RDEF,
2902 "Standby-Y condition activated by timer") },
2903 /* DTLPWRO A K */
2904 { SST(0x5E, 0x0A, SS_RDEF,
2905 "Standby-Y condition activated by command") },
2906 /* B */
2907 { SST(0x5E, 0x41, SS_RDEF, /* XXX TBD */
2908 "Power state change to active") },
2909 /* B */
2910 { SST(0x5E, 0x42, SS_RDEF, /* XXX TBD */
2911 "Power state change to idle") },
2912 /* B */
2913 { SST(0x5E, 0x43, SS_RDEF, /* XXX TBD */
2914 "Power state change to standby") },
2915 /* B */
2916 { SST(0x5E, 0x45, SS_RDEF, /* XXX TBD */
2917 "Power state change to sleep") },
2918 /* BK */
2919 { SST(0x5E, 0x47, SS_RDEF, /* XXX TBD */
2920 "Power state change to device control") },
2921 /* */
2922 { SST(0x60, 0x00, SS_RDEF,
2923 "Lamp failure") },
2924 /* */
2925 { SST(0x61, 0x00, SS_RDEF,
2926 "Video acquisition error") },
2927 /* */
2928 { SST(0x61, 0x01, SS_RDEF,
2929 "Unable to acquire video") },
2930 /* */
2931 { SST(0x61, 0x02, SS_RDEF,
2932 "Out of focus") },
2933 /* */
2934 { SST(0x62, 0x00, SS_RDEF,
2935 "Scan head positioning error") },
2936 /* R */
2937 { SST(0x63, 0x00, SS_RDEF,
2938 "End of user area encountered on this track") },
2939 /* R */
2940 { SST(0x63, 0x01, SS_FATAL | ENOSPC,
2941 "Packet does not fit in available space") },
2942 /* R */
2943 { SST(0x64, 0x00, SS_FATAL | ENXIO,
2944 "Illegal mode for this track") },
2945 /* R */
2946 { SST(0x64, 0x01, SS_RDEF,
2947 "Invalid packet size") },
2948 /* DTLPWROMAEBKVF */
2949 { SST(0x65, 0x00, SS_RDEF,
2950 "Voltage fault") },
2951 /* */
2952 { SST(0x66, 0x00, SS_RDEF,
2953 "Automatic document feeder cover up") },
2954 /* */
2955 { SST(0x66, 0x01, SS_RDEF,
2956 "Automatic document feeder lift up") },
2957 /* */
2958 { SST(0x66, 0x02, SS_RDEF,
2959 "Document jam in automatic document feeder") },
2960 /* */
2961 { SST(0x66, 0x03, SS_RDEF,
2962 "Document miss feed automatic in document feeder") },
2963 /* A */
2964 { SST(0x67, 0x00, SS_RDEF,
2965 "Configuration failure") },
2966 /* A */
2967 { SST(0x67, 0x01, SS_RDEF,
2968 "Configuration of incapable logical units failed") },
2969 /* A */
2970 { SST(0x67, 0x02, SS_RDEF,
2971 "Add logical unit failed") },
2972 /* A */
2973 { SST(0x67, 0x03, SS_RDEF,
2974 "Modification of logical unit failed") },
2975 /* A */
2976 { SST(0x67, 0x04, SS_RDEF,
2977 "Exchange of logical unit failed") },
2978 /* A */
2979 { SST(0x67, 0x05, SS_RDEF,
2980 "Remove of logical unit failed") },
2981 /* A */
2982 { SST(0x67, 0x06, SS_RDEF,
2983 "Attachment of logical unit failed") },
2984 /* A */
2985 { SST(0x67, 0x07, SS_RDEF,
2986 "Creation of logical unit failed") },
2987 /* A */
2988 { SST(0x67, 0x08, SS_RDEF, /* XXX TBD */
2989 "Assign failure occurred") },
2990 /* A */
2991 { SST(0x67, 0x09, SS_RDEF, /* XXX TBD */
2992 "Multiply assigned logical unit") },
2993 /* DTLPWROMAEBKVF */
2994 { SST(0x67, 0x0A, SS_RDEF, /* XXX TBD */
2995 "Set target port groups command failed") },
2996 /* DT B */
2997 { SST(0x67, 0x0B, SS_RDEF, /* XXX TBD */
2998 "ATA device feature not enabled") },
2999 /* A */
3000 { SST(0x68, 0x00, SS_RDEF,
3001 "Logical unit not configured") },
3002 /* D */
3003 { SST(0x68, 0x01, SS_RDEF,
3004 "Subsidiary logical unit not configured") },
3005 /* A */
3006 { SST(0x69, 0x00, SS_RDEF,
3007 "Data loss on logical unit") },
3008 /* A */
3009 { SST(0x69, 0x01, SS_RDEF,
3010 "Multiple logical unit failures") },
3011 /* A */
3012 { SST(0x69, 0x02, SS_RDEF,
3013 "Parity/data mismatch") },
3014 /* A */
3015 { SST(0x6A, 0x00, SS_RDEF,
3016 "Informational, refer to log") },
3017 /* A */
3018 { SST(0x6B, 0x00, SS_RDEF,
3019 "State change has occurred") },
3020 /* A */
3021 { SST(0x6B, 0x01, SS_RDEF,
3022 "Redundancy level got better") },
3023 /* A */
3024 { SST(0x6B, 0x02, SS_RDEF,
3025 "Redundancy level got worse") },
3026 /* A */
3027 { SST(0x6C, 0x00, SS_RDEF,
3028 "Rebuild failure occurred") },
3029 /* A */
3030 { SST(0x6D, 0x00, SS_RDEF,
3031 "Recalculate failure occurred") },
3032 /* A */
3033 { SST(0x6E, 0x00, SS_RDEF,
3034 "Command to logical unit failed") },
3035 /* R */
3036 { SST(0x6F, 0x00, SS_RDEF, /* XXX TBD */
3037 "Copy protection key exchange failure - authentication failure") },
3038 /* R */
3039 { SST(0x6F, 0x01, SS_RDEF, /* XXX TBD */
3040 "Copy protection key exchange failure - key not present") },
3041 /* R */
3042 { SST(0x6F, 0x02, SS_RDEF, /* XXX TBD */
3043 "Copy protection key exchange failure - key not established") },
3044 /* R */
3045 { SST(0x6F, 0x03, SS_RDEF, /* XXX TBD */
3046 "Read of scrambled sector without authentication") },
3047 /* R */
3048 { SST(0x6F, 0x04, SS_RDEF, /* XXX TBD */
3049 "Media region code is mismatched to logical unit region") },
3050 /* R */
3051 { SST(0x6F, 0x05, SS_RDEF, /* XXX TBD */
3052 "Drive region must be permanent/region reset count error") },
3053 /* R */
3054 { SST(0x6F, 0x06, SS_RDEF, /* XXX TBD */
3055 "Insufficient block count for binding NONCE recording") },
3056 /* R */
3057 { SST(0x6F, 0x07, SS_RDEF, /* XXX TBD */
3058 "Conflict in binding NONCE recording") },
3059 /* T */
3060 { SST(0x70, 0x00, SS_RDEF,
3061 "Decompression exception short: ASCQ = Algorithm ID") },
3062 /* T */
3063 { SST(0x70, 0xFF, SS_RDEF | SSQ_RANGE,
3064 NULL) }, /* Range 0x00 -> 0xFF */
3065 /* T */
3066 { SST(0x71, 0x00, SS_RDEF,
3067 "Decompression exception long: ASCQ = Algorithm ID") },
3068 /* T */
3069 { SST(0x71, 0xFF, SS_RDEF | SSQ_RANGE,
3070 NULL) }, /* Range 0x00 -> 0xFF */
3071 /* R */
3072 { SST(0x72, 0x00, SS_RDEF,
3073 "Session fixation error") },
3074 /* R */
3075 { SST(0x72, 0x01, SS_RDEF,
3076 "Session fixation error writing lead-in") },
3077 /* R */
3078 { SST(0x72, 0x02, SS_RDEF,
3079 "Session fixation error writing lead-out") },
3080 /* R */
3081 { SST(0x72, 0x03, SS_RDEF,
3082 "Session fixation error - incomplete track in session") },
3083 /* R */
3084 { SST(0x72, 0x04, SS_RDEF,
3085 "Empty or partially written reserved track") },
3086 /* R */
3087 { SST(0x72, 0x05, SS_RDEF, /* XXX TBD */
3088 "No more track reservations allowed") },
3089 /* R */
3090 { SST(0x72, 0x06, SS_RDEF, /* XXX TBD */
3091 "RMZ extension is not allowed") },
3092 /* R */
3093 { SST(0x72, 0x07, SS_RDEF, /* XXX TBD */
3094 "No more test zone extensions are allowed") },
3095 /* R */
3096 { SST(0x73, 0x00, SS_RDEF,
3097 "CD control error") },
3098 /* R */
3099 { SST(0x73, 0x01, SS_RDEF,
3100 "Power calibration area almost full") },
3101 /* R */
3102 { SST(0x73, 0x02, SS_FATAL | ENOSPC,
3103 "Power calibration area is full") },
3104 /* R */
3105 { SST(0x73, 0x03, SS_RDEF,
3106 "Power calibration area error") },
3107 /* R */
3108 { SST(0x73, 0x04, SS_RDEF,
3109 "Program memory area update failure") },
3110 /* R */
3111 { SST(0x73, 0x05, SS_RDEF,
3112 "Program memory area is full") },
3113 /* R */
3114 { SST(0x73, 0x06, SS_RDEF, /* XXX TBD */
3115 "RMA/PMA is almost full") },
3116 /* R */
3117 { SST(0x73, 0x10, SS_RDEF, /* XXX TBD */
3118 "Current power calibration area almost full") },
3119 /* R */
3120 { SST(0x73, 0x11, SS_RDEF, /* XXX TBD */
3121 "Current power calibration area is full") },
3122 /* R */
3123 { SST(0x73, 0x17, SS_RDEF, /* XXX TBD */
3124 "RDZ is full") },
3125 /* T */
3126 { SST(0x74, 0x00, SS_RDEF, /* XXX TBD */
3127 "Security error") },
3128 /* T */
3129 { SST(0x74, 0x01, SS_RDEF, /* XXX TBD */
3130 "Unable to decrypt data") },
3131 /* T */
3132 { SST(0x74, 0x02, SS_RDEF, /* XXX TBD */
3133 "Unencrypted data encountered while decrypting") },
3134 /* T */
3135 { SST(0x74, 0x03, SS_RDEF, /* XXX TBD */
3136 "Incorrect data encryption key") },
3137 /* T */
3138 { SST(0x74, 0x04, SS_RDEF, /* XXX TBD */
3139 "Cryptographic integrity validation failed") },
3140 /* T */
3141 { SST(0x74, 0x05, SS_RDEF, /* XXX TBD */
3142 "Error decrypting data") },
3143 /* T */
3144 { SST(0x74, 0x06, SS_RDEF, /* XXX TBD */
3145 "Unknown signature verification key") },
3146 /* T */
3147 { SST(0x74, 0x07, SS_RDEF, /* XXX TBD */
3148 "Encryption parameters not useable") },
3149 /* DT R M E VF */
3150 { SST(0x74, 0x08, SS_RDEF, /* XXX TBD */
3151 "Digital signature validation failure") },
3152 /* T */
3153 { SST(0x74, 0x09, SS_RDEF, /* XXX TBD */
3154 "Encryption mode mismatch on read") },
3155 /* T */
3156 { SST(0x74, 0x0A, SS_RDEF, /* XXX TBD */
3157 "Encrypted block not raw read enabled") },
3158 /* T */
3159 { SST(0x74, 0x0B, SS_RDEF, /* XXX TBD */
3160 "Incorrect encryption parameters") },
3161 /* DT R MAEBKV */
3162 { SST(0x74, 0x0C, SS_RDEF, /* XXX TBD */
3163 "Unable to decrypt parameter list") },
3164 /* T */
3165 { SST(0x74, 0x0D, SS_RDEF, /* XXX TBD */
3166 "Encryption algorithm disabled") },
3167 /* DT R MAEBKV */
3168 { SST(0x74, 0x10, SS_RDEF, /* XXX TBD */
3169 "SA creation parameter value invalid") },
3170 /* DT R MAEBKV */
3171 { SST(0x74, 0x11, SS_RDEF, /* XXX TBD */
3172 "SA creation parameter value rejected") },
3173 /* DT R MAEBKV */
3174 { SST(0x74, 0x12, SS_RDEF, /* XXX TBD */
3175 "Invalid SA usage") },
3176 /* T */
3177 { SST(0x74, 0x21, SS_RDEF, /* XXX TBD */
3178 "Data encryption configuration prevented") },
3179 /* DT R MAEBKV */
3180 { SST(0x74, 0x30, SS_RDEF, /* XXX TBD */
3181 "SA creation parameter not supported") },
3182 /* DT R MAEBKV */
3183 { SST(0x74, 0x40, SS_RDEF, /* XXX TBD */
3184 "Authentication failed") },
3185 /* V */
3186 { SST(0x74, 0x61, SS_RDEF, /* XXX TBD */
3187 "External data encryption key manager access error") },
3188 /* V */
3189 { SST(0x74, 0x62, SS_RDEF, /* XXX TBD */
3190 "External data encryption key manager error") },
3191 /* V */
3192 { SST(0x74, 0x63, SS_RDEF, /* XXX TBD */
3193 "External data encryption key not found") },
3194 /* V */
3195 { SST(0x74, 0x64, SS_RDEF, /* XXX TBD */
3196 "External data encryption request not authorized") },
3197 /* T */
3198 { SST(0x74, 0x6E, SS_RDEF, /* XXX TBD */
3199 "External data encryption control timeout") },
3200 /* T */
3201 { SST(0x74, 0x6F, SS_RDEF, /* XXX TBD */
3202 "External data encryption control error") },
3203 /* DT R M E V */
3204 { SST(0x74, 0x71, SS_FATAL | EACCES,
3205 "Logical unit access not authorized") },
3206 /* D */
3207 { SST(0x74, 0x79, SS_FATAL | EACCES,
3208 "Security conflict in translated device") }
3209 };
3210
3211 const u_int asc_table_size = nitems(asc_table);
3212
3213 struct asc_key
3214 {
3215 int asc;
3216 int ascq;
3217 };
3218
3219 static int
ascentrycomp(const void * key,const void * member)3220 ascentrycomp(const void *key, const void *member)
3221 {
3222 int asc;
3223 int ascq;
3224 const struct asc_table_entry *table_entry;
3225
3226 asc = ((const struct asc_key *)key)->asc;
3227 ascq = ((const struct asc_key *)key)->ascq;
3228 table_entry = (const struct asc_table_entry *)member;
3229
3230 if (asc >= table_entry->asc) {
3231
3232 if (asc > table_entry->asc)
3233 return (1);
3234
3235 if (ascq <= table_entry->ascq) {
3236 /* Check for ranges */
3237 if (ascq == table_entry->ascq
3238 || ((table_entry->action & SSQ_RANGE) != 0
3239 && ascq >= (table_entry - 1)->ascq))
3240 return (0);
3241 return (-1);
3242 }
3243 return (1);
3244 }
3245 return (-1);
3246 }
3247
3248 static int
senseentrycomp(const void * key,const void * member)3249 senseentrycomp(const void *key, const void *member)
3250 {
3251 int sense_key;
3252 const struct sense_key_table_entry *table_entry;
3253
3254 sense_key = *((const int *)key);
3255 table_entry = (const struct sense_key_table_entry *)member;
3256
3257 if (sense_key >= table_entry->sense_key) {
3258 if (sense_key == table_entry->sense_key)
3259 return (0);
3260 return (1);
3261 }
3262 return (-1);
3263 }
3264
3265 static void
fetchtableentries(int sense_key,int asc,int ascq,struct scsi_inquiry_data * inq_data,const struct sense_key_table_entry ** sense_entry,const struct asc_table_entry ** asc_entry)3266 fetchtableentries(int sense_key, int asc, int ascq,
3267 struct scsi_inquiry_data *inq_data,
3268 const struct sense_key_table_entry **sense_entry,
3269 const struct asc_table_entry **asc_entry)
3270 {
3271 caddr_t match;
3272 const struct asc_table_entry *asc_tables[2];
3273 const struct sense_key_table_entry *sense_tables[2];
3274 struct asc_key asc_ascq;
3275 size_t asc_tables_size[2];
3276 size_t sense_tables_size[2];
3277 int num_asc_tables;
3278 int num_sense_tables;
3279 int i;
3280
3281 /* Default to failure */
3282 *sense_entry = NULL;
3283 *asc_entry = NULL;
3284 match = NULL;
3285 if (inq_data != NULL)
3286 match = cam_quirkmatch((caddr_t)inq_data,
3287 (caddr_t)sense_quirk_table,
3288 sense_quirk_table_size,
3289 sizeof(*sense_quirk_table),
3290 scsi_inquiry_match);
3291
3292 if (match != NULL) {
3293 struct scsi_sense_quirk_entry *quirk;
3294
3295 quirk = (struct scsi_sense_quirk_entry *)match;
3296 asc_tables[0] = quirk->asc_info;
3297 asc_tables_size[0] = quirk->num_ascs;
3298 asc_tables[1] = asc_table;
3299 asc_tables_size[1] = asc_table_size;
3300 num_asc_tables = 2;
3301 sense_tables[0] = quirk->sense_key_info;
3302 sense_tables_size[0] = quirk->num_sense_keys;
3303 sense_tables[1] = sense_key_table;
3304 sense_tables_size[1] = nitems(sense_key_table);
3305 num_sense_tables = 2;
3306 } else {
3307 asc_tables[0] = asc_table;
3308 asc_tables_size[0] = asc_table_size;
3309 num_asc_tables = 1;
3310 sense_tables[0] = sense_key_table;
3311 sense_tables_size[0] = nitems(sense_key_table);
3312 num_sense_tables = 1;
3313 }
3314
3315 asc_ascq.asc = asc;
3316 asc_ascq.ascq = ascq;
3317 for (i = 0; i < num_asc_tables; i++) {
3318 void *found_entry;
3319
3320 found_entry = bsearch(&asc_ascq, asc_tables[i],
3321 asc_tables_size[i],
3322 sizeof(**asc_tables),
3323 ascentrycomp);
3324
3325 if (found_entry) {
3326 *asc_entry = (struct asc_table_entry *)found_entry;
3327 break;
3328 }
3329 }
3330
3331 for (i = 0; i < num_sense_tables; i++) {
3332 void *found_entry;
3333
3334 found_entry = bsearch(&sense_key, sense_tables[i],
3335 sense_tables_size[i],
3336 sizeof(**sense_tables),
3337 senseentrycomp);
3338
3339 if (found_entry) {
3340 *sense_entry =
3341 (struct sense_key_table_entry *)found_entry;
3342 break;
3343 }
3344 }
3345 }
3346
3347 void
scsi_sense_desc(int sense_key,int asc,int ascq,struct scsi_inquiry_data * inq_data,const char ** sense_key_desc,const char ** asc_desc)3348 scsi_sense_desc(int sense_key, int asc, int ascq,
3349 struct scsi_inquiry_data *inq_data,
3350 const char **sense_key_desc, const char **asc_desc)
3351 {
3352 const struct asc_table_entry *asc_entry;
3353 const struct sense_key_table_entry *sense_entry;
3354
3355 fetchtableentries(sense_key, asc, ascq,
3356 inq_data,
3357 &sense_entry,
3358 &asc_entry);
3359
3360 if (sense_entry != NULL)
3361 *sense_key_desc = sense_entry->desc;
3362 else
3363 *sense_key_desc = "Invalid Sense Key";
3364
3365 if (asc_entry != NULL)
3366 *asc_desc = asc_entry->desc;
3367 else if (asc >= 0x80 && asc <= 0xff)
3368 *asc_desc = "Vendor Specific ASC";
3369 else if (ascq >= 0x80 && ascq <= 0xff)
3370 *asc_desc = "Vendor Specific ASCQ";
3371 else
3372 *asc_desc = "Reserved ASC/ASCQ pair";
3373 }
3374
3375 /*
3376 * Given sense and device type information, return the appropriate action.
3377 * If we do not understand the specific error as identified by the ASC/ASCQ
3378 * pair, fall back on the more generic actions derived from the sense key.
3379 */
3380 scsi_sense_action
scsi_error_action(struct ccb_scsiio * csio,struct scsi_inquiry_data * inq_data,u_int32_t sense_flags)3381 scsi_error_action(struct ccb_scsiio *csio, struct scsi_inquiry_data *inq_data,
3382 u_int32_t sense_flags)
3383 {
3384 const struct asc_table_entry *asc_entry;
3385 const struct sense_key_table_entry *sense_entry;
3386 int error_code, sense_key, asc, ascq;
3387 scsi_sense_action action;
3388
3389 if (!scsi_extract_sense_ccb((union ccb *)csio,
3390 &error_code, &sense_key, &asc, &ascq)) {
3391 action = SS_RDEF;
3392 } else if ((error_code == SSD_DEFERRED_ERROR)
3393 || (error_code == SSD_DESC_DEFERRED_ERROR)) {
3394 /*
3395 * XXX dufault@FreeBSD.org
3396 * This error doesn't relate to the command associated
3397 * with this request sense. A deferred error is an error
3398 * for a command that has already returned GOOD status
3399 * (see SCSI2 8.2.14.2).
3400 *
3401 * By my reading of that section, it looks like the current
3402 * command has been cancelled, we should now clean things up
3403 * (hopefully recovering any lost data) and then retry the
3404 * current command. There are two easy choices, both wrong:
3405 *
3406 * 1. Drop through (like we had been doing), thus treating
3407 * this as if the error were for the current command and
3408 * return and stop the current command.
3409 *
3410 * 2. Issue a retry (like I made it do) thus hopefully
3411 * recovering the current transfer, and ignoring the
3412 * fact that we've dropped a command.
3413 *
3414 * These should probably be handled in a device specific
3415 * sense handler or punted back up to a user mode daemon
3416 */
3417 action = SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE;
3418 } else {
3419 fetchtableentries(sense_key, asc, ascq,
3420 inq_data,
3421 &sense_entry,
3422 &asc_entry);
3423
3424 /*
3425 * Override the 'No additional Sense' entry (0,0)
3426 * with the error action of the sense key.
3427 */
3428 if (asc_entry != NULL
3429 && (asc != 0 || ascq != 0))
3430 action = asc_entry->action;
3431 else if (sense_entry != NULL)
3432 action = sense_entry->action;
3433 else
3434 action = SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE;
3435
3436 if (sense_key == SSD_KEY_RECOVERED_ERROR) {
3437 /*
3438 * The action succeeded but the device wants
3439 * the user to know that some recovery action
3440 * was required.
3441 */
3442 action &= ~(SS_MASK|SSQ_MASK|SS_ERRMASK);
3443 action |= SS_NOP|SSQ_PRINT_SENSE;
3444 } else if (sense_key == SSD_KEY_ILLEGAL_REQUEST) {
3445 if ((sense_flags & SF_QUIET_IR) != 0)
3446 action &= ~SSQ_PRINT_SENSE;
3447 } else if (sense_key == SSD_KEY_UNIT_ATTENTION) {
3448 if ((sense_flags & SF_RETRY_UA) != 0
3449 && (action & SS_MASK) == SS_FAIL) {
3450 action &= ~(SS_MASK|SSQ_MASK);
3451 action |= SS_RETRY|SSQ_DECREMENT_COUNT|
3452 SSQ_PRINT_SENSE;
3453 }
3454 action |= SSQ_UA;
3455 }
3456 }
3457 if ((action & SS_MASK) >= SS_START &&
3458 (sense_flags & SF_NO_RECOVERY)) {
3459 action &= ~SS_MASK;
3460 action |= SS_FAIL;
3461 } else if ((action & SS_MASK) == SS_RETRY &&
3462 (sense_flags & SF_NO_RETRY)) {
3463 action &= ~SS_MASK;
3464 action |= SS_FAIL;
3465 }
3466 if ((sense_flags & SF_PRINT_ALWAYS) != 0)
3467 action |= SSQ_PRINT_SENSE;
3468 else if ((sense_flags & SF_NO_PRINT) != 0)
3469 action &= ~SSQ_PRINT_SENSE;
3470
3471 return (action);
3472 }
3473
3474 char *
scsi_cdb_string(u_int8_t * cdb_ptr,char * cdb_string,size_t len)3475 scsi_cdb_string(u_int8_t *cdb_ptr, char *cdb_string, size_t len)
3476 {
3477 struct sbuf sb;
3478 int error;
3479
3480 if (len == 0)
3481 return ("");
3482
3483 sbuf_new(&sb, cdb_string, len, SBUF_FIXEDLEN);
3484
3485 scsi_cdb_sbuf(cdb_ptr, &sb);
3486
3487 /* ENOMEM just means that the fixed buffer is full, OK to ignore */
3488 error = sbuf_finish(&sb);
3489 if (error != 0 &&
3490 #ifdef _KERNEL
3491 error != ENOMEM)
3492 #else
3493 errno != ENOMEM)
3494 #endif
3495 return ("");
3496
3497 return(sbuf_data(&sb));
3498 }
3499
3500 void
scsi_cdb_sbuf(u_int8_t * cdb_ptr,struct sbuf * sb)3501 scsi_cdb_sbuf(u_int8_t *cdb_ptr, struct sbuf *sb)
3502 {
3503 u_int8_t cdb_len;
3504 int i;
3505
3506 if (cdb_ptr == NULL)
3507 return;
3508
3509 /*
3510 * This is taken from the SCSI-3 draft spec.
3511 * (T10/1157D revision 0.3)
3512 * The top 3 bits of an opcode are the group code. The next 5 bits
3513 * are the command code.
3514 * Group 0: six byte commands
3515 * Group 1: ten byte commands
3516 * Group 2: ten byte commands
3517 * Group 3: reserved
3518 * Group 4: sixteen byte commands
3519 * Group 5: twelve byte commands
3520 * Group 6: vendor specific
3521 * Group 7: vendor specific
3522 */
3523 switch((*cdb_ptr >> 5) & 0x7) {
3524 case 0:
3525 cdb_len = 6;
3526 break;
3527 case 1:
3528 case 2:
3529 cdb_len = 10;
3530 break;
3531 case 3:
3532 case 6:
3533 case 7:
3534 /* in this case, just print out the opcode */
3535 cdb_len = 1;
3536 break;
3537 case 4:
3538 cdb_len = 16;
3539 break;
3540 case 5:
3541 cdb_len = 12;
3542 break;
3543 }
3544
3545 for (i = 0; i < cdb_len; i++)
3546 sbuf_printf(sb, "%02hhx ", cdb_ptr[i]);
3547
3548 return;
3549 }
3550
3551 const char *
scsi_status_string(struct ccb_scsiio * csio)3552 scsi_status_string(struct ccb_scsiio *csio)
3553 {
3554 switch(csio->scsi_status) {
3555 case SCSI_STATUS_OK:
3556 return("OK");
3557 case SCSI_STATUS_CHECK_COND:
3558 return("Check Condition");
3559 case SCSI_STATUS_BUSY:
3560 return("Busy");
3561 case SCSI_STATUS_INTERMED:
3562 return("Intermediate");
3563 case SCSI_STATUS_INTERMED_COND_MET:
3564 return("Intermediate-Condition Met");
3565 case SCSI_STATUS_RESERV_CONFLICT:
3566 return("Reservation Conflict");
3567 case SCSI_STATUS_CMD_TERMINATED:
3568 return("Command Terminated");
3569 case SCSI_STATUS_QUEUE_FULL:
3570 return("Queue Full");
3571 case SCSI_STATUS_ACA_ACTIVE:
3572 return("ACA Active");
3573 case SCSI_STATUS_TASK_ABORTED:
3574 return("Task Aborted");
3575 default: {
3576 static char unkstr[64];
3577 snprintf(unkstr, sizeof(unkstr), "Unknown %#x",
3578 csio->scsi_status);
3579 return(unkstr);
3580 }
3581 }
3582 }
3583
3584 /*
3585 * scsi_command_string() returns 0 for success and -1 for failure.
3586 */
3587 #ifdef _KERNEL
3588 int
scsi_command_string(struct ccb_scsiio * csio,struct sbuf * sb)3589 scsi_command_string(struct ccb_scsiio *csio, struct sbuf *sb)
3590 #else /* !_KERNEL */
3591 int
3592 scsi_command_string(struct cam_device *device, struct ccb_scsiio *csio,
3593 struct sbuf *sb)
3594 #endif /* _KERNEL/!_KERNEL */
3595 {
3596 struct scsi_inquiry_data *inq_data;
3597 #ifdef _KERNEL
3598 struct ccb_getdev *cgd;
3599 #endif /* _KERNEL */
3600
3601 #ifdef _KERNEL
3602 if ((cgd = (struct ccb_getdev*)xpt_alloc_ccb_nowait()) == NULL)
3603 return(-1);
3604 /*
3605 * Get the device information.
3606 */
3607 xpt_setup_ccb(&cgd->ccb_h,
3608 csio->ccb_h.path,
3609 CAM_PRIORITY_NORMAL);
3610 cgd->ccb_h.func_code = XPT_GDEV_TYPE;
3611 xpt_action((union ccb *)cgd);
3612
3613 /*
3614 * If the device is unconfigured, just pretend that it is a hard
3615 * drive. scsi_op_desc() needs this.
3616 */
3617 if (cgd->ccb_h.status == CAM_DEV_NOT_THERE)
3618 cgd->inq_data.device = T_DIRECT;
3619
3620 inq_data = &cgd->inq_data;
3621
3622 #else /* !_KERNEL */
3623
3624 inq_data = &device->inq_data;
3625
3626 #endif /* _KERNEL/!_KERNEL */
3627
3628 sbuf_printf(sb, "%s. CDB: ",
3629 scsi_op_desc(scsiio_cdb_ptr(csio)[0], inq_data));
3630 scsi_cdb_sbuf(scsiio_cdb_ptr(csio), sb);
3631
3632 #ifdef _KERNEL
3633 xpt_free_ccb((union ccb *)cgd);
3634 #endif
3635
3636 return(0);
3637 }
3638
3639 /*
3640 * Iterate over sense descriptors. Each descriptor is passed into iter_func().
3641 * If iter_func() returns 0, list traversal continues. If iter_func()
3642 * returns non-zero, list traversal is stopped.
3643 */
3644 void
scsi_desc_iterate(struct scsi_sense_data_desc * sense,u_int sense_len,int (* iter_func)(struct scsi_sense_data_desc * sense,u_int,struct scsi_sense_desc_header *,void *),void * arg)3645 scsi_desc_iterate(struct scsi_sense_data_desc *sense, u_int sense_len,
3646 int (*iter_func)(struct scsi_sense_data_desc *sense,
3647 u_int, struct scsi_sense_desc_header *,
3648 void *), void *arg)
3649 {
3650 int cur_pos;
3651 int desc_len;
3652
3653 /*
3654 * First make sure the extra length field is present.
3655 */
3656 if (SSD_DESC_IS_PRESENT(sense, sense_len, extra_len) == 0)
3657 return;
3658
3659 /*
3660 * The length of data actually returned may be different than the
3661 * extra_len recorded in the structure.
3662 */
3663 desc_len = sense_len -offsetof(struct scsi_sense_data_desc, sense_desc);
3664
3665 /*
3666 * Limit this further by the extra length reported, and the maximum
3667 * allowed extra length.
3668 */
3669 desc_len = MIN(desc_len, MIN(sense->extra_len, SSD_EXTRA_MAX));
3670
3671 /*
3672 * Subtract the size of the header from the descriptor length.
3673 * This is to ensure that we have at least the header left, so we
3674 * don't have to check that inside the loop. This can wind up
3675 * being a negative value.
3676 */
3677 desc_len -= sizeof(struct scsi_sense_desc_header);
3678
3679 for (cur_pos = 0; cur_pos < desc_len;) {
3680 struct scsi_sense_desc_header *header;
3681
3682 header = (struct scsi_sense_desc_header *)
3683 &sense->sense_desc[cur_pos];
3684
3685 /*
3686 * Check to make sure we have the entire descriptor. We
3687 * don't call iter_func() unless we do.
3688 *
3689 * Note that although cur_pos is at the beginning of the
3690 * descriptor, desc_len already has the header length
3691 * subtracted. So the comparison of the length in the
3692 * header (which does not include the header itself) to
3693 * desc_len - cur_pos is correct.
3694 */
3695 if (header->length > (desc_len - cur_pos))
3696 break;
3697
3698 if (iter_func(sense, sense_len, header, arg) != 0)
3699 break;
3700
3701 cur_pos += sizeof(*header) + header->length;
3702 }
3703 }
3704
3705 struct scsi_find_desc_info {
3706 uint8_t desc_type;
3707 struct scsi_sense_desc_header *header;
3708 };
3709
3710 static int
scsi_find_desc_func(struct scsi_sense_data_desc * sense,u_int sense_len,struct scsi_sense_desc_header * header,void * arg)3711 scsi_find_desc_func(struct scsi_sense_data_desc *sense, u_int sense_len,
3712 struct scsi_sense_desc_header *header, void *arg)
3713 {
3714 struct scsi_find_desc_info *desc_info;
3715
3716 desc_info = (struct scsi_find_desc_info *)arg;
3717
3718 if (header->desc_type == desc_info->desc_type) {
3719 desc_info->header = header;
3720
3721 /* We found the descriptor, tell the iterator to stop. */
3722 return (1);
3723 } else
3724 return (0);
3725 }
3726
3727 /*
3728 * Given a descriptor type, return a pointer to it if it is in the sense
3729 * data and not truncated. Avoiding truncating sense data will simplify
3730 * things significantly for the caller.
3731 */
3732 uint8_t *
scsi_find_desc(struct scsi_sense_data_desc * sense,u_int sense_len,uint8_t desc_type)3733 scsi_find_desc(struct scsi_sense_data_desc *sense, u_int sense_len,
3734 uint8_t desc_type)
3735 {
3736 struct scsi_find_desc_info desc_info;
3737
3738 desc_info.desc_type = desc_type;
3739 desc_info.header = NULL;
3740
3741 scsi_desc_iterate(sense, sense_len, scsi_find_desc_func, &desc_info);
3742
3743 return ((uint8_t *)desc_info.header);
3744 }
3745
3746 /*
3747 * Fill in SCSI descriptor sense data with the specified parameters.
3748 */
3749 static void
scsi_set_sense_data_desc_va(struct scsi_sense_data * sense_data,u_int * sense_len,scsi_sense_data_type sense_format,int current_error,int sense_key,int asc,int ascq,va_list ap)3750 scsi_set_sense_data_desc_va(struct scsi_sense_data *sense_data,
3751 u_int *sense_len, scsi_sense_data_type sense_format, int current_error,
3752 int sense_key, int asc, int ascq, va_list ap)
3753 {
3754 struct scsi_sense_data_desc *sense;
3755 scsi_sense_elem_type elem_type;
3756 int space, len;
3757 uint8_t *desc, *data;
3758
3759 memset(sense_data, 0, sizeof(*sense_data));
3760 sense = (struct scsi_sense_data_desc *)sense_data;
3761 if (current_error != 0)
3762 sense->error_code = SSD_DESC_CURRENT_ERROR;
3763 else
3764 sense->error_code = SSD_DESC_DEFERRED_ERROR;
3765 sense->sense_key = sense_key;
3766 sense->add_sense_code = asc;
3767 sense->add_sense_code_qual = ascq;
3768 sense->flags = 0;
3769
3770 desc = &sense->sense_desc[0];
3771 space = *sense_len - offsetof(struct scsi_sense_data_desc, sense_desc);
3772 while ((elem_type = va_arg(ap, scsi_sense_elem_type)) !=
3773 SSD_ELEM_NONE) {
3774 if (elem_type >= SSD_ELEM_MAX) {
3775 printf("%s: invalid sense type %d\n", __func__,
3776 elem_type);
3777 break;
3778 }
3779 len = va_arg(ap, int);
3780 data = va_arg(ap, uint8_t *);
3781
3782 switch (elem_type) {
3783 case SSD_ELEM_SKIP:
3784 break;
3785 case SSD_ELEM_DESC:
3786 if (space < len) {
3787 sense->flags |= SSDD_SDAT_OVFL;
3788 break;
3789 }
3790 bcopy(data, desc, len);
3791 desc += len;
3792 space -= len;
3793 break;
3794 case SSD_ELEM_SKS: {
3795 struct scsi_sense_sks *sks = (void *)desc;
3796
3797 if (len > sizeof(sks->sense_key_spec))
3798 break;
3799 if (space < sizeof(*sks)) {
3800 sense->flags |= SSDD_SDAT_OVFL;
3801 break;
3802 }
3803 sks->desc_type = SSD_DESC_SKS;
3804 sks->length = sizeof(*sks) -
3805 (offsetof(struct scsi_sense_sks, length) + 1);
3806 bcopy(data, &sks->sense_key_spec, len);
3807 desc += sizeof(*sks);
3808 space -= sizeof(*sks);
3809 break;
3810 }
3811 case SSD_ELEM_COMMAND: {
3812 struct scsi_sense_command *cmd = (void *)desc;
3813
3814 if (len > sizeof(cmd->command_info))
3815 break;
3816 if (space < sizeof(*cmd)) {
3817 sense->flags |= SSDD_SDAT_OVFL;
3818 break;
3819 }
3820 cmd->desc_type = SSD_DESC_COMMAND;
3821 cmd->length = sizeof(*cmd) -
3822 (offsetof(struct scsi_sense_command, length) + 1);
3823 bcopy(data, &cmd->command_info[
3824 sizeof(cmd->command_info) - len], len);
3825 desc += sizeof(*cmd);
3826 space -= sizeof(*cmd);
3827 break;
3828 }
3829 case SSD_ELEM_INFO: {
3830 struct scsi_sense_info *info = (void *)desc;
3831
3832 if (len > sizeof(info->info))
3833 break;
3834 if (space < sizeof(*info)) {
3835 sense->flags |= SSDD_SDAT_OVFL;
3836 break;
3837 }
3838 info->desc_type = SSD_DESC_INFO;
3839 info->length = sizeof(*info) -
3840 (offsetof(struct scsi_sense_info, length) + 1);
3841 info->byte2 = SSD_INFO_VALID;
3842 bcopy(data, &info->info[sizeof(info->info) - len], len);
3843 desc += sizeof(*info);
3844 space -= sizeof(*info);
3845 break;
3846 }
3847 case SSD_ELEM_FRU: {
3848 struct scsi_sense_fru *fru = (void *)desc;
3849
3850 if (len > sizeof(fru->fru))
3851 break;
3852 if (space < sizeof(*fru)) {
3853 sense->flags |= SSDD_SDAT_OVFL;
3854 break;
3855 }
3856 fru->desc_type = SSD_DESC_FRU;
3857 fru->length = sizeof(*fru) -
3858 (offsetof(struct scsi_sense_fru, length) + 1);
3859 fru->fru = *data;
3860 desc += sizeof(*fru);
3861 space -= sizeof(*fru);
3862 break;
3863 }
3864 case SSD_ELEM_STREAM: {
3865 struct scsi_sense_stream *stream = (void *)desc;
3866
3867 if (len > sizeof(stream->byte3))
3868 break;
3869 if (space < sizeof(*stream)) {
3870 sense->flags |= SSDD_SDAT_OVFL;
3871 break;
3872 }
3873 stream->desc_type = SSD_DESC_STREAM;
3874 stream->length = sizeof(*stream) -
3875 (offsetof(struct scsi_sense_stream, length) + 1);
3876 stream->byte3 = *data;
3877 desc += sizeof(*stream);
3878 space -= sizeof(*stream);
3879 break;
3880 }
3881 default:
3882 /*
3883 * We shouldn't get here, but if we do, do nothing.
3884 * We've already consumed the arguments above.
3885 */
3886 break;
3887 }
3888 }
3889 sense->extra_len = desc - &sense->sense_desc[0];
3890 *sense_len = offsetof(struct scsi_sense_data_desc, extra_len) + 1 +
3891 sense->extra_len;
3892 }
3893
3894 /*
3895 * Fill in SCSI fixed sense data with the specified parameters.
3896 */
3897 static void
scsi_set_sense_data_fixed_va(struct scsi_sense_data * sense_data,u_int * sense_len,scsi_sense_data_type sense_format,int current_error,int sense_key,int asc,int ascq,va_list ap)3898 scsi_set_sense_data_fixed_va(struct scsi_sense_data *sense_data,
3899 u_int *sense_len, scsi_sense_data_type sense_format, int current_error,
3900 int sense_key, int asc, int ascq, va_list ap)
3901 {
3902 struct scsi_sense_data_fixed *sense;
3903 scsi_sense_elem_type elem_type;
3904 uint8_t *data;
3905 int len;
3906
3907 memset(sense_data, 0, sizeof(*sense_data));
3908 sense = (struct scsi_sense_data_fixed *)sense_data;
3909 if (current_error != 0)
3910 sense->error_code = SSD_CURRENT_ERROR;
3911 else
3912 sense->error_code = SSD_DEFERRED_ERROR;
3913 sense->flags = sense_key & SSD_KEY;
3914 sense->extra_len = 0;
3915 if (*sense_len >= 13) {
3916 sense->add_sense_code = asc;
3917 sense->extra_len = MAX(sense->extra_len, 5);
3918 } else
3919 sense->flags |= SSD_SDAT_OVFL;
3920 if (*sense_len >= 14) {
3921 sense->add_sense_code_qual = ascq;
3922 sense->extra_len = MAX(sense->extra_len, 6);
3923 } else
3924 sense->flags |= SSD_SDAT_OVFL;
3925
3926 while ((elem_type = va_arg(ap, scsi_sense_elem_type)) !=
3927 SSD_ELEM_NONE) {
3928 if (elem_type >= SSD_ELEM_MAX) {
3929 printf("%s: invalid sense type %d\n", __func__,
3930 elem_type);
3931 break;
3932 }
3933 len = va_arg(ap, int);
3934 data = va_arg(ap, uint8_t *);
3935
3936 switch (elem_type) {
3937 case SSD_ELEM_SKIP:
3938 break;
3939 case SSD_ELEM_SKS:
3940 if (len > sizeof(sense->sense_key_spec))
3941 break;
3942 if (*sense_len < 18) {
3943 sense->flags |= SSD_SDAT_OVFL;
3944 break;
3945 }
3946 bcopy(data, &sense->sense_key_spec[0], len);
3947 sense->extra_len = MAX(sense->extra_len, 10);
3948 break;
3949 case SSD_ELEM_COMMAND:
3950 if (*sense_len < 12) {
3951 sense->flags |= SSD_SDAT_OVFL;
3952 break;
3953 }
3954 if (len > sizeof(sense->cmd_spec_info)) {
3955 data += len - sizeof(sense->cmd_spec_info);
3956 len = sizeof(sense->cmd_spec_info);
3957 }
3958 bcopy(data, &sense->cmd_spec_info[
3959 sizeof(sense->cmd_spec_info) - len], len);
3960 sense->extra_len = MAX(sense->extra_len, 4);
3961 break;
3962 case SSD_ELEM_INFO:
3963 /* Set VALID bit only if no overflow. */
3964 sense->error_code |= SSD_ERRCODE_VALID;
3965 while (len > sizeof(sense->info)) {
3966 if (data[0] != 0)
3967 sense->error_code &= ~SSD_ERRCODE_VALID;
3968 data ++;
3969 len --;
3970 }
3971 bcopy(data, &sense->info[sizeof(sense->info) - len], len);
3972 break;
3973 case SSD_ELEM_FRU:
3974 if (*sense_len < 15) {
3975 sense->flags |= SSD_SDAT_OVFL;
3976 break;
3977 }
3978 sense->fru = *data;
3979 sense->extra_len = MAX(sense->extra_len, 7);
3980 break;
3981 case SSD_ELEM_STREAM:
3982 sense->flags |= *data &
3983 (SSD_ILI | SSD_EOM | SSD_FILEMARK);
3984 break;
3985 default:
3986
3987 /*
3988 * We can't handle that in fixed format. Skip it.
3989 */
3990 break;
3991 }
3992 }
3993 *sense_len = offsetof(struct scsi_sense_data_fixed, extra_len) + 1 +
3994 sense->extra_len;
3995 }
3996
3997 /*
3998 * Fill in SCSI sense data with the specified parameters. This routine can
3999 * fill in either fixed or descriptor type sense data.
4000 */
4001 void
scsi_set_sense_data_va(struct scsi_sense_data * sense_data,u_int * sense_len,scsi_sense_data_type sense_format,int current_error,int sense_key,int asc,int ascq,va_list ap)4002 scsi_set_sense_data_va(struct scsi_sense_data *sense_data, u_int *sense_len,
4003 scsi_sense_data_type sense_format, int current_error,
4004 int sense_key, int asc, int ascq, va_list ap)
4005 {
4006
4007 if (*sense_len > SSD_FULL_SIZE)
4008 *sense_len = SSD_FULL_SIZE;
4009 if (sense_format == SSD_TYPE_DESC)
4010 scsi_set_sense_data_desc_va(sense_data, sense_len,
4011 sense_format, current_error, sense_key, asc, ascq, ap);
4012 else
4013 scsi_set_sense_data_fixed_va(sense_data, sense_len,
4014 sense_format, current_error, sense_key, asc, ascq, ap);
4015 }
4016
4017 void
scsi_set_sense_data(struct scsi_sense_data * sense_data,scsi_sense_data_type sense_format,int current_error,int sense_key,int asc,int ascq,...)4018 scsi_set_sense_data(struct scsi_sense_data *sense_data,
4019 scsi_sense_data_type sense_format, int current_error,
4020 int sense_key, int asc, int ascq, ...)
4021 {
4022 va_list ap;
4023 u_int sense_len = SSD_FULL_SIZE;
4024
4025 va_start(ap, ascq);
4026 scsi_set_sense_data_va(sense_data, &sense_len, sense_format,
4027 current_error, sense_key, asc, ascq, ap);
4028 va_end(ap);
4029 }
4030
4031 void
scsi_set_sense_data_len(struct scsi_sense_data * sense_data,u_int * sense_len,scsi_sense_data_type sense_format,int current_error,int sense_key,int asc,int ascq,...)4032 scsi_set_sense_data_len(struct scsi_sense_data *sense_data, u_int *sense_len,
4033 scsi_sense_data_type sense_format, int current_error,
4034 int sense_key, int asc, int ascq, ...)
4035 {
4036 va_list ap;
4037
4038 va_start(ap, ascq);
4039 scsi_set_sense_data_va(sense_data, sense_len, sense_format,
4040 current_error, sense_key, asc, ascq, ap);
4041 va_end(ap);
4042 }
4043
4044 /*
4045 * Get sense information for three similar sense data types.
4046 */
4047 int
scsi_get_sense_info(struct scsi_sense_data * sense_data,u_int sense_len,uint8_t info_type,uint64_t * info,int64_t * signed_info)4048 scsi_get_sense_info(struct scsi_sense_data *sense_data, u_int sense_len,
4049 uint8_t info_type, uint64_t *info, int64_t *signed_info)
4050 {
4051 scsi_sense_data_type sense_type;
4052
4053 if (sense_len == 0)
4054 goto bailout;
4055
4056 sense_type = scsi_sense_type(sense_data);
4057
4058 switch (sense_type) {
4059 case SSD_TYPE_DESC: {
4060 struct scsi_sense_data_desc *sense;
4061 uint8_t *desc;
4062
4063 sense = (struct scsi_sense_data_desc *)sense_data;
4064
4065 desc = scsi_find_desc(sense, sense_len, info_type);
4066 if (desc == NULL)
4067 goto bailout;
4068
4069 switch (info_type) {
4070 case SSD_DESC_INFO: {
4071 struct scsi_sense_info *info_desc;
4072
4073 info_desc = (struct scsi_sense_info *)desc;
4074
4075 if ((info_desc->byte2 & SSD_INFO_VALID) == 0)
4076 goto bailout;
4077
4078 *info = scsi_8btou64(info_desc->info);
4079 if (signed_info != NULL)
4080 *signed_info = *info;
4081 break;
4082 }
4083 case SSD_DESC_COMMAND: {
4084 struct scsi_sense_command *cmd_desc;
4085
4086 cmd_desc = (struct scsi_sense_command *)desc;
4087
4088 *info = scsi_8btou64(cmd_desc->command_info);
4089 if (signed_info != NULL)
4090 *signed_info = *info;
4091 break;
4092 }
4093 case SSD_DESC_FRU: {
4094 struct scsi_sense_fru *fru_desc;
4095
4096 fru_desc = (struct scsi_sense_fru *)desc;
4097
4098 if (fru_desc->fru == 0)
4099 goto bailout;
4100
4101 *info = fru_desc->fru;
4102 if (signed_info != NULL)
4103 *signed_info = (int8_t)fru_desc->fru;
4104 break;
4105 }
4106 default:
4107 goto bailout;
4108 break;
4109 }
4110 break;
4111 }
4112 case SSD_TYPE_FIXED: {
4113 struct scsi_sense_data_fixed *sense;
4114
4115 sense = (struct scsi_sense_data_fixed *)sense_data;
4116
4117 switch (info_type) {
4118 case SSD_DESC_INFO: {
4119 uint32_t info_val;
4120
4121 if ((sense->error_code & SSD_ERRCODE_VALID) == 0)
4122 goto bailout;
4123
4124 if (SSD_FIXED_IS_PRESENT(sense, sense_len, info) == 0)
4125 goto bailout;
4126
4127 info_val = scsi_4btoul(sense->info);
4128
4129 *info = info_val;
4130 if (signed_info != NULL)
4131 *signed_info = (int32_t)info_val;
4132 break;
4133 }
4134 case SSD_DESC_COMMAND: {
4135 uint32_t cmd_val;
4136
4137 if ((SSD_FIXED_IS_PRESENT(sense, sense_len,
4138 cmd_spec_info) == 0)
4139 || (SSD_FIXED_IS_FILLED(sense, cmd_spec_info) == 0))
4140 goto bailout;
4141
4142 cmd_val = scsi_4btoul(sense->cmd_spec_info);
4143 if (cmd_val == 0)
4144 goto bailout;
4145
4146 *info = cmd_val;
4147 if (signed_info != NULL)
4148 *signed_info = (int32_t)cmd_val;
4149 break;
4150 }
4151 case SSD_DESC_FRU:
4152 if ((SSD_FIXED_IS_PRESENT(sense, sense_len, fru) == 0)
4153 || (SSD_FIXED_IS_FILLED(sense, fru) == 0))
4154 goto bailout;
4155
4156 if (sense->fru == 0)
4157 goto bailout;
4158
4159 *info = sense->fru;
4160 if (signed_info != NULL)
4161 *signed_info = (int8_t)sense->fru;
4162 break;
4163 default:
4164 goto bailout;
4165 break;
4166 }
4167 break;
4168 }
4169 default:
4170 goto bailout;
4171 break;
4172 }
4173
4174 return (0);
4175 bailout:
4176 return (1);
4177 }
4178
4179 int
scsi_get_sks(struct scsi_sense_data * sense_data,u_int sense_len,uint8_t * sks)4180 scsi_get_sks(struct scsi_sense_data *sense_data, u_int sense_len, uint8_t *sks)
4181 {
4182 scsi_sense_data_type sense_type;
4183
4184 if (sense_len == 0)
4185 goto bailout;
4186
4187 sense_type = scsi_sense_type(sense_data);
4188
4189 switch (sense_type) {
4190 case SSD_TYPE_DESC: {
4191 struct scsi_sense_data_desc *sense;
4192 struct scsi_sense_sks *desc;
4193
4194 sense = (struct scsi_sense_data_desc *)sense_data;
4195
4196 desc = (struct scsi_sense_sks *)scsi_find_desc(sense, sense_len,
4197 SSD_DESC_SKS);
4198 if (desc == NULL)
4199 goto bailout;
4200
4201 if ((desc->sense_key_spec[0] & SSD_SKS_VALID) == 0)
4202 goto bailout;
4203
4204 bcopy(desc->sense_key_spec, sks, sizeof(desc->sense_key_spec));
4205 break;
4206 }
4207 case SSD_TYPE_FIXED: {
4208 struct scsi_sense_data_fixed *sense;
4209
4210 sense = (struct scsi_sense_data_fixed *)sense_data;
4211
4212 if ((SSD_FIXED_IS_PRESENT(sense, sense_len, sense_key_spec)== 0)
4213 || (SSD_FIXED_IS_FILLED(sense, sense_key_spec) == 0))
4214 goto bailout;
4215
4216 if ((sense->sense_key_spec[0] & SSD_SCS_VALID) == 0)
4217 goto bailout;
4218
4219 bcopy(sense->sense_key_spec, sks,sizeof(sense->sense_key_spec));
4220 break;
4221 }
4222 default:
4223 goto bailout;
4224 break;
4225 }
4226 return (0);
4227 bailout:
4228 return (1);
4229 }
4230
4231 /*
4232 * Provide a common interface for fixed and descriptor sense to detect
4233 * whether we have block-specific sense information. It is clear by the
4234 * presence of the block descriptor in descriptor mode, but we have to
4235 * infer from the inquiry data and ILI bit in fixed mode.
4236 */
4237 int
scsi_get_block_info(struct scsi_sense_data * sense_data,u_int sense_len,struct scsi_inquiry_data * inq_data,uint8_t * block_bits)4238 scsi_get_block_info(struct scsi_sense_data *sense_data, u_int sense_len,
4239 struct scsi_inquiry_data *inq_data, uint8_t *block_bits)
4240 {
4241 scsi_sense_data_type sense_type;
4242
4243 if (inq_data != NULL) {
4244 switch (SID_TYPE(inq_data)) {
4245 case T_DIRECT:
4246 case T_RBC:
4247 case T_ZBC_HM:
4248 break;
4249 default:
4250 goto bailout;
4251 break;
4252 }
4253 }
4254
4255 sense_type = scsi_sense_type(sense_data);
4256
4257 switch (sense_type) {
4258 case SSD_TYPE_DESC: {
4259 struct scsi_sense_data_desc *sense;
4260 struct scsi_sense_block *block;
4261
4262 sense = (struct scsi_sense_data_desc *)sense_data;
4263
4264 block = (struct scsi_sense_block *)scsi_find_desc(sense,
4265 sense_len, SSD_DESC_BLOCK);
4266 if (block == NULL)
4267 goto bailout;
4268
4269 *block_bits = block->byte3;
4270 break;
4271 }
4272 case SSD_TYPE_FIXED: {
4273 struct scsi_sense_data_fixed *sense;
4274
4275 sense = (struct scsi_sense_data_fixed *)sense_data;
4276
4277 if (SSD_FIXED_IS_PRESENT(sense, sense_len, flags) == 0)
4278 goto bailout;
4279
4280 *block_bits = sense->flags & SSD_ILI;
4281 break;
4282 }
4283 default:
4284 goto bailout;
4285 break;
4286 }
4287 return (0);
4288 bailout:
4289 return (1);
4290 }
4291
4292 int
scsi_get_stream_info(struct scsi_sense_data * sense_data,u_int sense_len,struct scsi_inquiry_data * inq_data,uint8_t * stream_bits)4293 scsi_get_stream_info(struct scsi_sense_data *sense_data, u_int sense_len,
4294 struct scsi_inquiry_data *inq_data, uint8_t *stream_bits)
4295 {
4296 scsi_sense_data_type sense_type;
4297
4298 if (inq_data != NULL) {
4299 switch (SID_TYPE(inq_data)) {
4300 case T_SEQUENTIAL:
4301 break;
4302 default:
4303 goto bailout;
4304 break;
4305 }
4306 }
4307
4308 sense_type = scsi_sense_type(sense_data);
4309
4310 switch (sense_type) {
4311 case SSD_TYPE_DESC: {
4312 struct scsi_sense_data_desc *sense;
4313 struct scsi_sense_stream *stream;
4314
4315 sense = (struct scsi_sense_data_desc *)sense_data;
4316
4317 stream = (struct scsi_sense_stream *)scsi_find_desc(sense,
4318 sense_len, SSD_DESC_STREAM);
4319 if (stream == NULL)
4320 goto bailout;
4321
4322 *stream_bits = stream->byte3;
4323 break;
4324 }
4325 case SSD_TYPE_FIXED: {
4326 struct scsi_sense_data_fixed *sense;
4327
4328 sense = (struct scsi_sense_data_fixed *)sense_data;
4329
4330 if (SSD_FIXED_IS_PRESENT(sense, sense_len, flags) == 0)
4331 goto bailout;
4332
4333 *stream_bits = sense->flags & (SSD_ILI|SSD_EOM|SSD_FILEMARK);
4334 break;
4335 }
4336 default:
4337 goto bailout;
4338 break;
4339 }
4340 return (0);
4341 bailout:
4342 return (1);
4343 }
4344
4345 void
scsi_info_sbuf(struct sbuf * sb,uint8_t * cdb,int cdb_len,struct scsi_inquiry_data * inq_data,uint64_t info)4346 scsi_info_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len,
4347 struct scsi_inquiry_data *inq_data, uint64_t info)
4348 {
4349 sbuf_printf(sb, "Info: %#jx", info);
4350 }
4351
4352 void
scsi_command_sbuf(struct sbuf * sb,uint8_t * cdb,int cdb_len,struct scsi_inquiry_data * inq_data,uint64_t csi)4353 scsi_command_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len,
4354 struct scsi_inquiry_data *inq_data, uint64_t csi)
4355 {
4356 sbuf_printf(sb, "Command Specific Info: %#jx", csi);
4357 }
4358
4359
4360 void
scsi_progress_sbuf(struct sbuf * sb,uint16_t progress)4361 scsi_progress_sbuf(struct sbuf *sb, uint16_t progress)
4362 {
4363 sbuf_printf(sb, "Progress: %d%% (%d/%d) complete",
4364 (progress * 100) / SSD_SKS_PROGRESS_DENOM,
4365 progress, SSD_SKS_PROGRESS_DENOM);
4366 }
4367
4368 /*
4369 * Returns 1 for failure (i.e. SKS isn't valid) and 0 for success.
4370 */
4371 int
scsi_sks_sbuf(struct sbuf * sb,int sense_key,uint8_t * sks)4372 scsi_sks_sbuf(struct sbuf *sb, int sense_key, uint8_t *sks)
4373 {
4374
4375 switch (sense_key) {
4376 case SSD_KEY_ILLEGAL_REQUEST: {
4377 struct scsi_sense_sks_field *field;
4378 int bad_command;
4379 char tmpstr[40];
4380
4381 /*Field Pointer*/
4382 field = (struct scsi_sense_sks_field *)sks;
4383
4384 if (field->byte0 & SSD_SKS_FIELD_CMD)
4385 bad_command = 1;
4386 else
4387 bad_command = 0;
4388
4389 tmpstr[0] = '\0';
4390
4391 /* Bit pointer is valid */
4392 if (field->byte0 & SSD_SKS_BPV)
4393 snprintf(tmpstr, sizeof(tmpstr), "bit %d ",
4394 field->byte0 & SSD_SKS_BIT_VALUE);
4395
4396 sbuf_printf(sb, "%s byte %d %sis invalid",
4397 bad_command ? "Command" : "Data",
4398 scsi_2btoul(field->field), tmpstr);
4399 break;
4400 }
4401 case SSD_KEY_UNIT_ATTENTION: {
4402 struct scsi_sense_sks_overflow *overflow;
4403
4404 overflow = (struct scsi_sense_sks_overflow *)sks;
4405
4406 /*UA Condition Queue Overflow*/
4407 sbuf_printf(sb, "Unit Attention Condition Queue %s",
4408 (overflow->byte0 & SSD_SKS_OVERFLOW_SET) ?
4409 "Overflowed" : "Did Not Overflow??");
4410 break;
4411 }
4412 case SSD_KEY_RECOVERED_ERROR:
4413 case SSD_KEY_HARDWARE_ERROR:
4414 case SSD_KEY_MEDIUM_ERROR: {
4415 struct scsi_sense_sks_retry *retry;
4416
4417 /*Actual Retry Count*/
4418 retry = (struct scsi_sense_sks_retry *)sks;
4419
4420 sbuf_printf(sb, "Actual Retry Count: %d",
4421 scsi_2btoul(retry->actual_retry_count));
4422 break;
4423 }
4424 case SSD_KEY_NO_SENSE:
4425 case SSD_KEY_NOT_READY: {
4426 struct scsi_sense_sks_progress *progress;
4427 int progress_val;
4428
4429 /*Progress Indication*/
4430 progress = (struct scsi_sense_sks_progress *)sks;
4431 progress_val = scsi_2btoul(progress->progress);
4432
4433 scsi_progress_sbuf(sb, progress_val);
4434 break;
4435 }
4436 case SSD_KEY_COPY_ABORTED: {
4437 struct scsi_sense_sks_segment *segment;
4438 char tmpstr[40];
4439
4440 /*Segment Pointer*/
4441 segment = (struct scsi_sense_sks_segment *)sks;
4442
4443 tmpstr[0] = '\0';
4444
4445 if (segment->byte0 & SSD_SKS_SEGMENT_BPV)
4446 snprintf(tmpstr, sizeof(tmpstr), "bit %d ",
4447 segment->byte0 & SSD_SKS_SEGMENT_BITPTR);
4448
4449 sbuf_printf(sb, "%s byte %d %sis invalid", (segment->byte0 &
4450 SSD_SKS_SEGMENT_SD) ? "Segment" : "Data",
4451 scsi_2btoul(segment->field), tmpstr);
4452 break;
4453 }
4454 default:
4455 sbuf_printf(sb, "Sense Key Specific: %#x,%#x", sks[0],
4456 scsi_2btoul(&sks[1]));
4457 break;
4458 }
4459
4460 return (0);
4461 }
4462
4463 void
scsi_fru_sbuf(struct sbuf * sb,uint64_t fru)4464 scsi_fru_sbuf(struct sbuf *sb, uint64_t fru)
4465 {
4466 sbuf_printf(sb, "Field Replaceable Unit: %d", (int)fru);
4467 }
4468
4469 void
scsi_stream_sbuf(struct sbuf * sb,uint8_t stream_bits)4470 scsi_stream_sbuf(struct sbuf *sb, uint8_t stream_bits)
4471 {
4472 int need_comma;
4473
4474 need_comma = 0;
4475 /*
4476 * XXX KDM this needs more descriptive decoding.
4477 */
4478 sbuf_printf(sb, "Stream Command Sense Data: ");
4479 if (stream_bits & SSD_DESC_STREAM_FM) {
4480 sbuf_printf(sb, "Filemark");
4481 need_comma = 1;
4482 }
4483
4484 if (stream_bits & SSD_DESC_STREAM_EOM) {
4485 sbuf_printf(sb, "%sEOM", (need_comma) ? "," : "");
4486 need_comma = 1;
4487 }
4488
4489 if (stream_bits & SSD_DESC_STREAM_ILI)
4490 sbuf_printf(sb, "%sILI", (need_comma) ? "," : "");
4491 }
4492
4493 void
scsi_block_sbuf(struct sbuf * sb,uint8_t block_bits)4494 scsi_block_sbuf(struct sbuf *sb, uint8_t block_bits)
4495 {
4496
4497 sbuf_printf(sb, "Block Command Sense Data: ");
4498 if (block_bits & SSD_DESC_BLOCK_ILI)
4499 sbuf_printf(sb, "ILI");
4500 }
4501
4502 void
scsi_sense_info_sbuf(struct sbuf * sb,struct scsi_sense_data * sense,u_int sense_len,uint8_t * cdb,int cdb_len,struct scsi_inquiry_data * inq_data,struct scsi_sense_desc_header * header)4503 scsi_sense_info_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
4504 u_int sense_len, uint8_t *cdb, int cdb_len,
4505 struct scsi_inquiry_data *inq_data,
4506 struct scsi_sense_desc_header *header)
4507 {
4508 struct scsi_sense_info *info;
4509
4510 info = (struct scsi_sense_info *)header;
4511
4512 if ((info->byte2 & SSD_INFO_VALID) == 0)
4513 return;
4514
4515 scsi_info_sbuf(sb, cdb, cdb_len, inq_data, scsi_8btou64(info->info));
4516 }
4517
4518 void
scsi_sense_command_sbuf(struct sbuf * sb,struct scsi_sense_data * sense,u_int sense_len,uint8_t * cdb,int cdb_len,struct scsi_inquiry_data * inq_data,struct scsi_sense_desc_header * header)4519 scsi_sense_command_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
4520 u_int sense_len, uint8_t *cdb, int cdb_len,
4521 struct scsi_inquiry_data *inq_data,
4522 struct scsi_sense_desc_header *header)
4523 {
4524 struct scsi_sense_command *command;
4525
4526 command = (struct scsi_sense_command *)header;
4527
4528 scsi_command_sbuf(sb, cdb, cdb_len, inq_data,
4529 scsi_8btou64(command->command_info));
4530 }
4531
4532 void
scsi_sense_sks_sbuf(struct sbuf * sb,struct scsi_sense_data * sense,u_int sense_len,uint8_t * cdb,int cdb_len,struct scsi_inquiry_data * inq_data,struct scsi_sense_desc_header * header)4533 scsi_sense_sks_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
4534 u_int sense_len, uint8_t *cdb, int cdb_len,
4535 struct scsi_inquiry_data *inq_data,
4536 struct scsi_sense_desc_header *header)
4537 {
4538 struct scsi_sense_sks *sks;
4539 int error_code, sense_key, asc, ascq;
4540
4541 sks = (struct scsi_sense_sks *)header;
4542
4543 if ((sks->sense_key_spec[0] & SSD_SKS_VALID) == 0)
4544 return;
4545
4546 scsi_extract_sense_len(sense, sense_len, &error_code, &sense_key,
4547 &asc, &ascq, /*show_errors*/ 1);
4548
4549 scsi_sks_sbuf(sb, sense_key, sks->sense_key_spec);
4550 }
4551
4552 void
scsi_sense_fru_sbuf(struct sbuf * sb,struct scsi_sense_data * sense,u_int sense_len,uint8_t * cdb,int cdb_len,struct scsi_inquiry_data * inq_data,struct scsi_sense_desc_header * header)4553 scsi_sense_fru_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
4554 u_int sense_len, uint8_t *cdb, int cdb_len,
4555 struct scsi_inquiry_data *inq_data,
4556 struct scsi_sense_desc_header *header)
4557 {
4558 struct scsi_sense_fru *fru;
4559
4560 fru = (struct scsi_sense_fru *)header;
4561
4562 if (fru->fru == 0)
4563 return;
4564
4565 scsi_fru_sbuf(sb, (uint64_t)fru->fru);
4566 }
4567
4568 void
scsi_sense_stream_sbuf(struct sbuf * sb,struct scsi_sense_data * sense,u_int sense_len,uint8_t * cdb,int cdb_len,struct scsi_inquiry_data * inq_data,struct scsi_sense_desc_header * header)4569 scsi_sense_stream_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
4570 u_int sense_len, uint8_t *cdb, int cdb_len,
4571 struct scsi_inquiry_data *inq_data,
4572 struct scsi_sense_desc_header *header)
4573 {
4574 struct scsi_sense_stream *stream;
4575
4576 stream = (struct scsi_sense_stream *)header;
4577 scsi_stream_sbuf(sb, stream->byte3);
4578 }
4579
4580 void
scsi_sense_block_sbuf(struct sbuf * sb,struct scsi_sense_data * sense,u_int sense_len,uint8_t * cdb,int cdb_len,struct scsi_inquiry_data * inq_data,struct scsi_sense_desc_header * header)4581 scsi_sense_block_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
4582 u_int sense_len, uint8_t *cdb, int cdb_len,
4583 struct scsi_inquiry_data *inq_data,
4584 struct scsi_sense_desc_header *header)
4585 {
4586 struct scsi_sense_block *block;
4587
4588 block = (struct scsi_sense_block *)header;
4589 scsi_block_sbuf(sb, block->byte3);
4590 }
4591
4592 void
scsi_sense_progress_sbuf(struct sbuf * sb,struct scsi_sense_data * sense,u_int sense_len,uint8_t * cdb,int cdb_len,struct scsi_inquiry_data * inq_data,struct scsi_sense_desc_header * header)4593 scsi_sense_progress_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
4594 u_int sense_len, uint8_t *cdb, int cdb_len,
4595 struct scsi_inquiry_data *inq_data,
4596 struct scsi_sense_desc_header *header)
4597 {
4598 struct scsi_sense_progress *progress;
4599 const char *sense_key_desc;
4600 const char *asc_desc;
4601 int progress_val;
4602
4603 progress = (struct scsi_sense_progress *)header;
4604
4605 /*
4606 * Get descriptions for the sense key, ASC, and ASCQ in the
4607 * progress descriptor. These could be different than the values
4608 * in the overall sense data.
4609 */
4610 scsi_sense_desc(progress->sense_key, progress->add_sense_code,
4611 progress->add_sense_code_qual, inq_data,
4612 &sense_key_desc, &asc_desc);
4613
4614 progress_val = scsi_2btoul(progress->progress);
4615
4616 /*
4617 * The progress indicator is for the operation described by the
4618 * sense key, ASC, and ASCQ in the descriptor.
4619 */
4620 sbuf_cat(sb, sense_key_desc);
4621 sbuf_printf(sb, " asc:%x,%x (%s): ", progress->add_sense_code,
4622 progress->add_sense_code_qual, asc_desc);
4623 scsi_progress_sbuf(sb, progress_val);
4624 }
4625
4626 void
scsi_sense_ata_sbuf(struct sbuf * sb,struct scsi_sense_data * sense,u_int sense_len,uint8_t * cdb,int cdb_len,struct scsi_inquiry_data * inq_data,struct scsi_sense_desc_header * header)4627 scsi_sense_ata_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
4628 u_int sense_len, uint8_t *cdb, int cdb_len,
4629 struct scsi_inquiry_data *inq_data,
4630 struct scsi_sense_desc_header *header)
4631 {
4632 struct scsi_sense_ata_ret_desc *res;
4633
4634 res = (struct scsi_sense_ata_ret_desc *)header;
4635
4636 sbuf_printf(sb, "ATA status: %02x (%s%s%s%s%s%s%s%s), ",
4637 res->status,
4638 (res->status & 0x80) ? "BSY " : "",
4639 (res->status & 0x40) ? "DRDY " : "",
4640 (res->status & 0x20) ? "DF " : "",
4641 (res->status & 0x10) ? "SERV " : "",
4642 (res->status & 0x08) ? "DRQ " : "",
4643 (res->status & 0x04) ? "CORR " : "",
4644 (res->status & 0x02) ? "IDX " : "",
4645 (res->status & 0x01) ? "ERR" : "");
4646 if (res->status & 1) {
4647 sbuf_printf(sb, "error: %02x (%s%s%s%s%s%s%s%s), ",
4648 res->error,
4649 (res->error & 0x80) ? "ICRC " : "",
4650 (res->error & 0x40) ? "UNC " : "",
4651 (res->error & 0x20) ? "MC " : "",
4652 (res->error & 0x10) ? "IDNF " : "",
4653 (res->error & 0x08) ? "MCR " : "",
4654 (res->error & 0x04) ? "ABRT " : "",
4655 (res->error & 0x02) ? "NM " : "",
4656 (res->error & 0x01) ? "ILI" : "");
4657 }
4658
4659 if (res->flags & SSD_DESC_ATA_FLAG_EXTEND) {
4660 sbuf_printf(sb, "count: %02x%02x, ",
4661 res->count_15_8, res->count_7_0);
4662 sbuf_printf(sb, "LBA: %02x%02x%02x%02x%02x%02x, ",
4663 res->lba_47_40, res->lba_39_32, res->lba_31_24,
4664 res->lba_23_16, res->lba_15_8, res->lba_7_0);
4665 } else {
4666 sbuf_printf(sb, "count: %02x, ", res->count_7_0);
4667 sbuf_printf(sb, "LBA: %02x%02x%02x, ",
4668 res->lba_23_16, res->lba_15_8, res->lba_7_0);
4669 }
4670 sbuf_printf(sb, "device: %02x, ", res->device);
4671 }
4672
4673 void
scsi_sense_forwarded_sbuf(struct sbuf * sb,struct scsi_sense_data * sense,u_int sense_len,uint8_t * cdb,int cdb_len,struct scsi_inquiry_data * inq_data,struct scsi_sense_desc_header * header)4674 scsi_sense_forwarded_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
4675 u_int sense_len, uint8_t *cdb, int cdb_len,
4676 struct scsi_inquiry_data *inq_data,
4677 struct scsi_sense_desc_header *header)
4678 {
4679 struct scsi_sense_forwarded *forwarded;
4680 const char *sense_key_desc;
4681 const char *asc_desc;
4682 int error_code, sense_key, asc, ascq;
4683
4684 forwarded = (struct scsi_sense_forwarded *)header;
4685 scsi_extract_sense_len((struct scsi_sense_data *)forwarded->sense_data,
4686 forwarded->length - 2, &error_code, &sense_key, &asc, &ascq, 1);
4687 scsi_sense_desc(sense_key, asc, ascq, NULL, &sense_key_desc, &asc_desc);
4688
4689 sbuf_printf(sb, "Forwarded sense: %s asc:%x,%x (%s): ",
4690 sense_key_desc, asc, ascq, asc_desc);
4691 }
4692
4693 /*
4694 * Generic sense descriptor printing routine. This is used when we have
4695 * not yet implemented a specific printing routine for this descriptor.
4696 */
4697 void
scsi_sense_generic_sbuf(struct sbuf * sb,struct scsi_sense_data * sense,u_int sense_len,uint8_t * cdb,int cdb_len,struct scsi_inquiry_data * inq_data,struct scsi_sense_desc_header * header)4698 scsi_sense_generic_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
4699 u_int sense_len, uint8_t *cdb, int cdb_len,
4700 struct scsi_inquiry_data *inq_data,
4701 struct scsi_sense_desc_header *header)
4702 {
4703 int i;
4704 uint8_t *buf_ptr;
4705
4706 sbuf_printf(sb, "Descriptor %#x:", header->desc_type);
4707
4708 buf_ptr = (uint8_t *)&header[1];
4709
4710 for (i = 0; i < header->length; i++, buf_ptr++)
4711 sbuf_printf(sb, " %02x", *buf_ptr);
4712 }
4713
4714 /*
4715 * Keep this list in numeric order. This speeds the array traversal.
4716 */
4717 struct scsi_sense_desc_printer {
4718 uint8_t desc_type;
4719 /*
4720 * The function arguments here are the superset of what is needed
4721 * to print out various different descriptors. Command and
4722 * information descriptors need inquiry data and command type.
4723 * Sense key specific descriptors need the sense key.
4724 *
4725 * The sense, cdb, and inquiry data arguments may be NULL, but the
4726 * information printed may not be fully decoded as a result.
4727 */
4728 void (*print_func)(struct sbuf *sb, struct scsi_sense_data *sense,
4729 u_int sense_len, uint8_t *cdb, int cdb_len,
4730 struct scsi_inquiry_data *inq_data,
4731 struct scsi_sense_desc_header *header);
4732 } scsi_sense_printers[] = {
4733 {SSD_DESC_INFO, scsi_sense_info_sbuf},
4734 {SSD_DESC_COMMAND, scsi_sense_command_sbuf},
4735 {SSD_DESC_SKS, scsi_sense_sks_sbuf},
4736 {SSD_DESC_FRU, scsi_sense_fru_sbuf},
4737 {SSD_DESC_STREAM, scsi_sense_stream_sbuf},
4738 {SSD_DESC_BLOCK, scsi_sense_block_sbuf},
4739 {SSD_DESC_ATA, scsi_sense_ata_sbuf},
4740 {SSD_DESC_PROGRESS, scsi_sense_progress_sbuf},
4741 {SSD_DESC_FORWARDED, scsi_sense_forwarded_sbuf}
4742 };
4743
4744 void
scsi_sense_desc_sbuf(struct sbuf * sb,struct scsi_sense_data * sense,u_int sense_len,uint8_t * cdb,int cdb_len,struct scsi_inquiry_data * inq_data,struct scsi_sense_desc_header * header)4745 scsi_sense_desc_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
4746 u_int sense_len, uint8_t *cdb, int cdb_len,
4747 struct scsi_inquiry_data *inq_data,
4748 struct scsi_sense_desc_header *header)
4749 {
4750 u_int i;
4751
4752 for (i = 0; i < nitems(scsi_sense_printers); i++) {
4753 struct scsi_sense_desc_printer *printer;
4754
4755 printer = &scsi_sense_printers[i];
4756
4757 /*
4758 * The list is sorted, so quit if we've passed our
4759 * descriptor number.
4760 */
4761 if (printer->desc_type > header->desc_type)
4762 break;
4763
4764 if (printer->desc_type != header->desc_type)
4765 continue;
4766
4767 printer->print_func(sb, sense, sense_len, cdb, cdb_len,
4768 inq_data, header);
4769
4770 return;
4771 }
4772
4773 /*
4774 * No specific printing routine, so use the generic routine.
4775 */
4776 scsi_sense_generic_sbuf(sb, sense, sense_len, cdb, cdb_len,
4777 inq_data, header);
4778 }
4779
4780 scsi_sense_data_type
scsi_sense_type(struct scsi_sense_data * sense_data)4781 scsi_sense_type(struct scsi_sense_data *sense_data)
4782 {
4783 switch (sense_data->error_code & SSD_ERRCODE) {
4784 case SSD_DESC_CURRENT_ERROR:
4785 case SSD_DESC_DEFERRED_ERROR:
4786 return (SSD_TYPE_DESC);
4787 break;
4788 case SSD_CURRENT_ERROR:
4789 case SSD_DEFERRED_ERROR:
4790 return (SSD_TYPE_FIXED);
4791 break;
4792 default:
4793 break;
4794 }
4795
4796 return (SSD_TYPE_NONE);
4797 }
4798
4799 struct scsi_print_sense_info {
4800 struct sbuf *sb;
4801 char *path_str;
4802 uint8_t *cdb;
4803 int cdb_len;
4804 struct scsi_inquiry_data *inq_data;
4805 };
4806
4807 static int
scsi_print_desc_func(struct scsi_sense_data_desc * sense,u_int sense_len,struct scsi_sense_desc_header * header,void * arg)4808 scsi_print_desc_func(struct scsi_sense_data_desc *sense, u_int sense_len,
4809 struct scsi_sense_desc_header *header, void *arg)
4810 {
4811 struct scsi_print_sense_info *print_info;
4812
4813 print_info = (struct scsi_print_sense_info *)arg;
4814
4815 switch (header->desc_type) {
4816 case SSD_DESC_INFO:
4817 case SSD_DESC_FRU:
4818 case SSD_DESC_COMMAND:
4819 case SSD_DESC_SKS:
4820 case SSD_DESC_BLOCK:
4821 case SSD_DESC_STREAM:
4822 /*
4823 * We have already printed these descriptors, if they are
4824 * present.
4825 */
4826 break;
4827 default: {
4828 sbuf_printf(print_info->sb, "%s", print_info->path_str);
4829 scsi_sense_desc_sbuf(print_info->sb,
4830 (struct scsi_sense_data *)sense, sense_len,
4831 print_info->cdb, print_info->cdb_len,
4832 print_info->inq_data, header);
4833 sbuf_printf(print_info->sb, "\n");
4834 break;
4835 }
4836 }
4837
4838 /*
4839 * Tell the iterator that we want to see more descriptors if they
4840 * are present.
4841 */
4842 return (0);
4843 }
4844
4845 void
scsi_sense_only_sbuf(struct scsi_sense_data * sense,u_int sense_len,struct sbuf * sb,char * path_str,struct scsi_inquiry_data * inq_data,uint8_t * cdb,int cdb_len)4846 scsi_sense_only_sbuf(struct scsi_sense_data *sense, u_int sense_len,
4847 struct sbuf *sb, char *path_str,
4848 struct scsi_inquiry_data *inq_data, uint8_t *cdb,
4849 int cdb_len)
4850 {
4851 int error_code, sense_key, asc, ascq;
4852
4853 sbuf_cat(sb, path_str);
4854
4855 scsi_extract_sense_len(sense, sense_len, &error_code, &sense_key,
4856 &asc, &ascq, /*show_errors*/ 1);
4857
4858 sbuf_printf(sb, "SCSI sense: ");
4859 switch (error_code) {
4860 case SSD_DEFERRED_ERROR:
4861 case SSD_DESC_DEFERRED_ERROR:
4862 sbuf_printf(sb, "Deferred error: ");
4863
4864 /* FALLTHROUGH */
4865 case SSD_CURRENT_ERROR:
4866 case SSD_DESC_CURRENT_ERROR:
4867 {
4868 struct scsi_sense_data_desc *desc_sense;
4869 struct scsi_print_sense_info print_info;
4870 const char *sense_key_desc;
4871 const char *asc_desc;
4872 uint8_t sks[3];
4873 uint64_t val;
4874 uint8_t bits;
4875
4876 /*
4877 * Get descriptions for the sense key, ASC, and ASCQ. If
4878 * these aren't present in the sense data (i.e. the sense
4879 * data isn't long enough), the -1 values that
4880 * scsi_extract_sense_len() returns will yield default
4881 * or error descriptions.
4882 */
4883 scsi_sense_desc(sense_key, asc, ascq, inq_data,
4884 &sense_key_desc, &asc_desc);
4885
4886 /*
4887 * We first print the sense key and ASC/ASCQ.
4888 */
4889 sbuf_cat(sb, sense_key_desc);
4890 sbuf_printf(sb, " asc:%x,%x (%s)\n", asc, ascq, asc_desc);
4891
4892 /*
4893 * Print any block or stream device-specific information.
4894 */
4895 if (scsi_get_block_info(sense, sense_len, inq_data,
4896 &bits) == 0 && bits != 0) {
4897 sbuf_cat(sb, path_str);
4898 scsi_block_sbuf(sb, bits);
4899 sbuf_printf(sb, "\n");
4900 } else if (scsi_get_stream_info(sense, sense_len, inq_data,
4901 &bits) == 0 && bits != 0) {
4902 sbuf_cat(sb, path_str);
4903 scsi_stream_sbuf(sb, bits);
4904 sbuf_printf(sb, "\n");
4905 }
4906
4907 /*
4908 * Print the info field.
4909 */
4910 if (scsi_get_sense_info(sense, sense_len, SSD_DESC_INFO,
4911 &val, NULL) == 0) {
4912 sbuf_cat(sb, path_str);
4913 scsi_info_sbuf(sb, cdb, cdb_len, inq_data, val);
4914 sbuf_printf(sb, "\n");
4915 }
4916
4917 /*
4918 * Print the FRU.
4919 */
4920 if (scsi_get_sense_info(sense, sense_len, SSD_DESC_FRU,
4921 &val, NULL) == 0) {
4922 sbuf_cat(sb, path_str);
4923 scsi_fru_sbuf(sb, val);
4924 sbuf_printf(sb, "\n");
4925 }
4926
4927 /*
4928 * Print any command-specific information.
4929 */
4930 if (scsi_get_sense_info(sense, sense_len, SSD_DESC_COMMAND,
4931 &val, NULL) == 0) {
4932 sbuf_cat(sb, path_str);
4933 scsi_command_sbuf(sb, cdb, cdb_len, inq_data, val);
4934 sbuf_printf(sb, "\n");
4935 }
4936
4937 /*
4938 * Print out any sense-key-specific information.
4939 */
4940 if (scsi_get_sks(sense, sense_len, sks) == 0) {
4941 sbuf_cat(sb, path_str);
4942 scsi_sks_sbuf(sb, sense_key, sks);
4943 sbuf_printf(sb, "\n");
4944 }
4945
4946 /*
4947 * If this is fixed sense, we're done. If we have
4948 * descriptor sense, we might have more information
4949 * available.
4950 */
4951 if (scsi_sense_type(sense) != SSD_TYPE_DESC)
4952 break;
4953
4954 desc_sense = (struct scsi_sense_data_desc *)sense;
4955
4956 print_info.sb = sb;
4957 print_info.path_str = path_str;
4958 print_info.cdb = cdb;
4959 print_info.cdb_len = cdb_len;
4960 print_info.inq_data = inq_data;
4961
4962 /*
4963 * Print any sense descriptors that we have not already printed.
4964 */
4965 scsi_desc_iterate(desc_sense, sense_len, scsi_print_desc_func,
4966 &print_info);
4967 break;
4968
4969 }
4970 case -1:
4971 /*
4972 * scsi_extract_sense_len() sets values to -1 if the
4973 * show_errors flag is set and they aren't present in the
4974 * sense data. This means that sense_len is 0.
4975 */
4976 sbuf_printf(sb, "No sense data present\n");
4977 break;
4978 default: {
4979 sbuf_printf(sb, "Error code 0x%x", error_code);
4980 if (sense->error_code & SSD_ERRCODE_VALID) {
4981 struct scsi_sense_data_fixed *fixed_sense;
4982
4983 fixed_sense = (struct scsi_sense_data_fixed *)sense;
4984
4985 if (SSD_FIXED_IS_PRESENT(fixed_sense, sense_len, info)){
4986 uint32_t info;
4987
4988 info = scsi_4btoul(fixed_sense->info);
4989
4990 sbuf_printf(sb, " at block no. %d (decimal)",
4991 info);
4992 }
4993 }
4994 sbuf_printf(sb, "\n");
4995 break;
4996 }
4997 }
4998 }
4999
5000 /*
5001 * scsi_sense_sbuf() returns 0 for success and -1 for failure.
5002 */
5003 #ifdef _KERNEL
5004 int
scsi_sense_sbuf(struct ccb_scsiio * csio,struct sbuf * sb,scsi_sense_string_flags flags)5005 scsi_sense_sbuf(struct ccb_scsiio *csio, struct sbuf *sb,
5006 scsi_sense_string_flags flags)
5007 #else /* !_KERNEL */
5008 int
5009 scsi_sense_sbuf(struct cam_device *device, struct ccb_scsiio *csio,
5010 struct sbuf *sb, scsi_sense_string_flags flags)
5011 #endif /* _KERNEL/!_KERNEL */
5012 {
5013 struct scsi_sense_data *sense;
5014 struct scsi_inquiry_data *inq_data;
5015 #ifdef _KERNEL
5016 struct ccb_getdev *cgd;
5017 #endif /* _KERNEL */
5018 char path_str[64];
5019
5020 #ifndef _KERNEL
5021 if (device == NULL)
5022 return(-1);
5023 #endif /* !_KERNEL */
5024 if ((csio == NULL) || (sb == NULL))
5025 return(-1);
5026
5027 /*
5028 * If the CDB is a physical address, we can't deal with it..
5029 */
5030 if ((csio->ccb_h.flags & CAM_CDB_PHYS) != 0)
5031 flags &= ~SSS_FLAG_PRINT_COMMAND;
5032
5033 #ifdef _KERNEL
5034 xpt_path_string(csio->ccb_h.path, path_str, sizeof(path_str));
5035 #else /* !_KERNEL */
5036 cam_path_string(device, path_str, sizeof(path_str));
5037 #endif /* _KERNEL/!_KERNEL */
5038
5039 #ifdef _KERNEL
5040 if ((cgd = (struct ccb_getdev*)xpt_alloc_ccb_nowait()) == NULL)
5041 return(-1);
5042 /*
5043 * Get the device information.
5044 */
5045 xpt_setup_ccb(&cgd->ccb_h,
5046 csio->ccb_h.path,
5047 CAM_PRIORITY_NORMAL);
5048 cgd->ccb_h.func_code = XPT_GDEV_TYPE;
5049 xpt_action((union ccb *)cgd);
5050
5051 /*
5052 * If the device is unconfigured, just pretend that it is a hard
5053 * drive. scsi_op_desc() needs this.
5054 */
5055 if (cgd->ccb_h.status == CAM_DEV_NOT_THERE)
5056 cgd->inq_data.device = T_DIRECT;
5057
5058 inq_data = &cgd->inq_data;
5059
5060 #else /* !_KERNEL */
5061
5062 inq_data = &device->inq_data;
5063
5064 #endif /* _KERNEL/!_KERNEL */
5065
5066 sense = NULL;
5067
5068 if (flags & SSS_FLAG_PRINT_COMMAND) {
5069
5070 sbuf_cat(sb, path_str);
5071
5072 #ifdef _KERNEL
5073 scsi_command_string(csio, sb);
5074 #else /* !_KERNEL */
5075 scsi_command_string(device, csio, sb);
5076 #endif /* _KERNEL/!_KERNEL */
5077 sbuf_printf(sb, "\n");
5078 }
5079
5080 /*
5081 * If the sense data is a physical pointer, forget it.
5082 */
5083 if (csio->ccb_h.flags & CAM_SENSE_PTR) {
5084 if (csio->ccb_h.flags & CAM_SENSE_PHYS) {
5085 #ifdef _KERNEL
5086 xpt_free_ccb((union ccb*)cgd);
5087 #endif /* _KERNEL/!_KERNEL */
5088 return(-1);
5089 } else {
5090 /*
5091 * bcopy the pointer to avoid unaligned access
5092 * errors on finicky architectures. We don't
5093 * ensure that the sense data is pointer aligned.
5094 */
5095 bcopy(&csio->sense_data, &sense,
5096 sizeof(struct scsi_sense_data *));
5097 }
5098 } else {
5099 /*
5100 * If the physical sense flag is set, but the sense pointer
5101 * is not also set, we assume that the user is an idiot and
5102 * return. (Well, okay, it could be that somehow, the
5103 * entire csio is physical, but we would have probably core
5104 * dumped on one of the bogus pointer deferences above
5105 * already.)
5106 */
5107 if (csio->ccb_h.flags & CAM_SENSE_PHYS) {
5108 #ifdef _KERNEL
5109 xpt_free_ccb((union ccb*)cgd);
5110 #endif /* _KERNEL/!_KERNEL */
5111 return(-1);
5112 } else
5113 sense = &csio->sense_data;
5114 }
5115
5116 scsi_sense_only_sbuf(sense, csio->sense_len - csio->sense_resid, sb,
5117 path_str, inq_data, scsiio_cdb_ptr(csio), csio->cdb_len);
5118
5119 #ifdef _KERNEL
5120 xpt_free_ccb((union ccb*)cgd);
5121 #endif /* _KERNEL/!_KERNEL */
5122 return(0);
5123 }
5124
5125
5126
5127 #ifdef _KERNEL
5128 char *
scsi_sense_string(struct ccb_scsiio * csio,char * str,int str_len)5129 scsi_sense_string(struct ccb_scsiio *csio, char *str, int str_len)
5130 #else /* !_KERNEL */
5131 char *
5132 scsi_sense_string(struct cam_device *device, struct ccb_scsiio *csio,
5133 char *str, int str_len)
5134 #endif /* _KERNEL/!_KERNEL */
5135 {
5136 struct sbuf sb;
5137
5138 sbuf_new(&sb, str, str_len, 0);
5139
5140 #ifdef _KERNEL
5141 scsi_sense_sbuf(csio, &sb, SSS_FLAG_PRINT_COMMAND);
5142 #else /* !_KERNEL */
5143 scsi_sense_sbuf(device, csio, &sb, SSS_FLAG_PRINT_COMMAND);
5144 #endif /* _KERNEL/!_KERNEL */
5145
5146 sbuf_finish(&sb);
5147
5148 return(sbuf_data(&sb));
5149 }
5150
5151 #ifdef _KERNEL
5152 void
scsi_sense_print(struct ccb_scsiio * csio)5153 scsi_sense_print(struct ccb_scsiio *csio)
5154 {
5155 struct sbuf sb;
5156 char str[512];
5157
5158 sbuf_new(&sb, str, sizeof(str), 0);
5159
5160 scsi_sense_sbuf(csio, &sb, SSS_FLAG_PRINT_COMMAND);
5161
5162 sbuf_finish(&sb);
5163
5164 printf("%s", sbuf_data(&sb));
5165 }
5166
5167 #else /* !_KERNEL */
5168 void
scsi_sense_print(struct cam_device * device,struct ccb_scsiio * csio,FILE * ofile)5169 scsi_sense_print(struct cam_device *device, struct ccb_scsiio *csio,
5170 FILE *ofile)
5171 {
5172 struct sbuf sb;
5173 char str[512];
5174
5175 if ((device == NULL) || (csio == NULL) || (ofile == NULL))
5176 return;
5177
5178 sbuf_new(&sb, str, sizeof(str), 0);
5179
5180 scsi_sense_sbuf(device, csio, &sb, SSS_FLAG_PRINT_COMMAND);
5181
5182 sbuf_finish(&sb);
5183
5184 fprintf(ofile, "%s", sbuf_data(&sb));
5185 }
5186
5187 #endif /* _KERNEL/!_KERNEL */
5188
5189 /*
5190 * Extract basic sense information. This is backward-compatible with the
5191 * previous implementation. For new implementations,
5192 * scsi_extract_sense_len() is recommended.
5193 */
5194 void
scsi_extract_sense(struct scsi_sense_data * sense_data,int * error_code,int * sense_key,int * asc,int * ascq)5195 scsi_extract_sense(struct scsi_sense_data *sense_data, int *error_code,
5196 int *sense_key, int *asc, int *ascq)
5197 {
5198 scsi_extract_sense_len(sense_data, sizeof(*sense_data), error_code,
5199 sense_key, asc, ascq, /*show_errors*/ 0);
5200 }
5201
5202 /*
5203 * Extract basic sense information from SCSI I/O CCB structure.
5204 */
5205 int
scsi_extract_sense_ccb(union ccb * ccb,int * error_code,int * sense_key,int * asc,int * ascq)5206 scsi_extract_sense_ccb(union ccb *ccb,
5207 int *error_code, int *sense_key, int *asc, int *ascq)
5208 {
5209 struct scsi_sense_data *sense_data;
5210
5211 /* Make sure there are some sense data we can access. */
5212 if (ccb->ccb_h.func_code != XPT_SCSI_IO ||
5213 (ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_SCSI_STATUS_ERROR ||
5214 (ccb->csio.scsi_status != SCSI_STATUS_CHECK_COND) ||
5215 (ccb->ccb_h.status & CAM_AUTOSNS_VALID) == 0 ||
5216 (ccb->ccb_h.flags & CAM_SENSE_PHYS))
5217 return (0);
5218
5219 if (ccb->ccb_h.flags & CAM_SENSE_PTR)
5220 bcopy(&ccb->csio.sense_data, &sense_data,
5221 sizeof(struct scsi_sense_data *));
5222 else
5223 sense_data = &ccb->csio.sense_data;
5224 scsi_extract_sense_len(sense_data,
5225 ccb->csio.sense_len - ccb->csio.sense_resid,
5226 error_code, sense_key, asc, ascq, 1);
5227 if (*error_code == -1)
5228 return (0);
5229 return (1);
5230 }
5231
5232 /*
5233 * Extract basic sense information. If show_errors is set, sense values
5234 * will be set to -1 if they are not present.
5235 */
5236 void
scsi_extract_sense_len(struct scsi_sense_data * sense_data,u_int sense_len,int * error_code,int * sense_key,int * asc,int * ascq,int show_errors)5237 scsi_extract_sense_len(struct scsi_sense_data *sense_data, u_int sense_len,
5238 int *error_code, int *sense_key, int *asc, int *ascq,
5239 int show_errors)
5240 {
5241 /*
5242 * If we have no length, we have no sense.
5243 */
5244 if (sense_len == 0) {
5245 if (show_errors == 0) {
5246 *error_code = 0;
5247 *sense_key = 0;
5248 *asc = 0;
5249 *ascq = 0;
5250 } else {
5251 *error_code = -1;
5252 *sense_key = -1;
5253 *asc = -1;
5254 *ascq = -1;
5255 }
5256 return;
5257 }
5258
5259 *error_code = sense_data->error_code & SSD_ERRCODE;
5260
5261 switch (*error_code) {
5262 case SSD_DESC_CURRENT_ERROR:
5263 case SSD_DESC_DEFERRED_ERROR: {
5264 struct scsi_sense_data_desc *sense;
5265
5266 sense = (struct scsi_sense_data_desc *)sense_data;
5267
5268 if (SSD_DESC_IS_PRESENT(sense, sense_len, sense_key))
5269 *sense_key = sense->sense_key & SSD_KEY;
5270 else
5271 *sense_key = (show_errors) ? -1 : 0;
5272
5273 if (SSD_DESC_IS_PRESENT(sense, sense_len, add_sense_code))
5274 *asc = sense->add_sense_code;
5275 else
5276 *asc = (show_errors) ? -1 : 0;
5277
5278 if (SSD_DESC_IS_PRESENT(sense, sense_len, add_sense_code_qual))
5279 *ascq = sense->add_sense_code_qual;
5280 else
5281 *ascq = (show_errors) ? -1 : 0;
5282 break;
5283 }
5284 case SSD_CURRENT_ERROR:
5285 case SSD_DEFERRED_ERROR:
5286 default: {
5287 struct scsi_sense_data_fixed *sense;
5288
5289 sense = (struct scsi_sense_data_fixed *)sense_data;
5290
5291 if (SSD_FIXED_IS_PRESENT(sense, sense_len, flags))
5292 *sense_key = sense->flags & SSD_KEY;
5293 else
5294 *sense_key = (show_errors) ? -1 : 0;
5295
5296 if ((SSD_FIXED_IS_PRESENT(sense, sense_len, add_sense_code))
5297 && (SSD_FIXED_IS_FILLED(sense, add_sense_code)))
5298 *asc = sense->add_sense_code;
5299 else
5300 *asc = (show_errors) ? -1 : 0;
5301
5302 if ((SSD_FIXED_IS_PRESENT(sense, sense_len,add_sense_code_qual))
5303 && (SSD_FIXED_IS_FILLED(sense, add_sense_code_qual)))
5304 *ascq = sense->add_sense_code_qual;
5305 else
5306 *ascq = (show_errors) ? -1 : 0;
5307 break;
5308 }
5309 }
5310 }
5311
5312 int
scsi_get_sense_key(struct scsi_sense_data * sense_data,u_int sense_len,int show_errors)5313 scsi_get_sense_key(struct scsi_sense_data *sense_data, u_int sense_len,
5314 int show_errors)
5315 {
5316 int error_code, sense_key, asc, ascq;
5317
5318 scsi_extract_sense_len(sense_data, sense_len, &error_code,
5319 &sense_key, &asc, &ascq, show_errors);
5320
5321 return (sense_key);
5322 }
5323
5324 int
scsi_get_asc(struct scsi_sense_data * sense_data,u_int sense_len,int show_errors)5325 scsi_get_asc(struct scsi_sense_data *sense_data, u_int sense_len,
5326 int show_errors)
5327 {
5328 int error_code, sense_key, asc, ascq;
5329
5330 scsi_extract_sense_len(sense_data, sense_len, &error_code,
5331 &sense_key, &asc, &ascq, show_errors);
5332
5333 return (asc);
5334 }
5335
5336 int
scsi_get_ascq(struct scsi_sense_data * sense_data,u_int sense_len,int show_errors)5337 scsi_get_ascq(struct scsi_sense_data *sense_data, u_int sense_len,
5338 int show_errors)
5339 {
5340 int error_code, sense_key, asc, ascq;
5341
5342 scsi_extract_sense_len(sense_data, sense_len, &error_code,
5343 &sense_key, &asc, &ascq, show_errors);
5344
5345 return (ascq);
5346 }
5347
5348 /*
5349 * This function currently requires at least 36 bytes, or
5350 * SHORT_INQUIRY_LENGTH, worth of data to function properly. If this
5351 * function needs more or less data in the future, another length should be
5352 * defined in scsi_all.h to indicate the minimum amount of data necessary
5353 * for this routine to function properly.
5354 */
5355 void
scsi_print_inquiry(struct scsi_inquiry_data * inq_data)5356 scsi_print_inquiry(struct scsi_inquiry_data *inq_data)
5357 {
5358 u_int8_t type;
5359 char *dtype, *qtype;
5360 char vendor[16], product[48], revision[16], rstr[12];
5361
5362 type = SID_TYPE(inq_data);
5363
5364 /*
5365 * Figure out basic device type and qualifier.
5366 */
5367 if (SID_QUAL_IS_VENDOR_UNIQUE(inq_data)) {
5368 qtype = " (vendor-unique qualifier)";
5369 } else {
5370 switch (SID_QUAL(inq_data)) {
5371 case SID_QUAL_LU_CONNECTED:
5372 qtype = "";
5373 break;
5374
5375 case SID_QUAL_LU_OFFLINE:
5376 qtype = " (offline)";
5377 break;
5378
5379 case SID_QUAL_RSVD:
5380 qtype = " (reserved qualifier)";
5381 break;
5382 default:
5383 case SID_QUAL_BAD_LU:
5384 qtype = " (LUN not supported)";
5385 break;
5386 }
5387 }
5388
5389 switch (type) {
5390 case T_DIRECT:
5391 dtype = "Direct Access";
5392 break;
5393 case T_SEQUENTIAL:
5394 dtype = "Sequential Access";
5395 break;
5396 case T_PRINTER:
5397 dtype = "Printer";
5398 break;
5399 case T_PROCESSOR:
5400 dtype = "Processor";
5401 break;
5402 case T_WORM:
5403 dtype = "WORM";
5404 break;
5405 case T_CDROM:
5406 dtype = "CD-ROM";
5407 break;
5408 case T_SCANNER:
5409 dtype = "Scanner";
5410 break;
5411 case T_OPTICAL:
5412 dtype = "Optical";
5413 break;
5414 case T_CHANGER:
5415 dtype = "Changer";
5416 break;
5417 case T_COMM:
5418 dtype = "Communication";
5419 break;
5420 case T_STORARRAY:
5421 dtype = "Storage Array";
5422 break;
5423 case T_ENCLOSURE:
5424 dtype = "Enclosure Services";
5425 break;
5426 case T_RBC:
5427 dtype = "Simplified Direct Access";
5428 break;
5429 case T_OCRW:
5430 dtype = "Optical Card Read/Write";
5431 break;
5432 case T_OSD:
5433 dtype = "Object-Based Storage";
5434 break;
5435 case T_ADC:
5436 dtype = "Automation/Drive Interface";
5437 break;
5438 case T_ZBC_HM:
5439 dtype = "Host Managed Zoned Block";
5440 break;
5441 case T_NODEVICE:
5442 dtype = "Uninstalled";
5443 break;
5444 default:
5445 dtype = "unknown";
5446 break;
5447 }
5448
5449 cam_strvis(vendor, inq_data->vendor, sizeof(inq_data->vendor),
5450 sizeof(vendor));
5451 cam_strvis(product, inq_data->product, sizeof(inq_data->product),
5452 sizeof(product));
5453 cam_strvis(revision, inq_data->revision, sizeof(inq_data->revision),
5454 sizeof(revision));
5455
5456 if (SID_ANSI_REV(inq_data) == SCSI_REV_0)
5457 snprintf(rstr, sizeof(rstr), "SCSI");
5458 else if (SID_ANSI_REV(inq_data) <= SCSI_REV_SPC) {
5459 snprintf(rstr, sizeof(rstr), "SCSI-%d",
5460 SID_ANSI_REV(inq_data));
5461 } else {
5462 snprintf(rstr, sizeof(rstr), "SPC-%d SCSI",
5463 SID_ANSI_REV(inq_data) - 2);
5464 }
5465 printf("<%s %s %s> %s %s %s device%s\n",
5466 vendor, product, revision,
5467 SID_IS_REMOVABLE(inq_data) ? "Removable" : "Fixed",
5468 dtype, rstr, qtype);
5469 }
5470
5471 void
scsi_print_inquiry_short(struct scsi_inquiry_data * inq_data)5472 scsi_print_inquiry_short(struct scsi_inquiry_data *inq_data)
5473 {
5474 char vendor[16], product[48], revision[16];
5475
5476 cam_strvis(vendor, inq_data->vendor, sizeof(inq_data->vendor),
5477 sizeof(vendor));
5478 cam_strvis(product, inq_data->product, sizeof(inq_data->product),
5479 sizeof(product));
5480 cam_strvis(revision, inq_data->revision, sizeof(inq_data->revision),
5481 sizeof(revision));
5482
5483 printf("<%s %s %s>", vendor, product, revision);
5484 }
5485
5486 /*
5487 * Table of syncrates that don't follow the "divisible by 4"
5488 * rule. This table will be expanded in future SCSI specs.
5489 */
5490 static struct {
5491 u_int period_factor;
5492 u_int period; /* in 100ths of ns */
5493 } scsi_syncrates[] = {
5494 { 0x08, 625 }, /* FAST-160 */
5495 { 0x09, 1250 }, /* FAST-80 */
5496 { 0x0a, 2500 }, /* FAST-40 40MHz */
5497 { 0x0b, 3030 }, /* FAST-40 33MHz */
5498 { 0x0c, 5000 } /* FAST-20 */
5499 };
5500
5501 /*
5502 * Return the frequency in kHz corresponding to the given
5503 * sync period factor.
5504 */
5505 u_int
scsi_calc_syncsrate(u_int period_factor)5506 scsi_calc_syncsrate(u_int period_factor)
5507 {
5508 u_int i;
5509 u_int num_syncrates;
5510
5511 /*
5512 * It's a bug if period is zero, but if it is anyway, don't
5513 * die with a divide fault- instead return something which
5514 * 'approximates' async
5515 */
5516 if (period_factor == 0) {
5517 return (3300);
5518 }
5519
5520 num_syncrates = nitems(scsi_syncrates);
5521 /* See if the period is in the "exception" table */
5522 for (i = 0; i < num_syncrates; i++) {
5523
5524 if (period_factor == scsi_syncrates[i].period_factor) {
5525 /* Period in kHz */
5526 return (100000000 / scsi_syncrates[i].period);
5527 }
5528 }
5529
5530 /*
5531 * Wasn't in the table, so use the standard
5532 * 4 times conversion.
5533 */
5534 return (10000000 / (period_factor * 4 * 10));
5535 }
5536
5537 /*
5538 * Return the SCSI sync parameter that corresponds to
5539 * the passed in period in 10ths of ns.
5540 */
5541 u_int
scsi_calc_syncparam(u_int period)5542 scsi_calc_syncparam(u_int period)
5543 {
5544 u_int i;
5545 u_int num_syncrates;
5546
5547 if (period == 0)
5548 return (~0); /* Async */
5549
5550 /* Adjust for exception table being in 100ths. */
5551 period *= 10;
5552 num_syncrates = nitems(scsi_syncrates);
5553 /* See if the period is in the "exception" table */
5554 for (i = 0; i < num_syncrates; i++) {
5555
5556 if (period <= scsi_syncrates[i].period) {
5557 /* Period in 100ths of ns */
5558 return (scsi_syncrates[i].period_factor);
5559 }
5560 }
5561
5562 /*
5563 * Wasn't in the table, so use the standard
5564 * 1/4 period in ns conversion.
5565 */
5566 return (period/400);
5567 }
5568
5569 int
scsi_devid_is_naa_ieee_reg(uint8_t * bufp)5570 scsi_devid_is_naa_ieee_reg(uint8_t *bufp)
5571 {
5572 struct scsi_vpd_id_descriptor *descr;
5573 struct scsi_vpd_id_naa_basic *naa;
5574 int n;
5575
5576 descr = (struct scsi_vpd_id_descriptor *)bufp;
5577 naa = (struct scsi_vpd_id_naa_basic *)descr->identifier;
5578 if ((descr->id_type & SVPD_ID_TYPE_MASK) != SVPD_ID_TYPE_NAA)
5579 return 0;
5580 if (descr->length < sizeof(struct scsi_vpd_id_naa_ieee_reg))
5581 return 0;
5582 n = naa->naa >> SVPD_ID_NAA_NAA_SHIFT;
5583 if (n != SVPD_ID_NAA_LOCAL_REG && n != SVPD_ID_NAA_IEEE_REG)
5584 return 0;
5585 return 1;
5586 }
5587
5588 int
scsi_devid_is_sas_target(uint8_t * bufp)5589 scsi_devid_is_sas_target(uint8_t *bufp)
5590 {
5591 struct scsi_vpd_id_descriptor *descr;
5592
5593 descr = (struct scsi_vpd_id_descriptor *)bufp;
5594 if (!scsi_devid_is_naa_ieee_reg(bufp))
5595 return 0;
5596 if ((descr->id_type & SVPD_ID_PIV) == 0) /* proto field reserved */
5597 return 0;
5598 if ((descr->proto_codeset >> SVPD_ID_PROTO_SHIFT) != SCSI_PROTO_SAS)
5599 return 0;
5600 return 1;
5601 }
5602
5603 int
scsi_devid_is_lun_eui64(uint8_t * bufp)5604 scsi_devid_is_lun_eui64(uint8_t *bufp)
5605 {
5606 struct scsi_vpd_id_descriptor *descr;
5607
5608 descr = (struct scsi_vpd_id_descriptor *)bufp;
5609 if ((descr->id_type & SVPD_ID_ASSOC_MASK) != SVPD_ID_ASSOC_LUN)
5610 return 0;
5611 if ((descr->id_type & SVPD_ID_TYPE_MASK) != SVPD_ID_TYPE_EUI64)
5612 return 0;
5613 return 1;
5614 }
5615
5616 int
scsi_devid_is_lun_naa(uint8_t * bufp)5617 scsi_devid_is_lun_naa(uint8_t *bufp)
5618 {
5619 struct scsi_vpd_id_descriptor *descr;
5620
5621 descr = (struct scsi_vpd_id_descriptor *)bufp;
5622 if ((descr->id_type & SVPD_ID_ASSOC_MASK) != SVPD_ID_ASSOC_LUN)
5623 return 0;
5624 if ((descr->id_type & SVPD_ID_TYPE_MASK) != SVPD_ID_TYPE_NAA)
5625 return 0;
5626 return 1;
5627 }
5628
5629 int
scsi_devid_is_lun_t10(uint8_t * bufp)5630 scsi_devid_is_lun_t10(uint8_t *bufp)
5631 {
5632 struct scsi_vpd_id_descriptor *descr;
5633
5634 descr = (struct scsi_vpd_id_descriptor *)bufp;
5635 if ((descr->id_type & SVPD_ID_ASSOC_MASK) != SVPD_ID_ASSOC_LUN)
5636 return 0;
5637 if ((descr->id_type & SVPD_ID_TYPE_MASK) != SVPD_ID_TYPE_T10)
5638 return 0;
5639 return 1;
5640 }
5641
5642 int
scsi_devid_is_lun_name(uint8_t * bufp)5643 scsi_devid_is_lun_name(uint8_t *bufp)
5644 {
5645 struct scsi_vpd_id_descriptor *descr;
5646
5647 descr = (struct scsi_vpd_id_descriptor *)bufp;
5648 if ((descr->id_type & SVPD_ID_ASSOC_MASK) != SVPD_ID_ASSOC_LUN)
5649 return 0;
5650 if ((descr->id_type & SVPD_ID_TYPE_MASK) != SVPD_ID_TYPE_SCSI_NAME)
5651 return 0;
5652 return 1;
5653 }
5654
5655 int
scsi_devid_is_lun_md5(uint8_t * bufp)5656 scsi_devid_is_lun_md5(uint8_t *bufp)
5657 {
5658 struct scsi_vpd_id_descriptor *descr;
5659
5660 descr = (struct scsi_vpd_id_descriptor *)bufp;
5661 if ((descr->id_type & SVPD_ID_ASSOC_MASK) != SVPD_ID_ASSOC_LUN)
5662 return 0;
5663 if ((descr->id_type & SVPD_ID_TYPE_MASK) != SVPD_ID_TYPE_MD5_LUN_ID)
5664 return 0;
5665 return 1;
5666 }
5667
5668 int
scsi_devid_is_lun_uuid(uint8_t * bufp)5669 scsi_devid_is_lun_uuid(uint8_t *bufp)
5670 {
5671 struct scsi_vpd_id_descriptor *descr;
5672
5673 descr = (struct scsi_vpd_id_descriptor *)bufp;
5674 if ((descr->id_type & SVPD_ID_ASSOC_MASK) != SVPD_ID_ASSOC_LUN)
5675 return 0;
5676 if ((descr->id_type & SVPD_ID_TYPE_MASK) != SVPD_ID_TYPE_UUID)
5677 return 0;
5678 return 1;
5679 }
5680
5681 int
scsi_devid_is_port_naa(uint8_t * bufp)5682 scsi_devid_is_port_naa(uint8_t *bufp)
5683 {
5684 struct scsi_vpd_id_descriptor *descr;
5685
5686 descr = (struct scsi_vpd_id_descriptor *)bufp;
5687 if ((descr->id_type & SVPD_ID_ASSOC_MASK) != SVPD_ID_ASSOC_PORT)
5688 return 0;
5689 if ((descr->id_type & SVPD_ID_TYPE_MASK) != SVPD_ID_TYPE_NAA)
5690 return 0;
5691 return 1;
5692 }
5693
5694 struct scsi_vpd_id_descriptor *
scsi_get_devid_desc(struct scsi_vpd_id_descriptor * desc,uint32_t len,scsi_devid_checkfn_t ck_fn)5695 scsi_get_devid_desc(struct scsi_vpd_id_descriptor *desc, uint32_t len,
5696 scsi_devid_checkfn_t ck_fn)
5697 {
5698 uint8_t *desc_buf_end;
5699
5700 desc_buf_end = (uint8_t *)desc + len;
5701
5702 for (; desc->identifier <= desc_buf_end &&
5703 desc->identifier + desc->length <= desc_buf_end;
5704 desc = (struct scsi_vpd_id_descriptor *)(desc->identifier
5705 + desc->length)) {
5706
5707 if (ck_fn == NULL || ck_fn((uint8_t *)desc) != 0)
5708 return (desc);
5709 }
5710 return (NULL);
5711 }
5712
5713 struct scsi_vpd_id_descriptor *
scsi_get_devid(struct scsi_vpd_device_id * id,uint32_t page_len,scsi_devid_checkfn_t ck_fn)5714 scsi_get_devid(struct scsi_vpd_device_id *id, uint32_t page_len,
5715 scsi_devid_checkfn_t ck_fn)
5716 {
5717 uint32_t len;
5718
5719 if (page_len < sizeof(*id))
5720 return (NULL);
5721 len = MIN(scsi_2btoul(id->length), page_len - sizeof(*id));
5722 return (scsi_get_devid_desc((struct scsi_vpd_id_descriptor *)
5723 id->desc_list, len, ck_fn));
5724 }
5725
5726 int
scsi_transportid_sbuf(struct sbuf * sb,struct scsi_transportid_header * hdr,uint32_t valid_len)5727 scsi_transportid_sbuf(struct sbuf *sb, struct scsi_transportid_header *hdr,
5728 uint32_t valid_len)
5729 {
5730 switch (hdr->format_protocol & SCSI_TRN_PROTO_MASK) {
5731 case SCSI_PROTO_FC: {
5732 struct scsi_transportid_fcp *fcp;
5733 uint64_t n_port_name;
5734
5735 fcp = (struct scsi_transportid_fcp *)hdr;
5736
5737 n_port_name = scsi_8btou64(fcp->n_port_name);
5738
5739 sbuf_printf(sb, "FCP address: 0x%.16jx",(uintmax_t)n_port_name);
5740 break;
5741 }
5742 case SCSI_PROTO_SPI: {
5743 struct scsi_transportid_spi *spi;
5744
5745 spi = (struct scsi_transportid_spi *)hdr;
5746
5747 sbuf_printf(sb, "SPI address: %u,%u",
5748 scsi_2btoul(spi->scsi_addr),
5749 scsi_2btoul(spi->rel_trgt_port_id));
5750 break;
5751 }
5752 case SCSI_PROTO_SSA:
5753 /*
5754 * XXX KDM there is no transport ID defined in SPC-4 for
5755 * SSA.
5756 */
5757 break;
5758 case SCSI_PROTO_1394: {
5759 struct scsi_transportid_1394 *sbp;
5760 uint64_t eui64;
5761
5762 sbp = (struct scsi_transportid_1394 *)hdr;
5763
5764 eui64 = scsi_8btou64(sbp->eui64);
5765 sbuf_printf(sb, "SBP address: 0x%.16jx", (uintmax_t)eui64);
5766 break;
5767 }
5768 case SCSI_PROTO_RDMA: {
5769 struct scsi_transportid_rdma *rdma;
5770 unsigned int i;
5771
5772 rdma = (struct scsi_transportid_rdma *)hdr;
5773
5774 sbuf_printf(sb, "RDMA address: 0x");
5775 for (i = 0; i < sizeof(rdma->initiator_port_id); i++)
5776 sbuf_printf(sb, "%02x", rdma->initiator_port_id[i]);
5777 break;
5778 }
5779 case SCSI_PROTO_ISCSI: {
5780 uint32_t add_len, i;
5781 uint8_t *iscsi_name = NULL;
5782 int nul_found = 0;
5783
5784 sbuf_printf(sb, "iSCSI address: ");
5785 if ((hdr->format_protocol & SCSI_TRN_FORMAT_MASK) ==
5786 SCSI_TRN_ISCSI_FORMAT_DEVICE) {
5787 struct scsi_transportid_iscsi_device *dev;
5788
5789 dev = (struct scsi_transportid_iscsi_device *)hdr;
5790
5791 /*
5792 * Verify how much additional data we really have.
5793 */
5794 add_len = scsi_2btoul(dev->additional_length);
5795 add_len = MIN(add_len, valid_len -
5796 __offsetof(struct scsi_transportid_iscsi_device,
5797 iscsi_name));
5798 iscsi_name = &dev->iscsi_name[0];
5799
5800 } else if ((hdr->format_protocol & SCSI_TRN_FORMAT_MASK) ==
5801 SCSI_TRN_ISCSI_FORMAT_PORT) {
5802 struct scsi_transportid_iscsi_port *port;
5803
5804 port = (struct scsi_transportid_iscsi_port *)hdr;
5805
5806 add_len = scsi_2btoul(port->additional_length);
5807 add_len = MIN(add_len, valid_len -
5808 __offsetof(struct scsi_transportid_iscsi_port,
5809 iscsi_name));
5810 iscsi_name = &port->iscsi_name[0];
5811 } else {
5812 sbuf_printf(sb, "unknown format %x",
5813 (hdr->format_protocol &
5814 SCSI_TRN_FORMAT_MASK) >>
5815 SCSI_TRN_FORMAT_SHIFT);
5816 break;
5817 }
5818 if (add_len == 0) {
5819 sbuf_printf(sb, "not enough data");
5820 break;
5821 }
5822 /*
5823 * This is supposed to be a NUL-terminated ASCII
5824 * string, but you never know. So we're going to
5825 * check. We need to do this because there is no
5826 * sbuf equivalent of strncat().
5827 */
5828 for (i = 0; i < add_len; i++) {
5829 if (iscsi_name[i] == '\0') {
5830 nul_found = 1;
5831 break;
5832 }
5833 }
5834 /*
5835 * If there is a NUL in the name, we can just use
5836 * sbuf_cat(). Otherwise we need to use sbuf_bcat().
5837 */
5838 if (nul_found != 0)
5839 sbuf_cat(sb, iscsi_name);
5840 else
5841 sbuf_bcat(sb, iscsi_name, add_len);
5842 break;
5843 }
5844 case SCSI_PROTO_SAS: {
5845 struct scsi_transportid_sas *sas;
5846 uint64_t sas_addr;
5847
5848 sas = (struct scsi_transportid_sas *)hdr;
5849
5850 sas_addr = scsi_8btou64(sas->sas_address);
5851 sbuf_printf(sb, "SAS address: 0x%.16jx", (uintmax_t)sas_addr);
5852 break;
5853 }
5854 case SCSI_PROTO_ADITP:
5855 case SCSI_PROTO_ATA:
5856 case SCSI_PROTO_UAS:
5857 /*
5858 * No Transport ID format for ADI, ATA or USB is defined in
5859 * SPC-4.
5860 */
5861 sbuf_printf(sb, "No known Transport ID format for protocol "
5862 "%#x", hdr->format_protocol & SCSI_TRN_PROTO_MASK);
5863 break;
5864 case SCSI_PROTO_SOP: {
5865 struct scsi_transportid_sop *sop;
5866 struct scsi_sop_routing_id_norm *rid;
5867
5868 sop = (struct scsi_transportid_sop *)hdr;
5869 rid = (struct scsi_sop_routing_id_norm *)sop->routing_id;
5870
5871 /*
5872 * Note that there is no alternate format specified in SPC-4
5873 * for the PCIe routing ID, so we don't really have a way
5874 * to know whether the second byte of the routing ID is
5875 * a device and function or just a function. So we just
5876 * assume bus,device,function.
5877 */
5878 sbuf_printf(sb, "SOP Routing ID: %u,%u,%u",
5879 rid->bus, rid->devfunc >> SCSI_TRN_SOP_DEV_SHIFT,
5880 rid->devfunc & SCSI_TRN_SOP_FUNC_NORM_MAX);
5881 break;
5882 }
5883 case SCSI_PROTO_NONE:
5884 default:
5885 sbuf_printf(sb, "Unknown protocol %#x",
5886 hdr->format_protocol & SCSI_TRN_PROTO_MASK);
5887 break;
5888 }
5889
5890 return (0);
5891 }
5892
5893 struct scsi_nv scsi_proto_map[] = {
5894 { "fcp", SCSI_PROTO_FC },
5895 { "spi", SCSI_PROTO_SPI },
5896 { "ssa", SCSI_PROTO_SSA },
5897 { "sbp", SCSI_PROTO_1394 },
5898 { "1394", SCSI_PROTO_1394 },
5899 { "srp", SCSI_PROTO_RDMA },
5900 { "rdma", SCSI_PROTO_RDMA },
5901 { "iscsi", SCSI_PROTO_ISCSI },
5902 { "iqn", SCSI_PROTO_ISCSI },
5903 { "sas", SCSI_PROTO_SAS },
5904 { "aditp", SCSI_PROTO_ADITP },
5905 { "ata", SCSI_PROTO_ATA },
5906 { "uas", SCSI_PROTO_UAS },
5907 { "usb", SCSI_PROTO_UAS },
5908 { "sop", SCSI_PROTO_SOP }
5909 };
5910
5911 const char *
scsi_nv_to_str(struct scsi_nv * table,int num_table_entries,uint64_t value)5912 scsi_nv_to_str(struct scsi_nv *table, int num_table_entries, uint64_t value)
5913 {
5914 int i;
5915
5916 for (i = 0; i < num_table_entries; i++) {
5917 if (table[i].value == value)
5918 return (table[i].name);
5919 }
5920
5921 return (NULL);
5922 }
5923
5924 /*
5925 * Given a name/value table, find a value matching the given name.
5926 * Return values:
5927 * SCSI_NV_FOUND - match found
5928 * SCSI_NV_AMBIGUOUS - more than one match, none of them exact
5929 * SCSI_NV_NOT_FOUND - no match found
5930 */
5931 scsi_nv_status
scsi_get_nv(struct scsi_nv * table,int num_table_entries,char * name,int * table_entry,scsi_nv_flags flags)5932 scsi_get_nv(struct scsi_nv *table, int num_table_entries,
5933 char *name, int *table_entry, scsi_nv_flags flags)
5934 {
5935 int i, num_matches = 0;
5936
5937 for (i = 0; i < num_table_entries; i++) {
5938 size_t table_len, name_len;
5939
5940 table_len = strlen(table[i].name);
5941 name_len = strlen(name);
5942
5943 if ((((flags & SCSI_NV_FLAG_IG_CASE) != 0)
5944 && (strncasecmp(table[i].name, name, name_len) == 0))
5945 || (((flags & SCSI_NV_FLAG_IG_CASE) == 0)
5946 && (strncmp(table[i].name, name, name_len) == 0))) {
5947 *table_entry = i;
5948
5949 /*
5950 * Check for an exact match. If we have the same
5951 * number of characters in the table as the argument,
5952 * and we already know they're the same, we have
5953 * an exact match.
5954 */
5955 if (table_len == name_len)
5956 return (SCSI_NV_FOUND);
5957
5958 /*
5959 * Otherwise, bump up the number of matches. We'll
5960 * see later how many we have.
5961 */
5962 num_matches++;
5963 }
5964 }
5965
5966 if (num_matches > 1)
5967 return (SCSI_NV_AMBIGUOUS);
5968 else if (num_matches == 1)
5969 return (SCSI_NV_FOUND);
5970 else
5971 return (SCSI_NV_NOT_FOUND);
5972 }
5973
5974 /*
5975 * Parse transport IDs for Fibre Channel, 1394 and SAS. Since these are
5976 * all 64-bit numbers, the code is similar.
5977 */
5978 int
scsi_parse_transportid_64bit(int proto_id,char * id_str,struct scsi_transportid_header ** hdr,unsigned int * alloc_len,struct malloc_type * type,int flags,char * error_str,int error_str_len)5979 scsi_parse_transportid_64bit(int proto_id, char *id_str,
5980 struct scsi_transportid_header **hdr,
5981 unsigned int *alloc_len,
5982 #ifdef _KERNEL
5983 struct malloc_type *type, int flags,
5984 #endif
5985 char *error_str, int error_str_len)
5986 {
5987 uint64_t value;
5988 char *endptr;
5989 int retval;
5990 size_t alloc_size;
5991
5992 retval = 0;
5993
5994 value = strtouq(id_str, &endptr, 0);
5995 if (*endptr != '\0') {
5996 if (error_str != NULL) {
5997 snprintf(error_str, error_str_len, "%s: error "
5998 "parsing ID %s, 64-bit number required",
5999 __func__, id_str);
6000 }
6001 retval = 1;
6002 goto bailout;
6003 }
6004
6005 switch (proto_id) {
6006 case SCSI_PROTO_FC:
6007 alloc_size = sizeof(struct scsi_transportid_fcp);
6008 break;
6009 case SCSI_PROTO_1394:
6010 alloc_size = sizeof(struct scsi_transportid_1394);
6011 break;
6012 case SCSI_PROTO_SAS:
6013 alloc_size = sizeof(struct scsi_transportid_sas);
6014 break;
6015 default:
6016 if (error_str != NULL) {
6017 snprintf(error_str, error_str_len, "%s: unsupported "
6018 "protocol %d", __func__, proto_id);
6019 }
6020 retval = 1;
6021 goto bailout;
6022 break; /* NOTREACHED */
6023 }
6024 #ifdef _KERNEL
6025 *hdr = malloc(alloc_size, type, flags);
6026 #else /* _KERNEL */
6027 *hdr = malloc(alloc_size);
6028 #endif /*_KERNEL */
6029 if (*hdr == NULL) {
6030 if (error_str != NULL) {
6031 snprintf(error_str, error_str_len, "%s: unable to "
6032 "allocate %zu bytes", __func__, alloc_size);
6033 }
6034 retval = 1;
6035 goto bailout;
6036 }
6037
6038 *alloc_len = alloc_size;
6039
6040 bzero(*hdr, alloc_size);
6041
6042 switch (proto_id) {
6043 case SCSI_PROTO_FC: {
6044 struct scsi_transportid_fcp *fcp;
6045
6046 fcp = (struct scsi_transportid_fcp *)(*hdr);
6047 fcp->format_protocol = SCSI_PROTO_FC |
6048 SCSI_TRN_FCP_FORMAT_DEFAULT;
6049 scsi_u64to8b(value, fcp->n_port_name);
6050 break;
6051 }
6052 case SCSI_PROTO_1394: {
6053 struct scsi_transportid_1394 *sbp;
6054
6055 sbp = (struct scsi_transportid_1394 *)(*hdr);
6056 sbp->format_protocol = SCSI_PROTO_1394 |
6057 SCSI_TRN_1394_FORMAT_DEFAULT;
6058 scsi_u64to8b(value, sbp->eui64);
6059 break;
6060 }
6061 case SCSI_PROTO_SAS: {
6062 struct scsi_transportid_sas *sas;
6063
6064 sas = (struct scsi_transportid_sas *)(*hdr);
6065 sas->format_protocol = SCSI_PROTO_SAS |
6066 SCSI_TRN_SAS_FORMAT_DEFAULT;
6067 scsi_u64to8b(value, sas->sas_address);
6068 break;
6069 }
6070 default:
6071 break;
6072 }
6073 bailout:
6074 return (retval);
6075 }
6076
6077 /*
6078 * Parse a SPI (Parallel SCSI) address of the form: id,rel_tgt_port
6079 */
6080 int
scsi_parse_transportid_spi(char * id_str,struct scsi_transportid_header ** hdr,unsigned int * alloc_len,struct malloc_type * type,int flags,char * error_str,int error_str_len)6081 scsi_parse_transportid_spi(char *id_str, struct scsi_transportid_header **hdr,
6082 unsigned int *alloc_len,
6083 #ifdef _KERNEL
6084 struct malloc_type *type, int flags,
6085 #endif
6086 char *error_str, int error_str_len)
6087 {
6088 unsigned long scsi_addr, target_port;
6089 struct scsi_transportid_spi *spi;
6090 char *tmpstr, *endptr;
6091 int retval;
6092
6093 retval = 0;
6094
6095 tmpstr = strsep(&id_str, ",");
6096 if (tmpstr == NULL) {
6097 if (error_str != NULL) {
6098 snprintf(error_str, error_str_len,
6099 "%s: no ID found", __func__);
6100 }
6101 retval = 1;
6102 goto bailout;
6103 }
6104 scsi_addr = strtoul(tmpstr, &endptr, 0);
6105 if (*endptr != '\0') {
6106 if (error_str != NULL) {
6107 snprintf(error_str, error_str_len, "%s: error "
6108 "parsing SCSI ID %s, number required",
6109 __func__, tmpstr);
6110 }
6111 retval = 1;
6112 goto bailout;
6113 }
6114
6115 if (id_str == NULL) {
6116 if (error_str != NULL) {
6117 snprintf(error_str, error_str_len, "%s: no relative "
6118 "target port found", __func__);
6119 }
6120 retval = 1;
6121 goto bailout;
6122 }
6123
6124 target_port = strtoul(id_str, &endptr, 0);
6125 if (*endptr != '\0') {
6126 if (error_str != NULL) {
6127 snprintf(error_str, error_str_len, "%s: error "
6128 "parsing relative target port %s, number "
6129 "required", __func__, id_str);
6130 }
6131 retval = 1;
6132 goto bailout;
6133 }
6134 #ifdef _KERNEL
6135 spi = malloc(sizeof(*spi), type, flags);
6136 #else
6137 spi = malloc(sizeof(*spi));
6138 #endif
6139 if (spi == NULL) {
6140 if (error_str != NULL) {
6141 snprintf(error_str, error_str_len, "%s: unable to "
6142 "allocate %zu bytes", __func__,
6143 sizeof(*spi));
6144 }
6145 retval = 1;
6146 goto bailout;
6147 }
6148 *alloc_len = sizeof(*spi);
6149 bzero(spi, sizeof(*spi));
6150
6151 spi->format_protocol = SCSI_PROTO_SPI | SCSI_TRN_SPI_FORMAT_DEFAULT;
6152 scsi_ulto2b(scsi_addr, spi->scsi_addr);
6153 scsi_ulto2b(target_port, spi->rel_trgt_port_id);
6154
6155 *hdr = (struct scsi_transportid_header *)spi;
6156 bailout:
6157 return (retval);
6158 }
6159
6160 /*
6161 * Parse an RDMA/SRP Initiator Port ID string. This is 32 hexadecimal digits,
6162 * optionally prefixed by "0x" or "0X".
6163 */
6164 int
scsi_parse_transportid_rdma(char * id_str,struct scsi_transportid_header ** hdr,unsigned int * alloc_len,struct malloc_type * type,int flags,char * error_str,int error_str_len)6165 scsi_parse_transportid_rdma(char *id_str, struct scsi_transportid_header **hdr,
6166 unsigned int *alloc_len,
6167 #ifdef _KERNEL
6168 struct malloc_type *type, int flags,
6169 #endif
6170 char *error_str, int error_str_len)
6171 {
6172 struct scsi_transportid_rdma *rdma;
6173 int retval;
6174 size_t id_len, rdma_id_size;
6175 uint8_t rdma_id[SCSI_TRN_RDMA_PORT_LEN];
6176 char *tmpstr;
6177 unsigned int i, j;
6178
6179 retval = 0;
6180 id_len = strlen(id_str);
6181 rdma_id_size = SCSI_TRN_RDMA_PORT_LEN;
6182
6183 /*
6184 * Check the size. It needs to be either 32 or 34 characters long.
6185 */
6186 if ((id_len != (rdma_id_size * 2))
6187 && (id_len != ((rdma_id_size * 2) + 2))) {
6188 if (error_str != NULL) {
6189 snprintf(error_str, error_str_len, "%s: RDMA ID "
6190 "must be 32 hex digits (0x prefix "
6191 "optional), only %zu seen", __func__, id_len);
6192 }
6193 retval = 1;
6194 goto bailout;
6195 }
6196
6197 tmpstr = id_str;
6198 /*
6199 * If the user gave us 34 characters, the string needs to start
6200 * with '0x'.
6201 */
6202 if (id_len == ((rdma_id_size * 2) + 2)) {
6203 if ((tmpstr[0] == '0')
6204 && ((tmpstr[1] == 'x') || (tmpstr[1] == 'X'))) {
6205 tmpstr += 2;
6206 } else {
6207 if (error_str != NULL) {
6208 snprintf(error_str, error_str_len, "%s: RDMA "
6209 "ID prefix, if used, must be \"0x\", "
6210 "got %s", __func__, tmpstr);
6211 }
6212 retval = 1;
6213 goto bailout;
6214 }
6215 }
6216 bzero(rdma_id, sizeof(rdma_id));
6217
6218 /*
6219 * Convert ASCII hex into binary bytes. There is no standard
6220 * 128-bit integer type, and so no strtou128t() routine to convert
6221 * from hex into a large integer. In the end, we're not going to
6222 * an integer, but rather to a byte array, so that and the fact
6223 * that we require the user to give us 32 hex digits simplifies the
6224 * logic.
6225 */
6226 for (i = 0; i < (rdma_id_size * 2); i++) {
6227 int cur_shift;
6228 unsigned char c;
6229
6230 /* Increment the byte array one for every 2 hex digits */
6231 j = i >> 1;
6232
6233 /*
6234 * The first digit in every pair is the most significant
6235 * 4 bits. The second is the least significant 4 bits.
6236 */
6237 if ((i % 2) == 0)
6238 cur_shift = 4;
6239 else
6240 cur_shift = 0;
6241
6242 c = tmpstr[i];
6243 /* Convert the ASCII hex character into a number */
6244 if (isdigit(c))
6245 c -= '0';
6246 else if (isalpha(c))
6247 c -= isupper(c) ? 'A' - 10 : 'a' - 10;
6248 else {
6249 if (error_str != NULL) {
6250 snprintf(error_str, error_str_len, "%s: "
6251 "RDMA ID must be hex digits, got "
6252 "invalid character %c", __func__,
6253 tmpstr[i]);
6254 }
6255 retval = 1;
6256 goto bailout;
6257 }
6258 /*
6259 * The converted number can't be less than 0; the type is
6260 * unsigned, and the subtraction logic will not give us
6261 * a negative number. So we only need to make sure that
6262 * the value is not greater than 0xf. (i.e. make sure the
6263 * user didn't give us a value like "0x12jklmno").
6264 */
6265 if (c > 0xf) {
6266 if (error_str != NULL) {
6267 snprintf(error_str, error_str_len, "%s: "
6268 "RDMA ID must be hex digits, got "
6269 "invalid character %c", __func__,
6270 tmpstr[i]);
6271 }
6272 retval = 1;
6273 goto bailout;
6274 }
6275
6276 rdma_id[j] |= c << cur_shift;
6277 }
6278
6279 #ifdef _KERNEL
6280 rdma = malloc(sizeof(*rdma), type, flags);
6281 #else
6282 rdma = malloc(sizeof(*rdma));
6283 #endif
6284 if (rdma == NULL) {
6285 if (error_str != NULL) {
6286 snprintf(error_str, error_str_len, "%s: unable to "
6287 "allocate %zu bytes", __func__,
6288 sizeof(*rdma));
6289 }
6290 retval = 1;
6291 goto bailout;
6292 }
6293 *alloc_len = sizeof(*rdma);
6294 bzero(rdma, *alloc_len);
6295
6296 rdma->format_protocol = SCSI_PROTO_RDMA | SCSI_TRN_RDMA_FORMAT_DEFAULT;
6297 bcopy(rdma_id, rdma->initiator_port_id, SCSI_TRN_RDMA_PORT_LEN);
6298
6299 *hdr = (struct scsi_transportid_header *)rdma;
6300
6301 bailout:
6302 return (retval);
6303 }
6304
6305 /*
6306 * Parse an iSCSI name. The format is either just the name:
6307 *
6308 * iqn.2012-06.com.example:target0
6309 * or the name, separator and initiator session ID:
6310 *
6311 * iqn.2012-06.com.example:target0,i,0x123
6312 *
6313 * The separator format is exact.
6314 */
6315 int
scsi_parse_transportid_iscsi(char * id_str,struct scsi_transportid_header ** hdr,unsigned int * alloc_len,struct malloc_type * type,int flags,char * error_str,int error_str_len)6316 scsi_parse_transportid_iscsi(char *id_str, struct scsi_transportid_header **hdr,
6317 unsigned int *alloc_len,
6318 #ifdef _KERNEL
6319 struct malloc_type *type, int flags,
6320 #endif
6321 char *error_str, int error_str_len)
6322 {
6323 size_t id_len, sep_len, id_size, name_len;
6324 int retval;
6325 unsigned int i, sep_pos, sep_found;
6326 const char *sep_template = ",i,0x";
6327 const char *iqn_prefix = "iqn.";
6328 struct scsi_transportid_iscsi_device *iscsi;
6329
6330 retval = 0;
6331 sep_found = 0;
6332
6333 id_len = strlen(id_str);
6334 sep_len = strlen(sep_template);
6335
6336 /*
6337 * The separator is defined as exactly ',i,0x'. Any other commas,
6338 * or any other form, is an error. So look for a comma, and once
6339 * we find that, the next few characters must match the separator
6340 * exactly. Once we get through the separator, there should be at
6341 * least one character.
6342 */
6343 for (i = 0, sep_pos = 0; i < id_len; i++) {
6344 if (sep_pos == 0) {
6345 if (id_str[i] == sep_template[sep_pos])
6346 sep_pos++;
6347
6348 continue;
6349 }
6350 if (sep_pos < sep_len) {
6351 if (id_str[i] == sep_template[sep_pos]) {
6352 sep_pos++;
6353 continue;
6354 }
6355 if (error_str != NULL) {
6356 snprintf(error_str, error_str_len, "%s: "
6357 "invalid separator in iSCSI name "
6358 "\"%s\"",
6359 __func__, id_str);
6360 }
6361 retval = 1;
6362 goto bailout;
6363 } else {
6364 sep_found = 1;
6365 break;
6366 }
6367 }
6368
6369 /*
6370 * Check to see whether we have a separator but no digits after it.
6371 */
6372 if ((sep_pos != 0)
6373 && (sep_found == 0)) {
6374 if (error_str != NULL) {
6375 snprintf(error_str, error_str_len, "%s: no digits "
6376 "found after separator in iSCSI name \"%s\"",
6377 __func__, id_str);
6378 }
6379 retval = 1;
6380 goto bailout;
6381 }
6382
6383 /*
6384 * The incoming ID string has the "iqn." prefix stripped off. We
6385 * need enough space for the base structure (the structures are the
6386 * same for the two iSCSI forms), the prefix, the ID string and a
6387 * terminating NUL.
6388 */
6389 id_size = sizeof(*iscsi) + strlen(iqn_prefix) + id_len + 1;
6390
6391 #ifdef _KERNEL
6392 iscsi = malloc(id_size, type, flags);
6393 #else
6394 iscsi = malloc(id_size);
6395 #endif
6396 if (iscsi == NULL) {
6397 if (error_str != NULL) {
6398 snprintf(error_str, error_str_len, "%s: unable to "
6399 "allocate %zu bytes", __func__, id_size);
6400 }
6401 retval = 1;
6402 goto bailout;
6403 }
6404 *alloc_len = id_size;
6405 bzero(iscsi, id_size);
6406
6407 iscsi->format_protocol = SCSI_PROTO_ISCSI;
6408 if (sep_found == 0)
6409 iscsi->format_protocol |= SCSI_TRN_ISCSI_FORMAT_DEVICE;
6410 else
6411 iscsi->format_protocol |= SCSI_TRN_ISCSI_FORMAT_PORT;
6412 name_len = id_size - sizeof(*iscsi);
6413 scsi_ulto2b(name_len, iscsi->additional_length);
6414 snprintf(iscsi->iscsi_name, name_len, "%s%s", iqn_prefix, id_str);
6415
6416 *hdr = (struct scsi_transportid_header *)iscsi;
6417
6418 bailout:
6419 return (retval);
6420 }
6421
6422 /*
6423 * Parse a SCSI over PCIe (SOP) identifier. The Routing ID can either be
6424 * of the form 'bus,device,function' or 'bus,function'.
6425 */
6426 int
scsi_parse_transportid_sop(char * id_str,struct scsi_transportid_header ** hdr,unsigned int * alloc_len,struct malloc_type * type,int flags,char * error_str,int error_str_len)6427 scsi_parse_transportid_sop(char *id_str, struct scsi_transportid_header **hdr,
6428 unsigned int *alloc_len,
6429 #ifdef _KERNEL
6430 struct malloc_type *type, int flags,
6431 #endif
6432 char *error_str, int error_str_len)
6433 {
6434 struct scsi_transportid_sop *sop;
6435 unsigned long bus, device, function;
6436 char *tmpstr, *endptr;
6437 int retval, device_spec;
6438
6439 retval = 0;
6440 device_spec = 0;
6441 device = 0;
6442
6443 tmpstr = strsep(&id_str, ",");
6444 if ((tmpstr == NULL)
6445 || (*tmpstr == '\0')) {
6446 if (error_str != NULL) {
6447 snprintf(error_str, error_str_len, "%s: no ID found",
6448 __func__);
6449 }
6450 retval = 1;
6451 goto bailout;
6452 }
6453 bus = strtoul(tmpstr, &endptr, 0);
6454 if (*endptr != '\0') {
6455 if (error_str != NULL) {
6456 snprintf(error_str, error_str_len, "%s: error "
6457 "parsing PCIe bus %s, number required",
6458 __func__, tmpstr);
6459 }
6460 retval = 1;
6461 goto bailout;
6462 }
6463 if ((id_str == NULL)
6464 || (*id_str == '\0')) {
6465 if (error_str != NULL) {
6466 snprintf(error_str, error_str_len, "%s: no PCIe "
6467 "device or function found", __func__);
6468 }
6469 retval = 1;
6470 goto bailout;
6471 }
6472 tmpstr = strsep(&id_str, ",");
6473 function = strtoul(tmpstr, &endptr, 0);
6474 if (*endptr != '\0') {
6475 if (error_str != NULL) {
6476 snprintf(error_str, error_str_len, "%s: error "
6477 "parsing PCIe device/function %s, number "
6478 "required", __func__, tmpstr);
6479 }
6480 retval = 1;
6481 goto bailout;
6482 }
6483 /*
6484 * Check to see whether the user specified a third value. If so,
6485 * the second is the device.
6486 */
6487 if (id_str != NULL) {
6488 if (*id_str == '\0') {
6489 if (error_str != NULL) {
6490 snprintf(error_str, error_str_len, "%s: "
6491 "no PCIe function found", __func__);
6492 }
6493 retval = 1;
6494 goto bailout;
6495 }
6496 device = function;
6497 device_spec = 1;
6498 function = strtoul(id_str, &endptr, 0);
6499 if (*endptr != '\0') {
6500 if (error_str != NULL) {
6501 snprintf(error_str, error_str_len, "%s: "
6502 "error parsing PCIe function %s, "
6503 "number required", __func__, id_str);
6504 }
6505 retval = 1;
6506 goto bailout;
6507 }
6508 }
6509 if (bus > SCSI_TRN_SOP_BUS_MAX) {
6510 if (error_str != NULL) {
6511 snprintf(error_str, error_str_len, "%s: bus value "
6512 "%lu greater than maximum %u", __func__,
6513 bus, SCSI_TRN_SOP_BUS_MAX);
6514 }
6515 retval = 1;
6516 goto bailout;
6517 }
6518
6519 if ((device_spec != 0)
6520 && (device > SCSI_TRN_SOP_DEV_MASK)) {
6521 if (error_str != NULL) {
6522 snprintf(error_str, error_str_len, "%s: device value "
6523 "%lu greater than maximum %u", __func__,
6524 device, SCSI_TRN_SOP_DEV_MAX);
6525 }
6526 retval = 1;
6527 goto bailout;
6528 }
6529
6530 if (((device_spec != 0)
6531 && (function > SCSI_TRN_SOP_FUNC_NORM_MAX))
6532 || ((device_spec == 0)
6533 && (function > SCSI_TRN_SOP_FUNC_ALT_MAX))) {
6534 if (error_str != NULL) {
6535 snprintf(error_str, error_str_len, "%s: function value "
6536 "%lu greater than maximum %u", __func__,
6537 function, (device_spec == 0) ?
6538 SCSI_TRN_SOP_FUNC_ALT_MAX :
6539 SCSI_TRN_SOP_FUNC_NORM_MAX);
6540 }
6541 retval = 1;
6542 goto bailout;
6543 }
6544
6545 #ifdef _KERNEL
6546 sop = malloc(sizeof(*sop), type, flags);
6547 #else
6548 sop = malloc(sizeof(*sop));
6549 #endif
6550 if (sop == NULL) {
6551 if (error_str != NULL) {
6552 snprintf(error_str, error_str_len, "%s: unable to "
6553 "allocate %zu bytes", __func__, sizeof(*sop));
6554 }
6555 retval = 1;
6556 goto bailout;
6557 }
6558 *alloc_len = sizeof(*sop);
6559 bzero(sop, sizeof(*sop));
6560 sop->format_protocol = SCSI_PROTO_SOP | SCSI_TRN_SOP_FORMAT_DEFAULT;
6561 if (device_spec != 0) {
6562 struct scsi_sop_routing_id_norm rid;
6563
6564 rid.bus = bus;
6565 rid.devfunc = (device << SCSI_TRN_SOP_DEV_SHIFT) | function;
6566 bcopy(&rid, sop->routing_id, MIN(sizeof(rid),
6567 sizeof(sop->routing_id)));
6568 } else {
6569 struct scsi_sop_routing_id_alt rid;
6570
6571 rid.bus = bus;
6572 rid.function = function;
6573 bcopy(&rid, sop->routing_id, MIN(sizeof(rid),
6574 sizeof(sop->routing_id)));
6575 }
6576
6577 *hdr = (struct scsi_transportid_header *)sop;
6578 bailout:
6579 return (retval);
6580 }
6581
6582 /*
6583 * transportid_str: NUL-terminated string with format: protcol,id
6584 * The ID is protocol specific.
6585 * hdr: Storage will be allocated for the transport ID.
6586 * alloc_len: The amount of memory allocated is returned here.
6587 * type: Malloc bucket (kernel only).
6588 * flags: Malloc flags (kernel only).
6589 * error_str: If non-NULL, it will contain error information (without
6590 * a terminating newline) if an error is returned.
6591 * error_str_len: Allocated length of the error string.
6592 *
6593 * Returns 0 for success, non-zero for failure.
6594 */
6595 int
scsi_parse_transportid(char * transportid_str,struct scsi_transportid_header ** hdr,unsigned int * alloc_len,struct malloc_type * type,int flags,char * error_str,int error_str_len)6596 scsi_parse_transportid(char *transportid_str,
6597 struct scsi_transportid_header **hdr,
6598 unsigned int *alloc_len,
6599 #ifdef _KERNEL
6600 struct malloc_type *type, int flags,
6601 #endif
6602 char *error_str, int error_str_len)
6603 {
6604 char *tmpstr;
6605 scsi_nv_status status;
6606 u_int num_proto_entries;
6607 int retval, table_entry;
6608
6609 retval = 0;
6610 table_entry = 0;
6611
6612 /*
6613 * We do allow a period as well as a comma to separate the protocol
6614 * from the ID string. This is to accommodate iSCSI names, which
6615 * start with "iqn.".
6616 */
6617 tmpstr = strsep(&transportid_str, ",.");
6618 if (tmpstr == NULL) {
6619 if (error_str != NULL) {
6620 snprintf(error_str, error_str_len,
6621 "%s: transportid_str is NULL", __func__);
6622 }
6623 retval = 1;
6624 goto bailout;
6625 }
6626
6627 num_proto_entries = nitems(scsi_proto_map);
6628 status = scsi_get_nv(scsi_proto_map, num_proto_entries, tmpstr,
6629 &table_entry, SCSI_NV_FLAG_IG_CASE);
6630 if (status != SCSI_NV_FOUND) {
6631 if (error_str != NULL) {
6632 snprintf(error_str, error_str_len, "%s: %s protocol "
6633 "name %s", __func__,
6634 (status == SCSI_NV_AMBIGUOUS) ? "ambiguous" :
6635 "invalid", tmpstr);
6636 }
6637 retval = 1;
6638 goto bailout;
6639 }
6640 switch (scsi_proto_map[table_entry].value) {
6641 case SCSI_PROTO_FC:
6642 case SCSI_PROTO_1394:
6643 case SCSI_PROTO_SAS:
6644 retval = scsi_parse_transportid_64bit(
6645 scsi_proto_map[table_entry].value, transportid_str, hdr,
6646 alloc_len,
6647 #ifdef _KERNEL
6648 type, flags,
6649 #endif
6650 error_str, error_str_len);
6651 break;
6652 case SCSI_PROTO_SPI:
6653 retval = scsi_parse_transportid_spi(transportid_str, hdr,
6654 alloc_len,
6655 #ifdef _KERNEL
6656 type, flags,
6657 #endif
6658 error_str, error_str_len);
6659 break;
6660 case SCSI_PROTO_RDMA:
6661 retval = scsi_parse_transportid_rdma(transportid_str, hdr,
6662 alloc_len,
6663 #ifdef _KERNEL
6664 type, flags,
6665 #endif
6666 error_str, error_str_len);
6667 break;
6668 case SCSI_PROTO_ISCSI:
6669 retval = scsi_parse_transportid_iscsi(transportid_str, hdr,
6670 alloc_len,
6671 #ifdef _KERNEL
6672 type, flags,
6673 #endif
6674 error_str, error_str_len);
6675 break;
6676 case SCSI_PROTO_SOP:
6677 retval = scsi_parse_transportid_sop(transportid_str, hdr,
6678 alloc_len,
6679 #ifdef _KERNEL
6680 type, flags,
6681 #endif
6682 error_str, error_str_len);
6683 break;
6684 case SCSI_PROTO_SSA:
6685 case SCSI_PROTO_ADITP:
6686 case SCSI_PROTO_ATA:
6687 case SCSI_PROTO_UAS:
6688 case SCSI_PROTO_NONE:
6689 default:
6690 /*
6691 * There is no format defined for a Transport ID for these
6692 * protocols. So even if the user gives us something, we
6693 * have no way to turn it into a standard SCSI Transport ID.
6694 */
6695 retval = 1;
6696 if (error_str != NULL) {
6697 snprintf(error_str, error_str_len, "%s: no Transport "
6698 "ID format exists for protocol %s",
6699 __func__, tmpstr);
6700 }
6701 goto bailout;
6702 break; /* NOTREACHED */
6703 }
6704 bailout:
6705 return (retval);
6706 }
6707
6708 struct scsi_attrib_table_entry scsi_mam_attr_table[] = {
6709 { SMA_ATTR_REM_CAP_PARTITION, SCSI_ATTR_FLAG_NONE,
6710 "Remaining Capacity in Partition",
6711 /*suffix*/ "MB", /*to_str*/ scsi_attrib_int_sbuf,/*parse_str*/ NULL },
6712 { SMA_ATTR_MAX_CAP_PARTITION, SCSI_ATTR_FLAG_NONE,
6713 "Maximum Capacity in Partition",
6714 /*suffix*/"MB", /*to_str*/ scsi_attrib_int_sbuf, /*parse_str*/ NULL },
6715 { SMA_ATTR_TAPEALERT_FLAGS, SCSI_ATTR_FLAG_HEX,
6716 "TapeAlert Flags",
6717 /*suffix*/NULL, /*to_str*/ scsi_attrib_int_sbuf, /*parse_str*/ NULL },
6718 { SMA_ATTR_LOAD_COUNT, SCSI_ATTR_FLAG_NONE,
6719 "Load Count",
6720 /*suffix*/NULL, /*to_str*/ scsi_attrib_int_sbuf, /*parse_str*/ NULL },
6721 { SMA_ATTR_MAM_SPACE_REMAINING, SCSI_ATTR_FLAG_NONE,
6722 "MAM Space Remaining",
6723 /*suffix*/"bytes", /*to_str*/ scsi_attrib_int_sbuf,
6724 /*parse_str*/ NULL },
6725 { SMA_ATTR_DEV_ASSIGNING_ORG, SCSI_ATTR_FLAG_NONE,
6726 "Assigning Organization",
6727 /*suffix*/NULL, /*to_str*/ scsi_attrib_ascii_sbuf,
6728 /*parse_str*/ NULL },
6729 { SMA_ATTR_FORMAT_DENSITY_CODE, SCSI_ATTR_FLAG_HEX,
6730 "Format Density Code",
6731 /*suffix*/NULL, /*to_str*/ scsi_attrib_int_sbuf, /*parse_str*/ NULL },
6732 { SMA_ATTR_INITIALIZATION_COUNT, SCSI_ATTR_FLAG_NONE,
6733 "Initialization Count",
6734 /*suffix*/NULL, /*to_str*/ scsi_attrib_int_sbuf, /*parse_str*/ NULL },
6735 { SMA_ATTR_VOLUME_ID, SCSI_ATTR_FLAG_NONE,
6736 "Volume Identifier",
6737 /*suffix*/NULL, /*to_str*/ scsi_attrib_ascii_sbuf,
6738 /*parse_str*/ NULL },
6739 { SMA_ATTR_VOLUME_CHANGE_REF, SCSI_ATTR_FLAG_HEX,
6740 "Volume Change Reference",
6741 /*suffix*/NULL, /*to_str*/ scsi_attrib_int_sbuf,
6742 /*parse_str*/ NULL },
6743 { SMA_ATTR_DEV_SERIAL_LAST_LOAD, SCSI_ATTR_FLAG_NONE,
6744 "Device Vendor/Serial at Last Load",
6745 /*suffix*/NULL, /*to_str*/ scsi_attrib_vendser_sbuf,
6746 /*parse_str*/ NULL },
6747 { SMA_ATTR_DEV_SERIAL_LAST_LOAD_1, SCSI_ATTR_FLAG_NONE,
6748 "Device Vendor/Serial at Last Load - 1",
6749 /*suffix*/NULL, /*to_str*/ scsi_attrib_vendser_sbuf,
6750 /*parse_str*/ NULL },
6751 { SMA_ATTR_DEV_SERIAL_LAST_LOAD_2, SCSI_ATTR_FLAG_NONE,
6752 "Device Vendor/Serial at Last Load - 2",
6753 /*suffix*/NULL, /*to_str*/ scsi_attrib_vendser_sbuf,
6754 /*parse_str*/ NULL },
6755 { SMA_ATTR_DEV_SERIAL_LAST_LOAD_3, SCSI_ATTR_FLAG_NONE,
6756 "Device Vendor/Serial at Last Load - 3",
6757 /*suffix*/NULL, /*to_str*/ scsi_attrib_vendser_sbuf,
6758 /*parse_str*/ NULL },
6759 { SMA_ATTR_TOTAL_MB_WRITTEN_LT, SCSI_ATTR_FLAG_NONE,
6760 "Total MB Written in Medium Life",
6761 /*suffix*/ "MB", /*to_str*/ scsi_attrib_int_sbuf,
6762 /*parse_str*/ NULL },
6763 { SMA_ATTR_TOTAL_MB_READ_LT, SCSI_ATTR_FLAG_NONE,
6764 "Total MB Read in Medium Life",
6765 /*suffix*/ "MB", /*to_str*/ scsi_attrib_int_sbuf,
6766 /*parse_str*/ NULL },
6767 { SMA_ATTR_TOTAL_MB_WRITTEN_CUR, SCSI_ATTR_FLAG_NONE,
6768 "Total MB Written in Current/Last Load",
6769 /*suffix*/ "MB", /*to_str*/ scsi_attrib_int_sbuf,
6770 /*parse_str*/ NULL },
6771 { SMA_ATTR_TOTAL_MB_READ_CUR, SCSI_ATTR_FLAG_NONE,
6772 "Total MB Read in Current/Last Load",
6773 /*suffix*/ "MB", /*to_str*/ scsi_attrib_int_sbuf,
6774 /*parse_str*/ NULL },
6775 { SMA_ATTR_FIRST_ENC_BLOCK, SCSI_ATTR_FLAG_NONE,
6776 "Logical Position of First Encrypted Block",
6777 /*suffix*/ NULL, /*to_str*/ scsi_attrib_int_sbuf,
6778 /*parse_str*/ NULL },
6779 { SMA_ATTR_NEXT_UNENC_BLOCK, SCSI_ATTR_FLAG_NONE,
6780 "Logical Position of First Unencrypted Block after First "
6781 "Encrypted Block",
6782 /*suffix*/ NULL, /*to_str*/ scsi_attrib_int_sbuf,
6783 /*parse_str*/ NULL },
6784 { SMA_ATTR_MEDIUM_USAGE_HIST, SCSI_ATTR_FLAG_NONE,
6785 "Medium Usage History",
6786 /*suffix*/ NULL, /*to_str*/ NULL,
6787 /*parse_str*/ NULL },
6788 { SMA_ATTR_PART_USAGE_HIST, SCSI_ATTR_FLAG_NONE,
6789 "Partition Usage History",
6790 /*suffix*/ NULL, /*to_str*/ NULL,
6791 /*parse_str*/ NULL },
6792 { SMA_ATTR_MED_MANUF, SCSI_ATTR_FLAG_NONE,
6793 "Medium Manufacturer",
6794 /*suffix*/NULL, /*to_str*/ scsi_attrib_ascii_sbuf,
6795 /*parse_str*/ NULL },
6796 { SMA_ATTR_MED_SERIAL, SCSI_ATTR_FLAG_NONE,
6797 "Medium Serial Number",
6798 /*suffix*/NULL, /*to_str*/ scsi_attrib_ascii_sbuf,
6799 /*parse_str*/ NULL },
6800 { SMA_ATTR_MED_LENGTH, SCSI_ATTR_FLAG_NONE,
6801 "Medium Length",
6802 /*suffix*/"m", /*to_str*/ scsi_attrib_int_sbuf,
6803 /*parse_str*/ NULL },
6804 { SMA_ATTR_MED_WIDTH, SCSI_ATTR_FLAG_FP | SCSI_ATTR_FLAG_DIV_10 |
6805 SCSI_ATTR_FLAG_FP_1DIGIT,
6806 "Medium Width",
6807 /*suffix*/"mm", /*to_str*/ scsi_attrib_int_sbuf,
6808 /*parse_str*/ NULL },
6809 { SMA_ATTR_MED_ASSIGNING_ORG, SCSI_ATTR_FLAG_NONE,
6810 "Assigning Organization",
6811 /*suffix*/NULL, /*to_str*/ scsi_attrib_ascii_sbuf,
6812 /*parse_str*/ NULL },
6813 { SMA_ATTR_MED_DENSITY_CODE, SCSI_ATTR_FLAG_HEX,
6814 "Medium Density Code",
6815 /*suffix*/NULL, /*to_str*/ scsi_attrib_int_sbuf,
6816 /*parse_str*/ NULL },
6817 { SMA_ATTR_MED_MANUF_DATE, SCSI_ATTR_FLAG_NONE,
6818 "Medium Manufacture Date",
6819 /*suffix*/NULL, /*to_str*/ scsi_attrib_ascii_sbuf,
6820 /*parse_str*/ NULL },
6821 { SMA_ATTR_MAM_CAPACITY, SCSI_ATTR_FLAG_NONE,
6822 "MAM Capacity",
6823 /*suffix*/"bytes", /*to_str*/ scsi_attrib_int_sbuf,
6824 /*parse_str*/ NULL },
6825 { SMA_ATTR_MED_TYPE, SCSI_ATTR_FLAG_HEX,
6826 "Medium Type",
6827 /*suffix*/NULL, /*to_str*/ scsi_attrib_int_sbuf,
6828 /*parse_str*/ NULL },
6829 { SMA_ATTR_MED_TYPE_INFO, SCSI_ATTR_FLAG_HEX,
6830 "Medium Type Information",
6831 /*suffix*/NULL, /*to_str*/ scsi_attrib_int_sbuf,
6832 /*parse_str*/ NULL },
6833 { SMA_ATTR_MED_SERIAL_NUM, SCSI_ATTR_FLAG_NONE,
6834 "Medium Serial Number",
6835 /*suffix*/NULL, /*to_str*/ scsi_attrib_int_sbuf,
6836 /*parse_str*/ NULL },
6837 { SMA_ATTR_APP_VENDOR, SCSI_ATTR_FLAG_NONE,
6838 "Application Vendor",
6839 /*suffix*/NULL, /*to_str*/ scsi_attrib_ascii_sbuf,
6840 /*parse_str*/ NULL },
6841 { SMA_ATTR_APP_NAME, SCSI_ATTR_FLAG_NONE,
6842 "Application Name",
6843 /*suffix*/NULL, /*to_str*/ scsi_attrib_ascii_sbuf,
6844 /*parse_str*/ NULL },
6845 { SMA_ATTR_APP_VERSION, SCSI_ATTR_FLAG_NONE,
6846 "Application Version",
6847 /*suffix*/NULL, /*to_str*/ scsi_attrib_ascii_sbuf,
6848 /*parse_str*/ NULL },
6849 { SMA_ATTR_USER_MED_TEXT_LABEL, SCSI_ATTR_FLAG_NONE,
6850 "User Medium Text Label",
6851 /*suffix*/NULL, /*to_str*/ scsi_attrib_text_sbuf,
6852 /*parse_str*/ NULL },
6853 { SMA_ATTR_LAST_WRITTEN_TIME, SCSI_ATTR_FLAG_NONE,
6854 "Date and Time Last Written",
6855 /*suffix*/NULL, /*to_str*/ scsi_attrib_ascii_sbuf,
6856 /*parse_str*/ NULL },
6857 { SMA_ATTR_TEXT_LOCAL_ID, SCSI_ATTR_FLAG_HEX,
6858 "Text Localization Identifier",
6859 /*suffix*/NULL, /*to_str*/ scsi_attrib_int_sbuf,
6860 /*parse_str*/ NULL },
6861 { SMA_ATTR_BARCODE, SCSI_ATTR_FLAG_NONE,
6862 "Barcode",
6863 /*suffix*/NULL, /*to_str*/ scsi_attrib_ascii_sbuf,
6864 /*parse_str*/ NULL },
6865 { SMA_ATTR_HOST_OWNER_NAME, SCSI_ATTR_FLAG_NONE,
6866 "Owning Host Textual Name",
6867 /*suffix*/NULL, /*to_str*/ scsi_attrib_text_sbuf,
6868 /*parse_str*/ NULL },
6869 { SMA_ATTR_MEDIA_POOL, SCSI_ATTR_FLAG_NONE,
6870 "Media Pool",
6871 /*suffix*/NULL, /*to_str*/ scsi_attrib_text_sbuf,
6872 /*parse_str*/ NULL },
6873 { SMA_ATTR_PART_USER_LABEL, SCSI_ATTR_FLAG_NONE,
6874 "Partition User Text Label",
6875 /*suffix*/NULL, /*to_str*/ scsi_attrib_ascii_sbuf,
6876 /*parse_str*/ NULL },
6877 { SMA_ATTR_LOAD_UNLOAD_AT_PART, SCSI_ATTR_FLAG_NONE,
6878 "Load/Unload at Partition",
6879 /*suffix*/NULL, /*to_str*/ scsi_attrib_int_sbuf,
6880 /*parse_str*/ NULL },
6881 { SMA_ATTR_APP_FORMAT_VERSION, SCSI_ATTR_FLAG_NONE,
6882 "Application Format Version",
6883 /*suffix*/NULL, /*to_str*/ scsi_attrib_ascii_sbuf,
6884 /*parse_str*/ NULL },
6885 { SMA_ATTR_VOL_COHERENCY_INFO, SCSI_ATTR_FLAG_NONE,
6886 "Volume Coherency Information",
6887 /*suffix*/NULL, /*to_str*/ scsi_attrib_volcoh_sbuf,
6888 /*parse_str*/ NULL },
6889 { 0x0ff1, SCSI_ATTR_FLAG_NONE,
6890 "Spectra MLM Creation",
6891 /*suffix*/NULL, /*to_str*/ scsi_attrib_hexdump_sbuf,
6892 /*parse_str*/ NULL },
6893 { 0x0ff2, SCSI_ATTR_FLAG_NONE,
6894 "Spectra MLM C3",
6895 /*suffix*/NULL, /*to_str*/ scsi_attrib_hexdump_sbuf,
6896 /*parse_str*/ NULL },
6897 { 0x0ff3, SCSI_ATTR_FLAG_NONE,
6898 "Spectra MLM RW",
6899 /*suffix*/NULL, /*to_str*/ scsi_attrib_hexdump_sbuf,
6900 /*parse_str*/ NULL },
6901 { 0x0ff4, SCSI_ATTR_FLAG_NONE,
6902 "Spectra MLM SDC List",
6903 /*suffix*/NULL, /*to_str*/ scsi_attrib_hexdump_sbuf,
6904 /*parse_str*/ NULL },
6905 { 0x0ff7, SCSI_ATTR_FLAG_NONE,
6906 "Spectra MLM Post Scan",
6907 /*suffix*/NULL, /*to_str*/ scsi_attrib_hexdump_sbuf,
6908 /*parse_str*/ NULL },
6909 { 0x0ffe, SCSI_ATTR_FLAG_NONE,
6910 "Spectra MLM Checksum",
6911 /*suffix*/NULL, /*to_str*/ scsi_attrib_hexdump_sbuf,
6912 /*parse_str*/ NULL },
6913 { 0x17f1, SCSI_ATTR_FLAG_NONE,
6914 "Spectra MLM Creation",
6915 /*suffix*/NULL, /*to_str*/ scsi_attrib_hexdump_sbuf,
6916 /*parse_str*/ NULL },
6917 { 0x17f2, SCSI_ATTR_FLAG_NONE,
6918 "Spectra MLM C3",
6919 /*suffix*/NULL, /*to_str*/ scsi_attrib_hexdump_sbuf,
6920 /*parse_str*/ NULL },
6921 { 0x17f3, SCSI_ATTR_FLAG_NONE,
6922 "Spectra MLM RW",
6923 /*suffix*/NULL, /*to_str*/ scsi_attrib_hexdump_sbuf,
6924 /*parse_str*/ NULL },
6925 { 0x17f4, SCSI_ATTR_FLAG_NONE,
6926 "Spectra MLM SDC List",
6927 /*suffix*/NULL, /*to_str*/ scsi_attrib_hexdump_sbuf,
6928 /*parse_str*/ NULL },
6929 { 0x17f7, SCSI_ATTR_FLAG_NONE,
6930 "Spectra MLM Post Scan",
6931 /*suffix*/NULL, /*to_str*/ scsi_attrib_hexdump_sbuf,
6932 /*parse_str*/ NULL },
6933 { 0x17ff, SCSI_ATTR_FLAG_NONE,
6934 "Spectra MLM Checksum",
6935 /*suffix*/NULL, /*to_str*/ scsi_attrib_hexdump_sbuf,
6936 /*parse_str*/ NULL },
6937 };
6938
6939 /*
6940 * Print out Volume Coherency Information (Attribute 0x080c).
6941 * This field has two variable length members, including one at the
6942 * beginning, so it isn't practical to have a fixed structure definition.
6943 * This is current as of SSC4r03 (see section 4.2.21.3), dated March 25,
6944 * 2013.
6945 */
6946 int
scsi_attrib_volcoh_sbuf(struct sbuf * sb,struct scsi_mam_attribute_header * hdr,uint32_t valid_len,uint32_t flags,uint32_t output_flags,char * error_str,int error_str_len)6947 scsi_attrib_volcoh_sbuf(struct sbuf *sb, struct scsi_mam_attribute_header *hdr,
6948 uint32_t valid_len, uint32_t flags,
6949 uint32_t output_flags, char *error_str,
6950 int error_str_len)
6951 {
6952 size_t avail_len;
6953 uint32_t field_size;
6954 uint64_t tmp_val;
6955 uint8_t *cur_ptr;
6956 int retval;
6957 int vcr_len, as_len;
6958
6959 retval = 0;
6960 tmp_val = 0;
6961
6962 field_size = scsi_2btoul(hdr->length);
6963 avail_len = valid_len - sizeof(*hdr);
6964 if (field_size > avail_len) {
6965 if (error_str != NULL) {
6966 snprintf(error_str, error_str_len, "Available "
6967 "length of attribute ID 0x%.4x %zu < field "
6968 "length %u", scsi_2btoul(hdr->id), avail_len,
6969 field_size);
6970 }
6971 retval = 1;
6972 goto bailout;
6973 } else if (field_size == 0) {
6974 /*
6975 * It isn't clear from the spec whether a field length of
6976 * 0 is invalid here. It probably is, but be lenient here
6977 * to avoid inconveniencing the user.
6978 */
6979 goto bailout;
6980 }
6981 cur_ptr = hdr->attribute;
6982 vcr_len = *cur_ptr;
6983 cur_ptr++;
6984
6985 sbuf_printf(sb, "\n\tVolume Change Reference Value:");
6986
6987 switch (vcr_len) {
6988 case 0:
6989 if (error_str != NULL) {
6990 snprintf(error_str, error_str_len, "Volume Change "
6991 "Reference value has length of 0");
6992 }
6993 retval = 1;
6994 goto bailout;
6995 break; /*NOTREACHED*/
6996 case 1:
6997 tmp_val = *cur_ptr;
6998 break;
6999 case 2:
7000 tmp_val = scsi_2btoul(cur_ptr);
7001 break;
7002 case 3:
7003 tmp_val = scsi_3btoul(cur_ptr);
7004 break;
7005 case 4:
7006 tmp_val = scsi_4btoul(cur_ptr);
7007 break;
7008 case 8:
7009 tmp_val = scsi_8btou64(cur_ptr);
7010 break;
7011 default:
7012 sbuf_printf(sb, "\n");
7013 sbuf_hexdump(sb, cur_ptr, vcr_len, NULL, 0);
7014 break;
7015 }
7016 if (vcr_len <= 8)
7017 sbuf_printf(sb, " 0x%jx\n", (uintmax_t)tmp_val);
7018
7019 cur_ptr += vcr_len;
7020 tmp_val = scsi_8btou64(cur_ptr);
7021 sbuf_printf(sb, "\tVolume Coherency Count: %ju\n", (uintmax_t)tmp_val);
7022
7023 cur_ptr += sizeof(tmp_val);
7024 tmp_val = scsi_8btou64(cur_ptr);
7025 sbuf_printf(sb, "\tVolume Coherency Set Identifier: 0x%jx\n",
7026 (uintmax_t)tmp_val);
7027
7028 /*
7029 * Figure out how long the Application Client Specific Information
7030 * is and produce a hexdump.
7031 */
7032 cur_ptr += sizeof(tmp_val);
7033 as_len = scsi_2btoul(cur_ptr);
7034 cur_ptr += sizeof(uint16_t);
7035 sbuf_printf(sb, "\tApplication Client Specific Information: ");
7036 if (((as_len == SCSI_LTFS_VER0_LEN)
7037 || (as_len == SCSI_LTFS_VER1_LEN))
7038 && (strncmp(cur_ptr, SCSI_LTFS_STR_NAME, SCSI_LTFS_STR_LEN) == 0)) {
7039 sbuf_printf(sb, "LTFS\n");
7040 cur_ptr += SCSI_LTFS_STR_LEN + 1;
7041 if (cur_ptr[SCSI_LTFS_UUID_LEN] != '\0')
7042 cur_ptr[SCSI_LTFS_UUID_LEN] = '\0';
7043 sbuf_printf(sb, "\tLTFS UUID: %s\n", cur_ptr);
7044 cur_ptr += SCSI_LTFS_UUID_LEN + 1;
7045 /* XXX KDM check the length */
7046 sbuf_printf(sb, "\tLTFS Version: %d\n", *cur_ptr);
7047 } else {
7048 sbuf_printf(sb, "Unknown\n");
7049 sbuf_hexdump(sb, cur_ptr, as_len, NULL, 0);
7050 }
7051
7052 bailout:
7053 return (retval);
7054 }
7055
7056 int
scsi_attrib_vendser_sbuf(struct sbuf * sb,struct scsi_mam_attribute_header * hdr,uint32_t valid_len,uint32_t flags,uint32_t output_flags,char * error_str,int error_str_len)7057 scsi_attrib_vendser_sbuf(struct sbuf *sb, struct scsi_mam_attribute_header *hdr,
7058 uint32_t valid_len, uint32_t flags,
7059 uint32_t output_flags, char *error_str,
7060 int error_str_len)
7061 {
7062 size_t avail_len;
7063 uint32_t field_size;
7064 struct scsi_attrib_vendser *vendser;
7065 cam_strvis_flags strvis_flags;
7066 int retval = 0;
7067
7068 field_size = scsi_2btoul(hdr->length);
7069 avail_len = valid_len - sizeof(*hdr);
7070 if (field_size > avail_len) {
7071 if (error_str != NULL) {
7072 snprintf(error_str, error_str_len, "Available "
7073 "length of attribute ID 0x%.4x %zu < field "
7074 "length %u", scsi_2btoul(hdr->id), avail_len,
7075 field_size);
7076 }
7077 retval = 1;
7078 goto bailout;
7079 } else if (field_size == 0) {
7080 /*
7081 * A field size of 0 doesn't make sense here. The device
7082 * can at least give you the vendor ID, even if it can't
7083 * give you the serial number.
7084 */
7085 if (error_str != NULL) {
7086 snprintf(error_str, error_str_len, "The length of "
7087 "attribute ID 0x%.4x is 0",
7088 scsi_2btoul(hdr->id));
7089 }
7090 retval = 1;
7091 goto bailout;
7092 }
7093 vendser = (struct scsi_attrib_vendser *)hdr->attribute;
7094
7095 switch (output_flags & SCSI_ATTR_OUTPUT_NONASCII_MASK) {
7096 case SCSI_ATTR_OUTPUT_NONASCII_TRIM:
7097 strvis_flags = CAM_STRVIS_FLAG_NONASCII_TRIM;
7098 break;
7099 case SCSI_ATTR_OUTPUT_NONASCII_RAW:
7100 strvis_flags = CAM_STRVIS_FLAG_NONASCII_RAW;
7101 break;
7102 case SCSI_ATTR_OUTPUT_NONASCII_ESC:
7103 default:
7104 strvis_flags = CAM_STRVIS_FLAG_NONASCII_ESC;
7105 break;;
7106 }
7107 cam_strvis_sbuf(sb, vendser->vendor, sizeof(vendser->vendor),
7108 strvis_flags);
7109 sbuf_putc(sb, ' ');
7110 cam_strvis_sbuf(sb, vendser->serial_num, sizeof(vendser->serial_num),
7111 strvis_flags);
7112 bailout:
7113 return (retval);
7114 }
7115
7116 int
scsi_attrib_hexdump_sbuf(struct sbuf * sb,struct scsi_mam_attribute_header * hdr,uint32_t valid_len,uint32_t flags,uint32_t output_flags,char * error_str,int error_str_len)7117 scsi_attrib_hexdump_sbuf(struct sbuf *sb, struct scsi_mam_attribute_header *hdr,
7118 uint32_t valid_len, uint32_t flags,
7119 uint32_t output_flags, char *error_str,
7120 int error_str_len)
7121 {
7122 uint32_t field_size;
7123 ssize_t avail_len;
7124 uint32_t print_len;
7125 uint8_t *num_ptr;
7126 int retval = 0;
7127
7128 field_size = scsi_2btoul(hdr->length);
7129 avail_len = valid_len - sizeof(*hdr);
7130 print_len = MIN(avail_len, field_size);
7131 num_ptr = hdr->attribute;
7132
7133 if (print_len > 0) {
7134 sbuf_printf(sb, "\n");
7135 sbuf_hexdump(sb, num_ptr, print_len, NULL, 0);
7136 }
7137
7138 return (retval);
7139 }
7140
7141 int
scsi_attrib_int_sbuf(struct sbuf * sb,struct scsi_mam_attribute_header * hdr,uint32_t valid_len,uint32_t flags,uint32_t output_flags,char * error_str,int error_str_len)7142 scsi_attrib_int_sbuf(struct sbuf *sb, struct scsi_mam_attribute_header *hdr,
7143 uint32_t valid_len, uint32_t flags,
7144 uint32_t output_flags, char *error_str,
7145 int error_str_len)
7146 {
7147 uint64_t print_number;
7148 size_t avail_len;
7149 uint32_t number_size;
7150 int retval = 0;
7151
7152 number_size = scsi_2btoul(hdr->length);
7153
7154 avail_len = valid_len - sizeof(*hdr);
7155 if (avail_len < number_size) {
7156 if (error_str != NULL) {
7157 snprintf(error_str, error_str_len, "Available "
7158 "length of attribute ID 0x%.4x %zu < field "
7159 "length %u", scsi_2btoul(hdr->id), avail_len,
7160 number_size);
7161 }
7162 retval = 1;
7163 goto bailout;
7164 }
7165
7166 switch (number_size) {
7167 case 0:
7168 /*
7169 * We don't treat this as an error, since there may be
7170 * scenarios where a device reports a field but then gives
7171 * a length of 0. See the note in scsi_attrib_ascii_sbuf().
7172 */
7173 goto bailout;
7174 break; /*NOTREACHED*/
7175 case 1:
7176 print_number = hdr->attribute[0];
7177 break;
7178 case 2:
7179 print_number = scsi_2btoul(hdr->attribute);
7180 break;
7181 case 3:
7182 print_number = scsi_3btoul(hdr->attribute);
7183 break;
7184 case 4:
7185 print_number = scsi_4btoul(hdr->attribute);
7186 break;
7187 case 8:
7188 print_number = scsi_8btou64(hdr->attribute);
7189 break;
7190 default:
7191 /*
7192 * If we wind up here, the number is too big to print
7193 * normally, so just do a hexdump.
7194 */
7195 retval = scsi_attrib_hexdump_sbuf(sb, hdr, valid_len,
7196 flags, output_flags,
7197 error_str, error_str_len);
7198 goto bailout;
7199 break;
7200 }
7201
7202 if (flags & SCSI_ATTR_FLAG_FP) {
7203 #ifndef _KERNEL
7204 long double num_float;
7205
7206 num_float = (long double)print_number;
7207
7208 if (flags & SCSI_ATTR_FLAG_DIV_10)
7209 num_float /= 10;
7210
7211 sbuf_printf(sb, "%.*Lf", (flags & SCSI_ATTR_FLAG_FP_1DIGIT) ?
7212 1 : 0, num_float);
7213 #else /* _KERNEL */
7214 sbuf_printf(sb, "%ju", (flags & SCSI_ATTR_FLAG_DIV_10) ?
7215 (print_number / 10) : print_number);
7216 #endif /* _KERNEL */
7217 } else if (flags & SCSI_ATTR_FLAG_HEX) {
7218 sbuf_printf(sb, "0x%jx", (uintmax_t)print_number);
7219 } else
7220 sbuf_printf(sb, "%ju", (uintmax_t)print_number);
7221
7222 bailout:
7223 return (retval);
7224 }
7225
7226 int
scsi_attrib_ascii_sbuf(struct sbuf * sb,struct scsi_mam_attribute_header * hdr,uint32_t valid_len,uint32_t flags,uint32_t output_flags,char * error_str,int error_str_len)7227 scsi_attrib_ascii_sbuf(struct sbuf *sb, struct scsi_mam_attribute_header *hdr,
7228 uint32_t valid_len, uint32_t flags,
7229 uint32_t output_flags, char *error_str,
7230 int error_str_len)
7231 {
7232 size_t avail_len;
7233 uint32_t field_size, print_size;
7234 int retval = 0;
7235
7236 avail_len = valid_len - sizeof(*hdr);
7237 field_size = scsi_2btoul(hdr->length);
7238 print_size = MIN(avail_len, field_size);
7239
7240 if (print_size > 0) {
7241 cam_strvis_flags strvis_flags;
7242
7243 switch (output_flags & SCSI_ATTR_OUTPUT_NONASCII_MASK) {
7244 case SCSI_ATTR_OUTPUT_NONASCII_TRIM:
7245 strvis_flags = CAM_STRVIS_FLAG_NONASCII_TRIM;
7246 break;
7247 case SCSI_ATTR_OUTPUT_NONASCII_RAW:
7248 strvis_flags = CAM_STRVIS_FLAG_NONASCII_RAW;
7249 break;
7250 case SCSI_ATTR_OUTPUT_NONASCII_ESC:
7251 default:
7252 strvis_flags = CAM_STRVIS_FLAG_NONASCII_ESC;
7253 break;
7254 }
7255 cam_strvis_sbuf(sb, hdr->attribute, print_size, strvis_flags);
7256 } else if (avail_len < field_size) {
7257 /*
7258 * We only report an error if the user didn't allocate
7259 * enough space to hold the full value of this field. If
7260 * the field length is 0, that is allowed by the spec.
7261 * e.g. in SPC-4r37, section 7.4.2.2.5, VOLUME IDENTIFIER
7262 * "This attribute indicates the current volume identifier
7263 * (see SMC-3) of the medium. If the device server supports
7264 * this attribute but does not have access to the volume
7265 * identifier, the device server shall report this attribute
7266 * with an attribute length value of zero."
7267 */
7268 if (error_str != NULL) {
7269 snprintf(error_str, error_str_len, "Available "
7270 "length of attribute ID 0x%.4x %zu < field "
7271 "length %u", scsi_2btoul(hdr->id), avail_len,
7272 field_size);
7273 }
7274 retval = 1;
7275 }
7276
7277 return (retval);
7278 }
7279
7280 int
scsi_attrib_text_sbuf(struct sbuf * sb,struct scsi_mam_attribute_header * hdr,uint32_t valid_len,uint32_t flags,uint32_t output_flags,char * error_str,int error_str_len)7281 scsi_attrib_text_sbuf(struct sbuf *sb, struct scsi_mam_attribute_header *hdr,
7282 uint32_t valid_len, uint32_t flags,
7283 uint32_t output_flags, char *error_str,
7284 int error_str_len)
7285 {
7286 size_t avail_len;
7287 uint32_t field_size, print_size;
7288 int retval = 0;
7289 int esc_text = 1;
7290
7291 avail_len = valid_len - sizeof(*hdr);
7292 field_size = scsi_2btoul(hdr->length);
7293 print_size = MIN(avail_len, field_size);
7294
7295 if ((output_flags & SCSI_ATTR_OUTPUT_TEXT_MASK) ==
7296 SCSI_ATTR_OUTPUT_TEXT_RAW)
7297 esc_text = 0;
7298
7299 if (print_size > 0) {
7300 uint32_t i;
7301
7302 for (i = 0; i < print_size; i++) {
7303 if (hdr->attribute[i] == '\0')
7304 continue;
7305 else if (((unsigned char)hdr->attribute[i] < 0x80)
7306 || (esc_text == 0))
7307 sbuf_putc(sb, hdr->attribute[i]);
7308 else
7309 sbuf_printf(sb, "%%%02x",
7310 (unsigned char)hdr->attribute[i]);
7311 }
7312 } else if (avail_len < field_size) {
7313 /*
7314 * We only report an error if the user didn't allocate
7315 * enough space to hold the full value of this field.
7316 */
7317 if (error_str != NULL) {
7318 snprintf(error_str, error_str_len, "Available "
7319 "length of attribute ID 0x%.4x %zu < field "
7320 "length %u", scsi_2btoul(hdr->id), avail_len,
7321 field_size);
7322 }
7323 retval = 1;
7324 }
7325
7326 return (retval);
7327 }
7328
7329 struct scsi_attrib_table_entry *
scsi_find_attrib_entry(struct scsi_attrib_table_entry * table,size_t num_table_entries,uint32_t id)7330 scsi_find_attrib_entry(struct scsi_attrib_table_entry *table,
7331 size_t num_table_entries, uint32_t id)
7332 {
7333 uint32_t i;
7334
7335 for (i = 0; i < num_table_entries; i++) {
7336 if (table[i].id == id)
7337 return (&table[i]);
7338 }
7339
7340 return (NULL);
7341 }
7342
7343 struct scsi_attrib_table_entry *
scsi_get_attrib_entry(uint32_t id)7344 scsi_get_attrib_entry(uint32_t id)
7345 {
7346 return (scsi_find_attrib_entry(scsi_mam_attr_table,
7347 nitems(scsi_mam_attr_table), id));
7348 }
7349
7350 int
scsi_attrib_value_sbuf(struct sbuf * sb,uint32_t valid_len,struct scsi_mam_attribute_header * hdr,uint32_t output_flags,char * error_str,size_t error_str_len)7351 scsi_attrib_value_sbuf(struct sbuf *sb, uint32_t valid_len,
7352 struct scsi_mam_attribute_header *hdr, uint32_t output_flags,
7353 char *error_str, size_t error_str_len)
7354 {
7355 int retval;
7356
7357 switch (hdr->byte2 & SMA_FORMAT_MASK) {
7358 case SMA_FORMAT_ASCII:
7359 retval = scsi_attrib_ascii_sbuf(sb, hdr, valid_len,
7360 SCSI_ATTR_FLAG_NONE, output_flags, error_str,error_str_len);
7361 break;
7362 case SMA_FORMAT_BINARY:
7363 if (scsi_2btoul(hdr->length) <= 8)
7364 retval = scsi_attrib_int_sbuf(sb, hdr, valid_len,
7365 SCSI_ATTR_FLAG_NONE, output_flags, error_str,
7366 error_str_len);
7367 else
7368 retval = scsi_attrib_hexdump_sbuf(sb, hdr, valid_len,
7369 SCSI_ATTR_FLAG_NONE, output_flags, error_str,
7370 error_str_len);
7371 break;
7372 case SMA_FORMAT_TEXT:
7373 retval = scsi_attrib_text_sbuf(sb, hdr, valid_len,
7374 SCSI_ATTR_FLAG_NONE, output_flags, error_str,
7375 error_str_len);
7376 break;
7377 default:
7378 if (error_str != NULL) {
7379 snprintf(error_str, error_str_len, "Unknown attribute "
7380 "format 0x%x", hdr->byte2 & SMA_FORMAT_MASK);
7381 }
7382 retval = 1;
7383 goto bailout;
7384 break; /*NOTREACHED*/
7385 }
7386
7387 sbuf_trim(sb);
7388
7389 bailout:
7390
7391 return (retval);
7392 }
7393
7394 void
scsi_attrib_prefix_sbuf(struct sbuf * sb,uint32_t output_flags,struct scsi_mam_attribute_header * hdr,uint32_t valid_len,const char * desc)7395 scsi_attrib_prefix_sbuf(struct sbuf *sb, uint32_t output_flags,
7396 struct scsi_mam_attribute_header *hdr,
7397 uint32_t valid_len, const char *desc)
7398 {
7399 int need_space = 0;
7400 uint32_t len;
7401 uint32_t id;
7402
7403 /*
7404 * We can't do anything if we don't have enough valid data for the
7405 * header.
7406 */
7407 if (valid_len < sizeof(*hdr))
7408 return;
7409
7410 id = scsi_2btoul(hdr->id);
7411 /*
7412 * Note that we print out the value of the attribute listed in the
7413 * header, regardless of whether we actually got that many bytes
7414 * back from the device through the controller. A truncated result
7415 * could be the result of a failure to ask for enough data; the
7416 * header indicates how many bytes are allocated for this attribute
7417 * in the MAM.
7418 */
7419 len = scsi_2btoul(hdr->length);
7420
7421 if ((output_flags & SCSI_ATTR_OUTPUT_FIELD_MASK) ==
7422 SCSI_ATTR_OUTPUT_FIELD_NONE)
7423 return;
7424
7425 if ((output_flags & SCSI_ATTR_OUTPUT_FIELD_DESC)
7426 && (desc != NULL)) {
7427 sbuf_printf(sb, "%s", desc);
7428 need_space = 1;
7429 }
7430
7431 if (output_flags & SCSI_ATTR_OUTPUT_FIELD_NUM) {
7432 sbuf_printf(sb, "%s(0x%.4x)", (need_space) ? " " : "", id);
7433 need_space = 0;
7434 }
7435
7436 if (output_flags & SCSI_ATTR_OUTPUT_FIELD_SIZE) {
7437 sbuf_printf(sb, "%s[%d]", (need_space) ? " " : "", len);
7438 need_space = 0;
7439 }
7440 if (output_flags & SCSI_ATTR_OUTPUT_FIELD_RW) {
7441 sbuf_printf(sb, "%s(%s)", (need_space) ? " " : "",
7442 (hdr->byte2 & SMA_READ_ONLY) ? "RO" : "RW");
7443 }
7444 sbuf_printf(sb, ": ");
7445 }
7446
7447 int
scsi_attrib_sbuf(struct sbuf * sb,struct scsi_mam_attribute_header * hdr,uint32_t valid_len,struct scsi_attrib_table_entry * user_table,size_t num_user_entries,int prefer_user_table,uint32_t output_flags,char * error_str,int error_str_len)7448 scsi_attrib_sbuf(struct sbuf *sb, struct scsi_mam_attribute_header *hdr,
7449 uint32_t valid_len, struct scsi_attrib_table_entry *user_table,
7450 size_t num_user_entries, int prefer_user_table,
7451 uint32_t output_flags, char *error_str, int error_str_len)
7452 {
7453 int retval;
7454 struct scsi_attrib_table_entry *table1 = NULL, *table2 = NULL;
7455 struct scsi_attrib_table_entry *entry = NULL;
7456 size_t table1_size = 0, table2_size = 0;
7457 uint32_t id;
7458
7459 retval = 0;
7460
7461 if (valid_len < sizeof(*hdr)) {
7462 retval = 1;
7463 goto bailout;
7464 }
7465
7466 id = scsi_2btoul(hdr->id);
7467
7468 if (user_table != NULL) {
7469 if (prefer_user_table != 0) {
7470 table1 = user_table;
7471 table1_size = num_user_entries;
7472 table2 = scsi_mam_attr_table;
7473 table2_size = nitems(scsi_mam_attr_table);
7474 } else {
7475 table1 = scsi_mam_attr_table;
7476 table1_size = nitems(scsi_mam_attr_table);
7477 table2 = user_table;
7478 table2_size = num_user_entries;
7479 }
7480 } else {
7481 table1 = scsi_mam_attr_table;
7482 table1_size = nitems(scsi_mam_attr_table);
7483 }
7484
7485 entry = scsi_find_attrib_entry(table1, table1_size, id);
7486 if (entry != NULL) {
7487 scsi_attrib_prefix_sbuf(sb, output_flags, hdr, valid_len,
7488 entry->desc);
7489 if (entry->to_str == NULL)
7490 goto print_default;
7491 retval = entry->to_str(sb, hdr, valid_len, entry->flags,
7492 output_flags, error_str, error_str_len);
7493 goto bailout;
7494 }
7495 if (table2 != NULL) {
7496 entry = scsi_find_attrib_entry(table2, table2_size, id);
7497 if (entry != NULL) {
7498 if (entry->to_str == NULL)
7499 goto print_default;
7500
7501 scsi_attrib_prefix_sbuf(sb, output_flags, hdr,
7502 valid_len, entry->desc);
7503 retval = entry->to_str(sb, hdr, valid_len, entry->flags,
7504 output_flags, error_str,
7505 error_str_len);
7506 goto bailout;
7507 }
7508 }
7509
7510 scsi_attrib_prefix_sbuf(sb, output_flags, hdr, valid_len, NULL);
7511
7512 print_default:
7513 retval = scsi_attrib_value_sbuf(sb, valid_len, hdr, output_flags,
7514 error_str, error_str_len);
7515 bailout:
7516 if (retval == 0) {
7517 if ((entry != NULL)
7518 && (entry->suffix != NULL))
7519 sbuf_printf(sb, " %s", entry->suffix);
7520
7521 sbuf_trim(sb);
7522 sbuf_printf(sb, "\n");
7523 }
7524
7525 return (retval);
7526 }
7527
7528 void
scsi_test_unit_ready(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),u_int8_t tag_action,u_int8_t sense_len,u_int32_t timeout)7529 scsi_test_unit_ready(struct ccb_scsiio *csio, u_int32_t retries,
7530 void (*cbfcnp)(struct cam_periph *, union ccb *),
7531 u_int8_t tag_action, u_int8_t sense_len, u_int32_t timeout)
7532 {
7533 struct scsi_test_unit_ready *scsi_cmd;
7534
7535 cam_fill_csio(csio,
7536 retries,
7537 cbfcnp,
7538 CAM_DIR_NONE,
7539 tag_action,
7540 /*data_ptr*/NULL,
7541 /*dxfer_len*/0,
7542 sense_len,
7543 sizeof(*scsi_cmd),
7544 timeout);
7545
7546 scsi_cmd = (struct scsi_test_unit_ready *)&csio->cdb_io.cdb_bytes;
7547 bzero(scsi_cmd, sizeof(*scsi_cmd));
7548 scsi_cmd->opcode = TEST_UNIT_READY;
7549 }
7550
7551 void
scsi_request_sense(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),void * data_ptr,u_int8_t dxfer_len,u_int8_t tag_action,u_int8_t sense_len,u_int32_t timeout)7552 scsi_request_sense(struct ccb_scsiio *csio, u_int32_t retries,
7553 void (*cbfcnp)(struct cam_periph *, union ccb *),
7554 void *data_ptr, u_int8_t dxfer_len, u_int8_t tag_action,
7555 u_int8_t sense_len, u_int32_t timeout)
7556 {
7557 struct scsi_request_sense *scsi_cmd;
7558
7559 cam_fill_csio(csio,
7560 retries,
7561 cbfcnp,
7562 CAM_DIR_IN,
7563 tag_action,
7564 data_ptr,
7565 dxfer_len,
7566 sense_len,
7567 sizeof(*scsi_cmd),
7568 timeout);
7569
7570 scsi_cmd = (struct scsi_request_sense *)&csio->cdb_io.cdb_bytes;
7571 bzero(scsi_cmd, sizeof(*scsi_cmd));
7572 scsi_cmd->opcode = REQUEST_SENSE;
7573 scsi_cmd->length = dxfer_len;
7574 }
7575
7576 void
scsi_inquiry(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),u_int8_t tag_action,u_int8_t * inq_buf,u_int32_t inq_len,int evpd,u_int8_t page_code,u_int8_t sense_len,u_int32_t timeout)7577 scsi_inquiry(struct ccb_scsiio *csio, u_int32_t retries,
7578 void (*cbfcnp)(struct cam_periph *, union ccb *),
7579 u_int8_t tag_action, u_int8_t *inq_buf, u_int32_t inq_len,
7580 int evpd, u_int8_t page_code, u_int8_t sense_len,
7581 u_int32_t timeout)
7582 {
7583 struct scsi_inquiry *scsi_cmd;
7584
7585 cam_fill_csio(csio,
7586 retries,
7587 cbfcnp,
7588 /*flags*/CAM_DIR_IN,
7589 tag_action,
7590 /*data_ptr*/inq_buf,
7591 /*dxfer_len*/inq_len,
7592 sense_len,
7593 sizeof(*scsi_cmd),
7594 timeout);
7595
7596 scsi_cmd = (struct scsi_inquiry *)&csio->cdb_io.cdb_bytes;
7597 bzero(scsi_cmd, sizeof(*scsi_cmd));
7598 scsi_cmd->opcode = INQUIRY;
7599 if (evpd) {
7600 scsi_cmd->byte2 |= SI_EVPD;
7601 scsi_cmd->page_code = page_code;
7602 }
7603 scsi_ulto2b(inq_len, scsi_cmd->length);
7604 }
7605
7606 void
scsi_mode_sense(struct ccb_scsiio * csio,uint32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),uint8_t tag_action,int dbd,uint8_t pc,uint8_t page,uint8_t * param_buf,uint32_t param_len,uint8_t sense_len,uint32_t timeout)7607 scsi_mode_sense(struct ccb_scsiio *csio, uint32_t retries,
7608 void (*cbfcnp)(struct cam_periph *, union ccb *), uint8_t tag_action,
7609 int dbd, uint8_t pc, uint8_t page, uint8_t *param_buf, uint32_t param_len,
7610 uint8_t sense_len, uint32_t timeout)
7611 {
7612
7613 scsi_mode_sense_subpage(csio, retries, cbfcnp, tag_action, dbd,
7614 pc, page, 0, param_buf, param_len, 0, sense_len, timeout);
7615 }
7616
7617 void
scsi_mode_sense_len(struct ccb_scsiio * csio,uint32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),uint8_t tag_action,int dbd,uint8_t pc,uint8_t page,uint8_t * param_buf,uint32_t param_len,int minimum_cmd_size,uint8_t sense_len,uint32_t timeout)7618 scsi_mode_sense_len(struct ccb_scsiio *csio, uint32_t retries,
7619 void (*cbfcnp)(struct cam_periph *, union ccb *), uint8_t tag_action,
7620 int dbd, uint8_t pc, uint8_t page, uint8_t *param_buf, uint32_t param_len,
7621 int minimum_cmd_size, uint8_t sense_len, uint32_t timeout)
7622 {
7623
7624 scsi_mode_sense_subpage(csio, retries, cbfcnp, tag_action, dbd,
7625 pc, page, 0, param_buf, param_len, minimum_cmd_size,
7626 sense_len, timeout);
7627 }
7628
7629 void
scsi_mode_sense_subpage(struct ccb_scsiio * csio,uint32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),uint8_t tag_action,int dbd,uint8_t pc,uint8_t page,uint8_t subpage,uint8_t * param_buf,uint32_t param_len,int minimum_cmd_size,uint8_t sense_len,uint32_t timeout)7630 scsi_mode_sense_subpage(struct ccb_scsiio *csio, uint32_t retries,
7631 void (*cbfcnp)(struct cam_periph *, union ccb *), uint8_t tag_action,
7632 int dbd, uint8_t pc, uint8_t page, uint8_t subpage, uint8_t *param_buf,
7633 uint32_t param_len, int minimum_cmd_size, uint8_t sense_len,
7634 uint32_t timeout)
7635 {
7636 u_int8_t cdb_len;
7637
7638 /*
7639 * Use the smallest possible command to perform the operation.
7640 */
7641 if ((param_len < 256)
7642 && (minimum_cmd_size < 10)) {
7643 /*
7644 * We can fit in a 6 byte cdb.
7645 */
7646 struct scsi_mode_sense_6 *scsi_cmd;
7647
7648 scsi_cmd = (struct scsi_mode_sense_6 *)&csio->cdb_io.cdb_bytes;
7649 bzero(scsi_cmd, sizeof(*scsi_cmd));
7650 scsi_cmd->opcode = MODE_SENSE_6;
7651 if (dbd != 0)
7652 scsi_cmd->byte2 |= SMS_DBD;
7653 scsi_cmd->page = pc | page;
7654 scsi_cmd->subpage = subpage;
7655 scsi_cmd->length = param_len;
7656 cdb_len = sizeof(*scsi_cmd);
7657 } else {
7658 /*
7659 * Need a 10 byte cdb.
7660 */
7661 struct scsi_mode_sense_10 *scsi_cmd;
7662
7663 scsi_cmd = (struct scsi_mode_sense_10 *)&csio->cdb_io.cdb_bytes;
7664 bzero(scsi_cmd, sizeof(*scsi_cmd));
7665 scsi_cmd->opcode = MODE_SENSE_10;
7666 if (dbd != 0)
7667 scsi_cmd->byte2 |= SMS_DBD;
7668 scsi_cmd->page = pc | page;
7669 scsi_cmd->subpage = subpage;
7670 scsi_ulto2b(param_len, scsi_cmd->length);
7671 cdb_len = sizeof(*scsi_cmd);
7672 }
7673 cam_fill_csio(csio,
7674 retries,
7675 cbfcnp,
7676 CAM_DIR_IN,
7677 tag_action,
7678 param_buf,
7679 param_len,
7680 sense_len,
7681 cdb_len,
7682 timeout);
7683 }
7684
7685 void
scsi_mode_select(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),u_int8_t tag_action,int scsi_page_fmt,int save_pages,u_int8_t * param_buf,u_int32_t param_len,u_int8_t sense_len,u_int32_t timeout)7686 scsi_mode_select(struct ccb_scsiio *csio, u_int32_t retries,
7687 void (*cbfcnp)(struct cam_periph *, union ccb *),
7688 u_int8_t tag_action, int scsi_page_fmt, int save_pages,
7689 u_int8_t *param_buf, u_int32_t param_len, u_int8_t sense_len,
7690 u_int32_t timeout)
7691 {
7692 scsi_mode_select_len(csio, retries, cbfcnp, tag_action,
7693 scsi_page_fmt, save_pages, param_buf,
7694 param_len, 0, sense_len, timeout);
7695 }
7696
7697 void
scsi_mode_select_len(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),u_int8_t tag_action,int scsi_page_fmt,int save_pages,u_int8_t * param_buf,u_int32_t param_len,int minimum_cmd_size,u_int8_t sense_len,u_int32_t timeout)7698 scsi_mode_select_len(struct ccb_scsiio *csio, u_int32_t retries,
7699 void (*cbfcnp)(struct cam_periph *, union ccb *),
7700 u_int8_t tag_action, int scsi_page_fmt, int save_pages,
7701 u_int8_t *param_buf, u_int32_t param_len,
7702 int minimum_cmd_size, u_int8_t sense_len,
7703 u_int32_t timeout)
7704 {
7705 u_int8_t cdb_len;
7706
7707 /*
7708 * Use the smallest possible command to perform the operation.
7709 */
7710 if ((param_len < 256)
7711 && (minimum_cmd_size < 10)) {
7712 /*
7713 * We can fit in a 6 byte cdb.
7714 */
7715 struct scsi_mode_select_6 *scsi_cmd;
7716
7717 scsi_cmd = (struct scsi_mode_select_6 *)&csio->cdb_io.cdb_bytes;
7718 bzero(scsi_cmd, sizeof(*scsi_cmd));
7719 scsi_cmd->opcode = MODE_SELECT_6;
7720 if (scsi_page_fmt != 0)
7721 scsi_cmd->byte2 |= SMS_PF;
7722 if (save_pages != 0)
7723 scsi_cmd->byte2 |= SMS_SP;
7724 scsi_cmd->length = param_len;
7725 cdb_len = sizeof(*scsi_cmd);
7726 } else {
7727 /*
7728 * Need a 10 byte cdb.
7729 */
7730 struct scsi_mode_select_10 *scsi_cmd;
7731
7732 scsi_cmd =
7733 (struct scsi_mode_select_10 *)&csio->cdb_io.cdb_bytes;
7734 bzero(scsi_cmd, sizeof(*scsi_cmd));
7735 scsi_cmd->opcode = MODE_SELECT_10;
7736 if (scsi_page_fmt != 0)
7737 scsi_cmd->byte2 |= SMS_PF;
7738 if (save_pages != 0)
7739 scsi_cmd->byte2 |= SMS_SP;
7740 scsi_ulto2b(param_len, scsi_cmd->length);
7741 cdb_len = sizeof(*scsi_cmd);
7742 }
7743 cam_fill_csio(csio,
7744 retries,
7745 cbfcnp,
7746 CAM_DIR_OUT,
7747 tag_action,
7748 param_buf,
7749 param_len,
7750 sense_len,
7751 cdb_len,
7752 timeout);
7753 }
7754
7755 void
scsi_log_sense(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),u_int8_t tag_action,u_int8_t page_code,u_int8_t page,int save_pages,int ppc,u_int32_t paramptr,u_int8_t * param_buf,u_int32_t param_len,u_int8_t sense_len,u_int32_t timeout)7756 scsi_log_sense(struct ccb_scsiio *csio, u_int32_t retries,
7757 void (*cbfcnp)(struct cam_periph *, union ccb *),
7758 u_int8_t tag_action, u_int8_t page_code, u_int8_t page,
7759 int save_pages, int ppc, u_int32_t paramptr,
7760 u_int8_t *param_buf, u_int32_t param_len, u_int8_t sense_len,
7761 u_int32_t timeout)
7762 {
7763 struct scsi_log_sense *scsi_cmd;
7764 u_int8_t cdb_len;
7765
7766 scsi_cmd = (struct scsi_log_sense *)&csio->cdb_io.cdb_bytes;
7767 bzero(scsi_cmd, sizeof(*scsi_cmd));
7768 scsi_cmd->opcode = LOG_SENSE;
7769 scsi_cmd->page = page_code | page;
7770 if (save_pages != 0)
7771 scsi_cmd->byte2 |= SLS_SP;
7772 if (ppc != 0)
7773 scsi_cmd->byte2 |= SLS_PPC;
7774 scsi_ulto2b(paramptr, scsi_cmd->paramptr);
7775 scsi_ulto2b(param_len, scsi_cmd->length);
7776 cdb_len = sizeof(*scsi_cmd);
7777
7778 cam_fill_csio(csio,
7779 retries,
7780 cbfcnp,
7781 /*flags*/CAM_DIR_IN,
7782 tag_action,
7783 /*data_ptr*/param_buf,
7784 /*dxfer_len*/param_len,
7785 sense_len,
7786 cdb_len,
7787 timeout);
7788 }
7789
7790 void
scsi_log_select(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),u_int8_t tag_action,u_int8_t page_code,int save_pages,int pc_reset,u_int8_t * param_buf,u_int32_t param_len,u_int8_t sense_len,u_int32_t timeout)7791 scsi_log_select(struct ccb_scsiio *csio, u_int32_t retries,
7792 void (*cbfcnp)(struct cam_periph *, union ccb *),
7793 u_int8_t tag_action, u_int8_t page_code, int save_pages,
7794 int pc_reset, u_int8_t *param_buf, u_int32_t param_len,
7795 u_int8_t sense_len, u_int32_t timeout)
7796 {
7797 struct scsi_log_select *scsi_cmd;
7798 u_int8_t cdb_len;
7799
7800 scsi_cmd = (struct scsi_log_select *)&csio->cdb_io.cdb_bytes;
7801 bzero(scsi_cmd, sizeof(*scsi_cmd));
7802 scsi_cmd->opcode = LOG_SELECT;
7803 scsi_cmd->page = page_code & SLS_PAGE_CODE;
7804 if (save_pages != 0)
7805 scsi_cmd->byte2 |= SLS_SP;
7806 if (pc_reset != 0)
7807 scsi_cmd->byte2 |= SLS_PCR;
7808 scsi_ulto2b(param_len, scsi_cmd->length);
7809 cdb_len = sizeof(*scsi_cmd);
7810
7811 cam_fill_csio(csio,
7812 retries,
7813 cbfcnp,
7814 /*flags*/CAM_DIR_OUT,
7815 tag_action,
7816 /*data_ptr*/param_buf,
7817 /*dxfer_len*/param_len,
7818 sense_len,
7819 cdb_len,
7820 timeout);
7821 }
7822
7823 /*
7824 * Prevent or allow the user to remove the media
7825 */
7826 void
scsi_prevent(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),u_int8_t tag_action,u_int8_t action,u_int8_t sense_len,u_int32_t timeout)7827 scsi_prevent(struct ccb_scsiio *csio, u_int32_t retries,
7828 void (*cbfcnp)(struct cam_periph *, union ccb *),
7829 u_int8_t tag_action, u_int8_t action,
7830 u_int8_t sense_len, u_int32_t timeout)
7831 {
7832 struct scsi_prevent *scsi_cmd;
7833
7834 cam_fill_csio(csio,
7835 retries,
7836 cbfcnp,
7837 /*flags*/CAM_DIR_NONE,
7838 tag_action,
7839 /*data_ptr*/NULL,
7840 /*dxfer_len*/0,
7841 sense_len,
7842 sizeof(*scsi_cmd),
7843 timeout);
7844
7845 scsi_cmd = (struct scsi_prevent *)&csio->cdb_io.cdb_bytes;
7846 bzero(scsi_cmd, sizeof(*scsi_cmd));
7847 scsi_cmd->opcode = PREVENT_ALLOW;
7848 scsi_cmd->how = action;
7849 }
7850
7851 /* XXX allow specification of address and PMI bit and LBA */
7852 void
scsi_read_capacity(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),u_int8_t tag_action,struct scsi_read_capacity_data * rcap_buf,u_int8_t sense_len,u_int32_t timeout)7853 scsi_read_capacity(struct ccb_scsiio *csio, u_int32_t retries,
7854 void (*cbfcnp)(struct cam_periph *, union ccb *),
7855 u_int8_t tag_action,
7856 struct scsi_read_capacity_data *rcap_buf,
7857 u_int8_t sense_len, u_int32_t timeout)
7858 {
7859 struct scsi_read_capacity *scsi_cmd;
7860
7861 cam_fill_csio(csio,
7862 retries,
7863 cbfcnp,
7864 /*flags*/CAM_DIR_IN,
7865 tag_action,
7866 /*data_ptr*/(u_int8_t *)rcap_buf,
7867 /*dxfer_len*/sizeof(*rcap_buf),
7868 sense_len,
7869 sizeof(*scsi_cmd),
7870 timeout);
7871
7872 scsi_cmd = (struct scsi_read_capacity *)&csio->cdb_io.cdb_bytes;
7873 bzero(scsi_cmd, sizeof(*scsi_cmd));
7874 scsi_cmd->opcode = READ_CAPACITY;
7875 }
7876
7877 void
scsi_read_capacity_16(struct ccb_scsiio * csio,uint32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),uint8_t tag_action,uint64_t lba,int reladr,int pmi,uint8_t * rcap_buf,int rcap_buf_len,uint8_t sense_len,uint32_t timeout)7878 scsi_read_capacity_16(struct ccb_scsiio *csio, uint32_t retries,
7879 void (*cbfcnp)(struct cam_periph *, union ccb *),
7880 uint8_t tag_action, uint64_t lba, int reladr, int pmi,
7881 uint8_t *rcap_buf, int rcap_buf_len, uint8_t sense_len,
7882 uint32_t timeout)
7883 {
7884 struct scsi_read_capacity_16 *scsi_cmd;
7885
7886
7887 cam_fill_csio(csio,
7888 retries,
7889 cbfcnp,
7890 /*flags*/CAM_DIR_IN,
7891 tag_action,
7892 /*data_ptr*/(u_int8_t *)rcap_buf,
7893 /*dxfer_len*/rcap_buf_len,
7894 sense_len,
7895 sizeof(*scsi_cmd),
7896 timeout);
7897 scsi_cmd = (struct scsi_read_capacity_16 *)&csio->cdb_io.cdb_bytes;
7898 bzero(scsi_cmd, sizeof(*scsi_cmd));
7899 scsi_cmd->opcode = SERVICE_ACTION_IN;
7900 scsi_cmd->service_action = SRC16_SERVICE_ACTION;
7901 scsi_u64to8b(lba, scsi_cmd->addr);
7902 scsi_ulto4b(rcap_buf_len, scsi_cmd->alloc_len);
7903 if (pmi)
7904 reladr |= SRC16_PMI;
7905 if (reladr)
7906 reladr |= SRC16_RELADR;
7907 }
7908
7909 void
scsi_report_luns(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),u_int8_t tag_action,u_int8_t select_report,struct scsi_report_luns_data * rpl_buf,u_int32_t alloc_len,u_int8_t sense_len,u_int32_t timeout)7910 scsi_report_luns(struct ccb_scsiio *csio, u_int32_t retries,
7911 void (*cbfcnp)(struct cam_periph *, union ccb *),
7912 u_int8_t tag_action, u_int8_t select_report,
7913 struct scsi_report_luns_data *rpl_buf, u_int32_t alloc_len,
7914 u_int8_t sense_len, u_int32_t timeout)
7915 {
7916 struct scsi_report_luns *scsi_cmd;
7917
7918 cam_fill_csio(csio,
7919 retries,
7920 cbfcnp,
7921 /*flags*/CAM_DIR_IN,
7922 tag_action,
7923 /*data_ptr*/(u_int8_t *)rpl_buf,
7924 /*dxfer_len*/alloc_len,
7925 sense_len,
7926 sizeof(*scsi_cmd),
7927 timeout);
7928 scsi_cmd = (struct scsi_report_luns *)&csio->cdb_io.cdb_bytes;
7929 bzero(scsi_cmd, sizeof(*scsi_cmd));
7930 scsi_cmd->opcode = REPORT_LUNS;
7931 scsi_cmd->select_report = select_report;
7932 scsi_ulto4b(alloc_len, scsi_cmd->length);
7933 }
7934
7935 void
scsi_report_target_group(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),u_int8_t tag_action,u_int8_t pdf,void * buf,u_int32_t alloc_len,u_int8_t sense_len,u_int32_t timeout)7936 scsi_report_target_group(struct ccb_scsiio *csio, u_int32_t retries,
7937 void (*cbfcnp)(struct cam_periph *, union ccb *),
7938 u_int8_t tag_action, u_int8_t pdf,
7939 void *buf, u_int32_t alloc_len,
7940 u_int8_t sense_len, u_int32_t timeout)
7941 {
7942 struct scsi_target_group *scsi_cmd;
7943
7944 cam_fill_csio(csio,
7945 retries,
7946 cbfcnp,
7947 /*flags*/CAM_DIR_IN,
7948 tag_action,
7949 /*data_ptr*/(u_int8_t *)buf,
7950 /*dxfer_len*/alloc_len,
7951 sense_len,
7952 sizeof(*scsi_cmd),
7953 timeout);
7954 scsi_cmd = (struct scsi_target_group *)&csio->cdb_io.cdb_bytes;
7955 bzero(scsi_cmd, sizeof(*scsi_cmd));
7956 scsi_cmd->opcode = MAINTENANCE_IN;
7957 scsi_cmd->service_action = REPORT_TARGET_PORT_GROUPS | pdf;
7958 scsi_ulto4b(alloc_len, scsi_cmd->length);
7959 }
7960
7961 void
scsi_report_timestamp(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),u_int8_t tag_action,u_int8_t pdf,void * buf,u_int32_t alloc_len,u_int8_t sense_len,u_int32_t timeout)7962 scsi_report_timestamp(struct ccb_scsiio *csio, u_int32_t retries,
7963 void (*cbfcnp)(struct cam_periph *, union ccb *),
7964 u_int8_t tag_action, u_int8_t pdf,
7965 void *buf, u_int32_t alloc_len,
7966 u_int8_t sense_len, u_int32_t timeout)
7967 {
7968 struct scsi_timestamp *scsi_cmd;
7969
7970 cam_fill_csio(csio,
7971 retries,
7972 cbfcnp,
7973 /*flags*/CAM_DIR_IN,
7974 tag_action,
7975 /*data_ptr*/(u_int8_t *)buf,
7976 /*dxfer_len*/alloc_len,
7977 sense_len,
7978 sizeof(*scsi_cmd),
7979 timeout);
7980 scsi_cmd = (struct scsi_timestamp *)&csio->cdb_io.cdb_bytes;
7981 bzero(scsi_cmd, sizeof(*scsi_cmd));
7982 scsi_cmd->opcode = MAINTENANCE_IN;
7983 scsi_cmd->service_action = REPORT_TIMESTAMP | pdf;
7984 scsi_ulto4b(alloc_len, scsi_cmd->length);
7985 }
7986
7987 void
scsi_set_target_group(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),u_int8_t tag_action,void * buf,u_int32_t alloc_len,u_int8_t sense_len,u_int32_t timeout)7988 scsi_set_target_group(struct ccb_scsiio *csio, u_int32_t retries,
7989 void (*cbfcnp)(struct cam_periph *, union ccb *),
7990 u_int8_t tag_action, void *buf, u_int32_t alloc_len,
7991 u_int8_t sense_len, u_int32_t timeout)
7992 {
7993 struct scsi_target_group *scsi_cmd;
7994
7995 cam_fill_csio(csio,
7996 retries,
7997 cbfcnp,
7998 /*flags*/CAM_DIR_OUT,
7999 tag_action,
8000 /*data_ptr*/(u_int8_t *)buf,
8001 /*dxfer_len*/alloc_len,
8002 sense_len,
8003 sizeof(*scsi_cmd),
8004 timeout);
8005 scsi_cmd = (struct scsi_target_group *)&csio->cdb_io.cdb_bytes;
8006 bzero(scsi_cmd, sizeof(*scsi_cmd));
8007 scsi_cmd->opcode = MAINTENANCE_OUT;
8008 scsi_cmd->service_action = SET_TARGET_PORT_GROUPS;
8009 scsi_ulto4b(alloc_len, scsi_cmd->length);
8010 }
8011
8012 void
scsi_create_timestamp(uint8_t * timestamp_6b_buf,uint64_t timestamp)8013 scsi_create_timestamp(uint8_t *timestamp_6b_buf,
8014 uint64_t timestamp)
8015 {
8016 uint8_t buf[8];
8017 scsi_u64to8b(timestamp, buf);
8018 /*
8019 * Using memcopy starting at buf[2] because the set timestamp parameters
8020 * only has six bytes for the timestamp to fit into, and we don't have a
8021 * scsi_u64to6b function.
8022 */
8023 memcpy(timestamp_6b_buf, &buf[2], 6);
8024 }
8025
8026 void
scsi_set_timestamp(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),u_int8_t tag_action,void * buf,u_int32_t alloc_len,u_int8_t sense_len,u_int32_t timeout)8027 scsi_set_timestamp(struct ccb_scsiio *csio, u_int32_t retries,
8028 void (*cbfcnp)(struct cam_periph *, union ccb *),
8029 u_int8_t tag_action, void *buf, u_int32_t alloc_len,
8030 u_int8_t sense_len, u_int32_t timeout)
8031 {
8032 struct scsi_timestamp *scsi_cmd;
8033
8034 cam_fill_csio(csio,
8035 retries,
8036 cbfcnp,
8037 /*flags*/CAM_DIR_OUT,
8038 tag_action,
8039 /*data_ptr*/(u_int8_t *) buf,
8040 /*dxfer_len*/alloc_len,
8041 sense_len,
8042 sizeof(*scsi_cmd),
8043 timeout);
8044 scsi_cmd = (struct scsi_timestamp *)&csio->cdb_io.cdb_bytes;
8045 bzero(scsi_cmd, sizeof(*scsi_cmd));
8046 scsi_cmd->opcode = MAINTENANCE_OUT;
8047 scsi_cmd->service_action = SET_TIMESTAMP;
8048 scsi_ulto4b(alloc_len, scsi_cmd->length);
8049 }
8050
8051 /*
8052 * Syncronize the media to the contents of the cache for
8053 * the given lba/count pair. Specifying 0/0 means sync
8054 * the whole cache.
8055 */
8056 void
scsi_synchronize_cache(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),u_int8_t tag_action,u_int32_t begin_lba,u_int16_t lb_count,u_int8_t sense_len,u_int32_t timeout)8057 scsi_synchronize_cache(struct ccb_scsiio *csio, u_int32_t retries,
8058 void (*cbfcnp)(struct cam_periph *, union ccb *),
8059 u_int8_t tag_action, u_int32_t begin_lba,
8060 u_int16_t lb_count, u_int8_t sense_len,
8061 u_int32_t timeout)
8062 {
8063 struct scsi_sync_cache *scsi_cmd;
8064
8065 cam_fill_csio(csio,
8066 retries,
8067 cbfcnp,
8068 /*flags*/CAM_DIR_NONE,
8069 tag_action,
8070 /*data_ptr*/NULL,
8071 /*dxfer_len*/0,
8072 sense_len,
8073 sizeof(*scsi_cmd),
8074 timeout);
8075
8076 scsi_cmd = (struct scsi_sync_cache *)&csio->cdb_io.cdb_bytes;
8077 bzero(scsi_cmd, sizeof(*scsi_cmd));
8078 scsi_cmd->opcode = SYNCHRONIZE_CACHE;
8079 scsi_ulto4b(begin_lba, scsi_cmd->begin_lba);
8080 scsi_ulto2b(lb_count, scsi_cmd->lb_count);
8081 }
8082
8083 void
scsi_read_write(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),u_int8_t tag_action,int readop,u_int8_t byte2,int minimum_cmd_size,u_int64_t lba,u_int32_t block_count,u_int8_t * data_ptr,u_int32_t dxfer_len,u_int8_t sense_len,u_int32_t timeout)8084 scsi_read_write(struct ccb_scsiio *csio, u_int32_t retries,
8085 void (*cbfcnp)(struct cam_periph *, union ccb *),
8086 u_int8_t tag_action, int readop, u_int8_t byte2,
8087 int minimum_cmd_size, u_int64_t lba, u_int32_t block_count,
8088 u_int8_t *data_ptr, u_int32_t dxfer_len, u_int8_t sense_len,
8089 u_int32_t timeout)
8090 {
8091 int read;
8092 u_int8_t cdb_len;
8093
8094 read = (readop & SCSI_RW_DIRMASK) == SCSI_RW_READ;
8095
8096 /*
8097 * Use the smallest possible command to perform the operation
8098 * as some legacy hardware does not support the 10 byte commands.
8099 * If any of the bits in byte2 is set, we have to go with a larger
8100 * command.
8101 */
8102 if ((minimum_cmd_size < 10)
8103 && ((lba & 0x1fffff) == lba)
8104 && ((block_count & 0xff) == block_count)
8105 && (byte2 == 0)) {
8106 /*
8107 * We can fit in a 6 byte cdb.
8108 */
8109 struct scsi_rw_6 *scsi_cmd;
8110
8111 scsi_cmd = (struct scsi_rw_6 *)&csio->cdb_io.cdb_bytes;
8112 scsi_cmd->opcode = read ? READ_6 : WRITE_6;
8113 scsi_ulto3b(lba, scsi_cmd->addr);
8114 scsi_cmd->length = block_count & 0xff;
8115 scsi_cmd->control = 0;
8116 cdb_len = sizeof(*scsi_cmd);
8117
8118 CAM_DEBUG(csio->ccb_h.path, CAM_DEBUG_SUBTRACE,
8119 ("6byte: %x%x%x:%d:%d\n", scsi_cmd->addr[0],
8120 scsi_cmd->addr[1], scsi_cmd->addr[2],
8121 scsi_cmd->length, dxfer_len));
8122 } else if ((minimum_cmd_size < 12)
8123 && ((block_count & 0xffff) == block_count)
8124 && ((lba & 0xffffffff) == lba)) {
8125 /*
8126 * Need a 10 byte cdb.
8127 */
8128 struct scsi_rw_10 *scsi_cmd;
8129
8130 scsi_cmd = (struct scsi_rw_10 *)&csio->cdb_io.cdb_bytes;
8131 scsi_cmd->opcode = read ? READ_10 : WRITE_10;
8132 scsi_cmd->byte2 = byte2;
8133 scsi_ulto4b(lba, scsi_cmd->addr);
8134 scsi_cmd->reserved = 0;
8135 scsi_ulto2b(block_count, scsi_cmd->length);
8136 scsi_cmd->control = 0;
8137 cdb_len = sizeof(*scsi_cmd);
8138
8139 CAM_DEBUG(csio->ccb_h.path, CAM_DEBUG_SUBTRACE,
8140 ("10byte: %x%x%x%x:%x%x: %d\n", scsi_cmd->addr[0],
8141 scsi_cmd->addr[1], scsi_cmd->addr[2],
8142 scsi_cmd->addr[3], scsi_cmd->length[0],
8143 scsi_cmd->length[1], dxfer_len));
8144 } else if ((minimum_cmd_size < 16)
8145 && ((block_count & 0xffffffff) == block_count)
8146 && ((lba & 0xffffffff) == lba)) {
8147 /*
8148 * The block count is too big for a 10 byte CDB, use a 12
8149 * byte CDB.
8150 */
8151 struct scsi_rw_12 *scsi_cmd;
8152
8153 scsi_cmd = (struct scsi_rw_12 *)&csio->cdb_io.cdb_bytes;
8154 scsi_cmd->opcode = read ? READ_12 : WRITE_12;
8155 scsi_cmd->byte2 = byte2;
8156 scsi_ulto4b(lba, scsi_cmd->addr);
8157 scsi_cmd->reserved = 0;
8158 scsi_ulto4b(block_count, scsi_cmd->length);
8159 scsi_cmd->control = 0;
8160 cdb_len = sizeof(*scsi_cmd);
8161
8162 CAM_DEBUG(csio->ccb_h.path, CAM_DEBUG_SUBTRACE,
8163 ("12byte: %x%x%x%x:%x%x%x%x: %d\n", scsi_cmd->addr[0],
8164 scsi_cmd->addr[1], scsi_cmd->addr[2],
8165 scsi_cmd->addr[3], scsi_cmd->length[0],
8166 scsi_cmd->length[1], scsi_cmd->length[2],
8167 scsi_cmd->length[3], dxfer_len));
8168 } else {
8169 /*
8170 * 16 byte CDB. We'll only get here if the LBA is larger
8171 * than 2^32, or if the user asks for a 16 byte command.
8172 */
8173 struct scsi_rw_16 *scsi_cmd;
8174
8175 scsi_cmd = (struct scsi_rw_16 *)&csio->cdb_io.cdb_bytes;
8176 scsi_cmd->opcode = read ? READ_16 : WRITE_16;
8177 scsi_cmd->byte2 = byte2;
8178 scsi_u64to8b(lba, scsi_cmd->addr);
8179 scsi_cmd->reserved = 0;
8180 scsi_ulto4b(block_count, scsi_cmd->length);
8181 scsi_cmd->control = 0;
8182 cdb_len = sizeof(*scsi_cmd);
8183 }
8184 cam_fill_csio(csio,
8185 retries,
8186 cbfcnp,
8187 (read ? CAM_DIR_IN : CAM_DIR_OUT) |
8188 ((readop & SCSI_RW_BIO) != 0 ? CAM_DATA_BIO : 0),
8189 tag_action,
8190 data_ptr,
8191 dxfer_len,
8192 sense_len,
8193 cdb_len,
8194 timeout);
8195 }
8196
8197 void
scsi_write_same(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),u_int8_t tag_action,u_int8_t byte2,int minimum_cmd_size,u_int64_t lba,u_int32_t block_count,u_int8_t * data_ptr,u_int32_t dxfer_len,u_int8_t sense_len,u_int32_t timeout)8198 scsi_write_same(struct ccb_scsiio *csio, u_int32_t retries,
8199 void (*cbfcnp)(struct cam_periph *, union ccb *),
8200 u_int8_t tag_action, u_int8_t byte2,
8201 int minimum_cmd_size, u_int64_t lba, u_int32_t block_count,
8202 u_int8_t *data_ptr, u_int32_t dxfer_len, u_int8_t sense_len,
8203 u_int32_t timeout)
8204 {
8205 u_int8_t cdb_len;
8206 if ((minimum_cmd_size < 16) &&
8207 ((block_count & 0xffff) == block_count) &&
8208 ((lba & 0xffffffff) == lba)) {
8209 /*
8210 * Need a 10 byte cdb.
8211 */
8212 struct scsi_write_same_10 *scsi_cmd;
8213
8214 scsi_cmd = (struct scsi_write_same_10 *)&csio->cdb_io.cdb_bytes;
8215 scsi_cmd->opcode = WRITE_SAME_10;
8216 scsi_cmd->byte2 = byte2;
8217 scsi_ulto4b(lba, scsi_cmd->addr);
8218 scsi_cmd->group = 0;
8219 scsi_ulto2b(block_count, scsi_cmd->length);
8220 scsi_cmd->control = 0;
8221 cdb_len = sizeof(*scsi_cmd);
8222
8223 CAM_DEBUG(csio->ccb_h.path, CAM_DEBUG_SUBTRACE,
8224 ("10byte: %x%x%x%x:%x%x: %d\n", scsi_cmd->addr[0],
8225 scsi_cmd->addr[1], scsi_cmd->addr[2],
8226 scsi_cmd->addr[3], scsi_cmd->length[0],
8227 scsi_cmd->length[1], dxfer_len));
8228 } else {
8229 /*
8230 * 16 byte CDB. We'll only get here if the LBA is larger
8231 * than 2^32, or if the user asks for a 16 byte command.
8232 */
8233 struct scsi_write_same_16 *scsi_cmd;
8234
8235 scsi_cmd = (struct scsi_write_same_16 *)&csio->cdb_io.cdb_bytes;
8236 scsi_cmd->opcode = WRITE_SAME_16;
8237 scsi_cmd->byte2 = byte2;
8238 scsi_u64to8b(lba, scsi_cmd->addr);
8239 scsi_ulto4b(block_count, scsi_cmd->length);
8240 scsi_cmd->group = 0;
8241 scsi_cmd->control = 0;
8242 cdb_len = sizeof(*scsi_cmd);
8243
8244 CAM_DEBUG(csio->ccb_h.path, CAM_DEBUG_SUBTRACE,
8245 ("16byte: %x%x%x%x%x%x%x%x:%x%x%x%x: %d\n",
8246 scsi_cmd->addr[0], scsi_cmd->addr[1],
8247 scsi_cmd->addr[2], scsi_cmd->addr[3],
8248 scsi_cmd->addr[4], scsi_cmd->addr[5],
8249 scsi_cmd->addr[6], scsi_cmd->addr[7],
8250 scsi_cmd->length[0], scsi_cmd->length[1],
8251 scsi_cmd->length[2], scsi_cmd->length[3],
8252 dxfer_len));
8253 }
8254 cam_fill_csio(csio,
8255 retries,
8256 cbfcnp,
8257 /*flags*/CAM_DIR_OUT,
8258 tag_action,
8259 data_ptr,
8260 dxfer_len,
8261 sense_len,
8262 cdb_len,
8263 timeout);
8264 }
8265
8266 void
scsi_ata_identify(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),u_int8_t tag_action,u_int8_t * data_ptr,u_int16_t dxfer_len,u_int8_t sense_len,u_int32_t timeout)8267 scsi_ata_identify(struct ccb_scsiio *csio, u_int32_t retries,
8268 void (*cbfcnp)(struct cam_periph *, union ccb *),
8269 u_int8_t tag_action, u_int8_t *data_ptr,
8270 u_int16_t dxfer_len, u_int8_t sense_len,
8271 u_int32_t timeout)
8272 {
8273 scsi_ata_pass(csio,
8274 retries,
8275 cbfcnp,
8276 /*flags*/CAM_DIR_IN,
8277 tag_action,
8278 /*protocol*/AP_PROTO_PIO_IN,
8279 /*ata_flags*/AP_FLAG_TDIR_FROM_DEV |
8280 AP_FLAG_BYT_BLOK_BLOCKS |
8281 AP_FLAG_TLEN_SECT_CNT,
8282 /*features*/0,
8283 /*sector_count*/dxfer_len / 512,
8284 /*lba*/0,
8285 /*command*/ATA_ATA_IDENTIFY,
8286 /*device*/ 0,
8287 /*icc*/ 0,
8288 /*auxiliary*/ 0,
8289 /*control*/0,
8290 data_ptr,
8291 dxfer_len,
8292 /*cdb_storage*/ NULL,
8293 /*cdb_storage_len*/ 0,
8294 /*minimum_cmd_size*/ 0,
8295 sense_len,
8296 timeout);
8297 }
8298
8299 void
scsi_ata_trim(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),u_int8_t tag_action,u_int16_t block_count,u_int8_t * data_ptr,u_int16_t dxfer_len,u_int8_t sense_len,u_int32_t timeout)8300 scsi_ata_trim(struct ccb_scsiio *csio, u_int32_t retries,
8301 void (*cbfcnp)(struct cam_periph *, union ccb *),
8302 u_int8_t tag_action, u_int16_t block_count,
8303 u_int8_t *data_ptr, u_int16_t dxfer_len, u_int8_t sense_len,
8304 u_int32_t timeout)
8305 {
8306 scsi_ata_pass_16(csio,
8307 retries,
8308 cbfcnp,
8309 /*flags*/CAM_DIR_OUT,
8310 tag_action,
8311 /*protocol*/AP_EXTEND|AP_PROTO_DMA,
8312 /*ata_flags*/AP_FLAG_TLEN_SECT_CNT|AP_FLAG_BYT_BLOK_BLOCKS,
8313 /*features*/ATA_DSM_TRIM,
8314 /*sector_count*/block_count,
8315 /*lba*/0,
8316 /*command*/ATA_DATA_SET_MANAGEMENT,
8317 /*control*/0,
8318 data_ptr,
8319 dxfer_len,
8320 sense_len,
8321 timeout);
8322 }
8323
8324 int
scsi_ata_read_log(struct ccb_scsiio * csio,uint32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),uint8_t tag_action,uint32_t log_address,uint32_t page_number,uint16_t block_count,uint8_t protocol,uint8_t * data_ptr,uint32_t dxfer_len,uint8_t sense_len,uint32_t timeout)8325 scsi_ata_read_log(struct ccb_scsiio *csio, uint32_t retries,
8326 void (*cbfcnp)(struct cam_periph *, union ccb *),
8327 uint8_t tag_action, uint32_t log_address,
8328 uint32_t page_number, uint16_t block_count,
8329 uint8_t protocol, uint8_t *data_ptr, uint32_t dxfer_len,
8330 uint8_t sense_len, uint32_t timeout)
8331 {
8332 uint8_t command, protocol_out;
8333 uint16_t count_out;
8334 uint64_t lba;
8335 int retval;
8336
8337 retval = 0;
8338
8339 switch (protocol) {
8340 case AP_PROTO_DMA:
8341 count_out = block_count;
8342 command = ATA_READ_LOG_DMA_EXT;
8343 protocol_out = AP_PROTO_DMA;
8344 break;
8345 case AP_PROTO_PIO_IN:
8346 default:
8347 count_out = block_count;
8348 command = ATA_READ_LOG_EXT;
8349 protocol_out = AP_PROTO_PIO_IN;
8350 break;
8351 }
8352
8353 lba = (((uint64_t)page_number & 0xff00) << 32) |
8354 ((page_number & 0x00ff) << 8) |
8355 (log_address & 0xff);
8356
8357 protocol_out |= AP_EXTEND;
8358
8359 retval = scsi_ata_pass(csio,
8360 retries,
8361 cbfcnp,
8362 /*flags*/CAM_DIR_IN,
8363 tag_action,
8364 /*protocol*/ protocol_out,
8365 /*ata_flags*/AP_FLAG_TLEN_SECT_CNT |
8366 AP_FLAG_BYT_BLOK_BLOCKS |
8367 AP_FLAG_TDIR_FROM_DEV,
8368 /*feature*/ 0,
8369 /*sector_count*/ count_out,
8370 /*lba*/ lba,
8371 /*command*/ command,
8372 /*device*/ 0,
8373 /*icc*/ 0,
8374 /*auxiliary*/ 0,
8375 /*control*/0,
8376 data_ptr,
8377 dxfer_len,
8378 /*cdb_storage*/ NULL,
8379 /*cdb_storage_len*/ 0,
8380 /*minimum_cmd_size*/ 0,
8381 sense_len,
8382 timeout);
8383
8384 return (retval);
8385 }
8386
8387 /*
8388 * Note! This is an unusual CDB building function because it can return
8389 * an error in the event that the command in question requires a variable
8390 * length CDB, but the caller has not given storage space for one or has not
8391 * given enough storage space. If there is enough space available in the
8392 * standard SCSI CCB CDB bytes, we'll prefer that over passed in storage.
8393 */
8394 int
scsi_ata_pass(struct ccb_scsiio * csio,uint32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),uint32_t flags,uint8_t tag_action,uint8_t protocol,uint8_t ata_flags,uint16_t features,uint16_t sector_count,uint64_t lba,uint8_t command,uint8_t device,uint8_t icc,uint32_t auxiliary,uint8_t control,u_int8_t * data_ptr,uint32_t dxfer_len,uint8_t * cdb_storage,size_t cdb_storage_len,int minimum_cmd_size,u_int8_t sense_len,u_int32_t timeout)8395 scsi_ata_pass(struct ccb_scsiio *csio, uint32_t retries,
8396 void (*cbfcnp)(struct cam_periph *, union ccb *),
8397 uint32_t flags, uint8_t tag_action,
8398 uint8_t protocol, uint8_t ata_flags, uint16_t features,
8399 uint16_t sector_count, uint64_t lba, uint8_t command,
8400 uint8_t device, uint8_t icc, uint32_t auxiliary,
8401 uint8_t control, u_int8_t *data_ptr, uint32_t dxfer_len,
8402 uint8_t *cdb_storage, size_t cdb_storage_len,
8403 int minimum_cmd_size, u_int8_t sense_len, u_int32_t timeout)
8404 {
8405 uint32_t cam_flags;
8406 uint8_t *cdb_ptr;
8407 int cmd_size;
8408 int retval;
8409 uint8_t cdb_len;
8410
8411 retval = 0;
8412 cam_flags = flags;
8413
8414 /*
8415 * Round the user's request to the nearest command size that is at
8416 * least as big as what he requested.
8417 */
8418 if (minimum_cmd_size <= 12)
8419 cmd_size = 12;
8420 else if (minimum_cmd_size > 16)
8421 cmd_size = 32;
8422 else
8423 cmd_size = 16;
8424
8425 /*
8426 * If we have parameters that require a 48-bit ATA command, we have to
8427 * use the 16 byte ATA PASS-THROUGH command at least.
8428 */
8429 if (((lba > ATA_MAX_28BIT_LBA)
8430 || (sector_count > 255)
8431 || (features > 255)
8432 || (protocol & AP_EXTEND))
8433 && ((cmd_size < 16)
8434 || ((protocol & AP_EXTEND) == 0))) {
8435 if (cmd_size < 16)
8436 cmd_size = 16;
8437 protocol |= AP_EXTEND;
8438 }
8439
8440 /*
8441 * The icc and auxiliary ATA registers are only supported in the
8442 * 32-byte version of the ATA PASS-THROUGH command.
8443 */
8444 if ((icc != 0)
8445 || (auxiliary != 0)) {
8446 cmd_size = 32;
8447 protocol |= AP_EXTEND;
8448 }
8449
8450
8451 if ((cmd_size > sizeof(csio->cdb_io.cdb_bytes))
8452 && ((cdb_storage == NULL)
8453 || (cdb_storage_len < cmd_size))) {
8454 retval = 1;
8455 goto bailout;
8456 }
8457
8458 /*
8459 * At this point we know we have enough space to store the command
8460 * in one place or another. We prefer the built-in array, but used
8461 * the passed in storage if necessary.
8462 */
8463 if (cmd_size <= sizeof(csio->cdb_io.cdb_bytes))
8464 cdb_ptr = csio->cdb_io.cdb_bytes;
8465 else {
8466 cdb_ptr = cdb_storage;
8467 cam_flags |= CAM_CDB_POINTER;
8468 }
8469
8470 if (cmd_size <= 12) {
8471 struct ata_pass_12 *cdb;
8472
8473 cdb = (struct ata_pass_12 *)cdb_ptr;
8474 cdb_len = sizeof(*cdb);
8475 bzero(cdb, cdb_len);
8476
8477 cdb->opcode = ATA_PASS_12;
8478 cdb->protocol = protocol;
8479 cdb->flags = ata_flags;
8480 cdb->features = features;
8481 cdb->sector_count = sector_count;
8482 cdb->lba_low = lba & 0xff;
8483 cdb->lba_mid = (lba >> 8) & 0xff;
8484 cdb->lba_high = (lba >> 16) & 0xff;
8485 cdb->device = ((lba >> 24) & 0xf) | ATA_DEV_LBA;
8486 cdb->command = command;
8487 cdb->control = control;
8488 } else if (cmd_size <= 16) {
8489 struct ata_pass_16 *cdb;
8490
8491 cdb = (struct ata_pass_16 *)cdb_ptr;
8492 cdb_len = sizeof(*cdb);
8493 bzero(cdb, cdb_len);
8494
8495 cdb->opcode = ATA_PASS_16;
8496 cdb->protocol = protocol;
8497 cdb->flags = ata_flags;
8498 cdb->features = features & 0xff;
8499 cdb->sector_count = sector_count & 0xff;
8500 cdb->lba_low = lba & 0xff;
8501 cdb->lba_mid = (lba >> 8) & 0xff;
8502 cdb->lba_high = (lba >> 16) & 0xff;
8503 /*
8504 * If AP_EXTEND is set, we're sending a 48-bit command.
8505 * Otherwise it's a 28-bit command.
8506 */
8507 if (protocol & AP_EXTEND) {
8508 cdb->lba_low_ext = (lba >> 24) & 0xff;
8509 cdb->lba_mid_ext = (lba >> 32) & 0xff;
8510 cdb->lba_high_ext = (lba >> 40) & 0xff;
8511 cdb->features_ext = (features >> 8) & 0xff;
8512 cdb->sector_count_ext = (sector_count >> 8) & 0xff;
8513 cdb->device = device | ATA_DEV_LBA;
8514 } else {
8515 cdb->lba_low_ext = (lba >> 24) & 0xf;
8516 cdb->device = ((lba >> 24) & 0xf) | ATA_DEV_LBA;
8517 }
8518 cdb->command = command;
8519 cdb->control = control;
8520 } else {
8521 struct ata_pass_32 *cdb;
8522 uint8_t tmp_lba[8];
8523
8524 cdb = (struct ata_pass_32 *)cdb_ptr;
8525 cdb_len = sizeof(*cdb);
8526 bzero(cdb, cdb_len);
8527 cdb->opcode = VARIABLE_LEN_CDB;
8528 cdb->control = control;
8529 cdb->length = sizeof(*cdb) - __offsetof(struct ata_pass_32,
8530 service_action);
8531 scsi_ulto2b(ATA_PASS_32_SA, cdb->service_action);
8532 cdb->protocol = protocol;
8533 cdb->flags = ata_flags;
8534
8535 if ((protocol & AP_EXTEND) == 0) {
8536 lba &= 0x0fffffff;
8537 cdb->device = ((lba >> 24) & 0xf) | ATA_DEV_LBA;
8538 features &= 0xff;
8539 sector_count &= 0xff;
8540 } else {
8541 cdb->device = device | ATA_DEV_LBA;
8542 }
8543 scsi_u64to8b(lba, tmp_lba);
8544 bcopy(&tmp_lba[2], cdb->lba, sizeof(cdb->lba));
8545 scsi_ulto2b(features, cdb->features);
8546 scsi_ulto2b(sector_count, cdb->count);
8547 cdb->command = command;
8548 cdb->icc = icc;
8549 scsi_ulto4b(auxiliary, cdb->auxiliary);
8550 }
8551
8552 cam_fill_csio(csio,
8553 retries,
8554 cbfcnp,
8555 cam_flags,
8556 tag_action,
8557 data_ptr,
8558 dxfer_len,
8559 sense_len,
8560 cmd_size,
8561 timeout);
8562 bailout:
8563 return (retval);
8564 }
8565
8566 void
scsi_ata_pass_16(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),u_int32_t flags,u_int8_t tag_action,u_int8_t protocol,u_int8_t ata_flags,u_int16_t features,u_int16_t sector_count,uint64_t lba,u_int8_t command,u_int8_t control,u_int8_t * data_ptr,u_int16_t dxfer_len,u_int8_t sense_len,u_int32_t timeout)8567 scsi_ata_pass_16(struct ccb_scsiio *csio, u_int32_t retries,
8568 void (*cbfcnp)(struct cam_periph *, union ccb *),
8569 u_int32_t flags, u_int8_t tag_action,
8570 u_int8_t protocol, u_int8_t ata_flags, u_int16_t features,
8571 u_int16_t sector_count, uint64_t lba, u_int8_t command,
8572 u_int8_t control, u_int8_t *data_ptr, u_int16_t dxfer_len,
8573 u_int8_t sense_len, u_int32_t timeout)
8574 {
8575 struct ata_pass_16 *ata_cmd;
8576
8577 ata_cmd = (struct ata_pass_16 *)&csio->cdb_io.cdb_bytes;
8578 ata_cmd->opcode = ATA_PASS_16;
8579 ata_cmd->protocol = protocol;
8580 ata_cmd->flags = ata_flags;
8581 ata_cmd->features_ext = features >> 8;
8582 ata_cmd->features = features;
8583 ata_cmd->sector_count_ext = sector_count >> 8;
8584 ata_cmd->sector_count = sector_count;
8585 ata_cmd->lba_low = lba;
8586 ata_cmd->lba_mid = lba >> 8;
8587 ata_cmd->lba_high = lba >> 16;
8588 ata_cmd->device = ATA_DEV_LBA;
8589 if (protocol & AP_EXTEND) {
8590 ata_cmd->lba_low_ext = lba >> 24;
8591 ata_cmd->lba_mid_ext = lba >> 32;
8592 ata_cmd->lba_high_ext = lba >> 40;
8593 } else
8594 ata_cmd->device |= (lba >> 24) & 0x0f;
8595 ata_cmd->command = command;
8596 ata_cmd->control = control;
8597
8598 cam_fill_csio(csio,
8599 retries,
8600 cbfcnp,
8601 flags,
8602 tag_action,
8603 data_ptr,
8604 dxfer_len,
8605 sense_len,
8606 sizeof(*ata_cmd),
8607 timeout);
8608 }
8609
8610 void
scsi_unmap(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),u_int8_t tag_action,u_int8_t byte2,u_int8_t * data_ptr,u_int16_t dxfer_len,u_int8_t sense_len,u_int32_t timeout)8611 scsi_unmap(struct ccb_scsiio *csio, u_int32_t retries,
8612 void (*cbfcnp)(struct cam_periph *, union ccb *),
8613 u_int8_t tag_action, u_int8_t byte2,
8614 u_int8_t *data_ptr, u_int16_t dxfer_len, u_int8_t sense_len,
8615 u_int32_t timeout)
8616 {
8617 struct scsi_unmap *scsi_cmd;
8618
8619 scsi_cmd = (struct scsi_unmap *)&csio->cdb_io.cdb_bytes;
8620 scsi_cmd->opcode = UNMAP;
8621 scsi_cmd->byte2 = byte2;
8622 scsi_ulto4b(0, scsi_cmd->reserved);
8623 scsi_cmd->group = 0;
8624 scsi_ulto2b(dxfer_len, scsi_cmd->length);
8625 scsi_cmd->control = 0;
8626
8627 cam_fill_csio(csio,
8628 retries,
8629 cbfcnp,
8630 /*flags*/CAM_DIR_OUT,
8631 tag_action,
8632 data_ptr,
8633 dxfer_len,
8634 sense_len,
8635 sizeof(*scsi_cmd),
8636 timeout);
8637 }
8638
8639 void
scsi_receive_diagnostic_results(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),uint8_t tag_action,int pcv,uint8_t page_code,uint8_t * data_ptr,uint16_t allocation_length,uint8_t sense_len,uint32_t timeout)8640 scsi_receive_diagnostic_results(struct ccb_scsiio *csio, u_int32_t retries,
8641 void (*cbfcnp)(struct cam_periph *, union ccb*),
8642 uint8_t tag_action, int pcv, uint8_t page_code,
8643 uint8_t *data_ptr, uint16_t allocation_length,
8644 uint8_t sense_len, uint32_t timeout)
8645 {
8646 struct scsi_receive_diag *scsi_cmd;
8647
8648 scsi_cmd = (struct scsi_receive_diag *)&csio->cdb_io.cdb_bytes;
8649 memset(scsi_cmd, 0, sizeof(*scsi_cmd));
8650 scsi_cmd->opcode = RECEIVE_DIAGNOSTIC;
8651 if (pcv) {
8652 scsi_cmd->byte2 |= SRD_PCV;
8653 scsi_cmd->page_code = page_code;
8654 }
8655 scsi_ulto2b(allocation_length, scsi_cmd->length);
8656
8657 cam_fill_csio(csio,
8658 retries,
8659 cbfcnp,
8660 /*flags*/CAM_DIR_IN,
8661 tag_action,
8662 data_ptr,
8663 allocation_length,
8664 sense_len,
8665 sizeof(*scsi_cmd),
8666 timeout);
8667 }
8668
8669 void
scsi_send_diagnostic(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),uint8_t tag_action,int unit_offline,int device_offline,int self_test,int page_format,int self_test_code,uint8_t * data_ptr,uint16_t param_list_length,uint8_t sense_len,uint32_t timeout)8670 scsi_send_diagnostic(struct ccb_scsiio *csio, u_int32_t retries,
8671 void (*cbfcnp)(struct cam_periph *, union ccb *),
8672 uint8_t tag_action, int unit_offline, int device_offline,
8673 int self_test, int page_format, int self_test_code,
8674 uint8_t *data_ptr, uint16_t param_list_length,
8675 uint8_t sense_len, uint32_t timeout)
8676 {
8677 struct scsi_send_diag *scsi_cmd;
8678
8679 scsi_cmd = (struct scsi_send_diag *)&csio->cdb_io.cdb_bytes;
8680 memset(scsi_cmd, 0, sizeof(*scsi_cmd));
8681 scsi_cmd->opcode = SEND_DIAGNOSTIC;
8682
8683 /*
8684 * The default self-test mode control and specific test
8685 * control are mutually exclusive.
8686 */
8687 if (self_test)
8688 self_test_code = SSD_SELF_TEST_CODE_NONE;
8689
8690 scsi_cmd->byte2 = ((self_test_code << SSD_SELF_TEST_CODE_SHIFT)
8691 & SSD_SELF_TEST_CODE_MASK)
8692 | (unit_offline ? SSD_UNITOFFL : 0)
8693 | (device_offline ? SSD_DEVOFFL : 0)
8694 | (self_test ? SSD_SELFTEST : 0)
8695 | (page_format ? SSD_PF : 0);
8696 scsi_ulto2b(param_list_length, scsi_cmd->length);
8697
8698 cam_fill_csio(csio,
8699 retries,
8700 cbfcnp,
8701 /*flags*/param_list_length ? CAM_DIR_OUT : CAM_DIR_NONE,
8702 tag_action,
8703 data_ptr,
8704 param_list_length,
8705 sense_len,
8706 sizeof(*scsi_cmd),
8707 timeout);
8708 }
8709
8710 void
scsi_read_buffer(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),uint8_t tag_action,int mode,uint8_t buffer_id,u_int32_t offset,uint8_t * data_ptr,uint32_t allocation_length,uint8_t sense_len,uint32_t timeout)8711 scsi_read_buffer(struct ccb_scsiio *csio, u_int32_t retries,
8712 void (*cbfcnp)(struct cam_periph *, union ccb*),
8713 uint8_t tag_action, int mode,
8714 uint8_t buffer_id, u_int32_t offset,
8715 uint8_t *data_ptr, uint32_t allocation_length,
8716 uint8_t sense_len, uint32_t timeout)
8717 {
8718 struct scsi_read_buffer *scsi_cmd;
8719
8720 scsi_cmd = (struct scsi_read_buffer *)&csio->cdb_io.cdb_bytes;
8721 memset(scsi_cmd, 0, sizeof(*scsi_cmd));
8722 scsi_cmd->opcode = READ_BUFFER;
8723 scsi_cmd->byte2 = mode;
8724 scsi_cmd->buffer_id = buffer_id;
8725 scsi_ulto3b(offset, scsi_cmd->offset);
8726 scsi_ulto3b(allocation_length, scsi_cmd->length);
8727
8728 cam_fill_csio(csio,
8729 retries,
8730 cbfcnp,
8731 /*flags*/CAM_DIR_IN,
8732 tag_action,
8733 data_ptr,
8734 allocation_length,
8735 sense_len,
8736 sizeof(*scsi_cmd),
8737 timeout);
8738 }
8739
8740 void
scsi_write_buffer(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),uint8_t tag_action,int mode,uint8_t buffer_id,u_int32_t offset,uint8_t * data_ptr,uint32_t param_list_length,uint8_t sense_len,uint32_t timeout)8741 scsi_write_buffer(struct ccb_scsiio *csio, u_int32_t retries,
8742 void (*cbfcnp)(struct cam_periph *, union ccb *),
8743 uint8_t tag_action, int mode,
8744 uint8_t buffer_id, u_int32_t offset,
8745 uint8_t *data_ptr, uint32_t param_list_length,
8746 uint8_t sense_len, uint32_t timeout)
8747 {
8748 struct scsi_write_buffer *scsi_cmd;
8749
8750 scsi_cmd = (struct scsi_write_buffer *)&csio->cdb_io.cdb_bytes;
8751 memset(scsi_cmd, 0, sizeof(*scsi_cmd));
8752 scsi_cmd->opcode = WRITE_BUFFER;
8753 scsi_cmd->byte2 = mode;
8754 scsi_cmd->buffer_id = buffer_id;
8755 scsi_ulto3b(offset, scsi_cmd->offset);
8756 scsi_ulto3b(param_list_length, scsi_cmd->length);
8757
8758 cam_fill_csio(csio,
8759 retries,
8760 cbfcnp,
8761 /*flags*/param_list_length ? CAM_DIR_OUT : CAM_DIR_NONE,
8762 tag_action,
8763 data_ptr,
8764 param_list_length,
8765 sense_len,
8766 sizeof(*scsi_cmd),
8767 timeout);
8768 }
8769
8770 void
scsi_start_stop(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),u_int8_t tag_action,int start,int load_eject,int immediate,u_int8_t sense_len,u_int32_t timeout)8771 scsi_start_stop(struct ccb_scsiio *csio, u_int32_t retries,
8772 void (*cbfcnp)(struct cam_periph *, union ccb *),
8773 u_int8_t tag_action, int start, int load_eject,
8774 int immediate, u_int8_t sense_len, u_int32_t timeout)
8775 {
8776 struct scsi_start_stop_unit *scsi_cmd;
8777 int extra_flags = 0;
8778
8779 scsi_cmd = (struct scsi_start_stop_unit *)&csio->cdb_io.cdb_bytes;
8780 bzero(scsi_cmd, sizeof(*scsi_cmd));
8781 scsi_cmd->opcode = START_STOP_UNIT;
8782 if (start != 0) {
8783 scsi_cmd->how |= SSS_START;
8784 /* it takes a lot of power to start a drive */
8785 extra_flags |= CAM_HIGH_POWER;
8786 }
8787 if (load_eject != 0)
8788 scsi_cmd->how |= SSS_LOEJ;
8789 if (immediate != 0)
8790 scsi_cmd->byte2 |= SSS_IMMED;
8791
8792 cam_fill_csio(csio,
8793 retries,
8794 cbfcnp,
8795 /*flags*/CAM_DIR_NONE | extra_flags,
8796 tag_action,
8797 /*data_ptr*/NULL,
8798 /*dxfer_len*/0,
8799 sense_len,
8800 sizeof(*scsi_cmd),
8801 timeout);
8802 }
8803
8804 void
scsi_read_attribute(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),u_int8_t tag_action,u_int8_t service_action,uint32_t element,u_int8_t elem_type,int logical_volume,int partition,u_int32_t first_attribute,int cache,u_int8_t * data_ptr,u_int32_t length,int sense_len,u_int32_t timeout)8805 scsi_read_attribute(struct ccb_scsiio *csio, u_int32_t retries,
8806 void (*cbfcnp)(struct cam_periph *, union ccb *),
8807 u_int8_t tag_action, u_int8_t service_action,
8808 uint32_t element, u_int8_t elem_type, int logical_volume,
8809 int partition, u_int32_t first_attribute, int cache,
8810 u_int8_t *data_ptr, u_int32_t length, int sense_len,
8811 u_int32_t timeout)
8812 {
8813 struct scsi_read_attribute *scsi_cmd;
8814
8815 scsi_cmd = (struct scsi_read_attribute *)&csio->cdb_io.cdb_bytes;
8816 bzero(scsi_cmd, sizeof(*scsi_cmd));
8817
8818 scsi_cmd->opcode = READ_ATTRIBUTE;
8819 scsi_cmd->service_action = service_action;
8820 scsi_ulto2b(element, scsi_cmd->element);
8821 scsi_cmd->elem_type = elem_type;
8822 scsi_cmd->logical_volume = logical_volume;
8823 scsi_cmd->partition = partition;
8824 scsi_ulto2b(first_attribute, scsi_cmd->first_attribute);
8825 scsi_ulto4b(length, scsi_cmd->length);
8826 if (cache != 0)
8827 scsi_cmd->cache |= SRA_CACHE;
8828
8829 cam_fill_csio(csio,
8830 retries,
8831 cbfcnp,
8832 /*flags*/CAM_DIR_IN,
8833 tag_action,
8834 /*data_ptr*/data_ptr,
8835 /*dxfer_len*/length,
8836 sense_len,
8837 sizeof(*scsi_cmd),
8838 timeout);
8839 }
8840
8841 void
scsi_write_attribute(struct ccb_scsiio * csio,u_int32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),u_int8_t tag_action,uint32_t element,int logical_volume,int partition,int wtc,u_int8_t * data_ptr,u_int32_t length,int sense_len,u_int32_t timeout)8842 scsi_write_attribute(struct ccb_scsiio *csio, u_int32_t retries,
8843 void (*cbfcnp)(struct cam_periph *, union ccb *),
8844 u_int8_t tag_action, uint32_t element, int logical_volume,
8845 int partition, int wtc, u_int8_t *data_ptr,
8846 u_int32_t length, int sense_len, u_int32_t timeout)
8847 {
8848 struct scsi_write_attribute *scsi_cmd;
8849
8850 scsi_cmd = (struct scsi_write_attribute *)&csio->cdb_io.cdb_bytes;
8851 bzero(scsi_cmd, sizeof(*scsi_cmd));
8852
8853 scsi_cmd->opcode = WRITE_ATTRIBUTE;
8854 if (wtc != 0)
8855 scsi_cmd->byte2 = SWA_WTC;
8856 scsi_ulto3b(element, scsi_cmd->element);
8857 scsi_cmd->logical_volume = logical_volume;
8858 scsi_cmd->partition = partition;
8859 scsi_ulto4b(length, scsi_cmd->length);
8860
8861 cam_fill_csio(csio,
8862 retries,
8863 cbfcnp,
8864 /*flags*/CAM_DIR_OUT,
8865 tag_action,
8866 /*data_ptr*/data_ptr,
8867 /*dxfer_len*/length,
8868 sense_len,
8869 sizeof(*scsi_cmd),
8870 timeout);
8871 }
8872
8873 void
scsi_persistent_reserve_in(struct ccb_scsiio * csio,uint32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),uint8_t tag_action,int service_action,uint8_t * data_ptr,uint32_t dxfer_len,int sense_len,int timeout)8874 scsi_persistent_reserve_in(struct ccb_scsiio *csio, uint32_t retries,
8875 void (*cbfcnp)(struct cam_periph *, union ccb *),
8876 uint8_t tag_action, int service_action,
8877 uint8_t *data_ptr, uint32_t dxfer_len, int sense_len,
8878 int timeout)
8879 {
8880 struct scsi_per_res_in *scsi_cmd;
8881
8882 scsi_cmd = (struct scsi_per_res_in *)&csio->cdb_io.cdb_bytes;
8883 bzero(scsi_cmd, sizeof(*scsi_cmd));
8884
8885 scsi_cmd->opcode = PERSISTENT_RES_IN;
8886 scsi_cmd->action = service_action;
8887 scsi_ulto2b(dxfer_len, scsi_cmd->length);
8888
8889 cam_fill_csio(csio,
8890 retries,
8891 cbfcnp,
8892 /*flags*/CAM_DIR_IN,
8893 tag_action,
8894 data_ptr,
8895 dxfer_len,
8896 sense_len,
8897 sizeof(*scsi_cmd),
8898 timeout);
8899 }
8900
8901 void
scsi_persistent_reserve_out(struct ccb_scsiio * csio,uint32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),uint8_t tag_action,int service_action,int scope,int res_type,uint8_t * data_ptr,uint32_t dxfer_len,int sense_len,int timeout)8902 scsi_persistent_reserve_out(struct ccb_scsiio *csio, uint32_t retries,
8903 void (*cbfcnp)(struct cam_periph *, union ccb *),
8904 uint8_t tag_action, int service_action,
8905 int scope, int res_type, uint8_t *data_ptr,
8906 uint32_t dxfer_len, int sense_len, int timeout)
8907 {
8908 struct scsi_per_res_out *scsi_cmd;
8909
8910 scsi_cmd = (struct scsi_per_res_out *)&csio->cdb_io.cdb_bytes;
8911 bzero(scsi_cmd, sizeof(*scsi_cmd));
8912
8913 scsi_cmd->opcode = PERSISTENT_RES_OUT;
8914 scsi_cmd->action = service_action;
8915 scsi_cmd->scope_type = scope | res_type;
8916 scsi_ulto4b(dxfer_len, scsi_cmd->length);
8917
8918 cam_fill_csio(csio,
8919 retries,
8920 cbfcnp,
8921 /*flags*/CAM_DIR_OUT,
8922 tag_action,
8923 /*data_ptr*/data_ptr,
8924 /*dxfer_len*/dxfer_len,
8925 sense_len,
8926 sizeof(*scsi_cmd),
8927 timeout);
8928 }
8929
8930 void
scsi_security_protocol_in(struct ccb_scsiio * csio,uint32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),uint8_t tag_action,uint32_t security_protocol,uint32_t security_protocol_specific,int byte4,uint8_t * data_ptr,uint32_t dxfer_len,int sense_len,int timeout)8931 scsi_security_protocol_in(struct ccb_scsiio *csio, uint32_t retries,
8932 void (*cbfcnp)(struct cam_periph *, union ccb *),
8933 uint8_t tag_action, uint32_t security_protocol,
8934 uint32_t security_protocol_specific, int byte4,
8935 uint8_t *data_ptr, uint32_t dxfer_len, int sense_len,
8936 int timeout)
8937 {
8938 struct scsi_security_protocol_in *scsi_cmd;
8939
8940 scsi_cmd = (struct scsi_security_protocol_in *)&csio->cdb_io.cdb_bytes;
8941 bzero(scsi_cmd, sizeof(*scsi_cmd));
8942
8943 scsi_cmd->opcode = SECURITY_PROTOCOL_IN;
8944
8945 scsi_cmd->security_protocol = security_protocol;
8946 scsi_ulto2b(security_protocol_specific,
8947 scsi_cmd->security_protocol_specific);
8948 scsi_cmd->byte4 = byte4;
8949 scsi_ulto4b(dxfer_len, scsi_cmd->length);
8950
8951 cam_fill_csio(csio,
8952 retries,
8953 cbfcnp,
8954 /*flags*/CAM_DIR_IN,
8955 tag_action,
8956 data_ptr,
8957 dxfer_len,
8958 sense_len,
8959 sizeof(*scsi_cmd),
8960 timeout);
8961 }
8962
8963 void
scsi_security_protocol_out(struct ccb_scsiio * csio,uint32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),uint8_t tag_action,uint32_t security_protocol,uint32_t security_protocol_specific,int byte4,uint8_t * data_ptr,uint32_t dxfer_len,int sense_len,int timeout)8964 scsi_security_protocol_out(struct ccb_scsiio *csio, uint32_t retries,
8965 void (*cbfcnp)(struct cam_periph *, union ccb *),
8966 uint8_t tag_action, uint32_t security_protocol,
8967 uint32_t security_protocol_specific, int byte4,
8968 uint8_t *data_ptr, uint32_t dxfer_len, int sense_len,
8969 int timeout)
8970 {
8971 struct scsi_security_protocol_out *scsi_cmd;
8972
8973 scsi_cmd = (struct scsi_security_protocol_out *)&csio->cdb_io.cdb_bytes;
8974 bzero(scsi_cmd, sizeof(*scsi_cmd));
8975
8976 scsi_cmd->opcode = SECURITY_PROTOCOL_OUT;
8977
8978 scsi_cmd->security_protocol = security_protocol;
8979 scsi_ulto2b(security_protocol_specific,
8980 scsi_cmd->security_protocol_specific);
8981 scsi_cmd->byte4 = byte4;
8982 scsi_ulto4b(dxfer_len, scsi_cmd->length);
8983
8984 cam_fill_csio(csio,
8985 retries,
8986 cbfcnp,
8987 /*flags*/CAM_DIR_OUT,
8988 tag_action,
8989 data_ptr,
8990 dxfer_len,
8991 sense_len,
8992 sizeof(*scsi_cmd),
8993 timeout);
8994 }
8995
8996 void
scsi_report_supported_opcodes(struct ccb_scsiio * csio,uint32_t retries,void (* cbfcnp)(struct cam_periph *,union ccb *),uint8_t tag_action,int options,int req_opcode,int req_service_action,uint8_t * data_ptr,uint32_t dxfer_len,int sense_len,int timeout)8997 scsi_report_supported_opcodes(struct ccb_scsiio *csio, uint32_t retries,
8998 void (*cbfcnp)(struct cam_periph *, union ccb *),
8999 uint8_t tag_action, int options, int req_opcode,
9000 int req_service_action, uint8_t *data_ptr,
9001 uint32_t dxfer_len, int sense_len, int timeout)
9002 {
9003 struct scsi_report_supported_opcodes *scsi_cmd;
9004
9005 scsi_cmd = (struct scsi_report_supported_opcodes *)
9006 &csio->cdb_io.cdb_bytes;
9007 bzero(scsi_cmd, sizeof(*scsi_cmd));
9008
9009 scsi_cmd->opcode = MAINTENANCE_IN;
9010 scsi_cmd->service_action = REPORT_SUPPORTED_OPERATION_CODES;
9011 scsi_cmd->options = options;
9012 scsi_cmd->requested_opcode = req_opcode;
9013 scsi_ulto2b(req_service_action, scsi_cmd->requested_service_action);
9014 scsi_ulto4b(dxfer_len, scsi_cmd->length);
9015
9016 cam_fill_csio(csio,
9017 retries,
9018 cbfcnp,
9019 /*flags*/CAM_DIR_IN,
9020 tag_action,
9021 data_ptr,
9022 dxfer_len,
9023 sense_len,
9024 sizeof(*scsi_cmd),
9025 timeout);
9026 }
9027
9028 /*
9029 * Try make as good a match as possible with
9030 * available sub drivers
9031 */
9032 int
scsi_inquiry_match(caddr_t inqbuffer,caddr_t table_entry)9033 scsi_inquiry_match(caddr_t inqbuffer, caddr_t table_entry)
9034 {
9035 struct scsi_inquiry_pattern *entry;
9036 struct scsi_inquiry_data *inq;
9037
9038 entry = (struct scsi_inquiry_pattern *)table_entry;
9039 inq = (struct scsi_inquiry_data *)inqbuffer;
9040
9041 if (((SID_TYPE(inq) == entry->type)
9042 || (entry->type == T_ANY))
9043 && (SID_IS_REMOVABLE(inq) ? entry->media_type & SIP_MEDIA_REMOVABLE
9044 : entry->media_type & SIP_MEDIA_FIXED)
9045 && (cam_strmatch(inq->vendor, entry->vendor, sizeof(inq->vendor)) == 0)
9046 && (cam_strmatch(inq->product, entry->product,
9047 sizeof(inq->product)) == 0)
9048 && (cam_strmatch(inq->revision, entry->revision,
9049 sizeof(inq->revision)) == 0)) {
9050 return (0);
9051 }
9052 return (-1);
9053 }
9054
9055 /*
9056 * Try make as good a match as possible with
9057 * available sub drivers
9058 */
9059 int
scsi_static_inquiry_match(caddr_t inqbuffer,caddr_t table_entry)9060 scsi_static_inquiry_match(caddr_t inqbuffer, caddr_t table_entry)
9061 {
9062 struct scsi_static_inquiry_pattern *entry;
9063 struct scsi_inquiry_data *inq;
9064
9065 entry = (struct scsi_static_inquiry_pattern *)table_entry;
9066 inq = (struct scsi_inquiry_data *)inqbuffer;
9067
9068 if (((SID_TYPE(inq) == entry->type)
9069 || (entry->type == T_ANY))
9070 && (SID_IS_REMOVABLE(inq) ? entry->media_type & SIP_MEDIA_REMOVABLE
9071 : entry->media_type & SIP_MEDIA_FIXED)
9072 && (cam_strmatch(inq->vendor, entry->vendor, sizeof(inq->vendor)) == 0)
9073 && (cam_strmatch(inq->product, entry->product,
9074 sizeof(inq->product)) == 0)
9075 && (cam_strmatch(inq->revision, entry->revision,
9076 sizeof(inq->revision)) == 0)) {
9077 return (0);
9078 }
9079 return (-1);
9080 }
9081
9082 /**
9083 * Compare two buffers of vpd device descriptors for a match.
9084 *
9085 * \param lhs Pointer to first buffer of descriptors to compare.
9086 * \param lhs_len The length of the first buffer.
9087 * \param rhs Pointer to second buffer of descriptors to compare.
9088 * \param rhs_len The length of the second buffer.
9089 *
9090 * \return 0 on a match, -1 otherwise.
9091 *
9092 * Treat rhs and lhs as arrays of vpd device id descriptors. Walk lhs matching
9093 * against each element in rhs until all data are exhausted or we have found
9094 * a match.
9095 */
9096 int
scsi_devid_match(uint8_t * lhs,size_t lhs_len,uint8_t * rhs,size_t rhs_len)9097 scsi_devid_match(uint8_t *lhs, size_t lhs_len, uint8_t *rhs, size_t rhs_len)
9098 {
9099 struct scsi_vpd_id_descriptor *lhs_id;
9100 struct scsi_vpd_id_descriptor *lhs_last;
9101 struct scsi_vpd_id_descriptor *rhs_last;
9102 uint8_t *lhs_end;
9103 uint8_t *rhs_end;
9104
9105 lhs_end = lhs + lhs_len;
9106 rhs_end = rhs + rhs_len;
9107
9108 /*
9109 * rhs_last and lhs_last are the last posible position of a valid
9110 * descriptor assuming it had a zero length identifier. We use
9111 * these variables to insure we can safely dereference the length
9112 * field in our loop termination tests.
9113 */
9114 lhs_last = (struct scsi_vpd_id_descriptor *)
9115 (lhs_end - __offsetof(struct scsi_vpd_id_descriptor, identifier));
9116 rhs_last = (struct scsi_vpd_id_descriptor *)
9117 (rhs_end - __offsetof(struct scsi_vpd_id_descriptor, identifier));
9118
9119 lhs_id = (struct scsi_vpd_id_descriptor *)lhs;
9120 while (lhs_id <= lhs_last
9121 && (lhs_id->identifier + lhs_id->length) <= lhs_end) {
9122 struct scsi_vpd_id_descriptor *rhs_id;
9123
9124 rhs_id = (struct scsi_vpd_id_descriptor *)rhs;
9125 while (rhs_id <= rhs_last
9126 && (rhs_id->identifier + rhs_id->length) <= rhs_end) {
9127
9128 if ((rhs_id->id_type &
9129 (SVPD_ID_ASSOC_MASK | SVPD_ID_TYPE_MASK)) ==
9130 (lhs_id->id_type &
9131 (SVPD_ID_ASSOC_MASK | SVPD_ID_TYPE_MASK))
9132 && rhs_id->length == lhs_id->length
9133 && memcmp(rhs_id->identifier, lhs_id->identifier,
9134 rhs_id->length) == 0)
9135 return (0);
9136
9137 rhs_id = (struct scsi_vpd_id_descriptor *)
9138 (rhs_id->identifier + rhs_id->length);
9139 }
9140 lhs_id = (struct scsi_vpd_id_descriptor *)
9141 (lhs_id->identifier + lhs_id->length);
9142 }
9143 return (-1);
9144 }
9145
9146 #ifdef _KERNEL
9147 int
scsi_vpd_supported_page(struct cam_periph * periph,uint8_t page_id)9148 scsi_vpd_supported_page(struct cam_periph *periph, uint8_t page_id)
9149 {
9150 struct cam_ed *device;
9151 struct scsi_vpd_supported_pages *vpds;
9152 int i, num_pages;
9153
9154 device = periph->path->device;
9155 vpds = (struct scsi_vpd_supported_pages *)device->supported_vpds;
9156
9157 if (vpds != NULL) {
9158 num_pages = device->supported_vpds_len -
9159 SVPD_SUPPORTED_PAGES_HDR_LEN;
9160 for (i = 0; i < num_pages; i++) {
9161 if (vpds->page_list[i] == page_id)
9162 return (1);
9163 }
9164 }
9165
9166 return (0);
9167 }
9168
9169 static void
init_scsi_delay(void)9170 init_scsi_delay(void)
9171 {
9172 int delay;
9173
9174 delay = SCSI_DELAY;
9175 TUNABLE_INT_FETCH("kern.cam.scsi_delay", &delay);
9176
9177 if (set_scsi_delay(delay) != 0) {
9178 printf("cam: invalid value for tunable kern.cam.scsi_delay\n");
9179 set_scsi_delay(SCSI_DELAY);
9180 }
9181 }
9182 SYSINIT(scsi_delay, SI_SUB_TUNABLES, SI_ORDER_ANY, init_scsi_delay, NULL);
9183
9184 static int
sysctl_scsi_delay(SYSCTL_HANDLER_ARGS)9185 sysctl_scsi_delay(SYSCTL_HANDLER_ARGS)
9186 {
9187 int error, delay;
9188
9189 delay = scsi_delay;
9190 error = sysctl_handle_int(oidp, &delay, 0, req);
9191 if (error != 0 || req->newptr == NULL)
9192 return (error);
9193 return (set_scsi_delay(delay));
9194 }
9195 SYSCTL_PROC(_kern_cam, OID_AUTO, scsi_delay, CTLTYPE_INT|CTLFLAG_RW,
9196 0, 0, sysctl_scsi_delay, "I",
9197 "Delay to allow devices to settle after a SCSI bus reset (ms)");
9198
9199 static int
set_scsi_delay(int delay)9200 set_scsi_delay(int delay)
9201 {
9202 /*
9203 * If someone sets this to 0, we assume that they want the
9204 * minimum allowable bus settle delay.
9205 */
9206 if (delay == 0) {
9207 printf("cam: using minimum scsi_delay (%dms)\n",
9208 SCSI_MIN_DELAY);
9209 delay = SCSI_MIN_DELAY;
9210 }
9211 if (delay < SCSI_MIN_DELAY)
9212 return (EINVAL);
9213 scsi_delay = delay;
9214 return (0);
9215 }
9216 #endif /* _KERNEL */
9217