[mirror_ubuntu-jammy-kernel.git] / drivers / input / touchscreen.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 *  Generic helper functions for touchscreens and other two-dimensional
 *  pointing devices
 *
 *  Copyright (c) 2014 Sebastian Reichel <sre@kernel.org>
 */

#include <linux/property.h>
#include <linux/input.h>
#include <linux/input/mt.h>
#include <linux/input/touchscreen.h>
#include <linux/module.h>

static bool touchscreen_get_prop_u32(struct device *dev,
				     const char *property,
				     unsigned int default_value,
				     unsigned int *value)
{
	u32 val;
	int error;

	error = device_property_read_u32(dev, property, &val);
	if (error) {
		*value = default_value;
		return false;
	}

	*value = val;
	return true;
}

static void touchscreen_set_params(struct input_dev *dev,
				   unsigned long axis,
				   int min, int max, int fuzz)
{
	struct input_absinfo *absinfo;

	if (!test_bit(axis, dev->absbit)) {
		dev_warn(&dev->dev,
			 "Parameters are specified but the axis %lu is not set up\n",
			 axis);
		return;
	}

	absinfo = &dev->absinfo[axis];
	absinfo->minimum = min;
	absinfo->maximum = max;
	absinfo->fuzz = fuzz;
}

/**
 * touchscreen_parse_properties - parse common touchscreen properties
 * @input: input device that should be parsed
 * @multitouch: specifies whether parsed properties should be applied to
 *	single-touch or multi-touch axes
 * @prop: pointer to a struct touchscreen_properties into which to store
 *	axis swap and invert info for use with touchscreen_report_x_y();
 *	or %NULL
 *
 * This function parses common properties for touchscreens and sets up the
 * input device accordingly. The function keeps previously set up default
 * values if no value is specified.
 */
void touchscreen_parse_properties(struct input_dev *input, bool multitouch,
				  struct touchscreen_properties *prop)
{
	struct device *dev = input->dev.parent;
	struct input_absinfo *absinfo;
	unsigned int axis, axis_x, axis_y;
	unsigned int minimum, maximum, fuzz;
	bool data_present;

	input_alloc_absinfo(input);
	if (!input->absinfo)
		return;

	axis_x = multitouch ? ABS_MT_POSITION_X : ABS_X;
	axis_y = multitouch ? ABS_MT_POSITION_Y : ABS_Y;

	data_present = touchscreen_get_prop_u32(dev, "touchscreen-min-x",
						input_abs_get_min(input, axis_x),
						&minimum);
	data_present |= touchscreen_get_prop_u32(dev, "touchscreen-size-x",
						 input_abs_get_max(input,
								   axis_x) + 1,
						 &maximum);
	data_present |= touchscreen_get_prop_u32(dev, "touchscreen-fuzz-x",
						 input_abs_get_fuzz(input, axis_x),
						 &fuzz);
	if (data_present)
		touchscreen_set_params(input, axis_x, minimum, maximum - 1, fuzz);

	data_present = touchscreen_get_prop_u32(dev, "touchscreen-min-y",
						input_abs_get_min(input, axis_y),
						&minimum);
	data_present |= touchscreen_get_prop_u32(dev, "touchscreen-size-y",
						 input_abs_get_max(input,
								   axis_y) + 1,
						 &maximum);
	data_present |= touchscreen_get_prop_u32(dev, "touchscreen-fuzz-y",
						 input_abs_get_fuzz(input, axis_y),
						 &fuzz);
	if (data_present)
		touchscreen_set_params(input, axis_y, minimum, maximum - 1, fuzz);

	axis = multitouch ? ABS_MT_PRESSURE : ABS_PRESSURE;
	data_present = touchscreen_get_prop_u32(dev,
						"touchscreen-max-pressure",
						input_abs_get_max(input, axis),
						&maximum);
	data_present |= touchscreen_get_prop_u32(dev,
						 "touchscreen-fuzz-pressure",
						 input_abs_get_fuzz(input, axis),
						 &fuzz);
	if (data_present)
		touchscreen_set_params(input, axis, 0, maximum, fuzz);

	if (!prop)
		return;

	prop->max_x = input_abs_get_max(input, axis_x);
	prop->max_y = input_abs_get_max(input, axis_y);

