2 * Copyright (c) 1998,1999,2000,2001,2002 Søren Schmidt <sos@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer,
10 * without modification, immediately at the beginning of the file.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 * $FreeBSD: src/sys/dev/ata/atapi-tape.c,v 1.36.2.12 2002/07/31 11:19:26 sos Exp $
32 #include <sys/param.h>
33 #include <sys/systm.h>
35 #include <sys/kernel.h>
37 #include <sys/malloc.h>
41 #include <sys/disklabel.h>
42 #include <sys/devicestat.h>
43 #include <dev/ata/ata-all.h>
44 #include <dev/ata/atapi-all.h>
45 #include <dev/ata/atapi-tape.h>
47 /* device structures */
48 static d_open_t astopen;
49 static d_close_t astclose;
50 static d_ioctl_t astioctl;
51 static d_strategy_t aststrategy;
52 static struct cdevsw ast_cdevsw = {
56 /* write */ physwrite,
60 /* strategy */ aststrategy,
65 /* flags */ D_TAPE | D_TRACKCLOSE,
69 static int ast_sense(struct ast_softc *);
70 static void ast_describe(struct ast_softc *);
71 static int ast_done(struct atapi_request *);
72 static int ast_mode_sense(struct ast_softc *, int, void *, int);
73 static int ast_mode_select(struct ast_softc *, void *, int);
74 static int ast_write_filemark(struct ast_softc *, u_int8_t);
75 static int ast_read_position(struct ast_softc *, int, struct ast_readposition *);
76 static int ast_space(struct ast_softc *, u_int8_t, int32_t);
77 static int ast_locate(struct ast_softc *, int, u_int32_t);
78 static int ast_prevent_allow(struct ast_softc *stp, int);
79 static int ast_load_unload(struct ast_softc *, u_int8_t);
80 static int ast_rewind(struct ast_softc *);
81 static int ast_erase(struct ast_softc *);
84 static u_int32_t ast_lun_map = 0;
85 static u_int64_t ast_total = 0;
86 static MALLOC_DEFINE(M_AST, "AST driver", "ATAPI tape driver buffers");
89 astattach(struct ata_device *atadev)
91 struct ast_softc *stp;
92 struct ast_readposition position;
95 stp = malloc(sizeof(struct ast_softc), M_AST, M_NOWAIT | M_ZERO);
97 ata_prtdev(atadev, "out of memory\n");
101 stp->device = atadev;
102 stp->lun = ata_get_lun(&ast_lun_map);
103 ata_set_name(atadev, "ast", stp->lun);
104 bufq_init(&stp->queue);
106 if (ast_sense(stp)) {
111 if (!strcmp(atadev->param->model, "OnStream DI-30")) {
112 struct ast_transferpage transfer;
113 struct ast_identifypage identify;
115 stp->flags |= F_ONSTREAM;
116 bzero(&transfer, sizeof(struct ast_transferpage));
117 ast_mode_sense(stp, ATAPI_TAPE_TRANSFER_PAGE,
118 &transfer, sizeof(transfer));
119 bzero(&identify, sizeof(struct ast_identifypage));
120 ast_mode_sense(stp, ATAPI_TAPE_IDENTIFY_PAGE,
121 &identify, sizeof(identify));
122 strncpy(identify.ident, "FBSD", 4);
123 ast_mode_select(stp, &identify, sizeof(identify));
124 ast_read_position(stp, 0, &position);
127 devstat_add_entry(&stp->stats, "ast", stp->lun, DEV_BSIZE,
128 DEVSTAT_NO_ORDERED_TAGS,
129 DEVSTAT_TYPE_SEQUENTIAL | DEVSTAT_TYPE_IF_IDE,
130 DEVSTAT_PRIORITY_TAPE);
131 dev = make_dev(&ast_cdevsw, dkmakeminor(stp->lun, 0, 0),
132 UID_ROOT, GID_OPERATOR, 0640, "ast%d", stp->lun);
134 dev->si_iosize_max = 256 * DEV_BSIZE;
136 dev = make_dev(&ast_cdevsw, dkmakeminor(stp->lun, 0, 1),
137 UID_ROOT, GID_OPERATOR, 0640, "nast%d", stp->lun);
139 dev->si_iosize_max = 256 * DEV_BSIZE;
141 stp->device->flags |= ATA_D_MEDIA_CHANGED;
143 atadev->driver = stp;
148 astdetach(struct ata_device *atadev)
150 struct ast_softc *stp = atadev->driver;
153 while ((bp = bufq_first(&stp->queue))) {
154 bufq_remove(&stp->queue, bp);
155 bp->b_flags |= B_ERROR;
159 destroy_dev(stp->dev1);
160 destroy_dev(stp->dev2);
161 devstat_remove_entry(&stp->stats);
162 ata_free_name(atadev);
163 ata_free_lun(&ast_lun_map, stp->lun);
165 atadev->driver = NULL;
169 ast_sense(struct ast_softc *stp)
171 int count, error = 0;
173 /* get drive capabilities, some drives needs this repeated */
174 for (count = 0 ; count < 5 ; count++) {
175 if (!(error = ast_mode_sense(stp, ATAPI_TAPE_CAP_PAGE,
176 &stp->cap, sizeof(stp->cap)))) {
178 stp->blksize = 32768;
179 if (stp->cap.blk1024)
185 stp->cap.max_speed = ntohs(stp->cap.max_speed);
186 stp->cap.max_defects = ntohs(stp->cap.max_defects);
187 stp->cap.ctl = ntohs(stp->cap.ctl);
188 stp->cap.speed = ntohs(stp->cap.speed);
189 stp->cap.buffer_size = ntohs(stp->cap.buffer_size);
197 ast_describe(struct ast_softc *stp)
200 ata_prtdev(stp->device, "<%.40s/%.8s> tape drive at ata%d as %s\n",
201 stp->device->param->model, stp->device->param->revision,
202 device_get_unit(stp->device->channel->dev),
203 (stp->device->unit == ATA_MASTER) ? "master" : "slave");
204 ata_prtdev(stp->device, "%dKB/s, ", stp->cap.max_speed);
205 printf("transfer limit %d blk%s, ",
206 stp->cap.ctl, (stp->cap.ctl > 1) ? "s" : "");
207 printf("%dKB buffer, ", (stp->cap.buffer_size * DEV_BSIZE) / 1024);
208 printf("%s\n", ata_mode2str(stp->device->mode));
209 ata_prtdev(stp->device, "Medium: ");
210 switch (stp->cap.medium_type) {
212 printf("none"); break;
214 printf("Travan 1 (400 Mbyte)"); break;
216 printf("Travan 4 (4 Gbyte)"); break;
218 printf("OnStream ADR (15Gyte)"); break;
220 printf("unknown (0x%x)", stp->cap.medium_type);
222 if (stp->cap.readonly) printf(", readonly");
223 if (stp->cap.reverse) printf(", reverse");
224 if (stp->cap.eformat) printf(", eformat");
225 if (stp->cap.qfa) printf(", qfa");
226 if (stp->cap.lock) printf(", lock");
227 if (stp->cap.locked) printf(", locked");
228 if (stp->cap.prevent) printf(", prevent");
229 if (stp->cap.eject) printf(", eject");
230 if (stp->cap.disconnect) printf(", disconnect");
231 if (stp->cap.ecc) printf(", ecc");
232 if (stp->cap.compress) printf(", compress");
233 if (stp->cap.blk512) printf(", 512b");
234 if (stp->cap.blk1024) printf(", 1024b");
235 if (stp->cap.blk32k) printf(", 32kb");
239 ata_prtdev(stp->device, "TAPE <%.40s> at ata%d-%s %s\n",
240 stp->device->param->model,
241 device_get_unit(stp->device->channel->dev),
242 (stp->device->unit == ATA_MASTER) ? "master" : "slave",
243 ata_mode2str(stp->device->mode));
248 astopen(dev_t dev, int flags, int fmt, struct proc *p)
250 struct ast_softc *stp = dev->si_drv1;
255 if (count_dev(dev) > 1)
258 atapi_test_ready(stp->device);
261 ast_prevent_allow(stp, 1);
264 ata_prtdev(stp->device, "sense media type failed\n");
266 stp->device->flags &= ~ATA_D_MEDIA_CHANGED;
267 stp->flags &= ~(F_DATA_WRITTEN | F_FM_WRITTEN);
273 astclose(dev_t dev, int flags, int fmt, struct proc *p)
275 struct ast_softc *stp = dev->si_drv1;
277 /* flush buffers, some drives fail here, they should report ctl = 0 */
278 if (stp->cap.ctl && (stp->flags & F_DATA_WRITTEN))
279 ast_write_filemark(stp, 0);
281 /* write filemark if data written to tape */
282 if (!(stp->flags & F_ONSTREAM) &&
283 (stp->flags & (F_DATA_WRITTEN | F_FM_WRITTEN)) == F_DATA_WRITTEN)
284 ast_write_filemark(stp, WF_WRITE);
286 /* if minor is even rewind on close */
287 if (!(minor(dev) & 0x01))
290 if (stp->cap.lock && count_dev(dev) == 1)
291 ast_prevent_allow(stp, 0);
293 stp->flags &= F_CTL_WARN;
295 ata_prtdev(stp->device, "%llu total bytes transferred\n", ast_total);
301 astioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, struct proc *p)
303 struct ast_softc *stp = dev->si_drv1;
309 struct mtget *g = (struct mtget *) addr;
311 bzero(g, sizeof(struct mtget));
314 g->mt_blksiz = stp->blksize;
315 g->mt_comp = stp->cap.compress;
316 g->mt_density0 = 0; g->mt_density1 = 0;
317 g->mt_density2 = 0; g->mt_density3 = 0;
318 g->mt_blksiz0 = 0; g->mt_blksiz1 = 0;
319 g->mt_blksiz2 = 0; g->mt_blksiz3 = 0;
320 g->mt_comp0 = 0; g->mt_comp1 = 0;
321 g->mt_comp2 = 0; g->mt_comp3 = 0;
327 struct mtop *mt = (struct mtop *)addr;
329 switch ((int16_t) (mt->mt_op)) {
332 for (i=0; i < mt->mt_count && !error; i++)
333 error = ast_write_filemark(stp, WF_WRITE);
338 error = ast_space(stp, SP_FM, mt->mt_count);
343 error = ast_space(stp, SP_FM, -(mt->mt_count));
347 error = ast_rewind(stp);
351 error = ast_load_unload(stp, SS_EJECT);
355 error = ast_write_filemark(stp, 0);
359 error = ast_erase(stp);
363 error = ast_space(stp, SP_EOD, 0);
367 error = ast_load_unload(stp, SS_RETENSION | SS_LOAD);
384 struct ast_readposition position;
386 if ((error = ast_read_position(stp, 0, &position)))
388 *(u_int32_t *)addr = position.tape;
393 struct ast_readposition position;
395 if ((error = ast_read_position(stp, 1, &position)))
397 *(u_int32_t *)addr = position.tape;
401 error = ast_locate(stp, 0, *(u_int32_t *)addr);
404 error = ast_locate(stp, 1, *(u_int32_t *)addr);
413 aststrategy(struct buf *bp)
415 struct ast_softc *stp = bp->b_dev->si_drv1;
418 if (stp->device->flags & ATA_D_DETACHING) {
419 bp->b_flags |= B_ERROR;
425 /* if it's a null transfer, return immediatly. */
426 if (bp->b_bcount == 0) {
431 if (!(bp->b_flags & B_READ) && stp->flags & F_WRITEPROTECT) {
432 bp->b_flags |= B_ERROR;
438 /* check for != blocksize requests */
439 if (bp->b_bcount % stp->blksize) {
440 ata_prtdev(stp->device, "transfers must be multiple of %d\n",
442 bp->b_flags |= B_ERROR;
448 /* warn about transfers bigger than the device suggests */
449 if (bp->b_bcount > stp->blksize * stp->cap.ctl) {
450 if ((stp->flags & F_CTL_WARN) == 0) {
451 ata_prtdev(stp->device, "WARNING: CTL exceeded %ld>%d\n",
452 bp->b_bcount, stp->blksize * stp->cap.ctl);
453 stp->flags |= F_CTL_WARN;
458 bufq_insert_tail(&stp->queue, bp);
460 ata_start(stp->device->channel);
464 ast_start(struct ata_device *atadev)
466 struct ast_softc *stp = atadev->driver;
467 struct buf *bp = bufq_first(&stp->queue);
474 bzero(ccb, sizeof(ccb));
476 if (bp->b_flags & B_READ)
479 ccb[0] = ATAPI_WRITE;
481 bufq_remove(&stp->queue, bp);
482 blkcount = bp->b_bcount / stp->blksize;
485 ccb[2] = blkcount>>16;
486 ccb[3] = blkcount>>8;
489 devstat_start_transaction(&stp->stats);
491 atapi_queue_cmd(stp->device, ccb, bp->b_data, blkcount * stp->blksize,
492 (bp->b_flags & B_READ) ? ATPR_F_READ : 0,
497 ast_done(struct atapi_request *request)
499 struct buf *bp = request->driver;
500 struct ast_softc *stp = request->device->driver;
502 if (request->error) {
503 bp->b_error = request->error;
504 bp->b_flags |= B_ERROR;
507 if (!(bp->b_flags & B_READ))
508 stp->flags |= F_DATA_WRITTEN;
509 bp->b_resid = bp->b_bcount - request->donecount;
510 ast_total += (bp->b_bcount - bp->b_resid);
512 devstat_end_transaction_buf(&stp->stats, bp);
518 ast_mode_sense(struct ast_softc *stp, int page, void *pagebuf, int pagesize)
520 int8_t ccb[16] = { ATAPI_MODE_SENSE, 0x08, page, pagesize>>8, pagesize,
521 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
524 error = atapi_queue_cmd(stp->device, ccb, pagebuf, pagesize, ATPR_F_READ,
527 atapi_dump("ast: mode sense ", pagebuf, pagesize);
533 ast_mode_select(struct ast_softc *stp, void *pagebuf, int pagesize)
535 int8_t ccb[16] = { ATAPI_MODE_SELECT, 0x10, 0, pagesize>>8, pagesize,
536 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
539 ata_prtdev(stp->device, "modeselect pagesize=%d\n", pagesize);
540 atapi_dump("mode select ", pagebuf, pagesize);
542 return atapi_queue_cmd(stp->device, ccb, pagebuf, pagesize, 0,
547 ast_write_filemark(struct ast_softc *stp, u_int8_t function)
549 int8_t ccb[16] = { ATAPI_WEOF, 0x01, 0, 0, function, 0, 0, 0,
550 0, 0, 0, 0, 0, 0, 0, 0 };
553 if (stp->flags & F_ONSTREAM)
554 ccb[4] = 0x00; /* only flush buffers supported */
557 if (stp->flags & F_FM_WRITTEN)
558 stp->flags &= ~F_DATA_WRITTEN;
560 stp->flags |= F_FM_WRITTEN;
563 error = atapi_queue_cmd(stp->device, ccb, NULL, 0, 0, 10, NULL, NULL);
566 return atapi_wait_dsc(stp->device, 10*60);
570 ast_read_position(struct ast_softc *stp, int hard,
571 struct ast_readposition *position)
573 int8_t ccb[16] = { ATAPI_READ_POSITION, (hard ? 0x01 : 0), 0, 0, 0, 0, 0, 0,
574 0, 0, 0, 0, 0, 0, 0, 0 };
577 error = atapi_queue_cmd(stp->device, ccb, (caddr_t)position,
578 sizeof(struct ast_readposition), ATPR_F_READ, 10,
580 position->tape = ntohl(position->tape);
581 position->host = ntohl(position->host);
586 ast_space(struct ast_softc *stp, u_int8_t function, int32_t count)
588 int8_t ccb[16] = { ATAPI_SPACE, function, count>>16, count>>8, count,
589 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
591 return atapi_queue_cmd(stp->device, ccb, NULL, 0, 0, 60*60, NULL, NULL);
595 ast_locate(struct ast_softc *stp, int hard, u_int32_t pos)
597 int8_t ccb[16] = { ATAPI_LOCATE, 0x01 | (hard ? 0x4 : 0), 0,
598 pos>>24, pos>>16, pos>>8, pos,
599 0, 0, 0, 0, 0, 0, 0, 0, 0 };
602 error = atapi_queue_cmd(stp->device, ccb, NULL, 0, 0, 10, NULL, NULL);
605 return atapi_wait_dsc(stp->device, 60*60);
609 ast_prevent_allow(struct ast_softc *stp, int lock)
611 int8_t ccb[16] = { ATAPI_PREVENT_ALLOW, 0, 0, 0, lock,
612 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
614 return atapi_queue_cmd(stp->device, ccb, NULL, 0, 0,30, NULL, NULL);
618 ast_load_unload(struct ast_softc *stp, u_int8_t function)
620 int8_t ccb[16] = { ATAPI_START_STOP, 0x01, 0, 0, function, 0, 0, 0,
621 0, 0, 0, 0, 0, 0, 0, 0 };
624 if ((function & SS_EJECT) && !stp->cap.eject)
626 error = atapi_queue_cmd(stp->device, ccb, NULL, 0, 0, 10, NULL, NULL);
629 tsleep((caddr_t)&error, PRIBIO, "astlu", 1 * hz);
630 if (function == SS_EJECT)
632 return atapi_wait_dsc(stp->device, 60*60);
636 ast_rewind(struct ast_softc *stp)
638 int8_t ccb[16] = { ATAPI_REZERO, 0x01, 0, 0, 0, 0, 0, 0,
639 0, 0, 0, 0, 0, 0, 0, 0 };
642 error = atapi_queue_cmd(stp->device, ccb, NULL, 0, 0, 10, NULL, NULL);
645 return atapi_wait_dsc(stp->device, 60*60);
649 ast_erase(struct ast_softc *stp)
651 int8_t ccb[16] = { ATAPI_ERASE, 3, 0, 0, 0, 0, 0, 0,
652 0, 0, 0, 0, 0, 0, 0, 0 };
655 if ((error = ast_rewind(stp)))
658 return atapi_queue_cmd(stp->device, ccb, NULL, 0, 0, 60*60, NULL, NULL);