[linux-2.6-block.git] / drivers / hid / hid-sensor-hub.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/hid.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/mfd/core.h>
#include <linux/list.h>
#include <linux/hid-sensor-ids.h>
#include <linux/hid-sensor-hub.h>
#include "hid-ids.h"

/**
 * struct sensor_hub_pending - Synchronous read pending information
 * @status:		Pending status true/false.
 * @ready:		Completion synchronization data.
 * @usage_id:		Usage id for physical device, E.g. Gyro usage id.
 * @attr_usage_id:	Usage Id of a field, E.g. X-AXIS for a gyro.
 * @raw_size:		Response size for a read request.
 * @raw_data:		Place holder for received response.
 */
struct sensor_hub_pending {
	bool status;
	struct completion ready;
	u32 usage_id;
	u32 attr_usage_id;
	int raw_size;
	u8  *raw_data;
};

/**
 * struct sensor_hub_data - Hold a instance data for a HID hub device
 * @hsdev:		Stored hid instance for current hub device.
 * @mutex:		Mutex to serialize synchronous request.
 * @lock:		Spin lock to protect pending request structure.
 * @pending:		Holds information of pending sync read request.
 * @dyn_callback_list:	Holds callback function
 * @dyn_callback_lock:	spin lock to protect callback list
 * @hid_sensor_hub_client_devs:	Stores all MFD cells for a hub instance.
 * @hid_sensor_client_cnt: Number of MFD cells, (no of sensors attached).
 */
struct sensor_hub_data {
	struct hid_sensor_hub_device *hsdev;
	struct mutex mutex;
	spinlock_t lock;
	struct sensor_hub_pending pending;
	struct list_head dyn_callback_list;
	spinlock_t dyn_callback_lock;
	struct mfd_cell *hid_sensor_hub_client_devs;
	int hid_sensor_client_cnt;
};

/**
 * struct hid_sensor_hub_callbacks_list - Stores callback list
 * @list:		list head.
 * @usage_id:		usage id for a physical device.
 * @usage_callback:	Stores registered callback functions.
 * @priv:		Private data for a physical device.
 */
struct hid_sensor_hub_callbacks_list {
	struct list_head list;
	u32 usage_id;
	struct hid_sensor_hub_callbacks *usage_callback;
	void *priv;
};

static struct hid_report *sensor_hub_report(int id, struct hid_device *hdev,
						int dir)
{
	struct hid_report *report;

	list_for_each_entry(report, &hdev->report_enum[dir].report_list, list) {
		if (report->id == id)
			return report;
	}
	hid_warn(hdev, "No report with id 0x%x found\n", id);

	return NULL;
}

static int sensor_hub_get_physical_device_count(
				struct hid_report_enum *report_enum)
{
	struct hid_report *report;
	struct hid_field *field;
	int cnt = 0;

	list_for_each_entry(report, &report_enum->report_list, list) {
		field = report->field[0];
		if (report->maxfield && field && field->physical)
			cnt++;
	}

	return cnt;
}

static void sensor_hub_fill_attr_info(
		struct hid_sensor_hub_attribute_info *info,
		s32 index, s32 report_id, struct hid_field *field)
{
	info->index = index;
	info->report_id = report_id;
	info->units = field->unit;
	info->unit_expo = field->unit_exponent;
	info->size = (field->report_size * field->report_count)/8;
	info->logical_minimum = field->logical_minimum;
	info->logical_maximum = field->logical_maximum;
}

static struct hid_sensor_hub_callbacks *sensor_hub_get_callback(
					struct hid_device *hdev,
					u32 usage_id, void **priv)
{
	struct hid_sensor_hub_callbacks_list *callback;
	struct sensor_hub_data *pdata = hid_get_drvdata(hdev);

	spin_lock(&pdata->dyn_callback_lock);
	list_for_each_entry(callback, &pdata->dyn_callback_list, list)
		if (callback->usage_id == usage_id) {
			*priv = callback->priv;
			spin_unlock(&pdata->dyn_callback_lock);
			return callback->usage_callback;
		}
	spin_unlock(&pdata->dyn_callback_lock);

	return NULL;
}

int sensor_hub_register_callback(struct hid_sensor_hub_device *hsdev,
			u32 usage_id,
			struct hid_sensor_hub_callbacks *usage_callback)
{
	struct hid_sensor_hub_callbacks_list *callback;
	struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);

	spin_lock(&pdata->dyn_callback_lock);
	list_for_each_entry(callback, &pdata->dyn_callback_list, list)
		if (callback->usage_id == usage_id) {
			spin_unlock(&pdata->dyn_callback_lock);
			return -EINVAL;
		}
	callback = kzalloc(sizeof(*callback), GFP_ATOMIC);
	if (!callback) {
		spin_unlock(&pdata->dyn_callback_lock);
		return -ENOMEM;
	}
	callback->usage_callback = usage_callback;
	callback->usage_id = usage_id;
	callback->priv = NULL;
	list_add_tail(&callback->list, &pdata->dyn_callback_list);
	spin_unlock(&pdata->dyn_callback_lock);

	return 0;
}
EXPORT_SYMBOL_GPL(sensor_hub_register_callback);

int sensor_hub_remove_callback(struct hid_sensor_hub_device *hsdev,
				u32 usage_id)
{
	struct hid_sensor_hub_callbacks_list *callback;
	struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);

	spin_lock(&pdata->dyn_callback_lock);
	list_for_each_entry(callback, &pdata->dyn_callback_list, list)
		if (callback->usage_id == usage_id) {
			list_del(&callback->list);
			kfree(callback);
			break;
		}
	spin_unlock(&pdata->dyn_callback_lock);

	return 0;
}
EXPORT_SYMBOL_GPL(sensor_hub_remove_callback);

