2 * Copyright (c) 1998 - 2006 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.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 * $FreeBSD: src/sys/dev/ata/atapi-tape.c,v 1.101 2006/01/05 21:27:19 sos Exp $
27 * $DragonFly: src/sys/dev/disk/nata/atapi-tape.c,v 1.2 2006/12/22 23:26:16 swildner Exp $
32 #include <sys/param.h>
37 #include <sys/device.h>
38 #include <sys/devicestat.h>
40 #include <sys/kernel.h>
41 #include <sys/libkern.h>
42 #include <sys/malloc.h>
43 #include <sys/module.h>
46 #include <sys/systm.h>
49 #include "atapi-tape.h"
52 /* device structure */
53 static d_open_t ast_open;
54 static d_close_t ast_close;
55 static d_ioctl_t ast_ioctl;
56 static d_strategy_t ast_strategy;
57 static struct dev_ops ast_ops = {
58 { "ast", 119, D_TAPE | D_TRACKCLOSE },
64 .d_strategy = ast_strategy
68 static int ast_sense(device_t);
69 static void ast_describe(device_t);
70 static void ast_done(struct ata_request *);
71 static int ast_mode_sense(device_t, int, void *, int);
72 static int ast_mode_select(device_t, void *, int);
73 static int ast_write_filemark(device_t, u_int8_t);
74 static int ast_read_position(device_t, int, struct ast_readposition *);
75 static int ast_space(device_t, u_int8_t, int32_t);
76 static int ast_locate(device_t, int, u_int32_t);
77 static int ast_prevent_allow(device_t, int);
78 static int ast_load_unload(device_t, u_int8_t);
79 static int ast_rewind(device_t);
80 static int ast_erase(device_t);
81 static int ast_test_ready(device_t);
82 static int ast_wait_dsc(device_t, int);
85 static u_int64_t ast_total = 0;
86 static MALLOC_DEFINE(M_AST, "ast_driver", "ATAPI tape driver buffers");
89 ast_probe(device_t dev)
91 struct ata_device *atadev = device_get_softc(dev);
93 if ((atadev->param.config & ATA_PROTO_ATAPI) &&
94 (atadev->param.config & ATA_ATAPI_TYPE_MASK) == ATA_ATAPI_TYPE_TAPE)
101 ast_attach(device_t dev)
103 struct ata_channel *ch = device_get_softc(device_get_parent(dev));
104 struct ata_device *atadev = device_get_softc(dev);
105 struct ast_softc *stp;
106 struct ast_readposition position;
109 /* XXX TGEN We're not in interrupt context, so we can M_WAITOK and remove
111 if (!(stp = kmalloc(sizeof(struct ast_softc), M_AST, M_NOWAIT | M_ZERO))) {
112 device_printf(dev, "out of memory\n");
115 device_set_ivars(dev, stp);
116 ATA_SETMODE(device_get_parent(dev), dev);
118 if (ast_sense(dev)) {
119 device_set_ivars(dev, NULL);
123 if (!strcmp(atadev->param.model, "OnStream DI-30")) {
124 struct ast_transferpage transfer;
125 struct ast_identifypage identify;
127 stp->flags |= F_ONSTREAM;
128 bzero(&transfer, sizeof(struct ast_transferpage));
129 ast_mode_sense(dev, ATAPI_TAPE_TRANSFER_PAGE,
130 &transfer, sizeof(transfer));
131 bzero(&identify, sizeof(struct ast_identifypage));
132 ast_mode_sense(dev, ATAPI_TAPE_IDENTIFY_PAGE,
133 &identify, sizeof(identify));
134 strncpy(identify.ident, "FBSD", 4);
135 ast_mode_select(dev, &identify, sizeof(identify));
136 ast_read_position(dev, 0, &position);
139 devstat_add_entry(&stp->stats, "ast", device_get_unit(dev), DEV_BSIZE,
140 DEVSTAT_NO_ORDERED_TAGS,
141 DEVSTAT_TYPE_SEQUENTIAL | DEVSTAT_TYPE_IF_IDE,
142 DEVSTAT_PRIORITY_TAPE);
143 dev_ops_add(&ast_ops, dkunitmask(), dkmakeunit(device_get_unit(dev)));
144 cdev = make_dev(&ast_ops, 2 * device_get_unit(dev), UID_ROOT, GID_OPERATOR,
145 0640, "ast%d", device_get_unit(dev));
149 cdev->si_iosize_max = ch->dma->max_iosize;
151 cdev->si_iosize_max = DFLTPHYS;
153 cdev = make_dev(&ast_ops, 2 * device_get_unit(dev) + 1, UID_ROOT,
154 GID_OPERATOR, 0640, "nast%d", device_get_unit(dev));
158 cdev->si_iosize_max = ch->dma->max_iosize;
160 cdev->si_iosize_max = DFLTPHYS;
163 /* announce we are here and ready */
169 ast_detach(device_t dev)
171 struct ast_softc *stp = device_get_ivars(dev);
173 /* detroy devices from the system so we dont get any further requests */
174 destroy_dev(stp->cdev1);
175 destroy_dev(stp->cdev2);
177 /* fail requests on the queue and any thats "in flight" for this device */
178 ata_fail_requests(dev);
180 /* dont leave anything behind */
181 dev_ops_remove(&ast_ops, dkunitmask(), dkmakeunit(device_get_unit(dev)));
182 devstat_remove_entry(&stp->stats);
183 device_set_ivars(dev, NULL);
189 ast_shutdown(device_t dev)
191 struct ata_device *atadev = device_get_softc(dev);
193 if (atadev->param.support.command2 & ATA_SUPPORT_FLUSHCACHE)
194 ata_controlcmd(dev, ATA_FLUSHCACHE, 0, 0, 0);
198 ast_reinit(device_t dev)
200 struct ata_channel *ch = device_get_softc(device_get_parent(dev));
201 struct ata_device *atadev = device_get_softc(dev);
202 struct ast_softc *stp = device_get_ivars(dev);
204 if (((atadev->unit == ATA_MASTER) && !(ch->devices & ATA_ATAPI_MASTER)) ||
205 ((atadev->unit == ATA_SLAVE) && !(ch->devices & ATA_ATAPI_SLAVE))) {
206 device_set_ivars(dev, NULL);
210 ATA_SETMODE(device_get_parent(dev), dev);
215 ast_open(struct dev_open_args *ap)
217 device_t dev = ap->a_head.a_dev->si_drv1;
218 struct ata_device *atadev = device_get_softc(dev);
219 struct ast_softc *stp = device_get_ivars(dev);
223 if (!device_is_attached(dev))
228 ast_prevent_allow(dev, 1);
230 device_printf(dev, "sense media type failed\n");
232 atadev->flags &= ~ATA_D_MEDIA_CHANGED;
233 stp->flags &= ~(F_DATA_WRITTEN | F_FM_WRITTEN);
239 ast_close(struct dev_close_args *ap)
241 device_t dev = ap->a_head.a_dev->si_drv1;
242 struct ast_softc *stp = device_get_ivars(dev);
243 cdev_t cdev = ap->a_head.a_dev;
245 /* flush buffers, some drives fail here, they should report ctl = 0 */
246 if (stp->cap.ctl && (stp->flags & F_DATA_WRITTEN))
247 ast_write_filemark(dev, 0);
249 /* write filemark if data written to tape */
250 if (!(stp->flags & F_ONSTREAM) &&
251 (stp->flags & (F_DATA_WRITTEN | F_FM_WRITTEN)) == F_DATA_WRITTEN)
252 ast_write_filemark(dev, ATAPI_WF_WRITE);
254 /* if minor is even rewind on close */
255 if (!(minor(cdev) & 0x01))
258 if (stp->cap.lock && count_dev(cdev) == 1)
259 ast_prevent_allow(dev, 0);
261 stp->flags &= ~F_CTL_WARN;
263 device_printf(dev, "%llu total bytes transferred\n",
264 (unsigned long long)ast_total);
270 ast_ioctl(struct dev_ioctl_args *ap)
272 device_t dev = ap->a_head.a_dev->si_drv1;
273 struct ast_softc *stp = device_get_ivars(dev);
279 struct mtget *g = (struct mtget *)ap->a_data;
281 bzero(g, sizeof(struct mtget));
284 g->mt_blksiz = stp->blksize;
285 g->mt_comp = stp->cap.compress;
286 g->mt_density0 = 0; g->mt_density1 = 0;
287 g->mt_density2 = 0; g->mt_density3 = 0;
288 g->mt_blksiz0 = 0; g->mt_blksiz1 = 0;
289 g->mt_blksiz2 = 0; g->mt_blksiz3 = 0;
290 g->mt_comp0 = 0; g->mt_comp1 = 0;
291 g->mt_comp2 = 0; g->mt_comp3 = 0;
298 struct mtop *mt = (struct mtop *)ap->a_data;
300 switch ((int16_t) (mt->mt_op)) {
303 for (i=0; i < mt->mt_count && !error; i++)
304 error = ast_write_filemark(dev, ATAPI_WF_WRITE);
309 error = ast_space(dev, ATAPI_SP_FM, mt->mt_count);
314 error = ast_space(dev, ATAPI_SP_FM, -(mt->mt_count));
318 error = ast_rewind(dev);
322 error = ast_load_unload(dev, ATAPI_SS_EJECT);
326 error = ast_write_filemark(dev, 0);
330 error = ast_erase(dev);
334 error = ast_space(dev, ATAPI_SP_EOD, 0);
338 error = ast_load_unload(dev, ATAPI_SS_RETENSION|ATAPI_SS_LOAD);
356 struct ast_readposition position;
358 if ((error = ast_read_position(dev, 0, &position)))
360 *(u_int32_t *)ap->a_data = position.tape;
366 struct ast_readposition position;
368 if ((error = ast_read_position(dev, 1, &position)))
370 *(u_int32_t *)ap->a_data = position.tape;
375 error = ast_locate(dev, 0, *(u_int32_t *)ap->a_data);
379 error = ast_locate(dev, 1, *(u_int32_t *)ap->a_data);
383 error = ata_device_ioctl(dev, ap->a_cmd, ap->a_data);
389 ast_strategy(struct dev_strategy_args *ap)
391 device_t dev = ap->a_head.a_dev->si_drv1;
392 struct bio *bp = ap->a_bio;
393 struct buf *bbp = bp->bio_buf;
394 struct ata_device *atadev = device_get_softc(dev);
395 struct ast_softc *stp = device_get_ivars(dev);
396 struct ata_request *request;
400 /* if it's a null transfer, return immediatly. */
401 if (bbp->b_bcount == 0) {
406 if (!(bbp->b_cmd == BUF_CMD_READ) && stp->flags & F_WRITEPROTECT) {
407 bbp->b_flags |= B_ERROR;
408 bbp->b_error = EPERM;
413 /* check for != blocksize requests */
414 if (bbp->b_bcount % stp->blksize) {
415 device_printf(dev, "transfers must be multiple of %d\n", stp->blksize);
416 bbp->b_flags |= B_ERROR;
422 /* warn about transfers bigger than the device suggests */
423 if (bbp->b_bcount > stp->blksize * stp->cap.ctl) {
424 if ((stp->flags & F_CTL_WARN) == 0) {
425 device_printf(dev, "WARNING: CTL exceeded %d>%d\n",
426 bbp->b_bcount, stp->blksize * stp->cap.ctl);
427 stp->flags |= F_CTL_WARN;
431 bzero(ccb, sizeof(ccb));
433 if (bbp->b_cmd == BUF_CMD_READ)
436 ccb[0] = ATAPI_WRITE;
438 blkcount = bbp->b_bcount / stp->blksize;
441 ccb[2] = blkcount >> 16;
442 ccb[3] = blkcount >> 8;
445 if (!(request = ata_alloc_request())) {
446 bbp->b_flags |= B_ERROR;
447 bbp->b_error = ENOMEM;
453 bcopy(ccb, request->u.atapi.ccb,
454 (atadev->param.config & ATA_PROTO_MASK) ==
455 ATA_PROTO_ATAPI_12 ? 16 : 12);
456 request->data = bbp->b_data;
457 request->bytecount = blkcount * stp->blksize;
458 request->transfersize = min(request->bytecount, 65534);
459 request->timeout = (ccb[0] == ATAPI_WRITE_BIG) ? 180 : 120;
460 request->retries = 2;
461 request->callback = ast_done;
462 switch (bbp->b_cmd) {
464 request->flags |= (ATA_R_ATAPI | ATA_R_READ);
467 request->flags |= (ATA_R_ATAPI | ATA_R_WRITE);
470 device_printf(dev, "unknown BUF operation\n");
471 ata_free_request(request);
472 bbp->b_flags |= B_ERROR;
477 devstat_start_transaction(&stp->stats);
478 ata_queue_request(request);
483 ast_done(struct ata_request *request)
485 struct ast_softc *stp = device_get_ivars(request->dev);
486 struct bio *bp = request->bio;
487 struct buf *bbp = bp->bio_buf;
489 /* finish up transfer */
490 if ((bbp->b_error = request->result))
491 bbp->b_flags |= B_ERROR;
492 if (bbp->b_cmd == BUF_CMD_WRITE)
493 stp->flags |= F_DATA_WRITTEN;
494 bbp->b_resid = bbp->b_bcount - request->donecount;
495 ast_total += (bbp->b_bcount - bbp->b_resid);
496 devstat_end_transaction_buf(&stp->stats, bbp);
498 ata_free_request(request);
502 ast_sense(device_t dev)
504 struct ast_softc *stp = device_get_ivars(dev);
507 /* get drive capabilities, some bugridden drives needs this repeated */
508 for (count = 0 ; count < 5 ; count++) {
509 if (!ast_mode_sense(dev, ATAPI_TAPE_CAP_PAGE,
510 &stp->cap, sizeof(stp->cap)) &&
511 stp->cap.page_code == ATAPI_TAPE_CAP_PAGE) {
513 stp->blksize = 32768;
514 if (stp->cap.blk1024)
520 stp->cap.max_speed = ntohs(stp->cap.max_speed);
521 stp->cap.max_defects = ntohs(stp->cap.max_defects);
522 stp->cap.ctl = ntohs(stp->cap.ctl);
523 stp->cap.speed = ntohs(stp->cap.speed);
524 stp->cap.buffer_size = ntohs(stp->cap.buffer_size);
532 ast_mode_sense(device_t dev, int page, void *pagebuf, int pagesize)
534 int8_t ccb[16] = { ATAPI_MODE_SENSE, 0x08, page, pagesize>>8, pagesize,
535 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
538 error = ata_atapicmd(dev, ccb, pagebuf, pagesize, ATA_R_READ, 10);
543 ast_mode_select(device_t dev, void *pagebuf, int pagesize)
545 int8_t ccb[16] = { ATAPI_MODE_SELECT, 0x10, 0, pagesize>>8, pagesize,
546 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
548 return ata_atapicmd(dev, ccb, pagebuf, pagesize, 0, 10);
552 ast_write_filemark(device_t dev, u_int8_t function)
554 struct ast_softc *stp = device_get_ivars(dev);
555 int8_t ccb[16] = { ATAPI_WEOF, 0x01, 0, 0, function, 0, 0, 0,
556 0, 0, 0, 0, 0, 0, 0, 0 };
559 if (stp->flags & F_ONSTREAM)
560 ccb[4] = 0x00; /* only flush buffers supported */
563 if (stp->flags & F_FM_WRITTEN)
564 stp->flags &= ~F_DATA_WRITTEN;
566 stp->flags |= F_FM_WRITTEN;
569 error = ata_atapicmd(dev, ccb, NULL, 0, 0, 10);
572 return ast_wait_dsc(dev, 10*60);
576 ast_read_position(device_t dev, int hard, struct ast_readposition *position)
578 int8_t ccb[16] = { ATAPI_READ_POSITION, (hard ? 0x01 : 0), 0, 0, 0, 0, 0, 0,
579 0, 0, 0, 0, 0, 0, 0, 0 };
582 error = ata_atapicmd(dev, ccb, (caddr_t)position,
583 sizeof(struct ast_readposition), ATA_R_READ, 10);
584 position->tape = ntohl(position->tape);
585 position->host = ntohl(position->host);
590 ast_space(device_t dev, u_int8_t function, int32_t count)
592 int8_t ccb[16] = { ATAPI_SPACE, function, count>>16, count>>8, count,
593 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
595 return ata_atapicmd(dev, ccb, NULL, 0, 0, 60*60);
599 ast_locate(device_t dev, int hard, u_int32_t pos)
601 int8_t ccb[16] = { ATAPI_LOCATE, 0x01 | (hard ? 0x4 : 0), 0,
602 pos>>24, pos>>16, pos>>8, pos,
603 0, 0, 0, 0, 0, 0, 0, 0, 0 };
606 error = ata_atapicmd(dev, ccb, NULL, 0, 0, 10);
609 return ast_wait_dsc(dev, 60*60);
613 ast_prevent_allow(device_t dev, int lock)
615 int8_t ccb[16] = { ATAPI_PREVENT_ALLOW, 0, 0, 0, lock,
616 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
618 return ata_atapicmd(dev, ccb, NULL, 0, 0, 30);
622 ast_load_unload(device_t dev, u_int8_t function)
624 struct ast_softc *stp = device_get_ivars(dev);
625 int8_t ccb[16] = { ATAPI_START_STOP, 0x01, 0, 0, function, 0, 0, 0,
626 0, 0, 0, 0, 0, 0, 0, 0 };
629 if ((function & ATAPI_SS_EJECT) && !stp->cap.eject)
631 error = ata_atapicmd(dev, ccb, NULL, 0, 0, 10);
634 tsleep((caddr_t)&error, 0, "astlu", 1 * hz);
635 if (function == ATAPI_SS_EJECT)
637 return ast_wait_dsc(dev, 60*60);
641 ast_rewind(device_t dev)
643 int8_t ccb[16] = { ATAPI_REZERO, 0x01, 0, 0, 0, 0, 0, 0,
644 0, 0, 0, 0, 0, 0, 0, 0 };
647 error = ata_atapicmd(dev, ccb, NULL, 0, 0, 10);
650 return ast_wait_dsc(dev, 60*60);
654 ast_erase(device_t dev)
656 int8_t ccb[16] = { ATAPI_ERASE, 3, 0, 0, 0, 0, 0, 0,
657 0, 0, 0, 0, 0, 0, 0, 0 };
660 if ((error = ast_rewind(dev)))
663 return ata_atapicmd(dev, ccb, NULL, 0, 0, 60*60);
667 ast_test_ready(device_t dev)
669 int8_t ccb[16] = { ATAPI_TEST_UNIT_READY, 0, 0, 0, 0,
670 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
672 return ata_atapicmd(dev, ccb, NULL, 0, 0, 30);
676 ast_wait_dsc(device_t dev, int timeout)
679 int8_t ccb[16] = { ATAPI_POLL_DSC, 0, 0, 0, 0,
680 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
683 while (timeout > 0) {
684 error = ata_atapicmd(dev, ccb, NULL, 0, 0, 0);
687 tsleep(&error, 0, "atpwt", hz / 2);
694 ast_describe(device_t dev)
696 struct ata_channel *ch = device_get_softc(device_get_parent(dev));
697 struct ata_device *atadev = device_get_softc(dev);
698 struct ast_softc *stp = device_get_ivars(dev);
701 device_printf(dev, "<%.40s/%.8s> tape drive at ata%d as %s\n",
702 atadev->param.model, atadev->param.revision,
703 device_get_unit(ch->dev),
704 (atadev->unit == ATA_MASTER) ? "master" : "slave");
705 device_printf(dev, "%dKB/s, ", stp->cap.max_speed);
706 kprintf("transfer limit %d blk%s, ",
707 stp->cap.ctl, (stp->cap.ctl > 1) ? "s" : "");
708 kprintf("%dKB buffer, ", (stp->cap.buffer_size * DEV_BSIZE) / 1024);
709 kprintf("%s\n", ata_mode2str(atadev->mode));
710 device_printf(dev, "Medium: ");
711 switch (stp->cap.medium_type) {
713 kprintf("none"); break;
715 kprintf("Travan 1 (400 Mbyte)"); break;
717 kprintf("Travan 4 (4 Gbyte)"); break;
719 kprintf("OnStream ADR (15Gyte)"); break;
721 kprintf("unknown (0x%x)", stp->cap.medium_type);
723 if (stp->cap.readonly) kprintf(", readonly");
724 if (stp->cap.reverse) kprintf(", reverse");
725 if (stp->cap.eformat) kprintf(", eformat");
726 if (stp->cap.qfa) kprintf(", qfa");
727 if (stp->cap.lock) kprintf(", lock");
728 if (stp->cap.locked) kprintf(", locked");
729 if (stp->cap.prevent) kprintf(", prevent");
730 if (stp->cap.eject) kprintf(", eject");
731 if (stp->cap.disconnect) kprintf(", disconnect");
732 if (stp->cap.ecc) kprintf(", ecc");
733 if (stp->cap.compress) kprintf(", compress");
734 if (stp->cap.blk512) kprintf(", 512b");
735 if (stp->cap.blk1024) kprintf(", 1024b");
736 if (stp->cap.blk32k) kprintf(", 32kb");
740 device_printf(dev, "TAPE <%.40s/%.8s> at ata%d-%s %s\n",
741 atadev->param.model, atadev->param.revision,
742 device_get_unit(ch->dev),
743 (atadev->unit == ATA_MASTER) ? "master" : "slave",
744 ata_mode2str(atadev->mode));
748 static device_method_t ast_methods[] = {
749 /* device interface */
750 DEVMETHOD(device_probe, ast_probe),
751 DEVMETHOD(device_attach, ast_attach),
752 DEVMETHOD(device_detach, ast_detach),
753 DEVMETHOD(device_shutdown, ast_shutdown),
756 DEVMETHOD(ata_reinit, ast_reinit),
761 static driver_t ast_driver = {
767 static devclass_t ast_devclass;
769 DRIVER_MODULE(ast, ata, ast_driver, ast_devclass, NULL, NULL);
770 MODULE_VERSION(ast, 1);
771 MODULE_DEPEND(ast, ata, 1, 1, 1);