ide-tape.c 70.6 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 84 85 86 87 88 89 90
 */
#define IDETAPE_MAX_PC_RETRIES		3

/*
 * Some drives (for example, Seagate STT3401A Travan) require a very long
 * timeout, because they don't return an interrupt or clear their busy bit
 * until after the command completes (even retension commands).
 */
#define IDETAPE_WAIT_CMD		(900*HZ)

/*
91 92 93 94
 * 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
95
 */
96
#define IDETAPE_FIFO_THRESHOLD		2
Linus Torvalds's avatar
Linus Torvalds committed
97 98

/*
99
 * DSC polling parameters.
Linus Torvalds's avatar
Linus Torvalds committed
100
 *
101 102
 * 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
103
 *
104 105 106 107 108
 * 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
109
 *
110 111 112 113 114 115 116 117
 * 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
118
 *
119 120
 * 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
121
 */
122 123

/* DSC timings. */
Linus Torvalds's avatar
Linus Torvalds committed
124 125 126 127 128 129 130 131 132 133
#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 ***********************/

134 135 136 137 138 139
/* 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
140 141

struct idetape_bh {
142
	u32 b_size;
Linus Torvalds's avatar
Linus Torvalds committed
143 144 145 146 147
	atomic_t b_count;
	struct idetape_bh *b_reqnext;
	char *b_data;
};

148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
/* 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

/*
 * Special requests for our block device strategy routine.
 *
 * In order to service a character device command, we add special requests to
 * the tail of our block device request queue and wait for their completion.
 */

enum {
	REQ_IDETAPE_PC1		= (1 << 0), /* packet command (first stage) */
	REQ_IDETAPE_PC2		= (1 << 1), /* packet command (second stage) */
	REQ_IDETAPE_READ	= (1 << 2),
	REQ_IDETAPE_WRITE	= (1 << 3),
};

/* 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
185
/*
186 187
 * 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
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
 */
typedef struct ide_tape_obj {
	ide_drive_t	*drive;
	ide_driver_t	*driver;
	struct gendisk	*disk;
	struct kref	kref;

	/*
	 *	pc points to the current processed packet command.
	 *
	 *	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.
	 */
	/* Current packet command */
204
	struct ide_atapi_pc *pc;
Linus Torvalds's avatar
Linus Torvalds committed
205
	/* Last failed packet command */
206
	struct ide_atapi_pc *failed_pc;
207 208
	/* used by REQ_IDETAPE_{READ,WRITE} requests */
	struct ide_atapi_pc queued_pc;
209

210
	struct ide_atapi_pc request_sense_pc;
211
	struct request request_sense_rq;
Linus Torvalds's avatar
Linus Torvalds committed
212 213

	/*
214
	 * DSC polling variables.
Linus Torvalds's avatar
Linus Torvalds committed
215
	 *
216 217 218
	 * 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
219
	 * data transfer) request in the device request queue.
Linus Torvalds's avatar
Linus Torvalds committed
220 221 222 223 224 225 226
	 */
	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 */
227 228
	unsigned long best_dsc_rw_freq;
	unsigned long dsc_poll_freq;
Linus Torvalds's avatar
Linus Torvalds committed
229 230
	unsigned long dsc_timeout;

231
	/* Read position information */
Linus Torvalds's avatar
Linus Torvalds committed
232 233
	u8 partition;
	/* Current block */
234
	unsigned int first_frame;
Linus Torvalds's avatar
Linus Torvalds committed
235

236
	/* Last error information */
Linus Torvalds's avatar
Linus Torvalds committed
237 238
	u8 sense_key, asc, ascq;

239
	/* Character device operation */
Linus Torvalds's avatar
Linus Torvalds committed
240 241 242 243
	unsigned int minor;
	/* device name */
	char name[4];
	/* Current character device data transfer direction */
244
	u8 chrdev_dir;
Linus Torvalds's avatar
Linus Torvalds committed
245

246 247
	/* tape block size, usually 512 or 1024 bytes */
	unsigned short blk_size;
Linus Torvalds's avatar
Linus Torvalds committed
248
	int user_bs_factor;
249

Linus Torvalds's avatar
Linus Torvalds committed
250
	/* Copy of the tape's Capabilities and Mechanical Page */
251
	u8 caps[20];
Linus Torvalds's avatar
Linus Torvalds committed
252 253

	/*
254
	 * Active data transfer request parameters.
Linus Torvalds's avatar
Linus Torvalds committed
255
	 *
256 257 258
	 * 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
259
	 */
260

261
	/* Data buffer size chosen based on the tape's recommendation */
262
	int buffer_size;
263 264
	/* merge buffer */
	struct idetape_bh *merge_bh;
265 266
	/* size of the merge buffer */
	int merge_bh_size;
267
	/* pointer to current buffer head within the merge buffer */
Linus Torvalds's avatar
Linus Torvalds committed
268 269 270
	struct idetape_bh *bh;
	char *b_data;
	int b_count;
271

272
	int pages_per_buffer;
Linus Torvalds's avatar
Linus Torvalds committed
273 274 275 276
	/* Wasted space in each stage */
	int excess_bh_size;

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

279
	/* Measures average tape speed */
Linus Torvalds's avatar
Linus Torvalds committed
280 281 282 283 284 285 286 287 288 289 290
	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;

291
	u32 debug_mask;
Linus Torvalds's avatar
Linus Torvalds committed
292 293
} idetape_tape_t;

