[linux.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 min;

	*val = 0;
	*val2 = 0;
	switch (mask) {
	case IIO_CHAN_INFO_RAW:
		hid_sensor_power_state(&gyro_state->common_attributes, true);
		report_id = gyro_state->gyro[chan->scan_index].report_id;
		min = gyro_state->gyro[chan->scan_index].logical_minimum;
		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,
					SENSOR_HUB_SYNC,
					min < 0);
		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 = {
	.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;

	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;
	}

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

	ret = gyro_3d_parse_report(pdev, hsdev,
				   (struct iio_chan_spec *)indio_dev->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->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 const 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,
		.pm	= &hid_sensor_pm_ops,
	},
	.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 <[email protected]>");
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;
0145b505	114	s32 min;
c5bdbef7	115
	116	*val = 0;
	117	*val2 = 0;
	118	switch (mask) {
67464a54	119	case IIO_CHAN_INFO_RAW:
0964f706	120	hid_sensor_power_state(&gyro_state->common_attributes, true);
c5bdbef7	121	report_id = gyro_state->gyro[chan->scan_index].report_id;
0145b505	122	min = gyro_state->gyro[chan->scan_index].logical_minimum;
c5bdbef7	123	address = gyro_3d_addresses[chan->scan_index];
	124	if (report_id >= 0)
	125	*val = sensor_hub_input_attr_get_raw_value(
0964f706 SP	126	gyro_state->common_attributes.hsdev,
0964f706 SP	127	HID_USAGE_SENSOR_GYRO_3D, address,
b3f4737d	128	report_id,
0145b505 HG	129	SENSOR_HUB_SYNC,
0145b505 HG	130	min < 0);
c5bdbef7	131	else {
c5bdbef7	132	*val = 0;
0964f706 SP	133	hid_sensor_power_state(&gyro_state->common_attributes,
0964f706 SP	134	false);
c5bdbef7	135	return -EINVAL;
c5bdbef7	136	}
0964f706	137	hid_sensor_power_state(&gyro_state->common_attributes, false);
c5bdbef7	138	ret_type = IIO_VAL_INT;
	139	break;
	140	case IIO_CHAN_INFO_SCALE:
6c7db77e SP	141	*val = gyro_state->scale_pre_decml;
	142	*val2 = gyro_state->scale_post_decml;
	143	ret_type = gyro_state->scale_precision;
c5bdbef7	144	break;
c5bdbef7	145	case IIO_CHAN_INFO_OFFSET:
6c7db77e	146	*val = gyro_state->value_offset;
c5bdbef7	147	ret_type = IIO_VAL_INT;
	148	break;
	149	case IIO_CHAN_INFO_SAMP_FREQ:
27793803	150	ret_type = hid_sensor_read_samp_freq_value(
c5bdbef7	151	&gyro_state->common_attributes, val, val2);
c5bdbef7	152	break;
c5bdbef7	153	case IIO_CHAN_INFO_HYSTERESIS:
27793803	154	ret_type = hid_sensor_read_raw_hyst_value(
c5bdbef7	155	&gyro_state->common_attributes, val, val2);
c5bdbef7	156	break;
	157	default:
	158	ret_type = -EINVAL;
	159	break;
	160	}
	161
	162	return ret_type;
	163	}
	164
	165	/* Channel write_raw handler */
	166	static int gyro_3d_write_raw(struct iio_dev *indio_dev,
	167	struct iio_chan_spec const *chan,
	168	int val,
	169	int val2,
	170	long mask)
	171	{
	172	struct gyro_3d_state *gyro_state = iio_priv(indio_dev);
	173	int ret = 0;
	174
	175	switch (mask) {
	176	case IIO_CHAN_INFO_SAMP_FREQ:
	177	ret = hid_sensor_write_samp_freq_value(
	178	&gyro_state->common_attributes, val, val2);
	179	break;
	180	case IIO_CHAN_INFO_HYSTERESIS:
	181	ret = hid_sensor_write_raw_hyst_value(
	182	&gyro_state->common_attributes, val, val2);
	183	break;
	184	default:
	185	ret = -EINVAL;
	186	}
	187
	188	return ret;
	189	}
	190
