diff --git a/src/evdev-mt-touchpad.c b/src/evdev-mt-touchpad.c index eb950a2c..8585351d 100644 --- a/src/evdev-mt-touchpad.c +++ b/src/evdev-mt-touchpad.c @@ -276,6 +276,14 @@ tp_end_sequence(struct tp_dispatch *tp, struct tp_touch *t, uint64_t time) tp_end_touch(tp, t, time); } +static void +tp_stop_actions(struct tp_dispatch *tp, uint64_t time) +{ + tp_edge_scroll_stop_events(tp, time); + tp_gesture_cancel(tp, time); + tp_tap_suspend(tp, time); +} + struct normalized_coords tp_get_delta(struct tp_touch *t) { @@ -333,6 +341,11 @@ tp_process_absolute(struct tp_dispatch *tp, t->dirty = true; tp->queued |= TOUCHPAD_EVENT_OTHERAXIS; break; + case ABS_MT_TOOL_TYPE: + t->is_tool_palm = e->value == MT_TOOL_PALM; + t->dirty = true; + tp->queued |= TOUCHPAD_EVENT_OTHERAXIS; + break; } } @@ -614,6 +627,31 @@ tp_palm_detect_trackpoint_triggered(struct tp_dispatch *tp, return false; } +static bool +tp_palm_detect_tool_triggered(struct tp_dispatch *tp, + struct tp_touch *t, + uint64_t time) +{ + if (!tp->palm.use_mt_tool) + return false; + + if (t->palm.state != PALM_NONE && + t->palm.state != PALM_TOOL_PALM) + return false; + + if (t->palm.state == PALM_NONE && + t->is_tool_palm) + t->palm.state = PALM_TOOL_PALM; + else if (t->palm.state == PALM_TOOL_PALM && + !t->is_tool_palm) + t->palm.state = PALM_NONE; + + if (t->palm.state == PALM_TOOL_PALM) + tp_stop_actions(tp, time); + + return t->palm.state == PALM_TOOL_PALM; +} + static inline bool tp_palm_detect_move_out_of_edge(struct tp_dispatch *tp, struct tp_touch *t, @@ -664,16 +702,11 @@ tp_palm_detect_multifinger(struct tp_dispatch *tp, struct tp_touch *t, uint64_t return false; } -static void -tp_palm_detect(struct tp_dispatch *tp, struct tp_touch *t, uint64_t time) +static inline bool +tp_palm_detect_edge(struct tp_dispatch *tp, + struct tp_touch *t, + uint64_t time) { - - if (tp_palm_detect_dwt_triggered(tp, t, time)) - goto out; - - if (tp_palm_detect_trackpoint_triggered(tp, t, time)) - goto out; - if (t->palm.state == PALM_EDGE) { if (tp_palm_detect_multifinger(tp, t, time)) { t->palm.state = PALM_NONE; @@ -689,36 +722,78 @@ tp_palm_detect(struct tp_dispatch *tp, struct tp_touch *t, uint64_t time) evdev_log_debug(tp->device, "palm: touch released, out of edge zone\n"); } - return; + return false; } else if (tp_palm_detect_multifinger(tp, t, time)) { - return; + return false; } /* palm must start in exclusion zone, it's ok to move into the zone without being a palm */ if (t->state != TOUCH_BEGIN || (t->point.x > tp->palm.left_edge && t->point.x < tp->palm.right_edge)) - return; + return false; /* 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; + return false; if (tp_touch_get_edge(tp, t) & EDGE_RIGHT) - return; + return false; t->palm.state = PALM_EDGE; t->palm.time = time; t->palm.first = t->point; + return true; +} + +static void +tp_palm_detect(struct tp_dispatch *tp, struct tp_touch *t, uint64_t time) +{ + const char *palm_state; + enum touch_palm_state oldstate = t->palm.state; + + if (tp_palm_detect_dwt_triggered(tp, t, time)) + goto out; + + if (tp_palm_detect_trackpoint_triggered(tp, t, time)) + goto out; + + if (tp_palm_detect_tool_triggered(tp, t, time)) + goto out; + + if (tp_palm_detect_edge(tp, t, time)) + goto out; + + return; out: + if (oldstate == t->palm.state) + return; + + switch (t->palm.state) { + case PALM_EDGE: + palm_state = "edge"; + break; + case PALM_TYPING: + palm_state = "typing"; + break; + case PALM_TRACKPOINT: + palm_state = "trackpoint"; + break; + case PALM_TOOL_PALM: + palm_state = "tool-palm"; + break; + case PALM_NONE: + default: + abort(); + break; + } evdev_log_debug(tp->device, "palm: palm detected (%s)\n", - t->palm.state == PALM_EDGE ? "edge" : - t->palm.state == PALM_TYPING ? "typing" : "trackpoint"); + palm_state); } static inline const char* @@ -1364,9 +1439,7 @@ tp_trackpoint_event(uint64_t time, struct libinput_event *event, void *data) return; if (!tp->palm.trackpoint_active) { - tp_edge_scroll_stop_events(tp, time); - tp_gesture_cancel(tp, time); - tp_tap_suspend(tp, time); + tp_stop_actions(tp, time); tp->palm.trackpoint_active = true; } @@ -1479,9 +1552,7 @@ tp_keyboard_event(uint64_t time, struct libinput_event *event, void *data) ARRAY_LENGTH(tp->dwt.mod_mask))) return; - tp_edge_scroll_stop_events(tp, time); - tp_gesture_cancel(tp, time); - tp_tap_suspend(tp, time); + tp_stop_actions(tp, time); tp->dwt.keyboard_active = true; timeout = DEFAULT_KEYBOARD_ACTIVITY_TIMEOUT_1; } else { @@ -2193,21 +2264,14 @@ tp_init_dwt(struct tp_dispatch *tp, return; } -static void -tp_init_palmdetect(struct tp_dispatch *tp, - struct evdev_device *device) +static inline void +tp_init_palmdetect_edge(struct tp_dispatch *tp, + struct evdev_device *device) { double width, height; struct phys_coords mm = { 0.0, 0.0 }; struct device_coords edges; - tp->palm.right_edge = INT_MAX; - tp->palm.left_edge = INT_MIN; - - if (device->tags & EVDEV_TAG_EXTERNAL_TOUCHPAD && - !tp_is_tpkb_combo_below(device)) - return; - evdev_device_get_size(device, &width, &height); /* Enable palm detection on touchpads >= 70 mm. Anything smaller @@ -2223,8 +2287,28 @@ tp_init_palmdetect(struct tp_dispatch *tp, mm.x = width * 0.95; edges = evdev_device_mm_to_units(device, &mm); tp->palm.right_edge = edges.x; +} + +static void +tp_init_palmdetect(struct tp_dispatch *tp, + struct evdev_device *device) +{ + + tp->palm.right_edge = INT_MAX; + tp->palm.left_edge = INT_MIN; + + if (device->tags & EVDEV_TAG_EXTERNAL_TOUCHPAD && + !tp_is_tpkb_combo_below(device)) + return; tp->palm.monitor_trackpoint = true; + + if (libevdev_has_event_code(device->evdev, + EV_ABS, + ABS_MT_TOOL_TYPE)) + tp->palm.use_mt_tool = true; + + tp_init_palmdetect_edge(tp, device); } static void diff --git a/src/evdev-mt-touchpad.h b/src/evdev-mt-touchpad.h index 2d531b5e..93dd37b4 100644 --- a/src/evdev-mt-touchpad.h +++ b/src/evdev-mt-touchpad.h @@ -66,6 +66,7 @@ enum touch_palm_state { PALM_EDGE, PALM_TYPING, PALM_TRACKPOINT, + PALM_TOOL_PALM, }; enum button_event { @@ -154,6 +155,7 @@ struct tp_touch { struct device_coords point; uint64_t millis; int pressure; + bool is_tool_palm; /* MT_TOOL_PALM */ bool was_down; /* if distance == 0, false for pure hovering touches */ @@ -347,6 +349,8 @@ struct tp_dispatch { uint64_t trackpoint_last_event_time; uint32_t trackpoint_event_count; bool monitor_trackpoint; + + bool use_mt_tool; } palm; struct { diff --git a/test/test-touchpad.c b/test/test-touchpad.c index c0de99bb..2731500a 100644 --- a/test/test-touchpad.c +++ b/test/test-touchpad.c @@ -1293,6 +1293,86 @@ START_TEST(touchpad_palm_detect_both_edges) } END_TEST +static inline bool +touchpad_has_tool_palm(struct litest_device *dev) +{ + return libevdev_has_event_code(dev->evdev, EV_ABS, ABS_MT_TOOL_TYPE); +} + +START_TEST(touchpad_palm_detect_tool_palm) +{ + struct litest_device *dev = litest_current_device(); + struct libinput *li = dev->libinput; + + if (!touchpad_has_tool_palm(dev)) + return; + + litest_touch_down(dev, 0, 50, 50); + litest_touch_move_to(dev, 0, 50, 50, 70, 70, 10, 1); + litest_drain_events(li); + + litest_event(dev, EV_ABS, ABS_MT_TOOL_TYPE, MT_TOOL_PALM); + litest_event(dev, EV_SYN, SYN_REPORT, 0); + litest_touch_move_to(dev, 0, 70, 70, 50, 40, 10, 1); + litest_touch_up(dev, 0); + + litest_assert_empty_queue(li); +} +END_TEST + +START_TEST(touchpad_palm_detect_tool_palm_on_off) +{ + struct litest_device *dev = litest_current_device(); + struct libinput *li = dev->libinput; + + if (!touchpad_has_tool_palm(dev)) + return; + + litest_touch_down(dev, 0, 50, 50); + litest_touch_move_to(dev, 0, 50, 50, 70, 70, 10, 1); + litest_drain_events(li); + + litest_event(dev, EV_ABS, ABS_MT_TOOL_TYPE, MT_TOOL_PALM); + litest_event(dev, EV_SYN, SYN_REPORT, 0); + litest_touch_move_to(dev, 0, 70, 70, 50, 40, 10, 1); + + litest_assert_empty_queue(li); + + litest_event(dev, EV_ABS, ABS_MT_TOOL_TYPE, MT_TOOL_FINGER); + litest_event(dev, EV_SYN, SYN_REPORT, 0); + litest_touch_move_to(dev, 0, 50, 40, 70, 70, 10, 1); + litest_touch_up(dev, 0); + + litest_assert_only_typed_events(li, LIBINPUT_EVENT_POINTER_MOTION); +} +END_TEST + +START_TEST(touchpad_palm_detect_tool_palm_tap) +{ + struct litest_device *dev = litest_current_device(); + struct libinput *li = dev->libinput; + + if (!touchpad_has_tool_palm(dev)) + return; + + litest_enable_tap(dev->libinput_device); + litest_drain_events(li); + + litest_push_event_frame(dev); + litest_event(dev, EV_ABS, ABS_MT_TOOL_TYPE, MT_TOOL_PALM); + litest_touch_down(dev, 0, 50, 50); + litest_pop_event_frame(dev); + libinput_dispatch(li); + litest_assert_empty_queue(li); + + litest_touch_up(dev, 0); + libinput_dispatch(li); + litest_timeout_tap(); + + litest_assert_empty_queue(li); +} +END_TEST + START_TEST(touchpad_left_handed) { struct litest_device *dev = litest_current_device(); @@ -4987,6 +5067,9 @@ litest_setup_tests_touchpad(void) litest_add("touchpad:palm", touchpad_no_palm_detect_at_edge_for_edge_scrolling, LITEST_TOUCHPAD, LITEST_CLICKPAD); litest_add("touchpad:palm", touchpad_no_palm_detect_2fg_scroll, LITEST_TOUCHPAD, LITEST_SINGLE_TOUCH); litest_add("touchpad:palm", touchpad_palm_detect_both_edges, LITEST_TOUCHPAD, LITEST_SINGLE_TOUCH); + litest_add("touchpad:palm", touchpad_palm_detect_tool_palm, LITEST_TOUCHPAD, LITEST_SINGLE_TOUCH); + litest_add("touchpad:palm", touchpad_palm_detect_tool_palm_on_off, LITEST_TOUCHPAD, LITEST_SINGLE_TOUCH); + litest_add("touchpad:palm", touchpad_palm_detect_tool_palm_tap, LITEST_TOUCHPAD, LITEST_SINGLE_TOUCH); litest_add("touchpad:left-handed", touchpad_left_handed, LITEST_TOUCHPAD|LITEST_BUTTON, LITEST_CLICKPAD); litest_add_for_device("touchpad:left-handed", touchpad_left_handed_appletouch, LITEST_APPLETOUCH);