xref: /netbsd-src/sys/dev/scsipi/st_scsi.c (revision b757af438b42b93f8c6571f026d8b8ef3eaf5fc9)
1 /*	$NetBSD: st_scsi.c,v 1.34 2012/02/28 10:58:11 mbalmer Exp $ */
2 
3 /*-
4  * Copyright (c) 1998, 2004 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Charles M. Hannum.
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  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /*
33  * Originally written by Julian Elischer (julian@tfs.com)
34  * for TRW Financial Systems for use under the MACH(2.5) operating system.
35  *
36  * TRW Financial Systems, in accordance with their agreement with Carnegie
37  * Mellon University, makes this software available to CMU to distribute
38  * or use in any manner that they see fit as long as this message is kept with
39  * the software. For this reason TFS also grants any other persons or
40  * organisations permission to use or modify this software.
41  *
42  * TFS supplies this software to be publicly redistributed
43  * on the understanding that TFS is not responsible for the correct
44  * functioning of this software in any circumstances.
45  *
46  * Ported to run under 386BSD by Julian Elischer (julian@tfs.com) Sept 1992
47  * major changes by Julian Elischer (julian@jules.dialix.oz.au) May 1993
48  *
49  * A lot of rewhacking done by mjacob (mjacob@nas.nasa.gov).
50  */
51 
52 #include <sys/cdefs.h>
53 __KERNEL_RCSID(0, "$NetBSD: st_scsi.c,v 1.34 2012/02/28 10:58:11 mbalmer Exp $");
54 
55 #include "opt_scsi.h"
56 
57 #include <sys/param.h>
58 #include <sys/device.h>
59 #include <sys/buf.h>
60 #include <sys/bufq.h>
61 #include <sys/conf.h>
62 #include <sys/kernel.h>
63 #include <sys/systm.h>
64 
65 #include <dev/scsipi/scsi_all.h>
66 #include <dev/scsipi/scsi_tape.h>
67 #include <dev/scsipi/stvar.h>
68 
69 static int	st_scsibus_match(device_t, cfdata_t, void *);
70 static void	st_scsibus_attach(device_t, device_t, void *);
71 static int	st_scsibus_ops(struct st_softc *, int, int);
72 static int	st_scsibus_read_block_limits(struct st_softc *, int);
73 static int	st_scsibus_mode_sense(struct st_softc *, int);
74 static int	st_scsibus_cmprss(struct st_softc *, int, int);
75 
76 CFATTACH_DECL_NEW(
77 	st_scsibus,
78 	sizeof(struct st_softc),
79 	st_scsibus_match,
80 	st_scsibus_attach,
81 	stdetach,
82 	NULL
83 );
84 
85 static const struct scsipi_inquiry_pattern st_scsibus_patterns[] = {
86 	{T_SEQUENTIAL, T_REMOV,
87 	 "",         "",                 ""},
88 };
89 
90 static int
91 st_scsibus_match(device_t parent, cfdata_t match, void *aux)
92 {
93 	struct scsipibus_attach_args *sa = aux;
94 	int priority;
95 
96 	if (scsipi_periph_bustype(sa->sa_periph) != SCSIPI_BUSTYPE_SCSI)
97 		return 0;
98 
99 	(void)scsipi_inqmatch(&sa->sa_inqbuf,
100 	    st_scsibus_patterns,
101 	    sizeof(st_scsibus_patterns)/sizeof(st_scsibus_patterns[0]),
102 	    sizeof(st_scsibus_patterns[0]), &priority);
103 	return priority;
104 }
105 
106 static void
107 st_scsibus_attach(device_t parent, device_t self, void *aux)
108 {
109 	struct st_softc *st = device_private(self);
110 
111 	st->ops = st_scsibus_ops;
112 	stattach(parent, self, aux);
113 }
114 
115 static int
116 st_scsibus_ops(struct st_softc *st, int op, int flags)
117 {
118 	switch(op) {
119 	case ST_OPS_RBL:
120 		return st_scsibus_read_block_limits(st, flags);
121 	case ST_OPS_MODESENSE:
122 		return st_scsibus_mode_sense(st, flags);
123 	case ST_OPS_MODESELECT:
124 		return st_mode_select(st, flags);
125 	case ST_OPS_CMPRSS_ON:
126 	case ST_OPS_CMPRSS_OFF:
127 		return st_scsibus_cmprss(st, flags,
128 		    (op == ST_OPS_CMPRSS_ON) ? 1 : 0);
129 	default:
130 		panic("st_scsibus_ops: invalid op");
131 		return 0; /* XXX to appease gcc */
132 	}
133 	/* NOTREACHED */
134 }
135 
136 /*
137  * Ask the drive what it's min and max blk sizes are.
138  */
139 static int
140 st_scsibus_read_block_limits(struct st_softc *st, int flags)
141 {
142 	struct scsi_block_limits cmd;
143 	struct scsi_block_limits_data block_limits;
144 	struct scsipi_periph *periph = st->sc_periph;
145 	int error;
146 
147 	/* do a 'Read Block Limits' */
148 	memset(&cmd, 0, sizeof(cmd));
149 	cmd.opcode = READ_BLOCK_LIMITS;
150 
151 	/* do the command, update the global values */
152 	error = scsipi_command(periph, (void *)&cmd, sizeof(cmd),
153 	    (void *)&block_limits, sizeof(block_limits),
154 	    ST_RETRIES, ST_CTL_TIME, NULL, flags | XS_CTL_DATA_IN);
155 	if (error)
156 		return error;
157 
158 	st->blkmin = _2btol(block_limits.min_length);
159 	st->blkmax = _3btol(block_limits.max_length);
160 
161 	SC_DEBUG(periph, SCSIPI_DB3,
162 	    ("(%d <= blksize <= %d)\n", st->blkmin, st->blkmax));
163 	return 0;
164 }
165 
166 /*
167  * Get the scsi driver to send a full inquiry to the
168  * device and use the results to fill out the global
169  * parameter structure.
170  *
171  * called from:
172  * attach
173  * open
174  * ioctl (to reset original blksize)
175  */
176 static int
177 st_scsibus_mode_sense(struct st_softc *st, int flags)
178 {
179 	u_int scsipi_sense_len;
180 	int error;
181 	struct scsipi_sense {
182 		struct scsi_mode_parameter_header_6 header;
183 		struct scsi_general_block_descriptor blk_desc;
184 		u_char sense_data[MAX_PAGE_0_SIZE];
185 	} scsipi_sense;
186 	struct scsipi_periph *periph = st->sc_periph;
187 
188 	scsipi_sense_len = sizeof(scsipi_sense.header) +
189 			   sizeof(scsipi_sense.blk_desc) +
190 			   st->page_0_size;
191 
192 	/*
193 	 * Set up a mode sense
194 	 * We don't need the results. Just print them for our interest's sake,
195 	 * if asked, or if we need it as a template for the mode select store
196 	 * it away.
197 	 */
198 	error = scsipi_mode_sense(st->sc_periph, 0, SMS_PCTRL_CURRENT,
199 	    &scsipi_sense.header, scsipi_sense_len, flags,
200 	    ST_RETRIES, ST_CTL_TIME);
201 	if (error)
202 		return error;
203 
204 	st->numblks = _3btol(scsipi_sense.blk_desc.nblocks);
205 	st->media_blksize = _3btol(scsipi_sense.blk_desc.blklen);
206 	st->media_density = scsipi_sense.blk_desc.density;
207 	if (scsipi_sense.header.dev_spec & SMH_DSP_WRITE_PROT)
208 		st->flags |= ST_READONLY;
209 	else
210 		st->flags &= ~ST_READONLY;
211 	SC_DEBUG(periph, SCSIPI_DB3,
212 	    ("density code %d, %d-byte blocks, write-%s, ",
213 	    st->media_density, st->media_blksize,
214 	    st->flags & ST_READONLY ? "protected" : "enabled"));
215 	SC_DEBUG(periph, SCSIPI_DB3,
216 	    ("%sbuffered\n",
217 	    scsipi_sense.header.dev_spec & SMH_DSP_BUFF_MODE ? "" : "un"));
218 	if (st->page_0_size)
219 		memcpy(st->sense_data, scsipi_sense.sense_data,
220 		    st->page_0_size);
221 	periph->periph_flags |= PERIPH_MEDIA_LOADED;
222 	return 0;
223 }
224 
225 static int
226 st_scsibus_cmprss(struct st_softc *st, int flags, int onoff)
227 {
228 	u_int scsi_dlen;
229 	int byte2, page;
230 	struct scsi_select {
231 		struct scsi_mode_parameter_header_6 header;
232 		struct scsi_general_block_descriptor blk_desc;
233 		u_char pdata[MAX(sizeof(struct scsi_tape_dev_conf_page),
234 		    sizeof(struct scsi_tape_dev_compression_page))];
235 	} scsi_pdata;
236 	struct scsi_tape_dev_conf_page *ptr;
237 	struct scsi_tape_dev_compression_page *cptr;
238 	struct scsipi_periph *periph = st->sc_periph;
239 	int error, ison;
240 
241 	scsi_dlen = sizeof(scsi_pdata);
242 	/* Do DATA COMPRESSION page first. */
243 	page = SMS_PCTRL_CURRENT | 0xf;
244 	byte2 = 0;
245 
246 	/*  Do the MODE SENSE command... */
247 again:
248 	memset(&scsi_pdata, 0, scsi_dlen);
249 	error = scsipi_mode_sense(periph, byte2, page,
250 	    &scsi_pdata.header, scsi_dlen, flags, ST_RETRIES, ST_CTL_TIME);
251 
252 	if (error) {
253 		if (byte2 != SMS_DBD) {
254 			byte2 = SMS_DBD;
255 			goto again;
256 		}
257 		/* Try a different page? */
258 		if (page == (SMS_PCTRL_CURRENT | 0xf)) {
259 			page = SMS_PCTRL_CURRENT | 0x10;
260 			byte2 = 0;
261 			goto again;
262 		}
263 		return error;
264 	}
265 
266 	if (scsi_pdata.header.blk_desc_len)
267 		ptr = (struct scsi_tape_dev_conf_page *) scsi_pdata.pdata;
268 	else
269 		ptr = (struct scsi_tape_dev_conf_page *) &scsi_pdata.blk_desc;
270 
271 	if ((page & SMS_PAGE_MASK) == 0xf) {
272 		cptr = (struct scsi_tape_dev_compression_page *) ptr;
273 		ison = (cptr->dce_dcc & DCP_DCE) != 0;
274 		if (onoff)
275 			cptr->dce_dcc |= DCP_DCE;
276 		else
277 			cptr->dce_dcc &= ~DCP_DCE;
278 		cptr->pagecode &= ~0x80;
279 	} else {
280 		ison =  (ptr->sel_comp_alg != 0);
281 		if (onoff)
282 			ptr->sel_comp_alg = 1;
283 		else
284 			ptr->sel_comp_alg = 0;
285 		ptr->pagecode &= ~0x80;
286 		ptr->byte2 = 0;
287 		ptr->active_partition = 0;
288 		ptr->wb_full_ratio = 0;
289 		ptr->rb_empty_ratio = 0;
290 		ptr->byte8 &= ~0x30;
291 		ptr->gap_size = 0;
292 		ptr->byte10 &= ~0xe7;
293 		ptr->ew_bufsize[0] = 0;
294 		ptr->ew_bufsize[1] = 0;
295 		ptr->ew_bufsize[2] = 0;
296 		ptr->reserved = 0;
297 	}
298 	/*
299 	 * There might be a virtue in actually doing the MODE SELECTS,
300 	 * but let's not clog the bus over it.
301 	 */
302 	if (onoff == ison)
303 		return 0;
304 
305 	/* Set up for a mode select */
306 	scsi_pdata.header.data_length = 0;
307 	scsi_pdata.header.medium_type = 0;
308 	if ((st->flags & ST_DONTBUFFER) == 0)
309 		scsi_pdata.header.dev_spec = SMH_DSP_BUFF_MODE_ON;
310 	else
311 		scsi_pdata.header.dev_spec = 0;
312 
313 	if (scsi_pdata.header.blk_desc_len) {
314 		scsi_pdata.blk_desc.density = 0;
315 		scsi_pdata.blk_desc.nblocks[0] = 0;
316 		scsi_pdata.blk_desc.nblocks[1] = 0;
317 		scsi_pdata.blk_desc.nblocks[2] = 0;
318 	}
319 
320 	/* Do the command */
321 	error = scsipi_mode_select(periph, SMS_PF, &scsi_pdata.header,
322 	    scsi_dlen, flags, ST_RETRIES, ST_CTL_TIME);
323 
324 	if (error && (page & SMS_PAGE_MASK) == 0xf) {
325 		/* Try DEVICE CONFIGURATION page. */
326 		page = SMS_PCTRL_CURRENT | 0x10;
327 		goto again;
328 	}
329 	return error;
330 }
331