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 = "20080224";
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(void)
456 return kzalloc(sizeof(struct st_request), GFP_KERNEL);
459 static void st_release_request(struct st_request *streq)
464 /* Do the scsi command. Waits until command performed if do_wait is true.
465 Otherwise write_behind_check() is used to check that the command
467 static struct st_request *
468 st_do_scsi(struct st_request * SRpnt, struct scsi_tape * STp, unsigned char *cmd,
469 int bytes, int direction, int timeout, int retries, int do_wait)
471 struct completion *waiting;
473 /* if async, make sure there's no command outstanding */
474 if (!do_wait && ((STp->buffer)->last_SRpnt)) {
475 printk(KERN_ERR "%s: Async command already active.\n",
477 if (signal_pending(current))
478 (STp->buffer)->syscall_result = (-EINTR);
480 (STp->buffer)->syscall_result = (-EBUSY);
485 SRpnt = st_allocate_request();
487 DEBC( printk(KERN_ERR "%s: Can't get SCSI request.\n",
489 if (signal_pending(current))
490 (STp->buffer)->syscall_result = (-EINTR);
492 (STp->buffer)->syscall_result = (-EBUSY);
498 /* If async IO, set last_SRpnt. This ptr tells write_behind_check
499 which IO is outstanding. It's nulled out when the IO completes. */
501 (STp->buffer)->last_SRpnt = SRpnt;
503 waiting = &STp->wait;
504 init_completion(waiting);
505 SRpnt->waiting = waiting;
507 if (!STp->buffer->do_dio)
508 buf_to_sg(STp->buffer, bytes);
510 memcpy(SRpnt->cmd, cmd, sizeof(SRpnt->cmd));
511 STp->buffer->cmdstat.have_sense = 0;
512 STp->buffer->syscall_result = 0;
514 if (scsi_execute_async(STp->device, cmd, COMMAND_SIZE(cmd[0]), direction,
515 &((STp->buffer)->sg[0]), bytes, (STp->buffer)->sg_segs,
516 timeout, retries, SRpnt, st_sleep_done, GFP_KERNEL)) {
517 /* could not allocate the buffer or request was too large */
518 (STp->buffer)->syscall_result = (-EBUSY);
519 (STp->buffer)->last_SRpnt = NULL;
522 wait_for_completion(waiting);
523 SRpnt->waiting = NULL;
524 (STp->buffer)->syscall_result = st_chk_result(STp, SRpnt);
531 /* Handle the write-behind checking (waits for completion). Returns -ENOSPC if
532 write has been correct but EOM early warning reached, -EIO if write ended in
533 error or zero if write successful. Asynchronous writes are used only in
534 variable block mode. */
535 static int write_behind_check(struct scsi_tape * STp)
538 struct st_buffer *STbuffer;
539 struct st_partstat *STps;
540 struct st_cmdstatus *cmdstatp;
541 struct st_request *SRpnt;
543 STbuffer = STp->buffer;
544 if (!STbuffer->writing)
548 if (STp->write_pending)
554 wait_for_completion(&(STp->wait));
555 SRpnt = STbuffer->last_SRpnt;
556 STbuffer->last_SRpnt = NULL;
557 SRpnt->waiting = NULL;
559 (STp->buffer)->syscall_result = st_chk_result(STp, SRpnt);
560 st_release_request(SRpnt);
562 STbuffer->buffer_bytes -= STbuffer->writing;
563 STps = &(STp->ps[STp->partition]);
564 if (STps->drv_block >= 0) {
565 if (STp->block_size == 0)
568 STps->drv_block += STbuffer->writing / STp->block_size;
571 cmdstatp = &STbuffer->cmdstat;
572 if (STbuffer->syscall_result) {
574 if (cmdstatp->have_sense && !cmdstatp->deferred &&
575 (cmdstatp->flags & SENSE_EOM) &&
576 (cmdstatp->sense_hdr.sense_key == NO_SENSE ||
577 cmdstatp->sense_hdr.sense_key == RECOVERED_ERROR)) {
578 /* EOM at write-behind, has all data been written? */
579 if (!cmdstatp->remainder_valid ||
580 cmdstatp->uremainder64 == 0)
584 STps->drv_block = -1;
586 STbuffer->writing = 0;
588 DEB(if (debugging && retval)
589 printk(ST_DEB_MSG "%s: Async write error %x, return value %d.\n",
590 tape_name(STp), STbuffer->cmdstat.midlevel_result, retval);) /* end DEB */
596 /* Step over EOF if it has been inadvertently crossed (ioctl not used because
597 it messes up the block number). */
598 static int cross_eof(struct scsi_tape * STp, int forward)
600 struct st_request *SRpnt;
601 unsigned char cmd[MAX_COMMAND_SIZE];
604 cmd[1] = 0x01; /* Space FileMarks */
609 cmd[2] = cmd[3] = cmd[4] = 0xff; /* -1 filemarks */
612 DEBC(printk(ST_DEB_MSG "%s: Stepping over filemark %s.\n",
613 tape_name(STp), forward ? "forward" : "backward"));
615 SRpnt = st_do_scsi(NULL, STp, cmd, 0, DMA_NONE,
616 STp->device->timeout, MAX_RETRIES, 1);
618 return (STp->buffer)->syscall_result;
620 st_release_request(SRpnt);
623 if ((STp->buffer)->cmdstat.midlevel_result != 0)
624 printk(KERN_ERR "%s: Stepping over filemark %s failed.\n",
625 tape_name(STp), forward ? "forward" : "backward");
627 return (STp->buffer)->syscall_result;
631 /* Flush the write buffer (never need to write if variable blocksize). */
632 static int st_flush_write_buffer(struct scsi_tape * STp)
634 int offset, transfer, blks;
636 unsigned char cmd[MAX_COMMAND_SIZE];
637 struct st_request *SRpnt;
638 struct st_partstat *STps;
640 result = write_behind_check(STp);
645 if (STp->dirty == 1) {
647 offset = (STp->buffer)->buffer_bytes;
648 transfer = ((offset + STp->block_size - 1) /
649 STp->block_size) * STp->block_size;
650 DEBC(printk(ST_DEB_MSG "%s: Flushing %d bytes.\n",
651 tape_name(STp), transfer));
653 memset((STp->buffer)->b_data + offset, 0, transfer - offset);
655 memset(cmd, 0, MAX_COMMAND_SIZE);
658 blks = transfer / STp->block_size;
663 SRpnt = st_do_scsi(NULL, STp, cmd, transfer, DMA_TO_DEVICE,
664 STp->device->timeout, MAX_WRITE_RETRIES, 1);
666 return (STp->buffer)->syscall_result;
668 STps = &(STp->ps[STp->partition]);
669 if ((STp->buffer)->syscall_result != 0) {
670 struct st_cmdstatus *cmdstatp = &STp->buffer->cmdstat;
672 if (cmdstatp->have_sense && !cmdstatp->deferred &&
673 (cmdstatp->flags & SENSE_EOM) &&
674 (cmdstatp->sense_hdr.sense_key == NO_SENSE ||
675 cmdstatp->sense_hdr.sense_key == RECOVERED_ERROR) &&
676 (!cmdstatp->remainder_valid ||
677 cmdstatp->uremainder64 == 0)) { /* All written at EOM early warning */
679 (STp->buffer)->buffer_bytes = 0;
680 if (STps->drv_block >= 0)
681 STps->drv_block += blks;
684 printk(KERN_ERR "%s: Error on flush.\n",
686 STps->drv_block = (-1);
690 if (STps->drv_block >= 0)
691 STps->drv_block += blks;
693 (STp->buffer)->buffer_bytes = 0;
695 st_release_request(SRpnt);
702 /* Flush the tape buffer. The tape will be positioned correctly unless
703 seek_next is true. */
704 static int flush_buffer(struct scsi_tape *STp, int seek_next)
706 int backspace, result;
707 struct st_buffer *STbuffer;
708 struct st_partstat *STps;
710 STbuffer = STp->buffer;
713 * If there was a bus reset, block further access
716 if (STp->pos_unknown)
719 if (STp->ready != ST_READY)
721 STps = &(STp->ps[STp->partition]);
722 if (STps->rw == ST_WRITING) /* Writing */
723 return st_flush_write_buffer(STp);
725 if (STp->block_size == 0)
728 backspace = ((STp->buffer)->buffer_bytes +
729 (STp->buffer)->read_pointer) / STp->block_size -
730 ((STp->buffer)->read_pointer + STp->block_size - 1) /
732 (STp->buffer)->buffer_bytes = 0;
733 (STp->buffer)->read_pointer = 0;
736 if (STps->eof == ST_FM_HIT) {
737 result = cross_eof(STp, 0); /* Back over the EOF hit */
739 STps->eof = ST_NOEOF;
741 if (STps->drv_file >= 0)
746 if (!result && backspace > 0)
747 result = st_int_ioctl(STp, MTBSR, backspace);
748 } else if (STps->eof == ST_FM_HIT) {
749 if (STps->drv_file >= 0)
752 STps->eof = ST_NOEOF;
758 /* Set the mode parameters */
759 static int set_mode_densblk(struct scsi_tape * STp, struct st_modedef * STm)
763 char *name = tape_name(STp);
765 if (!STp->density_changed &&
766 STm->default_density >= 0 &&
767 STm->default_density != STp->density) {
768 arg = STm->default_density;
772 arg <<= MT_ST_DENSITY_SHIFT;
773 if (!STp->blksize_changed &&
774 STm->default_blksize >= 0 &&
775 STm->default_blksize != STp->block_size) {
776 arg |= STm->default_blksize;
779 arg |= STp->block_size;
781 st_int_ioctl(STp, SET_DENS_AND_BLK, arg)) {
783 "%s: Can't set default block size to %d bytes and density %x.\n",
784 name, STm->default_blksize, STm->default_density);
792 /* Lock or unlock the drive door. Don't use when st_request allocated. */
793 static int do_door_lock(struct scsi_tape * STp, int do_lock)
796 DEB(char *name = tape_name(STp);)
799 cmd = do_lock ? SCSI_IOCTL_DOORLOCK : SCSI_IOCTL_DOORUNLOCK;
800 DEBC(printk(ST_DEB_MSG "%s: %socking drive door.\n", name,
801 do_lock ? "L" : "Unl"));
802 retval = scsi_ioctl(STp->device, cmd, NULL);
804 STp->door_locked = do_lock ? ST_LOCKED_EXPLICIT : ST_UNLOCKED;
807 STp->door_locked = ST_LOCK_FAILS;
813 /* Set the internal state after reset */
814 static void reset_state(struct scsi_tape *STp)
817 struct st_partstat *STps;
819 STp->pos_unknown = 0;
820 for (i = 0; i < ST_NBR_PARTITIONS; i++) {
821 STps = &(STp->ps[i]);
823 STps->eof = ST_NOEOF;
825 STps->last_block_valid = 0;
826 STps->drv_block = -1;
829 if (STp->can_partitions) {
830 STp->partition = find_partition(STp);
831 if (STp->partition < 0)
833 STp->new_partition = STp->partition;
837 /* Test if the drive is ready. Returns either one of the codes below or a negative system
839 #define CHKRES_READY 0
840 #define CHKRES_NEW_SESSION 1
841 #define CHKRES_NOT_READY 2
842 #define CHKRES_NO_TAPE 3
844 #define MAX_ATTENTIONS 10
846 static int test_ready(struct scsi_tape *STp, int do_wait)
848 int attentions, waits, max_wait, scode;
849 int retval = CHKRES_READY, new_session = 0;
850 unsigned char cmd[MAX_COMMAND_SIZE];
851 struct st_request *SRpnt = NULL;
852 struct st_cmdstatus *cmdstatp = &STp->buffer->cmdstat;
854 max_wait = do_wait ? ST_BLOCK_SECONDS : 0;
856 for (attentions=waits=0; ; ) {
857 memset((void *) &cmd[0], 0, MAX_COMMAND_SIZE);
858 cmd[0] = TEST_UNIT_READY;
859 SRpnt = st_do_scsi(SRpnt, STp, cmd, 0, DMA_NONE,
860 STp->long_timeout, MAX_READY_RETRIES, 1);
863 retval = (STp->buffer)->syscall_result;
867 if (cmdstatp->have_sense) {
869 scode = cmdstatp->sense_hdr.sense_key;
871 if (scode == UNIT_ATTENTION) { /* New media? */
873 if (attentions < MAX_ATTENTIONS) {
883 if (scode == NOT_READY) {
884 if (waits < max_wait) {
885 if (msleep_interruptible(1000)) {
893 if ((STp->device)->scsi_level >= SCSI_2 &&
894 cmdstatp->sense_hdr.asc == 0x3a) /* Check ASC */
895 retval = CHKRES_NO_TAPE;
897 retval = CHKRES_NOT_READY;
903 retval = (STp->buffer)->syscall_result;
905 retval = new_session ? CHKRES_NEW_SESSION : CHKRES_READY;
910 st_release_request(SRpnt);
915 /* See if the drive is ready and gather information about the tape. Return values:
916 < 0 negative error code from errno.h
918 1 drive not ready (possibly no tape)
920 static int check_tape(struct scsi_tape *STp, struct file *filp)
922 int i, retval, new_session = 0, do_wait;
923 unsigned char cmd[MAX_COMMAND_SIZE], saved_cleaning;
924 unsigned short st_flags = filp->f_flags;
925 struct st_request *SRpnt = NULL;
926 struct st_modedef *STm;
927 struct st_partstat *STps;
928 char *name = tape_name(STp);
929 struct inode *inode = filp->f_path.dentry->d_inode;
930 int mode = TAPE_MODE(inode);
932 STp->ready = ST_READY;
934 if (mode != STp->current_mode) {
935 DEBC(printk(ST_DEB_MSG "%s: Mode change from %d to %d.\n",
936 name, STp->current_mode, mode));
938 STp->current_mode = mode;
940 STm = &(STp->modes[STp->current_mode]);
942 saved_cleaning = STp->cleaning_req;
943 STp->cleaning_req = 0;
945 do_wait = ((filp->f_flags & O_NONBLOCK) == 0);
946 retval = test_ready(STp, do_wait);
951 if (retval == CHKRES_NEW_SESSION) {
952 STp->pos_unknown = 0;
953 STp->partition = STp->new_partition = 0;
954 if (STp->can_partitions)
955 STp->nbr_partitions = 1; /* This guess will be updated later
957 for (i = 0; i < ST_NBR_PARTITIONS; i++) {
958 STps = &(STp->ps[i]);
960 STps->eof = ST_NOEOF;
962 STps->last_block_valid = 0;
969 STp->cleaning_req |= saved_cleaning;
971 if (retval == CHKRES_NOT_READY || retval == CHKRES_NO_TAPE) {
972 if (retval == CHKRES_NO_TAPE)
973 STp->ready = ST_NO_TAPE;
975 STp->ready = ST_NOT_READY;
977 STp->density = 0; /* Clear the erroneous "residue" */
980 STp->ps[0].drv_file = STp->ps[0].drv_block = (-1);
981 STp->partition = STp->new_partition = 0;
982 STp->door_locked = ST_UNLOCKED;
983 return CHKRES_NOT_READY;
987 if (STp->omit_blklims)
988 STp->min_block = STp->max_block = (-1);
990 memset((void *) &cmd[0], 0, MAX_COMMAND_SIZE);
991 cmd[0] = READ_BLOCK_LIMITS;
993 SRpnt = st_do_scsi(SRpnt, STp, cmd, 6, DMA_FROM_DEVICE,
994 STp->device->timeout, MAX_READY_RETRIES, 1);
996 retval = (STp->buffer)->syscall_result;
1000 if (!SRpnt->result && !STp->buffer->cmdstat.have_sense) {
1001 STp->max_block = ((STp->buffer)->b_data[1] << 16) |
1002 ((STp->buffer)->b_data[2] << 8) | (STp->buffer)->b_data[3];
1003 STp->min_block = ((STp->buffer)->b_data[4] << 8) |
1004 (STp->buffer)->b_data[5];
1005 if ( DEB( debugging || ) !STp->inited)
1007 "%s: Block limits %d - %d bytes.\n", name,
1008 STp->min_block, STp->max_block);
1010 STp->min_block = STp->max_block = (-1);
1011 DEBC(printk(ST_DEB_MSG "%s: Can't read block limits.\n",
1016 memset((void *) &cmd[0], 0, MAX_COMMAND_SIZE);
1017 cmd[0] = MODE_SENSE;
1020 SRpnt = st_do_scsi(SRpnt, STp, cmd, 12, DMA_FROM_DEVICE,
1021 STp->device->timeout, MAX_READY_RETRIES, 1);
1023 retval = (STp->buffer)->syscall_result;
1027 if ((STp->buffer)->syscall_result != 0) {
1028 DEBC(printk(ST_DEB_MSG "%s: No Mode Sense.\n", name));
1029 STp->block_size = ST_DEFAULT_BLOCK; /* Educated guess (?) */
1030 (STp->buffer)->syscall_result = 0; /* Prevent error propagation */
1031 STp->drv_write_prot = 0;
1033 DEBC(printk(ST_DEB_MSG
1034 "%s: Mode sense. Length %d, medium %x, WBS %x, BLL %d\n",
1036 (STp->buffer)->b_data[0], (STp->buffer)->b_data[1],
1037 (STp->buffer)->b_data[2], (STp->buffer)->b_data[3]));
1039 if ((STp->buffer)->b_data[3] >= 8) {
1040 STp->drv_buffer = ((STp->buffer)->b_data[2] >> 4) & 7;
1041 STp->density = (STp->buffer)->b_data[4];
1042 STp->block_size = (STp->buffer)->b_data[9] * 65536 +
1043 (STp->buffer)->b_data[10] * 256 + (STp->buffer)->b_data[11];
1044 DEBC(printk(ST_DEB_MSG
1045 "%s: Density %x, tape length: %x, drv buffer: %d\n",
1046 name, STp->density, (STp->buffer)->b_data[5] * 65536 +
1047 (STp->buffer)->b_data[6] * 256 + (STp->buffer)->b_data[7],
1050 STp->drv_write_prot = ((STp->buffer)->b_data[2] & 0x80) != 0;
1052 st_release_request(SRpnt);
1056 if (STp->block_size > 0)
1057 (STp->buffer)->buffer_blocks =
1058 (STp->buffer)->buffer_size / STp->block_size;
1060 (STp->buffer)->buffer_blocks = 1;
1061 (STp->buffer)->buffer_bytes = (STp->buffer)->read_pointer = 0;
1063 DEBC(printk(ST_DEB_MSG
1064 "%s: Block size: %d, buffer size: %d (%d blocks).\n", name,
1065 STp->block_size, (STp->buffer)->buffer_size,
1066 (STp->buffer)->buffer_blocks));
1068 if (STp->drv_write_prot) {
1069 STp->write_prot = 1;
1071 DEBC(printk(ST_DEB_MSG "%s: Write protected\n", name));
1074 ((st_flags & O_ACCMODE) == O_WRONLY ||
1075 (st_flags & O_ACCMODE) == O_RDWR)) {
1081 if (STp->can_partitions && STp->nbr_partitions < 1) {
1082 /* This code is reached when the device is opened for the first time
1083 after the driver has been initialized with tape in the drive and the
1084 partition support has been enabled. */
1085 DEBC(printk(ST_DEB_MSG
1086 "%s: Updating partition number in status.\n", name));
1087 if ((STp->partition = find_partition(STp)) < 0) {
1088 retval = STp->partition;
1091 STp->new_partition = STp->partition;
1092 STp->nbr_partitions = 1; /* This guess will be updated when necessary */
1095 if (new_session) { /* Change the drive parameters for the new mode */
1096 STp->density_changed = STp->blksize_changed = 0;
1097 STp->compression_changed = 0;
1098 if (!(STm->defaults_for_writes) &&
1099 (retval = set_mode_densblk(STp, STm)) < 0)
1102 if (STp->default_drvbuffer != 0xff) {
1103 if (st_int_ioctl(STp, MTSETDRVBUFFER, STp->default_drvbuffer))
1105 "%s: Can't set default drive buffering to %d.\n",
1106 name, STp->default_drvbuffer);
1110 return CHKRES_READY;
1117 \f/* Open the device. Needs to take the BKL only because of incrementing the SCSI host
1119 static int st_open(struct inode *inode, struct file *filp)
1121 int i, retval = (-EIO);
1122 struct scsi_tape *STp;
1123 struct st_partstat *STps;
1124 int dev = TAPE_NR(inode);
1129 * We really want to do nonseekable_open(inode, filp); here, but some
1130 * versions of tar incorrectly call lseek on tapes and bail out if that
1131 * fails. So we disallow pread() and pwrite(), but permit lseeks.
1133 filp->f_mode &= ~(FMODE_PREAD | FMODE_PWRITE);
1135 if (!(STp = scsi_tape_get(dev))) {
1140 write_lock(&st_dev_arr_lock);
1141 filp->private_data = STp;
1142 name = tape_name(STp);
1145 write_unlock(&st_dev_arr_lock);
1148 DEB( printk(ST_DEB_MSG "%s: Device already in use.\n", name); )
1153 write_unlock(&st_dev_arr_lock);
1154 STp->rew_at_close = STp->autorew_dev = (iminor(inode) & 0x80) == 0;
1156 if (!scsi_block_when_processing_errors(STp->device)) {
1161 /* See that we have at least a one page buffer available */
1162 if (!enlarge_buffer(STp->buffer, PAGE_SIZE, STp->restr_dma)) {
1163 printk(KERN_WARNING "%s: Can't allocate one page tape buffer.\n",
1165 retval = (-EOVERFLOW);
1169 (STp->buffer)->cleared = 0;
1170 (STp->buffer)->writing = 0;
1171 (STp->buffer)->syscall_result = 0;
1173 STp->write_prot = ((filp->f_flags & O_ACCMODE) == O_RDONLY);
1176 for (i = 0; i < ST_NBR_PARTITIONS; i++) {
1177 STps = &(STp->ps[i]);
1180 STp->try_dio_now = STp->try_dio;
1181 STp->recover_count = 0;
1182 DEB( STp->nbr_waits = STp->nbr_finished = 0;
1183 STp->nbr_requests = STp->nbr_dio = STp->nbr_pages = 0; )
1185 retval = check_tape(STp, filp);
1188 if ((filp->f_flags & O_NONBLOCK) == 0 &&
1189 retval != CHKRES_READY) {
1190 if (STp->ready == NO_TAPE)
1191 retval = (-ENOMEDIUM);
1200 normalize_buffer(STp->buffer);
1209 /* Flush the tape buffer before close */
1210 static int st_flush(struct file *filp, fl_owner_t id)
1212 int result = 0, result2;
1213 unsigned char cmd[MAX_COMMAND_SIZE];
1214 struct st_request *SRpnt;
1215 struct scsi_tape *STp = filp->private_data;
1216 struct st_modedef *STm = &(STp->modes[STp->current_mode]);
1217 struct st_partstat *STps = &(STp->ps[STp->partition]);
1218 char *name = tape_name(STp);
1220 if (file_count(filp) > 1)
1223 if (STps->rw == ST_WRITING && !STp->pos_unknown) {
1224 result = st_flush_write_buffer(STp);
1225 if (result != 0 && result != (-ENOSPC))
1229 if (STp->can_partitions &&
1230 (result2 = switch_partition(STp)) < 0) {
1231 DEBC(printk(ST_DEB_MSG
1232 "%s: switch_partition at close failed.\n", name));
1238 DEBC( if (STp->nbr_requests)
1239 printk(KERN_DEBUG "%s: Number of r/w requests %d, dio used in %d, pages %d.\n",
1240 name, STp->nbr_requests, STp->nbr_dio, STp->nbr_pages));
1242 if (STps->rw == ST_WRITING && !STp->pos_unknown) {
1243 struct st_cmdstatus *cmdstatp = &STp->buffer->cmdstat;
1245 DEBC(printk(ST_DEB_MSG "%s: Async write waits %d, finished %d.\n",
1246 name, STp->nbr_waits, STp->nbr_finished);
1249 memset(cmd, 0, MAX_COMMAND_SIZE);
1250 cmd[0] = WRITE_FILEMARKS;
1251 cmd[4] = 1 + STp->two_fm;
1253 SRpnt = st_do_scsi(NULL, STp, cmd, 0, DMA_NONE,
1254 STp->device->timeout, MAX_WRITE_RETRIES, 1);
1256 result = (STp->buffer)->syscall_result;
1260 if (STp->buffer->syscall_result == 0 ||
1261 (cmdstatp->have_sense && !cmdstatp->deferred &&
1262 (cmdstatp->flags & SENSE_EOM) &&
1263 (cmdstatp->sense_hdr.sense_key == NO_SENSE ||
1264 cmdstatp->sense_hdr.sense_key == RECOVERED_ERROR) &&
1265 (!cmdstatp->remainder_valid || cmdstatp->uremainder64 == 0))) {
1266 /* Write successful at EOM */
1267 st_release_request(SRpnt);
1269 if (STps->drv_file >= 0)
1271 STps->drv_block = 0;
1276 else { /* Write error */
1277 st_release_request(SRpnt);
1279 printk(KERN_ERR "%s: Error on write filemark.\n", name);
1284 DEBC(printk(ST_DEB_MSG "%s: Buffer flushed, %d EOF(s) written\n",
1286 } else if (!STp->rew_at_close) {
1287 STps = &(STp->ps[STp->partition]);
1288 if (!STm->sysv || STps->rw != ST_READING) {
1290 result = flush_buffer(STp, 0);
1291 else if (STps->eof == ST_FM_HIT) {
1292 result = cross_eof(STp, 0);
1294 if (STps->drv_file >= 0)
1296 STps->drv_block = 0;
1299 STps->eof = ST_NOEOF;
1301 } else if ((STps->eof == ST_NOEOF &&
1302 !(result = cross_eof(STp, 1))) ||
1303 STps->eof == ST_FM_HIT) {
1304 if (STps->drv_file >= 0)
1306 STps->drv_block = 0;
1312 if (STp->rew_at_close) {
1313 result2 = st_int_ioctl(STp, MTREW, 1);
1321 /* Close the device and release it. BKL is not needed: this is the only thread
1322 accessing this tape. */
1323 static int st_release(struct inode *inode, struct file *filp)
1326 struct scsi_tape *STp = filp->private_data;
1328 if (STp->door_locked == ST_LOCKED_AUTO)
1329 do_door_lock(STp, 0);
1331 normalize_buffer(STp->buffer);
1332 write_lock(&st_dev_arr_lock);
1334 write_unlock(&st_dev_arr_lock);
1340 /* The checks common to both reading and writing */
1341 static ssize_t rw_checks(struct scsi_tape *STp, struct file *filp, size_t count)
1346 * If we are in the middle of error recovery, don't let anyone
1347 * else try and use this device. Also, if error recovery fails, it
1348 * may try and take the device offline, in which case all further
1349 * access to the device is prohibited.
1351 if (!scsi_block_when_processing_errors(STp->device)) {
1356 if (STp->ready != ST_READY) {
1357 if (STp->ready == ST_NO_TAPE)
1358 retval = (-ENOMEDIUM);
1364 if (! STp->modes[STp->current_mode].defined) {
1371 * If there was a bus reset, block further access
1374 if (STp->pos_unknown) {
1384 printk(ST_DEB_MSG "%s: Incorrect device.\n", tape_name(STp));
1389 if (STp->can_partitions &&
1390 (retval = switch_partition(STp)) < 0)
1393 if (STp->block_size == 0 && STp->max_block > 0 &&
1394 (count < STp->min_block || count > STp->max_block)) {
1399 if (STp->do_auto_lock && STp->door_locked == ST_UNLOCKED &&
1400 !do_door_lock(STp, 1))
1401 STp->door_locked = ST_LOCKED_AUTO;
1408 static int setup_buffering(struct scsi_tape *STp, const char __user *buf,
1409 size_t count, int is_read)
1411 int i, bufsize, retval = 0;
1412 struct st_buffer *STbp = STp->buffer;
1415 i = STp->try_dio_now && try_rdio;
1417 i = STp->try_dio_now && try_wdio;
1419 if (i && ((unsigned long)buf & queue_dma_alignment(
1420 STp->device->request_queue)) == 0) {
1421 i = sgl_map_user_pages(&(STbp->sg[0]), STbp->use_sg,
1422 (unsigned long)buf, count, (is_read ? READ : WRITE));
1425 STbp->buffer_bytes = 0; /* can be used as transfer counter */
1428 STbp->do_dio = 0; /* fall back to buffering with any error */
1429 STbp->sg_segs = STbp->do_dio;
1430 STbp->frp_sg_current = 0;
1434 STp->nbr_pages += STbp->do_dio;
1439 DEB( STp->nbr_requests++; )
1441 if (!STbp->do_dio) {
1442 if (STp->block_size)
1443 bufsize = STp->block_size > st_fixed_buffer_size ?
1444 STp->block_size : st_fixed_buffer_size;
1447 /* Make sure that data from previous user is not leaked even if
1448 HBA does not return correct residual */
1449 if (is_read && STp->sili && !STbp->cleared)
1453 if (bufsize > STbp->buffer_size &&
1454 !enlarge_buffer(STbp, bufsize, STp->restr_dma)) {
1455 printk(KERN_WARNING "%s: Can't allocate %d byte tape buffer.\n",
1456 tape_name(STp), bufsize);
1457 retval = (-EOVERFLOW);
1460 if (STp->block_size)
1461 STbp->buffer_blocks = bufsize / STp->block_size;
1469 /* Can be called more than once after each setup_buffer() */
1470 static void release_buffering(struct scsi_tape *STp, int is_read)
1472 struct st_buffer *STbp;
1476 sgl_unmap_user_pages(&(STbp->sg[0]), STbp->do_dio, is_read);
1485 st_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
1488 ssize_t i, do_count, blks, transfer;
1490 int undone, retry_eot = 0, scode;
1492 unsigned char cmd[MAX_COMMAND_SIZE];
1493 const char __user *b_point;
1494 struct st_request *SRpnt = NULL;
1495 struct scsi_tape *STp = filp->private_data;
1496 struct st_modedef *STm;
1497 struct st_partstat *STps;
1498 struct st_buffer *STbp;
1499 char *name = tape_name(STp);
1501 if (mutex_lock_interruptible(&STp->lock))
1502 return -ERESTARTSYS;
1504 retval = rw_checks(STp, filp, count);
1505 if (retval || count == 0)
1508 /* Write must be integral number of blocks */
1509 if (STp->block_size != 0 && (count % STp->block_size) != 0) {
1510 printk(KERN_WARNING "%s: Write not multiple of tape block size.\n",
1516 STm = &(STp->modes[STp->current_mode]);
1517 STps = &(STp->ps[STp->partition]);
1519 if (STp->write_prot) {
1525 if (STps->rw == ST_READING) {
1526 retval = flush_buffer(STp, 0);
1529 STps->rw = ST_WRITING;
1530 } else if (STps->rw != ST_WRITING &&
1531 STps->drv_file == 0 && STps->drv_block == 0) {
1532 if ((retval = set_mode_densblk(STp, STm)) < 0)
1534 if (STm->default_compression != ST_DONT_TOUCH &&
1535 !(STp->compression_changed)) {
1536 if (st_compression(STp, (STm->default_compression == ST_YES))) {
1537 printk(KERN_WARNING "%s: Can't set default compression.\n",
1539 if (modes_defined) {
1548 i = write_behind_check(STp);
1551 STps->eof = ST_EOM_OK;
1553 STps->eof = ST_EOM_ERROR;
1556 if (STps->eof == ST_EOM_OK) {
1557 STps->eof = ST_EOD_1; /* allow next write */
1561 else if (STps->eof == ST_EOM_ERROR) {
1566 /* Check the buffer readability in cases where copy_user might catch
1567 the problems after some tape movement. */
1568 if (STp->block_size != 0 &&
1570 (copy_from_user(&i, buf, 1) != 0 ||
1571 copy_from_user(&i, buf + count - 1, 1) != 0)) {
1576 retval = setup_buffering(STp, buf, count, 0);
1582 memset(cmd, 0, MAX_COMMAND_SIZE);
1584 cmd[1] = (STp->block_size != 0);
1586 STps->rw = ST_WRITING;
1589 while (count > 0 && !retry_eot) {
1595 if (STp->block_size == 0)
1598 do_count = STbp->buffer_blocks * STp->block_size -
1600 if (do_count > count)
1604 i = append_to_buffer(b_point, STbp, do_count);
1611 b_point += do_count;
1613 async_write = STp->block_size == 0 && !STbp->do_dio &&
1614 STm->do_async_writes && STps->eof < ST_EOM_OK;
1616 if (STp->block_size != 0 && STm->do_buffer_writes &&
1617 !(STp->try_dio_now && try_wdio) && STps->eof < ST_EOM_OK &&
1618 STbp->buffer_bytes < STbp->buffer_size) {
1620 /* Don't write a buffer that is not full enough. */
1621 if (!async_write && count == 0)
1626 if (STp->block_size == 0)
1627 blks = transfer = do_count;
1630 blks = STbp->buffer_bytes;
1633 blks /= STp->block_size;
1634 transfer = blks * STp->block_size;
1636 cmd[2] = blks >> 16;
1640 SRpnt = st_do_scsi(SRpnt, STp, cmd, transfer, DMA_TO_DEVICE,
1641 STp->device->timeout, MAX_WRITE_RETRIES, !async_write);
1643 retval = STbp->syscall_result;
1646 if (async_write && !STbp->syscall_result) {
1647 STbp->writing = transfer;
1648 STp->dirty = !(STbp->writing ==
1649 STbp->buffer_bytes);
1650 SRpnt = NULL; /* Prevent releasing this request! */
1651 DEB( STp->write_pending = 1; )
1655 if (STbp->syscall_result != 0) {
1656 struct st_cmdstatus *cmdstatp = &STp->buffer->cmdstat;
1658 DEBC(printk(ST_DEB_MSG "%s: Error on write:\n", name));
1659 if (cmdstatp->have_sense && (cmdstatp->flags & SENSE_EOM)) {
1660 scode = cmdstatp->sense_hdr.sense_key;
1661 if (cmdstatp->remainder_valid)
1662 undone = (int)cmdstatp->uremainder64;
1663 else if (STp->block_size == 0 &&
1664 scode == VOLUME_OVERFLOW)
1668 if (STp->block_size != 0)
1669 undone *= STp->block_size;
1670 if (undone <= do_count) {
1671 /* Only data from this write is not written */
1674 if (STp->block_size)
1675 blks = (transfer - undone) / STp->block_size;
1676 STps->eof = ST_EOM_OK;
1677 /* Continue in fixed block mode if all written
1678 in this request but still something left to write
1679 (retval left to zero)
1681 if (STp->block_size == 0 ||
1682 undone > 0 || count == 0)
1683 retval = (-ENOSPC); /* EOM within current request */
1684 DEBC(printk(ST_DEB_MSG
1685 "%s: EOM with %d bytes unwritten.\n",
1688 /* EOT within data buffered earlier (possible only
1689 in fixed block mode without direct i/o) */
1690 if (!retry_eot && !cmdstatp->deferred &&
1691 (scode == NO_SENSE || scode == RECOVERED_ERROR)) {
1692 move_buffer_data(STp->buffer, transfer - undone);
1694 if (STps->drv_block >= 0) {
1695 STps->drv_block += (transfer - undone) /
1698 STps->eof = ST_EOM_OK;
1699 DEBC(printk(ST_DEB_MSG
1700 "%s: Retry write of %d bytes at EOM.\n",
1701 name, STp->buffer->buffer_bytes));
1705 /* Either error within data buffered by driver or
1708 blks = do_count = 0;
1709 STps->eof = ST_EOM_ERROR;
1710 STps->drv_block = (-1); /* Too cautious? */
1711 retval = (-EIO); /* EOM for old data */
1712 DEBC(printk(ST_DEB_MSG
1713 "%s: EOM with lost data.\n",
1719 STps->drv_block = (-1); /* Too cautious? */
1720 retval = STbp->syscall_result;
1725 if (STps->drv_block >= 0) {
1726 if (STp->block_size == 0)
1727 STps->drv_block += (do_count > 0);
1729 STps->drv_block += blks;
1732 STbp->buffer_bytes = 0;
1735 if (retval || retry_eot) {
1737 retval = total - count;
1742 if (STps->eof == ST_EOD_1)
1743 STps->eof = ST_EOM_OK;
1744 else if (STps->eof != ST_EOM_OK)
1745 STps->eof = ST_NOEOF;
1746 retval = total - count;
1750 st_release_request(SRpnt);
1751 release_buffering(STp, 0);
1752 mutex_unlock(&STp->lock);
1757 /* Read data from the tape. Returns zero in the normal case, one if the
1758 eof status has changed, and the negative error code in case of a
1759 fatal error. Otherwise updates the buffer and the eof state.
1761 Does release user buffer mapping if it is set.
1763 static long read_tape(struct scsi_tape *STp, long count,
1764 struct st_request ** aSRpnt)
1766 int transfer, blks, bytes;
1767 unsigned char cmd[MAX_COMMAND_SIZE];
1768 struct st_request *SRpnt;
1769 struct st_modedef *STm;
1770 struct st_partstat *STps;
1771 struct st_buffer *STbp;
1773 char *name = tape_name(STp);
1778 STm = &(STp->modes[STp->current_mode]);
1779 STps = &(STp->ps[STp->partition]);
1780 if (STps->eof == ST_FM_HIT)
1784 if (STp->block_size == 0)
1785 blks = bytes = count;
1787 if (!(STp->try_dio_now && try_rdio) && STm->do_read_ahead) {
1788 blks = (STp->buffer)->buffer_blocks;
1789 bytes = blks * STp->block_size;
1792 if (!STbp->do_dio && bytes > (STp->buffer)->buffer_size)
1793 bytes = (STp->buffer)->buffer_size;
1794 blks = bytes / STp->block_size;
1795 bytes = blks * STp->block_size;
1799 memset(cmd, 0, MAX_COMMAND_SIZE);
1801 cmd[1] = (STp->block_size != 0);
1802 if (!cmd[1] && STp->sili)
1804 cmd[2] = blks >> 16;
1809 SRpnt = st_do_scsi(SRpnt, STp, cmd, bytes, DMA_FROM_DEVICE,
1810 STp->device->timeout, MAX_RETRIES, 1);
1811 release_buffering(STp, 1);
1814 return STbp->syscall_result;
1816 STbp->read_pointer = 0;
1819 /* Something to check */
1820 if (STbp->syscall_result) {
1821 struct st_cmdstatus *cmdstatp = &STp->buffer->cmdstat;
1824 DEBC(printk(ST_DEB_MSG "%s: Sense: %2x %2x %2x %2x %2x %2x %2x %2x\n",
1826 SRpnt->sense[0], SRpnt->sense[1],
1827 SRpnt->sense[2], SRpnt->sense[3],
1828 SRpnt->sense[4], SRpnt->sense[5],
1829 SRpnt->sense[6], SRpnt->sense[7]));
1830 if (cmdstatp->have_sense) {
1832 if (cmdstatp->sense_hdr.sense_key == BLANK_CHECK)
1833 cmdstatp->flags &= 0xcf; /* No need for EOM in this case */
1835 if (cmdstatp->flags != 0) { /* EOF, EOM, or ILI */
1836 /* Compute the residual count */
1837 if (cmdstatp->remainder_valid)
1838 transfer = (int)cmdstatp->uremainder64;
1841 if (STp->block_size == 0 &&
1842 cmdstatp->sense_hdr.sense_key == MEDIUM_ERROR)
1845 if (cmdstatp->flags & SENSE_ILI) { /* ILI */
1846 if (STp->block_size == 0) {
1847 if (transfer <= 0) {
1850 "%s: Failed to read %d byte block with %d byte transfer.\n",
1851 name, bytes - transfer, bytes);
1852 if (STps->drv_block >= 0)
1853 STps->drv_block += 1;
1854 STbp->buffer_bytes = 0;
1857 STbp->buffer_bytes = bytes - transfer;
1859 st_release_request(SRpnt);
1860 SRpnt = *aSRpnt = NULL;
1861 if (transfer == blks) { /* We did not get anything, error */
1862 printk(KERN_NOTICE "%s: Incorrect block size.\n", name);
1863 if (STps->drv_block >= 0)
1864 STps->drv_block += blks - transfer + 1;
1865 st_int_ioctl(STp, MTBSR, 1);
1868 /* We have some data, deliver it */
1869 STbp->buffer_bytes = (blks - transfer) *
1871 DEBC(printk(ST_DEB_MSG
1872 "%s: ILI but enough data received %ld %d.\n",
1873 name, count, STbp->buffer_bytes));
1874 if (STps->drv_block >= 0)
1875 STps->drv_block += 1;
1876 if (st_int_ioctl(STp, MTBSR, 1))
1879 } else if (cmdstatp->flags & SENSE_FMK) { /* FM overrides EOM */
1880 if (STps->eof != ST_FM_HIT)
1881 STps->eof = ST_FM_HIT;
1883 STps->eof = ST_EOD_2;
1884 if (STp->block_size == 0)
1885 STbp->buffer_bytes = 0;
1887 STbp->buffer_bytes =
1888 bytes - transfer * STp->block_size;
1889 DEBC(printk(ST_DEB_MSG
1890 "%s: EOF detected (%d bytes read).\n",
1891 name, STbp->buffer_bytes));
1892 } else if (cmdstatp->flags & SENSE_EOM) {
1893 if (STps->eof == ST_FM)
1894 STps->eof = ST_EOD_1;
1896 STps->eof = ST_EOM_OK;
1897 if (STp->block_size == 0)
1898 STbp->buffer_bytes = bytes - transfer;
1900 STbp->buffer_bytes =
1901 bytes - transfer * STp->block_size;
1903 DEBC(printk(ST_DEB_MSG "%s: EOM detected (%d bytes read).\n",
1904 name, STbp->buffer_bytes));
1907 /* end of EOF, EOM, ILI test */
1908 else { /* nonzero sense key */
1909 DEBC(printk(ST_DEB_MSG
1910 "%s: Tape error while reading.\n", name));
1911 STps->drv_block = (-1);
1912 if (STps->eof == ST_FM &&
1913 cmdstatp->sense_hdr.sense_key == BLANK_CHECK) {
1914 DEBC(printk(ST_DEB_MSG
1915 "%s: Zero returned for first BLANK CHECK after EOF.\n",
1917 STps->eof = ST_EOD_2; /* First BLANK_CHECK after FM */
1918 } else /* Some other extended sense code */
1922 if (STbp->buffer_bytes < 0) /* Caused by bogus sense data */
1923 STbp->buffer_bytes = 0;
1925 /* End of extended sense test */
1926 else { /* Non-extended sense */
1927 retval = STbp->syscall_result;
1931 /* End of error handling */
1932 else { /* Read successful */
1933 STbp->buffer_bytes = bytes;
1934 if (STp->sili) /* In fixed block mode residual is always zero here */
1935 STbp->buffer_bytes -= STp->buffer->cmdstat.residual;
1938 if (STps->drv_block >= 0) {
1939 if (STp->block_size == 0)
1942 STps->drv_block += STbp->buffer_bytes / STp->block_size;
1950 st_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
1954 ssize_t i, transfer;
1955 int special, do_dio = 0;
1956 struct st_request *SRpnt = NULL;
1957 struct scsi_tape *STp = filp->private_data;
1958 struct st_modedef *STm;
1959 struct st_partstat *STps;
1960 struct st_buffer *STbp = STp->buffer;
1961 DEB( char *name = tape_name(STp); )
1963 if (mutex_lock_interruptible(&STp->lock))
1964 return -ERESTARTSYS;
1966 retval = rw_checks(STp, filp, count);
1967 if (retval || count == 0)
1970 STm = &(STp->modes[STp->current_mode]);
1971 if (STp->block_size != 0 && (count % STp->block_size) != 0) {
1972 if (!STm->do_read_ahead) {
1973 retval = (-EINVAL); /* Read must be integral number of blocks */
1976 STp->try_dio_now = 0; /* Direct i/o can't handle split blocks */
1979 STps = &(STp->ps[STp->partition]);
1980 if (STps->rw == ST_WRITING) {
1981 retval = flush_buffer(STp, 0);
1984 STps->rw = ST_READING;
1987 if (debugging && STps->eof != ST_NOEOF)
1988 printk(ST_DEB_MSG "%s: EOF/EOM flag up (%d). Bytes %d\n", name,
1989 STps->eof, STbp->buffer_bytes);
1992 retval = setup_buffering(STp, buf, count, 1);
1995 do_dio = STbp->do_dio;
1997 if (STbp->buffer_bytes == 0 &&
1998 STps->eof >= ST_EOD_1) {
1999 if (STps->eof < ST_EOD) {
2004 retval = (-EIO); /* EOM or Blank Check */
2009 /* Check the buffer writability before any tape movement. Don't alter
2011 if (copy_from_user(&i, buf, 1) != 0 ||
2012 copy_to_user(buf, &i, 1) != 0 ||
2013 copy_from_user(&i, buf + count - 1, 1) != 0 ||
2014 copy_to_user(buf + count - 1, &i, 1) != 0) {
2020 STps->rw = ST_READING;
2023 /* Loop until enough data in buffer or a special condition found */
2024 for (total = 0, special = 0; total < count && !special;) {
2026 /* Get new data if the buffer is empty */
2027 if (STbp->buffer_bytes == 0) {
2028 special = read_tape(STp, count - total, &SRpnt);
2029 if (special < 0) { /* No need to continue read */
2035 /* Move the data from driver buffer to user buffer */
2036 if (STbp->buffer_bytes > 0) {
2038 if (debugging && STps->eof != ST_NOEOF)
2040 "%s: EOF up (%d). Left %d, needed %d.\n", name,
2041 STps->eof, STbp->buffer_bytes,
2042 (int)(count - total));
2044 transfer = STbp->buffer_bytes < count - total ?
2045 STbp->buffer_bytes : count - total;
2047 i = from_buffer(STbp, buf, transfer);
2057 if (STp->block_size == 0)
2058 break; /* Read only one variable length block */
2060 } /* for (total = 0, special = 0;
2061 total < count && !special; ) */
2063 /* Change the eof state if no data from tape or buffer */
2065 if (STps->eof == ST_FM_HIT) {
2067 STps->drv_block = 0;
2068 if (STps->drv_file >= 0)
2070 } else if (STps->eof == ST_EOD_1) {
2071 STps->eof = ST_EOD_2;
2072 STps->drv_block = 0;
2073 if (STps->drv_file >= 0)
2075 } else if (STps->eof == ST_EOD_2)
2077 } else if (STps->eof == ST_FM)
2078 STps->eof = ST_NOEOF;
2082 if (SRpnt != NULL) {
2083 st_release_request(SRpnt);
2087 release_buffering(STp, 1);
2088 STbp->buffer_bytes = 0;
2090 mutex_unlock(&STp->lock);
2098 /* Set the driver options */
2099 static void st_log_options(struct scsi_tape * STp, struct st_modedef * STm, char *name)
2103 "%s: Mode %d options: buffer writes: %d, async writes: %d, read ahead: %d\n",
2104 name, STp->current_mode, STm->do_buffer_writes, STm->do_async_writes,
2105 STm->do_read_ahead);
2107 "%s: can bsr: %d, two FMs: %d, fast mteom: %d, auto lock: %d,\n",
2108 name, STp->can_bsr, STp->two_fm, STp->fast_mteom, STp->do_auto_lock);
2110 "%s: defs for wr: %d, no block limits: %d, partitions: %d, s2 log: %d\n",
2111 name, STm->defaults_for_writes, STp->omit_blklims, STp->can_partitions,
2112 STp->scsi2_logical);
2114 "%s: sysv: %d nowait: %d sili: %d\n", name, STm->sysv, STp->immediate,
2116 printk(KERN_INFO "%s: debugging: %d\n",
2123 static int st_set_options(struct scsi_tape *STp, long options)
2127 struct st_modedef *STm;
2128 char *name = tape_name(STp);
2129 struct cdev *cd0, *cd1;
2131 STm = &(STp->modes[STp->current_mode]);
2132 if (!STm->defined) {
2133 cd0 = STm->cdevs[0]; cd1 = STm->cdevs[1];
2134 memcpy(STm, &(STp->modes[0]), sizeof(struct st_modedef));
2135 STm->cdevs[0] = cd0; STm->cdevs[1] = cd1;
2137 DEBC(printk(ST_DEB_MSG
2138 "%s: Initialized mode %d definition from mode 0\n",
2139 name, STp->current_mode));
2142 code = options & MT_ST_OPTIONS;
2143 if (code == MT_ST_BOOLEANS) {
2144 STm->do_buffer_writes = (options & MT_ST_BUFFER_WRITES) != 0;
2145 STm->do_async_writes = (options & MT_ST_ASYNC_WRITES) != 0;
2146 STm->defaults_for_writes = (options & MT_ST_DEF_WRITES) != 0;
2147 STm->do_read_ahead = (options & MT_ST_READ_AHEAD) != 0;
2148 STp->two_fm = (options & MT_ST_TWO_FM) != 0;
2149 STp->fast_mteom = (options & MT_ST_FAST_MTEOM) != 0;
2150 STp->do_auto_lock = (options & MT_ST_AUTO_LOCK) != 0;
2151 STp->can_bsr = (options & MT_ST_CAN_BSR) != 0;
2152 STp->omit_blklims = (options & MT_ST_NO_BLKLIMS) != 0;
2153 if ((STp->device)->scsi_level >= SCSI_2)
2154 STp->can_partitions = (options & MT_ST_CAN_PARTITIONS) != 0;
2155 STp->scsi2_logical = (options & MT_ST_SCSI2LOGICAL) != 0;
2156 STp->immediate = (options & MT_ST_NOWAIT) != 0;
2157 STm->sysv = (options & MT_ST_SYSV) != 0;
2158 STp->sili = (options & MT_ST_SILI) != 0;
2159 DEB( debugging = (options & MT_ST_DEBUGGING) != 0;
2160 st_log_options(STp, STm, name); )
2161 } else if (code == MT_ST_SETBOOLEANS || code == MT_ST_CLEARBOOLEANS) {
2162 value = (code == MT_ST_SETBOOLEANS);
2163 if ((options & MT_ST_BUFFER_WRITES) != 0)
2164 STm->do_buffer_writes = value;
2165 if ((options & MT_ST_ASYNC_WRITES) != 0)
2166 STm->do_async_writes = value;
2167 if ((options & MT_ST_DEF_WRITES) != 0)
2168 STm->defaults_for_writes = value;
2169 if ((options & MT_ST_READ_AHEAD) != 0)
2170 STm->do_read_ahead = value;
2171 if ((options & MT_ST_TWO_FM) != 0)
2172 STp->two_fm = value;
2173 if ((options & MT_ST_FAST_MTEOM) != 0)
2174 STp->fast_mteom = value;
2175 if ((options & MT_ST_AUTO_LOCK) != 0)
2176 STp->do_auto_lock = value;
2177 if ((options & MT_ST_CAN_BSR) != 0)
2178 STp->can_bsr = value;
2179 if ((options & MT_ST_NO_BLKLIMS) != 0)
2180 STp->omit_blklims = value;
2181 if ((STp->device)->scsi_level >= SCSI_2 &&
2182 (options & MT_ST_CAN_PARTITIONS) != 0)
2183 STp->can_partitions = value;
2184 if ((options & MT_ST_SCSI2LOGICAL) != 0)
2185 STp->scsi2_logical = value;
2186 if ((options & MT_ST_NOWAIT) != 0)
2187 STp->immediate = value;
2188 if ((options & MT_ST_SYSV) != 0)
2190 if ((options & MT_ST_SILI) != 0)
2193 if ((options & MT_ST_DEBUGGING) != 0)
2195 st_log_options(STp, STm, name); )
2196 } else if (code == MT_ST_WRITE_THRESHOLD) {
2197 /* Retained for compatibility */
2198 } else if (code == MT_ST_DEF_BLKSIZE) {
2199 value = (options & ~MT_ST_OPTIONS);
2200 if (value == ~MT_ST_OPTIONS) {
2201 STm->default_blksize = (-1);
2202 DEBC( printk(KERN_INFO "%s: Default block size disabled.\n", name));
2204 STm->default_blksize = value;
2205 DEBC( printk(KERN_INFO "%s: Default block size set to %d bytes.\n",
2206 name, STm->default_blksize));
2207 if (STp->ready == ST_READY) {
2208 STp->blksize_changed = 0;
2209 set_mode_densblk(STp, STm);
2212 } else if (code == MT_ST_TIMEOUTS) {
2213 value = (options & ~MT_ST_OPTIONS);
2214 if ((value & MT_ST_SET_LONG_TIMEOUT) != 0) {
2215 STp->long_timeout = (value & ~MT_ST_SET_LONG_TIMEOUT) * HZ;
2216 DEBC( printk(KERN_INFO "%s: Long timeout set to %d seconds.\n", name,
2217 (value & ~MT_ST_SET_LONG_TIMEOUT)));
2219 STp->device->timeout = value * HZ;
2220 DEBC( printk(KERN_INFO "%s: Normal timeout set to %d seconds.\n",
2223 } else if (code == MT_ST_SET_CLN) {
2224 value = (options & ~MT_ST_OPTIONS) & 0xff;
2226 value < EXTENDED_SENSE_START && value >= SCSI_SENSE_BUFFERSIZE)
2228 STp->cln_mode = value;
2229 STp->cln_sense_mask = (options >> 8) & 0xff;
2230 STp->cln_sense_value = (options >> 16) & 0xff;
2232 "%s: Cleaning request mode %d, mask %02x, value %02x\n",
2233 name, value, STp->cln_sense_mask, STp->cln_sense_value);
2234 } else if (code == MT_ST_DEF_OPTIONS) {
2235 code = (options & ~MT_ST_CLEAR_DEFAULT);
2236 value = (options & MT_ST_CLEAR_DEFAULT);
2237 if (code == MT_ST_DEF_DENSITY) {
2238 if (value == MT_ST_CLEAR_DEFAULT) {
2239 STm->default_density = (-1);
2240 DEBC( printk(KERN_INFO "%s: Density default disabled.\n",
2243 STm->default_density = value & 0xff;
2244 DEBC( printk(KERN_INFO "%s: Density default set to %x\n",
2245 name, STm->default_density));
2246 if (STp->ready == ST_READY) {
2247 STp->density_changed = 0;
2248 set_mode_densblk(STp, STm);
2251 } else if (code == MT_ST_DEF_DRVBUFFER) {
2252 if (value == MT_ST_CLEAR_DEFAULT) {
2253 STp->default_drvbuffer = 0xff;
2254 DEBC( printk(KERN_INFO
2255 "%s: Drive buffer default disabled.\n", name));
2257 STp->default_drvbuffer = value & 7;
2258 DEBC( printk(KERN_INFO
2259 "%s: Drive buffer default set to %x\n",
2260 name, STp->default_drvbuffer));
2261 if (STp->ready == ST_READY)
2262 st_int_ioctl(STp, MTSETDRVBUFFER, STp->default_drvbuffer);
2264 } else if (code == MT_ST_DEF_COMPRESSION) {
2265 if (value == MT_ST_CLEAR_DEFAULT) {
2266 STm->default_compression = ST_DONT_TOUCH;
2267 DEBC( printk(KERN_INFO
2268 "%s: Compression default disabled.\n", name));
2270 if ((value & 0xff00) != 0) {
2271 STp->c_algo = (value & 0xff00) >> 8;
2272 DEBC( printk(KERN_INFO "%s: Compression algorithm set to 0x%x.\n",
2273 name, STp->c_algo));
2275 if ((value & 0xff) != 0xff) {
2276 STm->default_compression = (value & 1 ? ST_YES : ST_NO);
2277 DEBC( printk(KERN_INFO "%s: Compression default set to %x\n",
2278 name, (value & 1)));
2279 if (STp->ready == ST_READY) {
2280 STp->compression_changed = 0;
2281 st_compression(STp, (STm->default_compression == ST_YES));
2292 #define MODE_HEADER_LENGTH 4
2294 /* Mode header and page byte offsets */
2295 #define MH_OFF_DATA_LENGTH 0
2296 #define MH_OFF_MEDIUM_TYPE 1
2297 #define MH_OFF_DEV_SPECIFIC 2
2298 #define MH_OFF_BDESCS_LENGTH 3
2299 #define MP_OFF_PAGE_NBR 0
2300 #define MP_OFF_PAGE_LENGTH 1
2302 /* Mode header and page bit masks */
2303 #define MH_BIT_WP 0x80
2304 #define MP_MSK_PAGE_NBR 0x3f
2306 /* Don't return block descriptors */
2307 #define MODE_SENSE_OMIT_BDESCS 0x08
2309 #define MODE_SELECT_PAGE_FORMAT 0x10
2311 /* Read a mode page into the tape buffer. The block descriptors are included
2312 if incl_block_descs is true. The page control is ored to the page number
2313 parameter, if necessary. */
2314 static int read_mode_page(struct scsi_tape *STp, int page, int omit_block_descs)
2316 unsigned char cmd[MAX_COMMAND_SIZE];
2317 struct st_request *SRpnt = NULL;
2319 memset(cmd, 0, MAX_COMMAND_SIZE);
2320 cmd[0] = MODE_SENSE;
2321 if (omit_block_descs)
2322 cmd[1] = MODE_SENSE_OMIT_BDESCS;
2326 SRpnt = st_do_scsi(SRpnt, STp, cmd, cmd[4], DMA_FROM_DEVICE,
2327 STp->device->timeout, 0, 1);
2329 return (STp->buffer)->syscall_result;
2331 st_release_request(SRpnt);
2333 return (STp->buffer)->syscall_result;
2337 /* Send the mode page in the tape buffer to the drive. Assumes that the mode data
2338 in the buffer is correctly formatted. The long timeout is used if slow is non-zero. */
2339 static int write_mode_page(struct scsi_tape *STp, int page, int slow)
2342 unsigned char cmd[MAX_COMMAND_SIZE];
2343 struct st_request *SRpnt = NULL;
2345 memset(cmd, 0, MAX_COMMAND_SIZE);
2346 cmd[0] = MODE_SELECT;
2347 cmd[1] = MODE_SELECT_PAGE_FORMAT;
2348 pgo = MODE_HEADER_LENGTH + (STp->buffer)->b_data[MH_OFF_BDESCS_LENGTH];
2349 cmd[4] = pgo + (STp->buffer)->b_data[pgo + MP_OFF_PAGE_LENGTH] + 2;
2351 /* Clear reserved fields */
2352 (STp->buffer)->b_data[MH_OFF_DATA_LENGTH] = 0;
2353 (STp->buffer)->b_data[MH_OFF_MEDIUM_TYPE] = 0;
2354 (STp->buffer)->b_data[MH_OFF_DEV_SPECIFIC] &= ~MH_BIT_WP;
2355 (STp->buffer)->b_data[pgo + MP_OFF_PAGE_NBR] &= MP_MSK_PAGE_NBR;
2357 SRpnt = st_do_scsi(SRpnt, STp, cmd, cmd[4], DMA_TO_DEVICE,
2358 (slow ? STp->long_timeout : STp->device->timeout), 0, 1);
2360 return (STp->buffer)->syscall_result;
2362 st_release_request(SRpnt);
2364 return (STp->buffer)->syscall_result;
2368 #define COMPRESSION_PAGE 0x0f
2369 #define COMPRESSION_PAGE_LENGTH 16
2371 #define CP_OFF_DCE_DCC 2
2372 #define CP_OFF_C_ALGO 7
2374 #define DCE_MASK 0x80
2375 #define DCC_MASK 0x40
2376 #define RED_MASK 0x60
2379 /* Control the compression with mode page 15. Algorithm not changed if zero.
2381 The block descriptors are read and written because Sony SDT-7000 does not
2382 work without this (suggestion from Michael Schaefer <Michael.Schaefer@dlr.de>).
2383 Including block descriptors should not cause any harm to other drives. */
2385 static int st_compression(struct scsi_tape * STp, int state)
2388 int mpoffs; /* Offset to mode page start */
2389 unsigned char *b_data = (STp->buffer)->b_data;
2390 DEB( char *name = tape_name(STp); )
2392 if (STp->ready != ST_READY)
2395 /* Read the current page contents */
2396 retval = read_mode_page(STp, COMPRESSION_PAGE, 0);
2398 DEBC(printk(ST_DEB_MSG "%s: Compression mode page not supported.\n",
2403 mpoffs = MODE_HEADER_LENGTH + b_data[MH_OFF_BDESCS_LENGTH];
2404 DEBC(printk(ST_DEB_MSG "%s: Compression state is %d.\n", name,
2405 (b_data[mpoffs + CP_OFF_DCE_DCC] & DCE_MASK ? 1 : 0)));
2407 /* Check if compression can be changed */
2408 if ((b_data[mpoffs + CP_OFF_DCE_DCC] & DCC_MASK) == 0) {
2409 DEBC(printk(ST_DEB_MSG "%s: Compression not supported.\n", name));
2415 b_data[mpoffs + CP_OFF_DCE_DCC] |= DCE_MASK;
2416 if (STp->c_algo != 0)
2417 b_data[mpoffs + CP_OFF_C_ALGO] = STp->c_algo;
2420 b_data[mpoffs + CP_OFF_DCE_DCC] &= ~DCE_MASK;
2421 if (STp->c_algo != 0)
2422 b_data[mpoffs + CP_OFF_C_ALGO] = 0; /* no compression */
2425 retval = write_mode_page(STp, COMPRESSION_PAGE, 0);
2427 DEBC(printk(ST_DEB_MSG "%s: Compression change failed.\n", name));
2430 DEBC(printk(ST_DEB_MSG "%s: Compression state changed to %d.\n",
2433 STp->compression_changed = 1;
2438 /* Process the load and unload commands (does unload if the load code is zero) */
2439 static int do_load_unload(struct scsi_tape *STp, struct file *filp, int load_code)
2441 int retval = (-EIO), timeout;
2442 DEB( char *name = tape_name(STp); )
2443 unsigned char cmd[MAX_COMMAND_SIZE];
2444 struct st_partstat *STps;
2445 struct st_request *SRpnt;
2447 if (STp->ready != ST_READY && !load_code) {
2448 if (STp->ready == ST_NO_TAPE)
2449 return (-ENOMEDIUM);
2454 memset(cmd, 0, MAX_COMMAND_SIZE);
2455 cmd[0] = START_STOP;
2459 * If arg >= 1 && arg <= 6 Enhanced load/unload in HP C1553A
2461 if (load_code >= 1 + MT_ST_HPLOADER_OFFSET
2462 && load_code <= 6 + MT_ST_HPLOADER_OFFSET) {
2463 DEBC(printk(ST_DEB_MSG "%s: Enhanced %sload slot %2d.\n",
2464 name, (cmd[4]) ? "" : "un",
2465 load_code - MT_ST_HPLOADER_OFFSET));
2466 cmd[3] = load_code - MT_ST_HPLOADER_OFFSET; /* MediaID field of C1553A */
2468 if (STp->immediate) {
2469 cmd[1] = 1; /* Don't wait for completion */
2470 timeout = STp->device->timeout;
2473 timeout = STp->long_timeout;
2477 printk(ST_DEB_MSG "%s: Unloading tape.\n", name);
2479 printk(ST_DEB_MSG "%s: Loading tape.\n", name);
2482 SRpnt = st_do_scsi(NULL, STp, cmd, 0, DMA_NONE,
2483 timeout, MAX_RETRIES, 1);
2485 return (STp->buffer)->syscall_result;
2487 retval = (STp->buffer)->syscall_result;
2488 st_release_request(SRpnt);
2490 if (!retval) { /* SCSI command successful */
2493 STp->rew_at_close = 0;
2494 STp->ready = ST_NO_TAPE;
2497 STp->rew_at_close = STp->autorew_dev;
2498 retval = check_tape(STp, filp);
2504 STps = &(STp->ps[STp->partition]);
2505 STps->drv_file = STps->drv_block = (-1);
2512 #define ST_DEB_FORWARD 0
2513 #define ST_DEB_BACKWARD 1
2514 static void deb_space_print(char *name, int direction, char *units, unsigned char *cmd)
2518 sc = cmd[2] & 0x80 ? 0xff000000 : 0;
2519 sc |= (cmd[2] << 16) | (cmd[3] << 8) | cmd[4];
2522 printk(ST_DEB_MSG "%s: Spacing tape %s over %d %s.\n", name,
2523 direction ? "backward" : "forward", sc, units);
2528 /* Internal ioctl function */
2529 static int st_int_ioctl(struct scsi_tape *STp, unsigned int cmd_in, unsigned long arg)
2535 unsigned char cmd[MAX_COMMAND_SIZE];
2536 struct st_request *SRpnt;
2537 struct st_partstat *STps;
2538 int fileno, blkno, at_sm, undone;
2539 int datalen = 0, direction = DMA_NONE;
2540 char *name = tape_name(STp);
2542 WARN_ON(STp->buffer->do_dio != 0);
2543 if (STp->ready != ST_READY) {
2544 if (STp->ready == ST_NO_TAPE)
2545 return (-ENOMEDIUM);
2549 timeout = STp->long_timeout;
2550 STps = &(STp->ps[STp->partition]);
2551 fileno = STps->drv_file;
2552 blkno = STps->drv_block;
2553 at_sm = STps->at_sm;
2555 memset(cmd, 0, MAX_COMMAND_SIZE);
2558 chg_eof = 0; /* Changed from the FSF after this */
2561 cmd[1] = 0x01; /* Space FileMarks */
2562 cmd[2] = (arg >> 16);
2563 cmd[3] = (arg >> 8);
2565 DEBC(deb_space_print(name, ST_DEB_FORWARD, "filemarks", cmd);)
2569 at_sm &= (arg == 0);
2572 chg_eof = 0; /* Changed from the FSF after this */
2575 cmd[1] = 0x01; /* Space FileMarks */
2577 cmd[2] = (ltmp >> 16);
2578 cmd[3] = (ltmp >> 8);
2580 DEBC(deb_space_print(name, ST_DEB_BACKWARD, "filemarks", cmd);)
2583 blkno = (-1); /* We can't know the block number */
2584 at_sm &= (arg == 0);
2588 cmd[1] = 0x00; /* Space Blocks */
2589 cmd[2] = (arg >> 16);
2590 cmd[3] = (arg >> 8);
2592 DEBC(deb_space_print(name, ST_DEB_FORWARD, "blocks", cmd);)
2595 at_sm &= (arg == 0);
2599 cmd[1] = 0x00; /* Space Blocks */
2601 cmd[2] = (ltmp >> 16);
2602 cmd[3] = (ltmp >> 8);
2604 DEBC(deb_space_print(name, ST_DEB_BACKWARD, "blocks", cmd);)
2607 at_sm &= (arg == 0);
2611 cmd[1] = 0x04; /* Space Setmarks */
2612 cmd[2] = (arg >> 16);
2613 cmd[3] = (arg >> 8);
2615 DEBC(deb_space_print(name, ST_DEB_FORWARD, "setmarks", cmd);)
2617 blkno = fileno = (-1);
2623 cmd[1] = 0x04; /* Space Setmarks */
2625 cmd[2] = (ltmp >> 16);
2626 cmd[3] = (ltmp >> 8);
2628 DEBC(deb_space_print(name, ST_DEB_BACKWARD, "setmarks", cmd);)
2630 blkno = fileno = (-1);
2636 if (STp->write_prot)
2638 cmd[0] = WRITE_FILEMARKS;
2639 if (cmd_in == MTWSM)
2641 cmd[2] = (arg >> 16);
2642 cmd[3] = (arg >> 8);
2644 timeout = STp->device->timeout;
2646 if (cmd_in == MTWEOF)
2647 printk(ST_DEB_MSG "%s: Writing %d filemarks.\n", name,
2648 cmd[2] * 65536 + cmd[3] * 256 + cmd[4]);
2650 printk(ST_DEB_MSG "%s: Writing %d setmarks.\n", name,
2651 cmd[2] * 65536 + cmd[3] * 256 + cmd[4]);
2656 at_sm = (cmd_in == MTWSM);
2659 cmd[0] = REZERO_UNIT;
2660 if (STp->immediate) {
2661 cmd[1] = 1; /* Don't wait for completion */
2662 timeout = STp->device->timeout;
2664 DEBC(printk(ST_DEB_MSG "%s: Rewinding tape.\n", name));
2665 fileno = blkno = at_sm = 0;
2668 DEBC(printk(ST_DEB_MSG "%s: No op on tape.\n", name));
2669 return 0; /* Should do something ? */
2672 cmd[0] = START_STOP;
2673 if (STp->immediate) {
2674 cmd[1] = 1; /* Don't wait for completion */
2675 timeout = STp->device->timeout;
2678 DEBC(printk(ST_DEB_MSG "%s: Retensioning tape.\n", name));
2679 fileno = blkno = at_sm = 0;
2682 if (!STp->fast_mteom) {
2683 /* space to the end of tape */
2684 ioctl_result = st_int_ioctl(STp, MTFSF, 0x7fffff);
2685 fileno = STps->drv_file;
2686 if (STps->eof >= ST_EOD_1)
2688 /* The next lines would hide the number of spaced FileMarks
2689 That's why I inserted the previous lines. I had no luck
2690 with detecting EOM with FSF, so we go now to EOM.
2696 DEBC(printk(ST_DEB_MSG "%s: Spacing to end of recorded medium.\n",
2702 if (STp->write_prot)
2705 cmd[1] = (arg ? 1 : 0); /* Long erase with non-zero argument */
2706 if (STp->immediate) {
2707 cmd[1] |= 2; /* Don't wait for completion */
2708 timeout = STp->device->timeout;
2711 timeout = STp->long_timeout * 8;
2713 DEBC(printk(ST_DEB_MSG "%s: Erasing tape.\n", name));
2714 fileno = blkno = at_sm = 0;
2716 case MTSETBLK: /* Set block length */
2717 case MTSETDENSITY: /* Set tape density */
2718 case MTSETDRVBUFFER: /* Set drive buffering */
2719 case SET_DENS_AND_BLK: /* Set density and block size */
2721 if (STp->dirty || (STp->buffer)->buffer_bytes != 0)
2722 return (-EIO); /* Not allowed if data in buffer */
2723 if ((cmd_in == MTSETBLK || cmd_in == SET_DENS_AND_BLK) &&
2724 (arg & MT_ST_BLKSIZE_MASK) != 0 &&
2725 STp->max_block > 0 &&
2726 ((arg & MT_ST_BLKSIZE_MASK) < STp->min_block ||
2727 (arg & MT_ST_BLKSIZE_MASK) > STp->max_block)) {
2728 printk(KERN_WARNING "%s: Illegal block size.\n", name);
2731 cmd[0] = MODE_SELECT;
2732 if ((STp->use_pf & USE_PF))
2733 cmd[1] = MODE_SELECT_PAGE_FORMAT;
2734 cmd[4] = datalen = 12;
2735 direction = DMA_TO_DEVICE;
2737 memset((STp->buffer)->b_data, 0, 12);
2738 if (cmd_in == MTSETDRVBUFFER)
2739 (STp->buffer)->b_data[2] = (arg & 7) << 4;
2741 (STp->buffer)->b_data[2] =
2742 STp->drv_buffer << 4;
2743 (STp->buffer)->b_data[3] = 8; /* block descriptor length */
2744 if (cmd_in == MTSETDENSITY) {
2745 (STp->buffer)->b_data[4] = arg;
2746 STp->density_changed = 1; /* At least we tried ;-) */
2747 } else if (cmd_in == SET_DENS_AND_BLK)
2748 (STp->buffer)->b_data[4] = arg >> 24;
2750 (STp->buffer)->b_data[4] = STp->density;
2751 if (cmd_in == MTSETBLK || cmd_in == SET_DENS_AND_BLK) {
2752 ltmp = arg & MT_ST_BLKSIZE_MASK;
2753 if (cmd_in == MTSETBLK)
2754 STp->blksize_changed = 1; /* At least we tried ;-) */
2756 ltmp = STp->block_size;
2757 (STp->buffer)->b_data[9] = (ltmp >> 16);
2758 (STp->buffer)->b_data[10] = (ltmp >> 8);
2759 (STp->buffer)->b_data[11] = ltmp;
2760 timeout = STp->device->timeout;
2762 if (cmd_in == MTSETBLK || cmd_in == SET_DENS_AND_BLK)
2764 "%s: Setting block size to %d bytes.\n", name,
2765 (STp->buffer)->b_data[9] * 65536 +
2766 (STp->buffer)->b_data[10] * 256 +
2767 (STp->buffer)->b_data[11]);
2768 if (cmd_in == MTSETDENSITY || cmd_in == SET_DENS_AND_BLK)
2770 "%s: Setting density code to %x.\n", name,
2771 (STp->buffer)->b_data[4]);
2772 if (cmd_in == MTSETDRVBUFFER)
2774 "%s: Setting drive buffer code to %d.\n", name,
2775 ((STp->buffer)->b_data[2] >> 4) & 7);
2782 SRpnt = st_do_scsi(NULL, STp, cmd, datalen, direction,
2783 timeout, MAX_RETRIES, 1);
2785 return (STp->buffer)->syscall_result;
2787 ioctl_result = (STp->buffer)->syscall_result;
2789 if (!ioctl_result) { /* SCSI command successful */
2790 st_release_request(SRpnt);
2792 STps->drv_block = blkno;
2793 STps->drv_file = fileno;
2794 STps->at_sm = at_sm;
2796 if (cmd_in == MTBSFM)
2797 ioctl_result = st_int_ioctl(STp, MTFSF, 1);
2798 else if (cmd_in == MTFSFM)
2799 ioctl_result = st_int_ioctl(STp, MTBSF, 1);
2801 if (cmd_in == MTSETBLK || cmd_in == SET_DENS_AND_BLK) {
2802 int old_block_size = STp->block_size;
2803 STp->block_size = arg & MT_ST_BLKSIZE_MASK;
2804 if (STp->block_size != 0) {
2805 if (old_block_size == 0)
2806 normalize_buffer(STp->buffer);
2807 (STp->buffer)->buffer_blocks =
2808 (STp->buffer)->buffer_size / STp->block_size;
2810 (STp->buffer)->buffer_bytes = (STp->buffer)->read_pointer = 0;
2811 if (cmd_in == SET_DENS_AND_BLK)
2812 STp->density = arg >> MT_ST_DENSITY_SHIFT;
2813 } else if (cmd_in == MTSETDRVBUFFER)
2814 STp->drv_buffer = (arg & 7);
2815 else if (cmd_in == MTSETDENSITY)
2818 if (cmd_in == MTEOM)
2820 else if (cmd_in == MTFSF)
2823 STps->eof = ST_NOEOF;
2825 if (cmd_in == MTWEOF)
2827 } else { /* SCSI command was not completely successful. Don't return
2828 from this block without releasing the SCSI command block! */
2829 struct st_cmdstatus *cmdstatp = &STp->buffer->cmdstat;
2831 if (cmdstatp->flags & SENSE_EOM) {
2832 if (cmd_in != MTBSF && cmd_in != MTBSFM &&
2833 cmd_in != MTBSR && cmd_in != MTBSS)
2834 STps->eof = ST_EOM_OK;
2835 STps->drv_block = 0;
2838 if (cmdstatp->remainder_valid)
2839 undone = (int)cmdstatp->uremainder64;
2843 if (cmd_in == MTWEOF &&
2844 cmdstatp->have_sense &&
2845 (cmdstatp->flags & SENSE_EOM)) {
2846 if (cmdstatp->sense_hdr.sense_key == NO_SENSE ||
2847 cmdstatp->sense_hdr.sense_key == RECOVERED_ERROR) {
2848 ioctl_result = 0; /* EOF(s) written successfully at EOM */
2849 STps->eof = ST_NOEOF;
2850 } else { /* Writing EOF(s) failed */
2854 STps->eof = ST_NOEOF;
2856 STps->drv_file = fileno;
2857 } else if ((cmd_in == MTFSF) || (cmd_in == MTFSFM)) {
2859 STps->drv_file = fileno - undone;
2861 STps->drv_file = fileno;
2862 STps->drv_block = -1;
2863 STps->eof = ST_NOEOF;
2864 } else if ((cmd_in == MTBSF) || (cmd_in == MTBSFM)) {
2865 if (arg > 0 && undone < 0) /* Some drives get this wrong */
2867 if (STps->drv_file >= 0)
2868 STps->drv_file = fileno + undone;
2869 STps->drv_block = 0;
2870 STps->eof = ST_NOEOF;
2871 } else if (cmd_in == MTFSR) {
2872 if (cmdstatp->flags & SENSE_FMK) { /* Hit filemark */
2873 if (STps->drv_file >= 0)
2875 STps->drv_block = 0;
2878 if (blkno >= undone)
2879 STps->drv_block = blkno - undone;
2881 STps->drv_block = (-1);
2882 STps->eof = ST_NOEOF;
2884 } else if (cmd_in == MTBSR) {
2885 if (cmdstatp->flags & SENSE_FMK) { /* Hit filemark */
2887 STps->drv_block = (-1);
2889 if (arg > 0 && undone < 0) /* Some drives get this wrong */
2891 if (STps->drv_block >= 0)
2892 STps->drv_block = blkno + undone;
2894 STps->eof = ST_NOEOF;
2895 } else if (cmd_in == MTEOM) {
2896 STps->drv_file = (-1);
2897 STps->drv_block = (-1);
2899 } else if (cmd_in == MTSETBLK ||
2900 cmd_in == MTSETDENSITY ||
2901 cmd_in == MTSETDRVBUFFER ||
2902 cmd_in == SET_DENS_AND_BLK) {
2903 if (cmdstatp->sense_hdr.sense_key == ILLEGAL_REQUEST &&
2904 !(STp->use_pf & PF_TESTED)) {
2905 /* Try the other possible state of Page Format if not
2907 STp->use_pf = !STp->use_pf | PF_TESTED;
2908 st_release_request(SRpnt);
2910 return st_int_ioctl(STp, cmd_in, arg);
2913 STps->eof = ST_NOEOF;
2915 if (cmdstatp->sense_hdr.sense_key == BLANK_CHECK)
2918 st_release_request(SRpnt);
2922 return ioctl_result;
2926 /* Get the tape position. If bt == 2, arg points into a kernel space mt_loc
2929 static int get_location(struct scsi_tape *STp, unsigned int *block, int *partition,
2933 unsigned char scmd[MAX_COMMAND_SIZE];
2934 struct st_request *SRpnt;
2935 DEB( char *name = tape_name(STp); )
2937 if (STp->ready != ST_READY)
2940 memset(scmd, 0, MAX_COMMAND_SIZE);
2941 if ((STp->device)->scsi_level < SCSI_2) {
2942 scmd[0] = QFA_REQUEST_BLOCK;
2945 scmd[0] = READ_POSITION;
2946 if (!logical && !STp->scsi2_logical)
2949 SRpnt = st_do_scsi(NULL, STp, scmd, 20, DMA_FROM_DEVICE,
2950 STp->device->timeout, MAX_READY_RETRIES, 1);
2952 return (STp->buffer)->syscall_result;
2954 if ((STp->buffer)->syscall_result != 0 ||
2955 (STp->device->scsi_level >= SCSI_2 &&
2956 ((STp->buffer)->b_data[0] & 4) != 0)) {
2957 *block = *partition = 0;
2958 DEBC(printk(ST_DEB_MSG "%s: Can't read tape position.\n", name));
2962 if ((STp->device)->scsi_level < SCSI_2) {
2963 *block = ((STp->buffer)->b_data[0] << 16)
2964 + ((STp->buffer)->b_data[1] << 8)
2965 + (STp->buffer)->b_data[2];
2968 *block = ((STp->buffer)->b_data[4] << 24)
2969 + ((STp->buffer)->b_data[5] << 16)
2970 + ((STp->buffer)->b_data[6] << 8)
2971 + (STp->buffer)->b_data[7];
2972 *partition = (STp->buffer)->b_data[1];
2973 if (((STp->buffer)->b_data[0] & 0x80) &&
2974 (STp->buffer)->b_data[1] == 0) /* BOP of partition 0 */
2975 STp->ps[0].drv_block = STp->ps[0].drv_file = 0;
2977 DEBC(printk(ST_DEB_MSG "%s: Got tape pos. blk %d part %d.\n", name,
2978 *block, *partition));
2980 st_release_request(SRpnt);
2987 /* Set the tape block and partition. Negative partition means that only the
2988 block should be set in vendor specific way. */
2989 static int set_location(struct scsi_tape *STp, unsigned int block, int partition,
2992 struct st_partstat *STps;
2996 unsigned char scmd[MAX_COMMAND_SIZE];
2997 struct st_request *SRpnt;
2998 DEB( char *name = tape_name(STp); )
3000 if (STp->ready != ST_READY)
3002 timeout = STp->long_timeout;
3003 STps = &(STp->ps[STp->partition]);
3005 DEBC(printk(ST_DEB_MSG "%s: Setting block to %d and partition to %d.\n",
3006 name, block, partition));
3007 DEB(if (partition < 0)
3010 /* Update the location at the partition we are leaving */
3011 if ((!STp->can_partitions && partition != 0) ||
3012 partition >= ST_NBR_PARTITIONS)
3014 if (partition != STp->partition) {
3015 if (get_location(STp, &blk, &p, 1))
3016 STps->last_block_valid = 0;
3018 STps->last_block_valid = 1;
3019 STps->last_block_visited = blk;
3020 DEBC(printk(ST_DEB_MSG
3021 "%s: Visited block %d for partition %d saved.\n",
3022 name, blk, STp->partition));
3026 memset(scmd, 0, MAX_COMMAND_SIZE);
3027 if ((STp->device)->scsi_level < SCSI_2) {
3028 scmd[0] = QFA_SEEK_BLOCK;
3029 scmd[2] = (block >> 16);
3030 scmd[3] = (block >> 8);
3035 scmd[3] = (block >> 24);
3036 scmd[4] = (block >> 16);
3037 scmd[5] = (block >> 8);
3039 if (!logical && !STp->scsi2_logical)
3041 if (STp->partition != partition) {
3043 scmd[8] = partition;
3044 DEBC(printk(ST_DEB_MSG
3045 "%s: Trying to change partition from %d to %d\n",
3046 name, STp->partition, partition));
3049 if (STp->immediate) {
3050 scmd[1] |= 1; /* Don't wait for completion */
3051 timeout = STp->device->timeout;
3054 SRpnt = st_do_scsi(NULL, STp, scmd, 0, DMA_NONE,
3055 timeout, MAX_READY_RETRIES, 1);
3057 return (STp->buffer)->syscall_result;
3059 STps->drv_block = STps->drv_file = (-1);
3060 STps->eof = ST_NOEOF;
3061 if ((STp->buffer)->syscall_result != 0) {
3063 if (STp->can_partitions &&
3064 (STp->device)->scsi_level >= SCSI_2 &&
3065 (p = find_partition(STp)) >= 0)
3068 if (STp->can_partitions) {
3069 STp->partition = partition;
3070 STps = &(STp->ps[partition]);
3071 if (!STps->last_block_valid ||
3072 STps->last_block_visited != block) {
3079 STps->drv_block = STps->drv_file = 0;
3083 st_release_request(SRpnt);
3090 /* Find the current partition number for the drive status. Called from open and
3091 returns either partition number of negative error code. */
3092 static int find_partition(struct scsi_tape *STp)
3097 if ((i = get_location(STp, &block, &partition, 1)) < 0)
3099 if (partition >= ST_NBR_PARTITIONS)
3105 /* Change the partition if necessary */
3106 static int switch_partition(struct scsi_tape *STp)
3108 struct st_partstat *STps;
3110 if (STp->partition == STp->new_partition)
3112 STps = &(STp->ps[STp->new_partition]);
3113 if (!STps->last_block_valid)
3114 STps->last_block_visited = 0;
3115 return set_location(STp, STps->last_block_visited, STp->new_partition, 1);
3118 /* Functions for reading and writing the medium partition mode page. */
3120 #define PART_PAGE 0x11
3121 #define PART_PAGE_FIXED_LENGTH 8
3123 #define PP_OFF_MAX_ADD_PARTS 2
3124 #define PP_OFF_NBR_ADD_PARTS 3
3125 #define PP_OFF_FLAGS 4
3126 #define PP_OFF_PART_UNITS 6
3127 #define PP_OFF_RESERVED 7
3129 #define PP_BIT_IDP 0x20
3130 #define PP_MSK_PSUM_MB 0x10
3132 /* Get the number of partitions on the tape. As a side effect reads the
3133 mode page into the tape buffer. */
3134 static int nbr_partitions(struct scsi_tape *STp)
3137 DEB( char *name = tape_name(STp); )
3139 if (STp->ready != ST_READY)
3142 result = read_mode_page(STp, PART_PAGE, 1);
3145 DEBC(printk(ST_DEB_MSG "%s: Can't read medium partition page.\n",
3149 result = (STp->buffer)->b_data[MODE_HEADER_LENGTH +
3150 PP_OFF_NBR_ADD_PARTS] + 1;
3151 DEBC(printk(ST_DEB_MSG "%s: Number of partitions %d.\n", name, result));
3158 /* Partition the tape into two partitions if size > 0 or one partition if
3161 The block descriptors are read and written because Sony SDT-7000 does not
3162 work without this (suggestion from Michael Schaefer <Michael.Schaefer@dlr.de>).
3164 My HP C1533A drive returns only one partition size field. This is used to
3165 set the size of partition 1. There is no size field for the default partition.
3166 Michael Schaefer's Sony SDT-7000 returns two descriptors and the second is
3167 used to set the size of partition 1 (this is what the SCSI-3 standard specifies).
3168 The following algorithm is used to accommodate both drives: if the number of
3169 partition size fields is greater than the maximum number of additional partitions
3170 in the mode page, the second field is used. Otherwise the first field is used.
3172 For Seagate DDS drives the page length must be 8 when no partitions is defined
3173 and 10 when 1 partition is defined (information from Eric Lee Green). This is
3174 is acceptable also to some other old drives and enforced if the first partition
3175 size field is used for the first additional partition size.
3177 static int partition_tape(struct scsi_tape *STp, int size)
3179 char *name = tape_name(STp);
3181 int pgo, psd_cnt, psdo;
3184 result = read_mode_page(STp, PART_PAGE, 0);
3186 DEBC(printk(ST_DEB_MSG "%s: Can't read partition mode page.\n", name));
3189 /* The mode page is in the buffer. Let's modify it and write it. */
3190 bp = (STp->buffer)->b_data;
3191 pgo = MODE_HEADER_LENGTH + bp[MH_OFF_BDESCS_LENGTH];
3192 DEBC(printk(ST_DEB_MSG "%s: Partition page length is %d bytes.\n",
3193 name, bp[pgo + MP_OFF_PAGE_LENGTH] + 2));
3195 psd_cnt = (bp[pgo + MP_OFF_PAGE_LENGTH] + 2 - PART_PAGE_FIXED_LENGTH) / 2;
3196 psdo = pgo + PART_PAGE_FIXED_LENGTH;
3197 if (psd_cnt > bp[pgo + PP_OFF_MAX_ADD_PARTS]) {
3198 bp[psdo] = bp[psdo + 1] = 0xff; /* Rest of the tape */
3201 memset(bp + psdo, 0, bp[pgo + PP_OFF_NBR_ADD_PARTS] * 2);
3203 DEBC(printk("%s: psd_cnt %d, max.parts %d, nbr_parts %d\n", name,
3204 psd_cnt, bp[pgo + PP_OFF_MAX_ADD_PARTS],
3205 bp[pgo + PP_OFF_NBR_ADD_PARTS]));
3208 bp[pgo + PP_OFF_NBR_ADD_PARTS] = 0;
3209 if (psd_cnt <= bp[pgo + PP_OFF_MAX_ADD_PARTS])
3210 bp[pgo + MP_OFF_PAGE_LENGTH] = 6;
3211 DEBC(printk(ST_DEB_MSG "%s: Formatting tape with one partition.\n",
3214 bp[psdo] = (size >> 8) & 0xff;
3215 bp[psdo + 1] = size & 0xff;
3217 if (bp[pgo + MP_OFF_PAGE_LENGTH] < 8)
3218 bp[pgo + MP_OFF_PAGE_LENGTH] = 8;
3219 DEBC(printk(ST_DEB_MSG
3220 "%s: Formatting tape with two partitions (1 = %d MB).\n",
3223 bp[pgo + PP_OFF_PART_UNITS] = 0;
3224 bp[pgo + PP_OFF_RESERVED] = 0;
3225 bp[pgo + PP_OFF_FLAGS] = PP_BIT_IDP | PP_MSK_PSUM_MB;
3227 result = write_mode_page(STp, PART_PAGE, 1);
3229 printk(KERN_INFO "%s: Partitioning of tape failed.\n", name);
3238 /* The ioctl command */
3239 static long st_ioctl(struct file *file, unsigned int cmd_in, unsigned long arg)
3241 int i, cmd_nr, cmd_type, bt;
3244 struct scsi_tape *STp = file->private_data;
3245 struct st_modedef *STm;
3246 struct st_partstat *STps;
3247 char *name = tape_name(STp);
3248 void __user *p = (void __user *)arg;
3250 if (mutex_lock_interruptible(&STp->lock))
3251 return -ERESTARTSYS;
3254 if (debugging && !STp->in_use) {
3255 printk(ST_DEB_MSG "%s: Incorrect device.\n", name);
3260 STm = &(STp->modes[STp->current_mode]);
3261 STps = &(STp->ps[STp->partition]);
3264 * If we are in the middle of error recovery, don't let anyone
3265 * else try and use this device. Also, if error recovery fails, it
3266 * may try and take the device offline, in which case all further
3267 * access to the device is prohibited.
3269 retval = scsi_nonblockable_ioctl(STp->device, cmd_in, p, file);
3270 if (!scsi_block_when_processing_errors(STp->device) || retval != -ENODEV)
3274 cmd_type = _IOC_TYPE(cmd_in);
3275 cmd_nr = _IOC_NR(cmd_in);
3277 if (cmd_type == _IOC_TYPE(MTIOCTOP) && cmd_nr == _IOC_NR(MTIOCTOP)) {
3280 if (_IOC_SIZE(cmd_in) != sizeof(mtc)) {
3285 i = copy_from_user(&mtc, p, sizeof(struct mtop));
3291 if (mtc.mt_op == MTSETDRVBUFFER && !capable(CAP_SYS_ADMIN)) {
3293 "%s: MTSETDRVBUFFER only allowed for root.\n", name);
3297 if (!STm->defined &&
3298 (mtc.mt_op != MTSETDRVBUFFER &&
3299 (mtc.mt_count & MT_ST_OPTIONS) == 0)) {
3304 if (!STp->pos_unknown) {
3306 if (STps->eof == ST_FM_HIT) {
3307 if (mtc.mt_op == MTFSF || mtc.mt_op == MTFSFM ||
3308 mtc.mt_op == MTEOM) {
3310 if (STps->drv_file >= 0)
3311 STps->drv_file += 1;
3312 } else if (mtc.mt_op == MTBSF || mtc.mt_op == MTBSFM) {
3314 if (STps->drv_file >= 0)
3315 STps->drv_file += 1;
3319 if (mtc.mt_op == MTSEEK) {
3320 /* Old position must be restored if partition will be
3322 i = !STp->can_partitions ||
3323 (STp->new_partition != STp->partition);
3325 i = mtc.mt_op == MTREW || mtc.mt_op == MTOFFL ||
3326 mtc.mt_op == MTRETEN || mtc.mt_op == MTEOM ||
3327 mtc.mt_op == MTLOCK || mtc.mt_op == MTLOAD ||
3328 mtc.mt_op == MTFSF || mtc.mt_op == MTFSFM ||
3329 mtc.mt_op == MTBSF || mtc.mt_op == MTBSFM ||
3330 mtc.mt_op == MTCOMPRESSION;
3332 i = flush_buffer(STp, i);
3337 if (STps->rw == ST_WRITING &&
3338 (mtc.mt_op == MTREW || mtc.mt_op == MTOFFL ||
3339 mtc.mt_op == MTSEEK ||
3340 mtc.mt_op == MTBSF || mtc.mt_op == MTBSFM)) {
3341 i = st_int_ioctl(STp, MTWEOF, 1);
3346 if (mtc.mt_op == MTBSF || mtc.mt_op == MTBSFM)
3353 * If there was a bus reset, block further access
3354 * to this device. If the user wants to rewind the tape,
3355 * then reset the flag and allow access again.
3357 if (mtc.mt_op != MTREW &&
3358 mtc.mt_op != MTOFFL &&
3359 mtc.mt_op != MTRETEN &&
3360 mtc.mt_op != MTERASE &&
3361 mtc.mt_op != MTSEEK &&
3362 mtc.mt_op != MTEOM) {
3367 /* remove this when the midlevel properly clears was_reset */
3368 STp->device->was_reset = 0;
3371 if (mtc.mt_op != MTNOP && mtc.mt_op != MTSETBLK &&
3372 mtc.mt_op != MTSETDENSITY && mtc.mt_op != MTWSM &&
3373 mtc.mt_op != MTSETDRVBUFFER && mtc.mt_op != MTSETPART)
3374 STps->rw = ST_IDLE; /* Prevent automatic WEOF and fsf */
3376 if (mtc.mt_op == MTOFFL && STp->door_locked != ST_UNLOCKED)
3377 do_door_lock(STp, 0); /* Ignore result! */
3379 if (mtc.mt_op == MTSETDRVBUFFER &&
3380 (mtc.mt_count & MT_ST_OPTIONS) != 0) {
3381 retval = st_set_options(STp, mtc.mt_count);
3385 if (mtc.mt_op == MTSETPART) {
3386 if (!STp->can_partitions ||
3387 mtc.mt_count < 0 || mtc.mt_count >= ST_NBR_PARTITIONS) {
3391 if (mtc.mt_count >= STp->nbr_partitions &&
3392 (STp->nbr_partitions = nbr_partitions(STp)) < 0) {
3396 if (mtc.mt_count >= STp->nbr_partitions) {
3400 STp->new_partition = mtc.mt_count;
3405 if (mtc.mt_op == MTMKPART) {
3406 if (!STp->can_partitions) {
3410 if ((i = st_int_ioctl(STp, MTREW, 0)) < 0 ||
3411 (i = partition_tape(STp, mtc.mt_count)) < 0) {
3415 for (i = 0; i < ST_NBR_PARTITIONS; i++) {
3416 STp->ps[i].rw = ST_IDLE;
3417 STp->ps[i].at_sm = 0;
3418 STp->ps[i].last_block_valid = 0;
3420 STp->partition = STp->new_partition = 0;
3421 STp->nbr_partitions = 1; /* Bad guess ?-) */
3422 STps->drv_block = STps->drv_file = 0;
3427 if (mtc.mt_op == MTSEEK) {
3428 i = set_location(STp, mtc.mt_count, STp->new_partition, 0);
3429 if (!STp->can_partitions)
3430 STp->ps[0].rw = ST_IDLE;
3435 if (mtc.mt_op == MTUNLOAD || mtc.mt_op == MTOFFL) {
3436 retval = do_load_unload(STp, file, 0);
3440 if (mtc.mt_op == MTLOAD) {
3441 retval = do_load_unload(STp, file, max(1, mtc.mt_count));
3445 if (mtc.mt_op == MTLOCK || mtc.mt_op == MTUNLOCK) {
3446 retval = do_door_lock(STp, (mtc.mt_op == MTLOCK));
3450 if (STp->can_partitions && STp->ready == ST_READY &&
3451 (i = switch_partition(STp)) < 0) {
3456 if (mtc.mt_op == MTCOMPRESSION)
3457 retval = st_compression(STp, (mtc.mt_count & 1));
3459 retval = st_int_ioctl(STp, mtc.mt_op, mtc.mt_count);
3462 if (!STm->defined) {
3467 if ((i = flush_buffer(STp, 0)) < 0) {
3471 if (STp->can_partitions &&
3472 (i = switch_partition(STp)) < 0) {
3477 if (cmd_type == _IOC_TYPE(MTIOCGET) && cmd_nr == _IOC_NR(MTIOCGET)) {
3478 struct mtget mt_status;
3480 if (_IOC_SIZE(cmd_in) != sizeof(struct mtget)) {
3485 mt_status.mt_type = STp->tape_type;
3486 mt_status.mt_dsreg =
3487 ((STp->block_size << MT_ST_BLKSIZE_SHIFT) & MT_ST_BLKSIZE_MASK) |
3488 ((STp->density << MT_ST_DENSITY_SHIFT) & MT_ST_DENSITY_MASK);
3489 mt_status.mt_blkno = STps->drv_block;
3490 mt_status.mt_fileno = STps->drv_file;
3491 if (STp->block_size != 0) {
3492 if (STps->rw == ST_WRITING)
3493 mt_status.mt_blkno +=
3494 (STp->buffer)->buffer_bytes / STp->block_size;
3495 else if (STps->rw == ST_READING)
3496 mt_status.mt_blkno -=
3497 ((STp->buffer)->buffer_bytes +
3498 STp->block_size - 1) / STp->block_size;
3501 mt_status.mt_gstat = 0;
3502 if (STp->drv_write_prot)
3503 mt_status.mt_gstat |= GMT_WR_PROT(0xffffffff);
3504 if (mt_status.mt_blkno == 0) {
3505 if (mt_status.mt_fileno == 0)
3506 mt_status.mt_gstat |= GMT_BOT(0xffffffff);
3508 mt_status.mt_gstat |= GMT_EOF(0xffffffff);
3510 mt_status.mt_erreg = (STp->recover_reg << MT_ST_SOFTERR_SHIFT);
3511 mt_status.mt_resid = STp->partition;
3512 if (STps->eof == ST_EOM_OK || STps->eof == ST_EOM_ERROR)
3513 mt_status.mt_gstat |= GMT_EOT(0xffffffff);
3514 else if (STps->eof >= ST_EOM_OK)
3515 mt_status.mt_gstat |= GMT_EOD(0xffffffff);
3516 if (STp->density == 1)
3517 mt_status.mt_gstat |= GMT_D_800(0xffffffff);
3518 else if (STp->density == 2)
3519 mt_status.mt_gstat |= GMT_D_1600(0xffffffff);
3520 else if (STp->density == 3)
3521 mt_status.mt_gstat |= GMT_D_6250(0xffffffff);
3522 if (STp->ready == ST_READY)
3523 mt_status.mt_gstat |= GMT_ONLINE(0xffffffff);
3524 if (STp->ready == ST_NO_TAPE)
3525 mt_status.mt_gstat |= GMT_DR_OPEN(0xffffffff);
3527 mt_status.mt_gstat |= GMT_SM(0xffffffff);
3528 if (STm->do_async_writes ||
3529 (STm->do_buffer_writes && STp->block_size != 0) ||
3530 STp->drv_buffer != 0)
3531 mt_status.mt_gstat |= GMT_IM_REP_EN(0xffffffff);
3532 if (STp->cleaning_req)
3533 mt_status.mt_gstat |= GMT_CLN(0xffffffff);
3535 i = copy_to_user(p, &mt_status, sizeof(struct mtget));
3541 STp->recover_reg = 0; /* Clear after read */
3544 } /* End of MTIOCGET */
3545 if (cmd_type == _IOC_TYPE(MTIOCPOS) && cmd_nr == _IOC_NR(MTIOCPOS)) {
3546 struct mtpos mt_pos;
3547 if (_IOC_SIZE(cmd_in) != sizeof(struct mtpos)) {
3551 if ((i = get_location(STp, &blk, &bt, 0)) < 0) {
3555 mt_pos.mt_blkno = blk;
3556 i = copy_to_user(p, &mt_pos, sizeof(struct mtpos));
3561 mutex_unlock(&STp->lock);
3563 case SCSI_IOCTL_GET_IDLUN:
3564 case SCSI_IOCTL_GET_BUS_NUMBER:
3567 if ((cmd_in == SG_IO ||
3568 cmd_in == SCSI_IOCTL_SEND_COMMAND ||
3569 cmd_in == CDROM_SEND_PACKET) &&
3570 !capable(CAP_SYS_RAWIO))
3573 i = scsi_cmd_ioctl(file, STp->disk->queue,
3574 STp->disk, cmd_in, p);
3579 retval = scsi_ioctl(STp->device, cmd_in, p);
3580 if (!retval && cmd_in == SCSI_IOCTL_STOP_UNIT) { /* unload */
3581 STp->rew_at_close = 0;
3582 STp->ready = ST_NO_TAPE;
3587 mutex_unlock(&STp->lock);
3591 #ifdef CONFIG_COMPAT
3592 static long st_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
3594 struct scsi_tape *STp = file->private_data;
3595 struct scsi_device *sdev = STp->device;
3596 int ret = -ENOIOCTLCMD;
3597 if (sdev->host->hostt->compat_ioctl) {
3599 ret = sdev->host->hostt->compat_ioctl(sdev, cmd, (void __user *)arg);
3608 /* Try to allocate a new tape buffer. Calling function must not hold
3610 static struct st_buffer *
3611 new_tape_buffer(int from_initialization, int need_dma, int max_sg)
3615 struct st_buffer *tb;
3617 if (from_initialization)
3618 priority = GFP_ATOMIC;
3620 priority = GFP_KERNEL;
3622 i = sizeof(struct st_buffer) + (max_sg - 1) * sizeof(struct scatterlist) +
3623 max_sg * sizeof(struct st_buf_fragment);
3624 tb = kzalloc(i, priority);
3626 printk(KERN_NOTICE "st: Can't allocate new tape buffer.\n");
3629 tb->frp_segs = tb->orig_frp_segs = 0;
3630 tb->use_sg = max_sg;
3631 tb->frp = (struct st_buf_fragment *)(&(tb->sg[0]) + max_sg);
3634 tb->buffer_size = got;
3635 sg_init_table(tb->sg, max_sg);
3641 /* Try to allocate enough space in the tape buffer */
3642 static int enlarge_buffer(struct st_buffer * STbuffer, int new_size, int need_dma)
3644 int segs, nbr, max_segs, b_size, order, got;
3647 if (new_size <= STbuffer->buffer_size)
3650 if (STbuffer->buffer_size <= PAGE_SIZE)
3651 normalize_buffer(STbuffer); /* Avoid extra segment */
3653 max_segs = STbuffer->use_sg;
3654 nbr = max_segs - STbuffer->frp_segs;
3658 priority = GFP_KERNEL | __GFP_NOWARN;
3660 priority |= GFP_DMA;
3661 for (b_size = PAGE_SIZE, order=0; order <= 6 &&
3662 b_size < new_size - STbuffer->buffer_size;
3663 order++, b_size *= 2)
3666 for (segs = STbuffer->frp_segs, got = STbuffer->buffer_size;
3667 segs < max_segs && got < new_size;) {
3668 STbuffer->frp[segs].page = alloc_pages(priority, order);
3669 if (STbuffer->frp[segs].page == NULL) {
3670 if (new_size - got <= (max_segs - segs) * b_size / 2) {
3671 b_size /= 2; /* Large enough for the rest of the buffers */
3675 DEB(STbuffer->buffer_size = got);
3676 normalize_buffer(STbuffer);
3679 STbuffer->frp[segs].length = b_size;
3680 STbuffer->frp_segs += 1;
3682 STbuffer->buffer_size = got;
3683 if (STbuffer->cleared)
3684 memset(page_address(STbuffer->frp[segs].page), 0, b_size);
3687 STbuffer->b_data = page_address(STbuffer->frp[0].page);
3693 /* Make sure that no data from previous user is in the internal buffer */
3694 static void clear_buffer(struct st_buffer * st_bp)
3698 for (i=0; i < st_bp->frp_segs; i++)
3699 memset(page_address(st_bp->frp[i].page), 0, st_bp->frp[i].length);
3704 /* Release the extra buffer */
3705 static void normalize_buffer(struct st_buffer * STbuffer)
3709 for (i = STbuffer->orig_frp_segs; i < STbuffer->frp_segs; i++) {
3710 order = get_order(STbuffer->frp[i].length);
3711 __free_pages(STbuffer->frp[i].page, order);
3712 STbuffer->buffer_size -= STbuffer->frp[i].length;
3714 STbuffer->frp_segs = STbuffer->orig_frp_segs;
3715 STbuffer->frp_sg_current = 0;
3716 STbuffer->sg_segs = 0;
3720 /* Move data from the user buffer to the tape buffer. Returns zero (success) or
3721 negative error code. */
3722 static int append_to_buffer(const char __user *ubp, struct st_buffer * st_bp, int do_count)
3724 int i, cnt, res, offset;
3726 for (i = 0, offset = st_bp->buffer_bytes;
3727 i < st_bp->frp_segs && offset >= st_bp->frp[i].length; i++)
3728 offset -= st_bp->frp[i].length;
3729 if (i == st_bp->frp_segs) { /* Should never happen */
3730 printk(KERN_WARNING "st: append_to_buffer offset overflow.\n");
3733 for (; i < st_bp->frp_segs && do_count > 0; i++) {
3734 cnt = st_bp->frp[i].length - offset < do_count ?
3735 st_bp->frp[i].length - offset : do_count;
3736 res = copy_from_user(page_address(st_bp->frp[i].page) + offset, ubp, cnt);
3740 st_bp->buffer_bytes += cnt;
3744 if (do_count) /* Should never happen */
3751 /* Move data from the tape buffer to the user buffer. Returns zero (success) or
3752 negative error code. */
3753 static int from_buffer(struct st_buffer * st_bp, char __user *ubp, int do_count)
3755 int i, cnt, res, offset;
3757 for (i = 0, offset = st_bp->read_pointer;
3758 i < st_bp->frp_segs && offset >= st_bp->frp[i].length; i++)
3759 offset -= st_bp->frp[i].length;
3760 if (i == st_bp->frp_segs) { /* Should never happen */
3761 printk(KERN_WARNING "st: from_buffer offset overflow.\n");
3764 for (; i < st_bp->frp_segs && do_count > 0; i++) {
3765 cnt = st_bp->frp[i].length - offset < do_count ?
3766 st_bp->frp[i].length - offset : do_count;
3767 res = copy_to_user(ubp, page_address(st_bp->frp[i].page) + offset, cnt);
3771 st_bp->buffer_bytes -= cnt;
3772 st_bp->read_pointer += cnt;
3776 if (do_count) /* Should never happen */
3783 /* Move data towards start of buffer */
3784 static void move_buffer_data(struct st_buffer * st_bp, int offset)
3786 int src_seg, dst_seg, src_offset = 0, dst_offset;
3792 total=st_bp->buffer_bytes - offset;
3793 for (src_seg=0; src_seg < st_bp->frp_segs; src_seg++) {
3794 src_offset = offset;
3795 if (src_offset < st_bp->frp[src_seg].length)
3797 offset -= st_bp->frp[src_seg].length;
3800 st_bp->buffer_bytes = st_bp->read_pointer = total;
3801 for (dst_seg=dst_offset=0; total > 0; ) {
3802 count = min(st_bp->frp[dst_seg].length - dst_offset,
3803 st_bp->frp[src_seg].length - src_offset);
3804 memmove(page_address(st_bp->frp[dst_seg].page) + dst_offset,
3805 page_address(st_bp->frp[src_seg].page) + src_offset, count);
3806 src_offset += count;
3807 if (src_offset >= st_bp->frp[src_seg].length) {
3811 dst_offset += count;
3812 if (dst_offset >= st_bp->frp[dst_seg].length) {
3821 /* Fill the s/g list up to the length required for this transfer */
3822 static void buf_to_sg(struct st_buffer *STbp, unsigned int length)
3826 struct scatterlist *sg;
3827 struct st_buf_fragment *frp;
3829 if (length == STbp->frp_sg_current)
3830 return; /* work already done */
3832 sg = &(STbp->sg[0]);
3834 for (i=count=0; count < length; i++) {
3835 if (length - count > frp[i].length)
3836 sg_set_page(&sg[i], frp[i].page, frp[i].length, 0);
3838 sg_set_page(&sg[i], frp[i].page, length - count, 0);
3839 count += sg[i].length;
3842 STbp->frp_sg_current = length;
3846 /* Validate the options from command line or module parameters */
3847 static void validate_options(void)
3850 st_fixed_buffer_size = buffer_kbs * ST_KILOBYTE;
3851 if (max_sg_segs >= ST_FIRST_SG)
3852 st_max_sg_segs = max_sg_segs;
3856 /* Set the boot options. Syntax is defined in Documenation/scsi/st.txt.
3858 static int __init st_setup(char *str)
3860 int i, len, ints[5];
3863 stp = get_options(str, ARRAY_SIZE(ints), ints);
3866 for (i = 0; i < ints[0] && i < ARRAY_SIZE(parms); i++)
3868 *parms[i].val = ints[i + 1];
3870 while (stp != NULL) {
3871 for (i = 0; i < ARRAY_SIZE(parms); i++) {
3872 len = strlen(parms[i].name);
3873 if (!strncmp(stp, parms[i].name, len) &&
3874 (*(stp + len) == ':' || *(stp + len) == '=')) {
3877 simple_strtoul(stp + len + 1, NULL, 0);
3879 printk(KERN_WARNING "st: Obsolete parameter %s\n",
3884 if (i >= ARRAY_SIZE(parms))
3885 printk(KERN_WARNING "st: invalid parameter in '%s'\n",
3887 stp = strchr(stp, ',');
3898 __setup("st=", st_setup);
3902 static const struct file_operations st_fops =
3904 .owner = THIS_MODULE,
3907 .unlocked_ioctl = st_ioctl,
3908 #ifdef CONFIG_COMPAT
3909 .compat_ioctl = st_compat_ioctl,
3913 .release = st_release,
3916 static int st_probe(struct device *dev)
3918 struct scsi_device *SDp = to_scsi_device(dev);
3919 struct gendisk *disk = NULL;
3920 struct cdev *cdev = NULL;
3921 struct scsi_tape *tpnt = NULL;
3922 struct st_modedef *STm;
3923 struct st_partstat *STps;
3924 struct st_buffer *buffer;
3925 int i, j, mode, dev_num, error;
3928 if (SDp->type != TYPE_TAPE)
3930 if ((stp = st_incompatible(SDp))) {
3931 sdev_printk(KERN_INFO, SDp, "Found incompatible tape\n");
3932 printk(KERN_INFO "st: The suggested driver is %s.\n", stp);
3936 i = min(SDp->request_queue->max_hw_segments,
3937 SDp->request_queue->max_phys_segments);
3938 if (st_max_sg_segs < i)
3940 buffer = new_tape_buffer(1, (SDp->host)->unchecked_isa_dma, i);
3941 if (buffer == NULL) {
3943 "st: Can't allocate new tape buffer. Device not attached.\n");
3947 disk = alloc_disk(1);
3949 printk(KERN_ERR "st: out of memory. Device not attached.\n");
3950 goto out_buffer_free;
3953 write_lock(&st_dev_arr_lock);
3954 if (st_nr_dev >= st_dev_max) {
3955 struct scsi_tape **tmp_da;
3958 tmp_dev_max = max(st_nr_dev * 2, 8);
3959 if (tmp_dev_max > ST_MAX_TAPES)
3960 tmp_dev_max = ST_MAX_TAPES;
3961 if (tmp_dev_max <= st_nr_dev) {
3962 write_unlock(&st_dev_arr_lock);
3963 printk(KERN_ERR "st: Too many tape devices (max. %d).\n",
3968 tmp_da = kzalloc(tmp_dev_max * sizeof(struct scsi_tape *), GFP_ATOMIC);
3969 if (tmp_da == NULL) {
3970 write_unlock(&st_dev_arr_lock);
3971 printk(KERN_ERR "st: Can't extend device array.\n");
3975 if (scsi_tapes != NULL) {
3976 memcpy(tmp_da, scsi_tapes,
3977 st_dev_max * sizeof(struct scsi_tape *));
3980 scsi_tapes = tmp_da;
3982 st_dev_max = tmp_dev_max;
3985 for (i = 0; i < st_dev_max; i++)
3986 if (scsi_tapes[i] == NULL)
3988 if (i >= st_dev_max)
3989 panic("scsi_devices corrupt (st)");
3991 tpnt = kzalloc(sizeof(struct scsi_tape), GFP_ATOMIC);
3993 write_unlock(&st_dev_arr_lock);
3994 printk(KERN_ERR "st: Can't allocate device descriptor.\n");
3997 kref_init(&tpnt->kref);
3999 sprintf(disk->disk_name, "st%d", i);
4000 disk->private_data = &tpnt->driver;
4001 disk->queue = SDp->request_queue;
4002 tpnt->driver = &st_template;
4003 scsi_tapes[i] = tpnt;
4007 if (SDp->scsi_level <= 2)
4008 tpnt->tape_type = MT_ISSCSI1;
4010 tpnt->tape_type = MT_ISSCSI2;
4012 tpnt->buffer = buffer;
4013 tpnt->buffer->last_SRpnt = NULL;
4018 tpnt->drv_buffer = 1; /* Try buffering if no mode sense */
4019 tpnt->restr_dma = (SDp->host)->unchecked_isa_dma;
4020 tpnt->use_pf = (SDp->scsi_level >= SCSI_2);
4022 tpnt->do_auto_lock = ST_AUTO_LOCK;
4023 tpnt->can_bsr = (SDp->scsi_level > 2 ? 1 : ST_IN_FILE_POS); /* BSR mandatory in SCSI3 */
4024 tpnt->can_partitions = 0;
4025 tpnt->two_fm = ST_TWO_FM;
4026 tpnt->fast_mteom = ST_FAST_MTEOM;
4027 tpnt->scsi2_logical = ST_SCSI2LOGICAL;
4028 tpnt->sili = ST_SILI;
4029 tpnt->immediate = ST_NOWAIT;
4030 tpnt->default_drvbuffer = 0xff; /* No forced buffering */
4031 tpnt->partition = 0;
4032 tpnt->new_partition = 0;
4033 tpnt->nbr_partitions = 0;
4034 tpnt->device->timeout = ST_TIMEOUT;
4035 tpnt->long_timeout = ST_LONG_TIMEOUT;
4036 tpnt->try_dio = try_direct_io && !SDp->host->unchecked_isa_dma;
4038 for (i = 0; i < ST_NBR_MODES; i++) {
4039 STm = &(tpnt->modes[i]);
4041 STm->sysv = ST_SYSV;
4042 STm->defaults_for_writes = 0;
4043 STm->do_async_writes = ST_ASYNC_WRITES;
4044 STm->do_buffer_writes = ST_BUFFER_WRITES;
4045 STm->do_read_ahead = ST_READ_AHEAD;
4046 STm->default_compression = ST_DONT_TOUCH;
4047 STm->default_blksize = (-1); /* No forced size */
4048 STm->default_density = (-1); /* No forced density */
4051 for (i = 0; i < ST_NBR_PARTITIONS; i++) {
4052 STps = &(tpnt->ps[i]);
4054 STps->eof = ST_NOEOF;
4056 STps->last_block_valid = 0;
4057 STps->drv_block = (-1);
4058 STps->drv_file = (-1);
4061 tpnt->current_mode = 0;
4062 tpnt->modes[0].defined = 1;
4064 tpnt->density_changed = tpnt->compression_changed =
4065 tpnt->blksize_changed = 0;
4066 mutex_init(&tpnt->lock);
4069 write_unlock(&st_dev_arr_lock);
4071 for (mode = 0; mode < ST_NBR_MODES; ++mode) {
4072 STm = &(tpnt->modes[mode]);
4073 for (j=0; j < 2; j++) {
4074 cdev = cdev_alloc();
4077 "st%d: out of memory. Device not attached.\n",
4081 cdev->owner = THIS_MODULE;
4082 cdev->ops = &st_fops;
4084 error = cdev_add(cdev,
4085 MKDEV(SCSI_TAPE_MAJOR, TAPE_MINOR(dev_num, mode, j)),
4088 printk(KERN_ERR "st%d: Can't add %s-rewind mode %d\n",
4089 dev_num, j ? "non" : "auto", mode);
4090 printk(KERN_ERR "st%d: Device not attached.\n", dev_num);
4093 STm->cdevs[j] = cdev;
4096 error = do_create_class_files(tpnt, dev_num, mode);
4101 sdev_printk(KERN_NOTICE, SDp,
4102 "Attached scsi tape %s\n", tape_name(tpnt));
4103 sdev_printk(KERN_INFO, SDp, "%s: try direct i/o: %s (alignment %d B)\n",
4104 tape_name(tpnt), tpnt->try_dio ? "yes" : "no",
4105 queue_dma_alignment(SDp->request_queue) + 1);
4110 for (mode=0; mode < ST_NBR_MODES; mode++) {
4111 STm = &(tpnt->modes[mode]);
4112 sysfs_remove_link(&tpnt->device->sdev_gendev.kobj,
4114 for (j=0; j < 2; j++) {
4115 if (STm->cdevs[j]) {
4116 if (cdev == STm->cdevs[j])
4118 device_destroy(st_sysfs_class,
4119 MKDEV(SCSI_TAPE_MAJOR,
4120 TAPE_MINOR(i, mode, j)));
4121 cdev_del(STm->cdevs[j]);
4127 write_lock(&st_dev_arr_lock);
4128 scsi_tapes[dev_num] = NULL;
4130 write_unlock(&st_dev_arr_lock);
4141 static int st_remove(struct device *dev)
4143 struct scsi_device *SDp = to_scsi_device(dev);
4144 struct scsi_tape *tpnt;
4147 write_lock(&st_dev_arr_lock);
4148 for (i = 0; i < st_dev_max; i++) {
4149 tpnt = scsi_tapes[i];
4150 if (tpnt != NULL && tpnt->device == SDp) {
4151 scsi_tapes[i] = NULL;
4153 write_unlock(&st_dev_arr_lock);
4154 sysfs_remove_link(&tpnt->device->sdev_gendev.kobj,
4156 for (mode = 0; mode < ST_NBR_MODES; ++mode) {
4157 for (j=0; j < 2; j++) {
4158 device_destroy(st_sysfs_class,
4159 MKDEV(SCSI_TAPE_MAJOR,
4160 TAPE_MINOR(i, mode, j)));
4161 cdev_del(tpnt->modes[mode].cdevs[j]);
4162 tpnt->modes[mode].cdevs[j] = NULL;
4166 mutex_lock(&st_ref_mutex);
4167 kref_put(&tpnt->kref, scsi_tape_release);
4168 mutex_unlock(&st_ref_mutex);
4173 write_unlock(&st_dev_arr_lock);
4178 * scsi_tape_release - Called to free the Scsi_Tape structure
4179 * @kref: pointer to embedded kref
4181 * st_ref_mutex must be held entering this routine. Because it is
4182 * called on last put, you should always use the scsi_tape_get()
4183 * scsi_tape_put() helpers which manipulate the semaphore directly
4184 * and never do a direct kref_put().
4186 static void scsi_tape_release(struct kref *kref)
4188 struct scsi_tape *tpnt = to_scsi_tape(kref);
4189 struct gendisk *disk = tpnt->disk;
4191 tpnt->device = NULL;
4194 tpnt->buffer->orig_frp_segs = 0;
4195 normalize_buffer(tpnt->buffer);
4196 kfree(tpnt->buffer);
4199 disk->private_data = NULL;
4205 static int __init init_st(void)
4211 printk(KERN_INFO "st: Version %s, fixed bufsize %d, s/g segs %d\n",
4212 verstr, st_fixed_buffer_size, st_max_sg_segs);
4214 st_sysfs_class = class_create(THIS_MODULE, "scsi_tape");
4215 if (IS_ERR(st_sysfs_class)) {
4216 printk(KERN_ERR "Unable create sysfs class for SCSI tapes\n");
4217 return PTR_ERR(st_sysfs_class);
4220 err = register_chrdev_region(MKDEV(SCSI_TAPE_MAJOR, 0),
4221 ST_MAX_TAPE_ENTRIES, "st");
4223 printk(KERN_ERR "Unable to get major %d for SCSI tapes\n",
4228 err = scsi_register_driver(&st_template.gendrv);
4232 err = do_create_sysfs_files();
4239 scsi_unregister_driver(&st_template.gendrv);
4241 unregister_chrdev_region(MKDEV(SCSI_TAPE_MAJOR, 0),
4242 ST_MAX_TAPE_ENTRIES);
4244 class_destroy(st_sysfs_class);
4248 static void __exit exit_st(void)
4250 do_remove_sysfs_files();
4251 scsi_unregister_driver(&st_template.gendrv);
4252 unregister_chrdev_region(MKDEV(SCSI_TAPE_MAJOR, 0),
4253 ST_MAX_TAPE_ENTRIES);
4254 class_destroy(st_sysfs_class);
4256 printk(KERN_INFO "st: Unloaded.\n");
4259 module_init(init_st);
4260 module_exit(exit_st);
4263 /* The sysfs driver interface. Read-only at the moment */
4264 static ssize_t st_try_direct_io_show(struct device_driver *ddp, char *buf)
4266 return snprintf(buf, PAGE_SIZE, "%d\n", try_direct_io);
4268 static DRIVER_ATTR(try_direct_io, S_IRUGO, st_try_direct_io_show, NULL);
4270 static ssize_t st_fixed_buffer_size_show(struct device_driver *ddp, char *buf)
4272 return snprintf(buf, PAGE_SIZE, "%d\n", st_fixed_buffer_size);
4274 static DRIVER_ATTR(fixed_buffer_size, S_IRUGO, st_fixed_buffer_size_show, NULL);
4276 static ssize_t st_max_sg_segs_show(struct device_driver *ddp, char *buf)
4278 return snprintf(buf, PAGE_SIZE, "%d\n", st_max_sg_segs);
4280 static DRIVER_ATTR(max_sg_segs, S_IRUGO, st_max_sg_segs_show, NULL);
4282 static ssize_t st_version_show(struct device_driver *ddd, char *buf)
4284 return snprintf(buf, PAGE_SIZE, "[%s]\n", verstr);
4286 static DRIVER_ATTR(version, S_IRUGO, st_version_show, NULL);
4288 static int do_create_sysfs_files(void)
4290 struct device_driver *sysfs = &st_template.gendrv;
4293 err = driver_create_file(sysfs, &driver_attr_try_direct_io);
4296 err = driver_create_file(sysfs, &driver_attr_fixed_buffer_size);
4298 goto err_try_direct_io;
4299 err = driver_create_file(sysfs, &driver_attr_max_sg_segs);
4301 goto err_attr_fixed_buf;
4302 err = driver_create_file(sysfs, &driver_attr_version);
4304 goto err_attr_max_sg;
4309 driver_remove_file(sysfs, &driver_attr_max_sg_segs);
4311 driver_remove_file(sysfs, &driver_attr_fixed_buffer_size);
4313 driver_remove_file(sysfs, &driver_attr_try_direct_io);
4317 static void do_remove_sysfs_files(void)
4319 struct device_driver *sysfs = &st_template.gendrv;
4321 driver_remove_file(sysfs, &driver_attr_version);
4322 driver_remove_file(sysfs, &driver_attr_max_sg_segs);
4323 driver_remove_file(sysfs, &driver_attr_fixed_buffer_size);
4324 driver_remove_file(sysfs, &driver_attr_try_direct_io);
4328 /* The sysfs simple class interface */
4330 st_defined_show(struct device *dev, struct device_attribute *attr, char *buf)
4332 struct st_modedef *STm = dev_get_drvdata(dev);
4335 l = snprintf(buf, PAGE_SIZE, "%d\n", STm->defined);
4339 DEVICE_ATTR(defined, S_IRUGO, st_defined_show, NULL);
4342 st_defblk_show(struct device *dev, struct device_attribute *attr, char *buf)
4344 struct st_modedef *STm = dev_get_drvdata(dev);
4347 l = snprintf(buf, PAGE_SIZE, "%d\n", STm->default_blksize);
4351 DEVICE_ATTR(default_blksize, S_IRUGO, st_defblk_show, NULL);
4354 st_defdensity_show(struct device *dev, struct device_attribute *attr, char *buf)
4356 struct st_modedef *STm = dev_get_drvdata(dev);
4360 fmt = STm->default_density >= 0 ? "0x%02x\n" : "%d\n";
4361 l = snprintf(buf, PAGE_SIZE, fmt, STm->default_density);
4365 DEVICE_ATTR(default_density, S_IRUGO, st_defdensity_show, NULL);
4368 st_defcompression_show(struct device *dev, struct device_attribute *attr,
4371 struct st_modedef *STm = dev_get_drvdata(dev);
4374 l = snprintf(buf, PAGE_SIZE, "%d\n", STm->default_compression - 1);
4378 DEVICE_ATTR(default_compression, S_IRUGO, st_defcompression_show, NULL);
4381 st_options_show(struct device *dev, struct device_attribute *attr, char *buf)
4383 struct st_modedef *STm = dev_get_drvdata(dev);
4384 struct scsi_tape *STp;
4388 for (i=0; i < st_dev_max; i++) {
4389 for (j=0; j < ST_NBR_MODES; j++)
4390 if (&scsi_tapes[i]->modes[j] == STm)
4392 if (j < ST_NBR_MODES)
4395 if (i == st_dev_max)
4396 return 0; /* should never happen */
4398 STp = scsi_tapes[i];
4400 options = STm->do_buffer_writes ? MT_ST_BUFFER_WRITES : 0;
4401 options |= STm->do_async_writes ? MT_ST_ASYNC_WRITES : 0;
4402 options |= STm->do_read_ahead ? MT_ST_READ_AHEAD : 0;
4403 DEB( options |= debugging ? MT_ST_DEBUGGING : 0 );
4404 options |= STp->two_fm ? MT_ST_TWO_FM : 0;
4405 options |= STp->fast_mteom ? MT_ST_FAST_MTEOM : 0;
4406 options |= STm->defaults_for_writes ? MT_ST_DEF_WRITES : 0;
4407 options |= STp->can_bsr ? MT_ST_CAN_BSR : 0;
4408 options |= STp->omit_blklims ? MT_ST_NO_BLKLIMS : 0;
4409 options |= STp->can_partitions ? MT_ST_CAN_PARTITIONS : 0;
4410 options |= STp->scsi2_logical ? MT_ST_SCSI2LOGICAL : 0;
4411 options |= STm->sysv ? MT_ST_SYSV : 0;
4412 options |= STp->immediate ? MT_ST_NOWAIT : 0;
4413 options |= STp->sili ? MT_ST_SILI : 0;
4415 l = snprintf(buf, PAGE_SIZE, "0x%08x\n", options);
4419 DEVICE_ATTR(options, S_IRUGO, st_options_show, NULL);
4421 static int do_create_class_files(struct scsi_tape *STp, int dev_num, int mode)
4425 struct device *st_class_member;
4427 for (rew=0; rew < 2; rew++) {
4428 /* Make sure that the minor numbers corresponding to the four
4429 first modes always get the same names */
4430 i = mode << (4 - ST_NBR_MODE_BITS);
4431 snprintf(name, 10, "%s%s%s", rew ? "n" : "",
4432 STp->disk->disk_name, st_formats[i]);
4434 device_create_drvdata(st_sysfs_class,
4435 &STp->device->sdev_gendev,
4436 MKDEV(SCSI_TAPE_MAJOR,
4441 if (IS_ERR(st_class_member)) {
4442 printk(KERN_WARNING "st%d: device_create failed\n",
4444 error = PTR_ERR(st_class_member);
4448 error = device_create_file(st_class_member,
4450 if (error) goto out;
4451 error = device_create_file(st_class_member,
4452 &dev_attr_default_blksize);
4453 if (error) goto out;
4454 error = device_create_file(st_class_member,
4455 &dev_attr_default_density);
4456 if (error) goto out;
4457 error = device_create_file(st_class_member,
4458 &dev_attr_default_compression);
4459 if (error) goto out;
4460 error = device_create_file(st_class_member,
4462 if (error) goto out;
4464 if (mode == 0 && rew == 0) {
4465 error = sysfs_create_link(&STp->device->sdev_gendev.kobj,
4466 &st_class_member->kobj,
4470 "st%d: Can't create sysfs link from SCSI device.\n",
4483 /* The following functions may be useful for a larger audience. */
4484 static int sgl_map_user_pages(struct scatterlist *sgl, const unsigned int max_pages,
4485 unsigned long uaddr, size_t count, int rw)
4487 unsigned long end = (uaddr + count + PAGE_SIZE - 1) >> PAGE_SHIFT;
4488 unsigned long start = uaddr >> PAGE_SHIFT;
4489 const int nr_pages = end - start;
4491 struct page **pages;
4493 /* User attempted Overflow! */
4494 if ((uaddr + count) < uaddr)
4498 if (nr_pages > max_pages)
4505 if ((pages = kmalloc(max_pages * sizeof(*pages), GFP_KERNEL)) == NULL)
4508 /* Try to fault in all of the necessary pages */
4509 down_read(¤t->mm->mmap_sem);
4510 /* rw==READ means read from drive, write into memory area */
4511 res = get_user_pages(
4517 0, /* don't force */
4520 up_read(¤t->mm->mmap_sem);
4522 /* Errors and no page mapped should return here */
4526 for (i=0; i < nr_pages; i++) {
4527 /* FIXME: flush superflous for rw==READ,
4528 * probably wrong function for rw==WRITE
4530 flush_dcache_page(pages[i]);
4533 /* Populate the scatter/gather list */
4534 sg_set_page(&sgl[0], pages[0], 0, uaddr & ~PAGE_MASK);
4536 sgl[0].length = PAGE_SIZE - sgl[0].offset;
4537 count -= sgl[0].length;
4538 for (i=1; i < nr_pages ; i++) {
4539 sg_set_page(&sgl[i], pages[i],
4540 count < PAGE_SIZE ? count : PAGE_SIZE, 0);;
4545 sgl[0].length = count;
4553 for (j=0; j < res; j++)
4554 page_cache_release(pages[j]);
4562 /* And unmap them... */
4563 static int sgl_unmap_user_pages(struct scatterlist *sgl, const unsigned int nr_pages,
4568 for (i=0; i < nr_pages; i++) {
4569 struct page *page = sg_page(&sgl[i]);
4573 /* FIXME: cache flush missing for rw==READ
4574 * FIXME: call the correct reference counting function
4576 page_cache_release(page);