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

18 19
#define DRV_NAME "ide-tape"

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

#include <linux/module.h>
#include <linux/types.h>
#include <linux/string.h>
#include <linux/kernel.h>
#include <linux/delay.h>
#include <linux/timer.h>
#include <linux/mm.h>
#include <linux/interrupt.h>
30
#include <linux/jiffies.h>
Linus Torvalds's avatar
Linus Torvalds committed
31 32 33 34 35 36 37 38 39
#include <linux/major.h>
#include <linux/errno.h>
#include <linux/genhd.h>
#include <linux/slab.h>
#include <linux/pci.h>
#include <linux/ide.h>
#include <linux/smp_lock.h>
#include <linux/completion.h>
#include <linux/bitops.h>
40
#include <linux/mutex.h>
41
#include <scsi/scsi.h>
Linus Torvalds's avatar
Linus Torvalds committed
42 43

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

50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
enum {
	/* output errors only */
	DBG_ERR =		(1 << 0),
	/* output all sense key/asc */
	DBG_SENSE =		(1 << 1),
	/* info regarding all chrdev-related procedures */
	DBG_CHRDEV =		(1 << 2),
	/* all remaining procedures */
	DBG_PROCS =		(1 << 3),
};

/* define to see debug info */
#define IDETAPE_DEBUG_LOG		0