294
static DEFINE_MUTEX(idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
295

296 297
static struct class *idetape_sysfs_class;

Linus Torvalds's avatar
Linus Torvalds committed
298 299 300 301 302
#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)

303 304
static void ide_tape_release(struct kref *);

Linus Torvalds's avatar
Linus Torvalds committed
305 306 307 308
static struct ide_tape_obj *ide_tape_get(struct gendisk *disk)
{
	struct ide_tape_obj *tape = NULL;

309
	mutex_lock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
310
	tape = ide_tape_g(disk);
311
	if (tape) {
312
		if (ide_device_get(tape->drive))
313
			tape = NULL;
314 315
		else
			kref_get(&tape->kref);
316
	}
317
	mutex_unlock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
318 319 320 321 322
	return tape;
}

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

325
	mutex_lock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
326
	kref_put(&tape->kref, ide_tape_release);
327
	ide_device_put(drive);
328
	mutex_unlock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
329 330 331
}

/*
332 333
 * 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
334
 */
335
static struct ide_tape_obj *idetape_devs[MAX_HWIFS * MAX_DRIVES];
Linus Torvalds's avatar
Linus Torvalds committed
336 337 338 339 340 341 342

#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;

343
	mutex_lock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
344 345 346
	tape = idetape_devs[i];
	if (tape)
		kref_get(&tape->kref);
347
	mutex_unlock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
348 349 350
	return tape;
}

351
static void idetape_input_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
352
				  unsigned int bcount)
Linus Torvalds's avatar
Linus Torvalds committed
353 354 355 356 357 358 359 360
{
	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");
361
			ide_pad_transfer(drive, 0, bcount);
Linus Torvalds's avatar
Linus Torvalds committed
362 363
			return;
		}
364 365 366
		count = min(
			(unsigned int)(bh->b_size - atomic_read(&bh->b_count)),
			bcount);
367
		drive->hwif->tp_ops->input_data(drive, NULL, bh->b_data +
368
					atomic_read(&bh->b_count), count);
Linus Torvalds's avatar
Linus Torvalds committed
369 370 371 372 373 374 375 376 377 378 379
		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;
}

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

	while (bcount) {
		if (bh == NULL) {
388 389
			printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
					__func__);
Linus Torvalds's avatar
Linus Torvalds committed
390 391 392
			return;
		}
		count = min((unsigned int)pc->b_count, (unsigned int)bcount);
393
		drive->hwif->tp_ops->output_data(drive, NULL, pc->b_data, count);
Linus Torvalds's avatar
Linus Torvalds committed
394 395 396 397
		bcount -= count;
		pc->b_data += count;
		pc->b_count -= count;
		if (!pc->b_count) {
398 399
			bh = bh->b_reqnext;
			pc->bh = bh;
Linus Torvalds's avatar
Linus Torvalds committed
400 401 402 403 404 405 406 407
			if (bh) {
				pc->b_data = bh->b_data;
				pc->b_count = atomic_read(&bh->b_count);
			}
		}
	}
}

