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
#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>
35
#include <linux/smp_lock.h>
Linus Torvalds's avatar
Linus Torvalds committed
36 37 38 39 40 41
#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>
42
#include <linux/mutex.h>
43
#include <scsi/scsi.h>
Linus Torvalds's avatar
Linus Torvalds committed
44 45

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

227 228
static struct class *idetape_sysfs_class;

229
static void ide_tape_release(struct device *);
230

Borislav Petkov's avatar
Borislav Petkov committed
231 232 233 234
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
235 236 237
{
	struct ide_tape_obj *tape = NULL;

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

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

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

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

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

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

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

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

281 282 283
	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
284

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

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

326 327
static void ide_tape_handle_dsc(ide_drive_t *);

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

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

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

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

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

		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;

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

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

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

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

387
	tape->postponed_rq = true;
388

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

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

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

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

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

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

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

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

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

	pc->retries++;

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

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

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

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

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

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

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

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

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

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

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

577 578 579
	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
580

581 582
	BUG_ON(!(rq->cmd_type == REQ_TYPE_SPECIAL ||
		 rq->cmd_type == REQ_TYPE_SENSE));
Linus Torvalds's avatar
Linus Torvalds committed
583

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

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

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

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

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

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

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

657 658 659 660 661 662 663
	memset(&cmd, 0, sizeof(cmd));

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

	cmd.rq = rq;

664
	ide_init_sg_cmd(&cmd, blk_rq_bytes(rq));
665 666
	ide_map_sg(drive, &cmd);

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

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

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

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

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

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

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

731
	ide_debug_log(IDE_DBG_FUNC, "enter");
Linus Torvalds's avatar
Linus Torvalds committed
732

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

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

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

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

	return tape->first_frame;
Linus Torvalds's avatar
Linus Torvalds committed
765 766
}

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

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

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

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

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

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

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

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

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

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

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