xref: /original-bsd/sys/sys/ioctl.h (revision 333da485)
1 /*-
2  * Copyright (c) 1982, 1986, 1990, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  * (c) UNIX System Laboratories, Inc.
5  * All or some portions of this file are derived from material licensed
6  * to the University of California by American Telephone and Telegraph
7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8  * the permission of UNIX System Laboratories, Inc.
9  *
10  * %sccs.include.redist.c%
11  *
12  *	@(#)ioctl.h	8.5 (Berkeley) 01/21/94
13  */
14 
15 #ifndef	_SYS_IOCTL_H_
16 #define	_SYS_IOCTL_H_
17 
18 /*
19  * Window/terminal size structure.  This information is stored by the kernel
20  * in order to provide a consistent interface, but is not used by the kernel.
21  */
22 struct winsize {
23 	unsigned short	ws_row;		/* rows, in characters */
24 	unsigned short	ws_col;		/* columns, in characters */
25 	unsigned short	ws_xpixel;	/* horizontal size, pixels */
26 	unsigned short	ws_ypixel;	/* vertical size, pixels */
27 };
28 
29 /*
30  * Pun for SUN.
31  */
32 struct ttysize {
33 	unsigned short	ts_lines;
34 	unsigned short	ts_cols;
35 	unsigned short	ts_xxx;
36 	unsigned short	ts_yyy;
37 };
38 #define	TIOCGSIZE	TIOCGWINSZ
39 #define	TIOCSSIZE	TIOCSWINSZ
40 
41 /*
42  * Ioctl's have the command encoded in the lower word, and the size of
43  * any in or out parameters in the upper word.  The high 3 bits of the
44  * upper word are used to encode the in/out status of the parameter.
45  */
46 #define	IOCPARM_MASK	0x1fff		/* parameter length, at most 13 bits */
47 #define	IOCPARM_LEN(x)	(((x) >> 16) & IOCPARM_MASK)
48 #define	IOCBASECMD(x)	((x) & ~(IOCPARM_MASK << 16))
49 #define	IOCGROUP(x)	(((x) >> 8) & 0xff)
50 
51 #define	IOCPARM_MAX	NBPG		/* max size of ioctl, mult. of NBPG */
52 #define	IOC_VOID	0x20000000	/* no parameters */
53 #define	IOC_OUT		0x40000000	/* copy out parameters */
54 #define	IOC_IN		0x80000000	/* copy in parameters */
55 #define	IOC_INOUT	(IOC_IN|IOC_OUT)
56 #define	IOC_DIRMASK	0xe0000000	/* mask for IN/OUT/VOID */
57 
58 #define	_IOC(inout,group,num,len) \
59 	(inout | ((len & IOCPARM_MASK) << 16) | ((group) << 8) | (num))
60 #define	_IO(g,n)	_IOC(IOC_VOID,	(g), (n), 0)
61 #define	_IOR(g,n,t)	_IOC(IOC_OUT,	(g), (n), sizeof(t))
62 #define	_IOW(g,n,t)	_IOC(IOC_IN,	(g), (n), sizeof(t))
63 /* this should be _IORW, but stdio got there first */
64 #define	_IOWR(g,n,t)	_IOC(IOC_INOUT,	(g), (n), sizeof(t))
65 
66 #define	TIOCMODG	_IOR('t', 3, int)	/* get modem control state */
67 #define	TIOCMODS	_IOW('t', 4, int)	/* set modem control state */
68 #define		TIOCM_LE	0001		/* line enable */
69 #define		TIOCM_DTR	0002		/* data terminal ready */
70 #define		TIOCM_RTS	0004		/* request to send */
71 #define		TIOCM_ST	0010		/* secondary transmit */
72 #define		TIOCM_SR	0020		/* secondary receive */
73 #define		TIOCM_CTS	0040		/* clear to send */
74 #define		TIOCM_CAR	0100		/* carrier detect */
75 #define		TIOCM_CD	TIOCM_CAR
76 #define		TIOCM_RNG	0200		/* ring */
77 #define		TIOCM_RI	TIOCM_RNG
78 #define		TIOCM_DSR	0400		/* data set ready */
79 						/* 8-10 compat */
80 #define	TIOCEXCL	_IO('t', 13)		/* set exclusive use of tty */
81 #define	TIOCNXCL	_IO('t', 14)		/* reset exclusive use of tty */
82 						/* 15 unused */
83 #define	TIOCFLUSH	_IOW('t', 16, int)	/* flush buffers */
84 						/* 17-18 compat */
85 #define	TIOCGETA	_IOR('t', 19, struct termios) /* get termios struct */
86 #define	TIOCSETA	_IOW('t', 20, struct termios) /* set termios struct */
87 #define	TIOCSETAW	_IOW('t', 21, struct termios) /* drain output, set */
88 #define	TIOCSETAF	_IOW('t', 22, struct termios) /* drn out, fls in, set */
89 #define	TIOCGETD	_IOR('t', 26, int)	/* get line discipline */
90 #define	TIOCSETD	_IOW('t', 27, int)	/* set line discipline */
91 						/* 127-124 compat */
92 #define	TIOCSBRK	_IO('t', 123)		/* set break bit */
93 #define	TIOCCBRK	_IO('t', 122)		/* clear break bit */
94 #define	TIOCSDTR	_IO('t', 121)		/* set data terminal ready */
95 #define	TIOCCDTR	_IO('t', 120)		/* clear data terminal ready */
96 #define	TIOCGPGRP	_IOR('t', 119, int)	/* get pgrp of tty */
97 #define	TIOCSPGRP	_IOW('t', 118, int)	/* set pgrp of tty */
98 						/* 117-116 compat */
99 #define	TIOCOUTQ	_IOR('t', 115, int)	/* output queue size */
100 #define	TIOCSTI		_IOW('t', 114, char)	/* simulate terminal input */
101 #define	TIOCNOTTY	_IO('t', 113)		/* void tty association */
102 #define	TIOCPKT		_IOW('t', 112, int)	/* pty: set/clear packet mode */
103 #define		TIOCPKT_DATA		0x00	/* data packet */
104 #define		TIOCPKT_FLUSHREAD	0x01	/* flush packet */
105 #define		TIOCPKT_FLUSHWRITE	0x02	/* flush packet */
106 #define		TIOCPKT_STOP		0x04	/* stop output */
107 #define		TIOCPKT_START		0x08	/* start output */
108 #define		TIOCPKT_NOSTOP		0x10	/* no more ^S, ^Q */
109 #define		TIOCPKT_DOSTOP		0x20	/* now do ^S ^Q */
110 #define		TIOCPKT_IOCTL		0x40	/* state change of pty driver */
111 #define	TIOCSTOP	_IO('t', 111)		/* stop output, like ^S */
112 #define	TIOCSTART	_IO('t', 110)		/* start output, like ^Q */
113 #define	TIOCMSET	_IOW('t', 109, int)	/* set all modem bits */
114 #define	TIOCMBIS	_IOW('t', 108, int)	/* bis modem bits */
115 #define	TIOCMBIC	_IOW('t', 107, int)	/* bic modem bits */
116 #define	TIOCMGET	_IOR('t', 106, int)	/* get all modem bits */
117 #define	TIOCREMOTE	_IOW('t', 105, int)	/* remote input editing */
118 #define	TIOCGWINSZ	_IOR('t', 104, struct winsize)	/* get window size */
119 #define	TIOCSWINSZ	_IOW('t', 103, struct winsize)	/* set window size */
120 #define	TIOCUCNTL	_IOW('t', 102, int)	/* pty: set/clr usr cntl mode */
121 #define		UIOCCMD(n)	_IO('u', n)		/* usr cntl op "n" */
122 #define	TIOCCONS	_IOW('t', 98, int)		/* become virtual console */
123 #define	TIOCSCTTY	_IO('t', 97)		/* become controlling tty */
124 #define	TIOCEXT		_IOW('t', 96, int)	/* pty: external processing */
125 #define	TIOCSIG		_IO('t', 95)		/* pty: generate signal */
126 #define	TIOCDRAIN	_IO('t', 94)		/* wait till output drained */
127 
128 #define	TTYDISC		0		/* termios tty line discipline */
129 #define	TABLDISC	3		/* tablet discipline */
130 #define	SLIPDISC	4		/* serial IP discipline */
131 
132 
133 #define	FIOCLEX		_IO('f', 1)		/* set close on exec on fd */
134 #define	FIONCLEX	_IO('f', 2)		/* remove close on exec */
135 #define	FIONREAD	_IOR('f', 127, int)	/* get # bytes to read */
136 #define	FIONBIO		_IOW('f', 126, int)	/* set/clear non-blocking i/o */
137 #define	FIOASYNC	_IOW('f', 125, int)	/* set/clear async i/o */
138 #define	FIOSETOWN	_IOW('f', 124, int)	/* set owner */
139 #define	FIOGETOWN	_IOR('f', 123, int)	/* get owner */
140 
141 /* socket i/o controls */
142 #define	SIOCSHIWAT	_IOW('s',  0, int)		/* set high watermark */
143 #define	SIOCGHIWAT	_IOR('s',  1, int)		/* get high watermark */
144 #define	SIOCSLOWAT	_IOW('s',  2, int)		/* set low watermark */
145 #define	SIOCGLOWAT	_IOR('s',  3, int)		/* get low watermark */
146 #define	SIOCATMARK	_IOR('s',  7, int)		/* at oob mark? */
147 #define	SIOCSPGRP	_IOW('s',  8, int)		/* set process group */
148 #define	SIOCGPGRP	_IOR('s',  9, int)		/* get process group */
149 
150 #define	SIOCADDRT	_IOW('r', 10, struct ortentry)	/* add route */
151 #define	SIOCDELRT	_IOW('r', 11, struct ortentry)	/* delete route */
152 
153 #define	SIOCSIFADDR	_IOW('i', 12, struct ifreq)	/* set ifnet address */
154 #define	OSIOCGIFADDR	_IOWR('i',13, struct ifreq)	/* get ifnet address */
155 #define	SIOCGIFADDR	_IOWR('i',33, struct ifreq)	/* get ifnet address */
156 #define	SIOCSIFDSTADDR	_IOW('i', 14, struct ifreq)	/* set p-p address */
157 #define	OSIOCGIFDSTADDR	_IOWR('i',15, struct ifreq)	/* get p-p address */
158 #define	SIOCGIFDSTADDR	_IOWR('i',34, struct ifreq)	/* get p-p address */
159 #define	SIOCSIFFLAGS	_IOW('i', 16, struct ifreq)	/* set ifnet flags */
160 #define	SIOCGIFFLAGS	_IOWR('i',17, struct ifreq)	/* get ifnet flags */
161 #define	OSIOCGIFBRDADDR	_IOWR('i',18, struct ifreq)	/* get broadcast addr */
162 #define	SIOCGIFBRDADDR	_IOWR('i',35, struct ifreq)	/* get broadcast addr */
163 #define	SIOCSIFBRDADDR	_IOW('i',19, struct ifreq)	/* set broadcast addr */
164 #define	OSIOCGIFCONF	_IOWR('i',20, struct ifconf)	/* get ifnet list */
165 #define	SIOCGIFCONF	_IOWR('i',36, struct ifconf)	/* get ifnet list */
166 #define	OSIOCGIFNETMASK	_IOWR('i',21, struct ifreq)	/* get net addr mask */
167 #define	SIOCGIFNETMASK	_IOWR('i',37, struct ifreq)	/* get net addr mask */
168 #define	SIOCSIFNETMASK	_IOW('i',22, struct ifreq)	/* set net addr mask */
169 #define	SIOCGIFMETRIC	_IOWR('i',23, struct ifreq)	/* get IF metric */
170 #define	SIOCSIFMETRIC	_IOW('i',24, struct ifreq)	/* set IF metric */
171 #define	SIOCDIFADDR	_IOW('i',25, struct ifreq)	/* delete IF addr */
172 #define	SIOCAIFADDR	_IOW('i',26, struct ifaliasreq)	/* add/chg IF alias */
173 
174 #define	SIOCADDMULTI	_IOW('i', 49, struct ifreq)	/* add m'cast addr */
175 #define	SIOCDELMULTI	_IOW('i', 50, struct ifreq)	/* del m'cast addr */
176 
177 #ifndef KERNEL
178 
179 #include <sys/cdefs.h>
180 
181 __BEGIN_DECLS
182 int	ioctl __P((int, unsigned long, ...));
183 __END_DECLS
184 #endif /* !KERNEL */
185 #endif /* !_SYS_IOCTL_H_ */
186 
187 /* Keep outside _SYS_IOCTL_H_
188  * Compatability with old terminal driver
189  *
190  * Source level -> #define USE_OLD_TTY
191  * Kernel level -> options COMPAT_43 or COMPAT_SUNOS
192  */
193 #if defined(USE_OLD_TTY) || defined(COMPAT_43) || defined(COMPAT_SUNOS)
194 #include <sys/ioctl_compat.h>
195 #endif
196