bsd/sys/ioccom.h

   1 /*
   2  * Copyright (c) 2006 Apple Computer, Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_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
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  31 /*-
  32  * Copyright (c) 1982, 1986, 1990, 1993, 1994
  33  *      The Regents of the University of California.  All rights reserved.
  34  *
  35  * Redistribution and use in source and binary forms, with or without
  36  * modification, are permitted provided that the following conditions
  37  * are met:
  38  * 1. Redistributions of source code must retain the above copyright
  39  *    notice, this list of conditions and the following disclaimer.
  40  * 2. Redistributions in binary form must reproduce the above copyright
  41  *    notice, this list of conditions and the following disclaimer in the
  42  *    documentation and/or other materials provided with the distribution.
  43  * 3. All advertising materials mentioning features or use of this software
  44  *    must display the following acknowledgement:
  45  *      This product includes software developed by the University of
  46  *      California, Berkeley and its contributors.
  47  * 4. Neither the name of the University nor the names of its contributors
  48  *    may be used to endorse or promote products derived from this software
  49  *    without specific prior written permission.
  50  *
  51  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  52  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  53  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  54  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  55  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  56  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  57  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  58  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  59  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  60  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  61  * SUCH DAMAGE.
  62  *
  63  *      @(#)ioccom.h    8.2 (Berkeley) 3/28/94
  64  */
  65
  66 #ifndef _SYS_IOCCOM_H_
  67 #define _SYS_IOCCOM_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        (unsigned long)0x20000000
  82                                 /* copy parameters out */
  83 #define IOC_OUT         (unsigned long)0x40000000
  84                                 /* copy parameters in */
  85 #define IOC_IN          (unsigned long)0x80000000
  86                                 /* copy paramters in and out */
  87 #define IOC_INOUT       (IOC_IN|IOC_OUT)
  88                                 /* mask for IN/OUT/VOID */
  89 #define IOC_DIRMASK     (unsigned long)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_ */