[deliverable/linux.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/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 magn_3d_channel {
	CHANNEL_SCAN_INDEX_X,
	CHANNEL_SCAN_INDEX_Y,
	CHANNEL_SCAN_INDEX_Z,
	CHANNEL_SCAN_INDEX_NORTH_MAGN_TILT_COMP,
	CHANNEL_SCAN_INDEX_NORTH_TRUE_TILT_COMP,
	CHANNEL_SCAN_INDEX_NORTH_MAGN,
	CHANNEL_SCAN_INDEX_NORTH_TRUE,
	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];

	/* dynamically sized array to hold sensor values */
	u32 *iio_vals;
	/* array of pointers to sensor value */
	u32 *magn_val_addr[MAGN_3D_CHANNEL_MAX];

	int scale_pre_decml;
	int scale_post_decml;
	int scale_precision;
	int value_offset;
};

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,
	HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH,
	HID_USAGE_SENSOR_ORIENT_COMP_TRUE_NORTH,
	HID_USAGE_SENSOR_ORIENT_MAGN_NORTH,
	HID_USAGE_SENSOR_ORIENT_TRUE_NORTH,
};

/* Channel definitions */
static const struct iio_chan_spec magn_3d_channels[] = {
	{
		.type = IIO_MAGN,
		.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),
	}, {
		.type = IIO_MAGN,
		.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),
	}, {
		.type = IIO_MAGN,
		.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),
	}, {
		.type = IIO_ROT,
		.modified = 1,
		.channel2 = IIO_MOD_NORTH_MAGN_TILT_COMP,
		.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),
	}, {
		.type = IIO_ROT,
		.modified = 1,
		.channel2 = IIO_MOD_NORTH_TRUE_TILT_COMP,
		.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),
	}, {
		.type = IIO_ROT,
		.modified = 1,
		.channel2 = IIO_MOD_NORTH_MAGN,
		.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),
	}, {
		.type = IIO_ROT,
		.modified = 1,
		.channel2 = IIO_MOD_NORTH_TRUE,
		.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),
	}
};

