ide-tape.c 67.9 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1
/*
2 3
 * IDE ATAPI streaming tape driver.
 *
4 5
 * Copyright (C) 1995-1999  Gadi Oxman <gadio@netvision.net.il>
 * Copyright (C) 2003-2005  Bartlomiej Zolnierkiewicz
Linus Torvalds's avatar
Linus Torvalds committed
6 7 8 9 10 11 12 13
 *
 * This driver was constructed as a student project in the software laboratory
 * of the faculty of electrical engineering in the Technion - Israel's
 * Institute Of Technology, with the guide of Avner Lottem and Dr. Ilana David.
 *
 * It is hereby placed under the terms of the GNU general public license.
 * (See linux/COPYING).
 *
14 15
 * For a historical changelog see
 * Documentation/ide/ChangeLog.ide-tape.1995-2002
Linus Torvalds's avatar
Linus Torvalds committed
16 17
 */

18 19
#define DRV_NAME "ide-tape"

20
#define IDETAPE_VERSION "1.20"
Linus Torvalds's avatar
Linus Torvalds committed
21 22 23 24 25 26 27 28 29

#include <linux/module.h>
#include <linux/types.h>
#include <linux/string.h>
#include <linux/kernel.h>
#include <linux/delay.h>
#include <linux/timer.h>
#include <linux/mm.h>
#include <linux/interrupt.h>
30
#include <linux/jiffies.h>
Linus Torvalds's avatar
Linus Torvalds committed
31 32 33 34 35 36 37 38 39
#include <linux/major.h>
#include <linux/errno.h>
#include <linux/genhd.h>
#include <linux/slab.h>
#include <linux/pci.h>
#include <linux/ide.h>
#include <linux/smp_lock.h>
#include <linux/completion.h>
#include <linux/bitops.h>
40
#include <linux/mutex.h>
41
#include <scsi/scsi.h>
Linus Torvalds's avatar
Linus Torvalds committed
42 43

#include <asm/byteorder.h>
44 45 46
#include <linux/irq.h>
#include <linux/uaccess.h>
#include <linux/io.h>
Linus Torvalds's avatar
Linus Torvalds committed
47 48 49
#include <asm/unaligned.h>
#include <linux/mtio.h>

50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
enum {
	/* output errors only */
	DBG_ERR =		(1 << 0),
	/* output all sense key/asc */
	DBG_SENSE =		(1 << 1),
	/* info regarding all chrdev-related procedures */
	DBG_CHRDEV =		(1 << 2),
	/* all remaining procedures */
	DBG_PROCS =		(1 << 3),
};

/* define to see debug info */
#define IDETAPE_DEBUG_LOG		0

