xref: /dragonfly/sys/sys/mtio.h (revision c66c7e2f)
1 /*
2  * Copyright (c) 1982, 1986, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  *	@(#)mtio.h	8.1 (Berkeley) 6/2/93
30  * $FreeBSD: src/sys/sys/mtio.h,v 1.20.2.2 2001/01/22 18:02:47 mjacob Exp $
31  * $DragonFly: src/sys/sys/mtio.h,v 1.4 2006/05/20 02:42:13 dillon Exp $
32  */
33 
34 #ifndef	_SYS_MTIO_H_
35 #define	_SYS_MTIO_H_
36 
37 #ifndef _SYS_TYPES_H_
38 #include <sys/types.h>
39 #endif
40 #ifndef _SYS_IOCCOM_H_
41 #include <sys/ioccom.h>
42 #endif
43 
44 /*
45  * Structures and definitions for mag tape io control commands
46  */
47 
48 /* structure for MTIOCTOP - mag tape op command */
49 struct mtop {
50 	short	mt_op;		/* operations defined below */
51 	daddr_t	mt_count;	/* how many of them */
52 };
53 
54 /* operations */
55 #define MTWEOF		0	/* write an end-of-file record */
56 #define MTFSF		1	/* forward space file */
57 #define MTBSF		2	/* backward space file */
58 #define MTFSR		3	/* forward space record */
59 #define MTBSR		4	/* backward space record */
60 #define MTREW		5	/* rewind */
61 #define MTOFFL		6	/* rewind and put the drive offline */
62 #define MTNOP		7	/* no operation, sets status only */
63 #define MTCACHE		8	/* enable controller cache */
64 #define MTNOCACHE	9	/* disable controller cache */
65 
66 #if defined(__DragonFly__)
67 /* Set block size for device. If device is a variable size dev		*/
68 /* a non zero parameter will change the device to a fixed block size	*/
69 /* device with block size set to that of the parameter passed in.	*/
70 /* Resetting the block size to 0 will restore the device to a variable	*/
71 /* block size device. */
72 
73 #define MTSETBSIZ	10
74 
75 /* Set density values for device. Sets the value for the opened mode only. */
76 
77 #define MTSETDNSTY	11
78 
79 #define MTERASE		12	/* erase to EOM */
80 #define MTEOD		13	/* Space to EOM */
81 #define MTCOMP		14	/* select compression mode 0=off, 1=def */
82 #define MTRETENS	15	/* re-tension tape */
83 #define MTWSS		16	/* write setmark(s) */
84 #define MTFSS		17	/* forward space setmark */
85 #define MTBSS		18	/* backward space setmark */
86 
87 #define MT_COMP_ENABLE		0xffffffff
88 #define MT_COMP_DISABLED	0xfffffffe
89 #define MT_COMP_UNSUPP		0xfffffffd
90 
91 /*
92  * Values in mt_dsreg that say what the device is doing
93  */
94 #define	MTIO_DSREG_NIL	0	/* Unknown */
95 #define	MTIO_DSREG_REST	1	/* Doing Nothing */
96 #define	MTIO_DSREG_RBSY	2	/* Communicating with tape (but no motion) */
97 #define	MTIO_DSREG_WR	20	/* Writing */
98 #define	MTIO_DSREG_FMK	21	/* Writing Filemarks */
99 #define	MTIO_DSREG_ZER	22	/* Erasing */
100 #define	MTIO_DSREG_RD	30	/* Reading */
101 #define	MTIO_DSREG_FWD	40	/* Spacing Forward */
102 #define	MTIO_DSREG_REV	41	/* Spacing Reverse */
103 #define	MTIO_DSREG_POS	42	/* Hardware Positioning (direction unknown) */
104 #define	MTIO_DSREG_REW	43	/* Rewinding */
105 #define	MTIO_DSREG_TEN	44	/* Retensioning */
106 #define	MTIO_DSREG_UNL	45	/* Unloading */
107 #define	MTIO_DSREG_LD	46	/* Loading */
108 
109 #endif	/* __DragonFly__ */
110 
111 /* structure for MTIOCGET - mag tape get status command */
112 
113 struct mtget {
114 	short	mt_type;	/* type of magtape device */
115 /* the following two registers are grossly device dependent */
116 	short	mt_dsreg;	/* ``drive status'' register */
117 	short	mt_erreg;	/* ``error'' register */
118 /* end device-dependent registers */
119 	/*
120 	 * Note that the residual count, while maintained, may be
121 	 * be nonsense because the size of the residual may (greatly)
122 	 * exceed 32 K-bytes. Use the MTIOCERRSTAT ioctl to get a
123 	 * more accurate count.
124 	 */
125 	short	mt_resid;	/* residual count */
126 #if defined (__DragonFly__)
127 	daddr_t mt_blksiz;	/* presently operating blocksize */
128 	daddr_t mt_density;	/* presently operating density */
129 	u_int32_t mt_comp;	/* presently operating compression */
130 	daddr_t mt_blksiz0;	/* blocksize for mode 0 */
131 	daddr_t mt_blksiz1;	/* blocksize for mode 1 */
132 	daddr_t mt_blksiz2;	/* blocksize for mode 2 */
133 	daddr_t mt_blksiz3;	/* blocksize for mode 3 */
134 	daddr_t mt_density0;	/* density for mode 0 */
135 	daddr_t mt_density1;	/* density for mode 1 */
136 	daddr_t mt_density2;	/* density for mode 2 */
137 	daddr_t mt_density3;	/* density for mode 3 */
138 /* the following are not yet implemented */
139 	u_int32_t mt_comp0;	/* compression type for mode 0 */
140 	u_int32_t mt_comp1;	/* compression type for mode 1 */
141 	u_int32_t mt_comp2;	/* compression type for mode 2 */
142 	u_int32_t mt_comp3;	/* compression type for mode 3 */
143 /* end not yet implemented */
144 #endif
145 	daddr_t	mt_fileno;	/* relative file number of current position */
146 	daddr_t	mt_blkno;	/* relative block number of current position */
147 };
148 
149 /* structure for MTIOCERRSTAT - tape get error status command */
150 /* really only supported for SCSI tapes right now */
151 struct scsi_tape_errors {
152 	/*
153 	 * These are latched from the last command that had a SCSI
154 	 * Check Condition noted for these operations. The act
155 	 * of issuing an MTIOCERRSTAT unlatches and clears them.
156 	 */
157 	u_int8_t io_sense[32];	/* Last Sense Data For Data I/O */
158 	int32_t io_resid;	/* residual count from last Data I/O */
159 	u_int8_t io_cdb[16];	/* Command that Caused the Last Data Sense */
160 	u_int8_t ctl_sense[32];	/* Last Sense Data For Control I/O */
161 	int32_t ctl_resid;	/* residual count from last Control I/O */
162 	u_int8_t ctl_cdb[16];	/* Command that Caused the Last Control Sense */
163 	/*
164 	 * These are the read and write cumulative error counters.
165 	 * (how to reset cumulative error counters is not yet defined).
166 	 * (not implemented as yet but space is being reserved for them)
167 	 */
168 	struct {
169 		u_int32_t retries;	/* total # retries performed */
170 		u_int32_t corrected;	/* total # corrections performed */
171 		u_int32_t processed;	/* total # corrections succssful */
172 		u_int32_t failures;	/* total # corrections/retries failed */
173 		u_int64_t nbytes;	/* total # bytes processed */
174 	} wterr, rderr;
175 };
176 
177 union mterrstat {
178 	struct scsi_tape_errors scsi_errstat;
179 	char _reserved_padding[256];
180 };
181 
182 /*
183  * Constants for mt_type byte.  These are the same
184  * for controllers compatible with the types listed.
185  */
186 #define	MT_ISTS		0x01		/* TS-11 */
187 #define	MT_ISHT		0x02		/* TM03 Massbus: TE16, TU45, TU77 */
188 #define	MT_ISTM		0x03		/* TM11/TE10 Unibus */
189 #define	MT_ISMT		0x04		/* TM78/TU78 Massbus */
190 #define	MT_ISUT		0x05		/* SI TU-45 emulation on Unibus */
191 #define	MT_ISCPC	0x06		/* SUN */
192 #define	MT_ISAR		0x07		/* SUN */
193 #define	MT_ISTMSCP	0x08		/* DEC TMSCP protocol (TU81, TK50) */
194 #define MT_ISCY		0x09		/* CCI Cipher */
195 #define MT_ISCT		0x0a		/* HP 1/4 tape */
196 #define MT_ISFHP	0x0b		/* HP 7980 1/2 tape */
197 #define MT_ISEXABYTE	0x0c		/* Exabyte */
198 #define MT_ISEXA8200	0x0c		/* Exabyte EXB-8200 */
199 #define MT_ISEXA8500	0x0d		/* Exabyte EXB-8500 */
200 #define MT_ISVIPER1	0x0e		/* Archive Viper-150 */
201 #define MT_ISPYTHON	0x0f		/* Archive Python (DAT) */
202 #define MT_ISHPDAT	0x10		/* HP 35450A DAT drive */
203 #define MT_ISMFOUR	0x11		/* M4 Data 1/2 9track drive */
204 #define MT_ISTK50	0x12		/* DEC SCSI TK50 */
205 #define MT_ISMT02	0x13		/* Emulex MT02 SCSI tape controller */
206 
207 /* mag tape io control commands */
208 #define	MTIOCTOP	_IOW('m', 1, struct mtop)	/* do a mag tape op */
209 #define	MTIOCGET	_IOR('m', 2, struct mtget)	/* get tape status */
210 /* these two do not appear to be used anywhere */
211 #define MTIOCIEOT	_IO('m', 3)			/* ignore EOT error */
212 #define MTIOCEEOT	_IO('m', 4)			/* enable EOT error */
213 /*
214  * When more SCSI-3 SSC (streaming device) devices are out there
215  * that support the full 32 byte type 2 structure, we'll have to
216  * rethink these ioctls to support all the entities they haul into
217  * the picture (64 bit blocks, logical file record numbers, etc..).
218  */
219 #define	MTIOCRDSPOS	_IOR('m', 5, u_int32_t)	/* get logical blk addr */
220 #define	MTIOCRDHPOS	_IOR('m', 6, u_int32_t)	/* get hardware blk addr */
221 #define	MTIOCSLOCATE	_IOW('m', 5, u_int32_t)	/* seek to logical blk addr */
222 #define	MTIOCHLOCATE	_IOW('m', 6, u_int32_t)	/* seek to hardware blk addr */
223 #define	MTIOCERRSTAT	_IOR('m', 7, union mterrstat)	/* get tape errors */
224 /*
225  * Set EOT model- argument is number of filemarks to end a tape with.
226  * Note that not all possible values will be accepted.
227  */
228 #define	MTIOCSETEOTMODEL	_IOW('m', 8, u_int32_t)
229 /* Get current EOT model */
230 #define	MTIOCGETEOTMODEL	_IOR('m', 8, u_int32_t)
231 
232 #ifndef _KERNEL
233 #define	DEFTAPE	"/dev/nsa0"
234 #endif
235 
236 #ifdef	_KERNEL
237 /*
238  * minor device number
239  */
240 
241 #define	T_UNIT		003		/* unit selection */
242 #define	T_NOREWIND	004		/* no rewind on close */
243 #define	T_DENSEL	030		/* density select */
244 #define	T_800BPI	000		/* select  800 bpi */
245 #define	T_1600BPI	010		/* select 1600 bpi */
246 #define	T_6250BPI	020		/* select 6250 bpi */
247 #define	T_BADBPI	030		/* undefined selection */
248 #endif
249 
250 #endif /* !_SYS_MTIO_H_ */
251