[linux-2.6-block.git] / drivers / input / mouse / trackpoint.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * Stephen Evanchik <evanchsa@gmail.com>
 *
 * Trademarks are the property of their respective owners.
 */

#include <linux/slab.h>
#include <linux/delay.h>
#include <linux/serio.h>
#include <linux/module.h>
#include <linux/input.h>
#include <linux/libps2.h>
#include <linux/proc_fs.h>
#include <linux/uaccess.h>
#include "psmouse.h"
#include "trackpoint.h"

static const char * const trackpoint_variants[] = {
	[TP_VARIANT_IBM]		= "IBM",
	[TP_VARIANT_ALPS]		= "ALPS",
	[TP_VARIANT_ELAN]		= "Elan",
	[TP_VARIANT_NXP]		= "NXP",
	[TP_VARIANT_JYT_SYNAPTICS]	= "JYT_Synaptics",
	[TP_VARIANT_SYNAPTICS]		= "Synaptics",
};

/*
 * Power-on Reset: Resets all trackpoint parameters, including RAM values,
 * to defaults.
 * Returns zero on success, non-zero on failure.
 */
static int trackpoint_power_on_reset(struct ps2dev *ps2dev)
{
	u8 param[2] = { TP_POR };
	int err;

	err = ps2_command(ps2dev, param, MAKE_PS2_CMD(1, 2, TP_COMMAND));
	if (err)
		return err;

	/* Check for success response -- 0xAA00 */
	if (param[0] != 0xAA || param[1] != 0x00)
		return -ENODEV;

	return 0;
}

/*
 * Device IO: read, write and toggle bit
 */
static int trackpoint_read(struct ps2dev *ps2dev, u8 loc, u8 *results)
{
	results[0] = loc;

	return ps2_command(ps2dev, results, MAKE_PS2_CMD(1, 1, TP_COMMAND));
}

static int trackpoint_write(struct ps2dev *ps2dev, u8 loc, u8 val)
{
	u8 param[3] = { TP_WRITE_MEM, loc, val };

	return ps2_command(ps2dev, param, MAKE_PS2_CMD(3, 0, TP_COMMAND));
}

static int trackpoint_toggle_bit(struct ps2dev *ps2dev, u8 loc, u8 mask)
{
	u8 param[3] = { TP_TOGGLE, loc, mask };

	/* Bad things will happen if the loc param isn't in this range */
	if (loc < 0x20 || loc >= 0x2F)
		return -EINVAL;

	return ps2_command(ps2dev, param, MAKE_PS2_CMD(3, 0, TP_COMMAND));
}

static int trackpoint_update_bit(struct ps2dev *ps2dev,
				 u8 loc, u8 mask, u8 value)
{
	int retval;
	u8 data;

	retval = trackpoint_read(ps2dev, loc, &data);
	if (retval)
		return retval;

	if (((data & mask) == mask) != !!value)
		retval = trackpoint_toggle_bit(ps2dev, loc, mask);

	return retval;
}

/*
 * Trackpoint-specific attributes
 */
struct trackpoint_attr_data {
	size_t field_offset;
	u8 command;
	u8 mask;
	bool inverted;
	u8 power_on_default;
};

static ssize_t trackpoint_show_int_attr(struct psmouse *psmouse,
					void *data, char *buf)
{
	struct trackpoint_data *tp = psmouse->private;
	struct trackpoint_attr_data *attr = data;
	u8 value = *(u8 *)((void *)tp + attr->field_offset);

	if (attr->inverted)
		value = !value;

	return sprintf(buf, "%u\n", value);
}

static ssize_t trackpoint_set_int_attr(struct psmouse *psmouse, void *data,
					const char *buf, size_t count)
{
	struct trackpoint_data *tp = psmouse->private;
	struct trackpoint_attr_data *attr = data;
	u8 *field = (void *)tp + attr->field_offset;
	u8 value;
	int err;

	err = kstrtou8(buf, 10, &value);
	if (err)
		return err;

	*field = value;
	err = trackpoint_write(&psmouse->ps2dev, attr->command, value);

	return err ?: count;
}

#define TRACKPOINT_INT_ATTR(_name, _command, _default)				\
	static struct trackpoint_attr_data trackpoint_attr_##_name = {		\
		.field_offset = offsetof(struct trackpoint_data, _name),	\
		.command = _command,						\
		.power_on_default = _default,					\
	};									\
	PSMOUSE_DEFINE_ATTR(_name, S_IWUSR | S_IRUGO,				\
			    &trackpoint_attr_##_name,				\
			    trackpoint_show_int_attr, trackpoint_set_int_attr)

static ssize_t trackpoint_set_bit_attr(struct psmouse *psmouse, void *data,
					const char *buf, size_t count)
{
	struct trackpoint_data *tp = psmouse->private;
	struct trackpoint_attr_data *attr = data;
	bool *field = (void *)tp + attr->field_offset;
	bool value;
	int err;

	err = kstrtobool(buf, &value);
	if (err)
		return err;

	if (attr->inverted)
		value = !value;

	if (*field != value) {
		*field = value;
		err = trackpoint_toggle_bit(&psmouse->ps2dev,
					    attr->command, attr->mask);
	}

	return err ?: count;
}


