ide-tape.c 79.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
#define IDETAPE_VERSION "1.20"
Linus Torvalds's avatar
Linus Torvalds committed
19 20 21 22 23 24 25 26 27

#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>
28
#include <linux/jiffies.h>
Linus Torvalds's avatar
Linus Torvalds committed
29 30 31 32 33 34 35 36 37
#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>
38
#include <linux/mutex.h>
39
#include <scsi/scsi.h>
Linus Torvalds's avatar
Linus Torvalds committed
40 41

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

48 49 50 51 52 53 54 55 56 57 58
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),
	/* buffer alloc info (pc_stack & rq_stack) */
	DBG_PCRQ_STACK =	(1 << 4),
59 60
	/* IRQ handler (always log debug info if debugging is on) */
	DBG_PC_INTR = 		(1 << 5),
61 62 63 64 65 66 67 68
};

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

#if IDETAPE_DEBUG_LOG
#define debug_log(lvl, fmt, args...)			\
{							\
69
	if ((lvl & DBG_PC_INTR) || (tape->debug_mask & lvl)) \
70 71 72 73 74 75
	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
76 77
/**************************** Tunable parameters *****************************/
/*
78 79
 * 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
80
 *
81
 * Setting IDETAPE_MAX_PC_RETRIES to 0 will disable retries.
Linus Torvalds's avatar
Linus Torvalds committed
82 83 84 85
 */
#define IDETAPE_MAX_PC_RETRIES		3

/*
86 87
 * With each packet command, we allocate a buffer of IDETAPE_PC_BUFFER_SIZE
 * bytes. This is used for several packet commands (Not for READ/WRITE commands)
Linus Torvalds's avatar
Linus Torvalds committed
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
 */
#define IDETAPE_PC_BUFFER_SIZE		256

/*
 *	In various places in the driver, we need to allocate storage
 *	for packet commands and requests, which will remain valid while
 *	we leave the driver to wait for an interrupt or a timeout event.
 */
#define IDETAPE_PC_STACK		(10 + IDETAPE_MAX_PC_RETRIES)

/*
 * Some drives (for example, Seagate STT3401A Travan) require a very long
 * timeout, because they don't return an interrupt or clear their busy bit
 * until after the command completes (even retension commands).
 */
#define IDETAPE_WAIT_CMD		(900*HZ)

/*
106 107 108 109
 * 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
110
 */
111
#define IDETAPE_FIFO_THRESHOLD		2
Linus Torvalds's avatar
Linus Torvalds committed
112 113

/*
114
 * DSC polling parameters.
Linus Torvalds's avatar
Linus Torvalds committed
115
 *
116 117
 * 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
118
 *
119 120 121 122 123
 * 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
124
 *
125 126 127 128 129 130 131 132
 * 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
133
 *
134 135
 * 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
136
 */
137 138

/* DSC timings. */
Linus Torvalds's avatar
Linus Torvalds committed
139 140 141 142 143 144 145 146 147 148
#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 ***********************/

149 150 151 152 153 154
/* 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
155 156

struct idetape_bh {
157
	u32 b_size;
Linus Torvalds's avatar
Linus Torvalds committed
158 159 160 161 162
	atomic_t b_count;
	struct idetape_bh *b_reqnext;
	char *b_data;
};

163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
/* 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

/*
 * Special requests for our block device strategy routine.
 *
 * In order to service a character device command, we add special requests to
 * the tail of our block device request queue and wait for their completion.
 */

enum {
	REQ_IDETAPE_PC1		= (1 << 0), /* packet command (first stage) */
	REQ_IDETAPE_PC2		= (1 << 1), /* packet command (second stage) */
	REQ_IDETAPE_READ	= (1 << 2),
	REQ_IDETAPE_WRITE	= (1 << 3),
};

/* Error codes returned in rq->errors to the higher part of the driver. */
#define IDETAPE_ERROR_GENERAL		101
#define IDETAPE_ERROR_FILEMARK		102
#define IDETAPE_ERROR_EOD		103

/* Structures related to the SELECT SENSE / MODE SENSE packet commands. */
#define IDETAPE_BLOCK_DESCRIPTOR	0
#define IDETAPE_CAPABILITIES_PAGE	0x2a

200 201 202 203 204 205
/* Tape flag bits values. */
enum {
	IDETAPE_FLAG_IGNORE_DSC		= (1 << 0),
	/* 0 When the tape position is unknown */
	IDETAPE_FLAG_ADDRESS_VALID	= (1 <<	1),
	/* Device already opened */
206
	IDETAPE_FLAG_BUSY		= (1 << 2),
207
	/* Attempt to auto-detect the current user block size */
208
	IDETAPE_FLAG_DETECT_BS		= (1 << 3),
209
	/* Currently on a filemark */
210
	IDETAPE_FLAG_FILEMARK		= (1 << 4),
211
	/* DRQ interrupt device */
212
	IDETAPE_FLAG_DRQ_INTERRUPT	= (1 << 5),
213
	/* 0 = no tape is loaded, so we don't rewind after ejecting */
214
	IDETAPE_FLAG_MEDIUM_PRESENT	= (1 << 6),
215 216
};

Linus Torvalds's avatar
Linus Torvalds committed
217
/*
218 219
 * 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
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
 */
typedef struct ide_tape_obj {
	ide_drive_t	*drive;
	ide_driver_t	*driver;
	struct gendisk	*disk;
	struct kref	kref;

	/*
	 *	Since a typical character device operation requires more
	 *	than one packet command, we provide here enough memory
	 *	for the maximum of interconnected packet commands.
	 *	The packet commands are stored in the circular array pc_stack.
	 *	pc_stack_index points to the last used entry, and warps around
	 *	to the start when we get to the last array entry.
	 *
	 *	pc points to the current processed packet command.
	 *
	 *	failed_pc points to the last failed packet command, or contains
	 *	NULL if we do not need to retry any packet command. This is
	 *	required since an additional packet command is needed before the
	 *	retry, to get detailed information on what went wrong.
	 */
	/* Current packet command */
243
	struct ide_atapi_pc *pc;
Linus Torvalds's avatar
Linus Torvalds committed
244
	/* Last failed packet command */
245
	struct ide_atapi_pc *failed_pc;
Linus Torvalds's avatar
Linus Torvalds committed
246
	/* Packet command stack */
247
	struct ide_atapi_pc pc_stack[IDETAPE_PC_STACK];
Linus Torvalds's avatar
Linus Torvalds committed
248 249 250 251 252 253 254
	/* Next free packet command storage space */
	int pc_stack_index;
	struct request rq_stack[IDETAPE_PC_STACK];
	/* We implement a circular array */
	int rq_stack_index;

	/*
255
	 * DSC polling variables.
Linus Torvalds's avatar
Linus Torvalds committed
256
	 *
257 258 259
	 * 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
260
	 * data transfer) request in the device request queue.
Linus Torvalds's avatar
Linus Torvalds committed
261 262 263 264 265 266 267
	 */
	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 */
268 269
	unsigned long best_dsc_rw_freq;
	unsigned long dsc_poll_freq;
Linus Torvalds's avatar
Linus Torvalds committed
270 271
	unsigned long dsc_timeout;

272
	/* Read position information */
Linus Torvalds's avatar
Linus Torvalds committed
273 274
	u8 partition;
	/* Current block */
275
	unsigned int first_frame;
Linus Torvalds's avatar
Linus Torvalds committed
276

277
	/* Last error information */
Linus Torvalds's avatar
Linus Torvalds committed
278 279
	u8 sense_key, asc, ascq;

280
	/* Character device operation */
Linus Torvalds's avatar
Linus Torvalds committed
281 282 283 284
	unsigned int minor;
	/* device name */
	char name[4];
	/* Current character device data transfer direction */
285
	u8 chrdev_dir;
Linus Torvalds's avatar
Linus Torvalds committed
286

287 288
	/* tape block size, usually 512 or 1024 bytes */
	unsigned short blk_size;
Linus Torvalds's avatar
Linus Torvalds committed
289
	int user_bs_factor;
290

Linus Torvalds's avatar
Linus Torvalds committed
291
	/* Copy of the tape's Capabilities and Mechanical Page */
292
	u8 caps[20];
Linus Torvalds's avatar
Linus Torvalds committed
293 294

	/*
295
	 * Active data transfer request parameters.
Linus Torvalds's avatar
Linus Torvalds committed
296
	 *
297 298 299
	 * 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
300
	 */
301

302
	/* Data buffer size chosen based on the tape's recommendation */
303
	int buffer_size;
304 305
	/* merge buffer */
	struct idetape_bh *merge_bh;
306 307
	/* size of the merge buffer */
	int merge_bh_size;
308
	/* pointer to current buffer head within the merge buffer */
Linus Torvalds's avatar
Linus Torvalds committed
309 310 311
	struct idetape_bh *bh;
	char *b_data;
	int b_count;
312

313
	int pages_per_buffer;
Linus Torvalds's avatar
Linus Torvalds committed
314 315 316 317 318 319
	/* Wasted space in each stage */
	int excess_bh_size;

	/* Status/Action flags: long for set_bit */
	unsigned long flags;
	/* protects the ide-tape queue */
320
	spinlock_t lock;
Linus Torvalds's avatar
Linus Torvalds committed
321

322
	/* Measures average tape speed */
Linus Torvalds's avatar
Linus Torvalds committed
323 324 325 326 327 328 329 330 331 332 333
	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;

334
	u32 debug_mask;
Linus Torvalds's avatar
Linus Torvalds committed
335 336
} idetape_tape_t;

337
static DEFINE_MUTEX(idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
338

339 340
static struct class *idetape_sysfs_class;

Linus Torvalds's avatar
Linus Torvalds committed
341 342 343 344 345 346 347 348 349
#define to_ide_tape(obj) container_of(obj, struct ide_tape_obj, kref)

#define ide_tape_g(disk) \
	container_of((disk)->private_data, struct ide_tape_obj, driver)

static struct ide_tape_obj *ide_tape_get(struct gendisk *disk)
{
	struct ide_tape_obj *tape = NULL;

350
	mutex_lock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
351 352 353
	tape = ide_tape_g(disk);
	if (tape)
		kref_get(&tape->kref);
354
	mutex_unlock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
355 356 357 358 359 360 361
	return tape;
}

static void ide_tape_release(struct kref *);

static void ide_tape_put(struct ide_tape_obj *tape)
{
362
	mutex_lock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
363
	kref_put(&tape->kref, ide_tape_release);
364
	mutex_unlock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
365 366 367
}

/*
368 369
 * 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
370
 */
371
static struct ide_tape_obj *idetape_devs[MAX_HWIFS * MAX_DRIVES];
Linus Torvalds's avatar
Linus Torvalds committed
372 373 374 375 376 377 378

#define ide_tape_f(file) ((file)->private_data)

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

379
	mutex_lock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
380 381 382
	tape = idetape_devs[i];
	if (tape)
		kref_get(&tape->kref);
383
	mutex_unlock(&idetape_ref_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
384 385 386
	return tape;
}

387
static void idetape_input_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
388
				  unsigned int bcount)
Linus Torvalds's avatar
Linus Torvalds committed
389 390 391 392 393 394 395 396
{
	struct idetape_bh *bh = pc->bh;
	int count;

	while (bcount) {
		if (bh == NULL) {
			printk(KERN_ERR "ide-tape: bh == NULL in "
				"idetape_input_buffers\n");
397
			ide_pad_transfer(drive, 0, bcount);
Linus Torvalds's avatar
Linus Torvalds committed
398 399
			return;
		}
400 401 402
		count = min(
			(unsigned int)(bh->b_size - atomic_read(&bh->b_count)),
			bcount);
403
		drive->hwif->input_data(drive, NULL, bh->b_data +
404
					atomic_read(&bh->b_count), count);
Linus Torvalds's avatar
Linus Torvalds committed
405 406 407 408 409 410 411 412 413 414 415
		bcount -= count;
		atomic_add(count, &bh->b_count);
		if (atomic_read(&bh->b_count) == bh->b_size) {
			bh = bh->b_reqnext;
			if (bh)
				atomic_set(&bh->b_count, 0);
		}
	}
	pc->bh = bh;
}

416
static void idetape_output_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
417
				   unsigned int bcount)
