ide-tape.c 54.7 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
/* define to see debug info */
51
#undef IDETAPE_DEBUG_LOG
52

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

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

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

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

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

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

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

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

Linus Torvalds's avatar
Linus Torvalds committed
150
	/*
151
	 * DSC polling variables.
Linus Torvalds's avatar
Linus Torvalds committed
152
	 *
153 154 155
	 * 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
156
	 * data transfer) request in the device request queue.
Linus Torvalds's avatar
Linus Torvalds committed
157 158 159 160 161 162 163
	 */
	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 */
164 165
	unsigned long best_dsc_rw_freq;
	unsigned long dsc_poll_freq;
Linus Torvalds's avatar
Linus Torvalds committed
166 167
	unsigned long dsc_timeout;

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

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

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

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

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

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

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

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

220
static DEFINE_MUTEX(idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
221

222 223
static struct class *idetape_sysfs_class;

224
static void ide_tape_release(struct device *);
225

Borislav Petkov's avatar
Borislav Petkov committed
226 227 228 229
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
230 231 232
{
	struct ide_tape_obj *tape = NULL;

233
	mutex_lock(&idetape_ref_mutex);
Borislav Petkov's avatar
Borislav Petkov committed
234 235 236 237 238 239

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

240
	if (tape) {
241
		if (ide_device_get(tape->drive))
242
			tape = NULL;
243
		else
244
			get_device(&tape->dev);
245
	}
Borislav Petkov's avatar
Borislav Petkov committed
246

247
	mutex_unlock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
248 249 250 251 252
	return tape;
}

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

255
	mutex_lock(&idetape_ref_mutex);
256
	put_device(&tape->dev);
257
	ide_device_put(drive);
258
	mutex_unlock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
259 260 261
}

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

272 273 274
	tape->sense_key = sense[2] & 0xF;
	tape->asc       = sense[12];
	tape->ascq      = sense[13];
275

276 277 278
	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
279

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

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

321 322
static void ide_tape_handle_dsc(ide_drive_t *);

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

331 332
	ide_debug_log(IDE_DBG_FUNC, "cmd: 0x%x, dsc: %d, err: %d", rq->cmd[0],
		      dsc, err);
333

334 335 336
	if (dsc)
		ide_tape_handle_dsc(drive);

337 338
	if (drive->failed_pc == pc)
		drive->failed_pc = NULL;
339

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

		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;

361 362 363 364
		if (pc->error) {
			uptodate = 0;
			err = pc->error;
		}
Linus Torvalds's avatar
Linus Torvalds committed
365
	}
366 367
	rq->errors = err;

368
	return uptodate;
Linus Torvalds's avatar
Linus Torvalds committed
369 370 371
}

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

380 381
	ide_debug_log(IDE_DBG_FUNC, "cmd: 0x%x, dsc_poll_freq: %lu",
		      rq->cmd[0], tape->dsc_poll_freq);
382

383
	tape->postponed_rq = rq;
384

385
	ide_stall_queue(drive, tape->dsc_poll_freq);
Linus Torvalds's avatar
Linus Torvalds committed
386 387
}

388 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 */
	idetape_postpone_request(drive);
}

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

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

444 445
	if (drive->failed_pc == NULL && pc->c[0] != REQUEST_SENSE)
		drive->failed_pc = pc;
446

Linus Torvalds's avatar
Linus Torvalds committed
447
	/* Set the current packet command */
448
	drive->pc = pc;
Linus Torvalds's avatar
Linus Torvalds committed
449 450

	if (pc->retries > IDETAPE_MAX_PC_RETRIES ||
451
		(pc->flags & PC_FLAG_ABORT)) {
452

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

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

	pc->retries++;

483
	return ide_issue_pc(drive, cmd);
Linus Torvalds's avatar
Linus Torvalds committed
484 485
}

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

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

520
	stat = hwif->tp_ops->read_status(hwif);
521

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

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

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

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

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

	memcpy(rq->cmd, pc->c, 12);
