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

18 19
#define DRV_NAME "ide-tape"

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

#include <linux/module.h>
#include <linux/types.h>
#include <linux/string.h>
#include <linux/kernel.h>
#include <linux/delay.h>
#include <linux/timer.h>
#include <linux/mm.h>
#include <linux/interrupt.h>
30
#include <linux/jiffies.h>
Linus Torvalds's avatar
Linus Torvalds committed
31 32 33
#include <linux/major.h>
#include <linux/errno.h>
#include <linux/genhd.h>
Alexey Dobriyan's avatar
Alexey Dobriyan committed
34
#include <linux/seq_file.h>
Linus Torvalds's avatar
Linus Torvalds committed
35 36 37 38 39 40
#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>
41
#include <linux/mutex.h>
42
#include <scsi/scsi.h>
Linus Torvalds's avatar
Linus Torvalds committed
43 44

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

51
/* define to see debug info */
52
#undef IDETAPE_DEBUG_LOG
53

54 55
#ifdef IDETAPE_DEBUG_LOG
#define ide_debug_log(lvl, fmt, args...) __ide_debug_log(lvl, fmt, ## args)
56
#else
57
#define ide_debug_log(lvl, fmt, args...) do {} while (0)
58 59
#endif

Linus Torvalds's avatar
Linus Torvalds committed
60 61
/**************************** Tunable parameters *****************************/
/*
62 63
 * 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
64
 *
65
 * Setting IDETAPE_MAX_PC_RETRIES to 0 will disable retries.
Linus Torvalds's avatar
Linus Torvalds committed
66 67 68 69
 */
#define IDETAPE_MAX_PC_RETRIES		3

/*
70 71 72 73
 * 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
74
 */
75
#define IDETAPE_FIFO_THRESHOLD		2
Linus Torvalds's avatar
Linus Torvalds committed
76 77

/*
78
 * DSC polling parameters.
Linus Torvalds's avatar
Linus Torvalds committed
79
 *
80 81
 * 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
82
 *
83 84 85 86 87
 * 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
88
 *
89 90 91 92 93 94 95 96
 * 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
97
 *
98 99
 * 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
100
 */
101 102

/* DSC timings. */
Linus Torvalds's avatar
Linus Torvalds committed
103 104 105 106 107 108 109 110 111 112
#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 ***********************/

113 114 115 116 117 118
/* 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
119

120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
/* 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
138
/*
139 140
 * 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
141 142
 */
typedef struct ide_tape_obj {
143 144 145
	ide_drive_t		*drive;
	struct ide_driver	*driver;
	struct gendisk		*disk;
146
	struct device		dev;
Linus Torvalds's avatar
Linus Torvalds committed
147

148 149
	/* used by REQ_IDETAPE_{READ,WRITE} requests */
	struct ide_atapi_pc queued_pc;
150

Linus Torvalds's avatar
Linus Torvalds committed
151
	/*
152
	 * DSC polling variables.
Linus Torvalds's avatar
Linus Torvalds committed
153
	 *
154 155 156
	 * 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
157
	 * data transfer) request in the device request queue.
Linus Torvalds's avatar
Linus Torvalds committed
158
	 */
159 160
	bool postponed_rq;

Linus Torvalds's avatar
Linus Torvalds committed
161 162 163 164 165
	/* 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 */
166 167
	unsigned long best_dsc_rw_freq;
	unsigned long dsc_poll_freq;
Linus Torvalds's avatar
Linus Torvalds committed
168 169
	unsigned long dsc_timeout;

170
	/* Read position information */
Linus Torvalds's avatar
Linus Torvalds committed
171 172
	u8 partition;
	/* Current block */
173
	unsigned int first_frame;
Linus Torvalds's avatar
Linus Torvalds committed
174

175
	/* Last error information */
Linus Torvalds's avatar
Linus Torvalds committed
176 177
	u8 sense_key, asc, ascq;

178
	/* Character device operation */
Linus Torvalds's avatar
Linus Torvalds committed
179 180 181 182
	unsigned int minor;
	/* device name */
	char name[4];
	/* Current character device data transfer direction */
183
	u8 chrdev_dir;
Linus Torvalds's avatar
Linus Torvalds committed
184

185 186
	/* tape block size, usually 512 or 1024 bytes */
	unsigned short blk_size;
Linus Torvalds's avatar
Linus Torvalds committed
187
	int user_bs_factor;
188

Linus Torvalds's avatar
Linus Torvalds committed
189
	/* Copy of the tape's Capabilities and Mechanical Page */
190
	u8 caps[20];
Linus Torvalds's avatar
Linus Torvalds committed
191 192

	/*
193
	 * Active data transfer request parameters.
Linus Torvalds's avatar
Linus Torvalds committed
194
	 *
195 196 197
	 * 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
198
	 */
199

200
	/* Data buffer size chosen based on the tape's recommendation */
201
	int buffer_size;
Tejun Heo's avatar
Tejun Heo committed
202 203 204 205 206 207
	/* Staging buffer of buffer_size bytes */
	void *buf;
	/* The read/write cursor */
	void *cur;
	/* The number of valid bytes in buf */
	size_t valid;
208 209

	/* Measures average tape speed */
Linus Torvalds's avatar
Linus Torvalds committed
210 211 212 213 214 215 216 217 218 219 220 221
	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;
} idetape_tape_t;