/* 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_type;
	s32 poll_value;

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

		hid_sensor_power_state(&magn_state->common_attributes, true);
		msleep_interruptible(poll_value * 2);

		report_id =
			magn_state->magn[chan->address].report_id;
		address = magn_3d_addresses[chan->address];
		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;
			hid_sensor_power_state(&magn_state->common_attributes,
						false);
			return -EINVAL;
		}
		hid_sensor_power_state(&magn_state->common_attributes, false);
		ret_type = IIO_VAL_INT;
		break;
	case IIO_CHAN_INFO_SCALE:
		*val = magn_state->scale_pre_decml;
		*val2 = magn_state->scale_post_decml;
		ret_type = magn_state->scale_precision;
		break;
	case IIO_CHAN_INFO_OFFSET:
		*val = magn_state->value_offset;
		ret_type = IIO_VAL_INT;
		break;
	case IIO_CHAN_INFO_SAMP_FREQ:
		ret_type = hid_sensor_read_samp_freq_value(
			&magn_state->common_attributes, val, val2);
		break;
	case IIO_CHAN_INFO_HYSTERESIS:
		ret_type = hid_sensor_read_raw_hyst_value(
			&magn_state->common_attributes, val, val2);
		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, const void *data)
{
	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 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\n");
	if (atomic_read(&magn_state->common_attributes.data_ready))
		hid_sensor_push_data(indio_dev, magn_state->iio_vals);

	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 = 0;
	u32 *iio_val = NULL;

	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)
				+ CHANNEL_SCAN_INDEX_X;
	break;
	case HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH:
	case HID_USAGE_SENSOR_ORIENT_COMP_TRUE_NORTH:
	case HID_USAGE_SENSOR_ORIENT_MAGN_NORTH:
	case HID_USAGE_SENSOR_ORIENT_TRUE_NORTH:
		offset = (usage_id - HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH)
				+ CHANNEL_SCAN_INDEX_NORTH_MAGN_TILT_COMP;
	break;
	default:
		return -EINVAL;
	}

	iio_val = magn_state->magn_val_addr[offset];

	if (iio_val != NULL)
		*iio_val = *((u32 *)raw_data);
	else
		ret = -EINVAL;

	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,
				int *chan_count,
				unsigned usage_id,
				struct magn_3d_state *st)
{
	int i;
	int attr_count = 0;
	struct iio_chan_spec *_channels;

	/* Scan for each usage attribute supported */
	for (i = 0; i < MAGN_3D_CHANNEL_MAX; i++) {
		int status;
		u32 address = magn_3d_addresses[i];

		/* Check if usage attribute exists in the sensor hub device */
		status = sensor_hub_input_get_attribute_info(hsdev,
			HID_INPUT_REPORT,
			usage_id,
			address,
			&(st->magn[i]));
		if (!status)
			attr_count++;
	}

	if (attr_count <= 0) {
		dev_err(&pdev->dev,
			"failed to find any supported usage attributes in report\n");
		return  -EINVAL;
	}

	dev_dbg(&pdev->dev, "magn_3d Found %d usage attributes\n",
			attr_count);
	dev_dbg(&pdev->dev, "magn_3d X: %x:%x Y: %x:%x Z: %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);

	/* Setup IIO channel array */
	_channels = devm_kcalloc(&pdev->dev, attr_count,
				sizeof(struct iio_chan_spec),
				GFP_KERNEL);
	if (!_channels) {
		dev_err(&pdev->dev,
			"failed to allocate space for iio channels\n");
		return -ENOMEM;
	}

	st->iio_vals = devm_kcalloc(&pdev->dev, attr_count,
				sizeof(u32),
				GFP_KERNEL);
	if (!st->iio_vals) {
		dev_err(&pdev->dev,
			"failed to allocate space for iio values array\n");
		return -ENOMEM;
	}

	for (i = 0, *chan_count = 0;
	i < MAGN_3D_CHANNEL_MAX && *chan_count < attr_count;
	i++){
		if (st->magn[i].index >= 0) {
			/* Setup IIO channel struct */
			(_channels[*chan_count]) = magn_3d_channels[i];
			(_channels[*chan_count]).scan_index = *chan_count;
			(_channels[*chan_count]).address = i;

			/* Set magn_val_addr to iio value address */
			st->magn_val_addr[i] = &(st->iio_vals[*chan_count]);
			magn_3d_adjust_channel_bit_mask(_channels,
							*chan_count,
							st->magn[i].size);
			(*chan_count)++;
		}
	}

	if (*chan_count <= 0) {
		dev_err(&pdev->dev,
			"failed to find any magnetic channels setup\n");
		return -EINVAL;
	}

	*channels = _channels;

	dev_dbg(&pdev->dev, "magn_3d Setup %d IIO channels\n",
			*chan_count);

	st->scale_precision = hid_sensor_format_scale(
				HID_USAGE_SENSOR_COMPASS_3D,
				&st->magn[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_ORIENTATION,
			&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 0;
}

/* 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;
	int chan_count = 0;

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

	ret = magn_3d_parse_report(pdev, hsdev,
				&channels, &chan_count,
				HID_USAGE_SENSOR_COMPASS_3D, magn_state);
	if (ret) {
		dev_err(&pdev->dev, "failed to parse report\n");
		return ret;
	}

	indio_dev->channels = channels;
	indio_dev->num_channels = chan_count;
	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");
		return ret;
	}
	atomic_set(&magn_state->common_attributes.data_ready, 0);
	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(&magn_state->common_attributes);
error_unreg_buffer_funcs:
	iio_triggered_buffer_cleanup(indio_dev);
	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);
	struct magn_3d_state *magn_state = iio_priv(indio_dev);

	sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_COMPASS_3D);
	iio_device_unregister(indio_dev);
	hid_sensor_remove_trigger(&magn_state->common_attributes);
	iio_triggered_buffer_cleanup(indio_dev);

	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,
	},
	.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>
8009c594	25	#include <linux/delay.h>
bc1d57ba	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>
bc1d57ba	32	#include "../common/hid-sensors/hid-sensor-trigger.h"
bc1d57ba	33
bc1d57ba	34	enum magn_3d_channel {
	35	CHANNEL_SCAN_INDEX_X,
	36	CHANNEL_SCAN_INDEX_Y,
	37	CHANNEL_SCAN_INDEX_Z,
abea9c62 RA	38	CHANNEL_SCAN_INDEX_NORTH_MAGN_TILT_COMP,
	39	CHANNEL_SCAN_INDEX_NORTH_TRUE_TILT_COMP,
	40	CHANNEL_SCAN_INDEX_NORTH_MAGN,
	41	CHANNEL_SCAN_INDEX_NORTH_TRUE,
bc1d57ba	42	MAGN_3D_CHANNEL_MAX,
	43	};
	44
	45	struct magn_3d_state {
	46	struct hid_sensor_hub_callbacks callbacks;
e07c6d17	47	struct hid_sensor_common common_attributes;
bc1d57ba	48	struct hid_sensor_hub_attribute_info magn[MAGN_3D_CHANNEL_MAX];
2a96540a RA	49
	50	/* dynamically sized array to hold sensor values */
	51	u32 *iio_vals;
	52	/* array of pointers to sensor value */
	53	u32 *magn_val_addr[MAGN_3D_CHANNEL_MAX];
	54
92463fda SP	55	int scale_pre_decml;
	56	int scale_post_decml;
	57	int scale_precision;
	58	int value_offset;
bc1d57ba	59	};
	60
	61	static const u32 magn_3d_addresses[MAGN_3D_CHANNEL_MAX] = {
	62	HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS,
	63	HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Y_AXIS,
abea9c62 RA	64	HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Z_AXIS,
	65	HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH,
	66	HID_USAGE_SENSOR_ORIENT_COMP_TRUE_NORTH,
	67	HID_USAGE_SENSOR_ORIENT_MAGN_NORTH,
	68	HID_USAGE_SENSOR_ORIENT_TRUE_NORTH,
bc1d57ba	69	};
	70
	71	/* Channel definitions */
	72	static const struct iio_chan_spec magn_3d_channels[] = {
	73	{
	74	.type = IIO_MAGN,
	75	.modified = 1,
	76	.channel2 = IIO_MOD_X,
8009c594	77	.info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
ecbe18f2 JC	78	.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) \|
	79	BIT(IIO_CHAN_INFO_SCALE) \|
	80	BIT(IIO_CHAN_INFO_SAMP_FREQ) \|
	81	BIT(IIO_CHAN_INFO_HYSTERESIS),
bc1d57ba	82	}, {
	83	.type = IIO_MAGN,
	84	.modified = 1,
	85	.channel2 = IIO_MOD_Y,
8009c594	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),
bc1d57ba	91	}, {
	92	.type = IIO_MAGN,
	93	.modified = 1,
	94	.channel2 = IIO_MOD_Z,
8009c594	95	.info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
ecbe18f2 JC	96	.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) \|
	97	BIT(IIO_CHAN_INFO_SCALE) \|
	98	BIT(IIO_CHAN_INFO_SAMP_FREQ) \|
	99	BIT(IIO_CHAN_INFO_HYSTERESIS),
