2 * Copyright © 2014 Red Hat, Inc.
4 * Permission to use, copy, modify, distribute, and sell this software and
5 * its documentation for any purpose is hereby granted without fee, provided
6 * that the above copyright notice appear in all copies and that both that
7 * copyright notice and this permission notice appear in supporting
8 * documentation, and that the name of the copyright holders not be used in
9 * advertising or publicity pertaining to distribution of the software
10 * without specific, written prior permission. The copyright holders make
11 * no representations about the suitability of this software for any
12 * purpose. It is provided "as is" without express or implied warranty.
14 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
15 * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
16 * FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
17 * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
18 * RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
19 * CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
20 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
30 #include "evdev-mt-touchpad.h"
32 #define DEFAULT_ACCEL_NUMERATOR 1200.0
33 #define DEFAULT_HYSTERESIS_MARGIN_DENOMINATOR 700.0
36 tp_hysteresis(int in, int center, int margin)
38 int diff = in - center;
39 if (abs(diff) <= margin)
43 return center + diff - margin;
45 return center + diff + margin;
48 static inline struct tp_motion *
49 tp_motion_history_offset(struct tp_touch *t, int offset)
52 (t->history.index - offset + TOUCHPAD_HISTORY_LENGTH) %
53 TOUCHPAD_HISTORY_LENGTH;
55 return &t->history.samples[offset_index];
59 tp_filter_motion(struct tp_dispatch *tp,
60 double *dx, double *dy, uint64_t time)
62 struct motion_params motion;
64 motion.dx = *dx * tp->accel.x_scale_coeff;
65 motion.dy = *dy * tp->accel.y_scale_coeff;
67 if (motion.dx != 0.0 || motion.dy != 0.0)
68 filter_dispatch(tp->filter, &motion, tp, time);
75 tp_motion_history_push(struct tp_touch *t)
77 int motion_index = (t->history.index + 1) % TOUCHPAD_HISTORY_LENGTH;
79 if (t->history.count < TOUCHPAD_HISTORY_LENGTH)
82 t->history.samples[motion_index].x = t->x;
83 t->history.samples[motion_index].y = t->y;
84 t->history.index = motion_index;
88 tp_motion_hysteresis(struct tp_dispatch *tp,
94 if (t->history.count == 0) {
95 t->hysteresis.center_x = t->x;
96 t->hysteresis.center_y = t->y;
99 t->hysteresis.center_x,
100 tp->hysteresis.margin_x);
102 t->hysteresis.center_y,
103 tp->hysteresis.margin_y);
104 t->hysteresis.center_x = x;
105 t->hysteresis.center_y = y;
112 tp_motion_history_reset(struct tp_touch *t)
114 t->history.count = 0;
117 static inline struct tp_touch *
118 tp_current_touch(struct tp_dispatch *tp)
120 return &tp->touches[min(tp->slot, tp->ntouches - 1)];
123 static inline struct tp_touch *
124 tp_get_touch(struct tp_dispatch *tp, unsigned int slot)
126 assert(slot < tp->ntouches);
127 return &tp->touches[slot];
131 tp_begin_touch(struct tp_dispatch *tp, struct tp_touch *t, uint64_t time)
133 if (t->state == TOUCH_BEGIN || t->state == TOUCH_UPDATE)
136 tp_motion_history_reset(t);
138 t->state = TOUCH_BEGIN;
139 t->pinned.is_pinned = false;
142 assert(tp->nfingers_down >= 1);
143 tp->queued |= TOUCHPAD_EVENT_MOTION;
147 tp_end_touch(struct tp_dispatch *tp, struct tp_touch *t, uint64_t time)
149 if (t->state == TOUCH_END || t->state == TOUCH_NONE)
153 t->is_pointer = false;
154 t->palm.is_palm = false;
155 t->state = TOUCH_END;
156 t->pinned.is_pinned = false;
158 assert(tp->nfingers_down >= 1);
160 tp->queued |= TOUCHPAD_EVENT_MOTION;
164 tp_estimate_delta(int x0, int x1, int x2, int x3)
166 return (x0 + x1 - x2 - x3) / 4;
170 tp_get_delta(struct tp_touch *t, double *dx, double *dy)
172 if (t->history.count < 4) {
178 *dx = tp_estimate_delta(tp_motion_history_offset(t, 0)->x,
179 tp_motion_history_offset(t, 1)->x,
180 tp_motion_history_offset(t, 2)->x,
181 tp_motion_history_offset(t, 3)->x);
182 *dy = tp_estimate_delta(tp_motion_history_offset(t, 0)->y,
183 tp_motion_history_offset(t, 1)->y,
184 tp_motion_history_offset(t, 2)->y,
185 tp_motion_history_offset(t, 3)->y);
189 tp_process_absolute(struct tp_dispatch *tp,
190 const struct input_event *e,
193 struct tp_touch *t = tp_current_touch(tp);
196 case ABS_MT_POSITION_X:
200 tp->queued |= TOUCHPAD_EVENT_MOTION;
202 case ABS_MT_POSITION_Y:
206 tp->queued |= TOUCHPAD_EVENT_MOTION;
211 case ABS_MT_TRACKING_ID:
213 tp_begin_touch(tp, t, time);
215 tp_end_touch(tp, t, time);
220 tp_process_absolute_st(struct tp_dispatch *tp,
221 const struct input_event *e,
224 struct tp_touch *t = tp_current_touch(tp);
231 tp->queued |= TOUCHPAD_EVENT_MOTION;
237 tp->queued |= TOUCHPAD_EVENT_MOTION;
243 tp_process_fake_touch(struct tp_dispatch *tp,
244 const struct input_event *e,
248 unsigned int fake_touches;
249 unsigned int nfake_touches;
253 if (e->code != BTN_TOUCH &&
254 (e->code < BTN_TOOL_DOUBLETAP || e->code > BTN_TOOL_QUADTAP))
257 shift = e->code == BTN_TOUCH ? 0 : (e->code - BTN_TOOL_DOUBLETAP + 1);
260 tp->fake_touches |= 1 << shift;
262 tp->fake_touches &= ~(0x1 << shift);
264 fake_touches = tp->fake_touches;
266 while (fake_touches) {
271 for (i = 0; i < tp->ntouches; i++) {
272 t = tp_get_touch(tp, i);
273 if (i < nfake_touches) {
274 tp_begin_touch(tp, t, time);
277 tp_end_touch(tp, t, time);
280 assert(tp->nfingers_down == nfake_touches);
284 tp_process_key(struct tp_dispatch *tp,
285 const struct input_event *e,
292 tp_process_button(tp, e, time);
295 case BTN_TOOL_DOUBLETAP:
296 case BTN_TOOL_TRIPLETAP:
297 case BTN_TOOL_QUADTAP:
299 tp_process_fake_touch(tp, e, time);
305 tp_unpin_finger(struct tp_dispatch *tp, struct tp_touch *t)
307 unsigned int xdist, ydist;
309 if (!t->pinned.is_pinned)
312 xdist = abs(t->x - t->pinned.center_x);
313 ydist = abs(t->y - t->pinned.center_y);
315 if (xdist * xdist + ydist * ydist >=
316 tp->buttons.motion_dist * tp->buttons.motion_dist) {
317 t->pinned.is_pinned = false;
318 tp_set_pointer(tp, t);
323 tp_pin_fingers(struct tp_dispatch *tp)
327 tp_for_each_touch(tp, t) {
328 t->is_pointer = false;
329 t->pinned.is_pinned = true;
330 t->pinned.center_x = t->x;
331 t->pinned.center_y = t->y;
336 tp_touch_active(struct tp_dispatch *tp, struct tp_touch *t)
338 return (t->state == TOUCH_BEGIN || t->state == TOUCH_UPDATE) &&
340 !t->pinned.is_pinned && tp_button_touch_active(tp, t);
344 tp_set_pointer(struct tp_dispatch *tp, struct tp_touch *t)
346 struct tp_touch *tmp = NULL;
348 /* Only set the touch as pointer if we don't have one yet */
349 tp_for_each_touch(tp, tmp) {
354 if (tp_touch_active(tp, t))
355 t->is_pointer = true;
359 tp_palm_detect(struct tp_dispatch *tp, struct tp_touch *t, uint64_t time)
361 const int PALM_TIMEOUT = 200; /* ms */
362 const int DIRECTIONS = NE|E|SE|SW|W|NW;
364 /* If labelled a touch as palm, we unlabel as palm when
365 we move out of the palm edge zone within the timeout, provided
366 the direction is within 45 degrees of the horizontal.
368 if (t->palm.is_palm) {
369 if (time < t->palm.time + PALM_TIMEOUT &&
370 (t->x > tp->palm.left_edge && t->x < tp->palm.right_edge)) {
371 int dirs = vector_get_direction(t->x - t->palm.x, t->y - t->palm.y);
372 if ((dirs & DIRECTIONS) && !(dirs & ~DIRECTIONS)) {
373 t->palm.is_palm = false;
374 tp_set_pointer(tp, t);
380 /* palm must start in exclusion zone, it's ok to move into
381 the zone without being a palm */
382 if (t->state != TOUCH_BEGIN ||
383 (t->x > tp->palm.left_edge && t->x < tp->palm.right_edge))
386 /* don't detect palm in software button areas, it's
387 likely that legitimate touches start in the area
388 covered by the exclusion zone */
389 if (tp->buttons.is_clickpad &&
390 tp_button_is_inside_softbutton_area(tp, t))
393 t->palm.is_palm = true;
400 tp_process_state(struct tp_dispatch *tp, uint64_t time)
403 struct tp_touch *first = tp_get_touch(tp, 0);
405 tp_for_each_touch(tp, t) {
406 if (!tp->has_mt && t != first && first->fake) {
410 t->dirty = first->dirty;
416 tp_palm_detect(tp, t, time);
418 tp_motion_hysteresis(tp, t);
419 tp_motion_history_push(t);
421 tp_unpin_finger(tp, t);
424 tp_button_handle_state(tp, time);
427 * We have a physical button down event on a clickpad. To avoid
428 * spurious pointer moves by the clicking finger we pin all fingers.
429 * We unpin fingers when they move more then a certain threshold to
430 * to allow drag and drop.
432 if ((tp->queued & TOUCHPAD_EVENT_BUTTON_PRESS) &&
433 tp->buttons.is_clickpad)
438 tp_post_process_state(struct tp_dispatch *tp, uint64_t time)
442 tp_for_each_touch(tp, t) {
446 if (t->state == TOUCH_END) {
447 t->state = TOUCH_NONE;
449 } else if (t->state == TOUCH_BEGIN)
450 t->state = TOUCH_UPDATE;
455 tp->buttons.old_state = tp->buttons.state;
457 tp->queued = TOUCHPAD_EVENT_NONE;
461 tp_post_twofinger_scroll(struct tp_dispatch *tp, uint64_t time)
465 double dx = 0, dy =0;
468 tp_for_each_touch(tp, t) {
469 if (tp_touch_active(tp, t) && t->dirty) {
471 tp_get_delta(t, &tmpx, &tmpy);
476 /* Stop spurious MOTION events at the end of scrolling */
477 t->is_pointer = false;
486 tp_filter_motion(tp, &dx, &dy, time);
488 /* Require at least five px scrolling to start */
489 if (dy <= -5.0 || dy >= 5.0)
490 tp->scroll.direction |= (1 << LIBINPUT_POINTER_AXIS_SCROLL_VERTICAL);
492 if (dx <= -5.0 || dx >= 5.0)
493 tp->scroll.direction |= (1 << LIBINPUT_POINTER_AXIS_SCROLL_HORIZONTAL);
496 (tp->scroll.direction & (1 << LIBINPUT_POINTER_AXIS_SCROLL_VERTICAL))) {
497 pointer_notify_axis(&tp->device->base,
499 LIBINPUT_POINTER_AXIS_SCROLL_VERTICAL,
504 (tp->scroll.direction & (1 << LIBINPUT_POINTER_AXIS_SCROLL_HORIZONTAL))) {
505 pointer_notify_axis(&tp->device->base,
507 LIBINPUT_POINTER_AXIS_SCROLL_HORIZONTAL,
513 tp_stop_scroll_events(struct tp_dispatch *tp, uint64_t time)
515 /* terminate scrolling with a zero scroll event */
516 if (tp->scroll.direction & (1 << LIBINPUT_POINTER_AXIS_SCROLL_VERTICAL))
517 pointer_notify_axis(&tp->device->base,
519 LIBINPUT_POINTER_AXIS_SCROLL_VERTICAL,
521 if (tp->scroll.direction & (1 << LIBINPUT_POINTER_AXIS_SCROLL_HORIZONTAL))
522 pointer_notify_axis(&tp->device->base,
524 LIBINPUT_POINTER_AXIS_SCROLL_HORIZONTAL,
527 tp->scroll.direction = 0;
531 tp_post_scroll_events(struct tp_dispatch *tp, uint64_t time)
534 int nfingers_down = 0;
536 /* Only count active touches for 2 finger scrolling */
537 tp_for_each_touch(tp, t) {
538 if (tp_touch_active(tp, t))
542 if (nfingers_down != 2) {
543 tp_stop_scroll_events(tp, time);
547 tp_post_twofinger_scroll(tp, time);
552 tp_post_events(struct tp_dispatch *tp, uint64_t time)
554 struct tp_touch *t = tp_current_touch(tp);
558 consumed |= tp_tap_handle_state(tp, time);
559 consumed |= tp_post_button_events(tp, time);
562 tp_stop_scroll_events(tp, time);
566 if (tp_post_scroll_events(tp, time) != 0)
569 if (!t->is_pointer) {
570 tp_for_each_touch(tp, t) {
576 if (!t->is_pointer ||
578 t->history.count < TOUCHPAD_MIN_SAMPLES)
581 tp_get_delta(t, &dx, &dy);
582 tp_filter_motion(tp, &dx, &dy, time);
584 if (dx != 0.0 || dy != 0.0)
585 pointer_notify_motion(&tp->device->base, time, dx, dy);
589 tp_process(struct evdev_dispatch *dispatch,
590 struct evdev_device *device,
591 struct input_event *e,
594 struct tp_dispatch *tp =
595 (struct tp_dispatch *)dispatch;
600 tp_process_absolute(tp, e, time);
602 tp_process_absolute_st(tp, e, time);
605 tp_process_key(tp, e, time);
608 tp_process_state(tp, time);
609 tp_post_events(tp, time);
610 tp_post_process_state(tp, time);
616 tp_destroy(struct evdev_dispatch *dispatch)
618 struct tp_dispatch *tp =
619 (struct tp_dispatch*)dispatch;
622 tp_destroy_buttons(tp);
624 filter_destroy(tp->filter);
629 static struct evdev_dispatch_interface tp_interface = {
635 tp_init_touch(struct tp_dispatch *tp,
642 tp_init_slots(struct tp_dispatch *tp,
643 struct evdev_device *device)
646 const struct input_absinfo *absinfo;
648 absinfo = libevdev_get_abs_info(device->evdev, ABS_MT_SLOT);
650 tp->ntouches = absinfo->maximum + 1;
651 tp->slot = absinfo->value;
658 { BTN_TOOL_QUINTTAP, 5 },
659 { BTN_TOOL_QUADTAP, 4 },
660 { BTN_TOOL_TRIPLETAP, 3 },
661 { BTN_TOOL_DOUBLETAP, 2 },
669 ARRAY_FOR_EACH(max_touches, m) {
670 if (libevdev_has_event_code(device->evdev,
673 tp->ntouches = m->ntouches;
678 tp->touches = calloc(tp->ntouches,
679 sizeof(struct tp_touch));
683 for (i = 0; i < tp->ntouches; i++)
684 tp_init_touch(tp, &tp->touches[i]);
690 tp_init_accel(struct tp_dispatch *tp, double diagonal)
692 struct motion_filter *accel;
696 res_x = libevdev_get_abs_resolution(tp->device->evdev,
698 res_y = libevdev_get_abs_resolution(tp->device->evdev,
701 res_x = libevdev_get_abs_resolution(tp->device->evdev,
703 res_y = libevdev_get_abs_resolution(tp->device->evdev,
708 * Not all touchpads report the same amount of units/mm (resolution).
709 * Normalize motion events to a resolution of 15.74 units/mm
710 * (== 400 dpi) as base (unaccelerated) speed. This also evens out any
711 * differences in x and y resolution, so that a circle on the
712 * touchpad does not turn into an elipse on the screen.
714 * We pick 400dpi as thats one of the many default resolutions
715 * for USB mice, so we end up with a similar base speed on the device.
717 if (res_x > 1 && res_y > 1) {
718 tp->accel.x_scale_coeff = (400/25.4) / res_x;
719 tp->accel.y_scale_coeff = (400/25.4) / res_y;
722 * For touchpads where the driver does not provide resolution, fall
723 * back to scaling motion events based on the diagonal size in units.
725 tp->accel.x_scale_coeff = DEFAULT_ACCEL_NUMERATOR / diagonal;
726 tp->accel.y_scale_coeff = DEFAULT_ACCEL_NUMERATOR / diagonal;
729 accel = create_pointer_accelator_filter(
730 pointer_accel_profile_smooth_simple);
740 tp_init_scroll(struct tp_dispatch *tp)
742 tp->scroll.direction = 0;
748 tp_init_palmdetect(struct tp_dispatch *tp,
749 struct evdev_device *device)
753 tp->palm.right_edge = INT_MAX;
754 tp->palm.left_edge = INT_MIN;
756 width = abs(device->abs.absinfo_x->maximum -
757 device->abs.absinfo_x->minimum);
759 /* Apple touchpads are always big enough to warrant palm detection */
760 if (evdev_device_get_id_vendor(device) != VENDOR_ID_APPLE) {
761 /* We don't know how big the touchpad is */
762 if (device->abs.absinfo_x->resolution == 1)
765 /* Enable palm detection on touchpads >= 80 mm. Anything smaller
766 probably won't need it, until we find out it does */
767 if (width/device->abs.absinfo_x->resolution < 80)
771 /* palm edges are 5% of the width on each side */
772 tp->palm.right_edge = device->abs.absinfo_x->maximum - width * 0.05;
773 tp->palm.left_edge = device->abs.absinfo_x->minimum + width * 0.05;
780 tp_init(struct tp_dispatch *tp,
781 struct evdev_device *device)
786 tp->base.interface = &tp_interface;
789 if (tp_init_slots(tp, device) != 0)
792 width = abs(device->abs.absinfo_x->maximum -
793 device->abs.absinfo_x->minimum);
794 height = abs(device->abs.absinfo_y->maximum -
795 device->abs.absinfo_y->minimum);
796 diagonal = sqrt(width*width + height*height);
798 tp->hysteresis.margin_x =
799 diagonal / DEFAULT_HYSTERESIS_MARGIN_DENOMINATOR;
800 tp->hysteresis.margin_y =
801 diagonal / DEFAULT_HYSTERESIS_MARGIN_DENOMINATOR;
803 if (tp_init_scroll(tp) != 0)
806 if (tp_init_accel(tp, diagonal) != 0)
809 if (tp_init_tap(tp) != 0)
812 if (tp_init_buttons(tp, device) != 0)
815 if (tp_init_palmdetect(tp, device) != 0)
821 struct evdev_dispatch *
822 evdev_mt_touchpad_create(struct evdev_device *device)
824 struct tp_dispatch *tp;
826 tp = zalloc(sizeof *tp);
830 if (tp_init(tp, device) != 0) {
831 tp_destroy(&tp->base);