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 ide_startstop_t 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);
715 * Postpone the current request so that ide.c will be able to service requests
716 * from another device on the same hwgroup while we are polling for DSC.
718 static void idetape_postpone_request(ide_drive_t *drive)
720 idetape_tape_t *tape = drive->driver_data;
722 debug_log(DBG_PROCS, "Enter %s\n", __func__);
724 tape->postponed_rq = HWGROUP(drive)->rq;
725 ide_stall_queue(drive, tape->dsc_poll_freq);
728 typedef void idetape_io_buf(ide_drive_t *, struct ide_atapi_pc *, unsigned int);
731 * This is the usual interrupt handler which will be called during a packet
732 * command. We will transfer some of the data (as requested by the drive) and
733 * will re-point interrupt handler to us. When data transfer is finished, we
734 * will act according to the algorithm described before
737 static ide_startstop_t idetape_pc_intr(ide_drive_t *drive)
739 ide_hwif_t *hwif = drive->hwif;
740 idetape_tape_t *tape = drive->driver_data;
741 struct ide_atapi_pc *pc = tape->pc;
742 xfer_func_t *xferfunc;
743 idetape_io_buf *iobuf;
748 debug_log(DBG_PROCS, "Enter %s - interrupt handler\n", __func__);
750 /* Clear the interrupt */
751 stat = ide_read_status(drive);
753 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
754 if (hwif->dma_ops->dma_end(drive) || (stat & ERR_STAT)) {
755 pc->flags |= PC_FLAG_DMA_ERROR;
757 pc->xferred = pc->req_xfer;
758 idetape_update_buffers(pc);
760 debug_log(DBG_PROCS, "DMA finished\n");
764 /* No more interrupts */
765 if ((stat & DRQ_STAT) == 0) {
766 debug_log(DBG_SENSE, "Packet command completed, %d bytes"
767 " transferred\n", pc->xferred);
769 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
770 local_irq_enable_in_hardirq();
772 if ((stat & ERR_STAT) && pc->c[0] == REQUEST_SENSE)
774 if ((stat & ERR_STAT) || (pc->flags & PC_FLAG_DMA_ERROR)) {
776 debug_log(DBG_ERR, "%s: I/O error\n", tape->name);
778 if (pc->c[0] == REQUEST_SENSE) {
779 printk(KERN_ERR "ide-tape: I/O error in request"
781 return ide_do_reset(drive);
783 debug_log(DBG_ERR, "[cmd %x]: check condition\n",
786 /* Retry operation */
787 return 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 "ide-tape: The tape wants to issue more "
809 "interrupts in DMA mode\n");
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 "ide-tape: CoD != 0 in %s\n", __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 "ide-tape: We wanted to %s, ",
826 (ireason & IO) ? "Write" : "Read");
827 printk(KERN_ERR "ide-tape: but the tape wants us to %s !\n",
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 "ide-tape: The tape wants to "
837 "send us more data than expected "
838 "- discarding data\n");
839 ide_pad_transfer(drive, 0, bcount);
840 ide_set_handler(drive, &idetape_pc_intr,
841 IDETAPE_WAIT_CMD, NULL);
844 debug_log(DBG_SENSE, "The tape wants to send us more "
845 "data than expected - allowing transfer\n");
847 iobuf = &idetape_input_buffers;
848 xferfunc = hwif->input_data;
850 iobuf = &idetape_output_buffers;
851 xferfunc = hwif->output_data;
855 iobuf(drive, pc, bcount);
857 xferfunc(drive, NULL, pc->cur_pos, bcount);
859 /* Update the current position */
860 pc->xferred += bcount;
861 pc->cur_pos += bcount;
863 debug_log(DBG_SENSE, "[cmd %x] transferred %d bytes on that intr.\n",
866 /* And set the interrupt handler again */
867 ide_set_handler(drive, &idetape_pc_intr, IDETAPE_WAIT_CMD, NULL);
872 * Packet Command Interface
874 * The current Packet Command is available in tape->pc, and will not change
875 * until we finish handling it. Each packet command is associated with a
876 * callback function that will be called when the command is finished.
878 * The handling will be done in three stages:
880 * 1. idetape_issue_pc will send the packet command to the drive, and will set
881 * the interrupt handler to idetape_pc_intr.
883 * 2. On each interrupt, idetape_pc_intr will be called. This step will be
884 * repeated until the device signals us that no more interrupts will be issued.
886 * 3. ATAPI Tape media access commands have immediate status with a delayed
887 * process. In case of a successful initiation of a media access packet command,
888 * the DSC bit will be set when the actual execution of the command is finished.
889 * Since the tape drive will not issue an interrupt, we have to poll for this
890 * event. In this case, we define the request as "low priority request" by
891 * setting rq_status to IDETAPE_RQ_POSTPONED, set a timer to poll for DSC and
894 * ide.c will then give higher priority to requests which originate from the
895 * other device, until will change rq_status to RQ_ACTIVE.
897 * 4. When the packet command is finished, it will be checked for errors.
899 * 5. In case an error was found, we queue a request sense packet command in
900 * front of the request queue and retry the operation up to
901 * IDETAPE_MAX_PC_RETRIES times.
903 * 6. In case no error was found, or we decided to give up and not to retry
904 * again, the callback function will be called and then we will handle the next
907 static ide_startstop_t idetape_transfer_pc(ide_drive_t *drive)
909 ide_hwif_t *hwif = drive->hwif;
910 idetape_tape_t *tape = drive->driver_data;
911 struct ide_atapi_pc *pc = tape->pc;
913 ide_startstop_t startstop;
916 if (ide_wait_stat(&startstop, drive, DRQ_STAT, BUSY_STAT, WAIT_READY)) {
917 printk(KERN_ERR "ide-tape: Strange, packet command initiated "
918 "yet DRQ isn't asserted\n");
921 ireason = hwif->INB(hwif->io_ports.nsect_addr);
922 while (retries-- && ((ireason & CD) == 0 || (ireason & IO))) {
923 printk(KERN_ERR "ide-tape: (IO,CoD != (0,1) while issuing "
924 "a packet command, retrying\n");
926 ireason = hwif->INB(hwif->io_ports.nsect_addr);
928 printk(KERN_ERR "ide-tape: (IO,CoD != (0,1) while "
929 "issuing a packet command, ignoring\n");
934 if ((ireason & CD) == 0 || (ireason & IO)) {
935 printk(KERN_ERR "ide-tape: (IO,CoD) != (0,1) while issuing "
936 "a packet command\n");
937 return ide_do_reset(drive);
939 /* Set the interrupt routine */
940 ide_set_handler(drive, &idetape_pc_intr, IDETAPE_WAIT_CMD, NULL);
942 /* Begin DMA, if necessary */
943 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS)
944 hwif->dma_ops->dma_start(drive);
946 /* Send the actual packet */
947 hwif->output_data(drive, NULL, pc->c, 12);
952 static ide_startstop_t idetape_issue_pc(ide_drive_t *drive,
953 struct ide_atapi_pc *pc)
955 ide_hwif_t *hwif = drive->hwif;
956 idetape_tape_t *tape = drive->driver_data;
960 if (tape->pc->c[0] == REQUEST_SENSE &&
961 pc->c[0] == REQUEST_SENSE) {
962 printk(KERN_ERR "ide-tape: possible ide-tape.c bug - "
963 "Two request sense in serial were issued\n");
966 if (tape->failed_pc == NULL && pc->c[0] != REQUEST_SENSE)
967 tape->failed_pc = pc;
968 /* Set the current packet command */
971 if (pc->retries > IDETAPE_MAX_PC_RETRIES ||
972 (pc->flags & PC_FLAG_ABORT)) {
974 * We will "abort" retrying a packet command in case legitimate
975 * error code was received (crossing a filemark, or end of the
976 * media, for example).
978 if (!(pc->flags & PC_FLAG_ABORT)) {
979 if (!(pc->c[0] == TEST_UNIT_READY &&
980 tape->sense_key == 2 && tape->asc == 4 &&
981 (tape->ascq == 1 || tape->ascq == 8))) {
982 printk(KERN_ERR "ide-tape: %s: I/O error, "
983 "pc = %2x, key = %2x, "
984 "asc = %2x, ascq = %2x\n",
985 tape->name, pc->c[0],
986 tape->sense_key, tape->asc,
990 pc->error = IDETAPE_ERROR_GENERAL;
992 tape->failed_pc = NULL;
993 return pc->idetape_callback(drive);
995 debug_log(DBG_SENSE, "Retry #%d, cmd = %02X\n", pc->retries, pc->c[0]);
998 /* We haven't transferred any data yet */
1000 pc->cur_pos = pc->buf;
1001 /* Request to transfer the entire buffer at once */
1002 bcount = pc->req_xfer;
1004 if (pc->flags & PC_FLAG_DMA_ERROR) {
1005 pc->flags &= ~PC_FLAG_DMA_ERROR;
1008 if ((pc->flags & PC_FLAG_DMA_RECOMMENDED) && drive->using_dma)
1009 dma_ok = !hwif->dma_ops->dma_setup(drive);
1011 ide_pktcmd_tf_load(drive, IDE_TFLAG_OUT_DEVICE, bcount, dma_ok);
1014 /* Will begin DMA later */
1015 pc->flags |= PC_FLAG_DMA_IN_PROGRESS;
1016 if (test_bit(IDETAPE_FLAG_DRQ_INTERRUPT, &tape->flags)) {
1017 ide_execute_command(drive, WIN_PACKETCMD, &idetape_transfer_pc,
1018 IDETAPE_WAIT_CMD, NULL);
1021 ide_execute_pkt_cmd(drive);
1022 return idetape_transfer_pc(drive);
1026 static ide_startstop_t idetape_pc_callback(ide_drive_t *drive)
1028 idetape_tape_t *tape = drive->driver_data;
1030 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1032 idetape_end_request(drive, tape->pc->error ? 0 : 1, 0);
1036 /* A mode sense command is used to "sense" tape parameters. */
1037 static void idetape_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
1039 idetape_init_pc(pc);
1040 pc->c[0] = MODE_SENSE;
1041 if (page_code != IDETAPE_BLOCK_DESCRIPTOR)
1042 /* DBD = 1 - Don't return block descriptors */
1044 pc->c[2] = page_code;
1046 * Changed pc->c[3] to 0 (255 will at best return unused info).
1048 * For SCSI this byte is defined as subpage instead of high byte
1049 * of length and some IDE drives seem to interpret it this way
1050 * and return an error when 255 is used.
1053 /* We will just discard data in that case */
1055 if (page_code == IDETAPE_BLOCK_DESCRIPTOR)
1057 else if (page_code == IDETAPE_CAPABILITIES_PAGE)
1061 pc->idetape_callback = &idetape_pc_callback;
1064 static ide_startstop_t idetape_media_access_finished(ide_drive_t *drive)
1066 idetape_tape_t *tape = drive->driver_data;
1067 struct ide_atapi_pc *pc = tape->pc;
1070 stat = ide_read_status(drive);
1072 if (stat & SEEK_STAT) {
1073 if (stat & ERR_STAT) {
1074 /* Error detected */
1075 if (pc->c[0] != TEST_UNIT_READY)
1076 printk(KERN_ERR "ide-tape: %s: I/O error, ",
1078 /* Retry operation */
1079 return idetape_retry_pc(drive);
1082 if (tape->failed_pc == pc)
1083 tape->failed_pc = NULL;
1085 pc->error = IDETAPE_ERROR_GENERAL;
1086 tape->failed_pc = NULL;
1088 return pc->idetape_callback(drive);
1091 static ide_startstop_t idetape_rw_callback(ide_drive_t *drive)
1093 idetape_tape_t *tape = drive->driver_data;
1094 struct request *rq = HWGROUP(drive)->rq;
1095 int blocks = tape->pc->xferred / tape->blk_size;
1097 tape->avg_size += blocks * tape->blk_size;
1099 if (time_after_eq(jiffies, tape->avg_time + HZ)) {
1100 tape->avg_speed = tape->avg_size * HZ /
1101 (jiffies - tape->avg_time) / 1024;
1103 tape->avg_time = jiffies;
1105 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1107 tape->first_frame += blocks;
1108 rq->current_nr_sectors -= blocks;
1110 if (!tape->pc->error)
1111 idetape_end_request(drive, 1, 0);
1113 idetape_end_request(drive, tape->pc->error, 0);
1117 static void idetape_create_read_cmd(idetape_tape_t *tape,
1118 struct ide_atapi_pc *pc,
1119 unsigned int length, struct idetape_bh *bh)
1121 idetape_init_pc(pc);
1123 put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
1125 pc->idetape_callback = &idetape_rw_callback;
1127 atomic_set(&bh->b_count, 0);
1129 pc->buf_size = length * tape->blk_size;
1130 pc->req_xfer = pc->buf_size;
1131 if (pc->req_xfer == tape->buffer_size)
1132 pc->flags |= PC_FLAG_DMA_RECOMMENDED;
1135 static void idetape_create_write_cmd(idetape_tape_t *tape,
1136 struct ide_atapi_pc *pc,
1137 unsigned int length, struct idetape_bh *bh)
1139 idetape_init_pc(pc);
1141 put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
1143 pc->idetape_callback = &idetape_rw_callback;
1144 pc->flags |= PC_FLAG_WRITING;
1146 pc->b_data = bh->b_data;
1147 pc->b_count = atomic_read(&bh->b_count);
1149 pc->buf_size = length * tape->blk_size;
1150 pc->req_xfer = pc->buf_size;
1151 if (pc->req_xfer == tape->buffer_size)
1152 pc->flags |= PC_FLAG_DMA_RECOMMENDED;
1155 static ide_startstop_t idetape_do_request(ide_drive_t *drive,
1156 struct request *rq, sector_t block)
1158 idetape_tape_t *tape = drive->driver_data;
1159 struct ide_atapi_pc *pc = NULL;
1160 struct request *postponed_rq = tape->postponed_rq;
1163 debug_log(DBG_SENSE, "sector: %ld, nr_sectors: %ld,"
1164 " current_nr_sectors: %d\n",
1165 rq->sector, rq->nr_sectors, rq->current_nr_sectors);
1167 if (!blk_special_request(rq)) {
1168 /* We do not support buffer cache originated requests. */
1169 printk(KERN_NOTICE "ide-tape: %s: Unsupported request in "
1170 "request queue (%d)\n", drive->name, rq->cmd_type);
1171 ide_end_request(drive, 0, 0);
1175 /* Retry a failed packet command */
1176 if (tape->failed_pc && tape->pc->c[0] == REQUEST_SENSE)
1177 return idetape_issue_pc(drive, tape->failed_pc);
1179 if (postponed_rq != NULL)
1180 if (rq != postponed_rq) {
1181 printk(KERN_ERR "ide-tape: ide-tape.c bug - "
1182 "Two DSC requests were queued\n");
1183 idetape_end_request(drive, 0, 0);
1187 tape->postponed_rq = NULL;
1190 * If the tape is still busy, postpone our request and service
1191 * the other device meanwhile.
1193 stat = ide_read_status(drive);
1195 if (!drive->dsc_overlap && !(rq->cmd[0] & REQ_IDETAPE_PC2))
1196 set_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags);
1198 if (drive->post_reset == 1) {
1199 set_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags);
1200 drive->post_reset = 0;
1203 if (!test_and_clear_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags) &&
1204 (stat & SEEK_STAT) == 0) {
1205 if (postponed_rq == NULL) {
1206 tape->dsc_polling_start = jiffies;
1207 tape->dsc_poll_freq = tape->best_dsc_rw_freq;
1208 tape->dsc_timeout = jiffies + IDETAPE_DSC_RW_TIMEOUT;
1209 } else if (time_after(jiffies, tape->dsc_timeout)) {
1210 printk(KERN_ERR "ide-tape: %s: DSC timeout\n",
1212 if (rq->cmd[0] & REQ_IDETAPE_PC2) {
1213 idetape_media_access_finished(drive);
1216 return ide_do_reset(drive);
1218 } else if (time_after(jiffies,
1219 tape->dsc_polling_start +
1220 IDETAPE_DSC_MA_THRESHOLD))
1221 tape->dsc_poll_freq = IDETAPE_DSC_MA_SLOW;
1222 idetape_postpone_request(drive);
1225 if (rq->cmd[0] & REQ_IDETAPE_READ) {
1226 pc = idetape_next_pc_storage(drive);
1227 idetape_create_read_cmd(tape, pc, rq->current_nr_sectors,
1228 (struct idetape_bh *)rq->special);
1231 if (rq->cmd[0] & REQ_IDETAPE_WRITE) {
1232 pc = idetape_next_pc_storage(drive);
1233 idetape_create_write_cmd(tape, pc, rq->current_nr_sectors,
1234 (struct idetape_bh *)rq->special);
1237 if (rq->cmd[0] & REQ_IDETAPE_PC1) {
1238 pc = (struct ide_atapi_pc *) rq->buffer;
1239 rq->cmd[0] &= ~(REQ_IDETAPE_PC1);
1240 rq->cmd[0] |= REQ_IDETAPE_PC2;
1243 if (rq->cmd[0] & REQ_IDETAPE_PC2) {
1244 idetape_media_access_finished(drive);
1249 return idetape_issue_pc(drive, pc);
1253 * The function below uses __get_free_pages to allocate a data buffer of size
1254 * tape->buffer_size (or a bit more). We attempt to combine sequential pages as
1257 * It returns a pointer to the newly allocated buffer, or NULL in case of
1260 static struct idetape_bh *ide_tape_kmalloc_buffer(idetape_tape_t *tape,
1261 int full, int clear)
1263 struct idetape_bh *prev_bh, *bh, *merge_bh;
1264 int pages = tape->pages_per_buffer;
1265 unsigned int order, b_allocd;
1266 char *b_data = NULL;
1268 merge_bh = kmalloc(sizeof(struct idetape_bh), GFP_KERNEL);
1273 order = fls(pages) - 1;
1274 bh->b_data = (char *) __get_free_pages(GFP_KERNEL, order);
1277 b_allocd = (1 << order) * PAGE_SIZE;
1281 memset(bh->b_data, 0, b_allocd);
1282 bh->b_reqnext = NULL;
1283 bh->b_size = b_allocd;
1284 atomic_set(&bh->b_count, full ? bh->b_size : 0);
1287 order = fls(pages) - 1;
1288 b_data = (char *) __get_free_pages(GFP_KERNEL, order);
1291 b_allocd = (1 << order) * PAGE_SIZE;
1294 memset(b_data, 0, b_allocd);
1296 /* newly allocated page frames below buffer header or ...*/
1297 if (bh->b_data == b_data + b_allocd) {
1298 bh->b_size += b_allocd;
1299 bh->b_data -= b_allocd;
1301 atomic_add(b_allocd, &bh->b_count);
1304 /* they are above the header */
1305 if (b_data == bh->b_data + bh->b_size) {
1306 bh->b_size += b_allocd;
1308 atomic_add(b_allocd, &bh->b_count);
1312 bh = kmalloc(sizeof(struct idetape_bh), GFP_KERNEL);
1314 free_pages((unsigned long) b_data, order);
1317 bh->b_reqnext = NULL;
1318 bh->b_data = b_data;
1319 bh->b_size = b_allocd;
1320 atomic_set(&bh->b_count, full ? bh->b_size : 0);
1321 prev_bh->b_reqnext = bh;
1326 bh->b_size -= tape->excess_bh_size;
1328 atomic_sub(tape->excess_bh_size, &bh->b_count);
1331 ide_tape_kfree_buffer(tape);
1335 static int idetape_copy_stage_from_user(idetape_tape_t *tape,
1336 const char __user *buf, int n)
1338 struct idetape_bh *bh = tape->bh;
1344 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
1348 count = min((unsigned int)
1349 (bh->b_size - atomic_read(&bh->b_count)),
1351 if (copy_from_user(bh->b_data + atomic_read(&bh->b_count), buf,
1355 atomic_add(count, &bh->b_count);
1357 if (atomic_read(&bh->b_count) == bh->b_size) {
1360 atomic_set(&bh->b_count, 0);
1367 static int idetape_copy_stage_to_user(idetape_tape_t *tape, char __user *buf,
1370 struct idetape_bh *bh = tape->bh;
1376 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
1380 count = min(tape->b_count, n);
1381 if (copy_to_user(buf, tape->b_data, count))
1384 tape->b_data += count;
1385 tape->b_count -= count;
1387 if (!tape->b_count) {
1391 tape->b_data = bh->b_data;
1392 tape->b_count = atomic_read(&bh->b_count);
1399 static void idetape_init_merge_buffer(idetape_tape_t *tape)
1401 struct idetape_bh *bh = tape->merge_bh;
1402 tape->bh = tape->merge_bh;
1404 if (tape->chrdev_dir == IDETAPE_DIR_WRITE)
1405 atomic_set(&bh->b_count, 0);
1407 tape->b_data = bh->b_data;
1408 tape->b_count = atomic_read(&bh->b_count);
1412 static ide_startstop_t idetape_read_position_callback(ide_drive_t *drive)
1414 idetape_tape_t *tape = drive->driver_data;
1415 u8 *readpos = tape->pc->buf;
1417 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1419 if (!tape->pc->error) {
1420 debug_log(DBG_SENSE, "BOP - %s\n",
1421 (readpos[0] & 0x80) ? "Yes" : "No");
1422 debug_log(DBG_SENSE, "EOP - %s\n",
1423 (readpos[0] & 0x40) ? "Yes" : "No");
1425 if (readpos[0] & 0x4) {
1426 printk(KERN_INFO "ide-tape: Block location is unknown"
1428 clear_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags);
1429 idetape_end_request(drive, 0, 0);
1431 debug_log(DBG_SENSE, "Block Location - %u\n",
1432 be32_to_cpu(*(u32 *)&readpos[4]));
1434 tape->partition = readpos[1];
1436 be32_to_cpu(*(u32 *)&readpos[4]);
1437 set_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags);
1438 idetape_end_request(drive, 1, 0);
1441 idetape_end_request(drive, 0, 0);
1447 * Write a filemark if write_filemark=1. Flush the device buffers without
1448 * writing a filemark otherwise.
1450 static void idetape_create_write_filemark_cmd(ide_drive_t *drive,
1451 struct ide_atapi_pc *pc, int write_filemark)
1453 idetape_init_pc(pc);
1454 pc->c[0] = WRITE_FILEMARKS;
1455 pc->c[4] = write_filemark;
1456 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1457 pc->idetape_callback = &idetape_pc_callback;
1460 static void idetape_create_test_unit_ready_cmd(struct ide_atapi_pc *pc)
1462 idetape_init_pc(pc);
1463 pc->c[0] = TEST_UNIT_READY;
1464 pc->idetape_callback = &idetape_pc_callback;
1468 * We add a special packet command request to the tail of the request queue, and
1469 * wait for it to be serviced. This is not to be called from within the request
1470 * handling part of the driver! We allocate here data on the stack and it is
1471 * valid until the request is finished. This is not the case for the bottom part
1472 * of the driver, where we are always leaving the functions to wait for an
1473 * interrupt or a timer event.
1475 * From the bottom part of the driver, we should allocate safe memory using
1476 * idetape_next_pc_storage() and ide_tape_next_rq_storage(), and add the request
1477 * to the request list without waiting for it to be serviced! In that case, we
1478 * usually use idetape_queue_pc_head().
1480 static int idetape_queue_pc_tail(ide_drive_t *drive, struct ide_atapi_pc *pc)
1482 struct ide_tape_obj *tape = drive->driver_data;
1486 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
1487 rq->cmd_type = REQ_TYPE_SPECIAL;
1488 rq->cmd[0] = REQ_IDETAPE_PC1;
1489 rq->buffer = (char *)pc;
1490 error = blk_execute_rq(drive->queue, tape->disk, rq, 0);
1491 blk_put_request(rq);
1495 static void idetape_create_load_unload_cmd(ide_drive_t *drive,
1496 struct ide_atapi_pc *pc, int cmd)
1498 idetape_init_pc(pc);
1499 pc->c[0] = START_STOP;
1501 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1502 pc->idetape_callback = &idetape_pc_callback;
1505 static int idetape_wait_ready(ide_drive_t *drive, unsigned long timeout)
1507 idetape_tape_t *tape = drive->driver_data;
1508 struct ide_atapi_pc pc;
1509 int load_attempted = 0;
1511 /* Wait for the tape to become ready */
1512 set_bit(IDETAPE_FLAG_MEDIUM_PRESENT, &tape->flags);
1514 while (time_before(jiffies, timeout)) {
1515 idetape_create_test_unit_ready_cmd(&pc);
1516 if (!idetape_queue_pc_tail(drive, &pc))
1518 if ((tape->sense_key == 2 && tape->asc == 4 && tape->ascq == 2)
1519 || (tape->asc == 0x3A)) {
1523 idetape_create_load_unload_cmd(drive, &pc,
1524 IDETAPE_LU_LOAD_MASK);
1525 idetape_queue_pc_tail(drive, &pc);
1527 /* not about to be ready */
1528 } else if (!(tape->sense_key == 2 && tape->asc == 4 &&
1529 (tape->ascq == 1 || tape->ascq == 8)))
1536 static int idetape_flush_tape_buffers(ide_drive_t *drive)
1538 struct ide_atapi_pc pc;
1541 idetape_create_write_filemark_cmd(drive, &pc, 0);
1542 rc = idetape_queue_pc_tail(drive, &pc);
1545 idetape_wait_ready(drive, 60 * 5 * HZ);
1549 static void idetape_create_read_position_cmd(struct ide_atapi_pc *pc)
1551 idetape_init_pc(pc);
1552 pc->c[0] = READ_POSITION;
1554 pc->idetape_callback = &idetape_read_position_callback;
1557 static int idetape_read_position(ide_drive_t *drive)
1559 idetape_tape_t *tape = drive->driver_data;
1560 struct ide_atapi_pc pc;
1563 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1565 idetape_create_read_position_cmd(&pc);
1566 if (idetape_queue_pc_tail(drive, &pc))
1568 position = tape->first_frame;
1572 static void idetape_create_locate_cmd(ide_drive_t *drive,
1573 struct ide_atapi_pc *pc,
1574 unsigned int block, u8 partition, int skip)
1576 idetape_init_pc(pc);
1577 pc->c[0] = POSITION_TO_ELEMENT;
1579 put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[3]);
1580 pc->c[8] = partition;
1581 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1582 pc->idetape_callback = &idetape_pc_callback;
1585 static int idetape_create_prevent_cmd(ide_drive_t *drive,
1586 struct ide_atapi_pc *pc, int prevent)
1588 idetape_tape_t *tape = drive->driver_data;
1590 /* device supports locking according to capabilities page */
1591 if (!(tape->caps[6] & 0x01))
1594 idetape_init_pc(pc);
1595 pc->c[0] = ALLOW_MEDIUM_REMOVAL;
1597 pc->idetape_callback = &idetape_pc_callback;
1601 static void __ide_tape_discard_merge_buffer(ide_drive_t *drive)
1603 idetape_tape_t *tape = drive->driver_data;
1605 if (tape->chrdev_dir != IDETAPE_DIR_READ)
1608 clear_bit(IDETAPE_FLAG_FILEMARK, &tape->flags);
1609 tape->merge_bh_size = 0;
1610 if (tape->merge_bh != NULL) {
1611 ide_tape_kfree_buffer(tape);
1612 tape->merge_bh = NULL;
1615 tape->chrdev_dir = IDETAPE_DIR_NONE;
1619 * Position the tape to the requested block using the LOCATE packet command.
1620 * A READ POSITION command is then issued to check where we are positioned. Like
1621 * all higher level operations, we queue the commands at the tail of the request
1622 * queue and wait for their completion.
1624 static int idetape_position_tape(ide_drive_t *drive, unsigned int block,
1625 u8 partition, int skip)
1627 idetape_tape_t *tape = drive->driver_data;
1629 struct ide_atapi_pc pc;
1631 if (tape->chrdev_dir == IDETAPE_DIR_READ)
1632 __ide_tape_discard_merge_buffer(drive);
1633 idetape_wait_ready(drive, 60 * 5 * HZ);
1634 idetape_create_locate_cmd(drive, &pc, block, partition, skip);
1635 retval = idetape_queue_pc_tail(drive, &pc);
1639 idetape_create_read_position_cmd(&pc);
1640 return (idetape_queue_pc_tail(drive, &pc));
1643 static void ide_tape_discard_merge_buffer(ide_drive_t *drive,
1644 int restore_position)
1646 idetape_tape_t *tape = drive->driver_data;
1649 __ide_tape_discard_merge_buffer(drive);
1650 if (restore_position) {
1651 position = idetape_read_position(drive);
1652 seek = position > 0 ? position : 0;
1653 if (idetape_position_tape(drive, seek, 0, 0)) {
1654 printk(KERN_INFO "ide-tape: %s: position_tape failed in"
1655 " %s\n", tape->name, __func__);
1662 * Generate a read/write request for the block device interface and wait for it
1665 static int idetape_queue_rw_tail(ide_drive_t *drive, int cmd, int blocks,
1666 struct idetape_bh *bh)
1668 idetape_tape_t *tape = drive->driver_data;
1672 debug_log(DBG_SENSE, "%s: cmd=%d\n", __func__, cmd);
1674 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
1675 rq->cmd_type = REQ_TYPE_SPECIAL;
1677 rq->rq_disk = tape->disk;
1678 rq->special = (void *)bh;
1679 rq->sector = tape->first_frame;
1680 rq->nr_sectors = blocks;
1681 rq->current_nr_sectors = blocks;
1682 blk_execute_rq(drive->queue, tape->disk, rq, 0);
1684 errors = rq->errors;
1685 ret = tape->blk_size * (blocks - rq->current_nr_sectors);
1686 blk_put_request(rq);
1688 if ((cmd & (REQ_IDETAPE_READ | REQ_IDETAPE_WRITE)) == 0)
1692 idetape_init_merge_buffer(tape);
1693 if (errors == IDETAPE_ERROR_GENERAL)
1698 static void idetape_create_inquiry_cmd(struct ide_atapi_pc *pc)
1700 idetape_init_pc(pc);
1704 pc->idetape_callback = &idetape_pc_callback;
1707 static void idetape_create_rewind_cmd(ide_drive_t *drive,
1708 struct ide_atapi_pc *pc)
1710 idetape_init_pc(pc);
1711 pc->c[0] = REZERO_UNIT;
1712 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1713 pc->idetape_callback = &idetape_pc_callback;
1716 static void idetape_create_erase_cmd(struct ide_atapi_pc *pc)
1718 idetape_init_pc(pc);
1721 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1722 pc->idetape_callback = &idetape_pc_callback;
1725 static void idetape_create_space_cmd(struct ide_atapi_pc *pc, int count, u8 cmd)
1727 idetape_init_pc(pc);
1729 put_unaligned(cpu_to_be32(count), (unsigned int *) &pc->c[1]);
1731 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1732 pc->idetape_callback = &idetape_pc_callback;
1735 /* Queue up a character device originated write request. */
1736 static int idetape_add_chrdev_write_request(ide_drive_t *drive, int blocks)
1738 idetape_tape_t *tape = drive->driver_data;
1740 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
1742 return idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE,
1743 blocks, tape->merge_bh);
1746 static void ide_tape_flush_merge_buffer(ide_drive_t *drive)
1748 idetape_tape_t *tape = drive->driver_data;
1750 struct idetape_bh *bh;
1752 if (tape->chrdev_dir != IDETAPE_DIR_WRITE) {
1753 printk(KERN_ERR "ide-tape: bug: Trying to empty merge buffer"
1754 " but we are not writing.\n");
1757 if (tape->merge_bh_size > tape->buffer_size) {
1758 printk(KERN_ERR "ide-tape: bug: merge_buffer too big\n");
1759 tape->merge_bh_size = tape->buffer_size;
1761 if (tape->merge_bh_size) {
1762 blocks = tape->merge_bh_size / tape->blk_size;
1763 if (tape->merge_bh_size % tape->blk_size) {
1767 i = tape->blk_size - tape->merge_bh_size %
1769 bh = tape->bh->b_reqnext;
1771 atomic_set(&bh->b_count, 0);
1777 printk(KERN_INFO "ide-tape: bug,"
1781 min = min(i, (unsigned int)(bh->b_size -
1782 atomic_read(&bh->b_count)));
1783 memset(bh->b_data + atomic_read(&bh->b_count),
1785 atomic_add(min, &bh->b_count);
1790 (void) idetape_add_chrdev_write_request(drive, blocks);
1791 tape->merge_bh_size = 0;
1793 if (tape->merge_bh != NULL) {
1794 ide_tape_kfree_buffer(tape);
1795 tape->merge_bh = NULL;
1797 tape->chrdev_dir = IDETAPE_DIR_NONE;
1800 static int idetape_init_read(ide_drive_t *drive)
1802 idetape_tape_t *tape = drive->driver_data;
1805 /* Initialize read operation */
1806 if (tape->chrdev_dir != IDETAPE_DIR_READ) {
1807 if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
1808 ide_tape_flush_merge_buffer(drive);
1809 idetape_flush_tape_buffers(drive);
1811 if (tape->merge_bh || tape->merge_bh_size) {
1812 printk(KERN_ERR "ide-tape: merge_bh_size should be"
1814 tape->merge_bh_size = 0;
1816 tape->merge_bh = ide_tape_kmalloc_buffer(tape, 0, 0);
1817 if (!tape->merge_bh)
1819 tape->chrdev_dir = IDETAPE_DIR_READ;
1822 * Issue a read 0 command to ensure that DSC handshake is
1823 * switched from completion mode to buffer available mode.
1824 * No point in issuing this if DSC overlap isn't supported, some
1825 * drives (Seagate STT3401A) will return an error.
1827 if (drive->dsc_overlap) {
1828 bytes_read = idetape_queue_rw_tail(drive,
1829 REQ_IDETAPE_READ, 0,
1831 if (bytes_read < 0) {
1832 ide_tape_kfree_buffer(tape);
1833 tape->merge_bh = NULL;
1834 tape->chrdev_dir = IDETAPE_DIR_NONE;
1843 /* called from idetape_chrdev_read() to service a chrdev read request. */
1844 static int idetape_add_chrdev_read_request(ide_drive_t *drive, int blocks)
1846 idetape_tape_t *tape = drive->driver_data;
1848 debug_log(DBG_PROCS, "Enter %s, %d blocks\n", __func__, blocks);
1850 /* If we are at a filemark, return a read length of 0 */
1851 if (test_bit(IDETAPE_FLAG_FILEMARK, &tape->flags))
1854 idetape_init_read(drive);
1856 return idetape_queue_rw_tail(drive, REQ_IDETAPE_READ, blocks,
1860 static void idetape_pad_zeros(ide_drive_t *drive, int bcount)
1862 idetape_tape_t *tape = drive->driver_data;
1863 struct idetape_bh *bh;
1869 bh = tape->merge_bh;
1870 count = min(tape->buffer_size, bcount);
1872 blocks = count / tape->blk_size;
1874 atomic_set(&bh->b_count,
1875 min(count, (unsigned int)bh->b_size));
1876 memset(bh->b_data, 0, atomic_read(&bh->b_count));
1877 count -= atomic_read(&bh->b_count);
1880 idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE, blocks,
1886 * Rewinds the tape to the Beginning Of the current Partition (BOP). We
1887 * currently support only one partition.
1889 static int idetape_rewind_tape(ide_drive_t *drive)
1892 struct ide_atapi_pc pc;
1893 idetape_tape_t *tape;
1894 tape = drive->driver_data;
1896 debug_log(DBG_SENSE, "Enter %s\n", __func__);
1898 idetape_create_rewind_cmd(drive, &pc);
1899 retval = idetape_queue_pc_tail(drive, &pc);
1903 idetape_create_read_position_cmd(&pc);
1904 retval = idetape_queue_pc_tail(drive, &pc);
1910 /* mtio.h compatible commands should be issued to the chrdev interface. */
1911 static int idetape_blkdev_ioctl(ide_drive_t *drive, unsigned int cmd,
1914 idetape_tape_t *tape = drive->driver_data;
1915 void __user *argp = (void __user *)arg;
1917 struct idetape_config {
1918 int dsc_rw_frequency;
1919 int dsc_media_access_frequency;
1923 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1927 if (copy_from_user(&config, argp, sizeof(config)))
1929 tape->best_dsc_rw_freq = config.dsc_rw_frequency;
1932 config.dsc_rw_frequency = (int) tape->best_dsc_rw_freq;
1933 config.nr_stages = 1;
1934 if (copy_to_user(argp, &config, sizeof(config)))
1943 static int idetape_space_over_filemarks(ide_drive_t *drive, short mt_op,
1946 idetape_tape_t *tape = drive->driver_data;
1947 struct ide_atapi_pc pc;
1948 int retval, count = 0;
1949 int sprev = !!(tape->caps[4] & 0x20);
1953 if (MTBSF == mt_op || MTBSFM == mt_op) {
1956 mt_count = -mt_count;
1959 if (tape->chrdev_dir == IDETAPE_DIR_READ) {
1960 tape->merge_bh_size = 0;
1961 if (test_and_clear_bit(IDETAPE_FLAG_FILEMARK, &tape->flags))
1963 ide_tape_discard_merge_buffer(drive, 0);
1969 idetape_create_space_cmd(&pc, mt_count - count,
1970 IDETAPE_SPACE_OVER_FILEMARK);
1971 return idetape_queue_pc_tail(drive, &pc);
1976 retval = idetape_space_over_filemarks(drive, MTFSF,
1980 count = (MTBSFM == mt_op ? 1 : -1);
1981 return idetape_space_over_filemarks(drive, MTFSF, count);
1983 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
1990 * Our character device read / write functions.
1992 * The tape is optimized to maximize throughput when it is transferring an
1993 * integral number of the "continuous transfer limit", which is a parameter of
1994 * the specific tape (26kB on my particular tape, 32kB for Onstream).
1996 * As of version 1.3 of the driver, the character device provides an abstract
1997 * continuous view of the media - any mix of block sizes (even 1 byte) on the
1998 * same backup/restore procedure is supported. The driver will internally
1999 * convert the requests to the recommended transfer unit, so that an unmatch
2000 * between the user's block size to the recommended size will only result in a
2001 * (slightly) increased driver overhead, but will no longer hit performance.
2002 * This is not applicable to Onstream.
2004 static ssize_t idetape_chrdev_read(struct file *file, char __user *buf,
2005 size_t count, loff_t *ppos)
2007 struct ide_tape_obj *tape = ide_tape_f(file);
2008 ide_drive_t *drive = tape->drive;
2009 ssize_t bytes_read, temp, actually_read = 0, rc;
2011 u16 ctl = *(u16 *)&tape->caps[12];
2013 debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
2015 if (tape->chrdev_dir != IDETAPE_DIR_READ) {
2016 if (test_bit(IDETAPE_FLAG_DETECT_BS, &tape->flags))
2017 if (count > tape->blk_size &&
2018 (count % tape->blk_size) == 0)
2019 tape->user_bs_factor = count / tape->blk_size;
2021 rc = idetape_init_read(drive);
2026 if (tape->merge_bh_size) {
2027 actually_read = min((unsigned int)(tape->merge_bh_size),
2028 (unsigned int)count);
2029 if (idetape_copy_stage_to_user(tape, buf, actually_read))
2031 buf += actually_read;
2032 tape->merge_bh_size -= actually_read;
2033 count -= actually_read;
2035 while (count >= tape->buffer_size) {
2036 bytes_read = idetape_add_chrdev_read_request(drive, ctl);
2037 if (bytes_read <= 0)
2039 if (idetape_copy_stage_to_user(tape, buf, bytes_read))
2042 count -= bytes_read;
2043 actually_read += bytes_read;
2046 bytes_read = idetape_add_chrdev_read_request(drive, ctl);
2047 if (bytes_read <= 0)
2049 temp = min((unsigned long)count, (unsigned long)bytes_read);
2050 if (idetape_copy_stage_to_user(tape, buf, temp))
2052 actually_read += temp;
2053 tape->merge_bh_size = bytes_read-temp;
2056 if (!actually_read && test_bit(IDETAPE_FLAG_FILEMARK, &tape->flags)) {
2057 debug_log(DBG_SENSE, "%s: spacing over filemark\n", tape->name);
2059 idetape_space_over_filemarks(drive, MTFSF, 1);
2063 return ret ? ret : actually_read;
2066 static ssize_t idetape_chrdev_write(struct file *file, const char __user *buf,
2067 size_t count, loff_t *ppos)
2069 struct ide_tape_obj *tape = ide_tape_f(file);
2070 ide_drive_t *drive = tape->drive;
2071 ssize_t actually_written = 0;
2073 u16 ctl = *(u16 *)&tape->caps[12];
2075 /* The drive is write protected. */
2076 if (tape->write_prot)
2079 debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
2081 /* Initialize write operation */
2082 if (tape->chrdev_dir != IDETAPE_DIR_WRITE) {
2083 if (tape->chrdev_dir == IDETAPE_DIR_READ)
2084 ide_tape_discard_merge_buffer(drive, 1);
2085 if (tape->merge_bh || tape->merge_bh_size) {
2086 printk(KERN_ERR "ide-tape: merge_bh_size "
2087 "should be 0 now\n");
2088 tape->merge_bh_size = 0;
2090 tape->merge_bh = ide_tape_kmalloc_buffer(tape, 0, 0);
2091 if (!tape->merge_bh)
2093 tape->chrdev_dir = IDETAPE_DIR_WRITE;
2094 idetape_init_merge_buffer(tape);
2097 * Issue a write 0 command to ensure that DSC handshake is
2098 * switched from completion mode to buffer available mode. No
2099 * point in issuing this if DSC overlap isn't supported, some
2100 * drives (Seagate STT3401A) will return an error.
2102 if (drive->dsc_overlap) {
2103 ssize_t retval = idetape_queue_rw_tail(drive,
2104 REQ_IDETAPE_WRITE, 0,
2107 ide_tape_kfree_buffer(tape);
2108 tape->merge_bh = NULL;
2109 tape->chrdev_dir = IDETAPE_DIR_NONE;
2116 if (tape->merge_bh_size) {
2117 if (tape->merge_bh_size >= tape->buffer_size) {
2118 printk(KERN_ERR "ide-tape: bug: merge buf too big\n");
2119 tape->merge_bh_size = 0;
2121 actually_written = min((unsigned int)
2122 (tape->buffer_size - tape->merge_bh_size),
2123 (unsigned int)count);
2124 if (idetape_copy_stage_from_user(tape, buf, actually_written))
2126 buf += actually_written;
2127 tape->merge_bh_size += actually_written;
2128 count -= actually_written;
2130 if (tape->merge_bh_size == tape->buffer_size) {
2132 tape->merge_bh_size = 0;
2133 retval = idetape_add_chrdev_write_request(drive, ctl);
2138 while (count >= tape->buffer_size) {
2140 if (idetape_copy_stage_from_user(tape, buf, tape->buffer_size))
2142 buf += tape->buffer_size;
2143 count -= tape->buffer_size;
2144 retval = idetape_add_chrdev_write_request(drive, ctl);
2145 actually_written += tape->buffer_size;
2150 actually_written += count;
2151 if (idetape_copy_stage_from_user(tape, buf, count))
2153 tape->merge_bh_size += count;
2155 return ret ? ret : actually_written;
2158 static int idetape_write_filemark(ide_drive_t *drive)
2160 struct ide_atapi_pc pc;
2162 /* Write a filemark */
2163 idetape_create_write_filemark_cmd(drive, &pc, 1);
2164 if (idetape_queue_pc_tail(drive, &pc)) {
2165 printk(KERN_ERR "ide-tape: Couldn't write a filemark\n");
2172 * Called from idetape_chrdev_ioctl when the general mtio MTIOCTOP ioctl is
2175 * Note: MTBSF and MTBSFM are not supported when the tape doesn't support
2176 * spacing over filemarks in the reverse direction. In this case, MTFSFM is also
2177 * usually not supported.
2179 * The following commands are currently not supported:
2181 * MTFSS, MTBSS, MTWSM, MTSETDENSITY, MTSETDRVBUFFER, MT_ST_BOOLEANS,
2182 * MT_ST_WRITE_THRESHOLD.
2184 static int idetape_mtioctop(ide_drive_t *drive, short mt_op, int mt_count)
2186 idetape_tape_t *tape = drive->driver_data;
2187 struct ide_atapi_pc pc;
2190 debug_log(DBG_ERR, "Handling MTIOCTOP ioctl: mt_op=%d, mt_count=%d\n",
2200 return idetape_space_over_filemarks(drive, mt_op, mt_count);
2207 if (tape->write_prot)
2209 ide_tape_discard_merge_buffer(drive, 1);
2210 for (i = 0; i < mt_count; i++) {
2211 retval = idetape_write_filemark(drive);
2217 ide_tape_discard_merge_buffer(drive, 0);
2218 if (idetape_rewind_tape(drive))
2222 ide_tape_discard_merge_buffer(drive, 0);
2223 idetape_create_load_unload_cmd(drive, &pc,
2224 IDETAPE_LU_LOAD_MASK);
2225 return idetape_queue_pc_tail(drive, &pc);
2229 * If door is locked, attempt to unlock before
2230 * attempting to eject.
2232 if (tape->door_locked) {
2233 if (idetape_create_prevent_cmd(drive, &pc, 0))
2234 if (!idetape_queue_pc_tail(drive, &pc))
2235 tape->door_locked = DOOR_UNLOCKED;
2237 ide_tape_discard_merge_buffer(drive, 0);
2238 idetape_create_load_unload_cmd(drive, &pc,
2239 !IDETAPE_LU_LOAD_MASK);
2240 retval = idetape_queue_pc_tail(drive, &pc);
2242 clear_bit(IDETAPE_FLAG_MEDIUM_PRESENT, &tape->flags);
2245 ide_tape_discard_merge_buffer(drive, 0);
2246 return idetape_flush_tape_buffers(drive);
2248 ide_tape_discard_merge_buffer(drive, 0);
2249 idetape_create_load_unload_cmd(drive, &pc,
2250 IDETAPE_LU_RETENSION_MASK | IDETAPE_LU_LOAD_MASK);
2251 return idetape_queue_pc_tail(drive, &pc);
2253 idetape_create_space_cmd(&pc, 0, IDETAPE_SPACE_TO_EOD);
2254 return idetape_queue_pc_tail(drive, &pc);
2256 (void)idetape_rewind_tape(drive);
2257 idetape_create_erase_cmd(&pc);
2258 return idetape_queue_pc_tail(drive, &pc);
2261 if (mt_count < tape->blk_size ||
2262 mt_count % tape->blk_size)
2264 tape->user_bs_factor = mt_count / tape->blk_size;
2265 clear_bit(IDETAPE_FLAG_DETECT_BS, &tape->flags);
2267 set_bit(IDETAPE_FLAG_DETECT_BS, &tape->flags);
2270 ide_tape_discard_merge_buffer(drive, 0);
2271 return idetape_position_tape(drive,
2272 mt_count * tape->user_bs_factor, tape->partition, 0);
2274 ide_tape_discard_merge_buffer(drive, 0);
2275 return idetape_position_tape(drive, 0, mt_count, 0);
2279 if (!idetape_create_prevent_cmd(drive, &pc, 1))
2281 retval = idetape_queue_pc_tail(drive, &pc);
2284 tape->door_locked = DOOR_EXPLICITLY_LOCKED;
2287 if (!idetape_create_prevent_cmd(drive, &pc, 0))
2289 retval = idetape_queue_pc_tail(drive, &pc);
2292 tape->door_locked = DOOR_UNLOCKED;
2295 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
2302 * Our character device ioctls. General mtio.h magnetic io commands are
2303 * supported here, and not in the corresponding block interface. Our own
2304 * ide-tape ioctls are supported on both interfaces.
2306 static int idetape_chrdev_ioctl(struct inode *inode, struct file *file,
2307 unsigned int cmd, unsigned long arg)
2309 struct ide_tape_obj *tape = ide_tape_f(file);
2310 ide_drive_t *drive = tape->drive;
2314 int block_offset = 0, position = tape->first_frame;
2315 void __user *argp = (void __user *)arg;
2317 debug_log(DBG_CHRDEV, "Enter %s, cmd=%u\n", __func__, cmd);
2319 if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
2320 ide_tape_flush_merge_buffer(drive);
2321 idetape_flush_tape_buffers(drive);
2323 if (cmd == MTIOCGET || cmd == MTIOCPOS) {
2324 block_offset = tape->merge_bh_size /
2325 (tape->blk_size * tape->user_bs_factor);
2326 position = idetape_read_position(drive);
2332 if (copy_from_user(&mtop, argp, sizeof(struct mtop)))
2334 return idetape_mtioctop(drive, mtop.mt_op, mtop.mt_count);
2336 memset(&mtget, 0, sizeof(struct mtget));
2337 mtget.mt_type = MT_ISSCSI2;
2338 mtget.mt_blkno = position / tape->user_bs_factor - block_offset;
2340 ((tape->blk_size * tape->user_bs_factor)
2341 << MT_ST_BLKSIZE_SHIFT) & MT_ST_BLKSIZE_MASK;
2343 if (tape->drv_write_prot)
2344 mtget.mt_gstat |= GMT_WR_PROT(0xffffffff);
2346 if (copy_to_user(argp, &mtget, sizeof(struct mtget)))
2350 mtpos.mt_blkno = position / tape->user_bs_factor - block_offset;
2351 if (copy_to_user(argp, &mtpos, sizeof(struct mtpos)))
2355 if (tape->chrdev_dir == IDETAPE_DIR_READ)
2356 ide_tape_discard_merge_buffer(drive, 1);
2357 return idetape_blkdev_ioctl(drive, cmd, arg);
2362 * Do a mode sense page 0 with block descriptor and if it succeeds set the tape
2363 * block size with the reported value.
2365 static void ide_tape_get_bsize_from_bdesc(ide_drive_t *drive)
2367 idetape_tape_t *tape = drive->driver_data;
2368 struct ide_atapi_pc pc;
2370 idetape_create_mode_sense_cmd(&pc, IDETAPE_BLOCK_DESCRIPTOR);
2371 if (idetape_queue_pc_tail(drive, &pc)) {
2372 printk(KERN_ERR "ide-tape: Can't get block descriptor\n");
2373 if (tape->blk_size == 0) {
2374 printk(KERN_WARNING "ide-tape: Cannot deal with zero "
2375 "block size, assuming 32k\n");
2376 tape->blk_size = 32768;
2380 tape->blk_size = (pc.buf[4 + 5] << 16) +
2381 (pc.buf[4 + 6] << 8) +
2383 tape->drv_write_prot = (pc.buf[2] & 0x80) >> 7;
2386 static int idetape_chrdev_open(struct inode *inode, struct file *filp)
2388 unsigned int minor = iminor(inode), i = minor & ~0xc0;
2390 idetape_tape_t *tape;
2391 struct ide_atapi_pc pc;
2394 if (i >= MAX_HWIFS * MAX_DRIVES)
2397 tape = ide_tape_chrdev_get(i);
2401 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
2404 * We really want to do nonseekable_open(inode, filp); here, but some
2405 * versions of tar incorrectly call lseek on tapes and bail out if that
2406 * fails. So we disallow pread() and pwrite(), but permit lseeks.
2408 filp->f_mode &= ~(FMODE_PREAD | FMODE_PWRITE);
2410 drive = tape->drive;
2412 filp->private_data = tape;
2414 if (test_and_set_bit(IDETAPE_FLAG_BUSY, &tape->flags)) {
2419 retval = idetape_wait_ready(drive, 60 * HZ);
2421 clear_bit(IDETAPE_FLAG_BUSY, &tape->flags);
2422 printk(KERN_ERR "ide-tape: %s: drive not ready\n", tape->name);
2426 idetape_read_position(drive);
2427 if (!test_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags))
2428 (void)idetape_rewind_tape(drive);
2430 /* Read block size and write protect status from drive. */
2431 ide_tape_get_bsize_from_bdesc(drive);
2433 /* Set write protect flag if device is opened as read-only. */
2434 if ((filp->f_flags & O_ACCMODE) == O_RDONLY)
2435 tape->write_prot = 1;
2437 tape->write_prot = tape->drv_write_prot;
2439 /* Make sure drive isn't write protected if user wants to write. */
2440 if (tape->write_prot) {
2441 if ((filp->f_flags & O_ACCMODE) == O_WRONLY ||
2442 (filp->f_flags & O_ACCMODE) == O_RDWR) {
2443 clear_bit(IDETAPE_FLAG_BUSY, &tape->flags);
2449 /* Lock the tape drive door so user can't eject. */
2450 if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
2451 if (idetape_create_prevent_cmd(drive, &pc, 1)) {
2452 if (!idetape_queue_pc_tail(drive, &pc)) {
2453 if (tape->door_locked != DOOR_EXPLICITLY_LOCKED)
2454 tape->door_locked = DOOR_LOCKED;
2465 static void idetape_write_release(ide_drive_t *drive, unsigned int minor)
2467 idetape_tape_t *tape = drive->driver_data;
2469 ide_tape_flush_merge_buffer(drive);
2470 tape->merge_bh = ide_tape_kmalloc_buffer(tape, 1, 0);
2471 if (tape->merge_bh != NULL) {
2472 idetape_pad_zeros(drive, tape->blk_size *
2473 (tape->user_bs_factor - 1));
2474 ide_tape_kfree_buffer(tape);
2475 tape->merge_bh = NULL;
2477 idetape_write_filemark(drive);
2478 idetape_flush_tape_buffers(drive);
2479 idetape_flush_tape_buffers(drive);
2482 static int idetape_chrdev_release(struct inode *inode, struct file *filp)
2484 struct ide_tape_obj *tape = ide_tape_f(filp);
2485 ide_drive_t *drive = tape->drive;
2486 struct ide_atapi_pc pc;
2487 unsigned int minor = iminor(inode);
2490 tape = drive->driver_data;
2492 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
2494 if (tape->chrdev_dir == IDETAPE_DIR_WRITE)
2495 idetape_write_release(drive, minor);
2496 if (tape->chrdev_dir == IDETAPE_DIR_READ) {
2498 ide_tape_discard_merge_buffer(drive, 1);
2501 if (minor < 128 && test_bit(IDETAPE_FLAG_MEDIUM_PRESENT, &tape->flags))
2502 (void) idetape_rewind_tape(drive);
2503 if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
2504 if (tape->door_locked == DOOR_LOCKED) {
2505 if (idetape_create_prevent_cmd(drive, &pc, 0)) {
2506 if (!idetape_queue_pc_tail(drive, &pc))
2507 tape->door_locked = DOOR_UNLOCKED;
2511 clear_bit(IDETAPE_FLAG_BUSY, &tape->flags);
2518 * check the contents of the ATAPI IDENTIFY command results. We return:
2520 * 1 - If the tape can be supported by us, based on the information we have so
2523 * 0 - If this tape driver is not currently supported by us.
2525 static int idetape_identify_device(ide_drive_t *drive)
2527 u8 gcw[2], protocol, device_type, removable, packet_size;
2529 if (drive->id_read == 0)
2532 *((unsigned short *) &gcw) = drive->id->config;
2534 protocol = (gcw[1] & 0xC0) >> 6;
2535 device_type = gcw[1] & 0x1F;
2536 removable = !!(gcw[0] & 0x80);
2537 packet_size = gcw[0] & 0x3;
2539 /* Check that we can support this device */
2541 printk(KERN_ERR "ide-tape: Protocol (0x%02x) is not ATAPI\n",
2543 else if (device_type != 1)
2544 printk(KERN_ERR "ide-tape: Device type (0x%02x) is not set "
2545 "to tape\n", device_type);
2546 else if (!removable)
2547 printk(KERN_ERR "ide-tape: The removable flag is not set\n");
2548 else if (packet_size != 0) {
2549 printk(KERN_ERR "ide-tape: Packet size (0x%02x) is not 12"
2550 " bytes\n", packet_size);
2556 static void idetape_get_inquiry_results(ide_drive_t *drive)
2558 idetape_tape_t *tape = drive->driver_data;
2559 struct ide_atapi_pc pc;
2560 char fw_rev[6], vendor_id[10], product_id[18];
2562 idetape_create_inquiry_cmd(&pc);
2563 if (idetape_queue_pc_tail(drive, &pc)) {
2564 printk(KERN_ERR "ide-tape: %s: can't get INQUIRY results\n",
2568 memcpy(vendor_id, &pc.buf[8], 8);
2569 memcpy(product_id, &pc.buf[16], 16);
2570 memcpy(fw_rev, &pc.buf[32], 4);
2572 ide_fixstring(vendor_id, 10, 0);
2573 ide_fixstring(product_id, 18, 0);
2574 ide_fixstring(fw_rev, 6, 0);
2576 printk(KERN_INFO "ide-tape: %s <-> %s: %s %s rev %s\n",
2577 drive->name, tape->name, vendor_id, product_id, fw_rev);
2581 * Ask the tape about its various parameters. In particular, we will adjust our
2582 * data transfer buffer size to the recommended value as returned by the tape.
2584 static void idetape_get_mode_sense_results(ide_drive_t *drive)
2586 idetape_tape_t *tape = drive->driver_data;
2587 struct ide_atapi_pc pc;
2589 u8 speed, max_speed;
2591 idetape_create_mode_sense_cmd(&pc, IDETAPE_CAPABILITIES_PAGE);
2592 if (idetape_queue_pc_tail(drive, &pc)) {
2593 printk(KERN_ERR "ide-tape: Can't get tape parameters - assuming"
2594 " some default values\n");
2595 tape->blk_size = 512;
2596 put_unaligned(52, (u16 *)&tape->caps[12]);
2597 put_unaligned(540, (u16 *)&tape->caps[14]);
2598 put_unaligned(6*52, (u16 *)&tape->caps[16]);
2601 caps = pc.buf + 4 + pc.buf[3];
2603 /* convert to host order and save for later use */
2604 speed = be16_to_cpu(*(u16 *)&caps[14]);
2605 max_speed = be16_to_cpu(*(u16 *)&caps[8]);
2607 put_unaligned(max_speed, (u16 *)&caps[8]);
2608 put_unaligned(be16_to_cpu(*(u16 *)&caps[12]), (u16 *)&caps[12]);
2609 put_unaligned(speed, (u16 *)&caps[14]);
2610 put_unaligned(be16_to_cpu(*(u16 *)&caps[16]), (u16 *)&caps[16]);
2613 printk(KERN_INFO "ide-tape: %s: invalid tape speed "
2614 "(assuming 650KB/sec)\n", drive->name);
2615 put_unaligned(650, (u16 *)&caps[14]);
2618 printk(KERN_INFO "ide-tape: %s: invalid max_speed "
2619 "(assuming 650KB/sec)\n", drive->name);
2620 put_unaligned(650, (u16 *)&caps[8]);
2623 memcpy(&tape->caps, caps, 20);
2625 tape->blk_size = 512;
2626 else if (caps[7] & 0x04)
2627 tape->blk_size = 1024;
2630 #ifdef CONFIG_IDE_PROC_FS
2631 static void idetape_add_settings(ide_drive_t *drive)
2633 idetape_tape_t *tape = drive->driver_data;
2635 ide_add_setting(drive, "buffer", SETTING_READ, TYPE_SHORT, 0, 0xffff,
2636 1, 2, (u16 *)&tape->caps[16], NULL);
2637 ide_add_setting(drive, "speed", SETTING_READ, TYPE_SHORT, 0, 0xffff,
2638 1, 1, (u16 *)&tape->caps[14], NULL);
2639 ide_add_setting(drive, "buffer_size", SETTING_READ, TYPE_INT, 0, 0xffff,
2640 1, 1024, &tape->buffer_size, NULL);
2641 ide_add_setting(drive, "tdsc", SETTING_RW, TYPE_INT, IDETAPE_DSC_RW_MIN,
2642 IDETAPE_DSC_RW_MAX, 1000, HZ, &tape->best_dsc_rw_freq,
2644 ide_add_setting(drive, "dsc_overlap", SETTING_RW, TYPE_BYTE, 0, 1, 1,
2645 1, &drive->dsc_overlap, NULL);
2646 ide_add_setting(drive, "avg_speed", SETTING_READ, TYPE_INT, 0, 0xffff,
2647 1, 1, &tape->avg_speed, NULL);
2648 ide_add_setting(drive, "debug_mask", SETTING_RW, TYPE_INT, 0, 0xffff, 1,
2649 1, &tape->debug_mask, NULL);
2652 static inline void idetape_add_settings(ide_drive_t *drive) { ; }
2656 * The function below is called to:
2658 * 1. Initialize our various state variables.
2659 * 2. Ask the tape for its capabilities.
2660 * 3. Allocate a buffer which will be used for data transfer. The buffer size
2661 * is chosen based on the recommendation which we received in step 2.
2663 * Note that at this point ide.c already assigned us an irq, so that we can
2664 * queue requests here and wait for their completion.
2666 static void idetape_setup(ide_drive_t *drive, idetape_tape_t *tape, int minor)
2672 u16 *ctl = (u16 *)&tape->caps[12];
2674 spin_lock_init(&tape->lock);
2675 drive->dsc_overlap = 1;
2676 if (drive->hwif->host_flags & IDE_HFLAG_NO_DSC) {
2677 printk(KERN_INFO "ide-tape: %s: disabling DSC overlap\n",
2679 drive->dsc_overlap = 0;
2681 /* Seagate Travan drives do not support DSC overlap. */
2682 if (strstr(drive->id->model, "Seagate STT3401"))
2683 drive->dsc_overlap = 0;
2684 tape->minor = minor;
2685 tape->name[0] = 'h';
2686 tape->name[1] = 't';
2687 tape->name[2] = '0' + minor;
2688 tape->chrdev_dir = IDETAPE_DIR_NONE;
2689 tape->pc = tape->pc_stack;
2690 *((unsigned short *) &gcw) = drive->id->config;
2692 /* Command packet DRQ type */
2693 if (((gcw[0] & 0x60) >> 5) == 1)
2694 set_bit(IDETAPE_FLAG_DRQ_INTERRUPT, &tape->flags);
2696 idetape_get_inquiry_results(drive);
2697 idetape_get_mode_sense_results(drive);
2698 ide_tape_get_bsize_from_bdesc(drive);
2699 tape->user_bs_factor = 1;
2700 tape->buffer_size = *ctl * tape->blk_size;
2701 while (tape->buffer_size > 0xffff) {
2702 printk(KERN_NOTICE "ide-tape: decreasing stage size\n");
2704 tape->buffer_size = *ctl * tape->blk_size;
2706 buffer_size = tape->buffer_size;
2707 tape->pages_per_buffer = buffer_size / PAGE_SIZE;
2708 if (buffer_size % PAGE_SIZE) {
2709 tape->pages_per_buffer++;
2710 tape->excess_bh_size = PAGE_SIZE - buffer_size % PAGE_SIZE;
2713 /* select the "best" DSC read/write polling freq */
2714 speed = max(*(u16 *)&tape->caps[14], *(u16 *)&tape->caps[8]);
2716 t = (IDETAPE_FIFO_THRESHOLD * tape->buffer_size * HZ) / (speed * 1000);
2719 * Ensure that the number we got makes sense; limit it within
2720 * IDETAPE_DSC_RW_MIN and IDETAPE_DSC_RW_MAX.
2722 tape->best_dsc_rw_freq = clamp_t(unsigned long, t, IDETAPE_DSC_RW_MIN,
2723 IDETAPE_DSC_RW_MAX);
2724 printk(KERN_INFO "ide-tape: %s <-> %s: %dKBps, %d*%dkB buffer, "
2726 drive->name, tape->name, *(u16 *)&tape->caps[14],
2727 (*(u16 *)&tape->caps[16] * 512) / tape->buffer_size,
2728 tape->buffer_size / 1024,
2729 tape->best_dsc_rw_freq * 1000 / HZ,
2730 drive->using_dma ? ", DMA":"");
2732 idetape_add_settings(drive);
2735 static void ide_tape_remove(ide_drive_t *drive)
2737 idetape_tape_t *tape = drive->driver_data;
2739 ide_proc_unregister_driver(drive, tape->driver);
2741 ide_unregister_region(tape->disk);
2746 static void ide_tape_release(struct kref *kref)
2748 struct ide_tape_obj *tape = to_ide_tape(kref);
2749 ide_drive_t *drive = tape->drive;
2750 struct gendisk *g = tape->disk;
2752 BUG_ON(tape->merge_bh_size);
2754 drive->dsc_overlap = 0;
2755 drive->driver_data = NULL;
2756 device_destroy(idetape_sysfs_class, MKDEV(IDETAPE_MAJOR, tape->minor));
2757 device_destroy(idetape_sysfs_class,
2758 MKDEV(IDETAPE_MAJOR, tape->minor + 128));
2759 idetape_devs[tape->minor] = NULL;
2760 g->private_data = NULL;
2765 #ifdef CONFIG_IDE_PROC_FS
2766 static int proc_idetape_read_name
2767 (char *page, char **start, off_t off, int count, int *eof, void *data)
2769 ide_drive_t *drive = (ide_drive_t *) data;
2770 idetape_tape_t *tape = drive->driver_data;
2774 len = sprintf(out, "%s\n", tape->name);
2775 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
2778 static ide_proc_entry_t idetape_proc[] = {
2779 { "capacity", S_IFREG|S_IRUGO, proc_ide_read_capacity, NULL },
2780 { "name", S_IFREG|S_IRUGO, proc_idetape_read_name, NULL },
2781 { NULL, 0, NULL, NULL }
2785 static int ide_tape_probe(ide_drive_t *);
2787 static ide_driver_t idetape_driver = {
2789 .owner = THIS_MODULE,
2791 .bus = &ide_bus_type,
2793 .probe = ide_tape_probe,
2794 .remove = ide_tape_remove,
2795 .version = IDETAPE_VERSION,
2797 .supports_dsc_overlap = 1,
2798 .do_request = idetape_do_request,
2799 .end_request = idetape_end_request,
2800 .error = __ide_error,
2801 .abort = __ide_abort,
2802 #ifdef CONFIG_IDE_PROC_FS
2803 .proc = idetape_proc,
2807 /* Our character device supporting functions, passed to register_chrdev. */
2808 static const struct file_operations idetape_fops = {
2809 .owner = THIS_MODULE,
2810 .read = idetape_chrdev_read,
2811 .write = idetape_chrdev_write,
2812 .ioctl = idetape_chrdev_ioctl,
2813 .open = idetape_chrdev_open,
2814 .release = idetape_chrdev_release,
2817 static int idetape_open(struct inode *inode, struct file *filp)
2819 struct gendisk *disk = inode->i_bdev->bd_disk;
2820 struct ide_tape_obj *tape;
2822 tape = ide_tape_get(disk);
2829 static int idetape_release(struct inode *inode, struct file *filp)
2831 struct gendisk *disk = inode->i_bdev->bd_disk;
2832 struct ide_tape_obj *tape = ide_tape_g(disk);
2839 static int idetape_ioctl(struct inode *inode, struct file *file,
2840 unsigned int cmd, unsigned long arg)
2842 struct block_device *bdev = inode->i_bdev;
2843 struct ide_tape_obj *tape = ide_tape_g(bdev->bd_disk);
2844 ide_drive_t *drive = tape->drive;
2845 int err = generic_ide_ioctl(drive, file, bdev, cmd, arg);
2847 err = idetape_blkdev_ioctl(drive, cmd, arg);
2851 static struct block_device_operations idetape_block_ops = {
2852 .owner = THIS_MODULE,
2853 .open = idetape_open,
2854 .release = idetape_release,
2855 .ioctl = idetape_ioctl,
2858 static int ide_tape_probe(ide_drive_t *drive)
2860 idetape_tape_t *tape;
2864 if (!strstr("ide-tape", drive->driver_req))
2866 if (!drive->present)
2868 if (drive->media != ide_tape)
2870 if (!idetape_identify_device(drive)) {
2871 printk(KERN_ERR "ide-tape: %s: not supported by this version of"
2872 " the driver\n", drive->name);
2876 printk(KERN_INFO "ide-tape: passing drive %s to ide-scsi"
2877 " emulation.\n", drive->name);
2880 tape = kzalloc(sizeof(idetape_tape_t), GFP_KERNEL);
2882 printk(KERN_ERR "ide-tape: %s: Can't allocate a tape struct\n",
2887 g = alloc_disk(1 << PARTN_BITS);
2891 ide_init_disk(g, drive);
2893 ide_proc_register_driver(drive, &idetape_driver);
2895 kref_init(&tape->kref);
2897 tape->drive = drive;
2898 tape->driver = &idetape_driver;
2901 g->private_data = &tape->driver;
2903 drive->driver_data = tape;
2905 mutex_lock(&idetape_ref_mutex);
2906 for (minor = 0; idetape_devs[minor]; minor++)
2908 idetape_devs[minor] = tape;
2909 mutex_unlock(&idetape_ref_mutex);
2911 idetape_setup(drive, tape, minor);
2913 device_create(idetape_sysfs_class, &drive->gendev,
2914 MKDEV(IDETAPE_MAJOR, minor), "%s", tape->name);
2915 device_create(idetape_sysfs_class, &drive->gendev,
2916 MKDEV(IDETAPE_MAJOR, minor + 128), "n%s", tape->name);
2918 g->fops = &idetape_block_ops;
2919 ide_register_region(g);
2929 static void __exit idetape_exit(void)
2931 driver_unregister(&idetape_driver.gen_driver);
2932 class_destroy(idetape_sysfs_class);
2933 unregister_chrdev(IDETAPE_MAJOR, "ht");
2936 static int __init idetape_init(void)
2939 idetape_sysfs_class = class_create(THIS_MODULE, "ide_tape");
2940 if (IS_ERR(idetape_sysfs_class)) {
2941 idetape_sysfs_class = NULL;
2942 printk(KERN_ERR "Unable to create sysfs class for ide tapes\n");
2947 if (register_chrdev(IDETAPE_MAJOR, "ht", &idetape_fops)) {
2948 printk(KERN_ERR "ide-tape: Failed to register chrdev"
2951 goto out_free_class;
2954 error = driver_register(&idetape_driver.gen_driver);
2956 goto out_free_driver;
2961 driver_unregister(&idetape_driver.gen_driver);
2963 class_destroy(idetape_sysfs_class);
2968 MODULE_ALIAS("ide:*m-tape*");
2969 module_init(idetape_init);
2970 module_exit(idetape_exit);
2971 MODULE_ALIAS_CHARDEV_MAJOR(IDETAPE_MAJOR);
2972 MODULE_DESCRIPTION("ATAPI Streaming TAPE Driver");
2973 MODULE_LICENSE("GPL");