blob: b6486b5d8681122759ae9bd3d5ca8e59542231a9 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001
2#ifndef _ST_H
3#define _ST_H
4
5#include <linux/completion.h>
Matthias Kaehlcke28f85002007-07-29 23:38:15 +02006#include <linux/mutex.h>
Kai Makisaraf03a5672005-08-02 13:40:47 +03007#include <linux/kref.h>
Mike Christie8b05b772005-11-08 04:06:44 -06008#include <scsi/scsi_cmnd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009
10/* Descriptor for analyzed sense data */
11struct st_cmdstatus {
12 int midlevel_result;
13 struct scsi_sense_hdr sense_hdr;
14 int have_sense;
Kai Makisara40f6b362008-02-24 22:23:24 +020015 int residual;
Linus Torvalds1da177e2005-04-16 15:20:36 -070016 u64 uremainder64;
17 u8 flags;
18 u8 remainder_valid;
19 u8 fixed_format;
20 u8 deferred;
21};
22
Mike Christie8b05b772005-11-08 04:06:44 -060023struct scsi_tape;
24
25/* scsi tape command */
26struct st_request {
27 unsigned char cmd[MAX_COMMAND_SIZE];
28 unsigned char sense[SCSI_SENSE_BUFFERSIZE];
29 int result;
30 struct scsi_tape *stp;
31 struct completion *waiting;
FUJITA Tomonori13b53b42008-12-18 14:49:41 +090032 struct bio *bio;
Mike Christie8b05b772005-11-08 04:06:44 -060033};
34
Linus Torvalds1da177e2005-04-16 15:20:36 -070035/* The tape buffer descriptor. */
36struct st_buffer {
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 unsigned char dma; /* DMA-able buffer */
Kai Makisara40f6b362008-02-24 22:23:24 +020038 unsigned char cleared; /* internal buffer cleared after open? */
David Jeffery7c018a92012-04-11 12:14:25 -040039 unsigned short do_dio; /* direct i/o set up? */
Linus Torvalds1da177e2005-04-16 15:20:36 -070040 int buffer_size;
41 int buffer_blocks;
42 int buffer_bytes;
43 int read_pointer;
44 int writing;
45 int syscall_result;
Mike Christie8b05b772005-11-08 04:06:44 -060046 struct st_request *last_SRpnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -070047 struct st_cmdstatus cmdstat;
FUJITA Tomonorid0e1ae32008-12-18 14:49:40 +090048 struct page **reserved_pages;
FUJITA Tomonoric982c362009-11-26 09:24:13 +090049 int reserved_page_order;
FUJITA Tomonori66207422008-12-18 14:49:43 +090050 struct page **mapped_pages;
FUJITA Tomonorid0e1ae32008-12-18 14:49:40 +090051 struct rq_map_data map_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 unsigned char *b_data;
53 unsigned short use_sg; /* zero or max number of s/g segments for this adapter */
54 unsigned short sg_segs; /* number of segments in s/g list */
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 unsigned short frp_segs; /* number of buffer segments */
Linus Torvalds1da177e2005-04-16 15:20:36 -070056};
57
Linus Torvalds1da177e2005-04-16 15:20:36 -070058/* The tape mode definition */
59struct st_modedef {
60 unsigned char defined;
61 unsigned char sysv; /* SYS V semantics? */
62 unsigned char do_async_writes;
63 unsigned char do_buffer_writes;
64 unsigned char do_read_ahead;
65 unsigned char defaults_for_writes;
66 unsigned char default_compression; /* 0 = don't touch, etc */
67 short default_density; /* Forced density, -1 = no value */
68 int default_blksize; /* Forced blocksize, -1 = no value */
Jeff Mahoney6c648d92012-08-18 15:20:39 -040069 struct scsi_tape *tape;
Jeff Mahoney26898af2012-08-18 15:20:40 -040070 struct device *devs[2]; /* Auto-rewind and non-rewind devices */
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 struct cdev *cdevs[2]; /* Auto-rewind and non-rewind devices */
72};
73
74/* Number of modes can be changed by changing ST_NBR_MODE_BITS. The maximum
75 number of modes is 16 (ST_NBR_MODE_BITS 4) */
76#define ST_NBR_MODE_BITS 2
77#define ST_NBR_MODES (1 << ST_NBR_MODE_BITS)
78#define ST_MODE_SHIFT (7 - ST_NBR_MODE_BITS)
79#define ST_MODE_MASK ((ST_NBR_MODES - 1) << ST_MODE_SHIFT)
80
Jeff Mahoney6ed33a42012-08-18 15:20:41 -040081#define ST_MAX_TAPES (1 << (20 - (ST_NBR_MODE_BITS + 1)))
Linus Torvalds1da177e2005-04-16 15:20:36 -070082#define ST_MAX_TAPE_ENTRIES (ST_MAX_TAPES << (ST_NBR_MODE_BITS + 1))
83
84/* The status related to each partition */
85struct st_partstat {
86 unsigned char rw;
87 unsigned char eof;
88 unsigned char at_sm;
89 unsigned char last_block_valid;
90 u32 last_block_visited;
91 int drv_block; /* The block where the drive head is */
92 int drv_file;
93};
94
Seymour, Shane M05545c92015-05-06 01:37:20 +000095/* Tape statistics */
96struct scsi_tape_stats {
97 atomic64_t read_byte_cnt; /* bytes read */
98 atomic64_t write_byte_cnt; /* bytes written */
99 atomic64_t in_flight; /* Number of I/Os in flight */
100 atomic64_t read_cnt; /* Count of read requests */
101 atomic64_t write_cnt; /* Count of write requests */
102 atomic64_t other_cnt; /* Count of other requests either
103 * implicit or from user space
104 * ioctl. */
105 atomic64_t resid_cnt; /* Count of resid_len > 0 */
106 atomic64_t tot_read_time; /* ktime spent completing reads */
107 atomic64_t tot_write_time; /* ktime spent completing writes */
108 atomic64_t tot_io_time; /* ktime spent doing any I/O */
109 ktime_t read_time; /* holds ktime request was queued */
110 ktime_t write_time; /* holds ktime request was queued */
111 ktime_t other_time; /* holds ktime request was queued */
112 atomic_t last_read_size; /* Number of bytes issued for last read */
113 atomic_t last_write_size; /* Number of bytes issued for last write */
114};
115
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116#define ST_NBR_PARTITIONS 4
117
118/* The tape drive descriptor */
119struct scsi_tape {
120 struct scsi_driver *driver;
121 struct scsi_device *device;
Matthias Kaehlcke28f85002007-07-29 23:38:15 +0200122 struct mutex lock; /* For serialization */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 struct completion wait; /* For SCSI commands */
124 struct st_buffer *buffer;
Jeff Mahoney6c648d92012-08-18 15:20:39 -0400125 int index;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
127 /* Drive characteristics */
128 unsigned char omit_blklims;
129 unsigned char do_auto_lock;
130 unsigned char can_bsr;
131 unsigned char can_partitions;
132 unsigned char two_fm;
133 unsigned char fast_mteom;
134 unsigned char immediate;
135 unsigned char restr_dma;
136 unsigned char scsi2_logical;
137 unsigned char default_drvbuffer; /* 0xff = don't touch, value 3 bits */
138 unsigned char cln_mode; /* 0 = none, otherwise sense byte nbr */
139 unsigned char cln_sense_value;
140 unsigned char cln_sense_mask;
141 unsigned char use_pf; /* Set Page Format bit in all mode selects? */
Kai Makisara9abe16c2007-02-03 13:21:29 +0200142 unsigned char try_dio; /* try direct i/o in general? */
143 unsigned char try_dio_now; /* try direct i/o before next close? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 unsigned char c_algo; /* compression algorithm */
145 unsigned char pos_unknown; /* after reset position unknown */
Kai Makisara40f6b362008-02-24 22:23:24 +0200146 unsigned char sili; /* use SILI when reading in variable b mode */
Lee Duncanc743e442012-03-01 12:41:01 -0800147 unsigned char immediate_filemark; /* write filemark immediately */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 int tape_type;
149 int long_timeout; /* timeout for commands known to take long time */
150
151 unsigned long max_pfn; /* the maximum page number reachable by the HBA */
152
153 /* Mode characteristics */
154 struct st_modedef modes[ST_NBR_MODES];
155 int current_mode;
156
157 /* Status variables */
158 int partition;
159 int new_partition;
160 int nbr_partitions; /* zero until partition support enabled */
161 struct st_partstat ps[ST_NBR_PARTITIONS];
162 unsigned char dirty;
163 unsigned char ready;
164 unsigned char write_prot;
165 unsigned char drv_write_prot;
166 unsigned char in_use;
167 unsigned char blksize_changed;
168 unsigned char density_changed;
169 unsigned char compression_changed;
170 unsigned char drv_buffer;
171 unsigned char density;
172 unsigned char door_locked;
173 unsigned char autorew_dev; /* auto-rewind device */
174 unsigned char rew_at_close; /* rewind necessary at close */
175 unsigned char inited;
176 unsigned char cleaning_req; /* cleaning requested? */
177 int block_size;
178 int min_block;
179 int max_block;
180 int recover_count; /* From tape opening */
181 int recover_reg; /* From last status call */
182
183#if DEBUG
184 unsigned char write_pending;
185 int nbr_finished;
186 int nbr_waits;
187 int nbr_requests;
188 int nbr_dio;
189 int nbr_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 unsigned char last_cmnd[6];
191 unsigned char last_sense[16];
192#endif
193 struct gendisk *disk;
Kai Makisaraf03a5672005-08-02 13:40:47 +0300194 struct kref kref;
Seymour, Shane M05545c92015-05-06 01:37:20 +0000195 struct scsi_tape_stats *stats;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196};
197
198/* Bit masks for use_pf */
199#define USE_PF 1
200#define PF_TESTED 2
201
202/* Values of eof */
203#define ST_NOEOF 0
204#define ST_FM_HIT 1
205#define ST_FM 2
206#define ST_EOM_OK 3
207#define ST_EOM_ERROR 4
208#define ST_EOD_1 5
209#define ST_EOD_2 6
210#define ST_EOD 7
211/* EOD hit while reading => ST_EOD_1 => return zero => ST_EOD_2 =>
212 return zero => ST_EOD, return ENOSPC */
213/* When writing: ST_EOM_OK == early warning found, write OK
214 ST_EOD_1 == allow trying new write after early warning
215 ST_EOM_ERROR == early warning found, not able to write all */
216
217/* Values of rw */
218#define ST_IDLE 0
219#define ST_READING 1
220#define ST_WRITING 2
221
222/* Values of ready state */
223#define ST_READY 0
224#define ST_NOT_READY 1
225#define ST_NO_TAPE 2
226
227/* Values for door lock state */
228#define ST_UNLOCKED 0
229#define ST_LOCKED_EXPLICIT 1
230#define ST_LOCKED_AUTO 2
231#define ST_LOCK_FAILS 3
232
233/* Positioning SCSI-commands for Tandberg, etc. drives */
234#define QFA_REQUEST_BLOCK 0x02
235#define QFA_SEEK_BLOCK 0x0c
236
237/* Setting the binary options */
238#define ST_DONT_TOUCH 0
239#define ST_NO 1
240#define ST_YES 2
241
242#define EXTENDED_SENSE_START 18
243
244/* Masks for some conditions in the sense data */
245#define SENSE_FMK 0x80
246#define SENSE_EOM 0x40
247#define SENSE_ILI 0x20
248
249#endif