include/linux/iio/events.h

   1 /* The industrial I/O - event passing to userspace
   2  *
   3  * Copyright (c) 2008-2011 Jonathan Cameron
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 as published by
   7  * the Free Software Foundation.
   8  */
   9 #ifndef _IIO_EVENTS_H_
  10 #define _IIO_EVENTS_H_
  11
  12 #include <linux/ioctl.h>
  13 #include <linux/types.h>
  14 #include <linux/iio/types.h>
  15
  16 /**
  17  * struct iio_event_data - The actual event being pushed to userspace
  18  * @id:         event identifier
  19  * @timestamp:  best estimate of time of event occurrence (often from
  20  *              the interrupt handler)
  21  */
  22 struct iio_event_data {
  23         __u64   id;
  24         __s64   timestamp;
  25 };
  26
  27 #define IIO_GET_EVENT_FD_IOCTL _IOR('i', 0x90, int)
  28
  29 /**
  30  * IIO_EVENT_CODE() - create event identifier
  31  * @chan_type:  Type of the channel. Should be one of enum iio_chan_type.
  32  * @diff:       Whether the event is for an differential channel or not.
  33  * @modifier:   Modifier for the channel. Should be one of enum iio_modifier.
  34  * @direction:  Direction of the event. One of enum iio_event_direction.
  35  * @type:       Type of the event. Should be one of enum iio_event_type.
  36  * @chan:       Channel number for non-differential channels.
  37  * @chan1:      First channel number for differential channels.
  38  * @chan2:      Second channel number for differential channels.
  39  */
  40
  41 #define IIO_EVENT_CODE(chan_type, diff, modifier, direction,            \
  42                        type, chan, chan1, chan2)                        \
  43         (((u64)type << 56) | ((u64)diff << 55) |                        \
  44          ((u64)direction << 48) | ((u64)modifier << 40) |               \
  45          ((u64)chan_type << 32) | (((u16)chan2) << 16) | ((u16)chan1) | \
  46          ((u16)chan))
  47
  48
  49 /**
  50  * IIO_MOD_EVENT_CODE() - create event identifier for modified channels
  51  * @chan_type:  Type of the channel. Should be one of enum iio_chan_type.
  52  * @number:     Channel number.
  53  * @modifier:   Modifier for the channel. Should be one of enum iio_modifier.
  54  * @type:       Type of the event. Should be one of enum iio_event_type.
  55  * @direction:  Direction of the event. One of enum iio_event_direction.
  56  */
  57
  58 #define IIO_MOD_EVENT_CODE(chan_type, number, modifier,         \
  59                            type, direction)                             \
  60         IIO_EVENT_CODE(chan_type, 0, modifier, direction, type, number, 0, 0)
  61
  62 /**
  63  * IIO_UNMOD_EVENT_CODE() - create event identifier for unmodified channels
  64  * @chan_type:  Type of the channel. Should be one of enum iio_chan_type.
  65  * @number:     Channel number.
  66  * @type:       Type of the event. Should be one of enum iio_event_type.
  67  * @direction:  Direction of the event. One of enum iio_event_direction.
  68  */
  69
  70 #define IIO_UNMOD_EVENT_CODE(chan_type, number, type, direction)        \
  71         IIO_EVENT_CODE(chan_type, 0, 0, direction, type, number, 0, 0)
  72
  73 #define IIO_EVENT_CODE_EXTRACT_TYPE(mask) ((mask >> 56) & 0xFF)
  74
  75 #define IIO_EVENT_CODE_EXTRACT_DIR(mask) ((mask >> 48) & 0x7F)
  76
  77 #define IIO_EVENT_CODE_EXTRACT_CHAN_TYPE(mask) ((mask >> 32) & 0xFF)
  78
  79 /* Event code number extraction depends on which type of event we have.
  80  * Perhaps review this function in the future*/
  81 #define IIO_EVENT_CODE_EXTRACT_CHAN(mask) ((__s16)(mask & 0xFFFF))
  82 #define IIO_EVENT_CODE_EXTRACT_CHAN2(mask) ((__s16)(((mask) >> 16) & 0xFFFF))
  83
  84 #define IIO_EVENT_CODE_EXTRACT_MODIFIER(mask) ((mask >> 40) & 0xFF)
  85 #define IIO_EVENT_CODE_EXTRACT_DIFF(mask) (((mask) >> 55) & 0x1)
  86
  87 #endif