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

/*
 * Copyright (c) 2000-2002 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) 1997 Apple Computer, Inc. All Rights Reserved */
/*-
 * Copyright (c) 1982, 1986, 1990, 1993, 1994
 *	The Regents of the University of California.  All rights reserved.
 * (c) UNIX System Laboratories, Inc.
 * All or some portions of this file are derived from material licensed
 * to the University of California by American Telephone and Telegraph
 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
 * the permission of UNIX System Laboratories, Inc.
 *
 * 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.
 *
 *	@(#)ttycom.h	8.1 (Berkeley) 3/28/94
 */

#ifndef	_SYS_TTYCOM_H_
#define	_SYS_TTYCOM_H_

#include <sys/ioccom.h>

/*
 * Tty ioctl's except for those supported only for backwards compatibility
 * with the old tty driver.
 */

/*
 * Window/terminal size structure.  This information is stored by the kernel
 * in order to provide a consistent interface, but is not used by the kernel.
 */
struct winsize {
	unsigned short	ws_row;		/* rows, in characters */
	unsigned short	ws_col;		/* columns, in characters */
	unsigned short	ws_xpixel;	/* horizontal size, pixels */
	unsigned short	ws_ypixel;	/* vertical size, pixels */
};

#define	TIOCMODG	_IOR('t', 3, int)	/* get modem control state */
#define	TIOCMODS	_IOW('t', 4, int)	/* set modem control state */
#define		TIOCM_LE	0001		/* line enable */
#define		TIOCM_DTR	0002		/* data terminal ready */
#define		TIOCM_RTS	0004		/* request to send */
#define		TIOCM_ST	0010		/* secondary transmit */
#define		TIOCM_SR	0020		/* secondary receive */
#define		TIOCM_CTS	0040		/* clear to send */
#define		TIOCM_CAR	0100		/* carrier detect */
#define		TIOCM_CD	TIOCM_CAR
#define		TIOCM_RNG	0200		/* ring */
#define		TIOCM_RI	TIOCM_RNG
#define		TIOCM_DSR	0400		/* data set ready */
						/* 8-10 compat */
#define	TIOCEXCL	 _IO('t', 13)		/* set exclusive use of tty */
#define	TIOCNXCL	 _IO('t', 14)		/* reset exclusive use of tty */
						/* 15 unused */
#define	TIOCFLUSH	_IOW('t', 16, int)	/* flush buffers */
						/* 17-18 compat */
#define	TIOCGETA	_IOR('t', 19, struct termios) /* get termios struct */
#define	TIOCSETA	_IOW('t', 20, struct termios) /* set termios struct */
#define	TIOCSETAW	_IOW('t', 21, struct termios) /* drain output, set */
#define	TIOCSETAF	_IOW('t', 22, struct termios) /* drn out, fls in, set */
#ifdef KERNEL
#define	TIOCGETA_64	_IOR('t', 19, struct user_termios)
#define	TIOCSETA_64	_IOW('t', 20, struct user_termios)
#define	TIOCSETAW_64	_IOW('t', 21, struct user_termios)
#define	TIOCSETAF_64	_IOW('t', 22, struct user_termios)
#endif	/* KERNEL */
#define	TIOCGETD	_IOR('t', 26, int)	/* get line discipline */
#define	TIOCSETD	_IOW('t', 27, int)	/* set line discipline */
#define	TIOCIXON	 _IO('t', 129)		/* internal input VSTART */
#define	TIOCIXOFF	 _IO('t', 128)		/* internal input VSTOP */
						/* 127-124 compat */
#define	TIOCSBRK	 _IO('t', 123)		/* set break bit */
#define	TIOCCBRK	 _IO('t', 122)		/* clear break bit */
#define	TIOCSDTR	 _IO('t', 121)		/* set data terminal ready */
#define	TIOCCDTR	 _IO('t', 120)		/* clear data terminal ready */
#define	TIOCGPGRP	_IOR('t', 119, int)	/* get pgrp of tty */
#define	TIOCSPGRP	_IOW('t', 118, int)	/* set pgrp of tty */
						/* 117-116 compat */