408
static void idetape_update_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc)
Linus Torvalds's avatar
Linus Torvalds committed
409 410 411
{
	struct idetape_bh *bh = pc->bh;
	int count;
412
	unsigned int bcount = pc->xferred;
Linus Torvalds's avatar
Linus Torvalds committed
413

414
	if (pc->flags & PC_FLAG_WRITING)
Linus Torvalds's avatar
Linus Torvalds committed
415 416 417
		return;
	while (bcount) {
		if (bh == NULL) {
418 419
			printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
					__func__);
Linus Torvalds's avatar
Linus Torvalds committed
420 421 422 423 424 425 426 427 428 429 430 431
			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;
}

/*
432 433
 * 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
434
 */
435
static void idetape_analyze_error(ide_drive_t *drive, u8 *sense)
Linus Torvalds's avatar
Linus Torvalds committed
436 437
{
	idetape_tape_t *tape = drive->driver_data;
438
	struct ide_atapi_pc *pc = tape->failed_pc;
Linus Torvalds's avatar
Linus Torvalds committed
439

440 441 442
	tape->sense_key = sense[2] & 0xF;
	tape->asc       = sense[12];
	tape->ascq      = sense[13];
443 444 445

	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
446

447
	/* Correct pc->xferred by asking the tape.	 */
448
	if (pc->flags & PC_FLAG_DMA_ERROR) {
449
		pc->xferred = pc->req_xfer -
450
			tape->blk_size *
451
			get_unaligned_be32(&sense[3]);
452
		idetape_update_buffers(drive, pc);
Linus Torvalds's avatar
Linus Torvalds committed
453 454 455 456 457 458 459
	}

	/*
	 * 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.
	 */
460
	if ((pc->c[0] == READ_6 || pc->c[0] == WRITE_6)
461 462 463
	    /* 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
464 465 466
			/* don't report an error, everything's ok */
			pc->error = 0;
			/* don't retry read/write */
467
			pc->flags |= PC_FLAG_ABORT;
Linus Torvalds's avatar
Linus Torvalds committed
468 469
		}
	}
470
	if (pc->c[0] == READ_6 && (sense[2] & 0x80)) {
Linus Torvalds's avatar
Linus Torvalds committed
471
		pc->error = IDETAPE_ERROR_FILEMARK;
472
		pc->flags |= PC_FLAG_ABORT;
Linus Torvalds's avatar
Linus Torvalds committed
473
	}
474
	if (pc->c[0] == WRITE_6) {
475 476
		if ((sense[2] & 0x40) || (tape->sense_key == 0xd
		     && tape->asc == 0x0 && tape->ascq == 0x2)) {
Linus Torvalds's avatar
Linus Torvalds committed
477
			pc->error = IDETAPE_ERROR_EOD;
478
			pc->flags |= PC_FLAG_ABORT;
Linus Torvalds's avatar
Linus Torvalds committed
479 480
		}
	}
481
	if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
482
		if (tape->sense_key == 8) {
Linus Torvalds's avatar
Linus Torvalds committed
483
			pc->error = IDETAPE_ERROR_EOD;
484
			pc->flags |= PC_FLAG_ABORT;
Linus Torvalds's avatar
Linus Torvalds committed
485
		}
486
		if (!(pc->flags & PC_FLAG_ABORT) &&
487
		    pc->xferred)
Linus Torvalds's avatar
Linus Torvalds committed
488 489 490 491
			pc->retries = IDETAPE_MAX_PC_RETRIES + 1;
	}
}

492
/* Free data buffers completely. */
493
static void ide_tape_kfree_buffer(idetape_tape_t *tape)
Linus Torvalds's avatar
Linus Torvalds committed
494
{
495
	struct idetape_bh *prev_bh, *bh = tape->merge_bh;
496 497 498 499 500 501 502 503 504 505 506 507

	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
508 509 510 511 512 513 514 515 516 517 518 519 520 521
		}
		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;

522
	debug_log(DBG_PROCS, "Enter %s\n", __func__);
