[mirror_ubuntu-bionic-kernel.git] / drivers / input / rmi4 / rmi_f12.c

/*
 * Copyright (c) 2012-2016 Synaptics Incorporated
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 as published by
 * the Free Software Foundation.
 */
#include <linux/input.h>
#include <linux/input/mt.h>
#include <linux/rmi.h>
#include "rmi_driver.h"
#include "rmi_2d_sensor.h"

enum rmi_f12_object_type {
	RMI_F12_OBJECT_NONE			= 0x00,
	RMI_F12_OBJECT_FINGER			= 0x01,
	RMI_F12_OBJECT_STYLUS			= 0x02,
	RMI_F12_OBJECT_PALM			= 0x03,
	RMI_F12_OBJECT_UNCLASSIFIED		= 0x04,
	RMI_F12_OBJECT_GLOVED_FINGER		= 0x06,
	RMI_F12_OBJECT_NARROW_OBJECT		= 0x07,
	RMI_F12_OBJECT_HAND_EDGE		= 0x08,
	RMI_F12_OBJECT_COVER			= 0x0A,
	RMI_F12_OBJECT_STYLUS_2			= 0x0B,
	RMI_F12_OBJECT_ERASER			= 0x0C,
	RMI_F12_OBJECT_SMALL_OBJECT		= 0x0D,
};

#define F12_DATA1_BYTES_PER_OBJ			8

struct f12_data {
	struct rmi_2d_sensor sensor;
	struct rmi_2d_sensor_platform_data sensor_pdata;
	bool has_dribble;

	u16 data_addr;

	struct rmi_register_descriptor query_reg_desc;
	struct rmi_register_descriptor control_reg_desc;
	struct rmi_register_descriptor data_reg_desc;

	/* F12 Data1 describes sensed objects */
	const struct rmi_register_desc_item *data1;
	u16 data1_offset;

	/* F12 Data5 describes finger ACM */
	const struct rmi_register_desc_item *data5;
	u16 data5_offset;

	/* F12 Data5 describes Pen */
	const struct rmi_register_desc_item *data6;
	u16 data6_offset;


	/* F12 Data9 reports relative data */
	const struct rmi_register_desc_item *data9;
	u16 data9_offset;

	const struct rmi_register_desc_item *data15;
	u16 data15_offset;
};

static int rmi_f12_read_sensor_tuning(struct f12_data *f12)
{
	const struct rmi_register_desc_item *item;
	struct rmi_2d_sensor *sensor = &f12->sensor;
	struct rmi_function *fn = sensor->fn;
	struct rmi_device *rmi_dev = fn->rmi_dev;
	int ret;
	int offset;
	u8 buf[15];
	int pitch_x = 0;
	int pitch_y = 0;
	int rx_receivers = 0;
	int tx_receivers = 0;
	int sensor_flags = 0;

	item = rmi_get_register_desc_item(&f12->control_reg_desc, 8);
	if (!item) {
		dev_err(&fn->dev,
			"F12 does not have the sensor tuning control register\n");
		return -ENODEV;
	}

	offset = rmi_register_desc_calc_reg_offset(&f12->control_reg_desc, 8);

	if (item->reg_size > sizeof(buf)) {
		dev_err(&fn->dev,
			"F12 control8 should be no bigger than %zd bytes, not: %ld\n",
			sizeof(buf), item->reg_size);
		return -ENODEV;
	}

	ret = rmi_read_block(rmi_dev, fn->fd.control_base_addr + offset, buf,
				item->reg_size);
	if (ret)
		return ret;

	offset = 0;
	if (rmi_register_desc_has_subpacket(item, 0)) {
		sensor->max_x = (buf[offset + 1] << 8) | buf[offset];
		sensor->max_y = (buf[offset + 3] << 8) | buf[offset + 2];
		offset += 4;
	}

	rmi_dbg(RMI_DEBUG_FN, &fn->dev, "%s: max_x: %d max_y: %d\n", __func__,
		sensor->max_x, sensor->max_y);

	if (rmi_register_desc_has_subpacket(item, 1)) {
		pitch_x = (buf[offset + 1] << 8) | buf[offset];
		pitch_y	= (buf[offset + 3] << 8) | buf[offset + 2];
		offset += 4;
	}

	if (rmi_register_desc_has_subpacket(item, 2)) {
		/* Units 1/128 sensor pitch */
		rmi_dbg(RMI_DEBUG_FN, &fn->dev,
			"%s: Inactive Border xlo:%d xhi:%d ylo:%d yhi:%d\n",
			__func__,
			buf[offset], buf[offset + 1],
			buf[offset + 2], buf[offset + 3]);

		offset += 4;
	}

	if (rmi_register_desc_has_subpacket(item, 3)) {
		rx_receivers = buf[offset];
		tx_receivers = buf[offset + 1];
		offset += 2;
	}

	if (rmi_register_desc_has_subpacket(item, 4)) {
		sensor_flags = buf[offset];
		offset += 1;
	}

	sensor->x_mm = (pitch_x * rx_receivers) >> 12;
	sensor->y_mm = (pitch_y * tx_receivers) >> 12;

	rmi_dbg(RMI_DEBUG_FN, &fn->dev, "%s: x_mm: %d y_mm: %d\n", __func__,
		sensor->x_mm, sensor->y_mm);

	return 0;
}

