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 /* Read/Write error simulation */
148 #define SIMULATE_ERRORS 0
150 /* tape directions */
152 IDETAPE_DIR_NONE = (1 << 0),
153 IDETAPE_DIR_READ = (1 << 1),
154 IDETAPE_DIR_WRITE = (1 << 2),
160 struct idetape_bh *b_reqnext;
164 /* Tape door status */
165 #define DOOR_UNLOCKED 0
166 #define DOOR_LOCKED 1
167 #define DOOR_EXPLICITLY_LOCKED 2
169 /* Some defines for the SPACE command */
170 #define IDETAPE_SPACE_OVER_FILEMARK 1
171 #define IDETAPE_SPACE_TO_EOD 3
173 /* Some defines for the LOAD UNLOAD command */
174 #define IDETAPE_LU_LOAD_MASK 1
175 #define IDETAPE_LU_RETENSION_MASK 2
176 #define IDETAPE_LU_EOT_MASK 4
179 * Special requests for our block device strategy routine.
181 * In order to service a character device command, we add special requests to
182 * the tail of our block device request queue and wait for their completion.
186 REQ_IDETAPE_PC1 = (1 << 0), /* packet command (first stage) */
187 REQ_IDETAPE_PC2 = (1 << 1), /* packet command (second stage) */
188 REQ_IDETAPE_READ = (1 << 2),
189 REQ_IDETAPE_WRITE = (1 << 3),
192 /* Error codes returned in rq->errors to the higher part of the driver. */
193 #define IDETAPE_ERROR_GENERAL 101
194 #define IDETAPE_ERROR_FILEMARK 102
195 #define IDETAPE_ERROR_EOD 103
197 /* Structures related to the SELECT SENSE / MODE SENSE packet commands. */
198 #define IDETAPE_BLOCK_DESCRIPTOR 0
199 #define IDETAPE_CAPABILITIES_PAGE 0x2a
201 /* Tape flag bits values. */
203 IDETAPE_FLAG_IGNORE_DSC = (1 << 0),
204 /* 0 When the tape position is unknown */
205 IDETAPE_FLAG_ADDRESS_VALID = (1 << 1),
206 /* Device already opened */
207 IDETAPE_FLAG_BUSY = (1 << 2),
208 /* Attempt to auto-detect the current user block size */
209 IDETAPE_FLAG_DETECT_BS = (1 << 3),
210 /* Currently on a filemark */
211 IDETAPE_FLAG_FILEMARK = (1 << 4),
212 /* DRQ interrupt device */
213 IDETAPE_FLAG_DRQ_INTERRUPT = (1 << 5),
214 /* 0 = no tape is loaded, so we don't rewind after ejecting */
215 IDETAPE_FLAG_MEDIUM_PRESENT = (1 << 6),
219 * Most of our global data which we need to save even as we leave the driver due
220 * to an interrupt or a timer event is stored in the struct defined below.
222 typedef struct ide_tape_obj {
224 ide_driver_t *driver;
225 struct gendisk *disk;
229 * Since a typical character device operation requires more
230 * than one packet command, we provide here enough memory
231 * for the maximum of interconnected packet commands.
232 * The packet commands are stored in the circular array pc_stack.
233 * pc_stack_index points to the last used entry, and warps around
234 * to the start when we get to the last array entry.
236 * pc points to the current processed packet command.
238 * failed_pc points to the last failed packet command, or contains
239 * NULL if we do not need to retry any packet command. This is
240 * required since an additional packet command is needed before the
241 * retry, to get detailed information on what went wrong.
243 /* Current packet command */
244 struct ide_atapi_pc *pc;
245 /* Last failed packet command */
246 struct ide_atapi_pc *failed_pc;
247 /* Packet command stack */
248 struct ide_atapi_pc pc_stack[IDETAPE_PC_STACK];
249 /* Next free packet command storage space */
251 struct request rq_stack[IDETAPE_PC_STACK];
252 /* We implement a circular array */
256 * DSC polling variables.
258 * While polling for DSC we use postponed_rq to postpone the current
259 * request so that ide.c will be able to service pending requests on the
260 * other device. Note that at most we will have only one DSC (usually
261 * data transfer) request in the device request queue.
263 struct request *postponed_rq;
264 /* The time in which we started polling for DSC */
265 unsigned long dsc_polling_start;
266 /* Timer used to poll for dsc */
267 struct timer_list dsc_timer;
268 /* Read/Write dsc polling frequency */
269 unsigned long best_dsc_rw_freq;
270 unsigned long dsc_poll_freq;
271 unsigned long dsc_timeout;
273 /* Read position information */
276 unsigned int first_frame;
278 /* Last error information */
279 u8 sense_key, asc, ascq;
281 /* Character device operation */
285 /* Current character device data transfer direction */
288 /* tape block size, usually 512 or 1024 bytes */
289 unsigned short blk_size;
292 /* Copy of the tape's Capabilities and Mechanical Page */
296 * Active data transfer request parameters.
298 * At most, there is only one ide-tape originated data transfer request
299 * in the device request queue. This allows ide.c to easily service
300 * requests from the other device when we postpone our active request.
303 /* Data buffer size chosen based on the tape's recommendation */
306 struct idetape_bh *merge_bh;
307 /* size of the merge buffer */
309 /* pointer to current buffer head within the merge buffer */
310 struct idetape_bh *bh;
314 int pages_per_buffer;
315 /* Wasted space in each stage */
318 /* Status/Action flags: long for set_bit */
320 /* protects the ide-tape queue */
323 /* Measures average tape speed */
324 unsigned long avg_time;
328 /* the door is currently locked */
330 /* the tape hardware is write protected */
332 /* the tape is write protected (hardware or opened as read-only) */
338 static DEFINE_MUTEX(idetape_ref_mutex);
340 static struct class *idetape_sysfs_class;
342 #define to_ide_tape(obj) container_of(obj, struct ide_tape_obj, kref)
344 #define ide_tape_g(disk) \
345 container_of((disk)->private_data, struct ide_tape_obj, driver)
347 static struct ide_tape_obj *ide_tape_get(struct gendisk *disk)
349 struct ide_tape_obj *tape = NULL;
351 mutex_lock(&idetape_ref_mutex);
352 tape = ide_tape_g(disk);
354 kref_get(&tape->kref);
355 mutex_unlock(&idetape_ref_mutex);
359 static void ide_tape_release(struct kref *);
361 static void ide_tape_put(struct ide_tape_obj *tape)
363 mutex_lock(&idetape_ref_mutex);
364 kref_put(&tape->kref, ide_tape_release);
365 mutex_unlock(&idetape_ref_mutex);
369 * The variables below are used for the character device interface. Additional
370 * state variables are defined in our ide_drive_t structure.
372 static struct ide_tape_obj *idetape_devs[MAX_HWIFS * MAX_DRIVES];
374 #define ide_tape_f(file) ((file)->private_data)
376 static struct ide_tape_obj *ide_tape_chrdev_get(unsigned int i)
378 struct ide_tape_obj *tape = NULL;
380 mutex_lock(&idetape_ref_mutex);
381 tape = idetape_devs[i];
383 kref_get(&tape->kref);
384 mutex_unlock(&idetape_ref_mutex);
388 static void idetape_input_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
391 struct idetape_bh *bh = pc->bh;
396 printk(KERN_ERR "ide-tape: bh == NULL in "
397 "idetape_input_buffers\n");
398 ide_pad_transfer(drive, 0, bcount);
402 (unsigned int)(bh->b_size - atomic_read(&bh->b_count)),
404 drive->hwif->input_data(drive, NULL, bh->b_data +
405 atomic_read(&bh->b_count), count);
407 atomic_add(count, &bh->b_count);
408 if (atomic_read(&bh->b_count) == bh->b_size) {
411 atomic_set(&bh->b_count, 0);
417 static void idetape_output_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
420 struct idetape_bh *bh = pc->bh;
425 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
429 count = min((unsigned int)pc->b_count, (unsigned int)bcount);
430 drive->hwif->output_data(drive, NULL, pc->b_data, count);
433 pc->b_count -= count;
438 pc->b_data = bh->b_data;
439 pc->b_count = atomic_read(&bh->b_count);
445 static void idetape_update_buffers(struct ide_atapi_pc *pc)
447 struct idetape_bh *bh = pc->bh;
449 unsigned int bcount = pc->xferred;
451 if (pc->flags & PC_FLAG_WRITING)
455 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
459 count = min((unsigned int)bh->b_size, (unsigned int)bcount);
460 atomic_set(&bh->b_count, count);
461 if (atomic_read(&bh->b_count) == bh->b_size)
469 * idetape_next_pc_storage returns a pointer to a place in which we can
470 * safely store a packet command, even though we intend to leave the
471 * driver. A storage space for a maximum of IDETAPE_PC_STACK packet
472 * commands is allocated at initialization time.
474 static struct ide_atapi_pc *idetape_next_pc_storage(ide_drive_t *drive)
476 idetape_tape_t *tape = drive->driver_data;
478 debug_log(DBG_PCRQ_STACK, "pc_stack_index=%d\n", tape->pc_stack_index);
480 if (tape->pc_stack_index == IDETAPE_PC_STACK)
481 tape->pc_stack_index = 0;
482 return (&tape->pc_stack[tape->pc_stack_index++]);
486 * idetape_next_rq_storage is used along with idetape_next_pc_storage.
487 * Since we queue packet commands in the request queue, we need to
488 * allocate a request, along with the allocation of a packet command.
491 /**************************************************************
493 * This should get fixed to use kmalloc(.., GFP_ATOMIC) *
494 * followed later on by kfree(). -ml *
496 **************************************************************/
498 static struct request *idetape_next_rq_storage(ide_drive_t *drive)
500 idetape_tape_t *tape = drive->driver_data;
502 debug_log(DBG_PCRQ_STACK, "rq_stack_index=%d\n", tape->rq_stack_index);
504 if (tape->rq_stack_index == IDETAPE_PC_STACK)
505 tape->rq_stack_index = 0;
506 return (&tape->rq_stack[tape->rq_stack_index++]);
509 static void idetape_init_pc(struct ide_atapi_pc *pc)
511 memset(pc->c, 0, 12);
515 pc->buf = pc->pc_buf;
516 pc->buf_size = IDETAPE_PC_BUFFER_SIZE;
522 * called on each failed packet command retry to analyze the request sense. We
523 * currently do not utilize this information.
525 static void idetape_analyze_error(ide_drive_t *drive, u8 *sense)
527 idetape_tape_t *tape = drive->driver_data;
528 struct ide_atapi_pc *pc = tape->failed_pc;
530 tape->sense_key = sense[2] & 0xF;
531 tape->asc = sense[12];
532 tape->ascq = sense[13];
534 debug_log(DBG_ERR, "pc = %x, sense key = %x, asc = %x, ascq = %x\n",
535 pc->c[0], tape->sense_key, tape->asc, tape->ascq);
537 /* Correct pc->xferred by asking the tape. */
538 if (pc->flags & PC_FLAG_DMA_ERROR) {
539 pc->xferred = pc->req_xfer -
541 get_unaligned_be32(&sense[3]);
542 idetape_update_buffers(pc);
546 * If error was the result of a zero-length read or write command,
547 * with sense key=5, asc=0x22, ascq=0, let it slide. Some drives
548 * (i.e. Seagate STT3401A Travan) don't support 0-length read/writes.
550 if ((pc->c[0] == READ_6 || pc->c[0] == WRITE_6)
552 && pc->c[4] == 0 && pc->c[3] == 0 && pc->c[2] == 0) {
553 if (tape->sense_key == 5) {
554 /* don't report an error, everything's ok */
556 /* don't retry read/write */
557 pc->flags |= PC_FLAG_ABORT;
560 if (pc->c[0] == READ_6 && (sense[2] & 0x80)) {
561 pc->error = IDETAPE_ERROR_FILEMARK;
562 pc->flags |= PC_FLAG_ABORT;
564 if (pc->c[0] == WRITE_6) {
565 if ((sense[2] & 0x40) || (tape->sense_key == 0xd
566 && tape->asc == 0x0 && tape->ascq == 0x2)) {
567 pc->error = IDETAPE_ERROR_EOD;
568 pc->flags |= PC_FLAG_ABORT;
571 if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
572 if (tape->sense_key == 8) {
573 pc->error = IDETAPE_ERROR_EOD;
574 pc->flags |= PC_FLAG_ABORT;
576 if (!(pc->flags & PC_FLAG_ABORT) &&
578 pc->retries = IDETAPE_MAX_PC_RETRIES + 1;
582 /* Free data buffers completely. */
583 static void ide_tape_kfree_buffer(idetape_tape_t *tape)
585 struct idetape_bh *prev_bh, *bh = tape->merge_bh;
588 u32 size = bh->b_size;
591 unsigned int order = fls(size >> PAGE_SHIFT)-1;
594 free_pages((unsigned long)bh->b_data, order);
597 bh->b_data += (1 << order) * PAGE_SIZE;
603 kfree(tape->merge_bh);
606 static int idetape_end_request(ide_drive_t *drive, int uptodate, int nr_sects)
608 struct request *rq = HWGROUP(drive)->rq;
609 idetape_tape_t *tape = drive->driver_data;
613 debug_log(DBG_PROCS, "Enter %s\n", __func__);
616 case 0: error = IDETAPE_ERROR_GENERAL; break;
617 case 1: error = 0; break;
618 default: error = uptodate;
622 tape->failed_pc = NULL;
624 if (!blk_special_request(rq)) {
625 ide_end_request(drive, uptodate, nr_sects);
629 spin_lock_irqsave(&tape->lock, flags);
631 ide_end_drive_cmd(drive, 0, 0);
633 spin_unlock_irqrestore(&tape->lock, flags);
637 static ide_startstop_t idetape_request_sense_callback(ide_drive_t *drive)
639 idetape_tape_t *tape = drive->driver_data;
641 debug_log(DBG_PROCS, "Enter %s\n", __func__);
643 if (!tape->pc->error) {
644 idetape_analyze_error(drive, tape->pc->buf);
645 idetape_end_request(drive, 1, 0);
647 printk(KERN_ERR "ide-tape: Error in REQUEST SENSE itself - "
648 "Aborting request!\n");
649 idetape_end_request(drive, 0, 0);
654 static void idetape_create_request_sense_cmd(struct ide_atapi_pc *pc)
657 pc->c[0] = REQUEST_SENSE;
660 pc->idetape_callback = &idetape_request_sense_callback;
663 static void idetape_init_rq(struct request *rq, u8 cmd)
665 blk_rq_init(NULL, rq);
666 rq->cmd_type = REQ_TYPE_SPECIAL;
671 * Generate a new packet command request in front of the request queue, before
672 * the current request, so that it will be processed immediately, on the next
673 * pass through the driver. The function below is called from the request
674 * handling part of the driver (the "bottom" part). Safe storage for the request
675 * should be allocated with ide_tape_next_{pc,rq}_storage() prior to that.
677 * Memory for those requests is pre-allocated at initialization time, and is
678 * limited to IDETAPE_PC_STACK requests. We assume that we have enough space for
679 * the maximum possible number of inter-dependent packet commands.
681 * The higher level of the driver - The ioctl handler and the character device
682 * handling functions should queue request to the lower level part and wait for
683 * their completion using idetape_queue_pc_tail or idetape_queue_rw_tail.
685 static void idetape_queue_pc_head(ide_drive_t *drive, struct ide_atapi_pc *pc,
688 struct ide_tape_obj *tape = drive->driver_data;
690 idetape_init_rq(rq, REQ_IDETAPE_PC1);
691 rq->cmd_flags |= REQ_PREEMPT;
692 rq->buffer = (char *) pc;
693 rq->rq_disk = tape->disk;
694 (void) ide_do_drive_cmd(drive, rq, ide_preempt);
698 * idetape_retry_pc is called when an error was detected during the
699 * last packet command. We queue a request sense packet command in
700 * the head of the request list.
702 static ide_startstop_t idetape_retry_pc (ide_drive_t *drive)
704 idetape_tape_t *tape = drive->driver_data;
705 struct ide_atapi_pc *pc;
708 (void)ide_read_error(drive);
709 pc = idetape_next_pc_storage(drive);
710 rq = idetape_next_rq_storage(drive);
711 idetape_create_request_sense_cmd(pc);
712 set_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags);
713 idetape_queue_pc_head(drive, pc, rq);
718 * Postpone the current request so that ide.c will be able to service requests
719 * from another device on the same hwgroup while we are polling for DSC.
721 static void idetape_postpone_request(ide_drive_t *drive)
723 idetape_tape_t *tape = drive->driver_data;
725 debug_log(DBG_PROCS, "Enter %s\n", __func__);
727 tape->postponed_rq = HWGROUP(drive)->rq;
728 ide_stall_queue(drive, tape->dsc_poll_freq);
731 typedef void idetape_io_buf(ide_drive_t *, struct ide_atapi_pc *, unsigned int);
734 * This is the usual interrupt handler which will be called during a packet
735 * command. We will transfer some of the data (as requested by the drive) and
736 * will re-point interrupt handler to us. When data transfer is finished, we
737 * will act according to the algorithm described before
740 static ide_startstop_t idetape_pc_intr(ide_drive_t *drive)
742 ide_hwif_t *hwif = drive->hwif;
743 idetape_tape_t *tape = drive->driver_data;
744 struct ide_atapi_pc *pc = tape->pc;
745 xfer_func_t *xferfunc;
746 idetape_io_buf *iobuf;
749 static int error_sim_count;
754 debug_log(DBG_PROCS, "Enter %s - interrupt handler\n", __func__);
756 /* Clear the interrupt */
757 stat = ide_read_status(drive);
759 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
760 if (hwif->dma_ops->dma_end(drive) || (stat & ERR_STAT)) {
762 * A DMA error is sometimes expected. For example,
763 * if the tape is crossing a filemark during a
764 * READ command, it will issue an irq and position
765 * itself before the filemark, so that only a partial
766 * data transfer will occur (which causes the DMA
767 * error). In that case, we will later ask the tape
768 * how much bytes of the original request were
769 * actually transferred (we can't receive that
770 * information from the DMA engine on most chipsets).
774 * On the contrary, a DMA error is never expected;
775 * it usually indicates a hardware error or abort.
776 * If the tape crosses a filemark during a READ
777 * command, it will issue an irq and position itself
778 * after the filemark (not before). Only a partial
779 * data transfer will occur, but no DMA error.
782 pc->flags |= PC_FLAG_DMA_ERROR;
784 pc->xferred = pc->req_xfer;
785 idetape_update_buffers(pc);
787 debug_log(DBG_PROCS, "DMA finished\n");
791 /* No more interrupts */
792 if ((stat & DRQ_STAT) == 0) {
793 debug_log(DBG_SENSE, "Packet command completed, %d bytes"
794 " transferred\n", pc->xferred);
796 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
800 if ((pc->c[0] == WRITE_6 || pc->c[0] == READ_6) &&
801 (++error_sim_count % 100) == 0) {
802 printk(KERN_INFO "ide-tape: %s: simulating error\n",
807 if ((stat & ERR_STAT) && pc->c[0] == REQUEST_SENSE)
809 if ((stat & ERR_STAT) || (pc->flags & PC_FLAG_DMA_ERROR)) {
811 debug_log(DBG_ERR, "%s: I/O error\n", tape->name);
813 if (pc->c[0] == REQUEST_SENSE) {
814 printk(KERN_ERR "ide-tape: I/O error in request"
816 return ide_do_reset(drive);
818 debug_log(DBG_ERR, "[cmd %x]: check condition\n",
821 /* Retry operation */
822 return idetape_retry_pc(drive);
825 if ((pc->flags & PC_FLAG_WAIT_FOR_DSC) &&
826 (stat & SEEK_STAT) == 0) {
827 /* Media access command */
828 tape->dsc_polling_start = jiffies;
829 tape->dsc_poll_freq = IDETAPE_DSC_MA_FAST;
830 tape->dsc_timeout = jiffies + IDETAPE_DSC_MA_TIMEOUT;
831 /* Allow ide.c to handle other requests */
832 idetape_postpone_request(drive);
835 if (tape->failed_pc == pc)
836 tape->failed_pc = NULL;
837 /* Command finished - Call the callback function */
838 return pc->idetape_callback(drive);
841 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
842 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
843 printk(KERN_ERR "ide-tape: The tape wants to issue more "
844 "interrupts in DMA mode\n");
845 printk(KERN_ERR "ide-tape: DMA disabled, reverting to PIO\n");
847 return ide_do_reset(drive);
849 /* Get the number of bytes to transfer on this interrupt. */
850 bcount = (hwif->INB(hwif->io_ports.lbah_addr) << 8) |
851 hwif->INB(hwif->io_ports.lbam_addr);
853 ireason = hwif->INB(hwif->io_ports.nsect_addr);
856 printk(KERN_ERR "ide-tape: CoD != 0 in %s\n", __func__);
857 return ide_do_reset(drive);
859 if (((ireason & IO) == IO) == !!(pc->flags & PC_FLAG_WRITING)) {
860 /* Hopefully, we will never get here */
861 printk(KERN_ERR "ide-tape: We wanted to %s, ",
862 (ireason & IO) ? "Write" : "Read");
863 printk(KERN_ERR "ide-tape: but the tape wants us to %s !\n",
864 (ireason & IO) ? "Read" : "Write");
865 return ide_do_reset(drive);
867 if (!(pc->flags & PC_FLAG_WRITING)) {
868 /* Reading - Check that we have enough space */
869 temp = pc->xferred + bcount;
870 if (temp > pc->req_xfer) {
871 if (temp > pc->buf_size) {
872 printk(KERN_ERR "ide-tape: The tape wants to "
873 "send us more data than expected "
874 "- discarding data\n");
875 ide_pad_transfer(drive, 0, bcount);
876 ide_set_handler(drive, &idetape_pc_intr,
877 IDETAPE_WAIT_CMD, NULL);
880 debug_log(DBG_SENSE, "The tape wants to send us more "
881 "data than expected - allowing transfer\n");
883 iobuf = &idetape_input_buffers;
884 xferfunc = hwif->input_data;
886 iobuf = &idetape_output_buffers;
887 xferfunc = hwif->output_data;
891 iobuf(drive, pc, bcount);
893 xferfunc(drive, NULL, pc->cur_pos, bcount);
895 /* Update the current position */
896 pc->xferred += bcount;
897 pc->cur_pos += bcount;
899 debug_log(DBG_SENSE, "[cmd %x] transferred %d bytes on that intr.\n",
902 /* And set the interrupt handler again */
903 ide_set_handler(drive, &idetape_pc_intr, IDETAPE_WAIT_CMD, NULL);
908 * Packet Command Interface
910 * The current Packet Command is available in tape->pc, and will not change
911 * until we finish handling it. Each packet command is associated with a
912 * callback function that will be called when the command is finished.
914 * The handling will be done in three stages:
916 * 1. idetape_issue_pc will send the packet command to the drive, and will set
917 * the interrupt handler to idetape_pc_intr.
919 * 2. On each interrupt, idetape_pc_intr will be called. This step will be
920 * repeated until the device signals us that no more interrupts will be issued.
922 * 3. ATAPI Tape media access commands have immediate status with a delayed
923 * process. In case of a successful initiation of a media access packet command,
924 * the DSC bit will be set when the actual execution of the command is finished.
925 * Since the tape drive will not issue an interrupt, we have to poll for this
926 * event. In this case, we define the request as "low priority request" by
927 * setting rq_status to IDETAPE_RQ_POSTPONED, set a timer to poll for DSC and
930 * ide.c will then give higher priority to requests which originate from the
931 * other device, until will change rq_status to RQ_ACTIVE.
933 * 4. When the packet command is finished, it will be checked for errors.
935 * 5. In case an error was found, we queue a request sense packet command in
936 * front of the request queue and retry the operation up to
937 * IDETAPE_MAX_PC_RETRIES times.
939 * 6. In case no error was found, or we decided to give up and not to retry
940 * again, the callback function will be called and then we will handle the next
943 static ide_startstop_t idetape_transfer_pc(ide_drive_t *drive)
945 ide_hwif_t *hwif = drive->hwif;
946 idetape_tape_t *tape = drive->driver_data;
947 struct ide_atapi_pc *pc = tape->pc;
949 ide_startstop_t startstop;
952 if (ide_wait_stat(&startstop, drive, DRQ_STAT, BUSY_STAT, WAIT_READY)) {
953 printk(KERN_ERR "ide-tape: Strange, packet command initiated "
954 "yet DRQ isn't asserted\n");
957 ireason = hwif->INB(hwif->io_ports.nsect_addr);
958 while (retries-- && ((ireason & CD) == 0 || (ireason & IO))) {
959 printk(KERN_ERR "ide-tape: (IO,CoD != (0,1) while issuing "
960 "a packet command, retrying\n");
962 ireason = hwif->INB(hwif->io_ports.nsect_addr);
964 printk(KERN_ERR "ide-tape: (IO,CoD != (0,1) while "
965 "issuing a packet command, ignoring\n");
970 if ((ireason & CD) == 0 || (ireason & IO)) {
971 printk(KERN_ERR "ide-tape: (IO,CoD) != (0,1) while issuing "
972 "a packet command\n");
973 return ide_do_reset(drive);
975 /* Set the interrupt routine */
976 ide_set_handler(drive, &idetape_pc_intr, IDETAPE_WAIT_CMD, NULL);
977 #ifdef CONFIG_BLK_DEV_IDEDMA
978 /* Begin DMA, if necessary */
979 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS)
980 hwif->dma_ops->dma_start(drive);
982 /* Send the actual packet */
983 hwif->output_data(drive, NULL, pc->c, 12);
988 static ide_startstop_t idetape_issue_pc(ide_drive_t *drive,
989 struct ide_atapi_pc *pc)
991 ide_hwif_t *hwif = drive->hwif;
992 idetape_tape_t *tape = drive->driver_data;
996 if (tape->pc->c[0] == REQUEST_SENSE &&
997 pc->c[0] == REQUEST_SENSE) {
998 printk(KERN_ERR "ide-tape: possible ide-tape.c bug - "
999 "Two request sense in serial were issued\n");
1002 if (tape->failed_pc == NULL && pc->c[0] != REQUEST_SENSE)
1003 tape->failed_pc = pc;
1004 /* Set the current packet command */
1007 if (pc->retries > IDETAPE_MAX_PC_RETRIES ||
1008 (pc->flags & PC_FLAG_ABORT)) {
1010 * We will "abort" retrying a packet command in case legitimate
1011 * error code was received (crossing a filemark, or end of the
1012 * media, for example).
1014 if (!(pc->flags & PC_FLAG_ABORT)) {
1015 if (!(pc->c[0] == TEST_UNIT_READY &&
1016 tape->sense_key == 2 && tape->asc == 4 &&
1017 (tape->ascq == 1 || tape->ascq == 8))) {
1018 printk(KERN_ERR "ide-tape: %s: I/O error, "
1019 "pc = %2x, key = %2x, "
1020 "asc = %2x, ascq = %2x\n",
1021 tape->name, pc->c[0],
1022 tape->sense_key, tape->asc,
1026 pc->error = IDETAPE_ERROR_GENERAL;
1028 tape->failed_pc = NULL;
1029 return pc->idetape_callback(drive);
1031 debug_log(DBG_SENSE, "Retry #%d, cmd = %02X\n", pc->retries, pc->c[0]);
1034 /* We haven't transferred any data yet */
1036 pc->cur_pos = pc->buf;
1037 /* Request to transfer the entire buffer at once */
1038 bcount = pc->req_xfer;
1040 if (pc->flags & PC_FLAG_DMA_ERROR) {
1041 pc->flags &= ~PC_FLAG_DMA_ERROR;
1042 printk(KERN_WARNING "ide-tape: DMA disabled, "
1043 "reverting to PIO\n");
1046 if ((pc->flags & PC_FLAG_DMA_RECOMMENDED) && drive->using_dma)
1047 dma_ok = !hwif->dma_ops->dma_setup(drive);
1049 ide_pktcmd_tf_load(drive, IDE_TFLAG_OUT_DEVICE, bcount, dma_ok);
1052 /* Will begin DMA later */
1053 pc->flags |= PC_FLAG_DMA_IN_PROGRESS;
1054 if (test_bit(IDETAPE_FLAG_DRQ_INTERRUPT, &tape->flags)) {
1055 ide_execute_command(drive, WIN_PACKETCMD, &idetape_transfer_pc,
1056 IDETAPE_WAIT_CMD, NULL);
1059 ide_execute_pkt_cmd(drive);
1060 return idetape_transfer_pc(drive);
1064 static ide_startstop_t idetape_pc_callback(ide_drive_t *drive)
1066 idetape_tape_t *tape = drive->driver_data;
1068 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1070 idetape_end_request(drive, tape->pc->error ? 0 : 1, 0);
1074 /* A mode sense command is used to "sense" tape parameters. */
1075 static void idetape_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
1077 idetape_init_pc(pc);
1078 pc->c[0] = MODE_SENSE;
1079 if (page_code != IDETAPE_BLOCK_DESCRIPTOR)
1080 /* DBD = 1 - Don't return block descriptors */
1082 pc->c[2] = page_code;
1084 * Changed pc->c[3] to 0 (255 will at best return unused info).
1086 * For SCSI this byte is defined as subpage instead of high byte
1087 * of length and some IDE drives seem to interpret it this way
1088 * and return an error when 255 is used.
1091 /* We will just discard data in that case */
1093 if (page_code == IDETAPE_BLOCK_DESCRIPTOR)
1095 else if (page_code == IDETAPE_CAPABILITIES_PAGE)
1099 pc->idetape_callback = &idetape_pc_callback;
1102 static ide_startstop_t idetape_media_access_finished(ide_drive_t *drive)
1104 idetape_tape_t *tape = drive->driver_data;
1105 struct ide_atapi_pc *pc = tape->pc;
1108 stat = ide_read_status(drive);
1110 if (stat & SEEK_STAT) {
1111 if (stat & ERR_STAT) {
1112 /* Error detected */
1113 if (pc->c[0] != TEST_UNIT_READY)
1114 printk(KERN_ERR "ide-tape: %s: I/O error, ",
1116 /* Retry operation */
1117 return idetape_retry_pc(drive);
1120 if (tape->failed_pc == pc)
1121 tape->failed_pc = NULL;
1123 pc->error = IDETAPE_ERROR_GENERAL;
1124 tape->failed_pc = NULL;
1126 return pc->idetape_callback(drive);
1129 static ide_startstop_t idetape_rw_callback(ide_drive_t *drive)
1131 idetape_tape_t *tape = drive->driver_data;
1132 struct request *rq = HWGROUP(drive)->rq;
1133 int blocks = tape->pc->xferred / tape->blk_size;
1135 tape->avg_size += blocks * tape->blk_size;
1137 if (time_after_eq(jiffies, tape->avg_time + HZ)) {
1138 tape->avg_speed = tape->avg_size * HZ /
1139 (jiffies - tape->avg_time) / 1024;
1141 tape->avg_time = jiffies;
1143 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1145 tape->first_frame += blocks;
1146 rq->current_nr_sectors -= blocks;
1148 if (!tape->pc->error)
1149 idetape_end_request(drive, 1, 0);
1151 idetape_end_request(drive, tape->pc->error, 0);
1155 static void idetape_create_read_cmd(idetape_tape_t *tape,
1156 struct ide_atapi_pc *pc,
1157 unsigned int length, struct idetape_bh *bh)
1159 idetape_init_pc(pc);
1161 put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
1163 pc->idetape_callback = &idetape_rw_callback;
1165 atomic_set(&bh->b_count, 0);
1167 pc->buf_size = length * tape->blk_size;
1168 pc->req_xfer = pc->buf_size;
1169 if (pc->req_xfer == tape->buffer_size)
1170 pc->flags |= PC_FLAG_DMA_RECOMMENDED;
1173 static void idetape_create_write_cmd(idetape_tape_t *tape,
1174 struct ide_atapi_pc *pc,
1175 unsigned int length, struct idetape_bh *bh)
1177 idetape_init_pc(pc);
1179 put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
1181 pc->idetape_callback = &idetape_rw_callback;
1182 pc->flags |= PC_FLAG_WRITING;
1184 pc->b_data = bh->b_data;
1185 pc->b_count = atomic_read(&bh->b_count);
1187 pc->buf_size = length * tape->blk_size;
1188 pc->req_xfer = pc->buf_size;
1189 if (pc->req_xfer == tape->buffer_size)
1190 pc->flags |= PC_FLAG_DMA_RECOMMENDED;
1193 static ide_startstop_t idetape_do_request(ide_drive_t *drive,
1194 struct request *rq, sector_t block)
1196 idetape_tape_t *tape = drive->driver_data;
1197 struct ide_atapi_pc *pc = NULL;
1198 struct request *postponed_rq = tape->postponed_rq;
1201 debug_log(DBG_SENSE, "sector: %ld, nr_sectors: %ld,"
1202 " current_nr_sectors: %d\n",
1203 rq->sector, rq->nr_sectors, rq->current_nr_sectors);
1205 if (!blk_special_request(rq)) {
1206 /* We do not support buffer cache originated requests. */
1207 printk(KERN_NOTICE "ide-tape: %s: Unsupported request in "
1208 "request queue (%d)\n", drive->name, rq->cmd_type);
1209 ide_end_request(drive, 0, 0);
1213 /* Retry a failed packet command */
1214 if (tape->failed_pc && tape->pc->c[0] == REQUEST_SENSE)
1215 return idetape_issue_pc(drive, tape->failed_pc);
1217 if (postponed_rq != NULL)
1218 if (rq != postponed_rq) {
1219 printk(KERN_ERR "ide-tape: ide-tape.c bug - "
1220 "Two DSC requests were queued\n");
1221 idetape_end_request(drive, 0, 0);
1225 tape->postponed_rq = NULL;
1228 * If the tape is still busy, postpone our request and service
1229 * the other device meanwhile.
1231 stat = ide_read_status(drive);
1233 if (!drive->dsc_overlap && !(rq->cmd[0] & REQ_IDETAPE_PC2))
1234 set_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags);
1236 if (drive->post_reset == 1) {
1237 set_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags);
1238 drive->post_reset = 0;
1241 if (!test_and_clear_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags) &&
1242 (stat & SEEK_STAT) == 0) {
1243 if (postponed_rq == NULL) {
1244 tape->dsc_polling_start = jiffies;
1245 tape->dsc_poll_freq = tape->best_dsc_rw_freq;
1246 tape->dsc_timeout = jiffies + IDETAPE_DSC_RW_TIMEOUT;
1247 } else if (time_after(jiffies, tape->dsc_timeout)) {
1248 printk(KERN_ERR "ide-tape: %s: DSC timeout\n",
1250 if (rq->cmd[0] & REQ_IDETAPE_PC2) {
1251 idetape_media_access_finished(drive);
1254 return ide_do_reset(drive);
1256 } else if (time_after(jiffies,
1257 tape->dsc_polling_start +
1258 IDETAPE_DSC_MA_THRESHOLD))
1259 tape->dsc_poll_freq = IDETAPE_DSC_MA_SLOW;
1260 idetape_postpone_request(drive);
1263 if (rq->cmd[0] & REQ_IDETAPE_READ) {
1264 pc = idetape_next_pc_storage(drive);
1265 idetape_create_read_cmd(tape, pc, rq->current_nr_sectors,
1266 (struct idetape_bh *)rq->special);
1269 if (rq->cmd[0] & REQ_IDETAPE_WRITE) {
1270 pc = idetape_next_pc_storage(drive);
1271 idetape_create_write_cmd(tape, pc, rq->current_nr_sectors,
1272 (struct idetape_bh *)rq->special);
1275 if (rq->cmd[0] & REQ_IDETAPE_PC1) {
1276 pc = (struct ide_atapi_pc *) rq->buffer;
1277 rq->cmd[0] &= ~(REQ_IDETAPE_PC1);
1278 rq->cmd[0] |= REQ_IDETAPE_PC2;
1281 if (rq->cmd[0] & REQ_IDETAPE_PC2) {
1282 idetape_media_access_finished(drive);
1287 return idetape_issue_pc(drive, pc);
1291 * The function below uses __get_free_pages to allocate a data buffer of size
1292 * tape->buffer_size (or a bit more). We attempt to combine sequential pages as
1295 * It returns a pointer to the newly allocated buffer, or NULL in case of
1298 static struct idetape_bh *ide_tape_kmalloc_buffer(idetape_tape_t *tape,
1299 int full, int clear)
1301 struct idetape_bh *prev_bh, *bh, *merge_bh;
1302 int pages = tape->pages_per_buffer;
1303 unsigned int order, b_allocd;
1304 char *b_data = NULL;
1306 merge_bh = kmalloc(sizeof(struct idetape_bh), GFP_KERNEL);
1311 order = fls(pages) - 1;
1312 bh->b_data = (char *) __get_free_pages(GFP_KERNEL, order);
1315 b_allocd = (1 << order) * PAGE_SIZE;
1319 memset(bh->b_data, 0, b_allocd);
1320 bh->b_reqnext = NULL;
1321 bh->b_size = b_allocd;
1322 atomic_set(&bh->b_count, full ? bh->b_size : 0);
1325 order = fls(pages) - 1;
1326 b_data = (char *) __get_free_pages(GFP_KERNEL, order);
1329 b_allocd = (1 << order) * PAGE_SIZE;
1332 memset(b_data, 0, b_allocd);
1334 /* newly allocated page frames below buffer header or ...*/
1335 if (bh->b_data == b_data + b_allocd) {
1336 bh->b_size += b_allocd;
1337 bh->b_data -= b_allocd;
1339 atomic_add(b_allocd, &bh->b_count);
1342 /* they are above the header */
1343 if (b_data == bh->b_data + bh->b_size) {
1344 bh->b_size += b_allocd;
1346 atomic_add(b_allocd, &bh->b_count);
1350 bh = kmalloc(sizeof(struct idetape_bh), GFP_KERNEL);
1352 free_pages((unsigned long) b_data, order);
1355 bh->b_reqnext = NULL;
1356 bh->b_data = b_data;
1357 bh->b_size = b_allocd;
1358 atomic_set(&bh->b_count, full ? bh->b_size : 0);
1359 prev_bh->b_reqnext = bh;
1364 bh->b_size -= tape->excess_bh_size;
1366 atomic_sub(tape->excess_bh_size, &bh->b_count);
1369 ide_tape_kfree_buffer(tape);
1373 static int idetape_copy_stage_from_user(idetape_tape_t *tape,
1374 const char __user *buf, int n)
1376 struct idetape_bh *bh = tape->bh;
1382 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
1386 count = min((unsigned int)
1387 (bh->b_size - atomic_read(&bh->b_count)),
1389 if (copy_from_user(bh->b_data + atomic_read(&bh->b_count), buf,
1393 atomic_add(count, &bh->b_count);
1395 if (atomic_read(&bh->b_count) == bh->b_size) {
1398 atomic_set(&bh->b_count, 0);
1405 static int idetape_copy_stage_to_user(idetape_tape_t *tape, char __user *buf,
1408 struct idetape_bh *bh = tape->bh;
1414 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
1418 count = min(tape->b_count, n);
1419 if (copy_to_user(buf, tape->b_data, count))
1422 tape->b_data += count;
1423 tape->b_count -= count;
1425 if (!tape->b_count) {
1429 tape->b_data = bh->b_data;
1430 tape->b_count = atomic_read(&bh->b_count);
1437 static void idetape_init_merge_buffer(idetape_tape_t *tape)
1439 struct idetape_bh *bh = tape->merge_bh;
1440 tape->bh = tape->merge_bh;
1442 if (tape->chrdev_dir == IDETAPE_DIR_WRITE)
1443 atomic_set(&bh->b_count, 0);
1445 tape->b_data = bh->b_data;
1446 tape->b_count = atomic_read(&bh->b_count);
1450 static ide_startstop_t idetape_read_position_callback(ide_drive_t *drive)
1452 idetape_tape_t *tape = drive->driver_data;
1453 u8 *readpos = tape->pc->buf;
1455 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1457 if (!tape->pc->error) {
1458 debug_log(DBG_SENSE, "BOP - %s\n",
1459 (readpos[0] & 0x80) ? "Yes" : "No");
1460 debug_log(DBG_SENSE, "EOP - %s\n",
1461 (readpos[0] & 0x40) ? "Yes" : "No");
1463 if (readpos[0] & 0x4) {
1464 printk(KERN_INFO "ide-tape: Block location is unknown"
1466 clear_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags);
1467 idetape_end_request(drive, 0, 0);
1469 debug_log(DBG_SENSE, "Block Location - %u\n",
1470 be32_to_cpu(*(u32 *)&readpos[4]));
1472 tape->partition = readpos[1];
1474 be32_to_cpu(*(u32 *)&readpos[4]);
1475 set_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags);
1476 idetape_end_request(drive, 1, 0);
1479 idetape_end_request(drive, 0, 0);
1485 * Write a filemark if write_filemark=1. Flush the device buffers without
1486 * writing a filemark otherwise.
1488 static void idetape_create_write_filemark_cmd(ide_drive_t *drive,
1489 struct ide_atapi_pc *pc, int write_filemark)
1491 idetape_init_pc(pc);
1492 pc->c[0] = WRITE_FILEMARKS;
1493 pc->c[4] = write_filemark;
1494 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1495 pc->idetape_callback = &idetape_pc_callback;
1498 static void idetape_create_test_unit_ready_cmd(struct ide_atapi_pc *pc)
1500 idetape_init_pc(pc);
1501 pc->c[0] = TEST_UNIT_READY;
1502 pc->idetape_callback = &idetape_pc_callback;
1506 * We add a special packet command request to the tail of the request queue, and
1507 * wait for it to be serviced. This is not to be called from within the request
1508 * handling part of the driver! We allocate here data on the stack and it is
1509 * valid until the request is finished. This is not the case for the bottom part
1510 * of the driver, where we are always leaving the functions to wait for an
1511 * interrupt or a timer event.
1513 * From the bottom part of the driver, we should allocate safe memory using
1514 * idetape_next_pc_storage() and ide_tape_next_rq_storage(), and add the request
1515 * to the request list without waiting for it to be serviced! In that case, we
1516 * usually use idetape_queue_pc_head().
1518 static int idetape_queue_pc_tail(ide_drive_t *drive, struct ide_atapi_pc *pc)
1520 struct ide_tape_obj *tape = drive->driver_data;
1524 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
1525 rq->cmd_type = REQ_TYPE_SPECIAL;
1526 rq->cmd[0] = REQ_IDETAPE_PC1;
1527 rq->buffer = (char *)pc;
1528 error = blk_execute_rq(drive->queue, tape->disk, rq, 0);
1529 blk_put_request(rq);
1533 static void idetape_create_load_unload_cmd(ide_drive_t *drive,
1534 struct ide_atapi_pc *pc, int cmd)
1536 idetape_init_pc(pc);
1537 pc->c[0] = START_STOP;
1539 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1540 pc->idetape_callback = &idetape_pc_callback;
1543 static int idetape_wait_ready(ide_drive_t *drive, unsigned long timeout)
1545 idetape_tape_t *tape = drive->driver_data;
1546 struct ide_atapi_pc pc;
1547 int load_attempted = 0;
1549 /* Wait for the tape to become ready */
1550 set_bit(IDETAPE_FLAG_MEDIUM_PRESENT, &tape->flags);
1552 while (time_before(jiffies, timeout)) {
1553 idetape_create_test_unit_ready_cmd(&pc);
1554 if (!idetape_queue_pc_tail(drive, &pc))
1556 if ((tape->sense_key == 2 && tape->asc == 4 && tape->ascq == 2)
1557 || (tape->asc == 0x3A)) {
1561 idetape_create_load_unload_cmd(drive, &pc,
1562 IDETAPE_LU_LOAD_MASK);
1563 idetape_queue_pc_tail(drive, &pc);
1565 /* not about to be ready */
1566 } else if (!(tape->sense_key == 2 && tape->asc == 4 &&
1567 (tape->ascq == 1 || tape->ascq == 8)))
1574 static int idetape_flush_tape_buffers(ide_drive_t *drive)
1576 struct ide_atapi_pc pc;
1579 idetape_create_write_filemark_cmd(drive, &pc, 0);
1580 rc = idetape_queue_pc_tail(drive, &pc);
1583 idetape_wait_ready(drive, 60 * 5 * HZ);
1587 static void idetape_create_read_position_cmd(struct ide_atapi_pc *pc)
1589 idetape_init_pc(pc);
1590 pc->c[0] = READ_POSITION;
1592 pc->idetape_callback = &idetape_read_position_callback;
1595 static int idetape_read_position(ide_drive_t *drive)
1597 idetape_tape_t *tape = drive->driver_data;
1598 struct ide_atapi_pc pc;
1601 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1603 idetape_create_read_position_cmd(&pc);
1604 if (idetape_queue_pc_tail(drive, &pc))
1606 position = tape->first_frame;
1610 static void idetape_create_locate_cmd(ide_drive_t *drive,
1611 struct ide_atapi_pc *pc,
1612 unsigned int block, u8 partition, int skip)
1614 idetape_init_pc(pc);
1615 pc->c[0] = POSITION_TO_ELEMENT;
1617 put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[3]);
1618 pc->c[8] = partition;
1619 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1620 pc->idetape_callback = &idetape_pc_callback;
1623 static int idetape_create_prevent_cmd(ide_drive_t *drive,
1624 struct ide_atapi_pc *pc, int prevent)
1626 idetape_tape_t *tape = drive->driver_data;
1628 /* device supports locking according to capabilities page */
1629 if (!(tape->caps[6] & 0x01))
1632 idetape_init_pc(pc);
1633 pc->c[0] = ALLOW_MEDIUM_REMOVAL;
1635 pc->idetape_callback = &idetape_pc_callback;
1639 static void __ide_tape_discard_merge_buffer(ide_drive_t *drive)
1641 idetape_tape_t *tape = drive->driver_data;
1643 if (tape->chrdev_dir != IDETAPE_DIR_READ)
1646 clear_bit(IDETAPE_FLAG_FILEMARK, &tape->flags);
1647 tape->merge_bh_size = 0;
1648 if (tape->merge_bh != NULL) {
1649 ide_tape_kfree_buffer(tape);
1650 tape->merge_bh = NULL;
1653 tape->chrdev_dir = IDETAPE_DIR_NONE;
1657 * Position the tape to the requested block using the LOCATE packet command.
1658 * A READ POSITION command is then issued to check where we are positioned. Like
1659 * all higher level operations, we queue the commands at the tail of the request
1660 * queue and wait for their completion.
1662 static int idetape_position_tape(ide_drive_t *drive, unsigned int block,
1663 u8 partition, int skip)
1665 idetape_tape_t *tape = drive->driver_data;
1667 struct ide_atapi_pc pc;
1669 if (tape->chrdev_dir == IDETAPE_DIR_READ)
1670 __ide_tape_discard_merge_buffer(drive);
1671 idetape_wait_ready(drive, 60 * 5 * HZ);
1672 idetape_create_locate_cmd(drive, &pc, block, partition, skip);
1673 retval = idetape_queue_pc_tail(drive, &pc);
1677 idetape_create_read_position_cmd(&pc);
1678 return (idetape_queue_pc_tail(drive, &pc));
1681 static void ide_tape_discard_merge_buffer(ide_drive_t *drive,
1682 int restore_position)
1684 idetape_tape_t *tape = drive->driver_data;
1687 __ide_tape_discard_merge_buffer(drive);
1688 if (restore_position) {
1689 position = idetape_read_position(drive);
1690 seek = position > 0 ? position : 0;
1691 if (idetape_position_tape(drive, seek, 0, 0)) {
1692 printk(KERN_INFO "ide-tape: %s: position_tape failed in"
1693 " %s\n", tape->name, __func__);
1700 * Generate a read/write request for the block device interface and wait for it
1703 static int idetape_queue_rw_tail(ide_drive_t *drive, int cmd, int blocks,
1704 struct idetape_bh *bh)
1706 idetape_tape_t *tape = drive->driver_data;
1710 debug_log(DBG_SENSE, "%s: cmd=%d\n", __func__, cmd);
1712 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
1713 rq->cmd_type = REQ_TYPE_SPECIAL;
1715 rq->rq_disk = tape->disk;
1716 rq->special = (void *)bh;
1717 rq->sector = tape->first_frame;
1718 rq->nr_sectors = blocks;
1719 rq->current_nr_sectors = blocks;
1720 blk_execute_rq(drive->queue, tape->disk, rq, 0);
1722 errors = rq->errors;
1723 ret = tape->blk_size * (blocks - rq->current_nr_sectors);
1724 blk_put_request(rq);
1726 if ((cmd & (REQ_IDETAPE_READ | REQ_IDETAPE_WRITE)) == 0)
1730 idetape_init_merge_buffer(tape);
1731 if (errors == IDETAPE_ERROR_GENERAL)
1736 static void idetape_create_inquiry_cmd(struct ide_atapi_pc *pc)
1738 idetape_init_pc(pc);
1742 pc->idetape_callback = &idetape_pc_callback;
1745 static void idetape_create_rewind_cmd(ide_drive_t *drive,
1746 struct ide_atapi_pc *pc)
1748 idetape_init_pc(pc);
1749 pc->c[0] = REZERO_UNIT;
1750 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1751 pc->idetape_callback = &idetape_pc_callback;
1754 static void idetape_create_erase_cmd(struct ide_atapi_pc *pc)
1756 idetape_init_pc(pc);
1759 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1760 pc->idetape_callback = &idetape_pc_callback;
1763 static void idetape_create_space_cmd(struct ide_atapi_pc *pc, int count, u8 cmd)
1765 idetape_init_pc(pc);
1767 put_unaligned(cpu_to_be32(count), (unsigned int *) &pc->c[1]);
1769 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1770 pc->idetape_callback = &idetape_pc_callback;
1773 /* Queue up a character device originated write request. */
1774 static int idetape_add_chrdev_write_request(ide_drive_t *drive, int blocks)
1776 idetape_tape_t *tape = drive->driver_data;
1778 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
1780 return idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE,
1781 blocks, tape->merge_bh);
1784 static void ide_tape_flush_merge_buffer(ide_drive_t *drive)
1786 idetape_tape_t *tape = drive->driver_data;
1788 struct idetape_bh *bh;
1790 if (tape->chrdev_dir != IDETAPE_DIR_WRITE) {
1791 printk(KERN_ERR "ide-tape: bug: Trying to empty merge buffer"
1792 " but we are not writing.\n");
1795 if (tape->merge_bh_size > tape->buffer_size) {
1796 printk(KERN_ERR "ide-tape: bug: merge_buffer too big\n");
1797 tape->merge_bh_size = tape->buffer_size;
1799 if (tape->merge_bh_size) {
1800 blocks = tape->merge_bh_size / tape->blk_size;
1801 if (tape->merge_bh_size % tape->blk_size) {
1805 i = tape->blk_size - tape->merge_bh_size %
1807 bh = tape->bh->b_reqnext;
1809 atomic_set(&bh->b_count, 0);
1815 printk(KERN_INFO "ide-tape: bug,"
1819 min = min(i, (unsigned int)(bh->b_size -
1820 atomic_read(&bh->b_count)));
1821 memset(bh->b_data + atomic_read(&bh->b_count),
1823 atomic_add(min, &bh->b_count);
1828 (void) idetape_add_chrdev_write_request(drive, blocks);
1829 tape->merge_bh_size = 0;
1831 if (tape->merge_bh != NULL) {
1832 ide_tape_kfree_buffer(tape);
1833 tape->merge_bh = NULL;
1835 tape->chrdev_dir = IDETAPE_DIR_NONE;
1838 static int idetape_init_read(ide_drive_t *drive)
1840 idetape_tape_t *tape = drive->driver_data;
1843 /* Initialize read operation */
1844 if (tape->chrdev_dir != IDETAPE_DIR_READ) {
1845 if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
1846 ide_tape_flush_merge_buffer(drive);
1847 idetape_flush_tape_buffers(drive);
1849 if (tape->merge_bh || tape->merge_bh_size) {
1850 printk(KERN_ERR "ide-tape: merge_bh_size should be"
1852 tape->merge_bh_size = 0;
1854 tape->merge_bh = ide_tape_kmalloc_buffer(tape, 0, 0);
1855 if (!tape->merge_bh)
1857 tape->chrdev_dir = IDETAPE_DIR_READ;
1860 * Issue a read 0 command to ensure that DSC handshake is
1861 * switched from completion mode to buffer available mode.
1862 * No point in issuing this if DSC overlap isn't supported, some
1863 * drives (Seagate STT3401A) will return an error.
1865 if (drive->dsc_overlap) {
1866 bytes_read = idetape_queue_rw_tail(drive,
1867 REQ_IDETAPE_READ, 0,
1869 if (bytes_read < 0) {
1870 ide_tape_kfree_buffer(tape);
1871 tape->merge_bh = NULL;
1872 tape->chrdev_dir = IDETAPE_DIR_NONE;
1881 /* called from idetape_chrdev_read() to service a chrdev read request. */
1882 static int idetape_add_chrdev_read_request(ide_drive_t *drive, int blocks)
1884 idetape_tape_t *tape = drive->driver_data;
1886 debug_log(DBG_PROCS, "Enter %s, %d blocks\n", __func__, blocks);
1888 /* If we are at a filemark, return a read length of 0 */
1889 if (test_bit(IDETAPE_FLAG_FILEMARK, &tape->flags))
1892 idetape_init_read(drive);
1894 return idetape_queue_rw_tail(drive, REQ_IDETAPE_READ, blocks,
1898 static void idetape_pad_zeros(ide_drive_t *drive, int bcount)
1900 idetape_tape_t *tape = drive->driver_data;
1901 struct idetape_bh *bh;
1907 bh = tape->merge_bh;
1908 count = min(tape->buffer_size, bcount);
1910 blocks = count / tape->blk_size;
1912 atomic_set(&bh->b_count,
1913 min(count, (unsigned int)bh->b_size));
1914 memset(bh->b_data, 0, atomic_read(&bh->b_count));
1915 count -= atomic_read(&bh->b_count);
1918 idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE, blocks,
1924 * Rewinds the tape to the Beginning Of the current Partition (BOP). We
1925 * currently support only one partition.
1927 static int idetape_rewind_tape(ide_drive_t *drive)
1930 struct ide_atapi_pc pc;
1931 idetape_tape_t *tape;
1932 tape = drive->driver_data;
1934 debug_log(DBG_SENSE, "Enter %s\n", __func__);
1936 idetape_create_rewind_cmd(drive, &pc);
1937 retval = idetape_queue_pc_tail(drive, &pc);
1941 idetape_create_read_position_cmd(&pc);
1942 retval = idetape_queue_pc_tail(drive, &pc);
1948 /* mtio.h compatible commands should be issued to the chrdev interface. */
1949 static int idetape_blkdev_ioctl(ide_drive_t *drive, unsigned int cmd,
1952 idetape_tape_t *tape = drive->driver_data;
1953 void __user *argp = (void __user *)arg;
1955 struct idetape_config {
1956 int dsc_rw_frequency;
1957 int dsc_media_access_frequency;
1961 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1965 if (copy_from_user(&config, argp, sizeof(config)))
1967 tape->best_dsc_rw_freq = config.dsc_rw_frequency;
1970 config.dsc_rw_frequency = (int) tape->best_dsc_rw_freq;
1971 config.nr_stages = 1;
1972 if (copy_to_user(argp, &config, sizeof(config)))
1981 static int idetape_space_over_filemarks(ide_drive_t *drive, short mt_op,
1984 idetape_tape_t *tape = drive->driver_data;
1985 struct ide_atapi_pc pc;
1986 int retval, count = 0;
1987 int sprev = !!(tape->caps[4] & 0x20);
1991 if (MTBSF == mt_op || MTBSFM == mt_op) {
1994 mt_count = -mt_count;
1997 if (tape->chrdev_dir == IDETAPE_DIR_READ) {
1998 tape->merge_bh_size = 0;
1999 if (test_and_clear_bit(IDETAPE_FLAG_FILEMARK, &tape->flags))
2001 ide_tape_discard_merge_buffer(drive, 0);
2007 idetape_create_space_cmd(&pc, mt_count - count,
2008 IDETAPE_SPACE_OVER_FILEMARK);
2009 return idetape_queue_pc_tail(drive, &pc);
2014 retval = idetape_space_over_filemarks(drive, MTFSF,
2018 count = (MTBSFM == mt_op ? 1 : -1);
2019 return idetape_space_over_filemarks(drive, MTFSF, count);
2021 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
2028 * Our character device read / write functions.
2030 * The tape is optimized to maximize throughput when it is transferring an
2031 * integral number of the "continuous transfer limit", which is a parameter of
2032 * the specific tape (26kB on my particular tape, 32kB for Onstream).
2034 * As of version 1.3 of the driver, the character device provides an abstract
2035 * continuous view of the media - any mix of block sizes (even 1 byte) on the
2036 * same backup/restore procedure is supported. The driver will internally
2037 * convert the requests to the recommended transfer unit, so that an unmatch
2038 * between the user's block size to the recommended size will only result in a
2039 * (slightly) increased driver overhead, but will no longer hit performance.
2040 * This is not applicable to Onstream.
2042 static ssize_t idetape_chrdev_read(struct file *file, char __user *buf,
2043 size_t count, loff_t *ppos)
2045 struct ide_tape_obj *tape = ide_tape_f(file);
2046 ide_drive_t *drive = tape->drive;
2047 ssize_t bytes_read, temp, actually_read = 0, rc;
2049 u16 ctl = *(u16 *)&tape->caps[12];
2051 debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
2053 if (tape->chrdev_dir != IDETAPE_DIR_READ) {
2054 if (test_bit(IDETAPE_FLAG_DETECT_BS, &tape->flags))
2055 if (count > tape->blk_size &&
2056 (count % tape->blk_size) == 0)
2057 tape->user_bs_factor = count / tape->blk_size;
2059 rc = idetape_init_read(drive);
2064 if (tape->merge_bh_size) {
2065 actually_read = min((unsigned int)(tape->merge_bh_size),
2066 (unsigned int)count);
2067 if (idetape_copy_stage_to_user(tape, buf, actually_read))
2069 buf += actually_read;
2070 tape->merge_bh_size -= actually_read;
2071 count -= actually_read;
2073 while (count >= tape->buffer_size) {
2074 bytes_read = idetape_add_chrdev_read_request(drive, ctl);
2075 if (bytes_read <= 0)
2077 if (idetape_copy_stage_to_user(tape, buf, bytes_read))
2080 count -= bytes_read;
2081 actually_read += bytes_read;
2084 bytes_read = idetape_add_chrdev_read_request(drive, ctl);
2085 if (bytes_read <= 0)
2087 temp = min((unsigned long)count, (unsigned long)bytes_read);
2088 if (idetape_copy_stage_to_user(tape, buf, temp))
2090 actually_read += temp;
2091 tape->merge_bh_size = bytes_read-temp;
2094 if (!actually_read && test_bit(IDETAPE_FLAG_FILEMARK, &tape->flags)) {
2095 debug_log(DBG_SENSE, "%s: spacing over filemark\n", tape->name);
2097 idetape_space_over_filemarks(drive, MTFSF, 1);
2101 return ret ? ret : actually_read;
2104 static ssize_t idetape_chrdev_write(struct file *file, const char __user *buf,
2105 size_t count, loff_t *ppos)
2107 struct ide_tape_obj *tape = ide_tape_f(file);
2108 ide_drive_t *drive = tape->drive;
2109 ssize_t actually_written = 0;
2111 u16 ctl = *(u16 *)&tape->caps[12];
2113 /* The drive is write protected. */
2114 if (tape->write_prot)
2117 debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
2119 /* Initialize write operation */
2120 if (tape->chrdev_dir != IDETAPE_DIR_WRITE) {
2121 if (tape->chrdev_dir == IDETAPE_DIR_READ)
2122 ide_tape_discard_merge_buffer(drive, 1);
2123 if (tape->merge_bh || tape->merge_bh_size) {
2124 printk(KERN_ERR "ide-tape: merge_bh_size "
2125 "should be 0 now\n");
2126 tape->merge_bh_size = 0;
2128 tape->merge_bh = ide_tape_kmalloc_buffer(tape, 0, 0);
2129 if (!tape->merge_bh)
2131 tape->chrdev_dir = IDETAPE_DIR_WRITE;
2132 idetape_init_merge_buffer(tape);
2135 * Issue a write 0 command to ensure that DSC handshake is
2136 * switched from completion mode to buffer available mode. No
2137 * point in issuing this if DSC overlap isn't supported, some
2138 * drives (Seagate STT3401A) will return an error.
2140 if (drive->dsc_overlap) {
2141 ssize_t retval = idetape_queue_rw_tail(drive,
2142 REQ_IDETAPE_WRITE, 0,
2145 ide_tape_kfree_buffer(tape);
2146 tape->merge_bh = NULL;
2147 tape->chrdev_dir = IDETAPE_DIR_NONE;
2154 if (tape->merge_bh_size) {
2155 if (tape->merge_bh_size >= tape->buffer_size) {
2156 printk(KERN_ERR "ide-tape: bug: merge buf too big\n");
2157 tape->merge_bh_size = 0;
2159 actually_written = min((unsigned int)
2160 (tape->buffer_size - tape->merge_bh_size),
2161 (unsigned int)count);
2162 if (idetape_copy_stage_from_user(tape, buf, actually_written))
2164 buf += actually_written;
2165 tape->merge_bh_size += actually_written;
2166 count -= actually_written;
2168 if (tape->merge_bh_size == tape->buffer_size) {
2170 tape->merge_bh_size = 0;
2171 retval = idetape_add_chrdev_write_request(drive, ctl);
2176 while (count >= tape->buffer_size) {
2178 if (idetape_copy_stage_from_user(tape, buf, tape->buffer_size))
2180 buf += tape->buffer_size;
2181 count -= tape->buffer_size;
2182 retval = idetape_add_chrdev_write_request(drive, ctl);
2183 actually_written += tape->buffer_size;
2188 actually_written += count;
2189 if (idetape_copy_stage_from_user(tape, buf, count))
2191 tape->merge_bh_size += count;
2193 return ret ? ret : actually_written;
2196 static int idetape_write_filemark(ide_drive_t *drive)
2198 struct ide_atapi_pc pc;
2200 /* Write a filemark */
2201 idetape_create_write_filemark_cmd(drive, &pc, 1);
2202 if (idetape_queue_pc_tail(drive, &pc)) {
2203 printk(KERN_ERR "ide-tape: Couldn't write a filemark\n");
2210 * Called from idetape_chrdev_ioctl when the general mtio MTIOCTOP ioctl is
2213 * Note: MTBSF and MTBSFM are not supported when the tape doesn't support
2214 * spacing over filemarks in the reverse direction. In this case, MTFSFM is also
2215 * usually not supported.
2217 * The following commands are currently not supported:
2219 * MTFSS, MTBSS, MTWSM, MTSETDENSITY, MTSETDRVBUFFER, MT_ST_BOOLEANS,
2220 * MT_ST_WRITE_THRESHOLD.
2222 static int idetape_mtioctop(ide_drive_t *drive, short mt_op, int mt_count)
2224 idetape_tape_t *tape = drive->driver_data;
2225 struct ide_atapi_pc pc;
2228 debug_log(DBG_ERR, "Handling MTIOCTOP ioctl: mt_op=%d, mt_count=%d\n",
2238 return idetape_space_over_filemarks(drive, mt_op, mt_count);
2245 if (tape->write_prot)
2247 ide_tape_discard_merge_buffer(drive, 1);
2248 for (i = 0; i < mt_count; i++) {
2249 retval = idetape_write_filemark(drive);
2255 ide_tape_discard_merge_buffer(drive, 0);
2256 if (idetape_rewind_tape(drive))
2260 ide_tape_discard_merge_buffer(drive, 0);
2261 idetape_create_load_unload_cmd(drive, &pc,
2262 IDETAPE_LU_LOAD_MASK);
2263 return idetape_queue_pc_tail(drive, &pc);
2267 * If door is locked, attempt to unlock before
2268 * attempting to eject.
2270 if (tape->door_locked) {
2271 if (idetape_create_prevent_cmd(drive, &pc, 0))
2272 if (!idetape_queue_pc_tail(drive, &pc))
2273 tape->door_locked = DOOR_UNLOCKED;
2275 ide_tape_discard_merge_buffer(drive, 0);
2276 idetape_create_load_unload_cmd(drive, &pc,
2277 !IDETAPE_LU_LOAD_MASK);
2278 retval = idetape_queue_pc_tail(drive, &pc);
2280 clear_bit(IDETAPE_FLAG_MEDIUM_PRESENT, &tape->flags);
2283 ide_tape_discard_merge_buffer(drive, 0);
2284 return idetape_flush_tape_buffers(drive);
2286 ide_tape_discard_merge_buffer(drive, 0);
2287 idetape_create_load_unload_cmd(drive, &pc,
2288 IDETAPE_LU_RETENSION_MASK | IDETAPE_LU_LOAD_MASK);
2289 return idetape_queue_pc_tail(drive, &pc);
2291 idetape_create_space_cmd(&pc, 0, IDETAPE_SPACE_TO_EOD);
2292 return idetape_queue_pc_tail(drive, &pc);
2294 (void)idetape_rewind_tape(drive);
2295 idetape_create_erase_cmd(&pc);
2296 return idetape_queue_pc_tail(drive, &pc);
2299 if (mt_count < tape->blk_size ||
2300 mt_count % tape->blk_size)
2302 tape->user_bs_factor = mt_count / tape->blk_size;
2303 clear_bit(IDETAPE_FLAG_DETECT_BS, &tape->flags);
2305 set_bit(IDETAPE_FLAG_DETECT_BS, &tape->flags);
2308 ide_tape_discard_merge_buffer(drive, 0);
2309 return idetape_position_tape(drive,
2310 mt_count * tape->user_bs_factor, tape->partition, 0);
2312 ide_tape_discard_merge_buffer(drive, 0);
2313 return idetape_position_tape(drive, 0, mt_count, 0);
2317 if (!idetape_create_prevent_cmd(drive, &pc, 1))
2319 retval = idetape_queue_pc_tail(drive, &pc);
2322 tape->door_locked = DOOR_EXPLICITLY_LOCKED;
2325 if (!idetape_create_prevent_cmd(drive, &pc, 0))
2327 retval = idetape_queue_pc_tail(drive, &pc);
2330 tape->door_locked = DOOR_UNLOCKED;
2333 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
2340 * Our character device ioctls. General mtio.h magnetic io commands are
2341 * supported here, and not in the corresponding block interface. Our own
2342 * ide-tape ioctls are supported on both interfaces.
2344 static int idetape_chrdev_ioctl(struct inode *inode, struct file *file,
2345 unsigned int cmd, unsigned long arg)
2347 struct ide_tape_obj *tape = ide_tape_f(file);
2348 ide_drive_t *drive = tape->drive;
2352 int block_offset = 0, position = tape->first_frame;
2353 void __user *argp = (void __user *)arg;
2355 debug_log(DBG_CHRDEV, "Enter %s, cmd=%u\n", __func__, cmd);
2357 if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
2358 ide_tape_flush_merge_buffer(drive);
2359 idetape_flush_tape_buffers(drive);
2361 if (cmd == MTIOCGET || cmd == MTIOCPOS) {
2362 block_offset = tape->merge_bh_size /
2363 (tape->blk_size * tape->user_bs_factor);
2364 position = idetape_read_position(drive);
2370 if (copy_from_user(&mtop, argp, sizeof(struct mtop)))
2372 return idetape_mtioctop(drive, mtop.mt_op, mtop.mt_count);
2374 memset(&mtget, 0, sizeof(struct mtget));
2375 mtget.mt_type = MT_ISSCSI2;
2376 mtget.mt_blkno = position / tape->user_bs_factor - block_offset;
2378 ((tape->blk_size * tape->user_bs_factor)
2379 << MT_ST_BLKSIZE_SHIFT) & MT_ST_BLKSIZE_MASK;
2381 if (tape->drv_write_prot)
2382 mtget.mt_gstat |= GMT_WR_PROT(0xffffffff);
2384 if (copy_to_user(argp, &mtget, sizeof(struct mtget)))
2388 mtpos.mt_blkno = position / tape->user_bs_factor - block_offset;
2389 if (copy_to_user(argp, &mtpos, sizeof(struct mtpos)))
2393 if (tape->chrdev_dir == IDETAPE_DIR_READ)
2394 ide_tape_discard_merge_buffer(drive, 1);
2395 return idetape_blkdev_ioctl(drive, cmd, arg);
2400 * Do a mode sense page 0 with block descriptor and if it succeeds set the tape
2401 * block size with the reported value.
2403 static void ide_tape_get_bsize_from_bdesc(ide_drive_t *drive)
2405 idetape_tape_t *tape = drive->driver_data;
2406 struct ide_atapi_pc pc;
2408 idetape_create_mode_sense_cmd(&pc, IDETAPE_BLOCK_DESCRIPTOR);
2409 if (idetape_queue_pc_tail(drive, &pc)) {
2410 printk(KERN_ERR "ide-tape: Can't get block descriptor\n");
2411 if (tape->blk_size == 0) {
2412 printk(KERN_WARNING "ide-tape: Cannot deal with zero "
2413 "block size, assuming 32k\n");
2414 tape->blk_size = 32768;
2418 tape->blk_size = (pc.buf[4 + 5] << 16) +
2419 (pc.buf[4 + 6] << 8) +
2421 tape->drv_write_prot = (pc.buf[2] & 0x80) >> 7;
2424 static int idetape_chrdev_open(struct inode *inode, struct file *filp)
2426 unsigned int minor = iminor(inode), i = minor & ~0xc0;
2428 idetape_tape_t *tape;
2429 struct ide_atapi_pc pc;
2432 if (i >= MAX_HWIFS * MAX_DRIVES)
2435 tape = ide_tape_chrdev_get(i);
2439 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
2442 * We really want to do nonseekable_open(inode, filp); here, but some
2443 * versions of tar incorrectly call lseek on tapes and bail out if that
2444 * fails. So we disallow pread() and pwrite(), but permit lseeks.
2446 filp->f_mode &= ~(FMODE_PREAD | FMODE_PWRITE);
2448 drive = tape->drive;
2450 filp->private_data = tape;
2452 if (test_and_set_bit(IDETAPE_FLAG_BUSY, &tape->flags)) {
2457 retval = idetape_wait_ready(drive, 60 * HZ);
2459 clear_bit(IDETAPE_FLAG_BUSY, &tape->flags);
2460 printk(KERN_ERR "ide-tape: %s: drive not ready\n", tape->name);
2464 idetape_read_position(drive);
2465 if (!test_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags))
2466 (void)idetape_rewind_tape(drive);
2468 /* Read block size and write protect status from drive. */
2469 ide_tape_get_bsize_from_bdesc(drive);
2471 /* Set write protect flag if device is opened as read-only. */
2472 if ((filp->f_flags & O_ACCMODE) == O_RDONLY)
2473 tape->write_prot = 1;
2475 tape->write_prot = tape->drv_write_prot;
2477 /* Make sure drive isn't write protected if user wants to write. */
2478 if (tape->write_prot) {
2479 if ((filp->f_flags & O_ACCMODE) == O_WRONLY ||
2480 (filp->f_flags & O_ACCMODE) == O_RDWR) {
2481 clear_bit(IDETAPE_FLAG_BUSY, &tape->flags);
2487 /* Lock the tape drive door so user can't eject. */
2488 if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
2489 if (idetape_create_prevent_cmd(drive, &pc, 1)) {
2490 if (!idetape_queue_pc_tail(drive, &pc)) {
2491 if (tape->door_locked != DOOR_EXPLICITLY_LOCKED)
2492 tape->door_locked = DOOR_LOCKED;
2503 static void idetape_write_release(ide_drive_t *drive, unsigned int minor)
2505 idetape_tape_t *tape = drive->driver_data;
2507 ide_tape_flush_merge_buffer(drive);
2508 tape->merge_bh = ide_tape_kmalloc_buffer(tape, 1, 0);
2509 if (tape->merge_bh != NULL) {
2510 idetape_pad_zeros(drive, tape->blk_size *
2511 (tape->user_bs_factor - 1));
2512 ide_tape_kfree_buffer(tape);
2513 tape->merge_bh = NULL;
2515 idetape_write_filemark(drive);
2516 idetape_flush_tape_buffers(drive);
2517 idetape_flush_tape_buffers(drive);
2520 static int idetape_chrdev_release(struct inode *inode, struct file *filp)
2522 struct ide_tape_obj *tape = ide_tape_f(filp);
2523 ide_drive_t *drive = tape->drive;
2524 struct ide_atapi_pc pc;
2525 unsigned int minor = iminor(inode);
2528 tape = drive->driver_data;
2530 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
2532 if (tape->chrdev_dir == IDETAPE_DIR_WRITE)
2533 idetape_write_release(drive, minor);
2534 if (tape->chrdev_dir == IDETAPE_DIR_READ) {
2536 ide_tape_discard_merge_buffer(drive, 1);
2539 if (minor < 128 && test_bit(IDETAPE_FLAG_MEDIUM_PRESENT, &tape->flags))
2540 (void) idetape_rewind_tape(drive);
2541 if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
2542 if (tape->door_locked == DOOR_LOCKED) {
2543 if (idetape_create_prevent_cmd(drive, &pc, 0)) {
2544 if (!idetape_queue_pc_tail(drive, &pc))
2545 tape->door_locked = DOOR_UNLOCKED;
2549 clear_bit(IDETAPE_FLAG_BUSY, &tape->flags);
2556 * check the contents of the ATAPI IDENTIFY command results. We return:
2558 * 1 - If the tape can be supported by us, based on the information we have so
2561 * 0 - If this tape driver is not currently supported by us.
2563 static int idetape_identify_device(ide_drive_t *drive)
2565 u8 gcw[2], protocol, device_type, removable, packet_size;
2567 if (drive->id_read == 0)
2570 *((unsigned short *) &gcw) = drive->id->config;
2572 protocol = (gcw[1] & 0xC0) >> 6;
2573 device_type = gcw[1] & 0x1F;
2574 removable = !!(gcw[0] & 0x80);
2575 packet_size = gcw[0] & 0x3;
2577 /* Check that we can support this device */
2579 printk(KERN_ERR "ide-tape: Protocol (0x%02x) is not ATAPI\n",
2581 else if (device_type != 1)
2582 printk(KERN_ERR "ide-tape: Device type (0x%02x) is not set "
2583 "to tape\n", device_type);
2584 else if (!removable)
2585 printk(KERN_ERR "ide-tape: The removable flag is not set\n");
2586 else if (packet_size != 0) {
2587 printk(KERN_ERR "ide-tape: Packet size (0x%02x) is not 12"
2588 " bytes\n", packet_size);
2594 static void idetape_get_inquiry_results(ide_drive_t *drive)
2596 idetape_tape_t *tape = drive->driver_data;
2597 struct ide_atapi_pc pc;
2598 char fw_rev[6], vendor_id[10], product_id[18];
2600 idetape_create_inquiry_cmd(&pc);
2601 if (idetape_queue_pc_tail(drive, &pc)) {
2602 printk(KERN_ERR "ide-tape: %s: can't get INQUIRY results\n",
2606 memcpy(vendor_id, &pc.buf[8], 8);
2607 memcpy(product_id, &pc.buf[16], 16);
2608 memcpy(fw_rev, &pc.buf[32], 4);
2610 ide_fixstring(vendor_id, 10, 0);
2611 ide_fixstring(product_id, 18, 0);
2612 ide_fixstring(fw_rev, 6, 0);
2614 printk(KERN_INFO "ide-tape: %s <-> %s: %s %s rev %s\n",
2615 drive->name, tape->name, vendor_id, product_id, fw_rev);
2619 * Ask the tape about its various parameters. In particular, we will adjust our
2620 * data transfer buffer size to the recommended value as returned by the tape.
2622 static void idetape_get_mode_sense_results(ide_drive_t *drive)
2624 idetape_tape_t *tape = drive->driver_data;
2625 struct ide_atapi_pc pc;
2627 u8 speed, max_speed;
2629 idetape_create_mode_sense_cmd(&pc, IDETAPE_CAPABILITIES_PAGE);
2630 if (idetape_queue_pc_tail(drive, &pc)) {
2631 printk(KERN_ERR "ide-tape: Can't get tape parameters - assuming"
2632 " some default values\n");
2633 tape->blk_size = 512;
2634 put_unaligned(52, (u16 *)&tape->caps[12]);
2635 put_unaligned(540, (u16 *)&tape->caps[14]);
2636 put_unaligned(6*52, (u16 *)&tape->caps[16]);
2639 caps = pc.buf + 4 + pc.buf[3];
2641 /* convert to host order and save for later use */
2642 speed = be16_to_cpu(*(u16 *)&caps[14]);
2643 max_speed = be16_to_cpu(*(u16 *)&caps[8]);
2645 put_unaligned(max_speed, (u16 *)&caps[8]);
2646 put_unaligned(be16_to_cpu(*(u16 *)&caps[12]), (u16 *)&caps[12]);
2647 put_unaligned(speed, (u16 *)&caps[14]);
2648 put_unaligned(be16_to_cpu(*(u16 *)&caps[16]), (u16 *)&caps[16]);
2651 printk(KERN_INFO "ide-tape: %s: invalid tape speed "
2652 "(assuming 650KB/sec)\n", drive->name);
2653 put_unaligned(650, (u16 *)&caps[14]);
2656 printk(KERN_INFO "ide-tape: %s: invalid max_speed "
2657 "(assuming 650KB/sec)\n", drive->name);
2658 put_unaligned(650, (u16 *)&caps[8]);
2661 memcpy(&tape->caps, caps, 20);
2663 tape->blk_size = 512;
2664 else if (caps[7] & 0x04)
2665 tape->blk_size = 1024;
2668 #ifdef CONFIG_IDE_PROC_FS
2669 static void idetape_add_settings(ide_drive_t *drive)
2671 idetape_tape_t *tape = drive->driver_data;
2673 ide_add_setting(drive, "buffer", SETTING_READ, TYPE_SHORT, 0, 0xffff,
2674 1, 2, (u16 *)&tape->caps[16], NULL);
2675 ide_add_setting(drive, "speed", SETTING_READ, TYPE_SHORT, 0, 0xffff,
2676 1, 1, (u16 *)&tape->caps[14], NULL);
2677 ide_add_setting(drive, "buffer_size", SETTING_READ, TYPE_INT, 0, 0xffff,
2678 1, 1024, &tape->buffer_size, NULL);
2679 ide_add_setting(drive, "tdsc", SETTING_RW, TYPE_INT, IDETAPE_DSC_RW_MIN,
2680 IDETAPE_DSC_RW_MAX, 1000, HZ, &tape->best_dsc_rw_freq,
2682 ide_add_setting(drive, "dsc_overlap", SETTING_RW, TYPE_BYTE, 0, 1, 1,
2683 1, &drive->dsc_overlap, NULL);
2684 ide_add_setting(drive, "avg_speed", SETTING_READ, TYPE_INT, 0, 0xffff,
2685 1, 1, &tape->avg_speed, NULL);
2686 ide_add_setting(drive, "debug_mask", SETTING_RW, TYPE_INT, 0, 0xffff, 1,
2687 1, &tape->debug_mask, NULL);
2690 static inline void idetape_add_settings(ide_drive_t *drive) { ; }
2694 * The function below is called to:
2696 * 1. Initialize our various state variables.
2697 * 2. Ask the tape for its capabilities.
2698 * 3. Allocate a buffer which will be used for data transfer. The buffer size
2699 * is chosen based on the recommendation which we received in step 2.
2701 * Note that at this point ide.c already assigned us an irq, so that we can
2702 * queue requests here and wait for their completion.
2704 static void idetape_setup(ide_drive_t *drive, idetape_tape_t *tape, int minor)
2710 u16 *ctl = (u16 *)&tape->caps[12];
2712 spin_lock_init(&tape->lock);
2713 drive->dsc_overlap = 1;
2714 if (drive->hwif->host_flags & IDE_HFLAG_NO_DSC) {
2715 printk(KERN_INFO "ide-tape: %s: disabling DSC overlap\n",
2717 drive->dsc_overlap = 0;
2719 /* Seagate Travan drives do not support DSC overlap. */
2720 if (strstr(drive->id->model, "Seagate STT3401"))
2721 drive->dsc_overlap = 0;
2722 tape->minor = minor;
2723 tape->name[0] = 'h';
2724 tape->name[1] = 't';
2725 tape->name[2] = '0' + minor;
2726 tape->chrdev_dir = IDETAPE_DIR_NONE;
2727 tape->pc = tape->pc_stack;
2728 *((unsigned short *) &gcw) = drive->id->config;
2730 /* Command packet DRQ type */
2731 if (((gcw[0] & 0x60) >> 5) == 1)
2732 set_bit(IDETAPE_FLAG_DRQ_INTERRUPT, &tape->flags);
2734 idetape_get_inquiry_results(drive);
2735 idetape_get_mode_sense_results(drive);
2736 ide_tape_get_bsize_from_bdesc(drive);
2737 tape->user_bs_factor = 1;
2738 tape->buffer_size = *ctl * tape->blk_size;
2739 while (tape->buffer_size > 0xffff) {
2740 printk(KERN_NOTICE "ide-tape: decreasing stage size\n");
2742 tape->buffer_size = *ctl * tape->blk_size;
2744 buffer_size = tape->buffer_size;
2745 tape->pages_per_buffer = buffer_size / PAGE_SIZE;
2746 if (buffer_size % PAGE_SIZE) {
2747 tape->pages_per_buffer++;
2748 tape->excess_bh_size = PAGE_SIZE - buffer_size % PAGE_SIZE;
2751 /* select the "best" DSC read/write polling freq */
2752 speed = max(*(u16 *)&tape->caps[14], *(u16 *)&tape->caps[8]);
2754 t = (IDETAPE_FIFO_THRESHOLD * tape->buffer_size * HZ) / (speed * 1000);
2757 * Ensure that the number we got makes sense; limit it within
2758 * IDETAPE_DSC_RW_MIN and IDETAPE_DSC_RW_MAX.
2760 tape->best_dsc_rw_freq = clamp_t(unsigned long, t, IDETAPE_DSC_RW_MIN,
2761 IDETAPE_DSC_RW_MAX);
2762 printk(KERN_INFO "ide-tape: %s <-> %s: %dKBps, %d*%dkB buffer, "
2764 drive->name, tape->name, *(u16 *)&tape->caps[14],
2765 (*(u16 *)&tape->caps[16] * 512) / tape->buffer_size,
2766 tape->buffer_size / 1024,
2767 tape->best_dsc_rw_freq * 1000 / HZ,
2768 drive->using_dma ? ", DMA":"");
2770 idetape_add_settings(drive);
2773 static void ide_tape_remove(ide_drive_t *drive)
2775 idetape_tape_t *tape = drive->driver_data;
2777 ide_proc_unregister_driver(drive, tape->driver);
2779 ide_unregister_region(tape->disk);
2784 static void ide_tape_release(struct kref *kref)
2786 struct ide_tape_obj *tape = to_ide_tape(kref);
2787 ide_drive_t *drive = tape->drive;
2788 struct gendisk *g = tape->disk;
2790 BUG_ON(tape->merge_bh_size);
2792 drive->dsc_overlap = 0;
2793 drive->driver_data = NULL;
2794 device_destroy(idetape_sysfs_class, MKDEV(IDETAPE_MAJOR, tape->minor));
2795 device_destroy(idetape_sysfs_class,
2796 MKDEV(IDETAPE_MAJOR, tape->minor + 128));
2797 idetape_devs[tape->minor] = NULL;
2798 g->private_data = NULL;
2803 #ifdef CONFIG_IDE_PROC_FS
2804 static int proc_idetape_read_name
2805 (char *page, char **start, off_t off, int count, int *eof, void *data)
2807 ide_drive_t *drive = (ide_drive_t *) data;
2808 idetape_tape_t *tape = drive->driver_data;
2812 len = sprintf(out, "%s\n", tape->name);
2813 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
2816 static ide_proc_entry_t idetape_proc[] = {
2817 { "capacity", S_IFREG|S_IRUGO, proc_ide_read_capacity, NULL },
2818 { "name", S_IFREG|S_IRUGO, proc_idetape_read_name, NULL },
2819 { NULL, 0, NULL, NULL }
2823 static int ide_tape_probe(ide_drive_t *);
2825 static ide_driver_t idetape_driver = {
2827 .owner = THIS_MODULE,
2829 .bus = &ide_bus_type,
2831 .probe = ide_tape_probe,
2832 .remove = ide_tape_remove,
2833 .version = IDETAPE_VERSION,
2835 .supports_dsc_overlap = 1,
2836 .do_request = idetape_do_request,
2837 .end_request = idetape_end_request,
2838 .error = __ide_error,
2839 .abort = __ide_abort,
2840 #ifdef CONFIG_IDE_PROC_FS
2841 .proc = idetape_proc,
2845 /* Our character device supporting functions, passed to register_chrdev. */
2846 static const struct file_operations idetape_fops = {
2847 .owner = THIS_MODULE,
2848 .read = idetape_chrdev_read,
2849 .write = idetape_chrdev_write,
2850 .ioctl = idetape_chrdev_ioctl,
2851 .open = idetape_chrdev_open,
2852 .release = idetape_chrdev_release,
2855 static int idetape_open(struct inode *inode, struct file *filp)
2857 struct gendisk *disk = inode->i_bdev->bd_disk;
2858 struct ide_tape_obj *tape;
2860 tape = ide_tape_get(disk);
2867 static int idetape_release(struct inode *inode, struct file *filp)
2869 struct gendisk *disk = inode->i_bdev->bd_disk;
2870 struct ide_tape_obj *tape = ide_tape_g(disk);
2877 static int idetape_ioctl(struct inode *inode, struct file *file,
2878 unsigned int cmd, unsigned long arg)
2880 struct block_device *bdev = inode->i_bdev;
2881 struct ide_tape_obj *tape = ide_tape_g(bdev->bd_disk);
2882 ide_drive_t *drive = tape->drive;
2883 int err = generic_ide_ioctl(drive, file, bdev, cmd, arg);
2885 err = idetape_blkdev_ioctl(drive, cmd, arg);
2889 static struct block_device_operations idetape_block_ops = {
2890 .owner = THIS_MODULE,
2891 .open = idetape_open,
2892 .release = idetape_release,
2893 .ioctl = idetape_ioctl,
2896 static int ide_tape_probe(ide_drive_t *drive)
2898 idetape_tape_t *tape;
2902 if (!strstr("ide-tape", drive->driver_req))
2904 if (!drive->present)
2906 if (drive->media != ide_tape)
2908 if (!idetape_identify_device(drive)) {
2909 printk(KERN_ERR "ide-tape: %s: not supported by this version of"
2910 " the driver\n", drive->name);
2914 printk(KERN_INFO "ide-tape: passing drive %s to ide-scsi"
2915 " emulation.\n", drive->name);
2918 tape = kzalloc(sizeof(idetape_tape_t), GFP_KERNEL);
2920 printk(KERN_ERR "ide-tape: %s: Can't allocate a tape struct\n",
2925 g = alloc_disk(1 << PARTN_BITS);
2929 ide_init_disk(g, drive);
2931 ide_proc_register_driver(drive, &idetape_driver);
2933 kref_init(&tape->kref);
2935 tape->drive = drive;
2936 tape->driver = &idetape_driver;
2939 g->private_data = &tape->driver;
2941 drive->driver_data = tape;
2943 mutex_lock(&idetape_ref_mutex);
2944 for (minor = 0; idetape_devs[minor]; minor++)
2946 idetape_devs[minor] = tape;
2947 mutex_unlock(&idetape_ref_mutex);
2949 idetape_setup(drive, tape, minor);
2951 device_create(idetape_sysfs_class, &drive->gendev,
2952 MKDEV(IDETAPE_MAJOR, minor), "%s", tape->name);
2953 device_create(idetape_sysfs_class, &drive->gendev,
2954 MKDEV(IDETAPE_MAJOR, minor + 128), "n%s", tape->name);
2956 g->fops = &idetape_block_ops;
2957 ide_register_region(g);
2967 static void __exit idetape_exit(void)
2969 driver_unregister(&idetape_driver.gen_driver);
2970 class_destroy(idetape_sysfs_class);
2971 unregister_chrdev(IDETAPE_MAJOR, "ht");
2974 static int __init idetape_init(void)
2977 idetape_sysfs_class = class_create(THIS_MODULE, "ide_tape");
2978 if (IS_ERR(idetape_sysfs_class)) {
2979 idetape_sysfs_class = NULL;
2980 printk(KERN_ERR "Unable to create sysfs class for ide tapes\n");
2985 if (register_chrdev(IDETAPE_MAJOR, "ht", &idetape_fops)) {
2986 printk(KERN_ERR "ide-tape: Failed to register chrdev"
2989 goto out_free_class;
2992 error = driver_register(&idetape_driver.gen_driver);
2994 goto out_free_driver;
2999 driver_unregister(&idetape_driver.gen_driver);
3001 class_destroy(idetape_sysfs_class);
3006 MODULE_ALIAS("ide:*m-tape*");
3007 module_init(idetape_init);
3008 module_exit(idetape_exit);
3009 MODULE_ALIAS_CHARDEV_MAJOR(IDETAPE_MAJOR);
3010 MODULE_DESCRIPTION("ATAPI Streaming TAPE Driver");
3011 MODULE_LICENSE("GPL");