#define TRACKPOINT_BIT_ATTR(_name, _command, _mask, _inv, _default)	\
static struct trackpoint_attr_data trackpoint_attr_##_name = {		\
	.field_offset		= offsetof(struct trackpoint_data,	\
					   _name),			\
	.command		= _command,				\
	.mask			= _mask,				\
	.inverted		= _inv,					\
	.power_on_default	= _default,				\
	};								\
PSMOUSE_DEFINE_ATTR(_name, S_IWUSR | S_IRUGO,				\
		    &trackpoint_attr_##_name,				\
		    trackpoint_show_int_attr, trackpoint_set_bit_attr)

TRACKPOINT_INT_ATTR(sensitivity, TP_SENS, TP_DEF_SENS);
TRACKPOINT_INT_ATTR(speed, TP_SPEED, TP_DEF_SPEED);
TRACKPOINT_INT_ATTR(inertia, TP_INERTIA, TP_DEF_INERTIA);
TRACKPOINT_INT_ATTR(reach, TP_REACH, TP_DEF_REACH);
TRACKPOINT_INT_ATTR(draghys, TP_DRAGHYS, TP_DEF_DRAGHYS);
TRACKPOINT_INT_ATTR(mindrag, TP_MINDRAG, TP_DEF_MINDRAG);
TRACKPOINT_INT_ATTR(thresh, TP_THRESH, TP_DEF_THRESH);
TRACKPOINT_INT_ATTR(upthresh, TP_UP_THRESH, TP_DEF_UP_THRESH);
TRACKPOINT_INT_ATTR(ztime, TP_Z_TIME, TP_DEF_Z_TIME);
TRACKPOINT_INT_ATTR(jenks, TP_JENKS_CURV, TP_DEF_JENKS_CURV);
TRACKPOINT_INT_ATTR(drift_time, TP_DRIFT_TIME, TP_DEF_DRIFT_TIME);

TRACKPOINT_BIT_ATTR(press_to_select, TP_TOGGLE_PTSON, TP_MASK_PTSON, false,
		    TP_DEF_PTSON);
TRACKPOINT_BIT_ATTR(skipback, TP_TOGGLE_SKIPBACK, TP_MASK_SKIPBACK, false,
		    TP_DEF_SKIPBACK);
TRACKPOINT_BIT_ATTR(ext_dev, TP_TOGGLE_EXT_DEV, TP_MASK_EXT_DEV, true,
		    TP_DEF_EXT_DEV);

static bool trackpoint_is_attr_available(struct psmouse *psmouse,
					 struct attribute *attr)
{
	struct trackpoint_data *tp = psmouse->private;

	return tp->variant_id == TP_VARIANT_IBM ||
		attr == &psmouse_attr_sensitivity.dattr.attr ||
		attr == &psmouse_attr_press_to_select.dattr.attr;
}

static umode_t trackpoint_is_attr_visible(struct kobject *kobj,
					  struct attribute *attr, int n)
{
	struct device *dev = kobj_to_dev(kobj);
	struct serio *serio = to_serio_port(dev);
	struct psmouse *psmouse = psmouse_from_serio(serio);

	return trackpoint_is_attr_available(psmouse, attr) ? attr->mode : 0;
}

static struct attribute *trackpoint_attrs[] = {
	&psmouse_attr_sensitivity.dattr.attr,
	&psmouse_attr_speed.dattr.attr,
	&psmouse_attr_inertia.dattr.attr,
	&psmouse_attr_reach.dattr.attr,
	&psmouse_attr_draghys.dattr.attr,
	&psmouse_attr_mindrag.dattr.attr,
	&psmouse_attr_thresh.dattr.attr,
	&psmouse_attr_upthresh.dattr.attr,
	&psmouse_attr_ztime.dattr.attr,
	&psmouse_attr_jenks.dattr.attr,
	&psmouse_attr_drift_time.dattr.attr,
	&psmouse_attr_press_to_select.dattr.attr,
	&psmouse_attr_skipback.dattr.attr,
	&psmouse_attr_ext_dev.dattr.attr,
	NULL
};

static struct attribute_group trackpoint_attr_group = {
	.is_visible	= trackpoint_is_attr_visible,
	.attrs		= trackpoint_attrs,
};

