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 *idetape_devs[MAX_HWIFS * MAX_DRIVES];
245 static struct ide_tape_obj *ide_tape_get(struct gendisk *disk, bool cdev,
248 struct ide_tape_obj *tape = NULL;
250 mutex_lock(&idetape_ref_mutex);
253 tape = idetape_devs[i];
255 tape = ide_drv_g(disk, ide_tape_obj);
258 if (ide_device_get(tape->drive))
261 get_device(&tape->dev);
264 mutex_unlock(&idetape_ref_mutex);
268 static void ide_tape_put(struct ide_tape_obj *tape)
270 ide_drive_t *drive = tape->drive;
272 mutex_lock(&idetape_ref_mutex);
273 put_device(&tape->dev);
274 ide_device_put(drive);
275 mutex_unlock(&idetape_ref_mutex);
279 * called on each failed packet command retry to analyze the request sense. We
280 * currently do not utilize this information.
282 static void idetape_analyze_error(ide_drive_t *drive)
284 idetape_tape_t *tape = drive->driver_data;
285 struct ide_atapi_pc *pc = drive->failed_pc;
286 struct request *rq = drive->hwif->rq;
287 u8 *sense = bio_data(rq->bio);
289 tape->sense_key = sense[2] & 0xF;
290 tape->asc = sense[12];
291 tape->ascq = sense[13];
293 debug_log(DBG_ERR, "pc = %x, sense key = %x, asc = %x, ascq = %x\n",
294 pc->c[0], tape->sense_key, tape->asc, tape->ascq);
296 /* correct remaining bytes to transfer */
297 if (pc->flags & PC_FLAG_DMA_ERROR)
298 rq->resid_len = tape->blk_size * get_unaligned_be32(&sense[3]);
301 * If error was the result of a zero-length read or write command,
302 * with sense key=5, asc=0x22, ascq=0, let it slide. Some drives
303 * (i.e. Seagate STT3401A Travan) don't support 0-length read/writes.
305 if ((pc->c[0] == READ_6 || pc->c[0] == WRITE_6)
307 && pc->c[4] == 0 && pc->c[3] == 0 && pc->c[2] == 0) {
308 if (tape->sense_key == 5) {
309 /* don't report an error, everything's ok */
311 /* don't retry read/write */
312 pc->flags |= PC_FLAG_ABORT;
315 if (pc->c[0] == READ_6 && (sense[2] & 0x80)) {
316 pc->error = IDE_DRV_ERROR_FILEMARK;
317 pc->flags |= PC_FLAG_ABORT;
319 if (pc->c[0] == WRITE_6) {
320 if ((sense[2] & 0x40) || (tape->sense_key == 0xd
321 && tape->asc == 0x0 && tape->ascq == 0x2)) {
322 pc->error = IDE_DRV_ERROR_EOD;
323 pc->flags |= PC_FLAG_ABORT;
326 if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
327 if (tape->sense_key == 8) {
328 pc->error = IDE_DRV_ERROR_EOD;
329 pc->flags |= PC_FLAG_ABORT;
331 if (!(pc->flags & PC_FLAG_ABORT) &&
332 (blk_rq_bytes(rq) - rq->resid_len))
333 pc->retries = IDETAPE_MAX_PC_RETRIES + 1;
337 static void ide_tape_handle_dsc(ide_drive_t *);
339 static int ide_tape_callback(ide_drive_t *drive, int dsc)
341 idetape_tape_t *tape = drive->driver_data;
342 struct ide_atapi_pc *pc = drive->pc;
343 struct request *rq = drive->hwif->rq;
344 int uptodate = pc->error ? 0 : 1;
345 int err = uptodate ? 0 : IDE_DRV_ERROR_GENERAL;
347 debug_log(DBG_PROCS, "Enter %s\n", __func__);
350 ide_tape_handle_dsc(drive);
352 if (drive->failed_pc == pc)
353 drive->failed_pc = NULL;
355 if (pc->c[0] == REQUEST_SENSE) {
357 idetape_analyze_error(drive);
359 printk(KERN_ERR "ide-tape: Error in REQUEST SENSE "
360 "itself - Aborting request!\n");
361 } else if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
362 unsigned int blocks =
363 (blk_rq_bytes(rq) - rq->resid_len) / tape->blk_size;
365 tape->avg_size += blocks * tape->blk_size;
367 if (time_after_eq(jiffies, tape->avg_time + HZ)) {
368 tape->avg_speed = tape->avg_size * HZ /
369 (jiffies - tape->avg_time) / 1024;
371 tape->avg_time = jiffies;
374 tape->first_frame += blocks;
387 * Postpone the current request so that ide.c will be able to service requests
388 * from another device on the same port while we are polling for DSC.
390 static void idetape_postpone_request(ide_drive_t *drive)
392 idetape_tape_t *tape = drive->driver_data;
394 debug_log(DBG_PROCS, "Enter %s\n", __func__);
396 tape->postponed_rq = drive->hwif->rq;
398 ide_stall_queue(drive, tape->dsc_poll_freq);
401 static void ide_tape_handle_dsc(ide_drive_t *drive)
403 idetape_tape_t *tape = drive->driver_data;
405 /* Media access command */
406 tape->dsc_polling_start = jiffies;
407 tape->dsc_poll_freq = IDETAPE_DSC_MA_FAST;
408 tape->dsc_timeout = jiffies + IDETAPE_DSC_MA_TIMEOUT;
409 /* Allow ide.c to handle other requests */
410 idetape_postpone_request(drive);
414 * Packet Command Interface
416 * The current Packet Command is available in drive->pc, and will not change
417 * until we finish handling it. Each packet command is associated with a
418 * callback function that will be called when the command is finished.
420 * The handling will be done in three stages:
422 * 1. ide_tape_issue_pc will send the packet command to the drive, and will set
423 * the interrupt handler to ide_pc_intr.
425 * 2. On each interrupt, ide_pc_intr will be called. This step will be
426 * repeated until the device signals us that no more interrupts will be issued.
428 * 3. ATAPI Tape media access commands have immediate status with a delayed
429 * process. In case of a successful initiation of a media access packet command,
430 * the DSC bit will be set when the actual execution of the command is finished.
431 * Since the tape drive will not issue an interrupt, we have to poll for this
432 * event. In this case, we define the request as "low priority request" by
433 * setting rq_status to IDETAPE_RQ_POSTPONED, set a timer to poll for DSC and
436 * ide.c will then give higher priority to requests which originate from the
437 * other device, until will change rq_status to RQ_ACTIVE.
439 * 4. When the packet command is finished, it will be checked for errors.
441 * 5. In case an error was found, we queue a request sense packet command in
442 * front of the request queue and retry the operation up to
443 * IDETAPE_MAX_PC_RETRIES times.
445 * 6. In case no error was found, or we decided to give up and not to retry
446 * again, the callback function will be called and then we will handle the next
450 static ide_startstop_t ide_tape_issue_pc(ide_drive_t *drive,
452 struct ide_atapi_pc *pc)
454 idetape_tape_t *tape = drive->driver_data;
455 struct request *rq = drive->hwif->rq;
457 if (drive->failed_pc == NULL && pc->c[0] != REQUEST_SENSE)
458 drive->failed_pc = pc;
460 /* Set the current packet command */
463 if (pc->retries > IDETAPE_MAX_PC_RETRIES ||
464 (pc->flags & PC_FLAG_ABORT)) {
467 * We will "abort" retrying a packet command in case legitimate
468 * error code was received (crossing a filemark, or end of the
469 * media, for example).
471 if (!(pc->flags & PC_FLAG_ABORT)) {
472 if (!(pc->c[0] == TEST_UNIT_READY &&
473 tape->sense_key == 2 && tape->asc == 4 &&
474 (tape->ascq == 1 || tape->ascq == 8))) {
475 printk(KERN_ERR "ide-tape: %s: I/O error, "
476 "pc = %2x, key = %2x, "
477 "asc = %2x, ascq = %2x\n",
478 tape->name, pc->c[0],
479 tape->sense_key, tape->asc,
483 pc->error = IDE_DRV_ERROR_GENERAL;
486 drive->failed_pc = NULL;
487 drive->pc_callback(drive, 0);
488 ide_complete_rq(drive, -EIO, blk_rq_bytes(rq));
491 debug_log(DBG_SENSE, "Retry #%d, cmd = %02X\n", pc->retries, pc->c[0]);
495 return ide_issue_pc(drive, cmd);
498 /* A mode sense command is used to "sense" tape parameters. */
499 static void idetape_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
502 pc->c[0] = MODE_SENSE;
503 if (page_code != IDETAPE_BLOCK_DESCRIPTOR)
504 /* DBD = 1 - Don't return block descriptors */
506 pc->c[2] = page_code;
508 * Changed pc->c[3] to 0 (255 will at best return unused info).
510 * For SCSI this byte is defined as subpage instead of high byte
511 * of length and some IDE drives seem to interpret it this way
512 * and return an error when 255 is used.
515 /* We will just discard data in that case */
517 if (page_code == IDETAPE_BLOCK_DESCRIPTOR)
519 else if (page_code == IDETAPE_CAPABILITIES_PAGE)
525 static ide_startstop_t idetape_media_access_finished(ide_drive_t *drive)
527 ide_hwif_t *hwif = drive->hwif;
528 idetape_tape_t *tape = drive->driver_data;
529 struct ide_atapi_pc *pc = drive->pc;
532 stat = hwif->tp_ops->read_status(hwif);
534 if (stat & ATA_DSC) {
535 if (stat & ATA_ERR) {
537 if (pc->c[0] != TEST_UNIT_READY)
538 printk(KERN_ERR "ide-tape: %s: I/O error, ",
540 /* Retry operation */
546 pc->error = IDE_DRV_ERROR_GENERAL;
547 drive->failed_pc = NULL;
549 drive->pc_callback(drive, 0);
553 static void ide_tape_create_rw_cmd(idetape_tape_t *tape,
554 struct ide_atapi_pc *pc, struct request *rq,
557 unsigned int length = blk_rq_sectors(rq) / (tape->blk_size >> 9);
560 put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
563 if (blk_rq_bytes(rq) == tape->buffer_size)
564 pc->flags |= PC_FLAG_DMA_OK;
566 if (opcode == READ_6)
568 else if (opcode == WRITE_6) {
570 pc->flags |= PC_FLAG_WRITING;
573 memcpy(rq->cmd, pc->c, 12);
576 static ide_startstop_t idetape_do_request(ide_drive_t *drive,
577 struct request *rq, sector_t block)
579 ide_hwif_t *hwif = drive->hwif;
580 idetape_tape_t *tape = drive->driver_data;
581 struct ide_atapi_pc *pc = NULL;
582 struct request *postponed_rq = tape->postponed_rq;
586 debug_log(DBG_SENSE, "sector: %llu, nr_sectors: %u\n"
587 (unsigned long long)blk_rq_pos(rq), blk_rq_sectors(rq));
589 BUG_ON(!(blk_special_request(rq) || blk_sense_request(rq)));
591 /* Retry a failed packet command */
592 if (drive->failed_pc && drive->pc->c[0] == REQUEST_SENSE) {
593 pc = drive->failed_pc;
597 if (postponed_rq != NULL)
598 if (rq != postponed_rq) {
599 printk(KERN_ERR "ide-tape: ide-tape.c bug - "
600 "Two DSC requests were queued\n");
601 drive->failed_pc = NULL;
603 ide_complete_rq(drive, 0, blk_rq_bytes(rq));
607 tape->postponed_rq = NULL;
610 * If the tape is still busy, postpone our request and service
611 * the other device meanwhile.
613 stat = hwif->tp_ops->read_status(hwif);
615 if ((drive->dev_flags & IDE_DFLAG_DSC_OVERLAP) == 0 &&
616 (rq->cmd[13] & REQ_IDETAPE_PC2) == 0)
617 drive->atapi_flags |= IDE_AFLAG_IGNORE_DSC;
619 if (drive->dev_flags & IDE_DFLAG_POST_RESET) {
620 drive->atapi_flags |= IDE_AFLAG_IGNORE_DSC;
621 drive->dev_flags &= ~IDE_DFLAG_POST_RESET;
624 if (!(drive->atapi_flags & IDE_AFLAG_IGNORE_DSC) &&
626 if (postponed_rq == NULL) {
627 tape->dsc_polling_start = jiffies;
628 tape->dsc_poll_freq = tape->best_dsc_rw_freq;
629 tape->dsc_timeout = jiffies + IDETAPE_DSC_RW_TIMEOUT;
630 } else if (time_after(jiffies, tape->dsc_timeout)) {
631 printk(KERN_ERR "ide-tape: %s: DSC timeout\n",
633 if (rq->cmd[13] & REQ_IDETAPE_PC2) {
634 idetape_media_access_finished(drive);
637 return ide_do_reset(drive);
639 } else if (time_after(jiffies,
640 tape->dsc_polling_start +
641 IDETAPE_DSC_MA_THRESHOLD))
642 tape->dsc_poll_freq = IDETAPE_DSC_MA_SLOW;
643 idetape_postpone_request(drive);
646 drive->atapi_flags &= ~IDE_AFLAG_IGNORE_DSC;
648 if (rq->cmd[13] & REQ_IDETAPE_READ) {
649 pc = &tape->queued_pc;
650 ide_tape_create_rw_cmd(tape, pc, rq, READ_6);
653 if (rq->cmd[13] & REQ_IDETAPE_WRITE) {
654 pc = &tape->queued_pc;
655 ide_tape_create_rw_cmd(tape, pc, rq, WRITE_6);
658 if (rq->cmd[13] & REQ_IDETAPE_PC1) {
659 pc = (struct ide_atapi_pc *)rq->special;
660 rq->cmd[13] &= ~(REQ_IDETAPE_PC1);
661 rq->cmd[13] |= REQ_IDETAPE_PC2;
664 if (rq->cmd[13] & REQ_IDETAPE_PC2) {
665 idetape_media_access_finished(drive);
671 /* prepare sense request for this command */
672 ide_prep_sense(drive, rq);
674 memset(&cmd, 0, sizeof(cmd));
677 cmd.tf_flags |= IDE_TFLAG_WRITE;
681 ide_init_sg_cmd(&cmd, blk_rq_bytes(rq));
682 ide_map_sg(drive, &cmd);
684 return ide_tape_issue_pc(drive, &cmd, pc);
688 * Write a filemark if write_filemark=1. Flush the device buffers without
689 * writing a filemark otherwise.
691 static void idetape_create_write_filemark_cmd(ide_drive_t *drive,
692 struct ide_atapi_pc *pc, int write_filemark)
695 pc->c[0] = WRITE_FILEMARKS;
696 pc->c[4] = write_filemark;
697 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
700 static int idetape_wait_ready(ide_drive_t *drive, unsigned long timeout)
702 idetape_tape_t *tape = drive->driver_data;
703 struct gendisk *disk = tape->disk;
704 int load_attempted = 0;
706 /* Wait for the tape to become ready */
707 set_bit(ilog2(IDE_AFLAG_MEDIUM_PRESENT), &drive->atapi_flags);
709 while (time_before(jiffies, timeout)) {
710 if (ide_do_test_unit_ready(drive, disk) == 0)
712 if ((tape->sense_key == 2 && tape->asc == 4 && tape->ascq == 2)
713 || (tape->asc == 0x3A)) {
717 ide_do_start_stop(drive, disk, IDETAPE_LU_LOAD_MASK);
719 /* not about to be ready */
720 } else if (!(tape->sense_key == 2 && tape->asc == 4 &&
721 (tape->ascq == 1 || tape->ascq == 8)))
728 static int idetape_flush_tape_buffers(ide_drive_t *drive)
730 struct ide_tape_obj *tape = drive->driver_data;
731 struct ide_atapi_pc pc;
734 idetape_create_write_filemark_cmd(drive, &pc, 0);
735 rc = ide_queue_pc_tail(drive, tape->disk, &pc, NULL, 0);
738 idetape_wait_ready(drive, 60 * 5 * HZ);
742 static int ide_tape_read_position(ide_drive_t *drive)
744 idetape_tape_t *tape = drive->driver_data;
745 struct ide_atapi_pc pc;
748 debug_log(DBG_PROCS, "Enter %s\n", __func__);
752 pc.c[0] = READ_POSITION;
755 if (ide_queue_pc_tail(drive, tape->disk, &pc, buf, pc.req_xfer))
759 debug_log(DBG_SENSE, "BOP - %s\n",
760 (buf[0] & 0x80) ? "Yes" : "No");
761 debug_log(DBG_SENSE, "EOP - %s\n",
762 (buf[0] & 0x40) ? "Yes" : "No");
765 printk(KERN_INFO "ide-tape: Block location is unknown"
767 clear_bit(ilog2(IDE_AFLAG_ADDRESS_VALID),
768 &drive->atapi_flags);
771 debug_log(DBG_SENSE, "Block Location - %u\n",
772 be32_to_cpup((__be32 *)&buf[4]));
774 tape->partition = buf[1];
775 tape->first_frame = be32_to_cpup((__be32 *)&buf[4]);
776 set_bit(ilog2(IDE_AFLAG_ADDRESS_VALID),
777 &drive->atapi_flags);
781 return tape->first_frame;
784 static void idetape_create_locate_cmd(ide_drive_t *drive,
785 struct ide_atapi_pc *pc,
786 unsigned int block, u8 partition, int skip)
789 pc->c[0] = POSITION_TO_ELEMENT;
791 put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[3]);
792 pc->c[8] = partition;
793 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
796 static void __ide_tape_discard_merge_buffer(ide_drive_t *drive)
798 idetape_tape_t *tape = drive->driver_data;
800 if (tape->chrdev_dir != IDETAPE_DIR_READ)
803 clear_bit(ilog2(IDE_AFLAG_FILEMARK), &drive->atapi_flags);
805 if (tape->buf != NULL) {
810 tape->chrdev_dir = IDETAPE_DIR_NONE;
814 * Position the tape to the requested block using the LOCATE packet command.
815 * A READ POSITION command is then issued to check where we are positioned. Like
816 * all higher level operations, we queue the commands at the tail of the request
817 * queue and wait for their completion.
819 static int idetape_position_tape(ide_drive_t *drive, unsigned int block,
820 u8 partition, int skip)
822 idetape_tape_t *tape = drive->driver_data;
823 struct gendisk *disk = tape->disk;
825 struct ide_atapi_pc pc;
827 if (tape->chrdev_dir == IDETAPE_DIR_READ)
828 __ide_tape_discard_merge_buffer(drive);
829 idetape_wait_ready(drive, 60 * 5 * HZ);
830 idetape_create_locate_cmd(drive, &pc, block, partition, skip);
831 ret = ide_queue_pc_tail(drive, disk, &pc, NULL, 0);
835 ret = ide_tape_read_position(drive);
841 static void ide_tape_discard_merge_buffer(ide_drive_t *drive,
842 int restore_position)
844 idetape_tape_t *tape = drive->driver_data;
847 __ide_tape_discard_merge_buffer(drive);
848 if (restore_position) {
849 position = ide_tape_read_position(drive);
850 seek = position > 0 ? position : 0;
851 if (idetape_position_tape(drive, seek, 0, 0)) {
852 printk(KERN_INFO "ide-tape: %s: position_tape failed in"
853 " %s\n", tape->name, __func__);
860 * Generate a read/write request for the block device interface and wait for it
863 static int idetape_queue_rw_tail(ide_drive_t *drive, int cmd, int size)
865 idetape_tape_t *tape = drive->driver_data;
869 debug_log(DBG_SENSE, "%s: cmd=%d\n", __func__, cmd);
870 BUG_ON(cmd != REQ_IDETAPE_READ && cmd != REQ_IDETAPE_WRITE);
871 BUG_ON(size < 0 || size % tape->blk_size);
873 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
874 rq->cmd_type = REQ_TYPE_SPECIAL;
876 rq->rq_disk = tape->disk;
877 rq->__sector = tape->first_frame;
880 ret = blk_rq_map_kern(drive->queue, rq, tape->buf, size,
886 blk_execute_rq(drive->queue, tape->disk, rq, 0);
888 /* calculate the number of transferred bytes and update buffer state */
889 size -= rq->resid_len;
890 tape->cur = tape->buf;
891 if (cmd == REQ_IDETAPE_READ)
897 if (rq->errors == IDE_DRV_ERROR_GENERAL)
904 static void idetape_create_inquiry_cmd(struct ide_atapi_pc *pc)
912 static void idetape_create_rewind_cmd(ide_drive_t *drive,
913 struct ide_atapi_pc *pc)
916 pc->c[0] = REZERO_UNIT;
917 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
920 static void idetape_create_erase_cmd(struct ide_atapi_pc *pc)
925 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
928 static void idetape_create_space_cmd(struct ide_atapi_pc *pc, int count, u8 cmd)
932 put_unaligned(cpu_to_be32(count), (unsigned int *) &pc->c[1]);
934 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
937 static void ide_tape_flush_merge_buffer(ide_drive_t *drive)
939 idetape_tape_t *tape = drive->driver_data;
941 if (tape->chrdev_dir != IDETAPE_DIR_WRITE) {
942 printk(KERN_ERR "ide-tape: bug: Trying to empty merge buffer"
943 " but we are not writing.\n");
947 size_t aligned = roundup(tape->valid, tape->blk_size);
949 memset(tape->cur, 0, aligned - tape->valid);
950 idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE, aligned);
954 tape->chrdev_dir = IDETAPE_DIR_NONE;
957 static int idetape_init_rw(ide_drive_t *drive, int dir)
959 idetape_tape_t *tape = drive->driver_data;
962 BUG_ON(dir != IDETAPE_DIR_READ && dir != IDETAPE_DIR_WRITE);
964 if (tape->chrdev_dir == dir)
967 if (tape->chrdev_dir == IDETAPE_DIR_READ)
968 ide_tape_discard_merge_buffer(drive, 1);
969 else if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
970 ide_tape_flush_merge_buffer(drive);
971 idetape_flush_tape_buffers(drive);
974 if (tape->buf || tape->valid) {
975 printk(KERN_ERR "ide-tape: valid should be 0 now\n");
979 tape->buf = kmalloc(tape->buffer_size, GFP_KERNEL);
982 tape->chrdev_dir = dir;
983 tape->cur = tape->buf;
986 * Issue a 0 rw command to ensure that DSC handshake is
987 * switched from completion mode to buffer available mode. No
988 * point in issuing this if DSC overlap isn't supported, some
989 * drives (Seagate STT3401A) will return an error.
991 if (drive->dev_flags & IDE_DFLAG_DSC_OVERLAP) {
992 int cmd = dir == IDETAPE_DIR_READ ? REQ_IDETAPE_READ
995 rc = idetape_queue_rw_tail(drive, cmd, 0);
999 tape->chrdev_dir = IDETAPE_DIR_NONE;
1007 static void idetape_pad_zeros(ide_drive_t *drive, int bcount)
1009 idetape_tape_t *tape = drive->driver_data;
1011 memset(tape->buf, 0, tape->buffer_size);
1014 unsigned int count = min(tape->buffer_size, bcount);
1016 idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE, count);
1022 * Rewinds the tape to the Beginning Of the current Partition (BOP). We
1023 * currently support only one partition.
1025 static int idetape_rewind_tape(ide_drive_t *drive)
1027 struct ide_tape_obj *tape = drive->driver_data;
1028 struct gendisk *disk = tape->disk;
1029 struct ide_atapi_pc pc;
1032 debug_log(DBG_SENSE, "Enter %s\n", __func__);
1034 idetape_create_rewind_cmd(drive, &pc);
1035 ret = ide_queue_pc_tail(drive, disk, &pc, NULL, 0);
1039 ret = ide_tape_read_position(drive);
1045 /* mtio.h compatible commands should be issued to the chrdev interface. */
1046 static int idetape_blkdev_ioctl(ide_drive_t *drive, unsigned int cmd,
1049 idetape_tape_t *tape = drive->driver_data;
1050 void __user *argp = (void __user *)arg;
1052 struct idetape_config {
1053 int dsc_rw_frequency;
1054 int dsc_media_access_frequency;
1058 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1062 if (copy_from_user(&config, argp, sizeof(config)))
1064 tape->best_dsc_rw_freq = config.dsc_rw_frequency;
1067 memset(&config, 0, sizeof(config));
1068 config.dsc_rw_frequency = (int) tape->best_dsc_rw_freq;
1069 config.nr_stages = 1;
1070 if (copy_to_user(argp, &config, sizeof(config)))
1079 static int idetape_space_over_filemarks(ide_drive_t *drive, short mt_op,
1082 idetape_tape_t *tape = drive->driver_data;
1083 struct gendisk *disk = tape->disk;
1084 struct ide_atapi_pc pc;
1085 int retval, count = 0;
1086 int sprev = !!(tape->caps[4] & 0x20);
1090 if (MTBSF == mt_op || MTBSFM == mt_op) {
1093 mt_count = -mt_count;
1096 if (tape->chrdev_dir == IDETAPE_DIR_READ) {
1098 if (test_and_clear_bit(ilog2(IDE_AFLAG_FILEMARK),
1099 &drive->atapi_flags))
1101 ide_tape_discard_merge_buffer(drive, 0);
1107 idetape_create_space_cmd(&pc, mt_count - count,
1108 IDETAPE_SPACE_OVER_FILEMARK);
1109 return ide_queue_pc_tail(drive, disk, &pc, NULL, 0);
1114 retval = idetape_space_over_filemarks(drive, MTFSF,
1118 count = (MTBSFM == mt_op ? 1 : -1);
1119 return idetape_space_over_filemarks(drive, MTFSF, count);
1121 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
1128 * Our character device read / write functions.
1130 * The tape is optimized to maximize throughput when it is transferring an
1131 * integral number of the "continuous transfer limit", which is a parameter of
1132 * the specific tape (26kB on my particular tape, 32kB for Onstream).
1134 * As of version 1.3 of the driver, the character device provides an abstract
1135 * continuous view of the media - any mix of block sizes (even 1 byte) on the
1136 * same backup/restore procedure is supported. The driver will internally
1137 * convert the requests to the recommended transfer unit, so that an unmatch
1138 * between the user's block size to the recommended size will only result in a
1139 * (slightly) increased driver overhead, but will no longer hit performance.
1140 * This is not applicable to Onstream.
1142 static ssize_t idetape_chrdev_read(struct file *file, char __user *buf,
1143 size_t count, loff_t *ppos)
1145 struct ide_tape_obj *tape = file->private_data;
1146 ide_drive_t *drive = tape->drive;
1151 debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
1153 if (tape->chrdev_dir != IDETAPE_DIR_READ) {
1154 if (test_bit(ilog2(IDE_AFLAG_DETECT_BS), &drive->atapi_flags))
1155 if (count > tape->blk_size &&
1156 (count % tape->blk_size) == 0)
1157 tape->user_bs_factor = count / tape->blk_size;
1160 rc = idetape_init_rw(drive, IDETAPE_DIR_READ);
1164 while (done < count) {
1167 /* refill if staging buffer is empty */
1169 /* If we are at a filemark, nothing more to read */
1170 if (test_bit(ilog2(IDE_AFLAG_FILEMARK),
1171 &drive->atapi_flags))
1174 if (idetape_queue_rw_tail(drive, REQ_IDETAPE_READ,
1175 tape->buffer_size) <= 0)
1180 todo = min_t(size_t, count - done, tape->valid);
1181 if (copy_to_user(buf + done, tape->cur, todo))
1185 tape->valid -= todo;
1189 if (!done && test_bit(ilog2(IDE_AFLAG_FILEMARK), &drive->atapi_flags)) {
1190 debug_log(DBG_SENSE, "%s: spacing over filemark\n", tape->name);
1192 idetape_space_over_filemarks(drive, MTFSF, 1);
1196 return ret ? ret : done;
1199 static ssize_t idetape_chrdev_write(struct file *file, const char __user *buf,
1200 size_t count, loff_t *ppos)
1202 struct ide_tape_obj *tape = file->private_data;
1203 ide_drive_t *drive = tape->drive;
1208 /* The drive is write protected. */
1209 if (tape->write_prot)
1212 debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
1214 /* Initialize write operation */
1215 rc = idetape_init_rw(drive, IDETAPE_DIR_WRITE);
1219 while (done < count) {
1222 /* flush if staging buffer is full */
1223 if (tape->valid == tape->buffer_size &&
1224 idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE,
1225 tape->buffer_size) <= 0)
1229 todo = min_t(size_t, count - done,
1230 tape->buffer_size - tape->valid);
1231 if (copy_from_user(tape->cur, buf + done, todo))
1235 tape->valid += todo;
1239 return ret ? ret : done;
1242 static int idetape_write_filemark(ide_drive_t *drive)
1244 struct ide_tape_obj *tape = drive->driver_data;
1245 struct ide_atapi_pc pc;
1247 /* Write a filemark */
1248 idetape_create_write_filemark_cmd(drive, &pc, 1);
1249 if (ide_queue_pc_tail(drive, tape->disk, &pc, NULL, 0)) {
1250 printk(KERN_ERR "ide-tape: Couldn't write a filemark\n");
1257 * Called from idetape_chrdev_ioctl when the general mtio MTIOCTOP ioctl is
1260 * Note: MTBSF and MTBSFM are not supported when the tape doesn't support
1261 * spacing over filemarks in the reverse direction. In this case, MTFSFM is also
1262 * usually not supported.
1264 * The following commands are currently not supported:
1266 * MTFSS, MTBSS, MTWSM, MTSETDENSITY, MTSETDRVBUFFER, MT_ST_BOOLEANS,
1267 * MT_ST_WRITE_THRESHOLD.
1269 static int idetape_mtioctop(ide_drive_t *drive, short mt_op, int mt_count)
1271 idetape_tape_t *tape = drive->driver_data;
1272 struct gendisk *disk = tape->disk;
1273 struct ide_atapi_pc pc;
1276 debug_log(DBG_ERR, "Handling MTIOCTOP ioctl: mt_op=%d, mt_count=%d\n",
1286 return idetape_space_over_filemarks(drive, mt_op, mt_count);
1293 if (tape->write_prot)
1295 ide_tape_discard_merge_buffer(drive, 1);
1296 for (i = 0; i < mt_count; i++) {
1297 retval = idetape_write_filemark(drive);
1303 ide_tape_discard_merge_buffer(drive, 0);
1304 if (idetape_rewind_tape(drive))
1308 ide_tape_discard_merge_buffer(drive, 0);
1309 return ide_do_start_stop(drive, disk, IDETAPE_LU_LOAD_MASK);
1313 * If door is locked, attempt to unlock before
1314 * attempting to eject.
1316 if (tape->door_locked) {
1317 if (!ide_set_media_lock(drive, disk, 0))
1318 tape->door_locked = DOOR_UNLOCKED;
1320 ide_tape_discard_merge_buffer(drive, 0);
1321 retval = ide_do_start_stop(drive, disk, !IDETAPE_LU_LOAD_MASK);
1323 clear_bit(ilog2(IDE_AFLAG_MEDIUM_PRESENT),
1324 &drive->atapi_flags);
1327 ide_tape_discard_merge_buffer(drive, 0);
1328 return idetape_flush_tape_buffers(drive);
1330 ide_tape_discard_merge_buffer(drive, 0);
1331 return ide_do_start_stop(drive, disk,
1332 IDETAPE_LU_RETENSION_MASK | IDETAPE_LU_LOAD_MASK);
1334 idetape_create_space_cmd(&pc, 0, IDETAPE_SPACE_TO_EOD);
1335 return ide_queue_pc_tail(drive, disk, &pc, NULL, 0);
1337 (void)idetape_rewind_tape(drive);
1338 idetape_create_erase_cmd(&pc);
1339 return ide_queue_pc_tail(drive, disk, &pc, NULL, 0);
1342 if (mt_count < tape->blk_size ||
1343 mt_count % tape->blk_size)
1345 tape->user_bs_factor = mt_count / tape->blk_size;
1346 clear_bit(ilog2(IDE_AFLAG_DETECT_BS),
1347 &drive->atapi_flags);
1349 set_bit(ilog2(IDE_AFLAG_DETECT_BS),
1350 &drive->atapi_flags);
1353 ide_tape_discard_merge_buffer(drive, 0);
1354 return idetape_position_tape(drive,
1355 mt_count * tape->user_bs_factor, tape->partition, 0);
1357 ide_tape_discard_merge_buffer(drive, 0);
1358 return idetape_position_tape(drive, 0, mt_count, 0);
1362 retval = ide_set_media_lock(drive, disk, 1);
1365 tape->door_locked = DOOR_EXPLICITLY_LOCKED;
1368 retval = ide_set_media_lock(drive, disk, 0);
1371 tape->door_locked = DOOR_UNLOCKED;
1374 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
1381 * Our character device ioctls. General mtio.h magnetic io commands are
1382 * supported here, and not in the corresponding block interface. Our own
1383 * ide-tape ioctls are supported on both interfaces.
1385 static int idetape_chrdev_ioctl(struct inode *inode, struct file *file,
1386 unsigned int cmd, unsigned long arg)
1388 struct ide_tape_obj *tape = file->private_data;
1389 ide_drive_t *drive = tape->drive;
1393 int block_offset = 0, position = tape->first_frame;
1394 void __user *argp = (void __user *)arg;
1396 debug_log(DBG_CHRDEV, "Enter %s, cmd=%u\n", __func__, cmd);
1398 if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
1399 ide_tape_flush_merge_buffer(drive);
1400 idetape_flush_tape_buffers(drive);
1402 if (cmd == MTIOCGET || cmd == MTIOCPOS) {
1403 block_offset = tape->valid /
1404 (tape->blk_size * tape->user_bs_factor);
1405 position = ide_tape_read_position(drive);
1411 if (copy_from_user(&mtop, argp, sizeof(struct mtop)))
1413 return idetape_mtioctop(drive, mtop.mt_op, mtop.mt_count);
1415 memset(&mtget, 0, sizeof(struct mtget));
1416 mtget.mt_type = MT_ISSCSI2;
1417 mtget.mt_blkno = position / tape->user_bs_factor - block_offset;
1419 ((tape->blk_size * tape->user_bs_factor)
1420 << MT_ST_BLKSIZE_SHIFT) & MT_ST_BLKSIZE_MASK;
1422 if (tape->drv_write_prot)
1423 mtget.mt_gstat |= GMT_WR_PROT(0xffffffff);
1425 if (copy_to_user(argp, &mtget, sizeof(struct mtget)))
1429 mtpos.mt_blkno = position / tape->user_bs_factor - block_offset;
1430 if (copy_to_user(argp, &mtpos, sizeof(struct mtpos)))
1434 if (tape->chrdev_dir == IDETAPE_DIR_READ)
1435 ide_tape_discard_merge_buffer(drive, 1);
1436 return idetape_blkdev_ioctl(drive, cmd, arg);
1441 * Do a mode sense page 0 with block descriptor and if it succeeds set the tape
1442 * block size with the reported value.
1444 static void ide_tape_get_bsize_from_bdesc(ide_drive_t *drive)
1446 idetape_tape_t *tape = drive->driver_data;
1447 struct ide_atapi_pc pc;
1450 idetape_create_mode_sense_cmd(&pc, IDETAPE_BLOCK_DESCRIPTOR);
1451 if (ide_queue_pc_tail(drive, tape->disk, &pc, buf, pc.req_xfer)) {
1452 printk(KERN_ERR "ide-tape: Can't get block descriptor\n");
1453 if (tape->blk_size == 0) {
1454 printk(KERN_WARNING "ide-tape: Cannot deal with zero "
1455 "block size, assuming 32k\n");
1456 tape->blk_size = 32768;
1460 tape->blk_size = (buf[4 + 5] << 16) +
1463 tape->drv_write_prot = (buf[2] & 0x80) >> 7;
1466 static int idetape_chrdev_open(struct inode *inode, struct file *filp)
1468 unsigned int minor = iminor(inode), i = minor & ~0xc0;
1470 idetape_tape_t *tape;
1473 if (i >= MAX_HWIFS * MAX_DRIVES)
1477 tape = ide_tape_get(NULL, true, i);
1483 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
1486 * We really want to do nonseekable_open(inode, filp); here, but some
1487 * versions of tar incorrectly call lseek on tapes and bail out if that
1488 * fails. So we disallow pread() and pwrite(), but permit lseeks.
1490 filp->f_mode &= ~(FMODE_PREAD | FMODE_PWRITE);
1492 drive = tape->drive;
1494 filp->private_data = tape;
1496 if (test_and_set_bit(ilog2(IDE_AFLAG_BUSY), &drive->atapi_flags)) {
1501 retval = idetape_wait_ready(drive, 60 * HZ);
1503 clear_bit(ilog2(IDE_AFLAG_BUSY), &drive->atapi_flags);
1504 printk(KERN_ERR "ide-tape: %s: drive not ready\n", tape->name);
1508 ide_tape_read_position(drive);
1509 if (!test_bit(ilog2(IDE_AFLAG_ADDRESS_VALID), &drive->atapi_flags))
1510 (void)idetape_rewind_tape(drive);
1512 /* Read block size and write protect status from drive. */
1513 ide_tape_get_bsize_from_bdesc(drive);
1515 /* Set write protect flag if device is opened as read-only. */
1516 if ((filp->f_flags & O_ACCMODE) == O_RDONLY)
1517 tape->write_prot = 1;
1519 tape->write_prot = tape->drv_write_prot;
1521 /* Make sure drive isn't write protected if user wants to write. */
1522 if (tape->write_prot) {
1523 if ((filp->f_flags & O_ACCMODE) == O_WRONLY ||
1524 (filp->f_flags & O_ACCMODE) == O_RDWR) {
1525 clear_bit(ilog2(IDE_AFLAG_BUSY), &drive->atapi_flags);
1531 /* Lock the tape drive door so user can't eject. */
1532 if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
1533 if (!ide_set_media_lock(drive, tape->disk, 1)) {
1534 if (tape->door_locked != DOOR_EXPLICITLY_LOCKED)
1535 tape->door_locked = DOOR_LOCKED;
1547 static void idetape_write_release(ide_drive_t *drive, unsigned int minor)
1549 idetape_tape_t *tape = drive->driver_data;
1551 ide_tape_flush_merge_buffer(drive);
1552 tape->buf = kmalloc(tape->buffer_size, GFP_KERNEL);
1553 if (tape->buf != NULL) {
1554 idetape_pad_zeros(drive, tape->blk_size *
1555 (tape->user_bs_factor - 1));
1559 idetape_write_filemark(drive);
1560 idetape_flush_tape_buffers(drive);
1561 idetape_flush_tape_buffers(drive);
1564 static int idetape_chrdev_release(struct inode *inode, struct file *filp)
1566 struct ide_tape_obj *tape = filp->private_data;
1567 ide_drive_t *drive = tape->drive;
1568 unsigned int minor = iminor(inode);
1571 tape = drive->driver_data;
1573 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
1575 if (tape->chrdev_dir == IDETAPE_DIR_WRITE)
1576 idetape_write_release(drive, minor);
1577 if (tape->chrdev_dir == IDETAPE_DIR_READ) {
1579 ide_tape_discard_merge_buffer(drive, 1);
1582 if (minor < 128 && test_bit(ilog2(IDE_AFLAG_MEDIUM_PRESENT),
1583 &drive->atapi_flags))
1584 (void) idetape_rewind_tape(drive);
1586 if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
1587 if (tape->door_locked == DOOR_LOCKED) {
1588 if (!ide_set_media_lock(drive, tape->disk, 0))
1589 tape->door_locked = DOOR_UNLOCKED;
1592 clear_bit(ilog2(IDE_AFLAG_BUSY), &drive->atapi_flags);
1598 static void idetape_get_inquiry_results(ide_drive_t *drive)
1600 idetape_tape_t *tape = drive->driver_data;
1601 struct ide_atapi_pc pc;
1603 char fw_rev[4], vendor_id[8], product_id[16];
1605 idetape_create_inquiry_cmd(&pc);
1606 if (ide_queue_pc_tail(drive, tape->disk, &pc, pc_buf, pc.req_xfer)) {
1607 printk(KERN_ERR "ide-tape: %s: can't get INQUIRY results\n",
1611 memcpy(vendor_id, &pc_buf[8], 8);
1612 memcpy(product_id, &pc_buf[16], 16);
1613 memcpy(fw_rev, &pc_buf[32], 4);
1615 ide_fixstring(vendor_id, 8, 0);
1616 ide_fixstring(product_id, 16, 0);
1617 ide_fixstring(fw_rev, 4, 0);
1619 printk(KERN_INFO "ide-tape: %s <-> %s: %.8s %.16s rev %.4s\n",
1620 drive->name, tape->name, vendor_id, product_id, fw_rev);
1624 * Ask the tape about its various parameters. In particular, we will adjust our
1625 * data transfer buffer size to the recommended value as returned by the tape.
1627 static void idetape_get_mode_sense_results(ide_drive_t *drive)
1629 idetape_tape_t *tape = drive->driver_data;
1630 struct ide_atapi_pc pc;
1632 u8 speed, max_speed;
1634 idetape_create_mode_sense_cmd(&pc, IDETAPE_CAPABILITIES_PAGE);
1635 if (ide_queue_pc_tail(drive, tape->disk, &pc, buf, pc.req_xfer)) {
1636 printk(KERN_ERR "ide-tape: Can't get tape parameters - assuming"
1637 " some default values\n");
1638 tape->blk_size = 512;
1639 put_unaligned(52, (u16 *)&tape->caps[12]);
1640 put_unaligned(540, (u16 *)&tape->caps[14]);
1641 put_unaligned(6*52, (u16 *)&tape->caps[16]);
1644 caps = buf + 4 + buf[3];
1646 /* convert to host order and save for later use */
1647 speed = be16_to_cpup((__be16 *)&caps[14]);
1648 max_speed = be16_to_cpup((__be16 *)&caps[8]);
1650 *(u16 *)&caps[8] = max_speed;
1651 *(u16 *)&caps[12] = be16_to_cpup((__be16 *)&caps[12]);
1652 *(u16 *)&caps[14] = speed;
1653 *(u16 *)&caps[16] = be16_to_cpup((__be16 *)&caps[16]);
1656 printk(KERN_INFO "ide-tape: %s: invalid tape speed "
1657 "(assuming 650KB/sec)\n", drive->name);
1658 *(u16 *)&caps[14] = 650;
1661 printk(KERN_INFO "ide-tape: %s: invalid max_speed "
1662 "(assuming 650KB/sec)\n", drive->name);
1663 *(u16 *)&caps[8] = 650;
1666 memcpy(&tape->caps, caps, 20);
1668 /* device lacks locking support according to capabilities page */
1669 if ((caps[6] & 1) == 0)
1670 drive->dev_flags &= ~IDE_DFLAG_DOORLOCKING;
1673 tape->blk_size = 512;
1674 else if (caps[7] & 0x04)
1675 tape->blk_size = 1024;
1678 #ifdef CONFIG_IDE_PROC_FS
1679 #define ide_tape_devset_get(name, field) \
1680 static int get_##name(ide_drive_t *drive) \
1682 idetape_tape_t *tape = drive->driver_data; \
1683 return tape->field; \
1686 #define ide_tape_devset_set(name, field) \
1687 static int set_##name(ide_drive_t *drive, int arg) \
1689 idetape_tape_t *tape = drive->driver_data; \
1690 tape->field = arg; \
1694 #define ide_tape_devset_rw_field(_name, _field) \
1695 ide_tape_devset_get(_name, _field) \
1696 ide_tape_devset_set(_name, _field) \
1697 IDE_DEVSET(_name, DS_SYNC, get_##_name, set_##_name)
1699 #define ide_tape_devset_r_field(_name, _field) \
1700 ide_tape_devset_get(_name, _field) \
1701 IDE_DEVSET(_name, 0, get_##_name, NULL)
1703 static int mulf_tdsc(ide_drive_t *drive) { return 1000; }
1704 static int divf_tdsc(ide_drive_t *drive) { return HZ; }
1705 static int divf_buffer(ide_drive_t *drive) { return 2; }
1706 static int divf_buffer_size(ide_drive_t *drive) { return 1024; }
1708 ide_devset_rw_flag(dsc_overlap, IDE_DFLAG_DSC_OVERLAP);
1710 ide_tape_devset_rw_field(debug_mask, debug_mask);
1711 ide_tape_devset_rw_field(tdsc, best_dsc_rw_freq);
1713 ide_tape_devset_r_field(avg_speed, avg_speed);
1714 ide_tape_devset_r_field(speed, caps[14]);
1715 ide_tape_devset_r_field(buffer, caps[16]);
1716 ide_tape_devset_r_field(buffer_size, buffer_size);
1718 static const struct ide_proc_devset idetape_settings[] = {
1719 __IDE_PROC_DEVSET(avg_speed, 0, 0xffff, NULL, NULL),
1720 __IDE_PROC_DEVSET(buffer, 0, 0xffff, NULL, divf_buffer),
1721 __IDE_PROC_DEVSET(buffer_size, 0, 0xffff, NULL, divf_buffer_size),
1722 __IDE_PROC_DEVSET(debug_mask, 0, 0xffff, NULL, NULL),
1723 __IDE_PROC_DEVSET(dsc_overlap, 0, 1, NULL, NULL),
1724 __IDE_PROC_DEVSET(speed, 0, 0xffff, NULL, NULL),
1725 __IDE_PROC_DEVSET(tdsc, IDETAPE_DSC_RW_MIN, IDETAPE_DSC_RW_MAX,
1726 mulf_tdsc, divf_tdsc),
1732 * The function below is called to:
1734 * 1. Initialize our various state variables.
1735 * 2. Ask the tape for its capabilities.
1736 * 3. Allocate a buffer which will be used for data transfer. The buffer size
1737 * is chosen based on the recommendation which we received in step 2.
1739 * Note that at this point ide.c already assigned us an irq, so that we can
1740 * queue requests here and wait for their completion.
1742 static void idetape_setup(ide_drive_t *drive, idetape_tape_t *tape, int minor)
1747 u16 *ctl = (u16 *)&tape->caps[12];
1749 drive->pc_callback = ide_tape_callback;
1751 drive->dev_flags |= IDE_DFLAG_DSC_OVERLAP;
1753 if (drive->hwif->host_flags & IDE_HFLAG_NO_DSC) {
1754 printk(KERN_INFO "ide-tape: %s: disabling DSC overlap\n",
1756 drive->dev_flags &= ~IDE_DFLAG_DSC_OVERLAP;
1759 /* Seagate Travan drives do not support DSC overlap. */
1760 if (strstr((char *)&drive->id[ATA_ID_PROD], "Seagate STT3401"))
1761 drive->dev_flags &= ~IDE_DFLAG_DSC_OVERLAP;
1763 tape->minor = minor;
1764 tape->name[0] = 'h';
1765 tape->name[1] = 't';
1766 tape->name[2] = '0' + minor;
1767 tape->chrdev_dir = IDETAPE_DIR_NONE;
1769 idetape_get_inquiry_results(drive);
1770 idetape_get_mode_sense_results(drive);
1771 ide_tape_get_bsize_from_bdesc(drive);
1772 tape->user_bs_factor = 1;
1773 tape->buffer_size = *ctl * tape->blk_size;
1774 while (tape->buffer_size > 0xffff) {
1775 printk(KERN_NOTICE "ide-tape: decreasing stage size\n");
1777 tape->buffer_size = *ctl * tape->blk_size;
1779 buffer_size = tape->buffer_size;
1781 /* select the "best" DSC read/write polling freq */
1782 speed = max(*(u16 *)&tape->caps[14], *(u16 *)&tape->caps[8]);
1784 t = (IDETAPE_FIFO_THRESHOLD * tape->buffer_size * HZ) / (speed * 1000);
1787 * Ensure that the number we got makes sense; limit it within
1788 * IDETAPE_DSC_RW_MIN and IDETAPE_DSC_RW_MAX.
1790 tape->best_dsc_rw_freq = clamp_t(unsigned long, t, IDETAPE_DSC_RW_MIN,
1791 IDETAPE_DSC_RW_MAX);
1792 printk(KERN_INFO "ide-tape: %s <-> %s: %dKBps, %d*%dkB buffer, "
1794 drive->name, tape->name, *(u16 *)&tape->caps[14],
1795 (*(u16 *)&tape->caps[16] * 512) / tape->buffer_size,
1796 tape->buffer_size / 1024,
1797 tape->best_dsc_rw_freq * 1000 / HZ,
1798 (drive->dev_flags & IDE_DFLAG_USING_DMA) ? ", DMA" : "");
1800 ide_proc_register_driver(drive, tape->driver);
1803 static void ide_tape_remove(ide_drive_t *drive)
1805 idetape_tape_t *tape = drive->driver_data;
1807 ide_proc_unregister_driver(drive, tape->driver);
1808 device_del(&tape->dev);
1809 ide_unregister_region(tape->disk);
1811 mutex_lock(&idetape_ref_mutex);
1812 put_device(&tape->dev);
1813 mutex_unlock(&idetape_ref_mutex);
1816 static void ide_tape_release(struct device *dev)
1818 struct ide_tape_obj *tape = to_ide_drv(dev, ide_tape_obj);
1819 ide_drive_t *drive = tape->drive;
1820 struct gendisk *g = tape->disk;
1822 BUG_ON(tape->valid);
1824 drive->dev_flags &= ~IDE_DFLAG_DSC_OVERLAP;
1825 drive->driver_data = NULL;
1826 device_destroy(idetape_sysfs_class, MKDEV(IDETAPE_MAJOR, tape->minor));
1827 device_destroy(idetape_sysfs_class,
1828 MKDEV(IDETAPE_MAJOR, tape->minor + 128));
1829 idetape_devs[tape->minor] = NULL;
1830 g->private_data = NULL;
1835 #ifdef CONFIG_IDE_PROC_FS
1836 static int proc_idetape_read_name
1837 (char *page, char **start, off_t off, int count, int *eof, void *data)
1839 ide_drive_t *drive = (ide_drive_t *) data;
1840 idetape_tape_t *tape = drive->driver_data;
1844 len = sprintf(out, "%s\n", tape->name);
1845 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
1848 static ide_proc_entry_t idetape_proc[] = {
1849 { "capacity", S_IFREG|S_IRUGO, proc_ide_read_capacity, NULL },
1850 { "name", S_IFREG|S_IRUGO, proc_idetape_read_name, NULL },
1851 { NULL, 0, NULL, NULL }
1854 static ide_proc_entry_t *ide_tape_proc_entries(ide_drive_t *drive)
1856 return idetape_proc;
1859 static const struct ide_proc_devset *ide_tape_proc_devsets(ide_drive_t *drive)
1861 return idetape_settings;
1865 static int ide_tape_probe(ide_drive_t *);
1867 static struct ide_driver idetape_driver = {
1869 .owner = THIS_MODULE,
1871 .bus = &ide_bus_type,
1873 .probe = ide_tape_probe,
1874 .remove = ide_tape_remove,
1875 .version = IDETAPE_VERSION,
1876 .do_request = idetape_do_request,
1877 #ifdef CONFIG_IDE_PROC_FS
1878 .proc_entries = ide_tape_proc_entries,
1879 .proc_devsets = ide_tape_proc_devsets,
1883 /* Our character device supporting functions, passed to register_chrdev. */
1884 static const struct file_operations idetape_fops = {
1885 .owner = THIS_MODULE,
1886 .read = idetape_chrdev_read,
1887 .write = idetape_chrdev_write,
1888 .ioctl = idetape_chrdev_ioctl,
1889 .open = idetape_chrdev_open,
1890 .release = idetape_chrdev_release,
1893 static int idetape_open(struct block_device *bdev, fmode_t mode)
1895 struct ide_tape_obj *tape = ide_tape_get(bdev->bd_disk, false, 0);
1903 static int idetape_release(struct gendisk *disk, fmode_t mode)
1905 struct ide_tape_obj *tape = ide_drv_g(disk, ide_tape_obj);
1911 static int idetape_ioctl(struct block_device *bdev, fmode_t mode,
1912 unsigned int cmd, unsigned long arg)
1914 struct ide_tape_obj *tape = ide_drv_g(bdev->bd_disk, ide_tape_obj);
1915 ide_drive_t *drive = tape->drive;
1916 int err = generic_ide_ioctl(drive, bdev, cmd, arg);
1918 err = idetape_blkdev_ioctl(drive, cmd, arg);
1922 static struct block_device_operations idetape_block_ops = {
1923 .owner = THIS_MODULE,
1924 .open = idetape_open,
1925 .release = idetape_release,
1926 .locked_ioctl = idetape_ioctl,
1929 static int ide_tape_probe(ide_drive_t *drive)
1931 idetape_tape_t *tape;
1935 if (!strstr("ide-tape", drive->driver_req))
1938 if (drive->media != ide_tape)
1941 if ((drive->dev_flags & IDE_DFLAG_ID_READ) &&
1942 ide_check_atapi_device(drive, DRV_NAME) == 0) {
1943 printk(KERN_ERR "ide-tape: %s: not supported by this version of"
1944 " the driver\n", drive->name);
1947 tape = kzalloc(sizeof(idetape_tape_t), GFP_KERNEL);
1949 printk(KERN_ERR "ide-tape: %s: Can't allocate a tape struct\n",
1954 g = alloc_disk(1 << PARTN_BITS);
1958 ide_init_disk(g, drive);
1960 tape->dev.parent = &drive->gendev;
1961 tape->dev.release = ide_tape_release;
1962 dev_set_name(&tape->dev, dev_name(&drive->gendev));
1964 if (device_register(&tape->dev))
1967 tape->drive = drive;
1968 tape->driver = &idetape_driver;
1971 g->private_data = &tape->driver;
1973 drive->driver_data = tape;
1975 mutex_lock(&idetape_ref_mutex);
1976 for (minor = 0; idetape_devs[minor]; minor++)
1978 idetape_devs[minor] = tape;
1979 mutex_unlock(&idetape_ref_mutex);
1981 idetape_setup(drive, tape, minor);
1983 device_create(idetape_sysfs_class, &drive->gendev,
1984 MKDEV(IDETAPE_MAJOR, minor), NULL, "%s", tape->name);
1985 device_create(idetape_sysfs_class, &drive->gendev,
1986 MKDEV(IDETAPE_MAJOR, minor + 128), NULL,
1989 g->fops = &idetape_block_ops;
1990 ide_register_region(g);
2002 static void __exit idetape_exit(void)
2004 driver_unregister(&idetape_driver.gen_driver);
2005 class_destroy(idetape_sysfs_class);
2006 unregister_chrdev(IDETAPE_MAJOR, "ht");
2009 static int __init idetape_init(void)
2012 idetape_sysfs_class = class_create(THIS_MODULE, "ide_tape");
2013 if (IS_ERR(idetape_sysfs_class)) {
2014 idetape_sysfs_class = NULL;
2015 printk(KERN_ERR "Unable to create sysfs class for ide tapes\n");
2020 if (register_chrdev(IDETAPE_MAJOR, "ht", &idetape_fops)) {
2021 printk(KERN_ERR "ide-tape: Failed to register chrdev"
2024 goto out_free_class;
2027 error = driver_register(&idetape_driver.gen_driver);
2029 goto out_free_driver;
2034 driver_unregister(&idetape_driver.gen_driver);
2036 class_destroy(idetape_sysfs_class);
2041 MODULE_ALIAS("ide:*m-tape*");
2042 module_init(idetape_init);
2043 module_exit(idetape_exit);
2044 MODULE_ALIAS_CHARDEV_MAJOR(IDETAPE_MAJOR);
2045 MODULE_DESCRIPTION("ATAPI Streaming TAPE Driver");
2046 MODULE_LICENSE("GPL");