2 SCSI Tape Driver for Linux version 1.1 and newer. See the accompanying
3 file Documentation/scsi/st.txt for more information.
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 = "20080504";
22 #include <linux/module.h>
25 #include <linux/kernel.h>
26 #include <linux/sched.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>
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>
57 /* The driver prints some debugging information on the console if DEBUG
58 is defined and non-zero. */
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
67 #define DEBC(a) if (debugging) { a ; }
73 #define ST_KILOBYTE 1024
75 #include "st_options.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;
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");
113 static int write_threshold_kbs; /* retained for compatibility */
114 static struct st_dev_parm {
117 } parms[] __initdata = {
119 "buffer_kbs", &buffer_kbs
121 { /* Retained for compatibility with 2.4 */
122 "write_threshold_kbs", &write_threshold_kbs
128 "try_direct_io", &try_direct_io
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"
137 /* Bit reversed order to get same names for same minors with all
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!"
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
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 struct st_buffer *new_tape_buffer(int, int, int);
186 static int enlarge_buffer(struct st_buffer *, int, int);
187 static void clear_buffer(struct st_buffer *);
188 static void normalize_buffer(struct st_buffer *);
189 static int append_to_buffer(const char __user *, struct st_buffer *, int);
190 static int from_buffer(struct st_buffer *, char __user *, int);
191 static void move_buffer_data(struct st_buffer *, int);
192 static void buf_to_sg(struct st_buffer *, unsigned int);
194 static int sgl_map_user_pages(struct scatterlist *, const unsigned int,
195 unsigned long, size_t, int);
196 static int sgl_unmap_user_pages(struct scatterlist *, const unsigned int, int);
198 static int st_probe(struct device *);
199 static int st_remove(struct device *);
201 static int do_create_sysfs_files(void);
202 static void do_remove_sysfs_files(void);
203 static int do_create_class_files(struct scsi_tape *, int, int);
205 static struct scsi_driver st_template = {
206 .owner = THIS_MODULE,
214 static int st_compression(struct scsi_tape *, int);
216 static int find_partition(struct scsi_tape *);
217 static int switch_partition(struct scsi_tape *);
219 static int st_int_ioctl(struct scsi_tape *, unsigned int, unsigned long);
221 static void scsi_tape_release(struct kref *);
223 #define to_scsi_tape(obj) container_of(obj, struct scsi_tape, kref)
225 static DEFINE_MUTEX(st_ref_mutex);
228 #include "osst_detect.h"
229 #ifndef SIGS_FROM_OSST
230 #define SIGS_FROM_OSST \
231 {"OnStream", "SC-", "", "osst"}, \
232 {"OnStream", "DI-", "", "osst"}, \
233 {"OnStream", "DP-", "", "osst"}, \
234 {"OnStream", "USB", "", "osst"}, \
235 {"OnStream", "FW-", "", "osst"}
238 static struct scsi_tape *scsi_tape_get(int dev)
240 struct scsi_tape *STp = NULL;
242 mutex_lock(&st_ref_mutex);
243 write_lock(&st_dev_arr_lock);
245 if (dev < st_dev_max && scsi_tapes != NULL)
246 STp = scsi_tapes[dev];
249 kref_get(&STp->kref);
254 if (scsi_device_get(STp->device))
260 kref_put(&STp->kref, scsi_tape_release);
263 write_unlock(&st_dev_arr_lock);
264 mutex_unlock(&st_ref_mutex);
268 static void scsi_tape_put(struct scsi_tape *STp)
270 struct scsi_device *sdev = STp->device;
272 mutex_lock(&st_ref_mutex);
273 kref_put(&STp->kref, scsi_tape_release);
274 scsi_device_put(sdev);
275 mutex_unlock(&st_ref_mutex);
278 struct st_reject_data {
282 char *driver_hint; /* Name of the correct driver, NULL if unknown */
285 static struct st_reject_data reject_list[] = {
286 /* {"XXX", "Yy-", "", NULL}, example */
290 /* If the device signature is on the list of incompatible drives, the
291 function returns a pointer to the name of the correct driver (if known) */
292 static char * st_incompatible(struct scsi_device* SDp)
294 struct st_reject_data *rp;
296 for (rp=&(reject_list[0]); rp->vendor != NULL; rp++)
297 if (!strncmp(rp->vendor, SDp->vendor, strlen(rp->vendor)) &&
298 !strncmp(rp->model, SDp->model, strlen(rp->model)) &&
299 !strncmp(rp->rev, SDp->rev, strlen(rp->rev))) {
301 return rp->driver_hint;
309 static inline char *tape_name(struct scsi_tape *tape)
311 return tape->disk->disk_name;
315 static void st_analyze_sense(struct st_request *SRpnt, struct st_cmdstatus *s)
318 const u8 *sense = SRpnt->sense;
320 s->have_sense = scsi_normalize_sense(SRpnt->sense,
321 SCSI_SENSE_BUFFERSIZE, &s->sense_hdr);
327 scsi_get_sense_info_fld(sense, SCSI_SENSE_BUFFERSIZE, &s->uremainder64);
328 switch (sense[0] & 0x7f) {
333 s->flags = sense[2] & 0xe0;
339 ucp = scsi_sense_desc_find(sense, SCSI_SENSE_BUFFERSIZE, 4);
340 s->flags = ucp ? (ucp[3] & 0xe0) : 0;
347 /* Convert the result to success code */
348 static int st_chk_result(struct scsi_tape *STp, struct st_request * SRpnt)
350 int result = SRpnt->result;
352 DEB(const char *stp;)
353 char *name = tape_name(STp);
354 struct st_cmdstatus *cmdstatp;
359 cmdstatp = &STp->buffer->cmdstat;
360 st_analyze_sense(SRpnt, cmdstatp);
362 if (cmdstatp->have_sense)
363 scode = STp->buffer->cmdstat.sense_hdr.sense_key;
369 printk(ST_DEB_MSG "%s: Error: %x, cmd: %x %x %x %x %x %x\n",
371 SRpnt->cmd[0], SRpnt->cmd[1], SRpnt->cmd[2],
372 SRpnt->cmd[3], SRpnt->cmd[4], SRpnt->cmd[5]);
373 if (cmdstatp->have_sense)
374 __scsi_print_sense(name, SRpnt->sense, SCSI_SENSE_BUFFERSIZE);
376 if (!debugging) { /* Abnormal conditions for tape */
377 if (!cmdstatp->have_sense)
379 "%s: Error %x (sugg. bt 0x%x, driver bt 0x%x, host bt 0x%x).\n",
380 name, result, suggestion(result),
381 driver_byte(result) & DRIVER_MASK, host_byte(result));
382 else if (cmdstatp->have_sense &&
384 scode != RECOVERED_ERROR &&
385 /* scode != UNIT_ATTENTION && */
386 scode != BLANK_CHECK &&
387 scode != VOLUME_OVERFLOW &&
388 SRpnt->cmd[0] != MODE_SENSE &&
389 SRpnt->cmd[0] != TEST_UNIT_READY) {
391 __scsi_print_sense(name, SRpnt->sense, SCSI_SENSE_BUFFERSIZE);
395 if (cmdstatp->fixed_format &&
396 STp->cln_mode >= EXTENDED_SENSE_START) { /* Only fixed format sense */
397 if (STp->cln_sense_value)
398 STp->cleaning_req |= ((SRpnt->sense[STp->cln_mode] &
399 STp->cln_sense_mask) == STp->cln_sense_value);
401 STp->cleaning_req |= ((SRpnt->sense[STp->cln_mode] &
402 STp->cln_sense_mask) != 0);
404 if (cmdstatp->have_sense &&
405 cmdstatp->sense_hdr.asc == 0 && cmdstatp->sense_hdr.ascq == 0x17)
406 STp->cleaning_req = 1; /* ASC and ASCQ => cleaning requested */
408 STp->pos_unknown |= STp->device->was_reset;
410 if (cmdstatp->have_sense &&
411 scode == RECOVERED_ERROR
412 #if ST_RECOVERED_WRITE_FATAL
413 && SRpnt->cmd[0] != WRITE_6
414 && SRpnt->cmd[0] != WRITE_FILEMARKS
417 STp->recover_count++;
422 if (SRpnt->cmd[0] == READ_6)
424 else if (SRpnt->cmd[0] == WRITE_6)
428 printk(ST_DEB_MSG "%s: Recovered %s error (%d).\n", name, stp,
432 if (cmdstatp->flags == 0)
439 /* Wakeup from interrupt */
440 static void st_sleep_done(void *data, char *sense, int result, int resid)
442 struct st_request *SRpnt = data;
443 struct scsi_tape *STp = SRpnt->stp;
445 memcpy(SRpnt->sense, sense, SCSI_SENSE_BUFFERSIZE);
446 (STp->buffer)->cmdstat.midlevel_result = SRpnt->result = result;
447 (STp->buffer)->cmdstat.residual = resid;
448 DEB( STp->write_pending = 0; )
451 complete(SRpnt->waiting);
454 static struct st_request *st_allocate_request(struct scsi_tape *stp)
456 struct st_request *streq;
458 streq = kzalloc(sizeof(*streq), GFP_KERNEL);
462 DEBC(printk(KERN_ERR "%s: Can't get SCSI request.\n",
464 if (signal_pending(current))
465 stp->buffer->syscall_result = -EINTR;
467 stp->buffer->syscall_result = -EBUSY;
473 static void st_release_request(struct st_request *streq)
478 /* Do the scsi command. Waits until command performed if do_wait is true.
479 Otherwise write_behind_check() is used to check that the command
481 static struct st_request *
482 st_do_scsi(struct st_request * SRpnt, struct scsi_tape * STp, unsigned char *cmd,
483 int bytes, int direction, int timeout, int retries, int do_wait)
485 struct completion *waiting;
487 /* if async, make sure there's no command outstanding */
488 if (!do_wait && ((STp->buffer)->last_SRpnt)) {
489 printk(KERN_ERR "%s: Async command already active.\n",
491 if (signal_pending(current))
492 (STp->buffer)->syscall_result = (-EINTR);
494 (STp->buffer)->syscall_result = (-EBUSY);
499 SRpnt = st_allocate_request(STp);
504 /* If async IO, set last_SRpnt. This ptr tells write_behind_check
505 which IO is outstanding. It's nulled out when the IO completes. */
507 (STp->buffer)->last_SRpnt = SRpnt;
509 waiting = &STp->wait;
510 init_completion(waiting);
511 SRpnt->waiting = waiting;
513 if (!STp->buffer->do_dio)
514 buf_to_sg(STp->buffer, bytes);
516 memcpy(SRpnt->cmd, cmd, sizeof(SRpnt->cmd));
517 STp->buffer->cmdstat.have_sense = 0;
518 STp->buffer->syscall_result = 0;
520 if (scsi_execute_async(STp->device, cmd, COMMAND_SIZE(cmd[0]), direction,
521 &((STp->buffer)->sg[0]), bytes, (STp->buffer)->sg_segs,
522 timeout, retries, SRpnt, st_sleep_done, GFP_KERNEL)) {
523 /* could not allocate the buffer or request was too large */
524 (STp->buffer)->syscall_result = (-EBUSY);
525 (STp->buffer)->last_SRpnt = NULL;
528 wait_for_completion(waiting);
529 SRpnt->waiting = NULL;
530 (STp->buffer)->syscall_result = st_chk_result(STp, SRpnt);
537 /* Handle the write-behind checking (waits for completion). Returns -ENOSPC if
538 write has been correct but EOM early warning reached, -EIO if write ended in
539 error or zero if write successful. Asynchronous writes are used only in
540 variable block mode. */
541 static int write_behind_check(struct scsi_tape * STp)
544 struct st_buffer *STbuffer;
545 struct st_partstat *STps;
546 struct st_cmdstatus *cmdstatp;
547 struct st_request *SRpnt;
549 STbuffer = STp->buffer;
550 if (!STbuffer->writing)
554 if (STp->write_pending)
560 wait_for_completion(&(STp->wait));
561 SRpnt = STbuffer->last_SRpnt;
562 STbuffer->last_SRpnt = NULL;
563 SRpnt->waiting = NULL;
565 (STp->buffer)->syscall_result = st_chk_result(STp, SRpnt);
566 st_release_request(SRpnt);
568 STbuffer->buffer_bytes -= STbuffer->writing;
569 STps = &(STp->ps[STp->partition]);
570 if (STps->drv_block >= 0) {
571 if (STp->block_size == 0)
574 STps->drv_block += STbuffer->writing / STp->block_size;
577 cmdstatp = &STbuffer->cmdstat;
578 if (STbuffer->syscall_result) {
580 if (cmdstatp->have_sense && !cmdstatp->deferred &&
581 (cmdstatp->flags & SENSE_EOM) &&
582 (cmdstatp->sense_hdr.sense_key == NO_SENSE ||
583 cmdstatp->sense_hdr.sense_key == RECOVERED_ERROR)) {
584 /* EOM at write-behind, has all data been written? */
585 if (!cmdstatp->remainder_valid ||
586 cmdstatp->uremainder64 == 0)
590 STps->drv_block = -1;
592 STbuffer->writing = 0;
594 DEB(if (debugging && retval)
595 printk(ST_DEB_MSG "%s: Async write error %x, return value %d.\n",
596 tape_name(STp), STbuffer->cmdstat.midlevel_result, retval);) /* end DEB */
602 /* Step over EOF if it has been inadvertently crossed (ioctl not used because
603 it messes up the block number). */
604 static int cross_eof(struct scsi_tape * STp, int forward)
606 struct st_request *SRpnt;
607 unsigned char cmd[MAX_COMMAND_SIZE];
610 cmd[1] = 0x01; /* Space FileMarks */
615 cmd[2] = cmd[3] = cmd[4] = 0xff; /* -1 filemarks */
618 DEBC(printk(ST_DEB_MSG "%s: Stepping over filemark %s.\n",
619 tape_name(STp), forward ? "forward" : "backward"));
621 SRpnt = st_do_scsi(NULL, STp, cmd, 0, DMA_NONE,
622 STp->device->request_queue->rq_timeout,
625 return (STp->buffer)->syscall_result;
627 st_release_request(SRpnt);
630 if ((STp->buffer)->cmdstat.midlevel_result != 0)
631 printk(KERN_ERR "%s: Stepping over filemark %s failed.\n",
632 tape_name(STp), forward ? "forward" : "backward");
634 return (STp->buffer)->syscall_result;
638 /* Flush the write buffer (never need to write if variable blocksize). */
639 static int st_flush_write_buffer(struct scsi_tape * STp)
643 unsigned char cmd[MAX_COMMAND_SIZE];
644 struct st_request *SRpnt;
645 struct st_partstat *STps;
647 result = write_behind_check(STp);
652 if (STp->dirty == 1) {
654 transfer = STp->buffer->buffer_bytes;
655 DEBC(printk(ST_DEB_MSG "%s: Flushing %d bytes.\n",
656 tape_name(STp), transfer));
658 memset(cmd, 0, MAX_COMMAND_SIZE);
661 blks = transfer / STp->block_size;
666 SRpnt = st_do_scsi(NULL, STp, cmd, transfer, DMA_TO_DEVICE,
667 STp->device->request_queue->rq_timeout,
668 MAX_WRITE_RETRIES, 1);
670 return (STp->buffer)->syscall_result;
672 STps = &(STp->ps[STp->partition]);
673 if ((STp->buffer)->syscall_result != 0) {
674 struct st_cmdstatus *cmdstatp = &STp->buffer->cmdstat;
676 if (cmdstatp->have_sense && !cmdstatp->deferred &&
677 (cmdstatp->flags & SENSE_EOM) &&
678 (cmdstatp->sense_hdr.sense_key == NO_SENSE ||
679 cmdstatp->sense_hdr.sense_key == RECOVERED_ERROR) &&
680 (!cmdstatp->remainder_valid ||
681 cmdstatp->uremainder64 == 0)) { /* All written at EOM early warning */
683 (STp->buffer)->buffer_bytes = 0;
684 if (STps->drv_block >= 0)
685 STps->drv_block += blks;
688 printk(KERN_ERR "%s: Error on flush.\n",
690 STps->drv_block = (-1);
694 if (STps->drv_block >= 0)
695 STps->drv_block += blks;
697 (STp->buffer)->buffer_bytes = 0;
699 st_release_request(SRpnt);
706 /* Flush the tape buffer. The tape will be positioned correctly unless
707 seek_next is true. */
708 static int flush_buffer(struct scsi_tape *STp, int seek_next)
710 int backspace, result;
711 struct st_buffer *STbuffer;
712 struct st_partstat *STps;
714 STbuffer = STp->buffer;
717 * If there was a bus reset, block further access
720 if (STp->pos_unknown)
723 if (STp->ready != ST_READY)
725 STps = &(STp->ps[STp->partition]);
726 if (STps->rw == ST_WRITING) /* Writing */
727 return st_flush_write_buffer(STp);
729 if (STp->block_size == 0)
732 backspace = ((STp->buffer)->buffer_bytes +
733 (STp->buffer)->read_pointer) / STp->block_size -
734 ((STp->buffer)->read_pointer + STp->block_size - 1) /
736 (STp->buffer)->buffer_bytes = 0;
737 (STp->buffer)->read_pointer = 0;
740 if (STps->eof == ST_FM_HIT) {
741 result = cross_eof(STp, 0); /* Back over the EOF hit */
743 STps->eof = ST_NOEOF;
745 if (STps->drv_file >= 0)
750 if (!result && backspace > 0)
751 result = st_int_ioctl(STp, MTBSR, backspace);
752 } else if (STps->eof == ST_FM_HIT) {
753 if (STps->drv_file >= 0)
756 STps->eof = ST_NOEOF;
762 /* Set the mode parameters */
763 static int set_mode_densblk(struct scsi_tape * STp, struct st_modedef * STm)
767 char *name = tape_name(STp);
769 if (!STp->density_changed &&
770 STm->default_density >= 0 &&
771 STm->default_density != STp->density) {
772 arg = STm->default_density;
776 arg <<= MT_ST_DENSITY_SHIFT;
777 if (!STp->blksize_changed &&
778 STm->default_blksize >= 0 &&
779 STm->default_blksize != STp->block_size) {
780 arg |= STm->default_blksize;
783 arg |= STp->block_size;
785 st_int_ioctl(STp, SET_DENS_AND_BLK, arg)) {
787 "%s: Can't set default block size to %d bytes and density %x.\n",
788 name, STm->default_blksize, STm->default_density);
796 /* Lock or unlock the drive door. Don't use when st_request allocated. */
797 static int do_door_lock(struct scsi_tape * STp, int do_lock)
800 DEB(char *name = tape_name(STp);)
803 cmd = do_lock ? SCSI_IOCTL_DOORLOCK : SCSI_IOCTL_DOORUNLOCK;
804 DEBC(printk(ST_DEB_MSG "%s: %socking drive door.\n", name,
805 do_lock ? "L" : "Unl"));
806 retval = scsi_ioctl(STp->device, cmd, NULL);
808 STp->door_locked = do_lock ? ST_LOCKED_EXPLICIT : ST_UNLOCKED;
811 STp->door_locked = ST_LOCK_FAILS;
817 /* Set the internal state after reset */
818 static void reset_state(struct scsi_tape *STp)
821 struct st_partstat *STps;
823 STp->pos_unknown = 0;
824 for (i = 0; i < ST_NBR_PARTITIONS; i++) {
825 STps = &(STp->ps[i]);
827 STps->eof = ST_NOEOF;
829 STps->last_block_valid = 0;
830 STps->drv_block = -1;
833 if (STp->can_partitions) {
834 STp->partition = find_partition(STp);
835 if (STp->partition < 0)
837 STp->new_partition = STp->partition;
841 /* Test if the drive is ready. Returns either one of the codes below or a negative system
843 #define CHKRES_READY 0
844 #define CHKRES_NEW_SESSION 1
845 #define CHKRES_NOT_READY 2
846 #define CHKRES_NO_TAPE 3
848 #define MAX_ATTENTIONS 10
850 static int test_ready(struct scsi_tape *STp, int do_wait)
852 int attentions, waits, max_wait, scode;
853 int retval = CHKRES_READY, new_session = 0;
854 unsigned char cmd[MAX_COMMAND_SIZE];
855 struct st_request *SRpnt = NULL;
856 struct st_cmdstatus *cmdstatp = &STp->buffer->cmdstat;
858 max_wait = do_wait ? ST_BLOCK_SECONDS : 0;
860 for (attentions=waits=0; ; ) {
861 memset((void *) &cmd[0], 0, MAX_COMMAND_SIZE);
862 cmd[0] = TEST_UNIT_READY;
863 SRpnt = st_do_scsi(SRpnt, STp, cmd, 0, DMA_NONE,
864 STp->long_timeout, MAX_READY_RETRIES, 1);
867 retval = (STp->buffer)->syscall_result;
871 if (cmdstatp->have_sense) {
873 scode = cmdstatp->sense_hdr.sense_key;
875 if (scode == UNIT_ATTENTION) { /* New media? */
877 if (attentions < MAX_ATTENTIONS) {
887 if (scode == NOT_READY) {
888 if (waits < max_wait) {
889 if (msleep_interruptible(1000)) {
897 if ((STp->device)->scsi_level >= SCSI_2 &&
898 cmdstatp->sense_hdr.asc == 0x3a) /* Check ASC */
899 retval = CHKRES_NO_TAPE;
901 retval = CHKRES_NOT_READY;
907 retval = (STp->buffer)->syscall_result;
909 retval = new_session ? CHKRES_NEW_SESSION : CHKRES_READY;
914 st_release_request(SRpnt);
919 /* See if the drive is ready and gather information about the tape. Return values:
920 < 0 negative error code from errno.h
922 1 drive not ready (possibly no tape)
924 static int check_tape(struct scsi_tape *STp, struct file *filp)
926 int i, retval, new_session = 0, do_wait;
927 unsigned char cmd[MAX_COMMAND_SIZE], saved_cleaning;
928 unsigned short st_flags = filp->f_flags;
929 struct st_request *SRpnt = NULL;
930 struct st_modedef *STm;
931 struct st_partstat *STps;
932 char *name = tape_name(STp);
933 struct inode *inode = filp->f_path.dentry->d_inode;
934 int mode = TAPE_MODE(inode);
936 STp->ready = ST_READY;
938 if (mode != STp->current_mode) {
939 DEBC(printk(ST_DEB_MSG "%s: Mode change from %d to %d.\n",
940 name, STp->current_mode, mode));
942 STp->current_mode = mode;
944 STm = &(STp->modes[STp->current_mode]);
946 saved_cleaning = STp->cleaning_req;
947 STp->cleaning_req = 0;
949 do_wait = ((filp->f_flags & O_NONBLOCK) == 0);
950 retval = test_ready(STp, do_wait);
955 if (retval == CHKRES_NEW_SESSION) {
956 STp->pos_unknown = 0;
957 STp->partition = STp->new_partition = 0;
958 if (STp->can_partitions)
959 STp->nbr_partitions = 1; /* This guess will be updated later
961 for (i = 0; i < ST_NBR_PARTITIONS; i++) {
962 STps = &(STp->ps[i]);
964 STps->eof = ST_NOEOF;
966 STps->last_block_valid = 0;
973 STp->cleaning_req |= saved_cleaning;
975 if (retval == CHKRES_NOT_READY || retval == CHKRES_NO_TAPE) {
976 if (retval == CHKRES_NO_TAPE)
977 STp->ready = ST_NO_TAPE;
979 STp->ready = ST_NOT_READY;
981 STp->density = 0; /* Clear the erroneous "residue" */
984 STp->ps[0].drv_file = STp->ps[0].drv_block = (-1);
985 STp->partition = STp->new_partition = 0;
986 STp->door_locked = ST_UNLOCKED;
987 return CHKRES_NOT_READY;
991 if (STp->omit_blklims)
992 STp->min_block = STp->max_block = (-1);
994 memset((void *) &cmd[0], 0, MAX_COMMAND_SIZE);
995 cmd[0] = READ_BLOCK_LIMITS;
997 SRpnt = st_do_scsi(SRpnt, STp, cmd, 6, DMA_FROM_DEVICE,
998 STp->device->request_queue->rq_timeout,
999 MAX_READY_RETRIES, 1);
1001 retval = (STp->buffer)->syscall_result;
1005 if (!SRpnt->result && !STp->buffer->cmdstat.have_sense) {
1006 STp->max_block = ((STp->buffer)->b_data[1] << 16) |
1007 ((STp->buffer)->b_data[2] << 8) | (STp->buffer)->b_data[3];
1008 STp->min_block = ((STp->buffer)->b_data[4] << 8) |
1009 (STp->buffer)->b_data[5];
1010 if ( DEB( debugging || ) !STp->inited)
1012 "%s: Block limits %d - %d bytes.\n", name,
1013 STp->min_block, STp->max_block);
1015 STp->min_block = STp->max_block = (-1);
1016 DEBC(printk(ST_DEB_MSG "%s: Can't read block limits.\n",
1021 memset((void *) &cmd[0], 0, MAX_COMMAND_SIZE);
1022 cmd[0] = MODE_SENSE;
1025 SRpnt = st_do_scsi(SRpnt, STp, cmd, 12, DMA_FROM_DEVICE,
1026 STp->device->request_queue->rq_timeout,
1027 MAX_READY_RETRIES, 1);
1029 retval = (STp->buffer)->syscall_result;
1033 if ((STp->buffer)->syscall_result != 0) {
1034 DEBC(printk(ST_DEB_MSG "%s: No Mode Sense.\n", name));
1035 STp->block_size = ST_DEFAULT_BLOCK; /* Educated guess (?) */
1036 (STp->buffer)->syscall_result = 0; /* Prevent error propagation */
1037 STp->drv_write_prot = 0;
1039 DEBC(printk(ST_DEB_MSG
1040 "%s: Mode sense. Length %d, medium %x, WBS %x, BLL %d\n",
1042 (STp->buffer)->b_data[0], (STp->buffer)->b_data[1],
1043 (STp->buffer)->b_data[2], (STp->buffer)->b_data[3]));
1045 if ((STp->buffer)->b_data[3] >= 8) {
1046 STp->drv_buffer = ((STp->buffer)->b_data[2] >> 4) & 7;
1047 STp->density = (STp->buffer)->b_data[4];
1048 STp->block_size = (STp->buffer)->b_data[9] * 65536 +
1049 (STp->buffer)->b_data[10] * 256 + (STp->buffer)->b_data[11];
1050 DEBC(printk(ST_DEB_MSG
1051 "%s: Density %x, tape length: %x, drv buffer: %d\n",
1052 name, STp->density, (STp->buffer)->b_data[5] * 65536 +
1053 (STp->buffer)->b_data[6] * 256 + (STp->buffer)->b_data[7],
1056 STp->drv_write_prot = ((STp->buffer)->b_data[2] & 0x80) != 0;
1058 st_release_request(SRpnt);
1062 if (STp->block_size > 0)
1063 (STp->buffer)->buffer_blocks =
1064 (STp->buffer)->buffer_size / STp->block_size;
1066 (STp->buffer)->buffer_blocks = 1;
1067 (STp->buffer)->buffer_bytes = (STp->buffer)->read_pointer = 0;
1069 DEBC(printk(ST_DEB_MSG
1070 "%s: Block size: %d, buffer size: %d (%d blocks).\n", name,
1071 STp->block_size, (STp->buffer)->buffer_size,
1072 (STp->buffer)->buffer_blocks));
1074 if (STp->drv_write_prot) {
1075 STp->write_prot = 1;
1077 DEBC(printk(ST_DEB_MSG "%s: Write protected\n", name));
1080 ((st_flags & O_ACCMODE) == O_WRONLY ||
1081 (st_flags & O_ACCMODE) == O_RDWR)) {
1087 if (STp->can_partitions && STp->nbr_partitions < 1) {
1088 /* This code is reached when the device is opened for the first time
1089 after the driver has been initialized with tape in the drive and the
1090 partition support has been enabled. */
1091 DEBC(printk(ST_DEB_MSG
1092 "%s: Updating partition number in status.\n", name));
1093 if ((STp->partition = find_partition(STp)) < 0) {
1094 retval = STp->partition;
1097 STp->new_partition = STp->partition;
1098 STp->nbr_partitions = 1; /* This guess will be updated when necessary */
1101 if (new_session) { /* Change the drive parameters for the new mode */
1102 STp->density_changed = STp->blksize_changed = 0;
1103 STp->compression_changed = 0;
1104 if (!(STm->defaults_for_writes) &&
1105 (retval = set_mode_densblk(STp, STm)) < 0)
1108 if (STp->default_drvbuffer != 0xff) {
1109 if (st_int_ioctl(STp, MTSETDRVBUFFER, STp->default_drvbuffer))
1111 "%s: Can't set default drive buffering to %d.\n",
1112 name, STp->default_drvbuffer);
1116 return CHKRES_READY;
1123 \f/* Open the device. Needs to take the BKL only because of incrementing the SCSI host
1125 static int st_open(struct inode *inode, struct file *filp)
1127 int i, retval = (-EIO);
1128 struct scsi_tape *STp;
1129 struct st_partstat *STps;
1130 int dev = TAPE_NR(inode);
1135 * We really want to do nonseekable_open(inode, filp); here, but some
1136 * versions of tar incorrectly call lseek on tapes and bail out if that
1137 * fails. So we disallow pread() and pwrite(), but permit lseeks.
1139 filp->f_mode &= ~(FMODE_PREAD | FMODE_PWRITE);
1141 if (!(STp = scsi_tape_get(dev))) {
1146 write_lock(&st_dev_arr_lock);
1147 filp->private_data = STp;
1148 name = tape_name(STp);
1151 write_unlock(&st_dev_arr_lock);
1154 DEB( printk(ST_DEB_MSG "%s: Device already in use.\n", name); )
1159 write_unlock(&st_dev_arr_lock);
1160 STp->rew_at_close = STp->autorew_dev = (iminor(inode) & 0x80) == 0;
1162 if (!scsi_block_when_processing_errors(STp->device)) {
1167 /* See that we have at least a one page buffer available */
1168 if (!enlarge_buffer(STp->buffer, PAGE_SIZE, STp->restr_dma)) {
1169 printk(KERN_WARNING "%s: Can't allocate one page tape buffer.\n",
1171 retval = (-EOVERFLOW);
1175 (STp->buffer)->cleared = 0;
1176 (STp->buffer)->writing = 0;
1177 (STp->buffer)->syscall_result = 0;
1179 STp->write_prot = ((filp->f_flags & O_ACCMODE) == O_RDONLY);
1182 for (i = 0; i < ST_NBR_PARTITIONS; i++) {
1183 STps = &(STp->ps[i]);
1186 STp->try_dio_now = STp->try_dio;
1187 STp->recover_count = 0;
1188 DEB( STp->nbr_waits = STp->nbr_finished = 0;
1189 STp->nbr_requests = STp->nbr_dio = STp->nbr_pages = 0; )
1191 retval = check_tape(STp, filp);
1194 if ((filp->f_flags & O_NONBLOCK) == 0 &&
1195 retval != CHKRES_READY) {
1196 if (STp->ready == NO_TAPE)
1197 retval = (-ENOMEDIUM);
1206 normalize_buffer(STp->buffer);
1215 /* Flush the tape buffer before close */
1216 static int st_flush(struct file *filp, fl_owner_t id)
1218 int result = 0, result2;
1219 unsigned char cmd[MAX_COMMAND_SIZE];
1220 struct st_request *SRpnt;
1221 struct scsi_tape *STp = filp->private_data;
1222 struct st_modedef *STm = &(STp->modes[STp->current_mode]);
1223 struct st_partstat *STps = &(STp->ps[STp->partition]);
1224 char *name = tape_name(STp);
1226 if (file_count(filp) > 1)
1229 if (STps->rw == ST_WRITING && !STp->pos_unknown) {
1230 result = st_flush_write_buffer(STp);
1231 if (result != 0 && result != (-ENOSPC))
1235 if (STp->can_partitions &&
1236 (result2 = switch_partition(STp)) < 0) {
1237 DEBC(printk(ST_DEB_MSG
1238 "%s: switch_partition at close failed.\n", name));
1244 DEBC( if (STp->nbr_requests)
1245 printk(KERN_DEBUG "%s: Number of r/w requests %d, dio used in %d, pages %d.\n",
1246 name, STp->nbr_requests, STp->nbr_dio, STp->nbr_pages));
1248 if (STps->rw == ST_WRITING && !STp->pos_unknown) {
1249 struct st_cmdstatus *cmdstatp = &STp->buffer->cmdstat;
1251 DEBC(printk(ST_DEB_MSG "%s: Async write waits %d, finished %d.\n",
1252 name, STp->nbr_waits, STp->nbr_finished);
1255 memset(cmd, 0, MAX_COMMAND_SIZE);
1256 cmd[0] = WRITE_FILEMARKS;
1257 cmd[4] = 1 + STp->two_fm;
1259 SRpnt = st_do_scsi(NULL, STp, cmd, 0, DMA_NONE,
1260 STp->device->request_queue->rq_timeout,
1261 MAX_WRITE_RETRIES, 1);
1263 result = (STp->buffer)->syscall_result;
1267 if (STp->buffer->syscall_result == 0 ||
1268 (cmdstatp->have_sense && !cmdstatp->deferred &&
1269 (cmdstatp->flags & SENSE_EOM) &&
1270 (cmdstatp->sense_hdr.sense_key == NO_SENSE ||
1271 cmdstatp->sense_hdr.sense_key == RECOVERED_ERROR) &&
1272 (!cmdstatp->remainder_valid || cmdstatp->uremainder64 == 0))) {
1273 /* Write successful at EOM */
1274 st_release_request(SRpnt);
1276 if (STps->drv_file >= 0)
1278 STps->drv_block = 0;
1283 else { /* Write error */
1284 st_release_request(SRpnt);
1286 printk(KERN_ERR "%s: Error on write filemark.\n", name);
1291 DEBC(printk(ST_DEB_MSG "%s: Buffer flushed, %d EOF(s) written\n",
1293 } else if (!STp->rew_at_close) {
1294 STps = &(STp->ps[STp->partition]);
1295 if (!STm->sysv || STps->rw != ST_READING) {
1297 result = flush_buffer(STp, 0);
1298 else if (STps->eof == ST_FM_HIT) {
1299 result = cross_eof(STp, 0);
1301 if (STps->drv_file >= 0)
1303 STps->drv_block = 0;
1306 STps->eof = ST_NOEOF;
1308 } else if ((STps->eof == ST_NOEOF &&
1309 !(result = cross_eof(STp, 1))) ||
1310 STps->eof == ST_FM_HIT) {
1311 if (STps->drv_file >= 0)
1313 STps->drv_block = 0;
1319 if (STp->rew_at_close) {
1320 result2 = st_int_ioctl(STp, MTREW, 1);
1328 /* Close the device and release it. BKL is not needed: this is the only thread
1329 accessing this tape. */
1330 static int st_release(struct inode *inode, struct file *filp)
1333 struct scsi_tape *STp = filp->private_data;
1335 if (STp->door_locked == ST_LOCKED_AUTO)
1336 do_door_lock(STp, 0);
1338 normalize_buffer(STp->buffer);
1339 write_lock(&st_dev_arr_lock);
1341 write_unlock(&st_dev_arr_lock);
1347 /* The checks common to both reading and writing */
1348 static ssize_t rw_checks(struct scsi_tape *STp, struct file *filp, size_t count)
1353 * If we are in the middle of error recovery, don't let anyone
1354 * else try and use this device. Also, if error recovery fails, it
1355 * may try and take the device offline, in which case all further
1356 * access to the device is prohibited.
1358 if (!scsi_block_when_processing_errors(STp->device)) {
1363 if (STp->ready != ST_READY) {
1364 if (STp->ready == ST_NO_TAPE)
1365 retval = (-ENOMEDIUM);
1371 if (! STp->modes[STp->current_mode].defined) {
1378 * If there was a bus reset, block further access
1381 if (STp->pos_unknown) {
1391 printk(ST_DEB_MSG "%s: Incorrect device.\n", tape_name(STp));
1396 if (STp->can_partitions &&
1397 (retval = switch_partition(STp)) < 0)
1400 if (STp->block_size == 0 && STp->max_block > 0 &&
1401 (count < STp->min_block || count > STp->max_block)) {
1406 if (STp->do_auto_lock && STp->door_locked == ST_UNLOCKED &&
1407 !do_door_lock(STp, 1))
1408 STp->door_locked = ST_LOCKED_AUTO;
1415 static int setup_buffering(struct scsi_tape *STp, const char __user *buf,
1416 size_t count, int is_read)
1418 int i, bufsize, retval = 0;
1419 struct st_buffer *STbp = STp->buffer;
1422 i = STp->try_dio_now && try_rdio;
1424 i = STp->try_dio_now && try_wdio;
1426 if (i && ((unsigned long)buf & queue_dma_alignment(
1427 STp->device->request_queue)) == 0) {
1428 i = sgl_map_user_pages(&(STbp->sg[0]), STbp->use_sg,
1429 (unsigned long)buf, count, (is_read ? READ : WRITE));
1432 STbp->buffer_bytes = 0; /* can be used as transfer counter */
1435 STbp->do_dio = 0; /* fall back to buffering with any error */
1436 STbp->sg_segs = STbp->do_dio;
1437 STbp->frp_sg_current = 0;
1441 STp->nbr_pages += STbp->do_dio;
1446 DEB( STp->nbr_requests++; )
1448 if (!STbp->do_dio) {
1449 if (STp->block_size)
1450 bufsize = STp->block_size > st_fixed_buffer_size ?
1451 STp->block_size : st_fixed_buffer_size;
1454 /* Make sure that data from previous user is not leaked even if
1455 HBA does not return correct residual */
1456 if (is_read && STp->sili && !STbp->cleared)
1460 if (bufsize > STbp->buffer_size &&
1461 !enlarge_buffer(STbp, bufsize, STp->restr_dma)) {
1462 printk(KERN_WARNING "%s: Can't allocate %d byte tape buffer.\n",
1463 tape_name(STp), bufsize);
1464 retval = (-EOVERFLOW);
1467 if (STp->block_size)
1468 STbp->buffer_blocks = bufsize / STp->block_size;
1476 /* Can be called more than once after each setup_buffer() */
1477 static void release_buffering(struct scsi_tape *STp, int is_read)
1479 struct st_buffer *STbp;
1483 sgl_unmap_user_pages(&(STbp->sg[0]), STbp->do_dio, is_read);
1492 st_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
1495 ssize_t i, do_count, blks, transfer;
1497 int undone, retry_eot = 0, scode;
1499 unsigned char cmd[MAX_COMMAND_SIZE];
1500 const char __user *b_point;
1501 struct st_request *SRpnt = NULL;
1502 struct scsi_tape *STp = filp->private_data;
1503 struct st_modedef *STm;
1504 struct st_partstat *STps;
1505 struct st_buffer *STbp;
1506 char *name = tape_name(STp);
1508 if (mutex_lock_interruptible(&STp->lock))
1509 return -ERESTARTSYS;
1511 retval = rw_checks(STp, filp, count);
1512 if (retval || count == 0)
1515 /* Write must be integral number of blocks */
1516 if (STp->block_size != 0 && (count % STp->block_size) != 0) {
1517 printk(KERN_WARNING "%s: Write not multiple of tape block size.\n",
1523 STm = &(STp->modes[STp->current_mode]);
1524 STps = &(STp->ps[STp->partition]);
1526 if (STp->write_prot) {
1532 if (STps->rw == ST_READING) {
1533 retval = flush_buffer(STp, 0);
1536 STps->rw = ST_WRITING;
1537 } else if (STps->rw != ST_WRITING &&
1538 STps->drv_file == 0 && STps->drv_block == 0) {
1539 if ((retval = set_mode_densblk(STp, STm)) < 0)
1541 if (STm->default_compression != ST_DONT_TOUCH &&
1542 !(STp->compression_changed)) {
1543 if (st_compression(STp, (STm->default_compression == ST_YES))) {
1544 printk(KERN_WARNING "%s: Can't set default compression.\n",
1546 if (modes_defined) {
1555 i = write_behind_check(STp);
1558 STps->eof = ST_EOM_OK;
1560 STps->eof = ST_EOM_ERROR;
1563 if (STps->eof == ST_EOM_OK) {
1564 STps->eof = ST_EOD_1; /* allow next write */
1568 else if (STps->eof == ST_EOM_ERROR) {
1573 /* Check the buffer readability in cases where copy_user might catch
1574 the problems after some tape movement. */
1575 if (STp->block_size != 0 &&
1577 (copy_from_user(&i, buf, 1) != 0 ||
1578 copy_from_user(&i, buf + count - 1, 1) != 0)) {
1583 retval = setup_buffering(STp, buf, count, 0);
1589 memset(cmd, 0, MAX_COMMAND_SIZE);
1591 cmd[1] = (STp->block_size != 0);
1593 STps->rw = ST_WRITING;
1596 while (count > 0 && !retry_eot) {
1602 if (STp->block_size == 0)
1605 do_count = STbp->buffer_blocks * STp->block_size -
1607 if (do_count > count)
1611 i = append_to_buffer(b_point, STbp, do_count);
1618 b_point += do_count;
1620 async_write = STp->block_size == 0 && !STbp->do_dio &&
1621 STm->do_async_writes && STps->eof < ST_EOM_OK;
1623 if (STp->block_size != 0 && STm->do_buffer_writes &&
1624 !(STp->try_dio_now && try_wdio) && STps->eof < ST_EOM_OK &&
1625 STbp->buffer_bytes < STbp->buffer_size) {
1627 /* Don't write a buffer that is not full enough. */
1628 if (!async_write && count == 0)
1633 if (STp->block_size == 0)
1634 blks = transfer = do_count;
1637 blks = STbp->buffer_bytes;
1640 blks /= STp->block_size;
1641 transfer = blks * STp->block_size;
1643 cmd[2] = blks >> 16;
1647 SRpnt = st_do_scsi(SRpnt, STp, cmd, transfer, DMA_TO_DEVICE,
1648 STp->device->request_queue->rq_timeout,
1649 MAX_WRITE_RETRIES, !async_write);
1651 retval = STbp->syscall_result;
1654 if (async_write && !STbp->syscall_result) {
1655 STbp->writing = transfer;
1656 STp->dirty = !(STbp->writing ==
1657 STbp->buffer_bytes);
1658 SRpnt = NULL; /* Prevent releasing this request! */
1659 DEB( STp->write_pending = 1; )
1663 if (STbp->syscall_result != 0) {
1664 struct st_cmdstatus *cmdstatp = &STp->buffer->cmdstat;
1666 DEBC(printk(ST_DEB_MSG "%s: Error on write:\n", name));
1667 if (cmdstatp->have_sense && (cmdstatp->flags & SENSE_EOM)) {
1668 scode = cmdstatp->sense_hdr.sense_key;
1669 if (cmdstatp->remainder_valid)
1670 undone = (int)cmdstatp->uremainder64;
1671 else if (STp->block_size == 0 &&
1672 scode == VOLUME_OVERFLOW)
1676 if (STp->block_size != 0)
1677 undone *= STp->block_size;
1678 if (undone <= do_count) {
1679 /* Only data from this write is not written */
1683 if (STp->block_size)
1684 blks = (transfer - undone) / STp->block_size;
1685 STps->eof = ST_EOM_OK;
1686 /* Continue in fixed block mode if all written
1687 in this request but still something left to write
1688 (retval left to zero)
1690 if (STp->block_size == 0 ||
1691 undone > 0 || count == 0)
1692 retval = (-ENOSPC); /* EOM within current request */
1693 DEBC(printk(ST_DEB_MSG
1694 "%s: EOM with %d bytes unwritten.\n",
1697 /* EOT within data buffered earlier (possible only
1698 in fixed block mode without direct i/o) */
1699 if (!retry_eot && !cmdstatp->deferred &&
1700 (scode == NO_SENSE || scode == RECOVERED_ERROR)) {
1701 move_buffer_data(STp->buffer, transfer - undone);
1703 if (STps->drv_block >= 0) {
1704 STps->drv_block += (transfer - undone) /
1707 STps->eof = ST_EOM_OK;
1708 DEBC(printk(ST_DEB_MSG
1709 "%s: Retry write of %d bytes at EOM.\n",
1710 name, STp->buffer->buffer_bytes));
1714 /* Either error within data buffered by driver or
1717 blks = do_count = 0;
1718 STps->eof = ST_EOM_ERROR;
1719 STps->drv_block = (-1); /* Too cautious? */
1720 retval = (-EIO); /* EOM for old data */
1721 DEBC(printk(ST_DEB_MSG
1722 "%s: EOM with lost data.\n",
1728 STps->drv_block = (-1); /* Too cautious? */
1729 retval = STbp->syscall_result;
1734 if (STps->drv_block >= 0) {
1735 if (STp->block_size == 0)
1736 STps->drv_block += (do_count > 0);
1738 STps->drv_block += blks;
1741 STbp->buffer_bytes = 0;
1744 if (retval || retry_eot) {
1746 retval = total - count;
1751 if (STps->eof == ST_EOD_1)
1752 STps->eof = ST_EOM_OK;
1753 else if (STps->eof != ST_EOM_OK)
1754 STps->eof = ST_NOEOF;
1755 retval = total - count;
1759 st_release_request(SRpnt);
1760 release_buffering(STp, 0);
1761 mutex_unlock(&STp->lock);
1766 /* Read data from the tape. Returns zero in the normal case, one if the
1767 eof status has changed, and the negative error code in case of a
1768 fatal error. Otherwise updates the buffer and the eof state.
1770 Does release user buffer mapping if it is set.
1772 static long read_tape(struct scsi_tape *STp, long count,
1773 struct st_request ** aSRpnt)
1775 int transfer, blks, bytes;
1776 unsigned char cmd[MAX_COMMAND_SIZE];
1777 struct st_request *SRpnt;
1778 struct st_modedef *STm;
1779 struct st_partstat *STps;
1780 struct st_buffer *STbp;
1782 char *name = tape_name(STp);
1787 STm = &(STp->modes[STp->current_mode]);
1788 STps = &(STp->ps[STp->partition]);
1789 if (STps->eof == ST_FM_HIT)
1793 if (STp->block_size == 0)
1794 blks = bytes = count;
1796 if (!(STp->try_dio_now && try_rdio) && STm->do_read_ahead) {
1797 blks = (STp->buffer)->buffer_blocks;
1798 bytes = blks * STp->block_size;
1801 if (!STbp->do_dio && bytes > (STp->buffer)->buffer_size)
1802 bytes = (STp->buffer)->buffer_size;
1803 blks = bytes / STp->block_size;
1804 bytes = blks * STp->block_size;
1808 memset(cmd, 0, MAX_COMMAND_SIZE);
1810 cmd[1] = (STp->block_size != 0);
1811 if (!cmd[1] && STp->sili)
1813 cmd[2] = blks >> 16;
1818 SRpnt = st_do_scsi(SRpnt, STp, cmd, bytes, DMA_FROM_DEVICE,
1819 STp->device->request_queue->rq_timeout,
1821 release_buffering(STp, 1);
1824 return STbp->syscall_result;
1826 STbp->read_pointer = 0;
1829 /* Something to check */
1830 if (STbp->syscall_result) {
1831 struct st_cmdstatus *cmdstatp = &STp->buffer->cmdstat;
1834 DEBC(printk(ST_DEB_MSG "%s: Sense: %2x %2x %2x %2x %2x %2x %2x %2x\n",
1836 SRpnt->sense[0], SRpnt->sense[1],
1837 SRpnt->sense[2], SRpnt->sense[3],
1838 SRpnt->sense[4], SRpnt->sense[5],
1839 SRpnt->sense[6], SRpnt->sense[7]));
1840 if (cmdstatp->have_sense) {
1842 if (cmdstatp->sense_hdr.sense_key == BLANK_CHECK)
1843 cmdstatp->flags &= 0xcf; /* No need for EOM in this case */
1845 if (cmdstatp->flags != 0) { /* EOF, EOM, or ILI */
1846 /* Compute the residual count */
1847 if (cmdstatp->remainder_valid)
1848 transfer = (int)cmdstatp->uremainder64;
1851 if (STp->block_size == 0 &&
1852 cmdstatp->sense_hdr.sense_key == MEDIUM_ERROR)
1855 if (cmdstatp->flags & SENSE_ILI) { /* ILI */
1856 if (STp->block_size == 0) {
1857 if (transfer <= 0) {
1860 "%s: Failed to read %d byte block with %d byte transfer.\n",
1861 name, bytes - transfer, bytes);
1862 if (STps->drv_block >= 0)
1863 STps->drv_block += 1;
1864 STbp->buffer_bytes = 0;
1867 STbp->buffer_bytes = bytes - transfer;
1869 st_release_request(SRpnt);
1870 SRpnt = *aSRpnt = NULL;
1871 if (transfer == blks) { /* We did not get anything, error */
1872 printk(KERN_NOTICE "%s: Incorrect block size.\n", name);
1873 if (STps->drv_block >= 0)
1874 STps->drv_block += blks - transfer + 1;
1875 st_int_ioctl(STp, MTBSR, 1);
1878 /* We have some data, deliver it */
1879 STbp->buffer_bytes = (blks - transfer) *
1881 DEBC(printk(ST_DEB_MSG
1882 "%s: ILI but enough data received %ld %d.\n",
1883 name, count, STbp->buffer_bytes));
1884 if (STps->drv_block >= 0)
1885 STps->drv_block += 1;
1886 if (st_int_ioctl(STp, MTBSR, 1))
1889 } else if (cmdstatp->flags & SENSE_FMK) { /* FM overrides EOM */
1890 if (STps->eof != ST_FM_HIT)
1891 STps->eof = ST_FM_HIT;
1893 STps->eof = ST_EOD_2;
1894 if (STp->block_size == 0)
1895 STbp->buffer_bytes = 0;
1897 STbp->buffer_bytes =
1898 bytes - transfer * STp->block_size;
1899 DEBC(printk(ST_DEB_MSG
1900 "%s: EOF detected (%d bytes read).\n",
1901 name, STbp->buffer_bytes));
1902 } else if (cmdstatp->flags & SENSE_EOM) {
1903 if (STps->eof == ST_FM)
1904 STps->eof = ST_EOD_1;
1906 STps->eof = ST_EOM_OK;
1907 if (STp->block_size == 0)
1908 STbp->buffer_bytes = bytes - transfer;
1910 STbp->buffer_bytes =
1911 bytes - transfer * STp->block_size;
1913 DEBC(printk(ST_DEB_MSG "%s: EOM detected (%d bytes read).\n",
1914 name, STbp->buffer_bytes));
1917 /* end of EOF, EOM, ILI test */
1918 else { /* nonzero sense key */
1919 DEBC(printk(ST_DEB_MSG
1920 "%s: Tape error while reading.\n", name));
1921 STps->drv_block = (-1);
1922 if (STps->eof == ST_FM &&
1923 cmdstatp->sense_hdr.sense_key == BLANK_CHECK) {
1924 DEBC(printk(ST_DEB_MSG
1925 "%s: Zero returned for first BLANK CHECK after EOF.\n",
1927 STps->eof = ST_EOD_2; /* First BLANK_CHECK after FM */
1928 } else /* Some other extended sense code */
1932 if (STbp->buffer_bytes < 0) /* Caused by bogus sense data */
1933 STbp->buffer_bytes = 0;
1935 /* End of extended sense test */
1936 else { /* Non-extended sense */
1937 retval = STbp->syscall_result;
1941 /* End of error handling */
1942 else { /* Read successful */
1943 STbp->buffer_bytes = bytes;
1944 if (STp->sili) /* In fixed block mode residual is always zero here */
1945 STbp->buffer_bytes -= STp->buffer->cmdstat.residual;
1948 if (STps->drv_block >= 0) {
1949 if (STp->block_size == 0)
1952 STps->drv_block += STbp->buffer_bytes / STp->block_size;
1960 st_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
1964 ssize_t i, transfer;
1965 int special, do_dio = 0;
1966 struct st_request *SRpnt = NULL;
1967 struct scsi_tape *STp = filp->private_data;
1968 struct st_modedef *STm;
1969 struct st_partstat *STps;
1970 struct st_buffer *STbp = STp->buffer;
1971 DEB( char *name = tape_name(STp); )
1973 if (mutex_lock_interruptible(&STp->lock))
1974 return -ERESTARTSYS;
1976 retval = rw_checks(STp, filp, count);
1977 if (retval || count == 0)
1980 STm = &(STp->modes[STp->current_mode]);
1981 if (STp->block_size != 0 && (count % STp->block_size) != 0) {
1982 if (!STm->do_read_ahead) {
1983 retval = (-EINVAL); /* Read must be integral number of blocks */
1986 STp->try_dio_now = 0; /* Direct i/o can't handle split blocks */
1989 STps = &(STp->ps[STp->partition]);
1990 if (STps->rw == ST_WRITING) {
1991 retval = flush_buffer(STp, 0);
1994 STps->rw = ST_READING;
1997 if (debugging && STps->eof != ST_NOEOF)
1998 printk(ST_DEB_MSG "%s: EOF/EOM flag up (%d). Bytes %d\n", name,
1999 STps->eof, STbp->buffer_bytes);
2002 retval = setup_buffering(STp, buf, count, 1);
2005 do_dio = STbp->do_dio;
2007 if (STbp->buffer_bytes == 0 &&
2008 STps->eof >= ST_EOD_1) {
2009 if (STps->eof < ST_EOD) {
2014 retval = (-EIO); /* EOM or Blank Check */
2019 /* Check the buffer writability before any tape movement. Don't alter
2021 if (copy_from_user(&i, buf, 1) != 0 ||
2022 copy_to_user(buf, &i, 1) != 0 ||
2023 copy_from_user(&i, buf + count - 1, 1) != 0 ||
2024 copy_to_user(buf + count - 1, &i, 1) != 0) {
2030 STps->rw = ST_READING;
2033 /* Loop until enough data in buffer or a special condition found */
2034 for (total = 0, special = 0; total < count && !special;) {
2036 /* Get new data if the buffer is empty */
2037 if (STbp->buffer_bytes == 0) {
2038 special = read_tape(STp, count - total, &SRpnt);
2039 if (special < 0) { /* No need to continue read */
2045 /* Move the data from driver buffer to user buffer */
2046 if (STbp->buffer_bytes > 0) {
2048 if (debugging && STps->eof != ST_NOEOF)
2050 "%s: EOF up (%d). Left %d, needed %d.\n", name,
2051 STps->eof, STbp->buffer_bytes,
2052 (int)(count - total));
2054 transfer = STbp->buffer_bytes < count - total ?
2055 STbp->buffer_bytes : count - total;
2057 i = from_buffer(STbp, buf, transfer);
2067 if (STp->block_size == 0)
2068 break; /* Read only one variable length block */
2070 } /* for (total = 0, special = 0;
2071 total < count && !special; ) */
2073 /* Change the eof state if no data from tape or buffer */
2075 if (STps->eof == ST_FM_HIT) {
2077 STps->drv_block = 0;
2078 if (STps->drv_file >= 0)
2080 } else if (STps->eof == ST_EOD_1) {
2081 STps->eof = ST_EOD_2;
2082 STps->drv_block = 0;
2083 if (STps->drv_file >= 0)
2085 } else if (STps->eof == ST_EOD_2)
2087 } else if (STps->eof == ST_FM)
2088 STps->eof = ST_NOEOF;
2092 if (SRpnt != NULL) {
2093 st_release_request(SRpnt);
2097 release_buffering(STp, 1);
2098 STbp->buffer_bytes = 0;
2100 mutex_unlock(&STp->lock);
2108 /* Set the driver options */
2109 static void st_log_options(struct scsi_tape * STp, struct st_modedef * STm, char *name)
2113 "%s: Mode %d options: buffer writes: %d, async writes: %d, read ahead: %d\n",
2114 name, STp->current_mode, STm->do_buffer_writes, STm->do_async_writes,
2115 STm->do_read_ahead);
2117 "%s: can bsr: %d, two FMs: %d, fast mteom: %d, auto lock: %d,\n",
2118 name, STp->can_bsr, STp->two_fm, STp->fast_mteom, STp->do_auto_lock);
2120 "%s: defs for wr: %d, no block limits: %d, partitions: %d, s2 log: %d\n",
2121 name, STm->defaults_for_writes, STp->omit_blklims, STp->can_partitions,
2122 STp->scsi2_logical);
2124 "%s: sysv: %d nowait: %d sili: %d\n", name, STm->sysv, STp->immediate,
2126 printk(KERN_INFO "%s: debugging: %d\n",
2133 static int st_set_options(struct scsi_tape *STp, long options)
2137 struct st_modedef *STm;
2138 char *name = tape_name(STp);
2139 struct cdev *cd0, *cd1;
2141 STm = &(STp->modes[STp->current_mode]);
2142 if (!STm->defined) {
2143 cd0 = STm->cdevs[0]; cd1 = STm->cdevs[1];
2144 memcpy(STm, &(STp->modes[0]), sizeof(struct st_modedef));
2145 STm->cdevs[0] = cd0; STm->cdevs[1] = cd1;
2147 DEBC(printk(ST_DEB_MSG
2148 "%s: Initialized mode %d definition from mode 0\n",
2149 name, STp->current_mode));
2152 code = options & MT_ST_OPTIONS;
2153 if (code == MT_ST_BOOLEANS) {
2154 STm->do_buffer_writes = (options & MT_ST_BUFFER_WRITES) != 0;
2155 STm->do_async_writes = (options & MT_ST_ASYNC_WRITES) != 0;
2156 STm->defaults_for_writes = (options & MT_ST_DEF_WRITES) != 0;
2157 STm->do_read_ahead = (options & MT_ST_READ_AHEAD) != 0;
2158 STp->two_fm = (options & MT_ST_TWO_FM) != 0;
2159 STp->fast_mteom = (options & MT_ST_FAST_MTEOM) != 0;
2160 STp->do_auto_lock = (options & MT_ST_AUTO_LOCK) != 0;
2161 STp->can_bsr = (options & MT_ST_CAN_BSR) != 0;
2162 STp->omit_blklims = (options & MT_ST_NO_BLKLIMS) != 0;
2163 if ((STp->device)->scsi_level >= SCSI_2)
2164 STp->can_partitions = (options & MT_ST_CAN_PARTITIONS) != 0;
2165 STp->scsi2_logical = (options & MT_ST_SCSI2LOGICAL) != 0;
2166 STp->immediate = (options & MT_ST_NOWAIT) != 0;
2167 STm->sysv = (options & MT_ST_SYSV) != 0;
2168 STp->sili = (options & MT_ST_SILI) != 0;
2169 DEB( debugging = (options & MT_ST_DEBUGGING) != 0;
2170 st_log_options(STp, STm, name); )
2171 } else if (code == MT_ST_SETBOOLEANS || code == MT_ST_CLEARBOOLEANS) {
2172 value = (code == MT_ST_SETBOOLEANS);
2173 if ((options & MT_ST_BUFFER_WRITES) != 0)
2174 STm->do_buffer_writes = value;
2175 if ((options & MT_ST_ASYNC_WRITES) != 0)
2176 STm->do_async_writes = value;
2177 if ((options & MT_ST_DEF_WRITES) != 0)
2178 STm->defaults_for_writes = value;
2179 if ((options & MT_ST_READ_AHEAD) != 0)
2180 STm->do_read_ahead = value;
2181 if ((options & MT_ST_TWO_FM) != 0)
2182 STp->two_fm = value;
2183 if ((options & MT_ST_FAST_MTEOM) != 0)
2184 STp->fast_mteom = value;
2185 if ((options & MT_ST_AUTO_LOCK) != 0)
2186 STp->do_auto_lock = value;
2187 if ((options & MT_ST_CAN_BSR) != 0)
2188 STp->can_bsr = value;
2189 if ((options & MT_ST_NO_BLKLIMS) != 0)
2190 STp->omit_blklims = value;
2191 if ((STp->device)->scsi_level >= SCSI_2 &&
2192 (options & MT_ST_CAN_PARTITIONS) != 0)
2193 STp->can_partitions = value;
2194 if ((options & MT_ST_SCSI2LOGICAL) != 0)
2195 STp->scsi2_logical = value;
2196 if ((options & MT_ST_NOWAIT) != 0)
2197 STp->immediate = value;
2198 if ((options & MT_ST_SYSV) != 0)
2200 if ((options & MT_ST_SILI) != 0)
2203 if ((options & MT_ST_DEBUGGING) != 0)
2205 st_log_options(STp, STm, name); )
2206 } else if (code == MT_ST_WRITE_THRESHOLD) {
2207 /* Retained for compatibility */
2208 } else if (code == MT_ST_DEF_BLKSIZE) {
2209 value = (options & ~MT_ST_OPTIONS);
2210 if (value == ~MT_ST_OPTIONS) {
2211 STm->default_blksize = (-1);
2212 DEBC( printk(KERN_INFO "%s: Default block size disabled.\n", name));
2214 STm->default_blksize = value;
2215 DEBC( printk(KERN_INFO "%s: Default block size set to %d bytes.\n",
2216 name, STm->default_blksize));
2217 if (STp->ready == ST_READY) {
2218 STp->blksize_changed = 0;
2219 set_mode_densblk(STp, STm);
2222 } else if (code == MT_ST_TIMEOUTS) {
2223 value = (options & ~MT_ST_OPTIONS);
2224 if ((value & MT_ST_SET_LONG_TIMEOUT) != 0) {
2225 STp->long_timeout = (value & ~MT_ST_SET_LONG_TIMEOUT) * HZ;
2226 DEBC( printk(KERN_INFO "%s: Long timeout set to %d seconds.\n", name,
2227 (value & ~MT_ST_SET_LONG_TIMEOUT)));
2229 blk_queue_rq_timeout(STp->device->request_queue,
2231 DEBC( printk(KERN_INFO "%s: Normal timeout set to %d seconds.\n",
2234 } else if (code == MT_ST_SET_CLN) {
2235 value = (options & ~MT_ST_OPTIONS) & 0xff;
2237 value < EXTENDED_SENSE_START && value >= SCSI_SENSE_BUFFERSIZE)
2239 STp->cln_mode = value;
2240 STp->cln_sense_mask = (options >> 8) & 0xff;
2241 STp->cln_sense_value = (options >> 16) & 0xff;
2243 "%s: Cleaning request mode %d, mask %02x, value %02x\n",
2244 name, value, STp->cln_sense_mask, STp->cln_sense_value);
2245 } else if (code == MT_ST_DEF_OPTIONS) {
2246 code = (options & ~MT_ST_CLEAR_DEFAULT);
2247 value = (options & MT_ST_CLEAR_DEFAULT);
2248 if (code == MT_ST_DEF_DENSITY) {
2249 if (value == MT_ST_CLEAR_DEFAULT) {
2250 STm->default_density = (-1);
2251 DEBC( printk(KERN_INFO "%s: Density default disabled.\n",
2254 STm->default_density = value & 0xff;
2255 DEBC( printk(KERN_INFO "%s: Density default set to %x\n",
2256 name, STm->default_density));
2257 if (STp->ready == ST_READY) {
2258 STp->density_changed = 0;
2259 set_mode_densblk(STp, STm);
2262 } else if (code == MT_ST_DEF_DRVBUFFER) {
2263 if (value == MT_ST_CLEAR_DEFAULT) {
2264 STp->default_drvbuffer = 0xff;
2265 DEBC( printk(KERN_INFO
2266 "%s: Drive buffer default disabled.\n", name));
2268 STp->default_drvbuffer = value & 7;
2269 DEBC( printk(KERN_INFO
2270 "%s: Drive buffer default set to %x\n",
2271 name, STp->default_drvbuffer));
2272 if (STp->ready == ST_READY)
2273 st_int_ioctl(STp, MTSETDRVBUFFER, STp->default_drvbuffer);
2275 } else if (code == MT_ST_DEF_COMPRESSION) {
2276 if (value == MT_ST_CLEAR_DEFAULT) {
2277 STm->default_compression = ST_DONT_TOUCH;
2278 DEBC( printk(KERN_INFO
2279 "%s: Compression default disabled.\n", name));
2281 if ((value & 0xff00) != 0) {
2282 STp->c_algo = (value & 0xff00) >> 8;
2283 DEBC( printk(KERN_INFO "%s: Compression algorithm set to 0x%x.\n",
2284 name, STp->c_algo));
2286 if ((value & 0xff) != 0xff) {
2287 STm->default_compression = (value & 1 ? ST_YES : ST_NO);
2288 DEBC( printk(KERN_INFO "%s: Compression default set to %x\n",
2289 name, (value & 1)));
2290 if (STp->ready == ST_READY) {
2291 STp->compression_changed = 0;
2292 st_compression(STp, (STm->default_compression == ST_YES));
2303 #define MODE_HEADER_LENGTH 4
2305 /* Mode header and page byte offsets */
2306 #define MH_OFF_DATA_LENGTH 0
2307 #define MH_OFF_MEDIUM_TYPE 1
2308 #define MH_OFF_DEV_SPECIFIC 2
2309 #define MH_OFF_BDESCS_LENGTH 3
2310 #define MP_OFF_PAGE_NBR 0
2311 #define MP_OFF_PAGE_LENGTH 1
2313 /* Mode header and page bit masks */
2314 #define MH_BIT_WP 0x80
2315 #define MP_MSK_PAGE_NBR 0x3f
2317 /* Don't return block descriptors */
2318 #define MODE_SENSE_OMIT_BDESCS 0x08
2320 #define MODE_SELECT_PAGE_FORMAT 0x10
2322 /* Read a mode page into the tape buffer. The block descriptors are included
2323 if incl_block_descs is true. The page control is ored to the page number
2324 parameter, if necessary. */
2325 static int read_mode_page(struct scsi_tape *STp, int page, int omit_block_descs)
2327 unsigned char cmd[MAX_COMMAND_SIZE];
2328 struct st_request *SRpnt = NULL;
2330 memset(cmd, 0, MAX_COMMAND_SIZE);
2331 cmd[0] = MODE_SENSE;
2332 if (omit_block_descs)
2333 cmd[1] = MODE_SENSE_OMIT_BDESCS;
2337 SRpnt = st_do_scsi(SRpnt, STp, cmd, cmd[4], DMA_FROM_DEVICE,
2338 STp->device->request_queue->rq_timeout, 0, 1);
2340 return (STp->buffer)->syscall_result;
2342 st_release_request(SRpnt);
2344 return (STp->buffer)->syscall_result;
2348 /* Send the mode page in the tape buffer to the drive. Assumes that the mode data
2349 in the buffer is correctly formatted. The long timeout is used if slow is non-zero. */
2350 static int write_mode_page(struct scsi_tape *STp, int page, int slow)
2353 unsigned char cmd[MAX_COMMAND_SIZE];
2354 struct st_request *SRpnt = NULL;
2356 memset(cmd, 0, MAX_COMMAND_SIZE);
2357 cmd[0] = MODE_SELECT;
2358 cmd[1] = MODE_SELECT_PAGE_FORMAT;
2359 pgo = MODE_HEADER_LENGTH + (STp->buffer)->b_data[MH_OFF_BDESCS_LENGTH];
2360 cmd[4] = pgo + (STp->buffer)->b_data[pgo + MP_OFF_PAGE_LENGTH] + 2;
2362 /* Clear reserved fields */
2363 (STp->buffer)->b_data[MH_OFF_DATA_LENGTH] = 0;
2364 (STp->buffer)->b_data[MH_OFF_MEDIUM_TYPE] = 0;
2365 (STp->buffer)->b_data[MH_OFF_DEV_SPECIFIC] &= ~MH_BIT_WP;
2366 (STp->buffer)->b_data[pgo + MP_OFF_PAGE_NBR] &= MP_MSK_PAGE_NBR;
2368 SRpnt = st_do_scsi(SRpnt, STp, cmd, cmd[4], DMA_TO_DEVICE,
2369 (slow ? STp->long_timeout : STp->device->request_queue->rq_timeout), 0, 1);
2371 return (STp->buffer)->syscall_result;
2373 st_release_request(SRpnt);
2375 return (STp->buffer)->syscall_result;
2379 #define COMPRESSION_PAGE 0x0f
2380 #define COMPRESSION_PAGE_LENGTH 16
2382 #define CP_OFF_DCE_DCC 2
2383 #define CP_OFF_C_ALGO 7
2385 #define DCE_MASK 0x80
2386 #define DCC_MASK 0x40
2387 #define RED_MASK 0x60
2390 /* Control the compression with mode page 15. Algorithm not changed if zero.
2392 The block descriptors are read and written because Sony SDT-7000 does not
2393 work without this (suggestion from Michael Schaefer <Michael.Schaefer@dlr.de>).
2394 Including block descriptors should not cause any harm to other drives. */
2396 static int st_compression(struct scsi_tape * STp, int state)
2399 int mpoffs; /* Offset to mode page start */
2400 unsigned char *b_data = (STp->buffer)->b_data;
2401 DEB( char *name = tape_name(STp); )
2403 if (STp->ready != ST_READY)
2406 /* Read the current page contents */
2407 retval = read_mode_page(STp, COMPRESSION_PAGE, 0);
2409 DEBC(printk(ST_DEB_MSG "%s: Compression mode page not supported.\n",
2414 mpoffs = MODE_HEADER_LENGTH + b_data[MH_OFF_BDESCS_LENGTH];
2415 DEBC(printk(ST_DEB_MSG "%s: Compression state is %d.\n", name,
2416 (b_data[mpoffs + CP_OFF_DCE_DCC] & DCE_MASK ? 1 : 0)));
2418 /* Check if compression can be changed */
2419 if ((b_data[mpoffs + CP_OFF_DCE_DCC] & DCC_MASK) == 0) {
2420 DEBC(printk(ST_DEB_MSG "%s: Compression not supported.\n", name));
2426 b_data[mpoffs + CP_OFF_DCE_DCC] |= DCE_MASK;
2427 if (STp->c_algo != 0)
2428 b_data[mpoffs + CP_OFF_C_ALGO] = STp->c_algo;
2431 b_data[mpoffs + CP_OFF_DCE_DCC] &= ~DCE_MASK;
2432 if (STp->c_algo != 0)
2433 b_data[mpoffs + CP_OFF_C_ALGO] = 0; /* no compression */
2436 retval = write_mode_page(STp, COMPRESSION_PAGE, 0);
2438 DEBC(printk(ST_DEB_MSG "%s: Compression change failed.\n", name));
2441 DEBC(printk(ST_DEB_MSG "%s: Compression state changed to %d.\n",
2444 STp->compression_changed = 1;
2449 /* Process the load and unload commands (does unload if the load code is zero) */
2450 static int do_load_unload(struct scsi_tape *STp, struct file *filp, int load_code)
2452 int retval = (-EIO), timeout;
2453 DEB( char *name = tape_name(STp); )
2454 unsigned char cmd[MAX_COMMAND_SIZE];
2455 struct st_partstat *STps;
2456 struct st_request *SRpnt;
2458 if (STp->ready != ST_READY && !load_code) {
2459 if (STp->ready == ST_NO_TAPE)
2460 return (-ENOMEDIUM);
2465 memset(cmd, 0, MAX_COMMAND_SIZE);
2466 cmd[0] = START_STOP;
2470 * If arg >= 1 && arg <= 6 Enhanced load/unload in HP C1553A
2472 if (load_code >= 1 + MT_ST_HPLOADER_OFFSET
2473 && load_code <= 6 + MT_ST_HPLOADER_OFFSET) {
2474 DEBC(printk(ST_DEB_MSG "%s: Enhanced %sload slot %2d.\n",
2475 name, (cmd[4]) ? "" : "un",
2476 load_code - MT_ST_HPLOADER_OFFSET));
2477 cmd[3] = load_code - MT_ST_HPLOADER_OFFSET; /* MediaID field of C1553A */
2479 if (STp->immediate) {
2480 cmd[1] = 1; /* Don't wait for completion */
2481 timeout = STp->device->request_queue->rq_timeout;
2484 timeout = STp->long_timeout;
2488 printk(ST_DEB_MSG "%s: Unloading tape.\n", name);
2490 printk(ST_DEB_MSG "%s: Loading tape.\n", name);
2493 SRpnt = st_do_scsi(NULL, STp, cmd, 0, DMA_NONE,
2494 timeout, MAX_RETRIES, 1);
2496 return (STp->buffer)->syscall_result;
2498 retval = (STp->buffer)->syscall_result;
2499 st_release_request(SRpnt);
2501 if (!retval) { /* SCSI command successful */
2504 STp->rew_at_close = 0;
2505 STp->ready = ST_NO_TAPE;
2508 STp->rew_at_close = STp->autorew_dev;
2509 retval = check_tape(STp, filp);
2515 STps = &(STp->ps[STp->partition]);
2516 STps->drv_file = STps->drv_block = (-1);
2523 #define ST_DEB_FORWARD 0
2524 #define ST_DEB_BACKWARD 1
2525 static void deb_space_print(char *name, int direction, char *units, unsigned char *cmd)
2529 sc = cmd[2] & 0x80 ? 0xff000000 : 0;
2530 sc |= (cmd[2] << 16) | (cmd[3] << 8) | cmd[4];
2533 printk(ST_DEB_MSG "%s: Spacing tape %s over %d %s.\n", name,
2534 direction ? "backward" : "forward", sc, units);
2539 /* Internal ioctl function */
2540 static int st_int_ioctl(struct scsi_tape *STp, unsigned int cmd_in, unsigned long arg)
2546 unsigned char cmd[MAX_COMMAND_SIZE];
2547 struct st_request *SRpnt;
2548 struct st_partstat *STps;
2549 int fileno, blkno, at_sm, undone;
2550 int datalen = 0, direction = DMA_NONE;
2551 char *name = tape_name(STp);
2553 WARN_ON(STp->buffer->do_dio != 0);
2554 if (STp->ready != ST_READY) {
2555 if (STp->ready == ST_NO_TAPE)
2556 return (-ENOMEDIUM);
2560 timeout = STp->long_timeout;
2561 STps = &(STp->ps[STp->partition]);
2562 fileno = STps->drv_file;
2563 blkno = STps->drv_block;
2564 at_sm = STps->at_sm;
2566 memset(cmd, 0, MAX_COMMAND_SIZE);
2569 chg_eof = 0; /* Changed from the FSF after this */
2572 cmd[1] = 0x01; /* Space FileMarks */
2573 cmd[2] = (arg >> 16);
2574 cmd[3] = (arg >> 8);
2576 DEBC(deb_space_print(name, ST_DEB_FORWARD, "filemarks", cmd);)
2580 at_sm &= (arg == 0);
2583 chg_eof = 0; /* Changed from the FSF after this */
2586 cmd[1] = 0x01; /* Space FileMarks */
2588 cmd[2] = (ltmp >> 16);
2589 cmd[3] = (ltmp >> 8);
2591 DEBC(deb_space_print(name, ST_DEB_BACKWARD, "filemarks", cmd);)
2594 blkno = (-1); /* We can't know the block number */
2595 at_sm &= (arg == 0);
2599 cmd[1] = 0x00; /* Space Blocks */
2600 cmd[2] = (arg >> 16);
2601 cmd[3] = (arg >> 8);
2603 DEBC(deb_space_print(name, ST_DEB_FORWARD, "blocks", cmd);)
2606 at_sm &= (arg == 0);
2610 cmd[1] = 0x00; /* Space Blocks */
2612 cmd[2] = (ltmp >> 16);
2613 cmd[3] = (ltmp >> 8);
2615 DEBC(deb_space_print(name, ST_DEB_BACKWARD, "blocks", cmd);)
2618 at_sm &= (arg == 0);
2622 cmd[1] = 0x04; /* Space Setmarks */
2623 cmd[2] = (arg >> 16);
2624 cmd[3] = (arg >> 8);
2626 DEBC(deb_space_print(name, ST_DEB_FORWARD, "setmarks", cmd);)
2628 blkno = fileno = (-1);
2634 cmd[1] = 0x04; /* Space Setmarks */
2636 cmd[2] = (ltmp >> 16);
2637 cmd[3] = (ltmp >> 8);
2639 DEBC(deb_space_print(name, ST_DEB_BACKWARD, "setmarks", cmd);)
2641 blkno = fileno = (-1);
2647 if (STp->write_prot)
2649 cmd[0] = WRITE_FILEMARKS;
2650 if (cmd_in == MTWSM)
2652 cmd[2] = (arg >> 16);
2653 cmd[3] = (arg >> 8);
2655 timeout = STp->device->request_queue->rq_timeout;
2657 if (cmd_in == MTWEOF)
2658 printk(ST_DEB_MSG "%s: Writing %d filemarks.\n", name,
2659 cmd[2] * 65536 + cmd[3] * 256 + cmd[4]);
2661 printk(ST_DEB_MSG "%s: Writing %d setmarks.\n", name,
2662 cmd[2] * 65536 + cmd[3] * 256 + cmd[4]);
2667 at_sm = (cmd_in == MTWSM);
2670 cmd[0] = REZERO_UNIT;
2671 if (STp->immediate) {
2672 cmd[1] = 1; /* Don't wait for completion */
2673 timeout = STp->device->request_queue->rq_timeout;
2675 DEBC(printk(ST_DEB_MSG "%s: Rewinding tape.\n", name));
2676 fileno = blkno = at_sm = 0;
2679 DEBC(printk(ST_DEB_MSG "%s: No op on tape.\n", name));
2680 return 0; /* Should do something ? */
2683 cmd[0] = START_STOP;
2684 if (STp->immediate) {
2685 cmd[1] = 1; /* Don't wait for completion */
2686 timeout = STp->device->request_queue->rq_timeout;
2689 DEBC(printk(ST_DEB_MSG "%s: Retensioning tape.\n", name));
2690 fileno = blkno = at_sm = 0;
2693 if (!STp->fast_mteom) {
2694 /* space to the end of tape */
2695 ioctl_result = st_int_ioctl(STp, MTFSF, 0x7fffff);
2696 fileno = STps->drv_file;
2697 if (STps->eof >= ST_EOD_1)
2699 /* The next lines would hide the number of spaced FileMarks
2700 That's why I inserted the previous lines. I had no luck
2701 with detecting EOM with FSF, so we go now to EOM.
2707 DEBC(printk(ST_DEB_MSG "%s: Spacing to end of recorded medium.\n",
2713 if (STp->write_prot)
2716 cmd[1] = (arg ? 1 : 0); /* Long erase with non-zero argument */
2717 if (STp->immediate) {
2718 cmd[1] |= 2; /* Don't wait for completion */
2719 timeout = STp->device->request_queue->rq_timeout;
2722 timeout = STp->long_timeout * 8;
2724 DEBC(printk(ST_DEB_MSG "%s: Erasing tape.\n", name));
2725 fileno = blkno = at_sm = 0;
2727 case MTSETBLK: /* Set block length */
2728 case MTSETDENSITY: /* Set tape density */
2729 case MTSETDRVBUFFER: /* Set drive buffering */
2730 case SET_DENS_AND_BLK: /* Set density and block size */
2732 if (STp->dirty || (STp->buffer)->buffer_bytes != 0)
2733 return (-EIO); /* Not allowed if data in buffer */
2734 if ((cmd_in == MTSETBLK || cmd_in == SET_DENS_AND_BLK) &&
2735 (arg & MT_ST_BLKSIZE_MASK) != 0 &&
2736 STp->max_block > 0 &&
2737 ((arg & MT_ST_BLKSIZE_MASK) < STp->min_block ||
2738 (arg & MT_ST_BLKSIZE_MASK) > STp->max_block)) {
2739 printk(KERN_WARNING "%s: Illegal block size.\n", name);
2742 cmd[0] = MODE_SELECT;
2743 if ((STp->use_pf & USE_PF))
2744 cmd[1] = MODE_SELECT_PAGE_FORMAT;
2745 cmd[4] = datalen = 12;
2746 direction = DMA_TO_DEVICE;
2748 memset((STp->buffer)->b_data, 0, 12);
2749 if (cmd_in == MTSETDRVBUFFER)
2750 (STp->buffer)->b_data[2] = (arg & 7) << 4;
2752 (STp->buffer)->b_data[2] =
2753 STp->drv_buffer << 4;
2754 (STp->buffer)->b_data[3] = 8; /* block descriptor length */
2755 if (cmd_in == MTSETDENSITY) {
2756 (STp->buffer)->b_data[4] = arg;
2757 STp->density_changed = 1; /* At least we tried ;-) */
2758 } else if (cmd_in == SET_DENS_AND_BLK)
2759 (STp->buffer)->b_data[4] = arg >> 24;
2761 (STp->buffer)->b_data[4] = STp->density;
2762 if (cmd_in == MTSETBLK || cmd_in == SET_DENS_AND_BLK) {
2763 ltmp = arg & MT_ST_BLKSIZE_MASK;
2764 if (cmd_in == MTSETBLK)
2765 STp->blksize_changed = 1; /* At least we tried ;-) */
2767 ltmp = STp->block_size;
2768 (STp->buffer)->b_data[9] = (ltmp >> 16);
2769 (STp->buffer)->b_data[10] = (ltmp >> 8);
2770 (STp->buffer)->b_data[11] = ltmp;
2771 timeout = STp->device->request_queue->rq_timeout;
2773 if (cmd_in == MTSETBLK || cmd_in == SET_DENS_AND_BLK)
2775 "%s: Setting block size to %d bytes.\n", name,
2776 (STp->buffer)->b_data[9] * 65536 +
2777 (STp->buffer)->b_data[10] * 256 +
2778 (STp->buffer)->b_data[11]);
2779 if (cmd_in == MTSETDENSITY || cmd_in == SET_DENS_AND_BLK)
2781 "%s: Setting density code to %x.\n", name,
2782 (STp->buffer)->b_data[4]);
2783 if (cmd_in == MTSETDRVBUFFER)
2785 "%s: Setting drive buffer code to %d.\n", name,
2786 ((STp->buffer)->b_data[2] >> 4) & 7);
2793 SRpnt = st_do_scsi(NULL, STp, cmd, datalen, direction,
2794 timeout, MAX_RETRIES, 1);
2796 return (STp->buffer)->syscall_result;
2798 ioctl_result = (STp->buffer)->syscall_result;
2800 if (!ioctl_result) { /* SCSI command successful */
2801 st_release_request(SRpnt);
2803 STps->drv_block = blkno;
2804 STps->drv_file = fileno;
2805 STps->at_sm = at_sm;
2807 if (cmd_in == MTBSFM)
2808 ioctl_result = st_int_ioctl(STp, MTFSF, 1);
2809 else if (cmd_in == MTFSFM)
2810 ioctl_result = st_int_ioctl(STp, MTBSF, 1);
2812 if (cmd_in == MTSETBLK || cmd_in == SET_DENS_AND_BLK) {
2813 int old_block_size = STp->block_size;
2814 STp->block_size = arg & MT_ST_BLKSIZE_MASK;
2815 if (STp->block_size != 0) {
2816 if (old_block_size == 0)
2817 normalize_buffer(STp->buffer);
2818 (STp->buffer)->buffer_blocks =
2819 (STp->buffer)->buffer_size / STp->block_size;
2821 (STp->buffer)->buffer_bytes = (STp->buffer)->read_pointer = 0;
2822 if (cmd_in == SET_DENS_AND_BLK)
2823 STp->density = arg >> MT_ST_DENSITY_SHIFT;
2824 } else if (cmd_in == MTSETDRVBUFFER)
2825 STp->drv_buffer = (arg & 7);
2826 else if (cmd_in == MTSETDENSITY)
2829 if (cmd_in == MTEOM)
2831 else if (cmd_in == MTFSF)
2834 STps->eof = ST_NOEOF;
2836 if (cmd_in == MTWEOF)
2838 } else { /* SCSI command was not completely successful. Don't return
2839 from this block without releasing the SCSI command block! */
2840 struct st_cmdstatus *cmdstatp = &STp->buffer->cmdstat;
2842 if (cmdstatp->flags & SENSE_EOM) {
2843 if (cmd_in != MTBSF && cmd_in != MTBSFM &&
2844 cmd_in != MTBSR && cmd_in != MTBSS)
2845 STps->eof = ST_EOM_OK;
2846 STps->drv_block = 0;
2849 if (cmdstatp->remainder_valid)
2850 undone = (int)cmdstatp->uremainder64;
2854 if (cmd_in == MTWEOF &&
2855 cmdstatp->have_sense &&
2856 (cmdstatp->flags & SENSE_EOM)) {
2857 if (cmdstatp->sense_hdr.sense_key == NO_SENSE ||
2858 cmdstatp->sense_hdr.sense_key == RECOVERED_ERROR) {
2859 ioctl_result = 0; /* EOF(s) written successfully at EOM */
2860 STps->eof = ST_NOEOF;
2861 } else { /* Writing EOF(s) failed */
2865 STps->eof = ST_NOEOF;
2867 STps->drv_file = fileno;
2868 } else if ((cmd_in == MTFSF) || (cmd_in == MTFSFM)) {
2870 STps->drv_file = fileno - undone;
2872 STps->drv_file = fileno;
2873 STps->drv_block = -1;
2874 STps->eof = ST_NOEOF;
2875 } else if ((cmd_in == MTBSF) || (cmd_in == MTBSFM)) {
2876 if (arg > 0 && undone < 0) /* Some drives get this wrong */
2878 if (STps->drv_file >= 0)
2879 STps->drv_file = fileno + undone;
2880 STps->drv_block = 0;
2881 STps->eof = ST_NOEOF;
2882 } else if (cmd_in == MTFSR) {
2883 if (cmdstatp->flags & SENSE_FMK) { /* Hit filemark */
2884 if (STps->drv_file >= 0)
2886 STps->drv_block = 0;
2889 if (blkno >= undone)
2890 STps->drv_block = blkno - undone;
2892 STps->drv_block = (-1);
2893 STps->eof = ST_NOEOF;
2895 } else if (cmd_in == MTBSR) {
2896 if (cmdstatp->flags & SENSE_FMK) { /* Hit filemark */
2898 STps->drv_block = (-1);
2900 if (arg > 0 && undone < 0) /* Some drives get this wrong */
2902 if (STps->drv_block >= 0)
2903 STps->drv_block = blkno + undone;
2905 STps->eof = ST_NOEOF;
2906 } else if (cmd_in == MTEOM) {
2907 STps->drv_file = (-1);
2908 STps->drv_block = (-1);
2910 } else if (cmd_in == MTSETBLK ||
2911 cmd_in == MTSETDENSITY ||
2912 cmd_in == MTSETDRVBUFFER ||
2913 cmd_in == SET_DENS_AND_BLK) {
2914 if (cmdstatp->sense_hdr.sense_key == ILLEGAL_REQUEST &&
2915 !(STp->use_pf & PF_TESTED)) {
2916 /* Try the other possible state of Page Format if not
2918 STp->use_pf = !STp->use_pf | PF_TESTED;
2919 st_release_request(SRpnt);
2921 return st_int_ioctl(STp, cmd_in, arg);
2924 STps->eof = ST_NOEOF;
2926 if (cmdstatp->sense_hdr.sense_key == BLANK_CHECK)
2929 st_release_request(SRpnt);
2933 return ioctl_result;
2937 /* Get the tape position. If bt == 2, arg points into a kernel space mt_loc
2940 static int get_location(struct scsi_tape *STp, unsigned int *block, int *partition,
2944 unsigned char scmd[MAX_COMMAND_SIZE];
2945 struct st_request *SRpnt;
2946 DEB( char *name = tape_name(STp); )
2948 if (STp->ready != ST_READY)
2951 memset(scmd, 0, MAX_COMMAND_SIZE);
2952 if ((STp->device)->scsi_level < SCSI_2) {
2953 scmd[0] = QFA_REQUEST_BLOCK;
2956 scmd[0] = READ_POSITION;
2957 if (!logical && !STp->scsi2_logical)
2960 SRpnt = st_do_scsi(NULL, STp, scmd, 20, DMA_FROM_DEVICE,
2961 STp->device->request_queue->rq_timeout,
2962 MAX_READY_RETRIES, 1);
2964 return (STp->buffer)->syscall_result;
2966 if ((STp->buffer)->syscall_result != 0 ||
2967 (STp->device->scsi_level >= SCSI_2 &&
2968 ((STp->buffer)->b_data[0] & 4) != 0)) {
2969 *block = *partition = 0;
2970 DEBC(printk(ST_DEB_MSG "%s: Can't read tape position.\n", name));
2974 if ((STp->device)->scsi_level < SCSI_2) {
2975 *block = ((STp->buffer)->b_data[0] << 16)
2976 + ((STp->buffer)->b_data[1] << 8)
2977 + (STp->buffer)->b_data[2];
2980 *block = ((STp->buffer)->b_data[4] << 24)
2981 + ((STp->buffer)->b_data[5] << 16)
2982 + ((STp->buffer)->b_data[6] << 8)
2983 + (STp->buffer)->b_data[7];
2984 *partition = (STp->buffer)->b_data[1];
2985 if (((STp->buffer)->b_data[0] & 0x80) &&
2986 (STp->buffer)->b_data[1] == 0) /* BOP of partition 0 */
2987 STp->ps[0].drv_block = STp->ps[0].drv_file = 0;
2989 DEBC(printk(ST_DEB_MSG "%s: Got tape pos. blk %d part %d.\n", name,
2990 *block, *partition));
2992 st_release_request(SRpnt);
2999 /* Set the tape block and partition. Negative partition means that only the
3000 block should be set in vendor specific way. */
3001 static int set_location(struct scsi_tape *STp, unsigned int block, int partition,
3004 struct st_partstat *STps;
3008 unsigned char scmd[MAX_COMMAND_SIZE];
3009 struct st_request *SRpnt;
3010 DEB( char *name = tape_name(STp); )
3012 if (STp->ready != ST_READY)
3014 timeout = STp->long_timeout;
3015 STps = &(STp->ps[STp->partition]);
3017 DEBC(printk(ST_DEB_MSG "%s: Setting block to %d and partition to %d.\n",
3018 name, block, partition));
3019 DEB(if (partition < 0)
3022 /* Update the location at the partition we are leaving */
3023 if ((!STp->can_partitions && partition != 0) ||
3024 partition >= ST_NBR_PARTITIONS)
3026 if (partition != STp->partition) {
3027 if (get_location(STp, &blk, &p, 1))
3028 STps->last_block_valid = 0;
3030 STps->last_block_valid = 1;
3031 STps->last_block_visited = blk;
3032 DEBC(printk(ST_DEB_MSG
3033 "%s: Visited block %d for partition %d saved.\n",
3034 name, blk, STp->partition));
3038 memset(scmd, 0, MAX_COMMAND_SIZE);
3039 if ((STp->device)->scsi_level < SCSI_2) {
3040 scmd[0] = QFA_SEEK_BLOCK;
3041 scmd[2] = (block >> 16);
3042 scmd[3] = (block >> 8);
3047 scmd[3] = (block >> 24);
3048 scmd[4] = (block >> 16);
3049 scmd[5] = (block >> 8);
3051 if (!logical && !STp->scsi2_logical)
3053 if (STp->partition != partition) {
3055 scmd[8] = partition;
3056 DEBC(printk(ST_DEB_MSG
3057 "%s: Trying to change partition from %d to %d\n",
3058 name, STp->partition, partition));
3061 if (STp->immediate) {
3062 scmd[1] |= 1; /* Don't wait for completion */
3063 timeout = STp->device->request_queue->rq_timeout;
3066 SRpnt = st_do_scsi(NULL, STp, scmd, 0, DMA_NONE,
3067 timeout, MAX_READY_RETRIES, 1);
3069 return (STp->buffer)->syscall_result;
3071 STps->drv_block = STps->drv_file = (-1);
3072 STps->eof = ST_NOEOF;
3073 if ((STp->buffer)->syscall_result != 0) {
3075 if (STp->can_partitions &&
3076 (STp->device)->scsi_level >= SCSI_2 &&
3077 (p = find_partition(STp)) >= 0)
3080 if (STp->can_partitions) {
3081 STp->partition = partition;
3082 STps = &(STp->ps[partition]);
3083 if (!STps->last_block_valid ||
3084 STps->last_block_visited != block) {
3091 STps->drv_block = STps->drv_file = 0;
3095 st_release_request(SRpnt);
3102 /* Find the current partition number for the drive status. Called from open and
3103 returns either partition number of negative error code. */
3104 static int find_partition(struct scsi_tape *STp)
3109 if ((i = get_location(STp, &block, &partition, 1)) < 0)
3111 if (partition >= ST_NBR_PARTITIONS)
3117 /* Change the partition if necessary */
3118 static int switch_partition(struct scsi_tape *STp)
3120 struct st_partstat *STps;
3122 if (STp->partition == STp->new_partition)
3124 STps = &(STp->ps[STp->new_partition]);
3125 if (!STps->last_block_valid)
3126 STps->last_block_visited = 0;
3127 return set_location(STp, STps->last_block_visited, STp->new_partition, 1);
3130 /* Functions for reading and writing the medium partition mode page. */
3132 #define PART_PAGE 0x11
3133 #define PART_PAGE_FIXED_LENGTH 8
3135 #define PP_OFF_MAX_ADD_PARTS 2
3136 #define PP_OFF_NBR_ADD_PARTS 3
3137 #define PP_OFF_FLAGS 4
3138 #define PP_OFF_PART_UNITS 6
3139 #define PP_OFF_RESERVED 7
3141 #define PP_BIT_IDP 0x20
3142 #define PP_MSK_PSUM_MB 0x10
3144 /* Get the number of partitions on the tape. As a side effect reads the
3145 mode page into the tape buffer. */
3146 static int nbr_partitions(struct scsi_tape *STp)
3149 DEB( char *name = tape_name(STp); )
3151 if (STp->ready != ST_READY)
3154 result = read_mode_page(STp, PART_PAGE, 1);
3157 DEBC(printk(ST_DEB_MSG "%s: Can't read medium partition page.\n",
3161 result = (STp->buffer)->b_data[MODE_HEADER_LENGTH +
3162 PP_OFF_NBR_ADD_PARTS] + 1;
3163 DEBC(printk(ST_DEB_MSG "%s: Number of partitions %d.\n", name, result));
3170 /* Partition the tape into two partitions if size > 0 or one partition if
3173 The block descriptors are read and written because Sony SDT-7000 does not
3174 work without this (suggestion from Michael Schaefer <Michael.Schaefer@dlr.de>).
3176 My HP C1533A drive returns only one partition size field. This is used to
3177 set the size of partition 1. There is no size field for the default partition.
3178 Michael Schaefer's Sony SDT-7000 returns two descriptors and the second is
3179 used to set the size of partition 1 (this is what the SCSI-3 standard specifies).
3180 The following algorithm is used to accommodate both drives: if the number of
3181 partition size fields is greater than the maximum number of additional partitions
3182 in the mode page, the second field is used. Otherwise the first field is used.
3184 For Seagate DDS drives the page length must be 8 when no partitions is defined
3185 and 10 when 1 partition is defined (information from Eric Lee Green). This is
3186 is acceptable also to some other old drives and enforced if the first partition
3187 size field is used for the first additional partition size.
3189 static int partition_tape(struct scsi_tape *STp, int size)
3191 char *name = tape_name(STp);
3193 int pgo, psd_cnt, psdo;
3196 result = read_mode_page(STp, PART_PAGE, 0);
3198 DEBC(printk(ST_DEB_MSG "%s: Can't read partition mode page.\n", name));
3201 /* The mode page is in the buffer. Let's modify it and write it. */
3202 bp = (STp->buffer)->b_data;
3203 pgo = MODE_HEADER_LENGTH + bp[MH_OFF_BDESCS_LENGTH];
3204 DEBC(printk(ST_DEB_MSG "%s: Partition page length is %d bytes.\n",
3205 name, bp[pgo + MP_OFF_PAGE_LENGTH] + 2));
3207 psd_cnt = (bp[pgo + MP_OFF_PAGE_LENGTH] + 2 - PART_PAGE_FIXED_LENGTH) / 2;
3208 psdo = pgo + PART_PAGE_FIXED_LENGTH;
3209 if (psd_cnt > bp[pgo + PP_OFF_MAX_ADD_PARTS]) {
3210 bp[psdo] = bp[psdo + 1] = 0xff; /* Rest of the tape */
3213 memset(bp + psdo, 0, bp[pgo + PP_OFF_NBR_ADD_PARTS] * 2);
3215 DEBC(printk("%s: psd_cnt %d, max.parts %d, nbr_parts %d\n", name,
3216 psd_cnt, bp[pgo + PP_OFF_MAX_ADD_PARTS],
3217 bp[pgo + PP_OFF_NBR_ADD_PARTS]));
3220 bp[pgo + PP_OFF_NBR_ADD_PARTS] = 0;
3221 if (psd_cnt <= bp[pgo + PP_OFF_MAX_ADD_PARTS])
3222 bp[pgo + MP_OFF_PAGE_LENGTH] = 6;
3223 DEBC(printk(ST_DEB_MSG "%s: Formatting tape with one partition.\n",
3226 bp[psdo] = (size >> 8) & 0xff;
3227 bp[psdo + 1] = size & 0xff;
3229 if (bp[pgo + MP_OFF_PAGE_LENGTH] < 8)
3230 bp[pgo + MP_OFF_PAGE_LENGTH] = 8;
3231 DEBC(printk(ST_DEB_MSG
3232 "%s: Formatting tape with two partitions (1 = %d MB).\n",
3235 bp[pgo + PP_OFF_PART_UNITS] = 0;
3236 bp[pgo + PP_OFF_RESERVED] = 0;
3237 bp[pgo + PP_OFF_FLAGS] = PP_BIT_IDP | PP_MSK_PSUM_MB;
3239 result = write_mode_page(STp, PART_PAGE, 1);
3241 printk(KERN_INFO "%s: Partitioning of tape failed.\n", name);
3250 /* The ioctl command */
3251 static long st_ioctl(struct file *file, unsigned int cmd_in, unsigned long arg)
3253 int i, cmd_nr, cmd_type, bt;
3256 struct scsi_tape *STp = file->private_data;
3257 struct st_modedef *STm;
3258 struct st_partstat *STps;
3259 char *name = tape_name(STp);
3260 void __user *p = (void __user *)arg;
3262 if (mutex_lock_interruptible(&STp->lock))
3263 return -ERESTARTSYS;
3266 if (debugging && !STp->in_use) {
3267 printk(ST_DEB_MSG "%s: Incorrect device.\n", name);
3272 STm = &(STp->modes[STp->current_mode]);
3273 STps = &(STp->ps[STp->partition]);
3276 * If we are in the middle of error recovery, don't let anyone
3277 * else try and use this device. Also, if error recovery fails, it
3278 * may try and take the device offline, in which case all further
3279 * access to the device is prohibited.
3281 retval = scsi_nonblockable_ioctl(STp->device, cmd_in, p,
3282 file->f_flags & O_NDELAY);
3283 if (!scsi_block_when_processing_errors(STp->device) || retval != -ENODEV)
3287 cmd_type = _IOC_TYPE(cmd_in);
3288 cmd_nr = _IOC_NR(cmd_in);
3290 if (cmd_type == _IOC_TYPE(MTIOCTOP) && cmd_nr == _IOC_NR(MTIOCTOP)) {
3293 if (_IOC_SIZE(cmd_in) != sizeof(mtc)) {
3298 i = copy_from_user(&mtc, p, sizeof(struct mtop));
3304 if (mtc.mt_op == MTSETDRVBUFFER && !capable(CAP_SYS_ADMIN)) {
3306 "%s: MTSETDRVBUFFER only allowed for root.\n", name);
3310 if (!STm->defined &&
3311 (mtc.mt_op != MTSETDRVBUFFER &&
3312 (mtc.mt_count & MT_ST_OPTIONS) == 0)) {
3317 if (!STp->pos_unknown) {
3319 if (STps->eof == ST_FM_HIT) {
3320 if (mtc.mt_op == MTFSF || mtc.mt_op == MTFSFM ||
3321 mtc.mt_op == MTEOM) {
3323 if (STps->drv_file >= 0)
3324 STps->drv_file += 1;
3325 } else if (mtc.mt_op == MTBSF || mtc.mt_op == MTBSFM) {
3327 if (STps->drv_file >= 0)
3328 STps->drv_file += 1;
3332 if (mtc.mt_op == MTSEEK) {
3333 /* Old position must be restored if partition will be
3335 i = !STp->can_partitions ||
3336 (STp->new_partition != STp->partition);
3338 i = mtc.mt_op == MTREW || mtc.mt_op == MTOFFL ||
3339 mtc.mt_op == MTRETEN || mtc.mt_op == MTEOM ||
3340 mtc.mt_op == MTLOCK || mtc.mt_op == MTLOAD ||
3341 mtc.mt_op == MTFSF || mtc.mt_op == MTFSFM ||
3342 mtc.mt_op == MTBSF || mtc.mt_op == MTBSFM ||
3343 mtc.mt_op == MTCOMPRESSION;
3345 i = flush_buffer(STp, i);
3350 if (STps->rw == ST_WRITING &&
3351 (mtc.mt_op == MTREW || mtc.mt_op == MTOFFL ||
3352 mtc.mt_op == MTSEEK ||
3353 mtc.mt_op == MTBSF || mtc.mt_op == MTBSFM)) {
3354 i = st_int_ioctl(STp, MTWEOF, 1);
3359 if (mtc.mt_op == MTBSF || mtc.mt_op == MTBSFM)
3366 * If there was a bus reset, block further access
3367 * to this device. If the user wants to rewind the tape,
3368 * then reset the flag and allow access again.
3370 if (mtc.mt_op != MTREW &&
3371 mtc.mt_op != MTOFFL &&
3372 mtc.mt_op != MTRETEN &&
3373 mtc.mt_op != MTERASE &&
3374 mtc.mt_op != MTSEEK &&
3375 mtc.mt_op != MTEOM) {
3380 /* remove this when the midlevel properly clears was_reset */
3381 STp->device->was_reset = 0;
3384 if (mtc.mt_op != MTNOP && mtc.mt_op != MTSETBLK &&
3385 mtc.mt_op != MTSETDENSITY && mtc.mt_op != MTWSM &&
3386 mtc.mt_op != MTSETDRVBUFFER && mtc.mt_op != MTSETPART)
3387 STps->rw = ST_IDLE; /* Prevent automatic WEOF and fsf */
3389 if (mtc.mt_op == MTOFFL && STp->door_locked != ST_UNLOCKED)
3390 do_door_lock(STp, 0); /* Ignore result! */
3392 if (mtc.mt_op == MTSETDRVBUFFER &&
3393 (mtc.mt_count & MT_ST_OPTIONS) != 0) {
3394 retval = st_set_options(STp, mtc.mt_count);
3398 if (mtc.mt_op == MTSETPART) {
3399 if (!STp->can_partitions ||
3400 mtc.mt_count < 0 || mtc.mt_count >= ST_NBR_PARTITIONS) {
3404 if (mtc.mt_count >= STp->nbr_partitions &&
3405 (STp->nbr_partitions = nbr_partitions(STp)) < 0) {
3409 if (mtc.mt_count >= STp->nbr_partitions) {
3413 STp->new_partition = mtc.mt_count;
3418 if (mtc.mt_op == MTMKPART) {
3419 if (!STp->can_partitions) {
3423 if ((i = st_int_ioctl(STp, MTREW, 0)) < 0 ||
3424 (i = partition_tape(STp, mtc.mt_count)) < 0) {
3428 for (i = 0; i < ST_NBR_PARTITIONS; i++) {
3429 STp->ps[i].rw = ST_IDLE;
3430 STp->ps[i].at_sm = 0;
3431 STp->ps[i].last_block_valid = 0;
3433 STp->partition = STp->new_partition = 0;
3434 STp->nbr_partitions = 1; /* Bad guess ?-) */
3435 STps->drv_block = STps->drv_file = 0;
3440 if (mtc.mt_op == MTSEEK) {
3441 i = set_location(STp, mtc.mt_count, STp->new_partition, 0);
3442 if (!STp->can_partitions)
3443 STp->ps[0].rw = ST_IDLE;
3448 if (mtc.mt_op == MTUNLOAD || mtc.mt_op == MTOFFL) {
3449 retval = do_load_unload(STp, file, 0);
3453 if (mtc.mt_op == MTLOAD) {
3454 retval = do_load_unload(STp, file, max(1, mtc.mt_count));
3458 if (mtc.mt_op == MTLOCK || mtc.mt_op == MTUNLOCK) {
3459 retval = do_door_lock(STp, (mtc.mt_op == MTLOCK));
3463 if (STp->can_partitions && STp->ready == ST_READY &&
3464 (i = switch_partition(STp)) < 0) {
3469 if (mtc.mt_op == MTCOMPRESSION)
3470 retval = st_compression(STp, (mtc.mt_count & 1));
3472 retval = st_int_ioctl(STp, mtc.mt_op, mtc.mt_count);
3475 if (!STm->defined) {
3480 if ((i = flush_buffer(STp, 0)) < 0) {
3484 if (STp->can_partitions &&
3485 (i = switch_partition(STp)) < 0) {
3490 if (cmd_type == _IOC_TYPE(MTIOCGET) && cmd_nr == _IOC_NR(MTIOCGET)) {
3491 struct mtget mt_status;
3493 if (_IOC_SIZE(cmd_in) != sizeof(struct mtget)) {
3498 mt_status.mt_type = STp->tape_type;
3499 mt_status.mt_dsreg =
3500 ((STp->block_size << MT_ST_BLKSIZE_SHIFT) & MT_ST_BLKSIZE_MASK) |
3501 ((STp->density << MT_ST_DENSITY_SHIFT) & MT_ST_DENSITY_MASK);
3502 mt_status.mt_blkno = STps->drv_block;
3503 mt_status.mt_fileno = STps->drv_file;
3504 if (STp->block_size != 0) {
3505 if (STps->rw == ST_WRITING)
3506 mt_status.mt_blkno +=
3507 (STp->buffer)->buffer_bytes / STp->block_size;
3508 else if (STps->rw == ST_READING)
3509 mt_status.mt_blkno -=
3510 ((STp->buffer)->buffer_bytes +
3511 STp->block_size - 1) / STp->block_size;
3514 mt_status.mt_gstat = 0;
3515 if (STp->drv_write_prot)
3516 mt_status.mt_gstat |= GMT_WR_PROT(0xffffffff);
3517 if (mt_status.mt_blkno == 0) {
3518 if (mt_status.mt_fileno == 0)
3519 mt_status.mt_gstat |= GMT_BOT(0xffffffff);
3521 mt_status.mt_gstat |= GMT_EOF(0xffffffff);
3523 mt_status.mt_erreg = (STp->recover_reg << MT_ST_SOFTERR_SHIFT);
3524 mt_status.mt_resid = STp->partition;
3525 if (STps->eof == ST_EOM_OK || STps->eof == ST_EOM_ERROR)
3526 mt_status.mt_gstat |= GMT_EOT(0xffffffff);
3527 else if (STps->eof >= ST_EOM_OK)
3528 mt_status.mt_gstat |= GMT_EOD(0xffffffff);
3529 if (STp->density == 1)
3530 mt_status.mt_gstat |= GMT_D_800(0xffffffff);
3531 else if (STp->density == 2)
3532 mt_status.mt_gstat |= GMT_D_1600(0xffffffff);
3533 else if (STp->density == 3)
3534 mt_status.mt_gstat |= GMT_D_6250(0xffffffff);
3535 if (STp->ready == ST_READY)
3536 mt_status.mt_gstat |= GMT_ONLINE(0xffffffff);
3537 if (STp->ready == ST_NO_TAPE)
3538 mt_status.mt_gstat |= GMT_DR_OPEN(0xffffffff);
3540 mt_status.mt_gstat |= GMT_SM(0xffffffff);
3541 if (STm->do_async_writes ||
3542 (STm->do_buffer_writes && STp->block_size != 0) ||
3543 STp->drv_buffer != 0)
3544 mt_status.mt_gstat |= GMT_IM_REP_EN(0xffffffff);
3545 if (STp->cleaning_req)
3546 mt_status.mt_gstat |= GMT_CLN(0xffffffff);
3548 i = copy_to_user(p, &mt_status, sizeof(struct mtget));
3554 STp->recover_reg = 0; /* Clear after read */
3557 } /* End of MTIOCGET */
3558 if (cmd_type == _IOC_TYPE(MTIOCPOS) && cmd_nr == _IOC_NR(MTIOCPOS)) {
3559 struct mtpos mt_pos;
3560 if (_IOC_SIZE(cmd_in) != sizeof(struct mtpos)) {
3564 if ((i = get_location(STp, &blk, &bt, 0)) < 0) {
3568 mt_pos.mt_blkno = blk;
3569 i = copy_to_user(p, &mt_pos, sizeof(struct mtpos));
3574 mutex_unlock(&STp->lock);
3576 case SCSI_IOCTL_GET_IDLUN:
3577 case SCSI_IOCTL_GET_BUS_NUMBER:
3580 if ((cmd_in == SG_IO ||
3581 cmd_in == SCSI_IOCTL_SEND_COMMAND ||
3582 cmd_in == CDROM_SEND_PACKET) &&
3583 !capable(CAP_SYS_RAWIO))
3586 i = scsi_cmd_ioctl(STp->disk->queue, STp->disk,
3587 file->f_mode, cmd_in, p);
3592 retval = scsi_ioctl(STp->device, cmd_in, p);
3593 if (!retval && cmd_in == SCSI_IOCTL_STOP_UNIT) { /* unload */
3594 STp->rew_at_close = 0;
3595 STp->ready = ST_NO_TAPE;
3600 mutex_unlock(&STp->lock);
3604 #ifdef CONFIG_COMPAT
3605 static long st_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
3607 struct scsi_tape *STp = file->private_data;
3608 struct scsi_device *sdev = STp->device;
3609 int ret = -ENOIOCTLCMD;
3610 if (sdev->host->hostt->compat_ioctl) {
3612 ret = sdev->host->hostt->compat_ioctl(sdev, cmd, (void __user *)arg);
3621 /* Try to allocate a new tape buffer. Calling function must not hold
3623 static struct st_buffer *
3624 new_tape_buffer(int from_initialization, int need_dma, int max_sg)
3628 struct st_buffer *tb;
3630 if (from_initialization)
3631 priority = GFP_ATOMIC;
3633 priority = GFP_KERNEL;
3635 i = sizeof(struct st_buffer) + (max_sg - 1) * sizeof(struct scatterlist) +
3636 max_sg * sizeof(struct st_buf_fragment);
3637 tb = kzalloc(i, priority);
3639 printk(KERN_NOTICE "st: Can't allocate new tape buffer.\n");
3642 tb->frp_segs = tb->orig_frp_segs = 0;
3643 tb->use_sg = max_sg;
3644 tb->frp = (struct st_buf_fragment *)(&(tb->sg[0]) + max_sg);
3647 tb->buffer_size = got;
3648 sg_init_table(tb->sg, max_sg);
3654 /* Try to allocate enough space in the tape buffer */
3655 static int enlarge_buffer(struct st_buffer * STbuffer, int new_size, int need_dma)
3657 int segs, nbr, max_segs, b_size, order, got;
3660 if (new_size <= STbuffer->buffer_size)
3663 if (STbuffer->buffer_size <= PAGE_SIZE)
3664 normalize_buffer(STbuffer); /* Avoid extra segment */
3666 max_segs = STbuffer->use_sg;
3667 nbr = max_segs - STbuffer->frp_segs;
3671 priority = GFP_KERNEL | __GFP_NOWARN;
3673 priority |= GFP_DMA;
3674 for (b_size = PAGE_SIZE, order=0; order <= 6 &&
3675 b_size < new_size - STbuffer->buffer_size;
3676 order++, b_size *= 2)
3679 for (segs = STbuffer->frp_segs, got = STbuffer->buffer_size;
3680 segs < max_segs && got < new_size;) {
3681 STbuffer->frp[segs].page = alloc_pages(priority, order);
3682 if (STbuffer->frp[segs].page == NULL) {
3683 if (new_size - got <= (max_segs - segs) * b_size / 2) {
3684 b_size /= 2; /* Large enough for the rest of the buffers */
3688 DEB(STbuffer->buffer_size = got);
3689 normalize_buffer(STbuffer);
3692 STbuffer->frp[segs].length = b_size;
3693 STbuffer->frp_segs += 1;
3695 STbuffer->buffer_size = got;
3696 if (STbuffer->cleared)
3697 memset(page_address(STbuffer->frp[segs].page), 0, b_size);
3700 STbuffer->b_data = page_address(STbuffer->frp[0].page);
3706 /* Make sure that no data from previous user is in the internal buffer */
3707 static void clear_buffer(struct st_buffer * st_bp)
3711 for (i=0; i < st_bp->frp_segs; i++)
3712 memset(page_address(st_bp->frp[i].page), 0, st_bp->frp[i].length);
3717 /* Release the extra buffer */
3718 static void normalize_buffer(struct st_buffer * STbuffer)
3722 for (i = STbuffer->orig_frp_segs; i < STbuffer->frp_segs; i++) {
3723 order = get_order(STbuffer->frp[i].length);
3724 __free_pages(STbuffer->frp[i].page, order);
3725 STbuffer->buffer_size -= STbuffer->frp[i].length;
3727 STbuffer->frp_segs = STbuffer->orig_frp_segs;
3728 STbuffer->frp_sg_current = 0;
3729 STbuffer->sg_segs = 0;
3733 /* Move data from the user buffer to the tape buffer. Returns zero (success) or
3734 negative error code. */
3735 static int append_to_buffer(const char __user *ubp, struct st_buffer * st_bp, int do_count)
3737 int i, cnt, res, offset;
3739 for (i = 0, offset = st_bp->buffer_bytes;
3740 i < st_bp->frp_segs && offset >= st_bp->frp[i].length; i++)
3741 offset -= st_bp->frp[i].length;
3742 if (i == st_bp->frp_segs) { /* Should never happen */
3743 printk(KERN_WARNING "st: append_to_buffer offset overflow.\n");
3746 for (; i < st_bp->frp_segs && do_count > 0; i++) {
3747 cnt = st_bp->frp[i].length - offset < do_count ?
3748 st_bp->frp[i].length - offset : do_count;
3749 res = copy_from_user(page_address(st_bp->frp[i].page) + offset, ubp, cnt);
3753 st_bp->buffer_bytes += cnt;
3757 if (do_count) /* Should never happen */
3764 /* Move data from the tape buffer to the user buffer. Returns zero (success) or
3765 negative error code. */
3766 static int from_buffer(struct st_buffer * st_bp, char __user *ubp, int do_count)
3768 int i, cnt, res, offset;
3770 for (i = 0, offset = st_bp->read_pointer;
3771 i < st_bp->frp_segs && offset >= st_bp->frp[i].length; i++)
3772 offset -= st_bp->frp[i].length;
3773 if (i == st_bp->frp_segs) { /* Should never happen */
3774 printk(KERN_WARNING "st: from_buffer offset overflow.\n");
3777 for (; i < st_bp->frp_segs && do_count > 0; i++) {
3778 cnt = st_bp->frp[i].length - offset < do_count ?
3779 st_bp->frp[i].length - offset : do_count;
3780 res = copy_to_user(ubp, page_address(st_bp->frp[i].page) + offset, cnt);
3784 st_bp->buffer_bytes -= cnt;
3785 st_bp->read_pointer += cnt;
3789 if (do_count) /* Should never happen */
3796 /* Move data towards start of buffer */
3797 static void move_buffer_data(struct st_buffer * st_bp, int offset)
3799 int src_seg, dst_seg, src_offset = 0, dst_offset;
3805 total=st_bp->buffer_bytes - offset;
3806 for (src_seg=0; src_seg < st_bp->frp_segs; src_seg++) {
3807 src_offset = offset;
3808 if (src_offset < st_bp->frp[src_seg].length)
3810 offset -= st_bp->frp[src_seg].length;
3813 st_bp->buffer_bytes = st_bp->read_pointer = total;
3814 for (dst_seg=dst_offset=0; total > 0; ) {
3815 count = min(st_bp->frp[dst_seg].length - dst_offset,
3816 st_bp->frp[src_seg].length - src_offset);
3817 memmove(page_address(st_bp->frp[dst_seg].page) + dst_offset,
3818 page_address(st_bp->frp[src_seg].page) + src_offset, count);
3819 src_offset += count;
3820 if (src_offset >= st_bp->frp[src_seg].length) {
3824 dst_offset += count;
3825 if (dst_offset >= st_bp->frp[dst_seg].length) {
3834 /* Fill the s/g list up to the length required for this transfer */
3835 static void buf_to_sg(struct st_buffer *STbp, unsigned int length)
3839 struct scatterlist *sg;
3840 struct st_buf_fragment *frp;
3842 if (length == STbp->frp_sg_current)
3843 return; /* work already done */
3845 sg = &(STbp->sg[0]);
3847 for (i=count=0; count < length; i++) {
3848 if (length - count > frp[i].length)
3849 sg_set_page(&sg[i], frp[i].page, frp[i].length, 0);
3851 sg_set_page(&sg[i], frp[i].page, length - count, 0);
3852 count += sg[i].length;
3855 STbp->frp_sg_current = length;
3859 /* Validate the options from command line or module parameters */
3860 static void validate_options(void)
3863 st_fixed_buffer_size = buffer_kbs * ST_KILOBYTE;
3864 if (max_sg_segs >= ST_FIRST_SG)
3865 st_max_sg_segs = max_sg_segs;
3869 /* Set the boot options. Syntax is defined in Documenation/scsi/st.txt.
3871 static int __init st_setup(char *str)
3873 int i, len, ints[5];
3876 stp = get_options(str, ARRAY_SIZE(ints), ints);
3879 for (i = 0; i < ints[0] && i < ARRAY_SIZE(parms); i++)
3881 *parms[i].val = ints[i + 1];
3883 while (stp != NULL) {
3884 for (i = 0; i < ARRAY_SIZE(parms); i++) {
3885 len = strlen(parms[i].name);
3886 if (!strncmp(stp, parms[i].name, len) &&
3887 (*(stp + len) == ':' || *(stp + len) == '=')) {
3890 simple_strtoul(stp + len + 1, NULL, 0);
3892 printk(KERN_WARNING "st: Obsolete parameter %s\n",
3897 if (i >= ARRAY_SIZE(parms))
3898 printk(KERN_WARNING "st: invalid parameter in '%s'\n",
3900 stp = strchr(stp, ',');
3911 __setup("st=", st_setup);
3915 static const struct file_operations st_fops =
3917 .owner = THIS_MODULE,
3920 .unlocked_ioctl = st_ioctl,
3921 #ifdef CONFIG_COMPAT
3922 .compat_ioctl = st_compat_ioctl,
3926 .release = st_release,
3929 static int st_probe(struct device *dev)
3931 struct scsi_device *SDp = to_scsi_device(dev);
3932 struct gendisk *disk = NULL;
3933 struct cdev *cdev = NULL;
3934 struct scsi_tape *tpnt = NULL;
3935 struct st_modedef *STm;
3936 struct st_partstat *STps;
3937 struct st_buffer *buffer;
3938 int i, j, mode, dev_num, error;
3941 if (SDp->type != TYPE_TAPE)
3943 if ((stp = st_incompatible(SDp))) {
3944 sdev_printk(KERN_INFO, SDp, "Found incompatible tape\n");
3945 printk(KERN_INFO "st: The suggested driver is %s.\n", stp);
3949 i = min(SDp->request_queue->max_hw_segments,
3950 SDp->request_queue->max_phys_segments);
3951 if (st_max_sg_segs < i)
3953 buffer = new_tape_buffer(1, (SDp->host)->unchecked_isa_dma, i);
3954 if (buffer == NULL) {
3956 "st: Can't allocate new tape buffer. Device not attached.\n");
3960 disk = alloc_disk(1);
3962 printk(KERN_ERR "st: out of memory. Device not attached.\n");
3963 goto out_buffer_free;
3966 write_lock(&st_dev_arr_lock);
3967 if (st_nr_dev >= st_dev_max) {
3968 struct scsi_tape **tmp_da;
3971 tmp_dev_max = max(st_nr_dev * 2, 8);
3972 if (tmp_dev_max > ST_MAX_TAPES)
3973 tmp_dev_max = ST_MAX_TAPES;
3974 if (tmp_dev_max <= st_nr_dev) {
3975 write_unlock(&st_dev_arr_lock);
3976 printk(KERN_ERR "st: Too many tape devices (max. %d).\n",
3981 tmp_da = kzalloc(tmp_dev_max * sizeof(struct scsi_tape *), GFP_ATOMIC);
3982 if (tmp_da == NULL) {
3983 write_unlock(&st_dev_arr_lock);
3984 printk(KERN_ERR "st: Can't extend device array.\n");
3988 if (scsi_tapes != NULL) {
3989 memcpy(tmp_da, scsi_tapes,
3990 st_dev_max * sizeof(struct scsi_tape *));
3993 scsi_tapes = tmp_da;
3995 st_dev_max = tmp_dev_max;
3998 for (i = 0; i < st_dev_max; i++)
3999 if (scsi_tapes[i] == NULL)
4001 if (i >= st_dev_max)
4002 panic("scsi_devices corrupt (st)");
4004 tpnt = kzalloc(sizeof(struct scsi_tape), GFP_ATOMIC);
4006 write_unlock(&st_dev_arr_lock);
4007 printk(KERN_ERR "st: Can't allocate device descriptor.\n");
4010 kref_init(&tpnt->kref);
4012 sprintf(disk->disk_name, "st%d", i);
4013 disk->private_data = &tpnt->driver;
4014 disk->queue = SDp->request_queue;
4015 tpnt->driver = &st_template;
4016 scsi_tapes[i] = tpnt;
4020 if (SDp->scsi_level <= 2)
4021 tpnt->tape_type = MT_ISSCSI1;
4023 tpnt->tape_type = MT_ISSCSI2;
4025 tpnt->buffer = buffer;
4026 tpnt->buffer->last_SRpnt = NULL;
4031 tpnt->drv_buffer = 1; /* Try buffering if no mode sense */
4032 tpnt->restr_dma = (SDp->host)->unchecked_isa_dma;
4033 tpnt->use_pf = (SDp->scsi_level >= SCSI_2);
4035 tpnt->do_auto_lock = ST_AUTO_LOCK;
4036 tpnt->can_bsr = (SDp->scsi_level > 2 ? 1 : ST_IN_FILE_POS); /* BSR mandatory in SCSI3 */
4037 tpnt->can_partitions = 0;
4038 tpnt->two_fm = ST_TWO_FM;
4039 tpnt->fast_mteom = ST_FAST_MTEOM;
4040 tpnt->scsi2_logical = ST_SCSI2LOGICAL;
4041 tpnt->sili = ST_SILI;
4042 tpnt->immediate = ST_NOWAIT;
4043 tpnt->default_drvbuffer = 0xff; /* No forced buffering */
4044 tpnt->partition = 0;
4045 tpnt->new_partition = 0;
4046 tpnt->nbr_partitions = 0;
4047 blk_queue_rq_timeout(tpnt->device->request_queue, ST_TIMEOUT);
4048 tpnt->long_timeout = ST_LONG_TIMEOUT;
4049 tpnt->try_dio = try_direct_io && !SDp->host->unchecked_isa_dma;
4051 for (i = 0; i < ST_NBR_MODES; i++) {
4052 STm = &(tpnt->modes[i]);
4054 STm->sysv = ST_SYSV;
4055 STm->defaults_for_writes = 0;
4056 STm->do_async_writes = ST_ASYNC_WRITES;
4057 STm->do_buffer_writes = ST_BUFFER_WRITES;
4058 STm->do_read_ahead = ST_READ_AHEAD;
4059 STm->default_compression = ST_DONT_TOUCH;
4060 STm->default_blksize = (-1); /* No forced size */
4061 STm->default_density = (-1); /* No forced density */
4064 for (i = 0; i < ST_NBR_PARTITIONS; i++) {
4065 STps = &(tpnt->ps[i]);
4067 STps->eof = ST_NOEOF;
4069 STps->last_block_valid = 0;
4070 STps->drv_block = (-1);
4071 STps->drv_file = (-1);
4074 tpnt->current_mode = 0;
4075 tpnt->modes[0].defined = 1;
4077 tpnt->density_changed = tpnt->compression_changed =
4078 tpnt->blksize_changed = 0;
4079 mutex_init(&tpnt->lock);
4082 write_unlock(&st_dev_arr_lock);
4084 for (mode = 0; mode < ST_NBR_MODES; ++mode) {
4085 STm = &(tpnt->modes[mode]);
4086 for (j=0; j < 2; j++) {
4087 cdev = cdev_alloc();
4090 "st%d: out of memory. Device not attached.\n",
4094 cdev->owner = THIS_MODULE;
4095 cdev->ops = &st_fops;
4097 error = cdev_add(cdev,
4098 MKDEV(SCSI_TAPE_MAJOR, TAPE_MINOR(dev_num, mode, j)),
4101 printk(KERN_ERR "st%d: Can't add %s-rewind mode %d\n",
4102 dev_num, j ? "non" : "auto", mode);
4103 printk(KERN_ERR "st%d: Device not attached.\n", dev_num);
4106 STm->cdevs[j] = cdev;
4109 error = do_create_class_files(tpnt, dev_num, mode);
4114 sdev_printk(KERN_NOTICE, SDp,
4115 "Attached scsi tape %s\n", tape_name(tpnt));
4116 sdev_printk(KERN_INFO, SDp, "%s: try direct i/o: %s (alignment %d B)\n",
4117 tape_name(tpnt), tpnt->try_dio ? "yes" : "no",
4118 queue_dma_alignment(SDp->request_queue) + 1);
4123 for (mode=0; mode < ST_NBR_MODES; mode++) {
4124 STm = &(tpnt->modes[mode]);
4125 sysfs_remove_link(&tpnt->device->sdev_gendev.kobj,
4127 for (j=0; j < 2; j++) {
4128 if (STm->cdevs[j]) {
4129 if (cdev == STm->cdevs[j])
4131 device_destroy(st_sysfs_class,
4132 MKDEV(SCSI_TAPE_MAJOR,
4133 TAPE_MINOR(i, mode, j)));
4134 cdev_del(STm->cdevs[j]);
4140 write_lock(&st_dev_arr_lock);
4141 scsi_tapes[dev_num] = NULL;
4143 write_unlock(&st_dev_arr_lock);
4154 static int st_remove(struct device *dev)
4156 struct scsi_device *SDp = to_scsi_device(dev);
4157 struct scsi_tape *tpnt;
4160 write_lock(&st_dev_arr_lock);
4161 for (i = 0; i < st_dev_max; i++) {
4162 tpnt = scsi_tapes[i];
4163 if (tpnt != NULL && tpnt->device == SDp) {
4164 scsi_tapes[i] = NULL;
4166 write_unlock(&st_dev_arr_lock);
4167 sysfs_remove_link(&tpnt->device->sdev_gendev.kobj,
4169 for (mode = 0; mode < ST_NBR_MODES; ++mode) {
4170 for (j=0; j < 2; j++) {
4171 device_destroy(st_sysfs_class,
4172 MKDEV(SCSI_TAPE_MAJOR,
4173 TAPE_MINOR(i, mode, j)));
4174 cdev_del(tpnt->modes[mode].cdevs[j]);
4175 tpnt->modes[mode].cdevs[j] = NULL;
4179 mutex_lock(&st_ref_mutex);
4180 kref_put(&tpnt->kref, scsi_tape_release);
4181 mutex_unlock(&st_ref_mutex);
4186 write_unlock(&st_dev_arr_lock);
4191 * scsi_tape_release - Called to free the Scsi_Tape structure
4192 * @kref: pointer to embedded kref
4194 * st_ref_mutex must be held entering this routine. Because it is
4195 * called on last put, you should always use the scsi_tape_get()
4196 * scsi_tape_put() helpers which manipulate the semaphore directly
4197 * and never do a direct kref_put().
4199 static void scsi_tape_release(struct kref *kref)
4201 struct scsi_tape *tpnt = to_scsi_tape(kref);
4202 struct gendisk *disk = tpnt->disk;
4204 tpnt->device = NULL;
4207 tpnt->buffer->orig_frp_segs = 0;
4208 normalize_buffer(tpnt->buffer);
4209 kfree(tpnt->buffer);
4212 disk->private_data = NULL;
4218 static int __init init_st(void)
4224 printk(KERN_INFO "st: Version %s, fixed bufsize %d, s/g segs %d\n",
4225 verstr, st_fixed_buffer_size, st_max_sg_segs);
4227 st_sysfs_class = class_create(THIS_MODULE, "scsi_tape");
4228 if (IS_ERR(st_sysfs_class)) {
4229 printk(KERN_ERR "Unable create sysfs class for SCSI tapes\n");
4230 return PTR_ERR(st_sysfs_class);
4233 err = register_chrdev_region(MKDEV(SCSI_TAPE_MAJOR, 0),
4234 ST_MAX_TAPE_ENTRIES, "st");
4236 printk(KERN_ERR "Unable to get major %d for SCSI tapes\n",
4241 err = scsi_register_driver(&st_template.gendrv);
4245 err = do_create_sysfs_files();
4252 scsi_unregister_driver(&st_template.gendrv);
4254 unregister_chrdev_region(MKDEV(SCSI_TAPE_MAJOR, 0),
4255 ST_MAX_TAPE_ENTRIES);
4257 class_destroy(st_sysfs_class);
4261 static void __exit exit_st(void)
4263 do_remove_sysfs_files();
4264 scsi_unregister_driver(&st_template.gendrv);
4265 unregister_chrdev_region(MKDEV(SCSI_TAPE_MAJOR, 0),
4266 ST_MAX_TAPE_ENTRIES);
4267 class_destroy(st_sysfs_class);
4269 printk(KERN_INFO "st: Unloaded.\n");
4272 module_init(init_st);
4273 module_exit(exit_st);
4276 /* The sysfs driver interface. Read-only at the moment */
4277 static ssize_t st_try_direct_io_show(struct device_driver *ddp, char *buf)
4279 return snprintf(buf, PAGE_SIZE, "%d\n", try_direct_io);
4281 static DRIVER_ATTR(try_direct_io, S_IRUGO, st_try_direct_io_show, NULL);
4283 static ssize_t st_fixed_buffer_size_show(struct device_driver *ddp, char *buf)
4285 return snprintf(buf, PAGE_SIZE, "%d\n", st_fixed_buffer_size);
4287 static DRIVER_ATTR(fixed_buffer_size, S_IRUGO, st_fixed_buffer_size_show, NULL);
4289 static ssize_t st_max_sg_segs_show(struct device_driver *ddp, char *buf)
4291 return snprintf(buf, PAGE_SIZE, "%d\n", st_max_sg_segs);
4293 static DRIVER_ATTR(max_sg_segs, S_IRUGO, st_max_sg_segs_show, NULL);
4295 static ssize_t st_version_show(struct device_driver *ddd, char *buf)
4297 return snprintf(buf, PAGE_SIZE, "[%s]\n", verstr);
4299 static DRIVER_ATTR(version, S_IRUGO, st_version_show, NULL);
4301 static int do_create_sysfs_files(void)
4303 struct device_driver *sysfs = &st_template.gendrv;
4306 err = driver_create_file(sysfs, &driver_attr_try_direct_io);
4309 err = driver_create_file(sysfs, &driver_attr_fixed_buffer_size);
4311 goto err_try_direct_io;
4312 err = driver_create_file(sysfs, &driver_attr_max_sg_segs);
4314 goto err_attr_fixed_buf;
4315 err = driver_create_file(sysfs, &driver_attr_version);
4317 goto err_attr_max_sg;
4322 driver_remove_file(sysfs, &driver_attr_max_sg_segs);
4324 driver_remove_file(sysfs, &driver_attr_fixed_buffer_size);
4326 driver_remove_file(sysfs, &driver_attr_try_direct_io);
4330 static void do_remove_sysfs_files(void)
4332 struct device_driver *sysfs = &st_template.gendrv;
4334 driver_remove_file(sysfs, &driver_attr_version);
4335 driver_remove_file(sysfs, &driver_attr_max_sg_segs);
4336 driver_remove_file(sysfs, &driver_attr_fixed_buffer_size);
4337 driver_remove_file(sysfs, &driver_attr_try_direct_io);
4341 /* The sysfs simple class interface */
4343 st_defined_show(struct device *dev, struct device_attribute *attr, char *buf)
4345 struct st_modedef *STm = dev_get_drvdata(dev);
4348 l = snprintf(buf, PAGE_SIZE, "%d\n", STm->defined);
4352 DEVICE_ATTR(defined, S_IRUGO, st_defined_show, NULL);
4355 st_defblk_show(struct device *dev, struct device_attribute *attr, char *buf)
4357 struct st_modedef *STm = dev_get_drvdata(dev);
4360 l = snprintf(buf, PAGE_SIZE, "%d\n", STm->default_blksize);
4364 DEVICE_ATTR(default_blksize, S_IRUGO, st_defblk_show, NULL);
4367 st_defdensity_show(struct device *dev, struct device_attribute *attr, char *buf)
4369 struct st_modedef *STm = dev_get_drvdata(dev);
4373 fmt = STm->default_density >= 0 ? "0x%02x\n" : "%d\n";
4374 l = snprintf(buf, PAGE_SIZE, fmt, STm->default_density);
4378 DEVICE_ATTR(default_density, S_IRUGO, st_defdensity_show, NULL);
4381 st_defcompression_show(struct device *dev, struct device_attribute *attr,
4384 struct st_modedef *STm = dev_get_drvdata(dev);
4387 l = snprintf(buf, PAGE_SIZE, "%d\n", STm->default_compression - 1);
4391 DEVICE_ATTR(default_compression, S_IRUGO, st_defcompression_show, NULL);
4394 st_options_show(struct device *dev, struct device_attribute *attr, char *buf)
4396 struct st_modedef *STm = dev_get_drvdata(dev);
4397 struct scsi_tape *STp;
4401 for (i=0; i < st_dev_max; i++) {
4402 for (j=0; j < ST_NBR_MODES; j++)
4403 if (&scsi_tapes[i]->modes[j] == STm)
4405 if (j < ST_NBR_MODES)
4408 if (i == st_dev_max)
4409 return 0; /* should never happen */
4411 STp = scsi_tapes[i];
4413 options = STm->do_buffer_writes ? MT_ST_BUFFER_WRITES : 0;
4414 options |= STm->do_async_writes ? MT_ST_ASYNC_WRITES : 0;
4415 options |= STm->do_read_ahead ? MT_ST_READ_AHEAD : 0;
4416 DEB( options |= debugging ? MT_ST_DEBUGGING : 0 );
4417 options |= STp->two_fm ? MT_ST_TWO_FM : 0;
4418 options |= STp->fast_mteom ? MT_ST_FAST_MTEOM : 0;
4419 options |= STm->defaults_for_writes ? MT_ST_DEF_WRITES : 0;
4420 options |= STp->can_bsr ? MT_ST_CAN_BSR : 0;
4421 options |= STp->omit_blklims ? MT_ST_NO_BLKLIMS : 0;
4422 options |= STp->can_partitions ? MT_ST_CAN_PARTITIONS : 0;
4423 options |= STp->scsi2_logical ? MT_ST_SCSI2LOGICAL : 0;
4424 options |= STm->sysv ? MT_ST_SYSV : 0;
4425 options |= STp->immediate ? MT_ST_NOWAIT : 0;
4426 options |= STp->sili ? MT_ST_SILI : 0;
4428 l = snprintf(buf, PAGE_SIZE, "0x%08x\n", options);
4432 DEVICE_ATTR(options, S_IRUGO, st_options_show, NULL);
4434 static int do_create_class_files(struct scsi_tape *STp, int dev_num, int mode)
4438 struct device *st_class_member;
4440 for (rew=0; rew < 2; rew++) {
4441 /* Make sure that the minor numbers corresponding to the four
4442 first modes always get the same names */
4443 i = mode << (4 - ST_NBR_MODE_BITS);
4444 snprintf(name, 10, "%s%s%s", rew ? "n" : "",
4445 STp->disk->disk_name, st_formats[i]);
4447 device_create(st_sysfs_class, &STp->device->sdev_gendev,
4448 MKDEV(SCSI_TAPE_MAJOR,
4449 TAPE_MINOR(dev_num, mode, rew)),
4450 &STp->modes[mode], "%s", name);
4451 if (IS_ERR(st_class_member)) {
4452 printk(KERN_WARNING "st%d: device_create failed\n",
4454 error = PTR_ERR(st_class_member);
4458 error = device_create_file(st_class_member,
4460 if (error) goto out;
4461 error = device_create_file(st_class_member,
4462 &dev_attr_default_blksize);
4463 if (error) goto out;
4464 error = device_create_file(st_class_member,
4465 &dev_attr_default_density);
4466 if (error) goto out;
4467 error = device_create_file(st_class_member,
4468 &dev_attr_default_compression);
4469 if (error) goto out;
4470 error = device_create_file(st_class_member,
4472 if (error) goto out;
4474 if (mode == 0 && rew == 0) {
4475 error = sysfs_create_link(&STp->device->sdev_gendev.kobj,
4476 &st_class_member->kobj,
4480 "st%d: Can't create sysfs link from SCSI device.\n",
4493 /* The following functions may be useful for a larger audience. */
4494 static int sgl_map_user_pages(struct scatterlist *sgl, const unsigned int max_pages,
4495 unsigned long uaddr, size_t count, int rw)
4497 unsigned long end = (uaddr + count + PAGE_SIZE - 1) >> PAGE_SHIFT;
4498 unsigned long start = uaddr >> PAGE_SHIFT;
4499 const int nr_pages = end - start;
4501 struct page **pages;
4503 /* User attempted Overflow! */
4504 if ((uaddr + count) < uaddr)
4508 if (nr_pages > max_pages)
4515 if ((pages = kmalloc(max_pages * sizeof(*pages), GFP_KERNEL)) == NULL)
4518 /* Try to fault in all of the necessary pages */
4519 down_read(¤t->mm->mmap_sem);
4520 /* rw==READ means read from drive, write into memory area */
4521 res = get_user_pages(
4527 0, /* don't force */
4530 up_read(¤t->mm->mmap_sem);
4532 /* Errors and no page mapped should return here */
4536 for (i=0; i < nr_pages; i++) {
4537 /* FIXME: flush superflous for rw==READ,
4538 * probably wrong function for rw==WRITE
4540 flush_dcache_page(pages[i]);
4543 /* Populate the scatter/gather list */
4544 sg_set_page(&sgl[0], pages[0], 0, uaddr & ~PAGE_MASK);
4546 sgl[0].length = PAGE_SIZE - sgl[0].offset;
4547 count -= sgl[0].length;
4548 for (i=1; i < nr_pages ; i++) {
4549 sg_set_page(&sgl[i], pages[i],
4550 count < PAGE_SIZE ? count : PAGE_SIZE, 0);;
4555 sgl[0].length = count;
4563 for (j=0; j < res; j++)
4564 page_cache_release(pages[j]);
4572 /* And unmap them... */
4573 static int sgl_unmap_user_pages(struct scatterlist *sgl, const unsigned int nr_pages,
4578 for (i=0; i < nr_pages; i++) {
4579 struct page *page = sg_page(&sgl[i]);
4583 /* FIXME: cache flush missing for rw==READ
4584 * FIXME: call the correct reference counting function
4586 page_cache_release(page);