int sensor_hub_set_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
				u32 field_index, s32 value)
{
	struct hid_report *report;
	struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
	int ret = 0;

	mutex_lock(&data->mutex);
	report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
	if (!report || (field_index >= report->maxfield)) {
		ret = -EINVAL;
		goto done_proc;
	}
	hid_set_field(report->field[field_index], 0, value);
	hid_hw_request(hsdev->hdev, report, HID_REQ_SET_REPORT);
	hid_hw_wait(hsdev->hdev);

done_proc:
	mutex_unlock(&data->mutex);

	return ret;
}
EXPORT_SYMBOL_GPL(sensor_hub_set_feature);

int sensor_hub_get_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
				u32 field_index, s32 *value)
{
	struct hid_report *report;
	struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
	int ret = 0;

	mutex_lock(&data->mutex);
	report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
	if (!report || (field_index >= report->maxfield) ||
	    report->field[field_index]->report_count < 1) {
		ret = -EINVAL;
		goto done_proc;
	}
	hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
	hid_hw_wait(hsdev->hdev);
	*value = report->field[field_index]->value[0];

done_proc:
	mutex_unlock(&data->mutex);

	return ret;
}
EXPORT_SYMBOL_GPL(sensor_hub_get_feature);


int sensor_hub_input_attr_get_raw_value(struct hid_sensor_hub_device *hsdev,
					u32 usage_id,
					u32 attr_usage_id, u32 report_id)
{
	struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
	unsigned long flags;
	struct hid_report *report;
	int ret_val = 0;

	mutex_lock(&data->mutex);
	memset(&data->pending, 0, sizeof(data->pending));
	init_completion(&data->pending.ready);
	data->pending.usage_id = usage_id;
	data->pending.attr_usage_id = attr_usage_id;
	data->pending.raw_size = 0;

	spin_lock_irqsave(&data->lock, flags);
	data->pending.status = true;
	report = sensor_hub_report(report_id, hsdev->hdev, HID_INPUT_REPORT);
	if (!report) {
		spin_unlock_irqrestore(&data->lock, flags);
		goto err_free;
	}
	hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
	spin_unlock_irqrestore(&data->lock, flags);
	wait_for_completion_interruptible_timeout(&data->pending.ready, HZ*5);
	switch (data->pending.raw_size) {
	case 1:
		ret_val = *(u8 *)data->pending.raw_data;
		break;
	case 2:
		ret_val = *(u16 *)data->pending.raw_data;
		break;
	case 4:
		ret_val = *(u32 *)data->pending.raw_data;
		break;
	default:
		ret_val = 0;
	}
	kfree(data->pending.raw_data);

err_free:
	data->pending.status = false;
	mutex_unlock(&data->mutex);

	return ret_val;
}
EXPORT_SYMBOL_GPL(sensor_hub_input_attr_get_raw_value);

int sensor_hub_input_get_attribute_info(struct hid_sensor_hub_device *hsdev,
				u8 type,
				u32 usage_id,
				u32 attr_usage_id,
				struct hid_sensor_hub_attribute_info *info)
{
	int ret = -1;
	int i, j;
	int collection_index = -1;
	struct hid_report *report;
	struct hid_field *field;
	struct hid_report_enum *report_enum;
	struct hid_device *hdev = hsdev->hdev;

	/* Initialize with defaults */
	info->usage_id = usage_id;
	info->attrib_id = attr_usage_id;
	info->report_id = -1;
	info->index = -1;
	info->units = -1;
	info->unit_expo = -1;

	for (i = 0; i < hdev->maxcollection; ++i) {
		struct hid_collection *collection = &hdev->collection[i];
		if (usage_id == collection->usage) {
			collection_index = i;
			break;
		}
	}
	if (collection_index == -1)
		goto err_ret;

	report_enum = &hdev->report_enum[type];
	list_for_each_entry(report, &report_enum->report_list, list) {
		for (i = 0; i < report->maxfield; ++i) {
			field = report->field[i];
			if (field->physical == usage_id &&
				field->logical == attr_usage_id) {
				sensor_hub_fill_attr_info(info, i, report->id,
							  field);
				ret = 0;
			} else {
				for (j = 0; j < field->maxusage; ++j) {
					if (field->usage[j].hid ==
					attr_usage_id &&
					field->usage[j].collection_index ==
					collection_index) {
						sensor_hub_fill_attr_info(info,
							  i, report->id, field);
						ret = 0;
						break;
					}
				}
			}
			if (ret == 0)
				break;
		}
	}

err_ret:
	return ret;
}
EXPORT_SYMBOL_GPL(sensor_hub_input_get_attribute_info);

#ifdef CONFIG_PM
static int sensor_hub_suspend(struct hid_device *hdev, pm_message_t message)
{
	struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
	struct hid_sensor_hub_callbacks_list *callback;

	hid_dbg(hdev, " sensor_hub_suspend\n");
	spin_lock(&pdata->dyn_callback_lock);
	list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
		if (callback->usage_callback->suspend)
			callback->usage_callback->suspend(
					pdata->hsdev, callback->priv);
	}
	spin_unlock(&pdata->dyn_callback_lock);

	return 0;
}

static int sensor_hub_resume(struct hid_device *hdev)
{
	struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
	struct hid_sensor_hub_callbacks_list *callback;

	hid_dbg(hdev, " sensor_hub_resume\n");
	spin_lock(&pdata->dyn_callback_lock);
	list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
		if (callback->usage_callback->resume)
			callback->usage_callback->resume(
					pdata->hsdev, callback->priv);
	}
	spin_unlock(&pdata->dyn_callback_lock);

	return 0;
}

static int sensor_hub_reset_resume(struct hid_device *hdev)
{
	return 0;
}
#endif

/*
 * Handle raw report as sent by device
 */
