xref: /freebsd/sys/cam/scsi/scsi_sa.c (revision 3b2324c3a800d7599f348c408f01908d0cef05a0)
1 /*-
2  * Implementation of SCSI Sequential Access Peripheral driver for CAM.
3  *
4  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
5  *
6  * Copyright (c) 1999, 2000 Matthew Jacob
7  * Copyright (c) 2013, 2014, 2015 Spectra Logic Corporation
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/queue.h>
37 #ifdef _KERNEL
38 #include <sys/systm.h>
39 #include <sys/kernel.h>
40 #endif
41 #include <sys/types.h>
42 #include <sys/time.h>
43 #include <sys/bio.h>
44 #include <sys/limits.h>
45 #include <sys/malloc.h>
46 #include <sys/mtio.h>
47 #ifdef _KERNEL
48 #include <sys/conf.h>
49 #include <sys/sbuf.h>
50 #include <sys/sysctl.h>
51 #include <sys/taskqueue.h>
52 #endif
53 #include <sys/fcntl.h>
54 #include <sys/devicestat.h>
55 
56 #ifndef _KERNEL
57 #include <stdio.h>
58 #include <string.h>
59 #endif
60 
61 #include <cam/cam.h>
62 #include <cam/cam_ccb.h>
63 #include <cam/cam_periph.h>
64 #include <cam/cam_xpt_periph.h>
65 #include <cam/cam_debug.h>
66 
67 #include <cam/scsi/scsi_all.h>
68 #include <cam/scsi/scsi_message.h>
69 #include <cam/scsi/scsi_sa.h>
70 
71 #ifdef _KERNEL
72 
73 #include "opt_sa.h"
74 
75 #ifndef SA_IO_TIMEOUT
76 #define SA_IO_TIMEOUT		32
77 #endif
78 #ifndef SA_SPACE_TIMEOUT
79 #define SA_SPACE_TIMEOUT	1 * 60
80 #endif
81 #ifndef SA_REWIND_TIMEOUT
82 #define SA_REWIND_TIMEOUT	2 * 60
83 #endif
84 #ifndef SA_ERASE_TIMEOUT
85 #define SA_ERASE_TIMEOUT	4 * 60
86 #endif
87 #ifndef SA_REP_DENSITY_TIMEOUT
88 #define SA_REP_DENSITY_TIMEOUT	90
89 #endif
90 
91 #define	SCSIOP_TIMEOUT		(60 * 1000)	/* not an option */
92 
93 #define	IO_TIMEOUT		(SA_IO_TIMEOUT * 60 * 1000)
94 #define	REWIND_TIMEOUT		(SA_REWIND_TIMEOUT * 60 * 1000)
95 #define	ERASE_TIMEOUT		(SA_ERASE_TIMEOUT * 60 * 1000)
96 #define	SPACE_TIMEOUT		(SA_SPACE_TIMEOUT * 60 * 1000)
97 #define	REP_DENSITY_TIMEOUT	(SA_REP_DENSITY_TIMEOUT * 60 * 1000)
98 
99 /*
100  * Additional options that can be set for config: SA_1FM_AT_EOT
101  */
102 
103 #ifndef	UNUSED_PARAMETER
104 #define	UNUSED_PARAMETER(x)	x = x
105 #endif
106 
107 #define	QFRLS(ccb)	\
108 	if (((ccb)->ccb_h.status & CAM_DEV_QFRZN) != 0)	\
109 		cam_release_devq((ccb)->ccb_h.path, 0, 0, 0, FALSE)
110 
111 /*
112  * Driver states
113  */
114 
115 static MALLOC_DEFINE(M_SCSISA, "SCSI sa", "SCSI sequential access buffers");
116 
117 typedef enum {
118 	SA_STATE_NORMAL, SA_STATE_ABNORMAL
119 } sa_state;
120 
121 #define ccb_pflags	ppriv_field0
122 #define ccb_bp	 	ppriv_ptr1
123 
124 /* bits in ccb_pflags */
125 #define	SA_POSITION_UPDATED	0x1
126 
127 
128 typedef enum {
129 	SA_FLAG_OPEN		= 0x0001,
130 	SA_FLAG_FIXED		= 0x0002,
131 	SA_FLAG_TAPE_LOCKED	= 0x0004,
132 	SA_FLAG_TAPE_MOUNTED	= 0x0008,
133 	SA_FLAG_TAPE_WP		= 0x0010,
134 	SA_FLAG_TAPE_WRITTEN	= 0x0020,
135 	SA_FLAG_EOM_PENDING	= 0x0040,
136 	SA_FLAG_EIO_PENDING	= 0x0080,
137 	SA_FLAG_EOF_PENDING	= 0x0100,
138 	SA_FLAG_ERR_PENDING	= (SA_FLAG_EOM_PENDING|SA_FLAG_EIO_PENDING|
139 				   SA_FLAG_EOF_PENDING),
140 	SA_FLAG_INVALID		= 0x0200,
141 	SA_FLAG_COMP_ENABLED	= 0x0400,
142 	SA_FLAG_COMP_SUPP	= 0x0800,
143 	SA_FLAG_COMP_UNSUPP	= 0x1000,
144 	SA_FLAG_TAPE_FROZEN	= 0x2000,
145 	SA_FLAG_PROTECT_SUPP	= 0x4000,
146 
147 	SA_FLAG_COMPRESSION	= (SA_FLAG_COMP_SUPP|SA_FLAG_COMP_ENABLED|
148 				   SA_FLAG_COMP_UNSUPP),
149 	SA_FLAG_SCTX_INIT	= 0x8000
150 } sa_flags;
151 
152 typedef enum {
153 	SA_MODE_REWIND		= 0x00,
154 	SA_MODE_NOREWIND	= 0x01,
155 	SA_MODE_OFFLINE		= 0x02
156 } sa_mode;
157 
158 typedef enum {
159 	SA_PARAM_NONE		= 0x000,
160 	SA_PARAM_BLOCKSIZE	= 0x001,
161 	SA_PARAM_DENSITY	= 0x002,
162 	SA_PARAM_COMPRESSION	= 0x004,
163 	SA_PARAM_BUFF_MODE	= 0x008,
164 	SA_PARAM_NUMBLOCKS	= 0x010,
165 	SA_PARAM_WP		= 0x020,
166 	SA_PARAM_SPEED		= 0x040,
167 	SA_PARAM_DENSITY_EXT	= 0x080,
168 	SA_PARAM_LBP		= 0x100,
169 	SA_PARAM_ALL		= 0x1ff
170 } sa_params;
171 
172 typedef enum {
173 	SA_QUIRK_NONE		= 0x000,
174 	SA_QUIRK_NOCOMP		= 0x001, /* Can't deal with compression at all*/
175 	SA_QUIRK_FIXED		= 0x002, /* Force fixed mode */
176 	SA_QUIRK_VARIABLE	= 0x004, /* Force variable mode */
177 	SA_QUIRK_2FM		= 0x008, /* Needs Two File Marks at EOD */
178 	SA_QUIRK_1FM		= 0x010, /* No more than 1 File Mark at EOD */
179 	SA_QUIRK_NODREAD	= 0x020, /* Don't try and dummy read density */
180 	SA_QUIRK_NO_MODESEL	= 0x040, /* Don't do mode select at all */
181 	SA_QUIRK_NO_CPAGE	= 0x080, /* Don't use DEVICE COMPRESSION page */
182 	SA_QUIRK_NO_LONG_POS	= 0x100  /* No long position information */
183 } sa_quirks;
184 
185 #define SA_QUIRK_BIT_STRING	\
186 	"\020"			\
187 	"\001NOCOMP"		\
188 	"\002FIXED"		\
189 	"\003VARIABLE"		\
190 	"\0042FM"		\
191 	"\0051FM"		\
192 	"\006NODREAD"		\
193 	"\007NO_MODESEL"	\
194 	"\010NO_CPAGE"		\
195 	"\011NO_LONG_POS"
196 
197 #define	SAMODE(z)	(dev2unit(z) & 0x3)
198 #define	SA_IS_CTRL(z)	(dev2unit(z) & (1 << 4))
199 
200 #define SA_NOT_CTLDEV	0
201 #define SA_CTLDEV	1
202 
203 #define SA_ATYPE_R	0
204 #define SA_ATYPE_NR	1
205 #define SA_ATYPE_ER	2
206 #define SA_NUM_ATYPES	3
207 
208 #define	SAMINOR(ctl, access) \
209 	((ctl << 4) | (access & 0x3))
210 
211 struct sa_devs {
212 	struct cdev *ctl_dev;
213 	struct cdev *r_dev;
214 	struct cdev *nr_dev;
215 	struct cdev *er_dev;
216 };
217 
218 #define	SASBADDBASE(sb, indent, data, xfmt, name, type, xsize, desc)	\
219 	sbuf_printf(sb, "%*s<%s type=\"%s\" size=\"%zd\" "		\
220 	    "fmt=\"%s\" desc=\"%s\">" #xfmt "</%s>\n", indent, "", 	\
221 	    #name, #type, xsize, #xfmt, desc ? desc : "", data, #name);
222 
223 #define	SASBADDINT(sb, indent, data, fmt, name)				\
224 	SASBADDBASE(sb, indent, data, fmt, name, int, sizeof(data),	\
225 		    NULL)
226 
227 #define	SASBADDINTDESC(sb, indent, data, fmt, name, desc)		\
228 	SASBADDBASE(sb, indent, data, fmt, name, int, sizeof(data),	\
229 		    desc)
230 
231 #define	SASBADDUINT(sb, indent, data, fmt, name)			\
232 	SASBADDBASE(sb, indent, data, fmt, name, uint, sizeof(data), 	\
233 		    NULL)
234 
235 #define	SASBADDUINTDESC(sb, indent, data, fmt, name, desc)		\
236 	SASBADDBASE(sb, indent, data, fmt, name, uint, sizeof(data), 	\
237 		    desc)
238 
239 #define	SASBADDFIXEDSTR(sb, indent, data, fmt, name)			\
240 	SASBADDBASE(sb, indent, data, fmt, name, str, sizeof(data),	\
241 		    NULL)
242 
243 #define	SASBADDFIXEDSTRDESC(sb, indent, data, fmt, name, desc)		\
244 	SASBADDBASE(sb, indent, data, fmt, name, str, sizeof(data),	\
245 		    desc)
246 
247 #define	SASBADDVARSTR(sb, indent, data, fmt, name, maxlen)		\
248 	SASBADDBASE(sb, indent, data, fmt, name, str, maxlen, NULL)
249 
250 #define	SASBADDVARSTRDESC(sb, indent, data, fmt, name, maxlen, desc)	\
251 	SASBADDBASE(sb, indent, data, fmt, name, str, maxlen, desc)
252 
253 #define	SASBADDNODE(sb, indent, name) {					\
254 	sbuf_printf(sb, "%*s<%s type=\"%s\">\n", indent, "", #name,	\
255 	    "node");							\
256 	indent += 2;							\
257 }
258 
259 #define	SASBADDNODENUM(sb, indent, name, num) {				\
260 	sbuf_printf(sb, "%*s<%s type=\"%s\" num=\"%d\">\n", indent, "",	\
261 	    #name, "node", num);					\
262 	indent += 2;							\
263 }
264 
265 #define	SASBENDNODE(sb, indent, name) {					\
266 	indent -= 2;							\
267 	sbuf_printf(sb, "%*s</%s>\n", indent, "", #name);		\
268 }
269 
270 #define	SA_DENSITY_TYPES	4
271 
272 struct sa_prot_state {
273 	int initialized;
274 	uint32_t prot_method;
275 	uint32_t pi_length;
276 	uint32_t lbp_w;
277 	uint32_t lbp_r;
278 	uint32_t rbdp;
279 };
280 
281 struct sa_prot_info {
282 	struct sa_prot_state cur_prot_state;
283 	struct sa_prot_state pending_prot_state;
284 };
285 
286 /*
287  * A table mapping protection parameters to their types and values.
288  */
289 struct sa_prot_map {
290 	char *name;
291 	mt_param_set_type param_type;
292 	off_t offset;
293 	uint32_t min_val;
294 	uint32_t max_val;
295 	uint32_t *value;
296 } sa_prot_table[] = {
297 	{ "prot_method", MT_PARAM_SET_UNSIGNED,
298 	  __offsetof(struct sa_prot_state, prot_method),
299 	  /*min_val*/ 0, /*max_val*/ 255, NULL },
300 	{ "pi_length", MT_PARAM_SET_UNSIGNED,
301 	  __offsetof(struct sa_prot_state, pi_length),
302 	  /*min_val*/ 0, /*max_val*/ SA_CTRL_DP_PI_LENGTH_MASK, NULL },
303 	{ "lbp_w", MT_PARAM_SET_UNSIGNED,
304 	  __offsetof(struct sa_prot_state, lbp_w),
305 	  /*min_val*/ 0, /*max_val*/ 1, NULL },
306 	{ "lbp_r", MT_PARAM_SET_UNSIGNED,
307 	  __offsetof(struct sa_prot_state, lbp_r),
308 	  /*min_val*/ 0, /*max_val*/ 1, NULL },
309 	{ "rbdp", MT_PARAM_SET_UNSIGNED,
310 	  __offsetof(struct sa_prot_state, rbdp),
311 	  /*min_val*/ 0, /*max_val*/ 1, NULL }
312 };
313 
314 #define	SA_NUM_PROT_ENTS nitems(sa_prot_table)
315 
316 #define	SA_PROT_ENABLED(softc) ((softc->flags & SA_FLAG_PROTECT_SUPP)	\
317 	&& (softc->prot_info.cur_prot_state.initialized != 0)		\
318 	&& (softc->prot_info.cur_prot_state.prot_method != 0))
319 
320 #define	SA_PROT_LEN(softc)	softc->prot_info.cur_prot_state.pi_length
321 
322 struct sa_softc {
323 	sa_state	state;
324 	sa_flags	flags;
325 	sa_quirks	quirks;
326 	u_int		si_flags;
327 	struct cam_periph *periph;
328 	struct		bio_queue_head bio_queue;
329 	int		queue_count;
330 	struct		devstat *device_stats;
331 	struct sa_devs	devs;
332 	int		open_count;
333 	int		num_devs_to_destroy;
334 	int		blk_gran;
335 	int		blk_mask;
336 	int		blk_shift;
337 	u_int32_t	max_blk;
338 	u_int32_t	min_blk;
339 	u_int32_t	maxio;
340 	u_int32_t	cpi_maxio;
341 	int		allow_io_split;
342 	int		inject_eom;
343 	int		set_pews_status;
344 	u_int32_t	comp_algorithm;
345 	u_int32_t	saved_comp_algorithm;
346 	u_int32_t	media_blksize;
347 	u_int32_t	last_media_blksize;
348 	u_int32_t	media_numblks;
349 	u_int8_t	media_density;
350 	u_int8_t	speed;
351 	u_int8_t	scsi_rev;
352 	u_int8_t	dsreg;		/* mtio mt_dsreg, redux */
353 	int		buffer_mode;
354 	int		filemarks;
355 	union		ccb saved_ccb;
356 	int		last_resid_was_io;
357 	uint8_t		density_type_bits[SA_DENSITY_TYPES];
358 	int		density_info_valid[SA_DENSITY_TYPES];
359 	uint8_t		density_info[SA_DENSITY_TYPES][SRDS_MAX_LENGTH];
360 
361 	struct sa_prot_info	prot_info;
362 
363 	int		sili;
364 	int		eot_warn;
365 
366 	/*
367 	 * Current position information.  -1 means that the given value is
368 	 * unknown.  fileno and blkno are always calculated.  blkno is
369 	 * relative to the previous file mark.  rep_fileno and rep_blkno
370 	 * are as reported by the drive, if it supports the long form
371 	 * report for the READ POSITION command.  rep_blkno is relative to
372 	 * the beginning of the partition.
373 	 *
374 	 * bop means that the drive is at the beginning of the partition.
375 	 * eop means that the drive is between early warning and end of
376 	 * partition, inside the current partition.
377 	 * bpew means that the position is in a PEWZ (Programmable Early
378 	 * Warning Zone)
379 	 */
380 	daddr_t		partition;	/* Absolute from BOT */
381 	daddr_t		fileno;		/* Relative to beginning of partition */
382 	daddr_t		blkno;		/* Relative to last file mark */
383 	daddr_t		rep_blkno;	/* Relative to beginning of partition */
384 	daddr_t		rep_fileno;	/* Relative to beginning of partition */
385 	int		bop;		/* Beginning of Partition */
386 	int		eop;		/* End of Partition */
387 	int		bpew;		/* Beyond Programmable Early Warning */
388 
389 	/*
390 	 * Latched Error Info
391 	 */
392 	struct {
393 		struct scsi_sense_data _last_io_sense;
394 		u_int64_t _last_io_resid;
395 		u_int8_t _last_io_cdb[CAM_MAX_CDBLEN];
396 		struct scsi_sense_data _last_ctl_sense;
397 		u_int64_t _last_ctl_resid;
398 		u_int8_t _last_ctl_cdb[CAM_MAX_CDBLEN];
399 #define	last_io_sense	errinfo._last_io_sense
400 #define	last_io_resid	errinfo._last_io_resid
401 #define	last_io_cdb	errinfo._last_io_cdb
402 #define	last_ctl_sense	errinfo._last_ctl_sense
403 #define	last_ctl_resid	errinfo._last_ctl_resid
404 #define	last_ctl_cdb	errinfo._last_ctl_cdb
405 	} errinfo;
406 	/*
407 	 * Misc other flags/state
408 	 */
409 	u_int32_t
410 					: 29,
411 		open_rdonly		: 1,	/* open read-only */
412 		open_pending_mount	: 1,	/* open pending mount */
413 		ctrl_mode		: 1;	/* control device open */
414 
415 	struct task		sysctl_task;
416 	struct sysctl_ctx_list	sysctl_ctx;
417 	struct sysctl_oid	*sysctl_tree;
418 };
419 
420 struct sa_quirk_entry {
421 	struct scsi_inquiry_pattern inq_pat;	/* matching pattern */
422 	sa_quirks quirks;	/* specific quirk type */
423 	u_int32_t prefblk;	/* preferred blocksize when in fixed mode */
424 };
425 
426 static struct sa_quirk_entry sa_quirk_table[] =
427 {
428 	{
429 		{ T_SEQUENTIAL, SIP_MEDIA_REMOVABLE, "OnStream",
430 		  "ADR*", "*"}, SA_QUIRK_FIXED|SA_QUIRK_NODREAD |
431 		   SA_QUIRK_1FM|SA_QUIRK_NO_MODESEL, 32768
432 	},
433 	{
434 		{ T_SEQUENTIAL, SIP_MEDIA_REMOVABLE, "ARCHIVE",
435 		  "Python 06408*", "*"}, SA_QUIRK_NODREAD, 0
436 	},
437 	{
438 		{ T_SEQUENTIAL, SIP_MEDIA_REMOVABLE, "ARCHIVE",
439 		  "Python 25601*", "*"}, SA_QUIRK_NOCOMP|SA_QUIRK_NODREAD, 0
440 	},
441 	{
442 		{ T_SEQUENTIAL, SIP_MEDIA_REMOVABLE, "ARCHIVE",
443 		  "Python*", "*"}, SA_QUIRK_NODREAD, 0
444 	},
445 	{
446 		{ T_SEQUENTIAL, SIP_MEDIA_REMOVABLE, "ARCHIVE",
447 		  "VIPER 150*", "*"}, SA_QUIRK_FIXED|SA_QUIRK_1FM, 512
448 	},
449 	{
450 		{ T_SEQUENTIAL, SIP_MEDIA_REMOVABLE, "ARCHIVE",
451 		  "VIPER 2525 25462", "-011"},
452 		  SA_QUIRK_NOCOMP|SA_QUIRK_1FM|SA_QUIRK_NODREAD, 0
453 	},
454 	{
455 		{ T_SEQUENTIAL, SIP_MEDIA_REMOVABLE, "ARCHIVE",
456 		  "VIPER 2525*", "*"}, SA_QUIRK_FIXED|SA_QUIRK_1FM, 1024
457 	},
458 #if	0
459 	{
460 		{ T_SEQUENTIAL, SIP_MEDIA_REMOVABLE, "HP",
461 		  "C15*", "*"}, SA_QUIRK_VARIABLE|SA_QUIRK_NO_CPAGE, 0,
462 	},
463 #endif
464  	{
465  		{ T_SEQUENTIAL, SIP_MEDIA_REMOVABLE, "HP",
466 		  "C56*", "*"}, SA_QUIRK_VARIABLE|SA_QUIRK_2FM, 0
467 	},
468 	{
469 		{ T_SEQUENTIAL, SIP_MEDIA_REMOVABLE, "HP",
470 		  "T20*", "*"}, SA_QUIRK_FIXED|SA_QUIRK_1FM, 512
471 	},
472 	{
473 		{ T_SEQUENTIAL, SIP_MEDIA_REMOVABLE, "HP",
474 		  "T4000*", "*"}, SA_QUIRK_FIXED|SA_QUIRK_1FM, 512
475 	},
476 	{
477 		{ T_SEQUENTIAL, SIP_MEDIA_REMOVABLE, "HP",
478 		  "HP-88780*", "*"}, SA_QUIRK_VARIABLE|SA_QUIRK_2FM, 0
479 	},
480 	{
481 		{ T_SEQUENTIAL, SIP_MEDIA_REMOVABLE, "KENNEDY",
482 		  "*", "*"}, SA_QUIRK_VARIABLE|SA_QUIRK_2FM, 0
483 	},
484 	{
485 		{ T_SEQUENTIAL, SIP_MEDIA_REMOVABLE, "M4 DATA",
486 		  "123107 SCSI*", "*"}, SA_QUIRK_VARIABLE|SA_QUIRK_2FM, 0
487 	},
488 	{	/* jreynold@primenet.com */
489 		{ T_SEQUENTIAL, SIP_MEDIA_REMOVABLE, "Seagate",
490 		"STT8000N*", "*"}, SA_QUIRK_1FM, 0
491 	},
492 	{	/* mike@sentex.net */
493 		{ T_SEQUENTIAL, SIP_MEDIA_REMOVABLE, "Seagate",
494 		"STT20000*", "*"}, SA_QUIRK_1FM, 0
495 	},
496 	{
497 		{ T_SEQUENTIAL, SIP_MEDIA_REMOVABLE, "SEAGATE",
498 		"DAT    06241-XXX", "*"}, SA_QUIRK_VARIABLE|SA_QUIRK_2FM, 0
499 	},
500 	{
501 		{ T_SEQUENTIAL, SIP_MEDIA_REMOVABLE, "TANDBERG",
502 		  " TDC 3600", "U07:"}, SA_QUIRK_NOCOMP|SA_QUIRK_1FM, 512
503 	},
504 	{
505 		{ T_SEQUENTIAL, SIP_MEDIA_REMOVABLE, "TANDBERG",
506 		  " TDC 3800", "*"}, SA_QUIRK_NOCOMP|SA_QUIRK_1FM, 512
507 	},
508 	{
509 		{ T_SEQUENTIAL, SIP_MEDIA_REMOVABLE, "TANDBERG",
510 		  " TDC 4100", "*"}, SA_QUIRK_NOCOMP|SA_QUIRK_1FM, 512
511 	},
512 	{
513 		{ T_SEQUENTIAL, SIP_MEDIA_REMOVABLE, "TANDBERG",
514 		  " TDC 4200", "*"}, SA_QUIRK_NOCOMP|SA_QUIRK_1FM, 512
515 	},
516 	{
517 		{ T_SEQUENTIAL, SIP_MEDIA_REMOVABLE, "TANDBERG",
518 		  " SLR*", "*"}, SA_QUIRK_1FM, 0
519 	},
520 	{
521 		{ T_SEQUENTIAL, SIP_MEDIA_REMOVABLE, "WANGTEK",
522 		  "5525ES*", "*"}, SA_QUIRK_FIXED|SA_QUIRK_1FM, 512
523 	},
524 	{
525 		{ T_SEQUENTIAL, SIP_MEDIA_REMOVABLE, "WANGTEK",
526 		  "51000*", "*"}, SA_QUIRK_FIXED|SA_QUIRK_1FM, 1024
527 	}
528 };
529 
530 static	d_open_t	saopen;
531 static	d_close_t	saclose;
532 static	d_strategy_t	sastrategy;
533 static	d_ioctl_t	saioctl;
534 static	periph_init_t	sainit;
535 static	periph_ctor_t	saregister;
536 static	periph_oninv_t	saoninvalidate;
537 static	periph_dtor_t	sacleanup;
538 static	periph_start_t	sastart;
539 static	void		saasync(void *callback_arg, u_int32_t code,
540 				struct cam_path *path, void *arg);
541 static	void		sadone(struct cam_periph *periph,
542 			       union ccb *start_ccb);
543 static  int		saerror(union ccb *ccb, u_int32_t cam_flags,
544 				u_int32_t sense_flags);
545 static int		samarkswanted(struct cam_periph *);
546 static int		sacheckeod(struct cam_periph *periph);
547 static int		sagetparams(struct cam_periph *periph,
548 				    sa_params params_to_get,
549 				    u_int32_t *blocksize, u_int8_t *density,
550 				    u_int32_t *numblocks, int *buff_mode,
551 				    u_int8_t *write_protect, u_int8_t *speed,
552 				    int *comp_supported, int *comp_enabled,
553 				    u_int32_t *comp_algorithm,
554 				    sa_comp_t *comp_page,
555 				    struct scsi_control_data_prot_subpage
556 				    *prot_page, int dp_size,
557 				    int prot_changeable);
558 static int		sasetprot(struct cam_periph *periph,
559 				  struct sa_prot_state *new_prot);
560 static int		sasetparams(struct cam_periph *periph,
561 				    sa_params params_to_set,
562 				    u_int32_t blocksize, u_int8_t density,
563 				    u_int32_t comp_algorithm,
564 				    u_int32_t sense_flags);
565 static int		sasetsili(struct cam_periph *periph,
566 				  struct mtparamset *ps, int num_params);
567 static int		saseteotwarn(struct cam_periph *periph,
568 				     struct mtparamset *ps, int num_params);
569 static void		safillprot(struct sa_softc *softc, int *indent,
570 				   struct sbuf *sb);
571 static void		sapopulateprots(struct sa_prot_state *cur_state,
572 					struct sa_prot_map *new_table,
573 					int table_ents);
574 static struct sa_prot_map *safindprotent(char *name, struct sa_prot_map *table,
575 					 int table_ents);
576 static int		sasetprotents(struct cam_periph *periph,
577 				      struct mtparamset *ps, int num_params);
578 static struct sa_param_ent *safindparament(struct mtparamset *ps);
579 static int		saparamsetlist(struct cam_periph *periph,
580 				       struct mtsetlist *list, int need_copy);
581 static	int		saextget(struct cdev *dev, struct cam_periph *periph,
582 				 struct sbuf *sb, struct mtextget *g);
583 static	int		saparamget(struct sa_softc *softc, struct sbuf *sb);
584 static void		saprevent(struct cam_periph *periph, int action);
585 static int		sarewind(struct cam_periph *periph);
586 static int		saspace(struct cam_periph *periph, int count,
587 				scsi_space_code code);
588 static void		sadevgonecb(void *arg);
589 static void		sasetupdev(struct sa_softc *softc, struct cdev *dev);
590 static int		samount(struct cam_periph *, int, struct cdev *);
591 static int		saretension(struct cam_periph *periph);
592 static int		sareservereleaseunit(struct cam_periph *periph,
593 					     int reserve);
594 static int		saloadunload(struct cam_periph *periph, int load);
595 static int		saerase(struct cam_periph *periph, int longerase);
596 static int		sawritefilemarks(struct cam_periph *periph,
597 					 int nmarks, int setmarks, int immed);
598 static int		sagetpos(struct cam_periph *periph);
599 static int		sardpos(struct cam_periph *periph, int, u_int32_t *);
600 static int		sasetpos(struct cam_periph *periph, int,
601 				 struct mtlocate *);
602 static void		safilldenstypesb(struct sbuf *sb, int *indent,
603 					 uint8_t *buf, int buf_len,
604 					 int is_density);
605 static void		safilldensitysb(struct sa_softc *softc, int *indent,
606 					struct sbuf *sb);
607 
608 
609 #ifndef	SA_DEFAULT_IO_SPLIT
610 #define	SA_DEFAULT_IO_SPLIT	0
611 #endif
612 
613 static int sa_allow_io_split = SA_DEFAULT_IO_SPLIT;
614 
615 /*
616  * Tunable to allow the user to set a global allow_io_split value.  Note
617  * that this WILL GO AWAY in FreeBSD 11.0.  Silently splitting the I/O up
618  * is bad behavior, because it hides the true tape block size from the
619  * application.
620  */
621 static SYSCTL_NODE(_kern_cam, OID_AUTO, sa, CTLFLAG_RD, 0,
622 		  "CAM Sequential Access Tape Driver");
623 SYSCTL_INT(_kern_cam_sa, OID_AUTO, allow_io_split, CTLFLAG_RDTUN,
624     &sa_allow_io_split, 0, "Default I/O split value");
625 
626 static struct periph_driver sadriver =
627 {
628 	sainit, "sa",
629 	TAILQ_HEAD_INITIALIZER(sadriver.units), /* generation */ 0
630 };
631 
632 PERIPHDRIVER_DECLARE(sa, sadriver);
633 
634 /* For 2.2-stable support */
635 #ifndef D_TAPE
636 #define D_TAPE 0
637 #endif
638 
639 
640 static struct cdevsw sa_cdevsw = {
641 	.d_version =	D_VERSION,
642 	.d_open =	saopen,
643 	.d_close =	saclose,
644 	.d_read =	physread,
645 	.d_write =	physwrite,
646 	.d_ioctl =	saioctl,
647 	.d_strategy =	sastrategy,
648 	.d_name =	"sa",
649 	.d_flags =	D_TAPE | D_TRACKCLOSE,
650 };
651 
652 static int
653 saopen(struct cdev *dev, int flags, int fmt, struct thread *td)
654 {
655 	struct cam_periph *periph;
656 	struct sa_softc *softc;
657 	int error;
658 
659 	periph = (struct cam_periph *)dev->si_drv1;
660 	if (cam_periph_acquire(periph) != 0) {
661 		return (ENXIO);
662 	}
663 
664 	cam_periph_lock(periph);
665 
666 	softc = (struct sa_softc *)periph->softc;
667 
668 	CAM_DEBUG(periph->path, CAM_DEBUG_TRACE|CAM_DEBUG_INFO,
669 	    ("saopen(%s): softc=0x%x\n", devtoname(dev), softc->flags));
670 
671 	if (SA_IS_CTRL(dev)) {
672 		softc->ctrl_mode = 1;
673 		softc->open_count++;
674 		cam_periph_unlock(periph);
675 		return (0);
676 	}
677 
678 	if ((error = cam_periph_hold(periph, PRIBIO|PCATCH)) != 0) {
679 		cam_periph_unlock(periph);
680 		cam_periph_release(periph);
681 		return (error);
682 	}
683 
684 	if (softc->flags & SA_FLAG_OPEN) {
685 		error = EBUSY;
686 	} else if (softc->flags & SA_FLAG_INVALID) {
687 		error = ENXIO;
688 	} else {
689 		/*
690 		 * Preserve whether this is a read_only open.
691 		 */
692 		softc->open_rdonly = (flags & O_RDWR) == O_RDONLY;
693 
694 		/*
695 		 * The function samount ensures media is loaded and ready.
696 		 * It also does a device RESERVE if the tape isn't yet mounted.
697 		 *
698 		 * If the mount fails and this was a non-blocking open,
699 		 * make this a 'open_pending_mount' action.
700 		 */
701 		error = samount(periph, flags, dev);
702 		if (error && (flags & O_NONBLOCK)) {
703 			softc->flags |= SA_FLAG_OPEN;
704 			softc->open_pending_mount = 1;
705 			softc->open_count++;
706 			cam_periph_unhold(periph);
707 			cam_periph_unlock(periph);
708 			return (0);
709 		}
710 	}
711 
712 	if (error) {
713 		cam_periph_unhold(periph);
714 		cam_periph_unlock(periph);
715 		cam_periph_release(periph);
716 		return (error);
717 	}
718 
719 	saprevent(periph, PR_PREVENT);
720 	softc->flags |= SA_FLAG_OPEN;
721 	softc->open_count++;
722 
723 	cam_periph_unhold(periph);
724 	cam_periph_unlock(periph);
725 	return (error);
726 }
727 
728 static int
729 saclose(struct cdev *dev, int flag, int fmt, struct thread *td)
730 {
731 	struct	cam_periph *periph;
732 	struct	sa_softc *softc;
733 	int	mode, error, writing, tmp, i;
734 	int	closedbits = SA_FLAG_OPEN;
735 
736 	mode = SAMODE(dev);
737 	periph = (struct cam_periph *)dev->si_drv1;
738 	cam_periph_lock(periph);
739 
740 	softc = (struct sa_softc *)periph->softc;
741 
742 	CAM_DEBUG(periph->path, CAM_DEBUG_TRACE|CAM_DEBUG_INFO,
743 	    ("saclose(%s): softc=0x%x\n", devtoname(dev), softc->flags));
744 
745 
746 	softc->open_rdonly = 0;
747 	if (SA_IS_CTRL(dev)) {
748 		softc->ctrl_mode = 0;
749 		softc->open_count--;
750 		cam_periph_unlock(periph);
751 		cam_periph_release(periph);
752 		return (0);
753 	}
754 
755 	if (softc->open_pending_mount) {
756 		softc->flags &= ~SA_FLAG_OPEN;
757 		softc->open_pending_mount = 0;
758 		softc->open_count--;
759 		cam_periph_unlock(periph);
760 		cam_periph_release(periph);
761 		return (0);
762 	}
763 
764 	if ((error = cam_periph_hold(periph, PRIBIO)) != 0) {
765 		cam_periph_unlock(periph);
766 		return (error);
767 	}
768 
769 	/*
770 	 * Were we writing the tape?
771 	 */
772 	writing = (softc->flags & SA_FLAG_TAPE_WRITTEN) != 0;
773 
774 	/*
775 	 * See whether or not we need to write filemarks. If this
776 	 * fails, we probably have to assume we've lost tape
777 	 * position.
778 	 */
779 	error = sacheckeod(periph);
780 	if (error) {
781 		xpt_print(periph->path,
782 		    "failed to write terminating filemark(s)\n");
783 		softc->flags |= SA_FLAG_TAPE_FROZEN;
784 	}
785 
786 	/*
787 	 * Whatever we end up doing, allow users to eject tapes from here on.
788 	 */
789 	saprevent(periph, PR_ALLOW);
790 
791 	/*
792 	 * Decide how to end...
793 	 */
794 	if ((softc->flags & SA_FLAG_TAPE_MOUNTED) == 0) {
795 		closedbits |= SA_FLAG_TAPE_FROZEN;
796 	} else switch (mode) {
797 	case SA_MODE_OFFLINE:
798 		/*
799 		 * An 'offline' close is an unconditional release of
800 		 * frozen && mount conditions, irrespective of whether
801 		 * these operations succeeded. The reason for this is
802 		 * to allow at least some kind of programmatic way
803 		 * around our state getting all fouled up. If somebody
804 		 * issues an 'offline' command, that will be allowed
805 		 * to clear state.
806 		 */
807 		(void) sarewind(periph);
808 		(void) saloadunload(periph, FALSE);
809 		closedbits |= SA_FLAG_TAPE_MOUNTED|SA_FLAG_TAPE_FROZEN;
810 		break;
811 	case SA_MODE_REWIND:
812 		/*
813 		 * If the rewind fails, return an error- if anyone cares,
814 		 * but not overwriting any previous error.
815 		 *
816 		 * We don't clear the notion of mounted here, but we do
817 		 * clear the notion of frozen if we successfully rewound.
818 		 */
819 		tmp = sarewind(periph);
820 		if (tmp) {
821 			if (error != 0)
822 				error = tmp;
823 		} else {
824 			closedbits |= SA_FLAG_TAPE_FROZEN;
825 		}
826 		break;
827 	case SA_MODE_NOREWIND:
828 		/*
829 		 * If we're not rewinding/unloading the tape, find out
830 		 * whether we need to back up over one of two filemarks
831 		 * we wrote (if we wrote two filemarks) so that appends
832 		 * from this point on will be sane.
833 		 */
834 		if (error == 0 && writing && (softc->quirks & SA_QUIRK_2FM)) {
835 			tmp = saspace(periph, -1, SS_FILEMARKS);
836 			if (tmp) {
837 				xpt_print(periph->path, "unable to backspace "
838 				    "over one of double filemarks at end of "
839 				    "tape\n");
840 				xpt_print(periph->path, "it is possible that "
841 				    "this device needs a SA_QUIRK_1FM quirk set"
842 				    "for it\n");
843 				softc->flags |= SA_FLAG_TAPE_FROZEN;
844 			}
845 		}
846 		break;
847 	default:
848 		xpt_print(periph->path, "unknown mode 0x%x in saclose\n", mode);
849 		/* NOTREACHED */
850 		break;
851 	}
852 
853 	/*
854 	 * We wish to note here that there are no more filemarks to be written.
855 	 */
856 	softc->filemarks = 0;
857 	softc->flags &= ~SA_FLAG_TAPE_WRITTEN;
858 
859 	/*
860 	 * And we are no longer open for business.
861 	 */
862 	softc->flags &= ~closedbits;
863 	softc->open_count--;
864 
865 	/*
866 	 * Invalidate any density information that depends on having tape
867 	 * media in the drive.
868 	 */
869 	for (i = 0; i < SA_DENSITY_TYPES; i++) {
870 		if (softc->density_type_bits[i] & SRDS_MEDIA)
871 			softc->density_info_valid[i] = 0;
872 	}
873 
874 	/*
875 	 * Inform users if tape state if frozen....
876 	 */
877 	if (softc->flags & SA_FLAG_TAPE_FROZEN) {
878 		xpt_print(periph->path, "tape is now frozen- use an OFFLINE, "
879 		    "REWIND or MTEOM command to clear this state.\n");
880 	}
881 
882 	/* release the device if it is no longer mounted */
883 	if ((softc->flags & SA_FLAG_TAPE_MOUNTED) == 0)
884 		sareservereleaseunit(periph, FALSE);
885 
886 	cam_periph_unhold(periph);
887 	cam_periph_unlock(periph);
888 	cam_periph_release(periph);
889 
890 	return (error);
891 }
892 
893 /*
894  * Actually translate the requested transfer into one the physical driver
895  * can understand.  The transfer is described by a buf and will include
896  * only one physical transfer.
897  */
898 static void
899 sastrategy(struct bio *bp)
900 {
901 	struct cam_periph *periph;
902 	struct sa_softc *softc;
903 
904 	bp->bio_resid = bp->bio_bcount;
905 	if (SA_IS_CTRL(bp->bio_dev)) {
906 		biofinish(bp, NULL, EINVAL);
907 		return;
908 	}
909 	periph = (struct cam_periph *)bp->bio_dev->si_drv1;
910 	cam_periph_lock(periph);
911 
912 	softc = (struct sa_softc *)periph->softc;
913 
914 	if (softc->flags & SA_FLAG_INVALID) {
915 		cam_periph_unlock(periph);
916 		biofinish(bp, NULL, ENXIO);
917 		return;
918 	}
919 
920 	if (softc->flags & SA_FLAG_TAPE_FROZEN) {
921 		cam_periph_unlock(periph);
922 		biofinish(bp, NULL, EPERM);
923 		return;
924 	}
925 
926 	/*
927 	 * This should actually never occur as the write(2)
928 	 * system call traps attempts to write to a read-only
929 	 * file descriptor.
930 	 */
931 	if (bp->bio_cmd == BIO_WRITE && softc->open_rdonly) {
932 		cam_periph_unlock(periph);
933 		biofinish(bp, NULL, EBADF);
934 		return;
935 	}
936 
937 	if (softc->open_pending_mount) {
938 		int error = samount(periph, 0, bp->bio_dev);
939 		if (error) {
940 			cam_periph_unlock(periph);
941 			biofinish(bp, NULL, ENXIO);
942 			return;
943 		}
944 		saprevent(periph, PR_PREVENT);
945 		softc->open_pending_mount = 0;
946 	}
947 
948 
949 	/*
950 	 * If it's a null transfer, return immediately
951 	 */
952 	if (bp->bio_bcount == 0) {
953 		cam_periph_unlock(periph);
954 		biodone(bp);
955 		return;
956 	}
957 
958 	/* valid request?  */
959 	if (softc->flags & SA_FLAG_FIXED) {
960 		/*
961 		 * Fixed block device.  The byte count must
962 		 * be a multiple of our block size.
963 		 */
964 		if (((softc->blk_mask != ~0) &&
965 		    ((bp->bio_bcount & softc->blk_mask) != 0)) ||
966 		    ((softc->blk_mask == ~0) &&
967 		    ((bp->bio_bcount % softc->min_blk) != 0))) {
968 			xpt_print(periph->path, "Invalid request.  Fixed block "
969 			    "device requests must be a multiple of %d bytes\n",
970 			    softc->min_blk);
971 			cam_periph_unlock(periph);
972 			biofinish(bp, NULL, EINVAL);
973 			return;
974 		}
975 	} else if ((bp->bio_bcount > softc->max_blk) ||
976 		   (bp->bio_bcount < softc->min_blk) ||
977 		   (bp->bio_bcount & softc->blk_mask) != 0) {
978 
979 		xpt_print_path(periph->path);
980 		printf("Invalid request.  Variable block "
981 		    "device requests must be ");
982 		if (softc->blk_mask != 0) {
983 			printf("a multiple of %d ", (0x1 << softc->blk_gran));
984 		}
985 		printf("between %d and %d bytes\n", softc->min_blk,
986 		    softc->max_blk);
987 		cam_periph_unlock(periph);
988 		biofinish(bp, NULL, EINVAL);
989 		return;
990         }
991 
992 	/*
993 	 * Place it at the end of the queue.
994 	 */
995 	bioq_insert_tail(&softc->bio_queue, bp);
996 	softc->queue_count++;
997 #if	0
998 	CAM_DEBUG(periph->path, CAM_DEBUG_INFO,
999 	    ("sastrategy: queuing a %ld %s byte %s\n", bp->bio_bcount,
1000  	    (softc->flags & SA_FLAG_FIXED)?  "fixed" : "variable",
1001 	    (bp->bio_cmd == BIO_READ)? "read" : "write"));
1002 #endif
1003 	if (softc->queue_count > 1) {
1004 		CAM_DEBUG(periph->path, CAM_DEBUG_INFO,
1005 		    ("sastrategy: queue count now %d\n", softc->queue_count));
1006 	}
1007 
1008 	/*
1009 	 * Schedule ourselves for performing the work.
1010 	 */
1011 	xpt_schedule(periph, CAM_PRIORITY_NORMAL);
1012 	cam_periph_unlock(periph);
1013 
1014 	return;
1015 }
1016 
1017 static int
1018 sasetsili(struct cam_periph *periph, struct mtparamset *ps, int num_params)
1019 {
1020 	uint32_t sili_blocksize;
1021 	struct sa_softc *softc;
1022 	int error;
1023 
1024 	error = 0;
1025 	softc = (struct sa_softc *)periph->softc;
1026 
1027 	if (ps->value_type != MT_PARAM_SET_SIGNED) {
1028 		snprintf(ps->error_str, sizeof(ps->error_str),
1029 		    "sili is a signed parameter");
1030 		goto bailout;
1031 	}
1032 	if ((ps->value.value_signed < 0)
1033 	 || (ps->value.value_signed > 1)) {
1034 		snprintf(ps->error_str, sizeof(ps->error_str),
1035 		    "invalid sili value %jd", (intmax_t)ps->value.value_signed);
1036 		goto bailout_error;
1037 	}
1038 	/*
1039 	 * We only set the SILI flag in variable block
1040 	 * mode.  You'll get a check condition in fixed
1041 	 * block mode if things don't line up in any case.
1042 	 */
1043 	if (softc->flags & SA_FLAG_FIXED) {
1044 		snprintf(ps->error_str, sizeof(ps->error_str),
1045 		    "can't set sili bit in fixed block mode");
1046 		goto bailout_error;
1047 	}
1048 	if (softc->sili == ps->value.value_signed)
1049 		goto bailout;
1050 
1051 	if (ps->value.value_signed == 1)
1052 		sili_blocksize = 4;
1053 	else
1054 		sili_blocksize = 0;
1055 
1056 	error = sasetparams(periph, SA_PARAM_BLOCKSIZE,
1057 			    sili_blocksize, 0, 0, SF_QUIET_IR);
1058 	if (error != 0) {
1059 		snprintf(ps->error_str, sizeof(ps->error_str),
1060 		    "sasetparams() returned error %d", error);
1061 		goto bailout_error;
1062 	}
1063 
1064 	softc->sili = ps->value.value_signed;
1065 
1066 bailout:
1067 	ps->status = MT_PARAM_STATUS_OK;
1068 	return (error);
1069 
1070 bailout_error:
1071 	ps->status = MT_PARAM_STATUS_ERROR;
1072 	if (error == 0)
1073 		error = EINVAL;
1074 
1075 	return (error);
1076 }
1077 
1078 static int
1079 saseteotwarn(struct cam_periph *periph, struct mtparamset *ps, int num_params)
1080 {
1081 	struct sa_softc *softc;
1082 	int error;
1083 
1084 	error = 0;
1085 	softc = (struct sa_softc *)periph->softc;
1086 
1087 	if (ps->value_type != MT_PARAM_SET_SIGNED) {
1088 		snprintf(ps->error_str, sizeof(ps->error_str),
1089 		    "eot_warn is a signed parameter");
1090 		ps->status = MT_PARAM_STATUS_ERROR;
1091 		goto bailout;
1092 	}
1093 	if ((ps->value.value_signed < 0)
1094 	 || (ps->value.value_signed > 1)) {
1095 		snprintf(ps->error_str, sizeof(ps->error_str),
1096 		    "invalid eot_warn value %jd\n",
1097 		    (intmax_t)ps->value.value_signed);
1098 		ps->status = MT_PARAM_STATUS_ERROR;
1099 		goto bailout;
1100 	}
1101 	softc->eot_warn = ps->value.value_signed;
1102 	ps->status = MT_PARAM_STATUS_OK;
1103 bailout:
1104 	if (ps->status != MT_PARAM_STATUS_OK)
1105 		error = EINVAL;
1106 
1107 	return (error);
1108 }
1109 
1110 
1111 static void
1112 safillprot(struct sa_softc *softc, int *indent, struct sbuf *sb)
1113 {
1114 	int tmpint;
1115 
1116 	SASBADDNODE(sb, *indent, protection);
1117 	if (softc->flags & SA_FLAG_PROTECT_SUPP)
1118 		tmpint = 1;
1119 	else
1120 		tmpint = 0;
1121 	SASBADDINTDESC(sb, *indent, tmpint, %d, protection_supported,
1122 	    "Set to 1 if protection information is supported");
1123 
1124 	if ((tmpint != 0)
1125 	 && (softc->prot_info.cur_prot_state.initialized != 0)) {
1126 		struct sa_prot_state *prot;
1127 
1128 		prot = &softc->prot_info.cur_prot_state;
1129 
1130 		SASBADDUINTDESC(sb, *indent, prot->prot_method, %u,
1131 		    prot_method, "Current Protection Method");
1132 		SASBADDUINTDESC(sb, *indent, prot->pi_length, %u,
1133 		    pi_length, "Length of Protection Information");
1134 		SASBADDUINTDESC(sb, *indent, prot->lbp_w, %u,
1135 		    lbp_w, "Check Protection on Writes");
1136 		SASBADDUINTDESC(sb, *indent, prot->lbp_r, %u,
1137 		    lbp_r, "Check and Include Protection on Reads");
1138 		SASBADDUINTDESC(sb, *indent, prot->rbdp, %u,
1139 		    rbdp, "Transfer Protection Information for RECOVER "
1140 		    "BUFFERED DATA command");
1141 	}
1142 	SASBENDNODE(sb, *indent, protection);
1143 }
1144 
1145 static void
1146 sapopulateprots(struct sa_prot_state *cur_state, struct sa_prot_map *new_table,
1147     int table_ents)
1148 {
1149 	int i;
1150 
1151 	bcopy(sa_prot_table, new_table, min(table_ents * sizeof(*new_table),
1152 	    sizeof(sa_prot_table)));
1153 
1154 	table_ents = min(table_ents, SA_NUM_PROT_ENTS);
1155 
1156 	for (i = 0; i < table_ents; i++)
1157 		new_table[i].value = (uint32_t *)((uint8_t *)cur_state +
1158 		    new_table[i].offset);
1159 
1160 	return;
1161 }
1162 
1163 static struct sa_prot_map *
1164 safindprotent(char *name, struct sa_prot_map *table, int table_ents)
1165 {
1166 	char *prot_name = "protection.";
1167 	int i, prot_len;
1168 
1169 	prot_len = strlen(prot_name);
1170 
1171 	/*
1172 	 * This shouldn't happen, but we check just in case.
1173 	 */
1174 	if (strncmp(name, prot_name, prot_len) != 0)
1175 		goto bailout;
1176 
1177 	for (i = 0; i < table_ents; i++) {
1178 		if (strcmp(&name[prot_len], table[i].name) != 0)
1179 			continue;
1180 		return (&table[i]);
1181 	}
1182 bailout:
1183 	return (NULL);
1184 }
1185 
1186 static int
1187 sasetprotents(struct cam_periph *periph, struct mtparamset *ps, int num_params)
1188 {
1189 	struct sa_softc *softc;
1190 	struct sa_prot_map prot_ents[SA_NUM_PROT_ENTS];
1191 	struct sa_prot_state new_state;
1192 	int error;
1193 	int i;
1194 
1195 	softc = (struct sa_softc *)periph->softc;
1196 	error = 0;
1197 
1198 	/*
1199 	 * Make sure that this tape drive supports protection information.
1200 	 * Otherwise we can't set anything.
1201 	 */
1202 	if ((softc->flags & SA_FLAG_PROTECT_SUPP) == 0) {
1203 		snprintf(ps[0].error_str, sizeof(ps[0].error_str),
1204 		    "Protection information is not supported for this device");
1205 		ps[0].status = MT_PARAM_STATUS_ERROR;
1206 		goto bailout;
1207 	}
1208 
1209 	/*
1210 	 * We can't operate with physio(9) splitting enabled, because there
1211 	 * is no way to insure (especially in variable block mode) that
1212 	 * what the user writes (with a checksum block at the end) will
1213 	 * make it into the sa(4) driver intact.
1214 	 */
1215 	if ((softc->si_flags & SI_NOSPLIT) == 0) {
1216 		snprintf(ps[0].error_str, sizeof(ps[0].error_str),
1217 		    "Protection information cannot be enabled with I/O "
1218 		    "splitting");
1219 		ps[0].status = MT_PARAM_STATUS_ERROR;
1220 		goto bailout;
1221 	}
1222 
1223 	/*
1224 	 * Take the current cached protection state and use that as the
1225 	 * basis for our new entries.
1226 	 */
1227 	bcopy(&softc->prot_info.cur_prot_state, &new_state, sizeof(new_state));
1228 
1229 	/*
1230 	 * Populate the table mapping property names to pointers into the
1231 	 * state structure.
1232 	 */
1233 	sapopulateprots(&new_state, prot_ents, SA_NUM_PROT_ENTS);
1234 
1235 	/*
1236 	 * For each parameter the user passed in, make sure the name, type
1237 	 * and value are valid.
1238 	 */
1239 	for (i = 0; i < num_params; i++) {
1240 		struct sa_prot_map *ent;
1241 
1242 		ent = safindprotent(ps[i].value_name, prot_ents,
1243 		    SA_NUM_PROT_ENTS);
1244 		if (ent == NULL) {
1245 			ps[i].status = MT_PARAM_STATUS_ERROR;
1246 			snprintf(ps[i].error_str, sizeof(ps[i].error_str),
1247 			    "Invalid protection entry name %s",
1248 			    ps[i].value_name);
1249 			error = EINVAL;
1250 			goto bailout;
1251 		}
1252 		if (ent->param_type != ps[i].value_type) {
1253 			ps[i].status = MT_PARAM_STATUS_ERROR;
1254 			snprintf(ps[i].error_str, sizeof(ps[i].error_str),
1255 			    "Supplied type %d does not match actual type %d",
1256 			    ps[i].value_type, ent->param_type);
1257 			error = EINVAL;
1258 			goto bailout;
1259 		}
1260 		if ((ps[i].value.value_unsigned < ent->min_val)
1261 		 || (ps[i].value.value_unsigned > ent->max_val)) {
1262 			ps[i].status = MT_PARAM_STATUS_ERROR;
1263 			snprintf(ps[i].error_str, sizeof(ps[i].error_str),
1264 			    "Value %ju is outside valid range %u - %u",
1265 			    (uintmax_t)ps[i].value.value_unsigned, ent->min_val,
1266 			    ent->max_val);
1267 			error = EINVAL;
1268 			goto bailout;
1269 		}
1270 		*(ent->value) = ps[i].value.value_unsigned;
1271 	}
1272 
1273 	/*
1274 	 * Actually send the protection settings to the drive.
1275 	 */
1276 	error = sasetprot(periph, &new_state);
1277 	if (error != 0) {
1278 		for (i = 0; i < num_params; i++) {
1279 			ps[i].status = MT_PARAM_STATUS_ERROR;
1280 			snprintf(ps[i].error_str, sizeof(ps[i].error_str),
1281 			    "Unable to set parameter, see dmesg(8)");
1282 		}
1283 		goto bailout;
1284 	}
1285 
1286 	/*
1287 	 * Let the user know that his settings were stored successfully.
1288 	 */
1289 	for (i = 0; i < num_params; i++)
1290 		ps[i].status = MT_PARAM_STATUS_OK;
1291 
1292 bailout:
1293 	return (error);
1294 }
1295 /*
1296  * Entry handlers generally only handle a single entry.  Node handlers will
1297  * handle a contiguous range of parameters to set in a single call.
1298  */
1299 typedef enum {
1300 	SA_PARAM_TYPE_ENTRY,
1301 	SA_PARAM_TYPE_NODE
1302 } sa_param_type;
1303 
1304 struct sa_param_ent {
1305 	char *name;
1306 	sa_param_type param_type;
1307 	int (*set_func)(struct cam_periph *periph, struct mtparamset *ps,
1308 			int num_params);
1309 } sa_param_table[] = {
1310 	{"sili", SA_PARAM_TYPE_ENTRY, sasetsili },
1311 	{"eot_warn", SA_PARAM_TYPE_ENTRY, saseteotwarn },
1312 	{"protection.", SA_PARAM_TYPE_NODE, sasetprotents }
1313 };
1314 
1315 static struct sa_param_ent *
1316 safindparament(struct mtparamset *ps)
1317 {
1318 	unsigned int i;
1319 
1320 	for (i = 0; i < nitems(sa_param_table); i++){
1321 		/*
1322 		 * For entries, we compare all of the characters.  For
1323 		 * nodes, we only compare the first N characters.  The node
1324 		 * handler will decode the rest.
1325 		 */
1326 		if (sa_param_table[i].param_type == SA_PARAM_TYPE_ENTRY) {
1327 			if (strcmp(ps->value_name, sa_param_table[i].name) != 0)
1328 				continue;
1329 		} else {
1330 			if (strncmp(ps->value_name, sa_param_table[i].name,
1331 			    strlen(sa_param_table[i].name)) != 0)
1332 				continue;
1333 		}
1334 		return (&sa_param_table[i]);
1335 	}
1336 
1337 	return (NULL);
1338 }
1339 
1340 /*
1341  * Go through a list of parameters, coalescing contiguous parameters with
1342  * the same parent node into a single call to a set_func.
1343  */
1344 static int
1345 saparamsetlist(struct cam_periph *periph, struct mtsetlist *list,
1346     int need_copy)
1347 {
1348 	int i, contig_ents;
1349 	int error;
1350 	struct mtparamset *params, *first;
1351 	struct sa_param_ent *first_ent;
1352 
1353 	error = 0;
1354 	params = NULL;
1355 
1356 	if (list->num_params == 0)
1357 		/* Nothing to do */
1358 		goto bailout;
1359 
1360 	/*
1361 	 * Verify that the user has the correct structure size.
1362 	 */
1363 	if ((list->num_params * sizeof(struct mtparamset)) !=
1364 	     list->param_len) {
1365 		xpt_print(periph->path, "%s: length of params %d != "
1366 		    "sizeof(struct mtparamset) %zd * num_params %d\n",
1367 		    __func__, list->param_len, sizeof(struct mtparamset),
1368 		    list->num_params);
1369 		error = EINVAL;
1370 		goto bailout;
1371 	}
1372 
1373 	if (need_copy != 0) {
1374 		/*
1375 		 * XXX KDM will dropping the lock cause an issue here?
1376 		 */
1377 		cam_periph_unlock(periph);
1378 		params = malloc(list->param_len, M_SCSISA, M_WAITOK | M_ZERO);
1379 		error = copyin(list->params, params, list->param_len);
1380 		cam_periph_lock(periph);
1381 
1382 		if (error != 0)
1383 			goto bailout;
1384 	} else {
1385 		params = list->params;
1386 	}
1387 
1388 	contig_ents = 0;
1389 	first = NULL;
1390 	first_ent = NULL;
1391 	for (i = 0; i < list->num_params; i++) {
1392 		struct sa_param_ent *ent;
1393 
1394 		ent = safindparament(&params[i]);
1395 		if (ent == NULL) {
1396 			snprintf(params[i].error_str,
1397 			    sizeof(params[i].error_str),
1398 			    "%s: cannot find parameter %s", __func__,
1399 			    params[i].value_name);
1400 			params[i].status = MT_PARAM_STATUS_ERROR;
1401 			break;
1402 		}
1403 
1404 		if (first != NULL) {
1405 			if (first_ent == ent) {
1406 				/*
1407 				 * We're still in a contiguous list of
1408 				 * parameters that can be handled by one
1409 				 * node handler.
1410 				 */
1411 				contig_ents++;
1412 				continue;
1413 			} else {
1414 				error = first_ent->set_func(periph, first,
1415 				    contig_ents);
1416 				first = NULL;
1417 				first_ent = NULL;
1418 				contig_ents = 0;
1419 				if (error != 0) {
1420 					error = 0;
1421 					break;
1422 				}
1423 			}
1424 		}
1425 		if (ent->param_type == SA_PARAM_TYPE_NODE) {
1426 			first = &params[i];
1427 			first_ent = ent;
1428 			contig_ents = 1;
1429 		} else {
1430 			error = ent->set_func(periph, &params[i], 1);
1431 			if (error != 0) {
1432 				error = 0;
1433 				break;
1434 			}
1435 		}
1436 	}
1437 	if (first != NULL)
1438 		first_ent->set_func(periph, first, contig_ents);
1439 
1440 bailout:
1441 	if (need_copy != 0) {
1442 		if (error != EFAULT) {
1443 			cam_periph_unlock(periph);
1444 			copyout(params, list->params, list->param_len);
1445 			cam_periph_lock(periph);
1446 		}
1447 		free(params, M_SCSISA);
1448 	}
1449 	return (error);
1450 }
1451 
1452 static int
1453 sagetparams_common(struct cdev *dev, struct cam_periph *periph)
1454 {
1455 	struct sa_softc *softc;
1456 	u_int8_t write_protect;
1457 	int comp_enabled, comp_supported, error;
1458 
1459 	softc = (struct sa_softc *)periph->softc;
1460 
1461 	if (softc->open_pending_mount)
1462 		return (0);
1463 
1464 	/* The control device may issue getparams() if there are no opens. */
1465 	if (SA_IS_CTRL(dev) && (softc->flags & SA_FLAG_OPEN) != 0)
1466 		return (0);
1467 
1468 	error = sagetparams(periph, SA_PARAM_ALL, &softc->media_blksize,
1469 	    &softc->media_density, &softc->media_numblks, &softc->buffer_mode,
1470 	    &write_protect, &softc->speed, &comp_supported, &comp_enabled,
1471 	    &softc->comp_algorithm, NULL, NULL, 0, 0);
1472 	if (error)
1473 		return (error);
1474 	if (write_protect)
1475 		softc->flags |= SA_FLAG_TAPE_WP;
1476 	else
1477 		softc->flags &= ~SA_FLAG_TAPE_WP;
1478 	softc->flags &= ~SA_FLAG_COMPRESSION;
1479 	if (comp_supported) {
1480 		if (softc->saved_comp_algorithm == 0)
1481 			softc->saved_comp_algorithm =
1482 			    softc->comp_algorithm;
1483 		softc->flags |= SA_FLAG_COMP_SUPP;
1484 		if (comp_enabled)
1485 			softc->flags |= SA_FLAG_COMP_ENABLED;
1486 	} else
1487 		softc->flags |= SA_FLAG_COMP_UNSUPP;
1488 
1489 	return (0);
1490 }
1491 
1492 #define	PENDING_MOUNT_CHECK(softc, periph, dev)		\
1493 	if (softc->open_pending_mount) {		\
1494 		error = samount(periph, 0, dev);	\
1495 		if (error) {				\
1496 			break;				\
1497 		}					\
1498 		saprevent(periph, PR_PREVENT);		\
1499 		softc->open_pending_mount = 0;		\
1500 	}
1501 
1502 static int
1503 saioctl(struct cdev *dev, u_long cmd, caddr_t arg, int flag, struct thread *td)
1504 {
1505 	struct cam_periph *periph;
1506 	struct sa_softc *softc;
1507 	scsi_space_code spaceop;
1508 	int didlockperiph = 0;
1509 	int mode;
1510 	int error = 0;
1511 
1512 	mode = SAMODE(dev);
1513 	error = 0;		/* shut up gcc */
1514 	spaceop = 0;		/* shut up gcc */
1515 
1516 	periph = (struct cam_periph *)dev->si_drv1;
1517 	cam_periph_lock(periph);
1518 	softc = (struct sa_softc *)periph->softc;
1519 
1520 	/*
1521 	 * Check for control mode accesses. We allow MTIOCGET and
1522 	 * MTIOCERRSTAT (but need to be the only one open in order
1523 	 * to clear latched status), and MTSETBSIZE, MTSETDNSTY
1524 	 * and MTCOMP (but need to be the only one accessing this
1525 	 * device to run those).
1526 	 */
1527 
1528 	if (SA_IS_CTRL(dev)) {
1529 		switch (cmd) {
1530 		case MTIOCGETEOTMODEL:
1531 		case MTIOCGET:
1532 		case MTIOCEXTGET:
1533 		case MTIOCPARAMGET:
1534 		case MTIOCRBLIM:
1535 			break;
1536 		case MTIOCERRSTAT:
1537 			/*
1538 			 * If the periph isn't already locked, lock it
1539 			 * so our MTIOCERRSTAT can reset latched error stats.
1540 			 *
1541 			 * If the periph is already locked, skip it because
1542 			 * we're just getting status and it'll be up to the
1543 			 * other thread that has this device open to do
1544 			 * an MTIOCERRSTAT that would clear latched status.
1545 			 */
1546 			if ((periph->flags & CAM_PERIPH_LOCKED) == 0) {
1547 				error = cam_periph_hold(periph, PRIBIO|PCATCH);
1548 				if (error != 0) {
1549 					cam_periph_unlock(periph);
1550 					return (error);
1551 				}
1552 				didlockperiph = 1;
1553 			}
1554 			break;
1555 
1556 		case MTIOCTOP:
1557 		{
1558 			struct mtop *mt = (struct mtop *) arg;
1559 
1560 			/*
1561 			 * Check to make sure it's an OP we can perform
1562 			 * with no media inserted.
1563 			 */
1564 			switch (mt->mt_op) {
1565 			case MTSETBSIZ:
1566 			case MTSETDNSTY:
1567 			case MTCOMP:
1568 				mt = NULL;
1569 				/* FALLTHROUGH */
1570 			default:
1571 				break;
1572 			}
1573 			if (mt != NULL) {
1574 				break;
1575 			}
1576 			/* FALLTHROUGH */
1577 		}
1578 		case MTIOCSETEOTMODEL:
1579 			/*
1580 			 * We need to acquire the peripheral here rather
1581 			 * than at open time because we are sharing writable
1582 			 * access to data structures.
1583 			 */
1584 			error = cam_periph_hold(periph, PRIBIO|PCATCH);
1585 			if (error != 0) {
1586 				cam_periph_unlock(periph);
1587 				return (error);
1588 			}
1589 			didlockperiph = 1;
1590 			break;
1591 
1592 		default:
1593 			cam_periph_unlock(periph);
1594 			return (EINVAL);
1595 		}
1596 	}
1597 
1598 	/*
1599 	 * Find the device that the user is talking about
1600 	 */
1601 	switch (cmd) {
1602 	case MTIOCGET:
1603 	{
1604 		struct mtget *g = (struct mtget *)arg;
1605 
1606 		error = sagetparams_common(dev, periph);
1607 		if (error)
1608 			break;
1609 		bzero(g, sizeof(struct mtget));
1610 		g->mt_type = MT_ISAR;
1611 		if (softc->flags & SA_FLAG_COMP_UNSUPP) {
1612 			g->mt_comp = MT_COMP_UNSUPP;
1613 			g->mt_comp0 = MT_COMP_UNSUPP;
1614 			g->mt_comp1 = MT_COMP_UNSUPP;
1615 			g->mt_comp2 = MT_COMP_UNSUPP;
1616 			g->mt_comp3 = MT_COMP_UNSUPP;
1617 		} else {
1618 			if ((softc->flags & SA_FLAG_COMP_ENABLED) == 0) {
1619 				g->mt_comp = MT_COMP_DISABLED;
1620 			} else {
1621 				g->mt_comp = softc->comp_algorithm;
1622 			}
1623 			g->mt_comp0 = softc->comp_algorithm;
1624 			g->mt_comp1 = softc->comp_algorithm;
1625 			g->mt_comp2 = softc->comp_algorithm;
1626 			g->mt_comp3 = softc->comp_algorithm;
1627 		}
1628 		g->mt_density = softc->media_density;
1629 		g->mt_density0 = softc->media_density;
1630 		g->mt_density1 = softc->media_density;
1631 		g->mt_density2 = softc->media_density;
1632 		g->mt_density3 = softc->media_density;
1633 		g->mt_blksiz = softc->media_blksize;
1634 		g->mt_blksiz0 = softc->media_blksize;
1635 		g->mt_blksiz1 = softc->media_blksize;
1636 		g->mt_blksiz2 = softc->media_blksize;
1637 		g->mt_blksiz3 = softc->media_blksize;
1638 		g->mt_fileno = softc->fileno;
1639 		g->mt_blkno = softc->blkno;
1640 		g->mt_dsreg = (short) softc->dsreg;
1641 		/*
1642 		 * Yes, we know that this is likely to overflow
1643 		 */
1644 		if (softc->last_resid_was_io) {
1645 			if ((g->mt_resid = (short) softc->last_io_resid) != 0) {
1646 				if (SA_IS_CTRL(dev) == 0 || didlockperiph) {
1647 					softc->last_io_resid = 0;
1648 				}
1649 			}
1650 		} else {
1651 			if ((g->mt_resid = (short)softc->last_ctl_resid) != 0) {
1652 				if (SA_IS_CTRL(dev) == 0 || didlockperiph) {
1653 					softc->last_ctl_resid = 0;
1654 				}
1655 			}
1656 		}
1657 		error = 0;
1658 		break;
1659 	}
1660 	case MTIOCEXTGET:
1661 	case MTIOCPARAMGET:
1662 	{
1663 		struct mtextget *g = (struct mtextget *)arg;
1664 		char *tmpstr2;
1665 		struct sbuf *sb;
1666 
1667 		/*
1668 		 * Report drive status using an XML format.
1669 		 */
1670 
1671 		/*
1672 		 * XXX KDM will dropping the lock cause any problems here?
1673 		 */
1674 		cam_periph_unlock(periph);
1675 		sb = sbuf_new(NULL, NULL, g->alloc_len, SBUF_FIXEDLEN);
1676 		if (sb == NULL) {
1677 			g->status = MT_EXT_GET_ERROR;
1678 			snprintf(g->error_str, sizeof(g->error_str),
1679 				 "Unable to allocate %d bytes for status info",
1680 				 g->alloc_len);
1681 			cam_periph_lock(periph);
1682 			goto extget_bailout;
1683 		}
1684 		cam_periph_lock(periph);
1685 
1686 		if (cmd == MTIOCEXTGET)
1687 			error = saextget(dev, periph, sb, g);
1688 		else
1689 			error = saparamget(softc, sb);
1690 
1691 		if (error != 0)
1692 			goto extget_bailout;
1693 
1694 		error = sbuf_finish(sb);
1695 		if (error == ENOMEM) {
1696 			g->status = MT_EXT_GET_NEED_MORE_SPACE;
1697 			error = 0;
1698 		} else if (error != 0) {
1699 			g->status = MT_EXT_GET_ERROR;
1700 			snprintf(g->error_str, sizeof(g->error_str),
1701 			    "Error %d returned from sbuf_finish()", error);
1702 		} else
1703 			g->status = MT_EXT_GET_OK;
1704 
1705 		error = 0;
1706 		tmpstr2 = sbuf_data(sb);
1707 		g->fill_len = strlen(tmpstr2) + 1;
1708 		cam_periph_unlock(periph);
1709 
1710 		error = copyout(tmpstr2, g->status_xml, g->fill_len);
1711 
1712 		cam_periph_lock(periph);
1713 
1714 extget_bailout:
1715 		sbuf_delete(sb);
1716 		break;
1717 	}
1718 	case MTIOCPARAMSET:
1719 	{
1720 		struct mtsetlist list;
1721 		struct mtparamset *ps = (struct mtparamset *)arg;
1722 
1723 		bzero(&list, sizeof(list));
1724 		list.num_params = 1;
1725 		list.param_len = sizeof(*ps);
1726 		list.params = ps;
1727 
1728 		error = saparamsetlist(periph, &list, /*need_copy*/ 0);
1729 		break;
1730 	}
1731 	case MTIOCSETLIST:
1732 	{
1733 		struct mtsetlist *list = (struct mtsetlist *)arg;
1734 
1735 		error = saparamsetlist(periph, list, /*need_copy*/ 1);
1736 		break;
1737 	}
1738 	case MTIOCERRSTAT:
1739 	{
1740 		struct scsi_tape_errors *sep =
1741 		    &((union mterrstat *)arg)->scsi_errstat;
1742 
1743 		CAM_DEBUG(periph->path, CAM_DEBUG_TRACE,
1744 		    ("saioctl: MTIOCERRSTAT\n"));
1745 
1746 		bzero(sep, sizeof(*sep));
1747 		sep->io_resid = softc->last_io_resid;
1748 		bcopy((caddr_t) &softc->last_io_sense, sep->io_sense,
1749 		    sizeof (sep->io_sense));
1750 		bcopy((caddr_t) &softc->last_io_cdb, sep->io_cdb,
1751 		    sizeof (sep->io_cdb));
1752 		sep->ctl_resid = softc->last_ctl_resid;
1753 		bcopy((caddr_t) &softc->last_ctl_sense, sep->ctl_sense,
1754 		    sizeof (sep->ctl_sense));
1755 		bcopy((caddr_t) &softc->last_ctl_cdb, sep->ctl_cdb,
1756 		    sizeof (sep->ctl_cdb));
1757 
1758 		if ((SA_IS_CTRL(dev) == 0 && !softc->open_pending_mount) ||
1759 		    didlockperiph)
1760 			bzero((caddr_t) &softc->errinfo,
1761 			    sizeof (softc->errinfo));
1762 		error = 0;
1763 		break;
1764 	}
1765 	case MTIOCTOP:
1766 	{
1767 		struct mtop *mt;
1768 		int    count;
1769 
1770 		PENDING_MOUNT_CHECK(softc, periph, dev);
1771 
1772 		mt = (struct mtop *)arg;
1773 
1774 
1775 		CAM_DEBUG(periph->path, CAM_DEBUG_TRACE,
1776 			 ("saioctl: op=0x%x count=0x%x\n",
1777 			  mt->mt_op, mt->mt_count));
1778 
1779 		count = mt->mt_count;
1780 		switch (mt->mt_op) {
1781 		case MTWEOF:	/* write an end-of-file marker */
1782 			/*
1783 			 * We don't need to clear the SA_FLAG_TAPE_WRITTEN
1784 			 * flag because by keeping track of filemarks
1785 			 * we have last written we know whether or not
1786 			 * we need to write more when we close the device.
1787 			 */
1788 			error = sawritefilemarks(periph, count, FALSE, FALSE);
1789 			break;
1790 		case MTWEOFI:
1791 			/* write an end-of-file marker without waiting */
1792 			error = sawritefilemarks(periph, count, FALSE, TRUE);
1793 			break;
1794 		case MTWSS:	/* write a setmark */
1795 			error = sawritefilemarks(periph, count, TRUE, FALSE);
1796 			break;
1797 		case MTBSR:	/* backward space record */
1798 		case MTFSR:	/* forward space record */
1799 		case MTBSF:	/* backward space file */
1800 		case MTFSF:	/* forward space file */
1801 		case MTBSS:	/* backward space setmark */
1802 		case MTFSS:	/* forward space setmark */
1803 		case MTEOD:	/* space to end of recorded medium */
1804 		{
1805 			int nmarks;
1806 
1807 			spaceop = SS_FILEMARKS;
1808 			nmarks = softc->filemarks;
1809 			error = sacheckeod(periph);
1810 			if (error) {
1811 				xpt_print(periph->path,
1812 				    "EOD check prior to spacing failed\n");
1813 				softc->flags |= SA_FLAG_EIO_PENDING;
1814 				break;
1815 			}
1816 			nmarks -= softc->filemarks;
1817 			switch(mt->mt_op) {
1818 			case MTBSR:
1819 				count = -count;
1820 				/* FALLTHROUGH */
1821 			case MTFSR:
1822 				spaceop = SS_BLOCKS;
1823 				break;
1824 			case MTBSF:
1825 				count = -count;
1826 				/* FALLTHROUGH */
1827 			case MTFSF:
1828 				break;
1829 			case MTBSS:
1830 				count = -count;
1831 				/* FALLTHROUGH */
1832 			case MTFSS:
1833 				spaceop = SS_SETMARKS;
1834 				break;
1835 			case MTEOD:
1836 				spaceop = SS_EOD;
1837 				count = 0;
1838 				nmarks = 0;
1839 				break;
1840 			default:
1841 				error = EINVAL;
1842 				break;
1843 			}
1844 			if (error)
1845 				break;
1846 
1847 			nmarks = softc->filemarks;
1848 			/*
1849 			 * XXX: Why are we checking again?
1850 			 */
1851 			error = sacheckeod(periph);
1852 			if (error)
1853 				break;
1854 			nmarks -= softc->filemarks;
1855 			error = saspace(periph, count - nmarks, spaceop);
1856 			/*
1857 			 * At this point, clear that we've written the tape
1858 			 * and that we've written any filemarks. We really
1859 			 * don't know what the applications wishes to do next-
1860 			 * the sacheckeod's will make sure we terminated the
1861 			 * tape correctly if we'd been writing, but the next
1862 			 * action the user application takes will set again
1863 			 * whether we need to write filemarks.
1864 			 */
1865 			softc->flags &=
1866 			    ~(SA_FLAG_TAPE_WRITTEN|SA_FLAG_TAPE_FROZEN);
1867 			softc->filemarks = 0;
1868 			break;
1869 		}
1870 		case MTREW:	/* rewind */
1871 			PENDING_MOUNT_CHECK(softc, periph, dev);
1872 			(void) sacheckeod(periph);
1873 			error = sarewind(periph);
1874 			/* see above */
1875 			softc->flags &=
1876 			    ~(SA_FLAG_TAPE_WRITTEN|SA_FLAG_TAPE_FROZEN);
1877 			softc->flags &= ~SA_FLAG_ERR_PENDING;
1878 			softc->filemarks = 0;
1879 			break;
1880 		case MTERASE:	/* erase */
1881 			PENDING_MOUNT_CHECK(softc, periph, dev);
1882 			error = saerase(periph, count);
1883 			softc->flags &=
1884 			    ~(SA_FLAG_TAPE_WRITTEN|SA_FLAG_TAPE_FROZEN);
1885 			softc->flags &= ~SA_FLAG_ERR_PENDING;
1886 			break;
1887 		case MTRETENS:	/* re-tension tape */
1888 			PENDING_MOUNT_CHECK(softc, periph, dev);
1889 			error = saretension(periph);
1890 			softc->flags &=
1891 			    ~(SA_FLAG_TAPE_WRITTEN|SA_FLAG_TAPE_FROZEN);
1892 			softc->flags &= ~SA_FLAG_ERR_PENDING;
1893 			break;
1894 		case MTOFFL:	/* rewind and put the drive offline */
1895 
1896 			PENDING_MOUNT_CHECK(softc, periph, dev);
1897 
1898 			(void) sacheckeod(periph);
1899 			/* see above */
1900 			softc->flags &= ~SA_FLAG_TAPE_WRITTEN;
1901 			softc->filemarks = 0;
1902 
1903 			error = sarewind(periph);
1904 			/* clear the frozen flag anyway */
1905 			softc->flags &= ~SA_FLAG_TAPE_FROZEN;
1906 
1907 			/*
1908 			 * Be sure to allow media removal before ejecting.
1909 			 */
1910 
1911 			saprevent(periph, PR_ALLOW);
1912 			if (error == 0) {
1913 				error = saloadunload(periph, FALSE);
1914 				if (error == 0) {
1915 					softc->flags &= ~SA_FLAG_TAPE_MOUNTED;
1916 				}
1917 			}
1918 			break;
1919 
1920 		case MTLOAD:
1921 			error = saloadunload(periph, TRUE);
1922 			break;
1923 		case MTNOP:	/* no operation, sets status only */
1924 		case MTCACHE:	/* enable controller cache */
1925 		case MTNOCACHE:	/* disable controller cache */
1926 			error = 0;
1927 			break;
1928 
1929 		case MTSETBSIZ:	/* Set block size for device */
1930 
1931 			PENDING_MOUNT_CHECK(softc, periph, dev);
1932 
1933 			if ((softc->sili != 0)
1934 			 && (count != 0)) {
1935 				xpt_print(periph->path, "Can't enter fixed "
1936 				    "block mode with SILI enabled\n");
1937 				error = EINVAL;
1938 				break;
1939 			}
1940 			error = sasetparams(periph, SA_PARAM_BLOCKSIZE, count,
1941 					    0, 0, 0);
1942 			if (error == 0) {
1943 				softc->last_media_blksize =
1944 				    softc->media_blksize;
1945 				softc->media_blksize = count;
1946 				if (count) {
1947 					softc->flags |= SA_FLAG_FIXED;
1948 					if (powerof2(count)) {
1949 						softc->blk_shift =
1950 						    ffs(count) - 1;
1951 						softc->blk_mask = count - 1;
1952 					} else {
1953 						softc->blk_mask = ~0;
1954 						softc->blk_shift = 0;
1955 					}
1956 					/*
1957 					 * Make the user's desire 'persistent'.
1958 					 */
1959 					softc->quirks &= ~SA_QUIRK_VARIABLE;
1960 					softc->quirks |= SA_QUIRK_FIXED;
1961 				} else {
1962 					softc->flags &= ~SA_FLAG_FIXED;
1963 					if (softc->max_blk == 0) {
1964 						softc->max_blk = ~0;
1965 					}
1966 					softc->blk_shift = 0;
1967 					if (softc->blk_gran != 0) {
1968 						softc->blk_mask =
1969 						    softc->blk_gran - 1;
1970 					} else {
1971 						softc->blk_mask = 0;
1972 					}
1973 					/*
1974 					 * Make the user's desire 'persistent'.
1975 					 */
1976 					softc->quirks |= SA_QUIRK_VARIABLE;
1977 					softc->quirks &= ~SA_QUIRK_FIXED;
1978 				}
1979 			}
1980 			break;
1981 		case MTSETDNSTY:	/* Set density for device and mode */
1982 			PENDING_MOUNT_CHECK(softc, periph, dev);
1983 
1984 			if (count > UCHAR_MAX) {
1985 				error = EINVAL;
1986 				break;
1987 			} else {
1988 				error = sasetparams(periph, SA_PARAM_DENSITY,
1989 						    0, count, 0, 0);
1990 			}
1991 			break;
1992 		case MTCOMP:	/* enable compression */
1993 			PENDING_MOUNT_CHECK(softc, periph, dev);
1994 			/*
1995 			 * Some devices don't support compression, and
1996 			 * don't like it if you ask them for the
1997 			 * compression page.
1998 			 */
1999 			if ((softc->quirks & SA_QUIRK_NOCOMP) ||
2000 			    (softc->flags & SA_FLAG_COMP_UNSUPP)) {
2001 				error = ENODEV;
2002 				break;
2003 			}
2004 			error = sasetparams(periph, SA_PARAM_COMPRESSION,
2005 			    0, 0, count, SF_NO_PRINT);
2006 			break;
2007 		default:
2008 			error = EINVAL;
2009 		}
2010 		break;
2011 	}
2012 	case MTIOCIEOT:
2013 	case MTIOCEEOT:
2014 		error = 0;
2015 		break;
2016 	case MTIOCRDSPOS:
2017 		PENDING_MOUNT_CHECK(softc, periph, dev);
2018 		error = sardpos(periph, 0, (u_int32_t *) arg);
2019 		break;
2020 	case MTIOCRDHPOS:
2021 		PENDING_MOUNT_CHECK(softc, periph, dev);
2022 		error = sardpos(periph, 1, (u_int32_t *) arg);
2023 		break;
2024 	case MTIOCSLOCATE:
2025 	case MTIOCHLOCATE: {
2026 		struct mtlocate locate_info;
2027 		int hard;
2028 
2029 		bzero(&locate_info, sizeof(locate_info));
2030 		locate_info.logical_id = *((uint32_t *)arg);
2031 		if (cmd == MTIOCSLOCATE)
2032 			hard = 0;
2033 		else
2034 			hard = 1;
2035 
2036 		PENDING_MOUNT_CHECK(softc, periph, dev);
2037 
2038 		error = sasetpos(periph, hard, &locate_info);
2039 		break;
2040 	}
2041 	case MTIOCEXTLOCATE:
2042 		PENDING_MOUNT_CHECK(softc, periph, dev);
2043 		error = sasetpos(periph, /*hard*/ 0, (struct mtlocate *)arg);
2044 		softc->flags &=
2045 		    ~(SA_FLAG_TAPE_WRITTEN|SA_FLAG_TAPE_FROZEN);
2046 		softc->flags &= ~SA_FLAG_ERR_PENDING;
2047 		softc->filemarks = 0;
2048 		break;
2049 	case MTIOCGETEOTMODEL:
2050 		error = 0;
2051 		if (softc->quirks & SA_QUIRK_1FM)
2052 			mode = 1;
2053 		else
2054 			mode = 2;
2055 		*((u_int32_t *) arg) = mode;
2056 		break;
2057 	case MTIOCSETEOTMODEL:
2058 		error = 0;
2059 		switch (*((u_int32_t *) arg)) {
2060 		case 1:
2061 			softc->quirks &= ~SA_QUIRK_2FM;
2062 			softc->quirks |= SA_QUIRK_1FM;
2063 			break;
2064 		case 2:
2065 			softc->quirks &= ~SA_QUIRK_1FM;
2066 			softc->quirks |= SA_QUIRK_2FM;
2067 			break;
2068 		default:
2069 			error = EINVAL;
2070 			break;
2071 		}
2072 		break;
2073 	case MTIOCRBLIM: {
2074 		struct mtrblim *rblim;
2075 
2076 		rblim = (struct mtrblim *)arg;
2077 
2078 		rblim->granularity = softc->blk_gran;
2079 		rblim->min_block_length = softc->min_blk;
2080 		rblim->max_block_length = softc->max_blk;
2081 		break;
2082 	}
2083 	default:
2084 		error = cam_periph_ioctl(periph, cmd, arg, saerror);
2085 		break;
2086 	}
2087 
2088 	/*
2089 	 * Check to see if we cleared a frozen state
2090 	 */
2091 	if (error == 0 && (softc->flags & SA_FLAG_TAPE_FROZEN)) {
2092 		switch(cmd) {
2093 		case MTIOCRDSPOS:
2094 		case MTIOCRDHPOS:
2095 		case MTIOCSLOCATE:
2096 		case MTIOCHLOCATE:
2097 			/*
2098 			 * XXX KDM look at this.
2099 			 */
2100 			softc->fileno = (daddr_t) -1;
2101 			softc->blkno = (daddr_t) -1;
2102 			softc->rep_blkno = (daddr_t) -1;
2103 			softc->rep_fileno = (daddr_t) -1;
2104 			softc->partition = (daddr_t) -1;
2105 			softc->flags &= ~SA_FLAG_TAPE_FROZEN;
2106 			xpt_print(periph->path,
2107 			    "tape state now unfrozen.\n");
2108 			break;
2109 		default:
2110 			break;
2111 		}
2112 	}
2113 	if (didlockperiph) {
2114 		cam_periph_unhold(periph);
2115 	}
2116 	cam_periph_unlock(periph);
2117 	return (error);
2118 }
2119 
2120 static void
2121 sainit(void)
2122 {
2123 	cam_status status;
2124 
2125 	/*
2126 	 * Install a global async callback.
2127 	 */
2128 	status = xpt_register_async(AC_FOUND_DEVICE, saasync, NULL, NULL);
2129 
2130 	if (status != CAM_REQ_CMP) {
2131 		printf("sa: Failed to attach master async callback "
2132 		       "due to status 0x%x!\n", status);
2133 	}
2134 }
2135 
2136 static void
2137 sadevgonecb(void *arg)
2138 {
2139 	struct cam_periph *periph;
2140 	struct mtx *mtx;
2141 	struct sa_softc *softc;
2142 
2143 	periph = (struct cam_periph *)arg;
2144 	softc = (struct sa_softc *)periph->softc;
2145 
2146 	mtx = cam_periph_mtx(periph);
2147 	mtx_lock(mtx);
2148 
2149 	softc->num_devs_to_destroy--;
2150 	if (softc->num_devs_to_destroy == 0) {
2151 		int i;
2152 
2153 		/*
2154 		 * When we have gotten all of our callbacks, we will get
2155 		 * no more close calls from devfs.  So if we have any
2156 		 * dangling opens, we need to release the reference held
2157 		 * for that particular context.
2158 		 */
2159 		for (i = 0; i < softc->open_count; i++)
2160 			cam_periph_release_locked(periph);
2161 
2162 		softc->open_count = 0;
2163 
2164 		/*
2165 		 * Release the reference held for devfs, all of our
2166 		 * instances are gone now.
2167 		 */
2168 		cam_periph_release_locked(periph);
2169 	}
2170 
2171 	/*
2172 	 * We reference the lock directly here, instead of using
2173 	 * cam_periph_unlock().  The reason is that the final call to
2174 	 * cam_periph_release_locked() above could result in the periph
2175 	 * getting freed.  If that is the case, dereferencing the periph
2176 	 * with a cam_periph_unlock() call would cause a page fault.
2177 	 */
2178 	mtx_unlock(mtx);
2179 }
2180 
2181 static void
2182 saoninvalidate(struct cam_periph *periph)
2183 {
2184 	struct sa_softc *softc;
2185 
2186 	softc = (struct sa_softc *)periph->softc;
2187 
2188 	/*
2189 	 * De-register any async callbacks.
2190 	 */
2191 	xpt_register_async(0, saasync, periph, periph->path);
2192 
2193 	softc->flags |= SA_FLAG_INVALID;
2194 
2195 	/*
2196 	 * Return all queued I/O with ENXIO.
2197 	 * XXX Handle any transactions queued to the card
2198 	 *     with XPT_ABORT_CCB.
2199 	 */
2200 	bioq_flush(&softc->bio_queue, NULL, ENXIO);
2201 	softc->queue_count = 0;
2202 
2203 	/*
2204 	 * Tell devfs that all of our devices have gone away, and ask for a
2205 	 * callback when it has cleaned up its state.
2206 	 */
2207 	destroy_dev_sched_cb(softc->devs.ctl_dev, sadevgonecb, periph);
2208 	destroy_dev_sched_cb(softc->devs.r_dev, sadevgonecb, periph);
2209 	destroy_dev_sched_cb(softc->devs.nr_dev, sadevgonecb, periph);
2210 	destroy_dev_sched_cb(softc->devs.er_dev, sadevgonecb, periph);
2211 }
2212 
2213 static void
2214 sacleanup(struct cam_periph *periph)
2215 {
2216 	struct sa_softc *softc;
2217 
2218 	softc = (struct sa_softc *)periph->softc;
2219 
2220 	cam_periph_unlock(periph);
2221 
2222 	if ((softc->flags & SA_FLAG_SCTX_INIT) != 0
2223 	 && sysctl_ctx_free(&softc->sysctl_ctx) != 0)
2224 		xpt_print(periph->path, "can't remove sysctl context\n");
2225 
2226 	cam_periph_lock(periph);
2227 
2228 	devstat_remove_entry(softc->device_stats);
2229 
2230 	free(softc, M_SCSISA);
2231 }
2232 
2233 static void
2234 saasync(void *callback_arg, u_int32_t code,
2235 	struct cam_path *path, void *arg)
2236 {
2237 	struct cam_periph *periph;
2238 
2239 	periph = (struct cam_periph *)callback_arg;
2240 	switch (code) {
2241 	case AC_FOUND_DEVICE:
2242 	{
2243 		struct ccb_getdev *cgd;
2244 		cam_status status;
2245 
2246 		cgd = (struct ccb_getdev *)arg;
2247 		if (cgd == NULL)
2248 			break;
2249 
2250 		if (cgd->protocol != PROTO_SCSI)
2251 			break;
2252 		if (SID_QUAL(&cgd->inq_data) != SID_QUAL_LU_CONNECTED)
2253 			break;
2254 		if (SID_TYPE(&cgd->inq_data) != T_SEQUENTIAL)
2255 			break;
2256 
2257 		/*
2258 		 * Allocate a peripheral instance for
2259 		 * this device and start the probe
2260 		 * process.
2261 		 */
2262 		status = cam_periph_alloc(saregister, saoninvalidate,
2263 					  sacleanup, sastart,
2264 					  "sa", CAM_PERIPH_BIO, path,
2265 					  saasync, AC_FOUND_DEVICE, cgd);
2266 
2267 		if (status != CAM_REQ_CMP
2268 		 && status != CAM_REQ_INPROG)
2269 			printf("saasync: Unable to probe new device "
2270 				"due to status 0x%x\n", status);
2271 		break;
2272 	}
2273 	default:
2274 		cam_periph_async(periph, code, path, arg);
2275 		break;
2276 	}
2277 }
2278 
2279 static void
2280 sasetupdev(struct sa_softc *softc, struct cdev *dev)
2281 {
2282 
2283 	dev->si_iosize_max = softc->maxio;
2284 	dev->si_flags |= softc->si_flags;
2285 	/*
2286 	 * Keep a count of how many non-alias devices we have created,
2287 	 * so we can make sure we clean them all up on shutdown.  Aliases
2288 	 * are cleaned up when we destroy the device they're an alias for.
2289 	 */
2290 	if ((dev->si_flags & SI_ALIAS) == 0)
2291 		softc->num_devs_to_destroy++;
2292 }
2293 
2294 static void
2295 sasysctlinit(void *context, int pending)
2296 {
2297 	struct cam_periph *periph;
2298 	struct sa_softc *softc;
2299 	char tmpstr[32], tmpstr2[16];
2300 
2301 	periph = (struct cam_periph *)context;
2302 	/*
2303 	 * If the periph is invalid, no need to setup the sysctls.
2304 	 */
2305 	if (periph->flags & CAM_PERIPH_INVALID)
2306 		goto bailout;
2307 
2308 	softc = (struct sa_softc *)periph->softc;
2309 
2310 	snprintf(tmpstr, sizeof(tmpstr), "CAM SA unit %d", periph->unit_number);
2311 	snprintf(tmpstr2, sizeof(tmpstr2), "%u", periph->unit_number);
2312 
2313 	sysctl_ctx_init(&softc->sysctl_ctx);
2314 	softc->flags |= SA_FLAG_SCTX_INIT;
2315 	softc->sysctl_tree = SYSCTL_ADD_NODE_WITH_LABEL(&softc->sysctl_ctx,
2316 	    SYSCTL_STATIC_CHILDREN(_kern_cam_sa), OID_AUTO, tmpstr2,
2317 	    CTLFLAG_RD, 0, tmpstr, "device_index");
2318 	if (softc->sysctl_tree == NULL)
2319 		goto bailout;
2320 
2321 	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
2322 	    OID_AUTO, "allow_io_split", CTLFLAG_RDTUN | CTLFLAG_NOFETCH,
2323 	    &softc->allow_io_split, 0, "Allow Splitting I/O");
2324 	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
2325 	    OID_AUTO, "maxio", CTLFLAG_RD,
2326 	    &softc->maxio, 0, "Maximum I/O size");
2327 	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
2328 	    OID_AUTO, "cpi_maxio", CTLFLAG_RD,
2329 	    &softc->cpi_maxio, 0, "Maximum Controller I/O size");
2330 	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
2331 	    OID_AUTO, "inject_eom", CTLFLAG_RW,
2332 	    &softc->inject_eom, 0, "Queue EOM for the next write/read");
2333 
2334 bailout:
2335 	/*
2336 	 * Release the reference that was held when this task was enqueued.
2337 	 */
2338 	cam_periph_release(periph);
2339 }
2340 
2341 static cam_status
2342 saregister(struct cam_periph *periph, void *arg)
2343 {
2344 	struct sa_softc *softc;
2345 	struct ccb_getdev *cgd;
2346 	struct ccb_pathinq cpi;
2347 	struct make_dev_args args;
2348 	caddr_t match;
2349 	char tmpstr[80];
2350 	int error;
2351 
2352 	cgd = (struct ccb_getdev *)arg;
2353 	if (cgd == NULL) {
2354 		printf("saregister: no getdev CCB, can't register device\n");
2355 		return (CAM_REQ_CMP_ERR);
2356 	}
2357 
2358 	softc = (struct sa_softc *)
2359 	    malloc(sizeof (*softc), M_SCSISA, M_NOWAIT | M_ZERO);
2360 	if (softc == NULL) {
2361 		printf("saregister: Unable to probe new device. "
2362 		       "Unable to allocate softc\n");
2363 		return (CAM_REQ_CMP_ERR);
2364 	}
2365 	softc->scsi_rev = SID_ANSI_REV(&cgd->inq_data);
2366 	softc->state = SA_STATE_NORMAL;
2367 	softc->fileno = (daddr_t) -1;
2368 	softc->blkno = (daddr_t) -1;
2369 	softc->rep_fileno = (daddr_t) -1;
2370 	softc->rep_blkno = (daddr_t) -1;
2371 	softc->partition = (daddr_t) -1;
2372 	softc->bop = -1;
2373 	softc->eop = -1;
2374 	softc->bpew = -1;
2375 
2376 	bioq_init(&softc->bio_queue);
2377 	softc->periph = periph;
2378 	periph->softc = softc;
2379 
2380 	/*
2381 	 * See if this device has any quirks.
2382 	 */
2383 	match = cam_quirkmatch((caddr_t)&cgd->inq_data,
2384 			       (caddr_t)sa_quirk_table,
2385 			       nitems(sa_quirk_table),
2386 			       sizeof(*sa_quirk_table), scsi_inquiry_match);
2387 
2388 	if (match != NULL) {
2389 		softc->quirks = ((struct sa_quirk_entry *)match)->quirks;
2390 		softc->last_media_blksize =
2391 		    ((struct sa_quirk_entry *)match)->prefblk;
2392 	} else
2393 		softc->quirks = SA_QUIRK_NONE;
2394 
2395 	/*
2396 	 * Long format data for READ POSITION was introduced in SSC, which
2397 	 * was after SCSI-2.  (Roughly equivalent to SCSI-3.)  If the drive
2398 	 * reports that it is SCSI-2 or older, it is unlikely to support
2399 	 * long position data, but it might.  Some drives from that era
2400 	 * claim to be SCSI-2, but do support long position information.
2401 	 * So, instead of immediately disabling long position information
2402 	 * for SCSI-2 devices, we'll try one pass through sagetpos(), and
2403 	 * then disable long position information if we get an error.
2404 	 */
2405 	if (cgd->inq_data.version <= SCSI_REV_CCS)
2406 		softc->quirks |= SA_QUIRK_NO_LONG_POS;
2407 
2408 	if (cgd->inq_data.spc3_flags & SPC3_SID_PROTECT) {
2409 		struct ccb_dev_advinfo cdai;
2410 		struct scsi_vpd_extended_inquiry_data ext_inq;
2411 
2412 		bzero(&ext_inq, sizeof(ext_inq));
2413 
2414 		xpt_setup_ccb(&cdai.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
2415 
2416 		cdai.ccb_h.func_code = XPT_DEV_ADVINFO;
2417 		cdai.flags = CDAI_FLAG_NONE;
2418 		cdai.buftype = CDAI_TYPE_EXT_INQ;
2419 		cdai.bufsiz = sizeof(ext_inq);
2420 		cdai.buf = (uint8_t *)&ext_inq;
2421 		xpt_action((union ccb *)&cdai);
2422 
2423 		if ((cdai.ccb_h.status & CAM_DEV_QFRZN) != 0)
2424 			cam_release_devq(cdai.ccb_h.path, 0, 0, 0, FALSE);
2425 		if ((cdai.ccb_h.status == CAM_REQ_CMP)
2426 		 && (ext_inq.flags1 & SVPD_EID_SA_SPT_LBP))
2427 			softc->flags |= SA_FLAG_PROTECT_SUPP;
2428 	}
2429 
2430 	xpt_path_inq(&cpi, periph->path);
2431 
2432 	/*
2433 	 * The SA driver supports a blocksize, but we don't know the
2434 	 * blocksize until we media is inserted.  So, set a flag to
2435 	 * indicate that the blocksize is unavailable right now.
2436 	 */
2437 	cam_periph_unlock(periph);
2438 	softc->device_stats = devstat_new_entry("sa", periph->unit_number, 0,
2439 	    DEVSTAT_BS_UNAVAILABLE, SID_TYPE(&cgd->inq_data) |
2440 	    XPORT_DEVSTAT_TYPE(cpi.transport), DEVSTAT_PRIORITY_TAPE);
2441 
2442 	/*
2443 	 * Load the default value that is either compiled in, or loaded
2444 	 * in the global kern.cam.sa.allow_io_split tunable.
2445 	 */
2446 	softc->allow_io_split = sa_allow_io_split;
2447 
2448 	/*
2449 	 * Load a per-instance tunable, if it exists.  NOTE that this
2450 	 * tunable WILL GO AWAY in FreeBSD 11.0.
2451 	 */
2452 	snprintf(tmpstr, sizeof(tmpstr), "kern.cam.sa.%u.allow_io_split",
2453 		 periph->unit_number);
2454 	TUNABLE_INT_FETCH(tmpstr, &softc->allow_io_split);
2455 
2456 	/*
2457 	 * If maxio isn't set, we fall back to DFLTPHYS.  Otherwise we take
2458 	 * the smaller of cpi.maxio or MAXPHYS.
2459 	 */
2460 	if (cpi.maxio == 0)
2461 		softc->maxio = DFLTPHYS;
2462 	else if (cpi.maxio > MAXPHYS)
2463 		softc->maxio = MAXPHYS;
2464 	else
2465 		softc->maxio = cpi.maxio;
2466 
2467 	/*
2468 	 * Record the controller's maximum I/O size so we can report it to
2469 	 * the user later.
2470 	 */
2471 	softc->cpi_maxio = cpi.maxio;
2472 
2473 	/*
2474 	 * By default we tell physio that we do not want our I/O split.
2475 	 * The user needs to have a 1:1 mapping between the size of his
2476 	 * write to a tape character device and the size of the write
2477 	 * that actually goes down to the drive.
2478 	 */
2479 	if (softc->allow_io_split == 0)
2480 		softc->si_flags = SI_NOSPLIT;
2481 	else
2482 		softc->si_flags = 0;
2483 
2484 	TASK_INIT(&softc->sysctl_task, 0, sasysctlinit, periph);
2485 
2486 	/*
2487 	 * If the SIM supports unmapped I/O, let physio know that we can
2488 	 * handle unmapped buffers.
2489 	 */
2490 	if (cpi.hba_misc & PIM_UNMAPPED)
2491 		softc->si_flags |= SI_UNMAPPED;
2492 
2493 	/*
2494 	 * Acquire a reference to the periph before we create the devfs
2495 	 * instances for it.  We'll release this reference once the devfs
2496 	 * instances have been freed.
2497 	 */
2498 	if (cam_periph_acquire(periph) != 0) {
2499 		xpt_print(periph->path, "%s: lost periph during "
2500 			  "registration!\n", __func__);
2501 		cam_periph_lock(periph);
2502 		return (CAM_REQ_CMP_ERR);
2503 	}
2504 
2505 	make_dev_args_init(&args);
2506 	args.mda_devsw = &sa_cdevsw;
2507 	args.mda_si_drv1 = softc->periph;
2508 	args.mda_uid = UID_ROOT;
2509 	args.mda_gid = GID_OPERATOR;
2510 	args.mda_mode = 0660;
2511 
2512 	args.mda_unit = SAMINOR(SA_CTLDEV, SA_ATYPE_R);
2513 	error = make_dev_s(&args, &softc->devs.ctl_dev, "%s%d.ctl",
2514 	    periph->periph_name, periph->unit_number);
2515 	if (error != 0) {
2516 		cam_periph_lock(periph);
2517 		return (CAM_REQ_CMP_ERR);
2518 	}
2519 	sasetupdev(softc, softc->devs.ctl_dev);
2520 
2521 	args.mda_unit = SAMINOR(SA_NOT_CTLDEV, SA_ATYPE_R);
2522 	error = make_dev_s(&args, &softc->devs.r_dev, "%s%d",
2523 	    periph->periph_name, periph->unit_number);
2524 	if (error != 0) {
2525 		cam_periph_lock(periph);
2526 		return (CAM_REQ_CMP_ERR);
2527 	}
2528 	sasetupdev(softc, softc->devs.r_dev);
2529 
2530 	args.mda_unit = SAMINOR(SA_NOT_CTLDEV, SA_ATYPE_NR);
2531 	error = make_dev_s(&args, &softc->devs.nr_dev, "n%s%d",
2532 	    periph->periph_name, periph->unit_number);
2533 	if (error != 0) {
2534 		cam_periph_lock(periph);
2535 		return (CAM_REQ_CMP_ERR);
2536 	}
2537 	sasetupdev(softc, softc->devs.nr_dev);
2538 
2539 	args.mda_unit = SAMINOR(SA_NOT_CTLDEV, SA_ATYPE_ER);
2540 	error = make_dev_s(&args, &softc->devs.er_dev, "e%s%d",
2541 	    periph->periph_name, periph->unit_number);
2542 	if (error != 0) {
2543 		cam_periph_lock(periph);
2544 		return (CAM_REQ_CMP_ERR);
2545 	}
2546 	sasetupdev(softc, softc->devs.er_dev);
2547 
2548 	cam_periph_lock(periph);
2549 
2550 	softc->density_type_bits[0] = 0;
2551 	softc->density_type_bits[1] = SRDS_MEDIA;
2552 	softc->density_type_bits[2] = SRDS_MEDIUM_TYPE;
2553 	softc->density_type_bits[3] = SRDS_MEDIUM_TYPE | SRDS_MEDIA;
2554 	/*
2555 	 * Bump the peripheral refcount for the sysctl thread, in case we
2556 	 * get invalidated before the thread has a chance to run.
2557 	 */
2558 	cam_periph_acquire(periph);
2559 	taskqueue_enqueue(taskqueue_thread, &softc->sysctl_task);
2560 
2561 	/*
2562 	 * Add an async callback so that we get
2563 	 * notified if this device goes away.
2564 	 */
2565 	xpt_register_async(AC_LOST_DEVICE, saasync, periph, periph->path);
2566 
2567 	xpt_announce_periph(periph, NULL);
2568 	xpt_announce_quirks(periph, softc->quirks, SA_QUIRK_BIT_STRING);
2569 
2570 	return (CAM_REQ_CMP);
2571 }
2572 
2573 static void
2574 sastart(struct cam_periph *periph, union ccb *start_ccb)
2575 {
2576 	struct sa_softc *softc;
2577 
2578 	softc = (struct sa_softc *)periph->softc;
2579 
2580 	CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("sastart\n"));
2581 
2582 
2583 	switch (softc->state) {
2584 	case SA_STATE_NORMAL:
2585 	{
2586 		/* Pull a buffer from the queue and get going on it */
2587 		struct bio *bp;
2588 
2589 		/*
2590 		 * See if there is a buf with work for us to do..
2591 		 */
2592 		bp = bioq_first(&softc->bio_queue);
2593 		if (bp == NULL) {
2594 			xpt_release_ccb(start_ccb);
2595 		} else if (((softc->flags & SA_FLAG_ERR_PENDING) != 0)
2596 			|| (softc->inject_eom != 0)) {
2597 			struct bio *done_bp;
2598 
2599 			if (softc->inject_eom != 0) {
2600 				softc->flags |= SA_FLAG_EOM_PENDING;
2601 				softc->inject_eom = 0;
2602 				/*
2603 				 * If we're injecting EOM for writes, we
2604 				 * need to keep PEWS set for 3 queries
2605 				 * to cover 2 position requests from the
2606 				 * kernel via sagetpos(), and then allow
2607 				 * for one for the user to see the BPEW
2608 				 * flag (e.g. via mt status).  After that,
2609 				 * it will be cleared.
2610 				 */
2611 				if (bp->bio_cmd == BIO_WRITE)
2612 					softc->set_pews_status = 3;
2613 				else
2614 					softc->set_pews_status = 1;
2615 			}
2616 again:
2617 			softc->queue_count--;
2618 			bioq_remove(&softc->bio_queue, bp);
2619 			bp->bio_resid = bp->bio_bcount;
2620 			done_bp = bp;
2621 			if ((softc->flags & SA_FLAG_EOM_PENDING) != 0) {
2622 				/*
2623 				 * We have two different behaviors for
2624 				 * writes when we hit either Early Warning
2625 				 * or the PEWZ (Programmable Early Warning
2626 				 * Zone).  The default behavior is that
2627 				 * for all writes that are currently
2628 				 * queued after the write where we saw the
2629 				 * early warning, we will return the write
2630 				 * with the residual equal to the count.
2631 				 * i.e. tell the application that 0 bytes
2632 				 * were written.
2633 				 *
2634 				 * The alternate behavior, which is enabled
2635 				 * when eot_warn is set, is that in
2636 				 * addition to setting the residual equal
2637 				 * to the count, we will set the error
2638 				 * to ENOSPC.
2639 				 *
2640 				 * In either case, once queued writes are
2641 				 * cleared out, we clear the error flag
2642 				 * (see below) and the application is free to
2643 				 * attempt to write more.
2644 				 */
2645 				if (softc->eot_warn != 0) {
2646 					bp->bio_flags |= BIO_ERROR;
2647 					bp->bio_error = ENOSPC;
2648 				} else
2649 					bp->bio_error = 0;
2650 			} else if ((softc->flags & SA_FLAG_EOF_PENDING) != 0) {
2651 				/*
2652 				 * This can only happen if we're reading
2653 				 * in fixed length mode. In this case,
2654 				 * we dump the rest of the list the
2655 				 * same way.
2656 				 */
2657 				bp->bio_error = 0;
2658 				if (bioq_first(&softc->bio_queue) != NULL) {
2659 					biodone(done_bp);
2660 					goto again;
2661 				}
2662 			} else if ((softc->flags & SA_FLAG_EIO_PENDING) != 0) {
2663 				bp->bio_error = EIO;
2664 				bp->bio_flags |= BIO_ERROR;
2665 			}
2666 			bp = bioq_first(&softc->bio_queue);
2667 			/*
2668 			 * Only if we have no other buffers queued up
2669 			 * do we clear the pending error flag.
2670 			 */
2671 			if (bp == NULL)
2672 				softc->flags &= ~SA_FLAG_ERR_PENDING;
2673 			CAM_DEBUG(periph->path, CAM_DEBUG_INFO,
2674 			    ("sastart- ERR_PENDING now 0x%x, bp is %sNULL, "
2675 			    "%d more buffers queued up\n",
2676 			    (softc->flags & SA_FLAG_ERR_PENDING),
2677 			    (bp != NULL)? "not " : " ", softc->queue_count));
2678 			xpt_release_ccb(start_ccb);
2679 			biodone(done_bp);
2680 		} else {
2681 			u_int32_t length;
2682 
2683 			bioq_remove(&softc->bio_queue, bp);
2684 			softc->queue_count--;
2685 
2686 			length = bp->bio_bcount;
2687 
2688 			if ((softc->flags & SA_FLAG_FIXED) != 0) {
2689 				if (softc->blk_shift != 0) {
2690 					length = length >> softc->blk_shift;
2691 				} else if (softc->media_blksize != 0) {
2692 					length = length / softc->media_blksize;
2693 				} else {
2694 					bp->bio_error = EIO;
2695 					xpt_print(periph->path, "zero blocksize"
2696 					    " for FIXED length writes?\n");
2697 					biodone(bp);
2698 					break;
2699 				}
2700 #if	0
2701 				CAM_DEBUG(start_ccb->ccb_h.path, CAM_DEBUG_INFO,
2702 				    ("issuing a %d fixed record %s\n",
2703 				    length,  (bp->bio_cmd == BIO_READ)? "read" :
2704 				    "write"));
2705 #endif
2706 			} else {
2707 #if	0
2708 				CAM_DEBUG(start_ccb->ccb_h.path, CAM_DEBUG_INFO,
2709 				    ("issuing a %d variable byte %s\n",
2710 				    length,  (bp->bio_cmd == BIO_READ)? "read" :
2711 				    "write"));
2712 #endif
2713 			}
2714 			devstat_start_transaction_bio(softc->device_stats, bp);
2715 			/*
2716 			 * Some people have theorized that we should
2717 			 * suppress illegal length indication if we are
2718 			 * running in variable block mode so that we don't
2719 			 * have to request sense every time our requested
2720 			 * block size is larger than the written block.
2721 			 * The residual information from the ccb allows
2722 			 * us to identify this situation anyway.  The only
2723 			 * problem with this is that we will not get
2724 			 * information about blocks that are larger than
2725 			 * our read buffer unless we set the block size
2726 			 * in the mode page to something other than 0.
2727 			 *
2728 			 * I believe that this is a non-issue. If user apps
2729 			 * don't adjust their read size to match our record
2730 			 * size, that's just life. Anyway, the typical usage
2731 			 * would be to issue, e.g., 64KB reads and occasionally
2732 			 * have to do deal with 512 byte or 1KB intermediate
2733 			 * records.
2734 			 *
2735 			 * That said, though, we now support setting the
2736 			 * SILI bit on reads, and we set the blocksize to 4
2737 			 * bytes when we do that.  This gives us
2738 			 * compatibility with software that wants this,
2739 			 * although the only real difference between that
2740 			 * and not setting the SILI bit on reads is that we
2741 			 * won't get a check condition on reads where our
2742 			 * request size is larger than the block on tape.
2743 			 * That probably only makes a real difference in
2744 			 * non-packetized SCSI, where you have to go back
2745 			 * to the drive to request sense and thus incur
2746 			 * more latency.
2747 			 */
2748 			softc->dsreg = (bp->bio_cmd == BIO_READ)?
2749 			    MTIO_DSREG_RD : MTIO_DSREG_WR;
2750 			scsi_sa_read_write(&start_ccb->csio, 0, sadone,
2751 			    MSG_SIMPLE_Q_TAG, (bp->bio_cmd == BIO_READ ?
2752 			    SCSI_RW_READ : SCSI_RW_WRITE) |
2753 			    ((bp->bio_flags & BIO_UNMAPPED) != 0 ?
2754 			    SCSI_RW_BIO : 0), softc->sili,
2755 			    (softc->flags & SA_FLAG_FIXED) != 0, length,
2756 			    (bp->bio_flags & BIO_UNMAPPED) != 0 ? (void *)bp :
2757 			    bp->bio_data, bp->bio_bcount, SSD_FULL_SIZE,
2758 			    IO_TIMEOUT);
2759 			start_ccb->ccb_h.ccb_pflags &= ~SA_POSITION_UPDATED;
2760 			start_ccb->ccb_h.ccb_bp = bp;
2761 			bp = bioq_first(&softc->bio_queue);
2762 			xpt_action(start_ccb);
2763 		}
2764 
2765 		if (bp != NULL) {
2766 			/* Have more work to do, so ensure we stay scheduled */
2767 			xpt_schedule(periph, CAM_PRIORITY_NORMAL);
2768 		}
2769 		break;
2770 	}
2771 	case SA_STATE_ABNORMAL:
2772 	default:
2773 		panic("state 0x%x in sastart", softc->state);
2774 		break;
2775 	}
2776 }
2777 
2778 
2779 static void
2780 sadone(struct cam_periph *periph, union ccb *done_ccb)
2781 {
2782 	struct sa_softc *softc;
2783 	struct ccb_scsiio *csio;
2784 	struct bio *bp;
2785 	int error;
2786 
2787 	softc = (struct sa_softc *)periph->softc;
2788 	csio = &done_ccb->csio;
2789 
2790 	softc->dsreg = MTIO_DSREG_REST;
2791 	bp = (struct bio *)done_ccb->ccb_h.ccb_bp;
2792 	error = 0;
2793 	if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
2794 		if ((error = saerror(done_ccb, 0, 0)) == ERESTART) {
2795 			/*
2796 			 * A retry was scheduled, so just return.
2797 			 */
2798 			return;
2799 		}
2800 	}
2801 
2802 	if (error == EIO) {
2803 
2804 		/*
2805 		 * Catastrophic error. Mark the tape as frozen
2806 		 * (we no longer know tape position).
2807 		 *
2808 		 * Return all queued I/O with EIO, and unfreeze
2809 		 * our queue so that future transactions that
2810 		 * attempt to fix this problem can get to the
2811 		 * device.
2812 		 *
2813 		 */
2814 
2815 		softc->flags |= SA_FLAG_TAPE_FROZEN;
2816 		bioq_flush(&softc->bio_queue, NULL, EIO);
2817 	}
2818 	if (error != 0) {
2819 		bp->bio_resid = bp->bio_bcount;
2820 		bp->bio_error = error;
2821 		bp->bio_flags |= BIO_ERROR;
2822 		/*
2823 		 * In the error case, position is updated in saerror.
2824 		 */
2825 	} else {
2826 		bp->bio_resid = csio->resid;
2827 		bp->bio_error = 0;
2828 		if (csio->resid != 0) {
2829 			bp->bio_flags |= BIO_ERROR;
2830 		}
2831 		if (bp->bio_cmd == BIO_WRITE) {
2832 			softc->flags |= SA_FLAG_TAPE_WRITTEN;
2833 			softc->filemarks = 0;
2834 		}
2835 		if (!(csio->ccb_h.ccb_pflags & SA_POSITION_UPDATED) &&
2836 		    (softc->blkno != (daddr_t) -1)) {
2837 			if ((softc->flags & SA_FLAG_FIXED) != 0) {
2838 				u_int32_t l;
2839 				if (softc->blk_shift != 0) {
2840 					l = bp->bio_bcount >>
2841 						softc->blk_shift;
2842 				} else {
2843 					l = bp->bio_bcount /
2844 						softc->media_blksize;
2845 				}
2846 				softc->blkno += (daddr_t) l;
2847 			} else {
2848 				softc->blkno++;
2849 			}
2850 		}
2851 	}
2852 	/*
2853 	 * If we had an error (immediate or pending),
2854 	 * release the device queue now.
2855 	 */
2856 	if (error || (softc->flags & SA_FLAG_ERR_PENDING))
2857 		cam_release_devq(done_ccb->ccb_h.path, 0, 0, 0, 0);
2858 	if (error || bp->bio_resid) {
2859 		CAM_DEBUG(periph->path, CAM_DEBUG_INFO,
2860 		    	  ("error %d resid %ld count %ld\n", error,
2861 			  bp->bio_resid, bp->bio_bcount));
2862 	}
2863 	biofinish(bp, softc->device_stats, 0);
2864 	xpt_release_ccb(done_ccb);
2865 }
2866 
2867 /*
2868  * Mount the tape (make sure it's ready for I/O).
2869  */
2870 static int
2871 samount(struct cam_periph *periph, int oflags, struct cdev *dev)
2872 {
2873 	struct	sa_softc *softc;
2874 	union	ccb *ccb;
2875 	int	error;
2876 
2877 	/*
2878 	 * oflags can be checked for 'kind' of open (read-only check) - later
2879 	 * dev can be checked for a control-mode or compression open - later
2880 	 */
2881 	UNUSED_PARAMETER(oflags);
2882 	UNUSED_PARAMETER(dev);
2883 
2884 
2885 	softc = (struct sa_softc *)periph->softc;
2886 
2887 	/*
2888 	 * This should determine if something has happened since the last
2889 	 * open/mount that would invalidate the mount. We do *not* want
2890 	 * to retry this command- we just want the status. But we only
2891 	 * do this if we're mounted already- if we're not mounted,
2892 	 * we don't care about the unit read state and can instead use
2893 	 * this opportunity to attempt to reserve the tape unit.
2894 	 */
2895 
2896 	if (softc->flags & SA_FLAG_TAPE_MOUNTED) {
2897 		ccb = cam_periph_getccb(periph, 1);
2898 		scsi_test_unit_ready(&ccb->csio, 0, NULL,
2899 		    MSG_SIMPLE_Q_TAG, SSD_FULL_SIZE, IO_TIMEOUT);
2900 		error = cam_periph_runccb(ccb, saerror, 0, SF_NO_PRINT,
2901 		    softc->device_stats);
2902 		if (error == ENXIO) {
2903 			softc->flags &= ~SA_FLAG_TAPE_MOUNTED;
2904 			scsi_test_unit_ready(&ccb->csio, 0, NULL,
2905 			    MSG_SIMPLE_Q_TAG, SSD_FULL_SIZE, IO_TIMEOUT);
2906 			error = cam_periph_runccb(ccb, saerror, 0, SF_NO_PRINT,
2907 			    softc->device_stats);
2908 		} else if (error) {
2909 			/*
2910 			 * We don't need to freeze the tape because we
2911 			 * will now attempt to rewind/load it.
2912 			 */
2913 			softc->flags &= ~SA_FLAG_TAPE_MOUNTED;
2914 			if (CAM_DEBUGGED(periph->path, CAM_DEBUG_INFO)) {
2915 				xpt_print(periph->path,
2916 				    "error %d on TUR in samount\n", error);
2917 			}
2918 		}
2919 	} else {
2920 		error = sareservereleaseunit(periph, TRUE);
2921 		if (error) {
2922 			return (error);
2923 		}
2924 		ccb = cam_periph_getccb(periph, 1);
2925 		scsi_test_unit_ready(&ccb->csio, 0, NULL,
2926 		    MSG_SIMPLE_Q_TAG, SSD_FULL_SIZE, IO_TIMEOUT);
2927 		error = cam_periph_runccb(ccb, saerror, 0, SF_NO_PRINT,
2928 		    softc->device_stats);
2929 	}
2930 
2931 	if ((softc->flags & SA_FLAG_TAPE_MOUNTED) == 0) {
2932 		struct scsi_read_block_limits_data *rblim = NULL;
2933 		int comp_enabled, comp_supported;
2934 		u_int8_t write_protect, guessing = 0;
2935 
2936 		/*
2937 		 * Clear out old state.
2938 		 */
2939 		softc->flags &= ~(SA_FLAG_TAPE_WP|SA_FLAG_TAPE_WRITTEN|
2940 				  SA_FLAG_ERR_PENDING|SA_FLAG_COMPRESSION);
2941 		softc->filemarks = 0;
2942 
2943 		/*
2944 		 * *Very* first off, make sure we're loaded to BOT.
2945 		 */
2946 		scsi_load_unload(&ccb->csio, 2, NULL, MSG_SIMPLE_Q_TAG, FALSE,
2947 		    FALSE, FALSE, 1, SSD_FULL_SIZE, REWIND_TIMEOUT);
2948 		error = cam_periph_runccb(ccb, saerror, 0, SF_NO_PRINT,
2949 		    softc->device_stats);
2950 
2951 		/*
2952 		 * In case this doesn't work, do a REWIND instead
2953 		 */
2954 		if (error) {
2955 			scsi_rewind(&ccb->csio, 2, NULL, MSG_SIMPLE_Q_TAG,
2956 			    FALSE, SSD_FULL_SIZE, REWIND_TIMEOUT);
2957 			error = cam_periph_runccb(ccb, saerror, 0, SF_NO_PRINT,
2958 				softc->device_stats);
2959 		}
2960 		if (error) {
2961 			xpt_release_ccb(ccb);
2962 			goto exit;
2963 		}
2964 
2965 		/*
2966 		 * Do a dummy test read to force access to the
2967 		 * media so that the drive will really know what's
2968 		 * there. We actually don't really care what the
2969 		 * blocksize on tape is and don't expect to really
2970 		 * read a full record.
2971 		 */
2972 		rblim = (struct  scsi_read_block_limits_data *)
2973 		    malloc(8192, M_SCSISA, M_NOWAIT);
2974 		if (rblim == NULL) {
2975 			xpt_print(periph->path, "no memory for test read\n");
2976 			xpt_release_ccb(ccb);
2977 			error = ENOMEM;
2978 			goto exit;
2979 		}
2980 
2981 		if ((softc->quirks & SA_QUIRK_NODREAD) == 0) {
2982 			scsi_sa_read_write(&ccb->csio, 0, NULL,
2983 			    MSG_SIMPLE_Q_TAG, 1, FALSE, 0, 8192,
2984 			    (void *) rblim, 8192, SSD_FULL_SIZE,
2985 			    IO_TIMEOUT);
2986 			(void) cam_periph_runccb(ccb, saerror, 0, SF_NO_PRINT,
2987 			    softc->device_stats);
2988 			scsi_rewind(&ccb->csio, 1, NULL, MSG_SIMPLE_Q_TAG,
2989 			    FALSE, SSD_FULL_SIZE, REWIND_TIMEOUT);
2990 			error = cam_periph_runccb(ccb, saerror, CAM_RETRY_SELTO,
2991 			    SF_NO_PRINT | SF_RETRY_UA,
2992 			    softc->device_stats);
2993 			if (error) {
2994 				xpt_print(periph->path,
2995 				    "unable to rewind after test read\n");
2996 				xpt_release_ccb(ccb);
2997 				goto exit;
2998 			}
2999 		}
3000 
3001 		/*
3002 		 * Next off, determine block limits.
3003 		 */
3004 		scsi_read_block_limits(&ccb->csio, 5, NULL, MSG_SIMPLE_Q_TAG,
3005 		    rblim, SSD_FULL_SIZE, SCSIOP_TIMEOUT);
3006 
3007 		error = cam_periph_runccb(ccb, saerror, CAM_RETRY_SELTO,
3008 		    SF_NO_PRINT | SF_RETRY_UA, softc->device_stats);
3009 
3010 		xpt_release_ccb(ccb);
3011 
3012 		if (error != 0) {
3013 			/*
3014 			 * If it's less than SCSI-2, READ BLOCK LIMITS is not
3015 			 * a MANDATORY command. Anyway- it doesn't matter-
3016 			 * we can proceed anyway.
3017 			 */
3018 			softc->blk_gran = 0;
3019 			softc->max_blk = ~0;
3020 			softc->min_blk = 0;
3021 		} else {
3022 			if (softc->scsi_rev >= SCSI_REV_SPC) {
3023 				softc->blk_gran = RBL_GRAN(rblim);
3024 			} else {
3025 				softc->blk_gran = 0;
3026 			}
3027 			/*
3028 			 * We take max_blk == min_blk to mean a default to
3029 			 * fixed mode- but note that whatever we get out of
3030 			 * sagetparams below will actually determine whether
3031 			 * we are actually *in* fixed mode.
3032 			 */
3033 			softc->max_blk = scsi_3btoul(rblim->maximum);
3034 			softc->min_blk = scsi_2btoul(rblim->minimum);
3035 
3036 
3037 		}
3038 		/*
3039 		 * Next, perform a mode sense to determine
3040 		 * current density, blocksize, compression etc.
3041 		 */
3042 		error = sagetparams(periph, SA_PARAM_ALL,
3043 				    &softc->media_blksize,
3044 				    &softc->media_density,
3045 				    &softc->media_numblks,
3046 				    &softc->buffer_mode, &write_protect,
3047 				    &softc->speed, &comp_supported,
3048 				    &comp_enabled, &softc->comp_algorithm,
3049 				    NULL, NULL, 0, 0);
3050 
3051 		if (error != 0) {
3052 			/*
3053 			 * We could work a little harder here. We could
3054 			 * adjust our attempts to get information. It
3055 			 * might be an ancient tape drive. If someone
3056 			 * nudges us, we'll do that.
3057 			 */
3058 			goto exit;
3059 		}
3060 
3061 		/*
3062 		 * If no quirk has determined that this is a device that is
3063 		 * preferred to be in fixed or variable mode, now is the time
3064 		 * to find out.
3065 	 	 */
3066 		if ((softc->quirks & (SA_QUIRK_FIXED|SA_QUIRK_VARIABLE)) == 0) {
3067 			guessing = 1;
3068 			/*
3069 			 * This could be expensive to find out. Luckily we
3070 			 * only need to do this once. If we start out in
3071 			 * 'default' mode, try and set ourselves to one
3072 			 * of the densities that would determine a wad
3073 			 * of other stuff. Go from highest to lowest.
3074 			 */
3075 			if (softc->media_density == SCSI_DEFAULT_DENSITY) {
3076 				int i;
3077 				static u_int8_t ctry[] = {
3078 					SCSI_DENSITY_HALFINCH_PE,
3079 					SCSI_DENSITY_HALFINCH_6250C,
3080 					SCSI_DENSITY_HALFINCH_6250,
3081 					SCSI_DENSITY_HALFINCH_1600,
3082 					SCSI_DENSITY_HALFINCH_800,
3083 					SCSI_DENSITY_QIC_4GB,
3084 					SCSI_DENSITY_QIC_2GB,
3085 					SCSI_DENSITY_QIC_525_320,
3086 					SCSI_DENSITY_QIC_150,
3087 					SCSI_DENSITY_QIC_120,
3088 					SCSI_DENSITY_QIC_24,
3089 					SCSI_DENSITY_QIC_11_9TRK,
3090 					SCSI_DENSITY_QIC_11_4TRK,
3091 					SCSI_DENSITY_QIC_1320,
3092 					SCSI_DENSITY_QIC_3080,
3093 					0
3094 				};
3095 				for (i = 0; ctry[i]; i++) {
3096 					error = sasetparams(periph,
3097 					    SA_PARAM_DENSITY, 0, ctry[i],
3098 					    0, SF_NO_PRINT);
3099 					if (error == 0) {
3100 						softc->media_density = ctry[i];
3101 						break;
3102 					}
3103 				}
3104 			}
3105 			switch (softc->media_density) {
3106 			case SCSI_DENSITY_QIC_11_4TRK:
3107 			case SCSI_DENSITY_QIC_11_9TRK:
3108 			case SCSI_DENSITY_QIC_24:
3109 			case SCSI_DENSITY_QIC_120:
3110 			case SCSI_DENSITY_QIC_150:
3111 			case SCSI_DENSITY_QIC_525_320:
3112 			case SCSI_DENSITY_QIC_1320:
3113 			case SCSI_DENSITY_QIC_3080:
3114 				softc->quirks &= ~SA_QUIRK_2FM;
3115 				softc->quirks |= SA_QUIRK_FIXED|SA_QUIRK_1FM;
3116 				softc->last_media_blksize = 512;
3117 				break;
3118 			case SCSI_DENSITY_QIC_4GB:
3119 			case SCSI_DENSITY_QIC_2GB:
3120 				softc->quirks &= ~SA_QUIRK_2FM;
3121 				softc->quirks |= SA_QUIRK_FIXED|SA_QUIRK_1FM;
3122 				softc->last_media_blksize = 1024;
3123 				break;
3124 			default:
3125 				softc->last_media_blksize =
3126 				    softc->media_blksize;
3127 				softc->quirks |= SA_QUIRK_VARIABLE;
3128 				break;
3129 			}
3130 		}
3131 
3132 		/*
3133 		 * If no quirk has determined that this is a device that needs
3134 		 * to have 2 Filemarks at EOD, now is the time to find out.
3135 		 */
3136 
3137 		if ((softc->quirks & SA_QUIRK_2FM) == 0) {
3138 			switch (softc->media_density) {
3139 			case SCSI_DENSITY_HALFINCH_800:
3140 			case SCSI_DENSITY_HALFINCH_1600:
3141 			case SCSI_DENSITY_HALFINCH_6250:
3142 			case SCSI_DENSITY_HALFINCH_6250C:
3143 			case SCSI_DENSITY_HALFINCH_PE:
3144 				softc->quirks &= ~SA_QUIRK_1FM;
3145 				softc->quirks |= SA_QUIRK_2FM;
3146 				break;
3147 			default:
3148 				break;
3149 			}
3150 		}
3151 
3152 		/*
3153 		 * Now validate that some info we got makes sense.
3154 		 */
3155 		if ((softc->max_blk < softc->media_blksize) ||
3156 		    (softc->min_blk > softc->media_blksize &&
3157 		    softc->media_blksize)) {
3158 			xpt_print(periph->path,
3159 			    "BLOCK LIMITS (%d..%d) could not match current "
3160 			    "block settings (%d)- adjusting\n", softc->min_blk,
3161 			    softc->max_blk, softc->media_blksize);
3162 			softc->max_blk = softc->min_blk =
3163 			    softc->media_blksize;
3164 		}
3165 
3166 		/*
3167 		 * Now put ourselves into the right frame of mind based
3168 		 * upon quirks...
3169 		 */
3170 tryagain:
3171 		/*
3172 		 * If we want to be in FIXED mode and our current blocksize
3173 		 * is not equal to our last blocksize (if nonzero), try and
3174 		 * set ourselves to this last blocksize (as the 'preferred'
3175 		 * block size).  The initial quirkmatch at registry sets the
3176 		 * initial 'last' blocksize. If, for whatever reason, this
3177 		 * 'last' blocksize is zero, set the blocksize to 512,
3178 		 * or min_blk if that's larger.
3179 		 */
3180 		if ((softc->quirks & SA_QUIRK_FIXED) &&
3181 		    (softc->quirks & SA_QUIRK_NO_MODESEL) == 0 &&
3182 		    (softc->media_blksize != softc->last_media_blksize)) {
3183 			softc->media_blksize = softc->last_media_blksize;
3184 			if (softc->media_blksize == 0) {
3185 				softc->media_blksize = 512;
3186 				if (softc->media_blksize < softc->min_blk) {
3187 					softc->media_blksize = softc->min_blk;
3188 				}
3189 			}
3190 			error = sasetparams(periph, SA_PARAM_BLOCKSIZE,
3191 			    softc->media_blksize, 0, 0, SF_NO_PRINT);
3192 			if (error) {
3193 				xpt_print(periph->path,
3194 				    "unable to set fixed blocksize to %d\n",
3195 				    softc->media_blksize);
3196 				goto exit;
3197 			}
3198 		}
3199 
3200 		if ((softc->quirks & SA_QUIRK_VARIABLE) &&
3201 		    (softc->media_blksize != 0)) {
3202 			softc->last_media_blksize = softc->media_blksize;
3203 			softc->media_blksize = 0;
3204 			error = sasetparams(periph, SA_PARAM_BLOCKSIZE,
3205 			    0, 0, 0, SF_NO_PRINT);
3206 			if (error) {
3207 				/*
3208 				 * If this fails and we were guessing, just
3209 				 * assume that we got it wrong and go try
3210 				 * fixed block mode. Don't even check against
3211 				 * density code at this point.
3212 				 */
3213 				if (guessing) {
3214 					softc->quirks &= ~SA_QUIRK_VARIABLE;
3215 					softc->quirks |= SA_QUIRK_FIXED;
3216 					if (softc->last_media_blksize == 0)
3217 						softc->last_media_blksize = 512;
3218 					goto tryagain;
3219 				}
3220 				xpt_print(periph->path,
3221 				    "unable to set variable blocksize\n");
3222 				goto exit;
3223 			}
3224 		}
3225 
3226 		/*
3227 		 * Now that we have the current block size,
3228 		 * set up some parameters for sastart's usage.
3229 		 */
3230 		if (softc->media_blksize) {
3231 			softc->flags |= SA_FLAG_FIXED;
3232 			if (powerof2(softc->media_blksize)) {
3233 				softc->blk_shift =
3234 				    ffs(softc->media_blksize) - 1;
3235 				softc->blk_mask = softc->media_blksize - 1;
3236 			} else {
3237 				softc->blk_mask = ~0;
3238 				softc->blk_shift = 0;
3239 			}
3240 		} else {
3241 			/*
3242 			 * The SCSI-3 spec allows 0 to mean "unspecified".
3243 			 * The SCSI-1 spec allows 0 to mean 'infinite'.
3244 			 *
3245 			 * Either works here.
3246 			 */
3247 			if (softc->max_blk == 0) {
3248 				softc->max_blk = ~0;
3249 			}
3250 			softc->blk_shift = 0;
3251 			if (softc->blk_gran != 0) {
3252 				softc->blk_mask = softc->blk_gran - 1;
3253 			} else {
3254 				softc->blk_mask = 0;
3255 			}
3256 		}
3257 
3258 		if (write_protect)
3259 			softc->flags |= SA_FLAG_TAPE_WP;
3260 
3261 		if (comp_supported) {
3262 			if (softc->saved_comp_algorithm == 0)
3263 				softc->saved_comp_algorithm =
3264 				    softc->comp_algorithm;
3265 			softc->flags |= SA_FLAG_COMP_SUPP;
3266 			if (comp_enabled)
3267 				softc->flags |= SA_FLAG_COMP_ENABLED;
3268 		} else
3269 			softc->flags |= SA_FLAG_COMP_UNSUPP;
3270 
3271 		if ((softc->buffer_mode == SMH_SA_BUF_MODE_NOBUF) &&
3272 		    (softc->quirks & SA_QUIRK_NO_MODESEL) == 0) {
3273 			error = sasetparams(periph, SA_PARAM_BUFF_MODE, 0,
3274 			    0, 0, SF_NO_PRINT);
3275 			if (error == 0) {
3276 				softc->buffer_mode = SMH_SA_BUF_MODE_SIBUF;
3277 			} else {
3278 				xpt_print(periph->path,
3279 				    "unable to set buffered mode\n");
3280 			}
3281 			error = 0;	/* not an error */
3282 		}
3283 
3284 
3285 		if (error == 0) {
3286 			softc->flags |= SA_FLAG_TAPE_MOUNTED;
3287 		}
3288 exit:
3289 		if (rblim != NULL)
3290 			free(rblim, M_SCSISA);
3291 
3292 		if (error != 0) {
3293 			softc->dsreg = MTIO_DSREG_NIL;
3294 		} else {
3295 			softc->fileno = softc->blkno = 0;
3296 			softc->rep_fileno = softc->rep_blkno = -1;
3297 			softc->partition = 0;
3298 			softc->dsreg = MTIO_DSREG_REST;
3299 		}
3300 #ifdef	SA_1FM_AT_EOD
3301 		if ((softc->quirks & SA_QUIRK_2FM) == 0)
3302 			softc->quirks |= SA_QUIRK_1FM;
3303 #else
3304 		if ((softc->quirks & SA_QUIRK_1FM) == 0)
3305 			softc->quirks |= SA_QUIRK_2FM;
3306 #endif
3307 	} else
3308 		xpt_release_ccb(ccb);
3309 
3310 	/*
3311 	 * If we return an error, we're not mounted any more,
3312 	 * so release any device reservation.
3313 	 */
3314 	if (error != 0) {
3315 		(void) sareservereleaseunit(periph, FALSE);
3316 	} else {
3317 		/*
3318 		 * Clear I/O residual.
3319 		 */
3320 		softc->last_io_resid = 0;
3321 		softc->last_ctl_resid = 0;
3322 	}
3323 	return (error);
3324 }
3325 
3326 /*
3327  * How many filemarks do we need to write if we were to terminate the
3328  * tape session right now? Note that this can be a negative number
3329  */
3330 
3331 static int
3332 samarkswanted(struct cam_periph *periph)
3333 {
3334 	int	markswanted;
3335 	struct	sa_softc *softc;
3336 
3337 	softc = (struct sa_softc *)periph->softc;
3338 	markswanted = 0;
3339 	if ((softc->flags & SA_FLAG_TAPE_WRITTEN) != 0) {
3340 		markswanted++;
3341 		if (softc->quirks & SA_QUIRK_2FM)
3342 			markswanted++;
3343 	}
3344 	markswanted -= softc->filemarks;
3345 	return (markswanted);
3346 }
3347 
3348 static int
3349 sacheckeod(struct cam_periph *periph)
3350 {
3351 	int	error;
3352 	int	markswanted;
3353 
3354 	markswanted = samarkswanted(periph);
3355 
3356 	if (markswanted > 0) {
3357 		error = sawritefilemarks(periph, markswanted, FALSE, FALSE);
3358 	} else {
3359 		error = 0;
3360 	}
3361 	return (error);
3362 }
3363 
3364 static int
3365 saerror(union ccb *ccb, u_int32_t cflgs, u_int32_t sflgs)
3366 {
3367 	static const char *toobig =
3368 	    "%d-byte tape record bigger than supplied buffer\n";
3369 	struct	cam_periph *periph;
3370 	struct	sa_softc *softc;
3371 	struct	ccb_scsiio *csio;
3372 	struct	scsi_sense_data *sense;
3373 	uint64_t resid = 0;
3374 	int64_t	info = 0;
3375 	cam_status status;
3376 	int error_code, sense_key, asc, ascq, error, aqvalid, stream_valid;
3377 	int sense_len;
3378 	uint8_t stream_bits;
3379 
3380 	periph = xpt_path_periph(ccb->ccb_h.path);
3381 	softc = (struct sa_softc *)periph->softc;
3382 	csio = &ccb->csio;
3383 	sense = &csio->sense_data;
3384 	sense_len = csio->sense_len - csio->sense_resid;
3385 	scsi_extract_sense_len(sense, sense_len, &error_code, &sense_key,
3386 	    &asc, &ascq, /*show_errors*/ 1);
3387 	if (asc != -1 && ascq != -1)
3388 		aqvalid = 1;
3389 	else
3390 		aqvalid = 0;
3391 	if (scsi_get_stream_info(sense, sense_len, NULL, &stream_bits) == 0)
3392 		stream_valid = 1;
3393 	else
3394 		stream_valid = 0;
3395 	error = 0;
3396 
3397 	status = csio->ccb_h.status & CAM_STATUS_MASK;
3398 
3399 	/*
3400 	 * Calculate/latch up, any residuals... We do this in a funny 2-step
3401 	 * so we can print stuff here if we have CAM_DEBUG enabled for this
3402 	 * unit.
3403 	 */
3404 	if (status == CAM_SCSI_STATUS_ERROR) {
3405 		if (scsi_get_sense_info(sense, sense_len, SSD_DESC_INFO, &resid,
3406 					&info) == 0) {
3407 			if ((softc->flags & SA_FLAG_FIXED) != 0)
3408 				resid *= softc->media_blksize;
3409 		} else {
3410 			resid = csio->dxfer_len;
3411 			info = resid;
3412 			if ((softc->flags & SA_FLAG_FIXED) != 0) {
3413 				if (softc->media_blksize)
3414 					info /= softc->media_blksize;
3415 			}
3416 		}
3417 		if (csio->cdb_io.cdb_bytes[0] == SA_READ ||
3418 		    csio->cdb_io.cdb_bytes[0] == SA_WRITE) {
3419 			bcopy((caddr_t) sense, (caddr_t) &softc->last_io_sense,
3420 			    sizeof (struct scsi_sense_data));
3421 			bcopy(csio->cdb_io.cdb_bytes, softc->last_io_cdb,
3422 			    (int) csio->cdb_len);
3423 			softc->last_io_resid = resid;
3424 			softc->last_resid_was_io = 1;
3425 		} else {
3426 			bcopy((caddr_t) sense, (caddr_t) &softc->last_ctl_sense,
3427 			    sizeof (struct scsi_sense_data));
3428 			bcopy(csio->cdb_io.cdb_bytes, softc->last_ctl_cdb,
3429 			    (int) csio->cdb_len);
3430 			softc->last_ctl_resid = resid;
3431 			softc->last_resid_was_io = 0;
3432 		}
3433 		CAM_DEBUG(periph->path, CAM_DEBUG_INFO, ("CDB[0]=0x%x Key 0x%x "
3434 		    "ASC/ASCQ 0x%x/0x%x CAM STATUS 0x%x flags 0x%x resid %jd "
3435 		    "dxfer_len %d\n", csio->cdb_io.cdb_bytes[0] & 0xff,
3436 		    sense_key, asc, ascq, status,
3437 		    (stream_valid) ? stream_bits : 0, (intmax_t)resid,
3438 		    csio->dxfer_len));
3439 	} else {
3440 		CAM_DEBUG(periph->path, CAM_DEBUG_INFO,
3441 		    ("Cam Status 0x%x\n", status));
3442 	}
3443 
3444 	switch (status) {
3445 	case CAM_REQ_CMP:
3446 		return (0);
3447 	case CAM_SCSI_STATUS_ERROR:
3448 		/*
3449 		 * If a read/write command, we handle it here.
3450 		 */
3451 		if (csio->cdb_io.cdb_bytes[0] == SA_READ ||
3452 		    csio->cdb_io.cdb_bytes[0] == SA_WRITE) {
3453 			break;
3454 		}
3455 		/*
3456 		 * If this was just EOM/EOP, Filemark, Setmark, ILI or
3457 		 * PEW detected on a non read/write command, we assume
3458 		 * it's not an error and propagate the residual and return.
3459 		 */
3460 		if ((aqvalid && asc == 0 && ((ascq > 0 && ascq <= 5)
3461 		  || (ascq == 0x07)))
3462 		 || (aqvalid == 0 && sense_key == SSD_KEY_NO_SENSE)) {
3463 			csio->resid = resid;
3464 			QFRLS(ccb);
3465 			return (0);
3466 		}
3467 		/*
3468 		 * Otherwise, we let the common code handle this.
3469 		 */
3470 		return (cam_periph_error(ccb, cflgs, sflgs));
3471 
3472 	/*
3473 	 * XXX: To Be Fixed
3474 	 * We cannot depend upon CAM honoring retry counts for these.
3475 	 */
3476 	case CAM_SCSI_BUS_RESET:
3477 	case CAM_BDR_SENT:
3478 		if (ccb->ccb_h.retry_count <= 0) {
3479 			return (EIO);
3480 		}
3481 		/* FALLTHROUGH */
3482 	default:
3483 		return (cam_periph_error(ccb, cflgs, sflgs));
3484 	}
3485 
3486 	/*
3487 	 * Handle filemark, end of tape, mismatched record sizes....
3488 	 * From this point out, we're only handling read/write cases.
3489 	 * Handle writes && reads differently.
3490 	 */
3491 
3492 	if (csio->cdb_io.cdb_bytes[0] == SA_WRITE) {
3493 		if (sense_key == SSD_KEY_VOLUME_OVERFLOW) {
3494 			csio->resid = resid;
3495 			error = ENOSPC;
3496 		} else if ((stream_valid != 0) && (stream_bits & SSD_EOM)) {
3497 			softc->flags |= SA_FLAG_EOM_PENDING;
3498 			/*
3499 			 * Grotesque as it seems, the few times
3500 			 * I've actually seen a non-zero resid,
3501 			 * the tape drive actually lied and had
3502 			 * written all the data!.
3503 			 */
3504 			csio->resid = 0;
3505 		}
3506 	} else {
3507 		csio->resid = resid;
3508 		if (sense_key == SSD_KEY_BLANK_CHECK) {
3509 			if (softc->quirks & SA_QUIRK_1FM) {
3510 				error = 0;
3511 				softc->flags |= SA_FLAG_EOM_PENDING;
3512 			} else {
3513 				error = EIO;
3514 			}
3515 		} else if ((stream_valid != 0) && (stream_bits & SSD_FILEMARK)){
3516 			if (softc->flags & SA_FLAG_FIXED) {
3517 				error = -1;
3518 				softc->flags |= SA_FLAG_EOF_PENDING;
3519 			}
3520 			/*
3521 			 * Unconditionally, if we detected a filemark on a read,
3522 			 * mark that we've run moved a file ahead.
3523 			 */
3524 			if (softc->fileno != (daddr_t) -1) {
3525 				softc->fileno++;
3526 				softc->blkno = 0;
3527 				csio->ccb_h.ccb_pflags |= SA_POSITION_UPDATED;
3528 			}
3529 		}
3530 	}
3531 
3532 	/*
3533 	 * Incorrect Length usually applies to read, but can apply to writes.
3534 	 */
3535 	if (error == 0 && (stream_valid != 0) && (stream_bits & SSD_ILI)) {
3536 		if (info < 0) {
3537 			xpt_print(csio->ccb_h.path, toobig,
3538 			    csio->dxfer_len - info);
3539 			csio->resid = csio->dxfer_len;
3540 			error = EIO;
3541 		} else {
3542 			csio->resid = resid;
3543 			if (softc->flags & SA_FLAG_FIXED) {
3544 				softc->flags |= SA_FLAG_EIO_PENDING;
3545 			}
3546 			/*
3547 			 * Bump the block number if we hadn't seen a filemark.
3548 			 * Do this independent of errors (we've moved anyway).
3549 			 */
3550 			if ((stream_valid == 0) ||
3551 			    (stream_bits & SSD_FILEMARK) == 0) {
3552 				if (softc->blkno != (daddr_t) -1) {
3553 					softc->blkno++;
3554 					csio->ccb_h.ccb_pflags |=
3555 					   SA_POSITION_UPDATED;
3556 				}
3557 			}
3558 		}
3559 	}
3560 
3561 	if (error <= 0) {
3562 		/*
3563 		 * Unfreeze the queue if frozen as we're not returning anything
3564 		 * to our waiters that would indicate an I/O error has occurred
3565 		 * (yet).
3566 		 */
3567 		QFRLS(ccb);
3568 		error = 0;
3569 	}
3570 	return (error);
3571 }
3572 
3573 static int
3574 sagetparams(struct cam_periph *periph, sa_params params_to_get,
3575 	    u_int32_t *blocksize, u_int8_t *density, u_int32_t *numblocks,
3576 	    int *buff_mode, u_int8_t *write_protect, u_int8_t *speed,
3577 	    int *comp_supported, int *comp_enabled, u_int32_t *comp_algorithm,
3578 	    sa_comp_t *tcs, struct scsi_control_data_prot_subpage *prot_page,
3579 	    int dp_size, int prot_changeable)
3580 {
3581 	union ccb *ccb;
3582 	void *mode_buffer;
3583 	struct scsi_mode_header_6 *mode_hdr;
3584 	struct scsi_mode_blk_desc *mode_blk;
3585 	int mode_buffer_len;
3586 	struct sa_softc *softc;
3587 	u_int8_t cpage;
3588 	int error;
3589 	cam_status status;
3590 
3591 	softc = (struct sa_softc *)periph->softc;
3592 	ccb = cam_periph_getccb(periph, 1);
3593 	if (softc->quirks & SA_QUIRK_NO_CPAGE)
3594 		cpage = SA_DEVICE_CONFIGURATION_PAGE;
3595 	else
3596 		cpage = SA_DATA_COMPRESSION_PAGE;
3597 
3598 retry:
3599 	mode_buffer_len = sizeof(*mode_hdr) + sizeof(*mode_blk);
3600 
3601 	if (params_to_get & SA_PARAM_COMPRESSION) {
3602 		if (softc->quirks & SA_QUIRK_NOCOMP) {
3603 			*comp_supported = FALSE;
3604 			params_to_get &= ~SA_PARAM_COMPRESSION;
3605 		} else
3606 			mode_buffer_len += sizeof (sa_comp_t);
3607 	}
3608 
3609 	/* XXX Fix M_NOWAIT */
3610 	mode_buffer = malloc(mode_buffer_len, M_SCSISA, M_NOWAIT | M_ZERO);
3611 	if (mode_buffer == NULL) {
3612 		xpt_release_ccb(ccb);
3613 		return (ENOMEM);
3614 	}
3615 	mode_hdr = (struct scsi_mode_header_6 *)mode_buffer;
3616 	mode_blk = (struct scsi_mode_blk_desc *)&mode_hdr[1];
3617 
3618 	/* it is safe to retry this */
3619 	scsi_mode_sense(&ccb->csio, 5, NULL, MSG_SIMPLE_Q_TAG, FALSE,
3620 	    SMS_PAGE_CTRL_CURRENT, (params_to_get & SA_PARAM_COMPRESSION) ?
3621 	    cpage : SMS_VENDOR_SPECIFIC_PAGE, mode_buffer, mode_buffer_len,
3622 	    SSD_FULL_SIZE, SCSIOP_TIMEOUT);
3623 
3624 	error = cam_periph_runccb(ccb, saerror, 0, SF_NO_PRINT,
3625 	    softc->device_stats);
3626 
3627 	status = ccb->ccb_h.status & CAM_STATUS_MASK;
3628 
3629 	if (error == EINVAL && (params_to_get & SA_PARAM_COMPRESSION) != 0) {
3630 		/*
3631 		 * Hmm. Let's see if we can try another page...
3632 		 * If we've already done that, give up on compression
3633 		 * for this device and remember this for the future
3634 		 * and attempt the request without asking for compression
3635 		 * info.
3636 		 */
3637 		if (cpage == SA_DATA_COMPRESSION_PAGE) {
3638 			cpage = SA_DEVICE_CONFIGURATION_PAGE;
3639 			goto retry;
3640 		}
3641 		softc->quirks |= SA_QUIRK_NOCOMP;
3642 		free(mode_buffer, M_SCSISA);
3643 		goto retry;
3644 	} else if (status == CAM_SCSI_STATUS_ERROR) {
3645 		/* Tell the user about the fatal error. */
3646 		scsi_sense_print(&ccb->csio);
3647 		goto sagetparamsexit;
3648 	}
3649 
3650 	/*
3651 	 * If the user only wants the compression information, and
3652 	 * the device doesn't send back the block descriptor, it's
3653 	 * no big deal.  If the user wants more than just
3654 	 * compression, though, and the device doesn't pass back the
3655 	 * block descriptor, we need to send another mode sense to
3656 	 * get the block descriptor.
3657 	 */
3658 	if ((mode_hdr->blk_desc_len == 0) &&
3659 	    (params_to_get & SA_PARAM_COMPRESSION) &&
3660 	    (params_to_get & ~(SA_PARAM_COMPRESSION))) {
3661 
3662 		/*
3663 		 * Decrease the mode buffer length by the size of
3664 		 * the compression page, to make sure the data
3665 		 * there doesn't get overwritten.
3666 		 */
3667 		mode_buffer_len -= sizeof (sa_comp_t);
3668 
3669 		/*
3670 		 * Now move the compression page that we presumably
3671 		 * got back down the memory chunk a little bit so
3672 		 * it doesn't get spammed.
3673 		 */
3674 		bcopy(&mode_hdr[0], &mode_hdr[1], sizeof (sa_comp_t));
3675 		bzero(&mode_hdr[0], sizeof (mode_hdr[0]));
3676 
3677 		/*
3678 		 * Now, we issue another mode sense and just ask
3679 		 * for the block descriptor, etc.
3680 		 */
3681 
3682 		scsi_mode_sense(&ccb->csio, 2, NULL, MSG_SIMPLE_Q_TAG, FALSE,
3683 		    SMS_PAGE_CTRL_CURRENT, SMS_VENDOR_SPECIFIC_PAGE,
3684 		    mode_buffer, mode_buffer_len, SSD_FULL_SIZE,
3685 		    SCSIOP_TIMEOUT);
3686 
3687 		error = cam_periph_runccb(ccb, saerror, 0, SF_NO_PRINT,
3688 		    softc->device_stats);
3689 
3690 		if (error != 0)
3691 			goto sagetparamsexit;
3692 	}
3693 
3694 	if (params_to_get & SA_PARAM_BLOCKSIZE)
3695 		*blocksize = scsi_3btoul(mode_blk->blklen);
3696 
3697 	if (params_to_get & SA_PARAM_NUMBLOCKS)
3698 		*numblocks = scsi_3btoul(mode_blk->nblocks);
3699 
3700 	if (params_to_get & SA_PARAM_BUFF_MODE)
3701 		*buff_mode = mode_hdr->dev_spec & SMH_SA_BUF_MODE_MASK;
3702 
3703 	if (params_to_get & SA_PARAM_DENSITY)
3704 		*density = mode_blk->density;
3705 
3706 	if (params_to_get & SA_PARAM_WP)
3707 		*write_protect = (mode_hdr->dev_spec & SMH_SA_WP)? TRUE : FALSE;
3708 
3709 	if (params_to_get & SA_PARAM_SPEED)
3710 		*speed = mode_hdr->dev_spec & SMH_SA_SPEED_MASK;
3711 
3712 	if (params_to_get & SA_PARAM_COMPRESSION) {
3713 		sa_comp_t *ntcs = (sa_comp_t *) &mode_blk[1];
3714 		if (cpage == SA_DATA_COMPRESSION_PAGE) {
3715 			struct scsi_data_compression_page *cp = &ntcs->dcomp;
3716 			*comp_supported =
3717 			    (cp->dce_and_dcc & SA_DCP_DCC)? TRUE : FALSE;
3718 			*comp_enabled =
3719 			    (cp->dce_and_dcc & SA_DCP_DCE)? TRUE : FALSE;
3720 			*comp_algorithm = scsi_4btoul(cp->comp_algorithm);
3721 		} else {
3722 			struct scsi_dev_conf_page *cp = &ntcs->dconf;
3723 			/*
3724 			 * We don't really know whether this device supports
3725 			 * Data Compression if the algorithm field is
3726 			 * zero. Just say we do.
3727 			 */
3728 			*comp_supported = TRUE;
3729 			*comp_enabled =
3730 			    (cp->sel_comp_alg != SA_COMP_NONE)? TRUE : FALSE;
3731 			*comp_algorithm = cp->sel_comp_alg;
3732 		}
3733 		if (tcs != NULL)
3734 			bcopy(ntcs, tcs, sizeof (sa_comp_t));
3735 	}
3736 
3737 	if ((params_to_get & SA_PARAM_DENSITY_EXT)
3738 	 && (softc->scsi_rev >= SCSI_REV_SPC)) {
3739 		int i;
3740 
3741 		for (i = 0; i < SA_DENSITY_TYPES; i++) {
3742 			scsi_report_density_support(&ccb->csio,
3743 			    /*retries*/ 1,
3744 			    /*cbfcnp*/ NULL,
3745 			    /*tag_action*/ MSG_SIMPLE_Q_TAG,
3746 			    /*media*/ softc->density_type_bits[i] & SRDS_MEDIA,
3747 			    /*medium_type*/ softc->density_type_bits[i] &
3748 					    SRDS_MEDIUM_TYPE,
3749 			    /*data_ptr*/ softc->density_info[i],
3750 			    /*length*/ sizeof(softc->density_info[i]),
3751 			    /*sense_len*/ SSD_FULL_SIZE,
3752 			    /*timeout*/ REP_DENSITY_TIMEOUT);
3753 			error = cam_periph_runccb(ccb, saerror, 0, SF_NO_PRINT,
3754 			    softc->device_stats);
3755 			status = ccb->ccb_h.status & CAM_STATUS_MASK;
3756 
3757 			/*
3758 			 * Some tape drives won't support this command at
3759 			 * all, but hopefully we'll minimize that with the
3760 			 * check for SPC or greater support above.  If they
3761 			 * don't support the default report (neither the
3762 			 * MEDIA or MEDIUM_TYPE bits set), then there is
3763 			 * really no point in continuing on to look for
3764 			 * other reports.
3765 			 */
3766 			if ((error != 0)
3767 			 || (status != CAM_REQ_CMP)) {
3768 				error = 0;
3769 				softc->density_info_valid[i] = 0;
3770 				if (softc->density_type_bits[i] == 0)
3771 					break;
3772 				else
3773 					continue;
3774 			}
3775 			softc->density_info_valid[i] = ccb->csio.dxfer_len -
3776 			    ccb->csio.resid;
3777 		}
3778 	}
3779 
3780 	/*
3781 	 * Get logical block protection parameters if the drive supports it.
3782 	 */
3783 	if ((params_to_get & SA_PARAM_LBP)
3784 	 && (softc->flags & SA_FLAG_PROTECT_SUPP)) {
3785 		struct scsi_mode_header_10 *mode10_hdr;
3786 		struct scsi_control_data_prot_subpage *dp_page;
3787 		struct scsi_mode_sense_10 *cdb;
3788 		struct sa_prot_state *prot;
3789 		int dp_len, returned_len;
3790 
3791 		if (dp_size == 0)
3792 			dp_size = sizeof(*dp_page);
3793 
3794 		dp_len = sizeof(*mode10_hdr) + dp_size;
3795 		mode10_hdr = malloc(dp_len, M_SCSISA, M_NOWAIT | M_ZERO);
3796 		if (mode10_hdr == NULL) {
3797 			error = ENOMEM;
3798 			goto sagetparamsexit;
3799 		}
3800 
3801 		scsi_mode_sense_len(&ccb->csio,
3802 				    /*retries*/ 5,
3803 				    /*cbfcnp*/ NULL,
3804 				    /*tag_action*/ MSG_SIMPLE_Q_TAG,
3805 				    /*dbd*/ TRUE,
3806 				    /*page_code*/ (prot_changeable == 0) ?
3807 						  SMS_PAGE_CTRL_CURRENT :
3808 						  SMS_PAGE_CTRL_CHANGEABLE,
3809 				    /*page*/ SMS_CONTROL_MODE_PAGE,
3810 				    /*param_buf*/ (uint8_t *)mode10_hdr,
3811 				    /*param_len*/ dp_len,
3812 				    /*minimum_cmd_size*/ 10,
3813 				    /*sense_len*/ SSD_FULL_SIZE,
3814 				    /*timeout*/ SCSIOP_TIMEOUT);
3815 		/*
3816 		 * XXX KDM we need to be able to set the subpage in the
3817 		 * fill function.
3818 		 */
3819 		cdb = (struct scsi_mode_sense_10 *)ccb->csio.cdb_io.cdb_bytes;
3820 		cdb->subpage = SA_CTRL_DP_SUBPAGE_CODE;
3821 
3822 		error = cam_periph_runccb(ccb, saerror, 0, SF_NO_PRINT,
3823 		    softc->device_stats);
3824 		if (error != 0) {
3825 			free(mode10_hdr, M_SCSISA);
3826 			goto sagetparamsexit;
3827 		}
3828 
3829 		status = ccb->ccb_h.status & CAM_STATUS_MASK;
3830 		if (status != CAM_REQ_CMP) {
3831 			error = EINVAL;
3832 			free(mode10_hdr, M_SCSISA);
3833 			goto sagetparamsexit;
3834 		}
3835 
3836 		/*
3837 		 * The returned data length at least has to be long enough
3838 		 * for us to look at length in the mode page header.
3839 		 */
3840 		returned_len = ccb->csio.dxfer_len - ccb->csio.resid;
3841 		if (returned_len < sizeof(mode10_hdr->data_length)) {
3842 			error = EINVAL;
3843 			free(mode10_hdr, M_SCSISA);
3844 			goto sagetparamsexit;
3845 		}
3846 
3847 		returned_len = min(returned_len,
3848 		    sizeof(mode10_hdr->data_length) +
3849 		    scsi_2btoul(mode10_hdr->data_length));
3850 
3851 		dp_page = (struct scsi_control_data_prot_subpage *)
3852 		    &mode10_hdr[1];
3853 
3854 		/*
3855 		 * We also have to have enough data to include the prot_bits
3856 		 * in the subpage.
3857 		 */
3858 		if (returned_len < (sizeof(*mode10_hdr) +
3859 		    __offsetof(struct scsi_control_data_prot_subpage, prot_bits)
3860 		    + sizeof(dp_page->prot_bits))) {
3861 			error = EINVAL;
3862 			free(mode10_hdr, M_SCSISA);
3863 			goto sagetparamsexit;
3864 		}
3865 
3866 		prot = &softc->prot_info.cur_prot_state;
3867 		prot->prot_method = dp_page->prot_method;
3868 		prot->pi_length = dp_page->pi_length &
3869 		    SA_CTRL_DP_PI_LENGTH_MASK;
3870 		prot->lbp_w = (dp_page->prot_bits & SA_CTRL_DP_LBP_W) ? 1 :0;
3871 		prot->lbp_r = (dp_page->prot_bits & SA_CTRL_DP_LBP_R) ? 1 :0;
3872 		prot->rbdp = (dp_page->prot_bits & SA_CTRL_DP_RBDP) ? 1 :0;
3873 		prot->initialized = 1;
3874 
3875 		if (prot_page != NULL)
3876 			bcopy(dp_page, prot_page, min(sizeof(*prot_page),
3877 			    sizeof(*dp_page)));
3878 
3879 		free(mode10_hdr, M_SCSISA);
3880 	}
3881 
3882 	if (CAM_DEBUGGED(periph->path, CAM_DEBUG_INFO)) {
3883 		int idx;
3884 		char *xyz = mode_buffer;
3885 		xpt_print_path(periph->path);
3886 		printf("Mode Sense Data=");
3887 		for (idx = 0; idx < mode_buffer_len; idx++)
3888 			printf(" 0x%02x", xyz[idx] & 0xff);
3889 		printf("\n");
3890 	}
3891 
3892 sagetparamsexit:
3893 
3894 	xpt_release_ccb(ccb);
3895 	free(mode_buffer, M_SCSISA);
3896 	return (error);
3897 }
3898 
3899 /*
3900  * Set protection information to the pending protection information stored
3901  * in the softc.
3902  */
3903 static int
3904 sasetprot(struct cam_periph *periph, struct sa_prot_state *new_prot)
3905 {
3906 	struct sa_softc *softc;
3907 	struct scsi_control_data_prot_subpage *dp_page, *dp_changeable;
3908 	struct scsi_mode_header_10 *mode10_hdr, *mode10_changeable;
3909 	union ccb *ccb;
3910 	uint8_t current_speed;
3911 	size_t dp_size, dp_page_length;
3912 	int dp_len, buff_mode;
3913 	int error;
3914 
3915 	softc = (struct sa_softc *)periph->softc;
3916 	mode10_hdr = NULL;
3917 	mode10_changeable = NULL;
3918 	ccb = NULL;
3919 
3920 	/*
3921 	 * Start off with the size set to the actual length of the page
3922 	 * that we have defined.
3923 	 */
3924 	dp_size = sizeof(*dp_changeable);
3925 	dp_page_length = dp_size -
3926 	    __offsetof(struct scsi_control_data_prot_subpage, prot_method);
3927 
3928 retry_length:
3929 
3930 	dp_len = sizeof(*mode10_changeable) + dp_size;
3931 	mode10_changeable = malloc(dp_len, M_SCSISA, M_NOWAIT | M_ZERO);
3932 	if (mode10_changeable == NULL) {
3933 		error = ENOMEM;
3934 		goto bailout;
3935 	}
3936 
3937 	dp_changeable =
3938 	    (struct scsi_control_data_prot_subpage *)&mode10_changeable[1];
3939 
3940 	/*
3941 	 * First get the data protection page changeable parameters mask.
3942 	 * We need to know which parameters the drive supports changing.
3943 	 * We also need to know what the drive claims that its page length
3944 	 * is.  The reason is that IBM drives in particular are very picky
3945 	 * about the page length.  They want it (the length set in the
3946 	 * page structure itself) to be 28 bytes, and they want the
3947 	 * parameter list length specified in the mode select header to be
3948 	 * 40 bytes.  So, to work with IBM drives as well as any other tape
3949 	 * drive, find out what the drive claims the page length is, and
3950 	 * make sure that we match that.
3951 	 */
3952 	error = sagetparams(periph, SA_PARAM_SPEED | SA_PARAM_LBP,
3953 	    NULL, NULL, NULL, &buff_mode, NULL, &current_speed, NULL, NULL,
3954 	    NULL, NULL, dp_changeable, dp_size, /*prot_changeable*/ 1);
3955 	if (error != 0)
3956 		goto bailout;
3957 
3958 	if (scsi_2btoul(dp_changeable->length) > dp_page_length) {
3959 		dp_page_length = scsi_2btoul(dp_changeable->length);
3960 		dp_size = dp_page_length +
3961 		    __offsetof(struct scsi_control_data_prot_subpage,
3962 		    prot_method);
3963 		free(mode10_changeable, M_SCSISA);
3964 		mode10_changeable = NULL;
3965 		goto retry_length;
3966 	}
3967 
3968 	mode10_hdr = malloc(dp_len, M_SCSISA, M_NOWAIT | M_ZERO);
3969 	if (mode10_hdr == NULL) {
3970 		error = ENOMEM;
3971 		goto bailout;
3972 	}
3973 
3974 	dp_page = (struct scsi_control_data_prot_subpage *)&mode10_hdr[1];
3975 
3976 	/*
3977 	 * Now grab the actual current settings in the page.
3978 	 */
3979 	error = sagetparams(periph, SA_PARAM_SPEED | SA_PARAM_LBP,
3980 	    NULL, NULL, NULL, &buff_mode, NULL, &current_speed, NULL, NULL,
3981 	    NULL, NULL, dp_page, dp_size, /*prot_changeable*/ 0);
3982 	if (error != 0)
3983 		goto bailout;
3984 
3985 	/* These two fields need to be 0 for MODE SELECT */
3986 	scsi_ulto2b(0, mode10_hdr->data_length);
3987 	mode10_hdr->medium_type = 0;
3988 	/* We are not including a block descriptor */
3989 	scsi_ulto2b(0, mode10_hdr->blk_desc_len);
3990 
3991 	mode10_hdr->dev_spec = current_speed;
3992 	/* if set, set single-initiator buffering mode */
3993 	if (softc->buffer_mode == SMH_SA_BUF_MODE_SIBUF) {
3994 		mode10_hdr->dev_spec |= SMH_SA_BUF_MODE_SIBUF;
3995 	}
3996 
3997 	/*
3998 	 * For each field, make sure that the drive allows changing it
3999 	 * before bringing in the user's setting.
4000 	 */
4001 	if (dp_changeable->prot_method != 0)
4002 		dp_page->prot_method = new_prot->prot_method;
4003 
4004 	if (dp_changeable->pi_length & SA_CTRL_DP_PI_LENGTH_MASK) {
4005 		dp_page->pi_length &= ~SA_CTRL_DP_PI_LENGTH_MASK;
4006 		dp_page->pi_length |= (new_prot->pi_length &
4007 		    SA_CTRL_DP_PI_LENGTH_MASK);
4008 	}
4009 	if (dp_changeable->prot_bits & SA_CTRL_DP_LBP_W) {
4010 		if (new_prot->lbp_w)
4011 			dp_page->prot_bits |= SA_CTRL_DP_LBP_W;
4012 		else
4013 			dp_page->prot_bits &= ~SA_CTRL_DP_LBP_W;
4014 	}
4015 
4016 	if (dp_changeable->prot_bits & SA_CTRL_DP_LBP_R) {
4017 		if (new_prot->lbp_r)
4018 			dp_page->prot_bits |= SA_CTRL_DP_LBP_R;
4019 		else
4020 			dp_page->prot_bits &= ~SA_CTRL_DP_LBP_R;
4021 	}
4022 
4023 	if (dp_changeable->prot_bits & SA_CTRL_DP_RBDP) {
4024 		if (new_prot->rbdp)
4025 			dp_page->prot_bits |= SA_CTRL_DP_RBDP;
4026 		else
4027 			dp_page->prot_bits &= ~SA_CTRL_DP_RBDP;
4028 	}
4029 
4030 	ccb = cam_periph_getccb(periph, 1);
4031 
4032 	scsi_mode_select_len(&ccb->csio,
4033 			     /*retries*/ 5,
4034 			     /*cbfcnp*/ NULL,
4035 			     /*tag_action*/ MSG_SIMPLE_Q_TAG,
4036 			     /*scsi_page_fmt*/ TRUE,
4037 			     /*save_pages*/ FALSE,
4038 			     /*param_buf*/ (uint8_t *)mode10_hdr,
4039 			     /*param_len*/ dp_len,
4040 			     /*minimum_cmd_size*/ 10,
4041 			     /*sense_len*/ SSD_FULL_SIZE,
4042 			     /*timeout*/ SCSIOP_TIMEOUT);
4043 
4044 	error = cam_periph_runccb(ccb, saerror, 0, 0, softc->device_stats);
4045 	if (error != 0)
4046 		goto bailout;
4047 
4048 	if ((ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
4049 		error = EINVAL;
4050 		goto bailout;
4051 	}
4052 
4053 	/*
4054 	 * The operation was successful.  We could just copy the settings
4055 	 * the user requested, but just in case the drive ignored some of
4056 	 * our settings, let's ask for status again.
4057 	 */
4058 	error = sagetparams(periph, SA_PARAM_SPEED | SA_PARAM_LBP,
4059 	    NULL, NULL, NULL, &buff_mode, NULL, &current_speed, NULL, NULL,
4060 	    NULL, NULL, dp_page, dp_size, 0);
4061 
4062 bailout:
4063 	if (ccb != NULL)
4064 		xpt_release_ccb(ccb);
4065 	free(mode10_hdr, M_SCSISA);
4066 	free(mode10_changeable, M_SCSISA);
4067 	return (error);
4068 }
4069 
4070 /*
4071  * The purpose of this function is to set one of four different parameters
4072  * for a tape drive:
4073  *	- blocksize
4074  *	- density
4075  *	- compression / compression algorithm
4076  *	- buffering mode
4077  *
4078  * The assumption is that this will be called from saioctl(), and therefore
4079  * from a process context.  Thus the waiting malloc calls below.  If that
4080  * assumption ever changes, the malloc calls should be changed to be
4081  * NOWAIT mallocs.
4082  *
4083  * Any or all of the four parameters may be set when this function is
4084  * called.  It should handle setting more than one parameter at once.
4085  */
4086 static int
4087 sasetparams(struct cam_periph *periph, sa_params params_to_set,
4088 	    u_int32_t blocksize, u_int8_t density, u_int32_t calg,
4089 	    u_int32_t sense_flags)
4090 {
4091 	struct sa_softc *softc;
4092 	u_int32_t current_blocksize;
4093 	u_int32_t current_calg;
4094 	u_int8_t current_density;
4095 	u_int8_t current_speed;
4096 	int comp_enabled, comp_supported;
4097 	void *mode_buffer;
4098 	int mode_buffer_len;
4099 	struct scsi_mode_header_6 *mode_hdr;
4100 	struct scsi_mode_blk_desc *mode_blk;
4101 	sa_comp_t *ccomp, *cpage;
4102 	int buff_mode;
4103 	union ccb *ccb = NULL;
4104 	int error;
4105 
4106 	softc = (struct sa_softc *)periph->softc;
4107 
4108 	ccomp = malloc(sizeof (sa_comp_t), M_SCSISA, M_NOWAIT);
4109 	if (ccomp == NULL)
4110 		return (ENOMEM);
4111 
4112 	/*
4113 	 * Since it doesn't make sense to set the number of blocks, or
4114 	 * write protection, we won't try to get the current value.  We
4115 	 * always want to get the blocksize, so we can set it back to the
4116 	 * proper value.
4117 	 */
4118 	error = sagetparams(periph,
4119 	    params_to_set | SA_PARAM_BLOCKSIZE | SA_PARAM_SPEED,
4120 	    &current_blocksize, &current_density, NULL, &buff_mode, NULL,
4121 	    &current_speed, &comp_supported, &comp_enabled,
4122 	    &current_calg, ccomp, NULL, 0, 0);
4123 
4124 	if (error != 0) {
4125 		free(ccomp, M_SCSISA);
4126 		return (error);
4127 	}
4128 
4129 	mode_buffer_len = sizeof(*mode_hdr) + sizeof(*mode_blk);
4130 	if (params_to_set & SA_PARAM_COMPRESSION)
4131 		mode_buffer_len += sizeof (sa_comp_t);
4132 
4133 	mode_buffer = malloc(mode_buffer_len, M_SCSISA, M_NOWAIT | M_ZERO);
4134 	if (mode_buffer == NULL) {
4135 		free(ccomp, M_SCSISA);
4136 		return (ENOMEM);
4137 	}
4138 
4139 	mode_hdr = (struct scsi_mode_header_6 *)mode_buffer;
4140 	mode_blk = (struct scsi_mode_blk_desc *)&mode_hdr[1];
4141 
4142 	ccb = cam_periph_getccb(periph, 1);
4143 
4144 retry:
4145 
4146 	if (params_to_set & SA_PARAM_COMPRESSION) {
4147 		if (mode_blk) {
4148 			cpage = (sa_comp_t *)&mode_blk[1];
4149 		} else {
4150 			cpage = (sa_comp_t *)&mode_hdr[1];
4151 		}
4152 		bcopy(ccomp, cpage, sizeof (sa_comp_t));
4153 		cpage->hdr.pagecode &= ~0x80;
4154 	} else
4155 		cpage = NULL;
4156 
4157 	/*
4158 	 * If the caller wants us to set the blocksize, use the one they
4159 	 * pass in.  Otherwise, use the blocksize we got back from the
4160 	 * mode select above.
4161 	 */
4162 	if (mode_blk) {
4163 		if (params_to_set & SA_PARAM_BLOCKSIZE)
4164 			scsi_ulto3b(blocksize, mode_blk->blklen);
4165 		else
4166 			scsi_ulto3b(current_blocksize, mode_blk->blklen);
4167 
4168 		/*
4169 		 * Set density if requested, else preserve old density.
4170 		 * SCSI_SAME_DENSITY only applies to SCSI-2 or better
4171 		 * devices, else density we've latched up in our softc.
4172 		 */
4173 		if (params_to_set & SA_PARAM_DENSITY) {
4174 			mode_blk->density = density;
4175 		} else if (softc->scsi_rev > SCSI_REV_CCS) {
4176 			mode_blk->density = SCSI_SAME_DENSITY;
4177 		} else {
4178 			mode_blk->density = softc->media_density;
4179 		}
4180 	}
4181 
4182 	/*
4183 	 * For mode selects, these two fields must be zero.
4184 	 */
4185 	mode_hdr->data_length = 0;
4186 	mode_hdr->medium_type = 0;
4187 
4188 	/* set the speed to the current value */
4189 	mode_hdr->dev_spec = current_speed;
4190 
4191 	/* if set, set single-initiator buffering mode */
4192 	if (softc->buffer_mode == SMH_SA_BUF_MODE_SIBUF) {
4193 		mode_hdr->dev_spec |= SMH_SA_BUF_MODE_SIBUF;
4194 	}
4195 
4196 	if (mode_blk)
4197 		mode_hdr->blk_desc_len = sizeof(struct scsi_mode_blk_desc);
4198 	else
4199 		mode_hdr->blk_desc_len = 0;
4200 
4201 	/*
4202 	 * First, if the user wants us to set the compression algorithm or
4203 	 * just turn compression on, check to make sure that this drive
4204 	 * supports compression.
4205 	 */
4206 	if (params_to_set & SA_PARAM_COMPRESSION) {
4207 		/*
4208 		 * If the compression algorithm is 0, disable compression.
4209 		 * If the compression algorithm is non-zero, enable
4210 		 * compression and set the compression type to the
4211 		 * specified compression algorithm, unless the algorithm is
4212 		 * MT_COMP_ENABLE.  In that case, we look at the
4213 		 * compression algorithm that is currently set and if it is
4214 		 * non-zero, we leave it as-is.  If it is zero, and we have
4215 		 * saved a compression algorithm from a time when
4216 		 * compression was enabled before, set the compression to
4217 		 * the saved value.
4218 		 */
4219 		switch (ccomp->hdr.pagecode & ~0x80) {
4220 		case SA_DEVICE_CONFIGURATION_PAGE:
4221 		{
4222 			struct scsi_dev_conf_page *dcp = &cpage->dconf;
4223 			if (calg == 0) {
4224 				dcp->sel_comp_alg = SA_COMP_NONE;
4225 				break;
4226 			}
4227 			if (calg != MT_COMP_ENABLE) {
4228 				dcp->sel_comp_alg = calg;
4229 			} else if (dcp->sel_comp_alg == SA_COMP_NONE &&
4230 			    softc->saved_comp_algorithm != 0) {
4231 				dcp->sel_comp_alg = softc->saved_comp_algorithm;
4232 			}
4233 			break;
4234 		}
4235 		case SA_DATA_COMPRESSION_PAGE:
4236 		if (ccomp->dcomp.dce_and_dcc & SA_DCP_DCC) {
4237 			struct scsi_data_compression_page *dcp = &cpage->dcomp;
4238 			if (calg == 0) {
4239 				/*
4240 				 * Disable compression, but leave the
4241 				 * decompression and the capability bit
4242 				 * alone.
4243 				 */
4244 				dcp->dce_and_dcc = SA_DCP_DCC;
4245 				dcp->dde_and_red |= SA_DCP_DDE;
4246 				break;
4247 			}
4248 			/* enable compression && decompression */
4249 			dcp->dce_and_dcc = SA_DCP_DCE | SA_DCP_DCC;
4250 			dcp->dde_and_red |= SA_DCP_DDE;
4251 			/*
4252 			 * If there, use compression algorithm from caller.
4253 			 * Otherwise, if there's a saved compression algorithm
4254 			 * and there is no current algorithm, use the saved
4255 			 * algorithm. Else parrot back what we got and hope
4256 			 * for the best.
4257 			 */
4258 			if (calg != MT_COMP_ENABLE) {
4259 				scsi_ulto4b(calg, dcp->comp_algorithm);
4260 				scsi_ulto4b(calg, dcp->decomp_algorithm);
4261 			} else if (scsi_4btoul(dcp->comp_algorithm) == 0 &&
4262 			    softc->saved_comp_algorithm != 0) {
4263 				scsi_ulto4b(softc->saved_comp_algorithm,
4264 				    dcp->comp_algorithm);
4265 				scsi_ulto4b(softc->saved_comp_algorithm,
4266 				    dcp->decomp_algorithm);
4267 			}
4268 			break;
4269 		}
4270 		/*
4271 		 * Compression does not appear to be supported-
4272 		 * at least via the DATA COMPRESSION page. It
4273 		 * would be too much to ask us to believe that
4274 		 * the page itself is supported, but incorrectly
4275 		 * reports an ability to manipulate data compression,
4276 		 * so we'll assume that this device doesn't support
4277 		 * compression. We can just fall through for that.
4278 		 */
4279 		/* FALLTHROUGH */
4280 		default:
4281 			/*
4282 			 * The drive doesn't seem to support compression,
4283 			 * so turn off the set compression bit.
4284 			 */
4285 			params_to_set &= ~SA_PARAM_COMPRESSION;
4286 			xpt_print(periph->path,
4287 			    "device does not seem to support compression\n");
4288 
4289 			/*
4290 			 * If that was the only thing the user wanted us to set,
4291 			 * clean up allocated resources and return with
4292 			 * 'operation not supported'.
4293 			 */
4294 			if (params_to_set == SA_PARAM_NONE) {
4295 				free(mode_buffer, M_SCSISA);
4296 				xpt_release_ccb(ccb);
4297 				return (ENODEV);
4298 			}
4299 
4300 			/*
4301 			 * That wasn't the only thing the user wanted us to set.
4302 			 * So, decrease the stated mode buffer length by the
4303 			 * size of the compression mode page.
4304 			 */
4305 			mode_buffer_len -= sizeof(sa_comp_t);
4306 		}
4307 	}
4308 
4309 	/* It is safe to retry this operation */
4310 	scsi_mode_select(&ccb->csio, 5, NULL, MSG_SIMPLE_Q_TAG,
4311 	    (params_to_set & SA_PARAM_COMPRESSION)? TRUE : FALSE,
4312 	    FALSE, mode_buffer, mode_buffer_len, SSD_FULL_SIZE, SCSIOP_TIMEOUT);
4313 
4314 	error = cam_periph_runccb(ccb, saerror, 0,
4315 	    sense_flags, softc->device_stats);
4316 
4317 	if (CAM_DEBUGGED(periph->path, CAM_DEBUG_INFO)) {
4318 		int idx;
4319 		char *xyz = mode_buffer;
4320 		xpt_print_path(periph->path);
4321 		printf("Err%d, Mode Select Data=", error);
4322 		for (idx = 0; idx < mode_buffer_len; idx++)
4323 			printf(" 0x%02x", xyz[idx] & 0xff);
4324 		printf("\n");
4325 	}
4326 
4327 
4328 	if (error) {
4329 		/*
4330 		 * If we can, try without setting density/blocksize.
4331 		 */
4332 		if (mode_blk) {
4333 			if ((params_to_set &
4334 			    (SA_PARAM_DENSITY|SA_PARAM_BLOCKSIZE)) == 0) {
4335 				mode_blk = NULL;
4336 				goto retry;
4337 			}
4338 		} else {
4339 			mode_blk = (struct scsi_mode_blk_desc *)&mode_hdr[1];
4340 			cpage = (sa_comp_t *)&mode_blk[1];
4341 		}
4342 
4343 		/*
4344 		 * If we were setting the blocksize, and that failed, we
4345 		 * want to set it to its original value.  If we weren't
4346 		 * setting the blocksize, we don't want to change it.
4347 		 */
4348 		scsi_ulto3b(current_blocksize, mode_blk->blklen);
4349 
4350 		/*
4351 		 * Set density if requested, else preserve old density.
4352 		 * SCSI_SAME_DENSITY only applies to SCSI-2 or better
4353 		 * devices, else density we've latched up in our softc.
4354 		 */
4355 		if (params_to_set & SA_PARAM_DENSITY) {
4356 			mode_blk->density = current_density;
4357 		} else if (softc->scsi_rev > SCSI_REV_CCS) {
4358 			mode_blk->density = SCSI_SAME_DENSITY;
4359 		} else {
4360 			mode_blk->density = softc->media_density;
4361 		}
4362 
4363 		if (params_to_set & SA_PARAM_COMPRESSION)
4364 			bcopy(ccomp, cpage, sizeof (sa_comp_t));
4365 
4366 		/*
4367 		 * The retry count is the only CCB field that might have been
4368 		 * changed that we care about, so reset it back to 1.
4369 		 */
4370 		ccb->ccb_h.retry_count = 1;
4371 		cam_periph_runccb(ccb, saerror, 0, sense_flags,
4372 		    softc->device_stats);
4373 	}
4374 
4375 	xpt_release_ccb(ccb);
4376 
4377 	if (ccomp != NULL)
4378 		free(ccomp, M_SCSISA);
4379 
4380 	if (params_to_set & SA_PARAM_COMPRESSION) {
4381 		if (error) {
4382 			softc->flags &= ~SA_FLAG_COMP_ENABLED;
4383 			/*
4384 			 * Even if we get an error setting compression,
4385 			 * do not say that we don't support it. We could
4386 			 * have been wrong, or it may be media specific.
4387 			 *	softc->flags &= ~SA_FLAG_COMP_SUPP;
4388 			 */
4389 			softc->saved_comp_algorithm = softc->comp_algorithm;
4390 			softc->comp_algorithm = 0;
4391 		} else {
4392 			softc->flags |= SA_FLAG_COMP_ENABLED;
4393 			softc->comp_algorithm = calg;
4394 		}
4395 	}
4396 
4397 	free(mode_buffer, M_SCSISA);
4398 	return (error);
4399 }
4400 
4401 static int
4402 saextget(struct cdev *dev, struct cam_periph *periph, struct sbuf *sb,
4403     struct mtextget *g)
4404 {
4405 	int indent, error;
4406 	char tmpstr[80];
4407 	struct sa_softc *softc;
4408 	int tmpint;
4409 	uint32_t maxio_tmp;
4410 	struct ccb_getdev cgd;
4411 
4412 	softc = (struct sa_softc *)periph->softc;
4413 
4414 	error = 0;
4415 
4416 	error = sagetparams_common(dev, periph);
4417 	if (error)
4418 		goto extget_bailout;
4419 	if (!SA_IS_CTRL(dev) && !softc->open_pending_mount)
4420 		sagetpos(periph);
4421 
4422 	indent = 0;
4423 	SASBADDNODE(sb, indent, mtextget);
4424 	/*
4425 	 * Basic CAM peripheral information.
4426 	 */
4427 	SASBADDVARSTR(sb, indent, periph->periph_name, %s, periph_name,
4428 	    strlen(periph->periph_name) + 1);
4429 	SASBADDUINT(sb, indent, periph->unit_number, %u, unit_number);
4430 	xpt_setup_ccb(&cgd.ccb_h,
4431 		      periph->path,
4432 		      CAM_PRIORITY_NORMAL);
4433 	cgd.ccb_h.func_code = XPT_GDEV_TYPE;
4434 	xpt_action((union ccb *)&cgd);
4435 	if ((cgd.ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
4436 		g->status = MT_EXT_GET_ERROR;
4437 		snprintf(g->error_str, sizeof(g->error_str),
4438 		    "Error %#x returned for XPT_GDEV_TYPE CCB",
4439 		    cgd.ccb_h.status);
4440 		goto extget_bailout;
4441 	}
4442 
4443 	cam_strvis(tmpstr, cgd.inq_data.vendor,
4444 	    sizeof(cgd.inq_data.vendor), sizeof(tmpstr));
4445 	SASBADDVARSTRDESC(sb, indent, tmpstr, %s, vendor,
4446 	    sizeof(cgd.inq_data.vendor) + 1, "SCSI Vendor ID");
4447 
4448 	cam_strvis(tmpstr, cgd.inq_data.product,
4449 	    sizeof(cgd.inq_data.product), sizeof(tmpstr));
4450 	SASBADDVARSTRDESC(sb, indent, tmpstr, %s, product,
4451 	    sizeof(cgd.inq_data.product) + 1, "SCSI Product ID");
4452 
4453 	cam_strvis(tmpstr, cgd.inq_data.revision,
4454 	    sizeof(cgd.inq_data.revision), sizeof(tmpstr));
4455 	SASBADDVARSTRDESC(sb, indent, tmpstr, %s, revision,
4456 	    sizeof(cgd.inq_data.revision) + 1, "SCSI Revision");
4457 
4458 	if (cgd.serial_num_len > 0) {
4459 		char *tmpstr2;
4460 		size_t ts2_len;
4461 		int ts2_malloc;
4462 
4463 		ts2_len = 0;
4464 
4465 		if (cgd.serial_num_len > sizeof(tmpstr)) {
4466 			ts2_len = cgd.serial_num_len + 1;
4467 			ts2_malloc = 1;
4468 			tmpstr2 = malloc(ts2_len, M_SCSISA, M_NOWAIT | M_ZERO);
4469 			/*
4470 			 * The 80 characters allocated on the stack above
4471 			 * will handle the vast majority of serial numbers.
4472 			 * If we run into one that is larger than that, and
4473 			 * we can't malloc the length without blocking,
4474 			 * bail out with an out of memory error.
4475 			 */
4476 			if (tmpstr2 == NULL) {
4477 				error = ENOMEM;
4478 				goto extget_bailout;
4479 			}
4480 		} else {
4481 			ts2_len = sizeof(tmpstr);
4482 			ts2_malloc = 0;
4483 			tmpstr2 = tmpstr;
4484 		}
4485 
4486 		cam_strvis(tmpstr2, cgd.serial_num, cgd.serial_num_len,
4487 		    ts2_len);
4488 
4489 		SASBADDVARSTRDESC(sb, indent, tmpstr2, %s, serial_num,
4490 		    (ssize_t)cgd.serial_num_len + 1, "Serial Number");
4491 		if (ts2_malloc != 0)
4492 			free(tmpstr2, M_SCSISA);
4493 	} else {
4494 		/*
4495 		 * We return a serial_num element in any case, but it will
4496 		 * be empty if the device has no serial number.
4497 		 */
4498 		tmpstr[0] = '\0';
4499 		SASBADDVARSTRDESC(sb, indent, tmpstr, %s, serial_num,
4500 		    (ssize_t)0, "Serial Number");
4501 	}
4502 
4503 	SASBADDUINTDESC(sb, indent, softc->maxio, %u, maxio,
4504 	    "Maximum I/O size allowed by driver and controller");
4505 
4506 	SASBADDUINTDESC(sb, indent, softc->cpi_maxio, %u, cpi_maxio,
4507 	    "Maximum I/O size reported by controller");
4508 
4509 	SASBADDUINTDESC(sb, indent, softc->max_blk, %u, max_blk,
4510 	    "Maximum block size supported by tape drive and media");
4511 
4512 	SASBADDUINTDESC(sb, indent, softc->min_blk, %u, min_blk,
4513 	    "Minimum block size supported by tape drive and media");
4514 
4515 	SASBADDUINTDESC(sb, indent, softc->blk_gran, %u, blk_gran,
4516 	    "Block granularity supported by tape drive and media");
4517 
4518 	maxio_tmp = min(softc->max_blk, softc->maxio);
4519 
4520 	SASBADDUINTDESC(sb, indent, maxio_tmp, %u, max_effective_iosize,
4521 	    "Maximum possible I/O size");
4522 
4523 	SASBADDINTDESC(sb, indent, softc->flags & SA_FLAG_FIXED ? 1 : 0, %d,
4524 	    fixed_mode, "Set to 1 for fixed block mode, 0 for variable block");
4525 
4526 	/*
4527 	 * XXX KDM include SIM, bus, target, LUN?
4528 	 */
4529 	if (softc->flags & SA_FLAG_COMP_UNSUPP)
4530 		tmpint = 0;
4531 	else
4532 		tmpint = 1;
4533 	SASBADDINTDESC(sb, indent, tmpint, %d, compression_supported,
4534 	    "Set to 1 if compression is supported, 0 if not");
4535 	if (softc->flags & SA_FLAG_COMP_ENABLED)
4536 		tmpint = 1;
4537 	else
4538 		tmpint = 0;
4539 	SASBADDINTDESC(sb, indent, tmpint, %d, compression_enabled,
4540 	    "Set to 1 if compression is enabled, 0 if not");
4541 	SASBADDUINTDESC(sb, indent, softc->comp_algorithm, %u,
4542 	    compression_algorithm, "Numeric compression algorithm");
4543 
4544 	safillprot(softc, &indent, sb);
4545 
4546 	SASBADDUINTDESC(sb, indent, softc->media_blksize, %u,
4547 	    media_blocksize, "Block size reported by drive or set by user");
4548 	SASBADDINTDESC(sb, indent, (intmax_t)softc->fileno, %jd,
4549 	    calculated_fileno, "Calculated file number, -1 if unknown");
4550 	SASBADDINTDESC(sb, indent, (intmax_t)softc->blkno, %jd,
4551 	    calculated_rel_blkno, "Calculated block number relative to file, "
4552 	    "set to -1 if unknown");
4553 	SASBADDINTDESC(sb, indent, (intmax_t)softc->rep_fileno, %jd,
4554 	    reported_fileno, "File number reported by drive, -1 if unknown");
4555 	SASBADDINTDESC(sb, indent, (intmax_t)softc->rep_blkno, %jd,
4556 	    reported_blkno, "Block number relative to BOP/BOT reported by "
4557 	    "drive, -1 if unknown");
4558 	SASBADDINTDESC(sb, indent, (intmax_t)softc->partition, %jd,
4559 	    partition, "Current partition number, 0 is the default");
4560 	SASBADDINTDESC(sb, indent, softc->bop, %d, bop,
4561 	    "Set to 1 if drive is at the beginning of partition/tape, 0 if "
4562 	    "not, -1 if unknown");
4563 	SASBADDINTDESC(sb, indent, softc->eop, %d, eop,
4564 	    "Set to 1 if drive is past early warning, 0 if not, -1 if unknown");
4565 	SASBADDINTDESC(sb, indent, softc->bpew, %d, bpew,
4566 	    "Set to 1 if drive is past programmable early warning, 0 if not, "
4567 	    "-1 if unknown");
4568 	SASBADDINTDESC(sb, indent, (intmax_t)softc->last_io_resid, %jd,
4569 	    residual, "Residual for the last I/O");
4570 	/*
4571 	 * XXX KDM should we send a string with the current driver
4572 	 * status already decoded instead of a numeric value?
4573 	 */
4574 	SASBADDINTDESC(sb, indent, softc->dsreg, %d, dsreg,
4575 	    "Current state of the driver");
4576 
4577 	safilldensitysb(softc, &indent, sb);
4578 
4579 	SASBENDNODE(sb, indent, mtextget);
4580 
4581 extget_bailout:
4582 
4583 	return (error);
4584 }
4585 
4586 static int
4587 saparamget(struct sa_softc *softc, struct sbuf *sb)
4588 {
4589 	int indent;
4590 
4591 	indent = 0;
4592 	SASBADDNODE(sb, indent, mtparamget);
4593 	SASBADDINTDESC(sb, indent, softc->sili, %d, sili,
4594 	    "Suppress an error on underlength variable reads");
4595 	SASBADDINTDESC(sb, indent, softc->eot_warn, %d, eot_warn,
4596 	    "Return an error to warn that end of tape is approaching");
4597 	safillprot(softc, &indent, sb);
4598 	SASBENDNODE(sb, indent, mtparamget);
4599 
4600 	return (0);
4601 }
4602 
4603 static void
4604 saprevent(struct cam_periph *periph, int action)
4605 {
4606 	struct	sa_softc *softc;
4607 	union	ccb *ccb;
4608 	int	error, sf;
4609 
4610 	softc = (struct sa_softc *)periph->softc;
4611 
4612 	if ((action == PR_ALLOW) && (softc->flags & SA_FLAG_TAPE_LOCKED) == 0)
4613 		return;
4614 	if ((action == PR_PREVENT) && (softc->flags & SA_FLAG_TAPE_LOCKED) != 0)
4615 		return;
4616 
4617 	/*
4618 	 * We can be quiet about illegal requests.
4619 	 */
4620 	if (CAM_DEBUGGED(periph->path, CAM_DEBUG_INFO)) {
4621 		sf = 0;
4622 	} else
4623 		sf = SF_QUIET_IR;
4624 
4625 	ccb = cam_periph_getccb(periph, 1);
4626 
4627 	/* It is safe to retry this operation */
4628 	scsi_prevent(&ccb->csio, 5, NULL, MSG_SIMPLE_Q_TAG, action,
4629 	    SSD_FULL_SIZE, SCSIOP_TIMEOUT);
4630 
4631 	error = cam_periph_runccb(ccb, saerror, 0, sf, softc->device_stats);
4632 	if (error == 0) {
4633 		if (action == PR_ALLOW)
4634 			softc->flags &= ~SA_FLAG_TAPE_LOCKED;
4635 		else
4636 			softc->flags |= SA_FLAG_TAPE_LOCKED;
4637 	}
4638 
4639 	xpt_release_ccb(ccb);
4640 }
4641 
4642 static int
4643 sarewind(struct cam_periph *periph)
4644 {
4645 	union	ccb *ccb;
4646 	struct	sa_softc *softc;
4647 	int	error;
4648 
4649 	softc = (struct sa_softc *)periph->softc;
4650 
4651 	ccb = cam_periph_getccb(periph, 1);
4652 
4653 	/* It is safe to retry this operation */
4654 	scsi_rewind(&ccb->csio, 2, NULL, MSG_SIMPLE_Q_TAG, FALSE,
4655 	    SSD_FULL_SIZE, REWIND_TIMEOUT);
4656 
4657 	softc->dsreg = MTIO_DSREG_REW;
4658 	error = cam_periph_runccb(ccb, saerror, 0, 0, softc->device_stats);
4659 	softc->dsreg = MTIO_DSREG_REST;
4660 
4661 	xpt_release_ccb(ccb);
4662 	if (error == 0) {
4663 		softc->partition = softc->fileno = softc->blkno = (daddr_t) 0;
4664 		softc->rep_fileno = softc->rep_blkno = (daddr_t) 0;
4665 	} else {
4666 		softc->fileno = softc->blkno = (daddr_t) -1;
4667 		softc->partition = (daddr_t) -1;
4668 		softc->rep_fileno = softc->rep_blkno = (daddr_t) -1;
4669 	}
4670 	return (error);
4671 }
4672 
4673 static int
4674 saspace(struct cam_periph *periph, int count, scsi_space_code code)
4675 {
4676 	union	ccb *ccb;
4677 	struct	sa_softc *softc;
4678 	int	error;
4679 
4680 	softc = (struct sa_softc *)periph->softc;
4681 
4682 	ccb = cam_periph_getccb(periph, 1);
4683 
4684 	/* This cannot be retried */
4685 
4686 	scsi_space(&ccb->csio, 0, NULL, MSG_SIMPLE_Q_TAG, code, count,
4687 	    SSD_FULL_SIZE, SPACE_TIMEOUT);
4688 
4689 	/*
4690 	 * Clear residual because we will be using it.
4691 	 */
4692 	softc->last_ctl_resid = 0;
4693 
4694 	softc->dsreg = (count < 0)? MTIO_DSREG_REV : MTIO_DSREG_FWD;
4695 	error = cam_periph_runccb(ccb, saerror, 0, 0, softc->device_stats);
4696 	softc->dsreg = MTIO_DSREG_REST;
4697 
4698 	xpt_release_ccb(ccb);
4699 
4700 	/*
4701 	 * If a spacing operation has failed, we need to invalidate
4702 	 * this mount.
4703 	 *
4704 	 * If the spacing operation was setmarks or to end of recorded data,
4705 	 * we no longer know our relative position.
4706 	 *
4707 	 * If the spacing operations was spacing files in reverse, we
4708 	 * take account of the residual, but still check against less
4709 	 * than zero- if we've gone negative, we must have hit BOT.
4710 	 *
4711 	 * If the spacing operations was spacing records in reverse and
4712 	 * we have a residual, we've either hit BOT or hit a filemark.
4713 	 * In the former case, we know our new record number (0). In
4714 	 * the latter case, we have absolutely no idea what the real
4715 	 * record number is- we've stopped between the end of the last
4716 	 * record in the previous file and the filemark that stopped
4717 	 * our spacing backwards.
4718 	 */
4719 	if (error) {
4720 		softc->fileno = softc->blkno = (daddr_t) -1;
4721 		softc->rep_blkno = softc->partition = (daddr_t) -1;
4722 		softc->rep_fileno = (daddr_t) -1;
4723 	} else if (code == SS_SETMARKS || code == SS_EOD) {
4724 		softc->fileno = softc->blkno = (daddr_t) -1;
4725 	} else if (code == SS_FILEMARKS && softc->fileno != (daddr_t) -1) {
4726 		softc->fileno += (count - softc->last_ctl_resid);
4727 		if (softc->fileno < 0)	/* we must of hit BOT */
4728 			softc->fileno = 0;
4729 		softc->blkno = 0;
4730 	} else if (code == SS_BLOCKS && softc->blkno != (daddr_t) -1) {
4731 		softc->blkno += (count - softc->last_ctl_resid);
4732 		if (count < 0) {
4733 			if (softc->last_ctl_resid || softc->blkno < 0) {
4734 				if (softc->fileno == 0) {
4735 					softc->blkno = 0;
4736 				} else {
4737 					softc->blkno = (daddr_t) -1;
4738 				}
4739 			}
4740 		}
4741 	}
4742 	if (error == 0)
4743 		sagetpos(periph);
4744 
4745 	return (error);
4746 }
4747 
4748 static int
4749 sawritefilemarks(struct cam_periph *periph, int nmarks, int setmarks, int immed)
4750 {
4751 	union	ccb *ccb;
4752 	struct	sa_softc *softc;
4753 	int	error, nwm = 0;
4754 
4755 	softc = (struct sa_softc *)periph->softc;
4756 	if (softc->open_rdonly)
4757 		return (EBADF);
4758 
4759 	ccb = cam_periph_getccb(periph, 1);
4760 	/*
4761 	 * Clear residual because we will be using it.
4762 	 */
4763 	softc->last_ctl_resid = 0;
4764 
4765 	softc->dsreg = MTIO_DSREG_FMK;
4766 	/* this *must* not be retried */
4767 	scsi_write_filemarks(&ccb->csio, 0, NULL, MSG_SIMPLE_Q_TAG,
4768 	    immed, setmarks, nmarks, SSD_FULL_SIZE, IO_TIMEOUT);
4769 	softc->dsreg = MTIO_DSREG_REST;
4770 
4771 
4772 	error = cam_periph_runccb(ccb, saerror, 0, 0, softc->device_stats);
4773 
4774 	if (error == 0 && nmarks) {
4775 		struct sa_softc *softc = (struct sa_softc *)periph->softc;
4776 		nwm = nmarks - softc->last_ctl_resid;
4777 		softc->filemarks += nwm;
4778 	}
4779 
4780 	xpt_release_ccb(ccb);
4781 
4782 	/*
4783 	 * Update relative positions (if we're doing that).
4784 	 */
4785 	if (error) {
4786 		softc->fileno = softc->blkno = softc->partition = (daddr_t) -1;
4787 	} else if (softc->fileno != (daddr_t) -1) {
4788 		softc->fileno += nwm;
4789 		softc->blkno = 0;
4790 	}
4791 
4792 	/*
4793 	 * Ask the tape drive for position information.
4794 	 */
4795 	sagetpos(periph);
4796 
4797 	/*
4798 	 * If we got valid position information, since we just wrote a file
4799 	 * mark, we know we're at the file mark and block 0 after that
4800 	 * filemark.
4801 	 */
4802 	if (softc->rep_fileno != (daddr_t) -1) {
4803 		softc->fileno = softc->rep_fileno;
4804 		softc->blkno = 0;
4805 	}
4806 
4807 	return (error);
4808 }
4809 
4810 static int
4811 sagetpos(struct cam_periph *periph)
4812 {
4813 	union ccb *ccb;
4814 	struct scsi_tape_position_long_data long_pos;
4815 	struct sa_softc *softc = (struct sa_softc *)periph->softc;
4816 	int error;
4817 
4818 	if (softc->quirks & SA_QUIRK_NO_LONG_POS) {
4819 		softc->rep_fileno = (daddr_t) -1;
4820 		softc->rep_blkno = (daddr_t) -1;
4821 		softc->bop = softc->eop = softc->bpew = -1;
4822 		return (EOPNOTSUPP);
4823 	}
4824 
4825 	bzero(&long_pos, sizeof(long_pos));
4826 
4827 	ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
4828 	scsi_read_position_10(&ccb->csio,
4829 			      /*retries*/ 1,
4830 			      /*cbfcnp*/ NULL,
4831 			      /*tag_action*/ MSG_SIMPLE_Q_TAG,
4832 			      /*service_action*/ SA_RPOS_LONG_FORM,
4833 			      /*data_ptr*/ (uint8_t *)&long_pos,
4834 			      /*length*/ sizeof(long_pos),
4835 			      /*sense_len*/ SSD_FULL_SIZE,
4836 			      /*timeout*/ SCSIOP_TIMEOUT);
4837 
4838 	softc->dsreg = MTIO_DSREG_RBSY;
4839 	error = cam_periph_runccb(ccb, saerror, 0, SF_QUIET_IR,
4840 				  softc->device_stats);
4841 	softc->dsreg = MTIO_DSREG_REST;
4842 
4843 	if (error == 0) {
4844 		if (long_pos.flags & SA_RPOS_LONG_MPU) {
4845 			/*
4846 			 * If the drive doesn't know what file mark it is
4847 			 * on, our calculated filemark isn't going to be
4848 			 * accurate either.
4849 			 */
4850 			softc->fileno = (daddr_t) -1;
4851 			softc->rep_fileno = (daddr_t) -1;
4852 		} else {
4853 			softc->fileno = softc->rep_fileno =
4854 			    scsi_8btou64(long_pos.logical_file_num);
4855 		}
4856 
4857 		if (long_pos.flags & SA_RPOS_LONG_LONU) {
4858 			softc->partition = (daddr_t) -1;
4859 			softc->rep_blkno = (daddr_t) -1;
4860 			/*
4861 			 * If the tape drive doesn't know its block
4862 			 * position, we can't claim to know it either.
4863 			 */
4864 			softc->blkno = (daddr_t) -1;
4865 		} else {
4866 			softc->partition = scsi_4btoul(long_pos.partition);
4867 			softc->rep_blkno =
4868 			    scsi_8btou64(long_pos.logical_object_num);
4869 		}
4870 		if (long_pos.flags & SA_RPOS_LONG_BOP)
4871 			softc->bop = 1;
4872 		else
4873 			softc->bop = 0;
4874 
4875 		if (long_pos.flags & SA_RPOS_LONG_EOP)
4876 			softc->eop = 1;
4877 		else
4878 			softc->eop = 0;
4879 
4880 		if ((long_pos.flags & SA_RPOS_LONG_BPEW)
4881 		 || (softc->set_pews_status != 0)) {
4882 			softc->bpew = 1;
4883 			if (softc->set_pews_status > 0)
4884 				softc->set_pews_status--;
4885 		} else
4886 			softc->bpew = 0;
4887 	} else if (error == EINVAL) {
4888 		/*
4889 		 * If this drive returned an invalid-request type error,
4890 		 * then it likely doesn't support the long form report.
4891 		 */
4892 		softc->quirks |= SA_QUIRK_NO_LONG_POS;
4893 	}
4894 
4895 	if (error != 0) {
4896 		softc->rep_fileno = softc->rep_blkno = (daddr_t) -1;
4897 		softc->partition = (daddr_t) -1;
4898 		softc->bop = softc->eop = softc->bpew = -1;
4899 	}
4900 
4901 	xpt_release_ccb(ccb);
4902 
4903 	return (error);
4904 }
4905 
4906 static int
4907 sardpos(struct cam_periph *periph, int hard, u_int32_t *blkptr)
4908 {
4909 	struct scsi_tape_position_data loc;
4910 	union ccb *ccb;
4911 	struct sa_softc *softc = (struct sa_softc *)periph->softc;
4912 	int error;
4913 
4914 	/*
4915 	 * We try and flush any buffered writes here if we were writing
4916 	 * and we're trying to get hardware block position. It eats
4917 	 * up performance substantially, but I'm wary of drive firmware.
4918 	 *
4919 	 * I think that *logical* block position is probably okay-
4920 	 * but hardware block position might have to wait for data
4921 	 * to hit media to be valid. Caveat Emptor.
4922 	 */
4923 
4924 	if (hard && (softc->flags & SA_FLAG_TAPE_WRITTEN)) {
4925 		error = sawritefilemarks(periph, 0, 0, 0);
4926 		if (error && error != EACCES)
4927 			return (error);
4928 	}
4929 
4930 	ccb = cam_periph_getccb(periph, 1);
4931 	scsi_read_position(&ccb->csio, 1, NULL, MSG_SIMPLE_Q_TAG,
4932 	    hard, &loc, SSD_FULL_SIZE, SCSIOP_TIMEOUT);
4933 	softc->dsreg = MTIO_DSREG_RBSY;
4934 	error = cam_periph_runccb(ccb, saerror, 0, 0, softc->device_stats);
4935 	softc->dsreg = MTIO_DSREG_REST;
4936 
4937 	if (error == 0) {
4938 		if (loc.flags & SA_RPOS_UNCERTAIN) {
4939 			error = EINVAL;		/* nothing is certain */
4940 		} else {
4941 			*blkptr = scsi_4btoul(loc.firstblk);
4942 		}
4943 	}
4944 
4945 	xpt_release_ccb(ccb);
4946 	return (error);
4947 }
4948 
4949 static int
4950 sasetpos(struct cam_periph *periph, int hard, struct mtlocate *locate_info)
4951 {
4952 	union ccb *ccb;
4953 	struct sa_softc *softc;
4954 	int locate16;
4955 	int immed, cp;
4956 	int error;
4957 
4958 	/*
4959 	 * We used to try and flush any buffered writes here.
4960 	 * Now we push this onto user applications to either
4961 	 * flush the pending writes themselves (via a zero count
4962 	 * WRITE FILEMARKS command) or they can trust their tape
4963 	 * drive to do this correctly for them.
4964  	 */
4965 
4966 	softc = (struct sa_softc *)periph->softc;
4967 	ccb = cam_periph_getccb(periph, 1);
4968 
4969 	cp = locate_info->flags & MT_LOCATE_FLAG_CHANGE_PART ? 1 : 0;
4970 	immed = locate_info->flags & MT_LOCATE_FLAG_IMMED ? 1 : 0;
4971 
4972 	/*
4973 	 * Determine whether we have to use LOCATE or LOCATE16.  The hard
4974 	 * bit is only possible with LOCATE, but the new ioctls do not
4975 	 * allow setting that bit.  So we can't get into the situation of
4976 	 * having the hard bit set with a block address that is larger than
4977 	 * 32-bits.
4978 	 */
4979 	if (hard != 0)
4980 		locate16 = 0;
4981 	else if ((locate_info->dest_type != MT_LOCATE_DEST_OBJECT)
4982 	      || (locate_info->block_address_mode != MT_LOCATE_BAM_IMPLICIT)
4983 	      || (locate_info->logical_id > SA_SPOS_MAX_BLK))
4984 		locate16 = 1;
4985 	else
4986 		locate16 = 0;
4987 
4988 	if (locate16 != 0) {
4989 		scsi_locate_16(&ccb->csio,
4990 			       /*retries*/ 1,
4991 			       /*cbfcnp*/ NULL,
4992 			       /*tag_action*/ MSG_SIMPLE_Q_TAG,
4993 			       /*immed*/ immed,
4994 			       /*cp*/ cp,
4995 			       /*dest_type*/ locate_info->dest_type,
4996 			       /*bam*/ locate_info->block_address_mode,
4997 			       /*partition*/ locate_info->partition,
4998 			       /*logical_id*/ locate_info->logical_id,
4999 			       /*sense_len*/ SSD_FULL_SIZE,
5000 			       /*timeout*/ SPACE_TIMEOUT);
5001 	} else {
5002 		scsi_locate_10(&ccb->csio,
5003 			       /*retries*/ 1,
5004 			       /*cbfcnp*/ NULL,
5005 			       /*tag_action*/ MSG_SIMPLE_Q_TAG,
5006 			       /*immed*/ immed,
5007 			       /*cp*/ cp,
5008 			       /*hard*/ hard,
5009 			       /*partition*/ locate_info->partition,
5010 			       /*block_address*/ locate_info->logical_id,
5011 			       /*sense_len*/ SSD_FULL_SIZE,
5012 			       /*timeout*/ SPACE_TIMEOUT);
5013 	}
5014 
5015 	softc->dsreg = MTIO_DSREG_POS;
5016 	error = cam_periph_runccb(ccb, saerror, 0, 0, softc->device_stats);
5017 	softc->dsreg = MTIO_DSREG_REST;
5018 	xpt_release_ccb(ccb);
5019 
5020 	/*
5021 	 * We assume the calculated file and block numbers are unknown
5022 	 * unless we have enough information to populate them.
5023 	 */
5024 	softc->fileno = softc->blkno = (daddr_t) -1;
5025 
5026 	/*
5027 	 * If the user requested changing the partition and the request
5028 	 * succeeded, note the partition.
5029 	 */
5030 	if ((error == 0)
5031 	 && (cp != 0))
5032 		softc->partition = locate_info->partition;
5033 	else
5034 		softc->partition = (daddr_t) -1;
5035 
5036 	if (error == 0) {
5037 		switch (locate_info->dest_type) {
5038 		case MT_LOCATE_DEST_FILE:
5039 			/*
5040 			 * This is the only case where we can reliably
5041 			 * calculate the file and block numbers.
5042 			 */
5043 			softc->fileno = locate_info->logical_id;
5044 			softc->blkno = 0;
5045 			break;
5046 		case MT_LOCATE_DEST_OBJECT:
5047 		case MT_LOCATE_DEST_SET:
5048 		case MT_LOCATE_DEST_EOD:
5049 		default:
5050 			break;
5051 		}
5052 	}
5053 
5054 	/*
5055 	 * Ask the drive for current position information.
5056 	 */
5057 	sagetpos(periph);
5058 
5059 	return (error);
5060 }
5061 
5062 static int
5063 saretension(struct cam_periph *periph)
5064 {
5065 	union ccb *ccb;
5066 	struct sa_softc *softc;
5067 	int error;
5068 
5069 	softc = (struct sa_softc *)periph->softc;
5070 
5071 	ccb = cam_periph_getccb(periph, 1);
5072 
5073 	/* It is safe to retry this operation */
5074 	scsi_load_unload(&ccb->csio, 5, NULL, MSG_SIMPLE_Q_TAG, FALSE,
5075 	    FALSE, TRUE,  TRUE, SSD_FULL_SIZE, ERASE_TIMEOUT);
5076 
5077 	softc->dsreg = MTIO_DSREG_TEN;
5078 	error = cam_periph_runccb(ccb, saerror, 0, 0, softc->device_stats);
5079 	softc->dsreg = MTIO_DSREG_REST;
5080 
5081 	xpt_release_ccb(ccb);
5082 	if (error == 0) {
5083 		softc->partition = softc->fileno = softc->blkno = (daddr_t) 0;
5084 		sagetpos(periph);
5085 	} else
5086 		softc->partition = softc->fileno = softc->blkno = (daddr_t) -1;
5087 	return (error);
5088 }
5089 
5090 static int
5091 sareservereleaseunit(struct cam_periph *periph, int reserve)
5092 {
5093 	union ccb *ccb;
5094 	struct sa_softc *softc;
5095 	int error;
5096 
5097 	softc = (struct sa_softc *)periph->softc;
5098 	ccb = cam_periph_getccb(periph,  1);
5099 
5100 	/* It is safe to retry this operation */
5101 	scsi_reserve_release_unit(&ccb->csio, 2, NULL, MSG_SIMPLE_Q_TAG,
5102 	    FALSE,  0, SSD_FULL_SIZE,  SCSIOP_TIMEOUT, reserve);
5103 	softc->dsreg = MTIO_DSREG_RBSY;
5104 	error = cam_periph_runccb(ccb, saerror, 0,
5105 	    SF_RETRY_UA | SF_NO_PRINT, softc->device_stats);
5106 	softc->dsreg = MTIO_DSREG_REST;
5107 	xpt_release_ccb(ccb);
5108 
5109 	/*
5110 	 * If the error was Illegal Request, then the device doesn't support
5111 	 * RESERVE/RELEASE. This is not an error.
5112 	 */
5113 	if (error == EINVAL) {
5114 		error = 0;
5115 	}
5116 
5117 	return (error);
5118 }
5119 
5120 static int
5121 saloadunload(struct cam_periph *periph, int load)
5122 {
5123 	union	ccb *ccb;
5124 	struct	sa_softc *softc;
5125 	int	error;
5126 
5127 	softc = (struct sa_softc *)periph->softc;
5128 
5129 	ccb = cam_periph_getccb(periph, 1);
5130 
5131 	/* It is safe to retry this operation */
5132 	scsi_load_unload(&ccb->csio, 5, NULL, MSG_SIMPLE_Q_TAG, FALSE,
5133 	    FALSE, FALSE, load, SSD_FULL_SIZE, REWIND_TIMEOUT);
5134 
5135 	softc->dsreg = (load)? MTIO_DSREG_LD : MTIO_DSREG_UNL;
5136 	error = cam_periph_runccb(ccb, saerror, 0, 0, softc->device_stats);
5137 	softc->dsreg = MTIO_DSREG_REST;
5138 	xpt_release_ccb(ccb);
5139 
5140 	if (error || load == 0) {
5141 		softc->partition = softc->fileno = softc->blkno = (daddr_t) -1;
5142 		softc->rep_fileno = softc->rep_blkno = (daddr_t) -1;
5143 	} else if (error == 0) {
5144 		softc->partition = softc->fileno = softc->blkno = (daddr_t) 0;
5145 		sagetpos(periph);
5146 	}
5147 	return (error);
5148 }
5149 
5150 static int
5151 saerase(struct cam_periph *periph, int longerase)
5152 {
5153 
5154 	union	ccb *ccb;
5155 	struct	sa_softc *softc;
5156 	int error;
5157 
5158 	softc = (struct sa_softc *)periph->softc;
5159 	if (softc->open_rdonly)
5160 		return (EBADF);
5161 
5162 	ccb = cam_periph_getccb(periph, 1);
5163 
5164 	scsi_erase(&ccb->csio, 1, NULL, MSG_SIMPLE_Q_TAG, FALSE, longerase,
5165 	    SSD_FULL_SIZE, ERASE_TIMEOUT);
5166 
5167 	softc->dsreg = MTIO_DSREG_ZER;
5168 	error = cam_periph_runccb(ccb, saerror, 0, 0, softc->device_stats);
5169 	softc->dsreg = MTIO_DSREG_REST;
5170 
5171 	xpt_release_ccb(ccb);
5172 	return (error);
5173 }
5174 
5175 /*
5176  * Fill an sbuf with density data in XML format.  This particular macro
5177  * works for multi-byte integer fields.
5178  *
5179  * Note that 1 byte fields aren't supported here.  The reason is that the
5180  * compiler does not evaluate the sizeof(), and assumes that any of the
5181  * sizes are possible for a given field.  So passing in a multi-byte
5182  * field will result in a warning that the assignment makes an integer
5183  * from a pointer without a cast, if there is an assignment in the 1 byte
5184  * case.
5185  */
5186 #define	SAFILLDENSSB(dens_data, sb, indent, field, desc_remain, 	\
5187 		     len_to_go, cur_offset, desc){			\
5188 	size_t cur_field_len;						\
5189 									\
5190 	cur_field_len = sizeof(dens_data->field);			\
5191 	if (desc_remain < cur_field_len) {				\
5192 		len_to_go -= desc_remain;				\
5193 		cur_offset += desc_remain;				\
5194 		continue;						\
5195 	}								\
5196 	len_to_go -= cur_field_len;					\
5197 	cur_offset += cur_field_len;					\
5198 	desc_remain -= cur_field_len;					\
5199 									\
5200 	switch (sizeof(dens_data->field)) {				\
5201 	case 1:								\
5202 		KASSERT(1 == 0, ("Programmer error, invalid 1 byte "	\
5203 			"field width for SAFILLDENSFIELD"));		\
5204 		break;							\
5205 	case 2:								\
5206 		SASBADDUINTDESC(sb, indent,				\
5207 		    scsi_2btoul(dens_data->field), %u, field, desc);	\
5208 		break;							\
5209 	case 3:								\
5210 		SASBADDUINTDESC(sb, indent,				\
5211 		    scsi_3btoul(dens_data->field), %u, field, desc);	\
5212 		break;							\
5213 	case 4:								\
5214 		SASBADDUINTDESC(sb, indent,				\
5215 		    scsi_4btoul(dens_data->field), %u, field, desc);	\
5216 		break;							\
5217 	case 8:								\
5218 		SASBADDUINTDESC(sb, indent, 				\
5219 		    (uintmax_t)scsi_8btou64(dens_data->field),	%ju, 	\
5220 		    field, desc);					\
5221 		break;							\
5222 	default:							\
5223 		break;							\
5224 	}								\
5225 };
5226 /*
5227  * Fill an sbuf with density data in XML format.  This particular macro
5228  * works for strings.
5229  */
5230 #define	SAFILLDENSSBSTR(dens_data, sb, indent, field, desc_remain, 	\
5231 			len_to_go, cur_offset, desc){			\
5232 	size_t cur_field_len;						\
5233 	char tmpstr[32];						\
5234 									\
5235 	cur_field_len = sizeof(dens_data->field);			\
5236 	if (desc_remain < cur_field_len) {				\
5237 		len_to_go -= desc_remain;				\
5238 		cur_offset += desc_remain;				\
5239 		continue;						\
5240 	}								\
5241 	len_to_go -= cur_field_len;					\
5242 	cur_offset += cur_field_len;					\
5243 	desc_remain -= cur_field_len;					\
5244 									\
5245 	cam_strvis(tmpstr, dens_data->field,				\
5246 	    sizeof(dens_data->field), sizeof(tmpstr));			\
5247 	SASBADDVARSTRDESC(sb, indent, tmpstr, %s, field,		\
5248 	    strlen(tmpstr) + 1, desc);					\
5249 };
5250 
5251 /*
5252  * Fill an sbuf with density data descriptors.
5253  */
5254 static void
5255 safilldenstypesb(struct sbuf *sb, int *indent, uint8_t *buf, int buf_len,
5256     int is_density)
5257 {
5258 	struct scsi_density_hdr *hdr;
5259 	uint32_t hdr_len;
5260 	int len_to_go, cur_offset;
5261 	int length_offset;
5262 	int num_reports, need_close;
5263 
5264 	/*
5265 	 * We need at least the header length.  Note that this isn't an
5266 	 * error, not all tape drives will have every data type.
5267 	 */
5268 	if (buf_len < sizeof(*hdr))
5269 		goto bailout;
5270 
5271 
5272 	hdr = (struct scsi_density_hdr *)buf;
5273 	hdr_len = scsi_2btoul(hdr->length);
5274 	len_to_go = min(buf_len - sizeof(*hdr), hdr_len);
5275 	if (is_density) {
5276 		length_offset = __offsetof(struct scsi_density_data,
5277 		    bits_per_mm);
5278 	} else {
5279 		length_offset = __offsetof(struct scsi_medium_type_data,
5280 		    num_density_codes);
5281 	}
5282 	cur_offset = sizeof(*hdr);
5283 
5284 	num_reports = 0;
5285 	need_close = 0;
5286 
5287 	while (len_to_go > length_offset) {
5288 		struct scsi_density_data *dens_data;
5289 		struct scsi_medium_type_data *type_data;
5290 		int desc_remain;
5291 		size_t cur_field_len;
5292 
5293 		dens_data = NULL;
5294 		type_data = NULL;
5295 
5296 		if (is_density) {
5297 			dens_data =(struct scsi_density_data *)&buf[cur_offset];
5298 			if (dens_data->byte2 & SDD_DLV)
5299 				desc_remain = scsi_2btoul(dens_data->length);
5300 			else
5301 				desc_remain = SDD_DEFAULT_LENGTH -
5302 				    length_offset;
5303 		} else {
5304 			type_data = (struct scsi_medium_type_data *)
5305 			    &buf[cur_offset];
5306 			desc_remain = scsi_2btoul(type_data->length);
5307 		}
5308 
5309 		len_to_go -= length_offset;
5310 		desc_remain = min(desc_remain, len_to_go);
5311 		cur_offset += length_offset;
5312 
5313 		if (need_close != 0) {
5314 			SASBENDNODE(sb, *indent, density_entry);
5315 		}
5316 
5317 		SASBADDNODENUM(sb, *indent, density_entry, num_reports);
5318 		num_reports++;
5319 		need_close = 1;
5320 
5321 		if (is_density) {
5322 			SASBADDUINTDESC(sb, *indent,
5323 			    dens_data->primary_density_code, %u,
5324 			    primary_density_code, "Primary Density Code");
5325 			SASBADDUINTDESC(sb, *indent,
5326 			    dens_data->secondary_density_code, %u,
5327 			    secondary_density_code, "Secondary Density Code");
5328 			SASBADDUINTDESC(sb, *indent,
5329 			    dens_data->byte2 & ~SDD_DLV, %#x, density_flags,
5330 			    "Density Flags");
5331 
5332 			SAFILLDENSSB(dens_data, sb, *indent, bits_per_mm,
5333 			    desc_remain, len_to_go, cur_offset, "Bits per mm");
5334 			SAFILLDENSSB(dens_data, sb, *indent, media_width,
5335 			    desc_remain, len_to_go, cur_offset, "Media width");
5336 			SAFILLDENSSB(dens_data, sb, *indent, tracks,
5337 			    desc_remain, len_to_go, cur_offset,
5338 			    "Number of Tracks");
5339 			SAFILLDENSSB(dens_data, sb, *indent, capacity,
5340 			    desc_remain, len_to_go, cur_offset, "Capacity");
5341 
5342 			SAFILLDENSSBSTR(dens_data, sb, *indent, assigning_org,
5343 			    desc_remain, len_to_go, cur_offset,
5344 			    "Assigning Organization");
5345 
5346 			SAFILLDENSSBSTR(dens_data, sb, *indent, density_name,
5347 			    desc_remain, len_to_go, cur_offset, "Density Name");
5348 
5349 			SAFILLDENSSBSTR(dens_data, sb, *indent, description,
5350 			    desc_remain, len_to_go, cur_offset, "Description");
5351 		} else {
5352 			int i;
5353 
5354 			SASBADDUINTDESC(sb, *indent, type_data->medium_type,
5355 			    %u, medium_type, "Medium Type");
5356 
5357 			cur_field_len =
5358 			    __offsetof(struct scsi_medium_type_data,
5359 				       media_width) -
5360 			    __offsetof(struct scsi_medium_type_data,
5361 				       num_density_codes);
5362 
5363 			if (desc_remain < cur_field_len) {
5364 				len_to_go -= desc_remain;
5365 				cur_offset += desc_remain;
5366 				continue;
5367 			}
5368 			len_to_go -= cur_field_len;
5369 			cur_offset += cur_field_len;
5370 			desc_remain -= cur_field_len;
5371 
5372 			SASBADDINTDESC(sb, *indent,
5373 			    type_data->num_density_codes, %d,
5374 			    num_density_codes, "Number of Density Codes");
5375 			SASBADDNODE(sb, *indent, density_code_list);
5376 			for (i = 0; i < type_data->num_density_codes;
5377 			     i++) {
5378 				SASBADDUINTDESC(sb, *indent,
5379 				    type_data->primary_density_codes[i], %u,
5380 				    density_code, "Density Code");
5381 			}
5382 			SASBENDNODE(sb, *indent, density_code_list);
5383 
5384 			SAFILLDENSSB(type_data, sb, *indent, media_width,
5385 			    desc_remain, len_to_go, cur_offset,
5386 			    "Media width");
5387 			SAFILLDENSSB(type_data, sb, *indent, medium_length,
5388 			    desc_remain, len_to_go, cur_offset,
5389 			    "Medium length");
5390 
5391 			/*
5392 			 * Account for the two reserved bytes.
5393 			 */
5394 			cur_field_len = sizeof(type_data->reserved2);
5395 			if (desc_remain < cur_field_len) {
5396 				len_to_go -= desc_remain;
5397 				cur_offset += desc_remain;
5398 				continue;
5399 			}
5400 			len_to_go -= cur_field_len;
5401 			cur_offset += cur_field_len;
5402 			desc_remain -= cur_field_len;
5403 
5404 			SAFILLDENSSBSTR(type_data, sb, *indent, assigning_org,
5405 			    desc_remain, len_to_go, cur_offset,
5406 			    "Assigning Organization");
5407 			SAFILLDENSSBSTR(type_data, sb, *indent,
5408 			    medium_type_name, desc_remain, len_to_go,
5409 			    cur_offset, "Medium type name");
5410 			SAFILLDENSSBSTR(type_data, sb, *indent, description,
5411 			    desc_remain, len_to_go, cur_offset, "Description");
5412 
5413 		}
5414 	}
5415 	if (need_close != 0) {
5416 		SASBENDNODE(sb, *indent, density_entry);
5417 	}
5418 
5419 bailout:
5420 	return;
5421 }
5422 
5423 /*
5424  * Fill an sbuf with density data information
5425  */
5426 static void
5427 safilldensitysb(struct sa_softc *softc, int *indent, struct sbuf *sb)
5428 {
5429 	int i, is_density;
5430 
5431 	SASBADDNODE(sb, *indent, mtdensity);
5432 	SASBADDUINTDESC(sb, *indent, softc->media_density, %u, media_density,
5433 	    "Current Medium Density");
5434 	is_density = 0;
5435 	for (i = 0; i < SA_DENSITY_TYPES; i++) {
5436 		int tmpint;
5437 
5438 		if (softc->density_info_valid[i] == 0)
5439 			continue;
5440 
5441 		SASBADDNODE(sb, *indent, density_report);
5442 		if (softc->density_type_bits[i] & SRDS_MEDIUM_TYPE) {
5443 			tmpint = 1;
5444 			is_density = 0;
5445 		} else {
5446 			tmpint = 0;
5447 			is_density = 1;
5448 		}
5449 		SASBADDINTDESC(sb, *indent, tmpint, %d, medium_type_report,
5450 		    "Medium type report");
5451 
5452 		if (softc->density_type_bits[i] & SRDS_MEDIA)
5453 			tmpint = 1;
5454 		else
5455 			tmpint = 0;
5456 		SASBADDINTDESC(sb, *indent, tmpint, %d, media_report,
5457 		    "Media report");
5458 
5459 		safilldenstypesb(sb, indent, softc->density_info[i],
5460 		    softc->density_info_valid[i], is_density);
5461 		SASBENDNODE(sb, *indent, density_report);
5462 	}
5463 	SASBENDNODE(sb, *indent, mtdensity);
5464 }
5465 
5466 #endif /* _KERNEL */
5467 
5468 /*
5469  * Read tape block limits command.
5470  */
5471 void
5472 scsi_read_block_limits(struct ccb_scsiio *csio, u_int32_t retries,
5473 		   void (*cbfcnp)(struct cam_periph *, union ccb *),
5474 		   u_int8_t tag_action,
5475 		   struct scsi_read_block_limits_data *rlimit_buf,
5476 		   u_int8_t sense_len, u_int32_t timeout)
5477 {
5478 	struct scsi_read_block_limits *scsi_cmd;
5479 
5480 	cam_fill_csio(csio, retries, cbfcnp, CAM_DIR_IN, tag_action,
5481 	     (u_int8_t *)rlimit_buf, sizeof(*rlimit_buf), sense_len,
5482 	     sizeof(*scsi_cmd), timeout);
5483 
5484 	scsi_cmd = (struct scsi_read_block_limits *)&csio->cdb_io.cdb_bytes;
5485 	bzero(scsi_cmd, sizeof(*scsi_cmd));
5486 	scsi_cmd->opcode = READ_BLOCK_LIMITS;
5487 }
5488 
5489 void
5490 scsi_sa_read_write(struct ccb_scsiio *csio, u_int32_t retries,
5491 		   void (*cbfcnp)(struct cam_periph *, union ccb *),
5492 		   u_int8_t tag_action, int readop, int sli,
5493 		   int fixed, u_int32_t length, u_int8_t *data_ptr,
5494 		   u_int32_t dxfer_len, u_int8_t sense_len, u_int32_t timeout)
5495 {
5496 	struct scsi_sa_rw *scsi_cmd;
5497 	int read;
5498 
5499 	read = (readop & SCSI_RW_DIRMASK) == SCSI_RW_READ;
5500 
5501 	scsi_cmd = (struct scsi_sa_rw *)&csio->cdb_io.cdb_bytes;
5502 	scsi_cmd->opcode = read ? SA_READ : SA_WRITE;
5503 	scsi_cmd->sli_fixed = 0;
5504 	if (sli && read)
5505 		scsi_cmd->sli_fixed |= SAR_SLI;
5506 	if (fixed)
5507 		scsi_cmd->sli_fixed |= SARW_FIXED;
5508 	scsi_ulto3b(length, scsi_cmd->length);
5509 	scsi_cmd->control = 0;
5510 
5511 	cam_fill_csio(csio, retries, cbfcnp, (read ? CAM_DIR_IN : CAM_DIR_OUT) |
5512 	    ((readop & SCSI_RW_BIO) != 0 ? CAM_DATA_BIO : 0),
5513 	    tag_action, data_ptr, dxfer_len, sense_len,
5514 	    sizeof(*scsi_cmd), timeout);
5515 }
5516 
5517 void
5518 scsi_load_unload(struct ccb_scsiio *csio, u_int32_t retries,
5519 		 void (*cbfcnp)(struct cam_periph *, union ccb *),
5520 		 u_int8_t tag_action, int immediate, int eot,
5521 		 int reten, int load, u_int8_t sense_len,
5522 		 u_int32_t timeout)
5523 {
5524 	struct scsi_load_unload *scsi_cmd;
5525 
5526 	scsi_cmd = (struct scsi_load_unload *)&csio->cdb_io.cdb_bytes;
5527 	bzero(scsi_cmd, sizeof(*scsi_cmd));
5528 	scsi_cmd->opcode = LOAD_UNLOAD;
5529 	if (immediate)
5530 		scsi_cmd->immediate = SLU_IMMED;
5531 	if (eot)
5532 		scsi_cmd->eot_reten_load |= SLU_EOT;
5533 	if (reten)
5534 		scsi_cmd->eot_reten_load |= SLU_RETEN;
5535 	if (load)
5536 		scsi_cmd->eot_reten_load |= SLU_LOAD;
5537 
5538 	cam_fill_csio(csio, retries, cbfcnp, CAM_DIR_NONE, tag_action,
5539 	    NULL, 0, sense_len, sizeof(*scsi_cmd), timeout);
5540 }
5541 
5542 void
5543 scsi_rewind(struct ccb_scsiio *csio, u_int32_t retries,
5544 	    void (*cbfcnp)(struct cam_periph *, union ccb *),
5545 	    u_int8_t tag_action, int immediate, u_int8_t sense_len,
5546 	    u_int32_t timeout)
5547 {
5548 	struct scsi_rewind *scsi_cmd;
5549 
5550 	scsi_cmd = (struct scsi_rewind *)&csio->cdb_io.cdb_bytes;
5551 	bzero(scsi_cmd, sizeof(*scsi_cmd));
5552 	scsi_cmd->opcode = REWIND;
5553 	if (immediate)
5554 		scsi_cmd->immediate = SREW_IMMED;
5555 
5556 	cam_fill_csio(csio, retries, cbfcnp, CAM_DIR_NONE, tag_action, NULL,
5557 	    0, sense_len, sizeof(*scsi_cmd), timeout);
5558 }
5559 
5560 void
5561 scsi_space(struct ccb_scsiio *csio, u_int32_t retries,
5562 	   void (*cbfcnp)(struct cam_periph *, union ccb *),
5563 	   u_int8_t tag_action, scsi_space_code code,
5564 	   u_int32_t count, u_int8_t sense_len, u_int32_t timeout)
5565 {
5566 	struct scsi_space *scsi_cmd;
5567 
5568 	scsi_cmd = (struct scsi_space *)&csio->cdb_io.cdb_bytes;
5569 	scsi_cmd->opcode = SPACE;
5570 	scsi_cmd->code = code;
5571 	scsi_ulto3b(count, scsi_cmd->count);
5572 	scsi_cmd->control = 0;
5573 
5574 	cam_fill_csio(csio, retries, cbfcnp, CAM_DIR_NONE, tag_action, NULL,
5575 	    0, sense_len, sizeof(*scsi_cmd), timeout);
5576 }
5577 
5578 void
5579 scsi_write_filemarks(struct ccb_scsiio *csio, u_int32_t retries,
5580 		     void (*cbfcnp)(struct cam_periph *, union ccb *),
5581 		     u_int8_t tag_action, int immediate, int setmark,
5582 		     u_int32_t num_marks, u_int8_t sense_len,
5583 		     u_int32_t timeout)
5584 {
5585 	struct scsi_write_filemarks *scsi_cmd;
5586 
5587 	scsi_cmd = (struct scsi_write_filemarks *)&csio->cdb_io.cdb_bytes;
5588 	bzero(scsi_cmd, sizeof(*scsi_cmd));
5589 	scsi_cmd->opcode = WRITE_FILEMARKS;
5590 	if (immediate)
5591 		scsi_cmd->byte2 |= SWFMRK_IMMED;
5592 	if (setmark)
5593 		scsi_cmd->byte2 |= SWFMRK_WSMK;
5594 
5595 	scsi_ulto3b(num_marks, scsi_cmd->num_marks);
5596 
5597 	cam_fill_csio(csio, retries, cbfcnp, CAM_DIR_NONE, tag_action, NULL,
5598 	    0, sense_len, sizeof(*scsi_cmd), timeout);
5599 }
5600 
5601 /*
5602  * The reserve and release unit commands differ only by their opcodes.
5603  */
5604 void
5605 scsi_reserve_release_unit(struct ccb_scsiio *csio, u_int32_t retries,
5606 			  void (*cbfcnp)(struct cam_periph *, union ccb *),
5607 			  u_int8_t tag_action, int third_party,
5608 			  int third_party_id, u_int8_t sense_len,
5609 			  u_int32_t timeout, int reserve)
5610 {
5611 	struct scsi_reserve_release_unit *scsi_cmd;
5612 
5613 	scsi_cmd = (struct scsi_reserve_release_unit *)&csio->cdb_io.cdb_bytes;
5614 	bzero(scsi_cmd, sizeof(*scsi_cmd));
5615 
5616 	if (reserve)
5617 		scsi_cmd->opcode = RESERVE_UNIT;
5618 	else
5619 		scsi_cmd->opcode = RELEASE_UNIT;
5620 
5621 	if (third_party) {
5622 		scsi_cmd->lun_thirdparty |= SRRU_3RD_PARTY;
5623 		scsi_cmd->lun_thirdparty |=
5624 			((third_party_id << SRRU_3RD_SHAMT) & SRRU_3RD_MASK);
5625 	}
5626 
5627 	cam_fill_csio(csio, retries, cbfcnp, CAM_DIR_NONE, tag_action, NULL,
5628 	    0, sense_len, sizeof(*scsi_cmd), timeout);
5629 }
5630 
5631 void
5632 scsi_erase(struct ccb_scsiio *csio, u_int32_t retries,
5633 	   void (*cbfcnp)(struct cam_periph *, union ccb *),
5634 	   u_int8_t tag_action, int immediate, int long_erase,
5635 	   u_int8_t sense_len, u_int32_t timeout)
5636 {
5637 	struct scsi_erase *scsi_cmd;
5638 
5639 	scsi_cmd = (struct scsi_erase *)&csio->cdb_io.cdb_bytes;
5640 	bzero(scsi_cmd, sizeof(*scsi_cmd));
5641 
5642 	scsi_cmd->opcode = ERASE;
5643 
5644 	if (immediate)
5645 		scsi_cmd->lun_imm_long |= SE_IMMED;
5646 
5647 	if (long_erase)
5648 		scsi_cmd->lun_imm_long |= SE_LONG;
5649 
5650 	cam_fill_csio(csio, retries, cbfcnp, CAM_DIR_NONE, tag_action, NULL,
5651 	    0, sense_len, sizeof(*scsi_cmd), timeout);
5652 }
5653 
5654 /*
5655  * Read Tape Position command.
5656  */
5657 void
5658 scsi_read_position(struct ccb_scsiio *csio, u_int32_t retries,
5659 		   void (*cbfcnp)(struct cam_periph *, union ccb *),
5660 		   u_int8_t tag_action, int hardsoft,
5661 		   struct scsi_tape_position_data *sbp,
5662 		   u_int8_t sense_len, u_int32_t timeout)
5663 {
5664 	struct scsi_tape_read_position *scmd;
5665 
5666 	cam_fill_csio(csio, retries, cbfcnp, CAM_DIR_IN, tag_action,
5667 	    (u_int8_t *)sbp, sizeof (*sbp), sense_len, sizeof(*scmd), timeout);
5668 	scmd = (struct scsi_tape_read_position *)&csio->cdb_io.cdb_bytes;
5669 	bzero(scmd, sizeof(*scmd));
5670 	scmd->opcode = READ_POSITION;
5671 	scmd->byte1 = hardsoft;
5672 }
5673 
5674 /*
5675  * Read Tape Position command.
5676  */
5677 void
5678 scsi_read_position_10(struct ccb_scsiio *csio, u_int32_t retries,
5679 		      void (*cbfcnp)(struct cam_periph *, union ccb *),
5680 		      u_int8_t tag_action, int service_action,
5681 		      u_int8_t *data_ptr, u_int32_t length,
5682 		      u_int32_t sense_len, u_int32_t timeout)
5683 {
5684 	struct scsi_tape_read_position *scmd;
5685 
5686 	cam_fill_csio(csio,
5687 		      retries,
5688 		      cbfcnp,
5689 		      /*flags*/CAM_DIR_IN,
5690 		      tag_action,
5691 		      /*data_ptr*/data_ptr,
5692 		      /*dxfer_len*/length,
5693 		      sense_len,
5694 		      sizeof(*scmd),
5695 		      timeout);
5696 
5697 
5698 	scmd = (struct scsi_tape_read_position *)&csio->cdb_io.cdb_bytes;
5699 	bzero(scmd, sizeof(*scmd));
5700 	scmd->opcode = READ_POSITION;
5701 	scmd->byte1 = service_action;
5702 	/*
5703 	 * The length is only currently set (as of SSC4r03) if the extended
5704 	 * form is specified.  The other forms have fixed lengths.
5705 	 */
5706 	if (service_action == SA_RPOS_EXTENDED_FORM)
5707 		scsi_ulto2b(length, scmd->length);
5708 }
5709 
5710 /*
5711  * Set Tape Position command.
5712  */
5713 void
5714 scsi_set_position(struct ccb_scsiio *csio, u_int32_t retries,
5715 		   void (*cbfcnp)(struct cam_periph *, union ccb *),
5716 		   u_int8_t tag_action, int hardsoft, u_int32_t blkno,
5717 		   u_int8_t sense_len, u_int32_t timeout)
5718 {
5719 	struct scsi_tape_locate *scmd;
5720 
5721 	cam_fill_csio(csio, retries, cbfcnp, CAM_DIR_NONE, tag_action,
5722 	    (u_int8_t *)NULL, 0, sense_len, sizeof(*scmd), timeout);
5723 	scmd = (struct scsi_tape_locate *)&csio->cdb_io.cdb_bytes;
5724 	bzero(scmd, sizeof(*scmd));
5725 	scmd->opcode = LOCATE;
5726 	if (hardsoft)
5727 		scmd->byte1 |= SA_SPOS_BT;
5728 	scsi_ulto4b(blkno, scmd->blkaddr);
5729 }
5730 
5731 /*
5732  * XXX KDM figure out how to make a compatibility function.
5733  */
5734 void
5735 scsi_locate_10(struct ccb_scsiio *csio, u_int32_t retries,
5736 	       void (*cbfcnp)(struct cam_periph *, union ccb *),
5737 	       u_int8_t tag_action, int immed, int cp, int hard,
5738 	       int64_t partition, u_int32_t block_address,
5739 	       int sense_len, u_int32_t timeout)
5740 {
5741 	struct scsi_tape_locate *scmd;
5742 
5743 	cam_fill_csio(csio,
5744 		      retries,
5745 		      cbfcnp,
5746 		      CAM_DIR_NONE,
5747 		      tag_action,
5748 		      /*data_ptr*/ NULL,
5749 		      /*dxfer_len*/ 0,
5750 		      sense_len,
5751 		      sizeof(*scmd),
5752 		      timeout);
5753 	scmd = (struct scsi_tape_locate *)&csio->cdb_io.cdb_bytes;
5754 	bzero(scmd, sizeof(*scmd));
5755 	scmd->opcode = LOCATE;
5756 	if (immed)
5757 		scmd->byte1 |= SA_SPOS_IMMED;
5758 	if (cp)
5759 		scmd->byte1 |= SA_SPOS_CP;
5760 	if (hard)
5761 		scmd->byte1 |= SA_SPOS_BT;
5762 	scsi_ulto4b(block_address, scmd->blkaddr);
5763 	scmd->partition = partition;
5764 }
5765 
5766 void
5767 scsi_locate_16(struct ccb_scsiio *csio, u_int32_t retries,
5768 	       void (*cbfcnp)(struct cam_periph *, union ccb *),
5769 	       u_int8_t tag_action, int immed, int cp, u_int8_t dest_type,
5770 	       int bam, int64_t partition, u_int64_t logical_id,
5771 	       int sense_len, u_int32_t timeout)
5772 {
5773 
5774 	struct scsi_locate_16 *scsi_cmd;
5775 
5776 	cam_fill_csio(csio,
5777 		      retries,
5778 		      cbfcnp,
5779 		      /*flags*/CAM_DIR_NONE,
5780 		      tag_action,
5781 		      /*data_ptr*/NULL,
5782 		      /*dxfer_len*/0,
5783 		      sense_len,
5784 		      sizeof(*scsi_cmd),
5785 		      timeout);
5786 
5787 	scsi_cmd = (struct scsi_locate_16 *)&csio->cdb_io.cdb_bytes;
5788 	bzero(scsi_cmd, sizeof(*scsi_cmd));
5789 	scsi_cmd->opcode = LOCATE_16;
5790 	if (immed)
5791 		scsi_cmd->byte1 |= SA_LC_IMMEDIATE;
5792 	if (cp)
5793 		scsi_cmd->byte1 |= SA_LC_CP;
5794 	scsi_cmd->byte1 |= (dest_type << SA_LC_DEST_TYPE_SHIFT);
5795 
5796 	scsi_cmd->byte2 |= bam;
5797 	scsi_cmd->partition = partition;
5798 	scsi_u64to8b(logical_id, scsi_cmd->logical_id);
5799 }
5800 
5801 void
5802 scsi_report_density_support(struct ccb_scsiio *csio, u_int32_t retries,
5803 			    void (*cbfcnp)(struct cam_periph *, union ccb *),
5804 			    u_int8_t tag_action, int media, int medium_type,
5805 			    u_int8_t *data_ptr, u_int32_t length,
5806 			    u_int32_t sense_len, u_int32_t timeout)
5807 {
5808 	struct scsi_report_density_support *scsi_cmd;
5809 
5810 	scsi_cmd =(struct scsi_report_density_support *)&csio->cdb_io.cdb_bytes;
5811 	bzero(scsi_cmd, sizeof(*scsi_cmd));
5812 
5813 	scsi_cmd->opcode = REPORT_DENSITY_SUPPORT;
5814 	if (media != 0)
5815 		scsi_cmd->byte1 |= SRDS_MEDIA;
5816 	if (medium_type != 0)
5817 		scsi_cmd->byte1 |= SRDS_MEDIUM_TYPE;
5818 
5819 	scsi_ulto2b(length, scsi_cmd->length);
5820 
5821 	cam_fill_csio(csio,
5822 		      retries,
5823 		      cbfcnp,
5824 		      /*flags*/CAM_DIR_IN,
5825 		      tag_action,
5826 		      /*data_ptr*/data_ptr,
5827 		      /*dxfer_len*/length,
5828 		      sense_len,
5829 		      sizeof(*scsi_cmd),
5830 		      timeout);
5831 }
5832 
5833 void
5834 scsi_set_capacity(struct ccb_scsiio *csio, u_int32_t retries,
5835 		  void (*cbfcnp)(struct cam_periph *, union ccb *),
5836 		  u_int8_t tag_action, int byte1, u_int32_t proportion,
5837 		  u_int32_t sense_len, u_int32_t timeout)
5838 {
5839 	struct scsi_set_capacity *scsi_cmd;
5840 
5841 	scsi_cmd = (struct scsi_set_capacity *)&csio->cdb_io.cdb_bytes;
5842 	bzero(scsi_cmd, sizeof(*scsi_cmd));
5843 
5844 	scsi_cmd->opcode = SET_CAPACITY;
5845 
5846 	scsi_cmd->byte1 = byte1;
5847 	scsi_ulto2b(proportion, scsi_cmd->cap_proportion);
5848 
5849 	cam_fill_csio(csio,
5850 		      retries,
5851 		      cbfcnp,
5852 		      /*flags*/CAM_DIR_NONE,
5853 		      tag_action,
5854 		      /*data_ptr*/NULL,
5855 		      /*dxfer_len*/0,
5856 		      sense_len,
5857 		      sizeof(*scsi_cmd),
5858 		      timeout);
5859 }
5860 
5861 void
5862 scsi_format_medium(struct ccb_scsiio *csio, u_int32_t retries,
5863 		   void (*cbfcnp)(struct cam_periph *, union ccb *),
5864 		   u_int8_t tag_action, int byte1, int byte2,
5865 		   u_int8_t *data_ptr, u_int32_t dxfer_len,
5866 		   u_int32_t sense_len, u_int32_t timeout)
5867 {
5868 	struct scsi_format_medium *scsi_cmd;
5869 
5870 	scsi_cmd = (struct scsi_format_medium*)&csio->cdb_io.cdb_bytes;
5871 	bzero(scsi_cmd, sizeof(*scsi_cmd));
5872 
5873 	scsi_cmd->opcode = FORMAT_MEDIUM;
5874 
5875 	scsi_cmd->byte1 = byte1;
5876 	scsi_cmd->byte2 = byte2;
5877 
5878 	scsi_ulto2b(dxfer_len, scsi_cmd->length);
5879 
5880 	cam_fill_csio(csio,
5881 		      retries,
5882 		      cbfcnp,
5883 		      /*flags*/(dxfer_len > 0) ? CAM_DIR_OUT : CAM_DIR_NONE,
5884 		      tag_action,
5885 		      /*data_ptr*/ data_ptr,
5886 		      /*dxfer_len*/ dxfer_len,
5887 		      sense_len,
5888 		      sizeof(*scsi_cmd),
5889 		      timeout);
5890 }
5891 
5892 void
5893 scsi_allow_overwrite(struct ccb_scsiio *csio, u_int32_t retries,
5894 		   void (*cbfcnp)(struct cam_periph *, union ccb *),
5895 		   u_int8_t tag_action, int allow_overwrite, int partition,
5896 		   u_int64_t logical_id, u_int32_t sense_len, u_int32_t timeout)
5897 {
5898 	struct scsi_allow_overwrite *scsi_cmd;
5899 
5900 	scsi_cmd = (struct scsi_allow_overwrite *)&csio->cdb_io.cdb_bytes;
5901 	bzero(scsi_cmd, sizeof(*scsi_cmd));
5902 
5903 	scsi_cmd->opcode = ALLOW_OVERWRITE;
5904 
5905 	scsi_cmd->allow_overwrite = allow_overwrite;
5906 	scsi_cmd->partition = partition;
5907 	scsi_u64to8b(logical_id, scsi_cmd->logical_id);
5908 
5909 	cam_fill_csio(csio,
5910 		      retries,
5911 		      cbfcnp,
5912 		      CAM_DIR_NONE,
5913 		      tag_action,
5914 		      /*data_ptr*/ NULL,
5915 		      /*dxfer_len*/ 0,
5916 		      sense_len,
5917 		      sizeof(*scsi_cmd),
5918 		      timeout);
5919 }
5920