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