#if IDETAPE_DEBUG_LOG
#define debug_log(lvl, fmt, args...)			\
{							\
	if (tape->debug_mask & lvl)			\
	printk(KERN_INFO "ide-tape: " fmt, ## args);	\
}
#else
#define debug_log(lvl, fmt, args...) do {} while (0)
#endif

Linus Torvalds's avatar
Linus Torvalds committed
74 75
/**************************** Tunable parameters *****************************/
/*
76 77
 * After each failed packet command we issue a request sense command and retry
 * the packet command IDETAPE_MAX_PC_RETRIES times.
Linus Torvalds's avatar
Linus Torvalds committed
78
 *
79
 * Setting IDETAPE_MAX_PC_RETRIES to 0 will disable retries.
Linus Torvalds's avatar
Linus Torvalds committed
80 81 82 83
 */
#define IDETAPE_MAX_PC_RETRIES		3

/*
84 85 86 87
 * The following parameter is used to select the point in the internal tape fifo
 * in which we will start to refill the buffer. Decreasing the following
 * parameter will improve the system's latency and interactive response, while
 * using a high value might improve system throughput.
Linus Torvalds's avatar
Linus Torvalds committed
88
 */
89
#define IDETAPE_FIFO_THRESHOLD		2
Linus Torvalds's avatar
Linus Torvalds committed
90 91

/*
92
 * DSC polling parameters.
Linus Torvalds's avatar
Linus Torvalds committed
93
 *
94 95
 * Polling for DSC (a single bit in the status register) is a very important
 * function in ide-tape. There are two cases in which we poll for DSC:
Linus Torvalds's avatar
Linus Torvalds committed
96
 *
97 98 99 100 101
 * 1. Before a read/write packet command, to ensure that we can transfer data
 * from/to the tape's data buffers, without causing an actual media access.
 * In case the tape is not ready yet, we take out our request from the device
 * request queue, so that ide.c could service requests from the other device
 * on the same interface in the meantime.
Linus Torvalds's avatar
Linus Torvalds committed
102
 *
103 104 105 106 107 108 109 110
 * 2. After the successful initialization of a "media access packet command",
 * which is a command that can take a long time to complete (the interval can
 * range from several seconds to even an hour). Again, we postpone our request
 * in the middle to free the bus for the other device. The polling frequency
 * here should be lower than the read/write frequency since those media access
 * commands are slow. We start from a "fast" frequency - IDETAPE_DSC_MA_FAST
 * (1 second), and if we don't receive DSC after IDETAPE_DSC_MA_THRESHOLD
 * (5 min), we switch it to a lower frequency - IDETAPE_DSC_MA_SLOW (1 min).
Linus Torvalds's avatar
Linus Torvalds committed
111
 *
112 113
 * We also set a timeout for the timer, in case something goes wrong. The
 * timeout should be longer then the maximum execution time of a tape operation.
Linus Torvalds's avatar
Linus Torvalds committed
114
 */
115 116

/* DSC timings. */
Linus Torvalds's avatar
Linus Torvalds committed
117 118 119 120 121 122 123 124 125 126
#define IDETAPE_DSC_RW_MIN		5*HZ/100	/* 50 msec */
#define IDETAPE_DSC_RW_MAX		40*HZ/100	/* 400 msec */
#define IDETAPE_DSC_RW_TIMEOUT		2*60*HZ		/* 2 minutes */
#define IDETAPE_DSC_MA_FAST		2*HZ		/* 2 seconds */
#define IDETAPE_DSC_MA_THRESHOLD	5*60*HZ		/* 5 minutes */
#define IDETAPE_DSC_MA_SLOW		30*HZ		/* 30 seconds */
#define IDETAPE_DSC_MA_TIMEOUT		2*60*60*HZ	/* 2 hours */

/*************************** End of tunable parameters ***********************/

127 128 129 130 131 132
/* tape directions */
enum {
	IDETAPE_DIR_NONE  = (1 << 0),
	IDETAPE_DIR_READ  = (1 << 1),
	IDETAPE_DIR_WRITE = (1 << 2),
};
Linus Torvalds's avatar
Linus Torvalds committed
133 134

struct idetape_bh {
135
	u32 b_size;
Linus Torvalds's avatar
Linus Torvalds committed
136 137 138 139 140
	atomic_t b_count;
	struct idetape_bh *b_reqnext;
	char *b_data;
};

141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
/* Tape door status */
#define DOOR_UNLOCKED			0
#define DOOR_LOCKED			1
#define DOOR_EXPLICITLY_LOCKED		2

/* Some defines for the SPACE command */
#define IDETAPE_SPACE_OVER_FILEMARK	1
#define IDETAPE_SPACE_TO_EOD		3

/* Some defines for the LOAD UNLOAD command */
#define IDETAPE_LU_LOAD_MASK		1
#define IDETAPE_LU_RETENSION_MASK	2
#define IDETAPE_LU_EOT_MASK		4

/* Error codes returned in rq->errors to the higher part of the driver. */
#define IDETAPE_ERROR_GENERAL		101
#define IDETAPE_ERROR_FILEMARK		102
#define IDETAPE_ERROR_EOD		103

/* Structures related to the SELECT SENSE / MODE SENSE packet commands. */
#define IDETAPE_BLOCK_DESCRIPTOR	0
#define IDETAPE_CAPABILITIES_PAGE	0x2a

Linus Torvalds's avatar
Linus Torvalds committed
164
/*
165 166
 * Most of our global data which we need to save even as we leave the driver due
 * to an interrupt or a timer event is stored in the struct defined below.
Linus Torvalds's avatar
Linus Torvalds committed
167 168 169 170 171 172 173 174 175 176 177 178 179 180
 */
typedef struct ide_tape_obj {
	ide_drive_t	*drive;
	ide_driver_t	*driver;
	struct gendisk	*disk;
	struct kref	kref;

	/*
	 *	failed_pc points to the last failed packet command, or contains
	 *	NULL if we do not need to retry any packet command. This is
	 *	required since an additional packet command is needed before the
	 *	retry, to get detailed information on what went wrong.
	 */
	/* Last failed packet command */
181
	struct ide_atapi_pc *failed_pc;
182 183
	/* used by REQ_IDETAPE_{READ,WRITE} requests */
	struct ide_atapi_pc queued_pc;
184

Linus Torvalds's avatar
Linus Torvalds committed
185
	/*
186
	 * DSC polling variables.
Linus Torvalds's avatar
Linus Torvalds committed
187
	 *
188 189 190
	 * While polling for DSC we use postponed_rq to postpone the current
	 * request so that ide.c will be able to service pending requests on the
	 * other device. Note that at most we will have only one DSC (usually
191
	 * data transfer) request in the device request queue.
Linus Torvalds's avatar
Linus Torvalds committed
192 193 194 195 196 197 198
	 */
	struct request *postponed_rq;
	/* The time in which we started polling for DSC */
	unsigned long dsc_polling_start;
	/* Timer used to poll for dsc */
	struct timer_list dsc_timer;
	/* Read/Write dsc polling frequency */
199 200
	unsigned long best_dsc_rw_freq;
	unsigned long dsc_poll_freq;
Linus Torvalds's avatar
Linus Torvalds committed
201 202
	unsigned long dsc_timeout;

203
	/* Read position information */
Linus Torvalds's avatar
Linus Torvalds committed
204 205
	u8 partition;
	/* Current block */
206
	unsigned int first_frame;
Linus Torvalds's avatar
Linus Torvalds committed
207

208
	/* Last error information */
Linus Torvalds's avatar
Linus Torvalds committed
209 210
	u8 sense_key, asc, ascq;

211
	/* Character device operation */
Linus Torvalds's avatar
Linus Torvalds committed
212 213 214 215
	unsigned int minor;
	/* device name */
	char name[4];
	/* Current character device data transfer direction */
216
	u8 chrdev_dir;
Linus Torvalds's avatar
Linus Torvalds committed
217

218 219
	/* tape block size, usually 512 or 1024 bytes */
	unsigned short blk_size;
Linus Torvalds's avatar
Linus Torvalds committed
220
	int user_bs_factor;
221

Linus Torvalds's avatar
Linus Torvalds committed
222
	/* Copy of the tape's Capabilities and Mechanical Page */
223
	u8 caps[20];
Linus Torvalds's avatar
Linus Torvalds committed
224 225

	/*
226
	 * Active data transfer request parameters.
Linus Torvalds's avatar
Linus Torvalds committed
227
	 *
228 229 230
	 * At most, there is only one ide-tape originated data transfer request
	 * in the device request queue. This allows ide.c to easily service
	 * requests from the other device when we postpone our active request.
Linus Torvalds's avatar
Linus Torvalds committed
231
	 */
232

233
	/* Data buffer size chosen based on the tape's recommendation */
234
	int buffer_size;
235 236
	/* merge buffer */
	struct idetape_bh *merge_bh;
237 238
	/* size of the merge buffer */
	int merge_bh_size;
239
	/* pointer to current buffer head within the merge buffer */
Linus Torvalds's avatar
Linus Torvalds committed
240 241 242
	struct idetape_bh *bh;
	char *b_data;
	int b_count;
243

244
	int pages_per_buffer;
Linus Torvalds's avatar
Linus Torvalds committed
245 246 247 248
	/* Wasted space in each stage */
	int excess_bh_size;

	/* protects the ide-tape queue */
249
	spinlock_t lock;
Linus Torvalds's avatar
Linus Torvalds committed
250

251
	/* Measures average tape speed */
Linus Torvalds's avatar
Linus Torvalds committed
252 253 254 255 256 257 258 259 260 261 262
	unsigned long avg_time;
	int avg_size;
	int avg_speed;

	/* the door is currently locked */
	int door_locked;
	/* the tape hardware is write protected */
	char drv_write_prot;
	/* the tape is write protected (hardware or opened as read-only) */
	char write_prot;

263
	u32 debug_mask;
Linus Torvalds's avatar
Linus Torvalds committed
264 265
} idetape_tape_t;

266
static DEFINE_MUTEX(idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
267

268 269
static struct class *idetape_sysfs_class;

Linus Torvalds's avatar
Linus Torvalds committed
270 271 272 273 274
#define to_ide_tape(obj) container_of(obj, struct ide_tape_obj, kref)

#define ide_tape_g(disk) \
	container_of((disk)->private_data, struct ide_tape_obj, driver)

275 276
static void ide_tape_release(struct kref *);

Linus Torvalds's avatar
Linus Torvalds committed
277 278 279 280
static struct ide_tape_obj *ide_tape_get(struct gendisk *disk)
{
	struct ide_tape_obj *tape = NULL;

281
	mutex_lock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
282
	tape = ide_tape_g(disk);
283
	if (tape) {
284
		if (ide_device_get(tape->drive))
285
			tape = NULL;
286 287
		else
			kref_get(&tape->kref);
288
	}
289
	mutex_unlock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
290 291 292 293 294
	return tape;
}

static void ide_tape_put(struct ide_tape_obj *tape)
{
295 296
	ide_drive_t *drive = tape->drive;

297
	mutex_lock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
298
	kref_put(&tape->kref, ide_tape_release);
299
	ide_device_put(drive);
300
	mutex_unlock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
301 302 303
}

/*
304 305
 * The variables below are used for the character device interface. Additional
 * state variables are defined in our ide_drive_t structure.
Linus Torvalds's avatar
Linus Torvalds committed
306
 */
307
static struct ide_tape_obj *idetape_devs[MAX_HWIFS * MAX_DRIVES];
Linus Torvalds's avatar
Linus Torvalds committed
308 309 310 311 312 313 314

#define ide_tape_f(file) ((file)->private_data)

static struct ide_tape_obj *ide_tape_chrdev_get(unsigned int i)
{
	struct ide_tape_obj *tape = NULL;

315
	mutex_lock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
316 317 318
	tape = idetape_devs[i];
	if (tape)
		kref_get(&tape->kref);
319
	mutex_unlock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
320 321 322
	return tape;
}

323
static void idetape_input_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
324
				  unsigned int bcount)
Linus Torvalds's avatar
Linus Torvalds committed
325 326 327 328 329 330 331 332
{
	struct idetape_bh *bh = pc->bh;
	int count;

	while (bcount) {
		if (bh == NULL) {
			printk(KERN_ERR "ide-tape: bh == NULL in "
				"idetape_input_buffers\n");
333
			ide_pad_transfer(drive, 0, bcount);
Linus Torvalds's avatar
Linus Torvalds committed
334 335
			return;
		}
336 337 338
		count = min(
			(unsigned int)(bh->b_size - atomic_read(&bh->b_count)),
			bcount);
339
		drive->hwif->tp_ops->input_data(drive, NULL, bh->b_data +
340
					atomic_read(&bh->b_count), count);
Linus Torvalds's avatar
Linus Torvalds committed
341 342 343 344 345 346 347 348 349 350 351
		bcount -= count;
		atomic_add(count, &bh->b_count);
		if (atomic_read(&bh->b_count) == bh->b_size) {
			bh = bh->b_reqnext;
			if (bh)
				atomic_set(&bh->b_count, 0);
		}
	}
	pc->bh = bh;
}

352
static void idetape_output_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
353
				   unsigned int bcount)
