st.c revision 1.110 1 /* $NetBSD: st.c,v 1.110 1999/02/28 17:14:57 explorer Exp $ */
2
3 /*-
4 * Copyright (c) 1998 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 * 3. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the NetBSD
21 * Foundation, Inc. and its contributors.
22 * 4. Neither the name of The NetBSD Foundation nor the names of its
23 * contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 * POSSIBILITY OF SUCH DAMAGE.
37 */
38
39 /*
40 * Originally written by Julian Elischer (julian (at) tfs.com)
41 * for TRW Financial Systems for use under the MACH(2.5) operating system.
42 *
43 * TRW Financial Systems, in accordance with their agreement with Carnegie
44 * Mellon University, makes this software available to CMU to distribute
45 * or use in any manner that they see fit as long as this message is kept with
46 * the software. For this reason TFS also grants any other persons or
47 * organisations permission to use or modify this software.
48 *
49 * TFS supplies this software to be publicly redistributed
50 * on the understanding that TFS is not responsible for the correct
51 * functioning of this software in any circumstances.
52 *
53 * Ported to run under 386BSD by Julian Elischer (julian (at) tfs.com) Sept 1992
54 * major changes by Julian Elischer (julian (at) jules.dialix.oz.au) May 1993
55 *
56 * A lot of rewhacking done by mjacob (mjacob (at) nas.nasa.gov).
57 */
58
59 #include "opt_scsi.h"
60 #include "rnd.h"
61
62 #include <sys/types.h>
63 #include <sys/param.h>
64 #include <sys/systm.h>
65 #include <sys/fcntl.h>
66 #include <sys/errno.h>
67 #include <sys/ioctl.h>
68 #include <sys/malloc.h>
69 #include <sys/buf.h>
70 #include <sys/proc.h>
71 #include <sys/user.h>
72 #include <sys/mtio.h>
73 #include <sys/device.h>
74 #include <sys/conf.h>
75 #if NRND > 0
76 #include <sys/rnd.h>
77 #endif
78
79 #include <dev/scsipi/scsipi_all.h>
80 #include <dev/scsipi/scsi_all.h>
81 #include <dev/scsipi/scsi_tape.h>
82 #include <dev/scsipi/scsiconf.h>
83
84 /* Defines for device specific stuff */
85 #define DEF_FIXED_BSIZE 512
86 #define ST_RETRIES 4 /* only on non IO commands */
87
88 #define STMODE(z) ( minor(z) & 0x03)
89 #define STDSTY(z) ((minor(z) >> 2) & 0x03)
90 #define STUNIT(z) ((minor(z) >> 4) )
91
92 #define NORMAL_MODE 0
93 #define NOREW_MODE 1
94 #define EJECT_MODE 2
95 #define CTRL_MODE 3
96
97 #define FALSE 0
98 #define TRUE 1
99
100 #define ST_IO_TIME (3 * 60 * 1000) /* 3 minutes */
101 #define ST_CTL_TIME (30 * 1000) /* 30 seconds */
102 #define ST_SPC_TIME (4 * 60 * 60 * 1000) /* 4 hours */
103
104 /*
105 * Define various devices that we know mis-behave in some way,
106 * and note how they are bad, so we can correct for them
107 */
108 struct modes {
109 u_int quirks; /* same definitions as in quirkdata */
110 int blksize;
111 u_int8_t density;
112 };
113
114 struct quirkdata {
115 u_int quirks;
116 #define ST_Q_FORCE_BLKSIZE 0x0001
117 #define ST_Q_SENSE_HELP 0x0002 /* must do READ for good MODE SENSE */
118 #define ST_Q_IGNORE_LOADS 0x0004
119 #define ST_Q_BLKSIZE 0x0008 /* variable-block media_blksize > 0 */
120 #define ST_Q_UNIMODAL 0x0010 /* unimode drive rejects mode select */
121 u_int page_0_size;
122 #define MAX_PAGE_0_SIZE 64
123 struct modes modes[4];
124 };
125
126 struct st_quirk_inquiry_pattern {
127 struct scsipi_inquiry_pattern pattern;
128 struct quirkdata quirkdata;
129 };
130
131 struct st_quirk_inquiry_pattern st_quirk_patterns[] = {
132 {{T_SEQUENTIAL, T_REMOV,
133 " ", " ", " "}, {0, 0, {
134 {ST_Q_FORCE_BLKSIZE, 512, 0}, /* minor 0-3 */
135 {ST_Q_FORCE_BLKSIZE, 512, QIC_24}, /* minor 4-7 */
136 {ST_Q_FORCE_BLKSIZE, 0, HALFINCH_1600}, /* minor 8-11 */
137 {ST_Q_FORCE_BLKSIZE, 0, HALFINCH_6250} /* minor 12-15 */
138 }}},
139 {{T_SEQUENTIAL, T_REMOV,
140 "TANDBERG", " TDC 3600 ", ""}, {0, 12, {
141 {0, 0, 0}, /* minor 0-3 */
142 {ST_Q_FORCE_BLKSIZE, 0, QIC_525}, /* minor 4-7 */
143 {0, 0, QIC_150}, /* minor 8-11 */
144 {0, 0, QIC_120} /* minor 12-15 */
145 }}},
146 {{T_SEQUENTIAL, T_REMOV,
147 "TANDBERG", " TDC 3800 ", ""}, {0, 0, {
148 {ST_Q_FORCE_BLKSIZE, 512, 0}, /* minor 0-3 */
149 {0, 0, QIC_525}, /* minor 4-7 */
150 {0, 0, QIC_150}, /* minor 8-11 */
151 {0, 0, QIC_120} /* minor 12-15 */
152 }}},
153 /*
154 * lacking a manual for the 4200, it's not clear what the
155 * specific density codes should be- the device is a 2.5GB
156 * capable QIC drive, those density codes aren't readily
157 * availabel. The 'default' will just have to do.
158 */
159 {{T_SEQUENTIAL, T_REMOV,
160 "TANDBERG", " TDC 4200 ", ""}, {0, 0, {
161 {ST_Q_FORCE_BLKSIZE, 512, 0}, /* minor 0-3 */
162 {0, 0, QIC_525}, /* minor 4-7 */
163 {0, 0, QIC_150}, /* minor 8-11 */
164 {0, 0, QIC_120} /* minor 12-15 */
165 }}},
166 /*
167 * At least -005 and -007 need this. I'll assume they all do unless I
168 * hear otherwise. - mycroft, 31MAR1994
169 */
170 {{T_SEQUENTIAL, T_REMOV,
171 "ARCHIVE ", "VIPER 2525 25462", ""}, {0, 0, {
172 {ST_Q_SENSE_HELP, 0, 0}, /* minor 0-3 */
173 {ST_Q_SENSE_HELP, 0, QIC_525}, /* minor 4-7 */
174 {0, 0, QIC_150}, /* minor 8-11 */
175 {0, 0, QIC_120} /* minor 12-15 */
176 }}},
177 /*
178 * One user reports that this works for his tape drive. It probably
179 * needs more work. - mycroft, 09APR1994
180 */
181 {{T_SEQUENTIAL, T_REMOV,
182 "SANKYO ", "CP525 ", ""}, {0, 0, {
183 {ST_Q_FORCE_BLKSIZE, 512, 0}, /* minor 0-3 */
184 {ST_Q_FORCE_BLKSIZE, 512, QIC_525}, /* minor 4-7 */
185 {0, 0, QIC_150}, /* minor 8-11 */
186 {0, 0, QIC_120} /* minor 12-15 */
187 }}},
188 {{T_SEQUENTIAL, T_REMOV,
189 "ANRITSU ", "DMT780 ", ""}, {0, 0, {
190 {ST_Q_FORCE_BLKSIZE, 512, 0}, /* minor 0-3 */
191 {ST_Q_FORCE_BLKSIZE, 512, QIC_525}, /* minor 4-7 */
192 {0, 0, QIC_150}, /* minor 8-11 */
193 {0, 0, QIC_120} /* minor 12-15 */
194 }}},
195 {{T_SEQUENTIAL, T_REMOV,
196 "ARCHIVE ", "VIPER 150 21247", ""}, {0, 12, {
197 {ST_Q_SENSE_HELP, 0, 0}, /* minor 0-3 */
198 {0, 0, QIC_150}, /* minor 4-7 */
199 {0, 0, QIC_120}, /* minor 8-11 */
200 {0, 0, QIC_24} /* minor 12-15 */
201 }}},
202 {{T_SEQUENTIAL, T_REMOV,
203 "ARCHIVE ", "VIPER 150 21531", ""}, {0, 12, {
204 {ST_Q_SENSE_HELP, 0, 0}, /* minor 0-3 */
205 {0, 0, QIC_150}, /* minor 4-7 */
206 {0, 0, QIC_120}, /* minor 8-11 */
207 {0, 0, QIC_24} /* minor 12-15 */
208 }}},
209 {{T_SEQUENTIAL, T_REMOV,
210 "WANGTEK ", "5099ES SCSI", ""}, {0, 0, {
211 {ST_Q_FORCE_BLKSIZE, 512, 0}, /* minor 0-3 */
212 {0, 0, QIC_11}, /* minor 4-7 */
213 {0, 0, QIC_24}, /* minor 8-11 */
214 {0, 0, QIC_24} /* minor 12-15 */
215 }}},
216 {{T_SEQUENTIAL, T_REMOV,
217 "WANGTEK ", "5150ES SCSI", ""}, {0, 0, {
218 {ST_Q_FORCE_BLKSIZE, 512, 0}, /* minor 0-3 */
219 {0, 0, QIC_24}, /* minor 4-7 */
220 {0, 0, QIC_120}, /* minor 8-11 */
221 {0, 0, QIC_150} /* minor 12-15 */
222 }}},
223 {{T_SEQUENTIAL, T_REMOV,
224 "WANGTEK ", "5525ES SCSI REV7", ""}, {0, 0, {
225 {0, 0, 0}, /* minor 0-3 */
226 {ST_Q_BLKSIZE, 0, QIC_525}, /* minor 4-7 */
227 {0, 0, QIC_150}, /* minor 8-11 */
228 {0, 0, QIC_120} /* minor 12-15 */
229 }}},
230 {{T_SEQUENTIAL, T_REMOV,
231 "WangDAT ", "Model 1300 ", ""}, {0, 0, {
232 {0, 0, 0}, /* minor 0-3 */
233 {ST_Q_FORCE_BLKSIZE, 512, DDS}, /* minor 4-7 */
234 {ST_Q_FORCE_BLKSIZE, 1024, DDS}, /* minor 8-11 */
235 {ST_Q_FORCE_BLKSIZE, 0, DDS} /* minor 12-15 */
236 }}},
237 {{T_SEQUENTIAL, T_REMOV,
238 "EXABYTE ", "EXB-8200 ", "263H"}, {0, 5, {
239 {0, 0, 0}, /* minor 0-3 */
240 {0, 0, 0}, /* minor 4-7 */
241 {0, 0, 0}, /* minor 8-11 */
242 {0, 0, 0} /* minor 12-15 */
243 }}},
244 {{T_SEQUENTIAL, T_REMOV,
245 "STK", "9490", ""},
246 {ST_Q_FORCE_BLKSIZE|ST_Q_IGNORE_LOADS, 0, {
247 {0, 0, 0}, /* minor 0-3 */
248 {0, 0, 0}, /* minor 4-7 */
249 {0, 0, 0}, /* minor 8-11 */
250 {0, 0, 0} /* minor 12-15 */
251 }}},
252 {{T_SEQUENTIAL, T_REMOV,
253 "STK", "SD-3", ""},
254 {ST_Q_FORCE_BLKSIZE|ST_Q_IGNORE_LOADS, 0, {
255 {0, 0, 0}, /* minor 0-3 */
256 {0, 0, 0}, /* minor 4-7 */
257 {0, 0, 0}, /* minor 8-11 */
258 {0, 0, 0} /* minor 12-15 */
259 }}},
260 {{T_SEQUENTIAL, T_REMOV,
261 "IBM", "03590", ""}, {ST_Q_IGNORE_LOADS, 0, {
262 {0, 0, 0}, /* minor 0-3 */
263 {0, 0, 0}, /* minor 4-7 */
264 {0, 0, 0}, /* minor 8-11 */
265 {0, 0, 0} /* minor 12-15 */
266 }}},
267 {{T_SEQUENTIAL, T_REMOV,
268 "HP ", "T4000s ", ""}, {ST_Q_UNIMODAL, 0, {
269 {0, 0, QIC_3095}, /* minor 0-3 */
270 {0, 0, QIC_3095}, /* minor 4-7 */
271 {0, 0, QIC_3095}, /* minor 8-11 */
272 {0, 0, QIC_3095}, /* minor 12-15 */
273 }}},
274 #if 0
275 {{T_SEQUENTIAL, T_REMOV,
276 "EXABYTE ", "EXB-8200 ", ""}, {0, 12, {
277 {0, 0, 0}, /* minor 0-3 */
278 {0, 0, 0}, /* minor 4-7 */
279 {0, 0, 0}, /* minor 8-11 */
280 {0, 0, 0} /* minor 12-15 */
281 }}},
282 #endif
283 };
284
285 #define NOEJECT 0
286 #define EJECT 1
287
288 struct st_softc {
289 struct device sc_dev;
290 /*--------------------present operating parameters, flags etc.---------------*/
291 int flags; /* see below */
292 u_int quirks; /* quirks for the open mode */
293 int blksize; /* blksize we are using */
294 u_int8_t density; /* present density */
295 u_int page_0_size; /* size of page 0 data */
296 u_int last_dsty; /* last density opened */
297 short mt_resid; /* last (short) resid */
298 short mt_erreg; /* last error (sense key) seen */
299 /*--------------------device/scsi parameters---------------------------------*/
300 struct scsipi_link *sc_link; /* our link to the adpter etc. */
301 /*--------------------parameters reported by the device ---------------------*/
302 int blkmin; /* min blk size */
303 int blkmax; /* max blk size */
304 struct quirkdata *quirkdata; /* if we have a rogue entry */
305 /*--------------------parameters reported by the device for this media-------*/
306 u_long numblks; /* nominal blocks capacity */
307 int media_blksize; /* 0 if not ST_FIXEDBLOCKS */
308 u_int8_t media_density; /* this is what it said when asked */
309 /*--------------------quirks for the whole drive-----------------------------*/
310 u_int drive_quirks; /* quirks of this drive */
311 /*--------------------How we should set up when opening each minor device----*/
312 struct modes modes[4]; /* plus more for each mode */
313 u_int8_t modeflags[4]; /* flags for the modes */
314 #define DENSITY_SET_BY_USER 0x01
315 #define DENSITY_SET_BY_QUIRK 0x02
316 #define BLKSIZE_SET_BY_USER 0x04
317 #define BLKSIZE_SET_BY_QUIRK 0x08
318 /*--------------------storage for sense data returned by the drive-----------*/
319 u_char sense_data[MAX_PAGE_0_SIZE]; /*
320 * additional sense data needed
321 * for mode sense/select.
322 */
323 struct buf buf_queue; /* the queue of pending IO */
324 /* operations */
325 #if NRND > 0
326 rndsource_element_t rnd_source;
327 #endif
328 };
329
330
331 int stmatch __P((struct device *, struct cfdata *, void *));
332 void stattach __P((struct device *, struct device *, void *));
333 void st_identify_drive __P((struct st_softc *,
334 struct scsipi_inquiry_pattern *));
335 void st_loadquirks __P((struct st_softc *));
336 int st_mount_tape __P((dev_t, int));
337 void st_unmount __P((struct st_softc *, boolean));
338 int st_decide_mode __P((struct st_softc *, boolean));
339 void ststart __P((void *));
340 void stdone __P((struct scsipi_xfer *));
341 int st_read __P((struct st_softc *, char *, int, int));
342 int st_read_block_limits __P((struct st_softc *, int));
343 int st_mode_sense __P((struct st_softc *, int));
344 int st_mode_select __P((struct st_softc *, int));
345 int st_cmprss __P((struct st_softc *, int));
346 int st_space __P((struct st_softc *, int, u_int, int));
347 int st_write_filemarks __P((struct st_softc *, int, int));
348 int st_check_eod __P((struct st_softc *, boolean, int *, int));
349 int st_load __P((struct st_softc *, u_int, int));
350 int st_rewind __P((struct st_softc *, u_int, int));
351 int st_interpret_sense __P((struct scsipi_xfer *));
352 int st_touch_tape __P((struct st_softc *));
353 int st_erase __P((struct st_softc *, int full, int flags));
354 int st_rdpos __P((struct st_softc *, int, u_int32_t *));
355 int st_setpos __P((struct st_softc *, int, u_int32_t *));
356
357 struct cfattach st_ca = {
358 sizeof(struct st_softc), stmatch, stattach
359 };
360
361 extern struct cfdriver st_cd;
362
363 struct scsipi_device st_switch = {
364 st_interpret_sense,
365 ststart,
366 NULL,
367 stdone
368 };
369
370 #define ST_INFO_VALID 0x0001
371 #define ST_BLOCK_SET 0x0002 /* block size, mode set by ioctl */
372 #define ST_WRITTEN 0x0004 /* data has been written, EOD needed */
373 #define ST_FIXEDBLOCKS 0x0008
374 #define ST_AT_FILEMARK 0x0010
375 #define ST_EIO_PENDING 0x0020 /* error reporting deferred until next op */
376 #define ST_NEW_MOUNT 0x0040 /* still need to decide mode */
377 #define ST_READONLY 0x0080 /* st_mode_sense says write protected */
378 #define ST_FM_WRITTEN 0x0100 /*
379 * EOF file mark written -- used with
380 * ~ST_WRITTEN to indicate that multiple file
381 * marks have been written
382 */
383 #define ST_BLANK_READ 0x0200 /* BLANK CHECK encountered already */
384 #define ST_2FM_AT_EOD 0x0400 /* write 2 file marks at EOD */
385 #define ST_MOUNTED 0x0800 /* Device is presently mounted */
386 #define ST_DONTBUFFER 0x1000 /* Disable buffering/caching */
387 #define ST_EARLYWARN 0x2000 /* Do (deferred) EOM for variable mode */
388 #define ST_EOM_PENDING 0x4000 /* EOM reporting deferred until next op */
389
390 #define ST_PER_ACTION (ST_AT_FILEMARK | ST_EIO_PENDING | ST_EOM_PENDING | \
391 ST_BLANK_READ)
392 #define ST_PER_MOUNT (ST_INFO_VALID | ST_BLOCK_SET | ST_WRITTEN | \
393 ST_FIXEDBLOCKS | ST_READONLY | ST_FM_WRITTEN | \
394 ST_2FM_AT_EOD | ST_PER_ACTION)
395
396 #if defined(ST_ENABLE_EARLYWARN)
397 #define ST_INIT_FLAGS ST_EARLYWARN
398 #else
399 #define ST_INIT_FLAGS 0
400 #endif
401
402 struct scsipi_inquiry_pattern st_patterns[] = {
403 {T_SEQUENTIAL, T_REMOV,
404 "", "", ""},
405 };
406
407 int
408 stmatch(parent, match, aux)
409 struct device *parent;
410 struct cfdata *match;
411 void *aux;
412 {
413 struct scsipibus_attach_args *sa = aux;
414 int priority;
415
416 (void)scsipi_inqmatch(&sa->sa_inqbuf,
417 (caddr_t)st_patterns, sizeof(st_patterns)/sizeof(st_patterns[0]),
418 sizeof(st_patterns[0]), &priority);
419 return (priority);
420 }
421
422 /*
423 * The routine called by the low level scsi routine when it discovers
424 * A device suitable for this driver
425 */
426 void
427 stattach(parent, self, aux)
428 struct device *parent, *self;
429 void *aux;
430 {
431 struct st_softc *st = (void *)self;
432 struct scsipibus_attach_args *sa = aux;
433 struct scsipi_link *sc_link = sa->sa_sc_link;
434
435 SC_DEBUG(sc_link, SDEV_DB2, ("stattach: "));
436
437 /*
438 * Store information needed to contact our base driver
439 */
440 st->sc_link = sc_link;
441 sc_link->device = &st_switch;
442 sc_link->device_softc = st;
443 sc_link->openings = 1;
444
445 /*
446 * Set initial flags
447 */
448
449 st->flags = ST_INIT_FLAGS;
450
451 /*
452 * Check if the drive is a known criminal and take
453 * Any steps needed to bring it into line
454 */
455 st_identify_drive(st, &sa->sa_inqbuf);
456 /*
457 * Use the subdriver to request information regarding
458 * the drive. We cannot use interrupts yet, so the
459 * request must specify this.
460 */
461 printf("\n");
462 printf("%s: %s", st->sc_dev.dv_xname, st->quirkdata ? "rogue, " : "");
463 if (scsipi_test_unit_ready(sc_link,
464 SCSI_AUTOCONF | SCSI_SILENT | SCSI_IGNORE_MEDIA_CHANGE) ||
465 st_mode_sense(st,
466 SCSI_AUTOCONF | SCSI_SILENT | SCSI_IGNORE_MEDIA_CHANGE))
467 printf("drive empty\n");
468 else {
469 printf("density code 0x%x, ", st->media_density);
470 if (st->media_blksize > 0)
471 printf("%d-byte", st->media_blksize);
472 else
473 printf("variable");
474 printf(" blocks, write-%s\n",
475 (st->flags & ST_READONLY) ? "protected" : "enabled");
476 }
477
478 /*
479 * Set up the buf queue for this device
480 */
481 st->buf_queue.b_active = 0;
482 st->buf_queue.b_actf = 0;
483 st->buf_queue.b_actb = &st->buf_queue.b_actf;
484
485 #if NRND > 0
486 rnd_attach_source(&st->rnd_source, st->sc_dev.dv_xname,
487 RND_TYPE_TAPE, 0);
488 #endif
489 }
490
491 /*
492 * Use the inquiry routine in 'scsi_base' to get drive info so we can
493 * Further tailor our behaviour.
494 */
495 void
496 st_identify_drive(st, inqbuf)
497 struct st_softc *st;
498 struct scsipi_inquiry_pattern *inqbuf;
499 {
500 struct st_quirk_inquiry_pattern *finger;
501 int priority;
502
503 finger = (struct st_quirk_inquiry_pattern *)scsipi_inqmatch(inqbuf,
504 (caddr_t)st_quirk_patterns,
505 sizeof(st_quirk_patterns) / sizeof(st_quirk_patterns[0]),
506 sizeof(st_quirk_patterns[0]), &priority);
507 if (priority != 0) {
508 st->quirkdata = &finger->quirkdata;
509 st->drive_quirks = finger->quirkdata.quirks;
510 st->quirks = finger->quirkdata.quirks; /* start value */
511 st->page_0_size = finger->quirkdata.page_0_size;
512 st_loadquirks(st);
513 }
514 }
515
516 /*
517 * initialise the subdevices to the default (QUIRK) state.
518 * this will remove any setting made by the system operator or previous
519 * operations.
520 */
521 void
522 st_loadquirks(st)
523 struct st_softc *st;
524 {
525 int i;
526 struct modes *mode;
527 struct modes *mode2;
528
529 mode = st->quirkdata->modes;
530 mode2 = st->modes;
531 for (i = 0; i < 4; i++) {
532 bzero(mode2, sizeof(struct modes));
533 st->modeflags[i] &= ~(BLKSIZE_SET_BY_QUIRK |
534 DENSITY_SET_BY_QUIRK | BLKSIZE_SET_BY_USER |
535 DENSITY_SET_BY_USER);
536 if ((mode->quirks | st->drive_quirks) & ST_Q_FORCE_BLKSIZE) {
537 mode2->blksize = mode->blksize;
538 st->modeflags[i] |= BLKSIZE_SET_BY_QUIRK;
539 }
540 if (mode->density) {
541 mode2->density = mode->density;
542 st->modeflags[i] |= DENSITY_SET_BY_QUIRK;
543 }
544 mode++;
545 mode2++;
546 }
547 }
548
549 /*
550 * open the device.
551 */
552 int
553 stopen(dev, flags, mode, p)
554 dev_t dev;
555 int flags;
556 int mode;
557 struct proc *p;
558 {
559 int unit;
560 u_int stmode, dsty;
561 int error;
562 struct st_softc *st;
563 struct scsipi_link *sc_link;
564
565 unit = STUNIT(dev);
566 if (unit >= st_cd.cd_ndevs)
567 return (ENXIO);
568 st = st_cd.cd_devs[unit];
569 if (st == NULL)
570 return (ENXIO);
571
572 stmode = STMODE(dev);
573 dsty = STDSTY(dev);
574 sc_link = st->sc_link;
575
576 SC_DEBUG(sc_link, SDEV_DB1, ("open: dev=0x%x (unit %d (of %d))\n", dev,
577 unit, st_cd.cd_ndevs));
578
579
580 /*
581 * Only allow one at a time
582 */
583 if (sc_link->flags & SDEV_OPEN) {
584 printf("%s: already open\n", st->sc_dev.dv_xname);
585 return (EBUSY);
586 }
587
588 if ((error = scsipi_adapter_addref(sc_link)) != 0)
589 return (error);
590
591 /*
592 * clear any latched errors.
593 */
594 st->mt_resid = 0;
595 st->mt_erreg = 0;
596
597 /*
598 * Catch any unit attention errors.
599 */
600 error = scsipi_test_unit_ready(sc_link, SCSI_IGNORE_MEDIA_CHANGE |
601 (stmode == CTRL_MODE ? SCSI_SILENT : 0));
602 if (error && stmode != CTRL_MODE) {
603 goto bad;
604 }
605 sc_link->flags |= SDEV_OPEN; /* unit attn are now errors */
606
607 /*
608 * If the mode is 3 (e.g. minor = 3,7,11,15) then the device has
609 * been opened to set defaults and perform other, usually non-I/O
610 * related, operations. In this case, do a quick check to see
611 * whether the unit actually had a tape loaded (this will be known
612 * as to whether or not we got a NOT READY for the above
613 * unit attention). If a tape is there, go do a mount sequence.
614 */
615 if (stmode == CTRL_MODE && st->mt_erreg == SKEY_NOT_READY) {
616 return (0);
617 }
618
619 /*
620 * If it's a different mode, or if the media has been
621 * invalidated, unmount the tape from the previous
622 * session but continue with open processing
623 */
624 if (st->last_dsty != dsty || !(sc_link->flags & SDEV_MEDIA_LOADED))
625 st_unmount(st, NOEJECT);
626
627 /*
628 * If we are not mounted, then we should start a new
629 * mount session.
630 */
631 if (!(st->flags & ST_MOUNTED)) {
632 st_mount_tape(dev, flags);
633 st->last_dsty = dsty;
634 }
635
636 SC_DEBUG(sc_link, SDEV_DB2, ("open complete\n"));
637 return (0);
638
639 bad:
640 st_unmount(st, NOEJECT);
641 scsipi_adapter_delref(sc_link);
642 sc_link->flags &= ~SDEV_OPEN;
643 return (error);
644 }
645
646 /*
647 * close the device.. only called if we are the LAST
648 * occurence of an open device
649 */
650 int
651 stclose(dev, flags, mode, p)
652 dev_t dev;
653 int flags;
654 int mode;
655 struct proc *p;
656 {
657 int stxx, error = 0;
658 struct st_softc *st = st_cd.cd_devs[STUNIT(dev)];
659
660 SC_DEBUG(st->sc_link, SDEV_DB1, ("closing\n"));
661
662 /*
663 * Make sure that a tape opened in write-only mode will have
664 * file marks written on it when closed, even if not written to.
665 *
666 * This is for SUN compatibility. Actually, the Sun way of
667 * things is to:
668 *
669 * only write filemarks if there are fmks to be written and
670 * - open for write (possibly read/write)
671 * - the last operation was a write
672 * or:
673 * - opened for wronly
674 * - no data was written (including filemarks)
675 */
676
677 stxx = st->flags & (ST_WRITTEN | ST_FM_WRITTEN);
678 if (((flags & FWRITE) && stxx == ST_WRITTEN) ||
679 ((flags & O_ACCMODE) == FWRITE && stxx == 0)) {
680 int nm;
681 error = st_check_eod(st, FALSE, &nm, 0);
682 }
683
684 switch (STMODE(dev)) {
685 case NORMAL_MODE:
686 st_unmount(st, NOEJECT);
687 break;
688 case NOREW_MODE:
689 case CTRL_MODE:
690 /*
691 * Leave mounted unless media seems to have been removed.
692 *
693 * Otherwise, if we're to terminate a tape with more than one
694 * filemark [ and because we're not rewinding here ], backspace
695 * one filemark so that later appends will see an unbroken
696 * sequence of:
697 *
698 * file - FMK - file - FMK ... file - FMK FMK (EOM)
699 */
700 if (!(st->sc_link->flags & SDEV_MEDIA_LOADED)) {
701 st_unmount(st, NOEJECT);
702 } else if (error == 0) {
703 /*
704 * ST_WRITTEN was preserved from above.
705 *
706 * All we need to know here is:
707 *
708 * Were we writing this tape and was the last
709 * operation a write?
710 *
711 * Are there supposed to be 2FM at EOD?
712 *
713 * If both statements are true, then we backspace
714 * one filemark.
715 */
716 stxx |= (st->flags & ST_2FM_AT_EOD);
717 if ((flags & FWRITE) != 0 &&
718 (stxx == (ST_2FM_AT_EOD|ST_WRITTEN))) {
719 error = st_space(st, -1, SP_FILEMARKS, 0);
720 }
721 }
722 break;
723 case EJECT_MODE:
724 st_unmount(st, EJECT);
725 break;
726 }
727
728 scsipi_wait_drain(st->sc_link);
729
730 scsipi_adapter_delref(st->sc_link);
731 st->sc_link->flags &= ~SDEV_OPEN;
732
733 return (error);
734 }
735
736 /*
737 * Start a new mount session.
738 * Copy in all the default parameters from the selected device mode.
739 * and try guess any that seem to be defaulted.
740 */
741 int
742 st_mount_tape(dev, flags)
743 dev_t dev;
744 int flags;
745 {
746 int unit;
747 u_int dsty;
748 struct st_softc *st;
749 struct scsipi_link *sc_link;
750 int error = 0;
751
752 unit = STUNIT(dev);
753 dsty = STDSTY(dev);
754 st = st_cd.cd_devs[unit];
755 sc_link = st->sc_link;
756
757 if (st->flags & ST_MOUNTED)
758 return (0);
759
760 SC_DEBUG(sc_link, SDEV_DB1, ("mounting\n "));
761 st->flags |= ST_NEW_MOUNT;
762 st->quirks = st->drive_quirks | st->modes[dsty].quirks;
763 /*
764 * If the media is new, then make sure we give it a chance to
765 * to do a 'load' instruction. (We assume it is new.)
766 */
767 if ((error = st_load(st, LD_LOAD, 0)) != 0)
768 return (error);
769 /*
770 * Throw another dummy instruction to catch
771 * 'Unit attention' errors. Many drives give
772 * these after doing a Load instruction (with
773 * the MEDIUM MAY HAVE CHANGED asc/ascq).
774 */
775 scsipi_test_unit_ready(sc_link, SCSI_SILENT); /* XXX */
776
777 /*
778 * Some devices can't tell you much until they have been
779 * asked to look at the media. This quirk does this.
780 */
781 if (st->quirks & ST_Q_SENSE_HELP)
782 if ((error = st_touch_tape(st)) != 0)
783 return (error);
784 /*
785 * Load the physical device parameters
786 * loads: blkmin, blkmax
787 */
788 if ((error = st_read_block_limits(st, 0)) != 0)
789 return (error);
790 /*
791 * Load the media dependent parameters
792 * includes: media_blksize,media_density,numblks
793 * As we have a tape in, it should be reflected here.
794 * If not you may need the "quirk" above.
795 */
796 if ((error = st_mode_sense(st, 0)) != 0)
797 return (error);
798 /*
799 * If we have gained a permanent density from somewhere,
800 * then use it in preference to the one supplied by
801 * default by the driver.
802 */
803 if (st->modeflags[dsty] & (DENSITY_SET_BY_QUIRK | DENSITY_SET_BY_USER))
804 st->density = st->modes[dsty].density;
805 else
806 st->density = st->media_density;
807 /*
808 * If we have gained a permanent blocksize
809 * then use it in preference to the one supplied by
810 * default by the driver.
811 */
812 st->flags &= ~ST_FIXEDBLOCKS;
813 if (st->modeflags[dsty] &
814 (BLKSIZE_SET_BY_QUIRK | BLKSIZE_SET_BY_USER)) {
815 st->blksize = st->modes[dsty].blksize;
816 if (st->blksize)
817 st->flags |= ST_FIXEDBLOCKS;
818 } else {
819 if ((error = st_decide_mode(st, FALSE)) != 0)
820 return (error);
821 }
822 if ((error = st_mode_select(st, 0)) != 0) {
823 printf("%s: cannot set selected mode\n", st->sc_dev.dv_xname);
824 return (error);
825 }
826 scsipi_prevent(sc_link, PR_PREVENT,
827 SCSI_IGNORE_ILLEGAL_REQUEST | SCSI_IGNORE_NOT_READY);
828 st->flags &= ~ST_NEW_MOUNT;
829 st->flags |= ST_MOUNTED;
830 sc_link->flags |= SDEV_MEDIA_LOADED; /* move earlier? */
831
832 return (0);
833 }
834
835 /*
836 * End the present mount session.
837 * Rewind, and optionally eject the tape.
838 * Reset various flags to indicate that all new
839 * operations require another mount operation
840 */
841 void
842 st_unmount(st, eject)
843 struct st_softc *st;
844 boolean eject;
845 {
846 struct scsipi_link *sc_link = st->sc_link;
847 int nmarks;
848
849 if (!(st->flags & ST_MOUNTED))
850 return;
851 SC_DEBUG(sc_link, SDEV_DB1, ("unmounting\n"));
852 st_check_eod(st, FALSE, &nmarks, SCSI_IGNORE_NOT_READY);
853 st_rewind(st, 0, SCSI_IGNORE_NOT_READY);
854 scsipi_prevent(sc_link, PR_ALLOW,
855 SCSI_IGNORE_ILLEGAL_REQUEST | SCSI_IGNORE_NOT_READY);
856 if (eject)
857 st_load(st, LD_UNLOAD, SCSI_IGNORE_NOT_READY);
858 st->flags &= ~(ST_MOUNTED | ST_NEW_MOUNT);
859 sc_link->flags &= ~SDEV_MEDIA_LOADED;
860 }
861
862 /*
863 * Given all we know about the device, media, mode, 'quirks' and
864 * initial operation, make a decision as to how we should be set
865 * to run (regarding blocking and EOD marks)
866 */
867 int
868 st_decide_mode(st, first_read)
869 struct st_softc *st;
870 boolean first_read;
871 {
872 #ifdef SCSIDEBUG
873 struct scsipi_link *sc_link = st->sc_link;
874 #endif
875
876 SC_DEBUG(sc_link, SDEV_DB2, ("starting block mode decision\n"));
877
878 /*
879 * If the drive can only handle fixed-length blocks and only at
880 * one size, perhaps we should just do that.
881 */
882 if (st->blkmin && (st->blkmin == st->blkmax)) {
883 st->flags |= ST_FIXEDBLOCKS;
884 st->blksize = st->blkmin;
885 SC_DEBUG(sc_link, SDEV_DB3,
886 ("blkmin == blkmax of %d\n", st->blkmin));
887 goto done;
888 }
889 /*
890 * If the tape density mandates (or even suggests) use of fixed
891 * or variable-length blocks, comply.
892 */
893 switch (st->density) {
894 case HALFINCH_800:
895 case HALFINCH_1600:
896 case HALFINCH_6250:
897 case DDS:
898 st->flags &= ~ST_FIXEDBLOCKS;
899 st->blksize = 0;
900 SC_DEBUG(sc_link, SDEV_DB3, ("density specified variable\n"));
901 goto done;
902 case QIC_11:
903 case QIC_24:
904 case QIC_120:
905 case QIC_150:
906 case QIC_525:
907 case QIC_1320:
908 st->flags |= ST_FIXEDBLOCKS;
909 if (st->media_blksize > 0)
910 st->blksize = st->media_blksize;
911 else
912 st->blksize = DEF_FIXED_BSIZE;
913 SC_DEBUG(sc_link, SDEV_DB3, ("density specified fixed\n"));
914 goto done;
915 }
916 /*
917 * If we're about to read the tape, perhaps we should choose
918 * fixed or variable-length blocks and block size according to
919 * what the drive found on the tape.
920 */
921 if (first_read &&
922 (!(st->quirks & ST_Q_BLKSIZE) || (st->media_blksize == 0) ||
923 (st->media_blksize == DEF_FIXED_BSIZE) ||
924 (st->media_blksize == 1024))) {
925 if (st->media_blksize > 0)
926 st->flags |= ST_FIXEDBLOCKS;
927 else
928 st->flags &= ~ST_FIXEDBLOCKS;
929 st->blksize = st->media_blksize;
930 SC_DEBUG(sc_link, SDEV_DB3,
931 ("Used media_blksize of %d\n", st->media_blksize));
932 goto done;
933 }
934 /*
935 * We're getting no hints from any direction. Choose variable-
936 * length blocks arbitrarily.
937 */
938 st->flags &= ~ST_FIXEDBLOCKS;
939 st->blksize = 0;
940 SC_DEBUG(sc_link, SDEV_DB3,
941 ("Give up and default to variable mode\n"));
942
943 done:
944 /*
945 * Decide whether or not to write two file marks to signify end-
946 * of-data. Make the decision as a function of density. If
947 * the decision is not to use a second file mark, the SCSI BLANK
948 * CHECK condition code will be recognized as end-of-data when
949 * first read.
950 * (I think this should be a by-product of fixed/variable..julian)
951 */
952 switch (st->density) {
953 /* case 8 mm: What is the SCSI density code for 8 mm, anyway? */
954 case QIC_11:
955 case QIC_24:
956 case QIC_120:
957 case QIC_150:
958 case QIC_525:
959 case QIC_1320:
960 st->flags &= ~ST_2FM_AT_EOD;
961 break;
962 default:
963 st->flags |= ST_2FM_AT_EOD;
964 }
965 return (0);
966 }
967
968 /*
969 * Actually translate the requested transfer into
970 * one the physical driver can understand
971 * The transfer is described by a buf and will include
972 * only one physical transfer.
973 */
974 void
975 ststrategy(bp)
976 struct buf *bp;
977 {
978 struct st_softc *st = st_cd.cd_devs[STUNIT(bp->b_dev)];
979 struct buf *dp;
980 int s;
981
982 SC_DEBUG(st->sc_link, SDEV_DB1,
983 ("ststrategy %ld bytes @ blk %d\n", bp->b_bcount, bp->b_blkno));
984 /*
985 * If it's a null transfer, return immediatly
986 */
987 if (bp->b_bcount == 0)
988 goto done;
989
990 /* If offset is negative, error */
991 if (bp->b_blkno < 0) {
992 bp->b_error = EINVAL;
993 goto bad;
994 }
995
996 /*
997 * Odd sized request on fixed drives are verboten
998 */
999 if (st->flags & ST_FIXEDBLOCKS) {
1000 if (bp->b_bcount % st->blksize) {
1001 printf("%s: bad request, must be multiple of %d\n",
1002 st->sc_dev.dv_xname, st->blksize);
1003 bp->b_error = EIO;
1004 goto bad;
1005 }
1006 }
1007 /*
1008 * as are out-of-range requests on variable drives.
1009 */
1010 else if (bp->b_bcount < st->blkmin ||
1011 (st->blkmax && bp->b_bcount > st->blkmax)) {
1012 printf("%s: bad request, must be between %d and %d\n",
1013 st->sc_dev.dv_xname, st->blkmin, st->blkmax);
1014 bp->b_error = EIO;
1015 goto bad;
1016 }
1017 s = splbio();
1018
1019 /*
1020 * Place it in the queue of activities for this tape
1021 * at the end (a bit silly because we only have on user..
1022 * (but it could fork()))
1023 */
1024 dp = &st->buf_queue;
1025 bp->b_actf = NULL;
1026 bp->b_actb = dp->b_actb;
1027 *dp->b_actb = bp;
1028 dp->b_actb = &bp->b_actf;
1029
1030 /*
1031 * Tell the device to get going on the transfer if it's
1032 * not doing anything, otherwise just wait for completion
1033 * (All a bit silly if we're only allowing 1 open but..)
1034 */
1035 ststart(st);
1036
1037 splx(s);
1038 return;
1039 bad:
1040 bp->b_flags |= B_ERROR;
1041 done:
1042 /*
1043 * Correctly set the buf to indicate a completed xfer
1044 */
1045 bp->b_resid = bp->b_bcount;
1046 biodone(bp);
1047 return;
1048 }
1049
1050 /*
1051 * ststart looks to see if there is a buf waiting for the device
1052 * and that the device is not already busy. If both are true,
1053 * It dequeues the buf and creates a scsi command to perform the
1054 * transfer required. The transfer request will call scsipi_done
1055 * on completion, which will in turn call this routine again
1056 * so that the next queued transfer is performed.
1057 * The bufs are queued by the strategy routine (ststrategy)
1058 *
1059 * This routine is also called after other non-queued requests
1060 * have been made of the scsi driver, to ensure that the queue
1061 * continues to be drained.
1062 * ststart() is called at splbio
1063 */
1064 void
1065 ststart(v)
1066 void *v;
1067 {
1068 struct st_softc *st = v;
1069 struct scsipi_link *sc_link = st->sc_link;
1070 register struct buf *bp, *dp;
1071 struct scsi_rw_tape cmd;
1072 int flags;
1073
1074 SC_DEBUG(sc_link, SDEV_DB2, ("ststart "));
1075 /*
1076 * See if there is a buf to do and we are not already
1077 * doing one
1078 */
1079 while (sc_link->openings > 0) {
1080 /* if a special awaits, let it proceed first */
1081 if (sc_link->flags & SDEV_WAITING) {
1082 sc_link->flags &= ~SDEV_WAITING;
1083 wakeup((caddr_t)sc_link);
1084 return;
1085 }
1086
1087 dp = &st->buf_queue;
1088 if ((bp = dp->b_actf) == NULL)
1089 return;
1090 if ((dp = bp->b_actf) != NULL)
1091 dp->b_actb = bp->b_actb;
1092 else
1093 st->buf_queue.b_actb = bp->b_actb;
1094 *bp->b_actb = dp;
1095
1096 /*
1097 * if the device has been unmounted byt the user
1098 * then throw away all requests until done
1099 */
1100 if (!(st->flags & ST_MOUNTED) ||
1101 !(sc_link->flags & SDEV_MEDIA_LOADED)) {
1102 /* make sure that one implies the other.. */
1103 sc_link->flags &= ~SDEV_MEDIA_LOADED;
1104 bp->b_flags |= B_ERROR;
1105 bp->b_error = EIO;
1106 bp->b_resid = bp->b_bcount;
1107 biodone(bp);
1108 continue;
1109 }
1110 /*
1111 * only FIXEDBLOCK devices have pending I/O or space operations.
1112 */
1113 if (st->flags & ST_FIXEDBLOCKS) {
1114 /*
1115 * If we are at a filemark but have not reported it yet
1116 * then we should report it now
1117 */
1118 if (st->flags & ST_AT_FILEMARK) {
1119 if ((bp->b_flags & B_READ) == B_WRITE) {
1120 /*
1121 * Handling of ST_AT_FILEMARK in
1122 * st_space will fill in the right file
1123 * mark count.
1124 * Back up over filemark
1125 */
1126 if (st_space(st, 0, SP_FILEMARKS, 0)) {
1127 bp->b_flags |= B_ERROR;
1128 bp->b_error = EIO;
1129 biodone(bp);
1130 continue;
1131 }
1132 } else {
1133 bp->b_resid = bp->b_bcount;
1134 bp->b_error = 0;
1135 bp->b_flags &= ~B_ERROR;
1136 st->flags &= ~ST_AT_FILEMARK;
1137 biodone(bp);
1138 continue; /* seek more work */
1139 }
1140 }
1141 }
1142 /*
1143 * If we are at EOM but have not reported it
1144 * yet then we should report it now.
1145 */
1146 if (st->flags & (ST_EOM_PENDING|ST_EIO_PENDING)) {
1147 bp->b_resid = bp->b_bcount;
1148 if (st->flags & ST_EIO_PENDING) {
1149 bp->b_error = EIO;
1150 bp->b_flags |= B_ERROR;
1151 }
1152 st->flags &= ~(ST_EOM_PENDING|ST_EIO_PENDING);
1153 biodone(bp);
1154 continue; /* seek more work */
1155 }
1156
1157 /*
1158 * Fill out the scsi command
1159 */
1160 bzero(&cmd, sizeof(cmd));
1161 if ((bp->b_flags & B_READ) == B_WRITE) {
1162 cmd.opcode = WRITE;
1163 st->flags &= ~ST_FM_WRITTEN;
1164 flags = SCSI_DATA_OUT;
1165 } else {
1166 cmd.opcode = READ;
1167 flags = SCSI_DATA_IN;
1168 }
1169
1170 /*
1171 * Handle "fixed-block-mode" tape drives by using the
1172 * block count instead of the length.
1173 */
1174 if (st->flags & ST_FIXEDBLOCKS) {
1175 cmd.byte2 |= SRW_FIXED;
1176 _lto3b(bp->b_bcount / st->blksize, cmd.len);
1177 } else
1178 _lto3b(bp->b_bcount, cmd.len);
1179
1180 /*
1181 * go ask the adapter to do all this for us
1182 */
1183 if (scsipi_command(sc_link,
1184 (struct scsipi_generic *)&cmd, sizeof(cmd),
1185 (u_char *)bp->b_data, bp->b_bcount,
1186 0, ST_IO_TIME, bp, flags | SCSI_NOSLEEP))
1187 printf("%s: not queued\n", st->sc_dev.dv_xname);
1188 } /* go back and see if we can cram more work in.. */
1189 }
1190
1191 void
1192 stdone(xs)
1193 struct scsipi_xfer *xs;
1194 {
1195
1196 if (xs->bp != NULL) {
1197 struct st_softc *st = xs->sc_link->device_softc;
1198 if ((xs->bp->b_flags & B_READ) == B_WRITE) {
1199 st->flags |= ST_WRITTEN;
1200 } else {
1201 st->flags &= ~ST_WRITTEN;
1202 }
1203 #if NRND > 0
1204 rnd_add_uint32(&st->rnd_source, xs->bp->b_blkno);
1205 #endif
1206 }
1207 }
1208
1209 int
1210 stread(dev, uio, iomode)
1211 dev_t dev;
1212 struct uio *uio;
1213 int iomode;
1214 {
1215 struct st_softc *st = st_cd.cd_devs[STUNIT(dev)];
1216
1217 return (physio(ststrategy, NULL, dev, B_READ,
1218 st->sc_link->adapter->scsipi_minphys, uio));
1219 }
1220
1221 int
1222 stwrite(dev, uio, iomode)
1223 dev_t dev;
1224 struct uio *uio;
1225 int iomode;
1226 {
1227 struct st_softc *st = st_cd.cd_devs[STUNIT(dev)];
1228
1229 return (physio(ststrategy, NULL, dev, B_WRITE,
1230 st->sc_link->adapter->scsipi_minphys, uio));
1231 }
1232
1233 /*
1234 * Perform special action on behalf of the user;
1235 * knows about the internals of this device
1236 */
1237 int
1238 stioctl(dev, cmd, arg, flag, p)
1239 dev_t dev;
1240 u_long cmd;
1241 caddr_t arg;
1242 int flag;
1243 struct proc *p;
1244 {
1245 int error = 0;
1246 int unit;
1247 int number, nmarks, dsty;
1248 int flags;
1249 struct st_softc *st;
1250 int hold_blksize;
1251 u_int8_t hold_density;
1252 struct mtop *mt = (struct mtop *) arg;
1253
1254 /*
1255 * Find the device that the user is talking about
1256 */
1257 flags = 0; /* give error messages, act on errors etc. */
1258 unit = STUNIT(dev);
1259 dsty = STDSTY(dev);
1260 st = st_cd.cd_devs[unit];
1261 hold_blksize = st->blksize;
1262 hold_density = st->density;
1263
1264 switch ((u_int) cmd) {
1265
1266 case MTIOCGET: {
1267 struct mtget *g = (struct mtget *) arg;
1268 /*
1269 * (to get the current state of READONLY)
1270 */
1271 error = st_mode_sense(st, SCSI_SILENT);
1272 if (error)
1273 break;
1274 SC_DEBUG(st->sc_link, SDEV_DB1, ("[ioctl: get status]\n"));
1275 bzero(g, sizeof(struct mtget));
1276 g->mt_type = 0x7; /* Ultrix compat *//*? */
1277 g->mt_blksiz = st->blksize;
1278 g->mt_density = st->density;
1279 g->mt_mblksiz[0] = st->modes[0].blksize;
1280 g->mt_mblksiz[1] = st->modes[1].blksize;
1281 g->mt_mblksiz[2] = st->modes[2].blksize;
1282 g->mt_mblksiz[3] = st->modes[3].blksize;
1283 g->mt_mdensity[0] = st->modes[0].density;
1284 g->mt_mdensity[1] = st->modes[1].density;
1285 g->mt_mdensity[2] = st->modes[2].density;
1286 g->mt_mdensity[3] = st->modes[3].density;
1287 if (st->flags & ST_READONLY)
1288 g->mt_dsreg |= MT_DS_RDONLY;
1289 if (st->flags & ST_MOUNTED)
1290 g->mt_dsreg |= MT_DS_MOUNTED;
1291 g->mt_resid = st->mt_resid;
1292 g->mt_erreg = st->mt_erreg;
1293 /*
1294 * clear latched errors.
1295 */
1296 st->mt_resid = 0;
1297 st->mt_erreg = 0;
1298 break;
1299 }
1300 case MTIOCTOP: {
1301
1302 SC_DEBUG(st->sc_link, SDEV_DB1,
1303 ("[ioctl: op=0x%x count=0x%x]\n", mt->mt_op,
1304 mt->mt_count));
1305
1306 /* compat: in U*x it is a short */
1307 number = mt->mt_count;
1308 switch ((short) (mt->mt_op)) {
1309 case MTWEOF: /* write an end-of-file record */
1310 error = st_write_filemarks(st, number, flags);
1311 break;
1312 case MTBSF: /* backward space file */
1313 number = -number;
1314 case MTFSF: /* forward space file */
1315 error = st_check_eod(st, FALSE, &nmarks, flags);
1316 if (!error)
1317 error = st_space(st, number - nmarks,
1318 SP_FILEMARKS, flags);
1319 break;
1320 case MTBSR: /* backward space record */
1321 number = -number;
1322 case MTFSR: /* forward space record */
1323 error = st_check_eod(st, TRUE, &nmarks, flags);
1324 if (!error)
1325 error = st_space(st, number, SP_BLKS, flags);
1326 break;
1327 case MTREW: /* rewind */
1328 error = st_rewind(st, 0, flags);
1329 break;
1330 case MTOFFL: /* rewind and put the drive offline */
1331 st_unmount(st, EJECT);
1332 break;
1333 case MTNOP: /* no operation, sets status only */
1334 break;
1335 case MTRETEN: /* retension the tape */
1336 error = st_load(st, LD_RETENSION, flags);
1337 if (!error)
1338 error = st_load(st, LD_LOAD, flags);
1339 break;
1340 case MTEOM: /* forward space to end of media */
1341 error = st_check_eod(st, FALSE, &nmarks, flags);
1342 if (!error)
1343 error = st_space(st, 1, SP_EOM, flags);
1344 break;
1345 case MTCACHE: /* enable controller cache */
1346 st->flags &= ~ST_DONTBUFFER;
1347 goto try_new_value;
1348 case MTNOCACHE: /* disable controller cache */
1349 st->flags |= ST_DONTBUFFER;
1350 goto try_new_value;
1351 case MTERASE: /* erase volume */
1352 error = st_erase(st, number, flags);
1353 break;
1354 case MTSETBSIZ: /* Set block size for device */
1355 #ifdef NOTYET
1356 if (!(st->flags & ST_NEW_MOUNT)) {
1357 uprintf("re-mount tape before changing blocksize");
1358 error = EINVAL;
1359 break;
1360 }
1361 #endif
1362 if (number == 0)
1363 st->flags &= ~ST_FIXEDBLOCKS;
1364 else {
1365 if ((st->blkmin || st->blkmax) &&
1366 (number < st->blkmin ||
1367 number > st->blkmax)) {
1368 error = EINVAL;
1369 break;
1370 }
1371 st->flags |= ST_FIXEDBLOCKS;
1372 }
1373 st->blksize = number;
1374 st->flags |= ST_BLOCK_SET; /*XXX */
1375 goto try_new_value;
1376
1377 case MTSETDNSTY: /* Set density for device and mode */
1378 /*
1379 * Any number >= 0 and <= 0xff is legal. Numbers
1380 * above 0x80 are 'vendor unique'.
1381 */
1382 if (number < 0 || number > 255) {
1383 error = EINVAL;
1384 break;
1385 } else
1386 st->density = number;
1387 goto try_new_value;
1388
1389 case MTCMPRESS:
1390 error = st_cmprss(st, number);
1391 break;
1392
1393 case MTEWARN:
1394 if (number)
1395 st->flags |= ST_EARLYWARN;
1396 else
1397 st->flags &= ~ST_EARLYWARN;
1398 break;
1399
1400 default:
1401 error = EINVAL;
1402 }
1403 break;
1404 }
1405 case MTIOCIEOT:
1406 case MTIOCEEOT:
1407 break;
1408
1409 case MTIOCRDSPOS:
1410 error = st_rdpos(st, 0, (u_int32_t *) arg);
1411 break;
1412
1413 case MTIOCRDHPOS:
1414 error = st_rdpos(st, 1, (u_int32_t *) arg);
1415 break;
1416
1417 case MTIOCSLOCATE:
1418 error = st_setpos(st, 0, (u_int32_t *) arg);
1419 break;
1420
1421 case MTIOCHLOCATE:
1422 error = st_setpos(st, 1, (u_int32_t *) arg);
1423 break;
1424
1425
1426 default:
1427 error = scsipi_do_ioctl(st->sc_link, dev, cmd, arg,
1428 flag, p);
1429 break;
1430 }
1431 return (error);
1432 /*-----------------------------*/
1433 try_new_value:
1434 /*
1435 * Check that the mode being asked for is aggreeable to the
1436 * drive. If not, put it back the way it was.
1437 */
1438 if ((error = st_mode_select(st, 0)) != 0) {/* put it back as it was */
1439 printf("%s: cannot set selected mode\n", st->sc_dev.dv_xname);
1440 st->density = hold_density;
1441 st->blksize = hold_blksize;
1442 if (st->blksize)
1443 st->flags |= ST_FIXEDBLOCKS;
1444 else
1445 st->flags &= ~ST_FIXEDBLOCKS;
1446 return (error);
1447 }
1448 /*
1449 * As the drive liked it, if we are setting a new default,
1450 * set it into the structures as such.
1451 *
1452 * The means for deciding this are not finalised yet- but
1453 * if the device was opened in Control Mode, the values
1454 * are persistent now across mounts.
1455 */
1456 if (STMODE(dev) == CTRL_MODE) {
1457 switch ((short) (mt->mt_op)) {
1458 case MTSETBSIZ:
1459 st->modes[dsty].blksize = st->blksize;
1460 st->modeflags[dsty] |= BLKSIZE_SET_BY_USER;
1461 break;
1462 case MTSETDNSTY:
1463 st->modes[dsty].density = st->density;
1464 st->modeflags[dsty] |= DENSITY_SET_BY_USER;
1465 break;
1466 }
1467 }
1468 return (0);
1469 }
1470
1471 /*
1472 * Do a synchronous read.
1473 */
1474 int
1475 st_read(st, buf, size, flags)
1476 struct st_softc *st;
1477 int size;
1478 int flags;
1479 char *buf;
1480 {
1481 struct scsi_rw_tape cmd;
1482
1483 /*
1484 * If it's a null transfer, return immediatly
1485 */
1486 if (size == 0)
1487 return (0);
1488 bzero(&cmd, sizeof(cmd));
1489 cmd.opcode = READ;
1490 if (st->flags & ST_FIXEDBLOCKS) {
1491 cmd.byte2 |= SRW_FIXED;
1492 _lto3b(size / (st->blksize ? st->blksize : DEF_FIXED_BSIZE),
1493 cmd.len);
1494 } else
1495 _lto3b(size, cmd.len);
1496 return (scsipi_command(st->sc_link,
1497 (struct scsipi_generic *)&cmd, sizeof(cmd),
1498 (u_char *)buf, size, 0, ST_IO_TIME, NULL, flags | SCSI_DATA_IN));
1499 }
1500
1501 /*
1502 * Ask the drive what it's min and max blk sizes are.
1503 */
1504 int
1505 st_read_block_limits(st, flags)
1506 struct st_softc *st;
1507 int flags;
1508 {
1509 struct scsi_block_limits cmd;
1510 struct scsi_block_limits_data block_limits;
1511 struct scsipi_link *sc_link = st->sc_link;
1512 int error;
1513
1514 /*
1515 * First check if we have it all loaded
1516 */
1517 if ((sc_link->flags & SDEV_MEDIA_LOADED))
1518 return (0);
1519
1520 /*
1521 * do a 'Read Block Limits'
1522 */
1523 bzero(&cmd, sizeof(cmd));
1524 cmd.opcode = READ_BLOCK_LIMITS;
1525
1526 /*
1527 * do the command, update the global values
1528 */
1529 error = scsipi_command(sc_link, (struct scsipi_generic *)&cmd,
1530 sizeof(cmd), (u_char *)&block_limits, sizeof(block_limits),
1531 ST_RETRIES, ST_CTL_TIME, NULL, flags | SCSI_DATA_IN);
1532 if (error)
1533 return (error);
1534
1535 st->blkmin = _2btol(block_limits.min_length);
1536 st->blkmax = _3btol(block_limits.max_length);
1537
1538 SC_DEBUG(sc_link, SDEV_DB3,
1539 ("(%d <= blksize <= %d)\n", st->blkmin, st->blkmax));
1540 return (0);
1541 }
1542
1543 /*
1544 * Get the scsi driver to send a full inquiry to the
1545 * device and use the results to fill out the global
1546 * parameter structure.
1547 *
1548 * called from:
1549 * attach
1550 * open
1551 * ioctl (to reset original blksize)
1552 */
1553 int
1554 st_mode_sense(st, flags)
1555 struct st_softc *st;
1556 int flags;
1557 {
1558 u_int scsipi_sense_len;
1559 int error;
1560 struct scsi_mode_sense cmd;
1561 struct scsipi_sense {
1562 struct scsi_mode_header header;
1563 struct scsi_blk_desc blk_desc;
1564 u_char sense_data[MAX_PAGE_0_SIZE];
1565 } scsipi_sense;
1566 struct scsipi_link *sc_link = st->sc_link;
1567
1568 scsipi_sense_len = 12 + st->page_0_size;
1569
1570 /*
1571 * Set up a mode sense
1572 */
1573 bzero(&cmd, sizeof(cmd));
1574 cmd.opcode = SCSI_MODE_SENSE;
1575 cmd.length = scsipi_sense_len;
1576
1577 /*
1578 * do the command, but we don't need the results
1579 * just print them for our interest's sake, if asked,
1580 * or if we need it as a template for the mode select
1581 * store it away.
1582 */
1583 error = scsipi_command(sc_link, (struct scsipi_generic *)&cmd,
1584 sizeof(cmd), (u_char *)&scsipi_sense, scsipi_sense_len,
1585 ST_RETRIES, ST_CTL_TIME, NULL, flags | SCSI_DATA_IN);
1586 if (error)
1587 return (error);
1588
1589 st->numblks = _3btol(scsipi_sense.blk_desc.nblocks);
1590 st->media_blksize = _3btol(scsipi_sense.blk_desc.blklen);
1591 st->media_density = scsipi_sense.blk_desc.density;
1592 if (scsipi_sense.header.dev_spec & SMH_DSP_WRITE_PROT)
1593 st->flags |= ST_READONLY;
1594 else
1595 st->flags &= ~ST_READONLY;
1596 SC_DEBUG(sc_link, SDEV_DB3,
1597 ("density code 0x%x, %d-byte blocks, write-%s, ",
1598 st->media_density, st->media_blksize,
1599 st->flags & ST_READONLY ? "protected" : "enabled"));
1600 SC_DEBUG(sc_link, SDEV_DB3,
1601 ("%sbuffered\n",
1602 scsipi_sense.header.dev_spec & SMH_DSP_BUFF_MODE ? "" : "un"));
1603 if (st->page_0_size)
1604 bcopy(scsipi_sense.sense_data, st->sense_data,
1605 st->page_0_size);
1606 sc_link->flags |= SDEV_MEDIA_LOADED;
1607 return (0);
1608 }
1609
1610 /*
1611 * Send a filled out parameter structure to the drive to
1612 * set it into the desire modes etc.
1613 */
1614 int
1615 st_mode_select(st, flags)
1616 struct st_softc *st;
1617 int flags;
1618 {
1619 u_int scsi_select_len;
1620 struct scsi_mode_select cmd;
1621 struct scsi_select {
1622 struct scsi_mode_header header;
1623 struct scsi_blk_desc blk_desc;
1624 u_char sense_data[MAX_PAGE_0_SIZE];
1625 } scsi_select;
1626 struct scsipi_link *sc_link = st->sc_link;
1627
1628 scsi_select_len = 12 + st->page_0_size;
1629
1630 /*
1631 * This quirk deals with drives that have only one valid mode
1632 * and think this gives them license to reject all mode selects,
1633 * even if the selected mode is the one that is supported.
1634 */
1635 if (st->quirks & ST_Q_UNIMODAL) {
1636 SC_DEBUG(sc_link, SDEV_DB3,
1637 ("not setting density 0x%x blksize 0x%x\n",
1638 st->density, st->blksize));
1639 return (0);
1640 }
1641
1642 /*
1643 * Set up for a mode select
1644 */
1645 bzero(&cmd, sizeof(cmd));
1646 cmd.opcode = SCSI_MODE_SELECT;
1647 cmd.length = scsi_select_len;
1648
1649 bzero(&scsi_select, scsi_select_len);
1650 scsi_select.header.blk_desc_len = sizeof(struct scsi_blk_desc);
1651 scsi_select.header.dev_spec &= ~SMH_DSP_BUFF_MODE;
1652 scsi_select.blk_desc.density = st->density;
1653 if (st->flags & ST_DONTBUFFER)
1654 scsi_select.header.dev_spec |= SMH_DSP_BUFF_MODE_OFF;
1655 else
1656 scsi_select.header.dev_spec |= SMH_DSP_BUFF_MODE_ON;
1657 if (st->flags & ST_FIXEDBLOCKS)
1658 _lto3b(st->blksize, scsi_select.blk_desc.blklen);
1659 if (st->page_0_size)
1660 bcopy(st->sense_data, scsi_select.sense_data, st->page_0_size);
1661
1662 /*
1663 * do the command
1664 */
1665 return (scsipi_command(sc_link, (struct scsipi_generic *)&cmd,
1666 sizeof(cmd), (u_char *)&scsi_select, scsi_select_len,
1667 ST_RETRIES, ST_CTL_TIME, NULL, flags | SCSI_DATA_OUT));
1668 }
1669
1670 int
1671 st_cmprss(st, onoff)
1672 struct st_softc *st;
1673 int onoff;
1674 {
1675 u_int scsi_dlen;
1676 struct scsi_mode_select mcmd;
1677 struct scsi_mode_sense scmd;
1678 struct scsi_select {
1679 struct scsi_mode_header header;
1680 struct scsi_blk_desc blk_desc;
1681 u_char pdata[max(sizeof(struct scsi_tape_dev_conf_page),
1682 sizeof(struct scsi_tape_dev_compression_page))];
1683 } scsi_pdata;
1684 struct scsi_tape_dev_conf_page *ptr;
1685 struct scsi_tape_dev_compression_page *cptr;
1686 struct scsipi_link *sc_link = st->sc_link;
1687 int error, ison, flags;
1688
1689 scsi_dlen = sizeof(scsi_pdata);
1690 bzero(&scsi_pdata, scsi_dlen);
1691
1692 /*
1693 * Set up for a mode sense.
1694 * Do DATA COMPRESSION page first.
1695 */
1696 bzero(&scmd, sizeof(scmd));
1697 scmd.opcode = SCSI_MODE_SENSE;
1698 scmd.page = SMS_PAGE_CTRL_CURRENT | 0xf;
1699 scmd.length = scsi_dlen;
1700
1701 flags = SCSI_SILENT;
1702
1703 /*
1704 * Do the MODE SENSE command...
1705 */
1706 again:
1707 bzero(&scsi_pdata, scsi_dlen);
1708 error = scsipi_command(sc_link,
1709 (struct scsipi_generic *)&scmd, sizeof(scmd),
1710 (u_char *)&scsi_pdata, scsi_dlen,
1711 ST_RETRIES, ST_CTL_TIME, NULL, flags | SCSI_DATA_IN);
1712
1713 if (error) {
1714 if (scmd.byte2 != SMS_DBD) {
1715 scmd.byte2 = SMS_DBD;
1716 goto again;
1717 }
1718 /*
1719 * Try a different page?
1720 */
1721 if (scmd.page == (SMS_PAGE_CTRL_CURRENT | 0xf)) {
1722 scmd.page = SMS_PAGE_CTRL_CURRENT | 0x10;
1723 scmd.byte2 = 0;
1724 goto again;
1725 }
1726 return (error);
1727 }
1728
1729 if (scsi_pdata.header.blk_desc_len)
1730 ptr = (struct scsi_tape_dev_conf_page *) scsi_pdata.pdata;
1731 else
1732 ptr = (struct scsi_tape_dev_conf_page *) &scsi_pdata.blk_desc;
1733
1734 if ((scmd.page & SMS_PAGE_CODE) == 0xf) {
1735 cptr = (struct scsi_tape_dev_compression_page *) ptr;
1736 ison = (cptr->dce_dcc & DCP_DCE) != 0;
1737 if (onoff)
1738 cptr->dce_dcc |= DCP_DCE;
1739 else
1740 cptr->dce_dcc &= ~DCP_DCE;
1741 cptr->pagecode &= ~0x80;
1742 } else {
1743 ison = (ptr->sel_comp_alg != 0);
1744 if (onoff)
1745 ptr->sel_comp_alg = 1;
1746 else
1747 ptr->sel_comp_alg = 0;
1748 ptr->pagecode &= ~0x80;
1749 ptr->byte2 = 0;
1750 ptr->active_partition = 0;
1751 ptr->wb_full_ratio = 0;
1752 ptr->rb_empty_ratio = 0;
1753 ptr->byte8 &= ~0x30;
1754 ptr->gap_size = 0;
1755 ptr->byte10 &= ~0xe7;
1756 ptr->ew_bufsize[0] = 0;
1757 ptr->ew_bufsize[1] = 0;
1758 ptr->ew_bufsize[2] = 0;
1759 ptr->reserved = 0;
1760 }
1761 onoff = onoff ? 1 : 0;
1762 /*
1763 * There might be a virtue in actually doing the MODE SELECTS,
1764 * but let's not clog the bus over it.
1765 */
1766 if (onoff == ison)
1767 return (0);
1768
1769 /*
1770 * Set up for a mode select
1771 */
1772
1773 scsi_pdata.header.data_length = 0;
1774 scsi_pdata.header.medium_type = 0;
1775 if ((st->flags & ST_DONTBUFFER) == 0)
1776 scsi_pdata.header.dev_spec = SMH_DSP_BUFF_MODE_ON;
1777 else
1778 scsi_pdata.header.dev_spec = 0;
1779
1780 bzero(&mcmd, sizeof(mcmd));
1781 mcmd.opcode = SCSI_MODE_SELECT;
1782 mcmd.byte2 = SMS_PF;
1783 mcmd.length = scsi_dlen;
1784 if (scsi_pdata.header.blk_desc_len) {
1785 scsi_pdata.blk_desc.density = 0;
1786 scsi_pdata.blk_desc.nblocks[0] = 0;
1787 scsi_pdata.blk_desc.nblocks[1] = 0;
1788 scsi_pdata.blk_desc.nblocks[2] = 0;
1789 }
1790
1791 /*
1792 * Do the command
1793 */
1794 error = scsipi_command(sc_link,
1795 (struct scsipi_generic *)&mcmd, sizeof(mcmd),
1796 (u_char *)&scsi_pdata, scsi_dlen,
1797 ST_RETRIES, ST_CTL_TIME, NULL, flags | SCSI_DATA_OUT);
1798
1799 if (error && (scmd.page & SMS_PAGE_CODE) == 0xf) {
1800 /*
1801 * Try DEVICE CONFIGURATION page.
1802 */
1803 scmd.page = SMS_PAGE_CTRL_CURRENT | 0x10;
1804 goto again;
1805 }
1806 return (error);
1807 }
1808 /*
1809 * issue an erase command
1810 */
1811 int
1812 st_erase(st, full, flags)
1813 struct st_softc *st;
1814 int full, flags;
1815 {
1816 int tmo;
1817 struct scsi_erase cmd;
1818
1819 /*
1820 * Full erase means set LONG bit in erase command, which asks
1821 * the drive to erase the entire unit. Without this bit, we're
1822 * asking the drive to write an erase gap.
1823 */
1824 bzero(&cmd, sizeof(cmd));
1825 cmd.opcode = ERASE;
1826 if (full) {
1827 cmd.byte2 = SE_IMMED|SE_LONG;
1828 tmo = ST_SPC_TIME;
1829 } else {
1830 tmo = ST_IO_TIME;
1831 cmd.byte2 = SE_IMMED;
1832 }
1833
1834 /*
1835 * XXX We always do this asynchronously, for now. How long should
1836 * we wait if we want to (eventually) to it synchronously?
1837 */
1838 return (scsipi_command(st->sc_link,
1839 (struct scsipi_generic *)&cmd, sizeof(cmd),
1840 0, 0, ST_RETRIES, tmo, NULL, flags));
1841 }
1842
1843 /*
1844 * skip N blocks/filemarks/seq filemarks/eom
1845 */
1846 int
1847 st_space(st, number, what, flags)
1848 struct st_softc *st;
1849 u_int what;
1850 int flags;
1851 int number;
1852 {
1853 struct scsi_space cmd;
1854 int error;
1855
1856 switch (what) {
1857 case SP_BLKS:
1858 if (st->flags & ST_PER_ACTION) {
1859 if (number > 0) {
1860 st->flags &= ~ST_PER_ACTION;
1861 return (EIO);
1862 } else if (number < 0) {
1863 if (st->flags & ST_AT_FILEMARK) {
1864 /*
1865 * Handling of ST_AT_FILEMARK
1866 * in st_space will fill in the
1867 * right file mark count.
1868 */
1869 error = st_space(st, 0, SP_FILEMARKS,
1870 flags);
1871 if (error)
1872 return (error);
1873 }
1874 if (st->flags & ST_BLANK_READ) {
1875 st->flags &= ~ST_BLANK_READ;
1876 return (EIO);
1877 }
1878 st->flags &= ~(ST_EIO_PENDING|ST_EOM_PENDING);
1879 }
1880 }
1881 break;
1882 case SP_FILEMARKS:
1883 if (st->flags & ST_EIO_PENDING) {
1884 if (number > 0) {
1885 /* pretend we just discovered the error */
1886 st->flags &= ~ST_EIO_PENDING;
1887 return (EIO);
1888 } else if (number < 0) {
1889 /* back away from the error */
1890 st->flags &= ~ST_EIO_PENDING;
1891 }
1892 }
1893 if (st->flags & ST_AT_FILEMARK) {
1894 st->flags &= ~ST_AT_FILEMARK;
1895 number--;
1896 }
1897 if ((st->flags & ST_BLANK_READ) && (number < 0)) {
1898 /* back away from unwritten tape */
1899 st->flags &= ~ST_BLANK_READ;
1900 number++; /* XXX dubious */
1901 }
1902 break;
1903 case SP_EOM:
1904 if (st->flags & ST_EOM_PENDING) {
1905 /* we're already there */
1906 st->flags &= ~ST_EOM_PENDING;
1907 return (0);
1908 }
1909 if (st->flags & ST_EIO_PENDING) {
1910 /* pretend we just discovered the error */
1911 st->flags &= ~ST_EIO_PENDING;
1912 return (EIO);
1913 }
1914 if (st->flags & ST_AT_FILEMARK)
1915 st->flags &= ~ST_AT_FILEMARK;
1916 break;
1917 }
1918 if (number == 0)
1919 return (0);
1920
1921 bzero(&cmd, sizeof(cmd));
1922 cmd.opcode = SPACE;
1923 cmd.byte2 = what;
1924 _lto3b(number, cmd.number);
1925
1926 return (scsipi_command(st->sc_link,
1927 (struct scsipi_generic *)&cmd, sizeof(cmd),
1928 0, 0, 0, ST_SPC_TIME, NULL, flags));
1929 }
1930
1931 /*
1932 * write N filemarks
1933 */
1934 int
1935 st_write_filemarks(st, number, flags)
1936 struct st_softc *st;
1937 int flags;
1938 int number;
1939 {
1940 struct scsi_write_filemarks cmd;
1941
1942 /*
1943 * It's hard to write a negative number of file marks.
1944 * Don't try.
1945 */
1946 if (number < 0)
1947 return (EINVAL);
1948 switch (number) {
1949 case 0: /* really a command to sync the drive's buffers */
1950 break;
1951 case 1:
1952 if (st->flags & ST_FM_WRITTEN) /* already have one down */
1953 st->flags &= ~ST_WRITTEN;
1954 else
1955 st->flags |= ST_FM_WRITTEN;
1956 st->flags &= ~ST_PER_ACTION;
1957 break;
1958 default:
1959 st->flags &= ~(ST_PER_ACTION | ST_WRITTEN);
1960 }
1961
1962 bzero(&cmd, sizeof(cmd));
1963 cmd.opcode = WRITE_FILEMARKS;
1964 _lto3b(number, cmd.number);
1965
1966 return (scsipi_command(st->sc_link,
1967 (struct scsipi_generic *)&cmd, sizeof(cmd),
1968 0, 0, 0, ST_IO_TIME * 4, NULL, flags));
1969 }
1970
1971 /*
1972 * Make sure the right number of file marks is on tape if the
1973 * tape has been written. If the position argument is true,
1974 * leave the tape positioned where it was originally.
1975 *
1976 * nmarks returns the number of marks to skip (or, if position
1977 * true, which were skipped) to get back original position.
1978 */
1979 int
1980 st_check_eod(st, position, nmarks, flags)
1981 struct st_softc *st;
1982 boolean position;
1983 int *nmarks;
1984 int flags;
1985 {
1986 int error;
1987
1988 switch (st->flags & (ST_WRITTEN | ST_FM_WRITTEN | ST_2FM_AT_EOD)) {
1989 default:
1990 *nmarks = 0;
1991 return (0);
1992 case ST_WRITTEN:
1993 case ST_WRITTEN | ST_FM_WRITTEN | ST_2FM_AT_EOD:
1994 *nmarks = 1;
1995 break;
1996 case ST_WRITTEN | ST_2FM_AT_EOD:
1997 *nmarks = 2;
1998 }
1999 error = st_write_filemarks(st, *nmarks, flags);
2000 if (position && !error)
2001 error = st_space(st, -*nmarks, SP_FILEMARKS, flags);
2002 return (error);
2003 }
2004
2005 /*
2006 * load/unload/retension
2007 */
2008 int
2009 st_load(st, type, flags)
2010 struct st_softc *st;
2011 u_int type;
2012 int flags;
2013 {
2014 struct scsi_load cmd;
2015
2016 if (type != LD_LOAD) {
2017 int error;
2018 int nmarks;
2019
2020 error = st_check_eod(st, FALSE, &nmarks, flags);
2021 if (error)
2022 return (error);
2023 }
2024 if (st->quirks & ST_Q_IGNORE_LOADS) {
2025 if (type == LD_LOAD) {
2026 /*
2027 * If we ignore loads, at least we should try a rewind.
2028 */
2029 return st_rewind(st, 0, flags);
2030 }
2031 return (0);
2032 }
2033
2034 bzero(&cmd, sizeof(cmd));
2035 cmd.opcode = LOAD;
2036 cmd.how = type;
2037
2038 return (scsipi_command(st->sc_link,
2039 (struct scsipi_generic *)&cmd, sizeof(cmd),
2040 0, 0, ST_RETRIES, ST_SPC_TIME, NULL, flags));
2041 }
2042
2043 /*
2044 * Rewind the device
2045 */
2046 int
2047 st_rewind(st, immediate, flags)
2048 struct st_softc *st;
2049 u_int immediate;
2050 int flags;
2051 {
2052 struct scsi_rewind cmd;
2053 int error;
2054 int nmarks;
2055
2056 error = st_check_eod(st, FALSE, &nmarks, flags);
2057 if (error)
2058 return (error);
2059 st->flags &= ~ST_PER_ACTION;
2060
2061 bzero(&cmd, sizeof(cmd));
2062 cmd.opcode = REWIND;
2063 cmd.byte2 = immediate;
2064
2065 return (scsipi_command(st->sc_link,
2066 (struct scsipi_generic *)&cmd, sizeof(cmd), 0, 0, ST_RETRIES,
2067 immediate ? ST_CTL_TIME: ST_SPC_TIME, NULL, flags));
2068 }
2069
2070 int
2071 st_rdpos(st, hard, blkptr)
2072 struct st_softc *st;
2073 int hard;
2074 u_int32_t *blkptr;
2075 {
2076 int error;
2077 u_int8_t posdata[20];
2078 struct scsi_tape_read_position cmd;
2079
2080 /*
2081 * First flush any pending writes...
2082 */
2083 error = st_write_filemarks(st, 0, SCSI_SILENT);
2084
2085 /*
2086 * The latter case is for 'write protected' tapes
2087 * which are too stupid to recognize a zero count
2088 * for writing filemarks as a no-op.
2089 */
2090 if (error != 0 && error != EACCES && error != EROFS)
2091 return (error);
2092
2093 bzero(&cmd, sizeof(cmd));
2094 bzero(&posdata, sizeof(posdata));
2095 cmd.opcode = READ_POSITION;
2096 if (hard)
2097 cmd.byte1 = 1;
2098
2099 error = scsipi_command(st->sc_link,
2100 (struct scsipi_generic *)&cmd, sizeof(cmd), (u_char *)&posdata,
2101 sizeof(posdata), ST_RETRIES, ST_CTL_TIME, NULL,
2102 SCSI_SILENT | SCSI_DATA_IN);
2103
2104 if (error == 0) {
2105 #if 0
2106 printf("posdata:");
2107 for (hard = 0; hard < sizeof(posdata); hard++)
2108 printf("%02x ", posdata[hard] & 0xff);
2109 printf("\n");
2110 #endif
2111 if (posdata[0] & 0x4) /* Block Position Unknown */
2112 error = EINVAL;
2113 else
2114 *blkptr = _4btol(&posdata[4]);
2115 }
2116 return (error);
2117 }
2118
2119 int
2120 st_setpos(st, hard, blkptr)
2121 struct st_softc *st;
2122 int hard;
2123 u_int32_t *blkptr;
2124 {
2125 int error;
2126 struct scsi_tape_locate cmd;
2127
2128 /*
2129 * First flush any pending writes. Strictly speaking,
2130 * we're not supposed to have to worry about this,
2131 * but let's be untrusting.
2132 */
2133 error = st_write_filemarks(st, 0, SCSI_SILENT);
2134
2135 /*
2136 * The latter case is for 'write protected' tapes
2137 * which are too stupid to recognize a zero count
2138 * for writing filemarks as a no-op.
2139 */
2140 if (error != 0 && error != EACCES && error != EROFS)
2141 return (error);
2142
2143 bzero(&cmd, sizeof(cmd));
2144 cmd.opcode = LOCATE;
2145 if (hard)
2146 cmd.byte2 = 1 << 2;
2147 _lto4b(*blkptr, cmd.blkaddr);
2148 error = scsipi_command(st->sc_link,
2149 (struct scsipi_generic *)&cmd, sizeof(cmd),
2150 NULL, 0, ST_RETRIES, ST_SPC_TIME, NULL, 0);
2151 /*
2152 * XXX: Note file && block number position now unknown (if
2153 * XXX: these things ever start being maintained in this driver)
2154 */
2155 return (error);
2156 }
2157
2158
2159 /*
2160 * Look at the returned sense and act on the error and determine
2161 * the unix error number to pass back..., 0 (== report no error),
2162 * -1 = retry the operation, -2 continue error processing.
2163 */
2164 int
2165 st_interpret_sense(xs)
2166 struct scsipi_xfer *xs;
2167 {
2168 struct scsipi_link *sc_link = xs->sc_link;
2169 struct scsipi_sense_data *sense = &xs->sense.scsi_sense;
2170 struct buf *bp = xs->bp;
2171 struct st_softc *st = sc_link->device_softc;
2172 int retval = SCSIRET_CONTINUE;
2173 int doprint = ((xs->flags & SCSI_SILENT) == 0);
2174 u_int8_t key;
2175 int32_t info;
2176
2177 /*
2178 * If it isn't a extended or extended/deferred error, let
2179 * the generic code handle it.
2180 */
2181 if ((sense->error_code & SSD_ERRCODE) != 0x70 &&
2182 (sense->error_code & SSD_ERRCODE) != 0x71) { /* DEFFERRED */
2183 return (retval);
2184 }
2185
2186 if (sense->error_code & SSD_ERRCODE_VALID)
2187 info = _4btol(sense->info);
2188 else
2189 info = xs->datalen; /* bad choice if fixed blocks */
2190 key = sense->flags & SSD_KEY;
2191 st->mt_erreg = key;
2192 st->mt_resid = (short) info;
2193
2194 /*
2195 * If the device is not open yet, let generic handle
2196 */
2197 if ((sc_link->flags & SDEV_OPEN) == 0) {
2198 return (retval);
2199 }
2200
2201
2202 if (st->flags & ST_FIXEDBLOCKS) {
2203 xs->resid = info * st->blksize;
2204 if (sense->flags & SSD_EOM) {
2205 if ((st->flags & ST_EARLYWARN) == 0)
2206 st->flags |= ST_EIO_PENDING;
2207 st->flags |= ST_EOM_PENDING;
2208 if (bp)
2209 bp->b_resid = xs->resid;
2210 }
2211 if (sense->flags & SSD_FILEMARK) {
2212 st->flags |= ST_AT_FILEMARK;
2213 if (bp)
2214 bp->b_resid = xs->resid;
2215 }
2216 if (sense->flags & SSD_ILI) {
2217 st->flags |= ST_EIO_PENDING;
2218 if (bp)
2219 bp->b_resid = xs->resid;
2220 if (sense->error_code & SSD_ERRCODE_VALID &&
2221 (xs->flags & SCSI_SILENT) == 0)
2222 printf("%s: block wrong size, %d blocks "
2223 "residual\n", st->sc_dev.dv_xname, info);
2224
2225 /*
2226 * This quirk code helps the drive read
2227 * the first tape block, regardless of
2228 * format. That is required for these
2229 * drives to return proper MODE SENSE
2230 * information.
2231 */
2232 if ((st->quirks & ST_Q_SENSE_HELP) &&
2233 !(sc_link->flags & SDEV_MEDIA_LOADED))
2234 st->blksize -= 512;
2235 }
2236 /*
2237 * If data wanted and no data was tranfered, do it immediatly
2238 */
2239 if (xs->datalen && xs->resid >= xs->datalen) {
2240 if (st->flags & ST_EIO_PENDING)
2241 return (EIO);
2242 if (st->flags & ST_AT_FILEMARK) {
2243 if (bp)
2244 bp->b_resid = xs->resid;
2245 return (SCSIRET_NOERROR);
2246 }
2247 }
2248 } else { /* must be variable mode */
2249 if (sense->flags & SSD_EOM) {
2250 /*
2251 * The current semantics of this
2252 * driver requires EOM detection
2253 * to return EIO unless early
2254 * warning detection is enabled
2255 * for variable mode (this is always
2256 * on for fixed block mode).
2257 */
2258 if (st->flags & ST_EARLYWARN) {
2259 st->flags |= ST_EOM_PENDING;
2260 retval = SCSIRET_NOERROR;
2261 } else {
2262 retval = EIO;
2263 }
2264
2265 /*
2266 * If it's an unadorned EOM detection,
2267 * suppress printing an error.
2268 */
2269 if (key == SKEY_NO_SENSE) {
2270 doprint = 0;
2271 }
2272 } else if (sense->flags & SSD_FILEMARK) {
2273 retval = SCSIRET_NOERROR;
2274 } else if (sense->flags & SSD_ILI) {
2275 if (info < 0) {
2276 /*
2277 * The tape record was bigger than the read
2278 * we issued.
2279 */
2280 if ((xs->flags & SCSI_SILENT) == 0) {
2281 printf("%s: %d-byte tape record too big"
2282 " for %d-byte user buffer\n",
2283 st->sc_dev.dv_xname,
2284 xs->datalen - info, xs->datalen);
2285 }
2286 retval = EIO;
2287 } else {
2288 retval = SCSIRET_NOERROR;
2289 }
2290 }
2291 xs->resid = info;
2292 if (bp)
2293 bp->b_resid = info;
2294 }
2295
2296 #ifndef SCSIDEBUG
2297 if (retval == SCSIRET_NOERROR && key == SKEY_NO_SENSE) {
2298 doprint = 0;
2299 }
2300 #endif
2301 if (key == SKEY_BLANK_CHECK) {
2302 /*
2303 * This quirk code helps the drive read the
2304 * first tape block, regardless of format. That
2305 * is required for these drives to return proper
2306 * MODE SENSE information.
2307 */
2308 if ((st->quirks & ST_Q_SENSE_HELP) &&
2309 !(sc_link->flags & SDEV_MEDIA_LOADED)) {
2310 /* still starting */
2311 st->blksize -= 512;
2312 } else if (!(st->flags & (ST_2FM_AT_EOD | ST_BLANK_READ))) {
2313 st->flags |= ST_BLANK_READ;
2314 xs->resid = xs->datalen;
2315 if (bp) {
2316 bp->b_resid = xs->resid;
2317 /* return an EOF */
2318 }
2319 retval = SCSIRET_NOERROR;
2320 }
2321 }
2322 #ifdef SCSIVERBOSE
2323 if (doprint) {
2324 scsipi_print_sense(xs, 0);
2325 }
2326 #else
2327 if (doprint) {
2328 xs->sc_link->sc_print_addr(xs->sc_link);
2329 printf("Sense Key 0x%02x", key);
2330 if ((sense->error_code & SSD_ERRCODE_VALID) != 0) {
2331 switch (key) {
2332 case SKEY_NOT_READY:
2333 case SKEY_ILLEGAL_REQUEST:
2334 case SKEY_UNIT_ATTENTION:
2335 case SKEY_WRITE_PROTECT:
2336 break;
2337 case SKEY_BLANK_CHECK:
2338 printf(", requested size: %d (decimal)", info);
2339 break;
2340 case SKEY_ABORTED_COMMAND:
2341 if (xs->retries)
2342 printf(", retrying");
2343 printf(", cmd 0x%x, info 0x%x",
2344 xs->cmd->opcode, info);
2345 break;
2346 default:
2347 printf(", info = %d (decimal)", info);
2348 }
2349 }
2350 if (sense->extra_len != 0) {
2351 int n;
2352 printf(", data =");
2353 for (n = 0; n < sense->extra_len; n++)
2354 printf(" %02x", sense->cmd_spec_info[n]);
2355 }
2356 printf("\n");
2357 }
2358 #endif
2359 return (retval);
2360 }
2361
2362 /*
2363 * The quirk here is that the drive returns some value to st_mode_sense
2364 * incorrectly until the tape has actually passed by the head.
2365 *
2366 * The method is to set the drive to large fixed-block state (user-specified
2367 * density and 1024-byte blocks), then read and rewind to get it to sense the
2368 * tape. If that doesn't work, try 512-byte fixed blocks. If that doesn't
2369 * work, as a last resort, try variable- length blocks. The result will be
2370 * the ability to do an accurate st_mode_sense.
2371 *
2372 * We know we can do a rewind because we just did a load, which implies rewind.
2373 * Rewind seems preferable to space backward if we have a virgin tape.
2374 *
2375 * The rest of the code for this quirk is in ILI processing and BLANK CHECK
2376 * error processing, both part of st_interpret_sense.
2377 */
2378 int
2379 st_touch_tape(st)
2380 struct st_softc *st;
2381 {
2382 char *buf;
2383 int readsize;
2384 int error;
2385
2386 buf = malloc(1024, M_TEMP, M_NOWAIT);
2387 if (buf == NULL)
2388 return (ENOMEM);
2389
2390 if ((error = st_mode_sense(st, 0)) != 0)
2391 goto bad;
2392 st->blksize = 1024;
2393 do {
2394 switch (st->blksize) {
2395 case 512:
2396 case 1024:
2397 readsize = st->blksize;
2398 st->flags |= ST_FIXEDBLOCKS;
2399 break;
2400 default:
2401 readsize = 1;
2402 st->flags &= ~ST_FIXEDBLOCKS;
2403 }
2404 if ((error = st_mode_select(st, 0)) != 0)
2405 goto bad;
2406 st_read(st, buf, readsize, SCSI_SILENT); /* XXX */
2407 if ((error = st_rewind(st, 0, 0)) != 0) {
2408 bad: free(buf, M_TEMP);
2409 return (error);
2410 }
2411 } while (readsize != 1 && readsize > st->blksize);
2412
2413 free(buf, M_TEMP);
2414 return (0);
2415 }
2416
2417 int
2418 stdump(dev, blkno, va, size)
2419 dev_t dev;
2420 daddr_t blkno;
2421 caddr_t va;
2422 size_t size;
2423 {
2424
2425 /* Not implemented. */
2426 return (ENXIO);
2427 }
2428