abea9c62 RA	100	}, {
	101	.type = IIO_ROT,
	102	.modified = 1,
	103	.channel2 = IIO_MOD_NORTH_MAGN_TILT_COMP,
	104	.info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
	105	.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) \|
	106	BIT(IIO_CHAN_INFO_SCALE) \|
	107	BIT(IIO_CHAN_INFO_SAMP_FREQ) \|
	108	BIT(IIO_CHAN_INFO_HYSTERESIS),
	109	}, {
	110	.type = IIO_ROT,
	111	.modified = 1,
	112	.channel2 = IIO_MOD_NORTH_TRUE_TILT_COMP,
	113	.info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
	114	.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) \|
	115	BIT(IIO_CHAN_INFO_SCALE) \|
	116	BIT(IIO_CHAN_INFO_SAMP_FREQ) \|
	117	BIT(IIO_CHAN_INFO_HYSTERESIS),
	118	}, {
	119	.type = IIO_ROT,
	120	.modified = 1,
	121	.channel2 = IIO_MOD_NORTH_MAGN,
	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	}, {
	128	.type = IIO_ROT,
	129	.modified = 1,
	130	.channel2 = IIO_MOD_NORTH_TRUE,
	131	.info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
	132	.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) \|
	133	BIT(IIO_CHAN_INFO_SCALE) \|
	134	BIT(IIO_CHAN_INFO_SAMP_FREQ) \|
	135	BIT(IIO_CHAN_INFO_HYSTERESIS),
