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.12 2005/06/03 21:56:23 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>
44 #include <machine/bus.h>
47 #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 cdevsw ast_cdevsw = {
61 /* flags */ D_TAPE | D_TRACKCLOSE,
68 /* write */ physwrite,
72 /* strategy */ aststrategy,
78 static int ast_sense(struct ast_softc *);
79 static void ast_describe(struct ast_softc *);
80 static int ast_done(struct atapi_request *);
81 static int ast_mode_sense(struct ast_softc *, int, void *, int);
82 static int ast_mode_select(struct ast_softc *, void *, int);
83 static int ast_write_filemark(struct ast_softc *, u_int8_t);
84 static int ast_read_position(struct ast_softc *, int, struct ast_readposition *);
85 static int ast_space(struct ast_softc *, u_int8_t, int32_t);
86 static int ast_locate(struct ast_softc *, int, u_int32_t);
87 static int ast_prevent_allow(struct ast_softc *stp, int);
88 static int ast_load_unload(struct ast_softc *, u_int8_t);
89 static int ast_rewind(struct ast_softc *);
90 static int ast_erase(struct ast_softc *);
93 static u_int32_t ast_lun_map = 0;
94 static u_int64_t ast_total = 0;
95 static MALLOC_DEFINE(M_AST, "AST driver", "ATAPI tape driver buffers");
98 astattach(struct ata_device *atadev)
100 struct ast_softc *stp;
101 struct ast_readposition position;
104 stp = malloc(sizeof(struct ast_softc), M_AST, M_WAITOK | M_ZERO);
106 ata_prtdev(atadev, "out of memory\n");
110 stp->device = atadev;
111 stp->lun = ata_get_lun(&ast_lun_map);
112 ata_set_name(atadev, "ast", stp->lun);
113 bufq_init(&stp->queue);
115 if (ast_sense(stp)) {
120 if (!strcmp(atadev->param->model, "OnStream DI-30")) {
121 struct ast_transferpage transfer;
122 struct ast_identifypage identify;
124 stp->flags |= F_ONSTREAM;
125 bzero(&transfer, sizeof(struct ast_transferpage));
126 ast_mode_sense(stp, ATAPI_TAPE_TRANSFER_PAGE,
127 &transfer, sizeof(transfer));
128 bzero(&identify, sizeof(struct ast_identifypage));
129 ast_mode_sense(stp, ATAPI_TAPE_IDENTIFY_PAGE,
130 &identify, sizeof(identify));
131 strncpy(identify.ident, "FBSD", 4);
132 ast_mode_select(stp, &identify, sizeof(identify));
133 ast_read_position(stp, 0, &position);
136 devstat_add_entry(&stp->stats, "ast", stp->lun, DEV_BSIZE,
137 DEVSTAT_NO_ORDERED_TAGS,
138 DEVSTAT_TYPE_SEQUENTIAL | DEVSTAT_TYPE_IF_IDE,
139 DEVSTAT_PRIORITY_TAPE);
140 cdevsw_add(&ast_cdevsw, dkunitmask(), dkmakeunit(stp->lun));
141 dev = make_dev(&ast_cdevsw, dkmakeminor(stp->lun, 0, 0),
142 UID_ROOT, GID_OPERATOR, 0640, "ast%d", stp->lun);
144 dev->si_iosize_max = 256 * DEV_BSIZE;
145 dev = make_dev(&ast_cdevsw, dkmakeminor(stp->lun, 0, 1),
146 UID_ROOT, GID_OPERATOR, 0640, "nast%d", stp->lun);
148 dev->si_iosize_max = 256 * DEV_BSIZE;
149 stp->device->flags |= ATA_D_MEDIA_CHANGED;
151 atadev->driver = stp;
156 astdetach(struct ata_device *atadev)
158 struct ast_softc *stp = atadev->driver;
161 while ((bp = bufq_first(&stp->queue))) {
162 bufq_remove(&stp->queue, bp);
163 bp->b_flags |= B_ERROR;
167 devstat_remove_entry(&stp->stats);
168 cdevsw_remove(&ast_cdevsw, dkunitmask(), dkmakeunit(stp->lun));
169 ata_free_name(atadev);
170 ata_free_lun(&ast_lun_map, stp->lun);
172 atadev->driver = NULL;
176 ast_sense(struct ast_softc *stp)
178 int count, error = 0;
180 /* get drive capabilities, some drives needs this repeated */
181 for (count = 0 ; count < 5 ; count++) {
182 if (!(error = ast_mode_sense(stp, ATAPI_TAPE_CAP_PAGE,
183 &stp->cap, sizeof(stp->cap)))) {
185 stp->blksize = 32768;
186 if (stp->cap.blk1024)
192 stp->cap.max_speed = ntohs(stp->cap.max_speed);
193 stp->cap.max_defects = ntohs(stp->cap.max_defects);
194 stp->cap.ctl = ntohs(stp->cap.ctl);
195 stp->cap.speed = ntohs(stp->cap.speed);
196 stp->cap.buffer_size = ntohs(stp->cap.buffer_size);
204 ast_describe(struct ast_softc *stp)
207 ata_prtdev(stp->device, "<%.40s/%.8s> tape drive at ata%d as %s\n",
208 stp->device->param->model, stp->device->param->revision,
209 device_get_unit(stp->device->channel->dev),
210 (stp->device->unit == ATA_MASTER) ? "master" : "slave");
211 ata_prtdev(stp->device, "%dKB/s, ", stp->cap.max_speed);
212 printf("transfer limit %d blk%s, ",
213 stp->cap.ctl, (stp->cap.ctl > 1) ? "s" : "");
214 printf("%dKB buffer, ", (stp->cap.buffer_size * DEV_BSIZE) / 1024);
215 printf("%s\n", ata_mode2str(stp->device->mode));
216 ata_prtdev(stp->device, "Medium: ");
217 switch (stp->cap.medium_type) {
219 printf("none"); break;
221 printf("Travan 1 (400 Mbyte)"); break;
223 printf("Travan 4 (4 Gbyte)"); break;
225 printf("OnStream ADR (15Gyte)"); break;
227 printf("unknown (0x%x)", stp->cap.medium_type);
229 if (stp->cap.readonly) printf(", readonly");
230 if (stp->cap.reverse) printf(", reverse");
231 if (stp->cap.eformat) printf(", eformat");
232 if (stp->cap.qfa) printf(", qfa");
233 if (stp->cap.lock) printf(", lock");
234 if (stp->cap.locked) printf(", locked");
235 if (stp->cap.prevent) printf(", prevent");
236 if (stp->cap.eject) printf(", eject");
237 if (stp->cap.disconnect) printf(", disconnect");
238 if (stp->cap.ecc) printf(", ecc");
239 if (stp->cap.compress) printf(", compress");
240 if (stp->cap.blk512) printf(", 512b");
241 if (stp->cap.blk1024) printf(", 1024b");
242 if (stp->cap.blk32k) printf(", 32kb");
246 ata_prtdev(stp->device, "TAPE <%.40s> at ata%d-%s %s\n",
247 stp->device->param->model,
248 device_get_unit(stp->device->channel->dev),
249 (stp->device->unit == ATA_MASTER) ? "master" : "slave",
250 ata_mode2str(stp->device->mode));
255 astopen(dev_t dev, int flags, int fmt, struct thread *td)
257 struct ast_softc *stp = dev->si_drv1;
262 if (count_dev(dev) > 1)
265 atapi_test_ready(stp->device);
268 ast_prevent_allow(stp, 1);
271 ata_prtdev(stp->device, "sense media type failed\n");
273 stp->device->flags &= ~ATA_D_MEDIA_CHANGED;
274 stp->flags &= ~(F_DATA_WRITTEN | F_FM_WRITTEN);
280 astclose(dev_t dev, int flags, int fmt, struct thread *td)
282 struct ast_softc *stp = dev->si_drv1;
284 /* flush buffers, some drives fail here, they should report ctl = 0 */
285 if (stp->cap.ctl && (stp->flags & F_DATA_WRITTEN))
286 ast_write_filemark(stp, 0);
288 /* write filemark if data written to tape */
289 if (!(stp->flags & F_ONSTREAM) &&
290 (stp->flags & (F_DATA_WRITTEN | F_FM_WRITTEN)) == F_DATA_WRITTEN)
291 ast_write_filemark(stp, WF_WRITE);
293 /* if minor is even rewind on close */
294 if (!(minor(dev) & 0x01))
297 if (stp->cap.lock && count_dev(dev) == 1)
298 ast_prevent_allow(stp, 0);
300 stp->flags &= F_CTL_WARN;
302 ata_prtdev(stp->device, "%llu total bytes transferred\n", ast_total);
308 astioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
310 struct ast_softc *stp = dev->si_drv1;
316 struct mtget *g = (struct mtget *) addr;
318 bzero(g, sizeof(struct mtget));
321 g->mt_blksiz = stp->blksize;
322 g->mt_comp = stp->cap.compress;
323 g->mt_density0 = 0; g->mt_density1 = 0;
324 g->mt_density2 = 0; g->mt_density3 = 0;
325 g->mt_blksiz0 = 0; g->mt_blksiz1 = 0;
326 g->mt_blksiz2 = 0; g->mt_blksiz3 = 0;
327 g->mt_comp0 = 0; g->mt_comp1 = 0;
328 g->mt_comp2 = 0; g->mt_comp3 = 0;
334 struct mtop *mt = (struct mtop *)addr;
336 switch ((int16_t) (mt->mt_op)) {
339 for (i=0; i < mt->mt_count && !error; i++)
340 error = ast_write_filemark(stp, WF_WRITE);
345 error = ast_space(stp, SP_FM, mt->mt_count);
350 error = ast_space(stp, SP_FM, -(mt->mt_count));
354 error = ast_rewind(stp);
358 error = ast_load_unload(stp, SS_EJECT);
362 error = ast_write_filemark(stp, 0);
366 error = ast_erase(stp);
370 error = ast_space(stp, SP_EOD, 0);
374 error = ast_load_unload(stp, SS_RETENSION | SS_LOAD);
391 struct ast_readposition position;
393 if ((error = ast_read_position(stp, 0, &position)))
395 *(u_int32_t *)addr = position.tape;
400 struct ast_readposition position;
402 if ((error = ast_read_position(stp, 1, &position)))
404 *(u_int32_t *)addr = position.tape;
408 error = ast_locate(stp, 0, *(u_int32_t *)addr);
411 error = ast_locate(stp, 1, *(u_int32_t *)addr);
420 aststrategy(struct buf *bp)
422 struct ast_softc *stp = bp->b_dev->si_drv1;
424 if (stp->device->flags & ATA_D_DETACHING) {
425 bp->b_flags |= B_ERROR;
431 /* if it's a null transfer, return immediatly. */
432 if (bp->b_bcount == 0) {
437 if (!(bp->b_flags & B_READ) && stp->flags & F_WRITEPROTECT) {
438 bp->b_flags |= B_ERROR;
444 /* check for != blocksize requests */
445 if (bp->b_bcount % stp->blksize) {
446 ata_prtdev(stp->device, "transfers must be multiple of %d\n",
448 bp->b_flags |= B_ERROR;
454 /* warn about transfers bigger than the device suggests */
455 if (bp->b_bcount > stp->blksize * stp->cap.ctl) {
456 if ((stp->flags & F_CTL_WARN) == 0) {
457 ata_prtdev(stp->device, "WARNING: CTL exceeded %ld>%d\n",
458 bp->b_bcount, stp->blksize * stp->cap.ctl);
459 stp->flags |= F_CTL_WARN;
464 bufq_insert_tail(&stp->queue, bp);
466 ata_start(stp->device->channel);
470 ast_start(struct ata_device *atadev)
472 struct ast_softc *stp = atadev->driver;
473 struct buf *bp = bufq_first(&stp->queue);
480 bzero(ccb, sizeof(ccb));
482 if (bp->b_flags & B_READ)
485 ccb[0] = ATAPI_WRITE;
487 bufq_remove(&stp->queue, bp);
488 blkcount = bp->b_bcount / stp->blksize;
491 ccb[2] = blkcount>>16;
492 ccb[3] = blkcount>>8;
495 devstat_start_transaction(&stp->stats);
497 atapi_queue_cmd(stp->device, ccb, bp->b_data, blkcount * stp->blksize,
498 (bp->b_flags & B_READ) ? ATPR_F_READ : 0,
503 ast_done(struct atapi_request *request)
505 struct buf *bp = request->driver;
506 struct ast_softc *stp = request->device->driver;
508 if (request->error) {
509 bp->b_error = request->error;
510 bp->b_flags |= B_ERROR;
513 if (!(bp->b_flags & B_READ))
514 stp->flags |= F_DATA_WRITTEN;
515 bp->b_resid = bp->b_bcount - request->donecount;
516 ast_total += (bp->b_bcount - bp->b_resid);
518 devstat_end_transaction_buf(&stp->stats, bp);
524 ast_mode_sense(struct ast_softc *stp, int page, void *pagebuf, int pagesize)
526 int8_t ccb[16] = { ATAPI_MODE_SENSE, 0x08, page, pagesize>>8, pagesize,
527 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
530 error = atapi_queue_cmd(stp->device, ccb, pagebuf, pagesize, ATPR_F_READ,
533 atapi_dump("ast: mode sense ", pagebuf, pagesize);
539 ast_mode_select(struct ast_softc *stp, void *pagebuf, int pagesize)
541 int8_t ccb[16] = { ATAPI_MODE_SELECT, 0x10, 0, pagesize>>8, pagesize,
542 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
545 ata_prtdev(stp->device, "modeselect pagesize=%d\n", pagesize);
546 atapi_dump("mode select ", pagebuf, pagesize);
548 return atapi_queue_cmd(stp->device, ccb, pagebuf, pagesize, 0,
553 ast_write_filemark(struct ast_softc *stp, u_int8_t function)
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 = atapi_queue_cmd(stp->device, ccb, NULL, 0, 0, 10, NULL, NULL);
572 return atapi_wait_dsc(stp->device, 10*60);
576 ast_read_position(struct ast_softc *stp, int hard,
577 struct ast_readposition *position)
579 int8_t ccb[16] = { ATAPI_READ_POSITION, (hard ? 0x01 : 0), 0, 0, 0, 0, 0, 0,
580 0, 0, 0, 0, 0, 0, 0, 0 };
583 error = atapi_queue_cmd(stp->device, ccb, (caddr_t)position,
584 sizeof(struct ast_readposition), ATPR_F_READ, 10,
586 position->tape = ntohl(position->tape);
587 position->host = ntohl(position->host);
592 ast_space(struct ast_softc *stp, u_int8_t function, int32_t count)
594 int8_t ccb[16] = { ATAPI_SPACE, function, count>>16, count>>8, count,
595 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
597 return atapi_queue_cmd(stp->device, ccb, NULL, 0, 0, 60*60, NULL, NULL);
601 ast_locate(struct ast_softc *stp, int hard, u_int32_t pos)
603 int8_t ccb[16] = { ATAPI_LOCATE, 0x01 | (hard ? 0x4 : 0), 0,
604 pos>>24, pos>>16, pos>>8, pos,
605 0, 0, 0, 0, 0, 0, 0, 0, 0 };
608 error = atapi_queue_cmd(stp->device, ccb, NULL, 0, 0, 10, NULL, NULL);
611 return atapi_wait_dsc(stp->device, 60*60);
615 ast_prevent_allow(struct ast_softc *stp, int lock)
617 int8_t ccb[16] = { ATAPI_PREVENT_ALLOW, 0, 0, 0, lock,
618 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
620 return atapi_queue_cmd(stp->device, ccb, NULL, 0, 0,30, NULL, NULL);
624 ast_load_unload(struct ast_softc *stp, u_int8_t function)
626 int8_t ccb[16] = { ATAPI_START_STOP, 0x01, 0, 0, function, 0, 0, 0,
627 0, 0, 0, 0, 0, 0, 0, 0 };
630 if ((function & SS_EJECT) && !stp->cap.eject)
632 error = atapi_queue_cmd(stp->device, ccb, NULL, 0, 0, 10, NULL, NULL);
635 tsleep((caddr_t)&error, 0, "astlu", 1 * hz);
636 if (function == SS_EJECT)
638 return atapi_wait_dsc(stp->device, 60*60);
642 ast_rewind(struct ast_softc *stp)
644 int8_t ccb[16] = { ATAPI_REZERO, 0x01, 0, 0, 0, 0, 0, 0,
645 0, 0, 0, 0, 0, 0, 0, 0 };
648 error = atapi_queue_cmd(stp->device, ccb, NULL, 0, 0, 10, NULL, NULL);
651 return atapi_wait_dsc(stp->device, 60*60);
655 ast_erase(struct ast_softc *stp)
657 int8_t ccb[16] = { ATAPI_ERASE, 3, 0, 0, 0, 0, 0, 0,
658 0, 0, 0, 0, 0, 0, 0, 0 };
661 if ((error = ast_rewind(stp)))
664 return atapi_queue_cmd(stp->device, ccb, NULL, 0, 0, 60*60, NULL, NULL);