[mirror_ubuntu-bionic-kernel.git] / drivers / iio / magnetometer / hid-sensor-magn-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/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 magn_3d_channel {
	CHANNEL_SCAN_INDEX_X,
	CHANNEL_SCAN_INDEX_Y,
	CHANNEL_SCAN_INDEX_Z,
	MAGN_3D_CHANNEL_MAX,
};

struct magn_3d_state {
	struct hid_sensor_hub_callbacks callbacks;
	struct hid_sensor_common common_attributes;
	struct hid_sensor_hub_attribute_info magn[MAGN_3D_CHANNEL_MAX];
	u32 magn_val[MAGN_3D_CHANNEL_MAX];
};

static const u32 magn_3d_addresses[MAGN_3D_CHANNEL_MAX] = {
	HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS,
	HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Y_AXIS,
	HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Z_AXIS
};

/* Channel definitions */
static const struct iio_chan_spec magn_3d_channels[] = {
	{
		.type = IIO_MAGN,
		.modified = 1,
		.channel2 = IIO_MOD_X,
		.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_MAGN,
		.modified = 1,
		.channel2 = IIO_MOD_Y,
		.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_MAGN,
		.modified = 1,
		.channel2 = IIO_MOD_Z,
		.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 magn_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 magn_3d_read_raw(struct iio_dev *indio_dev,
			      struct iio_chan_spec const *chan,
			      int *val, int *val2,
			      long mask)
{
	struct magn_3d_state *magn_state = iio_priv(indio_dev);
	int report_id = -1;
	u32 address;
	int ret;
	int ret_type;

	*val = 0;
	*val2 = 0;
	switch (mask) {
	case 0:
		report_id =
			magn_state->magn[chan->scan_index].report_id;
		address = magn_3d_addresses[chan->scan_index];
		if (report_id >= 0)
			*val = sensor_hub_input_attr_get_raw_value(
				magn_state->common_attributes.hsdev,
				HID_USAGE_SENSOR_COMPASS_3D, address,
				report_id);
		else {
			*val = 0;
			return -EINVAL;
		}
		ret_type = IIO_VAL_INT;
		break;
	case IIO_CHAN_INFO_SCALE:
		*val = magn_state->magn[CHANNEL_SCAN_INDEX_X].units;
		ret_type = IIO_VAL_INT;
		break;
	case IIO_CHAN_INFO_OFFSET:
		*val = hid_sensor_convert_exponent(
			magn_state->magn[CHANNEL_SCAN_INDEX_X].unit_expo);
		ret_type = IIO_VAL_INT;
		break;
	case IIO_CHAN_INFO_SAMP_FREQ:
		ret = hid_sensor_read_samp_freq_value(
			&magn_state->common_attributes, val, val2);
		ret_type = IIO_VAL_INT_PLUS_MICRO;
		break;
	case IIO_CHAN_INFO_HYSTERESIS:
		ret = hid_sensor_read_raw_hyst_value(
			&magn_state->common_attributes, val, val2);
		ret_type = IIO_VAL_INT_PLUS_MICRO;
		break;
	default:
		ret_type = -EINVAL;
		break;
	}

	return ret_type;
}

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

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

	return ret;
}

static const struct iio_info magn_3d_info = {
	.driver_module = THIS_MODULE,
	.read_raw = &magn_3d_read_raw,
	.write_raw = &magn_3d_write_raw,
};

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

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

	dev_dbg(&indio_dev->dev, "magn_3d_proc_event [%d]\n",
				magn_state->common_attributes.data_ready);
	if (magn_state->common_attributes.data_ready)
		hid_sensor_push_data(indio_dev,
				(u8 *)magn_state->magn_val,
				sizeof(magn_state->magn_val));

	return 0;
}

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

	switch (usage_id) {
	case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS:
	case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Y_AXIS:
	case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Z_AXIS:
		offset = usage_id - HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS;
		magn_state->magn_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 magn_3d_parse_report(struct platform_device *pdev,
				struct hid_sensor_hub_device *hsdev,
				struct iio_chan_spec *channels,
				unsigned usage_id,
				struct magn_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_ORIENT_MAGN_FLUX_X_AXIS + i,
				&st->magn[CHANNEL_SCAN_INDEX_X + i]);
		if (ret < 0)
			break;
		magn_3d_adjust_channel_bit_mask(channels,
				CHANNEL_SCAN_INDEX_X + i,
				st->magn[CHANNEL_SCAN_INDEX_X + i].size);
	}
	dev_dbg(&pdev->dev, "magn_3d %x:%x, %x:%x, %x:%x\n",
			st->magn[0].index,
			st->magn[0].report_id,
			st->magn[1].index, st->magn[1].report_id,
			st->magn[2].index, st->magn[2].report_id);

	return ret;
}