bc1d57ba	136	}
	137	};
	138
	139	/* Adjust channel real bits based on report descriptor */
	140	static void magn_3d_adjust_channel_bit_mask(struct iio_chan_spec *channels,
	141	int channel, int size)
	142	{
	143	channels[channel].scan_type.sign = 's';
	144	/* Real storage bits will change based on the report desc. */
	145	channels[channel].scan_type.realbits = size * 8;
	146	/* Maximum size of a sample to capture is u32 */
	147	channels[channel].scan_type.storagebits = sizeof(u32) * 8;
	148	}
	149
	150	/* Channel read_raw handler */
	151	static int magn_3d_read_raw(struct iio_dev *indio_dev,
	152	struct iio_chan_spec const *chan,
	153	int val, int val2,
	154	long mask)
	155	{
	156	struct magn_3d_state *magn_state = iio_priv(indio_dev);
	157	int report_id = -1;
	158	u32 address;
bc1d57ba	159	int ret_type;
8009c594	160	s32 poll_value;
bc1d57ba	161
	162	*val = 0;
	163	*val2 = 0;
	164	switch (mask) {
	165	case 0:
8009c594 SP	166	poll_value = hid_sensor_read_poll_value(
	167	&magn_state->common_attributes);
	168	if (poll_value < 0)
	169	return -EINVAL;
	170
	171	hid_sensor_power_state(&magn_state->common_attributes, true);
	172	msleep_interruptible(poll_value * 2);
	173
bc1d57ba	174	report_id =
2a96540a RA	175	magn_state->magn[chan->address].report_id;
2a96540a RA	176	address = magn_3d_addresses[chan->address];
bc1d57ba	177	if (report_id >= 0)
	178	*val = sensor_hub_input_attr_get_raw_value(
	179	magn_state->common_attributes.hsdev,
	180	HID_USAGE_SENSOR_COMPASS_3D, address,
	181	report_id);
	182	else {
	183	*val = 0;
8009c594 SP	184	hid_sensor_power_state(&magn_state->common_attributes,
8009c594 SP	185	false);
bc1d57ba	186	return -EINVAL;
bc1d57ba	187	}
8009c594	188	hid_sensor_power_state(&magn_state->common_attributes, false);
bc1d57ba	189	ret_type = IIO_VAL_INT;
	190	break;
	191	case IIO_CHAN_INFO_SCALE:
92463fda SP	192	*val = magn_state->scale_pre_decml;
	193	*val2 = magn_state->scale_post_decml;
	194	ret_type = magn_state->scale_precision;
bc1d57ba	195	break;
bc1d57ba	196	case IIO_CHAN_INFO_OFFSET:
92463fda	197	*val = magn_state->value_offset;
bc1d57ba	198	ret_type = IIO_VAL_INT;
	199	break;
	200	case IIO_CHAN_INFO_SAMP_FREQ:
5f25b41f	201	ret_type = hid_sensor_read_samp_freq_value(
bc1d57ba	202	&magn_state->common_attributes, val, val2);
bc1d57ba	203	break;
bc1d57ba	204	case IIO_CHAN_INFO_HYSTERESIS:
5f25b41f	205	ret_type = hid_sensor_read_raw_hyst_value(
bc1d57ba	206	&magn_state->common_attributes, val, val2);
bc1d57ba	207	break;
	208	default:
	209	ret_type = -EINVAL;
	210	break;
	211	}
	212
	213	return ret_type;
	214	}
	215
	216	/* Channel write_raw handler */
	217	static int magn_3d_write_raw(struct iio_dev *indio_dev,
	218	struct iio_chan_spec const *chan,
	219	int val,
	220	int val2,
	221	long mask)
	222	{
	223	struct magn_3d_state *magn_state = iio_priv(indio_dev);
	224	int ret = 0;
	225
	226	switch (mask) {
	227	case IIO_CHAN_INFO_SAMP_FREQ:
	228	ret = hid_sensor_write_samp_freq_value(
	229	&magn_state->common_attributes, val, val2);
	230	break;
	231	case IIO_CHAN_INFO_HYSTERESIS:
	232	ret = hid_sensor_write_raw_hyst_value(
	233	&magn_state->common_attributes, val, val2);
	234	break;
	235	default:
	236	ret = -EINVAL;
	237	}
	238
	239	return ret;
	240	}
	241
bc1d57ba	242	static const struct iio_info magn_3d_info = {
	243	.driver_module = THIS_MODULE,
	244	.read_raw = &magn_3d_read_raw,
	245	.write_raw = &magn_3d_write_raw,
bc1d57ba	246	};
	247
	248	/* Function to push data to buffer */
