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