[SCSI] st: convert dio path to use st_scsi_execute
[linux-2.6.git] / drivers / scsi / st.h
1
2 #ifndef _ST_H
3 #define _ST_H
4
5 #include <linux/completion.h>
6 #include <linux/mutex.h>
7 #include <linux/kref.h>
8 #include <scsi/scsi_cmnd.h>
9
10 /* Descriptor for analyzed sense data */
11 struct st_cmdstatus {
12         int midlevel_result;
13         struct scsi_sense_hdr sense_hdr;
14         int have_sense;
15         int residual;
16         u64 uremainder64;
17         u8 flags;
18         u8 remainder_valid;
19         u8 fixed_format;
20         u8 deferred;
21 };
22
23 struct scsi_tape;
24
25 /* scsi tape command */
26 struct 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;
32         struct bio *bio;
33 };
34
35 /* The tape buffer descriptor. */
36 struct st_buffer {
37         unsigned char dma;      /* DMA-able buffer */
38         unsigned char do_dio;   /* direct i/o set up? */
39         unsigned char cleared;  /* internal buffer cleared after open? */
40         int buffer_size;
41         int buffer_blocks;
42         int buffer_bytes;
43         int read_pointer;
44         int writing;
45         int syscall_result;
46         struct st_request *last_SRpnt;
47         struct st_cmdstatus cmdstat;
48         struct page **reserved_pages;
49         struct page **mapped_pages;
50         struct rq_map_data map_data;
51         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 */
54         unsigned short orig_frp_segs;   /* number of segments allocated at first try */
55         unsigned short frp_segs;        /* number of buffer segments */
56         unsigned int frp_sg_current;    /* driver buffer length currently in s/g list */
57         struct st_buf_fragment *frp;    /* the allocated buffer fragment list */
58         struct scatterlist sg[1];       /* MUST BE last item */
59 };
60
61 /* The tape buffer fragment descriptor */
62 struct st_buf_fragment {
63         struct page *page;
64         unsigned int length;
65 };
66
67 /* The tape mode definition */
68 struct st_modedef {
69         unsigned char defined;
70         unsigned char sysv;     /* SYS V semantics? */
71         unsigned char do_async_writes;
72         unsigned char do_buffer_writes;
73         unsigned char do_read_ahead;
74         unsigned char defaults_for_writes;
75         unsigned char default_compression;      /* 0 = don't touch, etc */
76         short default_density;  /* Forced density, -1 = no value */
77         int default_blksize;    /* Forced blocksize, -1 = no value */
78         struct cdev *cdevs[2];  /* Auto-rewind and non-rewind devices */
79 };
80
81 /* Number of modes can be changed by changing ST_NBR_MODE_BITS. The maximum
82    number of modes is 16 (ST_NBR_MODE_BITS 4) */
83 #define ST_NBR_MODE_BITS 2
84 #define ST_NBR_MODES (1 << ST_NBR_MODE_BITS)
85 #define ST_MODE_SHIFT (7 - ST_NBR_MODE_BITS)
86 #define ST_MODE_MASK ((ST_NBR_MODES - 1) << ST_MODE_SHIFT)
87
88 #define ST_MAX_TAPES 128
89 #define ST_MAX_TAPE_ENTRIES  (ST_MAX_TAPES << (ST_NBR_MODE_BITS + 1))
90
91 /* The status related to each partition */
92 struct st_partstat {
93         unsigned char rw;
94         unsigned char eof;
95         unsigned char at_sm;
96         unsigned char last_block_valid;
97         u32 last_block_visited;
98         int drv_block;          /* The block where the drive head is */
99         int drv_file;
100 };
101
102 #define ST_NBR_PARTITIONS 4
103
104 /* The tape drive descriptor */
105 struct scsi_tape {
106         struct scsi_driver *driver;
107         struct scsi_device *device;
108         struct mutex lock;      /* For serialization */
109         struct completion wait; /* For SCSI commands */
110         struct st_buffer *buffer;
111
112         /* Drive characteristics */
113         unsigned char omit_blklims;
114         unsigned char do_auto_lock;
115         unsigned char can_bsr;
116         unsigned char can_partitions;
117         unsigned char two_fm;
118         unsigned char fast_mteom;
119         unsigned char immediate;
120         unsigned char restr_dma;
121         unsigned char scsi2_logical;
122         unsigned char default_drvbuffer;        /* 0xff = don't touch, value 3 bits */
123         unsigned char cln_mode;                 /* 0 = none, otherwise sense byte nbr */
124         unsigned char cln_sense_value;
125         unsigned char cln_sense_mask;
126         unsigned char use_pf;                   /* Set Page Format bit in all mode selects? */
127         unsigned char try_dio;                  /* try direct i/o in general? */
128         unsigned char try_dio_now;              /* try direct i/o before next close? */
129         unsigned char c_algo;                   /* compression algorithm */
130         unsigned char pos_unknown;                      /* after reset position unknown */
131         unsigned char sili;                     /* use SILI when reading in variable b mode */
132         int tape_type;
133         int long_timeout;       /* timeout for commands known to take long time */
134
135         unsigned long max_pfn;  /* the maximum page number reachable by the HBA */
136
137         /* Mode characteristics */
138         struct st_modedef modes[ST_NBR_MODES];
139         int current_mode;
140
141         /* Status variables */
142         int partition;
143         int new_partition;
144         int nbr_partitions;     /* zero until partition support enabled */
145         struct st_partstat ps[ST_NBR_PARTITIONS];
146         unsigned char dirty;
147         unsigned char ready;
148         unsigned char write_prot;
149         unsigned char drv_write_prot;
150         unsigned char in_use;
151         unsigned char blksize_changed;
152         unsigned char density_changed;
153         unsigned char compression_changed;
154         unsigned char drv_buffer;
155         unsigned char density;
156         unsigned char door_locked;
157         unsigned char autorew_dev;   /* auto-rewind device */
158         unsigned char rew_at_close;  /* rewind necessary at close */
159         unsigned char inited;
160         unsigned char cleaning_req;  /* cleaning requested? */
161         int block_size;
162         int min_block;
163         int max_block;
164         int recover_count;     /* From tape opening */
165         int recover_reg;       /* From last status call */
166
167 #if DEBUG
168         unsigned char write_pending;
169         int nbr_finished;
170         int nbr_waits;
171         int nbr_requests;
172         int nbr_dio;
173         int nbr_pages;
174         unsigned char last_cmnd[6];
175         unsigned char last_sense[16];
176 #endif
177         struct gendisk *disk;
178         struct kref     kref;
179 };
180
181 /* Bit masks for use_pf */
182 #define USE_PF      1
183 #define PF_TESTED   2
184
185 /* Values of eof */
186 #define ST_NOEOF        0
187 #define ST_FM_HIT       1
188 #define ST_FM           2
189 #define ST_EOM_OK       3
190 #define ST_EOM_ERROR    4
191 #define ST_EOD_1        5
192 #define ST_EOD_2        6
193 #define ST_EOD          7
194 /* EOD hit while reading => ST_EOD_1 => return zero => ST_EOD_2 =>
195    return zero => ST_EOD, return ENOSPC */
196 /* When writing: ST_EOM_OK == early warning found, write OK
197                  ST_EOD_1  == allow trying new write after early warning
198                  ST_EOM_ERROR == early warning found, not able to write all */
199
200 /* Values of rw */
201 #define ST_IDLE         0
202 #define ST_READING      1
203 #define ST_WRITING      2
204
205 /* Values of ready state */
206 #define ST_READY        0
207 #define ST_NOT_READY    1
208 #define ST_NO_TAPE      2
209
210 /* Values for door lock state */
211 #define ST_UNLOCKED     0
212 #define ST_LOCKED_EXPLICIT 1
213 #define ST_LOCKED_AUTO  2
214 #define ST_LOCK_FAILS   3
215
216 /* Positioning SCSI-commands for Tandberg, etc. drives */
217 #define QFA_REQUEST_BLOCK       0x02
218 #define QFA_SEEK_BLOCK          0x0c
219
220 /* Setting the binary options */
221 #define ST_DONT_TOUCH  0
222 #define ST_NO          1
223 #define ST_YES         2
224
225 #define EXTENDED_SENSE_START  18
226
227 /* Masks for some conditions in the sense data */
228 #define SENSE_FMK   0x80
229 #define SENSE_EOM   0x40
230 #define SENSE_ILI   0x20
231
232 #endif