ftp://ftp.kernel.org/pub/linux/kernel/v2.6/linux-2.6.6.tar.bz2
[linux-2.6.git] / drivers / scsi / st.h
1
2 #ifndef _ST_H
3 #define _ST_H
4
5 #ifndef _SCSI_H
6 #include "scsi.h"
7 #endif
8 #include <linux/completion.h>
9
10 /* The tape buffer descriptor. */
11 typedef struct {
12         unsigned char in_use;
13         unsigned char dma;      /* DMA-able buffer */
14         unsigned char do_dio;   /* direct i/o set up? */
15         int buffer_size;
16         int buffer_blocks;
17         int buffer_bytes;
18         int read_pointer;
19         int writing;
20         int midlevel_result;
21         int syscall_result;
22         Scsi_Request *last_SRpnt;
23         unsigned char *b_data;
24         unsigned short use_sg;  /* zero or max number of s/g segments for this adapter */
25         unsigned short sg_segs;         /* number of segments in s/g list */
26         unsigned short orig_frp_segs;   /* number of segments allocated at first try */
27         unsigned short frp_segs;        /* number of buffer segments */
28         unsigned int frp_sg_current;    /* driver buffer length currently in s/g list */
29         struct st_buf_fragment *frp;    /* the allocated buffer fragment list */
30         struct scatterlist sg[1];       /* MUST BE last item */
31 } ST_buffer;
32
33 /* The tape buffer fragment descriptor */
34 struct st_buf_fragment {
35         struct page *page;
36         unsigned int length;
37 };
38
39 /* The tape mode definition */
40 typedef struct {
41         unsigned char defined;
42         unsigned char sysv;     /* SYS V semantics? */
43         unsigned char do_async_writes;
44         unsigned char do_buffer_writes;
45         unsigned char do_read_ahead;
46         unsigned char defaults_for_writes;
47         unsigned char default_compression;      /* 0 = don't touch, etc */
48         short default_density;  /* Forced density, -1 = no value */
49         int default_blksize;    /* Forced blocksize, -1 = no value */
50         struct cdev *cdevs[2];  /* Auto-rewind and non-rewind devices */
51 } ST_mode;
52
53 /* Number of modes can be changed by changing ST_NBR_MODE_BITS. The maximum
54    number of modes is 16 (ST_NBR_MODE_BITS 4) */
55 #define ST_NBR_MODE_BITS 2
56 #define ST_NBR_MODES (1 << ST_NBR_MODE_BITS)
57 #define ST_MODE_SHIFT (7 - ST_NBR_MODE_BITS)
58 #define ST_MODE_MASK ((ST_NBR_MODES - 1) << ST_MODE_SHIFT)
59
60 #define ST_MAX_TAPES 128
61 #define ST_MAX_TAPE_ENTRIES  (ST_MAX_TAPES << (ST_NBR_MODE_BITS + 1))
62
63 /* The status related to each partition */
64 typedef struct {
65         unsigned char rw;
66         unsigned char eof;
67         unsigned char at_sm;
68         unsigned char last_block_valid;
69         u32 last_block_visited;
70         int drv_block;          /* The block where the drive head is */
71         int drv_file;
72 } ST_partstat;
73
74 #define ST_NBR_PARTITIONS 4
75
76 /* The tape drive descriptor */
77 typedef struct {
78         struct scsi_driver *driver;
79         Scsi_Device *device;
80         struct semaphore lock;  /* For serialization */
81         struct completion wait; /* For SCSI commands */
82         ST_buffer *buffer;
83
84         /* Drive characteristics */
85         unsigned char omit_blklims;
86         unsigned char do_auto_lock;
87         unsigned char can_bsr;
88         unsigned char can_partitions;
89         unsigned char two_fm;
90         unsigned char fast_mteom;
91         unsigned char immediate;
92         unsigned char restr_dma;
93         unsigned char scsi2_logical;
94         unsigned char default_drvbuffer;        /* 0xff = don't touch, value 3 bits */
95         unsigned char cln_mode;                 /* 0 = none, otherwise sense byte nbr */
96         unsigned char cln_sense_value;
97         unsigned char cln_sense_mask;
98         unsigned char use_pf;                   /* Set Page Format bit in all mode selects? */
99         unsigned char try_dio;                  /* try direct i/o? */
100         unsigned char c_algo;                   /* compression algorithm */
101         unsigned char pos_unknown;                      /* after reset position unknown */
102         int tape_type;
103         int timeout;            /* timeout for normal commands */
104         int long_timeout;       /* timeout for commands known to take long time */
105
106         unsigned long max_pfn;  /* the maximum page number reachable by the HBA */
107
108         /* Mode characteristics */
109         ST_mode modes[ST_NBR_MODES];
110         int current_mode;
111
112         /* Status variables */
113         int partition;
114         int new_partition;
115         int nbr_partitions;     /* zero until partition support enabled */
116         ST_partstat ps[ST_NBR_PARTITIONS];
117         unsigned char dirty;
118         unsigned char ready;
119         unsigned char write_prot;
120         unsigned char drv_write_prot;
121         unsigned char in_use;
122         unsigned char blksize_changed;
123         unsigned char density_changed;
124         unsigned char compression_changed;
125         unsigned char drv_buffer;
126         unsigned char density;
127         unsigned char door_locked;
128         unsigned char autorew_dev;   /* auto-rewind device */
129         unsigned char rew_at_close;  /* rewind necessary at close */
130         unsigned char inited;
131         unsigned char cleaning_req;  /* cleaning requested? */
132         int block_size;
133         int min_block;
134         int max_block;
135         int recover_count;     /* From tape opening */
136         int recover_reg;       /* From last status call */
137
138 #if DEBUG
139         unsigned char write_pending;
140         int nbr_finished;
141         int nbr_waits;
142         int nbr_requests;
143         int nbr_dio;
144         int nbr_pages;
145         int nbr_combinable;
146         unsigned char last_cmnd[6];
147         unsigned char last_sense[16];
148 #endif
149         struct gendisk *disk;
150 } Scsi_Tape;
151
152 /* Bit masks for use_pf */
153 #define USE_PF      1
154 #define PF_TESTED   2
155
156 /* Values of eof */
157 #define ST_NOEOF        0
158 #define ST_FM_HIT       1
159 #define ST_FM           2
160 #define ST_EOM_OK       3
161 #define ST_EOM_ERROR    4
162 #define ST_EOD_1        5
163 #define ST_EOD_2        6
164 #define ST_EOD          7
165 /* EOD hit while reading => ST_EOD_1 => return zero => ST_EOD_2 =>
166    return zero => ST_EOD, return ENOSPC */
167 /* When writing: ST_EOM_OK == early warning found, write OK
168                  ST_EOD_1  == allow trying new write after early warning
169                  ST_EOM_ERROR == early warning found, not able to write all */
170
171 /* Values of rw */
172 #define ST_IDLE         0
173 #define ST_READING      1
174 #define ST_WRITING      2
175
176 /* Values of ready state */
177 #define ST_READY        0
178 #define ST_NOT_READY    1
179 #define ST_NO_TAPE      2
180
181 /* Values for door lock state */
182 #define ST_UNLOCKED     0
183 #define ST_LOCKED_EXPLICIT 1
184 #define ST_LOCKED_AUTO  2
185 #define ST_LOCK_FAILS   3
186
187 /* Positioning SCSI-commands for Tandberg, etc. drives */
188 #define QFA_REQUEST_BLOCK       0x02
189 #define QFA_SEEK_BLOCK          0x0c
190
191 /* Setting the binary options */
192 #define ST_DONT_TOUCH  0
193 #define ST_NO          1
194 #define ST_YES         2
195
196 #define EXTENDED_SENSE_START  18
197
198 #endif