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         unsigned long led_values[NLONGS(LED_CNT)];
  93         unsigned long sw_values[NLONGS(SW_CNT)];
  94         struct input_absinfo abs_info[ABS_CNT];
  95         int mt_slot_vals[MAX_SLOTS][ABS_MT_CNT];
  96         int num_slots; /**< valid slots in mt_slot_vals */
  97         int current_slot;
  98         int rep_values[REP_CNT];
  99
 100         enum SyncState sync_state;
 101         int grabbed;
 102
 103         struct input_event *queue;
 104         size_t queue_size; /**< size of queue in elements */
 105         size_t queue_next; /**< next event index */
 106         size_t queue_nsync; /**< number of sync events */
 107
 108         struct timeval last_event_time;
 109 };
 110
 111 /**
 112  * @return a pointer to the next element in the queue, or NULL if the queue
 113  * is full.
 114  */
 115 static inline struct input_event*
 116 queue_push(struct libevdev *dev)
 117 {
 118         if (dev->queue_next >= dev->queue_size)
 119                 return NULL;
 120
 121         return &dev->queue[dev->queue_next++];
 122 }
 123
 124 /**
 125  * Set ev to the last element in the queue, removing it from the queue.
 126  *
 127  * @return 0 on success, 1 if the queue is empty.
 128  */
 129 static inline int
 130 queue_pop(struct libevdev *dev, struct input_event *ev)
 131 {
 132         if (dev->queue_next == 0)
 133                 return 1;
 134
 135         *ev = dev->queue[--dev->queue_next];
 136
 137         return 0;
 138 }
 139
 140 static inline int
 141 queue_peek(struct libevdev *dev, size_t idx, struct input_event *ev)
 142 {
 143         if (dev->queue_next == 0 || idx > dev->queue_next)
 144                 return 1;
 145         *ev = dev->queue[idx];
 146         return 0;
 147 }
 148
 149
 150 /**
 151  * Shift the first n elements into ev and return the number of elements
 152  * shifted.
 153  * ev must be large enough to store n elements.
 154  *
 155  * @param ev The buffer to copy into, or NULL
 156  * @return The number of elements in ev.
 157  */
 158 static inline int
 159 queue_shift_multiple(struct libevdev *dev, size_t n, struct input_event *ev)
 160 {
 161         size_t i;
 162
 163         if (dev->queue_next == 0)
 164                 return 0;
 165
 166         n = min(n, dev->queue_next);
 167
 168         if (ev) {
 169                 for (i = 0; i < n; i++)
 170                         ev[i] = dev->queue[i];
 171         }
 172
 173         for (i = 0; i < dev->queue_next - n; i++)
 174                 dev->queue[i] = dev->queue[n + i];
 175
 176         dev->queue_next -= n;
 177         return n;
 178 }
 179
 180 /**
 181  * Set ev to the first element in the queue, shifting everything else
 182  * forward by one.
 183  *
 184  * @return 0 on success, 1 if the queue is empty.
 185  */
 186 static inline int
 187 queue_shift(struct libevdev *dev, struct input_event *ev)
 188 {
 189         return queue_shift_multiple(dev, 1, ev) == 1 ? 0 : 1;
 190 }
 191
 192 static inline int
 193 queue_alloc(struct libevdev *dev, size_t size)
 194 {
 195         if (size == 0)
 196                 return -ENOSPC;
 197
 198         dev->queue = calloc(size, sizeof(struct input_event));
 199         if (!dev->queue)
 200                 return -ENOSPC;
 201
 202         dev->queue_size = size;
 203         dev->queue_next = 0;
 204         return 0;
 205 }
 206
 207 static inline void
 208 queue_free(struct libevdev *dev)
 209 {
 210         free(dev->queue);
 211         dev->queue_size = 0;
 212         dev->queue_next = 0;
 213 }
 214
 215 static inline size_t
 216 queue_num_elements(struct libevdev *dev)
 217 {
 218         return dev->queue_next;
 219 }
 220
 221 static inline size_t
 222 queue_size(struct libevdev *dev)
 223 {
 224         return dev->queue_size;
 225 }
 226
 227 static inline size_t
 228 queue_num_free_elements(struct libevdev *dev)
 229 {
 230         if (dev->queue_size == 0)
 231                 return 0;
 232
 233         return dev->queue_size - dev->queue_next;
 234 }
 235
 236 static inline struct input_event *
 237 queue_next_element(struct libevdev *dev)
 238 {
 239         if (dev->queue_next == dev->queue_size)
 240                 return NULL;
 241
 242         return &dev->queue[dev->queue_next];
 243 }
 244
 245 static inline int
 246 queue_set_num_elements(struct libevdev *dev, size_t nelem)
 247 {
 248         if (nelem > dev->queue_size)
 249                 return 1;
 250
 251         dev->queue_next = nelem;
 252
 253         return 0;
 254 }
 255 #endif
 256