From c2466934dbc9e4e75d647aeb7ac8084734047094 Mon Sep 17 00:00:00 2001 From: Mike Pritchard Date: Mon, 12 Feb 1996 06:25:31 +0000 Subject: [PATCH] Added an i386/FreeBSD specific mtio(4) man page, adapted from the Lite-2 vax version. --- share/man/man4/man4.i386/Makefile | 3 +- share/man/man4/man4.i386/mtio.4 | 228 ++++++++++++++++++++++++++++++ share/man/man4/mtio.4 | 228 ++++++++++++++++++++++++++++++ 3 files changed, 458 insertions(+), 1 deletion(-) create mode 100644 share/man/man4/man4.i386/mtio.4 create mode 100644 share/man/man4/mtio.4 diff --git a/share/man/man4/man4.i386/Makefile b/share/man/man4/man4.i386/Makefile index 4ddf0af438df..29f0e5a32746 100644 --- a/share/man/man4/man4.i386/Makefile +++ b/share/man/man4/man4.i386/Makefile @@ -3,7 +3,7 @@ MAN4= aha.4 ahb.4 ahc.4 apm.4 ar.4 asc.4 bt.4 cx.4 cy.4 dgb.4 \ ed.4 gsc.4 fdc.4 fe.4 ie.4 io.4 \ joy.4 keyboard.4 labpc.4 lpt.4 matcd.4 mcd.4 mem.4 meteor.4 \ - mse.4 nca.4 npx.4 pcvt.4 qcam.4 scd.4 screen.4 sea.4 si.4 sio.4 \ + mse.4 mtio.4 nca.4 npx.4 pcvt.4 qcam.4 scd.4 screen.4 sea.4 si.4 sio.4 \ spkr.4 tw.4 uha.4 wd.4 MLINKS= aha.4 ../aha.4 @@ -31,6 +31,7 @@ MLINKS+= mcd.4 ../mcd.4 MLINKS+= mem.4 kmem.4 mem.4 ../mem.4 mem.4 ../kmem.4 MLINKS+= meteor.4 ../meteor.4 MLINKS+= mse.4 ../mse.4 +MLINKS+= mtio.4 ../mtio.4 MLINKS+= nca.4 ../nca.4 MLINKS+= npx.4 ../npx.4 MLINKS+= pcvt.4 ../pcvt.4 diff --git a/share/man/man4/man4.i386/mtio.4 b/share/man/man4/man4.i386/mtio.4 new file mode 100644 index 000000000000..76b43129c0eb --- /dev/null +++ b/share/man/man4/man4.i386/mtio.4 @@ -0,0 +1,228 @@ +.\" Copyright (c) 1996 +.\" Mike Pritchard . All rights reserved. +.\" +.\" 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 February 11, 1996 +.Dt MTIO 4 i386 +.Os FreeBSD 2.2 +.Sh NAME +.Nm mtio +.Nd +.Tn FreeBSD +magtape interface +.Sh DESCRIPTION +The special files +named +.Pa /dev/[nr]st* +refer to SCSI tape drives, +which may be attached to the system. +.Pa /dev/[nr]st*.ctl +are control devices that can be used to issue ioctls to the SCSI +tape driver to set parameters that are required to last beyond the +unmounting of a tape. +.Pp +.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 +Tapes can be written with either fixed length records or variable length +records. See +.Xr st 4 +for more information. 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 */ + +#if defined(__FreeBSD__) +/* Set block size for device. If device is a variable size dev */ +/* a non zero parameter will change the device to a fixed block size */ +/* device with block size set to that of the parameter passed in. */ +/* Resetting the block size to 0 will restore the device to a variable */ +/* block size device. */ + +#define MTSETBSIZ 10 + +/* Set density values for device. They are defined in the SCSI II spec */ +/* and range from 0 to 0x17. Sets the value for the opened mode only */ + +#define MTSETDNSTY 11 + +#define MTERASE 12 /* erase to EOM */ +#define MTEOD 13 /* Space to EOM */ +#define MTCOMP 14 /* select compression mode 0=off, 1=def */ +#define MTRETENS 15 /* re-tension tape */ + +#endif + +/* 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 */ +#if defined (__FreeBSD__) + daddr_t mt_blksiz; /* presently operating blocksize */ + daddr_t mt_density; /* presently operating density */ + daddr_t mt_comp; /* presently operating compression */ + daddr_t mt_blksiz0; /* blocksize for mode 0 */ + daddr_t mt_blksiz1; /* blocksize for mode 1 */ + daddr_t mt_blksiz2; /* blocksize for mode 2 */ + daddr_t mt_blksiz3; /* blocksize for mode 3 */ + daddr_t mt_density0; /* density for mode 0 */ + daddr_t mt_density1; /* density for mode 1 */ + daddr_t mt_density2; /* density for mode 2 */ + daddr_t mt_density3; /* density for mode 3 */ +/* the following are not yet implemented */ + u_char mt_comp0; /* compression type for mode 0 */ + u_char mt_comp1; /* compression type for mode 1 */ + u_char mt_comp2; /* compression type for mode 2 */ + u_char mt_comp3; /* compression type for mode 3 */ +#endif + 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 */ +#define MT_ISMFOUR 0x11 /* M4 Data 1/2 9track drive */ +#define MT_ISTK50 0x12 /* DEC SCSI TK50 */ +#define MT_ISMT02 0x13 /* Emulex MT02 SCSI tape controller */ + +/* 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/nrst0" +#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 +#endif /* _SYS_MTIO_H_ */ +.Ed +.Pp +.Sh FILES +.Bl -tag -width /dev/[nr]st* -compact +.It Pa /dev/[nr]st* +.El +.Sh SEE ALSO +.Xr mt 1 , +.Xr tar 1 , +.Xr st 4 +.Sh HISTORY +The +.Nm mtio +manual appeared in +.Bx 4.2 . +An i386 version first appeared in FreeBSD 2.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. diff --git a/share/man/man4/mtio.4 b/share/man/man4/mtio.4 new file mode 100644 index 000000000000..76b43129c0eb --- /dev/null +++ b/share/man/man4/mtio.4 @@ -0,0 +1,228 @@ +.\" Copyright (c) 1996 +.\" Mike Pritchard . All rights reserved. +.\" +.\" 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 February 11, 1996 +.Dt MTIO 4 i386 +.Os FreeBSD 2.2 +.Sh NAME +.Nm mtio +.Nd +.Tn FreeBSD +magtape interface +.Sh DESCRIPTION +The special files +named +.Pa /dev/[nr]st* +refer to SCSI tape drives, +which may be attached to the system. +.Pa /dev/[nr]st*.ctl +are control devices that can be used to issue ioctls to the SCSI +tape driver to set parameters that are required to last beyond the +unmounting of a tape. +.Pp +.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 +Tapes can be written with either fixed length records or variable length +records. See +.Xr st 4 +for more information. 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 */ + +#if defined(__FreeBSD__) +/* Set block size for device. If device is a variable size dev */ +/* a non zero parameter will change the device to a fixed block size */ +/* device with block size set to that of the parameter passed in. */ +/* Resetting the block size to 0 will restore the device to a variable */ +/* block size device. */ + +#define MTSETBSIZ 10 + +/* Set density values for device. They are defined in the SCSI II spec */ +/* and range from 0 to 0x17. Sets the value for the opened mode only */ + +#define MTSETDNSTY 11 + +#define MTERASE 12 /* erase to EOM */ +#define MTEOD 13 /* Space to EOM */ +#define MTCOMP 14 /* select compression mode 0=off, 1=def */ +#define MTRETENS 15 /* re-tension tape */ + +#endif + +/* 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 */ +#if defined (__FreeBSD__) + daddr_t mt_blksiz; /* presently operating blocksize */ + daddr_t mt_density; /* presently operating density */ + daddr_t mt_comp; /* presently operating compression */ + daddr_t mt_blksiz0; /* blocksize for mode 0 */ + daddr_t mt_blksiz1; /* blocksize for mode 1 */ + daddr_t mt_blksiz2; /* blocksize for mode 2 */ + daddr_t mt_blksiz3; /* blocksize for mode 3 */ + daddr_t mt_density0; /* density for mode 0 */ + daddr_t mt_density1; /* density for mode 1 */ + daddr_t mt_density2; /* density for mode 2 */ + daddr_t mt_density3; /* density for mode 3 */ +/* the following are not yet implemented */ + u_char mt_comp0; /* compression type for mode 0 */ + u_char mt_comp1; /* compression type for mode 1 */ + u_char mt_comp2; /* compression type for mode 2 */ + u_char mt_comp3; /* compression type for mode 3 */ +#endif + 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 */ +#define MT_ISMFOUR 0x11 /* M4 Data 1/2 9track drive */ +#define MT_ISTK50 0x12 /* DEC SCSI TK50 */ +#define MT_ISMT02 0x13 /* Emulex MT02 SCSI tape controller */ + +/* 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/nrst0" +#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 +#endif /* _SYS_MTIO_H_ */ +.Ed +.Pp +.Sh FILES +.Bl -tag -width /dev/[nr]st* -compact +.It Pa /dev/[nr]st* +.El +.Sh SEE ALSO +.Xr mt 1 , +.Xr tar 1 , +.Xr st 4 +.Sh HISTORY +The +.Nm mtio +manual appeared in +.Bx 4.2 . +An i386 version first appeared in FreeBSD 2.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.