[apple/xnu.git] / bsd / sys / mtio.h

/*
 * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
/*
 * Copyright (c) 1982, 1986, 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.h	8.1 (Berkeley) 6/2/93
 */

#ifndef	_SYS_MTIO_H_
#define	_SYS_MTIO_H_

#include <sys/appleapiopts.h>
#include <sys/cdefs.h>

#ifdef	__APPLE_API_OBSOLETE

/*
 * Structures and definitions for mag tape io control commands
 */

/* structure for MTIOCTOP - mag tape op command */
/* LP64todo - not 64-bit safe */
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 MTRETEN		8	/* retension */
#define MTERASE		9	/* erase entire tape */
#define MTEOM		10	/* forward to end of media */
#define MTNBSF		11	/* backward space to beginning of file */
#define MTCACHE		12	/* enable controller cache */
#define MTNOCACHE	13	/* disable controller cache */
#define MTSETBSIZ	14	/* set block size; 0 for variable */
#define MTSETDNSTY	15	/* set density code for current mode */

/* structure for MTIOCGET - mag tape get status command */
/* LP64todo - not 64-bit safe */
struct mtget {
	short	mt_type;	/* type of magtape device */
/* the following two registers are grossly device dependent */
	u_short	mt_dsreg;	/* ``drive status'' register. SCSI sense byte 0x02.  */
	u_short	mt_erreg;	/* ``error'' register. SCSI sense byte 0x0C. */
	u_short mt_ext_err0;	/* SCSI sense bytes 0x13..0x14 */
	u_short mt_ext_err1;	/* SCSI sense bytes 0x15..0x16 */
/* 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 */
	daddr_t	mt_blksiz;	/* current block size */
	daddr_t	mt_density;	/* current density code */
	daddr_t	mt_mblksiz[4];	/* block size for different modes */
	daddr_t mt_mdensity[4];	/* density codes for different modes */
};

/*
 * 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_ISWANGTEK	0x11		/* WANGTEK 5150ES */
#define MT_ISCALIPER	0x12		/* Caliper CP150 */
#define MT_ISWTEK5099	0x13		/* WANGTEK 5099ES */
#define MT_ISVIPER2525	0x14		/* Archive Viper 2525 */
#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 */
#define MT_ISGS		0x14		/* Generic SCSI Tape */

/* 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/rst0"
#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	/* __APPLE_API_OBSOLETE */

#endif	/* !_SYS_MTIO_H_ */
Commit	Line	Data
1c79356b	1	/*
5d5c5d0d A	2	* Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
5d5c5d0d A	3	*
8f6c56a5	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
8f6c56a5 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
	14	*
	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
8ad349bb	24	* limitations under the License.
8f6c56a5 A	25	*
8f6c56a5 A	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
	29	/*
	30	* Copyright (c) 1982, 1986, 1993
	31	* The Regents of the University of California. All rights reserved.
	32	*
	33	* Redistribution and use in source and binary forms, with or without
	34	* modification, are permitted provided that the following conditions
	35	* are met:
	36	* 1. Redistributions of source code must retain the above copyright
	37	* notice, this list of conditions and the following disclaimer.
	38	* 2. Redistributions in binary form must reproduce the above copyright
	39	* notice, this list of conditions and the following disclaimer in the
	40	* documentation and/or other materials provided with the distribution.
	41	* 3. All advertising materials mentioning features or use of this software
	42	* must display the following acknowledgement:
	43	* This product includes software developed by the University of
	44	* California, Berkeley and its contributors.
	45	* 4. Neither the name of the University nor the names of its contributors
	46	* may be used to endorse or promote products derived from this software
	47	* without specific prior written permission.
	48	*
	49	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	50	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	51	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	52	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	53	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	54	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	55	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	56	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	57	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	58	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	59	* SUCH DAMAGE.
	60	*
	61	* @(#)mtio.h 8.1 (Berkeley) 6/2/93
	62	*/
	63
	64	#ifndef _SYS_MTIO_H_
9bccf70c A	65	#define _SYS_MTIO_H_
	66
	67	#include <sys/appleapiopts.h>
91447636	68	#include <sys/cdefs.h>
9bccf70c A	69
9bccf70c A	70	#ifdef __APPLE_API_OBSOLETE
1c79356b A	71
	72	/*
	73	* Structures and definitions for mag tape io control commands
	74	*/
	75
	76	/* structure for MTIOCTOP - mag tape op command */
91447636	77	/* LP64todo - not 64-bit safe */
1c79356b A	78	struct mtop {
	79	short mt_op; /* operations defined below */
	80	daddr_t mt_count; /* how many of them */
	81	};
	82
	83	/* operations */
	84	#define MTWEOF 0 /* write an end-of-file record */
	85	#define MTFSF 1 /* forward space file */
	86	#define MTBSF 2 /* backward space file */
	87	#define MTFSR 3 /* forward space record */
	88	#define MTBSR 4 /* backward space record */
	89	#define MTREW 5 /* rewind */
	90	#define MTOFFL 6 /* rewind and put the drive offline */
	91	#define MTNOP 7 /* no operation, sets status only */
	92	#define MTRETEN 8 /* retension */
	93	#define MTERASE 9 /* erase entire tape */
	94	#define MTEOM 10 /* forward to end of media */
	95	#define MTNBSF 11 /* backward space to beginning of file */
	96	#define MTCACHE 12 /* enable controller cache */
	97	#define MTNOCACHE 13 /* disable controller cache */
	98	#define MTSETBSIZ 14 /* set block size; 0 for variable */
	99	#define MTSETDNSTY 15 /* set density code for current mode */
	100
	101	/* structure for MTIOCGET - mag tape get status command */