#define TRACKPOINT_UPDATE(_power_on, _psmouse, _tp, _name)		\
do {									\
	struct trackpoint_attr_data *_attr = &trackpoint_attr_##_name;	\
									\
	if ((!_power_on || _tp->_name != _attr->power_on_default) &&	\
	    trackpoint_is_attr_available(_psmouse,			\
				&psmouse_attr_##_name.dattr.attr)) {	\
		if (!_attr->mask)					\
			trackpoint_write(&_psmouse->ps2dev,		\
					 _attr->command, _tp->_name);	\
		else							\
			trackpoint_update_bit(&_psmouse->ps2dev,	\
					_attr->command, _attr->mask,	\
					_tp->_name);			\
	}								\
} while (0)

#define TRACKPOINT_SET_POWER_ON_DEFAULT(_tp, _name)			\
do {									\
	_tp->_name = trackpoint_attr_##_name.power_on_default;		\
} while (0)

static int trackpoint_start_protocol(struct psmouse *psmouse,
				     u8 *variant_id, u8 *firmware_id)
{
	u8 param[2] = { 0 };
	int error;

	error = ps2_command(&psmouse->ps2dev,
			    param, MAKE_PS2_CMD(0, 2, TP_READ_ID));
	if (error)
		return error;

	switch (param[0]) {
	case TP_VARIANT_IBM:
	case TP_VARIANT_ALPS:
	case TP_VARIANT_ELAN:
	case TP_VARIANT_NXP:
	case TP_VARIANT_JYT_SYNAPTICS:
	case TP_VARIANT_SYNAPTICS:
		if (variant_id)
			*variant_id = param[0];
		if (firmware_id)
			*firmware_id = param[1];
		return 0;
	}

	return -ENODEV;
}

/*
 * Write parameters to trackpad.
 * in_power_on_state: Set to true if TP is in default / power-on state (ex. if
 *		      power-on reset was run). If so, values will only be
 *		      written to TP if they differ from power-on default.
 */
static int trackpoint_sync(struct psmouse *psmouse, bool in_power_on_state)
{
	struct trackpoint_data *tp = psmouse->private;

	if (!in_power_on_state && tp->variant_id == TP_VARIANT_IBM) {
		/*
		 * Disable features that may make device unusable
		 * with this driver.
		 */
		trackpoint_update_bit(&psmouse->ps2dev, TP_TOGGLE_TWOHAND,
				      TP_MASK_TWOHAND, TP_DEF_TWOHAND);

		trackpoint_update_bit(&psmouse->ps2dev, TP_TOGGLE_SOURCE_TAG,
				      TP_MASK_SOURCE_TAG, TP_DEF_SOURCE_TAG);

		trackpoint_update_bit(&psmouse->ps2dev, TP_TOGGLE_MB,
				      TP_MASK_MB, TP_DEF_MB);
	}

	/*
	 * These properties can be changed in this driver. Only
	 * configure them if the values are non-default or if the TP is in
	 * an unknown state.
	 */
	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, sensitivity);
	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, inertia);
	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, speed);
	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, reach);
	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, draghys);
	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, mindrag);
	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, thresh);
	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, upthresh);
	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, ztime);
	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, jenks);
	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, drift_time);

	/* toggles */
	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, press_to_select);
	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, skipback);
	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, ext_dev);

	return 0;
}

static void trackpoint_defaults(struct trackpoint_data *tp)
{
	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, sensitivity);
	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, speed);
	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, reach);
	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, draghys);
	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, mindrag);
	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, thresh);
	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, upthresh);
	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, ztime);
	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, jenks);
	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, drift_time);
	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, inertia);

	/* toggles */
	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, press_to_select);
	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, skipback);
	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, ext_dev);
}

static void trackpoint_disconnect(struct psmouse *psmouse)
{
	device_remove_group(&psmouse->ps2dev.serio->dev,
			    &trackpoint_attr_group);

	kfree(psmouse->private);
	psmouse->private = NULL;
}

static int trackpoint_reconnect(struct psmouse *psmouse)
{
	struct trackpoint_data *tp = psmouse->private;
	int error;
	bool was_reset;

	error = trackpoint_start_protocol(psmouse, NULL, NULL);
	if (error)
		return error;

	was_reset = tp->variant_id == TP_VARIANT_IBM &&
		    trackpoint_power_on_reset(&psmouse->ps2dev) == 0;

	error = trackpoint_sync(psmouse, was_reset);
	if (error)
		return error;

	return 0;
}

