[unix-history] / usr / src / share / man / man4 / man4.vax / mtio.4

.\" Copyright (c) 1983, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)mtio.4	8.1 (Berkeley) 6/5/93
.\"
.Dd June 5, 1993
.Dt MTIO 4 vax
.Os BSD 4.2
.Sh NAME
.Nm mtio
.Nd
.Tn UNIX
magtape interface
.Sh DESCRIPTION
The special files
named
.Pa /dev/mt0
and
.Pa /dev/rmt0
through
.Pa /dev/mt23
and
.Pa /dev/rmt23
refer to
.Tn UNIX
magtape drives,
which may be on the
.Tn MASSBUS
using the
.Tn TM03
formatter
.Xr ht 4 ,
or
.Tn TM78
formatter,
.Xr mt 4 ,
or on the
.Tn UNIBUS
using either the
.Tn TM11
or
.Tn TS11
formatters
.Xr tm 4 ,
.Tn TU45
compatible formatters,
.Xr ut 4 ,
or
.Xr ts 4 .
These devices are typical tape block devices,
see
.Xr physio 4 .
.Pp
The following table of the converntional device names
is applicable to any of the transport/controller pairs.
(But note that only 1600
.Tn BPI
is available with the
.Tn TS11 . )
.Bl -column "no-rewindxxx" "or lowest densityxx" "or lowest densityxx" "or lowest densityxx" -offset indent
	      800 BPI	      1600 BPI	      6500 BPI
.Em	or lowest density	or second density	or third density

Rewind	     mt0/rmt0	      mt8/rmt8	       mt16/rmt16
Rewind	     mt1/rmt1	      mt9/rmt9	       mt17/rmt17
Rewind	     mt2/rmt2	      mt10/rmt10	       mt18/rmt18
Rewind	     mt3/rmt3	      mt11/rmt11	       mt19/rmt19
No-rewind	    nmt4/nrmt4	    nmt12/nrmt12	    nmt20/nrmt20
No-rewind	    nmt5/nrmt5	    nmt13/nrmt13	    nmt21/nrmt21
No-rewind	    nmt6/nrmt6	    nmt14/nrmt14	    nmt22/nrmt22
No-rewind	    nmt7/nrmt7	    nmt15/nrmt15	    nmt23/nrmt32
.El
.Pp
The rewind devices automatically rewind
when the last requested read, write or seek has finished, or the end of the tape
has been reached. The letter
.Ql n
is usually prepended to
the name of the no-rewind devices.
.Pp
Unix tapes are written in multiples of 1024 byte block
records. Two end-of-file markers mark the end of a tape, and
one end-of-file marker marks the end of a tape file.
If the tape is not to be rewound it is positioned with the
head in between the two tape marks, where the next write
will over write the second end-of-file marker.
.Pp
All of the magtape devices may be manipulated with the
.Xr mt 1
command.
.Pp
A number of
.Xr ioctl 2
operations are available
on raw magnetic tape.
The following definitions are from
.Aq Pa sys/mtio.h :
.Bd  -literal
/*
 * Structures and definitions for mag tape io control commands
 */

/* structure for MTIOCTOP - mag tape op command */
struct	mtop	{
	short	mt_op;		/* operations defined below */
	daddr_t	mt_count;	/* how many of them */
};

/* operations */
#define MTWEOF	0	/* write an end-of-file record */
#define MTFSF	1	/* forward space file */
#define MTBSF	2	/* backward space file */
#define MTFSR	3	/* forward space record */
#define MTBSR	4	/* backward space record */
#define MTREW	5	/* rewind */
#define MTOFFL	6	/* rewind and put the drive offline */
#define MTNOP	7	/* no operation, sets status only */
#define MTCACHE 8	/* enable controller cache */
#define MTNOCACHE 9	/* disable controller cache */

/* structure for MTIOCGET - mag tape get status command */

struct	mtget	{
	short	mt_type;	/* type of magtape device */
/* the following two registers are grossly device dependent */
	short	mt_dsreg;	/* ``drive status'' register */
	short	mt_erreg;	/* ``error'' register */
/* end device-dependent registers */
	short	mt_resid;	/* residual count */
/* the following two are not yet implemented */
	daddr_t	mt_fileno;	/* file number of current position */
	daddr_t	mt_blkno;	/* block number of current position */
/* end not yet implemented */
};

/*
 * Constants for mt_type byte.  These are the same
 * for controllers compatible with the types listed.
 */
