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 #define LIBEVDEV_EXPORT __attribute__((visibility("default")))
  41
  42 #undef min
  43 #undef max
  44 #define min(a,b) \
  45                 ({ __typeof__ (a) _a = (a); \
  46                   __typeof__ (b) _b = (b); \
  47                 _a > _b ? _b : _a; \
  48                 })
  49 #define max(a,b) \
  50                 ({ __typeof__ (a) _a = (a); \
  51                   __typeof__ (b) _b = (b); \
  52                 _a > _b ? _a : _b; \
  53                 })
  54
  55 /**
  56  * Sync state machine:
  57  * default state: SYNC_NONE
  58  *
  59  * SYNC_NONE → SYN_DROPPED or forced sync → SYNC_NEEDED
  60  * SYNC_NEEDED → libevdev_next_event(LIBEVDEV_READ_SYNC) → SYNC_IN_PROGRESS
  61  * SYNC_NEEDED → libevdev_next_event(LIBEVDEV_READ_SYNC_NONE) → SYNC_NONE
  62  * SYNC_IN_PROGRESS → libevdev_next_event(LIBEVDEV_READ_SYNC_NONE) → SYNC_NONE
  63  * SYNC_IN_PROGRESS → no sync events left → SYNC_NONE
  64  *
  65  */
  66 enum SyncState {
  67         SYNC_NONE,
  68         SYNC_NEEDED,
  69         SYNC_IN_PROGRESS,
  70 };
  71
  72 struct libevdev {
  73         int fd;
  74         libevdev_log_func_t log;
  75
  76         char *name;
  77         char *phys;
  78         char *uniq;
  79         struct input_id ids;
  80         int driver_version;
  81         unsigned long bits[NLONGS(EV_CNT)];
  82         unsigned long props[NLONGS(INPUT_PROP_CNT)];
  83         unsigned long key_bits[NLONGS(KEY_CNT)];
  84         unsigned long rel_bits[NLONGS(REL_CNT)];
  85         unsigned long abs_bits[NLONGS(ABS_CNT)];
  86         unsigned long led_bits[NLONGS(LED_CNT)];
  87         unsigned long msc_bits[NLONGS(MSC_CNT)];
  88         unsigned long sw_bits[NLONGS(SW_CNT)];
  89         unsigned long rep_bits[NLONGS(REP_CNT)]; /* convenience, always 1 */
  90         unsigned long ff_bits[NLONGS(FF_CNT)];
  91         unsigned long snd_bits[NLONGS(SND_CNT)];
  92         unsigned long key_values[NLONGS(KEY_CNT)];
  93         unsigned long led_values[NLONGS(LED_CNT)];
  94         unsigned long sw_values[NLONGS(SW_CNT)];
  95         struct input_absinfo abs_info[ABS_CNT];
  96         int mt_slot_vals[MAX_SLOTS][ABS_MT_CNT];
  97         int num_slots; /**< valid slots in mt_slot_vals */
  98         int current_slot;
  99         int rep_values[REP_CNT];
 100
 101         enum SyncState sync_state;
 102         int grabbed;
 103
 104         struct input_event *queue;
 105         size_t queue_size; /**< size of queue in elements */
 106         size_t queue_next; /**< next event index */
 107         size_t queue_nsync; /**< number of sync events */
 108
 109         struct timeval last_event_time;
 110 };
 111
 112 /**
 113  * @return a pointer to the next element in the queue, or NULL if the queue
 114  * is full.
 115  */
 116 static inline struct input_event*
 117 queue_push(struct libevdev *dev)
 118 {
 119         if (dev->queue_next >= dev->queue_size)
 120                 return NULL;
 121
 122         return &dev->queue[dev->queue_next++];
 123 }
 124
 125 /**
 126  * Set ev to the last element in the queue, removing it from the queue.
 127  *
 128  * @return 0 on success, 1 if the queue is empty.
 129  */
 130 static inline int
 131 queue_pop(struct libevdev *dev, struct input_event *ev)
 132 {
 133         if (dev->queue_next == 0)
 134                 return 1;
 135
 136         *ev = dev->queue[--dev->queue_next];
 137
 138         return 0;
 139 }
 140
 141 static inline int
 142 queue_peek(struct libevdev *dev, size_t idx, struct input_event *ev)
 143 {
 144         if (dev->queue_next == 0 || idx > dev->queue_next)
 145                 return 1;
 146         *ev = dev->queue[idx];
 147         return 0;
 148 }
 149
 150
 151 /**
 152  * Shift the first n elements into ev and return the number of elements
 153  * shifted.
 154  * ev must be large enough to store n elements.
 155  *
 156  * @param ev The buffer to copy into, or NULL
 157  * @return The number of elements in ev.
 158  */
 159 static inline int
 160 queue_shift_multiple(struct libevdev *dev, size_t n, struct input_event *ev)
 161 {
 162         size_t i;
 163
 164         if (dev->queue_next == 0)
 165                 return 0;
 166
 167         n = min(n, dev->queue_next);
 168
 169         if (ev) {
 170                 for (i = 0; i < n; i++)
 171                         ev[i] = dev->queue[i];
 172         }
 173
 174         for (i = 0; i < dev->queue_next - n; i++)
 175                 dev->queue[i] = dev->queue[n + i];
 176
 177         dev->queue_next -= n;
 178         return n;
 179 }
 180
 181 /**
 182  * Set ev to the first element in the queue, shifting everything else
 183  * forward by one.
 184  *
 185  * @return 0 on success, 1 if the queue is empty.
 186  */
 187 static inline int
 188 queue_shift(struct libevdev *dev, struct input_event *ev)
 189 {
 190         return queue_shift_multiple(dev, 1, ev) == 1 ? 0 : 1;
 191 }
 192
 193 static inline int
 194 queue_alloc(struct libevdev *dev, size_t size)
 195 {
 196         if (size == 0)
 197                 return -ENOSPC;
 198
 199         dev->queue = calloc(size, sizeof(struct input_event));
 200         if (!dev->queue)
 201                 return -ENOSPC;
 202
 203         dev->queue_size = size;
 204         dev->queue_next = 0;
 205         return 0;
 206 }
 207
 208 static inline void
 209 queue_free(struct libevdev *dev)
 210 {
 211         free(dev->queue);
 212         dev->queue_size = 0;
 213         dev->queue_next = 0;
 214 }
 215
 216 static inline size_t
 217 queue_num_elements(struct libevdev *dev)
 218 {
 219         return dev->queue_next;
 220 }
 221
 222 static inline size_t
 223 queue_size(struct libevdev *dev)
 224 {
 225         return dev->queue_size;
 226 }
 227
 228 static inline size_t
 229 queue_num_free_elements(struct libevdev *dev)
 230 {
 231         if (dev->queue_size == 0)
 232                 return 0;
 233
 234         return dev->queue_size - dev->queue_next;
 235 }
 236
 237 static inline struct input_event *
 238 queue_next_element(struct libevdev *dev)
 239 {
 240         if (dev->queue_next == dev->queue_size)
 241                 return NULL;
 242
 243         return &dev->queue[dev->queue_next];
 244 }
 245
 246 static inline int
 247 queue_set_num_elements(struct libevdev *dev, size_t nelem)
 248 {
 249         if (nelem > dev->queue_size)
 250                 return 1;
 251
 252         dev->queue_next = nelem;
 253
 254         return 0;
 255 }
 256 #endif
 257