xref: /netbsd/sys/sys/ioccom.h (revision bf9ec67e)
1 /*	$NetBSD: ioccom.h,v 1.5 1998/03/01 02:24:12 fvdl Exp $	*/
2 
3 /*-
4  * Copyright (c) 1982, 1986, 1990, 1993, 1994
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by the University of
18  *	California, Berkeley and its contributors.
19  * 4. Neither the name of the University nor the names of its contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  *
35  *	@(#)ioccom.h	8.3 (Berkeley) 1/9/95
36  */
37 
38 #ifndef	_SYS_IOCCOM_H_
39 #define	_SYS_IOCCOM_H_
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 args, mult. of NBPG */
52 				/* no parameters */
53 #define	IOC_VOID	(unsigned long)0x20000000
54 				/* copy parameters out */
55 #define	IOC_OUT		(unsigned long)0x40000000
56 				/* copy parameters in */
57 #define	IOC_IN		(unsigned long)0x80000000
58 				/* copy paramters in and out */
59 #define	IOC_INOUT	(IOC_IN|IOC_OUT)
60 				/* mask for IN/OUT/VOID */
61 #define	IOC_DIRMASK	(unsigned long)0xe0000000
62 
63 #define	_IOC(inout,group,num,len) \
64 	(inout | ((len & IOCPARM_MASK) << 16) | ((group) << 8) | (num))
65 #define	_IO(g,n)	_IOC(IOC_VOID,	(g), (n), 0)
66 #define	_IOR(g,n,t)	_IOC(IOC_OUT,	(g), (n), sizeof(t))
67 #define	_IOW(g,n,t)	_IOC(IOC_IN,	(g), (n), sizeof(t))
68 /* this should be _IORW, but stdio got there first */
69 #define	_IOWR(g,n,t)	_IOC(IOC_INOUT,	(g), (n), sizeof(t))
70 
71 #endif /* !_SYS_IOCCOM_H_ */
72