Linus Torvalds's avatar
Linus Torvalds committed
418 419 420 421 422 423
{
	struct idetape_bh *bh = pc->bh;
	int count;

	while (bcount) {
		if (bh == NULL) {
424 425
			printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
					__func__);
Linus Torvalds's avatar
Linus Torvalds committed
426 427 428
			return;
		}
		count = min((unsigned int)pc->b_count, (unsigned int)bcount);
429
		drive->hwif->output_data(drive, NULL, pc->b_data, count);
Linus Torvalds's avatar
Linus Torvalds committed
430 431 432 433
		bcount -= count;
		pc->b_data += count;
		pc->b_count -= count;
		if (!pc->b_count) {
434 435
			bh = bh->b_reqnext;
			pc->bh = bh;
Linus Torvalds's avatar
Linus Torvalds committed
436 437 438 439 440 441 442 443
			if (bh) {
				pc->b_data = bh->b_data;
				pc->b_count = atomic_read(&bh->b_count);
			}
		}
	}
}

444
static void idetape_update_buffers(struct ide_atapi_pc *pc)
Linus Torvalds's avatar
Linus Torvalds committed
445 446 447
{
	struct idetape_bh *bh = pc->bh;
	int count;
448
	unsigned int bcount = pc->xferred;
Linus Torvalds's avatar
Linus Torvalds committed
449

450
	if (pc->flags & PC_FLAG_WRITING)
Linus Torvalds's avatar
Linus Torvalds committed
451 452 453
		return;
	while (bcount) {
		if (bh == NULL) {
454 455
			printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
					__func__);
Linus Torvalds's avatar
Linus Torvalds committed
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
			return;
		}
		count = min((unsigned int)bh->b_size, (unsigned int)bcount);
		atomic_set(&bh->b_count, count);
		if (atomic_read(&bh->b_count) == bh->b_size)
			bh = bh->b_reqnext;
		bcount -= count;
	}
	pc->bh = bh;
}

