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