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