Linus Torvalds's avatar
Linus Torvalds committed
562 563 564 565 566
}

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

574 575 576
	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
577

578
	BUG_ON(!(blk_special_request(rq) || blk_sense_request(rq)));
Linus Torvalds's avatar
Linus Torvalds committed
579

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

Linus Torvalds's avatar
Linus Torvalds committed
586 587 588 589
	if (postponed_rq != NULL)
		if (rq != postponed_rq) {
			printk(KERN_ERR "ide-tape: ide-tape.c bug - "
					"Two DSC requests were queued\n");
590
			drive->failed_pc = NULL;
591
			rq->errors = 0;
592
			ide_complete_rq(drive, 0, blk_rq_bytes(rq));
Linus Torvalds's avatar
Linus Torvalds committed
593 594 595 596 597 598 599 600 601
			return ide_stopped;
		}

	tape->postponed_rq = NULL;

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

604 605
	if ((drive->dev_flags & IDE_DFLAG_DSC_OVERLAP) == 0 &&
	    (rq->cmd[13] & REQ_IDETAPE_PC2) == 0)
606
		drive->atapi_flags |= IDE_AFLAG_IGNORE_DSC;
Linus Torvalds's avatar
Linus Torvalds committed
607

608
	if (drive->dev_flags & IDE_DFLAG_POST_RESET) {
609
		drive->atapi_flags |= IDE_AFLAG_IGNORE_DSC;
610
		drive->dev_flags &= ~IDE_DFLAG_POST_RESET;
Linus Torvalds's avatar
Linus Torvalds committed
611 612
	}

613 614
	if (!(drive->atapi_flags & IDE_AFLAG_IGNORE_DSC) &&
	    !(stat & ATA_DSC)) {
Linus Torvalds's avatar
Linus Torvalds committed
615 616
		if (postponed_rq == NULL) {
			tape->dsc_polling_start = jiffies;
617
			tape->dsc_poll_freq = tape->best_dsc_rw_freq;
Linus Torvalds's avatar
Linus Torvalds committed
618 619 620 621
			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);
622
			if (rq->cmd[13] & REQ_IDETAPE_PC2) {
Linus Torvalds's avatar
Linus Torvalds committed
623 624 625 626 627
				idetape_media_access_finished(drive);
				return ide_stopped;
			} else {
				return ide_do_reset(drive);
			}
628 629 630
		} else if (time_after(jiffies,
					tape->dsc_polling_start +
					IDETAPE_DSC_MA_THRESHOLD))
631
			tape->dsc_poll_freq = IDETAPE_DSC_MA_SLOW;
Linus Torvalds's avatar
Linus Torvalds committed
632 633
		idetape_postpone_request(drive);
		return ide_stopped;
634 635 636
	} else
		drive->atapi_flags &= ~IDE_AFLAG_IGNORE_DSC;

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

659
out:
660 661 662
	/* prepare sense request for this command */
	ide_prep_sense(drive, rq);

663 664 665 666 667 668 669
	memset(&cmd, 0, sizeof(cmd));

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

	cmd.rq = rq;

670
	ide_init_sg_cmd(&cmd, blk_rq_bytes(rq));
671 672
	ide_map_sg(drive, &cmd);

673
	return ide_tape_issue_pc(drive, &cmd, pc);
Linus Torvalds's avatar
Linus Torvalds committed
674 675 676
}

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

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

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