static int sensor_hub_raw_event(struct hid_device *hdev,
		struct hid_report *report, u8 *raw_data, int size)
{
	int i;
	u8 *ptr;
	int sz;
	struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
	unsigned long flags;
	struct hid_sensor_hub_callbacks *callback = NULL;
	struct hid_collection *collection = NULL;
	void *priv = NULL;

	hid_dbg(hdev, "sensor_hub_raw_event report id:0x%x size:%d type:%d\n",
			 report->id, size, report->type);
	hid_dbg(hdev, "maxfield:%d\n", report->maxfield);
	if (report->type != HID_INPUT_REPORT)
		return 1;

	ptr = raw_data;
	ptr++; /* Skip report id */

	spin_lock_irqsave(&pdata->lock, flags);

	for (i = 0; i < report->maxfield; ++i) {
		hid_dbg(hdev, "%d collection_index:%x hid:%x sz:%x\n",
				i, report->field[i]->usage->collection_index,
				report->field[i]->usage->hid,
				(report->field[i]->report_size *
					report->field[i]->report_count)/8);
		sz = (report->field[i]->report_size *
					report->field[i]->report_count)/8;
		if (pdata->pending.status && pdata->pending.attr_usage_id ==
				report->field[i]->usage->hid) {
			hid_dbg(hdev, "data was pending ...\n");
			pdata->pending.raw_data = kmemdup(ptr, sz, GFP_ATOMIC);
			if (pdata->pending.raw_data)
				pdata->pending.raw_size = sz;
			else
				pdata->pending.raw_size = 0;
			complete(&pdata->pending.ready);
		}
		collection = &hdev->collection[
				report->field[i]->usage->collection_index];
		hid_dbg(hdev, "collection->usage %x\n",
					collection->usage);
		callback = sensor_hub_get_callback(pdata->hsdev->hdev,
						report->field[i]->physical,
							&priv);
		if (callback && callback->capture_sample) {
			if (report->field[i]->logical)
				callback->capture_sample(pdata->hsdev,
					report->field[i]->logical, sz, ptr,
					callback->pdev);
			else
				callback->capture_sample(pdata->hsdev,
					report->field[i]->usage->hid, sz, ptr,
					callback->pdev);
		}
		ptr += sz;
	}
	if (callback && collection && callback->send_event)
		callback->send_event(pdata->hsdev, collection->usage,
				callback->pdev);
	spin_unlock_irqrestore(&pdata->lock, flags);

	return 1;
}

int sensor_hub_device_open(struct hid_sensor_hub_device *hsdev)
{
	int ret = 0;
	struct sensor_hub_data *data =  hid_get_drvdata(hsdev->hdev);

	mutex_lock(&data->mutex);
	if (!hsdev->ref_cnt) {
		ret = hid_hw_open(hsdev->hdev);
		if (ret) {
			hid_err(hsdev->hdev, "failed to open hid device\n");
			mutex_unlock(&data->mutex);
			return ret;
		}
	}
	hsdev->ref_cnt++;
	mutex_unlock(&data->mutex);

	return ret;
}
EXPORT_SYMBOL_GPL(sensor_hub_device_open);

void sensor_hub_device_close(struct hid_sensor_hub_device *hsdev)
{
	struct sensor_hub_data *data =  hid_get_drvdata(hsdev->hdev);

	mutex_lock(&data->mutex);
	hsdev->ref_cnt--;
	if (!hsdev->ref_cnt)
		hid_hw_close(hsdev->hdev);
	mutex_unlock(&data->mutex);
}
EXPORT_SYMBOL_GPL(sensor_hub_device_close);

static int sensor_hub_probe(struct hid_device *hdev,
				const struct hid_device_id *id)
{
	int ret;
	struct sensor_hub_data *sd;
	int i;
	char *name;
	struct hid_report *report;
	struct hid_report_enum *report_enum;
	struct hid_field *field;
	int dev_cnt;

	sd = devm_kzalloc(&hdev->dev, sizeof(*sd), GFP_KERNEL);
	if (!sd) {
		hid_err(hdev, "cannot allocate Sensor data\n");
		return -ENOMEM;
	}
	sd->hsdev = devm_kzalloc(&hdev->dev, sizeof(*sd->hsdev), GFP_KERNEL);
	if (!sd->hsdev) {
		hid_err(hdev, "cannot allocate hid_sensor_hub_device\n");
		return -ENOMEM;
	}
	hid_set_drvdata(hdev, sd);
	sd->hsdev->hdev = hdev;
	sd->hsdev->vendor_id = hdev->vendor;
	sd->hsdev->product_id = hdev->product;
	spin_lock_init(&sd->lock);
	spin_lock_init(&sd->dyn_callback_lock);
	mutex_init(&sd->mutex);
	ret = hid_parse(hdev);
	if (ret) {
		hid_err(hdev, "parse failed\n");
		return ret;
	}
	INIT_LIST_HEAD(&hdev->inputs);

	ret = hid_hw_start(hdev, 0);
	if (ret) {
		hid_err(hdev, "hw start failed\n");
		return ret;
	}
	INIT_LIST_HEAD(&sd->dyn_callback_list);
	sd->hid_sensor_client_cnt = 0;
	report_enum = &hdev->report_enum[HID_INPUT_REPORT];

	dev_cnt = sensor_hub_get_physical_device_count(report_enum);
	if (dev_cnt > HID_MAX_PHY_DEVICES) {
		hid_err(hdev, "Invalid Physical device count\n");
		ret = -EINVAL;
		goto err_stop_hw;
	}
	sd->hid_sensor_hub_client_devs = kzalloc(dev_cnt *
						sizeof(struct mfd_cell),
						GFP_KERNEL);
	if (sd->hid_sensor_hub_client_devs == NULL) {
		hid_err(hdev, "Failed to allocate memory for mfd cells\n");
			ret = -ENOMEM;
			goto err_stop_hw;
	}
	list_for_each_entry(report, &report_enum->report_list, list) {
		hid_dbg(hdev, "Report id:%x\n", report->id);
		field = report->field[0];
		if (report->maxfield && field &&
					field->physical) {
			name = kasprintf(GFP_KERNEL, "HID-SENSOR-%x",
						field->physical);
			if (name == NULL) {
				hid_err(hdev, "Failed MFD device name\n");
					ret = -ENOMEM;
					goto err_free_names;
			}
			sd->hid_sensor_hub_client_devs[
				sd->hid_sensor_client_cnt].id = PLATFORM_DEVID_AUTO;
			sd->hid_sensor_hub_client_devs[
				sd->hid_sensor_client_cnt].name = name;
			sd->hid_sensor_hub_client_devs[
				sd->hid_sensor_client_cnt].platform_data =
						sd->hsdev;
			sd->hid_sensor_hub_client_devs[
				sd->hid_sensor_client_cnt].pdata_size =
						sizeof(*sd->hsdev);
			hid_dbg(hdev, "Adding %s:%p\n", name, sd);
			sd->hid_sensor_client_cnt++;
		}
	}
	ret = mfd_add_devices(&hdev->dev, 0, sd->hid_sensor_hub_client_devs,
		sd->hid_sensor_client_cnt, NULL, 0, NULL);
	if (ret < 0)
		goto err_free_names;

	return ret;

err_free_names:
	for (i = 0; i < sd->hid_sensor_client_cnt ; ++i)
		kfree(sd->hid_sensor_hub_client_devs[i].name);
	kfree(sd->hid_sensor_hub_client_devs);
err_stop_hw:
	hid_hw_stop(hdev);

	return ret;
}