c5bdbef7	191	static const struct iio_info gyro_3d_info = {
c5bdbef7	192	.read_raw = &gyro_3d_read_raw,
c5bdbef7	193	.write_raw = &gyro_3d_write_raw,
c5bdbef7	194	};
	195
	196	/* Function to push data to buffer */
8c60c7e7 LPC	197	static void hid_sensor_push_data(struct iio_dev indio_dev, const void data,
8c60c7e7 LPC	198	int len)
c5bdbef7	199	{
c5bdbef7	200	dev_dbg(&indio_dev->dev, "hid_sensor_push_data\n");
8c60c7e7	201	iio_push_to_buffers(indio_dev, data);
c5bdbef7	202	}
	203
	204	/* Callback handler to send event after all samples are received and captured */
	205	static int gyro_3d_proc_event(struct hid_sensor_hub_device *hsdev,
	206	unsigned usage_id,
	207	void *priv)
	208	{
	209	struct iio_dev *indio_dev = platform_get_drvdata(priv);
	210	struct gyro_3d_state *gyro_state = iio_priv(indio_dev);
	211
56ff6be6 SP	212	dev_dbg(&indio_dev->dev, "gyro_3d_proc_event\n");
56ff6be6 SP	213	if (atomic_read(&gyro_state->common_attributes.data_ready))
c5bdbef7	214	hid_sensor_push_data(indio_dev,
8c60c7e7	215	gyro_state->gyro_val,
c5bdbef7	216	sizeof(gyro_state->gyro_val));
	217
	218	return 0;
	219	}
	220
	221	/* Capture samples in local storage */
	222	static int gyro_3d_capture_sample(struct hid_sensor_hub_device *hsdev,
	223	unsigned usage_id,
	224	size_t raw_len, char *raw_data,
	225	void *priv)
	226	{
	227	struct iio_dev *indio_dev = platform_get_drvdata(priv);
	228	struct gyro_3d_state *gyro_state = iio_priv(indio_dev);
	229	int offset;
	230	int ret = -EINVAL;
	231
	232	switch (usage_id) {
	233	case HID_USAGE_SENSOR_ANGL_VELOCITY_X_AXIS:
	234	case HID_USAGE_SENSOR_ANGL_VELOCITY_Y_AXIS:
	235	case HID_USAGE_SENSOR_ANGL_VELOCITY_Z_AXIS:
	236	offset = usage_id - HID_USAGE_SENSOR_ANGL_VELOCITY_X_AXIS;
	237	gyro_state->gyro_val[CHANNEL_SCAN_INDEX_X + offset] =
	238	(u32 )raw_data;
	239	ret = 0;
	240	break;
	241	default:
	242	break;
	243	}
	244
	245	return ret;
	246	}
	247
	248	/* Parse report which is specific to an usage id*/
	249	static int gyro_3d_parse_report(struct platform_device *pdev,
	250	struct hid_sensor_hub_device *hsdev,
	251	struct iio_chan_spec *channels,
	252	unsigned usage_id,
	253	struct gyro_3d_state *st)
	254	{
	255	int ret;
	256	int i;
	257
	258	for (i = 0; i <= CHANNEL_SCAN_INDEX_Z; ++i) {
	259	ret = sensor_hub_input_get_attribute_info(hsdev,
	260	HID_INPUT_REPORT,
	261	usage_id,
	262	HID_USAGE_SENSOR_ANGL_VELOCITY_X_AXIS + i,
	263	&st->gyro[CHANNEL_SCAN_INDEX_X + i]);
	264	if (ret < 0)
	265	break;
	266	gyro_3d_adjust_channel_bit_mask(channels,
	267	CHANNEL_SCAN_INDEX_X + i,
	268	st->gyro[CHANNEL_SCAN_INDEX_X + i].size);
	269	}
	270	dev_dbg(&pdev->dev, "gyro_3d %x:%x, %x:%x, %x:%x\n",
	271	st->gyro[0].index,
	272	st->gyro[0].report_id,
	273	st->gyro[1].index, st->gyro[1].report_id,
	274	st->gyro[2].index, st->gyro[2].report_id);
	275
6c7db77e SP	276	st->scale_precision = hid_sensor_format_scale(
	277	HID_USAGE_SENSOR_GYRO_3D,
	278	&st->gyro[CHANNEL_SCAN_INDEX_X],
	279	&st->scale_pre_decml, &st->scale_post_decml);
	280
2371aebf SP	281	/* Set Sensitivity field ids, when there is no individual modifier */
	282	if (st->common_attributes.sensitivity.index < 0) {
	283	sensor_hub_input_get_attribute_info(hsdev,
	284	HID_FEATURE_REPORT, usage_id,
	285	HID_USAGE_SENSOR_DATA_MOD_CHANGE_SENSITIVITY_ABS \|
	286	HID_USAGE_SENSOR_DATA_ANGL_VELOCITY,
	287	&st->common_attributes.sensitivity);
	288	dev_dbg(&pdev->dev, "Sensitivity index:report %d:%d\n",
	289	st->common_attributes.sensitivity.index,
	290	st->common_attributes.sensitivity.report_id);
	291	}
c5bdbef7	292	return ret;
	293	}
	294
	295	/* Function to initialize the processing for usage id */