91447636	102	/* LP64todo - not 64-bit safe */
1c79356b A	103	struct mtget {
	104	short mt_type; /* type of magtape device */
	105	/* the following two registers are grossly device dependent */
	106	u_short mt_dsreg; /* ``drive status'' register. SCSI sense byte 0x02. */
	107	u_short mt_erreg; /* ``error'' register. SCSI sense byte 0x0C. */
	108	u_short mt_ext_err0; /* SCSI sense bytes 0x13..0x14 */
	109	u_short mt_ext_err1; /* SCSI sense bytes 0x15..0x16 */
	110	/* end device-dependent registers */
	111	short mt_resid; /* residual count */
	112	/* the following two are not yet implemented */
	113	daddr_t mt_fileno; /* file number of current position */
	114	daddr_t mt_blkno; /* block number of current position */
	115	/* end not yet implemented */
	116	daddr_t mt_blksiz; /* current block size */
	117	daddr_t mt_density; /* current density code */
	118	daddr_t mt_mblksiz[4]; /* block size for different modes */
	119	daddr_t mt_mdensity[4]; /* density codes for different modes */
	120	};
	121
	122	/*
	123	* Constants for mt_type byte. These are the same
	124	* for controllers compatible with the types listed.
	125	*/
	126	#define MT_ISTS 0x01 /* TS-11 */
	127	#define MT_ISHT 0x02 /* TM03 Massbus: TE16, TU45, TU77 */
	128	#define MT_ISTM 0x03 /* TM11/TE10 Unibus */
	129	#define MT_ISMT 0x04 /* TM78/TU78 Massbus */
	130	#define MT_ISUT 0x05 /* SI TU-45 emulation on Unibus */
	131	#define MT_ISCPC 0x06 /* SUN */
	132	#define MT_ISAR 0x07 /* SUN */
	133	#define MT_ISTMSCP 0x08 /* DEC TMSCP protocol (TU81, TK50) */
	134	#define MT_ISCY 0x09 /* CCI Cipher */
	135	#define MT_ISCT 0x0a /* HP 1/4 tape */
	136	#define MT_ISFHP 0x0b /* HP 7980 1/2 tape */
	137	#define MT_ISEXABYTE 0x0c /* Exabyte */
	138	#define MT_ISEXA8200 0x0c /* Exabyte EXB-8200 */
	139	#define MT_ISEXA8500 0x0d /* Exabyte EXB-8500 */
	140	#define MT_ISVIPER1 0x0e /* Archive Viper-150 */
	141	#define MT_ISPYTHON 0x0f /* Archive Python (DAT) */
	142	#define MT_ISHPDAT 0x10 /* HP 35450A DAT drive */
	143	#define MT_ISWANGTEK 0x11 /* WANGTEK 5150ES */
	144	#define MT_ISCALIPER 0x12 /* Caliper CP150 */
	145	#define MT_ISWTEK5099 0x13 /* WANGTEK 5099ES */
	146	#define MT_ISVIPER2525 0x14 /* Archive Viper 2525 */
	147	#define MT_ISMFOUR 0x11 /* M4 Data 1/2 9track drive */
	148	#define MT_ISTK50 0x12 /* DEC SCSI TK50 */
	149	#define MT_ISMT02 0x13 /* Emulex MT02 SCSI tape controller */
	150	#define MT_ISGS 0x14 /* Generic SCSI Tape */
	151
	152	/* mag tape io control commands */
	153	#define MTIOCTOP _IOW('m', 1, struct mtop) /* do a mag tape op */
	154	#define MTIOCGET _IOR('m', 2, struct mtget) /* get tape status */
	155	#define MTIOCIEOT _IO('m', 3) /* ignore EOT error */
	156	#define MTIOCEEOT _IO('m', 4) /* enable EOT error */
	157
	158	#ifndef KERNEL
	159	#define DEFTAPE "/dev/rst0"
	160	#endif
	161
	162	#ifdef KERNEL
	163	/*
	164	* minor device number
	165	*/
	166
167	#define T_UNIT 003 /* unit selection */
168	#define T_NOREWIND 004 /* no rewind on close */
169	#define T_DENSEL 030 /* density select */
170	#define T_800BPI 000 /* select 800 bpi */
171	#define T_1600BPI 010 /* select 1600 bpi */
172	#define T_6250BPI 020 /* select 6250 bpi */
173	#define T_BADBPI 030 /* undefined selection */
174	#endif
9bccf70c A	175
	176	#endif /* __APPLE_API_OBSOLETE */
	177
1c79356b	178	#endif /* !_SYS_MTIO_H_ */