static void sensor_hub_remove(struct hid_device *hdev)
{
	struct sensor_hub_data *data = hid_get_drvdata(hdev);
	unsigned long flags;
	int i;

	hid_dbg(hdev, " hardware removed\n");
	hid_hw_close(hdev);
	hid_hw_stop(hdev);
	spin_lock_irqsave(&data->lock, flags);
	if (data->pending.status)
		complete(&data->pending.ready);
	spin_unlock_irqrestore(&data->lock, flags);
	mfd_remove_devices(&hdev->dev);
	for (i = 0; i < data->hid_sensor_client_cnt ; ++i)
		kfree(data->hid_sensor_hub_client_devs[i].name);
	kfree(data->hid_sensor_hub_client_devs);
	hid_set_drvdata(hdev, NULL);
	mutex_destroy(&data->mutex);
}

static const struct hid_device_id sensor_hub_devices[] = {
	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, HID_ANY_ID,
		     HID_ANY_ID) },
	{ }
};
MODULE_DEVICE_TABLE(hid, sensor_hub_devices);

static struct hid_driver sensor_hub_driver = {
	.name = "hid-sensor-hub",
	.id_table = sensor_hub_devices,
	.probe = sensor_hub_probe,
	.remove = sensor_hub_remove,
	.raw_event = sensor_hub_raw_event,
#ifdef CONFIG_PM
	.suspend = sensor_hub_suspend,
	.resume = sensor_hub_resume,
	.reset_resume = sensor_hub_reset_resume,
#endif
};
module_hid_driver(sensor_hub_driver);

MODULE_DESCRIPTION("HID Sensor Hub driver");
MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
MODULE_LICENSE("GPL");
Commit	Line	Data
401ca24f	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/hid.h>
401ca24f	21	#include <linux/module.h>
	22	#include <linux/slab.h>
	23	#include <linux/mfd/core.h>
	24	#include <linux/list.h>
	25	#include <linux/hid-sensor-ids.h>
	26	#include <linux/hid-sensor-hub.h>
	27	#include "hid-ids.h"
	28
	29	/**
	30	* struct sensor_hub_pending - Synchronous read pending information
	31	* @status: Pending status true/false.
	32	* @ready: Completion synchronization data.
	33	* @usage_id: Usage id for physical device, E.g. Gyro usage id.
	34	* @attr_usage_id: Usage Id of a field, E.g. X-AXIS for a gyro.
	35	* @raw_size: Response size for a read request.
	36	* @raw_data: Place holder for received response.
	37	*/
	38	struct sensor_hub_pending {
	39	bool status;
	40	struct completion ready;
	41	u32 usage_id;
	42	u32 attr_usage_id;
	43	int raw_size;
	44	u8 *raw_data;
	45	};
	46
	47	/**
	48	* struct sensor_hub_data - Hold a instance data for a HID hub device
	49	* @hsdev: Stored hid instance for current hub device.
	50	* @mutex: Mutex to serialize synchronous request.
	51	* @lock: Spin lock to protect pending request structure.
	52	* @pending: Holds information of pending sync read request.
	53	* @dyn_callback_list: Holds callback function
	54	* @dyn_callback_lock: spin lock to protect callback list
	55	* @hid_sensor_hub_client_devs: Stores all MFD cells for a hub instance.
	56	* @hid_sensor_client_cnt: Number of MFD cells, (no of sensors attached).
	57	*/
	58	struct sensor_hub_data {
	59	struct hid_sensor_hub_device *hsdev;
	60	struct mutex mutex;
	61	spinlock_t lock;
	62	struct sensor_hub_pending pending;
	63	struct list_head dyn_callback_list;
	64	spinlock_t dyn_callback_lock;
	65	struct mfd_cell *hid_sensor_hub_client_devs;
	66	int hid_sensor_client_cnt;
	67	};
	68
	69	/**
	70	* struct hid_sensor_hub_callbacks_list - Stores callback list
	71	* @list: list head.
	72	* @usage_id: usage id for a physical device.
	73	* @usage_callback: Stores registered callback functions.
	74	* @priv: Private data for a physical device.
	75	*/
	76	struct hid_sensor_hub_callbacks_list {
	77	struct list_head list;
	78	u32 usage_id;
	79	struct hid_sensor_hub_callbacks *usage_callback;
	80	void *priv;
	81	};
	82