/* Function to initialize the processing for usage id */
static int hid_magn_3d_probe(struct platform_device *pdev)
{
	int ret = 0;
	static char *name = "magn_3d";
	struct iio_dev *indio_dev;
	struct magn_3d_state *magn_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(struct magn_3d_state));
	if (indio_dev == NULL)
		return -ENOMEM;

	platform_set_drvdata(pdev, indio_dev);

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

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

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

	ret = magn_3d_parse_report(pdev, hsdev, channels,
				HID_USAGE_SENSOR_COMPASS_3D, magn_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(magn_3d_channels);
	indio_dev->dev.parent = &pdev->dev;
	indio_dev->info = &magn_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;
	}
	magn_state->common_attributes.data_ready = false;
	ret = hid_sensor_setup_trigger(indio_dev, name,
					&magn_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;
	}

	magn_state->callbacks.send_event = magn_3d_proc_event;
	magn_state->callbacks.capture_sample = magn_3d_capture_sample;
	magn_state->callbacks.pdev = pdev;
	ret = sensor_hub_register_callback(hsdev, HID_USAGE_SENSOR_COMPASS_3D,
					&magn_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(indio_dev);
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_magn_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);

	sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_COMPASS_3D);
	iio_device_unregister(indio_dev);
	hid_sensor_remove_trigger(indio_dev);
	iio_triggered_buffer_cleanup(indio_dev);
	kfree(indio_dev->channels);

	return 0;
}

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

static struct platform_driver hid_magn_3d_platform_driver = {
	.id_table = hid_magn_3d_ids,
	.driver = {
		.name	= KBUILD_MODNAME,
		.owner	= THIS_MODULE,
	},
	.probe		= hid_magn_3d_probe,
	.remove		= hid_magn_3d_remove,
};
module_platform_driver(hid_magn_3d_platform_driver);

MODULE_DESCRIPTION("HID Sensor Magnetometer 3D");
MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
MODULE_LICENSE("GPL");
Commit	Line	Data
bc1d57ba	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>
	25	#include <linux/hid-sensor-hub.h>
	26	#include <linux/iio/iio.h>
	27	#include <linux/iio/sysfs.h>
	28	#include <linux/iio/buffer.h>
	29	#include <linux/iio/trigger_consumer.h>
	30	#include <linux/iio/triggered_buffer.h>
bc1d57ba	31	#include "../common/hid-sensors/hid-sensor-trigger.h"
bc1d57ba	32
bc1d57ba	33	enum magn_3d_channel {
	34	CHANNEL_SCAN_INDEX_X,
	35	CHANNEL_SCAN_INDEX_Y,
	36	CHANNEL_SCAN_INDEX_Z,
	37	MAGN_3D_CHANNEL_MAX,
	38	};
	39
	40	struct magn_3d_state {
	41	struct hid_sensor_hub_callbacks callbacks;
e07c6d17	42	struct hid_sensor_common common_attributes;
bc1d57ba	43	struct hid_sensor_hub_attribute_info magn[MAGN_3D_CHANNEL_MAX];
	44	u32 magn_val[MAGN_3D_CHANNEL_MAX];
	45	};
	46
	47	static const u32 magn_3d_addresses[MAGN_3D_CHANNEL_MAX] = {
	48	HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS,
	49	HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Y_AXIS,
	50	HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Z_AXIS
	51	};
	52
	53	/* Channel definitions */
	54	static const struct iio_chan_spec magn_3d_channels[] = {
	55	{
	56	.type = IIO_MAGN,
	57	.modified = 1,
	58	.channel2 = IIO_MOD_X,
ecbe18f2 JC	59	.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) \|
	60	BIT(IIO_CHAN_INFO_SCALE) \|
	61	BIT(IIO_CHAN_INFO_SAMP_FREQ) \|
	62	BIT(IIO_CHAN_INFO_HYSTERESIS),
bc1d57ba	63	.scan_index = CHANNEL_SCAN_INDEX_X,
	64	}, {
	65	.type = IIO_MAGN,
	66	.modified = 1,
	67	.channel2 = IIO_MOD_Y,
ecbe18f2 JC	68	.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) \|
	69	BIT(IIO_CHAN_INFO_SCALE) \|
	70	BIT(IIO_CHAN_INFO_SAMP_FREQ) \|
	71	BIT(IIO_CHAN_INFO_HYSTERESIS),