#if IDETAPE_DEBUG_LOG
#define debug_log(lvl, fmt, args...)			\
{							\
	if (tape->debug_mask & lvl)			\
	printk(KERN_INFO "ide-tape: " fmt, ## args);	\
}
#else
#define debug_log(lvl, fmt, args...) do {} while (0)
#endif

Linus Torvalds's avatar
Linus Torvalds committed
74 75
/**************************** Tunable parameters *****************************/
/*
76 77
 * After each failed packet command we issue a request sense command and retry
 * the packet command IDETAPE_MAX_PC_RETRIES times.
Linus Torvalds's avatar
Linus Torvalds committed
78
 *
79
 * Setting IDETAPE_MAX_PC_RETRIES to 0 will disable retries.
Linus Torvalds's avatar
Linus Torvalds committed
80 81 82 83
 */
#define IDETAPE_MAX_PC_RETRIES		3

/*
84 85 86 87
 * The following parameter is used to select the point in the internal tape fifo
 * in which we will start to refill the buffer. Decreasing the following
 * parameter will improve the system's latency and interactive response, while
 * using a high value might improve system throughput.
Linus Torvalds's avatar
Linus Torvalds committed
88
 */
89
#define IDETAPE_FIFO_THRESHOLD		2
Linus Torvalds's avatar
Linus Torvalds committed
90 91

/*
92
 * DSC polling parameters.
Linus Torvalds's avatar
Linus Torvalds committed
93
 *
94 95
 * Polling for DSC (a single bit in the status register) is a very important
 * function in ide-tape. There are two cases in which we poll for DSC:
Linus Torvalds's avatar
Linus Torvalds committed
96
 *
97 98 99 100 101
 * 1. Before a read/write packet command, to ensure that we can transfer data
 * from/to the tape's data buffers, without causing an actual media access.
 * In case the tape is not ready yet, we take out our request from the device
 * request queue, so that ide.c could service requests from the other device
 * on the same interface in the meantime.
Linus Torvalds's avatar
Linus Torvalds committed
102
 *
103 104 105 106 107 108 109 110
 * 2. After the successful initialization of a "media access packet command",
 * which is a command that can take a long time to complete (the interval can
 * range from several seconds to even an hour). Again, we postpone our request
 * in the middle to free the bus for the other device. The polling frequency
 * here should be lower than the read/write frequency since those media access
 * commands are slow. We start from a "fast" frequency - IDETAPE_DSC_MA_FAST
 * (1 second), and if we don't receive DSC after IDETAPE_DSC_MA_THRESHOLD
 * (5 min), we switch it to a lower frequency - IDETAPE_DSC_MA_SLOW (1 min).
Linus Torvalds's avatar
Linus Torvalds committed
111
 *
112 113
 * We also set a timeout for the timer, in case something goes wrong. The
 * timeout should be longer then the maximum execution time of a tape operation.
Linus Torvalds's avatar
Linus Torvalds committed
114
 */
115 116

/* DSC timings. */
Linus Torvalds's avatar
Linus Torvalds committed
117 118 119 120 121 122 123 124 125 126
#define IDETAPE_DSC_RW_MIN		5*HZ/100	/* 50 msec */
#define IDETAPE_DSC_RW_MAX		40*HZ/100	/* 400 msec */
#define IDETAPE_DSC_RW_TIMEOUT		2*60*HZ		/* 2 minutes */
#define IDETAPE_DSC_MA_FAST		2*HZ		/* 2 seconds */
#define IDETAPE_DSC_MA_THRESHOLD	5*60*HZ		/* 5 minutes */
#define IDETAPE_DSC_MA_SLOW		30*HZ		/* 30 seconds */
#define IDETAPE_DSC_MA_TIMEOUT		2*60*60*HZ	/* 2 hours */

/*************************** End of tunable parameters ***********************/

127 128 129 130 131 132
/* tape directions */
enum {
	IDETAPE_DIR_NONE  = (1 << 0),
	IDETAPE_DIR_READ  = (1 << 1),
	IDETAPE_DIR_WRITE = (1 << 2),
};
Linus Torvalds's avatar
Linus Torvalds committed
133 134

struct idetape_bh {
135
	u32 b_size;
Linus Torvalds's avatar
Linus Torvalds committed
136 137 138 139
	atomic_t b_count;
	char *b_data;
};

140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
/* 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
158
/*
159 160
 * 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
161 162
 */
typedef struct ide_tape_obj {
163 164 165
	ide_drive_t		*drive;
	struct ide_driver	*driver;
	struct gendisk		*disk;
166
	struct device		dev;
Linus Torvalds's avatar
Linus Torvalds committed
167

168 169
	/* used by REQ_IDETAPE_{READ,WRITE} requests */
	struct ide_atapi_pc queued_pc;
170

Linus Torvalds's avatar
Linus Torvalds committed
171
	/*
172
	 * DSC polling variables.
Linus Torvalds's avatar
Linus Torvalds committed
173
	 *
174 175 176
	 * 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
177
	 * data transfer) request in the device request queue.
Linus Torvalds's avatar
Linus Torvalds committed
178 179 180 181 182 183 184
	 */
	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 */
185 186
	unsigned long best_dsc_rw_freq;
	unsigned long dsc_poll_freq;
Linus Torvalds's avatar
Linus Torvalds committed
187 188
	unsigned long dsc_timeout;

189
	/* Read position information */
Linus Torvalds's avatar
Linus Torvalds committed
190 191
	u8 partition;
	/* Current block */
192
	unsigned int first_frame;
Linus Torvalds's avatar
Linus Torvalds committed
193

194
	/* Last error information */
Linus Torvalds's avatar
Linus Torvalds committed
195 196
	u8 sense_key, asc, ascq;

197
	/* Character device operation */
Linus Torvalds's avatar
Linus Torvalds committed
198 199 200 201
	unsigned int minor;
	/* device name */
	char name[4];
	/* Current character device data transfer direction */
202
	u8 chrdev_dir;
Linus Torvalds's avatar
Linus Torvalds committed
203

204 205
	/* tape block size, usually 512 or 1024 bytes */
	unsigned short blk_size;
Linus Torvalds's avatar
Linus Torvalds committed
206
	int user_bs_factor;
207

Linus Torvalds's avatar
Linus Torvalds committed
208
	/* Copy of the tape's Capabilities and Mechanical Page */
209
	u8 caps[20];
Linus Torvalds's avatar
Linus Torvalds committed
210 211

	/*
212
	 * Active data transfer request parameters.
Linus Torvalds's avatar
Linus Torvalds committed
213
	 *
214 215 216
	 * 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
217
	 */
218

219
	/* Data buffer size chosen based on the tape's recommendation */
220
	int buffer_size;
221 222
	/* merge buffer */
	struct idetape_bh *merge_bh;
223 224
	/* size of the merge buffer */
	int merge_bh_size;
225
	/* pointer to current buffer head within the merge buffer */
Linus Torvalds's avatar
Linus Torvalds committed
226 227 228
	struct idetape_bh *bh;
	char *b_data;
	int b_count;
229 230

	/* Measures average tape speed */
Linus Torvalds's avatar
Linus Torvalds committed
231 232 233 234 235 236 237 238 239 240 241
	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;

242
	u32 debug_mask;
Linus Torvalds's avatar
Linus Torvalds committed
243 244
} idetape_tape_t;

245
static DEFINE_MUTEX(idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
246

247 248
static struct class *idetape_sysfs_class;

249
static void ide_tape_release(struct device *);
250

Linus Torvalds's avatar
Linus Torvalds committed
251 252 253 254
static struct ide_tape_obj *ide_tape_get(struct gendisk *disk)
{
	struct ide_tape_obj *tape = NULL;

255
	mutex_lock(&idetape_ref_mutex);
Borislav Petkov's avatar
Borislav Petkov committed
256
	tape = ide_drv_g(disk, ide_tape_obj);
257
	if (tape) {
258
		if (ide_device_get(tape->drive))
259
			tape = NULL;
260
		else
261
			get_device(&tape->dev);
262
	}
263
	mutex_unlock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
264 265 266 267 268
	return tape;
}

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

271
	mutex_lock(&idetape_ref_mutex);
272
	put_device(&tape->dev);
273
	ide_device_put(drive);
274
	mutex_unlock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
275 276 277
}

/*
278 279
 * The variables below are used for the character device interface. Additional
 * state variables are defined in our ide_drive_t structure.
Linus Torvalds's avatar
Linus Torvalds committed
280
 */
281
static struct ide_tape_obj *idetape_devs[MAX_HWIFS * MAX_DRIVES];
Linus Torvalds's avatar
Linus Torvalds committed
282 283 284 285 286

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

287
	mutex_lock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
288 289
	tape = idetape_devs[i];
	if (tape)
290
		get_device(&tape->dev);
291
	mutex_unlock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
292 293 294 295
	return tape;
}

