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