	prop->invert_x =
		device_property_read_bool(dev, "touchscreen-inverted-x");
	if (prop->invert_x) {
		absinfo = &input->absinfo[axis_x];
		absinfo->maximum -= absinfo->minimum;
		absinfo->minimum = 0;
	}

	prop->invert_y =
		device_property_read_bool(dev, "touchscreen-inverted-y");
	if (prop->invert_y) {
		absinfo = &input->absinfo[axis_y];
		absinfo->maximum -= absinfo->minimum;
		absinfo->minimum = 0;
	}

	prop->swap_x_y =
		device_property_read_bool(dev, "touchscreen-swapped-x-y");
	if (prop->swap_x_y)
		swap(input->absinfo[axis_x], input->absinfo[axis_y]);
}
EXPORT_SYMBOL(touchscreen_parse_properties);

static void
touchscreen_apply_prop_to_x_y(const struct touchscreen_properties *prop,
			      unsigned int *x, unsigned int *y)
{
	if (prop->invert_x)
		*x = prop->max_x - *x;

	if (prop->invert_y)
		*y = prop->max_y - *y;

	if (prop->swap_x_y)
		swap(*x, *y);
}

/**
 * touchscreen_set_mt_pos - Set input_mt_pos coordinates
 * @pos: input_mt_pos to set coordinates of
 * @prop: pointer to a struct touchscreen_properties
 * @x: X coordinate to store in pos
 * @y: Y coordinate to store in pos
 *
 * Adjust the passed in x and y values applying any axis inversion and
 * swapping requested in the passed in touchscreen_properties and store
 * the result in a struct input_mt_pos.
 */
void touchscreen_set_mt_pos(struct input_mt_pos *pos,
			    const struct touchscreen_properties *prop,
			    unsigned int x, unsigned int y)
{
	touchscreen_apply_prop_to_x_y(prop, &x, &y);
	pos->x = x;
	pos->y = y;
}
EXPORT_SYMBOL(touchscreen_set_mt_pos);

/**
 * touchscreen_report_pos - Report touchscreen coordinates
 * @input: input_device to report coordinates for
 * @prop: pointer to a struct touchscreen_properties
 * @x: X coordinate to report
 * @y: Y coordinate to report
 * @multitouch: Report coordinates on single-touch or multi-touch axes
 *
 * Adjust the passed in x and y values applying any axis inversion and
 * swapping requested in the passed in touchscreen_properties and then
 * report the resulting coordinates on the input_dev's x and y axis.
 */
void touchscreen_report_pos(struct input_dev *input,
			    const struct touchscreen_properties *prop,
			    unsigned int x, unsigned int y,
			    bool multitouch)
{
	touchscreen_apply_prop_to_x_y(prop, &x, &y);
	input_report_abs(input, multitouch ? ABS_MT_POSITION_X : ABS_X, x);
	input_report_abs(input, multitouch ? ABS_MT_POSITION_Y : ABS_Y, y);
}
EXPORT_SYMBOL(touchscreen_report_pos);

MODULE_LICENSE("GPL v2");
MODULE_DESCRIPTION("Helper functions for touchscreens and other devices");
Commit	Line	Data
d2912cb1	1	// SPDX-License-Identifier: GPL-2.0-only
b98abe52	2	/*
51e01fc0 JL	3	* Generic helper functions for touchscreens and other two-dimensional
51e01fc0 JL	4	* pointing devices
b98abe52 SR	5	*
b98abe52 SR	6	* Copyright (c) 2014 Sebastian Reichel <sre@kernel.org>
b98abe52 SR	7	*/
b98abe52 SR	8
4200e831	9	#include <linux/property.h>
b98abe52	10	#include <linux/input.h>
0a363a38	11	#include <linux/input/mt.h>
b98abe52	12	#include <linux/input/touchscreen.h>
43173a0e	13	#include <linux/module.h>
b98abe52	14
4200e831	15	static bool touchscreen_get_prop_u32(struct device *dev,
7c494375 DT	16	const char *property,
	17	unsigned int default_value,
	18	unsigned int *value)