bc1d57ba	72	.scan_index = CHANNEL_SCAN_INDEX_Y,
	73	}, {
	74	.type = IIO_MAGN,
	75	.modified = 1,
	76	.channel2 = IIO_MOD_Z,
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),
bc1d57ba	81	.scan_index = CHANNEL_SCAN_INDEX_Z,
	82	}
	83	};
	84
	85	/* Adjust channel real bits based on report descriptor */
	86	static void magn_3d_adjust_channel_bit_mask(struct iio_chan_spec *channels,
	87	int channel, int size)
	88	{
	89	channels[channel].scan_type.sign = 's';
	90	/* Real storage bits will change based on the report desc. */
	91	channels[channel].scan_type.realbits = size * 8;
	92	/* Maximum size of a sample to capture is u32 */
	93	channels[channel].scan_type.storagebits = sizeof(u32) * 8;
	94	}
	95
	96	/* Channel read_raw handler */
	97	static int magn_3d_read_raw(struct iio_dev *indio_dev,
	98	struct iio_chan_spec const *chan,
	99	int val, int val2,
	100	long mask)
	101	{
	102	struct magn_3d_state *magn_state = iio_priv(indio_dev);
	103	int report_id = -1;
	104	u32 address;
	105	int ret;
	106	int ret_type;
	107
	108	*val = 0;
	109	*val2 = 0;
	110	switch (mask) {
	111	case 0:
	112	report_id =
	113	magn_state->magn[chan->scan_index].report_id;
	114	address = magn_3d_addresses[chan->scan_index];
	115	if (report_id >= 0)
	116	*val = sensor_hub_input_attr_get_raw_value(
	117	magn_state->common_attributes.hsdev,
	118	HID_USAGE_SENSOR_COMPASS_3D, address,
	119	report_id);
	120	else {
	121	*val = 0;
	122	return -EINVAL;
	123	}
	124	ret_type = IIO_VAL_INT;
	125	break;
	126	case IIO_CHAN_INFO_SCALE:
	127	*val = magn_state->magn[CHANNEL_SCAN_INDEX_X].units;
	128	ret_type = IIO_VAL_INT;
	129	break;
	130	case IIO_CHAN_INFO_OFFSET:
	131	*val = hid_sensor_convert_exponent(
	132	magn_state->magn[CHANNEL_SCAN_INDEX_X].unit_expo);
	133	ret_type = IIO_VAL_INT;
	134	break;
	135	case IIO_CHAN_INFO_SAMP_FREQ:
	136	ret = hid_sensor_read_samp_freq_value(
	137	&magn_state->common_attributes, val, val2);
	138	ret_type = IIO_VAL_INT_PLUS_MICRO;
	139	break;
	140	case IIO_CHAN_INFO_HYSTERESIS:
	141	ret = hid_sensor_read_raw_hyst_value(
	142	&magn_state->common_attributes, val, val2);
	143	ret_type = IIO_VAL_INT_PLUS_MICRO;
	144	break;
145	default:
146	ret_type = -EINVAL;
147	break;
148	}
149
150	return ret_type;
151	}
152
153	/* Channel write_raw handler */
154	static int magn_3d_write_raw(struct iio_dev *indio_dev,
155	struct iio_chan_spec const *chan,
156	int val,
157	int val2,
158	long mask)
159	{
160	struct magn_3d_state *magn_state = iio_priv(indio_dev);
161	int ret = 0;
162
163	switch (mask) {
164	case IIO_CHAN_INFO_SAMP_FREQ:
165	ret = hid_sensor_write_samp_freq_value(
166	&magn_state->common_attributes, val, val2);
167	break;
168	case IIO_CHAN_INFO_HYSTERESIS:
169	ret = hid_sensor_write_raw_hyst_value(
170	&magn_state->common_attributes, val, val2);
171	break;
172	default:
173	ret = -EINVAL;
174	}
175
176	return ret;
177	}
178
bc1d57ba	179	static const struct iio_info magn_3d_info = {
	180	.driver_module = THIS_MODULE,
	181	.read_raw = &magn_3d_read_raw,
	182	.write_raw = &magn_3d_write_raw,
bc1d57ba	183	};
	184
	185	/* Function to push data to buffer */
	186	static void hid_sensor_push_data(struct iio_dev indio_dev, u8 data, int len)
	187	{
bc1d57ba	188	dev_dbg(&indio_dev->dev, "hid_sensor_push_data\n");
84b36ce5	189	iio_push_to_buffers(indio_dev, (u8 *)data);
bc1d57ba	190	}
	191
	192	/* Callback handler to send event after all samples are received and captured */
	193	static int magn_3d_proc_event(struct hid_sensor_hub_device *hsdev,
	194	unsigned usage_id,
	195	void *priv)
	196	{
	197	struct iio_dev *indio_dev = platform_get_drvdata(priv);
	198	struct magn_3d_state *magn_state = iio_priv(indio_dev);
	199
	200	dev_dbg(&indio_dev->dev, "magn_3d_proc_event [%d]\n",
	201	magn_state->common_attributes.data_ready);
	202	if (magn_state->common_attributes.data_ready)
	203	hid_sensor_push_data(indio_dev,
	204	(u8 *)magn_state->magn_val,
	205	sizeof(magn_state->magn_val));
	206
	207	return 0;
	208	}
	209
	210	/* Capture samples in local storage */
	211	static int magn_3d_capture_sample(struct hid_sensor_hub_device *hsdev,
	212	unsigned usage_id,
	213	size_t raw_len, char *raw_data,
	214	void *priv)
	215	{
	216	struct iio_dev *indio_dev = platform_get_drvdata(priv);
	217	struct magn_3d_state *magn_state = iio_priv(indio_dev);
	218	int offset;
	219	int ret = -EINVAL;
	220
	221	switch (usage_id) {
	222	case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS:
	223	case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Y_AXIS:
	224	case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Z_AXIS:
	225	offset = usage_id - HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS;
	226	magn_state->magn_val[CHANNEL_SCAN_INDEX_X + offset] =
	227	(u32 )raw_data;
	228	ret = 0;
	229	break;
	230	default:
	231	break;
	232	}
	233
	234	return ret;
	235	}
	236
	237	/* Parse report which is specific to an usage id*/
	238	static int magn_3d_parse_report(struct platform_device *pdev,
	239	struct hid_sensor_hub_device *hsdev,
	240	struct iio_chan_spec *channels,
	241	unsigned usage_id,
	242	struct magn_3d_state *st)
	243	{
	244	int ret;
	245	int i;
	246
	247	for (i = 0; i <= CHANNEL_SCAN_INDEX_Z; ++i) {
	248	ret = sensor_hub_input_get_attribute_info(hsdev,
	249	HID_INPUT_REPORT,
	250	usage_id,
	251	HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS + i,
	252	&st->magn[CHANNEL_SCAN_INDEX_X + i]);
	253	if (ret < 0)
254	break;
255	magn_3d_adjust_channel_bit_mask(channels,
256	CHANNEL_SCAN_INDEX_X + i,
257	st->magn[CHANNEL_SCAN_INDEX_X + i].size);
258	}
259	dev_dbg(&pdev->dev, "magn_3d %x:%x, %x:%x, %x:%x\n",
260	st->magn[0].index,
261	st->magn[0].report_id,
262	st->magn[1].index, st->magn[1].report_id,
263	st->magn[2].index, st->magn[2].report_id);
264
265	return ret;
266	}
267
268	/* Function to initialize the processing for usage id */
fc52692c	269	static int hid_magn_3d_probe(struct platform_device *pdev)
bc1d57ba	270	{
	271	int ret = 0;
	272	static char *name = "magn_3d";
	273	struct iio_dev *indio_dev;
	274	struct magn_3d_state *magn_state;
	275	struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
	276	struct iio_chan_spec *channels;
	277
907c0a0a SK	278	indio_dev = devm_iio_device_alloc(&pdev->dev,
	279	sizeof(struct magn_3d_state));
	280	if (indio_dev == NULL)
	281	return -ENOMEM;
	282
bc1d57ba	283	platform_set_drvdata(pdev, indio_dev);
	284
	285	magn_state = iio_priv(indio_dev);
	286	magn_state->common_attributes.hsdev = hsdev;
	287	magn_state->common_attributes.pdev = pdev;
	288
	289	ret = hid_sensor_parse_common_attributes(hsdev,
	290	HID_USAGE_SENSOR_COMPASS_3D,
	291	&magn_state->common_attributes);
	292	if (ret) {
	293	dev_err(&pdev->dev, "failed to setup common attributes\n");
907c0a0a	294	return ret;
bc1d57ba	295	}
bc1d57ba	296
64ebe955 AL	297	channels = kmemdup(magn_3d_channels, sizeof(magn_3d_channels),
64ebe955 AL	298	GFP_KERNEL);
bc1d57ba	299	if (!channels) {
bc1d57ba	300	dev_err(&pdev->dev, "failed to duplicate channels\n");
907c0a0a	301	return -ENOMEM;
bc1d57ba	302	}
	303
	304	ret = magn_3d_parse_report(pdev, hsdev, channels,
	305	HID_USAGE_SENSOR_COMPASS_3D, magn_state);
	306	if (ret) {
	307	dev_err(&pdev->dev, "failed to setup attributes\n");
	308	goto error_free_dev_mem;
	309	}
	310
	311	indio_dev->channels = channels;
	312	indio_dev->num_channels = ARRAY_SIZE(magn_3d_channels);
	313	indio_dev->dev.parent = &pdev->dev;
	314	indio_dev->info = &magn_3d_info;
	315	indio_dev->name = name;
	316	indio_dev->modes = INDIO_DIRECT_MODE;
	317
	318	ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time,
	319	NULL, NULL);
	320	if (ret) {
	321	dev_err(&pdev->dev, "failed to initialize trigger buffer\n");
	322	goto error_free_dev_mem;
	323	}
	324	magn_state->common_attributes.data_ready = false;
	325	ret = hid_sensor_setup_trigger(indio_dev, name,
	326	&magn_state->common_attributes);
	327	if (ret < 0) {
	328	dev_err(&pdev->dev, "trigger setup failed\n");
	329	goto error_unreg_buffer_funcs;
	330	}
	331
	332	ret = iio_device_register(indio_dev);
	333	if (ret) {
	334	dev_err(&pdev->dev, "device register failed\n");
	335	goto error_remove_trigger;
	336	}
	337
	338	magn_state->callbacks.send_event = magn_3d_proc_event;
	339	magn_state->callbacks.capture_sample = magn_3d_capture_sample;
	340	magn_state->callbacks.pdev = pdev;
	341	ret = sensor_hub_register_callback(hsdev, HID_USAGE_SENSOR_COMPASS_3D,
	342	&magn_state->callbacks);
	343	if (ret < 0) {
	344	dev_err(&pdev->dev, "callback reg failed\n");
	345	goto error_iio_unreg;
	346	}
	347
	348	return ret;
	349
	350	error_iio_unreg:
	351	iio_device_unregister(indio_dev);
	352	error_remove_trigger:
	353	hid_sensor_remove_trigger(indio_dev);
	354	error_unreg_buffer_funcs:
	355	iio_triggered_buffer_cleanup(indio_dev);
	356	error_free_dev_mem:
	357	kfree(indio_dev->channels);