int trackpoint_detect(struct psmouse *psmouse, bool set_properties)
{
	struct ps2dev *ps2dev = &psmouse->ps2dev;
	struct trackpoint_data *tp;
	u8 variant_id;
	u8 firmware_id;
	u8 button_info;
	int error;

	error = trackpoint_start_protocol(psmouse, &variant_id, &firmware_id);
	if (error)
		return error;

	if (!set_properties)
		return 0;

	tp = kzalloc(sizeof(*tp), GFP_KERNEL);
	if (!tp)
		return -ENOMEM;

	trackpoint_defaults(tp);
	tp->variant_id = variant_id;
	tp->firmware_id = firmware_id;

	psmouse->private = tp;

	psmouse->vendor = trackpoint_variants[variant_id];
	psmouse->name = "TrackPoint";

	psmouse->reconnect = trackpoint_reconnect;
	psmouse->disconnect = trackpoint_disconnect;

	if (variant_id != TP_VARIANT_IBM) {
		/* Newer variants do not support extended button query. */
		button_info = 0x33;
	} else {
		error = trackpoint_read(ps2dev, TP_EXT_BTN, &button_info);
		if (error) {
			psmouse_warn(psmouse,
				     "failed to get extended button data, assuming 3 buttons\n");
			button_info = 0x33;
		} else if (!button_info) {
			psmouse_warn(psmouse,
				     "got 0 in extended button data, assuming 3 buttons\n");
			button_info = 0x33;
		}
	}

	if ((button_info & 0x0f) >= 3)
		input_set_capability(psmouse->dev, EV_KEY, BTN_MIDDLE);

	__set_bit(INPUT_PROP_POINTER, psmouse->dev->propbit);
	__set_bit(INPUT_PROP_POINTING_STICK, psmouse->dev->propbit);

	if (variant_id != TP_VARIANT_IBM ||
	    trackpoint_power_on_reset(ps2dev) != 0) {
		/*
		 * Write defaults to TP if we did not reset the trackpoint.
		 */
		trackpoint_sync(psmouse, false);
	}

	error = device_add_group(&ps2dev->serio->dev, &trackpoint_attr_group);
	if (error) {
		psmouse_err(psmouse,
			    "failed to create sysfs attributes, error: %d\n",
			    error);
		kfree(psmouse->private);
		psmouse->private = NULL;
		return -1;
	}

	psmouse_info(psmouse,
		     "%s TrackPoint firmware: 0x%02x, buttons: %d/%d\n",
		     psmouse->vendor, firmware_id,
		     (button_info & 0xf0) >> 4, button_info & 0x0f);

	return 0;
}
Commit	Line	Data
d2912cb1	1	// SPDX-License-Identifier: GPL-2.0-only
541e316a SE	2	/*
	3	* Stephen Evanchik <evanchsa@gmail.com>
	4	*
541e316a SE	5	* Trademarks are the property of their respective owners.
	6	*/
	7
5a0e3ad6	8	#include <linux/slab.h>
541e316a SE	9	#include <linux/delay.h>
	10	#include <linux/serio.h>
	11	#include <linux/module.h>
541e316a SE	12	#include <linux/input.h>
	13	#include <linux/libps2.h>
	14	#include <linux/proc_fs.h>
7c0f6ba6	15	#include <linux/uaccess.h>
541e316a SE	16	#include "psmouse.h"
	17	#include "trackpoint.h"
	18
2a924d71	19	static const char * const trackpoint_variants[] = {
6c77545a VH	20	[TP_VARIANT_IBM] = "IBM",
	21	[TP_VARIANT_ALPS] = "ALPS",
	22	[TP_VARIANT_ELAN] = "Elan",
	23	[TP_VARIANT_NXP] = "NXP",
	24	[TP_VARIANT_JYT_SYNAPTICS] = "JYT_Synaptics",
	25	[TP_VARIANT_SYNAPTICS] = "Synaptics",
2a924d71 DT	26	};
2a924d71 DT	27
0c6a6165 SN	28	/*
	29	* Power-on Reset: Resets all trackpoint parameters, including RAM values,
	30	* to defaults.
	31	* Returns zero on success, non-zero on failure.
	32	*/
	33	static int trackpoint_power_on_reset(struct ps2dev *ps2dev)
	34	{
3aceaa34 DT	35	u8 param[2] = { TP_POR };
3aceaa34 DT	36	int err;
0c6a6165	37
3aceaa34 DT	38	err = ps2_command(ps2dev, param, MAKE_PS2_CMD(1, 2, TP_COMMAND));
	39	if (err)
	40	return err;
0c6a6165 SN	41
0c6a6165 SN	42	/* Check for success response -- 0xAA00 */
3aceaa34	43	if (param[0] != 0xAA \|\| param[1] != 0x00)
2a924d71	44	return -ENODEV;
0c6a6165 SN	45
	46	return 0;
	47	}
	48
541e316a SE	49	/*
	50	* Device IO: read, write and toggle bit
	51	*/
