ide-tape.c 66.3 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
 */
typedef struct ide_tape_obj {
169 170 171
	ide_drive_t		*drive;
	struct ide_driver	*driver;
	struct gendisk		*disk;
172
	struct device		dev;
Linus Torvalds's avatar
Linus Torvalds committed
173

174 175
	/* used by REQ_IDETAPE_{READ,WRITE} requests */
	struct ide_atapi_pc queued_pc;
176

Linus Torvalds's avatar
Linus Torvalds committed
177
	/*
178
	 * DSC polling variables.
Linus Torvalds's avatar
Linus Torvalds committed
179
	 *
180 181 182
	 * 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
183
	 * data transfer) request in the device request queue.
Linus Torvalds's avatar
Linus Torvalds committed
184 185 186 187 188 189 190
	 */
	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 */
191 192
	unsigned long best_dsc_rw_freq;
	unsigned long dsc_poll_freq;
Linus Torvalds's avatar
Linus Torvalds committed
193 194
	unsigned long dsc_timeout;

195
	/* Read position information */
Linus Torvalds's avatar
Linus Torvalds committed
196 197
	u8 partition;
	/* Current block */
198
	unsigned int first_frame;
Linus Torvalds's avatar
Linus Torvalds committed
199

200
	/* Last error information */
Linus Torvalds's avatar
Linus Torvalds committed
201 202
	u8 sense_key, asc, ascq;

203
	/* Character device operation */
Linus Torvalds's avatar
Linus Torvalds committed
204 205 206 207
	unsigned int minor;
	/* device name */
	char name[4];
	/* Current character device data transfer direction */
208
	u8 chrdev_dir;
Linus Torvalds's avatar
Linus Torvalds committed
209

210 211
	/* tape block size, usually 512 or 1024 bytes */
	unsigned short blk_size;
Linus Torvalds's avatar
Linus Torvalds committed
212
	int user_bs_factor;
213

Linus Torvalds's avatar
Linus Torvalds committed
214
	/* Copy of the tape's Capabilities and Mechanical Page */
215
	u8 caps[20];
Linus Torvalds's avatar
Linus Torvalds committed
216 217

	/*
218
	 * Active data transfer request parameters.
Linus Torvalds's avatar
Linus Torvalds committed
219
	 *
220 221 222
	 * 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
223
	 */
224

225
	/* Data buffer size chosen based on the tape's recommendation */
226
	int buffer_size;
227 228
	/* merge buffer */
	struct idetape_bh *merge_bh;
229 230
	/* size of the merge buffer */
	int merge_bh_size;
231
	/* pointer to current buffer head within the merge buffer */
Linus Torvalds's avatar
Linus Torvalds committed
232 233 234
	struct idetape_bh *bh;
	char *b_data;
	int b_count;
235

236
	int pages_per_buffer;
Linus Torvalds's avatar
Linus Torvalds committed
237 238 239
	/* Wasted space in each stage */
	int excess_bh_size;

240
	/* Measures average tape speed */
Linus Torvalds's avatar
Linus Torvalds committed
241 242 243 244 245 246 247 248 249 250 251
	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;

252
	u32 debug_mask;
Linus Torvalds's avatar
Linus Torvalds committed
253 254
} idetape_tape_t;

255
static DEFINE_MUTEX(idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
256

257 258
static struct class *idetape_sysfs_class;

259
static void ide_tape_release(struct device *);
260

Linus Torvalds's avatar
Linus Torvalds committed
261 262 263 264
static struct ide_tape_obj *ide_tape_get(struct gendisk *disk)
{
	struct ide_tape_obj *tape = NULL;

265
	mutex_lock(&idetape_ref_mutex);
Borislav Petkov's avatar
Borislav Petkov committed
266
	tape = ide_drv_g(disk, ide_tape_obj);
267
	if (tape) {
268
		if (ide_device_get(tape->drive))
269
			tape = NULL;
270
		else
271
			get_device(&tape->dev);
272
	}
273
	mutex_unlock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
274 275 276 277 278
	return tape;
}

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

281
	mutex_lock(&idetape_ref_mutex);
282
	put_device(&tape->dev);
283
	ide_device_put(drive);
284
	mutex_unlock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
285 286 287
}

