[mirror_ubuntu-artful-kernel.git] / drivers / iio / gyro / hid-sensor-gyro-3d.c

/*
 * HID Sensors Driver
 * Copyright (c) 2012, Intel Corporation.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
 *
 */
#include <linux/device.h>
#include <linux/platform_device.h>
#include <linux/module.h>
#include <linux/interrupt.h>
#include <linux/irq.h>
#include <linux/slab.h>
#include <linux/delay.h>
#include <linux/hid-sensor-hub.h>
#include <linux/iio/iio.h>
#include <linux/iio/sysfs.h>
#include <linux/iio/buffer.h>
#include <linux/iio/trigger_consumer.h>
#include <linux/iio/triggered_buffer.h>
#include "../common/hid-sensors/hid-sensor-trigger.h"

enum gyro_3d_channel {
	CHANNEL_SCAN_INDEX_X,
	CHANNEL_SCAN_INDEX_Y,
	CHANNEL_SCAN_INDEX_Z,
	GYRO_3D_CHANNEL_MAX,
};

struct gyro_3d_state {
	struct hid_sensor_hub_callbacks callbacks;
	struct hid_sensor_common common_attributes;
	struct hid_sensor_hub_attribute_info gyro[GYRO_3D_CHANNEL_MAX];
	u32 gyro_val[GYRO_3D_CHANNEL_MAX];
	int scale_pre_decml;
	int scale_post_decml;
	int scale_precision;
	int value_offset;
};

static const u32 gyro_3d_addresses[GYRO_3D_CHANNEL_MAX] = {
	HID_USAGE_SENSOR_ANGL_VELOCITY_X_AXIS,
	HID_USAGE_SENSOR_ANGL_VELOCITY_Y_AXIS,
	HID_USAGE_SENSOR_ANGL_VELOCITY_Z_AXIS
};

/* Channel definitions */
static const struct iio_chan_spec gyro_3d_channels[] = {
	{
		.type = IIO_ANGL_VEL,
		.modified = 1,
		.channel2 = IIO_MOD_X,
		.info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
		.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
		BIT(IIO_CHAN_INFO_SCALE) |
		BIT(IIO_CHAN_INFO_SAMP_FREQ) |
		BIT(IIO_CHAN_INFO_HYSTERESIS),
		.scan_index = CHANNEL_SCAN_INDEX_X,
	}, {
		.type = IIO_ANGL_VEL,
		.modified = 1,
		.channel2 = IIO_MOD_Y,
		.info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
		.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
		BIT(IIO_CHAN_INFO_SCALE) |
		BIT(IIO_CHAN_INFO_SAMP_FREQ) |
		BIT(IIO_CHAN_INFO_HYSTERESIS),
		.scan_index = CHANNEL_SCAN_INDEX_Y,
	}, {
		.type = IIO_ANGL_VEL,
		.modified = 1,
		.channel2 = IIO_MOD_Z,
		.info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
		.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
		BIT(IIO_CHAN_INFO_SCALE) |
		BIT(IIO_CHAN_INFO_SAMP_FREQ) |
		BIT(IIO_CHAN_INFO_HYSTERESIS),
		.scan_index = CHANNEL_SCAN_INDEX_Z,
	}
};

/* Adjust channel real bits based on report descriptor */
static void gyro_3d_adjust_channel_bit_mask(struct iio_chan_spec *channels,
						int channel, int size)
{
	channels[channel].scan_type.sign = 's';
	/* Real storage bits will change based on the report desc. */
	channels[channel].scan_type.realbits = size * 8;
	/* Maximum size of a sample to capture is u32 */
	channels[channel].scan_type.storagebits = sizeof(u32) * 8;
}