2a924d71	52	static int trackpoint_read(struct ps2dev ps2dev, u8 loc, u8 results)
541e316a	53	{
3aceaa34	54	results[0] = loc;
541e316a	55
3aceaa34	56	return ps2_command(ps2dev, results, MAKE_PS2_CMD(1, 1, TP_COMMAND));
541e316a SE	57	}
541e316a SE	58
2a924d71	59	static int trackpoint_write(struct ps2dev *ps2dev, u8 loc, u8 val)
541e316a	60	{
3aceaa34	61	u8 param[3] = { TP_WRITE_MEM, loc, val };
541e316a	62
3aceaa34	63	return ps2_command(ps2dev, param, MAKE_PS2_CMD(3, 0, TP_COMMAND));
541e316a SE	64	}
541e316a SE	65
2a924d71	66	static int trackpoint_toggle_bit(struct ps2dev *ps2dev, u8 loc, u8 mask)
541e316a	67	{
3aceaa34 DT	68	u8 param[3] = { TP_TOGGLE, loc, mask };
3aceaa34 DT	69
541e316a SE	70	/* Bad things will happen if the loc param isn't in this range */
541e316a SE	71	if (loc < 0x20 \|\| loc >= 0x2F)
3aceaa34	72	return -EINVAL;
541e316a	73
3aceaa34	74	return ps2_command(ps2dev, param, MAKE_PS2_CMD(3, 0, TP_COMMAND));
541e316a SE	75	}
541e316a SE	76
2a924d71 DT	77	static int trackpoint_update_bit(struct ps2dev *ps2dev,
2a924d71 DT	78	u8 loc, u8 mask, u8 value)
0c6a6165	79	{
3aceaa34	80	int retval;
2a924d71	81	u8 data;
0c6a6165	82
3aceaa34 DT	83	retval = trackpoint_read(ps2dev, loc, &data);
	84	if (retval)
	85	return retval;
	86
0c6a6165 SN	87	if (((data & mask) == mask) != !!value)
	88	retval = trackpoint_toggle_bit(ps2dev, loc, mask);
	89
	90	return retval;
	91	}
541e316a	92
cfe9e888 DT	93	/*
	94	* Trackpoint-specific attributes
	95	*/
	96	struct trackpoint_attr_data {
	97	size_t field_offset;
2a924d71 DT	98	u8 command;
	99	u8 mask;
	100	bool inverted;
	101	u8 power_on_default;
cfe9e888	102	};
541e316a	103
2a924d71 DT	104	static ssize_t trackpoint_show_int_attr(struct psmouse *psmouse,
2a924d71 DT	105	void data, char buf)
cfe9e888 DT	106	{
	107	struct trackpoint_data *tp = psmouse->private;
	108	struct trackpoint_attr_data *attr = data;
2a924d71	109	u8 value = (u8 )((void *)tp + attr->field_offset);
b8044c74 DT	110
	111	if (attr->inverted)
	112	value = !value;
541e316a	113
b8044c74	114	return sprintf(buf, "%u\n", value);
cfe9e888	115	}
541e316a	116
cfe9e888 DT	117	static ssize_t trackpoint_set_int_attr(struct psmouse psmouse, void data,
	118	const char *buf, size_t count)
	119	{
	120	struct trackpoint_data *tp = psmouse->private;
	121	struct trackpoint_attr_data *attr = data;
2a924d71 DT	122	u8 field = (void )tp + attr->field_offset;
2a924d71 DT	123	u8 value;
76496e7a	124	int err;
541e316a	125
76496e7a JD	126	err = kstrtou8(buf, 10, &value);
	127	if (err)
	128	return err;
541e316a	129
cfe9e888	130	*field = value;
3aceaa34	131	err = trackpoint_write(&psmouse->ps2dev, attr->command, value);
541e316a	132
3aceaa34	133	return err ?: count;
cfe9e888	134	}
541e316a	135
0c6a6165	136	#define TRACKPOINT_INT_ATTR(_name, _command, _default) \
cfe9e888 DT	137	static struct trackpoint_attr_data trackpoint_attr_##_name = { \
	138	.field_offset = offsetof(struct trackpoint_data, _name), \
	139	.command = _command, \
0c6a6165	140	.power_on_default = _default, \
cfe9e888 DT	141	}; \
	142	PSMOUSE_DEFINE_ATTR(_name, S_IWUSR \| S_IRUGO, \
	143	&trackpoint_attr_##_name, \
	144	trackpoint_show_int_attr, trackpoint_set_int_attr)
	145
	146	static ssize_t trackpoint_set_bit_attr(struct psmouse psmouse, void data,
	147	const char *buf, size_t count)
	148	{
	149	struct trackpoint_data *tp = psmouse->private;
	150	struct trackpoint_attr_data *attr = data;
2a924d71 DT	151	bool field = (void )tp + attr->field_offset;
2a924d71 DT	152	bool value;
76496e7a JD	153	int err;
76496e7a JD	154
2a924d71	155	err = kstrtobool(buf, &value);
76496e7a JD	156	if (err)
76496e7a JD	157	return err;
cfe9e888	158
b8044c74 DT	159	if (attr->inverted)
	160	value = !value;
	161
cfe9e888 DT	162	if (*field != value) {
cfe9e888 DT	163	*field = value;
3aceaa34 DT	164	err = trackpoint_toggle_bit(&psmouse->ps2dev,
3aceaa34 DT	165	attr->command, attr->mask);
cfe9e888	166	}
541e316a	167
3aceaa34	168	return err ?: count;
cfe9e888	169	}
541e316a	170
541e316a	171
0c6a6165 SN	172	#define TRACKPOINT_BIT_ATTR(_name, _command, _mask, _inv, _default) \
	173	static struct trackpoint_attr_data trackpoint_attr_##_name = { \
	174	.field_offset = offsetof(struct trackpoint_data, \
	175	_name), \
	176	.command = _command, \
	177	.mask = _mask, \
	178	.inverted = _inv, \
	179	.power_on_default = _default, \
	180	}; \
	181	PSMOUSE_DEFINE_ATTR(_name, S_IWUSR \| S_IRUGO, \
	182	&trackpoint_attr_##_name, \
	183	trackpoint_show_int_attr, trackpoint_set_bit_attr)
	184
