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.
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
31 #include <sys/param.h>
32 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/module.h>
36 #include <sys/malloc.h>
41 #include <sys/devicestat.h>
43 #include <sys/taskqueue.h>
45 #include <machine/bus.h>
46 #include <dev/ata/ata-all.h>
47 #include <dev/ata/atapi-tape.h>
50 /* device structure */
51 static d_open_t ast_open;
52 static d_close_t ast_close;
53 static d_ioctl_t ast_ioctl;
54 static d_strategy_t ast_strategy;
55 static struct cdevsw ast_cdevsw = {
56 .d_version = D_VERSION,
62 .d_strategy = ast_strategy,
64 .d_flags = D_TAPE | D_TRACKCLOSE,
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 if (!(stp = malloc(sizeof(struct ast_softc), M_AST, M_NOWAIT | M_ZERO))) {
110 device_printf(dev, "out of memory\n");
113 device_set_ivars(dev, stp);
114 ATA_SETMODE(device_get_parent(dev), dev);
116 if (ast_sense(dev)) {
117 device_set_ivars(dev, NULL);
121 if (!strcmp(atadev->param.model, "OnStream DI-30")) {
122 struct ast_transferpage transfer;
123 struct ast_identifypage identify;
125 stp->flags |= F_ONSTREAM;
126 bzero(&transfer, sizeof(struct ast_transferpage));
127 ast_mode_sense(dev, ATAPI_TAPE_TRANSFER_PAGE,
128 &transfer, sizeof(transfer));
129 bzero(&identify, sizeof(struct ast_identifypage));
130 ast_mode_sense(dev, ATAPI_TAPE_IDENTIFY_PAGE,
131 &identify, sizeof(identify));
132 strncpy(identify.ident, "FBSD", 4);
133 ast_mode_select(dev, &identify, sizeof(identify));
134 ast_read_position(dev, 0, &position);
137 stp->stats = devstat_new_entry("ast", device_get_unit(dev), DEV_BSIZE,
138 DEVSTAT_NO_ORDERED_TAGS,
139 DEVSTAT_TYPE_SEQUENTIAL | DEVSTAT_TYPE_IF_IDE,
140 DEVSTAT_PRIORITY_TAPE);
141 device = make_dev(&ast_cdevsw, 2 * device_get_unit(dev),
142 UID_ROOT, GID_OPERATOR, 0640, "ast%d",
143 device_get_unit(dev));
144 device->si_drv1 = dev;
146 device->si_iosize_max = ch->dma->max_iosize;
148 device->si_iosize_max = DFLTPHYS;
150 device = make_dev(&ast_cdevsw, 2 * device_get_unit(dev) + 1,
151 UID_ROOT, GID_OPERATOR, 0640, "nast%d",
152 device_get_unit(dev));
153 device->si_drv1 = dev;
155 device->si_iosize_max = ch->dma->max_iosize;
157 device->si_iosize_max = DFLTPHYS;
160 /* announce we are here and ready */
166 ast_detach(device_t dev)
168 struct ast_softc *stp = device_get_ivars(dev);
170 /* detroy devices from the system so we dont get any further requests */
171 destroy_dev(stp->dev1);
172 destroy_dev(stp->dev2);
174 /* fail requests on the queue and any thats "in flight" for this device */
175 ata_fail_requests(dev);
177 /* dont leave anything behind */
178 devstat_remove_entry(stp->stats);
179 device_set_ivars(dev, NULL);
185 ast_shutdown(device_t dev)
187 struct ata_device *atadev = device_get_softc(dev);
189 if (atadev->param.support.command2 & ATA_SUPPORT_FLUSHCACHE)
190 ata_controlcmd(dev, ATA_FLUSHCACHE, 0, 0, 0);
194 ast_reinit(device_t dev)
196 struct ata_channel *ch = device_get_softc(device_get_parent(dev));
197 struct ata_device *atadev = device_get_softc(dev);
198 struct ast_softc *stp = device_get_ivars(dev);
200 if (((atadev->unit == ATA_MASTER) && !(ch->devices & ATA_ATAPI_MASTER)) ||
201 ((atadev->unit == ATA_SLAVE) && !(ch->devices & ATA_ATAPI_SLAVE))) {
202 device_set_ivars(dev, NULL);
206 ATA_SETMODE(device_get_parent(dev), dev);
211 ast_open(struct cdev *cdev, int flags, int fmt, struct thread *td)
213 device_t dev = cdev->si_drv1;
214 struct ata_device *atadev = device_get_softc(dev);
215 struct ast_softc *stp = device_get_ivars(dev);
219 if (!device_is_attached(dev))
224 ast_prevent_allow(dev, 1);
226 device_printf(dev, "sense media type failed\n");
228 atadev->flags &= ~ATA_D_MEDIA_CHANGED;
229 stp->flags &= ~(F_DATA_WRITTEN | F_FM_WRITTEN);
235 ast_close(struct cdev *cdev, int flags, int fmt, struct thread *td)
237 device_t dev = cdev->si_drv1;
238 struct ast_softc *stp = device_get_ivars(dev);
240 /* flush buffers, some drives fail here, they should report ctl = 0 */
241 if (stp->cap.ctl && (stp->flags & F_DATA_WRITTEN))
242 ast_write_filemark(dev, 0);
244 /* write filemark if data written to tape */
245 if (!(stp->flags & F_ONSTREAM) &&
246 (stp->flags & (F_DATA_WRITTEN | F_FM_WRITTEN)) == F_DATA_WRITTEN)
247 ast_write_filemark(dev, ATAPI_WF_WRITE);
249 /* if minor is even rewind on close */
250 if (!(minor(cdev) & 0x01))
253 if (stp->cap.lock && count_dev(cdev) == 1)
254 ast_prevent_allow(dev, 0);
256 stp->flags &= ~F_CTL_WARN;
258 device_printf(dev, "%ju total bytes transferred\n", (uintmax_t)ast_total);
264 ast_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int flag, struct thread *td)
266 device_t dev = cdev->si_drv1;
267 struct ast_softc *stp = device_get_ivars(dev);
273 struct mtget *g = (struct mtget *) data;
275 bzero(g, sizeof(struct mtget));
278 g->mt_blksiz = stp->blksize;
279 g->mt_comp = stp->cap.compress;
280 g->mt_density0 = 0; g->mt_density1 = 0;
281 g->mt_density2 = 0; g->mt_density3 = 0;
282 g->mt_blksiz0 = 0; g->mt_blksiz1 = 0;
283 g->mt_blksiz2 = 0; g->mt_blksiz3 = 0;
284 g->mt_comp0 = 0; g->mt_comp1 = 0;
285 g->mt_comp2 = 0; g->mt_comp3 = 0;
292 struct mtop *mt = (struct mtop *)data;
294 switch ((int16_t) (mt->mt_op)) {
297 for (i=0; i < mt->mt_count && !error; i++)
298 error = ast_write_filemark(dev, ATAPI_WF_WRITE);
303 error = ast_space(dev, ATAPI_SP_FM, mt->mt_count);
308 error = ast_space(dev, ATAPI_SP_FM, -(mt->mt_count));
312 error = ast_rewind(dev);
316 error = ast_load_unload(dev, ATAPI_SS_EJECT);
320 error = ast_write_filemark(dev, 0);
324 error = ast_erase(dev);
328 error = ast_space(dev, ATAPI_SP_EOD, 0);
332 error = ast_load_unload(dev, ATAPI_SS_RETENSION|ATAPI_SS_LOAD);
350 struct ast_readposition position;
352 if ((error = ast_read_position(dev, 0, &position)))
354 *(u_int32_t *)data = position.tape;
360 struct ast_readposition position;
362 if ((error = ast_read_position(dev, 1, &position)))
364 *(u_int32_t *)data = position.tape;
369 error = ast_locate(dev, 0, *(u_int32_t *)data);
373 error = ast_locate(dev, 1, *(u_int32_t *)data);
377 error = ata_device_ioctl(dev, cmd, data);
383 ast_strategy(struct bio *bp)
385 device_t dev = bp->bio_dev->si_drv1;
386 struct ata_device *atadev = device_get_softc(dev);
387 struct ast_softc *stp = device_get_ivars(dev);
388 struct ata_request *request;
392 /* if it's a null transfer, return immediatly. */
393 if (bp->bio_bcount == 0) {
398 if (!(bp->bio_cmd == BIO_READ) && stp->flags & F_WRITEPROTECT) {
399 biofinish(bp, NULL, EPERM);
403 /* check for != blocksize requests */
404 if (bp->bio_bcount % stp->blksize) {
405 device_printf(dev, "transfers must be multiple of %d\n", stp->blksize);
406 biofinish(bp, NULL, EIO);
410 /* warn about transfers bigger than the device suggests */
411 if (bp->bio_bcount > stp->blksize * stp->cap.ctl) {
412 if ((stp->flags & F_CTL_WARN) == 0) {
413 device_printf(dev, "WARNING: CTL exceeded %ld>%d\n",
414 bp->bio_bcount, stp->blksize * stp->cap.ctl);
415 stp->flags |= F_CTL_WARN;
419 bzero(ccb, sizeof(ccb));
421 if (bp->bio_cmd == BIO_READ)
424 ccb[0] = ATAPI_WRITE;
426 blkcount = bp->bio_bcount / stp->blksize;
429 ccb[2] = blkcount >> 16;
430 ccb[3] = blkcount >> 8;
433 if (!(request = ata_alloc_request())) {
434 biofinish(bp, NULL, ENOMEM);
438 request->driver = bp;
439 bcopy(ccb, request->u.atapi.ccb,
440 (atadev->param.config & ATA_PROTO_MASK) ==
441 ATA_PROTO_ATAPI_12 ? 16 : 12);
442 request->data = bp->bio_data;
443 request->bytecount = blkcount * stp->blksize;
444 request->transfersize = min(request->bytecount, 65534);
445 request->timeout = (ccb[0] == ATAPI_WRITE_BIG) ? 180 : 120;
446 request->retries = 2;
447 request->callback = ast_done;
448 switch (bp->bio_cmd) {
450 request->flags |= (ATA_R_ATAPI | ATA_R_READ);
453 request->flags |= (ATA_R_ATAPI | ATA_R_WRITE);
456 device_printf(dev, "unknown BIO operation\n");
457 ata_free_request(request);
458 biofinish(bp, NULL, EIO);
461 devstat_start_transaction_bio(stp->stats, bp);
462 ata_queue_request(request);
466 ast_done(struct ata_request *request)
468 struct ast_softc *stp = device_get_ivars(request->dev);
469 struct bio *bp = request->driver;
471 /* finish up transfer */
472 if ((bp->bio_error = request->result))
473 bp->bio_flags |= BIO_ERROR;
474 if (bp->bio_cmd == BIO_WRITE)
475 stp->flags |= F_DATA_WRITTEN;
476 bp->bio_resid = bp->bio_bcount - request->donecount;
477 ast_total += (bp->bio_bcount - bp->bio_resid);
478 biofinish(bp, stp->stats, 0);
479 ata_free_request(request);
483 ast_sense(device_t dev)
485 struct ast_softc *stp = device_get_ivars(dev);
488 /* get drive capabilities, some bugridden drives needs this repeated */
489 for (count = 0 ; count < 5 ; count++) {
490 if (!ast_mode_sense(dev, ATAPI_TAPE_CAP_PAGE,
491 &stp->cap, sizeof(stp->cap)) &&
492 stp->cap.page_code == ATAPI_TAPE_CAP_PAGE) {
494 stp->blksize = 32768;
495 if (stp->cap.blk1024)
501 stp->cap.max_speed = ntohs(stp->cap.max_speed);
502 stp->cap.max_defects = ntohs(stp->cap.max_defects);
503 stp->cap.ctl = ntohs(stp->cap.ctl);
504 stp->cap.speed = ntohs(stp->cap.speed);
505 stp->cap.buffer_size = ntohs(stp->cap.buffer_size);
513 ast_mode_sense(device_t dev, int page, void *pagebuf, int pagesize)
515 int8_t ccb[16] = { ATAPI_MODE_SENSE, 0x08, page, pagesize>>8, pagesize,
516 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
519 error = ata_atapicmd(dev, ccb, pagebuf, pagesize, ATA_R_READ, 10);
524 ast_mode_select(device_t dev, void *pagebuf, int pagesize)
526 int8_t ccb[16] = { ATAPI_MODE_SELECT, 0x10, 0, pagesize>>8, pagesize,
527 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
529 return ata_atapicmd(dev, ccb, pagebuf, pagesize, 0, 10);
533 ast_write_filemark(device_t dev, u_int8_t function)
535 struct ast_softc *stp = device_get_ivars(dev);
536 int8_t ccb[16] = { ATAPI_WEOF, 0x01, 0, 0, function, 0, 0, 0,
537 0, 0, 0, 0, 0, 0, 0, 0 };
540 if (stp->flags & F_ONSTREAM)
541 ccb[4] = 0x00; /* only flush buffers supported */
544 if (stp->flags & F_FM_WRITTEN)
545 stp->flags &= ~F_DATA_WRITTEN;
547 stp->flags |= F_FM_WRITTEN;
550 error = ata_atapicmd(dev, ccb, NULL, 0, 0, 10);
553 return ast_wait_dsc(dev, 10*60);
557 ast_read_position(device_t dev, int hard, struct ast_readposition *position)
559 int8_t ccb[16] = { ATAPI_READ_POSITION, (hard ? 0x01 : 0), 0, 0, 0, 0, 0, 0,
560 0, 0, 0, 0, 0, 0, 0, 0 };
563 error = ata_atapicmd(dev, ccb, (caddr_t)position,
564 sizeof(struct ast_readposition), ATA_R_READ, 10);
565 position->tape = ntohl(position->tape);
566 position->host = ntohl(position->host);
571 ast_space(device_t dev, u_int8_t function, int32_t count)
573 int8_t ccb[16] = { ATAPI_SPACE, function, count>>16, count>>8, count,
574 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
576 return ata_atapicmd(dev, ccb, NULL, 0, 0, 60*60);
580 ast_locate(device_t dev, int hard, u_int32_t pos)
582 int8_t ccb[16] = { ATAPI_LOCATE, 0x01 | (hard ? 0x4 : 0), 0,
583 pos>>24, pos>>16, pos>>8, pos,
584 0, 0, 0, 0, 0, 0, 0, 0, 0 };
587 error = ata_atapicmd(dev, ccb, NULL, 0, 0, 10);
590 return ast_wait_dsc(dev, 60*60);
594 ast_prevent_allow(device_t dev, int lock)
596 int8_t ccb[16] = { ATAPI_PREVENT_ALLOW, 0, 0, 0, lock,
597 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
599 return ata_atapicmd(dev, ccb, NULL, 0, 0, 30);
603 ast_load_unload(device_t dev, u_int8_t function)
605 struct ast_softc *stp = device_get_ivars(dev);
606 int8_t ccb[16] = { ATAPI_START_STOP, 0x01, 0, 0, function, 0, 0, 0,
607 0, 0, 0, 0, 0, 0, 0, 0 };
610 if ((function & ATAPI_SS_EJECT) && !stp->cap.eject)
612 error = ata_atapicmd(dev, ccb, NULL, 0, 0, 10);
615 tsleep((caddr_t)&error, PRIBIO, "astlu", 1 * hz);
616 if (function == ATAPI_SS_EJECT)
618 return ast_wait_dsc(dev, 60*60);
622 ast_rewind(device_t dev)
624 int8_t ccb[16] = { ATAPI_REZERO, 0x01, 0, 0, 0, 0, 0, 0,
625 0, 0, 0, 0, 0, 0, 0, 0 };
628 error = ata_atapicmd(dev, ccb, NULL, 0, 0, 10);
631 return ast_wait_dsc(dev, 60*60);
635 ast_erase(device_t dev)
637 int8_t ccb[16] = { ATAPI_ERASE, 3, 0, 0, 0, 0, 0, 0,
638 0, 0, 0, 0, 0, 0, 0, 0 };
641 if ((error = ast_rewind(dev)))
644 return ata_atapicmd(dev, ccb, NULL, 0, 0, 60*60);
648 ast_test_ready(device_t dev)
650 int8_t ccb[16] = { ATAPI_TEST_UNIT_READY, 0, 0, 0, 0,
651 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
653 return ata_atapicmd(dev, ccb, NULL, 0, 0, 30);
657 ast_wait_dsc(device_t dev, int timeout)
660 int8_t ccb[16] = { ATAPI_POLL_DSC, 0, 0, 0, 0,
661 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
664 while (timeout > 0) {
665 error = ata_atapicmd(dev, ccb, NULL, 0, 0, 0);
668 tsleep(&error, PRIBIO, "atpwt", hz / 2);
675 ast_describe(device_t dev)
677 struct ata_channel *ch = device_get_softc(device_get_parent(dev));
678 struct ata_device *atadev = device_get_softc(dev);
679 struct ast_softc *stp = device_get_ivars(dev);
682 device_printf(dev, "<%.40s/%.8s> tape drive at ata%d as %s\n",
683 atadev->param.model, atadev->param.revision,
684 device_get_unit(ch->dev),
685 (atadev->unit == ATA_MASTER) ? "master" : "slave");
686 device_printf(dev, "%dKB/s, ", stp->cap.max_speed);
687 printf("transfer limit %d blk%s, ",
688 stp->cap.ctl, (stp->cap.ctl > 1) ? "s" : "");
689 printf("%dKB buffer, ", (stp->cap.buffer_size * DEV_BSIZE) / 1024);
690 printf("%s\n", ata_mode2str(atadev->mode));
691 device_printf(dev, "Medium: ");
692 switch (stp->cap.medium_type) {
694 printf("none"); break;
696 printf("Travan 1 (400 Mbyte)"); break;
698 printf("Travan 4 (4 Gbyte)"); break;
700 printf("OnStream ADR (15Gyte)"); break;
702 printf("unknown (0x%x)", stp->cap.medium_type);
704 if (stp->cap.readonly) printf(", readonly");
705 if (stp->cap.reverse) printf(", reverse");
706 if (stp->cap.eformat) printf(", eformat");
707 if (stp->cap.qfa) printf(", qfa");
708 if (stp->cap.lock) printf(", lock");
709 if (stp->cap.locked) printf(", locked");
710 if (stp->cap.prevent) printf(", prevent");
711 if (stp->cap.eject) printf(", eject");
712 if (stp->cap.disconnect) printf(", disconnect");
713 if (stp->cap.ecc) printf(", ecc");
714 if (stp->cap.compress) printf(", compress");
715 if (stp->cap.blk512) printf(", 512b");
716 if (stp->cap.blk1024) printf(", 1024b");
717 if (stp->cap.blk32k) printf(", 32kb");
721 device_printf(dev, "TAPE <%.40s/%.8s> at ata%d-%s %s\n",
722 atadev->param.model, atadev->param.revision,
723 device_get_unit(ch->dev),
724 (atadev->unit == ATA_MASTER) ? "master" : "slave",
725 ata_mode2str(atadev->mode));
729 static device_method_t ast_methods[] = {
730 /* device interface */
731 DEVMETHOD(device_probe, ast_probe),
732 DEVMETHOD(device_attach, ast_attach),
733 DEVMETHOD(device_detach, ast_detach),
734 DEVMETHOD(device_shutdown, ast_shutdown),
737 DEVMETHOD(ata_reinit, ast_reinit),
742 static driver_t ast_driver = {
748 static devclass_t ast_devclass;
750 DRIVER_MODULE(ast, ata, ast_driver, ast_devclass, NULL, NULL);
751 MODULE_VERSION(ast, 1);
752 MODULE_DEPEND(ast, ata, 1, 1, 1);