Linus Torvalds's avatar
Linus Torvalds committed
523 524

	switch (uptodate) {
525 526 527
	case 0:	error = IDETAPE_ERROR_GENERAL; break;
	case 1: error = 0; break;
	default: error = uptodate;
Linus Torvalds's avatar
Linus Torvalds committed
528 529 530 531 532
	}
	rq->errors = error;
	if (error)
		tape->failed_pc = NULL;

533 534 535 536 537
	if (!blk_special_request(rq)) {
		ide_end_request(drive, uptodate, nr_sects);
		return 0;
	}

538
	spin_lock_irqsave(&tape->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
539 540 541

	ide_end_drive_cmd(drive, 0, 0);

542
	spin_unlock_irqrestore(&tape->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
543 544 545
	return 0;
}

546
static void ide_tape_callback(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
547 548
{
	idetape_tape_t *tape = drive->driver_data;
549 550
	struct ide_atapi_pc *pc = tape->pc;
	int uptodate = pc->error ? 0 : 1;
Linus Torvalds's avatar
Linus Torvalds committed
551

552 553
	debug_log(DBG_PROCS, "Enter %s\n", __func__);

554 555 556
	if (tape->failed_pc == pc)
		tape->failed_pc = NULL;

557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
	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) {
		u8 *readpos = tape->pc->buf;

		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");
592
			clear_bit(IDE_AFLAG_ADDRESS_VALID, &drive->atapi_flags);
593 594 595
			uptodate = 0;
		} else {
			debug_log(DBG_SENSE, "Block Location - %u\n",
596
					be32_to_cpup((__be32 *)&readpos[4]));
597 598

			tape->partition = readpos[1];
599
			tape->first_frame = be32_to_cpup((__be32 *)&readpos[4]);
600
			set_bit(IDE_AFLAG_ADDRESS_VALID, &drive->atapi_flags);
601
		}
Linus Torvalds's avatar
Linus Torvalds committed
602
	}
603 604

	idetape_end_request(drive, uptodate, 0);
Linus Torvalds's avatar
Linus Torvalds committed
605 606
}

607
static void idetape_create_request_sense_cmd(struct ide_atapi_pc *pc)
Linus Torvalds's avatar
Linus Torvalds committed
608
{
609
	ide_init_pc(pc);
610
	pc->c[0] = REQUEST_SENSE;
Linus Torvalds's avatar
Linus Torvalds committed
611
	pc->c[4] = 20;
612
	pc->req_xfer = 20;
Linus Torvalds's avatar
Linus Torvalds committed
613 614 615
}

/*
616 617
 * Generate a new packet command request in front of the request queue, before
 * the current request, so that it will be processed immediately, on the next
618
 * pass through the driver.
Linus Torvalds's avatar
Linus Torvalds committed
619
 */
620
static void idetape_queue_pc_head(ide_drive_t *drive, struct ide_atapi_pc *pc,
621
				  struct request *rq)
Linus Torvalds's avatar
Linus Torvalds committed
622 623 624
{
	struct ide_tape_obj *tape = drive->driver_data;

625 626
	blk_rq_init(NULL, rq);
	rq->cmd_type = REQ_TYPE_SPECIAL;
627
	rq->cmd_flags |= REQ_PREEMPT;
Linus Torvalds's avatar
Linus Torvalds committed
628 629
	rq->buffer = (char *) pc;
	rq->rq_disk = tape->disk;
630
	memcpy(rq->cmd, pc->c, 12);
631
	rq->cmd[13] = REQ_IDETAPE_PC1;
632
	ide_do_drive_cmd(drive, rq);
Linus Torvalds's avatar
Linus Torvalds committed
633 634 635 636 637 638 639
}

/*
 *	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.
 */
640
static void idetape_retry_pc(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
641
{
642 643
	struct ide_tape_obj *tape = drive->driver_data;
	struct request *rq = &tape->request_sense_rq;
644
	struct ide_atapi_pc *pc = &tape->request_sense_pc;
Linus Torvalds's avatar
Linus Torvalds committed
645

646
	(void)ide_read_error(drive);
Linus Torvalds's avatar
Linus Torvalds committed
647
	idetape_create_request_sense_cmd(pc);
648
	set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
Linus Torvalds's avatar
Linus Torvalds committed
649 650 651 652
	idetape_queue_pc_head(drive, pc, rq);
}

/*
653 654
 * 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
655
 */
656
static void idetape_postpone_request(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
657 658 659
{
	idetape_tape_t *tape = drive->driver_data;

660 661
	debug_log(DBG_PROCS, "Enter %s\n", __func__);

Linus Torvalds's avatar
Linus Torvalds committed
662
	tape->postponed_rq = HWGROUP(drive)->rq;
663
	ide_stall_queue(drive, tape->dsc_poll_freq);
Linus Torvalds's avatar
Linus Torvalds committed
664 665
}

666 667 668 669 670 671 672 673 674 675 676 677
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);
}