0c6a6165 SN	185	TRACKPOINT_INT_ATTR(sensitivity, TP_SENS, TP_DEF_SENS);
	186	TRACKPOINT_INT_ATTR(speed, TP_SPEED, TP_DEF_SPEED);
	187	TRACKPOINT_INT_ATTR(inertia, TP_INERTIA, TP_DEF_INERTIA);
	188	TRACKPOINT_INT_ATTR(reach, TP_REACH, TP_DEF_REACH);
	189	TRACKPOINT_INT_ATTR(draghys, TP_DRAGHYS, TP_DEF_DRAGHYS);
	190	TRACKPOINT_INT_ATTR(mindrag, TP_MINDRAG, TP_DEF_MINDRAG);
	191	TRACKPOINT_INT_ATTR(thresh, TP_THRESH, TP_DEF_THRESH);
	192	TRACKPOINT_INT_ATTR(upthresh, TP_UP_THRESH, TP_DEF_UP_THRESH);
	193	TRACKPOINT_INT_ATTR(ztime, TP_Z_TIME, TP_DEF_Z_TIME);
	194	TRACKPOINT_INT_ATTR(jenks, TP_JENKS_CURV, TP_DEF_JENKS_CURV);
2ba35320	195	TRACKPOINT_INT_ATTR(drift_time, TP_DRIFT_TIME, TP_DEF_DRIFT_TIME);
0c6a6165	196
2a924d71	197	TRACKPOINT_BIT_ATTR(press_to_select, TP_TOGGLE_PTSON, TP_MASK_PTSON, false,
0c6a6165	198	TP_DEF_PTSON);
2a924d71	199	TRACKPOINT_BIT_ATTR(skipback, TP_TOGGLE_SKIPBACK, TP_MASK_SKIPBACK, false,
0c6a6165	200	TP_DEF_SKIPBACK);
2a924d71	201	TRACKPOINT_BIT_ATTR(ext_dev, TP_TOGGLE_EXT_DEV, TP_MASK_EXT_DEV, true,
0c6a6165	202	TP_DEF_EXT_DEV);
541e316a	203
2a924d71 DT	204	static bool trackpoint_is_attr_available(struct psmouse *psmouse,
	205	struct attribute *attr)
	206	{
	207	struct trackpoint_data *tp = psmouse->private;
	208
	209	return tp->variant_id == TP_VARIANT_IBM \|\|
	210	attr == &psmouse_attr_sensitivity.dattr.attr \|\|
	211	attr == &psmouse_attr_press_to_select.dattr.attr;
	212	}
	213
	214	static umode_t trackpoint_is_attr_visible(struct kobject *kobj,
	215	struct attribute *attr, int n)
	216	{
eacacdb5	217	struct device *dev = kobj_to_dev(kobj);
2a924d71	218	struct serio *serio = to_serio_port(dev);
100e1695	219	struct psmouse *psmouse = psmouse_from_serio(serio);
2a924d71 DT	220
	221	return trackpoint_is_attr_available(psmouse, attr) ? attr->mode : 0;
	222	}
	223
