blob: 544dc6b1f54808516ce2890356c49536ea956d30 [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 */
38 unsigned char do_dio; /* direct i/o set up? */
Kai Makisara40f6b362008-02-24 22:23:24 +020039 unsigned char cleared; /* internal buffer cleared after open? */
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 Tomonori66207422008-12-18 14:49:43 +090049 struct page **mapped_pages;
FUJITA Tomonorid0e1ae32008-12-18 14:49:40 +090050 struct rq_map_data map_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 unsigned char *b_data;
52 unsigned short use_sg; /* zero or max number of s/g segments for this adapter */
53 unsigned short sg_segs; /* number of segments in s/g list */
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 unsigned short frp_segs; /* number of buffer segments */
Linus Torvalds1da177e2005-04-16 15:20:36 -070055};
56
Linus Torvalds1da177e2005-04-16 15:20:36 -070057/* The tape mode definition */
58struct st_modedef {
59 unsigned char defined;
60 unsigned char sysv; /* SYS V semantics? */
61 unsigned char do_async_writes;
62 unsigned char do_buffer_writes;
63 unsigned char do_read_ahead;
64 unsigned char defaults_for_writes;
65 unsigned char default_compression; /* 0 = don't touch, etc */
66 short default_density; /* Forced density, -1 = no value */
67 int default_blksize; /* Forced blocksize, -1 = no value */
68 struct cdev *cdevs[2]; /* Auto-rewind and non-rewind devices */
69};
70
71/* Number of modes can be changed by changing ST_NBR_MODE_BITS. The maximum
72 number of modes is 16 (ST_NBR_MODE_BITS 4) */
73#define ST_NBR_MODE_BITS 2
74#define ST_NBR_MODES (1 << ST_NBR_MODE_BITS)
75#define ST_MODE_SHIFT (7 - ST_NBR_MODE_BITS)
76#define ST_MODE_MASK ((ST_NBR_MODES - 1) << ST_MODE_SHIFT)
77
78#define ST_MAX_TAPES 128
79#define ST_MAX_TAPE_ENTRIES (ST_MAX_TAPES << (ST_NBR_MODE_BITS + 1))
80
81/* The status related to each partition */
82struct st_partstat {
83 unsigned char rw;
84 unsigned char eof;
85 unsigned char at_sm;
86 unsigned char last_block_valid;
87 u32 last_block_visited;
88 int drv_block; /* The block where the drive head is */
89 int drv_file;
90};
91
92#define ST_NBR_PARTITIONS 4
93
94/* The tape drive descriptor */
95struct scsi_tape {
96 struct scsi_driver *driver;
97 struct scsi_device *device;
Matthias Kaehlcke28f85002007-07-29 23:38:15 +020098 struct mutex lock; /* For serialization */
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 struct completion wait; /* For SCSI commands */
100 struct st_buffer *buffer;
101
102 /* Drive characteristics */
103 unsigned char omit_blklims;
104 unsigned char do_auto_lock;
105 unsigned char can_bsr;
106 unsigned char can_partitions;
107 unsigned char two_fm;
108 unsigned char fast_mteom;
109 unsigned char immediate;
110 unsigned char restr_dma;
111 unsigned char scsi2_logical;
112 unsigned char default_drvbuffer; /* 0xff = don't touch, value 3 bits */
113 unsigned char cln_mode; /* 0 = none, otherwise sense byte nbr */
114 unsigned char cln_sense_value;
115 unsigned char cln_sense_mask;
116 unsigned char use_pf; /* Set Page Format bit in all mode selects? */
Kai Makisara9abe16c2007-02-03 13:21:29 +0200117 unsigned char try_dio; /* try direct i/o in general? */
118 unsigned char try_dio_now; /* try direct i/o before next close? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 unsigned char c_algo; /* compression algorithm */
120 unsigned char pos_unknown; /* after reset position unknown */
Kai Makisara40f6b362008-02-24 22:23:24 +0200121 unsigned char sili; /* use SILI when reading in variable b mode */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 int tape_type;
123 int long_timeout; /* timeout for commands known to take long time */
124
125 unsigned long max_pfn; /* the maximum page number reachable by the HBA */
126
127 /* Mode characteristics */
128 struct st_modedef modes[ST_NBR_MODES];
129 int current_mode;
130
131 /* Status variables */
132 int partition;
133 int new_partition;
134 int nbr_partitions; /* zero until partition support enabled */
135 struct st_partstat ps[ST_NBR_PARTITIONS];
136 unsigned char dirty;
137 unsigned char ready;
138 unsigned char write_prot;
139 unsigned char drv_write_prot;
140 unsigned char in_use;
141 unsigned char blksize_changed;
142 unsigned char density_changed;
143 unsigned char compression_changed;
144 unsigned char drv_buffer;
145 unsigned char density;
146 unsigned char door_locked;
147 unsigned char autorew_dev; /* auto-rewind device */
148 unsigned char rew_at_close; /* rewind necessary at close */
149 unsigned char inited;
150 unsigned char cleaning_req; /* cleaning requested? */
151 int block_size;
152 int min_block;
153 int max_block;
154 int recover_count; /* From tape opening */
155 int recover_reg; /* From last status call */
156
157#if DEBUG
158 unsigned char write_pending;
159 int nbr_finished;
160 int nbr_waits;
161 int nbr_requests;
162 int nbr_dio;
163 int nbr_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 unsigned char last_cmnd[6];
165 unsigned char last_sense[16];
166#endif
167 struct gendisk *disk;
Kai Makisaraf03a5672005-08-02 13:40:47 +0300168 struct kref kref;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169};
170
171/* Bit masks for use_pf */
172#define USE_PF 1
173#define PF_TESTED 2
174
175/* Values of eof */
176#define ST_NOEOF 0
177#define ST_FM_HIT 1
178#define ST_FM 2
179#define ST_EOM_OK 3
180#define ST_EOM_ERROR 4
181#define ST_EOD_1 5
182#define ST_EOD_2 6
183#define ST_EOD 7
184/* EOD hit while reading => ST_EOD_1 => return zero => ST_EOD_2 =>
185 return zero => ST_EOD, return ENOSPC */
186/* When writing: ST_EOM_OK == early warning found, write OK
187 ST_EOD_1 == allow trying new write after early warning
188 ST_EOM_ERROR == early warning found, not able to write all */
189
190/* Values of rw */
191#define ST_IDLE 0
192#define ST_READING 1
193#define ST_WRITING 2
194
195/* Values of ready state */
196#define ST_READY 0
197#define ST_NOT_READY 1
198#define ST_NO_TAPE 2
199
200/* Values for door lock state */
201#define ST_UNLOCKED 0
202#define ST_LOCKED_EXPLICIT 1
203#define ST_LOCKED_AUTO 2
204#define ST_LOCK_FAILS 3
205
206/* Positioning SCSI-commands for Tandberg, etc. drives */
207#define QFA_REQUEST_BLOCK 0x02
208#define QFA_SEEK_BLOCK 0x0c
209
210/* Setting the binary options */
211#define ST_DONT_TOUCH 0
212#define ST_NO 1
213#define ST_YES 2
214
215#define EXTENDED_SENSE_START 18
216
217/* Masks for some conditions in the sense data */
218#define SENSE_FMK 0x80
219#define SENSE_EOM 0x40
220#define SENSE_ILI 0x20
221
222#endif