/*
 *	idetape_next_pc_storage returns a pointer to a place in which we can
 *	safely store a packet command, even though we intend to leave the
 *	driver. A storage space for a maximum of IDETAPE_PC_STACK packet
 *	commands is allocated at initialization time.
 */
473
static struct ide_atapi_pc *idetape_next_pc_storage(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
474 475 476
{
	idetape_tape_t *tape = drive->driver_data;

477 478
	debug_log(DBG_PCRQ_STACK, "pc_stack_index=%d\n", tape->pc_stack_index);

Linus Torvalds's avatar
Linus Torvalds committed
479
	if (tape->pc_stack_index == IDETAPE_PC_STACK)
480
		tape->pc_stack_index = 0;
Linus Torvalds's avatar
Linus Torvalds committed
481 482 483 484 485 486 487 488
	return (&tape->pc_stack[tape->pc_stack_index++]);
}

/*
 *	idetape_next_rq_storage is used along with idetape_next_pc_storage.
 *	Since we queue packet commands in the request queue, we need to
 *	allocate a request, along with the allocation of a packet command.
 */
489

Linus Torvalds's avatar
Linus Torvalds committed
490 491 492 493 494 495
/**************************************************************
 *                                                            *
 *  This should get fixed to use kmalloc(.., GFP_ATOMIC)      *
 *  followed later on by kfree().   -ml                       *
 *                                                            *
 **************************************************************/
496 497

static struct request *idetape_next_rq_storage(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
498 499 500
{
	idetape_tape_t *tape = drive->driver_data;

501 502
	debug_log(DBG_PCRQ_STACK, "rq_stack_index=%d\n", tape->rq_stack_index);

Linus Torvalds's avatar
Linus Torvalds committed
503
	if (tape->rq_stack_index == IDETAPE_PC_STACK)
504
		tape->rq_stack_index = 0;
Linus Torvalds's avatar
Linus Torvalds committed
505 506 507 508
	return (&tape->rq_stack[tape->rq_stack_index++]);
}

/*
509 510
 * 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
511
 */
512
static void idetape_analyze_error(ide_drive_t *drive, u8 *sense)
Linus Torvalds's avatar
Linus Torvalds committed
513 514
{
	idetape_tape_t *tape = drive->driver_data;
515
	struct ide_atapi_pc *pc = tape->failed_pc;
Linus Torvalds's avatar
Linus Torvalds committed
516

517 518 519
	tape->sense_key = sense[2] & 0xF;
	tape->asc       = sense[12];
	tape->ascq      = sense[13];
520 521 522

	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
523

524
	/* Correct pc->xferred by asking the tape.	 */
525
	if (pc->flags & PC_FLAG_DMA_ERROR) {
526
		pc->xferred = pc->req_xfer -
527
			tape->blk_size *
528
			get_unaligned_be32(&sense[3]);
Linus Torvalds's avatar
Linus Torvalds committed
529 530 531 532 533 534 535 536
		idetape_update_buffers(pc);
	}

	/*
	 * 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.
	 */
537
	if ((pc->c[0] == READ_6 || pc->c[0] == WRITE_6)
538 539 540
	    /* 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
541 542 543
			/* don't report an error, everything's ok */
			pc->error = 0;
			/* don't retry read/write */
544
			pc->flags |= PC_FLAG_ABORT;
Linus Torvalds's avatar
Linus Torvalds committed
545 546
		}
	}
547
	if (pc->c[0] == READ_6 && (sense[2] & 0x80)) {
Linus Torvalds's avatar
Linus Torvalds committed
548
		pc->error = IDETAPE_ERROR_FILEMARK;
549
		pc->flags |= PC_FLAG_ABORT;
Linus Torvalds's avatar
Linus Torvalds committed
550
	}
551
	if (pc->c[0] == WRITE_6) {
552 553
		if ((sense[2] & 0x40) || (tape->sense_key == 0xd
		     && tape->asc == 0x0 && tape->ascq == 0x2)) {
Linus Torvalds's avatar
Linus Torvalds committed
554
			pc->error = IDETAPE_ERROR_EOD;
555
			pc->flags |= PC_FLAG_ABORT;
Linus Torvalds's avatar
Linus Torvalds committed
556 557
		}
	}
558
	if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
559
		if (tape->sense_key == 8) {
Linus Torvalds's avatar
Linus Torvalds committed
560
			pc->error = IDETAPE_ERROR_EOD;
561
			pc->flags |= PC_FLAG_ABORT;
Linus Torvalds's avatar
Linus Torvalds committed
562
		}
563
		if (!(pc->flags & PC_FLAG_ABORT) &&
564
		    pc->xferred)
Linus Torvalds's avatar
Linus Torvalds committed
565 566 567 568
			pc->retries = IDETAPE_MAX_PC_RETRIES + 1;
	}
}

