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