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),
218 /* A pipeline stage. */
219 typedef struct idetape_stage_s {
220 struct request rq; /* The corresponding request */
221 struct idetape_bh *bh; /* The data buffers */
222 struct idetape_stage_s *next; /* Pointer to the next stage */
226 * Most of our global data which we need to save even as we leave the driver due
227 * to an interrupt or a timer event is stored in the struct defined below.
229 typedef struct ide_tape_obj {
231 ide_driver_t *driver;
232 struct gendisk *disk;
236 * Since a typical character device operation requires more
237 * than one packet command, we provide here enough memory
238 * for the maximum of interconnected packet commands.
239 * The packet commands are stored in the circular array pc_stack.
240 * pc_stack_index points to the last used entry, and warps around
241 * to the start when we get to the last array entry.
243 * pc points to the current processed packet command.
245 * failed_pc points to the last failed packet command, or contains
246 * NULL if we do not need to retry any packet command. This is
247 * required since an additional packet command is needed before the
248 * retry, to get detailed information on what went wrong.
250 /* Current packet command */
251 struct ide_atapi_pc *pc;
252 /* Last failed packet command */
253 struct ide_atapi_pc *failed_pc;
254 /* Packet command stack */
255 struct ide_atapi_pc pc_stack[IDETAPE_PC_STACK];
256 /* Next free packet command storage space */
258 struct request rq_stack[IDETAPE_PC_STACK];
259 /* We implement a circular array */
263 * DSC polling variables.
265 * While polling for DSC we use postponed_rq to postpone the current
266 * request so that ide.c will be able to service pending requests on the
267 * other device. Note that at most we will have only one DSC (usually
268 * data transfer) request in the device request queue.
270 struct request *postponed_rq;
271 /* The time in which we started polling for DSC */
272 unsigned long dsc_polling_start;
273 /* Timer used to poll for dsc */
274 struct timer_list dsc_timer;
275 /* Read/Write dsc polling frequency */
276 unsigned long best_dsc_rw_freq;
277 unsigned long dsc_poll_freq;
278 unsigned long dsc_timeout;
280 /* Read position information */
283 unsigned int first_frame;
285 /* Last error information */
286 u8 sense_key, asc, ascq;
288 /* Character device operation */
292 /* Current character device data transfer direction */
295 /* tape block size, usually 512 or 1024 bytes */
296 unsigned short blk_size;
299 /* Copy of the tape's Capabilities and Mechanical Page */
303 * Active data transfer request parameters.
305 * At most, there is only one ide-tape originated data transfer request
306 * in the device request queue. This allows ide.c to easily service
307 * requests from the other device when we postpone our active request.
310 /* Data buffer size chosen based on the tape's recommendation */
312 idetape_stage_t *merge_stage;
313 int merge_stage_size;
314 struct idetape_bh *bh;
318 int pages_per_buffer;
319 /* Wasted space in each stage */
322 /* Status/Action flags: long for set_bit */
324 /* protects the ide-tape queue */
327 /* Measures average tape speed */
328 unsigned long avg_time;
332 /* the door is currently locked */
334 /* the tape hardware is write protected */
336 /* the tape is write protected (hardware or opened as read-only) */
342 static DEFINE_MUTEX(idetape_ref_mutex);
344 static struct class *idetape_sysfs_class;
346 #define to_ide_tape(obj) container_of(obj, struct ide_tape_obj, kref)
348 #define ide_tape_g(disk) \
349 container_of((disk)->private_data, struct ide_tape_obj, driver)
351 static struct ide_tape_obj *ide_tape_get(struct gendisk *disk)
353 struct ide_tape_obj *tape = NULL;
355 mutex_lock(&idetape_ref_mutex);
356 tape = ide_tape_g(disk);
358 kref_get(&tape->kref);
359 mutex_unlock(&idetape_ref_mutex);
363 static void ide_tape_release(struct kref *);
365 static void ide_tape_put(struct ide_tape_obj *tape)
367 mutex_lock(&idetape_ref_mutex);
368 kref_put(&tape->kref, ide_tape_release);
369 mutex_unlock(&idetape_ref_mutex);
373 * The variables below are used for the character device interface. Additional
374 * state variables are defined in our ide_drive_t structure.
376 static struct ide_tape_obj *idetape_devs[MAX_HWIFS * MAX_DRIVES];
378 #define ide_tape_f(file) ((file)->private_data)
380 static struct ide_tape_obj *ide_tape_chrdev_get(unsigned int i)
382 struct ide_tape_obj *tape = NULL;
384 mutex_lock(&idetape_ref_mutex);
385 tape = idetape_devs[i];
387 kref_get(&tape->kref);
388 mutex_unlock(&idetape_ref_mutex);
392 static void idetape_input_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
395 struct idetape_bh *bh = pc->bh;
400 printk(KERN_ERR "ide-tape: bh == NULL in "
401 "idetape_input_buffers\n");
402 ide_atapi_discard_data(drive, bcount);
406 (unsigned int)(bh->b_size - atomic_read(&bh->b_count)),
408 HWIF(drive)->atapi_input_bytes(drive, bh->b_data +
409 atomic_read(&bh->b_count), count);
411 atomic_add(count, &bh->b_count);
412 if (atomic_read(&bh->b_count) == bh->b_size) {
415 atomic_set(&bh->b_count, 0);
421 static void idetape_output_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
424 struct idetape_bh *bh = pc->bh;
429 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
433 count = min((unsigned int)pc->b_count, (unsigned int)bcount);
434 HWIF(drive)->atapi_output_bytes(drive, pc->b_data, count);
437 pc->b_count -= count;
442 pc->b_data = bh->b_data;
443 pc->b_count = atomic_read(&bh->b_count);
449 static void idetape_update_buffers(struct ide_atapi_pc *pc)
451 struct idetape_bh *bh = pc->bh;
453 unsigned int bcount = pc->xferred;
455 if (pc->flags & PC_FLAG_WRITING)
459 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
463 count = min((unsigned int)bh->b_size, (unsigned int)bcount);
464 atomic_set(&bh->b_count, count);
465 if (atomic_read(&bh->b_count) == bh->b_size)
473 * idetape_next_pc_storage returns a pointer to a place in which we can
474 * safely store a packet command, even though we intend to leave the
475 * driver. A storage space for a maximum of IDETAPE_PC_STACK packet
476 * commands is allocated at initialization time.
478 static struct ide_atapi_pc *idetape_next_pc_storage(ide_drive_t *drive)
480 idetape_tape_t *tape = drive->driver_data;
482 debug_log(DBG_PCRQ_STACK, "pc_stack_index=%d\n", tape->pc_stack_index);
484 if (tape->pc_stack_index == IDETAPE_PC_STACK)
485 tape->pc_stack_index = 0;
486 return (&tape->pc_stack[tape->pc_stack_index++]);
490 * idetape_next_rq_storage is used along with idetape_next_pc_storage.
491 * Since we queue packet commands in the request queue, we need to
492 * allocate a request, along with the allocation of a packet command.
495 /**************************************************************
497 * This should get fixed to use kmalloc(.., GFP_ATOMIC) *
498 * followed later on by kfree(). -ml *
500 **************************************************************/
502 static struct request *idetape_next_rq_storage(ide_drive_t *drive)
504 idetape_tape_t *tape = drive->driver_data;
506 debug_log(DBG_PCRQ_STACK, "rq_stack_index=%d\n", tape->rq_stack_index);
508 if (tape->rq_stack_index == IDETAPE_PC_STACK)
509 tape->rq_stack_index = 0;
510 return (&tape->rq_stack[tape->rq_stack_index++]);
513 static void idetape_init_pc(struct ide_atapi_pc *pc)
515 memset(pc->c, 0, 12);
519 pc->buf = pc->pc_buf;
520 pc->buf_size = IDETAPE_PC_BUFFER_SIZE;
526 * called on each failed packet command retry to analyze the request sense. We
527 * currently do not utilize this information.
529 static void idetape_analyze_error(ide_drive_t *drive, u8 *sense)
531 idetape_tape_t *tape = drive->driver_data;
532 struct ide_atapi_pc *pc = tape->failed_pc;
534 tape->sense_key = sense[2] & 0xF;
535 tape->asc = sense[12];
536 tape->ascq = sense[13];
538 debug_log(DBG_ERR, "pc = %x, sense key = %x, asc = %x, ascq = %x\n",
539 pc->c[0], tape->sense_key, tape->asc, tape->ascq);
541 /* Correct pc->xferred by asking the tape. */
542 if (pc->flags & PC_FLAG_DMA_ERROR) {
543 pc->xferred = pc->req_xfer -
545 be32_to_cpu(get_unaligned((u32 *)&sense[3]));
546 idetape_update_buffers(pc);
550 * If error was the result of a zero-length read or write command,
551 * with sense key=5, asc=0x22, ascq=0, let it slide. Some drives
552 * (i.e. Seagate STT3401A Travan) don't support 0-length read/writes.
554 if ((pc->c[0] == READ_6 || pc->c[0] == WRITE_6)
556 && pc->c[4] == 0 && pc->c[3] == 0 && pc->c[2] == 0) {
557 if (tape->sense_key == 5) {
558 /* don't report an error, everything's ok */
560 /* don't retry read/write */
561 pc->flags |= PC_FLAG_ABORT;
564 if (pc->c[0] == READ_6 && (sense[2] & 0x80)) {
565 pc->error = IDETAPE_ERROR_FILEMARK;
566 pc->flags |= PC_FLAG_ABORT;
568 if (pc->c[0] == WRITE_6) {
569 if ((sense[2] & 0x40) || (tape->sense_key == 0xd
570 && tape->asc == 0x0 && tape->ascq == 0x2)) {
571 pc->error = IDETAPE_ERROR_EOD;
572 pc->flags |= PC_FLAG_ABORT;
575 if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
576 if (tape->sense_key == 8) {
577 pc->error = IDETAPE_ERROR_EOD;
578 pc->flags |= PC_FLAG_ABORT;
580 if (!(pc->flags & PC_FLAG_ABORT) &&
582 pc->retries = IDETAPE_MAX_PC_RETRIES + 1;
586 /* Free data buffers completely. */
587 static void ide_tape_kfree_buffer(idetape_stage_t *stage)
589 struct idetape_bh *prev_bh, *bh = stage->bh;
592 u32 size = bh->b_size;
595 unsigned int order = fls(size >> PAGE_SHIFT)-1;
598 free_pages((unsigned long)bh->b_data, order);
601 bh->b_data += (1 << order) * PAGE_SIZE;
610 static int idetape_end_request(ide_drive_t *drive, int uptodate, int nr_sects)
612 struct request *rq = HWGROUP(drive)->rq;
613 idetape_tape_t *tape = drive->driver_data;
617 debug_log(DBG_PROCS, "Enter %s\n", __func__);
620 case 0: error = IDETAPE_ERROR_GENERAL; break;
621 case 1: error = 0; break;
622 default: error = uptodate;
626 tape->failed_pc = NULL;
628 if (!blk_special_request(rq)) {
629 ide_end_request(drive, uptodate, nr_sects);
633 spin_lock_irqsave(&tape->lock, flags);
635 ide_end_drive_cmd(drive, 0, 0);
637 spin_unlock_irqrestore(&tape->lock, flags);
641 static ide_startstop_t idetape_request_sense_callback(ide_drive_t *drive)
643 idetape_tape_t *tape = drive->driver_data;
645 debug_log(DBG_PROCS, "Enter %s\n", __func__);
647 if (!tape->pc->error) {
648 idetape_analyze_error(drive, tape->pc->buf);
649 idetape_end_request(drive, 1, 0);
651 printk(KERN_ERR "ide-tape: Error in REQUEST SENSE itself - "
652 "Aborting request!\n");
653 idetape_end_request(drive, 0, 0);
658 static void idetape_create_request_sense_cmd(struct ide_atapi_pc *pc)
661 pc->c[0] = REQUEST_SENSE;
664 pc->idetape_callback = &idetape_request_sense_callback;
667 static void idetape_init_rq(struct request *rq, u8 cmd)
669 memset(rq, 0, sizeof(*rq));
670 rq->cmd_type = REQ_TYPE_SPECIAL;
675 * Generate a new packet command request in front of the request queue, before
676 * the current request, so that it will be processed immediately, on the next
677 * pass through the driver. The function below is called from the request
678 * handling part of the driver (the "bottom" part). Safe storage for the request
679 * should be allocated with ide_tape_next_{pc,rq}_storage() prior to that.
681 * Memory for those requests is pre-allocated at initialization time, and is
682 * limited to IDETAPE_PC_STACK requests. We assume that we have enough space for
683 * the maximum possible number of inter-dependent packet commands.
685 * The higher level of the driver - The ioctl handler and the character device
686 * handling functions should queue request to the lower level part and wait for
687 * their completion using idetape_queue_pc_tail or idetape_queue_rw_tail.
689 static void idetape_queue_pc_head(ide_drive_t *drive, struct ide_atapi_pc *pc,
692 struct ide_tape_obj *tape = drive->driver_data;
694 idetape_init_rq(rq, REQ_IDETAPE_PC1);
695 rq->buffer = (char *) pc;
696 rq->rq_disk = tape->disk;
697 (void) ide_do_drive_cmd(drive, rq, ide_preempt);
701 * idetape_retry_pc is called when an error was detected during the
702 * last packet command. We queue a request sense packet command in
703 * the head of the request list.
705 static ide_startstop_t idetape_retry_pc (ide_drive_t *drive)
707 idetape_tape_t *tape = drive->driver_data;
708 struct ide_atapi_pc *pc;
711 (void)ide_read_error(drive);
712 pc = idetape_next_pc_storage(drive);
713 rq = idetape_next_rq_storage(drive);
714 idetape_create_request_sense_cmd(pc);
715 set_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags);
716 idetape_queue_pc_head(drive, pc, rq);
721 * Postpone the current request so that ide.c will be able to service requests
722 * from another device on the same hwgroup while we are polling for DSC.
724 static void idetape_postpone_request(ide_drive_t *drive)
726 idetape_tape_t *tape = drive->driver_data;
728 debug_log(DBG_PROCS, "Enter %s\n", __func__);
730 tape->postponed_rq = HWGROUP(drive)->rq;
731 ide_stall_queue(drive, tape->dsc_poll_freq);
734 typedef void idetape_io_buf(ide_drive_t *, struct ide_atapi_pc *, unsigned int);
737 * This is the usual interrupt handler which will be called during a packet
738 * command. We will transfer some of the data (as requested by the drive) and
739 * will re-point interrupt handler to us. When data transfer is finished, we
740 * will act according to the algorithm described before
743 static ide_startstop_t idetape_pc_intr(ide_drive_t *drive)
745 ide_hwif_t *hwif = drive->hwif;
746 idetape_tape_t *tape = drive->driver_data;
747 struct ide_atapi_pc *pc = tape->pc;
748 xfer_func_t *xferfunc;
749 idetape_io_buf *iobuf;
752 static int error_sim_count;
757 debug_log(DBG_PROCS, "Enter %s - interrupt handler\n", __func__);
759 /* Clear the interrupt */
760 stat = ide_read_status(drive);
762 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
763 if (hwif->dma_ops->dma_end(drive) || (stat & ERR_STAT)) {
765 * A DMA error is sometimes expected. For example,
766 * if the tape is crossing a filemark during a
767 * READ command, it will issue an irq and position
768 * itself before the filemark, so that only a partial
769 * data transfer will occur (which causes the DMA
770 * error). In that case, we will later ask the tape
771 * how much bytes of the original request were
772 * actually transferred (we can't receive that
773 * information from the DMA engine on most chipsets).
777 * On the contrary, a DMA error is never expected;
778 * it usually indicates a hardware error or abort.
779 * If the tape crosses a filemark during a READ
780 * command, it will issue an irq and position itself
781 * after the filemark (not before). Only a partial
782 * data transfer will occur, but no DMA error.
785 pc->flags |= PC_FLAG_DMA_ERROR;
787 pc->xferred = pc->req_xfer;
788 idetape_update_buffers(pc);
790 debug_log(DBG_PROCS, "DMA finished\n");
794 /* No more interrupts */
795 if ((stat & DRQ_STAT) == 0) {
796 debug_log(DBG_SENSE, "Packet command completed, %d bytes"
797 " transferred\n", pc->xferred);
799 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
803 if ((pc->c[0] == WRITE_6 || pc->c[0] == READ_6) &&
804 (++error_sim_count % 100) == 0) {
805 printk(KERN_INFO "ide-tape: %s: simulating error\n",
810 if ((stat & ERR_STAT) && pc->c[0] == REQUEST_SENSE)
812 if ((stat & ERR_STAT) || (pc->flags & PC_FLAG_DMA_ERROR)) {
814 debug_log(DBG_ERR, "%s: I/O error\n", tape->name);
816 if (pc->c[0] == REQUEST_SENSE) {
817 printk(KERN_ERR "ide-tape: I/O error in request"
819 return ide_do_reset(drive);
821 debug_log(DBG_ERR, "[cmd %x]: check condition\n",
824 /* Retry operation */
825 return idetape_retry_pc(drive);
828 if ((pc->flags & PC_FLAG_WAIT_FOR_DSC) &&
829 (stat & SEEK_STAT) == 0) {
830 /* Media access command */
831 tape->dsc_polling_start = jiffies;
832 tape->dsc_poll_freq = IDETAPE_DSC_MA_FAST;
833 tape->dsc_timeout = jiffies + IDETAPE_DSC_MA_TIMEOUT;
834 /* Allow ide.c to handle other requests */
835 idetape_postpone_request(drive);
838 if (tape->failed_pc == pc)
839 tape->failed_pc = NULL;
840 /* Command finished - Call the callback function */
841 return pc->idetape_callback(drive);
844 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
845 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
846 printk(KERN_ERR "ide-tape: The tape wants to issue more "
847 "interrupts in DMA mode\n");
848 printk(KERN_ERR "ide-tape: DMA disabled, reverting to PIO\n");
850 return ide_do_reset(drive);
852 /* Get the number of bytes to transfer on this interrupt. */
853 bcount = (hwif->INB(hwif->io_ports.lbah_addr) << 8) |
854 hwif->INB(hwif->io_ports.lbam_addr);
856 ireason = hwif->INB(hwif->io_ports.nsect_addr);
859 printk(KERN_ERR "ide-tape: CoD != 0 in %s\n", __func__);
860 return ide_do_reset(drive);
862 if (((ireason & IO) == IO) == !!(pc->flags & PC_FLAG_WRITING)) {
863 /* Hopefully, we will never get here */
864 printk(KERN_ERR "ide-tape: We wanted to %s, ",
865 (ireason & IO) ? "Write" : "Read");
866 printk(KERN_ERR "ide-tape: but the tape wants us to %s !\n",
867 (ireason & IO) ? "Read" : "Write");
868 return ide_do_reset(drive);
870 if (!(pc->flags & PC_FLAG_WRITING)) {
871 /* Reading - Check that we have enough space */
872 temp = pc->xferred + bcount;
873 if (temp > pc->req_xfer) {
874 if (temp > pc->buf_size) {
875 printk(KERN_ERR "ide-tape: The tape wants to "
876 "send us more data than expected "
877 "- discarding data\n");
878 ide_atapi_discard_data(drive, bcount);
879 ide_set_handler(drive, &idetape_pc_intr,
880 IDETAPE_WAIT_CMD, NULL);
883 debug_log(DBG_SENSE, "The tape wants to send us more "
884 "data than expected - allowing transfer\n");
886 iobuf = &idetape_input_buffers;
887 xferfunc = hwif->atapi_input_bytes;
889 iobuf = &idetape_output_buffers;
890 xferfunc = hwif->atapi_output_bytes;
894 iobuf(drive, pc, bcount);
896 xferfunc(drive, pc->cur_pos, bcount);
898 /* Update the current position */
899 pc->xferred += bcount;
900 pc->cur_pos += bcount;
902 debug_log(DBG_SENSE, "[cmd %x] transferred %d bytes on that intr.\n",
905 /* And set the interrupt handler again */
906 ide_set_handler(drive, &idetape_pc_intr, IDETAPE_WAIT_CMD, NULL);
911 * Packet Command Interface
913 * The current Packet Command is available in tape->pc, and will not change
914 * until we finish handling it. Each packet command is associated with a
915 * callback function that will be called when the command is finished.
917 * The handling will be done in three stages:
919 * 1. idetape_issue_pc will send the packet command to the drive, and will set
920 * the interrupt handler to idetape_pc_intr.
922 * 2. On each interrupt, idetape_pc_intr will be called. This step will be
923 * repeated until the device signals us that no more interrupts will be issued.
925 * 3. ATAPI Tape media access commands have immediate status with a delayed
926 * process. In case of a successful initiation of a media access packet command,
927 * the DSC bit will be set when the actual execution of the command is finished.
928 * Since the tape drive will not issue an interrupt, we have to poll for this
929 * event. In this case, we define the request as "low priority request" by
930 * setting rq_status to IDETAPE_RQ_POSTPONED, set a timer to poll for DSC and
933 * ide.c will then give higher priority to requests which originate from the
934 * other device, until will change rq_status to RQ_ACTIVE.
936 * 4. When the packet command is finished, it will be checked for errors.
938 * 5. In case an error was found, we queue a request sense packet command in
939 * front of the request queue and retry the operation up to
940 * IDETAPE_MAX_PC_RETRIES times.
942 * 6. In case no error was found, or we decided to give up and not to retry
943 * again, the callback function will be called and then we will handle the next
946 static ide_startstop_t idetape_transfer_pc(ide_drive_t *drive)
948 ide_hwif_t *hwif = drive->hwif;
949 idetape_tape_t *tape = drive->driver_data;
950 struct ide_atapi_pc *pc = tape->pc;
952 ide_startstop_t startstop;
955 if (ide_wait_stat(&startstop, drive, DRQ_STAT, BUSY_STAT, WAIT_READY)) {
956 printk(KERN_ERR "ide-tape: Strange, packet command initiated "
957 "yet DRQ isn't asserted\n");
960 ireason = hwif->INB(hwif->io_ports.nsect_addr);
961 while (retries-- && ((ireason & CD) == 0 || (ireason & IO))) {
962 printk(KERN_ERR "ide-tape: (IO,CoD != (0,1) while issuing "
963 "a packet command, retrying\n");
965 ireason = hwif->INB(hwif->io_ports.nsect_addr);
967 printk(KERN_ERR "ide-tape: (IO,CoD != (0,1) while "
968 "issuing a packet command, ignoring\n");
973 if ((ireason & CD) == 0 || (ireason & IO)) {
974 printk(KERN_ERR "ide-tape: (IO,CoD) != (0,1) while issuing "
975 "a packet command\n");
976 return ide_do_reset(drive);
978 /* Set the interrupt routine */
979 ide_set_handler(drive, &idetape_pc_intr, IDETAPE_WAIT_CMD, NULL);
980 #ifdef CONFIG_BLK_DEV_IDEDMA
981 /* Begin DMA, if necessary */
982 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS)
983 hwif->dma_ops->dma_start(drive);
985 /* Send the actual packet */
986 HWIF(drive)->atapi_output_bytes(drive, pc->c, 12);
990 static ide_startstop_t idetape_issue_pc(ide_drive_t *drive,
991 struct ide_atapi_pc *pc)
993 ide_hwif_t *hwif = drive->hwif;
994 idetape_tape_t *tape = drive->driver_data;
998 if (tape->pc->c[0] == REQUEST_SENSE &&
999 pc->c[0] == REQUEST_SENSE) {
1000 printk(KERN_ERR "ide-tape: possible ide-tape.c bug - "
1001 "Two request sense in serial were issued\n");
1004 if (tape->failed_pc == NULL && pc->c[0] != REQUEST_SENSE)
1005 tape->failed_pc = pc;
1006 /* Set the current packet command */
1009 if (pc->retries > IDETAPE_MAX_PC_RETRIES ||
1010 (pc->flags & PC_FLAG_ABORT)) {
1012 * We will "abort" retrying a packet command in case legitimate
1013 * error code was received (crossing a filemark, or end of the
1014 * media, for example).
1016 if (!(pc->flags & PC_FLAG_ABORT)) {
1017 if (!(pc->c[0] == TEST_UNIT_READY &&
1018 tape->sense_key == 2 && tape->asc == 4 &&
1019 (tape->ascq == 1 || tape->ascq == 8))) {
1020 printk(KERN_ERR "ide-tape: %s: I/O error, "
1021 "pc = %2x, key = %2x, "
1022 "asc = %2x, ascq = %2x\n",
1023 tape->name, pc->c[0],
1024 tape->sense_key, tape->asc,
1028 pc->error = IDETAPE_ERROR_GENERAL;
1030 tape->failed_pc = NULL;
1031 return pc->idetape_callback(drive);
1033 debug_log(DBG_SENSE, "Retry #%d, cmd = %02X\n", pc->retries, pc->c[0]);
1036 /* We haven't transferred any data yet */
1038 pc->cur_pos = pc->buf;
1039 /* Request to transfer the entire buffer at once */
1040 bcount = pc->req_xfer;
1042 if (pc->flags & PC_FLAG_DMA_ERROR) {
1043 pc->flags &= ~PC_FLAG_DMA_ERROR;
1044 printk(KERN_WARNING "ide-tape: DMA disabled, "
1045 "reverting to PIO\n");
1048 if ((pc->flags & PC_FLAG_DMA_RECOMMENDED) && drive->using_dma)
1049 dma_ok = !hwif->dma_ops->dma_setup(drive);
1051 ide_pktcmd_tf_load(drive, IDE_TFLAG_NO_SELECT_MASK |
1052 IDE_TFLAG_OUT_DEVICE, bcount, dma_ok);
1055 /* Will begin DMA later */
1056 pc->flags |= PC_FLAG_DMA_IN_PROGRESS;
1057 if (test_bit(IDETAPE_FLAG_DRQ_INTERRUPT, &tape->flags)) {
1058 ide_execute_command(drive, WIN_PACKETCMD, &idetape_transfer_pc,
1059 IDETAPE_WAIT_CMD, NULL);
1062 hwif->OUTB(WIN_PACKETCMD, hwif->io_ports.command_addr);
1063 return idetape_transfer_pc(drive);
1067 static ide_startstop_t idetape_pc_callback(ide_drive_t *drive)
1069 idetape_tape_t *tape = drive->driver_data;
1071 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1073 idetape_end_request(drive, tape->pc->error ? 0 : 1, 0);
1077 /* A mode sense command is used to "sense" tape parameters. */
1078 static void idetape_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
1080 idetape_init_pc(pc);
1081 pc->c[0] = MODE_SENSE;
1082 if (page_code != IDETAPE_BLOCK_DESCRIPTOR)
1083 /* DBD = 1 - Don't return block descriptors */
1085 pc->c[2] = page_code;
1087 * Changed pc->c[3] to 0 (255 will at best return unused info).
1089 * For SCSI this byte is defined as subpage instead of high byte
1090 * of length and some IDE drives seem to interpret it this way
1091 * and return an error when 255 is used.
1094 /* We will just discard data in that case */
1096 if (page_code == IDETAPE_BLOCK_DESCRIPTOR)
1098 else if (page_code == IDETAPE_CAPABILITIES_PAGE)
1102 pc->idetape_callback = &idetape_pc_callback;
1105 static ide_startstop_t idetape_media_access_finished(ide_drive_t *drive)
1107 idetape_tape_t *tape = drive->driver_data;
1108 struct ide_atapi_pc *pc = tape->pc;
1111 stat = ide_read_status(drive);
1113 if (stat & SEEK_STAT) {
1114 if (stat & ERR_STAT) {
1115 /* Error detected */
1116 if (pc->c[0] != TEST_UNIT_READY)
1117 printk(KERN_ERR "ide-tape: %s: I/O error, ",
1119 /* Retry operation */
1120 return idetape_retry_pc(drive);
1123 if (tape->failed_pc == pc)
1124 tape->failed_pc = NULL;
1126 pc->error = IDETAPE_ERROR_GENERAL;
1127 tape->failed_pc = NULL;
1129 return pc->idetape_callback(drive);
1132 static ide_startstop_t idetape_rw_callback(ide_drive_t *drive)
1134 idetape_tape_t *tape = drive->driver_data;
1135 struct request *rq = HWGROUP(drive)->rq;
1136 int blocks = tape->pc->xferred / tape->blk_size;
1138 tape->avg_size += blocks * tape->blk_size;
1140 if (time_after_eq(jiffies, tape->avg_time + HZ)) {
1141 tape->avg_speed = tape->avg_size * HZ /
1142 (jiffies - tape->avg_time) / 1024;
1144 tape->avg_time = jiffies;
1146 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1148 tape->first_frame += blocks;
1149 rq->current_nr_sectors -= blocks;
1151 if (!tape->pc->error)
1152 idetape_end_request(drive, 1, 0);
1154 idetape_end_request(drive, tape->pc->error, 0);
1158 static void idetape_create_read_cmd(idetape_tape_t *tape,
1159 struct ide_atapi_pc *pc,
1160 unsigned int length, struct idetape_bh *bh)
1162 idetape_init_pc(pc);
1164 put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
1166 pc->idetape_callback = &idetape_rw_callback;
1168 atomic_set(&bh->b_count, 0);
1170 pc->buf_size = length * tape->blk_size;
1171 pc->req_xfer = pc->buf_size;
1172 if (pc->req_xfer == tape->buffer_size)
1173 pc->flags |= PC_FLAG_DMA_RECOMMENDED;
1176 static void idetape_create_write_cmd(idetape_tape_t *tape,
1177 struct ide_atapi_pc *pc,
1178 unsigned int length, struct idetape_bh *bh)
1180 idetape_init_pc(pc);
1182 put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
1184 pc->idetape_callback = &idetape_rw_callback;
1185 pc->flags |= PC_FLAG_WRITING;
1187 pc->b_data = bh->b_data;
1188 pc->b_count = atomic_read(&bh->b_count);
1190 pc->buf_size = length * tape->blk_size;
1191 pc->req_xfer = pc->buf_size;
1192 if (pc->req_xfer == tape->buffer_size)
1193 pc->flags |= PC_FLAG_DMA_RECOMMENDED;
1196 static ide_startstop_t idetape_do_request(ide_drive_t *drive,
1197 struct request *rq, sector_t block)
1199 idetape_tape_t *tape = drive->driver_data;
1200 struct ide_atapi_pc *pc = NULL;
1201 struct request *postponed_rq = tape->postponed_rq;
1204 debug_log(DBG_SENSE, "sector: %ld, nr_sectors: %ld,"
1205 " current_nr_sectors: %d\n",
1206 rq->sector, rq->nr_sectors, rq->current_nr_sectors);
1208 if (!blk_special_request(rq)) {
1209 /* We do not support buffer cache originated requests. */
1210 printk(KERN_NOTICE "ide-tape: %s: Unsupported request in "
1211 "request queue (%d)\n", drive->name, rq->cmd_type);
1212 ide_end_request(drive, 0, 0);
1216 /* Retry a failed packet command */
1217 if (tape->failed_pc && tape->pc->c[0] == REQUEST_SENSE)
1218 return idetape_issue_pc(drive, tape->failed_pc);
1220 if (postponed_rq != NULL)
1221 if (rq != postponed_rq) {
1222 printk(KERN_ERR "ide-tape: ide-tape.c bug - "
1223 "Two DSC requests were queued\n");
1224 idetape_end_request(drive, 0, 0);
1228 tape->postponed_rq = NULL;
1231 * If the tape is still busy, postpone our request and service
1232 * the other device meanwhile.
1234 stat = ide_read_status(drive);
1236 if (!drive->dsc_overlap && !(rq->cmd[0] & REQ_IDETAPE_PC2))
1237 set_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags);
1239 if (drive->post_reset == 1) {
1240 set_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags);
1241 drive->post_reset = 0;
1244 if (!test_and_clear_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags) &&
1245 (stat & SEEK_STAT) == 0) {
1246 if (postponed_rq == NULL) {
1247 tape->dsc_polling_start = jiffies;
1248 tape->dsc_poll_freq = tape->best_dsc_rw_freq;
1249 tape->dsc_timeout = jiffies + IDETAPE_DSC_RW_TIMEOUT;
1250 } else if (time_after(jiffies, tape->dsc_timeout)) {
1251 printk(KERN_ERR "ide-tape: %s: DSC timeout\n",
1253 if (rq->cmd[0] & REQ_IDETAPE_PC2) {
1254 idetape_media_access_finished(drive);
1257 return ide_do_reset(drive);
1259 } else if (time_after(jiffies,
1260 tape->dsc_polling_start +
1261 IDETAPE_DSC_MA_THRESHOLD))
1262 tape->dsc_poll_freq = IDETAPE_DSC_MA_SLOW;
1263 idetape_postpone_request(drive);
1266 if (rq->cmd[0] & REQ_IDETAPE_READ) {
1267 pc = idetape_next_pc_storage(drive);
1268 idetape_create_read_cmd(tape, pc, rq->current_nr_sectors,
1269 (struct idetape_bh *)rq->special);
1272 if (rq->cmd[0] & REQ_IDETAPE_WRITE) {
1273 pc = idetape_next_pc_storage(drive);
1274 idetape_create_write_cmd(tape, pc, rq->current_nr_sectors,
1275 (struct idetape_bh *)rq->special);
1278 if (rq->cmd[0] & REQ_IDETAPE_PC1) {
1279 pc = (struct ide_atapi_pc *) rq->buffer;
1280 rq->cmd[0] &= ~(REQ_IDETAPE_PC1);
1281 rq->cmd[0] |= REQ_IDETAPE_PC2;
1284 if (rq->cmd[0] & REQ_IDETAPE_PC2) {
1285 idetape_media_access_finished(drive);
1290 return idetape_issue_pc(drive, pc);
1294 * The function below uses __get_free_pages to allocate a data buffer of size
1295 * tape->buffer_size (or a bit more). We attempt to combine sequential pages as
1298 * It returns a pointer to the newly allocated buffer, or NULL in case of
1301 static idetape_stage_t *ide_tape_kmalloc_buffer(idetape_tape_t *tape, int full,
1304 idetape_stage_t *stage;
1305 struct idetape_bh *prev_bh, *bh;
1306 int pages = tape->pages_per_buffer;
1307 unsigned int order, b_allocd;
1308 char *b_data = NULL;
1310 stage = kmalloc(sizeof(idetape_stage_t), GFP_KERNEL);
1315 stage->bh = kmalloc(sizeof(struct idetape_bh), GFP_KERNEL);
1320 order = fls(pages) - 1;
1321 bh->b_data = (char *) __get_free_pages(GFP_KERNEL, order);
1324 b_allocd = (1 << order) * PAGE_SIZE;
1328 memset(bh->b_data, 0, b_allocd);
1329 bh->b_reqnext = NULL;
1330 bh->b_size = b_allocd;
1331 atomic_set(&bh->b_count, full ? bh->b_size : 0);
1334 order = fls(pages) - 1;
1335 b_data = (char *) __get_free_pages(GFP_KERNEL, order);
1338 b_allocd = (1 << order) * PAGE_SIZE;
1341 memset(b_data, 0, b_allocd);
1343 /* newly allocated page frames below buffer header or ...*/
1344 if (bh->b_data == b_data + b_allocd) {
1345 bh->b_size += b_allocd;
1346 bh->b_data -= b_allocd;
1348 atomic_add(b_allocd, &bh->b_count);
1351 /* they are above the header */
1352 if (b_data == bh->b_data + bh->b_size) {
1353 bh->b_size += b_allocd;
1355 atomic_add(b_allocd, &bh->b_count);
1359 bh = kmalloc(sizeof(struct idetape_bh), GFP_KERNEL);
1361 free_pages((unsigned long) b_data, order);
1364 bh->b_reqnext = NULL;
1365 bh->b_data = b_data;
1366 bh->b_size = b_allocd;
1367 atomic_set(&bh->b_count, full ? bh->b_size : 0);
1368 prev_bh->b_reqnext = bh;
1373 bh->b_size -= tape->excess_bh_size;
1375 atomic_sub(tape->excess_bh_size, &bh->b_count);
1378 ide_tape_kfree_buffer(stage);
1382 static int idetape_copy_stage_from_user(idetape_tape_t *tape,
1383 const char __user *buf, int n)
1385 struct idetape_bh *bh = tape->bh;
1391 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
1395 count = min((unsigned int)
1396 (bh->b_size - atomic_read(&bh->b_count)),
1398 if (copy_from_user(bh->b_data + atomic_read(&bh->b_count), buf,
1402 atomic_add(count, &bh->b_count);
1404 if (atomic_read(&bh->b_count) == bh->b_size) {
1407 atomic_set(&bh->b_count, 0);
1414 static int idetape_copy_stage_to_user(idetape_tape_t *tape, char __user *buf,
1417 struct idetape_bh *bh = tape->bh;
1423 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
1427 count = min(tape->b_count, n);
1428 if (copy_to_user(buf, tape->b_data, count))
1431 tape->b_data += count;
1432 tape->b_count -= count;
1434 if (!tape->b_count) {
1438 tape->b_data = bh->b_data;
1439 tape->b_count = atomic_read(&bh->b_count);
1446 static void idetape_init_merge_stage(idetape_tape_t *tape)
1448 struct idetape_bh *bh = tape->merge_stage->bh;
1451 if (tape->chrdev_dir == IDETAPE_DIR_WRITE)
1452 atomic_set(&bh->b_count, 0);
1454 tape->b_data = bh->b_data;
1455 tape->b_count = atomic_read(&bh->b_count);
1459 static ide_startstop_t idetape_read_position_callback(ide_drive_t *drive)
1461 idetape_tape_t *tape = drive->driver_data;
1462 u8 *readpos = tape->pc->buf;
1464 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1466 if (!tape->pc->error) {
1467 debug_log(DBG_SENSE, "BOP - %s\n",
1468 (readpos[0] & 0x80) ? "Yes" : "No");
1469 debug_log(DBG_SENSE, "EOP - %s\n",
1470 (readpos[0] & 0x40) ? "Yes" : "No");
1472 if (readpos[0] & 0x4) {
1473 printk(KERN_INFO "ide-tape: Block location is unknown"
1475 clear_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags);
1476 idetape_end_request(drive, 0, 0);
1478 debug_log(DBG_SENSE, "Block Location - %u\n",
1479 be32_to_cpu(*(u32 *)&readpos[4]));
1481 tape->partition = readpos[1];
1483 be32_to_cpu(*(u32 *)&readpos[4]);
1484 set_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags);
1485 idetape_end_request(drive, 1, 0);
1488 idetape_end_request(drive, 0, 0);
1494 * Write a filemark if write_filemark=1. Flush the device buffers without
1495 * writing a filemark otherwise.
1497 static void idetape_create_write_filemark_cmd(ide_drive_t *drive,
1498 struct ide_atapi_pc *pc, int write_filemark)
1500 idetape_init_pc(pc);
1501 pc->c[0] = WRITE_FILEMARKS;
1502 pc->c[4] = write_filemark;
1503 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1504 pc->idetape_callback = &idetape_pc_callback;
1507 static void idetape_create_test_unit_ready_cmd(struct ide_atapi_pc *pc)
1509 idetape_init_pc(pc);
1510 pc->c[0] = TEST_UNIT_READY;
1511 pc->idetape_callback = &idetape_pc_callback;
1515 * We add a special packet command request to the tail of the request queue, and
1516 * wait for it to be serviced. This is not to be called from within the request
1517 * handling part of the driver! We allocate here data on the stack and it is
1518 * valid until the request is finished. This is not the case for the bottom part
1519 * of the driver, where we are always leaving the functions to wait for an
1520 * interrupt or a timer event.
1522 * From the bottom part of the driver, we should allocate safe memory using
1523 * idetape_next_pc_storage() and ide_tape_next_rq_storage(), and add the request
1524 * to the request list without waiting for it to be serviced! In that case, we
1525 * usually use idetape_queue_pc_head().
1527 static int idetape_queue_pc_tail(ide_drive_t *drive, struct ide_atapi_pc *pc)
1529 struct ide_tape_obj *tape = drive->driver_data;
1532 idetape_init_rq(&rq, REQ_IDETAPE_PC1);
1533 rq.buffer = (char *) pc;
1534 rq.rq_disk = tape->disk;
1535 return ide_do_drive_cmd(drive, &rq, ide_wait);
1538 static void idetape_create_load_unload_cmd(ide_drive_t *drive,
1539 struct ide_atapi_pc *pc, int cmd)
1541 idetape_init_pc(pc);
1542 pc->c[0] = START_STOP;
1544 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1545 pc->idetape_callback = &idetape_pc_callback;
1548 static int idetape_wait_ready(ide_drive_t *drive, unsigned long timeout)
1550 idetape_tape_t *tape = drive->driver_data;
1551 struct ide_atapi_pc pc;
1552 int load_attempted = 0;
1554 /* Wait for the tape to become ready */
1555 set_bit(IDETAPE_FLAG_MEDIUM_PRESENT, &tape->flags);
1557 while (time_before(jiffies, timeout)) {
1558 idetape_create_test_unit_ready_cmd(&pc);
1559 if (!idetape_queue_pc_tail(drive, &pc))
1561 if ((tape->sense_key == 2 && tape->asc == 4 && tape->ascq == 2)
1562 || (tape->asc == 0x3A)) {
1566 idetape_create_load_unload_cmd(drive, &pc,
1567 IDETAPE_LU_LOAD_MASK);
1568 idetape_queue_pc_tail(drive, &pc);
1570 /* not about to be ready */
1571 } else if (!(tape->sense_key == 2 && tape->asc == 4 &&
1572 (tape->ascq == 1 || tape->ascq == 8)))
1579 static int idetape_flush_tape_buffers(ide_drive_t *drive)
1581 struct ide_atapi_pc pc;
1584 idetape_create_write_filemark_cmd(drive, &pc, 0);
1585 rc = idetape_queue_pc_tail(drive, &pc);
1588 idetape_wait_ready(drive, 60 * 5 * HZ);
1592 static void idetape_create_read_position_cmd(struct ide_atapi_pc *pc)
1594 idetape_init_pc(pc);
1595 pc->c[0] = READ_POSITION;
1597 pc->idetape_callback = &idetape_read_position_callback;
1600 static int idetape_read_position(ide_drive_t *drive)
1602 idetape_tape_t *tape = drive->driver_data;
1603 struct ide_atapi_pc pc;
1606 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1608 idetape_create_read_position_cmd(&pc);
1609 if (idetape_queue_pc_tail(drive, &pc))
1611 position = tape->first_frame;
1615 static void idetape_create_locate_cmd(ide_drive_t *drive,
1616 struct ide_atapi_pc *pc,
1617 unsigned int block, u8 partition, int skip)
1619 idetape_init_pc(pc);
1620 pc->c[0] = POSITION_TO_ELEMENT;
1622 put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[3]);
1623 pc->c[8] = partition;
1624 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1625 pc->idetape_callback = &idetape_pc_callback;
1628 static int idetape_create_prevent_cmd(ide_drive_t *drive,
1629 struct ide_atapi_pc *pc, int prevent)
1631 idetape_tape_t *tape = drive->driver_data;
1633 /* device supports locking according to capabilities page */
1634 if (!(tape->caps[6] & 0x01))
1637 idetape_init_pc(pc);
1638 pc->c[0] = ALLOW_MEDIUM_REMOVAL;
1640 pc->idetape_callback = &idetape_pc_callback;
1644 static void __idetape_discard_read_pipeline(ide_drive_t *drive)
1646 idetape_tape_t *tape = drive->driver_data;
1648 if (tape->chrdev_dir != IDETAPE_DIR_READ)
1651 clear_bit(IDETAPE_FLAG_FILEMARK, &tape->flags);
1652 tape->merge_stage_size = 0;
1653 if (tape->merge_stage != NULL) {
1654 ide_tape_kfree_buffer(tape->merge_stage);
1655 tape->merge_stage = NULL;
1658 tape->chrdev_dir = IDETAPE_DIR_NONE;
1662 * Position the tape to the requested block using the LOCATE packet command.
1663 * A READ POSITION command is then issued to check where we are positioned. Like
1664 * all higher level operations, we queue the commands at the tail of the request
1665 * queue and wait for their completion.
1667 static int idetape_position_tape(ide_drive_t *drive, unsigned int block,
1668 u8 partition, int skip)
1670 idetape_tape_t *tape = drive->driver_data;
1672 struct ide_atapi_pc pc;
1674 if (tape->chrdev_dir == IDETAPE_DIR_READ)
1675 __idetape_discard_read_pipeline(drive);
1676 idetape_wait_ready(drive, 60 * 5 * HZ);
1677 idetape_create_locate_cmd(drive, &pc, block, partition, skip);
1678 retval = idetape_queue_pc_tail(drive, &pc);
1682 idetape_create_read_position_cmd(&pc);
1683 return (idetape_queue_pc_tail(drive, &pc));
1686 static void idetape_discard_read_pipeline(ide_drive_t *drive,
1687 int restore_position)
1689 idetape_tape_t *tape = drive->driver_data;
1692 __idetape_discard_read_pipeline(drive);
1693 if (restore_position) {
1694 position = idetape_read_position(drive);
1695 seek = position > 0 ? position : 0;
1696 if (idetape_position_tape(drive, seek, 0, 0)) {
1697 printk(KERN_INFO "ide-tape: %s: position_tape failed in"
1698 " discard_pipeline()\n", tape->name);
1705 * Generate a read/write request for the block device interface and wait for it
1708 static int idetape_queue_rw_tail(ide_drive_t *drive, int cmd, int blocks,
1709 struct idetape_bh *bh)
1711 idetape_tape_t *tape = drive->driver_data;
1714 debug_log(DBG_SENSE, "%s: cmd=%d\n", __func__, cmd);
1716 idetape_init_rq(&rq, cmd);
1717 rq.rq_disk = tape->disk;
1718 rq.special = (void *)bh;
1719 rq.sector = tape->first_frame;
1720 rq.nr_sectors = blocks;
1721 rq.current_nr_sectors = blocks;
1722 (void) ide_do_drive_cmd(drive, &rq, ide_wait);
1724 if ((cmd & (REQ_IDETAPE_READ | REQ_IDETAPE_WRITE)) == 0)
1727 if (tape->merge_stage)
1728 idetape_init_merge_stage(tape);
1729 if (rq.errors == IDETAPE_ERROR_GENERAL)
1731 return (tape->blk_size * (blocks-rq.current_nr_sectors));
1734 static void idetape_create_inquiry_cmd(struct ide_atapi_pc *pc)
1736 idetape_init_pc(pc);
1740 pc->idetape_callback = &idetape_pc_callback;
1743 static void idetape_create_rewind_cmd(ide_drive_t *drive,
1744 struct ide_atapi_pc *pc)
1746 idetape_init_pc(pc);
1747 pc->c[0] = REZERO_UNIT;
1748 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1749 pc->idetape_callback = &idetape_pc_callback;
1752 static void idetape_create_erase_cmd(struct ide_atapi_pc *pc)
1754 idetape_init_pc(pc);
1757 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1758 pc->idetape_callback = &idetape_pc_callback;
1761 static void idetape_create_space_cmd(struct ide_atapi_pc *pc, int count, u8 cmd)
1763 idetape_init_pc(pc);
1765 put_unaligned(cpu_to_be32(count), (unsigned int *) &pc->c[1]);
1767 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1768 pc->idetape_callback = &idetape_pc_callback;
1771 /* Queue up a character device originated write request. */
1772 static int idetape_add_chrdev_write_request(ide_drive_t *drive, int blocks)
1774 idetape_tape_t *tape = drive->driver_data;
1776 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
1778 return idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE,
1779 blocks, tape->merge_stage->bh);
1782 static void idetape_empty_write_pipeline(ide_drive_t *drive)
1784 idetape_tape_t *tape = drive->driver_data;
1786 struct idetape_bh *bh;
1788 if (tape->chrdev_dir != IDETAPE_DIR_WRITE) {
1789 printk(KERN_ERR "ide-tape: bug: Trying to empty write pipeline,"
1790 " but we are not writing.\n");
1793 if (tape->merge_stage_size > tape->buffer_size) {
1794 printk(KERN_ERR "ide-tape: bug: merge_buffer too big\n");
1795 tape->merge_stage_size = tape->buffer_size;
1797 if (tape->merge_stage_size) {
1798 blocks = tape->merge_stage_size / tape->blk_size;
1799 if (tape->merge_stage_size % tape->blk_size) {
1803 i = tape->blk_size - tape->merge_stage_size %
1805 bh = tape->bh->b_reqnext;
1807 atomic_set(&bh->b_count, 0);
1813 printk(KERN_INFO "ide-tape: bug,"
1817 min = min(i, (unsigned int)(bh->b_size -
1818 atomic_read(&bh->b_count)));
1819 memset(bh->b_data + atomic_read(&bh->b_count),
1821 atomic_add(min, &bh->b_count);
1826 (void) idetape_add_chrdev_write_request(drive, blocks);
1827 tape->merge_stage_size = 0;
1829 if (tape->merge_stage != NULL) {
1830 ide_tape_kfree_buffer(tape->merge_stage);
1831 tape->merge_stage = NULL;
1833 tape->chrdev_dir = IDETAPE_DIR_NONE;
1836 static int idetape_init_read(ide_drive_t *drive)
1838 idetape_tape_t *tape = drive->driver_data;
1841 /* Initialize read operation */
1842 if (tape->chrdev_dir != IDETAPE_DIR_READ) {
1843 if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
1844 idetape_empty_write_pipeline(drive);
1845 idetape_flush_tape_buffers(drive);
1847 if (tape->merge_stage || tape->merge_stage_size) {
1848 printk(KERN_ERR "ide-tape: merge_stage_size should be"
1850 tape->merge_stage_size = 0;
1852 tape->merge_stage = ide_tape_kmalloc_buffer(tape, 0, 0);
1853 if (!tape->merge_stage)
1855 tape->chrdev_dir = IDETAPE_DIR_READ;
1858 * Issue a read 0 command to ensure that DSC handshake is
1859 * switched from completion mode to buffer available mode.
1860 * No point in issuing this if DSC overlap isn't supported, some
1861 * drives (Seagate STT3401A) will return an error.
1863 if (drive->dsc_overlap) {
1864 bytes_read = idetape_queue_rw_tail(drive,
1865 REQ_IDETAPE_READ, 0,
1866 tape->merge_stage->bh);
1867 if (bytes_read < 0) {
1868 ide_tape_kfree_buffer(tape->merge_stage);
1869 tape->merge_stage = NULL;
1870 tape->chrdev_dir = IDETAPE_DIR_NONE;
1879 /* called from idetape_chrdev_read() to service a chrdev read request. */
1880 static int idetape_add_chrdev_read_request(ide_drive_t *drive, int blocks)
1882 idetape_tape_t *tape = drive->driver_data;
1884 debug_log(DBG_PROCS, "Enter %s, %d blocks\n", __func__, blocks);
1886 /* If we are at a filemark, return a read length of 0 */
1887 if (test_bit(IDETAPE_FLAG_FILEMARK, &tape->flags))
1890 idetape_init_read(drive);
1892 return idetape_queue_rw_tail(drive, REQ_IDETAPE_READ, blocks,
1893 tape->merge_stage->bh);
1896 static void idetape_pad_zeros(ide_drive_t *drive, int bcount)
1898 idetape_tape_t *tape = drive->driver_data;
1899 struct idetape_bh *bh;
1905 bh = tape->merge_stage->bh;
1906 count = min(tape->buffer_size, bcount);
1908 blocks = count / tape->blk_size;
1910 atomic_set(&bh->b_count,
1911 min(count, (unsigned int)bh->b_size));
1912 memset(bh->b_data, 0, atomic_read(&bh->b_count));
1913 count -= atomic_read(&bh->b_count);
1916 idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE, blocks,
1917 tape->merge_stage->bh);
1922 * Rewinds the tape to the Beginning Of the current Partition (BOP). We
1923 * currently support only one partition.
1925 static int idetape_rewind_tape(ide_drive_t *drive)
1928 struct ide_atapi_pc pc;
1929 idetape_tape_t *tape;
1930 tape = drive->driver_data;
1932 debug_log(DBG_SENSE, "Enter %s\n", __func__);
1934 idetape_create_rewind_cmd(drive, &pc);
1935 retval = idetape_queue_pc_tail(drive, &pc);
1939 idetape_create_read_position_cmd(&pc);
1940 retval = idetape_queue_pc_tail(drive, &pc);
1946 /* mtio.h compatible commands should be issued to the chrdev interface. */
1947 static int idetape_blkdev_ioctl(ide_drive_t *drive, unsigned int cmd,
1950 idetape_tape_t *tape = drive->driver_data;
1951 void __user *argp = (void __user *)arg;
1953 struct idetape_config {
1954 int dsc_rw_frequency;
1955 int dsc_media_access_frequency;
1959 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1963 if (copy_from_user(&config, argp, sizeof(config)))
1965 tape->best_dsc_rw_freq = config.dsc_rw_frequency;
1968 config.dsc_rw_frequency = (int) tape->best_dsc_rw_freq;
1969 config.nr_stages = 1;
1970 if (copy_to_user(argp, &config, sizeof(config)))
1979 static int idetape_space_over_filemarks(ide_drive_t *drive, short mt_op,
1982 idetape_tape_t *tape = drive->driver_data;
1983 struct ide_atapi_pc pc;
1984 int retval, count = 0;
1985 int sprev = !!(tape->caps[4] & 0x20);
1989 if (MTBSF == mt_op || MTBSFM == mt_op) {
1992 mt_count = -mt_count;
1995 if (tape->chrdev_dir == IDETAPE_DIR_READ) {
1996 tape->merge_stage_size = 0;
1997 if (test_and_clear_bit(IDETAPE_FLAG_FILEMARK, &tape->flags))
1999 idetape_discard_read_pipeline(drive, 0);
2003 * The filemark was not found in our internal pipeline; now we can issue
2004 * the space command.
2009 idetape_create_space_cmd(&pc, mt_count - count,
2010 IDETAPE_SPACE_OVER_FILEMARK);
2011 return idetape_queue_pc_tail(drive, &pc);
2016 retval = idetape_space_over_filemarks(drive, MTFSF,
2020 count = (MTBSFM == mt_op ? 1 : -1);
2021 return idetape_space_over_filemarks(drive, MTFSF, count);
2023 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
2030 * Our character device read / write functions.
2032 * The tape is optimized to maximize throughput when it is transferring an
2033 * integral number of the "continuous transfer limit", which is a parameter of
2034 * the specific tape (26kB on my particular tape, 32kB for Onstream).
2036 * As of version 1.3 of the driver, the character device provides an abstract
2037 * continuous view of the media - any mix of block sizes (even 1 byte) on the
2038 * same backup/restore procedure is supported. The driver will internally
2039 * convert the requests to the recommended transfer unit, so that an unmatch
2040 * between the user's block size to the recommended size will only result in a
2041 * (slightly) increased driver overhead, but will no longer hit performance.
2042 * This is not applicable to Onstream.
2044 static ssize_t idetape_chrdev_read(struct file *file, char __user *buf,
2045 size_t count, loff_t *ppos)
2047 struct ide_tape_obj *tape = ide_tape_f(file);
2048 ide_drive_t *drive = tape->drive;
2049 ssize_t bytes_read, temp, actually_read = 0, rc;
2051 u16 ctl = *(u16 *)&tape->caps[12];
2053 debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
2055 if (tape->chrdev_dir != IDETAPE_DIR_READ) {
2056 if (test_bit(IDETAPE_FLAG_DETECT_BS, &tape->flags))
2057 if (count > tape->blk_size &&
2058 (count % tape->blk_size) == 0)
2059 tape->user_bs_factor = count / tape->blk_size;
2061 rc = idetape_init_read(drive);
2066 if (tape->merge_stage_size) {
2067 actually_read = min((unsigned int)(tape->merge_stage_size),
2068 (unsigned int)count);
2069 if (idetape_copy_stage_to_user(tape, buf, actually_read))
2071 buf += actually_read;
2072 tape->merge_stage_size -= actually_read;
2073 count -= actually_read;
2075 while (count >= tape->buffer_size) {
2076 bytes_read = idetape_add_chrdev_read_request(drive, ctl);
2077 if (bytes_read <= 0)
2079 if (idetape_copy_stage_to_user(tape, buf, bytes_read))
2082 count -= bytes_read;
2083 actually_read += bytes_read;
2086 bytes_read = idetape_add_chrdev_read_request(drive, ctl);
2087 if (bytes_read <= 0)
2089 temp = min((unsigned long)count, (unsigned long)bytes_read);
2090 if (idetape_copy_stage_to_user(tape, buf, temp))
2092 actually_read += temp;
2093 tape->merge_stage_size = bytes_read-temp;
2096 if (!actually_read && test_bit(IDETAPE_FLAG_FILEMARK, &tape->flags)) {
2097 debug_log(DBG_SENSE, "%s: spacing over filemark\n", tape->name);
2099 idetape_space_over_filemarks(drive, MTFSF, 1);
2103 return ret ? ret : actually_read;
2106 static ssize_t idetape_chrdev_write(struct file *file, const char __user *buf,
2107 size_t count, loff_t *ppos)
2109 struct ide_tape_obj *tape = ide_tape_f(file);
2110 ide_drive_t *drive = tape->drive;
2111 ssize_t actually_written = 0;
2113 u16 ctl = *(u16 *)&tape->caps[12];
2115 /* The drive is write protected. */
2116 if (tape->write_prot)
2119 debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
2121 /* Initialize write operation */
2122 if (tape->chrdev_dir != IDETAPE_DIR_WRITE) {
2123 if (tape->chrdev_dir == IDETAPE_DIR_READ)
2124 idetape_discard_read_pipeline(drive, 1);
2125 if (tape->merge_stage || tape->merge_stage_size) {
2126 printk(KERN_ERR "ide-tape: merge_stage_size "
2127 "should be 0 now\n");
2128 tape->merge_stage_size = 0;
2130 tape->merge_stage = ide_tape_kmalloc_buffer(tape, 0, 0);
2131 if (!tape->merge_stage)
2133 tape->chrdev_dir = IDETAPE_DIR_WRITE;
2134 idetape_init_merge_stage(tape);
2137 * Issue a write 0 command to ensure that DSC handshake is
2138 * switched from completion mode to buffer available mode. No
2139 * point in issuing this if DSC overlap isn't supported, some
2140 * drives (Seagate STT3401A) will return an error.
2142 if (drive->dsc_overlap) {
2143 ssize_t retval = idetape_queue_rw_tail(drive,
2144 REQ_IDETAPE_WRITE, 0,
2145 tape->merge_stage->bh);
2147 ide_tape_kfree_buffer(tape->merge_stage);
2148 tape->merge_stage = NULL;
2149 tape->chrdev_dir = IDETAPE_DIR_NONE;
2156 if (tape->merge_stage_size) {
2157 if (tape->merge_stage_size >= tape->buffer_size) {
2158 printk(KERN_ERR "ide-tape: bug: merge buf too big\n");
2159 tape->merge_stage_size = 0;
2161 actually_written = min((unsigned int)
2162 (tape->buffer_size - tape->merge_stage_size),
2163 (unsigned int)count);
2164 if (idetape_copy_stage_from_user(tape, buf, actually_written))
2166 buf += actually_written;
2167 tape->merge_stage_size += actually_written;
2168 count -= actually_written;
2170 if (tape->merge_stage_size == tape->buffer_size) {
2172 tape->merge_stage_size = 0;
2173 retval = idetape_add_chrdev_write_request(drive, ctl);
2178 while (count >= tape->buffer_size) {
2180 if (idetape_copy_stage_from_user(tape, buf, tape->buffer_size))
2182 buf += tape->buffer_size;
2183 count -= tape->buffer_size;
2184 retval = idetape_add_chrdev_write_request(drive, ctl);
2185 actually_written += tape->buffer_size;
2190 actually_written += count;
2191 if (idetape_copy_stage_from_user(tape, buf, count))
2193 tape->merge_stage_size += count;
2195 return ret ? ret : actually_written;
2198 static int idetape_write_filemark(ide_drive_t *drive)
2200 struct ide_atapi_pc pc;
2202 /* Write a filemark */
2203 idetape_create_write_filemark_cmd(drive, &pc, 1);
2204 if (idetape_queue_pc_tail(drive, &pc)) {
2205 printk(KERN_ERR "ide-tape: Couldn't write a filemark\n");
2212 * Called from idetape_chrdev_ioctl when the general mtio MTIOCTOP ioctl is
2215 * Note: MTBSF and MTBSFM are not supported when the tape doesn't support
2216 * spacing over filemarks in the reverse direction. In this case, MTFSFM is also
2217 * usually not supported.
2219 * The following commands are currently not supported:
2221 * MTFSS, MTBSS, MTWSM, MTSETDENSITY, MTSETDRVBUFFER, MT_ST_BOOLEANS,
2222 * MT_ST_WRITE_THRESHOLD.
2224 static int idetape_mtioctop(ide_drive_t *drive, short mt_op, int mt_count)
2226 idetape_tape_t *tape = drive->driver_data;
2227 struct ide_atapi_pc pc;
2230 debug_log(DBG_ERR, "Handling MTIOCTOP ioctl: mt_op=%d, mt_count=%d\n",
2240 return idetape_space_over_filemarks(drive, mt_op, mt_count);
2247 if (tape->write_prot)
2249 idetape_discard_read_pipeline(drive, 1);
2250 for (i = 0; i < mt_count; i++) {
2251 retval = idetape_write_filemark(drive);
2257 idetape_discard_read_pipeline(drive, 0);
2258 if (idetape_rewind_tape(drive))
2262 idetape_discard_read_pipeline(drive, 0);
2263 idetape_create_load_unload_cmd(drive, &pc,
2264 IDETAPE_LU_LOAD_MASK);
2265 return idetape_queue_pc_tail(drive, &pc);
2269 * If door is locked, attempt to unlock before
2270 * attempting to eject.
2272 if (tape->door_locked) {
2273 if (idetape_create_prevent_cmd(drive, &pc, 0))
2274 if (!idetape_queue_pc_tail(drive, &pc))
2275 tape->door_locked = DOOR_UNLOCKED;
2277 idetape_discard_read_pipeline(drive, 0);
2278 idetape_create_load_unload_cmd(drive, &pc,
2279 !IDETAPE_LU_LOAD_MASK);
2280 retval = idetape_queue_pc_tail(drive, &pc);
2282 clear_bit(IDETAPE_FLAG_MEDIUM_PRESENT, &tape->flags);
2285 idetape_discard_read_pipeline(drive, 0);
2286 return idetape_flush_tape_buffers(drive);
2288 idetape_discard_read_pipeline(drive, 0);
2289 idetape_create_load_unload_cmd(drive, &pc,
2290 IDETAPE_LU_RETENSION_MASK | IDETAPE_LU_LOAD_MASK);
2291 return idetape_queue_pc_tail(drive, &pc);
2293 idetape_create_space_cmd(&pc, 0, IDETAPE_SPACE_TO_EOD);
2294 return idetape_queue_pc_tail(drive, &pc);
2296 (void)idetape_rewind_tape(drive);
2297 idetape_create_erase_cmd(&pc);
2298 return idetape_queue_pc_tail(drive, &pc);
2301 if (mt_count < tape->blk_size ||
2302 mt_count % tape->blk_size)
2304 tape->user_bs_factor = mt_count / tape->blk_size;
2305 clear_bit(IDETAPE_FLAG_DETECT_BS, &tape->flags);
2307 set_bit(IDETAPE_FLAG_DETECT_BS, &tape->flags);
2310 idetape_discard_read_pipeline(drive, 0);
2311 return idetape_position_tape(drive,
2312 mt_count * tape->user_bs_factor, tape->partition, 0);
2314 idetape_discard_read_pipeline(drive, 0);
2315 return idetape_position_tape(drive, 0, mt_count, 0);
2319 if (!idetape_create_prevent_cmd(drive, &pc, 1))
2321 retval = idetape_queue_pc_tail(drive, &pc);
2324 tape->door_locked = DOOR_EXPLICITLY_LOCKED;
2327 if (!idetape_create_prevent_cmd(drive, &pc, 0))
2329 retval = idetape_queue_pc_tail(drive, &pc);
2332 tape->door_locked = DOOR_UNLOCKED;
2335 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
2342 * Our character device ioctls. General mtio.h magnetic io commands are
2343 * supported here, and not in the corresponding block interface. Our own
2344 * ide-tape ioctls are supported on both interfaces.
2346 static int idetape_chrdev_ioctl(struct inode *inode, struct file *file,
2347 unsigned int cmd, unsigned long arg)
2349 struct ide_tape_obj *tape = ide_tape_f(file);
2350 ide_drive_t *drive = tape->drive;
2354 int block_offset = 0, position = tape->first_frame;
2355 void __user *argp = (void __user *)arg;
2357 debug_log(DBG_CHRDEV, "Enter %s, cmd=%u\n", __func__, cmd);
2359 if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
2360 idetape_empty_write_pipeline(drive);
2361 idetape_flush_tape_buffers(drive);
2363 if (cmd == MTIOCGET || cmd == MTIOCPOS) {
2364 block_offset = tape->merge_stage_size /
2365 (tape->blk_size * tape->user_bs_factor);
2366 position = idetape_read_position(drive);
2372 if (copy_from_user(&mtop, argp, sizeof(struct mtop)))
2374 return idetape_mtioctop(drive, mtop.mt_op, mtop.mt_count);
2376 memset(&mtget, 0, sizeof(struct mtget));
2377 mtget.mt_type = MT_ISSCSI2;
2378 mtget.mt_blkno = position / tape->user_bs_factor - block_offset;
2380 ((tape->blk_size * tape->user_bs_factor)
2381 << MT_ST_BLKSIZE_SHIFT) & MT_ST_BLKSIZE_MASK;
2383 if (tape->drv_write_prot)
2384 mtget.mt_gstat |= GMT_WR_PROT(0xffffffff);
2386 if (copy_to_user(argp, &mtget, sizeof(struct mtget)))
2390 mtpos.mt_blkno = position / tape->user_bs_factor - block_offset;
2391 if (copy_to_user(argp, &mtpos, sizeof(struct mtpos)))
2395 if (tape->chrdev_dir == IDETAPE_DIR_READ)
2396 idetape_discard_read_pipeline(drive, 1);
2397 return idetape_blkdev_ioctl(drive, cmd, arg);
2402 * Do a mode sense page 0 with block descriptor and if it succeeds set the tape
2403 * block size with the reported value.
2405 static void ide_tape_get_bsize_from_bdesc(ide_drive_t *drive)
2407 idetape_tape_t *tape = drive->driver_data;
2408 struct ide_atapi_pc pc;
2410 idetape_create_mode_sense_cmd(&pc, IDETAPE_BLOCK_DESCRIPTOR);
2411 if (idetape_queue_pc_tail(drive, &pc)) {
2412 printk(KERN_ERR "ide-tape: Can't get block descriptor\n");
2413 if (tape->blk_size == 0) {
2414 printk(KERN_WARNING "ide-tape: Cannot deal with zero "
2415 "block size, assuming 32k\n");
2416 tape->blk_size = 32768;
2420 tape->blk_size = (pc.buf[4 + 5] << 16) +
2421 (pc.buf[4 + 6] << 8) +
2423 tape->drv_write_prot = (pc.buf[2] & 0x80) >> 7;
2426 static int idetape_chrdev_open(struct inode *inode, struct file *filp)
2428 unsigned int minor = iminor(inode), i = minor & ~0xc0;
2430 idetape_tape_t *tape;
2431 struct ide_atapi_pc pc;
2434 if (i >= MAX_HWIFS * MAX_DRIVES)
2437 tape = ide_tape_chrdev_get(i);
2441 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
2444 * We really want to do nonseekable_open(inode, filp); here, but some
2445 * versions of tar incorrectly call lseek on tapes and bail out if that
2446 * fails. So we disallow pread() and pwrite(), but permit lseeks.
2448 filp->f_mode &= ~(FMODE_PREAD | FMODE_PWRITE);
2450 drive = tape->drive;
2452 filp->private_data = tape;
2454 if (test_and_set_bit(IDETAPE_FLAG_BUSY, &tape->flags)) {
2459 retval = idetape_wait_ready(drive, 60 * HZ);
2461 clear_bit(IDETAPE_FLAG_BUSY, &tape->flags);
2462 printk(KERN_ERR "ide-tape: %s: drive not ready\n", tape->name);
2466 idetape_read_position(drive);
2467 if (!test_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags))
2468 (void)idetape_rewind_tape(drive);
2470 /* Read block size and write protect status from drive. */
2471 ide_tape_get_bsize_from_bdesc(drive);
2473 /* Set write protect flag if device is opened as read-only. */
2474 if ((filp->f_flags & O_ACCMODE) == O_RDONLY)
2475 tape->write_prot = 1;
2477 tape->write_prot = tape->drv_write_prot;
2479 /* Make sure drive isn't write protected if user wants to write. */
2480 if (tape->write_prot) {
2481 if ((filp->f_flags & O_ACCMODE) == O_WRONLY ||
2482 (filp->f_flags & O_ACCMODE) == O_RDWR) {
2483 clear_bit(IDETAPE_FLAG_BUSY, &tape->flags);
2489 /* Lock the tape drive door so user can't eject. */
2490 if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
2491 if (idetape_create_prevent_cmd(drive, &pc, 1)) {
2492 if (!idetape_queue_pc_tail(drive, &pc)) {
2493 if (tape->door_locked != DOOR_EXPLICITLY_LOCKED)
2494 tape->door_locked = DOOR_LOCKED;
2505 static void idetape_write_release(ide_drive_t *drive, unsigned int minor)
2507 idetape_tape_t *tape = drive->driver_data;
2509 idetape_empty_write_pipeline(drive);
2510 tape->merge_stage = ide_tape_kmalloc_buffer(tape, 1, 0);
2511 if (tape->merge_stage != NULL) {
2512 idetape_pad_zeros(drive, tape->blk_size *
2513 (tape->user_bs_factor - 1));
2514 ide_tape_kfree_buffer(tape->merge_stage);
2515 tape->merge_stage = NULL;
2517 idetape_write_filemark(drive);
2518 idetape_flush_tape_buffers(drive);
2519 idetape_flush_tape_buffers(drive);
2522 static int idetape_chrdev_release(struct inode *inode, struct file *filp)
2524 struct ide_tape_obj *tape = ide_tape_f(filp);
2525 ide_drive_t *drive = tape->drive;
2526 struct ide_atapi_pc pc;
2527 unsigned int minor = iminor(inode);
2530 tape = drive->driver_data;
2532 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
2534 if (tape->chrdev_dir == IDETAPE_DIR_WRITE)
2535 idetape_write_release(drive, minor);
2536 if (tape->chrdev_dir == IDETAPE_DIR_READ) {
2538 idetape_discard_read_pipeline(drive, 1);
2541 if (minor < 128 && test_bit(IDETAPE_FLAG_MEDIUM_PRESENT, &tape->flags))
2542 (void) idetape_rewind_tape(drive);
2543 if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
2544 if (tape->door_locked == DOOR_LOCKED) {
2545 if (idetape_create_prevent_cmd(drive, &pc, 0)) {
2546 if (!idetape_queue_pc_tail(drive, &pc))
2547 tape->door_locked = DOOR_UNLOCKED;
2551 clear_bit(IDETAPE_FLAG_BUSY, &tape->flags);
2558 * check the contents of the ATAPI IDENTIFY command results. We return:
2560 * 1 - If the tape can be supported by us, based on the information we have so
2563 * 0 - If this tape driver is not currently supported by us.
2565 static int idetape_identify_device(ide_drive_t *drive)
2567 u8 gcw[2], protocol, device_type, removable, packet_size;
2569 if (drive->id_read == 0)
2572 *((unsigned short *) &gcw) = drive->id->config;
2574 protocol = (gcw[1] & 0xC0) >> 6;
2575 device_type = gcw[1] & 0x1F;
2576 removable = !!(gcw[0] & 0x80);
2577 packet_size = gcw[0] & 0x3;
2579 /* Check that we can support this device */
2581 printk(KERN_ERR "ide-tape: Protocol (0x%02x) is not ATAPI\n",
2583 else if (device_type != 1)
2584 printk(KERN_ERR "ide-tape: Device type (0x%02x) is not set "
2585 "to tape\n", device_type);
2586 else if (!removable)
2587 printk(KERN_ERR "ide-tape: The removable flag is not set\n");
2588 else if (packet_size != 0) {
2589 printk(KERN_ERR "ide-tape: Packet size (0x%02x) is not 12"
2590 " bytes\n", packet_size);
2596 static void idetape_get_inquiry_results(ide_drive_t *drive)
2598 idetape_tape_t *tape = drive->driver_data;
2599 struct ide_atapi_pc pc;
2600 char fw_rev[6], vendor_id[10], product_id[18];
2602 idetape_create_inquiry_cmd(&pc);
2603 if (idetape_queue_pc_tail(drive, &pc)) {
2604 printk(KERN_ERR "ide-tape: %s: can't get INQUIRY results\n",
2608 memcpy(vendor_id, &pc.buf[8], 8);
2609 memcpy(product_id, &pc.buf[16], 16);
2610 memcpy(fw_rev, &pc.buf[32], 4);
2612 ide_fixstring(vendor_id, 10, 0);
2613 ide_fixstring(product_id, 18, 0);
2614 ide_fixstring(fw_rev, 6, 0);
2616 printk(KERN_INFO "ide-tape: %s <-> %s: %s %s rev %s\n",
2617 drive->name, tape->name, vendor_id, product_id, fw_rev);
2621 * Ask the tape about its various parameters. In particular, we will adjust our
2622 * data transfer buffer size to the recommended value as returned by the tape.
2624 static void idetape_get_mode_sense_results(ide_drive_t *drive)
2626 idetape_tape_t *tape = drive->driver_data;
2627 struct ide_atapi_pc pc;
2629 u8 speed, max_speed;
2631 idetape_create_mode_sense_cmd(&pc, IDETAPE_CAPABILITIES_PAGE);
2632 if (idetape_queue_pc_tail(drive, &pc)) {
2633 printk(KERN_ERR "ide-tape: Can't get tape parameters - assuming"
2634 " some default values\n");
2635 tape->blk_size = 512;
2636 put_unaligned(52, (u16 *)&tape->caps[12]);
2637 put_unaligned(540, (u16 *)&tape->caps[14]);
2638 put_unaligned(6*52, (u16 *)&tape->caps[16]);
2641 caps = pc.buf + 4 + pc.buf[3];
2643 /* convert to host order and save for later use */
2644 speed = be16_to_cpu(*(u16 *)&caps[14]);
2645 max_speed = be16_to_cpu(*(u16 *)&caps[8]);
2647 put_unaligned(max_speed, (u16 *)&caps[8]);
2648 put_unaligned(be16_to_cpu(*(u16 *)&caps[12]), (u16 *)&caps[12]);
2649 put_unaligned(speed, (u16 *)&caps[14]);
2650 put_unaligned(be16_to_cpu(*(u16 *)&caps[16]), (u16 *)&caps[16]);
2653 printk(KERN_INFO "ide-tape: %s: invalid tape speed "
2654 "(assuming 650KB/sec)\n", drive->name);
2655 put_unaligned(650, (u16 *)&caps[14]);
2658 printk(KERN_INFO "ide-tape: %s: invalid max_speed "
2659 "(assuming 650KB/sec)\n", drive->name);
2660 put_unaligned(650, (u16 *)&caps[8]);
2663 memcpy(&tape->caps, caps, 20);
2665 tape->blk_size = 512;
2666 else if (caps[7] & 0x04)
2667 tape->blk_size = 1024;
2670 #ifdef CONFIG_IDE_PROC_FS
2671 static void idetape_add_settings(ide_drive_t *drive)
2673 idetape_tape_t *tape = drive->driver_data;
2675 ide_add_setting(drive, "buffer", SETTING_READ, TYPE_SHORT, 0, 0xffff,
2676 1, 2, (u16 *)&tape->caps[16], NULL);
2677 ide_add_setting(drive, "speed", SETTING_READ, TYPE_SHORT, 0, 0xffff,
2678 1, 1, (u16 *)&tape->caps[14], NULL);
2679 ide_add_setting(drive, "buffer_size", SETTING_READ, TYPE_INT, 0, 0xffff,
2680 1, 1024, &tape->buffer_size, NULL);
2681 ide_add_setting(drive, "tdsc", SETTING_RW, TYPE_INT, IDETAPE_DSC_RW_MIN,
2682 IDETAPE_DSC_RW_MAX, 1000, HZ, &tape->best_dsc_rw_freq,
2684 ide_add_setting(drive, "dsc_overlap", SETTING_RW, TYPE_BYTE, 0, 1, 1,
2685 1, &drive->dsc_overlap, NULL);
2686 ide_add_setting(drive, "avg_speed", SETTING_READ, TYPE_INT, 0, 0xffff,
2687 1, 1, &tape->avg_speed, NULL);
2688 ide_add_setting(drive, "debug_mask", SETTING_RW, TYPE_INT, 0, 0xffff, 1,
2689 1, &tape->debug_mask, NULL);
2692 static inline void idetape_add_settings(ide_drive_t *drive) { ; }
2696 * The function below is called to:
2698 * 1. Initialize our various state variables.
2699 * 2. Ask the tape for its capabilities.
2700 * 3. Allocate a buffer which will be used for data transfer. The buffer size
2701 * is chosen based on the recommendation which we received in step 2.
2703 * Note that at this point ide.c already assigned us an irq, so that we can
2704 * queue requests here and wait for their completion.
2706 static void idetape_setup(ide_drive_t *drive, idetape_tape_t *tape, int minor)
2712 u16 *ctl = (u16 *)&tape->caps[12];
2714 spin_lock_init(&tape->lock);
2715 drive->dsc_overlap = 1;
2716 if (drive->hwif->host_flags & IDE_HFLAG_NO_DSC) {
2717 printk(KERN_INFO "ide-tape: %s: disabling DSC overlap\n",
2719 drive->dsc_overlap = 0;
2721 /* Seagate Travan drives do not support DSC overlap. */
2722 if (strstr(drive->id->model, "Seagate STT3401"))
2723 drive->dsc_overlap = 0;
2724 tape->minor = minor;
2725 tape->name[0] = 'h';
2726 tape->name[1] = 't';
2727 tape->name[2] = '0' + minor;
2728 tape->chrdev_dir = IDETAPE_DIR_NONE;
2729 tape->pc = tape->pc_stack;
2730 *((unsigned short *) &gcw) = drive->id->config;
2732 /* Command packet DRQ type */
2733 if (((gcw[0] & 0x60) >> 5) == 1)
2734 set_bit(IDETAPE_FLAG_DRQ_INTERRUPT, &tape->flags);
2736 idetape_get_inquiry_results(drive);
2737 idetape_get_mode_sense_results(drive);
2738 ide_tape_get_bsize_from_bdesc(drive);
2739 tape->user_bs_factor = 1;
2740 tape->buffer_size = *ctl * tape->blk_size;
2741 while (tape->buffer_size > 0xffff) {
2742 printk(KERN_NOTICE "ide-tape: decreasing stage size\n");
2744 tape->buffer_size = *ctl * tape->blk_size;
2746 buffer_size = tape->buffer_size;
2747 tape->pages_per_buffer = buffer_size / PAGE_SIZE;
2748 if (buffer_size % PAGE_SIZE) {
2749 tape->pages_per_buffer++;
2750 tape->excess_bh_size = PAGE_SIZE - buffer_size % PAGE_SIZE;
2753 /* select the "best" DSC read/write polling freq */
2754 speed = max(*(u16 *)&tape->caps[14], *(u16 *)&tape->caps[8]);
2756 t = (IDETAPE_FIFO_THRESHOLD * tape->buffer_size * HZ) / (speed * 1000);
2759 * Ensure that the number we got makes sense; limit it within
2760 * IDETAPE_DSC_RW_MIN and IDETAPE_DSC_RW_MAX.
2762 tape->best_dsc_rw_freq = max_t(unsigned long,
2763 min_t(unsigned long, t, IDETAPE_DSC_RW_MAX),
2764 IDETAPE_DSC_RW_MIN);
2765 printk(KERN_INFO "ide-tape: %s <-> %s: %dKBps, %d*%dkB buffer, "
2767 drive->name, tape->name, *(u16 *)&tape->caps[14],
2768 (*(u16 *)&tape->caps[16] * 512) / tape->buffer_size,
2769 tape->buffer_size / 1024,
2770 tape->best_dsc_rw_freq * 1000 / HZ,
2771 drive->using_dma ? ", DMA":"");
2773 idetape_add_settings(drive);
2776 static void ide_tape_remove(ide_drive_t *drive)
2778 idetape_tape_t *tape = drive->driver_data;
2780 ide_proc_unregister_driver(drive, tape->driver);
2782 ide_unregister_region(tape->disk);
2787 static void ide_tape_release(struct kref *kref)
2789 struct ide_tape_obj *tape = to_ide_tape(kref);
2790 ide_drive_t *drive = tape->drive;
2791 struct gendisk *g = tape->disk;
2793 BUG_ON(tape->merge_stage_size);
2795 drive->dsc_overlap = 0;
2796 drive->driver_data = NULL;
2797 device_destroy(idetape_sysfs_class, MKDEV(IDETAPE_MAJOR, tape->minor));
2798 device_destroy(idetape_sysfs_class,
2799 MKDEV(IDETAPE_MAJOR, tape->minor + 128));
2800 idetape_devs[tape->minor] = NULL;
2801 g->private_data = NULL;
2806 #ifdef CONFIG_IDE_PROC_FS
2807 static int proc_idetape_read_name
2808 (char *page, char **start, off_t off, int count, int *eof, void *data)
2810 ide_drive_t *drive = (ide_drive_t *) data;
2811 idetape_tape_t *tape = drive->driver_data;
2815 len = sprintf(out, "%s\n", tape->name);
2816 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
2819 static ide_proc_entry_t idetape_proc[] = {
2820 { "capacity", S_IFREG|S_IRUGO, proc_ide_read_capacity, NULL },
2821 { "name", S_IFREG|S_IRUGO, proc_idetape_read_name, NULL },
2822 { NULL, 0, NULL, NULL }
2826 static int ide_tape_probe(ide_drive_t *);
2828 static ide_driver_t idetape_driver = {
2830 .owner = THIS_MODULE,
2832 .bus = &ide_bus_type,
2834 .probe = ide_tape_probe,
2835 .remove = ide_tape_remove,
2836 .version = IDETAPE_VERSION,
2838 .supports_dsc_overlap = 1,
2839 .do_request = idetape_do_request,
2840 .end_request = idetape_end_request,
2841 .error = __ide_error,
2842 .abort = __ide_abort,
2843 #ifdef CONFIG_IDE_PROC_FS
2844 .proc = idetape_proc,
2848 /* Our character device supporting functions, passed to register_chrdev. */
2849 static const struct file_operations idetape_fops = {
2850 .owner = THIS_MODULE,
2851 .read = idetape_chrdev_read,
2852 .write = idetape_chrdev_write,
2853 .ioctl = idetape_chrdev_ioctl,
2854 .open = idetape_chrdev_open,
2855 .release = idetape_chrdev_release,
2858 static int idetape_open(struct inode *inode, struct file *filp)
2860 struct gendisk *disk = inode->i_bdev->bd_disk;
2861 struct ide_tape_obj *tape;
2863 tape = ide_tape_get(disk);
2870 static int idetape_release(struct inode *inode, struct file *filp)
2872 struct gendisk *disk = inode->i_bdev->bd_disk;
2873 struct ide_tape_obj *tape = ide_tape_g(disk);
2880 static int idetape_ioctl(struct inode *inode, struct file *file,
2881 unsigned int cmd, unsigned long arg)
2883 struct block_device *bdev = inode->i_bdev;
2884 struct ide_tape_obj *tape = ide_tape_g(bdev->bd_disk);
2885 ide_drive_t *drive = tape->drive;
2886 int err = generic_ide_ioctl(drive, file, bdev, cmd, arg);
2888 err = idetape_blkdev_ioctl(drive, cmd, arg);
2892 static struct block_device_operations idetape_block_ops = {
2893 .owner = THIS_MODULE,
2894 .open = idetape_open,
2895 .release = idetape_release,
2896 .ioctl = idetape_ioctl,
2899 static int ide_tape_probe(ide_drive_t *drive)
2901 idetape_tape_t *tape;
2905 if (!strstr("ide-tape", drive->driver_req))
2907 if (!drive->present)
2909 if (drive->media != ide_tape)
2911 if (!idetape_identify_device(drive)) {
2912 printk(KERN_ERR "ide-tape: %s: not supported by this version of"
2913 " the driver\n", drive->name);
2917 printk(KERN_INFO "ide-tape: passing drive %s to ide-scsi"
2918 " emulation.\n", drive->name);
2921 tape = kzalloc(sizeof(idetape_tape_t), GFP_KERNEL);
2923 printk(KERN_ERR "ide-tape: %s: Can't allocate a tape struct\n",
2928 g = alloc_disk(1 << PARTN_BITS);
2932 ide_init_disk(g, drive);
2934 ide_proc_register_driver(drive, &idetape_driver);
2936 kref_init(&tape->kref);
2938 tape->drive = drive;
2939 tape->driver = &idetape_driver;
2942 g->private_data = &tape->driver;
2944 drive->driver_data = tape;
2946 mutex_lock(&idetape_ref_mutex);
2947 for (minor = 0; idetape_devs[minor]; minor++)
2949 idetape_devs[minor] = tape;
2950 mutex_unlock(&idetape_ref_mutex);
2952 idetape_setup(drive, tape, minor);
2954 device_create(idetape_sysfs_class, &drive->gendev,
2955 MKDEV(IDETAPE_MAJOR, minor), "%s", tape->name);
2956 device_create(idetape_sysfs_class, &drive->gendev,
2957 MKDEV(IDETAPE_MAJOR, minor + 128), "n%s", tape->name);
2959 g->fops = &idetape_block_ops;
2960 ide_register_region(g);
2970 static void __exit idetape_exit(void)
2972 driver_unregister(&idetape_driver.gen_driver);
2973 class_destroy(idetape_sysfs_class);
2974 unregister_chrdev(IDETAPE_MAJOR, "ht");
2977 static int __init idetape_init(void)
2980 idetape_sysfs_class = class_create(THIS_MODULE, "ide_tape");
2981 if (IS_ERR(idetape_sysfs_class)) {
2982 idetape_sysfs_class = NULL;
2983 printk(KERN_ERR "Unable to create sysfs class for ide tapes\n");
2988 if (register_chrdev(IDETAPE_MAJOR, "ht", &idetape_fops)) {
2989 printk(KERN_ERR "ide-tape: Failed to register chrdev"
2992 goto out_free_class;
2995 error = driver_register(&idetape_driver.gen_driver);
2997 goto out_free_driver;
3002 driver_unregister(&idetape_driver.gen_driver);
3004 class_destroy(idetape_sysfs_class);
3009 MODULE_ALIAS("ide:*m-tape*");
3010 module_init(idetape_init);
3011 module_exit(idetape_exit);
3012 MODULE_ALIAS_CHARDEV_MAJOR(IDETAPE_MAJOR);
3013 MODULE_DESCRIPTION("ATAPI Streaming TAPE Driver");
3014 MODULE_LICENSE("GPL");