[mirror_ubuntu-bionic-kernel.git] / drivers / iio / accel / hid-sensor-accel-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 accel_3d_channel {
	CHANNEL_SCAN_INDEX_X,
	CHANNEL_SCAN_INDEX_Y,
	CHANNEL_SCAN_INDEX_Z,
	ACCEL_3D_CHANNEL_MAX,
};

struct accel_3d_state {
	struct hid_sensor_hub_callbacks callbacks;
	struct hid_sensor_common common_attributes;
	struct hid_sensor_hub_attribute_info accel[ACCEL_3D_CHANNEL_MAX];
	/* Reserve for 3 channels + padding + timestamp */
	u32 accel_val[ACCEL_3D_CHANNEL_MAX + 3];
	int scale_pre_decml;
	int scale_post_decml;
	int scale_precision;
	int value_offset;
	int64_t timestamp;
};

static const u32 accel_3d_addresses[ACCEL_3D_CHANNEL_MAX] = {
	HID_USAGE_SENSOR_ACCEL_X_AXIS,
	HID_USAGE_SENSOR_ACCEL_Y_AXIS,
	HID_USAGE_SENSOR_ACCEL_Z_AXIS
};

/* Channel definitions */
static const struct iio_chan_spec accel_3d_channels[] = {
	{
		.type = IIO_ACCEL,
		.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_ACCEL,
		.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_ACCEL,
		.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,
	},
	IIO_CHAN_SOFT_TIMESTAMP(3)
};

/* Channel definitions */
static const struct iio_chan_spec gravity_channels[] = {
	{
		.type = IIO_GRAVITY,
		.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_GRAVITY,
		.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_GRAVITY,
		.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 accel_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 accel_3d_read_raw(struct iio_dev *indio_dev,
			      struct iio_chan_spec const *chan,
			      int *val, int *val2,
			      long mask)
{
	struct accel_3d_state *accel_state = iio_priv(indio_dev);
	int report_id = -1;
	u32 address;
	int ret_type;
	struct hid_sensor_hub_device *hsdev =
					accel_state->common_attributes.hsdev;

	*val = 0;
	*val2 = 0;
	switch (mask) {
	case 0:
		hid_sensor_power_state(&accel_state->common_attributes, true);
		report_id = accel_state->accel[chan->scan_index].report_id;
		address = accel_3d_addresses[chan->scan_index];
		if (report_id >= 0)
			*val = sensor_hub_input_attr_get_raw_value(
					accel_state->common_attributes.hsdev,
					hsdev->usage, address, report_id,
					SENSOR_HUB_SYNC);
		else {
			*val = 0;
			hid_sensor_power_state(&accel_state->common_attributes,
						 false);
			return -EINVAL;
		}
		hid_sensor_power_state(&accel_state->common_attributes, false);
		ret_type = IIO_VAL_INT;
		break;
	case IIO_CHAN_INFO_SCALE:
		*val = accel_state->scale_pre_decml;
		*val2 = accel_state->scale_post_decml;
		ret_type = accel_state->scale_precision;
		break;
	case IIO_CHAN_INFO_OFFSET:
		*val = accel_state->value_offset;
		ret_type = IIO_VAL_INT;
		break;
	case IIO_CHAN_INFO_SAMP_FREQ:
		ret_type = hid_sensor_read_samp_freq_value(
			&accel_state->common_attributes, val, val2);
		break;
	case IIO_CHAN_INFO_HYSTERESIS:
		ret_type = hid_sensor_read_raw_hyst_value(
			&accel_state->common_attributes, val, val2);
		break;
	default:
		ret_type = -EINVAL;
		break;
	}

	return ret_type;
}

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

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

	return ret;
}

static const struct iio_info accel_3d_info = {
	.read_raw = &accel_3d_read_raw,
	.write_raw = &accel_3d_write_raw,
};

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

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

	dev_dbg(&indio_dev->dev, "accel_3d_proc_event\n");
	if (atomic_read(&accel_state->common_attributes.data_ready)) {
		if (!accel_state->timestamp)
			accel_state->timestamp = iio_get_time_ns(indio_dev);

		hid_sensor_push_data(indio_dev,
				     accel_state->accel_val,
				     sizeof(accel_state->accel_val),
				     accel_state->timestamp);

		accel_state->timestamp = 0;
	}

	return 0;
}