/*
288 289
 * 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
290
 */
291
static struct ide_tape_obj *idetape_devs[MAX_HWIFS * MAX_DRIVES];
Linus Torvalds's avatar
Linus Torvalds committed
292 293 294 295 296

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

297
	mutex_lock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
298 299
	tape = idetape_devs[i];
	if (tape)
300
		get_device(&tape->dev);
301
	mutex_unlock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
302 303 304
	return tape;
}

305
static void idetape_input_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
306
				  unsigned int bcount)
Linus Torvalds's avatar
Linus Torvalds committed
307 308 309 310 311 312 313 314
{
	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");
315
			ide_pad_transfer(drive, 0, bcount);
Linus Torvalds's avatar
Linus Torvalds committed
316 317
			return;
		}
318 319 320
		count = min(
			(unsigned int)(bh->b_size - atomic_read(&bh->b_count)),
			bcount);
321
		drive->hwif->tp_ops->input_data(drive, NULL, bh->b_data +
322
					atomic_read(&bh->b_count), count);
Linus Torvalds's avatar
Linus Torvalds committed
323 324 325 326 327 328 329 330 331 332 333
		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;
}

334
static void idetape_output_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
335
				   unsigned int bcount)
Linus Torvalds's avatar
Linus Torvalds committed
336 337 338 339 340 341
{
	struct idetape_bh *bh = pc->bh;
	int count;

	while (bcount) {
		if (bh == NULL) {
342 343
			printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
					__func__);
Linus Torvalds's avatar
Linus Torvalds committed
344 345 346
			return;
		}
		count = min((unsigned int)pc->b_count, (unsigned int)bcount);
347
		drive->hwif->tp_ops->output_data(drive, NULL, pc->b_data, count);
Linus Torvalds's avatar
Linus Torvalds committed
348 349 350 351
		bcount -= count;
		pc->b_data += count;
		pc->b_count -= count;
		if (!pc->b_count) {
352 353
			bh = bh->b_reqnext;
			pc->bh = bh;
Linus Torvalds's avatar
Linus Torvalds committed
354 355 356 357 358 359 360 361
			if (bh) {
				pc->b_data = bh->b_data;
				pc->b_count = atomic_read(&bh->b_count);
			}
		}
	}
}

362
static void idetape_update_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc)
Linus Torvalds's avatar
Linus Torvalds committed
363 364 365
{
	struct idetape_bh *bh = pc->bh;
	int count;
366
	unsigned int bcount = pc->xferred;
Linus Torvalds's avatar
Linus Torvalds committed
367

368
	if (pc->flags & PC_FLAG_WRITING)
Linus Torvalds's avatar
Linus Torvalds committed
369 370 371
		return;
	while (bcount) {
		if (bh == NULL) {
372 373
			printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
					__func__);
Linus Torvalds's avatar
Linus Torvalds committed
374 375 376 377 378 379 380 381 382 383 384 385
			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;
}

/*
386 387
 * 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
388
 */
389
static void idetape_analyze_error(ide_drive_t *drive, u8 *sense)
Linus Torvalds's avatar
Linus Torvalds committed
390 391
{
	idetape_tape_t *tape = drive->driver_data;
392
	struct ide_atapi_pc *pc = drive->failed_pc;
Linus Torvalds's avatar
Linus Torvalds committed
393

394 395 396
	tape->sense_key = sense[2] & 0xF;
	tape->asc       = sense[12];
	tape->ascq      = sense[13];
397 398 399

	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
400

401
	/* Correct pc->xferred by asking the tape.	 */
402
	if (pc->flags & PC_FLAG_DMA_ERROR) {
403
		pc->xferred = pc->req_xfer -
404
			tape->blk_size *
405
			get_unaligned_be32(&sense[3]);
406
		idetape_update_buffers(drive, pc);
Linus Torvalds's avatar
Linus Torvalds committed
407 408 409 410 411 412 413
	}

	/*
	 * 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.
	 */
414
	if ((pc->c[0] == READ_6 || pc->c[0] == WRITE_6)
415 416 417
	    /* 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
418 419 420
			/* don't report an error, everything's ok */
			pc->error = 0;
			/* don't retry read/write */
421
			pc->flags |= PC_FLAG_ABORT;
Linus Torvalds's avatar
Linus Torvalds committed
422 423
		}
	}
424
	if (pc->c[0] == READ_6 && (sense[2] & 0x80)) {
Linus Torvalds's avatar
Linus Torvalds committed
425
		pc->error = IDETAPE_ERROR_FILEMARK;
426
		pc->flags |= PC_FLAG_ABORT;
Linus Torvalds's avatar
Linus Torvalds committed
427
	}
428
	if (pc->c[0] == WRITE_6) {
429 430
		if ((sense[2] & 0x40) || (tape->sense_key == 0xd
		     && tape->asc == 0x0 && tape->ascq == 0x2)) {
Linus Torvalds's avatar
Linus Torvalds committed
431
			pc->error = IDETAPE_ERROR_EOD;
432
			pc->flags |= PC_FLAG_ABORT;
Linus Torvalds's avatar
Linus Torvalds committed
433 434
		}
	}
435
	if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
436
		if (tape->sense_key == 8) {
Linus Torvalds's avatar
Linus Torvalds committed
437
			pc->error = IDETAPE_ERROR_EOD;
438
			pc->flags |= PC_FLAG_ABORT;
Linus Torvalds's avatar
Linus Torvalds committed
439
		}
440
		if (!(pc->flags & PC_FLAG_ABORT) &&
441
		    pc->xferred)
Linus Torvalds's avatar
Linus Torvalds committed
442 443 444 445
			pc->retries = IDETAPE_MAX_PC_RETRIES + 1;
	}
}