/*
296 297
 * 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
298
 */
299
static void idetape_analyze_error(ide_drive_t *drive, u8 *sense)
Linus Torvalds's avatar
Linus Torvalds committed
300 301
{
	idetape_tape_t *tape = drive->driver_data;
302
	struct ide_atapi_pc *pc = drive->failed_pc;
Linus Torvalds's avatar
Linus Torvalds committed
303

304 305 306
	tape->sense_key = sense[2] & 0xF;
	tape->asc       = sense[12];
	tape->ascq      = sense[13];
307 308 309

	debug_log(DBG_ERR, "pc = %x, sense key = %x, asc = %x, ascq = %x\n",
		 pc->c[0], tape->sense_key, tape->asc, tape->ascq);
Linus Torvalds's avatar
Linus Torvalds committed
310

311
	/* Correct pc->xferred by asking the tape.	 */
312
	if (pc->flags & PC_FLAG_DMA_ERROR)
313
		pc->xferred = pc->req_xfer -
314
			tape->blk_size *
315
			get_unaligned_be32(&sense[3]);
Linus Torvalds's avatar
Linus Torvalds committed
316 317 318 319 320 321

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

354
/* Free data buffers completely. */
355
static void ide_tape_kfree_buffer(idetape_tape_t *tape)
Linus Torvalds's avatar
Linus Torvalds committed
356
{
357
	struct idetape_bh *bh = tape->merge_bh;
358

359 360
	kfree(bh->b_data);
	kfree(bh);
Linus Torvalds's avatar
Linus Torvalds committed
361 362
}

363 364
static void ide_tape_handle_dsc(ide_drive_t *);

365
static int ide_tape_callback(ide_drive_t *drive, int dsc)
Linus Torvalds's avatar
Linus Torvalds committed
366 367
{
	idetape_tape_t *tape = drive->driver_data;
368
	struct ide_atapi_pc *pc = drive->pc;
369
	struct request *rq = drive->hwif->rq;
370
	int uptodate = pc->error ? 0 : 1;
371
	int err = uptodate ? 0 : IDE_DRV_ERROR_GENERAL;
Linus Torvalds's avatar
Linus Torvalds committed
372

373 374
	debug_log(DBG_PROCS, "Enter %s\n", __func__);

375 376 377
	if (dsc)
		ide_tape_handle_dsc(drive);

378 379
	if (drive->failed_pc == pc)
		drive->failed_pc = NULL;
380

381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
	if (pc->c[0] == REQUEST_SENSE) {
		if (uptodate)
			idetape_analyze_error(drive, pc->buf);
		else
			printk(KERN_ERR "ide-tape: Error in REQUEST SENSE "
					"itself - Aborting request!\n");
	} else if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
		int blocks = pc->xferred / tape->blk_size;

		tape->avg_size += blocks * tape->blk_size;

		if (time_after_eq(jiffies, tape->avg_time + HZ)) {
			tape->avg_speed = tape->avg_size * HZ /
				(jiffies - tape->avg_time) / 1024;
			tape->avg_size = 0;
			tape->avg_time = jiffies;
		}

		tape->first_frame += blocks;
400
		rq->data_len -= blocks * tape->blk_size;
401

402 403 404 405
		if (pc->error) {
			uptodate = 0;
			err = pc->error;
		}
406
	} else if (pc->c[0] == READ_POSITION && uptodate) {
407
		u8 *readpos = pc->buf;
408 409 410 411 412 413 414 415 416

		debug_log(DBG_SENSE, "BOP - %s\n",
				(readpos[0] & 0x80) ? "Yes" : "No");
		debug_log(DBG_SENSE, "EOP - %s\n",
				(readpos[0] & 0x40) ? "Yes" : "No");

		if (readpos[0] & 0x4) {
			printk(KERN_INFO "ide-tape: Block location is unknown"
					 "to the tape\n");
417
			clear_bit(IDE_AFLAG_ADDRESS_VALID, &drive->atapi_flags);
418
			uptodate = 0;
419
			err = IDE_DRV_ERROR_GENERAL;
420 421
		} else {
			debug_log(DBG_SENSE, "Block Location - %u\n",
422
					be32_to_cpup((__be32 *)&readpos[4]));
423 424

			tape->partition = readpos[1];
425
			tape->first_frame = be32_to_cpup((__be32 *)&readpos[4]);
426
			set_bit(IDE_AFLAG_ADDRESS_VALID, &drive->atapi_flags);
427
		}
Linus Torvalds's avatar
Linus Torvalds committed
428
	}
429

430 431
	rq->errors = err;

432
	return uptodate;
Linus Torvalds's avatar
Linus Torvalds committed
433 434 435
}