#define	TIOCOUTQ	_IOR('t', 115, int)	/* output queue size */
#define	TIOCSTI		_IOW('t', 114, char)	/* simulate terminal input */
#define	TIOCNOTTY	 _IO('t', 113)		/* void tty association */
#define	TIOCPKT		_IOW('t', 112, int)	/* pty: set/clear packet mode */
#define		TIOCPKT_DATA		0x00	/* data packet */
#define		TIOCPKT_FLUSHREAD	0x01	/* flush packet */
#define		TIOCPKT_FLUSHWRITE	0x02	/* flush packet */
#define		TIOCPKT_STOP		0x04	/* stop output */
#define		TIOCPKT_START		0x08	/* start output */
#define		TIOCPKT_NOSTOP		0x10	/* no more ^S, ^Q */
#define		TIOCPKT_DOSTOP		0x20	/* now do ^S ^Q */
#define		TIOCPKT_IOCTL		0x40	/* state change of pty driver */
#define	TIOCSTOP	 _IO('t', 111)		/* stop output, like ^S */
#define	TIOCSTART	 _IO('t', 110)		/* start output, like ^Q */
#define	TIOCMSET	_IOW('t', 109, int)	/* set all modem bits */
#define	TIOCMBIS	_IOW('t', 108, int)	/* bis modem bits */
#define	TIOCMBIC	_IOW('t', 107, int)	/* bic modem bits */
#define	TIOCMGET	_IOR('t', 106, int)	/* get all modem bits */
#define	TIOCREMOTE	_IOW('t', 105, int)	/* remote input editing */
#define	TIOCGWINSZ	_IOR('t', 104, struct winsize)	/* get window size */
#define	TIOCSWINSZ	_IOW('t', 103, struct winsize)	/* set window size */
#define	TIOCUCNTL	_IOW('t', 102, int)	/* pty: set/clr usr cntl mode */
#define	TIOCSTAT	 _IO('t', 101)		/* simulate ^T status message */
#define		UIOCCMD(n)	_IO('u', n)	/* usr cntl op "n" */
#define	TIOCSCONS	_IO('t', 99)		/* 4.2 compatibility */
#define	TIOCCONS	_IOW('t', 98, int)	/* become virtual console */
#define	TIOCSCTTY	 _IO('t', 97)		/* become controlling tty */
#define	TIOCEXT		_IOW('t', 96, int)	/* pty: external processing */
#define	TIOCSIG		 _IO('t', 95)		/* pty: generate signal */
#define	TIOCDRAIN	 _IO('t', 94)		/* wait till output drained */
#define	TIOCMSDTRWAIT	_IOW('t', 91, int)	/* modem: set wait on close */
#define	TIOCMGDTRWAIT	_IOR('t', 90, int)	/* modem: get wait on close */
#define	TIOCTIMESTAMP	_IOR('t', 89, struct timeval)	/* enable/get timestamp
						 * of last input event */
#define	TIOCDCDTIMESTAMP _IOR('t', 88, struct timeval)	/* enable/get timestamp
						 * of last DCd rise */
#ifdef KERNEL
#define	TIOCTIMESTAMP_64	_IOR('t', 89, struct user_timeval)
#define	TIOCDCDTIMESTAMP_64	_IOR('t', 88, struct user_timeval)
#endif
#define	TIOCSDRAINWAIT	_IOW('t', 87, int)	/* set ttywait timeout */
#define	TIOCGDRAINWAIT	_IOR('t', 86, int)	/* get ttywait timeout */
#define	TIOCDSIMICROCODE _IO('t', 85)		/* download microcode to
						 * DSI Softmodem */
#define TIOCPTYGRANT	_IO('t', 84)		/* grantpt(3) */
#define TIOCPTYGNAME	_IOC(IOC_OUT, 't', 83, 128)	/* ptsname(3) */
#define TIOCPTYUNLK	_IO('t', 82)		/* unlockpt(3) */

#define	TTYDISC		0		/* termios tty line discipline */
#define	TABLDISC	3		/* tablet discipline */
#define	SLIPDISC	4		/* serial IP discipline */
#define	PPPDISC		5		/* PPP discipline */