static void rmi_f12_process_objects(struct f12_data *f12, u8 *data1, int size)
{
	int i;
	struct rmi_2d_sensor *sensor = &f12->sensor;
	int objects = f12->data1->num_subpackets;

	if ((f12->data1->num_subpackets * F12_DATA1_BYTES_PER_OBJ) > size)
		objects = size / F12_DATA1_BYTES_PER_OBJ;

	for (i = 0; i < objects; i++) {
		struct rmi_2d_sensor_abs_object *obj = &sensor->objs[i];

		obj->type = RMI_2D_OBJECT_NONE;
		obj->mt_tool = MT_TOOL_FINGER;

		switch (data1[0]) {
		case RMI_F12_OBJECT_FINGER:
			obj->type = RMI_2D_OBJECT_FINGER;
			break;
		case RMI_F12_OBJECT_STYLUS:
			obj->type = RMI_2D_OBJECT_STYLUS;
			obj->mt_tool = MT_TOOL_PEN;
			break;
		case RMI_F12_OBJECT_PALM:
			obj->type = RMI_2D_OBJECT_PALM;
			obj->mt_tool = MT_TOOL_PALM;
			break;
		case RMI_F12_OBJECT_UNCLASSIFIED:
			obj->type = RMI_2D_OBJECT_UNCLASSIFIED;
			break;
		}

		obj->x = (data1[2] << 8) | data1[1];
		obj->y = (data1[4] << 8) | data1[3];
		obj->z = data1[5];
		obj->wx = data1[6];
		obj->wy = data1[7];

		rmi_2d_sensor_abs_process(sensor, obj, i);

		data1 += F12_DATA1_BYTES_PER_OBJ;
	}

	if (sensor->kernel_tracking)
		input_mt_assign_slots(sensor->input,
				      sensor->tracking_slots,
				      sensor->tracking_pos,
				      sensor->nbr_fingers,
				      sensor->dmax);

	for (i = 0; i < objects; i++)
		rmi_2d_sensor_abs_report(sensor, &sensor->objs[i], i);
}

static int rmi_f12_attention(struct rmi_function *fn,
			     unsigned long *irq_nr_regs)
{
	int retval;
	struct rmi_device *rmi_dev = fn->rmi_dev;
	struct rmi_driver_data *drvdata = dev_get_drvdata(&rmi_dev->dev);
	struct f12_data *f12 = dev_get_drvdata(&fn->dev);
	struct rmi_2d_sensor *sensor = &f12->sensor;
	int valid_bytes = sensor->pkt_size;

	if (drvdata->attn_data.data) {
		if (sensor->attn_size > drvdata->attn_data.size)
			valid_bytes = drvdata->attn_data.size;
		else
			valid_bytes = sensor->attn_size;
		memcpy(sensor->data_pkt, drvdata->attn_data.data,
			valid_bytes);
		drvdata->attn_data.data += sensor->attn_size;
		drvdata->attn_data.size -= sensor->attn_size;
	} else {
		retval = rmi_read_block(rmi_dev, f12->data_addr,
					sensor->data_pkt, sensor->pkt_size);
		if (retval < 0) {
			dev_err(&fn->dev, "Failed to read object data. Code: %d.\n",
				retval);
			return retval;
		}
	}

	if (f12->data1)
		rmi_f12_process_objects(f12,
			&sensor->data_pkt[f12->data1_offset], valid_bytes);

	input_mt_sync_frame(sensor->input);

	return 0;
}

static int rmi_f12_write_control_regs(struct rmi_function *fn)
{
	int ret;
	const struct rmi_register_desc_item *item;
	struct rmi_device *rmi_dev = fn->rmi_dev;
	struct f12_data *f12 = dev_get_drvdata(&fn->dev);
	int control_size;
	char buf[3];
	u16 control_offset = 0;
	u8 subpacket_offset = 0;

	if (f12->has_dribble
	    && (f12->sensor.dribble != RMI_REG_STATE_DEFAULT)) {
		item = rmi_get_register_desc_item(&f12->control_reg_desc, 20);
		if (item) {
			control_offset = rmi_register_desc_calc_reg_offset(
						&f12->control_reg_desc, 20);

			/*
			 * The byte containing the EnableDribble bit will be
			 * in either byte 0 or byte 2 of control 20. Depending
			 * on the existence of subpacket 0. If control 20 is
			 * larger then 3 bytes, just read the first 3.
			 */
			control_size = min(item->reg_size, 3UL);

			ret = rmi_read_block(rmi_dev, fn->fd.control_base_addr
					+ control_offset, buf, control_size);
			if (ret)
				return ret;

			if (rmi_register_desc_has_subpacket(item, 0))
				subpacket_offset += 1;

			switch (f12->sensor.dribble) {
			case RMI_REG_STATE_OFF:
				buf[subpacket_offset] &= ~BIT(2);
				break;
			case RMI_REG_STATE_ON:
				buf[subpacket_offset] |= BIT(2);
				break;
			case RMI_REG_STATE_DEFAULT:
			default:
				break;
			}

			ret = rmi_write_block(rmi_dev,
				fn->fd.control_base_addr + control_offset,
				buf, control_size);
			if (ret)
				return ret;
		}
	}

	return 0;

}