fc52692c	296	static int hid_gyro_3d_probe(struct platform_device *pdev)
c5bdbef7	297	{
	298	int ret = 0;
	299	static const char *name = "gyro_3d";
	300	struct iio_dev *indio_dev;
	301	struct gyro_3d_state *gyro_state;
	302	struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
c5bdbef7	303
1ba15cf2 SK	304	indio_dev = devm_iio_device_alloc(&pdev->dev, sizeof(*gyro_state));
	305	if (!indio_dev)
	306	return -ENOMEM;
c5bdbef7	307	platform_set_drvdata(pdev, indio_dev);
	308
	309	gyro_state = iio_priv(indio_dev);
	310	gyro_state->common_attributes.hsdev = hsdev;
	311	gyro_state->common_attributes.pdev = pdev;
	312
	313	ret = hid_sensor_parse_common_attributes(hsdev,
	314	HID_USAGE_SENSOR_GYRO_3D,
	315	&gyro_state->common_attributes);
	316	if (ret) {
	317	dev_err(&pdev->dev, "failed to setup common attributes\n");
1ba15cf2	318	return ret;
c5bdbef7	319	}
c5bdbef7	320
d8c9d23e FE	321	indio_dev->channels = kmemdup(gyro_3d_channels,
	322	sizeof(gyro_3d_channels), GFP_KERNEL);
	323	if (!indio_dev->channels) {
c5bdbef7	324	dev_err(&pdev->dev, "failed to duplicate channels\n");
1ba15cf2	325	return -ENOMEM;
c5bdbef7	326	}
c5bdbef7	327
d8c9d23e FE	328	ret = gyro_3d_parse_report(pdev, hsdev,
	329	(struct iio_chan_spec *)indio_dev->channels,
	330	HID_USAGE_SENSOR_GYRO_3D, gyro_state);
c5bdbef7	331	if (ret) {
	332	dev_err(&pdev->dev, "failed to setup attributes\n");
	333	goto error_free_dev_mem;
	334	}
	335
c5bdbef7	336	indio_dev->num_channels = ARRAY_SIZE(gyro_3d_channels);
	337	indio_dev->dev.parent = &pdev->dev;
	338	indio_dev->info = &gyro_3d_info;
	339	indio_dev->name = name;
	340	indio_dev->modes = INDIO_DIRECT_MODE;
	341
	342	ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time,
	343	NULL, NULL);
	344	if (ret) {
	345	dev_err(&pdev->dev, "failed to initialize trigger buffer\n");
	346	goto error_free_dev_mem;
	347	}
