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 *****************************/
78 * Pipelined mode parameters.
80 * We try to use the minimum number of stages which is enough to keep the tape
81 * constantly streaming. To accomplish that, we implement a feedback loop around
82 * the maximum number of stages:
84 * We start from MIN maximum stages (we will not even use MIN stages if we don't
85 * need them), increment it by RATE*(MAX-MIN) whenever we sense that the
86 * pipeline is empty, until we reach the optimum value or until we reach MAX.
88 #define IDETAPE_MIN_PIPELINE_STAGES 1
89 #define IDETAPE_MAX_PIPELINE_STAGES 400
90 #define IDETAPE_INCREASE_STAGES_RATE 20
93 * After each failed packet command we issue a request sense command and retry
94 * the packet command IDETAPE_MAX_PC_RETRIES times.
96 * Setting IDETAPE_MAX_PC_RETRIES to 0 will disable retries.
98 #define IDETAPE_MAX_PC_RETRIES 3
101 * With each packet command, we allocate a buffer of IDETAPE_PC_BUFFER_SIZE
102 * bytes. This is used for several packet commands (Not for READ/WRITE commands)
104 #define IDETAPE_PC_BUFFER_SIZE 256
107 * In various places in the driver, we need to allocate storage
108 * for packet commands and requests, which will remain valid while
109 * we leave the driver to wait for an interrupt or a timeout event.
111 #define IDETAPE_PC_STACK (10 + IDETAPE_MAX_PC_RETRIES)
114 * Some drives (for example, Seagate STT3401A Travan) require a very long
115 * timeout, because they don't return an interrupt or clear their busy bit
116 * until after the command completes (even retension commands).
118 #define IDETAPE_WAIT_CMD (900*HZ)
121 * The following parameter is used to select the point in the internal tape fifo
122 * in which we will start to refill the buffer. Decreasing the following
123 * parameter will improve the system's latency and interactive response, while
124 * using a high value might improve system throughput.
126 #define IDETAPE_FIFO_THRESHOLD 2
129 * DSC polling parameters.
131 * Polling for DSC (a single bit in the status register) is a very important
132 * function in ide-tape. There are two cases in which we poll for DSC:
134 * 1. Before a read/write packet command, to ensure that we can transfer data
135 * from/to the tape's data buffers, without causing an actual media access.
136 * In case the tape is not ready yet, we take out our request from the device
137 * request queue, so that ide.c could service requests from the other device
138 * on the same interface in the meantime.
140 * 2. After the successful initialization of a "media access packet command",
141 * which is a command that can take a long time to complete (the interval can
142 * range from several seconds to even an hour). Again, we postpone our request
143 * in the middle to free the bus for the other device. The polling frequency
144 * here should be lower than the read/write frequency since those media access
145 * commands are slow. We start from a "fast" frequency - IDETAPE_DSC_MA_FAST
146 * (1 second), and if we don't receive DSC after IDETAPE_DSC_MA_THRESHOLD
147 * (5 min), we switch it to a lower frequency - IDETAPE_DSC_MA_SLOW (1 min).
149 * We also set a timeout for the timer, in case something goes wrong. The
150 * timeout should be longer then the maximum execution time of a tape operation.
154 #define IDETAPE_DSC_RW_MIN 5*HZ/100 /* 50 msec */
155 #define IDETAPE_DSC_RW_MAX 40*HZ/100 /* 400 msec */
156 #define IDETAPE_DSC_RW_TIMEOUT 2*60*HZ /* 2 minutes */
157 #define IDETAPE_DSC_MA_FAST 2*HZ /* 2 seconds */
158 #define IDETAPE_DSC_MA_THRESHOLD 5*60*HZ /* 5 minutes */
159 #define IDETAPE_DSC_MA_SLOW 30*HZ /* 30 seconds */
160 #define IDETAPE_DSC_MA_TIMEOUT 2*60*60*HZ /* 2 hours */
162 /*************************** End of tunable parameters ***********************/
164 /* Read/Write error simulation */
165 #define SIMULATE_ERRORS 0
167 /* tape directions */
169 IDETAPE_DIR_NONE = (1 << 0),
170 IDETAPE_DIR_READ = (1 << 1),
171 IDETAPE_DIR_WRITE = (1 << 2),
177 struct idetape_bh *b_reqnext;
181 /* Tape door status */
182 #define DOOR_UNLOCKED 0
183 #define DOOR_LOCKED 1
184 #define DOOR_EXPLICITLY_LOCKED 2
186 /* Some defines for the SPACE command */
187 #define IDETAPE_SPACE_OVER_FILEMARK 1
188 #define IDETAPE_SPACE_TO_EOD 3
190 /* Some defines for the LOAD UNLOAD command */
191 #define IDETAPE_LU_LOAD_MASK 1
192 #define IDETAPE_LU_RETENSION_MASK 2
193 #define IDETAPE_LU_EOT_MASK 4
196 * Special requests for our block device strategy routine.
198 * In order to service a character device command, we add special requests to
199 * the tail of our block device request queue and wait for their completion.
203 REQ_IDETAPE_PC1 = (1 << 0), /* packet command (first stage) */
204 REQ_IDETAPE_PC2 = (1 << 1), /* packet command (second stage) */
205 REQ_IDETAPE_READ = (1 << 2),
206 REQ_IDETAPE_WRITE = (1 << 3),
209 /* Error codes returned in rq->errors to the higher part of the driver. */
210 #define IDETAPE_ERROR_GENERAL 101
211 #define IDETAPE_ERROR_FILEMARK 102
212 #define IDETAPE_ERROR_EOD 103
214 /* Structures related to the SELECT SENSE / MODE SENSE packet commands. */
215 #define IDETAPE_BLOCK_DESCRIPTOR 0
216 #define IDETAPE_CAPABILITIES_PAGE 0x2a
218 /* Tape flag bits values. */
220 IDETAPE_FLAG_IGNORE_DSC = (1 << 0),
221 /* 0 When the tape position is unknown */
222 IDETAPE_FLAG_ADDRESS_VALID = (1 << 1),
223 /* Device already opened */
224 IDETAPE_FLAG_BUSY = (1 << 2),
225 /* Error detected in a pipeline stage */
226 IDETAPE_FLAG_PIPELINE_ERR = (1 << 3),
227 /* Attempt to auto-detect the current user block size */
228 IDETAPE_FLAG_DETECT_BS = (1 << 4),
229 /* Currently on a filemark */
230 IDETAPE_FLAG_FILEMARK = (1 << 5),
231 /* DRQ interrupt device */
232 IDETAPE_FLAG_DRQ_INTERRUPT = (1 << 6),
233 /* pipeline active */
234 IDETAPE_FLAG_PIPELINE_ACTIVE = (1 << 7),
235 /* 0 = no tape is loaded, so we don't rewind after ejecting */
236 IDETAPE_FLAG_MEDIUM_PRESENT = (1 << 8),
239 /* A pipeline stage. */
240 typedef struct idetape_stage_s {
241 struct request rq; /* The corresponding request */
242 struct idetape_bh *bh; /* The data buffers */
243 struct idetape_stage_s *next; /* Pointer to the next stage */
247 * Most of our global data which we need to save even as we leave the driver due
248 * to an interrupt or a timer event is stored in the struct defined below.
250 typedef struct ide_tape_obj {
252 ide_driver_t *driver;
253 struct gendisk *disk;
257 * Since a typical character device operation requires more
258 * than one packet command, we provide here enough memory
259 * for the maximum of interconnected packet commands.
260 * The packet commands are stored in the circular array pc_stack.
261 * pc_stack_index points to the last used entry, and warps around
262 * to the start when we get to the last array entry.
264 * pc points to the current processed packet command.
266 * failed_pc points to the last failed packet command, or contains
267 * NULL if we do not need to retry any packet command. This is
268 * required since an additional packet command is needed before the
269 * retry, to get detailed information on what went wrong.
271 /* Current packet command */
272 struct ide_atapi_pc *pc;
273 /* Last failed packet command */
274 struct ide_atapi_pc *failed_pc;
275 /* Packet command stack */
276 struct ide_atapi_pc pc_stack[IDETAPE_PC_STACK];
277 /* Next free packet command storage space */
279 struct request rq_stack[IDETAPE_PC_STACK];
280 /* We implement a circular array */
284 * DSC polling variables.
286 * While polling for DSC we use postponed_rq to postpone the current
287 * request so that ide.c will be able to service pending requests on the
288 * other device. Note that at most we will have only one DSC (usually
289 * data transfer) request in the device request queue. Additional
290 * requests can be queued in our internal pipeline, but they will be
291 * visible to ide.c only one at a time.
293 struct request *postponed_rq;
294 /* The time in which we started polling for DSC */
295 unsigned long dsc_polling_start;
296 /* Timer used to poll for dsc */
297 struct timer_list dsc_timer;
298 /* Read/Write dsc polling frequency */
299 unsigned long best_dsc_rw_freq;
300 unsigned long dsc_poll_freq;
301 unsigned long dsc_timeout;
303 /* Read position information */
306 unsigned int first_frame;
308 /* Last error information */
309 u8 sense_key, asc, ascq;
311 /* Character device operation */
315 /* Current character device data transfer direction */
318 /* tape block size, usually 512 or 1024 bytes */
319 unsigned short blk_size;
322 /* Copy of the tape's Capabilities and Mechanical Page */
326 * Active data transfer request parameters.
328 * At most, there is only one ide-tape originated data transfer request
329 * in the device request queue. This allows ide.c to easily service
330 * requests from the other device when we postpone our active request.
331 * In the pipelined operation mode, we use our internal pipeline
332 * structure to hold more data requests. The data buffer size is chosen
333 * based on the tape's recommendation.
335 /* ptr to the request which is waiting in the device request queue */
336 struct request *active_data_rq;
337 /* Data buffer size chosen based on the tape's recommendation */
339 idetape_stage_t *merge_stage;
340 int merge_stage_size;
341 struct idetape_bh *bh;
346 * Pipeline parameters.
348 * To accomplish non-pipelined mode, we simply set the following
349 * variables to zero (or NULL, where appropriate).
351 /* Number of currently used stages */
353 /* Number of pending stages */
354 int nr_pending_stages;
355 /* We will not allocate more than this number of stages */
356 int max_stages, min_pipeline, max_pipeline;
357 /* The first stage which will be removed from the pipeline */
358 idetape_stage_t *first_stage;
359 /* The currently active stage */
360 idetape_stage_t *active_stage;
361 /* Will be serviced after the currently active request */
362 idetape_stage_t *next_stage;
363 /* New requests will be added to the pipeline here */
364 idetape_stage_t *last_stage;
366 /* Wasted space in each stage */
369 /* Status/Action flags: long for set_bit */
371 /* protects the ide-tape queue */
374 /* Measures average tape speed */
375 unsigned long avg_time;
379 /* the door is currently locked */
381 /* the tape hardware is write protected */
383 /* the tape is write protected (hardware or opened as read-only) */
387 * Limit the number of times a request can be postponed, to avoid an
388 * infinite postpone deadlock.
392 /* Speed control at the tape buffers input/output */
393 unsigned long insert_time;
396 int measure_insert_time;
401 static DEFINE_MUTEX(idetape_ref_mutex);
403 static struct class *idetape_sysfs_class;
405 #define to_ide_tape(obj) container_of(obj, struct ide_tape_obj, kref)
407 #define ide_tape_g(disk) \
408 container_of((disk)->private_data, struct ide_tape_obj, driver)
410 static struct ide_tape_obj *ide_tape_get(struct gendisk *disk)
412 struct ide_tape_obj *tape = NULL;
414 mutex_lock(&idetape_ref_mutex);
415 tape = ide_tape_g(disk);
417 kref_get(&tape->kref);
418 mutex_unlock(&idetape_ref_mutex);
422 static void ide_tape_release(struct kref *);
424 static void ide_tape_put(struct ide_tape_obj *tape)
426 mutex_lock(&idetape_ref_mutex);
427 kref_put(&tape->kref, ide_tape_release);
428 mutex_unlock(&idetape_ref_mutex);
432 * The variables below are used for the character device interface. Additional
433 * state variables are defined in our ide_drive_t structure.
435 static struct ide_tape_obj *idetape_devs[MAX_HWIFS * MAX_DRIVES];
437 #define ide_tape_f(file) ((file)->private_data)
439 static struct ide_tape_obj *ide_tape_chrdev_get(unsigned int i)
441 struct ide_tape_obj *tape = NULL;
443 mutex_lock(&idetape_ref_mutex);
444 tape = idetape_devs[i];
446 kref_get(&tape->kref);
447 mutex_unlock(&idetape_ref_mutex);
451 static void idetape_input_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
454 struct idetape_bh *bh = pc->bh;
459 printk(KERN_ERR "ide-tape: bh == NULL in "
460 "idetape_input_buffers\n");
461 ide_atapi_discard_data(drive, bcount);
465 (unsigned int)(bh->b_size - atomic_read(&bh->b_count)),
467 HWIF(drive)->atapi_input_bytes(drive, bh->b_data +
468 atomic_read(&bh->b_count), count);
470 atomic_add(count, &bh->b_count);
471 if (atomic_read(&bh->b_count) == bh->b_size) {
474 atomic_set(&bh->b_count, 0);
480 static void idetape_output_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
483 struct idetape_bh *bh = pc->bh;
488 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
492 count = min((unsigned int)pc->b_count, (unsigned int)bcount);
493 HWIF(drive)->atapi_output_bytes(drive, pc->b_data, count);
496 pc->b_count -= count;
501 pc->b_data = bh->b_data;
502 pc->b_count = atomic_read(&bh->b_count);
508 static void idetape_update_buffers(struct ide_atapi_pc *pc)
510 struct idetape_bh *bh = pc->bh;
512 unsigned int bcount = pc->xferred;
514 if (pc->flags & PC_FLAG_WRITING)
518 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
522 count = min((unsigned int)bh->b_size, (unsigned int)bcount);
523 atomic_set(&bh->b_count, count);
524 if (atomic_read(&bh->b_count) == bh->b_size)
532 * idetape_next_pc_storage returns a pointer to a place in which we can
533 * safely store a packet command, even though we intend to leave the
534 * driver. A storage space for a maximum of IDETAPE_PC_STACK packet
535 * commands is allocated at initialization time.
537 static struct ide_atapi_pc *idetape_next_pc_storage(ide_drive_t *drive)
539 idetape_tape_t *tape = drive->driver_data;
541 debug_log(DBG_PCRQ_STACK, "pc_stack_index=%d\n", tape->pc_stack_index);
543 if (tape->pc_stack_index == IDETAPE_PC_STACK)
544 tape->pc_stack_index = 0;
545 return (&tape->pc_stack[tape->pc_stack_index++]);
549 * idetape_next_rq_storage is used along with idetape_next_pc_storage.
550 * Since we queue packet commands in the request queue, we need to
551 * allocate a request, along with the allocation of a packet command.
554 /**************************************************************
556 * This should get fixed to use kmalloc(.., GFP_ATOMIC) *
557 * followed later on by kfree(). -ml *
559 **************************************************************/
561 static struct request *idetape_next_rq_storage(ide_drive_t *drive)
563 idetape_tape_t *tape = drive->driver_data;
565 debug_log(DBG_PCRQ_STACK, "rq_stack_index=%d\n", tape->rq_stack_index);
567 if (tape->rq_stack_index == IDETAPE_PC_STACK)
568 tape->rq_stack_index = 0;
569 return (&tape->rq_stack[tape->rq_stack_index++]);
572 static void idetape_init_pc(struct ide_atapi_pc *pc)
574 memset(pc->c, 0, 12);
578 pc->buf = pc->pc_buf;
579 pc->buf_size = IDETAPE_PC_BUFFER_SIZE;
585 * called on each failed packet command retry to analyze the request sense. We
586 * currently do not utilize this information.
588 static void idetape_analyze_error(ide_drive_t *drive, u8 *sense)
590 idetape_tape_t *tape = drive->driver_data;
591 struct ide_atapi_pc *pc = tape->failed_pc;
593 tape->sense_key = sense[2] & 0xF;
594 tape->asc = sense[12];
595 tape->ascq = sense[13];
597 debug_log(DBG_ERR, "pc = %x, sense key = %x, asc = %x, ascq = %x\n",
598 pc->c[0], tape->sense_key, tape->asc, tape->ascq);
600 /* Correct pc->xferred by asking the tape. */
601 if (pc->flags & PC_FLAG_DMA_ERROR) {
602 pc->xferred = pc->req_xfer -
604 be32_to_cpu(get_unaligned((u32 *)&sense[3]));
605 idetape_update_buffers(pc);
609 * If error was the result of a zero-length read or write command,
610 * with sense key=5, asc=0x22, ascq=0, let it slide. Some drives
611 * (i.e. Seagate STT3401A Travan) don't support 0-length read/writes.
613 if ((pc->c[0] == READ_6 || pc->c[0] == WRITE_6)
615 && pc->c[4] == 0 && pc->c[3] == 0 && pc->c[2] == 0) {
616 if (tape->sense_key == 5) {
617 /* don't report an error, everything's ok */
619 /* don't retry read/write */
620 pc->flags |= PC_FLAG_ABORT;
623 if (pc->c[0] == READ_6 && (sense[2] & 0x80)) {
624 pc->error = IDETAPE_ERROR_FILEMARK;
625 pc->flags |= PC_FLAG_ABORT;
627 if (pc->c[0] == WRITE_6) {
628 if ((sense[2] & 0x40) || (tape->sense_key == 0xd
629 && tape->asc == 0x0 && tape->ascq == 0x2)) {
630 pc->error = IDETAPE_ERROR_EOD;
631 pc->flags |= PC_FLAG_ABORT;
634 if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
635 if (tape->sense_key == 8) {
636 pc->error = IDETAPE_ERROR_EOD;
637 pc->flags |= PC_FLAG_ABORT;
639 if (!(pc->flags & PC_FLAG_ABORT) &&
641 pc->retries = IDETAPE_MAX_PC_RETRIES + 1;
645 /* Free a stage along with its related buffers completely. */
646 static void __idetape_kfree_stage(idetape_stage_t *stage)
648 struct idetape_bh *prev_bh, *bh = stage->bh;
652 if (bh->b_data != NULL) {
653 size = (int) bh->b_size;
655 free_page((unsigned long) bh->b_data);
657 bh->b_data += PAGE_SIZE;
668 * Finish servicing a request and insert a pending pipeline request into the
671 static int idetape_end_request(ide_drive_t *drive, int uptodate, int nr_sects)
673 struct request *rq = HWGROUP(drive)->rq;
674 idetape_tape_t *tape = drive->driver_data;
678 debug_log(DBG_PROCS, "Enter %s\n", __func__);
681 case 0: error = IDETAPE_ERROR_GENERAL; break;
682 case 1: error = 0; break;
683 default: error = uptodate;
687 tape->failed_pc = NULL;
689 if (!blk_special_request(rq)) {
690 ide_end_request(drive, uptodate, nr_sects);
694 spin_lock_irqsave(&tape->lock, flags);
696 ide_end_drive_cmd(drive, 0, 0);
698 clear_bit(IDETAPE_FLAG_PIPELINE_ACTIVE, &tape->flags);
699 spin_unlock_irqrestore(&tape->lock, flags);
703 static ide_startstop_t idetape_request_sense_callback(ide_drive_t *drive)
705 idetape_tape_t *tape = drive->driver_data;
707 debug_log(DBG_PROCS, "Enter %s\n", __func__);
709 if (!tape->pc->error) {
710 idetape_analyze_error(drive, tape->pc->buf);
711 idetape_end_request(drive, 1, 0);
713 printk(KERN_ERR "ide-tape: Error in REQUEST SENSE itself - "
714 "Aborting request!\n");
715 idetape_end_request(drive, 0, 0);
720 static void idetape_create_request_sense_cmd(struct ide_atapi_pc *pc)
723 pc->c[0] = REQUEST_SENSE;
726 pc->idetape_callback = &idetape_request_sense_callback;
729 static void idetape_init_rq(struct request *rq, u8 cmd)
731 memset(rq, 0, sizeof(*rq));
732 rq->cmd_type = REQ_TYPE_SPECIAL;
737 * Generate a new packet command request in front of the request queue, before
738 * the current request, so that it will be processed immediately, on the next
739 * pass through the driver. The function below is called from the request
740 * handling part of the driver (the "bottom" part). Safe storage for the request
741 * should be allocated with ide_tape_next_{pc,rq}_storage() prior to that.
743 * Memory for those requests is pre-allocated at initialization time, and is
744 * limited to IDETAPE_PC_STACK requests. We assume that we have enough space for
745 * the maximum possible number of inter-dependent packet commands.
747 * The higher level of the driver - The ioctl handler and the character device
748 * handling functions should queue request to the lower level part and wait for
749 * their completion using idetape_queue_pc_tail or idetape_queue_rw_tail.
751 static void idetape_queue_pc_head(ide_drive_t *drive, struct ide_atapi_pc *pc,
754 struct ide_tape_obj *tape = drive->driver_data;
756 idetape_init_rq(rq, REQ_IDETAPE_PC1);
757 rq->buffer = (char *) pc;
758 rq->rq_disk = tape->disk;
759 (void) ide_do_drive_cmd(drive, rq, ide_preempt);
763 * idetape_retry_pc is called when an error was detected during the
764 * last packet command. We queue a request sense packet command in
765 * the head of the request list.
767 static ide_startstop_t idetape_retry_pc (ide_drive_t *drive)
769 idetape_tape_t *tape = drive->driver_data;
770 struct ide_atapi_pc *pc;
773 (void)ide_read_error(drive);
774 pc = idetape_next_pc_storage(drive);
775 rq = idetape_next_rq_storage(drive);
776 idetape_create_request_sense_cmd(pc);
777 set_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags);
778 idetape_queue_pc_head(drive, pc, rq);
783 * Postpone the current request so that ide.c will be able to service requests
784 * from another device on the same hwgroup while we are polling for DSC.
786 static void idetape_postpone_request(ide_drive_t *drive)
788 idetape_tape_t *tape = drive->driver_data;
790 debug_log(DBG_PROCS, "Enter %s\n", __func__);
792 tape->postponed_rq = HWGROUP(drive)->rq;
793 ide_stall_queue(drive, tape->dsc_poll_freq);
796 typedef void idetape_io_buf(ide_drive_t *, struct ide_atapi_pc *, unsigned int);
799 * This is the usual interrupt handler which will be called during a packet
800 * command. We will transfer some of the data (as requested by the drive) and
801 * will re-point interrupt handler to us. When data transfer is finished, we
802 * will act according to the algorithm described before
805 static ide_startstop_t idetape_pc_intr(ide_drive_t *drive)
807 ide_hwif_t *hwif = drive->hwif;
808 idetape_tape_t *tape = drive->driver_data;
809 struct ide_atapi_pc *pc = tape->pc;
810 xfer_func_t *xferfunc;
811 idetape_io_buf *iobuf;
814 static int error_sim_count;
819 debug_log(DBG_PROCS, "Enter %s - interrupt handler\n", __func__);
821 /* Clear the interrupt */
822 stat = ide_read_status(drive);
824 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
825 if (hwif->dma_ops->dma_end(drive) || (stat & ERR_STAT)) {
827 * A DMA error is sometimes expected. For example,
828 * if the tape is crossing a filemark during a
829 * READ command, it will issue an irq and position
830 * itself before the filemark, so that only a partial
831 * data transfer will occur (which causes the DMA
832 * error). In that case, we will later ask the tape
833 * how much bytes of the original request were
834 * actually transferred (we can't receive that
835 * information from the DMA engine on most chipsets).
839 * On the contrary, a DMA error is never expected;
840 * it usually indicates a hardware error or abort.
841 * If the tape crosses a filemark during a READ
842 * command, it will issue an irq and position itself
843 * after the filemark (not before). Only a partial
844 * data transfer will occur, but no DMA error.
847 pc->flags |= PC_FLAG_DMA_ERROR;
849 pc->xferred = pc->req_xfer;
850 idetape_update_buffers(pc);
852 debug_log(DBG_PROCS, "DMA finished\n");
856 /* No more interrupts */
857 if ((stat & DRQ_STAT) == 0) {
858 debug_log(DBG_SENSE, "Packet command completed, %d bytes"
859 " transferred\n", pc->xferred);
861 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
865 if ((pc->c[0] == WRITE_6 || pc->c[0] == READ_6) &&
866 (++error_sim_count % 100) == 0) {
867 printk(KERN_INFO "ide-tape: %s: simulating error\n",
872 if ((stat & ERR_STAT) && pc->c[0] == REQUEST_SENSE)
874 if ((stat & ERR_STAT) || (pc->flags & PC_FLAG_DMA_ERROR)) {
876 debug_log(DBG_ERR, "%s: I/O error\n", tape->name);
878 if (pc->c[0] == REQUEST_SENSE) {
879 printk(KERN_ERR "ide-tape: I/O error in request"
881 return ide_do_reset(drive);
883 debug_log(DBG_ERR, "[cmd %x]: check condition\n",
886 /* Retry operation */
887 return idetape_retry_pc(drive);
890 if ((pc->flags & PC_FLAG_WAIT_FOR_DSC) &&
891 (stat & SEEK_STAT) == 0) {
892 /* Media access command */
893 tape->dsc_polling_start = jiffies;
894 tape->dsc_poll_freq = IDETAPE_DSC_MA_FAST;
895 tape->dsc_timeout = jiffies + IDETAPE_DSC_MA_TIMEOUT;
896 /* Allow ide.c to handle other requests */
897 idetape_postpone_request(drive);
900 if (tape->failed_pc == pc)
901 tape->failed_pc = NULL;
902 /* Command finished - Call the callback function */
903 return pc->idetape_callback(drive);
906 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
907 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
908 printk(KERN_ERR "ide-tape: The tape wants to issue more "
909 "interrupts in DMA mode\n");
910 printk(KERN_ERR "ide-tape: DMA disabled, reverting to PIO\n");
912 return ide_do_reset(drive);
914 /* Get the number of bytes to transfer on this interrupt. */
915 bcount = (hwif->INB(hwif->io_ports[IDE_BCOUNTH_OFFSET]) << 8) |
916 hwif->INB(hwif->io_ports[IDE_BCOUNTL_OFFSET]);
918 ireason = hwif->INB(hwif->io_ports[IDE_IREASON_OFFSET]);
921 printk(KERN_ERR "ide-tape: CoD != 0 in %s\n", __func__);
922 return ide_do_reset(drive);
924 if (((ireason & IO) == IO) == !!(pc->flags & PC_FLAG_WRITING)) {
925 /* Hopefully, we will never get here */
926 printk(KERN_ERR "ide-tape: We wanted to %s, ",
927 (ireason & IO) ? "Write" : "Read");
928 printk(KERN_ERR "ide-tape: but the tape wants us to %s !\n",
929 (ireason & IO) ? "Read" : "Write");
930 return ide_do_reset(drive);
932 if (!(pc->flags & PC_FLAG_WRITING)) {
933 /* Reading - Check that we have enough space */
934 temp = pc->xferred + bcount;
935 if (temp > pc->req_xfer) {
936 if (temp > pc->buf_size) {
937 printk(KERN_ERR "ide-tape: The tape wants to "
938 "send us more data than expected "
939 "- discarding data\n");
940 ide_atapi_discard_data(drive, bcount);
941 ide_set_handler(drive, &idetape_pc_intr,
942 IDETAPE_WAIT_CMD, NULL);
945 debug_log(DBG_SENSE, "The tape wants to send us more "
946 "data than expected - allowing transfer\n");
948 iobuf = &idetape_input_buffers;
949 xferfunc = hwif->atapi_input_bytes;
951 iobuf = &idetape_output_buffers;
952 xferfunc = hwif->atapi_output_bytes;
956 iobuf(drive, pc, bcount);
958 xferfunc(drive, pc->cur_pos, bcount);
960 /* Update the current position */
961 pc->xferred += bcount;
962 pc->cur_pos += bcount;
964 debug_log(DBG_SENSE, "[cmd %x] transferred %d bytes on that intr.\n",
967 /* And set the interrupt handler again */
968 ide_set_handler(drive, &idetape_pc_intr, IDETAPE_WAIT_CMD, NULL);
973 * Packet Command Interface
975 * The current Packet Command is available in tape->pc, and will not change
976 * until we finish handling it. Each packet command is associated with a
977 * callback function that will be called when the command is finished.
979 * The handling will be done in three stages:
981 * 1. idetape_issue_pc will send the packet command to the drive, and will set
982 * the interrupt handler to idetape_pc_intr.
984 * 2. On each interrupt, idetape_pc_intr will be called. This step will be
985 * repeated until the device signals us that no more interrupts will be issued.
987 * 3. ATAPI Tape media access commands have immediate status with a delayed
988 * process. In case of a successful initiation of a media access packet command,
989 * the DSC bit will be set when the actual execution of the command is finished.
990 * Since the tape drive will not issue an interrupt, we have to poll for this
991 * event. In this case, we define the request as "low priority request" by
992 * setting rq_status to IDETAPE_RQ_POSTPONED, set a timer to poll for DSC and
995 * ide.c will then give higher priority to requests which originate from the
996 * other device, until will change rq_status to RQ_ACTIVE.
998 * 4. When the packet command is finished, it will be checked for errors.
1000 * 5. In case an error was found, we queue a request sense packet command in
1001 * front of the request queue and retry the operation up to
1002 * IDETAPE_MAX_PC_RETRIES times.
1004 * 6. In case no error was found, or we decided to give up and not to retry
1005 * again, the callback function will be called and then we will handle the next
1008 static ide_startstop_t idetape_transfer_pc(ide_drive_t *drive)
1010 ide_hwif_t *hwif = drive->hwif;
1011 idetape_tape_t *tape = drive->driver_data;
1012 struct ide_atapi_pc *pc = tape->pc;
1014 ide_startstop_t startstop;
1017 if (ide_wait_stat(&startstop, drive, DRQ_STAT, BUSY_STAT, WAIT_READY)) {
1018 printk(KERN_ERR "ide-tape: Strange, packet command initiated "
1019 "yet DRQ isn't asserted\n");
1022 ireason = hwif->INB(hwif->io_ports[IDE_IREASON_OFFSET]);
1023 while (retries-- && ((ireason & CD) == 0 || (ireason & IO))) {
1024 printk(KERN_ERR "ide-tape: (IO,CoD != (0,1) while issuing "
1025 "a packet command, retrying\n");
1027 ireason = hwif->INB(hwif->io_ports[IDE_IREASON_OFFSET]);
1029 printk(KERN_ERR "ide-tape: (IO,CoD != (0,1) while "
1030 "issuing a packet command, ignoring\n");
1035 if ((ireason & CD) == 0 || (ireason & IO)) {
1036 printk(KERN_ERR "ide-tape: (IO,CoD) != (0,1) while issuing "
1037 "a packet command\n");
1038 return ide_do_reset(drive);
1040 /* Set the interrupt routine */
1041 ide_set_handler(drive, &idetape_pc_intr, IDETAPE_WAIT_CMD, NULL);
1042 #ifdef CONFIG_BLK_DEV_IDEDMA
1043 /* Begin DMA, if necessary */
1044 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS)
1045 hwif->dma_ops->dma_start(drive);
1047 /* Send the actual packet */
1048 HWIF(drive)->atapi_output_bytes(drive, pc->c, 12);
1052 static ide_startstop_t idetape_issue_pc(ide_drive_t *drive,
1053 struct ide_atapi_pc *pc)
1055 ide_hwif_t *hwif = drive->hwif;
1056 idetape_tape_t *tape = drive->driver_data;
1060 if (tape->pc->c[0] == REQUEST_SENSE &&
1061 pc->c[0] == REQUEST_SENSE) {
1062 printk(KERN_ERR "ide-tape: possible ide-tape.c bug - "
1063 "Two request sense in serial were issued\n");
1066 if (tape->failed_pc == NULL && pc->c[0] != REQUEST_SENSE)
1067 tape->failed_pc = pc;
1068 /* Set the current packet command */
1071 if (pc->retries > IDETAPE_MAX_PC_RETRIES ||
1072 (pc->flags & PC_FLAG_ABORT)) {
1074 * We will "abort" retrying a packet command in case legitimate
1075 * error code was received (crossing a filemark, or end of the
1076 * media, for example).
1078 if (!(pc->flags & PC_FLAG_ABORT)) {
1079 if (!(pc->c[0] == TEST_UNIT_READY &&
1080 tape->sense_key == 2 && tape->asc == 4 &&
1081 (tape->ascq == 1 || tape->ascq == 8))) {
1082 printk(KERN_ERR "ide-tape: %s: I/O error, "
1083 "pc = %2x, key = %2x, "
1084 "asc = %2x, ascq = %2x\n",
1085 tape->name, pc->c[0],
1086 tape->sense_key, tape->asc,
1090 pc->error = IDETAPE_ERROR_GENERAL;
1092 tape->failed_pc = NULL;
1093 return pc->idetape_callback(drive);
1095 debug_log(DBG_SENSE, "Retry #%d, cmd = %02X\n", pc->retries, pc->c[0]);
1098 /* We haven't transferred any data yet */
1100 pc->cur_pos = pc->buf;
1101 /* Request to transfer the entire buffer at once */
1102 bcount = pc->req_xfer;
1104 if (pc->flags & PC_FLAG_DMA_ERROR) {
1105 pc->flags &= ~PC_FLAG_DMA_ERROR;
1106 printk(KERN_WARNING "ide-tape: DMA disabled, "
1107 "reverting to PIO\n");
1110 if ((pc->flags & PC_FLAG_DMA_RECOMMENDED) && drive->using_dma)
1111 dma_ok = !hwif->dma_ops->dma_setup(drive);
1113 ide_pktcmd_tf_load(drive, IDE_TFLAG_NO_SELECT_MASK |
1114 IDE_TFLAG_OUT_DEVICE, bcount, dma_ok);
1117 /* Will begin DMA later */
1118 pc->flags |= PC_FLAG_DMA_IN_PROGRESS;
1119 if (test_bit(IDETAPE_FLAG_DRQ_INTERRUPT, &tape->flags)) {
1120 ide_execute_command(drive, WIN_PACKETCMD, &idetape_transfer_pc,
1121 IDETAPE_WAIT_CMD, NULL);
1124 hwif->OUTB(WIN_PACKETCMD, hwif->io_ports[IDE_COMMAND_OFFSET]);
1125 return idetape_transfer_pc(drive);
1129 static ide_startstop_t idetape_pc_callback(ide_drive_t *drive)
1131 idetape_tape_t *tape = drive->driver_data;
1133 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1135 idetape_end_request(drive, tape->pc->error ? 0 : 1, 0);
1139 /* A mode sense command is used to "sense" tape parameters. */
1140 static void idetape_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
1142 idetape_init_pc(pc);
1143 pc->c[0] = MODE_SENSE;
1144 if (page_code != IDETAPE_BLOCK_DESCRIPTOR)
1145 /* DBD = 1 - Don't return block descriptors */
1147 pc->c[2] = page_code;
1149 * Changed pc->c[3] to 0 (255 will at best return unused info).
1151 * For SCSI this byte is defined as subpage instead of high byte
1152 * of length and some IDE drives seem to interpret it this way
1153 * and return an error when 255 is used.
1156 /* We will just discard data in that case */
1158 if (page_code == IDETAPE_BLOCK_DESCRIPTOR)
1160 else if (page_code == IDETAPE_CAPABILITIES_PAGE)
1164 pc->idetape_callback = &idetape_pc_callback;
1167 static ide_startstop_t idetape_media_access_finished(ide_drive_t *drive)
1169 idetape_tape_t *tape = drive->driver_data;
1170 struct ide_atapi_pc *pc = tape->pc;
1173 stat = ide_read_status(drive);
1175 if (stat & SEEK_STAT) {
1176 if (stat & ERR_STAT) {
1177 /* Error detected */
1178 if (pc->c[0] != TEST_UNIT_READY)
1179 printk(KERN_ERR "ide-tape: %s: I/O error, ",
1181 /* Retry operation */
1182 return idetape_retry_pc(drive);
1185 if (tape->failed_pc == pc)
1186 tape->failed_pc = NULL;
1188 pc->error = IDETAPE_ERROR_GENERAL;
1189 tape->failed_pc = NULL;
1191 return pc->idetape_callback(drive);
1194 static ide_startstop_t idetape_rw_callback(ide_drive_t *drive)
1196 idetape_tape_t *tape = drive->driver_data;
1197 struct request *rq = HWGROUP(drive)->rq;
1198 int blocks = tape->pc->xferred / tape->blk_size;
1200 tape->avg_size += blocks * tape->blk_size;
1201 tape->insert_size += blocks * tape->blk_size;
1202 if (tape->insert_size > 1024 * 1024)
1203 tape->measure_insert_time = 1;
1204 if (tape->measure_insert_time) {
1205 tape->measure_insert_time = 0;
1206 tape->insert_time = jiffies;
1207 tape->insert_size = 0;
1209 if (time_after(jiffies, tape->insert_time))
1210 tape->insert_speed = tape->insert_size / 1024 * HZ /
1211 (jiffies - tape->insert_time);
1212 if (time_after_eq(jiffies, tape->avg_time + HZ)) {
1213 tape->avg_speed = tape->avg_size * HZ /
1214 (jiffies - tape->avg_time) / 1024;
1216 tape->avg_time = jiffies;
1218 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1220 tape->first_frame += blocks;
1221 rq->current_nr_sectors -= blocks;
1223 if (!tape->pc->error)
1224 idetape_end_request(drive, 1, 0);
1226 idetape_end_request(drive, tape->pc->error, 0);
1230 static void idetape_create_read_cmd(idetape_tape_t *tape,
1231 struct ide_atapi_pc *pc,
1232 unsigned int length, struct idetape_bh *bh)
1234 idetape_init_pc(pc);
1236 put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
1238 pc->idetape_callback = &idetape_rw_callback;
1240 atomic_set(&bh->b_count, 0);
1242 pc->buf_size = length * tape->blk_size;
1243 pc->req_xfer = pc->buf_size;
1244 if (pc->req_xfer == tape->stage_size)
1245 pc->flags |= PC_FLAG_DMA_RECOMMENDED;
1248 static void idetape_create_write_cmd(idetape_tape_t *tape,
1249 struct ide_atapi_pc *pc,
1250 unsigned int length, struct idetape_bh *bh)
1252 idetape_init_pc(pc);
1254 put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
1256 pc->idetape_callback = &idetape_rw_callback;
1257 pc->flags |= PC_FLAG_WRITING;
1259 pc->b_data = bh->b_data;
1260 pc->b_count = atomic_read(&bh->b_count);
1262 pc->buf_size = length * tape->blk_size;
1263 pc->req_xfer = pc->buf_size;
1264 if (pc->req_xfer == tape->stage_size)
1265 pc->flags |= PC_FLAG_DMA_RECOMMENDED;
1268 static ide_startstop_t idetape_do_request(ide_drive_t *drive,
1269 struct request *rq, sector_t block)
1271 idetape_tape_t *tape = drive->driver_data;
1272 struct ide_atapi_pc *pc = NULL;
1273 struct request *postponed_rq = tape->postponed_rq;
1276 debug_log(DBG_SENSE, "sector: %ld, nr_sectors: %ld,"
1277 " current_nr_sectors: %d\n",
1278 rq->sector, rq->nr_sectors, rq->current_nr_sectors);
1280 if (!blk_special_request(rq)) {
1281 /* We do not support buffer cache originated requests. */
1282 printk(KERN_NOTICE "ide-tape: %s: Unsupported request in "
1283 "request queue (%d)\n", drive->name, rq->cmd_type);
1284 ide_end_request(drive, 0, 0);
1288 /* Retry a failed packet command */
1289 if (tape->failed_pc && tape->pc->c[0] == REQUEST_SENSE)
1290 return idetape_issue_pc(drive, tape->failed_pc);
1292 if (postponed_rq != NULL)
1293 if (rq != postponed_rq) {
1294 printk(KERN_ERR "ide-tape: ide-tape.c bug - "
1295 "Two DSC requests were queued\n");
1296 idetape_end_request(drive, 0, 0);
1300 tape->postponed_rq = NULL;
1303 * If the tape is still busy, postpone our request and service
1304 * the other device meanwhile.
1306 stat = ide_read_status(drive);
1308 if (!drive->dsc_overlap && !(rq->cmd[0] & REQ_IDETAPE_PC2))
1309 set_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags);
1311 if (drive->post_reset == 1) {
1312 set_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags);
1313 drive->post_reset = 0;
1316 if (time_after(jiffies, tape->insert_time))
1317 tape->insert_speed = tape->insert_size / 1024 * HZ /
1318 (jiffies - tape->insert_time);
1319 if (!test_and_clear_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags) &&
1320 (stat & SEEK_STAT) == 0) {
1321 if (postponed_rq == NULL) {
1322 tape->dsc_polling_start = jiffies;
1323 tape->dsc_poll_freq = tape->best_dsc_rw_freq;
1324 tape->dsc_timeout = jiffies + IDETAPE_DSC_RW_TIMEOUT;
1325 } else if (time_after(jiffies, tape->dsc_timeout)) {
1326 printk(KERN_ERR "ide-tape: %s: DSC timeout\n",
1328 if (rq->cmd[0] & REQ_IDETAPE_PC2) {
1329 idetape_media_access_finished(drive);
1332 return ide_do_reset(drive);
1334 } else if (time_after(jiffies,
1335 tape->dsc_polling_start +
1336 IDETAPE_DSC_MA_THRESHOLD))
1337 tape->dsc_poll_freq = IDETAPE_DSC_MA_SLOW;
1338 idetape_postpone_request(drive);
1341 if (rq->cmd[0] & REQ_IDETAPE_READ) {
1342 tape->postpone_cnt = 0;
1343 pc = idetape_next_pc_storage(drive);
1344 idetape_create_read_cmd(tape, pc, rq->current_nr_sectors,
1345 (struct idetape_bh *)rq->special);
1348 if (rq->cmd[0] & REQ_IDETAPE_WRITE) {
1349 tape->postpone_cnt = 0;
1350 pc = idetape_next_pc_storage(drive);
1351 idetape_create_write_cmd(tape, pc, rq->current_nr_sectors,
1352 (struct idetape_bh *)rq->special);
1355 if (rq->cmd[0] & REQ_IDETAPE_PC1) {
1356 pc = (struct ide_atapi_pc *) rq->buffer;
1357 rq->cmd[0] &= ~(REQ_IDETAPE_PC1);
1358 rq->cmd[0] |= REQ_IDETAPE_PC2;
1361 if (rq->cmd[0] & REQ_IDETAPE_PC2) {
1362 idetape_media_access_finished(drive);
1367 return idetape_issue_pc(drive, pc);
1370 /* Pipeline related functions */
1373 * The function below uses __get_free_page to allocate a pipeline stage, along
1374 * with all the necessary small buffers which together make a buffer of size
1375 * tape->stage_size (or a bit more). We attempt to combine sequential pages as
1378 * It returns a pointer to the new allocated stage, or NULL if we can't (or
1379 * don't want to) allocate a stage.
1381 * Pipeline stages are optional and are used to increase performance. If we
1382 * can't allocate them, we'll manage without them.
1384 static idetape_stage_t *__idetape_kmalloc_stage(idetape_tape_t *tape, int full,
1387 idetape_stage_t *stage;
1388 struct idetape_bh *prev_bh, *bh;
1389 int pages = tape->pages_per_stage;
1390 char *b_data = NULL;
1392 stage = kmalloc(sizeof(idetape_stage_t), GFP_KERNEL);
1397 stage->bh = kmalloc(sizeof(struct idetape_bh), GFP_KERNEL);
1401 bh->b_reqnext = NULL;
1402 bh->b_data = (char *) __get_free_page(GFP_KERNEL);
1406 memset(bh->b_data, 0, PAGE_SIZE);
1407 bh->b_size = PAGE_SIZE;
1408 atomic_set(&bh->b_count, full ? bh->b_size : 0);
1411 b_data = (char *) __get_free_page(GFP_KERNEL);
1415 memset(b_data, 0, PAGE_SIZE);
1416 if (bh->b_data == b_data + PAGE_SIZE) {
1417 bh->b_size += PAGE_SIZE;
1418 bh->b_data -= PAGE_SIZE;
1420 atomic_add(PAGE_SIZE, &bh->b_count);
1423 if (b_data == bh->b_data + bh->b_size) {
1424 bh->b_size += PAGE_SIZE;
1426 atomic_add(PAGE_SIZE, &bh->b_count);
1430 bh = kmalloc(sizeof(struct idetape_bh), GFP_KERNEL);
1432 free_page((unsigned long) b_data);
1435 bh->b_reqnext = NULL;
1436 bh->b_data = b_data;
1437 bh->b_size = PAGE_SIZE;
1438 atomic_set(&bh->b_count, full ? bh->b_size : 0);
1439 prev_bh->b_reqnext = bh;
1441 bh->b_size -= tape->excess_bh_size;
1443 atomic_sub(tape->excess_bh_size, &bh->b_count);
1446 __idetape_kfree_stage(stage);
1450 static int idetape_copy_stage_from_user(idetape_tape_t *tape,
1451 const char __user *buf, int n)
1453 struct idetape_bh *bh = tape->bh;
1459 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
1463 count = min((unsigned int)
1464 (bh->b_size - atomic_read(&bh->b_count)),
1466 if (copy_from_user(bh->b_data + atomic_read(&bh->b_count), buf,
1470 atomic_add(count, &bh->b_count);
1472 if (atomic_read(&bh->b_count) == bh->b_size) {
1475 atomic_set(&bh->b_count, 0);
1482 static int idetape_copy_stage_to_user(idetape_tape_t *tape, char __user *buf,
1485 struct idetape_bh *bh = tape->bh;
1491 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
1495 count = min(tape->b_count, n);
1496 if (copy_to_user(buf, tape->b_data, count))
1499 tape->b_data += count;
1500 tape->b_count -= count;
1502 if (!tape->b_count) {
1506 tape->b_data = bh->b_data;
1507 tape->b_count = atomic_read(&bh->b_count);
1514 static void idetape_init_merge_stage(idetape_tape_t *tape)
1516 struct idetape_bh *bh = tape->merge_stage->bh;
1519 if (tape->chrdev_dir == IDETAPE_DIR_WRITE)
1520 atomic_set(&bh->b_count, 0);
1522 tape->b_data = bh->b_data;
1523 tape->b_count = atomic_read(&bh->b_count);
1527 static ide_startstop_t idetape_read_position_callback(ide_drive_t *drive)
1529 idetape_tape_t *tape = drive->driver_data;
1530 u8 *readpos = tape->pc->buf;
1532 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1534 if (!tape->pc->error) {
1535 debug_log(DBG_SENSE, "BOP - %s\n",
1536 (readpos[0] & 0x80) ? "Yes" : "No");
1537 debug_log(DBG_SENSE, "EOP - %s\n",
1538 (readpos[0] & 0x40) ? "Yes" : "No");
1540 if (readpos[0] & 0x4) {
1541 printk(KERN_INFO "ide-tape: Block location is unknown"
1543 clear_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags);
1544 idetape_end_request(drive, 0, 0);
1546 debug_log(DBG_SENSE, "Block Location - %u\n",
1547 be32_to_cpu(*(u32 *)&readpos[4]));
1549 tape->partition = readpos[1];
1551 be32_to_cpu(*(u32 *)&readpos[4]);
1552 set_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags);
1553 idetape_end_request(drive, 1, 0);
1556 idetape_end_request(drive, 0, 0);
1562 * Write a filemark if write_filemark=1. Flush the device buffers without
1563 * writing a filemark otherwise.
1565 static void idetape_create_write_filemark_cmd(ide_drive_t *drive,
1566 struct ide_atapi_pc *pc, int write_filemark)
1568 idetape_init_pc(pc);
1569 pc->c[0] = WRITE_FILEMARKS;
1570 pc->c[4] = write_filemark;
1571 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1572 pc->idetape_callback = &idetape_pc_callback;
1575 static void idetape_create_test_unit_ready_cmd(struct ide_atapi_pc *pc)
1577 idetape_init_pc(pc);
1578 pc->c[0] = TEST_UNIT_READY;
1579 pc->idetape_callback = &idetape_pc_callback;
1583 * We add a special packet command request to the tail of the request queue, and
1584 * wait for it to be serviced. This is not to be called from within the request
1585 * handling part of the driver! We allocate here data on the stack and it is
1586 * valid until the request is finished. This is not the case for the bottom part
1587 * of the driver, where we are always leaving the functions to wait for an
1588 * interrupt or a timer event.
1590 * From the bottom part of the driver, we should allocate safe memory using
1591 * idetape_next_pc_storage() and ide_tape_next_rq_storage(), and add the request
1592 * to the request list without waiting for it to be serviced! In that case, we
1593 * usually use idetape_queue_pc_head().
1595 static int idetape_queue_pc_tail(ide_drive_t *drive, struct ide_atapi_pc *pc)
1597 struct ide_tape_obj *tape = drive->driver_data;
1600 idetape_init_rq(&rq, REQ_IDETAPE_PC1);
1601 rq.buffer = (char *) pc;
1602 rq.rq_disk = tape->disk;
1603 return ide_do_drive_cmd(drive, &rq, ide_wait);
1606 static void idetape_create_load_unload_cmd(ide_drive_t *drive,
1607 struct ide_atapi_pc *pc, int cmd)
1609 idetape_init_pc(pc);
1610 pc->c[0] = START_STOP;
1612 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1613 pc->idetape_callback = &idetape_pc_callback;
1616 static int idetape_wait_ready(ide_drive_t *drive, unsigned long timeout)
1618 idetape_tape_t *tape = drive->driver_data;
1619 struct ide_atapi_pc pc;
1620 int load_attempted = 0;
1622 /* Wait for the tape to become ready */
1623 set_bit(IDETAPE_FLAG_MEDIUM_PRESENT, &tape->flags);
1625 while (time_before(jiffies, timeout)) {
1626 idetape_create_test_unit_ready_cmd(&pc);
1627 if (!idetape_queue_pc_tail(drive, &pc))
1629 if ((tape->sense_key == 2 && tape->asc == 4 && tape->ascq == 2)
1630 || (tape->asc == 0x3A)) {
1634 idetape_create_load_unload_cmd(drive, &pc,
1635 IDETAPE_LU_LOAD_MASK);
1636 idetape_queue_pc_tail(drive, &pc);
1638 /* not about to be ready */
1639 } else if (!(tape->sense_key == 2 && tape->asc == 4 &&
1640 (tape->ascq == 1 || tape->ascq == 8)))
1647 static int idetape_flush_tape_buffers(ide_drive_t *drive)
1649 struct ide_atapi_pc pc;
1652 idetape_create_write_filemark_cmd(drive, &pc, 0);
1653 rc = idetape_queue_pc_tail(drive, &pc);
1656 idetape_wait_ready(drive, 60 * 5 * HZ);
1660 static void idetape_create_read_position_cmd(struct ide_atapi_pc *pc)
1662 idetape_init_pc(pc);
1663 pc->c[0] = READ_POSITION;
1665 pc->idetape_callback = &idetape_read_position_callback;
1668 static int idetape_read_position(ide_drive_t *drive)
1670 idetape_tape_t *tape = drive->driver_data;
1671 struct ide_atapi_pc pc;
1674 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1676 idetape_create_read_position_cmd(&pc);
1677 if (idetape_queue_pc_tail(drive, &pc))
1679 position = tape->first_frame;
1683 static void idetape_create_locate_cmd(ide_drive_t *drive,
1684 struct ide_atapi_pc *pc,
1685 unsigned int block, u8 partition, int skip)
1687 idetape_init_pc(pc);
1688 pc->c[0] = POSITION_TO_ELEMENT;
1690 put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[3]);
1691 pc->c[8] = partition;
1692 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1693 pc->idetape_callback = &idetape_pc_callback;
1696 static int idetape_create_prevent_cmd(ide_drive_t *drive,
1697 struct ide_atapi_pc *pc, int prevent)
1699 idetape_tape_t *tape = drive->driver_data;
1701 /* device supports locking according to capabilities page */
1702 if (!(tape->caps[6] & 0x01))
1705 idetape_init_pc(pc);
1706 pc->c[0] = ALLOW_MEDIUM_REMOVAL;
1708 pc->idetape_callback = &idetape_pc_callback;
1712 static int __idetape_discard_read_pipeline(ide_drive_t *drive)
1714 idetape_tape_t *tape = drive->driver_data;
1715 unsigned long flags;
1718 if (tape->chrdev_dir != IDETAPE_DIR_READ)
1721 /* Remove merge stage. */
1722 cnt = tape->merge_stage_size / tape->blk_size;
1723 if (test_and_clear_bit(IDETAPE_FLAG_FILEMARK, &tape->flags))
1724 ++cnt; /* Filemarks count as 1 sector */
1725 tape->merge_stage_size = 0;
1726 if (tape->merge_stage != NULL) {
1727 __idetape_kfree_stage(tape->merge_stage);
1728 tape->merge_stage = NULL;
1731 /* Clear pipeline flags. */
1732 clear_bit(IDETAPE_FLAG_PIPELINE_ERR, &tape->flags);
1733 tape->chrdev_dir = IDETAPE_DIR_NONE;
1735 /* Remove pipeline stages. */
1736 if (tape->first_stage == NULL)
1739 spin_lock_irqsave(&tape->lock, flags);
1740 tape->next_stage = NULL;
1741 spin_unlock_irqrestore(&tape->lock, flags);
1743 while (tape->first_stage != NULL) {
1744 struct request *rq_ptr = &tape->first_stage->rq;
1746 cnt += rq_ptr->nr_sectors - rq_ptr->current_nr_sectors;
1747 if (rq_ptr->errors == IDETAPE_ERROR_FILEMARK)
1750 tape->nr_pending_stages = 0;
1751 tape->max_stages = tape->min_pipeline;
1756 * Position the tape to the requested block using the LOCATE packet command.
1757 * A READ POSITION command is then issued to check where we are positioned. Like
1758 * all higher level operations, we queue the commands at the tail of the request
1759 * queue and wait for their completion.
1761 static int idetape_position_tape(ide_drive_t *drive, unsigned int block,
1762 u8 partition, int skip)
1764 idetape_tape_t *tape = drive->driver_data;
1766 struct ide_atapi_pc pc;
1768 if (tape->chrdev_dir == IDETAPE_DIR_READ)
1769 __idetape_discard_read_pipeline(drive);
1770 idetape_wait_ready(drive, 60 * 5 * HZ);
1771 idetape_create_locate_cmd(drive, &pc, block, partition, skip);
1772 retval = idetape_queue_pc_tail(drive, &pc);
1776 idetape_create_read_position_cmd(&pc);
1777 return (idetape_queue_pc_tail(drive, &pc));
1780 static void idetape_discard_read_pipeline(ide_drive_t *drive,
1781 int restore_position)
1783 idetape_tape_t *tape = drive->driver_data;
1787 cnt = __idetape_discard_read_pipeline(drive);
1788 if (restore_position) {
1789 position = idetape_read_position(drive);
1790 seek = position > cnt ? position - cnt : 0;
1791 if (idetape_position_tape(drive, seek, 0, 0)) {
1792 printk(KERN_INFO "ide-tape: %s: position_tape failed in"
1793 " discard_pipeline()\n", tape->name);
1800 * Generate a read/write request for the block device interface and wait for it
1803 static int idetape_queue_rw_tail(ide_drive_t *drive, int cmd, int blocks,
1804 struct idetape_bh *bh)
1806 idetape_tape_t *tape = drive->driver_data;
1809 debug_log(DBG_SENSE, "%s: cmd=%d\n", __func__, cmd);
1811 if (test_bit(IDETAPE_FLAG_PIPELINE_ACTIVE, &tape->flags)) {
1812 printk(KERN_ERR "ide-tape: bug: the pipeline is active in %s\n",
1817 idetape_init_rq(&rq, cmd);
1818 rq.rq_disk = tape->disk;
1819 rq.special = (void *)bh;
1820 rq.sector = tape->first_frame;
1821 rq.nr_sectors = blocks;
1822 rq.current_nr_sectors = blocks;
1823 (void) ide_do_drive_cmd(drive, &rq, ide_wait);
1825 if ((cmd & (REQ_IDETAPE_READ | REQ_IDETAPE_WRITE)) == 0)
1828 if (tape->merge_stage)
1829 idetape_init_merge_stage(tape);
1830 if (rq.errors == IDETAPE_ERROR_GENERAL)
1832 return (tape->blk_size * (blocks-rq.current_nr_sectors));
1835 static void idetape_create_inquiry_cmd(struct ide_atapi_pc *pc)
1837 idetape_init_pc(pc);
1841 pc->idetape_callback = &idetape_pc_callback;
1844 static void idetape_create_rewind_cmd(ide_drive_t *drive,
1845 struct ide_atapi_pc *pc)
1847 idetape_init_pc(pc);
1848 pc->c[0] = REZERO_UNIT;
1849 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1850 pc->idetape_callback = &idetape_pc_callback;
1853 static void idetape_create_erase_cmd(struct ide_atapi_pc *pc)
1855 idetape_init_pc(pc);
1858 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1859 pc->idetape_callback = &idetape_pc_callback;
1862 static void idetape_create_space_cmd(struct ide_atapi_pc *pc, int count, u8 cmd)
1864 idetape_init_pc(pc);
1866 put_unaligned(cpu_to_be32(count), (unsigned int *) &pc->c[1]);
1868 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1869 pc->idetape_callback = &idetape_pc_callback;
1872 /* Queue up a character device originated write request. */
1873 static int idetape_add_chrdev_write_request(ide_drive_t *drive, int blocks)
1875 idetape_tape_t *tape = drive->driver_data;
1877 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
1879 return idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE,
1880 blocks, tape->merge_stage->bh);
1883 static void idetape_empty_write_pipeline(ide_drive_t *drive)
1885 idetape_tape_t *tape = drive->driver_data;
1887 struct idetape_bh *bh;
1889 if (tape->chrdev_dir != IDETAPE_DIR_WRITE) {
1890 printk(KERN_ERR "ide-tape: bug: Trying to empty write pipeline,"
1891 " but we are not writing.\n");
1894 if (tape->merge_stage_size > tape->stage_size) {
1895 printk(KERN_ERR "ide-tape: bug: merge_buffer too big\n");
1896 tape->merge_stage_size = tape->stage_size;
1898 if (tape->merge_stage_size) {
1899 blocks = tape->merge_stage_size / tape->blk_size;
1900 if (tape->merge_stage_size % tape->blk_size) {
1904 i = tape->blk_size - tape->merge_stage_size %
1906 bh = tape->bh->b_reqnext;
1908 atomic_set(&bh->b_count, 0);
1914 printk(KERN_INFO "ide-tape: bug,"
1918 min = min(i, (unsigned int)(bh->b_size -
1919 atomic_read(&bh->b_count)));
1920 memset(bh->b_data + atomic_read(&bh->b_count),
1922 atomic_add(min, &bh->b_count);
1927 (void) idetape_add_chrdev_write_request(drive, blocks);
1928 tape->merge_stage_size = 0;
1930 if (tape->merge_stage != NULL) {
1931 __idetape_kfree_stage(tape->merge_stage);
1932 tape->merge_stage = NULL;
1934 clear_bit(IDETAPE_FLAG_PIPELINE_ERR, &tape->flags);
1935 tape->chrdev_dir = IDETAPE_DIR_NONE;
1938 * On the next backup, perform the feedback loop again. (I don't want to
1939 * keep sense information between backups, as some systems are
1940 * constantly on, and the system load can be totally different on the
1943 tape->max_stages = tape->min_pipeline;
1944 if (tape->first_stage != NULL ||
1945 tape->next_stage != NULL ||
1946 tape->last_stage != NULL ||
1947 tape->nr_stages != 0) {
1948 printk(KERN_ERR "ide-tape: ide-tape pipeline bug, "
1949 "first_stage %p, next_stage %p, "
1950 "last_stage %p, nr_stages %d\n",
1951 tape->first_stage, tape->next_stage,
1952 tape->last_stage, tape->nr_stages);
1956 static int idetape_init_read(ide_drive_t *drive, int max_stages)
1958 idetape_tape_t *tape = drive->driver_data;
1961 /* Initialize read operation */
1962 if (tape->chrdev_dir != IDETAPE_DIR_READ) {
1963 if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
1964 idetape_empty_write_pipeline(drive);
1965 idetape_flush_tape_buffers(drive);
1967 if (tape->merge_stage || tape->merge_stage_size) {
1968 printk(KERN_ERR "ide-tape: merge_stage_size should be"
1970 tape->merge_stage_size = 0;
1972 tape->merge_stage = __idetape_kmalloc_stage(tape, 0, 0);
1973 if (!tape->merge_stage)
1975 tape->chrdev_dir = IDETAPE_DIR_READ;
1978 * Issue a read 0 command to ensure that DSC handshake is
1979 * switched from completion mode to buffer available mode.
1980 * No point in issuing this if DSC overlap isn't supported, some
1981 * drives (Seagate STT3401A) will return an error.
1983 if (drive->dsc_overlap) {
1984 bytes_read = idetape_queue_rw_tail(drive,
1985 REQ_IDETAPE_READ, 0,
1986 tape->merge_stage->bh);
1987 if (bytes_read < 0) {
1988 __idetape_kfree_stage(tape->merge_stage);
1989 tape->merge_stage = NULL;
1990 tape->chrdev_dir = IDETAPE_DIR_NONE;
1996 if (!test_bit(IDETAPE_FLAG_PIPELINE_ACTIVE, &tape->flags)) {
1997 if (tape->nr_pending_stages >= 3 * max_stages / 4) {
1998 tape->measure_insert_time = 1;
1999 tape->insert_time = jiffies;
2000 tape->insert_size = 0;
2001 tape->insert_speed = 0;
2008 * Called from idetape_chrdev_read() to service a character device read request
2009 * and add read-ahead requests to our pipeline.
2011 static int idetape_add_chrdev_read_request(ide_drive_t *drive, int blocks)
2013 idetape_tape_t *tape = drive->driver_data;
2015 debug_log(DBG_PROCS, "Enter %s, %d blocks\n", __func__, blocks);
2017 /* If we are at a filemark, return a read length of 0 */
2018 if (test_bit(IDETAPE_FLAG_FILEMARK, &tape->flags))
2021 idetape_init_read(drive, tape->max_stages);
2023 if (test_bit(IDETAPE_FLAG_PIPELINE_ERR, &tape->flags))
2026 return idetape_queue_rw_tail(drive, REQ_IDETAPE_READ, blocks,
2027 tape->merge_stage->bh);
2030 static void idetape_pad_zeros(ide_drive_t *drive, int bcount)
2032 idetape_tape_t *tape = drive->driver_data;
2033 struct idetape_bh *bh;
2039 bh = tape->merge_stage->bh;
2040 count = min(tape->stage_size, bcount);
2042 blocks = count / tape->blk_size;
2044 atomic_set(&bh->b_count,
2045 min(count, (unsigned int)bh->b_size));
2046 memset(bh->b_data, 0, atomic_read(&bh->b_count));
2047 count -= atomic_read(&bh->b_count);
2050 idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE, blocks,
2051 tape->merge_stage->bh);
2056 * Rewinds the tape to the Beginning Of the current Partition (BOP). We
2057 * currently support only one partition.
2059 static int idetape_rewind_tape(ide_drive_t *drive)
2062 struct ide_atapi_pc pc;
2063 idetape_tape_t *tape;
2064 tape = drive->driver_data;
2066 debug_log(DBG_SENSE, "Enter %s\n", __func__);
2068 idetape_create_rewind_cmd(drive, &pc);
2069 retval = idetape_queue_pc_tail(drive, &pc);
2073 idetape_create_read_position_cmd(&pc);
2074 retval = idetape_queue_pc_tail(drive, &pc);
2080 /* mtio.h compatible commands should be issued to the chrdev interface. */
2081 static int idetape_blkdev_ioctl(ide_drive_t *drive, unsigned int cmd,
2084 idetape_tape_t *tape = drive->driver_data;
2085 void __user *argp = (void __user *)arg;
2087 struct idetape_config {
2088 int dsc_rw_frequency;
2089 int dsc_media_access_frequency;
2093 debug_log(DBG_PROCS, "Enter %s\n", __func__);
2097 if (copy_from_user(&config, argp, sizeof(config)))
2099 tape->best_dsc_rw_freq = config.dsc_rw_frequency;
2100 tape->max_stages = config.nr_stages;
2103 config.dsc_rw_frequency = (int) tape->best_dsc_rw_freq;
2104 config.nr_stages = tape->max_stages;
2105 if (copy_to_user(argp, &config, sizeof(config)))
2114 static int idetape_space_over_filemarks(ide_drive_t *drive, short mt_op,
2117 idetape_tape_t *tape = drive->driver_data;
2118 struct ide_atapi_pc pc;
2119 int retval, count = 0;
2120 int sprev = !!(tape->caps[4] & 0x20);
2124 if (MTBSF == mt_op || MTBSFM == mt_op) {
2127 mt_count = -mt_count;
2130 if (tape->chrdev_dir == IDETAPE_DIR_READ) {
2131 tape->merge_stage_size = 0;
2132 if (test_and_clear_bit(IDETAPE_FLAG_FILEMARK, &tape->flags))
2134 idetape_discard_read_pipeline(drive, 0);
2138 * The filemark was not found in our internal pipeline; now we can issue
2139 * the space command.
2144 idetape_create_space_cmd(&pc, mt_count - count,
2145 IDETAPE_SPACE_OVER_FILEMARK);
2146 return idetape_queue_pc_tail(drive, &pc);
2151 retval = idetape_space_over_filemarks(drive, MTFSF,
2155 count = (MTBSFM == mt_op ? 1 : -1);
2156 return idetape_space_over_filemarks(drive, MTFSF, count);
2158 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
2165 * Our character device read / write functions.
2167 * The tape is optimized to maximize throughput when it is transferring an
2168 * integral number of the "continuous transfer limit", which is a parameter of
2169 * the specific tape (26kB on my particular tape, 32kB for Onstream).
2171 * As of version 1.3 of the driver, the character device provides an abstract
2172 * continuous view of the media - any mix of block sizes (even 1 byte) on the
2173 * same backup/restore procedure is supported. The driver will internally
2174 * convert the requests to the recommended transfer unit, so that an unmatch
2175 * between the user's block size to the recommended size will only result in a
2176 * (slightly) increased driver overhead, but will no longer hit performance.
2177 * This is not applicable to Onstream.
2179 static ssize_t idetape_chrdev_read(struct file *file, char __user *buf,
2180 size_t count, loff_t *ppos)
2182 struct ide_tape_obj *tape = ide_tape_f(file);
2183 ide_drive_t *drive = tape->drive;
2184 ssize_t bytes_read, temp, actually_read = 0, rc;
2186 u16 ctl = *(u16 *)&tape->caps[12];
2188 debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
2190 if (tape->chrdev_dir != IDETAPE_DIR_READ) {
2191 if (test_bit(IDETAPE_FLAG_DETECT_BS, &tape->flags))
2192 if (count > tape->blk_size &&
2193 (count % tape->blk_size) == 0)
2194 tape->user_bs_factor = count / tape->blk_size;
2196 rc = idetape_init_read(drive, tape->max_stages);
2201 if (tape->merge_stage_size) {
2202 actually_read = min((unsigned int)(tape->merge_stage_size),
2203 (unsigned int)count);
2204 if (idetape_copy_stage_to_user(tape, buf, actually_read))
2206 buf += actually_read;
2207 tape->merge_stage_size -= actually_read;
2208 count -= actually_read;
2210 while (count >= tape->stage_size) {
2211 bytes_read = idetape_add_chrdev_read_request(drive, ctl);
2212 if (bytes_read <= 0)
2214 if (idetape_copy_stage_to_user(tape, buf, bytes_read))
2217 count -= bytes_read;
2218 actually_read += bytes_read;
2221 bytes_read = idetape_add_chrdev_read_request(drive, ctl);
2222 if (bytes_read <= 0)
2224 temp = min((unsigned long)count, (unsigned long)bytes_read);
2225 if (idetape_copy_stage_to_user(tape, buf, temp))
2227 actually_read += temp;
2228 tape->merge_stage_size = bytes_read-temp;
2231 if (!actually_read && test_bit(IDETAPE_FLAG_FILEMARK, &tape->flags)) {
2232 debug_log(DBG_SENSE, "%s: spacing over filemark\n", tape->name);
2234 idetape_space_over_filemarks(drive, MTFSF, 1);
2238 return ret ? ret : actually_read;
2241 static ssize_t idetape_chrdev_write(struct file *file, const char __user *buf,
2242 size_t count, loff_t *ppos)
2244 struct ide_tape_obj *tape = ide_tape_f(file);
2245 ide_drive_t *drive = tape->drive;
2246 ssize_t actually_written = 0;
2248 u16 ctl = *(u16 *)&tape->caps[12];
2250 /* The drive is write protected. */
2251 if (tape->write_prot)
2254 debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
2256 /* Initialize write operation */
2257 if (tape->chrdev_dir != IDETAPE_DIR_WRITE) {
2258 if (tape->chrdev_dir == IDETAPE_DIR_READ)
2259 idetape_discard_read_pipeline(drive, 1);
2260 if (tape->merge_stage || tape->merge_stage_size) {
2261 printk(KERN_ERR "ide-tape: merge_stage_size "
2262 "should be 0 now\n");
2263 tape->merge_stage_size = 0;
2265 tape->merge_stage = __idetape_kmalloc_stage(tape, 0, 0);
2266 if (!tape->merge_stage)
2268 tape->chrdev_dir = IDETAPE_DIR_WRITE;
2269 idetape_init_merge_stage(tape);
2272 * Issue a write 0 command to ensure that DSC handshake is
2273 * switched from completion mode to buffer available mode. No
2274 * point in issuing this if DSC overlap isn't supported, some
2275 * drives (Seagate STT3401A) will return an error.
2277 if (drive->dsc_overlap) {
2278 ssize_t retval = idetape_queue_rw_tail(drive,
2279 REQ_IDETAPE_WRITE, 0,
2280 tape->merge_stage->bh);
2282 __idetape_kfree_stage(tape->merge_stage);
2283 tape->merge_stage = NULL;
2284 tape->chrdev_dir = IDETAPE_DIR_NONE;
2291 if (tape->merge_stage_size) {
2292 if (tape->merge_stage_size >= tape->stage_size) {
2293 printk(KERN_ERR "ide-tape: bug: merge buf too big\n");
2294 tape->merge_stage_size = 0;
2296 actually_written = min((unsigned int)
2297 (tape->stage_size - tape->merge_stage_size),
2298 (unsigned int)count);
2299 if (idetape_copy_stage_from_user(tape, buf, actually_written))
2301 buf += actually_written;
2302 tape->merge_stage_size += actually_written;
2303 count -= actually_written;
2305 if (tape->merge_stage_size == tape->stage_size) {
2307 tape->merge_stage_size = 0;
2308 retval = idetape_add_chrdev_write_request(drive, ctl);
2313 while (count >= tape->stage_size) {
2315 if (idetape_copy_stage_from_user(tape, buf, tape->stage_size))
2317 buf += tape->stage_size;
2318 count -= tape->stage_size;
2319 retval = idetape_add_chrdev_write_request(drive, ctl);
2320 actually_written += tape->stage_size;
2325 actually_written += count;
2326 if (idetape_copy_stage_from_user(tape, buf, count))
2328 tape->merge_stage_size += count;
2330 return ret ? ret : actually_written;
2333 static int idetape_write_filemark(ide_drive_t *drive)
2335 struct ide_atapi_pc pc;
2337 /* Write a filemark */
2338 idetape_create_write_filemark_cmd(drive, &pc, 1);
2339 if (idetape_queue_pc_tail(drive, &pc)) {
2340 printk(KERN_ERR "ide-tape: Couldn't write a filemark\n");
2347 * Called from idetape_chrdev_ioctl when the general mtio MTIOCTOP ioctl is
2350 * Note: MTBSF and MTBSFM are not supported when the tape doesn't support
2351 * spacing over filemarks in the reverse direction. In this case, MTFSFM is also
2352 * usually not supported (it is supported in the rare case in which we crossed
2353 * the filemark during our read-ahead pipelined operation mode).
2355 * The following commands are currently not supported:
2357 * MTFSS, MTBSS, MTWSM, MTSETDENSITY, MTSETDRVBUFFER, MT_ST_BOOLEANS,
2358 * MT_ST_WRITE_THRESHOLD.
2360 static int idetape_mtioctop(ide_drive_t *drive, short mt_op, int mt_count)
2362 idetape_tape_t *tape = drive->driver_data;
2363 struct ide_atapi_pc pc;
2366 debug_log(DBG_ERR, "Handling MTIOCTOP ioctl: mt_op=%d, mt_count=%d\n",
2369 /* Commands which need our pipelined read-ahead stages. */
2377 return idetape_space_over_filemarks(drive, mt_op, mt_count);
2384 if (tape->write_prot)
2386 idetape_discard_read_pipeline(drive, 1);
2387 for (i = 0; i < mt_count; i++) {
2388 retval = idetape_write_filemark(drive);
2394 idetape_discard_read_pipeline(drive, 0);
2395 if (idetape_rewind_tape(drive))
2399 idetape_discard_read_pipeline(drive, 0);
2400 idetape_create_load_unload_cmd(drive, &pc,
2401 IDETAPE_LU_LOAD_MASK);
2402 return idetape_queue_pc_tail(drive, &pc);
2406 * If door is locked, attempt to unlock before
2407 * attempting to eject.
2409 if (tape->door_locked) {
2410 if (idetape_create_prevent_cmd(drive, &pc, 0))
2411 if (!idetape_queue_pc_tail(drive, &pc))
2412 tape->door_locked = DOOR_UNLOCKED;
2414 idetape_discard_read_pipeline(drive, 0);
2415 idetape_create_load_unload_cmd(drive, &pc,
2416 !IDETAPE_LU_LOAD_MASK);
2417 retval = idetape_queue_pc_tail(drive, &pc);
2419 clear_bit(IDETAPE_FLAG_MEDIUM_PRESENT, &tape->flags);
2422 idetape_discard_read_pipeline(drive, 0);
2423 return idetape_flush_tape_buffers(drive);
2425 idetape_discard_read_pipeline(drive, 0);
2426 idetape_create_load_unload_cmd(drive, &pc,
2427 IDETAPE_LU_RETENSION_MASK | IDETAPE_LU_LOAD_MASK);
2428 return idetape_queue_pc_tail(drive, &pc);
2430 idetape_create_space_cmd(&pc, 0, IDETAPE_SPACE_TO_EOD);
2431 return idetape_queue_pc_tail(drive, &pc);
2433 (void)idetape_rewind_tape(drive);
2434 idetape_create_erase_cmd(&pc);
2435 return idetape_queue_pc_tail(drive, &pc);
2438 if (mt_count < tape->blk_size ||
2439 mt_count % tape->blk_size)
2441 tape->user_bs_factor = mt_count / tape->blk_size;
2442 clear_bit(IDETAPE_FLAG_DETECT_BS, &tape->flags);
2444 set_bit(IDETAPE_FLAG_DETECT_BS, &tape->flags);
2447 idetape_discard_read_pipeline(drive, 0);
2448 return idetape_position_tape(drive,
2449 mt_count * tape->user_bs_factor, tape->partition, 0);
2451 idetape_discard_read_pipeline(drive, 0);
2452 return idetape_position_tape(drive, 0, mt_count, 0);
2456 if (!idetape_create_prevent_cmd(drive, &pc, 1))
2458 retval = idetape_queue_pc_tail(drive, &pc);
2461 tape->door_locked = DOOR_EXPLICITLY_LOCKED;
2464 if (!idetape_create_prevent_cmd(drive, &pc, 0))
2466 retval = idetape_queue_pc_tail(drive, &pc);
2469 tape->door_locked = DOOR_UNLOCKED;
2472 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
2479 * Our character device ioctls. General mtio.h magnetic io commands are
2480 * supported here, and not in the corresponding block interface. Our own
2481 * ide-tape ioctls are supported on both interfaces.
2483 static int idetape_chrdev_ioctl(struct inode *inode, struct file *file,
2484 unsigned int cmd, unsigned long arg)
2486 struct ide_tape_obj *tape = ide_tape_f(file);
2487 ide_drive_t *drive = tape->drive;
2491 int block_offset = 0, position = tape->first_frame;
2492 void __user *argp = (void __user *)arg;
2494 debug_log(DBG_CHRDEV, "Enter %s, cmd=%u\n", __func__, cmd);
2496 if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
2497 idetape_empty_write_pipeline(drive);
2498 idetape_flush_tape_buffers(drive);
2500 if (cmd == MTIOCGET || cmd == MTIOCPOS) {
2501 block_offset = tape->merge_stage_size /
2502 (tape->blk_size * tape->user_bs_factor);
2503 position = idetape_read_position(drive);
2509 if (copy_from_user(&mtop, argp, sizeof(struct mtop)))
2511 return idetape_mtioctop(drive, mtop.mt_op, mtop.mt_count);
2513 memset(&mtget, 0, sizeof(struct mtget));
2514 mtget.mt_type = MT_ISSCSI2;
2515 mtget.mt_blkno = position / tape->user_bs_factor - block_offset;
2517 ((tape->blk_size * tape->user_bs_factor)
2518 << MT_ST_BLKSIZE_SHIFT) & MT_ST_BLKSIZE_MASK;
2520 if (tape->drv_write_prot)
2521 mtget.mt_gstat |= GMT_WR_PROT(0xffffffff);
2523 if (copy_to_user(argp, &mtget, sizeof(struct mtget)))
2527 mtpos.mt_blkno = position / tape->user_bs_factor - block_offset;
2528 if (copy_to_user(argp, &mtpos, sizeof(struct mtpos)))
2532 if (tape->chrdev_dir == IDETAPE_DIR_READ)
2533 idetape_discard_read_pipeline(drive, 1);
2534 return idetape_blkdev_ioctl(drive, cmd, arg);
2539 * Do a mode sense page 0 with block descriptor and if it succeeds set the tape
2540 * block size with the reported value.
2542 static void ide_tape_get_bsize_from_bdesc(ide_drive_t *drive)
2544 idetape_tape_t *tape = drive->driver_data;
2545 struct ide_atapi_pc pc;
2547 idetape_create_mode_sense_cmd(&pc, IDETAPE_BLOCK_DESCRIPTOR);
2548 if (idetape_queue_pc_tail(drive, &pc)) {
2549 printk(KERN_ERR "ide-tape: Can't get block descriptor\n");
2550 if (tape->blk_size == 0) {
2551 printk(KERN_WARNING "ide-tape: Cannot deal with zero "
2552 "block size, assuming 32k\n");
2553 tape->blk_size = 32768;
2557 tape->blk_size = (pc.buf[4 + 5] << 16) +
2558 (pc.buf[4 + 6] << 8) +
2560 tape->drv_write_prot = (pc.buf[2] & 0x80) >> 7;
2563 static int idetape_chrdev_open(struct inode *inode, struct file *filp)
2565 unsigned int minor = iminor(inode), i = minor & ~0xc0;
2567 idetape_tape_t *tape;
2568 struct ide_atapi_pc pc;
2571 if (i >= MAX_HWIFS * MAX_DRIVES)
2574 tape = ide_tape_chrdev_get(i);
2578 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
2581 * We really want to do nonseekable_open(inode, filp); here, but some
2582 * versions of tar incorrectly call lseek on tapes and bail out if that
2583 * fails. So we disallow pread() and pwrite(), but permit lseeks.
2585 filp->f_mode &= ~(FMODE_PREAD | FMODE_PWRITE);
2587 drive = tape->drive;
2589 filp->private_data = tape;
2591 if (test_and_set_bit(IDETAPE_FLAG_BUSY, &tape->flags)) {
2596 retval = idetape_wait_ready(drive, 60 * HZ);
2598 clear_bit(IDETAPE_FLAG_BUSY, &tape->flags);
2599 printk(KERN_ERR "ide-tape: %s: drive not ready\n", tape->name);
2603 idetape_read_position(drive);
2604 if (!test_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags))
2605 (void)idetape_rewind_tape(drive);
2607 if (tape->chrdev_dir != IDETAPE_DIR_READ)
2608 clear_bit(IDETAPE_FLAG_PIPELINE_ERR, &tape->flags);
2610 /* Read block size and write protect status from drive. */
2611 ide_tape_get_bsize_from_bdesc(drive);
2613 /* Set write protect flag if device is opened as read-only. */
2614 if ((filp->f_flags & O_ACCMODE) == O_RDONLY)
2615 tape->write_prot = 1;
2617 tape->write_prot = tape->drv_write_prot;
2619 /* Make sure drive isn't write protected if user wants to write. */
2620 if (tape->write_prot) {
2621 if ((filp->f_flags & O_ACCMODE) == O_WRONLY ||
2622 (filp->f_flags & O_ACCMODE) == O_RDWR) {
2623 clear_bit(IDETAPE_FLAG_BUSY, &tape->flags);
2629 /* Lock the tape drive door so user can't eject. */
2630 if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
2631 if (idetape_create_prevent_cmd(drive, &pc, 1)) {
2632 if (!idetape_queue_pc_tail(drive, &pc)) {
2633 if (tape->door_locked != DOOR_EXPLICITLY_LOCKED)
2634 tape->door_locked = DOOR_LOCKED;
2645 static void idetape_write_release(ide_drive_t *drive, unsigned int minor)
2647 idetape_tape_t *tape = drive->driver_data;
2649 idetape_empty_write_pipeline(drive);
2650 tape->merge_stage = __idetape_kmalloc_stage(tape, 1, 0);
2651 if (tape->merge_stage != NULL) {
2652 idetape_pad_zeros(drive, tape->blk_size *
2653 (tape->user_bs_factor - 1));
2654 __idetape_kfree_stage(tape->merge_stage);
2655 tape->merge_stage = NULL;
2657 idetape_write_filemark(drive);
2658 idetape_flush_tape_buffers(drive);
2659 idetape_flush_tape_buffers(drive);
2662 static int idetape_chrdev_release(struct inode *inode, struct file *filp)
2664 struct ide_tape_obj *tape = ide_tape_f(filp);
2665 ide_drive_t *drive = tape->drive;
2666 struct ide_atapi_pc pc;
2667 unsigned int minor = iminor(inode);
2670 tape = drive->driver_data;
2672 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
2674 if (tape->chrdev_dir == IDETAPE_DIR_WRITE)
2675 idetape_write_release(drive, minor);
2676 if (tape->chrdev_dir == IDETAPE_DIR_READ) {
2678 idetape_discard_read_pipeline(drive, 1);
2681 if (minor < 128 && test_bit(IDETAPE_FLAG_MEDIUM_PRESENT, &tape->flags))
2682 (void) idetape_rewind_tape(drive);
2683 if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
2684 if (tape->door_locked == DOOR_LOCKED) {
2685 if (idetape_create_prevent_cmd(drive, &pc, 0)) {
2686 if (!idetape_queue_pc_tail(drive, &pc))
2687 tape->door_locked = DOOR_UNLOCKED;
2691 clear_bit(IDETAPE_FLAG_BUSY, &tape->flags);
2698 * check the contents of the ATAPI IDENTIFY command results. We return:
2700 * 1 - If the tape can be supported by us, based on the information we have so
2703 * 0 - If this tape driver is not currently supported by us.
2705 static int idetape_identify_device(ide_drive_t *drive)
2707 u8 gcw[2], protocol, device_type, removable, packet_size;
2709 if (drive->id_read == 0)
2712 *((unsigned short *) &gcw) = drive->id->config;
2714 protocol = (gcw[1] & 0xC0) >> 6;
2715 device_type = gcw[1] & 0x1F;
2716 removable = !!(gcw[0] & 0x80);
2717 packet_size = gcw[0] & 0x3;
2719 /* Check that we can support this device */
2721 printk(KERN_ERR "ide-tape: Protocol (0x%02x) is not ATAPI\n",
2723 else if (device_type != 1)
2724 printk(KERN_ERR "ide-tape: Device type (0x%02x) is not set "
2725 "to tape\n", device_type);
2726 else if (!removable)
2727 printk(KERN_ERR "ide-tape: The removable flag is not set\n");
2728 else if (packet_size != 0) {
2729 printk(KERN_ERR "ide-tape: Packet size (0x%02x) is not 12"
2730 " bytes\n", packet_size);
2736 static void idetape_get_inquiry_results(ide_drive_t *drive)
2738 idetape_tape_t *tape = drive->driver_data;
2739 struct ide_atapi_pc pc;
2740 char fw_rev[6], vendor_id[10], product_id[18];
2742 idetape_create_inquiry_cmd(&pc);
2743 if (idetape_queue_pc_tail(drive, &pc)) {
2744 printk(KERN_ERR "ide-tape: %s: can't get INQUIRY results\n",
2748 memcpy(vendor_id, &pc.buf[8], 8);
2749 memcpy(product_id, &pc.buf[16], 16);
2750 memcpy(fw_rev, &pc.buf[32], 4);
2752 ide_fixstring(vendor_id, 10, 0);
2753 ide_fixstring(product_id, 18, 0);
2754 ide_fixstring(fw_rev, 6, 0);
2756 printk(KERN_INFO "ide-tape: %s <-> %s: %s %s rev %s\n",
2757 drive->name, tape->name, vendor_id, product_id, fw_rev);
2761 * Ask the tape about its various parameters. In particular, we will adjust our
2762 * data transfer buffer size to the recommended value as returned by the tape.
2764 static void idetape_get_mode_sense_results(ide_drive_t *drive)
2766 idetape_tape_t *tape = drive->driver_data;
2767 struct ide_atapi_pc pc;
2769 u8 speed, max_speed;
2771 idetape_create_mode_sense_cmd(&pc, IDETAPE_CAPABILITIES_PAGE);
2772 if (idetape_queue_pc_tail(drive, &pc)) {
2773 printk(KERN_ERR "ide-tape: Can't get tape parameters - assuming"
2774 " some default values\n");
2775 tape->blk_size = 512;
2776 put_unaligned(52, (u16 *)&tape->caps[12]);
2777 put_unaligned(540, (u16 *)&tape->caps[14]);
2778 put_unaligned(6*52, (u16 *)&tape->caps[16]);
2781 caps = pc.buf + 4 + pc.buf[3];
2783 /* convert to host order and save for later use */
2784 speed = be16_to_cpu(*(u16 *)&caps[14]);
2785 max_speed = be16_to_cpu(*(u16 *)&caps[8]);
2787 put_unaligned(max_speed, (u16 *)&caps[8]);
2788 put_unaligned(be16_to_cpu(*(u16 *)&caps[12]), (u16 *)&caps[12]);
2789 put_unaligned(speed, (u16 *)&caps[14]);
2790 put_unaligned(be16_to_cpu(*(u16 *)&caps[16]), (u16 *)&caps[16]);
2793 printk(KERN_INFO "ide-tape: %s: invalid tape speed "
2794 "(assuming 650KB/sec)\n", drive->name);
2795 put_unaligned(650, (u16 *)&caps[14]);
2798 printk(KERN_INFO "ide-tape: %s: invalid max_speed "
2799 "(assuming 650KB/sec)\n", drive->name);
2800 put_unaligned(650, (u16 *)&caps[8]);
2803 memcpy(&tape->caps, caps, 20);
2805 tape->blk_size = 512;
2806 else if (caps[7] & 0x04)
2807 tape->blk_size = 1024;
2810 #ifdef CONFIG_IDE_PROC_FS
2811 static void idetape_add_settings(ide_drive_t *drive)
2813 idetape_tape_t *tape = drive->driver_data;
2815 ide_add_setting(drive, "buffer", SETTING_READ, TYPE_SHORT, 0, 0xffff,
2816 1, 2, (u16 *)&tape->caps[16], NULL);
2817 ide_add_setting(drive, "pipeline_min", SETTING_RW, TYPE_INT, 1, 0xffff,
2818 tape->stage_size / 1024, 1, &tape->min_pipeline, NULL);
2819 ide_add_setting(drive, "pipeline", SETTING_RW, TYPE_INT, 1, 0xffff,
2820 tape->stage_size / 1024, 1, &tape->max_stages, NULL);
2821 ide_add_setting(drive, "pipeline_max", SETTING_RW, TYPE_INT, 1, 0xffff,
2822 tape->stage_size / 1024, 1, &tape->max_pipeline, NULL);
2823 ide_add_setting(drive, "pipeline_used", SETTING_READ, TYPE_INT, 0,
2824 0xffff, tape->stage_size / 1024, 1, &tape->nr_stages,
2826 ide_add_setting(drive, "pipeline_pending", SETTING_READ, TYPE_INT, 0,
2827 0xffff, tape->stage_size / 1024, 1,
2828 &tape->nr_pending_stages, NULL);
2829 ide_add_setting(drive, "speed", SETTING_READ, TYPE_SHORT, 0, 0xffff,
2830 1, 1, (u16 *)&tape->caps[14], NULL);
2831 ide_add_setting(drive, "stage", SETTING_READ, TYPE_INT, 0, 0xffff, 1,
2832 1024, &tape->stage_size, NULL);
2833 ide_add_setting(drive, "tdsc", SETTING_RW, TYPE_INT, IDETAPE_DSC_RW_MIN,
2834 IDETAPE_DSC_RW_MAX, 1000, HZ, &tape->best_dsc_rw_freq,
2836 ide_add_setting(drive, "dsc_overlap", SETTING_RW, TYPE_BYTE, 0, 1, 1,
2837 1, &drive->dsc_overlap, NULL);
2838 ide_add_setting(drive, "avg_speed", SETTING_READ, TYPE_INT, 0, 0xffff,
2839 1, 1, &tape->avg_speed, NULL);
2840 ide_add_setting(drive, "debug_mask", SETTING_RW, TYPE_INT, 0, 0xffff, 1,
2841 1, &tape->debug_mask, NULL);
2844 static inline void idetape_add_settings(ide_drive_t *drive) { ; }
2848 * The function below is called to:
2850 * 1. Initialize our various state variables.
2851 * 2. Ask the tape for its capabilities.
2852 * 3. Allocate a buffer which will be used for data transfer. The buffer size
2853 * is chosen based on the recommendation which we received in step 2.
2855 * Note that at this point ide.c already assigned us an irq, so that we can
2856 * queue requests here and wait for their completion.
2858 static void idetape_setup(ide_drive_t *drive, idetape_tape_t *tape, int minor)
2860 unsigned long t1, tmid, tn, t;
2865 u16 *ctl = (u16 *)&tape->caps[12];
2867 spin_lock_init(&tape->lock);
2868 drive->dsc_overlap = 1;
2869 if (drive->hwif->host_flags & IDE_HFLAG_NO_DSC) {
2870 printk(KERN_INFO "ide-tape: %s: disabling DSC overlap\n",
2872 drive->dsc_overlap = 0;
2874 /* Seagate Travan drives do not support DSC overlap. */
2875 if (strstr(drive->id->model, "Seagate STT3401"))
2876 drive->dsc_overlap = 0;
2877 tape->minor = minor;
2878 tape->name[0] = 'h';
2879 tape->name[1] = 't';
2880 tape->name[2] = '0' + minor;
2881 tape->chrdev_dir = IDETAPE_DIR_NONE;
2882 tape->pc = tape->pc_stack;
2883 *((unsigned short *) &gcw) = drive->id->config;
2885 /* Command packet DRQ type */
2886 if (((gcw[0] & 0x60) >> 5) == 1)
2887 set_bit(IDETAPE_FLAG_DRQ_INTERRUPT, &tape->flags);
2889 tape->min_pipeline = 10;
2890 tape->max_pipeline = 10;
2891 tape->max_stages = 10;
2893 idetape_get_inquiry_results(drive);
2894 idetape_get_mode_sense_results(drive);
2895 ide_tape_get_bsize_from_bdesc(drive);
2896 tape->user_bs_factor = 1;
2897 tape->stage_size = *ctl * tape->blk_size;
2898 while (tape->stage_size > 0xffff) {
2899 printk(KERN_NOTICE "ide-tape: decreasing stage size\n");
2901 tape->stage_size = *ctl * tape->blk_size;
2903 stage_size = tape->stage_size;
2904 tape->pages_per_stage = stage_size / PAGE_SIZE;
2905 if (stage_size % PAGE_SIZE) {
2906 tape->pages_per_stage++;
2907 tape->excess_bh_size = PAGE_SIZE - stage_size % PAGE_SIZE;
2910 /* Select the "best" DSC read/write polling freq and pipeline size. */
2911 speed = max(*(u16 *)&tape->caps[14], *(u16 *)&tape->caps[8]);
2913 tape->max_stages = speed * 1000 * 10 / tape->stage_size;
2915 /* Limit memory use for pipeline to 10% of physical memory */
2917 if (tape->max_stages * tape->stage_size >
2918 si.totalram * si.mem_unit / 10)
2920 si.totalram * si.mem_unit / (10 * tape->stage_size);
2922 tape->max_stages = min(tape->max_stages, IDETAPE_MAX_PIPELINE_STAGES);
2923 tape->min_pipeline = min(tape->max_stages, IDETAPE_MIN_PIPELINE_STAGES);
2924 tape->max_pipeline =
2925 min(tape->max_stages * 2, IDETAPE_MAX_PIPELINE_STAGES);
2926 if (tape->max_stages == 0) {
2927 tape->max_stages = 1;
2928 tape->min_pipeline = 1;
2929 tape->max_pipeline = 1;
2932 t1 = (tape->stage_size * HZ) / (speed * 1000);
2933 tmid = (*(u16 *)&tape->caps[16] * 32 * HZ) / (speed * 125);
2934 tn = (IDETAPE_FIFO_THRESHOLD * tape->stage_size * HZ) / (speed * 1000);
2936 if (tape->max_stages)
2942 * Ensure that the number we got makes sense; limit it within
2943 * IDETAPE_DSC_RW_MIN and IDETAPE_DSC_RW_MAX.
2945 tape->best_dsc_rw_freq = max_t(unsigned long,
2946 min_t(unsigned long, t, IDETAPE_DSC_RW_MAX),
2947 IDETAPE_DSC_RW_MIN);
2948 printk(KERN_INFO "ide-tape: %s <-> %s: %dKBps, %d*%dkB buffer, "
2949 "%dkB pipeline, %lums tDSC%s\n",
2950 drive->name, tape->name, *(u16 *)&tape->caps[14],
2951 (*(u16 *)&tape->caps[16] * 512) / tape->stage_size,
2952 tape->stage_size / 1024,
2953 tape->max_stages * tape->stage_size / 1024,
2954 tape->best_dsc_rw_freq * 1000 / HZ,
2955 drive->using_dma ? ", DMA":"");
2957 idetape_add_settings(drive);
2960 static void ide_tape_remove(ide_drive_t *drive)
2962 idetape_tape_t *tape = drive->driver_data;
2964 ide_proc_unregister_driver(drive, tape->driver);
2966 ide_unregister_region(tape->disk);
2971 static void ide_tape_release(struct kref *kref)
2973 struct ide_tape_obj *tape = to_ide_tape(kref);
2974 ide_drive_t *drive = tape->drive;
2975 struct gendisk *g = tape->disk;
2977 BUG_ON(tape->first_stage != NULL || tape->merge_stage_size);
2979 drive->dsc_overlap = 0;
2980 drive->driver_data = NULL;
2981 device_destroy(idetape_sysfs_class, MKDEV(IDETAPE_MAJOR, tape->minor));
2982 device_destroy(idetape_sysfs_class,
2983 MKDEV(IDETAPE_MAJOR, tape->minor + 128));
2984 idetape_devs[tape->minor] = NULL;
2985 g->private_data = NULL;
2990 #ifdef CONFIG_IDE_PROC_FS
2991 static int proc_idetape_read_name
2992 (char *page, char **start, off_t off, int count, int *eof, void *data)
2994 ide_drive_t *drive = (ide_drive_t *) data;
2995 idetape_tape_t *tape = drive->driver_data;
2999 len = sprintf(out, "%s\n", tape->name);
3000 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
3003 static ide_proc_entry_t idetape_proc[] = {
3004 { "capacity", S_IFREG|S_IRUGO, proc_ide_read_capacity, NULL },
3005 { "name", S_IFREG|S_IRUGO, proc_idetape_read_name, NULL },
3006 { NULL, 0, NULL, NULL }
3010 static int ide_tape_probe(ide_drive_t *);
3012 static ide_driver_t idetape_driver = {
3014 .owner = THIS_MODULE,
3016 .bus = &ide_bus_type,
3018 .probe = ide_tape_probe,
3019 .remove = ide_tape_remove,
3020 .version = IDETAPE_VERSION,
3022 .supports_dsc_overlap = 1,
3023 .do_request = idetape_do_request,
3024 .end_request = idetape_end_request,
3025 .error = __ide_error,
3026 .abort = __ide_abort,
3027 #ifdef CONFIG_IDE_PROC_FS
3028 .proc = idetape_proc,
3032 /* Our character device supporting functions, passed to register_chrdev. */
3033 static const struct file_operations idetape_fops = {
3034 .owner = THIS_MODULE,
3035 .read = idetape_chrdev_read,
3036 .write = idetape_chrdev_write,
3037 .ioctl = idetape_chrdev_ioctl,
3038 .open = idetape_chrdev_open,
3039 .release = idetape_chrdev_release,
3042 static int idetape_open(struct inode *inode, struct file *filp)
3044 struct gendisk *disk = inode->i_bdev->bd_disk;
3045 struct ide_tape_obj *tape;
3047 tape = ide_tape_get(disk);
3054 static int idetape_release(struct inode *inode, struct file *filp)
3056 struct gendisk *disk = inode->i_bdev->bd_disk;
3057 struct ide_tape_obj *tape = ide_tape_g(disk);
3064 static int idetape_ioctl(struct inode *inode, struct file *file,
3065 unsigned int cmd, unsigned long arg)
3067 struct block_device *bdev = inode->i_bdev;
3068 struct ide_tape_obj *tape = ide_tape_g(bdev->bd_disk);
3069 ide_drive_t *drive = tape->drive;
3070 int err = generic_ide_ioctl(drive, file, bdev, cmd, arg);
3072 err = idetape_blkdev_ioctl(drive, cmd, arg);
3076 static struct block_device_operations idetape_block_ops = {
3077 .owner = THIS_MODULE,
3078 .open = idetape_open,
3079 .release = idetape_release,
3080 .ioctl = idetape_ioctl,
3083 static int ide_tape_probe(ide_drive_t *drive)
3085 idetape_tape_t *tape;
3089 if (!strstr("ide-tape", drive->driver_req))
3091 if (!drive->present)
3093 if (drive->media != ide_tape)
3095 if (!idetape_identify_device(drive)) {
3096 printk(KERN_ERR "ide-tape: %s: not supported by this version of"
3097 " the driver\n", drive->name);
3101 printk(KERN_INFO "ide-tape: passing drive %s to ide-scsi"
3102 " emulation.\n", drive->name);
3105 tape = kzalloc(sizeof(idetape_tape_t), GFP_KERNEL);
3107 printk(KERN_ERR "ide-tape: %s: Can't allocate a tape struct\n",
3112 g = alloc_disk(1 << PARTN_BITS);
3116 ide_init_disk(g, drive);
3118 ide_proc_register_driver(drive, &idetape_driver);
3120 kref_init(&tape->kref);
3122 tape->drive = drive;
3123 tape->driver = &idetape_driver;
3126 g->private_data = &tape->driver;
3128 drive->driver_data = tape;
3130 mutex_lock(&idetape_ref_mutex);
3131 for (minor = 0; idetape_devs[minor]; minor++)
3133 idetape_devs[minor] = tape;
3134 mutex_unlock(&idetape_ref_mutex);
3136 idetape_setup(drive, tape, minor);
3138 device_create(idetape_sysfs_class, &drive->gendev,
3139 MKDEV(IDETAPE_MAJOR, minor), "%s", tape->name);
3140 device_create(idetape_sysfs_class, &drive->gendev,
3141 MKDEV(IDETAPE_MAJOR, minor + 128), "n%s", tape->name);
3143 g->fops = &idetape_block_ops;
3144 ide_register_region(g);
3154 static void __exit idetape_exit(void)
3156 driver_unregister(&idetape_driver.gen_driver);
3157 class_destroy(idetape_sysfs_class);
3158 unregister_chrdev(IDETAPE_MAJOR, "ht");
3161 static int __init idetape_init(void)
3164 idetape_sysfs_class = class_create(THIS_MODULE, "ide_tape");
3165 if (IS_ERR(idetape_sysfs_class)) {
3166 idetape_sysfs_class = NULL;
3167 printk(KERN_ERR "Unable to create sysfs class for ide tapes\n");
3172 if (register_chrdev(IDETAPE_MAJOR, "ht", &idetape_fops)) {
3173 printk(KERN_ERR "ide-tape: Failed to register chrdev"
3176 goto out_free_class;
3179 error = driver_register(&idetape_driver.gen_driver);
3181 goto out_free_driver;
3186 driver_unregister(&idetape_driver.gen_driver);
3188 class_destroy(idetape_sysfs_class);
3193 MODULE_ALIAS("ide:*m-tape*");
3194 module_init(idetape_init);
3195 module_exit(idetape_exit);
3196 MODULE_ALIAS_CHARDEV_MAJOR(IDETAPE_MAJOR);
3197 MODULE_DESCRIPTION("ATAPI Streaming TAPE Driver");
3198 MODULE_LICENSE("GPL");