/* Channel read_raw handler */
static int gyro_3d_read_raw(struct iio_dev *indio_dev,
			      struct iio_chan_spec const *chan,
			      int *val, int *val2,
			      long mask)
{
	struct gyro_3d_state *gyro_state = iio_priv(indio_dev);
	int report_id = -1;
	u32 address;
	int ret_type;
	s32 poll_value;

	*val = 0;
	*val2 = 0;
	switch (mask) {
	case 0:
		poll_value = hid_sensor_read_poll_value(
					&gyro_state->common_attributes);
		if (poll_value < 0)
			return -EINVAL;

		hid_sensor_power_state(&gyro_state->common_attributes, true);
		msleep_interruptible(poll_value * 2);
		report_id = gyro_state->gyro[chan->scan_index].report_id;
		address = gyro_3d_addresses[chan->scan_index];
		if (report_id >= 0)
			*val = sensor_hub_input_attr_get_raw_value(
					gyro_state->common_attributes.hsdev,
					HID_USAGE_SENSOR_GYRO_3D, address,
					report_id);
		else {
			*val = 0;
			hid_sensor_power_state(&gyro_state->common_attributes,
						false);
			return -EINVAL;
		}
		hid_sensor_power_state(&gyro_state->common_attributes, false);
		ret_type = IIO_VAL_INT;
		break;
	case IIO_CHAN_INFO_SCALE:
		*val = gyro_state->scale_pre_decml;
		*val2 = gyro_state->scale_post_decml;
		ret_type = gyro_state->scale_precision;
		break;
	case IIO_CHAN_INFO_OFFSET:
		*val = gyro_state->value_offset;
		ret_type = IIO_VAL_INT;
		break;
	case IIO_CHAN_INFO_SAMP_FREQ:
		ret_type = hid_sensor_read_samp_freq_value(
			&gyro_state->common_attributes, val, val2);
		break;
	case IIO_CHAN_INFO_HYSTERESIS:
		ret_type = hid_sensor_read_raw_hyst_value(
			&gyro_state->common_attributes, val, val2);
		break;
	default:
		ret_type = -EINVAL;
		break;
	}

	return ret_type;
}

/* Channel write_raw handler */
static int gyro_3d_write_raw(struct iio_dev *indio_dev,
			       struct iio_chan_spec const *chan,
			       int val,
			       int val2,
			       long mask)
{
	struct gyro_3d_state *gyro_state = iio_priv(indio_dev);
	int ret = 0;

	switch (mask) {
	case IIO_CHAN_INFO_SAMP_FREQ:
		ret = hid_sensor_write_samp_freq_value(
				&gyro_state->common_attributes, val, val2);
		break;
	case IIO_CHAN_INFO_HYSTERESIS:
		ret = hid_sensor_write_raw_hyst_value(
				&gyro_state->common_attributes, val, val2);
		break;
	default:
		ret = -EINVAL;
	}

	return ret;
}

static const struct iio_info gyro_3d_info = {
	.driver_module = THIS_MODULE,
	.read_raw = &gyro_3d_read_raw,
	.write_raw = &gyro_3d_write_raw,
};

/* Function to push data to buffer */
static void hid_sensor_push_data(struct iio_dev *indio_dev, const void *data,
	int len)
{
	dev_dbg(&indio_dev->dev, "hid_sensor_push_data\n");
	iio_push_to_buffers(indio_dev, data);
}

/* Callback handler to send event after all samples are received and captured */
static int gyro_3d_proc_event(struct hid_sensor_hub_device *hsdev,
				unsigned usage_id,
				void *priv)
{
	struct iio_dev *indio_dev = platform_get_drvdata(priv);
	struct gyro_3d_state *gyro_state = iio_priv(indio_dev);

	dev_dbg(&indio_dev->dev, "gyro_3d_proc_event\n");
	if (atomic_read(&gyro_state->common_attributes.data_ready))
		hid_sensor_push_data(indio_dev,
				gyro_state->gyro_val,
				sizeof(gyro_state->gyro_val));

	return 0;
}

/* Capture samples in local storage */
static int gyro_3d_capture_sample(struct hid_sensor_hub_device *hsdev,
				unsigned usage_id,
				size_t raw_len, char *raw_data,
				void *priv)
{
	struct iio_dev *indio_dev = platform_get_drvdata(priv);
	struct gyro_3d_state *gyro_state = iio_priv(indio_dev);
	int offset;
	int ret = -EINVAL;

	switch (usage_id) {
	case HID_USAGE_SENSOR_ANGL_VELOCITY_X_AXIS:
	case HID_USAGE_SENSOR_ANGL_VELOCITY_Y_AXIS:
	case HID_USAGE_SENSOR_ANGL_VELOCITY_Z_AXIS:
		offset = usage_id - HID_USAGE_SENSOR_ANGL_VELOCITY_X_AXIS;
		gyro_state->gyro_val[CHANNEL_SCAN_INDEX_X + offset] =
						*(u32 *)raw_data;
		ret = 0;
	break;
	default:
		break;
	}

	return ret;
}

/* Parse report which is specific to an usage id*/
static int gyro_3d_parse_report(struct platform_device *pdev,
				struct hid_sensor_hub_device *hsdev,
				struct iio_chan_spec *channels,
				unsigned usage_id,
				struct gyro_3d_state *st)
{
	int ret;
	int i;