678
static int ide_tape_io_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
679 680 681 682 683 684
				unsigned int bcount, int write)
{
	if (write)
		idetape_output_buffers(drive, pc, bcount);
	else
		idetape_input_buffers(drive, pc, bcount);
685 686

	return bcount;
687
}
688

Linus Torvalds's avatar
Linus Torvalds committed
689
/*
690 691 692 693
 * 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
694
 * idetape_issue_pc.
Linus Torvalds's avatar
Linus Torvalds committed
695
 */
696
static ide_startstop_t idetape_pc_intr(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
697 698 699
{
	idetape_tape_t *tape = drive->driver_data;

700 701 702
	return ide_pc_intr(drive, tape->pc, idetape_pc_intr, IDETAPE_WAIT_CMD,
			   NULL, idetape_update_buffers, idetape_retry_pc,
			   ide_tape_handle_dsc, ide_tape_io_buffers);
Linus Torvalds's avatar
Linus Torvalds committed
703 704 705
}

/*
706
 * Packet Command Interface
Linus Torvalds's avatar
Linus Torvalds committed
707
 *
708 709 710
 * The current Packet Command is available in tape->pc, and will not change
 * 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
711
 *
712
 * The handling will be done in three stages:
Linus Torvalds's avatar
Linus Torvalds committed
713
 *
714 715
 * 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
716
 *
717 718
 * 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
719
 *
720 721 722 723 724 725 726
 * 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
727
 *
728 729
 * 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
730
 *
731
 * 4. When the packet command is finished, it will be checked for errors.
Linus Torvalds's avatar
Linus Torvalds committed
732
 *
733 734 735
 * 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
736
 *
737 738 739
 * 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
740 741 742 743
 */
static ide_startstop_t idetape_transfer_pc(ide_drive_t *drive)
{
	idetape_tape_t *tape = drive->driver_data;
744

745 746
	return ide_transfer_pc(drive, tape->pc, idetape_pc_intr,
			       IDETAPE_WAIT_CMD, NULL);
Linus Torvalds's avatar
Linus Torvalds committed
747 748
}

749 750
static ide_startstop_t idetape_issue_pc(ide_drive_t *drive,
		struct ide_atapi_pc *pc)
Linus Torvalds's avatar
Linus Torvalds committed
751 752 753
{
	idetape_tape_t *tape = drive->driver_data;

754 755
	if (tape->pc->c[0] == REQUEST_SENSE &&
	    pc->c[0] == REQUEST_SENSE) {
Linus Torvalds's avatar
Linus Torvalds committed
756 757 758 759
		printk(KERN_ERR "ide-tape: possible ide-tape.c bug - "
			"Two request sense in serial were issued\n");
	}

760
	if (tape->failed_pc == NULL && pc->c[0] != REQUEST_SENSE)
Linus Torvalds's avatar
Linus Torvalds committed
761 762 763 764 765
		tape->failed_pc = pc;
	/* Set the current packet command */
	tape->pc = pc;

	if (pc->retries > IDETAPE_MAX_PC_RETRIES ||
766
		(pc->flags & PC_FLAG_ABORT)) {
Linus Torvalds's avatar
Linus Torvalds committed
767
		/*
768 769 770
		 * 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
771
		 */
772
		if (!(pc->flags & PC_FLAG_ABORT)) {
773
			if (!(pc->c[0] == TEST_UNIT_READY &&
Linus Torvalds's avatar
Linus Torvalds committed
774 775 776 777 778 779 780 781 782 783 784 785 786
			      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;
787
		drive->pc_callback(drive);
788
		return ide_stopped;
Linus Torvalds's avatar
Linus Torvalds committed
789
	}
790
	debug_log(DBG_SENSE, "Retry #%d, cmd = %02X\n", pc->retries, pc->c[0]);
Linus Torvalds's avatar
Linus Torvalds committed
791 792 793

	pc->retries++;

794 795
	return ide_issue_pc(drive, pc, idetape_transfer_pc,
			    IDETAPE_WAIT_CMD, NULL);
Linus Torvalds's avatar
Linus Torvalds committed
796 797
}

798
/* A mode sense command is used to "sense" tape parameters. */
799
static void idetape_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
Linus Torvalds's avatar
Linus Torvalds committed
800
{
801
	ide_init_pc(pc);
802
	pc->c[0] = MODE_SENSE;
Linus Torvalds's avatar
Linus Torvalds committed
803
	if (page_code != IDETAPE_BLOCK_DESCRIPTOR)
804 805
		/* DBD = 1 - Don't return block descriptors */
		pc->c[1] = 8;
Linus Torvalds's avatar
Linus Torvalds committed
806 807 808 809 810 811 812 813 814
	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;
815 816
	/* We will just discard data in that case */
	pc->c[4] = 255;
Linus Torvalds's avatar
Linus Torvalds committed
817
	if (page_code == IDETAPE_BLOCK_DESCRIPTOR)
818
		pc->req_xfer = 12;
Linus Torvalds's avatar
Linus Torvalds committed
819
	else if (page_code == IDETAPE_CAPABILITIES_PAGE)
820
		pc->req_xfer = 24;
Linus Torvalds's avatar
Linus Torvalds committed
821
	else
822
		pc->req_xfer = 50;
Linus Torvalds's avatar
Linus Torvalds committed
823 824
}

825
static ide_startstop_t idetape_media_access_finished(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
826
{
827
	ide_hwif_t *hwif = drive->hwif;
Linus Torvalds's avatar
Linus Torvalds committed
828
	idetape_tape_t *tape = drive->driver_data;
829
	struct ide_atapi_pc *pc = tape->pc;
830
	u8 stat;
Linus Torvalds's avatar
Linus Torvalds committed
831

832
	stat = hwif->tp_ops->read_status(hwif);
833

834 835
	if (stat & ATA_DSC) {
		if (stat & ATA_ERR) {
Linus Torvalds's avatar
Linus Torvalds committed
836
			/* Error detected */
837
			if (pc->c[0] != TEST_UNIT_READY)
Linus Torvalds's avatar
Linus Torvalds committed
838 839 840
				printk(KERN_ERR "ide-tape: %s: I/O error, ",
						tape->name);
			/* Retry operation */
841 842
			idetape_retry_pc(drive);
			return ide_stopped;
Linus Torvalds's avatar
Linus Torvalds committed
843 844 845 846 847 848
		}
		pc->error = 0;
	} else {
		pc->error = IDETAPE_ERROR_GENERAL;
		tape->failed_pc = NULL;
	}
849
	drive->pc_callback(drive);
Linus Torvalds's avatar
Linus Torvalds committed
850 851 852
	return ide_stopped;
}

853
static void ide_tape_create_rw_cmd(idetape_tape_t *tape,
854 855
				   struct ide_atapi_pc *pc, struct request *rq,
				   u8 opcode)
Linus Torvalds's avatar
Linus Torvalds committed
856
{
857 858 859
	struct idetape_bh *bh = (struct idetape_bh *)rq->special;
	unsigned int length = rq->current_nr_sectors;

860
	ide_init_pc(pc);
861
	put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
Linus Torvalds's avatar
Linus Torvalds committed
862 863
	pc->c[1] = 1;
	pc->bh = bh;
864 865 866
	pc->buf = NULL;
	pc->buf_size = length * tape->blk_size;
	pc->req_xfer = pc->buf_size;
867
	if (pc->req_xfer == tape->buffer_size)
868
		pc->flags |= PC_FLAG_DMA_OK;
Linus Torvalds's avatar
Linus Torvalds committed
869

870 871 872 873 874 875 876 877 878
	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);
	}
879 880

	memcpy(rq->cmd, pc->c, 12);
Linus Torvalds's avatar
Linus Torvalds committed
881 882 883 884 885
}

static ide_startstop_t idetape_do_request(ide_drive_t *drive,
					  struct request *rq, sector_t block)
{
886
	ide_hwif_t *hwif = drive->hwif;
Linus Torvalds's avatar
Linus Torvalds committed
887
	idetape_tape_t *tape = drive->driver_data;
888
	struct ide_atapi_pc *pc = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
889
	struct request *postponed_rq = tape->postponed_rq;
890
	u8 stat;
Linus Torvalds's avatar
Linus Torvalds committed
891

892 893 894 895
	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
896

897
	if (!blk_special_request(rq)) {
898
		/* We do not support buffer cache originated requests. */
Linus Torvalds's avatar
Linus Torvalds committed
899
		printk(KERN_NOTICE "ide-tape: %s: Unsupported request in "
900
			"request queue (%d)\n", drive->name, rq->cmd_type);
Linus Torvalds's avatar
Linus Torvalds committed
901 902 903 904
		ide_end_request(drive, 0, 0);
		return ide_stopped;
	}

905
	/* Retry a failed packet command */
906 907 908 909
	if (tape->failed_pc && tape->pc->c[0] == REQUEST_SENSE) {
		pc = tape->failed_pc;
		goto out;
	}
910

Linus Torvalds's avatar
Linus Torvalds committed
911 912 913 914 915 916 917 918 919 920 921 922 923 924
	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.
	 */
925
	stat = hwif->tp_ops->read_status(hwif);
Linus Torvalds's avatar
Linus Torvalds committed
926

927
	if (!drive->dsc_overlap && !(rq->cmd[13] & REQ_IDETAPE_PC2))
928
		set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
Linus Torvalds's avatar
Linus Torvalds committed
929 930

	if (drive->post_reset == 1) {
931
		set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
Linus Torvalds's avatar
Linus Torvalds committed
932 933 934
		drive->post_reset = 0;
	}

935
	if (!test_and_clear_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags) &&
936
	    (stat & ATA_DSC) == 0) {
Linus Torvalds's avatar
Linus Torvalds committed
937 938
		if (postponed_rq == NULL) {
			tape->dsc_polling_start = jiffies;
939
			tape->dsc_poll_freq = tape->best_dsc_rw_freq;
Linus Torvalds's avatar
Linus Torvalds committed
940 941 942 943
			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);
944
			if (rq->cmd[13] & REQ_IDETAPE_PC2) {
Linus Torvalds's avatar
Linus Torvalds committed
945 946 947 948 949
				idetape_media_access_finished(drive);
				return ide_stopped;
			} else {
				return ide_do_reset(drive);
			}
950 951 952
		} else if (time_after(jiffies,
					tape->dsc_polling_start +
					IDETAPE_DSC_MA_THRESHOLD))
953
			tape->dsc_poll_freq = IDETAPE_DSC_MA_SLOW;
Linus Torvalds's avatar
Linus Torvalds committed
954 955 956
		idetape_postpone_request(drive);
		return ide_stopped;
	}
957
	if (rq->cmd[13] & REQ_IDETAPE_READ) {
958
		pc = &tape->queued_pc;
959
		ide_tape_create_rw_cmd(tape, pc, rq, READ_6);
Linus Torvalds's avatar
Linus Torvalds committed
960 961
		goto out;
	}
962
	if (rq->cmd[13] & REQ_IDETAPE_WRITE) {
963
		pc = &tape->queued_pc;
964
		ide_tape_create_rw_cmd(tape, pc, rq, WRITE_6);
Linus Torvalds's avatar
Linus Torvalds committed
965 966
		goto out;
	}
967
	if (rq->cmd[13] & REQ_IDETAPE_PC1) {
968
		pc = (struct ide_atapi_pc *) rq->buffer;
969 970
		rq->cmd[13] &= ~(REQ_IDETAPE_PC1);
		rq->cmd[13] |= REQ_IDETAPE_PC2;
Linus Torvalds's avatar
Linus Torvalds committed
971 972
		goto out;
	}
973
	if (rq->cmd[13] & REQ_IDETAPE_PC2) {
Linus Torvalds's avatar
Linus Torvalds committed
974 975 976 977
		idetape_media_access_finished(drive);
		return ide_stopped;
	}
	BUG();