#define	MT_ISTS		0x01		/* TS-11 */
#define	MT_ISHT		0x02		/* TM03 Massbus: TE16, TU45, TU77 */
#define	MT_ISTM		0x03		/* TM11/TE10 Unibus */
#define	MT_ISMT		0x04		/* TM78/TU78 Massbus */
#define	MT_ISUT		0x05		/* SI TU-45 emulation on Unibus */
#define	MT_ISCPC	0x06		/* SUN */
#define	MT_ISAR		0x07		/* SUN */
#define	MT_ISTMSCP	0x08		/* DEC TMSCP protocol (TU81, TK50) */
#define MT_ISCY 	0x09		/* CCI Cipher */
#define MT_ISCT 	0x0a		/* HP 1/4 tape */
#define MT_ISFHP	0x0b		/* HP 7980 1/2 tape */
#define MT_ISEXABYTE	0x0c		/* Exabyte */
#define MT_ISEXA8200	0x0c		/* Exabyte EXB-8200 */
#define MT_ISEXA8500	0x0d		/* Exabyte EXB-8500 */
#define MT_ISVIPER1	0x0e		/* Archive Viper-150 */
#define MT_ISPYTHON	0x0f		/* Archive Python (DAT) */
#define MT_ISHPDAT	0x10		/* HP 35450A DAT drive */

/* mag tape io control commands */
#define	MTIOCTOP	_IOW('m', 1, struct mtop)	/* do a mag tape op */
#define	MTIOCGET	_IOR('m', 2, struct mtget)	/* get tape status */
#define MTIOCIEOT	_IO('m', 3)			/* ignore EOT error */
#define MTIOCEEOT	_IO('m', 4)			/* enable EOT error */

#ifndef KERNEL
#define	DEFTAPE	"/dev/rmt12"
#endif

#ifdef	KERNEL
/*
 * minor device number
 */

#define	T_UNIT		003		/* unit selection */
#define	T_NOREWIND	004		/* no rewind on close */
#define	T_DENSEL	030		/* density select */
#define	T_800BPI	000		/* select  800 bpi */
#define	T_1600BPI	010		/* select 1600 bpi */
#define	T_6250BPI	020		/* select 6250 bpi */
#define	T_BADBPI	030		/* undefined selection */
#endif
.Ed
.Pp
.Sh FILES
.Bl -tag -width /dev/rmt? -compact
.It Pa /dev/mt?
.It Pa /dev/rmt?
.El
.Sh SEE ALSO
.Xr mt 1 ,
.Xr tar 1 ,
.Xr tp 1 ,
.Xr ht 4 ,
.Xr tm 4 ,
.Xr ts 4 ,
.Xr mt 4 ,
.Xr ut 4
.Sh HISTORY
The
.Nm mtio
manual appeared in
.Bx 4.2 .
.Sh BUGS
The status should be returned in a device independent format.
.Pp
The special file naming should be redone in a more consistent and
understandable manner.
Commit	Line	Data
5ebe7d4b KB	1	.\" Copyright (c) 1983, 1991, 1993
5ebe7d4b KB	2	.\" The Regents of the University of California. All rights reserved.
79540a66	3	.\"
ad787160 C	4	.\" Redistribution and use in source and binary forms, with or without
	5	.\" modification, are permitted provided that the following conditions
	6	.\" are met:
	7	.\" 1. Redistributions of source code must retain the above copyright
	8	.\" notice, this list of conditions and the following disclaimer.
	9	.\" 2. Redistributions in binary form must reproduce the above copyright
	10	.\" notice, this list of conditions and the following disclaimer in the
	11	.\" documentation and/or other materials provided with the distribution.
	12	.\" 3. All advertising materials mentioning features or use of this software
	13	.\" must display the following acknowledgement:
	14	.\" This product includes software developed by the University of
	15	.\" California, Berkeley and its contributors.
	16	.\" 4. Neither the name of the University nor the names of its contributors
	17	.\" may be used to endorse or promote products derived from this software
	18	.\" without specific prior written permission.
615bd8a3	19	.\"
ad787160 C	20	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	21	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	22	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	23	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	24	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	25	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	26	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	27	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	28	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	29	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	30	.\" SUCH DAMAGE.
79540a66	31	.\"
ad787160 C	32	.\" @(#)mtio.4 8.1 (Berkeley) 6/5/93
	33	.\"
	34	.Dd June 5, 1993
