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
199 * Most of our global data which we need to save even as we leave the driver due
200 * to an interrupt or a timer event is stored in the struct defined below.
202 typedef struct ide_tape_obj
{
204 ide_driver_t
*driver
;
205 struct gendisk
*disk
;
209 * Since a typical character device operation requires more
210 * than one packet command, we provide here enough memory
211 * for the maximum of interconnected packet commands.
212 * The packet commands are stored in the circular array pc_stack.
213 * pc_stack_index points to the last used entry, and warps around
214 * to the start when we get to the last array entry.
216 * pc points to the current processed packet command.
218 * failed_pc points to the last failed packet command, or contains
219 * NULL if we do not need to retry any packet command. This is
220 * required since an additional packet command is needed before the
221 * retry, to get detailed information on what went wrong.
223 /* Current packet command */
224 struct ide_atapi_pc
*pc
;
225 /* Last failed packet command */
226 struct ide_atapi_pc
*failed_pc
;
227 /* Packet command stack */
228 struct ide_atapi_pc pc_stack
[IDETAPE_PC_STACK
];
229 /* Next free packet command storage space */
231 struct request rq_stack
[IDETAPE_PC_STACK
];
232 /* We implement a circular array */
236 * DSC polling variables.
238 * While polling for DSC we use postponed_rq to postpone the current
239 * request so that ide.c will be able to service pending requests on the
240 * other device. Note that at most we will have only one DSC (usually
241 * data transfer) request in the device request queue.
243 struct request
*postponed_rq
;
244 /* The time in which we started polling for DSC */
245 unsigned long dsc_polling_start
;
246 /* Timer used to poll for dsc */
247 struct timer_list dsc_timer
;
248 /* Read/Write dsc polling frequency */
249 unsigned long best_dsc_rw_freq
;
250 unsigned long dsc_poll_freq
;
251 unsigned long dsc_timeout
;
253 /* Read position information */
256 unsigned int first_frame
;
258 /* Last error information */
259 u8 sense_key
, asc
, ascq
;
261 /* Character device operation */
265 /* Current character device data transfer direction */
268 /* tape block size, usually 512 or 1024 bytes */
269 unsigned short blk_size
;
272 /* Copy of the tape's Capabilities and Mechanical Page */
276 * Active data transfer request parameters.
278 * At most, there is only one ide-tape originated data transfer request
279 * in the device request queue. This allows ide.c to easily service
280 * requests from the other device when we postpone our active request.
283 /* Data buffer size chosen based on the tape's recommendation */
286 struct idetape_bh
*merge_bh
;
287 /* size of the merge buffer */
289 /* pointer to current buffer head within the merge buffer */
290 struct idetape_bh
*bh
;
294 int pages_per_buffer
;
295 /* Wasted space in each stage */
298 /* protects the ide-tape queue */
301 /* Measures average tape speed */
302 unsigned long avg_time
;
306 /* the door is currently locked */
308 /* the tape hardware is write protected */
310 /* the tape is write protected (hardware or opened as read-only) */
316 static DEFINE_MUTEX(idetape_ref_mutex
);
318 static struct class *idetape_sysfs_class
;
320 #define to_ide_tape(obj) container_of(obj, struct ide_tape_obj, kref)
322 #define ide_tape_g(disk) \
323 container_of((disk)->private_data, struct ide_tape_obj, driver)
325 static void ide_tape_release(struct kref
*);
327 static struct ide_tape_obj
*ide_tape_get(struct gendisk
*disk
)
329 struct ide_tape_obj
*tape
= NULL
;
331 mutex_lock(&idetape_ref_mutex
);
332 tape
= ide_tape_g(disk
);
334 if (ide_device_get(tape
->drive
))
337 kref_get(&tape
->kref
);
339 mutex_unlock(&idetape_ref_mutex
);
343 static void ide_tape_put(struct ide_tape_obj
*tape
)
345 ide_drive_t
*drive
= tape
->drive
;
347 mutex_lock(&idetape_ref_mutex
);
348 kref_put(&tape
->kref
, ide_tape_release
);
349 ide_device_put(drive
);
350 mutex_unlock(&idetape_ref_mutex
);
354 * The variables below are used for the character device interface. Additional
355 * state variables are defined in our ide_drive_t structure.
357 static struct ide_tape_obj
*idetape_devs
[MAX_HWIFS
* MAX_DRIVES
];
359 #define ide_tape_f(file) ((file)->private_data)
361 static struct ide_tape_obj
*ide_tape_chrdev_get(unsigned int i
)
363 struct ide_tape_obj
*tape
= NULL
;
365 mutex_lock(&idetape_ref_mutex
);
366 tape
= idetape_devs
[i
];
368 kref_get(&tape
->kref
);
369 mutex_unlock(&idetape_ref_mutex
);
373 static void idetape_input_buffers(ide_drive_t
*drive
, struct ide_atapi_pc
*pc
,
376 struct idetape_bh
*bh
= pc
->bh
;
381 printk(KERN_ERR
"ide-tape: bh == NULL in "
382 "idetape_input_buffers\n");
383 ide_pad_transfer(drive
, 0, bcount
);
387 (unsigned int)(bh
->b_size
- atomic_read(&bh
->b_count
)),
389 drive
->hwif
->tp_ops
->input_data(drive
, NULL
, bh
->b_data
+
390 atomic_read(&bh
->b_count
), count
);
392 atomic_add(count
, &bh
->b_count
);
393 if (atomic_read(&bh
->b_count
) == bh
->b_size
) {
396 atomic_set(&bh
->b_count
, 0);
402 static void idetape_output_buffers(ide_drive_t
*drive
, struct ide_atapi_pc
*pc
,
405 struct idetape_bh
*bh
= pc
->bh
;
410 printk(KERN_ERR
"ide-tape: bh == NULL in %s\n",
414 count
= min((unsigned int)pc
->b_count
, (unsigned int)bcount
);
415 drive
->hwif
->tp_ops
->output_data(drive
, NULL
, pc
->b_data
, count
);
418 pc
->b_count
-= count
;
423 pc
->b_data
= bh
->b_data
;
424 pc
->b_count
= atomic_read(&bh
->b_count
);
430 static void idetape_update_buffers(ide_drive_t
*drive
, struct ide_atapi_pc
*pc
)
432 struct idetape_bh
*bh
= pc
->bh
;
434 unsigned int bcount
= pc
->xferred
;
436 if (pc
->flags
& PC_FLAG_WRITING
)
440 printk(KERN_ERR
"ide-tape: bh == NULL in %s\n",
444 count
= min((unsigned int)bh
->b_size
, (unsigned int)bcount
);
445 atomic_set(&bh
->b_count
, count
);
446 if (atomic_read(&bh
->b_count
) == bh
->b_size
)
454 * idetape_next_pc_storage returns a pointer to a place in which we can
455 * safely store a packet command, even though we intend to leave the
456 * driver. A storage space for a maximum of IDETAPE_PC_STACK packet
457 * commands is allocated at initialization time.
459 static struct ide_atapi_pc
*idetape_next_pc_storage(ide_drive_t
*drive
)
461 idetape_tape_t
*tape
= drive
->driver_data
;
463 debug_log(DBG_PCRQ_STACK
, "pc_stack_index=%d\n", tape
->pc_stack_index
);
465 if (tape
->pc_stack_index
== IDETAPE_PC_STACK
)
466 tape
->pc_stack_index
= 0;
467 return (&tape
->pc_stack
[tape
->pc_stack_index
++]);
471 * idetape_next_rq_storage is used along with idetape_next_pc_storage.
472 * Since we queue packet commands in the request queue, we need to
473 * allocate a request, along with the allocation of a packet command.
476 /**************************************************************
478 * This should get fixed to use kmalloc(.., GFP_ATOMIC) *
479 * followed later on by kfree(). -ml *
481 **************************************************************/
483 static struct request
*idetape_next_rq_storage(ide_drive_t
*drive
)
485 idetape_tape_t
*tape
= drive
->driver_data
;
487 debug_log(DBG_PCRQ_STACK
, "rq_stack_index=%d\n", tape
->rq_stack_index
);
489 if (tape
->rq_stack_index
== IDETAPE_PC_STACK
)
490 tape
->rq_stack_index
= 0;
491 return (&tape
->rq_stack
[tape
->rq_stack_index
++]);
495 * called on each failed packet command retry to analyze the request sense. We
496 * currently do not utilize this information.
498 static void idetape_analyze_error(ide_drive_t
*drive
, u8
*sense
)
500 idetape_tape_t
*tape
= drive
->driver_data
;
501 struct ide_atapi_pc
*pc
= tape
->failed_pc
;
503 tape
->sense_key
= sense
[2] & 0xF;
504 tape
->asc
= sense
[12];
505 tape
->ascq
= sense
[13];
507 debug_log(DBG_ERR
, "pc = %x, sense key = %x, asc = %x, ascq = %x\n",
508 pc
->c
[0], tape
->sense_key
, tape
->asc
, tape
->ascq
);
510 /* Correct pc->xferred by asking the tape. */
511 if (pc
->flags
& PC_FLAG_DMA_ERROR
) {
512 pc
->xferred
= pc
->req_xfer
-
514 get_unaligned_be32(&sense
[3]);
515 idetape_update_buffers(drive
, pc
);
519 * If error was the result of a zero-length read or write command,
520 * with sense key=5, asc=0x22, ascq=0, let it slide. Some drives
521 * (i.e. Seagate STT3401A Travan) don't support 0-length read/writes.
523 if ((pc
->c
[0] == READ_6
|| pc
->c
[0] == WRITE_6
)
525 && pc
->c
[4] == 0 && pc
->c
[3] == 0 && pc
->c
[2] == 0) {
526 if (tape
->sense_key
== 5) {
527 /* don't report an error, everything's ok */
529 /* don't retry read/write */
530 pc
->flags
|= PC_FLAG_ABORT
;
533 if (pc
->c
[0] == READ_6
&& (sense
[2] & 0x80)) {
534 pc
->error
= IDETAPE_ERROR_FILEMARK
;
535 pc
->flags
|= PC_FLAG_ABORT
;
537 if (pc
->c
[0] == WRITE_6
) {
538 if ((sense
[2] & 0x40) || (tape
->sense_key
== 0xd
539 && tape
->asc
== 0x0 && tape
->ascq
== 0x2)) {
540 pc
->error
= IDETAPE_ERROR_EOD
;
541 pc
->flags
|= PC_FLAG_ABORT
;
544 if (pc
->c
[0] == READ_6
|| pc
->c
[0] == WRITE_6
) {
545 if (tape
->sense_key
== 8) {
546 pc
->error
= IDETAPE_ERROR_EOD
;
547 pc
->flags
|= PC_FLAG_ABORT
;
549 if (!(pc
->flags
& PC_FLAG_ABORT
) &&
551 pc
->retries
= IDETAPE_MAX_PC_RETRIES
+ 1;
555 /* Free data buffers completely. */
556 static void ide_tape_kfree_buffer(idetape_tape_t
*tape
)
558 struct idetape_bh
*prev_bh
, *bh
= tape
->merge_bh
;
561 u32 size
= bh
->b_size
;
564 unsigned int order
= fls(size
>> PAGE_SHIFT
)-1;
567 free_pages((unsigned long)bh
->b_data
, order
);
570 bh
->b_data
+= (1 << order
) * PAGE_SIZE
;
578 static int idetape_end_request(ide_drive_t
*drive
, int uptodate
, int nr_sects
)
580 struct request
*rq
= HWGROUP(drive
)->rq
;
581 idetape_tape_t
*tape
= drive
->driver_data
;
585 debug_log(DBG_PROCS
, "Enter %s\n", __func__
);
588 case 0: error
= IDETAPE_ERROR_GENERAL
; break;
589 case 1: error
= 0; break;
590 default: error
= uptodate
;
594 tape
->failed_pc
= NULL
;
596 if (!blk_special_request(rq
)) {
597 ide_end_request(drive
, uptodate
, nr_sects
);
601 spin_lock_irqsave(&tape
->lock
, flags
);
603 ide_end_drive_cmd(drive
, 0, 0);
605 spin_unlock_irqrestore(&tape
->lock
, flags
);
609 static void ide_tape_callback(ide_drive_t
*drive
)
611 idetape_tape_t
*tape
= drive
->driver_data
;
612 struct ide_atapi_pc
*pc
= tape
->pc
;
613 int uptodate
= pc
->error
? 0 : 1;
615 debug_log(DBG_PROCS
, "Enter %s\n", __func__
);
617 if (tape
->failed_pc
== pc
)
618 tape
->failed_pc
= NULL
;
620 if (pc
->c
[0] == REQUEST_SENSE
) {
622 idetape_analyze_error(drive
, pc
->buf
);
624 printk(KERN_ERR
"ide-tape: Error in REQUEST SENSE "
625 "itself - Aborting request!\n");
626 } else if (pc
->c
[0] == READ_6
|| pc
->c
[0] == WRITE_6
) {
627 struct request
*rq
= drive
->hwif
->hwgroup
->rq
;
628 int blocks
= pc
->xferred
/ tape
->blk_size
;
630 tape
->avg_size
+= blocks
* tape
->blk_size
;
632 if (time_after_eq(jiffies
, tape
->avg_time
+ HZ
)) {
633 tape
->avg_speed
= tape
->avg_size
* HZ
/
634 (jiffies
- tape
->avg_time
) / 1024;
636 tape
->avg_time
= jiffies
;
639 tape
->first_frame
+= blocks
;
640 rq
->current_nr_sectors
-= blocks
;
643 uptodate
= pc
->error
;
644 } else if (pc
->c
[0] == READ_POSITION
&& uptodate
) {
645 u8
*readpos
= tape
->pc
->buf
;
647 debug_log(DBG_SENSE
, "BOP - %s\n",
648 (readpos
[0] & 0x80) ? "Yes" : "No");
649 debug_log(DBG_SENSE
, "EOP - %s\n",
650 (readpos
[0] & 0x40) ? "Yes" : "No");
652 if (readpos
[0] & 0x4) {
653 printk(KERN_INFO
"ide-tape: Block location is unknown"
655 clear_bit(IDE_AFLAG_ADDRESS_VALID
, &drive
->atapi_flags
);
658 debug_log(DBG_SENSE
, "Block Location - %u\n",
659 be32_to_cpup((__be32
*)&readpos
[4]));
661 tape
->partition
= readpos
[1];
662 tape
->first_frame
= be32_to_cpup((__be32
*)&readpos
[4]);
663 set_bit(IDE_AFLAG_ADDRESS_VALID
, &drive
->atapi_flags
);
667 idetape_end_request(drive
, uptodate
, 0);
670 static void idetape_init_pc(struct ide_atapi_pc
*pc
)
672 memset(pc
->c
, 0, 12);
676 pc
->buf
= pc
->pc_buf
;
677 pc
->buf_size
= IDETAPE_PC_BUFFER_SIZE
;
682 static void idetape_create_request_sense_cmd(struct ide_atapi_pc
*pc
)
685 pc
->c
[0] = REQUEST_SENSE
;
690 static void idetape_init_rq(struct request
*rq
, u8 cmd
)
692 blk_rq_init(NULL
, rq
);
693 rq
->cmd_type
= REQ_TYPE_SPECIAL
;
698 * Generate a new packet command request in front of the request queue, before
699 * the current request, so that it will be processed immediately, on the next
700 * pass through the driver. The function below is called from the request
701 * handling part of the driver (the "bottom" part). Safe storage for the request
702 * should be allocated with ide_tape_next_{pc,rq}_storage() prior to that.
704 * Memory for those requests is pre-allocated at initialization time, and is
705 * limited to IDETAPE_PC_STACK requests. We assume that we have enough space for
706 * the maximum possible number of inter-dependent packet commands.
708 * The higher level of the driver - The ioctl handler and the character device
709 * handling functions should queue request to the lower level part and wait for
710 * their completion using idetape_queue_pc_tail or idetape_queue_rw_tail.
712 static void idetape_queue_pc_head(ide_drive_t
*drive
, struct ide_atapi_pc
*pc
,
715 struct ide_tape_obj
*tape
= drive
->driver_data
;
717 idetape_init_rq(rq
, REQ_IDETAPE_PC1
);
718 rq
->cmd_flags
|= REQ_PREEMPT
;
719 rq
->buffer
= (char *) pc
;
720 rq
->rq_disk
= tape
->disk
;
721 memcpy(rq
->cmd
, pc
->c
, 12);
722 ide_do_drive_cmd(drive
, rq
);
726 * idetape_retry_pc is called when an error was detected during the
727 * last packet command. We queue a request sense packet command in
728 * the head of the request list.
730 static void idetape_retry_pc(ide_drive_t
*drive
)
732 struct ide_atapi_pc
*pc
;
735 (void)ide_read_error(drive
);
736 pc
= idetape_next_pc_storage(drive
);
737 rq
= idetape_next_rq_storage(drive
);
738 idetape_create_request_sense_cmd(pc
);
739 set_bit(IDE_AFLAG_IGNORE_DSC
, &drive
->atapi_flags
);
740 idetape_queue_pc_head(drive
, pc
, rq
);
744 * Postpone the current request so that ide.c will be able to service requests
745 * from another device on the same hwgroup while we are polling for DSC.
747 static void idetape_postpone_request(ide_drive_t
*drive
)
749 idetape_tape_t
*tape
= drive
->driver_data
;
751 debug_log(DBG_PROCS
, "Enter %s\n", __func__
);
753 tape
->postponed_rq
= HWGROUP(drive
)->rq
;
754 ide_stall_queue(drive
, tape
->dsc_poll_freq
);
757 static void ide_tape_handle_dsc(ide_drive_t
*drive
)
759 idetape_tape_t
*tape
= drive
->driver_data
;
761 /* Media access command */
762 tape
->dsc_polling_start
= jiffies
;
763 tape
->dsc_poll_freq
= IDETAPE_DSC_MA_FAST
;
764 tape
->dsc_timeout
= jiffies
+ IDETAPE_DSC_MA_TIMEOUT
;
765 /* Allow ide.c to handle other requests */
766 idetape_postpone_request(drive
);
769 static void ide_tape_io_buffers(ide_drive_t
*drive
, struct ide_atapi_pc
*pc
,
770 unsigned int bcount
, int write
)
773 idetape_output_buffers(drive
, pc
, bcount
);
775 idetape_input_buffers(drive
, pc
, bcount
);
779 * This is the usual interrupt handler which will be called during a packet
780 * command. We will transfer some of the data (as requested by the drive) and
781 * will re-point interrupt handler to us. When data transfer is finished, we
782 * will act according to the algorithm described before
785 static ide_startstop_t
idetape_pc_intr(ide_drive_t
*drive
)
787 idetape_tape_t
*tape
= drive
->driver_data
;
789 return ide_pc_intr(drive
, tape
->pc
, idetape_pc_intr
, IDETAPE_WAIT_CMD
,
790 NULL
, idetape_update_buffers
, idetape_retry_pc
,
791 ide_tape_handle_dsc
, ide_tape_io_buffers
);
795 * Packet Command Interface
797 * The current Packet Command is available in tape->pc, and will not change
798 * until we finish handling it. Each packet command is associated with a
799 * callback function that will be called when the command is finished.
801 * The handling will be done in three stages:
803 * 1. idetape_issue_pc will send the packet command to the drive, and will set
804 * the interrupt handler to idetape_pc_intr.
806 * 2. On each interrupt, idetape_pc_intr will be called. This step will be
807 * repeated until the device signals us that no more interrupts will be issued.
809 * 3. ATAPI Tape media access commands have immediate status with a delayed
810 * process. In case of a successful initiation of a media access packet command,
811 * the DSC bit will be set when the actual execution of the command is finished.
812 * Since the tape drive will not issue an interrupt, we have to poll for this
813 * event. In this case, we define the request as "low priority request" by
814 * setting rq_status to IDETAPE_RQ_POSTPONED, set a timer to poll for DSC and
817 * ide.c will then give higher priority to requests which originate from the
818 * other device, until will change rq_status to RQ_ACTIVE.
820 * 4. When the packet command is finished, it will be checked for errors.
822 * 5. In case an error was found, we queue a request sense packet command in
823 * front of the request queue and retry the operation up to
824 * IDETAPE_MAX_PC_RETRIES times.
826 * 6. In case no error was found, or we decided to give up and not to retry
827 * again, the callback function will be called and then we will handle the next
830 static ide_startstop_t
idetape_transfer_pc(ide_drive_t
*drive
)
832 idetape_tape_t
*tape
= drive
->driver_data
;
834 return ide_transfer_pc(drive
, tape
->pc
, idetape_pc_intr
,
835 IDETAPE_WAIT_CMD
, NULL
);
838 static ide_startstop_t
idetape_issue_pc(ide_drive_t
*drive
,
839 struct ide_atapi_pc
*pc
)
841 idetape_tape_t
*tape
= drive
->driver_data
;
843 if (tape
->pc
->c
[0] == REQUEST_SENSE
&&
844 pc
->c
[0] == REQUEST_SENSE
) {
845 printk(KERN_ERR
"ide-tape: possible ide-tape.c bug - "
846 "Two request sense in serial were issued\n");
849 if (tape
->failed_pc
== NULL
&& pc
->c
[0] != REQUEST_SENSE
)
850 tape
->failed_pc
= pc
;
851 /* Set the current packet command */
854 if (pc
->retries
> IDETAPE_MAX_PC_RETRIES
||
855 (pc
->flags
& PC_FLAG_ABORT
)) {
857 * We will "abort" retrying a packet command in case legitimate
858 * error code was received (crossing a filemark, or end of the
859 * media, for example).
861 if (!(pc
->flags
& PC_FLAG_ABORT
)) {
862 if (!(pc
->c
[0] == TEST_UNIT_READY
&&
863 tape
->sense_key
== 2 && tape
->asc
== 4 &&
864 (tape
->ascq
== 1 || tape
->ascq
== 8))) {
865 printk(KERN_ERR
"ide-tape: %s: I/O error, "
866 "pc = %2x, key = %2x, "
867 "asc = %2x, ascq = %2x\n",
868 tape
->name
, pc
->c
[0],
869 tape
->sense_key
, tape
->asc
,
873 pc
->error
= IDETAPE_ERROR_GENERAL
;
875 tape
->failed_pc
= NULL
;
876 drive
->pc_callback(drive
);
879 debug_log(DBG_SENSE
, "Retry #%d, cmd = %02X\n", pc
->retries
, pc
->c
[0]);
883 return ide_issue_pc(drive
, pc
, idetape_transfer_pc
,
884 IDETAPE_WAIT_CMD
, NULL
);
887 /* A mode sense command is used to "sense" tape parameters. */
888 static void idetape_create_mode_sense_cmd(struct ide_atapi_pc
*pc
, u8 page_code
)
891 pc
->c
[0] = MODE_SENSE
;
892 if (page_code
!= IDETAPE_BLOCK_DESCRIPTOR
)
893 /* DBD = 1 - Don't return block descriptors */
895 pc
->c
[2] = page_code
;
897 * Changed pc->c[3] to 0 (255 will at best return unused info).
899 * For SCSI this byte is defined as subpage instead of high byte
900 * of length and some IDE drives seem to interpret it this way
901 * and return an error when 255 is used.
904 /* We will just discard data in that case */
906 if (page_code
== IDETAPE_BLOCK_DESCRIPTOR
)
908 else if (page_code
== IDETAPE_CAPABILITIES_PAGE
)
914 static ide_startstop_t
idetape_media_access_finished(ide_drive_t
*drive
)
916 ide_hwif_t
*hwif
= drive
->hwif
;
917 idetape_tape_t
*tape
= drive
->driver_data
;
918 struct ide_atapi_pc
*pc
= tape
->pc
;
921 stat
= hwif
->tp_ops
->read_status(hwif
);
923 if (stat
& SEEK_STAT
) {
924 if (stat
& ERR_STAT
) {
926 if (pc
->c
[0] != TEST_UNIT_READY
)
927 printk(KERN_ERR
"ide-tape: %s: I/O error, ",
929 /* Retry operation */
930 idetape_retry_pc(drive
);
935 pc
->error
= IDETAPE_ERROR_GENERAL
;
936 tape
->failed_pc
= NULL
;
938 drive
->pc_callback(drive
);
942 static void ide_tape_create_rw_cmd(idetape_tape_t
*tape
,
943 struct ide_atapi_pc
*pc
, struct request
*rq
,
946 struct idetape_bh
*bh
= (struct idetape_bh
*)rq
->special
;
947 unsigned int length
= rq
->current_nr_sectors
;
950 put_unaligned(cpu_to_be32(length
), (unsigned int *) &pc
->c
[1]);
954 pc
->buf_size
= length
* tape
->blk_size
;
955 pc
->req_xfer
= pc
->buf_size
;
956 if (pc
->req_xfer
== tape
->buffer_size
)
957 pc
->flags
|= PC_FLAG_DMA_OK
;
959 if (opcode
== READ_6
) {
961 atomic_set(&bh
->b_count
, 0);
962 } else if (opcode
== WRITE_6
) {
964 pc
->flags
|= PC_FLAG_WRITING
;
965 pc
->b_data
= bh
->b_data
;
966 pc
->b_count
= atomic_read(&bh
->b_count
);
969 memcpy(rq
->cmd
, pc
->c
, 12);
972 static ide_startstop_t
idetape_do_request(ide_drive_t
*drive
,
973 struct request
*rq
, sector_t block
)
975 ide_hwif_t
*hwif
= drive
->hwif
;
976 idetape_tape_t
*tape
= drive
->driver_data
;
977 struct ide_atapi_pc
*pc
= NULL
;
978 struct request
*postponed_rq
= tape
->postponed_rq
;
981 debug_log(DBG_SENSE
, "sector: %llu, nr_sectors: %lu,"
982 " current_nr_sectors: %u\n",
983 (unsigned long long)rq
->sector
, rq
->nr_sectors
,
984 rq
->current_nr_sectors
);
986 if (!blk_special_request(rq
)) {
987 /* We do not support buffer cache originated requests. */
988 printk(KERN_NOTICE
"ide-tape: %s: Unsupported request in "
989 "request queue (%d)\n", drive
->name
, rq
->cmd_type
);
990 ide_end_request(drive
, 0, 0);
994 /* Retry a failed packet command */
995 if (tape
->failed_pc
&& tape
->pc
->c
[0] == REQUEST_SENSE
) {
996 pc
= tape
->failed_pc
;
1000 if (postponed_rq
!= NULL
)
1001 if (rq
!= postponed_rq
) {
1002 printk(KERN_ERR
"ide-tape: ide-tape.c bug - "
1003 "Two DSC requests were queued\n");
1004 idetape_end_request(drive
, 0, 0);
1008 tape
->postponed_rq
= NULL
;
1011 * If the tape is still busy, postpone our request and service
1012 * the other device meanwhile.
1014 stat
= hwif
->tp_ops
->read_status(hwif
);
1016 if (!drive
->dsc_overlap
&& !(rq
->cmd
[13] & REQ_IDETAPE_PC2
))
1017 set_bit(IDE_AFLAG_IGNORE_DSC
, &drive
->atapi_flags
);
1019 if (drive
->post_reset
== 1) {
1020 set_bit(IDE_AFLAG_IGNORE_DSC
, &drive
->atapi_flags
);
1021 drive
->post_reset
= 0;
1024 if (!test_and_clear_bit(IDE_AFLAG_IGNORE_DSC
, &drive
->atapi_flags
) &&
1025 (stat
& SEEK_STAT
) == 0) {
1026 if (postponed_rq
== NULL
) {
1027 tape
->dsc_polling_start
= jiffies
;
1028 tape
->dsc_poll_freq
= tape
->best_dsc_rw_freq
;
1029 tape
->dsc_timeout
= jiffies
+ IDETAPE_DSC_RW_TIMEOUT
;
1030 } else if (time_after(jiffies
, tape
->dsc_timeout
)) {
1031 printk(KERN_ERR
"ide-tape: %s: DSC timeout\n",
1033 if (rq
->cmd
[13] & REQ_IDETAPE_PC2
) {
1034 idetape_media_access_finished(drive
);
1037 return ide_do_reset(drive
);
1039 } else if (time_after(jiffies
,
1040 tape
->dsc_polling_start
+
1041 IDETAPE_DSC_MA_THRESHOLD
))
1042 tape
->dsc_poll_freq
= IDETAPE_DSC_MA_SLOW
;
1043 idetape_postpone_request(drive
);
1046 if (rq
->cmd
[13] & REQ_IDETAPE_READ
) {
1047 pc
= idetape_next_pc_storage(drive
);
1048 ide_tape_create_rw_cmd(tape
, pc
, rq
, READ_6
);
1051 if (rq
->cmd
[13] & REQ_IDETAPE_WRITE
) {
1052 pc
= idetape_next_pc_storage(drive
);
1053 ide_tape_create_rw_cmd(tape
, pc
, rq
, WRITE_6
);
1056 if (rq
->cmd
[13] & REQ_IDETAPE_PC1
) {
1057 pc
= (struct ide_atapi_pc
*) rq
->buffer
;
1058 rq
->cmd
[13] &= ~(REQ_IDETAPE_PC1
);
1059 rq
->cmd
[13] |= REQ_IDETAPE_PC2
;
1062 if (rq
->cmd
[13] & REQ_IDETAPE_PC2
) {
1063 idetape_media_access_finished(drive
);
1069 return idetape_issue_pc(drive
, pc
);
1073 * The function below uses __get_free_pages to allocate a data buffer of size
1074 * tape->buffer_size (or a bit more). We attempt to combine sequential pages as
1077 * It returns a pointer to the newly allocated buffer, or NULL in case of
1080 static struct idetape_bh
*ide_tape_kmalloc_buffer(idetape_tape_t
*tape
,
1081 int full
, int clear
)
1083 struct idetape_bh
*prev_bh
, *bh
, *merge_bh
;
1084 int pages
= tape
->pages_per_buffer
;
1085 unsigned int order
, b_allocd
;
1086 char *b_data
= NULL
;
1088 merge_bh
= kmalloc(sizeof(struct idetape_bh
), GFP_KERNEL
);
1093 order
= fls(pages
) - 1;
1094 bh
->b_data
= (char *) __get_free_pages(GFP_KERNEL
, order
);
1097 b_allocd
= (1 << order
) * PAGE_SIZE
;
1101 memset(bh
->b_data
, 0, b_allocd
);
1102 bh
->b_reqnext
= NULL
;
1103 bh
->b_size
= b_allocd
;
1104 atomic_set(&bh
->b_count
, full
? bh
->b_size
: 0);
1107 order
= fls(pages
) - 1;
1108 b_data
= (char *) __get_free_pages(GFP_KERNEL
, order
);
1111 b_allocd
= (1 << order
) * PAGE_SIZE
;
1114 memset(b_data
, 0, b_allocd
);
1116 /* newly allocated page frames below buffer header or ...*/
1117 if (bh
->b_data
== b_data
+ b_allocd
) {
1118 bh
->b_size
+= b_allocd
;
1119 bh
->b_data
-= b_allocd
;
1121 atomic_add(b_allocd
, &bh
->b_count
);
1124 /* they are above the header */
1125 if (b_data
== bh
->b_data
+ bh
->b_size
) {
1126 bh
->b_size
+= b_allocd
;
1128 atomic_add(b_allocd
, &bh
->b_count
);
1132 bh
= kmalloc(sizeof(struct idetape_bh
), GFP_KERNEL
);
1134 free_pages((unsigned long) b_data
, order
);
1137 bh
->b_reqnext
= NULL
;
1138 bh
->b_data
= b_data
;
1139 bh
->b_size
= b_allocd
;
1140 atomic_set(&bh
->b_count
, full
? bh
->b_size
: 0);
1141 prev_bh
->b_reqnext
= bh
;
1146 bh
->b_size
-= tape
->excess_bh_size
;
1148 atomic_sub(tape
->excess_bh_size
, &bh
->b_count
);
1151 ide_tape_kfree_buffer(tape
);
1155 static int idetape_copy_stage_from_user(idetape_tape_t
*tape
,
1156 const char __user
*buf
, int n
)
1158 struct idetape_bh
*bh
= tape
->bh
;
1164 printk(KERN_ERR
"ide-tape: bh == NULL in %s\n",
1168 count
= min((unsigned int)
1169 (bh
->b_size
- atomic_read(&bh
->b_count
)),
1171 if (copy_from_user(bh
->b_data
+ atomic_read(&bh
->b_count
), buf
,
1175 atomic_add(count
, &bh
->b_count
);
1177 if (atomic_read(&bh
->b_count
) == bh
->b_size
) {
1180 atomic_set(&bh
->b_count
, 0);
1187 static int idetape_copy_stage_to_user(idetape_tape_t
*tape
, char __user
*buf
,
1190 struct idetape_bh
*bh
= tape
->bh
;
1196 printk(KERN_ERR
"ide-tape: bh == NULL in %s\n",
1200 count
= min(tape
->b_count
, n
);
1201 if (copy_to_user(buf
, tape
->b_data
, count
))
1204 tape
->b_data
+= count
;
1205 tape
->b_count
-= count
;
1207 if (!tape
->b_count
) {
1211 tape
->b_data
= bh
->b_data
;
1212 tape
->b_count
= atomic_read(&bh
->b_count
);
1219 static void idetape_init_merge_buffer(idetape_tape_t
*tape
)
1221 struct idetape_bh
*bh
= tape
->merge_bh
;
1222 tape
->bh
= tape
->merge_bh
;
1224 if (tape
->chrdev_dir
== IDETAPE_DIR_WRITE
)
1225 atomic_set(&bh
->b_count
, 0);
1227 tape
->b_data
= bh
->b_data
;
1228 tape
->b_count
= atomic_read(&bh
->b_count
);
1233 * Write a filemark if write_filemark=1. Flush the device buffers without
1234 * writing a filemark otherwise.
1236 static void idetape_create_write_filemark_cmd(ide_drive_t
*drive
,
1237 struct ide_atapi_pc
*pc
, int write_filemark
)
1239 idetape_init_pc(pc
);
1240 pc
->c
[0] = WRITE_FILEMARKS
;
1241 pc
->c
[4] = write_filemark
;
1242 pc
->flags
|= PC_FLAG_WAIT_FOR_DSC
;
1245 static void idetape_create_test_unit_ready_cmd(struct ide_atapi_pc
*pc
)
1247 idetape_init_pc(pc
);
1248 pc
->c
[0] = TEST_UNIT_READY
;
1252 * We add a special packet command request to the tail of the request queue, and
1253 * wait for it to be serviced. This is not to be called from within the request
1254 * handling part of the driver! We allocate here data on the stack and it is
1255 * valid until the request is finished. This is not the case for the bottom part
1256 * of the driver, where we are always leaving the functions to wait for an
1257 * interrupt or a timer event.
1259 * From the bottom part of the driver, we should allocate safe memory using
1260 * idetape_next_pc_storage() and ide_tape_next_rq_storage(), and add the request
1261 * to the request list without waiting for it to be serviced! In that case, we
1262 * usually use idetape_queue_pc_head().
1264 static int idetape_queue_pc_tail(ide_drive_t
*drive
, struct ide_atapi_pc
*pc
)
1266 struct ide_tape_obj
*tape
= drive
->driver_data
;
1270 rq
= blk_get_request(drive
->queue
, READ
, __GFP_WAIT
);
1271 rq
->cmd_type
= REQ_TYPE_SPECIAL
;
1272 rq
->cmd
[13] = REQ_IDETAPE_PC1
;
1273 rq
->buffer
= (char *)pc
;
1274 memcpy(rq
->cmd
, pc
->c
, 12);
1275 error
= blk_execute_rq(drive
->queue
, tape
->disk
, rq
, 0);
1276 blk_put_request(rq
);
1280 static void idetape_create_load_unload_cmd(ide_drive_t
*drive
,
1281 struct ide_atapi_pc
*pc
, int cmd
)
1283 idetape_init_pc(pc
);
1284 pc
->c
[0] = START_STOP
;
1286 pc
->flags
|= PC_FLAG_WAIT_FOR_DSC
;
1289 static int idetape_wait_ready(ide_drive_t
*drive
, unsigned long timeout
)
1291 idetape_tape_t
*tape
= drive
->driver_data
;
1292 struct ide_atapi_pc pc
;
1293 int load_attempted
= 0;
1295 /* Wait for the tape to become ready */
1296 set_bit(IDE_AFLAG_MEDIUM_PRESENT
, &drive
->atapi_flags
);
1298 while (time_before(jiffies
, timeout
)) {
1299 idetape_create_test_unit_ready_cmd(&pc
);
1300 if (!idetape_queue_pc_tail(drive
, &pc
))
1302 if ((tape
->sense_key
== 2 && tape
->asc
== 4 && tape
->ascq
== 2)
1303 || (tape
->asc
== 0x3A)) {
1307 idetape_create_load_unload_cmd(drive
, &pc
,
1308 IDETAPE_LU_LOAD_MASK
);
1309 idetape_queue_pc_tail(drive
, &pc
);
1311 /* not about to be ready */
1312 } else if (!(tape
->sense_key
== 2 && tape
->asc
== 4 &&
1313 (tape
->ascq
== 1 || tape
->ascq
== 8)))
1320 static int idetape_flush_tape_buffers(ide_drive_t
*drive
)
1322 struct ide_atapi_pc pc
;
1325 idetape_create_write_filemark_cmd(drive
, &pc
, 0);
1326 rc
= idetape_queue_pc_tail(drive
, &pc
);
1329 idetape_wait_ready(drive
, 60 * 5 * HZ
);
1333 static void idetape_create_read_position_cmd(struct ide_atapi_pc
*pc
)
1335 idetape_init_pc(pc
);
1336 pc
->c
[0] = READ_POSITION
;
1340 static int idetape_read_position(ide_drive_t
*drive
)
1342 idetape_tape_t
*tape
= drive
->driver_data
;
1343 struct ide_atapi_pc pc
;
1346 debug_log(DBG_PROCS
, "Enter %s\n", __func__
);
1348 idetape_create_read_position_cmd(&pc
);
1349 if (idetape_queue_pc_tail(drive
, &pc
))
1351 position
= tape
->first_frame
;
1355 static void idetape_create_locate_cmd(ide_drive_t
*drive
,
1356 struct ide_atapi_pc
*pc
,
1357 unsigned int block
, u8 partition
, int skip
)
1359 idetape_init_pc(pc
);
1360 pc
->c
[0] = POSITION_TO_ELEMENT
;
1362 put_unaligned(cpu_to_be32(block
), (unsigned int *) &pc
->c
[3]);
1363 pc
->c
[8] = partition
;
1364 pc
->flags
|= PC_FLAG_WAIT_FOR_DSC
;
1367 static int idetape_create_prevent_cmd(ide_drive_t
*drive
,
1368 struct ide_atapi_pc
*pc
, int prevent
)
1370 idetape_tape_t
*tape
= drive
->driver_data
;
1372 /* device supports locking according to capabilities page */
1373 if (!(tape
->caps
[6] & 0x01))
1376 idetape_init_pc(pc
);
1377 pc
->c
[0] = ALLOW_MEDIUM_REMOVAL
;
1382 static void __ide_tape_discard_merge_buffer(ide_drive_t
*drive
)
1384 idetape_tape_t
*tape
= drive
->driver_data
;
1386 if (tape
->chrdev_dir
!= IDETAPE_DIR_READ
)
1389 clear_bit(IDE_AFLAG_FILEMARK
, &drive
->atapi_flags
);
1390 tape
->merge_bh_size
= 0;
1391 if (tape
->merge_bh
!= NULL
) {
1392 ide_tape_kfree_buffer(tape
);
1393 tape
->merge_bh
= NULL
;
1396 tape
->chrdev_dir
= IDETAPE_DIR_NONE
;
1400 * Position the tape to the requested block using the LOCATE packet command.
1401 * A READ POSITION command is then issued to check where we are positioned. Like
1402 * all higher level operations, we queue the commands at the tail of the request
1403 * queue and wait for their completion.
1405 static int idetape_position_tape(ide_drive_t
*drive
, unsigned int block
,
1406 u8 partition
, int skip
)
1408 idetape_tape_t
*tape
= drive
->driver_data
;
1410 struct ide_atapi_pc pc
;
1412 if (tape
->chrdev_dir
== IDETAPE_DIR_READ
)
1413 __ide_tape_discard_merge_buffer(drive
);
1414 idetape_wait_ready(drive
, 60 * 5 * HZ
);
1415 idetape_create_locate_cmd(drive
, &pc
, block
, partition
, skip
);
1416 retval
= idetape_queue_pc_tail(drive
, &pc
);
1420 idetape_create_read_position_cmd(&pc
);
1421 return (idetape_queue_pc_tail(drive
, &pc
));
1424 static void ide_tape_discard_merge_buffer(ide_drive_t
*drive
,
1425 int restore_position
)
1427 idetape_tape_t
*tape
= drive
->driver_data
;
1430 __ide_tape_discard_merge_buffer(drive
);
1431 if (restore_position
) {
1432 position
= idetape_read_position(drive
);
1433 seek
= position
> 0 ? position
: 0;
1434 if (idetape_position_tape(drive
, seek
, 0, 0)) {
1435 printk(KERN_INFO
"ide-tape: %s: position_tape failed in"
1436 " %s\n", tape
->name
, __func__
);
1443 * Generate a read/write request for the block device interface and wait for it
1446 static int idetape_queue_rw_tail(ide_drive_t
*drive
, int cmd
, int blocks
,
1447 struct idetape_bh
*bh
)
1449 idetape_tape_t
*tape
= drive
->driver_data
;
1453 debug_log(DBG_SENSE
, "%s: cmd=%d\n", __func__
, cmd
);
1455 rq
= blk_get_request(drive
->queue
, READ
, __GFP_WAIT
);
1456 rq
->cmd_type
= REQ_TYPE_SPECIAL
;
1458 rq
->rq_disk
= tape
->disk
;
1459 rq
->special
= (void *)bh
;
1460 rq
->sector
= tape
->first_frame
;
1461 rq
->nr_sectors
= blocks
;
1462 rq
->current_nr_sectors
= blocks
;
1463 blk_execute_rq(drive
->queue
, tape
->disk
, rq
, 0);
1465 errors
= rq
->errors
;
1466 ret
= tape
->blk_size
* (blocks
- rq
->current_nr_sectors
);
1467 blk_put_request(rq
);
1469 if ((cmd
& (REQ_IDETAPE_READ
| REQ_IDETAPE_WRITE
)) == 0)
1473 idetape_init_merge_buffer(tape
);
1474 if (errors
== IDETAPE_ERROR_GENERAL
)
1479 static void idetape_create_inquiry_cmd(struct ide_atapi_pc
*pc
)
1481 idetape_init_pc(pc
);
1487 static void idetape_create_rewind_cmd(ide_drive_t
*drive
,
1488 struct ide_atapi_pc
*pc
)
1490 idetape_init_pc(pc
);
1491 pc
->c
[0] = REZERO_UNIT
;
1492 pc
->flags
|= PC_FLAG_WAIT_FOR_DSC
;
1495 static void idetape_create_erase_cmd(struct ide_atapi_pc
*pc
)
1497 idetape_init_pc(pc
);
1500 pc
->flags
|= PC_FLAG_WAIT_FOR_DSC
;
1503 static void idetape_create_space_cmd(struct ide_atapi_pc
*pc
, int count
, u8 cmd
)
1505 idetape_init_pc(pc
);
1507 put_unaligned(cpu_to_be32(count
), (unsigned int *) &pc
->c
[1]);
1509 pc
->flags
|= PC_FLAG_WAIT_FOR_DSC
;
1512 /* Queue up a character device originated write request. */
1513 static int idetape_add_chrdev_write_request(ide_drive_t
*drive
, int blocks
)
1515 idetape_tape_t
*tape
= drive
->driver_data
;
1517 debug_log(DBG_CHRDEV
, "Enter %s\n", __func__
);
1519 return idetape_queue_rw_tail(drive
, REQ_IDETAPE_WRITE
,
1520 blocks
, tape
->merge_bh
);
1523 static void ide_tape_flush_merge_buffer(ide_drive_t
*drive
)
1525 idetape_tape_t
*tape
= drive
->driver_data
;
1527 struct idetape_bh
*bh
;
1529 if (tape
->chrdev_dir
!= IDETAPE_DIR_WRITE
) {
1530 printk(KERN_ERR
"ide-tape: bug: Trying to empty merge buffer"
1531 " but we are not writing.\n");
1534 if (tape
->merge_bh_size
> tape
->buffer_size
) {
1535 printk(KERN_ERR
"ide-tape: bug: merge_buffer too big\n");
1536 tape
->merge_bh_size
= tape
->buffer_size
;
1538 if (tape
->merge_bh_size
) {
1539 blocks
= tape
->merge_bh_size
/ tape
->blk_size
;
1540 if (tape
->merge_bh_size
% tape
->blk_size
) {
1544 i
= tape
->blk_size
- tape
->merge_bh_size
%
1546 bh
= tape
->bh
->b_reqnext
;
1548 atomic_set(&bh
->b_count
, 0);
1554 printk(KERN_INFO
"ide-tape: bug,"
1558 min
= min(i
, (unsigned int)(bh
->b_size
-
1559 atomic_read(&bh
->b_count
)));
1560 memset(bh
->b_data
+ atomic_read(&bh
->b_count
),
1562 atomic_add(min
, &bh
->b_count
);
1567 (void) idetape_add_chrdev_write_request(drive
, blocks
);
1568 tape
->merge_bh_size
= 0;
1570 if (tape
->merge_bh
!= NULL
) {
1571 ide_tape_kfree_buffer(tape
);
1572 tape
->merge_bh
= NULL
;
1574 tape
->chrdev_dir
= IDETAPE_DIR_NONE
;
1577 static int idetape_init_read(ide_drive_t
*drive
)
1579 idetape_tape_t
*tape
= drive
->driver_data
;
1582 /* Initialize read operation */
1583 if (tape
->chrdev_dir
!= IDETAPE_DIR_READ
) {
1584 if (tape
->chrdev_dir
== IDETAPE_DIR_WRITE
) {
1585 ide_tape_flush_merge_buffer(drive
);
1586 idetape_flush_tape_buffers(drive
);
1588 if (tape
->merge_bh
|| tape
->merge_bh_size
) {
1589 printk(KERN_ERR
"ide-tape: merge_bh_size should be"
1591 tape
->merge_bh_size
= 0;
1593 tape
->merge_bh
= ide_tape_kmalloc_buffer(tape
, 0, 0);
1594 if (!tape
->merge_bh
)
1596 tape
->chrdev_dir
= IDETAPE_DIR_READ
;
1599 * Issue a read 0 command to ensure that DSC handshake is
1600 * switched from completion mode to buffer available mode.
1601 * No point in issuing this if DSC overlap isn't supported, some
1602 * drives (Seagate STT3401A) will return an error.
1604 if (drive
->dsc_overlap
) {
1605 bytes_read
= idetape_queue_rw_tail(drive
,
1606 REQ_IDETAPE_READ
, 0,
1608 if (bytes_read
< 0) {
1609 ide_tape_kfree_buffer(tape
);
1610 tape
->merge_bh
= NULL
;
1611 tape
->chrdev_dir
= IDETAPE_DIR_NONE
;
1620 /* called from idetape_chrdev_read() to service a chrdev read request. */
1621 static int idetape_add_chrdev_read_request(ide_drive_t
*drive
, int blocks
)
1623 idetape_tape_t
*tape
= drive
->driver_data
;
1625 debug_log(DBG_PROCS
, "Enter %s, %d blocks\n", __func__
, blocks
);
1627 /* If we are at a filemark, return a read length of 0 */
1628 if (test_bit(IDE_AFLAG_FILEMARK
, &drive
->atapi_flags
))
1631 idetape_init_read(drive
);
1633 return idetape_queue_rw_tail(drive
, REQ_IDETAPE_READ
, blocks
,
1637 static void idetape_pad_zeros(ide_drive_t
*drive
, int bcount
)
1639 idetape_tape_t
*tape
= drive
->driver_data
;
1640 struct idetape_bh
*bh
;
1646 bh
= tape
->merge_bh
;
1647 count
= min(tape
->buffer_size
, bcount
);
1649 blocks
= count
/ tape
->blk_size
;
1651 atomic_set(&bh
->b_count
,
1652 min(count
, (unsigned int)bh
->b_size
));
1653 memset(bh
->b_data
, 0, atomic_read(&bh
->b_count
));
1654 count
-= atomic_read(&bh
->b_count
);
1657 idetape_queue_rw_tail(drive
, REQ_IDETAPE_WRITE
, blocks
,
1663 * Rewinds the tape to the Beginning Of the current Partition (BOP). We
1664 * currently support only one partition.
1666 static int idetape_rewind_tape(ide_drive_t
*drive
)
1669 struct ide_atapi_pc pc
;
1670 idetape_tape_t
*tape
;
1671 tape
= drive
->driver_data
;
1673 debug_log(DBG_SENSE
, "Enter %s\n", __func__
);
1675 idetape_create_rewind_cmd(drive
, &pc
);
1676 retval
= idetape_queue_pc_tail(drive
, &pc
);
1680 idetape_create_read_position_cmd(&pc
);
1681 retval
= idetape_queue_pc_tail(drive
, &pc
);
1687 /* mtio.h compatible commands should be issued to the chrdev interface. */
1688 static int idetape_blkdev_ioctl(ide_drive_t
*drive
, unsigned int cmd
,
1691 idetape_tape_t
*tape
= drive
->driver_data
;
1692 void __user
*argp
= (void __user
*)arg
;
1694 struct idetape_config
{
1695 int dsc_rw_frequency
;
1696 int dsc_media_access_frequency
;
1700 debug_log(DBG_PROCS
, "Enter %s\n", __func__
);
1704 if (copy_from_user(&config
, argp
, sizeof(config
)))
1706 tape
->best_dsc_rw_freq
= config
.dsc_rw_frequency
;
1709 config
.dsc_rw_frequency
= (int) tape
->best_dsc_rw_freq
;
1710 config
.nr_stages
= 1;
1711 if (copy_to_user(argp
, &config
, sizeof(config
)))
1720 static int idetape_space_over_filemarks(ide_drive_t
*drive
, short mt_op
,
1723 idetape_tape_t
*tape
= drive
->driver_data
;
1724 struct ide_atapi_pc pc
;
1725 int retval
, count
= 0;
1726 int sprev
= !!(tape
->caps
[4] & 0x20);
1730 if (MTBSF
== mt_op
|| MTBSFM
== mt_op
) {
1733 mt_count
= -mt_count
;
1736 if (tape
->chrdev_dir
== IDETAPE_DIR_READ
) {
1737 tape
->merge_bh_size
= 0;
1738 if (test_and_clear_bit(IDE_AFLAG_FILEMARK
, &drive
->atapi_flags
))
1740 ide_tape_discard_merge_buffer(drive
, 0);
1746 idetape_create_space_cmd(&pc
, mt_count
- count
,
1747 IDETAPE_SPACE_OVER_FILEMARK
);
1748 return idetape_queue_pc_tail(drive
, &pc
);
1753 retval
= idetape_space_over_filemarks(drive
, MTFSF
,
1757 count
= (MTBSFM
== mt_op
? 1 : -1);
1758 return idetape_space_over_filemarks(drive
, MTFSF
, count
);
1760 printk(KERN_ERR
"ide-tape: MTIO operation %d not supported\n",
1767 * Our character device read / write functions.
1769 * The tape is optimized to maximize throughput when it is transferring an
1770 * integral number of the "continuous transfer limit", which is a parameter of
1771 * the specific tape (26kB on my particular tape, 32kB for Onstream).
1773 * As of version 1.3 of the driver, the character device provides an abstract
1774 * continuous view of the media - any mix of block sizes (even 1 byte) on the
1775 * same backup/restore procedure is supported. The driver will internally
1776 * convert the requests to the recommended transfer unit, so that an unmatch
1777 * between the user's block size to the recommended size will only result in a
1778 * (slightly) increased driver overhead, but will no longer hit performance.
1779 * This is not applicable to Onstream.
1781 static ssize_t
idetape_chrdev_read(struct file
*file
, char __user
*buf
,
1782 size_t count
, loff_t
*ppos
)
1784 struct ide_tape_obj
*tape
= ide_tape_f(file
);
1785 ide_drive_t
*drive
= tape
->drive
;
1786 ssize_t bytes_read
, temp
, actually_read
= 0, rc
;
1788 u16 ctl
= *(u16
*)&tape
->caps
[12];
1790 debug_log(DBG_CHRDEV
, "Enter %s, count %Zd\n", __func__
, count
);
1792 if (tape
->chrdev_dir
!= IDETAPE_DIR_READ
) {
1793 if (test_bit(IDE_AFLAG_DETECT_BS
, &drive
->atapi_flags
))
1794 if (count
> tape
->blk_size
&&
1795 (count
% tape
->blk_size
) == 0)
1796 tape
->user_bs_factor
= count
/ tape
->blk_size
;
1798 rc
= idetape_init_read(drive
);
1803 if (tape
->merge_bh_size
) {
1804 actually_read
= min((unsigned int)(tape
->merge_bh_size
),
1805 (unsigned int)count
);
1806 if (idetape_copy_stage_to_user(tape
, buf
, actually_read
))
1808 buf
+= actually_read
;
1809 tape
->merge_bh_size
-= actually_read
;
1810 count
-= actually_read
;
1812 while (count
>= tape
->buffer_size
) {
1813 bytes_read
= idetape_add_chrdev_read_request(drive
, ctl
);
1814 if (bytes_read
<= 0)
1816 if (idetape_copy_stage_to_user(tape
, buf
, bytes_read
))
1819 count
-= bytes_read
;
1820 actually_read
+= bytes_read
;
1823 bytes_read
= idetape_add_chrdev_read_request(drive
, ctl
);
1824 if (bytes_read
<= 0)
1826 temp
= min((unsigned long)count
, (unsigned long)bytes_read
);
1827 if (idetape_copy_stage_to_user(tape
, buf
, temp
))
1829 actually_read
+= temp
;
1830 tape
->merge_bh_size
= bytes_read
-temp
;
1833 if (!actually_read
&& test_bit(IDE_AFLAG_FILEMARK
, &drive
->atapi_flags
)) {
1834 debug_log(DBG_SENSE
, "%s: spacing over filemark\n", tape
->name
);
1836 idetape_space_over_filemarks(drive
, MTFSF
, 1);
1840 return ret
? ret
: actually_read
;
1843 static ssize_t
idetape_chrdev_write(struct file
*file
, const char __user
*buf
,
1844 size_t count
, loff_t
*ppos
)
1846 struct ide_tape_obj
*tape
= ide_tape_f(file
);
1847 ide_drive_t
*drive
= tape
->drive
;
1848 ssize_t actually_written
= 0;
1850 u16 ctl
= *(u16
*)&tape
->caps
[12];
1852 /* The drive is write protected. */
1853 if (tape
->write_prot
)
1856 debug_log(DBG_CHRDEV
, "Enter %s, count %Zd\n", __func__
, count
);
1858 /* Initialize write operation */
1859 if (tape
->chrdev_dir
!= IDETAPE_DIR_WRITE
) {
1860 if (tape
->chrdev_dir
== IDETAPE_DIR_READ
)
1861 ide_tape_discard_merge_buffer(drive
, 1);
1862 if (tape
->merge_bh
|| tape
->merge_bh_size
) {
1863 printk(KERN_ERR
"ide-tape: merge_bh_size "
1864 "should be 0 now\n");
1865 tape
->merge_bh_size
= 0;
1867 tape
->merge_bh
= ide_tape_kmalloc_buffer(tape
, 0, 0);
1868 if (!tape
->merge_bh
)
1870 tape
->chrdev_dir
= IDETAPE_DIR_WRITE
;
1871 idetape_init_merge_buffer(tape
);
1874 * Issue a write 0 command to ensure that DSC handshake is
1875 * switched from completion mode to buffer available mode. No
1876 * point in issuing this if DSC overlap isn't supported, some
1877 * drives (Seagate STT3401A) will return an error.
1879 if (drive
->dsc_overlap
) {
1880 ssize_t retval
= idetape_queue_rw_tail(drive
,
1881 REQ_IDETAPE_WRITE
, 0,
1884 ide_tape_kfree_buffer(tape
);
1885 tape
->merge_bh
= NULL
;
1886 tape
->chrdev_dir
= IDETAPE_DIR_NONE
;
1893 if (tape
->merge_bh_size
) {
1894 if (tape
->merge_bh_size
>= tape
->buffer_size
) {
1895 printk(KERN_ERR
"ide-tape: bug: merge buf too big\n");
1896 tape
->merge_bh_size
= 0;
1898 actually_written
= min((unsigned int)
1899 (tape
->buffer_size
- tape
->merge_bh_size
),
1900 (unsigned int)count
);
1901 if (idetape_copy_stage_from_user(tape
, buf
, actually_written
))
1903 buf
+= actually_written
;
1904 tape
->merge_bh_size
+= actually_written
;
1905 count
-= actually_written
;
1907 if (tape
->merge_bh_size
== tape
->buffer_size
) {
1909 tape
->merge_bh_size
= 0;
1910 retval
= idetape_add_chrdev_write_request(drive
, ctl
);
1915 while (count
>= tape
->buffer_size
) {
1917 if (idetape_copy_stage_from_user(tape
, buf
, tape
->buffer_size
))
1919 buf
+= tape
->buffer_size
;
1920 count
-= tape
->buffer_size
;
1921 retval
= idetape_add_chrdev_write_request(drive
, ctl
);
1922 actually_written
+= tape
->buffer_size
;
1927 actually_written
+= count
;
1928 if (idetape_copy_stage_from_user(tape
, buf
, count
))
1930 tape
->merge_bh_size
+= count
;
1932 return ret
? ret
: actually_written
;
1935 static int idetape_write_filemark(ide_drive_t
*drive
)
1937 struct ide_atapi_pc pc
;
1939 /* Write a filemark */
1940 idetape_create_write_filemark_cmd(drive
, &pc
, 1);
1941 if (idetape_queue_pc_tail(drive
, &pc
)) {
1942 printk(KERN_ERR
"ide-tape: Couldn't write a filemark\n");
1949 * Called from idetape_chrdev_ioctl when the general mtio MTIOCTOP ioctl is
1952 * Note: MTBSF and MTBSFM are not supported when the tape doesn't support
1953 * spacing over filemarks in the reverse direction. In this case, MTFSFM is also
1954 * usually not supported.
1956 * The following commands are currently not supported:
1958 * MTFSS, MTBSS, MTWSM, MTSETDENSITY, MTSETDRVBUFFER, MT_ST_BOOLEANS,
1959 * MT_ST_WRITE_THRESHOLD.
1961 static int idetape_mtioctop(ide_drive_t
*drive
, short mt_op
, int mt_count
)
1963 idetape_tape_t
*tape
= drive
->driver_data
;
1964 struct ide_atapi_pc pc
;
1967 debug_log(DBG_ERR
, "Handling MTIOCTOP ioctl: mt_op=%d, mt_count=%d\n",
1977 return idetape_space_over_filemarks(drive
, mt_op
, mt_count
);
1984 if (tape
->write_prot
)
1986 ide_tape_discard_merge_buffer(drive
, 1);
1987 for (i
= 0; i
< mt_count
; i
++) {
1988 retval
= idetape_write_filemark(drive
);
1994 ide_tape_discard_merge_buffer(drive
, 0);
1995 if (idetape_rewind_tape(drive
))
1999 ide_tape_discard_merge_buffer(drive
, 0);
2000 idetape_create_load_unload_cmd(drive
, &pc
,
2001 IDETAPE_LU_LOAD_MASK
);
2002 return idetape_queue_pc_tail(drive
, &pc
);
2006 * If door is locked, attempt to unlock before
2007 * attempting to eject.
2009 if (tape
->door_locked
) {
2010 if (idetape_create_prevent_cmd(drive
, &pc
, 0))
2011 if (!idetape_queue_pc_tail(drive
, &pc
))
2012 tape
->door_locked
= DOOR_UNLOCKED
;
2014 ide_tape_discard_merge_buffer(drive
, 0);
2015 idetape_create_load_unload_cmd(drive
, &pc
,
2016 !IDETAPE_LU_LOAD_MASK
);
2017 retval
= idetape_queue_pc_tail(drive
, &pc
);
2019 clear_bit(IDE_AFLAG_MEDIUM_PRESENT
, &drive
->atapi_flags
);
2022 ide_tape_discard_merge_buffer(drive
, 0);
2023 return idetape_flush_tape_buffers(drive
);
2025 ide_tape_discard_merge_buffer(drive
, 0);
2026 idetape_create_load_unload_cmd(drive
, &pc
,
2027 IDETAPE_LU_RETENSION_MASK
| IDETAPE_LU_LOAD_MASK
);
2028 return idetape_queue_pc_tail(drive
, &pc
);
2030 idetape_create_space_cmd(&pc
, 0, IDETAPE_SPACE_TO_EOD
);
2031 return idetape_queue_pc_tail(drive
, &pc
);
2033 (void)idetape_rewind_tape(drive
);
2034 idetape_create_erase_cmd(&pc
);
2035 return idetape_queue_pc_tail(drive
, &pc
);
2038 if (mt_count
< tape
->blk_size
||
2039 mt_count
% tape
->blk_size
)
2041 tape
->user_bs_factor
= mt_count
/ tape
->blk_size
;
2042 clear_bit(IDE_AFLAG_DETECT_BS
, &drive
->atapi_flags
);
2044 set_bit(IDE_AFLAG_DETECT_BS
, &drive
->atapi_flags
);
2047 ide_tape_discard_merge_buffer(drive
, 0);
2048 return idetape_position_tape(drive
,
2049 mt_count
* tape
->user_bs_factor
, tape
->partition
, 0);
2051 ide_tape_discard_merge_buffer(drive
, 0);
2052 return idetape_position_tape(drive
, 0, mt_count
, 0);
2056 if (!idetape_create_prevent_cmd(drive
, &pc
, 1))
2058 retval
= idetape_queue_pc_tail(drive
, &pc
);
2061 tape
->door_locked
= DOOR_EXPLICITLY_LOCKED
;
2064 if (!idetape_create_prevent_cmd(drive
, &pc
, 0))
2066 retval
= idetape_queue_pc_tail(drive
, &pc
);
2069 tape
->door_locked
= DOOR_UNLOCKED
;
2072 printk(KERN_ERR
"ide-tape: MTIO operation %d not supported\n",
2079 * Our character device ioctls. General mtio.h magnetic io commands are
2080 * supported here, and not in the corresponding block interface. Our own
2081 * ide-tape ioctls are supported on both interfaces.
2083 static int idetape_chrdev_ioctl(struct inode
*inode
, struct file
*file
,
2084 unsigned int cmd
, unsigned long arg
)
2086 struct ide_tape_obj
*tape
= ide_tape_f(file
);
2087 ide_drive_t
*drive
= tape
->drive
;
2091 int block_offset
= 0, position
= tape
->first_frame
;
2092 void __user
*argp
= (void __user
*)arg
;
2094 debug_log(DBG_CHRDEV
, "Enter %s, cmd=%u\n", __func__
, cmd
);
2096 if (tape
->chrdev_dir
== IDETAPE_DIR_WRITE
) {
2097 ide_tape_flush_merge_buffer(drive
);
2098 idetape_flush_tape_buffers(drive
);
2100 if (cmd
== MTIOCGET
|| cmd
== MTIOCPOS
) {
2101 block_offset
= tape
->merge_bh_size
/
2102 (tape
->blk_size
* tape
->user_bs_factor
);
2103 position
= idetape_read_position(drive
);
2109 if (copy_from_user(&mtop
, argp
, sizeof(struct mtop
)))
2111 return idetape_mtioctop(drive
, mtop
.mt_op
, mtop
.mt_count
);
2113 memset(&mtget
, 0, sizeof(struct mtget
));
2114 mtget
.mt_type
= MT_ISSCSI2
;
2115 mtget
.mt_blkno
= position
/ tape
->user_bs_factor
- block_offset
;
2117 ((tape
->blk_size
* tape
->user_bs_factor
)
2118 << MT_ST_BLKSIZE_SHIFT
) & MT_ST_BLKSIZE_MASK
;
2120 if (tape
->drv_write_prot
)
2121 mtget
.mt_gstat
|= GMT_WR_PROT(0xffffffff);
2123 if (copy_to_user(argp
, &mtget
, sizeof(struct mtget
)))
2127 mtpos
.mt_blkno
= position
/ tape
->user_bs_factor
- block_offset
;
2128 if (copy_to_user(argp
, &mtpos
, sizeof(struct mtpos
)))
2132 if (tape
->chrdev_dir
== IDETAPE_DIR_READ
)
2133 ide_tape_discard_merge_buffer(drive
, 1);
2134 return idetape_blkdev_ioctl(drive
, cmd
, arg
);
2139 * Do a mode sense page 0 with block descriptor and if it succeeds set the tape
2140 * block size with the reported value.
2142 static void ide_tape_get_bsize_from_bdesc(ide_drive_t
*drive
)
2144 idetape_tape_t
*tape
= drive
->driver_data
;
2145 struct ide_atapi_pc pc
;
2147 idetape_create_mode_sense_cmd(&pc
, IDETAPE_BLOCK_DESCRIPTOR
);
2148 if (idetape_queue_pc_tail(drive
, &pc
)) {
2149 printk(KERN_ERR
"ide-tape: Can't get block descriptor\n");
2150 if (tape
->blk_size
== 0) {
2151 printk(KERN_WARNING
"ide-tape: Cannot deal with zero "
2152 "block size, assuming 32k\n");
2153 tape
->blk_size
= 32768;
2157 tape
->blk_size
= (pc
.buf
[4 + 5] << 16) +
2158 (pc
.buf
[4 + 6] << 8) +
2160 tape
->drv_write_prot
= (pc
.buf
[2] & 0x80) >> 7;
2163 static int idetape_chrdev_open(struct inode
*inode
, struct file
*filp
)
2165 unsigned int minor
= iminor(inode
), i
= minor
& ~0xc0;
2167 idetape_tape_t
*tape
;
2168 struct ide_atapi_pc pc
;
2171 if (i
>= MAX_HWIFS
* MAX_DRIVES
)
2175 tape
= ide_tape_chrdev_get(i
);
2181 debug_log(DBG_CHRDEV
, "Enter %s\n", __func__
);
2184 * We really want to do nonseekable_open(inode, filp); here, but some
2185 * versions of tar incorrectly call lseek on tapes and bail out if that
2186 * fails. So we disallow pread() and pwrite(), but permit lseeks.
2188 filp
->f_mode
&= ~(FMODE_PREAD
| FMODE_PWRITE
);
2190 drive
= tape
->drive
;
2192 filp
->private_data
= tape
;
2194 if (test_and_set_bit(IDE_AFLAG_BUSY
, &drive
->atapi_flags
)) {
2199 retval
= idetape_wait_ready(drive
, 60 * HZ
);
2201 clear_bit(IDE_AFLAG_BUSY
, &drive
->atapi_flags
);
2202 printk(KERN_ERR
"ide-tape: %s: drive not ready\n", tape
->name
);
2206 idetape_read_position(drive
);
2207 if (!test_bit(IDE_AFLAG_ADDRESS_VALID
, &drive
->atapi_flags
))
2208 (void)idetape_rewind_tape(drive
);
2210 /* Read block size and write protect status from drive. */
2211 ide_tape_get_bsize_from_bdesc(drive
);
2213 /* Set write protect flag if device is opened as read-only. */
2214 if ((filp
->f_flags
& O_ACCMODE
) == O_RDONLY
)
2215 tape
->write_prot
= 1;
2217 tape
->write_prot
= tape
->drv_write_prot
;
2219 /* Make sure drive isn't write protected if user wants to write. */
2220 if (tape
->write_prot
) {
2221 if ((filp
->f_flags
& O_ACCMODE
) == O_WRONLY
||
2222 (filp
->f_flags
& O_ACCMODE
) == O_RDWR
) {
2223 clear_bit(IDE_AFLAG_BUSY
, &drive
->atapi_flags
);
2229 /* Lock the tape drive door so user can't eject. */
2230 if (tape
->chrdev_dir
== IDETAPE_DIR_NONE
) {
2231 if (idetape_create_prevent_cmd(drive
, &pc
, 1)) {
2232 if (!idetape_queue_pc_tail(drive
, &pc
)) {
2233 if (tape
->door_locked
!= DOOR_EXPLICITLY_LOCKED
)
2234 tape
->door_locked
= DOOR_LOCKED
;
2247 static void idetape_write_release(ide_drive_t
*drive
, unsigned int minor
)
2249 idetape_tape_t
*tape
= drive
->driver_data
;
2251 ide_tape_flush_merge_buffer(drive
);
2252 tape
->merge_bh
= ide_tape_kmalloc_buffer(tape
, 1, 0);
2253 if (tape
->merge_bh
!= NULL
) {
2254 idetape_pad_zeros(drive
, tape
->blk_size
*
2255 (tape
->user_bs_factor
- 1));
2256 ide_tape_kfree_buffer(tape
);
2257 tape
->merge_bh
= NULL
;
2259 idetape_write_filemark(drive
);
2260 idetape_flush_tape_buffers(drive
);
2261 idetape_flush_tape_buffers(drive
);
2264 static int idetape_chrdev_release(struct inode
*inode
, struct file
*filp
)
2266 struct ide_tape_obj
*tape
= ide_tape_f(filp
);
2267 ide_drive_t
*drive
= tape
->drive
;
2268 struct ide_atapi_pc pc
;
2269 unsigned int minor
= iminor(inode
);
2272 tape
= drive
->driver_data
;
2274 debug_log(DBG_CHRDEV
, "Enter %s\n", __func__
);
2276 if (tape
->chrdev_dir
== IDETAPE_DIR_WRITE
)
2277 idetape_write_release(drive
, minor
);
2278 if (tape
->chrdev_dir
== IDETAPE_DIR_READ
) {
2280 ide_tape_discard_merge_buffer(drive
, 1);
2283 if (minor
< 128 && test_bit(IDE_AFLAG_MEDIUM_PRESENT
, &drive
->atapi_flags
))
2284 (void) idetape_rewind_tape(drive
);
2285 if (tape
->chrdev_dir
== IDETAPE_DIR_NONE
) {
2286 if (tape
->door_locked
== DOOR_LOCKED
) {
2287 if (idetape_create_prevent_cmd(drive
, &pc
, 0)) {
2288 if (!idetape_queue_pc_tail(drive
, &pc
))
2289 tape
->door_locked
= DOOR_UNLOCKED
;
2293 clear_bit(IDE_AFLAG_BUSY
, &drive
->atapi_flags
);
2300 * check the contents of the ATAPI IDENTIFY command results. We return:
2302 * 1 - If the tape can be supported by us, based on the information we have so
2305 * 0 - If this tape driver is not currently supported by us.
2307 static int idetape_identify_device(ide_drive_t
*drive
)
2309 u8 gcw
[2], protocol
, device_type
, removable
, packet_size
;
2311 if (drive
->id_read
== 0)
2314 *((u16
*)&gcw
) = drive
->id
[ATA_ID_CONFIG
];
2316 protocol
= (gcw
[1] & 0xC0) >> 6;
2317 device_type
= gcw
[1] & 0x1F;
2318 removable
= !!(gcw
[0] & 0x80);
2319 packet_size
= gcw
[0] & 0x3;
2321 /* Check that we can support this device */
2323 printk(KERN_ERR
"ide-tape: Protocol (0x%02x) is not ATAPI\n",
2325 else if (device_type
!= 1)
2326 printk(KERN_ERR
"ide-tape: Device type (0x%02x) is not set "
2327 "to tape\n", device_type
);
2328 else if (!removable
)
2329 printk(KERN_ERR
"ide-tape: The removable flag is not set\n");
2330 else if (packet_size
!= 0) {
2331 printk(KERN_ERR
"ide-tape: Packet size (0x%02x) is not 12"
2332 " bytes\n", packet_size
);
2338 static void idetape_get_inquiry_results(ide_drive_t
*drive
)
2340 idetape_tape_t
*tape
= drive
->driver_data
;
2341 struct ide_atapi_pc pc
;
2342 char fw_rev
[4], vendor_id
[8], product_id
[16];
2344 idetape_create_inquiry_cmd(&pc
);
2345 if (idetape_queue_pc_tail(drive
, &pc
)) {
2346 printk(KERN_ERR
"ide-tape: %s: can't get INQUIRY results\n",
2350 memcpy(vendor_id
, &pc
.buf
[8], 8);
2351 memcpy(product_id
, &pc
.buf
[16], 16);
2352 memcpy(fw_rev
, &pc
.buf
[32], 4);
2354 ide_fixstring(vendor_id
, 8, 0);
2355 ide_fixstring(product_id
, 16, 0);
2356 ide_fixstring(fw_rev
, 4, 0);
2358 printk(KERN_INFO
"ide-tape: %s <-> %s: %.8s %.16s rev %.4s\n",
2359 drive
->name
, tape
->name
, vendor_id
, product_id
, fw_rev
);
2363 * Ask the tape about its various parameters. In particular, we will adjust our
2364 * data transfer buffer size to the recommended value as returned by the tape.
2366 static void idetape_get_mode_sense_results(ide_drive_t
*drive
)
2368 idetape_tape_t
*tape
= drive
->driver_data
;
2369 struct ide_atapi_pc pc
;
2371 u8 speed
, max_speed
;
2373 idetape_create_mode_sense_cmd(&pc
, IDETAPE_CAPABILITIES_PAGE
);
2374 if (idetape_queue_pc_tail(drive
, &pc
)) {
2375 printk(KERN_ERR
"ide-tape: Can't get tape parameters - assuming"
2376 " some default values\n");
2377 tape
->blk_size
= 512;
2378 put_unaligned(52, (u16
*)&tape
->caps
[12]);
2379 put_unaligned(540, (u16
*)&tape
->caps
[14]);
2380 put_unaligned(6*52, (u16
*)&tape
->caps
[16]);
2383 caps
= pc
.buf
+ 4 + pc
.buf
[3];
2385 /* convert to host order and save for later use */
2386 speed
= be16_to_cpup((__be16
*)&caps
[14]);
2387 max_speed
= be16_to_cpup((__be16
*)&caps
[8]);
2389 *(u16
*)&caps
[8] = max_speed
;
2390 *(u16
*)&caps
[12] = be16_to_cpup((__be16
*)&caps
[12]);
2391 *(u16
*)&caps
[14] = speed
;
2392 *(u16
*)&caps
[16] = be16_to_cpup((__be16
*)&caps
[16]);
2395 printk(KERN_INFO
"ide-tape: %s: invalid tape speed "
2396 "(assuming 650KB/sec)\n", drive
->name
);
2397 *(u16
*)&caps
[14] = 650;
2400 printk(KERN_INFO
"ide-tape: %s: invalid max_speed "
2401 "(assuming 650KB/sec)\n", drive
->name
);
2402 *(u16
*)&caps
[8] = 650;
2405 memcpy(&tape
->caps
, caps
, 20);
2407 tape
->blk_size
= 512;
2408 else if (caps
[7] & 0x04)
2409 tape
->blk_size
= 1024;
2412 #ifdef CONFIG_IDE_PROC_FS
2413 static void idetape_add_settings(ide_drive_t
*drive
)
2415 idetape_tape_t
*tape
= drive
->driver_data
;
2417 ide_add_setting(drive
, "buffer", SETTING_READ
, TYPE_SHORT
, 0, 0xffff,
2418 1, 2, (u16
*)&tape
->caps
[16], NULL
);
2419 ide_add_setting(drive
, "speed", SETTING_READ
, TYPE_SHORT
, 0, 0xffff,
2420 1, 1, (u16
*)&tape
->caps
[14], NULL
);
2421 ide_add_setting(drive
, "buffer_size", SETTING_READ
, TYPE_INT
, 0, 0xffff,
2422 1, 1024, &tape
->buffer_size
, NULL
);
2423 ide_add_setting(drive
, "tdsc", SETTING_RW
, TYPE_INT
, IDETAPE_DSC_RW_MIN
,
2424 IDETAPE_DSC_RW_MAX
, 1000, HZ
, &tape
->best_dsc_rw_freq
,
2426 ide_add_setting(drive
, "dsc_overlap", SETTING_RW
, TYPE_BYTE
, 0, 1, 1,
2427 1, &drive
->dsc_overlap
, NULL
);
2428 ide_add_setting(drive
, "avg_speed", SETTING_READ
, TYPE_INT
, 0, 0xffff,
2429 1, 1, &tape
->avg_speed
, NULL
);
2430 ide_add_setting(drive
, "debug_mask", SETTING_RW
, TYPE_INT
, 0, 0xffff, 1,
2431 1, &tape
->debug_mask
, NULL
);
2434 static inline void idetape_add_settings(ide_drive_t
*drive
) { ; }
2438 * The function below is called to:
2440 * 1. Initialize our various state variables.
2441 * 2. Ask the tape for its capabilities.
2442 * 3. Allocate a buffer which will be used for data transfer. The buffer size
2443 * is chosen based on the recommendation which we received in step 2.
2445 * Note that at this point ide.c already assigned us an irq, so that we can
2446 * queue requests here and wait for their completion.
2448 static void idetape_setup(ide_drive_t
*drive
, idetape_tape_t
*tape
, int minor
)
2454 u16
*ctl
= (u16
*)&tape
->caps
[12];
2456 drive
->pc_callback
= ide_tape_callback
;
2458 spin_lock_init(&tape
->lock
);
2459 drive
->dsc_overlap
= 1;
2460 if (drive
->hwif
->host_flags
& IDE_HFLAG_NO_DSC
) {
2461 printk(KERN_INFO
"ide-tape: %s: disabling DSC overlap\n",
2463 drive
->dsc_overlap
= 0;
2465 /* Seagate Travan drives do not support DSC overlap. */
2466 if (strstr((char *)&drive
->id
[ATA_ID_PROD
], "Seagate STT3401"))
2467 drive
->dsc_overlap
= 0;
2468 tape
->minor
= minor
;
2469 tape
->name
[0] = 'h';
2470 tape
->name
[1] = 't';
2471 tape
->name
[2] = '0' + minor
;
2472 tape
->chrdev_dir
= IDETAPE_DIR_NONE
;
2473 tape
->pc
= tape
->pc_stack
;
2475 *((u16
*)&gcw
) = drive
->id
[ATA_ID_CONFIG
];
2477 /* Command packet DRQ type */
2478 if (((gcw
[0] & 0x60) >> 5) == 1)
2479 set_bit(IDE_AFLAG_DRQ_INTERRUPT
, &drive
->atapi_flags
);
2481 idetape_get_inquiry_results(drive
);
2482 idetape_get_mode_sense_results(drive
);
2483 ide_tape_get_bsize_from_bdesc(drive
);
2484 tape
->user_bs_factor
= 1;
2485 tape
->buffer_size
= *ctl
* tape
->blk_size
;
2486 while (tape
->buffer_size
> 0xffff) {
2487 printk(KERN_NOTICE
"ide-tape: decreasing stage size\n");
2489 tape
->buffer_size
= *ctl
* tape
->blk_size
;
2491 buffer_size
= tape
->buffer_size
;
2492 tape
->pages_per_buffer
= buffer_size
/ PAGE_SIZE
;
2493 if (buffer_size
% PAGE_SIZE
) {
2494 tape
->pages_per_buffer
++;
2495 tape
->excess_bh_size
= PAGE_SIZE
- buffer_size
% PAGE_SIZE
;
2498 /* select the "best" DSC read/write polling freq */
2499 speed
= max(*(u16
*)&tape
->caps
[14], *(u16
*)&tape
->caps
[8]);
2501 t
= (IDETAPE_FIFO_THRESHOLD
* tape
->buffer_size
* HZ
) / (speed
* 1000);
2504 * Ensure that the number we got makes sense; limit it within
2505 * IDETAPE_DSC_RW_MIN and IDETAPE_DSC_RW_MAX.
2507 tape
->best_dsc_rw_freq
= clamp_t(unsigned long, t
, IDETAPE_DSC_RW_MIN
,
2508 IDETAPE_DSC_RW_MAX
);
2509 printk(KERN_INFO
"ide-tape: %s <-> %s: %dKBps, %d*%dkB buffer, "
2511 drive
->name
, tape
->name
, *(u16
*)&tape
->caps
[14],
2512 (*(u16
*)&tape
->caps
[16] * 512) / tape
->buffer_size
,
2513 tape
->buffer_size
/ 1024,
2514 tape
->best_dsc_rw_freq
* 1000 / HZ
,
2515 drive
->using_dma
? ", DMA":"");
2517 idetape_add_settings(drive
);
2520 static void ide_tape_remove(ide_drive_t
*drive
)
2522 idetape_tape_t
*tape
= drive
->driver_data
;
2524 ide_proc_unregister_driver(drive
, tape
->driver
);
2526 ide_unregister_region(tape
->disk
);
2531 static void ide_tape_release(struct kref
*kref
)
2533 struct ide_tape_obj
*tape
= to_ide_tape(kref
);
2534 ide_drive_t
*drive
= tape
->drive
;
2535 struct gendisk
*g
= tape
->disk
;
2537 BUG_ON(tape
->merge_bh_size
);
2539 drive
->dsc_overlap
= 0;
2540 drive
->driver_data
= NULL
;
2541 device_destroy(idetape_sysfs_class
, MKDEV(IDETAPE_MAJOR
, tape
->minor
));
2542 device_destroy(idetape_sysfs_class
,
2543 MKDEV(IDETAPE_MAJOR
, tape
->minor
+ 128));
2544 idetape_devs
[tape
->minor
] = NULL
;
2545 g
->private_data
= NULL
;
2550 #ifdef CONFIG_IDE_PROC_FS
2551 static int proc_idetape_read_name
2552 (char *page
, char **start
, off_t off
, int count
, int *eof
, void *data
)
2554 ide_drive_t
*drive
= (ide_drive_t
*) data
;
2555 idetape_tape_t
*tape
= drive
->driver_data
;
2559 len
= sprintf(out
, "%s\n", tape
->name
);
2560 PROC_IDE_READ_RETURN(page
, start
, off
, count
, eof
, len
);
2563 static ide_proc_entry_t idetape_proc
[] = {
2564 { "capacity", S_IFREG
|S_IRUGO
, proc_ide_read_capacity
, NULL
},
2565 { "name", S_IFREG
|S_IRUGO
, proc_idetape_read_name
, NULL
},
2566 { NULL
, 0, NULL
, NULL
}
2570 static int ide_tape_probe(ide_drive_t
*);
2572 static ide_driver_t idetape_driver
= {
2574 .owner
= THIS_MODULE
,
2576 .bus
= &ide_bus_type
,
2578 .probe
= ide_tape_probe
,
2579 .remove
= ide_tape_remove
,
2580 .version
= IDETAPE_VERSION
,
2582 .supports_dsc_overlap
= 1,
2583 .do_request
= idetape_do_request
,
2584 .end_request
= idetape_end_request
,
2585 .error
= __ide_error
,
2586 #ifdef CONFIG_IDE_PROC_FS
2587 .proc
= idetape_proc
,
2591 /* Our character device supporting functions, passed to register_chrdev. */
2592 static const struct file_operations idetape_fops
= {
2593 .owner
= THIS_MODULE
,
2594 .read
= idetape_chrdev_read
,
2595 .write
= idetape_chrdev_write
,
2596 .ioctl
= idetape_chrdev_ioctl
,
2597 .open
= idetape_chrdev_open
,
2598 .release
= idetape_chrdev_release
,
2601 static int idetape_open(struct inode
*inode
, struct file
*filp
)
2603 struct gendisk
*disk
= inode
->i_bdev
->bd_disk
;
2604 struct ide_tape_obj
*tape
;
2606 tape
= ide_tape_get(disk
);
2613 static int idetape_release(struct inode
*inode
, struct file
*filp
)
2615 struct gendisk
*disk
= inode
->i_bdev
->bd_disk
;
2616 struct ide_tape_obj
*tape
= ide_tape_g(disk
);
2623 static int idetape_ioctl(struct inode
*inode
, struct file
*file
,
2624 unsigned int cmd
, unsigned long arg
)
2626 struct block_device
*bdev
= inode
->i_bdev
;
2627 struct ide_tape_obj
*tape
= ide_tape_g(bdev
->bd_disk
);
2628 ide_drive_t
*drive
= tape
->drive
;
2629 int err
= generic_ide_ioctl(drive
, file
, bdev
, cmd
, arg
);
2631 err
= idetape_blkdev_ioctl(drive
, cmd
, arg
);
2635 static struct block_device_operations idetape_block_ops
= {
2636 .owner
= THIS_MODULE
,
2637 .open
= idetape_open
,
2638 .release
= idetape_release
,
2639 .ioctl
= idetape_ioctl
,
2642 static int ide_tape_probe(ide_drive_t
*drive
)
2644 idetape_tape_t
*tape
;
2648 if (!strstr("ide-tape", drive
->driver_req
))
2650 if (!drive
->present
)
2652 if (drive
->media
!= ide_tape
)
2654 if (!idetape_identify_device(drive
)) {
2655 printk(KERN_ERR
"ide-tape: %s: not supported by this version of"
2656 " the driver\n", drive
->name
);
2659 tape
= kzalloc(sizeof(idetape_tape_t
), GFP_KERNEL
);
2661 printk(KERN_ERR
"ide-tape: %s: Can't allocate a tape struct\n",
2666 g
= alloc_disk(1 << PARTN_BITS
);
2670 ide_init_disk(g
, drive
);
2672 ide_proc_register_driver(drive
, &idetape_driver
);
2674 kref_init(&tape
->kref
);
2676 tape
->drive
= drive
;
2677 tape
->driver
= &idetape_driver
;
2680 g
->private_data
= &tape
->driver
;
2682 drive
->driver_data
= tape
;
2684 mutex_lock(&idetape_ref_mutex
);
2685 for (minor
= 0; idetape_devs
[minor
]; minor
++)
2687 idetape_devs
[minor
] = tape
;
2688 mutex_unlock(&idetape_ref_mutex
);
2690 idetape_setup(drive
, tape
, minor
);
2692 device_create_drvdata(idetape_sysfs_class
, &drive
->gendev
,
2693 MKDEV(IDETAPE_MAJOR
, minor
), NULL
,
2695 device_create_drvdata(idetape_sysfs_class
, &drive
->gendev
,
2696 MKDEV(IDETAPE_MAJOR
, minor
+ 128), NULL
,
2699 g
->fops
= &idetape_block_ops
;
2700 ide_register_region(g
);
2710 static void __exit
idetape_exit(void)
2712 driver_unregister(&idetape_driver
.gen_driver
);
2713 class_destroy(idetape_sysfs_class
);
2714 unregister_chrdev(IDETAPE_MAJOR
, "ht");
2717 static int __init
idetape_init(void)
2720 idetape_sysfs_class
= class_create(THIS_MODULE
, "ide_tape");
2721 if (IS_ERR(idetape_sysfs_class
)) {
2722 idetape_sysfs_class
= NULL
;
2723 printk(KERN_ERR
"Unable to create sysfs class for ide tapes\n");
2728 if (register_chrdev(IDETAPE_MAJOR
, "ht", &idetape_fops
)) {
2729 printk(KERN_ERR
"ide-tape: Failed to register chrdev"
2732 goto out_free_class
;
2735 error
= driver_register(&idetape_driver
.gen_driver
);
2737 goto out_free_driver
;
2742 driver_unregister(&idetape_driver
.gen_driver
);
2744 class_destroy(idetape_sysfs_class
);
2749 MODULE_ALIAS("ide:*m-tape*");
2750 module_init(idetape_init
);
2751 module_exit(idetape_exit
);
2752 MODULE_ALIAS_CHARDEV_MAJOR(IDETAPE_MAJOR
);
2753 MODULE_DESCRIPTION("ATAPI Streaming TAPE Driver");
2754 MODULE_LICENSE("GPL");