ide-tape.c 55.1 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 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
/* 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

/* 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
152
/*
153 154
 * 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
155 156
 */
typedef struct ide_tape_obj {
157 158 159
	ide_drive_t		*drive;
	struct ide_driver	*driver;
	struct gendisk		*disk;
160
	struct device		dev;
Linus Torvalds's avatar
Linus Torvalds committed
161

162 163
	/* used by REQ_IDETAPE_{READ,WRITE} requests */
	struct ide_atapi_pc queued_pc;
164

Linus Torvalds's avatar
Linus Torvalds committed
165
	/*
166
	 * DSC polling variables.
Linus Torvalds's avatar
Linus Torvalds committed
167
	 *
168 169 170
	 * 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
171
	 * data transfer) request in the device request queue.
Linus Torvalds's avatar
Linus Torvalds committed
172 173 174 175 176 177 178
	 */
	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 */
179 180
	unsigned long best_dsc_rw_freq;
	unsigned long dsc_poll_freq;
Linus Torvalds's avatar
Linus Torvalds committed
181 182
	unsigned long dsc_timeout;

183
	/* Read position information */
Linus Torvalds's avatar
Linus Torvalds committed
184 185
	u8 partition;
	/* Current block */
186
	unsigned int first_frame;
Linus Torvalds's avatar
Linus Torvalds committed
187

188
	/* Last error information */
Linus Torvalds's avatar
Linus Torvalds committed
189 190
	u8 sense_key, asc, ascq;

191
	/* Character device operation */
Linus Torvalds's avatar
Linus Torvalds committed
192 193 194 195
	unsigned int minor;
	/* device name */
	char name[4];
	/* Current character device data transfer direction */
196
	u8 chrdev_dir;
Linus Torvalds's avatar
Linus Torvalds committed
197

198 199
	/* tape block size, usually 512 or 1024 bytes */
	unsigned short blk_size;
Linus Torvalds's avatar
Linus Torvalds committed
200
	int user_bs_factor;
201

Linus Torvalds's avatar
Linus Torvalds committed
202
	/* Copy of the tape's Capabilities and Mechanical Page */
203
	u8 caps[20];
Linus Torvalds's avatar
Linus Torvalds committed
204 205

	/*
206
	 * Active data transfer request parameters.
Linus Torvalds's avatar
Linus Torvalds committed
207
	 *
208 209 210
	 * 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
211
	 */
212

213
	/* Data buffer size chosen based on the tape's recommendation */
214
	int buffer_size;
Tejun Heo's avatar
Tejun Heo committed
215 216 217 218 219 220
	/* Staging buffer of buffer_size bytes */
	void *buf;
	/* The read/write cursor */
	void *cur;
	/* The number of valid bytes in buf */
	size_t valid;
221 222

	/* Measures average tape speed */
Linus Torvalds's avatar
Linus Torvalds committed
223 224 225 226 227 228 229 230 231 232 233
	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;

234
	u32 debug_mask;
Linus Torvalds's avatar
Linus Torvalds committed
235 236
} idetape_tape_t;

237
static DEFINE_MUTEX(idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
238

239 240
static struct class *idetape_sysfs_class;

241
static void ide_tape_release(struct device *);
242

Linus Torvalds's avatar
Linus Torvalds committed
243 244 245 246
static struct ide_tape_obj *ide_tape_get(struct gendisk *disk)
{
	struct ide_tape_obj *tape = NULL;

247
	mutex_lock(&idetape_ref_mutex);
Borislav Petkov's avatar
Borislav Petkov committed
248
	tape = ide_drv_g(disk, ide_tape_obj);
249
	if (tape) {
250
		if (ide_device_get(tape->drive))
251
			tape = NULL;
252
		else
253
			get_device(&tape->dev);
254
	}
255
	mutex_unlock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
256 257 258 259 260
	return tape;
}

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

263
	mutex_lock(&idetape_ref_mutex);
264
	put_device(&tape->dev);
265
	ide_device_put(drive);
266
	mutex_unlock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
267 268 269
}

