ide: remove ide_end_request()
[linux-2.6-block.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 DRV_NAME "ide-tape"
19
20 #define IDETAPE_VERSION "1.20"
21
22 #include <linux/module.h>
23 #include <linux/types.h>
24 #include <linux/string.h>
25 #include <linux/kernel.h>
26 #include <linux/delay.h>
27 #include <linux/timer.h>
28 #include <linux/mm.h>
29 #include <linux/interrupt.h>
30 #include <linux/jiffies.h>
31 #include <linux/major.h>
32 #include <linux/errno.h>
33 #include <linux/genhd.h>
34 #include <linux/slab.h>
35 #include <linux/pci.h>
36 #include <linux/ide.h>
37 #include <linux/smp_lock.h>
38 #include <linux/completion.h>
39 #include <linux/bitops.h>
40 #include <linux/mutex.h>
41 #include <scsi/scsi.h>
42
43 #include <asm/byteorder.h>
44 #include <linux/irq.h>
45 #include <linux/uaccess.h>
46 #include <linux/io.h>
47 #include <asm/unaligned.h>
48 #include <linux/mtio.h>
49
50 enum {
51         /* output errors only */
52         DBG_ERR =               (1 << 0),
53         /* output all sense key/asc */
54         DBG_SENSE =             (1 << 1),
55         /* info regarding all chrdev-related procedures */
56         DBG_CHRDEV =            (1 << 2),
57         /* all remaining procedures */
58         DBG_PROCS =             (1 << 3),
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  * The following parameter is used to select the point in the internal tape fifo
85  * in which we will start to refill the buffer. Decreasing the following
86  * parameter will improve the system's latency and interactive response, while
87  * using a high value might improve system throughput.
88  */
89 #define IDETAPE_FIFO_THRESHOLD          2
90
91 /*
92  * DSC polling parameters.
93  *
94  * Polling for DSC (a single bit in the status register) is a very important
95  * function in ide-tape. There are two cases in which we poll for DSC:
96  *
97  * 1. Before a read/write packet command, to ensure that we can transfer data
98  * from/to the tape's data buffers, without causing an actual media access.
99  * In case the tape is not ready yet, we take out our request from the device
100  * request queue, so that ide.c could service requests from the other device
101  * on the same interface in the meantime.
102  *
103  * 2. After the successful initialization of a "media access packet command",
104  * which is a command that can take a long time to complete (the interval can
105  * range from several seconds to even an hour). Again, we postpone our request
106  * in the middle to free the bus for the other device. The polling frequency
107  * here should be lower than the read/write frequency since those media access
108  * commands are slow. We start from a "fast" frequency - IDETAPE_DSC_MA_FAST
109  * (1 second), and if we don't receive DSC after IDETAPE_DSC_MA_THRESHOLD
110  * (5 min), we switch it to a lower frequency - IDETAPE_DSC_MA_SLOW (1 min).
111  *
112  * We also set a timeout for the timer, in case something goes wrong. The
113  * timeout should be longer then the maximum execution time of a tape operation.
114  */
115
116 /* DSC timings. */
117 #define IDETAPE_DSC_RW_MIN              5*HZ/100        /* 50 msec */
118 #define IDETAPE_DSC_RW_MAX              40*HZ/100       /* 400 msec */
119 #define IDETAPE_DSC_RW_TIMEOUT          2*60*HZ         /* 2 minutes */
120 #define IDETAPE_DSC_MA_FAST             2*HZ            /* 2 seconds */
121 #define IDETAPE_DSC_MA_THRESHOLD        5*60*HZ         /* 5 minutes */
122 #define IDETAPE_DSC_MA_SLOW             30*HZ           /* 30 seconds */
123 #define IDETAPE_DSC_MA_TIMEOUT          2*60*60*HZ      /* 2 hours */
124
125 /*************************** End of tunable parameters ***********************/
126
127 /* tape directions */
128 enum {
129         IDETAPE_DIR_NONE  = (1 << 0),
130         IDETAPE_DIR_READ  = (1 << 1),
131         IDETAPE_DIR_WRITE = (1 << 2),
132 };
133
134 struct idetape_bh {
135         u32 b_size;
136         atomic_t b_count;
137         struct idetape_bh *b_reqnext;
138         char *b_data;
139 };
140
141 /* Tape door status */
142 #define DOOR_UNLOCKED                   0
143 #define DOOR_LOCKED                     1
144 #define DOOR_EXPLICITLY_LOCKED          2
145
146 /* Some defines for the SPACE command */
147 #define IDETAPE_SPACE_OVER_FILEMARK     1
148 #define IDETAPE_SPACE_TO_EOD            3
149
150 /* Some defines for the LOAD UNLOAD command */
151 #define IDETAPE_LU_LOAD_MASK            1
152 #define IDETAPE_LU_RETENSION_MASK       2
153 #define IDETAPE_LU_EOT_MASK             4
154
155 /* Structures related to the SELECT SENSE / MODE SENSE packet commands. */
156 #define IDETAPE_BLOCK_DESCRIPTOR        0
157 #define IDETAPE_CAPABILITIES_PAGE       0x2a
158
159 /*
160  * Most of our global data which we need to save even as we leave the driver due
161  * to an interrupt or a timer event is stored in the struct defined below.
162  */
163 typedef struct ide_tape_obj {
164         ide_drive_t             *drive;
165         struct ide_driver       *driver;
166         struct gendisk          *disk;
167         struct device           dev;
168
169         /* used by REQ_IDETAPE_{READ,WRITE} requests */
170         struct ide_atapi_pc queued_pc;
171
172         /*
173          * DSC polling variables.
174          *
175          * While polling for DSC we use postponed_rq to postpone the current
176          * request so that ide.c will be able to service pending requests on the
177          * other device. Note that at most we will have only one DSC (usually
178          * data transfer) request in the device request queue.
179          */
180         struct request *postponed_rq;
181         /* The time in which we started polling for DSC */
182         unsigned long dsc_polling_start;
183         /* Timer used to poll for dsc */
184         struct timer_list dsc_timer;
185         /* Read/Write dsc polling frequency */
186         unsigned long best_dsc_rw_freq;
187         unsigned long dsc_poll_freq;
188         unsigned long dsc_timeout;
189
190         /* Read position information */
191         u8 partition;
192         /* Current block */
193         unsigned int first_frame;
194
195         /* Last error information */
196         u8 sense_key, asc, ascq;
197
198         /* Character device operation */
199         unsigned int minor;
200         /* device name */
201         char name[4];
202         /* Current character device data transfer direction */
203         u8 chrdev_dir;
204
205         /* tape block size, usually 512 or 1024 bytes */
206         unsigned short blk_size;
207         int user_bs_factor;
208
209         /* Copy of the tape's Capabilities and Mechanical Page */
210         u8 caps[20];
211
212         /*
213          * Active data transfer request parameters.
214          *
215          * At most, there is only one ide-tape originated data transfer request
216          * in the device request queue. This allows ide.c to easily service
217          * requests from the other device when we postpone our active request.
218          */
219
220         /* Data buffer size chosen based on the tape's recommendation */
221         int buffer_size;
222         /* merge buffer */
223         struct idetape_bh *merge_bh;
224         /* size of the merge buffer */
225         int merge_bh_size;
226         /* pointer to current buffer head within the merge buffer */
227         struct idetape_bh *bh;
228         char *b_data;
229         int b_count;
230
231         int pages_per_buffer;
232         /* Wasted space in each stage */
233         int excess_bh_size;
234
235         /* Measures average tape speed */
236         unsigned long avg_time;
237         int avg_size;
238         int avg_speed;
239
240         /* the door is currently locked */
241         int door_locked;
242         /* the tape hardware is write protected */
243         char drv_write_prot;
244         /* the tape is write protected (hardware or opened as read-only) */
245         char write_prot;
246
247         u32 debug_mask;
248 } idetape_tape_t;
249
250 static DEFINE_MUTEX(idetape_ref_mutex);
251
252 static struct class *idetape_sysfs_class;
253
254 static void ide_tape_release(struct device *);
255
256 static struct ide_tape_obj *ide_tape_get(struct gendisk *disk)
257 {
258         struct ide_tape_obj *tape = NULL;
259
260         mutex_lock(&idetape_ref_mutex);
261         tape = ide_drv_g(disk, ide_tape_obj);
262         if (tape) {
263                 if (ide_device_get(tape->drive))
264                         tape = NULL;
265                 else
266                         get_device(&tape->dev);
267         }
268         mutex_unlock(&idetape_ref_mutex);
269         return tape;
270 }
271
272 static void ide_tape_put(struct ide_tape_obj *tape)
273 {
274         ide_drive_t *drive = tape->drive;
275
276         mutex_lock(&idetape_ref_mutex);
277         put_device(&tape->dev);
278         ide_device_put(drive);
279         mutex_unlock(&idetape_ref_mutex);
280 }
281
282 /*
283  * The variables below are used for the character device interface. Additional
284  * state variables are defined in our ide_drive_t structure.
285  */
286 static struct ide_tape_obj *idetape_devs[MAX_HWIFS * MAX_DRIVES];
287
288 static struct ide_tape_obj *ide_tape_chrdev_get(unsigned int i)
289 {
290         struct ide_tape_obj *tape = NULL;
291
292         mutex_lock(&idetape_ref_mutex);
293         tape = idetape_devs[i];
294         if (tape)
295                 get_device(&tape->dev);
296         mutex_unlock(&idetape_ref_mutex);
297         return tape;
298 }
299
300 static void idetape_input_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
301                                   unsigned int bcount)
302 {
303         struct idetape_bh *bh = pc->bh;
304         int count;
305
306         while (bcount) {
307                 if (bh == NULL) {
308                         printk(KERN_ERR "ide-tape: bh == NULL in "
309                                 "idetape_input_buffers\n");
310                         ide_pad_transfer(drive, 0, bcount);
311                         return;
312                 }
313                 count = min(
314                         (unsigned int)(bh->b_size - atomic_read(&bh->b_count)),
315                         bcount);
316                 drive->hwif->tp_ops->input_data(drive, NULL, bh->b_data +
317                                         atomic_read(&bh->b_count), count);
318                 bcount -= count;
319                 atomic_add(count, &bh->b_count);
320                 if (atomic_read(&bh->b_count) == bh->b_size) {
321                         bh = bh->b_reqnext;
322                         if (bh)
323                                 atomic_set(&bh->b_count, 0);
324                 }
325         }
326         pc->bh = bh;
327 }
328
329 static void idetape_output_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
330                                    unsigned int bcount)
331 {
332         struct idetape_bh *bh = pc->bh;
333         int count;
334
335         while (bcount) {
336                 if (bh == NULL) {
337                         printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
338                                         __func__);
339                         return;
340                 }
341                 count = min((unsigned int)pc->b_count, (unsigned int)bcount);
342                 drive->hwif->tp_ops->output_data(drive, NULL, pc->b_data, count);
343                 bcount -= count;
344                 pc->b_data += count;
345                 pc->b_count -= count;
346                 if (!pc->b_count) {
347                         bh = bh->b_reqnext;
348                         pc->bh = bh;
349                         if (bh) {
350                                 pc->b_data = bh->b_data;
351                                 pc->b_count = atomic_read(&bh->b_count);
352                         }
353                 }
354         }
355 }
356
357 static void idetape_update_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc)
358 {
359         struct idetape_bh *bh = pc->bh;
360         int count;
361         unsigned int bcount = pc->xferred;
362
363         if (pc->flags & PC_FLAG_WRITING)
364                 return;
365         while (bcount) {
366                 if (bh == NULL) {
367                         printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
368                                         __func__);
369                         return;
370                 }
371                 count = min((unsigned int)bh->b_size, (unsigned int)bcount);
372                 atomic_set(&bh->b_count, count);
373                 if (atomic_read(&bh->b_count) == bh->b_size)
374                         bh = bh->b_reqnext;
375                 bcount -= count;
376         }
377         pc->bh = bh;
378 }
379
380 /*
381  * called on each failed packet command retry to analyze the request sense. We
382  * currently do not utilize this information.
383  */
384 static void idetape_analyze_error(ide_drive_t *drive, u8 *sense)
385 {
386         idetape_tape_t *tape = drive->driver_data;
387         struct ide_atapi_pc *pc = drive->failed_pc;
388
389         tape->sense_key = sense[2] & 0xF;
390         tape->asc       = sense[12];
391         tape->ascq      = sense[13];
392
393         debug_log(DBG_ERR, "pc = %x, sense key = %x, asc = %x, ascq = %x\n",
394                  pc->c[0], tape->sense_key, tape->asc, tape->ascq);
395
396         /* Correct pc->xferred by asking the tape.       */
397         if (pc->flags & PC_FLAG_DMA_ERROR) {
398                 pc->xferred = pc->req_xfer -
399                         tape->blk_size *
400                         get_unaligned_be32(&sense[3]);
401                 idetape_update_buffers(drive, pc);
402         }
403
404         /*
405          * If error was the result of a zero-length read or write command,
406          * with sense key=5, asc=0x22, ascq=0, let it slide.  Some drives
407          * (i.e. Seagate STT3401A Travan) don't support 0-length read/writes.
408          */
409         if ((pc->c[0] == READ_6 || pc->c[0] == WRITE_6)
410             /* length == 0 */
411             && pc->c[4] == 0 && pc->c[3] == 0 && pc->c[2] == 0) {
412                 if (tape->sense_key == 5) {
413                         /* don't report an error, everything's ok */
414                         pc->error = 0;
415                         /* don't retry read/write */
416                         pc->flags |= PC_FLAG_ABORT;
417                 }
418         }
419         if (pc->c[0] == READ_6 && (sense[2] & 0x80)) {
420                 pc->error = IDE_DRV_ERROR_FILEMARK;
421                 pc->flags |= PC_FLAG_ABORT;
422         }
423         if (pc->c[0] == WRITE_6) {
424                 if ((sense[2] & 0x40) || (tape->sense_key == 0xd
425                      && tape->asc == 0x0 && tape->ascq == 0x2)) {
426                         pc->error = IDE_DRV_ERROR_EOD;
427                         pc->flags |= PC_FLAG_ABORT;
428                 }
429         }
430         if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
431                 if (tape->sense_key == 8) {
432                         pc->error = IDE_DRV_ERROR_EOD;
433                         pc->flags |= PC_FLAG_ABORT;
434                 }
435                 if (!(pc->flags & PC_FLAG_ABORT) &&
436                     pc->xferred)
437                         pc->retries = IDETAPE_MAX_PC_RETRIES + 1;
438         }
439 }
440
441 /* Free data buffers completely. */
442 static void ide_tape_kfree_buffer(idetape_tape_t *tape)
443 {
444         struct idetape_bh *prev_bh, *bh = tape->merge_bh;
445
446         while (bh) {
447                 u32 size = bh->b_size;
448
449                 while (size) {
450                         unsigned int order = fls(size >> PAGE_SHIFT)-1;
451
452                         if (bh->b_data)
453                                 free_pages((unsigned long)bh->b_data, order);
454
455                         size &= (order-1);
456                         bh->b_data += (1 << order) * PAGE_SIZE;
457                 }
458                 prev_bh = bh;
459                 bh = bh->b_reqnext;
460                 kfree(prev_bh);
461         }
462 }
463
464 static void ide_tape_handle_dsc(ide_drive_t *);
465
466 static int ide_tape_callback(ide_drive_t *drive, int dsc)
467 {
468         idetape_tape_t *tape = drive->driver_data;
469         struct ide_atapi_pc *pc = drive->pc;
470         struct request *rq = drive->hwif->rq;
471         int uptodate = pc->error ? 0 : 1;
472         int err = uptodate ? 0 : IDE_DRV_ERROR_GENERAL;
473
474         debug_log(DBG_PROCS, "Enter %s\n", __func__);
475
476         if (dsc)
477                 ide_tape_handle_dsc(drive);
478
479         if (drive->failed_pc == pc)
480                 drive->failed_pc = NULL;
481
482         if (pc->c[0] == REQUEST_SENSE) {
483                 if (uptodate)
484                         idetape_analyze_error(drive, pc->buf);
485                 else
486                         printk(KERN_ERR "ide-tape: Error in REQUEST SENSE "
487                                         "itself - Aborting request!\n");
488         } else if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
489                 int blocks = pc->xferred / tape->blk_size;
490
491                 tape->avg_size += blocks * tape->blk_size;
492
493                 if (time_after_eq(jiffies, tape->avg_time + HZ)) {
494                         tape->avg_speed = tape->avg_size * HZ /
495                                 (jiffies - tape->avg_time) / 1024;
496                         tape->avg_size = 0;
497                         tape->avg_time = jiffies;
498                 }
499
500                 tape->first_frame += blocks;
501                 rq->current_nr_sectors -= blocks;
502
503                 if (pc->error) {
504                         uptodate = 0;
505                         err = pc->error;
506                 }
507         } else if (pc->c[0] == READ_POSITION && uptodate) {
508                 u8 *readpos = pc->buf;
509
510                 debug_log(DBG_SENSE, "BOP - %s\n",
511                                 (readpos[0] & 0x80) ? "Yes" : "No");
512                 debug_log(DBG_SENSE, "EOP - %s\n",
513                                 (readpos[0] & 0x40) ? "Yes" : "No");
514
515                 if (readpos[0] & 0x4) {
516                         printk(KERN_INFO "ide-tape: Block location is unknown"
517                                          "to the tape\n");
518                         clear_bit(IDE_AFLAG_ADDRESS_VALID, &drive->atapi_flags);
519                         uptodate = 0;
520                         err = IDE_DRV_ERROR_GENERAL;
521                 } else {
522                         debug_log(DBG_SENSE, "Block Location - %u\n",
523                                         be32_to_cpup((__be32 *)&readpos[4]));
524
525                         tape->partition = readpos[1];
526                         tape->first_frame = be32_to_cpup((__be32 *)&readpos[4]);
527                         set_bit(IDE_AFLAG_ADDRESS_VALID, &drive->atapi_flags);
528                 }
529         }
530
531         rq->errors = err;
532
533         return uptodate;
534 }
535
536 /*
537  * Postpone the current request so that ide.c will be able to service requests
538  * from another device on the same port while we are polling for DSC.
539  */
540 static void idetape_postpone_request(ide_drive_t *drive)
541 {
542         idetape_tape_t *tape = drive->driver_data;
543
544         debug_log(DBG_PROCS, "Enter %s\n", __func__);
545
546         tape->postponed_rq = drive->hwif->rq;
547
548         ide_stall_queue(drive, tape->dsc_poll_freq);
549 }
550
551 static void ide_tape_handle_dsc(ide_drive_t *drive)
552 {
553         idetape_tape_t *tape = drive->driver_data;
554
555         /* Media access command */
556         tape->dsc_polling_start = jiffies;
557         tape->dsc_poll_freq = IDETAPE_DSC_MA_FAST;
558         tape->dsc_timeout = jiffies + IDETAPE_DSC_MA_TIMEOUT;
559         /* Allow ide.c to handle other requests */
560         idetape_postpone_request(drive);
561 }
562
563 static int ide_tape_io_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
564                                 unsigned int bcount, int write)
565 {
566         if (write)
567                 idetape_output_buffers(drive, pc, bcount);
568         else
569                 idetape_input_buffers(drive, pc, bcount);
570
571         return bcount;
572 }
573
574 /*
575  * Packet Command Interface
576  *
577  * The current Packet Command is available in drive->pc, and will not change
578  * until we finish handling it. Each packet command is associated with a
579  * callback function that will be called when the command is finished.
580  *
581  * The handling will be done in three stages:
582  *
583  * 1. idetape_issue_pc will send the packet command to the drive, and will set
584  * the interrupt handler to ide_pc_intr.
585  *
586  * 2. On each interrupt, ide_pc_intr will be called. This step will be
587  * repeated until the device signals us that no more interrupts will be issued.
588  *
589  * 3. ATAPI Tape media access commands have immediate status with a delayed
590  * process. In case of a successful initiation of a media access packet command,
591  * the DSC bit will be set when the actual execution of the command is finished.
592  * Since the tape drive will not issue an interrupt, we have to poll for this
593  * event. In this case, we define the request as "low priority request" by
594  * setting rq_status to IDETAPE_RQ_POSTPONED, set a timer to poll for DSC and
595  * exit the driver.
596  *
597  * ide.c will then give higher priority to requests which originate from the
598  * other device, until will change rq_status to RQ_ACTIVE.
599  *
600  * 4. When the packet command is finished, it will be checked for errors.
601  *
602  * 5. In case an error was found, we queue a request sense packet command in
603  * front of the request queue and retry the operation up to
604  * IDETAPE_MAX_PC_RETRIES times.
605  *
606  * 6. In case no error was found, or we decided to give up and not to retry
607  * again, the callback function will be called and then we will handle the next
608  * request.
609  */
610
611 static ide_startstop_t idetape_issue_pc(ide_drive_t *drive,
612                 struct ide_atapi_pc *pc)
613 {
614         idetape_tape_t *tape = drive->driver_data;
615
616         if (drive->pc->c[0] == REQUEST_SENSE &&
617             pc->c[0] == REQUEST_SENSE) {
618                 printk(KERN_ERR "ide-tape: possible ide-tape.c bug - "
619                         "Two request sense in serial were issued\n");
620         }
621
622         if (drive->failed_pc == NULL && pc->c[0] != REQUEST_SENSE)
623                 drive->failed_pc = pc;
624
625         /* Set the current packet command */
626         drive->pc = pc;
627
628         if (pc->retries > IDETAPE_MAX_PC_RETRIES ||
629                 (pc->flags & PC_FLAG_ABORT)) {
630                 /*
631                  * We will "abort" retrying a packet command in case legitimate
632                  * error code was received (crossing a filemark, or end of the
633                  * media, for example).
634                  */
635                 if (!(pc->flags & PC_FLAG_ABORT)) {
636                         if (!(pc->c[0] == TEST_UNIT_READY &&
637                               tape->sense_key == 2 && tape->asc == 4 &&
638                              (tape->ascq == 1 || tape->ascq == 8))) {
639                                 printk(KERN_ERR "ide-tape: %s: I/O error, "
640                                                 "pc = %2x, key = %2x, "
641                                                 "asc = %2x, ascq = %2x\n",
642                                                 tape->name, pc->c[0],
643                                                 tape->sense_key, tape->asc,
644                                                 tape->ascq);
645                         }
646                         /* Giving up */
647                         pc->error = IDE_DRV_ERROR_GENERAL;
648                 }
649                 drive->failed_pc = NULL;
650                 drive->pc_callback(drive, 0);
651                 return ide_stopped;
652         }
653         debug_log(DBG_SENSE, "Retry #%d, cmd = %02X\n", pc->retries, pc->c[0]);
654
655         pc->retries++;
656
657         return ide_issue_pc(drive);
658 }
659
660 /* A mode sense command is used to "sense" tape parameters. */
661 static void idetape_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
662 {
663         ide_init_pc(pc);
664         pc->c[0] = MODE_SENSE;
665         if (page_code != IDETAPE_BLOCK_DESCRIPTOR)
666                 /* DBD = 1 - Don't return block descriptors */
667                 pc->c[1] = 8;
668         pc->c[2] = page_code;
669         /*
670          * Changed pc->c[3] to 0 (255 will at best return unused info).
671          *
672          * For SCSI this byte is defined as subpage instead of high byte
673          * of length and some IDE drives seem to interpret it this way
674          * and return an error when 255 is used.
675          */
676         pc->c[3] = 0;
677         /* We will just discard data in that case */
678         pc->c[4] = 255;
679         if (page_code == IDETAPE_BLOCK_DESCRIPTOR)
680                 pc->req_xfer = 12;
681         else if (page_code == IDETAPE_CAPABILITIES_PAGE)
682                 pc->req_xfer = 24;
683         else
684                 pc->req_xfer = 50;
685 }
686
687 static ide_startstop_t idetape_media_access_finished(ide_drive_t *drive)
688 {
689         ide_hwif_t *hwif = drive->hwif;
690         idetape_tape_t *tape = drive->driver_data;
691         struct ide_atapi_pc *pc = drive->pc;
692         u8 stat;
693
694         stat = hwif->tp_ops->read_status(hwif);
695
696         if (stat & ATA_DSC) {
697                 if (stat & ATA_ERR) {
698                         /* Error detected */
699                         if (pc->c[0] != TEST_UNIT_READY)
700                                 printk(KERN_ERR "ide-tape: %s: I/O error, ",
701                                                 tape->name);
702                         /* Retry operation */
703                         ide_retry_pc(drive, tape->disk);
704                         return ide_stopped;
705                 }
706                 pc->error = 0;
707         } else {
708                 pc->error = IDE_DRV_ERROR_GENERAL;
709                 drive->failed_pc = NULL;
710         }
711         drive->pc_callback(drive, 0);
712         return ide_stopped;
713 }
714
715 static void ide_tape_create_rw_cmd(idetape_tape_t *tape,
716                                    struct ide_atapi_pc *pc, struct request *rq,
717                                    u8 opcode)
718 {
719         struct idetape_bh *bh = (struct idetape_bh *)rq->special;
720         unsigned int length = rq->current_nr_sectors;
721
722         ide_init_pc(pc);
723         put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
724         pc->c[1] = 1;
725         pc->bh = bh;
726         pc->buf = NULL;
727         pc->buf_size = length * tape->blk_size;
728         pc->req_xfer = pc->buf_size;
729         if (pc->req_xfer == tape->buffer_size)
730                 pc->flags |= PC_FLAG_DMA_OK;
731
732         if (opcode == READ_6) {
733                 pc->c[0] = READ_6;
734                 atomic_set(&bh->b_count, 0);
735         } else if (opcode == WRITE_6) {
736                 pc->c[0] = WRITE_6;
737                 pc->flags |= PC_FLAG_WRITING;
738                 pc->b_data = bh->b_data;
739                 pc->b_count = atomic_read(&bh->b_count);
740         }
741
742         memcpy(rq->cmd, pc->c, 12);
743 }
744
745 static ide_startstop_t idetape_do_request(ide_drive_t *drive,
746                                           struct request *rq, sector_t block)
747 {
748         ide_hwif_t *hwif = drive->hwif;
749         idetape_tape_t *tape = drive->driver_data;
750         struct ide_atapi_pc *pc = NULL;
751         struct request *postponed_rq = tape->postponed_rq;
752         u8 stat;
753
754         debug_log(DBG_SENSE, "sector: %llu, nr_sectors: %lu,"
755                         " current_nr_sectors: %u\n",
756                         (unsigned long long)rq->sector, rq->nr_sectors,
757                         rq->current_nr_sectors);
758
759         if (!blk_special_request(rq)) {
760                 /* We do not support buffer cache originated requests. */
761                 printk(KERN_NOTICE "ide-tape: %s: Unsupported request in "
762                         "request queue (%d)\n", drive->name, rq->cmd_type);
763                 if (blk_fs_request(rq) == 0 && rq->errors == 0)
764                         rq->errors = -EIO;
765                 ide_complete_rq(drive, -EIO, ide_rq_bytes(rq));
766                 return ide_stopped;
767         }
768
769         /* Retry a failed packet command */
770         if (drive->failed_pc && drive->pc->c[0] == REQUEST_SENSE) {
771                 pc = drive->failed_pc;
772                 goto out;
773         }
774
775         if (postponed_rq != NULL)
776                 if (rq != postponed_rq) {
777                         printk(KERN_ERR "ide-tape: ide-tape.c bug - "
778                                         "Two DSC requests were queued\n");
779                         drive->failed_pc = NULL;
780                         rq->errors = 0;
781                         ide_complete_rq(drive, 0, blk_rq_bytes(rq));
782                         return ide_stopped;
783                 }
784
785         tape->postponed_rq = NULL;
786
787         /*
788          * If the tape is still busy, postpone our request and service
789          * the other device meanwhile.
790          */
791         stat = hwif->tp_ops->read_status(hwif);
792
793         if ((drive->dev_flags & IDE_DFLAG_DSC_OVERLAP) == 0 &&
794             (rq->cmd[13] & REQ_IDETAPE_PC2) == 0)
795                 set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
796
797         if (drive->dev_flags & IDE_DFLAG_POST_RESET) {
798                 set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
799                 drive->dev_flags &= ~IDE_DFLAG_POST_RESET;
800         }
801
802         if (!test_and_clear_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags) &&
803             (stat & ATA_DSC) == 0) {
804                 if (postponed_rq == NULL) {
805                         tape->dsc_polling_start = jiffies;
806                         tape->dsc_poll_freq = tape->best_dsc_rw_freq;
807                         tape->dsc_timeout = jiffies + IDETAPE_DSC_RW_TIMEOUT;
808                 } else if (time_after(jiffies, tape->dsc_timeout)) {
809                         printk(KERN_ERR "ide-tape: %s: DSC timeout\n",
810                                 tape->name);
811                         if (rq->cmd[13] & REQ_IDETAPE_PC2) {
812                                 idetape_media_access_finished(drive);
813                                 return ide_stopped;
814                         } else {
815                                 return ide_do_reset(drive);
816                         }
817                 } else if (time_after(jiffies,
818                                         tape->dsc_polling_start +
819                                         IDETAPE_DSC_MA_THRESHOLD))
820                         tape->dsc_poll_freq = IDETAPE_DSC_MA_SLOW;
821                 idetape_postpone_request(drive);
822                 return ide_stopped;
823         }
824         if (rq->cmd[13] & REQ_IDETAPE_READ) {
825                 pc = &tape->queued_pc;
826                 ide_tape_create_rw_cmd(tape, pc, rq, READ_6);
827                 goto out;
828         }
829         if (rq->cmd[13] & REQ_IDETAPE_WRITE) {
830                 pc = &tape->queued_pc;
831                 ide_tape_create_rw_cmd(tape, pc, rq, WRITE_6);
832                 goto out;
833         }
834         if (rq->cmd[13] & REQ_IDETAPE_PC1) {
835                 pc = (struct ide_atapi_pc *) rq->buffer;
836                 rq->cmd[13] &= ~(REQ_IDETAPE_PC1);
837                 rq->cmd[13] |= REQ_IDETAPE_PC2;
838                 goto out;
839         }
840         if (rq->cmd[13] & REQ_IDETAPE_PC2) {
841                 idetape_media_access_finished(drive);
842                 return ide_stopped;
843         }
844         BUG();
845
846 out:
847         return idetape_issue_pc(drive, pc);
848 }
849
850 /*
851  * The function below uses __get_free_pages to allocate a data buffer of size
852  * tape->buffer_size (or a bit more). We attempt to combine sequential pages as
853  * much as possible.
854  *
855  * It returns a pointer to the newly allocated buffer, or NULL in case of
856  * failure.
857  */
858 static struct idetape_bh *ide_tape_kmalloc_buffer(idetape_tape_t *tape,
859                                                   int full, int clear)
860 {
861         struct idetape_bh *prev_bh, *bh, *merge_bh;
862         int pages = tape->pages_per_buffer;
863         unsigned int order, b_allocd;
864         char *b_data = NULL;
865
866         merge_bh = kmalloc(sizeof(struct idetape_bh), GFP_KERNEL);
867         bh = merge_bh;
868         if (bh == NULL)
869                 goto abort;
870
871         order = fls(pages) - 1;
872         bh->b_data = (char *) __get_free_pages(GFP_KERNEL, order);
873         if (!bh->b_data)
874                 goto abort;
875         b_allocd = (1 << order) * PAGE_SIZE;
876         pages &= (order-1);
877
878         if (clear)
879                 memset(bh->b_data, 0, b_allocd);
880         bh->b_reqnext = NULL;
881         bh->b_size = b_allocd;
882         atomic_set(&bh->b_count, full ? bh->b_size : 0);
883
884         while (pages) {
885                 order = fls(pages) - 1;
886                 b_data = (char *) __get_free_pages(GFP_KERNEL, order);
887                 if (!b_data)
888                         goto abort;
889                 b_allocd = (1 << order) * PAGE_SIZE;
890
891                 if (clear)
892                         memset(b_data, 0, b_allocd);
893
894                 /* newly allocated page frames below buffer header or ...*/
895                 if (bh->b_data == b_data + b_allocd) {
896                         bh->b_size += b_allocd;
897                         bh->b_data -= b_allocd;
898                         if (full)
899                                 atomic_add(b_allocd, &bh->b_count);
900                         continue;
901                 }
902                 /* they are above the header */
903                 if (b_data == bh->b_data + bh->b_size) {
904                         bh->b_size += b_allocd;
905                         if (full)
906                                 atomic_add(b_allocd, &bh->b_count);
907                         continue;
908                 }
909                 prev_bh = bh;
910                 bh = kmalloc(sizeof(struct idetape_bh), GFP_KERNEL);
911                 if (!bh) {
912                         free_pages((unsigned long) b_data, order);
913                         goto abort;
914                 }
915                 bh->b_reqnext = NULL;
916                 bh->b_data = b_data;
917                 bh->b_size = b_allocd;
918                 atomic_set(&bh->b_count, full ? bh->b_size : 0);
919                 prev_bh->b_reqnext = bh;
920
921                 pages &= (order-1);
922         }
923
924         bh->b_size -= tape->excess_bh_size;
925         if (full)
926                 atomic_sub(tape->excess_bh_size, &bh->b_count);
927         return merge_bh;
928 abort:
929         ide_tape_kfree_buffer(tape);
930         return NULL;
931 }
932
933 static int idetape_copy_stage_from_user(idetape_tape_t *tape,
934                                         const char __user *buf, int n)
935 {
936         struct idetape_bh *bh = tape->bh;
937         int count;
938         int ret = 0;
939
940         while (n) {
941                 if (bh == NULL) {
942                         printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
943                                         __func__);
944                         return 1;
945                 }
946                 count = min((unsigned int)
947                                 (bh->b_size - atomic_read(&bh->b_count)),
948                                 (unsigned int)n);
949                 if (copy_from_user(bh->b_data + atomic_read(&bh->b_count), buf,
950                                 count))
951                         ret = 1;
952                 n -= count;
953                 atomic_add(count, &bh->b_count);
954                 buf += count;
955                 if (atomic_read(&bh->b_count) == bh->b_size) {
956                         bh = bh->b_reqnext;
957                         if (bh)
958                                 atomic_set(&bh->b_count, 0);
959                 }
960         }
961         tape->bh = bh;
962         return ret;
963 }
964
965 static int idetape_copy_stage_to_user(idetape_tape_t *tape, char __user *buf,
966                                       int n)
967 {
968         struct idetape_bh *bh = tape->bh;
969         int count;
970         int ret = 0;
971
972         while (n) {
973                 if (bh == NULL) {
974                         printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
975                                         __func__);
976                         return 1;
977                 }
978                 count = min(tape->b_count, n);
979                 if  (copy_to_user(buf, tape->b_data, count))
980                         ret = 1;
981                 n -= count;
982                 tape->b_data += count;
983                 tape->b_count -= count;
984                 buf += count;
985                 if (!tape->b_count) {
986                         bh = bh->b_reqnext;
987                         tape->bh = bh;
988                         if (bh) {
989                                 tape->b_data = bh->b_data;
990                                 tape->b_count = atomic_read(&bh->b_count);
991                         }
992                 }
993         }
994         return ret;
995 }
996
997 static void idetape_init_merge_buffer(idetape_tape_t *tape)
998 {
999         struct idetape_bh *bh = tape->merge_bh;
1000         tape->bh = tape->merge_bh;
1001
1002         if (tape->chrdev_dir == IDETAPE_DIR_WRITE)
1003                 atomic_set(&bh->b_count, 0);
1004         else {
1005                 tape->b_data = bh->b_data;
1006                 tape->b_count = atomic_read(&bh->b_count);
1007         }
1008 }
1009
1010 /*
1011  * Write a filemark if write_filemark=1. Flush the device buffers without
1012  * writing a filemark otherwise.
1013  */
1014 static void idetape_create_write_filemark_cmd(ide_drive_t *drive,
1015                 struct ide_atapi_pc *pc, int write_filemark)
1016 {
1017         ide_init_pc(pc);
1018         pc->c[0] = WRITE_FILEMARKS;
1019         pc->c[4] = write_filemark;
1020         pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1021 }
1022
1023 static int idetape_wait_ready(ide_drive_t *drive, unsigned long timeout)
1024 {
1025         idetape_tape_t *tape = drive->driver_data;
1026         struct gendisk *disk = tape->disk;
1027         int load_attempted = 0;
1028
1029         /* Wait for the tape to become ready */
1030         set_bit(IDE_AFLAG_MEDIUM_PRESENT, &drive->atapi_flags);
1031         timeout += jiffies;
1032         while (time_before(jiffies, timeout)) {
1033                 if (ide_do_test_unit_ready(drive, disk) == 0)
1034                         return 0;
1035                 if ((tape->sense_key == 2 && tape->asc == 4 && tape->ascq == 2)
1036                     || (tape->asc == 0x3A)) {
1037                         /* no media */
1038                         if (load_attempted)
1039                                 return -ENOMEDIUM;
1040                         ide_do_start_stop(drive, disk, IDETAPE_LU_LOAD_MASK);
1041                         load_attempted = 1;
1042                 /* not about to be ready */
1043                 } else if (!(tape->sense_key == 2 && tape->asc == 4 &&
1044                              (tape->ascq == 1 || tape->ascq == 8)))
1045                         return -EIO;
1046                 msleep(100);
1047         }
1048         return -EIO;
1049 }
1050
1051 static int idetape_flush_tape_buffers(ide_drive_t *drive)
1052 {
1053         struct ide_tape_obj *tape = drive->driver_data;
1054         struct ide_atapi_pc pc;
1055         int rc;
1056
1057         idetape_create_write_filemark_cmd(drive, &pc, 0);
1058         rc = ide_queue_pc_tail(drive, tape->disk, &pc);
1059         if (rc)
1060                 return rc;
1061         idetape_wait_ready(drive, 60 * 5 * HZ);
1062         return 0;
1063 }
1064
1065 static void idetape_create_read_position_cmd(struct ide_atapi_pc *pc)
1066 {
1067         ide_init_pc(pc);
1068         pc->c[0] = READ_POSITION;
1069         pc->req_xfer = 20;
1070 }
1071
1072 static int idetape_read_position(ide_drive_t *drive)
1073 {
1074         idetape_tape_t *tape = drive->driver_data;
1075         struct ide_atapi_pc pc;
1076         int position;
1077
1078         debug_log(DBG_PROCS, "Enter %s\n", __func__);
1079
1080         idetape_create_read_position_cmd(&pc);
1081         if (ide_queue_pc_tail(drive, tape->disk, &pc))
1082                 return -1;
1083         position = tape->first_frame;
1084         return position;
1085 }
1086
1087 static void idetape_create_locate_cmd(ide_drive_t *drive,
1088                 struct ide_atapi_pc *pc,
1089                 unsigned int block, u8 partition, int skip)
1090 {
1091         ide_init_pc(pc);
1092         pc->c[0] = POSITION_TO_ELEMENT;
1093         pc->c[1] = 2;
1094         put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[3]);
1095         pc->c[8] = partition;
1096         pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1097 }
1098
1099 static void __ide_tape_discard_merge_buffer(ide_drive_t *drive)
1100 {
1101         idetape_tape_t *tape = drive->driver_data;
1102
1103         if (tape->chrdev_dir != IDETAPE_DIR_READ)
1104                 return;
1105
1106         clear_bit(IDE_AFLAG_FILEMARK, &drive->atapi_flags);
1107         tape->merge_bh_size = 0;
1108         if (tape->merge_bh != NULL) {
1109                 ide_tape_kfree_buffer(tape);
1110                 tape->merge_bh = NULL;
1111         }
1112
1113         tape->chrdev_dir = IDETAPE_DIR_NONE;
1114 }
1115
1116 /*
1117  * Position the tape to the requested block using the LOCATE packet command.
1118  * A READ POSITION command is then issued to check where we are positioned. Like
1119  * all higher level operations, we queue the commands at the tail of the request
1120  * queue and wait for their completion.
1121  */
1122 static int idetape_position_tape(ide_drive_t *drive, unsigned int block,
1123                 u8 partition, int skip)
1124 {
1125         idetape_tape_t *tape = drive->driver_data;
1126         struct gendisk *disk = tape->disk;
1127         int retval;
1128         struct ide_atapi_pc pc;
1129
1130         if (tape->chrdev_dir == IDETAPE_DIR_READ)
1131                 __ide_tape_discard_merge_buffer(drive);
1132         idetape_wait_ready(drive, 60 * 5 * HZ);
1133         idetape_create_locate_cmd(drive, &pc, block, partition, skip);
1134         retval = ide_queue_pc_tail(drive, disk, &pc);
1135         if (retval)
1136                 return (retval);
1137
1138         idetape_create_read_position_cmd(&pc);
1139         return ide_queue_pc_tail(drive, disk, &pc);
1140 }
1141
1142 static void ide_tape_discard_merge_buffer(ide_drive_t *drive,
1143                                           int restore_position)
1144 {
1145         idetape_tape_t *tape = drive->driver_data;
1146         int seek, position;
1147
1148         __ide_tape_discard_merge_buffer(drive);
1149         if (restore_position) {
1150                 position = idetape_read_position(drive);
1151                 seek = position > 0 ? position : 0;
1152                 if (idetape_position_tape(drive, seek, 0, 0)) {
1153                         printk(KERN_INFO "ide-tape: %s: position_tape failed in"
1154                                          " %s\n", tape->name, __func__);
1155                         return;
1156                 }
1157         }
1158 }
1159
1160 /*
1161  * Generate a read/write request for the block device interface and wait for it
1162  * to be serviced.
1163  */
1164 static int idetape_queue_rw_tail(ide_drive_t *drive, int cmd, int blocks,
1165                                  struct idetape_bh *bh)
1166 {
1167         idetape_tape_t *tape = drive->driver_data;
1168         struct request *rq;
1169         int ret, errors;
1170
1171         debug_log(DBG_SENSE, "%s: cmd=%d\n", __func__, cmd);
1172
1173         rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
1174         rq->cmd_type = REQ_TYPE_SPECIAL;
1175         rq->cmd[13] = cmd;
1176         rq->rq_disk = tape->disk;
1177         rq->special = (void *)bh;
1178         rq->sector = tape->first_frame;
1179         rq->nr_sectors = blocks;
1180         rq->current_nr_sectors = blocks;
1181         blk_execute_rq(drive->queue, tape->disk, rq, 0);
1182
1183         errors = rq->errors;
1184         ret = tape->blk_size * (blocks - rq->current_nr_sectors);
1185         blk_put_request(rq);
1186
1187         if ((cmd & (REQ_IDETAPE_READ | REQ_IDETAPE_WRITE)) == 0)
1188                 return 0;
1189
1190         if (tape->merge_bh)
1191                 idetape_init_merge_buffer(tape);
1192         if (errors == IDE_DRV_ERROR_GENERAL)
1193                 return -EIO;
1194         return ret;
1195 }
1196
1197 static void idetape_create_inquiry_cmd(struct ide_atapi_pc *pc)
1198 {
1199         ide_init_pc(pc);
1200         pc->c[0] = INQUIRY;
1201         pc->c[4] = 254;
1202         pc->req_xfer = 254;
1203 }
1204
1205 static void idetape_create_rewind_cmd(ide_drive_t *drive,
1206                 struct ide_atapi_pc *pc)
1207 {
1208         ide_init_pc(pc);
1209         pc->c[0] = REZERO_UNIT;
1210         pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1211 }
1212
1213 static void idetape_create_erase_cmd(struct ide_atapi_pc *pc)
1214 {
1215         ide_init_pc(pc);
1216         pc->c[0] = ERASE;
1217         pc->c[1] = 1;
1218         pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1219 }
1220
1221 static void idetape_create_space_cmd(struct ide_atapi_pc *pc, int count, u8 cmd)
1222 {
1223         ide_init_pc(pc);
1224         pc->c[0] = SPACE;
1225         put_unaligned(cpu_to_be32(count), (unsigned int *) &pc->c[1]);
1226         pc->c[1] = cmd;
1227         pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1228 }
1229
1230 /* Queue up a character device originated write request. */
1231 static int idetape_add_chrdev_write_request(ide_drive_t *drive, int blocks)
1232 {
1233         idetape_tape_t *tape = drive->driver_data;
1234
1235         debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
1236
1237         return idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE,
1238                                      blocks, tape->merge_bh);
1239 }
1240
1241 static void ide_tape_flush_merge_buffer(ide_drive_t *drive)
1242 {
1243         idetape_tape_t *tape = drive->driver_data;
1244         int blocks, min;
1245         struct idetape_bh *bh;
1246
1247         if (tape->chrdev_dir != IDETAPE_DIR_WRITE) {
1248                 printk(KERN_ERR "ide-tape: bug: Trying to empty merge buffer"
1249                                 " but we are not writing.\n");
1250                 return;
1251         }
1252         if (tape->merge_bh_size > tape->buffer_size) {
1253                 printk(KERN_ERR "ide-tape: bug: merge_buffer too big\n");
1254                 tape->merge_bh_size = tape->buffer_size;
1255         }
1256         if (tape->merge_bh_size) {
1257                 blocks = tape->merge_bh_size / tape->blk_size;
1258                 if (tape->merge_bh_size % tape->blk_size) {
1259                         unsigned int i;
1260
1261                         blocks++;
1262                         i = tape->blk_size - tape->merge_bh_size %
1263                                 tape->blk_size;
1264                         bh = tape->bh->b_reqnext;
1265                         while (bh) {
1266                                 atomic_set(&bh->b_count, 0);
1267                                 bh = bh->b_reqnext;
1268                         }
1269                         bh = tape->bh;
1270                         while (i) {
1271                                 if (bh == NULL) {
1272                                         printk(KERN_INFO "ide-tape: bug,"
1273                                                          " bh NULL\n");
1274                                         break;
1275                                 }
1276                                 min = min(i, (unsigned int)(bh->b_size -
1277                                                 atomic_read(&bh->b_count)));
1278                                 memset(bh->b_data + atomic_read(&bh->b_count),
1279                                                 0, min);
1280                                 atomic_add(min, &bh->b_count);
1281                                 i -= min;
1282                                 bh = bh->b_reqnext;
1283                         }
1284                 }
1285                 (void) idetape_add_chrdev_write_request(drive, blocks);
1286                 tape->merge_bh_size = 0;
1287         }
1288         if (tape->merge_bh != NULL) {
1289                 ide_tape_kfree_buffer(tape);
1290                 tape->merge_bh = NULL;
1291         }
1292         tape->chrdev_dir = IDETAPE_DIR_NONE;
1293 }
1294
1295 static int idetape_init_read(ide_drive_t *drive)
1296 {
1297         idetape_tape_t *tape = drive->driver_data;
1298         int bytes_read;
1299
1300         /* Initialize read operation */
1301         if (tape->chrdev_dir != IDETAPE_DIR_READ) {
1302                 if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
1303                         ide_tape_flush_merge_buffer(drive);
1304                         idetape_flush_tape_buffers(drive);
1305                 }
1306                 if (tape->merge_bh || tape->merge_bh_size) {
1307                         printk(KERN_ERR "ide-tape: merge_bh_size should be"
1308                                          " 0 now\n");
1309                         tape->merge_bh_size = 0;
1310                 }
1311                 tape->merge_bh = ide_tape_kmalloc_buffer(tape, 0, 0);
1312                 if (!tape->merge_bh)
1313                         return -ENOMEM;
1314                 tape->chrdev_dir = IDETAPE_DIR_READ;
1315
1316                 /*
1317                  * Issue a read 0 command to ensure that DSC handshake is
1318                  * switched from completion mode to buffer available mode.
1319                  * No point in issuing this if DSC overlap isn't supported, some
1320                  * drives (Seagate STT3401A) will return an error.
1321                  */
1322                 if (drive->dev_flags & IDE_DFLAG_DSC_OVERLAP) {
1323                         bytes_read = idetape_queue_rw_tail(drive,
1324                                                         REQ_IDETAPE_READ, 0,
1325                                                         tape->merge_bh);
1326                         if (bytes_read < 0) {
1327                                 ide_tape_kfree_buffer(tape);
1328                                 tape->merge_bh = NULL;
1329                                 tape->chrdev_dir = IDETAPE_DIR_NONE;
1330                                 return bytes_read;
1331                         }
1332                 }
1333         }
1334
1335         return 0;
1336 }
1337
1338 /* called from idetape_chrdev_read() to service a chrdev read request. */
1339 static int idetape_add_chrdev_read_request(ide_drive_t *drive, int blocks)
1340 {
1341         idetape_tape_t *tape = drive->driver_data;
1342
1343         debug_log(DBG_PROCS, "Enter %s, %d blocks\n", __func__, blocks);
1344
1345         /* If we are at a filemark, return a read length of 0 */
1346         if (test_bit(IDE_AFLAG_FILEMARK, &drive->atapi_flags))
1347                 return 0;
1348
1349         idetape_init_read(drive);
1350
1351         return idetape_queue_rw_tail(drive, REQ_IDETAPE_READ, blocks,
1352                                      tape->merge_bh);
1353 }
1354
1355 static void idetape_pad_zeros(ide_drive_t *drive, int bcount)
1356 {
1357         idetape_tape_t *tape = drive->driver_data;
1358         struct idetape_bh *bh;
1359         int blocks;
1360
1361         while (bcount) {
1362                 unsigned int count;
1363
1364                 bh = tape->merge_bh;
1365                 count = min(tape->buffer_size, bcount);
1366                 bcount -= count;
1367                 blocks = count / tape->blk_size;
1368                 while (count) {
1369                         atomic_set(&bh->b_count,
1370                                    min(count, (unsigned int)bh->b_size));
1371                         memset(bh->b_data, 0, atomic_read(&bh->b_count));
1372                         count -= atomic_read(&bh->b_count);
1373                         bh = bh->b_reqnext;
1374                 }
1375                 idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE, blocks,
1376                                       tape->merge_bh);
1377         }
1378 }
1379
1380 /*
1381  * Rewinds the tape to the Beginning Of the current Partition (BOP). We
1382  * currently support only one partition.
1383  */
1384 static int idetape_rewind_tape(ide_drive_t *drive)
1385 {
1386         struct ide_tape_obj *tape = drive->driver_data;
1387         struct gendisk *disk = tape->disk;
1388         int retval;
1389         struct ide_atapi_pc pc;
1390
1391         debug_log(DBG_SENSE, "Enter %s\n", __func__);
1392
1393         idetape_create_rewind_cmd(drive, &pc);
1394         retval = ide_queue_pc_tail(drive, disk, &pc);
1395         if (retval)
1396                 return retval;
1397
1398         idetape_create_read_position_cmd(&pc);
1399         retval = ide_queue_pc_tail(drive, disk, &pc);
1400         if (retval)
1401                 return retval;
1402         return 0;
1403 }
1404
1405 /* mtio.h compatible commands should be issued to the chrdev interface. */
1406 static int idetape_blkdev_ioctl(ide_drive_t *drive, unsigned int cmd,
1407                                 unsigned long arg)
1408 {
1409         idetape_tape_t *tape = drive->driver_data;
1410         void __user *argp = (void __user *)arg;
1411
1412         struct idetape_config {
1413                 int dsc_rw_frequency;
1414                 int dsc_media_access_frequency;
1415                 int nr_stages;
1416         } config;
1417
1418         debug_log(DBG_PROCS, "Enter %s\n", __func__);
1419
1420         switch (cmd) {
1421         case 0x0340:
1422                 if (copy_from_user(&config, argp, sizeof(config)))
1423                         return -EFAULT;
1424                 tape->best_dsc_rw_freq = config.dsc_rw_frequency;
1425                 break;
1426         case 0x0350:
1427                 config.dsc_rw_frequency = (int) tape->best_dsc_rw_freq;
1428                 config.nr_stages = 1;
1429                 if (copy_to_user(argp, &config, sizeof(config)))
1430                         return -EFAULT;
1431                 break;
1432         default:
1433                 return -EIO;
1434         }
1435         return 0;
1436 }
1437
1438 static int idetape_space_over_filemarks(ide_drive_t *drive, short mt_op,
1439                                         int mt_count)
1440 {
1441         idetape_tape_t *tape = drive->driver_data;
1442         struct gendisk *disk = tape->disk;
1443         struct ide_atapi_pc pc;
1444         int retval, count = 0;
1445         int sprev = !!(tape->caps[4] & 0x20);
1446
1447         if (mt_count == 0)
1448                 return 0;
1449         if (MTBSF == mt_op || MTBSFM == mt_op) {
1450                 if (!sprev)
1451                         return -EIO;
1452                 mt_count = -mt_count;
1453         }
1454
1455         if (tape->chrdev_dir == IDETAPE_DIR_READ) {
1456                 tape->merge_bh_size = 0;
1457                 if (test_and_clear_bit(IDE_AFLAG_FILEMARK, &drive->atapi_flags))
1458                         ++count;
1459                 ide_tape_discard_merge_buffer(drive, 0);
1460         }
1461
1462         switch (mt_op) {
1463         case MTFSF:
1464         case MTBSF:
1465                 idetape_create_space_cmd(&pc, mt_count - count,
1466                                          IDETAPE_SPACE_OVER_FILEMARK);
1467                 return ide_queue_pc_tail(drive, disk, &pc);
1468         case MTFSFM:
1469         case MTBSFM:
1470                 if (!sprev)
1471                         return -EIO;
1472                 retval = idetape_space_over_filemarks(drive, MTFSF,
1473                                                       mt_count - count);
1474                 if (retval)
1475                         return retval;
1476                 count = (MTBSFM == mt_op ? 1 : -1);
1477                 return idetape_space_over_filemarks(drive, MTFSF, count);
1478         default:
1479                 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
1480                                 mt_op);
1481                 return -EIO;
1482         }
1483 }
1484
1485 /*
1486  * Our character device read / write functions.
1487  *
1488  * The tape is optimized to maximize throughput when it is transferring an
1489  * integral number of the "continuous transfer limit", which is a parameter of
1490  * the specific tape (26kB on my particular tape, 32kB for Onstream).
1491  *
1492  * As of version 1.3 of the driver, the character device provides an abstract
1493  * continuous view of the media - any mix of block sizes (even 1 byte) on the
1494  * same backup/restore procedure is supported. The driver will internally
1495  * convert the requests to the recommended transfer unit, so that an unmatch
1496  * between the user's block size to the recommended size will only result in a
1497  * (slightly) increased driver overhead, but will no longer hit performance.
1498  * This is not applicable to Onstream.
1499  */
1500 static ssize_t idetape_chrdev_read(struct file *file, char __user *buf,
1501                                    size_t count, loff_t *ppos)
1502 {
1503         struct ide_tape_obj *tape = file->private_data;
1504         ide_drive_t *drive = tape->drive;
1505         ssize_t bytes_read, temp, actually_read = 0, rc;
1506         ssize_t ret = 0;
1507         u16 ctl = *(u16 *)&tape->caps[12];
1508
1509         debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
1510
1511         if (tape->chrdev_dir != IDETAPE_DIR_READ) {
1512                 if (test_bit(IDE_AFLAG_DETECT_BS, &drive->atapi_flags))
1513                         if (count > tape->blk_size &&
1514                             (count % tape->blk_size) == 0)
1515                                 tape->user_bs_factor = count / tape->blk_size;
1516         }
1517         rc = idetape_init_read(drive);
1518         if (rc < 0)
1519                 return rc;
1520         if (count == 0)
1521                 return (0);
1522         if (tape->merge_bh_size) {
1523                 actually_read = min((unsigned int)(tape->merge_bh_size),
1524                                     (unsigned int)count);
1525                 if (idetape_copy_stage_to_user(tape, buf, actually_read))
1526                         ret = -EFAULT;
1527                 buf += actually_read;
1528                 tape->merge_bh_size -= actually_read;
1529                 count -= actually_read;
1530         }
1531         while (count >= tape->buffer_size) {
1532                 bytes_read = idetape_add_chrdev_read_request(drive, ctl);
1533                 if (bytes_read <= 0)
1534                         goto finish;
1535                 if (idetape_copy_stage_to_user(tape, buf, bytes_read))
1536                         ret = -EFAULT;
1537                 buf += bytes_read;
1538                 count -= bytes_read;
1539                 actually_read += bytes_read;
1540         }
1541         if (count) {
1542                 bytes_read = idetape_add_chrdev_read_request(drive, ctl);
1543                 if (bytes_read <= 0)
1544                         goto finish;
1545                 temp = min((unsigned long)count, (unsigned long)bytes_read);
1546                 if (idetape_copy_stage_to_user(tape, buf, temp))
1547                         ret = -EFAULT;
1548                 actually_read += temp;
1549                 tape->merge_bh_size = bytes_read-temp;
1550         }
1551 finish:
1552         if (!actually_read && test_bit(IDE_AFLAG_FILEMARK, &drive->atapi_flags)) {
1553                 debug_log(DBG_SENSE, "%s: spacing over filemark\n", tape->name);
1554
1555                 idetape_space_over_filemarks(drive, MTFSF, 1);
1556                 return 0;
1557         }
1558
1559         return ret ? ret : actually_read;
1560 }
1561
1562 static ssize_t idetape_chrdev_write(struct file *file, const char __user *buf,
1563                                      size_t count, loff_t *ppos)
1564 {
1565         struct ide_tape_obj *tape = file->private_data;
1566         ide_drive_t *drive = tape->drive;
1567         ssize_t actually_written = 0;
1568         ssize_t ret = 0;
1569         u16 ctl = *(u16 *)&tape->caps[12];
1570
1571         /* The drive is write protected. */
1572         if (tape->write_prot)
1573                 return -EACCES;
1574
1575         debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
1576
1577         /* Initialize write operation */
1578         if (tape->chrdev_dir != IDETAPE_DIR_WRITE) {
1579                 if (tape->chrdev_dir == IDETAPE_DIR_READ)
1580                         ide_tape_discard_merge_buffer(drive, 1);
1581                 if (tape->merge_bh || tape->merge_bh_size) {
1582                         printk(KERN_ERR "ide-tape: merge_bh_size "
1583                                 "should be 0 now\n");
1584                         tape->merge_bh_size = 0;
1585                 }
1586                 tape->merge_bh = ide_tape_kmalloc_buffer(tape, 0, 0);
1587                 if (!tape->merge_bh)
1588                         return -ENOMEM;
1589                 tape->chrdev_dir = IDETAPE_DIR_WRITE;
1590                 idetape_init_merge_buffer(tape);
1591
1592                 /*
1593                  * Issue a write 0 command to ensure that DSC handshake is
1594                  * switched from completion mode to buffer available mode. No
1595                  * point in issuing this if DSC overlap isn't supported, some
1596                  * drives (Seagate STT3401A) will return an error.
1597                  */
1598                 if (drive->dev_flags & IDE_DFLAG_DSC_OVERLAP) {
1599                         ssize_t retval = idetape_queue_rw_tail(drive,
1600                                                         REQ_IDETAPE_WRITE, 0,
1601                                                         tape->merge_bh);
1602                         if (retval < 0) {
1603                                 ide_tape_kfree_buffer(tape);
1604                                 tape->merge_bh = NULL;
1605                                 tape->chrdev_dir = IDETAPE_DIR_NONE;
1606                                 return retval;
1607                         }
1608                 }
1609         }
1610         if (count == 0)
1611                 return (0);
1612         if (tape->merge_bh_size) {
1613                 if (tape->merge_bh_size >= tape->buffer_size) {
1614                         printk(KERN_ERR "ide-tape: bug: merge buf too big\n");
1615                         tape->merge_bh_size = 0;
1616                 }
1617                 actually_written = min((unsigned int)
1618                                 (tape->buffer_size - tape->merge_bh_size),
1619                                 (unsigned int)count);
1620                 if (idetape_copy_stage_from_user(tape, buf, actually_written))
1621                                 ret = -EFAULT;
1622                 buf += actually_written;
1623                 tape->merge_bh_size += actually_written;
1624                 count -= actually_written;
1625
1626                 if (tape->merge_bh_size == tape->buffer_size) {
1627                         ssize_t retval;
1628                         tape->merge_bh_size = 0;
1629                         retval = idetape_add_chrdev_write_request(drive, ctl);
1630                         if (retval <= 0)
1631                                 return (retval);
1632                 }
1633         }
1634         while (count >= tape->buffer_size) {
1635                 ssize_t retval;
1636                 if (idetape_copy_stage_from_user(tape, buf, tape->buffer_size))
1637                         ret = -EFAULT;
1638                 buf += tape->buffer_size;
1639                 count -= tape->buffer_size;
1640                 retval = idetape_add_chrdev_write_request(drive, ctl);
1641                 actually_written += tape->buffer_size;
1642                 if (retval <= 0)
1643                         return (retval);
1644         }
1645         if (count) {
1646                 actually_written += count;
1647                 if (idetape_copy_stage_from_user(tape, buf, count))
1648                         ret = -EFAULT;
1649                 tape->merge_bh_size += count;
1650         }
1651         return ret ? ret : actually_written;
1652 }
1653
1654 static int idetape_write_filemark(ide_drive_t *drive)
1655 {
1656         struct ide_tape_obj *tape = drive->driver_data;
1657         struct ide_atapi_pc pc;
1658
1659         /* Write a filemark */
1660         idetape_create_write_filemark_cmd(drive, &pc, 1);
1661         if (ide_queue_pc_tail(drive, tape->disk, &pc)) {
1662                 printk(KERN_ERR "ide-tape: Couldn't write a filemark\n");
1663                 return -EIO;
1664         }
1665         return 0;
1666 }
1667
1668 /*
1669  * Called from idetape_chrdev_ioctl when the general mtio MTIOCTOP ioctl is
1670  * requested.
1671  *
1672  * Note: MTBSF and MTBSFM are not supported when the tape doesn't support
1673  * spacing over filemarks in the reverse direction. In this case, MTFSFM is also
1674  * usually not supported.
1675  *
1676  * The following commands are currently not supported:
1677  *
1678  * MTFSS, MTBSS, MTWSM, MTSETDENSITY, MTSETDRVBUFFER, MT_ST_BOOLEANS,
1679  * MT_ST_WRITE_THRESHOLD.
1680  */
1681 static int idetape_mtioctop(ide_drive_t *drive, short mt_op, int mt_count)
1682 {
1683         idetape_tape_t *tape = drive->driver_data;
1684         struct gendisk *disk = tape->disk;
1685         struct ide_atapi_pc pc;
1686         int i, retval;
1687
1688         debug_log(DBG_ERR, "Handling MTIOCTOP ioctl: mt_op=%d, mt_count=%d\n",
1689                         mt_op, mt_count);
1690
1691         switch (mt_op) {
1692         case MTFSF:
1693         case MTFSFM:
1694         case MTBSF:
1695         case MTBSFM:
1696                 if (!mt_count)
1697                         return 0;
1698                 return idetape_space_over_filemarks(drive, mt_op, mt_count);
1699         default:
1700                 break;
1701         }
1702
1703         switch (mt_op) {
1704         case MTWEOF:
1705                 if (tape->write_prot)
1706                         return -EACCES;
1707                 ide_tape_discard_merge_buffer(drive, 1);
1708                 for (i = 0; i < mt_count; i++) {
1709                         retval = idetape_write_filemark(drive);
1710                         if (retval)
1711                                 return retval;
1712                 }
1713                 return 0;
1714         case MTREW:
1715                 ide_tape_discard_merge_buffer(drive, 0);
1716                 if (idetape_rewind_tape(drive))
1717                         return -EIO;
1718                 return 0;
1719         case MTLOAD:
1720                 ide_tape_discard_merge_buffer(drive, 0);
1721                 return ide_do_start_stop(drive, disk, IDETAPE_LU_LOAD_MASK);
1722         case MTUNLOAD:
1723         case MTOFFL:
1724                 /*
1725                  * If door is locked, attempt to unlock before
1726                  * attempting to eject.
1727                  */
1728                 if (tape->door_locked) {
1729                         if (!ide_set_media_lock(drive, disk, 0))
1730                                 tape->door_locked = DOOR_UNLOCKED;
1731                 }
1732                 ide_tape_discard_merge_buffer(drive, 0);
1733                 retval = ide_do_start_stop(drive, disk, !IDETAPE_LU_LOAD_MASK);
1734                 if (!retval)
1735                         clear_bit(IDE_AFLAG_MEDIUM_PRESENT, &drive->atapi_flags);
1736                 return retval;
1737         case MTNOP:
1738                 ide_tape_discard_merge_buffer(drive, 0);
1739                 return idetape_flush_tape_buffers(drive);
1740         case MTRETEN:
1741                 ide_tape_discard_merge_buffer(drive, 0);
1742                 return ide_do_start_stop(drive, disk,
1743                         IDETAPE_LU_RETENSION_MASK | IDETAPE_LU_LOAD_MASK);
1744         case MTEOM:
1745                 idetape_create_space_cmd(&pc, 0, IDETAPE_SPACE_TO_EOD);
1746                 return ide_queue_pc_tail(drive, disk, &pc);
1747         case MTERASE:
1748                 (void)idetape_rewind_tape(drive);
1749                 idetape_create_erase_cmd(&pc);
1750                 return ide_queue_pc_tail(drive, disk, &pc);
1751         case MTSETBLK:
1752                 if (mt_count) {
1753                         if (mt_count < tape->blk_size ||
1754                             mt_count % tape->blk_size)
1755                                 return -EIO;
1756                         tape->user_bs_factor = mt_count / tape->blk_size;
1757                         clear_bit(IDE_AFLAG_DETECT_BS, &drive->atapi_flags);
1758                 } else
1759                         set_bit(IDE_AFLAG_DETECT_BS, &drive->atapi_flags);
1760                 return 0;
1761         case MTSEEK:
1762                 ide_tape_discard_merge_buffer(drive, 0);
1763                 return idetape_position_tape(drive,
1764                         mt_count * tape->user_bs_factor, tape->partition, 0);
1765         case MTSETPART:
1766                 ide_tape_discard_merge_buffer(drive, 0);
1767                 return idetape_position_tape(drive, 0, mt_count, 0);
1768         case MTFSR:
1769         case MTBSR:
1770         case MTLOCK:
1771                 retval = ide_set_media_lock(drive, disk, 1);
1772                 if (retval)
1773                         return retval;
1774                 tape->door_locked = DOOR_EXPLICITLY_LOCKED;
1775                 return 0;
1776         case MTUNLOCK:
1777                 retval = ide_set_media_lock(drive, disk, 0);
1778                 if (retval)
1779                         return retval;
1780                 tape->door_locked = DOOR_UNLOCKED;
1781                 return 0;
1782         default:
1783                 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
1784                                 mt_op);
1785                 return -EIO;
1786         }
1787 }
1788
1789 /*
1790  * Our character device ioctls. General mtio.h magnetic io commands are
1791  * supported here, and not in the corresponding block interface. Our own
1792  * ide-tape ioctls are supported on both interfaces.
1793  */
1794 static int idetape_chrdev_ioctl(struct inode *inode, struct file *file,
1795                                 unsigned int cmd, unsigned long arg)
1796 {
1797         struct ide_tape_obj *tape = file->private_data;
1798         ide_drive_t *drive = tape->drive;
1799         struct mtop mtop;
1800         struct mtget mtget;
1801         struct mtpos mtpos;
1802         int block_offset = 0, position = tape->first_frame;
1803         void __user *argp = (void __user *)arg;
1804
1805         debug_log(DBG_CHRDEV, "Enter %s, cmd=%u\n", __func__, cmd);
1806
1807         if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
1808                 ide_tape_flush_merge_buffer(drive);
1809                 idetape_flush_tape_buffers(drive);
1810         }
1811         if (cmd == MTIOCGET || cmd == MTIOCPOS) {
1812                 block_offset = tape->merge_bh_size /
1813                         (tape->blk_size * tape->user_bs_factor);
1814                 position = idetape_read_position(drive);
1815                 if (position < 0)
1816                         return -EIO;
1817         }
1818         switch (cmd) {
1819         case MTIOCTOP:
1820                 if (copy_from_user(&mtop, argp, sizeof(struct mtop)))
1821                         return -EFAULT;
1822                 return idetape_mtioctop(drive, mtop.mt_op, mtop.mt_count);
1823         case MTIOCGET:
1824                 memset(&mtget, 0, sizeof(struct mtget));
1825                 mtget.mt_type = MT_ISSCSI2;
1826                 mtget.mt_blkno = position / tape->user_bs_factor - block_offset;
1827                 mtget.mt_dsreg =
1828                         ((tape->blk_size * tape->user_bs_factor)
1829                          << MT_ST_BLKSIZE_SHIFT) & MT_ST_BLKSIZE_MASK;
1830
1831                 if (tape->drv_write_prot)
1832                         mtget.mt_gstat |= GMT_WR_PROT(0xffffffff);
1833
1834                 if (copy_to_user(argp, &mtget, sizeof(struct mtget)))
1835                         return -EFAULT;
1836                 return 0;
1837         case MTIOCPOS:
1838                 mtpos.mt_blkno = position / tape->user_bs_factor - block_offset;
1839                 if (copy_to_user(argp, &mtpos, sizeof(struct mtpos)))
1840                         return -EFAULT;
1841                 return 0;
1842         default:
1843                 if (tape->chrdev_dir == IDETAPE_DIR_READ)
1844                         ide_tape_discard_merge_buffer(drive, 1);
1845                 return idetape_blkdev_ioctl(drive, cmd, arg);
1846         }
1847 }
1848
1849 /*
1850  * Do a mode sense page 0 with block descriptor and if it succeeds set the tape
1851  * block size with the reported value.
1852  */
1853 static void ide_tape_get_bsize_from_bdesc(ide_drive_t *drive)
1854 {
1855         idetape_tape_t *tape = drive->driver_data;
1856         struct ide_atapi_pc pc;
1857
1858         idetape_create_mode_sense_cmd(&pc, IDETAPE_BLOCK_DESCRIPTOR);
1859         if (ide_queue_pc_tail(drive, tape->disk, &pc)) {
1860                 printk(KERN_ERR "ide-tape: Can't get block descriptor\n");
1861                 if (tape->blk_size == 0) {
1862                         printk(KERN_WARNING "ide-tape: Cannot deal with zero "
1863                                             "block size, assuming 32k\n");
1864                         tape->blk_size = 32768;
1865                 }
1866                 return;
1867         }
1868         tape->blk_size = (pc.buf[4 + 5] << 16) +
1869                                 (pc.buf[4 + 6] << 8)  +
1870                                  pc.buf[4 + 7];
1871         tape->drv_write_prot = (pc.buf[2] & 0x80) >> 7;
1872 }
1873
1874 static int idetape_chrdev_open(struct inode *inode, struct file *filp)
1875 {
1876         unsigned int minor = iminor(inode), i = minor & ~0xc0;
1877         ide_drive_t *drive;
1878         idetape_tape_t *tape;
1879         int retval;
1880
1881         if (i >= MAX_HWIFS * MAX_DRIVES)
1882                 return -ENXIO;
1883
1884         lock_kernel();
1885         tape = ide_tape_chrdev_get(i);
1886         if (!tape) {
1887                 unlock_kernel();
1888                 return -ENXIO;
1889         }
1890
1891         debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
1892
1893         /*
1894          * We really want to do nonseekable_open(inode, filp); here, but some
1895          * versions of tar incorrectly call lseek on tapes and bail out if that
1896          * fails.  So we disallow pread() and pwrite(), but permit lseeks.
1897          */
1898         filp->f_mode &= ~(FMODE_PREAD | FMODE_PWRITE);
1899
1900         drive = tape->drive;
1901
1902         filp->private_data = tape;
1903
1904         if (test_and_set_bit(IDE_AFLAG_BUSY, &drive->atapi_flags)) {
1905                 retval = -EBUSY;
1906                 goto out_put_tape;
1907         }
1908
1909         retval = idetape_wait_ready(drive, 60 * HZ);
1910         if (retval) {
1911                 clear_bit(IDE_AFLAG_BUSY, &drive->atapi_flags);
1912                 printk(KERN_ERR "ide-tape: %s: drive not ready\n", tape->name);
1913                 goto out_put_tape;
1914         }
1915
1916         idetape_read_position(drive);
1917         if (!test_bit(IDE_AFLAG_ADDRESS_VALID, &drive->atapi_flags))
1918                 (void)idetape_rewind_tape(drive);
1919
1920         /* Read block size and write protect status from drive. */
1921         ide_tape_get_bsize_from_bdesc(drive);
1922
1923         /* Set write protect flag if device is opened as read-only. */
1924         if ((filp->f_flags & O_ACCMODE) == O_RDONLY)
1925                 tape->write_prot = 1;
1926         else
1927                 tape->write_prot = tape->drv_write_prot;
1928
1929         /* Make sure drive isn't write protected if user wants to write. */
1930         if (tape->write_prot) {
1931                 if ((filp->f_flags & O_ACCMODE) == O_WRONLY ||
1932                     (filp->f_flags & O_ACCMODE) == O_RDWR) {
1933                         clear_bit(IDE_AFLAG_BUSY, &drive->atapi_flags);
1934                         retval = -EROFS;
1935                         goto out_put_tape;
1936                 }
1937         }
1938
1939         /* Lock the tape drive door so user can't eject. */
1940         if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
1941                 if (!ide_set_media_lock(drive, tape->disk, 1)) {
1942                         if (tape->door_locked != DOOR_EXPLICITLY_LOCKED)
1943                                 tape->door_locked = DOOR_LOCKED;
1944                 }
1945         }
1946         unlock_kernel();
1947         return 0;
1948
1949 out_put_tape:
1950         ide_tape_put(tape);
1951         unlock_kernel();
1952         return retval;
1953 }
1954
1955 static void idetape_write_release(ide_drive_t *drive, unsigned int minor)
1956 {
1957         idetape_tape_t *tape = drive->driver_data;
1958
1959         ide_tape_flush_merge_buffer(drive);
1960         tape->merge_bh = ide_tape_kmalloc_buffer(tape, 1, 0);
1961         if (tape->merge_bh != NULL) {
1962                 idetape_pad_zeros(drive, tape->blk_size *
1963                                 (tape->user_bs_factor - 1));
1964                 ide_tape_kfree_buffer(tape);
1965                 tape->merge_bh = NULL;
1966         }
1967         idetape_write_filemark(drive);
1968         idetape_flush_tape_buffers(drive);
1969         idetape_flush_tape_buffers(drive);
1970 }
1971
1972 static int idetape_chrdev_release(struct inode *inode, struct file *filp)
1973 {
1974         struct ide_tape_obj *tape = filp->private_data;
1975         ide_drive_t *drive = tape->drive;
1976         unsigned int minor = iminor(inode);
1977
1978         lock_kernel();
1979         tape = drive->driver_data;
1980
1981         debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
1982
1983         if (tape->chrdev_dir == IDETAPE_DIR_WRITE)
1984                 idetape_write_release(drive, minor);
1985         if (tape->chrdev_dir == IDETAPE_DIR_READ) {
1986                 if (minor < 128)
1987                         ide_tape_discard_merge_buffer(drive, 1);
1988         }
1989
1990         if (minor < 128 && test_bit(IDE_AFLAG_MEDIUM_PRESENT, &drive->atapi_flags))
1991                 (void) idetape_rewind_tape(drive);
1992         if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
1993                 if (tape->door_locked == DOOR_LOCKED) {
1994                         if (!ide_set_media_lock(drive, tape->disk, 0))
1995                                 tape->door_locked = DOOR_UNLOCKED;
1996                 }
1997         }
1998         clear_bit(IDE_AFLAG_BUSY, &drive->atapi_flags);
1999         ide_tape_put(tape);
2000         unlock_kernel();
2001         return 0;
2002 }
2003
2004 static void idetape_get_inquiry_results(ide_drive_t *drive)
2005 {
2006         idetape_tape_t *tape = drive->driver_data;
2007         struct ide_atapi_pc pc;
2008         char fw_rev[4], vendor_id[8], product_id[16];
2009
2010         idetape_create_inquiry_cmd(&pc);
2011         if (ide_queue_pc_tail(drive, tape->disk, &pc)) {
2012                 printk(KERN_ERR "ide-tape: %s: can't get INQUIRY results\n",
2013                                 tape->name);
2014                 return;
2015         }
2016         memcpy(vendor_id, &pc.buf[8], 8);
2017         memcpy(product_id, &pc.buf[16], 16);
2018         memcpy(fw_rev, &pc.buf[32], 4);
2019
2020         ide_fixstring(vendor_id, 8, 0);
2021         ide_fixstring(product_id, 16, 0);
2022         ide_fixstring(fw_rev, 4, 0);
2023
2024         printk(KERN_INFO "ide-tape: %s <-> %s: %.8s %.16s rev %.4s\n",
2025                         drive->name, tape->name, vendor_id, product_id, fw_rev);
2026 }
2027
2028 /*
2029  * Ask the tape about its various parameters. In particular, we will adjust our
2030  * data transfer buffer size to the recommended value as returned by the tape.
2031  */
2032 static void idetape_get_mode_sense_results(ide_drive_t *drive)
2033 {
2034         idetape_tape_t *tape = drive->driver_data;
2035         struct ide_atapi_pc pc;
2036         u8 *caps;
2037         u8 speed, max_speed;
2038
2039         idetape_create_mode_sense_cmd(&pc, IDETAPE_CAPABILITIES_PAGE);
2040         if (ide_queue_pc_tail(drive, tape->disk, &pc)) {
2041                 printk(KERN_ERR "ide-tape: Can't get tape parameters - assuming"
2042                                 " some default values\n");
2043                 tape->blk_size = 512;
2044                 put_unaligned(52,   (u16 *)&tape->caps[12]);
2045                 put_unaligned(540,  (u16 *)&tape->caps[14]);
2046                 put_unaligned(6*52, (u16 *)&tape->caps[16]);
2047                 return;
2048         }
2049         caps = pc.buf + 4 + pc.buf[3];
2050
2051         /* convert to host order and save for later use */
2052         speed = be16_to_cpup((__be16 *)&caps[14]);
2053         max_speed = be16_to_cpup((__be16 *)&caps[8]);
2054
2055         *(u16 *)&caps[8] = max_speed;
2056         *(u16 *)&caps[12] = be16_to_cpup((__be16 *)&caps[12]);
2057         *(u16 *)&caps[14] = speed;
2058         *(u16 *)&caps[16] = be16_to_cpup((__be16 *)&caps[16]);
2059
2060         if (!speed) {
2061                 printk(KERN_INFO "ide-tape: %s: invalid tape speed "
2062                                 "(assuming 650KB/sec)\n", drive->name);
2063                 *(u16 *)&caps[14] = 650;
2064         }
2065         if (!max_speed) {
2066                 printk(KERN_INFO "ide-tape: %s: invalid max_speed "
2067                                 "(assuming 650KB/sec)\n", drive->name);
2068                 *(u16 *)&caps[8] = 650;
2069         }
2070
2071         memcpy(&tape->caps, caps, 20);
2072
2073         /* device lacks locking support according to capabilities page */
2074         if ((caps[6] & 1) == 0)
2075                 drive->dev_flags &= ~IDE_DFLAG_DOORLOCKING;
2076
2077         if (caps[7] & 0x02)
2078                 tape->blk_size = 512;
2079         else if (caps[7] & 0x04)
2080                 tape->blk_size = 1024;
2081 }
2082
2083 #ifdef CONFIG_IDE_PROC_FS
2084 #define ide_tape_devset_get(name, field) \
2085 static int get_##name(ide_drive_t *drive) \
2086 { \
2087         idetape_tape_t *tape = drive->driver_data; \
2088         return tape->field; \
2089 }
2090
2091 #define ide_tape_devset_set(name, field) \
2092 static int set_##name(ide_drive_t *drive, int arg) \
2093 { \
2094         idetape_tape_t *tape = drive->driver_data; \
2095         tape->field = arg; \
2096         return 0; \
2097 }
2098
2099 #define ide_tape_devset_rw_field(_name, _field) \
2100 ide_tape_devset_get(_name, _field) \
2101 ide_tape_devset_set(_name, _field) \
2102 IDE_DEVSET(_name, DS_SYNC, get_##_name, set_##_name)
2103
2104 #define ide_tape_devset_r_field(_name, _field) \
2105 ide_tape_devset_get(_name, _field) \
2106 IDE_DEVSET(_name, 0, get_##_name, NULL)
2107
2108 static int mulf_tdsc(ide_drive_t *drive)        { return 1000; }
2109 static int divf_tdsc(ide_drive_t *drive)        { return   HZ; }
2110 static int divf_buffer(ide_drive_t *drive)      { return    2; }
2111 static int divf_buffer_size(ide_drive_t *drive) { return 1024; }
2112
2113 ide_devset_rw_flag(dsc_overlap, IDE_DFLAG_DSC_OVERLAP);
2114
2115 ide_tape_devset_rw_field(debug_mask, debug_mask);
2116 ide_tape_devset_rw_field(tdsc, best_dsc_rw_freq);
2117
2118 ide_tape_devset_r_field(avg_speed, avg_speed);
2119 ide_tape_devset_r_field(speed, caps[14]);
2120 ide_tape_devset_r_field(buffer, caps[16]);
2121 ide_tape_devset_r_field(buffer_size, buffer_size);
2122
2123 static const struct ide_proc_devset idetape_settings[] = {
2124         __IDE_PROC_DEVSET(avg_speed,    0, 0xffff, NULL, NULL),
2125         __IDE_PROC_DEVSET(buffer,       0, 0xffff, NULL, divf_buffer),
2126         __IDE_PROC_DEVSET(buffer_size,  0, 0xffff, NULL, divf_buffer_size),
2127         __IDE_PROC_DEVSET(debug_mask,   0, 0xffff, NULL, NULL),
2128         __IDE_PROC_DEVSET(dsc_overlap,  0,      1, NULL, NULL),
2129         __IDE_PROC_DEVSET(speed,        0, 0xffff, NULL, NULL),
2130         __IDE_PROC_DEVSET(tdsc,         IDETAPE_DSC_RW_MIN, IDETAPE_DSC_RW_MAX,
2131                                         mulf_tdsc, divf_tdsc),
2132         { NULL },
2133 };
2134 #endif
2135
2136 /*
2137  * The function below is called to:
2138  *
2139  * 1. Initialize our various state variables.
2140  * 2. Ask the tape for its capabilities.
2141  * 3. Allocate a buffer which will be used for data transfer. The buffer size
2142  * is chosen based on the recommendation which we received in step 2.
2143  *
2144  * Note that at this point ide.c already assigned us an irq, so that we can
2145  * queue requests here and wait for their completion.
2146  */
2147 static void idetape_setup(ide_drive_t *drive, idetape_tape_t *tape, int minor)
2148 {
2149         unsigned long t;
2150         int speed;
2151         int buffer_size;
2152         u16 *ctl = (u16 *)&tape->caps[12];
2153
2154         drive->pc_callback       = ide_tape_callback;
2155         drive->pc_update_buffers = idetape_update_buffers;
2156         drive->pc_io_buffers     = ide_tape_io_buffers;
2157
2158         drive->dev_flags |= IDE_DFLAG_DSC_OVERLAP;
2159
2160         if (drive->hwif->host_flags & IDE_HFLAG_NO_DSC) {
2161                 printk(KERN_INFO "ide-tape: %s: disabling DSC overlap\n",
2162                                  tape->name);
2163                 drive->dev_flags &= ~IDE_DFLAG_DSC_OVERLAP;
2164         }
2165
2166         /* Seagate Travan drives do not support DSC overlap. */
2167         if (strstr((char *)&drive->id[ATA_ID_PROD], "Seagate STT3401"))
2168                 drive->dev_flags &= ~IDE_DFLAG_DSC_OVERLAP;
2169
2170         tape->minor = minor;
2171         tape->name[0] = 'h';
2172         tape->name[1] = 't';
2173         tape->name[2] = '0' + minor;
2174         tape->chrdev_dir = IDETAPE_DIR_NONE;
2175
2176         idetape_get_inquiry_results(drive);
2177         idetape_get_mode_sense_results(drive);
2178         ide_tape_get_bsize_from_bdesc(drive);
2179         tape->user_bs_factor = 1;
2180         tape->buffer_size = *ctl * tape->blk_size;
2181         while (tape->buffer_size > 0xffff) {
2182                 printk(KERN_NOTICE "ide-tape: decreasing stage size\n");
2183                 *ctl /= 2;
2184                 tape->buffer_size = *ctl * tape->blk_size;
2185         }
2186         buffer_size = tape->buffer_size;
2187         tape->pages_per_buffer = buffer_size / PAGE_SIZE;
2188         if (buffer_size % PAGE_SIZE) {
2189                 tape->pages_per_buffer++;
2190                 tape->excess_bh_size = PAGE_SIZE - buffer_size % PAGE_SIZE;
2191         }
2192
2193         /* select the "best" DSC read/write polling freq */
2194         speed = max(*(u16 *)&tape->caps[14], *(u16 *)&tape->caps[8]);
2195
2196         t = (IDETAPE_FIFO_THRESHOLD * tape->buffer_size * HZ) / (speed * 1000);
2197
2198         /*
2199          * Ensure that the number we got makes sense; limit it within
2200          * IDETAPE_DSC_RW_MIN and IDETAPE_DSC_RW_MAX.
2201          */
2202         tape->best_dsc_rw_freq = clamp_t(unsigned long, t, IDETAPE_DSC_RW_MIN,
2203                                          IDETAPE_DSC_RW_MAX);
2204         printk(KERN_INFO "ide-tape: %s <-> %s: %dKBps, %d*%dkB buffer, "
2205                 "%lums tDSC%s\n",
2206                 drive->name, tape->name, *(u16 *)&tape->caps[14],
2207                 (*(u16 *)&tape->caps[16] * 512) / tape->buffer_size,
2208                 tape->buffer_size / 1024,
2209                 tape->best_dsc_rw_freq * 1000 / HZ,
2210                 (drive->dev_flags & IDE_DFLAG_USING_DMA) ? ", DMA" : "");
2211
2212         ide_proc_register_driver(drive, tape->driver);
2213 }
2214
2215 static void ide_tape_remove(ide_drive_t *drive)
2216 {
2217         idetape_tape_t *tape = drive->driver_data;
2218
2219         ide_proc_unregister_driver(drive, tape->driver);
2220         device_del(&tape->dev);
2221         ide_unregister_region(tape->disk);
2222
2223         mutex_lock(&idetape_ref_mutex);
2224         put_device(&tape->dev);
2225         mutex_unlock(&idetape_ref_mutex);
2226 }
2227
2228 static void ide_tape_release(struct device *dev)
2229 {
2230         struct ide_tape_obj *tape = to_ide_drv(dev, ide_tape_obj);
2231         ide_drive_t *drive = tape->drive;
2232         struct gendisk *g = tape->disk;
2233
2234         BUG_ON(tape->merge_bh_size);
2235
2236         drive->dev_flags &= ~IDE_DFLAG_DSC_OVERLAP;
2237         drive->driver_data = NULL;
2238         device_destroy(idetape_sysfs_class, MKDEV(IDETAPE_MAJOR, tape->minor));
2239         device_destroy(idetape_sysfs_class,
2240                         MKDEV(IDETAPE_MAJOR, tape->minor + 128));
2241         idetape_devs[tape->minor] = NULL;
2242         g->private_data = NULL;
2243         put_disk(g);
2244         kfree(tape);
2245 }
2246
2247 #ifdef CONFIG_IDE_PROC_FS
2248 static int proc_idetape_read_name
2249         (char *page, char **start, off_t off, int count, int *eof, void *data)
2250 {
2251         ide_drive_t     *drive = (ide_drive_t *) data;
2252         idetape_tape_t  *tape = drive->driver_data;
2253         char            *out = page;
2254         int             len;
2255
2256         len = sprintf(out, "%s\n", tape->name);
2257         PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
2258 }
2259
2260 static ide_proc_entry_t idetape_proc[] = {
2261         { "capacity",   S_IFREG|S_IRUGO,        proc_ide_read_capacity, NULL },
2262         { "name",       S_IFREG|S_IRUGO,        proc_idetape_read_name, NULL },
2263         { NULL, 0, NULL, NULL }
2264 };
2265
2266 static ide_proc_entry_t *ide_tape_proc_entries(ide_drive_t *drive)
2267 {
2268         return idetape_proc;
2269 }
2270
2271 static const struct ide_proc_devset *ide_tape_proc_devsets(ide_drive_t *drive)
2272 {
2273         return idetape_settings;
2274 }
2275 #endif
2276
2277 static int ide_tape_probe(ide_drive_t *);
2278
2279 static struct ide_driver idetape_driver = {
2280         .gen_driver = {
2281                 .owner          = THIS_MODULE,
2282                 .name           = "ide-tape",
2283                 .bus            = &ide_bus_type,
2284         },
2285         .probe                  = ide_tape_probe,
2286         .remove                 = ide_tape_remove,
2287         .version                = IDETAPE_VERSION,
2288         .do_request             = idetape_do_request,
2289 #ifdef CONFIG_IDE_PROC_FS
2290         .proc_entries           = ide_tape_proc_entries,
2291         .proc_devsets           = ide_tape_proc_devsets,
2292 #endif
2293 };
2294
2295 /* Our character device supporting functions, passed to register_chrdev. */
2296 static const struct file_operations idetape_fops = {
2297         .owner          = THIS_MODULE,
2298         .read           = idetape_chrdev_read,
2299         .write          = idetape_chrdev_write,
2300         .ioctl          = idetape_chrdev_ioctl,
2301         .open           = idetape_chrdev_open,
2302         .release        = idetape_chrdev_release,
2303 };
2304
2305 static int idetape_open(struct block_device *bdev, fmode_t mode)
2306 {
2307         struct ide_tape_obj *tape = ide_tape_get(bdev->bd_disk);
2308
2309         if (!tape)
2310                 return -ENXIO;
2311
2312         return 0;
2313 }
2314
2315 static int idetape_release(struct gendisk *disk, fmode_t mode)
2316 {
2317         struct ide_tape_obj *tape = ide_drv_g(disk, ide_tape_obj);
2318
2319         ide_tape_put(tape);
2320         return 0;
2321 }
2322
2323 static int idetape_ioctl(struct block_device *bdev, fmode_t mode,
2324                         unsigned int cmd, unsigned long arg)
2325 {
2326         struct ide_tape_obj *tape = ide_drv_g(bdev->bd_disk, ide_tape_obj);
2327         ide_drive_t *drive = tape->drive;
2328         int err = generic_ide_ioctl(drive, bdev, cmd, arg);
2329         if (err == -EINVAL)
2330                 err = idetape_blkdev_ioctl(drive, cmd, arg);
2331         return err;
2332 }
2333
2334 static struct block_device_operations idetape_block_ops = {
2335         .owner          = THIS_MODULE,
2336         .open           = idetape_open,
2337         .release        = idetape_release,
2338         .locked_ioctl   = idetape_ioctl,
2339 };
2340
2341 static int ide_tape_probe(ide_drive_t *drive)
2342 {
2343         idetape_tape_t *tape;
2344         struct gendisk *g;
2345         int minor;
2346
2347         if (!strstr("ide-tape", drive->driver_req))
2348                 goto failed;
2349
2350         if (drive->media != ide_tape)
2351                 goto failed;
2352
2353         if ((drive->dev_flags & IDE_DFLAG_ID_READ) &&
2354             ide_check_atapi_device(drive, DRV_NAME) == 0) {
2355                 printk(KERN_ERR "ide-tape: %s: not supported by this version of"
2356                                 " the driver\n", drive->name);
2357                 goto failed;
2358         }
2359         tape = kzalloc(sizeof(idetape_tape_t), GFP_KERNEL);
2360         if (tape == NULL) {
2361                 printk(KERN_ERR "ide-tape: %s: Can't allocate a tape struct\n",
2362                                 drive->name);
2363                 goto failed;
2364         }
2365
2366         g = alloc_disk(1 << PARTN_BITS);
2367         if (!g)
2368                 goto out_free_tape;
2369
2370         ide_init_disk(g, drive);
2371
2372         tape->dev.parent = &drive->gendev;
2373         tape->dev.release = ide_tape_release;
2374         dev_set_name(&tape->dev, dev_name(&drive->gendev));
2375
2376         if (device_register(&tape->dev))
2377                 goto out_free_disk;
2378
2379         tape->drive = drive;
2380         tape->driver = &idetape_driver;
2381         tape->disk = g;
2382
2383         g->private_data = &tape->driver;
2384
2385         drive->driver_data = tape;
2386
2387         mutex_lock(&idetape_ref_mutex);
2388         for (minor = 0; idetape_devs[minor]; minor++)
2389                 ;
2390         idetape_devs[minor] = tape;
2391         mutex_unlock(&idetape_ref_mutex);
2392
2393         idetape_setup(drive, tape, minor);
2394
2395         device_create(idetape_sysfs_class, &drive->gendev,
2396                       MKDEV(IDETAPE_MAJOR, minor), NULL, "%s", tape->name);
2397         device_create(idetape_sysfs_class, &drive->gendev,
2398                       MKDEV(IDETAPE_MAJOR, minor + 128), NULL,
2399                       "n%s", tape->name);
2400
2401         g->fops = &idetape_block_ops;
2402         ide_register_region(g);
2403
2404         return 0;
2405
2406 out_free_disk:
2407         put_disk(g);
2408 out_free_tape:
2409         kfree(tape);
2410 failed:
2411         return -ENODEV;
2412 }
2413
2414 static void __exit idetape_exit(void)
2415 {
2416         driver_unregister(&idetape_driver.gen_driver);
2417         class_destroy(idetape_sysfs_class);
2418         unregister_chrdev(IDETAPE_MAJOR, "ht");
2419 }
2420
2421 static int __init idetape_init(void)
2422 {
2423         int error = 1;
2424         idetape_sysfs_class = class_create(THIS_MODULE, "ide_tape");
2425         if (IS_ERR(idetape_sysfs_class)) {
2426                 idetape_sysfs_class = NULL;
2427                 printk(KERN_ERR "Unable to create sysfs class for ide tapes\n");
2428                 error = -EBUSY;
2429                 goto out;
2430         }
2431
2432         if (register_chrdev(IDETAPE_MAJOR, "ht", &idetape_fops)) {
2433                 printk(KERN_ERR "ide-tape: Failed to register chrdev"
2434                                 " interface\n");
2435                 error = -EBUSY;
2436                 goto out_free_class;
2437         }
2438
2439         error = driver_register(&idetape_driver.gen_driver);
2440         if (error)
2441                 goto out_free_driver;
2442
2443         return 0;
2444
2445 out_free_driver:
2446         driver_unregister(&idetape_driver.gen_driver);
2447 out_free_class:
2448         class_destroy(idetape_sysfs_class);
2449 out:
2450         return error;
2451 }
2452
2453 MODULE_ALIAS("ide:*m-tape*");
2454 module_init(idetape_init);
2455 module_exit(idetape_exit);
2456 MODULE_ALIAS_CHARDEV_MAJOR(IDETAPE_MAJOR);
2457 MODULE_DESCRIPTION("ATAPI Streaming TAPE Driver");
2458 MODULE_LICENSE("GPL");