1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
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. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 */
31
32#ifndef _SYS_IOCCOM_H_
33#define _SYS_IOCCOM_H_
34
35/*
36 * Ioctl's have the command encoded in the lower word, and the size of
37 * any in or out parameters in the upper word. The high 3 bits of the
38 * upper word are used to encode the in/out status of the parameter.
39 *
40 * 31 29 28 16 15 8 7 0
41 * +---------------------------------------------------------------+
42 * | I/O | Parameter Length | Command Group | Command |
43 * +---------------------------------------------------------------+
44 */
45#define IOCPARM_SHIFT 13 /* number of bits for ioctl size */
46#define IOCPARM_MASK ((1 << IOCPARM_SHIFT) - 1) /* parameter length mask */
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 (1 << IOCPARM_SHIFT) /* max size of ioctl */
52
53#define IOC_VOID 0x20000000UL /* no parameters */
54#define IOC_OUT 0x40000000UL /* copy out parameters */
55#define IOC_IN 0x80000000UL /* copy in parameters */
56#define IOC_INOUT (IOC_IN|IOC_OUT)/* copy parameters in and out */
57#define IOC_DIRMASK (IOC_VOID|IOC_OUT|IOC_IN)/* mask for IN/OUT/VOID */
58
59#define _IOC(inout,group,num,len) ((unsigned long) \
60 ((inout) | (((len) & IOCPARM_MASK) << 16) | ((group) << 8) | (num)))
61#define _IO(g,n) _IOC(IOC_VOID, (g), (n), 0)
62#define _IOWINT(g,n) _IOC(IOC_VOID, (g), (n), sizeof(int))
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/* Replace length/type in an ioctl command. */
68#define _IOC_NEWLEN(ioc, len) \
69 (((~(IOCPARM_MASK << 16)) & (ioc)) | (((len) & IOCPARM_MASK) << 16))
70#define _IOC_NEWTYPE(ioc, type) _IOC_NEWLEN((ioc), sizeof(type))
71
72#ifdef _KERNEL
73
74#if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \
75 defined(COMPAT_FREEBSD4) || defined(COMPAT_43)
76#define IOCPARM_IVAL(x) ((int)(intptr_t)(void *)*(caddr_t *)(void *)(x))
77#endif
78
79#define _IOC_INVALID (_IOC_VOID|_IOC_INOUT) /* Never valid cmd value,
80 use as filler */
81
82#elif !defined(_STANDALONE)
83
84#include <sys/cdefs.h>
85
86__BEGIN_DECLS
87int ioctl(int, unsigned long, ...);
88__END_DECLS
89
90#endif
91
92#endif /* !_SYS_IOCCOM_H_ */