xref: /illumos-gate/usr/src/uts/common/sys/mtio.h (revision 0173c38a73f34277e0c97a19fedfd25d81ba8380)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  *
25  *	Copyright (c) 1983-1989 by AT&T.
26  *	All rights reserved.
27  */
28 
29 /*
30  * Portions of this source code were derived from Berkeley 4.3 BSD
31  * under license from the Regents of the University of California.
32  */
33 
34 #ifndef	_SYS_MTIO_H
35 #define	_SYS_MTIO_H
36 
37 #pragma ident	"%Z%%M%	%I%	%E% SMI"
38 
39 #include <sys/types.h>
40 
41 #ifdef	__cplusplus
42 extern "C" {
43 #endif
44 
45 /*
46  * Structures and definitions for mag tape io control commands
47  */
48 
49 /*
50  * structure for MTIOCTOP - mag tape op command
51  */
52 struct mtop	{
53 	short		mt_op;		/* operations defined below */
54 	daddr_t		mt_count;	/* how many of them */
55 };
56 
57 #if defined(_SYSCALL32)
58 struct mtop32	{
59 	short		mt_op;		/* operations defined below */
60 	daddr32_t	mt_count;	/* how many of them */
61 };
62 #endif /* _SYSCALL32 */
63 
64 
65 /*
66  * values for mt_op
67  */
68 #define	MTWEOF		0	/* write an end-of-file record */
69 #define	MTFSF		1	/* forward space over file mark */
70 #define	MTBSF		2	/* backward space over file mark (1/2" only ) */
71 #define	MTFSR		3	/* forward space to inter-record gap */
72 #define	MTBSR		4	/* backward space to inter-record gap */
73 #define	MTREW		5	/* rewind */
74 #define	MTOFFL		6	/* rewind and put the drive offline */
75 #define	MTNOP		7	/* no operation, sets status only */
76 #define	MTRETEN		8	/* retension the tape (cartridge tape only) */
77 #define	MTERASE		9	/* erase the entire tape */
78 #define	MTEOM		10	/* position to end of media */
79 #define	MTNBSF		11	/* backward space file to BOF */
80 #define	MTSRSZ		12	/* set record size */
81 #define	MTGRSZ		13	/* get record size */
82 #define	MTLOAD		14	/* for loading a tape (use o_delay to open */
83 				/* the tape device) */
84 
85 /*
86  * structure for MTIOCGET - mag tape get status command
87  */
88 struct mtget	{
89 	short		mt_type;	/* type of magtape device */
90 	/* the following two registers are grossly device dependent */
91 	short		mt_dsreg;	/* ``drive status'' register */
92 	short		mt_erreg;	/* ``error'' register */
93 	/* optional error info. */
94 	daddr_t		mt_resid;	/* residual count */
95 	daddr_t		mt_fileno;	/* file number of current position */
96 	daddr_t		mt_blkno;	/* block number of current position */
97 	ushort_t	mt_flags;
98 	short		mt_bf;		/* optimum blocking factor */
99 };
100 
101 #if defined(_SYSCALL32)
102 struct mtget32	{
103 	short		mt_type;	/* type of magtape device */
104 	/* the following two registers are grossly device dependent */
105 	short		mt_dsreg;	/* ``drive status'' register */
106 	short		mt_erreg;	/* ``error'' register */
107 	/* optional error info. */
108 	daddr32_t	mt_resid;	/* residual count */
109 	daddr32_t	mt_fileno;	/* file number of current position */
110 	daddr32_t	mt_blkno;	/* block number of current position */
111 	ushort_t	mt_flags;
112 	short		mt_bf;		/* optimum blocking factor */
113 };
114 #endif /* _SYSCALL32 */
115 
116 #define	MT_NDENSITIES	4
117 #define	MT_NSPEEDS	4
118 
119 /*
120  * struct for MTIOCGETDRIVETYPE - get tape config data
121  */
122 struct mtdrivetype {
123 	char    name[64];		/* Name, for debug */
124 	char    vid[25];		/* Vendor id and model (product) id */
125 	char    type;			/* Drive type for driver */
126 	int	bsize;			/* Block size */
127 	int	options;		/* Drive options */
128 	int	max_rretries;		/* Max read retries */
129 	int	max_wretries;		/* Max write retries */
130 	uchar_t densities[MT_NDENSITIES];	/* density codes, low->hi */
131 	uchar_t	default_density;	/* Default density chosen */
132 	uchar_t speeds[MT_NSPEEDS];	/* speed codes, low->hi */
133 	ushort_t non_motion_timeout;    /* Inquiry type commands */
134 	ushort_t io_timeout;		/* io timeout. seconds */
135 	ushort_t rewind_timeout;	/* rewind timeout. seconds */
136 	ushort_t space_timeout;		/* space cmd timeout. seconds */
137 	ushort_t load_timeout;		/* load tape time in seconds */
138 	ushort_t unload_timeout;	/* Unload tape time in scounds */
139 	ushort_t erase_timeout;		/* erase timeout. seconds */
140 };
141 
142 
143 struct mtdrivetype_request {
144 	int	size;
145 	struct  mtdrivetype *mtdtp;
146 };
147 
148 #if defined(_SYSCALL32)
149 struct mtdrivetype_request32 {
150 	int		size;
151 	caddr32_t	mtdtp;
152 };
153 #endif /* _SYSCALL32 */
154 
155 
156 /*
157  * values for mt_flags
158  */
159 #define	MTF_SCSI	0x01
160 #define	MTF_REEL	0x02
161 #define	MTF_ASF		0x04
162 
163 #define	MTF_TAPE_HEAD_DIRTY	0x08
164 #define	MTF_TAPE_CLN_SUPPORTED	0x10
165 #define	MTF_WORM_MEDIA		0x20
166 
167 /*
168  * Constants for mt_type byte (these are somewhat obsolete)
169  */
170 #define	MT_ISTS		0x01		/* vax: unibus ts-11 */
171 #define	MT_ISHT		0x02		/* vax: massbus tu77, etc */
172 #define	MT_ISTM		0x03		/* vax: unibus tm-11 */
173 #define	MT_ISMT		0x04		/* vax: massbus tu78 */
174 #define	MT_ISUT		0x05		/* vax: unibus gcr */
175 #define	MT_ISCPC	0x06		/* sun: multibus cpc */
176 #define	MT_ISAR		0x07		/* sun: multibus archive */
177 #define	MT_ISSC		0x08		/* sun: SCSI archive */
178 #define	MT_ISSYSGEN11	0x10		/* sun: SCSI Sysgen, QIC-11 only */
179 #define	MT_ISSYSGEN	0x11		/* sun: SCSI Sysgen QIC-24/11 */
180 #define	MT_ISDEFAULT	0x12		/* sun: SCSI default CCS */
181 #define	MT_ISCCS3	0x13		/* sun: SCSI generic (unknown) CCS */
182 #define	MT_ISMT02	0x14		/* sun: SCSI Emulex MT02 */
183 #define	MT_ISVIPER1	0x15		/* sun: SCSI Archive QIC-150 Viper */
184 #define	MT_ISWANGTEK1	0x16		/* sun: SCSI Wangtek QIC-150 */
185 #define	MT_ISCCS7	0x17		/* sun: SCSI generic (unknown) CCS */
186 #define	MT_ISCCS8	0x18		/* sun: SCSI generic (unknown) CCS */
187 #define	MT_ISCCS9	0x19		/* sun: SCSI generic (unknown) CCS */
188 #define	MT_ISCCS11	0x1a		/* sun: SCSI generic (unknown) CCS */
189 #define	MT_ISCCS12	0x1b		/* sun: SCSI generic (unknown) CCS */
190 #define	MT_ISCCS13	0x1c		/* sun: SCSI generic (unknown) CCS */
191 #define	MT_ISCCS14	0x1d		/* sun: SCSI generic (unknown) CCS */
192 #define	MT_ISCCS15	0x1e		/* sun: SCSI generic (unknown) CCS */
193 #define	MT_ISCCS16	0x1f		/* sun: SCSI generic (unknown) CCS */
194 #define	MT_ISCDC	0x20		/* sun: SCSI CDC 1/2" cartridge */
195 #define	MT_ISFUJI	0x21		/* sun: SCSI Fujitsu 1/2" cartridge */
196 #define	MT_ISKENNEDY	0x22		/* sun: SCSI Kennedy 1/2" reel */
197 #define	MT_ISHP		0x23		/* sun: SCSI HP 1/2" reel */
198 #define	MT_ISSTC	0x24		/* sun: SCSI IBM STC 3490 */
199 #define	MT_ISANRITSU	0x25		/* nihon sun: Anritsu 1/2" reel */
200 #define	MT_ISCCS23	0x26		/* sun: SCSI generic  1/2" */
201 #define	MT_ISCCS24	0x27		/* sun: SCSI generic  1/2" */
202 #define	MT_ISEXABYTE	0x28		/* sun: SCSI Exabyte 8mm cartridge */
203 #define	MT_ISEXB8500	0x29		/* sun: SCSI Exabyte 8500 8mm cart */
204 #define	MT_ISWANGTHS	0x2a		/* sun: SCSI Wangtek 6130HS RDAT */
205 #define	MT_ISWANGDAT	0x2b		/* sun: SCSI WangDAT */
206 #define	MT_ISPYTHON	0x2c		/* sun: SCSI Archive Python DAT  */
207 #define	MT_ISCCS28	0x2d		/* sun: SCSI generic DAT CCS */
208 #define	MT_ISCCS29	0x2e		/* sun: SCSI generic (unknown) CCS */
209 #define	MT_ISCCS30	0x2f		/* sun: SCSI generic (unknown) CCS */
210 #define	MT_ISCCS31	0x30		/* sun: SCSI generic (unknown) CCS */
211 #define	MT_ISCCS32	0x31		/* sun: SCSI generic (unknown) CCS */
212 
213 
214 /*
215  * these are recommended
216  */
217 #define	MT_ISQIC	0x32		/* generic QIC tape drive */
218 #define	MT_ISREEL	0x33		/* generic reel tape drive */
219 #define	MT_ISDAT	0x34		/* generic DAT tape drive */
220 #define	MT_IS8MM	0x35		/* generic 8mm tape drive */
221 #define	MT_ISOTHER	0x36		/* generic other type of tape drive */
222 
223 /* more Sun devices */
224 #define	MT_ISTAND25G	0x37		/* sun: SCSI Tandberg 2.5 Gig QIC */
225 #define	MT_ISDLT	0x38		/* sun: SCSI DLT tape drive */
226 #define	MT_ISSTK9840	0x39		/* sun: STK 9840, 9940, 9840B */
227 #define	MT_ISBMDLT1	0x3a		/* sun: Benchmark DLT1 */
228 #define	MT_LTO		0x3b		/* sun: LTO,s by Hp, Seagate, IBM .. */
229 #define	MT_ISAIT	0x3c		/* Sony: AIT I II III and SAIT */
230 
231 /*
232  * Device table structure and data for looking tape name from
233  * tape id number.  Used by mt.c.
234  */
235 struct mt_tape_info {
236 	short	t_type;		/* type of magtape device */
237 	char	*t_name;	/* printing name */
238 	char	*t_dsbits;	/* "drive status" register */
239 	char	*t_erbits;	/* "error" register */
240 };
241 
242 /*
243  * this table is now obsolete, use MTIOCGETDRIVETYPE ioctl
244  *
245  * WARNING: this table will be eliminated in some future release
246  */
247 #define	MT_TAPE_INFO  {\
248 { MT_ISSYSGEN11,	"Sysgen QIC-11",		0, 0 }, \
249 { MT_ISSYSGEN,		"Sysgen QIC-24",		0, 0 }, \
250 { MT_ISMT02,		"Emulex MT-02 QIC-24",		0, 0 }, \
251 { MT_ISVIPER1,		"Archive QIC-150",		0, 0 }, \
252 { MT_ISWANGTEK1,	"Wangtek QIC-150",		0, 0 }, \
253 { MT_ISKENNEDY,		"Kennedy 9612 1/2-inch",	0, 0 }, \
254 { MT_ISANRITSU,		"Anritsu 1/2-inch",		0, 0 }, \
255 { MT_ISHP,		"HP 88780 1/2-inch",		0, 0 }, \
256 { MT_ISEXABYTE,		"Exabyte EXB-8200 8mm",		0, 0 }, \
257 { MT_ISEXB8500,		"Exabyte EXB-8500 8mm",		0, 0 }, \
258 { MT_ISWANGDAT,		"WangDAT 3.81mm",		0, 0 }, \
259 { MT_ISWANGTHS,		"Wangtek 4mm RDAT",		0, 0 }, \
260 { MT_ISPYTHON,		"Archive Python 4mm Helical Scan",	0, 0 }, \
261 { MT_ISSTC,		"STC 1/2\" Cartridge",		0, 0}, \
262 { MT_ISTAND25G,		"Tandberg 2.5 Gig QIC",		0, 0}, \
263 { MT_ISQIC,		"QIC",		0, 0}, \
264 { MT_ISREEL,		"REEL",		0, 0}, \
265 { MT_ISDAT,		"DAT",		0, 0}, \
266 { MT_IS8MM,		"8mm",		0, 0}, \
267 { MT_ISOTHER,		"Other",	0, 0}, \
268 { 0 } \
269 }
270 
271 /* mag tape io control commands */
272 #define	MTIOC			('m'<<8)
273 #define	MTIOCTOP		(MTIOC|1)	/* do a mag tape op */
274 #define	MTIOCGET		(MTIOC|2)	/* get tape status */
275 #define	MTIOCGETDRIVETYPE	(MTIOC|3)	/* get tape config data */
276 #define	MTIOCPERSISTENT		(MTIOC|4)	/* turn on persistent errors */
277 #define	MTIOCPERSISTENTSTATUS	(MTIOC|5)	/* query persis. err status */
278 #define	MTIOCLRERR		(MTIOC|6)	/* clear a persitent error */
279 #define	MTIOCGUARANTEEDORDER	(MTIOC|7)	/* check for guaranteed order */
280 #define	MTIOCRESERVE		(MTIOC|8)	/* preserve reserve */
281 #define	MTIOCRELEASE		(MTIOC|9)	/* turnoff preserve reserve */
282 #define	MTIOCFORCERESERVE	(MTIOC|10)	/* break reservation drive */
283 
284 #define	MTIOCSTATE		(MTIOC|13)	/* Inquire insert/eject state */
285 
286 #define	MTIOCREADIGNOREILI  	(MTIOC|14)	/* Enable/Disable ILI */
287 #define	MTIOCREADIGNOREEOFS 	(MTIOC|15)	/* Enable/Disable Ignore EOF */
288 #define	MTIOCSHORTFMK		(MTIOC|16)	/* Enable/Disable Short FMK */
289 
290 /*
291  * This state enum is the argument passed to the MTIOCSTATE ioctl.
292  */
293 enum mtio_state { MTIO_NONE, MTIO_EJECTED, MTIO_INSERTED };
294 
295 #ifndef KERNEL
296 /*
297  * don't use DEFTAPE.
298  */
299 #define	DEFTAPE	"/dev/rmt/0"
300 #endif
301 
302 /*
303  * Layout of minor device byte
304  * 15 - 8    7    6    5    4    3    2    1    0
305  * --------------------------------------------
306  * |    |    |    |    |    |    |    |    |----| Unit #. lower 2 bits
307  * |    |    |    |    |    |    |    |---------- No rewind on close bit....
308  * |    |    |    |    |    |----|--------------- Density Select
309  * |    |    |    |    |------------------------- Resrvd.(add. campus dens. bit)
310  * |    |    |    |------------------------------ BSD behavior
311  * |----|----|----------------------------------- Unit #  bit 2-6
312  */
313 
314 #define	MTUNIT(dev)	(((getminor(dev) & 0xff80) >> 5) + \
315 			    (getminor(dev) & 0x3))
316 #define	MT_NOREWIND	(1 <<2)
317 #define	MT_DENSITY_MASK	(3 <<3)
318 #define	MT_DENSITY1	(0 <<3)		/* Lowest density/format */
319 #define	MT_DENSITY2	(1 <<3)
320 #define	MT_DENSITY3	(2 <<3)
321 #define	MT_DENSITY4	(3 <<3)		/* Highest density/format */
322 #define	MTMINOR(unit)	((((unit) & 0x7fc) << 5) + ((unit) & 0x3))
323 #define	MT_BSD		(1 <<6)		/* BSD behavior on close */
324 #define	MT_DENSITY(dev) ((getminor(dev) & MT_DENSITY_MASK) >> 3)
325 
326 
327 #ifdef	__cplusplus
328 }
329 #endif
330 
331 #endif /* _SYS_MTIO_H */
332