/* Capture samples in local storage */
static int accel_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 accel_3d_state *accel_state = iio_priv(indio_dev);
	int offset;
	int ret = -EINVAL;

	switch (usage_id) {
	case HID_USAGE_SENSOR_ACCEL_X_AXIS:
	case HID_USAGE_SENSOR_ACCEL_Y_AXIS:
	case HID_USAGE_SENSOR_ACCEL_Z_AXIS:
		offset = usage_id - HID_USAGE_SENSOR_ACCEL_X_AXIS;
		accel_state->accel_val[CHANNEL_SCAN_INDEX_X + offset] =
						*(u32 *)raw_data;
		ret = 0;
	break;
	case HID_USAGE_SENSOR_TIME_TIMESTAMP:
		accel_state->timestamp =
			hid_sensor_convert_timestamp(
					&accel_state->common_attributes,
					*(int64_t *)raw_data);
	break;
	default:
		break;
	}

	return ret;
}

/* Parse report which is specific to an usage id*/
static int accel_3d_parse_report(struct platform_device *pdev,
				struct hid_sensor_hub_device *hsdev,
				struct iio_chan_spec *channels,
				unsigned usage_id,
				struct accel_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_ACCEL_X_AXIS + i,
				&st->accel[CHANNEL_SCAN_INDEX_X + i]);
		if (ret < 0)
			break;
		accel_3d_adjust_channel_bit_mask(channels,
				CHANNEL_SCAN_INDEX_X + i,
				st->accel[CHANNEL_SCAN_INDEX_X + i].size);
	}
	dev_dbg(&pdev->dev, "accel_3d %x:%x, %x:%x, %x:%x\n",
			st->accel[0].index,
			st->accel[0].report_id,
			st->accel[1].index, st->accel[1].report_id,
			st->accel[2].index, st->accel[2].report_id);

	st->scale_precision = hid_sensor_format_scale(
				hsdev->usage,
				&st->accel[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_ACCELERATION,
			&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_accel_3d_probe(struct platform_device *pdev)
{
	int ret = 0;
	const char *name;
	struct iio_dev *indio_dev;
	struct accel_3d_state *accel_state;
	const struct iio_chan_spec *channel_spec;
	int channel_size;

	struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;

	indio_dev = devm_iio_device_alloc(&pdev->dev,
					  sizeof(struct accel_3d_state));
	if (indio_dev == NULL)
		return -ENOMEM;

	platform_set_drvdata(pdev, indio_dev);

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

	if (hsdev->usage == HID_USAGE_SENSOR_ACCEL_3D) {
		name = "accel_3d";
		channel_spec = accel_3d_channels;
		channel_size = sizeof(accel_3d_channels);
		indio_dev->num_channels = ARRAY_SIZE(accel_3d_channels);
	} else {
		name = "gravity";
		channel_spec = gravity_channels;
		channel_size = sizeof(gravity_channels);
		indio_dev->num_channels = ARRAY_SIZE(gravity_channels);
	}
	ret = hid_sensor_parse_common_attributes(hsdev, hsdev->usage,
					&accel_state->common_attributes);
	if (ret) {
		dev_err(&pdev->dev, "failed to setup common attributes\n");
		return ret;
	}
	indio_dev->channels = kmemdup(channel_spec, channel_size, GFP_KERNEL);

	if (!indio_dev->channels) {
		dev_err(&pdev->dev, "failed to duplicate channels\n");
		return -ENOMEM;
	}
	ret = accel_3d_parse_report(pdev, hsdev,
				(struct iio_chan_spec *)indio_dev->channels,
				hsdev->usage, accel_state);
	if (ret) {
		dev_err(&pdev->dev, "failed to setup attributes\n");
		goto error_free_dev_mem;
	}

	indio_dev->dev.parent = &pdev->dev;
	indio_dev->info = &accel_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(&accel_state->common_attributes.data_ready, 0);
	ret = hid_sensor_setup_trigger(indio_dev, name,
					&accel_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;
	}

	accel_state->callbacks.send_event = accel_3d_proc_event;
	accel_state->callbacks.capture_sample = accel_3d_capture_sample;
	accel_state->callbacks.pdev = pdev;
	ret = sensor_hub_register_callback(hsdev, hsdev->usage,
					&accel_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(&accel_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_accel_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 accel_3d_state *accel_state = iio_priv(indio_dev);

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

	return 0;
}

static const struct platform_device_id hid_accel_3d_ids[] = {
	{
		/* Format: HID-SENSOR-usage_id_in_hex_lowercase */
		.name = "HID-SENSOR-200073",
	},
	{	/* gravity sensor */
		.name = "HID-SENSOR-20007b",
	},
	{ /* sentinel */ }
};
MODULE_DEVICE_TABLE(platform, hid_accel_3d_ids);

static struct platform_driver hid_accel_3d_platform_driver = {
	.id_table = hid_accel_3d_ids,
	.driver = {
		.name	= KBUILD_MODNAME,
		.pm	= &hid_sensor_pm_ops,
	},
	.probe		= hid_accel_3d_probe,
	.remove		= hid_accel_3d_remove,
};
module_platform_driver(hid_accel_3d_platform_driver);

MODULE_DESCRIPTION("HID Sensor Accel 3D");
MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
MODULE_LICENSE("GPL");
Commit	Line	Data
45fe6f7d	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>
c6399453	25	#include <linux/delay.h>
45fe6f7d	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>
45fe6f7d	32	#include "../common/hid-sensors/hid-sensor-trigger.h"
45fe6f7d	33
45fe6f7d	34	enum accel_3d_channel {
	35	CHANNEL_SCAN_INDEX_X,
	36	CHANNEL_SCAN_INDEX_Y,
	37	CHANNEL_SCAN_INDEX_Z,
	38	ACCEL_3D_CHANNEL_MAX,
	39	};
	40
	41	struct accel_3d_state {
	42	struct hid_sensor_hub_callbacks callbacks;
e07c6d17	43	struct hid_sensor_common common_attributes;
45fe6f7d	44	struct hid_sensor_hub_attribute_info accel[ACCEL_3D_CHANNEL_MAX];
a96cd0f9 SP	45	/* Reserve for 3 channels + padding + timestamp */
a96cd0f9 SP	46	u32 accel_val[ACCEL_3D_CHANNEL_MAX + 3];
73a24988 SP	47	int scale_pre_decml;
	48	int scale_post_decml;
	49	int scale_precision;
	50	int value_offset;
a96cd0f9	51	int64_t timestamp;
45fe6f7d	52	};
	53
	54	static const u32 accel_3d_addresses[ACCEL_3D_CHANNEL_MAX] = {
	55	HID_USAGE_SENSOR_ACCEL_X_AXIS,
	56	HID_USAGE_SENSOR_ACCEL_Y_AXIS,
	57	HID_USAGE_SENSOR_ACCEL_Z_AXIS
	58	};
	59
	60	/* Channel definitions */
	61	static const struct iio_chan_spec accel_3d_channels[] = {
	62	{
	63	.type = IIO_ACCEL,
	64	.modified = 1,
	65	.channel2 = IIO_MOD_X,
c6399453	66	.info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
ecbe18f2 JC	67	.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) \|
	68	BIT(IIO_CHAN_INFO_SCALE) \|
	69	BIT(IIO_CHAN_INFO_SAMP_FREQ) \|
	70	BIT(IIO_CHAN_INFO_HYSTERESIS),
45fe6f7d	71	.scan_index = CHANNEL_SCAN_INDEX_X,
	72	}, {
	73	.type = IIO_ACCEL,
	74	.modified = 1,
	75	.channel2 = IIO_MOD_Y,
c6399453	76	.info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
ecbe18f2 JC	77	.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) \|
	78	BIT(IIO_CHAN_INFO_SCALE) \|
	79	BIT(IIO_CHAN_INFO_SAMP_FREQ) \|
	80	BIT(IIO_CHAN_INFO_HYSTERESIS),
45fe6f7d	81	.scan_index = CHANNEL_SCAN_INDEX_Y,
	82	}, {
	83	.type = IIO_ACCEL,
	84	.modified = 1,
	85	.channel2 = IIO_MOD_Z,
c6399453	86	.info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
ecbe18f2 JC	87	.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) \|
	88	BIT(IIO_CHAN_INFO_SCALE) \|
	89	BIT(IIO_CHAN_INFO_SAMP_FREQ) \|
	90	BIT(IIO_CHAN_INFO_HYSTERESIS),
45fe6f7d	91	.scan_index = CHANNEL_SCAN_INDEX_Z,
a96cd0f9 SP	92	},
a96cd0f9 SP	93	IIO_CHAN_SOFT_TIMESTAMP(3)
45fe6f7d	94	};
45fe6f7d	95
0e377f3b SH	96	/* Channel definitions */
	97	static const struct iio_chan_spec gravity_channels[] = {
	98	{
	99	.type = IIO_GRAVITY,
	100	.modified = 1,
	101	.channel2 = IIO_MOD_X,
	102	.info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
	103	.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) \|
	104	BIT(IIO_CHAN_INFO_SCALE) \|
	105	BIT(IIO_CHAN_INFO_SAMP_FREQ) \|
	106	BIT(IIO_CHAN_INFO_HYSTERESIS),
	107	.scan_index = CHANNEL_SCAN_INDEX_X,
	108	}, {
	109	.type = IIO_GRAVITY,
	110	.modified = 1,
	111	.channel2 = IIO_MOD_Y,
	112	.info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
	113	.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) \|
	114	BIT(IIO_CHAN_INFO_SCALE) \|
	115	BIT(IIO_CHAN_INFO_SAMP_FREQ) \|
	116	BIT(IIO_CHAN_INFO_HYSTERESIS),
	117	.scan_index = CHANNEL_SCAN_INDEX_Y,
	118	}, {
	119	.type = IIO_GRAVITY,
	120	.modified = 1,
	121	.channel2 = IIO_MOD_Z,
	122	.info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
	123	.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) \|
	124	BIT(IIO_CHAN_INFO_SCALE) \|
	125	BIT(IIO_CHAN_INFO_SAMP_FREQ) \|
	126	BIT(IIO_CHAN_INFO_HYSTERESIS),
	127	.scan_index = CHANNEL_SCAN_INDEX_Z,
	128	}
	129	};
	130