541e316a	224	static struct attribute *trackpoint_attrs[] = {
cfe9e888 DT	225	&psmouse_attr_sensitivity.dattr.attr,
	226	&psmouse_attr_speed.dattr.attr,
	227	&psmouse_attr_inertia.dattr.attr,
	228	&psmouse_attr_reach.dattr.attr,
	229	&psmouse_attr_draghys.dattr.attr,
	230	&psmouse_attr_mindrag.dattr.attr,
	231	&psmouse_attr_thresh.dattr.attr,
	232	&psmouse_attr_upthresh.dattr.attr,
	233	&psmouse_attr_ztime.dattr.attr,
	234	&psmouse_attr_jenks.dattr.attr,
2ba35320	235	&psmouse_attr_drift_time.dattr.attr,
cfe9e888 DT	236	&psmouse_attr_press_to_select.dattr.attr,
	237	&psmouse_attr_skipback.dattr.attr,
	238	&psmouse_attr_ext_dev.dattr.attr,
541e316a SE	239	NULL
	240	};
	241
	242	static struct attribute_group trackpoint_attr_group = {
2a924d71 DT	243	.is_visible = trackpoint_is_attr_visible,
2a924d71 DT	244	.attrs = trackpoint_attrs,
541e316a SE	245	};
541e316a SE	246
2a924d71 DT	247	#define TRACKPOINT_UPDATE(_power_on, _psmouse, _tp, _name) \
	248	do { \
	249	struct trackpoint_attr_data *_attr = &trackpoint_attr_##_name; \
	250	\
	251	if ((!_power_on \|\| _tp->_name != _attr->power_on_default) && \
	252	trackpoint_is_attr_available(_psmouse, \
	253	&psmouse_attr_##_name.dattr.attr)) { \
	254	if (!_attr->mask) \
	255	trackpoint_write(&_psmouse->ps2dev, \
	256	_attr->command, _tp->_name); \
	257	else \
	258	trackpoint_update_bit(&_psmouse->ps2dev, \
	259	_attr->command, _attr->mask, \
	260	_tp->_name); \
	261	} \
	262	} while (0)
541e316a	263
2a924d71 DT	264	#define TRACKPOINT_SET_POWER_ON_DEFAULT(_tp, _name) \
	265	do { \
	266	_tp->_name = trackpoint_attr_##_name.power_on_default; \
	267	} while (0)
184dd275	268
2a924d71 DT	269	static int trackpoint_start_protocol(struct psmouse *psmouse,
	270	u8 variant_id, u8 firmware_id)
	271	{
	272	u8 param[2] = { 0 };
	273	int error;
184dd275	274
2a924d71 DT	275	error = ps2_command(&psmouse->ps2dev,
	276	param, MAKE_PS2_CMD(0, 2, TP_READ_ID));
	277	if (error)
	278	return error;
	279
	280	switch (param[0]) {
	281	case TP_VARIANT_IBM:
	282	case TP_VARIANT_ALPS:
	283	case TP_VARIANT_ELAN:
	284	case TP_VARIANT_NXP:
996d585b VH	285	case TP_VARIANT_JYT_SYNAPTICS:
996d585b VH	286	case TP_VARIANT_SYNAPTICS:
2a924d71 DT	287	if (variant_id)
	288	*variant_id = param[0];
	289	if (firmware_id)
	290	*firmware_id = param[1];
	291	return 0;
	292	}
184dd275	293
2a924d71	294	return -ENODEV;
541e316a SE	295	}
541e316a SE	296
0c6a6165 SN	297	/*
	298	* Write parameters to trackpad.
	299	* in_power_on_state: Set to true if TP is in default / power-on state (ex. if
	300	* power-on reset was run). If so, values will only be
	301	* written to TP if they differ from power-on default.
	302	*/
	303	static int trackpoint_sync(struct psmouse *psmouse, bool in_power_on_state)
541e316a	304	{
541e316a	305	struct trackpoint_data *tp = psmouse->private;
541e316a	306
2a924d71	307	if (!in_power_on_state && tp->variant_id == TP_VARIANT_IBM) {
0c6a6165 SN	308	/*
	309	* Disable features that may make device unusable
	310	* with this driver.
	311	*/
	312	trackpoint_update_bit(&psmouse->ps2dev, TP_TOGGLE_TWOHAND,
	313	TP_MASK_TWOHAND, TP_DEF_TWOHAND);
541e316a	314
0c6a6165 SN	315	trackpoint_update_bit(&psmouse->ps2dev, TP_TOGGLE_SOURCE_TAG,
0c6a6165 SN	316	TP_MASK_SOURCE_TAG, TP_DEF_SOURCE_TAG);
541e316a	317
0c6a6165 SN	318	trackpoint_update_bit(&psmouse->ps2dev, TP_TOGGLE_MB,
	319	TP_MASK_MB, TP_DEF_MB);
	320	}
541e316a	321
0c6a6165 SN	322	/*
	323	* These properties can be changed in this driver. Only
	324	* configure them if the values are non-default or if the TP is in
	325	* an unknown state.
	326	*/
	327	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, sensitivity);
	328	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, inertia);
	329	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, speed);
	330	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, reach);
	331	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, draghys);
	332	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, mindrag);
	333	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, thresh);
	334	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, upthresh);
	335	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, ztime);
	336	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, jenks);
2ba35320	337	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, drift_time);
0c6a6165 SN	338
	339	/* toggles */
	340	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, press_to_select);
	341	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, skipback);
	342	TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, ext_dev);
541e316a SE	343
	344	return 0;
	345	}
	346
	347	static void trackpoint_defaults(struct trackpoint_data *tp)
	348	{
0c6a6165 SN	349	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, sensitivity);
	350	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, speed);
	351	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, reach);
	352	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, draghys);
	353	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, mindrag);
	354	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, thresh);
	355	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, upthresh);
	356	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, ztime);
	357	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, jenks);
2ba35320	358	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, drift_time);
0c6a6165 SN	359	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, inertia);
	360
	361	/* toggles */
	362	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, press_to_select);
	363	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, skipback);
	364	TRACKPOINT_SET_POWER_ON_DEFAULT(tp, ext_dev);
