1 // SPDX-License-Identifier: GPL-2.0-only
3 * Input Multitouch Library
5 * Copyright (c) 2008-2010 Henrik Rydberg
8 #include <linux/input/mt.h>
9 #include <linux/export.h>
10 #include <linux/slab.h>
12 #define TRKID_SGN ((TRKID_MAX + 1) >> 1)
14 static void copy_abs(struct input_dev
*dev
, unsigned int dst
, unsigned int src
)
16 if (dev
->absinfo
&& test_bit(src
, dev
->absbit
)) {
17 dev
->absinfo
[dst
] = dev
->absinfo
[src
];
18 dev
->absinfo
[dst
].fuzz
= 0;
19 dev
->absbit
[BIT_WORD(dst
)] |= BIT_MASK(dst
);
24 * input_mt_init_slots() - initialize MT input slots
25 * @dev: input device supporting MT events and finger tracking
26 * @num_slots: number of slots used by the device
27 * @flags: mt tasks to handle in core
29 * This function allocates all necessary memory for MT slot handling
30 * in the input device, prepares the ABS_MT_SLOT and
31 * ABS_MT_TRACKING_ID events for use and sets up appropriate buffers.
32 * Depending on the flags set, it also performs pointer emulation and
33 * frame synchronization.
35 * May be called repeatedly. Returns -EINVAL if attempting to
36 * reinitialize with a different number of slots.
38 int input_mt_init_slots(struct input_dev
*dev
, unsigned int num_slots
,
41 struct input_mt
*mt
= dev
->mt
;
47 return mt
->num_slots
!= num_slots
? -EINVAL
: 0;
49 mt
= kzalloc(struct_size(mt
, slots
, num_slots
), GFP_KERNEL
);
53 mt
->num_slots
= num_slots
;
55 input_set_abs_params(dev
, ABS_MT_SLOT
, 0, num_slots
- 1, 0, 0);
56 input_set_abs_params(dev
, ABS_MT_TRACKING_ID
, 0, TRKID_MAX
, 0, 0);
58 if (flags
& (INPUT_MT_POINTER
| INPUT_MT_DIRECT
)) {
59 __set_bit(EV_KEY
, dev
->evbit
);
60 __set_bit(BTN_TOUCH
, dev
->keybit
);
62 copy_abs(dev
, ABS_X
, ABS_MT_POSITION_X
);
63 copy_abs(dev
, ABS_Y
, ABS_MT_POSITION_Y
);
64 copy_abs(dev
, ABS_PRESSURE
, ABS_MT_PRESSURE
);
66 if (flags
& INPUT_MT_POINTER
) {
67 __set_bit(BTN_TOOL_FINGER
, dev
->keybit
);
68 __set_bit(BTN_TOOL_DOUBLETAP
, dev
->keybit
);
70 __set_bit(BTN_TOOL_TRIPLETAP
, dev
->keybit
);
72 __set_bit(BTN_TOOL_QUADTAP
, dev
->keybit
);
74 __set_bit(BTN_TOOL_QUINTTAP
, dev
->keybit
);
75 __set_bit(INPUT_PROP_POINTER
, dev
->propbit
);
77 if (flags
& INPUT_MT_DIRECT
)
78 __set_bit(INPUT_PROP_DIRECT
, dev
->propbit
);
79 if (flags
& INPUT_MT_SEMI_MT
)
80 __set_bit(INPUT_PROP_SEMI_MT
, dev
->propbit
);
81 if (flags
& INPUT_MT_TRACK
) {
82 unsigned int n2
= num_slots
* num_slots
;
83 mt
->red
= kcalloc(n2
, sizeof(*mt
->red
), GFP_KERNEL
);
88 /* Mark slots as 'inactive' */
89 for (i
= 0; i
< num_slots
; i
++)
90 input_mt_set_value(&mt
->slots
[i
], ABS_MT_TRACKING_ID
, -1);
92 /* Mark slots as 'unused' */
101 EXPORT_SYMBOL(input_mt_init_slots
);
104 * input_mt_destroy_slots() - frees the MT slots of the input device
105 * @dev: input device with allocated MT slots
107 * This function is only needed in error path as the input core will
108 * automatically free the MT slots when the device is destroyed.
110 void input_mt_destroy_slots(struct input_dev
*dev
)
118 EXPORT_SYMBOL(input_mt_destroy_slots
);
121 * input_mt_report_slot_state() - report contact state
122 * @dev: input device with allocated MT slots
123 * @tool_type: the tool type to use in this slot
124 * @active: true if contact is active, false otherwise
126 * Reports a contact via ABS_MT_TRACKING_ID, and optionally
127 * ABS_MT_TOOL_TYPE. If active is true and the slot is currently
128 * inactive, or if the tool type is changed, a new tracking id is
129 * assigned to the slot. The tool type is only reported if the
130 * corresponding absbit field is set.
132 * Returns true if contact is active.
134 bool input_mt_report_slot_state(struct input_dev
*dev
,
135 unsigned int tool_type
, bool active
)
137 struct input_mt
*mt
= dev
->mt
;
138 struct input_mt_slot
*slot
;
144 slot
= &mt
->slots
[mt
->slot
];
145 slot
->frame
= mt
->frame
;
148 input_event(dev
, EV_ABS
, ABS_MT_TRACKING_ID
, -1);
152 id
= input_mt_get_value(slot
, ABS_MT_TRACKING_ID
);
154 id
= input_mt_new_trkid(mt
);
156 input_event(dev
, EV_ABS
, ABS_MT_TRACKING_ID
, id
);
157 input_event(dev
, EV_ABS
, ABS_MT_TOOL_TYPE
, tool_type
);
161 EXPORT_SYMBOL(input_mt_report_slot_state
);
164 * input_mt_report_finger_count() - report contact count
165 * @dev: input device with allocated MT slots
166 * @count: the number of contacts
168 * Reports the contact count via BTN_TOOL_FINGER, BTN_TOOL_DOUBLETAP,
169 * BTN_TOOL_TRIPLETAP and BTN_TOOL_QUADTAP.
171 * The input core ensures only the KEY events already setup for
172 * this device will produce output.
174 void input_mt_report_finger_count(struct input_dev
*dev
, int count
)
176 input_event(dev
, EV_KEY
, BTN_TOOL_FINGER
, count
== 1);
177 input_event(dev
, EV_KEY
, BTN_TOOL_DOUBLETAP
, count
== 2);
178 input_event(dev
, EV_KEY
, BTN_TOOL_TRIPLETAP
, count
== 3);
179 input_event(dev
, EV_KEY
, BTN_TOOL_QUADTAP
, count
== 4);
180 input_event(dev
, EV_KEY
, BTN_TOOL_QUINTTAP
, count
== 5);
182 EXPORT_SYMBOL(input_mt_report_finger_count
);
185 * input_mt_report_pointer_emulation() - common pointer emulation
186 * @dev: input device with allocated MT slots
187 * @use_count: report number of active contacts as finger count
189 * Performs legacy pointer emulation via BTN_TOUCH, ABS_X, ABS_Y and
190 * ABS_PRESSURE. Touchpad finger count is emulated if use_count is true.
192 * The input core ensures only the KEY and ABS axes already setup for
193 * this device will produce output.
195 void input_mt_report_pointer_emulation(struct input_dev
*dev
, bool use_count
)
197 struct input_mt
*mt
= dev
->mt
;
198 struct input_mt_slot
*oldest
;
208 for (i
= 0; i
< mt
->num_slots
; ++i
) {
209 struct input_mt_slot
*ps
= &mt
->slots
[i
];
210 int id
= input_mt_get_value(ps
, ABS_MT_TRACKING_ID
);
214 if ((id
- oldid
) & TRKID_SGN
) {
221 input_event(dev
, EV_KEY
, BTN_TOUCH
, count
> 0);
225 !test_bit(ABS_MT_DISTANCE
, dev
->absbit
) &&
226 test_bit(ABS_DISTANCE
, dev
->absbit
) &&
227 input_abs_get_val(dev
, ABS_DISTANCE
) != 0) {
229 * Force reporting BTN_TOOL_FINGER for devices that
230 * only report general hover (and not per-contact
231 * distance) when contact is in proximity but not
237 input_mt_report_finger_count(dev
, count
);
241 int x
= input_mt_get_value(oldest
, ABS_MT_POSITION_X
);
242 int y
= input_mt_get_value(oldest
, ABS_MT_POSITION_Y
);
244 input_event(dev
, EV_ABS
, ABS_X
, x
);
245 input_event(dev
, EV_ABS
, ABS_Y
, y
);
247 if (test_bit(ABS_MT_PRESSURE
, dev
->absbit
)) {
248 int p
= input_mt_get_value(oldest
, ABS_MT_PRESSURE
);
249 input_event(dev
, EV_ABS
, ABS_PRESSURE
, p
);
252 if (test_bit(ABS_MT_PRESSURE
, dev
->absbit
))
253 input_event(dev
, EV_ABS
, ABS_PRESSURE
, 0);
256 EXPORT_SYMBOL(input_mt_report_pointer_emulation
);
258 static void __input_mt_drop_unused(struct input_dev
*dev
, struct input_mt
*mt
)
262 for (i
= 0; i
< mt
->num_slots
; i
++) {
263 if (!input_mt_is_used(mt
, &mt
->slots
[i
])) {
264 input_mt_slot(dev
, i
);
265 input_event(dev
, EV_ABS
, ABS_MT_TRACKING_ID
, -1);
271 * input_mt_drop_unused() - Inactivate slots not seen in this frame
272 * @dev: input device with allocated MT slots
274 * Lift all slots not seen since the last call to this function.
276 void input_mt_drop_unused(struct input_dev
*dev
)
278 struct input_mt
*mt
= dev
->mt
;
281 __input_mt_drop_unused(dev
, mt
);
285 EXPORT_SYMBOL(input_mt_drop_unused
);
288 * input_mt_sync_frame() - synchronize mt frame
289 * @dev: input device with allocated MT slots
291 * Close the frame and prepare the internal state for a new one.
292 * Depending on the flags, marks unused slots as inactive and performs
295 void input_mt_sync_frame(struct input_dev
*dev
)
297 struct input_mt
*mt
= dev
->mt
;
298 bool use_count
= false;
303 if (mt
->flags
& INPUT_MT_DROP_UNUSED
)
304 __input_mt_drop_unused(dev
, mt
);
306 if ((mt
->flags
& INPUT_MT_POINTER
) && !(mt
->flags
& INPUT_MT_SEMI_MT
))
309 input_mt_report_pointer_emulation(dev
, use_count
);
313 EXPORT_SYMBOL(input_mt_sync_frame
);
315 static int adjust_dual(int *begin
, int step
, int *end
, int eq
, int mu
)
324 s
= p
== end
? f
+ 1 : *p
;
326 for (; p
!= end
; p
+= step
)
333 if (c
== 0 || (c
> mu
&& (!eq
|| mu
> 0)))
335 /* Improve convergence for positive matrices by penalizing overcovers */
336 if (s
< 0 && mu
<= 0)
339 for (p
= begin
; p
!= end
; p
+= step
)
342 return (c
< s
&& s
<= 0) || (f
>= 0 && f
< c
);
345 static void find_reduced_matrix(int *w
, int nr
, int nc
, int nrc
, int mu
)
349 for (k
= 0; k
< nrc
; k
++) {
350 for (i
= 0; i
< nr
; i
++)
351 adjust_dual(w
+ i
, nr
, w
+ i
+ nrc
, nr
<= nc
, mu
);
353 for (i
= 0; i
< nrc
; i
+= nr
)
354 sum
+= adjust_dual(w
+ i
, 1, w
+ i
+ nr
, nc
<= nr
, mu
);
360 static int input_mt_set_matrix(struct input_mt
*mt
,
361 const struct input_mt_pos
*pos
, int num_pos
,
364 const struct input_mt_pos
*p
;
365 struct input_mt_slot
*s
;
369 for (s
= mt
->slots
; s
!= mt
->slots
+ mt
->num_slots
; s
++) {
370 if (!input_mt_is_active(s
))
372 x
= input_mt_get_value(s
, ABS_MT_POSITION_X
);
373 y
= input_mt_get_value(s
, ABS_MT_POSITION_Y
);
374 for (p
= pos
; p
!= pos
+ num_pos
; p
++) {
375 int dx
= x
- p
->x
, dy
= y
- p
->y
;
376 *w
++ = dx
* dx
+ dy
* dy
- mu
;
383 static void input_mt_set_slots(struct input_mt
*mt
,
384 int *slots
, int num_pos
)
386 struct input_mt_slot
*s
;
389 for (j
= 0; j
!= num_pos
; j
++)
392 for (s
= mt
->slots
; s
!= mt
->slots
+ mt
->num_slots
; s
++) {
393 if (!input_mt_is_active(s
))
396 for (j
= 0; j
!= num_pos
; j
++) {
398 slots
[j
] = s
- mt
->slots
;
406 for (s
= mt
->slots
; s
!= mt
->slots
+ mt
->num_slots
; s
++) {
407 if (input_mt_is_active(s
))
410 for (j
= 0; j
!= num_pos
; j
++) {
412 slots
[j
] = s
- mt
->slots
;
420 * input_mt_assign_slots() - perform a best-match assignment
421 * @dev: input device with allocated MT slots
422 * @slots: the slot assignment to be filled
423 * @pos: the position array to match
424 * @num_pos: number of positions
425 * @dmax: maximum ABS_MT_POSITION displacement (zero for infinite)
427 * Performs a best match against the current contacts and returns
428 * the slot assignment list. New contacts are assigned to unused
431 * The assignments are balanced so that all coordinate displacements are
432 * below the euclidian distance dmax. If no such assignment can be found,
433 * some contacts are assigned to unused slots.
435 * Returns zero on success, or negative error in case of failure.
437 int input_mt_assign_slots(struct input_dev
*dev
, int *slots
,
438 const struct input_mt_pos
*pos
, int num_pos
,
441 struct input_mt
*mt
= dev
->mt
;
442 int mu
= 2 * dmax
* dmax
;
447 if (num_pos
> mt
->num_slots
)
452 nrc
= input_mt_set_matrix(mt
, pos
, num_pos
, mu
);
453 find_reduced_matrix(mt
->red
, num_pos
, nrc
/ num_pos
, nrc
, mu
);
454 input_mt_set_slots(mt
, slots
, num_pos
);
458 EXPORT_SYMBOL(input_mt_assign_slots
);
461 * input_mt_get_slot_by_key() - return slot matching key
462 * @dev: input device with allocated MT slots
463 * @key: the key of the sought slot
465 * Returns the slot of the given key, if it exists, otherwise
466 * set the key on the first unused slot and return.
468 * If no available slot can be found, -1 is returned.
469 * Note that for this function to work properly, input_mt_sync_frame() has
470 * to be called at each frame.
472 int input_mt_get_slot_by_key(struct input_dev
*dev
, int key
)
474 struct input_mt
*mt
= dev
->mt
;
475 struct input_mt_slot
*s
;
480 for (s
= mt
->slots
; s
!= mt
->slots
+ mt
->num_slots
; s
++)
481 if (input_mt_is_active(s
) && s
->key
== key
)
482 return s
- mt
->slots
;
484 for (s
= mt
->slots
; s
!= mt
->slots
+ mt
->num_slots
; s
++)
485 if (!input_mt_is_active(s
) && !input_mt_is_used(mt
, s
)) {
487 return s
- mt
->slots
;
492 EXPORT_SYMBOL(input_mt_get_slot_by_key
);