569
/* Free data buffers completely. */
570
static void ide_tape_kfree_buffer(idetape_tape_t *tape)
Linus Torvalds's avatar
Linus Torvalds committed
571
{
572
	struct idetape_bh *prev_bh, *bh = tape->merge_bh;
573 574 575 576 577 578 579 580 581 582 583 584

	while (bh) {
		u32 size = bh->b_size;

		while (size) {
			unsigned int order = fls(size >> PAGE_SHIFT)-1;

			if (bh->b_data)
				free_pages((unsigned long)bh->b_data, order);

			size &= (order-1);
			bh->b_data += (1 << order) * PAGE_SIZE;
Linus Torvalds's avatar
Linus Torvalds committed
585 586 587 588 589
		}
		prev_bh = bh;
		bh = bh->b_reqnext;
		kfree(prev_bh);
	}
590
	kfree(tape->merge_bh);
Linus Torvalds's avatar
Linus Torvalds committed
591 592 593 594 595 596 597 598 599
}

static int idetape_end_request(ide_drive_t *drive, int uptodate, int nr_sects)
{
	struct request *rq = HWGROUP(drive)->rq;
	idetape_tape_t *tape = drive->driver_data;
	unsigned long flags;
	int error;

600
	debug_log(DBG_PROCS, "Enter %s\n", __func__);
Linus Torvalds's avatar
Linus Torvalds committed
601 602

	switch (uptodate) {
603 604 605
	case 0:	error = IDETAPE_ERROR_GENERAL; break;
	case 1: error = 0; break;
	default: error = uptodate;
Linus Torvalds's avatar
Linus Torvalds committed
606 607 608 609 610
	}
	rq->errors = error;
	if (error)
		tape->failed_pc = NULL;

611 612 613 614 615
	if (!blk_special_request(rq)) {
		ide_end_request(drive, uptodate, nr_sects);
		return 0;
	}

616
	spin_lock_irqsave(&tape->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
617 618 619

	ide_end_drive_cmd(drive, 0, 0);

620
	spin_unlock_irqrestore(&tape->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
621 622 623
	return 0;
}

624
static void ide_tape_callback(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
625 626
{
	idetape_tape_t *tape = drive->driver_data;
627 628
	struct ide_atapi_pc *pc = tape->pc;
	int uptodate = pc->error ? 0 : 1;
Linus Torvalds's avatar
Linus Torvalds committed
629

630 631
	debug_log(DBG_PROCS, "Enter %s\n", __func__);

632 633 634
	if (tape->failed_pc == pc)
		tape->failed_pc = NULL;

635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
	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) {
		struct request *rq = drive->hwif->hwgroup->rq;
		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;
		rq->current_nr_sectors -= blocks;

		if (pc->error)
			uptodate = pc->error;
	} else if (pc->c[0] == READ_POSITION && uptodate) {
		u8 *readpos = tape->pc->buf;

		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");
			clear_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags);
			uptodate = 0;
		} else {
			debug_log(DBG_SENSE, "Block Location - %u\n",
					be32_to_cpu(*(u32 *)&readpos[4]));

			tape->partition = readpos[1];
			tape->first_frame = be32_to_cpu(*(u32 *)&readpos[4]);
			set_bit(IDETAPE_FLAG_ADDRESS_VALID, &tape->flags);
		}
Linus Torvalds's avatar
Linus Torvalds committed
680
	}
681 682

	idetape_end_request(drive, uptodate, 0);
Linus Torvalds's avatar
Linus Torvalds committed
683 684
}

