bsd/sys/ioccom.h

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