touchpad: always init the left/right palm edge to INT_MIN/MAX
[platform/upstream/libinput.git] / src / evdev-mt-touchpad.c
index 4e797a8..5db204f 100644 (file)
 #include <assert.h>
 #include <math.h>
 #include <stdbool.h>
+#include <limits.h>
 
 #include "evdev-mt-touchpad.h"
 
-#define DEFAULT_CONSTANT_ACCEL_NUMERATOR 100
-#define DEFAULT_MIN_ACCEL_FACTOR 0.20
-#define DEFAULT_MAX_ACCEL_FACTOR 0.40
+#define DEFAULT_ACCEL_NUMERATOR 1200.0
 #define DEFAULT_HYSTERESIS_MARGIN_DENOMINATOR 700.0
 
 static inline int
@@ -42,30 +41,8 @@ tp_hysteresis(int in, int center, int margin)
 
        if (diff > margin)
                return center + diff - margin;
-       else if (diff < -margin)
+       else
                return center + diff + margin;
-       return center + diff;
-}
-
-static double
-tp_accel_profile(struct motion_filter *filter,
-                void *data,
-                double velocity,
-                uint64_t time)
-{
-       struct tp_dispatch *tp =
-               (struct tp_dispatch *) data;
-
-       double accel_factor;
-
-       accel_factor = velocity * tp->accel.constant_factor;
-
-       if (accel_factor > tp->accel.max_factor)
-               accel_factor = tp->accel.max_factor;
-       else if (accel_factor < tp->accel.min_factor)
-               accel_factor = tp->accel.min_factor;
-
-       return accel_factor;
 }
 
 static inline struct tp_motion *
@@ -84,10 +61,11 @@ tp_filter_motion(struct tp_dispatch *tp,
 {
        struct motion_params motion;
 
-       motion.dx = *dx;
-       motion.dy = *dy;
+       motion.dx = *dx * tp->accel.x_scale_coeff;
+       motion.dy = *dy * tp->accel.y_scale_coeff;
 
-       filter_dispatch(tp->filter, &motion, tp, time);
+       if (motion.dx != 0.0 || motion.dy != 0.0)
+               filter_dispatch(tp->filter, &motion, tp, time);
 
        *dx = motion.dx;
        *dy = motion.dy;
@@ -139,7 +117,7 @@ tp_motion_history_reset(struct tp_touch *t)
 static inline struct tp_touch *
 tp_current_touch(struct tp_dispatch *tp)
 {
-       return &tp->touches[min(tp->slot, tp->ntouches)];
+       return &tp->touches[min(tp->slot, tp->ntouches - 1)];
 }
 
 static inline struct tp_touch *
@@ -171,6 +149,7 @@ tp_end_touch(struct tp_dispatch *tp, struct tp_touch *t)
 
        t->dirty = true;
        t->is_pointer = false;
+       t->palm.is_palm = false;
        t->state = TOUCH_END;
        t->pinned.is_pinned = false;
        assert(tp->nfingers_down >= 1);
@@ -362,6 +341,7 @@ static int
 tp_touch_active(struct tp_dispatch *tp, struct tp_touch *t)
 {
        return (t->state == TOUCH_BEGIN || t->state == TOUCH_UPDATE) &&
+               !t->palm.is_palm &&
                !t->pinned.is_pinned && tp_button_touch_active(tp, t);
 }
 
@@ -381,6 +361,47 @@ tp_set_pointer(struct tp_dispatch *tp, struct tp_touch *t)
 }
 
 static void
+tp_palm_detect(struct tp_dispatch *tp, struct tp_touch *t, uint64_t time)
+{
+       const int PALM_TIMEOUT = 200; /* ms */
+       const int DIRECTIONS = NE|E|SE|SW|W|NW;
+
+       /* If labelled a touch as palm, we unlabel as palm when
+          we move out of the palm edge zone within the timeout, provided
+          the direction is within 45 degrees of the horizontal.
+        */
+       if (t->palm.is_palm) {
+               if (time < t->palm.time + PALM_TIMEOUT &&
+                   (t->x > tp->palm.left_edge && t->x < tp->palm.right_edge)) {
+                       int dirs = vector_get_direction(t->x - t->palm.x, t->y - t->palm.y);
+                       if ((dirs & DIRECTIONS) && !(dirs & ~DIRECTIONS)) {
+                               t->palm.is_palm = false;
+                               tp_set_pointer(tp, t);
+                       }
+               }
+               return;
+       }
+
+       /* palm must start in exclusion zone, it's ok to move into
+          the zone without being a palm */
+       if (t->state != TOUCH_BEGIN ||
+           (t->x > tp->palm.left_edge && t->x < tp->palm.right_edge))
+               return;
+
+       /* don't detect palm in software button areas, it's
+          likely that legitimate touches start in the area
+          covered by the exclusion zone */
+       if (tp->buttons.is_clickpad &&
+           tp_button_is_inside_softbutton_area(tp, t))
+               return;
+
+       t->palm.is_palm = true;
+       t->palm.time = time;
+       t->palm.x = t->x;
+       t->palm.y = t->y;
+}
+
+static void
 tp_process_state(struct tp_dispatch *tp, uint64_t time)
 {
        struct tp_touch *t;
@@ -392,8 +413,11 @@ tp_process_state(struct tp_dispatch *tp, uint64_t time)
                        t->y = first->y;
                        if (!t->dirty)
                                t->dirty = first->dirty;
-               } else if (!t->dirty)
+               } else if (!t->dirty) {
                        continue;
+               }
+
+               tp_palm_detect(tp, t, time);
 
                tp_motion_hysteresis(tp, t);
                tp_motion_history_push(t);