/*
436
 * Postpone the current request so that ide.c will be able to service requests
437
 * from another device on the same port while we are polling for DSC.
Linus Torvalds's avatar
Linus Torvalds committed
438
 */
439
static void idetape_postpone_request(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
440 441 442
{
	idetape_tape_t *tape = drive->driver_data;

443 444
	debug_log(DBG_PROCS, "Enter %s\n", __func__);

445 446
	tape->postponed_rq = drive->hwif->rq;

447
	ide_stall_queue(drive, tape->dsc_poll_freq);
Linus Torvalds's avatar
Linus Torvalds committed
448 449
}

450 451 452 453 454 455 456 457 458 459 460 461
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
462
/*
463
 * Packet Command Interface
Linus Torvalds's avatar
Linus Torvalds committed
464
 *
465
 * The current Packet Command is available in drive->pc, and will not change
466 467
 * 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
468
 *
469
 * The handling will be done in three stages:
Linus Torvalds's avatar
Linus Torvalds committed
470
 *
471
 * 1. ide_tape_issue_pc will send the packet command to the drive, and will set
472
 * the interrupt handler to ide_pc_intr.
Linus Torvalds's avatar
Linus Torvalds committed
473
 *
474
 * 2. On each interrupt, ide_pc_intr will be called. This step will be
475
 * repeated until the device signals us that no more interrupts will be issued.
Linus Torvalds's avatar
Linus Torvalds committed
476
 *
477 478 479 480 481 482 483
 * 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
484
 *
485 486
 * 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
487
 *
488
 * 4. When the packet command is finished, it will be checked for errors.
Linus Torvalds's avatar
Linus Torvalds committed
489
 *
490 491 492
 * 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
493
 *
494 495 496
 * 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
497 498
 */

499 500 501
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
502 503 504
{
	idetape_tape_t *tape = drive->driver_data;

505 506
	if (drive->failed_pc == NULL && pc->c[0] != REQUEST_SENSE)
		drive->failed_pc = pc;
507

Linus Torvalds's avatar
Linus Torvalds committed
508
	/* Set the current packet command */
509
	drive->pc = pc;
Linus Torvalds's avatar
Linus Torvalds committed
510 511

	if (pc->retries > IDETAPE_MAX_PC_RETRIES ||
512
		(pc->flags & PC_FLAG_ABORT)) {
513 514
		unsigned int done = blk_rq_bytes(drive->hwif->rq);

Linus Torvalds's avatar
Linus Torvalds committed
515
		/*
516 517 518
		 * 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
519
		 */
520
		if (!(pc->flags & PC_FLAG_ABORT)) {
521
			if (!(pc->c[0] == TEST_UNIT_READY &&
Linus Torvalds's avatar
Linus Torvalds committed
522 523 524 525 526 527 528 529 530 531
			      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 */
532
			pc->error = IDE_DRV_ERROR_GENERAL;
Linus Torvalds's avatar
Linus Torvalds committed
533
		}
534

535
		drive->failed_pc = NULL;
536
		drive->pc_callback(drive, 0);
537
		ide_complete_rq(drive, -EIO, done);
538
		return ide_stopped;
Linus Torvalds's avatar
Linus Torvalds committed
539
	}
540
	debug_log(DBG_SENSE, "Retry #%d, cmd = %02X\n", pc->retries, pc->c[0]);
Linus Torvalds's avatar
Linus Torvalds committed
541 542 543

	pc->retries++;

544
	return ide_issue_pc(drive, cmd);
Linus Torvalds's avatar
Linus Torvalds committed
545 546
}

547
/* A mode sense command is used to "sense" tape parameters. */
548
static void idetape_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
Linus Torvalds's avatar
Linus Torvalds committed
549
{
550
	ide_init_pc(pc);
551
	pc->c[0] = MODE_SENSE;
Linus Torvalds's avatar
Linus Torvalds committed
552
	if (page_code != IDETAPE_BLOCK_DESCRIPTOR)
553 554
		/* DBD = 1 - Don't return block descriptors */
		pc->c[1] = 8;
Linus Torvalds's avatar
Linus Torvalds committed
555 556 557 558 559 560 561 562 563
	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;
564 565
	/* We will just discard data in that case */
	pc->c[4] = 255;
Linus Torvalds's avatar
Linus Torvalds committed
566
	if (page_code == IDETAPE_BLOCK_DESCRIPTOR)
567
		pc->req_xfer = 12;
Linus Torvalds's avatar
Linus Torvalds committed
568
	else if (page_code == IDETAPE_CAPABILITIES_PAGE)
569
		pc->req_xfer = 24;
Linus Torvalds's avatar
Linus Torvalds committed
570
	else
571
		pc->req_xfer = 50;
Linus Torvalds's avatar
Linus Torvalds committed
572 573
}

574
static ide_startstop_t idetape_media_access_finished(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
575
{
576
	ide_hwif_t *hwif = drive->hwif;
Linus Torvalds's avatar
Linus Torvalds committed
577
	idetape_tape_t *tape = drive->driver_data;
578
	struct ide_atapi_pc *pc = drive->pc;
579
	u8 stat;
Linus Torvalds's avatar
Linus Torvalds committed
580

581
	stat = hwif->tp_ops->read_status(hwif);
582

583 584
	if (stat & ATA_DSC) {
		if (stat & ATA_ERR) {
Linus Torvalds's avatar
Linus Torvalds committed
585
			/* Error detected */
586
			if (pc->c[0] != TEST_UNIT_READY)
Linus Torvalds's avatar
Linus Torvalds committed
587 588 589
				printk(KERN_ERR "ide-tape: %s: I/O error, ",
						tape->name);
			/* Retry operation */
590
			ide_retry_pc(drive);
591
			return ide_stopped;
Linus Torvalds's avatar
Linus Torvalds committed
592 593 594
		}
		pc->error = 0;
	} else {
595
		pc->error = IDE_DRV_ERROR_GENERAL;
596
		drive->failed_pc = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
597
	}
598
	drive->pc_callback(drive, 0);
Linus Torvalds's avatar
Linus Torvalds committed
599 600 601
	return ide_stopped;
}

602
static void ide_tape_create_rw_cmd(idetape_tape_t *tape,
603 604
				   struct ide_atapi_pc *pc, struct request *rq,
				   u8 opcode)
Linus Torvalds's avatar
Linus Torvalds committed
605
{
606 607 608
	struct idetape_bh *bh = (struct idetape_bh *)rq->special;
	unsigned int length = rq->current_nr_sectors;

609
	ide_init_pc(pc);
610
	put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
Linus Torvalds's avatar
Linus Torvalds committed
611
	pc->c[1] = 1;
612
	pc->bh = NULL;
613 614 615
	pc->buf = NULL;
	pc->buf_size = length * tape->blk_size;
	pc->req_xfer = pc->buf_size;
616
	if (pc->req_xfer == tape->buffer_size)
617
		pc->flags |= PC_FLAG_DMA_OK;
Linus Torvalds's avatar
Linus Torvalds committed
618

619 620 621 622 623 624 625 626 627
	if (opcode == READ_6) {
		pc->c[0] = READ_6;
		atomic_set(&bh->b_count, 0);
	} else if (opcode == WRITE_6) {
		pc->c[0] = WRITE_6;
		pc->flags |= PC_FLAG_WRITING;
		pc->b_data = bh->b_data;
		pc->b_count = atomic_read(&bh->b_count);
	}
628 629

	memcpy(rq->cmd, pc->c, 12);
Linus Torvalds's avatar
Linus Torvalds committed
630 631 632 633 634
}

static ide_startstop_t idetape_do_request(ide_drive_t *drive,
					  struct request *rq, sector_t block)
{
635
	ide_hwif_t *hwif = drive->hwif;
Linus Torvalds's avatar
Linus Torvalds committed
636
	idetape_tape_t *tape = drive->driver_data;
637
	struct ide_atapi_pc *pc = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
638
	struct request *postponed_rq = tape->postponed_rq;
639
	struct ide_cmd cmd;
640
	u8 stat;
Linus Torvalds's avatar
Linus Torvalds committed
641

642 643 644 645
	debug_log(DBG_SENSE, "sector: %llu, nr_sectors: %lu,"
			" current_nr_sectors: %u\n",
			(unsigned long long)rq->sector, rq->nr_sectors,
			rq->current_nr_sectors);
Linus Torvalds's avatar
Linus Torvalds committed
646

647
	if (!(blk_special_request(rq) || blk_sense_request(rq))) {
648
		/* We do not support buffer cache originated requests. */
Linus Torvalds's avatar
Linus Torvalds committed
649
		printk(KERN_NOTICE "ide-tape: %s: Unsupported request in "
650
			"request queue (%d)\n", drive->name, rq->cmd_type);
651 652
		if (blk_fs_request(rq) == 0 && rq->errors == 0)
			rq->errors = -EIO;
653
		ide_complete_rq(drive, -EIO, ide_rq_bytes(rq));
Linus Torvalds's avatar
Linus Torvalds committed
654 655 656
		return ide_stopped;
	}

657
	/* Retry a failed packet command */
658 659
	if (drive->failed_pc && drive->pc->c[0] == REQUEST_SENSE) {
		pc = drive->failed_pc;
660 661
		goto out;
	}
662

Linus Torvalds's avatar
Linus Torvalds committed
663 664 665 666
	if (postponed_rq != NULL)
		if (rq != postponed_rq) {
			printk(KERN_ERR "ide-tape: ide-tape.c bug - "
					"Two DSC requests were queued\n");
667
			drive->failed_pc = NULL;
668
			rq->errors = 0;
669
			ide_complete_rq(drive, 0, blk_rq_bytes(rq));
Linus Torvalds's avatar
Linus Torvalds committed
670 671 672 673 674 675 676 677 678
			return ide_stopped;
		}

	tape->postponed_rq = NULL;

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

681 682
	if ((drive->dev_flags & IDE_DFLAG_DSC_OVERLAP) == 0 &&
	    (rq->cmd[13] & REQ_IDETAPE_PC2) == 0)
683
		set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
Linus Torvalds's avatar
Linus Torvalds committed
684

685
	if (drive->dev_flags & IDE_DFLAG_POST_RESET) {
686
		set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
687
		drive->dev_flags &= ~IDE_DFLAG_POST_RESET;
Linus Torvalds's avatar
Linus Torvalds committed
688 689
	}

690
	if (!test_and_clear_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags) &&
691
	    (stat & ATA_DSC) == 0) {
Linus Torvalds's avatar
Linus Torvalds committed
692 693
		if (postponed_rq == NULL) {
			tape->dsc_polling_start = jiffies;
694
			tape->dsc_poll_freq = tape->best_dsc_rw_freq;
Linus Torvalds's avatar
Linus Torvalds committed
695 696 697 698
			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);
699
			if (rq->cmd[13] & REQ_IDETAPE_PC2) {
Linus Torvalds's avatar
Linus Torvalds committed
700 701 702 703 704
				idetape_media_access_finished(drive);
				return ide_stopped;
			} else {
				return ide_do_reset(drive);
			}
705 706 707
		} else if (time_after(jiffies,
					tape->dsc_polling_start +
					IDETAPE_DSC_MA_THRESHOLD))
708
			tape->dsc_poll_freq = IDETAPE_DSC_MA_SLOW;
Linus Torvalds's avatar
Linus Torvalds committed
709 710 711
		idetape_postpone_request(drive);
		return ide_stopped;
	}
712
	if (rq->cmd[13] & REQ_IDETAPE_READ) {
713
		pc = &tape->queued_pc;
714
		ide_tape_create_rw_cmd(tape, pc, rq, READ_6);
Linus Torvalds's avatar
Linus Torvalds committed
715 716
		goto out;
	}
717
	if (rq->cmd[13] & REQ_IDETAPE_WRITE) {
718
		pc = &tape->queued_pc;
719
		ide_tape_create_rw_cmd(tape, pc, rq, WRITE_6);
Linus Torvalds's avatar
Linus Torvalds committed
720 721
		goto out;
	}
722
	if (rq->cmd[13] & REQ_IDETAPE_PC1) {
Tejun Heo's avatar
Tejun Heo committed
723
		pc = (struct ide_atapi_pc *)rq->special;
724 725
		rq->cmd[13] &= ~(REQ_IDETAPE_PC1);
		rq->cmd[13] |= REQ_IDETAPE_PC2;
Linus Torvalds's avatar
Linus Torvalds committed
726 727
		goto out;
	}
728
	if (rq->cmd[13] & REQ_IDETAPE_PC2) {
Linus Torvalds's avatar
Linus Torvalds committed
729 730 731 732
		idetape_media_access_finished(drive);
		return ide_stopped;
	}
	BUG();
733

734
out:
735 736 737
	/* prepare sense request for this command */
	ide_prep_sense(drive, rq);

738 739 740 741 742 743 744
	memset(&cmd, 0, sizeof(cmd));

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

	cmd.rq = rq;

745 746 747
	ide_init_sg_cmd(&cmd, pc->req_xfer);
	ide_map_sg(drive, &cmd);

748
	return ide_tape_issue_pc(drive, &cmd, pc);
Linus Torvalds's avatar
Linus Torvalds committed
749 750 751
}

/*
752 753
 * It returns a pointer to the newly allocated buffer, or NULL in case
 * of failure.
Linus Torvalds's avatar
Linus Torvalds committed
754
 */
755
static struct idetape_bh *ide_tape_kmalloc_buffer(idetape_tape_t *tape,
756
						  int full)
Linus Torvalds's avatar
Linus Torvalds committed
757
{
758 759 760 761 762 763 764 765 766 767 768 769 770
	struct idetape_bh *bh;

	bh = kmalloc(sizeof(struct idetape_bh), GFP_KERNEL);
	if (!bh)
		return NULL;

	bh->b_data = kmalloc(tape->buffer_size, GFP_KERNEL);
	if (!bh->b_data) {
		kfree(bh);
		return NULL;
	}

	bh->b_size = tape->buffer_size;
Linus Torvalds's avatar
Linus Torvalds committed
771 772
	atomic_set(&bh->b_count, full ? bh->b_size : 0);

773
	return bh;
Linus Torvalds's avatar
Linus Torvalds committed
774 775
}

776
static int idetape_copy_stage_from_user(idetape_tape_t *tape,
777
					const char __user *buf, int n)
Linus Torvalds's avatar
Linus Torvalds committed
778 779
{
	struct idetape_bh *bh = tape->bh;
780
	int ret = 0;
Linus Torvalds's avatar
Linus Torvalds committed
781

782 783
	if (n) {
		if (bh == NULL || n > bh->b_size - atomic_read(&bh->b_count)) {
784 785
			printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
					__func__);
786
			return 1;
Linus Torvalds's avatar
Linus Torvalds committed
787
		}
788
		if (copy_from_user(bh->b_data + atomic_read(&bh->b_count), buf,
789
				   n))
790
			ret = 1;
791 792 793
		atomic_add(n, &bh->b_count);
		if (atomic_read(&bh->b_count) == bh->b_size)
			tape->bh = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
794
	}
795

796
	return ret;
Linus Torvalds's avatar
Linus Torvalds committed
797 798
}

799
static int idetape_copy_stage_to_user(idetape_tape_t *tape, char __user *buf,
800
				      int n)
Linus Torvalds's avatar
Linus Torvalds committed
801 802
{
	struct idetape_bh *bh = tape->bh;
803
	int ret = 0;
Linus Torvalds's avatar
Linus Torvalds committed
804

805 806
	if (n) {
		if (bh == NULL || n > tape->b_count) {
807 808
			printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
					__func__);
809
			return 1;
Linus Torvalds's avatar
Linus Torvalds committed
810
		}
811
		if (copy_to_user(buf, tape->b_data, n))
812
			ret = 1;
813 814 815 816
		tape->b_data += n;
		tape->b_count -= n;
		if (!tape->b_count)
			tape->bh = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
817
	}
818
	return ret;
Linus Torvalds's avatar
Linus Torvalds committed
819 820
}

