bsd/sys/ioccom.h

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