@@ -453,6 +477,8 @@ tp_post_twofinger_scroll(struct tp_dispatch *tp, uint64_t time)
                        dx += tmpx;
                        dy += tmpy;
                }
+               /* Stop spurious MOTION events at the end of scrolling */
+               t->is_pointer = false;
        }
 
        if (nchanged == 0)
@@ -463,62 +489,45 @@ tp_post_twofinger_scroll(struct tp_dispatch *tp, uint64_t time)
 
        tp_filter_motion(tp, &dx, &dy, time);
 
-       if (tp->scroll.state == SCROLL_STATE_NONE) {
-               /* Require at least one px scrolling to start */
-               if (dx <= -1.0 || dx >= 1.0) {
-                       tp->scroll.state = SCROLL_STATE_SCROLLING;
-                       tp->scroll.direction |= (1 << LIBINPUT_POINTER_AXIS_HORIZONTAL_SCROLL);
-               }
+       /* Require at least five px scrolling to start */
+       if (dy <= -5.0 || dy >= 5.0)
+               tp->scroll.direction |= (1 << LIBINPUT_POINTER_AXIS_SCROLL_VERTICAL);
 
-               if (dy <= -1.0 || dy >= 1.0) {
-                       tp->scroll.state = SCROLL_STATE_SCROLLING;
-                       tp->scroll.direction |= (1 << LIBINPUT_POINTER_AXIS_VERTICAL_SCROLL);
-               }
-
-               if (tp->scroll.state == SCROLL_STATE_NONE)
-                       return;
-       }
-
-       /* Stop spurious MOTION events at the end of scrolling */
-       tp_for_each_touch(tp, t)
-               t->is_pointer = false;
+       if (dx <= -5.0 || dx >= 5.0)
+               tp->scroll.direction |= (1 << LIBINPUT_POINTER_AXIS_SCROLL_HORIZONTAL);
 
        if (dy != 0.0 &&
-           (tp->scroll.direction & (1 << LIBINPUT_POINTER_AXIS_VERTICAL_SCROLL))) {
+           (tp->scroll.direction & (1 << LIBINPUT_POINTER_AXIS_SCROLL_VERTICAL))) {
                pointer_notify_axis(&tp->device->base,
                                    time,
-                                   LIBINPUT_POINTER_AXIS_VERTICAL_SCROLL,
-                                   li_fixed_from_double(dy));
+                                   LIBINPUT_POINTER_AXIS_SCROLL_VERTICAL,
+                                   dy);
        }
 
        if (dx != 0.0 &&
-           (tp->scroll.direction & (1 << LIBINPUT_POINTER_AXIS_HORIZONTAL_SCROLL))) {
+           (tp->scroll.direction & (1 << LIBINPUT_POINTER_AXIS_SCROLL_HORIZONTAL))) {
                pointer_notify_axis(&tp->device->base,
                                    time,
-                                   LIBINPUT_POINTER_AXIS_HORIZONTAL_SCROLL,
-                                   li_fixed_from_double(dx));
+                                   LIBINPUT_POINTER_AXIS_SCROLL_HORIZONTAL,
+                                   dx);
        }
 }
 
 static void
 tp_stop_scroll_events(struct tp_dispatch *tp, uint64_t time)
 {
-       if (tp->scroll.state == SCROLL_STATE_NONE)
-               return;
-
        /* terminate scrolling with a zero scroll event */
-       if (tp->scroll.direction & (1 << LIBINPUT_POINTER_AXIS_VERTICAL_SCROLL))
+       if (tp->scroll.direction & (1 << LIBINPUT_POINTER_AXIS_SCROLL_VERTICAL))
                pointer_notify_axis(&tp->device->base,
                                    time,
-                                   LIBINPUT_POINTER_AXIS_VERTICAL_SCROLL,
+                                   LIBINPUT_POINTER_AXIS_SCROLL_VERTICAL,
                                    0);
-       if (tp->scroll.direction & (1 << LIBINPUT_POINTER_AXIS_HORIZONTAL_SCROLL))
+       if (tp->scroll.direction & (1 << LIBINPUT_POINTER_AXIS_SCROLL_HORIZONTAL))
                pointer_notify_axis(&tp->device->base,
                                    time,
-                                   LIBINPUT_POINTER_AXIS_HORIZONTAL_SCROLL,
+                                   LIBINPUT_POINTER_AXIS_SCROLL_HORIZONTAL,
                                    0);
 
-       tp->scroll.state = SCROLL_STATE_NONE;
        tp->scroll.direction = 0;
 }
 
