]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * linux/mtio.h header file for Linux. Written by H. Bergman | |
3 | * | |
4 | * Modified for special ioctls provided by zftape in September 1997 | |
5 | * by C.-J. Heine. | |
6 | */ | |
7 | ||
8 | #ifndef _LINUX_MTIO_H | |
9 | #define _LINUX_MTIO_H | |
10 | ||
11 | #include <linux/types.h> | |
12 | #include <linux/ioctl.h> | |
13 | #include <linux/qic117.h> | |
14 | ||
15 | /* | |
16 | * Structures and definitions for mag tape io control commands | |
17 | */ | |
18 | ||
19 | /* structure for MTIOCTOP - mag tape op command */ | |
20 | struct mtop { | |
21 | short mt_op; /* operations defined below */ | |
22 | int mt_count; /* how many of them */ | |
23 | }; | |
24 | ||
25 | /* Magnetic Tape operations [Not all operations supported by all drivers]: */ | |
26 | #define MTRESET 0 /* +reset drive in case of problems */ | |
27 | #define MTFSF 1 /* forward space over FileMark, | |
28 | * position at first record of next file | |
29 | */ | |
30 | #define MTBSF 2 /* backward space FileMark (position before FM) */ | |
31 | #define MTFSR 3 /* forward space record */ | |
32 | #define MTBSR 4 /* backward space record */ | |
33 | #define MTWEOF 5 /* write an end-of-file record (mark) */ | |
34 | #define MTREW 6 /* rewind */ | |
35 | #define MTOFFL 7 /* rewind and put the drive offline (eject?) */ | |
36 | #define MTNOP 8 /* no op, set status only (read with MTIOCGET) */ | |
37 | #define MTRETEN 9 /* retension tape */ | |
38 | #define MTBSFM 10 /* +backward space FileMark, position at FM */ | |
39 | #define MTFSFM 11 /* +forward space FileMark, position at FM */ | |
40 | #define MTEOM 12 /* goto end of recorded media (for appending files). | |
41 | * MTEOM positions after the last FM, ready for | |
42 | * appending another file. | |
43 | */ | |
44 | #define MTERASE 13 /* erase tape -- be careful! */ | |
45 | ||
46 | #define MTRAS1 14 /* run self test 1 (nondestructive) */ | |
47 | #define MTRAS2 15 /* run self test 2 (destructive) */ | |
48 | #define MTRAS3 16 /* reserved for self test 3 */ | |
49 | ||
50 | #define MTSETBLK 20 /* set block length (SCSI) */ | |
51 | #define MTSETDENSITY 21 /* set tape density (SCSI) */ | |
52 | #define MTSEEK 22 /* seek to block (Tandberg, etc.) */ | |
53 | #define MTTELL 23 /* tell block (Tandberg, etc.) */ | |
54 | #define MTSETDRVBUFFER 24 /* set the drive buffering according to SCSI-2 */ | |
55 | /* ordinary buffered operation with code 1 */ | |
56 | #define MTFSS 25 /* space forward over setmarks */ | |
57 | #define MTBSS 26 /* space backward over setmarks */ | |
58 | #define MTWSM 27 /* write setmarks */ | |
59 | ||
60 | #define MTLOCK 28 /* lock the drive door */ | |
61 | #define MTUNLOCK 29 /* unlock the drive door */ | |
62 | #define MTLOAD 30 /* execute the SCSI load command */ | |
63 | #define MTUNLOAD 31 /* execute the SCSI unload command */ | |
64 | #define MTCOMPRESSION 32/* control compression with SCSI mode page 15 */ | |
65 | #define MTSETPART 33 /* Change the active tape partition */ | |
66 | #define MTMKPART 34 /* Format the tape with one or two partitions */ | |
67 | ||
68 | /* structure for MTIOCGET - mag tape get status command */ | |
69 | ||
70 | struct mtget { | |
71 | long mt_type; /* type of magtape device */ | |
72 | long mt_resid; /* residual count: (not sure) | |
73 | * number of bytes ignored, or | |
74 | * number of files not skipped, or | |
75 | * number of records not skipped. | |
76 | */ | |
77 | /* the following registers are device dependent */ | |
78 | long mt_dsreg; /* status register */ | |
79 | long mt_gstat; /* generic (device independent) status */ | |
80 | long mt_erreg; /* error register */ | |
81 | /* The next two fields are not always used */ | |
82 | __kernel_daddr_t mt_fileno; /* number of current file on tape */ | |
83 | __kernel_daddr_t mt_blkno; /* current block number */ | |
84 | }; | |
85 | ||
86 | ||
87 | ||
88 | /* | |
89 | * Constants for mt_type. Not all of these are supported, | |
90 | * and these are not all of the ones that are supported. | |
91 | */ | |
92 | #define MT_ISUNKNOWN 0x01 | |
93 | #define MT_ISQIC02 0x02 /* Generic QIC-02 tape streamer */ | |
94 | #define MT_ISWT5150 0x03 /* Wangtek 5150EQ, QIC-150, QIC-02 */ | |
95 | #define MT_ISARCHIVE_5945L2 0x04 /* Archive 5945L-2, QIC-24, QIC-02? */ | |
96 | #define MT_ISCMSJ500 0x05 /* CMS Jumbo 500 (QIC-02?) */ | |
97 | #define MT_ISTDC3610 0x06 /* Tandberg 6310, QIC-24 */ | |
98 | #define MT_ISARCHIVE_VP60I 0x07 /* Archive VP60i, QIC-02 */ | |
99 | #define MT_ISARCHIVE_2150L 0x08 /* Archive Viper 2150L */ | |
100 | #define MT_ISARCHIVE_2060L 0x09 /* Archive Viper 2060L */ | |
101 | #define MT_ISARCHIVESC499 0x0A /* Archive SC-499 QIC-36 controller */ | |
102 | #define MT_ISQIC02_ALL_FEATURES 0x0F /* Generic QIC-02 with all features */ | |
103 | #define MT_ISWT5099EEN24 0x11 /* Wangtek 5099-een24, 60MB, QIC-24 */ | |
104 | #define MT_ISTEAC_MT2ST 0x12 /* Teac MT-2ST 155mb drive, Teac DC-1 card (Wangtek type) */ | |
105 | #define MT_ISEVEREX_FT40A 0x32 /* Everex FT40A (QIC-40) */ | |
106 | #define MT_ISDDS1 0x51 /* DDS device without partitions */ | |
107 | #define MT_ISDDS2 0x52 /* DDS device with partitions */ | |
108 | #define MT_ISONSTREAM_SC 0x61 /* OnStream SCSI tape drives (SC-x0) | |
109 | and SCSI emulated (DI, DP, USB) */ | |
110 | #define MT_ISSCSI1 0x71 /* Generic ANSI SCSI-1 tape unit */ | |
111 | #define MT_ISSCSI2 0x72 /* Generic ANSI SCSI-2 tape unit */ | |
112 | ||
113 | /* QIC-40/80/3010/3020 ftape supported drives. | |
114 | * 20bit vendor ID + 0x800000 (see ftape-vendors.h) | |
115 | */ | |
116 | #define MT_ISFTAPE_UNKNOWN 0x800000 /* obsolete */ | |
117 | #define MT_ISFTAPE_FLAG 0x800000 | |
118 | ||
119 | struct mt_tape_info { | |
120 | long t_type; /* device type id (mt_type) */ | |
121 | char *t_name; /* descriptive name */ | |
122 | }; | |
123 | ||
124 | #define MT_TAPE_INFO { \ | |
125 | {MT_ISUNKNOWN, "Unknown type of tape device"}, \ | |
126 | {MT_ISQIC02, "Generic QIC-02 tape streamer"}, \ | |
127 | {MT_ISWT5150, "Wangtek 5150, QIC-150"}, \ | |
128 | {MT_ISARCHIVE_5945L2, "Archive 5945L-2"}, \ | |
129 | {MT_ISCMSJ500, "CMS Jumbo 500"}, \ | |
130 | {MT_ISTDC3610, "Tandberg TDC 3610, QIC-24"}, \ | |
131 | {MT_ISARCHIVE_VP60I, "Archive VP60i, QIC-02"}, \ | |
132 | {MT_ISARCHIVE_2150L, "Archive Viper 2150L"}, \ | |
133 | {MT_ISARCHIVE_2060L, "Archive Viper 2060L"}, \ | |
134 | {MT_ISARCHIVESC499, "Archive SC-499 QIC-36 controller"}, \ | |
135 | {MT_ISQIC02_ALL_FEATURES, "Generic QIC-02 tape, all features"}, \ | |
136 | {MT_ISWT5099EEN24, "Wangtek 5099-een24, 60MB"}, \ | |
137 | {MT_ISTEAC_MT2ST, "Teac MT-2ST 155mb data cassette drive"}, \ | |
138 | {MT_ISEVEREX_FT40A, "Everex FT40A, QIC-40"}, \ | |
139 | {MT_ISONSTREAM_SC, "OnStream SC-, DI-, DP-, or USB tape drive"}, \ | |
140 | {MT_ISSCSI1, "Generic SCSI-1 tape"}, \ | |
141 | {MT_ISSCSI2, "Generic SCSI-2 tape"}, \ | |
142 | {0, NULL} \ | |
143 | } | |
144 | ||
145 | ||
146 | /* structure for MTIOCPOS - mag tape get position command */ | |
147 | ||
148 | struct mtpos { | |
149 | long mt_blkno; /* current block number */ | |
150 | }; | |
151 | ||
152 | ||
153 | /* structure for MTIOCVOLINFO, query information about the volume | |
154 | * currently positioned at (zftape) | |
155 | */ | |
156 | struct mtvolinfo { | |
157 | unsigned int mt_volno; /* vol-number */ | |
158 | unsigned int mt_blksz; /* blocksize used when recording */ | |
159 | unsigned int mt_rawsize; /* raw tape space consumed, in kb */ | |
160 | unsigned int mt_size; /* volume size after decompression, in kb */ | |
161 | unsigned int mt_cmpr:1; /* this volume has been compressed */ | |
162 | }; | |
163 | ||
164 | /* raw access to a floppy drive, read and write an arbitrary segment. | |
165 | * For ftape/zftape to support formatting etc. | |
166 | */ | |
167 | #define MT_FT_RD_SINGLE 0 | |
168 | #define MT_FT_RD_AHEAD 1 | |
169 | #define MT_FT_WR_ASYNC 0 /* start tape only when all buffers are full */ | |
170 | #define MT_FT_WR_MULTI 1 /* start tape, continue until buffers are empty */ | |
171 | #define MT_FT_WR_SINGLE 2 /* write a single segment and stop afterwards */ | |
172 | #define MT_FT_WR_DELETE 3 /* write deleted data marks, one segment at time */ | |
173 | ||
174 | struct mtftseg | |
175 | { | |
176 | unsigned mt_segno; /* the segment to read or write */ | |
177 | unsigned mt_mode; /* modes for read/write (sync/async etc.) */ | |
178 | int mt_result; /* result of r/w request, not of the ioctl */ | |
179 | void __user *mt_data; /* User space buffer: must be 29kb */ | |
180 | }; | |
181 | ||
182 | /* get tape capacity (ftape/zftape) | |
183 | */ | |
184 | struct mttapesize { | |
185 | unsigned long mt_capacity; /* entire, uncompressed capacity | |
186 | * of a cartridge | |
187 | */ | |
188 | unsigned long mt_used; /* what has been used so far, raw | |
189 | * uncompressed amount | |
190 | */ | |
191 | }; | |
192 | ||
193 | /* possible values of the ftfmt_op field | |
194 | */ | |
195 | #define FTFMT_SET_PARMS 1 /* set software parms */ | |
196 | #define FTFMT_GET_PARMS 2 /* get software parms */ | |
197 | #define FTFMT_FORMAT_TRACK 3 /* start formatting a tape track */ | |
198 | #define FTFMT_STATUS 4 /* monitor formatting a tape track */ | |
199 | #define FTFMT_VERIFY 5 /* verify the given segment */ | |
200 | ||
201 | struct ftfmtparms { | |
202 | unsigned char ft_qicstd; /* QIC-40/QIC-80/QIC-3010/QIC-3020 */ | |
203 | unsigned char ft_fmtcode; /* Refer to the QIC specs */ | |
204 | unsigned char ft_fhm; /* floppy head max */ | |
205 | unsigned char ft_ftm; /* floppy track max */ | |
206 | unsigned short ft_spt; /* segments per track */ | |
207 | unsigned short ft_tpc; /* tracks per cartridge */ | |
208 | }; | |
209 | ||
210 | struct ftfmttrack { | |
211 | unsigned int ft_track; /* track to format */ | |
212 | unsigned char ft_gap3; /* size of gap3, for FORMAT_TRK */ | |
213 | }; | |
214 | ||
215 | struct ftfmtstatus { | |
216 | unsigned int ft_segment; /* segment currently being formatted */ | |
217 | }; | |
218 | ||
219 | struct ftfmtverify { | |
220 | unsigned int ft_segment; /* segment to verify */ | |
221 | unsigned long ft_bsm; /* bsm as result of VERIFY cmd */ | |
222 | }; | |
223 | ||
224 | struct mtftformat { | |
225 | unsigned int fmt_op; /* operation to perform */ | |
226 | union fmt_arg { | |
227 | struct ftfmtparms fmt_parms; /* format parameters */ | |
228 | struct ftfmttrack fmt_track; /* ctrl while formatting */ | |
229 | struct ftfmtstatus fmt_status; | |
230 | struct ftfmtverify fmt_verify; /* for verifying */ | |
231 | } fmt_arg; | |
232 | }; | |
233 | ||
234 | struct mtftcmd { | |
235 | unsigned int ft_wait_before; /* timeout to wait for drive to get ready | |
236 | * before command is sent. Milliseconds | |
237 | */ | |
238 | qic117_cmd_t ft_cmd; /* command to send */ | |
239 | unsigned char ft_parm_cnt; /* zero: no parm is sent. */ | |
240 | unsigned char ft_parms[3]; /* parameter(s) to send to | |
241 | * the drive. The parms are nibbles | |
242 | * driver sends cmd + 2 step pulses */ | |
243 | unsigned int ft_result_bits; /* if non zero, number of bits | |
244 | * returned by the tape drive | |
245 | */ | |
246 | unsigned int ft_result; /* the result returned by the tape drive*/ | |
247 | unsigned int ft_wait_after; /* timeout to wait for drive to get ready | |
248 | * after command is sent. 0: don't wait */ | |
249 | int ft_status; /* status returned by ready wait | |
250 | * undefined if timeout was 0. | |
251 | */ | |
252 | int ft_error; /* error code if error status was set by | |
253 | * command | |
254 | */ | |
255 | }; | |
256 | ||
257 | /* mag tape io control commands */ | |
258 | #define MTIOCTOP _IOW('m', 1, struct mtop) /* do a mag tape op */ | |
259 | #define MTIOCGET _IOR('m', 2, struct mtget) /* get tape status */ | |
260 | #define MTIOCPOS _IOR('m', 3, struct mtpos) /* get tape position */ | |
261 | ||
262 | /* The next two are used by the QIC-02 driver for runtime reconfiguration. | |
263 | * See tpqic02.h for struct mtconfiginfo. | |
264 | */ | |
265 | #define MTIOCGETCONFIG _IOR('m', 4, struct mtconfiginfo) /* get tape config */ | |
266 | #define MTIOCSETCONFIG _IOW('m', 5, struct mtconfiginfo) /* set tape config */ | |
267 | ||
268 | /* the next six are used by the floppy ftape drivers and its frontends | |
269 | * sorry, but MTIOCTOP commands are write only. | |
270 | */ | |
271 | #define MTIOCRDFTSEG _IOWR('m', 6, struct mtftseg) /* read a segment */ | |
272 | #define MTIOCWRFTSEG _IOWR('m', 7, struct mtftseg) /* write a segment */ | |
273 | #define MTIOCVOLINFO _IOR('m', 8, struct mtvolinfo) /* info about volume */ | |
274 | #define MTIOCGETSIZE _IOR('m', 9, struct mttapesize)/* get cartridge size*/ | |
275 | #define MTIOCFTFORMAT _IOWR('m', 10, struct mtftformat) /* format ftape */ | |
276 | #define MTIOCFTCMD _IOWR('m', 11, struct mtftcmd) /* send QIC-117 cmd */ | |
277 | ||
278 | /* Generic Mag Tape (device independent) status macros for examining | |
279 | * mt_gstat -- HP-UX compatible. | |
280 | * There is room for more generic status bits here, but I don't | |
281 | * know which of them are reserved. At least three or so should | |
282 | * be added to make this really useful. | |
283 | */ | |
284 | #define GMT_EOF(x) ((x) & 0x80000000) | |
285 | #define GMT_BOT(x) ((x) & 0x40000000) | |
286 | #define GMT_EOT(x) ((x) & 0x20000000) | |
287 | #define GMT_SM(x) ((x) & 0x10000000) /* DDS setmark */ | |
288 | #define GMT_EOD(x) ((x) & 0x08000000) /* DDS EOD */ | |
289 | #define GMT_WR_PROT(x) ((x) & 0x04000000) | |
290 | /* #define GMT_ ? ((x) & 0x02000000) */ | |
291 | #define GMT_ONLINE(x) ((x) & 0x01000000) | |
292 | #define GMT_D_6250(x) ((x) & 0x00800000) | |
293 | #define GMT_D_1600(x) ((x) & 0x00400000) | |
294 | #define GMT_D_800(x) ((x) & 0x00200000) | |
295 | /* #define GMT_ ? ((x) & 0x00100000) */ | |
296 | /* #define GMT_ ? ((x) & 0x00080000) */ | |
297 | #define GMT_DR_OPEN(x) ((x) & 0x00040000) /* door open (no tape) */ | |
298 | /* #define GMT_ ? ((x) & 0x00020000) */ | |
299 | #define GMT_IM_REP_EN(x) ((x) & 0x00010000) /* immediate report mode */ | |
300 | #define GMT_CLN(x) ((x) & 0x00008000) /* cleaning requested */ | |
301 | /* 15 generic status bits unused */ | |
302 | ||
303 | ||
304 | /* SCSI-tape specific definitions */ | |
305 | /* Bitfield shifts in the status */ | |
306 | #define MT_ST_BLKSIZE_SHIFT 0 | |
307 | #define MT_ST_BLKSIZE_MASK 0xffffff | |
308 | #define MT_ST_DENSITY_SHIFT 24 | |
309 | #define MT_ST_DENSITY_MASK 0xff000000 | |
310 | ||
311 | #define MT_ST_SOFTERR_SHIFT 0 | |
312 | #define MT_ST_SOFTERR_MASK 0xffff | |
313 | ||
314 | /* Bitfields for the MTSETDRVBUFFER ioctl */ | |
315 | #define MT_ST_OPTIONS 0xf0000000 | |
316 | #define MT_ST_BOOLEANS 0x10000000 | |
317 | #define MT_ST_SETBOOLEANS 0x30000000 | |
318 | #define MT_ST_CLEARBOOLEANS 0x40000000 | |
319 | #define MT_ST_WRITE_THRESHOLD 0x20000000 | |
320 | #define MT_ST_DEF_BLKSIZE 0x50000000 | |
321 | #define MT_ST_DEF_OPTIONS 0x60000000 | |
322 | #define MT_ST_TIMEOUTS 0x70000000 | |
323 | #define MT_ST_SET_TIMEOUT (MT_ST_TIMEOUTS | 0x000000) | |
324 | #define MT_ST_SET_LONG_TIMEOUT (MT_ST_TIMEOUTS | 0x100000) | |
325 | #define MT_ST_SET_CLN 0x80000000 | |
326 | ||
327 | #define MT_ST_BUFFER_WRITES 0x1 | |
328 | #define MT_ST_ASYNC_WRITES 0x2 | |
329 | #define MT_ST_READ_AHEAD 0x4 | |
330 | #define MT_ST_DEBUGGING 0x8 | |
331 | #define MT_ST_TWO_FM 0x10 | |
332 | #define MT_ST_FAST_MTEOM 0x20 | |
333 | #define MT_ST_AUTO_LOCK 0x40 | |
334 | #define MT_ST_DEF_WRITES 0x80 | |
335 | #define MT_ST_CAN_BSR 0x100 | |
336 | #define MT_ST_NO_BLKLIMS 0x200 | |
337 | #define MT_ST_CAN_PARTITIONS 0x400 | |
338 | #define MT_ST_SCSI2LOGICAL 0x800 | |
339 | #define MT_ST_SYSV 0x1000 | |
340 | #define MT_ST_NOWAIT 0x2000 | |
341 | ||
342 | /* The mode parameters to be controlled. Parameter chosen with bits 20-28 */ | |
343 | #define MT_ST_CLEAR_DEFAULT 0xfffff | |
344 | #define MT_ST_DEF_DENSITY (MT_ST_DEF_OPTIONS | 0x100000) | |
345 | #define MT_ST_DEF_COMPRESSION (MT_ST_DEF_OPTIONS | 0x200000) | |
346 | #define MT_ST_DEF_DRVBUFFER (MT_ST_DEF_OPTIONS | 0x300000) | |
347 | ||
348 | /* The offset for the arguments for the special HP changer load command. */ | |
349 | #define MT_ST_HPLOADER_OFFSET 10000 | |
350 | ||
351 | #endif /* _LINUX_MTIO_H */ |