03d79558	249	static void hid_sensor_push_data(struct iio_dev indio_dev, const void data)
bc1d57ba	250	{
bc1d57ba	251	dev_dbg(&indio_dev->dev, "hid_sensor_push_data\n");
8c60c7e7	252	iio_push_to_buffers(indio_dev, data);
bc1d57ba	253	}
	254
	255	/* Callback handler to send event after all samples are received and captured */
	256	static int magn_3d_proc_event(struct hid_sensor_hub_device *hsdev,
	257	unsigned usage_id,
	258	void *priv)
	259	{
	260	struct iio_dev *indio_dev = platform_get_drvdata(priv);
	261	struct magn_3d_state *magn_state = iio_priv(indio_dev);
	262
56ff6be6 SP	263	dev_dbg(&indio_dev->dev, "magn_3d_proc_event\n");
56ff6be6 SP	264	if (atomic_read(&magn_state->common_attributes.data_ready))
03d79558	265	hid_sensor_push_data(indio_dev, magn_state->iio_vals);
bc1d57ba	266
	267	return 0;
	268	}
	269
	270	/* Capture samples in local storage */
	271	static int magn_3d_capture_sample(struct hid_sensor_hub_device *hsdev,
	272	unsigned usage_id,
	273	size_t raw_len, char *raw_data,
	274	void *priv)
	275	{
	276	struct iio_dev *indio_dev = platform_get_drvdata(priv);
	277	struct magn_3d_state *magn_state = iio_priv(indio_dev);
	278	int offset;
2a96540a RA	279	int ret = 0;
2a96540a RA	280	u32 *iio_val = NULL;
bc1d57ba	281
	282	switch (usage_id) {
	283	case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS:
	284	case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Y_AXIS:
	285	case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Z_AXIS:
2a96540a RA	286	offset = (usage_id - HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS)
2a96540a RA	287	+ CHANNEL_SCAN_INDEX_X;
bc1d57ba	288	break;
abea9c62 RA	289	case HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH:
	290	case HID_USAGE_SENSOR_ORIENT_COMP_TRUE_NORTH:
	291	case HID_USAGE_SENSOR_ORIENT_MAGN_NORTH:
	292	case HID_USAGE_SENSOR_ORIENT_TRUE_NORTH:
	293	offset = (usage_id - HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH)
	294	+ CHANNEL_SCAN_INDEX_NORTH_MAGN_TILT_COMP;
bc1d57ba	295	break;
bc1d57ba	296	default:
2a96540a	297	return -EINVAL;
bc1d57ba	298	}
bc1d57ba	299
2a96540a RA	300	iio_val = magn_state->magn_val_addr[offset];
	301
	302	if (iio_val != NULL)
	303	iio_val = ((u32 *)raw_data);
	304	else
	305	ret = -EINVAL;
	306
bc1d57ba	307	return ret;
	308	}
	309
	310	/* Parse report which is specific to an usage id*/
	311	static int magn_3d_parse_report(struct platform_device *pdev,
	312	struct hid_sensor_hub_device *hsdev,
2a96540a RA	313	struct iio_chan_spec **channels,
2a96540a RA	314	int *chan_count,
bc1d57ba	315	unsigned usage_id,
	316	struct magn_3d_state *st)
	317	{
bc1d57ba	318	int i;
2a96540a RA	319	int attr_count = 0;
	320	struct iio_chan_spec *_channels;
	321
	322	/* Scan for each usage attribute supported */
	323	for (i = 0; i < MAGN_3D_CHANNEL_MAX; i++) {
	324	int status;
	325	u32 address = magn_3d_addresses[i];
	326
	327	/* Check if usage attribute exists in the sensor hub device */
	328	status = sensor_hub_input_get_attribute_info(hsdev,
	329	HID_INPUT_REPORT,
	330	usage_id,
	331	address,
	332	&(st->magn[i]));
	333	if (!status)
	334	attr_count++;
	335	}
bc1d57ba	336
2a96540a RA	337	if (attr_count <= 0) {
	338	dev_err(&pdev->dev,
	339	"failed to find any supported usage attributes in report\n");
	340	return -EINVAL;
bc1d57ba	341	}
2a96540a RA	342
	343	dev_dbg(&pdev->dev, "magn_3d Found %d usage attributes\n",
	344	attr_count);
	345	dev_dbg(&pdev->dev, "magn_3d X: %x:%x Y: %x:%x Z: %x:%x\n",
bc1d57ba	346	st->magn[0].index,
	347	st->magn[0].report_id,
	348	st->magn[1].index, st->magn[1].report_id,
	349	st->magn[2].index, st->magn[2].report_id);
	350
2a96540a RA	351	/* Setup IIO channel array */
	352	_channels = devm_kcalloc(&pdev->dev, attr_count,
	353	sizeof(struct iio_chan_spec),
	354	GFP_KERNEL);
	355	if (!_channels) {
	356	dev_err(&pdev->dev,
	357	"failed to allocate space for iio channels\n");
	358	return -ENOMEM;
	359	}
	360
	361	st->iio_vals = devm_kcalloc(&pdev->dev, attr_count,
	362	sizeof(u32),
	363	GFP_KERNEL);
	364	if (!st->iio_vals) {
	365	dev_err(&pdev->dev,
	366	"failed to allocate space for iio values array\n");
	367	return -ENOMEM;
	368	}
	369
	370	for (i = 0, *chan_count = 0;
	371	i < MAGN_3D_CHANNEL_MAX && *chan_count < attr_count;
	372	i++){
	373	if (st->magn[i].index >= 0) {
	374	/* Setup IIO channel struct */
	375	(_channels[*chan_count]) = magn_3d_channels[i];
	376	(_channels[chan_count]).scan_index = chan_count;
	377	(_channels[*chan_count]).address = i;
	378
	379	/* Set magn_val_addr to iio value address */
	380	st->magn_val_addr[i] = &(st->iio_vals[*chan_count]);
	381	magn_3d_adjust_channel_bit_mask(_channels,
	382	*chan_count,
	383	st->magn[i].size);
	384	(*chan_count)++;
	385	}
	386	}
	387
	388	if (*chan_count <= 0) {
	389	dev_err(&pdev->dev,
	390	"failed to find any magnetic channels setup\n");
	391	return -EINVAL;
	392	}
	393
	394	*channels = _channels;
	395
	396	dev_dbg(&pdev->dev, "magn_3d Setup %d IIO channels\n",
	397	*chan_count);
	398
92463fda SP	399	st->scale_precision = hid_sensor_format_scale(
	400	HID_USAGE_SENSOR_COMPASS_3D,
	401	&st->magn[CHANNEL_SCAN_INDEX_X],
	402	&st->scale_pre_decml, &st->scale_post_decml);
	403
2461fc9f SP	404	/* Set Sensitivity field ids, when there is no individual modifier */
	405	if (st->common_attributes.sensitivity.index < 0) {
	406	sensor_hub_input_get_attribute_info(hsdev,
	407	HID_FEATURE_REPORT, usage_id,
	408	HID_USAGE_SENSOR_DATA_MOD_CHANGE_SENSITIVITY_ABS \|
	409	HID_USAGE_SENSOR_DATA_ORIENTATION,
	410	&st->common_attributes.sensitivity);
	411	dev_dbg(&pdev->dev, "Sensitivity index:report %d:%d\n",
	412	st->common_attributes.sensitivity.index,
	413	st->common_attributes.sensitivity.report_id);
	414	}
	415
2a96540a	416	return 0;
bc1d57ba	417	}
	418
	419	/* Function to initialize the processing for usage id */
