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 $
29 * $DragonFly: src/sys/dev/disk/ata/atapi-tape.c,v 1.20 2006/12/22 23:26:15 swildner Exp $
33 #include <sys/param.h>
34 #include <sys/systm.h>
36 #include <sys/kernel.h>
38 #include <sys/malloc.h>
42 #include <sys/disklabel.h>
43 #include <sys/devicestat.h>
46 #include <sys/thread2.h>
49 #include "atapi-all.h"
50 #include "atapi-tape.h"
52 /* device structures */
53 static d_open_t astopen;
54 static d_close_t astclose;
55 static d_ioctl_t astioctl;
56 static d_strategy_t aststrategy;
58 static struct dev_ops ast_ops = {
59 { "ast", 119, D_TAPE | D_TRACKCLOSE },
65 .d_strategy = aststrategy
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 = kmalloc(sizeof(struct ast_softc), M_AST, M_WAITOK | 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 bioq_init(&stp->bio_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_ops_add(&ast_ops, dkunitmask(), dkmakeunit(stp->lun));
132 dev = make_dev(&ast_ops, dkmakeminor(stp->lun, 0, 0),
133 UID_ROOT, GID_OPERATOR, 0640, "ast%d", stp->lun);
135 dev->si_iosize_max = 256 * DEV_BSIZE;
136 dev = make_dev(&ast_ops, dkmakeminor(stp->lun, 0, 1),
137 UID_ROOT, GID_OPERATOR, 0640, "nast%d", stp->lun);
139 dev->si_iosize_max = 256 * DEV_BSIZE;
140 stp->device->flags |= ATA_D_MEDIA_CHANGED;
142 atadev->driver = stp;
147 astdetach(struct ata_device *atadev)
149 struct ast_softc *stp = atadev->driver;
153 while ((bio = bioq_first(&stp->bio_queue))) {
154 bioq_remove(&stp->bio_queue, bio);
156 bp->b_flags |= B_ERROR;
160 devstat_remove_entry(&stp->stats);
161 dev_ops_remove(&ast_ops, dkunitmask(), dkmakeunit(stp->lun));
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 kprintf("transfer limit %d blk%s, ",
206 stp->cap.ctl, (stp->cap.ctl > 1) ? "s" : "");
207 kprintf("%dKB buffer, ", (stp->cap.buffer_size * DEV_BSIZE) / 1024);
208 kprintf("%s\n", ata_mode2str(stp->device->mode));
209 ata_prtdev(stp->device, "Medium: ");
210 switch (stp->cap.medium_type) {
212 kprintf("none"); break;
214 kprintf("Travan 1 (400 Mbyte)"); break;
216 kprintf("Travan 4 (4 Gbyte)"); break;
218 kprintf("OnStream ADR (15Gyte)"); break;
220 kprintf("unknown (0x%x)", stp->cap.medium_type);
222 if (stp->cap.readonly) kprintf(", readonly");
223 if (stp->cap.reverse) kprintf(", reverse");
224 if (stp->cap.eformat) kprintf(", eformat");
225 if (stp->cap.qfa) kprintf(", qfa");
226 if (stp->cap.lock) kprintf(", lock");
227 if (stp->cap.locked) kprintf(", locked");
228 if (stp->cap.prevent) kprintf(", prevent");
229 if (stp->cap.eject) kprintf(", eject");
230 if (stp->cap.disconnect) kprintf(", disconnect");
231 if (stp->cap.ecc) kprintf(", ecc");
232 if (stp->cap.compress) kprintf(", compress");
233 if (stp->cap.blk512) kprintf(", 512b");
234 if (stp->cap.blk1024) kprintf(", 1024b");
235 if (stp->cap.blk32k) kprintf(", 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(struct dev_open_args *ap)
250 cdev_t dev = ap->a_head.a_dev;
251 struct ast_softc *stp = dev->si_drv1;
256 if (count_dev(dev) > 1)
259 atapi_test_ready(stp->device);
262 ast_prevent_allow(stp, 1);
265 ata_prtdev(stp->device, "sense media type failed\n");
267 stp->device->flags &= ~ATA_D_MEDIA_CHANGED;
268 stp->flags &= ~(F_DATA_WRITTEN | F_FM_WRITTEN);
274 astclose(struct dev_close_args *ap)
276 cdev_t dev = ap->a_head.a_dev;
277 struct ast_softc *stp = dev->si_drv1;
279 /* flush buffers, some drives fail here, they should report ctl = 0 */
280 if (stp->cap.ctl && (stp->flags & F_DATA_WRITTEN))
281 ast_write_filemark(stp, 0);
283 /* write filemark if data written to tape */
284 if (!(stp->flags & F_ONSTREAM) &&
285 (stp->flags & (F_DATA_WRITTEN | F_FM_WRITTEN)) == F_DATA_WRITTEN)
286 ast_write_filemark(stp, WF_WRITE);
288 /* if minor is even rewind on close */
289 if (!(minor(dev) & 0x01))
292 if (stp->cap.lock && count_dev(dev) == 1)
293 ast_prevent_allow(stp, 0);
295 stp->flags &= F_CTL_WARN;
297 ata_prtdev(stp->device, "%llu total bytes transferred\n", ast_total);
303 astioctl(struct dev_ioctl_args *ap)
305 cdev_t dev = ap->a_head.a_dev;
306 struct ast_softc *stp = dev->si_drv1;
312 struct mtget *g = (struct mtget *) ap->a_data;
314 bzero(g, sizeof(struct mtget));
317 g->mt_blksiz = stp->blksize;
318 g->mt_comp = stp->cap.compress;
319 g->mt_density0 = 0; g->mt_density1 = 0;
320 g->mt_density2 = 0; g->mt_density3 = 0;
321 g->mt_blksiz0 = 0; g->mt_blksiz1 = 0;
322 g->mt_blksiz2 = 0; g->mt_blksiz3 = 0;
323 g->mt_comp0 = 0; g->mt_comp1 = 0;
324 g->mt_comp2 = 0; g->mt_comp3 = 0;
330 struct mtop *mt = (struct mtop *)ap->a_data;
332 switch ((int16_t) (mt->mt_op)) {
335 for (i=0; i < mt->mt_count && !error; i++)
336 error = ast_write_filemark(stp, WF_WRITE);
341 error = ast_space(stp, SP_FM, mt->mt_count);
346 error = ast_space(stp, SP_FM, -(mt->mt_count));
350 error = ast_rewind(stp);
354 error = ast_load_unload(stp, SS_EJECT);
358 error = ast_write_filemark(stp, 0);
362 error = ast_erase(stp);
366 error = ast_space(stp, SP_EOD, 0);
370 error = ast_load_unload(stp, SS_RETENSION | SS_LOAD);
387 struct ast_readposition position;
389 if ((error = ast_read_position(stp, 0, &position)))
391 *(u_int32_t *)ap->a_data = position.tape;
396 struct ast_readposition position;
398 if ((error = ast_read_position(stp, 1, &position)))
400 *(u_int32_t *)ap->a_data = position.tape;
404 error = ast_locate(stp, 0, *(u_int32_t *)ap->a_data);
407 error = ast_locate(stp, 1, *(u_int32_t *)ap->a_data);
416 aststrategy(struct dev_strategy_args *ap)
418 cdev_t dev = ap->a_head.a_dev;
419 struct bio *bio = ap->a_bio;
420 struct buf *bp = bio->bio_buf;
421 struct ast_softc *stp = dev->si_drv1;
423 if (stp->device->flags & ATA_D_DETACHING) {
424 bp->b_flags |= B_ERROR;
430 /* if it's a null transfer, return immediatly. */
431 if (bp->b_bcount == 0) {
436 if (bp->b_cmd != BUF_CMD_READ && (stp->flags & F_WRITEPROTECT)) {
437 bp->b_flags |= B_ERROR;
443 /* check for != blocksize requests */
444 if (bp->b_bcount % stp->blksize) {
445 ata_prtdev(stp->device, "transfers must be multiple of %d\n",
447 bp->b_flags |= B_ERROR;
453 /* warn about transfers bigger than the device suggests */
454 if (bp->b_bcount > stp->blksize * stp->cap.ctl) {
455 if ((stp->flags & F_CTL_WARN) == 0) {
456 ata_prtdev(stp->device, "WARNING: CTL exceeded %d > %d\n",
457 bp->b_bcount, stp->blksize * stp->cap.ctl);
458 stp->flags |= F_CTL_WARN;
463 bioq_insert_tail(&stp->bio_queue, bio);
465 ata_start(stp->device->channel);
470 ast_start(struct ata_device *atadev)
472 struct ast_softc *stp = atadev->driver;
473 struct bio *bio = bioq_first(&stp->bio_queue);
480 bzero(ccb, sizeof(ccb));
483 if (bp->b_cmd == BUF_CMD_READ)
486 ccb[0] = ATAPI_WRITE;
488 bioq_remove(&stp->bio_queue, bio);
489 blkcount = bp->b_bcount / stp->blksize;
492 ccb[2] = blkcount>>16;
493 ccb[3] = blkcount>>8;
496 devstat_start_transaction(&stp->stats);
498 atapi_queue_cmd(stp->device, ccb, bp->b_data, blkcount * stp->blksize,
499 ((bp->b_cmd == BUF_CMD_READ) ? ATPR_F_READ : 0),
504 ast_done(struct atapi_request *request)
506 struct bio *bio = request->driver;
507 struct buf *bp = bio->bio_buf;
508 struct ast_softc *stp = request->device->driver;
510 if (request->error) {
511 bp->b_error = request->error;
512 bp->b_flags |= B_ERROR;
514 if (bp->b_cmd != BUF_CMD_READ)
515 stp->flags |= F_DATA_WRITTEN;
516 bp->b_resid = bp->b_bcount - request->donecount;
517 ast_total += (bp->b_bcount - bp->b_resid);
519 devstat_end_transaction_buf(&stp->stats, bp);
525 ast_mode_sense(struct ast_softc *stp, int page, void *pagebuf, int pagesize)
527 int8_t ccb[16] = { ATAPI_MODE_SENSE, 0x08, page, pagesize>>8, pagesize,
528 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
531 error = atapi_queue_cmd(stp->device, ccb, pagebuf, pagesize, ATPR_F_READ,
534 atapi_dump("ast: mode sense ", pagebuf, pagesize);
540 ast_mode_select(struct ast_softc *stp, void *pagebuf, int pagesize)
542 int8_t ccb[16] = { ATAPI_MODE_SELECT, 0x10, 0, pagesize>>8, pagesize,
543 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
546 ata_prtdev(stp->device, "modeselect pagesize=%d\n", pagesize);
547 atapi_dump("mode select ", pagebuf, pagesize);
549 return atapi_queue_cmd(stp->device, ccb, pagebuf, pagesize, 0,
554 ast_write_filemark(struct ast_softc *stp, u_int8_t function)
556 int8_t ccb[16] = { ATAPI_WEOF, 0x01, 0, 0, function, 0, 0, 0,
557 0, 0, 0, 0, 0, 0, 0, 0 };
560 if (stp->flags & F_ONSTREAM)
561 ccb[4] = 0x00; /* only flush buffers supported */
564 if (stp->flags & F_FM_WRITTEN)
565 stp->flags &= ~F_DATA_WRITTEN;
567 stp->flags |= F_FM_WRITTEN;
570 error = atapi_queue_cmd(stp->device, ccb, NULL, 0, 0, 10, NULL, NULL);
573 return atapi_wait_dsc(stp->device, 10*60);
577 ast_read_position(struct ast_softc *stp, int hard,
578 struct ast_readposition *position)
580 int8_t ccb[16] = { ATAPI_READ_POSITION, (hard ? 0x01 : 0), 0, 0, 0, 0, 0, 0,
581 0, 0, 0, 0, 0, 0, 0, 0 };
584 error = atapi_queue_cmd(stp->device, ccb, (caddr_t)position,
585 sizeof(struct ast_readposition), ATPR_F_READ, 10,
587 position->tape = ntohl(position->tape);
588 position->host = ntohl(position->host);
593 ast_space(struct ast_softc *stp, u_int8_t function, int32_t count)
595 int8_t ccb[16] = { ATAPI_SPACE, function, count>>16, count>>8, count,
596 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
598 return atapi_queue_cmd(stp->device, ccb, NULL, 0, 0, 60*60, NULL, NULL);
602 ast_locate(struct ast_softc *stp, int hard, u_int32_t pos)
604 int8_t ccb[16] = { ATAPI_LOCATE, 0x01 | (hard ? 0x4 : 0), 0,
605 pos>>24, pos>>16, pos>>8, pos,
606 0, 0, 0, 0, 0, 0, 0, 0, 0 };
609 error = atapi_queue_cmd(stp->device, ccb, NULL, 0, 0, 10, NULL, NULL);
612 return atapi_wait_dsc(stp->device, 60*60);
616 ast_prevent_allow(struct ast_softc *stp, int lock)
618 int8_t ccb[16] = { ATAPI_PREVENT_ALLOW, 0, 0, 0, lock,
619 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
621 return atapi_queue_cmd(stp->device, ccb, NULL, 0, 0,30, NULL, NULL);
625 ast_load_unload(struct ast_softc *stp, u_int8_t function)
627 int8_t ccb[16] = { ATAPI_START_STOP, 0x01, 0, 0, function, 0, 0, 0,
628 0, 0, 0, 0, 0, 0, 0, 0 };
631 if ((function & SS_EJECT) && !stp->cap.eject)
633 error = atapi_queue_cmd(stp->device, ccb, NULL, 0, 0, 10, NULL, NULL);
636 tsleep((caddr_t)&error, 0, "astlu", 1 * hz);
637 if (function == SS_EJECT)
639 return atapi_wait_dsc(stp->device, 60*60);
643 ast_rewind(struct ast_softc *stp)
645 int8_t ccb[16] = { ATAPI_REZERO, 0x01, 0, 0, 0, 0, 0, 0,
646 0, 0, 0, 0, 0, 0, 0, 0 };
649 error = atapi_queue_cmd(stp->device, ccb, NULL, 0, 0, 10, NULL, NULL);
652 return atapi_wait_dsc(stp->device, 60*60);
656 ast_erase(struct ast_softc *stp)
658 int8_t ccb[16] = { ATAPI_ERASE, 3, 0, 0, 0, 0, 0, 0,
659 0, 0, 0, 0, 0, 0, 0, 0 };
662 if ((error = ast_rewind(stp)))
665 return atapi_queue_cmd(stp->device, ccb, NULL, 0, 0, 60*60, NULL, NULL);