401ca24f	83	static struct hid_report sensor_hub_report(int id, struct hid_device hdev,
	84	int dir)
	85	{
	86	struct hid_report *report;
	87
	88	list_for_each_entry(report, &hdev->report_enum[dir].report_list, list) {
	89	if (report->id == id)
	90	return report;
	91	}
	92	hid_warn(hdev, "No report with id 0x%x found\n", id);
	93
	94	return NULL;
	95	}
	96
	97	static int sensor_hub_get_physical_device_count(
	98	struct hid_report_enum *report_enum)
	99	{
	100	struct hid_report *report;
	101	struct hid_field *field;
	102	int cnt = 0;
	103
	104	list_for_each_entry(report, &report_enum->report_list, list) {
	105	field = report->field[0];
5902fde1	106	if (report->maxfield && field && field->physical)
401ca24f	107	cnt++;
	108	}
	109
	110	return cnt;
	111	}
	112
	113	static void sensor_hub_fill_attr_info(
	114	struct hid_sensor_hub_attribute_info *info,
9f740ffa	115	s32 index, s32 report_id, struct hid_field *field)
401ca24f	116	{
	117	info->index = index;
	118	info->report_id = report_id;
9f740ffa SP	119	info->units = field->unit;
	120	info->unit_expo = field->unit_exponent;
	121	info->size = (field->report_size * field->report_count)/8;
	122	info->logical_minimum = field->logical_minimum;
	123	info->logical_maximum = field->logical_maximum;
401ca24f	124	}
	125
	126	static struct hid_sensor_hub_callbacks *sensor_hub_get_callback(
	127	struct hid_device *hdev,
	128	u32 usage_id, void **priv)
	129	{
	130	struct hid_sensor_hub_callbacks_list *callback;
	131	struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
	132
	133	spin_lock(&pdata->dyn_callback_lock);
	134	list_for_each_entry(callback, &pdata->dyn_callback_list, list)
	135	if (callback->usage_id == usage_id) {
	136	*priv = callback->priv;
	137	spin_unlock(&pdata->dyn_callback_lock);
	138	return callback->usage_callback;
	139	}
	140	spin_unlock(&pdata->dyn_callback_lock);
	141
	142	return NULL;
	143	}
	144
	145	int sensor_hub_register_callback(struct hid_sensor_hub_device *hsdev,
	146	u32 usage_id,
	147	struct hid_sensor_hub_callbacks *usage_callback)
	148	{
	149	struct hid_sensor_hub_callbacks_list *callback;
	150	struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);
	151
	152	spin_lock(&pdata->dyn_callback_lock);
	153	list_for_each_entry(callback, &pdata->dyn_callback_list, list)
	154	if (callback->usage_id == usage_id) {
	155	spin_unlock(&pdata->dyn_callback_lock);
	156	return -EINVAL;
	157	}