821
static void idetape_init_merge_buffer(idetape_tape_t *tape)
Linus Torvalds's avatar
Linus Torvalds committed
822
{
823 824
	struct idetape_bh *bh = tape->merge_bh;
	tape->bh = tape->merge_bh;
825

826
	if (tape->chrdev_dir == IDETAPE_DIR_WRITE)
Linus Torvalds's avatar
Linus Torvalds committed
827 828 829 830 831 832 833 834
		atomic_set(&bh->b_count, 0);
	else {
		tape->b_data = bh->b_data;
		tape->b_count = atomic_read(&bh->b_count);
	}
}

/*
835 836
 * Write a filemark if write_filemark=1. Flush the device buffers without
 * writing a filemark otherwise.
Linus Torvalds's avatar
Linus Torvalds committed
837
 */
838
static void idetape_create_write_filemark_cmd(ide_drive_t *drive,
839
		struct ide_atapi_pc *pc, int write_filemark)
Linus Torvalds's avatar
Linus Torvalds committed
840
{
841
	ide_init_pc(pc);
842
	pc->c[0] = WRITE_FILEMARKS;
Linus Torvalds's avatar
Linus Torvalds committed
843
	pc->c[4] = write_filemark;
844
	pc->flags |= PC_FLAG_WAIT_FOR_DSC;
Linus Torvalds's avatar
Linus Torvalds committed
845 846 847 848 849
}

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

853
	/* Wait for the tape to become ready */
854
	set_bit(IDE_AFLAG_MEDIUM_PRESENT, &drive->atapi_flags);
Linus Torvalds's avatar
Linus Torvalds committed
855 856
	timeout += jiffies;
	while (time_before(jiffies, timeout)) {
857
		if (ide_do_test_unit_ready(drive, disk) == 0)
Linus Torvalds's avatar
Linus Torvalds committed
858 859
			return 0;
		if ((tape->sense_key == 2 && tape->asc == 4 && tape->ascq == 2)
860