	for (i = 0; i <= CHANNEL_SCAN_INDEX_Z; ++i) {
		ret = sensor_hub_input_get_attribute_info(hsdev,
				HID_INPUT_REPORT,
				usage_id,
				HID_USAGE_SENSOR_ANGL_VELOCITY_X_AXIS + i,
				&st->gyro[CHANNEL_SCAN_INDEX_X + i]);
		if (ret < 0)
			break;
		gyro_3d_adjust_channel_bit_mask(channels,
				CHANNEL_SCAN_INDEX_X + i,
				st->gyro[CHANNEL_SCAN_INDEX_X + i].size);
	}
	dev_dbg(&pdev->dev, "gyro_3d %x:%x, %x:%x, %x:%x\n",
			st->gyro[0].index,
			st->gyro[0].report_id,
			st->gyro[1].index, st->gyro[1].report_id,
			st->gyro[2].index, st->gyro[2].report_id);

	st->scale_precision = hid_sensor_format_scale(
				HID_USAGE_SENSOR_GYRO_3D,
				&st->gyro[CHANNEL_SCAN_INDEX_X],
				&st->scale_pre_decml, &st->scale_post_decml);

	/* Set Sensitivity field ids, when there is no individual modifier */
	if (st->common_attributes.sensitivity.index < 0) {
		sensor_hub_input_get_attribute_info(hsdev,
			HID_FEATURE_REPORT, usage_id,
			HID_USAGE_SENSOR_DATA_MOD_CHANGE_SENSITIVITY_ABS |
			HID_USAGE_SENSOR_DATA_ANGL_VELOCITY,
			&st->common_attributes.sensitivity);
		dev_dbg(&pdev->dev, "Sensitivity index:report %d:%d\n",
			st->common_attributes.sensitivity.index,
			st->common_attributes.sensitivity.report_id);
	}
	return ret;
}

/* Function to initialize the processing for usage id */
static int hid_gyro_3d_probe(struct platform_device *pdev)
{
	int ret = 0;
	static const char *name = "gyro_3d";
	struct iio_dev *indio_dev;
	struct gyro_3d_state *gyro_state;
	struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
	struct iio_chan_spec *channels;

	indio_dev = devm_iio_device_alloc(&pdev->dev, sizeof(*gyro_state));
	if (!indio_dev)
		return -ENOMEM;
	platform_set_drvdata(pdev, indio_dev);

	gyro_state = iio_priv(indio_dev);
	gyro_state->common_attributes.hsdev = hsdev;
	gyro_state->common_attributes.pdev = pdev;

	ret = hid_sensor_parse_common_attributes(hsdev,
						HID_USAGE_SENSOR_GYRO_3D,
						&gyro_state->common_attributes);
	if (ret) {
		dev_err(&pdev->dev, "failed to setup common attributes\n");
		return ret;
	}

	channels = kmemdup(gyro_3d_channels, sizeof(gyro_3d_channels),
			   GFP_KERNEL);
	if (!channels) {
		dev_err(&pdev->dev, "failed to duplicate channels\n");
		return -ENOMEM;
	}

	ret = gyro_3d_parse_report(pdev, hsdev, channels,
					HID_USAGE_SENSOR_GYRO_3D, gyro_state);
	if (ret) {
		dev_err(&pdev->dev, "failed to setup attributes\n");
		goto error_free_dev_mem;
	}

	indio_dev->channels = channels;
	indio_dev->num_channels = ARRAY_SIZE(gyro_3d_channels);
	indio_dev->dev.parent = &pdev->dev;
	indio_dev->info = &gyro_3d_info;
	indio_dev->name = name;
	indio_dev->modes = INDIO_DIRECT_MODE;

	ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time,
		NULL, NULL);
	if (ret) {
		dev_err(&pdev->dev, "failed to initialize trigger buffer\n");
		goto error_free_dev_mem;
	}
	atomic_set(&gyro_state->common_attributes.data_ready, 0);
	ret = hid_sensor_setup_trigger(indio_dev, name,
					&gyro_state->common_attributes);
	if (ret < 0) {
		dev_err(&pdev->dev, "trigger setup failed\n");
		goto error_unreg_buffer_funcs;
	}

	ret = iio_device_register(indio_dev);
	if (ret) {
		dev_err(&pdev->dev, "device register failed\n");
		goto error_remove_trigger;
	}

	gyro_state->callbacks.send_event = gyro_3d_proc_event;
	gyro_state->callbacks.capture_sample = gyro_3d_capture_sample;
	gyro_state->callbacks.pdev = pdev;
	ret = sensor_hub_register_callback(hsdev, HID_USAGE_SENSOR_GYRO_3D,
					&gyro_state->callbacks);
	if (ret < 0) {
		dev_err(&pdev->dev, "callback reg failed\n");
		goto error_iio_unreg;
	}

	return ret;

