2 * IDE ATAPI streaming tape driver.
4 * Copyright (C) 1995-1999 Gadi Oxman <gadio@netvision.net.il>
5 * Copyright (C) 2003-2005 Bartlomiej Zolnierkiewicz
7 * This driver was constructed as a student project in the software laboratory
8 * of the faculty of electrical engineering in the Technion - Israel's
9 * Institute Of Technology, with the guide of Avner Lottem and Dr. Ilana David.
11 * It is hereby placed under the terms of the GNU general public license.
12 * (See linux/COPYING).
14 * For a historical changelog see
15 * Documentation/ide/ChangeLog.ide-tape.1995-2002
18 #define DRV_NAME "ide-tape"
20 #define IDETAPE_VERSION "1.20"
22 #include <linux/module.h>
23 #include <linux/types.h>
24 #include <linux/string.h>
25 #include <linux/kernel.h>
26 #include <linux/delay.h>
27 #include <linux/timer.h>
29 #include <linux/interrupt.h>
30 #include <linux/jiffies.h>
31 #include <linux/major.h>
32 #include <linux/errno.h>
33 #include <linux/genhd.h>
34 #include <linux/slab.h>
35 #include <linux/pci.h>
36 #include <linux/ide.h>
37 #include <linux/smp_lock.h>
38 #include <linux/completion.h>
39 #include <linux/bitops.h>
40 #include <linux/mutex.h>
41 #include <scsi/scsi.h>
43 #include <asm/byteorder.h>
44 #include <linux/irq.h>
45 #include <linux/uaccess.h>
47 #include <asm/unaligned.h>
48 #include <linux/mtio.h>
51 /* output errors only */
53 /* output all sense key/asc */
55 /* info regarding all chrdev-related procedures */
56 DBG_CHRDEV = (1 << 2),
57 /* all remaining procedures */
61 /* define to see debug info */
62 #define IDETAPE_DEBUG_LOG 0
65 #define debug_log(lvl, fmt, args...) \
67 if (tape->debug_mask & lvl) \
68 printk(KERN_INFO "ide-tape: " fmt, ## args); \
71 #define debug_log(lvl, fmt, args...) do {} while (0)
74 /**************************** Tunable parameters *****************************/
76 * After each failed packet command we issue a request sense command and retry
77 * the packet command IDETAPE_MAX_PC_RETRIES times.
79 * Setting IDETAPE_MAX_PC_RETRIES to 0 will disable retries.
81 #define IDETAPE_MAX_PC_RETRIES 3
84 * The following parameter is used to select the point in the internal tape fifo
85 * in which we will start to refill the buffer. Decreasing the following
86 * parameter will improve the system's latency and interactive response, while
87 * using a high value might improve system throughput.
89 #define IDETAPE_FIFO_THRESHOLD 2
92 * DSC polling parameters.
94 * Polling for DSC (a single bit in the status register) is a very important
95 * function in ide-tape. There are two cases in which we poll for DSC:
97 * 1. Before a read/write packet command, to ensure that we can transfer data
98 * from/to the tape's data buffers, without causing an actual media access.
99 * In case the tape is not ready yet, we take out our request from the device
100 * request queue, so that ide.c could service requests from the other device
101 * on the same interface in the meantime.
103 * 2. After the successful initialization of a "media access packet command",
104 * which is a command that can take a long time to complete (the interval can
105 * range from several seconds to even an hour). Again, we postpone our request
106 * in the middle to free the bus for the other device. The polling frequency
107 * here should be lower than the read/write frequency since those media access
108 * commands are slow. We start from a "fast" frequency - IDETAPE_DSC_MA_FAST
109 * (1 second), and if we don't receive DSC after IDETAPE_DSC_MA_THRESHOLD
110 * (5 min), we switch it to a lower frequency - IDETAPE_DSC_MA_SLOW (1 min).
112 * We also set a timeout for the timer, in case something goes wrong. The
113 * timeout should be longer then the maximum execution time of a tape operation.
117 #define IDETAPE_DSC_RW_MIN 5*HZ/100 /* 50 msec */
118 #define IDETAPE_DSC_RW_MAX 40*HZ/100 /* 400 msec */
119 #define IDETAPE_DSC_RW_TIMEOUT 2*60*HZ /* 2 minutes */
120 #define IDETAPE_DSC_MA_FAST 2*HZ /* 2 seconds */
121 #define IDETAPE_DSC_MA_THRESHOLD 5*60*HZ /* 5 minutes */
122 #define IDETAPE_DSC_MA_SLOW 30*HZ /* 30 seconds */
123 #define IDETAPE_DSC_MA_TIMEOUT 2*60*60*HZ /* 2 hours */
125 /*************************** End of tunable parameters ***********************/
127 /* tape directions */
129 IDETAPE_DIR_NONE = (1 << 0),
130 IDETAPE_DIR_READ = (1 << 1),
131 IDETAPE_DIR_WRITE = (1 << 2),
134 /* Tape door status */
135 #define DOOR_UNLOCKED 0
136 #define DOOR_LOCKED 1
137 #define DOOR_EXPLICITLY_LOCKED 2
139 /* Some defines for the SPACE command */
140 #define IDETAPE_SPACE_OVER_FILEMARK 1
141 #define IDETAPE_SPACE_TO_EOD 3
143 /* Some defines for the LOAD UNLOAD command */
144 #define IDETAPE_LU_LOAD_MASK 1
145 #define IDETAPE_LU_RETENSION_MASK 2
146 #define IDETAPE_LU_EOT_MASK 4
148 /* Structures related to the SELECT SENSE / MODE SENSE packet commands. */
149 #define IDETAPE_BLOCK_DESCRIPTOR 0
150 #define IDETAPE_CAPABILITIES_PAGE 0x2a
153 * Most of our global data which we need to save even as we leave the driver due
154 * to an interrupt or a timer event is stored in the struct defined below.
156 typedef struct ide_tape_obj {
158 struct ide_driver *driver;
159 struct gendisk *disk;
162 /* used by REQ_IDETAPE_{READ,WRITE} requests */
163 struct ide_atapi_pc queued_pc;
166 * DSC polling variables.
168 * While polling for DSC we use postponed_rq to postpone the current
169 * request so that ide.c will be able to service pending requests on the
170 * other device. Note that at most we will have only one DSC (usually
171 * data transfer) request in the device request queue.
173 struct request *postponed_rq;
174 /* The time in which we started polling for DSC */
175 unsigned long dsc_polling_start;
176 /* Timer used to poll for dsc */
177 struct timer_list dsc_timer;
178 /* Read/Write dsc polling frequency */
179 unsigned long best_dsc_rw_freq;
180 unsigned long dsc_poll_freq;
181 unsigned long dsc_timeout;
183 /* Read position information */
186 unsigned int first_frame;
188 /* Last error information */
189 u8 sense_key, asc, ascq;
191 /* Character device operation */
195 /* Current character device data transfer direction */
198 /* tape block size, usually 512 or 1024 bytes */
199 unsigned short blk_size;
202 /* Copy of the tape's Capabilities and Mechanical Page */
206 * Active data transfer request parameters.
208 * At most, there is only one ide-tape originated data transfer request
209 * in the device request queue. This allows ide.c to easily service
210 * requests from the other device when we postpone our active request.
213 /* Data buffer size chosen based on the tape's recommendation */
215 /* Staging buffer of buffer_size bytes */
217 /* The read/write cursor */
219 /* The number of valid bytes in buf */
222 /* Measures average tape speed */
223 unsigned long avg_time;
227 /* the door is currently locked */
229 /* the tape hardware is write protected */
231 /* the tape is write protected (hardware or opened as read-only) */
237 static DEFINE_MUTEX(idetape_ref_mutex);
239 static struct class *idetape_sysfs_class;
241 static void ide_tape_release(struct device *);
243 static struct ide_tape_obj *ide_tape_get(struct gendisk *disk)
245 struct ide_tape_obj *tape = NULL;
247 mutex_lock(&idetape_ref_mutex);
248 tape = ide_drv_g(disk, ide_tape_obj);
250 if (ide_device_get(tape->drive))
253 get_device(&tape->dev);
255 mutex_unlock(&idetape_ref_mutex);
259 static void ide_tape_put(struct ide_tape_obj *tape)
261 ide_drive_t *drive = tape->drive;
263 mutex_lock(&idetape_ref_mutex);
264 put_device(&tape->dev);
265 ide_device_put(drive);
266 mutex_unlock(&idetape_ref_mutex);
270 * The variables below are used for the character device interface. Additional
271 * state variables are defined in our ide_drive_t structure.
273 static struct ide_tape_obj *idetape_devs[MAX_HWIFS * MAX_DRIVES];
275 static struct ide_tape_obj *ide_tape_chrdev_get(unsigned int i)
277 struct ide_tape_obj *tape = NULL;
279 mutex_lock(&idetape_ref_mutex);
280 tape = idetape_devs[i];
282 get_device(&tape->dev);
283 mutex_unlock(&idetape_ref_mutex);
288 * called on each failed packet command retry to analyze the request sense. We
289 * currently do not utilize this information.
291 static void idetape_analyze_error(ide_drive_t *drive, u8 *sense)
293 idetape_tape_t *tape = drive->driver_data;
294 struct ide_atapi_pc *pc = drive->failed_pc;
296 tape->sense_key = sense[2] & 0xF;
297 tape->asc = sense[12];
298 tape->ascq = sense[13];
300 debug_log(DBG_ERR, "pc = %x, sense key = %x, asc = %x, ascq = %x\n",
301 pc->c[0], tape->sense_key, tape->asc, tape->ascq);
303 /* Correct pc->xferred by asking the tape. */
304 if (pc->flags & PC_FLAG_DMA_ERROR)
305 pc->xferred = pc->req_xfer -
307 get_unaligned_be32(&sense[3]);
310 * If error was the result of a zero-length read or write command,
311 * with sense key=5, asc=0x22, ascq=0, let it slide. Some drives
312 * (i.e. Seagate STT3401A Travan) don't support 0-length read/writes.
314 if ((pc->c[0] == READ_6 || pc->c[0] == WRITE_6)
316 && pc->c[4] == 0 && pc->c[3] == 0 && pc->c[2] == 0) {
317 if (tape->sense_key == 5) {
318 /* don't report an error, everything's ok */
320 /* don't retry read/write */
321 pc->flags |= PC_FLAG_ABORT;
324 if (pc->c[0] == READ_6 && (sense[2] & 0x80)) {
325 pc->error = IDE_DRV_ERROR_FILEMARK;
326 pc->flags |= PC_FLAG_ABORT;
328 if (pc->c[0] == WRITE_6) {
329 if ((sense[2] & 0x40) || (tape->sense_key == 0xd
330 && tape->asc == 0x0 && tape->ascq == 0x2)) {
331 pc->error = IDE_DRV_ERROR_EOD;
332 pc->flags |= PC_FLAG_ABORT;
335 if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
336 if (tape->sense_key == 8) {
337 pc->error = IDE_DRV_ERROR_EOD;
338 pc->flags |= PC_FLAG_ABORT;
340 if (!(pc->flags & PC_FLAG_ABORT) &&
342 pc->retries = IDETAPE_MAX_PC_RETRIES + 1;
346 static void ide_tape_handle_dsc(ide_drive_t *);
348 static int ide_tape_callback(ide_drive_t *drive, int dsc)
350 idetape_tape_t *tape = drive->driver_data;
351 struct ide_atapi_pc *pc = drive->pc;
352 struct request *rq = drive->hwif->rq;
353 int uptodate = pc->error ? 0 : 1;
354 int err = uptodate ? 0 : IDE_DRV_ERROR_GENERAL;
356 debug_log(DBG_PROCS, "Enter %s\n", __func__);
359 ide_tape_handle_dsc(drive);
361 if (drive->failed_pc == pc)
362 drive->failed_pc = NULL;
364 if (pc->c[0] == REQUEST_SENSE) {
366 idetape_analyze_error(drive, pc->buf);
368 printk(KERN_ERR "ide-tape: Error in REQUEST SENSE "
369 "itself - Aborting request!\n");
370 } else if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
371 int blocks = pc->xferred / tape->blk_size;
373 tape->avg_size += blocks * tape->blk_size;
375 if (time_after_eq(jiffies, tape->avg_time + HZ)) {
376 tape->avg_speed = tape->avg_size * HZ /
377 (jiffies - tape->avg_time) / 1024;
379 tape->avg_time = jiffies;
382 tape->first_frame += blocks;
383 rq->data_len -= blocks * tape->blk_size;
389 } else if (pc->c[0] == READ_POSITION && uptodate) {
390 u8 *readpos = pc->buf;
392 debug_log(DBG_SENSE, "BOP - %s\n",
393 (readpos[0] & 0x80) ? "Yes" : "No");
394 debug_log(DBG_SENSE, "EOP - %s\n",
395 (readpos[0] & 0x40) ? "Yes" : "No");
397 if (readpos[0] & 0x4) {
398 printk(KERN_INFO "ide-tape: Block location is unknown"
400 clear_bit(IDE_AFLAG_ADDRESS_VALID, &drive->atapi_flags);
402 err = IDE_DRV_ERROR_GENERAL;
404 debug_log(DBG_SENSE, "Block Location - %u\n",
405 be32_to_cpup((__be32 *)&readpos[4]));
407 tape->partition = readpos[1];
408 tape->first_frame = be32_to_cpup((__be32 *)&readpos[4]);
409 set_bit(IDE_AFLAG_ADDRESS_VALID, &drive->atapi_flags);
419 * Postpone the current request so that ide.c will be able to service requests
420 * from another device on the same port while we are polling for DSC.
422 static void idetape_postpone_request(ide_drive_t *drive)
424 idetape_tape_t *tape = drive->driver_data;
426 debug_log(DBG_PROCS, "Enter %s\n", __func__);
428 tape->postponed_rq = drive->hwif->rq;
430 ide_stall_queue(drive, tape->dsc_poll_freq);
433 static void ide_tape_handle_dsc(ide_drive_t *drive)
435 idetape_tape_t *tape = drive->driver_data;
437 /* Media access command */
438 tape->dsc_polling_start = jiffies;
439 tape->dsc_poll_freq = IDETAPE_DSC_MA_FAST;
440 tape->dsc_timeout = jiffies + IDETAPE_DSC_MA_TIMEOUT;
441 /* Allow ide.c to handle other requests */
442 idetape_postpone_request(drive);
446 * Packet Command Interface
448 * The current Packet Command is available in drive->pc, and will not change
449 * until we finish handling it. Each packet command is associated with a
450 * callback function that will be called when the command is finished.
452 * The handling will be done in three stages:
454 * 1. ide_tape_issue_pc will send the packet command to the drive, and will set
455 * the interrupt handler to ide_pc_intr.
457 * 2. On each interrupt, ide_pc_intr will be called. This step will be
458 * repeated until the device signals us that no more interrupts will be issued.
460 * 3. ATAPI Tape media access commands have immediate status with a delayed
461 * process. In case of a successful initiation of a media access packet command,
462 * the DSC bit will be set when the actual execution of the command is finished.
463 * Since the tape drive will not issue an interrupt, we have to poll for this
464 * event. In this case, we define the request as "low priority request" by
465 * setting rq_status to IDETAPE_RQ_POSTPONED, set a timer to poll for DSC and
468 * ide.c will then give higher priority to requests which originate from the
469 * other device, until will change rq_status to RQ_ACTIVE.
471 * 4. When the packet command is finished, it will be checked for errors.
473 * 5. In case an error was found, we queue a request sense packet command in
474 * front of the request queue and retry the operation up to
475 * IDETAPE_MAX_PC_RETRIES times.
477 * 6. In case no error was found, or we decided to give up and not to retry
478 * again, the callback function will be called and then we will handle the next
482 static ide_startstop_t ide_tape_issue_pc(ide_drive_t *drive,
484 struct ide_atapi_pc *pc)
486 idetape_tape_t *tape = drive->driver_data;
488 if (drive->failed_pc == NULL && pc->c[0] != REQUEST_SENSE)
489 drive->failed_pc = pc;
491 /* Set the current packet command */
494 if (pc->retries > IDETAPE_MAX_PC_RETRIES ||
495 (pc->flags & PC_FLAG_ABORT)) {
496 unsigned int done = blk_rq_bytes(drive->hwif->rq);
499 * We will "abort" retrying a packet command in case legitimate
500 * error code was received (crossing a filemark, or end of the
501 * media, for example).
503 if (!(pc->flags & PC_FLAG_ABORT)) {
504 if (!(pc->c[0] == TEST_UNIT_READY &&
505 tape->sense_key == 2 && tape->asc == 4 &&
506 (tape->ascq == 1 || tape->ascq == 8))) {
507 printk(KERN_ERR "ide-tape: %s: I/O error, "
508 "pc = %2x, key = %2x, "
509 "asc = %2x, ascq = %2x\n",
510 tape->name, pc->c[0],
511 tape->sense_key, tape->asc,
515 pc->error = IDE_DRV_ERROR_GENERAL;
518 drive->failed_pc = NULL;
519 drive->pc_callback(drive, 0);
520 ide_complete_rq(drive, -EIO, done);
523 debug_log(DBG_SENSE, "Retry #%d, cmd = %02X\n", pc->retries, pc->c[0]);
527 return ide_issue_pc(drive, cmd);
530 /* A mode sense command is used to "sense" tape parameters. */
531 static void idetape_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
534 pc->c[0] = MODE_SENSE;
535 if (page_code != IDETAPE_BLOCK_DESCRIPTOR)
536 /* DBD = 1 - Don't return block descriptors */
538 pc->c[2] = page_code;
540 * Changed pc->c[3] to 0 (255 will at best return unused info).
542 * For SCSI this byte is defined as subpage instead of high byte
543 * of length and some IDE drives seem to interpret it this way
544 * and return an error when 255 is used.
547 /* We will just discard data in that case */
549 if (page_code == IDETAPE_BLOCK_DESCRIPTOR)
551 else if (page_code == IDETAPE_CAPABILITIES_PAGE)
557 static ide_startstop_t idetape_media_access_finished(ide_drive_t *drive)
559 ide_hwif_t *hwif = drive->hwif;
560 idetape_tape_t *tape = drive->driver_data;
561 struct ide_atapi_pc *pc = drive->pc;
564 stat = hwif->tp_ops->read_status(hwif);
566 if (stat & ATA_DSC) {
567 if (stat & ATA_ERR) {
569 if (pc->c[0] != TEST_UNIT_READY)
570 printk(KERN_ERR "ide-tape: %s: I/O error, ",
572 /* Retry operation */
578 pc->error = IDE_DRV_ERROR_GENERAL;
579 drive->failed_pc = NULL;
581 drive->pc_callback(drive, 0);
585 static void ide_tape_create_rw_cmd(idetape_tape_t *tape,
586 struct ide_atapi_pc *pc, struct request *rq,
589 unsigned int length = rq->nr_sectors;
592 put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
596 pc->buf_size = length * tape->blk_size;
597 pc->req_xfer = pc->buf_size;
598 if (pc->req_xfer == tape->buffer_size)
599 pc->flags |= PC_FLAG_DMA_OK;
601 if (opcode == READ_6)
603 else if (opcode == WRITE_6) {
605 pc->flags |= PC_FLAG_WRITING;
608 memcpy(rq->cmd, pc->c, 12);
611 static ide_startstop_t idetape_do_request(ide_drive_t *drive,
612 struct request *rq, sector_t block)
614 ide_hwif_t *hwif = drive->hwif;
615 idetape_tape_t *tape = drive->driver_data;
616 struct ide_atapi_pc *pc = NULL;
617 struct request *postponed_rq = tape->postponed_rq;
621 debug_log(DBG_SENSE, "sector: %llu, nr_sectors: %lu\n"
622 (unsigned long long)rq->sector, rq->nr_sectors);
624 if (!(blk_special_request(rq) || blk_sense_request(rq))) {
625 /* We do not support buffer cache originated requests. */
626 printk(KERN_NOTICE "ide-tape: %s: Unsupported request in "
627 "request queue (%d)\n", drive->name, rq->cmd_type);
628 if (blk_fs_request(rq) == 0 && rq->errors == 0)
630 ide_complete_rq(drive, -EIO, ide_rq_bytes(rq));
634 /* Retry a failed packet command */
635 if (drive->failed_pc && drive->pc->c[0] == REQUEST_SENSE) {
636 pc = drive->failed_pc;
640 if (postponed_rq != NULL)
641 if (rq != postponed_rq) {
642 printk(KERN_ERR "ide-tape: ide-tape.c bug - "
643 "Two DSC requests were queued\n");
644 drive->failed_pc = NULL;
646 ide_complete_rq(drive, 0, blk_rq_bytes(rq));
650 tape->postponed_rq = NULL;
653 * If the tape is still busy, postpone our request and service
654 * the other device meanwhile.
656 stat = hwif->tp_ops->read_status(hwif);
658 if ((drive->dev_flags & IDE_DFLAG_DSC_OVERLAP) == 0 &&
659 (rq->cmd[13] & REQ_IDETAPE_PC2) == 0)
660 set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
662 if (drive->dev_flags & IDE_DFLAG_POST_RESET) {
663 set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
664 drive->dev_flags &= ~IDE_DFLAG_POST_RESET;
667 if (!test_and_clear_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags) &&
668 (stat & ATA_DSC) == 0) {
669 if (postponed_rq == NULL) {
670 tape->dsc_polling_start = jiffies;
671 tape->dsc_poll_freq = tape->best_dsc_rw_freq;
672 tape->dsc_timeout = jiffies + IDETAPE_DSC_RW_TIMEOUT;
673 } else if (time_after(jiffies, tape->dsc_timeout)) {
674 printk(KERN_ERR "ide-tape: %s: DSC timeout\n",
676 if (rq->cmd[13] & REQ_IDETAPE_PC2) {
677 idetape_media_access_finished(drive);
680 return ide_do_reset(drive);
682 } else if (time_after(jiffies,
683 tape->dsc_polling_start +
684 IDETAPE_DSC_MA_THRESHOLD))
685 tape->dsc_poll_freq = IDETAPE_DSC_MA_SLOW;
686 idetape_postpone_request(drive);
689 if (rq->cmd[13] & REQ_IDETAPE_READ) {
690 pc = &tape->queued_pc;
691 ide_tape_create_rw_cmd(tape, pc, rq, READ_6);
694 if (rq->cmd[13] & REQ_IDETAPE_WRITE) {
695 pc = &tape->queued_pc;
696 ide_tape_create_rw_cmd(tape, pc, rq, WRITE_6);
699 if (rq->cmd[13] & REQ_IDETAPE_PC1) {
700 pc = (struct ide_atapi_pc *)rq->special;
701 rq->cmd[13] &= ~(REQ_IDETAPE_PC1);
702 rq->cmd[13] |= REQ_IDETAPE_PC2;
705 if (rq->cmd[13] & REQ_IDETAPE_PC2) {
706 idetape_media_access_finished(drive);
712 /* prepare sense request for this command */
713 ide_prep_sense(drive, rq);
715 memset(&cmd, 0, sizeof(cmd));
718 cmd.tf_flags |= IDE_TFLAG_WRITE;
722 ide_init_sg_cmd(&cmd, pc->req_xfer);
723 ide_map_sg(drive, &cmd);
725 return ide_tape_issue_pc(drive, &cmd, pc);
729 * Write a filemark if write_filemark=1. Flush the device buffers without
730 * writing a filemark otherwise.
732 static void idetape_create_write_filemark_cmd(ide_drive_t *drive,
733 struct ide_atapi_pc *pc, int write_filemark)
736 pc->c[0] = WRITE_FILEMARKS;
737 pc->c[4] = write_filemark;
738 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
741 static int idetape_wait_ready(ide_drive_t *drive, unsigned long timeout)
743 idetape_tape_t *tape = drive->driver_data;
744 struct gendisk *disk = tape->disk;
745 int load_attempted = 0;
747 /* Wait for the tape to become ready */
748 set_bit(IDE_AFLAG_MEDIUM_PRESENT, &drive->atapi_flags);
750 while (time_before(jiffies, timeout)) {
751 if (ide_do_test_unit_ready(drive, disk) == 0)
753 if ((tape->sense_key == 2 && tape->asc == 4 && tape->ascq == 2)
754 || (tape->asc == 0x3A)) {
758 ide_do_start_stop(drive, disk, IDETAPE_LU_LOAD_MASK);
760 /* not about to be ready */
761 } else if (!(tape->sense_key == 2 && tape->asc == 4 &&
762 (tape->ascq == 1 || tape->ascq == 8)))
769 static int idetape_flush_tape_buffers(ide_drive_t *drive)
771 struct ide_tape_obj *tape = drive->driver_data;
772 struct ide_atapi_pc pc;
775 idetape_create_write_filemark_cmd(drive, &pc, 0);
776 rc = ide_queue_pc_tail(drive, tape->disk, &pc);
779 idetape_wait_ready(drive, 60 * 5 * HZ);
783 static void idetape_create_read_position_cmd(struct ide_atapi_pc *pc)
786 pc->c[0] = READ_POSITION;
790 static int idetape_read_position(ide_drive_t *drive)
792 idetape_tape_t *tape = drive->driver_data;
793 struct ide_atapi_pc pc;
796 debug_log(DBG_PROCS, "Enter %s\n", __func__);
798 idetape_create_read_position_cmd(&pc);
799 if (ide_queue_pc_tail(drive, tape->disk, &pc))
801 position = tape->first_frame;
805 static void idetape_create_locate_cmd(ide_drive_t *drive,
806 struct ide_atapi_pc *pc,
807 unsigned int block, u8 partition, int skip)
810 pc->c[0] = POSITION_TO_ELEMENT;
812 put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[3]);
813 pc->c[8] = partition;
814 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
817 static void __ide_tape_discard_merge_buffer(ide_drive_t *drive)
819 idetape_tape_t *tape = drive->driver_data;
821 if (tape->chrdev_dir != IDETAPE_DIR_READ)
824 clear_bit(IDE_AFLAG_FILEMARK, &drive->atapi_flags);
826 if (tape->buf != NULL) {
831 tape->chrdev_dir = IDETAPE_DIR_NONE;
835 * Position the tape to the requested block using the LOCATE packet command.
836 * A READ POSITION command is then issued to check where we are positioned. Like
837 * all higher level operations, we queue the commands at the tail of the request
838 * queue and wait for their completion.
840 static int idetape_position_tape(ide_drive_t *drive, unsigned int block,
841 u8 partition, int skip)
843 idetape_tape_t *tape = drive->driver_data;
844 struct gendisk *disk = tape->disk;
846 struct ide_atapi_pc pc;
848 if (tape->chrdev_dir == IDETAPE_DIR_READ)
849 __ide_tape_discard_merge_buffer(drive);
850 idetape_wait_ready(drive, 60 * 5 * HZ);
851 idetape_create_locate_cmd(drive, &pc, block, partition, skip);
852 retval = ide_queue_pc_tail(drive, disk, &pc);
856 idetape_create_read_position_cmd(&pc);
857 return ide_queue_pc_tail(drive, disk, &pc);
860 static void ide_tape_discard_merge_buffer(ide_drive_t *drive,
861 int restore_position)
863 idetape_tape_t *tape = drive->driver_data;
866 __ide_tape_discard_merge_buffer(drive);
867 if (restore_position) {
868 position = idetape_read_position(drive);
869 seek = position > 0 ? position : 0;
870 if (idetape_position_tape(drive, seek, 0, 0)) {
871 printk(KERN_INFO "ide-tape: %s: position_tape failed in"
872 " %s\n", tape->name, __func__);
879 * Generate a read/write request for the block device interface and wait for it
882 static int idetape_queue_rw_tail(ide_drive_t *drive, int cmd, int size)
884 idetape_tape_t *tape = drive->driver_data;
888 debug_log(DBG_SENSE, "%s: cmd=%d\n", __func__, cmd);
889 BUG_ON(cmd != REQ_IDETAPE_READ && cmd != REQ_IDETAPE_WRITE);
890 BUG_ON(size < 0 || size % tape->blk_size);
892 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
893 rq->cmd_type = REQ_TYPE_SPECIAL;
895 rq->rq_disk = tape->disk;
896 rq->sector = tape->first_frame;
899 ret = blk_rq_map_kern(drive->queue, rq, tape->buf, size,
905 blk_execute_rq(drive->queue, tape->disk, rq, 0);
907 /* calculate the number of transferred bytes and update buffer state */
908 size -= rq->data_len;
909 tape->cur = tape->buf;
910 if (cmd == REQ_IDETAPE_READ)
916 if (rq->errors == IDE_DRV_ERROR_GENERAL)
923 static void idetape_create_inquiry_cmd(struct ide_atapi_pc *pc)
931 static void idetape_create_rewind_cmd(ide_drive_t *drive,
932 struct ide_atapi_pc *pc)
935 pc->c[0] = REZERO_UNIT;
936 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
939 static void idetape_create_erase_cmd(struct ide_atapi_pc *pc)
944 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
947 static void idetape_create_space_cmd(struct ide_atapi_pc *pc, int count, u8 cmd)
951 put_unaligned(cpu_to_be32(count), (unsigned int *) &pc->c[1]);
953 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
956 /* Queue up a character device originated write request. */
957 static int idetape_add_chrdev_write_request(ide_drive_t *drive, int size)
959 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
961 return idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE, size);
964 static void ide_tape_flush_merge_buffer(ide_drive_t *drive)
966 idetape_tape_t *tape = drive->driver_data;
968 if (tape->chrdev_dir != IDETAPE_DIR_WRITE) {
969 printk(KERN_ERR "ide-tape: bug: Trying to empty merge buffer"
970 " but we are not writing.\n");
974 size_t aligned = roundup(tape->valid, tape->blk_size);
976 memset(tape->cur, 0, aligned - tape->valid);
977 idetape_add_chrdev_write_request(drive, aligned);
981 tape->chrdev_dir = IDETAPE_DIR_NONE;
984 static int idetape_init_rw(ide_drive_t *drive, int dir)
986 idetape_tape_t *tape = drive->driver_data;
989 BUG_ON(dir != IDETAPE_DIR_READ && dir != IDETAPE_DIR_WRITE);
991 if (tape->chrdev_dir == dir)
994 if (tape->chrdev_dir == IDETAPE_DIR_READ)
995 ide_tape_discard_merge_buffer(drive, 1);
996 else if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
997 ide_tape_flush_merge_buffer(drive);
998 idetape_flush_tape_buffers(drive);
1001 if (tape->buf || tape->valid) {
1002 printk(KERN_ERR "ide-tape: valid should be 0 now\n");
1006 tape->buf = kmalloc(tape->buffer_size, GFP_KERNEL);
1009 tape->chrdev_dir = dir;
1010 tape->cur = tape->buf;
1013 * Issue a 0 rw command to ensure that DSC handshake is
1014 * switched from completion mode to buffer available mode. No
1015 * point in issuing this if DSC overlap isn't supported, some
1016 * drives (Seagate STT3401A) will return an error.
1018 if (drive->dev_flags & IDE_DFLAG_DSC_OVERLAP) {
1019 int cmd = dir == IDETAPE_DIR_READ ? REQ_IDETAPE_READ
1020 : REQ_IDETAPE_WRITE;
1022 rc = idetape_queue_rw_tail(drive, cmd, 0);
1026 tape->chrdev_dir = IDETAPE_DIR_NONE;
1034 /* called from idetape_chrdev_read() to service a chrdev read request. */
1035 static int idetape_add_chrdev_read_request(ide_drive_t *drive, int size)
1037 debug_log(DBG_PROCS, "Enter %s, %d bytes\n", __func__, size);
1039 /* If we are at a filemark, return a read length of 0 */
1040 if (test_bit(IDE_AFLAG_FILEMARK, &drive->atapi_flags))
1043 idetape_init_rw(drive, IDETAPE_DIR_READ);
1045 return idetape_queue_rw_tail(drive, REQ_IDETAPE_READ, size);
1048 static void idetape_pad_zeros(ide_drive_t *drive, int bcount)
1050 idetape_tape_t *tape = drive->driver_data;
1052 memset(tape->buf, 0, tape->buffer_size);
1055 unsigned int count = min(tape->buffer_size, bcount);
1057 idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE, count);
1063 * Rewinds the tape to the Beginning Of the current Partition (BOP). We
1064 * currently support only one partition.
1066 static int idetape_rewind_tape(ide_drive_t *drive)
1068 struct ide_tape_obj *tape = drive->driver_data;
1069 struct gendisk *disk = tape->disk;
1071 struct ide_atapi_pc pc;
1073 debug_log(DBG_SENSE, "Enter %s\n", __func__);
1075 idetape_create_rewind_cmd(drive, &pc);
1076 retval = ide_queue_pc_tail(drive, disk, &pc);
1080 idetape_create_read_position_cmd(&pc);
1081 retval = ide_queue_pc_tail(drive, disk, &pc);
1087 /* mtio.h compatible commands should be issued to the chrdev interface. */
1088 static int idetape_blkdev_ioctl(ide_drive_t *drive, unsigned int cmd,
1091 idetape_tape_t *tape = drive->driver_data;
1092 void __user *argp = (void __user *)arg;
1094 struct idetape_config {
1095 int dsc_rw_frequency;
1096 int dsc_media_access_frequency;
1100 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1104 if (copy_from_user(&config, argp, sizeof(config)))
1106 tape->best_dsc_rw_freq = config.dsc_rw_frequency;
1109 config.dsc_rw_frequency = (int) tape->best_dsc_rw_freq;
1110 config.nr_stages = 1;
1111 if (copy_to_user(argp, &config, sizeof(config)))
1120 static int idetape_space_over_filemarks(ide_drive_t *drive, short mt_op,
1123 idetape_tape_t *tape = drive->driver_data;
1124 struct gendisk *disk = tape->disk;
1125 struct ide_atapi_pc pc;
1126 int retval, count = 0;
1127 int sprev = !!(tape->caps[4] & 0x20);
1131 if (MTBSF == mt_op || MTBSFM == mt_op) {
1134 mt_count = -mt_count;
1137 if (tape->chrdev_dir == IDETAPE_DIR_READ) {
1139 if (test_and_clear_bit(IDE_AFLAG_FILEMARK, &drive->atapi_flags))
1141 ide_tape_discard_merge_buffer(drive, 0);
1147 idetape_create_space_cmd(&pc, mt_count - count,
1148 IDETAPE_SPACE_OVER_FILEMARK);
1149 return ide_queue_pc_tail(drive, disk, &pc);
1154 retval = idetape_space_over_filemarks(drive, MTFSF,
1158 count = (MTBSFM == mt_op ? 1 : -1);
1159 return idetape_space_over_filemarks(drive, MTFSF, count);
1161 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
1168 * Our character device read / write functions.
1170 * The tape is optimized to maximize throughput when it is transferring an
1171 * integral number of the "continuous transfer limit", which is a parameter of
1172 * the specific tape (26kB on my particular tape, 32kB for Onstream).
1174 * As of version 1.3 of the driver, the character device provides an abstract
1175 * continuous view of the media - any mix of block sizes (even 1 byte) on the
1176 * same backup/restore procedure is supported. The driver will internally
1177 * convert the requests to the recommended transfer unit, so that an unmatch
1178 * between the user's block size to the recommended size will only result in a
1179 * (slightly) increased driver overhead, but will no longer hit performance.
1180 * This is not applicable to Onstream.
1182 static ssize_t idetape_chrdev_read(struct file *file, char __user *buf,
1183 size_t count, loff_t *ppos)
1185 struct ide_tape_obj *tape = file->private_data;
1186 ide_drive_t *drive = tape->drive;
1187 ssize_t bytes_read, temp, actually_read = 0, rc;
1190 debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
1192 if (tape->chrdev_dir != IDETAPE_DIR_READ) {
1193 if (test_bit(IDE_AFLAG_DETECT_BS, &drive->atapi_flags))
1194 if (count > tape->blk_size &&
1195 (count % tape->blk_size) == 0)
1196 tape->user_bs_factor = count / tape->blk_size;
1198 rc = idetape_init_rw(drive, IDETAPE_DIR_READ);
1204 actually_read = min_t(unsigned int, tape->valid, count);
1205 if (copy_to_user(buf, tape->cur, actually_read))
1207 buf += actually_read;
1208 count -= actually_read;
1209 tape->cur += actually_read;
1210 tape->valid -= actually_read;
1212 while (count >= tape->buffer_size) {
1213 bytes_read = idetape_add_chrdev_read_request(drive,
1215 if (bytes_read <= 0)
1217 if (copy_to_user(buf, tape->cur, bytes_read))
1220 count -= bytes_read;
1221 actually_read += bytes_read;
1224 bytes_read = idetape_add_chrdev_read_request(drive,
1226 if (bytes_read <= 0)
1228 temp = min((unsigned long)count, (unsigned long)bytes_read);
1229 if (copy_to_user(buf, tape->cur, temp))
1231 actually_read += temp;
1233 tape->valid -= temp;
1236 if (!actually_read && test_bit(IDE_AFLAG_FILEMARK, &drive->atapi_flags)) {
1237 debug_log(DBG_SENSE, "%s: spacing over filemark\n", tape->name);
1239 idetape_space_over_filemarks(drive, MTFSF, 1);
1243 return ret ? ret : actually_read;
1246 static ssize_t idetape_chrdev_write(struct file *file, const char __user *buf,
1247 size_t count, loff_t *ppos)
1249 struct ide_tape_obj *tape = file->private_data;
1250 ide_drive_t *drive = tape->drive;
1251 ssize_t actually_written = 0;
1255 /* The drive is write protected. */
1256 if (tape->write_prot)
1259 debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
1261 /* Initialize write operation */
1262 rc = idetape_init_rw(drive, IDETAPE_DIR_WRITE);
1267 if (tape->valid < tape->buffer_size) {
1268 actually_written = min_t(unsigned int,
1269 tape->buffer_size - tape->valid,
1271 if (copy_from_user(tape->cur, buf, actually_written))
1273 buf += actually_written;
1274 count -= actually_written;
1275 tape->cur += actually_written;
1276 tape->valid += actually_written;
1278 if (tape->valid == tape->buffer_size) {
1280 retval = idetape_add_chrdev_write_request(drive,
1286 while (count >= tape->buffer_size) {
1288 if (copy_from_user(tape->cur, buf, tape->buffer_size))
1290 buf += tape->buffer_size;
1291 count -= tape->buffer_size;
1292 retval = idetape_add_chrdev_write_request(drive,
1294 actually_written += tape->buffer_size;
1299 actually_written += count;
1300 if (copy_from_user(tape->cur, buf, count))
1303 tape->valid += count;
1305 return ret ? ret : actually_written;
1308 static int idetape_write_filemark(ide_drive_t *drive)
1310 struct ide_tape_obj *tape = drive->driver_data;
1311 struct ide_atapi_pc pc;
1313 /* Write a filemark */
1314 idetape_create_write_filemark_cmd(drive, &pc, 1);
1315 if (ide_queue_pc_tail(drive, tape->disk, &pc)) {
1316 printk(KERN_ERR "ide-tape: Couldn't write a filemark\n");
1323 * Called from idetape_chrdev_ioctl when the general mtio MTIOCTOP ioctl is
1326 * Note: MTBSF and MTBSFM are not supported when the tape doesn't support
1327 * spacing over filemarks in the reverse direction. In this case, MTFSFM is also
1328 * usually not supported.
1330 * The following commands are currently not supported:
1332 * MTFSS, MTBSS, MTWSM, MTSETDENSITY, MTSETDRVBUFFER, MT_ST_BOOLEANS,
1333 * MT_ST_WRITE_THRESHOLD.
1335 static int idetape_mtioctop(ide_drive_t *drive, short mt_op, int mt_count)
1337 idetape_tape_t *tape = drive->driver_data;
1338 struct gendisk *disk = tape->disk;
1339 struct ide_atapi_pc pc;
1342 debug_log(DBG_ERR, "Handling MTIOCTOP ioctl: mt_op=%d, mt_count=%d\n",
1352 return idetape_space_over_filemarks(drive, mt_op, mt_count);
1359 if (tape->write_prot)
1361 ide_tape_discard_merge_buffer(drive, 1);
1362 for (i = 0; i < mt_count; i++) {
1363 retval = idetape_write_filemark(drive);
1369 ide_tape_discard_merge_buffer(drive, 0);
1370 if (idetape_rewind_tape(drive))
1374 ide_tape_discard_merge_buffer(drive, 0);
1375 return ide_do_start_stop(drive, disk, IDETAPE_LU_LOAD_MASK);
1379 * If door is locked, attempt to unlock before
1380 * attempting to eject.
1382 if (tape->door_locked) {
1383 if (!ide_set_media_lock(drive, disk, 0))
1384 tape->door_locked = DOOR_UNLOCKED;
1386 ide_tape_discard_merge_buffer(drive, 0);
1387 retval = ide_do_start_stop(drive, disk, !IDETAPE_LU_LOAD_MASK);
1389 clear_bit(IDE_AFLAG_MEDIUM_PRESENT, &drive->atapi_flags);
1392 ide_tape_discard_merge_buffer(drive, 0);
1393 return idetape_flush_tape_buffers(drive);
1395 ide_tape_discard_merge_buffer(drive, 0);
1396 return ide_do_start_stop(drive, disk,
1397 IDETAPE_LU_RETENSION_MASK | IDETAPE_LU_LOAD_MASK);
1399 idetape_create_space_cmd(&pc, 0, IDETAPE_SPACE_TO_EOD);
1400 return ide_queue_pc_tail(drive, disk, &pc);
1402 (void)idetape_rewind_tape(drive);
1403 idetape_create_erase_cmd(&pc);
1404 return ide_queue_pc_tail(drive, disk, &pc);
1407 if (mt_count < tape->blk_size ||
1408 mt_count % tape->blk_size)
1410 tape->user_bs_factor = mt_count / tape->blk_size;
1411 clear_bit(IDE_AFLAG_DETECT_BS, &drive->atapi_flags);
1413 set_bit(IDE_AFLAG_DETECT_BS, &drive->atapi_flags);
1416 ide_tape_discard_merge_buffer(drive, 0);
1417 return idetape_position_tape(drive,
1418 mt_count * tape->user_bs_factor, tape->partition, 0);
1420 ide_tape_discard_merge_buffer(drive, 0);
1421 return idetape_position_tape(drive, 0, mt_count, 0);
1425 retval = ide_set_media_lock(drive, disk, 1);
1428 tape->door_locked = DOOR_EXPLICITLY_LOCKED;
1431 retval = ide_set_media_lock(drive, disk, 0);
1434 tape->door_locked = DOOR_UNLOCKED;
1437 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
1444 * Our character device ioctls. General mtio.h magnetic io commands are
1445 * supported here, and not in the corresponding block interface. Our own
1446 * ide-tape ioctls are supported on both interfaces.
1448 static int idetape_chrdev_ioctl(struct inode *inode, struct file *file,
1449 unsigned int cmd, unsigned long arg)
1451 struct ide_tape_obj *tape = file->private_data;
1452 ide_drive_t *drive = tape->drive;
1456 int block_offset = 0, position = tape->first_frame;
1457 void __user *argp = (void __user *)arg;
1459 debug_log(DBG_CHRDEV, "Enter %s, cmd=%u\n", __func__, cmd);
1461 if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
1462 ide_tape_flush_merge_buffer(drive);
1463 idetape_flush_tape_buffers(drive);
1465 if (cmd == MTIOCGET || cmd == MTIOCPOS) {
1466 block_offset = tape->valid /
1467 (tape->blk_size * tape->user_bs_factor);
1468 position = idetape_read_position(drive);
1474 if (copy_from_user(&mtop, argp, sizeof(struct mtop)))
1476 return idetape_mtioctop(drive, mtop.mt_op, mtop.mt_count);
1478 memset(&mtget, 0, sizeof(struct mtget));
1479 mtget.mt_type = MT_ISSCSI2;
1480 mtget.mt_blkno = position / tape->user_bs_factor - block_offset;
1482 ((tape->blk_size * tape->user_bs_factor)
1483 << MT_ST_BLKSIZE_SHIFT) & MT_ST_BLKSIZE_MASK;
1485 if (tape->drv_write_prot)
1486 mtget.mt_gstat |= GMT_WR_PROT(0xffffffff);
1488 if (copy_to_user(argp, &mtget, sizeof(struct mtget)))
1492 mtpos.mt_blkno = position / tape->user_bs_factor - block_offset;
1493 if (copy_to_user(argp, &mtpos, sizeof(struct mtpos)))
1497 if (tape->chrdev_dir == IDETAPE_DIR_READ)
1498 ide_tape_discard_merge_buffer(drive, 1);
1499 return idetape_blkdev_ioctl(drive, cmd, arg);
1504 * Do a mode sense page 0 with block descriptor and if it succeeds set the tape
1505 * block size with the reported value.
1507 static void ide_tape_get_bsize_from_bdesc(ide_drive_t *drive)
1509 idetape_tape_t *tape = drive->driver_data;
1510 struct ide_atapi_pc pc;
1512 idetape_create_mode_sense_cmd(&pc, IDETAPE_BLOCK_DESCRIPTOR);
1513 if (ide_queue_pc_tail(drive, tape->disk, &pc)) {
1514 printk(KERN_ERR "ide-tape: Can't get block descriptor\n");
1515 if (tape->blk_size == 0) {
1516 printk(KERN_WARNING "ide-tape: Cannot deal with zero "
1517 "block size, assuming 32k\n");
1518 tape->blk_size = 32768;
1522 tape->blk_size = (pc.buf[4 + 5] << 16) +
1523 (pc.buf[4 + 6] << 8) +
1525 tape->drv_write_prot = (pc.buf[2] & 0x80) >> 7;
1528 static int idetape_chrdev_open(struct inode *inode, struct file *filp)
1530 unsigned int minor = iminor(inode), i = minor & ~0xc0;
1532 idetape_tape_t *tape;
1535 if (i >= MAX_HWIFS * MAX_DRIVES)
1539 tape = ide_tape_chrdev_get(i);
1545 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
1548 * We really want to do nonseekable_open(inode, filp); here, but some
1549 * versions of tar incorrectly call lseek on tapes and bail out if that
1550 * fails. So we disallow pread() and pwrite(), but permit lseeks.
1552 filp->f_mode &= ~(FMODE_PREAD | FMODE_PWRITE);
1554 drive = tape->drive;
1556 filp->private_data = tape;
1558 if (test_and_set_bit(IDE_AFLAG_BUSY, &drive->atapi_flags)) {
1563 retval = idetape_wait_ready(drive, 60 * HZ);
1565 clear_bit(IDE_AFLAG_BUSY, &drive->atapi_flags);
1566 printk(KERN_ERR "ide-tape: %s: drive not ready\n", tape->name);
1570 idetape_read_position(drive);
1571 if (!test_bit(IDE_AFLAG_ADDRESS_VALID, &drive->atapi_flags))
1572 (void)idetape_rewind_tape(drive);
1574 /* Read block size and write protect status from drive. */
1575 ide_tape_get_bsize_from_bdesc(drive);
1577 /* Set write protect flag if device is opened as read-only. */
1578 if ((filp->f_flags & O_ACCMODE) == O_RDONLY)
1579 tape->write_prot = 1;
1581 tape->write_prot = tape->drv_write_prot;
1583 /* Make sure drive isn't write protected if user wants to write. */
1584 if (tape->write_prot) {
1585 if ((filp->f_flags & O_ACCMODE) == O_WRONLY ||
1586 (filp->f_flags & O_ACCMODE) == O_RDWR) {
1587 clear_bit(IDE_AFLAG_BUSY, &drive->atapi_flags);
1593 /* Lock the tape drive door so user can't eject. */
1594 if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
1595 if (!ide_set_media_lock(drive, tape->disk, 1)) {
1596 if (tape->door_locked != DOOR_EXPLICITLY_LOCKED)
1597 tape->door_locked = DOOR_LOCKED;
1609 static void idetape_write_release(ide_drive_t *drive, unsigned int minor)
1611 idetape_tape_t *tape = drive->driver_data;
1613 ide_tape_flush_merge_buffer(drive);
1614 tape->buf = kmalloc(tape->buffer_size, GFP_KERNEL);
1615 if (tape->buf != NULL) {
1616 idetape_pad_zeros(drive, tape->blk_size *
1617 (tape->user_bs_factor - 1));
1621 idetape_write_filemark(drive);
1622 idetape_flush_tape_buffers(drive);
1623 idetape_flush_tape_buffers(drive);
1626 static int idetape_chrdev_release(struct inode *inode, struct file *filp)
1628 struct ide_tape_obj *tape = filp->private_data;
1629 ide_drive_t *drive = tape->drive;
1630 unsigned int minor = iminor(inode);
1633 tape = drive->driver_data;
1635 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
1637 if (tape->chrdev_dir == IDETAPE_DIR_WRITE)
1638 idetape_write_release(drive, minor);
1639 if (tape->chrdev_dir == IDETAPE_DIR_READ) {
1641 ide_tape_discard_merge_buffer(drive, 1);
1644 if (minor < 128 && test_bit(IDE_AFLAG_MEDIUM_PRESENT, &drive->atapi_flags))
1645 (void) idetape_rewind_tape(drive);
1646 if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
1647 if (tape->door_locked == DOOR_LOCKED) {
1648 if (!ide_set_media_lock(drive, tape->disk, 0))
1649 tape->door_locked = DOOR_UNLOCKED;
1652 clear_bit(IDE_AFLAG_BUSY, &drive->atapi_flags);
1658 static void idetape_get_inquiry_results(ide_drive_t *drive)
1660 idetape_tape_t *tape = drive->driver_data;
1661 struct ide_atapi_pc pc;
1663 char fw_rev[4], vendor_id[8], product_id[16];
1665 idetape_create_inquiry_cmd(&pc);
1666 pc.buf = &pc_buf[0];
1667 pc.buf_size = sizeof(pc_buf);
1669 if (ide_queue_pc_tail(drive, tape->disk, &pc)) {
1670 printk(KERN_ERR "ide-tape: %s: can't get INQUIRY results\n",
1674 memcpy(vendor_id, &pc.buf[8], 8);
1675 memcpy(product_id, &pc.buf[16], 16);
1676 memcpy(fw_rev, &pc.buf[32], 4);
1678 ide_fixstring(vendor_id, 8, 0);
1679 ide_fixstring(product_id, 16, 0);
1680 ide_fixstring(fw_rev, 4, 0);
1682 printk(KERN_INFO "ide-tape: %s <-> %s: %.8s %.16s rev %.4s\n",
1683 drive->name, tape->name, vendor_id, product_id, fw_rev);
1687 * Ask the tape about its various parameters. In particular, we will adjust our
1688 * data transfer buffer size to the recommended value as returned by the tape.
1690 static void idetape_get_mode_sense_results(ide_drive_t *drive)
1692 idetape_tape_t *tape = drive->driver_data;
1693 struct ide_atapi_pc pc;
1695 u8 speed, max_speed;
1697 idetape_create_mode_sense_cmd(&pc, IDETAPE_CAPABILITIES_PAGE);
1698 if (ide_queue_pc_tail(drive, tape->disk, &pc)) {
1699 printk(KERN_ERR "ide-tape: Can't get tape parameters - assuming"
1700 " some default values\n");
1701 tape->blk_size = 512;
1702 put_unaligned(52, (u16 *)&tape->caps[12]);
1703 put_unaligned(540, (u16 *)&tape->caps[14]);
1704 put_unaligned(6*52, (u16 *)&tape->caps[16]);
1707 caps = pc.buf + 4 + pc.buf[3];
1709 /* convert to host order and save for later use */
1710 speed = be16_to_cpup((__be16 *)&caps[14]);
1711 max_speed = be16_to_cpup((__be16 *)&caps[8]);
1713 *(u16 *)&caps[8] = max_speed;
1714 *(u16 *)&caps[12] = be16_to_cpup((__be16 *)&caps[12]);
1715 *(u16 *)&caps[14] = speed;
1716 *(u16 *)&caps[16] = be16_to_cpup((__be16 *)&caps[16]);
1719 printk(KERN_INFO "ide-tape: %s: invalid tape speed "
1720 "(assuming 650KB/sec)\n", drive->name);
1721 *(u16 *)&caps[14] = 650;
1724 printk(KERN_INFO "ide-tape: %s: invalid max_speed "
1725 "(assuming 650KB/sec)\n", drive->name);
1726 *(u16 *)&caps[8] = 650;
1729 memcpy(&tape->caps, caps, 20);
1731 /* device lacks locking support according to capabilities page */
1732 if ((caps[6] & 1) == 0)
1733 drive->dev_flags &= ~IDE_DFLAG_DOORLOCKING;
1736 tape->blk_size = 512;
1737 else if (caps[7] & 0x04)
1738 tape->blk_size = 1024;
1741 #ifdef CONFIG_IDE_PROC_FS
1742 #define ide_tape_devset_get(name, field) \
1743 static int get_##name(ide_drive_t *drive) \
1745 idetape_tape_t *tape = drive->driver_data; \
1746 return tape->field; \
1749 #define ide_tape_devset_set(name, field) \
1750 static int set_##name(ide_drive_t *drive, int arg) \
1752 idetape_tape_t *tape = drive->driver_data; \
1753 tape->field = arg; \
1757 #define ide_tape_devset_rw_field(_name, _field) \
1758 ide_tape_devset_get(_name, _field) \
1759 ide_tape_devset_set(_name, _field) \
1760 IDE_DEVSET(_name, DS_SYNC, get_##_name, set_##_name)
1762 #define ide_tape_devset_r_field(_name, _field) \
1763 ide_tape_devset_get(_name, _field) \
1764 IDE_DEVSET(_name, 0, get_##_name, NULL)
1766 static int mulf_tdsc(ide_drive_t *drive) { return 1000; }
1767 static int divf_tdsc(ide_drive_t *drive) { return HZ; }
1768 static int divf_buffer(ide_drive_t *drive) { return 2; }
1769 static int divf_buffer_size(ide_drive_t *drive) { return 1024; }
1771 ide_devset_rw_flag(dsc_overlap, IDE_DFLAG_DSC_OVERLAP);
1773 ide_tape_devset_rw_field(debug_mask, debug_mask);
1774 ide_tape_devset_rw_field(tdsc, best_dsc_rw_freq);
1776 ide_tape_devset_r_field(avg_speed, avg_speed);
1777 ide_tape_devset_r_field(speed, caps[14]);
1778 ide_tape_devset_r_field(buffer, caps[16]);
1779 ide_tape_devset_r_field(buffer_size, buffer_size);
1781 static const struct ide_proc_devset idetape_settings[] = {
1782 __IDE_PROC_DEVSET(avg_speed, 0, 0xffff, NULL, NULL),
1783 __IDE_PROC_DEVSET(buffer, 0, 0xffff, NULL, divf_buffer),
1784 __IDE_PROC_DEVSET(buffer_size, 0, 0xffff, NULL, divf_buffer_size),
1785 __IDE_PROC_DEVSET(debug_mask, 0, 0xffff, NULL, NULL),
1786 __IDE_PROC_DEVSET(dsc_overlap, 0, 1, NULL, NULL),
1787 __IDE_PROC_DEVSET(speed, 0, 0xffff, NULL, NULL),
1788 __IDE_PROC_DEVSET(tdsc, IDETAPE_DSC_RW_MIN, IDETAPE_DSC_RW_MAX,
1789 mulf_tdsc, divf_tdsc),
1795 * The function below is called to:
1797 * 1. Initialize our various state variables.
1798 * 2. Ask the tape for its capabilities.
1799 * 3. Allocate a buffer which will be used for data transfer. The buffer size
1800 * is chosen based on the recommendation which we received in step 2.
1802 * Note that at this point ide.c already assigned us an irq, so that we can
1803 * queue requests here and wait for their completion.
1805 static void idetape_setup(ide_drive_t *drive, idetape_tape_t *tape, int minor)
1810 u16 *ctl = (u16 *)&tape->caps[12];
1812 drive->pc_callback = ide_tape_callback;
1814 drive->dev_flags |= IDE_DFLAG_DSC_OVERLAP;
1816 if (drive->hwif->host_flags & IDE_HFLAG_NO_DSC) {
1817 printk(KERN_INFO "ide-tape: %s: disabling DSC overlap\n",
1819 drive->dev_flags &= ~IDE_DFLAG_DSC_OVERLAP;
1822 /* Seagate Travan drives do not support DSC overlap. */
1823 if (strstr((char *)&drive->id[ATA_ID_PROD], "Seagate STT3401"))
1824 drive->dev_flags &= ~IDE_DFLAG_DSC_OVERLAP;
1826 tape->minor = minor;
1827 tape->name[0] = 'h';
1828 tape->name[1] = 't';
1829 tape->name[2] = '0' + minor;
1830 tape->chrdev_dir = IDETAPE_DIR_NONE;
1832 idetape_get_inquiry_results(drive);
1833 idetape_get_mode_sense_results(drive);
1834 ide_tape_get_bsize_from_bdesc(drive);
1835 tape->user_bs_factor = 1;
1836 tape->buffer_size = *ctl * tape->blk_size;
1837 while (tape->buffer_size > 0xffff) {
1838 printk(KERN_NOTICE "ide-tape: decreasing stage size\n");
1840 tape->buffer_size = *ctl * tape->blk_size;
1842 buffer_size = tape->buffer_size;
1844 /* select the "best" DSC read/write polling freq */
1845 speed = max(*(u16 *)&tape->caps[14], *(u16 *)&tape->caps[8]);
1847 t = (IDETAPE_FIFO_THRESHOLD * tape->buffer_size * HZ) / (speed * 1000);
1850 * Ensure that the number we got makes sense; limit it within
1851 * IDETAPE_DSC_RW_MIN and IDETAPE_DSC_RW_MAX.
1853 tape->best_dsc_rw_freq = clamp_t(unsigned long, t, IDETAPE_DSC_RW_MIN,
1854 IDETAPE_DSC_RW_MAX);
1855 printk(KERN_INFO "ide-tape: %s <-> %s: %dKBps, %d*%dkB buffer, "
1857 drive->name, tape->name, *(u16 *)&tape->caps[14],
1858 (*(u16 *)&tape->caps[16] * 512) / tape->buffer_size,
1859 tape->buffer_size / 1024,
1860 tape->best_dsc_rw_freq * 1000 / HZ,
1861 (drive->dev_flags & IDE_DFLAG_USING_DMA) ? ", DMA" : "");
1863 ide_proc_register_driver(drive, tape->driver);
1866 static void ide_tape_remove(ide_drive_t *drive)
1868 idetape_tape_t *tape = drive->driver_data;
1870 ide_proc_unregister_driver(drive, tape->driver);
1871 device_del(&tape->dev);
1872 ide_unregister_region(tape->disk);
1874 mutex_lock(&idetape_ref_mutex);
1875 put_device(&tape->dev);
1876 mutex_unlock(&idetape_ref_mutex);
1879 static void ide_tape_release(struct device *dev)
1881 struct ide_tape_obj *tape = to_ide_drv(dev, ide_tape_obj);
1882 ide_drive_t *drive = tape->drive;
1883 struct gendisk *g = tape->disk;
1885 BUG_ON(tape->valid);
1887 drive->dev_flags &= ~IDE_DFLAG_DSC_OVERLAP;
1888 drive->driver_data = NULL;
1889 device_destroy(idetape_sysfs_class, MKDEV(IDETAPE_MAJOR, tape->minor));
1890 device_destroy(idetape_sysfs_class,
1891 MKDEV(IDETAPE_MAJOR, tape->minor + 128));
1892 idetape_devs[tape->minor] = NULL;
1893 g->private_data = NULL;
1898 #ifdef CONFIG_IDE_PROC_FS
1899 static int proc_idetape_read_name
1900 (char *page, char **start, off_t off, int count, int *eof, void *data)
1902 ide_drive_t *drive = (ide_drive_t *) data;
1903 idetape_tape_t *tape = drive->driver_data;
1907 len = sprintf(out, "%s\n", tape->name);
1908 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
1911 static ide_proc_entry_t idetape_proc[] = {
1912 { "capacity", S_IFREG|S_IRUGO, proc_ide_read_capacity, NULL },
1913 { "name", S_IFREG|S_IRUGO, proc_idetape_read_name, NULL },
1914 { NULL, 0, NULL, NULL }
1917 static ide_proc_entry_t *ide_tape_proc_entries(ide_drive_t *drive)
1919 return idetape_proc;
1922 static const struct ide_proc_devset *ide_tape_proc_devsets(ide_drive_t *drive)
1924 return idetape_settings;
1928 static int ide_tape_probe(ide_drive_t *);
1930 static struct ide_driver idetape_driver = {
1932 .owner = THIS_MODULE,
1934 .bus = &ide_bus_type,
1936 .probe = ide_tape_probe,
1937 .remove = ide_tape_remove,
1938 .version = IDETAPE_VERSION,
1939 .do_request = idetape_do_request,
1940 #ifdef CONFIG_IDE_PROC_FS
1941 .proc_entries = ide_tape_proc_entries,
1942 .proc_devsets = ide_tape_proc_devsets,
1946 /* Our character device supporting functions, passed to register_chrdev. */
1947 static const struct file_operations idetape_fops = {
1948 .owner = THIS_MODULE,
1949 .read = idetape_chrdev_read,
1950 .write = idetape_chrdev_write,
1951 .ioctl = idetape_chrdev_ioctl,
1952 .open = idetape_chrdev_open,
1953 .release = idetape_chrdev_release,
1956 static int idetape_open(struct block_device *bdev, fmode_t mode)
1958 struct ide_tape_obj *tape = ide_tape_get(bdev->bd_disk);
1966 static int idetape_release(struct gendisk *disk, fmode_t mode)
1968 struct ide_tape_obj *tape = ide_drv_g(disk, ide_tape_obj);
1974 static int idetape_ioctl(struct block_device *bdev, fmode_t mode,
1975 unsigned int cmd, unsigned long arg)
1977 struct ide_tape_obj *tape = ide_drv_g(bdev->bd_disk, ide_tape_obj);
1978 ide_drive_t *drive = tape->drive;
1979 int err = generic_ide_ioctl(drive, bdev, cmd, arg);
1981 err = idetape_blkdev_ioctl(drive, cmd, arg);
1985 static struct block_device_operations idetape_block_ops = {
1986 .owner = THIS_MODULE,
1987 .open = idetape_open,
1988 .release = idetape_release,
1989 .locked_ioctl = idetape_ioctl,
1992 static int ide_tape_probe(ide_drive_t *drive)
1994 idetape_tape_t *tape;
1998 if (!strstr("ide-tape", drive->driver_req))
2001 if (drive->media != ide_tape)
2004 if ((drive->dev_flags & IDE_DFLAG_ID_READ) &&
2005 ide_check_atapi_device(drive, DRV_NAME) == 0) {
2006 printk(KERN_ERR "ide-tape: %s: not supported by this version of"
2007 " the driver\n", drive->name);
2010 tape = kzalloc(sizeof(idetape_tape_t), GFP_KERNEL);
2012 printk(KERN_ERR "ide-tape: %s: Can't allocate a tape struct\n",
2017 g = alloc_disk(1 << PARTN_BITS);
2021 ide_init_disk(g, drive);
2023 tape->dev.parent = &drive->gendev;
2024 tape->dev.release = ide_tape_release;
2025 dev_set_name(&tape->dev, dev_name(&drive->gendev));
2027 if (device_register(&tape->dev))
2030 tape->drive = drive;
2031 tape->driver = &idetape_driver;
2034 g->private_data = &tape->driver;
2036 drive->driver_data = tape;
2038 mutex_lock(&idetape_ref_mutex);
2039 for (minor = 0; idetape_devs[minor]; minor++)
2041 idetape_devs[minor] = tape;
2042 mutex_unlock(&idetape_ref_mutex);
2044 idetape_setup(drive, tape, minor);
2046 device_create(idetape_sysfs_class, &drive->gendev,
2047 MKDEV(IDETAPE_MAJOR, minor), NULL, "%s", tape->name);
2048 device_create(idetape_sysfs_class, &drive->gendev,
2049 MKDEV(IDETAPE_MAJOR, minor + 128), NULL,
2052 g->fops = &idetape_block_ops;
2053 ide_register_region(g);
2065 static void __exit idetape_exit(void)
2067 driver_unregister(&idetape_driver.gen_driver);
2068 class_destroy(idetape_sysfs_class);
2069 unregister_chrdev(IDETAPE_MAJOR, "ht");
2072 static int __init idetape_init(void)
2075 idetape_sysfs_class = class_create(THIS_MODULE, "ide_tape");
2076 if (IS_ERR(idetape_sysfs_class)) {
2077 idetape_sysfs_class = NULL;
2078 printk(KERN_ERR "Unable to create sysfs class for ide tapes\n");
2083 if (register_chrdev(IDETAPE_MAJOR, "ht", &idetape_fops)) {
2084 printk(KERN_ERR "ide-tape: Failed to register chrdev"
2087 goto out_free_class;
2090 error = driver_register(&idetape_driver.gen_driver);
2092 goto out_free_driver;
2097 driver_unregister(&idetape_driver.gen_driver);
2099 class_destroy(idetape_sysfs_class);
2104 MODULE_ALIAS("ide:*m-tape*");
2105 module_init(idetape_init);
2106 module_exit(idetape_exit);
2107 MODULE_ALIAS_CHARDEV_MAJOR(IDETAPE_MAJOR);
2108 MODULE_DESCRIPTION("ATAPI Streaming TAPE Driver");
2109 MODULE_LICENSE("GPL");