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;
295 struct request *rq = drive->hwif->rq;
297 tape->sense_key = sense[2] & 0xF;
298 tape->asc = sense[12];
299 tape->ascq = sense[13];
301 debug_log(DBG_ERR, "pc = %x, sense key = %x, asc = %x, ascq = %x\n",
302 pc->c[0], tape->sense_key, tape->asc, tape->ascq);
304 /* Correct pc->xferred by asking the tape. */
305 if (pc->flags & PC_FLAG_DMA_ERROR)
306 pc->xferred = blk_rq_bytes(rq) -
308 get_unaligned_be32(&sense[3]);
311 * If error was the result of a zero-length read or write command,
312 * with sense key=5, asc=0x22, ascq=0, let it slide. Some drives
313 * (i.e. Seagate STT3401A Travan) don't support 0-length read/writes.
315 if ((pc->c[0] == READ_6 || pc->c[0] == WRITE_6)
317 && pc->c[4] == 0 && pc->c[3] == 0 && pc->c[2] == 0) {
318 if (tape->sense_key == 5) {
319 /* don't report an error, everything's ok */
321 /* don't retry read/write */
322 pc->flags |= PC_FLAG_ABORT;
325 if (pc->c[0] == READ_6 && (sense[2] & 0x80)) {
326 pc->error = IDE_DRV_ERROR_FILEMARK;
327 pc->flags |= PC_FLAG_ABORT;
329 if (pc->c[0] == WRITE_6) {
330 if ((sense[2] & 0x40) || (tape->sense_key == 0xd
331 && tape->asc == 0x0 && tape->ascq == 0x2)) {
332 pc->error = IDE_DRV_ERROR_EOD;
333 pc->flags |= PC_FLAG_ABORT;
336 if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
337 if (tape->sense_key == 8) {
338 pc->error = IDE_DRV_ERROR_EOD;
339 pc->flags |= PC_FLAG_ABORT;
341 if (!(pc->flags & PC_FLAG_ABORT) &&
343 pc->retries = IDETAPE_MAX_PC_RETRIES + 1;
347 static void ide_tape_handle_dsc(ide_drive_t *);
349 static int ide_tape_callback(ide_drive_t *drive, int dsc)
351 idetape_tape_t *tape = drive->driver_data;
352 struct ide_atapi_pc *pc = drive->pc;
353 struct request *rq = drive->hwif->rq;
354 int uptodate = pc->error ? 0 : 1;
355 int err = uptodate ? 0 : IDE_DRV_ERROR_GENERAL;
357 debug_log(DBG_PROCS, "Enter %s\n", __func__);
360 ide_tape_handle_dsc(drive);
362 if (drive->failed_pc == pc)
363 drive->failed_pc = NULL;
365 if (pc->c[0] == REQUEST_SENSE) {
367 idetape_analyze_error(drive, pc->buf);
369 printk(KERN_ERR "ide-tape: Error in REQUEST SENSE "
370 "itself - Aborting request!\n");
371 } else if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
372 int blocks = pc->xferred / tape->blk_size;
374 tape->avg_size += blocks * tape->blk_size;
376 if (time_after_eq(jiffies, tape->avg_time + HZ)) {
377 tape->avg_speed = tape->avg_size * HZ /
378 (jiffies - tape->avg_time) / 1024;
380 tape->avg_time = jiffies;
383 tape->first_frame += blocks;
384 rq->resid_len = blk_rq_bytes(rq) - blocks * tape->blk_size;
390 } else if (pc->c[0] == READ_POSITION && uptodate) {
391 u8 *readpos = pc->buf;
393 debug_log(DBG_SENSE, "BOP - %s\n",
394 (readpos[0] & 0x80) ? "Yes" : "No");
395 debug_log(DBG_SENSE, "EOP - %s\n",
396 (readpos[0] & 0x40) ? "Yes" : "No");
398 if (readpos[0] & 0x4) {
399 printk(KERN_INFO "ide-tape: Block location is unknown"
401 clear_bit(IDE_AFLAG_ADDRESS_VALID, &drive->atapi_flags);
403 err = IDE_DRV_ERROR_GENERAL;
405 debug_log(DBG_SENSE, "Block Location - %u\n",
406 be32_to_cpup((__be32 *)&readpos[4]));
408 tape->partition = readpos[1];
409 tape->first_frame = be32_to_cpup((__be32 *)&readpos[4]);
410 set_bit(IDE_AFLAG_ADDRESS_VALID, &drive->atapi_flags);
420 * Postpone the current request so that ide.c will be able to service requests
421 * from another device on the same port while we are polling for DSC.
423 static void idetape_postpone_request(ide_drive_t *drive)
425 idetape_tape_t *tape = drive->driver_data;
427 debug_log(DBG_PROCS, "Enter %s\n", __func__);
429 tape->postponed_rq = drive->hwif->rq;
431 ide_stall_queue(drive, tape->dsc_poll_freq);
434 static void ide_tape_handle_dsc(ide_drive_t *drive)
436 idetape_tape_t *tape = drive->driver_data;
438 /* Media access command */
439 tape->dsc_polling_start = jiffies;
440 tape->dsc_poll_freq = IDETAPE_DSC_MA_FAST;
441 tape->dsc_timeout = jiffies + IDETAPE_DSC_MA_TIMEOUT;
442 /* Allow ide.c to handle other requests */
443 idetape_postpone_request(drive);
447 * Packet Command Interface
449 * The current Packet Command is available in drive->pc, and will not change
450 * until we finish handling it. Each packet command is associated with a
451 * callback function that will be called when the command is finished.
453 * The handling will be done in three stages:
455 * 1. ide_tape_issue_pc will send the packet command to the drive, and will set
456 * the interrupt handler to ide_pc_intr.
458 * 2. On each interrupt, ide_pc_intr will be called. This step will be
459 * repeated until the device signals us that no more interrupts will be issued.
461 * 3. ATAPI Tape media access commands have immediate status with a delayed
462 * process. In case of a successful initiation of a media access packet command,
463 * the DSC bit will be set when the actual execution of the command is finished.
464 * Since the tape drive will not issue an interrupt, we have to poll for this
465 * event. In this case, we define the request as "low priority request" by
466 * setting rq_status to IDETAPE_RQ_POSTPONED, set a timer to poll for DSC and
469 * ide.c will then give higher priority to requests which originate from the
470 * other device, until will change rq_status to RQ_ACTIVE.
472 * 4. When the packet command is finished, it will be checked for errors.
474 * 5. In case an error was found, we queue a request sense packet command in
475 * front of the request queue and retry the operation up to
476 * IDETAPE_MAX_PC_RETRIES times.
478 * 6. In case no error was found, or we decided to give up and not to retry
479 * again, the callback function will be called and then we will handle the next
483 static ide_startstop_t ide_tape_issue_pc(ide_drive_t *drive,
485 struct ide_atapi_pc *pc)
487 idetape_tape_t *tape = drive->driver_data;
488 struct request *rq = drive->hwif->rq;
490 if (drive->failed_pc == NULL && pc->c[0] != REQUEST_SENSE)
491 drive->failed_pc = pc;
493 /* Set the current packet command */
496 if (pc->retries > IDETAPE_MAX_PC_RETRIES ||
497 (pc->flags & PC_FLAG_ABORT)) {
500 * We will "abort" retrying a packet command in case legitimate
501 * error code was received (crossing a filemark, or end of the
502 * media, for example).
504 if (!(pc->flags & PC_FLAG_ABORT)) {
505 if (!(pc->c[0] == TEST_UNIT_READY &&
506 tape->sense_key == 2 && tape->asc == 4 &&
507 (tape->ascq == 1 || tape->ascq == 8))) {
508 printk(KERN_ERR "ide-tape: %s: I/O error, "
509 "pc = %2x, key = %2x, "
510 "asc = %2x, ascq = %2x\n",
511 tape->name, pc->c[0],
512 tape->sense_key, tape->asc,
516 pc->error = IDE_DRV_ERROR_GENERAL;
519 drive->failed_pc = NULL;
520 drive->pc_callback(drive, 0);
521 ide_complete_rq(drive, -EIO, blk_rq_bytes(rq));
524 debug_log(DBG_SENSE, "Retry #%d, cmd = %02X\n", pc->retries, pc->c[0]);
528 return ide_issue_pc(drive, cmd);
531 /* A mode sense command is used to "sense" tape parameters. */
532 static void idetape_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
535 pc->c[0] = MODE_SENSE;
536 if (page_code != IDETAPE_BLOCK_DESCRIPTOR)
537 /* DBD = 1 - Don't return block descriptors */
539 pc->c[2] = page_code;
541 * Changed pc->c[3] to 0 (255 will at best return unused info).
543 * For SCSI this byte is defined as subpage instead of high byte
544 * of length and some IDE drives seem to interpret it this way
545 * and return an error when 255 is used.
548 /* We will just discard data in that case */
550 if (page_code == IDETAPE_BLOCK_DESCRIPTOR)
552 else if (page_code == IDETAPE_CAPABILITIES_PAGE)
558 static ide_startstop_t idetape_media_access_finished(ide_drive_t *drive)
560 ide_hwif_t *hwif = drive->hwif;
561 idetape_tape_t *tape = drive->driver_data;
562 struct ide_atapi_pc *pc = drive->pc;
565 stat = hwif->tp_ops->read_status(hwif);
567 if (stat & ATA_DSC) {
568 if (stat & ATA_ERR) {
570 if (pc->c[0] != TEST_UNIT_READY)
571 printk(KERN_ERR "ide-tape: %s: I/O error, ",
573 /* Retry operation */
579 pc->error = IDE_DRV_ERROR_GENERAL;
580 drive->failed_pc = NULL;
582 drive->pc_callback(drive, 0);
586 static void ide_tape_create_rw_cmd(idetape_tape_t *tape,
587 struct ide_atapi_pc *pc, struct request *rq,
590 unsigned int length = blk_rq_sectors(rq) / (tape->blk_size >> 9);
593 put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
596 pc->buf_size = blk_rq_bytes(rq);
597 if (pc->buf_size == tape->buffer_size)
598 pc->flags |= PC_FLAG_DMA_OK;
600 if (opcode == READ_6)
602 else if (opcode == WRITE_6) {
604 pc->flags |= PC_FLAG_WRITING;
607 memcpy(rq->cmd, pc->c, 12);
610 static ide_startstop_t idetape_do_request(ide_drive_t *drive,
611 struct request *rq, sector_t block)
613 ide_hwif_t *hwif = drive->hwif;
614 idetape_tape_t *tape = drive->driver_data;
615 struct ide_atapi_pc *pc = NULL;
616 struct request *postponed_rq = tape->postponed_rq;
620 debug_log(DBG_SENSE, "sector: %llu, nr_sectors: %u\n"
621 (unsigned long long)blk_rq_pos(rq), blk_rq_sectors(rq));
623 if (!(blk_special_request(rq) || blk_sense_request(rq))) {
624 /* We do not support buffer cache originated requests. */
625 printk(KERN_NOTICE "ide-tape: %s: Unsupported request in "
626 "request queue (%d)\n", drive->name, rq->cmd_type);
627 if (blk_fs_request(rq) == 0 && rq->errors == 0)
629 ide_complete_rq(drive, -EIO, ide_rq_bytes(rq));
633 /* Retry a failed packet command */
634 if (drive->failed_pc && drive->pc->c[0] == REQUEST_SENSE) {
635 pc = drive->failed_pc;
639 if (postponed_rq != NULL)
640 if (rq != postponed_rq) {
641 printk(KERN_ERR "ide-tape: ide-tape.c bug - "
642 "Two DSC requests were queued\n");
643 drive->failed_pc = NULL;
645 ide_complete_rq(drive, 0, blk_rq_bytes(rq));
649 tape->postponed_rq = NULL;
652 * If the tape is still busy, postpone our request and service
653 * the other device meanwhile.
655 stat = hwif->tp_ops->read_status(hwif);
657 if ((drive->dev_flags & IDE_DFLAG_DSC_OVERLAP) == 0 &&
658 (rq->cmd[13] & REQ_IDETAPE_PC2) == 0)
659 set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
661 if (drive->dev_flags & IDE_DFLAG_POST_RESET) {
662 set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
663 drive->dev_flags &= ~IDE_DFLAG_POST_RESET;
666 if (!test_and_clear_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags) &&
667 (stat & ATA_DSC) == 0) {
668 if (postponed_rq == NULL) {
669 tape->dsc_polling_start = jiffies;
670 tape->dsc_poll_freq = tape->best_dsc_rw_freq;
671 tape->dsc_timeout = jiffies + IDETAPE_DSC_RW_TIMEOUT;
672 } else if (time_after(jiffies, tape->dsc_timeout)) {
673 printk(KERN_ERR "ide-tape: %s: DSC timeout\n",
675 if (rq->cmd[13] & REQ_IDETAPE_PC2) {
676 idetape_media_access_finished(drive);
679 return ide_do_reset(drive);
681 } else if (time_after(jiffies,
682 tape->dsc_polling_start +
683 IDETAPE_DSC_MA_THRESHOLD))
684 tape->dsc_poll_freq = IDETAPE_DSC_MA_SLOW;
685 idetape_postpone_request(drive);
688 if (rq->cmd[13] & REQ_IDETAPE_READ) {
689 pc = &tape->queued_pc;
690 ide_tape_create_rw_cmd(tape, pc, rq, READ_6);
693 if (rq->cmd[13] & REQ_IDETAPE_WRITE) {
694 pc = &tape->queued_pc;
695 ide_tape_create_rw_cmd(tape, pc, rq, WRITE_6);
698 if (rq->cmd[13] & REQ_IDETAPE_PC1) {
699 pc = (struct ide_atapi_pc *)rq->special;
700 rq->cmd[13] &= ~(REQ_IDETAPE_PC1);
701 rq->cmd[13] |= REQ_IDETAPE_PC2;
704 if (rq->cmd[13] & REQ_IDETAPE_PC2) {
705 idetape_media_access_finished(drive);
711 /* prepare sense request for this command */
712 ide_prep_sense(drive, rq);
714 memset(&cmd, 0, sizeof(cmd));
717 cmd.tf_flags |= IDE_TFLAG_WRITE;
721 ide_init_sg_cmd(&cmd, blk_rq_bytes(rq));
722 ide_map_sg(drive, &cmd);
724 return ide_tape_issue_pc(drive, &cmd, pc);
728 * Write a filemark if write_filemark=1. Flush the device buffers without
729 * writing a filemark otherwise.
731 static void idetape_create_write_filemark_cmd(ide_drive_t *drive,
732 struct ide_atapi_pc *pc, int write_filemark)
735 pc->c[0] = WRITE_FILEMARKS;
736 pc->c[4] = write_filemark;
737 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
740 static int idetape_wait_ready(ide_drive_t *drive, unsigned long timeout)
742 idetape_tape_t *tape = drive->driver_data;
743 struct gendisk *disk = tape->disk;
744 int load_attempted = 0;
746 /* Wait for the tape to become ready */
747 set_bit(IDE_AFLAG_MEDIUM_PRESENT, &drive->atapi_flags);
749 while (time_before(jiffies, timeout)) {
750 if (ide_do_test_unit_ready(drive, disk) == 0)
752 if ((tape->sense_key == 2 && tape->asc == 4 && tape->ascq == 2)
753 || (tape->asc == 0x3A)) {
757 ide_do_start_stop(drive, disk, IDETAPE_LU_LOAD_MASK);
759 /* not about to be ready */
760 } else if (!(tape->sense_key == 2 && tape->asc == 4 &&
761 (tape->ascq == 1 || tape->ascq == 8)))
768 static int idetape_flush_tape_buffers(ide_drive_t *drive)
770 struct ide_tape_obj *tape = drive->driver_data;
771 struct ide_atapi_pc pc;
774 idetape_create_write_filemark_cmd(drive, &pc, 0);
775 rc = ide_queue_pc_tail(drive, tape->disk, &pc);
778 idetape_wait_ready(drive, 60 * 5 * HZ);
782 static void idetape_create_read_position_cmd(struct ide_atapi_pc *pc)
785 pc->c[0] = READ_POSITION;
789 static int idetape_read_position(ide_drive_t *drive)
791 idetape_tape_t *tape = drive->driver_data;
792 struct ide_atapi_pc pc;
795 debug_log(DBG_PROCS, "Enter %s\n", __func__);
797 idetape_create_read_position_cmd(&pc);
798 if (ide_queue_pc_tail(drive, tape->disk, &pc))
800 position = tape->first_frame;
804 static void idetape_create_locate_cmd(ide_drive_t *drive,
805 struct ide_atapi_pc *pc,
806 unsigned int block, u8 partition, int skip)
809 pc->c[0] = POSITION_TO_ELEMENT;
811 put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[3]);
812 pc->c[8] = partition;
813 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
816 static void __ide_tape_discard_merge_buffer(ide_drive_t *drive)
818 idetape_tape_t *tape = drive->driver_data;
820 if (tape->chrdev_dir != IDETAPE_DIR_READ)
823 clear_bit(IDE_AFLAG_FILEMARK, &drive->atapi_flags);
825 if (tape->buf != NULL) {
830 tape->chrdev_dir = IDETAPE_DIR_NONE;
834 * Position the tape to the requested block using the LOCATE packet command.
835 * A READ POSITION command is then issued to check where we are positioned. Like
836 * all higher level operations, we queue the commands at the tail of the request
837 * queue and wait for their completion.
839 static int idetape_position_tape(ide_drive_t *drive, unsigned int block,
840 u8 partition, int skip)
842 idetape_tape_t *tape = drive->driver_data;
843 struct gendisk *disk = tape->disk;
845 struct ide_atapi_pc pc;
847 if (tape->chrdev_dir == IDETAPE_DIR_READ)
848 __ide_tape_discard_merge_buffer(drive);
849 idetape_wait_ready(drive, 60 * 5 * HZ);
850 idetape_create_locate_cmd(drive, &pc, block, partition, skip);
851 retval = ide_queue_pc_tail(drive, disk, &pc);
855 idetape_create_read_position_cmd(&pc);
856 return ide_queue_pc_tail(drive, disk, &pc);
859 static void ide_tape_discard_merge_buffer(ide_drive_t *drive,
860 int restore_position)
862 idetape_tape_t *tape = drive->driver_data;
865 __ide_tape_discard_merge_buffer(drive);
866 if (restore_position) {
867 position = idetape_read_position(drive);
868 seek = position > 0 ? position : 0;
869 if (idetape_position_tape(drive, seek, 0, 0)) {
870 printk(KERN_INFO "ide-tape: %s: position_tape failed in"
871 " %s\n", tape->name, __func__);
878 * Generate a read/write request for the block device interface and wait for it
881 static int idetape_queue_rw_tail(ide_drive_t *drive, int cmd, int size)
883 idetape_tape_t *tape = drive->driver_data;
887 debug_log(DBG_SENSE, "%s: cmd=%d\n", __func__, cmd);
888 BUG_ON(cmd != REQ_IDETAPE_READ && cmd != REQ_IDETAPE_WRITE);
889 BUG_ON(size < 0 || size % tape->blk_size);
891 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
892 rq->cmd_type = REQ_TYPE_SPECIAL;
894 rq->rq_disk = tape->disk;
897 ret = blk_rq_map_kern(drive->queue, rq, tape->buf, size,
903 blk_execute_rq(drive->queue, tape->disk, rq, 0);
905 /* calculate the number of transferred bytes and update buffer state */
906 size -= rq->resid_len;
907 tape->cur = tape->buf;
908 if (cmd == REQ_IDETAPE_READ)
914 if (rq->errors == IDE_DRV_ERROR_GENERAL)
921 static void idetape_create_inquiry_cmd(struct ide_atapi_pc *pc)
929 static void idetape_create_rewind_cmd(ide_drive_t *drive,
930 struct ide_atapi_pc *pc)
933 pc->c[0] = REZERO_UNIT;
934 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
937 static void idetape_create_erase_cmd(struct ide_atapi_pc *pc)
942 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
945 static void idetape_create_space_cmd(struct ide_atapi_pc *pc, int count, u8 cmd)
949 put_unaligned(cpu_to_be32(count), (unsigned int *) &pc->c[1]);
951 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
954 static void ide_tape_flush_merge_buffer(ide_drive_t *drive)
956 idetape_tape_t *tape = drive->driver_data;
958 if (tape->chrdev_dir != IDETAPE_DIR_WRITE) {
959 printk(KERN_ERR "ide-tape: bug: Trying to empty merge buffer"
960 " but we are not writing.\n");
964 size_t aligned = roundup(tape->valid, tape->blk_size);
966 memset(tape->cur, 0, aligned - tape->valid);
967 idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE, aligned);
971 tape->chrdev_dir = IDETAPE_DIR_NONE;
974 static int idetape_init_rw(ide_drive_t *drive, int dir)
976 idetape_tape_t *tape = drive->driver_data;
979 BUG_ON(dir != IDETAPE_DIR_READ && dir != IDETAPE_DIR_WRITE);
981 if (tape->chrdev_dir == dir)
984 if (tape->chrdev_dir == IDETAPE_DIR_READ)
985 ide_tape_discard_merge_buffer(drive, 1);
986 else if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
987 ide_tape_flush_merge_buffer(drive);
988 idetape_flush_tape_buffers(drive);
991 if (tape->buf || tape->valid) {
992 printk(KERN_ERR "ide-tape: valid should be 0 now\n");
996 tape->buf = kmalloc(tape->buffer_size, GFP_KERNEL);
999 tape->chrdev_dir = dir;
1000 tape->cur = tape->buf;
1003 * Issue a 0 rw command to ensure that DSC handshake is
1004 * switched from completion mode to buffer available mode. No
1005 * point in issuing this if DSC overlap isn't supported, some
1006 * drives (Seagate STT3401A) will return an error.
1008 if (drive->dev_flags & IDE_DFLAG_DSC_OVERLAP) {
1009 int cmd = dir == IDETAPE_DIR_READ ? REQ_IDETAPE_READ
1010 : REQ_IDETAPE_WRITE;
1012 rc = idetape_queue_rw_tail(drive, cmd, 0);
1016 tape->chrdev_dir = IDETAPE_DIR_NONE;
1024 static void idetape_pad_zeros(ide_drive_t *drive, int bcount)
1026 idetape_tape_t *tape = drive->driver_data;
1028 memset(tape->buf, 0, tape->buffer_size);
1031 unsigned int count = min(tape->buffer_size, bcount);
1033 idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE, count);
1039 * Rewinds the tape to the Beginning Of the current Partition (BOP). We
1040 * currently support only one partition.
1042 static int idetape_rewind_tape(ide_drive_t *drive)
1044 struct ide_tape_obj *tape = drive->driver_data;
1045 struct gendisk *disk = tape->disk;
1047 struct ide_atapi_pc pc;
1049 debug_log(DBG_SENSE, "Enter %s\n", __func__);
1051 idetape_create_rewind_cmd(drive, &pc);
1052 retval = ide_queue_pc_tail(drive, disk, &pc);
1056 idetape_create_read_position_cmd(&pc);
1057 retval = ide_queue_pc_tail(drive, disk, &pc);
1063 /* mtio.h compatible commands should be issued to the chrdev interface. */
1064 static int idetape_blkdev_ioctl(ide_drive_t *drive, unsigned int cmd,
1067 idetape_tape_t *tape = drive->driver_data;
1068 void __user *argp = (void __user *)arg;
1070 struct idetape_config {
1071 int dsc_rw_frequency;
1072 int dsc_media_access_frequency;
1076 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1080 if (copy_from_user(&config, argp, sizeof(config)))
1082 tape->best_dsc_rw_freq = config.dsc_rw_frequency;
1085 config.dsc_rw_frequency = (int) tape->best_dsc_rw_freq;
1086 config.nr_stages = 1;
1087 if (copy_to_user(argp, &config, sizeof(config)))
1096 static int idetape_space_over_filemarks(ide_drive_t *drive, short mt_op,
1099 idetape_tape_t *tape = drive->driver_data;
1100 struct gendisk *disk = tape->disk;
1101 struct ide_atapi_pc pc;
1102 int retval, count = 0;
1103 int sprev = !!(tape->caps[4] & 0x20);
1107 if (MTBSF == mt_op || MTBSFM == mt_op) {
1110 mt_count = -mt_count;
1113 if (tape->chrdev_dir == IDETAPE_DIR_READ) {
1115 if (test_and_clear_bit(IDE_AFLAG_FILEMARK, &drive->atapi_flags))
1117 ide_tape_discard_merge_buffer(drive, 0);
1123 idetape_create_space_cmd(&pc, mt_count - count,
1124 IDETAPE_SPACE_OVER_FILEMARK);
1125 return ide_queue_pc_tail(drive, disk, &pc);
1130 retval = idetape_space_over_filemarks(drive, MTFSF,
1134 count = (MTBSFM == mt_op ? 1 : -1);
1135 return idetape_space_over_filemarks(drive, MTFSF, count);
1137 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
1144 * Our character device read / write functions.
1146 * The tape is optimized to maximize throughput when it is transferring an
1147 * integral number of the "continuous transfer limit", which is a parameter of
1148 * the specific tape (26kB on my particular tape, 32kB for Onstream).
1150 * As of version 1.3 of the driver, the character device provides an abstract
1151 * continuous view of the media - any mix of block sizes (even 1 byte) on the
1152 * same backup/restore procedure is supported. The driver will internally
1153 * convert the requests to the recommended transfer unit, so that an unmatch
1154 * between the user's block size to the recommended size will only result in a
1155 * (slightly) increased driver overhead, but will no longer hit performance.
1156 * This is not applicable to Onstream.
1158 static ssize_t idetape_chrdev_read(struct file *file, char __user *buf,
1159 size_t count, loff_t *ppos)
1161 struct ide_tape_obj *tape = file->private_data;
1162 ide_drive_t *drive = tape->drive;
1167 debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
1169 if (tape->chrdev_dir != IDETAPE_DIR_READ) {
1170 if (test_bit(IDE_AFLAG_DETECT_BS, &drive->atapi_flags))
1171 if (count > tape->blk_size &&
1172 (count % tape->blk_size) == 0)
1173 tape->user_bs_factor = count / tape->blk_size;
1176 rc = idetape_init_rw(drive, IDETAPE_DIR_READ);
1180 while (done < count) {
1183 /* refill if staging buffer is empty */
1185 /* If we are at a filemark, nothing more to read */
1186 if (test_bit(IDE_AFLAG_FILEMARK, &drive->atapi_flags))
1189 if (idetape_queue_rw_tail(drive, REQ_IDETAPE_READ,
1190 tape->buffer_size) <= 0)
1195 todo = min_t(size_t, count - done, tape->valid);
1196 if (copy_to_user(buf + done, tape->cur, todo))
1200 tape->valid -= todo;
1204 if (!done && test_bit(IDE_AFLAG_FILEMARK, &drive->atapi_flags)) {
1205 debug_log(DBG_SENSE, "%s: spacing over filemark\n", tape->name);
1207 idetape_space_over_filemarks(drive, MTFSF, 1);
1211 return ret ? ret : done;
1214 static ssize_t idetape_chrdev_write(struct file *file, const char __user *buf,
1215 size_t count, loff_t *ppos)
1217 struct ide_tape_obj *tape = file->private_data;
1218 ide_drive_t *drive = tape->drive;
1223 /* The drive is write protected. */
1224 if (tape->write_prot)
1227 debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
1229 /* Initialize write operation */
1230 rc = idetape_init_rw(drive, IDETAPE_DIR_WRITE);
1234 while (done < count) {
1237 /* flush if staging buffer is full */
1238 if (tape->valid == tape->buffer_size &&
1239 idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE,
1240 tape->buffer_size) <= 0)
1244 todo = min_t(size_t, count - done,
1245 tape->buffer_size - tape->valid);
1246 if (copy_from_user(tape->cur, buf + done, todo))
1250 tape->valid += todo;
1254 return ret ? ret : done;
1257 static int idetape_write_filemark(ide_drive_t *drive)
1259 struct ide_tape_obj *tape = drive->driver_data;
1260 struct ide_atapi_pc pc;
1262 /* Write a filemark */
1263 idetape_create_write_filemark_cmd(drive, &pc, 1);
1264 if (ide_queue_pc_tail(drive, tape->disk, &pc)) {
1265 printk(KERN_ERR "ide-tape: Couldn't write a filemark\n");
1272 * Called from idetape_chrdev_ioctl when the general mtio MTIOCTOP ioctl is
1275 * Note: MTBSF and MTBSFM are not supported when the tape doesn't support
1276 * spacing over filemarks in the reverse direction. In this case, MTFSFM is also
1277 * usually not supported.
1279 * The following commands are currently not supported:
1281 * MTFSS, MTBSS, MTWSM, MTSETDENSITY, MTSETDRVBUFFER, MT_ST_BOOLEANS,
1282 * MT_ST_WRITE_THRESHOLD.
1284 static int idetape_mtioctop(ide_drive_t *drive, short mt_op, int mt_count)
1286 idetape_tape_t *tape = drive->driver_data;
1287 struct gendisk *disk = tape->disk;
1288 struct ide_atapi_pc pc;
1291 debug_log(DBG_ERR, "Handling MTIOCTOP ioctl: mt_op=%d, mt_count=%d\n",
1301 return idetape_space_over_filemarks(drive, mt_op, mt_count);
1308 if (tape->write_prot)
1310 ide_tape_discard_merge_buffer(drive, 1);
1311 for (i = 0; i < mt_count; i++) {
1312 retval = idetape_write_filemark(drive);
1318 ide_tape_discard_merge_buffer(drive, 0);
1319 if (idetape_rewind_tape(drive))
1323 ide_tape_discard_merge_buffer(drive, 0);
1324 return ide_do_start_stop(drive, disk, IDETAPE_LU_LOAD_MASK);
1328 * If door is locked, attempt to unlock before
1329 * attempting to eject.
1331 if (tape->door_locked) {
1332 if (!ide_set_media_lock(drive, disk, 0))
1333 tape->door_locked = DOOR_UNLOCKED;
1335 ide_tape_discard_merge_buffer(drive, 0);
1336 retval = ide_do_start_stop(drive, disk, !IDETAPE_LU_LOAD_MASK);
1338 clear_bit(IDE_AFLAG_MEDIUM_PRESENT, &drive->atapi_flags);
1341 ide_tape_discard_merge_buffer(drive, 0);
1342 return idetape_flush_tape_buffers(drive);
1344 ide_tape_discard_merge_buffer(drive, 0);
1345 return ide_do_start_stop(drive, disk,
1346 IDETAPE_LU_RETENSION_MASK | IDETAPE_LU_LOAD_MASK);
1348 idetape_create_space_cmd(&pc, 0, IDETAPE_SPACE_TO_EOD);
1349 return ide_queue_pc_tail(drive, disk, &pc);
1351 (void)idetape_rewind_tape(drive);
1352 idetape_create_erase_cmd(&pc);
1353 return ide_queue_pc_tail(drive, disk, &pc);
1356 if (mt_count < tape->blk_size ||
1357 mt_count % tape->blk_size)
1359 tape->user_bs_factor = mt_count / tape->blk_size;
1360 clear_bit(IDE_AFLAG_DETECT_BS, &drive->atapi_flags);
1362 set_bit(IDE_AFLAG_DETECT_BS, &drive->atapi_flags);
1365 ide_tape_discard_merge_buffer(drive, 0);
1366 return idetape_position_tape(drive,
1367 mt_count * tape->user_bs_factor, tape->partition, 0);
1369 ide_tape_discard_merge_buffer(drive, 0);
1370 return idetape_position_tape(drive, 0, mt_count, 0);
1374 retval = ide_set_media_lock(drive, disk, 1);
1377 tape->door_locked = DOOR_EXPLICITLY_LOCKED;
1380 retval = ide_set_media_lock(drive, disk, 0);
1383 tape->door_locked = DOOR_UNLOCKED;
1386 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
1393 * Our character device ioctls. General mtio.h magnetic io commands are
1394 * supported here, and not in the corresponding block interface. Our own
1395 * ide-tape ioctls are supported on both interfaces.
1397 static int idetape_chrdev_ioctl(struct inode *inode, struct file *file,
1398 unsigned int cmd, unsigned long arg)
1400 struct ide_tape_obj *tape = file->private_data;
1401 ide_drive_t *drive = tape->drive;
1405 int block_offset = 0, position = tape->first_frame;
1406 void __user *argp = (void __user *)arg;
1408 debug_log(DBG_CHRDEV, "Enter %s, cmd=%u\n", __func__, cmd);
1410 if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
1411 ide_tape_flush_merge_buffer(drive);
1412 idetape_flush_tape_buffers(drive);
1414 if (cmd == MTIOCGET || cmd == MTIOCPOS) {
1415 block_offset = tape->valid /
1416 (tape->blk_size * tape->user_bs_factor);
1417 position = idetape_read_position(drive);
1423 if (copy_from_user(&mtop, argp, sizeof(struct mtop)))
1425 return idetape_mtioctop(drive, mtop.mt_op, mtop.mt_count);
1427 memset(&mtget, 0, sizeof(struct mtget));
1428 mtget.mt_type = MT_ISSCSI2;
1429 mtget.mt_blkno = position / tape->user_bs_factor - block_offset;
1431 ((tape->blk_size * tape->user_bs_factor)
1432 << MT_ST_BLKSIZE_SHIFT) & MT_ST_BLKSIZE_MASK;
1434 if (tape->drv_write_prot)
1435 mtget.mt_gstat |= GMT_WR_PROT(0xffffffff);
1437 if (copy_to_user(argp, &mtget, sizeof(struct mtget)))
1441 mtpos.mt_blkno = position / tape->user_bs_factor - block_offset;
1442 if (copy_to_user(argp, &mtpos, sizeof(struct mtpos)))
1446 if (tape->chrdev_dir == IDETAPE_DIR_READ)
1447 ide_tape_discard_merge_buffer(drive, 1);
1448 return idetape_blkdev_ioctl(drive, cmd, arg);
1453 * Do a mode sense page 0 with block descriptor and if it succeeds set the tape
1454 * block size with the reported value.
1456 static void ide_tape_get_bsize_from_bdesc(ide_drive_t *drive)
1458 idetape_tape_t *tape = drive->driver_data;
1459 struct ide_atapi_pc pc;
1461 idetape_create_mode_sense_cmd(&pc, IDETAPE_BLOCK_DESCRIPTOR);
1462 if (ide_queue_pc_tail(drive, tape->disk, &pc)) {
1463 printk(KERN_ERR "ide-tape: Can't get block descriptor\n");
1464 if (tape->blk_size == 0) {
1465 printk(KERN_WARNING "ide-tape: Cannot deal with zero "
1466 "block size, assuming 32k\n");
1467 tape->blk_size = 32768;
1471 tape->blk_size = (pc.buf[4 + 5] << 16) +
1472 (pc.buf[4 + 6] << 8) +
1474 tape->drv_write_prot = (pc.buf[2] & 0x80) >> 7;
1477 static int idetape_chrdev_open(struct inode *inode, struct file *filp)
1479 unsigned int minor = iminor(inode), i = minor & ~0xc0;
1481 idetape_tape_t *tape;
1484 if (i >= MAX_HWIFS * MAX_DRIVES)
1488 tape = ide_tape_chrdev_get(i);
1494 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
1497 * We really want to do nonseekable_open(inode, filp); here, but some
1498 * versions of tar incorrectly call lseek on tapes and bail out if that
1499 * fails. So we disallow pread() and pwrite(), but permit lseeks.
1501 filp->f_mode &= ~(FMODE_PREAD | FMODE_PWRITE);
1503 drive = tape->drive;
1505 filp->private_data = tape;
1507 if (test_and_set_bit(IDE_AFLAG_BUSY, &drive->atapi_flags)) {
1512 retval = idetape_wait_ready(drive, 60 * HZ);
1514 clear_bit(IDE_AFLAG_BUSY, &drive->atapi_flags);
1515 printk(KERN_ERR "ide-tape: %s: drive not ready\n", tape->name);
1519 idetape_read_position(drive);
1520 if (!test_bit(IDE_AFLAG_ADDRESS_VALID, &drive->atapi_flags))
1521 (void)idetape_rewind_tape(drive);
1523 /* Read block size and write protect status from drive. */
1524 ide_tape_get_bsize_from_bdesc(drive);
1526 /* Set write protect flag if device is opened as read-only. */
1527 if ((filp->f_flags & O_ACCMODE) == O_RDONLY)
1528 tape->write_prot = 1;
1530 tape->write_prot = tape->drv_write_prot;
1532 /* Make sure drive isn't write protected if user wants to write. */
1533 if (tape->write_prot) {
1534 if ((filp->f_flags & O_ACCMODE) == O_WRONLY ||
1535 (filp->f_flags & O_ACCMODE) == O_RDWR) {
1536 clear_bit(IDE_AFLAG_BUSY, &drive->atapi_flags);
1542 /* Lock the tape drive door so user can't eject. */
1543 if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
1544 if (!ide_set_media_lock(drive, tape->disk, 1)) {
1545 if (tape->door_locked != DOOR_EXPLICITLY_LOCKED)
1546 tape->door_locked = DOOR_LOCKED;
1558 static void idetape_write_release(ide_drive_t *drive, unsigned int minor)
1560 idetape_tape_t *tape = drive->driver_data;
1562 ide_tape_flush_merge_buffer(drive);
1563 tape->buf = kmalloc(tape->buffer_size, GFP_KERNEL);
1564 if (tape->buf != NULL) {
1565 idetape_pad_zeros(drive, tape->blk_size *
1566 (tape->user_bs_factor - 1));
1570 idetape_write_filemark(drive);
1571 idetape_flush_tape_buffers(drive);
1572 idetape_flush_tape_buffers(drive);
1575 static int idetape_chrdev_release(struct inode *inode, struct file *filp)
1577 struct ide_tape_obj *tape = filp->private_data;
1578 ide_drive_t *drive = tape->drive;
1579 unsigned int minor = iminor(inode);
1582 tape = drive->driver_data;
1584 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
1586 if (tape->chrdev_dir == IDETAPE_DIR_WRITE)
1587 idetape_write_release(drive, minor);
1588 if (tape->chrdev_dir == IDETAPE_DIR_READ) {
1590 ide_tape_discard_merge_buffer(drive, 1);
1593 if (minor < 128 && test_bit(IDE_AFLAG_MEDIUM_PRESENT, &drive->atapi_flags))
1594 (void) idetape_rewind_tape(drive);
1595 if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
1596 if (tape->door_locked == DOOR_LOCKED) {
1597 if (!ide_set_media_lock(drive, tape->disk, 0))
1598 tape->door_locked = DOOR_UNLOCKED;
1601 clear_bit(IDE_AFLAG_BUSY, &drive->atapi_flags);
1607 static void idetape_get_inquiry_results(ide_drive_t *drive)
1609 idetape_tape_t *tape = drive->driver_data;
1610 struct ide_atapi_pc pc;
1612 char fw_rev[4], vendor_id[8], product_id[16];
1614 idetape_create_inquiry_cmd(&pc);
1615 pc.buf = &pc_buf[0];
1616 pc.buf_size = sizeof(pc_buf);
1618 if (ide_queue_pc_tail(drive, tape->disk, &pc)) {
1619 printk(KERN_ERR "ide-tape: %s: can't get INQUIRY results\n",
1623 memcpy(vendor_id, &pc.buf[8], 8);
1624 memcpy(product_id, &pc.buf[16], 16);
1625 memcpy(fw_rev, &pc.buf[32], 4);
1627 ide_fixstring(vendor_id, 8, 0);
1628 ide_fixstring(product_id, 16, 0);
1629 ide_fixstring(fw_rev, 4, 0);
1631 printk(KERN_INFO "ide-tape: %s <-> %s: %.8s %.16s rev %.4s\n",
1632 drive->name, tape->name, vendor_id, product_id, fw_rev);
1636 * Ask the tape about its various parameters. In particular, we will adjust our
1637 * data transfer buffer size to the recommended value as returned by the tape.
1639 static void idetape_get_mode_sense_results(ide_drive_t *drive)
1641 idetape_tape_t *tape = drive->driver_data;
1642 struct ide_atapi_pc pc;
1644 u8 speed, max_speed;
1646 idetape_create_mode_sense_cmd(&pc, IDETAPE_CAPABILITIES_PAGE);
1647 if (ide_queue_pc_tail(drive, tape->disk, &pc)) {
1648 printk(KERN_ERR "ide-tape: Can't get tape parameters - assuming"
1649 " some default values\n");
1650 tape->blk_size = 512;
1651 put_unaligned(52, (u16 *)&tape->caps[12]);
1652 put_unaligned(540, (u16 *)&tape->caps[14]);
1653 put_unaligned(6*52, (u16 *)&tape->caps[16]);
1656 caps = pc.buf + 4 + pc.buf[3];
1658 /* convert to host order and save for later use */
1659 speed = be16_to_cpup((__be16 *)&caps[14]);
1660 max_speed = be16_to_cpup((__be16 *)&caps[8]);
1662 *(u16 *)&caps[8] = max_speed;
1663 *(u16 *)&caps[12] = be16_to_cpup((__be16 *)&caps[12]);
1664 *(u16 *)&caps[14] = speed;
1665 *(u16 *)&caps[16] = be16_to_cpup((__be16 *)&caps[16]);
1668 printk(KERN_INFO "ide-tape: %s: invalid tape speed "
1669 "(assuming 650KB/sec)\n", drive->name);
1670 *(u16 *)&caps[14] = 650;
1673 printk(KERN_INFO "ide-tape: %s: invalid max_speed "
1674 "(assuming 650KB/sec)\n", drive->name);
1675 *(u16 *)&caps[8] = 650;
1678 memcpy(&tape->caps, caps, 20);
1680 /* device lacks locking support according to capabilities page */
1681 if ((caps[6] & 1) == 0)
1682 drive->dev_flags &= ~IDE_DFLAG_DOORLOCKING;
1685 tape->blk_size = 512;
1686 else if (caps[7] & 0x04)
1687 tape->blk_size = 1024;
1690 #ifdef CONFIG_IDE_PROC_FS
1691 #define ide_tape_devset_get(name, field) \
1692 static int get_##name(ide_drive_t *drive) \
1694 idetape_tape_t *tape = drive->driver_data; \
1695 return tape->field; \
1698 #define ide_tape_devset_set(name, field) \
1699 static int set_##name(ide_drive_t *drive, int arg) \
1701 idetape_tape_t *tape = drive->driver_data; \
1702 tape->field = arg; \
1706 #define ide_tape_devset_rw_field(_name, _field) \
1707 ide_tape_devset_get(_name, _field) \
1708 ide_tape_devset_set(_name, _field) \
1709 IDE_DEVSET(_name, DS_SYNC, get_##_name, set_##_name)
1711 #define ide_tape_devset_r_field(_name, _field) \
1712 ide_tape_devset_get(_name, _field) \
1713 IDE_DEVSET(_name, 0, get_##_name, NULL)
1715 static int mulf_tdsc(ide_drive_t *drive) { return 1000; }
1716 static int divf_tdsc(ide_drive_t *drive) { return HZ; }
1717 static int divf_buffer(ide_drive_t *drive) { return 2; }
1718 static int divf_buffer_size(ide_drive_t *drive) { return 1024; }
1720 ide_devset_rw_flag(dsc_overlap, IDE_DFLAG_DSC_OVERLAP);
1722 ide_tape_devset_rw_field(debug_mask, debug_mask);
1723 ide_tape_devset_rw_field(tdsc, best_dsc_rw_freq);
1725 ide_tape_devset_r_field(avg_speed, avg_speed);
1726 ide_tape_devset_r_field(speed, caps[14]);
1727 ide_tape_devset_r_field(buffer, caps[16]);
1728 ide_tape_devset_r_field(buffer_size, buffer_size);
1730 static const struct ide_proc_devset idetape_settings[] = {
1731 __IDE_PROC_DEVSET(avg_speed, 0, 0xffff, NULL, NULL),
1732 __IDE_PROC_DEVSET(buffer, 0, 0xffff, NULL, divf_buffer),
1733 __IDE_PROC_DEVSET(buffer_size, 0, 0xffff, NULL, divf_buffer_size),
1734 __IDE_PROC_DEVSET(debug_mask, 0, 0xffff, NULL, NULL),
1735 __IDE_PROC_DEVSET(dsc_overlap, 0, 1, NULL, NULL),
1736 __IDE_PROC_DEVSET(speed, 0, 0xffff, NULL, NULL),
1737 __IDE_PROC_DEVSET(tdsc, IDETAPE_DSC_RW_MIN, IDETAPE_DSC_RW_MAX,
1738 mulf_tdsc, divf_tdsc),
1744 * The function below is called to:
1746 * 1. Initialize our various state variables.
1747 * 2. Ask the tape for its capabilities.
1748 * 3. Allocate a buffer which will be used for data transfer. The buffer size
1749 * is chosen based on the recommendation which we received in step 2.
1751 * Note that at this point ide.c already assigned us an irq, so that we can
1752 * queue requests here and wait for their completion.
1754 static void idetape_setup(ide_drive_t *drive, idetape_tape_t *tape, int minor)
1759 u16 *ctl = (u16 *)&tape->caps[12];
1761 drive->pc_callback = ide_tape_callback;
1763 drive->dev_flags |= IDE_DFLAG_DSC_OVERLAP;
1765 if (drive->hwif->host_flags & IDE_HFLAG_NO_DSC) {
1766 printk(KERN_INFO "ide-tape: %s: disabling DSC overlap\n",
1768 drive->dev_flags &= ~IDE_DFLAG_DSC_OVERLAP;
1771 /* Seagate Travan drives do not support DSC overlap. */
1772 if (strstr((char *)&drive->id[ATA_ID_PROD], "Seagate STT3401"))
1773 drive->dev_flags &= ~IDE_DFLAG_DSC_OVERLAP;
1775 tape->minor = minor;
1776 tape->name[0] = 'h';
1777 tape->name[1] = 't';
1778 tape->name[2] = '0' + minor;
1779 tape->chrdev_dir = IDETAPE_DIR_NONE;
1781 idetape_get_inquiry_results(drive);
1782 idetape_get_mode_sense_results(drive);
1783 ide_tape_get_bsize_from_bdesc(drive);
1784 tape->user_bs_factor = 1;
1785 tape->buffer_size = *ctl * tape->blk_size;
1786 while (tape->buffer_size > 0xffff) {
1787 printk(KERN_NOTICE "ide-tape: decreasing stage size\n");
1789 tape->buffer_size = *ctl * tape->blk_size;
1791 buffer_size = tape->buffer_size;
1793 /* select the "best" DSC read/write polling freq */
1794 speed = max(*(u16 *)&tape->caps[14], *(u16 *)&tape->caps[8]);
1796 t = (IDETAPE_FIFO_THRESHOLD * tape->buffer_size * HZ) / (speed * 1000);
1799 * Ensure that the number we got makes sense; limit it within
1800 * IDETAPE_DSC_RW_MIN and IDETAPE_DSC_RW_MAX.
1802 tape->best_dsc_rw_freq = clamp_t(unsigned long, t, IDETAPE_DSC_RW_MIN,
1803 IDETAPE_DSC_RW_MAX);
1804 printk(KERN_INFO "ide-tape: %s <-> %s: %dKBps, %d*%dkB buffer, "
1806 drive->name, tape->name, *(u16 *)&tape->caps[14],
1807 (*(u16 *)&tape->caps[16] * 512) / tape->buffer_size,
1808 tape->buffer_size / 1024,
1809 tape->best_dsc_rw_freq * 1000 / HZ,
1810 (drive->dev_flags & IDE_DFLAG_USING_DMA) ? ", DMA" : "");
1812 ide_proc_register_driver(drive, tape->driver);
1815 static void ide_tape_remove(ide_drive_t *drive)
1817 idetape_tape_t *tape = drive->driver_data;
1819 ide_proc_unregister_driver(drive, tape->driver);
1820 device_del(&tape->dev);
1821 ide_unregister_region(tape->disk);
1823 mutex_lock(&idetape_ref_mutex);
1824 put_device(&tape->dev);
1825 mutex_unlock(&idetape_ref_mutex);
1828 static void ide_tape_release(struct device *dev)
1830 struct ide_tape_obj *tape = to_ide_drv(dev, ide_tape_obj);
1831 ide_drive_t *drive = tape->drive;
1832 struct gendisk *g = tape->disk;
1834 BUG_ON(tape->valid);
1836 drive->dev_flags &= ~IDE_DFLAG_DSC_OVERLAP;
1837 drive->driver_data = NULL;
1838 device_destroy(idetape_sysfs_class, MKDEV(IDETAPE_MAJOR, tape->minor));
1839 device_destroy(idetape_sysfs_class,
1840 MKDEV(IDETAPE_MAJOR, tape->minor + 128));
1841 idetape_devs[tape->minor] = NULL;
1842 g->private_data = NULL;
1847 #ifdef CONFIG_IDE_PROC_FS
1848 static int proc_idetape_read_name
1849 (char *page, char **start, off_t off, int count, int *eof, void *data)
1851 ide_drive_t *drive = (ide_drive_t *) data;
1852 idetape_tape_t *tape = drive->driver_data;
1856 len = sprintf(out, "%s\n", tape->name);
1857 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
1860 static ide_proc_entry_t idetape_proc[] = {
1861 { "capacity", S_IFREG|S_IRUGO, proc_ide_read_capacity, NULL },
1862 { "name", S_IFREG|S_IRUGO, proc_idetape_read_name, NULL },
1863 { NULL, 0, NULL, NULL }
1866 static ide_proc_entry_t *ide_tape_proc_entries(ide_drive_t *drive)
1868 return idetape_proc;
1871 static const struct ide_proc_devset *ide_tape_proc_devsets(ide_drive_t *drive)
1873 return idetape_settings;
1877 static int ide_tape_probe(ide_drive_t *);
1879 static struct ide_driver idetape_driver = {
1881 .owner = THIS_MODULE,
1883 .bus = &ide_bus_type,
1885 .probe = ide_tape_probe,
1886 .remove = ide_tape_remove,
1887 .version = IDETAPE_VERSION,
1888 .do_request = idetape_do_request,
1889 #ifdef CONFIG_IDE_PROC_FS
1890 .proc_entries = ide_tape_proc_entries,
1891 .proc_devsets = ide_tape_proc_devsets,
1895 /* Our character device supporting functions, passed to register_chrdev. */
1896 static const struct file_operations idetape_fops = {
1897 .owner = THIS_MODULE,
1898 .read = idetape_chrdev_read,
1899 .write = idetape_chrdev_write,
1900 .ioctl = idetape_chrdev_ioctl,
1901 .open = idetape_chrdev_open,
1902 .release = idetape_chrdev_release,
1905 static int idetape_open(struct block_device *bdev, fmode_t mode)
1907 struct ide_tape_obj *tape = ide_tape_get(bdev->bd_disk);
1915 static int idetape_release(struct gendisk *disk, fmode_t mode)
1917 struct ide_tape_obj *tape = ide_drv_g(disk, ide_tape_obj);
1923 static int idetape_ioctl(struct block_device *bdev, fmode_t mode,
1924 unsigned int cmd, unsigned long arg)
1926 struct ide_tape_obj *tape = ide_drv_g(bdev->bd_disk, ide_tape_obj);
1927 ide_drive_t *drive = tape->drive;
1928 int err = generic_ide_ioctl(drive, bdev, cmd, arg);
1930 err = idetape_blkdev_ioctl(drive, cmd, arg);
1934 static struct block_device_operations idetape_block_ops = {
1935 .owner = THIS_MODULE,
1936 .open = idetape_open,
1937 .release = idetape_release,
1938 .locked_ioctl = idetape_ioctl,
1941 static int ide_tape_probe(ide_drive_t *drive)
1943 idetape_tape_t *tape;
1947 if (!strstr("ide-tape", drive->driver_req))
1950 if (drive->media != ide_tape)
1953 if ((drive->dev_flags & IDE_DFLAG_ID_READ) &&
1954 ide_check_atapi_device(drive, DRV_NAME) == 0) {
1955 printk(KERN_ERR "ide-tape: %s: not supported by this version of"
1956 " the driver\n", drive->name);
1959 tape = kzalloc(sizeof(idetape_tape_t), GFP_KERNEL);
1961 printk(KERN_ERR "ide-tape: %s: Can't allocate a tape struct\n",
1966 g = alloc_disk(1 << PARTN_BITS);
1970 ide_init_disk(g, drive);
1972 tape->dev.parent = &drive->gendev;
1973 tape->dev.release = ide_tape_release;
1974 dev_set_name(&tape->dev, dev_name(&drive->gendev));
1976 if (device_register(&tape->dev))
1979 tape->drive = drive;
1980 tape->driver = &idetape_driver;
1983 g->private_data = &tape->driver;
1985 drive->driver_data = tape;
1987 mutex_lock(&idetape_ref_mutex);
1988 for (minor = 0; idetape_devs[minor]; minor++)
1990 idetape_devs[minor] = tape;
1991 mutex_unlock(&idetape_ref_mutex);
1993 idetape_setup(drive, tape, minor);
1995 device_create(idetape_sysfs_class, &drive->gendev,
1996 MKDEV(IDETAPE_MAJOR, minor), NULL, "%s", tape->name);
1997 device_create(idetape_sysfs_class, &drive->gendev,
1998 MKDEV(IDETAPE_MAJOR, minor + 128), NULL,
2001 g->fops = &idetape_block_ops;
2002 ide_register_region(g);
2014 static void __exit idetape_exit(void)
2016 driver_unregister(&idetape_driver.gen_driver);
2017 class_destroy(idetape_sysfs_class);
2018 unregister_chrdev(IDETAPE_MAJOR, "ht");
2021 static int __init idetape_init(void)
2024 idetape_sysfs_class = class_create(THIS_MODULE, "ide_tape");
2025 if (IS_ERR(idetape_sysfs_class)) {
2026 idetape_sysfs_class = NULL;
2027 printk(KERN_ERR "Unable to create sysfs class for ide tapes\n");
2032 if (register_chrdev(IDETAPE_MAJOR, "ht", &idetape_fops)) {
2033 printk(KERN_ERR "ide-tape: Failed to register chrdev"
2036 goto out_free_class;
2039 error = driver_register(&idetape_driver.gen_driver);
2041 goto out_free_driver;
2046 driver_unregister(&idetape_driver.gen_driver);
2048 class_destroy(idetape_sysfs_class);
2053 MODULE_ALIAS("ide:*m-tape*");
2054 module_init(idetape_init);
2055 module_exit(idetape_exit);
2056 MODULE_ALIAS_CHARDEV_MAJOR(IDETAPE_MAJOR);
2057 MODULE_DESCRIPTION("ATAPI Streaming TAPE Driver");
2058 MODULE_LICENSE("GPL");