/*
270 271
 * 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
272
 */
273
static struct ide_tape_obj *idetape_devs[MAX_HWIFS * MAX_DRIVES];
Linus Torvalds's avatar
Linus Torvalds committed
274 275 276 277 278

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

279
	mutex_lock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
280 281
	tape = idetape_devs[i];
	if (tape)
282
		get_device(&tape->dev);
283
	mutex_unlock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
284 285 286 287
	return tape;
}

/*
288 289
 * 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
290
 */
291
static void idetape_analyze_error(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
292 293
{
	idetape_tape_t *tape = drive->driver_data;
294
	struct ide_atapi_pc *pc = drive->failed_pc;
295
	struct request *rq = drive->hwif->rq;
296
	u8 *sense = bio_data(rq->bio);
Linus Torvalds's avatar
Linus Torvalds committed
297

298 299 300
	tape->sense_key = sense[2] & 0xF;
	tape->asc       = sense[12];
	tape->ascq      = sense[13];
301 302 303

	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
304

305
	/* correct remaining bytes to transfer */
306
	if (pc->flags & PC_FLAG_DMA_ERROR)
307
		rq->resid_len = tape->blk_size * get_unaligned_be32(&sense[3]);
Linus Torvalds's avatar
Linus Torvalds committed
308 309 310 311 312 313

	/*
	 * 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.
	 */
314
	if ((pc->c[0] == READ_6 || pc->c[0] == WRITE_6)
315 316 317
	    /* 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
318 319 320
			/* don't report an error, everything's ok */
			pc->error = 0;
			/* don't retry read/write */
321
			pc->flags |= PC_FLAG_ABORT;
Linus Torvalds's avatar
Linus Torvalds committed
322 323
		}
	}
324
	if (pc->c[0] == READ_6 && (sense[2] & 0x80)) {
325
		pc->error = IDE_DRV_ERROR_FILEMARK;
326
		pc->flags |= PC_FLAG_ABORT;
Linus Torvalds's avatar
Linus Torvalds committed
327
	}
328
	if (pc->c[0] == WRITE_6) {
329 330
		if ((sense[2] & 0x40) || (tape->sense_key == 0xd
		     && tape->asc == 0x0 && tape->ascq == 0x2)) {
331
			pc->error = IDE_DRV_ERROR_EOD;
332
			pc->flags |= PC_FLAG_ABORT;
Linus Torvalds's avatar
Linus Torvalds committed
333 334
		}
	}
335
	if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
336
		if (tape->sense_key == 8) {
337
			pc->error = IDE_DRV_ERROR_EOD;
338
			pc->flags |= PC_FLAG_ABORT;
Linus Torvalds's avatar
Linus Torvalds committed
339
		}
340
		if (!(pc->flags & PC_FLAG_ABORT) &&
341
		    (blk_rq_bytes(rq) - rq->resid_len))
Linus Torvalds's avatar
Linus Torvalds committed
342 343 344 345
			pc->retries = IDETAPE_MAX_PC_RETRIES + 1;
	}
}

346 347
static void ide_tape_handle_dsc(ide_drive_t *);

348
static int ide_tape_callback(ide_drive_t *drive, int dsc)
Linus Torvalds's avatar
Linus Torvalds committed
349 350
{
	idetape_tape_t *tape = drive->driver_data;
351
	struct ide_atapi_pc *pc = drive->pc;
352
	struct request *rq = drive->hwif->rq;
353
	int uptodate = pc->error ? 0 : 1;
354
	int err = uptodate ? 0 : IDE_DRV_ERROR_GENERAL;
Linus Torvalds's avatar
Linus Torvalds committed
355

356 357
	debug_log(DBG_PROCS, "Enter %s\n", __func__);

358 359 360
	if (dsc)
		ide_tape_handle_dsc(drive);

361 362
	if (drive->failed_pc == pc)
		drive->failed_pc = NULL;
363

364 365
	if (pc->c[0] == REQUEST_SENSE) {
		if (uptodate)
366
			idetape_analyze_error(drive);
367 368 369 370
		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) {
371 372
		unsigned int blocks =
			(blk_rq_bytes(rq) - rq->resid_len) / tape->blk_size;
373 374 375 376 377 378 379 380 381 382 383 384

		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;

385 386 387 388
		if (pc->error) {
			uptodate = 0;
			err = pc->error;
		}
Linus Torvalds's avatar
Linus Torvalds committed
389
	}
390 391
	rq->errors = err;

392
	return uptodate;
Linus Torvalds's avatar
Linus Torvalds committed
393 394 395
}