446
/* Free data buffers completely. */
447
static void ide_tape_kfree_buffer(idetape_tape_t *tape)
Linus Torvalds's avatar
Linus Torvalds committed
448
{
449
	struct idetape_bh *prev_bh, *bh = tape->merge_bh;
450 451 452 453 454 455 456 457 458 459 460 461

	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
462 463 464 465 466 467 468 469 470
		}
		prev_bh = bh;
		bh = bh->b_reqnext;
		kfree(prev_bh);
	}
}

static int idetape_end_request(ide_drive_t *drive, int uptodate, int nr_sects)
{
471
	struct request *rq = drive->hwif->rq;
Linus Torvalds's avatar
Linus Torvalds committed
472 473
	int error;

474
	debug_log(DBG_PROCS, "Enter %s\n", __func__);
Linus Torvalds's avatar
Linus Torvalds committed
475 476

	switch (uptodate) {
477 478 479
	case 0:	error = IDETAPE_ERROR_GENERAL; break;
	case 1: error = 0; break;
	default: error = uptodate;
Linus Torvalds's avatar
Linus Torvalds committed
480 481 482
	}
	rq->errors = error;
	if (error)
483
		drive->failed_pc = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
484

485 486 487 488 489
	if (!blk_special_request(rq)) {
		ide_end_request(drive, uptodate, nr_sects);
		return 0;
	}

490
	ide_complete_rq(drive, 0);
Linus Torvalds's avatar
Linus Torvalds committed
491 492 493 494

	return 0;
}

495 496 497
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
498 499
{
	idetape_tape_t *tape = drive->driver_data;
500
	struct ide_atapi_pc *pc = drive->pc;
501
	int uptodate = pc->error ? 0 : 1;
Linus Torvalds's avatar
Linus Torvalds committed
502

503 504
	debug_log(DBG_PROCS, "Enter %s\n", __func__);

505 506 507
	if (dsc)
		ide_tape_handle_dsc(drive);

508 509
	if (drive->failed_pc == pc)
		drive->failed_pc = NULL;
510

511 512 513 514 515 516 517
	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) {
518
		struct request *rq = drive->hwif->rq;
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
		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) {
536
		u8 *readpos = pc->buf;
537 538 539 540 541 542 543 544 545

		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");
546
			clear_bit(IDE_AFLAG_ADDRESS_VALID, &drive->atapi_flags);
547 548 549
			uptodate = 0;
		} else {
			debug_log(DBG_SENSE, "Block Location - %u\n",
550
					be32_to_cpup((__be32 *)&readpos[4]));
551 552

			tape->partition = readpos[1];
553
			tape->first_frame = be32_to_cpup((__be32 *)&readpos[4]);
554
			set_bit(IDE_AFLAG_ADDRESS_VALID, &drive->atapi_flags);
555
		}
