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 "%s: I/O error in request sense"
780 " command\n", drive->name);
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 "%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 return idetape_retry_pc(drive);
1084 if (tape->failed_pc == pc)
1085 tape->failed_pc = NULL;
1087 pc->error = IDETAPE_ERROR_GENERAL;
1088 tape->failed_pc = NULL;
1090 return pc->idetape_callback(drive);
1093 static ide_startstop_t idetape_rw_callback(ide_drive_t *drive)
1095 idetape_tape_t *tape = drive->driver_data;
1096 struct request *rq = HWGROUP(drive)->rq;
1097 int blocks = tape->pc->xferred / tape->blk_size;
1099 tape->avg_size += blocks * tape->blk_size;
1101 if (time_after_eq(jiffies, tape->avg_time + HZ)) {
1102 tape->avg_speed = tape->avg_size * HZ /
1103 (jiffies - tape->avg_time) / 1024;
1105 tape->avg_time = jiffies;
1107 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1109 tape->first_frame += blocks;
1110 rq->current_nr_sectors -= blocks;
1112 if (!tape->pc->error)
1113 idetape_end_request(drive, 1, 0);
1115 idetape_end_request(drive, tape->pc->error, 0);
1119 static void idetape_create_read_cmd(idetape_tape_t *tape,
1120 struct ide_atapi_pc *pc,
1121 unsigned int length, struct idetape_bh *bh)
1123 idetape_init_pc(pc);
1125 put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
1127 pc->idetape_callback = &idetape_rw_callback;
1129 atomic_set(&bh->b_count, 0);
1131 pc->buf_size = length * tape->blk_size;
1132 pc->req_xfer = pc->buf_size;
1133 if (pc->req_xfer == tape->buffer_size)
1134 pc->flags |= PC_FLAG_DMA_RECOMMENDED;
1137 static void idetape_create_write_cmd(idetape_tape_t *tape,
1138 struct ide_atapi_pc *pc,
1139 unsigned int length, struct idetape_bh *bh)
1141 idetape_init_pc(pc);
1143 put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
1145 pc->idetape_callback = &idetape_rw_callback;
1146 pc->flags |= PC_FLAG_WRITING;
1148 pc->b_data = bh->b_data;
1149 pc->b_count = atomic_read(&bh->b_count);
1151 pc->buf_size = length * tape->blk_size;
1152 pc->req_xfer = pc->buf_size;
1153 if (pc->req_xfer == tape->buffer_size)
1154 pc->flags |= PC_FLAG_DMA_RECOMMENDED;
1157 static ide_startstop_t idetape_do_request(ide_drive_t *drive,
1158 struct request *rq, sector_t block)
1160 idetape_tape_t *tape = drive->driver_data;
1161 struct ide_atapi_pc *pc = NULL;
1162 struct request *postponed_rq = tape->postponed_rq;
1165 debug_log(DBG_SENSE, "sector: %ld, nr_sectors: %ld,"
1166 " current_nr_sectors: %d\n",
1167 rq->sector, rq->nr_sectors, rq->current_nr_sectors);
1169 if (!blk_special_request(rq)) {
1170 /* We do not support buffer cache originated requests. */
1171 printk(KERN_NOTICE "ide-tape: %s: Unsupported request in "
1172 "request queue (%d)\n", drive->name, rq->cmd_type);
1173 ide_end_request(drive, 0, 0);
1177 /* Retry a failed packet command */
1178 if (tape->failed_pc && tape->pc->c[0] == REQUEST_SENSE)
1179 return idetape_issue_pc(drive, tape->failed_pc);
1181 if (postponed_rq != NULL)
1182 if (rq != postponed_rq) {
1183 printk(KERN_ERR "ide-tape: ide-tape.c bug - "
1184 "Two DSC requests were queued\n");
1185 idetape_end_request(drive, 0, 0);
1189 tape->postponed_rq = NULL;
1192 * If the tape is still busy, postpone our request and service
1193 * the other device meanwhile.
1195 stat = ide_read_status(drive);
1197 if (!drive->dsc_overlap && !(rq->cmd[0] & REQ_IDETAPE_PC2))
1198 set_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags);
1200 if (drive->post_reset == 1) {
1201 set_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags);
1202 drive->post_reset = 0;
1205 if (!test_and_clear_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags) &&
1206 (stat & SEEK_STAT) == 0) {
1207 if (postponed_rq == NULL) {
1208 tape->dsc_polling_start = jiffies;
1209 tape->dsc_poll_freq = tape->best_dsc_rw_freq;
1210 tape->dsc_timeout = jiffies + IDETAPE_DSC_RW_TIMEOUT;
1211 } else if (time_after(jiffies, tape->dsc_timeout)) {
1212 printk(KERN_ERR "ide-tape: %s: DSC timeout\n",
1214 if (rq->cmd[0] & REQ_IDETAPE_PC2) {
1215 idetape_media_access_finished(drive);
1218 return ide_do_reset(drive);
1220 } else if (time_after(jiffies,
1221 tape->dsc_polling_start +
1222 IDETAPE_DSC_MA_THRESHOLD))
1223 tape->dsc_poll_freq = IDETAPE_DSC_MA_SLOW;
1224 idetape_postpone_request(drive);
1227 if (rq->cmd[0] & REQ_IDETAPE_READ) {
1228 pc = idetape_next_pc_storage(drive);
1229 idetape_create_read_cmd(tape, pc, rq->current_nr_sectors,
1230 (struct idetape_bh *)rq->special);
1233 if (rq->cmd[0] & REQ_IDETAPE_WRITE) {
1234 pc = idetape_next_pc_storage(drive);
1235 idetape_create_write_cmd(tape, pc, rq->current_nr_sectors,
1236 (struct idetape_bh *)rq->special);
1239 if (rq->cmd[0] & REQ_IDETAPE_PC1) {
1240 pc = (struct ide_atapi_pc *) rq->buffer;
1241 rq->cmd[0] &= ~(REQ_IDETAPE_PC1);
1242 rq->cmd[0] |= REQ_IDETAPE_PC2;
1245 if (rq->cmd[0] & REQ_IDETAPE_PC2) {
1246 idetape_media_access_finished(drive);
1251 return idetape_issue_pc(drive, pc);
1255 * The function below uses __get_free_pages to allocate a data buffer of size
1256 * tape->buffer_size (or a bit more). We attempt to combine sequential pages as
1259 * It returns a pointer to the newly allocated buffer, or NULL in case of
1262 static struct idetape_bh *ide_tape_kmalloc_buffer(idetape_tape_t *tape,
1263 int full, int clear)
1265 struct idetape_bh *prev_bh, *bh, *merge_bh;
1266 int pages = tape->pages_per_buffer;
1267 unsigned int order, b_allocd;
1268 char *b_data = NULL;
1270 merge_bh = kmalloc(sizeof(struct idetape_bh), GFP_KERNEL);
1275 order = fls(pages) - 1;
1276 bh->b_data = (char *) __get_free_pages(GFP_KERNEL, order);
1279 b_allocd = (1 << order) * PAGE_SIZE;
1283 memset(bh->b_data, 0, b_allocd);
1284 bh->b_reqnext = NULL;
1285 bh->b_size = b_allocd;
1286 atomic_set(&bh->b_count, full ? bh->b_size : 0);
1289 order = fls(pages) - 1;
1290 b_data = (char *) __get_free_pages(GFP_KERNEL, order);
1293 b_allocd = (1 << order) * PAGE_SIZE;
1296 memset(b_data, 0, b_allocd);
1298 /* newly allocated page frames below buffer header or ...*/
1299 if (bh->b_data == b_data + b_allocd) {
1300 bh->b_size += b_allocd;
1301 bh->b_data -= b_allocd;
1303 atomic_add(b_allocd, &bh->b_count);
1306 /* they are above the header */
1307 if (b_data == bh->b_data + bh->b_size) {
1308 bh->b_size += b_allocd;
1310 atomic_add(b_allocd, &bh->b_count);
1314 bh = kmalloc(sizeof(struct idetape_bh), GFP_KERNEL);
1316 free_pages((unsigned long) b_data, order);
1319 bh->b_reqnext = NULL;
1320 bh->b_data = b_data;
1321 bh->b_size = b_allocd;
1322 atomic_set(&bh->b_count, full ? bh->b_size : 0);
1323 prev_bh->b_reqnext = bh;
1328 bh->b_size -= tape->excess_bh_size;
1330 atomic_sub(tape->excess_bh_size, &bh->b_count);
1333 ide_tape_kfree_buffer(tape);
1337 static int idetape_copy_stage_from_user(idetape_tape_t *tape,
1338 const char __user *buf, int n)
1340 struct idetape_bh *bh = tape->bh;
1346 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
1350 count = min((unsigned int)
1351 (bh->b_size - atomic_read(&bh->b_count)),
1353 if (copy_from_user(bh->b_data + atomic_read(&bh->b_count), buf,
1357 atomic_add(count, &bh->b_count);
1359 if (atomic_read(&bh->b_count) == bh->b_size) {
1362 atomic_set(&bh->b_count, 0);
1369 static int idetape_copy_stage_to_user(idetape_tape_t *tape, char __user *buf,
1372 struct idetape_bh *bh = tape->bh;
1378 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
1382 count = min(tape->b_count, n);
1383 if (copy_to_user(buf, tape->b_data, count))
1386 tape->b_data += count;
1387 tape->b_count -= count;
1389 if (!tape->b_count) {
1393 tape->b_data = bh->b_data;
1394 tape->b_count = atomic_read(&bh->b_count);
1401 static void idetape_init_merge_buffer(idetape_tape_t *tape)
1403 struct idetape_bh *bh = tape->merge_bh;
1404 tape->bh = tape->merge_bh;
1406 if (tape->chrdev_dir == IDETAPE_DIR_WRITE)
1407 atomic_set(&bh->b_count, 0);
1409 tape->b_data = bh->b_data;
1410 tape->b_count = atomic_read(&bh->b_count);
1414 static ide_startstop_t idetape_read_position_callback(ide_drive_t *drive)
1416 idetape_tape_t *tape = drive->driver_data;
1417 u8 *readpos = tape->pc->buf;
1419 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1421 if (!tape->pc->error) {
1422 debug_log(DBG_SENSE, "BOP - %s\n",
1423 (readpos[0] & 0x80) ? "Yes" : "No");
1424 debug_log(DBG_SENSE, "EOP - %s\n",
1425 (readpos[0] & 0x40) ? "Yes" : "No");
1427 if (readpos[0] & 0x4) {
1428 printk(KERN_INFO "ide-tape: Block location is unknown"
1430 clear_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags);
1431 idetape_end_request(drive, 0, 0);
1433 debug_log(DBG_SENSE, "Block Location - %u\n",
1434 be32_to_cpu(*(u32 *)&readpos[4]));
1436 tape->partition = readpos[1];
1438 be32_to_cpu(*(u32 *)&readpos[4]);
1439 set_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags);
1440 idetape_end_request(drive, 1, 0);
1443 idetape_end_request(drive, 0, 0);
1449 * Write a filemark if write_filemark=1. Flush the device buffers without
1450 * writing a filemark otherwise.
1452 static void idetape_create_write_filemark_cmd(ide_drive_t *drive,
1453 struct ide_atapi_pc *pc, int write_filemark)
1455 idetape_init_pc(pc);
1456 pc->c[0] = WRITE_FILEMARKS;
1457 pc->c[4] = write_filemark;
1458 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1459 pc->idetape_callback = &idetape_pc_callback;
1462 static void idetape_create_test_unit_ready_cmd(struct ide_atapi_pc *pc)
1464 idetape_init_pc(pc);
1465 pc->c[0] = TEST_UNIT_READY;
1466 pc->idetape_callback = &idetape_pc_callback;
1470 * We add a special packet command request to the tail of the request queue, and
1471 * wait for it to be serviced. This is not to be called from within the request
1472 * handling part of the driver! We allocate here data on the stack and it is
1473 * valid until the request is finished. This is not the case for the bottom part
1474 * of the driver, where we are always leaving the functions to wait for an
1475 * interrupt or a timer event.
1477 * From the bottom part of the driver, we should allocate safe memory using
1478 * idetape_next_pc_storage() and ide_tape_next_rq_storage(), and add the request
1479 * to the request list without waiting for it to be serviced! In that case, we
1480 * usually use idetape_queue_pc_head().
1482 static int idetape_queue_pc_tail(ide_drive_t *drive, struct ide_atapi_pc *pc)
1484 struct ide_tape_obj *tape = drive->driver_data;
1488 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
1489 rq->cmd_type = REQ_TYPE_SPECIAL;
1490 rq->cmd[0] = REQ_IDETAPE_PC1;
1491 rq->buffer = (char *)pc;
1492 error = blk_execute_rq(drive->queue, tape->disk, rq, 0);
1493 blk_put_request(rq);
1497 static void idetape_create_load_unload_cmd(ide_drive_t *drive,
1498 struct ide_atapi_pc *pc, int cmd)
1500 idetape_init_pc(pc);
1501 pc->c[0] = START_STOP;
1503 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1504 pc->idetape_callback = &idetape_pc_callback;
1507 static int idetape_wait_ready(ide_drive_t *drive, unsigned long timeout)
1509 idetape_tape_t *tape = drive->driver_data;
1510 struct ide_atapi_pc pc;
1511 int load_attempted = 0;
1513 /* Wait for the tape to become ready */
1514 set_bit(IDETAPE_FLAG_MEDIUM_PRESENT, &tape->flags);
1516 while (time_before(jiffies, timeout)) {
1517 idetape_create_test_unit_ready_cmd(&pc);
1518 if (!idetape_queue_pc_tail(drive, &pc))
1520 if ((tape->sense_key == 2 && tape->asc == 4 && tape->ascq == 2)
1521 || (tape->asc == 0x3A)) {
1525 idetape_create_load_unload_cmd(drive, &pc,
1526 IDETAPE_LU_LOAD_MASK);
1527 idetape_queue_pc_tail(drive, &pc);
1529 /* not about to be ready */
1530 } else if (!(tape->sense_key == 2 && tape->asc == 4 &&
1531 (tape->ascq == 1 || tape->ascq == 8)))
1538 static int idetape_flush_tape_buffers(ide_drive_t *drive)
1540 struct ide_atapi_pc pc;
1543 idetape_create_write_filemark_cmd(drive, &pc, 0);
1544 rc = idetape_queue_pc_tail(drive, &pc);
1547 idetape_wait_ready(drive, 60 * 5 * HZ);
1551 static void idetape_create_read_position_cmd(struct ide_atapi_pc *pc)
1553 idetape_init_pc(pc);
1554 pc->c[0] = READ_POSITION;
1556 pc->idetape_callback = &idetape_read_position_callback;
1559 static int idetape_read_position(ide_drive_t *drive)
1561 idetape_tape_t *tape = drive->driver_data;
1562 struct ide_atapi_pc pc;
1565 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1567 idetape_create_read_position_cmd(&pc);
1568 if (idetape_queue_pc_tail(drive, &pc))
1570 position = tape->first_frame;
1574 static void idetape_create_locate_cmd(ide_drive_t *drive,
1575 struct ide_atapi_pc *pc,
1576 unsigned int block, u8 partition, int skip)
1578 idetape_init_pc(pc);
1579 pc->c[0] = POSITION_TO_ELEMENT;
1581 put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[3]);
1582 pc->c[8] = partition;
1583 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1584 pc->idetape_callback = &idetape_pc_callback;
1587 static int idetape_create_prevent_cmd(ide_drive_t *drive,
1588 struct ide_atapi_pc *pc, int prevent)
1590 idetape_tape_t *tape = drive->driver_data;
1592 /* device supports locking according to capabilities page */
1593 if (!(tape->caps[6] & 0x01))
1596 idetape_init_pc(pc);
1597 pc->c[0] = ALLOW_MEDIUM_REMOVAL;
1599 pc->idetape_callback = &idetape_pc_callback;
1603 static void __ide_tape_discard_merge_buffer(ide_drive_t *drive)
1605 idetape_tape_t *tape = drive->driver_data;
1607 if (tape->chrdev_dir != IDETAPE_DIR_READ)
1610 clear_bit(IDETAPE_FLAG_FILEMARK, &tape->flags);
1611 tape->merge_bh_size = 0;
1612 if (tape->merge_bh != NULL) {
1613 ide_tape_kfree_buffer(tape);
1614 tape->merge_bh = NULL;
1617 tape->chrdev_dir = IDETAPE_DIR_NONE;
1621 * Position the tape to the requested block using the LOCATE packet command.
1622 * A READ POSITION command is then issued to check where we are positioned. Like
1623 * all higher level operations, we queue the commands at the tail of the request
1624 * queue and wait for their completion.
1626 static int idetape_position_tape(ide_drive_t *drive, unsigned int block,
1627 u8 partition, int skip)
1629 idetape_tape_t *tape = drive->driver_data;
1631 struct ide_atapi_pc pc;
1633 if (tape->chrdev_dir == IDETAPE_DIR_READ)
1634 __ide_tape_discard_merge_buffer(drive);
1635 idetape_wait_ready(drive, 60 * 5 * HZ);
1636 idetape_create_locate_cmd(drive, &pc, block, partition, skip);
1637 retval = idetape_queue_pc_tail(drive, &pc);
1641 idetape_create_read_position_cmd(&pc);
1642 return (idetape_queue_pc_tail(drive, &pc));
1645 static void ide_tape_discard_merge_buffer(ide_drive_t *drive,
1646 int restore_position)
1648 idetape_tape_t *tape = drive->driver_data;
1651 __ide_tape_discard_merge_buffer(drive);
1652 if (restore_position) {
1653 position = idetape_read_position(drive);
1654 seek = position > 0 ? position : 0;
1655 if (idetape_position_tape(drive, seek, 0, 0)) {
1656 printk(KERN_INFO "ide-tape: %s: position_tape failed in"
1657 " %s\n", tape->name, __func__);
1664 * Generate a read/write request for the block device interface and wait for it
1667 static int idetape_queue_rw_tail(ide_drive_t *drive, int cmd, int blocks,
1668 struct idetape_bh *bh)
1670 idetape_tape_t *tape = drive->driver_data;
1674 debug_log(DBG_SENSE, "%s: cmd=%d\n", __func__, cmd);
1676 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
1677 rq->cmd_type = REQ_TYPE_SPECIAL;
1679 rq->rq_disk = tape->disk;
1680 rq->special = (void *)bh;
1681 rq->sector = tape->first_frame;
1682 rq->nr_sectors = blocks;
1683 rq->current_nr_sectors = blocks;
1684 blk_execute_rq(drive->queue, tape->disk, rq, 0);
1686 errors = rq->errors;
1687 ret = tape->blk_size * (blocks - rq->current_nr_sectors);
1688 blk_put_request(rq);
1690 if ((cmd & (REQ_IDETAPE_READ | REQ_IDETAPE_WRITE)) == 0)
1694 idetape_init_merge_buffer(tape);
1695 if (errors == IDETAPE_ERROR_GENERAL)
1700 static void idetape_create_inquiry_cmd(struct ide_atapi_pc *pc)
1702 idetape_init_pc(pc);
1706 pc->idetape_callback = &idetape_pc_callback;
1709 static void idetape_create_rewind_cmd(ide_drive_t *drive,
1710 struct ide_atapi_pc *pc)
1712 idetape_init_pc(pc);
1713 pc->c[0] = REZERO_UNIT;
1714 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1715 pc->idetape_callback = &idetape_pc_callback;
1718 static void idetape_create_erase_cmd(struct ide_atapi_pc *pc)
1720 idetape_init_pc(pc);
1723 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1724 pc->idetape_callback = &idetape_pc_callback;
1727 static void idetape_create_space_cmd(struct ide_atapi_pc *pc, int count, u8 cmd)
1729 idetape_init_pc(pc);
1731 put_unaligned(cpu_to_be32(count), (unsigned int *) &pc->c[1]);
1733 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1734 pc->idetape_callback = &idetape_pc_callback;
1737 /* Queue up a character device originated write request. */
1738 static int idetape_add_chrdev_write_request(ide_drive_t *drive, int blocks)
1740 idetape_tape_t *tape = drive->driver_data;
1742 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
1744 return idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE,
1745 blocks, tape->merge_bh);
1748 static void ide_tape_flush_merge_buffer(ide_drive_t *drive)
1750 idetape_tape_t *tape = drive->driver_data;
1752 struct idetape_bh *bh;
1754 if (tape->chrdev_dir != IDETAPE_DIR_WRITE) {
1755 printk(KERN_ERR "ide-tape: bug: Trying to empty merge buffer"
1756 " but we are not writing.\n");
1759 if (tape->merge_bh_size > tape->buffer_size) {
1760 printk(KERN_ERR "ide-tape: bug: merge_buffer too big\n");
1761 tape->merge_bh_size = tape->buffer_size;
1763 if (tape->merge_bh_size) {
1764 blocks = tape->merge_bh_size / tape->blk_size;
1765 if (tape->merge_bh_size % tape->blk_size) {
1769 i = tape->blk_size - tape->merge_bh_size %
1771 bh = tape->bh->b_reqnext;
1773 atomic_set(&bh->b_count, 0);
1779 printk(KERN_INFO "ide-tape: bug,"
1783 min = min(i, (unsigned int)(bh->b_size -
1784 atomic_read(&bh->b_count)));
1785 memset(bh->b_data + atomic_read(&bh->b_count),
1787 atomic_add(min, &bh->b_count);
1792 (void) idetape_add_chrdev_write_request(drive, blocks);
1793 tape->merge_bh_size = 0;
1795 if (tape->merge_bh != NULL) {
1796 ide_tape_kfree_buffer(tape);
1797 tape->merge_bh = NULL;
1799 tape->chrdev_dir = IDETAPE_DIR_NONE;
1802 static int idetape_init_read(ide_drive_t *drive)
1804 idetape_tape_t *tape = drive->driver_data;
1807 /* Initialize read operation */
1808 if (tape->chrdev_dir != IDETAPE_DIR_READ) {
1809 if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
1810 ide_tape_flush_merge_buffer(drive);
1811 idetape_flush_tape_buffers(drive);
1813 if (tape->merge_bh || tape->merge_bh_size) {
1814 printk(KERN_ERR "ide-tape: merge_bh_size should be"
1816 tape->merge_bh_size = 0;
1818 tape->merge_bh = ide_tape_kmalloc_buffer(tape, 0, 0);
1819 if (!tape->merge_bh)
1821 tape->chrdev_dir = IDETAPE_DIR_READ;
1824 * Issue a read 0 command to ensure that DSC handshake is
1825 * switched from completion mode to buffer available mode.
1826 * No point in issuing this if DSC overlap isn't supported, some
1827 * drives (Seagate STT3401A) will return an error.
1829 if (drive->dsc_overlap) {
1830 bytes_read = idetape_queue_rw_tail(drive,
1831 REQ_IDETAPE_READ, 0,
1833 if (bytes_read < 0) {
1834 ide_tape_kfree_buffer(tape);
1835 tape->merge_bh = NULL;
1836 tape->chrdev_dir = IDETAPE_DIR_NONE;
1845 /* called from idetape_chrdev_read() to service a chrdev read request. */
1846 static int idetape_add_chrdev_read_request(ide_drive_t *drive, int blocks)
1848 idetape_tape_t *tape = drive->driver_data;
1850 debug_log(DBG_PROCS, "Enter %s, %d blocks\n", __func__, blocks);
1852 /* If we are at a filemark, return a read length of 0 */
1853 if (test_bit(IDETAPE_FLAG_FILEMARK, &tape->flags))
1856 idetape_init_read(drive);
1858 return idetape_queue_rw_tail(drive, REQ_IDETAPE_READ, blocks,
1862 static void idetape_pad_zeros(ide_drive_t *drive, int bcount)
1864 idetape_tape_t *tape = drive->driver_data;
1865 struct idetape_bh *bh;
1871 bh = tape->merge_bh;
1872 count = min(tape->buffer_size, bcount);
1874 blocks = count / tape->blk_size;
1876 atomic_set(&bh->b_count,
1877 min(count, (unsigned int)bh->b_size));
1878 memset(bh->b_data, 0, atomic_read(&bh->b_count));
1879 count -= atomic_read(&bh->b_count);
1882 idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE, blocks,
1888 * Rewinds the tape to the Beginning Of the current Partition (BOP). We
1889 * currently support only one partition.
1891 static int idetape_rewind_tape(ide_drive_t *drive)
1894 struct ide_atapi_pc pc;
1895 idetape_tape_t *tape;
1896 tape = drive->driver_data;
1898 debug_log(DBG_SENSE, "Enter %s\n", __func__);
1900 idetape_create_rewind_cmd(drive, &pc);
1901 retval = idetape_queue_pc_tail(drive, &pc);
1905 idetape_create_read_position_cmd(&pc);
1906 retval = idetape_queue_pc_tail(drive, &pc);
1912 /* mtio.h compatible commands should be issued to the chrdev interface. */
1913 static int idetape_blkdev_ioctl(ide_drive_t *drive, unsigned int cmd,
1916 idetape_tape_t *tape = drive->driver_data;
1917 void __user *argp = (void __user *)arg;
1919 struct idetape_config {
1920 int dsc_rw_frequency;
1921 int dsc_media_access_frequency;
1925 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1929 if (copy_from_user(&config, argp, sizeof(config)))
1931 tape->best_dsc_rw_freq = config.dsc_rw_frequency;
1934 config.dsc_rw_frequency = (int) tape->best_dsc_rw_freq;
1935 config.nr_stages = 1;
1936 if (copy_to_user(argp, &config, sizeof(config)))
1945 static int idetape_space_over_filemarks(ide_drive_t *drive, short mt_op,
1948 idetape_tape_t *tape = drive->driver_data;
1949 struct ide_atapi_pc pc;
1950 int retval, count = 0;
1951 int sprev = !!(tape->caps[4] & 0x20);
1955 if (MTBSF == mt_op || MTBSFM == mt_op) {
1958 mt_count = -mt_count;
1961 if (tape->chrdev_dir == IDETAPE_DIR_READ) {
1962 tape->merge_bh_size = 0;
1963 if (test_and_clear_bit(IDETAPE_FLAG_FILEMARK, &tape->flags))
1965 ide_tape_discard_merge_buffer(drive, 0);
1971 idetape_create_space_cmd(&pc, mt_count - count,
1972 IDETAPE_SPACE_OVER_FILEMARK);
1973 return idetape_queue_pc_tail(drive, &pc);
1978 retval = idetape_space_over_filemarks(drive, MTFSF,
1982 count = (MTBSFM == mt_op ? 1 : -1);
1983 return idetape_space_over_filemarks(drive, MTFSF, count);
1985 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
1992 * Our character device read / write functions.
1994 * The tape is optimized to maximize throughput when it is transferring an
1995 * integral number of the "continuous transfer limit", which is a parameter of
1996 * the specific tape (26kB on my particular tape, 32kB for Onstream).
1998 * As of version 1.3 of the driver, the character device provides an abstract
1999 * continuous view of the media - any mix of block sizes (even 1 byte) on the
2000 * same backup/restore procedure is supported. The driver will internally
2001 * convert the requests to the recommended transfer unit, so that an unmatch
2002 * between the user's block size to the recommended size will only result in a
2003 * (slightly) increased driver overhead, but will no longer hit performance.
2004 * This is not applicable to Onstream.
2006 static ssize_t idetape_chrdev_read(struct file *file, char __user *buf,
2007 size_t count, loff_t *ppos)
2009 struct ide_tape_obj *tape = ide_tape_f(file);
2010 ide_drive_t *drive = tape->drive;
2011 ssize_t bytes_read, temp, actually_read = 0, rc;
2013 u16 ctl = *(u16 *)&tape->caps[12];
2015 debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
2017 if (tape->chrdev_dir != IDETAPE_DIR_READ) {
2018 if (test_bit(IDETAPE_FLAG_DETECT_BS, &tape->flags))
2019 if (count > tape->blk_size &&
2020 (count % tape->blk_size) == 0)
2021 tape->user_bs_factor = count / tape->blk_size;
2023 rc = idetape_init_read(drive);
2028 if (tape->merge_bh_size) {
2029 actually_read = min((unsigned int)(tape->merge_bh_size),
2030 (unsigned int)count);
2031 if (idetape_copy_stage_to_user(tape, buf, actually_read))
2033 buf += actually_read;
2034 tape->merge_bh_size -= actually_read;
2035 count -= actually_read;
2037 while (count >= tape->buffer_size) {
2038 bytes_read = idetape_add_chrdev_read_request(drive, ctl);
2039 if (bytes_read <= 0)
2041 if (idetape_copy_stage_to_user(tape, buf, bytes_read))
2044 count -= bytes_read;
2045 actually_read += bytes_read;
2048 bytes_read = idetape_add_chrdev_read_request(drive, ctl);
2049 if (bytes_read <= 0)
2051 temp = min((unsigned long)count, (unsigned long)bytes_read);
2052 if (idetape_copy_stage_to_user(tape, buf, temp))
2054 actually_read += temp;
2055 tape->merge_bh_size = bytes_read-temp;
2058 if (!actually_read && test_bit(IDETAPE_FLAG_FILEMARK, &tape->flags)) {
2059 debug_log(DBG_SENSE, "%s: spacing over filemark\n", tape->name);
2061 idetape_space_over_filemarks(drive, MTFSF, 1);
2065 return ret ? ret : actually_read;
2068 static ssize_t idetape_chrdev_write(struct file *file, const char __user *buf,
2069 size_t count, loff_t *ppos)
2071 struct ide_tape_obj *tape = ide_tape_f(file);
2072 ide_drive_t *drive = tape->drive;
2073 ssize_t actually_written = 0;
2075 u16 ctl = *(u16 *)&tape->caps[12];
2077 /* The drive is write protected. */
2078 if (tape->write_prot)
2081 debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
2083 /* Initialize write operation */
2084 if (tape->chrdev_dir != IDETAPE_DIR_WRITE) {
2085 if (tape->chrdev_dir == IDETAPE_DIR_READ)
2086 ide_tape_discard_merge_buffer(drive, 1);
2087 if (tape->merge_bh || tape->merge_bh_size) {
2088 printk(KERN_ERR "ide-tape: merge_bh_size "
2089 "should be 0 now\n");
2090 tape->merge_bh_size = 0;
2092 tape->merge_bh = ide_tape_kmalloc_buffer(tape, 0, 0);
2093 if (!tape->merge_bh)
2095 tape->chrdev_dir = IDETAPE_DIR_WRITE;
2096 idetape_init_merge_buffer(tape);
2099 * Issue a write 0 command to ensure that DSC handshake is
2100 * switched from completion mode to buffer available mode. No
2101 * point in issuing this if DSC overlap isn't supported, some
2102 * drives (Seagate STT3401A) will return an error.
2104 if (drive->dsc_overlap) {
2105 ssize_t retval = idetape_queue_rw_tail(drive,
2106 REQ_IDETAPE_WRITE, 0,
2109 ide_tape_kfree_buffer(tape);
2110 tape->merge_bh = NULL;
2111 tape->chrdev_dir = IDETAPE_DIR_NONE;
2118 if (tape->merge_bh_size) {
2119 if (tape->merge_bh_size >= tape->buffer_size) {
2120 printk(KERN_ERR "ide-tape: bug: merge buf too big\n");
2121 tape->merge_bh_size = 0;
2123 actually_written = min((unsigned int)
2124 (tape->buffer_size - tape->merge_bh_size),
2125 (unsigned int)count);
2126 if (idetape_copy_stage_from_user(tape, buf, actually_written))
2128 buf += actually_written;
2129 tape->merge_bh_size += actually_written;
2130 count -= actually_written;
2132 if (tape->merge_bh_size == tape->buffer_size) {
2134 tape->merge_bh_size = 0;
2135 retval = idetape_add_chrdev_write_request(drive, ctl);
2140 while (count >= tape->buffer_size) {
2142 if (idetape_copy_stage_from_user(tape, buf, tape->buffer_size))
2144 buf += tape->buffer_size;
2145 count -= tape->buffer_size;
2146 retval = idetape_add_chrdev_write_request(drive, ctl);
2147 actually_written += tape->buffer_size;
2152 actually_written += count;
2153 if (idetape_copy_stage_from_user(tape, buf, count))
2155 tape->merge_bh_size += count;
2157 return ret ? ret : actually_written;
2160 static int idetape_write_filemark(ide_drive_t *drive)
2162 struct ide_atapi_pc pc;
2164 /* Write a filemark */
2165 idetape_create_write_filemark_cmd(drive, &pc, 1);
2166 if (idetape_queue_pc_tail(drive, &pc)) {
2167 printk(KERN_ERR "ide-tape: Couldn't write a filemark\n");
2174 * Called from idetape_chrdev_ioctl when the general mtio MTIOCTOP ioctl is
2177 * Note: MTBSF and MTBSFM are not supported when the tape doesn't support
2178 * spacing over filemarks in the reverse direction. In this case, MTFSFM is also
2179 * usually not supported.
2181 * The following commands are currently not supported:
2183 * MTFSS, MTBSS, MTWSM, MTSETDENSITY, MTSETDRVBUFFER, MT_ST_BOOLEANS,
2184 * MT_ST_WRITE_THRESHOLD.
2186 static int idetape_mtioctop(ide_drive_t *drive, short mt_op, int mt_count)
2188 idetape_tape_t *tape = drive->driver_data;
2189 struct ide_atapi_pc pc;
2192 debug_log(DBG_ERR, "Handling MTIOCTOP ioctl: mt_op=%d, mt_count=%d\n",
2202 return idetape_space_over_filemarks(drive, mt_op, mt_count);
2209 if (tape->write_prot)
2211 ide_tape_discard_merge_buffer(drive, 1);
2212 for (i = 0; i < mt_count; i++) {
2213 retval = idetape_write_filemark(drive);
2219 ide_tape_discard_merge_buffer(drive, 0);
2220 if (idetape_rewind_tape(drive))
2224 ide_tape_discard_merge_buffer(drive, 0);
2225 idetape_create_load_unload_cmd(drive, &pc,
2226 IDETAPE_LU_LOAD_MASK);
2227 return idetape_queue_pc_tail(drive, &pc);
2231 * If door is locked, attempt to unlock before
2232 * attempting to eject.
2234 if (tape->door_locked) {
2235 if (idetape_create_prevent_cmd(drive, &pc, 0))
2236 if (!idetape_queue_pc_tail(drive, &pc))
2237 tape->door_locked = DOOR_UNLOCKED;
2239 ide_tape_discard_merge_buffer(drive, 0);
2240 idetape_create_load_unload_cmd(drive, &pc,
2241 !IDETAPE_LU_LOAD_MASK);
2242 retval = idetape_queue_pc_tail(drive, &pc);
2244 clear_bit(IDETAPE_FLAG_MEDIUM_PRESENT, &tape->flags);
2247 ide_tape_discard_merge_buffer(drive, 0);
2248 return idetape_flush_tape_buffers(drive);
2250 ide_tape_discard_merge_buffer(drive, 0);
2251 idetape_create_load_unload_cmd(drive, &pc,
2252 IDETAPE_LU_RETENSION_MASK | IDETAPE_LU_LOAD_MASK);
2253 return idetape_queue_pc_tail(drive, &pc);
2255 idetape_create_space_cmd(&pc, 0, IDETAPE_SPACE_TO_EOD);
2256 return idetape_queue_pc_tail(drive, &pc);
2258 (void)idetape_rewind_tape(drive);
2259 idetape_create_erase_cmd(&pc);
2260 return idetape_queue_pc_tail(drive, &pc);
2263 if (mt_count < tape->blk_size ||
2264 mt_count % tape->blk_size)
2266 tape->user_bs_factor = mt_count / tape->blk_size;
2267 clear_bit(IDETAPE_FLAG_DETECT_BS, &tape->flags);
2269 set_bit(IDETAPE_FLAG_DETECT_BS, &tape->flags);
2272 ide_tape_discard_merge_buffer(drive, 0);
2273 return idetape_position_tape(drive,
2274 mt_count * tape->user_bs_factor, tape->partition, 0);
2276 ide_tape_discard_merge_buffer(drive, 0);
2277 return idetape_position_tape(drive, 0, mt_count, 0);
2281 if (!idetape_create_prevent_cmd(drive, &pc, 1))
2283 retval = idetape_queue_pc_tail(drive, &pc);
2286 tape->door_locked = DOOR_EXPLICITLY_LOCKED;
2289 if (!idetape_create_prevent_cmd(drive, &pc, 0))
2291 retval = idetape_queue_pc_tail(drive, &pc);
2294 tape->door_locked = DOOR_UNLOCKED;
2297 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
2304 * Our character device ioctls. General mtio.h magnetic io commands are
2305 * supported here, and not in the corresponding block interface. Our own
2306 * ide-tape ioctls are supported on both interfaces.
2308 static int idetape_chrdev_ioctl(struct inode *inode, struct file *file,
2309 unsigned int cmd, unsigned long arg)
2311 struct ide_tape_obj *tape = ide_tape_f(file);
2312 ide_drive_t *drive = tape->drive;
2316 int block_offset = 0, position = tape->first_frame;
2317 void __user *argp = (void __user *)arg;
2319 debug_log(DBG_CHRDEV, "Enter %s, cmd=%u\n", __func__, cmd);
2321 if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
2322 ide_tape_flush_merge_buffer(drive);
2323 idetape_flush_tape_buffers(drive);
2325 if (cmd == MTIOCGET || cmd == MTIOCPOS) {
2326 block_offset = tape->merge_bh_size /
2327 (tape->blk_size * tape->user_bs_factor);
2328 position = idetape_read_position(drive);
2334 if (copy_from_user(&mtop, argp, sizeof(struct mtop)))
2336 return idetape_mtioctop(drive, mtop.mt_op, mtop.mt_count);
2338 memset(&mtget, 0, sizeof(struct mtget));
2339 mtget.mt_type = MT_ISSCSI2;
2340 mtget.mt_blkno = position / tape->user_bs_factor - block_offset;
2342 ((tape->blk_size * tape->user_bs_factor)
2343 << MT_ST_BLKSIZE_SHIFT) & MT_ST_BLKSIZE_MASK;
2345 if (tape->drv_write_prot)
2346 mtget.mt_gstat |= GMT_WR_PROT(0xffffffff);
2348 if (copy_to_user(argp, &mtget, sizeof(struct mtget)))
2352 mtpos.mt_blkno = position / tape->user_bs_factor - block_offset;
2353 if (copy_to_user(argp, &mtpos, sizeof(struct mtpos)))
2357 if (tape->chrdev_dir == IDETAPE_DIR_READ)
2358 ide_tape_discard_merge_buffer(drive, 1);
2359 return idetape_blkdev_ioctl(drive, cmd, arg);
2364 * Do a mode sense page 0 with block descriptor and if it succeeds set the tape
2365 * block size with the reported value.
2367 static void ide_tape_get_bsize_from_bdesc(ide_drive_t *drive)
2369 idetape_tape_t *tape = drive->driver_data;
2370 struct ide_atapi_pc pc;
2372 idetape_create_mode_sense_cmd(&pc, IDETAPE_BLOCK_DESCRIPTOR);
2373 if (idetape_queue_pc_tail(drive, &pc)) {
2374 printk(KERN_ERR "ide-tape: Can't get block descriptor\n");
2375 if (tape->blk_size == 0) {
2376 printk(KERN_WARNING "ide-tape: Cannot deal with zero "
2377 "block size, assuming 32k\n");
2378 tape->blk_size = 32768;
2382 tape->blk_size = (pc.buf[4 + 5] << 16) +
2383 (pc.buf[4 + 6] << 8) +
2385 tape->drv_write_prot = (pc.buf[2] & 0x80) >> 7;
2388 static int idetape_chrdev_open(struct inode *inode, struct file *filp)
2390 unsigned int minor = iminor(inode), i = minor & ~0xc0;
2392 idetape_tape_t *tape;
2393 struct ide_atapi_pc pc;
2396 if (i >= MAX_HWIFS * MAX_DRIVES)
2399 tape = ide_tape_chrdev_get(i);
2403 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
2406 * We really want to do nonseekable_open(inode, filp); here, but some
2407 * versions of tar incorrectly call lseek on tapes and bail out if that
2408 * fails. So we disallow pread() and pwrite(), but permit lseeks.
2410 filp->f_mode &= ~(FMODE_PREAD | FMODE_PWRITE);
2412 drive = tape->drive;
2414 filp->private_data = tape;
2416 if (test_and_set_bit(IDETAPE_FLAG_BUSY, &tape->flags)) {
2421 retval = idetape_wait_ready(drive, 60 * HZ);
2423 clear_bit(IDETAPE_FLAG_BUSY, &tape->flags);
2424 printk(KERN_ERR "ide-tape: %s: drive not ready\n", tape->name);
2428 idetape_read_position(drive);
2429 if (!test_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags))
2430 (void)idetape_rewind_tape(drive);
2432 /* Read block size and write protect status from drive. */
2433 ide_tape_get_bsize_from_bdesc(drive);
2435 /* Set write protect flag if device is opened as read-only. */
2436 if ((filp->f_flags & O_ACCMODE) == O_RDONLY)
2437 tape->write_prot = 1;
2439 tape->write_prot = tape->drv_write_prot;
2441 /* Make sure drive isn't write protected if user wants to write. */
2442 if (tape->write_prot) {
2443 if ((filp->f_flags & O_ACCMODE) == O_WRONLY ||
2444 (filp->f_flags & O_ACCMODE) == O_RDWR) {
2445 clear_bit(IDETAPE_FLAG_BUSY, &tape->flags);
2451 /* Lock the tape drive door so user can't eject. */
2452 if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
2453 if (idetape_create_prevent_cmd(drive, &pc, 1)) {
2454 if (!idetape_queue_pc_tail(drive, &pc)) {
2455 if (tape->door_locked != DOOR_EXPLICITLY_LOCKED)
2456 tape->door_locked = DOOR_LOCKED;
2467 static void idetape_write_release(ide_drive_t *drive, unsigned int minor)
2469 idetape_tape_t *tape = drive->driver_data;
2471 ide_tape_flush_merge_buffer(drive);
2472 tape->merge_bh = ide_tape_kmalloc_buffer(tape, 1, 0);
2473 if (tape->merge_bh != NULL) {
2474 idetape_pad_zeros(drive, tape->blk_size *
2475 (tape->user_bs_factor - 1));
2476 ide_tape_kfree_buffer(tape);
2477 tape->merge_bh = NULL;
2479 idetape_write_filemark(drive);
2480 idetape_flush_tape_buffers(drive);
2481 idetape_flush_tape_buffers(drive);
2484 static int idetape_chrdev_release(struct inode *inode, struct file *filp)
2486 struct ide_tape_obj *tape = ide_tape_f(filp);
2487 ide_drive_t *drive = tape->drive;
2488 struct ide_atapi_pc pc;
2489 unsigned int minor = iminor(inode);
2492 tape = drive->driver_data;
2494 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
2496 if (tape->chrdev_dir == IDETAPE_DIR_WRITE)
2497 idetape_write_release(drive, minor);
2498 if (tape->chrdev_dir == IDETAPE_DIR_READ) {
2500 ide_tape_discard_merge_buffer(drive, 1);
2503 if (minor < 128 && test_bit(IDETAPE_FLAG_MEDIUM_PRESENT, &tape->flags))
2504 (void) idetape_rewind_tape(drive);
2505 if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
2506 if (tape->door_locked == DOOR_LOCKED) {
2507 if (idetape_create_prevent_cmd(drive, &pc, 0)) {
2508 if (!idetape_queue_pc_tail(drive, &pc))
2509 tape->door_locked = DOOR_UNLOCKED;
2513 clear_bit(IDETAPE_FLAG_BUSY, &tape->flags);
2520 * check the contents of the ATAPI IDENTIFY command results. We return:
2522 * 1 - If the tape can be supported by us, based on the information we have so
2525 * 0 - If this tape driver is not currently supported by us.
2527 static int idetape_identify_device(ide_drive_t *drive)
2529 u8 gcw[2], protocol, device_type, removable, packet_size;
2531 if (drive->id_read == 0)
2534 *((unsigned short *) &gcw) = drive->id->config;
2536 protocol = (gcw[1] & 0xC0) >> 6;
2537 device_type = gcw[1] & 0x1F;
2538 removable = !!(gcw[0] & 0x80);
2539 packet_size = gcw[0] & 0x3;
2541 /* Check that we can support this device */
2543 printk(KERN_ERR "ide-tape: Protocol (0x%02x) is not ATAPI\n",
2545 else if (device_type != 1)
2546 printk(KERN_ERR "ide-tape: Device type (0x%02x) is not set "
2547 "to tape\n", device_type);
2548 else if (!removable)
2549 printk(KERN_ERR "ide-tape: The removable flag is not set\n");
2550 else if (packet_size != 0) {
2551 printk(KERN_ERR "ide-tape: Packet size (0x%02x) is not 12"
2552 " bytes\n", packet_size);
2558 static void idetape_get_inquiry_results(ide_drive_t *drive)
2560 idetape_tape_t *tape = drive->driver_data;
2561 struct ide_atapi_pc pc;
2562 char fw_rev[6], vendor_id[10], product_id[18];
2564 idetape_create_inquiry_cmd(&pc);
2565 if (idetape_queue_pc_tail(drive, &pc)) {
2566 printk(KERN_ERR "ide-tape: %s: can't get INQUIRY results\n",
2570 memcpy(vendor_id, &pc.buf[8], 8);
2571 memcpy(product_id, &pc.buf[16], 16);
2572 memcpy(fw_rev, &pc.buf[32], 4);
2574 ide_fixstring(vendor_id, 10, 0);
2575 ide_fixstring(product_id, 18, 0);
2576 ide_fixstring(fw_rev, 6, 0);
2578 printk(KERN_INFO "ide-tape: %s <-> %s: %s %s rev %s\n",
2579 drive->name, tape->name, vendor_id, product_id, fw_rev);
2583 * Ask the tape about its various parameters. In particular, we will adjust our
2584 * data transfer buffer size to the recommended value as returned by the tape.
2586 static void idetape_get_mode_sense_results(ide_drive_t *drive)
2588 idetape_tape_t *tape = drive->driver_data;
2589 struct ide_atapi_pc pc;
2591 u8 speed, max_speed;
2593 idetape_create_mode_sense_cmd(&pc, IDETAPE_CAPABILITIES_PAGE);
2594 if (idetape_queue_pc_tail(drive, &pc)) {
2595 printk(KERN_ERR "ide-tape: Can't get tape parameters - assuming"
2596 " some default values\n");
2597 tape->blk_size = 512;
2598 put_unaligned(52, (u16 *)&tape->caps[12]);
2599 put_unaligned(540, (u16 *)&tape->caps[14]);
2600 put_unaligned(6*52, (u16 *)&tape->caps[16]);
2603 caps = pc.buf + 4 + pc.buf[3];
2605 /* convert to host order and save for later use */
2606 speed = be16_to_cpu(*(u16 *)&caps[14]);
2607 max_speed = be16_to_cpu(*(u16 *)&caps[8]);
2609 put_unaligned(max_speed, (u16 *)&caps[8]);
2610 put_unaligned(be16_to_cpu(*(u16 *)&caps[12]), (u16 *)&caps[12]);
2611 put_unaligned(speed, (u16 *)&caps[14]);
2612 put_unaligned(be16_to_cpu(*(u16 *)&caps[16]), (u16 *)&caps[16]);
2615 printk(KERN_INFO "ide-tape: %s: invalid tape speed "
2616 "(assuming 650KB/sec)\n", drive->name);
2617 put_unaligned(650, (u16 *)&caps[14]);
2620 printk(KERN_INFO "ide-tape: %s: invalid max_speed "
2621 "(assuming 650KB/sec)\n", drive->name);
2622 put_unaligned(650, (u16 *)&caps[8]);
2625 memcpy(&tape->caps, caps, 20);
2627 tape->blk_size = 512;
2628 else if (caps[7] & 0x04)
2629 tape->blk_size = 1024;
2632 #ifdef CONFIG_IDE_PROC_FS
2633 static void idetape_add_settings(ide_drive_t *drive)
2635 idetape_tape_t *tape = drive->driver_data;
2637 ide_add_setting(drive, "buffer", SETTING_READ, TYPE_SHORT, 0, 0xffff,
2638 1, 2, (u16 *)&tape->caps[16], NULL);
2639 ide_add_setting(drive, "speed", SETTING_READ, TYPE_SHORT, 0, 0xffff,
2640 1, 1, (u16 *)&tape->caps[14], NULL);
2641 ide_add_setting(drive, "buffer_size", SETTING_READ, TYPE_INT, 0, 0xffff,
2642 1, 1024, &tape->buffer_size, NULL);
2643 ide_add_setting(drive, "tdsc", SETTING_RW, TYPE_INT, IDETAPE_DSC_RW_MIN,
2644 IDETAPE_DSC_RW_MAX, 1000, HZ, &tape->best_dsc_rw_freq,
2646 ide_add_setting(drive, "dsc_overlap", SETTING_RW, TYPE_BYTE, 0, 1, 1,
2647 1, &drive->dsc_overlap, NULL);
2648 ide_add_setting(drive, "avg_speed", SETTING_READ, TYPE_INT, 0, 0xffff,
2649 1, 1, &tape->avg_speed, NULL);
2650 ide_add_setting(drive, "debug_mask", SETTING_RW, TYPE_INT, 0, 0xffff, 1,
2651 1, &tape->debug_mask, NULL);
2654 static inline void idetape_add_settings(ide_drive_t *drive) { ; }
2658 * The function below is called to:
2660 * 1. Initialize our various state variables.
2661 * 2. Ask the tape for its capabilities.
2662 * 3. Allocate a buffer which will be used for data transfer. The buffer size
2663 * is chosen based on the recommendation which we received in step 2.
2665 * Note that at this point ide.c already assigned us an irq, so that we can
2666 * queue requests here and wait for their completion.
2668 static void idetape_setup(ide_drive_t *drive, idetape_tape_t *tape, int minor)
2674 u16 *ctl = (u16 *)&tape->caps[12];
2676 spin_lock_init(&tape->lock);
2677 drive->dsc_overlap = 1;
2678 if (drive->hwif->host_flags & IDE_HFLAG_NO_DSC) {
2679 printk(KERN_INFO "ide-tape: %s: disabling DSC overlap\n",
2681 drive->dsc_overlap = 0;
2683 /* Seagate Travan drives do not support DSC overlap. */
2684 if (strstr(drive->id->model, "Seagate STT3401"))
2685 drive->dsc_overlap = 0;
2686 tape->minor = minor;
2687 tape->name[0] = 'h';
2688 tape->name[1] = 't';
2689 tape->name[2] = '0' + minor;
2690 tape->chrdev_dir = IDETAPE_DIR_NONE;
2691 tape->pc = tape->pc_stack;
2692 *((unsigned short *) &gcw) = drive->id->config;
2694 /* Command packet DRQ type */
2695 if (((gcw[0] & 0x60) >> 5) == 1)
2696 set_bit(IDETAPE_FLAG_DRQ_INTERRUPT, &tape->flags);
2698 idetape_get_inquiry_results(drive);
2699 idetape_get_mode_sense_results(drive);
2700 ide_tape_get_bsize_from_bdesc(drive);
2701 tape->user_bs_factor = 1;
2702 tape->buffer_size = *ctl * tape->blk_size;
2703 while (tape->buffer_size > 0xffff) {
2704 printk(KERN_NOTICE "ide-tape: decreasing stage size\n");
2706 tape->buffer_size = *ctl * tape->blk_size;
2708 buffer_size = tape->buffer_size;
2709 tape->pages_per_buffer = buffer_size / PAGE_SIZE;
2710 if (buffer_size % PAGE_SIZE) {
2711 tape->pages_per_buffer++;
2712 tape->excess_bh_size = PAGE_SIZE - buffer_size % PAGE_SIZE;
2715 /* select the "best" DSC read/write polling freq */
2716 speed = max(*(u16 *)&tape->caps[14], *(u16 *)&tape->caps[8]);
2718 t = (IDETAPE_FIFO_THRESHOLD * tape->buffer_size * HZ) / (speed * 1000);
2721 * Ensure that the number we got makes sense; limit it within
2722 * IDETAPE_DSC_RW_MIN and IDETAPE_DSC_RW_MAX.
2724 tape->best_dsc_rw_freq = clamp_t(unsigned long, t, IDETAPE_DSC_RW_MIN,
2725 IDETAPE_DSC_RW_MAX);
2726 printk(KERN_INFO "ide-tape: %s <-> %s: %dKBps, %d*%dkB buffer, "
2728 drive->name, tape->name, *(u16 *)&tape->caps[14],
2729 (*(u16 *)&tape->caps[16] * 512) / tape->buffer_size,
2730 tape->buffer_size / 1024,
2731 tape->best_dsc_rw_freq * 1000 / HZ,
2732 drive->using_dma ? ", DMA":"");
2734 idetape_add_settings(drive);
2737 static void ide_tape_remove(ide_drive_t *drive)
2739 idetape_tape_t *tape = drive->driver_data;
2741 ide_proc_unregister_driver(drive, tape->driver);
2743 ide_unregister_region(tape->disk);
2748 static void ide_tape_release(struct kref *kref)
2750 struct ide_tape_obj *tape = to_ide_tape(kref);
2751 ide_drive_t *drive = tape->drive;
2752 struct gendisk *g = tape->disk;
2754 BUG_ON(tape->merge_bh_size);
2756 drive->dsc_overlap = 0;
2757 drive->driver_data = NULL;
2758 device_destroy(idetape_sysfs_class, MKDEV(IDETAPE_MAJOR, tape->minor));
2759 device_destroy(idetape_sysfs_class,
2760 MKDEV(IDETAPE_MAJOR, tape->minor + 128));
2761 idetape_devs[tape->minor] = NULL;
2762 g->private_data = NULL;
2767 #ifdef CONFIG_IDE_PROC_FS
2768 static int proc_idetape_read_name
2769 (char *page, char **start, off_t off, int count, int *eof, void *data)
2771 ide_drive_t *drive = (ide_drive_t *) data;
2772 idetape_tape_t *tape = drive->driver_data;
2776 len = sprintf(out, "%s\n", tape->name);
2777 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
2780 static ide_proc_entry_t idetape_proc[] = {
2781 { "capacity", S_IFREG|S_IRUGO, proc_ide_read_capacity, NULL },
2782 { "name", S_IFREG|S_IRUGO, proc_idetape_read_name, NULL },
2783 { NULL, 0, NULL, NULL }
2787 static int ide_tape_probe(ide_drive_t *);
2789 static ide_driver_t idetape_driver = {
2791 .owner = THIS_MODULE,
2793 .bus = &ide_bus_type,
2795 .probe = ide_tape_probe,
2796 .remove = ide_tape_remove,
2797 .version = IDETAPE_VERSION,
2799 .supports_dsc_overlap = 1,
2800 .do_request = idetape_do_request,
2801 .end_request = idetape_end_request,
2802 .error = __ide_error,
2803 .abort = __ide_abort,
2804 #ifdef CONFIG_IDE_PROC_FS
2805 .proc = idetape_proc,
2809 /* Our character device supporting functions, passed to register_chrdev. */
2810 static const struct file_operations idetape_fops = {
2811 .owner = THIS_MODULE,
2812 .read = idetape_chrdev_read,
2813 .write = idetape_chrdev_write,
2814 .ioctl = idetape_chrdev_ioctl,
2815 .open = idetape_chrdev_open,
2816 .release = idetape_chrdev_release,
2819 static int idetape_open(struct inode *inode, struct file *filp)
2821 struct gendisk *disk = inode->i_bdev->bd_disk;
2822 struct ide_tape_obj *tape;
2824 tape = ide_tape_get(disk);
2831 static int idetape_release(struct inode *inode, struct file *filp)
2833 struct gendisk *disk = inode->i_bdev->bd_disk;
2834 struct ide_tape_obj *tape = ide_tape_g(disk);
2841 static int idetape_ioctl(struct inode *inode, struct file *file,
2842 unsigned int cmd, unsigned long arg)
2844 struct block_device *bdev = inode->i_bdev;
2845 struct ide_tape_obj *tape = ide_tape_g(bdev->bd_disk);
2846 ide_drive_t *drive = tape->drive;
2847 int err = generic_ide_ioctl(drive, file, bdev, cmd, arg);
2849 err = idetape_blkdev_ioctl(drive, cmd, arg);
2853 static struct block_device_operations idetape_block_ops = {
2854 .owner = THIS_MODULE,
2855 .open = idetape_open,
2856 .release = idetape_release,
2857 .ioctl = idetape_ioctl,
2860 static int ide_tape_probe(ide_drive_t *drive)
2862 idetape_tape_t *tape;
2866 if (!strstr("ide-tape", drive->driver_req))
2868 if (!drive->present)
2870 if (drive->media != ide_tape)
2872 if (!idetape_identify_device(drive)) {
2873 printk(KERN_ERR "ide-tape: %s: not supported by this version of"
2874 " the driver\n", drive->name);
2878 printk(KERN_INFO "ide-tape: passing drive %s to ide-scsi"
2879 " emulation.\n", drive->name);
2882 tape = kzalloc(sizeof(idetape_tape_t), GFP_KERNEL);
2884 printk(KERN_ERR "ide-tape: %s: Can't allocate a tape struct\n",
2889 g = alloc_disk(1 << PARTN_BITS);
2893 ide_init_disk(g, drive);
2895 ide_proc_register_driver(drive, &idetape_driver);
2897 kref_init(&tape->kref);
2899 tape->drive = drive;
2900 tape->driver = &idetape_driver;
2903 g->private_data = &tape->driver;
2905 drive->driver_data = tape;
2907 mutex_lock(&idetape_ref_mutex);
2908 for (minor = 0; idetape_devs[minor]; minor++)
2910 idetape_devs[minor] = tape;
2911 mutex_unlock(&idetape_ref_mutex);
2913 idetape_setup(drive, tape, minor);
2915 device_create(idetape_sysfs_class, &drive->gendev,
2916 MKDEV(IDETAPE_MAJOR, minor), "%s", tape->name);
2917 device_create(idetape_sysfs_class, &drive->gendev,
2918 MKDEV(IDETAPE_MAJOR, minor + 128), "n%s", tape->name);
2920 g->fops = &idetape_block_ops;
2921 ide_register_region(g);
2931 static void __exit idetape_exit(void)
2933 driver_unregister(&idetape_driver.gen_driver);
2934 class_destroy(idetape_sysfs_class);
2935 unregister_chrdev(IDETAPE_MAJOR, "ht");
2938 static int __init idetape_init(void)
2941 idetape_sysfs_class = class_create(THIS_MODULE, "ide_tape");
2942 if (IS_ERR(idetape_sysfs_class)) {
2943 idetape_sysfs_class = NULL;
2944 printk(KERN_ERR "Unable to create sysfs class for ide tapes\n");
2949 if (register_chrdev(IDETAPE_MAJOR, "ht", &idetape_fops)) {
2950 printk(KERN_ERR "ide-tape: Failed to register chrdev"
2953 goto out_free_class;
2956 error = driver_register(&idetape_driver.gen_driver);
2958 goto out_free_driver;
2963 driver_unregister(&idetape_driver.gen_driver);
2965 class_destroy(idetape_sysfs_class);
2970 MODULE_ALIAS("ide:*m-tape*");
2971 module_init(idetape_init);
2972 module_exit(idetape_exit);
2973 MODULE_ALIAS_CHARDEV_MAJOR(IDETAPE_MAJOR);
2974 MODULE_DESCRIPTION("ATAPI Streaming TAPE Driver");
2975 MODULE_LICENSE("GPL");