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 IDETAPE_VERSION "1.20"
20 #include <linux/module.h>
21 #include <linux/types.h>
22 #include <linux/string.h>
23 #include <linux/kernel.h>
24 #include <linux/delay.h>
25 #include <linux/timer.h>
27 #include <linux/interrupt.h>
28 #include <linux/jiffies.h>
29 #include <linux/major.h>
30 #include <linux/errno.h>
31 #include <linux/genhd.h>
32 #include <linux/slab.h>
33 #include <linux/pci.h>
34 #include <linux/ide.h>
35 #include <linux/smp_lock.h>
36 #include <linux/completion.h>
37 #include <linux/bitops.h>
38 #include <linux/mutex.h>
39 #include <scsi/scsi.h>
41 #include <asm/byteorder.h>
42 #include <linux/irq.h>
43 #include <linux/uaccess.h>
45 #include <asm/unaligned.h>
46 #include <linux/mtio.h>
49 /* output errors only */
51 /* output all sense key/asc */
53 /* info regarding all chrdev-related procedures */
54 DBG_CHRDEV = (1 << 2),
55 /* all remaining procedures */
57 /* buffer alloc info (pc_stack & rq_stack) */
58 DBG_PCRQ_STACK = (1 << 4),
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 * With each packet command, we allocate a buffer of IDETAPE_PC_BUFFER_SIZE
85 * bytes. This is used for several packet commands (Not for READ/WRITE commands)
87 #define IDETAPE_PC_BUFFER_SIZE 256
90 * In various places in the driver, we need to allocate storage
91 * for packet commands and requests, which will remain valid while
92 * we leave the driver to wait for an interrupt or a timeout event.
94 #define IDETAPE_PC_STACK (10 + IDETAPE_MAX_PC_RETRIES)
97 * Some drives (for example, Seagate STT3401A Travan) require a very long
98 * timeout, because they don't return an interrupt or clear their busy bit
99 * until after the command completes (even retension commands).
101 #define IDETAPE_WAIT_CMD (900*HZ)
104 * The following parameter is used to select the point in the internal tape fifo
105 * in which we will start to refill the buffer. Decreasing the following
106 * parameter will improve the system's latency and interactive response, while
107 * using a high value might improve system throughput.
109 #define IDETAPE_FIFO_THRESHOLD 2
112 * DSC polling parameters.
114 * Polling for DSC (a single bit in the status register) is a very important
115 * function in ide-tape. There are two cases in which we poll for DSC:
117 * 1. Before a read/write packet command, to ensure that we can transfer data
118 * from/to the tape's data buffers, without causing an actual media access.
119 * In case the tape is not ready yet, we take out our request from the device
120 * request queue, so that ide.c could service requests from the other device
121 * on the same interface in the meantime.
123 * 2. After the successful initialization of a "media access packet command",
124 * which is a command that can take a long time to complete (the interval can
125 * range from several seconds to even an hour). Again, we postpone our request
126 * in the middle to free the bus for the other device. The polling frequency
127 * here should be lower than the read/write frequency since those media access
128 * commands are slow. We start from a "fast" frequency - IDETAPE_DSC_MA_FAST
129 * (1 second), and if we don't receive DSC after IDETAPE_DSC_MA_THRESHOLD
130 * (5 min), we switch it to a lower frequency - IDETAPE_DSC_MA_SLOW (1 min).
132 * We also set a timeout for the timer, in case something goes wrong. The
133 * timeout should be longer then the maximum execution time of a tape operation.
137 #define IDETAPE_DSC_RW_MIN 5*HZ/100 /* 50 msec */
138 #define IDETAPE_DSC_RW_MAX 40*HZ/100 /* 400 msec */
139 #define IDETAPE_DSC_RW_TIMEOUT 2*60*HZ /* 2 minutes */
140 #define IDETAPE_DSC_MA_FAST 2*HZ /* 2 seconds */
141 #define IDETAPE_DSC_MA_THRESHOLD 5*60*HZ /* 5 minutes */
142 #define IDETAPE_DSC_MA_SLOW 30*HZ /* 30 seconds */
143 #define IDETAPE_DSC_MA_TIMEOUT 2*60*60*HZ /* 2 hours */
145 /*************************** End of tunable parameters ***********************/
147 /* tape directions */
149 IDETAPE_DIR_NONE = (1 << 0),
150 IDETAPE_DIR_READ = (1 << 1),
151 IDETAPE_DIR_WRITE = (1 << 2),
157 struct idetape_bh *b_reqnext;
161 /* Tape door status */
162 #define DOOR_UNLOCKED 0
163 #define DOOR_LOCKED 1
164 #define DOOR_EXPLICITLY_LOCKED 2
166 /* Some defines for the SPACE command */
167 #define IDETAPE_SPACE_OVER_FILEMARK 1
168 #define IDETAPE_SPACE_TO_EOD 3
170 /* Some defines for the LOAD UNLOAD command */
171 #define IDETAPE_LU_LOAD_MASK 1
172 #define IDETAPE_LU_RETENSION_MASK 2
173 #define IDETAPE_LU_EOT_MASK 4
176 * Special requests for our block device strategy routine.
178 * In order to service a character device command, we add special requests to
179 * the tail of our block device request queue and wait for their completion.
183 REQ_IDETAPE_PC1 = (1 << 0), /* packet command (first stage) */
184 REQ_IDETAPE_PC2 = (1 << 1), /* packet command (second stage) */
185 REQ_IDETAPE_READ = (1 << 2),
186 REQ_IDETAPE_WRITE = (1 << 3),
189 /* Error codes returned in rq->errors to the higher part of the driver. */
190 #define IDETAPE_ERROR_GENERAL 101
191 #define IDETAPE_ERROR_FILEMARK 102
192 #define IDETAPE_ERROR_EOD 103
194 /* Structures related to the SELECT SENSE / MODE SENSE packet commands. */
195 #define IDETAPE_BLOCK_DESCRIPTOR 0
196 #define IDETAPE_CAPABILITIES_PAGE 0x2a
198 /* Tape flag bits values. */
200 IDETAPE_FLAG_IGNORE_DSC = (1 << 0),
201 /* 0 When the tape position is unknown */
202 IDETAPE_FLAG_ADDRESS_VALID = (1 << 1),
203 /* Device already opened */
204 IDETAPE_FLAG_BUSY = (1 << 2),
205 /* Attempt to auto-detect the current user block size */
206 IDETAPE_FLAG_DETECT_BS = (1 << 3),
207 /* Currently on a filemark */
208 IDETAPE_FLAG_FILEMARK = (1 << 4),
209 /* DRQ interrupt device */
210 IDETAPE_FLAG_DRQ_INTERRUPT = (1 << 5),
211 /* 0 = no tape is loaded, so we don't rewind after ejecting */
212 IDETAPE_FLAG_MEDIUM_PRESENT = (1 << 6),
216 * Most of our global data which we need to save even as we leave the driver due
217 * to an interrupt or a timer event is stored in the struct defined below.
219 typedef struct ide_tape_obj {
221 ide_driver_t *driver;
222 struct gendisk *disk;
226 * Since a typical character device operation requires more
227 * than one packet command, we provide here enough memory
228 * for the maximum of interconnected packet commands.
229 * The packet commands are stored in the circular array pc_stack.
230 * pc_stack_index points to the last used entry, and warps around
231 * to the start when we get to the last array entry.
233 * pc points to the current processed packet command.
235 * failed_pc points to the last failed packet command, or contains
236 * NULL if we do not need to retry any packet command. This is
237 * required since an additional packet command is needed before the
238 * retry, to get detailed information on what went wrong.
240 /* Current packet command */
241 struct ide_atapi_pc *pc;
242 /* Last failed packet command */
243 struct ide_atapi_pc *failed_pc;
244 /* Packet command stack */
245 struct ide_atapi_pc pc_stack[IDETAPE_PC_STACK];
246 /* Next free packet command storage space */
248 struct request rq_stack[IDETAPE_PC_STACK];
249 /* We implement a circular array */
253 * DSC polling variables.
255 * While polling for DSC we use postponed_rq to postpone the current
256 * request so that ide.c will be able to service pending requests on the
257 * other device. Note that at most we will have only one DSC (usually
258 * data transfer) request in the device request queue.
260 struct request *postponed_rq;
261 /* The time in which we started polling for DSC */
262 unsigned long dsc_polling_start;
263 /* Timer used to poll for dsc */
264 struct timer_list dsc_timer;
265 /* Read/Write dsc polling frequency */
266 unsigned long best_dsc_rw_freq;
267 unsigned long dsc_poll_freq;
268 unsigned long dsc_timeout;
270 /* Read position information */
273 unsigned int first_frame;
275 /* Last error information */
276 u8 sense_key, asc, ascq;
278 /* Character device operation */
282 /* Current character device data transfer direction */
285 /* tape block size, usually 512 or 1024 bytes */
286 unsigned short blk_size;
289 /* Copy of the tape's Capabilities and Mechanical Page */
293 * Active data transfer request parameters.
295 * At most, there is only one ide-tape originated data transfer request
296 * in the device request queue. This allows ide.c to easily service
297 * requests from the other device when we postpone our active request.
300 /* Data buffer size chosen based on the tape's recommendation */
303 struct idetape_bh *merge_bh;
304 /* size of the merge buffer */
306 /* pointer to current buffer head within the merge buffer */
307 struct idetape_bh *bh;
311 int pages_per_buffer;
312 /* Wasted space in each stage */
315 /* Status/Action flags: long for set_bit */
317 /* protects the ide-tape queue */
320 /* Measures average tape speed */
321 unsigned long avg_time;
325 /* the door is currently locked */
327 /* the tape hardware is write protected */
329 /* the tape is write protected (hardware or opened as read-only) */
335 static DEFINE_MUTEX(idetape_ref_mutex);
337 static struct class *idetape_sysfs_class;
339 #define to_ide_tape(obj) container_of(obj, struct ide_tape_obj, kref)
341 #define ide_tape_g(disk) \
342 container_of((disk)->private_data, struct ide_tape_obj, driver)
344 static struct ide_tape_obj *ide_tape_get(struct gendisk *disk)
346 struct ide_tape_obj *tape = NULL;
348 mutex_lock(&idetape_ref_mutex);
349 tape = ide_tape_g(disk);
351 kref_get(&tape->kref);
352 mutex_unlock(&idetape_ref_mutex);
356 static void ide_tape_release(struct kref *);
358 static void ide_tape_put(struct ide_tape_obj *tape)
360 mutex_lock(&idetape_ref_mutex);
361 kref_put(&tape->kref, ide_tape_release);
362 mutex_unlock(&idetape_ref_mutex);
366 * The variables below are used for the character device interface. Additional
367 * state variables are defined in our ide_drive_t structure.
369 static struct ide_tape_obj *idetape_devs[MAX_HWIFS * MAX_DRIVES];
371 #define ide_tape_f(file) ((file)->private_data)
373 static struct ide_tape_obj *ide_tape_chrdev_get(unsigned int i)
375 struct ide_tape_obj *tape = NULL;
377 mutex_lock(&idetape_ref_mutex);
378 tape = idetape_devs[i];
380 kref_get(&tape->kref);
381 mutex_unlock(&idetape_ref_mutex);
385 static void idetape_input_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
388 struct idetape_bh *bh = pc->bh;
393 printk(KERN_ERR "ide-tape: bh == NULL in "
394 "idetape_input_buffers\n");
395 ide_pad_transfer(drive, 0, bcount);
399 (unsigned int)(bh->b_size - atomic_read(&bh->b_count)),
401 drive->hwif->input_data(drive, NULL, bh->b_data +
402 atomic_read(&bh->b_count), count);
404 atomic_add(count, &bh->b_count);
405 if (atomic_read(&bh->b_count) == bh->b_size) {
408 atomic_set(&bh->b_count, 0);
414 static void idetape_output_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
417 struct idetape_bh *bh = pc->bh;
422 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
426 count = min((unsigned int)pc->b_count, (unsigned int)bcount);
427 drive->hwif->output_data(drive, NULL, pc->b_data, count);
430 pc->b_count -= count;
435 pc->b_data = bh->b_data;
436 pc->b_count = atomic_read(&bh->b_count);
442 static void idetape_update_buffers(struct ide_atapi_pc *pc)
444 struct idetape_bh *bh = pc->bh;
446 unsigned int bcount = pc->xferred;
448 if (pc->flags & PC_FLAG_WRITING)
452 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
456 count = min((unsigned int)bh->b_size, (unsigned int)bcount);
457 atomic_set(&bh->b_count, count);
458 if (atomic_read(&bh->b_count) == bh->b_size)
466 * idetape_next_pc_storage returns a pointer to a place in which we can
467 * safely store a packet command, even though we intend to leave the
468 * driver. A storage space for a maximum of IDETAPE_PC_STACK packet
469 * commands is allocated at initialization time.
471 static struct ide_atapi_pc *idetape_next_pc_storage(ide_drive_t *drive)
473 idetape_tape_t *tape = drive->driver_data;
475 debug_log(DBG_PCRQ_STACK, "pc_stack_index=%d\n", tape->pc_stack_index);
477 if (tape->pc_stack_index == IDETAPE_PC_STACK)
478 tape->pc_stack_index = 0;
479 return (&tape->pc_stack[tape->pc_stack_index++]);
483 * idetape_next_rq_storage is used along with idetape_next_pc_storage.
484 * Since we queue packet commands in the request queue, we need to
485 * allocate a request, along with the allocation of a packet command.
488 /**************************************************************
490 * This should get fixed to use kmalloc(.., GFP_ATOMIC) *
491 * followed later on by kfree(). -ml *
493 **************************************************************/
495 static struct request *idetape_next_rq_storage(ide_drive_t *drive)
497 idetape_tape_t *tape = drive->driver_data;
499 debug_log(DBG_PCRQ_STACK, "rq_stack_index=%d\n", tape->rq_stack_index);
501 if (tape->rq_stack_index == IDETAPE_PC_STACK)
502 tape->rq_stack_index = 0;
503 return (&tape->rq_stack[tape->rq_stack_index++]);
506 static void idetape_init_pc(struct ide_atapi_pc *pc)
508 memset(pc->c, 0, 12);
512 pc->buf = pc->pc_buf;
513 pc->buf_size = IDETAPE_PC_BUFFER_SIZE;
519 * called on each failed packet command retry to analyze the request sense. We
520 * currently do not utilize this information.
522 static void idetape_analyze_error(ide_drive_t *drive, u8 *sense)
524 idetape_tape_t *tape = drive->driver_data;
525 struct ide_atapi_pc *pc = tape->failed_pc;
527 tape->sense_key = sense[2] & 0xF;
528 tape->asc = sense[12];
529 tape->ascq = sense[13];
531 debug_log(DBG_ERR, "pc = %x, sense key = %x, asc = %x, ascq = %x\n",
532 pc->c[0], tape->sense_key, tape->asc, tape->ascq);
534 /* Correct pc->xferred by asking the tape. */
535 if (pc->flags & PC_FLAG_DMA_ERROR) {
536 pc->xferred = pc->req_xfer -
538 get_unaligned_be32(&sense[3]);
539 idetape_update_buffers(pc);
543 * If error was the result of a zero-length read or write command,
544 * with sense key=5, asc=0x22, ascq=0, let it slide. Some drives
545 * (i.e. Seagate STT3401A Travan) don't support 0-length read/writes.
547 if ((pc->c[0] == READ_6 || pc->c[0] == WRITE_6)
549 && pc->c[4] == 0 && pc->c[3] == 0 && pc->c[2] == 0) {
550 if (tape->sense_key == 5) {
551 /* don't report an error, everything's ok */
553 /* don't retry read/write */
554 pc->flags |= PC_FLAG_ABORT;
557 if (pc->c[0] == READ_6 && (sense[2] & 0x80)) {
558 pc->error = IDETAPE_ERROR_FILEMARK;
559 pc->flags |= PC_FLAG_ABORT;
561 if (pc->c[0] == WRITE_6) {
562 if ((sense[2] & 0x40) || (tape->sense_key == 0xd
563 && tape->asc == 0x0 && tape->ascq == 0x2)) {
564 pc->error = IDETAPE_ERROR_EOD;
565 pc->flags |= PC_FLAG_ABORT;
568 if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
569 if (tape->sense_key == 8) {
570 pc->error = IDETAPE_ERROR_EOD;
571 pc->flags |= PC_FLAG_ABORT;
573 if (!(pc->flags & PC_FLAG_ABORT) &&
575 pc->retries = IDETAPE_MAX_PC_RETRIES + 1;
579 /* Free data buffers completely. */
580 static void ide_tape_kfree_buffer(idetape_tape_t *tape)
582 struct idetape_bh *prev_bh, *bh = tape->merge_bh;
585 u32 size = bh->b_size;
588 unsigned int order = fls(size >> PAGE_SHIFT)-1;
591 free_pages((unsigned long)bh->b_data, order);
594 bh->b_data += (1 << order) * PAGE_SIZE;
600 kfree(tape->merge_bh);
603 static int idetape_end_request(ide_drive_t *drive, int uptodate, int nr_sects)
605 struct request *rq = HWGROUP(drive)->rq;
606 idetape_tape_t *tape = drive->driver_data;
610 debug_log(DBG_PROCS, "Enter %s\n", __func__);
613 case 0: error = IDETAPE_ERROR_GENERAL; break;
614 case 1: error = 0; break;
615 default: error = uptodate;
619 tape->failed_pc = NULL;
621 if (!blk_special_request(rq)) {
622 ide_end_request(drive, uptodate, nr_sects);
626 spin_lock_irqsave(&tape->lock, flags);
628 ide_end_drive_cmd(drive, 0, 0);
630 spin_unlock_irqrestore(&tape->lock, flags);
634 static ide_startstop_t idetape_request_sense_callback(ide_drive_t *drive)
636 idetape_tape_t *tape = drive->driver_data;
638 debug_log(DBG_PROCS, "Enter %s\n", __func__);
640 if (!tape->pc->error) {
641 idetape_analyze_error(drive, tape->pc->buf);
642 idetape_end_request(drive, 1, 0);
644 printk(KERN_ERR "ide-tape: Error in REQUEST SENSE itself - "
645 "Aborting request!\n");
646 idetape_end_request(drive, 0, 0);
651 static void idetape_create_request_sense_cmd(struct ide_atapi_pc *pc)
654 pc->c[0] = REQUEST_SENSE;
657 pc->idetape_callback = &idetape_request_sense_callback;
660 static void idetape_init_rq(struct request *rq, u8 cmd)
662 blk_rq_init(NULL, rq);
663 rq->cmd_type = REQ_TYPE_SPECIAL;
668 * Generate a new packet command request in front of the request queue, before
669 * the current request, so that it will be processed immediately, on the next
670 * pass through the driver. The function below is called from the request
671 * handling part of the driver (the "bottom" part). Safe storage for the request
672 * should be allocated with ide_tape_next_{pc,rq}_storage() prior to that.
674 * Memory for those requests is pre-allocated at initialization time, and is
675 * limited to IDETAPE_PC_STACK requests. We assume that we have enough space for
676 * the maximum possible number of inter-dependent packet commands.
678 * The higher level of the driver - The ioctl handler and the character device
679 * handling functions should queue request to the lower level part and wait for
680 * their completion using idetape_queue_pc_tail or idetape_queue_rw_tail.
682 static void idetape_queue_pc_head(ide_drive_t *drive, struct ide_atapi_pc *pc,
685 struct ide_tape_obj *tape = drive->driver_data;
687 idetape_init_rq(rq, REQ_IDETAPE_PC1);
688 rq->cmd_flags |= REQ_PREEMPT;
689 rq->buffer = (char *) pc;
690 rq->rq_disk = tape->disk;
691 ide_do_drive_cmd(drive, rq);
695 * idetape_retry_pc is called when an error was detected during the
696 * last packet command. We queue a request sense packet command in
697 * the head of the request list.
699 static void idetape_retry_pc(ide_drive_t *drive)
701 idetape_tape_t *tape = drive->driver_data;
702 struct ide_atapi_pc *pc;
705 (void)ide_read_error(drive);
706 pc = idetape_next_pc_storage(drive);
707 rq = idetape_next_rq_storage(drive);
708 idetape_create_request_sense_cmd(pc);
709 set_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags);
710 idetape_queue_pc_head(drive, pc, rq);
714 * Postpone the current request so that ide.c will be able to service requests
715 * from another device on the same hwgroup while we are polling for DSC.
717 static void idetape_postpone_request(ide_drive_t *drive)
719 idetape_tape_t *tape = drive->driver_data;
721 debug_log(DBG_PROCS, "Enter %s\n", __func__);
723 tape->postponed_rq = HWGROUP(drive)->rq;
724 ide_stall_queue(drive, tape->dsc_poll_freq);
727 typedef void idetape_io_buf(ide_drive_t *, struct ide_atapi_pc *, unsigned int);
730 * This is the usual interrupt handler which will be called during a packet
731 * command. We will transfer some of the data (as requested by the drive) and
732 * will re-point interrupt handler to us. When data transfer is finished, we
733 * will act according to the algorithm described before
736 static ide_startstop_t idetape_pc_intr(ide_drive_t *drive)
738 ide_hwif_t *hwif = drive->hwif;
739 idetape_tape_t *tape = drive->driver_data;
740 struct ide_atapi_pc *pc = tape->pc;
741 xfer_func_t *xferfunc;
742 idetape_io_buf *iobuf;
747 debug_log(DBG_PROCS, "Enter %s - interrupt handler\n", __func__);
749 /* Clear the interrupt */
750 stat = ide_read_status(drive);
752 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
753 if (hwif->dma_ops->dma_end(drive) || (stat & ERR_STAT)) {
754 pc->flags |= PC_FLAG_DMA_ERROR;
756 pc->xferred = pc->req_xfer;
757 idetape_update_buffers(pc);
759 debug_log(DBG_PROCS, "DMA finished\n");
763 /* No more interrupts */
764 if ((stat & DRQ_STAT) == 0) {
765 debug_log(DBG_SENSE, "Packet command completed, %d bytes"
766 " transferred\n", pc->xferred);
768 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
769 local_irq_enable_in_hardirq();
771 if ((stat & ERR_STAT) && pc->c[0] == REQUEST_SENSE)
773 if ((stat & ERR_STAT) || (pc->flags & PC_FLAG_DMA_ERROR)) {
775 debug_log(DBG_ERR, "%s: I/O error\n", tape->name);
777 if (pc->c[0] == REQUEST_SENSE) {
778 printk(KERN_ERR "%s: I/O error in request sense"
779 " command\n", drive->name);
780 return ide_do_reset(drive);
782 debug_log(DBG_ERR, "[cmd %x]: check condition\n",
785 /* Retry operation */
786 idetape_retry_pc(drive);
790 if ((pc->flags & PC_FLAG_WAIT_FOR_DSC) &&
791 (stat & SEEK_STAT) == 0) {
792 /* Media access command */
793 tape->dsc_polling_start = jiffies;
794 tape->dsc_poll_freq = IDETAPE_DSC_MA_FAST;
795 tape->dsc_timeout = jiffies + IDETAPE_DSC_MA_TIMEOUT;
796 /* Allow ide.c to handle other requests */
797 idetape_postpone_request(drive);
800 if (tape->failed_pc == pc)
801 tape->failed_pc = NULL;
802 /* Command finished - Call the callback function */
803 return pc->idetape_callback(drive);
806 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
807 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
808 printk(KERN_ERR "%s: The device wants to issue more interrupts "
809 "in DMA mode\n", drive->name);
811 return ide_do_reset(drive);
813 /* Get the number of bytes to transfer on this interrupt. */
814 bcount = (hwif->INB(hwif->io_ports.lbah_addr) << 8) |
815 hwif->INB(hwif->io_ports.lbam_addr);
817 ireason = hwif->INB(hwif->io_ports.nsect_addr);
820 printk(KERN_ERR "%s: CoD != 0 in %s\n", drive->name, __func__);
821 return ide_do_reset(drive);
823 if (((ireason & IO) == IO) == !!(pc->flags & PC_FLAG_WRITING)) {
824 /* Hopefully, we will never get here */
825 printk(KERN_ERR "%s: We wanted to %s, but the device wants us "
826 "to %s!\n", drive->name,
827 (ireason & IO) ? "Write" : "Read",
828 (ireason & IO) ? "Read" : "Write");
829 return ide_do_reset(drive);
831 if (!(pc->flags & PC_FLAG_WRITING)) {
832 /* Reading - Check that we have enough space */
833 temp = pc->xferred + bcount;
834 if (temp > pc->req_xfer) {
835 if (temp > pc->buf_size) {
836 printk(KERN_ERR "%s: The device wants to send "
837 "us more data than expected - "
840 ide_pad_transfer(drive, 0, bcount);
841 ide_set_handler(drive, &idetape_pc_intr,
842 IDETAPE_WAIT_CMD, NULL);
845 debug_log(DBG_SENSE, "The device wants to send us more "
846 "data than expected - allowing transfer\n");
848 iobuf = &idetape_input_buffers;
849 xferfunc = hwif->input_data;
851 iobuf = &idetape_output_buffers;
852 xferfunc = hwif->output_data;
856 iobuf(drive, pc, bcount);
858 xferfunc(drive, NULL, pc->cur_pos, bcount);
860 /* Update the current position */
861 pc->xferred += bcount;
862 pc->cur_pos += bcount;
864 debug_log(DBG_SENSE, "[cmd %x] transferred %d bytes on that intr.\n",
867 /* And set the interrupt handler again */
868 ide_set_handler(drive, &idetape_pc_intr, IDETAPE_WAIT_CMD, NULL);
873 * Packet Command Interface
875 * The current Packet Command is available in tape->pc, and will not change
876 * until we finish handling it. Each packet command is associated with a
877 * callback function that will be called when the command is finished.
879 * The handling will be done in three stages:
881 * 1. idetape_issue_pc will send the packet command to the drive, and will set
882 * the interrupt handler to idetape_pc_intr.
884 * 2. On each interrupt, idetape_pc_intr will be called. This step will be
885 * repeated until the device signals us that no more interrupts will be issued.
887 * 3. ATAPI Tape media access commands have immediate status with a delayed
888 * process. In case of a successful initiation of a media access packet command,
889 * the DSC bit will be set when the actual execution of the command is finished.
890 * Since the tape drive will not issue an interrupt, we have to poll for this
891 * event. In this case, we define the request as "low priority request" by
892 * setting rq_status to IDETAPE_RQ_POSTPONED, set a timer to poll for DSC and
895 * ide.c will then give higher priority to requests which originate from the
896 * other device, until will change rq_status to RQ_ACTIVE.
898 * 4. When the packet command is finished, it will be checked for errors.
900 * 5. In case an error was found, we queue a request sense packet command in
901 * front of the request queue and retry the operation up to
902 * IDETAPE_MAX_PC_RETRIES times.
904 * 6. In case no error was found, or we decided to give up and not to retry
905 * again, the callback function will be called and then we will handle the next
908 static ide_startstop_t idetape_transfer_pc(ide_drive_t *drive)
910 ide_hwif_t *hwif = drive->hwif;
911 idetape_tape_t *tape = drive->driver_data;
912 struct ide_atapi_pc *pc = tape->pc;
914 ide_startstop_t startstop;
917 if (ide_wait_stat(&startstop, drive, DRQ_STAT, BUSY_STAT, WAIT_READY)) {
918 printk(KERN_ERR "%s: Strange, packet command initiated yet "
919 "DRQ isn't asserted\n", drive->name);
922 ireason = hwif->INB(hwif->io_ports.nsect_addr);
923 while (retries-- && ((ireason & CD) == 0 || (ireason & IO))) {
924 printk(KERN_ERR "%s: (IO,CoD != (0,1) while issuing "
925 "a packet command, retrying\n", drive->name);
927 ireason = hwif->INB(hwif->io_ports.nsect_addr);
929 printk(KERN_ERR "%s: (IO,CoD != (0,1) while issuing "
930 "a packet command, ignoring\n",
936 if ((ireason & CD) == 0 || (ireason & IO)) {
937 printk(KERN_ERR "%s: (IO,CoD) != (0,1) while issuing "
938 "a packet command\n", drive->name);
939 return ide_do_reset(drive);
941 /* Set the interrupt routine */
942 ide_set_handler(drive, &idetape_pc_intr, IDETAPE_WAIT_CMD, NULL);
944 /* Begin DMA, if necessary */
945 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS)
946 hwif->dma_ops->dma_start(drive);
948 /* Send the actual packet */
949 hwif->output_data(drive, NULL, pc->c, 12);
954 static ide_startstop_t idetape_issue_pc(ide_drive_t *drive,
955 struct ide_atapi_pc *pc)
957 ide_hwif_t *hwif = drive->hwif;
958 idetape_tape_t *tape = drive->driver_data;
962 if (tape->pc->c[0] == REQUEST_SENSE &&
963 pc->c[0] == REQUEST_SENSE) {
964 printk(KERN_ERR "ide-tape: possible ide-tape.c bug - "
965 "Two request sense in serial were issued\n");
968 if (tape->failed_pc == NULL && pc->c[0] != REQUEST_SENSE)
969 tape->failed_pc = pc;
970 /* Set the current packet command */
973 if (pc->retries > IDETAPE_MAX_PC_RETRIES ||
974 (pc->flags & PC_FLAG_ABORT)) {
976 * We will "abort" retrying a packet command in case legitimate
977 * error code was received (crossing a filemark, or end of the
978 * media, for example).
980 if (!(pc->flags & PC_FLAG_ABORT)) {
981 if (!(pc->c[0] == TEST_UNIT_READY &&
982 tape->sense_key == 2 && tape->asc == 4 &&
983 (tape->ascq == 1 || tape->ascq == 8))) {
984 printk(KERN_ERR "ide-tape: %s: I/O error, "
985 "pc = %2x, key = %2x, "
986 "asc = %2x, ascq = %2x\n",
987 tape->name, pc->c[0],
988 tape->sense_key, tape->asc,
992 pc->error = IDETAPE_ERROR_GENERAL;
994 tape->failed_pc = NULL;
995 return pc->idetape_callback(drive);
997 debug_log(DBG_SENSE, "Retry #%d, cmd = %02X\n", pc->retries, pc->c[0]);
1000 /* We haven't transferred any data yet */
1002 pc->cur_pos = pc->buf;
1003 /* Request to transfer the entire buffer at once */
1004 bcount = pc->req_xfer;
1006 if (pc->flags & PC_FLAG_DMA_ERROR) {
1007 pc->flags &= ~PC_FLAG_DMA_ERROR;
1010 if ((pc->flags & PC_FLAG_DMA_RECOMMENDED) && drive->using_dma)
1011 dma_ok = !hwif->dma_ops->dma_setup(drive);
1013 ide_pktcmd_tf_load(drive, IDE_TFLAG_OUT_DEVICE, bcount, dma_ok);
1016 /* Will begin DMA later */
1017 pc->flags |= PC_FLAG_DMA_IN_PROGRESS;
1018 if (test_bit(IDETAPE_FLAG_DRQ_INTERRUPT, &tape->flags)) {
1019 ide_execute_command(drive, WIN_PACKETCMD, &idetape_transfer_pc,
1020 IDETAPE_WAIT_CMD, NULL);
1023 ide_execute_pkt_cmd(drive);
1024 return idetape_transfer_pc(drive);
1028 static ide_startstop_t idetape_pc_callback(ide_drive_t *drive)
1030 idetape_tape_t *tape = drive->driver_data;
1032 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1034 idetape_end_request(drive, tape->pc->error ? 0 : 1, 0);
1038 /* A mode sense command is used to "sense" tape parameters. */
1039 static void idetape_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
1041 idetape_init_pc(pc);
1042 pc->c[0] = MODE_SENSE;
1043 if (page_code != IDETAPE_BLOCK_DESCRIPTOR)
1044 /* DBD = 1 - Don't return block descriptors */
1046 pc->c[2] = page_code;
1048 * Changed pc->c[3] to 0 (255 will at best return unused info).
1050 * For SCSI this byte is defined as subpage instead of high byte
1051 * of length and some IDE drives seem to interpret it this way
1052 * and return an error when 255 is used.
1055 /* We will just discard data in that case */
1057 if (page_code == IDETAPE_BLOCK_DESCRIPTOR)
1059 else if (page_code == IDETAPE_CAPABILITIES_PAGE)
1063 pc->idetape_callback = &idetape_pc_callback;
1066 static ide_startstop_t idetape_media_access_finished(ide_drive_t *drive)
1068 idetape_tape_t *tape = drive->driver_data;
1069 struct ide_atapi_pc *pc = tape->pc;
1072 stat = ide_read_status(drive);
1074 if (stat & SEEK_STAT) {
1075 if (stat & ERR_STAT) {
1076 /* Error detected */
1077 if (pc->c[0] != TEST_UNIT_READY)
1078 printk(KERN_ERR "ide-tape: %s: I/O error, ",
1080 /* Retry operation */
1081 idetape_retry_pc(drive);
1085 if (tape->failed_pc == pc)
1086 tape->failed_pc = NULL;
1088 pc->error = IDETAPE_ERROR_GENERAL;
1089 tape->failed_pc = NULL;
1091 return pc->idetape_callback(drive);
1094 static ide_startstop_t idetape_rw_callback(ide_drive_t *drive)
1096 idetape_tape_t *tape = drive->driver_data;
1097 struct request *rq = HWGROUP(drive)->rq;
1098 int blocks = tape->pc->xferred / tape->blk_size;
1100 tape->avg_size += blocks * tape->blk_size;
1102 if (time_after_eq(jiffies, tape->avg_time + HZ)) {
1103 tape->avg_speed = tape->avg_size * HZ /
1104 (jiffies - tape->avg_time) / 1024;
1106 tape->avg_time = jiffies;
1108 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1110 tape->first_frame += blocks;
1111 rq->current_nr_sectors -= blocks;
1113 if (!tape->pc->error)
1114 idetape_end_request(drive, 1, 0);
1116 idetape_end_request(drive, tape->pc->error, 0);
1120 static void idetape_create_read_cmd(idetape_tape_t *tape,
1121 struct ide_atapi_pc *pc,
1122 unsigned int length, struct idetape_bh *bh)
1124 idetape_init_pc(pc);
1126 put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
1128 pc->idetape_callback = &idetape_rw_callback;
1130 atomic_set(&bh->b_count, 0);
1132 pc->buf_size = length * tape->blk_size;
1133 pc->req_xfer = pc->buf_size;
1134 if (pc->req_xfer == tape->buffer_size)
1135 pc->flags |= PC_FLAG_DMA_RECOMMENDED;
1138 static void idetape_create_write_cmd(idetape_tape_t *tape,
1139 struct ide_atapi_pc *pc,
1140 unsigned int length, struct idetape_bh *bh)
1142 idetape_init_pc(pc);
1144 put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
1146 pc->idetape_callback = &idetape_rw_callback;
1147 pc->flags |= PC_FLAG_WRITING;
1149 pc->b_data = bh->b_data;
1150 pc->b_count = atomic_read(&bh->b_count);
1152 pc->buf_size = length * tape->blk_size;
1153 pc->req_xfer = pc->buf_size;
1154 if (pc->req_xfer == tape->buffer_size)
1155 pc->flags |= PC_FLAG_DMA_RECOMMENDED;
1158 static ide_startstop_t idetape_do_request(ide_drive_t *drive,
1159 struct request *rq, sector_t block)
1161 idetape_tape_t *tape = drive->driver_data;
1162 struct ide_atapi_pc *pc = NULL;
1163 struct request *postponed_rq = tape->postponed_rq;
1166 debug_log(DBG_SENSE, "sector: %ld, nr_sectors: %ld,"
1167 " current_nr_sectors: %d\n",
1168 rq->sector, rq->nr_sectors, rq->current_nr_sectors);
1170 if (!blk_special_request(rq)) {
1171 /* We do not support buffer cache originated requests. */
1172 printk(KERN_NOTICE "ide-tape: %s: Unsupported request in "
1173 "request queue (%d)\n", drive->name, rq->cmd_type);
1174 ide_end_request(drive, 0, 0);
1178 /* Retry a failed packet command */
1179 if (tape->failed_pc && tape->pc->c[0] == REQUEST_SENSE)
1180 return idetape_issue_pc(drive, tape->failed_pc);
1182 if (postponed_rq != NULL)
1183 if (rq != postponed_rq) {
1184 printk(KERN_ERR "ide-tape: ide-tape.c bug - "
1185 "Two DSC requests were queued\n");
1186 idetape_end_request(drive, 0, 0);
1190 tape->postponed_rq = NULL;
1193 * If the tape is still busy, postpone our request and service
1194 * the other device meanwhile.
1196 stat = ide_read_status(drive);
1198 if (!drive->dsc_overlap && !(rq->cmd[0] & REQ_IDETAPE_PC2))
1199 set_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags);
1201 if (drive->post_reset == 1) {
1202 set_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags);
1203 drive->post_reset = 0;
1206 if (!test_and_clear_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags) &&
1207 (stat & SEEK_STAT) == 0) {
1208 if (postponed_rq == NULL) {
1209 tape->dsc_polling_start = jiffies;
1210 tape->dsc_poll_freq = tape->best_dsc_rw_freq;
1211 tape->dsc_timeout = jiffies + IDETAPE_DSC_RW_TIMEOUT;
1212 } else if (time_after(jiffies, tape->dsc_timeout)) {
1213 printk(KERN_ERR "ide-tape: %s: DSC timeout\n",
1215 if (rq->cmd[0] & REQ_IDETAPE_PC2) {
1216 idetape_media_access_finished(drive);
1219 return ide_do_reset(drive);
1221 } else if (time_after(jiffies,
1222 tape->dsc_polling_start +
1223 IDETAPE_DSC_MA_THRESHOLD))
1224 tape->dsc_poll_freq = IDETAPE_DSC_MA_SLOW;
1225 idetape_postpone_request(drive);
1228 if (rq->cmd[0] & REQ_IDETAPE_READ) {
1229 pc = idetape_next_pc_storage(drive);
1230 idetape_create_read_cmd(tape, pc, rq->current_nr_sectors,
1231 (struct idetape_bh *)rq->special);
1234 if (rq->cmd[0] & REQ_IDETAPE_WRITE) {
1235 pc = idetape_next_pc_storage(drive);
1236 idetape_create_write_cmd(tape, pc, rq->current_nr_sectors,
1237 (struct idetape_bh *)rq->special);
1240 if (rq->cmd[0] & REQ_IDETAPE_PC1) {
1241 pc = (struct ide_atapi_pc *) rq->buffer;
1242 rq->cmd[0] &= ~(REQ_IDETAPE_PC1);
1243 rq->cmd[0] |= REQ_IDETAPE_PC2;
1246 if (rq->cmd[0] & REQ_IDETAPE_PC2) {
1247 idetape_media_access_finished(drive);
1252 return idetape_issue_pc(drive, pc);
1256 * The function below uses __get_free_pages to allocate a data buffer of size
1257 * tape->buffer_size (or a bit more). We attempt to combine sequential pages as
1260 * It returns a pointer to the newly allocated buffer, or NULL in case of
1263 static struct idetape_bh *ide_tape_kmalloc_buffer(idetape_tape_t *tape,
1264 int full, int clear)
1266 struct idetape_bh *prev_bh, *bh, *merge_bh;
1267 int pages = tape->pages_per_buffer;
1268 unsigned int order, b_allocd;
1269 char *b_data = NULL;
1271 merge_bh = kmalloc(sizeof(struct idetape_bh), GFP_KERNEL);
1276 order = fls(pages) - 1;
1277 bh->b_data = (char *) __get_free_pages(GFP_KERNEL, order);
1280 b_allocd = (1 << order) * PAGE_SIZE;
1284 memset(bh->b_data, 0, b_allocd);
1285 bh->b_reqnext = NULL;
1286 bh->b_size = b_allocd;
1287 atomic_set(&bh->b_count, full ? bh->b_size : 0);
1290 order = fls(pages) - 1;
1291 b_data = (char *) __get_free_pages(GFP_KERNEL, order);
1294 b_allocd = (1 << order) * PAGE_SIZE;
1297 memset(b_data, 0, b_allocd);
1299 /* newly allocated page frames below buffer header or ...*/
1300 if (bh->b_data == b_data + b_allocd) {
1301 bh->b_size += b_allocd;
1302 bh->b_data -= b_allocd;
1304 atomic_add(b_allocd, &bh->b_count);
1307 /* they are above the header */
1308 if (b_data == bh->b_data + bh->b_size) {
1309 bh->b_size += b_allocd;
1311 atomic_add(b_allocd, &bh->b_count);
1315 bh = kmalloc(sizeof(struct idetape_bh), GFP_KERNEL);
1317 free_pages((unsigned long) b_data, order);
1320 bh->b_reqnext = NULL;
1321 bh->b_data = b_data;
1322 bh->b_size = b_allocd;
1323 atomic_set(&bh->b_count, full ? bh->b_size : 0);
1324 prev_bh->b_reqnext = bh;
1329 bh->b_size -= tape->excess_bh_size;
1331 atomic_sub(tape->excess_bh_size, &bh->b_count);
1334 ide_tape_kfree_buffer(tape);
1338 static int idetape_copy_stage_from_user(idetape_tape_t *tape,
1339 const char __user *buf, int n)
1341 struct idetape_bh *bh = tape->bh;
1347 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
1351 count = min((unsigned int)
1352 (bh->b_size - atomic_read(&bh->b_count)),
1354 if (copy_from_user(bh->b_data + atomic_read(&bh->b_count), buf,
1358 atomic_add(count, &bh->b_count);
1360 if (atomic_read(&bh->b_count) == bh->b_size) {
1363 atomic_set(&bh->b_count, 0);
1370 static int idetape_copy_stage_to_user(idetape_tape_t *tape, char __user *buf,
1373 struct idetape_bh *bh = tape->bh;
1379 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
1383 count = min(tape->b_count, n);
1384 if (copy_to_user(buf, tape->b_data, count))
1387 tape->b_data += count;
1388 tape->b_count -= count;
1390 if (!tape->b_count) {
1394 tape->b_data = bh->b_data;
1395 tape->b_count = atomic_read(&bh->b_count);
1402 static void idetape_init_merge_buffer(idetape_tape_t *tape)
1404 struct idetape_bh *bh = tape->merge_bh;
1405 tape->bh = tape->merge_bh;
1407 if (tape->chrdev_dir == IDETAPE_DIR_WRITE)
1408 atomic_set(&bh->b_count, 0);
1410 tape->b_data = bh->b_data;
1411 tape->b_count = atomic_read(&bh->b_count);
1415 static ide_startstop_t idetape_read_position_callback(ide_drive_t *drive)
1417 idetape_tape_t *tape = drive->driver_data;
1418 u8 *readpos = tape->pc->buf;
1420 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1422 if (!tape->pc->error) {
1423 debug_log(DBG_SENSE, "BOP - %s\n",
1424 (readpos[0] & 0x80) ? "Yes" : "No");
1425 debug_log(DBG_SENSE, "EOP - %s\n",
1426 (readpos[0] & 0x40) ? "Yes" : "No");
1428 if (readpos[0] & 0x4) {
1429 printk(KERN_INFO "ide-tape: Block location is unknown"
1431 clear_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags);
1432 idetape_end_request(drive, 0, 0);
1434 debug_log(DBG_SENSE, "Block Location - %u\n",
1435 be32_to_cpu(*(u32 *)&readpos[4]));
1437 tape->partition = readpos[1];
1439 be32_to_cpu(*(u32 *)&readpos[4]);
1440 set_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags);
1441 idetape_end_request(drive, 1, 0);
1444 idetape_end_request(drive, 0, 0);
1450 * Write a filemark if write_filemark=1. Flush the device buffers without
1451 * writing a filemark otherwise.
1453 static void idetape_create_write_filemark_cmd(ide_drive_t *drive,
1454 struct ide_atapi_pc *pc, int write_filemark)
1456 idetape_init_pc(pc);
1457 pc->c[0] = WRITE_FILEMARKS;
1458 pc->c[4] = write_filemark;
1459 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1460 pc->idetape_callback = &idetape_pc_callback;
1463 static void idetape_create_test_unit_ready_cmd(struct ide_atapi_pc *pc)
1465 idetape_init_pc(pc);
1466 pc->c[0] = TEST_UNIT_READY;
1467 pc->idetape_callback = &idetape_pc_callback;
1471 * We add a special packet command request to the tail of the request queue, and
1472 * wait for it to be serviced. This is not to be called from within the request
1473 * handling part of the driver! We allocate here data on the stack and it is
1474 * valid until the request is finished. This is not the case for the bottom part
1475 * of the driver, where we are always leaving the functions to wait for an
1476 * interrupt or a timer event.
1478 * From the bottom part of the driver, we should allocate safe memory using
1479 * idetape_next_pc_storage() and ide_tape_next_rq_storage(), and add the request
1480 * to the request list without waiting for it to be serviced! In that case, we
1481 * usually use idetape_queue_pc_head().
1483 static int idetape_queue_pc_tail(ide_drive_t *drive, struct ide_atapi_pc *pc)
1485 struct ide_tape_obj *tape = drive->driver_data;
1489 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
1490 rq->cmd_type = REQ_TYPE_SPECIAL;
1491 rq->cmd[0] = REQ_IDETAPE_PC1;
1492 rq->buffer = (char *)pc;
1493 error = blk_execute_rq(drive->queue, tape->disk, rq, 0);
1494 blk_put_request(rq);
1498 static void idetape_create_load_unload_cmd(ide_drive_t *drive,
1499 struct ide_atapi_pc *pc, int cmd)
1501 idetape_init_pc(pc);
1502 pc->c[0] = START_STOP;
1504 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1505 pc->idetape_callback = &idetape_pc_callback;
1508 static int idetape_wait_ready(ide_drive_t *drive, unsigned long timeout)
1510 idetape_tape_t *tape = drive->driver_data;
1511 struct ide_atapi_pc pc;
1512 int load_attempted = 0;
1514 /* Wait for the tape to become ready */
1515 set_bit(IDETAPE_FLAG_MEDIUM_PRESENT, &tape->flags);
1517 while (time_before(jiffies, timeout)) {
1518 idetape_create_test_unit_ready_cmd(&pc);
1519 if (!idetape_queue_pc_tail(drive, &pc))
1521 if ((tape->sense_key == 2 && tape->asc == 4 && tape->ascq == 2)
1522 || (tape->asc == 0x3A)) {
1526 idetape_create_load_unload_cmd(drive, &pc,
1527 IDETAPE_LU_LOAD_MASK);
1528 idetape_queue_pc_tail(drive, &pc);
1530 /* not about to be ready */
1531 } else if (!(tape->sense_key == 2 && tape->asc == 4 &&
1532 (tape->ascq == 1 || tape->ascq == 8)))
1539 static int idetape_flush_tape_buffers(ide_drive_t *drive)
1541 struct ide_atapi_pc pc;
1544 idetape_create_write_filemark_cmd(drive, &pc, 0);
1545 rc = idetape_queue_pc_tail(drive, &pc);
1548 idetape_wait_ready(drive, 60 * 5 * HZ);
1552 static void idetape_create_read_position_cmd(struct ide_atapi_pc *pc)
1554 idetape_init_pc(pc);
1555 pc->c[0] = READ_POSITION;
1557 pc->idetape_callback = &idetape_read_position_callback;
1560 static int idetape_read_position(ide_drive_t *drive)
1562 idetape_tape_t *tape = drive->driver_data;
1563 struct ide_atapi_pc pc;
1566 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1568 idetape_create_read_position_cmd(&pc);
1569 if (idetape_queue_pc_tail(drive, &pc))
1571 position = tape->first_frame;
1575 static void idetape_create_locate_cmd(ide_drive_t *drive,
1576 struct ide_atapi_pc *pc,
1577 unsigned int block, u8 partition, int skip)
1579 idetape_init_pc(pc);
1580 pc->c[0] = POSITION_TO_ELEMENT;
1582 put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[3]);
1583 pc->c[8] = partition;
1584 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1585 pc->idetape_callback = &idetape_pc_callback;
1588 static int idetape_create_prevent_cmd(ide_drive_t *drive,
1589 struct ide_atapi_pc *pc, int prevent)
1591 idetape_tape_t *tape = drive->driver_data;
1593 /* device supports locking according to capabilities page */
1594 if (!(tape->caps[6] & 0x01))
1597 idetape_init_pc(pc);
1598 pc->c[0] = ALLOW_MEDIUM_REMOVAL;
1600 pc->idetape_callback = &idetape_pc_callback;
1604 static void __ide_tape_discard_merge_buffer(ide_drive_t *drive)
1606 idetape_tape_t *tape = drive->driver_data;
1608 if (tape->chrdev_dir != IDETAPE_DIR_READ)
1611 clear_bit(IDETAPE_FLAG_FILEMARK, &tape->flags);
1612 tape->merge_bh_size = 0;
1613 if (tape->merge_bh != NULL) {
1614 ide_tape_kfree_buffer(tape);
1615 tape->merge_bh = NULL;
1618 tape->chrdev_dir = IDETAPE_DIR_NONE;
1622 * Position the tape to the requested block using the LOCATE packet command.
1623 * A READ POSITION command is then issued to check where we are positioned. Like
1624 * all higher level operations, we queue the commands at the tail of the request
1625 * queue and wait for their completion.
1627 static int idetape_position_tape(ide_drive_t *drive, unsigned int block,
1628 u8 partition, int skip)
1630 idetape_tape_t *tape = drive->driver_data;
1632 struct ide_atapi_pc pc;
1634 if (tape->chrdev_dir == IDETAPE_DIR_READ)
1635 __ide_tape_discard_merge_buffer(drive);
1636 idetape_wait_ready(drive, 60 * 5 * HZ);
1637 idetape_create_locate_cmd(drive, &pc, block, partition, skip);
1638 retval = idetape_queue_pc_tail(drive, &pc);
1642 idetape_create_read_position_cmd(&pc);
1643 return (idetape_queue_pc_tail(drive, &pc));
1646 static void ide_tape_discard_merge_buffer(ide_drive_t *drive,
1647 int restore_position)
1649 idetape_tape_t *tape = drive->driver_data;
1652 __ide_tape_discard_merge_buffer(drive);
1653 if (restore_position) {
1654 position = idetape_read_position(drive);
1655 seek = position > 0 ? position : 0;
1656 if (idetape_position_tape(drive, seek, 0, 0)) {
1657 printk(KERN_INFO "ide-tape: %s: position_tape failed in"
1658 " %s\n", tape->name, __func__);
1665 * Generate a read/write request for the block device interface and wait for it
1668 static int idetape_queue_rw_tail(ide_drive_t *drive, int cmd, int blocks,
1669 struct idetape_bh *bh)
1671 idetape_tape_t *tape = drive->driver_data;
1675 debug_log(DBG_SENSE, "%s: cmd=%d\n", __func__, cmd);
1677 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
1678 rq->cmd_type = REQ_TYPE_SPECIAL;
1680 rq->rq_disk = tape->disk;
1681 rq->special = (void *)bh;
1682 rq->sector = tape->first_frame;
1683 rq->nr_sectors = blocks;
1684 rq->current_nr_sectors = blocks;
1685 blk_execute_rq(drive->queue, tape->disk, rq, 0);
1687 errors = rq->errors;
1688 ret = tape->blk_size * (blocks - rq->current_nr_sectors);
1689 blk_put_request(rq);
1691 if ((cmd & (REQ_IDETAPE_READ | REQ_IDETAPE_WRITE)) == 0)
1695 idetape_init_merge_buffer(tape);
1696 if (errors == IDETAPE_ERROR_GENERAL)
1701 static void idetape_create_inquiry_cmd(struct ide_atapi_pc *pc)
1703 idetape_init_pc(pc);
1707 pc->idetape_callback = &idetape_pc_callback;
1710 static void idetape_create_rewind_cmd(ide_drive_t *drive,
1711 struct ide_atapi_pc *pc)
1713 idetape_init_pc(pc);
1714 pc->c[0] = REZERO_UNIT;
1715 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1716 pc->idetape_callback = &idetape_pc_callback;
1719 static void idetape_create_erase_cmd(struct ide_atapi_pc *pc)
1721 idetape_init_pc(pc);
1724 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1725 pc->idetape_callback = &idetape_pc_callback;
1728 static void idetape_create_space_cmd(struct ide_atapi_pc *pc, int count, u8 cmd)
1730 idetape_init_pc(pc);
1732 put_unaligned(cpu_to_be32(count), (unsigned int *) &pc->c[1]);
1734 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1735 pc->idetape_callback = &idetape_pc_callback;
1738 /* Queue up a character device originated write request. */
1739 static int idetape_add_chrdev_write_request(ide_drive_t *drive, int blocks)
1741 idetape_tape_t *tape = drive->driver_data;
1743 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
1745 return idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE,
1746 blocks, tape->merge_bh);
1749 static void ide_tape_flush_merge_buffer(ide_drive_t *drive)
1751 idetape_tape_t *tape = drive->driver_data;
1753 struct idetape_bh *bh;
1755 if (tape->chrdev_dir != IDETAPE_DIR_WRITE) {
1756 printk(KERN_ERR "ide-tape: bug: Trying to empty merge buffer"
1757 " but we are not writing.\n");
1760 if (tape->merge_bh_size > tape->buffer_size) {
1761 printk(KERN_ERR "ide-tape: bug: merge_buffer too big\n");
1762 tape->merge_bh_size = tape->buffer_size;
1764 if (tape->merge_bh_size) {
1765 blocks = tape->merge_bh_size / tape->blk_size;
1766 if (tape->merge_bh_size % tape->blk_size) {
1770 i = tape->blk_size - tape->merge_bh_size %
1772 bh = tape->bh->b_reqnext;
1774 atomic_set(&bh->b_count, 0);
1780 printk(KERN_INFO "ide-tape: bug,"
1784 min = min(i, (unsigned int)(bh->b_size -
1785 atomic_read(&bh->b_count)));
1786 memset(bh->b_data + atomic_read(&bh->b_count),
1788 atomic_add(min, &bh->b_count);
1793 (void) idetape_add_chrdev_write_request(drive, blocks);
1794 tape->merge_bh_size = 0;
1796 if (tape->merge_bh != NULL) {
1797 ide_tape_kfree_buffer(tape);
1798 tape->merge_bh = NULL;
1800 tape->chrdev_dir = IDETAPE_DIR_NONE;
1803 static int idetape_init_read(ide_drive_t *drive)
1805 idetape_tape_t *tape = drive->driver_data;
1808 /* Initialize read operation */
1809 if (tape->chrdev_dir != IDETAPE_DIR_READ) {
1810 if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
1811 ide_tape_flush_merge_buffer(drive);
1812 idetape_flush_tape_buffers(drive);
1814 if (tape->merge_bh || tape->merge_bh_size) {
1815 printk(KERN_ERR "ide-tape: merge_bh_size should be"
1817 tape->merge_bh_size = 0;
1819 tape->merge_bh = ide_tape_kmalloc_buffer(tape, 0, 0);
1820 if (!tape->merge_bh)
1822 tape->chrdev_dir = IDETAPE_DIR_READ;
1825 * Issue a read 0 command to ensure that DSC handshake is
1826 * switched from completion mode to buffer available mode.
1827 * No point in issuing this if DSC overlap isn't supported, some
1828 * drives (Seagate STT3401A) will return an error.
1830 if (drive->dsc_overlap) {
1831 bytes_read = idetape_queue_rw_tail(drive,
1832 REQ_IDETAPE_READ, 0,
1834 if (bytes_read < 0) {
1835 ide_tape_kfree_buffer(tape);
1836 tape->merge_bh = NULL;
1837 tape->chrdev_dir = IDETAPE_DIR_NONE;
1846 /* called from idetape_chrdev_read() to service a chrdev read request. */
1847 static int idetape_add_chrdev_read_request(ide_drive_t *drive, int blocks)
1849 idetape_tape_t *tape = drive->driver_data;
1851 debug_log(DBG_PROCS, "Enter %s, %d blocks\n", __func__, blocks);
1853 /* If we are at a filemark, return a read length of 0 */
1854 if (test_bit(IDETAPE_FLAG_FILEMARK, &tape->flags))
1857 idetape_init_read(drive);
1859 return idetape_queue_rw_tail(drive, REQ_IDETAPE_READ, blocks,
1863 static void idetape_pad_zeros(ide_drive_t *drive, int bcount)
1865 idetape_tape_t *tape = drive->driver_data;
1866 struct idetape_bh *bh;
1872 bh = tape->merge_bh;
1873 count = min(tape->buffer_size, bcount);
1875 blocks = count / tape->blk_size;
1877 atomic_set(&bh->b_count,
1878 min(count, (unsigned int)bh->b_size));
1879 memset(bh->b_data, 0, atomic_read(&bh->b_count));
1880 count -= atomic_read(&bh->b_count);
1883 idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE, blocks,
1889 * Rewinds the tape to the Beginning Of the current Partition (BOP). We
1890 * currently support only one partition.
1892 static int idetape_rewind_tape(ide_drive_t *drive)
1895 struct ide_atapi_pc pc;
1896 idetape_tape_t *tape;
1897 tape = drive->driver_data;
1899 debug_log(DBG_SENSE, "Enter %s\n", __func__);
1901 idetape_create_rewind_cmd(drive, &pc);
1902 retval = idetape_queue_pc_tail(drive, &pc);
1906 idetape_create_read_position_cmd(&pc);
1907 retval = idetape_queue_pc_tail(drive, &pc);
1913 /* mtio.h compatible commands should be issued to the chrdev interface. */
1914 static int idetape_blkdev_ioctl(ide_drive_t *drive, unsigned int cmd,
1917 idetape_tape_t *tape = drive->driver_data;
1918 void __user *argp = (void __user *)arg;
1920 struct idetape_config {
1921 int dsc_rw_frequency;
1922 int dsc_media_access_frequency;
1926 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1930 if (copy_from_user(&config, argp, sizeof(config)))
1932 tape->best_dsc_rw_freq = config.dsc_rw_frequency;
1935 config.dsc_rw_frequency = (int) tape->best_dsc_rw_freq;
1936 config.nr_stages = 1;
1937 if (copy_to_user(argp, &config, sizeof(config)))
1946 static int idetape_space_over_filemarks(ide_drive_t *drive, short mt_op,
1949 idetape_tape_t *tape = drive->driver_data;
1950 struct ide_atapi_pc pc;
1951 int retval, count = 0;
1952 int sprev = !!(tape->caps[4] & 0x20);
1956 if (MTBSF == mt_op || MTBSFM == mt_op) {
1959 mt_count = -mt_count;
1962 if (tape->chrdev_dir == IDETAPE_DIR_READ) {
1963 tape->merge_bh_size = 0;
1964 if (test_and_clear_bit(IDETAPE_FLAG_FILEMARK, &tape->flags))
1966 ide_tape_discard_merge_buffer(drive, 0);
1972 idetape_create_space_cmd(&pc, mt_count - count,
1973 IDETAPE_SPACE_OVER_FILEMARK);
1974 return idetape_queue_pc_tail(drive, &pc);
1979 retval = idetape_space_over_filemarks(drive, MTFSF,
1983 count = (MTBSFM == mt_op ? 1 : -1);
1984 return idetape_space_over_filemarks(drive, MTFSF, count);
1986 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
1993 * Our character device read / write functions.
1995 * The tape is optimized to maximize throughput when it is transferring an
1996 * integral number of the "continuous transfer limit", which is a parameter of
1997 * the specific tape (26kB on my particular tape, 32kB for Onstream).
1999 * As of version 1.3 of the driver, the character device provides an abstract
2000 * continuous view of the media - any mix of block sizes (even 1 byte) on the
2001 * same backup/restore procedure is supported. The driver will internally
2002 * convert the requests to the recommended transfer unit, so that an unmatch
2003 * between the user's block size to the recommended size will only result in a
2004 * (slightly) increased driver overhead, but will no longer hit performance.
2005 * This is not applicable to Onstream.
2007 static ssize_t idetape_chrdev_read(struct file *file, char __user *buf,
2008 size_t count, loff_t *ppos)
2010 struct ide_tape_obj *tape = ide_tape_f(file);
2011 ide_drive_t *drive = tape->drive;
2012 ssize_t bytes_read, temp, actually_read = 0, rc;
2014 u16 ctl = *(u16 *)&tape->caps[12];
2016 debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
2018 if (tape->chrdev_dir != IDETAPE_DIR_READ) {
2019 if (test_bit(IDETAPE_FLAG_DETECT_BS, &tape->flags))
2020 if (count > tape->blk_size &&
2021 (count % tape->blk_size) == 0)
2022 tape->user_bs_factor = count / tape->blk_size;
2024 rc = idetape_init_read(drive);
2029 if (tape->merge_bh_size) {
2030 actually_read = min((unsigned int)(tape->merge_bh_size),
2031 (unsigned int)count);
2032 if (idetape_copy_stage_to_user(tape, buf, actually_read))
2034 buf += actually_read;
2035 tape->merge_bh_size -= actually_read;
2036 count -= actually_read;
2038 while (count >= tape->buffer_size) {
2039 bytes_read = idetape_add_chrdev_read_request(drive, ctl);
2040 if (bytes_read <= 0)
2042 if (idetape_copy_stage_to_user(tape, buf, bytes_read))
2045 count -= bytes_read;
2046 actually_read += bytes_read;
2049 bytes_read = idetape_add_chrdev_read_request(drive, ctl);
2050 if (bytes_read <= 0)
2052 temp = min((unsigned long)count, (unsigned long)bytes_read);
2053 if (idetape_copy_stage_to_user(tape, buf, temp))
2055 actually_read += temp;
2056 tape->merge_bh_size = bytes_read-temp;
2059 if (!actually_read && test_bit(IDETAPE_FLAG_FILEMARK, &tape->flags)) {
2060 debug_log(DBG_SENSE, "%s: spacing over filemark\n", tape->name);
2062 idetape_space_over_filemarks(drive, MTFSF, 1);
2066 return ret ? ret : actually_read;
2069 static ssize_t idetape_chrdev_write(struct file *file, const char __user *buf,
2070 size_t count, loff_t *ppos)
2072 struct ide_tape_obj *tape = ide_tape_f(file);
2073 ide_drive_t *drive = tape->drive;
2074 ssize_t actually_written = 0;
2076 u16 ctl = *(u16 *)&tape->caps[12];
2078 /* The drive is write protected. */
2079 if (tape->write_prot)
2082 debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
2084 /* Initialize write operation */
2085 if (tape->chrdev_dir != IDETAPE_DIR_WRITE) {
2086 if (tape->chrdev_dir == IDETAPE_DIR_READ)
2087 ide_tape_discard_merge_buffer(drive, 1);
2088 if (tape->merge_bh || tape->merge_bh_size) {
2089 printk(KERN_ERR "ide-tape: merge_bh_size "
2090 "should be 0 now\n");
2091 tape->merge_bh_size = 0;
2093 tape->merge_bh = ide_tape_kmalloc_buffer(tape, 0, 0);
2094 if (!tape->merge_bh)
2096 tape->chrdev_dir = IDETAPE_DIR_WRITE;
2097 idetape_init_merge_buffer(tape);
2100 * Issue a write 0 command to ensure that DSC handshake is
2101 * switched from completion mode to buffer available mode. No
2102 * point in issuing this if DSC overlap isn't supported, some
2103 * drives (Seagate STT3401A) will return an error.
2105 if (drive->dsc_overlap) {
2106 ssize_t retval = idetape_queue_rw_tail(drive,
2107 REQ_IDETAPE_WRITE, 0,
2110 ide_tape_kfree_buffer(tape);
2111 tape->merge_bh = NULL;
2112 tape->chrdev_dir = IDETAPE_DIR_NONE;
2119 if (tape->merge_bh_size) {
2120 if (tape->merge_bh_size >= tape->buffer_size) {
2121 printk(KERN_ERR "ide-tape: bug: merge buf too big\n");
2122 tape->merge_bh_size = 0;
2124 actually_written = min((unsigned int)
2125 (tape->buffer_size - tape->merge_bh_size),
2126 (unsigned int)count);
2127 if (idetape_copy_stage_from_user(tape, buf, actually_written))
2129 buf += actually_written;
2130 tape->merge_bh_size += actually_written;
2131 count -= actually_written;
2133 if (tape->merge_bh_size == tape->buffer_size) {
2135 tape->merge_bh_size = 0;
2136 retval = idetape_add_chrdev_write_request(drive, ctl);
2141 while (count >= tape->buffer_size) {
2143 if (idetape_copy_stage_from_user(tape, buf, tape->buffer_size))
2145 buf += tape->buffer_size;
2146 count -= tape->buffer_size;
2147 retval = idetape_add_chrdev_write_request(drive, ctl);
2148 actually_written += tape->buffer_size;
2153 actually_written += count;
2154 if (idetape_copy_stage_from_user(tape, buf, count))
2156 tape->merge_bh_size += count;
2158 return ret ? ret : actually_written;
2161 static int idetape_write_filemark(ide_drive_t *drive)
2163 struct ide_atapi_pc pc;
2165 /* Write a filemark */
2166 idetape_create_write_filemark_cmd(drive, &pc, 1);
2167 if (idetape_queue_pc_tail(drive, &pc)) {
2168 printk(KERN_ERR "ide-tape: Couldn't write a filemark\n");
2175 * Called from idetape_chrdev_ioctl when the general mtio MTIOCTOP ioctl is
2178 * Note: MTBSF and MTBSFM are not supported when the tape doesn't support
2179 * spacing over filemarks in the reverse direction. In this case, MTFSFM is also
2180 * usually not supported.
2182 * The following commands are currently not supported:
2184 * MTFSS, MTBSS, MTWSM, MTSETDENSITY, MTSETDRVBUFFER, MT_ST_BOOLEANS,
2185 * MT_ST_WRITE_THRESHOLD.
2187 static int idetape_mtioctop(ide_drive_t *drive, short mt_op, int mt_count)
2189 idetape_tape_t *tape = drive->driver_data;
2190 struct ide_atapi_pc pc;
2193 debug_log(DBG_ERR, "Handling MTIOCTOP ioctl: mt_op=%d, mt_count=%d\n",
2203 return idetape_space_over_filemarks(drive, mt_op, mt_count);
2210 if (tape->write_prot)
2212 ide_tape_discard_merge_buffer(drive, 1);
2213 for (i = 0; i < mt_count; i++) {
2214 retval = idetape_write_filemark(drive);
2220 ide_tape_discard_merge_buffer(drive, 0);
2221 if (idetape_rewind_tape(drive))
2225 ide_tape_discard_merge_buffer(drive, 0);
2226 idetape_create_load_unload_cmd(drive, &pc,
2227 IDETAPE_LU_LOAD_MASK);
2228 return idetape_queue_pc_tail(drive, &pc);
2232 * If door is locked, attempt to unlock before
2233 * attempting to eject.
2235 if (tape->door_locked) {
2236 if (idetape_create_prevent_cmd(drive, &pc, 0))
2237 if (!idetape_queue_pc_tail(drive, &pc))
2238 tape->door_locked = DOOR_UNLOCKED;
2240 ide_tape_discard_merge_buffer(drive, 0);
2241 idetape_create_load_unload_cmd(drive, &pc,
2242 !IDETAPE_LU_LOAD_MASK);
2243 retval = idetape_queue_pc_tail(drive, &pc);
2245 clear_bit(IDETAPE_FLAG_MEDIUM_PRESENT, &tape->flags);
2248 ide_tape_discard_merge_buffer(drive, 0);
2249 return idetape_flush_tape_buffers(drive);
2251 ide_tape_discard_merge_buffer(drive, 0);
2252 idetape_create_load_unload_cmd(drive, &pc,
2253 IDETAPE_LU_RETENSION_MASK | IDETAPE_LU_LOAD_MASK);
2254 return idetape_queue_pc_tail(drive, &pc);
2256 idetape_create_space_cmd(&pc, 0, IDETAPE_SPACE_TO_EOD);
2257 return idetape_queue_pc_tail(drive, &pc);
2259 (void)idetape_rewind_tape(drive);
2260 idetape_create_erase_cmd(&pc);
2261 return idetape_queue_pc_tail(drive, &pc);
2264 if (mt_count < tape->blk_size ||
2265 mt_count % tape->blk_size)
2267 tape->user_bs_factor = mt_count / tape->blk_size;
2268 clear_bit(IDETAPE_FLAG_DETECT_BS, &tape->flags);
2270 set_bit(IDETAPE_FLAG_DETECT_BS, &tape->flags);
2273 ide_tape_discard_merge_buffer(drive, 0);
2274 return idetape_position_tape(drive,
2275 mt_count * tape->user_bs_factor, tape->partition, 0);
2277 ide_tape_discard_merge_buffer(drive, 0);
2278 return idetape_position_tape(drive, 0, mt_count, 0);
2282 if (!idetape_create_prevent_cmd(drive, &pc, 1))
2284 retval = idetape_queue_pc_tail(drive, &pc);
2287 tape->door_locked = DOOR_EXPLICITLY_LOCKED;
2290 if (!idetape_create_prevent_cmd(drive, &pc, 0))
2292 retval = idetape_queue_pc_tail(drive, &pc);
2295 tape->door_locked = DOOR_UNLOCKED;
2298 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
2305 * Our character device ioctls. General mtio.h magnetic io commands are
2306 * supported here, and not in the corresponding block interface. Our own
2307 * ide-tape ioctls are supported on both interfaces.
2309 static int idetape_chrdev_ioctl(struct inode *inode, struct file *file,
2310 unsigned int cmd, unsigned long arg)
2312 struct ide_tape_obj *tape = ide_tape_f(file);
2313 ide_drive_t *drive = tape->drive;
2317 int block_offset = 0, position = tape->first_frame;
2318 void __user *argp = (void __user *)arg;
2320 debug_log(DBG_CHRDEV, "Enter %s, cmd=%u\n", __func__, cmd);
2322 if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
2323 ide_tape_flush_merge_buffer(drive);
2324 idetape_flush_tape_buffers(drive);
2326 if (cmd == MTIOCGET || cmd == MTIOCPOS) {
2327 block_offset = tape->merge_bh_size /
2328 (tape->blk_size * tape->user_bs_factor);
2329 position = idetape_read_position(drive);
2335 if (copy_from_user(&mtop, argp, sizeof(struct mtop)))
2337 return idetape_mtioctop(drive, mtop.mt_op, mtop.mt_count);
2339 memset(&mtget, 0, sizeof(struct mtget));
2340 mtget.mt_type = MT_ISSCSI2;
2341 mtget.mt_blkno = position / tape->user_bs_factor - block_offset;
2343 ((tape->blk_size * tape->user_bs_factor)
2344 << MT_ST_BLKSIZE_SHIFT) & MT_ST_BLKSIZE_MASK;
2346 if (tape->drv_write_prot)
2347 mtget.mt_gstat |= GMT_WR_PROT(0xffffffff);
2349 if (copy_to_user(argp, &mtget, sizeof(struct mtget)))
2353 mtpos.mt_blkno = position / tape->user_bs_factor - block_offset;
2354 if (copy_to_user(argp, &mtpos, sizeof(struct mtpos)))
2358 if (tape->chrdev_dir == IDETAPE_DIR_READ)
2359 ide_tape_discard_merge_buffer(drive, 1);
2360 return idetape_blkdev_ioctl(drive, cmd, arg);
2365 * Do a mode sense page 0 with block descriptor and if it succeeds set the tape
2366 * block size with the reported value.
2368 static void ide_tape_get_bsize_from_bdesc(ide_drive_t *drive)
2370 idetape_tape_t *tape = drive->driver_data;
2371 struct ide_atapi_pc pc;
2373 idetape_create_mode_sense_cmd(&pc, IDETAPE_BLOCK_DESCRIPTOR);
2374 if (idetape_queue_pc_tail(drive, &pc)) {
2375 printk(KERN_ERR "ide-tape: Can't get block descriptor\n");
2376 if (tape->blk_size == 0) {
2377 printk(KERN_WARNING "ide-tape: Cannot deal with zero "
2378 "block size, assuming 32k\n");
2379 tape->blk_size = 32768;
2383 tape->blk_size = (pc.buf[4 + 5] << 16) +
2384 (pc.buf[4 + 6] << 8) +
2386 tape->drv_write_prot = (pc.buf[2] & 0x80) >> 7;
2389 static int idetape_chrdev_open(struct inode *inode, struct file *filp)
2391 unsigned int minor = iminor(inode), i = minor & ~0xc0;
2393 idetape_tape_t *tape;
2394 struct ide_atapi_pc pc;
2397 if (i >= MAX_HWIFS * MAX_DRIVES)
2400 tape = ide_tape_chrdev_get(i);
2404 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
2407 * We really want to do nonseekable_open(inode, filp); here, but some
2408 * versions of tar incorrectly call lseek on tapes and bail out if that
2409 * fails. So we disallow pread() and pwrite(), but permit lseeks.
2411 filp->f_mode &= ~(FMODE_PREAD | FMODE_PWRITE);
2413 drive = tape->drive;
2415 filp->private_data = tape;
2417 if (test_and_set_bit(IDETAPE_FLAG_BUSY, &tape->flags)) {
2422 retval = idetape_wait_ready(drive, 60 * HZ);
2424 clear_bit(IDETAPE_FLAG_BUSY, &tape->flags);
2425 printk(KERN_ERR "ide-tape: %s: drive not ready\n", tape->name);
2429 idetape_read_position(drive);
2430 if (!test_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags))
2431 (void)idetape_rewind_tape(drive);
2433 /* Read block size and write protect status from drive. */
2434 ide_tape_get_bsize_from_bdesc(drive);
2436 /* Set write protect flag if device is opened as read-only. */
2437 if ((filp->f_flags & O_ACCMODE) == O_RDONLY)
2438 tape->write_prot = 1;
2440 tape->write_prot = tape->drv_write_prot;
2442 /* Make sure drive isn't write protected if user wants to write. */
2443 if (tape->write_prot) {
2444 if ((filp->f_flags & O_ACCMODE) == O_WRONLY ||
2445 (filp->f_flags & O_ACCMODE) == O_RDWR) {
2446 clear_bit(IDETAPE_FLAG_BUSY, &tape->flags);
2452 /* Lock the tape drive door so user can't eject. */
2453 if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
2454 if (idetape_create_prevent_cmd(drive, &pc, 1)) {
2455 if (!idetape_queue_pc_tail(drive, &pc)) {
2456 if (tape->door_locked != DOOR_EXPLICITLY_LOCKED)
2457 tape->door_locked = DOOR_LOCKED;
2468 static void idetape_write_release(ide_drive_t *drive, unsigned int minor)
2470 idetape_tape_t *tape = drive->driver_data;
2472 ide_tape_flush_merge_buffer(drive);
2473 tape->merge_bh = ide_tape_kmalloc_buffer(tape, 1, 0);
2474 if (tape->merge_bh != NULL) {
2475 idetape_pad_zeros(drive, tape->blk_size *
2476 (tape->user_bs_factor - 1));
2477 ide_tape_kfree_buffer(tape);
2478 tape->merge_bh = NULL;
2480 idetape_write_filemark(drive);
2481 idetape_flush_tape_buffers(drive);
2482 idetape_flush_tape_buffers(drive);
2485 static int idetape_chrdev_release(struct inode *inode, struct file *filp)
2487 struct ide_tape_obj *tape = ide_tape_f(filp);
2488 ide_drive_t *drive = tape->drive;
2489 struct ide_atapi_pc pc;
2490 unsigned int minor = iminor(inode);
2493 tape = drive->driver_data;
2495 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
2497 if (tape->chrdev_dir == IDETAPE_DIR_WRITE)
2498 idetape_write_release(drive, minor);
2499 if (tape->chrdev_dir == IDETAPE_DIR_READ) {
2501 ide_tape_discard_merge_buffer(drive, 1);
2504 if (minor < 128 && test_bit(IDETAPE_FLAG_MEDIUM_PRESENT, &tape->flags))
2505 (void) idetape_rewind_tape(drive);
2506 if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
2507 if (tape->door_locked == DOOR_LOCKED) {
2508 if (idetape_create_prevent_cmd(drive, &pc, 0)) {
2509 if (!idetape_queue_pc_tail(drive, &pc))
2510 tape->door_locked = DOOR_UNLOCKED;
2514 clear_bit(IDETAPE_FLAG_BUSY, &tape->flags);
2521 * check the contents of the ATAPI IDENTIFY command results. We return:
2523 * 1 - If the tape can be supported by us, based on the information we have so
2526 * 0 - If this tape driver is not currently supported by us.
2528 static int idetape_identify_device(ide_drive_t *drive)
2530 u8 gcw[2], protocol, device_type, removable, packet_size;
2532 if (drive->id_read == 0)
2535 *((unsigned short *) &gcw) = drive->id->config;
2537 protocol = (gcw[1] & 0xC0) >> 6;
2538 device_type = gcw[1] & 0x1F;
2539 removable = !!(gcw[0] & 0x80);
2540 packet_size = gcw[0] & 0x3;
2542 /* Check that we can support this device */
2544 printk(KERN_ERR "ide-tape: Protocol (0x%02x) is not ATAPI\n",
2546 else if (device_type != 1)
2547 printk(KERN_ERR "ide-tape: Device type (0x%02x) is not set "
2548 "to tape\n", device_type);
2549 else if (!removable)
2550 printk(KERN_ERR "ide-tape: The removable flag is not set\n");
2551 else if (packet_size != 0) {
2552 printk(KERN_ERR "ide-tape: Packet size (0x%02x) is not 12"
2553 " bytes\n", packet_size);
2559 static void idetape_get_inquiry_results(ide_drive_t *drive)
2561 idetape_tape_t *tape = drive->driver_data;
2562 struct ide_atapi_pc pc;
2563 char fw_rev[6], vendor_id[10], product_id[18];
2565 idetape_create_inquiry_cmd(&pc);
2566 if (idetape_queue_pc_tail(drive, &pc)) {
2567 printk(KERN_ERR "ide-tape: %s: can't get INQUIRY results\n",
2571 memcpy(vendor_id, &pc.buf[8], 8);
2572 memcpy(product_id, &pc.buf[16], 16);
2573 memcpy(fw_rev, &pc.buf[32], 4);
2575 ide_fixstring(vendor_id, 10, 0);
2576 ide_fixstring(product_id, 18, 0);
2577 ide_fixstring(fw_rev, 6, 0);
2579 printk(KERN_INFO "ide-tape: %s <-> %s: %s %s rev %s\n",
2580 drive->name, tape->name, vendor_id, product_id, fw_rev);
2584 * Ask the tape about its various parameters. In particular, we will adjust our
2585 * data transfer buffer size to the recommended value as returned by the tape.
2587 static void idetape_get_mode_sense_results(ide_drive_t *drive)
2589 idetape_tape_t *tape = drive->driver_data;
2590 struct ide_atapi_pc pc;
2592 u8 speed, max_speed;
2594 idetape_create_mode_sense_cmd(&pc, IDETAPE_CAPABILITIES_PAGE);
2595 if (idetape_queue_pc_tail(drive, &pc)) {
2596 printk(KERN_ERR "ide-tape: Can't get tape parameters - assuming"
2597 " some default values\n");
2598 tape->blk_size = 512;
2599 put_unaligned(52, (u16 *)&tape->caps[12]);
2600 put_unaligned(540, (u16 *)&tape->caps[14]);
2601 put_unaligned(6*52, (u16 *)&tape->caps[16]);
2604 caps = pc.buf + 4 + pc.buf[3];
2606 /* convert to host order and save for later use */
2607 speed = be16_to_cpu(*(u16 *)&caps[14]);
2608 max_speed = be16_to_cpu(*(u16 *)&caps[8]);
2610 put_unaligned(max_speed, (u16 *)&caps[8]);
2611 put_unaligned(be16_to_cpu(*(u16 *)&caps[12]), (u16 *)&caps[12]);
2612 put_unaligned(speed, (u16 *)&caps[14]);
2613 put_unaligned(be16_to_cpu(*(u16 *)&caps[16]), (u16 *)&caps[16]);
2616 printk(KERN_INFO "ide-tape: %s: invalid tape speed "
2617 "(assuming 650KB/sec)\n", drive->name);
2618 put_unaligned(650, (u16 *)&caps[14]);
2621 printk(KERN_INFO "ide-tape: %s: invalid max_speed "
2622 "(assuming 650KB/sec)\n", drive->name);
2623 put_unaligned(650, (u16 *)&caps[8]);
2626 memcpy(&tape->caps, caps, 20);
2628 tape->blk_size = 512;
2629 else if (caps[7] & 0x04)
2630 tape->blk_size = 1024;
2633 #ifdef CONFIG_IDE_PROC_FS
2634 static void idetape_add_settings(ide_drive_t *drive)
2636 idetape_tape_t *tape = drive->driver_data;
2638 ide_add_setting(drive, "buffer", SETTING_READ, TYPE_SHORT, 0, 0xffff,
2639 1, 2, (u16 *)&tape->caps[16], NULL);
2640 ide_add_setting(drive, "speed", SETTING_READ, TYPE_SHORT, 0, 0xffff,
2641 1, 1, (u16 *)&tape->caps[14], NULL);
2642 ide_add_setting(drive, "buffer_size", SETTING_READ, TYPE_INT, 0, 0xffff,
2643 1, 1024, &tape->buffer_size, NULL);
2644 ide_add_setting(drive, "tdsc", SETTING_RW, TYPE_INT, IDETAPE_DSC_RW_MIN,
2645 IDETAPE_DSC_RW_MAX, 1000, HZ, &tape->best_dsc_rw_freq,
2647 ide_add_setting(drive, "dsc_overlap", SETTING_RW, TYPE_BYTE, 0, 1, 1,
2648 1, &drive->dsc_overlap, NULL);
2649 ide_add_setting(drive, "avg_speed", SETTING_READ, TYPE_INT, 0, 0xffff,
2650 1, 1, &tape->avg_speed, NULL);
2651 ide_add_setting(drive, "debug_mask", SETTING_RW, TYPE_INT, 0, 0xffff, 1,
2652 1, &tape->debug_mask, NULL);
2655 static inline void idetape_add_settings(ide_drive_t *drive) { ; }
2659 * The function below is called to:
2661 * 1. Initialize our various state variables.
2662 * 2. Ask the tape for its capabilities.
2663 * 3. Allocate a buffer which will be used for data transfer. The buffer size
2664 * is chosen based on the recommendation which we received in step 2.
2666 * Note that at this point ide.c already assigned us an irq, so that we can
2667 * queue requests here and wait for their completion.
2669 static void idetape_setup(ide_drive_t *drive, idetape_tape_t *tape, int minor)
2675 u16 *ctl = (u16 *)&tape->caps[12];
2677 spin_lock_init(&tape->lock);
2678 drive->dsc_overlap = 1;
2679 if (drive->hwif->host_flags & IDE_HFLAG_NO_DSC) {
2680 printk(KERN_INFO "ide-tape: %s: disabling DSC overlap\n",
2682 drive->dsc_overlap = 0;
2684 /* Seagate Travan drives do not support DSC overlap. */
2685 if (strstr(drive->id->model, "Seagate STT3401"))
2686 drive->dsc_overlap = 0;
2687 tape->minor = minor;
2688 tape->name[0] = 'h';
2689 tape->name[1] = 't';
2690 tape->name[2] = '0' + minor;
2691 tape->chrdev_dir = IDETAPE_DIR_NONE;
2692 tape->pc = tape->pc_stack;
2693 *((unsigned short *) &gcw) = drive->id->config;
2695 /* Command packet DRQ type */
2696 if (((gcw[0] & 0x60) >> 5) == 1)
2697 set_bit(IDETAPE_FLAG_DRQ_INTERRUPT, &tape->flags);
2699 idetape_get_inquiry_results(drive);
2700 idetape_get_mode_sense_results(drive);
2701 ide_tape_get_bsize_from_bdesc(drive);
2702 tape->user_bs_factor = 1;
2703 tape->buffer_size = *ctl * tape->blk_size;
2704 while (tape->buffer_size > 0xffff) {
2705 printk(KERN_NOTICE "ide-tape: decreasing stage size\n");
2707 tape->buffer_size = *ctl * tape->blk_size;
2709 buffer_size = tape->buffer_size;
2710 tape->pages_per_buffer = buffer_size / PAGE_SIZE;
2711 if (buffer_size % PAGE_SIZE) {
2712 tape->pages_per_buffer++;
2713 tape->excess_bh_size = PAGE_SIZE - buffer_size % PAGE_SIZE;
2716 /* select the "best" DSC read/write polling freq */
2717 speed = max(*(u16 *)&tape->caps[14], *(u16 *)&tape->caps[8]);
2719 t = (IDETAPE_FIFO_THRESHOLD * tape->buffer_size * HZ) / (speed * 1000);
2722 * Ensure that the number we got makes sense; limit it within
2723 * IDETAPE_DSC_RW_MIN and IDETAPE_DSC_RW_MAX.
2725 tape->best_dsc_rw_freq = clamp_t(unsigned long, t, IDETAPE_DSC_RW_MIN,
2726 IDETAPE_DSC_RW_MAX);
2727 printk(KERN_INFO "ide-tape: %s <-> %s: %dKBps, %d*%dkB buffer, "
2729 drive->name, tape->name, *(u16 *)&tape->caps[14],
2730 (*(u16 *)&tape->caps[16] * 512) / tape->buffer_size,
2731 tape->buffer_size / 1024,
2732 tape->best_dsc_rw_freq * 1000 / HZ,
2733 drive->using_dma ? ", DMA":"");
2735 idetape_add_settings(drive);
2738 static void ide_tape_remove(ide_drive_t *drive)
2740 idetape_tape_t *tape = drive->driver_data;
2742 ide_proc_unregister_driver(drive, tape->driver);
2744 ide_unregister_region(tape->disk);
2749 static void ide_tape_release(struct kref *kref)
2751 struct ide_tape_obj *tape = to_ide_tape(kref);
2752 ide_drive_t *drive = tape->drive;
2753 struct gendisk *g = tape->disk;
2755 BUG_ON(tape->merge_bh_size);
2757 drive->dsc_overlap = 0;
2758 drive->driver_data = NULL;
2759 device_destroy(idetape_sysfs_class, MKDEV(IDETAPE_MAJOR, tape->minor));
2760 device_destroy(idetape_sysfs_class,
2761 MKDEV(IDETAPE_MAJOR, tape->minor + 128));
2762 idetape_devs[tape->minor] = NULL;
2763 g->private_data = NULL;
2768 #ifdef CONFIG_IDE_PROC_FS
2769 static int proc_idetape_read_name
2770 (char *page, char **start, off_t off, int count, int *eof, void *data)
2772 ide_drive_t *drive = (ide_drive_t *) data;
2773 idetape_tape_t *tape = drive->driver_data;
2777 len = sprintf(out, "%s\n", tape->name);
2778 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
2781 static ide_proc_entry_t idetape_proc[] = {
2782 { "capacity", S_IFREG|S_IRUGO, proc_ide_read_capacity, NULL },
2783 { "name", S_IFREG|S_IRUGO, proc_idetape_read_name, NULL },
2784 { NULL, 0, NULL, NULL }
2788 static int ide_tape_probe(ide_drive_t *);
2790 static ide_driver_t idetape_driver = {
2792 .owner = THIS_MODULE,
2794 .bus = &ide_bus_type,
2796 .probe = ide_tape_probe,
2797 .remove = ide_tape_remove,
2798 .version = IDETAPE_VERSION,
2800 .supports_dsc_overlap = 1,
2801 .do_request = idetape_do_request,
2802 .end_request = idetape_end_request,
2803 .error = __ide_error,
2804 .abort = __ide_abort,
2805 #ifdef CONFIG_IDE_PROC_FS
2806 .proc = idetape_proc,
2810 /* Our character device supporting functions, passed to register_chrdev. */
2811 static const struct file_operations idetape_fops = {
2812 .owner = THIS_MODULE,
2813 .read = idetape_chrdev_read,
2814 .write = idetape_chrdev_write,
2815 .ioctl = idetape_chrdev_ioctl,
2816 .open = idetape_chrdev_open,
2817 .release = idetape_chrdev_release,
2820 static int idetape_open(struct inode *inode, struct file *filp)
2822 struct gendisk *disk = inode->i_bdev->bd_disk;
2823 struct ide_tape_obj *tape;
2825 tape = ide_tape_get(disk);
2832 static int idetape_release(struct inode *inode, struct file *filp)
2834 struct gendisk *disk = inode->i_bdev->bd_disk;
2835 struct ide_tape_obj *tape = ide_tape_g(disk);
2842 static int idetape_ioctl(struct inode *inode, struct file *file,
2843 unsigned int cmd, unsigned long arg)
2845 struct block_device *bdev = inode->i_bdev;
2846 struct ide_tape_obj *tape = ide_tape_g(bdev->bd_disk);
2847 ide_drive_t *drive = tape->drive;
2848 int err = generic_ide_ioctl(drive, file, bdev, cmd, arg);
2850 err = idetape_blkdev_ioctl(drive, cmd, arg);
2854 static struct block_device_operations idetape_block_ops = {
2855 .owner = THIS_MODULE,
2856 .open = idetape_open,
2857 .release = idetape_release,
2858 .ioctl = idetape_ioctl,
2861 static int ide_tape_probe(ide_drive_t *drive)
2863 idetape_tape_t *tape;
2867 if (!strstr("ide-tape", drive->driver_req))
2869 if (!drive->present)
2871 if (drive->media != ide_tape)
2873 if (!idetape_identify_device(drive)) {
2874 printk(KERN_ERR "ide-tape: %s: not supported by this version of"
2875 " the driver\n", drive->name);
2879 printk(KERN_INFO "ide-tape: passing drive %s to ide-scsi"
2880 " emulation.\n", drive->name);
2883 tape = kzalloc(sizeof(idetape_tape_t), GFP_KERNEL);
2885 printk(KERN_ERR "ide-tape: %s: Can't allocate a tape struct\n",
2890 g = alloc_disk(1 << PARTN_BITS);
2894 ide_init_disk(g, drive);
2896 ide_proc_register_driver(drive, &idetape_driver);
2898 kref_init(&tape->kref);
2900 tape->drive = drive;
2901 tape->driver = &idetape_driver;
2904 g->private_data = &tape->driver;
2906 drive->driver_data = tape;
2908 mutex_lock(&idetape_ref_mutex);
2909 for (minor = 0; idetape_devs[minor]; minor++)
2911 idetape_devs[minor] = tape;
2912 mutex_unlock(&idetape_ref_mutex);
2914 idetape_setup(drive, tape, minor);
2916 device_create(idetape_sysfs_class, &drive->gendev,
2917 MKDEV(IDETAPE_MAJOR, minor), "%s", tape->name);
2918 device_create(idetape_sysfs_class, &drive->gendev,
2919 MKDEV(IDETAPE_MAJOR, minor + 128), "n%s", tape->name);
2921 g->fops = &idetape_block_ops;
2922 ide_register_region(g);
2932 static void __exit idetape_exit(void)
2934 driver_unregister(&idetape_driver.gen_driver);
2935 class_destroy(idetape_sysfs_class);
2936 unregister_chrdev(IDETAPE_MAJOR, "ht");
2939 static int __init idetape_init(void)
2942 idetape_sysfs_class = class_create(THIS_MODULE, "ide_tape");
2943 if (IS_ERR(idetape_sysfs_class)) {
2944 idetape_sysfs_class = NULL;
2945 printk(KERN_ERR "Unable to create sysfs class for ide tapes\n");
2950 if (register_chrdev(IDETAPE_MAJOR, "ht", &idetape_fops)) {
2951 printk(KERN_ERR "ide-tape: Failed to register chrdev"
2954 goto out_free_class;
2957 error = driver_register(&idetape_driver.gen_driver);
2959 goto out_free_driver;
2964 driver_unregister(&idetape_driver.gen_driver);
2966 class_destroy(idetape_sysfs_class);
2971 MODULE_ALIAS("ide:*m-tape*");
2972 module_init(idetape_init);
2973 module_exit(idetape_exit);
2974 MODULE_ALIAS_CHARDEV_MAJOR(IDETAPE_MAJOR);
2975 MODULE_DESCRIPTION("ATAPI Streaming TAPE Driver");
2976 MODULE_LICENSE("GPL");