bsd/sys/ioccom.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  29 /*-
  30  * Copyright (c) 1982, 1986, 1990, 1993, 1994
  31  *      The Regents of the University of California.  All rights reserved.
  32  *
  33  * Redistribution and use in source and binary forms, with or without
  34  * modification, are permitted provided that the following conditions
  35  * are met:
  36  * 1. Redistributions of source code must retain the above copyright
  37  *    notice, this list of conditions and the following disclaimer.
  38  * 2. Redistributions in binary form must reproduce the above copyright
  39  *    notice, this list of conditions and the following disclaimer in the
  40  *    documentation and/or other materials provided with the distribution.
  41  * 3. All advertising materials mentioning features or use of this software
  42  *    must display the following acknowledgement:
  43  *      This product includes software developed by the University of
  44  *      California, Berkeley and its contributors.
  45  * 4. Neither the name of the University nor the names of its contributors
  46  *    may be used to endorse or promote products derived from this software
  47  *    without specific prior written permission.
  48  *
  49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  50  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  51  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  52  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  53  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  54  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  55  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  56  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  57  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  58  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  59  * SUCH DAMAGE.
  60  *
  61  *      @(#)ioccom.h    8.2 (Berkeley) 3/28/94
  62  */
  63
  64 #ifndef _SYS_IOCCOM_H_
  65 #define _SYS_IOCCOM_H_
  66
  67 #include <sys/_types.h>
  68
  69 /*
  70  * Ioctl's have the command encoded in the lower word, and the size of
  71  * any in or out parameters in the upper word.  The high 3 bits of the
  72  * upper word are used to encode the in/out status of the parameter.
  73  */
  74 #define IOCPARM_MASK    0x1fff          /* parameter length, at most 13 bits */
  75 #define IOCPARM_LEN(x)  (((x) >> 16) & IOCPARM_MASK)
  76 #define IOCBASECMD(x)   ((x) & ~(IOCPARM_MASK << 16))
  77 #define IOCGROUP(x)     (((x) >> 8) & 0xff)
  78
  79 #define IOCPARM_MAX     (IOCPARM_MASK + 1)      /* max size of ioctl args */
  80 /* no parameters */
  81 #define IOC_VOID        (__uint32_t)0x20000000
  82 /* copy parameters out */
  83 #define IOC_OUT         (__uint32_t)0x40000000
  84 /* copy parameters in */
  85 #define IOC_IN          (__uint32_t)0x80000000
  86 /* copy parameters in and out */
  87 #define IOC_INOUT       (IOC_IN|IOC_OUT)
  88 /* mask for IN/OUT/VOID */
  89 #define IOC_DIRMASK     (__uint32_t)0xe0000000
  90
  91 #define _IOC(inout, group, num, len) \
  92         (inout | ((len & IOCPARM_MASK) << 16) | ((group) << 8) | (num))
  93 #define _IO(g, n)        _IOC(IOC_VOID, (g), (n), 0)
  94 #define _IOR(g, n, t)     _IOC(IOC_OUT, (g), (n), sizeof(t))
  95 #define _IOW(g, n, t)     _IOC(IOC_IN,  (g), (n), sizeof(t))
  96 /* this should be _IORW, but stdio got there first */
  97 #define _IOWR(g, n, t)    _IOC(IOC_INOUT,       (g), (n), sizeof(t))
  98
  99 #endif /* !_SYS_IOCCOM_H_ */