Linus Torvalds's avatar
Linus Torvalds committed
556
	}
557 558

	idetape_end_request(drive, uptodate, 0);
Linus Torvalds's avatar
Linus Torvalds committed
559 560 561
}

/*
562
 * Postpone the current request so that ide.c will be able to service requests
563
 * from another device on the same port while we are polling for DSC.
Linus Torvalds's avatar
Linus Torvalds committed
564
 */
565
static void idetape_postpone_request(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
566 567 568
{
	idetape_tape_t *tape = drive->driver_data;

569 570
	debug_log(DBG_PROCS, "Enter %s\n", __func__);

571 572
	tape->postponed_rq = drive->hwif->rq;

573
	ide_stall_queue(drive, tape->dsc_poll_freq);
Linus Torvalds's avatar
Linus Torvalds committed
574 575
}

576 577 578 579 580 581 582 583 584 585 586 587
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);
}

588
static int ide_tape_io_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
589 590 591 592 593 594
				unsigned int bcount, int write)
{
	if (write)
		idetape_output_buffers(drive, pc, bcount);
	else
		idetape_input_buffers(drive, pc, bcount);
595 596

	return bcount;
597
}
598

Linus Torvalds's avatar
Linus Torvalds committed
599
/*
600
 * Packet Command Interface
Linus Torvalds's avatar
Linus Torvalds committed
601
 *
602
 * The current Packet Command is available in drive->pc, and will not change
603 604
 * 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
605
 *
606
 * The handling will be done in three stages:
Linus Torvalds's avatar
Linus Torvalds committed
607
 *
608
 * 1. idetape_issue_pc will send the packet command to the drive, and will set
609
 * the interrupt handler to ide_pc_intr.
Linus Torvalds's avatar
Linus Torvalds committed
610
 *
611
 * 2. On each interrupt, ide_pc_intr will be called. This step will be
612
 * repeated until the device signals us that no more interrupts will be issued.
Linus Torvalds's avatar
Linus Torvalds committed
613
 *
614 615 616 617 618 619 620
 * 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
621
 *
622 623
 * 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
624
 *
625
 * 4. When the packet command is finished, it will be checked for errors.
Linus Torvalds's avatar
Linus Torvalds committed
626
 *
627 628 629
 * 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
630
 *
631 632 633
 * 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
634 635
 */

636 637
static ide_startstop_t idetape_issue_pc(ide_drive_t *drive,
		struct ide_atapi_pc *pc)
