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