45fe6f7d	131	/* Adjust channel real bits based on report descriptor */
	132	static void accel_3d_adjust_channel_bit_mask(struct iio_chan_spec *channels,
	133	int channel, int size)
	134	{
	135	channels[channel].scan_type.sign = 's';
	136	/* Real storage bits will change based on the report desc. */
	137	channels[channel].scan_type.realbits = size * 8;
	138	/* Maximum size of a sample to capture is u32 */
	139	channels[channel].scan_type.storagebits = sizeof(u32) * 8;
	140	}
	141
	142	/* Channel read_raw handler */
	143	static int accel_3d_read_raw(struct iio_dev *indio_dev,
	144	struct iio_chan_spec const *chan,
	145	int val, int val2,
	146	long mask)
	147	{
	148	struct accel_3d_state *accel_state = iio_priv(indio_dev);
	149	int report_id = -1;
	150	u32 address;
45fe6f7d	151	int ret_type;
0e377f3b SH	152	struct hid_sensor_hub_device *hsdev =
0e377f3b SH	153	accel_state->common_attributes.hsdev;
45fe6f7d	154
	155	*val = 0;
	156	*val2 = 0;
	157	switch (mask) {
	158	case 0:
c6399453	159	hid_sensor_power_state(&accel_state->common_attributes, true);
45fe6f7d	160	report_id = accel_state->accel[chan->scan_index].report_id;
	161	address = accel_3d_addresses[chan->scan_index];
	162	if (report_id >= 0)
	163	*val = sensor_hub_input_attr_get_raw_value(
c6399453	164	accel_state->common_attributes.hsdev,
0e377f3b	165	hsdev->usage, address, report_id,
b3f4737d	166	SENSOR_HUB_SYNC);
45fe6f7d	167	else {
45fe6f7d	168	*val = 0;
c6399453 SP	169	hid_sensor_power_state(&accel_state->common_attributes,
c6399453 SP	170	false);
45fe6f7d	171	return -EINVAL;
45fe6f7d	172	}
c6399453	173	hid_sensor_power_state(&accel_state->common_attributes, false);
45fe6f7d	174	ret_type = IIO_VAL_INT;
	175	break;
	176	case IIO_CHAN_INFO_SCALE:
73a24988 SP	177	*val = accel_state->scale_pre_decml;
	178	*val2 = accel_state->scale_post_decml;
	179	ret_type = accel_state->scale_precision;
45fe6f7d	180	break;
45fe6f7d	181	case IIO_CHAN_INFO_OFFSET:
73a24988	182	*val = accel_state->value_offset;
45fe6f7d	183	ret_type = IIO_VAL_INT;
	184	break;
	185	case IIO_CHAN_INFO_SAMP_FREQ:
2f084c17	186	ret_type = hid_sensor_read_samp_freq_value(
45fe6f7d	187	&accel_state->common_attributes, val, val2);
45fe6f7d	188	break;
45fe6f7d	189	case IIO_CHAN_INFO_HYSTERESIS:
2f084c17	190	ret_type = hid_sensor_read_raw_hyst_value(
45fe6f7d	191	&accel_state->common_attributes, val, val2);
45fe6f7d	192	break;
	193	default:
	194	ret_type = -EINVAL;
	195	break;
	196	}
	197
	198	return ret_type;
	199	}
	200
	201	/* Channel write_raw handler */
	202	static int accel_3d_write_raw(struct iio_dev *indio_dev,
	203	struct iio_chan_spec const *chan,
	204	int val,
	205	int val2,
	206	long mask)
	207	{
	208	struct accel_3d_state *accel_state = iio_priv(indio_dev);
	209	int ret = 0;
	210
	211	switch (mask) {
	212	case IIO_CHAN_INFO_SAMP_FREQ:
	213	ret = hid_sensor_write_samp_freq_value(
	214	&accel_state->common_attributes, val, val2);
	215	break;
	216	case IIO_CHAN_INFO_HYSTERESIS:
	217	ret = hid_sensor_write_raw_hyst_value(
	218	&accel_state->common_attributes, val, val2);
	219	break;
	220	default:
	221	ret = -EINVAL;
	222	}
	223
	224	return ret;
	225	}
	226