error_iio_unreg:
	iio_device_unregister(indio_dev);
error_remove_trigger:
	hid_sensor_remove_trigger(&gyro_state->common_attributes);
error_unreg_buffer_funcs:
	iio_triggered_buffer_cleanup(indio_dev);
error_free_dev_mem:
	kfree(indio_dev->channels);
	return ret;
}

/* Function to deinitialize the processing for usage id */
static int hid_gyro_3d_remove(struct platform_device *pdev)
{
	struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
	struct iio_dev *indio_dev = platform_get_drvdata(pdev);
	struct gyro_3d_state *gyro_state = iio_priv(indio_dev);

	sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_GYRO_3D);
	iio_device_unregister(indio_dev);
	hid_sensor_remove_trigger(&gyro_state->common_attributes);
	iio_triggered_buffer_cleanup(indio_dev);
	kfree(indio_dev->channels);

	return 0;
}

static struct platform_device_id hid_gyro_3d_ids[] = {
	{
		/* Format: HID-SENSOR-usage_id_in_hex_lowercase */
		.name = "HID-SENSOR-200076",
	},
	{ /* sentinel */ }
};
MODULE_DEVICE_TABLE(platform, hid_gyro_3d_ids);

static struct platform_driver hid_gyro_3d_platform_driver = {
	.id_table = hid_gyro_3d_ids,
	.driver = {
		.name	= KBUILD_MODNAME,
	},
	.probe		= hid_gyro_3d_probe,
	.remove		= hid_gyro_3d_remove,
};
module_platform_driver(hid_gyro_3d_platform_driver);

MODULE_DESCRIPTION("HID Sensor Gyroscope 3D");
MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
MODULE_LICENSE("GPL");
Commit	Line	Data
c5bdbef7	1	/*
	2	* HID Sensors Driver
	3	* Copyright (c) 2012, Intel Corporation.
	4	*
	5	* This program is free software; you can redistribute it and/or modify it
	6	* under the terms and conditions of the GNU General Public License,
	7	* version 2, as published by the Free Software Foundation.
	8	*
	9	* This program is distributed in the hope it will be useful, but WITHOUT
	10	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	11	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	12	* more details.
	13	*
	14	* You should have received a copy of the GNU General Public License along with
	15	* this program; if not, write to the Free Software Foundation, Inc.,
	16	* 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
	17	*
	18	*/
	19	#include <linux/device.h>
	20	#include <linux/platform_device.h>
	21	#include <linux/module.h>
	22	#include <linux/interrupt.h>
	23	#include <linux/irq.h>
	24	#include <linux/slab.h>
0964f706	25	#include <linux/delay.h>
c5bdbef7	26	#include <linux/hid-sensor-hub.h>
	27	#include <linux/iio/iio.h>
	28	#include <linux/iio/sysfs.h>
	29	#include <linux/iio/buffer.h>
	30	#include <linux/iio/trigger_consumer.h>
	31	#include <linux/iio/triggered_buffer.h>
