xref: /openbsd/sys/sys/ioccom.h (revision ec65d0cc)
1 /*	$OpenBSD: ioccom.h,v 1.5 2013/03/22 21:22:05 deraadt Exp $	*/
2 /*	$NetBSD: ioccom.h,v 1.4 1994/10/30 21:49:56 cgd Exp $	*/
3 
4 /*-
5  * Copyright (c) 1982, 1986, 1990, 1993, 1994
6  *	The Regents of the University of California.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  *	@(#)ioccom.h	8.2 (Berkeley) 3/28/94
33  */
34 
35 #ifndef	_SYS_IOCCOM_H_
36 #define	_SYS_IOCCOM_H_
37 
38 /*
39  * Ioctl's have the command encoded in the lower word, and the size of
40  * any in or out parameters in the upper word.  The high 3 bits of the
41  * upper word are used to encode the in/out status of the parameter.
42  */
43 #define	IOCPARM_MASK	0x1fff		/* parameter length, at most 13 bits */
44 #define	IOCPARM_LEN(x)	(((x) >> 16) & IOCPARM_MASK)
45 #define	IOCBASECMD(x)	((x) & ~(IOCPARM_MASK << 16))
46 #define	IOCGROUP(x)	(((x) >> 8) & 0xff)
47 
48 #define	IOCPARM_MAX	PAGE_SIZE	/* max size of ioctl args */
49 				/* no parameters */
50 #define	IOC_VOID	(unsigned long)0x20000000
51 				/* copy parameters out */
52 #define	IOC_OUT		(unsigned long)0x40000000
53 				/* copy parameters in */
54 #define	IOC_IN		(unsigned long)0x80000000
55 				/* copy parameters in and out */
56 #define	IOC_INOUT	(IOC_IN|IOC_OUT)
57 				/* mask for IN/OUT/VOID */
58 #define	IOC_DIRMASK	(unsigned long)0xe0000000
59 
60 #define	_IOC(inout,group,num,len) \
61 	(inout | ((len & IOCPARM_MASK) << 16) | ((group) << 8) | (num))
62 #define	_IO(g,n)	_IOC(IOC_VOID,	(g), (n), 0)
63 #define	_IOR(g,n,t)	_IOC(IOC_OUT,	(g), (n), sizeof(t))
64 #define	_IOW(g,n,t)	_IOC(IOC_IN,	(g), (n), sizeof(t))
65 /* this should be _IORW, but stdio got there first */
66 #define	_IOWR(g,n,t)	_IOC(IOC_INOUT,	(g), (n), sizeof(t))
67 
68 #endif /* !_SYS_IOCCOM_H_ */
69