xref: /linux-6.15/include/linux/input/mt.h (revision 348cbf98)
1d2912cb1SThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-only */
247c78e89SHenrik Rydberg #ifndef _INPUT_MT_H
347c78e89SHenrik Rydberg #define _INPUT_MT_H
447c78e89SHenrik Rydberg 
547c78e89SHenrik Rydberg /*
647c78e89SHenrik Rydberg  * Input Multitouch Library
747c78e89SHenrik Rydberg  *
847c78e89SHenrik Rydberg  * Copyright (c) 2010 Henrik Rydberg
947c78e89SHenrik Rydberg  */
1047c78e89SHenrik Rydberg 
1147c78e89SHenrik Rydberg #include <linux/input.h>
1247c78e89SHenrik Rydberg 
13c5f4dec1SHenrik Rydberg #define TRKID_MAX	0xffff
14c5f4dec1SHenrik Rydberg 
1555e49089SHenrik Rydberg #define INPUT_MT_POINTER	0x0001	/* pointer device, e.g. trackpad */
1655e49089SHenrik Rydberg #define INPUT_MT_DIRECT		0x0002	/* direct device, e.g. touchscreen */
1755e49089SHenrik Rydberg #define INPUT_MT_DROP_UNUSED	0x0004	/* drop contacts not seen in frame */
187c1a8789SHenrik Rydberg #define INPUT_MT_TRACK		0x0008	/* use in-kernel tracking */
19a0ef6a34SHenrik Rydberg #define INPUT_MT_SEMI_MT	0x0010	/* semi-mt device, finger count handled manually */
207c1a8789SHenrik Rydberg 
2147c78e89SHenrik Rydberg /**
2247c78e89SHenrik Rydberg  * struct input_mt_slot - represents the state of an input MT slot
2347c78e89SHenrik Rydberg  * @abs: holds current values of ABS_MT axes for this slot
2455e49089SHenrik Rydberg  * @frame: last frame at which input_mt_report_slot_state() was called
2517a465a7SHenrik Rydberg  * @key: optional driver designation of this slot
2647c78e89SHenrik Rydberg  */
2747c78e89SHenrik Rydberg struct input_mt_slot {
2847c78e89SHenrik Rydberg 	int abs[ABS_MT_LAST - ABS_MT_FIRST + 1];
2955e49089SHenrik Rydberg 	unsigned int frame;
3017a465a7SHenrik Rydberg 	unsigned int key;
3147c78e89SHenrik Rydberg };
3247c78e89SHenrik Rydberg 
338d18fba2SHenrik Rydberg /**
348d18fba2SHenrik Rydberg  * struct input_mt - state of tracked contacts
358d18fba2SHenrik Rydberg  * @trkid: stores MT tracking ID for the next contact
368d18fba2SHenrik Rydberg  * @num_slots: number of MT slots the device uses
378d18fba2SHenrik Rydberg  * @slot: MT slot currently being transmitted
38b4adbbefSHenrik Rydberg  * @flags: input_mt operation flags
3955e49089SHenrik Rydberg  * @frame: increases every time input_mt_sync_frame() is called
407c1a8789SHenrik Rydberg  * @red: reduced cost matrix for in-kernel tracking
418d18fba2SHenrik Rydberg  * @slots: array of slots holding current values of tracked contacts
428d18fba2SHenrik Rydberg  */
438d18fba2SHenrik Rydberg struct input_mt {
448d18fba2SHenrik Rydberg 	int trkid;
458d18fba2SHenrik Rydberg 	int num_slots;
468d18fba2SHenrik Rydberg 	int slot;
47b4adbbefSHenrik Rydberg 	unsigned int flags;
4855e49089SHenrik Rydberg 	unsigned int frame;
497c1a8789SHenrik Rydberg 	int *red;
50*348cbf98SKees Cook 	struct input_mt_slot slots[] __counted_by(num_slots);
518d18fba2SHenrik Rydberg };
528d18fba2SHenrik Rydberg 
input_mt_set_value(struct input_mt_slot * slot,unsigned code,int value)5347c78e89SHenrik Rydberg static inline void input_mt_set_value(struct input_mt_slot *slot,
5447c78e89SHenrik Rydberg 				      unsigned code, int value)
5547c78e89SHenrik Rydberg {
5647c78e89SHenrik Rydberg 	slot->abs[code - ABS_MT_FIRST] = value;
5747c78e89SHenrik Rydberg }
5847c78e89SHenrik Rydberg 
input_mt_get_value(const struct input_mt_slot * slot,unsigned code)5947c78e89SHenrik Rydberg static inline int input_mt_get_value(const struct input_mt_slot *slot,
6047c78e89SHenrik Rydberg 				     unsigned code)
6147c78e89SHenrik Rydberg {
6247c78e89SHenrik Rydberg 	return slot->abs[code - ABS_MT_FIRST];
6347c78e89SHenrik Rydberg }
6447c78e89SHenrik Rydberg 
input_mt_is_active(const struct input_mt_slot * slot)657c1a8789SHenrik Rydberg static inline bool input_mt_is_active(const struct input_mt_slot *slot)
667c1a8789SHenrik Rydberg {
677c1a8789SHenrik Rydberg 	return input_mt_get_value(slot, ABS_MT_TRACKING_ID) >= 0;
687c1a8789SHenrik Rydberg }
697c1a8789SHenrik Rydberg 
input_mt_is_used(const struct input_mt * mt,const struct input_mt_slot * slot)7029807d1eSBenjamin Tissoires static inline bool input_mt_is_used(const struct input_mt *mt,
7129807d1eSBenjamin Tissoires 				    const struct input_mt_slot *slot)
7229807d1eSBenjamin Tissoires {
7329807d1eSBenjamin Tissoires 	return slot->frame == mt->frame;
7429807d1eSBenjamin Tissoires }
7529807d1eSBenjamin Tissoires 
76b4adbbefSHenrik Rydberg int input_mt_init_slots(struct input_dev *dev, unsigned int num_slots,
77b4adbbefSHenrik Rydberg 			unsigned int flags);
7847c78e89SHenrik Rydberg void input_mt_destroy_slots(struct input_dev *dev);
7947c78e89SHenrik Rydberg 
input_mt_new_trkid(struct input_mt * mt)808d18fba2SHenrik Rydberg static inline int input_mt_new_trkid(struct input_mt *mt)
81c5f4dec1SHenrik Rydberg {
828d18fba2SHenrik Rydberg 	return mt->trkid++ & TRKID_MAX;
83c5f4dec1SHenrik Rydberg }
84c5f4dec1SHenrik Rydberg 
input_mt_slot(struct input_dev * dev,int slot)8547c78e89SHenrik Rydberg static inline void input_mt_slot(struct input_dev *dev, int slot)
8647c78e89SHenrik Rydberg {
8747c78e89SHenrik Rydberg 	input_event(dev, EV_ABS, ABS_MT_SLOT, slot);
8847c78e89SHenrik Rydberg }
8947c78e89SHenrik Rydberg 
input_is_mt_value(int axis)90b89529a1SHenrik Rydberg static inline bool input_is_mt_value(int axis)
91b89529a1SHenrik Rydberg {
92b89529a1SHenrik Rydberg 	return axis >= ABS_MT_FIRST && axis <= ABS_MT_LAST;
93b89529a1SHenrik Rydberg }
94b89529a1SHenrik Rydberg 
input_is_mt_axis(int axis)9580b4895aSJeff Brown static inline bool input_is_mt_axis(int axis)
9680b4895aSJeff Brown {
97b89529a1SHenrik Rydberg 	return axis == ABS_MT_SLOT || input_is_mt_value(axis);
9880b4895aSJeff Brown }
9980b4895aSJeff Brown 
100bf6247a7SDmitry Torokhov bool input_mt_report_slot_state(struct input_dev *dev,
101c5f4dec1SHenrik Rydberg 				unsigned int tool_type, bool active);
102c5f4dec1SHenrik Rydberg 
input_mt_report_slot_inactive(struct input_dev * dev)1035fc70e35SJiada Wang static inline void input_mt_report_slot_inactive(struct input_dev *dev)
1045fc70e35SJiada Wang {
1055fc70e35SJiada Wang 	input_mt_report_slot_state(dev, 0, false);
1065fc70e35SJiada Wang }
1075fc70e35SJiada Wang 
108c5f4dec1SHenrik Rydberg void input_mt_report_finger_count(struct input_dev *dev, int count);
109c5f4dec1SHenrik Rydberg void input_mt_report_pointer_emulation(struct input_dev *dev, bool use_count);
110f8ec8949SHenrik Rydberg void input_mt_drop_unused(struct input_dev *dev);
111c5f4dec1SHenrik Rydberg 
11255e49089SHenrik Rydberg void input_mt_sync_frame(struct input_dev *dev);
11355e49089SHenrik Rydberg 
1147c1a8789SHenrik Rydberg /**
1157c1a8789SHenrik Rydberg  * struct input_mt_pos - contact position
1167c1a8789SHenrik Rydberg  * @x: horizontal coordinate
1177c1a8789SHenrik Rydberg  * @y: vertical coordinate
1187c1a8789SHenrik Rydberg  */
1197c1a8789SHenrik Rydberg struct input_mt_pos {
1207c1a8789SHenrik Rydberg 	s16 x, y;
1217c1a8789SHenrik Rydberg };
1227c1a8789SHenrik Rydberg 
1237c1a8789SHenrik Rydberg int input_mt_assign_slots(struct input_dev *dev, int *slots,
124448c7f38SHenrik Rydberg 			  const struct input_mt_pos *pos, int num_pos,
125448c7f38SHenrik Rydberg 			  int dmax);
1267c1a8789SHenrik Rydberg 
12717a465a7SHenrik Rydberg int input_mt_get_slot_by_key(struct input_dev *dev, int key);
12817a465a7SHenrik Rydberg 
12947c78e89SHenrik Rydberg #endif
130