c5bdbef7	32	#include "../common/hid-sensors/hid-sensor-trigger.h"
c5bdbef7	33
c5bdbef7	34	enum gyro_3d_channel {
	35	CHANNEL_SCAN_INDEX_X,
	36	CHANNEL_SCAN_INDEX_Y,
	37	CHANNEL_SCAN_INDEX_Z,
	38	GYRO_3D_CHANNEL_MAX,
	39	};
	40
	41	struct gyro_3d_state {
	42	struct hid_sensor_hub_callbacks callbacks;
e07c6d17	43	struct hid_sensor_common common_attributes;
c5bdbef7	44	struct hid_sensor_hub_attribute_info gyro[GYRO_3D_CHANNEL_MAX];
c5bdbef7	45	u32 gyro_val[GYRO_3D_CHANNEL_MAX];
6c7db77e SP	46	int scale_pre_decml;
	47	int scale_post_decml;
	48	int scale_precision;
	49	int value_offset;
c5bdbef7	50	};
	51
	52	static const u32 gyro_3d_addresses[GYRO_3D_CHANNEL_MAX] = {
	53	HID_USAGE_SENSOR_ANGL_VELOCITY_X_AXIS,
	54	HID_USAGE_SENSOR_ANGL_VELOCITY_Y_AXIS,
	55	HID_USAGE_SENSOR_ANGL_VELOCITY_Z_AXIS
	56	};
	57
	58	/* Channel definitions */
	59	static const struct iio_chan_spec gyro_3d_channels[] = {
	60	{
	61	.type = IIO_ANGL_VEL,
	62	.modified = 1,
	63	.channel2 = IIO_MOD_X,
0964f706	64	.info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
ecbe18f2 JC	65	.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) \|
	66	BIT(IIO_CHAN_INFO_SCALE) \|
	67	BIT(IIO_CHAN_INFO_SAMP_FREQ) \|
	68	BIT(IIO_CHAN_INFO_HYSTERESIS),
c5bdbef7	69	.scan_index = CHANNEL_SCAN_INDEX_X,
	70	}, {
	71	.type = IIO_ANGL_VEL,
	72	.modified = 1,
	73	.channel2 = IIO_MOD_Y,
0964f706	74	.info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
ecbe18f2 JC	75	.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) \|
	76	BIT(IIO_CHAN_INFO_SCALE) \|
	77	BIT(IIO_CHAN_INFO_SAMP_FREQ) \|
	78	BIT(IIO_CHAN_INFO_HYSTERESIS),
c5bdbef7	79	.scan_index = CHANNEL_SCAN_INDEX_Y,
	80	}, {
	81	.type = IIO_ANGL_VEL,
	82	.modified = 1,
	83	.channel2 = IIO_MOD_Z,
0964f706	84	.info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
ecbe18f2 JC	85	.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) \|
	86	BIT(IIO_CHAN_INFO_SCALE) \|
	87	BIT(IIO_CHAN_INFO_SAMP_FREQ) \|
	88	BIT(IIO_CHAN_INFO_HYSTERESIS),
c5bdbef7	89	.scan_index = CHANNEL_SCAN_INDEX_Z,
	90	}
	91	};
	92
	93	/* Adjust channel real bits based on report descriptor */
	94	static void gyro_3d_adjust_channel_bit_mask(struct iio_chan_spec *channels,
	95	int channel, int size)
	96	{
	97	channels[channel].scan_type.sign = 's';
	98	/* Real storage bits will change based on the report desc. */
	99	channels[channel].scan_type.realbits = size * 8;
	100	/* Maximum size of a sample to capture is u32 */
	101	channels[channel].scan_type.storagebits = sizeof(u32) * 8;
	102	}
	103
	104	/* Channel read_raw handler */
	105	static int gyro_3d_read_raw(struct iio_dev *indio_dev,
	106	struct iio_chan_spec const *chan,
	107	int val, int val2,
	108	long mask)
	109	{
	110	struct gyro_3d_state *gyro_state = iio_priv(indio_dev);
	111	int report_id = -1;
	112	u32 address;
c5bdbef7	113	int ret_type;
0964f706	114	s32 poll_value;
c5bdbef7	115
	116	*val = 0;
	117	*val2 = 0;
	118	switch (mask) {
	119	case 0:
0964f706 SP	120	poll_value = hid_sensor_read_poll_value(
	121	&gyro_state->common_attributes);
	122	if (poll_value < 0)
	123	return -EINVAL;
	124
	125	hid_sensor_power_state(&gyro_state->common_attributes, true);
	126	msleep_interruptible(poll_value * 2);
c5bdbef7	127	report_id = gyro_state->gyro[chan->scan_index].report_id;
	128	address = gyro_3d_addresses[chan->scan_index];
	129	if (report_id >= 0)
	130	*val = sensor_hub_input_attr_get_raw_value(
0964f706 SP	131	gyro_state->common_attributes.hsdev,
	132	HID_USAGE_SENSOR_GYRO_3D, address,
	133	report_id);
c5bdbef7	134	else {
c5bdbef7	135	*val = 0;
0964f706 SP	136	hid_sensor_power_state(&gyro_state->common_attributes,
0964f706 SP	137	false);
c5bdbef7	138	return -EINVAL;
c5bdbef7	139	}
0964f706	140	hid_sensor_power_state(&gyro_state->common_attributes, false);
c5bdbef7	141	ret_type = IIO_VAL_INT;
	142	break;
	143	case IIO_CHAN_INFO_SCALE:
6c7db77e SP	144	*val = gyro_state->scale_pre_decml;
	145	*val2 = gyro_state->scale_post_decml;
	146	ret_type = gyro_state->scale_precision;
c5bdbef7	147	break;
c5bdbef7	148	case IIO_CHAN_INFO_OFFSET:
6c7db77e	149	*val = gyro_state->value_offset;
c5bdbef7	150	ret_type = IIO_VAL_INT;
	151	break;
	152	case IIO_CHAN_INFO_SAMP_FREQ:
27793803	153	ret_type = hid_sensor_read_samp_freq_value(
c5bdbef7	154	&gyro_state->common_attributes, val, val2);
c5bdbef7	155	break;
c5bdbef7	156	case IIO_CHAN_INFO_HYSTERESIS:
27793803	157	ret_type = hid_sensor_read_raw_hyst_value(
c5bdbef7	158	&gyro_state->common_attributes, val, val2);
c5bdbef7	159	break;
	160	default:
	161	ret_type = -EINVAL;
	162	break;
	163	}
	164
	165	return ret_type;
	166	}
	167
	168	/* Channel write_raw handler */
	169	static int gyro_3d_write_raw(struct iio_dev *indio_dev,
	170	struct iio_chan_spec const *chan,
	171	int val,
	172	int val2,
	173	long mask)
	174	{
	175	struct gyro_3d_state *gyro_state = iio_priv(indio_dev);
	176	int ret = 0;
	177
	178	switch (mask) {
	179	case IIO_CHAN_INFO_SAMP_FREQ:
	180	ret = hid_sensor_write_samp_freq_value(
	181	&gyro_state->common_attributes, val, val2);
	182	break;
	183	case IIO_CHAN_INFO_HYSTERESIS:
	184	ret = hid_sensor_write_raw_hyst_value(
	185	&gyro_state->common_attributes, val, val2);
	186	break;
	187	default:
	188	ret = -EINVAL;
	189	}
	190
	191	return ret;
	192	}
	193