2b7c4b8e	158	callback = kzalloc(sizeof(*callback), GFP_ATOMIC);
401ca24f	159	if (!callback) {
	160	spin_unlock(&pdata->dyn_callback_lock);
	161	return -ENOMEM;
	162	}
	163	callback->usage_callback = usage_callback;
	164	callback->usage_id = usage_id;
	165	callback->priv = NULL;
	166	list_add_tail(&callback->list, &pdata->dyn_callback_list);
	167	spin_unlock(&pdata->dyn_callback_lock);
	168
	169	return 0;
	170	}
	171	EXPORT_SYMBOL_GPL(sensor_hub_register_callback);
	172
	173	int sensor_hub_remove_callback(struct hid_sensor_hub_device *hsdev,
	174	u32 usage_id)
	175	{
	176	struct hid_sensor_hub_callbacks_list *callback;
	177	struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);
	178
	179	spin_lock(&pdata->dyn_callback_lock);
	180	list_for_each_entry(callback, &pdata->dyn_callback_list, list)
	181	if (callback->usage_id == usage_id) {
	182	list_del(&callback->list);
	183	kfree(callback);
	184	break;
	185	}
	186	spin_unlock(&pdata->dyn_callback_lock);
	187
	188	return 0;
	189	}
	190	EXPORT_SYMBOL_GPL(sensor_hub_remove_callback);
	191
	192	int sensor_hub_set_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
	193	u32 field_index, s32 value)
	194	{
	195	struct hid_report *report;
5902fde1	196	struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
401ca24f	197	int ret = 0;
401ca24f	198
401ca24f	199	mutex_lock(&data->mutex);
401ca24f	200	report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
5902fde1	201	if (!report \|\| (field_index >= report->maxfield)) {
401ca24f	202	ret = -EINVAL;
	203	goto done_proc;
	204	}
	205	hid_set_field(report->field[field_index], 0, value);
d8814272	206	hid_hw_request(hsdev->hdev, report, HID_REQ_SET_REPORT);
b7966a4d	207	hid_hw_wait(hsdev->hdev);
401ca24f	208
	209	done_proc:
	210	mutex_unlock(&data->mutex);
	211
	212	return ret;
	213	}
	214	EXPORT_SYMBOL_GPL(sensor_hub_set_feature);
	215
	216	int sensor_hub_get_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
	217	u32 field_index, s32 *value)
	218	{
	219	struct hid_report *report;
5902fde1	220	struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
401ca24f	221	int ret = 0;
401ca24f	222
401ca24f	223	mutex_lock(&data->mutex);
401ca24f	224	report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
4e5a494e	225	if (!report \|\| (field_index >= report->maxfield) \|\|
9e891025	226	report->field[field_index]->report_count < 1) {
401ca24f	227	ret = -EINVAL;
	228	goto done_proc;
	229	}
d8814272	230	hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
b7966a4d	231	hid_hw_wait(hsdev->hdev);
401ca24f	232	*value = report->field[field_index]->value[0];
	233
	234	done_proc:
	235	mutex_unlock(&data->mutex);
	236
	237	return ret;
	238	}
	239	EXPORT_SYMBOL_GPL(sensor_hub_get_feature);
	240
	241
	242	int sensor_hub_input_attr_get_raw_value(struct hid_sensor_hub_device *hsdev,
	243	u32 usage_id,
	244	u32 attr_usage_id, u32 report_id)
	245	{
5902fde1	246	struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
401ca24f	247	unsigned long flags;
	248	struct hid_report *report;
	249	int ret_val = 0;
	250
401ca24f	251	mutex_lock(&data->mutex);
	252	memset(&data->pending, 0, sizeof(data->pending));
	253	init_completion(&data->pending.ready);
	254	data->pending.usage_id = usage_id;
	255	data->pending.attr_usage_id = attr_usage_id;
	256	data->pending.raw_size = 0;
	257
	258	spin_lock_irqsave(&data->lock, flags);
	259	data->pending.status = true;
	260	report = sensor_hub_report(report_id, hsdev->hdev, HID_INPUT_REPORT);
	261	if (!report) {
	262	spin_unlock_irqrestore(&data->lock, flags);
	263	goto err_free;
	264	}
d8814272	265	hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
401ca24f	266	spin_unlock_irqrestore(&data->lock, flags);
	267	wait_for_completion_interruptible_timeout(&data->pending.ready, HZ*5);
	268	switch (data->pending.raw_size) {
	269	case 1:
	270	ret_val = (u8 )data->pending.raw_data;
	271	break;
	272	case 2:
	273	ret_val = (u16 )data->pending.raw_data;
	274	break;
	275	case 4:
	276	ret_val = (u32 )data->pending.raw_data;
	277	break;
	278	default:
	279	ret_val = 0;
	280	}
	281	kfree(data->pending.raw_data);
	282
	283	err_free:
	284	data->pending.status = false;
	285	mutex_unlock(&data->mutex);
	286
	287	return ret_val;
	288	}
	289	EXPORT_SYMBOL_GPL(sensor_hub_input_attr_get_raw_value);
	290
	291	int sensor_hub_input_get_attribute_info(struct hid_sensor_hub_device *hsdev,
	292	u8 type,
	293	u32 usage_id,
	294	u32 attr_usage_id,
	295	struct hid_sensor_hub_attribute_info *info)
	296	{
	297	int ret = -1;
	298	int i, j;
	299	int collection_index = -1;
	300	struct hid_report *report;
	301	struct hid_field *field;
	302	struct hid_report_enum *report_enum;
	303	struct hid_device *hdev = hsdev->hdev;
	304
	305	/* Initialize with defaults */
	306	info->usage_id = usage_id;
5902fde1	307	info->attrib_id = attr_usage_id;
401ca24f	308	info->report_id = -1;
	309	info->index = -1;
	310	info->units = -1;
	311	info->unit_expo = -1;
	312
	313	for (i = 0; i < hdev->maxcollection; ++i) {
	314	struct hid_collection *collection = &hdev->collection[i];
	315	if (usage_id == collection->usage) {
	316	collection_index = i;
	317	break;
	318	}
	319	}
	320	if (collection_index == -1)
	321	goto err_ret;
	322
	323	report_enum = &hdev->report_enum[type];
	324	list_for_each_entry(report, &report_enum->report_list, list) {
	325	for (i = 0; i < report->maxfield; ++i) {
	326	field = report->field[i];
	327	if (field->physical == usage_id &&
	328	field->logical == attr_usage_id) {
	329	sensor_hub_fill_attr_info(info, i, report->id,
9f740ffa	330	field);
401ca24f	331	ret = 0;
	332	} else {
	333	for (j = 0; j < field->maxusage; ++j) {
	334	if (field->usage[j].hid ==
	335	attr_usage_id &&
	336	field->usage[j].collection_index ==
5902fde1	337	collection_index) {
401ca24f	338	sensor_hub_fill_attr_info(info,
9f740ffa	339	i, report->id, field);
401ca24f	340	ret = 0;
	341	break;
	342	}
	343	}
	344	}
	345	if (ret == 0)
	346	break;
	347	}
	348	}
	349
	350	err_ret:
	351	return ret;
	352	}
	353	EXPORT_SYMBOL_GPL(sensor_hub_input_get_attribute_info);
	354
	355	#ifdef CONFIG_PM
	356	static int sensor_hub_suspend(struct hid_device *hdev, pm_message_t message)
	357	{
5902fde1	358	struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
401ca24f	359	struct hid_sensor_hub_callbacks_list *callback;
	360
	361	hid_dbg(hdev, " sensor_hub_suspend\n");
	362	spin_lock(&pdata->dyn_callback_lock);
	363	list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
	364	if (callback->usage_callback->suspend)
	365	callback->usage_callback->suspend(
	366	pdata->hsdev, callback->priv);
	367	}
	368	spin_unlock(&pdata->dyn_callback_lock);
	369
	370	return 0;
	371	}
	372
	373	static int sensor_hub_resume(struct hid_device *hdev)
	374	{
5902fde1	375	struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
401ca24f	376	struct hid_sensor_hub_callbacks_list *callback;
	377
	378	hid_dbg(hdev, " sensor_hub_resume\n");
	379	spin_lock(&pdata->dyn_callback_lock);
	380	list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
	381	if (callback->usage_callback->resume)
	382	callback->usage_callback->resume(
	383	pdata->hsdev, callback->priv);
	384	}
	385	spin_unlock(&pdata->dyn_callback_lock);
	386
	387	return 0;
	388	}
	389
	390	static int sensor_hub_reset_resume(struct hid_device *hdev)
	391	{
	392	return 0;
	393	}
	394	#endif