9903e566 CL	35	.Dt MTIO 4 vax
	36	.Os BSD 4.2
	37	.Sh NAME
	38	.Nm mtio
	39	.Nd
	40	.Tn UNIX
	41	magtape interface
	42	.Sh DESCRIPTION
	43	The special files
	44	named
	45	.Pa /dev/mt0
79540a66	46	and
9903e566 CL	47	.Pa /dev/rmt0
	48	through
	49	.Pa /dev/mt23
	50	and
	51	.Pa /dev/rmt23
	52	refer to
	53	.Tn UNIX
	54	magtape drives,
	55	which may be on the
	56	.Tn MASSBUS
	57	using the
	58	.Tn TM03
	59	formatter
	60	.Xr ht 4 ,
	61	or
	62	.Tn TM78
	63	formatter,
	64	.Xr mt 4 ,
	65	or on the
	66	.Tn UNIBUS
	67	using either the
	68	.Tn TM11
	69	or
	70	.Tn TS11
	71	formatters
	72	.Xr tm 4 ,
	73	.Tn TU45
	74	compatible formatters,
	75	.Xr ut 4 ,
	76	or
	77	.Xr ts 4 .
	78	These devices are typical tape block devices,
	79	see
	80	.Xr physio 4 .
	81	.Pp
	82	The following table of the converntional device names
	83	is applicable to any of the transport/controller pairs.
	84	(But note that only 1600
	85	.Tn BPI
	86	is available with the
	87	.Tn TS11 . )
	88	.Bl -column "no-rewindxxx" "or lowest densityxx" "or lowest densityxx" "or lowest densityxx" -offset indent
	89	800 BPI 1600 BPI 6500 BPI
	90	.Em or lowest density or second density or third density
	91
	92	Rewind mt0/rmt0 mt8/rmt8 mt16/rmt16
	93	Rewind mt1/rmt1 mt9/rmt9 mt17/rmt17
	94	Rewind mt2/rmt2 mt10/rmt10 mt18/rmt18
	95	Rewind mt3/rmt3 mt11/rmt11 mt19/rmt19
	96	No-rewind nmt4/nrmt4 nmt12/nrmt12 nmt20/nrmt20
	97	No-rewind nmt5/nrmt5 nmt13/nrmt13 nmt21/nrmt21
	98	No-rewind nmt6/nrmt6 nmt14/nrmt14 nmt22/nrmt22
	99	No-rewind nmt7/nrmt7 nmt15/nrmt15 nmt23/nrmt32
	100	.El
	101	.Pp
	102	The rewind devices automatically rewind
	103	when the last requested read, write or seek has finished, or the end of the tape
	104	has been reached. The letter
	105	.Ql n
	106	is usually prepended to
	107	the name of the no-rewind devices.
	108	.Pp
	109	Unix tapes are written in multiples of 1024 byte block
	110	records. Two end-of-file markers mark the end of a tape, and
111	one end-of-file marker marks the end of a tape file.
112	If the tape is not to be rewound it is positioned with the
113	head in between the two tape marks, where the next write
114	will over write the second end-of-file marker.
115	.Pp
116	All of the magtape devices may be manipulated with the
117	.Xr mt 1
118	command.
119	.Pp
120	A number of
121	.Xr ioctl 2
122	operations are available
79540a66 KM	123	on raw magnetic tape.
79540a66 KM	124	The following definitions are from
9903e566 CL	125	.Aq Pa sys/mtio.h :
9903e566 CL	126	.Bd -literal
79540a66 KM	127	/*
	128	* Structures and definitions for mag tape io control commands
	129	*/
	130
	131	/* structure for MTIOCTOP - mag tape op command */
	132	struct mtop {
	133	short mt_op; /* operations defined below */
	134	daddr_t mt_count; /* how many of them */
	135	};
	136
	137	/* operations */
	138	#define MTWEOF 0 /* write an end-of-file record */
	139	#define MTFSF 1 /* forward space file */
	140	#define MTBSF 2 /* backward space file */
	141	#define MTFSR 3 /* forward space record */
	142	#define MTBSR 4 /* backward space record */
	143	#define MTREW 5 /* rewind */
	144	#define MTOFFL 6 /* rewind and put the drive offline */
	145	#define MTNOP 7 /* no operation, sets status only */