Linus Torvalds's avatar
Linus Torvalds committed
354 355 356 357 358 359
{
	struct idetape_bh *bh = pc->bh;
	int count;

	while (bcount) {
		if (bh == NULL) {
360 361
			printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
					__func__);
Linus Torvalds's avatar
Linus Torvalds committed
362 363 364
			return;
		}
		count = min((unsigned int)pc->b_count, (unsigned int)bcount);
365
		drive->hwif->tp_ops->output_data(drive, NULL, pc->b_data, count);
Linus Torvalds's avatar
Linus Torvalds committed
366 367 368 369
		bcount -= count;
		pc->b_data += count;
		pc->b_count -= count;
		if (!pc->b_count) {
370 371
			bh = bh->b_reqnext;
			pc->bh = bh;
Linus Torvalds's avatar
Linus Torvalds committed
372 373 374 375 376 377 378 379
			if (bh) {
				pc->b_data = bh->b_data;
				pc->b_count = atomic_read(&bh->b_count);
			}
		}
	}
}

380
static void idetape_update_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc)
Linus Torvalds's avatar
Linus Torvalds committed
381 382 383
{
	struct idetape_bh *bh = pc->bh;
	int count;
384
	unsigned int bcount = pc->xferred;
Linus Torvalds's avatar
Linus Torvalds committed
385

386
	if (pc->flags & PC_FLAG_WRITING)
Linus Torvalds's avatar
Linus Torvalds committed
387 388 389
		return;
	while (bcount) {
		if (bh == NULL) {
390 391
			printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
					__func__);
Linus Torvalds's avatar
Linus Torvalds committed
392 393 394 395 396 397 398 399 400 401 402 403
			return;
		}
		count = min((unsigned int)bh->b_size, (unsigned int)bcount);
		atomic_set(&bh->b_count, count);
		if (atomic_read(&bh->b_count) == bh->b_size)
			bh = bh->b_reqnext;
		bcount -= count;
	}
	pc->bh = bh;
}

