libevdev/libevdev-int.h

   1 /*
   2  * Copyright © 2013 Red Hat, Inc.
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and its
   5  * documentation for any purpose is hereby granted without fee, provided that
   6  * the above copyright notice appear in all copies and that both that copyright
   7  * notice and this permission notice appear in supporting documentation, and
   8  * that the name of the copyright holders not be used in advertising or
   9  * publicity pertaining to distribution of the software without specific,
  10  * written prior permission.  The copyright holders make no representations
  11  * about the suitability of this software for any purpose.  It is provided "as
  12  * is" without express or implied warranty.
  13  *
  14  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  15  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  16  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  17  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  18  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  19  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  20  * OF THIS SOFTWARE.
  21  */
  22
  23 #ifndef libevdev_INT_H
  24 #define libevdev_INT_H
  25
  26 #include <config.h>
  27 #include <stdio.h>
  28 #include <stdlib.h>
  29 #include <errno.h>
  30 #include "libevdev.h"
  31
  32 #define LONG_BITS (sizeof(long) * 8)
  33 #define NLONGS(x) (((x) + LONG_BITS - 1) / LONG_BITS)
  34 #define ARRAY_LENGTH(a) (sizeof(a) / (sizeof((a)[0])))
  35 #define MAX_NAME 256
  36 #define MAX_SLOTS 32
  37 #define ABS_MT_MIN ABS_MT_SLOT
  38 #define ABS_MT_MAX ABS_MT_TOOL_Y
  39 #define ABS_MT_CNT (ABS_MT_MAX - ABS_MT_MIN + 1)
  40
  41 #undef min
  42 #undef max
  43 #define min(a,b) \
  44                 ({ __typeof__ (a) _a = (a); \
  45                   __typeof__ (b) _b = (b); \
  46                 _a > _b ? _b : _a; \
  47                 })
  48 #define max(a,b) \
  49                 ({ __typeof__ (a) _a = (a); \
  50                   __typeof__ (b) _b = (b); \
  51                 _a > _b ? _a : _b; \
  52                 })
  53
  54 /**
  55  * Sync state machine:
  56  * default state: SYNC_NONE
  57  *
  58  * SYNC_NONE → SYN_DROPPED or forced sync → SYNC_NEEDED
  59  * SYNC_NEEDED → libevdev_next_event(LIBEVDEV_READ_SYNC) → SYNC_IN_PROGRESS
  60  * SYNC_NEEDED → libevdev_next_event(LIBEVDEV_READ_SYNC_NONE) → SYNC_NONE
  61  * SYNC_IN_PROGRESS → libevdev_next_event(LIBEVDEV_READ_SYNC_NONE) → SYNC_NONE
  62  * SYNC_IN_PROGRESS → no sync events left → SYNC_NONE
  63  *
  64  */
  65 enum SyncState {
  66         SYNC_NONE,
  67         SYNC_NEEDED,
  68         SYNC_IN_PROGRESS,
  69 };
  70
  71 struct libevdev {
  72         int fd;
  73         libevdev_log_func_t log;
  74
  75         char *name;
  76         char *phys;
  77         char *uniq;
  78         struct input_id ids;
  79         int driver_version;
  80         unsigned long bits[NLONGS(EV_CNT)];
  81         unsigned long props[NLONGS(INPUT_PROP_CNT)];
  82         unsigned long key_bits[NLONGS(KEY_CNT)];
  83         unsigned long rel_bits[NLONGS(REL_CNT)];
  84         unsigned long abs_bits[NLONGS(ABS_CNT)];
  85         unsigned long led_bits[NLONGS(LED_CNT)];
  86         unsigned long msc_bits[NLONGS(MSC_CNT)];
  87         unsigned long sw_bits[NLONGS(SW_CNT)];
  88         unsigned long rep_bits[NLONGS(REP_CNT)]; /* convenience, always 1 */
  89         unsigned long ff_bits[NLONGS(FF_CNT)];
  90         unsigned long snd_bits[NLONGS(SND_CNT)];
  91         unsigned long key_values[NLONGS(KEY_CNT)];
  92         struct input_absinfo abs_info[ABS_CNT];
  93         unsigned int mt_slot_vals[MAX_SLOTS][ABS_MT_CNT];
  94         int num_slots; /**< valid slots in mt_slot_vals */
  95         int current_slot;
  96         int rep_values[REP_CNT];
  97
  98         enum SyncState sync_state;
  99         int grabbed;
 100
 101         struct input_event *queue;
 102         size_t queue_size; /**< size of queue in elements */
 103         size_t queue_next; /**< next event index */
 104         size_t queue_nsync; /**< number of sync events */
 105
 106         struct timeval last_event_time;
 107 };
 108
 109 /**
 110  * @return a pointer to the next element in the queue, or NULL if the queue
 111  * is full.
 112  */
 113 static inline struct input_event*
 114 queue_push(struct libevdev *dev)
 115 {
 116         if (dev->queue_next >= dev->queue_size)
 117                 return NULL;
 118
 119         return &dev->queue[dev->queue_next++];
 120 }
 121
 122 /**
 123  * Set ev to the last element in the queue, removing it from the queue.
 124  *
 125  * @return 0 on success, 1 if the queue is empty.
 126  */
 127 static inline int
 128 queue_pop(struct libevdev *dev, struct input_event *ev)
 129 {
 130         if (dev->queue_next == 0)
 131                 return 1;
 132
 133         *ev = dev->queue[--dev->queue_next];
 134
 135         return 0;
 136 }
 137
 138 static inline int
 139 queue_peek(struct libevdev *dev, size_t idx, struct input_event *ev)
 140 {
 141         if (dev->queue_next == 0 || idx > dev->queue_next)
 142                 return 1;
 143         *ev = dev->queue[idx];
 144         return 0;
 145 }
 146
 147
 148 /**
 149  * Shift the first n elements into ev and return the number of elements
 150  * shifted.
 151  * ev must be large enough to store n elements.
 152  *
 153  * @param ev The buffer to copy into, or NULL
 154  * @return The number of elements in ev.
 155  */
 156 static inline int
 157 queue_shift_multiple(struct libevdev *dev, size_t n, struct input_event *ev)
 158 {
 159         size_t i;
 160
 161         if (dev->queue_next == 0)
 162                 return 0;
 163
 164         n = min(n, dev->queue_next);
 165
 166         if (ev) {
 167                 for (i = 0; i < n; i++)
 168                         ev[i] = dev->queue[i];
 169         }
 170
 171         for (i = 0; i < dev->queue_next - n; i++)
 172                 dev->queue[i] = dev->queue[n + i];
 173
 174         dev->queue_next -= n;
 175         return n;
 176 }
 177
 178 /**
 179  * Set ev to the first element in the queue, shifting everything else
 180  * forward by one.
 181  *
 182  * @return 0 on success, 1 if the queue is empty.
 183  */
 184 static inline int
 185 queue_shift(struct libevdev *dev, struct input_event *ev)
 186 {
 187         return queue_shift_multiple(dev, 1, ev) == 1 ? 0 : 1;
 188 }
 189
 190 static inline int
 191 queue_alloc(struct libevdev *dev, size_t size)
 192 {
 193         if (size == 0)
 194                 return -ENOSPC;
 195
 196         dev->queue = calloc(size, sizeof(struct input_event));
 197         if (!dev->queue)
 198                 return -ENOSPC;
 199
 200         dev->queue_size = size;
 201         dev->queue_next = 0;
 202         return 0;
 203 }
 204
 205 static inline void
 206 queue_free(struct libevdev *dev)
 207 {
 208         free(dev->queue);
 209         dev->queue_size = 0;
 210         dev->queue_next = 0;
 211 }
 212
 213 static inline size_t
 214 queue_num_elements(struct libevdev *dev)
 215 {
 216         return dev->queue_next;
 217 }
 218
 219 static inline size_t
 220 queue_size(struct libevdev *dev)
 221 {
 222         return dev->queue_size;
 223 }
 224
 225 static inline size_t
 226 queue_num_free_elements(struct libevdev *dev)
 227 {
 228         if (dev->queue_size == 0)
 229                 return 0;
 230
 231         return dev->queue_size - dev->queue_next;
 232 }
 233
 234 static inline struct input_event *
 235 queue_next_element(struct libevdev *dev)
 236 {
 237         if (dev->queue_next == dev->queue_size)
 238                 return NULL;
 239
 240         return &dev->queue[dev->queue_next];
 241 }
 242
 243 static inline int
 244 queue_set_num_elements(struct libevdev *dev, size_t nelem)
 245 {
 246         if (nelem > dev->queue_size)
 247                 return 1;
 248
 249         dev->queue_next = nelem;
 250
 251         return 0;
 252 }
 253 #endif
 254