5902fde1	395
401ca24f	396	/*
	397	* Handle raw report as sent by device
	398	*/
	399	static int sensor_hub_raw_event(struct hid_device *hdev,
	400	struct hid_report report, u8 raw_data, int size)
	401	{
	402	int i;
	403	u8 *ptr;
	404	int sz;
	405	struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
	406	unsigned long flags;
	407	struct hid_sensor_hub_callbacks *callback = NULL;
	408	struct hid_collection *collection = NULL;
	409	void *priv = NULL;
	410
	411	hid_dbg(hdev, "sensor_hub_raw_event report id:0x%x size:%d type:%d\n",
	412	report->id, size, report->type);
	413	hid_dbg(hdev, "maxfield:%d\n", report->maxfield);
	414	if (report->type != HID_INPUT_REPORT)
	415	return 1;
	416
	417	ptr = raw_data;
15261f6d	418	ptr++; /* Skip report id */
401ca24f	419
401ca24f	420	spin_lock_irqsave(&pdata->lock, flags);
	421
	422	for (i = 0; i < report->maxfield; ++i) {
401ca24f	423	hid_dbg(hdev, "%d collection_index:%x hid:%x sz:%x\n",
	424	i, report->field[i]->usage->collection_index,
	425	report->field[i]->usage->hid,
d4b1bba7 SP	426	(report->field[i]->report_size *
	427	report->field[i]->report_count)/8);
	428	sz = (report->field[i]->report_size *
	429	report->field[i]->report_count)/8;
401ca24f	430	if (pdata->pending.status && pdata->pending.attr_usage_id ==
	431	report->field[i]->usage->hid) {
	432	hid_dbg(hdev, "data was pending ...\n");
7b0692f1 AS	433	pdata->pending.raw_data = kmemdup(ptr, sz, GFP_ATOMIC);
7b0692f1 AS	434	if (pdata->pending.raw_data)
5902fde1	435	pdata->pending.raw_size = sz;
7b0692f1	436	else
401ca24f	437	pdata->pending.raw_size = 0;
	438	complete(&pdata->pending.ready);
	439	}
	440	collection = &hdev->collection[
	441	report->field[i]->usage->collection_index];
	442	hid_dbg(hdev, "collection->usage %x\n",
	443	collection->usage);
	444	callback = sensor_hub_get_callback(pdata->hsdev->hdev,
	445	report->field[i]->physical,
	446	&priv);
	447	if (callback && callback->capture_sample) {
	448	if (report->field[i]->logical)
	449	callback->capture_sample(pdata->hsdev,
	450	report->field[i]->logical, sz, ptr,
	451	callback->pdev);
	452	else
	453	callback->capture_sample(pdata->hsdev,
	454	report->field[i]->usage->hid, sz, ptr,
	455	callback->pdev);
	456	}
	457	ptr += sz;
	458	}
	459	if (callback && collection && callback->send_event)
	460	callback->send_event(pdata->hsdev, collection->usage,
	461	callback->pdev);
	462	spin_unlock_irqrestore(&pdata->lock, flags);
	463
401ca24f	464	return 1;
	465	}
	466
1df3a401 SP	467	int sensor_hub_device_open(struct hid_sensor_hub_device *hsdev)
	468	{
	469	int ret = 0;
	470	struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
	471
	472	mutex_lock(&data->mutex);
	473	if (!hsdev->ref_cnt) {
	474	ret = hid_hw_open(hsdev->hdev);
	475	if (ret) {
	476	hid_err(hsdev->hdev, "failed to open hid device\n");
	477	mutex_unlock(&data->mutex);
	478	return ret;
	479	}
	480	}
	481	hsdev->ref_cnt++;
	482	mutex_unlock(&data->mutex);
	483
	484	return ret;
	485	}
	486	EXPORT_SYMBOL_GPL(sensor_hub_device_open);
	487
	488	void sensor_hub_device_close(struct hid_sensor_hub_device *hsdev)
	489	{
	490	struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
	491
	492	mutex_lock(&data->mutex);
	493	hsdev->ref_cnt--;
	494	if (!hsdev->ref_cnt)
	495	hid_hw_close(hsdev->hdev);
	496	mutex_unlock(&data->mutex);
	497	}
	498	EXPORT_SYMBOL_GPL(sensor_hub_device_close);
	499
