initial commit with v2.6.32.60
[linux-2.6.32.60-moxart.git] / drivers / scsi / st.c
blob723da1d14e8304a95e6cd4114132c2e8c82cc8f6
1 /*
2 SCSI Tape Driver for Linux version 1.1 and newer. See the accompanying
3 file Documentation/scsi/st.txt for more information.
5 History:
6 Rewritten from Dwayne Forsyth's SCSI tape driver by Kai Makisara.
7 Contribution and ideas from several people including (in alphabetical
8 order) Klaus Ehrenfried, Eugene Exarevsky, Eric Lee Green, Wolfgang Denk,
9 Steve Hirsch, Andreas Koppenh"ofer, Michael Leodolter, Eyal Lebedinsky,
10 Michael Schaefer, J"org Weule, and Eric Youngdale.
12 Copyright 1992 - 2008 Kai Makisara
13 email Kai.Makisara@kolumbus.fi
15 Some small formal changes - aeb, 950809
17 Last modified: 18-JAN-1998 Richard Gooch <rgooch@atnf.csiro.au> Devfs support
20 static const char *verstr = "20081215";
22 #include <linux/module.h>
24 #include <linux/fs.h>
25 #include <linux/kernel.h>
26 #include <linux/sched.h>
27 #include <linux/mm.h>
28 #include <linux/init.h>
29 #include <linux/string.h>
30 #include <linux/errno.h>
31 #include <linux/mtio.h>
32 #include <linux/cdrom.h>
33 #include <linux/ioctl.h>
34 #include <linux/fcntl.h>
35 #include <linux/spinlock.h>
36 #include <linux/blkdev.h>
37 #include <linux/moduleparam.h>
38 #include <linux/cdev.h>
39 #include <linux/delay.h>
40 #include <linux/mutex.h>
41 #include <linux/smp_lock.h>
43 #include <asm/uaccess.h>
44 #include <asm/dma.h>
45 #include <asm/system.h>
47 #include <scsi/scsi.h>
48 #include <scsi/scsi_dbg.h>
49 #include <scsi/scsi_device.h>
50 #include <scsi/scsi_driver.h>
51 #include <scsi/scsi_eh.h>
52 #include <scsi/scsi_host.h>
53 #include <scsi/scsi_ioctl.h>
54 #include <scsi/sg.h>
57 /* The driver prints some debugging information on the console if DEBUG
58 is defined and non-zero. */
59 #define DEBUG 0
61 #if DEBUG
62 /* The message level for the debug messages is currently set to KERN_NOTICE
63 so that people can easily see the messages. Later when the debugging messages
64 in the drivers are more widely classified, this may be changed to KERN_DEBUG. */
65 #define ST_DEB_MSG KERN_NOTICE
66 #define DEB(a) a
67 #define DEBC(a) if (debugging) { a ; }
68 #else
69 #define DEB(a)
70 #define DEBC(a)
71 #endif
73 #define ST_KILOBYTE 1024
75 #include "st_options.h"
76 #include "st.h"
78 static int buffer_kbs;
79 static int max_sg_segs;
80 static int try_direct_io = TRY_DIRECT_IO;
81 static int try_rdio = 1;
82 static int try_wdio = 1;
84 static int st_dev_max;
85 static int st_nr_dev;
87 static struct class *st_sysfs_class;
89 MODULE_AUTHOR("Kai Makisara");
90 MODULE_DESCRIPTION("SCSI tape (st) driver");
91 MODULE_LICENSE("GPL");
92 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_TAPE_MAJOR);
93 MODULE_ALIAS_SCSI_DEVICE(TYPE_TAPE);
95 /* Set 'perm' (4th argument) to 0 to disable module_param's definition
96 * of sysfs parameters (which module_param doesn't yet support).
97 * Sysfs parameters defined explicitly later.
99 module_param_named(buffer_kbs, buffer_kbs, int, 0);
100 MODULE_PARM_DESC(buffer_kbs, "Default driver buffer size for fixed block mode (KB; 32)");
101 module_param_named(max_sg_segs, max_sg_segs, int, 0);
102 MODULE_PARM_DESC(max_sg_segs, "Maximum number of scatter/gather segments to use (256)");
103 module_param_named(try_direct_io, try_direct_io, int, 0);
104 MODULE_PARM_DESC(try_direct_io, "Try direct I/O between user buffer and tape drive (1)");
106 /* Extra parameters for testing */
107 module_param_named(try_rdio, try_rdio, int, 0);
108 MODULE_PARM_DESC(try_rdio, "Try direct read i/o when possible");
109 module_param_named(try_wdio, try_wdio, int, 0);
110 MODULE_PARM_DESC(try_wdio, "Try direct write i/o when possible");
112 #ifndef MODULE
113 static int write_threshold_kbs; /* retained for compatibility */
114 static struct st_dev_parm {
115 char *name;
116 int *val;
117 } parms[] __initdata = {
119 "buffer_kbs", &buffer_kbs
121 { /* Retained for compatibility with 2.4 */
122 "write_threshold_kbs", &write_threshold_kbs
125 "max_sg_segs", NULL
128 "try_direct_io", &try_direct_io
131 #endif
133 /* Restrict the number of modes so that names for all are assigned */
134 #if ST_NBR_MODES > 16
135 #error "Maximum number of modes is 16"
136 #endif
137 /* Bit reversed order to get same names for same minors with all
138 mode counts */
139 static const char *st_formats[] = {
140 "", "r", "k", "s", "l", "t", "o", "u",
141 "m", "v", "p", "x", "a", "y", "q", "z"};
143 /* The default definitions have been moved to st_options.h */
145 #define ST_FIXED_BUFFER_SIZE (ST_FIXED_BUFFER_BLOCKS * ST_KILOBYTE)
147 /* The buffer size should fit into the 24 bits for length in the
148 6-byte SCSI read and write commands. */
149 #if ST_FIXED_BUFFER_SIZE >= (2 << 24 - 1)
150 #error "Buffer size should not exceed (2 << 24 - 1) bytes!"
151 #endif
153 static int debugging = DEBUG;
155 #define MAX_RETRIES 0
156 #define MAX_WRITE_RETRIES 0
157 #define MAX_READY_RETRIES 0
158 #define NO_TAPE NOT_READY
160 #define ST_TIMEOUT (900 * HZ)
161 #define ST_LONG_TIMEOUT (14000 * HZ)
163 /* Remove mode bits and auto-rewind bit (7) */
164 #define TAPE_NR(x) ( ((iminor(x) & ~255) >> (ST_NBR_MODE_BITS + 1)) | \
165 (iminor(x) & ~(-1 << ST_MODE_SHIFT)) )
166 #define TAPE_MODE(x) ((iminor(x) & ST_MODE_MASK) >> ST_MODE_SHIFT)
168 /* Construct the minor number from the device (d), mode (m), and non-rewind (n) data */
169 #define TAPE_MINOR(d, m, n) (((d & ~(255 >> (ST_NBR_MODE_BITS + 1))) << (ST_NBR_MODE_BITS + 1)) | \
170 (d & (255 >> (ST_NBR_MODE_BITS + 1))) | (m << ST_MODE_SHIFT) | ((n != 0) << 7) )
172 /* Internal ioctl to set both density (uppermost 8 bits) and blocksize (lower
173 24 bits) */
174 #define SET_DENS_AND_BLK 0x10001
176 static DEFINE_RWLOCK(st_dev_arr_lock);
178 static int st_fixed_buffer_size = ST_FIXED_BUFFER_SIZE;
179 static int st_max_sg_segs = ST_MAX_SG;
181 static struct scsi_tape **scsi_tapes = NULL;
183 static int modes_defined;
185 static int enlarge_buffer(struct st_buffer *, int, int);
186 static void clear_buffer(struct st_buffer *);
187 static void normalize_buffer(struct st_buffer *);
188 static int append_to_buffer(const char __user *, struct st_buffer *, int);
189 static int from_buffer(struct st_buffer *, char __user *, int);
190 static void move_buffer_data(struct st_buffer *, int);
192 static int sgl_map_user_pages(struct st_buffer *, const unsigned int,
193 unsigned long, size_t, int);
194 static int sgl_unmap_user_pages(struct st_buffer *, const unsigned int, int);
196 static int st_probe(struct device *);
197 static int st_remove(struct device *);
199 static int do_create_sysfs_files(void);
200 static void do_remove_sysfs_files(void);
201 static int do_create_class_files(struct scsi_tape *, int, int);
203 static struct scsi_driver st_template = {
204 .owner = THIS_MODULE,
205 .gendrv = {
206 .name = "st",
207 .probe = st_probe,
208 .remove = st_remove,
212 static int st_compression(struct scsi_tape *, int);
214 static int find_partition(struct scsi_tape *);
215 static int switch_partition(struct scsi_tape *);
217 static int st_int_ioctl(struct scsi_tape *, unsigned int, unsigned long);
219 static void scsi_tape_release(struct kref *);
221 #define to_scsi_tape(obj) container_of(obj, struct scsi_tape, kref)
223 static DEFINE_MUTEX(st_ref_mutex);
226 #include "osst_detect.h"
227 #ifndef SIGS_FROM_OSST
228 #define SIGS_FROM_OSST \
229 {"OnStream", "SC-", "", "osst"}, \
230 {"OnStream", "DI-", "", "osst"}, \
231 {"OnStream", "DP-", "", "osst"}, \
232 {"OnStream", "USB", "", "osst"}, \
233 {"OnStream", "FW-", "", "osst"}
234 #endif
236 static struct scsi_tape *scsi_tape_get(int dev)
238 struct scsi_tape *STp = NULL;
240 mutex_lock(&st_ref_mutex);
241 write_lock(&st_dev_arr_lock);
243 if (dev < st_dev_max && scsi_tapes != NULL)
244 STp = scsi_tapes[dev];
245 if (!STp) goto out;
247 kref_get(&STp->kref);
249 if (!STp->device)
250 goto out_put;
252 if (scsi_device_get(STp->device))
253 goto out_put;
255 goto out;
257 out_put:
258 kref_put(&STp->kref, scsi_tape_release);
259 STp = NULL;
260 out:
261 write_unlock(&st_dev_arr_lock);
262 mutex_unlock(&st_ref_mutex);
263 return STp;
266 static void scsi_tape_put(struct scsi_tape *STp)
268 struct scsi_device *sdev = STp->device;
270 mutex_lock(&st_ref_mutex);
271 kref_put(&STp->kref, scsi_tape_release);
272 scsi_device_put(sdev);
273 mutex_unlock(&st_ref_mutex);
276 struct st_reject_data {
277 char *vendor;
278 char *model;
279 char *rev;
280 char *driver_hint; /* Name of the correct driver, NULL if unknown */
283 static struct st_reject_data reject_list[] = {
284 /* {"XXX", "Yy-", "", NULL}, example */
285 SIGS_FROM_OSST,
286 {NULL, }};
288 /* If the device signature is on the list of incompatible drives, the
289 function returns a pointer to the name of the correct driver (if known) */
290 static char * st_incompatible(struct scsi_device* SDp)
292 struct st_reject_data *rp;
294 for (rp=&(reject_list[0]); rp->vendor != NULL; rp++)
295 if (!strncmp(rp->vendor, SDp->vendor, strlen(rp->vendor)) &&
296 !strncmp(rp->model, SDp->model, strlen(rp->model)) &&
297 !strncmp(rp->rev, SDp->rev, strlen(rp->rev))) {
298 if (rp->driver_hint)
299 return rp->driver_hint;
300 else
301 return "unknown";
303 return NULL;
307 static inline char *tape_name(struct scsi_tape *tape)
309 return tape->disk->disk_name;
313 static void st_analyze_sense(struct st_request *SRpnt, struct st_cmdstatus *s)
315 const u8 *ucp;
316 const u8 *sense = SRpnt->sense;
318 s->have_sense = scsi_normalize_sense(SRpnt->sense,
319 SCSI_SENSE_BUFFERSIZE, &s->sense_hdr);
320 s->flags = 0;
322 if (s->have_sense) {
323 s->deferred = 0;
324 s->remainder_valid =
325 scsi_get_sense_info_fld(sense, SCSI_SENSE_BUFFERSIZE, &s->uremainder64);
326 switch (sense[0] & 0x7f) {
327 case 0x71:
328 s->deferred = 1;
329 case 0x70:
330 s->fixed_format = 1;
331 s->flags = sense[2] & 0xe0;
332 break;
333 case 0x73:
334 s->deferred = 1;
335 case 0x72:
336 s->fixed_format = 0;
337 ucp = scsi_sense_desc_find(sense, SCSI_SENSE_BUFFERSIZE, 4);
338 s->flags = ucp ? (ucp[3] & 0xe0) : 0;
339 break;
345 /* Convert the result to success code */
346 static int st_chk_result(struct scsi_tape *STp, struct st_request * SRpnt)
348 int result = SRpnt->result;
349 u8 scode;
350 DEB(const char *stp;)
351 char *name = tape_name(STp);
352 struct st_cmdstatus *cmdstatp;
354 if (!result)
355 return 0;
357 cmdstatp = &STp->buffer->cmdstat;
358 st_analyze_sense(SRpnt, cmdstatp);
360 if (cmdstatp->have_sense)
361 scode = STp->buffer->cmdstat.sense_hdr.sense_key;
362 else
363 scode = 0;
365 DEB(
366 if (debugging) {
367 printk(ST_DEB_MSG "%s: Error: %x, cmd: %x %x %x %x %x %x\n",
368 name, result,
369 SRpnt->cmd[0], SRpnt->cmd[1], SRpnt->cmd[2],
370 SRpnt->cmd[3], SRpnt->cmd[4], SRpnt->cmd[5]);
371 if (cmdstatp->have_sense)
372 __scsi_print_sense(name, SRpnt->sense, SCSI_SENSE_BUFFERSIZE);
373 } ) /* end DEB */
374 if (!debugging) { /* Abnormal conditions for tape */
375 if (!cmdstatp->have_sense)
376 printk(KERN_WARNING
377 "%s: Error %x (driver bt 0x%x, host bt 0x%x).\n",
378 name, result, driver_byte(result),
379 host_byte(result));
380 else if (cmdstatp->have_sense &&
381 scode != NO_SENSE &&
382 scode != RECOVERED_ERROR &&
383 /* scode != UNIT_ATTENTION && */
384 scode != BLANK_CHECK &&
385 scode != VOLUME_OVERFLOW &&
386 SRpnt->cmd[0] != MODE_SENSE &&
387 SRpnt->cmd[0] != TEST_UNIT_READY) {
389 __scsi_print_sense(name, SRpnt->sense, SCSI_SENSE_BUFFERSIZE);
393 if (cmdstatp->fixed_format &&
394 STp->cln_mode >= EXTENDED_SENSE_START) { /* Only fixed format sense */
395 if (STp->cln_sense_value)
396 STp->cleaning_req |= ((SRpnt->sense[STp->cln_mode] &
397 STp->cln_sense_mask) == STp->cln_sense_value);
398 else
399 STp->cleaning_req |= ((SRpnt->sense[STp->cln_mode] &
400 STp->cln_sense_mask) != 0);
402 if (cmdstatp->have_sense &&
403 cmdstatp->sense_hdr.asc == 0 && cmdstatp->sense_hdr.ascq == 0x17)
404 STp->cleaning_req = 1; /* ASC and ASCQ => cleaning requested */
406 STp->pos_unknown |= STp->device->was_reset;
408 if (cmdstatp->have_sense &&
409 scode == RECOVERED_ERROR
410 #if ST_RECOVERED_WRITE_FATAL
411 && SRpnt->cmd[0] != WRITE_6
412 && SRpnt->cmd[0] != WRITE_FILEMARKS
413 #endif
415 STp->recover_count++;
416 STp->recover_reg++;
418 DEB(
419 if (debugging) {
420 if (SRpnt->cmd[0] == READ_6)
421 stp = "read";
422 else if (SRpnt->cmd[0] == WRITE_6)
423 stp = "write";
424 else
425 stp = "ioctl";
426 printk(ST_DEB_MSG "%s: Recovered %s error (%d).\n", name, stp,
427 STp->recover_count);
428 } ) /* end DEB */
430 if (cmdstatp->flags == 0)
431 return 0;
433 return (-EIO);
436 static struct st_request *st_allocate_request(struct scsi_tape *stp)
438 struct st_request *streq;
440 streq = kzalloc(sizeof(*streq), GFP_KERNEL);
441 if (streq)
442 streq->stp = stp;
443 else {
444 DEBC(printk(KERN_ERR "%s: Can't get SCSI request.\n",
445 tape_name(stp)););
446 if (signal_pending(current))
447 stp->buffer->syscall_result = -EINTR;
448 else
449 stp->buffer->syscall_result = -EBUSY;
452 return streq;
455 static void st_release_request(struct st_request *streq)
457 kfree(streq);
460 static void st_scsi_execute_end(struct request *req, int uptodate)
462 struct st_request *SRpnt = req->end_io_data;
463 struct scsi_tape *STp = SRpnt->stp;
464 struct bio *tmp;
466 STp->buffer->cmdstat.midlevel_result = SRpnt->result = req->errors;
467 STp->buffer->cmdstat.residual = req->resid_len;
469 tmp = SRpnt->bio;
470 if (SRpnt->waiting)
471 complete(SRpnt->waiting);
473 blk_rq_unmap_user(tmp);
474 __blk_put_request(req->q, req);
477 static int st_scsi_execute(struct st_request *SRpnt, const unsigned char *cmd,
478 int data_direction, void *buffer, unsigned bufflen,
479 int timeout, int retries)
481 struct request *req;
482 struct rq_map_data *mdata = &SRpnt->stp->buffer->map_data;
483 int err = 0;
484 int write = (data_direction == DMA_TO_DEVICE);
486 req = blk_get_request(SRpnt->stp->device->request_queue, write,
487 GFP_KERNEL);
488 if (!req)
489 return DRIVER_ERROR << 24;
491 req->cmd_type = REQ_TYPE_BLOCK_PC;
492 req->cmd_flags |= REQ_QUIET;
494 mdata->null_mapped = 1;
496 if (bufflen) {
497 err = blk_rq_map_user(req->q, req, mdata, NULL, bufflen,
498 GFP_KERNEL);
499 if (err) {
500 blk_put_request(req);
501 return DRIVER_ERROR << 24;
505 SRpnt->bio = req->bio;
506 req->cmd_len = COMMAND_SIZE(cmd[0]);
507 memset(req->cmd, 0, BLK_MAX_CDB);
508 memcpy(req->cmd, cmd, req->cmd_len);
509 req->sense = SRpnt->sense;
510 req->sense_len = 0;
511 req->timeout = timeout;
512 req->retries = retries;
513 req->end_io_data = SRpnt;
515 blk_execute_rq_nowait(req->q, NULL, req, 1, st_scsi_execute_end);
516 return 0;
519 /* Do the scsi command. Waits until command performed if do_wait is true.
520 Otherwise write_behind_check() is used to check that the command
521 has finished. */
522 static struct st_request *
523 st_do_scsi(struct st_request * SRpnt, struct scsi_tape * STp, unsigned char *cmd,
524 int bytes, int direction, int timeout, int retries, int do_wait)
526 struct completion *waiting;
527 struct rq_map_data *mdata = &STp->buffer->map_data;
528 int ret;
530 /* if async, make sure there's no command outstanding */
531 if (!do_wait && ((STp->buffer)->last_SRpnt)) {
532 printk(KERN_ERR "%s: Async command already active.\n",
533 tape_name(STp));
534 if (signal_pending(current))
535 (STp->buffer)->syscall_result = (-EINTR);
536 else
537 (STp->buffer)->syscall_result = (-EBUSY);
538 return NULL;
541 if (!SRpnt) {
542 SRpnt = st_allocate_request(STp);
543 if (!SRpnt)
544 return NULL;
547 /* If async IO, set last_SRpnt. This ptr tells write_behind_check
548 which IO is outstanding. It's nulled out when the IO completes. */
549 if (!do_wait)
550 (STp->buffer)->last_SRpnt = SRpnt;
552 waiting = &STp->wait;
553 init_completion(waiting);
554 SRpnt->waiting = waiting;
556 if (STp->buffer->do_dio) {
557 mdata->page_order = 0;
558 mdata->nr_entries = STp->buffer->sg_segs;
559 mdata->pages = STp->buffer->mapped_pages;
560 } else {
561 mdata->page_order = STp->buffer->reserved_page_order;
562 mdata->nr_entries =
563 DIV_ROUND_UP(bytes, PAGE_SIZE << mdata->page_order);
564 mdata->pages = STp->buffer->reserved_pages;
565 mdata->offset = 0;
568 memcpy(SRpnt->cmd, cmd, sizeof(SRpnt->cmd));
569 STp->buffer->cmdstat.have_sense = 0;
570 STp->buffer->syscall_result = 0;
572 ret = st_scsi_execute(SRpnt, cmd, direction, NULL, bytes, timeout,
573 retries);
574 if (ret) {
575 /* could not allocate the buffer or request was too large */
576 (STp->buffer)->syscall_result = (-EBUSY);
577 (STp->buffer)->last_SRpnt = NULL;
578 } else if (do_wait) {
579 wait_for_completion(waiting);
580 SRpnt->waiting = NULL;
581 (STp->buffer)->syscall_result = st_chk_result(STp, SRpnt);
584 return SRpnt;
588 /* Handle the write-behind checking (waits for completion). Returns -ENOSPC if
589 write has been correct but EOM early warning reached, -EIO if write ended in
590 error or zero if write successful. Asynchronous writes are used only in
591 variable block mode. */
592 static int write_behind_check(struct scsi_tape * STp)
594 int retval = 0;
595 struct st_buffer *STbuffer;
596 struct st_partstat *STps;
597 struct st_cmdstatus *cmdstatp;
598 struct st_request *SRpnt;
600 STbuffer = STp->buffer;
601 if (!STbuffer->writing)
602 return 0;
604 DEB(
605 if (STp->write_pending)
606 STp->nbr_waits++;
607 else
608 STp->nbr_finished++;
609 ) /* end DEB */
611 wait_for_completion(&(STp->wait));
612 SRpnt = STbuffer->last_SRpnt;
613 STbuffer->last_SRpnt = NULL;
614 SRpnt->waiting = NULL;
616 (STp->buffer)->syscall_result = st_chk_result(STp, SRpnt);
617 st_release_request(SRpnt);
619 STbuffer->buffer_bytes -= STbuffer->writing;
620 STps = &(STp->ps[STp->partition]);
621 if (STps->drv_block >= 0) {
622 if (STp->block_size == 0)
623 STps->drv_block++;
624 else
625 STps->drv_block += STbuffer->writing / STp->block_size;
628 cmdstatp = &STbuffer->cmdstat;
629 if (STbuffer->syscall_result) {
630 retval = -EIO;
631 if (cmdstatp->have_sense && !cmdstatp->deferred &&
632 (cmdstatp->flags & SENSE_EOM) &&
633 (cmdstatp->sense_hdr.sense_key == NO_SENSE ||
634 cmdstatp->sense_hdr.sense_key == RECOVERED_ERROR)) {
635 /* EOM at write-behind, has all data been written? */
636 if (!cmdstatp->remainder_valid ||
637 cmdstatp->uremainder64 == 0)
638 retval = -ENOSPC;
640 if (retval == -EIO)
641 STps->drv_block = -1;
643 STbuffer->writing = 0;
645 DEB(if (debugging && retval)
646 printk(ST_DEB_MSG "%s: Async write error %x, return value %d.\n",
647 tape_name(STp), STbuffer->cmdstat.midlevel_result, retval);) /* end DEB */
649 return retval;
653 /* Step over EOF if it has been inadvertently crossed (ioctl not used because
654 it messes up the block number). */
655 static int cross_eof(struct scsi_tape * STp, int forward)
657 struct st_request *SRpnt;
658 unsigned char cmd[MAX_COMMAND_SIZE];
660 cmd[0] = SPACE;
661 cmd[1] = 0x01; /* Space FileMarks */
662 if (forward) {
663 cmd[2] = cmd[3] = 0;
664 cmd[4] = 1;
665 } else
666 cmd[2] = cmd[3] = cmd[4] = 0xff; /* -1 filemarks */
667 cmd[5] = 0;
669 DEBC(printk(ST_DEB_MSG "%s: Stepping over filemark %s.\n",
670 tape_name(STp), forward ? "forward" : "backward"));
672 SRpnt = st_do_scsi(NULL, STp, cmd, 0, DMA_NONE,
673 STp->device->request_queue->rq_timeout,
674 MAX_RETRIES, 1);
675 if (!SRpnt)
676 return (STp->buffer)->syscall_result;
678 st_release_request(SRpnt);
679 SRpnt = NULL;
681 if ((STp->buffer)->cmdstat.midlevel_result != 0)
682 printk(KERN_ERR "%s: Stepping over filemark %s failed.\n",
683 tape_name(STp), forward ? "forward" : "backward");
685 return (STp->buffer)->syscall_result;
689 /* Flush the write buffer (never need to write if variable blocksize). */
690 static int st_flush_write_buffer(struct scsi_tape * STp)
692 int transfer, blks;
693 int result;
694 unsigned char cmd[MAX_COMMAND_SIZE];
695 struct st_request *SRpnt;
696 struct st_partstat *STps;
698 result = write_behind_check(STp);
699 if (result)
700 return result;
702 result = 0;
703 if (STp->dirty == 1) {
705 transfer = STp->buffer->buffer_bytes;
706 DEBC(printk(ST_DEB_MSG "%s: Flushing %d bytes.\n",
707 tape_name(STp), transfer));
709 memset(cmd, 0, MAX_COMMAND_SIZE);
710 cmd[0] = WRITE_6;
711 cmd[1] = 1;
712 blks = transfer / STp->block_size;
713 cmd[2] = blks >> 16;
714 cmd[3] = blks >> 8;
715 cmd[4] = blks;
717 SRpnt = st_do_scsi(NULL, STp, cmd, transfer, DMA_TO_DEVICE,
718 STp->device->request_queue->rq_timeout,
719 MAX_WRITE_RETRIES, 1);
720 if (!SRpnt)
721 return (STp->buffer)->syscall_result;
723 STps = &(STp->ps[STp->partition]);
724 if ((STp->buffer)->syscall_result != 0) {
725 struct st_cmdstatus *cmdstatp = &STp->buffer->cmdstat;
727 if (cmdstatp->have_sense && !cmdstatp->deferred &&
728 (cmdstatp->flags & SENSE_EOM) &&
729 (cmdstatp->sense_hdr.sense_key == NO_SENSE ||
730 cmdstatp->sense_hdr.sense_key == RECOVERED_ERROR) &&
731 (!cmdstatp->remainder_valid ||
732 cmdstatp->uremainder64 == 0)) { /* All written at EOM early warning */
733 STp->dirty = 0;
734 (STp->buffer)->buffer_bytes = 0;
735 if (STps->drv_block >= 0)
736 STps->drv_block += blks;
737 result = (-ENOSPC);
738 } else {
739 printk(KERN_ERR "%s: Error on flush.\n",
740 tape_name(STp));
741 STps->drv_block = (-1);
742 result = (-EIO);
744 } else {
745 if (STps->drv_block >= 0)
746 STps->drv_block += blks;
747 STp->dirty = 0;
748 (STp->buffer)->buffer_bytes = 0;
750 st_release_request(SRpnt);
751 SRpnt = NULL;
753 return result;
757 /* Flush the tape buffer. The tape will be positioned correctly unless
758 seek_next is true. */
759 static int flush_buffer(struct scsi_tape *STp, int seek_next)
761 int backspace, result;
762 struct st_buffer *STbuffer;
763 struct st_partstat *STps;
765 STbuffer = STp->buffer;
768 * If there was a bus reset, block further access
769 * to this device.
771 if (STp->pos_unknown)
772 return (-EIO);
774 if (STp->ready != ST_READY)
775 return 0;
776 STps = &(STp->ps[STp->partition]);
777 if (STps->rw == ST_WRITING) /* Writing */
778 return st_flush_write_buffer(STp);
780 if (STp->block_size == 0)
781 return 0;
783 backspace = ((STp->buffer)->buffer_bytes +
784 (STp->buffer)->read_pointer) / STp->block_size -
785 ((STp->buffer)->read_pointer + STp->block_size - 1) /
786 STp->block_size;
787 (STp->buffer)->buffer_bytes = 0;
788 (STp->buffer)->read_pointer = 0;
789 result = 0;
790 if (!seek_next) {
791 if (STps->eof == ST_FM_HIT) {
792 result = cross_eof(STp, 0); /* Back over the EOF hit */
793 if (!result)
794 STps->eof = ST_NOEOF;
795 else {
796 if (STps->drv_file >= 0)
797 STps->drv_file++;
798 STps->drv_block = 0;
801 if (!result && backspace > 0)
802 result = st_int_ioctl(STp, MTBSR, backspace);
803 } else if (STps->eof == ST_FM_HIT) {
804 if (STps->drv_file >= 0)
805 STps->drv_file++;
806 STps->drv_block = 0;
807 STps->eof = ST_NOEOF;
809 return result;
813 /* Set the mode parameters */
814 static int set_mode_densblk(struct scsi_tape * STp, struct st_modedef * STm)
816 int set_it = 0;
817 unsigned long arg;
818 char *name = tape_name(STp);
820 if (!STp->density_changed &&
821 STm->default_density >= 0 &&
822 STm->default_density != STp->density) {
823 arg = STm->default_density;
824 set_it = 1;
825 } else
826 arg = STp->density;
827 arg <<= MT_ST_DENSITY_SHIFT;
828 if (!STp->blksize_changed &&
829 STm->default_blksize >= 0 &&
830 STm->default_blksize != STp->block_size) {
831 arg |= STm->default_blksize;
832 set_it = 1;
833 } else
834 arg |= STp->block_size;
835 if (set_it &&
836 st_int_ioctl(STp, SET_DENS_AND_BLK, arg)) {
837 printk(KERN_WARNING
838 "%s: Can't set default block size to %d bytes and density %x.\n",
839 name, STm->default_blksize, STm->default_density);
840 if (modes_defined)
841 return (-EINVAL);
843 return 0;
847 /* Lock or unlock the drive door. Don't use when st_request allocated. */
848 static int do_door_lock(struct scsi_tape * STp, int do_lock)
850 int retval, cmd;
851 DEB(char *name = tape_name(STp);)
854 cmd = do_lock ? SCSI_IOCTL_DOORLOCK : SCSI_IOCTL_DOORUNLOCK;
855 DEBC(printk(ST_DEB_MSG "%s: %socking drive door.\n", name,
856 do_lock ? "L" : "Unl"));
857 retval = scsi_ioctl(STp->device, cmd, NULL);
858 if (!retval) {
859 STp->door_locked = do_lock ? ST_LOCKED_EXPLICIT : ST_UNLOCKED;
861 else {
862 STp->door_locked = ST_LOCK_FAILS;
864 return retval;
868 /* Set the internal state after reset */
869 static void reset_state(struct scsi_tape *STp)
871 int i;
872 struct st_partstat *STps;
874 STp->pos_unknown = 0;
875 for (i = 0; i < ST_NBR_PARTITIONS; i++) {
876 STps = &(STp->ps[i]);
877 STps->rw = ST_IDLE;
878 STps->eof = ST_NOEOF;
879 STps->at_sm = 0;
880 STps->last_block_valid = 0;
881 STps->drv_block = -1;
882 STps->drv_file = -1;
884 if (STp->can_partitions) {
885 STp->partition = find_partition(STp);
886 if (STp->partition < 0)
887 STp->partition = 0;
888 STp->new_partition = STp->partition;
892 /* Test if the drive is ready. Returns either one of the codes below or a negative system
893 error code. */
894 #define CHKRES_READY 0
895 #define CHKRES_NEW_SESSION 1
896 #define CHKRES_NOT_READY 2
897 #define CHKRES_NO_TAPE 3
899 #define MAX_ATTENTIONS 10
901 static int test_ready(struct scsi_tape *STp, int do_wait)
903 int attentions, waits, max_wait, scode;
904 int retval = CHKRES_READY, new_session = 0;
905 unsigned char cmd[MAX_COMMAND_SIZE];
906 struct st_request *SRpnt = NULL;
907 struct st_cmdstatus *cmdstatp = &STp->buffer->cmdstat;
909 max_wait = do_wait ? ST_BLOCK_SECONDS : 0;
911 for (attentions=waits=0; ; ) {
912 memset((void *) &cmd[0], 0, MAX_COMMAND_SIZE);
913 cmd[0] = TEST_UNIT_READY;
914 SRpnt = st_do_scsi(SRpnt, STp, cmd, 0, DMA_NONE,
915 STp->long_timeout, MAX_READY_RETRIES, 1);
917 if (!SRpnt) {
918 retval = (STp->buffer)->syscall_result;
919 break;
922 if (cmdstatp->have_sense) {
924 scode = cmdstatp->sense_hdr.sense_key;
926 if (scode == UNIT_ATTENTION) { /* New media? */
927 new_session = 1;
928 if (attentions < MAX_ATTENTIONS) {
929 attentions++;
930 continue;
932 else {
933 retval = (-EIO);
934 break;
938 if (scode == NOT_READY) {
939 if (waits < max_wait) {
940 if (msleep_interruptible(1000)) {
941 retval = (-EINTR);
942 break;
944 waits++;
945 continue;
947 else {
948 if ((STp->device)->scsi_level >= SCSI_2 &&
949 cmdstatp->sense_hdr.asc == 0x3a) /* Check ASC */
950 retval = CHKRES_NO_TAPE;
951 else
952 retval = CHKRES_NOT_READY;
953 break;
958 retval = (STp->buffer)->syscall_result;
959 if (!retval)
960 retval = new_session ? CHKRES_NEW_SESSION : CHKRES_READY;
961 break;
964 if (SRpnt != NULL)
965 st_release_request(SRpnt);
966 return retval;
970 /* See if the drive is ready and gather information about the tape. Return values:
971 < 0 negative error code from errno.h
972 0 drive ready
973 1 drive not ready (possibly no tape)
975 static int check_tape(struct scsi_tape *STp, struct file *filp)
977 int i, retval, new_session = 0, do_wait;
978 unsigned char cmd[MAX_COMMAND_SIZE], saved_cleaning;
979 unsigned short st_flags = filp->f_flags;
980 struct st_request *SRpnt = NULL;
981 struct st_modedef *STm;
982 struct st_partstat *STps;
983 char *name = tape_name(STp);
984 struct inode *inode = filp->f_path.dentry->d_inode;
985 int mode = TAPE_MODE(inode);
987 STp->ready = ST_READY;
989 if (mode != STp->current_mode) {
990 DEBC(printk(ST_DEB_MSG "%s: Mode change from %d to %d.\n",
991 name, STp->current_mode, mode));
992 new_session = 1;
993 STp->current_mode = mode;
995 STm = &(STp->modes[STp->current_mode]);
997 saved_cleaning = STp->cleaning_req;
998 STp->cleaning_req = 0;
1000 do_wait = ((filp->f_flags & O_NONBLOCK) == 0);
1001 retval = test_ready(STp, do_wait);
1003 if (retval < 0)
1004 goto err_out;
1006 if (retval == CHKRES_NEW_SESSION) {
1007 STp->pos_unknown = 0;
1008 STp->partition = STp->new_partition = 0;
1009 if (STp->can_partitions)
1010 STp->nbr_partitions = 1; /* This guess will be updated later
1011 if necessary */
1012 for (i = 0; i < ST_NBR_PARTITIONS; i++) {
1013 STps = &(STp->ps[i]);
1014 STps->rw = ST_IDLE;
1015 STps->eof = ST_NOEOF;
1016 STps->at_sm = 0;
1017 STps->last_block_valid = 0;
1018 STps->drv_block = 0;
1019 STps->drv_file = 0;
1021 new_session = 1;
1023 else {
1024 STp->cleaning_req |= saved_cleaning;
1026 if (retval == CHKRES_NOT_READY || retval == CHKRES_NO_TAPE) {
1027 if (retval == CHKRES_NO_TAPE)
1028 STp->ready = ST_NO_TAPE;
1029 else
1030 STp->ready = ST_NOT_READY;
1032 STp->density = 0; /* Clear the erroneous "residue" */
1033 STp->write_prot = 0;
1034 STp->block_size = 0;
1035 STp->ps[0].drv_file = STp->ps[0].drv_block = (-1);
1036 STp->partition = STp->new_partition = 0;
1037 STp->door_locked = ST_UNLOCKED;
1038 return CHKRES_NOT_READY;
1042 if (STp->omit_blklims)
1043 STp->min_block = STp->max_block = (-1);
1044 else {
1045 memset((void *) &cmd[0], 0, MAX_COMMAND_SIZE);
1046 cmd[0] = READ_BLOCK_LIMITS;
1048 SRpnt = st_do_scsi(SRpnt, STp, cmd, 6, DMA_FROM_DEVICE,
1049 STp->device->request_queue->rq_timeout,
1050 MAX_READY_RETRIES, 1);
1051 if (!SRpnt) {
1052 retval = (STp->buffer)->syscall_result;
1053 goto err_out;
1056 if (!SRpnt->result && !STp->buffer->cmdstat.have_sense) {
1057 STp->max_block = ((STp->buffer)->b_data[1] << 16) |
1058 ((STp->buffer)->b_data[2] << 8) | (STp->buffer)->b_data[3];
1059 STp->min_block = ((STp->buffer)->b_data[4] << 8) |
1060 (STp->buffer)->b_data[5];
1061 if ( DEB( debugging || ) !STp->inited)
1062 printk(KERN_INFO
1063 "%s: Block limits %d - %d bytes.\n", name,
1064 STp->min_block, STp->max_block);
1065 } else {
1066 STp->min_block = STp->max_block = (-1);
1067 DEBC(printk(ST_DEB_MSG "%s: Can't read block limits.\n",
1068 name));
1072 memset((void *) &cmd[0], 0, MAX_COMMAND_SIZE);
1073 cmd[0] = MODE_SENSE;
1074 cmd[4] = 12;
1076 SRpnt = st_do_scsi(SRpnt, STp, cmd, 12, DMA_FROM_DEVICE,
1077 STp->device->request_queue->rq_timeout,
1078 MAX_READY_RETRIES, 1);
1079 if (!SRpnt) {
1080 retval = (STp->buffer)->syscall_result;
1081 goto err_out;
1084 if ((STp->buffer)->syscall_result != 0) {
1085 DEBC(printk(ST_DEB_MSG "%s: No Mode Sense.\n", name));
1086 STp->block_size = ST_DEFAULT_BLOCK; /* Educated guess (?) */
1087 (STp->buffer)->syscall_result = 0; /* Prevent error propagation */
1088 STp->drv_write_prot = 0;
1089 } else {
1090 DEBC(printk(ST_DEB_MSG
1091 "%s: Mode sense. Length %d, medium %x, WBS %x, BLL %d\n",
1092 name,
1093 (STp->buffer)->b_data[0], (STp->buffer)->b_data[1],
1094 (STp->buffer)->b_data[2], (STp->buffer)->b_data[3]));
1096 if ((STp->buffer)->b_data[3] >= 8) {
1097 STp->drv_buffer = ((STp->buffer)->b_data[2] >> 4) & 7;
1098 STp->density = (STp->buffer)->b_data[4];
1099 STp->block_size = (STp->buffer)->b_data[9] * 65536 +
1100 (STp->buffer)->b_data[10] * 256 + (STp->buffer)->b_data[11];
1101 DEBC(printk(ST_DEB_MSG
1102 "%s: Density %x, tape length: %x, drv buffer: %d\n",
1103 name, STp->density, (STp->buffer)->b_data[5] * 65536 +
1104 (STp->buffer)->b_data[6] * 256 + (STp->buffer)->b_data[7],
1105 STp->drv_buffer));
1107 STp->drv_write_prot = ((STp->buffer)->b_data[2] & 0x80) != 0;
1109 st_release_request(SRpnt);
1110 SRpnt = NULL;
1111 STp->inited = 1;
1113 if (STp->block_size > 0)
1114 (STp->buffer)->buffer_blocks =
1115 (STp->buffer)->buffer_size / STp->block_size;
1116 else
1117 (STp->buffer)->buffer_blocks = 1;
1118 (STp->buffer)->buffer_bytes = (STp->buffer)->read_pointer = 0;
1120 DEBC(printk(ST_DEB_MSG
1121 "%s: Block size: %d, buffer size: %d (%d blocks).\n", name,
1122 STp->block_size, (STp->buffer)->buffer_size,
1123 (STp->buffer)->buffer_blocks));
1125 if (STp->drv_write_prot) {
1126 STp->write_prot = 1;
1128 DEBC(printk(ST_DEB_MSG "%s: Write protected\n", name));
1130 if (do_wait &&
1131 ((st_flags & O_ACCMODE) == O_WRONLY ||
1132 (st_flags & O_ACCMODE) == O_RDWR)) {
1133 retval = (-EROFS);
1134 goto err_out;
1138 if (STp->can_partitions && STp->nbr_partitions < 1) {
1139 /* This code is reached when the device is opened for the first time
1140 after the driver has been initialized with tape in the drive and the
1141 partition support has been enabled. */
1142 DEBC(printk(ST_DEB_MSG
1143 "%s: Updating partition number in status.\n", name));
1144 if ((STp->partition = find_partition(STp)) < 0) {
1145 retval = STp->partition;
1146 goto err_out;
1148 STp->new_partition = STp->partition;
1149 STp->nbr_partitions = 1; /* This guess will be updated when necessary */
1152 if (new_session) { /* Change the drive parameters for the new mode */
1153 STp->density_changed = STp->blksize_changed = 0;
1154 STp->compression_changed = 0;
1155 if (!(STm->defaults_for_writes) &&
1156 (retval = set_mode_densblk(STp, STm)) < 0)
1157 goto err_out;
1159 if (STp->default_drvbuffer != 0xff) {
1160 if (st_int_ioctl(STp, MTSETDRVBUFFER, STp->default_drvbuffer))
1161 printk(KERN_WARNING
1162 "%s: Can't set default drive buffering to %d.\n",
1163 name, STp->default_drvbuffer);
1167 return CHKRES_READY;
1169 err_out:
1170 return retval;
1174 \f/* Open the device. Needs to take the BKL only because of incrementing the SCSI host
1175 module count. */
1176 static int st_open(struct inode *inode, struct file *filp)
1178 int i, retval = (-EIO);
1179 struct scsi_tape *STp;
1180 struct st_partstat *STps;
1181 int dev = TAPE_NR(inode);
1182 char *name;
1184 lock_kernel();
1186 * We really want to do nonseekable_open(inode, filp); here, but some
1187 * versions of tar incorrectly call lseek on tapes and bail out if that
1188 * fails. So we disallow pread() and pwrite(), but permit lseeks.
1190 filp->f_mode &= ~(FMODE_PREAD | FMODE_PWRITE);
1192 if (!(STp = scsi_tape_get(dev))) {
1193 unlock_kernel();
1194 return -ENXIO;
1197 write_lock(&st_dev_arr_lock);
1198 filp->private_data = STp;
1199 name = tape_name(STp);
1201 if (STp->in_use) {
1202 write_unlock(&st_dev_arr_lock);
1203 scsi_tape_put(STp);
1204 unlock_kernel();
1205 DEB( printk(ST_DEB_MSG "%s: Device already in use.\n", name); )
1206 return (-EBUSY);
1209 STp->in_use = 1;
1210 write_unlock(&st_dev_arr_lock);
1211 STp->rew_at_close = STp->autorew_dev = (iminor(inode) & 0x80) == 0;
1213 if (!scsi_block_when_processing_errors(STp->device)) {
1214 retval = (-ENXIO);
1215 goto err_out;
1218 /* See that we have at least a one page buffer available */
1219 if (!enlarge_buffer(STp->buffer, PAGE_SIZE, STp->restr_dma)) {
1220 printk(KERN_WARNING "%s: Can't allocate one page tape buffer.\n",
1221 name);
1222 retval = (-EOVERFLOW);
1223 goto err_out;
1226 (STp->buffer)->cleared = 0;
1227 (STp->buffer)->writing = 0;
1228 (STp->buffer)->syscall_result = 0;
1230 STp->write_prot = ((filp->f_flags & O_ACCMODE) == O_RDONLY);
1232 STp->dirty = 0;
1233 for (i = 0; i < ST_NBR_PARTITIONS; i++) {
1234 STps = &(STp->ps[i]);
1235 STps->rw = ST_IDLE;
1237 STp->try_dio_now = STp->try_dio;
1238 STp->recover_count = 0;
1239 DEB( STp->nbr_waits = STp->nbr_finished = 0;
1240 STp->nbr_requests = STp->nbr_dio = STp->nbr_pages = 0; )
1242 retval = check_tape(STp, filp);
1243 if (retval < 0)
1244 goto err_out;
1245 if ((filp->f_flags & O_NONBLOCK) == 0 &&
1246 retval != CHKRES_READY) {
1247 if (STp->ready == NO_TAPE)
1248 retval = (-ENOMEDIUM);
1249 else
1250 retval = (-EIO);
1251 goto err_out;
1253 unlock_kernel();
1254 return 0;
1256 err_out:
1257 normalize_buffer(STp->buffer);
1258 STp->in_use = 0;
1259 scsi_tape_put(STp);
1260 unlock_kernel();
1261 return retval;
1266 /* Flush the tape buffer before close */
1267 static int st_flush(struct file *filp, fl_owner_t id)
1269 int result = 0, result2;
1270 unsigned char cmd[MAX_COMMAND_SIZE];
1271 struct st_request *SRpnt;
1272 struct scsi_tape *STp = filp->private_data;
1273 struct st_modedef *STm = &(STp->modes[STp->current_mode]);
1274 struct st_partstat *STps = &(STp->ps[STp->partition]);
1275 char *name = tape_name(STp);
1277 if (file_count(filp) > 1)
1278 return 0;
1280 if (STps->rw == ST_WRITING && !STp->pos_unknown) {
1281 result = st_flush_write_buffer(STp);
1282 if (result != 0 && result != (-ENOSPC))
1283 goto out;
1286 if (STp->can_partitions &&
1287 (result2 = switch_partition(STp)) < 0) {
1288 DEBC(printk(ST_DEB_MSG
1289 "%s: switch_partition at close failed.\n", name));
1290 if (result == 0)
1291 result = result2;
1292 goto out;
1295 DEBC( if (STp->nbr_requests)
1296 printk(KERN_DEBUG "%s: Number of r/w requests %d, dio used in %d, pages %d.\n",
1297 name, STp->nbr_requests, STp->nbr_dio, STp->nbr_pages));
1299 if (STps->rw == ST_WRITING && !STp->pos_unknown) {
1300 struct st_cmdstatus *cmdstatp = &STp->buffer->cmdstat;
1302 DEBC(printk(ST_DEB_MSG "%s: Async write waits %d, finished %d.\n",
1303 name, STp->nbr_waits, STp->nbr_finished);
1306 memset(cmd, 0, MAX_COMMAND_SIZE);
1307 cmd[0] = WRITE_FILEMARKS;
1308 cmd[4] = 1 + STp->two_fm;
1310 SRpnt = st_do_scsi(NULL, STp, cmd, 0, DMA_NONE,
1311 STp->device->request_queue->rq_timeout,
1312 MAX_WRITE_RETRIES, 1);
1313 if (!SRpnt) {
1314 result = (STp->buffer)->syscall_result;
1315 goto out;
1318 if (STp->buffer->syscall_result == 0 ||
1319 (cmdstatp->have_sense && !cmdstatp->deferred &&
1320 (cmdstatp->flags & SENSE_EOM) &&
1321 (cmdstatp->sense_hdr.sense_key == NO_SENSE ||
1322 cmdstatp->sense_hdr.sense_key == RECOVERED_ERROR) &&
1323 (!cmdstatp->remainder_valid || cmdstatp->uremainder64 == 0))) {
1324 /* Write successful at EOM */
1325 st_release_request(SRpnt);
1326 SRpnt = NULL;
1327 if (STps->drv_file >= 0)
1328 STps->drv_file++;
1329 STps->drv_block = 0;
1330 if (STp->two_fm)
1331 cross_eof(STp, 0);
1332 STps->eof = ST_FM;
1334 else { /* Write error */
1335 st_release_request(SRpnt);
1336 SRpnt = NULL;
1337 printk(KERN_ERR "%s: Error on write filemark.\n", name);
1338 if (result == 0)
1339 result = (-EIO);
1342 DEBC(printk(ST_DEB_MSG "%s: Buffer flushed, %d EOF(s) written\n",
1343 name, cmd[4]));
1344 } else if (!STp->rew_at_close) {
1345 STps = &(STp->ps[STp->partition]);
1346 if (!STm->sysv || STps->rw != ST_READING) {
1347 if (STp->can_bsr)
1348 result = flush_buffer(STp, 0);
1349 else if (STps->eof == ST_FM_HIT) {
1350 result = cross_eof(STp, 0);
1351 if (result) {
1352 if (STps->drv_file >= 0)
1353 STps->drv_file++;
1354 STps->drv_block = 0;
1355 STps->eof = ST_FM;
1356 } else
1357 STps->eof = ST_NOEOF;
1359 } else if ((STps->eof == ST_NOEOF &&
1360 !(result = cross_eof(STp, 1))) ||
1361 STps->eof == ST_FM_HIT) {
1362 if (STps->drv_file >= 0)
1363 STps->drv_file++;
1364 STps->drv_block = 0;
1365 STps->eof = ST_FM;
1369 out:
1370 if (STp->rew_at_close) {
1371 result2 = st_int_ioctl(STp, MTREW, 1);
1372 if (result == 0)
1373 result = result2;
1375 return result;
1379 /* Close the device and release it. BKL is not needed: this is the only thread
1380 accessing this tape. */
1381 static int st_release(struct inode *inode, struct file *filp)
1383 int result = 0;
1384 struct scsi_tape *STp = filp->private_data;
1386 if (STp->door_locked == ST_LOCKED_AUTO)
1387 do_door_lock(STp, 0);
1389 normalize_buffer(STp->buffer);
1390 write_lock(&st_dev_arr_lock);
1391 STp->in_use = 0;
1392 write_unlock(&st_dev_arr_lock);
1393 scsi_tape_put(STp);
1395 return result;
1398 /* The checks common to both reading and writing */
1399 static ssize_t rw_checks(struct scsi_tape *STp, struct file *filp, size_t count)
1401 ssize_t retval = 0;
1404 * If we are in the middle of error recovery, don't let anyone
1405 * else try and use this device. Also, if error recovery fails, it
1406 * may try and take the device offline, in which case all further
1407 * access to the device is prohibited.
1409 if (!scsi_block_when_processing_errors(STp->device)) {
1410 retval = (-ENXIO);
1411 goto out;
1414 if (STp->ready != ST_READY) {
1415 if (STp->ready == ST_NO_TAPE)
1416 retval = (-ENOMEDIUM);
1417 else
1418 retval = (-EIO);
1419 goto out;
1422 if (! STp->modes[STp->current_mode].defined) {
1423 retval = (-ENXIO);
1424 goto out;
1429 * If there was a bus reset, block further access
1430 * to this device.
1432 if (STp->pos_unknown) {
1433 retval = (-EIO);
1434 goto out;
1437 if (count == 0)
1438 goto out;
1440 DEB(
1441 if (!STp->in_use) {
1442 printk(ST_DEB_MSG "%s: Incorrect device.\n", tape_name(STp));
1443 retval = (-EIO);
1444 goto out;
1445 } ) /* end DEB */
1447 if (STp->can_partitions &&
1448 (retval = switch_partition(STp)) < 0)
1449 goto out;
1451 if (STp->block_size == 0 && STp->max_block > 0 &&
1452 (count < STp->min_block || count > STp->max_block)) {
1453 retval = (-EINVAL);
1454 goto out;
1457 if (STp->do_auto_lock && STp->door_locked == ST_UNLOCKED &&
1458 !do_door_lock(STp, 1))
1459 STp->door_locked = ST_LOCKED_AUTO;
1461 out:
1462 return retval;
1466 static int setup_buffering(struct scsi_tape *STp, const char __user *buf,
1467 size_t count, int is_read)
1469 int i, bufsize, retval = 0;
1470 struct st_buffer *STbp = STp->buffer;
1472 if (is_read)
1473 i = STp->try_dio_now && try_rdio;
1474 else
1475 i = STp->try_dio_now && try_wdio;
1477 if (i && ((unsigned long)buf & queue_dma_alignment(
1478 STp->device->request_queue)) == 0) {
1479 i = sgl_map_user_pages(STbp, STbp->use_sg, (unsigned long)buf,
1480 count, (is_read ? READ : WRITE));
1481 if (i > 0) {
1482 STbp->do_dio = i;
1483 STbp->buffer_bytes = 0; /* can be used as transfer counter */
1485 else
1486 STbp->do_dio = 0; /* fall back to buffering with any error */
1487 STbp->sg_segs = STbp->do_dio;
1488 DEB(
1489 if (STbp->do_dio) {
1490 STp->nbr_dio++;
1491 STp->nbr_pages += STbp->do_dio;
1494 } else
1495 STbp->do_dio = 0;
1496 DEB( STp->nbr_requests++; )
1498 if (!STbp->do_dio) {
1499 if (STp->block_size)
1500 bufsize = STp->block_size > st_fixed_buffer_size ?
1501 STp->block_size : st_fixed_buffer_size;
1502 else {
1503 bufsize = count;
1504 /* Make sure that data from previous user is not leaked even if
1505 HBA does not return correct residual */
1506 if (is_read && STp->sili && !STbp->cleared)
1507 clear_buffer(STbp);
1510 if (bufsize > STbp->buffer_size &&
1511 !enlarge_buffer(STbp, bufsize, STp->restr_dma)) {
1512 printk(KERN_WARNING "%s: Can't allocate %d byte tape buffer.\n",
1513 tape_name(STp), bufsize);
1514 retval = (-EOVERFLOW);
1515 goto out;
1517 if (STp->block_size)
1518 STbp->buffer_blocks = bufsize / STp->block_size;
1521 out:
1522 return retval;
1526 /* Can be called more than once after each setup_buffer() */
1527 static void release_buffering(struct scsi_tape *STp, int is_read)
1529 struct st_buffer *STbp;
1531 STbp = STp->buffer;
1532 if (STbp->do_dio) {
1533 sgl_unmap_user_pages(STbp, STbp->do_dio, is_read);
1534 STbp->do_dio = 0;
1535 STbp->sg_segs = 0;
1540 /* Write command */
1541 static ssize_t
1542 st_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
1544 ssize_t total;
1545 ssize_t i, do_count, blks, transfer;
1546 ssize_t retval;
1547 int undone, retry_eot = 0, scode;
1548 int async_write;
1549 unsigned char cmd[MAX_COMMAND_SIZE];
1550 const char __user *b_point;
1551 struct st_request *SRpnt = NULL;
1552 struct scsi_tape *STp = filp->private_data;
1553 struct st_modedef *STm;
1554 struct st_partstat *STps;
1555 struct st_buffer *STbp;
1556 char *name = tape_name(STp);
1558 if (mutex_lock_interruptible(&STp->lock))
1559 return -ERESTARTSYS;
1561 retval = rw_checks(STp, filp, count);
1562 if (retval || count == 0)
1563 goto out;
1565 /* Write must be integral number of blocks */
1566 if (STp->block_size != 0 && (count % STp->block_size) != 0) {
1567 printk(KERN_WARNING "%s: Write not multiple of tape block size.\n",
1568 name);
1569 retval = (-EINVAL);
1570 goto out;
1573 STm = &(STp->modes[STp->current_mode]);
1574 STps = &(STp->ps[STp->partition]);
1576 if (STp->write_prot) {
1577 retval = (-EACCES);
1578 goto out;
1582 if (STps->rw == ST_READING) {
1583 retval = flush_buffer(STp, 0);
1584 if (retval)
1585 goto out;
1586 STps->rw = ST_WRITING;
1587 } else if (STps->rw != ST_WRITING &&
1588 STps->drv_file == 0 && STps->drv_block == 0) {
1589 if ((retval = set_mode_densblk(STp, STm)) < 0)
1590 goto out;
1591 if (STm->default_compression != ST_DONT_TOUCH &&
1592 !(STp->compression_changed)) {
1593 if (st_compression(STp, (STm->default_compression == ST_YES))) {
1594 printk(KERN_WARNING "%s: Can't set default compression.\n",
1595 name);
1596 if (modes_defined) {
1597 retval = (-EINVAL);
1598 goto out;
1604 STbp = STp->buffer;
1605 i = write_behind_check(STp);
1606 if (i) {
1607 if (i == -ENOSPC)
1608 STps->eof = ST_EOM_OK;
1609 else
1610 STps->eof = ST_EOM_ERROR;
1613 if (STps->eof == ST_EOM_OK) {
1614 STps->eof = ST_EOD_1; /* allow next write */
1615 retval = (-ENOSPC);
1616 goto out;
1618 else if (STps->eof == ST_EOM_ERROR) {
1619 retval = (-EIO);
1620 goto out;
1623 /* Check the buffer readability in cases where copy_user might catch
1624 the problems after some tape movement. */
1625 if (STp->block_size != 0 &&
1626 !STbp->do_dio &&
1627 (copy_from_user(&i, buf, 1) != 0 ||
1628 copy_from_user(&i, buf + count - 1, 1) != 0)) {
1629 retval = (-EFAULT);
1630 goto out;
1633 retval = setup_buffering(STp, buf, count, 0);
1634 if (retval)
1635 goto out;
1637 total = count;
1639 memset(cmd, 0, MAX_COMMAND_SIZE);
1640 cmd[0] = WRITE_6;
1641 cmd[1] = (STp->block_size != 0);
1643 STps->rw = ST_WRITING;
1645 b_point = buf;
1646 while (count > 0 && !retry_eot) {
1648 if (STbp->do_dio) {
1649 do_count = count;
1651 else {
1652 if (STp->block_size == 0)
1653 do_count = count;
1654 else {
1655 do_count = STbp->buffer_blocks * STp->block_size -
1656 STbp->buffer_bytes;
1657 if (do_count > count)
1658 do_count = count;
1661 i = append_to_buffer(b_point, STbp, do_count);
1662 if (i) {
1663 retval = i;
1664 goto out;
1667 count -= do_count;
1668 b_point += do_count;
1670 async_write = STp->block_size == 0 && !STbp->do_dio &&
1671 STm->do_async_writes && STps->eof < ST_EOM_OK;
1673 if (STp->block_size != 0 && STm->do_buffer_writes &&
1674 !(STp->try_dio_now && try_wdio) && STps->eof < ST_EOM_OK &&
1675 STbp->buffer_bytes < STbp->buffer_size) {
1676 STp->dirty = 1;
1677 /* Don't write a buffer that is not full enough. */
1678 if (!async_write && count == 0)
1679 break;
1682 retry_write:
1683 if (STp->block_size == 0)
1684 blks = transfer = do_count;
1685 else {
1686 if (!STbp->do_dio)
1687 blks = STbp->buffer_bytes;
1688 else
1689 blks = do_count;
1690 blks /= STp->block_size;
1691 transfer = blks * STp->block_size;
1693 cmd[2] = blks >> 16;
1694 cmd[3] = blks >> 8;
1695 cmd[4] = blks;
1697 SRpnt = st_do_scsi(SRpnt, STp, cmd, transfer, DMA_TO_DEVICE,
1698 STp->device->request_queue->rq_timeout,
1699 MAX_WRITE_RETRIES, !async_write);
1700 if (!SRpnt) {
1701 retval = STbp->syscall_result;
1702 goto out;
1704 if (async_write && !STbp->syscall_result) {
1705 STbp->writing = transfer;
1706 STp->dirty = !(STbp->writing ==
1707 STbp->buffer_bytes);
1708 SRpnt = NULL; /* Prevent releasing this request! */
1709 DEB( STp->write_pending = 1; )
1710 break;
1713 if (STbp->syscall_result != 0) {
1714 struct st_cmdstatus *cmdstatp = &STp->buffer->cmdstat;
1716 DEBC(printk(ST_DEB_MSG "%s: Error on write:\n", name));
1717 if (cmdstatp->have_sense && (cmdstatp->flags & SENSE_EOM)) {
1718 scode = cmdstatp->sense_hdr.sense_key;
1719 if (cmdstatp->remainder_valid)
1720 undone = (int)cmdstatp->uremainder64;
1721 else if (STp->block_size == 0 &&
1722 scode == VOLUME_OVERFLOW)
1723 undone = transfer;
1724 else
1725 undone = 0;
1726 if (STp->block_size != 0)
1727 undone *= STp->block_size;
1728 if (undone <= do_count) {
1729 /* Only data from this write is not written */
1730 count += undone;
1731 b_point -= undone;
1732 do_count -= undone;
1733 if (STp->block_size)
1734 blks = (transfer - undone) / STp->block_size;
1735 STps->eof = ST_EOM_OK;
1736 /* Continue in fixed block mode if all written
1737 in this request but still something left to write
1738 (retval left to zero)
1740 if (STp->block_size == 0 ||
1741 undone > 0 || count == 0)
1742 retval = (-ENOSPC); /* EOM within current request */
1743 DEBC(printk(ST_DEB_MSG
1744 "%s: EOM with %d bytes unwritten.\n",
1745 name, (int)count));
1746 } else {
1747 /* EOT within data buffered earlier (possible only
1748 in fixed block mode without direct i/o) */
1749 if (!retry_eot && !cmdstatp->deferred &&
1750 (scode == NO_SENSE || scode == RECOVERED_ERROR)) {
1751 move_buffer_data(STp->buffer, transfer - undone);
1752 retry_eot = 1;
1753 if (STps->drv_block >= 0) {
1754 STps->drv_block += (transfer - undone) /
1755 STp->block_size;
1757 STps->eof = ST_EOM_OK;
1758 DEBC(printk(ST_DEB_MSG
1759 "%s: Retry write of %d bytes at EOM.\n",
1760 name, STp->buffer->buffer_bytes));
1761 goto retry_write;
1763 else {
1764 /* Either error within data buffered by driver or
1765 failed retry */
1766 count -= do_count;
1767 blks = do_count = 0;
1768 STps->eof = ST_EOM_ERROR;
1769 STps->drv_block = (-1); /* Too cautious? */
1770 retval = (-EIO); /* EOM for old data */
1771 DEBC(printk(ST_DEB_MSG
1772 "%s: EOM with lost data.\n",
1773 name));
1776 } else {
1777 count += do_count;
1778 STps->drv_block = (-1); /* Too cautious? */
1779 retval = STbp->syscall_result;
1784 if (STps->drv_block >= 0) {
1785 if (STp->block_size == 0)
1786 STps->drv_block += (do_count > 0);
1787 else
1788 STps->drv_block += blks;
1791 STbp->buffer_bytes = 0;
1792 STp->dirty = 0;
1794 if (retval || retry_eot) {
1795 if (count < total)
1796 retval = total - count;
1797 goto out;
1801 if (STps->eof == ST_EOD_1)
1802 STps->eof = ST_EOM_OK;
1803 else if (STps->eof != ST_EOM_OK)
1804 STps->eof = ST_NOEOF;
1805 retval = total - count;
1807 out:
1808 if (SRpnt != NULL)
1809 st_release_request(SRpnt);
1810 release_buffering(STp, 0);
1811 mutex_unlock(&STp->lock);
1813 return retval;
1816 /* Read data from the tape. Returns zero in the normal case, one if the
1817 eof status has changed, and the negative error code in case of a
1818 fatal error. Otherwise updates the buffer and the eof state.
1820 Does release user buffer mapping if it is set.
1822 static long read_tape(struct scsi_tape *STp, long count,
1823 struct st_request ** aSRpnt)
1825 int transfer, blks, bytes;
1826 unsigned char cmd[MAX_COMMAND_SIZE];
1827 struct st_request *SRpnt;
1828 struct st_modedef *STm;
1829 struct st_partstat *STps;
1830 struct st_buffer *STbp;
1831 int retval = 0;
1832 char *name = tape_name(STp);
1834 if (count == 0)
1835 return 0;
1837 STm = &(STp->modes[STp->current_mode]);
1838 STps = &(STp->ps[STp->partition]);
1839 if (STps->eof == ST_FM_HIT)
1840 return 1;
1841 STbp = STp->buffer;
1843 if (STp->block_size == 0)
1844 blks = bytes = count;
1845 else {
1846 if (!(STp->try_dio_now && try_rdio) && STm->do_read_ahead) {
1847 blks = (STp->buffer)->buffer_blocks;
1848 bytes = blks * STp->block_size;
1849 } else {
1850 bytes = count;
1851 if (!STbp->do_dio && bytes > (STp->buffer)->buffer_size)
1852 bytes = (STp->buffer)->buffer_size;
1853 blks = bytes / STp->block_size;
1854 bytes = blks * STp->block_size;
1858 memset(cmd, 0, MAX_COMMAND_SIZE);
1859 cmd[0] = READ_6;
1860 cmd[1] = (STp->block_size != 0);
1861 if (!cmd[1] && STp->sili)
1862 cmd[1] |= 2;
1863 cmd[2] = blks >> 16;
1864 cmd[3] = blks >> 8;
1865 cmd[4] = blks;
1867 SRpnt = *aSRpnt;
1868 SRpnt = st_do_scsi(SRpnt, STp, cmd, bytes, DMA_FROM_DEVICE,
1869 STp->device->request_queue->rq_timeout,
1870 MAX_RETRIES, 1);
1871 release_buffering(STp, 1);
1872 *aSRpnt = SRpnt;
1873 if (!SRpnt)
1874 return STbp->syscall_result;
1876 STbp->read_pointer = 0;
1877 STps->at_sm = 0;
1879 /* Something to check */
1880 if (STbp->syscall_result) {
1881 struct st_cmdstatus *cmdstatp = &STp->buffer->cmdstat;
1883 retval = 1;
1884 DEBC(printk(ST_DEB_MSG "%s: Sense: %2x %2x %2x %2x %2x %2x %2x %2x\n",
1885 name,
1886 SRpnt->sense[0], SRpnt->sense[1],
1887 SRpnt->sense[2], SRpnt->sense[3],
1888 SRpnt->sense[4], SRpnt->sense[5],
1889 SRpnt->sense[6], SRpnt->sense[7]));
1890 if (cmdstatp->have_sense) {
1892 if (cmdstatp->sense_hdr.sense_key == BLANK_CHECK)
1893 cmdstatp->flags &= 0xcf; /* No need for EOM in this case */
1895 if (cmdstatp->flags != 0) { /* EOF, EOM, or ILI */
1896 /* Compute the residual count */
1897 if (cmdstatp->remainder_valid)
1898 transfer = (int)cmdstatp->uremainder64;
1899 else
1900 transfer = 0;
1901 if (STp->block_size == 0 &&
1902 cmdstatp->sense_hdr.sense_key == MEDIUM_ERROR)
1903 transfer = bytes;
1905 if (cmdstatp->flags & SENSE_ILI) { /* ILI */
1906 if (STp->block_size == 0) {
1907 if (transfer <= 0) {
1908 if (transfer < 0)
1909 printk(KERN_NOTICE
1910 "%s: Failed to read %d byte block with %d byte transfer.\n",
1911 name, bytes - transfer, bytes);
1912 if (STps->drv_block >= 0)
1913 STps->drv_block += 1;
1914 STbp->buffer_bytes = 0;
1915 return (-ENOMEM);
1917 STbp->buffer_bytes = bytes - transfer;
1918 } else {
1919 st_release_request(SRpnt);
1920 SRpnt = *aSRpnt = NULL;
1921 if (transfer == blks) { /* We did not get anything, error */
1922 printk(KERN_NOTICE "%s: Incorrect block size.\n", name);
1923 if (STps->drv_block >= 0)
1924 STps->drv_block += blks - transfer + 1;
1925 st_int_ioctl(STp, MTBSR, 1);
1926 return (-EIO);
1928 /* We have some data, deliver it */
1929 STbp->buffer_bytes = (blks - transfer) *
1930 STp->block_size;
1931 DEBC(printk(ST_DEB_MSG
1932 "%s: ILI but enough data received %ld %d.\n",
1933 name, count, STbp->buffer_bytes));
1934 if (STps->drv_block >= 0)
1935 STps->drv_block += 1;
1936 if (st_int_ioctl(STp, MTBSR, 1))
1937 return (-EIO);
1939 } else if (cmdstatp->flags & SENSE_FMK) { /* FM overrides EOM */
1940 if (STps->eof != ST_FM_HIT)
1941 STps->eof = ST_FM_HIT;
1942 else
1943 STps->eof = ST_EOD_2;
1944 if (STp->block_size == 0)
1945 STbp->buffer_bytes = 0;
1946 else
1947 STbp->buffer_bytes =
1948 bytes - transfer * STp->block_size;
1949 DEBC(printk(ST_DEB_MSG
1950 "%s: EOF detected (%d bytes read).\n",
1951 name, STbp->buffer_bytes));
1952 } else if (cmdstatp->flags & SENSE_EOM) {
1953 if (STps->eof == ST_FM)
1954 STps->eof = ST_EOD_1;
1955 else
1956 STps->eof = ST_EOM_OK;
1957 if (STp->block_size == 0)
1958 STbp->buffer_bytes = bytes - transfer;
1959 else
1960 STbp->buffer_bytes =
1961 bytes - transfer * STp->block_size;
1963 DEBC(printk(ST_DEB_MSG "%s: EOM detected (%d bytes read).\n",
1964 name, STbp->buffer_bytes));
1967 /* end of EOF, EOM, ILI test */
1968 else { /* nonzero sense key */
1969 DEBC(printk(ST_DEB_MSG
1970 "%s: Tape error while reading.\n", name));
1971 STps->drv_block = (-1);
1972 if (STps->eof == ST_FM &&
1973 cmdstatp->sense_hdr.sense_key == BLANK_CHECK) {
1974 DEBC(printk(ST_DEB_MSG
1975 "%s: Zero returned for first BLANK CHECK after EOF.\n",
1976 name));
1977 STps->eof = ST_EOD_2; /* First BLANK_CHECK after FM */
1978 } else /* Some other extended sense code */
1979 retval = (-EIO);
1982 if (STbp->buffer_bytes < 0) /* Caused by bogus sense data */
1983 STbp->buffer_bytes = 0;
1985 /* End of extended sense test */
1986 else { /* Non-extended sense */
1987 retval = STbp->syscall_result;
1991 /* End of error handling */
1992 else { /* Read successful */
1993 STbp->buffer_bytes = bytes;
1994 if (STp->sili) /* In fixed block mode residual is always zero here */
1995 STbp->buffer_bytes -= STp->buffer->cmdstat.residual;
1998 if (STps->drv_block >= 0) {
1999 if (STp->block_size == 0)
2000 STps->drv_block++;
2001 else
2002 STps->drv_block += STbp->buffer_bytes / STp->block_size;
2004 return retval;
2008 /* Read command */
2009 static ssize_t
2010 st_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
2012 ssize_t total;
2013 ssize_t retval = 0;
2014 ssize_t i, transfer;
2015 int special, do_dio = 0;
2016 struct st_request *SRpnt = NULL;
2017 struct scsi_tape *STp = filp->private_data;
2018 struct st_modedef *STm;
2019 struct st_partstat *STps;
2020 struct st_buffer *STbp = STp->buffer;
2021 DEB( char *name = tape_name(STp); )
2023 if (mutex_lock_interruptible(&STp->lock))
2024 return -ERESTARTSYS;
2026 retval = rw_checks(STp, filp, count);
2027 if (retval || count == 0)
2028 goto out;
2030 STm = &(STp->modes[STp->current_mode]);
2031 if (STp->block_size != 0 && (count % STp->block_size) != 0) {
2032 if (!STm->do_read_ahead) {
2033 retval = (-EINVAL); /* Read must be integral number of blocks */
2034 goto out;
2036 STp->try_dio_now = 0; /* Direct i/o can't handle split blocks */
2039 STps = &(STp->ps[STp->partition]);
2040 if (STps->rw == ST_WRITING) {
2041 retval = flush_buffer(STp, 0);
2042 if (retval)
2043 goto out;
2044 STps->rw = ST_READING;
2046 DEB(
2047 if (debugging && STps->eof != ST_NOEOF)
2048 printk(ST_DEB_MSG "%s: EOF/EOM flag up (%d). Bytes %d\n", name,
2049 STps->eof, STbp->buffer_bytes);
2050 ) /* end DEB */
2052 retval = setup_buffering(STp, buf, count, 1);
2053 if (retval)
2054 goto out;
2055 do_dio = STbp->do_dio;
2057 if (STbp->buffer_bytes == 0 &&
2058 STps->eof >= ST_EOD_1) {
2059 if (STps->eof < ST_EOD) {
2060 STps->eof += 1;
2061 retval = 0;
2062 goto out;
2064 retval = (-EIO); /* EOM or Blank Check */
2065 goto out;
2068 if (do_dio) {
2069 /* Check the buffer writability before any tape movement. Don't alter
2070 buffer data. */
2071 if (copy_from_user(&i, buf, 1) != 0 ||
2072 copy_to_user(buf, &i, 1) != 0 ||
2073 copy_from_user(&i, buf + count - 1, 1) != 0 ||
2074 copy_to_user(buf + count - 1, &i, 1) != 0) {
2075 retval = (-EFAULT);
2076 goto out;
2080 STps->rw = ST_READING;
2083 /* Loop until enough data in buffer or a special condition found */
2084 for (total = 0, special = 0; total < count && !special;) {
2086 /* Get new data if the buffer is empty */
2087 if (STbp->buffer_bytes == 0) {
2088 special = read_tape(STp, count - total, &SRpnt);
2089 if (special < 0) { /* No need to continue read */
2090 retval = special;
2091 goto out;
2095 /* Move the data from driver buffer to user buffer */
2096 if (STbp->buffer_bytes > 0) {
2097 DEB(
2098 if (debugging && STps->eof != ST_NOEOF)
2099 printk(ST_DEB_MSG
2100 "%s: EOF up (%d). Left %d, needed %d.\n", name,
2101 STps->eof, STbp->buffer_bytes,
2102 (int)(count - total));
2103 ) /* end DEB */
2104 transfer = STbp->buffer_bytes < count - total ?
2105 STbp->buffer_bytes : count - total;
2106 if (!do_dio) {
2107 i = from_buffer(STbp, buf, transfer);
2108 if (i) {
2109 retval = i;
2110 goto out;
2113 buf += transfer;
2114 total += transfer;
2117 if (STp->block_size == 0)
2118 break; /* Read only one variable length block */
2120 } /* for (total = 0, special = 0;
2121 total < count && !special; ) */
2123 /* Change the eof state if no data from tape or buffer */
2124 if (total == 0) {
2125 if (STps->eof == ST_FM_HIT) {
2126 STps->eof = ST_FM;
2127 STps->drv_block = 0;
2128 if (STps->drv_file >= 0)
2129 STps->drv_file++;
2130 } else if (STps->eof == ST_EOD_1) {
2131 STps->eof = ST_EOD_2;
2132 STps->drv_block = 0;
2133 if (STps->drv_file >= 0)
2134 STps->drv_file++;
2135 } else if (STps->eof == ST_EOD_2)
2136 STps->eof = ST_EOD;
2137 } else if (STps->eof == ST_FM)
2138 STps->eof = ST_NOEOF;
2139 retval = total;
2141 out:
2142 if (SRpnt != NULL) {
2143 st_release_request(SRpnt);
2144 SRpnt = NULL;
2146 if (do_dio) {
2147 release_buffering(STp, 1);
2148 STbp->buffer_bytes = 0;
2150 mutex_unlock(&STp->lock);
2152 return retval;
2157 DEB(
2158 /* Set the driver options */
2159 static void st_log_options(struct scsi_tape * STp, struct st_modedef * STm, char *name)
2161 if (debugging) {
2162 printk(KERN_INFO
2163 "%s: Mode %d options: buffer writes: %d, async writes: %d, read ahead: %d\n",
2164 name, STp->current_mode, STm->do_buffer_writes, STm->do_async_writes,
2165 STm->do_read_ahead);
2166 printk(KERN_INFO
2167 "%s: can bsr: %d, two FMs: %d, fast mteom: %d, auto lock: %d,\n",
2168 name, STp->can_bsr, STp->two_fm, STp->fast_mteom, STp->do_auto_lock);
2169 printk(KERN_INFO
2170 "%s: defs for wr: %d, no block limits: %d, partitions: %d, s2 log: %d\n",
2171 name, STm->defaults_for_writes, STp->omit_blklims, STp->can_partitions,
2172 STp->scsi2_logical);
2173 printk(KERN_INFO
2174 "%s: sysv: %d nowait: %d sili: %d\n", name, STm->sysv, STp->immediate,
2175 STp->sili);
2176 printk(KERN_INFO "%s: debugging: %d\n",
2177 name, debugging);
2183 static int st_set_options(struct scsi_tape *STp, long options)
2185 int value;
2186 long code;
2187 struct st_modedef *STm;
2188 char *name = tape_name(STp);
2189 struct cdev *cd0, *cd1;
2191 STm = &(STp->modes[STp->current_mode]);
2192 if (!STm->defined) {
2193 cd0 = STm->cdevs[0]; cd1 = STm->cdevs[1];
2194 memcpy(STm, &(STp->modes[0]), sizeof(struct st_modedef));
2195 STm->cdevs[0] = cd0; STm->cdevs[1] = cd1;
2196 modes_defined = 1;
2197 DEBC(printk(ST_DEB_MSG
2198 "%s: Initialized mode %d definition from mode 0\n",
2199 name, STp->current_mode));
2202 code = options & MT_ST_OPTIONS;
2203 if (code == MT_ST_BOOLEANS) {
2204 STm->do_buffer_writes = (options & MT_ST_BUFFER_WRITES) != 0;
2205 STm->do_async_writes = (options & MT_ST_ASYNC_WRITES) != 0;
2206 STm->defaults_for_writes = (options & MT_ST_DEF_WRITES) != 0;
2207 STm->do_read_ahead = (options & MT_ST_READ_AHEAD) != 0;
2208 STp->two_fm = (options & MT_ST_TWO_FM) != 0;
2209 STp->fast_mteom = (options & MT_ST_FAST_MTEOM) != 0;
2210 STp->do_auto_lock = (options & MT_ST_AUTO_LOCK) != 0;
2211 STp->can_bsr = (options & MT_ST_CAN_BSR) != 0;
2212 STp->omit_blklims = (options & MT_ST_NO_BLKLIMS) != 0;
2213 if ((STp->device)->scsi_level >= SCSI_2)
2214 STp->can_partitions = (options & MT_ST_CAN_PARTITIONS) != 0;
2215 STp->scsi2_logical = (options & MT_ST_SCSI2LOGICAL) != 0;
2216 STp->immediate = (options & MT_ST_NOWAIT) != 0;
2217 STm->sysv = (options & MT_ST_SYSV) != 0;
2218 STp->sili = (options & MT_ST_SILI) != 0;
2219 DEB( debugging = (options & MT_ST_DEBUGGING) != 0;
2220 st_log_options(STp, STm, name); )
2221 } else if (code == MT_ST_SETBOOLEANS || code == MT_ST_CLEARBOOLEANS) {
2222 value = (code == MT_ST_SETBOOLEANS);
2223 if ((options & MT_ST_BUFFER_WRITES) != 0)
2224 STm->do_buffer_writes = value;
2225 if ((options & MT_ST_ASYNC_WRITES) != 0)
2226 STm->do_async_writes = value;
2227 if ((options & MT_ST_DEF_WRITES) != 0)
2228 STm->defaults_for_writes = value;
2229 if ((options & MT_ST_READ_AHEAD) != 0)
2230 STm->do_read_ahead = value;
2231 if ((options & MT_ST_TWO_FM) != 0)
2232 STp->two_fm = value;
2233 if ((options & MT_ST_FAST_MTEOM) != 0)
2234 STp->fast_mteom = value;
2235 if ((options & MT_ST_AUTO_LOCK) != 0)
2236 STp->do_auto_lock = value;
2237 if ((options & MT_ST_CAN_BSR) != 0)
2238 STp->can_bsr = value;
2239 if ((options & MT_ST_NO_BLKLIMS) != 0)
2240 STp->omit_blklims = value;
2241 if ((STp->device)->scsi_level >= SCSI_2 &&
2242 (options & MT_ST_CAN_PARTITIONS) != 0)
2243 STp->can_partitions = value;
2244 if ((options & MT_ST_SCSI2LOGICAL) != 0)
2245 STp->scsi2_logical = value;
2246 if ((options & MT_ST_NOWAIT) != 0)
2247 STp->immediate = value;
2248 if ((options & MT_ST_SYSV) != 0)
2249 STm->sysv = value;
2250 if ((options & MT_ST_SILI) != 0)
2251 STp->sili = value;
2252 DEB(
2253 if ((options & MT_ST_DEBUGGING) != 0)
2254 debugging = value;
2255 st_log_options(STp, STm, name); )
2256 } else if (code == MT_ST_WRITE_THRESHOLD) {
2257 /* Retained for compatibility */
2258 } else if (code == MT_ST_DEF_BLKSIZE) {
2259 value = (options & ~MT_ST_OPTIONS);
2260 if (value == ~MT_ST_OPTIONS) {
2261 STm->default_blksize = (-1);
2262 DEBC( printk(KERN_INFO "%s: Default block size disabled.\n", name));
2263 } else {
2264 STm->default_blksize = value;
2265 DEBC( printk(KERN_INFO "%s: Default block size set to %d bytes.\n",
2266 name, STm->default_blksize));
2267 if (STp->ready == ST_READY) {
2268 STp->blksize_changed = 0;
2269 set_mode_densblk(STp, STm);
2272 } else if (code == MT_ST_TIMEOUTS) {
2273 value = (options & ~MT_ST_OPTIONS);
2274 if ((value & MT_ST_SET_LONG_TIMEOUT) != 0) {
2275 STp->long_timeout = (value & ~MT_ST_SET_LONG_TIMEOUT) * HZ;
2276 DEBC( printk(KERN_INFO "%s: Long timeout set to %d seconds.\n", name,
2277 (value & ~MT_ST_SET_LONG_TIMEOUT)));
2278 } else {
2279 blk_queue_rq_timeout(STp->device->request_queue,
2280 value * HZ);
2281 DEBC( printk(KERN_INFO "%s: Normal timeout set to %d seconds.\n",
2282 name, value) );
2284 } else if (code == MT_ST_SET_CLN) {
2285 value = (options & ~MT_ST_OPTIONS) & 0xff;
2286 if (value != 0 &&
2287 value < EXTENDED_SENSE_START && value >= SCSI_SENSE_BUFFERSIZE)
2288 return (-EINVAL);
2289 STp->cln_mode = value;
2290 STp->cln_sense_mask = (options >> 8) & 0xff;
2291 STp->cln_sense_value = (options >> 16) & 0xff;
2292 printk(KERN_INFO
2293 "%s: Cleaning request mode %d, mask %02x, value %02x\n",
2294 name, value, STp->cln_sense_mask, STp->cln_sense_value);
2295 } else if (code == MT_ST_DEF_OPTIONS) {
2296 code = (options & ~MT_ST_CLEAR_DEFAULT);
2297 value = (options & MT_ST_CLEAR_DEFAULT);
2298 if (code == MT_ST_DEF_DENSITY) {
2299 if (value == MT_ST_CLEAR_DEFAULT) {
2300 STm->default_density = (-1);
2301 DEBC( printk(KERN_INFO "%s: Density default disabled.\n",
2302 name));
2303 } else {
2304 STm->default_density = value & 0xff;
2305 DEBC( printk(KERN_INFO "%s: Density default set to %x\n",
2306 name, STm->default_density));
2307 if (STp->ready == ST_READY) {
2308 STp->density_changed = 0;
2309 set_mode_densblk(STp, STm);
2312 } else if (code == MT_ST_DEF_DRVBUFFER) {
2313 if (value == MT_ST_CLEAR_DEFAULT) {
2314 STp->default_drvbuffer = 0xff;
2315 DEBC( printk(KERN_INFO
2316 "%s: Drive buffer default disabled.\n", name));
2317 } else {
2318 STp->default_drvbuffer = value & 7;
2319 DEBC( printk(KERN_INFO
2320 "%s: Drive buffer default set to %x\n",
2321 name, STp->default_drvbuffer));
2322 if (STp->ready == ST_READY)
2323 st_int_ioctl(STp, MTSETDRVBUFFER, STp->default_drvbuffer);
2325 } else if (code == MT_ST_DEF_COMPRESSION) {
2326 if (value == MT_ST_CLEAR_DEFAULT) {
2327 STm->default_compression = ST_DONT_TOUCH;
2328 DEBC( printk(KERN_INFO
2329 "%s: Compression default disabled.\n", name));
2330 } else {
2331 if ((value & 0xff00) != 0) {
2332 STp->c_algo = (value & 0xff00) >> 8;
2333 DEBC( printk(KERN_INFO "%s: Compression algorithm set to 0x%x.\n",
2334 name, STp->c_algo));
2336 if ((value & 0xff) != 0xff) {
2337 STm->default_compression = (value & 1 ? ST_YES : ST_NO);
2338 DEBC( printk(KERN_INFO "%s: Compression default set to %x\n",
2339 name, (value & 1)));
2340 if (STp->ready == ST_READY) {
2341 STp->compression_changed = 0;
2342 st_compression(STp, (STm->default_compression == ST_YES));
2347 } else
2348 return (-EIO);
2350 return 0;
2353 #define MODE_HEADER_LENGTH 4
2355 /* Mode header and page byte offsets */
2356 #define MH_OFF_DATA_LENGTH 0
2357 #define MH_OFF_MEDIUM_TYPE 1
2358 #define MH_OFF_DEV_SPECIFIC 2
2359 #define MH_OFF_BDESCS_LENGTH 3
2360 #define MP_OFF_PAGE_NBR 0
2361 #define MP_OFF_PAGE_LENGTH 1
2363 /* Mode header and page bit masks */
2364 #define MH_BIT_WP 0x80
2365 #define MP_MSK_PAGE_NBR 0x3f
2367 /* Don't return block descriptors */
2368 #define MODE_SENSE_OMIT_BDESCS 0x08
2370 #define MODE_SELECT_PAGE_FORMAT 0x10
2372 /* Read a mode page into the tape buffer. The block descriptors are included
2373 if incl_block_descs is true. The page control is ored to the page number
2374 parameter, if necessary. */
2375 static int read_mode_page(struct scsi_tape *STp, int page, int omit_block_descs)
2377 unsigned char cmd[MAX_COMMAND_SIZE];
2378 struct st_request *SRpnt;
2380 memset(cmd, 0, MAX_COMMAND_SIZE);
2381 cmd[0] = MODE_SENSE;
2382 if (omit_block_descs)
2383 cmd[1] = MODE_SENSE_OMIT_BDESCS;
2384 cmd[2] = page;
2385 cmd[4] = 255;
2387 SRpnt = st_do_scsi(NULL, STp, cmd, cmd[4], DMA_FROM_DEVICE,
2388 STp->device->request_queue->rq_timeout, 0, 1);
2389 if (SRpnt == NULL)
2390 return (STp->buffer)->syscall_result;
2392 st_release_request(SRpnt);
2394 return STp->buffer->syscall_result;
2398 /* Send the mode page in the tape buffer to the drive. Assumes that the mode data
2399 in the buffer is correctly formatted. The long timeout is used if slow is non-zero. */
2400 static int write_mode_page(struct scsi_tape *STp, int page, int slow)
2402 int pgo;
2403 unsigned char cmd[MAX_COMMAND_SIZE];
2404 struct st_request *SRpnt;
2405 int timeout;
2407 memset(cmd, 0, MAX_COMMAND_SIZE);
2408 cmd[0] = MODE_SELECT;
2409 cmd[1] = MODE_SELECT_PAGE_FORMAT;
2410 pgo = MODE_HEADER_LENGTH + (STp->buffer)->b_data[MH_OFF_BDESCS_LENGTH];
2411 cmd[4] = pgo + (STp->buffer)->b_data[pgo + MP_OFF_PAGE_LENGTH] + 2;
2413 /* Clear reserved fields */
2414 (STp->buffer)->b_data[MH_OFF_DATA_LENGTH] = 0;
2415 (STp->buffer)->b_data[MH_OFF_MEDIUM_TYPE] = 0;
2416 (STp->buffer)->b_data[MH_OFF_DEV_SPECIFIC] &= ~MH_BIT_WP;
2417 (STp->buffer)->b_data[pgo + MP_OFF_PAGE_NBR] &= MP_MSK_PAGE_NBR;
2419 timeout = slow ?
2420 STp->long_timeout : STp->device->request_queue->rq_timeout;
2421 SRpnt = st_do_scsi(NULL, STp, cmd, cmd[4], DMA_TO_DEVICE,
2422 timeout, 0, 1);
2423 if (SRpnt == NULL)
2424 return (STp->buffer)->syscall_result;
2426 st_release_request(SRpnt);
2428 return STp->buffer->syscall_result;
2432 #define COMPRESSION_PAGE 0x0f
2433 #define COMPRESSION_PAGE_LENGTH 16
2435 #define CP_OFF_DCE_DCC 2
2436 #define CP_OFF_C_ALGO 7
2438 #define DCE_MASK 0x80
2439 #define DCC_MASK 0x40
2440 #define RED_MASK 0x60
2443 /* Control the compression with mode page 15. Algorithm not changed if zero.
2445 The block descriptors are read and written because Sony SDT-7000 does not
2446 work without this (suggestion from Michael Schaefer <Michael.Schaefer@dlr.de>).
2447 Including block descriptors should not cause any harm to other drives. */
2449 static int st_compression(struct scsi_tape * STp, int state)
2451 int retval;
2452 int mpoffs; /* Offset to mode page start */
2453 unsigned char *b_data = (STp->buffer)->b_data;
2454 DEB( char *name = tape_name(STp); )
2456 if (STp->ready != ST_READY)
2457 return (-EIO);
2459 /* Read the current page contents */
2460 retval = read_mode_page(STp, COMPRESSION_PAGE, 0);
2461 if (retval) {
2462 DEBC(printk(ST_DEB_MSG "%s: Compression mode page not supported.\n",
2463 name));
2464 return (-EIO);
2467 mpoffs = MODE_HEADER_LENGTH + b_data[MH_OFF_BDESCS_LENGTH];
2468 DEBC(printk(ST_DEB_MSG "%s: Compression state is %d.\n", name,
2469 (b_data[mpoffs + CP_OFF_DCE_DCC] & DCE_MASK ? 1 : 0)));
2471 /* Check if compression can be changed */
2472 if ((b_data[mpoffs + CP_OFF_DCE_DCC] & DCC_MASK) == 0) {
2473 DEBC(printk(ST_DEB_MSG "%s: Compression not supported.\n", name));
2474 return (-EIO);
2477 /* Do the change */
2478 if (state) {
2479 b_data[mpoffs + CP_OFF_DCE_DCC] |= DCE_MASK;
2480 if (STp->c_algo != 0)
2481 b_data[mpoffs + CP_OFF_C_ALGO] = STp->c_algo;
2483 else {
2484 b_data[mpoffs + CP_OFF_DCE_DCC] &= ~DCE_MASK;
2485 if (STp->c_algo != 0)
2486 b_data[mpoffs + CP_OFF_C_ALGO] = 0; /* no compression */
2489 retval = write_mode_page(STp, COMPRESSION_PAGE, 0);
2490 if (retval) {
2491 DEBC(printk(ST_DEB_MSG "%s: Compression change failed.\n", name));
2492 return (-EIO);
2494 DEBC(printk(ST_DEB_MSG "%s: Compression state changed to %d.\n",
2495 name, state));
2497 STp->compression_changed = 1;
2498 return 0;
2502 /* Process the load and unload commands (does unload if the load code is zero) */
2503 static int do_load_unload(struct scsi_tape *STp, struct file *filp, int load_code)
2505 int retval = (-EIO), timeout;
2506 DEB( char *name = tape_name(STp); )
2507 unsigned char cmd[MAX_COMMAND_SIZE];
2508 struct st_partstat *STps;
2509 struct st_request *SRpnt;
2511 if (STp->ready != ST_READY && !load_code) {
2512 if (STp->ready == ST_NO_TAPE)
2513 return (-ENOMEDIUM);
2514 else
2515 return (-EIO);
2518 memset(cmd, 0, MAX_COMMAND_SIZE);
2519 cmd[0] = START_STOP;
2520 if (load_code)
2521 cmd[4] |= 1;
2523 * If arg >= 1 && arg <= 6 Enhanced load/unload in HP C1553A
2525 if (load_code >= 1 + MT_ST_HPLOADER_OFFSET
2526 && load_code <= 6 + MT_ST_HPLOADER_OFFSET) {
2527 DEBC(printk(ST_DEB_MSG "%s: Enhanced %sload slot %2d.\n",
2528 name, (cmd[4]) ? "" : "un",
2529 load_code - MT_ST_HPLOADER_OFFSET));
2530 cmd[3] = load_code - MT_ST_HPLOADER_OFFSET; /* MediaID field of C1553A */
2532 if (STp->immediate) {
2533 cmd[1] = 1; /* Don't wait for completion */
2534 timeout = STp->device->request_queue->rq_timeout;
2536 else
2537 timeout = STp->long_timeout;
2539 DEBC(
2540 if (!load_code)
2541 printk(ST_DEB_MSG "%s: Unloading tape.\n", name);
2542 else
2543 printk(ST_DEB_MSG "%s: Loading tape.\n", name);
2546 SRpnt = st_do_scsi(NULL, STp, cmd, 0, DMA_NONE,
2547 timeout, MAX_RETRIES, 1);
2548 if (!SRpnt)
2549 return (STp->buffer)->syscall_result;
2551 retval = (STp->buffer)->syscall_result;
2552 st_release_request(SRpnt);
2554 if (!retval) { /* SCSI command successful */
2556 if (!load_code) {
2557 STp->rew_at_close = 0;
2558 STp->ready = ST_NO_TAPE;
2560 else {
2561 STp->rew_at_close = STp->autorew_dev;
2562 retval = check_tape(STp, filp);
2563 if (retval > 0)
2564 retval = 0;
2567 else {
2568 STps = &(STp->ps[STp->partition]);
2569 STps->drv_file = STps->drv_block = (-1);
2572 return retval;
2575 #if DEBUG
2576 #define ST_DEB_FORWARD 0
2577 #define ST_DEB_BACKWARD 1
2578 static void deb_space_print(char *name, int direction, char *units, unsigned char *cmd)
2580 s32 sc;
2582 sc = cmd[2] & 0x80 ? 0xff000000 : 0;
2583 sc |= (cmd[2] << 16) | (cmd[3] << 8) | cmd[4];
2584 if (direction)
2585 sc = -sc;
2586 printk(ST_DEB_MSG "%s: Spacing tape %s over %d %s.\n", name,
2587 direction ? "backward" : "forward", sc, units);
2589 #endif
2592 /* Internal ioctl function */
2593 static int st_int_ioctl(struct scsi_tape *STp, unsigned int cmd_in, unsigned long arg)
2595 int timeout;
2596 long ltmp;
2597 int ioctl_result;
2598 int chg_eof = 1;
2599 unsigned char cmd[MAX_COMMAND_SIZE];
2600 struct st_request *SRpnt;
2601 struct st_partstat *STps;
2602 int fileno, blkno, at_sm, undone;
2603 int datalen = 0, direction = DMA_NONE;
2604 char *name = tape_name(STp);
2606 WARN_ON(STp->buffer->do_dio != 0);
2607 if (STp->ready != ST_READY) {
2608 if (STp->ready == ST_NO_TAPE)
2609 return (-ENOMEDIUM);
2610 else
2611 return (-EIO);
2613 timeout = STp->long_timeout;
2614 STps = &(STp->ps[STp->partition]);
2615 fileno = STps->drv_file;
2616 blkno = STps->drv_block;
2617 at_sm = STps->at_sm;
2619 memset(cmd, 0, MAX_COMMAND_SIZE);
2620 switch (cmd_in) {
2621 case MTFSFM:
2622 chg_eof = 0; /* Changed from the FSF after this */
2623 case MTFSF:
2624 cmd[0] = SPACE;
2625 cmd[1] = 0x01; /* Space FileMarks */
2626 cmd[2] = (arg >> 16);
2627 cmd[3] = (arg >> 8);
2628 cmd[4] = arg;
2629 DEBC(deb_space_print(name, ST_DEB_FORWARD, "filemarks", cmd);)
2630 if (fileno >= 0)
2631 fileno += arg;
2632 blkno = 0;
2633 at_sm &= (arg == 0);
2634 break;
2635 case MTBSFM:
2636 chg_eof = 0; /* Changed from the FSF after this */
2637 case MTBSF:
2638 cmd[0] = SPACE;
2639 cmd[1] = 0x01; /* Space FileMarks */
2640 ltmp = (-arg);
2641 cmd[2] = (ltmp >> 16);
2642 cmd[3] = (ltmp >> 8);
2643 cmd[4] = ltmp;
2644 DEBC(deb_space_print(name, ST_DEB_BACKWARD, "filemarks", cmd);)
2645 if (fileno >= 0)
2646 fileno -= arg;
2647 blkno = (-1); /* We can't know the block number */
2648 at_sm &= (arg == 0);
2649 break;
2650 case MTFSR:
2651 cmd[0] = SPACE;
2652 cmd[1] = 0x00; /* Space Blocks */
2653 cmd[2] = (arg >> 16);
2654 cmd[3] = (arg >> 8);
2655 cmd[4] = arg;
2656 DEBC(deb_space_print(name, ST_DEB_FORWARD, "blocks", cmd);)
2657 if (blkno >= 0)
2658 blkno += arg;
2659 at_sm &= (arg == 0);
2660 break;
2661 case MTBSR:
2662 cmd[0] = SPACE;
2663 cmd[1] = 0x00; /* Space Blocks */
2664 ltmp = (-arg);
2665 cmd[2] = (ltmp >> 16);
2666 cmd[3] = (ltmp >> 8);
2667 cmd[4] = ltmp;
2668 DEBC(deb_space_print(name, ST_DEB_BACKWARD, "blocks", cmd);)
2669 if (blkno >= 0)
2670 blkno -= arg;
2671 at_sm &= (arg == 0);
2672 break;
2673 case MTFSS:
2674 cmd[0] = SPACE;
2675 cmd[1] = 0x04; /* Space Setmarks */
2676 cmd[2] = (arg >> 16);
2677 cmd[3] = (arg >> 8);
2678 cmd[4] = arg;
2679 DEBC(deb_space_print(name, ST_DEB_FORWARD, "setmarks", cmd);)
2680 if (arg != 0) {
2681 blkno = fileno = (-1);
2682 at_sm = 1;
2684 break;
2685 case MTBSS:
2686 cmd[0] = SPACE;
2687 cmd[1] = 0x04; /* Space Setmarks */
2688 ltmp = (-arg);
2689 cmd[2] = (ltmp >> 16);
2690 cmd[3] = (ltmp >> 8);
2691 cmd[4] = ltmp;
2692 DEBC(deb_space_print(name, ST_DEB_BACKWARD, "setmarks", cmd);)
2693 if (arg != 0) {
2694 blkno = fileno = (-1);
2695 at_sm = 1;
2697 break;
2698 case MTWEOF:
2699 case MTWSM:
2700 if (STp->write_prot)
2701 return (-EACCES);
2702 cmd[0] = WRITE_FILEMARKS;
2703 if (cmd_in == MTWSM)
2704 cmd[1] = 2;
2705 cmd[2] = (arg >> 16);
2706 cmd[3] = (arg >> 8);
2707 cmd[4] = arg;
2708 timeout = STp->device->request_queue->rq_timeout;
2709 DEBC(
2710 if (cmd_in == MTWEOF)
2711 printk(ST_DEB_MSG "%s: Writing %d filemarks.\n", name,
2712 cmd[2] * 65536 + cmd[3] * 256 + cmd[4]);
2713 else
2714 printk(ST_DEB_MSG "%s: Writing %d setmarks.\n", name,
2715 cmd[2] * 65536 + cmd[3] * 256 + cmd[4]);
2717 if (fileno >= 0)
2718 fileno += arg;
2719 blkno = 0;
2720 at_sm = (cmd_in == MTWSM);
2721 break;
2722 case MTREW:
2723 cmd[0] = REZERO_UNIT;
2724 if (STp->immediate) {
2725 cmd[1] = 1; /* Don't wait for completion */
2726 timeout = STp->device->request_queue->rq_timeout;
2728 DEBC(printk(ST_DEB_MSG "%s: Rewinding tape.\n", name));
2729 fileno = blkno = at_sm = 0;
2730 break;
2731 case MTNOP:
2732 DEBC(printk(ST_DEB_MSG "%s: No op on tape.\n", name));
2733 return 0; /* Should do something ? */
2734 break;
2735 case MTRETEN:
2736 cmd[0] = START_STOP;
2737 if (STp->immediate) {
2738 cmd[1] = 1; /* Don't wait for completion */
2739 timeout = STp->device->request_queue->rq_timeout;
2741 cmd[4] = 3;
2742 DEBC(printk(ST_DEB_MSG "%s: Retensioning tape.\n", name));
2743 fileno = blkno = at_sm = 0;
2744 break;
2745 case MTEOM:
2746 if (!STp->fast_mteom) {
2747 /* space to the end of tape */
2748 ioctl_result = st_int_ioctl(STp, MTFSF, 0x7fffff);
2749 fileno = STps->drv_file;
2750 if (STps->eof >= ST_EOD_1)
2751 return 0;
2752 /* The next lines would hide the number of spaced FileMarks
2753 That's why I inserted the previous lines. I had no luck
2754 with detecting EOM with FSF, so we go now to EOM.
2755 Joerg Weule */
2756 } else
2757 fileno = (-1);
2758 cmd[0] = SPACE;
2759 cmd[1] = 3;
2760 DEBC(printk(ST_DEB_MSG "%s: Spacing to end of recorded medium.\n",
2761 name));
2762 blkno = -1;
2763 at_sm = 0;
2764 break;
2765 case MTERASE:
2766 if (STp->write_prot)
2767 return (-EACCES);
2768 cmd[0] = ERASE;
2769 cmd[1] = (arg ? 1 : 0); /* Long erase with non-zero argument */
2770 if (STp->immediate) {
2771 cmd[1] |= 2; /* Don't wait for completion */
2772 timeout = STp->device->request_queue->rq_timeout;
2774 else
2775 timeout = STp->long_timeout * 8;
2777 DEBC(printk(ST_DEB_MSG "%s: Erasing tape.\n", name));
2778 fileno = blkno = at_sm = 0;
2779 break;
2780 case MTSETBLK: /* Set block length */
2781 case MTSETDENSITY: /* Set tape density */
2782 case MTSETDRVBUFFER: /* Set drive buffering */
2783 case SET_DENS_AND_BLK: /* Set density and block size */
2784 chg_eof = 0;
2785 if (STp->dirty || (STp->buffer)->buffer_bytes != 0)
2786 return (-EIO); /* Not allowed if data in buffer */
2787 if ((cmd_in == MTSETBLK || cmd_in == SET_DENS_AND_BLK) &&
2788 (arg & MT_ST_BLKSIZE_MASK) != 0 &&
2789 STp->max_block > 0 &&
2790 ((arg & MT_ST_BLKSIZE_MASK) < STp->min_block ||
2791 (arg & MT_ST_BLKSIZE_MASK) > STp->max_block)) {
2792 printk(KERN_WARNING "%s: Illegal block size.\n", name);
2793 return (-EINVAL);
2795 cmd[0] = MODE_SELECT;
2796 if ((STp->use_pf & USE_PF))
2797 cmd[1] = MODE_SELECT_PAGE_FORMAT;
2798 cmd[4] = datalen = 12;
2799 direction = DMA_TO_DEVICE;
2801 memset((STp->buffer)->b_data, 0, 12);
2802 if (cmd_in == MTSETDRVBUFFER)
2803 (STp->buffer)->b_data[2] = (arg & 7) << 4;
2804 else
2805 (STp->buffer)->b_data[2] =
2806 STp->drv_buffer << 4;
2807 (STp->buffer)->b_data[3] = 8; /* block descriptor length */
2808 if (cmd_in == MTSETDENSITY) {
2809 (STp->buffer)->b_data[4] = arg;
2810 STp->density_changed = 1; /* At least we tried ;-) */
2811 } else if (cmd_in == SET_DENS_AND_BLK)
2812 (STp->buffer)->b_data[4] = arg >> 24;
2813 else
2814 (STp->buffer)->b_data[4] = STp->density;
2815 if (cmd_in == MTSETBLK || cmd_in == SET_DENS_AND_BLK) {
2816 ltmp = arg & MT_ST_BLKSIZE_MASK;
2817 if (cmd_in == MTSETBLK)
2818 STp->blksize_changed = 1; /* At least we tried ;-) */
2819 } else
2820 ltmp = STp->block_size;
2821 (STp->buffer)->b_data[9] = (ltmp >> 16);
2822 (STp->buffer)->b_data[10] = (ltmp >> 8);
2823 (STp->buffer)->b_data[11] = ltmp;
2824 timeout = STp->device->request_queue->rq_timeout;
2825 DEBC(
2826 if (cmd_in == MTSETBLK || cmd_in == SET_DENS_AND_BLK)
2827 printk(ST_DEB_MSG
2828 "%s: Setting block size to %d bytes.\n", name,
2829 (STp->buffer)->b_data[9] * 65536 +
2830 (STp->buffer)->b_data[10] * 256 +
2831 (STp->buffer)->b_data[11]);
2832 if (cmd_in == MTSETDENSITY || cmd_in == SET_DENS_AND_BLK)
2833 printk(ST_DEB_MSG
2834 "%s: Setting density code to %x.\n", name,
2835 (STp->buffer)->b_data[4]);
2836 if (cmd_in == MTSETDRVBUFFER)
2837 printk(ST_DEB_MSG
2838 "%s: Setting drive buffer code to %d.\n", name,
2839 ((STp->buffer)->b_data[2] >> 4) & 7);
2841 break;
2842 default:
2843 return (-ENOSYS);
2846 SRpnt = st_do_scsi(NULL, STp, cmd, datalen, direction,
2847 timeout, MAX_RETRIES, 1);
2848 if (!SRpnt)
2849 return (STp->buffer)->syscall_result;
2851 ioctl_result = (STp->buffer)->syscall_result;
2853 if (!ioctl_result) { /* SCSI command successful */
2854 st_release_request(SRpnt);
2855 SRpnt = NULL;
2856 STps->drv_block = blkno;
2857 STps->drv_file = fileno;
2858 STps->at_sm = at_sm;
2860 if (cmd_in == MTBSFM)
2861 ioctl_result = st_int_ioctl(STp, MTFSF, 1);
2862 else if (cmd_in == MTFSFM)
2863 ioctl_result = st_int_ioctl(STp, MTBSF, 1);
2865 if (cmd_in == MTSETBLK || cmd_in == SET_DENS_AND_BLK) {
2866 STp->block_size = arg & MT_ST_BLKSIZE_MASK;
2867 if (STp->block_size != 0) {
2868 (STp->buffer)->buffer_blocks =
2869 (STp->buffer)->buffer_size / STp->block_size;
2871 (STp->buffer)->buffer_bytes = (STp->buffer)->read_pointer = 0;
2872 if (cmd_in == SET_DENS_AND_BLK)
2873 STp->density = arg >> MT_ST_DENSITY_SHIFT;
2874 } else if (cmd_in == MTSETDRVBUFFER)
2875 STp->drv_buffer = (arg & 7);
2876 else if (cmd_in == MTSETDENSITY)
2877 STp->density = arg;
2879 if (cmd_in == MTEOM)
2880 STps->eof = ST_EOD;
2881 else if (cmd_in == MTFSF)
2882 STps->eof = ST_FM;
2883 else if (chg_eof)
2884 STps->eof = ST_NOEOF;
2886 if (cmd_in == MTWEOF)
2887 STps->rw = ST_IDLE;
2888 } else { /* SCSI command was not completely successful. Don't return
2889 from this block without releasing the SCSI command block! */
2890 struct st_cmdstatus *cmdstatp = &STp->buffer->cmdstat;
2892 if (cmdstatp->flags & SENSE_EOM) {
2893 if (cmd_in != MTBSF && cmd_in != MTBSFM &&
2894 cmd_in != MTBSR && cmd_in != MTBSS)
2895 STps->eof = ST_EOM_OK;
2896 STps->drv_block = 0;
2899 if (cmdstatp->remainder_valid)
2900 undone = (int)cmdstatp->uremainder64;
2901 else
2902 undone = 0;
2904 if (cmd_in == MTWEOF &&
2905 cmdstatp->have_sense &&
2906 (cmdstatp->flags & SENSE_EOM)) {
2907 if (cmdstatp->sense_hdr.sense_key == NO_SENSE ||
2908 cmdstatp->sense_hdr.sense_key == RECOVERED_ERROR) {
2909 ioctl_result = 0; /* EOF(s) written successfully at EOM */
2910 STps->eof = ST_NOEOF;
2911 } else { /* Writing EOF(s) failed */
2912 if (fileno >= 0)
2913 fileno -= undone;
2914 if (undone < arg)
2915 STps->eof = ST_NOEOF;
2917 STps->drv_file = fileno;
2918 } else if ((cmd_in == MTFSF) || (cmd_in == MTFSFM)) {
2919 if (fileno >= 0)
2920 STps->drv_file = fileno - undone;
2921 else
2922 STps->drv_file = fileno;
2923 STps->drv_block = -1;
2924 STps->eof = ST_NOEOF;
2925 } else if ((cmd_in == MTBSF) || (cmd_in == MTBSFM)) {
2926 if (arg > 0 && undone < 0) /* Some drives get this wrong */
2927 undone = (-undone);
2928 if (STps->drv_file >= 0)
2929 STps->drv_file = fileno + undone;
2930 STps->drv_block = 0;
2931 STps->eof = ST_NOEOF;
2932 } else if (cmd_in == MTFSR) {
2933 if (cmdstatp->flags & SENSE_FMK) { /* Hit filemark */
2934 if (STps->drv_file >= 0)
2935 STps->drv_file++;
2936 STps->drv_block = 0;
2937 STps->eof = ST_FM;
2938 } else {
2939 if (blkno >= undone)
2940 STps->drv_block = blkno - undone;
2941 else
2942 STps->drv_block = (-1);
2943 STps->eof = ST_NOEOF;
2945 } else if (cmd_in == MTBSR) {
2946 if (cmdstatp->flags & SENSE_FMK) { /* Hit filemark */
2947 STps->drv_file--;
2948 STps->drv_block = (-1);
2949 } else {
2950 if (arg > 0 && undone < 0) /* Some drives get this wrong */
2951 undone = (-undone);
2952 if (STps->drv_block >= 0)
2953 STps->drv_block = blkno + undone;
2955 STps->eof = ST_NOEOF;
2956 } else if (cmd_in == MTEOM) {
2957 STps->drv_file = (-1);
2958 STps->drv_block = (-1);
2959 STps->eof = ST_EOD;
2960 } else if (cmd_in == MTSETBLK ||
2961 cmd_in == MTSETDENSITY ||
2962 cmd_in == MTSETDRVBUFFER ||
2963 cmd_in == SET_DENS_AND_BLK) {
2964 if (cmdstatp->sense_hdr.sense_key == ILLEGAL_REQUEST &&
2965 !(STp->use_pf & PF_TESTED)) {
2966 /* Try the other possible state of Page Format if not
2967 already tried */
2968 STp->use_pf = (STp->use_pf ^ USE_PF) | PF_TESTED;
2969 st_release_request(SRpnt);
2970 SRpnt = NULL;
2971 return st_int_ioctl(STp, cmd_in, arg);
2973 } else if (chg_eof)
2974 STps->eof = ST_NOEOF;
2976 if (cmdstatp->sense_hdr.sense_key == BLANK_CHECK)
2977 STps->eof = ST_EOD;
2979 st_release_request(SRpnt);
2980 SRpnt = NULL;
2983 return ioctl_result;
2987 /* Get the tape position. If bt == 2, arg points into a kernel space mt_loc
2988 structure. */
2990 static int get_location(struct scsi_tape *STp, unsigned int *block, int *partition,
2991 int logical)
2993 int result;
2994 unsigned char scmd[MAX_COMMAND_SIZE];
2995 struct st_request *SRpnt;
2996 DEB( char *name = tape_name(STp); )
2998 if (STp->ready != ST_READY)
2999 return (-EIO);
3001 memset(scmd, 0, MAX_COMMAND_SIZE);
3002 if ((STp->device)->scsi_level < SCSI_2) {
3003 scmd[0] = QFA_REQUEST_BLOCK;
3004 scmd[4] = 3;
3005 } else {
3006 scmd[0] = READ_POSITION;
3007 if (!logical && !STp->scsi2_logical)
3008 scmd[1] = 1;
3010 SRpnt = st_do_scsi(NULL, STp, scmd, 20, DMA_FROM_DEVICE,
3011 STp->device->request_queue->rq_timeout,
3012 MAX_READY_RETRIES, 1);
3013 if (!SRpnt)
3014 return (STp->buffer)->syscall_result;
3016 if ((STp->buffer)->syscall_result != 0 ||
3017 (STp->device->scsi_level >= SCSI_2 &&
3018 ((STp->buffer)->b_data[0] & 4) != 0)) {
3019 *block = *partition = 0;
3020 DEBC(printk(ST_DEB_MSG "%s: Can't read tape position.\n", name));
3021 result = (-EIO);
3022 } else {
3023 result = 0;
3024 if ((STp->device)->scsi_level < SCSI_2) {
3025 *block = ((STp->buffer)->b_data[0] << 16)
3026 + ((STp->buffer)->b_data[1] << 8)
3027 + (STp->buffer)->b_data[2];
3028 *partition = 0;
3029 } else {
3030 *block = ((STp->buffer)->b_data[4] << 24)
3031 + ((STp->buffer)->b_data[5] << 16)
3032 + ((STp->buffer)->b_data[6] << 8)
3033 + (STp->buffer)->b_data[7];
3034 *partition = (STp->buffer)->b_data[1];
3035 if (((STp->buffer)->b_data[0] & 0x80) &&
3036 (STp->buffer)->b_data[1] == 0) /* BOP of partition 0 */
3037 STp->ps[0].drv_block = STp->ps[0].drv_file = 0;
3039 DEBC(printk(ST_DEB_MSG "%s: Got tape pos. blk %d part %d.\n", name,
3040 *block, *partition));
3042 st_release_request(SRpnt);
3043 SRpnt = NULL;
3045 return result;
3049 /* Set the tape block and partition. Negative partition means that only the
3050 block should be set in vendor specific way. */
3051 static int set_location(struct scsi_tape *STp, unsigned int block, int partition,
3052 int logical)
3054 struct st_partstat *STps;
3055 int result, p;
3056 unsigned int blk;
3057 int timeout;
3058 unsigned char scmd[MAX_COMMAND_SIZE];
3059 struct st_request *SRpnt;
3060 DEB( char *name = tape_name(STp); )
3062 if (STp->ready != ST_READY)
3063 return (-EIO);
3064 timeout = STp->long_timeout;
3065 STps = &(STp->ps[STp->partition]);
3067 DEBC(printk(ST_DEB_MSG "%s: Setting block to %d and partition to %d.\n",
3068 name, block, partition));
3069 DEB(if (partition < 0)
3070 return (-EIO); )
3072 /* Update the location at the partition we are leaving */
3073 if ((!STp->can_partitions && partition != 0) ||
3074 partition >= ST_NBR_PARTITIONS)
3075 return (-EINVAL);
3076 if (partition != STp->partition) {
3077 if (get_location(STp, &blk, &p, 1))
3078 STps->last_block_valid = 0;
3079 else {
3080 STps->last_block_valid = 1;
3081 STps->last_block_visited = blk;
3082 DEBC(printk(ST_DEB_MSG
3083 "%s: Visited block %d for partition %d saved.\n",
3084 name, blk, STp->partition));
3088 memset(scmd, 0, MAX_COMMAND_SIZE);
3089 if ((STp->device)->scsi_level < SCSI_2) {
3090 scmd[0] = QFA_SEEK_BLOCK;
3091 scmd[2] = (block >> 16);
3092 scmd[3] = (block >> 8);
3093 scmd[4] = block;
3094 scmd[5] = 0;
3095 } else {
3096 scmd[0] = SEEK_10;
3097 scmd[3] = (block >> 24);
3098 scmd[4] = (block >> 16);
3099 scmd[5] = (block >> 8);
3100 scmd[6] = block;
3101 if (!logical && !STp->scsi2_logical)
3102 scmd[1] = 4;
3103 if (STp->partition != partition) {
3104 scmd[1] |= 2;
3105 scmd[8] = partition;
3106 DEBC(printk(ST_DEB_MSG
3107 "%s: Trying to change partition from %d to %d\n",
3108 name, STp->partition, partition));
3111 if (STp->immediate) {
3112 scmd[1] |= 1; /* Don't wait for completion */
3113 timeout = STp->device->request_queue->rq_timeout;
3116 SRpnt = st_do_scsi(NULL, STp, scmd, 0, DMA_NONE,
3117 timeout, MAX_READY_RETRIES, 1);
3118 if (!SRpnt)
3119 return (STp->buffer)->syscall_result;
3121 STps->drv_block = STps->drv_file = (-1);
3122 STps->eof = ST_NOEOF;
3123 if ((STp->buffer)->syscall_result != 0) {
3124 result = (-EIO);
3125 if (STp->can_partitions &&
3126 (STp->device)->scsi_level >= SCSI_2 &&
3127 (p = find_partition(STp)) >= 0)
3128 STp->partition = p;
3129 } else {
3130 if (STp->can_partitions) {
3131 STp->partition = partition;
3132 STps = &(STp->ps[partition]);
3133 if (!STps->last_block_valid ||
3134 STps->last_block_visited != block) {
3135 STps->at_sm = 0;
3136 STps->rw = ST_IDLE;
3138 } else
3139 STps->at_sm = 0;
3140 if (block == 0)
3141 STps->drv_block = STps->drv_file = 0;
3142 result = 0;
3145 st_release_request(SRpnt);
3146 SRpnt = NULL;
3148 return result;
3152 /* Find the current partition number for the drive status. Called from open and
3153 returns either partition number of negative error code. */
3154 static int find_partition(struct scsi_tape *STp)
3156 int i, partition;
3157 unsigned int block;
3159 if ((i = get_location(STp, &block, &partition, 1)) < 0)
3160 return i;
3161 if (partition >= ST_NBR_PARTITIONS)
3162 return (-EIO);
3163 return partition;
3167 /* Change the partition if necessary */
3168 static int switch_partition(struct scsi_tape *STp)
3170 struct st_partstat *STps;
3172 if (STp->partition == STp->new_partition)
3173 return 0;
3174 STps = &(STp->ps[STp->new_partition]);
3175 if (!STps->last_block_valid)
3176 STps->last_block_visited = 0;
3177 return set_location(STp, STps->last_block_visited, STp->new_partition, 1);
3180 /* Functions for reading and writing the medium partition mode page. */
3182 #define PART_PAGE 0x11
3183 #define PART_PAGE_FIXED_LENGTH 8
3185 #define PP_OFF_MAX_ADD_PARTS 2
3186 #define PP_OFF_NBR_ADD_PARTS 3
3187 #define PP_OFF_FLAGS 4
3188 #define PP_OFF_PART_UNITS 6
3189 #define PP_OFF_RESERVED 7
3191 #define PP_BIT_IDP 0x20
3192 #define PP_MSK_PSUM_MB 0x10
3194 /* Get the number of partitions on the tape. As a side effect reads the
3195 mode page into the tape buffer. */
3196 static int nbr_partitions(struct scsi_tape *STp)
3198 int result;
3199 DEB( char *name = tape_name(STp); )
3201 if (STp->ready != ST_READY)
3202 return (-EIO);
3204 result = read_mode_page(STp, PART_PAGE, 1);
3206 if (result) {
3207 DEBC(printk(ST_DEB_MSG "%s: Can't read medium partition page.\n",
3208 name));
3209 result = (-EIO);
3210 } else {
3211 result = (STp->buffer)->b_data[MODE_HEADER_LENGTH +
3212 PP_OFF_NBR_ADD_PARTS] + 1;
3213 DEBC(printk(ST_DEB_MSG "%s: Number of partitions %d.\n", name, result));
3216 return result;
3220 /* Partition the tape into two partitions if size > 0 or one partition if
3221 size == 0.
3223 The block descriptors are read and written because Sony SDT-7000 does not
3224 work without this (suggestion from Michael Schaefer <Michael.Schaefer@dlr.de>).
3226 My HP C1533A drive returns only one partition size field. This is used to
3227 set the size of partition 1. There is no size field for the default partition.
3228 Michael Schaefer's Sony SDT-7000 returns two descriptors and the second is
3229 used to set the size of partition 1 (this is what the SCSI-3 standard specifies).
3230 The following algorithm is used to accommodate both drives: if the number of
3231 partition size fields is greater than the maximum number of additional partitions
3232 in the mode page, the second field is used. Otherwise the first field is used.
3234 For Seagate DDS drives the page length must be 8 when no partitions is defined
3235 and 10 when 1 partition is defined (information from Eric Lee Green). This is
3236 is acceptable also to some other old drives and enforced if the first partition
3237 size field is used for the first additional partition size.
3239 static int partition_tape(struct scsi_tape *STp, int size)
3241 char *name = tape_name(STp);
3242 int result;
3243 int pgo, psd_cnt, psdo;
3244 unsigned char *bp;
3246 result = read_mode_page(STp, PART_PAGE, 0);
3247 if (result) {
3248 DEBC(printk(ST_DEB_MSG "%s: Can't read partition mode page.\n", name));
3249 return result;
3251 /* The mode page is in the buffer. Let's modify it and write it. */
3252 bp = (STp->buffer)->b_data;
3253 pgo = MODE_HEADER_LENGTH + bp[MH_OFF_BDESCS_LENGTH];
3254 DEBC(printk(ST_DEB_MSG "%s: Partition page length is %d bytes.\n",
3255 name, bp[pgo + MP_OFF_PAGE_LENGTH] + 2));
3257 psd_cnt = (bp[pgo + MP_OFF_PAGE_LENGTH] + 2 - PART_PAGE_FIXED_LENGTH) / 2;
3258 psdo = pgo + PART_PAGE_FIXED_LENGTH;
3259 if (psd_cnt > bp[pgo + PP_OFF_MAX_ADD_PARTS]) {
3260 bp[psdo] = bp[psdo + 1] = 0xff; /* Rest of the tape */
3261 psdo += 2;
3263 memset(bp + psdo, 0, bp[pgo + PP_OFF_NBR_ADD_PARTS] * 2);
3265 DEBC(printk("%s: psd_cnt %d, max.parts %d, nbr_parts %d\n", name,
3266 psd_cnt, bp[pgo + PP_OFF_MAX_ADD_PARTS],
3267 bp[pgo + PP_OFF_NBR_ADD_PARTS]));
3269 if (size <= 0) {
3270 bp[pgo + PP_OFF_NBR_ADD_PARTS] = 0;
3271 if (psd_cnt <= bp[pgo + PP_OFF_MAX_ADD_PARTS])
3272 bp[pgo + MP_OFF_PAGE_LENGTH] = 6;
3273 DEBC(printk(ST_DEB_MSG "%s: Formatting tape with one partition.\n",
3274 name));
3275 } else {
3276 bp[psdo] = (size >> 8) & 0xff;
3277 bp[psdo + 1] = size & 0xff;
3278 bp[pgo + 3] = 1;
3279 if (bp[pgo + MP_OFF_PAGE_LENGTH] < 8)
3280 bp[pgo + MP_OFF_PAGE_LENGTH] = 8;
3281 DEBC(printk(ST_DEB_MSG
3282 "%s: Formatting tape with two partitions (1 = %d MB).\n",
3283 name, size));
3285 bp[pgo + PP_OFF_PART_UNITS] = 0;
3286 bp[pgo + PP_OFF_RESERVED] = 0;
3287 bp[pgo + PP_OFF_FLAGS] = PP_BIT_IDP | PP_MSK_PSUM_MB;
3289 result = write_mode_page(STp, PART_PAGE, 1);
3290 if (result) {
3291 printk(KERN_INFO "%s: Partitioning of tape failed.\n", name);
3292 result = (-EIO);
3295 return result;
3300 /* The ioctl command */
3301 static long st_ioctl(struct file *file, unsigned int cmd_in, unsigned long arg)
3303 int i, cmd_nr, cmd_type, bt;
3304 int retval = 0;
3305 unsigned int blk;
3306 struct scsi_tape *STp = file->private_data;
3307 struct st_modedef *STm;
3308 struct st_partstat *STps;
3309 char *name = tape_name(STp);
3310 void __user *p = (void __user *)arg;
3312 if (mutex_lock_interruptible(&STp->lock))
3313 return -ERESTARTSYS;
3315 DEB(
3316 if (debugging && !STp->in_use) {
3317 printk(ST_DEB_MSG "%s: Incorrect device.\n", name);
3318 retval = (-EIO);
3319 goto out;
3320 } ) /* end DEB */
3322 STm = &(STp->modes[STp->current_mode]);
3323 STps = &(STp->ps[STp->partition]);
3326 * If we are in the middle of error recovery, don't let anyone
3327 * else try and use this device. Also, if error recovery fails, it
3328 * may try and take the device offline, in which case all further
3329 * access to the device is prohibited.
3331 retval = scsi_nonblockable_ioctl(STp->device, cmd_in, p,
3332 file->f_flags & O_NDELAY);
3333 if (!scsi_block_when_processing_errors(STp->device) || retval != -ENODEV)
3334 goto out;
3335 retval = 0;
3337 cmd_type = _IOC_TYPE(cmd_in);
3338 cmd_nr = _IOC_NR(cmd_in);
3340 if (cmd_type == _IOC_TYPE(MTIOCTOP) && cmd_nr == _IOC_NR(MTIOCTOP)) {
3341 struct mtop mtc;
3343 if (_IOC_SIZE(cmd_in) != sizeof(mtc)) {
3344 retval = (-EINVAL);
3345 goto out;
3348 i = copy_from_user(&mtc, p, sizeof(struct mtop));
3349 if (i) {
3350 retval = (-EFAULT);
3351 goto out;
3354 if (mtc.mt_op == MTSETDRVBUFFER && !capable(CAP_SYS_ADMIN)) {
3355 printk(KERN_WARNING
3356 "%s: MTSETDRVBUFFER only allowed for root.\n", name);
3357 retval = (-EPERM);
3358 goto out;
3360 if (!STm->defined &&
3361 (mtc.mt_op != MTSETDRVBUFFER &&
3362 (mtc.mt_count & MT_ST_OPTIONS) == 0)) {
3363 retval = (-ENXIO);
3364 goto out;
3367 if (!STp->pos_unknown) {
3369 if (STps->eof == ST_FM_HIT) {
3370 if (mtc.mt_op == MTFSF || mtc.mt_op == MTFSFM ||
3371 mtc.mt_op == MTEOM) {
3372 mtc.mt_count -= 1;
3373 if (STps->drv_file >= 0)
3374 STps->drv_file += 1;
3375 } else if (mtc.mt_op == MTBSF || mtc.mt_op == MTBSFM) {
3376 mtc.mt_count += 1;
3377 if (STps->drv_file >= 0)
3378 STps->drv_file += 1;
3382 if (mtc.mt_op == MTSEEK) {
3383 /* Old position must be restored if partition will be
3384 changed */
3385 i = !STp->can_partitions ||
3386 (STp->new_partition != STp->partition);
3387 } else {
3388 i = mtc.mt_op == MTREW || mtc.mt_op == MTOFFL ||
3389 mtc.mt_op == MTRETEN || mtc.mt_op == MTEOM ||
3390 mtc.mt_op == MTLOCK || mtc.mt_op == MTLOAD ||
3391 mtc.mt_op == MTFSF || mtc.mt_op == MTFSFM ||
3392 mtc.mt_op == MTBSF || mtc.mt_op == MTBSFM ||
3393 mtc.mt_op == MTCOMPRESSION;
3395 i = flush_buffer(STp, i);
3396 if (i < 0) {
3397 retval = i;
3398 goto out;
3400 if (STps->rw == ST_WRITING &&
3401 (mtc.mt_op == MTREW || mtc.mt_op == MTOFFL ||
3402 mtc.mt_op == MTSEEK ||
3403 mtc.mt_op == MTBSF || mtc.mt_op == MTBSFM)) {
3404 i = st_int_ioctl(STp, MTWEOF, 1);
3405 if (i < 0) {
3406 retval = i;
3407 goto out;
3409 if (mtc.mt_op == MTBSF || mtc.mt_op == MTBSFM)
3410 mtc.mt_count++;
3411 STps->rw = ST_IDLE;
3414 } else {
3416 * If there was a bus reset, block further access
3417 * to this device. If the user wants to rewind the tape,
3418 * then reset the flag and allow access again.
3420 if (mtc.mt_op != MTREW &&
3421 mtc.mt_op != MTOFFL &&
3422 mtc.mt_op != MTRETEN &&
3423 mtc.mt_op != MTERASE &&
3424 mtc.mt_op != MTSEEK &&
3425 mtc.mt_op != MTEOM) {
3426 retval = (-EIO);
3427 goto out;
3429 reset_state(STp);
3430 /* remove this when the midlevel properly clears was_reset */
3431 STp->device->was_reset = 0;
3434 if (mtc.mt_op != MTNOP && mtc.mt_op != MTSETBLK &&
3435 mtc.mt_op != MTSETDENSITY && mtc.mt_op != MTWSM &&
3436 mtc.mt_op != MTSETDRVBUFFER && mtc.mt_op != MTSETPART)
3437 STps->rw = ST_IDLE; /* Prevent automatic WEOF and fsf */
3439 if (mtc.mt_op == MTOFFL && STp->door_locked != ST_UNLOCKED)
3440 do_door_lock(STp, 0); /* Ignore result! */
3442 if (mtc.mt_op == MTSETDRVBUFFER &&
3443 (mtc.mt_count & MT_ST_OPTIONS) != 0) {
3444 retval = st_set_options(STp, mtc.mt_count);
3445 goto out;
3448 if (mtc.mt_op == MTSETPART) {
3449 if (!STp->can_partitions ||
3450 mtc.mt_count < 0 || mtc.mt_count >= ST_NBR_PARTITIONS) {
3451 retval = (-EINVAL);
3452 goto out;
3454 if (mtc.mt_count >= STp->nbr_partitions &&
3455 (STp->nbr_partitions = nbr_partitions(STp)) < 0) {
3456 retval = (-EIO);
3457 goto out;
3459 if (mtc.mt_count >= STp->nbr_partitions) {
3460 retval = (-EINVAL);
3461 goto out;
3463 STp->new_partition = mtc.mt_count;
3464 retval = 0;
3465 goto out;
3468 if (mtc.mt_op == MTMKPART) {
3469 if (!STp->can_partitions) {
3470 retval = (-EINVAL);
3471 goto out;
3473 if ((i = st_int_ioctl(STp, MTREW, 0)) < 0 ||
3474 (i = partition_tape(STp, mtc.mt_count)) < 0) {
3475 retval = i;
3476 goto out;
3478 for (i = 0; i < ST_NBR_PARTITIONS; i++) {
3479 STp->ps[i].rw = ST_IDLE;
3480 STp->ps[i].at_sm = 0;
3481 STp->ps[i].last_block_valid = 0;
3483 STp->partition = STp->new_partition = 0;
3484 STp->nbr_partitions = 1; /* Bad guess ?-) */
3485 STps->drv_block = STps->drv_file = 0;
3486 retval = 0;
3487 goto out;
3490 if (mtc.mt_op == MTSEEK) {
3491 i = set_location(STp, mtc.mt_count, STp->new_partition, 0);
3492 if (!STp->can_partitions)
3493 STp->ps[0].rw = ST_IDLE;
3494 retval = i;
3495 goto out;
3498 if (mtc.mt_op == MTUNLOAD || mtc.mt_op == MTOFFL) {
3499 retval = do_load_unload(STp, file, 0);
3500 goto out;
3503 if (mtc.mt_op == MTLOAD) {
3504 retval = do_load_unload(STp, file, max(1, mtc.mt_count));
3505 goto out;
3508 if (mtc.mt_op == MTLOCK || mtc.mt_op == MTUNLOCK) {
3509 retval = do_door_lock(STp, (mtc.mt_op == MTLOCK));
3510 goto out;
3513 if (STp->can_partitions && STp->ready == ST_READY &&
3514 (i = switch_partition(STp)) < 0) {
3515 retval = i;
3516 goto out;
3519 if (mtc.mt_op == MTCOMPRESSION)
3520 retval = st_compression(STp, (mtc.mt_count & 1));
3521 else
3522 retval = st_int_ioctl(STp, mtc.mt_op, mtc.mt_count);
3523 goto out;
3525 if (!STm->defined) {
3526 retval = (-ENXIO);
3527 goto out;
3530 if ((i = flush_buffer(STp, 0)) < 0) {
3531 retval = i;
3532 goto out;
3534 if (STp->can_partitions &&
3535 (i = switch_partition(STp)) < 0) {
3536 retval = i;
3537 goto out;
3540 if (cmd_type == _IOC_TYPE(MTIOCGET) && cmd_nr == _IOC_NR(MTIOCGET)) {
3541 struct mtget mt_status;
3543 if (_IOC_SIZE(cmd_in) != sizeof(struct mtget)) {
3544 retval = (-EINVAL);
3545 goto out;
3548 mt_status.mt_type = STp->tape_type;
3549 mt_status.mt_dsreg =
3550 ((STp->block_size << MT_ST_BLKSIZE_SHIFT) & MT_ST_BLKSIZE_MASK) |
3551 ((STp->density << MT_ST_DENSITY_SHIFT) & MT_ST_DENSITY_MASK);
3552 mt_status.mt_blkno = STps->drv_block;
3553 mt_status.mt_fileno = STps->drv_file;
3554 if (STp->block_size != 0) {
3555 if (STps->rw == ST_WRITING)
3556 mt_status.mt_blkno +=
3557 (STp->buffer)->buffer_bytes / STp->block_size;
3558 else if (STps->rw == ST_READING)
3559 mt_status.mt_blkno -=
3560 ((STp->buffer)->buffer_bytes +
3561 STp->block_size - 1) / STp->block_size;
3564 mt_status.mt_gstat = 0;
3565 if (STp->drv_write_prot)
3566 mt_status.mt_gstat |= GMT_WR_PROT(0xffffffff);
3567 if (mt_status.mt_blkno == 0) {
3568 if (mt_status.mt_fileno == 0)
3569 mt_status.mt_gstat |= GMT_BOT(0xffffffff);
3570 else
3571 mt_status.mt_gstat |= GMT_EOF(0xffffffff);
3573 mt_status.mt_erreg = (STp->recover_reg << MT_ST_SOFTERR_SHIFT);
3574 mt_status.mt_resid = STp->partition;
3575 if (STps->eof == ST_EOM_OK || STps->eof == ST_EOM_ERROR)
3576 mt_status.mt_gstat |= GMT_EOT(0xffffffff);
3577 else if (STps->eof >= ST_EOM_OK)
3578 mt_status.mt_gstat |= GMT_EOD(0xffffffff);
3579 if (STp->density == 1)
3580 mt_status.mt_gstat |= GMT_D_800(0xffffffff);
3581 else if (STp->density == 2)
3582 mt_status.mt_gstat |= GMT_D_1600(0xffffffff);
3583 else if (STp->density == 3)
3584 mt_status.mt_gstat |= GMT_D_6250(0xffffffff);
3585 if (STp->ready == ST_READY)
3586 mt_status.mt_gstat |= GMT_ONLINE(0xffffffff);
3587 if (STp->ready == ST_NO_TAPE)
3588 mt_status.mt_gstat |= GMT_DR_OPEN(0xffffffff);
3589 if (STps->at_sm)
3590 mt_status.mt_gstat |= GMT_SM(0xffffffff);
3591 if (STm->do_async_writes ||
3592 (STm->do_buffer_writes && STp->block_size != 0) ||
3593 STp->drv_buffer != 0)
3594 mt_status.mt_gstat |= GMT_IM_REP_EN(0xffffffff);
3595 if (STp->cleaning_req)
3596 mt_status.mt_gstat |= GMT_CLN(0xffffffff);
3598 i = copy_to_user(p, &mt_status, sizeof(struct mtget));
3599 if (i) {
3600 retval = (-EFAULT);
3601 goto out;
3604 STp->recover_reg = 0; /* Clear after read */
3605 retval = 0;
3606 goto out;
3607 } /* End of MTIOCGET */
3608 if (cmd_type == _IOC_TYPE(MTIOCPOS) && cmd_nr == _IOC_NR(MTIOCPOS)) {
3609 struct mtpos mt_pos;
3610 if (_IOC_SIZE(cmd_in) != sizeof(struct mtpos)) {
3611 retval = (-EINVAL);
3612 goto out;
3614 if ((i = get_location(STp, &blk, &bt, 0)) < 0) {
3615 retval = i;
3616 goto out;
3618 mt_pos.mt_blkno = blk;
3619 i = copy_to_user(p, &mt_pos, sizeof(struct mtpos));
3620 if (i)
3621 retval = (-EFAULT);
3622 goto out;
3624 mutex_unlock(&STp->lock);
3625 switch (cmd_in) {
3626 case SCSI_IOCTL_GET_IDLUN:
3627 case SCSI_IOCTL_GET_BUS_NUMBER:
3628 break;
3629 default:
3630 if ((cmd_in == SG_IO ||
3631 cmd_in == SCSI_IOCTL_SEND_COMMAND ||
3632 cmd_in == CDROM_SEND_PACKET) &&
3633 !capable(CAP_SYS_RAWIO))
3634 i = -EPERM;
3635 else
3636 i = scsi_cmd_ioctl(STp->disk->queue, STp->disk,
3637 file->f_mode, cmd_in, p);
3638 if (i != -ENOTTY)
3639 return i;
3640 break;
3642 retval = scsi_ioctl(STp->device, cmd_in, p);
3643 if (!retval && cmd_in == SCSI_IOCTL_STOP_UNIT) { /* unload */
3644 STp->rew_at_close = 0;
3645 STp->ready = ST_NO_TAPE;
3647 return retval;
3649 out:
3650 mutex_unlock(&STp->lock);
3651 return retval;
3654 #ifdef CONFIG_COMPAT
3655 static long st_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
3657 struct scsi_tape *STp = file->private_data;
3658 struct scsi_device *sdev = STp->device;
3659 int ret = -ENOIOCTLCMD;
3660 if (sdev->host->hostt->compat_ioctl) {
3662 ret = sdev->host->hostt->compat_ioctl(sdev, cmd, (void __user *)arg);
3665 return ret;
3667 #endif
3671 /* Try to allocate a new tape buffer. Calling function must not hold
3672 dev_arr_lock. */
3673 static struct st_buffer *new_tape_buffer(int need_dma, int max_sg)
3675 struct st_buffer *tb;
3677 tb = kzalloc(sizeof(struct st_buffer), GFP_ATOMIC);
3678 if (!tb) {
3679 printk(KERN_NOTICE "st: Can't allocate new tape buffer.\n");
3680 return NULL;
3682 tb->frp_segs = 0;
3683 tb->use_sg = max_sg;
3684 tb->dma = need_dma;
3685 tb->buffer_size = 0;
3687 tb->reserved_pages = kzalloc(max_sg * sizeof(struct page *),
3688 GFP_ATOMIC);
3689 if (!tb->reserved_pages) {
3690 kfree(tb);
3691 return NULL;
3694 return tb;
3698 /* Try to allocate enough space in the tape buffer */
3699 #define ST_MAX_ORDER 6
3701 static int enlarge_buffer(struct st_buffer * STbuffer, int new_size, int need_dma)
3703 int segs, nbr, max_segs, b_size, order, got;
3704 gfp_t priority;
3706 if (new_size <= STbuffer->buffer_size)
3707 return 1;
3709 if (STbuffer->buffer_size <= PAGE_SIZE)
3710 normalize_buffer(STbuffer); /* Avoid extra segment */
3712 max_segs = STbuffer->use_sg;
3713 nbr = max_segs - STbuffer->frp_segs;
3714 if (nbr <= 0)
3715 return 0;
3717 priority = GFP_KERNEL | __GFP_NOWARN;
3718 if (need_dma)
3719 priority |= GFP_DMA;
3721 if (STbuffer->cleared)
3722 priority |= __GFP_ZERO;
3724 if (STbuffer->frp_segs) {
3725 order = STbuffer->reserved_page_order;
3726 b_size = PAGE_SIZE << order;
3727 } else {
3728 for (b_size = PAGE_SIZE, order = 0;
3729 order < ST_MAX_ORDER && b_size < new_size;
3730 order++, b_size *= 2)
3731 ; /* empty */
3733 if (max_segs * (PAGE_SIZE << order) < new_size) {
3734 if (order == ST_MAX_ORDER)
3735 return 0;
3736 normalize_buffer(STbuffer);
3737 return enlarge_buffer(STbuffer, new_size, need_dma);
3740 for (segs = STbuffer->frp_segs, got = STbuffer->buffer_size;
3741 segs < max_segs && got < new_size;) {
3742 struct page *page;
3744 page = alloc_pages(priority, order);
3745 if (!page) {
3746 DEB(STbuffer->buffer_size = got);
3747 normalize_buffer(STbuffer);
3748 return 0;
3751 STbuffer->frp_segs += 1;
3752 got += b_size;
3753 STbuffer->buffer_size = got;
3754 STbuffer->reserved_pages[segs] = page;
3755 segs++;
3757 STbuffer->b_data = page_address(STbuffer->reserved_pages[0]);
3758 STbuffer->reserved_page_order = order;
3760 return 1;
3764 /* Make sure that no data from previous user is in the internal buffer */
3765 static void clear_buffer(struct st_buffer * st_bp)
3767 int i;
3769 for (i=0; i < st_bp->frp_segs; i++)
3770 memset(page_address(st_bp->reserved_pages[i]), 0,
3771 PAGE_SIZE << st_bp->reserved_page_order);
3772 st_bp->cleared = 1;
3776 /* Release the extra buffer */
3777 static void normalize_buffer(struct st_buffer * STbuffer)
3779 int i, order = STbuffer->reserved_page_order;
3781 for (i = 0; i < STbuffer->frp_segs; i++) {
3782 __free_pages(STbuffer->reserved_pages[i], order);
3783 STbuffer->buffer_size -= (PAGE_SIZE << order);
3785 STbuffer->frp_segs = 0;
3786 STbuffer->sg_segs = 0;
3787 STbuffer->reserved_page_order = 0;
3788 STbuffer->map_data.offset = 0;
3792 /* Move data from the user buffer to the tape buffer. Returns zero (success) or
3793 negative error code. */
3794 static int append_to_buffer(const char __user *ubp, struct st_buffer * st_bp, int do_count)
3796 int i, cnt, res, offset;
3797 int length = PAGE_SIZE << st_bp->reserved_page_order;
3799 for (i = 0, offset = st_bp->buffer_bytes;
3800 i < st_bp->frp_segs && offset >= length; i++)
3801 offset -= length;
3802 if (i == st_bp->frp_segs) { /* Should never happen */
3803 printk(KERN_WARNING "st: append_to_buffer offset overflow.\n");
3804 return (-EIO);
3806 for (; i < st_bp->frp_segs && do_count > 0; i++) {
3807 struct page *page = st_bp->reserved_pages[i];
3808 cnt = length - offset < do_count ? length - offset : do_count;
3809 res = copy_from_user(page_address(page) + offset, ubp, cnt);
3810 if (res)
3811 return (-EFAULT);
3812 do_count -= cnt;
3813 st_bp->buffer_bytes += cnt;
3814 ubp += cnt;
3815 offset = 0;
3817 if (do_count) /* Should never happen */
3818 return (-EIO);
3820 return 0;
3824 /* Move data from the tape buffer to the user buffer. Returns zero (success) or
3825 negative error code. */
3826 static int from_buffer(struct st_buffer * st_bp, char __user *ubp, int do_count)
3828 int i, cnt, res, offset;
3829 int length = PAGE_SIZE << st_bp->reserved_page_order;
3831 for (i = 0, offset = st_bp->read_pointer;
3832 i < st_bp->frp_segs && offset >= length; i++)
3833 offset -= length;
3834 if (i == st_bp->frp_segs) { /* Should never happen */
3835 printk(KERN_WARNING "st: from_buffer offset overflow.\n");
3836 return (-EIO);
3838 for (; i < st_bp->frp_segs && do_count > 0; i++) {
3839 struct page *page = st_bp->reserved_pages[i];
3840 cnt = length - offset < do_count ? length - offset : do_count;
3841 res = copy_to_user(ubp, page_address(page) + offset, cnt);
3842 if (res)
3843 return (-EFAULT);
3844 do_count -= cnt;
3845 st_bp->buffer_bytes -= cnt;
3846 st_bp->read_pointer += cnt;
3847 ubp += cnt;
3848 offset = 0;
3850 if (do_count) /* Should never happen */
3851 return (-EIO);
3853 return 0;
3857 /* Move data towards start of buffer */
3858 static void move_buffer_data(struct st_buffer * st_bp, int offset)
3860 int src_seg, dst_seg, src_offset = 0, dst_offset;
3861 int count, total;
3862 int length = PAGE_SIZE << st_bp->reserved_page_order;
3864 if (offset == 0)
3865 return;
3867 total=st_bp->buffer_bytes - offset;
3868 for (src_seg=0; src_seg < st_bp->frp_segs; src_seg++) {
3869 src_offset = offset;
3870 if (src_offset < length)
3871 break;
3872 offset -= length;
3875 st_bp->buffer_bytes = st_bp->read_pointer = total;
3876 for (dst_seg=dst_offset=0; total > 0; ) {
3877 struct page *dpage = st_bp->reserved_pages[dst_seg];
3878 struct page *spage = st_bp->reserved_pages[src_seg];
3880 count = min(length - dst_offset, length - src_offset);
3881 memmove(page_address(dpage) + dst_offset,
3882 page_address(spage) + src_offset, count);
3883 src_offset += count;
3884 if (src_offset >= length) {
3885 src_seg++;
3886 src_offset = 0;
3888 dst_offset += count;
3889 if (dst_offset >= length) {
3890 dst_seg++;
3891 dst_offset = 0;
3893 total -= count;
3897 /* Validate the options from command line or module parameters */
3898 static void validate_options(void)
3900 if (buffer_kbs > 0)
3901 st_fixed_buffer_size = buffer_kbs * ST_KILOBYTE;
3902 if (max_sg_segs >= ST_FIRST_SG)
3903 st_max_sg_segs = max_sg_segs;
3906 #ifndef MODULE
3907 /* Set the boot options. Syntax is defined in Documenation/scsi/st.txt.
3909 static int __init st_setup(char *str)
3911 int i, len, ints[5];
3912 char *stp;
3914 stp = get_options(str, ARRAY_SIZE(ints), ints);
3916 if (ints[0] > 0) {
3917 for (i = 0; i < ints[0] && i < ARRAY_SIZE(parms); i++)
3918 if (parms[i].val)
3919 *parms[i].val = ints[i + 1];
3920 } else {
3921 while (stp != NULL) {
3922 for (i = 0; i < ARRAY_SIZE(parms); i++) {
3923 len = strlen(parms[i].name);
3924 if (!strncmp(stp, parms[i].name, len) &&
3925 (*(stp + len) == ':' || *(stp + len) == '=')) {
3926 if (parms[i].val)
3927 *parms[i].val =
3928 simple_strtoul(stp + len + 1, NULL, 0);
3929 else
3930 printk(KERN_WARNING "st: Obsolete parameter %s\n",
3931 parms[i].name);
3932 break;
3935 if (i >= ARRAY_SIZE(parms))
3936 printk(KERN_WARNING "st: invalid parameter in '%s'\n",
3937 stp);
3938 stp = strchr(stp, ',');
3939 if (stp)
3940 stp++;
3944 validate_options();
3946 return 1;
3949 __setup("st=", st_setup);
3951 #endif
3953 static const struct file_operations st_fops =
3955 .owner = THIS_MODULE,
3956 .read = st_read,
3957 .write = st_write,
3958 .unlocked_ioctl = st_ioctl,
3959 #ifdef CONFIG_COMPAT
3960 .compat_ioctl = st_compat_ioctl,
3961 #endif
3962 .open = st_open,
3963 .flush = st_flush,
3964 .release = st_release,
3967 static int st_probe(struct device *dev)
3969 struct scsi_device *SDp = to_scsi_device(dev);
3970 struct gendisk *disk = NULL;
3971 struct cdev *cdev = NULL;
3972 struct scsi_tape *tpnt = NULL;
3973 struct st_modedef *STm;
3974 struct st_partstat *STps;
3975 struct st_buffer *buffer;
3976 int i, j, mode, dev_num, error;
3977 char *stp;
3979 if (SDp->type != TYPE_TAPE)
3980 return -ENODEV;
3981 if ((stp = st_incompatible(SDp))) {
3982 sdev_printk(KERN_INFO, SDp, "Found incompatible tape\n");
3983 printk(KERN_INFO "st: The suggested driver is %s.\n", stp);
3984 return -ENODEV;
3987 i = min(queue_max_hw_segments(SDp->request_queue),
3988 queue_max_phys_segments(SDp->request_queue));
3989 if (st_max_sg_segs < i)
3990 i = st_max_sg_segs;
3991 buffer = new_tape_buffer((SDp->host)->unchecked_isa_dma, i);
3992 if (buffer == NULL) {
3993 printk(KERN_ERR
3994 "st: Can't allocate new tape buffer. Device not attached.\n");
3995 goto out;
3998 disk = alloc_disk(1);
3999 if (!disk) {
4000 printk(KERN_ERR "st: out of memory. Device not attached.\n");
4001 goto out_buffer_free;
4004 write_lock(&st_dev_arr_lock);
4005 if (st_nr_dev >= st_dev_max) {
4006 struct scsi_tape **tmp_da;
4007 int tmp_dev_max;
4009 tmp_dev_max = max(st_nr_dev * 2, 8);
4010 if (tmp_dev_max > ST_MAX_TAPES)
4011 tmp_dev_max = ST_MAX_TAPES;
4012 if (tmp_dev_max <= st_nr_dev) {
4013 write_unlock(&st_dev_arr_lock);
4014 printk(KERN_ERR "st: Too many tape devices (max. %d).\n",
4015 ST_MAX_TAPES);
4016 goto out_put_disk;
4019 tmp_da = kzalloc(tmp_dev_max * sizeof(struct scsi_tape *), GFP_ATOMIC);
4020 if (tmp_da == NULL) {
4021 write_unlock(&st_dev_arr_lock);
4022 printk(KERN_ERR "st: Can't extend device array.\n");
4023 goto out_put_disk;
4026 if (scsi_tapes != NULL) {
4027 memcpy(tmp_da, scsi_tapes,
4028 st_dev_max * sizeof(struct scsi_tape *));
4029 kfree(scsi_tapes);
4031 scsi_tapes = tmp_da;
4033 st_dev_max = tmp_dev_max;
4036 for (i = 0; i < st_dev_max; i++)
4037 if (scsi_tapes[i] == NULL)
4038 break;
4039 if (i >= st_dev_max)
4040 panic("scsi_devices corrupt (st)");
4042 tpnt = kzalloc(sizeof(struct scsi_tape), GFP_ATOMIC);
4043 if (tpnt == NULL) {
4044 write_unlock(&st_dev_arr_lock);
4045 printk(KERN_ERR "st: Can't allocate device descriptor.\n");
4046 goto out_put_disk;
4048 kref_init(&tpnt->kref);
4049 tpnt->disk = disk;
4050 sprintf(disk->disk_name, "st%d", i);
4051 disk->private_data = &tpnt->driver;
4052 disk->queue = SDp->request_queue;
4053 tpnt->driver = &st_template;
4054 scsi_tapes[i] = tpnt;
4055 dev_num = i;
4057 tpnt->device = SDp;
4058 if (SDp->scsi_level <= 2)
4059 tpnt->tape_type = MT_ISSCSI1;
4060 else
4061 tpnt->tape_type = MT_ISSCSI2;
4063 tpnt->buffer = buffer;
4064 tpnt->buffer->last_SRpnt = NULL;
4066 tpnt->inited = 0;
4067 tpnt->dirty = 0;
4068 tpnt->in_use = 0;
4069 tpnt->drv_buffer = 1; /* Try buffering if no mode sense */
4070 tpnt->restr_dma = (SDp->host)->unchecked_isa_dma;
4071 tpnt->use_pf = (SDp->scsi_level >= SCSI_2);
4072 tpnt->density = 0;
4073 tpnt->do_auto_lock = ST_AUTO_LOCK;
4074 tpnt->can_bsr = (SDp->scsi_level > 2 ? 1 : ST_IN_FILE_POS); /* BSR mandatory in SCSI3 */
4075 tpnt->can_partitions = 0;
4076 tpnt->two_fm = ST_TWO_FM;
4077 tpnt->fast_mteom = ST_FAST_MTEOM;
4078 tpnt->scsi2_logical = ST_SCSI2LOGICAL;
4079 tpnt->sili = ST_SILI;
4080 tpnt->immediate = ST_NOWAIT;
4081 tpnt->default_drvbuffer = 0xff; /* No forced buffering */
4082 tpnt->partition = 0;
4083 tpnt->new_partition = 0;
4084 tpnt->nbr_partitions = 0;
4085 blk_queue_rq_timeout(tpnt->device->request_queue, ST_TIMEOUT);
4086 tpnt->long_timeout = ST_LONG_TIMEOUT;
4087 tpnt->try_dio = try_direct_io && !SDp->host->unchecked_isa_dma;
4089 for (i = 0; i < ST_NBR_MODES; i++) {
4090 STm = &(tpnt->modes[i]);
4091 STm->defined = 0;
4092 STm->sysv = ST_SYSV;
4093 STm->defaults_for_writes = 0;
4094 STm->do_async_writes = ST_ASYNC_WRITES;
4095 STm->do_buffer_writes = ST_BUFFER_WRITES;
4096 STm->do_read_ahead = ST_READ_AHEAD;
4097 STm->default_compression = ST_DONT_TOUCH;
4098 STm->default_blksize = (-1); /* No forced size */
4099 STm->default_density = (-1); /* No forced density */
4102 for (i = 0; i < ST_NBR_PARTITIONS; i++) {
4103 STps = &(tpnt->ps[i]);
4104 STps->rw = ST_IDLE;
4105 STps->eof = ST_NOEOF;
4106 STps->at_sm = 0;
4107 STps->last_block_valid = 0;
4108 STps->drv_block = (-1);
4109 STps->drv_file = (-1);
4112 tpnt->current_mode = 0;
4113 tpnt->modes[0].defined = 1;
4115 tpnt->density_changed = tpnt->compression_changed =
4116 tpnt->blksize_changed = 0;
4117 mutex_init(&tpnt->lock);
4119 st_nr_dev++;
4120 write_unlock(&st_dev_arr_lock);
4122 for (mode = 0; mode < ST_NBR_MODES; ++mode) {
4123 STm = &(tpnt->modes[mode]);
4124 for (j=0; j < 2; j++) {
4125 cdev = cdev_alloc();
4126 if (!cdev) {
4127 printk(KERN_ERR
4128 "st%d: out of memory. Device not attached.\n",
4129 dev_num);
4130 goto out_free_tape;
4132 cdev->owner = THIS_MODULE;
4133 cdev->ops = &st_fops;
4135 error = cdev_add(cdev,
4136 MKDEV(SCSI_TAPE_MAJOR, TAPE_MINOR(dev_num, mode, j)),
4138 if (error) {
4139 printk(KERN_ERR "st%d: Can't add %s-rewind mode %d\n",
4140 dev_num, j ? "non" : "auto", mode);
4141 printk(KERN_ERR "st%d: Device not attached.\n", dev_num);
4142 goto out_free_tape;
4144 STm->cdevs[j] = cdev;
4147 error = do_create_class_files(tpnt, dev_num, mode);
4148 if (error)
4149 goto out_free_tape;
4152 sdev_printk(KERN_NOTICE, SDp,
4153 "Attached scsi tape %s\n", tape_name(tpnt));
4154 sdev_printk(KERN_INFO, SDp, "%s: try direct i/o: %s (alignment %d B)\n",
4155 tape_name(tpnt), tpnt->try_dio ? "yes" : "no",
4156 queue_dma_alignment(SDp->request_queue) + 1);
4158 return 0;
4160 out_free_tape:
4161 for (mode=0; mode < ST_NBR_MODES; mode++) {
4162 STm = &(tpnt->modes[mode]);
4163 sysfs_remove_link(&tpnt->device->sdev_gendev.kobj,
4164 "tape");
4165 for (j=0; j < 2; j++) {
4166 if (STm->cdevs[j]) {
4167 if (cdev == STm->cdevs[j])
4168 cdev = NULL;
4169 device_destroy(st_sysfs_class,
4170 MKDEV(SCSI_TAPE_MAJOR,
4171 TAPE_MINOR(i, mode, j)));
4172 cdev_del(STm->cdevs[j]);
4176 if (cdev)
4177 cdev_del(cdev);
4178 write_lock(&st_dev_arr_lock);
4179 scsi_tapes[dev_num] = NULL;
4180 st_nr_dev--;
4181 write_unlock(&st_dev_arr_lock);
4182 out_put_disk:
4183 put_disk(disk);
4184 kfree(tpnt);
4185 out_buffer_free:
4186 kfree(buffer);
4187 out:
4188 return -ENODEV;
4192 static int st_remove(struct device *dev)
4194 struct scsi_device *SDp = to_scsi_device(dev);
4195 struct scsi_tape *tpnt;
4196 int i, j, mode;
4198 write_lock(&st_dev_arr_lock);
4199 for (i = 0; i < st_dev_max; i++) {
4200 tpnt = scsi_tapes[i];
4201 if (tpnt != NULL && tpnt->device == SDp) {
4202 scsi_tapes[i] = NULL;
4203 st_nr_dev--;
4204 write_unlock(&st_dev_arr_lock);
4205 sysfs_remove_link(&tpnt->device->sdev_gendev.kobj,
4206 "tape");
4207 for (mode = 0; mode < ST_NBR_MODES; ++mode) {
4208 for (j=0; j < 2; j++) {
4209 device_destroy(st_sysfs_class,
4210 MKDEV(SCSI_TAPE_MAJOR,
4211 TAPE_MINOR(i, mode, j)));
4212 cdev_del(tpnt->modes[mode].cdevs[j]);
4213 tpnt->modes[mode].cdevs[j] = NULL;
4217 mutex_lock(&st_ref_mutex);
4218 kref_put(&tpnt->kref, scsi_tape_release);
4219 mutex_unlock(&st_ref_mutex);
4220 return 0;
4224 write_unlock(&st_dev_arr_lock);
4225 return 0;
4229 * scsi_tape_release - Called to free the Scsi_Tape structure
4230 * @kref: pointer to embedded kref
4232 * st_ref_mutex must be held entering this routine. Because it is
4233 * called on last put, you should always use the scsi_tape_get()
4234 * scsi_tape_put() helpers which manipulate the semaphore directly
4235 * and never do a direct kref_put().
4237 static void scsi_tape_release(struct kref *kref)
4239 struct scsi_tape *tpnt = to_scsi_tape(kref);
4240 struct gendisk *disk = tpnt->disk;
4242 tpnt->device = NULL;
4244 if (tpnt->buffer) {
4245 normalize_buffer(tpnt->buffer);
4246 kfree(tpnt->buffer->reserved_pages);
4247 kfree(tpnt->buffer);
4250 disk->private_data = NULL;
4251 put_disk(disk);
4252 kfree(tpnt);
4253 return;
4256 static int __init init_st(void)
4258 int err;
4260 validate_options();
4262 printk(KERN_INFO "st: Version %s, fixed bufsize %d, s/g segs %d\n",
4263 verstr, st_fixed_buffer_size, st_max_sg_segs);
4265 st_sysfs_class = class_create(THIS_MODULE, "scsi_tape");
4266 if (IS_ERR(st_sysfs_class)) {
4267 printk(KERN_ERR "Unable create sysfs class for SCSI tapes\n");
4268 return PTR_ERR(st_sysfs_class);
4271 err = register_chrdev_region(MKDEV(SCSI_TAPE_MAJOR, 0),
4272 ST_MAX_TAPE_ENTRIES, "st");
4273 if (err) {
4274 printk(KERN_ERR "Unable to get major %d for SCSI tapes\n",
4275 SCSI_TAPE_MAJOR);
4276 goto err_class;
4279 err = scsi_register_driver(&st_template.gendrv);
4280 if (err)
4281 goto err_chrdev;
4283 err = do_create_sysfs_files();
4284 if (err)
4285 goto err_scsidrv;
4287 return 0;
4289 err_scsidrv:
4290 scsi_unregister_driver(&st_template.gendrv);
4291 err_chrdev:
4292 unregister_chrdev_region(MKDEV(SCSI_TAPE_MAJOR, 0),
4293 ST_MAX_TAPE_ENTRIES);
4294 err_class:
4295 class_destroy(st_sysfs_class);
4296 return err;
4299 static void __exit exit_st(void)
4301 do_remove_sysfs_files();
4302 scsi_unregister_driver(&st_template.gendrv);
4303 unregister_chrdev_region(MKDEV(SCSI_TAPE_MAJOR, 0),
4304 ST_MAX_TAPE_ENTRIES);
4305 class_destroy(st_sysfs_class);
4306 kfree(scsi_tapes);
4307 printk(KERN_INFO "st: Unloaded.\n");
4310 module_init(init_st);
4311 module_exit(exit_st);
4314 /* The sysfs driver interface. Read-only at the moment */
4315 static ssize_t st_try_direct_io_show(struct device_driver *ddp, char *buf)
4317 return snprintf(buf, PAGE_SIZE, "%d\n", try_direct_io);
4319 static DRIVER_ATTR(try_direct_io, S_IRUGO, st_try_direct_io_show, NULL);
4321 static ssize_t st_fixed_buffer_size_show(struct device_driver *ddp, char *buf)
4323 return snprintf(buf, PAGE_SIZE, "%d\n", st_fixed_buffer_size);
4325 static DRIVER_ATTR(fixed_buffer_size, S_IRUGO, st_fixed_buffer_size_show, NULL);
4327 static ssize_t st_max_sg_segs_show(struct device_driver *ddp, char *buf)
4329 return snprintf(buf, PAGE_SIZE, "%d\n", st_max_sg_segs);
4331 static DRIVER_ATTR(max_sg_segs, S_IRUGO, st_max_sg_segs_show, NULL);
4333 static ssize_t st_version_show(struct device_driver *ddd, char *buf)
4335 return snprintf(buf, PAGE_SIZE, "[%s]\n", verstr);
4337 static DRIVER_ATTR(version, S_IRUGO, st_version_show, NULL);
4339 static int do_create_sysfs_files(void)
4341 struct device_driver *sysfs = &st_template.gendrv;
4342 int err;
4344 err = driver_create_file(sysfs, &driver_attr_try_direct_io);
4345 if (err)
4346 return err;
4347 err = driver_create_file(sysfs, &driver_attr_fixed_buffer_size);
4348 if (err)
4349 goto err_try_direct_io;
4350 err = driver_create_file(sysfs, &driver_attr_max_sg_segs);
4351 if (err)
4352 goto err_attr_fixed_buf;
4353 err = driver_create_file(sysfs, &driver_attr_version);
4354 if (err)
4355 goto err_attr_max_sg;
4357 return 0;
4359 err_attr_max_sg:
4360 driver_remove_file(sysfs, &driver_attr_max_sg_segs);
4361 err_attr_fixed_buf:
4362 driver_remove_file(sysfs, &driver_attr_fixed_buffer_size);
4363 err_try_direct_io:
4364 driver_remove_file(sysfs, &driver_attr_try_direct_io);
4365 return err;
4368 static void do_remove_sysfs_files(void)
4370 struct device_driver *sysfs = &st_template.gendrv;
4372 driver_remove_file(sysfs, &driver_attr_version);
4373 driver_remove_file(sysfs, &driver_attr_max_sg_segs);
4374 driver_remove_file(sysfs, &driver_attr_fixed_buffer_size);
4375 driver_remove_file(sysfs, &driver_attr_try_direct_io);
4379 /* The sysfs simple class interface */
4380 static ssize_t
4381 st_defined_show(struct device *dev, struct device_attribute *attr, char *buf)
4383 struct st_modedef *STm = dev_get_drvdata(dev);
4384 ssize_t l = 0;
4386 l = snprintf(buf, PAGE_SIZE, "%d\n", STm->defined);
4387 return l;
4390 DEVICE_ATTR(defined, S_IRUGO, st_defined_show, NULL);
4392 static ssize_t
4393 st_defblk_show(struct device *dev, struct device_attribute *attr, char *buf)
4395 struct st_modedef *STm = dev_get_drvdata(dev);
4396 ssize_t l = 0;
4398 l = snprintf(buf, PAGE_SIZE, "%d\n", STm->default_blksize);
4399 return l;
4402 DEVICE_ATTR(default_blksize, S_IRUGO, st_defblk_show, NULL);
4404 static ssize_t
4405 st_defdensity_show(struct device *dev, struct device_attribute *attr, char *buf)
4407 struct st_modedef *STm = dev_get_drvdata(dev);
4408 ssize_t l = 0;
4409 char *fmt;
4411 fmt = STm->default_density >= 0 ? "0x%02x\n" : "%d\n";
4412 l = snprintf(buf, PAGE_SIZE, fmt, STm->default_density);
4413 return l;
4416 DEVICE_ATTR(default_density, S_IRUGO, st_defdensity_show, NULL);
4418 static ssize_t
4419 st_defcompression_show(struct device *dev, struct device_attribute *attr,
4420 char *buf)
4422 struct st_modedef *STm = dev_get_drvdata(dev);
4423 ssize_t l = 0;
4425 l = snprintf(buf, PAGE_SIZE, "%d\n", STm->default_compression - 1);
4426 return l;
4429 DEVICE_ATTR(default_compression, S_IRUGO, st_defcompression_show, NULL);
4431 static ssize_t
4432 st_options_show(struct device *dev, struct device_attribute *attr, char *buf)
4434 struct st_modedef *STm = dev_get_drvdata(dev);
4435 struct scsi_tape *STp;
4436 int i, j, options;
4437 ssize_t l = 0;
4439 for (i=0; i < st_dev_max; i++) {
4440 for (j=0; j < ST_NBR_MODES; j++)
4441 if (&scsi_tapes[i]->modes[j] == STm)
4442 break;
4443 if (j < ST_NBR_MODES)
4444 break;
4446 if (i == st_dev_max)
4447 return 0; /* should never happen */
4449 STp = scsi_tapes[i];
4451 options = STm->do_buffer_writes ? MT_ST_BUFFER_WRITES : 0;
4452 options |= STm->do_async_writes ? MT_ST_ASYNC_WRITES : 0;
4453 options |= STm->do_read_ahead ? MT_ST_READ_AHEAD : 0;
4454 DEB( options |= debugging ? MT_ST_DEBUGGING : 0 );
4455 options |= STp->two_fm ? MT_ST_TWO_FM : 0;
4456 options |= STp->fast_mteom ? MT_ST_FAST_MTEOM : 0;
4457 options |= STm->defaults_for_writes ? MT_ST_DEF_WRITES : 0;
4458 options |= STp->can_bsr ? MT_ST_CAN_BSR : 0;
4459 options |= STp->omit_blklims ? MT_ST_NO_BLKLIMS : 0;
4460 options |= STp->can_partitions ? MT_ST_CAN_PARTITIONS : 0;
4461 options |= STp->scsi2_logical ? MT_ST_SCSI2LOGICAL : 0;
4462 options |= STm->sysv ? MT_ST_SYSV : 0;
4463 options |= STp->immediate ? MT_ST_NOWAIT : 0;
4464 options |= STp->sili ? MT_ST_SILI : 0;
4466 l = snprintf(buf, PAGE_SIZE, "0x%08x\n", options);
4467 return l;
4470 DEVICE_ATTR(options, S_IRUGO, st_options_show, NULL);
4472 static int do_create_class_files(struct scsi_tape *STp, int dev_num, int mode)
4474 int i, rew, error;
4475 char name[10];
4476 struct device *st_class_member;
4478 for (rew=0; rew < 2; rew++) {
4479 /* Make sure that the minor numbers corresponding to the four
4480 first modes always get the same names */
4481 i = mode << (4 - ST_NBR_MODE_BITS);
4482 snprintf(name, 10, "%s%s%s", rew ? "n" : "",
4483 STp->disk->disk_name, st_formats[i]);
4484 st_class_member =
4485 device_create(st_sysfs_class, &STp->device->sdev_gendev,
4486 MKDEV(SCSI_TAPE_MAJOR,
4487 TAPE_MINOR(dev_num, mode, rew)),
4488 &STp->modes[mode], "%s", name);
4489 if (IS_ERR(st_class_member)) {
4490 printk(KERN_WARNING "st%d: device_create failed\n",
4491 dev_num);
4492 error = PTR_ERR(st_class_member);
4493 goto out;
4496 error = device_create_file(st_class_member,
4497 &dev_attr_defined);
4498 if (error) goto out;
4499 error = device_create_file(st_class_member,
4500 &dev_attr_default_blksize);
4501 if (error) goto out;
4502 error = device_create_file(st_class_member,
4503 &dev_attr_default_density);
4504 if (error) goto out;
4505 error = device_create_file(st_class_member,
4506 &dev_attr_default_compression);
4507 if (error) goto out;
4508 error = device_create_file(st_class_member,
4509 &dev_attr_options);
4510 if (error) goto out;
4512 if (mode == 0 && rew == 0) {
4513 error = sysfs_create_link(&STp->device->sdev_gendev.kobj,
4514 &st_class_member->kobj,
4515 "tape");
4516 if (error) {
4517 printk(KERN_ERR
4518 "st%d: Can't create sysfs link from SCSI device.\n",
4519 dev_num);
4520 goto out;
4525 return 0;
4527 out:
4528 return error;
4531 /* The following functions may be useful for a larger audience. */
4532 static int sgl_map_user_pages(struct st_buffer *STbp,
4533 const unsigned int max_pages, unsigned long uaddr,
4534 size_t count, int rw)
4536 unsigned long end = (uaddr + count + PAGE_SIZE - 1) >> PAGE_SHIFT;
4537 unsigned long start = uaddr >> PAGE_SHIFT;
4538 const int nr_pages = end - start;
4539 int res, i, j;
4540 struct page **pages;
4541 struct rq_map_data *mdata = &STbp->map_data;
4543 /* User attempted Overflow! */
4544 if ((uaddr + count) < uaddr)
4545 return -EINVAL;
4547 /* Too big */
4548 if (nr_pages > max_pages)
4549 return -ENOMEM;
4551 /* Hmm? */
4552 if (count == 0)
4553 return 0;
4555 if ((pages = kmalloc(max_pages * sizeof(*pages), GFP_KERNEL)) == NULL)
4556 return -ENOMEM;
4558 /* Try to fault in all of the necessary pages */
4559 down_read(&current->mm->mmap_sem);
4560 /* rw==READ means read from drive, write into memory area */
4561 res = get_user_pages(
4562 current,
4563 current->mm,
4564 uaddr,
4565 nr_pages,
4566 rw == READ,
4567 0, /* don't force */
4568 pages,
4569 NULL);
4570 up_read(&current->mm->mmap_sem);
4572 /* Errors and no page mapped should return here */
4573 if (res < nr_pages)
4574 goto out_unmap;
4576 for (i=0; i < nr_pages; i++) {
4577 /* FIXME: flush superflous for rw==READ,
4578 * probably wrong function for rw==WRITE
4580 flush_dcache_page(pages[i]);
4583 mdata->offset = uaddr & ~PAGE_MASK;
4584 STbp->mapped_pages = pages;
4586 return nr_pages;
4587 out_unmap:
4588 if (res > 0) {
4589 for (j=0; j < res; j++)
4590 page_cache_release(pages[j]);
4591 res = 0;
4593 kfree(pages);
4594 return res;
4598 /* And unmap them... */
4599 static int sgl_unmap_user_pages(struct st_buffer *STbp,
4600 const unsigned int nr_pages, int dirtied)
4602 int i;
4604 for (i=0; i < nr_pages; i++) {
4605 struct page *page = STbp->mapped_pages[i];
4607 if (dirtied)
4608 SetPageDirty(page);
4609 /* FIXME: cache flush missing for rw==READ
4610 * FIXME: call the correct reference counting function
4612 page_cache_release(page);
4614 kfree(STbp->mapped_pages);
4615 STbp->mapped_pages = NULL;
4617 return 0;