2a362138f97310f6ca6c8060eccbad2dab3d2fe8
[pandora-kernel.git] / drivers / ide / ide-tape.c
1 /*
2  * IDE ATAPI streaming tape driver.
3  *
4  * Copyright (C) 1995-1999  Gadi Oxman <gadio@netvision.net.il>
5  * Copyright (C) 2003-2005  Bartlomiej Zolnierkiewicz
6  *
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.
10  *
11  * It is hereby placed under the terms of the GNU general public license.
12  * (See linux/COPYING).
13  *
14  * For a historical changelog see
15  * Documentation/ide/ChangeLog.ide-tape.1995-2002
16  */
17
18 #define IDETAPE_VERSION "1.20"
19
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>
26 #include <linux/mm.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>
40
41 #include <asm/byteorder.h>
42 #include <linux/irq.h>
43 #include <linux/uaccess.h>
44 #include <linux/io.h>
45 #include <asm/unaligned.h>
46 #include <linux/mtio.h>
47
48 enum {
49         /* output errors only */
50         DBG_ERR =               (1 << 0),
51         /* output all sense key/asc */
52         DBG_SENSE =             (1 << 1),
53         /* info regarding all chrdev-related procedures */
54         DBG_CHRDEV =            (1 << 2),
55         /* all remaining procedures */
56         DBG_PROCS =             (1 << 3),
57         /* buffer alloc info (pc_stack & rq_stack) */
58         DBG_PCRQ_STACK =        (1 << 4),
59 };
60
61 /* define to see debug info */
62 #define IDETAPE_DEBUG_LOG               0
63
64 #if IDETAPE_DEBUG_LOG
65 #define debug_log(lvl, fmt, args...)                    \
66 {                                                       \
67         if (tape->debug_mask & lvl)                     \
68         printk(KERN_INFO "ide-tape: " fmt, ## args);    \
69 }
70 #else
71 #define debug_log(lvl, fmt, args...) do {} while (0)
72 #endif
73
74 /**************************** Tunable parameters *****************************/
75 /*
76  * After each failed packet command we issue a request sense command and retry
77  * the packet command IDETAPE_MAX_PC_RETRIES times.
78  *
79  * Setting IDETAPE_MAX_PC_RETRIES to 0 will disable retries.
80  */
81 #define IDETAPE_MAX_PC_RETRIES          3
82
83 /*
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)
86  */
87 #define IDETAPE_PC_BUFFER_SIZE          256
88
89 /*
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.
93  */
94 #define IDETAPE_PC_STACK                (10 + IDETAPE_MAX_PC_RETRIES)
95
96 /*
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).
100  */
101 #define IDETAPE_WAIT_CMD                (900*HZ)
102
103 /*
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.
108  */
109 #define IDETAPE_FIFO_THRESHOLD          2
110
111 /*
112  * DSC polling parameters.
113  *
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:
116  *
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.
122  *
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).
131  *
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.
134  */
135
136 /* DSC timings. */
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 */
144
145 /*************************** End of tunable parameters ***********************/
146
147 /* tape directions */
148 enum {
149         IDETAPE_DIR_NONE  = (1 << 0),
150         IDETAPE_DIR_READ  = (1 << 1),
151         IDETAPE_DIR_WRITE = (1 << 2),
152 };
153
154 struct idetape_bh {
155         u32 b_size;
156         atomic_t b_count;
157         struct idetape_bh *b_reqnext;
158         char *b_data;
159 };
160
161 /* Tape door status */
162 #define DOOR_UNLOCKED                   0
163 #define DOOR_LOCKED                     1
164 #define DOOR_EXPLICITLY_LOCKED          2
165
166 /* Some defines for the SPACE command */
167 #define IDETAPE_SPACE_OVER_FILEMARK     1
168 #define IDETAPE_SPACE_TO_EOD            3
169
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
174
175 /*
176  * Special requests for our block device strategy routine.
177  *
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.
180  */
181
182 enum {
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),
187 };
188
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
193
194 /* Structures related to the SELECT SENSE / MODE SENSE packet commands. */
195 #define IDETAPE_BLOCK_DESCRIPTOR        0
196 #define IDETAPE_CAPABILITIES_PAGE       0x2a
197
198 /* Tape flag bits values. */
199 enum {
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),
213 };
214
215 /*
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.
218  */
219 typedef struct ide_tape_obj {
220         ide_drive_t     *drive;
221         ide_driver_t    *driver;
222         struct gendisk  *disk;
223         struct kref     kref;
224
225         /*
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.
232          *
233          *      pc points to the current processed packet command.
234          *
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.
239          */
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 */
247         int pc_stack_index;
248         struct request rq_stack[IDETAPE_PC_STACK];
249         /* We implement a circular array */
250         int rq_stack_index;
251
252         /*
253          * DSC polling variables.
254          *
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.
259          */
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;
269
270         /* Read position information */
271         u8 partition;
272         /* Current block */
273         unsigned int first_frame;
274
275         /* Last error information */
276         u8 sense_key, asc, ascq;
277
278         /* Character device operation */
279         unsigned int minor;
280         /* device name */
281         char name[4];
282         /* Current character device data transfer direction */
283         u8 chrdev_dir;
284
285         /* tape block size, usually 512 or 1024 bytes */
286         unsigned short blk_size;
287         int user_bs_factor;
288
289         /* Copy of the tape's Capabilities and Mechanical Page */
290         u8 caps[20];
291
292         /*
293          * Active data transfer request parameters.
294          *
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.
298          */
299
300         /* Data buffer size chosen based on the tape's recommendation */
301         int buffer_size;
302         /* merge buffer */
303         struct idetape_bh *merge_bh;
304         /* size of the merge buffer */
305         int merge_bh_size;
306         /* pointer to current buffer head within the merge buffer */
307         struct idetape_bh *bh;
308         char *b_data;
309         int b_count;
310
311         int pages_per_buffer;
312         /* Wasted space in each stage */
313         int excess_bh_size;
314
315         /* Status/Action flags: long for set_bit */
316         unsigned long flags;
317         /* protects the ide-tape queue */
318         spinlock_t lock;
319
320         /* Measures average tape speed */
321         unsigned long avg_time;
322         int avg_size;
323         int avg_speed;
324
325         /* the door is currently locked */
326         int door_locked;
327         /* the tape hardware is write protected */
328         char drv_write_prot;
329         /* the tape is write protected (hardware or opened as read-only) */
330         char write_prot;
331
332         u32 debug_mask;
333 } idetape_tape_t;
334
335 static DEFINE_MUTEX(idetape_ref_mutex);
336
337 static struct class *idetape_sysfs_class;
338
339 #define to_ide_tape(obj) container_of(obj, struct ide_tape_obj, kref)
340
341 #define ide_tape_g(disk) \
342         container_of((disk)->private_data, struct ide_tape_obj, driver)
343
344 static struct ide_tape_obj *ide_tape_get(struct gendisk *disk)
345 {
346         struct ide_tape_obj *tape = NULL;
347
348         mutex_lock(&idetape_ref_mutex);
349         tape = ide_tape_g(disk);
350         if (tape)
351                 kref_get(&tape->kref);
352         mutex_unlock(&idetape_ref_mutex);
353         return tape;
354 }
355
356 static void ide_tape_release(struct kref *);
357
358 static void ide_tape_put(struct ide_tape_obj *tape)
359 {
360         mutex_lock(&idetape_ref_mutex);
361         kref_put(&tape->kref, ide_tape_release);
362         mutex_unlock(&idetape_ref_mutex);
363 }
364
365 /*
366  * The variables below are used for the character device interface. Additional
367  * state variables are defined in our ide_drive_t structure.
368  */
369 static struct ide_tape_obj *idetape_devs[MAX_HWIFS * MAX_DRIVES];
370
371 #define ide_tape_f(file) ((file)->private_data)
372
373 static struct ide_tape_obj *ide_tape_chrdev_get(unsigned int i)
374 {
375         struct ide_tape_obj *tape = NULL;
376
377         mutex_lock(&idetape_ref_mutex);
378         tape = idetape_devs[i];
379         if (tape)
380                 kref_get(&tape->kref);
381         mutex_unlock(&idetape_ref_mutex);
382         return tape;
383 }
384
385 static void idetape_input_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
386                                   unsigned int bcount)
387 {
388         struct idetape_bh *bh = pc->bh;
389         int count;
390
391         while (bcount) {
392                 if (bh == NULL) {
393                         printk(KERN_ERR "ide-tape: bh == NULL in "
394                                 "idetape_input_buffers\n");
395                         ide_pad_transfer(drive, 0, bcount);
396                         return;
397                 }
398                 count = min(
399                         (unsigned int)(bh->b_size - atomic_read(&bh->b_count)),
400                         bcount);
401                 drive->hwif->input_data(drive, NULL, bh->b_data +
402                                         atomic_read(&bh->b_count), count);
403                 bcount -= count;
404                 atomic_add(count, &bh->b_count);
405                 if (atomic_read(&bh->b_count) == bh->b_size) {
406                         bh = bh->b_reqnext;
407                         if (bh)
408                                 atomic_set(&bh->b_count, 0);
409                 }
410         }
411         pc->bh = bh;
412 }
413
414 static void idetape_output_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
415                                    unsigned int bcount)
416 {
417         struct idetape_bh *bh = pc->bh;
418         int count;
419
420         while (bcount) {
421                 if (bh == NULL) {
422                         printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
423                                         __func__);
424                         return;
425                 }
426                 count = min((unsigned int)pc->b_count, (unsigned int)bcount);
427                 drive->hwif->output_data(drive, NULL, pc->b_data, count);
428                 bcount -= count;
429                 pc->b_data += count;
430                 pc->b_count -= count;
431                 if (!pc->b_count) {
432                         bh = bh->b_reqnext;
433                         pc->bh = bh;
434                         if (bh) {
435                                 pc->b_data = bh->b_data;
436                                 pc->b_count = atomic_read(&bh->b_count);
437                         }
438                 }
439         }
440 }
441
442 static void idetape_update_buffers(struct ide_atapi_pc *pc)
443 {
444         struct idetape_bh *bh = pc->bh;
445         int count;
446         unsigned int bcount = pc->xferred;
447
448         if (pc->flags & PC_FLAG_WRITING)
449                 return;
450         while (bcount) {
451                 if (bh == NULL) {
452                         printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
453                                         __func__);
454                         return;
455                 }
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)
459                         bh = bh->b_reqnext;
460                 bcount -= count;
461         }
462         pc->bh = bh;
463 }
464
465 /*
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.
470  */
471 static struct ide_atapi_pc *idetape_next_pc_storage(ide_drive_t *drive)
472 {
473         idetape_tape_t *tape = drive->driver_data;
474
475         debug_log(DBG_PCRQ_STACK, "pc_stack_index=%d\n", tape->pc_stack_index);
476
477         if (tape->pc_stack_index == IDETAPE_PC_STACK)
478                 tape->pc_stack_index = 0;
479         return (&tape->pc_stack[tape->pc_stack_index++]);
480 }
481
482 /*
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.
486  */
487
488 /**************************************************************
489  *                                                            *
490  *  This should get fixed to use kmalloc(.., GFP_ATOMIC)      *
491  *  followed later on by kfree().   -ml                       *
492  *                                                            *
493  **************************************************************/
494
495 static struct request *idetape_next_rq_storage(ide_drive_t *drive)
496 {
497         idetape_tape_t *tape = drive->driver_data;
498
499         debug_log(DBG_PCRQ_STACK, "rq_stack_index=%d\n", tape->rq_stack_index);
500
501         if (tape->rq_stack_index == IDETAPE_PC_STACK)
502                 tape->rq_stack_index = 0;
503         return (&tape->rq_stack[tape->rq_stack_index++]);
504 }
505
506 /*
507  * called on each failed packet command retry to analyze the request sense. We
508  * currently do not utilize this information.
509  */
510 static void idetape_analyze_error(ide_drive_t *drive, u8 *sense)
511 {
512         idetape_tape_t *tape = drive->driver_data;
513         struct ide_atapi_pc *pc = tape->failed_pc;
514
515         tape->sense_key = sense[2] & 0xF;
516         tape->asc       = sense[12];
517         tape->ascq      = sense[13];
518
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);
521
522         /* Correct pc->xferred by asking the tape.       */
523         if (pc->flags & PC_FLAG_DMA_ERROR) {
524                 pc->xferred = pc->req_xfer -
525                         tape->blk_size *
526                         get_unaligned_be32(&sense[3]);
527                 idetape_update_buffers(pc);
528         }
529
530         /*
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.
534          */
535         if ((pc->c[0] == READ_6 || pc->c[0] == WRITE_6)
536             /* length == 0 */
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 */
540                         pc->error = 0;
541                         /* don't retry read/write */
542                         pc->flags |= PC_FLAG_ABORT;
543                 }
544         }
545         if (pc->c[0] == READ_6 && (sense[2] & 0x80)) {
546                 pc->error = IDETAPE_ERROR_FILEMARK;
547                 pc->flags |= PC_FLAG_ABORT;
548         }
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;
554                 }
555         }
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;
560                 }
561                 if (!(pc->flags & PC_FLAG_ABORT) &&
562                     pc->xferred)
563                         pc->retries = IDETAPE_MAX_PC_RETRIES + 1;
564         }
565 }
566
567 /* Free data buffers completely. */
568 static void ide_tape_kfree_buffer(idetape_tape_t *tape)
569 {
570         struct idetape_bh *prev_bh, *bh = tape->merge_bh;
571
572         while (bh) {
573                 u32 size = bh->b_size;
574
575                 while (size) {
576                         unsigned int order = fls(size >> PAGE_SHIFT)-1;
577
578                         if (bh->b_data)
579                                 free_pages((unsigned long)bh->b_data, order);
580
581                         size &= (order-1);
582                         bh->b_data += (1 << order) * PAGE_SIZE;
583                 }
584                 prev_bh = bh;
585                 bh = bh->b_reqnext;
586                 kfree(prev_bh);
587         }
588         kfree(tape->merge_bh);
589 }
590
591 static int idetape_end_request(ide_drive_t *drive, int uptodate, int nr_sects)
592 {
593         struct request *rq = HWGROUP(drive)->rq;
594         idetape_tape_t *tape = drive->driver_data;
595         unsigned long flags;
596         int error;
597
598         debug_log(DBG_PROCS, "Enter %s\n", __func__);
599
600         switch (uptodate) {
601         case 0: error = IDETAPE_ERROR_GENERAL; break;
602         case 1: error = 0; break;
603         default: error = uptodate;
604         }
605         rq->errors = error;
606         if (error)
607                 tape->failed_pc = NULL;
608
609         if (!blk_special_request(rq)) {
610                 ide_end_request(drive, uptodate, nr_sects);
611                 return 0;
612         }
613
614         spin_lock_irqsave(&tape->lock, flags);
615
616         ide_end_drive_cmd(drive, 0, 0);
617
618         spin_unlock_irqrestore(&tape->lock, flags);
619         return 0;
620 }
621
622 static void ide_tape_callback(ide_drive_t *drive)
623 {
624         idetape_tape_t *tape = drive->driver_data;
625         struct ide_atapi_pc *pc = tape->pc;
626         int uptodate = pc->error ? 0 : 1;
627
628         debug_log(DBG_PROCS, "Enter %s\n", __func__);
629
630         if (pc->c[0] == REQUEST_SENSE) {
631                 if (uptodate)
632                         idetape_analyze_error(drive, pc->buf);
633                 else
634                         printk(KERN_ERR "ide-tape: Error in REQUEST SENSE "
635                                         "itself - Aborting request!\n");
636         } else if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
637                 struct request *rq = drive->hwif->hwgroup->rq;
638                 int blocks = pc->xferred / tape->blk_size;
639
640                 tape->avg_size += blocks * tape->blk_size;
641
642                 if (time_after_eq(jiffies, tape->avg_time + HZ)) {
643                         tape->avg_speed = tape->avg_size * HZ /
644                                 (jiffies - tape->avg_time) / 1024;
645                         tape->avg_size = 0;
646                         tape->avg_time = jiffies;
647                 }
648
649                 tape->first_frame += blocks;
650                 rq->current_nr_sectors -= blocks;
651
652                 if (pc->error)
653                         uptodate = pc->error;
654         } else if (pc->c[0] == READ_POSITION && uptodate) {
655                 u8 *readpos = tape->pc->buf;
656
657                 debug_log(DBG_SENSE, "BOP - %s\n",
658                                 (readpos[0] & 0x80) ? "Yes" : "No");
659                 debug_log(DBG_SENSE, "EOP - %s\n",
660                                 (readpos[0] & 0x40) ? "Yes" : "No");
661
662                 if (readpos[0] & 0x4) {
663                         printk(KERN_INFO "ide-tape: Block location is unknown"
664                                          "to the tape\n");
665                         clear_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags);
666                         uptodate = 0;
667                 } else {
668                         debug_log(DBG_SENSE, "Block Location - %u\n",
669                                         be32_to_cpu(*(u32 *)&readpos[4]));
670
671                         tape->partition = readpos[1];
672                         tape->first_frame = be32_to_cpu(*(u32 *)&readpos[4]);
673                         set_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags);
674                 }
675         }
676
677         idetape_end_request(drive, uptodate, 0);
678 }
679
680 static void idetape_init_pc(struct ide_atapi_pc *pc)
681 {
682         memset(pc->c, 0, 12);
683         pc->retries = 0;
684         pc->flags = 0;
685         pc->req_xfer = 0;
686         pc->buf = pc->pc_buf;
687         pc->buf_size = IDETAPE_PC_BUFFER_SIZE;
688         pc->bh = NULL;
689         pc->b_data = NULL;
690         pc->callback = ide_tape_callback;
691 }
692
693 static void idetape_create_request_sense_cmd(struct ide_atapi_pc *pc)
694 {
695         idetape_init_pc(pc);
696         pc->c[0] = REQUEST_SENSE;
697         pc->c[4] = 20;
698         pc->req_xfer = 20;
699 }
700
701 static void idetape_init_rq(struct request *rq, u8 cmd)
702 {
703         blk_rq_init(NULL, rq);
704         rq->cmd_type = REQ_TYPE_SPECIAL;
705         rq->cmd[0] = cmd;
706 }
707
708 /*
709  * Generate a new packet command request in front of the request queue, before
710  * the current request, so that it will be processed immediately, on the next
711  * pass through the driver. The function below is called from the request
712  * handling part of the driver (the "bottom" part). Safe storage for the request
713  * should be allocated with ide_tape_next_{pc,rq}_storage() prior to that.
714  *
715  * Memory for those requests is pre-allocated at initialization time, and is
716  * limited to IDETAPE_PC_STACK requests. We assume that we have enough space for
717  * the maximum possible number of inter-dependent packet commands.
718  *
719  * The higher level of the driver - The ioctl handler and the character device
720  * handling functions should queue request to the lower level part and wait for
721  * their completion using idetape_queue_pc_tail or idetape_queue_rw_tail.
722  */
723 static void idetape_queue_pc_head(ide_drive_t *drive, struct ide_atapi_pc *pc,
724                                   struct request *rq)
725 {
726         struct ide_tape_obj *tape = drive->driver_data;
727
728         idetape_init_rq(rq, REQ_IDETAPE_PC1);
729         rq->cmd_flags |= REQ_PREEMPT;
730         rq->buffer = (char *) pc;
731         rq->rq_disk = tape->disk;
732         ide_do_drive_cmd(drive, rq);
733 }
734
735 /*
736  *      idetape_retry_pc is called when an error was detected during the
737  *      last packet command. We queue a request sense packet command in
738  *      the head of the request list.
739  */
740 static void idetape_retry_pc(ide_drive_t *drive)
741 {
742         idetape_tape_t *tape = drive->driver_data;
743         struct ide_atapi_pc *pc;
744         struct request *rq;
745
746         (void)ide_read_error(drive);
747         pc = idetape_next_pc_storage(drive);
748         rq = idetape_next_rq_storage(drive);
749         idetape_create_request_sense_cmd(pc);
750         set_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags);
751         idetape_queue_pc_head(drive, pc, rq);
752 }
753
754 /*
755  * Postpone the current request so that ide.c will be able to service requests
756  * from another device on the same hwgroup while we are polling for DSC.
757  */
758 static void idetape_postpone_request(ide_drive_t *drive)
759 {
760         idetape_tape_t *tape = drive->driver_data;
761
762         debug_log(DBG_PROCS, "Enter %s\n", __func__);
763
764         tape->postponed_rq = HWGROUP(drive)->rq;
765         ide_stall_queue(drive, tape->dsc_poll_freq);
766 }
767
768 typedef void idetape_io_buf(ide_drive_t *, struct ide_atapi_pc *, unsigned int);
769
770 /*
771  * This is the usual interrupt handler which will be called during a packet
772  * command. We will transfer some of the data (as requested by the drive) and
773  * will re-point interrupt handler to us. When data transfer is finished, we
774  * will act according to the algorithm described before
775  * idetape_issue_pc.
776  */
777 static ide_startstop_t idetape_pc_intr(ide_drive_t *drive)
778 {
779         ide_hwif_t *hwif = drive->hwif;
780         idetape_tape_t *tape = drive->driver_data;
781         struct ide_atapi_pc *pc = tape->pc;
782         xfer_func_t *xferfunc;
783         idetape_io_buf *iobuf;
784         unsigned int temp;
785         u16 bcount;
786         u8 stat, ireason;
787
788         debug_log(DBG_PROCS, "Enter %s - interrupt handler\n", __func__);
789
790         /* Clear the interrupt */
791         stat = ide_read_status(drive);
792
793         if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
794                 if (hwif->dma_ops->dma_end(drive) || (stat & ERR_STAT)) {
795                         pc->flags |= PC_FLAG_DMA_ERROR;
796                 } else {
797                         pc->xferred = pc->req_xfer;
798                         idetape_update_buffers(pc);
799                 }
800                 debug_log(DBG_PROCS, "DMA finished\n");
801
802         }
803
804         /* No more interrupts */
805         if ((stat & DRQ_STAT) == 0) {
806                 debug_log(DBG_SENSE, "Packet command completed, %d bytes"
807                                 " transferred\n", pc->xferred);
808
809                 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
810                 local_irq_enable_in_hardirq();
811
812                 if ((stat & ERR_STAT) && pc->c[0] == REQUEST_SENSE)
813                         stat &= ~ERR_STAT;
814                 if ((stat & ERR_STAT) || (pc->flags & PC_FLAG_DMA_ERROR)) {
815                         /* Error detected */
816                         debug_log(DBG_ERR, "%s: I/O error\n", tape->name);
817
818                         if (pc->c[0] == REQUEST_SENSE) {
819                                 printk(KERN_ERR "%s: I/O error in request sense"
820                                                 " command\n", drive->name);
821                                 return ide_do_reset(drive);
822                         }
823                         debug_log(DBG_ERR, "[cmd %x]: check condition\n",
824                                         pc->c[0]);
825
826                         /* Retry operation */
827                         idetape_retry_pc(drive);
828                         return ide_stopped;
829                 }
830                 pc->error = 0;
831                 if ((pc->flags & PC_FLAG_WAIT_FOR_DSC) &&
832                     (stat & SEEK_STAT) == 0) {
833                         /* Media access command */
834                         tape->dsc_polling_start = jiffies;
835                         tape->dsc_poll_freq = IDETAPE_DSC_MA_FAST;
836                         tape->dsc_timeout = jiffies + IDETAPE_DSC_MA_TIMEOUT;
837                         /* Allow ide.c to handle other requests */
838                         idetape_postpone_request(drive);
839                         return ide_stopped;
840                 }
841                 if (tape->failed_pc == pc)
842                         tape->failed_pc = NULL;
843                 /* Command finished - Call the callback function */
844                 pc->callback(drive);
845                 return ide_stopped;
846         }
847
848         if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
849                 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
850                 printk(KERN_ERR "%s: The device wants to issue more interrupts "
851                                 "in DMA mode\n", drive->name);
852                 ide_dma_off(drive);
853                 return ide_do_reset(drive);
854         }
855         /* Get the number of bytes to transfer on this interrupt. */
856         bcount = (hwif->INB(hwif->io_ports.lbah_addr) << 8) |
857                   hwif->INB(hwif->io_ports.lbam_addr);
858
859         ireason = hwif->INB(hwif->io_ports.nsect_addr);
860
861         if (ireason & CD) {
862                 printk(KERN_ERR "%s: CoD != 0 in %s\n", drive->name, __func__);
863                 return ide_do_reset(drive);
864         }
865         if (((ireason & IO) == IO) == !!(pc->flags & PC_FLAG_WRITING)) {
866                 /* Hopefully, we will never get here */
867                 printk(KERN_ERR "%s: We wanted to %s, but the device wants us "
868                                 "to %s!\n", drive->name,
869                                 (ireason & IO) ? "Write" : "Read",
870                                 (ireason & IO) ? "Read" : "Write");
871                 return ide_do_reset(drive);
872         }
873         if (!(pc->flags & PC_FLAG_WRITING)) {
874                 /* Reading - Check that we have enough space */
875                 temp = pc->xferred + bcount;
876                 if (temp > pc->req_xfer) {
877                         if (temp > pc->buf_size) {
878                                 printk(KERN_ERR "%s: The device wants to send "
879                                                 "us more data than expected - "
880                                                 "discarding data\n",
881                                                 drive->name);
882                                 ide_pad_transfer(drive, 0, bcount);
883                                 ide_set_handler(drive, &idetape_pc_intr,
884                                                 IDETAPE_WAIT_CMD, NULL);
885                                 return ide_started;
886                         }
887                         debug_log(DBG_SENSE, "The device wants to send us more "
888                                 "data than expected - allowing transfer\n");
889                 }
890                 iobuf = &idetape_input_buffers;
891                 xferfunc = hwif->input_data;
892         } else {
893                 iobuf = &idetape_output_buffers;
894                 xferfunc = hwif->output_data;
895         }
896
897         if (pc->bh)
898                 iobuf(drive, pc, bcount);
899         else
900                 xferfunc(drive, NULL, pc->cur_pos, bcount);
901
902         /* Update the current position */
903         pc->xferred += bcount;
904         pc->cur_pos += bcount;
905
906         debug_log(DBG_SENSE, "[cmd %x] transferred %d bytes on that intr.\n",
907                         pc->c[0], bcount);
908
909         /* And set the interrupt handler again */
910         ide_set_handler(drive, &idetape_pc_intr, IDETAPE_WAIT_CMD, NULL);
911         return ide_started;
912 }
913
914 /*
915  * Packet Command Interface
916  *
917  * The current Packet Command is available in tape->pc, and will not change
918  * until we finish handling it. Each packet command is associated with a
919  * callback function that will be called when the command is finished.
920  *
921  * The handling will be done in three stages:
922  *
923  * 1. idetape_issue_pc will send the packet command to the drive, and will set
924  * the interrupt handler to idetape_pc_intr.
925  *
926  * 2. On each interrupt, idetape_pc_intr will be called. This step will be
927  * repeated until the device signals us that no more interrupts will be issued.
928  *
929  * 3. ATAPI Tape media access commands have immediate status with a delayed
930  * process. In case of a successful initiation of a media access packet command,
931  * the DSC bit will be set when the actual execution of the command is finished.
932  * Since the tape drive will not issue an interrupt, we have to poll for this
933  * event. In this case, we define the request as "low priority request" by
934  * setting rq_status to IDETAPE_RQ_POSTPONED, set a timer to poll for DSC and
935  * exit the driver.
936  *
937  * ide.c will then give higher priority to requests which originate from the
938  * other device, until will change rq_status to RQ_ACTIVE.
939  *
940  * 4. When the packet command is finished, it will be checked for errors.
941  *
942  * 5. In case an error was found, we queue a request sense packet command in
943  * front of the request queue and retry the operation up to
944  * IDETAPE_MAX_PC_RETRIES times.
945  *
946  * 6. In case no error was found, or we decided to give up and not to retry
947  * again, the callback function will be called and then we will handle the next
948  * request.
949  */
950
951 static u8 ide_tape_wait_ireason(ide_drive_t *drive, u8 ireason)
952 {
953         ide_hwif_t *hwif = drive->hwif;
954         int retries = 100;
955
956         while (retries-- && ((ireason & CD) == 0 || (ireason & IO))) {
957                 printk(KERN_ERR "%s: (IO,CoD != (0,1) while issuing "
958                                 "a packet command, retrying\n", drive->name);
959                 udelay(100);
960                 ireason = hwif->INB(hwif->io_ports.nsect_addr);
961                 if (retries == 0) {
962                         printk(KERN_ERR "%s: (IO,CoD != (0,1) while issuing "
963                                         "a packet command, ignoring\n",
964                                         drive->name);
965                         ireason |= CD;
966                         ireason &= ~IO;
967                 }
968         }
969
970         return ireason;
971 }
972
973 static ide_startstop_t idetape_transfer_pc(ide_drive_t *drive)
974 {
975         ide_hwif_t *hwif = drive->hwif;
976         idetape_tape_t *tape = drive->driver_data;
977         struct ide_atapi_pc *pc = tape->pc;
978         ide_startstop_t startstop;
979         u8 ireason;
980
981         if (ide_wait_stat(&startstop, drive, DRQ_STAT, BUSY_STAT, WAIT_READY)) {
982                 printk(KERN_ERR "%s: Strange, packet command initiated yet "
983                                 "DRQ isn't asserted\n", drive->name);
984                 return startstop;
985         }
986
987         ireason = hwif->INB(hwif->io_ports.nsect_addr);
988         ireason = ide_tape_wait_ireason(drive, ireason);
989
990         if ((ireason & CD) == 0 || (ireason & IO)) {
991                 printk(KERN_ERR "%s: (IO,CoD) != (0,1) while issuing "
992                                 "a packet command\n", drive->name);
993                 return ide_do_reset(drive);
994         }
995         /* Set the interrupt routine */
996         ide_set_handler(drive, &idetape_pc_intr, IDETAPE_WAIT_CMD, NULL);
997
998         /* Begin DMA, if necessary */
999         if (pc->flags & PC_FLAG_DMA_OK) {
1000                 pc->flags |= PC_FLAG_DMA_IN_PROGRESS;
1001                 hwif->dma_ops->dma_start(drive);
1002         }
1003
1004         /* Send the actual packet */
1005         hwif->output_data(drive, NULL, pc->c, 12);
1006
1007         return ide_started;
1008 }
1009
1010 static ide_startstop_t idetape_issue_pc(ide_drive_t *drive,
1011                 struct ide_atapi_pc *pc)
1012 {
1013         ide_hwif_t *hwif = drive->hwif;
1014         idetape_tape_t *tape = drive->driver_data;
1015         int dma_ok = 0;
1016         u16 bcount;
1017
1018         if (tape->pc->c[0] == REQUEST_SENSE &&
1019             pc->c[0] == REQUEST_SENSE) {
1020                 printk(KERN_ERR "ide-tape: possible ide-tape.c bug - "
1021                         "Two request sense in serial were issued\n");
1022         }
1023
1024         if (tape->failed_pc == NULL && pc->c[0] != REQUEST_SENSE)
1025                 tape->failed_pc = pc;
1026         /* Set the current packet command */
1027         tape->pc = pc;
1028
1029         if (pc->retries > IDETAPE_MAX_PC_RETRIES ||
1030                 (pc->flags & PC_FLAG_ABORT)) {
1031                 /*
1032                  * We will "abort" retrying a packet command in case legitimate
1033                  * error code was received (crossing a filemark, or end of the
1034                  * media, for example).
1035                  */
1036                 if (!(pc->flags & PC_FLAG_ABORT)) {
1037                         if (!(pc->c[0] == TEST_UNIT_READY &&
1038                               tape->sense_key == 2 && tape->asc == 4 &&
1039                              (tape->ascq == 1 || tape->ascq == 8))) {
1040                                 printk(KERN_ERR "ide-tape: %s: I/O error, "
1041                                                 "pc = %2x, key = %2x, "
1042                                                 "asc = %2x, ascq = %2x\n",
1043                                                 tape->name, pc->c[0],
1044                                                 tape->sense_key, tape->asc,
1045                                                 tape->ascq);
1046                         }
1047                         /* Giving up */
1048                         pc->error = IDETAPE_ERROR_GENERAL;
1049                 }
1050                 tape->failed_pc = NULL;
1051                 pc->callback(drive);
1052                 return ide_stopped;
1053         }
1054         debug_log(DBG_SENSE, "Retry #%d, cmd = %02X\n", pc->retries, pc->c[0]);
1055
1056         pc->retries++;
1057         /* We haven't transferred any data yet */
1058         pc->xferred = 0;
1059         pc->cur_pos = pc->buf;
1060         /* Request to transfer the entire buffer at once */
1061         bcount = pc->req_xfer;
1062
1063         if (pc->flags & PC_FLAG_DMA_ERROR) {
1064                 pc->flags &= ~PC_FLAG_DMA_ERROR;
1065                 ide_dma_off(drive);
1066         }
1067         if ((pc->flags & PC_FLAG_DMA_OK) && drive->using_dma)
1068                 dma_ok = !hwif->dma_ops->dma_setup(drive);
1069
1070         if (!dma_ok)
1071                 pc->flags &= ~PC_FLAG_DMA_OK;
1072
1073         ide_pktcmd_tf_load(drive, IDE_TFLAG_OUT_DEVICE, bcount, dma_ok);
1074
1075         if (test_bit(IDETAPE_FLAG_DRQ_INTERRUPT, &tape->flags)) {
1076                 ide_execute_command(drive, WIN_PACKETCMD, &idetape_transfer_pc,
1077                                     IDETAPE_WAIT_CMD, NULL);
1078                 return ide_started;
1079         } else {
1080                 ide_execute_pkt_cmd(drive);
1081                 return idetape_transfer_pc(drive);
1082         }
1083 }
1084
1085 /* A mode sense command is used to "sense" tape parameters. */
1086 static void idetape_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
1087 {
1088         idetape_init_pc(pc);
1089         pc->c[0] = MODE_SENSE;
1090         if (page_code != IDETAPE_BLOCK_DESCRIPTOR)
1091                 /* DBD = 1 - Don't return block descriptors */
1092                 pc->c[1] = 8;
1093         pc->c[2] = page_code;
1094         /*
1095          * Changed pc->c[3] to 0 (255 will at best return unused info).
1096          *
1097          * For SCSI this byte is defined as subpage instead of high byte
1098          * of length and some IDE drives seem to interpret it this way
1099          * and return an error when 255 is used.
1100          */
1101         pc->c[3] = 0;
1102         /* We will just discard data in that case */
1103         pc->c[4] = 255;
1104         if (page_code == IDETAPE_BLOCK_DESCRIPTOR)
1105                 pc->req_xfer = 12;
1106         else if (page_code == IDETAPE_CAPABILITIES_PAGE)
1107                 pc->req_xfer = 24;
1108         else
1109                 pc->req_xfer = 50;
1110 }
1111
1112 static ide_startstop_t idetape_media_access_finished(ide_drive_t *drive)
1113 {
1114         idetape_tape_t *tape = drive->driver_data;
1115         struct ide_atapi_pc *pc = tape->pc;
1116         u8 stat;
1117
1118         stat = ide_read_status(drive);
1119
1120         if (stat & SEEK_STAT) {
1121                 if (stat & ERR_STAT) {
1122                         /* Error detected */
1123                         if (pc->c[0] != TEST_UNIT_READY)
1124                                 printk(KERN_ERR "ide-tape: %s: I/O error, ",
1125                                                 tape->name);
1126                         /* Retry operation */
1127                         idetape_retry_pc(drive);
1128                         return ide_stopped;
1129                 }
1130                 pc->error = 0;
1131                 if (tape->failed_pc == pc)
1132                         tape->failed_pc = NULL;
1133         } else {
1134                 pc->error = IDETAPE_ERROR_GENERAL;
1135                 tape->failed_pc = NULL;
1136         }
1137         pc->callback(drive);
1138         return ide_stopped;
1139 }
1140
1141 static void idetape_create_read_cmd(idetape_tape_t *tape,
1142                 struct ide_atapi_pc *pc,
1143                 unsigned int length, struct idetape_bh *bh)
1144 {
1145         idetape_init_pc(pc);
1146         pc->c[0] = READ_6;
1147         put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
1148         pc->c[1] = 1;
1149         pc->bh = bh;
1150         atomic_set(&bh->b_count, 0);
1151         pc->buf = NULL;
1152         pc->buf_size = length * tape->blk_size;
1153         pc->req_xfer = pc->buf_size;
1154         if (pc->req_xfer == tape->buffer_size)
1155                 pc->flags |= PC_FLAG_DMA_OK;
1156 }
1157
1158 static void idetape_create_write_cmd(idetape_tape_t *tape,
1159                 struct ide_atapi_pc *pc,
1160                 unsigned int length, struct idetape_bh *bh)
1161 {
1162         idetape_init_pc(pc);
1163         pc->c[0] = WRITE_6;
1164         put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
1165         pc->c[1] = 1;
1166         pc->flags |= PC_FLAG_WRITING;
1167         pc->bh = bh;
1168         pc->b_data = bh->b_data;
1169         pc->b_count = atomic_read(&bh->b_count);
1170         pc->buf = NULL;
1171         pc->buf_size = length * tape->blk_size;
1172         pc->req_xfer = pc->buf_size;
1173         if (pc->req_xfer == tape->buffer_size)
1174                 pc->flags |= PC_FLAG_DMA_OK;
1175 }
1176
1177 static ide_startstop_t idetape_do_request(ide_drive_t *drive,
1178                                           struct request *rq, sector_t block)
1179 {
1180         idetape_tape_t *tape = drive->driver_data;
1181         struct ide_atapi_pc *pc = NULL;
1182         struct request *postponed_rq = tape->postponed_rq;
1183         u8 stat;
1184
1185         debug_log(DBG_SENSE, "sector: %ld, nr_sectors: %ld,"
1186                         " current_nr_sectors: %d\n",
1187                         rq->sector, rq->nr_sectors, rq->current_nr_sectors);
1188
1189         if (!blk_special_request(rq)) {
1190                 /* We do not support buffer cache originated requests. */
1191                 printk(KERN_NOTICE "ide-tape: %s: Unsupported request in "
1192                         "request queue (%d)\n", drive->name, rq->cmd_type);
1193                 ide_end_request(drive, 0, 0);
1194                 return ide_stopped;
1195         }
1196
1197         /* Retry a failed packet command */
1198         if (tape->failed_pc && tape->pc->c[0] == REQUEST_SENSE)
1199                 return idetape_issue_pc(drive, tape->failed_pc);
1200
1201         if (postponed_rq != NULL)
1202                 if (rq != postponed_rq) {
1203                         printk(KERN_ERR "ide-tape: ide-tape.c bug - "
1204                                         "Two DSC requests were queued\n");
1205                         idetape_end_request(drive, 0, 0);
1206                         return ide_stopped;
1207                 }
1208
1209         tape->postponed_rq = NULL;
1210
1211         /*
1212          * If the tape is still busy, postpone our request and service
1213          * the other device meanwhile.
1214          */
1215         stat = ide_read_status(drive);
1216
1217         if (!drive->dsc_overlap && !(rq->cmd[0] & REQ_IDETAPE_PC2))
1218                 set_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags);
1219
1220         if (drive->post_reset == 1) {
1221                 set_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags);
1222                 drive->post_reset = 0;
1223         }
1224
1225         if (!test_and_clear_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags) &&
1226             (stat & SEEK_STAT) == 0) {
1227                 if (postponed_rq == NULL) {
1228                         tape->dsc_polling_start = jiffies;
1229                         tape->dsc_poll_freq = tape->best_dsc_rw_freq;
1230                         tape->dsc_timeout = jiffies + IDETAPE_DSC_RW_TIMEOUT;
1231                 } else if (time_after(jiffies, tape->dsc_timeout)) {
1232                         printk(KERN_ERR "ide-tape: %s: DSC timeout\n",
1233                                 tape->name);
1234                         if (rq->cmd[0] & REQ_IDETAPE_PC2) {
1235                                 idetape_media_access_finished(drive);
1236                                 return ide_stopped;
1237                         } else {
1238                                 return ide_do_reset(drive);
1239                         }
1240                 } else if (time_after(jiffies,
1241                                         tape->dsc_polling_start +
1242                                         IDETAPE_DSC_MA_THRESHOLD))
1243                         tape->dsc_poll_freq = IDETAPE_DSC_MA_SLOW;
1244                 idetape_postpone_request(drive);
1245                 return ide_stopped;
1246         }
1247         if (rq->cmd[0] & REQ_IDETAPE_READ) {
1248                 pc = idetape_next_pc_storage(drive);
1249                 idetape_create_read_cmd(tape, pc, rq->current_nr_sectors,
1250                                         (struct idetape_bh *)rq->special);
1251                 goto out;
1252         }
1253         if (rq->cmd[0] & REQ_IDETAPE_WRITE) {
1254                 pc = idetape_next_pc_storage(drive);
1255                 idetape_create_write_cmd(tape, pc, rq->current_nr_sectors,
1256                                          (struct idetape_bh *)rq->special);
1257                 goto out;
1258         }
1259         if (rq->cmd[0] & REQ_IDETAPE_PC1) {
1260                 pc = (struct ide_atapi_pc *) rq->buffer;
1261                 rq->cmd[0] &= ~(REQ_IDETAPE_PC1);
1262                 rq->cmd[0] |= REQ_IDETAPE_PC2;
1263                 goto out;
1264         }
1265         if (rq->cmd[0] & REQ_IDETAPE_PC2) {
1266                 idetape_media_access_finished(drive);
1267                 return ide_stopped;
1268         }
1269         BUG();
1270 out:
1271         return idetape_issue_pc(drive, pc);
1272 }
1273
1274 /*
1275  * The function below uses __get_free_pages to allocate a data buffer of size
1276  * tape->buffer_size (or a bit more). We attempt to combine sequential pages as
1277  * much as possible.
1278  *
1279  * It returns a pointer to the newly allocated buffer, or NULL in case of
1280  * failure.
1281  */
1282 static struct idetape_bh *ide_tape_kmalloc_buffer(idetape_tape_t *tape,
1283                                                   int full, int clear)
1284 {
1285         struct idetape_bh *prev_bh, *bh, *merge_bh;
1286         int pages = tape->pages_per_buffer;
1287         unsigned int order, b_allocd;
1288         char *b_data = NULL;
1289
1290         merge_bh = kmalloc(sizeof(struct idetape_bh), GFP_KERNEL);
1291         bh = merge_bh;
1292         if (bh == NULL)
1293                 goto abort;
1294
1295         order = fls(pages) - 1;
1296         bh->b_data = (char *) __get_free_pages(GFP_KERNEL, order);
1297         if (!bh->b_data)
1298                 goto abort;
1299         b_allocd = (1 << order) * PAGE_SIZE;
1300         pages &= (order-1);
1301
1302         if (clear)
1303                 memset(bh->b_data, 0, b_allocd);
1304         bh->b_reqnext = NULL;
1305         bh->b_size = b_allocd;
1306         atomic_set(&bh->b_count, full ? bh->b_size : 0);
1307
1308         while (pages) {
1309                 order = fls(pages) - 1;
1310                 b_data = (char *) __get_free_pages(GFP_KERNEL, order);
1311                 if (!b_data)
1312                         goto abort;
1313                 b_allocd = (1 << order) * PAGE_SIZE;
1314
1315                 if (clear)
1316                         memset(b_data, 0, b_allocd);
1317
1318                 /* newly allocated page frames below buffer header or ...*/
1319                 if (bh->b_data == b_data + b_allocd) {
1320                         bh->b_size += b_allocd;
1321                         bh->b_data -= b_allocd;
1322                         if (full)
1323                                 atomic_add(b_allocd, &bh->b_count);
1324                         continue;
1325                 }
1326                 /* they are above the header */
1327                 if (b_data == bh->b_data + bh->b_size) {
1328                         bh->b_size += b_allocd;
1329                         if (full)
1330                                 atomic_add(b_allocd, &bh->b_count);
1331                         continue;
1332                 }
1333                 prev_bh = bh;
1334                 bh = kmalloc(sizeof(struct idetape_bh), GFP_KERNEL);
1335                 if (!bh) {
1336                         free_pages((unsigned long) b_data, order);
1337                         goto abort;
1338                 }
1339                 bh->b_reqnext = NULL;
1340                 bh->b_data = b_data;
1341                 bh->b_size = b_allocd;
1342                 atomic_set(&bh->b_count, full ? bh->b_size : 0);
1343                 prev_bh->b_reqnext = bh;
1344
1345                 pages &= (order-1);
1346         }
1347
1348         bh->b_size -= tape->excess_bh_size;
1349         if (full)
1350                 atomic_sub(tape->excess_bh_size, &bh->b_count);
1351         return merge_bh;
1352 abort:
1353         ide_tape_kfree_buffer(tape);
1354         return NULL;
1355 }
1356
1357 static int idetape_copy_stage_from_user(idetape_tape_t *tape,
1358                                         const char __user *buf, int n)
1359 {
1360         struct idetape_bh *bh = tape->bh;
1361         int count;
1362         int ret = 0;
1363
1364         while (n) {
1365                 if (bh == NULL) {
1366                         printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
1367                                         __func__);
1368                         return 1;
1369                 }
1370                 count = min((unsigned int)
1371                                 (bh->b_size - atomic_read(&bh->b_count)),
1372                                 (unsigned int)n);
1373                 if (copy_from_user(bh->b_data + atomic_read(&bh->b_count), buf,
1374                                 count))
1375                         ret = 1;
1376                 n -= count;
1377                 atomic_add(count, &bh->b_count);
1378                 buf += count;
1379                 if (atomic_read(&bh->b_count) == bh->b_size) {
1380                         bh = bh->b_reqnext;
1381                         if (bh)
1382                                 atomic_set(&bh->b_count, 0);
1383                 }
1384         }
1385         tape->bh = bh;
1386         return ret;
1387 }
1388
1389 static int idetape_copy_stage_to_user(idetape_tape_t *tape, char __user *buf,
1390                                       int n)
1391 {
1392         struct idetape_bh *bh = tape->bh;
1393         int count;
1394         int ret = 0;
1395
1396         while (n) {
1397                 if (bh == NULL) {
1398                         printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
1399                                         __func__);
1400                         return 1;
1401                 }
1402                 count = min(tape->b_count, n);
1403                 if  (copy_to_user(buf, tape->b_data, count))
1404                         ret = 1;
1405                 n -= count;
1406                 tape->b_data += count;
1407                 tape->b_count -= count;
1408                 buf += count;
1409                 if (!tape->b_count) {
1410                         bh = bh->b_reqnext;
1411                         tape->bh = bh;
1412                         if (bh) {
1413                                 tape->b_data = bh->b_data;
1414                                 tape->b_count = atomic_read(&bh->b_count);
1415                         }
1416                 }
1417         }
1418         return ret;
1419 }
1420
1421 static void idetape_init_merge_buffer(idetape_tape_t *tape)
1422 {
1423         struct idetape_bh *bh = tape->merge_bh;
1424         tape->bh = tape->merge_bh;
1425
1426         if (tape->chrdev_dir == IDETAPE_DIR_WRITE)
1427                 atomic_set(&bh->b_count, 0);
1428         else {
1429                 tape->b_data = bh->b_data;
1430                 tape->b_count = atomic_read(&bh->b_count);
1431         }
1432 }
1433
1434 /*
1435  * Write a filemark if write_filemark=1. Flush the device buffers without
1436  * writing a filemark otherwise.
1437  */
1438 static void idetape_create_write_filemark_cmd(ide_drive_t *drive,
1439                 struct ide_atapi_pc *pc, int write_filemark)
1440 {
1441         idetape_init_pc(pc);
1442         pc->c[0] = WRITE_FILEMARKS;
1443         pc->c[4] = write_filemark;
1444         pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1445 }
1446
1447 static void idetape_create_test_unit_ready_cmd(struct ide_atapi_pc *pc)
1448 {
1449         idetape_init_pc(pc);
1450         pc->c[0] = TEST_UNIT_READY;
1451 }
1452
1453 /*
1454  * We add a special packet command request to the tail of the request queue, and
1455  * wait for it to be serviced. This is not to be called from within the request
1456  * handling part of the driver! We allocate here data on the stack and it is
1457  * valid until the request is finished. This is not the case for the bottom part
1458  * of the driver, where we are always leaving the functions to wait for an
1459  * interrupt or a timer event.
1460  *
1461  * From the bottom part of the driver, we should allocate safe memory using
1462  * idetape_next_pc_storage() and ide_tape_next_rq_storage(), and add the request
1463  * to the request list without waiting for it to be serviced! In that case, we
1464  * usually use idetape_queue_pc_head().
1465  */
1466 static int idetape_queue_pc_tail(ide_drive_t *drive, struct ide_atapi_pc *pc)
1467 {
1468         struct ide_tape_obj *tape = drive->driver_data;
1469         struct request *rq;
1470         int error;
1471
1472         rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
1473         rq->cmd_type = REQ_TYPE_SPECIAL;
1474         rq->cmd[0] = REQ_IDETAPE_PC1;
1475         rq->buffer = (char *)pc;
1476         error = blk_execute_rq(drive->queue, tape->disk, rq, 0);
1477         blk_put_request(rq);
1478         return error;
1479 }
1480
1481 static void idetape_create_load_unload_cmd(ide_drive_t *drive,
1482                 struct ide_atapi_pc *pc, int cmd)
1483 {
1484         idetape_init_pc(pc);
1485         pc->c[0] = START_STOP;
1486         pc->c[4] = cmd;
1487         pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1488 }
1489
1490 static int idetape_wait_ready(ide_drive_t *drive, unsigned long timeout)
1491 {
1492         idetape_tape_t *tape = drive->driver_data;
1493         struct ide_atapi_pc pc;
1494         int load_attempted = 0;
1495
1496         /* Wait for the tape to become ready */
1497         set_bit(IDETAPE_FLAG_MEDIUM_PRESENT, &tape->flags);
1498         timeout += jiffies;
1499         while (time_before(jiffies, timeout)) {
1500                 idetape_create_test_unit_ready_cmd(&pc);
1501                 if (!idetape_queue_pc_tail(drive, &pc))
1502                         return 0;
1503                 if ((tape->sense_key == 2 && tape->asc == 4 && tape->ascq == 2)
1504                     || (tape->asc == 0x3A)) {
1505                         /* no media */
1506                         if (load_attempted)
1507                                 return -ENOMEDIUM;
1508                         idetape_create_load_unload_cmd(drive, &pc,
1509                                                         IDETAPE_LU_LOAD_MASK);
1510                         idetape_queue_pc_tail(drive, &pc);
1511                         load_attempted = 1;
1512                 /* not about to be ready */
1513                 } else if (!(tape->sense_key == 2 && tape->asc == 4 &&
1514                              (tape->ascq == 1 || tape->ascq == 8)))
1515                         return -EIO;
1516                 msleep(100);
1517         }
1518         return -EIO;
1519 }
1520
1521 static int idetape_flush_tape_buffers(ide_drive_t *drive)
1522 {
1523         struct ide_atapi_pc pc;
1524         int rc;
1525
1526         idetape_create_write_filemark_cmd(drive, &pc, 0);
1527         rc = idetape_queue_pc_tail(drive, &pc);
1528         if (rc)
1529                 return rc;
1530         idetape_wait_ready(drive, 60 * 5 * HZ);
1531         return 0;
1532 }
1533
1534 static void idetape_create_read_position_cmd(struct ide_atapi_pc *pc)
1535 {
1536         idetape_init_pc(pc);
1537         pc->c[0] = READ_POSITION;
1538         pc->req_xfer = 20;
1539 }
1540
1541 static int idetape_read_position(ide_drive_t *drive)
1542 {
1543         idetape_tape_t *tape = drive->driver_data;
1544         struct ide_atapi_pc pc;
1545         int position;
1546
1547         debug_log(DBG_PROCS, "Enter %s\n", __func__);
1548
1549         idetape_create_read_position_cmd(&pc);
1550         if (idetape_queue_pc_tail(drive, &pc))
1551                 return -1;
1552         position = tape->first_frame;
1553         return position;
1554 }
1555
1556 static void idetape_create_locate_cmd(ide_drive_t *drive,
1557                 struct ide_atapi_pc *pc,
1558                 unsigned int block, u8 partition, int skip)
1559 {
1560         idetape_init_pc(pc);
1561         pc->c[0] = POSITION_TO_ELEMENT;
1562         pc->c[1] = 2;
1563         put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[3]);
1564         pc->c[8] = partition;
1565         pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1566 }
1567
1568 static int idetape_create_prevent_cmd(ide_drive_t *drive,
1569                 struct ide_atapi_pc *pc, int prevent)
1570 {
1571         idetape_tape_t *tape = drive->driver_data;
1572
1573         /* device supports locking according to capabilities page */
1574         if (!(tape->caps[6] & 0x01))
1575                 return 0;
1576
1577         idetape_init_pc(pc);
1578         pc->c[0] = ALLOW_MEDIUM_REMOVAL;
1579         pc->c[4] = prevent;
1580         return 1;
1581 }
1582
1583 static void __ide_tape_discard_merge_buffer(ide_drive_t *drive)
1584 {
1585         idetape_tape_t *tape = drive->driver_data;
1586
1587         if (tape->chrdev_dir != IDETAPE_DIR_READ)
1588                 return;
1589
1590         clear_bit(IDETAPE_FLAG_FILEMARK, &tape->flags);
1591         tape->merge_bh_size = 0;
1592         if (tape->merge_bh != NULL) {
1593                 ide_tape_kfree_buffer(tape);
1594                 tape->merge_bh = NULL;
1595         }
1596
1597         tape->chrdev_dir = IDETAPE_DIR_NONE;
1598 }
1599
1600 /*
1601  * Position the tape to the requested block using the LOCATE packet command.
1602  * A READ POSITION command is then issued to check where we are positioned. Like
1603  * all higher level operations, we queue the commands at the tail of the request
1604  * queue and wait for their completion.
1605  */
1606 static int idetape_position_tape(ide_drive_t *drive, unsigned int block,
1607                 u8 partition, int skip)
1608 {
1609         idetape_tape_t *tape = drive->driver_data;
1610         int retval;
1611         struct ide_atapi_pc pc;
1612
1613         if (tape->chrdev_dir == IDETAPE_DIR_READ)
1614                 __ide_tape_discard_merge_buffer(drive);
1615         idetape_wait_ready(drive, 60 * 5 * HZ);
1616         idetape_create_locate_cmd(drive, &pc, block, partition, skip);
1617         retval = idetape_queue_pc_tail(drive, &pc);
1618         if (retval)
1619                 return (retval);
1620
1621         idetape_create_read_position_cmd(&pc);
1622         return (idetape_queue_pc_tail(drive, &pc));
1623 }
1624
1625 static void ide_tape_discard_merge_buffer(ide_drive_t *drive,
1626                                           int restore_position)
1627 {
1628         idetape_tape_t *tape = drive->driver_data;
1629         int seek, position;
1630
1631         __ide_tape_discard_merge_buffer(drive);
1632         if (restore_position) {
1633                 position = idetape_read_position(drive);
1634                 seek = position > 0 ? position : 0;
1635                 if (idetape_position_tape(drive, seek, 0, 0)) {
1636                         printk(KERN_INFO "ide-tape: %s: position_tape failed in"
1637                                          " %s\n", tape->name, __func__);
1638                         return;
1639                 }
1640         }
1641 }
1642
1643 /*
1644  * Generate a read/write request for the block device interface and wait for it
1645  * to be serviced.
1646  */
1647 static int idetape_queue_rw_tail(ide_drive_t *drive, int cmd, int blocks,
1648                                  struct idetape_bh *bh)
1649 {
1650         idetape_tape_t *tape = drive->driver_data;
1651         struct request *rq;
1652         int ret, errors;
1653
1654         debug_log(DBG_SENSE, "%s: cmd=%d\n", __func__, cmd);
1655
1656         rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
1657         rq->cmd_type = REQ_TYPE_SPECIAL;
1658         rq->cmd[0] = cmd;
1659         rq->rq_disk = tape->disk;
1660         rq->special = (void *)bh;
1661         rq->sector = tape->first_frame;
1662         rq->nr_sectors = blocks;
1663         rq->current_nr_sectors = blocks;
1664         blk_execute_rq(drive->queue, tape->disk, rq, 0);
1665
1666         errors = rq->errors;
1667         ret = tape->blk_size * (blocks - rq->current_nr_sectors);
1668         blk_put_request(rq);
1669
1670         if ((cmd & (REQ_IDETAPE_READ | REQ_IDETAPE_WRITE)) == 0)
1671                 return 0;
1672
1673         if (tape->merge_bh)
1674                 idetape_init_merge_buffer(tape);
1675         if (errors == IDETAPE_ERROR_GENERAL)
1676                 return -EIO;
1677         return ret;
1678 }
1679
1680 static void idetape_create_inquiry_cmd(struct ide_atapi_pc *pc)
1681 {
1682         idetape_init_pc(pc);
1683         pc->c[0] = INQUIRY;
1684         pc->c[4] = 254;
1685         pc->req_xfer = 254;
1686 }
1687
1688 static void idetape_create_rewind_cmd(ide_drive_t *drive,
1689                 struct ide_atapi_pc *pc)
1690 {
1691         idetape_init_pc(pc);
1692         pc->c[0] = REZERO_UNIT;
1693         pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1694 }
1695
1696 static void idetape_create_erase_cmd(struct ide_atapi_pc *pc)
1697 {
1698         idetape_init_pc(pc);
1699         pc->c[0] = ERASE;
1700         pc->c[1] = 1;
1701         pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1702 }
1703
1704 static void idetape_create_space_cmd(struct ide_atapi_pc *pc, int count, u8 cmd)
1705 {
1706         idetape_init_pc(pc);
1707         pc->c[0] = SPACE;
1708         put_unaligned(cpu_to_be32(count), (unsigned int *) &pc->c[1]);
1709         pc->c[1] = cmd;
1710         pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1711 }
1712
1713 /* Queue up a character device originated write request. */
1714 static int idetape_add_chrdev_write_request(ide_drive_t *drive, int blocks)
1715 {
1716         idetape_tape_t *tape = drive->driver_data;
1717
1718         debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
1719
1720         return idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE,
1721                                      blocks, tape->merge_bh);
1722 }
1723
1724 static void ide_tape_flush_merge_buffer(ide_drive_t *drive)
1725 {
1726         idetape_tape_t *tape = drive->driver_data;
1727         int blocks, min;
1728         struct idetape_bh *bh;
1729
1730         if (tape->chrdev_dir != IDETAPE_DIR_WRITE) {
1731                 printk(KERN_ERR "ide-tape: bug: Trying to empty merge buffer"
1732                                 " but we are not writing.\n");
1733                 return;
1734         }
1735         if (tape->merge_bh_size > tape->buffer_size) {
1736                 printk(KERN_ERR "ide-tape: bug: merge_buffer too big\n");
1737                 tape->merge_bh_size = tape->buffer_size;
1738         }
1739         if (tape->merge_bh_size) {
1740                 blocks = tape->merge_bh_size / tape->blk_size;
1741                 if (tape->merge_bh_size % tape->blk_size) {
1742                         unsigned int i;
1743
1744                         blocks++;
1745                         i = tape->blk_size - tape->merge_bh_size %
1746                                 tape->blk_size;
1747                         bh = tape->bh->b_reqnext;
1748                         while (bh) {
1749                                 atomic_set(&bh->b_count, 0);
1750                                 bh = bh->b_reqnext;
1751                         }
1752                         bh = tape->bh;
1753                         while (i) {
1754                                 if (bh == NULL) {
1755                                         printk(KERN_INFO "ide-tape: bug,"
1756                                                          " bh NULL\n");
1757                                         break;
1758                                 }
1759                                 min = min(i, (unsigned int)(bh->b_size -
1760                                                 atomic_read(&bh->b_count)));
1761                                 memset(bh->b_data + atomic_read(&bh->b_count),
1762                                                 0, min);
1763                                 atomic_add(min, &bh->b_count);
1764                                 i -= min;
1765                                 bh = bh->b_reqnext;
1766                         }
1767                 }
1768                 (void) idetape_add_chrdev_write_request(drive, blocks);
1769                 tape->merge_bh_size = 0;
1770         }
1771         if (tape->merge_bh != NULL) {
1772                 ide_tape_kfree_buffer(tape);
1773                 tape->merge_bh = NULL;
1774         }
1775         tape->chrdev_dir = IDETAPE_DIR_NONE;
1776 }
1777
1778 static int idetape_init_read(ide_drive_t *drive)
1779 {
1780         idetape_tape_t *tape = drive->driver_data;
1781         int bytes_read;
1782
1783         /* Initialize read operation */
1784         if (tape->chrdev_dir != IDETAPE_DIR_READ) {
1785                 if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
1786                         ide_tape_flush_merge_buffer(drive);
1787                         idetape_flush_tape_buffers(drive);
1788                 }
1789                 if (tape->merge_bh || tape->merge_bh_size) {
1790                         printk(KERN_ERR "ide-tape: merge_bh_size should be"
1791                                          " 0 now\n");
1792                         tape->merge_bh_size = 0;
1793                 }
1794                 tape->merge_bh = ide_tape_kmalloc_buffer(tape, 0, 0);
1795                 if (!tape->merge_bh)
1796                         return -ENOMEM;
1797                 tape->chrdev_dir = IDETAPE_DIR_READ;
1798
1799                 /*
1800                  * Issue a read 0 command to ensure that DSC handshake is
1801                  * switched from completion mode to buffer available mode.
1802                  * No point in issuing this if DSC overlap isn't supported, some
1803                  * drives (Seagate STT3401A) will return an error.
1804                  */
1805                 if (drive->dsc_overlap) {
1806                         bytes_read = idetape_queue_rw_tail(drive,
1807                                                         REQ_IDETAPE_READ, 0,
1808                                                         tape->merge_bh);
1809                         if (bytes_read < 0) {
1810                                 ide_tape_kfree_buffer(tape);
1811                                 tape->merge_bh = NULL;
1812                                 tape->chrdev_dir = IDETAPE_DIR_NONE;
1813                                 return bytes_read;
1814                         }
1815                 }
1816         }
1817
1818         return 0;
1819 }
1820
1821 /* called from idetape_chrdev_read() to service a chrdev read request. */
1822 static int idetape_add_chrdev_read_request(ide_drive_t *drive, int blocks)
1823 {
1824         idetape_tape_t *tape = drive->driver_data;
1825
1826         debug_log(DBG_PROCS, "Enter %s, %d blocks\n", __func__, blocks);
1827
1828         /* If we are at a filemark, return a read length of 0 */
1829         if (test_bit(IDETAPE_FLAG_FILEMARK, &tape->flags))
1830                 return 0;
1831
1832         idetape_init_read(drive);
1833
1834         return idetape_queue_rw_tail(drive, REQ_IDETAPE_READ, blocks,
1835                                      tape->merge_bh);
1836 }
1837
1838 static void idetape_pad_zeros(ide_drive_t *drive, int bcount)
1839 {
1840         idetape_tape_t *tape = drive->driver_data;
1841         struct idetape_bh *bh;
1842         int blocks;
1843
1844         while (bcount) {
1845                 unsigned int count;
1846
1847                 bh = tape->merge_bh;
1848                 count = min(tape->buffer_size, bcount);
1849                 bcount -= count;
1850                 blocks = count / tape->blk_size;
1851                 while (count) {
1852                         atomic_set(&bh->b_count,
1853                                    min(count, (unsigned int)bh->b_size));
1854                         memset(bh->b_data, 0, atomic_read(&bh->b_count));
1855                         count -= atomic_read(&bh->b_count);
1856                         bh = bh->b_reqnext;
1857                 }
1858                 idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE, blocks,
1859                                       tape->merge_bh);
1860         }
1861 }
1862
1863 /*
1864  * Rewinds the tape to the Beginning Of the current Partition (BOP). We
1865  * currently support only one partition.
1866  */
1867 static int idetape_rewind_tape(ide_drive_t *drive)
1868 {
1869         int retval;
1870         struct ide_atapi_pc pc;
1871         idetape_tape_t *tape;
1872         tape = drive->driver_data;
1873
1874         debug_log(DBG_SENSE, "Enter %s\n", __func__);
1875
1876         idetape_create_rewind_cmd(drive, &pc);
1877         retval = idetape_queue_pc_tail(drive, &pc);
1878         if (retval)
1879                 return retval;
1880
1881         idetape_create_read_position_cmd(&pc);
1882         retval = idetape_queue_pc_tail(drive, &pc);
1883         if (retval)
1884                 return retval;
1885         return 0;
1886 }
1887
1888 /* mtio.h compatible commands should be issued to the chrdev interface. */
1889 static int idetape_blkdev_ioctl(ide_drive_t *drive, unsigned int cmd,
1890                                 unsigned long arg)
1891 {
1892         idetape_tape_t *tape = drive->driver_data;
1893         void __user *argp = (void __user *)arg;
1894
1895         struct idetape_config {
1896                 int dsc_rw_frequency;
1897                 int dsc_media_access_frequency;
1898                 int nr_stages;
1899         } config;
1900
1901         debug_log(DBG_PROCS, "Enter %s\n", __func__);
1902
1903         switch (cmd) {
1904         case 0x0340:
1905                 if (copy_from_user(&config, argp, sizeof(config)))
1906                         return -EFAULT;
1907                 tape->best_dsc_rw_freq = config.dsc_rw_frequency;
1908                 break;
1909         case 0x0350:
1910                 config.dsc_rw_frequency = (int) tape->best_dsc_rw_freq;
1911                 config.nr_stages = 1;
1912                 if (copy_to_user(argp, &config, sizeof(config)))
1913                         return -EFAULT;
1914                 break;
1915         default:
1916                 return -EIO;
1917         }
1918         return 0;
1919 }
1920
1921 static int idetape_space_over_filemarks(ide_drive_t *drive, short mt_op,
1922                                         int mt_count)
1923 {
1924         idetape_tape_t *tape = drive->driver_data;
1925         struct ide_atapi_pc pc;
1926         int retval, count = 0;
1927         int sprev = !!(tape->caps[4] & 0x20);
1928
1929         if (mt_count == 0)
1930                 return 0;
1931         if (MTBSF == mt_op || MTBSFM == mt_op) {
1932                 if (!sprev)
1933                         return -EIO;
1934                 mt_count = -mt_count;
1935         }
1936
1937         if (tape->chrdev_dir == IDETAPE_DIR_READ) {
1938                 tape->merge_bh_size = 0;
1939                 if (test_and_clear_bit(IDETAPE_FLAG_FILEMARK, &tape->flags))
1940                         ++count;
1941                 ide_tape_discard_merge_buffer(drive, 0);
1942         }
1943
1944         switch (mt_op) {
1945         case MTFSF:
1946         case MTBSF:
1947                 idetape_create_space_cmd(&pc, mt_count - count,
1948                                          IDETAPE_SPACE_OVER_FILEMARK);
1949                 return idetape_queue_pc_tail(drive, &pc);
1950         case MTFSFM:
1951         case MTBSFM:
1952                 if (!sprev)
1953                         return -EIO;
1954                 retval = idetape_space_over_filemarks(drive, MTFSF,
1955                                                       mt_count - count);
1956                 if (retval)
1957                         return retval;
1958                 count = (MTBSFM == mt_op ? 1 : -1);
1959                 return idetape_space_over_filemarks(drive, MTFSF, count);
1960         default:
1961                 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
1962                                 mt_op);
1963                 return -EIO;
1964         }
1965 }
1966
1967 /*
1968  * Our character device read / write functions.
1969  *
1970  * The tape is optimized to maximize throughput when it is transferring an
1971  * integral number of the "continuous transfer limit", which is a parameter of
1972  * the specific tape (26kB on my particular tape, 32kB for Onstream).
1973  *
1974  * As of version 1.3 of the driver, the character device provides an abstract
1975  * continuous view of the media - any mix of block sizes (even 1 byte) on the
1976  * same backup/restore procedure is supported. The driver will internally
1977  * convert the requests to the recommended transfer unit, so that an unmatch
1978  * between the user's block size to the recommended size will only result in a
1979  * (slightly) increased driver overhead, but will no longer hit performance.
1980  * This is not applicable to Onstream.
1981  */
1982 static ssize_t idetape_chrdev_read(struct file *file, char __user *buf,
1983                                    size_t count, loff_t *ppos)
1984 {
1985         struct ide_tape_obj *tape = ide_tape_f(file);
1986         ide_drive_t *drive = tape->drive;
1987         ssize_t bytes_read, temp, actually_read = 0, rc;
1988         ssize_t ret = 0;
1989         u16 ctl = *(u16 *)&tape->caps[12];
1990
1991         debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
1992
1993         if (tape->chrdev_dir != IDETAPE_DIR_READ) {
1994                 if (test_bit(IDETAPE_FLAG_DETECT_BS, &tape->flags))
1995                         if (count > tape->blk_size &&
1996                             (count % tape->blk_size) == 0)
1997                                 tape->user_bs_factor = count / tape->blk_size;
1998         }
1999         rc = idetape_init_read(drive);
2000         if (rc < 0)
2001                 return rc;
2002         if (count == 0)
2003                 return (0);
2004         if (tape->merge_bh_size) {
2005                 actually_read = min((unsigned int)(tape->merge_bh_size),
2006                                     (unsigned int)count);
2007                 if (idetape_copy_stage_to_user(tape, buf, actually_read))
2008                         ret = -EFAULT;
2009                 buf += actually_read;
2010                 tape->merge_bh_size -= actually_read;
2011                 count -= actually_read;
2012         }
2013         while (count >= tape->buffer_size) {
2014                 bytes_read = idetape_add_chrdev_read_request(drive, ctl);
2015                 if (bytes_read <= 0)
2016                         goto finish;
2017                 if (idetape_copy_stage_to_user(tape, buf, bytes_read))
2018                         ret = -EFAULT;
2019                 buf += bytes_read;
2020                 count -= bytes_read;
2021                 actually_read += bytes_read;
2022         }
2023         if (count) {
2024                 bytes_read = idetape_add_chrdev_read_request(drive, ctl);
2025                 if (bytes_read <= 0)
2026                         goto finish;
2027                 temp = min((unsigned long)count, (unsigned long)bytes_read);
2028                 if (idetape_copy_stage_to_user(tape, buf, temp))
2029                         ret = -EFAULT;
2030                 actually_read += temp;
2031                 tape->merge_bh_size = bytes_read-temp;
2032         }
2033 finish:
2034         if (!actually_read && test_bit(IDETAPE_FLAG_FILEMARK, &tape->flags)) {
2035                 debug_log(DBG_SENSE, "%s: spacing over filemark\n", tape->name);
2036
2037                 idetape_space_over_filemarks(drive, MTFSF, 1);
2038                 return 0;
2039         }
2040
2041         return ret ? ret : actually_read;
2042 }
2043
2044 static ssize_t idetape_chrdev_write(struct file *file, const char __user *buf,
2045                                      size_t count, loff_t *ppos)
2046 {
2047         struct ide_tape_obj *tape = ide_tape_f(file);
2048         ide_drive_t *drive = tape->drive;
2049         ssize_t actually_written = 0;
2050         ssize_t ret = 0;
2051         u16 ctl = *(u16 *)&tape->caps[12];
2052
2053         /* The drive is write protected. */
2054         if (tape->write_prot)
2055                 return -EACCES;
2056
2057         debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
2058
2059         /* Initialize write operation */
2060         if (tape->chrdev_dir != IDETAPE_DIR_WRITE) {
2061                 if (tape->chrdev_dir == IDETAPE_DIR_READ)
2062                         ide_tape_discard_merge_buffer(drive, 1);
2063                 if (tape->merge_bh || tape->merge_bh_size) {
2064                         printk(KERN_ERR "ide-tape: merge_bh_size "
2065                                 "should be 0 now\n");
2066                         tape->merge_bh_size = 0;
2067                 }
2068                 tape->merge_bh = ide_tape_kmalloc_buffer(tape, 0, 0);
2069                 if (!tape->merge_bh)
2070                         return -ENOMEM;
2071                 tape->chrdev_dir = IDETAPE_DIR_WRITE;
2072                 idetape_init_merge_buffer(tape);
2073
2074                 /*
2075                  * Issue a write 0 command to ensure that DSC handshake is
2076                  * switched from completion mode to buffer available mode. No
2077                  * point in issuing this if DSC overlap isn't supported, some
2078                  * drives (Seagate STT3401A) will return an error.
2079                  */
2080                 if (drive->dsc_overlap) {
2081                         ssize_t retval = idetape_queue_rw_tail(drive,
2082                                                         REQ_IDETAPE_WRITE, 0,
2083                                                         tape->merge_bh);
2084                         if (retval < 0) {
2085                                 ide_tape_kfree_buffer(tape);
2086                                 tape->merge_bh = NULL;
2087                                 tape->chrdev_dir = IDETAPE_DIR_NONE;
2088                                 return retval;
2089                         }
2090                 }
2091         }
2092         if (count == 0)
2093                 return (0);
2094         if (tape->merge_bh_size) {
2095                 if (tape->merge_bh_size >= tape->buffer_size) {
2096                         printk(KERN_ERR "ide-tape: bug: merge buf too big\n");
2097                         tape->merge_bh_size = 0;
2098                 }
2099                 actually_written = min((unsigned int)
2100                                 (tape->buffer_size - tape->merge_bh_size),
2101                                 (unsigned int)count);
2102                 if (idetape_copy_stage_from_user(tape, buf, actually_written))
2103                                 ret = -EFAULT;
2104                 buf += actually_written;
2105                 tape->merge_bh_size += actually_written;
2106                 count -= actually_written;
2107
2108                 if (tape->merge_bh_size == tape->buffer_size) {
2109                         ssize_t retval;
2110                         tape->merge_bh_size = 0;
2111                         retval = idetape_add_chrdev_write_request(drive, ctl);
2112                         if (retval <= 0)
2113                                 return (retval);
2114                 }
2115         }
2116         while (count >= tape->buffer_size) {
2117                 ssize_t retval;
2118                 if (idetape_copy_stage_from_user(tape, buf, tape->buffer_size))
2119                         ret = -EFAULT;
2120                 buf += tape->buffer_size;
2121                 count -= tape->buffer_size;
2122                 retval = idetape_add_chrdev_write_request(drive, ctl);
2123                 actually_written += tape->buffer_size;
2124                 if (retval <= 0)
2125                         return (retval);
2126         }
2127         if (count) {
2128                 actually_written += count;
2129                 if (idetape_copy_stage_from_user(tape, buf, count))
2130                         ret = -EFAULT;
2131                 tape->merge_bh_size += count;
2132         }
2133         return ret ? ret : actually_written;
2134 }
2135
2136 static int idetape_write_filemark(ide_drive_t *drive)
2137 {
2138         struct ide_atapi_pc pc;
2139
2140         /* Write a filemark */
2141         idetape_create_write_filemark_cmd(drive, &pc, 1);
2142         if (idetape_queue_pc_tail(drive, &pc)) {
2143                 printk(KERN_ERR "ide-tape: Couldn't write a filemark\n");
2144                 return -EIO;
2145         }
2146         return 0;
2147 }
2148
2149 /*
2150  * Called from idetape_chrdev_ioctl when the general mtio MTIOCTOP ioctl is
2151  * requested.
2152  *
2153  * Note: MTBSF and MTBSFM are not supported when the tape doesn't support
2154  * spacing over filemarks in the reverse direction. In this case, MTFSFM is also
2155  * usually not supported.
2156  *
2157  * The following commands are currently not supported:
2158  *
2159  * MTFSS, MTBSS, MTWSM, MTSETDENSITY, MTSETDRVBUFFER, MT_ST_BOOLEANS,
2160  * MT_ST_WRITE_THRESHOLD.
2161  */
2162 static int idetape_mtioctop(ide_drive_t *drive, short mt_op, int mt_count)
2163 {
2164         idetape_tape_t *tape = drive->driver_data;
2165         struct ide_atapi_pc pc;
2166         int i, retval;
2167
2168         debug_log(DBG_ERR, "Handling MTIOCTOP ioctl: mt_op=%d, mt_count=%d\n",
2169                         mt_op, mt_count);
2170
2171         switch (mt_op) {
2172         case MTFSF:
2173         case MTFSFM:
2174         case MTBSF:
2175         case MTBSFM:
2176                 if (!mt_count)
2177                         return 0;
2178                 return idetape_space_over_filemarks(drive, mt_op, mt_count);
2179         default:
2180                 break;
2181         }
2182
2183         switch (mt_op) {
2184         case MTWEOF:
2185                 if (tape->write_prot)
2186                         return -EACCES;
2187                 ide_tape_discard_merge_buffer(drive, 1);
2188                 for (i = 0; i < mt_count; i++) {
2189                         retval = idetape_write_filemark(drive);
2190                         if (retval)
2191                                 return retval;
2192                 }
2193                 return 0;
2194         case MTREW:
2195                 ide_tape_discard_merge_buffer(drive, 0);
2196                 if (idetape_rewind_tape(drive))
2197                         return -EIO;
2198                 return 0;
2199         case MTLOAD:
2200                 ide_tape_discard_merge_buffer(drive, 0);
2201                 idetape_create_load_unload_cmd(drive, &pc,
2202                                                IDETAPE_LU_LOAD_MASK);
2203                 return idetape_queue_pc_tail(drive, &pc);
2204         case MTUNLOAD:
2205         case MTOFFL:
2206                 /*
2207                  * If door is locked, attempt to unlock before
2208                  * attempting to eject.
2209                  */
2210                 if (tape->door_locked) {
2211                         if (idetape_create_prevent_cmd(drive, &pc, 0))
2212                                 if (!idetape_queue_pc_tail(drive, &pc))
2213                                         tape->door_locked = DOOR_UNLOCKED;
2214                 }
2215                 ide_tape_discard_merge_buffer(drive, 0);
2216                 idetape_create_load_unload_cmd(drive, &pc,
2217                                               !IDETAPE_LU_LOAD_MASK);
2218                 retval = idetape_queue_pc_tail(drive, &pc);
2219                 if (!retval)
2220                         clear_bit(IDETAPE_FLAG_MEDIUM_PRESENT, &tape->flags);
2221                 return retval;
2222         case MTNOP:
2223                 ide_tape_discard_merge_buffer(drive, 0);
2224                 return idetape_flush_tape_buffers(drive);
2225         case MTRETEN:
2226                 ide_tape_discard_merge_buffer(drive, 0);
2227                 idetape_create_load_unload_cmd(drive, &pc,
2228                         IDETAPE_LU_RETENSION_MASK | IDETAPE_LU_LOAD_MASK);
2229                 return idetape_queue_pc_tail(drive, &pc);
2230         case MTEOM:
2231                 idetape_create_space_cmd(&pc, 0, IDETAPE_SPACE_TO_EOD);
2232                 return idetape_queue_pc_tail(drive, &pc);
2233         case MTERASE:
2234                 (void)idetape_rewind_tape(drive);
2235                 idetape_create_erase_cmd(&pc);
2236                 return idetape_queue_pc_tail(drive, &pc);
2237         case MTSETBLK:
2238                 if (mt_count) {
2239                         if (mt_count < tape->blk_size ||
2240                             mt_count % tape->blk_size)
2241                                 return -EIO;
2242                         tape->user_bs_factor = mt_count / tape->blk_size;
2243                         clear_bit(IDETAPE_FLAG_DETECT_BS, &tape->flags);
2244                 } else
2245                         set_bit(IDETAPE_FLAG_DETECT_BS, &tape->flags);
2246                 return 0;
2247         case MTSEEK:
2248                 ide_tape_discard_merge_buffer(drive, 0);
2249                 return idetape_position_tape(drive,
2250                         mt_count * tape->user_bs_factor, tape->partition, 0);
2251         case MTSETPART:
2252                 ide_tape_discard_merge_buffer(drive, 0);
2253                 return idetape_position_tape(drive, 0, mt_count, 0);
2254         case MTFSR:
2255         case MTBSR:
2256         case MTLOCK:
2257                 if (!idetape_create_prevent_cmd(drive, &pc, 1))
2258                         return 0;
2259                 retval = idetape_queue_pc_tail(drive, &pc);
2260                 if (retval)
2261                         return retval;
2262                 tape->door_locked = DOOR_EXPLICITLY_LOCKED;
2263                 return 0;
2264         case MTUNLOCK:
2265                 if (!idetape_create_prevent_cmd(drive, &pc, 0))
2266                         return 0;
2267                 retval = idetape_queue_pc_tail(drive, &pc);
2268                 if (retval)
2269                         return retval;
2270                 tape->door_locked = DOOR_UNLOCKED;
2271                 return 0;
2272         default:
2273                 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
2274                                 mt_op);
2275                 return -EIO;
2276         }
2277 }
2278
2279 /*
2280  * Our character device ioctls. General mtio.h magnetic io commands are
2281  * supported here, and not in the corresponding block interface. Our own
2282  * ide-tape ioctls are supported on both interfaces.
2283  */
2284 static int idetape_chrdev_ioctl(struct inode *inode, struct file *file,
2285                                 unsigned int cmd, unsigned long arg)
2286 {
2287         struct ide_tape_obj *tape = ide_tape_f(file);
2288         ide_drive_t *drive = tape->drive;
2289         struct mtop mtop;
2290         struct mtget mtget;
2291         struct mtpos mtpos;
2292         int block_offset = 0, position = tape->first_frame;
2293         void __user *argp = (void __user *)arg;
2294
2295         debug_log(DBG_CHRDEV, "Enter %s, cmd=%u\n", __func__, cmd);
2296
2297         if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
2298                 ide_tape_flush_merge_buffer(drive);
2299                 idetape_flush_tape_buffers(drive);
2300         }
2301         if (cmd == MTIOCGET || cmd == MTIOCPOS) {
2302                 block_offset = tape->merge_bh_size /
2303                         (tape->blk_size * tape->user_bs_factor);
2304                 position = idetape_read_position(drive);
2305                 if (position < 0)
2306                         return -EIO;
2307         }
2308         switch (cmd) {
2309         case MTIOCTOP:
2310                 if (copy_from_user(&mtop, argp, sizeof(struct mtop)))
2311                         return -EFAULT;
2312                 return idetape_mtioctop(drive, mtop.mt_op, mtop.mt_count);
2313         case MTIOCGET:
2314                 memset(&mtget, 0, sizeof(struct mtget));
2315                 mtget.mt_type = MT_ISSCSI2;
2316                 mtget.mt_blkno = position / tape->user_bs_factor - block_offset;
2317                 mtget.mt_dsreg =
2318                         ((tape->blk_size * tape->user_bs_factor)
2319                          << MT_ST_BLKSIZE_SHIFT) & MT_ST_BLKSIZE_MASK;
2320
2321                 if (tape->drv_write_prot)
2322                         mtget.mt_gstat |= GMT_WR_PROT(0xffffffff);
2323
2324                 if (copy_to_user(argp, &mtget, sizeof(struct mtget)))
2325                         return -EFAULT;
2326                 return 0;
2327         case MTIOCPOS:
2328                 mtpos.mt_blkno = position / tape->user_bs_factor - block_offset;
2329                 if (copy_to_user(argp, &mtpos, sizeof(struct mtpos)))
2330                         return -EFAULT;
2331                 return 0;
2332         default:
2333                 if (tape->chrdev_dir == IDETAPE_DIR_READ)
2334                         ide_tape_discard_merge_buffer(drive, 1);
2335                 return idetape_blkdev_ioctl(drive, cmd, arg);
2336         }
2337 }
2338
2339 /*
2340  * Do a mode sense page 0 with block descriptor and if it succeeds set the tape
2341  * block size with the reported value.
2342  */
2343 static void ide_tape_get_bsize_from_bdesc(ide_drive_t *drive)
2344 {
2345         idetape_tape_t *tape = drive->driver_data;
2346         struct ide_atapi_pc pc;
2347
2348         idetape_create_mode_sense_cmd(&pc, IDETAPE_BLOCK_DESCRIPTOR);
2349         if (idetape_queue_pc_tail(drive, &pc)) {
2350                 printk(KERN_ERR "ide-tape: Can't get block descriptor\n");
2351                 if (tape->blk_size == 0) {
2352                         printk(KERN_WARNING "ide-tape: Cannot deal with zero "
2353                                             "block size, assuming 32k\n");
2354                         tape->blk_size = 32768;
2355                 }
2356                 return;
2357         }
2358         tape->blk_size = (pc.buf[4 + 5] << 16) +
2359                                 (pc.buf[4 + 6] << 8)  +
2360                                  pc.buf[4 + 7];
2361         tape->drv_write_prot = (pc.buf[2] & 0x80) >> 7;
2362 }
2363
2364 static int idetape_chrdev_open(struct inode *inode, struct file *filp)
2365 {
2366         unsigned int minor = iminor(inode), i = minor & ~0xc0;
2367         ide_drive_t *drive;
2368         idetape_tape_t *tape;
2369         struct ide_atapi_pc pc;
2370         int retval;
2371
2372         if (i >= MAX_HWIFS * MAX_DRIVES)
2373                 return -ENXIO;
2374
2375         tape = ide_tape_chrdev_get(i);
2376         if (!tape)
2377                 return -ENXIO;
2378
2379         debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
2380
2381         /*
2382          * We really want to do nonseekable_open(inode, filp); here, but some
2383          * versions of tar incorrectly call lseek on tapes and bail out if that
2384          * fails.  So we disallow pread() and pwrite(), but permit lseeks.
2385          */
2386         filp->f_mode &= ~(FMODE_PREAD | FMODE_PWRITE);
2387
2388         drive = tape->drive;
2389
2390         filp->private_data = tape;
2391
2392         if (test_and_set_bit(IDETAPE_FLAG_BUSY, &tape->flags)) {
2393                 retval = -EBUSY;
2394                 goto out_put_tape;
2395         }
2396
2397         retval = idetape_wait_ready(drive, 60 * HZ);
2398         if (retval) {
2399                 clear_bit(IDETAPE_FLAG_BUSY, &tape->flags);
2400                 printk(KERN_ERR "ide-tape: %s: drive not ready\n", tape->name);
2401                 goto out_put_tape;
2402         }
2403
2404         idetape_read_position(drive);
2405         if (!test_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags))
2406                 (void)idetape_rewind_tape(drive);
2407
2408         /* Read block size and write protect status from drive. */
2409         ide_tape_get_bsize_from_bdesc(drive);
2410
2411         /* Set write protect flag if device is opened as read-only. */
2412         if ((filp->f_flags & O_ACCMODE) == O_RDONLY)
2413                 tape->write_prot = 1;
2414         else
2415                 tape->write_prot = tape->drv_write_prot;
2416
2417         /* Make sure drive isn't write protected if user wants to write. */
2418         if (tape->write_prot) {
2419                 if ((filp->f_flags & O_ACCMODE) == O_WRONLY ||
2420                     (filp->f_flags & O_ACCMODE) == O_RDWR) {
2421                         clear_bit(IDETAPE_FLAG_BUSY, &tape->flags);
2422                         retval = -EROFS;
2423                         goto out_put_tape;
2424                 }
2425         }
2426
2427         /* Lock the tape drive door so user can't eject. */
2428         if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
2429                 if (idetape_create_prevent_cmd(drive, &pc, 1)) {
2430                         if (!idetape_queue_pc_tail(drive, &pc)) {
2431                                 if (tape->door_locked != DOOR_EXPLICITLY_LOCKED)
2432                                         tape->door_locked = DOOR_LOCKED;
2433                         }
2434                 }
2435         }
2436         return 0;
2437
2438 out_put_tape:
2439         ide_tape_put(tape);
2440         return retval;
2441 }
2442
2443 static void idetape_write_release(ide_drive_t *drive, unsigned int minor)
2444 {
2445         idetape_tape_t *tape = drive->driver_data;
2446
2447         ide_tape_flush_merge_buffer(drive);
2448         tape->merge_bh = ide_tape_kmalloc_buffer(tape, 1, 0);
2449         if (tape->merge_bh != NULL) {
2450                 idetape_pad_zeros(drive, tape->blk_size *
2451                                 (tape->user_bs_factor - 1));
2452                 ide_tape_kfree_buffer(tape);
2453                 tape->merge_bh = NULL;
2454         }
2455         idetape_write_filemark(drive);
2456         idetape_flush_tape_buffers(drive);
2457         idetape_flush_tape_buffers(drive);
2458 }
2459
2460 static int idetape_chrdev_release(struct inode *inode, struct file *filp)
2461 {
2462         struct ide_tape_obj *tape = ide_tape_f(filp);
2463         ide_drive_t *drive = tape->drive;
2464         struct ide_atapi_pc pc;
2465         unsigned int minor = iminor(inode);
2466
2467         lock_kernel();
2468         tape = drive->driver_data;
2469
2470         debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
2471
2472         if (tape->chrdev_dir == IDETAPE_DIR_WRITE)
2473                 idetape_write_release(drive, minor);
2474         if (tape->chrdev_dir == IDETAPE_DIR_READ) {
2475                 if (minor < 128)
2476                         ide_tape_discard_merge_buffer(drive, 1);
2477         }
2478
2479         if (minor < 128 && test_bit(IDETAPE_FLAG_MEDIUM_PRESENT, &tape->flags))
2480                 (void) idetape_rewind_tape(drive);
2481         if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
2482                 if (tape->door_locked == DOOR_LOCKED) {
2483                         if (idetape_create_prevent_cmd(drive, &pc, 0)) {
2484                                 if (!idetape_queue_pc_tail(drive, &pc))
2485                                         tape->door_locked = DOOR_UNLOCKED;
2486                         }
2487                 }
2488         }
2489         clear_bit(IDETAPE_FLAG_BUSY, &tape->flags);
2490         ide_tape_put(tape);
2491         unlock_kernel();
2492         return 0;
2493 }
2494
2495 /*
2496  * check the contents of the ATAPI IDENTIFY command results. We return:
2497  *
2498  * 1 - If the tape can be supported by us, based on the information we have so
2499  * far.
2500  *
2501  * 0 - If this tape driver is not currently supported by us.
2502  */
2503 static int idetape_identify_device(ide_drive_t *drive)
2504 {
2505         u8 gcw[2], protocol, device_type, removable, packet_size;
2506
2507         if (drive->id_read == 0)
2508                 return 1;
2509
2510         *((unsigned short *) &gcw) = drive->id->config;
2511
2512         protocol        =   (gcw[1] & 0xC0) >> 6;
2513         device_type     =    gcw[1] & 0x1F;
2514         removable       = !!(gcw[0] & 0x80);
2515         packet_size     =    gcw[0] & 0x3;
2516
2517         /* Check that we can support this device */
2518         if (protocol != 2)
2519                 printk(KERN_ERR "ide-tape: Protocol (0x%02x) is not ATAPI\n",
2520                                 protocol);
2521         else if (device_type != 1)
2522                 printk(KERN_ERR "ide-tape: Device type (0x%02x) is not set "
2523                                 "to tape\n", device_type);
2524         else if (!removable)
2525                 printk(KERN_ERR "ide-tape: The removable flag is not set\n");
2526         else if (packet_size != 0) {
2527                 printk(KERN_ERR "ide-tape: Packet size (0x%02x) is not 12"
2528                                 " bytes\n", packet_size);
2529         } else
2530                 return 1;
2531         return 0;
2532 }
2533
2534 static void idetape_get_inquiry_results(ide_drive_t *drive)
2535 {
2536         idetape_tape_t *tape = drive->driver_data;
2537         struct ide_atapi_pc pc;
2538         char fw_rev[6], vendor_id[10], product_id[18];
2539
2540         idetape_create_inquiry_cmd(&pc);
2541         if (idetape_queue_pc_tail(drive, &pc)) {
2542                 printk(KERN_ERR "ide-tape: %s: can't get INQUIRY results\n",
2543                                 tape->name);
2544                 return;
2545         }
2546         memcpy(vendor_id, &pc.buf[8], 8);
2547         memcpy(product_id, &pc.buf[16], 16);
2548         memcpy(fw_rev, &pc.buf[32], 4);
2549
2550         ide_fixstring(vendor_id, 10, 0);
2551         ide_fixstring(product_id, 18, 0);
2552         ide_fixstring(fw_rev, 6, 0);
2553
2554         printk(KERN_INFO "ide-tape: %s <-> %s: %s %s rev %s\n",
2555                         drive->name, tape->name, vendor_id, product_id, fw_rev);
2556 }
2557
2558 /*
2559  * Ask the tape about its various parameters. In particular, we will adjust our
2560  * data transfer buffer size to the recommended value as returned by the tape.
2561  */
2562 static void idetape_get_mode_sense_results(ide_drive_t *drive)
2563 {
2564         idetape_tape_t *tape = drive->driver_data;
2565         struct ide_atapi_pc pc;
2566         u8 *caps;
2567         u8 speed, max_speed;
2568
2569         idetape_create_mode_sense_cmd(&pc, IDETAPE_CAPABILITIES_PAGE);
2570         if (idetape_queue_pc_tail(drive, &pc)) {
2571                 printk(KERN_ERR "ide-tape: Can't get tape parameters - assuming"
2572                                 " some default values\n");
2573                 tape->blk_size = 512;
2574                 put_unaligned(52,   (u16 *)&tape->caps[12]);
2575                 put_unaligned(540,  (u16 *)&tape->caps[14]);
2576                 put_unaligned(6*52, (u16 *)&tape->caps[16]);
2577                 return;
2578         }
2579         caps = pc.buf + 4 + pc.buf[3];
2580
2581         /* convert to host order and save for later use */
2582         speed = be16_to_cpu(*(u16 *)&caps[14]);
2583         max_speed = be16_to_cpu(*(u16 *)&caps[8]);
2584
2585         put_unaligned(max_speed, (u16 *)&caps[8]);
2586         put_unaligned(be16_to_cpu(*(u16 *)&caps[12]), (u16 *)&caps[12]);
2587         put_unaligned(speed, (u16 *)&caps[14]);
2588         put_unaligned(be16_to_cpu(*(u16 *)&caps[16]), (u16 *)&caps[16]);
2589
2590         if (!speed) {
2591                 printk(KERN_INFO "ide-tape: %s: invalid tape speed "
2592                                 "(assuming 650KB/sec)\n", drive->name);
2593                 put_unaligned(650, (u16 *)&caps[14]);
2594         }
2595         if (!max_speed) {
2596                 printk(KERN_INFO "ide-tape: %s: invalid max_speed "
2597                                 "(assuming 650KB/sec)\n", drive->name);
2598                 put_unaligned(650, (u16 *)&caps[8]);
2599         }
2600
2601         memcpy(&tape->caps, caps, 20);
2602         if (caps[7] & 0x02)
2603                 tape->blk_size = 512;
2604         else if (caps[7] & 0x04)
2605                 tape->blk_size = 1024;
2606 }
2607
2608 #ifdef CONFIG_IDE_PROC_FS
2609 static void idetape_add_settings(ide_drive_t *drive)
2610 {
2611         idetape_tape_t *tape = drive->driver_data;
2612
2613         ide_add_setting(drive, "buffer", SETTING_READ, TYPE_SHORT, 0, 0xffff,
2614                         1, 2, (u16 *)&tape->caps[16], NULL);
2615         ide_add_setting(drive, "speed", SETTING_READ, TYPE_SHORT, 0, 0xffff,
2616                         1, 1, (u16 *)&tape->caps[14], NULL);
2617         ide_add_setting(drive, "buffer_size", SETTING_READ, TYPE_INT, 0, 0xffff,
2618                         1, 1024, &tape->buffer_size, NULL);
2619         ide_add_setting(drive, "tdsc", SETTING_RW, TYPE_INT, IDETAPE_DSC_RW_MIN,
2620                         IDETAPE_DSC_RW_MAX, 1000, HZ, &tape->best_dsc_rw_freq,
2621                         NULL);
2622         ide_add_setting(drive, "dsc_overlap", SETTING_RW, TYPE_BYTE, 0, 1, 1,
2623                         1, &drive->dsc_overlap, NULL);
2624         ide_add_setting(drive, "avg_speed", SETTING_READ, TYPE_INT, 0, 0xffff,
2625                         1, 1, &tape->avg_speed, NULL);
2626         ide_add_setting(drive, "debug_mask", SETTING_RW, TYPE_INT, 0, 0xffff, 1,
2627                         1, &tape->debug_mask, NULL);
2628 }
2629 #else
2630 static inline void idetape_add_settings(ide_drive_t *drive) { ; }
2631 #endif
2632
2633 /*
2634  * The function below is called to:
2635  *
2636  * 1. Initialize our various state variables.
2637  * 2. Ask the tape for its capabilities.
2638  * 3. Allocate a buffer which will be used for data transfer. The buffer size
2639  * is chosen based on the recommendation which we received in step 2.
2640  *
2641  * Note that at this point ide.c already assigned us an irq, so that we can
2642  * queue requests here and wait for their completion.
2643  */
2644 static void idetape_setup(ide_drive_t *drive, idetape_tape_t *tape, int minor)
2645 {
2646         unsigned long t;
2647         int speed;
2648         int buffer_size;
2649         u8 gcw[2];
2650         u16 *ctl = (u16 *)&tape->caps[12];
2651
2652         spin_lock_init(&tape->lock);
2653         drive->dsc_overlap = 1;
2654         if (drive->hwif->host_flags & IDE_HFLAG_NO_DSC) {
2655                 printk(KERN_INFO "ide-tape: %s: disabling DSC overlap\n",
2656                                  tape->name);
2657                 drive->dsc_overlap = 0;
2658         }
2659         /* Seagate Travan drives do not support DSC overlap. */
2660         if (strstr(drive->id->model, "Seagate STT3401"))
2661                 drive->dsc_overlap = 0;
2662         tape->minor = minor;
2663         tape->name[0] = 'h';
2664         tape->name[1] = 't';
2665         tape->name[2] = '0' + minor;
2666         tape->chrdev_dir = IDETAPE_DIR_NONE;
2667         tape->pc = tape->pc_stack;
2668         *((unsigned short *) &gcw) = drive->id->config;
2669
2670         /* Command packet DRQ type */
2671         if (((gcw[0] & 0x60) >> 5) == 1)
2672                 set_bit(IDETAPE_FLAG_DRQ_INTERRUPT, &tape->flags);
2673
2674         idetape_get_inquiry_results(drive);
2675         idetape_get_mode_sense_results(drive);
2676         ide_tape_get_bsize_from_bdesc(drive);
2677         tape->user_bs_factor = 1;
2678         tape->buffer_size = *ctl * tape->blk_size;
2679         while (tape->buffer_size > 0xffff) {
2680                 printk(KERN_NOTICE "ide-tape: decreasing stage size\n");
2681                 *ctl /= 2;
2682                 tape->buffer_size = *ctl * tape->blk_size;
2683         }
2684         buffer_size = tape->buffer_size;
2685         tape->pages_per_buffer = buffer_size / PAGE_SIZE;
2686         if (buffer_size % PAGE_SIZE) {
2687                 tape->pages_per_buffer++;
2688                 tape->excess_bh_size = PAGE_SIZE - buffer_size % PAGE_SIZE;
2689         }
2690
2691         /* select the "best" DSC read/write polling freq */
2692         speed = max(*(u16 *)&tape->caps[14], *(u16 *)&tape->caps[8]);
2693
2694         t = (IDETAPE_FIFO_THRESHOLD * tape->buffer_size * HZ) / (speed * 1000);
2695
2696         /*
2697          * Ensure that the number we got makes sense; limit it within
2698          * IDETAPE_DSC_RW_MIN and IDETAPE_DSC_RW_MAX.
2699          */
2700         tape->best_dsc_rw_freq = clamp_t(unsigned long, t, IDETAPE_DSC_RW_MIN,
2701                                          IDETAPE_DSC_RW_MAX);
2702         printk(KERN_INFO "ide-tape: %s <-> %s: %dKBps, %d*%dkB buffer, "
2703                 "%lums tDSC%s\n",
2704                 drive->name, tape->name, *(u16 *)&tape->caps[14],
2705                 (*(u16 *)&tape->caps[16] * 512) / tape->buffer_size,
2706                 tape->buffer_size / 1024,
2707                 tape->best_dsc_rw_freq * 1000 / HZ,
2708                 drive->using_dma ? ", DMA":"");
2709
2710         idetape_add_settings(drive);
2711 }
2712
2713 static void ide_tape_remove(ide_drive_t *drive)
2714 {
2715         idetape_tape_t *tape = drive->driver_data;
2716
2717         ide_proc_unregister_driver(drive, tape->driver);
2718
2719         ide_unregister_region(tape->disk);
2720
2721         ide_tape_put(tape);
2722 }
2723
2724 static void ide_tape_release(struct kref *kref)
2725 {
2726         struct ide_tape_obj *tape = to_ide_tape(kref);
2727         ide_drive_t *drive = tape->drive;
2728         struct gendisk *g = tape->disk;
2729
2730         BUG_ON(tape->merge_bh_size);
2731
2732         drive->dsc_overlap = 0;
2733         drive->driver_data = NULL;
2734         device_destroy(idetape_sysfs_class, MKDEV(IDETAPE_MAJOR, tape->minor));
2735         device_destroy(idetape_sysfs_class,
2736                         MKDEV(IDETAPE_MAJOR, tape->minor + 128));
2737         idetape_devs[tape->minor] = NULL;
2738         g->private_data = NULL;
2739         put_disk(g);
2740         kfree(tape);
2741 }
2742
2743 #ifdef CONFIG_IDE_PROC_FS
2744 static int proc_idetape_read_name
2745         (char *page, char **start, off_t off, int count, int *eof, void *data)
2746 {
2747         ide_drive_t     *drive = (ide_drive_t *) data;
2748         idetape_tape_t  *tape = drive->driver_data;
2749         char            *out = page;
2750         int             len;
2751
2752         len = sprintf(out, "%s\n", tape->name);
2753         PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
2754 }
2755
2756 static ide_proc_entry_t idetape_proc[] = {
2757         { "capacity",   S_IFREG|S_IRUGO,        proc_ide_read_capacity, NULL },
2758         { "name",       S_IFREG|S_IRUGO,        proc_idetape_read_name, NULL },
2759         { NULL, 0, NULL, NULL }
2760 };
2761 #endif
2762
2763 static int ide_tape_probe(ide_drive_t *);
2764
2765 static ide_driver_t idetape_driver = {
2766         .gen_driver = {
2767                 .owner          = THIS_MODULE,
2768                 .name           = "ide-tape",
2769                 .bus            = &ide_bus_type,
2770         },
2771         .probe                  = ide_tape_probe,
2772         .remove                 = ide_tape_remove,
2773         .version                = IDETAPE_VERSION,
2774         .media                  = ide_tape,
2775         .supports_dsc_overlap   = 1,
2776         .do_request             = idetape_do_request,
2777         .end_request            = idetape_end_request,
2778         .error                  = __ide_error,
2779         .abort                  = __ide_abort,
2780 #ifdef CONFIG_IDE_PROC_FS
2781         .proc                   = idetape_proc,
2782 #endif
2783 };
2784
2785 /* Our character device supporting functions, passed to register_chrdev. */
2786 static const struct file_operations idetape_fops = {
2787         .owner          = THIS_MODULE,
2788         .read           = idetape_chrdev_read,
2789         .write          = idetape_chrdev_write,
2790         .ioctl          = idetape_chrdev_ioctl,
2791         .open           = idetape_chrdev_open,
2792         .release        = idetape_chrdev_release,
2793 };
2794
2795 static int idetape_open(struct inode *inode, struct file *filp)
2796 {
2797         struct gendisk *disk = inode->i_bdev->bd_disk;
2798         struct ide_tape_obj *tape;
2799
2800         tape = ide_tape_get(disk);
2801         if (!tape)
2802                 return -ENXIO;
2803
2804         return 0;
2805 }
2806
2807 static int idetape_release(struct inode *inode, struct file *filp)
2808 {
2809         struct gendisk *disk = inode->i_bdev->bd_disk;
2810         struct ide_tape_obj *tape = ide_tape_g(disk);
2811
2812         ide_tape_put(tape);
2813
2814         return 0;
2815 }
2816
2817 static int idetape_ioctl(struct inode *inode, struct file *file,
2818                         unsigned int cmd, unsigned long arg)
2819 {
2820         struct block_device *bdev = inode->i_bdev;
2821         struct ide_tape_obj *tape = ide_tape_g(bdev->bd_disk);
2822         ide_drive_t *drive = tape->drive;
2823         int err = generic_ide_ioctl(drive, file, bdev, cmd, arg);
2824         if (err == -EINVAL)
2825                 err = idetape_blkdev_ioctl(drive, cmd, arg);
2826         return err;
2827 }
2828
2829 static struct block_device_operations idetape_block_ops = {
2830         .owner          = THIS_MODULE,
2831         .open           = idetape_open,
2832         .release        = idetape_release,
2833         .ioctl          = idetape_ioctl,
2834 };
2835
2836 static int ide_tape_probe(ide_drive_t *drive)
2837 {
2838         idetape_tape_t *tape;
2839         struct gendisk *g;
2840         int minor;
2841
2842         if (!strstr("ide-tape", drive->driver_req))
2843                 goto failed;
2844         if (!drive->present)
2845                 goto failed;
2846         if (drive->media != ide_tape)
2847                 goto failed;
2848         if (!idetape_identify_device(drive)) {
2849                 printk(KERN_ERR "ide-tape: %s: not supported by this version of"
2850                                 " the driver\n", drive->name);
2851                 goto failed;
2852         }
2853         tape = kzalloc(sizeof(idetape_tape_t), GFP_KERNEL);
2854         if (tape == NULL) {
2855                 printk(KERN_ERR "ide-tape: %s: Can't allocate a tape struct\n",
2856                                 drive->name);
2857                 goto failed;
2858         }
2859
2860         g = alloc_disk(1 << PARTN_BITS);
2861         if (!g)
2862                 goto out_free_tape;
2863
2864         ide_init_disk(g, drive);
2865
2866         ide_proc_register_driver(drive, &idetape_driver);
2867
2868         kref_init(&tape->kref);
2869
2870         tape->drive = drive;
2871         tape->driver = &idetape_driver;
2872         tape->disk = g;
2873
2874         g->private_data = &tape->driver;
2875
2876         drive->driver_data = tape;
2877
2878         mutex_lock(&idetape_ref_mutex);
2879         for (minor = 0; idetape_devs[minor]; minor++)
2880                 ;
2881         idetape_devs[minor] = tape;
2882         mutex_unlock(&idetape_ref_mutex);
2883
2884         idetape_setup(drive, tape, minor);
2885
2886         device_create(idetape_sysfs_class, &drive->gendev,
2887                       MKDEV(IDETAPE_MAJOR, minor), "%s", tape->name);
2888         device_create(idetape_sysfs_class, &drive->gendev,
2889                         MKDEV(IDETAPE_MAJOR, minor + 128), "n%s", tape->name);
2890
2891         g->fops = &idetape_block_ops;
2892         ide_register_region(g);
2893
2894         return 0;
2895
2896 out_free_tape:
2897         kfree(tape);
2898 failed:
2899         return -ENODEV;
2900 }
2901
2902 static void __exit idetape_exit(void)
2903 {
2904         driver_unregister(&idetape_driver.gen_driver);
2905         class_destroy(idetape_sysfs_class);
2906         unregister_chrdev(IDETAPE_MAJOR, "ht");
2907 }
2908
2909 static int __init idetape_init(void)
2910 {
2911         int error = 1;
2912         idetape_sysfs_class = class_create(THIS_MODULE, "ide_tape");
2913         if (IS_ERR(idetape_sysfs_class)) {
2914                 idetape_sysfs_class = NULL;
2915                 printk(KERN_ERR "Unable to create sysfs class for ide tapes\n");
2916                 error = -EBUSY;
2917                 goto out;
2918         }
2919
2920         if (register_chrdev(IDETAPE_MAJOR, "ht", &idetape_fops)) {
2921                 printk(KERN_ERR "ide-tape: Failed to register chrdev"
2922                                 " interface\n");
2923                 error = -EBUSY;
2924                 goto out_free_class;
2925         }
2926
2927         error = driver_register(&idetape_driver.gen_driver);
2928         if (error)
2929                 goto out_free_driver;
2930
2931         return 0;
2932
2933 out_free_driver:
2934         driver_unregister(&idetape_driver.gen_driver);
2935 out_free_class:
2936         class_destroy(idetape_sysfs_class);
2937 out:
2938         return error;
2939 }
2940
2941 MODULE_ALIAS("ide:*m-tape*");
2942 module_init(idetape_init);
2943 module_exit(idetape_exit);
2944 MODULE_ALIAS_CHARDEV_MAJOR(IDETAPE_MAJOR);
2945 MODULE_DESCRIPTION("ATAPI Streaming TAPE Driver");
2946 MODULE_LICENSE("GPL");