45fe6f7d	227	static const struct iio_info accel_3d_info = {
45fe6f7d	228	.read_raw = &accel_3d_read_raw,
45fe6f7d	229	.write_raw = &accel_3d_write_raw,
45fe6f7d	230	};
	231
	232	/* Function to push data to buffer */
a96cd0f9 SP	233	static void hid_sensor_push_data(struct iio_dev indio_dev, void data,
a96cd0f9 SP	234	int len, int64_t timestamp)
45fe6f7d	235	{
45fe6f7d	236	dev_dbg(&indio_dev->dev, "hid_sensor_push_data\n");
a96cd0f9	237	iio_push_to_buffers_with_timestamp(indio_dev, data, timestamp);
45fe6f7d	238	}
	239
	240	/* Callback handler to send event after all samples are received and captured */
	241	static int accel_3d_proc_event(struct hid_sensor_hub_device *hsdev,
	242	unsigned usage_id,
	243	void *priv)
	244	{
	245	struct iio_dev *indio_dev = platform_get_drvdata(priv);
	246	struct accel_3d_state *accel_state = iio_priv(indio_dev);
	247
56ff6be6	248	dev_dbg(&indio_dev->dev, "accel_3d_proc_event\n");
a96cd0f9 SP	249	if (atomic_read(&accel_state->common_attributes.data_ready)) {
	250	if (!accel_state->timestamp)
	251	accel_state->timestamp = iio_get_time_ns(indio_dev);
	252
45fe6f7d	253	hid_sensor_push_data(indio_dev,
a96cd0f9 SP	254	accel_state->accel_val,
	255	sizeof(accel_state->accel_val),
	256	accel_state->timestamp);
	257
	258	accel_state->timestamp = 0;
	259	}
45fe6f7d	260
	261	return 0;
	262	}
	263
	264	/* Capture samples in local storage */
	265	static int accel_3d_capture_sample(struct hid_sensor_hub_device *hsdev,
	266	unsigned usage_id,
	267	size_t raw_len, char *raw_data,
	268	void *priv)
	269	{
	270	struct iio_dev *indio_dev = platform_get_drvdata(priv);
	271	struct accel_3d_state *accel_state = iio_priv(indio_dev);
	272	int offset;
	273	int ret = -EINVAL;
	274
	275	switch (usage_id) {
	276	case HID_USAGE_SENSOR_ACCEL_X_AXIS:
	277	case HID_USAGE_SENSOR_ACCEL_Y_AXIS:
	278	case HID_USAGE_SENSOR_ACCEL_Z_AXIS:
	279	offset = usage_id - HID_USAGE_SENSOR_ACCEL_X_AXIS;
	280	accel_state->accel_val[CHANNEL_SCAN_INDEX_X + offset] =
	281	(u32 )raw_data;
	282	ret = 0;
	283	break;
a96cd0f9 SP	284	case HID_USAGE_SENSOR_TIME_TIMESTAMP:
	285	accel_state->timestamp =
	286	hid_sensor_convert_timestamp(
	287	&accel_state->common_attributes,
	288	(int64_t )raw_data);
	289	break;
45fe6f7d	290	default:
	291	break;
	292	}
	293
	294	return ret;
	295	}
	296
	297	/* Parse report which is specific to an usage id*/
	298	static int accel_3d_parse_report(struct platform_device *pdev,
	299	struct hid_sensor_hub_device *hsdev,
	300	struct iio_chan_spec *channels,
	301	unsigned usage_id,
	302	struct accel_3d_state *st)
	303	{
	304	int ret;
	305	int i;
	306
	307	for (i = 0; i <= CHANNEL_SCAN_INDEX_Z; ++i) {
	308	ret = sensor_hub_input_get_attribute_info(hsdev,
	309	HID_INPUT_REPORT,
	310	usage_id,
	311	HID_USAGE_SENSOR_ACCEL_X_AXIS + i,
	312	&st->accel[CHANNEL_SCAN_INDEX_X + i]);
	313	if (ret < 0)
	314	break;
	315	accel_3d_adjust_channel_bit_mask(channels,
	316	CHANNEL_SCAN_INDEX_X + i,
	317	st->accel[CHANNEL_SCAN_INDEX_X + i].size);
	318	}
	319	dev_dbg(&pdev->dev, "accel_3d %x:%x, %x:%x, %x:%x\n",
	320	st->accel[0].index,
	321	st->accel[0].report_id,
	322	st->accel[1].index, st->accel[1].report_id,
	323	st->accel[2].index, st->accel[2].report_id);
	324
73a24988	325	st->scale_precision = hid_sensor_format_scale(
0e377f3b	326	hsdev->usage,
73a24988 SP	327	&st->accel[CHANNEL_SCAN_INDEX_X],
	328	&st->scale_pre_decml, &st->scale_post_decml);
	329
64528d03 SP	330	/* Set Sensitivity field ids, when there is no individual modifier */
	331	if (st->common_attributes.sensitivity.index < 0) {
	332	sensor_hub_input_get_attribute_info(hsdev,
	333	HID_FEATURE_REPORT, usage_id,
	334	HID_USAGE_SENSOR_DATA_MOD_CHANGE_SENSITIVITY_ABS \|
	335	HID_USAGE_SENSOR_DATA_ACCELERATION,
	336	&st->common_attributes.sensitivity);
	337	dev_dbg(&pdev->dev, "Sensitivity index:report %d:%d\n",
	338	st->common_attributes.sensitivity.index,
	339	st->common_attributes.sensitivity.report_id);
	340	}
	341
45fe6f7d	342	return ret;
	343	}
	344
	345	/* Function to initialize the processing for usage id */