c5bdbef7	194	static const struct iio_info gyro_3d_info = {
	195	.driver_module = THIS_MODULE,
	196	.read_raw = &gyro_3d_read_raw,
	197	.write_raw = &gyro_3d_write_raw,
c5bdbef7	198	};
	199
	200	/* Function to push data to buffer */
8c60c7e7 LPC	201	static void hid_sensor_push_data(struct iio_dev indio_dev, const void data,
8c60c7e7 LPC	202	int len)
c5bdbef7	203	{
c5bdbef7	204	dev_dbg(&indio_dev->dev, "hid_sensor_push_data\n");
8c60c7e7	205	iio_push_to_buffers(indio_dev, data);
c5bdbef7	206	}
	207
	208	/* Callback handler to send event after all samples are received and captured */
	209	static int gyro_3d_proc_event(struct hid_sensor_hub_device *hsdev,
	210	unsigned usage_id,
	211	void *priv)
	212	{
	213	struct iio_dev *indio_dev = platform_get_drvdata(priv);
	214	struct gyro_3d_state *gyro_state = iio_priv(indio_dev);
	215
56ff6be6 SP	216	dev_dbg(&indio_dev->dev, "gyro_3d_proc_event\n");
56ff6be6 SP	217	if (atomic_read(&gyro_state->common_attributes.data_ready))
c5bdbef7	218	hid_sensor_push_data(indio_dev,
8c60c7e7	219	gyro_state->gyro_val,
c5bdbef7	220	sizeof(gyro_state->gyro_val));
	221
	222	return 0;
	223	}
	224
	225	/* Capture samples in local storage */
	226	static int gyro_3d_capture_sample(struct hid_sensor_hub_device *hsdev,
	227	unsigned usage_id,
	228	size_t raw_len, char *raw_data,
	229	void *priv)
	230	{
	231	struct iio_dev *indio_dev = platform_get_drvdata(priv);
	232	struct gyro_3d_state *gyro_state = iio_priv(indio_dev);
	233	int offset;
	234	int ret = -EINVAL;
	235
	236	switch (usage_id) {
	237	case HID_USAGE_SENSOR_ANGL_VELOCITY_X_AXIS:
	238	case HID_USAGE_SENSOR_ANGL_VELOCITY_Y_AXIS:
	239	case HID_USAGE_SENSOR_ANGL_VELOCITY_Z_AXIS:
	240	offset = usage_id - HID_USAGE_SENSOR_ANGL_VELOCITY_X_AXIS;
	241	gyro_state->gyro_val[CHANNEL_SCAN_INDEX_X + offset] =
	242	(u32 )raw_data;
	243	ret = 0;
	244	break;
	245	default:
	246	break;
	247	}
	248
	249	return ret;
	250	}
	251
	252	/* Parse report which is specific to an usage id*/
	253	static int gyro_3d_parse_report(struct platform_device *pdev,
	254	struct hid_sensor_hub_device *hsdev,
	255	struct iio_chan_spec *channels,
	256	unsigned usage_id,
	257	struct gyro_3d_state *st)
	258	{
	259	int ret;
	260	int i;
	261
	262	for (i = 0; i <= CHANNEL_SCAN_INDEX_Z; ++i) {
	263	ret = sensor_hub_input_get_attribute_info(hsdev,
	264	HID_INPUT_REPORT,
	265	usage_id,
	266	HID_USAGE_SENSOR_ANGL_VELOCITY_X_AXIS + i,
	267	&st->gyro[CHANNEL_SCAN_INDEX_X + i]);
	268	if (ret < 0)
	269	break;
	270	gyro_3d_adjust_channel_bit_mask(channels,
	271	CHANNEL_SCAN_INDEX_X + i,
	272	st->gyro[CHANNEL_SCAN_INDEX_X + i].size);
	273	}
	274	dev_dbg(&pdev->dev, "gyro_3d %x:%x, %x:%x, %x:%x\n",
	275	st->gyro[0].index,
	276	st->gyro[0].report_id,
	277	st->gyro[1].index, st->gyro[1].report_id,
	278	st->gyro[2].index, st->gyro[2].report_id);
	279
6c7db77e SP	280	st->scale_precision = hid_sensor_format_scale(
	281	HID_USAGE_SENSOR_GYRO_3D,
	282	&st->gyro[CHANNEL_SCAN_INDEX_X],
	283	&st->scale_pre_decml, &st->scale_post_decml);
	284
2371aebf SP	285	/* Set Sensitivity field ids, when there is no individual modifier */
	286	if (st->common_attributes.sensitivity.index < 0) {
	287	sensor_hub_input_get_attribute_info(hsdev,
	288	HID_FEATURE_REPORT, usage_id,
	289	HID_USAGE_SENSOR_DATA_MOD_CHANGE_SENSITIVITY_ABS \|
	290	HID_USAGE_SENSOR_DATA_ANGL_VELOCITY,
	291	&st->common_attributes.sensitivity);
	292	dev_dbg(&pdev->dev, "Sensitivity index:report %d:%d\n",
	293	st->common_attributes.sensitivity.index,
	294	st->common_attributes.sensitivity.report_id);
	295	}
c5bdbef7	296	return ret;
	297	}
	298
	299	/* Function to initialize the processing for usage id */