/*
404 405
 * called on each failed packet command retry to analyze the request sense. We
 * currently do not utilize this information.
Linus Torvalds's avatar
Linus Torvalds committed
406
 */
407
static void idetape_analyze_error(ide_drive_t *drive, u8 *sense)
Linus Torvalds's avatar
Linus Torvalds committed
408 409
{
	idetape_tape_t *tape = drive->driver_data;
410
	struct ide_atapi_pc *pc = tape->failed_pc;
Linus Torvalds's avatar
Linus Torvalds committed
411

412 413 414
	tape->sense_key = sense[2] & 0xF;
	tape->asc       = sense[12];
	tape->ascq      = sense[13];
415 416 417

	debug_log(DBG_ERR, "pc = %x, sense key = %x, asc = %x, ascq = %x\n",
		 pc->c[0], tape->sense_key, tape->asc, tape->ascq);
Linus Torvalds's avatar
Linus Torvalds committed
418

419
	/* Correct pc->xferred by asking the tape.	 */
420
	if (pc->flags & PC_FLAG_DMA_ERROR) {
421
		pc->xferred = pc->req_xfer -
422
			tape->blk_size *
423
			get_unaligned_be32(&sense[3]);
424
		idetape_update_buffers(drive, pc);
Linus Torvalds's avatar
Linus Torvalds committed
425 426 427 428 429 430 431
	}

	/*
	 * If error was the result of a zero-length read or write command,
	 * with sense key=5, asc=0x22, ascq=0, let it slide.  Some drives
	 * (i.e. Seagate STT3401A Travan) don't support 0-length read/writes.
	 */
432
	if ((pc->c[0] == READ_6 || pc->c[0] == WRITE_6)
433 434 435
	    /* length == 0 */
	    && pc->c[4] == 0 && pc->c[3] == 0 && pc->c[2] == 0) {
		if (tape->sense_key == 5) {
Linus Torvalds's avatar
Linus Torvalds committed
436 437 438
			/* don't report an error, everything's ok */
			pc->error = 0;
			/* don't retry read/write */
439
			pc->flags |= PC_FLAG_ABORT;
Linus Torvalds's avatar
Linus Torvalds committed
440 441
		}
	}
442
	if (pc->c[0] == READ_6 && (sense[2] & 0x80)) {
Linus Torvalds's avatar
Linus Torvalds committed
443
		pc->error = IDETAPE_ERROR_FILEMARK;
444
		pc->flags |= PC_FLAG_ABORT;
Linus Torvalds's avatar
Linus Torvalds committed
445
	}
446
	if (pc->c[0] == WRITE_6) {
447 448
		if ((sense[2] & 0x40) || (tape->sense_key == 0xd
		     && tape->asc == 0x0 && tape->ascq == 0x2)) {
Linus Torvalds's avatar
Linus Torvalds committed
449
			pc->error = IDETAPE_ERROR_EOD;
450
			pc->flags |= PC_FLAG_ABORT;
Linus Torvalds's avatar
Linus Torvalds committed
451 452
		}
	}
453
	if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
454
		if (tape->sense_key == 8) {
Linus Torvalds's avatar
Linus Torvalds committed
455
			pc->error = IDETAPE_ERROR_EOD;
456
			pc->flags |= PC_FLAG_ABORT;
Linus Torvalds's avatar
Linus Torvalds committed
457
		}
458
		if (!(pc->flags & PC_FLAG_ABORT) &&
459
		    pc->xferred)
Linus Torvalds's avatar
Linus Torvalds committed
460 461 462 463
			pc->retries = IDETAPE_MAX_PC_RETRIES + 1;
	}
}

464
/* Free data buffers completely. */
465
static void ide_tape_kfree_buffer(idetape_tape_t *tape)
Linus Torvalds's avatar
Linus Torvalds committed
466
{
467
	struct idetape_bh *prev_bh, *bh = tape->merge_bh;
468 469 470 471 472 473 474 475 476 477 478 479

	while (bh) {
		u32 size = bh->b_size;

		while (size) {
			unsigned int order = fls(size >> PAGE_SHIFT)-1;

			if (bh->b_data)
				free_pages((unsigned long)bh->b_data, order);

			size &= (order-1);
			bh->b_data += (1 << order) * PAGE_SIZE;
Linus Torvalds's avatar
Linus Torvalds committed
480 481 482 483 484 485 486 487 488 489 490 491 492 493
		}
		prev_bh = bh;
		bh = bh->b_reqnext;
		kfree(prev_bh);
	}
}