685 686 687 688 689 690 691 692 693 694
static void idetape_init_pc(struct ide_atapi_pc *pc)
{
	memset(pc->c, 0, 12);
	pc->retries = 0;
	pc->flags = 0;
	pc->req_xfer = 0;
	pc->buf = pc->pc_buf;
	pc->buf_size = IDETAPE_PC_BUFFER_SIZE;
	pc->bh = NULL;
	pc->b_data = NULL;
695
	pc->callback = ide_tape_callback;
696 697
}

698
static void idetape_create_request_sense_cmd(struct ide_atapi_pc *pc)
Linus Torvalds's avatar
Linus Torvalds committed
699
{
700
	idetape_init_pc(pc);
701
	pc->c[0] = REQUEST_SENSE;
Linus Torvalds's avatar
Linus Torvalds committed
702
	pc->c[4] = 20;
703
	pc->req_xfer = 20;
Linus Torvalds's avatar
Linus Torvalds committed
704 705 706 707
}

static void idetape_init_rq(struct request *rq, u8 cmd)
{
708
	blk_rq_init(NULL, rq);
709
	rq->cmd_type = REQ_TYPE_SPECIAL;
Linus Torvalds's avatar
Linus Torvalds committed
710 711 712 713
	rq->cmd[0] = cmd;
}