fc52692c	346	static int hid_accel_3d_probe(struct platform_device *pdev)
45fe6f7d	347	{
45fe6f7d	348	int ret = 0;
40f4b1f0	349	const char *name;
45fe6f7d	350	struct iio_dev *indio_dev;
45fe6f7d	351	struct accel_3d_state *accel_state;
0e377f3b SH	352	const struct iio_chan_spec *channel_spec;
	353	int channel_size;
	354
45fe6f7d	355	struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
45fe6f7d	356
6b545eed SK	357	indio_dev = devm_iio_device_alloc(&pdev->dev,
	358	sizeof(struct accel_3d_state));
	359	if (indio_dev == NULL)
	360	return -ENOMEM;
	361
45fe6f7d	362	platform_set_drvdata(pdev, indio_dev);
	363
	364	accel_state = iio_priv(indio_dev);
	365	accel_state->common_attributes.hsdev = hsdev;
	366	accel_state->common_attributes.pdev = pdev;
	367
0e377f3b SH	368	if (hsdev->usage == HID_USAGE_SENSOR_ACCEL_3D) {
	369	name = "accel_3d";
	370	channel_spec = accel_3d_channels;
	371	channel_size = sizeof(accel_3d_channels);
862d1d89	372	indio_dev->num_channels = ARRAY_SIZE(accel_3d_channels);
0e377f3b SH	373	} else {
	374	name = "gravity";
	375	channel_spec = gravity_channels;
	376	channel_size = sizeof(gravity_channels);
862d1d89	377	indio_dev->num_channels = ARRAY_SIZE(gravity_channels);
0e377f3b SH	378	}
0e377f3b SH	379	ret = hid_sensor_parse_common_attributes(hsdev, hsdev->usage,
45fe6f7d	380	&accel_state->common_attributes);
	381	if (ret) {
	382	dev_err(&pdev->dev, "failed to setup common attributes\n");
6b545eed	383	return ret;
45fe6f7d	384	}
0e377f3b	385	indio_dev->channels = kmemdup(channel_spec, channel_size, GFP_KERNEL);
45fe6f7d	386
b136faff	387	if (!indio_dev->channels) {
45fe6f7d	388	dev_err(&pdev->dev, "failed to duplicate channels\n");
6b545eed	389	return -ENOMEM;
45fe6f7d	390	}
b136faff	391	ret = accel_3d_parse_report(pdev, hsdev,
0e377f3b SH	392	(struct iio_chan_spec *)indio_dev->channels,
0e377f3b SH	393	hsdev->usage, accel_state);
45fe6f7d	394	if (ret) {
	395	dev_err(&pdev->dev, "failed to setup attributes\n");
	396	goto error_free_dev_mem;
	397	}
	398
45fe6f7d	399	indio_dev->dev.parent = &pdev->dev;
	400	indio_dev->info = &accel_3d_info;
	401	indio_dev->name = name;
	402	indio_dev->modes = INDIO_DIRECT_MODE;
	403
	404	ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time,
	405	NULL, NULL);
	406	if (ret) {
	407	dev_err(&pdev->dev, "failed to initialize trigger buffer\n");
	408	goto error_free_dev_mem;
	409	}