401ca24f	500	static int sensor_hub_probe(struct hid_device *hdev,
	501	const struct hid_device_id *id)
	502	{
	503	int ret;
	504	struct sensor_hub_data *sd;
	505	int i;
	506	char *name;
	507	struct hid_report *report;
	508	struct hid_report_enum *report_enum;
	509	struct hid_field *field;
	510	int dev_cnt;
	511
905cc199	512	sd = devm_kzalloc(&hdev->dev, sizeof(*sd), GFP_KERNEL);
401ca24f	513	if (!sd) {
	514	hid_err(hdev, "cannot allocate Sensor data\n");
	515	return -ENOMEM;
	516	}
905cc199	517	sd->hsdev = devm_kzalloc(&hdev->dev, sizeof(*sd->hsdev), GFP_KERNEL);
401ca24f	518	if (!sd->hsdev) {
401ca24f	519	hid_err(hdev, "cannot allocate hid_sensor_hub_device\n");
905cc199	520	return -ENOMEM;
401ca24f	521	}
	522	hid_set_drvdata(hdev, sd);
	523	sd->hsdev->hdev = hdev;
	524	sd->hsdev->vendor_id = hdev->vendor;
	525	sd->hsdev->product_id = hdev->product;
	526	spin_lock_init(&sd->lock);
	527	spin_lock_init(&sd->dyn_callback_lock);
	528	mutex_init(&sd->mutex);
	529	ret = hid_parse(hdev);
	530	if (ret) {
	531	hid_err(hdev, "parse failed\n");
905cc199	532	return ret;
401ca24f	533	}
401ca24f	534	INIT_LIST_HEAD(&hdev->inputs);
401ca24f	535
401ca24f	536	ret = hid_hw_start(hdev, 0);
	537	if (ret) {
	538	hid_err(hdev, "hw start failed\n");
905cc199	539	return ret;
401ca24f	540	}
401ca24f	541	INIT_LIST_HEAD(&sd->dyn_callback_list);
	542	sd->hid_sensor_client_cnt = 0;
	543	report_enum = &hdev->report_enum[HID_INPUT_REPORT];
	544
	545	dev_cnt = sensor_hub_get_physical_device_count(report_enum);
	546	if (dev_cnt > HID_MAX_PHY_DEVICES) {
	547	hid_err(hdev, "Invalid Physical device count\n");
	548	ret = -EINVAL;
1df3a401	549	goto err_stop_hw;
401ca24f	550	}
	551	sd->hid_sensor_hub_client_devs = kzalloc(dev_cnt *
	552	sizeof(struct mfd_cell),
	553	GFP_KERNEL);
	554	if (sd->hid_sensor_hub_client_devs == NULL) {
f2f13a68	555	hid_err(hdev, "Failed to allocate memory for mfd cells\n");
401ca24f	556	ret = -ENOMEM;
1df3a401	557	goto err_stop_hw;
401ca24f	558	}
	559	list_for_each_entry(report, &report_enum->report_list, list) {
	560	hid_dbg(hdev, "Report id:%x\n", report->id);
	561	field = report->field[0];
	562	if (report->maxfield && field &&
	563	field->physical) {
	564	name = kasprintf(GFP_KERNEL, "HID-SENSOR-%x",
	565	field->physical);
5902fde1	566	if (name == NULL) {
f2f13a68	567	hid_err(hdev, "Failed MFD device name\n");
401ca24f	568	ret = -ENOMEM;
f2f13a68	569	goto err_free_names;
401ca24f	570	}
401ca24f	571	sd->hid_sensor_hub_client_devs[
d81cae80 SP	572	sd->hid_sensor_client_cnt].id = PLATFORM_DEVID_AUTO;
d81cae80 SP	573	sd->hid_sensor_hub_client_devs[
401ca24f	574	sd->hid_sensor_client_cnt].name = name;
	575	sd->hid_sensor_hub_client_devs[
	576	sd->hid_sensor_client_cnt].platform_data =
	577	sd->hsdev;
	578	sd->hid_sensor_hub_client_devs[
	579	sd->hid_sensor_client_cnt].pdata_size =
	580	sizeof(*sd->hsdev);
	581	hid_dbg(hdev, "Adding %s:%p\n", name, sd);
	582	sd->hid_sensor_client_cnt++;
	583	}
	584	}
	585	ret = mfd_add_devices(&hdev->dev, 0, sd->hid_sensor_hub_client_devs,
f45c69b1	586	sd->hid_sensor_client_cnt, NULL, 0, NULL);
401ca24f	587	if (ret < 0)
	588	goto err_free_names;
	589
	590	return ret;
	591
	592	err_free_names:
	593	for (i = 0; i < sd->hid_sensor_client_cnt ; ++i)
	594	kfree(sd->hid_sensor_hub_client_devs[i].name);
401ca24f	595	kfree(sd->hid_sensor_hub_client_devs);
401ca24f	596	err_stop_hw:
401ca24f	597	hid_hw_stop(hdev);
401ca24f	598
	599	return ret;
	600	}
	601
	602	static void sensor_hub_remove(struct hid_device *hdev)
	603	{
	604	struct sensor_hub_data *data = hid_get_drvdata(hdev);
	605	unsigned long flags;
	606	int i;
	607
	608	hid_dbg(hdev, " hardware removed\n");
401ca24f	609	hid_hw_close(hdev);
f2f13a68	610	hid_hw_stop(hdev);
401ca24f	611	spin_lock_irqsave(&data->lock, flags);
	612	if (data->pending.status)
	613	complete(&data->pending.ready);
	614	spin_unlock_irqrestore(&data->lock, flags);
	615	mfd_remove_devices(&hdev->dev);
	616	for (i = 0; i < data->hid_sensor_client_cnt ; ++i)
	617	kfree(data->hid_sensor_hub_client_devs[i].name);
	618	kfree(data->hid_sensor_hub_client_devs);
	619	hid_set_drvdata(hdev, NULL);
	620	mutex_destroy(&data->mutex);
401ca24f	621	}
	622
	623	static const struct hid_device_id sensor_hub_devices[] = {
0d1e4b02 MW	624	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, HID_ANY_ID,
0d1e4b02 MW	625	HID_ANY_ID) },
401ca24f	626	{ }
	627	};
	628	MODULE_DEVICE_TABLE(hid, sensor_hub_devices);
	629
401ca24f	630	static struct hid_driver sensor_hub_driver = {
	631	.name = "hid-sensor-hub",
	632	.id_table = sensor_hub_devices,
	633	.probe = sensor_hub_probe,
	634	.remove = sensor_hub_remove,
	635	.raw_event = sensor_hub_raw_event,
	636	#ifdef CONFIG_PM
	637	.suspend = sensor_hub_suspend,
5902fde1 AS	638	.resume = sensor_hub_resume,
5902fde1 AS	639	.reset_resume = sensor_hub_reset_resume,
401ca24f	640	#endif
401ca24f	641	};
f425458e	642	module_hid_driver(sensor_hub_driver);
401ca24f	643
	644	MODULE_DESCRIPTION("HID Sensor Hub driver");
	645	MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
	646	MODULE_LICENSE("GPL");