222
static DEFINE_MUTEX(idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
223

Borislav Petkov's avatar
Borislav Petkov committed
224 225
static DEFINE_MUTEX(idetape_chrdev_mutex);

226 227
static struct class *idetape_sysfs_class;

228
static void ide_tape_release(struct device *);
229

Borislav Petkov's avatar
Borislav Petkov committed
230 231 232 233
static struct ide_tape_obj *idetape_devs[MAX_HWIFS * MAX_DRIVES];

static struct ide_tape_obj *ide_tape_get(struct gendisk *disk, bool cdev,
					 unsigned int i)
Linus Torvalds's avatar
Linus Torvalds committed
234 235 236
{
	struct ide_tape_obj *tape = NULL;

237
	mutex_lock(&idetape_ref_mutex);
Borislav Petkov's avatar
Borislav Petkov committed
238 239 240 241 242 243

	if (cdev)
		tape = idetape_devs[i];
	else
		tape = ide_drv_g(disk, ide_tape_obj);

244
	if (tape) {
245
		if (ide_device_get(tape->drive))
246
			tape = NULL;
247
		else
248
			get_device(&tape->dev);
249
	}
Borislav Petkov's avatar
Borislav Petkov committed
250

251
	mutex_unlock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
252 253 254 255 256
	return tape;
}

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

259
	mutex_lock(&idetape_ref_mutex);
260
	put_device(&tape->dev);
261
	ide_device_put(drive);
262
	mutex_unlock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
263 264 265
}

/*
266 267
 * 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
268
 */