56ff6be6	410	atomic_set(&accel_state->common_attributes.data_ready, 0);
45fe6f7d	411	ret = hid_sensor_setup_trigger(indio_dev, name,
	412	&accel_state->common_attributes);
	413	if (ret < 0) {
	414	dev_err(&pdev->dev, "trigger setup failed\n");
	415	goto error_unreg_buffer_funcs;
	416	}
	417
	418	ret = iio_device_register(indio_dev);
	419	if (ret) {
	420	dev_err(&pdev->dev, "device register failed\n");
	421	goto error_remove_trigger;
	422	}
	423
	424	accel_state->callbacks.send_event = accel_3d_proc_event;
	425	accel_state->callbacks.capture_sample = accel_3d_capture_sample;
	426	accel_state->callbacks.pdev = pdev;
0e377f3b	427	ret = sensor_hub_register_callback(hsdev, hsdev->usage,
45fe6f7d	428	&accel_state->callbacks);
	429	if (ret < 0) {
	430	dev_err(&pdev->dev, "callback reg failed\n");
	431	goto error_iio_unreg;
	432	}
	433
	434	return ret;
	435
	436	error_iio_unreg:
	437	iio_device_unregister(indio_dev);
	438	error_remove_trigger:
ec7f68e0	439	hid_sensor_remove_trigger(&accel_state->common_attributes);
45fe6f7d	440	error_unreg_buffer_funcs:
	441	iio_triggered_buffer_cleanup(indio_dev);
	442	error_free_dev_mem:
	443	kfree(indio_dev->channels);