717
static int idetape_flush_tape_buffers(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
718
{
719
	struct ide_tape_obj *tape = drive->driver_data;
720
	struct ide_atapi_pc pc;
Linus Torvalds's avatar
Linus Torvalds committed
721 722 723
	int rc;

	idetape_create_write_filemark_cmd(drive, &pc, 0);
724
	rc = ide_queue_pc_tail(drive, tape->disk, &pc, NULL, 0);
725
	if (rc)
Linus Torvalds's avatar
Linus Torvalds committed
726 727 728 729 730
		return rc;
	idetape_wait_ready(drive, 60 * 5 * HZ);
	return 0;
}

731
static int ide_tape_read_position(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
732 733
{
	idetape_tape_t *tape = drive->driver_data;
734
	struct ide_atapi_pc pc;
735
	u8 buf[20];
Linus Torvalds's avatar
Linus Torvalds committed
736

737
	ide_debug_log(IDE_DBG_FUNC, "enter");
Linus Torvalds's avatar
Linus Torvalds committed
738

739 740 741 742 743 744
	/* 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
745
		return -1;
746 747

	if (!pc.error) {
748
		ide_debug_log(IDE_DBG_FUNC, "BOP - %s",
749
				(buf[0] & 0x80) ? "Yes" : "No");
750
		ide_debug_log(IDE_DBG_FUNC, "EOP - %s",
751 752 753 754 755
				(buf[0] & 0x40) ? "Yes" : "No");

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

			tape->partition = buf[1];
			tape->first_frame = be32_to_cpup((__be32 *)&buf[4]);
765 766
			set_bit(ilog2(IDE_AFLAG_ADDRESS_VALID),
				&drive->atapi_flags);
767 768 769 770
		}
	}

	return tape->first_frame;
Linus Torvalds's avatar
Linus Torvalds committed
771 772
}

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

785
static void __ide_tape_discard_merge_buffer(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
786 787 788
{
	idetape_tape_t *tape = drive->driver_data;

789
	if (tape->chrdev_dir != IDETAPE_DIR_READ)
790
		return;
Linus Torvalds's avatar
Linus Torvalds committed
791

792
	clear_bit(ilog2(IDE_AFLAG_FILEMARK), &drive->atapi_flags);
Tejun Heo's avatar
Tejun Heo committed
793 794 795 796
	tape->valid = 0;
	if (tape->buf != NULL) {
		kfree(tape->buf);
		tape->buf = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
797 798
	}

799
	tape->chrdev_dir = IDETAPE_DIR_NONE;
Linus Torvalds's avatar
Linus Torvalds committed
800 801 802
}

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

816
	if (tape->chrdev_dir == IDETAPE_DIR_READ)
817
		__ide_tape_discard_merge_buffer(drive);
Linus Torvalds's avatar
Linus Torvalds committed
818 819
	idetape_wait_ready(drive, 60 * 5 * HZ);
	idetape_create_locate_cmd(drive, &pc, block, partition, skip);
820 821 822
	ret = ide_queue_pc_tail(drive, disk, &pc, NULL, 0);
	if (ret)
		return ret;
Linus Torvalds's avatar
Linus Torvalds committed
823

824 825 826 827
	ret = ide_tape_read_position(drive);
	if (ret < 0)
		return ret;
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
828 829
}

830
static void ide_tape_discard_merge_buffer(ide_drive_t *drive,
831
					  int restore_position)
Linus Torvalds's avatar
Linus Torvalds committed
832 833 834 835
{
	idetape_tape_t *tape = drive->driver_data;
	int seek, position;

836
	__ide_tape_discard_merge_buffer(drive);
Linus Torvalds's avatar
Linus Torvalds committed
837
	if (restore_position) {
838
		position = ide_tape_read_position(drive);
839
		seek = position > 0 ? position : 0;
Linus Torvalds's avatar
Linus Torvalds committed
840
		if (idetape_position_tape(drive, seek, 0, 0)) {
841
			printk(KERN_INFO "ide-tape: %s: position_tape failed in"
842
					 " %s\n", tape->name, __func__);
Linus Torvalds's avatar
Linus Torvalds committed
843 844 845 846 847 848
			return;
		}
	}
}

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

858 859
	ide_debug_log(IDE_DBG_FUNC, "cmd: 0x%x, size: %d", cmd, size);

860
	BUG_ON(cmd != REQ_IDETAPE_READ && cmd != REQ_IDETAPE_WRITE);
861
	BUG_ON(size < 0 || size % tape->blk_size);
862