3 * Copyright (c) 2012, Intel Corporation.
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.
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
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.
19 #include <linux/device.h>
20 #include <linux/hid.h>
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>
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.
38 struct sensor_hub_pending {
40 struct completion ready;
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).
58 struct sensor_hub_data {
59 struct hid_sensor_hub_device *hsdev;
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;
70 * struct hid_sensor_hub_callbacks_list - Stores callback list
72 * @usage_id: usage id for a physical device.
73 * @usage_callback: Stores registered callback functions.
74 * @priv: Private data for a physical device.
76 struct hid_sensor_hub_callbacks_list {
77 struct list_head list;
79 struct hid_sensor_hub_callbacks *usage_callback;
83 static struct hid_report *sensor_hub_report(int id, struct hid_device *hdev,
86 struct hid_report *report;
88 list_for_each_entry(report, &hdev->report_enum[dir].report_list, list) {
92 hid_warn(hdev, "No report with id 0x%x found\n", id);
97 static int sensor_hub_get_physical_device_count(
98 struct hid_report_enum *report_enum)
100 struct hid_report *report;
101 struct hid_field *field;
104 list_for_each_entry(report, &report_enum->report_list, list) {
105 field = report->field[0];
106 if (report->maxfield && field &&
114 static void sensor_hub_fill_attr_info(
115 struct hid_sensor_hub_attribute_info *info,
116 s32 index, s32 report_id, s32 units, s32 unit_expo, s32 size)
119 info->report_id = report_id;
121 info->unit_expo = unit_expo;
125 static struct hid_sensor_hub_callbacks *sensor_hub_get_callback(
126 struct hid_device *hdev,
127 u32 usage_id, void **priv)
129 struct hid_sensor_hub_callbacks_list *callback;
130 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
132 spin_lock(&pdata->dyn_callback_lock);
133 list_for_each_entry(callback, &pdata->dyn_callback_list, list)
134 if (callback->usage_id == usage_id) {
135 *priv = callback->priv;
136 spin_unlock(&pdata->dyn_callback_lock);
137 return callback->usage_callback;
139 spin_unlock(&pdata->dyn_callback_lock);
144 int sensor_hub_register_callback(struct hid_sensor_hub_device *hsdev,
146 struct hid_sensor_hub_callbacks *usage_callback)
148 struct hid_sensor_hub_callbacks_list *callback;
149 struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);
151 spin_lock(&pdata->dyn_callback_lock);
152 list_for_each_entry(callback, &pdata->dyn_callback_list, list)
153 if (callback->usage_id == usage_id) {
154 spin_unlock(&pdata->dyn_callback_lock);
157 callback = kzalloc(sizeof(*callback), GFP_ATOMIC);
159 spin_unlock(&pdata->dyn_callback_lock);
162 callback->usage_callback = usage_callback;
163 callback->usage_id = usage_id;
164 callback->priv = NULL;
165 list_add_tail(&callback->list, &pdata->dyn_callback_list);
166 spin_unlock(&pdata->dyn_callback_lock);
170 EXPORT_SYMBOL_GPL(sensor_hub_register_callback);
172 int sensor_hub_remove_callback(struct hid_sensor_hub_device *hsdev,
175 struct hid_sensor_hub_callbacks_list *callback;
176 struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);
178 spin_lock(&pdata->dyn_callback_lock);
179 list_for_each_entry(callback, &pdata->dyn_callback_list, list)
180 if (callback->usage_id == usage_id) {
181 list_del(&callback->list);
185 spin_unlock(&pdata->dyn_callback_lock);
189 EXPORT_SYMBOL_GPL(sensor_hub_remove_callback);
191 int sensor_hub_set_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
192 u32 field_index, s32 value)
194 struct hid_report *report;
195 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
198 mutex_lock(&data->mutex);
199 report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
200 if (!report || (field_index >= report->maxfield)) {
204 hid_set_field(report->field[field_index], 0, value);
205 hid_hw_request(hsdev->hdev, report, HID_REQ_SET_REPORT);
206 hid_hw_wait(hsdev->hdev);
209 mutex_unlock(&data->mutex);
213 EXPORT_SYMBOL_GPL(sensor_hub_set_feature);
215 int sensor_hub_get_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
216 u32 field_index, s32 *value)
218 struct hid_report *report;
219 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
222 mutex_lock(&data->mutex);
223 report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
224 if (!report || (field_index >= report->maxfield) ||
225 report->field[field_index]->report_count < 1) {
229 hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
230 hid_hw_wait(hsdev->hdev);
231 *value = report->field[field_index]->value[0];
234 mutex_unlock(&data->mutex);
238 EXPORT_SYMBOL_GPL(sensor_hub_get_feature);
241 int sensor_hub_input_attr_get_raw_value(struct hid_sensor_hub_device *hsdev,
243 u32 attr_usage_id, u32 report_id)
245 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
247 struct hid_report *report;
250 mutex_lock(&data->mutex);
251 memset(&data->pending, 0, sizeof(data->pending));
252 init_completion(&data->pending.ready);
253 data->pending.usage_id = usage_id;
254 data->pending.attr_usage_id = attr_usage_id;
255 data->pending.raw_size = 0;
257 spin_lock_irqsave(&data->lock, flags);
258 data->pending.status = true;
259 report = sensor_hub_report(report_id, hsdev->hdev, HID_INPUT_REPORT);
261 spin_unlock_irqrestore(&data->lock, flags);
264 hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
265 spin_unlock_irqrestore(&data->lock, flags);
266 wait_for_completion_interruptible_timeout(&data->pending.ready, HZ*5);
267 switch (data->pending.raw_size) {
269 ret_val = *(u8 *)data->pending.raw_data;
272 ret_val = *(u16 *)data->pending.raw_data;
275 ret_val = *(u32 *)data->pending.raw_data;
280 kfree(data->pending.raw_data);
283 data->pending.status = false;
284 mutex_unlock(&data->mutex);
288 EXPORT_SYMBOL_GPL(sensor_hub_input_attr_get_raw_value);
290 int sensor_hub_input_get_attribute_info(struct hid_sensor_hub_device *hsdev,
294 struct hid_sensor_hub_attribute_info *info)
298 int collection_index = -1;
299 struct hid_report *report;
300 struct hid_field *field;
301 struct hid_report_enum *report_enum;
302 struct hid_device *hdev = hsdev->hdev;
304 /* Initialize with defaults */
305 info->usage_id = usage_id;
306 info->attrib_id = attr_usage_id;
307 info->report_id = -1;
310 info->unit_expo = -1;
312 for (i = 0; i < hdev->maxcollection; ++i) {
313 struct hid_collection *collection = &hdev->collection[i];
314 if (usage_id == collection->usage) {
315 collection_index = i;
319 if (collection_index == -1)
322 report_enum = &hdev->report_enum[type];
323 list_for_each_entry(report, &report_enum->report_list, list) {
324 for (i = 0; i < report->maxfield; ++i) {
325 field = report->field[i];
326 if (field->physical == usage_id &&
327 field->logical == attr_usage_id) {
328 sensor_hub_fill_attr_info(info, i, report->id,
329 field->unit, field->unit_exponent,
331 field->report_count);
334 for (j = 0; j < field->maxusage; ++j) {
335 if (field->usage[j].hid ==
337 field->usage[j].collection_index ==
339 sensor_hub_fill_attr_info(info,
342 field->unit_exponent,
344 field->report_count);
358 EXPORT_SYMBOL_GPL(sensor_hub_input_get_attribute_info);
361 static int sensor_hub_suspend(struct hid_device *hdev, pm_message_t message)
363 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
364 struct hid_sensor_hub_callbacks_list *callback;
366 hid_dbg(hdev, " sensor_hub_suspend\n");
367 spin_lock(&pdata->dyn_callback_lock);
368 list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
369 if (callback->usage_callback->suspend)
370 callback->usage_callback->suspend(
371 pdata->hsdev, callback->priv);
373 spin_unlock(&pdata->dyn_callback_lock);
378 static int sensor_hub_resume(struct hid_device *hdev)
380 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
381 struct hid_sensor_hub_callbacks_list *callback;
383 hid_dbg(hdev, " sensor_hub_resume\n");
384 spin_lock(&pdata->dyn_callback_lock);
385 list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
386 if (callback->usage_callback->resume)
387 callback->usage_callback->resume(
388 pdata->hsdev, callback->priv);
390 spin_unlock(&pdata->dyn_callback_lock);
395 static int sensor_hub_reset_resume(struct hid_device *hdev)
401 * Handle raw report as sent by device
403 static int sensor_hub_raw_event(struct hid_device *hdev,
404 struct hid_report *report, u8 *raw_data, int size)
409 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
411 struct hid_sensor_hub_callbacks *callback = NULL;
412 struct hid_collection *collection = NULL;
415 hid_dbg(hdev, "sensor_hub_raw_event report id:0x%x size:%d type:%d\n",
416 report->id, size, report->type);
417 hid_dbg(hdev, "maxfield:%d\n", report->maxfield);
418 if (report->type != HID_INPUT_REPORT)
422 ptr++; /*Skip report id*/
424 spin_lock_irqsave(&pdata->lock, flags);
426 for (i = 0; i < report->maxfield; ++i) {
428 hid_dbg(hdev, "%d collection_index:%x hid:%x sz:%x\n",
429 i, report->field[i]->usage->collection_index,
430 report->field[i]->usage->hid,
431 (report->field[i]->report_size *
432 report->field[i]->report_count)/8);
433 sz = (report->field[i]->report_size *
434 report->field[i]->report_count)/8;
435 if (pdata->pending.status && pdata->pending.attr_usage_id ==
436 report->field[i]->usage->hid) {
437 hid_dbg(hdev, "data was pending ...\n");
438 pdata->pending.raw_data = kmalloc(sz, GFP_ATOMIC);
439 if (pdata->pending.raw_data) {
440 memcpy(pdata->pending.raw_data, ptr, sz);
441 pdata->pending.raw_size = sz;
443 pdata->pending.raw_size = 0;
444 complete(&pdata->pending.ready);
446 collection = &hdev->collection[
447 report->field[i]->usage->collection_index];
448 hid_dbg(hdev, "collection->usage %x\n",
450 callback = sensor_hub_get_callback(pdata->hsdev->hdev,
451 report->field[i]->physical,
453 if (callback && callback->capture_sample) {
454 if (report->field[i]->logical)
455 callback->capture_sample(pdata->hsdev,
456 report->field[i]->logical, sz, ptr,
459 callback->capture_sample(pdata->hsdev,
460 report->field[i]->usage->hid, sz, ptr,
465 if (callback && collection && callback->send_event)
466 callback->send_event(pdata->hsdev, collection->usage,
468 spin_unlock_irqrestore(&pdata->lock, flags);
473 static int sensor_hub_probe(struct hid_device *hdev,
474 const struct hid_device_id *id)
477 struct sensor_hub_data *sd;
480 struct hid_report *report;
481 struct hid_report_enum *report_enum;
482 struct hid_field *field;
485 sd = kzalloc(sizeof(struct sensor_hub_data), GFP_KERNEL);
487 hid_err(hdev, "cannot allocate Sensor data\n");
490 sd->hsdev = kzalloc(sizeof(struct hid_sensor_hub_device), GFP_KERNEL);
492 hid_err(hdev, "cannot allocate hid_sensor_hub_device\n");
496 hid_set_drvdata(hdev, sd);
497 sd->hsdev->hdev = hdev;
498 sd->hsdev->vendor_id = hdev->vendor;
499 sd->hsdev->product_id = hdev->product;
500 spin_lock_init(&sd->lock);
501 spin_lock_init(&sd->dyn_callback_lock);
502 mutex_init(&sd->mutex);
503 ret = hid_parse(hdev);
505 hid_err(hdev, "parse failed\n");
508 INIT_LIST_HEAD(&hdev->inputs);
510 ret = hid_hw_start(hdev, 0);
512 hid_err(hdev, "hw start failed\n");
515 ret = hid_hw_open(hdev);
517 hid_err(hdev, "failed to open input interrupt pipe\n");
521 INIT_LIST_HEAD(&sd->dyn_callback_list);
522 sd->hid_sensor_client_cnt = 0;
523 report_enum = &hdev->report_enum[HID_INPUT_REPORT];
525 dev_cnt = sensor_hub_get_physical_device_count(report_enum);
526 if (dev_cnt > HID_MAX_PHY_DEVICES) {
527 hid_err(hdev, "Invalid Physical device count\n");
531 sd->hid_sensor_hub_client_devs = kzalloc(dev_cnt *
532 sizeof(struct mfd_cell),
534 if (sd->hid_sensor_hub_client_devs == NULL) {
535 hid_err(hdev, "Failed to allocate memory for mfd cells\n");
539 list_for_each_entry(report, &report_enum->report_list, list) {
540 hid_dbg(hdev, "Report id:%x\n", report->id);
541 field = report->field[0];
542 if (report->maxfield && field &&
544 name = kasprintf(GFP_KERNEL, "HID-SENSOR-%x",
547 hid_err(hdev, "Failed MFD device name\n");
551 sd->hid_sensor_hub_client_devs[
552 sd->hid_sensor_client_cnt].name = name;
553 sd->hid_sensor_hub_client_devs[
554 sd->hid_sensor_client_cnt].platform_data =
556 sd->hid_sensor_hub_client_devs[
557 sd->hid_sensor_client_cnt].pdata_size =
559 hid_dbg(hdev, "Adding %s:%p\n", name, sd);
560 sd->hid_sensor_client_cnt++;
563 ret = mfd_add_devices(&hdev->dev, 0, sd->hid_sensor_hub_client_devs,
564 sd->hid_sensor_client_cnt, NULL, 0, NULL);
571 for (i = 0; i < sd->hid_sensor_client_cnt ; ++i)
572 kfree(sd->hid_sensor_hub_client_devs[i].name);
573 kfree(sd->hid_sensor_hub_client_devs);
586 static void sensor_hub_remove(struct hid_device *hdev)
588 struct sensor_hub_data *data = hid_get_drvdata(hdev);
592 hid_dbg(hdev, " hardware removed\n");
595 spin_lock_irqsave(&data->lock, flags);
596 if (data->pending.status)
597 complete(&data->pending.ready);
598 spin_unlock_irqrestore(&data->lock, flags);
599 mfd_remove_devices(&hdev->dev);
600 for (i = 0; i < data->hid_sensor_client_cnt ; ++i)
601 kfree(data->hid_sensor_hub_client_devs[i].name);
602 kfree(data->hid_sensor_hub_client_devs);
603 hid_set_drvdata(hdev, NULL);
604 mutex_destroy(&data->mutex);
609 static const struct hid_device_id sensor_hub_devices[] = {
610 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, HID_ANY_ID,
614 MODULE_DEVICE_TABLE(hid, sensor_hub_devices);
616 static struct hid_driver sensor_hub_driver = {
617 .name = "hid-sensor-hub",
618 .id_table = sensor_hub_devices,
619 .probe = sensor_hub_probe,
620 .remove = sensor_hub_remove,
621 .raw_event = sensor_hub_raw_event,
623 .suspend = sensor_hub_suspend,
624 .resume = sensor_hub_resume,
625 .reset_resume = sensor_hub_reset_resume,
628 module_hid_driver(sensor_hub_driver);
630 MODULE_DESCRIPTION("HID Sensor Hub driver");
631 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
632 MODULE_LICENSE("GPL");