45fe6f7d	444	return ret;
	445	}
	446
	447	/* Function to deinitialize the processing for usage id */
fc52692c	448	static int hid_accel_3d_remove(struct platform_device *pdev)
45fe6f7d	449	{
	450	struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
	451	struct iio_dev *indio_dev = platform_get_drvdata(pdev);
ec7f68e0	452	struct accel_3d_state *accel_state = iio_priv(indio_dev);
45fe6f7d	453
0e377f3b	454	sensor_hub_remove_callback(hsdev, hsdev->usage);
45fe6f7d	455	iio_device_unregister(indio_dev);
ec7f68e0	456	hid_sensor_remove_trigger(&accel_state->common_attributes);
45fe6f7d	457	iio_triggered_buffer_cleanup(indio_dev);
45fe6f7d	458	kfree(indio_dev->channels);
45fe6f7d	459
	460	return 0;
	461	}
	462
76ec50a1	463	static const struct platform_device_id hid_accel_3d_ids[] = {
66c721f7 AH	464	{
	465	/* Format: HID-SENSOR-usage_id_in_hex_lowercase */
	466	.name = "HID-SENSOR-200073",
	467	},
0e377f3b SH	468	{ /* gravity sensor */
	469	.name = "HID-SENSOR-20007b",
	470	},
66c721f7 AH	471	{ /* sentinel */ }
	472	};
	473	MODULE_DEVICE_TABLE(platform, hid_accel_3d_ids);
	474
45fe6f7d	475	static struct platform_driver hid_accel_3d_platform_driver = {
66c721f7	476	.id_table = hid_accel_3d_ids,
45fe6f7d	477	.driver = {
66c721f7	478	.name = KBUILD_MODNAME,
cbbcc937	479	.pm = &hid_sensor_pm_ops,
45fe6f7d	480	},
	481	.probe = hid_accel_3d_probe,
	482	.remove = hid_accel_3d_remove,
	483	};
	484	module_platform_driver(hid_accel_3d_platform_driver);
	485
	486	MODULE_DESCRIPTION("HID Sensor Accel 3D");
	487	MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
	488	MODULE_LICENSE("GPL");