Merge tag 'sound-3.19-rc4' of git://git.kernel.org/pub/scm/linux/kernel/git/tiwai...
[pandora-kernel.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 cleared;  /* internal buffer cleared after open? */
39         unsigned short do_dio;  /* direct i/o set up? */
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         int reserved_page_order;
50         struct page **mapped_pages;
51         struct rq_map_data map_data;
52         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 */
55         unsigned short frp_segs;        /* number of buffer segments */
56 };
57
58 /* The tape mode definition */
59 struct 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 */
69         struct scsi_tape *tape;
70         struct device *devs[2];  /* Auto-rewind and non-rewind devices */
71         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
81 #define ST_MAX_TAPES (1 << (20 - (ST_NBR_MODE_BITS + 1)))
82 #define ST_MAX_TAPE_ENTRIES  (ST_MAX_TAPES << (ST_NBR_MODE_BITS + 1))
83
84 /* The status related to each partition */
85 struct 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
95 #define ST_NBR_PARTITIONS 4
96
97 /* The tape drive descriptor */
98 struct scsi_tape {
99         struct scsi_driver *driver;
100         struct scsi_device *device;
101         struct mutex lock;      /* For serialization */
102         struct completion wait; /* For SCSI commands */
103         struct st_buffer *buffer;
104         int index;
105
106         /* Drive characteristics */
107         unsigned char omit_blklims;
108         unsigned char do_auto_lock;
109         unsigned char can_bsr;
110         unsigned char can_partitions;
111         unsigned char two_fm;
112         unsigned char fast_mteom;
113         unsigned char immediate;
114         unsigned char restr_dma;
115         unsigned char scsi2_logical;
116         unsigned char default_drvbuffer;        /* 0xff = don't touch, value 3 bits */
117         unsigned char cln_mode;                 /* 0 = none, otherwise sense byte nbr */
118         unsigned char cln_sense_value;
119         unsigned char cln_sense_mask;
120         unsigned char use_pf;                   /* Set Page Format bit in all mode selects? */
121         unsigned char try_dio;                  /* try direct i/o in general? */
122         unsigned char try_dio_now;              /* try direct i/o before next close? */
123         unsigned char c_algo;                   /* compression algorithm */
124         unsigned char pos_unknown;                      /* after reset position unknown */
125         unsigned char sili;                     /* use SILI when reading in variable b mode */
126         unsigned char immediate_filemark;       /* write filemark immediately */
127         int tape_type;
128         int long_timeout;       /* timeout for commands known to take long time */
129
130         unsigned long max_pfn;  /* the maximum page number reachable by the HBA */
131
132         /* Mode characteristics */
133         struct st_modedef modes[ST_NBR_MODES];
134         int current_mode;
135
136         /* Status variables */
137         int partition;
138         int new_partition;
139         int nbr_partitions;     /* zero until partition support enabled */
140         struct st_partstat ps[ST_NBR_PARTITIONS];
141         unsigned char dirty;
142         unsigned char ready;
143         unsigned char write_prot;
144         unsigned char drv_write_prot;
145         unsigned char in_use;
146         unsigned char blksize_changed;
147         unsigned char density_changed;
148         unsigned char compression_changed;
149         unsigned char drv_buffer;
150         unsigned char density;
151         unsigned char door_locked;
152         unsigned char autorew_dev;   /* auto-rewind device */
153         unsigned char rew_at_close;  /* rewind necessary at close */
154         unsigned char inited;
155         unsigned char cleaning_req;  /* cleaning requested? */
156         int block_size;
157         int min_block;
158         int max_block;
159         int recover_count;     /* From tape opening */
160         int recover_reg;       /* From last status call */
161
162 #if DEBUG
163         unsigned char write_pending;
164         int nbr_finished;
165         int nbr_waits;
166         int nbr_requests;
167         int nbr_dio;
168         int nbr_pages;
169         unsigned char last_cmnd[6];
170         unsigned char last_sense[16];
171 #endif
172         struct gendisk *disk;
173         struct kref     kref;
174 };
175
176 /* Bit masks for use_pf */
177 #define USE_PF      1
178 #define PF_TESTED   2
179
180 /* Values of eof */
181 #define ST_NOEOF        0
182 #define ST_FM_HIT       1
183 #define ST_FM           2
184 #define ST_EOM_OK       3
185 #define ST_EOM_ERROR    4
186 #define ST_EOD_1        5
187 #define ST_EOD_2        6
188 #define ST_EOD          7
189 /* EOD hit while reading => ST_EOD_1 => return zero => ST_EOD_2 =>
190    return zero => ST_EOD, return ENOSPC */
191 /* When writing: ST_EOM_OK == early warning found, write OK
192                  ST_EOD_1  == allow trying new write after early warning
193                  ST_EOM_ERROR == early warning found, not able to write all */
194
195 /* Values of rw */
196 #define ST_IDLE         0
197 #define ST_READING      1
198 #define ST_WRITING      2
199
200 /* Values of ready state */
201 #define ST_READY        0
202 #define ST_NOT_READY    1
203 #define ST_NO_TAPE      2
204
205 /* Values for door lock state */
206 #define ST_UNLOCKED     0
207 #define ST_LOCKED_EXPLICIT 1
208 #define ST_LOCKED_AUTO  2
209 #define ST_LOCK_FAILS   3
210
211 /* Positioning SCSI-commands for Tandberg, etc. drives */
212 #define QFA_REQUEST_BLOCK       0x02
213 #define QFA_SEEK_BLOCK          0x0c
214
215 /* Setting the binary options */
216 #define ST_DONT_TOUCH  0
217 #define ST_NO          1
218 #define ST_YES         2
219
220 #define EXTENDED_SENSE_START  18
221
222 /* Masks for some conditions in the sense data */
223 #define SENSE_FMK   0x80
224 #define SENSE_EOM   0x40
225 #define SENSE_ILI   0x20
226
227 #endif