2 * IDE ATAPI streaming tape driver.
4 * Copyright (C) 1995-1999 Gadi Oxman <gadio@netvision.net.il>
5 * Copyright (C) 2003-2005 Bartlomiej Zolnierkiewicz
7 * This driver was constructed as a student project in the software laboratory
8 * of the faculty of electrical engineering in the Technion - Israel's
9 * Institute Of Technology, with the guide of Avner Lottem and Dr. Ilana David.
11 * It is hereby placed under the terms of the GNU general public license.
12 * (See linux/COPYING).
14 * For a historical changelog see
15 * Documentation/ide/ChangeLog.ide-tape.1995-2002
18 #define IDETAPE_VERSION "1.20"
20 #include <linux/module.h>
21 #include <linux/types.h>
22 #include <linux/string.h>
23 #include <linux/kernel.h>
24 #include <linux/delay.h>
25 #include <linux/timer.h>
27 #include <linux/interrupt.h>
28 #include <linux/jiffies.h>
29 #include <linux/major.h>
30 #include <linux/errno.h>
31 #include <linux/genhd.h>
32 #include <linux/slab.h>
33 #include <linux/pci.h>
34 #include <linux/ide.h>
35 #include <linux/smp_lock.h>
36 #include <linux/completion.h>
37 #include <linux/bitops.h>
38 #include <linux/mutex.h>
39 #include <scsi/scsi.h>
41 #include <asm/byteorder.h>
42 #include <linux/irq.h>
43 #include <linux/uaccess.h>
45 #include <asm/unaligned.h>
46 #include <linux/mtio.h>
49 /* output errors only */
51 /* output all sense key/asc */
53 /* info regarding all chrdev-related procedures */
54 DBG_CHRDEV = (1 << 2),
55 /* all remaining procedures */
57 /* buffer alloc info (pc_stack & rq_stack) */
58 DBG_PCRQ_STACK = (1 << 4),
61 /* define to see debug info */
62 #define IDETAPE_DEBUG_LOG 0
65 #define debug_log(lvl, fmt, args...) \
67 if (tape->debug_mask & lvl) \
68 printk(KERN_INFO "ide-tape: " fmt, ## args); \
71 #define debug_log(lvl, fmt, args...) do {} while (0)
74 /**************************** Tunable parameters *****************************/
76 * After each failed packet command we issue a request sense command and retry
77 * the packet command IDETAPE_MAX_PC_RETRIES times.
79 * Setting IDETAPE_MAX_PC_RETRIES to 0 will disable retries.
81 #define IDETAPE_MAX_PC_RETRIES 3
84 * With each packet command, we allocate a buffer of IDETAPE_PC_BUFFER_SIZE
85 * bytes. This is used for several packet commands (Not for READ/WRITE commands)
87 #define IDETAPE_PC_BUFFER_SIZE 256
90 * In various places in the driver, we need to allocate storage
91 * for packet commands and requests, which will remain valid while
92 * we leave the driver to wait for an interrupt or a timeout event.
94 #define IDETAPE_PC_STACK (10 + IDETAPE_MAX_PC_RETRIES)
97 * Some drives (for example, Seagate STT3401A Travan) require a very long
98 * timeout, because they don't return an interrupt or clear their busy bit
99 * until after the command completes (even retension commands).
101 #define IDETAPE_WAIT_CMD (900*HZ)
104 * The following parameter is used to select the point in the internal tape fifo
105 * in which we will start to refill the buffer. Decreasing the following
106 * parameter will improve the system's latency and interactive response, while
107 * using a high value might improve system throughput.
109 #define IDETAPE_FIFO_THRESHOLD 2
112 * DSC polling parameters.
114 * Polling for DSC (a single bit in the status register) is a very important
115 * function in ide-tape. There are two cases in which we poll for DSC:
117 * 1. Before a read/write packet command, to ensure that we can transfer data
118 * from/to the tape's data buffers, without causing an actual media access.
119 * In case the tape is not ready yet, we take out our request from the device
120 * request queue, so that ide.c could service requests from the other device
121 * on the same interface in the meantime.
123 * 2. After the successful initialization of a "media access packet command",
124 * which is a command that can take a long time to complete (the interval can
125 * range from several seconds to even an hour). Again, we postpone our request
126 * in the middle to free the bus for the other device. The polling frequency
127 * here should be lower than the read/write frequency since those media access
128 * commands are slow. We start from a "fast" frequency - IDETAPE_DSC_MA_FAST
129 * (1 second), and if we don't receive DSC after IDETAPE_DSC_MA_THRESHOLD
130 * (5 min), we switch it to a lower frequency - IDETAPE_DSC_MA_SLOW (1 min).
132 * We also set a timeout for the timer, in case something goes wrong. The
133 * timeout should be longer then the maximum execution time of a tape operation.
137 #define IDETAPE_DSC_RW_MIN 5*HZ/100 /* 50 msec */
138 #define IDETAPE_DSC_RW_MAX 40*HZ/100 /* 400 msec */
139 #define IDETAPE_DSC_RW_TIMEOUT 2*60*HZ /* 2 minutes */
140 #define IDETAPE_DSC_MA_FAST 2*HZ /* 2 seconds */
141 #define IDETAPE_DSC_MA_THRESHOLD 5*60*HZ /* 5 minutes */
142 #define IDETAPE_DSC_MA_SLOW 30*HZ /* 30 seconds */
143 #define IDETAPE_DSC_MA_TIMEOUT 2*60*60*HZ /* 2 hours */
145 /*************************** End of tunable parameters ***********************/
147 /* tape directions */
149 IDETAPE_DIR_NONE = (1 << 0),
150 IDETAPE_DIR_READ = (1 << 1),
151 IDETAPE_DIR_WRITE = (1 << 2),
157 struct idetape_bh *b_reqnext;
161 /* Tape door status */
162 #define DOOR_UNLOCKED 0
163 #define DOOR_LOCKED 1
164 #define DOOR_EXPLICITLY_LOCKED 2
166 /* Some defines for the SPACE command */
167 #define IDETAPE_SPACE_OVER_FILEMARK 1
168 #define IDETAPE_SPACE_TO_EOD 3
170 /* Some defines for the LOAD UNLOAD command */
171 #define IDETAPE_LU_LOAD_MASK 1
172 #define IDETAPE_LU_RETENSION_MASK 2
173 #define IDETAPE_LU_EOT_MASK 4
176 * Special requests for our block device strategy routine.
178 * In order to service a character device command, we add special requests to
179 * the tail of our block device request queue and wait for their completion.
183 REQ_IDETAPE_PC1 = (1 << 0), /* packet command (first stage) */
184 REQ_IDETAPE_PC2 = (1 << 1), /* packet command (second stage) */
185 REQ_IDETAPE_READ = (1 << 2),
186 REQ_IDETAPE_WRITE = (1 << 3),
189 /* Error codes returned in rq->errors to the higher part of the driver. */
190 #define IDETAPE_ERROR_GENERAL 101
191 #define IDETAPE_ERROR_FILEMARK 102
192 #define IDETAPE_ERROR_EOD 103
194 /* Structures related to the SELECT SENSE / MODE SENSE packet commands. */
195 #define IDETAPE_BLOCK_DESCRIPTOR 0
196 #define IDETAPE_CAPABILITIES_PAGE 0x2a
198 /* Tape flag bits values. */
200 IDETAPE_FLAG_IGNORE_DSC = (1 << 0),
201 /* 0 When the tape position is unknown */
202 IDETAPE_FLAG_ADDRESS_VALID = (1 << 1),
203 /* Device already opened */
204 IDETAPE_FLAG_BUSY = (1 << 2),
205 /* Attempt to auto-detect the current user block size */
206 IDETAPE_FLAG_DETECT_BS = (1 << 3),
207 /* Currently on a filemark */
208 IDETAPE_FLAG_FILEMARK = (1 << 4),
209 /* DRQ interrupt device */
210 IDETAPE_FLAG_DRQ_INTERRUPT = (1 << 5),
211 /* 0 = no tape is loaded, so we don't rewind after ejecting */
212 IDETAPE_FLAG_MEDIUM_PRESENT = (1 << 6),
216 * Most of our global data which we need to save even as we leave the driver due
217 * to an interrupt or a timer event is stored in the struct defined below.
219 typedef struct ide_tape_obj {
221 ide_driver_t *driver;
222 struct gendisk *disk;
226 * Since a typical character device operation requires more
227 * than one packet command, we provide here enough memory
228 * for the maximum of interconnected packet commands.
229 * The packet commands are stored in the circular array pc_stack.
230 * pc_stack_index points to the last used entry, and warps around
231 * to the start when we get to the last array entry.
233 * pc points to the current processed packet command.
235 * failed_pc points to the last failed packet command, or contains
236 * NULL if we do not need to retry any packet command. This is
237 * required since an additional packet command is needed before the
238 * retry, to get detailed information on what went wrong.
240 /* Current packet command */
241 struct ide_atapi_pc *pc;
242 /* Last failed packet command */
243 struct ide_atapi_pc *failed_pc;
244 /* Packet command stack */
245 struct ide_atapi_pc pc_stack[IDETAPE_PC_STACK];
246 /* Next free packet command storage space */
248 struct request rq_stack[IDETAPE_PC_STACK];
249 /* We implement a circular array */
253 * DSC polling variables.
255 * While polling for DSC we use postponed_rq to postpone the current
256 * request so that ide.c will be able to service pending requests on the
257 * other device. Note that at most we will have only one DSC (usually
258 * data transfer) request in the device request queue.
260 struct request *postponed_rq;
261 /* The time in which we started polling for DSC */
262 unsigned long dsc_polling_start;
263 /* Timer used to poll for dsc */
264 struct timer_list dsc_timer;
265 /* Read/Write dsc polling frequency */
266 unsigned long best_dsc_rw_freq;
267 unsigned long dsc_poll_freq;
268 unsigned long dsc_timeout;
270 /* Read position information */
273 unsigned int first_frame;
275 /* Last error information */
276 u8 sense_key, asc, ascq;
278 /* Character device operation */
282 /* Current character device data transfer direction */
285 /* tape block size, usually 512 or 1024 bytes */
286 unsigned short blk_size;
289 /* Copy of the tape's Capabilities and Mechanical Page */
293 * Active data transfer request parameters.
295 * At most, there is only one ide-tape originated data transfer request
296 * in the device request queue. This allows ide.c to easily service
297 * requests from the other device when we postpone our active request.
300 /* Data buffer size chosen based on the tape's recommendation */
303 struct idetape_bh *merge_bh;
304 /* size of the merge buffer */
306 /* pointer to current buffer head within the merge buffer */
307 struct idetape_bh *bh;
311 int pages_per_buffer;
312 /* Wasted space in each stage */
315 /* Status/Action flags: long for set_bit */
317 /* protects the ide-tape queue */
320 /* Measures average tape speed */
321 unsigned long avg_time;
325 /* the door is currently locked */
327 /* the tape hardware is write protected */
329 /* the tape is write protected (hardware or opened as read-only) */
335 static DEFINE_MUTEX(idetape_ref_mutex);
337 static struct class *idetape_sysfs_class;
339 #define to_ide_tape(obj) container_of(obj, struct ide_tape_obj, kref)
341 #define ide_tape_g(disk) \
342 container_of((disk)->private_data, struct ide_tape_obj, driver)
344 static struct ide_tape_obj *ide_tape_get(struct gendisk *disk)
346 struct ide_tape_obj *tape = NULL;
348 mutex_lock(&idetape_ref_mutex);
349 tape = ide_tape_g(disk);
351 kref_get(&tape->kref);
352 mutex_unlock(&idetape_ref_mutex);
356 static void ide_tape_release(struct kref *);
358 static void ide_tape_put(struct ide_tape_obj *tape)
360 mutex_lock(&idetape_ref_mutex);
361 kref_put(&tape->kref, ide_tape_release);
362 mutex_unlock(&idetape_ref_mutex);
366 * The variables below are used for the character device interface. Additional
367 * state variables are defined in our ide_drive_t structure.
369 static struct ide_tape_obj *idetape_devs[MAX_HWIFS * MAX_DRIVES];
371 #define ide_tape_f(file) ((file)->private_data)
373 static struct ide_tape_obj *ide_tape_chrdev_get(unsigned int i)
375 struct ide_tape_obj *tape = NULL;
377 mutex_lock(&idetape_ref_mutex);
378 tape = idetape_devs[i];
380 kref_get(&tape->kref);
381 mutex_unlock(&idetape_ref_mutex);
385 static void idetape_input_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
388 struct idetape_bh *bh = pc->bh;
393 printk(KERN_ERR "ide-tape: bh == NULL in "
394 "idetape_input_buffers\n");
395 ide_pad_transfer(drive, 0, bcount);
399 (unsigned int)(bh->b_size - atomic_read(&bh->b_count)),
401 drive->hwif->input_data(drive, NULL, bh->b_data +
402 atomic_read(&bh->b_count), count);
404 atomic_add(count, &bh->b_count);
405 if (atomic_read(&bh->b_count) == bh->b_size) {
408 atomic_set(&bh->b_count, 0);
414 static void idetape_output_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
417 struct idetape_bh *bh = pc->bh;
422 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
426 count = min((unsigned int)pc->b_count, (unsigned int)bcount);
427 drive->hwif->output_data(drive, NULL, pc->b_data, count);
430 pc->b_count -= count;
435 pc->b_data = bh->b_data;
436 pc->b_count = atomic_read(&bh->b_count);
442 static void idetape_update_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc)
444 struct idetape_bh *bh = pc->bh;
446 unsigned int bcount = pc->xferred;
448 if (pc->flags & PC_FLAG_WRITING)
452 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
456 count = min((unsigned int)bh->b_size, (unsigned int)bcount);
457 atomic_set(&bh->b_count, count);
458 if (atomic_read(&bh->b_count) == bh->b_size)
466 * idetape_next_pc_storage returns a pointer to a place in which we can
467 * safely store a packet command, even though we intend to leave the
468 * driver. A storage space for a maximum of IDETAPE_PC_STACK packet
469 * commands is allocated at initialization time.
471 static struct ide_atapi_pc *idetape_next_pc_storage(ide_drive_t *drive)
473 idetape_tape_t *tape = drive->driver_data;
475 debug_log(DBG_PCRQ_STACK, "pc_stack_index=%d\n", tape->pc_stack_index);
477 if (tape->pc_stack_index == IDETAPE_PC_STACK)
478 tape->pc_stack_index = 0;
479 return (&tape->pc_stack[tape->pc_stack_index++]);
483 * idetape_next_rq_storage is used along with idetape_next_pc_storage.
484 * Since we queue packet commands in the request queue, we need to
485 * allocate a request, along with the allocation of a packet command.
488 /**************************************************************
490 * This should get fixed to use kmalloc(.., GFP_ATOMIC) *
491 * followed later on by kfree(). -ml *
493 **************************************************************/
495 static struct request *idetape_next_rq_storage(ide_drive_t *drive)
497 idetape_tape_t *tape = drive->driver_data;
499 debug_log(DBG_PCRQ_STACK, "rq_stack_index=%d\n", tape->rq_stack_index);
501 if (tape->rq_stack_index == IDETAPE_PC_STACK)
502 tape->rq_stack_index = 0;
503 return (&tape->rq_stack[tape->rq_stack_index++]);
507 * called on each failed packet command retry to analyze the request sense. We
508 * currently do not utilize this information.
510 static void idetape_analyze_error(ide_drive_t *drive, u8 *sense)
512 idetape_tape_t *tape = drive->driver_data;
513 struct ide_atapi_pc *pc = tape->failed_pc;
515 tape->sense_key = sense[2] & 0xF;
516 tape->asc = sense[12];
517 tape->ascq = sense[13];
519 debug_log(DBG_ERR, "pc = %x, sense key = %x, asc = %x, ascq = %x\n",
520 pc->c[0], tape->sense_key, tape->asc, tape->ascq);
522 /* Correct pc->xferred by asking the tape. */
523 if (pc->flags & PC_FLAG_DMA_ERROR) {
524 pc->xferred = pc->req_xfer -
526 get_unaligned_be32(&sense[3]);
527 idetape_update_buffers(drive, pc);
531 * If error was the result of a zero-length read or write command,
532 * with sense key=5, asc=0x22, ascq=0, let it slide. Some drives
533 * (i.e. Seagate STT3401A Travan) don't support 0-length read/writes.
535 if ((pc->c[0] == READ_6 || pc->c[0] == WRITE_6)
537 && pc->c[4] == 0 && pc->c[3] == 0 && pc->c[2] == 0) {
538 if (tape->sense_key == 5) {
539 /* don't report an error, everything's ok */
541 /* don't retry read/write */
542 pc->flags |= PC_FLAG_ABORT;
545 if (pc->c[0] == READ_6 && (sense[2] & 0x80)) {
546 pc->error = IDETAPE_ERROR_FILEMARK;
547 pc->flags |= PC_FLAG_ABORT;
549 if (pc->c[0] == WRITE_6) {
550 if ((sense[2] & 0x40) || (tape->sense_key == 0xd
551 && tape->asc == 0x0 && tape->ascq == 0x2)) {
552 pc->error = IDETAPE_ERROR_EOD;
553 pc->flags |= PC_FLAG_ABORT;
556 if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
557 if (tape->sense_key == 8) {
558 pc->error = IDETAPE_ERROR_EOD;
559 pc->flags |= PC_FLAG_ABORT;
561 if (!(pc->flags & PC_FLAG_ABORT) &&
563 pc->retries = IDETAPE_MAX_PC_RETRIES + 1;
567 /* Free data buffers completely. */
568 static void ide_tape_kfree_buffer(idetape_tape_t *tape)
570 struct idetape_bh *prev_bh, *bh = tape->merge_bh;
573 u32 size = bh->b_size;
576 unsigned int order = fls(size >> PAGE_SHIFT)-1;
579 free_pages((unsigned long)bh->b_data, order);
582 bh->b_data += (1 << order) * PAGE_SIZE;
588 kfree(tape->merge_bh);
591 static int idetape_end_request(ide_drive_t *drive, int uptodate, int nr_sects)
593 struct request *rq = HWGROUP(drive)->rq;
594 idetape_tape_t *tape = drive->driver_data;
598 debug_log(DBG_PROCS, "Enter %s\n", __func__);
601 case 0: error = IDETAPE_ERROR_GENERAL; break;
602 case 1: error = 0; break;
603 default: error = uptodate;
607 tape->failed_pc = NULL;
609 if (!blk_special_request(rq)) {
610 ide_end_request(drive, uptodate, nr_sects);
614 spin_lock_irqsave(&tape->lock, flags);
616 ide_end_drive_cmd(drive, 0, 0);
618 spin_unlock_irqrestore(&tape->lock, flags);
622 static void ide_tape_callback(ide_drive_t *drive)
624 idetape_tape_t *tape = drive->driver_data;
625 struct ide_atapi_pc *pc = tape->pc;
626 int uptodate = pc->error ? 0 : 1;
628 debug_log(DBG_PROCS, "Enter %s\n", __func__);
630 if (tape->failed_pc == pc)
631 tape->failed_pc = NULL;
633 if (pc->c[0] == REQUEST_SENSE) {
635 idetape_analyze_error(drive, pc->buf);
637 printk(KERN_ERR "ide-tape: Error in REQUEST SENSE "
638 "itself - Aborting request!\n");
639 } else if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
640 struct request *rq = drive->hwif->hwgroup->rq;
641 int blocks = pc->xferred / tape->blk_size;
643 tape->avg_size += blocks * tape->blk_size;
645 if (time_after_eq(jiffies, tape->avg_time + HZ)) {
646 tape->avg_speed = tape->avg_size * HZ /
647 (jiffies - tape->avg_time) / 1024;
649 tape->avg_time = jiffies;
652 tape->first_frame += blocks;
653 rq->current_nr_sectors -= blocks;
656 uptodate = pc->error;
657 } else if (pc->c[0] == READ_POSITION && uptodate) {
658 u8 *readpos = tape->pc->buf;
660 debug_log(DBG_SENSE, "BOP - %s\n",
661 (readpos[0] & 0x80) ? "Yes" : "No");
662 debug_log(DBG_SENSE, "EOP - %s\n",
663 (readpos[0] & 0x40) ? "Yes" : "No");
665 if (readpos[0] & 0x4) {
666 printk(KERN_INFO "ide-tape: Block location is unknown"
668 clear_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags);
671 debug_log(DBG_SENSE, "Block Location - %u\n",
672 be32_to_cpu(*(u32 *)&readpos[4]));
674 tape->partition = readpos[1];
675 tape->first_frame = be32_to_cpu(*(u32 *)&readpos[4]);
676 set_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags);
680 idetape_end_request(drive, uptodate, 0);
683 static void idetape_init_pc(struct ide_atapi_pc *pc)
685 memset(pc->c, 0, 12);
689 pc->buf = pc->pc_buf;
690 pc->buf_size = IDETAPE_PC_BUFFER_SIZE;
693 pc->callback = ide_tape_callback;
696 static void idetape_create_request_sense_cmd(struct ide_atapi_pc *pc)
699 pc->c[0] = REQUEST_SENSE;
704 static void idetape_init_rq(struct request *rq, u8 cmd)
706 blk_rq_init(NULL, rq);
707 rq->cmd_type = REQ_TYPE_SPECIAL;
712 * Generate a new packet command request in front of the request queue, before
713 * the current request, so that it will be processed immediately, on the next
714 * pass through the driver. The function below is called from the request
715 * handling part of the driver (the "bottom" part). Safe storage for the request
716 * should be allocated with ide_tape_next_{pc,rq}_storage() prior to that.
718 * Memory for those requests is pre-allocated at initialization time, and is
719 * limited to IDETAPE_PC_STACK requests. We assume that we have enough space for
720 * the maximum possible number of inter-dependent packet commands.
722 * The higher level of the driver - The ioctl handler and the character device
723 * handling functions should queue request to the lower level part and wait for
724 * their completion using idetape_queue_pc_tail or idetape_queue_rw_tail.
726 static void idetape_queue_pc_head(ide_drive_t *drive, struct ide_atapi_pc *pc,
729 struct ide_tape_obj *tape = drive->driver_data;
731 idetape_init_rq(rq, REQ_IDETAPE_PC1);
732 rq->cmd_flags |= REQ_PREEMPT;
733 rq->buffer = (char *) pc;
734 rq->rq_disk = tape->disk;
735 ide_do_drive_cmd(drive, rq);
739 * idetape_retry_pc is called when an error was detected during the
740 * last packet command. We queue a request sense packet command in
741 * the head of the request list.
743 static void idetape_retry_pc(ide_drive_t *drive)
745 idetape_tape_t *tape = drive->driver_data;
746 struct ide_atapi_pc *pc;
749 (void)ide_read_error(drive);
750 pc = idetape_next_pc_storage(drive);
751 rq = idetape_next_rq_storage(drive);
752 idetape_create_request_sense_cmd(pc);
753 set_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags);
754 idetape_queue_pc_head(drive, pc, rq);
758 * Postpone the current request so that ide.c will be able to service requests
759 * from another device on the same hwgroup while we are polling for DSC.
761 static void idetape_postpone_request(ide_drive_t *drive)
763 idetape_tape_t *tape = drive->driver_data;
765 debug_log(DBG_PROCS, "Enter %s\n", __func__);
767 tape->postponed_rq = HWGROUP(drive)->rq;
768 ide_stall_queue(drive, tape->dsc_poll_freq);
771 static void ide_tape_handle_dsc(ide_drive_t *drive)
773 idetape_tape_t *tape = drive->driver_data;
775 /* Media access command */
776 tape->dsc_polling_start = jiffies;
777 tape->dsc_poll_freq = IDETAPE_DSC_MA_FAST;
778 tape->dsc_timeout = jiffies + IDETAPE_DSC_MA_TIMEOUT;
779 /* Allow ide.c to handle other requests */
780 idetape_postpone_request(drive);
783 static void ide_tape_io_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
784 unsigned int bcount, int write)
787 idetape_output_buffers(drive, pc, bcount);
789 idetape_input_buffers(drive, pc, bcount);
793 * This is the usual interrupt handler which will be called during a packet
794 * command. We will transfer some of the data (as requested by the drive) and
795 * will re-point interrupt handler to us. When data transfer is finished, we
796 * will act according to the algorithm described before
799 static ide_startstop_t idetape_pc_intr(ide_drive_t *drive)
801 idetape_tape_t *tape = drive->driver_data;
803 return ide_pc_intr(drive, tape->pc, idetape_pc_intr, IDETAPE_WAIT_CMD,
804 NULL, idetape_update_buffers, idetape_retry_pc,
805 ide_tape_handle_dsc, ide_tape_io_buffers);
809 * Packet Command Interface
811 * The current Packet Command is available in tape->pc, and will not change
812 * until we finish handling it. Each packet command is associated with a
813 * callback function that will be called when the command is finished.
815 * The handling will be done in three stages:
817 * 1. idetape_issue_pc will send the packet command to the drive, and will set
818 * the interrupt handler to idetape_pc_intr.
820 * 2. On each interrupt, idetape_pc_intr will be called. This step will be
821 * repeated until the device signals us that no more interrupts will be issued.
823 * 3. ATAPI Tape media access commands have immediate status with a delayed
824 * process. In case of a successful initiation of a media access packet command,
825 * the DSC bit will be set when the actual execution of the command is finished.
826 * Since the tape drive will not issue an interrupt, we have to poll for this
827 * event. In this case, we define the request as "low priority request" by
828 * setting rq_status to IDETAPE_RQ_POSTPONED, set a timer to poll for DSC and
831 * ide.c will then give higher priority to requests which originate from the
832 * other device, until will change rq_status to RQ_ACTIVE.
834 * 4. When the packet command is finished, it will be checked for errors.
836 * 5. In case an error was found, we queue a request sense packet command in
837 * front of the request queue and retry the operation up to
838 * IDETAPE_MAX_PC_RETRIES times.
840 * 6. In case no error was found, or we decided to give up and not to retry
841 * again, the callback function will be called and then we will handle the next
844 static ide_startstop_t idetape_transfer_pc(ide_drive_t *drive)
846 idetape_tape_t *tape = drive->driver_data;
848 return ide_transfer_pc(drive, tape->pc, idetape_pc_intr,
849 IDETAPE_WAIT_CMD, NULL);
852 static ide_startstop_t idetape_issue_pc(ide_drive_t *drive,
853 struct ide_atapi_pc *pc)
855 idetape_tape_t *tape = drive->driver_data;
857 if (tape->pc->c[0] == REQUEST_SENSE &&
858 pc->c[0] == REQUEST_SENSE) {
859 printk(KERN_ERR "ide-tape: possible ide-tape.c bug - "
860 "Two request sense in serial were issued\n");
863 if (tape->failed_pc == NULL && pc->c[0] != REQUEST_SENSE)
864 tape->failed_pc = pc;
865 /* Set the current packet command */
868 if (pc->retries > IDETAPE_MAX_PC_RETRIES ||
869 (pc->flags & PC_FLAG_ABORT)) {
871 * We will "abort" retrying a packet command in case legitimate
872 * error code was received (crossing a filemark, or end of the
873 * media, for example).
875 if (!(pc->flags & PC_FLAG_ABORT)) {
876 if (!(pc->c[0] == TEST_UNIT_READY &&
877 tape->sense_key == 2 && tape->asc == 4 &&
878 (tape->ascq == 1 || tape->ascq == 8))) {
879 printk(KERN_ERR "ide-tape: %s: I/O error, "
880 "pc = %2x, key = %2x, "
881 "asc = %2x, ascq = %2x\n",
882 tape->name, pc->c[0],
883 tape->sense_key, tape->asc,
887 pc->error = IDETAPE_ERROR_GENERAL;
889 tape->failed_pc = NULL;
893 debug_log(DBG_SENSE, "Retry #%d, cmd = %02X\n", pc->retries, pc->c[0]);
897 return ide_issue_pc(drive, pc, idetape_transfer_pc,
898 IDETAPE_WAIT_CMD, NULL);
901 /* A mode sense command is used to "sense" tape parameters. */
902 static void idetape_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
905 pc->c[0] = MODE_SENSE;
906 if (page_code != IDETAPE_BLOCK_DESCRIPTOR)
907 /* DBD = 1 - Don't return block descriptors */
909 pc->c[2] = page_code;
911 * Changed pc->c[3] to 0 (255 will at best return unused info).
913 * For SCSI this byte is defined as subpage instead of high byte
914 * of length and some IDE drives seem to interpret it this way
915 * and return an error when 255 is used.
918 /* We will just discard data in that case */
920 if (page_code == IDETAPE_BLOCK_DESCRIPTOR)
922 else if (page_code == IDETAPE_CAPABILITIES_PAGE)
928 static ide_startstop_t idetape_media_access_finished(ide_drive_t *drive)
930 ide_hwif_t *hwif = drive->hwif;
931 idetape_tape_t *tape = drive->driver_data;
932 struct ide_atapi_pc *pc = tape->pc;
935 stat = hwif->read_status(hwif);
937 if (stat & SEEK_STAT) {
938 if (stat & ERR_STAT) {
940 if (pc->c[0] != TEST_UNIT_READY)
941 printk(KERN_ERR "ide-tape: %s: I/O error, ",
943 /* Retry operation */
944 idetape_retry_pc(drive);
949 pc->error = IDETAPE_ERROR_GENERAL;
950 tape->failed_pc = NULL;
956 static void ide_tape_create_rw_cmd(idetape_tape_t *tape,
957 struct ide_atapi_pc *pc, unsigned int length,
958 struct idetape_bh *bh, u8 opcode)
961 put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
965 pc->buf_size = length * tape->blk_size;
966 pc->req_xfer = pc->buf_size;
967 if (pc->req_xfer == tape->buffer_size)
968 pc->flags |= PC_FLAG_DMA_OK;
970 if (opcode == READ_6) {
972 atomic_set(&bh->b_count, 0);
973 } else if (opcode == WRITE_6) {
975 pc->flags |= PC_FLAG_WRITING;
976 pc->b_data = bh->b_data;
977 pc->b_count = atomic_read(&bh->b_count);
981 static ide_startstop_t idetape_do_request(ide_drive_t *drive,
982 struct request *rq, sector_t block)
984 ide_hwif_t *hwif = drive->hwif;
985 idetape_tape_t *tape = drive->driver_data;
986 struct ide_atapi_pc *pc = NULL;
987 struct request *postponed_rq = tape->postponed_rq;
990 debug_log(DBG_SENSE, "sector: %ld, nr_sectors: %ld,"
991 " current_nr_sectors: %d\n",
992 rq->sector, rq->nr_sectors, rq->current_nr_sectors);
994 if (!blk_special_request(rq)) {
995 /* We do not support buffer cache originated requests. */
996 printk(KERN_NOTICE "ide-tape: %s: Unsupported request in "
997 "request queue (%d)\n", drive->name, rq->cmd_type);
998 ide_end_request(drive, 0, 0);
1002 /* Retry a failed packet command */
1003 if (tape->failed_pc && tape->pc->c[0] == REQUEST_SENSE) {
1004 pc = tape->failed_pc;
1008 if (postponed_rq != NULL)
1009 if (rq != postponed_rq) {
1010 printk(KERN_ERR "ide-tape: ide-tape.c bug - "
1011 "Two DSC requests were queued\n");
1012 idetape_end_request(drive, 0, 0);
1016 tape->postponed_rq = NULL;
1019 * If the tape is still busy, postpone our request and service
1020 * the other device meanwhile.
1022 stat = hwif->read_status(hwif);
1024 if (!drive->dsc_overlap && !(rq->cmd[0] & REQ_IDETAPE_PC2))
1025 set_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags);
1027 if (drive->post_reset == 1) {
1028 set_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags);
1029 drive->post_reset = 0;
1032 if (!test_and_clear_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags) &&
1033 (stat & SEEK_STAT) == 0) {
1034 if (postponed_rq == NULL) {
1035 tape->dsc_polling_start = jiffies;
1036 tape->dsc_poll_freq = tape->best_dsc_rw_freq;
1037 tape->dsc_timeout = jiffies + IDETAPE_DSC_RW_TIMEOUT;
1038 } else if (time_after(jiffies, tape->dsc_timeout)) {
1039 printk(KERN_ERR "ide-tape: %s: DSC timeout\n",
1041 if (rq->cmd[0] & REQ_IDETAPE_PC2) {
1042 idetape_media_access_finished(drive);
1045 return ide_do_reset(drive);
1047 } else if (time_after(jiffies,
1048 tape->dsc_polling_start +
1049 IDETAPE_DSC_MA_THRESHOLD))
1050 tape->dsc_poll_freq = IDETAPE_DSC_MA_SLOW;
1051 idetape_postpone_request(drive);
1054 if (rq->cmd[0] & REQ_IDETAPE_READ) {
1055 pc = idetape_next_pc_storage(drive);
1056 ide_tape_create_rw_cmd(tape, pc, rq->current_nr_sectors,
1057 (struct idetape_bh *)rq->special,
1061 if (rq->cmd[0] & REQ_IDETAPE_WRITE) {
1062 pc = idetape_next_pc_storage(drive);
1063 ide_tape_create_rw_cmd(tape, pc, rq->current_nr_sectors,
1064 (struct idetape_bh *)rq->special,
1068 if (rq->cmd[0] & REQ_IDETAPE_PC1) {
1069 pc = (struct ide_atapi_pc *) rq->buffer;
1070 rq->cmd[0] &= ~(REQ_IDETAPE_PC1);
1071 rq->cmd[0] |= REQ_IDETAPE_PC2;
1074 if (rq->cmd[0] & REQ_IDETAPE_PC2) {
1075 idetape_media_access_finished(drive);
1080 if (test_bit(IDETAPE_FLAG_DRQ_INTERRUPT, &tape->flags))
1081 pc->flags |= PC_FLAG_DRQ_INTERRUPT;
1083 return idetape_issue_pc(drive, pc);
1087 * The function below uses __get_free_pages to allocate a data buffer of size
1088 * tape->buffer_size (or a bit more). We attempt to combine sequential pages as
1091 * It returns a pointer to the newly allocated buffer, or NULL in case of
1094 static struct idetape_bh *ide_tape_kmalloc_buffer(idetape_tape_t *tape,
1095 int full, int clear)
1097 struct idetape_bh *prev_bh, *bh, *merge_bh;
1098 int pages = tape->pages_per_buffer;
1099 unsigned int order, b_allocd;
1100 char *b_data = NULL;
1102 merge_bh = kmalloc(sizeof(struct idetape_bh), GFP_KERNEL);
1107 order = fls(pages) - 1;
1108 bh->b_data = (char *) __get_free_pages(GFP_KERNEL, order);
1111 b_allocd = (1 << order) * PAGE_SIZE;
1115 memset(bh->b_data, 0, b_allocd);
1116 bh->b_reqnext = NULL;
1117 bh->b_size = b_allocd;
1118 atomic_set(&bh->b_count, full ? bh->b_size : 0);
1121 order = fls(pages) - 1;
1122 b_data = (char *) __get_free_pages(GFP_KERNEL, order);
1125 b_allocd = (1 << order) * PAGE_SIZE;
1128 memset(b_data, 0, b_allocd);
1130 /* newly allocated page frames below buffer header or ...*/
1131 if (bh->b_data == b_data + b_allocd) {
1132 bh->b_size += b_allocd;
1133 bh->b_data -= b_allocd;
1135 atomic_add(b_allocd, &bh->b_count);
1138 /* they are above the header */
1139 if (b_data == bh->b_data + bh->b_size) {
1140 bh->b_size += b_allocd;
1142 atomic_add(b_allocd, &bh->b_count);
1146 bh = kmalloc(sizeof(struct idetape_bh), GFP_KERNEL);
1148 free_pages((unsigned long) b_data, order);
1151 bh->b_reqnext = NULL;
1152 bh->b_data = b_data;
1153 bh->b_size = b_allocd;
1154 atomic_set(&bh->b_count, full ? bh->b_size : 0);
1155 prev_bh->b_reqnext = bh;
1160 bh->b_size -= tape->excess_bh_size;
1162 atomic_sub(tape->excess_bh_size, &bh->b_count);
1165 ide_tape_kfree_buffer(tape);
1169 static int idetape_copy_stage_from_user(idetape_tape_t *tape,
1170 const char __user *buf, int n)
1172 struct idetape_bh *bh = tape->bh;
1178 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
1182 count = min((unsigned int)
1183 (bh->b_size - atomic_read(&bh->b_count)),
1185 if (copy_from_user(bh->b_data + atomic_read(&bh->b_count), buf,
1189 atomic_add(count, &bh->b_count);
1191 if (atomic_read(&bh->b_count) == bh->b_size) {
1194 atomic_set(&bh->b_count, 0);
1201 static int idetape_copy_stage_to_user(idetape_tape_t *tape, char __user *buf,
1204 struct idetape_bh *bh = tape->bh;
1210 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
1214 count = min(tape->b_count, n);
1215 if (copy_to_user(buf, tape->b_data, count))
1218 tape->b_data += count;
1219 tape->b_count -= count;
1221 if (!tape->b_count) {
1225 tape->b_data = bh->b_data;
1226 tape->b_count = atomic_read(&bh->b_count);
1233 static void idetape_init_merge_buffer(idetape_tape_t *tape)
1235 struct idetape_bh *bh = tape->merge_bh;
1236 tape->bh = tape->merge_bh;
1238 if (tape->chrdev_dir == IDETAPE_DIR_WRITE)
1239 atomic_set(&bh->b_count, 0);
1241 tape->b_data = bh->b_data;
1242 tape->b_count = atomic_read(&bh->b_count);
1247 * Write a filemark if write_filemark=1. Flush the device buffers without
1248 * writing a filemark otherwise.
1250 static void idetape_create_write_filemark_cmd(ide_drive_t *drive,
1251 struct ide_atapi_pc *pc, int write_filemark)
1253 idetape_init_pc(pc);
1254 pc->c[0] = WRITE_FILEMARKS;
1255 pc->c[4] = write_filemark;
1256 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1259 static void idetape_create_test_unit_ready_cmd(struct ide_atapi_pc *pc)
1261 idetape_init_pc(pc);
1262 pc->c[0] = TEST_UNIT_READY;
1266 * We add a special packet command request to the tail of the request queue, and
1267 * wait for it to be serviced. This is not to be called from within the request
1268 * handling part of the driver! We allocate here data on the stack and it is
1269 * valid until the request is finished. This is not the case for the bottom part
1270 * of the driver, where we are always leaving the functions to wait for an
1271 * interrupt or a timer event.
1273 * From the bottom part of the driver, we should allocate safe memory using
1274 * idetape_next_pc_storage() and ide_tape_next_rq_storage(), and add the request
1275 * to the request list without waiting for it to be serviced! In that case, we
1276 * usually use idetape_queue_pc_head().
1278 static int idetape_queue_pc_tail(ide_drive_t *drive, struct ide_atapi_pc *pc)
1280 struct ide_tape_obj *tape = drive->driver_data;
1284 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
1285 rq->cmd_type = REQ_TYPE_SPECIAL;
1286 rq->cmd[0] = REQ_IDETAPE_PC1;
1287 rq->buffer = (char *)pc;
1288 error = blk_execute_rq(drive->queue, tape->disk, rq, 0);
1289 blk_put_request(rq);
1293 static void idetape_create_load_unload_cmd(ide_drive_t *drive,
1294 struct ide_atapi_pc *pc, int cmd)
1296 idetape_init_pc(pc);
1297 pc->c[0] = START_STOP;
1299 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1302 static int idetape_wait_ready(ide_drive_t *drive, unsigned long timeout)
1304 idetape_tape_t *tape = drive->driver_data;
1305 struct ide_atapi_pc pc;
1306 int load_attempted = 0;
1308 /* Wait for the tape to become ready */
1309 set_bit(IDETAPE_FLAG_MEDIUM_PRESENT, &tape->flags);
1311 while (time_before(jiffies, timeout)) {
1312 idetape_create_test_unit_ready_cmd(&pc);
1313 if (!idetape_queue_pc_tail(drive, &pc))
1315 if ((tape->sense_key == 2 && tape->asc == 4 && tape->ascq == 2)
1316 || (tape->asc == 0x3A)) {
1320 idetape_create_load_unload_cmd(drive, &pc,
1321 IDETAPE_LU_LOAD_MASK);
1322 idetape_queue_pc_tail(drive, &pc);
1324 /* not about to be ready */
1325 } else if (!(tape->sense_key == 2 && tape->asc == 4 &&
1326 (tape->ascq == 1 || tape->ascq == 8)))
1333 static int idetape_flush_tape_buffers(ide_drive_t *drive)
1335 struct ide_atapi_pc pc;
1338 idetape_create_write_filemark_cmd(drive, &pc, 0);
1339 rc = idetape_queue_pc_tail(drive, &pc);
1342 idetape_wait_ready(drive, 60 * 5 * HZ);
1346 static void idetape_create_read_position_cmd(struct ide_atapi_pc *pc)
1348 idetape_init_pc(pc);
1349 pc->c[0] = READ_POSITION;
1353 static int idetape_read_position(ide_drive_t *drive)
1355 idetape_tape_t *tape = drive->driver_data;
1356 struct ide_atapi_pc pc;
1359 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1361 idetape_create_read_position_cmd(&pc);
1362 if (idetape_queue_pc_tail(drive, &pc))
1364 position = tape->first_frame;
1368 static void idetape_create_locate_cmd(ide_drive_t *drive,
1369 struct ide_atapi_pc *pc,
1370 unsigned int block, u8 partition, int skip)
1372 idetape_init_pc(pc);
1373 pc->c[0] = POSITION_TO_ELEMENT;
1375 put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[3]);
1376 pc->c[8] = partition;
1377 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1380 static int idetape_create_prevent_cmd(ide_drive_t *drive,
1381 struct ide_atapi_pc *pc, int prevent)
1383 idetape_tape_t *tape = drive->driver_data;
1385 /* device supports locking according to capabilities page */
1386 if (!(tape->caps[6] & 0x01))
1389 idetape_init_pc(pc);
1390 pc->c[0] = ALLOW_MEDIUM_REMOVAL;
1395 static void __ide_tape_discard_merge_buffer(ide_drive_t *drive)
1397 idetape_tape_t *tape = drive->driver_data;
1399 if (tape->chrdev_dir != IDETAPE_DIR_READ)
1402 clear_bit(IDETAPE_FLAG_FILEMARK, &tape->flags);
1403 tape->merge_bh_size = 0;
1404 if (tape->merge_bh != NULL) {
1405 ide_tape_kfree_buffer(tape);
1406 tape->merge_bh = NULL;
1409 tape->chrdev_dir = IDETAPE_DIR_NONE;
1413 * Position the tape to the requested block using the LOCATE packet command.
1414 * A READ POSITION command is then issued to check where we are positioned. Like
1415 * all higher level operations, we queue the commands at the tail of the request
1416 * queue and wait for their completion.
1418 static int idetape_position_tape(ide_drive_t *drive, unsigned int block,
1419 u8 partition, int skip)
1421 idetape_tape_t *tape = drive->driver_data;
1423 struct ide_atapi_pc pc;
1425 if (tape->chrdev_dir == IDETAPE_DIR_READ)
1426 __ide_tape_discard_merge_buffer(drive);
1427 idetape_wait_ready(drive, 60 * 5 * HZ);
1428 idetape_create_locate_cmd(drive, &pc, block, partition, skip);
1429 retval = idetape_queue_pc_tail(drive, &pc);
1433 idetape_create_read_position_cmd(&pc);
1434 return (idetape_queue_pc_tail(drive, &pc));
1437 static void ide_tape_discard_merge_buffer(ide_drive_t *drive,
1438 int restore_position)
1440 idetape_tape_t *tape = drive->driver_data;
1443 __ide_tape_discard_merge_buffer(drive);
1444 if (restore_position) {
1445 position = idetape_read_position(drive);
1446 seek = position > 0 ? position : 0;
1447 if (idetape_position_tape(drive, seek, 0, 0)) {
1448 printk(KERN_INFO "ide-tape: %s: position_tape failed in"
1449 " %s\n", tape->name, __func__);
1456 * Generate a read/write request for the block device interface and wait for it
1459 static int idetape_queue_rw_tail(ide_drive_t *drive, int cmd, int blocks,
1460 struct idetape_bh *bh)
1462 idetape_tape_t *tape = drive->driver_data;
1466 debug_log(DBG_SENSE, "%s: cmd=%d\n", __func__, cmd);
1468 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
1469 rq->cmd_type = REQ_TYPE_SPECIAL;
1471 rq->rq_disk = tape->disk;
1472 rq->special = (void *)bh;
1473 rq->sector = tape->first_frame;
1474 rq->nr_sectors = blocks;
1475 rq->current_nr_sectors = blocks;
1476 blk_execute_rq(drive->queue, tape->disk, rq, 0);
1478 errors = rq->errors;
1479 ret = tape->blk_size * (blocks - rq->current_nr_sectors);
1480 blk_put_request(rq);
1482 if ((cmd & (REQ_IDETAPE_READ | REQ_IDETAPE_WRITE)) == 0)
1486 idetape_init_merge_buffer(tape);
1487 if (errors == IDETAPE_ERROR_GENERAL)
1492 static void idetape_create_inquiry_cmd(struct ide_atapi_pc *pc)
1494 idetape_init_pc(pc);
1500 static void idetape_create_rewind_cmd(ide_drive_t *drive,
1501 struct ide_atapi_pc *pc)
1503 idetape_init_pc(pc);
1504 pc->c[0] = REZERO_UNIT;
1505 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1508 static void idetape_create_erase_cmd(struct ide_atapi_pc *pc)
1510 idetape_init_pc(pc);
1513 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1516 static void idetape_create_space_cmd(struct ide_atapi_pc *pc, int count, u8 cmd)
1518 idetape_init_pc(pc);
1520 put_unaligned(cpu_to_be32(count), (unsigned int *) &pc->c[1]);
1522 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1525 /* Queue up a character device originated write request. */
1526 static int idetape_add_chrdev_write_request(ide_drive_t *drive, int blocks)
1528 idetape_tape_t *tape = drive->driver_data;
1530 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
1532 return idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE,
1533 blocks, tape->merge_bh);
1536 static void ide_tape_flush_merge_buffer(ide_drive_t *drive)
1538 idetape_tape_t *tape = drive->driver_data;
1540 struct idetape_bh *bh;
1542 if (tape->chrdev_dir != IDETAPE_DIR_WRITE) {
1543 printk(KERN_ERR "ide-tape: bug: Trying to empty merge buffer"
1544 " but we are not writing.\n");
1547 if (tape->merge_bh_size > tape->buffer_size) {
1548 printk(KERN_ERR "ide-tape: bug: merge_buffer too big\n");
1549 tape->merge_bh_size = tape->buffer_size;
1551 if (tape->merge_bh_size) {
1552 blocks = tape->merge_bh_size / tape->blk_size;
1553 if (tape->merge_bh_size % tape->blk_size) {
1557 i = tape->blk_size - tape->merge_bh_size %
1559 bh = tape->bh->b_reqnext;
1561 atomic_set(&bh->b_count, 0);
1567 printk(KERN_INFO "ide-tape: bug,"
1571 min = min(i, (unsigned int)(bh->b_size -
1572 atomic_read(&bh->b_count)));
1573 memset(bh->b_data + atomic_read(&bh->b_count),
1575 atomic_add(min, &bh->b_count);
1580 (void) idetape_add_chrdev_write_request(drive, blocks);
1581 tape->merge_bh_size = 0;
1583 if (tape->merge_bh != NULL) {
1584 ide_tape_kfree_buffer(tape);
1585 tape->merge_bh = NULL;
1587 tape->chrdev_dir = IDETAPE_DIR_NONE;
1590 static int idetape_init_read(ide_drive_t *drive)
1592 idetape_tape_t *tape = drive->driver_data;
1595 /* Initialize read operation */
1596 if (tape->chrdev_dir != IDETAPE_DIR_READ) {
1597 if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
1598 ide_tape_flush_merge_buffer(drive);
1599 idetape_flush_tape_buffers(drive);
1601 if (tape->merge_bh || tape->merge_bh_size) {
1602 printk(KERN_ERR "ide-tape: merge_bh_size should be"
1604 tape->merge_bh_size = 0;
1606 tape->merge_bh = ide_tape_kmalloc_buffer(tape, 0, 0);
1607 if (!tape->merge_bh)
1609 tape->chrdev_dir = IDETAPE_DIR_READ;
1612 * Issue a read 0 command to ensure that DSC handshake is
1613 * switched from completion mode to buffer available mode.
1614 * No point in issuing this if DSC overlap isn't supported, some
1615 * drives (Seagate STT3401A) will return an error.
1617 if (drive->dsc_overlap) {
1618 bytes_read = idetape_queue_rw_tail(drive,
1619 REQ_IDETAPE_READ, 0,
1621 if (bytes_read < 0) {
1622 ide_tape_kfree_buffer(tape);
1623 tape->merge_bh = NULL;
1624 tape->chrdev_dir = IDETAPE_DIR_NONE;
1633 /* called from idetape_chrdev_read() to service a chrdev read request. */
1634 static int idetape_add_chrdev_read_request(ide_drive_t *drive, int blocks)
1636 idetape_tape_t *tape = drive->driver_data;
1638 debug_log(DBG_PROCS, "Enter %s, %d blocks\n", __func__, blocks);
1640 /* If we are at a filemark, return a read length of 0 */
1641 if (test_bit(IDETAPE_FLAG_FILEMARK, &tape->flags))
1644 idetape_init_read(drive);
1646 return idetape_queue_rw_tail(drive, REQ_IDETAPE_READ, blocks,
1650 static void idetape_pad_zeros(ide_drive_t *drive, int bcount)
1652 idetape_tape_t *tape = drive->driver_data;
1653 struct idetape_bh *bh;
1659 bh = tape->merge_bh;
1660 count = min(tape->buffer_size, bcount);
1662 blocks = count / tape->blk_size;
1664 atomic_set(&bh->b_count,
1665 min(count, (unsigned int)bh->b_size));
1666 memset(bh->b_data, 0, atomic_read(&bh->b_count));
1667 count -= atomic_read(&bh->b_count);
1670 idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE, blocks,
1676 * Rewinds the tape to the Beginning Of the current Partition (BOP). We
1677 * currently support only one partition.
1679 static int idetape_rewind_tape(ide_drive_t *drive)
1682 struct ide_atapi_pc pc;
1683 idetape_tape_t *tape;
1684 tape = drive->driver_data;
1686 debug_log(DBG_SENSE, "Enter %s\n", __func__);
1688 idetape_create_rewind_cmd(drive, &pc);
1689 retval = idetape_queue_pc_tail(drive, &pc);
1693 idetape_create_read_position_cmd(&pc);
1694 retval = idetape_queue_pc_tail(drive, &pc);
1700 /* mtio.h compatible commands should be issued to the chrdev interface. */
1701 static int idetape_blkdev_ioctl(ide_drive_t *drive, unsigned int cmd,
1704 idetape_tape_t *tape = drive->driver_data;
1705 void __user *argp = (void __user *)arg;
1707 struct idetape_config {
1708 int dsc_rw_frequency;
1709 int dsc_media_access_frequency;
1713 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1717 if (copy_from_user(&config, argp, sizeof(config)))
1719 tape->best_dsc_rw_freq = config.dsc_rw_frequency;
1722 config.dsc_rw_frequency = (int) tape->best_dsc_rw_freq;
1723 config.nr_stages = 1;
1724 if (copy_to_user(argp, &config, sizeof(config)))
1733 static int idetape_space_over_filemarks(ide_drive_t *drive, short mt_op,
1736 idetape_tape_t *tape = drive->driver_data;
1737 struct ide_atapi_pc pc;
1738 int retval, count = 0;
1739 int sprev = !!(tape->caps[4] & 0x20);
1743 if (MTBSF == mt_op || MTBSFM == mt_op) {
1746 mt_count = -mt_count;
1749 if (tape->chrdev_dir == IDETAPE_DIR_READ) {
1750 tape->merge_bh_size = 0;
1751 if (test_and_clear_bit(IDETAPE_FLAG_FILEMARK, &tape->flags))
1753 ide_tape_discard_merge_buffer(drive, 0);
1759 idetape_create_space_cmd(&pc, mt_count - count,
1760 IDETAPE_SPACE_OVER_FILEMARK);
1761 return idetape_queue_pc_tail(drive, &pc);
1766 retval = idetape_space_over_filemarks(drive, MTFSF,
1770 count = (MTBSFM == mt_op ? 1 : -1);
1771 return idetape_space_over_filemarks(drive, MTFSF, count);
1773 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
1780 * Our character device read / write functions.
1782 * The tape is optimized to maximize throughput when it is transferring an
1783 * integral number of the "continuous transfer limit", which is a parameter of
1784 * the specific tape (26kB on my particular tape, 32kB for Onstream).
1786 * As of version 1.3 of the driver, the character device provides an abstract
1787 * continuous view of the media - any mix of block sizes (even 1 byte) on the
1788 * same backup/restore procedure is supported. The driver will internally
1789 * convert the requests to the recommended transfer unit, so that an unmatch
1790 * between the user's block size to the recommended size will only result in a
1791 * (slightly) increased driver overhead, but will no longer hit performance.
1792 * This is not applicable to Onstream.
1794 static ssize_t idetape_chrdev_read(struct file *file, char __user *buf,
1795 size_t count, loff_t *ppos)
1797 struct ide_tape_obj *tape = ide_tape_f(file);
1798 ide_drive_t *drive = tape->drive;
1799 ssize_t bytes_read, temp, actually_read = 0, rc;
1801 u16 ctl = *(u16 *)&tape->caps[12];
1803 debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
1805 if (tape->chrdev_dir != IDETAPE_DIR_READ) {
1806 if (test_bit(IDETAPE_FLAG_DETECT_BS, &tape->flags))
1807 if (count > tape->blk_size &&
1808 (count % tape->blk_size) == 0)
1809 tape->user_bs_factor = count / tape->blk_size;
1811 rc = idetape_init_read(drive);
1816 if (tape->merge_bh_size) {
1817 actually_read = min((unsigned int)(tape->merge_bh_size),
1818 (unsigned int)count);
1819 if (idetape_copy_stage_to_user(tape, buf, actually_read))
1821 buf += actually_read;
1822 tape->merge_bh_size -= actually_read;
1823 count -= actually_read;
1825 while (count >= tape->buffer_size) {
1826 bytes_read = idetape_add_chrdev_read_request(drive, ctl);
1827 if (bytes_read <= 0)
1829 if (idetape_copy_stage_to_user(tape, buf, bytes_read))
1832 count -= bytes_read;
1833 actually_read += bytes_read;
1836 bytes_read = idetape_add_chrdev_read_request(drive, ctl);
1837 if (bytes_read <= 0)
1839 temp = min((unsigned long)count, (unsigned long)bytes_read);
1840 if (idetape_copy_stage_to_user(tape, buf, temp))
1842 actually_read += temp;
1843 tape->merge_bh_size = bytes_read-temp;
1846 if (!actually_read && test_bit(IDETAPE_FLAG_FILEMARK, &tape->flags)) {
1847 debug_log(DBG_SENSE, "%s: spacing over filemark\n", tape->name);
1849 idetape_space_over_filemarks(drive, MTFSF, 1);
1853 return ret ? ret : actually_read;
1856 static ssize_t idetape_chrdev_write(struct file *file, const char __user *buf,
1857 size_t count, loff_t *ppos)
1859 struct ide_tape_obj *tape = ide_tape_f(file);
1860 ide_drive_t *drive = tape->drive;
1861 ssize_t actually_written = 0;
1863 u16 ctl = *(u16 *)&tape->caps[12];
1865 /* The drive is write protected. */
1866 if (tape->write_prot)
1869 debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
1871 /* Initialize write operation */
1872 if (tape->chrdev_dir != IDETAPE_DIR_WRITE) {
1873 if (tape->chrdev_dir == IDETAPE_DIR_READ)
1874 ide_tape_discard_merge_buffer(drive, 1);
1875 if (tape->merge_bh || tape->merge_bh_size) {
1876 printk(KERN_ERR "ide-tape: merge_bh_size "
1877 "should be 0 now\n");
1878 tape->merge_bh_size = 0;
1880 tape->merge_bh = ide_tape_kmalloc_buffer(tape, 0, 0);
1881 if (!tape->merge_bh)
1883 tape->chrdev_dir = IDETAPE_DIR_WRITE;
1884 idetape_init_merge_buffer(tape);
1887 * Issue a write 0 command to ensure that DSC handshake is
1888 * switched from completion mode to buffer available mode. No
1889 * point in issuing this if DSC overlap isn't supported, some
1890 * drives (Seagate STT3401A) will return an error.
1892 if (drive->dsc_overlap) {
1893 ssize_t retval = idetape_queue_rw_tail(drive,
1894 REQ_IDETAPE_WRITE, 0,
1897 ide_tape_kfree_buffer(tape);
1898 tape->merge_bh = NULL;
1899 tape->chrdev_dir = IDETAPE_DIR_NONE;
1906 if (tape->merge_bh_size) {
1907 if (tape->merge_bh_size >= tape->buffer_size) {
1908 printk(KERN_ERR "ide-tape: bug: merge buf too big\n");
1909 tape->merge_bh_size = 0;
1911 actually_written = min((unsigned int)
1912 (tape->buffer_size - tape->merge_bh_size),
1913 (unsigned int)count);
1914 if (idetape_copy_stage_from_user(tape, buf, actually_written))
1916 buf += actually_written;
1917 tape->merge_bh_size += actually_written;
1918 count -= actually_written;
1920 if (tape->merge_bh_size == tape->buffer_size) {
1922 tape->merge_bh_size = 0;
1923 retval = idetape_add_chrdev_write_request(drive, ctl);
1928 while (count >= tape->buffer_size) {
1930 if (idetape_copy_stage_from_user(tape, buf, tape->buffer_size))
1932 buf += tape->buffer_size;
1933 count -= tape->buffer_size;
1934 retval = idetape_add_chrdev_write_request(drive, ctl);
1935 actually_written += tape->buffer_size;
1940 actually_written += count;
1941 if (idetape_copy_stage_from_user(tape, buf, count))
1943 tape->merge_bh_size += count;
1945 return ret ? ret : actually_written;
1948 static int idetape_write_filemark(ide_drive_t *drive)
1950 struct ide_atapi_pc pc;
1952 /* Write a filemark */
1953 idetape_create_write_filemark_cmd(drive, &pc, 1);
1954 if (idetape_queue_pc_tail(drive, &pc)) {
1955 printk(KERN_ERR "ide-tape: Couldn't write a filemark\n");
1962 * Called from idetape_chrdev_ioctl when the general mtio MTIOCTOP ioctl is
1965 * Note: MTBSF and MTBSFM are not supported when the tape doesn't support
1966 * spacing over filemarks in the reverse direction. In this case, MTFSFM is also
1967 * usually not supported.
1969 * The following commands are currently not supported:
1971 * MTFSS, MTBSS, MTWSM, MTSETDENSITY, MTSETDRVBUFFER, MT_ST_BOOLEANS,
1972 * MT_ST_WRITE_THRESHOLD.
1974 static int idetape_mtioctop(ide_drive_t *drive, short mt_op, int mt_count)
1976 idetape_tape_t *tape = drive->driver_data;
1977 struct ide_atapi_pc pc;
1980 debug_log(DBG_ERR, "Handling MTIOCTOP ioctl: mt_op=%d, mt_count=%d\n",
1990 return idetape_space_over_filemarks(drive, mt_op, mt_count);
1997 if (tape->write_prot)
1999 ide_tape_discard_merge_buffer(drive, 1);
2000 for (i = 0; i < mt_count; i++) {
2001 retval = idetape_write_filemark(drive);
2007 ide_tape_discard_merge_buffer(drive, 0);
2008 if (idetape_rewind_tape(drive))
2012 ide_tape_discard_merge_buffer(drive, 0);
2013 idetape_create_load_unload_cmd(drive, &pc,
2014 IDETAPE_LU_LOAD_MASK);
2015 return idetape_queue_pc_tail(drive, &pc);
2019 * If door is locked, attempt to unlock before
2020 * attempting to eject.
2022 if (tape->door_locked) {
2023 if (idetape_create_prevent_cmd(drive, &pc, 0))
2024 if (!idetape_queue_pc_tail(drive, &pc))
2025 tape->door_locked = DOOR_UNLOCKED;
2027 ide_tape_discard_merge_buffer(drive, 0);
2028 idetape_create_load_unload_cmd(drive, &pc,
2029 !IDETAPE_LU_LOAD_MASK);
2030 retval = idetape_queue_pc_tail(drive, &pc);
2032 clear_bit(IDETAPE_FLAG_MEDIUM_PRESENT, &tape->flags);
2035 ide_tape_discard_merge_buffer(drive, 0);
2036 return idetape_flush_tape_buffers(drive);
2038 ide_tape_discard_merge_buffer(drive, 0);
2039 idetape_create_load_unload_cmd(drive, &pc,
2040 IDETAPE_LU_RETENSION_MASK | IDETAPE_LU_LOAD_MASK);
2041 return idetape_queue_pc_tail(drive, &pc);
2043 idetape_create_space_cmd(&pc, 0, IDETAPE_SPACE_TO_EOD);
2044 return idetape_queue_pc_tail(drive, &pc);
2046 (void)idetape_rewind_tape(drive);
2047 idetape_create_erase_cmd(&pc);
2048 return idetape_queue_pc_tail(drive, &pc);
2051 if (mt_count < tape->blk_size ||
2052 mt_count % tape->blk_size)
2054 tape->user_bs_factor = mt_count / tape->blk_size;
2055 clear_bit(IDETAPE_FLAG_DETECT_BS, &tape->flags);
2057 set_bit(IDETAPE_FLAG_DETECT_BS, &tape->flags);
2060 ide_tape_discard_merge_buffer(drive, 0);
2061 return idetape_position_tape(drive,
2062 mt_count * tape->user_bs_factor, tape->partition, 0);
2064 ide_tape_discard_merge_buffer(drive, 0);
2065 return idetape_position_tape(drive, 0, mt_count, 0);
2069 if (!idetape_create_prevent_cmd(drive, &pc, 1))
2071 retval = idetape_queue_pc_tail(drive, &pc);
2074 tape->door_locked = DOOR_EXPLICITLY_LOCKED;
2077 if (!idetape_create_prevent_cmd(drive, &pc, 0))
2079 retval = idetape_queue_pc_tail(drive, &pc);
2082 tape->door_locked = DOOR_UNLOCKED;
2085 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
2092 * Our character device ioctls. General mtio.h magnetic io commands are
2093 * supported here, and not in the corresponding block interface. Our own
2094 * ide-tape ioctls are supported on both interfaces.
2096 static int idetape_chrdev_ioctl(struct inode *inode, struct file *file,
2097 unsigned int cmd, unsigned long arg)
2099 struct ide_tape_obj *tape = ide_tape_f(file);
2100 ide_drive_t *drive = tape->drive;
2104 int block_offset = 0, position = tape->first_frame;
2105 void __user *argp = (void __user *)arg;
2107 debug_log(DBG_CHRDEV, "Enter %s, cmd=%u\n", __func__, cmd);
2109 if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
2110 ide_tape_flush_merge_buffer(drive);
2111 idetape_flush_tape_buffers(drive);
2113 if (cmd == MTIOCGET || cmd == MTIOCPOS) {
2114 block_offset = tape->merge_bh_size /
2115 (tape->blk_size * tape->user_bs_factor);
2116 position = idetape_read_position(drive);
2122 if (copy_from_user(&mtop, argp, sizeof(struct mtop)))
2124 return idetape_mtioctop(drive, mtop.mt_op, mtop.mt_count);
2126 memset(&mtget, 0, sizeof(struct mtget));
2127 mtget.mt_type = MT_ISSCSI2;
2128 mtget.mt_blkno = position / tape->user_bs_factor - block_offset;
2130 ((tape->blk_size * tape->user_bs_factor)
2131 << MT_ST_BLKSIZE_SHIFT) & MT_ST_BLKSIZE_MASK;
2133 if (tape->drv_write_prot)
2134 mtget.mt_gstat |= GMT_WR_PROT(0xffffffff);
2136 if (copy_to_user(argp, &mtget, sizeof(struct mtget)))
2140 mtpos.mt_blkno = position / tape->user_bs_factor - block_offset;
2141 if (copy_to_user(argp, &mtpos, sizeof(struct mtpos)))
2145 if (tape->chrdev_dir == IDETAPE_DIR_READ)
2146 ide_tape_discard_merge_buffer(drive, 1);
2147 return idetape_blkdev_ioctl(drive, cmd, arg);
2152 * Do a mode sense page 0 with block descriptor and if it succeeds set the tape
2153 * block size with the reported value.
2155 static void ide_tape_get_bsize_from_bdesc(ide_drive_t *drive)
2157 idetape_tape_t *tape = drive->driver_data;
2158 struct ide_atapi_pc pc;
2160 idetape_create_mode_sense_cmd(&pc, IDETAPE_BLOCK_DESCRIPTOR);
2161 if (idetape_queue_pc_tail(drive, &pc)) {
2162 printk(KERN_ERR "ide-tape: Can't get block descriptor\n");
2163 if (tape->blk_size == 0) {
2164 printk(KERN_WARNING "ide-tape: Cannot deal with zero "
2165 "block size, assuming 32k\n");
2166 tape->blk_size = 32768;
2170 tape->blk_size = (pc.buf[4 + 5] << 16) +
2171 (pc.buf[4 + 6] << 8) +
2173 tape->drv_write_prot = (pc.buf[2] & 0x80) >> 7;
2176 static int idetape_chrdev_open(struct inode *inode, struct file *filp)
2178 unsigned int minor = iminor(inode), i = minor & ~0xc0;
2180 idetape_tape_t *tape;
2181 struct ide_atapi_pc pc;
2184 if (i >= MAX_HWIFS * MAX_DRIVES)
2188 tape = ide_tape_chrdev_get(i);
2194 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
2197 * We really want to do nonseekable_open(inode, filp); here, but some
2198 * versions of tar incorrectly call lseek on tapes and bail out if that
2199 * fails. So we disallow pread() and pwrite(), but permit lseeks.
2201 filp->f_mode &= ~(FMODE_PREAD | FMODE_PWRITE);
2203 drive = tape->drive;
2205 filp->private_data = tape;
2207 if (test_and_set_bit(IDETAPE_FLAG_BUSY, &tape->flags)) {
2212 retval = idetape_wait_ready(drive, 60 * HZ);
2214 clear_bit(IDETAPE_FLAG_BUSY, &tape->flags);
2215 printk(KERN_ERR "ide-tape: %s: drive not ready\n", tape->name);
2219 idetape_read_position(drive);
2220 if (!test_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags))
2221 (void)idetape_rewind_tape(drive);
2223 /* Read block size and write protect status from drive. */
2224 ide_tape_get_bsize_from_bdesc(drive);
2226 /* Set write protect flag if device is opened as read-only. */
2227 if ((filp->f_flags & O_ACCMODE) == O_RDONLY)
2228 tape->write_prot = 1;
2230 tape->write_prot = tape->drv_write_prot;
2232 /* Make sure drive isn't write protected if user wants to write. */
2233 if (tape->write_prot) {
2234 if ((filp->f_flags & O_ACCMODE) == O_WRONLY ||
2235 (filp->f_flags & O_ACCMODE) == O_RDWR) {
2236 clear_bit(IDETAPE_FLAG_BUSY, &tape->flags);
2242 /* Lock the tape drive door so user can't eject. */
2243 if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
2244 if (idetape_create_prevent_cmd(drive, &pc, 1)) {
2245 if (!idetape_queue_pc_tail(drive, &pc)) {
2246 if (tape->door_locked != DOOR_EXPLICITLY_LOCKED)
2247 tape->door_locked = DOOR_LOCKED;
2260 static void idetape_write_release(ide_drive_t *drive, unsigned int minor)
2262 idetape_tape_t *tape = drive->driver_data;
2264 ide_tape_flush_merge_buffer(drive);
2265 tape->merge_bh = ide_tape_kmalloc_buffer(tape, 1, 0);
2266 if (tape->merge_bh != NULL) {
2267 idetape_pad_zeros(drive, tape->blk_size *
2268 (tape->user_bs_factor - 1));
2269 ide_tape_kfree_buffer(tape);
2270 tape->merge_bh = NULL;
2272 idetape_write_filemark(drive);
2273 idetape_flush_tape_buffers(drive);
2274 idetape_flush_tape_buffers(drive);
2277 static int idetape_chrdev_release(struct inode *inode, struct file *filp)
2279 struct ide_tape_obj *tape = ide_tape_f(filp);
2280 ide_drive_t *drive = tape->drive;
2281 struct ide_atapi_pc pc;
2282 unsigned int minor = iminor(inode);
2285 tape = drive->driver_data;
2287 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
2289 if (tape->chrdev_dir == IDETAPE_DIR_WRITE)
2290 idetape_write_release(drive, minor);
2291 if (tape->chrdev_dir == IDETAPE_DIR_READ) {
2293 ide_tape_discard_merge_buffer(drive, 1);
2296 if (minor < 128 && test_bit(IDETAPE_FLAG_MEDIUM_PRESENT, &tape->flags))
2297 (void) idetape_rewind_tape(drive);
2298 if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
2299 if (tape->door_locked == DOOR_LOCKED) {
2300 if (idetape_create_prevent_cmd(drive, &pc, 0)) {
2301 if (!idetape_queue_pc_tail(drive, &pc))
2302 tape->door_locked = DOOR_UNLOCKED;
2306 clear_bit(IDETAPE_FLAG_BUSY, &tape->flags);
2313 * check the contents of the ATAPI IDENTIFY command results. We return:
2315 * 1 - If the tape can be supported by us, based on the information we have so
2318 * 0 - If this tape driver is not currently supported by us.
2320 static int idetape_identify_device(ide_drive_t *drive)
2322 u8 gcw[2], protocol, device_type, removable, packet_size;
2324 if (drive->id_read == 0)
2327 *((unsigned short *) &gcw) = drive->id->config;
2329 protocol = (gcw[1] & 0xC0) >> 6;
2330 device_type = gcw[1] & 0x1F;
2331 removable = !!(gcw[0] & 0x80);
2332 packet_size = gcw[0] & 0x3;
2334 /* Check that we can support this device */
2336 printk(KERN_ERR "ide-tape: Protocol (0x%02x) is not ATAPI\n",
2338 else if (device_type != 1)
2339 printk(KERN_ERR "ide-tape: Device type (0x%02x) is not set "
2340 "to tape\n", device_type);
2341 else if (!removable)
2342 printk(KERN_ERR "ide-tape: The removable flag is not set\n");
2343 else if (packet_size != 0) {
2344 printk(KERN_ERR "ide-tape: Packet size (0x%02x) is not 12"
2345 " bytes\n", packet_size);
2351 static void idetape_get_inquiry_results(ide_drive_t *drive)
2353 idetape_tape_t *tape = drive->driver_data;
2354 struct ide_atapi_pc pc;
2355 char fw_rev[6], vendor_id[10], product_id[18];
2357 idetape_create_inquiry_cmd(&pc);
2358 if (idetape_queue_pc_tail(drive, &pc)) {
2359 printk(KERN_ERR "ide-tape: %s: can't get INQUIRY results\n",
2363 memcpy(vendor_id, &pc.buf[8], 8);
2364 memcpy(product_id, &pc.buf[16], 16);
2365 memcpy(fw_rev, &pc.buf[32], 4);
2367 ide_fixstring(vendor_id, 10, 0);
2368 ide_fixstring(product_id, 18, 0);
2369 ide_fixstring(fw_rev, 6, 0);
2371 printk(KERN_INFO "ide-tape: %s <-> %s: %s %s rev %s\n",
2372 drive->name, tape->name, vendor_id, product_id, fw_rev);
2376 * Ask the tape about its various parameters. In particular, we will adjust our
2377 * data transfer buffer size to the recommended value as returned by the tape.
2379 static void idetape_get_mode_sense_results(ide_drive_t *drive)
2381 idetape_tape_t *tape = drive->driver_data;
2382 struct ide_atapi_pc pc;
2384 u8 speed, max_speed;
2386 idetape_create_mode_sense_cmd(&pc, IDETAPE_CAPABILITIES_PAGE);
2387 if (idetape_queue_pc_tail(drive, &pc)) {
2388 printk(KERN_ERR "ide-tape: Can't get tape parameters - assuming"
2389 " some default values\n");
2390 tape->blk_size = 512;
2391 put_unaligned(52, (u16 *)&tape->caps[12]);
2392 put_unaligned(540, (u16 *)&tape->caps[14]);
2393 put_unaligned(6*52, (u16 *)&tape->caps[16]);
2396 caps = pc.buf + 4 + pc.buf[3];
2398 /* convert to host order and save for later use */
2399 speed = be16_to_cpu(*(u16 *)&caps[14]);
2400 max_speed = be16_to_cpu(*(u16 *)&caps[8]);
2402 put_unaligned(max_speed, (u16 *)&caps[8]);
2403 put_unaligned(be16_to_cpu(*(u16 *)&caps[12]), (u16 *)&caps[12]);
2404 put_unaligned(speed, (u16 *)&caps[14]);
2405 put_unaligned(be16_to_cpu(*(u16 *)&caps[16]), (u16 *)&caps[16]);
2408 printk(KERN_INFO "ide-tape: %s: invalid tape speed "
2409 "(assuming 650KB/sec)\n", drive->name);
2410 put_unaligned(650, (u16 *)&caps[14]);
2413 printk(KERN_INFO "ide-tape: %s: invalid max_speed "
2414 "(assuming 650KB/sec)\n", drive->name);
2415 put_unaligned(650, (u16 *)&caps[8]);
2418 memcpy(&tape->caps, caps, 20);
2420 tape->blk_size = 512;
2421 else if (caps[7] & 0x04)
2422 tape->blk_size = 1024;
2425 #ifdef CONFIG_IDE_PROC_FS
2426 static void idetape_add_settings(ide_drive_t *drive)
2428 idetape_tape_t *tape = drive->driver_data;
2430 ide_add_setting(drive, "buffer", SETTING_READ, TYPE_SHORT, 0, 0xffff,
2431 1, 2, (u16 *)&tape->caps[16], NULL);
2432 ide_add_setting(drive, "speed", SETTING_READ, TYPE_SHORT, 0, 0xffff,
2433 1, 1, (u16 *)&tape->caps[14], NULL);
2434 ide_add_setting(drive, "buffer_size", SETTING_READ, TYPE_INT, 0, 0xffff,
2435 1, 1024, &tape->buffer_size, NULL);
2436 ide_add_setting(drive, "tdsc", SETTING_RW, TYPE_INT, IDETAPE_DSC_RW_MIN,
2437 IDETAPE_DSC_RW_MAX, 1000, HZ, &tape->best_dsc_rw_freq,
2439 ide_add_setting(drive, "dsc_overlap", SETTING_RW, TYPE_BYTE, 0, 1, 1,
2440 1, &drive->dsc_overlap, NULL);
2441 ide_add_setting(drive, "avg_speed", SETTING_READ, TYPE_INT, 0, 0xffff,
2442 1, 1, &tape->avg_speed, NULL);
2443 ide_add_setting(drive, "debug_mask", SETTING_RW, TYPE_INT, 0, 0xffff, 1,
2444 1, &tape->debug_mask, NULL);
2447 static inline void idetape_add_settings(ide_drive_t *drive) { ; }
2451 * The function below is called to:
2453 * 1. Initialize our various state variables.
2454 * 2. Ask the tape for its capabilities.
2455 * 3. Allocate a buffer which will be used for data transfer. The buffer size
2456 * is chosen based on the recommendation which we received in step 2.
2458 * Note that at this point ide.c already assigned us an irq, so that we can
2459 * queue requests here and wait for their completion.
2461 static void idetape_setup(ide_drive_t *drive, idetape_tape_t *tape, int minor)
2467 u16 *ctl = (u16 *)&tape->caps[12];
2469 spin_lock_init(&tape->lock);
2470 drive->dsc_overlap = 1;
2471 if (drive->hwif->host_flags & IDE_HFLAG_NO_DSC) {
2472 printk(KERN_INFO "ide-tape: %s: disabling DSC overlap\n",
2474 drive->dsc_overlap = 0;
2476 /* Seagate Travan drives do not support DSC overlap. */
2477 if (strstr(drive->id->model, "Seagate STT3401"))
2478 drive->dsc_overlap = 0;
2479 tape->minor = minor;
2480 tape->name[0] = 'h';
2481 tape->name[1] = 't';
2482 tape->name[2] = '0' + minor;
2483 tape->chrdev_dir = IDETAPE_DIR_NONE;
2484 tape->pc = tape->pc_stack;
2485 *((unsigned short *) &gcw) = drive->id->config;
2487 /* Command packet DRQ type */
2488 if (((gcw[0] & 0x60) >> 5) == 1)
2489 set_bit(IDETAPE_FLAG_DRQ_INTERRUPT, &tape->flags);
2491 idetape_get_inquiry_results(drive);
2492 idetape_get_mode_sense_results(drive);
2493 ide_tape_get_bsize_from_bdesc(drive);
2494 tape->user_bs_factor = 1;
2495 tape->buffer_size = *ctl * tape->blk_size;
2496 while (tape->buffer_size > 0xffff) {
2497 printk(KERN_NOTICE "ide-tape: decreasing stage size\n");
2499 tape->buffer_size = *ctl * tape->blk_size;
2501 buffer_size = tape->buffer_size;
2502 tape->pages_per_buffer = buffer_size / PAGE_SIZE;
2503 if (buffer_size % PAGE_SIZE) {
2504 tape->pages_per_buffer++;
2505 tape->excess_bh_size = PAGE_SIZE - buffer_size % PAGE_SIZE;
2508 /* select the "best" DSC read/write polling freq */
2509 speed = max(*(u16 *)&tape->caps[14], *(u16 *)&tape->caps[8]);
2511 t = (IDETAPE_FIFO_THRESHOLD * tape->buffer_size * HZ) / (speed * 1000);
2514 * Ensure that the number we got makes sense; limit it within
2515 * IDETAPE_DSC_RW_MIN and IDETAPE_DSC_RW_MAX.
2517 tape->best_dsc_rw_freq = clamp_t(unsigned long, t, IDETAPE_DSC_RW_MIN,
2518 IDETAPE_DSC_RW_MAX);
2519 printk(KERN_INFO "ide-tape: %s <-> %s: %dKBps, %d*%dkB buffer, "
2521 drive->name, tape->name, *(u16 *)&tape->caps[14],
2522 (*(u16 *)&tape->caps[16] * 512) / tape->buffer_size,
2523 tape->buffer_size / 1024,
2524 tape->best_dsc_rw_freq * 1000 / HZ,
2525 drive->using_dma ? ", DMA":"");
2527 idetape_add_settings(drive);
2530 static void ide_tape_remove(ide_drive_t *drive)
2532 idetape_tape_t *tape = drive->driver_data;
2534 ide_proc_unregister_driver(drive, tape->driver);
2536 ide_unregister_region(tape->disk);
2541 static void ide_tape_release(struct kref *kref)
2543 struct ide_tape_obj *tape = to_ide_tape(kref);
2544 ide_drive_t *drive = tape->drive;
2545 struct gendisk *g = tape->disk;
2547 BUG_ON(tape->merge_bh_size);
2549 drive->dsc_overlap = 0;
2550 drive->driver_data = NULL;
2551 device_destroy(idetape_sysfs_class, MKDEV(IDETAPE_MAJOR, tape->minor));
2552 device_destroy(idetape_sysfs_class,
2553 MKDEV(IDETAPE_MAJOR, tape->minor + 128));
2554 idetape_devs[tape->minor] = NULL;
2555 g->private_data = NULL;
2560 #ifdef CONFIG_IDE_PROC_FS
2561 static int proc_idetape_read_name
2562 (char *page, char **start, off_t off, int count, int *eof, void *data)
2564 ide_drive_t *drive = (ide_drive_t *) data;
2565 idetape_tape_t *tape = drive->driver_data;
2569 len = sprintf(out, "%s\n", tape->name);
2570 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
2573 static ide_proc_entry_t idetape_proc[] = {
2574 { "capacity", S_IFREG|S_IRUGO, proc_ide_read_capacity, NULL },
2575 { "name", S_IFREG|S_IRUGO, proc_idetape_read_name, NULL },
2576 { NULL, 0, NULL, NULL }
2580 static int ide_tape_probe(ide_drive_t *);
2582 static ide_driver_t idetape_driver = {
2584 .owner = THIS_MODULE,
2586 .bus = &ide_bus_type,
2588 .probe = ide_tape_probe,
2589 .remove = ide_tape_remove,
2590 .version = IDETAPE_VERSION,
2592 .supports_dsc_overlap = 1,
2593 .do_request = idetape_do_request,
2594 .end_request = idetape_end_request,
2595 .error = __ide_error,
2596 #ifdef CONFIG_IDE_PROC_FS
2597 .proc = idetape_proc,
2601 /* Our character device supporting functions, passed to register_chrdev. */
2602 static const struct file_operations idetape_fops = {
2603 .owner = THIS_MODULE,
2604 .read = idetape_chrdev_read,
2605 .write = idetape_chrdev_write,
2606 .ioctl = idetape_chrdev_ioctl,
2607 .open = idetape_chrdev_open,
2608 .release = idetape_chrdev_release,
2611 static int idetape_open(struct inode *inode, struct file *filp)
2613 struct gendisk *disk = inode->i_bdev->bd_disk;
2614 struct ide_tape_obj *tape;
2616 tape = ide_tape_get(disk);
2623 static int idetape_release(struct inode *inode, struct file *filp)
2625 struct gendisk *disk = inode->i_bdev->bd_disk;
2626 struct ide_tape_obj *tape = ide_tape_g(disk);
2633 static int idetape_ioctl(struct inode *inode, struct file *file,
2634 unsigned int cmd, unsigned long arg)
2636 struct block_device *bdev = inode->i_bdev;
2637 struct ide_tape_obj *tape = ide_tape_g(bdev->bd_disk);
2638 ide_drive_t *drive = tape->drive;
2639 int err = generic_ide_ioctl(drive, file, bdev, cmd, arg);
2641 err = idetape_blkdev_ioctl(drive, cmd, arg);
2645 static struct block_device_operations idetape_block_ops = {
2646 .owner = THIS_MODULE,
2647 .open = idetape_open,
2648 .release = idetape_release,
2649 .ioctl = idetape_ioctl,
2652 static int ide_tape_probe(ide_drive_t *drive)
2654 idetape_tape_t *tape;
2658 if (!strstr("ide-tape", drive->driver_req))
2660 if (!drive->present)
2662 if (drive->media != ide_tape)
2664 if (!idetape_identify_device(drive)) {
2665 printk(KERN_ERR "ide-tape: %s: not supported by this version of"
2666 " the driver\n", drive->name);
2669 tape = kzalloc(sizeof(idetape_tape_t), GFP_KERNEL);
2671 printk(KERN_ERR "ide-tape: %s: Can't allocate a tape struct\n",
2676 g = alloc_disk(1 << PARTN_BITS);
2680 ide_init_disk(g, drive);
2682 ide_proc_register_driver(drive, &idetape_driver);
2684 kref_init(&tape->kref);
2686 tape->drive = drive;
2687 tape->driver = &idetape_driver;
2690 g->private_data = &tape->driver;
2692 drive->driver_data = tape;
2694 mutex_lock(&idetape_ref_mutex);
2695 for (minor = 0; idetape_devs[minor]; minor++)
2697 idetape_devs[minor] = tape;
2698 mutex_unlock(&idetape_ref_mutex);
2700 idetape_setup(drive, tape, minor);
2702 device_create_drvdata(idetape_sysfs_class, &drive->gendev,
2703 MKDEV(IDETAPE_MAJOR, minor), NULL,
2705 device_create_drvdata(idetape_sysfs_class, &drive->gendev,
2706 MKDEV(IDETAPE_MAJOR, minor + 128), NULL,
2709 g->fops = &idetape_block_ops;
2710 ide_register_region(g);
2720 static void __exit idetape_exit(void)
2722 driver_unregister(&idetape_driver.gen_driver);
2723 class_destroy(idetape_sysfs_class);
2724 unregister_chrdev(IDETAPE_MAJOR, "ht");
2727 static int __init idetape_init(void)
2730 idetape_sysfs_class = class_create(THIS_MODULE, "ide_tape");
2731 if (IS_ERR(idetape_sysfs_class)) {
2732 idetape_sysfs_class = NULL;
2733 printk(KERN_ERR "Unable to create sysfs class for ide tapes\n");
2738 if (register_chrdev(IDETAPE_MAJOR, "ht", &idetape_fops)) {
2739 printk(KERN_ERR "ide-tape: Failed to register chrdev"
2742 goto out_free_class;
2745 error = driver_register(&idetape_driver.gen_driver);
2747 goto out_free_driver;
2752 driver_unregister(&idetape_driver.gen_driver);
2754 class_destroy(idetape_sysfs_class);
2759 MODULE_ALIAS("ide:*m-tape*");
2760 module_init(idetape_init);
2761 module_exit(idetape_exit);
2762 MODULE_ALIAS_CHARDEV_MAJOR(IDETAPE_MAJOR);
2763 MODULE_DESCRIPTION("ATAPI Streaming TAPE Driver");
2764 MODULE_LICENSE("GPL");