/*
396
 * Postpone the current request so that ide.c will be able to service requests
397
 * from another device on the same port while we are polling for DSC.
Linus Torvalds's avatar
Linus Torvalds committed
398
 */
399
static void idetape_postpone_request(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
400 401 402
{
	idetape_tape_t *tape = drive->driver_data;

403 404
	debug_log(DBG_PROCS, "Enter %s\n", __func__);

405 406
	tape->postponed_rq = drive->hwif->rq;

407
	ide_stall_queue(drive, tape->dsc_poll_freq);
Linus Torvalds's avatar
Linus Torvalds committed
408 409
}

410 411 412 413 414 415 416 417 418 419 420 421
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);
}

Linus Torvalds's avatar
Linus Torvalds committed
422
/*
423
 * Packet Command Interface
Linus Torvalds's avatar
Linus Torvalds committed
424
 *
425
 * The current Packet Command is available in drive->pc, and will not change
426 427
 * 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
428
 *
429
 * The handling will be done in three stages:
Linus Torvalds's avatar
Linus Torvalds committed
430
 *
431
 * 1. ide_tape_issue_pc will send the packet command to the drive, and will set
432
 * the interrupt handler to ide_pc_intr.
Linus Torvalds's avatar
Linus Torvalds committed
433
 *
434
 * 2. On each interrupt, ide_pc_intr will be called. This step will be
435
 * repeated until the device signals us that no more interrupts will be issued.
Linus Torvalds's avatar
Linus Torvalds committed
436
 *
437 438 439 440 441 442 443
 * 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
444
 *
445 446
 * 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
447
 *
448
 * 4. When the packet command is finished, it will be checked for errors.
Linus Torvalds's avatar
Linus Torvalds committed
449
 *
450 451 452
 * 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
453
 *
454 455 456
 * 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
457 458
 */

459 460 461
static ide_startstop_t ide_tape_issue_pc(ide_drive_t *drive,
					 struct ide_cmd *cmd,
					 struct ide_atapi_pc *pc)