bc1d57ba	358	return ret;
	359	}
	360
	361	/* Function to deinitialize the processing for usage id */
fc52692c	362	static int hid_magn_3d_remove(struct platform_device *pdev)
bc1d57ba	363	{
	364	struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
	365	struct iio_dev *indio_dev = platform_get_drvdata(pdev);
	366
	367	sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_COMPASS_3D);
	368	iio_device_unregister(indio_dev);
	369	hid_sensor_remove_trigger(indio_dev);
	370	iio_triggered_buffer_cleanup(indio_dev);
	371	kfree(indio_dev->channels);
bc1d57ba	372
	373	return 0;
	374	}
	375
a67c385a AH	376	static struct platform_device_id hid_magn_3d_ids[] = {
	377	{
	378	/* Format: HID-SENSOR-usage_id_in_hex_lowercase */
	379	.name = "HID-SENSOR-200083",
	380	},
	381	{ /* sentinel */ }
	382	};
	383	MODULE_DEVICE_TABLE(platform, hid_magn_3d_ids);
	384
bc1d57ba	385	static struct platform_driver hid_magn_3d_platform_driver = {
a67c385a	386	.id_table = hid_magn_3d_ids,
bc1d57ba	387	.driver = {
a67c385a	388	.name = KBUILD_MODNAME,
bc1d57ba	389	.owner = THIS_MODULE,
	390	},
	391	.probe = hid_magn_3d_probe,
	392	.remove = hid_magn_3d_remove,
	393	};
	394	module_platform_driver(hid_magn_3d_platform_driver);
	395
	396	MODULE_DESCRIPTION("HID Sensor Magnetometer 3D");
	397	MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
	398	MODULE_LICENSE("GPL");