#endif /* !_SYS_TTYCOM_H_ */
Commit	Line	Data
1c79356b	1	/*
5d5c5d0d A	2	* Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
5d5c5d0d A	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/* Copyright (c) 1997 Apple Computer, Inc. All Rights Reserved */
	29	/*-
	30	* Copyright (c) 1982, 1986, 1990, 1993, 1994
	31	* The Regents of the University of California. All rights reserved.
	32	* (c) UNIX System Laboratories, Inc.
	33	* All or some portions of this file are derived from material licensed
	34	* to the University of California by American Telephone and Telegraph
	35	* Co. or Unix System Laboratories, Inc. and are reproduced herein with
	36	* the permission of UNIX System Laboratories, Inc.
	37	*
	38	* Redistribution and use in source and binary forms, with or without
	39	* modification, are permitted provided that the following conditions
	40	* are met:
	41	* 1. Redistributions of source code must retain the above copyright
	42	* notice, this list of conditions and the following disclaimer.
	43	* 2. Redistributions in binary form must reproduce the above copyright
	44	* notice, this list of conditions and the following disclaimer in the
	45	* documentation and/or other materials provided with the distribution.
	46	* 3. All advertising materials mentioning features or use of this software
	47	* must display the following acknowledgement:
	48	* This product includes software developed by the University of
	49	* California, Berkeley and its contributors.
	50	* 4. Neither the name of the University nor the names of its contributors
	51	* may be used to endorse or promote products derived from this software
	52	* without specific prior written permission.
	53	*
	54	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	55	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	56	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	57	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	58	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	59	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	60	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	61	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	62	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	63	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	64	* SUCH DAMAGE.
	65	*
	66	* @(#)ttycom.h 8.1 (Berkeley) 3/28/94
	67	*/
	68
	69	#ifndef _SYS_TTYCOM_H_
	70	#define _SYS_TTYCOM_H_
	71
	72	#include <sys/ioccom.h>
	73
	74	/*
	75	* Tty ioctl's except for those supported only for backwards compatibility
	76	* with the old tty driver.
	77	*/
	78
	79	/*
	80	* Window/terminal size structure. This information is stored by the kernel
	81	* in order to provide a consistent interface, but is not used by the kernel.
	82	*/
	83	struct winsize {
	84	unsigned short ws_row; /* rows, in characters */
	85	unsigned short ws_col; /* columns, in characters */
	86	unsigned short ws_xpixel; /* horizontal size, pixels */
	87	unsigned short ws_ypixel; /* vertical size, pixels */
	88	};
	89
	90	#define TIOCMODG _IOR('t', 3, int) /* get modem control state */
91	#define TIOCMODS _IOW('t', 4, int) /* set modem control state */
92	#define TIOCM_LE 0001 /* line enable */
93	#define TIOCM_DTR 0002 /* data terminal ready */
94	#define TIOCM_RTS 0004 /* request to send */
95	#define TIOCM_ST 0010 /* secondary transmit */
96	#define TIOCM_SR 0020 /* secondary receive */
97	#define TIOCM_CTS 0040 /* clear to send */
98	#define TIOCM_CAR 0100 /* carrier detect */
99	#define TIOCM_CD TIOCM_CAR
100	#define TIOCM_RNG 0200 /* ring */
101	#define TIOCM_RI TIOCM_RNG
102	#define TIOCM_DSR 0400 /* data set ready */
103	/* 8-10 compat */
104	#define TIOCEXCL _IO('t', 13) /* set exclusive use of tty */
105	#define TIOCNXCL _IO('t', 14) /* reset exclusive use of tty */
106	/* 15 unused */
107	#define TIOCFLUSH _IOW('t', 16, int) /* flush buffers */
108	/* 17-18 compat */
109	#define TIOCGETA _IOR('t', 19, struct termios) /* get termios struct */
110	#define TIOCSETA _IOW('t', 20, struct termios) /* set termios struct */
111	#define TIOCSETAW _IOW('t', 21, struct termios) /* drain output, set */
112	#define TIOCSETAF _IOW('t', 22, struct termios) /* drn out, fls in, set */
91447636 A	113	#ifdef KERNEL
	114	#define TIOCGETA_64 _IOR('t', 19, struct user_termios)
	115	#define TIOCSETA_64 _IOW('t', 20, struct user_termios)
	116	#define TIOCSETAW_64 _IOW('t', 21, struct user_termios)
	117	#define TIOCSETAF_64 _IOW('t', 22, struct user_termios)
	118	#endif /* KERNEL */
