update from main archive 970118
[kopensolaris-gnu/glibc.git] / sysdeps / unix / sysv / linux / sys / mtio.h
1 /* Structures and definitions for magnetic tape I/O control commands.
2    Copyright (C) 1996, 1997 Free Software Foundation, Inc.
3    This file is part of the GNU C Library.
4
5    The GNU C Library is free software; you can redistribute it and/or
6    modify it under the terms of the GNU Library General Public License as
7    published by the Free Software Foundation; either version 2 of the
8    License, or (at your option) any later version.
9
10    The GNU C Library is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    Library General Public License for more details.
14
15    You should have received a copy of the GNU Library General Public
16    License along with the GNU C Library; see the file COPYING.LIB.  If not,
17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18    Boston, MA 02111-1307, USA.  */
19
20 /* Written by H. Bergman <hennus@cybercomm.nl>.  */
21
22 #ifndef _SYS_MTIO_H
23 #define _SYS_MTIO_H     1
24
25 /* Get necessary definitions from system and kernel headers.  */
26 #include <sys/types.h>
27 #include <sys/ioctl.h>
28
29
30 /* Structure for MTIOCTOP - magnetic tape operation command.  */
31 struct mtop
32   {
33     short int mt_op;            /* Operations defined below.  */
34     int mt_count;               /* How many of them.  */
35   };
36
37 /* Magnetic Tape operations [Not all operations supported by all drivers].  */
38 #define MTRESET 0       /* +reset drive in case of problems.  */
39 #define MTFSF   1       /* Forward space over FileMark,
40                          * position at first record of next file.  */
41 #define MTBSF   2       /* Backward space FileMark (position before FM).  */
42 #define MTFSR   3       /* Forward space record.  */
43 #define MTBSR   4       /* Backward space record.  */
44 #define MTWEOF  5       /* Write an end-of-file record (mark).  */
45 #define MTREW   6       /* Rewind.  */
46 #define MTOFFL  7       /* Rewind and put the drive offline (eject?).  */
47 #define MTNOP   8       /* No op, set status only (read with MTIOCGET).  */
48 #define MTRETEN 9       /* Retension tape.  */
49 #define MTBSFM  10      /* +backward space FileMark, position at FM.  */
50 #define MTFSFM  11      /* +forward space FileMark, position at FM.  */
51 #define MTEOM   12      /* Goto end of recorded media (for appending files).
52                            MTEOM positions after the last FM, ready for
53                            appending another file.  */
54 #define MTERASE 13      /* Erase tape -- be careful!  */
55
56 #define MTRAS1  14      /* Run self test 1 (nondestructive).  */
57 #define MTRAS2  15      /* Run self test 2 (destructive).  */
58 #define MTRAS3  16      /* Reserved for self test 3.  */
59
60 #define MTSETBLK 20     /* Set block length (SCSI).  */
61 #define MTSETDENSITY 21 /* Set tape density (SCSI).  */
62 #define MTSEEK  22      /* Seek to block (Tandberg, etc.).  */
63 #define MTTELL  23      /* Tell block (Tandberg, etc.).  */
64 #define MTSETDRVBUFFER 24 /* Set the drive buffering according to SCSI-2.
65                              Ordinary buffered operation with code 1.  */
66 #define MTFSS   25      /* Space forward over setmarks.  */
67 #define MTBSS   26      /* Space backward over setmarks.  */
68 #define MTWSM   27      /* Write setmarks.  */
69
70 #define MTLOCK  28      /* Lock the drive door.  */
71 #define MTUNLOCK 29     /* Unlock the drive door.  */
72 #define MTLOAD  30      /* Execute the SCSI load command.  */
73 #define MTUNLOAD 31     /* Execute the SCSI unload command.  */
74 #define MTCOMPRESSION 32/* Control compression with SCSI mode page 15.  */
75 #define MTSETPART 33    /* Change the active tape partition.  */
76 #define MTMKPART  34    /* Format the tape with one or two partitions.  */
77
78 /* structure for MTIOCGET - mag tape get status command */
79
80 struct mtget
81   {
82     long int mt_type;           /* Type of magtape device.  */
83     long int mt_resid;          /* Residual count: (not sure)
84                                    number of bytes ignored, or
85                                    number of files not skipped, or
86                                    number of records not skipped.  */
87     /* The following registers are device dependent.  */
88     long int mt_dsreg;          /* Status register.  */
89     long int mt_gstat;          /* Generic (device independent) status.  */
90     long int mt_erreg;          /* Error register.  */
91     /* The next two fields are not always used.  */
92     __daddr_t mt_fileno;        /* Number of current file on tape.  */
93     __daddr_t mt_blkno;         /* Current block number.  */
94   };
95
96
97
98 /* Constants for mt_type. Not all of these are supported, and
99    these are not all of the ones that are supported.  */
100 #define MT_ISUNKNOWN            0x01
101 #define MT_ISQIC02              0x02    /* Generic QIC-02 tape streamer.  */
102 #define MT_ISWT5150             0x03    /* Wangtek 5150EQ, QIC-150, QIC-02.  */
103 #define MT_ISARCHIVE_5945L2     0x04    /* Archive 5945L-2, QIC-24, QIC-02?. */
104 #define MT_ISCMSJ500            0x05    /* CMS Jumbo 500 (QIC-02?).  */
105 #define MT_ISTDC3610            0x06    /* Tandberg 6310, QIC-24.  */
106 #define MT_ISARCHIVE_VP60I      0x07    /* Archive VP60i, QIC-02.  */
107 #define MT_ISARCHIVE_2150L      0x08    /* Archive Viper 2150L.  */
108 #define MT_ISARCHIVE_2060L      0x09    /* Archive Viper 2060L.  */
109 #define MT_ISARCHIVESC499       0x0A    /* Archive SC-499 QIC-36 controller. */
110 #define MT_ISQIC02_ALL_FEATURES 0x0F    /* Generic QIC-02 with all features. */
111 #define MT_ISWT5099EEN24        0x11    /* Wangtek 5099-een24, 60MB, QIC-24. */
112 #define MT_ISTEAC_MT2ST         0x12    /* Teac MT-2ST 155mb drive,
113                                            Teac DC-1 card (Wangtek type).  */
114 #define MT_ISEVEREX_FT40A       0x32    /* Everex FT40A (QIC-40).  */
115 #define MT_ISDDS1               0x51    /* DDS device without partitions.  */
116 #define MT_ISDDS2               0x52    /* DDS device with partitions.  */
117 #define MT_ISSCSI1              0x71    /* Generic ANSI SCSI-1 tape unit.  */
118 #define MT_ISSCSI2              0x72    /* Generic ANSI SCSI-2 tape unit.  */
119
120 /* QIC-40/80/3010/3020 ftape supported drives.
121    20bit vendor ID + 0x800000 (see vendors.h in ftape distribution).  */
122 #define MT_ISFTAPE_UNKNOWN      0x800000 /* obsolete */
123 #define MT_ISFTAPE_FLAG         0x800000
124
125 struct mt_tape_info
126   {
127     long int t_type;            /* Device type id (mt_type).  */
128     char *t_name;               /* Descriptive name.  */
129   };
130
131 #define MT_TAPE_INFO \
132   {                                                                           \
133         {MT_ISUNKNOWN,          "Unknown type of tape device"},               \
134         {MT_ISQIC02,            "Generic QIC-02 tape streamer"},              \
135         {MT_ISWT5150,           "Wangtek 5150, QIC-150"},                     \
136         {MT_ISARCHIVE_5945L2,   "Archive 5945L-2"},                           \
137         {MT_ISCMSJ500,          "CMS Jumbo 500"},                             \
138         {MT_ISTDC3610,          "Tandberg TDC 3610, QIC-24"},                 \
139         {MT_ISARCHIVE_VP60I,    "Archive VP60i, QIC-02"},                     \
140         {MT_ISARCHIVE_2150L,    "Archive Viper 2150L"},                       \
141         {MT_ISARCHIVE_2060L,    "Archive Viper 2060L"},                       \
142         {MT_ISARCHIVESC499,     "Archive SC-499 QIC-36 controller"},          \
143         {MT_ISQIC02_ALL_FEATURES, "Generic QIC-02 tape, all features"},       \
144         {MT_ISWT5099EEN24,      "Wangtek 5099-een24, 60MB"},                  \
145         {MT_ISTEAC_MT2ST,       "Teac MT-2ST 155mb data cassette drive"},     \
146         {MT_ISEVEREX_FT40A,     "Everex FT40A, QIC-40"},                      \
147         {MT_ISSCSI1,            "Generic SCSI-1 tape"},                       \
148         {MT_ISSCSI2,            "Generic SCSI-2 tape"},                       \
149         {0, NULL}                                                             \
150   }
151
152
153 /* Structure for MTIOCPOS - mag tape get position command.  */
154
155 struct mtpos
156   {
157     long int mt_blkno;  /* Current block number.  */
158   };
159
160
161 /* Structure for MTIOCGETCONFIG/MTIOCSETCONFIG primarily intended
162    as an interim solution for QIC-02 until DDI is fully implemented.  */
163 struct mtconfiginfo
164   {
165     long int mt_type;           /* Drive type.  */
166     long int ifc_type;          /* Interface card type.  */
167     unsigned short int irqnr;   /* IRQ number to use.  */
168     unsigned short int dmanr;   /* DMA channel to use.  */
169     unsigned short int port;    /* IO port base address.  */
170
171     unsigned long int debug;    /* Debugging flags.  */
172
173     unsigned have_dens:1;
174     unsigned have_bsf:1;
175     unsigned have_fsr:1;
176     unsigned have_bsr:1;
177     unsigned have_eod:1;
178     unsigned have_seek:1;
179     unsigned have_tell:1;
180     unsigned have_ras1:1;
181     unsigned have_ras2:1;
182     unsigned have_ras3:1;
183     unsigned have_qfa:1;
184
185     unsigned pad1:5;
186     char reserved[10];
187   };
188
189
190 /* Magnetic tape I/O control commands.  */
191 #define MTIOCTOP        _IOW('m', 1, struct mtop)       /* Do a mag tape op. */
192 #define MTIOCGET        _IOR('m', 2, struct mtget)      /* Get tape status.  */
193 #define MTIOCPOS        _IOR('m', 3, struct mtpos)      /* Get tape position.*/
194
195 /* The next two are used by the QIC-02 driver for runtime reconfiguration.
196    See tpqic02.h for struct mtconfiginfo.  */
197 #define MTIOCGETCONFIG  _IOR('m', 4, struct mtconfiginfo) /* Get tape config.*/
198 #define MTIOCSETCONFIG  _IOW('m', 5, struct mtconfiginfo) /* Set tape config.*/
199
200 /* Generic Mag Tape (device independent) status macros for examining
201    mt_gstat -- HP-UX compatible.
202    There is room for more generic status bits here, but I don't
203    know which of them are reserved. At least three or so should
204    be added to make this really useful.  */
205 #define GMT_EOF(x)              ((x) & 0x80000000)
206 #define GMT_BOT(x)              ((x) & 0x40000000)
207 #define GMT_EOT(x)              ((x) & 0x20000000)
208 #define GMT_SM(x)               ((x) & 0x10000000)  /* DDS setmark */
209 #define GMT_EOD(x)              ((x) & 0x08000000)  /* DDS EOD */
210 #define GMT_WR_PROT(x)          ((x) & 0x04000000)
211 /* #define GMT_ ?               ((x) & 0x02000000) */
212 #define GMT_ONLINE(x)           ((x) & 0x01000000)
213 #define GMT_D_6250(x)           ((x) & 0x00800000)
214 #define GMT_D_1600(x)           ((x) & 0x00400000)
215 #define GMT_D_800(x)            ((x) & 0x00200000)
216 /* #define GMT_ ?               ((x) & 0x00100000) */
217 /* #define GMT_ ?               ((x) & 0x00080000) */
218 #define GMT_DR_OPEN(x)          ((x) & 0x00040000)  /* Door open (no tape).  */
219 /* #define GMT_ ?               ((x) & 0x00020000) */
220 #define GMT_IM_REP_EN(x)        ((x) & 0x00010000)  /* Immediate report mode.*/
221 /* 16 generic status bits unused.  */
222
223
224 /* SCSI-tape specific definitions.  Bitfield shifts in the status  */
225 #define MT_ST_BLKSIZE_SHIFT     0
226 #define MT_ST_BLKSIZE_MASK      0xffffff
227 #define MT_ST_DENSITY_SHIFT     24
228 #define MT_ST_DENSITY_MASK      0xff000000
229
230 #define MT_ST_SOFTERR_SHIFT     0
231 #define MT_ST_SOFTERR_MASK      0xffff
232
233 /* Bitfields for the MTSETDRVBUFFER ioctl.  */
234 #define MT_ST_OPTIONS           0xf0000000
235 #define MT_ST_BOOLEANS          0x10000000
236 #define MT_ST_SETBOOLEANS       0x30000000
237 #define MT_ST_CLEARBOOLEANS     0x40000000
238 #define MT_ST_WRITE_THRESHOLD   0x20000000
239 #define MT_ST_DEF_BLKSIZE       0x50000000
240 #define MT_ST_DEF_OPTIONS       0x60000000
241
242 #define MT_ST_BUFFER_WRITES     0x1
243 #define MT_ST_ASYNC_WRITES      0x2
244 #define MT_ST_READ_AHEAD        0x4
245 #define MT_ST_DEBUGGING         0x8
246 #define MT_ST_TWO_FM            0x10
247 #define MT_ST_FAST_MTEOM        0x20
248 #define MT_ST_AUTO_LOCK         0x40
249 #define MT_ST_DEF_WRITES        0x80
250 #define MT_ST_CAN_BSR           0x100
251 #define MT_ST_NO_BLKLIMS        0x200
252 #define MT_ST_CAN_PARTITIONS    0x400
253 #define MT_ST_SCSI2LOGICAL      0x800
254
255 /* The mode parameters to be controlled. Parameter chosen with bits 20-28.  */
256 #define MT_ST_CLEAR_DEFAULT     0xfffff
257 #define MT_ST_DEF_DENSITY       (MT_ST_DEF_OPTIONS | 0x100000)
258 #define MT_ST_DEF_COMPRESSION   (MT_ST_DEF_OPTIONS | 0x200000)
259 #define MT_ST_DEF_DRVBUFFER     (MT_ST_DEF_OPTIONS | 0x300000)
260
261 /* The offset for the arguments for the special HP changer load command.  */
262 #define MT_ST_HPLOADER_OFFSET 10000
263
264
265 /* Specify default tape device.  */
266 #ifndef DEFTAPE
267 # define DEFTAPE        "/dev/tape"
268 #endif
269
270 #endif /* mtio.h */