3eea8b5d	19	{
7c494375 DT	20	u32 val;
7c494375 DT	21	int error;
3eea8b5d	22
4200e831	23	error = device_property_read_u32(dev, property, &val);
7c494375 DT	24	if (error) {
	25	*value = default_value;
	26	return false;
	27	}
3eea8b5d	28
7c494375 DT	29	*value = val;
7c494375 DT	30	return true;
3eea8b5d MR	31	}
	32
	33	static void touchscreen_set_params(struct input_dev *dev,
	34	unsigned long axis,
d9265e8a	35	int min, int max, int fuzz)
3eea8b5d MR	36	{
	37	struct input_absinfo *absinfo;
	38
	39	if (!test_bit(axis, dev->absbit)) {
f61fd21d	40	dev_warn(&dev->dev,
51e01fc0	41	"Parameters are specified but the axis %lu is not set up\n",
f61fd21d	42	axis);
3eea8b5d MR	43	return;
	44	}
	45
	46	absinfo = &dev->absinfo[axis];
d9265e8a	47	absinfo->minimum = min;
3eea8b5d MR	48	absinfo->maximum = max;
	49	absinfo->fuzz = fuzz;
	50	}
	51
b98abe52	52	/**
51e01fc0	53	* touchscreen_parse_properties - parse common touchscreen properties
4200e831 DT	54	* @input: input device that should be parsed
	55	* @multitouch: specifies whether parsed properties should be applied to
	56	* single-touch or multi-touch axes
ed7c9870 HG	57	* @prop: pointer to a struct touchscreen_properties into which to store
	58	* axis swap and invert info for use with touchscreen_report_x_y();
	59	* or %NULL
b98abe52	60	*
51e01fc0	61	* This function parses common properties for touchscreens and sets up the
4200e831	62	* input device accordingly. The function keeps previously set up default
51e01fc0	63	* values if no value is specified.
b98abe52	64	*/
ed7c9870 HG	65	void touchscreen_parse_properties(struct input_dev *input, bool multitouch,
ed7c9870 HG	66	struct touchscreen_properties *prop)
b98abe52	67	{
4200e831	68	struct device *dev = input->dev.parent;
d9265e8a	69	struct input_absinfo *absinfo;
cc5117d6	70	unsigned int axis, axis_x, axis_y;
d9265e8a	71	unsigned int minimum, maximum, fuzz;
7c494375	72	bool data_present;
b98abe52	73
4200e831 DT	74	input_alloc_absinfo(input);
4200e831 DT	75	if (!input->absinfo)
b98abe52 SR	76	return;
b98abe52 SR	77
cc5117d6 AS	78	axis_x = multitouch ? ABS_MT_POSITION_X : ABS_X;
	79	axis_y = multitouch ? ABS_MT_POSITION_Y : ABS_Y;
	80
d9265e8a	81	data_present = touchscreen_get_prop_u32(dev, "touchscreen-min-x",
cc5117d6	82	input_abs_get_min(input, axis_x),
a02dcde5 NC	83	&minimum);
	84	data_present \|= touchscreen_get_prop_u32(dev, "touchscreen-size-x",
	85	input_abs_get_max(input,
	86	axis_x) + 1,
	87	&maximum);
	88	data_present \|= touchscreen_get_prop_u32(dev, "touchscreen-fuzz-x",
	89	input_abs_get_fuzz(input, axis_x),
	90	&fuzz);
7c494375	91	if (data_present)
cc5117d6	92	touchscreen_set_params(input, axis_x, minimum, maximum - 1, fuzz);
b98abe52	93
d9265e8a	94	data_present = touchscreen_get_prop_u32(dev, "touchscreen-min-y",
cc5117d6	95	input_abs_get_min(input, axis_y),
a02dcde5 NC	96	&minimum);
	97	data_present \|= touchscreen_get_prop_u32(dev, "touchscreen-size-y",
	98	input_abs_get_max(input,
	99	axis_y) + 1,
	100	&maximum);
	101	data_present \|= touchscreen_get_prop_u32(dev, "touchscreen-fuzz-y",
	102	input_abs_get_fuzz(input, axis_y),
	103	&fuzz);
7c494375	104	if (data_present)
cc5117d6	105	touchscreen_set_params(input, axis_y, minimum, maximum - 1, fuzz);
b98abe52	106
7c494375	107	axis = multitouch ? ABS_MT_PRESSURE : ABS_PRESSURE;
4200e831 DT	108	data_present = touchscreen_get_prop_u32(dev,
	109	"touchscreen-max-pressure",
	110	input_abs_get_max(input, axis),
a02dcde5 NC	111	&maximum);
	112	data_present \|= touchscreen_get_prop_u32(dev,
	113	"touchscreen-fuzz-pressure",
	114	input_abs_get_fuzz(input, axis),
	115	&fuzz);
7c494375	116	if (data_present)
d9265e8a	117	touchscreen_set_params(input, axis, 0, maximum, fuzz);
ed7c9870 HG	118
	119	if (!prop)
	120	return;
	121
cc5117d6 AS	122	prop->max_x = input_abs_get_max(input, axis_x);
cc5117d6 AS	123	prop->max_y = input_abs_get_max(input, axis_y);
d9265e8a	124
ed7c9870 HG	125	prop->invert_x =
ed7c9870 HG	126	device_property_read_bool(dev, "touchscreen-inverted-x");
d9265e8a	127	if (prop->invert_x) {
cc5117d6	128	absinfo = &input->absinfo[axis_x];
d9265e8a HG	129	absinfo->maximum -= absinfo->minimum;
	130	absinfo->minimum = 0;
	131	}
	132
ed7c9870 HG	133	prop->invert_y =
ed7c9870 HG	134	device_property_read_bool(dev, "touchscreen-inverted-y");
d9265e8a	135	if (prop->invert_y) {
cc5117d6	136	absinfo = &input->absinfo[axis_y];
d9265e8a HG	137	absinfo->maximum -= absinfo->minimum;
	138	absinfo->minimum = 0;
	139	}
	140
ed7c9870 HG	141	prop->swap_x_y =
ed7c9870 HG	142	device_property_read_bool(dev, "touchscreen-swapped-x-y");
ed7c9870	143	if (prop->swap_x_y)
cc5117d6	144	swap(input->absinfo[axis_x], input->absinfo[axis_y]);
b98abe52	145	}
4200e831	146	EXPORT_SYMBOL(touchscreen_parse_properties);
ed7c9870 HG	147
	148	static void
	149	touchscreen_apply_prop_to_x_y(const struct touchscreen_properties *prop,
	150	unsigned int x, unsigned int y)
	151	{
	152	if (prop->invert_x)
	153	x = prop->max_x - x;
	154
	155	if (prop->invert_y)
	156	y = prop->max_y - y;
	157
	158	if (prop->swap_x_y)
	159	swap(x, y);
	160	}
	161
	162	/**
	163	* touchscreen_set_mt_pos - Set input_mt_pos coordinates
	164	* @pos: input_mt_pos to set coordinates of
	165	* @prop: pointer to a struct touchscreen_properties
	166	* @x: X coordinate to store in pos
	167	* @y: Y coordinate to store in pos
	168	*
	169	* Adjust the passed in x and y values applying any axis inversion and
	170	* swapping requested in the passed in touchscreen_properties and store
	171	* the result in a struct input_mt_pos.
	172	*/
	173	void touchscreen_set_mt_pos(struct input_mt_pos *pos,
	174	const struct touchscreen_properties *prop,
	175	unsigned int x, unsigned int y)
	176	{
	177	touchscreen_apply_prop_to_x_y(prop, &x, &y);
	178	pos->x = x;
	179	pos->y = y;
	180	}
	181	EXPORT_SYMBOL(touchscreen_set_mt_pos);
	182
	183	/**
	184	* touchscreen_report_pos - Report touchscreen coordinates
	185	* @input: input_device to report coordinates for
	186	* @prop: pointer to a struct touchscreen_properties
	187	* @x: X coordinate to report
	188	* @y: Y coordinate to report
	189	* @multitouch: Report coordinates on single-touch or multi-touch axes
	190	*
	191	* Adjust the passed in x and y values applying any axis inversion and
	192	* swapping requested in the passed in touchscreen_properties and then
	193	* report the resulting coordinates on the input_dev's x and y axis.
	194	*/
	195	void touchscreen_report_pos(struct input_dev *input,
	196	const struct touchscreen_properties *prop,
	197	unsigned int x, unsigned int y,
	198	bool multitouch)
	199	{
	200	touchscreen_apply_prop_to_x_y(prop, &x, &y);
	201	input_report_abs(input, multitouch ? ABS_MT_POSITION_X : ABS_X, x);
	202	input_report_abs(input, multitouch ? ABS_MT_POSITION_Y : ABS_Y, y);
	203	}
	204	EXPORT_SYMBOL(touchscreen_report_pos);
43173a0e AB	205
43173a0e AB	206	MODULE_LICENSE("GPL v2");
51e01fc0	207	MODULE_DESCRIPTION("Helper functions for touchscreens and other devices");