/*
714 715 716 717 718
 * Generate a new packet command request in front of the request queue, before
 * the current request, so that it will be processed immediately, on the next
 * pass through the driver. The function below is called from the request
 * handling part of the driver (the "bottom" part). Safe storage for the request
 * should be allocated with ide_tape_next_{pc,rq}_storage() prior to that.
Linus Torvalds's avatar
Linus Torvalds committed
719
 *
720 721 722
 * Memory for those requests is pre-allocated at initialization time, and is
 * limited to IDETAPE_PC_STACK requests. We assume that we have enough space for
 * the maximum possible number of inter-dependent packet commands.
Linus Torvalds's avatar
Linus Torvalds committed
723
 *
724 725 726
 * The higher level of the driver - The ioctl handler and the character device
 * handling functions should queue request to the lower level part and wait for
 * their completion using idetape_queue_pc_tail or idetape_queue_rw_tail.
Linus Torvalds's avatar
Linus Torvalds committed
727
 */
728
static void idetape_queue_pc_head(ide_drive_t *drive, struct ide_atapi_pc *pc,
729
				  struct request *rq)
Linus Torvalds's avatar
Linus Torvalds committed
730 731 732 733
{
	struct ide_tape_obj *tape = drive->driver_data;

	idetape_init_rq(rq, REQ_IDETAPE_PC1);
734
	rq->cmd_flags |= REQ_PREEMPT;
Linus Torvalds's avatar
Linus Torvalds committed
735 736
	rq->buffer = (char *) pc;
	rq->rq_disk = tape->disk;
737
	ide_do_drive_cmd(drive, rq);
Linus Torvalds's avatar
Linus Torvalds committed
738 739 740 741 742 743 744
}

/*
 *	idetape_retry_pc is called when an error was detected during the
 *	last packet command. We queue a request sense packet command in
 *	the head of the request list.
 */
745
static void idetape_retry_pc(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
746 747
{
	idetape_tape_t *tape = drive->driver_data;
748
	struct ide_atapi_pc *pc;
Linus Torvalds's avatar
Linus Torvalds committed
749 750
	struct request *rq;

751
	(void)ide_read_error(drive);
Linus Torvalds's avatar
Linus Torvalds committed
752 753 754
	pc = idetape_next_pc_storage(drive);
	rq = idetape_next_rq_storage(drive);
	idetape_create_request_sense_cmd(pc);
755
	set_bit(IDETAPE_FLAG_IGNORE_DSC, &tape->flags);
Linus Torvalds's avatar
Linus Torvalds committed
756 757 758 759
	idetape_queue_pc_head(drive, pc, rq);
}

/*
760 761
 * Postpone the current request so that ide.c will be able to service requests
 * from another device on the same hwgroup while we are polling for DSC.
Linus Torvalds's avatar
Linus Torvalds committed
762
 */
763
static void idetape_postpone_request(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
764 765 766
{
	idetape_tape_t *tape = drive->driver_data;

767 768
	debug_log(DBG_PROCS, "Enter %s\n", __func__);

Linus Torvalds's avatar
Linus Torvalds committed
769
	tape->postponed_rq = HWGROUP(drive)->rq;
770
	ide_stall_queue(drive, tape->dsc_poll_freq);
Linus Torvalds's avatar
Linus Torvalds committed
771 772
}

773 774 775 776 777 778 779 780 781 782 783 784
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);
}

785 786 787 788 789 790 791 792
static void ide_tape_io_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
				unsigned int bcount, int write)
{
	if (write)
		idetape_output_buffers(drive, pc, bcount);
	else
		idetape_input_buffers(drive, pc, bcount);
}
793

Linus Torvalds's avatar
Linus Torvalds committed
794
/*
795 796 797 798
 * This is the usual interrupt handler which will be called during a packet
 * command. We will transfer some of the data (as requested by the drive) and
 * will re-point interrupt handler to us. When data transfer is finished, we
 * will act according to the algorithm described before
799
 * idetape_issue_pc.
Linus Torvalds's avatar
Linus Torvalds committed
800
 */