fc52692c	300	static int hid_gyro_3d_probe(struct platform_device *pdev)
c5bdbef7	301	{
	302	int ret = 0;
	303	static const char *name = "gyro_3d";
	304	struct iio_dev *indio_dev;
	305	struct gyro_3d_state *gyro_state;
	306	struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
	307	struct iio_chan_spec *channels;
	308
1ba15cf2 SK	309	indio_dev = devm_iio_device_alloc(&pdev->dev, sizeof(*gyro_state));
	310	if (!indio_dev)
	311	return -ENOMEM;
c5bdbef7	312	platform_set_drvdata(pdev, indio_dev);
	313
	314	gyro_state = iio_priv(indio_dev);
	315	gyro_state->common_attributes.hsdev = hsdev;
	316	gyro_state->common_attributes.pdev = pdev;
	317
	318	ret = hid_sensor_parse_common_attributes(hsdev,
	319	HID_USAGE_SENSOR_GYRO_3D,
	320	&gyro_state->common_attributes);
	321	if (ret) {
	322	dev_err(&pdev->dev, "failed to setup common attributes\n");
1ba15cf2	323	return ret;
c5bdbef7	324	}
c5bdbef7	325
64ebe955 AL	326	channels = kmemdup(gyro_3d_channels, sizeof(gyro_3d_channels),
64ebe955 AL	327	GFP_KERNEL);
c5bdbef7	328	if (!channels) {
c5bdbef7	329	dev_err(&pdev->dev, "failed to duplicate channels\n");
1ba15cf2	330	return -ENOMEM;
c5bdbef7	331	}
	332
	333	ret = gyro_3d_parse_report(pdev, hsdev, channels,
	334	HID_USAGE_SENSOR_GYRO_3D, gyro_state);
	335	if (ret) {
	336	dev_err(&pdev->dev, "failed to setup attributes\n");
	337	goto error_free_dev_mem;
	338	}
	339
	340	indio_dev->channels = channels;
	341	indio_dev->num_channels = ARRAY_SIZE(gyro_3d_channels);
	342	indio_dev->dev.parent = &pdev->dev;
	343	indio_dev->info = &gyro_3d_info;
	344	indio_dev->name = name;
	345	indio_dev->modes = INDIO_DIRECT_MODE;
	346
	347	ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time,
	348	NULL, NULL);
	349	if (ret) {
	350	dev_err(&pdev->dev, "failed to initialize trigger buffer\n");
	351	goto error_free_dev_mem;
	352	}