269
static void idetape_analyze_error(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
270 271
{
	idetape_tape_t *tape = drive->driver_data;
272
	struct ide_atapi_pc *pc = drive->failed_pc;
273
	struct request *rq = drive->hwif->rq;
274
	u8 *sense = bio_data(rq->bio);
Linus Torvalds's avatar
Linus Torvalds committed
275

276 277 278
	tape->sense_key = sense[2] & 0xF;
	tape->asc       = sense[12];
	tape->ascq      = sense[13];
279

280 281 282
	ide_debug_log(IDE_DBG_FUNC,
		      "cmd: 0x%x, sense key = %x, asc = %x, ascq = %x",
		      rq->cmd[0], tape->sense_key, tape->asc, tape->ascq);
Linus Torvalds's avatar
Linus Torvalds committed
283

284
	/* correct remaining bytes to transfer */
285
	if (pc->flags & PC_FLAG_DMA_ERROR)
286
		rq->resid_len = tape->blk_size * get_unaligned_be32(&sense[3]);
Linus Torvalds's avatar
Linus Torvalds committed
287 288 289 290 291 292

	/*
	 * 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.
	 */
293
	if ((pc->c[0] == READ_6 || pc->c[0] == WRITE_6)
294 295 296
	    /* 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
297 298 299
			/* don't report an error, everything's ok */
			pc->error = 0;
			/* don't retry read/write */
300
			pc->flags |= PC_FLAG_ABORT;
Linus Torvalds's avatar
Linus Torvalds committed
301 302
		}
	}
303
	if (pc->c[0] == READ_6 && (sense[2] & 0x80)) {
304
		pc->error = IDE_DRV_ERROR_FILEMARK;
305
		pc->flags |= PC_FLAG_ABORT;
Linus Torvalds's avatar
Linus Torvalds committed
306
	}
307
	if (pc->c[0] == WRITE_6) {
308 309
		if ((sense[2] & 0x40) || (tape->sense_key == 0xd
		     && tape->asc == 0x0 && tape->ascq == 0x2)) {
310
			pc->error = IDE_DRV_ERROR_EOD;
311
			pc->flags |= PC_FLAG_ABORT;
Linus Torvalds's avatar
Linus Torvalds committed
312 313
		}
	}
314
	if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
315
		if (tape->sense_key == 8) {
316
			pc->error = IDE_DRV_ERROR_EOD;
317
			pc->flags |= PC_FLAG_ABORT;
Linus Torvalds's avatar
Linus Torvalds committed
318
		}
319
		if (!(pc->flags & PC_FLAG_ABORT) &&
320
		    (blk_rq_bytes(rq) - rq->resid_len))
Linus Torvalds's avatar
Linus Torvalds committed
321 322 323 324
			pc->retries = IDETAPE_MAX_PC_RETRIES + 1;
	}
}

325 326
static void ide_tape_handle_dsc(ide_drive_t *);

327
static int ide_tape_callback(ide_drive_t *drive, int dsc)
Linus Torvalds's avatar
Linus Torvalds committed
328 329
{
	idetape_tape_t *tape = drive->driver_data;
330
	struct ide_atapi_pc *pc = drive->pc;
331
	struct request *rq = drive->hwif->rq;
332
	int uptodate = pc->error ? 0 : 1;
333
	int err = uptodate ? 0 : IDE_DRV_ERROR_GENERAL;
Linus Torvalds's avatar
Linus Torvalds committed
334

335 336
	ide_debug_log(IDE_DBG_FUNC, "cmd: 0x%x, dsc: %d, err: %d", rq->cmd[0],
		      dsc, err);
337

338 339 340
	if (dsc)
		ide_tape_handle_dsc(drive);

341 342
	if (drive->failed_pc == pc)
		drive->failed_pc = NULL;
343

344 345
	if (pc->c[0] == REQUEST_SENSE) {
		if (uptodate)
346
			idetape_analyze_error(drive);
347 348 349 350
		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) {
351 352
		unsigned int blocks =
			(blk_rq_bytes(rq) - rq->resid_len) / tape->blk_size;
353 354 355 356 357 358 359 360 361 362 363 364

		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;

365 366 367 368
		if (pc->error) {
			uptodate = 0;
			err = pc->error;
		}
Linus Torvalds's avatar
Linus Torvalds committed
369
	}
370 371
	rq->errors = err;

372
	return uptodate;
Linus Torvalds's avatar
Linus Torvalds committed
373 374 375
}

/*
376
 * Postpone the current request so that ide.c will be able to service requests
377
 * from another device on the same port while we are polling for DSC.
Linus Torvalds's avatar
Linus Torvalds committed
378
 */
379
static void ide_tape_stall_queue(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
380 381 382
{
	idetape_tape_t *tape = drive->driver_data;

383
	ide_debug_log(IDE_DBG_FUNC, "cmd: 0x%x, dsc_poll_freq: %lu",
384
		      drive->hwif->rq->cmd[0], tape->dsc_poll_freq);
385

386
	tape->postponed_rq = true;
387

388
	ide_stall_queue(drive, tape->dsc_poll_freq);
Linus Torvalds's avatar
Linus Torvalds committed
389 390
}

391 392 393 394 395 396 397 398 399
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 */
400
	ide_tape_stall_queue(drive);
401 402
}

