evdev: Add an internal device suspend / resume notification system
[platform/upstream/libinput.git] / 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 };
57
58 struct mt_slot {
59         int32_t seat_slot;
60         int32_t x, y;
61 };
62
63 struct evdev_device {
64         struct libinput_device base;
65
66         struct libinput_source *source;
67
68         struct evdev_dispatch *dispatch;
69         struct libevdev *evdev;
70         char *output_name;
71         char *devnode;
72         char *sysname;
73         char *syspath;
74         const char *devname;
75         int fd;
76         struct {
77                 const struct input_absinfo *absinfo_x, *absinfo_y;
78                 int fake_resolution;
79
80                 int32_t x, y;
81                 int32_t seat_slot;
82
83                 int apply_calibration;
84                 struct matrix calibration;
85                 struct matrix default_calibration; /* from LIBINPUT_CALIBRATION_MATRIX */
86                 struct matrix usermatrix; /* as supplied by the caller */
87         } abs;
88
89         struct {
90                 int slot;
91                 struct mt_slot *slots;
92                 size_t slots_len;
93         } mt;
94         struct mtdev *mtdev;
95
96         struct {
97                 int dx, dy;
98         } rel;
99
100         struct {
101                 struct libinput_timer timer;
102                 bool has_middle_button_scroll;
103                 bool middle_button_scroll_active;
104                 double threshold;
105                 uint32_t direction;
106         } scroll;
107
108         enum evdev_event_type pending_event;
109         enum evdev_device_seat_capability seat_caps;
110         enum evdev_device_tags tags;
111
112         int is_mt;
113         int suspended;
114
115         struct {
116                 struct motion_filter *filter;
117         } pointer;
118
119         /* Bitmask of pressed keys used to ignore initial release events from
120          * the kernel. */
121         unsigned long hw_key_mask[NLONGS(KEY_CNT)];
122         /* Key counter used for multiplexing button events internally in
123          * libinput. */
124         uint8_t key_count[KEY_CNT];
125 };
126
127 #define EVDEV_UNHANDLED_DEVICE ((struct evdev_device *) 1)
128
129 struct evdev_dispatch;
130
131 struct evdev_dispatch_interface {
132         /* Process an evdev input event. */
133         void (*process)(struct evdev_dispatch *dispatch,
134                         struct evdev_device *device,
135                         struct input_event *event,
136                         uint64_t time);
137
138         /* Destroy an event dispatch handler and free all its resources. */
139         void (*destroy)(struct evdev_dispatch *dispatch);
140
141         /* A new device was added */
142         void (*device_added)(struct evdev_device *device,
143                              struct evdev_device *added_device);
144
145         /* A device was removed */
146         void (*device_removed)(struct evdev_device *device,
147                                struct evdev_device *removed_device);
148
149         /* A device was suspended */
150         void (*device_suspended)(struct evdev_device *device,
151                                  struct evdev_device *suspended_device);
152
153         /* A device was resumed */
154         void (*device_resumed)(struct evdev_device *device,
155                                struct evdev_device *resumed_device);
156
157         /* Tag device with one of EVDEV_TAG */
158         void (*tag_device)(struct evdev_device *device,
159                            struct udev_device *udev_device);
160 };
161
162 struct evdev_dispatch {
163         struct evdev_dispatch_interface *interface;
164         struct libinput_device_config_calibration calibration;
165
166         struct {
167                 struct libinput_device_config_send_events config;
168                 enum libinput_config_send_events_mode current_mode;
169         } sendevents;
170 };
171
172 struct evdev_device *
173 evdev_device_create(struct libinput_seat *seat,
174                     const char *devnode,
175                     const char *sysname,
176                     const char *syspath);
177
178 struct evdev_dispatch *
179 evdev_touchpad_create(struct evdev_device *device);
180
181 struct evdev_dispatch *
182 evdev_mt_touchpad_create(struct evdev_device *device);
183
184 void
185 evdev_device_proces_event(struct libinput_event *event);
186
187 void
188 evdev_device_led_update(struct evdev_device *device, enum libinput_led leds);
189
190 int
191 evdev_device_get_keys(struct evdev_device *device, char *keys, size_t size);
192
193 const char *
194 evdev_device_get_output(struct evdev_device *device);
195
196 const char *
197 evdev_device_get_sysname(struct evdev_device *device);
198
199 const char *
200 evdev_device_get_name(struct evdev_device *device);
201
202 unsigned int
203 evdev_device_get_id_product(struct evdev_device *device);
204
205 unsigned int
206 evdev_device_get_id_vendor(struct evdev_device *device);
207
208 void
209 evdev_device_set_default_calibration(struct evdev_device *device,
210                                      const float calibration[6]);
211 void
212 evdev_device_calibrate(struct evdev_device *device,
213                        const float calibration[6]);
214
215 int
216 evdev_device_has_capability(struct evdev_device *device,
217                             enum libinput_device_capability capability);
218
219 int
220 evdev_device_get_size(struct evdev_device *device,
221                       double *w,
222                       double *h);
223
224 double
225 evdev_device_transform_x(struct evdev_device *device,
226                          double x,
227                          uint32_t width);
228
229 double
230 evdev_device_transform_y(struct evdev_device *device,
231                          double y,
232                          uint32_t height);
233 int
234 evdev_device_suspend(struct evdev_device *device);
235
236 int
237 evdev_device_resume(struct evdev_device *device);
238
239 void
240 evdev_notify_suspended_device(struct evdev_device *device);
241
242 void
243 evdev_notify_resumed_device(struct evdev_device *device);
244
245 void
246 evdev_keyboard_notify_key(struct evdev_device *device,
247                           uint32_t time,
248                           int key,
249                           enum libinput_key_state state);
250
251 void
252 evdev_pointer_notify_button(struct evdev_device *device,
253                             uint32_t time,
254                             int button,
255                             enum libinput_button_state state);
256
257 void
258 evdev_post_scroll(struct evdev_device *device,
259                   uint64_t time,
260                   double dx,
261                   double dy);
262
263
264 void
265 evdev_stop_scroll(struct evdev_device *device, uint64_t time);
266
267 void
268 evdev_device_remove(struct evdev_device *device);
269
270 void
271 evdev_device_destroy(struct evdev_device *device);
272
273 static inline double
274 evdev_convert_to_mm(const struct input_absinfo *absinfo, double v)
275 {
276         double value = v - absinfo->minimum;
277         return value/absinfo->resolution;
278 }
279
280 #endif /* EVDEV_H */