Linus Torvalds's avatar
Linus Torvalds committed
638 639 640
{
	idetape_tape_t *tape = drive->driver_data;

641
	if (drive->pc->c[0] == REQUEST_SENSE &&
642
	    pc->c[0] == REQUEST_SENSE) {
Linus Torvalds's avatar
Linus Torvalds committed
643 644 645 646
		printk(KERN_ERR "ide-tape: possible ide-tape.c bug - "
			"Two request sense in serial were issued\n");
	}

647 648
	if (drive->failed_pc == NULL && pc->c[0] != REQUEST_SENSE)
		drive->failed_pc = pc;
649

Linus Torvalds's avatar
Linus Torvalds committed
650
	/* Set the current packet command */
651
	drive->pc = pc;
Linus Torvalds's avatar
Linus Torvalds committed
652 653

	if (pc->retries > IDETAPE_MAX_PC_RETRIES ||
654
		(pc->flags & PC_FLAG_ABORT)) {
Linus Torvalds's avatar
Linus Torvalds committed
655
		/*
656 657 658
		 * 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
659
		 */
660
		if (!(pc->flags & PC_FLAG_ABORT)) {
661
			if (!(pc->c[0] == TEST_UNIT_READY &&
Linus Torvalds's avatar
Linus Torvalds committed
662 663 664 665 666 667 668 669 670 671 672 673
			      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;
		}
674
		drive->failed_pc = NULL;
675
		drive->pc_callback(drive, 0);
676
		return ide_stopped;
Linus Torvalds's avatar
Linus Torvalds committed
677
	}
678
	debug_log(DBG_SENSE, "Retry #%d, cmd = %02X\n", pc->retries, pc->c[0]);
Linus Torvalds's avatar
Linus Torvalds committed
679 680 681

	pc->retries++;

682
	return ide_issue_pc(drive);
Linus Torvalds's avatar
Linus Torvalds committed
683 684
}

685
/* A mode sense command is used to "sense" tape parameters. */
686
static void idetape_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
Linus Torvalds's avatar
Linus Torvalds committed
687
{
688
	ide_init_pc(pc);
689
	pc->c[0] = MODE_SENSE;
Linus Torvalds's avatar
Linus Torvalds committed
690
	if (page_code != IDETAPE_BLOCK_DESCRIPTOR)
691 692
		/* DBD = 1 - Don't return block descriptors */
		pc->c[1] = 8;
Linus Torvalds's avatar
Linus Torvalds committed
693 694 695 696 697 698 699 700 701
	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;
702 703
	/* We will just discard data in that case */
	pc->c[4] = 255;
Linus Torvalds's avatar
Linus Torvalds committed
704
	if (page_code == IDETAPE_BLOCK_DESCRIPTOR)
705
		pc->req_xfer = 12;
Linus Torvalds's avatar
Linus Torvalds committed
706
	else if (page_code == IDETAPE_CAPABILITIES_PAGE)
707
		pc->req_xfer = 24;
Linus Torvalds's avatar
Linus Torvalds committed
708
	else
709
		pc->req_xfer = 50;
Linus Torvalds's avatar
Linus Torvalds committed
710 711
}

712
static ide_startstop_t idetape_media_access_finished(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
713
{
714
	ide_hwif_t *hwif = drive->hwif;
Linus Torvalds's avatar
Linus Torvalds committed
715
	idetape_tape_t *tape = drive->driver_data;
716
	struct ide_atapi_pc *pc = drive->pc;
717
	u8 stat;
Linus Torvalds's avatar
Linus Torvalds committed
718

719
	stat = hwif->tp_ops->read_status(hwif);
720

721 722
	if (stat & ATA_DSC) {
		if (stat & ATA_ERR) {
Linus Torvalds's avatar
Linus Torvalds committed
723
			/* Error detected */
724
			if (pc->c[0] != TEST_UNIT_READY)
Linus Torvalds's avatar
Linus Torvalds committed
725 726 727
				printk(KERN_ERR "ide-tape: %s: I/O error, ",
						tape->name);
			/* Retry operation */
728
			ide_retry_pc(drive, tape->disk);
729
			return ide_stopped;
Linus Torvalds's avatar
Linus Torvalds committed
730 731 732 733
		}
		pc->error = 0;
	} else {
		pc->error = IDETAPE_ERROR_GENERAL;
734
		drive->failed_pc = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
735
	}
736
	drive->pc_callback(drive, 0);
Linus Torvalds's avatar
Linus Torvalds committed
737 738 739
	return ide_stopped;
}

740
static void ide_tape_create_rw_cmd(idetape_tape_t *tape,
741 742
				   struct ide_atapi_pc *pc, struct request *rq,
				   u8 opcode)
Linus Torvalds's avatar
Linus Torvalds committed
743
{
744 745 746
	struct idetape_bh *bh = (struct idetape_bh *)rq->special;
	unsigned int length = rq->current_nr_sectors;

747
	ide_init_pc(pc);
748
	put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
Linus Torvalds's avatar
Linus Torvalds committed
749 750
	pc->c[1] = 1;
	pc->bh = bh;
751 752 753
	pc->buf = NULL;
	pc->buf_size = length * tape->blk_size;
	pc->req_xfer = pc->buf_size;
754
	if (pc->req_xfer == tape->buffer_size)
755
		pc->flags |= PC_FLAG_DMA_OK;
Linus Torvalds's avatar
Linus Torvalds committed
756

757 758 759 760 761 762 763 764 765
	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);
	}
766 767

	memcpy(rq->cmd, pc->c, 12);
Linus Torvalds's avatar
Linus Torvalds committed
768 769 770 771 772
}

static ide_startstop_t idetape_do_request(ide_drive_t *drive,
					  struct request *rq, sector_t block)
{
773
	ide_hwif_t *hwif = drive->hwif;
Linus Torvalds's avatar
Linus Torvalds committed
774
	idetape_tape_t *tape = drive->driver_data;
775
	struct ide_atapi_pc *pc = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
776
	struct request *postponed_rq = tape->postponed_rq;
777
	u8 stat;
Linus Torvalds's avatar
Linus Torvalds committed
778

779 780 781 782
	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
783

784
	if (!blk_special_request(rq)) {
785
		/* We do not support buffer cache originated requests. */
Linus Torvalds's avatar
Linus Torvalds committed
786
		printk(KERN_NOTICE "ide-tape: %s: Unsupported request in "
787
			"request queue (%d)\n", drive->name, rq->cmd_type);
Linus Torvalds's avatar
Linus Torvalds committed
788 789 790 791
		ide_end_request(drive, 0, 0);
		return ide_stopped;
	}

792
	/* Retry a failed packet command */
793 794
	if (drive->failed_pc && drive->pc->c[0] == REQUEST_SENSE) {
		pc = drive->failed_pc;
795 796
		goto out;
	}
797

Linus Torvalds's avatar
Linus Torvalds committed
798 799 800 801 802 803 804 805 806 807 808 809 810 811
	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.
	 */
812
	stat = hwif->tp_ops->read_status(hwif);
Linus Torvalds's avatar
Linus Torvalds committed
813

814 815
	if ((drive->dev_flags & IDE_DFLAG_DSC_OVERLAP) == 0 &&
	    (rq->cmd[13] & REQ_IDETAPE_PC2) == 0)
816
		set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
Linus Torvalds's avatar
Linus Torvalds committed
817

818
	if (drive->dev_flags & IDE_DFLAG_POST_RESET) {
819
		set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
820
		drive->dev_flags &= ~IDE_DFLAG_POST_RESET;
Linus Torvalds's avatar
Linus Torvalds committed
821 822
	}

823
	if (!test_and_clear_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags) &&
824
	    (stat & ATA_DSC) == 0) {
Linus Torvalds's avatar
Linus Torvalds committed
825 826
		if (postponed_rq == NULL) {
			tape->dsc_polling_start = jiffies;
827
			tape->dsc_poll_freq = tape->best_dsc_rw_freq;
Linus Torvalds's avatar
Linus Torvalds committed
828 829 830 831
			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);
832
			if (rq->cmd[13] & REQ_IDETAPE_PC2) {
Linus Torvalds's avatar
Linus Torvalds committed
833 834 835 836 837
				idetape_media_access_finished(drive);
				return ide_stopped;
			} else {
				return ide_do_reset(drive);
			}
838 839 840
		} else if (time_after(jiffies,
					tape->dsc_polling_start +
					IDETAPE_DSC_MA_THRESHOLD))
841
			tape->dsc_poll_freq = IDETAPE_DSC_MA_SLOW;
Linus Torvalds's avatar
Linus Torvalds committed
842 843 844
		idetape_postpone_request(drive);
		return ide_stopped;
	}