Linus Torvalds's avatar
Linus Torvalds committed
403
/*
404
 * Packet Command Interface
Linus Torvalds's avatar
Linus Torvalds committed
405
 *
406
 * The current Packet Command is available in drive->pc, and will not change
407 408
 * 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
409
 *
410
 * The handling will be done in three stages:
Linus Torvalds's avatar
Linus Torvalds committed
411
 *
412
 * 1. ide_tape_issue_pc will send the packet command to the drive, and will set
413
 * the interrupt handler to ide_pc_intr.
Linus Torvalds's avatar
Linus Torvalds committed
414
 *
415
 * 2. On each interrupt, ide_pc_intr will be called. This step will be
416
 * repeated until the device signals us that no more interrupts will be issued.
Linus Torvalds's avatar
Linus Torvalds committed
417
 *
418 419 420 421 422 423 424
 * 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
425
 *
426 427
 * 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
428
 *
429
 * 4. When the packet command is finished, it will be checked for errors.
Linus Torvalds's avatar
Linus Torvalds committed
430
 *
431 432 433
 * 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
434
 *
435 436 437
 * 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
438 439
 */

440 441 442
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
443 444
{
	idetape_tape_t *tape = drive->driver_data;
445
	struct request *rq = drive->hwif->rq;
Linus Torvalds's avatar
Linus Torvalds committed
446

447 448
	if (drive->failed_pc == NULL && pc->c[0] != REQUEST_SENSE)
		drive->failed_pc = pc;
449

Linus Torvalds's avatar
Linus Torvalds committed
450
	/* Set the current packet command */
451
	drive->pc = pc;
Linus Torvalds's avatar
Linus Torvalds committed
452 453

	if (pc->retries > IDETAPE_MAX_PC_RETRIES ||
454
		(pc->flags & PC_FLAG_ABORT)) {
455

Linus Torvalds's avatar
Linus Torvalds committed
456
		/*
457 458 459
		 * 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
460
		 */
461
		if (!(pc->flags & PC_FLAG_ABORT)) {
462
			if (!(pc->c[0] == TEST_UNIT_READY &&
Linus Torvalds's avatar
Linus Torvalds committed
463 464 465 466 467 468 469 470 471 472
			      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 */
473
			pc->error = IDE_DRV_ERROR_GENERAL;
Linus Torvalds's avatar
Linus Torvalds committed
474
		}
475

476
		drive->failed_pc = NULL;
477
		drive->pc_callback(drive, 0);
478
		ide_complete_rq(drive, -EIO, blk_rq_bytes(rq));
479
		return ide_stopped;
Linus Torvalds's avatar
Linus Torvalds committed
480
	}
481 482
	ide_debug_log(IDE_DBG_SENSE, "retry #%d, cmd: 0x%02x", pc->retries,
		      pc->c[0]);
Linus Torvalds's avatar
Linus Torvalds committed
483 484 485

	pc->retries++;

486
	return ide_issue_pc(drive, cmd);
Linus Torvalds's avatar
Linus Torvalds committed
487 488
}

489
/* A mode sense command is used to "sense" tape parameters. */
490
static void idetape_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
Linus Torvalds's avatar
Linus Torvalds committed
491
{
492
	ide_init_pc(pc);
493
	pc->c[0] = MODE_SENSE;
Linus Torvalds's avatar
Linus Torvalds committed
494
	if (page_code != IDETAPE_BLOCK_DESCRIPTOR)
495 496
		/* DBD = 1 - Don't return block descriptors */
		pc->c[1] = 8;
Linus Torvalds's avatar
Linus Torvalds committed
497 498 499 500 501 502 503 504 505
	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;
506 507
	/* We will just discard data in that case */
	pc->c[4] = 255;
Linus Torvalds's avatar
Linus Torvalds committed
508
	if (page_code == IDETAPE_BLOCK_DESCRIPTOR)
509
		pc->req_xfer = 12;
Linus Torvalds's avatar
Linus Torvalds committed
510
	else if (page_code == IDETAPE_CAPABILITIES_PAGE)
511
		pc->req_xfer = 24;
Linus Torvalds's avatar
Linus Torvalds committed
512
	else
513
		pc->req_xfer = 50;
Linus Torvalds's avatar
Linus Torvalds committed
514 515
}

516
static ide_startstop_t idetape_media_access_finished(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
517
{
518
	ide_hwif_t *hwif = drive->hwif;
Linus Torvalds's avatar
Linus Torvalds committed
519
	idetape_tape_t *tape = drive->driver_data;
520
	struct ide_atapi_pc *pc = drive->pc;
521
	u8 stat;
Linus Torvalds's avatar
Linus Torvalds committed
522

523
	stat = hwif->tp_ops->read_status(hwif);
524

525 526
	if (stat & ATA_DSC) {
		if (stat & ATA_ERR) {
Linus Torvalds's avatar
Linus Torvalds committed
527
			/* Error detected */
528
			if (pc->c[0] != TEST_UNIT_READY)
Linus Torvalds's avatar
Linus Torvalds committed
529 530 531
				printk(KERN_ERR "ide-tape: %s: I/O error, ",
						tape->name);
			/* Retry operation */
532
			ide_retry_pc(drive);
533
			return ide_stopped;
Linus Torvalds's avatar
Linus Torvalds committed
534 535 536
		}
		pc->error = 0;
	} else {
537
		pc->error = IDE_DRV_ERROR_GENERAL;
538
		drive->failed_pc = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
539
	}
540
	drive->pc_callback(drive, 0);
Linus Torvalds's avatar
Linus Torvalds committed
541 542 543
	return ide_stopped;
}

544
static void ide_tape_create_rw_cmd(idetape_tape_t *tape,
545 546
				   struct ide_atapi_pc *pc, struct request *rq,
				   u8 opcode)
Linus Torvalds's avatar
Linus Torvalds committed
547
{
548
	unsigned int length = blk_rq_sectors(rq) / (tape->blk_size >> 9);
549

550
	ide_init_pc(pc);
551
	put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
Linus Torvalds's avatar
Linus Torvalds committed
552
	pc->c[1] = 1;
Borislav Petkov's avatar
Borislav Petkov committed
553 554

	if (blk_rq_bytes(rq) == tape->buffer_size)
555
		pc->flags |= PC_FLAG_DMA_OK;
Linus Torvalds's avatar
Linus Torvalds committed
556

Tejun Heo's avatar
Tejun Heo committed
557
	if (opcode == READ_6)
558
		pc->c[0] = READ_6;
Tejun Heo's avatar
Tejun Heo committed
559
	else if (opcode == WRITE_6) {
560 561 562
		pc->c[0] = WRITE_6;
		pc->flags |= PC_FLAG_WRITING;
	}
563 564

	memcpy(rq->cmd, pc->c, 12);
Linus Torvalds's avatar
Linus Torvalds committed
565 566 567 568 569
}

static ide_startstop_t idetape_do_request(ide_drive_t *drive,
					  struct request *rq, sector_t block)
{
570
	ide_hwif_t *hwif = drive->hwif;
Linus Torvalds's avatar
Linus Torvalds committed
571
	idetape_tape_t *tape = drive->driver_data;
572
	struct ide_atapi_pc *pc = NULL;
573
	struct ide_cmd cmd;
574
	u8 stat;
Linus Torvalds's avatar
Linus Torvalds committed
575

576 577 578
	ide_debug_log(IDE_DBG_RQ, "cmd: 0x%x, sector: %llu, nr_sectors: %u",
		      rq->cmd[0], (unsigned long long)blk_rq_pos(rq),
		      blk_rq_sectors(rq));
Linus Torvalds's avatar
Linus Torvalds committed
579

580
	BUG_ON(!(blk_special_request(rq) || blk_sense_request(rq)));
Linus Torvalds's avatar
Linus Torvalds committed
581

582
	/* Retry a failed packet command */
583 584
	if (drive->failed_pc && drive->pc->c[0] == REQUEST_SENSE) {
		pc = drive->failed_pc;
585 586
		goto out;
	}
587

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

594 595
	if ((drive->dev_flags & IDE_DFLAG_DSC_OVERLAP) == 0 &&
	    (rq->cmd[13] & REQ_IDETAPE_PC2) == 0)
596
		drive->atapi_flags |= IDE_AFLAG_IGNORE_DSC;
Linus Torvalds's avatar
Linus Torvalds committed
597

598
	if (drive->dev_flags & IDE_DFLAG_POST_RESET) {
599
		drive->atapi_flags |= IDE_AFLAG_IGNORE_DSC;
600
		drive->dev_flags &= ~IDE_DFLAG_POST_RESET;
Linus Torvalds's avatar
Linus Torvalds committed
601 602
	}

603 604
	if (!(drive->atapi_flags & IDE_AFLAG_IGNORE_DSC) &&
	    !(stat & ATA_DSC)) {
605
		if (!tape->postponed_rq) {
Linus Torvalds's avatar
Linus Torvalds committed
606
			tape->dsc_polling_start = jiffies;
607
			tape->dsc_poll_freq = tape->best_dsc_rw_freq;
Linus Torvalds's avatar
Linus Torvalds committed
608 609 610 611
			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);
612
			if (rq->cmd[13] & REQ_IDETAPE_PC2) {
Linus Torvalds's avatar
Linus Torvalds committed
613 614 615 616 617
				idetape_media_access_finished(drive);
				return ide_stopped;
			} else {
				return ide_do_reset(drive);
			}
618 619 620
		} else if (time_after(jiffies,
					tape->dsc_polling_start +
					IDETAPE_DSC_MA_THRESHOLD))
621
			tape->dsc_poll_freq = IDETAPE_DSC_MA_SLOW;
622
		ide_tape_stall_queue(drive);
Linus Torvalds's avatar
Linus Torvalds committed
623
		return ide_stopped;
624
	} else {
625
		drive->atapi_flags &= ~IDE_AFLAG_IGNORE_DSC;
626 627
		tape->postponed_rq = false;
	}
628

629
	if (rq->cmd[13] & REQ_IDETAPE_READ) {
630
		pc = &tape->queued_pc;
631
		ide_tape_create_rw_cmd(tape, pc, rq, READ_6);
Linus Torvalds's avatar
Linus Torvalds committed
632 633
		goto out;
	}
634
	if (rq->cmd[13] & REQ_IDETAPE_WRITE) {
635
		pc = &tape->queued_pc;
636
		ide_tape_create_rw_cmd(tape, pc, rq, WRITE_6);
Linus Torvalds's avatar
Linus Torvalds committed
637 638
		goto out;
	}
639
	if (rq->cmd[13] & REQ_IDETAPE_PC1) {
Tejun Heo's avatar
Tejun Heo committed
640
		pc = (struct ide_atapi_pc *)rq->special;
641 642
		rq->cmd[13] &= ~(REQ_IDETAPE_PC1);
		rq->cmd[13] |= REQ_IDETAPE_PC2;
Linus Torvalds's avatar
Linus Torvalds committed
643 644
		goto out;
	}
645
	if (rq->cmd[13] & REQ_IDETAPE_PC2) {
Linus Torvalds's avatar
Linus Torvalds committed
646 647 648 649
		idetape_media_access_finished(drive);
		return ide_stopped;
	}
	BUG();
650

651
out:
652 653 654
	/* prepare sense request for this command */
	ide_prep_sense(drive, rq);

655 656 657 658 659 660 661
	memset(&cmd, 0, sizeof(cmd));

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

	cmd.rq = rq;

662
	ide_init_sg_cmd(&cmd, blk_rq_bytes(rq));
663 664
	ide_map_sg(drive, &cmd);

665
	return ide_tape_issue_pc(drive, &cmd, pc);
Linus Torvalds's avatar
Linus Torvalds committed
666 667 668
}

/*
669 670
 * Write a filemark if write_filemark=1. Flush the device buffers without
 * writing a filemark otherwise.
Linus Torvalds's avatar
Linus Torvalds committed
671
 */
672
static void idetape_create_write_filemark_cmd(ide_drive_t *drive,
673
		struct ide_atapi_pc *pc, int write_filemark)
Linus Torvalds's avatar
Linus Torvalds committed
674
{
675
	ide_init_pc(pc);
676
	pc->c[0] = WRITE_FILEMARKS;
Linus Torvalds's avatar
Linus Torvalds committed
677
	pc->c[4] = write_filemark;
678
	pc->flags |= PC_FLAG_WAIT_FOR_DSC;
Linus Torvalds's avatar
Linus Torvalds committed
679 680 681 682 683
}

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

687
	/* Wait for the tape to become ready */
688
	set_bit(ilog2(IDE_AFLAG_MEDIUM_PRESENT), &drive->atapi_flags);
Linus Torvalds's avatar
Linus Torvalds committed
689 690
	timeout += jiffies;
	while (time_before(jiffies, timeout)) {
691
		if (ide_do_test_unit_ready(drive, disk) == 0)
Linus Torvalds's avatar
Linus Torvalds committed
692 693
			return 0;
		if ((tape->sense_key == 2 && tape->asc == 4 && tape->ascq == 2)
694 695
		    || (tape->asc == 0x3A)) {
			/* no media */
Linus Torvalds's avatar
Linus Torvalds committed
696 697
			if (load_attempted)
				return -ENOMEDIUM;
698
			ide_do_start_stop(drive, disk, IDETAPE_LU_LOAD_MASK);
Linus Torvalds's avatar
Linus Torvalds committed
699 700 701 702 703
			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;
704
		msleep(100);
Linus Torvalds's avatar
Linus Torvalds committed
705 706 707 708
	}
	return -EIO;
}

709
static int idetape_flush_tape_buffers(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
710
{
711
	struct ide_tape_obj *tape = drive->driver_data;
712
	struct ide_atapi_pc pc;
Linus Torvalds's avatar
Linus Torvalds committed
713 714 715
	int rc;

	idetape_create_write_filemark_cmd(drive, &pc, 0);
716
	rc = ide_queue_pc_tail(drive, tape->disk, &pc, NULL, 0);
717
	if (rc)
Linus Torvalds's avatar
Linus Torvalds committed
718 719 720 721 722
		return rc;
	idetape_wait_ready(drive, 60 * 5 * HZ);
	return 0;
}

723
static int ide_tape_read_position(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
724 725
{
	idetape_tape_t *tape = drive->driver_data;
726
	struct ide_atapi_pc pc;
727
	u8 buf[20];
Linus Torvalds's avatar
Linus Torvalds committed
728

729
	ide_debug_log(IDE_DBG_FUNC, "enter");
Linus Torvalds's avatar
Linus Torvalds committed
730

731 732 733 734 735 736
	/* 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
737
		return -1;
738 739

	if (!pc.error) {
740
		ide_debug_log(IDE_DBG_FUNC, "BOP - %s",
741
				(buf[0] & 0x80) ? "Yes" : "No");
742
		ide_debug_log(IDE_DBG_FUNC, "EOP - %s",
743 744 745 746 747
				(buf[0] & 0x40) ? "Yes" : "No");

		if (buf[0] & 0x4) {
			printk(KERN_INFO "ide-tape: Block location is unknown"
					 "to the tape\n");
748 749
			clear_bit(ilog2(IDE_AFLAG_ADDRESS_VALID),
				  &drive->atapi_flags);
750 751
			return -1;
		} else {
752 753
			ide_debug_log(IDE_DBG_FUNC, "Block Location: %u",
				      be32_to_cpup((__be32 *)&buf[4]));
754 755 756

			tape->partition = buf[1];
			tape->first_frame = be32_to_cpup((__be32 *)&buf[4]);
757 758
			set_bit(ilog2(IDE_AFLAG_ADDRESS_VALID),
				&drive->atapi_flags);
759 760 761 762
		}
	}

	return tape->first_frame;
Linus Torvalds's avatar
Linus Torvalds committed
763 764
}

765 766
static void idetape_create_locate_cmd(ide_drive_t *drive,
		struct ide_atapi_pc *pc,
767
		unsigned int block, u8 partition, int skip)
Linus Torvalds's avatar
Linus Torvalds committed
768
{
769
	ide_init_pc(pc);
770
	pc->c[0] = POSITION_TO_ELEMENT;
Linus Torvalds's avatar
Linus Torvalds committed
771
	pc->c[1] = 2;
772
	put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[3]);
Linus Torvalds's avatar
Linus Torvalds committed
773
	pc->c[8] = partition;
774
	pc->flags |= PC_FLAG_WAIT_FOR_DSC;
Linus Torvalds's avatar
Linus Torvalds committed
775 776
}

777
static void __ide_tape_discard_merge_buffer(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
778 779 780
{
	idetape_tape_t *tape = drive->driver_data;

781
	if (tape->chrdev_dir != IDETAPE_DIR_READ)
782
		return;
Linus Torvalds's avatar
Linus Torvalds committed
783

784
	clear_bit(ilog2(IDE_AFLAG_FILEMARK), &drive->atapi_flags);
Tejun Heo's avatar
Tejun Heo committed
785 786 787 788
	tape->valid = 0;
	if (tape->buf != NULL) {
		kfree(tape->buf);
		tape->buf = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
789 790
	}

791
	tape->chrdev_dir = IDETAPE_DIR_NONE;
Linus Torvalds's avatar
Linus Torvalds committed
792 793 794
}

/*
795 796 797 798
 * 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
799
 */
800 801
static int idetape_position_tape(ide_drive_t *drive, unsigned int block,
		u8 partition, int skip)
Linus Torvalds's avatar
Linus Torvalds committed
802 803
{
	idetape_tape_t *tape = drive->driver_data;
804
	struct gendisk *disk = tape->disk;
805
	int ret;
806
	struct ide_atapi_pc pc;
Linus Torvalds's avatar
Linus Torvalds committed
807

808
	if (tape->chrdev_dir == IDETAPE_DIR_READ)
809
		__ide_tape_discard_merge_buffer(drive);
Linus Torvalds's avatar
Linus Torvalds committed
810 811
	idetape_wait_ready(drive, 60 * 5 * HZ);
	idetape_create_locate_cmd(drive, &pc, block, partition, skip);
812 813 814
	ret = ide_queue_pc_tail(drive, disk, &pc, NULL, 0);
	if (ret)
		return ret;
Linus Torvalds's avatar
Linus Torvalds committed
815

816 817 818 819
	ret = ide_tape_read_position(drive);
	if (ret < 0)
		return ret;
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
820 821
}

822
static void ide_tape_discard_merge_buffer(ide_drive_t *drive,
823
					  int restore_position)
Linus Torvalds's avatar
Linus Torvalds committed
824 825 826 827
{
	idetape_tape_t *tape = drive->driver_data;
	int seek, position;

828
	__ide_tape_discard_merge_buffer(drive);
Linus Torvalds's avatar
Linus Torvalds committed
829
	if (restore_position) {
830
		position = ide_tape_read_position(drive);
831
		seek = position > 0 ? position : 0;
Linus Torvalds's avatar
Linus Torvalds committed
832
		if (idetape_position_tape(drive, seek, 0, 0)) {
833
			printk(KERN_INFO "ide-tape: %s: position_tape failed in"
834
					 " %s\n", tape->name, __func__);
Linus Torvalds's avatar
Linus Torvalds committed
835 836 837 838 839 840
			return;
		}
	}
}

/*
841 842
 * Generate a read/write request for the block device interface and wait for it
 * to be serviced.
Linus Torvalds's avatar
Linus Torvalds committed
843
 */
844
static int idetape_queue_rw_tail(ide_drive_t *drive, int cmd, int size)
Linus Torvalds's avatar
Linus Torvalds committed
845 846
{
	idetape_tape_t *tape = drive->driver_data;
847
	struct request *rq;
848
	int ret;
Linus Torvalds's avatar
Linus Torvalds committed
849

850 851
	ide_debug_log(IDE_DBG_FUNC, "cmd: 0x%x, size: %d", cmd, size);