@@ -548,13 +557,12 @@ tp_post_events(struct tp_dispatch *tp, uint64_t time)
 {
        struct tp_touch *t = tp_current_touch(tp);
        double dx, dy;
+       int consumed = 0;
 
-       if (tp_post_button_events(tp, time) != 0) {
-               tp_stop_scroll_events(tp, time);
-               return;
-       }
+       consumed |= tp_tap_handle_state(tp, time);
+       consumed |= tp_post_button_events(tp, time);
 
-       if (tp_tap_handle_state(tp, time) != 0) {
+       if (consumed) {
                tp_stop_scroll_events(tp, time);
                return;
        }
@@ -562,27 +570,23 @@ tp_post_events(struct tp_dispatch *tp, uint64_t time)
        if (tp_post_scroll_events(tp, time) != 0)
                return;
 
-       if (t->history.count >= TOUCHPAD_MIN_SAMPLES) {
-               if (!t->is_pointer) {
-                       tp_for_each_touch(tp, t) {
-                               if (t->is_pointer)
-                                       break;
-                       }
+       if (!t->is_pointer) {
+               tp_for_each_touch(tp, t) {
+                       if (t->is_pointer)
+                               break;
                }
+       }
 
-               if (!t->is_pointer)
-                       return;
+       if (!t->is_pointer ||
+           !t->dirty ||
+           t->history.count < TOUCHPAD_MIN_SAMPLES)
+               return;
 
-               tp_get_delta(t, &dx, &dy);
-               tp_filter_motion(tp, &dx, &dy, time);
+       tp_get_delta(t, &dx, &dy);
+       tp_filter_motion(tp, &dx, &dy, time);
 
-               if (dx != 0 || dy != 0)
-                       pointer_notify_motion(
-                               &tp->device->base,
-                               time,
-                               li_fixed_from_double(dx),
-                               li_fixed_from_double(dy));
-       }
+       if (dx != 0.0 || dy != 0.0)
+               pointer_notify_motion(&tp->device->base, time, dx, dy);
 }
 
 static void
@@ -621,7 +625,7 @@ tp_destroy(struct evdev_dispatch *dispatch)
        tp_destroy_tap(tp);
        tp_destroy_buttons(tp);
 
-       motion_filter_destroy(tp->filter);
+       filter_destroy(tp->filter);
        free(tp->touches);
        free(tp);
 }
@@ -635,7 +639,7 @@ static void
 tp_init_touch(struct tp_dispatch *tp,
              struct tp_touch *t)
 {
-       t->button.state = BUTTON_STATE_NONE;
+       t->tp = tp;
 }
 
 static int
@@ -687,20 +691,51 @@ tp_init_slots(struct tp_dispatch *tp,
 }
 
 static int
-tp_init_accel(struct tp_dispatch *touchpad, double diagonal)
+tp_init_accel(struct tp_dispatch *tp, double diagonal)
 {
        struct motion_filter *accel;
+       int res_x, res_y;
+
+       if (tp->has_mt) {
+               res_x = libevdev_get_abs_resolution(tp->device->evdev,
+                                                   ABS_MT_POSITION_X);
+               res_y = libevdev_get_abs_resolution(tp->device->evdev,
+                                                   ABS_MT_POSITION_Y);
+       } else {
+               res_x = libevdev_get_abs_resolution(tp->device->evdev,
+                                                   ABS_X);
+               res_y = libevdev_get_abs_resolution(tp->device->evdev,
+                                                   ABS_Y);
+       }
 
-       touchpad->accel.constant_factor =
-               DEFAULT_CONSTANT_ACCEL_NUMERATOR / diagonal;
-       touchpad->accel.min_factor = DEFAULT_MIN_ACCEL_FACTOR;
-       touchpad->accel.max_factor = DEFAULT_MAX_ACCEL_FACTOR;
+       /*
+        * Not all touchpads report the same amount of units/mm (resolution).
+        * Normalize motion events to a resolution of 15.74 units/mm
+        * (== 400 dpi) as base (unaccelerated) speed. This also evens out any
+        * differences in x and y resolution, so that a circle on the
+        * touchpad does not turn into an elipse on the screen.
+        *
+        * We pick 400dpi as thats one of the many default resolutions
+        * for USB mice, so we end up with a similar base speed on the device.
+        */
+       if (res_x > 1 && res_y > 1) {
+               tp->accel.x_scale_coeff = (400/25.4) / res_x;
+               tp->accel.y_scale_coeff = (400/25.4) / res_y;
+       } else {
+       /*
+        * For touchpads where the driver does not provide resolution, fall
+        * back to scaling motion events based on the diagonal size in units.
+        */
+               tp->accel.x_scale_coeff = DEFAULT_ACCEL_NUMERATOR / diagonal;
+               tp->accel.y_scale_coeff = DEFAULT_ACCEL_NUMERATOR / diagonal;
+       }
 
-       accel = create_pointer_accelator_filter(tp_accel_profile);
+       accel = create_pointer_accelator_filter(
+                       pointer_accel_profile_smooth_simple);
        if (accel == NULL)
                return -1;
 
-       touchpad->filter = accel;
+       tp->filter = accel;
 
        return 0;
 }
@@ -709,12 +744,40 @@ static int
 tp_init_scroll(struct tp_dispatch *tp)
 {
        tp->scroll.direction = 0;
-       tp->scroll.state = SCROLL_STATE_NONE;
 
        return 0;
 }
 
 static int
+tp_init_palmdetect(struct tp_dispatch *tp,
+                  struct evdev_device *device)
+{
+       int width;
+
+       tp->palm.right_edge = INT_MAX;
+       tp->palm.left_edge = INT_MIN;
+
+       /* We don't know how big the touchpad is */
+       if (device->abs.absinfo_x->resolution == 1)
+               return 0;
+
+       width = abs(device->abs.absinfo_x->maximum -
+                   device->abs.absinfo_x->minimum);
+
+       /* Enable palm detection on touchpads >= 80 mm. Anything smaller
+          probably won't need it, until we find out it does */
+       if (width/device->abs.absinfo_x->resolution < 80)
+               return 0;
+
+       /* palm edges are 5% of the width on each side */
+       tp->palm.right_edge = device->abs.absinfo_x->maximum - width * 0.05;
+       tp->palm.left_edge = device->abs.absinfo_x->minimum + width * 0.05;
+
+       return 0;
+}
+
+
+static int
 tp_init(struct tp_dispatch *tp,
        struct evdev_device *device)
 {
@@ -723,14 +786,14 @@ tp_init(struct tp_dispatch *tp,
 
        tp->base.interface = &tp_interface;
        tp->device = device;
-       tp->tap.timer_fd = -1;
-       tp->buttons.timer_fd = -1;
 
        if (tp_init_slots(tp, device) != 0)
                return -1;
 
-       width = abs(device->abs.max_x - device->abs.min_x);
-       height = abs(device->abs.max_y - device->abs.min_y);
+       width = abs(device->abs.absinfo_x->maximum -
+                   device->abs.absinfo_x->minimum);
+       height = abs(device->abs.absinfo_y->maximum -
+                    device->abs.absinfo_y->minimum);
        diagonal = sqrt(width*width + height*height);
 
        tp->hysteresis.margin_x =
@@ -750,6 +813,9 @@ tp_init(struct tp_dispatch *tp,
        if (tp_init_buttons(tp, device) != 0)
                return -1;
 
+       if (tp_init_palmdetect(tp, device) != 0)
+               return -1;
+
        return 0;
 }