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