1c79356b A	119	#define TIOCGETD _IOR('t', 26, int) /* get line discipline */
1c79356b A	120	#define TIOCSETD _IOW('t', 27, int) /* set line discipline */
2d21ac55 A	121	#define TIOCIXON _IO('t', 129) /* internal input VSTART */
2d21ac55 A	122	#define TIOCIXOFF _IO('t', 128) /* internal input VSTOP */
1c79356b A	123	/* 127-124 compat */
	124	#define TIOCSBRK _IO('t', 123) /* set break bit */
	125	#define TIOCCBRK _IO('t', 122) /* clear break bit */
	126	#define TIOCSDTR _IO('t', 121) /* set data terminal ready */
	127	#define TIOCCDTR _IO('t', 120) /* clear data terminal ready */
	128	#define TIOCGPGRP _IOR('t', 119, int) /* get pgrp of tty */
	129	#define TIOCSPGRP _IOW('t', 118, int) /* set pgrp of tty */
	130	/* 117-116 compat */
	131	#define TIOCOUTQ _IOR('t', 115, int) /* output queue size */
	132	#define TIOCSTI _IOW('t', 114, char) /* simulate terminal input */
	133	#define TIOCNOTTY _IO('t', 113) /* void tty association */
	134	#define TIOCPKT _IOW('t', 112, int) /* pty: set/clear packet mode */
	135	#define TIOCPKT_DATA 0x00 /* data packet */
	136	#define TIOCPKT_FLUSHREAD 0x01 /* flush packet */
	137	#define TIOCPKT_FLUSHWRITE 0x02 /* flush packet */
	138	#define TIOCPKT_STOP 0x04 /* stop output */
	139	#define TIOCPKT_START 0x08 /* start output */
	140	#define TIOCPKT_NOSTOP 0x10 /* no more ^S, ^Q */
	141	#define TIOCPKT_DOSTOP 0x20 /* now do ^S ^Q */
	142	#define TIOCPKT_IOCTL 0x40 /* state change of pty driver */
	143	#define TIOCSTOP _IO('t', 111) /* stop output, like ^S */
	144	#define TIOCSTART _IO('t', 110) /* start output, like ^Q */
	145	#define TIOCMSET _IOW('t', 109, int) /* set all modem bits */
	146	#define TIOCMBIS _IOW('t', 108, int) /* bis modem bits */
	147	#define TIOCMBIC _IOW('t', 107, int) /* bic modem bits */
	148	#define TIOCMGET _IOR('t', 106, int) /* get all modem bits */
	149	#define TIOCREMOTE _IOW('t', 105, int) /* remote input editing */
	150	#define TIOCGWINSZ _IOR('t', 104, struct winsize) /* get window size */
	151	#define TIOCSWINSZ _IOW('t', 103, struct winsize) /* set window size */
	152	#define TIOCUCNTL _IOW('t', 102, int) /* pty: set/clr usr cntl mode */
	153	#define TIOCSTAT _IO('t', 101) /* simulate ^T status message */
	154	#define UIOCCMD(n) _IO('u', n) /* usr cntl op "n" */
	155	#define TIOCSCONS _IO('t', 99) /* 4.2 compatibility */
	156	#define TIOCCONS _IOW('t', 98, int) /* become virtual console */
	157	#define TIOCSCTTY _IO('t', 97) /* become controlling tty */
	158	#define TIOCEXT _IOW('t', 96, int) /* pty: external processing */
	159	#define TIOCSIG _IO('t', 95) /* pty: generate signal */
	160	#define TIOCDRAIN _IO('t', 94) /* wait till output drained */
	161	#define TIOCMSDTRWAIT _IOW('t', 91, int) /* modem: set wait on close */
	162	#define TIOCMGDTRWAIT _IOR('t', 90, int) /* modem: get wait on close */
	163	#define TIOCTIMESTAMP _IOR('t', 89, struct timeval) /* enable/get timestamp
	164	* of last input event */
	165	#define TIOCDCDTIMESTAMP _IOR('t', 88, struct timeval) /* enable/get timestamp
	166	* of last DCd rise */
2d21ac55 A	167	#ifdef KERNEL
	168	#define TIOCTIMESTAMP_64 _IOR('t', 89, struct user_timeval)
	169	#define TIOCDCDTIMESTAMP_64 _IOR('t', 88, struct user_timeval)
	170	#endif
1c79356b A	171	#define TIOCSDRAINWAIT _IOW('t', 87, int) /* set ttywait timeout */
	172	#define TIOCGDRAINWAIT _IOR('t', 86, int) /* get ttywait timeout */
	173	#define TIOCDSIMICROCODE _IO('t', 85) /* download microcode to
	174	* DSI Softmodem */
2d21ac55 A	175	#define TIOCPTYGRANT _IO('t', 84) /* grantpt(3) */
	176	#define TIOCPTYGNAME _IOC(IOC_OUT, 't', 83, 128) /* ptsname(3) */
	177	#define TIOCPTYUNLK _IO('t', 82) /* unlockpt(3) */
1c79356b A	178
	179	#define TTYDISC 0 /* termios tty line discipline */
	180	#define TABLDISC 3 /* tablet discipline */
	181	#define SLIPDISC 4 /* serial IP discipline */
	182	#define PPPDISC 5 /* PPP discipline */
	183
	184	#endif /* !_SYS_TTYCOM_H_ */