1/*	$NetBSD: ioccom.h,v 1.13 2019/05/26 10:21:33 hannken 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. 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 *	@(#)ioccom.h	8.3 (Berkeley) 1/9/95
32 */
33
34#ifndef	_SYS_IOCCOM_H_
35#define	_SYS_IOCCOM_H_
36
37/*
38 * Ioctl's have the command encoded in the lower word, and the size of
39 * any in or out parameters in the upper word.  The high 3 bits of the
40 * upper word are used to encode the in/out status of the parameter.
41 *
42 *	 31 29 28                     16 15            8 7             0
43 *	+---------------------------------------------------------------+
44 *	| I/O | Parameter Length        | Command Group | Command       |
45 *	+---------------------------------------------------------------+
46 */
47#define	IOCPARM_MASK	0x1fff		/* parameter length, at most 13 bits */
48#define	IOCPARM_SHIFT	16
49#define	IOCGROUP_SHIFT	8
50#define	IOCPARM_LEN(x)	(((x) >> IOCPARM_SHIFT) & IOCPARM_MASK)
51#define	IOCBASECMD(x)	((x) & ~(IOCPARM_MASK << IOCPARM_SHIFT))
52#define	IOCGROUP(x)	(((x) >> IOCGROUP_SHIFT) & 0xff)
53
54#define	IOCPARM_MAX	NBPG	/* max size of ioctl args, mult. of NBPG */
55				/* no parameters */
56#define	IOC_VOID	(unsigned long)0x20000000
57				/* copy parameters out */
58#define	IOC_OUT		(unsigned long)0x40000000
59				/* copy parameters in */
60#define	IOC_IN		(unsigned long)0x80000000
61				/* copy parameters in and out */
62#define	IOC_INOUT	(IOC_IN|IOC_OUT)
63				/* mask for IN/OUT/VOID */
64#define	IOC_DIRMASK	(unsigned long)0xe0000000
65
66#define	_IOC(inout, group, num, len) \
67    ((inout) | (((len) & IOCPARM_MASK) << IOCPARM_SHIFT) | \
68    ((group) << IOCGROUP_SHIFT) | (num))
69#define	_IO(g,n)	_IOC(IOC_VOID,	(g), (n), 0)
70#define	_IOR(g,n,t)	_IOC(IOC_OUT,	(g), (n), sizeof(t))
71#define	_IOW(g,n,t)	_IOC(IOC_IN,	(g), (n), sizeof(t))
72/* this should be _IORW, but stdio got there first */
73#define	_IOWR(g,n,t)	_IOC(IOC_INOUT,	(g), (n), sizeof(t))
74
75#define IOCSNPRINTF(buf, len, cmd) \
76    snprintf((buf), (len), "_IO%s%s('%c', %hhu)", \
77	(((cmd) >> 30) & 1) ? "R" : "", \
78	(((cmd) >> 30) & 2) ? "W" : "", \
79	(char)IOCGROUP(cmd), (unsigned char)(cmd))
80		
81
82#endif /* !_SYS_IOCCOM_H_ */