845
	if (rq->cmd[13] & REQ_IDETAPE_READ) {
846
		pc = &tape->queued_pc;
847
		ide_tape_create_rw_cmd(tape, pc, rq, READ_6);
Linus Torvalds's avatar
Linus Torvalds committed
848 849
		goto out;
	}
850
	if (rq->cmd[13] & REQ_IDETAPE_WRITE) {
851
		pc = &tape->queued_pc;
852
		ide_tape_create_rw_cmd(tape, pc, rq, WRITE_6);
Linus Torvalds's avatar
Linus Torvalds committed
853 854
		goto out;
	}
855
	if (rq->cmd[13] & REQ_IDETAPE_PC1) {
856
		pc = (struct ide_atapi_pc *) rq->buffer;
857 858
		rq->cmd[13] &= ~(REQ_IDETAPE_PC1);
		rq->cmd[13] |= REQ_IDETAPE_PC2;
Linus Torvalds's avatar
Linus Torvalds committed
859 860
		goto out;
	}
861
	if (rq->cmd[13] & REQ_IDETAPE_PC2) {
Linus Torvalds's avatar
Linus Torvalds committed
862 863 864 865
		idetape_media_access_finished(drive);
		return ide_stopped;
	}
	BUG();
866

867
out:
868
	return idetape_issue_pc(drive, pc);
