1*95ffaba3SGraeme Russ #ifndef _ASM_GENERIC_IOCTL_H 2*95ffaba3SGraeme Russ #define _ASM_GENERIC_IOCTL_H 3*95ffaba3SGraeme Russ 4*95ffaba3SGraeme Russ /* ioctl command encoding: 32 bits total, command in lower 16 bits, 5*95ffaba3SGraeme Russ * size of the parameter structure in the lower 14 bits of the 6*95ffaba3SGraeme Russ * upper 16 bits. 7*95ffaba3SGraeme Russ * Encoding the size of the parameter structure in the ioctl request 8*95ffaba3SGraeme Russ * is useful for catching programs compiled with old versions 9*95ffaba3SGraeme Russ * and to avoid overwriting user space outside the user buffer area. 10*95ffaba3SGraeme Russ * The highest 2 bits are reserved for indicating the ``access mode''. 11*95ffaba3SGraeme Russ * NOTE: This limits the max parameter size to 16kB -1 ! 12*95ffaba3SGraeme Russ */ 13*95ffaba3SGraeme Russ 14*95ffaba3SGraeme Russ /* 15*95ffaba3SGraeme Russ * The following is for compatibility across the various Linux 16*95ffaba3SGraeme Russ * platforms. The generic ioctl numbering scheme doesn't really enforce 17*95ffaba3SGraeme Russ * a type field. De facto, however, the top 8 bits of the lower 16 18*95ffaba3SGraeme Russ * bits are indeed used as a type field, so we might just as well make 19*95ffaba3SGraeme Russ * this explicit here. Please be sure to use the decoding macros 20*95ffaba3SGraeme Russ * below from now on. 21*95ffaba3SGraeme Russ */ 22*95ffaba3SGraeme Russ #define _IOC_NRBITS 8 23*95ffaba3SGraeme Russ #define _IOC_TYPEBITS 8 24*95ffaba3SGraeme Russ 25*95ffaba3SGraeme Russ /* 26*95ffaba3SGraeme Russ * Let any architecture override either of the following before 27*95ffaba3SGraeme Russ * including this file. 28*95ffaba3SGraeme Russ */ 29*95ffaba3SGraeme Russ 30*95ffaba3SGraeme Russ #ifndef _IOC_SIZEBITS 31*95ffaba3SGraeme Russ # define _IOC_SIZEBITS 14 32*95ffaba3SGraeme Russ #endif 33*95ffaba3SGraeme Russ 34*95ffaba3SGraeme Russ #ifndef _IOC_DIRBITS 35*95ffaba3SGraeme Russ # define _IOC_DIRBITS 2 36*95ffaba3SGraeme Russ #endif 37*95ffaba3SGraeme Russ 38*95ffaba3SGraeme Russ #define _IOC_NRMASK ((1 << _IOC_NRBITS)-1) 39*95ffaba3SGraeme Russ #define _IOC_TYPEMASK ((1 << _IOC_TYPEBITS)-1) 40*95ffaba3SGraeme Russ #define _IOC_SIZEMASK ((1 << _IOC_SIZEBITS)-1) 41*95ffaba3SGraeme Russ #define _IOC_DIRMASK ((1 << _IOC_DIRBITS)-1) 42*95ffaba3SGraeme Russ 43*95ffaba3SGraeme Russ #define _IOC_NRSHIFT 0 44*95ffaba3SGraeme Russ #define _IOC_TYPESHIFT (_IOC_NRSHIFT+_IOC_NRBITS) 45*95ffaba3SGraeme Russ #define _IOC_SIZESHIFT (_IOC_TYPESHIFT+_IOC_TYPEBITS) 46*95ffaba3SGraeme Russ #define _IOC_DIRSHIFT (_IOC_SIZESHIFT+_IOC_SIZEBITS) 47*95ffaba3SGraeme Russ 48*95ffaba3SGraeme Russ /* 49*95ffaba3SGraeme Russ * Direction bits, which any architecture can choose to override 50*95ffaba3SGraeme Russ * before including this file. 51*95ffaba3SGraeme Russ */ 52*95ffaba3SGraeme Russ 53*95ffaba3SGraeme Russ #ifndef _IOC_NONE 54*95ffaba3SGraeme Russ # define _IOC_NONE 0U 55*95ffaba3SGraeme Russ #endif 56*95ffaba3SGraeme Russ 57*95ffaba3SGraeme Russ #ifndef _IOC_WRITE 58*95ffaba3SGraeme Russ # define _IOC_WRITE 1U 59*95ffaba3SGraeme Russ #endif 60*95ffaba3SGraeme Russ 61*95ffaba3SGraeme Russ #ifndef _IOC_READ 62*95ffaba3SGraeme Russ # define _IOC_READ 2U 63*95ffaba3SGraeme Russ #endif 64*95ffaba3SGraeme Russ 65*95ffaba3SGraeme Russ #define _IOC(dir,type,nr,size) \ 66*95ffaba3SGraeme Russ (((dir) << _IOC_DIRSHIFT) | \ 67*95ffaba3SGraeme Russ ((type) << _IOC_TYPESHIFT) | \ 68*95ffaba3SGraeme Russ ((nr) << _IOC_NRSHIFT) | \ 69*95ffaba3SGraeme Russ ((size) << _IOC_SIZESHIFT)) 70*95ffaba3SGraeme Russ 71*95ffaba3SGraeme Russ #ifdef __KERNEL__ 72*95ffaba3SGraeme Russ /* provoke compile error for invalid uses of size argument */ 73*95ffaba3SGraeme Russ extern unsigned int __invalid_size_argument_for_IOC; 74*95ffaba3SGraeme Russ #define _IOC_TYPECHECK(t) \ 75*95ffaba3SGraeme Russ ((sizeof(t) == sizeof(t[1]) && \ 76*95ffaba3SGraeme Russ sizeof(t) < (1 << _IOC_SIZEBITS)) ? \ 77*95ffaba3SGraeme Russ sizeof(t) : __invalid_size_argument_for_IOC) 78*95ffaba3SGraeme Russ #else 79*95ffaba3SGraeme Russ #define _IOC_TYPECHECK(t) (sizeof(t)) 80*95ffaba3SGraeme Russ #endif 81*95ffaba3SGraeme Russ 82*95ffaba3SGraeme Russ /* used to create numbers */ 83*95ffaba3SGraeme Russ #define _IO(type,nr) _IOC(_IOC_NONE,(type),(nr),0) 84*95ffaba3SGraeme Russ #define _IOR(type,nr,size) _IOC(_IOC_READ,(type),(nr),(_IOC_TYPECHECK(size))) 85*95ffaba3SGraeme Russ #define _IOW(type,nr,size) _IOC(_IOC_WRITE,(type),(nr),(_IOC_TYPECHECK(size))) 86*95ffaba3SGraeme Russ #define _IOWR(type,nr,size) _IOC(_IOC_READ|_IOC_WRITE,(type),(nr),(_IOC_TYPECHECK(size))) 87*95ffaba3SGraeme Russ #define _IOR_BAD(type,nr,size) _IOC(_IOC_READ,(type),(nr),sizeof(size)) 88*95ffaba3SGraeme Russ #define _IOW_BAD(type,nr,size) _IOC(_IOC_WRITE,(type),(nr),sizeof(size)) 89*95ffaba3SGraeme Russ #define _IOWR_BAD(type,nr,size) _IOC(_IOC_READ|_IOC_WRITE,(type),(nr),sizeof(size)) 90*95ffaba3SGraeme Russ 91*95ffaba3SGraeme Russ /* used to decode ioctl numbers.. */ 92*95ffaba3SGraeme Russ #define _IOC_DIR(nr) (((nr) >> _IOC_DIRSHIFT) & _IOC_DIRMASK) 93*95ffaba3SGraeme Russ #define _IOC_TYPE(nr) (((nr) >> _IOC_TYPESHIFT) & _IOC_TYPEMASK) 94*95ffaba3SGraeme Russ #define _IOC_NR(nr) (((nr) >> _IOC_NRSHIFT) & _IOC_NRMASK) 95*95ffaba3SGraeme Russ #define _IOC_SIZE(nr) (((nr) >> _IOC_SIZESHIFT) & _IOC_SIZEMASK) 96*95ffaba3SGraeme Russ 97*95ffaba3SGraeme Russ /* ...and for the drivers/sound files... */ 98*95ffaba3SGraeme Russ 99*95ffaba3SGraeme Russ #define IOC_IN (_IOC_WRITE << _IOC_DIRSHIFT) 100*95ffaba3SGraeme Russ #define IOC_OUT (_IOC_READ << _IOC_DIRSHIFT) 101*95ffaba3SGraeme Russ #define IOC_INOUT ((_IOC_WRITE|_IOC_READ) << _IOC_DIRSHIFT) 102*95ffaba3SGraeme Russ #define IOCSIZE_MASK (_IOC_SIZEMASK << _IOC_SIZESHIFT) 103*95ffaba3SGraeme Russ #define IOCSIZE_SHIFT (_IOC_SIZESHIFT) 104*95ffaba3SGraeme Russ 105*95ffaba3SGraeme Russ #endif /* _ASM_GENERIC_IOCTL_H */ 106