56ff6be6	353	atomic_set(&gyro_state->common_attributes.data_ready, 0);
c5bdbef7	354	ret = hid_sensor_setup_trigger(indio_dev, name,
	355	&gyro_state->common_attributes);
	356	if (ret < 0) {
	357	dev_err(&pdev->dev, "trigger setup failed\n");
	358	goto error_unreg_buffer_funcs;
	359	}
	360
	361	ret = iio_device_register(indio_dev);
	362	if (ret) {
	363	dev_err(&pdev->dev, "device register failed\n");
	364	goto error_remove_trigger;
	365	}
	366
	367	gyro_state->callbacks.send_event = gyro_3d_proc_event;
	368	gyro_state->callbacks.capture_sample = gyro_3d_capture_sample;
	369	gyro_state->callbacks.pdev = pdev;
	370	ret = sensor_hub_register_callback(hsdev, HID_USAGE_SENSOR_GYRO_3D,
	371	&gyro_state->callbacks);
	372	if (ret < 0) {
	373	dev_err(&pdev->dev, "callback reg failed\n");
	374	goto error_iio_unreg;
	375	}
	376
	377	return ret;
	378
	379	error_iio_unreg:
	380	iio_device_unregister(indio_dev);
	381	error_remove_trigger:
ec7f68e0	382	hid_sensor_remove_trigger(&gyro_state->common_attributes);
c5bdbef7	383	error_unreg_buffer_funcs:
	384	iio_triggered_buffer_cleanup(indio_dev);
	385	error_free_dev_mem:
	386	kfree(indio_dev->channels);
c5bdbef7	387	return ret;
	388	}
	389
	390	/* Function to deinitialize the processing for usage id */
fc52692c	391	static int hid_gyro_3d_remove(struct platform_device *pdev)
c5bdbef7	392	{
	393	struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
	394	struct iio_dev *indio_dev = platform_get_drvdata(pdev);
ec7f68e0	395	struct gyro_3d_state *gyro_state = iio_priv(indio_dev);
c5bdbef7	396
	397	sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_GYRO_3D);
	398	iio_device_unregister(indio_dev);
ec7f68e0	399	hid_sensor_remove_trigger(&gyro_state->common_attributes);
c5bdbef7	400	iio_triggered_buffer_cleanup(indio_dev);
c5bdbef7	401	kfree(indio_dev->channels);
c5bdbef7	402
	403	return 0;
	404	}
	405
a411e735 AH	406	static struct platform_device_id hid_gyro_3d_ids[] = {
	407	{
	408	/* Format: HID-SENSOR-usage_id_in_hex_lowercase */
	409	.name = "HID-SENSOR-200076",
	410	},
	411	{ /* sentinel */ }
	412	};
	413	MODULE_DEVICE_TABLE(platform, hid_gyro_3d_ids);
	414
c5bdbef7	415	static struct platform_driver hid_gyro_3d_platform_driver = {
a411e735	416	.id_table = hid_gyro_3d_ids,
c5bdbef7	417	.driver = {
a411e735	418	.name = KBUILD_MODNAME,
c5bdbef7	419	},
	420	.probe = hid_gyro_3d_probe,
	421	.remove = hid_gyro_3d_remove,
	422	};
	423	module_platform_driver(hid_gyro_3d_platform_driver);
	424
	425	MODULE_DESCRIPTION("HID Sensor Gyroscope 3D");
	426	MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
	427	MODULE_LICENSE("GPL");