801
static ide_startstop_t idetape_pc_intr(ide_drive_t *drive)
Linus Torvalds's avatar
Linus Torvalds committed
802 803 804
{
	ide_hwif_t *hwif = drive->hwif;
	idetape_tape_t *tape = drive->driver_data;
805
	struct ide_atapi_pc *pc = tape->pc;
806
	xfer_func_t *xferfunc;
Linus Torvalds's avatar
Linus Torvalds committed
807
	unsigned int temp;
808
	u16 bcount;
809
	u8 stat, ireason;
Linus Torvalds's avatar
Linus Torvalds committed
810

811
	debug_log(DBG_PC_INTR, "Enter %s - interrupt handler\n", __func__);
Linus Torvalds's avatar
Linus Torvalds committed
812 813

	/* Clear the interrupt */
814
	stat = ide_read_status(drive);
Linus Torvalds's avatar
Linus Torvalds committed
815

816
	if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
817
		if (hwif->dma_ops->dma_end(drive) || (stat & ERR_STAT)) {
818
			pc->flags |= PC_FLAG_DMA_ERROR;
Linus Torvalds's avatar
Linus Torvalds committed
819
		} else {
820
			pc->xferred = pc->req_xfer;
Linus Torvalds's avatar
Linus Torvalds committed
821 822
			idetape_update_buffers(pc);
		}
823
		debug_log(DBG_PC_INTR, "%s: DMA finished\n", drive->name);
Linus Torvalds's avatar
Linus Torvalds committed
824 825 826
	}

	/* No more interrupts */
827
	if ((stat & DRQ_STAT) == 0) {
828
		debug_log(DBG_PC_INTR, "Packet command completed, %d bytes"
829
				" transferred\n", pc->xferred);
Linus Torvalds's avatar
Linus Torvalds committed
830

831
		pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
832
		local_irq_enable_in_hardirq();
Linus Torvalds's avatar
Linus Torvalds committed
833

834
		if ((stat & ERR_STAT) && pc->c[0] == REQUEST_SENSE)
835
			stat &= ~ERR_STAT;
836
		if ((stat & ERR_STAT) || (pc->flags & PC_FLAG_DMA_ERROR)) {
837
			/* Error detected */
838
			debug_log(DBG_PC_INTR, "%s: I/O error\n", drive->name);
839

840
			if (pc->c[0] == REQUEST_SENSE) {
841 842
				printk(KERN_ERR "%s: I/O error in request sense"
						" command\n", drive->name);
Linus Torvalds's avatar
Linus Torvalds committed
843 844
				return ide_do_reset(drive);
			}
845
			debug_log(DBG_PC_INTR, "[cmd %x]: check condition\n",
846 847
					pc->c[0]);

Linus Torvalds's avatar
Linus Torvalds committed
848
			/* Retry operation */
849 850
			idetape_retry_pc(drive);
			return ide_stopped;
Linus Torvalds's avatar
Linus Torvalds committed
851 852
		}
		pc->error = 0;
853
		if ((pc->flags & PC_FLAG_WAIT_FOR_DSC) &&
854
		    (stat & SEEK_STAT) == 0) {
855
			ide_tape_handle_dsc(drive);
Linus Torvalds's avatar
Linus Torvalds committed
856 857 858
			return ide_stopped;
		}
		/* Command finished - Call the callback function */
859
		pc->callback(drive);
860
		return ide_stopped;
Linus Torvalds's avatar
Linus Torvalds committed
861
	}
862 863 864

	if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
		pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
865 866
		printk(KERN_ERR "%s: The device wants to issue more interrupts "
				"in DMA mode\n", drive->name);
867
		ide_dma_off(drive);
Linus Torvalds's avatar
Linus Torvalds committed
868 869 870
		return ide_do_reset(drive);
	}
	/* Get the number of bytes to transfer on this interrupt. */
871 872
	bcount = (hwif->INB(hwif->io_ports.lbah_addr) << 8) |
		  hwif->INB(hwif->io_ports.lbam_addr);
Linus Torvalds's avatar
Linus Torvalds committed
873

874
	ireason = hwif->INB(hwif->io_ports.nsect_addr);
Linus Torvalds's avatar
Linus Torvalds committed
875

876
	if (ireason & CD) {
877
		printk(KERN_ERR "%s: CoD != 0 in %s\n", drive->name, __func__);
Linus Torvalds's avatar
Linus Torvalds committed
878 879
		return ide_do_reset(drive);
	}
880
	if (((ireason & IO) == IO) == !!(pc->flags & PC_FLAG_WRITING)) {
Linus Torvalds's avatar
Linus Torvalds committed
881
		/* Hopefully, we will never get here */
882 883 884
		printk(KERN_ERR "%s: We wanted to %s, but the device wants us "
				"to %s!\n", drive->name,
				(ireason & IO) ? "Write" : "Read",
885
				(ireason & IO) ? "Read" : "Write");
Linus Torvalds's avatar
Linus Torvalds committed
886 887
		return ide_do_reset(drive);
	}