static int rmi_f12_config(struct rmi_function *fn)
{
	struct rmi_driver *drv = fn->rmi_dev->driver;
	int ret;

	drv->set_irq_bits(fn->rmi_dev, fn->irq_mask);

	ret = rmi_f12_write_control_regs(fn);
	if (ret)
		dev_warn(&fn->dev,
			"Failed to write F12 control registers: %d\n", ret);

	return 0;
}

static int rmi_f12_probe(struct rmi_function *fn)
{
	struct f12_data *f12;
	int ret;
	struct rmi_device *rmi_dev = fn->rmi_dev;
	char buf;
	u16 query_addr = fn->fd.query_base_addr;
	const struct rmi_register_desc_item *item;
	struct rmi_2d_sensor *sensor;
	struct rmi_device_platform_data *pdata = rmi_get_platform_data(rmi_dev);
	struct rmi_driver_data *drvdata = dev_get_drvdata(&rmi_dev->dev);
	u16 data_offset = 0;

	rmi_dbg(RMI_DEBUG_FN, &fn->dev, "%s\n", __func__);

	ret = rmi_read(fn->rmi_dev, query_addr, &buf);
	if (ret < 0) {
		dev_err(&fn->dev, "Failed to read general info register: %d\n",
			ret);
		return -ENODEV;
	}
	++query_addr;

	if (!(buf & BIT(0))) {
		dev_err(&fn->dev,
			"Behavior of F12 without register descriptors is undefined.\n");
		return -ENODEV;
	}

	f12 = devm_kzalloc(&fn->dev, sizeof(struct f12_data), GFP_KERNEL);
	if (!f12)
		return -ENOMEM;

	f12->has_dribble = !!(buf & BIT(3));

	if (fn->dev.of_node) {
		ret = rmi_2d_sensor_of_probe(&fn->dev, &f12->sensor_pdata);
		if (ret)
			return ret;
	} else {
		f12->sensor_pdata = pdata->sensor_pdata;
	}

	ret = rmi_read_register_desc(rmi_dev, query_addr,
					&f12->query_reg_desc);
	if (ret) {
		dev_err(&fn->dev,
			"Failed to read the Query Register Descriptor: %d\n",
			ret);
		return ret;
	}
	query_addr += 3;

	ret = rmi_read_register_desc(rmi_dev, query_addr,
						&f12->control_reg_desc);
	if (ret) {
		dev_err(&fn->dev,
			"Failed to read the Control Register Descriptor: %d\n",
			ret);
		return ret;
	}
	query_addr += 3;

	ret = rmi_read_register_desc(rmi_dev, query_addr,
						&f12->data_reg_desc);
	if (ret) {
		dev_err(&fn->dev,
			"Failed to read the Data Register Descriptor: %d\n",
			ret);
		return ret;
	}
	query_addr += 3;

	sensor = &f12->sensor;
	sensor->fn = fn;
	f12->data_addr = fn->fd.data_base_addr;
	sensor->pkt_size = rmi_register_desc_calc_size(&f12->data_reg_desc);

	sensor->axis_align =
		f12->sensor_pdata.axis_align;

	sensor->x_mm = f12->sensor_pdata.x_mm;
	sensor->y_mm = f12->sensor_pdata.y_mm;
	sensor->dribble = f12->sensor_pdata.dribble;

	if (sensor->sensor_type == rmi_sensor_default)
		sensor->sensor_type =
			f12->sensor_pdata.sensor_type;

	rmi_dbg(RMI_DEBUG_FN, &fn->dev, "%s: data packet size: %d\n", __func__,
		sensor->pkt_size);
	sensor->data_pkt = devm_kzalloc(&fn->dev, sensor->pkt_size, GFP_KERNEL);
	if (!sensor->data_pkt)
		return -ENOMEM;

	dev_set_drvdata(&fn->dev, f12);

	ret = rmi_f12_read_sensor_tuning(f12);
	if (ret)
		return ret;

	/*
	 * Figure out what data is contained in the data registers. HID devices
	 * may have registers defined, but their data is not reported in the
	 * HID attention report. Registers which are not reported in the HID
	 * attention report check to see if the device is receiving data from
	 * HID attention reports.
	 */
	item = rmi_get_register_desc_item(&f12->data_reg_desc, 0);
	if (item && !drvdata->attn_data.data)
		data_offset += item->reg_size;

	item = rmi_get_register_desc_item(&f12->data_reg_desc, 1);
	if (item) {
		f12->data1 = item;
		f12->data1_offset = data_offset;
		data_offset += item->reg_size;
		sensor->nbr_fingers = item->num_subpackets;
		sensor->report_abs = 1;
		sensor->attn_size += item->reg_size;
	}

	item = rmi_get_register_desc_item(&f12->data_reg_desc, 2);
	if (item && !drvdata->attn_data.data)
		data_offset += item->reg_size;

	item = rmi_get_register_desc_item(&f12->data_reg_desc, 3);
	if (item && !drvdata->attn_data.data)
		data_offset += item->reg_size;

	item = rmi_get_register_desc_item(&f12->data_reg_desc, 4);
	if (item && !drvdata->attn_data.data)
		data_offset += item->reg_size;

	item = rmi_get_register_desc_item(&f12->data_reg_desc, 5);
	if (item) {
		f12->data5 = item;
		f12->data5_offset = data_offset;
		data_offset += item->reg_size;
		sensor->attn_size += item->reg_size;
	}

	item = rmi_get_register_desc_item(&f12->data_reg_desc, 6);
	if (item && !drvdata->attn_data.data) {
		f12->data6 = item;
		f12->data6_offset = data_offset;
		data_offset += item->reg_size;
	}

	item = rmi_get_register_desc_item(&f12->data_reg_desc, 7);
	if (item && !drvdata->attn_data.data)
		data_offset += item->reg_size;

	item = rmi_get_register_desc_item(&f12->data_reg_desc, 8);
	if (item && !drvdata->attn_data.data)
		data_offset += item->reg_size;

	item = rmi_get_register_desc_item(&f12->data_reg_desc, 9);
	if (item && !drvdata->attn_data.data) {
		f12->data9 = item;
		f12->data9_offset = data_offset;
		data_offset += item->reg_size;
		if (!sensor->report_abs)
			sensor->report_rel = 1;
	}

	item = rmi_get_register_desc_item(&f12->data_reg_desc, 10);
	if (item && !drvdata->attn_data.data)
		data_offset += item->reg_size;

	item = rmi_get_register_desc_item(&f12->data_reg_desc, 11);
	if (item && !drvdata->attn_data.data)
		data_offset += item->reg_size;

	item = rmi_get_register_desc_item(&f12->data_reg_desc, 12);
	if (item && !drvdata->attn_data.data)
		data_offset += item->reg_size;

	item = rmi_get_register_desc_item(&f12->data_reg_desc, 13);
	if (item && !drvdata->attn_data.data)
		data_offset += item->reg_size;

	item = rmi_get_register_desc_item(&f12->data_reg_desc, 14);
	if (item && !drvdata->attn_data.data)
		data_offset += item->reg_size;

	item = rmi_get_register_desc_item(&f12->data_reg_desc, 15);
	if (item && !drvdata->attn_data.data) {
		f12->data15 = item;
		f12->data15_offset = data_offset;
		data_offset += item->reg_size;
	}

	/* allocate the in-kernel tracking buffers */
	sensor->tracking_pos = devm_kzalloc(&fn->dev,
			sizeof(struct input_mt_pos) * sensor->nbr_fingers,
			GFP_KERNEL);
	sensor->tracking_slots = devm_kzalloc(&fn->dev,
			sizeof(int) * sensor->nbr_fingers, GFP_KERNEL);
	sensor->objs = devm_kzalloc(&fn->dev,
			sizeof(struct rmi_2d_sensor_abs_object)
			* sensor->nbr_fingers, GFP_KERNEL);
	if (!sensor->tracking_pos || !sensor->tracking_slots || !sensor->objs)
		return -ENOMEM;

	ret = rmi_2d_sensor_configure_input(fn, sensor);
	if (ret)
		return ret;

	return 0;
}

