sys/sys/ioccom.h

   1 /*-
   2  * Copyright (c) 1982, 1986, 1990, 1993, 1994
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  *      @(#)ioccom.h    8.2 (Berkeley) 3/28/94
  34  * $FreeBSD: src/sys/sys/ioccom.h,v 1.9 1999/12/29 04:24:42 peter Exp $
  35  * $DragonFly: src/sys/sys/ioccom.h,v 1.3 2003/08/20 07:31:21 rob Exp $
  36  */
  37
  38 #ifndef _SYS_IOCCOM_H_
  39 #define _SYS_IOCCOM_H_
  40
  41 /*
  42  * Ioctl's have the command encoded in the lower word, and the size of
  43  * any in or out parameters in the upper word.  The high 3 bits of the
  44  * upper word are used to encode the in/out status of the parameter.
  45  */
  46 #define IOCPARM_MASK    0x1fff          /* parameter length, at most 13 bits */
  47 #define IOCPARM_LEN(x)  (((x) >> 16) & IOCPARM_MASK)
  48 #define IOCBASECMD(x)   ((x) & ~(IOCPARM_MASK << 16))
  49 #define IOCGROUP(x)     (((x) >> 8) & 0xff)
  50
  51 #define IOCPARM_MAX     PAGE_SIZE               /* max size of ioctl, mult. of PAGE_SIZE */
  52 #define IOC_VOID        0x20000000      /* no parameters */
  53 #define IOC_OUT         0x40000000      /* copy out parameters */
  54 #define IOC_IN          0x80000000      /* copy in parameters */
  55 #define IOC_INOUT       (IOC_IN|IOC_OUT)
  56 #define IOC_DIRMASK     0xe0000000      /* mask for IN/OUT/VOID */
  57
  58 #define _IOC(inout,group,num,len) \
  59         ((unsigned long)(inout | ((len & IOCPARM_MASK) << 16) | ((group) << 8) | (num)))
  60 #define _IO(g,n)        _IOC(IOC_VOID,  (g), (n), 0)
  61 #define _IOR(g,n,t)     _IOC(IOC_OUT,   (g), (n), sizeof(t))
  62 #define _IOW(g,n,t)     _IOC(IOC_IN,    (g), (n), sizeof(t))
  63 /* this should be _IORW, but stdio got there first */
  64 #define _IOWR(g,n,t)    _IOC(IOC_INOUT, (g), (n), sizeof(t))
  65
  66 #ifndef _KERNEL
  67
  68 #include <sys/cdefs.h>
  69
  70 __BEGIN_DECLS
  71 int     ioctl (int, unsigned long, ...);
  72 __END_DECLS
  73
  74 #endif
  75
  76 #endif /* !_SYS_IOCCOM_H_ */