56ff6be6	348	atomic_set(&gyro_state->common_attributes.data_ready, 0);
c5bdbef7	349	ret = hid_sensor_setup_trigger(indio_dev, name,
	350	&gyro_state->common_attributes);
	351	if (ret < 0) {
	352	dev_err(&pdev->dev, "trigger setup failed\n");
	353	goto error_unreg_buffer_funcs;
	354	}
	355
	356	ret = iio_device_register(indio_dev);
	357	if (ret) {
	358	dev_err(&pdev->dev, "device register failed\n");
	359	goto error_remove_trigger;
	360	}
	361
	362	gyro_state->callbacks.send_event = gyro_3d_proc_event;
	363	gyro_state->callbacks.capture_sample = gyro_3d_capture_sample;
	364	gyro_state->callbacks.pdev = pdev;
	365	ret = sensor_hub_register_callback(hsdev, HID_USAGE_SENSOR_GYRO_3D,
	366	&gyro_state->callbacks);
	367	if (ret < 0) {
	368	dev_err(&pdev->dev, "callback reg failed\n");
	369	goto error_iio_unreg;
	370	}
	371
	372	return ret;
	373
	374	error_iio_unreg:
	375	iio_device_unregister(indio_dev);
	376	error_remove_trigger:
ec7f68e0	377	hid_sensor_remove_trigger(&gyro_state->common_attributes);
c5bdbef7	378	error_unreg_buffer_funcs:
	379	iio_triggered_buffer_cleanup(indio_dev);
	380	error_free_dev_mem:
	381	kfree(indio_dev->channels);
c5bdbef7	382	return ret;
	383	}
	384
	385	/* Function to deinitialize the processing for usage id */
fc52692c	386	static int hid_gyro_3d_remove(struct platform_device *pdev)
c5bdbef7	387	{
	388	struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
	389	struct iio_dev *indio_dev = platform_get_drvdata(pdev);
ec7f68e0	390	struct gyro_3d_state *gyro_state = iio_priv(indio_dev);
c5bdbef7	391
	392	sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_GYRO_3D);
	393	iio_device_unregister(indio_dev);
ec7f68e0	394	hid_sensor_remove_trigger(&gyro_state->common_attributes);
c5bdbef7	395	iio_triggered_buffer_cleanup(indio_dev);
c5bdbef7	396	kfree(indio_dev->channels);
c5bdbef7	397
	398	return 0;
	399	}
	400
322a3b1e	401	static const struct platform_device_id hid_gyro_3d_ids[] = {
a411e735 AH	402	{
	403	/* Format: HID-SENSOR-usage_id_in_hex_lowercase */
	404	.name = "HID-SENSOR-200076",
	405	},
	406	{ /* sentinel */ }
	407	};
	408	MODULE_DEVICE_TABLE(platform, hid_gyro_3d_ids);
	409
c5bdbef7	410	static struct platform_driver hid_gyro_3d_platform_driver = {
a411e735	411	.id_table = hid_gyro_3d_ids,
c5bdbef7	412	.driver = {
a411e735	413	.name = KBUILD_MODNAME,
27ce4239	414	.pm = &hid_sensor_pm_ops,
c5bdbef7	415	},
	416	.probe = hid_gyro_3d_probe,
	417	.remove = hid_gyro_3d_remove,
	418	};
	419	module_platform_driver(hid_gyro_3d_platform_driver);
	420
	421	MODULE_DESCRIPTION("HID Sensor Gyroscope 3D");
	422	MODULE_AUTHOR("Srinivas Pandruvada <[email protected]>");
	423	MODULE_LICENSE("GPL");