struct rmi_function_handler rmi_f12_handler = {
	.driver = {
		.name = "rmi4_f12",
	},
	.func = 0x12,
	.probe = rmi_f12_probe,
	.config = rmi_f12_config,
	.attention = rmi_f12_attention,
};
Commit	Line	Data
b43d2c1e AD	1	/*
	2	* Copyright (c) 2012-2016 Synaptics Incorporated
	3	*
	4	* This program is free software; you can redistribute it and/or modify it
	5	* under the terms of the GNU General Public License version 2 as published by
	6	* the Free Software Foundation.
	7	*/
	8	#include <linux/input.h>
	9	#include <linux/input/mt.h>
	10	#include <linux/rmi.h>
	11	#include "rmi_driver.h"
	12	#include "rmi_2d_sensor.h"
	13
	14	enum rmi_f12_object_type {
	15	RMI_F12_OBJECT_NONE = 0x00,
	16	RMI_F12_OBJECT_FINGER = 0x01,
	17	RMI_F12_OBJECT_STYLUS = 0x02,
	18	RMI_F12_OBJECT_PALM = 0x03,
	19	RMI_F12_OBJECT_UNCLASSIFIED = 0x04,
	20	RMI_F12_OBJECT_GLOVED_FINGER = 0x06,
	21	RMI_F12_OBJECT_NARROW_OBJECT = 0x07,
	22	RMI_F12_OBJECT_HAND_EDGE = 0x08,
	23	RMI_F12_OBJECT_COVER = 0x0A,
	24	RMI_F12_OBJECT_STYLUS_2 = 0x0B,
	25	RMI_F12_OBJECT_ERASER = 0x0C,
	26	RMI_F12_OBJECT_SMALL_OBJECT = 0x0D,
	27	};
	28