static int idetape_end_request(ide_drive_t *drive, int uptodate, int nr_sects)
{
	struct request *rq = HWGROUP(drive)->rq;
	idetape_tape_t *tape = drive->driver_data;
	unsigned long flags;
	int error;

494
	debug_log(DBG_PROCS, "Enter %s\n", __func__);
Linus Torvalds's avatar
Linus Torvalds committed
495 496

	switch (uptodate) {
497 498 499
	case 0:	error = IDETAPE_ERROR_GENERAL; break;
	case 1: error = 0; break;
	default: error = uptodate;
Linus Torvalds's avatar
Linus Torvalds committed
500 501 502 503 504
	}
	rq->errors = error;
	if (error)
		tape->failed_pc = NULL;

505 506 507 508 509
	if (!blk_special_request(rq)) {
		ide_end_request(drive, uptodate, nr_sects);
		return 0;
	}

510
	spin_lock_irqsave(&tape->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
511 512 513

	ide_end_drive_cmd(drive, 0, 0);

514
	spin_unlock_irqrestore(&tape->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
515 516 517
	return 0;
}

518 519 520
static void ide_tape_handle_dsc(ide_drive_t *);

static void ide_tape_callback(ide_drive_t *drive, int dsc)
Linus Torvalds's avatar
Linus Torvalds committed
521 522
{
	idetape_tape_t *tape = drive->driver_data;
523
	struct ide_atapi_pc *pc = drive->pc;
524
	int uptodate = pc->error ? 0 : 1;
Linus Torvalds's avatar
Linus Torvalds committed
525

526 527
	debug_log(DBG_PROCS, "Enter %s\n", __func__);

528 529 530
	if (dsc)
		ide_tape_handle_dsc(drive);

531 532 533
	if (tape->failed_pc == pc)
		tape->failed_pc = NULL;

534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
	if (pc->c[0] == REQUEST_SENSE) {
		if (uptodate)
			idetape_analyze_error(drive, pc->buf);
		else
			printk(KERN_ERR "ide-tape: Error in REQUEST SENSE "
					"itself - Aborting request!\n");
	} else if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
		struct request *rq = drive->hwif->hwgroup->rq;
		int blocks = pc->xferred / tape->blk_size;

		tape->avg_size += blocks * tape->blk_size;

		if (time_after_eq(jiffies, tape->avg_time + HZ)) {
			tape->avg_speed = tape->avg_size * HZ /
				(jiffies - tape->avg_time) / 1024;
			tape->avg_size = 0;
			tape->avg_time = jiffies;
		}

		tape->first_frame += blocks;
		rq->current_nr_sectors -= blocks;

		if (pc->error)
			uptodate = pc->error;
	} else if (pc->c[0] == READ_POSITION && uptodate) {
559
		u8 *readpos = pc->buf;
560 561 562 563 564 565 566 567 568

		debug_log(DBG_SENSE, "BOP - %s\n",
				(readpos[0] & 0x80) ? "Yes" : "No");
		debug_log(DBG_SENSE, "EOP - %s\n",
				(readpos[0] & 0x40) ? "Yes" : "No");

		if (readpos[0] & 0x4) {
			printk(KERN_INFO "ide-tape: Block location is unknown"
					 "to the tape\n");
569
			clear_bit(IDE_AFLAG_ADDRESS_VALID, &drive->atapi_flags);
570 571 572
			uptodate = 0;
		} else {
			debug_log(DBG_SENSE, "Block Location - %u\n",
573
					be32_to_cpup((__be32 *)&readpos[4]));
574 575

			tape->partition = readpos[1];
576
			tape->first_frame = be32_to_cpup((__be32 *)&readpos[4]);
577
			set_bit(IDE_AFLAG_ADDRESS_VALID, &drive->atapi_flags);
578
		}
Linus Torvalds's avatar
Linus Torvalds committed
579
	}
580 581

	idetape_end_request(drive, uptodate, 0);
Linus Torvalds's avatar
Linus Torvalds committed
582 583
}

584
static void idetape_create_request_sense_cmd(struct ide_atapi_pc *pc)
Linus Torvalds's avatar
Linus Torvalds committed
585
{
586
	ide_init_pc(pc);
587
	pc->c[0] = REQUEST_SENSE;
Linus Torvalds's avatar
Linus Torvalds committed
588
	pc->c[4] = 20;
589
	pc->req_xfer = 20;
Linus Torvalds's avatar
Linus Torvalds committed
590 591 592 593 594 595 596
}

/*
 *	idetape_retry_pc is called when an error was detected during the
 *	last packet command. We queue a request sense packet command in
 *	the head of the request list.
 */
597
static void idetape_retry_pc(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
598
{
599
	struct ide_tape_obj *tape = drive->driver_data;
600 601
	struct request *rq = &drive->request_sense_rq;
	struct ide_atapi_pc *pc = &drive->request_sense_pc;
Linus Torvalds's avatar
Linus Torvalds committed
602

603
	(void)ide_read_error(drive);
Linus Torvalds's avatar
Linus Torvalds committed
604
	idetape_create_request_sense_cmd(pc);
605
	set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
606
	ide_queue_pc_head(drive, tape->disk, pc, rq);
Linus Torvalds's avatar
Linus Torvalds committed
607 608 609
}

/*
610 611
 * Postpone the current request so that ide.c will be able to service requests
 * from another device on the same hwgroup while we are polling for DSC.
Linus Torvalds's avatar
Linus Torvalds committed
612
 */
613
static void idetape_postpone_request(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
614 615 616
{
	idetape_tape_t *tape = drive->driver_data;

617 618
	debug_log(DBG_PROCS, "Enter %s\n", __func__);

Linus Torvalds's avatar
Linus Torvalds committed
619
	tape->postponed_rq = HWGROUP(drive)->rq;
620
	ide_stall_queue(drive, tape->dsc_poll_freq);
Linus Torvalds's avatar
Linus Torvalds committed
621 622
}

623 624 625 626 627 628 629 630 631 632 633 634
static void ide_tape_handle_dsc(ide_drive_t *drive)
{
	idetape_tape_t *tape = drive->driver_data;

	/* Media access command */
	tape->dsc_polling_start = jiffies;
	tape->dsc_poll_freq = IDETAPE_DSC_MA_FAST;
	tape->dsc_timeout = jiffies + IDETAPE_DSC_MA_TIMEOUT;
	/* Allow ide.c to handle other requests */
	idetape_postpone_request(drive);
}

635
static int ide_tape_io_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
636 637 638 639 640 641
				unsigned int bcount, int write)
{
	if (write)
		idetape_output_buffers(drive, pc, bcount);
	else
		idetape_input_buffers(drive, pc, bcount);
642 643

	return bcount;
644
}
645

Linus Torvalds's avatar
Linus Torvalds committed
646
/*
647 648 649 650
 * This is the usual interrupt handler which will be called during a packet
 * command. We will transfer some of the data (as requested by the drive) and
 * will re-point interrupt handler to us. When data transfer is finished, we
 * will act according to the algorithm described before
651
 * idetape_issue_pc.
Linus Torvalds's avatar
Linus Torvalds committed
652
 */
653
static ide_startstop_t idetape_pc_intr(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
654
{
655 656
	return ide_pc_intr(drive, idetape_pc_intr, idetape_update_buffers,
			   idetape_retry_pc, ide_tape_io_buffers);
Linus Torvalds's avatar
Linus Torvalds committed
657 658 659
}

/*
660
 * Packet Command Interface
Linus Torvalds's avatar
Linus Torvalds committed
661
 *
662
 * The current Packet Command is available in drive->pc, and will not change
663 664
 * until we finish handling it. Each packet command is associated with a
 * callback function that will be called when the command is finished.
Linus Torvalds's avatar
Linus Torvalds committed
665
 *
666
 * The handling will be done in three stages:
Linus Torvalds's avatar
Linus Torvalds committed
667
 *
668 669
 * 1. idetape_issue_pc will send the packet command to the drive, and will set
 * the interrupt handler to idetape_pc_intr.
Linus Torvalds's avatar
Linus Torvalds committed
670
 *
671 672
 * 2. On each interrupt, idetape_pc_intr will be called. This step will be
 * repeated until the device signals us that no more interrupts will be issued.
Linus Torvalds's avatar
Linus Torvalds committed
673
 *
674 675 676 677 678 679 680
 * 3. ATAPI Tape media access commands have immediate status with a delayed
 * process. In case of a successful initiation of a media access packet command,
 * the DSC bit will be set when the actual execution of the command is finished.
 * Since the tape drive will not issue an interrupt, we have to poll for this
 * event. In this case, we define the request as "low priority request" by
 * setting rq_status to IDETAPE_RQ_POSTPONED, set a timer to poll for DSC and
 * exit the driver.
Linus Torvalds's avatar
Linus Torvalds committed
681
 *
682 683
 * ide.c will then give higher priority to requests which originate from the
 * other device, until will change rq_status to RQ_ACTIVE.
Linus Torvalds's avatar
Linus Torvalds committed
684
 *
685
 * 4. When the packet command is finished, it will be checked for errors.
Linus Torvalds's avatar
Linus Torvalds committed
686
 *
687 688 689
 * 5. In case an error was found, we queue a request sense packet command in
 * front of the request queue and retry the operation up to
 * IDETAPE_MAX_PC_RETRIES times.
Linus Torvalds's avatar
Linus Torvalds committed
690
 *
691 692 693
 * 6. In case no error was found, or we decided to give up and not to retry
 * again, the callback function will be called and then we will handle the next
 * request.
Linus Torvalds's avatar
Linus Torvalds committed
694 695 696
 */
static ide_startstop_t idetape_transfer_pc(ide_drive_t *drive)
{
697
	return ide_transfer_pc(drive, idetape_pc_intr, WAIT_TAPE_CMD, NULL);
Linus Torvalds's avatar
Linus Torvalds committed
698 699
}

700 701
static ide_startstop_t idetape_issue_pc(ide_drive_t *drive,
		struct ide_atapi_pc *pc)
Linus Torvalds's avatar
Linus Torvalds committed
702 703 704
{
	idetape_tape_t *tape = drive->driver_data;

705
	if (drive->pc->c[0] == REQUEST_SENSE &&
706
	    pc->c[0] == REQUEST_SENSE) {
Linus Torvalds's avatar
Linus Torvalds committed
707 708 709 710
		printk(KERN_ERR "ide-tape: possible ide-tape.c bug - "
			"Two request sense in serial were issued\n");
	}

711
	if (tape->failed_pc == NULL && pc->c[0] != REQUEST_SENSE)
Linus Torvalds's avatar
Linus Torvalds committed
712
		tape->failed_pc = pc;
713

Linus Torvalds's avatar
Linus Torvalds committed
714
	/* Set the current packet command */
715
	drive->pc = pc;
Linus Torvalds's avatar
Linus Torvalds committed
716 717

	if (pc->retries > IDETAPE_MAX_PC_RETRIES ||
718
		(pc->flags & PC_FLAG_ABORT)) {
Linus Torvalds's avatar
Linus Torvalds committed
719
		/*
720 721 722
		 * We will "abort" retrying a packet command in case legitimate
		 * error code was received (crossing a filemark, or end of the
		 * media, for example).
Linus Torvalds's avatar
Linus Torvalds committed
723
		 */
724
		if (!(pc->flags & PC_FLAG_ABORT)) {
725
			if (!(pc->c[0] == TEST_UNIT_READY &&
Linus Torvalds's avatar
Linus Torvalds committed
726 727 728 729 730 731 732 733 734 735 736 737 738
			      tape->sense_key == 2 && tape->asc == 4 &&
			     (tape->ascq == 1 || tape->ascq == 8))) {
				printk(KERN_ERR "ide-tape: %s: I/O error, "
						"pc = %2x, key = %2x, "
						"asc = %2x, ascq = %2x\n",
						tape->name, pc->c[0],
						tape->sense_key, tape->asc,
						tape->ascq);
			}
			/* Giving up */
			pc->error = IDETAPE_ERROR_GENERAL;
		}
		tape->failed_pc = NULL;
739
		drive->pc_callback(drive, 0);
740
		return ide_stopped;
Linus Torvalds's avatar
Linus Torvalds committed
741
	}
742
	debug_log(DBG_SENSE, "Retry #%d, cmd = %02X\n", pc->retries, pc->c[0]);
Linus Torvalds's avatar
Linus Torvalds committed
743 744 745

	pc->retries++;

746
	return ide_issue_pc(drive, idetape_transfer_pc, WAIT_TAPE_CMD, NULL);
Linus Torvalds's avatar
Linus Torvalds committed
747 748
}

749
/* A mode sense command is used to "sense" tape parameters. */
750
static void idetape_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
Linus Torvalds's avatar
Linus Torvalds committed
751
{
752
	ide_init_pc(pc);
753
	pc->c[0] = MODE_SENSE;
Linus Torvalds's avatar
Linus Torvalds committed
754
	if (page_code != IDETAPE_BLOCK_DESCRIPTOR)
755 756
		/* DBD = 1 - Don't return block descriptors */
		pc->c[1] = 8;
Linus Torvalds's avatar
Linus Torvalds committed
757 758 759 760 761 762 763 764 765
	pc->c[2] = page_code;
	/*
	 * Changed pc->c[3] to 0 (255 will at best return unused info).
	 *
	 * For SCSI this byte is defined as subpage instead of high byte
	 * of length and some IDE drives seem to interpret it this way
	 * and return an error when 255 is used.
	 */
	pc->c[3] = 0;
766 767
	/* We will just discard data in that case */
	pc->c[4] = 255;
Linus Torvalds's avatar
Linus Torvalds committed
768
	if (page_code == IDETAPE_BLOCK_DESCRIPTOR)
769
		pc->req_xfer = 12;
Linus Torvalds's avatar
Linus Torvalds committed
770
	else if (page_code == IDETAPE_CAPABILITIES_PAGE)
771
		pc->req_xfer = 24;
Linus Torvalds's avatar
Linus Torvalds committed
772
	else
773
		pc->req_xfer = 50;
Linus Torvalds's avatar
Linus Torvalds committed
774 775
}

776
static ide_startstop_t idetape_media_access_finished(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
777
{
778
	ide_hwif_t *hwif = drive->hwif;
Linus Torvalds's avatar
Linus Torvalds committed
779
	idetape_tape_t *tape = drive->driver_data;
780
	struct ide_atapi_pc *pc = drive->pc;
781
	u8 stat;
Linus Torvalds's avatar
Linus Torvalds committed
782

783
	stat = hwif->tp_ops->read_status(hwif);
784

785 786
	if (stat & ATA_DSC) {
		if (stat & ATA_ERR) {
Linus Torvalds's avatar
Linus Torvalds committed
787
			/* Error detected */
788
			if (pc->c[0] != TEST_UNIT_READY)
Linus Torvalds's avatar
Linus Torvalds committed
789 790 791
				printk(KERN_ERR "ide-tape: %s: I/O error, ",
						tape->name);
			/* Retry operation */
792 793
			idetape_retry_pc(drive);
			return ide_stopped;
Linus Torvalds's avatar
Linus Torvalds committed
794 795 796 797 798 799
		}
		pc->error = 0;
	} else {
		pc->error = IDETAPE_ERROR_GENERAL;
		tape->failed_pc = NULL;
	}
800
	drive->pc_callback(drive, 0);
Linus Torvalds's avatar
Linus Torvalds committed
801 802 803
	return ide_stopped;
}

804
static void ide_tape_create_rw_cmd(idetape_tape_t *tape,
805 806
				   struct ide_atapi_pc *pc, struct request *rq,
				   u8 opcode)
Linus Torvalds's avatar
Linus Torvalds committed
807
{
808 809 810
	struct idetape_bh *bh = (struct idetape_bh *)rq->special;
	unsigned int length = rq->current_nr_sectors;

811
	ide_init_pc(pc);
812
	put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
Linus Torvalds's avatar
Linus Torvalds committed
813 814
	pc->c[1] = 1;
	pc->bh = bh;
815 816 817
	pc->buf = NULL;
	pc->buf_size = length * tape->blk_size;
	pc->req_xfer = pc->buf_size;
818
	if (pc->req_xfer == tape->buffer_size)
819
		pc->flags |= PC_FLAG_DMA_OK;
Linus Torvalds's avatar
Linus Torvalds committed
820

821 822 823 824 825 826 827 828 829
	if (opcode == READ_6) {
		pc->c[0] = READ_6;
		atomic_set(&bh->b_count, 0);
	} else if (opcode == WRITE_6) {
		pc->c[0] = WRITE_6;
		pc->flags |= PC_FLAG_WRITING;
		pc->b_data = bh->b_data;
		pc->b_count = atomic_read(&bh->b_count);
	}
830 831

	memcpy(rq->cmd, pc->c, 12);
Linus Torvalds's avatar
Linus Torvalds committed
832 833 834 835 836
}

static ide_startstop_t idetape_do_request(ide_drive_t *drive,
					  struct request *rq, sector_t block)
{
837
	ide_hwif_t *hwif = drive->hwif;
Linus Torvalds's avatar
Linus Torvalds committed
838
	idetape_tape_t *tape = drive->driver_data;
839
	struct ide_atapi_pc *pc = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
840
	struct request *postponed_rq = tape->postponed_rq;
841
	u8 stat;
Linus Torvalds's avatar
Linus Torvalds committed
842

843 844 845 846
	debug_log(DBG_SENSE, "sector: %llu, nr_sectors: %lu,"
			" current_nr_sectors: %u\n",
			(unsigned long long)rq->sector, rq->nr_sectors,
			rq->current_nr_sectors);
Linus Torvalds's avatar
Linus Torvalds committed
847

848
	if (!blk_special_request(rq)) {
849
		/* We do not support buffer cache originated requests. */
Linus Torvalds's avatar
Linus Torvalds committed
850
		printk(KERN_NOTICE "ide-tape: %s: Unsupported request in "
851
			"request queue (%d)\n", drive->name, rq->cmd_type);
Linus Torvalds's avatar
Linus Torvalds committed
852 853 854 855
		ide_end_request(drive, 0, 0);
		return ide_stopped;
	}

856
	/* Retry a failed packet command */
857
	if (tape->failed_pc && drive->pc->c[0] == REQUEST_SENSE) {
858 859 860
		pc = tape->failed_pc;
		goto out;
	}
861

Linus Torvalds's avatar
Linus Torvalds committed
862 863 864 865 866 867 868 869 870 871 872 873 874 875
	if (postponed_rq != NULL)
		if (rq != postponed_rq) {
			printk(KERN_ERR "ide-tape: ide-tape.c bug - "
					"Two DSC requests were queued\n");
			idetape_end_request(drive, 0, 0);
			return ide_stopped;
		}

	tape->postponed_rq = NULL;

	/*
	 * If the tape is still busy, postpone our request and service
	 * the other device meanwhile.
	 */
876
	stat = hwif->tp_ops->read_status(hwif);
Linus Torvalds's avatar
Linus Torvalds committed
877

878
	if (!drive->dsc_overlap && !(rq->cmd[13] & REQ_IDETAPE_PC2))
879
		set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
Linus Torvalds's avatar
Linus Torvalds committed
880 881

	if (drive->post_reset == 1) {
882
		set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
Linus Torvalds's avatar
Linus Torvalds committed
883 884 885
		drive->post_reset = 0;
	}

886
	if (!test_and_clear_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags) &&
887
	    (stat & ATA_DSC) == 0) {
Linus Torvalds's avatar
Linus Torvalds committed
888 889
		if (postponed_rq == NULL) {
			tape->dsc_polling_start = jiffies;
890
			tape->dsc_poll_freq = tape->best_dsc_rw_freq;
Linus Torvalds's avatar
Linus Torvalds committed
891 892 893 894
			tape->dsc_timeout = jiffies + IDETAPE_DSC_RW_TIMEOUT;
		} else if (time_after(jiffies, tape->dsc_timeout)) {
			printk(KERN_ERR "ide-tape: %s: DSC timeout\n",
				tape->name);
895
			if (rq->cmd[13] & REQ_IDETAPE_PC2) {
Linus Torvalds's avatar
Linus Torvalds committed
896 897 898 899 900
				idetape_media_access_finished(drive);
				return ide_stopped;
			} else {
				return ide_do_reset(drive);
			}
901 902 903
		} else if (time_after(jiffies,
					tape->dsc_polling_start +
					IDETAPE_DSC_MA_THRESHOLD))
904
			tape->dsc_poll_freq = IDETAPE_DSC_MA_SLOW;
Linus Torvalds's avatar
Linus Torvalds committed
905 906 907
		idetape_postpone_request(drive);
		return ide_stopped;
	}
908
	if (rq->cmd[13] & REQ_IDETAPE_READ) {
909
		pc = &tape->queued_pc;
910
		ide_tape_create_rw_cmd(tape, pc, rq, READ_6);
Linus Torvalds's avatar
Linus Torvalds committed
911 912
		goto out;
	}
913
	if (rq->cmd[13] & REQ_IDETAPE_WRITE) {
914
		pc = &tape->queued_pc;
915
		ide_tape_create_rw_cmd(tape, pc, rq, WRITE_6);
Linus Torvalds's avatar
Linus Torvalds committed
916 917
		goto out;
	}
918
	if (rq->cmd[13] & REQ_IDETAPE_PC1) {
919
		pc = (struct ide_atapi_pc *) rq->buffer;
920 921
		rq->cmd[13] &= ~(REQ_IDETAPE_PC1);
		rq->cmd[13] |= REQ_IDETAPE_PC2;
Linus Torvalds's avatar
Linus Torvalds committed
922 923
		goto out;
	}
924
	if (rq->cmd[13] & REQ_IDETAPE_PC2) {
Linus Torvalds's avatar
Linus Torvalds committed
925 926 927 928
		idetape_media_access_finished(drive);
		return ide_stopped;
	}
	BUG();
929

930
out:
931
	return idetape_issue_pc(drive, pc);
Linus Torvalds's avatar
Linus Torvalds committed
932 933 934
}

/*
935
 * The function below uses __get_free_pages to allocate a data buffer of size
936
 * tape->buffer_size (or a bit more). We attempt to combine sequential pages as
937
 * much as possible.
Linus Torvalds's avatar
Linus Torvalds committed
938
 *
939 940
 * It returns a pointer to the newly allocated buffer, or NULL in case of
 * failure.
Linus Torvalds's avatar
Linus Torvalds committed
941
 */
942 943
static struct idetape_bh *ide_tape_kmalloc_buffer(idetape_tape_t *tape,
						  int full, int clear)
Linus Torvalds's avatar
Linus Torvalds committed
944
{
945
	struct idetape_bh *prev_bh, *bh, *merge_bh;
946
	int pages = tape->pages_per_buffer;
947