src/evdev.h

   1 /*
   2  * Copyright © 2011, 2012 Intel Corporation
   3  * Copyright © 2013 Jonas Ådahl
   4  *
   5  * Permission to use, copy, modify, distribute, and sell this software and
   6  * its documentation for any purpose is hereby granted without fee, provided
   7  * that the above copyright notice appear in all copies and that both that
   8  * copyright notice and this permission notice appear in supporting
   9  * documentation, and that the name of the copyright holders not be used in
  10  * advertising or publicity pertaining to distribution of the software
  11  * without specific, written prior permission.  The copyright holders make
  12  * no representations about the suitability of this software for any
  13  * purpose.  It is provided "as is" without express or implied warranty.
  14  *
  15  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
  16  * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
  17  * FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
  18  * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
  19  * RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
  20  * CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  21  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  22  */
  23
  24 #ifndef EVDEV_H
  25 #define EVDEV_H
  26
  27 #include "config.h"
  28
  29 #include <stdbool.h>
  30 #include "linux/input.h"
  31 #include <libevdev/libevdev.h>
  32
  33 #include "libinput-private.h"
  34 #include "timer.h"
  35
  36 enum evdev_event_type {
  37         EVDEV_NONE,
  38         EVDEV_ABSOLUTE_TOUCH_DOWN,
  39         EVDEV_ABSOLUTE_MOTION,
  40         EVDEV_ABSOLUTE_TOUCH_UP,
  41         EVDEV_ABSOLUTE_MT_DOWN,
  42         EVDEV_ABSOLUTE_MT_MOTION,
  43         EVDEV_ABSOLUTE_MT_UP,
  44         EVDEV_RELATIVE_MOTION,
  45 };
  46
  47 enum evdev_device_seat_capability {
  48         EVDEV_DEVICE_POINTER = (1 << 0),
  49         EVDEV_DEVICE_KEYBOARD = (1 << 1),
  50         EVDEV_DEVICE_TOUCH = (1 << 2)
  51 };
  52
  53 enum evdev_device_tags {
  54         EVDEV_TAG_EXTERNAL_MOUSE = (1 << 0),
  55         EVDEV_TAG_INTERNAL_TOUCHPAD = (1 << 1),
  56         EVDEV_TAG_TRACKPOINT = (1 << 2),
  57 };
  58
  59 struct mt_slot {
  60         int32_t seat_slot;
  61         int32_t x, y;
  62 };
  63
  64 struct evdev_device {
  65         struct libinput_device base;
  66
  67         struct libinput_source *source;
  68
  69         struct evdev_dispatch *dispatch;
  70         struct libevdev *evdev;
  71         char *output_name;
  72         char *devnode;
  73         char *sysname;
  74         char *syspath;
  75         const char *devname;
  76         int fd;
  77         struct {
  78                 const struct input_absinfo *absinfo_x, *absinfo_y;
  79                 int fake_resolution;
  80
  81                 int32_t x, y;
  82                 int32_t seat_slot;
  83
  84                 int apply_calibration;
  85                 struct matrix calibration;
  86                 struct matrix default_calibration; /* from LIBINPUT_CALIBRATION_MATRIX */
  87                 struct matrix usermatrix; /* as supplied by the caller */
  88         } abs;
  89
  90         struct {
  91                 int slot;
  92                 struct mt_slot *slots;
  93                 size_t slots_len;
  94         } mt;
  95         struct mtdev *mtdev;
  96
  97         struct {
  98                 int dx, dy;
  99         } rel;
 100
 101         struct {
 102                 struct libinput_timer timer;
 103                 struct libinput_device_config_scroll_mode config;
 104                 /* Currently enabled mode, button */
 105                 enum libinput_config_scroll_mode mode;
 106                 uint32_t button;
 107                 /* set during device init, used at runtime to delay changes
 108                  * until all buttons are up */
 109                 enum libinput_config_scroll_mode want_mode;
 110                 uint32_t want_button;
 111                 /* Checks if buttons are down and commits the setting */
 112                 void (*change_scroll_mode)(struct evdev_device *device);
 113                 bool button_scroll_active;
 114                 double threshold;
 115                 uint32_t direction;
 116                 double buildup_vertical;
 117                 double buildup_horizontal;
 118         } scroll;
 119
 120         enum evdev_event_type pending_event;
 121         enum evdev_device_seat_capability seat_caps;
 122         enum evdev_device_tags tags;
 123
 124         int is_mt;
 125         int suspended;
 126
 127         struct {
 128                 struct libinput_device_config_accel config;
 129                 struct motion_filter *filter;
 130         } pointer;
 131
 132         /* Bitmask of pressed keys used to ignore initial release events from
 133          * the kernel. */
 134         unsigned long hw_key_mask[NLONGS(KEY_CNT)];
 135         /* Key counter used for multiplexing button events internally in
 136          * libinput. */
 137         uint8_t key_count[KEY_CNT];
 138
 139         struct {
 140                 struct libinput_device_config_left_handed config_left_handed;
 141                 /* left-handed currently enabled */
 142                 bool left_handed;
 143                 /* set during device init if we want left_handed config,
 144                  * used at runtime to delay the effect until buttons are up */
 145                 bool want_left_handed;
 146                 /* Checks if buttons are down and commits the setting */
 147                 void (*change_to_left_handed)(struct evdev_device *device);
 148         } buttons;
 149
 150         int dpi; /* HW resolution */
 151         struct ratelimit syn_drop_limit; /* ratelimit for SYN_DROPPED logging */
 152 };
 153
 154 #define EVDEV_UNHANDLED_DEVICE ((struct evdev_device *) 1)
 155
 156 struct evdev_dispatch;
 157
 158 struct evdev_dispatch_interface {
 159         /* Process an evdev input event. */
 160         void (*process)(struct evdev_dispatch *dispatch,
 161                         struct evdev_device *device,
 162                         struct input_event *event,
 163                         uint64_t time);
 164
 165         /* Destroy an event dispatch handler and free all its resources. */
 166         void (*destroy)(struct evdev_dispatch *dispatch);
 167
 168         /* A new device was added */
 169         void (*device_added)(struct evdev_device *device,
 170                              struct evdev_device *added_device);
 171
 172         /* A device was removed */
 173         void (*device_removed)(struct evdev_device *device,
 174                                struct evdev_device *removed_device);
 175
 176         /* A device was suspended */
 177         void (*device_suspended)(struct evdev_device *device,
 178                                  struct evdev_device *suspended_device);
 179
 180         /* A device was resumed */
 181         void (*device_resumed)(struct evdev_device *device,
 182                                struct evdev_device *resumed_device);
 183
 184         /* Tag device with one of EVDEV_TAG */
 185         void (*tag_device)(struct evdev_device *device,
 186                            struct udev_device *udev_device);
 187 };
 188
 189 struct evdev_dispatch {
 190         struct evdev_dispatch_interface *interface;
 191         struct libinput_device_config_calibration calibration;
 192
 193         struct {
 194                 struct libinput_device_config_send_events config;
 195                 enum libinput_config_send_events_mode current_mode;
 196         } sendevents;
 197 };
 198
 199 struct evdev_device *
 200 evdev_device_create(struct libinput_seat *seat,
 201                     const char *devnode,
 202                     const char *sysname,
 203                     const char *syspath);
 204
 205 int
 206 evdev_device_init_pointer_acceleration(struct evdev_device *device);
 207
 208 struct evdev_dispatch *
 209 evdev_touchpad_create(struct evdev_device *device);
 210
 211 struct evdev_dispatch *
 212 evdev_mt_touchpad_create(struct evdev_device *device);
 213
 214 void
 215 evdev_device_led_update(struct evdev_device *device, enum libinput_led leds);
 216
 217 int
 218 evdev_device_get_keys(struct evdev_device *device, char *keys, size_t size);
 219
 220 const char *
 221 evdev_device_get_output(struct evdev_device *device);
 222
 223 const char *
 224 evdev_device_get_sysname(struct evdev_device *device);
 225
 226 const char *
 227 evdev_device_get_name(struct evdev_device *device);
 228
 229 unsigned int
 230 evdev_device_get_id_product(struct evdev_device *device);
 231
 232 unsigned int
 233 evdev_device_get_id_vendor(struct evdev_device *device);
 234
 235 void
 236 evdev_device_set_default_calibration(struct evdev_device *device,
 237                                      const float calibration[6]);
 238 void
 239 evdev_device_calibrate(struct evdev_device *device,
 240                        const float calibration[6]);
 241
 242 int
 243 evdev_device_has_capability(struct evdev_device *device,
 244                             enum libinput_device_capability capability);
 245
 246 int
 247 evdev_device_get_size(struct evdev_device *device,
 248                       double *w,
 249                       double *h);
 250
 251 int
 252 evdev_device_has_button(struct evdev_device *device, uint32_t code);
 253
 254 double
 255 evdev_device_transform_x(struct evdev_device *device,
 256                          double x,
 257                          uint32_t width);
 258
 259 double
 260 evdev_device_transform_y(struct evdev_device *device,
 261                          double y,
 262                          uint32_t height);
 263 int
 264 evdev_device_suspend(struct evdev_device *device);
 265
 266 int
 267 evdev_device_resume(struct evdev_device *device);
 268
 269 void
 270 evdev_notify_suspended_device(struct evdev_device *device);
 271
 272 void
 273 evdev_notify_resumed_device(struct evdev_device *device);
 274
 275 void
 276 evdev_keyboard_notify_key(struct evdev_device *device,
 277                           uint32_t time,
 278                           int key,
 279                           enum libinput_key_state state);
 280
 281 void
 282 evdev_pointer_notify_button(struct evdev_device *device,
 283                             uint32_t time,
 284                             int button,
 285                             enum libinput_button_state state);
 286
 287 void
 288 evdev_post_scroll(struct evdev_device *device,
 289                   uint64_t time,
 290                   double dx,
 291                   double dy);
 292
 293
 294 void
 295 evdev_stop_scroll(struct evdev_device *device, uint64_t time);
 296
 297 void
 298 evdev_device_remove(struct evdev_device *device);
 299
 300 void
 301 evdev_device_destroy(struct evdev_device *device);
 302
 303 static inline double
 304 evdev_convert_to_mm(const struct input_absinfo *absinfo, double v)
 305 {
 306         double value = v - absinfo->minimum;
 307         return value/absinfo->resolution;
 308 }
 309
 310 int
 311 evdev_init_left_handed(struct evdev_device *device,
 312                        void (*change_to_left_handed)(struct evdev_device *));
 313
 314 static inline uint32_t
 315 evdev_to_left_handed(struct evdev_device *device,
 316                      uint32_t button)
 317 {
 318         if (device->buttons.left_handed) {
 319                 if (button == BTN_LEFT)
 320                         return BTN_RIGHT;
 321                 else if (button == BTN_RIGHT)
 322                         return BTN_LEFT;
 323         }
 324         return button;
 325 }
 326
 327 #endif /* EVDEV_H */