6d0dbeae AD	29	#define F12_DATA1_BYTES_PER_OBJ 8
6d0dbeae AD	30
b43d2c1e	31	struct f12_data {
b43d2c1e AD	32	struct rmi_2d_sensor sensor;
b43d2c1e AD	33	struct rmi_2d_sensor_platform_data sensor_pdata;
24f63b1c	34	bool has_dribble;
b43d2c1e AD	35
	36	u16 data_addr;
	37
	38	struct rmi_register_descriptor query_reg_desc;
	39	struct rmi_register_descriptor control_reg_desc;
	40	struct rmi_register_descriptor data_reg_desc;
	41
	42	/* F12 Data1 describes sensed objects */
	43	const struct rmi_register_desc_item *data1;
	44	u16 data1_offset;
	45
	46	/* F12 Data5 describes finger ACM */
	47	const struct rmi_register_desc_item *data5;
	48	u16 data5_offset;
	49
	50	/* F12 Data5 describes Pen */
	51	const struct rmi_register_desc_item *data6;
	52	u16 data6_offset;
	53
	54
	55	/* F12 Data9 reports relative data */
	56	const struct rmi_register_desc_item *data9;
	57	u16 data9_offset;
	58
	59	const struct rmi_register_desc_item *data15;
	60	u16 data15_offset;
	61	};
	62
	63	static int rmi_f12_read_sensor_tuning(struct f12_data *f12)
	64	{
	65	const struct rmi_register_desc_item *item;
	66	struct rmi_2d_sensor *sensor = &f12->sensor;
	67	struct rmi_function *fn = sensor->fn;
	68	struct rmi_device *rmi_dev = fn->rmi_dev;
	69	int ret;
	70	int offset;
e4add7b6	71	u8 buf[15];
b43d2c1e AD	72	int pitch_x = 0;
b43d2c1e AD	73	int pitch_y = 0;
b43d2c1e AD	74	int rx_receivers = 0;
	75	int tx_receivers = 0;
	76	int sensor_flags = 0;
	77
	78	item = rmi_get_register_desc_item(&f12->control_reg_desc, 8);
	79	if (!item) {
	80	dev_err(&fn->dev,
	81	"F12 does not have the sensor tuning control register\n");
	82	return -ENODEV;
	83	}
	84
	85	offset = rmi_register_desc_calc_reg_offset(&f12->control_reg_desc, 8);
	86
e4add7b6 AD	87	if (item->reg_size > sizeof(buf)) {
	88	dev_err(&fn->dev,
	89	"F12 control8 should be no bigger than %zd bytes, not: %ld\n",
	90	sizeof(buf), item->reg_size);
b43d2c1e AD	91	return -ENODEV;
	92	}
	93
	94	ret = rmi_read_block(rmi_dev, fn->fd.control_base_addr + offset, buf,
	95	item->reg_size);
	96	if (ret)
	97	return ret;
	98
	99	offset = 0;
	100	if (rmi_register_desc_has_subpacket(item, 0)) {
	101	sensor->max_x = (buf[offset + 1] << 8) \| buf[offset];
	102	sensor->max_y = (buf[offset + 3] << 8) \| buf[offset + 2];
	103	offset += 4;
	104	}
	105
	106	rmi_dbg(RMI_DEBUG_FN, &fn->dev, "%s: max_x: %d max_y: %d\n", __func__,
	107	sensor->max_x, sensor->max_y);
	108
	109	if (rmi_register_desc_has_subpacket(item, 1)) {
	110	pitch_x = (buf[offset + 1] << 8) \| buf[offset];
	111	pitch_y = (buf[offset + 3] << 8) \| buf[offset + 2];
	112	offset += 4;
	113	}
	114
	115	if (rmi_register_desc_has_subpacket(item, 2)) {
25670fb0 ND	116	/* Units 1/128 sensor pitch */
	117	rmi_dbg(RMI_DEBUG_FN, &fn->dev,
	118	"%s: Inactive Border xlo:%d xhi:%d ylo:%d yhi:%d\n",
	119	__func__,
	120	buf[offset], buf[offset + 1],
	121	buf[offset + 2], buf[offset + 3]);
	122
b43d2c1e AD	123	offset += 4;
	124	}
	125
b43d2c1e AD	126	if (rmi_register_desc_has_subpacket(item, 3)) {
	127	rx_receivers = buf[offset];
	128	tx_receivers = buf[offset + 1];
	129	offset += 2;
	130	}
	131
	132	if (rmi_register_desc_has_subpacket(item, 4)) {
	133	sensor_flags = buf[offset];
	134	offset += 1;
	135	}
	136
	137	sensor->x_mm = (pitch_x * rx_receivers) >> 12;
	138	sensor->y_mm = (pitch_y * tx_receivers) >> 12;
	139
	140	rmi_dbg(RMI_DEBUG_FN, &fn->dev, "%s: x_mm: %d y_mm: %d\n", __func__,
	141	sensor->x_mm, sensor->y_mm);
	142
	143	return 0;
	144	}
	145