541e316a SE	365	}
541e316a SE	366
184dd275 DT	367	static void trackpoint_disconnect(struct psmouse *psmouse)
184dd275 DT	368	{
2a924d71 DT	369	device_remove_group(&psmouse->ps2dev.serio->dev,
2a924d71 DT	370	&trackpoint_attr_group);
184dd275 DT	371
	372	kfree(psmouse->private);
	373	psmouse->private = NULL;
	374	}
	375
	376	static int trackpoint_reconnect(struct psmouse *psmouse)
	377	{
2a924d71 DT	378	struct trackpoint_data *tp = psmouse->private;
	379	int error;
	380	bool was_reset;
0c6a6165	381
2a924d71 DT	382	error = trackpoint_start_protocol(psmouse, NULL, NULL);
	383	if (error)
	384	return error;
184dd275	385
2a924d71 DT	386	was_reset = tp->variant_id == TP_VARIANT_IBM &&
	387	trackpoint_power_on_reset(&psmouse->ps2dev) == 0;
	388
	389	error = trackpoint_sync(psmouse, was_reset);
	390	if (error)
	391	return error;
184dd275 DT	392
	393	return 0;
	394	}
	395
b7802c5c	396	int trackpoint_detect(struct psmouse *psmouse, bool set_properties)
541e316a	397	{
541e316a	398	struct ps2dev *ps2dev = &psmouse->ps2dev;
2a924d71 DT	399	struct trackpoint_data *tp;
	400	u8 variant_id;
	401	u8 firmware_id;
	402	u8 button_info;
8ff22ea7	403	int error;
541e316a	404
2a924d71 DT	405	error = trackpoint_start_protocol(psmouse, &variant_id, &firmware_id);
	406	if (error)
	407	return error;
541e316a SE	408
	409	if (!set_properties)
	410	return 0;
	411
2a924d71 DT	412	tp = kzalloc(sizeof(*tp), GFP_KERNEL);
2a924d71 DT	413	if (!tp)
6792cbbb	414	return -ENOMEM;
541e316a	415
2a924d71 DT	416	trackpoint_defaults(tp);
	417	tp->variant_id = variant_id;
	418	tp->firmware_id = firmware_id;
	419
	420	psmouse->private = tp;
	421
	422	psmouse->vendor = trackpoint_variants[variant_id];
541e316a SE	423	psmouse->name = "TrackPoint";
541e316a SE	424
184dd275	425	psmouse->reconnect = trackpoint_reconnect;
541e316a SE	426	psmouse->disconnect = trackpoint_disconnect;
541e316a SE	427
2a924d71 DT	428	if (variant_id != TP_VARIANT_IBM) {
	429	/* Newer variants do not support extended button query. */
	430	button_info = 0x33;
	431	} else {
	432	error = trackpoint_read(ps2dev, TP_EXT_BTN, &button_info);
	433	if (error) {
	434	psmouse_warn(psmouse,
	435	"failed to get extended button data, assuming 3 buttons\n");
	436	button_info = 0x33;
	437	} else if (!button_info) {
	438	psmouse_warn(psmouse,
	439	"got 0 in extended button data, assuming 3 buttons\n");
	440	button_info = 0x33;
	441	}
	442	}
	443
315eb996	444	if ((button_info & 0x0f) >= 3)
2a924d71	445	input_set_capability(psmouse->dev, EV_KEY, BTN_MIDDLE);
315eb996	446
01d4cd5c	447	__set_bit(INPUT_PROP_POINTER, psmouse->dev->propbit);
7611392f HG	448	__set_bit(INPUT_PROP_POINTING_STICK, psmouse->dev->propbit);
7611392f HG	449
2a924d71 DT	450	if (variant_id != TP_VARIANT_IBM \|\|
	451	trackpoint_power_on_reset(ps2dev) != 0) {
	452	/*
	453	* Write defaults to TP if we did not reset the trackpoint.
	454	*/
0c6a6165	455	trackpoint_sync(psmouse, false);
2a924d71	456	}
541e316a	457
2a924d71	458	error = device_add_group(&ps2dev->serio->dev, &trackpoint_attr_group);
8ff22ea7	459	if (error) {
fb16395e JD	460	psmouse_err(psmouse,
	461	"failed to create sysfs attributes, error: %d\n",
	462	error);
315eb996 DT	463	kfree(psmouse->private);
315eb996 DT	464	psmouse->private = NULL;
8ff22ea7 JG	465	return -1;
8ff22ea7 JG	466	}
541e316a	467
fb16395e	468	psmouse_info(psmouse,
2a924d71 DT	469	"%s TrackPoint firmware: 0x%02x, buttons: %d/%d\n",
2a924d71 DT	470	psmouse->vendor, firmware_id,
fb16395e	471	(button_info & 0xf0) >> 4, button_info & 0x0f);
541e316a SE	472
	473	return 0;
	474	}
	475