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 idetape_tape_t
*tape
= drive
->driver_data
;
931 struct ide_atapi_pc
*pc
= tape
->pc
;
934 stat
= ide_read_status(drive
);
936 if (stat
& SEEK_STAT
) {
937 if (stat
& ERR_STAT
) {
939 if (pc
->c
[0] != TEST_UNIT_READY
)
940 printk(KERN_ERR
"ide-tape: %s: I/O error, ",
942 /* Retry operation */
943 idetape_retry_pc(drive
);
948 pc
->error
= IDETAPE_ERROR_GENERAL
;
949 tape
->failed_pc
= NULL
;
955 static void ide_tape_create_rw_cmd(idetape_tape_t
*tape
,
956 struct ide_atapi_pc
*pc
, unsigned int length
,
957 struct idetape_bh
*bh
, u8 opcode
)
960 put_unaligned(cpu_to_be32(length
), (unsigned int *) &pc
->c
[1]);
964 pc
->buf_size
= length
* tape
->blk_size
;
965 pc
->req_xfer
= pc
->buf_size
;
966 if (pc
->req_xfer
== tape
->buffer_size
)
967 pc
->flags
|= PC_FLAG_DMA_OK
;
969 if (opcode
== READ_6
) {
971 atomic_set(&bh
->b_count
, 0);
972 } else if (opcode
== WRITE_6
) {
974 pc
->flags
|= PC_FLAG_WRITING
;
975 pc
->b_data
= bh
->b_data
;
976 pc
->b_count
= atomic_read(&bh
->b_count
);
980 static ide_startstop_t
idetape_do_request(ide_drive_t
*drive
,
981 struct request
*rq
, sector_t block
)
983 idetape_tape_t
*tape
= drive
->driver_data
;
984 struct ide_atapi_pc
*pc
= NULL
;
985 struct request
*postponed_rq
= tape
->postponed_rq
;
988 debug_log(DBG_SENSE
, "sector: %ld, nr_sectors: %ld,"
989 " current_nr_sectors: %d\n",
990 rq
->sector
, rq
->nr_sectors
, rq
->current_nr_sectors
);
992 if (!blk_special_request(rq
)) {
993 /* We do not support buffer cache originated requests. */
994 printk(KERN_NOTICE
"ide-tape: %s: Unsupported request in "
995 "request queue (%d)\n", drive
->name
, rq
->cmd_type
);
996 ide_end_request(drive
, 0, 0);
1000 /* Retry a failed packet command */
1001 if (tape
->failed_pc
&& tape
->pc
->c
[0] == REQUEST_SENSE
) {
1002 pc
= tape
->failed_pc
;
1006 if (postponed_rq
!= NULL
)
1007 if (rq
!= postponed_rq
) {
1008 printk(KERN_ERR
"ide-tape: ide-tape.c bug - "
1009 "Two DSC requests were queued\n");
1010 idetape_end_request(drive
, 0, 0);
1014 tape
->postponed_rq
= NULL
;
1017 * If the tape is still busy, postpone our request and service
1018 * the other device meanwhile.
1020 stat
= ide_read_status(drive
);
1022 if (!drive
->dsc_overlap
&& !(rq
->cmd
[0] & REQ_IDETAPE_PC2
))
1023 set_bit(IDETAPE_FLAG_IGNORE_DSC
, &tape
->flags
);
1025 if (drive
->post_reset
== 1) {
1026 set_bit(IDETAPE_FLAG_IGNORE_DSC
, &tape
->flags
);
1027 drive
->post_reset
= 0;
1030 if (!test_and_clear_bit(IDETAPE_FLAG_IGNORE_DSC
, &tape
->flags
) &&
1031 (stat
& SEEK_STAT
) == 0) {
1032 if (postponed_rq
== NULL
) {
1033 tape
->dsc_polling_start
= jiffies
;
1034 tape
->dsc_poll_freq
= tape
->best_dsc_rw_freq
;
1035 tape
->dsc_timeout
= jiffies
+ IDETAPE_DSC_RW_TIMEOUT
;
1036 } else if (time_after(jiffies
, tape
->dsc_timeout
)) {
1037 printk(KERN_ERR
"ide-tape: %s: DSC timeout\n",
1039 if (rq
->cmd
[0] & REQ_IDETAPE_PC2
) {
1040 idetape_media_access_finished(drive
);
1043 return ide_do_reset(drive
);
1045 } else if (time_after(jiffies
,
1046 tape
->dsc_polling_start
+
1047 IDETAPE_DSC_MA_THRESHOLD
))
1048 tape
->dsc_poll_freq
= IDETAPE_DSC_MA_SLOW
;
1049 idetape_postpone_request(drive
);
1052 if (rq
->cmd
[0] & REQ_IDETAPE_READ
) {
1053 pc
= idetape_next_pc_storage(drive
);
1054 ide_tape_create_rw_cmd(tape
, pc
, rq
->current_nr_sectors
,
1055 (struct idetape_bh
*)rq
->special
,
1059 if (rq
->cmd
[0] & REQ_IDETAPE_WRITE
) {
1060 pc
= idetape_next_pc_storage(drive
);
1061 ide_tape_create_rw_cmd(tape
, pc
, rq
->current_nr_sectors
,
1062 (struct idetape_bh
*)rq
->special
,
1066 if (rq
->cmd
[0] & REQ_IDETAPE_PC1
) {
1067 pc
= (struct ide_atapi_pc
*) rq
->buffer
;
1068 rq
->cmd
[0] &= ~(REQ_IDETAPE_PC1
);
1069 rq
->cmd
[0] |= REQ_IDETAPE_PC2
;
1072 if (rq
->cmd
[0] & REQ_IDETAPE_PC2
) {
1073 idetape_media_access_finished(drive
);
1078 if (test_bit(IDETAPE_FLAG_DRQ_INTERRUPT
, &tape
->flags
))
1079 pc
->flags
|= PC_FLAG_DRQ_INTERRUPT
;
1081 return idetape_issue_pc(drive
, pc
);
1085 * The function below uses __get_free_pages to allocate a data buffer of size
1086 * tape->buffer_size (or a bit more). We attempt to combine sequential pages as
1089 * It returns a pointer to the newly allocated buffer, or NULL in case of
1092 static struct idetape_bh
*ide_tape_kmalloc_buffer(idetape_tape_t
*tape
,
1093 int full
, int clear
)
1095 struct idetape_bh
*prev_bh
, *bh
, *merge_bh
;
1096 int pages
= tape
->pages_per_buffer
;
1097 unsigned int order
, b_allocd
;
1098 char *b_data
= NULL
;
1100 merge_bh
= kmalloc(sizeof(struct idetape_bh
), GFP_KERNEL
);
1105 order
= fls(pages
) - 1;
1106 bh
->b_data
= (char *) __get_free_pages(GFP_KERNEL
, order
);
1109 b_allocd
= (1 << order
) * PAGE_SIZE
;
1113 memset(bh
->b_data
, 0, b_allocd
);
1114 bh
->b_reqnext
= NULL
;
1115 bh
->b_size
= b_allocd
;
1116 atomic_set(&bh
->b_count
, full
? bh
->b_size
: 0);
1119 order
= fls(pages
) - 1;
1120 b_data
= (char *) __get_free_pages(GFP_KERNEL
, order
);
1123 b_allocd
= (1 << order
) * PAGE_SIZE
;
1126 memset(b_data
, 0, b_allocd
);
1128 /* newly allocated page frames below buffer header or ...*/
1129 if (bh
->b_data
== b_data
+ b_allocd
) {
1130 bh
->b_size
+= b_allocd
;
1131 bh
->b_data
-= b_allocd
;
1133 atomic_add(b_allocd
, &bh
->b_count
);
1136 /* they are above the header */
1137 if (b_data
== bh
->b_data
+ bh
->b_size
) {
1138 bh
->b_size
+= b_allocd
;
1140 atomic_add(b_allocd
, &bh
->b_count
);
1144 bh
= kmalloc(sizeof(struct idetape_bh
), GFP_KERNEL
);
1146 free_pages((unsigned long) b_data
, order
);
1149 bh
->b_reqnext
= NULL
;
1150 bh
->b_data
= b_data
;
1151 bh
->b_size
= b_allocd
;
1152 atomic_set(&bh
->b_count
, full
? bh
->b_size
: 0);
1153 prev_bh
->b_reqnext
= bh
;
1158 bh
->b_size
-= tape
->excess_bh_size
;
1160 atomic_sub(tape
->excess_bh_size
, &bh
->b_count
);
1163 ide_tape_kfree_buffer(tape
);
1167 static int idetape_copy_stage_from_user(idetape_tape_t
*tape
,
1168 const char __user
*buf
, int n
)
1170 struct idetape_bh
*bh
= tape
->bh
;
1176 printk(KERN_ERR
"ide-tape: bh == NULL in %s\n",
1180 count
= min((unsigned int)
1181 (bh
->b_size
- atomic_read(&bh
->b_count
)),
1183 if (copy_from_user(bh
->b_data
+ atomic_read(&bh
->b_count
), buf
,
1187 atomic_add(count
, &bh
->b_count
);
1189 if (atomic_read(&bh
->b_count
) == bh
->b_size
) {
1192 atomic_set(&bh
->b_count
, 0);
1199 static int idetape_copy_stage_to_user(idetape_tape_t
*tape
, char __user
*buf
,
1202 struct idetape_bh
*bh
= tape
->bh
;
1208 printk(KERN_ERR
"ide-tape: bh == NULL in %s\n",
1212 count
= min(tape
->b_count
, n
);
1213 if (copy_to_user(buf
, tape
->b_data
, count
))
1216 tape
->b_data
+= count
;
1217 tape
->b_count
-= count
;
1219 if (!tape
->b_count
) {
1223 tape
->b_data
= bh
->b_data
;
1224 tape
->b_count
= atomic_read(&bh
->b_count
);
1231 static void idetape_init_merge_buffer(idetape_tape_t
*tape
)
1233 struct idetape_bh
*bh
= tape
->merge_bh
;
1234 tape
->bh
= tape
->merge_bh
;
1236 if (tape
->chrdev_dir
== IDETAPE_DIR_WRITE
)
1237 atomic_set(&bh
->b_count
, 0);
1239 tape
->b_data
= bh
->b_data
;
1240 tape
->b_count
= atomic_read(&bh
->b_count
);
1245 * Write a filemark if write_filemark=1. Flush the device buffers without
1246 * writing a filemark otherwise.
1248 static void idetape_create_write_filemark_cmd(ide_drive_t
*drive
,
1249 struct ide_atapi_pc
*pc
, int write_filemark
)
1251 idetape_init_pc(pc
);
1252 pc
->c
[0] = WRITE_FILEMARKS
;
1253 pc
->c
[4] = write_filemark
;
1254 pc
->flags
|= PC_FLAG_WAIT_FOR_DSC
;
1257 static void idetape_create_test_unit_ready_cmd(struct ide_atapi_pc
*pc
)
1259 idetape_init_pc(pc
);
1260 pc
->c
[0] = TEST_UNIT_READY
;
1264 * We add a special packet command request to the tail of the request queue, and
1265 * wait for it to be serviced. This is not to be called from within the request
1266 * handling part of the driver! We allocate here data on the stack and it is
1267 * valid until the request is finished. This is not the case for the bottom part
1268 * of the driver, where we are always leaving the functions to wait for an
1269 * interrupt or a timer event.
1271 * From the bottom part of the driver, we should allocate safe memory using
1272 * idetape_next_pc_storage() and ide_tape_next_rq_storage(), and add the request
1273 * to the request list without waiting for it to be serviced! In that case, we
1274 * usually use idetape_queue_pc_head().
1276 static int idetape_queue_pc_tail(ide_drive_t
*drive
, struct ide_atapi_pc
*pc
)
1278 struct ide_tape_obj
*tape
= drive
->driver_data
;
1282 rq
= blk_get_request(drive
->queue
, READ
, __GFP_WAIT
);
1283 rq
->cmd_type
= REQ_TYPE_SPECIAL
;
1284 rq
->cmd
[0] = REQ_IDETAPE_PC1
;
1285 rq
->buffer
= (char *)pc
;
1286 error
= blk_execute_rq(drive
->queue
, tape
->disk
, rq
, 0);
1287 blk_put_request(rq
);
1291 static void idetape_create_load_unload_cmd(ide_drive_t
*drive
,
1292 struct ide_atapi_pc
*pc
, int cmd
)
1294 idetape_init_pc(pc
);
1295 pc
->c
[0] = START_STOP
;
1297 pc
->flags
|= PC_FLAG_WAIT_FOR_DSC
;
1300 static int idetape_wait_ready(ide_drive_t
*drive
, unsigned long timeout
)
1302 idetape_tape_t
*tape
= drive
->driver_data
;
1303 struct ide_atapi_pc pc
;
1304 int load_attempted
= 0;
1306 /* Wait for the tape to become ready */
1307 set_bit(IDETAPE_FLAG_MEDIUM_PRESENT
, &tape
->flags
);
1309 while (time_before(jiffies
, timeout
)) {
1310 idetape_create_test_unit_ready_cmd(&pc
);
1311 if (!idetape_queue_pc_tail(drive
, &pc
))
1313 if ((tape
->sense_key
== 2 && tape
->asc
== 4 && tape
->ascq
== 2)
1314 || (tape
->asc
== 0x3A)) {
1318 idetape_create_load_unload_cmd(drive
, &pc
,
1319 IDETAPE_LU_LOAD_MASK
);
1320 idetape_queue_pc_tail(drive
, &pc
);
1322 /* not about to be ready */
1323 } else if (!(tape
->sense_key
== 2 && tape
->asc
== 4 &&
1324 (tape
->ascq
== 1 || tape
->ascq
== 8)))
1331 static int idetape_flush_tape_buffers(ide_drive_t
*drive
)
1333 struct ide_atapi_pc pc
;
1336 idetape_create_write_filemark_cmd(drive
, &pc
, 0);
1337 rc
= idetape_queue_pc_tail(drive
, &pc
);
1340 idetape_wait_ready(drive
, 60 * 5 * HZ
);
1344 static void idetape_create_read_position_cmd(struct ide_atapi_pc
*pc
)
1346 idetape_init_pc(pc
);
1347 pc
->c
[0] = READ_POSITION
;
1351 static int idetape_read_position(ide_drive_t
*drive
)
1353 idetape_tape_t
*tape
= drive
->driver_data
;
1354 struct ide_atapi_pc pc
;
1357 debug_log(DBG_PROCS
, "Enter %s\n", __func__
);
1359 idetape_create_read_position_cmd(&pc
);
1360 if (idetape_queue_pc_tail(drive
, &pc
))
1362 position
= tape
->first_frame
;
1366 static void idetape_create_locate_cmd(ide_drive_t
*drive
,
1367 struct ide_atapi_pc
*pc
,
1368 unsigned int block
, u8 partition
, int skip
)
1370 idetape_init_pc(pc
);
1371 pc
->c
[0] = POSITION_TO_ELEMENT
;
1373 put_unaligned(cpu_to_be32(block
), (unsigned int *) &pc
->c
[3]);
1374 pc
->c
[8] = partition
;
1375 pc
->flags
|= PC_FLAG_WAIT_FOR_DSC
;
1378 static int idetape_create_prevent_cmd(ide_drive_t
*drive
,
1379 struct ide_atapi_pc
*pc
, int prevent
)
1381 idetape_tape_t
*tape
= drive
->driver_data
;
1383 /* device supports locking according to capabilities page */
1384 if (!(tape
->caps
[6] & 0x01))
1387 idetape_init_pc(pc
);
1388 pc
->c
[0] = ALLOW_MEDIUM_REMOVAL
;
1393 static void __ide_tape_discard_merge_buffer(ide_drive_t
*drive
)
1395 idetape_tape_t
*tape
= drive
->driver_data
;
1397 if (tape
->chrdev_dir
!= IDETAPE_DIR_READ
)
1400 clear_bit(IDETAPE_FLAG_FILEMARK
, &tape
->flags
);
1401 tape
->merge_bh_size
= 0;
1402 if (tape
->merge_bh
!= NULL
) {
1403 ide_tape_kfree_buffer(tape
);
1404 tape
->merge_bh
= NULL
;
1407 tape
->chrdev_dir
= IDETAPE_DIR_NONE
;
1411 * Position the tape to the requested block using the LOCATE packet command.
1412 * A READ POSITION command is then issued to check where we are positioned. Like
1413 * all higher level operations, we queue the commands at the tail of the request
1414 * queue and wait for their completion.
1416 static int idetape_position_tape(ide_drive_t
*drive
, unsigned int block
,
1417 u8 partition
, int skip
)
1419 idetape_tape_t
*tape
= drive
->driver_data
;
1421 struct ide_atapi_pc pc
;
1423 if (tape
->chrdev_dir
== IDETAPE_DIR_READ
)
1424 __ide_tape_discard_merge_buffer(drive
);
1425 idetape_wait_ready(drive
, 60 * 5 * HZ
);
1426 idetape_create_locate_cmd(drive
, &pc
, block
, partition
, skip
);
1427 retval
= idetape_queue_pc_tail(drive
, &pc
);
1431 idetape_create_read_position_cmd(&pc
);
1432 return (idetape_queue_pc_tail(drive
, &pc
));
1435 static void ide_tape_discard_merge_buffer(ide_drive_t
*drive
,
1436 int restore_position
)
1438 idetape_tape_t
*tape
= drive
->driver_data
;
1441 __ide_tape_discard_merge_buffer(drive
);
1442 if (restore_position
) {
1443 position
= idetape_read_position(drive
);
1444 seek
= position
> 0 ? position
: 0;
1445 if (idetape_position_tape(drive
, seek
, 0, 0)) {
1446 printk(KERN_INFO
"ide-tape: %s: position_tape failed in"
1447 " %s\n", tape
->name
, __func__
);
1454 * Generate a read/write request for the block device interface and wait for it
1457 static int idetape_queue_rw_tail(ide_drive_t
*drive
, int cmd
, int blocks
,
1458 struct idetape_bh
*bh
)
1460 idetape_tape_t
*tape
= drive
->driver_data
;
1464 debug_log(DBG_SENSE
, "%s: cmd=%d\n", __func__
, cmd
);
1466 rq
= blk_get_request(drive
->queue
, READ
, __GFP_WAIT
);
1467 rq
->cmd_type
= REQ_TYPE_SPECIAL
;
1469 rq
->rq_disk
= tape
->disk
;
1470 rq
->special
= (void *)bh
;
1471 rq
->sector
= tape
->first_frame
;
1472 rq
->nr_sectors
= blocks
;
1473 rq
->current_nr_sectors
= blocks
;
1474 blk_execute_rq(drive
->queue
, tape
->disk
, rq
, 0);
1476 errors
= rq
->errors
;
1477 ret
= tape
->blk_size
* (blocks
- rq
->current_nr_sectors
);
1478 blk_put_request(rq
);
1480 if ((cmd
& (REQ_IDETAPE_READ
| REQ_IDETAPE_WRITE
)) == 0)
1484 idetape_init_merge_buffer(tape
);
1485 if (errors
== IDETAPE_ERROR_GENERAL
)
1490 static void idetape_create_inquiry_cmd(struct ide_atapi_pc
*pc
)
1492 idetape_init_pc(pc
);
1498 static void idetape_create_rewind_cmd(ide_drive_t
*drive
,
1499 struct ide_atapi_pc
*pc
)
1501 idetape_init_pc(pc
);
1502 pc
->c
[0] = REZERO_UNIT
;
1503 pc
->flags
|= PC_FLAG_WAIT_FOR_DSC
;
1506 static void idetape_create_erase_cmd(struct ide_atapi_pc
*pc
)
1508 idetape_init_pc(pc
);
1511 pc
->flags
|= PC_FLAG_WAIT_FOR_DSC
;
1514 static void idetape_create_space_cmd(struct ide_atapi_pc
*pc
, int count
, u8 cmd
)
1516 idetape_init_pc(pc
);
1518 put_unaligned(cpu_to_be32(count
), (unsigned int *) &pc
->c
[1]);
1520 pc
->flags
|= PC_FLAG_WAIT_FOR_DSC
;
1523 /* Queue up a character device originated write request. */
1524 static int idetape_add_chrdev_write_request(ide_drive_t
*drive
, int blocks
)
1526 idetape_tape_t
*tape
= drive
->driver_data
;
1528 debug_log(DBG_CHRDEV
, "Enter %s\n", __func__
);
1530 return idetape_queue_rw_tail(drive
, REQ_IDETAPE_WRITE
,
1531 blocks
, tape
->merge_bh
);
1534 static void ide_tape_flush_merge_buffer(ide_drive_t
*drive
)
1536 idetape_tape_t
*tape
= drive
->driver_data
;
1538 struct idetape_bh
*bh
;
1540 if (tape
->chrdev_dir
!= IDETAPE_DIR_WRITE
) {
1541 printk(KERN_ERR
"ide-tape: bug: Trying to empty merge buffer"
1542 " but we are not writing.\n");
1545 if (tape
->merge_bh_size
> tape
->buffer_size
) {
1546 printk(KERN_ERR
"ide-tape: bug: merge_buffer too big\n");
1547 tape
->merge_bh_size
= tape
->buffer_size
;
1549 if (tape
->merge_bh_size
) {
1550 blocks
= tape
->merge_bh_size
/ tape
->blk_size
;
1551 if (tape
->merge_bh_size
% tape
->blk_size
) {
1555 i
= tape
->blk_size
- tape
->merge_bh_size
%
1557 bh
= tape
->bh
->b_reqnext
;
1559 atomic_set(&bh
->b_count
, 0);
1565 printk(KERN_INFO
"ide-tape: bug,"
1569 min
= min(i
, (unsigned int)(bh
->b_size
-
1570 atomic_read(&bh
->b_count
)));
1571 memset(bh
->b_data
+ atomic_read(&bh
->b_count
),
1573 atomic_add(min
, &bh
->b_count
);
1578 (void) idetape_add_chrdev_write_request(drive
, blocks
);
1579 tape
->merge_bh_size
= 0;
1581 if (tape
->merge_bh
!= NULL
) {
1582 ide_tape_kfree_buffer(tape
);
1583 tape
->merge_bh
= NULL
;
1585 tape
->chrdev_dir
= IDETAPE_DIR_NONE
;
1588 static int idetape_init_read(ide_drive_t
*drive
)
1590 idetape_tape_t
*tape
= drive
->driver_data
;
1593 /* Initialize read operation */
1594 if (tape
->chrdev_dir
!= IDETAPE_DIR_READ
) {
1595 if (tape
->chrdev_dir
== IDETAPE_DIR_WRITE
) {
1596 ide_tape_flush_merge_buffer(drive
);
1597 idetape_flush_tape_buffers(drive
);
1599 if (tape
->merge_bh
|| tape
->merge_bh_size
) {
1600 printk(KERN_ERR
"ide-tape: merge_bh_size should be"
1602 tape
->merge_bh_size
= 0;
1604 tape
->merge_bh
= ide_tape_kmalloc_buffer(tape
, 0, 0);
1605 if (!tape
->merge_bh
)
1607 tape
->chrdev_dir
= IDETAPE_DIR_READ
;
1610 * Issue a read 0 command to ensure that DSC handshake is
1611 * switched from completion mode to buffer available mode.
1612 * No point in issuing this if DSC overlap isn't supported, some
1613 * drives (Seagate STT3401A) will return an error.
1615 if (drive
->dsc_overlap
) {
1616 bytes_read
= idetape_queue_rw_tail(drive
,
1617 REQ_IDETAPE_READ
, 0,
1619 if (bytes_read
< 0) {
1620 ide_tape_kfree_buffer(tape
);
1621 tape
->merge_bh
= NULL
;
1622 tape
->chrdev_dir
= IDETAPE_DIR_NONE
;
1631 /* called from idetape_chrdev_read() to service a chrdev read request. */
1632 static int idetape_add_chrdev_read_request(ide_drive_t
*drive
, int blocks
)
1634 idetape_tape_t
*tape
= drive
->driver_data
;
1636 debug_log(DBG_PROCS
, "Enter %s, %d blocks\n", __func__
, blocks
);
1638 /* If we are at a filemark, return a read length of 0 */
1639 if (test_bit(IDETAPE_FLAG_FILEMARK
, &tape
->flags
))
1642 idetape_init_read(drive
);
1644 return idetape_queue_rw_tail(drive
, REQ_IDETAPE_READ
, blocks
,
1648 static void idetape_pad_zeros(ide_drive_t
*drive
, int bcount
)
1650 idetape_tape_t
*tape
= drive
->driver_data
;
1651 struct idetape_bh
*bh
;
1657 bh
= tape
->merge_bh
;
1658 count
= min(tape
->buffer_size
, bcount
);
1660 blocks
= count
/ tape
->blk_size
;
1662 atomic_set(&bh
->b_count
,
1663 min(count
, (unsigned int)bh
->b_size
));
1664 memset(bh
->b_data
, 0, atomic_read(&bh
->b_count
));
1665 count
-= atomic_read(&bh
->b_count
);
1668 idetape_queue_rw_tail(drive
, REQ_IDETAPE_WRITE
, blocks
,
1674 * Rewinds the tape to the Beginning Of the current Partition (BOP). We
1675 * currently support only one partition.
1677 static int idetape_rewind_tape(ide_drive_t
*drive
)
1680 struct ide_atapi_pc pc
;
1681 idetape_tape_t
*tape
;
1682 tape
= drive
->driver_data
;
1684 debug_log(DBG_SENSE
, "Enter %s\n", __func__
);
1686 idetape_create_rewind_cmd(drive
, &pc
);
1687 retval
= idetape_queue_pc_tail(drive
, &pc
);
1691 idetape_create_read_position_cmd(&pc
);
1692 retval
= idetape_queue_pc_tail(drive
, &pc
);
1698 /* mtio.h compatible commands should be issued to the chrdev interface. */
1699 static int idetape_blkdev_ioctl(ide_drive_t
*drive
, unsigned int cmd
,
1702 idetape_tape_t
*tape
= drive
->driver_data
;
1703 void __user
*argp
= (void __user
*)arg
;
1705 struct idetape_config
{
1706 int dsc_rw_frequency
;
1707 int dsc_media_access_frequency
;
1711 debug_log(DBG_PROCS
, "Enter %s\n", __func__
);
1715 if (copy_from_user(&config
, argp
, sizeof(config
)))
1717 tape
->best_dsc_rw_freq
= config
.dsc_rw_frequency
;
1720 config
.dsc_rw_frequency
= (int) tape
->best_dsc_rw_freq
;
1721 config
.nr_stages
= 1;
1722 if (copy_to_user(argp
, &config
, sizeof(config
)))
1731 static int idetape_space_over_filemarks(ide_drive_t
*drive
, short mt_op
,
1734 idetape_tape_t
*tape
= drive
->driver_data
;
1735 struct ide_atapi_pc pc
;
1736 int retval
, count
= 0;
1737 int sprev
= !!(tape
->caps
[4] & 0x20);
1741 if (MTBSF
== mt_op
|| MTBSFM
== mt_op
) {
1744 mt_count
= -mt_count
;
1747 if (tape
->chrdev_dir
== IDETAPE_DIR_READ
) {
1748 tape
->merge_bh_size
= 0;
1749 if (test_and_clear_bit(IDETAPE_FLAG_FILEMARK
, &tape
->flags
))
1751 ide_tape_discard_merge_buffer(drive
, 0);
1757 idetape_create_space_cmd(&pc
, mt_count
- count
,
1758 IDETAPE_SPACE_OVER_FILEMARK
);
1759 return idetape_queue_pc_tail(drive
, &pc
);
1764 retval
= idetape_space_over_filemarks(drive
, MTFSF
,
1768 count
= (MTBSFM
== mt_op
? 1 : -1);
1769 return idetape_space_over_filemarks(drive
, MTFSF
, count
);
1771 printk(KERN_ERR
"ide-tape: MTIO operation %d not supported\n",
1778 * Our character device read / write functions.
1780 * The tape is optimized to maximize throughput when it is transferring an
1781 * integral number of the "continuous transfer limit", which is a parameter of
1782 * the specific tape (26kB on my particular tape, 32kB for Onstream).
1784 * As of version 1.3 of the driver, the character device provides an abstract
1785 * continuous view of the media - any mix of block sizes (even 1 byte) on the
1786 * same backup/restore procedure is supported. The driver will internally
1787 * convert the requests to the recommended transfer unit, so that an unmatch
1788 * between the user's block size to the recommended size will only result in a
1789 * (slightly) increased driver overhead, but will no longer hit performance.
1790 * This is not applicable to Onstream.
1792 static ssize_t
idetape_chrdev_read(struct file
*file
, char __user
*buf
,
1793 size_t count
, loff_t
*ppos
)
1795 struct ide_tape_obj
*tape
= ide_tape_f(file
);
1796 ide_drive_t
*drive
= tape
->drive
;
1797 ssize_t bytes_read
, temp
, actually_read
= 0, rc
;
1799 u16 ctl
= *(u16
*)&tape
->caps
[12];
1801 debug_log(DBG_CHRDEV
, "Enter %s, count %Zd\n", __func__
, count
);
1803 if (tape
->chrdev_dir
!= IDETAPE_DIR_READ
) {
1804 if (test_bit(IDETAPE_FLAG_DETECT_BS
, &tape
->flags
))
1805 if (count
> tape
->blk_size
&&
1806 (count
% tape
->blk_size
) == 0)
1807 tape
->user_bs_factor
= count
/ tape
->blk_size
;
1809 rc
= idetape_init_read(drive
);
1814 if (tape
->merge_bh_size
) {
1815 actually_read
= min((unsigned int)(tape
->merge_bh_size
),
1816 (unsigned int)count
);
1817 if (idetape_copy_stage_to_user(tape
, buf
, actually_read
))
1819 buf
+= actually_read
;
1820 tape
->merge_bh_size
-= actually_read
;
1821 count
-= actually_read
;
1823 while (count
>= tape
->buffer_size
) {
1824 bytes_read
= idetape_add_chrdev_read_request(drive
, ctl
);
1825 if (bytes_read
<= 0)
1827 if (idetape_copy_stage_to_user(tape
, buf
, bytes_read
))
1830 count
-= bytes_read
;
1831 actually_read
+= bytes_read
;
1834 bytes_read
= idetape_add_chrdev_read_request(drive
, ctl
);
1835 if (bytes_read
<= 0)
1837 temp
= min((unsigned long)count
, (unsigned long)bytes_read
);
1838 if (idetape_copy_stage_to_user(tape
, buf
, temp
))
1840 actually_read
+= temp
;
1841 tape
->merge_bh_size
= bytes_read
-temp
;
1844 if (!actually_read
&& test_bit(IDETAPE_FLAG_FILEMARK
, &tape
->flags
)) {
1845 debug_log(DBG_SENSE
, "%s: spacing over filemark\n", tape
->name
);
1847 idetape_space_over_filemarks(drive
, MTFSF
, 1);
1851 return ret
? ret
: actually_read
;
1854 static ssize_t
idetape_chrdev_write(struct file
*file
, const char __user
*buf
,
1855 size_t count
, loff_t
*ppos
)
1857 struct ide_tape_obj
*tape
= ide_tape_f(file
);
1858 ide_drive_t
*drive
= tape
->drive
;
1859 ssize_t actually_written
= 0;
1861 u16 ctl
= *(u16
*)&tape
->caps
[12];
1863 /* The drive is write protected. */
1864 if (tape
->write_prot
)
1867 debug_log(DBG_CHRDEV
, "Enter %s, count %Zd\n", __func__
, count
);
1869 /* Initialize write operation */
1870 if (tape
->chrdev_dir
!= IDETAPE_DIR_WRITE
) {
1871 if (tape
->chrdev_dir
== IDETAPE_DIR_READ
)
1872 ide_tape_discard_merge_buffer(drive
, 1);
1873 if (tape
->merge_bh
|| tape
->merge_bh_size
) {
1874 printk(KERN_ERR
"ide-tape: merge_bh_size "
1875 "should be 0 now\n");
1876 tape
->merge_bh_size
= 0;
1878 tape
->merge_bh
= ide_tape_kmalloc_buffer(tape
, 0, 0);
1879 if (!tape
->merge_bh
)
1881 tape
->chrdev_dir
= IDETAPE_DIR_WRITE
;
1882 idetape_init_merge_buffer(tape
);
1885 * Issue a write 0 command to ensure that DSC handshake is
1886 * switched from completion mode to buffer available mode. No
1887 * point in issuing this if DSC overlap isn't supported, some
1888 * drives (Seagate STT3401A) will return an error.
1890 if (drive
->dsc_overlap
) {
1891 ssize_t retval
= idetape_queue_rw_tail(drive
,
1892 REQ_IDETAPE_WRITE
, 0,
1895 ide_tape_kfree_buffer(tape
);
1896 tape
->merge_bh
= NULL
;
1897 tape
->chrdev_dir
= IDETAPE_DIR_NONE
;
1904 if (tape
->merge_bh_size
) {
1905 if (tape
->merge_bh_size
>= tape
->buffer_size
) {
1906 printk(KERN_ERR
"ide-tape: bug: merge buf too big\n");
1907 tape
->merge_bh_size
= 0;
1909 actually_written
= min((unsigned int)
1910 (tape
->buffer_size
- tape
->merge_bh_size
),
1911 (unsigned int)count
);
1912 if (idetape_copy_stage_from_user(tape
, buf
, actually_written
))
1914 buf
+= actually_written
;
1915 tape
->merge_bh_size
+= actually_written
;
1916 count
-= actually_written
;
1918 if (tape
->merge_bh_size
== tape
->buffer_size
) {
1920 tape
->merge_bh_size
= 0;
1921 retval
= idetape_add_chrdev_write_request(drive
, ctl
);
1926 while (count
>= tape
->buffer_size
) {
1928 if (idetape_copy_stage_from_user(tape
, buf
, tape
->buffer_size
))
1930 buf
+= tape
->buffer_size
;
1931 count
-= tape
->buffer_size
;
1932 retval
= idetape_add_chrdev_write_request(drive
, ctl
);
1933 actually_written
+= tape
->buffer_size
;
1938 actually_written
+= count
;
1939 if (idetape_copy_stage_from_user(tape
, buf
, count
))
1941 tape
->merge_bh_size
+= count
;
1943 return ret
? ret
: actually_written
;
1946 static int idetape_write_filemark(ide_drive_t
*drive
)
1948 struct ide_atapi_pc pc
;
1950 /* Write a filemark */
1951 idetape_create_write_filemark_cmd(drive
, &pc
, 1);
1952 if (idetape_queue_pc_tail(drive
, &pc
)) {
1953 printk(KERN_ERR
"ide-tape: Couldn't write a filemark\n");
1960 * Called from idetape_chrdev_ioctl when the general mtio MTIOCTOP ioctl is
1963 * Note: MTBSF and MTBSFM are not supported when the tape doesn't support
1964 * spacing over filemarks in the reverse direction. In this case, MTFSFM is also
1965 * usually not supported.
1967 * The following commands are currently not supported:
1969 * MTFSS, MTBSS, MTWSM, MTSETDENSITY, MTSETDRVBUFFER, MT_ST_BOOLEANS,
1970 * MT_ST_WRITE_THRESHOLD.
1972 static int idetape_mtioctop(ide_drive_t
*drive
, short mt_op
, int mt_count
)
1974 idetape_tape_t
*tape
= drive
->driver_data
;
1975 struct ide_atapi_pc pc
;
1978 debug_log(DBG_ERR
, "Handling MTIOCTOP ioctl: mt_op=%d, mt_count=%d\n",
1988 return idetape_space_over_filemarks(drive
, mt_op
, mt_count
);
1995 if (tape
->write_prot
)
1997 ide_tape_discard_merge_buffer(drive
, 1);
1998 for (i
= 0; i
< mt_count
; i
++) {
1999 retval
= idetape_write_filemark(drive
);
2005 ide_tape_discard_merge_buffer(drive
, 0);
2006 if (idetape_rewind_tape(drive
))
2010 ide_tape_discard_merge_buffer(drive
, 0);
2011 idetape_create_load_unload_cmd(drive
, &pc
,
2012 IDETAPE_LU_LOAD_MASK
);
2013 return idetape_queue_pc_tail(drive
, &pc
);
2017 * If door is locked, attempt to unlock before
2018 * attempting to eject.
2020 if (tape
->door_locked
) {
2021 if (idetape_create_prevent_cmd(drive
, &pc
, 0))
2022 if (!idetape_queue_pc_tail(drive
, &pc
))
2023 tape
->door_locked
= DOOR_UNLOCKED
;
2025 ide_tape_discard_merge_buffer(drive
, 0);
2026 idetape_create_load_unload_cmd(drive
, &pc
,
2027 !IDETAPE_LU_LOAD_MASK
);
2028 retval
= idetape_queue_pc_tail(drive
, &pc
);
2030 clear_bit(IDETAPE_FLAG_MEDIUM_PRESENT
, &tape
->flags
);
2033 ide_tape_discard_merge_buffer(drive
, 0);
2034 return idetape_flush_tape_buffers(drive
);
2036 ide_tape_discard_merge_buffer(drive
, 0);
2037 idetape_create_load_unload_cmd(drive
, &pc
,
2038 IDETAPE_LU_RETENSION_MASK
| IDETAPE_LU_LOAD_MASK
);
2039 return idetape_queue_pc_tail(drive
, &pc
);
2041 idetape_create_space_cmd(&pc
, 0, IDETAPE_SPACE_TO_EOD
);
2042 return idetape_queue_pc_tail(drive
, &pc
);
2044 (void)idetape_rewind_tape(drive
);
2045 idetape_create_erase_cmd(&pc
);
2046 return idetape_queue_pc_tail(drive
, &pc
);
2049 if (mt_count
< tape
->blk_size
||
2050 mt_count
% tape
->blk_size
)
2052 tape
->user_bs_factor
= mt_count
/ tape
->blk_size
;
2053 clear_bit(IDETAPE_FLAG_DETECT_BS
, &tape
->flags
);
2055 set_bit(IDETAPE_FLAG_DETECT_BS
, &tape
->flags
);
2058 ide_tape_discard_merge_buffer(drive
, 0);
2059 return idetape_position_tape(drive
,
2060 mt_count
* tape
->user_bs_factor
, tape
->partition
, 0);
2062 ide_tape_discard_merge_buffer(drive
, 0);
2063 return idetape_position_tape(drive
, 0, mt_count
, 0);
2067 if (!idetape_create_prevent_cmd(drive
, &pc
, 1))
2069 retval
= idetape_queue_pc_tail(drive
, &pc
);
2072 tape
->door_locked
= DOOR_EXPLICITLY_LOCKED
;
2075 if (!idetape_create_prevent_cmd(drive
, &pc
, 0))
2077 retval
= idetape_queue_pc_tail(drive
, &pc
);
2080 tape
->door_locked
= DOOR_UNLOCKED
;
2083 printk(KERN_ERR
"ide-tape: MTIO operation %d not supported\n",
2090 * Our character device ioctls. General mtio.h magnetic io commands are
2091 * supported here, and not in the corresponding block interface. Our own
2092 * ide-tape ioctls are supported on both interfaces.
2094 static int idetape_chrdev_ioctl(struct inode
*inode
, struct file
*file
,
2095 unsigned int cmd
, unsigned long arg
)
2097 struct ide_tape_obj
*tape
= ide_tape_f(file
);
2098 ide_drive_t
*drive
= tape
->drive
;
2102 int block_offset
= 0, position
= tape
->first_frame
;
2103 void __user
*argp
= (void __user
*)arg
;
2105 debug_log(DBG_CHRDEV
, "Enter %s, cmd=%u\n", __func__
, cmd
);
2107 if (tape
->chrdev_dir
== IDETAPE_DIR_WRITE
) {
2108 ide_tape_flush_merge_buffer(drive
);
2109 idetape_flush_tape_buffers(drive
);
2111 if (cmd
== MTIOCGET
|| cmd
== MTIOCPOS
) {
2112 block_offset
= tape
->merge_bh_size
/
2113 (tape
->blk_size
* tape
->user_bs_factor
);
2114 position
= idetape_read_position(drive
);
2120 if (copy_from_user(&mtop
, argp
, sizeof(struct mtop
)))
2122 return idetape_mtioctop(drive
, mtop
.mt_op
, mtop
.mt_count
);
2124 memset(&mtget
, 0, sizeof(struct mtget
));
2125 mtget
.mt_type
= MT_ISSCSI2
;
2126 mtget
.mt_blkno
= position
/ tape
->user_bs_factor
- block_offset
;
2128 ((tape
->blk_size
* tape
->user_bs_factor
)
2129 << MT_ST_BLKSIZE_SHIFT
) & MT_ST_BLKSIZE_MASK
;
2131 if (tape
->drv_write_prot
)
2132 mtget
.mt_gstat
|= GMT_WR_PROT(0xffffffff);
2134 if (copy_to_user(argp
, &mtget
, sizeof(struct mtget
)))
2138 mtpos
.mt_blkno
= position
/ tape
->user_bs_factor
- block_offset
;
2139 if (copy_to_user(argp
, &mtpos
, sizeof(struct mtpos
)))
2143 if (tape
->chrdev_dir
== IDETAPE_DIR_READ
)
2144 ide_tape_discard_merge_buffer(drive
, 1);
2145 return idetape_blkdev_ioctl(drive
, cmd
, arg
);
2150 * Do a mode sense page 0 with block descriptor and if it succeeds set the tape
2151 * block size with the reported value.
2153 static void ide_tape_get_bsize_from_bdesc(ide_drive_t
*drive
)
2155 idetape_tape_t
*tape
= drive
->driver_data
;
2156 struct ide_atapi_pc pc
;
2158 idetape_create_mode_sense_cmd(&pc
, IDETAPE_BLOCK_DESCRIPTOR
);
2159 if (idetape_queue_pc_tail(drive
, &pc
)) {
2160 printk(KERN_ERR
"ide-tape: Can't get block descriptor\n");
2161 if (tape
->blk_size
== 0) {
2162 printk(KERN_WARNING
"ide-tape: Cannot deal with zero "
2163 "block size, assuming 32k\n");
2164 tape
->blk_size
= 32768;
2168 tape
->blk_size
= (pc
.buf
[4 + 5] << 16) +
2169 (pc
.buf
[4 + 6] << 8) +
2171 tape
->drv_write_prot
= (pc
.buf
[2] & 0x80) >> 7;
2174 static int idetape_chrdev_open(struct inode
*inode
, struct file
*filp
)
2176 unsigned int minor
= iminor(inode
), i
= minor
& ~0xc0;
2178 idetape_tape_t
*tape
;
2179 struct ide_atapi_pc pc
;
2182 if (i
>= MAX_HWIFS
* MAX_DRIVES
)
2186 tape
= ide_tape_chrdev_get(i
);
2192 debug_log(DBG_CHRDEV
, "Enter %s\n", __func__
);
2195 * We really want to do nonseekable_open(inode, filp); here, but some
2196 * versions of tar incorrectly call lseek on tapes and bail out if that
2197 * fails. So we disallow pread() and pwrite(), but permit lseeks.
2199 filp
->f_mode
&= ~(FMODE_PREAD
| FMODE_PWRITE
);
2201 drive
= tape
->drive
;
2203 filp
->private_data
= tape
;
2205 if (test_and_set_bit(IDETAPE_FLAG_BUSY
, &tape
->flags
)) {
2210 retval
= idetape_wait_ready(drive
, 60 * HZ
);
2212 clear_bit(IDETAPE_FLAG_BUSY
, &tape
->flags
);
2213 printk(KERN_ERR
"ide-tape: %s: drive not ready\n", tape
->name
);
2217 idetape_read_position(drive
);
2218 if (!test_bit(IDETAPE_FLAG_ADDRESS_VALID
, &tape
->flags
))
2219 (void)idetape_rewind_tape(drive
);
2221 /* Read block size and write protect status from drive. */
2222 ide_tape_get_bsize_from_bdesc(drive
);
2224 /* Set write protect flag if device is opened as read-only. */
2225 if ((filp
->f_flags
& O_ACCMODE
) == O_RDONLY
)
2226 tape
->write_prot
= 1;
2228 tape
->write_prot
= tape
->drv_write_prot
;
2230 /* Make sure drive isn't write protected if user wants to write. */
2231 if (tape
->write_prot
) {
2232 if ((filp
->f_flags
& O_ACCMODE
) == O_WRONLY
||
2233 (filp
->f_flags
& O_ACCMODE
) == O_RDWR
) {
2234 clear_bit(IDETAPE_FLAG_BUSY
, &tape
->flags
);
2240 /* Lock the tape drive door so user can't eject. */
2241 if (tape
->chrdev_dir
== IDETAPE_DIR_NONE
) {
2242 if (idetape_create_prevent_cmd(drive
, &pc
, 1)) {
2243 if (!idetape_queue_pc_tail(drive
, &pc
)) {
2244 if (tape
->door_locked
!= DOOR_EXPLICITLY_LOCKED
)
2245 tape
->door_locked
= DOOR_LOCKED
;
2258 static void idetape_write_release(ide_drive_t
*drive
, unsigned int minor
)
2260 idetape_tape_t
*tape
= drive
->driver_data
;
2262 ide_tape_flush_merge_buffer(drive
);
2263 tape
->merge_bh
= ide_tape_kmalloc_buffer(tape
, 1, 0);
2264 if (tape
->merge_bh
!= NULL
) {
2265 idetape_pad_zeros(drive
, tape
->blk_size
*
2266 (tape
->user_bs_factor
- 1));
2267 ide_tape_kfree_buffer(tape
);
2268 tape
->merge_bh
= NULL
;
2270 idetape_write_filemark(drive
);
2271 idetape_flush_tape_buffers(drive
);
2272 idetape_flush_tape_buffers(drive
);
2275 static int idetape_chrdev_release(struct inode
*inode
, struct file
*filp
)
2277 struct ide_tape_obj
*tape
= ide_tape_f(filp
);
2278 ide_drive_t
*drive
= tape
->drive
;
2279 struct ide_atapi_pc pc
;
2280 unsigned int minor
= iminor(inode
);
2283 tape
= drive
->driver_data
;
2285 debug_log(DBG_CHRDEV
, "Enter %s\n", __func__
);
2287 if (tape
->chrdev_dir
== IDETAPE_DIR_WRITE
)
2288 idetape_write_release(drive
, minor
);
2289 if (tape
->chrdev_dir
== IDETAPE_DIR_READ
) {
2291 ide_tape_discard_merge_buffer(drive
, 1);
2294 if (minor
< 128 && test_bit(IDETAPE_FLAG_MEDIUM_PRESENT
, &tape
->flags
))
2295 (void) idetape_rewind_tape(drive
);
2296 if (tape
->chrdev_dir
== IDETAPE_DIR_NONE
) {
2297 if (tape
->door_locked
== DOOR_LOCKED
) {
2298 if (idetape_create_prevent_cmd(drive
, &pc
, 0)) {
2299 if (!idetape_queue_pc_tail(drive
, &pc
))
2300 tape
->door_locked
= DOOR_UNLOCKED
;
2304 clear_bit(IDETAPE_FLAG_BUSY
, &tape
->flags
);
2311 * check the contents of the ATAPI IDENTIFY command results. We return:
2313 * 1 - If the tape can be supported by us, based on the information we have so
2316 * 0 - If this tape driver is not currently supported by us.
2318 static int idetape_identify_device(ide_drive_t
*drive
)
2320 u8 gcw
[2], protocol
, device_type
, removable
, packet_size
;
2322 if (drive
->id_read
== 0)
2325 *((unsigned short *) &gcw
) = drive
->id
->config
;
2327 protocol
= (gcw
[1] & 0xC0) >> 6;
2328 device_type
= gcw
[1] & 0x1F;
2329 removable
= !!(gcw
[0] & 0x80);
2330 packet_size
= gcw
[0] & 0x3;
2332 /* Check that we can support this device */
2334 printk(KERN_ERR
"ide-tape: Protocol (0x%02x) is not ATAPI\n",
2336 else if (device_type
!= 1)
2337 printk(KERN_ERR
"ide-tape: Device type (0x%02x) is not set "
2338 "to tape\n", device_type
);
2339 else if (!removable
)
2340 printk(KERN_ERR
"ide-tape: The removable flag is not set\n");
2341 else if (packet_size
!= 0) {
2342 printk(KERN_ERR
"ide-tape: Packet size (0x%02x) is not 12"
2343 " bytes\n", packet_size
);
2349 static void idetape_get_inquiry_results(ide_drive_t
*drive
)
2351 idetape_tape_t
*tape
= drive
->driver_data
;
2352 struct ide_atapi_pc pc
;
2353 char fw_rev
[6], vendor_id
[10], product_id
[18];
2355 idetape_create_inquiry_cmd(&pc
);
2356 if (idetape_queue_pc_tail(drive
, &pc
)) {
2357 printk(KERN_ERR
"ide-tape: %s: can't get INQUIRY results\n",
2361 memcpy(vendor_id
, &pc
.buf
[8], 8);
2362 memcpy(product_id
, &pc
.buf
[16], 16);
2363 memcpy(fw_rev
, &pc
.buf
[32], 4);
2365 ide_fixstring(vendor_id
, 10, 0);
2366 ide_fixstring(product_id
, 18, 0);
2367 ide_fixstring(fw_rev
, 6, 0);
2369 printk(KERN_INFO
"ide-tape: %s <-> %s: %s %s rev %s\n",
2370 drive
->name
, tape
->name
, vendor_id
, product_id
, fw_rev
);
2374 * Ask the tape about its various parameters. In particular, we will adjust our
2375 * data transfer buffer size to the recommended value as returned by the tape.
2377 static void idetape_get_mode_sense_results(ide_drive_t
*drive
)
2379 idetape_tape_t
*tape
= drive
->driver_data
;
2380 struct ide_atapi_pc pc
;
2382 u8 speed
, max_speed
;
2384 idetape_create_mode_sense_cmd(&pc
, IDETAPE_CAPABILITIES_PAGE
);
2385 if (idetape_queue_pc_tail(drive
, &pc
)) {
2386 printk(KERN_ERR
"ide-tape: Can't get tape parameters - assuming"
2387 " some default values\n");
2388 tape
->blk_size
= 512;
2389 put_unaligned(52, (u16
*)&tape
->caps
[12]);
2390 put_unaligned(540, (u16
*)&tape
->caps
[14]);
2391 put_unaligned(6*52, (u16
*)&tape
->caps
[16]);
2394 caps
= pc
.buf
+ 4 + pc
.buf
[3];
2396 /* convert to host order and save for later use */
2397 speed
= be16_to_cpu(*(u16
*)&caps
[14]);
2398 max_speed
= be16_to_cpu(*(u16
*)&caps
[8]);
2400 put_unaligned(max_speed
, (u16
*)&caps
[8]);
2401 put_unaligned(be16_to_cpu(*(u16
*)&caps
[12]), (u16
*)&caps
[12]);
2402 put_unaligned(speed
, (u16
*)&caps
[14]);
2403 put_unaligned(be16_to_cpu(*(u16
*)&caps
[16]), (u16
*)&caps
[16]);
2406 printk(KERN_INFO
"ide-tape: %s: invalid tape speed "
2407 "(assuming 650KB/sec)\n", drive
->name
);
2408 put_unaligned(650, (u16
*)&caps
[14]);
2411 printk(KERN_INFO
"ide-tape: %s: invalid max_speed "
2412 "(assuming 650KB/sec)\n", drive
->name
);
2413 put_unaligned(650, (u16
*)&caps
[8]);
2416 memcpy(&tape
->caps
, caps
, 20);
2418 tape
->blk_size
= 512;
2419 else if (caps
[7] & 0x04)
2420 tape
->blk_size
= 1024;
2423 #ifdef CONFIG_IDE_PROC_FS
2424 static void idetape_add_settings(ide_drive_t
*drive
)
2426 idetape_tape_t
*tape
= drive
->driver_data
;
2428 ide_add_setting(drive
, "buffer", SETTING_READ
, TYPE_SHORT
, 0, 0xffff,
2429 1, 2, (u16
*)&tape
->caps
[16], NULL
);
2430 ide_add_setting(drive
, "speed", SETTING_READ
, TYPE_SHORT
, 0, 0xffff,
2431 1, 1, (u16
*)&tape
->caps
[14], NULL
);
2432 ide_add_setting(drive
, "buffer_size", SETTING_READ
, TYPE_INT
, 0, 0xffff,
2433 1, 1024, &tape
->buffer_size
, NULL
);
2434 ide_add_setting(drive
, "tdsc", SETTING_RW
, TYPE_INT
, IDETAPE_DSC_RW_MIN
,
2435 IDETAPE_DSC_RW_MAX
, 1000, HZ
, &tape
->best_dsc_rw_freq
,
2437 ide_add_setting(drive
, "dsc_overlap", SETTING_RW
, TYPE_BYTE
, 0, 1, 1,
2438 1, &drive
->dsc_overlap
, NULL
);
2439 ide_add_setting(drive
, "avg_speed", SETTING_READ
, TYPE_INT
, 0, 0xffff,
2440 1, 1, &tape
->avg_speed
, NULL
);
2441 ide_add_setting(drive
, "debug_mask", SETTING_RW
, TYPE_INT
, 0, 0xffff, 1,
2442 1, &tape
->debug_mask
, NULL
);
2445 static inline void idetape_add_settings(ide_drive_t
*drive
) { ; }
2449 * The function below is called to:
2451 * 1. Initialize our various state variables.
2452 * 2. Ask the tape for its capabilities.
2453 * 3. Allocate a buffer which will be used for data transfer. The buffer size
2454 * is chosen based on the recommendation which we received in step 2.
2456 * Note that at this point ide.c already assigned us an irq, so that we can
2457 * queue requests here and wait for their completion.
2459 static void idetape_setup(ide_drive_t
*drive
, idetape_tape_t
*tape
, int minor
)
2465 u16
*ctl
= (u16
*)&tape
->caps
[12];
2467 spin_lock_init(&tape
->lock
);
2468 drive
->dsc_overlap
= 1;
2469 if (drive
->hwif
->host_flags
& IDE_HFLAG_NO_DSC
) {
2470 printk(KERN_INFO
"ide-tape: %s: disabling DSC overlap\n",
2472 drive
->dsc_overlap
= 0;
2474 /* Seagate Travan drives do not support DSC overlap. */
2475 if (strstr(drive
->id
->model
, "Seagate STT3401"))
2476 drive
->dsc_overlap
= 0;
2477 tape
->minor
= minor
;
2478 tape
->name
[0] = 'h';
2479 tape
->name
[1] = 't';
2480 tape
->name
[2] = '0' + minor
;
2481 tape
->chrdev_dir
= IDETAPE_DIR_NONE
;
2482 tape
->pc
= tape
->pc_stack
;
2483 *((unsigned short *) &gcw
) = drive
->id
->config
;
2485 /* Command packet DRQ type */
2486 if (((gcw
[0] & 0x60) >> 5) == 1)
2487 set_bit(IDETAPE_FLAG_DRQ_INTERRUPT
, &tape
->flags
);
2489 idetape_get_inquiry_results(drive
);
2490 idetape_get_mode_sense_results(drive
);
2491 ide_tape_get_bsize_from_bdesc(drive
);
2492 tape
->user_bs_factor
= 1;
2493 tape
->buffer_size
= *ctl
* tape
->blk_size
;
2494 while (tape
->buffer_size
> 0xffff) {
2495 printk(KERN_NOTICE
"ide-tape: decreasing stage size\n");
2497 tape
->buffer_size
= *ctl
* tape
->blk_size
;
2499 buffer_size
= tape
->buffer_size
;
2500 tape
->pages_per_buffer
= buffer_size
/ PAGE_SIZE
;
2501 if (buffer_size
% PAGE_SIZE
) {
2502 tape
->pages_per_buffer
++;
2503 tape
->excess_bh_size
= PAGE_SIZE
- buffer_size
% PAGE_SIZE
;
2506 /* select the "best" DSC read/write polling freq */
2507 speed
= max(*(u16
*)&tape
->caps
[14], *(u16
*)&tape
->caps
[8]);
2509 t
= (IDETAPE_FIFO_THRESHOLD
* tape
->buffer_size
* HZ
) / (speed
* 1000);
2512 * Ensure that the number we got makes sense; limit it within
2513 * IDETAPE_DSC_RW_MIN and IDETAPE_DSC_RW_MAX.
2515 tape
->best_dsc_rw_freq
= clamp_t(unsigned long, t
, IDETAPE_DSC_RW_MIN
,
2516 IDETAPE_DSC_RW_MAX
);
2517 printk(KERN_INFO
"ide-tape: %s <-> %s: %dKBps, %d*%dkB buffer, "
2519 drive
->name
, tape
->name
, *(u16
*)&tape
->caps
[14],
2520 (*(u16
*)&tape
->caps
[16] * 512) / tape
->buffer_size
,
2521 tape
->buffer_size
/ 1024,
2522 tape
->best_dsc_rw_freq
* 1000 / HZ
,
2523 drive
->using_dma
? ", DMA":"");
2525 idetape_add_settings(drive
);
2528 static void ide_tape_remove(ide_drive_t
*drive
)
2530 idetape_tape_t
*tape
= drive
->driver_data
;
2532 ide_proc_unregister_driver(drive
, tape
->driver
);
2534 ide_unregister_region(tape
->disk
);
2539 static void ide_tape_release(struct kref
*kref
)
2541 struct ide_tape_obj
*tape
= to_ide_tape(kref
);
2542 ide_drive_t
*drive
= tape
->drive
;
2543 struct gendisk
*g
= tape
->disk
;
2545 BUG_ON(tape
->merge_bh_size
);
2547 drive
->dsc_overlap
= 0;
2548 drive
->driver_data
= NULL
;
2549 device_destroy(idetape_sysfs_class
, MKDEV(IDETAPE_MAJOR
, tape
->minor
));
2550 device_destroy(idetape_sysfs_class
,
2551 MKDEV(IDETAPE_MAJOR
, tape
->minor
+ 128));
2552 idetape_devs
[tape
->minor
] = NULL
;
2553 g
->private_data
= NULL
;
2558 #ifdef CONFIG_IDE_PROC_FS
2559 static int proc_idetape_read_name
2560 (char *page
, char **start
, off_t off
, int count
, int *eof
, void *data
)
2562 ide_drive_t
*drive
= (ide_drive_t
*) data
;
2563 idetape_tape_t
*tape
= drive
->driver_data
;
2567 len
= sprintf(out
, "%s\n", tape
->name
);
2568 PROC_IDE_READ_RETURN(page
, start
, off
, count
, eof
, len
);
2571 static ide_proc_entry_t idetape_proc
[] = {
2572 { "capacity", S_IFREG
|S_IRUGO
, proc_ide_read_capacity
, NULL
},
2573 { "name", S_IFREG
|S_IRUGO
, proc_idetape_read_name
, NULL
},
2574 { NULL
, 0, NULL
, NULL
}
2578 static int ide_tape_probe(ide_drive_t
*);
2580 static ide_driver_t idetape_driver
= {
2582 .owner
= THIS_MODULE
,
2584 .bus
= &ide_bus_type
,
2586 .probe
= ide_tape_probe
,
2587 .remove
= ide_tape_remove
,
2588 .version
= IDETAPE_VERSION
,
2590 .supports_dsc_overlap
= 1,
2591 .do_request
= idetape_do_request
,
2592 .end_request
= idetape_end_request
,
2593 .error
= __ide_error
,
2594 .abort
= __ide_abort
,
2595 #ifdef CONFIG_IDE_PROC_FS
2596 .proc
= idetape_proc
,
2600 /* Our character device supporting functions, passed to register_chrdev. */
2601 static const struct file_operations idetape_fops
= {
2602 .owner
= THIS_MODULE
,
2603 .read
= idetape_chrdev_read
,
2604 .write
= idetape_chrdev_write
,
2605 .ioctl
= idetape_chrdev_ioctl
,
2606 .open
= idetape_chrdev_open
,
2607 .release
= idetape_chrdev_release
,
2610 static int idetape_open(struct inode
*inode
, struct file
*filp
)
2612 struct gendisk
*disk
= inode
->i_bdev
->bd_disk
;
2613 struct ide_tape_obj
*tape
;
2615 tape
= ide_tape_get(disk
);
2622 static int idetape_release(struct inode
*inode
, struct file
*filp
)
2624 struct gendisk
*disk
= inode
->i_bdev
->bd_disk
;
2625 struct ide_tape_obj
*tape
= ide_tape_g(disk
);
2632 static int idetape_ioctl(struct inode
*inode
, struct file
*file
,
2633 unsigned int cmd
, unsigned long arg
)
2635 struct block_device
*bdev
= inode
->i_bdev
;
2636 struct ide_tape_obj
*tape
= ide_tape_g(bdev
->bd_disk
);
2637 ide_drive_t
*drive
= tape
->drive
;
2638 int err
= generic_ide_ioctl(drive
, file
, bdev
, cmd
, arg
);
2640 err
= idetape_blkdev_ioctl(drive
, cmd
, arg
);
2644 static struct block_device_operations idetape_block_ops
= {
2645 .owner
= THIS_MODULE
,
2646 .open
= idetape_open
,
2647 .release
= idetape_release
,
2648 .ioctl
= idetape_ioctl
,
2651 static int ide_tape_probe(ide_drive_t
*drive
)
2653 idetape_tape_t
*tape
;
2657 if (!strstr("ide-tape", drive
->driver_req
))
2659 if (!drive
->present
)
2661 if (drive
->media
!= ide_tape
)
2663 if (!idetape_identify_device(drive
)) {
2664 printk(KERN_ERR
"ide-tape: %s: not supported by this version of"
2665 " the driver\n", drive
->name
);
2668 tape
= kzalloc(sizeof(idetape_tape_t
), GFP_KERNEL
);
2670 printk(KERN_ERR
"ide-tape: %s: Can't allocate a tape struct\n",
2675 g
= alloc_disk(1 << PARTN_BITS
);
2679 ide_init_disk(g
, drive
);
2681 ide_proc_register_driver(drive
, &idetape_driver
);
2683 kref_init(&tape
->kref
);
2685 tape
->drive
= drive
;
2686 tape
->driver
= &idetape_driver
;
2689 g
->private_data
= &tape
->driver
;
2691 drive
->driver_data
= tape
;
2693 mutex_lock(&idetape_ref_mutex
);
2694 for (minor
= 0; idetape_devs
[minor
]; minor
++)
2696 idetape_devs
[minor
] = tape
;
2697 mutex_unlock(&idetape_ref_mutex
);
2699 idetape_setup(drive
, tape
, minor
);
2701 device_create(idetape_sysfs_class
, &drive
->gendev
,
2702 MKDEV(IDETAPE_MAJOR
, minor
), "%s", tape
->name
);
2703 device_create(idetape_sysfs_class
, &drive
->gendev
,
2704 MKDEV(IDETAPE_MAJOR
, minor
+ 128), "n%s", tape
->name
);
2706 g
->fops
= &idetape_block_ops
;
2707 ide_register_region(g
);
2717 static void __exit
idetape_exit(void)
2719 driver_unregister(&idetape_driver
.gen_driver
);
2720 class_destroy(idetape_sysfs_class
);
2721 unregister_chrdev(IDETAPE_MAJOR
, "ht");
2724 static int __init
idetape_init(void)
2727 idetape_sysfs_class
= class_create(THIS_MODULE
, "ide_tape");
2728 if (IS_ERR(idetape_sysfs_class
)) {
2729 idetape_sysfs_class
= NULL
;
2730 printk(KERN_ERR
"Unable to create sysfs class for ide tapes\n");
2735 if (register_chrdev(IDETAPE_MAJOR
, "ht", &idetape_fops
)) {
2736 printk(KERN_ERR
"ide-tape: Failed to register chrdev"
2739 goto out_free_class
;
2742 error
= driver_register(&idetape_driver
.gen_driver
);
2744 goto out_free_driver
;
2749 driver_unregister(&idetape_driver
.gen_driver
);
2751 class_destroy(idetape_sysfs_class
);
2756 MODULE_ALIAS("ide:*m-tape*");
2757 module_init(idetape_init
);
2758 module_exit(idetape_exit
);
2759 MODULE_ALIAS_CHARDEV_MAJOR(IDETAPE_MAJOR
);
2760 MODULE_DESCRIPTION("ATAPI Streaming TAPE Driver");
2761 MODULE_LICENSE("GPL");