6d0dbeae	146	static void rmi_f12_process_objects(struct f12_data f12, u8 data1, int size)
b43d2c1e AD	147	{
	148	int i;
	149	struct rmi_2d_sensor *sensor = &f12->sensor;
6d0dbeae AD	150	int objects = f12->data1->num_subpackets;
	151
	152	if ((f12->data1->num_subpackets * F12_DATA1_BYTES_PER_OBJ) > size)
	153	objects = size / F12_DATA1_BYTES_PER_OBJ;
b43d2c1e	154
6d0dbeae	155	for (i = 0; i < objects; i++) {
b43d2c1e AD	156	struct rmi_2d_sensor_abs_object *obj = &sensor->objs[i];
	157
	158	obj->type = RMI_2D_OBJECT_NONE;
	159	obj->mt_tool = MT_TOOL_FINGER;
	160
	161	switch (data1[0]) {
	162	case RMI_F12_OBJECT_FINGER:
	163	obj->type = RMI_2D_OBJECT_FINGER;
	164	break;
	165	case RMI_F12_OBJECT_STYLUS:
	166	obj->type = RMI_2D_OBJECT_STYLUS;
	167	obj->mt_tool = MT_TOOL_PEN;
	168	break;
	169	case RMI_F12_OBJECT_PALM:
	170	obj->type = RMI_2D_OBJECT_PALM;
	171	obj->mt_tool = MT_TOOL_PALM;
	172	break;
	173	case RMI_F12_OBJECT_UNCLASSIFIED:
	174	obj->type = RMI_2D_OBJECT_UNCLASSIFIED;
	175	break;
	176	}
	177
	178	obj->x = (data1[2] << 8) \| data1[1];
	179	obj->y = (data1[4] << 8) \| data1[3];
	180	obj->z = data1[5];
	181	obj->wx = data1[6];
	182	obj->wy = data1[7];
	183
	184	rmi_2d_sensor_abs_process(sensor, obj, i);
	185
6d0dbeae	186	data1 += F12_DATA1_BYTES_PER_OBJ;
b43d2c1e AD	187	}
	188
	189	if (sensor->kernel_tracking)
	190	input_mt_assign_slots(sensor->input,
	191	sensor->tracking_slots,
	192	sensor->tracking_pos,
	193	sensor->nbr_fingers,
	194	sensor->dmax);
	195
6d0dbeae	196	for (i = 0; i < objects; i++)
b43d2c1e AD	197	rmi_2d_sensor_abs_report(sensor, &sensor->objs[i], i);
	198	}
	199
	200	static int rmi_f12_attention(struct rmi_function *fn,
	201	unsigned long *irq_nr_regs)
	202	{
	203	int retval;
	204	struct rmi_device *rmi_dev = fn->rmi_dev;
ae9979c3	205	struct rmi_driver_data *drvdata = dev_get_drvdata(&rmi_dev->dev);
b43d2c1e AD	206	struct f12_data *f12 = dev_get_drvdata(&fn->dev);
b43d2c1e AD	207	struct rmi_2d_sensor *sensor = &f12->sensor;
6d0dbeae	208	int valid_bytes = sensor->pkt_size;
b43d2c1e	209
ae9979c3 BT	210	if (drvdata->attn_data.data) {
	211	if (sensor->attn_size > drvdata->attn_data.size)
	212	valid_bytes = drvdata->attn_data.size;
6d0dbeae AD	213	else
6d0dbeae AD	214	valid_bytes = sensor->attn_size;
ae9979c3	215	memcpy(sensor->data_pkt, drvdata->attn_data.data,
6d0dbeae	216	valid_bytes);
ae9979c3 BT	217	drvdata->attn_data.data += sensor->attn_size;
ae9979c3 BT	218	drvdata->attn_data.size -= sensor->attn_size;
b43d2c1e AD	219	} else {
	220	retval = rmi_read_block(rmi_dev, f12->data_addr,
	221	sensor->data_pkt, sensor->pkt_size);
	222	if (retval < 0) {
	223	dev_err(&fn->dev, "Failed to read object data. Code: %d.\n",
	224	retval);
	225	return retval;
	226	}
	227	}
	228
	229	if (f12->data1)
	230	rmi_f12_process_objects(f12,
6d0dbeae	231	&sensor->data_pkt[f12->data1_offset], valid_bytes);
b43d2c1e AD	232
	233	input_mt_sync_frame(sensor->input);
	234
	235	return 0;
	236	}
	237
24f63b1c AD	238	static int rmi_f12_write_control_regs(struct rmi_function *fn)
	239	{
	240	int ret;
	241	const struct rmi_register_desc_item *item;
	242	struct rmi_device *rmi_dev = fn->rmi_dev;
	243	struct f12_data *f12 = dev_get_drvdata(&fn->dev);
	244	int control_size;
	245	char buf[3];
	246	u16 control_offset = 0;
	247	u8 subpacket_offset = 0;
	248
	249	if (f12->has_dribble
	250	&& (f12->sensor.dribble != RMI_REG_STATE_DEFAULT)) {
	251	item = rmi_get_register_desc_item(&f12->control_reg_desc, 20);
	252	if (item) {
	253	control_offset = rmi_register_desc_calc_reg_offset(
	254	&f12->control_reg_desc, 20);
	255
	256	/*
	257	* The byte containing the EnableDribble bit will be
	258	* in either byte 0 or byte 2 of control 20. Depending
	259	* on the existence of subpacket 0. If control 20 is
	260	* larger then 3 bytes, just read the first 3.
	261	*/
	262	control_size = min(item->reg_size, 3UL);
	263
	264	ret = rmi_read_block(rmi_dev, fn->fd.control_base_addr
	265	+ control_offset, buf, control_size);
	266	if (ret)
	267	return ret;
	268
	269	if (rmi_register_desc_has_subpacket(item, 0))
	270	subpacket_offset += 1;
	271
	272	switch (f12->sensor.dribble) {
	273	case RMI_REG_STATE_OFF:
	274	buf[subpacket_offset] &= ~BIT(2);
	275	break;
	276	case RMI_REG_STATE_ON:
	277	buf[subpacket_offset] \|= BIT(2);
	278	break;
	279	case RMI_REG_STATE_DEFAULT:
	280	default:
	281	break;
	282	}
	283
	284	ret = rmi_write_block(rmi_dev,
	285	fn->fd.control_base_addr + control_offset,
	286	buf, control_size);
	287	if (ret)
	288	return ret;
	289	}
	290	}
	291
	292	return 0;
	293
	294	}
	295