888
	if (!(pc->flags & PC_FLAG_WRITING)) {
Linus Torvalds's avatar
Linus Torvalds committed
889
		/* Reading - Check that we have enough space */
890 891 892
		temp = pc->xferred + bcount;
		if (temp > pc->req_xfer) {
			if (temp > pc->buf_size) {
893 894 895 896
				printk(KERN_ERR "%s: The device wants to send "
						"us more data than expected - "
						"discarding data\n",
						drive->name);
897
				ide_pad_transfer(drive, 0, bcount);
898 899
				ide_set_handler(drive, &idetape_pc_intr,
						IDETAPE_WAIT_CMD, NULL);
Linus Torvalds's avatar
Linus Torvalds committed
900 901
				return ide_started;
			}
902
			debug_log(DBG_PC_INTR, "The device wants to send us more "
903
				"data than expected - allowing transfer\n");
Linus Torvalds's avatar
Linus Torvalds committed
904
		}
905
		xferfunc = hwif->input_data;
Linus Torvalds's avatar
Linus Torvalds committed
906
	} else {
907
		xferfunc = hwif->output_data;
Linus Torvalds's avatar
Linus Torvalds committed
908
	}
909 910

	if (pc->bh)
911 912
		ide_tape_io_buffers(drive, pc, bcount,
				    !!(pc->flags & PC_FLAG_WRITING));
913
	else
914
		xferfunc(drive, NULL, pc->cur_pos, bcount);
915

Linus Torvalds's avatar
Linus Torvalds committed
916
	/* Update the current position */
917 918
	pc->xferred += bcount;
	pc->cur_pos += bcount;
919

920
	debug_log(DBG_PC_INTR, "[cmd %x] transferred %d bytes on that intr.\n",
921 922
			pc->c[0], bcount);

Linus Torvalds's avatar
Linus Torvalds committed
923 924 925 926 927 928
	/* And set the interrupt handler again */
	ide_set_handler(drive, &idetape_pc_intr, IDETAPE_WAIT_CMD, NULL);
	return ide_started;
}

/*
929
 * Packet Command Interface
Linus Torvalds's avatar
Linus Torvalds committed
930
 *
931 932 933
 * The current Packet Command is available in tape->pc, and will not change
 * 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
934
 *
935
 * The handling will be done in three stages:
Linus Torvalds's avatar
Linus Torvalds committed
936
 *
937 938
 * 1. idetape_issue_pc will send the packet command to the drive, and will set
 * the interrupt handler to idetape_pc_intr.
Linus Torvalds's avatar
Linus Torvalds committed
939
 *
940 941
 * 2. On each interrupt, idetape_pc_intr will be called. This step will be
 * repeated until the device signals us that no more interrupts will be issued.
Linus Torvalds's avatar
Linus Torvalds committed
942
 *
943 944 945 946 947 948 949
 * 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
950
 *
951 952
 * 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
953
 *
954
 * 4. When the packet command is finished, it will be checked for errors.
Linus Torvalds's avatar
Linus Torvalds committed
955
 *
956 957 958
 * 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
959
 *
960 961 962
 * 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
963
 */
964 965 966 967
static ide_startstop_t idetape_transfer_pc(ide_drive_t *drive)
{
	idetape_tape_t *tape = drive->driver_data;

968 969
	return ide_transfer_pc(drive, tape->pc, idetape_pc_intr,
			       IDETAPE_WAIT_CMD, NULL);
Linus Torvalds's avatar
Linus Torvalds committed
970 971
}

972 973
static ide_startstop_t idetape_issue_pc(ide_drive_t *drive,
		struct ide_atapi_pc *pc)
Linus Torvalds's avatar
Linus Torvalds committed
974 975 976
{
	idetape_tape_t *tape = drive->driver_data;

977 978
	if (tape->pc->c[0] == REQUEST_SENSE &&
	    pc->c[0] == REQUEST_SENSE) {
Linus Torvalds's avatar
Linus Torvalds committed
979 980 981 982
		printk(KERN_ERR "ide-tape: possible ide-tape.c bug - "
			"Two request sense in serial were issued\n");
	}

983
	if (tape->failed_pc == NULL && pc->c[0] != REQUEST_SENSE)
Linus Torvalds's avatar
Linus Torvalds committed
984 985 986 987 988
		tape->failed_pc = pc;
	/* Set the current packet command */
	tape->pc = pc;

	if (pc->retries > IDETAPE_MAX_PC_RETRIES ||
989
		(pc->flags & PC_FLAG_ABORT)) {
Linus Torvalds's avatar
Linus Torvalds committed
990
		/*
991 992 993
		 * 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
994
		 */
995
		if (!(pc->flags & PC_FLAG_ABORT)) {