fc52692c	420	static int hid_magn_3d_probe(struct platform_device *pdev)
bc1d57ba	421	{
	422	int ret = 0;
	423	static char *name = "magn_3d";
	424	struct iio_dev *indio_dev;
	425	struct magn_3d_state *magn_state;
	426	struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
	427	struct iio_chan_spec *channels;
2a96540a	428	int chan_count = 0;
bc1d57ba	429
907c0a0a SK	430	indio_dev = devm_iio_device_alloc(&pdev->dev,
	431	sizeof(struct magn_3d_state));
	432	if (indio_dev == NULL)
	433	return -ENOMEM;
	434
bc1d57ba	435	platform_set_drvdata(pdev, indio_dev);
	436
	437	magn_state = iio_priv(indio_dev);
	438	magn_state->common_attributes.hsdev = hsdev;
	439	magn_state->common_attributes.pdev = pdev;
	440
	441	ret = hid_sensor_parse_common_attributes(hsdev,
	442	HID_USAGE_SENSOR_COMPASS_3D,
	443	&magn_state->common_attributes);
	444	if (ret) {
	445	dev_err(&pdev->dev, "failed to setup common attributes\n");
907c0a0a	446	return ret;
bc1d57ba	447	}
bc1d57ba	448
2a96540a RA	449	ret = magn_3d_parse_report(pdev, hsdev,
2a96540a RA	450	&channels, &chan_count,
bc1d57ba	451	HID_USAGE_SENSOR_COMPASS_3D, magn_state);
bc1d57ba	452	if (ret) {
2a96540a RA	453	dev_err(&pdev->dev, "failed to parse report\n");
2a96540a RA	454	return ret;
bc1d57ba	455	}
	456
	457	indio_dev->channels = channels;
2a96540a	458	indio_dev->num_channels = chan_count;
bc1d57ba	459	indio_dev->dev.parent = &pdev->dev;
	460	indio_dev->info = &magn_3d_info;
	461	indio_dev->name = name;
	462	indio_dev->modes = INDIO_DIRECT_MODE;
	463
	464	ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time,
	465	NULL, NULL);
	466	if (ret) {
	467	dev_err(&pdev->dev, "failed to initialize trigger buffer\n");
2a96540a	468	return ret;
bc1d57ba	469	}
56ff6be6	470	atomic_set(&magn_state->common_attributes.data_ready, 0);
bc1d57ba	471	ret = hid_sensor_setup_trigger(indio_dev, name,
	472	&magn_state->common_attributes);
	473	if (ret < 0) {
	474	dev_err(&pdev->dev, "trigger setup failed\n");
	475	goto error_unreg_buffer_funcs;
	476	}
	477
	478	ret = iio_device_register(indio_dev);
	479	if (ret) {
	480	dev_err(&pdev->dev, "device register failed\n");
	481	goto error_remove_trigger;
	482	}
	483
	484	magn_state->callbacks.send_event = magn_3d_proc_event;
	485	magn_state->callbacks.capture_sample = magn_3d_capture_sample;
	486	magn_state->callbacks.pdev = pdev;
	487	ret = sensor_hub_register_callback(hsdev, HID_USAGE_SENSOR_COMPASS_3D,
	488	&magn_state->callbacks);
	489	if (ret < 0) {
	490	dev_err(&pdev->dev, "callback reg failed\n");
	491	goto error_iio_unreg;
	492	}
	493
	494	return ret;
	495
	496	error_iio_unreg:
	497	iio_device_unregister(indio_dev);
	498	error_remove_trigger:
ec7f68e0	499	hid_sensor_remove_trigger(&magn_state->common_attributes);
bc1d57ba	500	error_unreg_buffer_funcs:
bc1d57ba	501	iio_triggered_buffer_cleanup(indio_dev);
bc1d57ba	502	return ret;
	503	}
	504
	505	/* Function to deinitialize the processing for usage id */
fc52692c	506	static int hid_magn_3d_remove(struct platform_device *pdev)
bc1d57ba	507	{
	508	struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
	509	struct iio_dev *indio_dev = platform_get_drvdata(pdev);
ec7f68e0	510	struct magn_3d_state *magn_state = iio_priv(indio_dev);
bc1d57ba	511
	512	sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_COMPASS_3D);
	513	iio_device_unregister(indio_dev);
ec7f68e0	514	hid_sensor_remove_trigger(&magn_state->common_attributes);
bc1d57ba	515	iio_triggered_buffer_cleanup(indio_dev);
bc1d57ba	516
	517	return 0;
	518	}
	519
a67c385a AH	520	static struct platform_device_id hid_magn_3d_ids[] = {
	521	{
	522	/* Format: HID-SENSOR-usage_id_in_hex_lowercase */
	523	.name = "HID-SENSOR-200083",
	524	},
	525	{ /* sentinel */ }
	526	};
	527	MODULE_DEVICE_TABLE(platform, hid_magn_3d_ids);
	528
bc1d57ba	529	static struct platform_driver hid_magn_3d_platform_driver = {
a67c385a	530	.id_table = hid_magn_3d_ids,
bc1d57ba	531	.driver = {
a67c385a	532	.name = KBUILD_MODNAME,
bc1d57ba	533	},
	534	.probe = hid_magn_3d_probe,
	535	.remove = hid_magn_3d_remove,
	536	};
	537	module_platform_driver(hid_magn_3d_platform_driver);
	538
	539	MODULE_DESCRIPTION("HID Sensor Magnetometer 3D");
	540	MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
	541	MODULE_LICENSE("GPL");