b43d2c1e AD	296	static int rmi_f12_config(struct rmi_function *fn)
	297	{
	298	struct rmi_driver *drv = fn->rmi_dev->driver;
24f63b1c	299	int ret;
b43d2c1e AD	300
	301	drv->set_irq_bits(fn->rmi_dev, fn->irq_mask);
	302
24f63b1c AD	303	ret = rmi_f12_write_control_regs(fn);
	304	if (ret)
	305	dev_warn(&fn->dev,
	306	"Failed to write F12 control registers: %d\n", ret);
	307
b43d2c1e AD	308	return 0;
	309	}
	310
	311	static int rmi_f12_probe(struct rmi_function *fn)
	312	{
	313	struct f12_data *f12;
	314	int ret;
	315	struct rmi_device *rmi_dev = fn->rmi_dev;
	316	char buf;
	317	u16 query_addr = fn->fd.query_base_addr;
	318	const struct rmi_register_desc_item *item;
	319	struct rmi_2d_sensor *sensor;
	320	struct rmi_device_platform_data *pdata = rmi_get_platform_data(rmi_dev);
ae9979c3	321	struct rmi_driver_data *drvdata = dev_get_drvdata(&rmi_dev->dev);
b43d2c1e AD	322	u16 data_offset = 0;
	323
	324	rmi_dbg(RMI_DEBUG_FN, &fn->dev, "%s\n", __func__);
	325
	326	ret = rmi_read(fn->rmi_dev, query_addr, &buf);
	327	if (ret < 0) {
	328	dev_err(&fn->dev, "Failed to read general info register: %d\n",
	329	ret);
	330	return -ENODEV;
	331	}
	332	++query_addr;
	333
24f63b1c	334	if (!(buf & BIT(0))) {
b43d2c1e AD	335	dev_err(&fn->dev,
	336	"Behavior of F12 without register descriptors is undefined.\n");
	337	return -ENODEV;
	338	}
	339
	340	f12 = devm_kzalloc(&fn->dev, sizeof(struct f12_data), GFP_KERNEL);
	341	if (!f12)
	342	return -ENOMEM;
	343
24f63b1c AD	344	f12->has_dribble = !!(buf & BIT(3));
24f63b1c AD	345
b43d2c1e AD	346	if (fn->dev.of_node) {
	347	ret = rmi_2d_sensor_of_probe(&fn->dev, &f12->sensor_pdata);
	348	if (ret)
	349	return ret;
0a135b88 BT	350	} else {
0a135b88 BT	351	f12->sensor_pdata = pdata->sensor_pdata;
b43d2c1e AD	352	}
	353
	354	ret = rmi_read_register_desc(rmi_dev, query_addr,
	355	&f12->query_reg_desc);
	356	if (ret) {
	357	dev_err(&fn->dev,
	358	"Failed to read the Query Register Descriptor: %d\n",
	359	ret);
	360	return ret;
	361	}
	362	query_addr += 3;
	363
	364	ret = rmi_read_register_desc(rmi_dev, query_addr,
	365	&f12->control_reg_desc);
	366	if (ret) {
	367	dev_err(&fn->dev,
	368	"Failed to read the Control Register Descriptor: %d\n",
	369	ret);
	370	return ret;
	371	}
	372	query_addr += 3;
	373
	374	ret = rmi_read_register_desc(rmi_dev, query_addr,
	375	&f12->data_reg_desc);
	376	if (ret) {
	377	dev_err(&fn->dev,
	378	"Failed to read the Data Register Descriptor: %d\n",
	379	ret);
	380	return ret;
	381	}
	382	query_addr += 3;
	383
	384	sensor = &f12->sensor;
	385	sensor->fn = fn;
	386	f12->data_addr = fn->fd.data_base_addr;
	387	sensor->pkt_size = rmi_register_desc_calc_size(&f12->data_reg_desc);
	388
	389	sensor->axis_align =
	390	f12->sensor_pdata.axis_align;
	391
	392	sensor->x_mm = f12->sensor_pdata.x_mm;
	393	sensor->y_mm = f12->sensor_pdata.y_mm;
24f63b1c	394	sensor->dribble = f12->sensor_pdata.dribble;
b43d2c1e AD	395
	396	if (sensor->sensor_type == rmi_sensor_default)
	397	sensor->sensor_type =
	398	f12->sensor_pdata.sensor_type;
	399
	400	rmi_dbg(RMI_DEBUG_FN, &fn->dev, "%s: data packet size: %d\n", __func__,
	401	sensor->pkt_size);
	402	sensor->data_pkt = devm_kzalloc(&fn->dev, sensor->pkt_size, GFP_KERNEL);
	403	if (!sensor->data_pkt)
	404	return -ENOMEM;
	405
	406	dev_set_drvdata(&fn->dev, f12);
	407
	408	ret = rmi_f12_read_sensor_tuning(f12);
	409	if (ret)
	410	return ret;
	411
	412	/*
	413	* Figure out what data is contained in the data registers. HID devices
	414	* may have registers defined, but their data is not reported in the
	415	* HID attention report. Registers which are not reported in the HID
	416	* attention report check to see if the device is receiving data from
	417	* HID attention reports.
	418	*/
	419	item = rmi_get_register_desc_item(&f12->data_reg_desc, 0);
ae9979c3	420	if (item && !drvdata->attn_data.data)
b43d2c1e AD	421	data_offset += item->reg_size;
	422
	423	item = rmi_get_register_desc_item(&f12->data_reg_desc, 1);
	424	if (item) {
	425	f12->data1 = item;
	426	f12->data1_offset = data_offset;
	427	data_offset += item->reg_size;
	428	sensor->nbr_fingers = item->num_subpackets;
	429	sensor->report_abs = 1;
	430	sensor->attn_size += item->reg_size;
	431	}
	432
	433	item = rmi_get_register_desc_item(&f12->data_reg_desc, 2);
ae9979c3	434	if (item && !drvdata->attn_data.data)
b43d2c1e AD	435	data_offset += item->reg_size;
	436
	437	item = rmi_get_register_desc_item(&f12->data_reg_desc, 3);
ae9979c3	438	if (item && !drvdata->attn_data.data)
b43d2c1e AD	439	data_offset += item->reg_size;
	440
	441	item = rmi_get_register_desc_item(&f12->data_reg_desc, 4);
ae9979c3	442	if (item && !drvdata->attn_data.data)
b43d2c1e AD	443	data_offset += item->reg_size;
	444
	445	item = rmi_get_register_desc_item(&f12->data_reg_desc, 5);
	446	if (item) {
	447	f12->data5 = item;
	448	f12->data5_offset = data_offset;
	449	data_offset += item->reg_size;
	450	sensor->attn_size += item->reg_size;
	451	}
	452
	453	item = rmi_get_register_desc_item(&f12->data_reg_desc, 6);
ae9979c3	454	if (item && !drvdata->attn_data.data) {
b43d2c1e AD	455	f12->data6 = item;
	456	f12->data6_offset = data_offset;
	457	data_offset += item->reg_size;
	458	}
	459
	460	item = rmi_get_register_desc_item(&f12->data_reg_desc, 7);
ae9979c3	461	if (item && !drvdata->attn_data.data)
b43d2c1e AD	462	data_offset += item->reg_size;
	463
	464	item = rmi_get_register_desc_item(&f12->data_reg_desc, 8);
ae9979c3	465	if (item && !drvdata->attn_data.data)
b43d2c1e AD	466	data_offset += item->reg_size;
	467
	468	item = rmi_get_register_desc_item(&f12->data_reg_desc, 9);
ae9979c3	469	if (item && !drvdata->attn_data.data) {
b43d2c1e AD	470	f12->data9 = item;
	471	f12->data9_offset = data_offset;
	472	data_offset += item->reg_size;
	473	if (!sensor->report_abs)
	474	sensor->report_rel = 1;
	475	}
	476
	477	item = rmi_get_register_desc_item(&f12->data_reg_desc, 10);
ae9979c3	478	if (item && !drvdata->attn_data.data)
b43d2c1e AD	479	data_offset += item->reg_size;
	480
	481	item = rmi_get_register_desc_item(&f12->data_reg_desc, 11);
ae9979c3	482	if (item && !drvdata->attn_data.data)
b43d2c1e AD	483	data_offset += item->reg_size;
	484
	485	item = rmi_get_register_desc_item(&f12->data_reg_desc, 12);
ae9979c3	486	if (item && !drvdata->attn_data.data)
b43d2c1e AD	487	data_offset += item->reg_size;
	488
	489	item = rmi_get_register_desc_item(&f12->data_reg_desc, 13);
ae9979c3	490	if (item && !drvdata->attn_data.data)
b43d2c1e AD	491	data_offset += item->reg_size;
	492
	493	item = rmi_get_register_desc_item(&f12->data_reg_desc, 14);
ae9979c3	494	if (item && !drvdata->attn_data.data)
b43d2c1e AD	495	data_offset += item->reg_size;
	496
	497	item = rmi_get_register_desc_item(&f12->data_reg_desc, 15);
ae9979c3	498	if (item && !drvdata->attn_data.data) {
b43d2c1e AD	499	f12->data15 = item;
	500	f12->data15_offset = data_offset;
	501	data_offset += item->reg_size;
	502	}
	503
	504	/* allocate the in-kernel tracking buffers */
	505	sensor->tracking_pos = devm_kzalloc(&fn->dev,
	506	sizeof(struct input_mt_pos) * sensor->nbr_fingers,
	507	GFP_KERNEL);
	508	sensor->tracking_slots = devm_kzalloc(&fn->dev,
	509	sizeof(int) * sensor->nbr_fingers, GFP_KERNEL);
	510	sensor->objs = devm_kzalloc(&fn->dev,
	511	sizeof(struct rmi_2d_sensor_abs_object)
	512	* sensor->nbr_fingers, GFP_KERNEL);
	513	if (!sensor->tracking_pos \|\| !sensor->tracking_slots \|\| !sensor->objs)
	514	return -ENOMEM;
	515
	516	ret = rmi_2d_sensor_configure_input(fn, sensor);
	517	if (ret)
	518	return ret;
	519
	520	return 0;
	521	}
	522
	523	struct rmi_function_handler rmi_f12_handler = {
	524	.driver = {
	525	.name = "rmi4_f12",
	526	},
	527	.func = 0x12,
	528	.probe = rmi_f12_probe,
	529	.config = rmi_f12_config,
	530	.attention = rmi_f12_attention,
	531	};