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