Linus Torvalds's avatar
Linus Torvalds committed
869 870 871
}

/*
872
 * The function below uses __get_free_pages to allocate a data buffer of size
873
 * tape->buffer_size (or a bit more). We attempt to combine sequential pages as
874
 * much as possible.
Linus Torvalds's avatar
Linus Torvalds committed
875
 *
876 877
 * It returns a pointer to the newly allocated buffer, or NULL in case of
 * failure.
Linus Torvalds's avatar
Linus Torvalds committed
878
 */
879 880
static struct idetape_bh *ide_tape_kmalloc_buffer(idetape_tape_t *tape,
						  int full, int clear)
Linus Torvalds's avatar
Linus Torvalds committed
881
{
882
	struct idetape_bh *prev_bh, *bh, *merge_bh;
883
	int pages = tape->pages_per_buffer;
884
	unsigned int order, b_allocd;
Linus Torvalds's avatar
Linus Torvalds committed
885 886
	char *b_data = NULL;

887 888
	merge_bh = kmalloc(sizeof(struct idetape_bh), GFP_KERNEL);
	bh = merge_bh;
Linus Torvalds's avatar
Linus Torvalds committed
889 890
	if (bh == NULL)
		goto abort;
891 892 893

	order = fls(pages) - 1;
	bh->b_data = (char *) __get_free_pages(GFP_KERNEL, order);
894
	if (!bh->b_data)
Linus Torvalds's avatar
Linus Torvalds committed
895
		goto abort;
896 897 898
	b_allocd = (1 << order) * PAGE_SIZE;
	pages &= (order-1);

Linus Torvalds's avatar
Linus Torvalds committed
899
	if (clear)
900 901 902
		memset(bh->b_data, 0, b_allocd);
	bh->b_reqnext = NULL;
	bh->b_size = b_allocd;
Linus Torvalds's avatar
Linus Torvalds committed
903 904
	atomic_set(&bh->b_count, full ? bh->b_size : 0);

905 906 907
	while (pages) {
		order = fls(pages) - 1;
		b_data = (char *) __get_free_pages(GFP_KERNEL, order);
908
		if (!b_data)
Linus Torvalds's avatar
Linus Torvalds committed
909
			goto abort;
910 911
		b_allocd = (1 << order) * PAGE_SIZE;

Linus Torvalds's avatar
Linus Torvalds committed
912
		if (clear)
913 914 915 916 917 918
			memset(b_data, 0, b_allocd);

		/* newly allocated page frames below buffer header or ...*/
		if (bh->b_data == b_data + b_allocd) {
			bh->b_size += b_allocd;
			bh->b_data -= b_allocd;
Linus Torvalds's avatar
Linus Torvalds committed
919
			if (full)
920
				atomic_add(b_allocd, &bh->b_count);
Linus Torvalds's avatar
Linus Torvalds committed
921 922
			continue;
		}
923
		/* they are above the header */
Linus Torvalds's avatar
Linus Torvalds committed
924
		if (b_data == bh->b_data + bh->b_size) {
925
			bh->b_size += b_allocd;
Linus Torvalds's avatar
Linus Torvalds committed
926
			if (full)
927
				atomic_add(b_allocd, &bh->b_count);
Linus Torvalds's avatar
Linus Torvalds committed
928 929 930
			continue;
		}
		prev_bh = bh;
931 932
		bh = kmalloc(sizeof(struct idetape_bh), GFP_KERNEL);
		if (!bh) {
933
			free_pages((unsigned long) b_data, order);
Linus Torvalds's avatar
Linus Torvalds committed
934 935 936 937
			goto abort;
		}
		bh->b_reqnext = NULL;
		bh->b_data = b_data;
938
		bh->b_size = b_allocd;
Linus Torvalds's avatar
Linus Torvalds committed
939 940
		atomic_set(&bh->b_count, full ? bh->b_size : 0);
		prev_bh->b_reqnext = bh;
941 942

		pages &= (order-1);
Linus Torvalds's avatar
Linus Torvalds committed
943
	}
944

Linus Torvalds's avatar
Linus Torvalds committed
945 946 947
	bh->b_size -= tape->excess_bh_size;
	if (full)
		atomic_sub(tape->excess_bh_size, &bh->b_count);