ide-atapi: don't abuse rq->buffer
[GitHub/LineageOS/android_kernel_motorola_exynos9610.git] / drivers / ide / ide-tape.c
CommitLineData
1da177e4 1/*
5ce78af4
BP
2 * IDE ATAPI streaming tape driver.
3 *
59bca8cc
BZ
4 * Copyright (C) 1995-1999 Gadi Oxman <gadio@netvision.net.il>
5 * Copyright (C) 2003-2005 Bartlomiej Zolnierkiewicz
1da177e4 6 *
1da177e4
LT
7 * This driver was constructed as a student project in the software laboratory
8 * of the faculty of electrical engineering in the Technion - Israel's
9 * Institute Of Technology, with the guide of Avner Lottem and Dr. Ilana David.
10 *
11 * It is hereby placed under the terms of the GNU general public license.
12 * (See linux/COPYING).
1da177e4 13 *
5ce78af4
BP
14 * For a historical changelog see
15 * Documentation/ide/ChangeLog.ide-tape.1995-2002
1da177e4
LT
16 */
17
51509eec
BZ
18#define DRV_NAME "ide-tape"
19
dfe79936 20#define IDETAPE_VERSION "1.20"
1da177e4 21
1da177e4
LT
22#include <linux/module.h>
23#include <linux/types.h>
24#include <linux/string.h>
25#include <linux/kernel.h>
26#include <linux/delay.h>
27#include <linux/timer.h>
28#include <linux/mm.h>
29#include <linux/interrupt.h>
9bae1ff3 30#include <linux/jiffies.h>
1da177e4 31#include <linux/major.h>
1da177e4
LT
32#include <linux/errno.h>
33#include <linux/genhd.h>
34#include <linux/slab.h>
35#include <linux/pci.h>
36#include <linux/ide.h>
37#include <linux/smp_lock.h>
38#include <linux/completion.h>
39#include <linux/bitops.h>
cf8b8975 40#include <linux/mutex.h>
90699ce2 41#include <scsi/scsi.h>
1da177e4
LT
42
43#include <asm/byteorder.h>
c837cfa5
BP
44#include <linux/irq.h>
45#include <linux/uaccess.h>
46#include <linux/io.h>
1da177e4 47#include <asm/unaligned.h>
1da177e4
LT
48#include <linux/mtio.h>
49
8004a8c9
BP
50enum {
51 /* output errors only */
52 DBG_ERR = (1 << 0),
53 /* output all sense key/asc */
54 DBG_SENSE = (1 << 1),
55 /* info regarding all chrdev-related procedures */
56 DBG_CHRDEV = (1 << 2),
57 /* all remaining procedures */
58 DBG_PROCS = (1 << 3),
8004a8c9
BP
59};
60
61/* define to see debug info */
62#define IDETAPE_DEBUG_LOG 0
63
64#if IDETAPE_DEBUG_LOG
65#define debug_log(lvl, fmt, args...) \
66{ \
67 if (tape->debug_mask & lvl) \
68 printk(KERN_INFO "ide-tape: " fmt, ## args); \
69}
70#else
71#define debug_log(lvl, fmt, args...) do {} while (0)
72#endif
73
1da177e4 74/**************************** Tunable parameters *****************************/
1da177e4 75/*
3c98bf34
BP
76 * After each failed packet command we issue a request sense command and retry
77 * the packet command IDETAPE_MAX_PC_RETRIES times.
1da177e4 78 *
3c98bf34 79 * Setting IDETAPE_MAX_PC_RETRIES to 0 will disable retries.
1da177e4
LT
80 */
81#define IDETAPE_MAX_PC_RETRIES 3
82
1da177e4 83/*
3c98bf34
BP
84 * The following parameter is used to select the point in the internal tape fifo
85 * in which we will start to refill the buffer. Decreasing the following
86 * parameter will improve the system's latency and interactive response, while
87 * using a high value might improve system throughput.
1da177e4 88 */
3c98bf34 89#define IDETAPE_FIFO_THRESHOLD 2
1da177e4
LT
90
91/*
3c98bf34 92 * DSC polling parameters.
1da177e4 93 *
3c98bf34
BP
94 * Polling for DSC (a single bit in the status register) is a very important
95 * function in ide-tape. There are two cases in which we poll for DSC:
1da177e4 96 *
3c98bf34
BP
97 * 1. Before a read/write packet command, to ensure that we can transfer data
98 * from/to the tape's data buffers, without causing an actual media access.
99 * In case the tape is not ready yet, we take out our request from the device
100 * request queue, so that ide.c could service requests from the other device
101 * on the same interface in the meantime.
1da177e4 102 *
3c98bf34
BP
103 * 2. After the successful initialization of a "media access packet command",
104 * which is a command that can take a long time to complete (the interval can
105 * range from several seconds to even an hour). Again, we postpone our request
106 * in the middle to free the bus for the other device. The polling frequency
107 * here should be lower than the read/write frequency since those media access
108 * commands are slow. We start from a "fast" frequency - IDETAPE_DSC_MA_FAST
109 * (1 second), and if we don't receive DSC after IDETAPE_DSC_MA_THRESHOLD
110 * (5 min), we switch it to a lower frequency - IDETAPE_DSC_MA_SLOW (1 min).
1da177e4 111 *
3c98bf34
BP
112 * We also set a timeout for the timer, in case something goes wrong. The
113 * timeout should be longer then the maximum execution time of a tape operation.
1da177e4 114 */
3c98bf34
BP
115
116/* DSC timings. */
1da177e4
LT
117#define IDETAPE_DSC_RW_MIN 5*HZ/100 /* 50 msec */
118#define IDETAPE_DSC_RW_MAX 40*HZ/100 /* 400 msec */
119#define IDETAPE_DSC_RW_TIMEOUT 2*60*HZ /* 2 minutes */
120#define IDETAPE_DSC_MA_FAST 2*HZ /* 2 seconds */
121#define IDETAPE_DSC_MA_THRESHOLD 5*60*HZ /* 5 minutes */
122#define IDETAPE_DSC_MA_SLOW 30*HZ /* 30 seconds */
123#define IDETAPE_DSC_MA_TIMEOUT 2*60*60*HZ /* 2 hours */
124
125/*************************** End of tunable parameters ***********************/
126
54abf37e
BP
127/* tape directions */
128enum {
129 IDETAPE_DIR_NONE = (1 << 0),
130 IDETAPE_DIR_READ = (1 << 1),
131 IDETAPE_DIR_WRITE = (1 << 2),
132};
1da177e4
LT
133
134struct idetape_bh {
ab057968 135 u32 b_size;
1da177e4
LT
136 atomic_t b_count;
137 struct idetape_bh *b_reqnext;
138 char *b_data;
139};
140
03056b90
BP
141/* Tape door status */
142#define DOOR_UNLOCKED 0
143#define DOOR_LOCKED 1
144#define DOOR_EXPLICITLY_LOCKED 2
145
146/* Some defines for the SPACE command */
147#define IDETAPE_SPACE_OVER_FILEMARK 1
148#define IDETAPE_SPACE_TO_EOD 3
149
150/* Some defines for the LOAD UNLOAD command */
151#define IDETAPE_LU_LOAD_MASK 1
152#define IDETAPE_LU_RETENSION_MASK 2
153#define IDETAPE_LU_EOT_MASK 4
154
03056b90
BP
155/* Structures related to the SELECT SENSE / MODE SENSE packet commands. */
156#define IDETAPE_BLOCK_DESCRIPTOR 0
157#define IDETAPE_CAPABILITIES_PAGE 0x2a
158
1da177e4 159/*
3c98bf34
BP
160 * Most of our global data which we need to save even as we leave the driver due
161 * to an interrupt or a timer event is stored in the struct defined below.
1da177e4
LT
162 */
163typedef struct ide_tape_obj {
7f3c868b
BZ
164 ide_drive_t *drive;
165 struct ide_driver *driver;
166 struct gendisk *disk;
8fed4368 167 struct device dev;
1da177e4 168
2e8a6f89
BZ
169 /* used by REQ_IDETAPE_{READ,WRITE} requests */
170 struct ide_atapi_pc queued_pc;
394a4c21 171
1da177e4 172 /*
3c98bf34 173 * DSC polling variables.
1da177e4 174 *
3c98bf34
BP
175 * While polling for DSC we use postponed_rq to postpone the current
176 * request so that ide.c will be able to service pending requests on the
177 * other device. Note that at most we will have only one DSC (usually
5bd50dc6 178 * data transfer) request in the device request queue.
1da177e4
LT
179 */
180 struct request *postponed_rq;
181 /* The time in which we started polling for DSC */
182 unsigned long dsc_polling_start;
183 /* Timer used to poll for dsc */
184 struct timer_list dsc_timer;
185 /* Read/Write dsc polling frequency */
54bb2074
BP
186 unsigned long best_dsc_rw_freq;
187 unsigned long dsc_poll_freq;
1da177e4
LT
188 unsigned long dsc_timeout;
189
3c98bf34 190 /* Read position information */
1da177e4
LT
191 u8 partition;
192 /* Current block */
54bb2074 193 unsigned int first_frame;
1da177e4 194
3c98bf34 195 /* Last error information */
1da177e4
LT
196 u8 sense_key, asc, ascq;
197
3c98bf34 198 /* Character device operation */
1da177e4
LT
199 unsigned int minor;
200 /* device name */
201 char name[4];
202 /* Current character device data transfer direction */
54abf37e 203 u8 chrdev_dir;
1da177e4 204
54bb2074
BP
205 /* tape block size, usually 512 or 1024 bytes */
206 unsigned short blk_size;
1da177e4 207 int user_bs_factor;
b6422013 208
1da177e4 209 /* Copy of the tape's Capabilities and Mechanical Page */
b6422013 210 u8 caps[20];
1da177e4
LT
211
212 /*
3c98bf34 213 * Active data transfer request parameters.
1da177e4 214 *
3c98bf34
BP
215 * At most, there is only one ide-tape originated data transfer request
216 * in the device request queue. This allows ide.c to easily service
217 * requests from the other device when we postpone our active request.
1da177e4 218 */
83042b24 219
3c98bf34 220 /* Data buffer size chosen based on the tape's recommendation */
f73850a3 221 int buffer_size;
077e3bdb
BP
222 /* merge buffer */
223 struct idetape_bh *merge_bh;
01a63aeb
BP
224 /* size of the merge buffer */
225 int merge_bh_size;
077e3bdb 226 /* pointer to current buffer head within the merge buffer */
1da177e4
LT
227 struct idetape_bh *bh;
228 char *b_data;
229 int b_count;
3c98bf34 230
a997a435 231 int pages_per_buffer;
1da177e4
LT
232 /* Wasted space in each stage */
233 int excess_bh_size;
234
3c98bf34 235 /* Measures average tape speed */
1da177e4
LT
236 unsigned long avg_time;
237 int avg_size;
238 int avg_speed;
239
1da177e4
LT
240 /* the door is currently locked */
241 int door_locked;
242 /* the tape hardware is write protected */
243 char drv_write_prot;
244 /* the tape is write protected (hardware or opened as read-only) */
245 char write_prot;
246
8004a8c9 247 u32 debug_mask;
1da177e4
LT
248} idetape_tape_t;
249
cf8b8975 250static DEFINE_MUTEX(idetape_ref_mutex);
1da177e4 251
d5dee80a
WD
252static struct class *idetape_sysfs_class;
253
8fed4368 254static void ide_tape_release(struct device *);
08da591e 255
1da177e4
LT
256static struct ide_tape_obj *ide_tape_get(struct gendisk *disk)
257{
258 struct ide_tape_obj *tape = NULL;
259
cf8b8975 260 mutex_lock(&idetape_ref_mutex);
5aeddf90 261 tape = ide_drv_g(disk, ide_tape_obj);
08da591e 262 if (tape) {
d3e33ff5 263 if (ide_device_get(tape->drive))
08da591e 264 tape = NULL;
d3e33ff5 265 else
8fed4368 266 get_device(&tape->dev);
08da591e 267 }
cf8b8975 268 mutex_unlock(&idetape_ref_mutex);
1da177e4
LT
269 return tape;
270}
271
1da177e4
LT
272static void ide_tape_put(struct ide_tape_obj *tape)
273{
d3e33ff5
BZ
274 ide_drive_t *drive = tape->drive;
275
cf8b8975 276 mutex_lock(&idetape_ref_mutex);
8fed4368 277 put_device(&tape->dev);
d3e33ff5 278 ide_device_put(drive);
cf8b8975 279 mutex_unlock(&idetape_ref_mutex);
1da177e4
LT
280}
281
1da177e4 282/*
3c98bf34
BP
283 * The variables below are used for the character device interface. Additional
284 * state variables are defined in our ide_drive_t structure.
1da177e4 285 */
5a04cfa9 286static struct ide_tape_obj *idetape_devs[MAX_HWIFS * MAX_DRIVES];
1da177e4 287
1da177e4
LT
288static struct ide_tape_obj *ide_tape_chrdev_get(unsigned int i)
289{
290 struct ide_tape_obj *tape = NULL;
291
cf8b8975 292 mutex_lock(&idetape_ref_mutex);
1da177e4
LT
293 tape = idetape_devs[i];
294 if (tape)
8fed4368 295 get_device(&tape->dev);
cf8b8975 296 mutex_unlock(&idetape_ref_mutex);
1da177e4
LT
297 return tape;
298}
299
d93bc452 300static int idetape_input_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
5a04cfa9 301 unsigned int bcount)
1da177e4
LT
302{
303 struct idetape_bh *bh = pc->bh;
304 int count;
305
306 while (bcount) {
d93bc452
BZ
307 if (bh == NULL)
308 break;
5a04cfa9
BP
309 count = min(
310 (unsigned int)(bh->b_size - atomic_read(&bh->b_count)),
311 bcount);
374e042c 312 drive->hwif->tp_ops->input_data(drive, NULL, bh->b_data +
5a04cfa9 313 atomic_read(&bh->b_count), count);
1da177e4
LT
314 bcount -= count;
315 atomic_add(count, &bh->b_count);
316 if (atomic_read(&bh->b_count) == bh->b_size) {
317 bh = bh->b_reqnext;
318 if (bh)
319 atomic_set(&bh->b_count, 0);
320 }
321 }
d93bc452 322
1da177e4 323 pc->bh = bh;
d93bc452
BZ
324
325 return bcount;
1da177e4
LT
326}
327
d93bc452 328static int idetape_output_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
5a04cfa9 329 unsigned int bcount)
1da177e4
LT
330{
331 struct idetape_bh *bh = pc->bh;
332 int count;
333
334 while (bcount) {
d93bc452
BZ
335 if (bh == NULL)
336 break;
1da177e4 337 count = min((unsigned int)pc->b_count, (unsigned int)bcount);
374e042c 338 drive->hwif->tp_ops->output_data(drive, NULL, pc->b_data, count);
1da177e4
LT
339 bcount -= count;
340 pc->b_data += count;
341 pc->b_count -= count;
342 if (!pc->b_count) {
5a04cfa9
BP
343 bh = bh->b_reqnext;
344 pc->bh = bh;
1da177e4
LT
345 if (bh) {
346 pc->b_data = bh->b_data;
347 pc->b_count = atomic_read(&bh->b_count);
348 }
349 }
350 }
d93bc452
BZ
351
352 return bcount;
1da177e4
LT
353}
354
646c0cb6 355static void idetape_update_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc)
1da177e4
LT
356{
357 struct idetape_bh *bh = pc->bh;
358 int count;
d236d74c 359 unsigned int bcount = pc->xferred;
1da177e4 360
346331f8 361 if (pc->flags & PC_FLAG_WRITING)
1da177e4
LT
362 return;
363 while (bcount) {
1da177e4 364 if (bh == NULL) {
5a04cfa9
BP
365 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
366 __func__);
1da177e4
LT
367 return;
368 }
1da177e4
LT
369 count = min((unsigned int)bh->b_size, (unsigned int)bcount);
370 atomic_set(&bh->b_count, count);
371 if (atomic_read(&bh->b_count) == bh->b_size)
372 bh = bh->b_reqnext;
373 bcount -= count;
374 }
375 pc->bh = bh;
376}
377
1da177e4 378/*
1b5db434
BP
379 * called on each failed packet command retry to analyze the request sense. We
380 * currently do not utilize this information.
1da177e4 381 */
1b5db434 382static void idetape_analyze_error(ide_drive_t *drive, u8 *sense)
1da177e4
LT
383{
384 idetape_tape_t *tape = drive->driver_data;
5e2040fd 385 struct ide_atapi_pc *pc = drive->failed_pc;
1da177e4 386
1b5db434
BP
387 tape->sense_key = sense[2] & 0xF;
388 tape->asc = sense[12];
389 tape->ascq = sense[13];
8004a8c9
BP
390
391 debug_log(DBG_ERR, "pc = %x, sense key = %x, asc = %x, ascq = %x\n",
392 pc->c[0], tape->sense_key, tape->asc, tape->ascq);
1da177e4 393
d236d74c 394 /* Correct pc->xferred by asking the tape. */
346331f8 395 if (pc->flags & PC_FLAG_DMA_ERROR) {
d236d74c 396 pc->xferred = pc->req_xfer -
54bb2074 397 tape->blk_size *
5d0cc8ae 398 get_unaligned_be32(&sense[3]);
646c0cb6 399 idetape_update_buffers(drive, pc);
1da177e4
LT
400 }
401
402 /*
403 * If error was the result of a zero-length read or write command,
404 * with sense key=5, asc=0x22, ascq=0, let it slide. Some drives
405 * (i.e. Seagate STT3401A Travan) don't support 0-length read/writes.
406 */
90699ce2 407 if ((pc->c[0] == READ_6 || pc->c[0] == WRITE_6)
1b5db434
BP
408 /* length == 0 */
409 && pc->c[4] == 0 && pc->c[3] == 0 && pc->c[2] == 0) {
410 if (tape->sense_key == 5) {
1da177e4
LT
411 /* don't report an error, everything's ok */
412 pc->error = 0;
413 /* don't retry read/write */
346331f8 414 pc->flags |= PC_FLAG_ABORT;
1da177e4
LT
415 }
416 }
90699ce2 417 if (pc->c[0] == READ_6 && (sense[2] & 0x80)) {
c152cc1a 418 pc->error = IDE_DRV_ERROR_FILEMARK;
346331f8 419 pc->flags |= PC_FLAG_ABORT;
1da177e4 420 }
90699ce2 421 if (pc->c[0] == WRITE_6) {
1b5db434
BP
422 if ((sense[2] & 0x40) || (tape->sense_key == 0xd
423 && tape->asc == 0x0 && tape->ascq == 0x2)) {
c152cc1a 424 pc->error = IDE_DRV_ERROR_EOD;
346331f8 425 pc->flags |= PC_FLAG_ABORT;
1da177e4
LT
426 }
427 }
90699ce2 428 if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
1b5db434 429 if (tape->sense_key == 8) {
c152cc1a 430 pc->error = IDE_DRV_ERROR_EOD;
346331f8 431 pc->flags |= PC_FLAG_ABORT;
1da177e4 432 }
346331f8 433 if (!(pc->flags & PC_FLAG_ABORT) &&
d236d74c 434 pc->xferred)
1da177e4
LT
435 pc->retries = IDETAPE_MAX_PC_RETRIES + 1;
436 }
437}
438
d01dbc3b 439/* Free data buffers completely. */
077e3bdb 440static void ide_tape_kfree_buffer(idetape_tape_t *tape)
1da177e4 441{
077e3bdb 442 struct idetape_bh *prev_bh, *bh = tape->merge_bh;
d01dbc3b
BP
443
444 while (bh) {
445 u32 size = bh->b_size;
446
447 while (size) {
448 unsigned int order = fls(size >> PAGE_SHIFT)-1;
449
450 if (bh->b_data)
451 free_pages((unsigned long)bh->b_data, order);
452
453 size &= (order-1);
454 bh->b_data += (1 << order) * PAGE_SIZE;
1da177e4
LT
455 }
456 prev_bh = bh;
457 bh = bh->b_reqnext;
458 kfree(prev_bh);
459 }
1da177e4
LT
460}
461
b14c7212
BZ
462static void ide_tape_handle_dsc(ide_drive_t *);
463
03a2faae 464static int ide_tape_callback(ide_drive_t *drive, int dsc)
1da177e4
LT
465{
466 idetape_tape_t *tape = drive->driver_data;
2b9efba4 467 struct ide_atapi_pc *pc = drive->pc;
313afea7 468 struct request *rq = drive->hwif->rq;
5985e6ab 469 int uptodate = pc->error ? 0 : 1;
313afea7 470 int err = uptodate ? 0 : IDE_DRV_ERROR_GENERAL;
1da177e4 471
8004a8c9
BP
472 debug_log(DBG_PROCS, "Enter %s\n", __func__);
473
b14c7212
BZ
474 if (dsc)
475 ide_tape_handle_dsc(drive);
476
5e2040fd
BZ
477 if (drive->failed_pc == pc)
478 drive->failed_pc = NULL;
dd2e9a03 479
5985e6ab
BZ
480 if (pc->c[0] == REQUEST_SENSE) {
481 if (uptodate)
482 idetape_analyze_error(drive, pc->buf);
483 else
484 printk(KERN_ERR "ide-tape: Error in REQUEST SENSE "
485 "itself - Aborting request!\n");
486 } else if (pc->c[0] == READ_6 || pc->c[0] == WRITE_6) {
5985e6ab
BZ
487 int blocks = pc->xferred / tape->blk_size;
488
489 tape->avg_size += blocks * tape->blk_size;
490
491 if (time_after_eq(jiffies, tape->avg_time + HZ)) {
492 tape->avg_speed = tape->avg_size * HZ /
493 (jiffies - tape->avg_time) / 1024;
494 tape->avg_size = 0;
495 tape->avg_time = jiffies;
496 }
497
498 tape->first_frame += blocks;
499 rq->current_nr_sectors -= blocks;
500
313afea7
BZ
501 if (pc->error) {
502 uptodate = 0;
503 err = pc->error;
504 }
5985e6ab 505 } else if (pc->c[0] == READ_POSITION && uptodate) {
2b9efba4 506 u8 *readpos = pc->buf;
5985e6ab
BZ
507
508 debug_log(DBG_SENSE, "BOP - %s\n",
509 (readpos[0] & 0x80) ? "Yes" : "No");
510 debug_log(DBG_SENSE, "EOP - %s\n",
511 (readpos[0] & 0x40) ? "Yes" : "No");
512
513 if (readpos[0] & 0x4) {
514 printk(KERN_INFO "ide-tape: Block location is unknown"
515 "to the tape\n");
f2e3ab52 516 clear_bit(IDE_AFLAG_ADDRESS_VALID, &drive->atapi_flags);
5985e6ab 517 uptodate = 0;
313afea7 518 err = IDE_DRV_ERROR_GENERAL;
5985e6ab
BZ
519 } else {
520 debug_log(DBG_SENSE, "Block Location - %u\n",
cd740ab0 521 be32_to_cpup((__be32 *)&readpos[4]));
5985e6ab
BZ
522
523 tape->partition = readpos[1];
cd740ab0 524 tape->first_frame = be32_to_cpup((__be32 *)&readpos[4]);
f2e3ab52 525 set_bit(IDE_AFLAG_ADDRESS_VALID, &drive->atapi_flags);
5985e6ab 526 }
1da177e4 527 }
5985e6ab 528
313afea7
BZ
529 rq->errors = err;
530
03a2faae 531 return uptodate;
1da177e4
LT
532}
533
1da177e4 534/*
3c98bf34 535 * Postpone the current request so that ide.c will be able to service requests
b65fac32 536 * from another device on the same port while we are polling for DSC.
1da177e4 537 */
5a04cfa9 538static void idetape_postpone_request(ide_drive_t *drive)
1da177e4
LT
539{
540 idetape_tape_t *tape = drive->driver_data;
541
8004a8c9
BP
542 debug_log(DBG_PROCS, "Enter %s\n", __func__);
543
b65fac32
BZ
544 tape->postponed_rq = drive->hwif->rq;
545
54bb2074 546 ide_stall_queue(drive, tape->dsc_poll_freq);
1da177e4
LT
547}
548
74e63e74
BZ
549static void ide_tape_handle_dsc(ide_drive_t *drive)
550{
551 idetape_tape_t *tape = drive->driver_data;
552
553 /* Media access command */
554 tape->dsc_polling_start = jiffies;
555 tape->dsc_poll_freq = IDETAPE_DSC_MA_FAST;
556 tape->dsc_timeout = jiffies + IDETAPE_DSC_MA_TIMEOUT;
557 /* Allow ide.c to handle other requests */
558 idetape_postpone_request(drive);
559}
560
acaa0f5f 561static int ide_tape_io_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
08424ac2
BZ
562 unsigned int bcount, int write)
563{
d93bc452
BZ
564 unsigned int bleft;
565
08424ac2 566 if (write)
d93bc452 567 bleft = idetape_output_buffers(drive, pc, bcount);
08424ac2 568 else
d93bc452 569 bleft = idetape_input_buffers(drive, pc, bcount);
acaa0f5f 570
d93bc452 571 return bcount - bleft;
08424ac2 572}
a1efc85f 573
1da177e4 574/*
3c98bf34 575 * Packet Command Interface
1da177e4 576 *
2b9efba4 577 * The current Packet Command is available in drive->pc, and will not change
3c98bf34
BP
578 * until we finish handling it. Each packet command is associated with a
579 * callback function that will be called when the command is finished.
1da177e4 580 *
3c98bf34 581 * The handling will be done in three stages:
1da177e4 582 *
b788ee9c 583 * 1. ide_tape_issue_pc will send the packet command to the drive, and will set
aa5d2de7 584 * the interrupt handler to ide_pc_intr.
1da177e4 585 *
aa5d2de7 586 * 2. On each interrupt, ide_pc_intr will be called. This step will be
3c98bf34 587 * repeated until the device signals us that no more interrupts will be issued.
1da177e4 588 *
3c98bf34
BP
589 * 3. ATAPI Tape media access commands have immediate status with a delayed
590 * process. In case of a successful initiation of a media access packet command,
591 * the DSC bit will be set when the actual execution of the command is finished.
592 * Since the tape drive will not issue an interrupt, we have to poll for this
593 * event. In this case, we define the request as "low priority request" by
594 * setting rq_status to IDETAPE_RQ_POSTPONED, set a timer to poll for DSC and
595 * exit the driver.
1da177e4 596 *
3c98bf34
BP
597 * ide.c will then give higher priority to requests which originate from the
598 * other device, until will change rq_status to RQ_ACTIVE.
1da177e4 599 *
3c98bf34 600 * 4. When the packet command is finished, it will be checked for errors.
1da177e4 601 *
3c98bf34
BP
602 * 5. In case an error was found, we queue a request sense packet command in
603 * front of the request queue and retry the operation up to
604 * IDETAPE_MAX_PC_RETRIES times.
1da177e4 605 *
3c98bf34
BP
606 * 6. In case no error was found, or we decided to give up and not to retry
607 * again, the callback function will be called and then we will handle the next
608 * request.
1da177e4 609 */
1da177e4 610
b788ee9c
BZ
611static ide_startstop_t ide_tape_issue_pc(ide_drive_t *drive,
612 struct ide_cmd *cmd,
613 struct ide_atapi_pc *pc)
1da177e4 614{
1da177e4 615 idetape_tape_t *tape = drive->driver_data;
1da177e4 616
5e2040fd
BZ
617 if (drive->failed_pc == NULL && pc->c[0] != REQUEST_SENSE)
618 drive->failed_pc = pc;
2b9efba4 619
1da177e4 620 /* Set the current packet command */
2b9efba4 621 drive->pc = pc;
1da177e4
LT
622
623 if (pc->retries > IDETAPE_MAX_PC_RETRIES ||
346331f8 624 (pc->flags & PC_FLAG_ABORT)) {
1da177e4 625 /*
3c98bf34
BP
626 * We will "abort" retrying a packet command in case legitimate
627 * error code was received (crossing a filemark, or end of the
628 * media, for example).
1da177e4 629 */
346331f8 630 if (!(pc->flags & PC_FLAG_ABORT)) {
90699ce2 631 if (!(pc->c[0] == TEST_UNIT_READY &&
1da177e4
LT
632 tape->sense_key == 2 && tape->asc == 4 &&
633 (tape->ascq == 1 || tape->ascq == 8))) {
634 printk(KERN_ERR "ide-tape: %s: I/O error, "
635 "pc = %2x, key = %2x, "
636 "asc = %2x, ascq = %2x\n",
637 tape->name, pc->c[0],
638 tape->sense_key, tape->asc,
639 tape->ascq);
640 }
641 /* Giving up */
c152cc1a 642 pc->error = IDE_DRV_ERROR_GENERAL;
1da177e4 643 }
5e2040fd 644 drive->failed_pc = NULL;
b14c7212 645 drive->pc_callback(drive, 0);
92f5daff 646 return ide_stopped;
1da177e4 647 }
8004a8c9 648 debug_log(DBG_SENSE, "Retry #%d, cmd = %02X\n", pc->retries, pc->c[0]);
1da177e4
LT
649
650 pc->retries++;
1da177e4 651
b788ee9c 652 return ide_issue_pc(drive, cmd);
1da177e4
LT
653}
654
3c98bf34 655/* A mode sense command is used to "sense" tape parameters. */
d236d74c 656static void idetape_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
1da177e4 657{
7bf7420a 658 ide_init_pc(pc);
90699ce2 659 pc->c[0] = MODE_SENSE;
1da177e4 660 if (page_code != IDETAPE_BLOCK_DESCRIPTOR)
3c98bf34
BP
661 /* DBD = 1 - Don't return block descriptors */
662 pc->c[1] = 8;
1da177e4
LT
663 pc->c[2] = page_code;
664 /*
665 * Changed pc->c[3] to 0 (255 will at best return unused info).
666 *
667 * For SCSI this byte is defined as subpage instead of high byte
668 * of length and some IDE drives seem to interpret it this way
669 * and return an error when 255 is used.
670 */
671 pc->c[3] = 0;
3c98bf34
BP
672 /* We will just discard data in that case */
673 pc->c[4] = 255;
1da177e4 674 if (page_code == IDETAPE_BLOCK_DESCRIPTOR)
d236d74c 675 pc->req_xfer = 12;
1da177e4 676 else if (page_code == IDETAPE_CAPABILITIES_PAGE)
d236d74c 677 pc->req_xfer = 24;
1da177e4 678 else
d236d74c 679 pc->req_xfer = 50;
1da177e4
LT
680}
681
5a04cfa9 682static ide_startstop_t idetape_media_access_finished(ide_drive_t *drive)
1da177e4 683{
b73c7ee2 684 ide_hwif_t *hwif = drive->hwif;
1da177e4 685 idetape_tape_t *tape = drive->driver_data;
2b9efba4 686 struct ide_atapi_pc *pc = drive->pc;
22c525b9 687 u8 stat;
1da177e4 688
374e042c 689 stat = hwif->tp_ops->read_status(hwif);
c47137a9 690
3a7d2484
BZ
691 if (stat & ATA_DSC) {
692 if (stat & ATA_ERR) {
1da177e4 693 /* Error detected */
90699ce2 694 if (pc->c[0] != TEST_UNIT_READY)
1da177e4
LT
695 printk(KERN_ERR "ide-tape: %s: I/O error, ",
696 tape->name);
697 /* Retry operation */
6b0da28b 698 ide_retry_pc(drive, tape->disk);
258ec411 699 return ide_stopped;
1da177e4
LT
700 }
701 pc->error = 0;
1da177e4 702 } else {
c152cc1a 703 pc->error = IDE_DRV_ERROR_GENERAL;
5e2040fd 704 drive->failed_pc = NULL;
1da177e4 705 }
b14c7212 706 drive->pc_callback(drive, 0);
1da177e4
LT
707 return ide_stopped;
708}
709
cd2abbfe 710static void ide_tape_create_rw_cmd(idetape_tape_t *tape,
0014c75b
BP
711 struct ide_atapi_pc *pc, struct request *rq,
712 u8 opcode)
1da177e4 713{
0014c75b
BP
714 struct idetape_bh *bh = (struct idetape_bh *)rq->special;
715 unsigned int length = rq->current_nr_sectors;
716
7bf7420a 717 ide_init_pc(pc);
860ff5ec 718 put_unaligned(cpu_to_be32(length), (unsigned int *) &pc->c[1]);
1da177e4 719 pc->c[1] = 1;
1da177e4 720 pc->bh = bh;
d236d74c
BP
721 pc->buf = NULL;
722 pc->buf_size = length * tape->blk_size;
723 pc->req_xfer = pc->buf_size;
f73850a3 724 if (pc->req_xfer == tape->buffer_size)
5e331095 725 pc->flags |= PC_FLAG_DMA_OK;
1da177e4 726
cd2abbfe
BP
727 if (opcode == READ_6) {
728 pc->c[0] = READ_6;
729 atomic_set(&bh->b_count, 0);
730 } else if (opcode == WRITE_6) {
731 pc->c[0] = WRITE_6;
732 pc->flags |= PC_FLAG_WRITING;
733 pc->b_data = bh->b_data;
734 pc->b_count = atomic_read(&bh->b_count);
735 }
0014c75b
BP
736
737 memcpy(rq->cmd, pc->c, 12);
1da177e4
LT
738}
739
1da177e4
LT
740static ide_startstop_t idetape_do_request(ide_drive_t *drive,
741 struct request *rq, sector_t block)
742{
b73c7ee2 743 ide_hwif_t *hwif = drive->hwif;
1da177e4 744 idetape_tape_t *tape = drive->driver_data;
d236d74c 745 struct ide_atapi_pc *pc = NULL;
1da177e4 746 struct request *postponed_rq = tape->postponed_rq;
b788ee9c 747 struct ide_cmd cmd;
22c525b9 748 u8 stat;
1da177e4 749
730616b2
MW
750 debug_log(DBG_SENSE, "sector: %llu, nr_sectors: %lu,"
751 " current_nr_sectors: %u\n",
752 (unsigned long long)rq->sector, rq->nr_sectors,
753 rq->current_nr_sectors);
1da177e4 754
4aff5e23 755 if (!blk_special_request(rq)) {
3c98bf34 756 /* We do not support buffer cache originated requests. */
1da177e4 757 printk(KERN_NOTICE "ide-tape: %s: Unsupported request in "
4aff5e23 758 "request queue (%d)\n", drive->name, rq->cmd_type);
89f78b32
BZ
759 if (blk_fs_request(rq) == 0 && rq->errors == 0)
760 rq->errors = -EIO;
130e8867 761 ide_complete_rq(drive, -EIO, ide_rq_bytes(rq));
1da177e4
LT
762 return ide_stopped;
763 }
764
3c98bf34 765 /* Retry a failed packet command */
5e2040fd
BZ
766 if (drive->failed_pc && drive->pc->c[0] == REQUEST_SENSE) {
767 pc = drive->failed_pc;
28c7214b
BZ
768 goto out;
769 }
5a04cfa9 770
1da177e4
LT
771 if (postponed_rq != NULL)
772 if (rq != postponed_rq) {
773 printk(KERN_ERR "ide-tape: ide-tape.c bug - "
774 "Two DSC requests were queued\n");
313afea7 775 drive->failed_pc = NULL;
6902a533 776 rq->errors = 0;
f974b196 777 ide_complete_rq(drive, 0, blk_rq_bytes(rq));
1da177e4
LT
778 return ide_stopped;
779 }
1da177e4
LT
780
781 tape->postponed_rq = NULL;
782
783 /*
784 * If the tape is still busy, postpone our request and service
785 * the other device meanwhile.
786 */
374e042c 787 stat = hwif->tp_ops->read_status(hwif);
1da177e4 788
97100fc8
BZ
789 if ((drive->dev_flags & IDE_DFLAG_DSC_OVERLAP) == 0 &&
790 (rq->cmd[13] & REQ_IDETAPE_PC2) == 0)
f2e3ab52 791 set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
1da177e4 792
97100fc8 793 if (drive->dev_flags & IDE_DFLAG_POST_RESET) {
f2e3ab52 794 set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
97100fc8 795 drive->dev_flags &= ~IDE_DFLAG_POST_RESET;
1da177e4
LT
796 }
797
f2e3ab52 798 if (!test_and_clear_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags) &&
3a7d2484 799 (stat & ATA_DSC) == 0) {
1da177e4
LT
800 if (postponed_rq == NULL) {
801 tape->dsc_polling_start = jiffies;
54bb2074 802 tape->dsc_poll_freq = tape->best_dsc_rw_freq;
1da177e4
LT
803 tape->dsc_timeout = jiffies + IDETAPE_DSC_RW_TIMEOUT;
804 } else if (time_after(jiffies, tape->dsc_timeout)) {
805 printk(KERN_ERR "ide-tape: %s: DSC timeout\n",
806 tape->name);
83dd5735 807 if (rq->cmd[13] & REQ_IDETAPE_PC2) {
1da177e4
LT
808 idetape_media_access_finished(drive);
809 return ide_stopped;
810 } else {
811 return ide_do_reset(drive);
812 }
5a04cfa9
BP
813 } else if (time_after(jiffies,
814 tape->dsc_polling_start +
815 IDETAPE_DSC_MA_THRESHOLD))
54bb2074 816 tape->dsc_poll_freq = IDETAPE_DSC_MA_SLOW;
1da177e4
LT
817 idetape_postpone_request(drive);
818 return ide_stopped;
819 }
83dd5735 820 if (rq->cmd[13] & REQ_IDETAPE_READ) {
2e8a6f89 821 pc = &tape->queued_pc;
0014c75b 822 ide_tape_create_rw_cmd(tape, pc, rq, READ_6);
1da177e4
LT
823 goto out;
824 }
83dd5735 825 if (rq->cmd[13] & REQ_IDETAPE_WRITE) {
2e8a6f89 826 pc = &tape->queued_pc;
0014c75b 827 ide_tape_create_rw_cmd(tape, pc, rq, WRITE_6);
1da177e4
LT
828 goto out;
829 }
83dd5735 830 if (rq->cmd[13] & REQ_IDETAPE_PC1) {
c267cc1c 831 pc = (struct ide_atapi_pc *)rq->special;
83dd5735
BP
832 rq->cmd[13] &= ~(REQ_IDETAPE_PC1);
833 rq->cmd[13] |= REQ_IDETAPE_PC2;
1da177e4
LT
834 goto out;
835 }
83dd5735 836 if (rq->cmd[13] & REQ_IDETAPE_PC2) {
1da177e4
LT
837 idetape_media_access_finished(drive);
838 return ide_stopped;
839 }
840 BUG();
28c7214b 841
f2e3ab52 842out:
b788ee9c
BZ
843 memset(&cmd, 0, sizeof(cmd));
844
845 if (rq_data_dir(rq))
846 cmd.tf_flags |= IDE_TFLAG_WRITE;
847
848 cmd.rq = rq;
849
850 return ide_tape_issue_pc(drive, &cmd, pc);
1da177e4
LT
851}
852
1da177e4 853/*
41aa1706 854 * The function below uses __get_free_pages to allocate a data buffer of size
f73850a3 855 * tape->buffer_size (or a bit more). We attempt to combine sequential pages as
3c98bf34 856 * much as possible.
1da177e4 857 *
41aa1706
BP
858 * It returns a pointer to the newly allocated buffer, or NULL in case of
859 * failure.
1da177e4 860 */
077e3bdb
BP
861static struct idetape_bh *ide_tape_kmalloc_buffer(idetape_tape_t *tape,
862 int full, int clear)
1da177e4 863{
077e3bdb 864 struct idetape_bh *prev_bh, *bh, *merge_bh;
a997a435 865 int pages = tape->pages_per_buffer;
41aa1706 866 unsigned int order, b_allocd;
1da177e4
LT
867 char *b_data = NULL;
868
077e3bdb
BP
869 merge_bh = kmalloc(sizeof(struct idetape_bh), GFP_KERNEL);
870 bh = merge_bh;
1da177e4
LT
871 if (bh == NULL)
872 goto abort;
41aa1706
BP
873
874 order = fls(pages) - 1;
875 bh->b_data = (char *) __get_free_pages(GFP_KERNEL, order);
5a04cfa9 876 if (!bh->b_data)
1da177e4 877 goto abort;
41aa1706
BP
878 b_allocd = (1 << order) * PAGE_SIZE;
879 pages &= (order-1);
880
1da177e4 881 if (clear)
41aa1706
BP
882 memset(bh->b_data, 0, b_allocd);
883 bh->b_reqnext = NULL;
884 bh->b_size = b_allocd;
1da177e4
LT
885 atomic_set(&bh->b_count, full ? bh->b_size : 0);
886
41aa1706
BP
887 while (pages) {
888 order = fls(pages) - 1;
889 b_data = (char *) __get_free_pages(GFP_KERNEL, order);
5a04cfa9 890 if (!b_data)
1da177e4 891 goto abort;
41aa1706
BP
892 b_allocd = (1 << order) * PAGE_SIZE;
893
1da177e4 894 if (clear)
41aa1706
BP
895 memset(b_data, 0, b_allocd);
896
897 /* newly allocated page frames below buffer header or ...*/
898 if (bh->b_data == b_data + b_allocd) {
899 bh->b_size += b_allocd;
900 bh->b_data -= b_allocd;
1da177e4 901 if (full)
41aa1706 902 atomic_add(b_allocd, &bh->b_count);
1da177e4
LT
903 continue;
904 }
41aa1706 905 /* they are above the header */
1da177e4 906 if (b_data == bh->b_data + bh->b_size) {
41aa1706 907 bh->b_size += b_allocd;
1da177e4 908 if (full)
41aa1706 909 atomic_add(b_allocd, &bh->b_count);
1da177e4
LT
910 continue;
911 }
912 prev_bh = bh;
5a04cfa9
BP
913 bh = kmalloc(sizeof(struct idetape_bh), GFP_KERNEL);
914 if (!bh) {
41aa1706 915 free_pages((unsigned long) b_data, order);
1da177e4
LT
916 goto abort;
917 }
918 bh->b_reqnext = NULL;
919 bh->b_data = b_data;
41aa1706 920 bh->b_size = b_allocd;
1da177e4
LT
921 atomic_set(&bh->b_count, full ? bh->b_size : 0);
922 prev_bh->b_reqnext = bh;
41aa1706
BP
923
924 pages &= (order-1);
1da177e4 925 }
41aa1706 926
1da177e4
LT
927 bh->b_size -= tape->excess_bh_size;
928 if (full)
929 atomic_sub(tape->excess_bh_size, &bh->b_count);
077e3bdb 930 return merge_bh;
1da177e4 931abort:
077e3bdb 932 ide_tape_kfree_buffer(tape);
1da177e4
LT
933 return NULL;
934}
935
5a04cfa9 936static int idetape_copy_stage_from_user(idetape_tape_t *tape,
8646c88f 937 const char __user *buf, int n)
1da177e4
LT
938{
939 struct idetape_bh *bh = tape->bh;
940 int count;
dcd96379 941 int ret = 0;
1da177e4
LT
942
943 while (n) {
1da177e4 944 if (bh == NULL) {
5a04cfa9
BP
945 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
946 __func__);
dcd96379 947 return 1;
1da177e4 948 }
5a04cfa9
BP
949 count = min((unsigned int)
950 (bh->b_size - atomic_read(&bh->b_count)),
951 (unsigned int)n);
952 if (copy_from_user(bh->b_data + atomic_read(&bh->b_count), buf,
953 count))
dcd96379 954 ret = 1;
1da177e4
LT
955 n -= count;
956 atomic_add(count, &bh->b_count);
957 buf += count;
958 if (atomic_read(&bh->b_count) == bh->b_size) {
959 bh = bh->b_reqnext;
960 if (bh)
961 atomic_set(&bh->b_count, 0);
962 }
963 }
964 tape->bh = bh;
dcd96379 965 return ret;
1da177e4
LT
966}
967
5a04cfa9 968static int idetape_copy_stage_to_user(idetape_tape_t *tape, char __user *buf,
99d74e61 969 int n)
1da177e4
LT
970{
971 struct idetape_bh *bh = tape->bh;
972 int count;
dcd96379 973 int ret = 0;
1da177e4
LT
974
975 while (n) {
1da177e4 976 if (bh == NULL) {
5a04cfa9
BP
977 printk(KERN_ERR "ide-tape: bh == NULL in %s\n",
978 __func__);
dcd96379 979 return 1;
1da177e4 980 }
1da177e4 981 count = min(tape->b_count, n);
dcd96379
DW
982 if (copy_to_user(buf, tape->b_data, count))
983 ret = 1;
1da177e4
LT
984 n -= count;
985 tape->b_data += count;
986 tape->b_count -= count;
987 buf += count;
988 if (!tape->b_count) {
5a04cfa9
BP
989 bh = bh->b_reqnext;
990 tape->bh = bh;
1da177e4
LT
991 if (bh) {
992 tape->b_data = bh->b_data;
993 tape->b_count = atomic_read(&bh->b_count);
994 }
995 }
996 }
dcd96379 997 return ret;
1da177e4
LT
998}
999
077e3bdb 1000static void idetape_init_merge_buffer(idetape_tape_t *tape)
1da177e4 1001{
077e3bdb
BP
1002 struct idetape_bh *bh = tape->merge_bh;
1003 tape->bh = tape->merge_bh;
5a04cfa9 1004
54abf37e 1005 if (tape->chrdev_dir == IDETAPE_DIR_WRITE)
1da177e4
LT
1006 atomic_set(&bh->b_count, 0);
1007 else {
1008 tape->b_data = bh->b_data;
1009 tape->b_count = atomic_read(&bh->b_count);
1010 }
1011}
1012
1da177e4 1013/*
3c98bf34
BP
1014 * Write a filemark if write_filemark=1. Flush the device buffers without
1015 * writing a filemark otherwise.
1da177e4 1016 */
5a04cfa9 1017static void idetape_create_write_filemark_cmd(ide_drive_t *drive,
d236d74c 1018 struct ide_atapi_pc *pc, int write_filemark)
1da177e4 1019{
7bf7420a 1020 ide_init_pc(pc);
90699ce2 1021 pc->c[0] = WRITE_FILEMARKS;
1da177e4 1022 pc->c[4] = write_filemark;
346331f8 1023 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1da177e4
LT
1024}
1025
1da177e4
LT
1026static int idetape_wait_ready(ide_drive_t *drive, unsigned long timeout)
1027{
1028 idetape_tape_t *tape = drive->driver_data;
2ac07d92 1029 struct gendisk *disk = tape->disk;
1da177e4
LT
1030 int load_attempted = 0;
1031
3c98bf34 1032 /* Wait for the tape to become ready */
f2e3ab52 1033 set_bit(IDE_AFLAG_MEDIUM_PRESENT, &drive->atapi_flags);
1da177e4
LT
1034 timeout += jiffies;
1035 while (time_before(jiffies, timeout)) {
de699ad5 1036 if (ide_do_test_unit_ready(drive, disk) == 0)
1da177e4
LT
1037 return 0;
1038 if ((tape->sense_key == 2 && tape->asc == 4 && tape->ascq == 2)
3c98bf34
BP
1039 || (tape->asc == 0x3A)) {
1040 /* no media */
1da177e4
LT
1041 if (load_attempted)
1042 return -ENOMEDIUM;
0c8a6c7a 1043 ide_do_start_stop(drive, disk, IDETAPE_LU_LOAD_MASK);
1da177e4
LT
1044 load_attempted = 1;
1045 /* not about to be ready */
1046 } else if (!(tape->sense_key == 2 && tape->asc == 4 &&
1047 (tape->ascq == 1 || tape->ascq == 8)))
1048 return -EIO;
80ce45fd 1049 msleep(100);
1da177e4
LT
1050 }
1051 return -EIO;
1052}
1053
5a04cfa9 1054static int idetape_flush_tape_buffers(ide_drive_t *drive)
1da177e4 1055{
2ac07d92 1056 struct ide_tape_obj *tape = drive->driver_data;
d236d74c 1057 struct ide_atapi_pc pc;
1da177e4
LT
1058 int rc;
1059
1060 idetape_create_write_filemark_cmd(drive, &pc, 0);
2ac07d92 1061 rc = ide_queue_pc_tail(drive, tape->disk, &pc);
5a04cfa9 1062 if (rc)
1da177e4
LT
1063 return rc;
1064 idetape_wait_ready(drive, 60 * 5 * HZ);
1065 return 0;
1066}
1067
d236d74c 1068static void idetape_create_read_position_cmd(struct ide_atapi_pc *pc)
1da177e4 1069{
7bf7420a 1070 ide_init_pc(pc);
90699ce2 1071 pc->c[0] = READ_POSITION;
d236d74c 1072 pc->req_xfer = 20;
1da177e4
LT
1073}
1074
5a04cfa9 1075static int idetape_read_position(ide_drive_t *drive)
1da177e4
LT
1076{
1077 idetape_tape_t *tape = drive->driver_data;
d236d74c 1078 struct ide_atapi_pc pc;
1da177e4
LT
1079 int position;
1080
8004a8c9 1081 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1da177e4
LT
1082
1083 idetape_create_read_position_cmd(&pc);
2ac07d92 1084 if (ide_queue_pc_tail(drive, tape->disk, &pc))
1da177e4 1085 return -1;
54bb2074 1086 position = tape->first_frame;
1da177e4
LT
1087 return position;
1088}
1089
d236d74c
BP
1090static void idetape_create_locate_cmd(ide_drive_t *drive,
1091 struct ide_atapi_pc *pc,
5a04cfa9 1092 unsigned int block, u8 partition, int skip)
1da177e4 1093{
7bf7420a 1094 ide_init_pc(pc);
90699ce2 1095 pc->c[0] = POSITION_TO_ELEMENT;
1da177e4 1096 pc->c[1] = 2;
860ff5ec 1097 put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[3]);
1da177e4 1098 pc->c[8] = partition;
346331f8 1099 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1da177e4
LT
1100}
1101
ec0fdb01 1102static void __ide_tape_discard_merge_buffer(ide_drive_t *drive)
1da177e4
LT
1103{
1104 idetape_tape_t *tape = drive->driver_data;
1da177e4 1105
54abf37e 1106 if (tape->chrdev_dir != IDETAPE_DIR_READ)
9798630a 1107 return;
1da177e4 1108
f2e3ab52 1109 clear_bit(IDE_AFLAG_FILEMARK, &drive->atapi_flags);
01a63aeb 1110 tape->merge_bh_size = 0;
077e3bdb
BP
1111 if (tape->merge_bh != NULL) {
1112 ide_tape_kfree_buffer(tape);
1113 tape->merge_bh = NULL;
1da177e4
LT
1114 }
1115
54abf37e 1116 tape->chrdev_dir = IDETAPE_DIR_NONE;
1da177e4
LT
1117}
1118
1119/*
3c98bf34
BP
1120 * Position the tape to the requested block using the LOCATE packet command.
1121 * A READ POSITION command is then issued to check where we are positioned. Like
1122 * all higher level operations, we queue the commands at the tail of the request
1123 * queue and wait for their completion.
1da177e4 1124 */
5a04cfa9
BP
1125static int idetape_position_tape(ide_drive_t *drive, unsigned int block,
1126 u8 partition, int skip)
1da177e4
LT
1127{
1128 idetape_tape_t *tape = drive->driver_data;
2ac07d92 1129 struct gendisk *disk = tape->disk;
1da177e4 1130 int retval;
d236d74c 1131 struct ide_atapi_pc pc;
1da177e4 1132
54abf37e 1133 if (tape->chrdev_dir == IDETAPE_DIR_READ)
ec0fdb01 1134 __ide_tape_discard_merge_buffer(drive);
1da177e4
LT
1135 idetape_wait_ready(drive, 60 * 5 * HZ);
1136 idetape_create_locate_cmd(drive, &pc, block, partition, skip);
2ac07d92 1137 retval = ide_queue_pc_tail(drive, disk, &pc);
1da177e4
LT
1138 if (retval)
1139 return (retval);
1140
1141 idetape_create_read_position_cmd(&pc);
2ac07d92 1142 return ide_queue_pc_tail(drive, disk, &pc);
1da177e4
LT
1143}
1144
ec0fdb01 1145static void ide_tape_discard_merge_buffer(ide_drive_t *drive,
5a04cfa9 1146 int restore_position)
1da177e4
LT
1147{
1148 idetape_tape_t *tape = drive->driver_data;
1da177e4
LT
1149 int seek, position;
1150
ec0fdb01 1151 __ide_tape_discard_merge_buffer(drive);
1da177e4
LT
1152 if (restore_position) {
1153 position = idetape_read_position(drive);
9798630a 1154 seek = position > 0 ? position : 0;
1da177e4 1155 if (idetape_position_tape(drive, seek, 0, 0)) {
5a04cfa9 1156 printk(KERN_INFO "ide-tape: %s: position_tape failed in"
ec0fdb01 1157 " %s\n", tape->name, __func__);
1da177e4
LT
1158 return;
1159 }
1160 }
1161}
1162
1163/*
3c98bf34
BP
1164 * Generate a read/write request for the block device interface and wait for it
1165 * to be serviced.
1da177e4 1166 */
5a04cfa9
BP
1167static int idetape_queue_rw_tail(ide_drive_t *drive, int cmd, int blocks,
1168 struct idetape_bh *bh)
1da177e4
LT
1169{
1170 idetape_tape_t *tape = drive->driver_data;
64ea1b4a
FT
1171 struct request *rq;
1172 int ret, errors;
1da177e4 1173
8004a8c9
BP
1174 debug_log(DBG_SENSE, "%s: cmd=%d\n", __func__, cmd);
1175
64ea1b4a
FT
1176 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
1177 rq->cmd_type = REQ_TYPE_SPECIAL;
83dd5735 1178 rq->cmd[13] = cmd;
64ea1b4a
FT
1179 rq->rq_disk = tape->disk;
1180 rq->special = (void *)bh;
1181 rq->sector = tape->first_frame;
1182 rq->nr_sectors = blocks;
1183 rq->current_nr_sectors = blocks;
1184 blk_execute_rq(drive->queue, tape->disk, rq, 0);
1185
1186 errors = rq->errors;
1187 ret = tape->blk_size * (blocks - rq->current_nr_sectors);
1188 blk_put_request(rq);
1da177e4
LT
1189
1190 if ((cmd & (REQ_IDETAPE_READ | REQ_IDETAPE_WRITE)) == 0)
1191 return 0;
1192
077e3bdb
BP
1193 if (tape->merge_bh)
1194 idetape_init_merge_buffer(tape);
c152cc1a 1195 if (errors == IDE_DRV_ERROR_GENERAL)
1da177e4 1196 return -EIO;
64ea1b4a 1197 return ret;
1da177e4
LT
1198}
1199
d236d74c 1200static void idetape_create_inquiry_cmd(struct ide_atapi_pc *pc)
1da177e4 1201{
7bf7420a 1202 ide_init_pc(pc);
90699ce2 1203 pc->c[0] = INQUIRY;
5a04cfa9 1204 pc->c[4] = 254;
d236d74c 1205 pc->req_xfer = 254;
1da177e4
LT
1206}
1207
d236d74c
BP
1208static void idetape_create_rewind_cmd(ide_drive_t *drive,
1209 struct ide_atapi_pc *pc)
1da177e4 1210{
7bf7420a 1211 ide_init_pc(pc);
90699ce2 1212 pc->c[0] = REZERO_UNIT;
346331f8 1213 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1da177e4
LT
1214}
1215
d236d74c 1216static void idetape_create_erase_cmd(struct ide_atapi_pc *pc)
1da177e4 1217{
7bf7420a 1218 ide_init_pc(pc);
90699ce2 1219 pc->c[0] = ERASE;
1da177e4 1220 pc->c[1] = 1;
346331f8 1221 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1da177e4
LT
1222}
1223
d236d74c 1224static void idetape_create_space_cmd(struct ide_atapi_pc *pc, int count, u8 cmd)
1da177e4 1225{
7bf7420a 1226 ide_init_pc(pc);
90699ce2 1227 pc->c[0] = SPACE;
860ff5ec 1228 put_unaligned(cpu_to_be32(count), (unsigned int *) &pc->c[1]);
1da177e4 1229 pc->c[1] = cmd;
346331f8 1230 pc->flags |= PC_FLAG_WAIT_FOR_DSC;
1da177e4
LT
1231}
1232
97c566ce 1233/* Queue up a character device originated write request. */
5a04cfa9 1234static int idetape_add_chrdev_write_request(ide_drive_t *drive, int blocks)
1da177e4
LT
1235{
1236 idetape_tape_t *tape = drive->driver_data;
1da177e4 1237
8004a8c9 1238 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
1da177e4 1239
0aa4b01e 1240 return idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE,
077e3bdb 1241 blocks, tape->merge_bh);
1da177e4
LT
1242}
1243
d9df937a 1244static void ide_tape_flush_merge_buffer(ide_drive_t *drive)
1da177e4
LT
1245{
1246 idetape_tape_t *tape = drive->driver_data;
1247 int blocks, min;
1248 struct idetape_bh *bh;
55a5d291 1249
54abf37e 1250 if (tape->chrdev_dir != IDETAPE_DIR_WRITE) {
077e3bdb 1251 printk(KERN_ERR "ide-tape: bug: Trying to empty merge buffer"
5a04cfa9 1252 " but we are not writing.\n");
1da177e4
LT
1253 return;
1254 }
01a63aeb 1255 if (tape->merge_bh_size > tape->buffer_size) {
1da177e4 1256 printk(KERN_ERR "ide-tape: bug: merge_buffer too big\n");
01a63aeb 1257 tape->merge_bh_size = tape->buffer_size;
1da177e4 1258 }
01a63aeb
BP
1259 if (tape->merge_bh_size) {
1260 blocks = tape->merge_bh_size / tape->blk_size;
1261 if (tape->merge_bh_size % tape->blk_size) {
1da177e4
LT
1262 unsigned int i;
1263
1264 blocks++;
01a63aeb 1265 i = tape->blk_size - tape->merge_bh_size %
54bb2074 1266 tape->blk_size;
1da177e4
LT
1267 bh = tape->bh->b_reqnext;
1268 while (bh) {
1269 atomic_set(&bh->b_count, 0);
1270 bh = bh->b_reqnext;
1271 }
1272 bh = tape->bh;
1273 while (i) {
1274 if (bh == NULL) {
5a04cfa9
BP
1275 printk(KERN_INFO "ide-tape: bug,"
1276 " bh NULL\n");
1da177e4
LT
1277 break;
1278 }
5a04cfa9
BP
1279 min = min(i, (unsigned int)(bh->b_size -
1280 atomic_read(&bh->b_count)));
1281 memset(bh->b_data + atomic_read(&bh->b_count),
1282 0, min);
1da177e4
LT
1283 atomic_add(min, &bh->b_count);
1284 i -= min;
1285 bh = bh->b_reqnext;
1286 }
1287 }
1288 (void) idetape_add_chrdev_write_request(drive, blocks);
01a63aeb 1289 tape->merge_bh_size = 0;
1da177e4 1290 }
077e3bdb
BP
1291 if (tape->merge_bh != NULL) {
1292 ide_tape_kfree_buffer(tape);
1293 tape->merge_bh = NULL;
1da177e4 1294 }
54abf37e 1295 tape->chrdev_dir = IDETAPE_DIR_NONE;
1da177e4
LT
1296}
1297
83042b24 1298static int idetape_init_read(ide_drive_t *drive)
1da177e4
LT
1299{
1300 idetape_tape_t *tape = drive->driver_data;
1da177e4 1301 int bytes_read;
1da177e4
LT
1302
1303 /* Initialize read operation */
54abf37e
BP
1304 if (tape->chrdev_dir != IDETAPE_DIR_READ) {
1305 if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
d9df937a 1306 ide_tape_flush_merge_buffer(drive);
1da177e4
LT
1307 idetape_flush_tape_buffers(drive);
1308 }
077e3bdb 1309 if (tape->merge_bh || tape->merge_bh_size) {
01a63aeb 1310 printk(KERN_ERR "ide-tape: merge_bh_size should be"
5a04cfa9 1311 " 0 now\n");
01a63aeb 1312 tape->merge_bh_size = 0;
1da177e4 1313 }
077e3bdb
BP
1314 tape->merge_bh = ide_tape_kmalloc_buffer(tape, 0, 0);
1315 if (!tape->merge_bh)
1da177e4 1316 return -ENOMEM;
54abf37e 1317 tape->chrdev_dir = IDETAPE_DIR_READ;
1da177e4
LT
1318
1319 /*
3c98bf34
BP
1320 * Issue a read 0 command to ensure that DSC handshake is
1321 * switched from completion mode to buffer available mode.
1322 * No point in issuing this if DSC overlap isn't supported, some
1323 * drives (Seagate STT3401A) will return an error.
1da177e4 1324 */
97100fc8 1325 if (drive->dev_flags & IDE_DFLAG_DSC_OVERLAP) {
5a04cfa9
BP
1326 bytes_read = idetape_queue_rw_tail(drive,
1327 REQ_IDETAPE_READ, 0,
077e3bdb 1328 tape->merge_bh);
1da177e4 1329 if (bytes_read < 0) {
077e3bdb
BP
1330 ide_tape_kfree_buffer(tape);
1331 tape->merge_bh = NULL;
54abf37e 1332 tape->chrdev_dir = IDETAPE_DIR_NONE;
1da177e4
LT
1333 return bytes_read;
1334 }
1335 }
1336 }
5e69bd95 1337
1da177e4
LT
1338 return 0;
1339}
1340
5bd50dc6 1341/* called from idetape_chrdev_read() to service a chrdev read request. */
5a04cfa9 1342static int idetape_add_chrdev_read_request(ide_drive_t *drive, int blocks)
1da177e4
LT
1343{
1344 idetape_tape_t *tape = drive->driver_data;
1da177e4 1345
8004a8c9 1346 debug_log(DBG_PROCS, "Enter %s, %d blocks\n", __func__, blocks);
1da177e4 1347
3c98bf34 1348 /* If we are at a filemark, return a read length of 0 */
f2e3ab52 1349 if (test_bit(IDE_AFLAG_FILEMARK, &drive->atapi_flags))
1da177e4
LT
1350 return 0;
1351
83042b24 1352 idetape_init_read(drive);
5e69bd95 1353
5e69bd95 1354 return idetape_queue_rw_tail(drive, REQ_IDETAPE_READ, blocks,
077e3bdb 1355 tape->merge_bh);
1da177e4
LT
1356}
1357
5a04cfa9 1358static void idetape_pad_zeros(ide_drive_t *drive, int bcount)
1da177e4
LT
1359{
1360 idetape_tape_t *tape = drive->driver_data;
1361 struct idetape_bh *bh;
1362 int blocks;
3c98bf34 1363
1da177e4
LT
1364 while (bcount) {
1365 unsigned int count;
1366
077e3bdb 1367 bh = tape->merge_bh;
f73850a3 1368 count = min(tape->buffer_size, bcount);
1da177e4 1369 bcount -= count;
54bb2074 1370 blocks = count / tape->blk_size;
1da177e4 1371 while (count) {
5a04cfa9
BP
1372 atomic_set(&bh->b_count,
1373 min(count, (unsigned int)bh->b_size));
1da177e4
LT
1374 memset(bh->b_data, 0, atomic_read(&bh->b_count));
1375 count -= atomic_read(&bh->b_count);
1376 bh = bh->b_reqnext;
1377 }
5a04cfa9 1378 idetape_queue_rw_tail(drive, REQ_IDETAPE_WRITE, blocks,
077e3bdb 1379 tape->merge_bh);
1da177e4
LT
1380 }
1381}
1382
1da177e4 1383/*
3c98bf34
BP
1384 * Rewinds the tape to the Beginning Of the current Partition (BOP). We
1385 * currently support only one partition.
1386 */
5a04cfa9 1387static int idetape_rewind_tape(ide_drive_t *drive)
1da177e4 1388{
2ac07d92
BZ
1389 struct ide_tape_obj *tape = drive->driver_data;
1390 struct gendisk *disk = tape->disk;
1da177e4 1391 int retval;
d236d74c 1392 struct ide_atapi_pc pc;
8004a8c9
BP
1393
1394 debug_log(DBG_SENSE, "Enter %s\n", __func__);
1395
1da177e4 1396 idetape_create_rewind_cmd(drive, &pc);
2ac07d92 1397 retval = ide_queue_pc_tail(drive, disk, &pc);
1da177e4
LT
1398 if (retval)
1399 return retval;
1400
1401 idetape_create_read_position_cmd(&pc);
2ac07d92 1402 retval = ide_queue_pc_tail(drive, disk, &pc);
1da177e4
LT
1403 if (retval)
1404 return retval;
1405 return 0;
1406}
1407
3c98bf34 1408/* mtio.h compatible commands should be issued to the chrdev interface. */
5a04cfa9
BP
1409static int idetape_blkdev_ioctl(ide_drive_t *drive, unsigned int cmd,
1410 unsigned long arg)
1da177e4
LT
1411{
1412 idetape_tape_t *tape = drive->driver_data;
1da177e4
LT
1413 void __user *argp = (void __user *)arg;
1414
d59823fa
BP
1415 struct idetape_config {
1416 int dsc_rw_frequency;
1417 int dsc_media_access_frequency;
1418 int nr_stages;
1419 } config;
1420
8004a8c9
BP
1421 debug_log(DBG_PROCS, "Enter %s\n", __func__);
1422
1da177e4 1423 switch (cmd) {
5a04cfa9
BP
1424 case 0x0340:
1425 if (copy_from_user(&config, argp, sizeof(config)))
1426 return -EFAULT;
1427 tape->best_dsc_rw_freq = config.dsc_rw_frequency;
5a04cfa9
BP
1428 break;
1429 case 0x0350:
1430 config.dsc_rw_frequency = (int) tape->best_dsc_rw_freq;
83042b24 1431 config.nr_stages = 1;
5a04cfa9
BP
1432 if (copy_to_user(argp, &config, sizeof(config)))
1433 return -EFAULT;
1434 break;
1435 default:
1436 return -EIO;
1da177e4
LT
1437 }
1438 return 0;
1439}
1440
5a04cfa9
BP
1441static int idetape_space_over_filemarks(ide_drive_t *drive, short mt_op,
1442 int mt_count)
1da177e4
LT
1443{
1444 idetape_tape_t *tape = drive->driver_data;
2ac07d92 1445 struct gendisk *disk = tape->disk;
d236d74c 1446 struct ide_atapi_pc pc;
5a04cfa9 1447 int retval, count = 0;
b6422013 1448 int sprev = !!(tape->caps[4] & 0x20);
1da177e4
LT
1449
1450 if (mt_count == 0)
1451 return 0;
1452 if (MTBSF == mt_op || MTBSFM == mt_op) {
b6422013 1453 if (!sprev)
1da177e4 1454 return -EIO;
5a04cfa9 1455 mt_count = -mt_count;
1da177e4
LT
1456 }
1457
54abf37e 1458 if (tape->chrdev_dir == IDETAPE_DIR_READ) {
01a63aeb 1459 tape->merge_bh_size = 0;
f2e3ab52 1460 if (test_and_clear_bit(IDE_AFLAG_FILEMARK, &drive->atapi_flags))
1da177e4 1461 ++count;
ec0fdb01 1462 ide_tape_discard_merge_buffer(drive, 0);
1da177e4
LT
1463 }
1464
1da177e4 1465 switch (mt_op) {
5a04cfa9
BP
1466 case MTFSF:
1467 case MTBSF:
1468 idetape_create_space_cmd(&pc, mt_count - count,
1469 IDETAPE_SPACE_OVER_FILEMARK);
2ac07d92 1470 return ide_queue_pc_tail(drive, disk, &pc);
5a04cfa9
BP
1471 case MTFSFM:
1472 case MTBSFM:
1473 if (!sprev)
1474 return -EIO;
1475 retval = idetape_space_over_filemarks(drive, MTFSF,
1476 mt_count - count);
1477 if (retval)
1478 return retval;
1479 count = (MTBSFM == mt_op ? 1 : -1);
1480 return idetape_space_over_filemarks(drive, MTFSF, count);
1481 default:
1482 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
1483 mt_op);
1484 return -EIO;
1da177e4
LT
1485 }
1486}
1487
1da177e4 1488/*
3c98bf34 1489 * Our character device read / write functions.
1da177e4 1490 *
3c98bf34
BP
1491 * The tape is optimized to maximize throughput when it is transferring an
1492 * integral number of the "continuous transfer limit", which is a parameter of
1493 * the specific tape (26kB on my particular tape, 32kB for Onstream).
1da177e4 1494 *
3c98bf34
BP
1495 * As of version 1.3 of the driver, the character device provides an abstract
1496 * continuous view of the media - any mix of block sizes (even 1 byte) on the
1497 * same backup/restore procedure is supported. The driver will internally
1498 * convert the requests to the recommended transfer unit, so that an unmatch
1499 * between the user's block size to the recommended size will only result in a
1500 * (slightly) increased driver overhead, but will no longer hit performance.
1501 * This is not applicable to Onstream.
1da177e4 1502 */
5a04cfa9
BP
1503static ssize_t idetape_chrdev_read(struct file *file, char __user *buf,
1504 size_t count, loff_t *ppos)
1da177e4 1505{
5aeddf90 1506 struct ide_tape_obj *tape = file->private_data;
1da177e4 1507 ide_drive_t *drive = tape->drive;
5a04cfa9 1508 ssize_t bytes_read, temp, actually_read = 0, rc;
dcd96379 1509 ssize_t ret = 0;
b6422013 1510 u16 ctl = *(u16 *)&tape->caps[12];
1da177e4 1511
8004a8c9 1512 debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
1da177e4 1513
54abf37e 1514 if (tape->chrdev_dir != IDETAPE_DIR_READ) {
f2e3ab52 1515 if (test_bit(IDE_AFLAG_DETECT_BS, &drive->atapi_flags))
54bb2074
BP
1516 if (count > tape->blk_size &&
1517 (count % tape->blk_size) == 0)
1518 tape->user_bs_factor = count / tape->blk_size;
1da177e4 1519 }
83042b24 1520 rc = idetape_init_read(drive);
8d06bfad 1521 if (rc < 0)
1da177e4
LT
1522 return rc;
1523 if (count == 0)
1524 return (0);
01a63aeb
BP
1525 if (tape->merge_bh_size) {
1526 actually_read = min((unsigned int)(tape->merge_bh_size),
5a04cfa9 1527 (unsigned int)count);
99d74e61 1528 if (idetape_copy_stage_to_user(tape, buf, actually_read))
dcd96379 1529 ret = -EFAULT;
1da177e4 1530 buf += actually_read;
01a63aeb 1531 tape->merge_bh_size -= actually_read;
1da177e4
LT
1532 count -= actually_read;
1533 }
f73850a3 1534 while (count >= tape->buffer_size) {
b6422013 1535 bytes_read = idetape_add_chrdev_read_request(drive, ctl);
1da177e4
LT
1536 if (bytes_read <= 0)
1537 goto finish;
99d74e61 1538 if (idetape_copy_stage_to_user(tape, buf, bytes_read))
dcd96379 1539 ret = -EFAULT;
1da177e4
LT
1540 buf += bytes_read;
1541 count -= bytes_read;
1542 actually_read += bytes_read;
1543 }
1544 if (count) {
b6422013 1545 bytes_read = idetape_add_chrdev_read_request(drive, ctl);
1da177e4
LT
1546 if (bytes_read <= 0)
1547 goto finish;
1548 temp = min((unsigned long)count, (unsigned long)bytes_read);
99d74e61 1549 if (idetape_copy_stage_to_user(tape, buf, temp))
dcd96379 1550 ret = -EFAULT;
1da177e4 1551 actually_read += temp;
01a63aeb 1552 tape->merge_bh_size = bytes_read-temp;
1da177e4
LT
1553 }
1554finish:
f2e3ab52 1555 if (!actually_read && test_bit(IDE_AFLAG_FILEMARK, &drive->atapi_flags)) {
8004a8c9
BP
1556 debug_log(DBG_SENSE, "%s: spacing over filemark\n", tape->name);
1557
1da177e4
LT
1558 idetape_space_over_filemarks(drive, MTFSF, 1);
1559 return 0;
1560 }
dcd96379 1561
5a04cfa9 1562 return ret ? ret : actually_read;
1da177e4
LT
1563}
1564
5a04cfa9 1565static ssize_t idetape_chrdev_write(struct file *file, const char __user *buf,
1da177e4
LT
1566 size_t count, loff_t *ppos)
1567{
5aeddf90 1568 struct ide_tape_obj *tape = file->private_data;
1da177e4 1569 ide_drive_t *drive = tape->drive;
dcd96379
DW
1570 ssize_t actually_written = 0;
1571 ssize_t ret = 0;
b6422013 1572 u16 ctl = *(u16 *)&tape->caps[12];
1da177e4
LT
1573
1574 /* The drive is write protected. */
1575 if (tape->write_prot)
1576 return -EACCES;
1577
8004a8c9 1578 debug_log(DBG_CHRDEV, "Enter %s, count %Zd\n", __func__, count);
1da177e4
LT
1579
1580 /* Initialize write operation */
54abf37e
BP
1581 if (tape->chrdev_dir != IDETAPE_DIR_WRITE) {
1582 if (tape->chrdev_dir == IDETAPE_DIR_READ)
ec0fdb01 1583 ide_tape_discard_merge_buffer(drive, 1);
077e3bdb 1584 if (tape->merge_bh || tape->merge_bh_size) {
01a63aeb 1585 printk(KERN_ERR "ide-tape: merge_bh_size "
1da177e4 1586 "should be 0 now\n");
01a63aeb 1587 tape->merge_bh_size = 0;
1da177e4 1588 }
077e3bdb
BP
1589 tape->merge_bh = ide_tape_kmalloc_buffer(tape, 0, 0);
1590 if (!tape->merge_bh)
1da177e4 1591 return -ENOMEM;
54abf37e 1592 tape->chrdev_dir = IDETAPE_DIR_WRITE;
077e3bdb 1593 idetape_init_merge_buffer(tape);
1da177e4
LT
1594
1595 /*
3c98bf34
BP
1596 * Issue a write 0 command to ensure that DSC handshake is
1597 * switched from completion mode to buffer available mode. No
1598 * point in issuing this if DSC overlap isn't supported, some
1599 * drives (Seagate STT3401A) will return an error.
1da177e4 1600 */
97100fc8 1601 if (drive->dev_flags & IDE_DFLAG_DSC_OVERLAP) {
5a04cfa9
BP
1602 ssize_t retval = idetape_queue_rw_tail(drive,
1603 REQ_IDETAPE_WRITE, 0,
077e3bdb 1604 tape->merge_bh);
1da177e4 1605 if (retval < 0) {
077e3bdb
BP
1606 ide_tape_kfree_buffer(tape);
1607 tape->merge_bh = NULL;
54abf37e 1608 tape->chrdev_dir = IDETAPE_DIR_NONE;
1da177e4
LT
1609 return retval;
1610 }
1611 }
1612 }
1613 if (count == 0)
1614 return (0);
01a63aeb
BP
1615 if (tape->merge_bh_size) {
1616 if (tape->merge_bh_size >= tape->buffer_size) {
5a04cfa9 1617 printk(KERN_ERR "ide-tape: bug: merge buf too big\n");
01a63aeb 1618 tape->merge_bh_size = 0;
1da177e4 1619 }
5a04cfa9 1620 actually_written = min((unsigned int)
01a63aeb 1621 (tape->buffer_size - tape->merge_bh_size),
5a04cfa9 1622 (unsigned int)count);
8646c88f 1623 if (idetape_copy_stage_from_user(tape, buf, actually_written))
dcd96379 1624 ret = -EFAULT;
1da177e4 1625 buf += actually_written;
01a63aeb 1626 tape->merge_bh_size += actually_written;
1da177e4
LT
1627 count -= actually_written;
1628
01a63aeb 1629 if (tape->merge_bh_size == tape->buffer_size) {
dcd96379 1630 ssize_t retval;
01a63aeb 1631 tape->merge_bh_size = 0;
b6422013 1632 retval = idetape_add_chrdev_write_request(drive, ctl);
1da177e4
LT
1633 if (retval <= 0)
1634 return (retval);
1635 }
1636 }
f73850a3 1637 while (count >= tape->buffer_size) {
dcd96379 1638 ssize_t retval;
f73850a3 1639 if (idetape_copy_stage_from_user(tape, buf, tape->buffer_size))
dcd96379 1640 ret = -EFAULT;
f73850a3
BP
1641 buf += tape->buffer_size;
1642 count -= tape->buffer_size;
b6422013 1643 retval = idetape_add_chrdev_write_request(drive, ctl);
f73850a3 1644 actually_written += tape->buffer_size;
1da177e4
LT
1645 if (retval <= 0)
1646 return (retval);
1647 }
1648 if (count) {
1649 actually_written += count;
8646c88f 1650 if (idetape_copy_stage_from_user(tape, buf, count))
dcd96379 1651 ret = -EFAULT;
01a63aeb 1652 tape->merge_bh_size += count;
1da177e4 1653 }
5a04cfa9 1654 return ret ? ret : actually_written;
1da177e4
LT
1655}
1656
5a04cfa9 1657static int idetape_write_filemark(ide_drive_t *drive)
1da177e4 1658{
2ac07d92 1659 struct ide_tape_obj *tape = drive->driver_data;
d236d74c 1660 struct ide_atapi_pc pc;
1da177e4
LT
1661
1662 /* Write a filemark */
1663 idetape_create_write_filemark_cmd(drive, &pc, 1);
2ac07d92 1664 if (ide_queue_pc_tail(drive, tape->disk, &pc)) {
1da177e4
LT
1665 printk(KERN_ERR "ide-tape: Couldn't write a filemark\n");
1666 return -EIO;
1667 }
1668 return 0;
1669}
1670
1671/*
d99c9da2
BP
1672 * Called from idetape_chrdev_ioctl when the general mtio MTIOCTOP ioctl is
1673 * requested.
1da177e4 1674 *
d99c9da2
BP
1675 * Note: MTBSF and MTBSFM are not supported when the tape doesn't support
1676 * spacing over filemarks in the reverse direction. In this case, MTFSFM is also
5bd50dc6 1677 * usually not supported.
1da177e4 1678 *
d99c9da2 1679 * The following commands are currently not supported:
1da177e4 1680 *
d99c9da2
BP
1681 * MTFSS, MTBSS, MTWSM, MTSETDENSITY, MTSETDRVBUFFER, MT_ST_BOOLEANS,
1682 * MT_ST_WRITE_THRESHOLD.
1da177e4 1683 */
d99c9da2 1684static int idetape_mtioctop(ide_drive_t *drive, short mt_op, int mt_count)
1da177e4
LT
1685{
1686 idetape_tape_t *tape = drive->driver_data;
2ac07d92 1687 struct gendisk *disk = tape->disk;
d236d74c 1688 struct ide_atapi_pc pc;
5a04cfa9 1689 int i, retval;
1da177e4 1690
8004a8c9
BP
1691 debug_log(DBG_ERR, "Handling MTIOCTOP ioctl: mt_op=%d, mt_count=%d\n",
1692 mt_op, mt_count);
5a04cfa9 1693
1da177e4 1694 switch (mt_op) {
5a04cfa9
BP
1695 case MTFSF:
1696 case MTFSFM:
1697 case MTBSF:
1698 case MTBSFM:
1699 if (!mt_count)
1700 return 0;
1701 return idetape_space_over_filemarks(drive, mt_op, mt_count);
1702 default:
1703 break;
1da177e4 1704 }
5a04cfa9 1705
1da177e4 1706 switch (mt_op) {
5a04cfa9
BP
1707 case MTWEOF:
1708 if (tape->write_prot)
1709 return -EACCES;
ec0fdb01 1710 ide_tape_discard_merge_buffer(drive, 1);
5a04cfa9
BP
1711 for (i = 0; i < mt_count; i++) {
1712 retval = idetape_write_filemark(drive);
1713 if (retval)
1714 return retval;
1715 }
1716 return 0;
1717 case MTREW:
ec0fdb01 1718 ide_tape_discard_merge_buffer(drive, 0);
5a04cfa9
BP
1719 if (idetape_rewind_tape(drive))
1720 return -EIO;
1721 return 0;
1722 case MTLOAD:
ec0fdb01 1723 ide_tape_discard_merge_buffer(drive, 0);
0c8a6c7a 1724 return ide_do_start_stop(drive, disk, IDETAPE_LU_LOAD_MASK);
5a04cfa9
BP
1725 case MTUNLOAD:
1726 case MTOFFL:
1727 /*
1728 * If door is locked, attempt to unlock before
1729 * attempting to eject.
1730 */
1731 if (tape->door_locked) {
0578042d 1732 if (!ide_set_media_lock(drive, disk, 0))
385a4b87 1733 tape->door_locked = DOOR_UNLOCKED;
5a04cfa9 1734 }
ec0fdb01 1735 ide_tape_discard_merge_buffer(drive, 0);
0c8a6c7a 1736 retval = ide_do_start_stop(drive, disk, !IDETAPE_LU_LOAD_MASK);
5a04cfa9 1737 if (!retval)
f2e3ab52 1738 clear_bit(IDE_AFLAG_MEDIUM_PRESENT, &drive->atapi_flags);
5a04cfa9
BP
1739 return retval;
1740 case MTNOP:
ec0fdb01 1741 ide_tape_discard_merge_buffer(drive, 0);
5a04cfa9
BP
1742 return idetape_flush_tape_buffers(drive);
1743 case MTRETEN:
ec0fdb01 1744 ide_tape_discard_merge_buffer(drive, 0);
0c8a6c7a 1745 return ide_do_start_stop(drive, disk,
5a04cfa9 1746 IDETAPE_LU_RETENSION_MASK | IDETAPE_LU_LOAD_MASK);
5a04cfa9
BP
1747 case MTEOM:
1748 idetape_create_space_cmd(&pc, 0, IDETAPE_SPACE_TO_EOD);
2ac07d92 1749 return ide_queue_pc_tail(drive, disk, &pc);
5a04cfa9
BP
1750 case MTERASE:
1751 (void)idetape_rewind_tape(drive);
1752 idetape_create_erase_cmd(&pc);
2ac07d92 1753 return ide_queue_pc_tail(drive, disk, &pc);
5a04cfa9
BP
1754 case MTSETBLK:
1755 if (mt_count) {
1756 if (mt_count < tape->blk_size ||
1757 mt_count % tape->blk_size)
1da177e4 1758 return -EIO;
5a04cfa9 1759 tape->user_bs_factor = mt_count / tape->blk_size;
f2e3ab52 1760 clear_bit(IDE_AFLAG_DETECT_BS, &drive->atapi_flags);
5a04cfa9 1761 } else
f2e3ab52 1762 set_bit(IDE_AFLAG_DETECT_BS, &drive->atapi_flags);
5a04cfa9
BP
1763 return 0;
1764 case MTSEEK:
ec0fdb01 1765 ide_tape_discard_merge_buffer(drive, 0);
5a04cfa9
BP
1766 return idetape_position_tape(drive,
1767 mt_count * tape->user_bs_factor, tape->partition, 0);
1768 case MTSETPART:
ec0fdb01 1769 ide_tape_discard_merge_buffer(drive, 0);
5a04cfa9
BP
1770 return idetape_position_tape(drive, 0, mt_count, 0);
1771 case MTFSR:
1772 case MTBSR:
1773 case MTLOCK:
0578042d 1774 retval = ide_set_media_lock(drive, disk, 1);
5a04cfa9 1775 if (retval)
1da177e4 1776 return retval;
5a04cfa9
BP
1777 tape->door_locked = DOOR_EXPLICITLY_LOCKED;
1778 return 0;
1779 case MTUNLOCK:
0578042d 1780 retval = ide_set_media_lock(drive, disk, 0);
5a04cfa9
BP
1781 if (retval)
1782 return retval;
1783 tape->door_locked = DOOR_UNLOCKED;
1784 return 0;
1785 default:
1786 printk(KERN_ERR "ide-tape: MTIO operation %d not supported\n",
1787 mt_op);
1788 return -EIO;
1da177e4
LT
1789 }
1790}
1791
1792/*
d99c9da2
BP
1793 * Our character device ioctls. General mtio.h magnetic io commands are
1794 * supported here, and not in the corresponding block interface. Our own
1795 * ide-tape ioctls are supported on both interfaces.
1da177e4 1796 */
d99c9da2
BP
1797static int idetape_chrdev_ioctl(struct inode *inode, struct file *file,
1798 unsigned int cmd, unsigned long arg)
1da177e4 1799{
5aeddf90 1800 struct ide_tape_obj *tape = file->private_data;
1da177e4
LT
1801 ide_drive_t *drive = tape->drive;
1802 struct mtop mtop;
1803 struct mtget mtget;
1804 struct mtpos mtpos;
54bb2074 1805 int block_offset = 0, position = tape->first_frame;
1da177e4
LT
1806 void __user *argp = (void __user *)arg;
1807
8004a8c9 1808 debug_log(DBG_CHRDEV, "Enter %s, cmd=%u\n", __func__, cmd);
1da177e4 1809
54abf37e 1810 if (tape->chrdev_dir == IDETAPE_DIR_WRITE) {
d9df937a 1811 ide_tape_flush_merge_buffer(drive);
1da177e4
LT
1812 idetape_flush_tape_buffers(drive);
1813 }
1814 if (cmd == MTIOCGET || cmd == MTIOCPOS) {
01a63aeb 1815 block_offset = tape->merge_bh_size /
54bb2074 1816 (tape->blk_size * tape->user_bs_factor);
5a04cfa9
BP
1817 position = idetape_read_position(drive);
1818 if (position < 0)
1da177e4
LT
1819 return -EIO;
1820 }
1821 switch (cmd) {
5a04cfa9
BP
1822 case MTIOCTOP:
1823 if (copy_from_user(&mtop, argp, sizeof(struct mtop)))
1824 return -EFAULT;
1825 return idetape_mtioctop(drive, mtop.mt_op, mtop.mt_count);
1826 case MTIOCGET:
1827 memset(&mtget, 0, sizeof(struct mtget));
1828 mtget.mt_type = MT_ISSCSI2;
1829 mtget.mt_blkno = position / tape->user_bs_factor - block_offset;
1830 mtget.mt_dsreg =
1831 ((tape->blk_size * tape->user_bs_factor)
1832 << MT_ST_BLKSIZE_SHIFT) & MT_ST_BLKSIZE_MASK;
1833
1834 if (tape->drv_write_prot)
1835 mtget.mt_gstat |= GMT_WR_PROT(0xffffffff);
1836
1837 if (copy_to_user(argp, &mtget, sizeof(struct mtget)))
1838 return -EFAULT;
1839 return 0;
1840 case MTIOCPOS:
1841 mtpos.mt_blkno = position / tape->user_bs_factor - block_offset;
1842 if (copy_to_user(argp, &mtpos, sizeof(struct mtpos)))
1843 return -EFAULT;
1844 return 0;
1845 default:
1846 if (tape->chrdev_dir == IDETAPE_DIR_READ)
ec0fdb01 1847 ide_tape_discard_merge_buffer(drive, 1);
5a04cfa9 1848 return idetape_blkdev_ioctl(drive, cmd, arg);
1da177e4
LT
1849 }
1850}
1851
3cffb9ce
BP
1852/*
1853 * Do a mode sense page 0 with block descriptor and if it succeeds set the tape
1854 * block size with the reported value.
1855 */
1856static void ide_tape_get_bsize_from_bdesc(ide_drive_t *drive)
1857{
1858 idetape_tape_t *tape = drive->driver_data;
d236d74c 1859 struct ide_atapi_pc pc;
3cffb9ce
BP
1860
1861 idetape_create_mode_sense_cmd(&pc, IDETAPE_BLOCK_DESCRIPTOR);
2ac07d92 1862 if (ide_queue_pc_tail(drive, tape->disk, &pc)) {
3cffb9ce 1863 printk(KERN_ERR "ide-tape: Can't get block descriptor\n");
54bb2074 1864 if (tape->blk_size == 0) {
3cffb9ce
BP
1865 printk(KERN_WARNING "ide-tape: Cannot deal with zero "
1866 "block size, assuming 32k\n");
54bb2074 1867 tape->blk_size = 32768;
3cffb9ce
BP
1868 }
1869 return;
1870 }
d236d74c
BP
1871 tape->blk_size = (pc.buf[4 + 5] << 16) +
1872 (pc.buf[4 + 6] << 8) +
1873 pc.buf[4 + 7];
1874 tape->drv_write_prot = (pc.buf[2] & 0x80) >> 7;
3cffb9ce 1875}
1da177e4 1876
5a04cfa9 1877static int idetape_chrdev_open(struct inode *inode, struct file *filp)
1da177e4
LT
1878{
1879 unsigned int minor = iminor(inode), i = minor & ~0xc0;
1880 ide_drive_t *drive;
1881 idetape_tape_t *tape;
1da177e4
LT
1882 int retval;
1883
8004a8c9
BP
1884 if (i >= MAX_HWIFS * MAX_DRIVES)
1885 return -ENXIO;
1886
04f4ac9d 1887 lock_kernel();
8004a8c9 1888 tape = ide_tape_chrdev_get(i);
04f4ac9d
JC
1889 if (!tape) {
1890 unlock_kernel();
8004a8c9 1891 return -ENXIO;
04f4ac9d 1892 }
8004a8c9
BP
1893
1894 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
1895
1da177e4
LT
1896 /*
1897 * We really want to do nonseekable_open(inode, filp); here, but some
1898 * versions of tar incorrectly call lseek on tapes and bail out if that
1899 * fails. So we disallow pread() and pwrite(), but permit lseeks.
1900 */
1901 filp->f_mode &= ~(FMODE_PREAD | FMODE_PWRITE);
1902
1da177e4
LT
1903 drive = tape->drive;
1904
1905 filp->private_data = tape;
1906
f2e3ab52 1907 if (test_and_set_bit(IDE_AFLAG_BUSY, &drive->atapi_flags)) {
1da177e4
LT
1908 retval = -EBUSY;
1909 goto out_put_tape;
1910 }
1911
1912 retval = idetape_wait_ready(drive, 60 * HZ);
1913 if (retval) {
f2e3ab52 1914 clear_bit(IDE_AFLAG_BUSY, &drive->atapi_flags);
1da177e4
LT
1915 printk(KERN_ERR "ide-tape: %s: drive not ready\n", tape->name);
1916 goto out_put_tape;
1917 }
1918
1919 idetape_read_position(drive);
f2e3ab52 1920 if (!test_bit(IDE_AFLAG_ADDRESS_VALID, &drive->atapi_flags))
1da177e4
LT
1921 (void)idetape_rewind_tape(drive);
1922
1da177e4 1923 /* Read block size and write protect status from drive. */
3cffb9ce 1924 ide_tape_get_bsize_from_bdesc(drive);
1da177e4
LT
1925
1926 /* Set write protect flag if device is opened as read-only. */
1927 if ((filp->f_flags & O_ACCMODE) == O_RDONLY)
1928 tape->write_prot = 1;
1929 else
1930 tape->write_prot = tape->drv_write_prot;
1931
1932 /* Make sure drive isn't write protected if user wants to write. */
1933 if (tape->write_prot) {
1934 if ((filp->f_flags & O_ACCMODE) == O_WRONLY ||
1935 (filp->f_flags & O_ACCMODE) == O_RDWR) {
f2e3ab52 1936 clear_bit(IDE_AFLAG_BUSY, &drive->atapi_flags);
1da177e4
LT
1937 retval = -EROFS;
1938 goto out_put_tape;
1939 }
1940 }
1941
3c98bf34 1942 /* Lock the tape drive door so user can't eject. */
54abf37e 1943 if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
0578042d 1944 if (!ide_set_media_lock(drive, tape->disk, 1)) {
385a4b87
BZ
1945 if (tape->door_locked != DOOR_EXPLICITLY_LOCKED)
1946 tape->door_locked = DOOR_LOCKED;
1da177e4
LT
1947 }
1948 }
04f4ac9d 1949 unlock_kernel();
1da177e4
LT
1950 return 0;
1951
1952out_put_tape:
1953 ide_tape_put(tape);
04f4ac9d 1954 unlock_kernel();
1da177e4
LT
1955 return retval;
1956}
1957
5a04cfa9 1958static void idetape_write_release(ide_drive_t *drive, unsigned int minor)
1da177e4
LT
1959{
1960 idetape_tape_t *tape = drive->driver_data;
1961
d9df937a 1962 ide_tape_flush_merge_buffer(drive);
077e3bdb
BP
1963 tape->merge_bh = ide_tape_kmalloc_buffer(tape, 1, 0);
1964 if (tape->merge_bh != NULL) {
54bb2074
BP
1965 idetape_pad_zeros(drive, tape->blk_size *
1966 (tape->user_bs_factor - 1));
077e3bdb
BP
1967 ide_tape_kfree_buffer(tape);
1968 tape->merge_bh = NULL;
1da177e4
LT
1969 }
1970 idetape_write_filemark(drive);
1971 idetape_flush_tape_buffers(drive);
1972 idetape_flush_tape_buffers(drive);
1973}
1974
5a04cfa9 1975static int idetape_chrdev_release(struct inode *inode, struct file *filp)
1da177e4 1976{
5aeddf90 1977 struct ide_tape_obj *tape = filp->private_data;
1da177e4 1978 ide_drive_t *drive = tape->drive;
1da177e4
LT
1979 unsigned int minor = iminor(inode);
1980
1981 lock_kernel();
1982 tape = drive->driver_data;
8004a8c9
BP
1983
1984 debug_log(DBG_CHRDEV, "Enter %s\n", __func__);
1da177e4 1985
54abf37e 1986 if (tape->chrdev_dir == IDETAPE_DIR_WRITE)
1da177e4 1987 idetape_write_release(drive, minor);
54abf37e 1988 if (tape->chrdev_dir == IDETAPE_DIR_READ) {
1da177e4 1989 if (minor < 128)
ec0fdb01 1990 ide_tape_discard_merge_buffer(drive, 1);
1da177e4 1991 }
f64eee7b 1992
f2e3ab52 1993 if (minor < 128 && test_bit(IDE_AFLAG_MEDIUM_PRESENT, &drive->atapi_flags))
1da177e4 1994 (void) idetape_rewind_tape(drive);
54abf37e 1995 if (tape->chrdev_dir == IDETAPE_DIR_NONE) {
1da177e4 1996 if (tape->door_locked == DOOR_LOCKED) {
0578042d 1997 if (!ide_set_media_lock(drive, tape->disk, 0))
385a4b87 1998 tape->door_locked = DOOR_UNLOCKED;
1da177e4
LT
1999 }
2000 }
f2e3ab52 2001 clear_bit(IDE_AFLAG_BUSY, &drive->atapi_flags);
1da177e4
LT
2002 ide_tape_put(tape);
2003 unlock_kernel();
2004 return 0;
2005}
2006
6d29c8f0 2007static void idetape_get_inquiry_results(ide_drive_t *drive)
1da177e4 2008{
1da177e4 2009 idetape_tape_t *tape = drive->driver_data;
d236d74c 2010 struct ide_atapi_pc pc;
41fa9f86 2011 u8 pc_buf[256];
801bd32e 2012 char fw_rev[4], vendor_id[8], product_id[16];
6d29c8f0 2013
1da177e4 2014 idetape_create_inquiry_cmd(&pc);
41fa9f86
BZ
2015 pc.buf = &pc_buf[0];
2016 pc.buf_size = sizeof(pc_buf);
2017
2ac07d92 2018 if (ide_queue_pc_tail(drive, tape->disk, &pc)) {
6d29c8f0
BP
2019 printk(KERN_ERR "ide-tape: %s: can't get INQUIRY results\n",
2020 tape->name);
1da177e4
LT
2021 return;
2022 }
d236d74c
BP
2023 memcpy(vendor_id, &pc.buf[8], 8);
2024 memcpy(product_id, &pc.buf[16], 16);
2025 memcpy(fw_rev, &pc.buf[32], 4);
41f81d54 2026
801bd32e
BP
2027 ide_fixstring(vendor_id, 8, 0);
2028 ide_fixstring(product_id, 16, 0);
2029 ide_fixstring(fw_rev, 4, 0);
41f81d54 2030
801bd32e 2031 printk(KERN_INFO "ide-tape: %s <-> %s: %.8s %.16s rev %.4s\n",
41f81d54 2032 drive->name, tape->name, vendor_id, product_id, fw_rev);
1da177e4
LT
2033}
2034
2035/*
b6422013
BP
2036 * Ask the tape about its various parameters. In particular, we will adjust our
2037 * data transfer buffer size to the recommended value as returned by the tape.
1da177e4 2038 */
5a04cfa9 2039static void idetape_get_mode_sense_results(ide_drive_t *drive)
1da177e4
LT
2040{
2041 idetape_tape_t *tape = drive->driver_data;
d236d74c 2042 struct ide_atapi_pc pc;
b6422013
BP
2043 u8 *caps;
2044 u8 speed, max_speed;
47314fa4 2045
1da177e4 2046 idetape_create_mode_sense_cmd(&pc, IDETAPE_CAPABILITIES_PAGE);
2ac07d92 2047 if (ide_queue_pc_tail(drive, tape->disk, &pc)) {
b6422013
BP
2048 printk(KERN_ERR "ide-tape: Can't get tape parameters - assuming"
2049 " some default values\n");
54bb2074 2050 tape->blk_size = 512;
b6422013
BP
2051 put_unaligned(52, (u16 *)&tape->caps[12]);
2052 put_unaligned(540, (u16 *)&tape->caps[14]);
2053 put_unaligned(6*52, (u16 *)&tape->caps[16]);
1da177e4
LT
2054 return;
2055 }
d236d74c 2056 caps = pc.buf + 4 + pc.buf[3];
b6422013
BP
2057
2058 /* convert to host order and save for later use */
cd740ab0
HH
2059 speed = be16_to_cpup((__be16 *)&caps[14]);
2060 max_speed = be16_to_cpup((__be16 *)&caps[8]);
1da177e4 2061
cd740ab0
HH
2062 *(u16 *)&caps[8] = max_speed;
2063 *(u16 *)&caps[12] = be16_to_cpup((__be16 *)&caps[12]);
2064 *(u16 *)&caps[14] = speed;
2065 *(u16 *)&caps[16] = be16_to_cpup((__be16 *)&caps[16]);
1da177e4 2066
b6422013
BP
2067 if (!speed) {
2068 printk(KERN_INFO "ide-tape: %s: invalid tape speed "
2069 "(assuming 650KB/sec)\n", drive->name);
cd740ab0 2070 *(u16 *)&caps[14] = 650;
1da177e4 2071 }
b6422013
BP
2072 if (!max_speed) {
2073 printk(KERN_INFO "ide-tape: %s: invalid max_speed "
2074 "(assuming 650KB/sec)\n", drive->name);
cd740ab0 2075 *(u16 *)&caps[8] = 650;
1da177e4
LT
2076 }
2077
b6422013 2078 memcpy(&tape->caps, caps, 20);
0578042d
BZ
2079
2080 /* device lacks locking support according to capabilities page */
2081 if ((caps[6] & 1) == 0)
42619d35 2082 drive->dev_flags &= ~IDE_DFLAG_DOORLOCKING;
0578042d 2083
b6422013 2084 if (caps[7] & 0x02)
54bb2074 2085 tape->blk_size = 512;
b6422013 2086 else if (caps[7] & 0x04)
54bb2074 2087 tape->blk_size = 1024;
1da177e4
LT
2088}
2089
7662d046 2090#ifdef CONFIG_IDE_PROC_FS
8185d5aa
BZ
2091#define ide_tape_devset_get(name, field) \
2092static int get_##name(ide_drive_t *drive) \
2093{ \
2094 idetape_tape_t *tape = drive->driver_data; \
2095 return tape->field; \
2096}
2097
2098#define ide_tape_devset_set(name, field) \
2099static int set_##name(ide_drive_t *drive, int arg) \
2100{ \
2101 idetape_tape_t *tape = drive->driver_data; \
2102 tape->field = arg; \
2103 return 0; \
2104}
2105
92f1f8fd 2106#define ide_tape_devset_rw_field(_name, _field) \
8185d5aa
BZ
2107ide_tape_devset_get(_name, _field) \
2108ide_tape_devset_set(_name, _field) \
92f1f8fd 2109IDE_DEVSET(_name, DS_SYNC, get_##_name, set_##_name)
8185d5aa 2110
92f1f8fd 2111#define ide_tape_devset_r_field(_name, _field) \
8185d5aa 2112ide_tape_devset_get(_name, _field) \
92f1f8fd 2113IDE_DEVSET(_name, 0, get_##_name, NULL)
8185d5aa
BZ
2114
2115static int mulf_tdsc(ide_drive_t *drive) { return 1000; }
2116static int divf_tdsc(ide_drive_t *drive) { return HZ; }
2117static int divf_buffer(ide_drive_t *drive) { return 2; }
2118static int divf_buffer_size(ide_drive_t *drive) { return 1024; }
2119
97100fc8 2120ide_devset_rw_flag(dsc_overlap, IDE_DFLAG_DSC_OVERLAP);
92f1f8fd
EO
2121
2122ide_tape_devset_rw_field(debug_mask, debug_mask);
2123ide_tape_devset_rw_field(tdsc, best_dsc_rw_freq);
2124
2125ide_tape_devset_r_field(avg_speed, avg_speed);
2126ide_tape_devset_r_field(speed, caps[14]);
2127ide_tape_devset_r_field(buffer, caps[16]);
2128ide_tape_devset_r_field(buffer_size, buffer_size);
2129
2130static const struct ide_proc_devset idetape_settings[] = {
2131 __IDE_PROC_DEVSET(avg_speed, 0, 0xffff, NULL, NULL),
2132 __IDE_PROC_DEVSET(buffer, 0, 0xffff, NULL, divf_buffer),
2133 __IDE_PROC_DEVSET(buffer_size, 0, 0xffff, NULL, divf_buffer_size),
2134 __IDE_PROC_DEVSET(debug_mask, 0, 0xffff, NULL, NULL),
2135 __IDE_PROC_DEVSET(dsc_overlap, 0, 1, NULL, NULL),
2136 __IDE_PROC_DEVSET(speed, 0, 0xffff, NULL, NULL),
2137 __IDE_PROC_DEVSET(tdsc, IDETAPE_DSC_RW_MIN, IDETAPE_DSC_RW_MAX,
2138 mulf_tdsc, divf_tdsc),
71bfc7a7 2139 { NULL },
8185d5aa 2140};
7662d046 2141#endif
1da177e4
LT
2142
2143/*
3c98bf34 2144 * The function below is called to:
1da177e4 2145 *
3c98bf34
BP
2146 * 1. Initialize our various state variables.
2147 * 2. Ask the tape for its capabilities.
2148 * 3. Allocate a buffer which will be used for data transfer. The buffer size
2149 * is chosen based on the recommendation which we received in step 2.
1da177e4 2150 *
3c98bf34
BP
2151 * Note that at this point ide.c already assigned us an irq, so that we can
2152 * queue requests here and wait for their completion.
1da177e4 2153 */
5a04cfa9 2154static void idetape_setup(ide_drive_t *drive, idetape_tape_t *tape, int minor)
1da177e4 2155{
83042b24 2156 unsigned long t;
1da177e4 2157 int speed;
f73850a3 2158 int buffer_size;
b6422013 2159 u16 *ctl = (u16 *)&tape->caps[12];
1da177e4 2160
85e39035
BZ
2161 drive->pc_callback = ide_tape_callback;
2162 drive->pc_update_buffers = idetape_update_buffers;
2163 drive->pc_io_buffers = ide_tape_io_buffers;
776bb027 2164
97100fc8
BZ
2165 drive->dev_flags |= IDE_DFLAG_DSC_OVERLAP;
2166
4166c199
BZ
2167 if (drive->hwif->host_flags & IDE_HFLAG_NO_DSC) {
2168 printk(KERN_INFO "ide-tape: %s: disabling DSC overlap\n",
2169 tape->name);
97100fc8 2170 drive->dev_flags &= ~IDE_DFLAG_DSC_OVERLAP;
1da177e4 2171 }
97100fc8 2172
1da177e4 2173 /* Seagate Travan drives do not support DSC overlap. */
4dde4492 2174 if (strstr((char *)&drive->id[ATA_ID_PROD], "Seagate STT3401"))
97100fc8
BZ
2175 drive->dev_flags &= ~IDE_DFLAG_DSC_OVERLAP;
2176
1da177e4
LT
2177 tape->minor = minor;
2178 tape->name[0] = 'h';
2179 tape->name[1] = 't';
2180 tape->name[2] = '0' + minor;
54abf37e 2181 tape->chrdev_dir = IDETAPE_DIR_NONE;
4dde4492 2182
1da177e4
LT
2183 idetape_get_inquiry_results(drive);
2184 idetape_get_mode_sense_results(drive);
3cffb9ce 2185 ide_tape_get_bsize_from_bdesc(drive);
1da177e4 2186 tape->user_bs_factor = 1;
f73850a3
BP
2187 tape->buffer_size = *ctl * tape->blk_size;
2188 while (tape->buffer_size > 0xffff) {
1da177e4 2189 printk(KERN_NOTICE "ide-tape: decreasing stage size\n");
b6422013 2190 *ctl /= 2;
f73850a3 2191 tape->buffer_size = *ctl * tape->blk_size;
1da177e4 2192 }
f73850a3 2193 buffer_size = tape->buffer_size;
a997a435 2194 tape->pages_per_buffer = buffer_size / PAGE_SIZE;
f73850a3 2195 if (buffer_size % PAGE_SIZE) {
a997a435 2196 tape->pages_per_buffer++;
f73850a3 2197 tape->excess_bh_size = PAGE_SIZE - buffer_size % PAGE_SIZE;
1da177e4
LT
2198 }
2199
83042b24 2200 /* select the "best" DSC read/write polling freq */
b6422013 2201 speed = max(*(u16 *)&tape->caps[14], *(u16 *)&tape->caps[8]);
1da177e4 2202
f73850a3 2203 t = (IDETAPE_FIFO_THRESHOLD * tape->buffer_size * HZ) / (speed * 1000);
1da177e4
LT
2204
2205 /*
3c98bf34
BP
2206 * Ensure that the number we got makes sense; limit it within
2207 * IDETAPE_DSC_RW_MIN and IDETAPE_DSC_RW_MAX.
1da177e4 2208 */
a792bd5a
HH
2209 tape->best_dsc_rw_freq = clamp_t(unsigned long, t, IDETAPE_DSC_RW_MIN,
2210 IDETAPE_DSC_RW_MAX);
1da177e4 2211 printk(KERN_INFO "ide-tape: %s <-> %s: %dKBps, %d*%dkB buffer, "
83042b24 2212 "%lums tDSC%s\n",
b6422013 2213 drive->name, tape->name, *(u16 *)&tape->caps[14],
f73850a3
BP
2214 (*(u16 *)&tape->caps[16] * 512) / tape->buffer_size,
2215 tape->buffer_size / 1024,
54bb2074 2216 tape->best_dsc_rw_freq * 1000 / HZ,
97100fc8 2217 (drive->dev_flags & IDE_DFLAG_USING_DMA) ? ", DMA" : "");
1da177e4 2218
1e874f44 2219 ide_proc_register_driver(drive, tape->driver);
1da177e4
LT
2220}
2221
4031bbe4 2222static void ide_tape_remove(ide_drive_t *drive)
1da177e4
LT
2223{
2224 idetape_tape_t *tape = drive->driver_data;
1da177e4 2225
7662d046 2226 ide_proc_unregister_driver(drive, tape->driver);
8fed4368 2227 device_del(&tape->dev);
1da177e4
LT
2228 ide_unregister_region(tape->disk);
2229
8fed4368
BZ
2230 mutex_lock(&idetape_ref_mutex);
2231 put_device(&tape->dev);
2232 mutex_unlock(&idetape_ref_mutex);
1da177e4
LT
2233}
2234
8fed4368 2235static void ide_tape_release(struct device *dev)
1da177e4 2236{
8fed4368 2237 struct ide_tape_obj *tape = to_ide_drv(dev, ide_tape_obj);
1da177e4
LT
2238 ide_drive_t *drive = tape->drive;
2239 struct gendisk *g = tape->disk;
2240
01a63aeb 2241 BUG_ON(tape->merge_bh_size);
8604affd 2242
97100fc8 2243 drive->dev_flags &= ~IDE_DFLAG_DSC_OVERLAP;
1da177e4 2244 drive->driver_data = NULL;
dbc1272e 2245 device_destroy(idetape_sysfs_class, MKDEV(IDETAPE_MAJOR, tape->minor));
5a04cfa9
BP
2246 device_destroy(idetape_sysfs_class,
2247 MKDEV(IDETAPE_MAJOR, tape->minor + 128));
1da177e4
LT
2248 idetape_devs[tape->minor] = NULL;
2249 g->private_data = NULL;
2250 put_disk(g);
2251 kfree(tape);
2252}
2253
ecfd80e4 2254#ifdef CONFIG_IDE_PROC_FS
1da177e4
LT
2255static int proc_idetape_read_name
2256 (char *page, char **start, off_t off, int count, int *eof, void *data)
2257{
2258 ide_drive_t *drive = (ide_drive_t *) data;
2259 idetape_tape_t *tape = drive->driver_data;
2260 char *out = page;
2261 int len;
2262
2263 len = sprintf(out, "%s\n", tape->name);
2264 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
2265}
2266
2267static ide_proc_entry_t idetape_proc[] = {
2268 { "capacity", S_IFREG|S_IRUGO, proc_ide_read_capacity, NULL },
2269 { "name", S_IFREG|S_IRUGO, proc_idetape_read_name, NULL },
2270 { NULL, 0, NULL, NULL }
2271};
79cb3803
BZ
2272
2273static ide_proc_entry_t *ide_tape_proc_entries(ide_drive_t *drive)
2274{
2275 return idetape_proc;
2276}
2277
2278static const struct ide_proc_devset *ide_tape_proc_devsets(ide_drive_t *drive)
2279{
2280 return idetape_settings;
2281}
1da177e4
LT
2282#endif
2283
4031bbe4 2284static int ide_tape_probe(ide_drive_t *);
1da177e4 2285
7f3c868b 2286static struct ide_driver idetape_driver = {
8604affd 2287 .gen_driver = {
4ef3b8f4 2288 .owner = THIS_MODULE,
8604affd
BZ
2289 .name = "ide-tape",
2290 .bus = &ide_bus_type,
8604affd 2291 },
4031bbe4
RK
2292 .probe = ide_tape_probe,
2293 .remove = ide_tape_remove,
1da177e4 2294 .version = IDETAPE_VERSION,
1da177e4 2295 .do_request = idetape_do_request,
7662d046 2296#ifdef CONFIG_IDE_PROC_FS
79cb3803
BZ
2297 .proc_entries = ide_tape_proc_entries,
2298 .proc_devsets = ide_tape_proc_devsets,
7662d046 2299#endif
1da177e4
LT
2300};
2301
3c98bf34 2302/* Our character device supporting functions, passed to register_chrdev. */
2b8693c0 2303static const struct file_operations idetape_fops = {
1da177e4
LT
2304 .owner = THIS_MODULE,
2305 .read = idetape_chrdev_read,
2306 .write = idetape_chrdev_write,
2307 .ioctl = idetape_chrdev_ioctl,
2308 .open = idetape_chrdev_open,
2309 .release = idetape_chrdev_release,
2310};
2311
a4600f81 2312static int idetape_open(struct block_device *bdev, fmode_t mode)
1da177e4 2313{
a4600f81 2314 struct ide_tape_obj *tape = ide_tape_get(bdev->bd_disk);
1da177e4 2315
5a04cfa9 2316 if (!tape)
1da177e4
LT
2317 return -ENXIO;
2318
1da177e4
LT
2319 return 0;
2320}
2321
a4600f81 2322static int idetape_release(struct gendisk *disk, fmode_t mode)
1da177e4 2323{
5aeddf90 2324 struct ide_tape_obj *tape = ide_drv_g(disk, ide_tape_obj);
1da177e4
LT
2325
2326 ide_tape_put(tape);
1da177e4
LT
2327 return 0;
2328}
2329
a4600f81 2330static int idetape_ioctl(struct block_device *bdev, fmode_t mode,
1da177e4
LT
2331 unsigned int cmd, unsigned long arg)
2332{
5aeddf90 2333 struct ide_tape_obj *tape = ide_drv_g(bdev->bd_disk, ide_tape_obj);
1da177e4 2334 ide_drive_t *drive = tape->drive;
1bddd9e6 2335 int err = generic_ide_ioctl(drive, bdev, cmd, arg);
1da177e4
LT
2336 if (err == -EINVAL)
2337 err = idetape_blkdev_ioctl(drive, cmd, arg);
2338 return err;
2339}
2340
2341static struct block_device_operations idetape_block_ops = {
2342 .owner = THIS_MODULE,
a4600f81
AV
2343 .open = idetape_open,
2344 .release = idetape_release,
2345 .locked_ioctl = idetape_ioctl,
1da177e4
LT
2346};
2347
4031bbe4 2348static int ide_tape_probe(ide_drive_t *drive)
1da177e4
LT
2349{
2350 idetape_tape_t *tape;
2351 struct gendisk *g;
2352 int minor;
2353
2354 if (!strstr("ide-tape", drive->driver_req))
2355 goto failed;
2a924662 2356
1da177e4
LT
2357 if (drive->media != ide_tape)
2358 goto failed;
2a924662 2359
97100fc8
BZ
2360 if ((drive->dev_flags & IDE_DFLAG_ID_READ) &&
2361 ide_check_atapi_device(drive, DRV_NAME) == 0) {
5a04cfa9
BP
2362 printk(KERN_ERR "ide-tape: %s: not supported by this version of"
2363 " the driver\n", drive->name);
1da177e4
LT
2364 goto failed;
2365 }
5a04cfa9 2366 tape = kzalloc(sizeof(idetape_tape_t), GFP_KERNEL);
1da177e4 2367 if (tape == NULL) {
5a04cfa9
BP
2368 printk(KERN_ERR "ide-tape: %s: Can't allocate a tape struct\n",
2369 drive->name);
1da177e4
LT
2370 goto failed;
2371 }
2372
2373 g = alloc_disk(1 << PARTN_BITS);
2374 if (!g)
2375 goto out_free_tape;
2376
2377 ide_init_disk(g, drive);
2378
8fed4368
BZ
2379 tape->dev.parent = &drive->gendev;
2380 tape->dev.release = ide_tape_release;
2381 dev_set_name(&tape->dev, dev_name(&drive->gendev));
2382
2383 if (device_register(&tape->dev))
2384 goto out_free_disk;
1da177e4
LT
2385
2386 tape->drive = drive;
2387 tape->driver = &idetape_driver;
2388 tape->disk = g;
2389
2390 g->private_data = &tape->driver;
2391
2392 drive->driver_data = tape;
2393
cf8b8975 2394 mutex_lock(&idetape_ref_mutex);
1da177e4
LT
2395 for (minor = 0; idetape_devs[minor]; minor++)
2396 ;
2397 idetape_devs[minor] = tape;
cf8b8975 2398 mutex_unlock(&idetape_ref_mutex);
1da177e4
LT
2399
2400 idetape_setup(drive, tape, minor);
2401
3ee074bf
GKH
2402 device_create(idetape_sysfs_class, &drive->gendev,
2403 MKDEV(IDETAPE_MAJOR, minor), NULL, "%s", tape->name);
2404 device_create(idetape_sysfs_class, &drive->gendev,
2405 MKDEV(IDETAPE_MAJOR, minor + 128), NULL,
2406 "n%s", tape->name);
d5dee80a 2407
1da177e4
LT
2408 g->fops = &idetape_block_ops;
2409 ide_register_region(g);
2410
2411 return 0;
8604affd 2412
8fed4368
BZ
2413out_free_disk:
2414 put_disk(g);
1da177e4
LT
2415out_free_tape:
2416 kfree(tape);
2417failed:
8604affd 2418 return -ENODEV;
1da177e4
LT
2419}
2420
5a04cfa9 2421static void __exit idetape_exit(void)
1da177e4 2422{
8604affd 2423 driver_unregister(&idetape_driver.gen_driver);
d5dee80a 2424 class_destroy(idetape_sysfs_class);
1da177e4
LT
2425 unregister_chrdev(IDETAPE_MAJOR, "ht");
2426}
2427
17514e8a 2428static int __init idetape_init(void)
1da177e4 2429{
d5dee80a
WD
2430 int error = 1;
2431 idetape_sysfs_class = class_create(THIS_MODULE, "ide_tape");
2432 if (IS_ERR(idetape_sysfs_class)) {
2433 idetape_sysfs_class = NULL;
2434 printk(KERN_ERR "Unable to create sysfs class for ide tapes\n");
2435 error = -EBUSY;
2436 goto out;
2437 }
2438
1da177e4 2439 if (register_chrdev(IDETAPE_MAJOR, "ht", &idetape_fops)) {
5a04cfa9
BP
2440 printk(KERN_ERR "ide-tape: Failed to register chrdev"
2441 " interface\n");
d5dee80a
WD
2442 error = -EBUSY;
2443 goto out_free_class;
1da177e4 2444 }
d5dee80a
WD
2445
2446 error = driver_register(&idetape_driver.gen_driver);
2447 if (error)
2448 goto out_free_driver;
2449
2450 return 0;
2451
2452out_free_driver:
2453 driver_unregister(&idetape_driver.gen_driver);
2454out_free_class:
2455 class_destroy(idetape_sysfs_class);
2456out:
2457 return error;
1da177e4
LT
2458}
2459
263756ec 2460MODULE_ALIAS("ide:*m-tape*");
1da177e4
LT
2461module_init(idetape_init);
2462module_exit(idetape_exit);
2463MODULE_ALIAS_CHARDEV_MAJOR(IDETAPE_MAJOR);
9c145768
BP
2464MODULE_DESCRIPTION("ATAPI Streaming TAPE Driver");
2465MODULE_LICENSE("GPL");