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