Linus Torvalds's avatar
Linus Torvalds committed
462 463
{
	idetape_tape_t *tape = drive->driver_data;
464
	struct request *rq = drive->hwif->rq;
Linus Torvalds's avatar
Linus Torvalds committed
465

466 467
	if (drive->failed_pc == NULL && pc->c[0] != REQUEST_SENSE)
		drive->failed_pc = pc;
468

Linus Torvalds's avatar
Linus Torvalds committed
469
	/* Set the current packet command */
470
	drive->pc = pc;
Linus Torvalds's avatar
Linus Torvalds committed
471 472

	if (pc->retries > IDETAPE_MAX_PC_RETRIES ||
473
		(pc->flags & PC_FLAG_ABORT)) {
474

Linus Torvalds's avatar
Linus Torvalds committed
475
		/*
476 477 478
		 * 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
479
		 */
480
		if (!(pc->flags & PC_FLAG_ABORT)) {
481
			if (!(pc->c[0] == TEST_UNIT_READY &&
Linus Torvalds's avatar
Linus Torvalds committed
482 483 484 485 486 487 488 489 490 491
			      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 */
492
			pc->error = IDE_DRV_ERROR_GENERAL;
Linus Torvalds's avatar
Linus Torvalds committed
493
		}
494

495
		drive->failed_pc = NULL;
496
		drive->pc_callback(drive, 0);
497
		ide_complete_rq(drive, -EIO, blk_rq_bytes(rq));
498
		return ide_stopped;
Linus Torvalds's avatar
Linus Torvalds committed
499
	}
500
	debug_log(DBG_SENSE, "Retry #%d, cmd = %02X\n", pc->retries, pc->c[0]);
Linus Torvalds's avatar
Linus Torvalds committed
501 502 503

	pc->retries++;

504
	return ide_issue_pc(drive, cmd);
Linus Torvalds's avatar
Linus Torvalds committed
505 506
}

507
/* A mode sense command is used to "sense" tape parameters. */
508
static void idetape_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
Linus Torvalds's avatar
Linus Torvalds committed
509
{
510
	ide_init_pc(pc);
511
	pc->c[0] = MODE_SENSE;
Linus Torvalds's avatar
Linus Torvalds committed
512
	if (page_code != IDETAPE_BLOCK_DESCRIPTOR)
513 514
		/* DBD = 1 - Don't return block descriptors */
		pc->c[1] = 8;
Linus Torvalds's avatar
Linus Torvalds committed
515 516 517 518 519 520 521 522 523
	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;
524 525
	/* We will just discard data in that case */
	pc->c[4] = 255;
Linus Torvalds's avatar
Linus Torvalds committed
526
	if (page_code == IDETAPE_BLOCK_DESCRIPTOR)
527
		pc->req_xfer = 12;
Linus Torvalds's avatar
Linus Torvalds committed
528
	else if (page_code == IDETAPE_CAPABILITIES_PAGE)
529
		pc->req_xfer = 24;
Linus Torvalds's avatar
Linus Torvalds committed
530
	else
531
		pc->req_xfer = 50;
Linus Torvalds's avatar
Linus Torvalds committed
532 533
}

534
static ide_startstop_t idetape_media_access_finished(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
535
{
536
	ide_hwif_t *hwif = drive->hwif;
Linus Torvalds's avatar
Linus Torvalds committed
537
	idetape_tape_t *tape = drive->driver_data;
538
	struct ide_atapi_pc *pc = drive->pc;
539
	u8 stat;
Linus Torvalds's avatar
Linus Torvalds committed
540

541
	stat = hwif->tp_ops->read_status(hwif);
542

543 544
	if (stat & ATA_DSC) {
		if (stat & ATA_ERR) {
Linus Torvalds's avatar
Linus Torvalds committed
545
			/* Error detected */
546
			if (pc->c[0] != TEST_UNIT_READY)
Linus Torvalds's avatar
Linus Torvalds committed
547 548 549
				printk(KERN_ERR "ide-tape: %s: I/O error, ",
						tape->name);
			/* Retry operation */
550
			ide_retry_pc(drive);
551
			return ide_stopped;
Linus Torvalds's avatar
Linus Torvalds committed
552 553 554
		}
		pc->error = 0;
	} else {
555
		pc->error = IDE_DRV_ERROR_GENERAL;
556
		drive->failed_pc = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
557
	}
558
	drive->pc_callback(drive, 0);
Linus Torvalds's avatar
Linus Torvalds committed
559 560 561
	return ide_stopped;
}

562
static void ide_tape_create_rw_cmd(idetape_tape_t *tape,
563 564
				   struct ide_atapi_pc *pc, struct request *rq,
				   u8 opcode)
Linus Torvalds's avatar
Linus Torvalds committed
565
{
566
	unsigned int length = blk_rq_sectors(rq) / (tape->blk_size >> 9);
567

568
	ide_init_pc(pc);
569
	put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
Linus Torvalds's avatar
Linus Torvalds committed
570
	pc->c[1] = 1;
571
	pc->buf = NULL;
572 573
	pc->buf_size = blk_rq_bytes(rq);
	if (pc->buf_size == tape->buffer_size)
574
		pc->flags |= PC_FLAG_DMA_OK;
Linus Torvalds's avatar
Linus Torvalds committed
575

Tejun Heo's avatar
Tejun Heo committed
576
	if (opcode == READ_6)
577
		pc->c[0] = READ_6;
Tejun Heo's avatar
Tejun Heo committed
578
	else if (opcode == WRITE_6) {
579 580 581
		pc->c[0] = WRITE_6;
		pc->flags |= PC_FLAG_WRITING;
	}
582 583

	memcpy(rq->cmd, pc->c, 12);
Linus Torvalds's avatar
Linus Torvalds committed
584 585 586 587 588
}

static ide_startstop_t idetape_do_request(ide_drive_t *drive,
					  struct request *rq, sector_t block)
{
589
	ide_hwif_t *hwif = drive->hwif;
Linus Torvalds's avatar
Linus Torvalds committed
590
	idetape_tape_t *tape = drive->driver_data;
591
	struct ide_atapi_pc *pc = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
592
	struct request *postponed_rq = tape->postponed_rq;
593
	struct ide_cmd cmd;
594
	u8 stat;
Linus Torvalds's avatar
Linus Torvalds committed
595

596 597
	debug_log(DBG_SENSE, "sector: %llu, nr_sectors: %u\n"
		  (unsigned long long)blk_rq_pos(rq), blk_rq_sectors(rq));
Linus Torvalds's avatar
Linus Torvalds committed
598

599
	if (!(blk_special_request(rq) || blk_sense_request(rq))) {
600
		/* We do not support buffer cache originated requests. */
Linus Torvalds's avatar
Linus Torvalds committed
601
		printk(KERN_NOTICE "ide-tape: %s: Unsupported request in "
602
			"request queue (%d)\n", drive->name, rq->cmd_type);
603 604
		if (blk_fs_request(rq) == 0 && rq->errors == 0)
			rq->errors = -EIO;
605
		ide_complete_rq(drive, -EIO, ide_rq_bytes(rq));
Linus Torvalds's avatar
Linus Torvalds committed
606 607 608
		return ide_stopped;
	}

609
	/* Retry a failed packet command */
610 611
	if (drive->failed_pc && drive->pc->c[0] == REQUEST_SENSE) {
		pc = drive->failed_pc;
612 613
		goto out;
	}
614

Linus Torvalds's avatar
Linus Torvalds committed
615 616 617 618
	if (postponed_rq != NULL)
		if (rq != postponed_rq) {
			printk(KERN_ERR "ide-tape: ide-tape.c bug - "
					"Two DSC requests were queued\n");
619
			drive->failed_pc = NULL;
620
			rq->errors = 0;
621
			ide_complete_rq(drive, 0, blk_rq_bytes(rq));
Linus Torvalds's avatar
Linus Torvalds committed
622 623 624 625 626 627 628 629 630
			return ide_stopped;
		}

	tape->postponed_rq = NULL;

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

633 634
	if ((drive->dev_flags & IDE_DFLAG_DSC_OVERLAP) == 0 &&
	    (rq->cmd[13] & REQ_IDETAPE_PC2) == 0)
635
		set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
Linus Torvalds's avatar
Linus Torvalds committed
636

637
	if (drive->dev_flags & IDE_DFLAG_POST_RESET) {
638
		set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
639
		drive->dev_flags &= ~IDE_DFLAG_POST_RESET;
Linus Torvalds's avatar
Linus Torvalds committed
640 641
	}

642
	if (!test_and_clear_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags) &&
643
	    (stat & ATA_DSC) == 0) {
Linus Torvalds's avatar
Linus Torvalds committed
644 645
		if (postponed_rq == NULL) {
			tape->dsc_polling_start = jiffies;
646
			tape->dsc_poll_freq = tape->best_dsc_rw_freq;
Linus Torvalds's avatar
Linus Torvalds committed
647 648 649 650
			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);
651
			if (rq->cmd[13] & REQ_IDETAPE_PC2) {
Linus Torvalds's avatar
Linus Torvalds committed
652 653 654 655 656
				idetape_media_access_finished(drive);
				return ide_stopped;
			} else {
				return ide_do_reset(drive);
			}
657 658 659
		} else if (time_after(jiffies,
					tape->dsc_polling_start +
					IDETAPE_DSC_MA_THRESHOLD))
660
			tape->dsc_poll_freq = IDETAPE_DSC_MA_SLOW;
Linus Torvalds's avatar
Linus Torvalds committed
661 662 663
		idetape_postpone_request(drive);
		return ide_stopped;
	}
664
	if (rq->cmd[13] & REQ_IDETAPE_READ) {
665
		pc = &tape->queued_pc;
666
		ide_tape_create_rw_cmd(tape, pc, rq, READ_6);
Linus Torvalds's avatar
Linus Torvalds committed
667 668
		goto out;
	}
669
	if (rq->cmd[13] & REQ_IDETAPE_WRITE) {
670
		pc = &tape->queued_pc;
671
		ide_tape_create_rw_cmd(tape, pc, rq, WRITE_6);
Linus Torvalds's avatar
Linus Torvalds committed
672 673
		goto out;
	}
674
	if (rq->cmd[13] & REQ_IDETAPE_PC1) {
Tejun Heo's avatar
Tejun Heo committed
675
		pc = (struct ide_atapi_pc *)rq->special;
676 677
		rq->cmd[13] &= ~(REQ_IDETAPE_PC1);
		rq->cmd[13] |= REQ_IDETAPE_PC2;
Linus Torvalds's avatar
Linus Torvalds committed
678 679
		goto out;
	}
680
	if (rq->cmd[13] & REQ_IDETAPE_PC2) {
Linus Torvalds's avatar
Linus Torvalds committed
681 682 683 684
		idetape_media_access_finished(drive);
		return ide_stopped;
	}
	BUG();
685

686
out:
687 688 689
	/* prepare sense request for this command */
	ide_prep_sense(drive, rq);

690 691 692 693 694 695 696
	memset(&cmd, 0, sizeof(cmd));

	if (rq_data_dir(rq))
		cmd.tf_flags |= IDE_TFLAG_WRITE;

	cmd.rq = rq;

697
	ide_init_sg_cmd(&cmd, blk_rq_bytes(rq));
698 699
	ide_map_sg(drive, &cmd);

700
	return ide_tape_issue_pc(drive, &cmd, pc);
Linus Torvalds's avatar
Linus Torvalds committed
701 702 703
}

/*
704 705
 * Write a filemark if write_filemark=1. Flush the device buffers without
 * writing a filemark otherwise.
Linus Torvalds's avatar
Linus Torvalds committed
706
 */
707
static void idetape_create_write_filemark_cmd(ide_drive_t *drive,
708
		struct ide_atapi_pc *pc, int write_filemark)
Linus Torvalds's avatar
Linus Torvalds committed
709
{
710
	ide_init_pc(pc);
711
	pc->c[0] = WRITE_FILEMARKS;
Linus Torvalds's avatar
Linus Torvalds committed
712
	pc->c[4] = write_filemark;
713
	pc->flags |= PC_FLAG_WAIT_FOR_DSC;
Linus Torvalds's avatar
Linus Torvalds committed
714 715 716 717 718
}

static int idetape_wait_ready(ide_drive_t *drive, unsigned long timeout)
{
	idetape_tape_t *tape = drive->driver_data;
719
	struct gendisk *disk = tape->disk;
Linus Torvalds's avatar
Linus Torvalds committed
720 721
	int load_attempted = 0;

722
	/* Wait for the tape to become ready */
723
	set_bit(IDE_AFLAG_MEDIUM_PRESENT, &drive->atapi_flags);
Linus Torvalds's avatar
Linus Torvalds committed
724 725
	timeout += jiffies;
	while (time_before(jiffies, timeout)) {
726
		if (ide_do_test_unit_ready(drive, disk) == 0)
Linus Torvalds's avatar
Linus Torvalds committed
727 728
			return 0;
		if ((tape->sense_key == 2 && tape->asc == 4 && tape->ascq == 2)
729 730
		    || (tape->asc == 0x3A)) {
			/* no media */
Linus Torvalds's avatar
Linus Torvalds committed
731 732
			if (load_attempted)
				return -ENOMEDIUM;
733
			ide_do_start_stop(drive, disk, IDETAPE_LU_LOAD_MASK);
Linus Torvalds's avatar
Linus Torvalds committed
734 735 736 737 738
			load_attempted = 1;
		/* not about to be ready */
		} else if (!(tape->sense_key == 2 && tape->asc == 4 &&
			     (tape->ascq == 1 || tape->ascq == 8)))
			return -EIO;
739
		msleep(100);
Linus Torvalds's avatar
Linus Torvalds committed
740 741 742 743
	}
	return -EIO;
}

744
static int idetape_flush_tape_buffers(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
745
{
746
	struct ide_tape_obj *tape = drive->driver_data;
747
	struct ide_atapi_pc pc;
Linus Torvalds's avatar
Linus Torvalds committed
748 749 750
	int rc;

	idetape_create_write_filemark_cmd(drive, &pc, 0);
751
	rc = ide_queue_pc_tail(drive, tape->disk, &pc, NULL, 0);
752
	if (rc)
Linus Torvalds's avatar
Linus Torvalds committed
753 754 755 756 757
		return rc;
	idetape_wait_ready(drive, 60 * 5 * HZ);
	return 0;
}

758
static int ide_tape_read_position(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
759 760
{
	idetape_tape_t *tape = drive->driver_data;
761
	struct ide_atapi_pc pc;
762
	u8 buf[20];
Linus Torvalds's avatar
Linus Torvalds committed
763

764
	debug_log(DBG_PROCS, "Enter %s\n", __func__);
Linus Torvalds's avatar
Linus Torvalds committed
765

766 767 768 769 770 771
	/* prep cmd */
	ide_init_pc(&pc);
	pc.c[0] = READ_POSITION;
	pc.req_xfer = 20;

	if (ide_queue_pc_tail(drive, tape->disk, &pc, buf, pc.req_xfer))
Linus Torvalds's avatar
Linus Torvalds committed
772
		return -1;
773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795

	if (!pc.error) {
		debug_log(DBG_SENSE, "BOP - %s\n",
				(buf[0] & 0x80) ? "Yes" : "No");
		debug_log(DBG_SENSE, "EOP - %s\n",
				(buf[0] & 0x40) ? "Yes" : "No");

		if (buf[0] & 0x4) {
			printk(KERN_INFO "ide-tape: Block location is unknown"
					 "to the tape\n");
			clear_bit(IDE_AFLAG_ADDRESS_VALID, &drive->atapi_flags);
			return -1;
		} else {
			debug_log(DBG_SENSE, "Block Location - %u\n",
					be32_to_cpup((__be32 *)&buf[4]));

			tape->partition = buf[1];
			tape->first_frame = be32_to_cpup((__be32 *)&buf[4]);
			set_bit(IDE_AFLAG_ADDRESS_VALID, &drive->atapi_flags);
		}
	}

	return tape->first_frame;
Linus Torvalds's avatar
Linus Torvalds committed
796 797
}

798 799
static void idetape_create_locate_cmd(ide_drive_t *drive,
		struct ide_atapi_pc *pc,
800
		unsigned int block, u8 partition, int skip)
Linus Torvalds's avatar
Linus Torvalds committed
801
{
802
	ide_init_pc(pc);
803
	pc->c[0] = POSITION_TO_ELEMENT;
Linus Torvalds's avatar
Linus Torvalds committed
804
	pc->c[1] = 2;
805
	put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[3]);
Linus Torvalds's avatar
Linus Torvalds committed
806
	pc->c[8] = partition;
807
	pc->flags |= PC_FLAG_WAIT_FOR_DSC;
Linus Torvalds's avatar
Linus Torvalds committed
808 809
}

810
static void __ide_tape_discard_merge_buffer(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
811 812 813
{
	idetape_tape_t *tape = drive->driver_data;

814
	if (tape->chrdev_dir != IDETAPE_DIR_READ)
815
		return;
Linus Torvalds's avatar
Linus Torvalds committed
816

817
	clear_bit(IDE_AFLAG_FILEMARK, &drive->atapi_flags);
Tejun Heo's avatar
Tejun Heo committed
818 819 820 821
	tape->valid = 0;
	if (tape->buf != NULL) {
		kfree(tape->buf);
		tape->buf = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
822 823
	}

824
	tape->chrdev_dir = IDETAPE_DIR_NONE;
Linus Torvalds's avatar
Linus Torvalds committed
825 826 827
}

/*
828 829 830 831
 * Position the tape to the requested block using the LOCATE packet command.
 * A READ POSITION command is then issued to check where we are positioned. Like
 * all higher level operations, we queue the commands at the tail of the request
 * queue and wait for their completion.
Linus Torvalds's avatar
Linus Torvalds committed
832
 */
833 834
static int idetape_position_tape(ide_drive_t *drive, unsigned int block,
		u8 partition, int skip)
Linus Torvalds's avatar
Linus Torvalds committed
835 836
{
	idetape_tape_t *tape = drive->driver_data;
837
	struct gendisk *disk = tape->disk;
838
	int ret;
839
	struct ide_atapi_pc pc;
Linus Torvalds's avatar
Linus Torvalds committed
840

841
	if (tape->chrdev_dir == IDETAPE_DIR_READ)
842
		__ide_tape_discard_merge_buffer(drive);
Linus Torvalds's avatar
Linus Torvalds committed
843 844
	idetape_wait_ready(drive, 60 * 5 * HZ);
	idetape_create_locate_cmd(drive, &pc, block, partition, skip);
845 846 847
	ret = ide_queue_pc_tail(drive, disk, &pc, NULL, 0);
	if (ret)
		return ret;
Linus Torvalds's avatar
Linus Torvalds committed
848

849 850 851 852
	ret = ide_tape_read_position(drive);
	if (ret < 0)
		return ret;
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
853 854
}

855
static void ide_tape_discard_merge_buffer(ide_drive_t *drive,
856
					  int restore_position)
Linus Torvalds's avatar
Linus Torvalds committed
857 858 859 860
{
	idetape_tape_t *tape = drive->driver_data;
	int seek, position;

861
	__ide_tape_discard_merge_buffer(drive);
Linus Torvalds's avatar
Linus Torvalds committed
862
	if (restore_position) {
863
		position = ide_tape_read_position(drive);
864
		seek = position > 0 ? position : 0;
Linus Torvalds's avatar
Linus Torvalds committed
865
		if (idetape_position_tape(drive, seek, 0, 0)) {
866
			printk(KERN_INFO "ide-tape: %s: position_tape failed in"
867
					 " %s\n", tape->name, __func__);
Linus Torvalds's avatar
Linus Torvalds committed
868 869 870 871 872 873
			return;
		}
	}
}

/*
874 875
 * Generate a read/write request for the block device interface and wait for it
 * to be serviced.
Linus Torvalds's avatar
Linus Torvalds committed
876
 */
877
static int idetape_queue_rw_tail(ide_drive_t *drive, int cmd, int size)
Linus Torvalds's avatar
Linus Torvalds committed
878 879
{
	idetape_tape_t *tape = drive->driver_data;
880
	struct request *rq;
881
	int ret;
Linus Torvalds's avatar
Linus Torvalds committed
882

883
	debug_log(DBG_SENSE, "%s: cmd=%d\n", __func__, cmd);
884
	BUG_ON(cmd != REQ_IDETAPE_READ && cmd != REQ_IDETAPE_WRITE);
885
	BUG_ON(size < 0 || size % tape->blk_size);
886

887 888
	rq = blk_get_request(drive->queue,