9903e566 CL	146	#define MTCACHE 8 /* enable controller cache */
9903e566 CL	147	#define MTNOCACHE 9 /* disable controller cache */
79540a66 KM	148
	149	/* structure for MTIOCGET - mag tape get status command */
	150
	151	struct mtget {
	152	short mt_type; /* type of magtape device */
	153	/* the following two registers are grossly device dependent */
	154	short mt_dsreg; /* ``drive status'' register */
	155	short mt_erreg; /* ``error'' register */
	156	/* end device-dependent registers */
	157	short mt_resid; /* residual count */
	158	/* the following two are not yet implemented */
	159	daddr_t mt_fileno; /* file number of current position */
	160	daddr_t mt_blkno; /* block number of current position */
	161	/* end not yet implemented */
	162	};
	163
	164	/*
249fe986	165	* Constants for mt_type byte. These are the same
9903e566	166	* for controllers compatible with the types listed.
79540a66	167	*/
249fe986 MK	168	#define MT_ISTS 0x01 /* TS-11 */
	169	#define MT_ISHT 0x02 /* TM03 Massbus: TE16, TU45, TU77 */
	170	#define MT_ISTM 0x03 /* TM11/TE10 Unibus */
	171	#define MT_ISMT 0x04 /* TM78/TU78 Massbus */
	172	#define MT_ISUT 0x05 /* SI TU-45 emulation on Unibus */
	173	#define MT_ISCPC 0x06 /* SUN */
	174	#define MT_ISAR 0x07 /* SUN */
	175	#define MT_ISTMSCP 0x08 /* DEC TMSCP protocol (TU81, TK50) */
9903e566 CL	176	#define MT_ISCY 0x09 /* CCI Cipher */
	177	#define MT_ISCT 0x0a /* HP 1/4 tape */
	178	#define MT_ISFHP 0x0b /* HP 7980 1/2 tape */
	179	#define MT_ISEXABYTE 0x0c /* Exabyte */
	180	#define MT_ISEXA8200 0x0c /* Exabyte EXB-8200 */
	181	#define MT_ISEXA8500 0x0d /* Exabyte EXB-8500 */
	182	#define MT_ISVIPER1 0x0e /* Archive Viper-150 */
	183	#define MT_ISPYTHON 0x0f /* Archive Python (DAT) */
	184	#define MT_ISHPDAT 0x10 /* HP 35450A DAT drive */
79540a66 KM	185
79540a66 KM	186	/* mag tape io control commands */
9903e566 CL	187	#define MTIOCTOP _IOW('m', 1, struct mtop) /* do a mag tape op */
	188	#define MTIOCGET _IOR('m', 2, struct mtget) /* get tape status */
	189	#define MTIOCIEOT _IO('m', 3) /* ignore EOT error */
	190	#define MTIOCEEOT _IO('m', 4) /* enable EOT error */
79540a66 KM	191
	192	#ifndef KERNEL
	193	#define DEFTAPE "/dev/rmt12"
	194	#endif
9903e566 CL	195
	196	#ifdef KERNEL
	197	/*
	198	* minor device number
	199	*/
	200
	201	#define T_UNIT 003 /* unit selection */
	202	#define T_NOREWIND 004 /* no rewind on close */
	203	#define T_DENSEL 030 /* density select */
	204	#define T_800BPI 000 /* select 800 bpi */
	205	#define T_1600BPI 010 /* select 1600 bpi */
	206	#define T_6250BPI 020 /* select 6250 bpi */
	207	#define T_BADBPI 030 /* undefined selection */
	208	#endif
	209	.Ed
	210	.Pp
	211	.Sh FILES
	212	.Bl -tag -width /dev/rmt? -compact
	213	.It Pa /dev/mt?
	214	.It Pa /dev/rmt?
	215	.El
	216	.Sh SEE ALSO
	217	.Xr mt 1 ,
	218	.Xr tar 1 ,
	219	.Xr tp 1 ,
	220	.Xr ht 4 ,
	221	.Xr tm 4 ,
	222	.Xr ts 4 ,
	223	.Xr mt 4 ,
	224	.Xr ut 4
	225	.Sh HISTORY
	226	The
	227	.Nm mtio
	228	manual appeared in
	229	.Bx 4.2 .
	230	.Sh BUGS
79540a66	231	The status should be returned in a device independent format.
9903e566	232	.Pp
249fe986 MK	233	The special file naming should be redone in a more consistent and
249fe986 MK	234	understandable manner.