x86/xen: resume timer irqs early
[linux/fpc-iii.git] / drivers / hid / hid-sensor-hub.c
blob9e4cdca549c00cb6a148cd8d60d37348a2ee0210
1 /*
2 * HID Sensors Driver
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
12 * more details.
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>
27 #include "hid-ids.h"
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.
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;
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).
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;
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.
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;
83 static struct hid_report *sensor_hub_report(int id, struct hid_device *hdev,
84 int dir)
86 struct hid_report *report;
88 list_for_each_entry(report, &hdev->report_enum[dir].report_list, list) {
89 if (report->id == id)
90 return report;
92 hid_warn(hdev, "No report with id 0x%x found\n", id);
94 return NULL;
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;
102 int cnt = 0;
104 list_for_each_entry(report, &report_enum->report_list, list) {
105 field = report->field[0];
106 if (report->maxfield && field && field->physical)
107 cnt++;
110 return cnt;
113 static void sensor_hub_fill_attr_info(
114 struct hid_sensor_hub_attribute_info *info,
115 s32 index, s32 report_id, s32 units, s32 unit_expo, s32 size)
117 info->index = index;
118 info->report_id = report_id;
119 info->units = units;
120 info->unit_expo = unit_expo;
121 info->size = size/8;
124 static struct hid_sensor_hub_callbacks *sensor_hub_get_callback(
125 struct hid_device *hdev,
126 u32 usage_id, void **priv)
128 struct hid_sensor_hub_callbacks_list *callback;
129 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
131 spin_lock(&pdata->dyn_callback_lock);
132 list_for_each_entry(callback, &pdata->dyn_callback_list, list)
133 if (callback->usage_id == usage_id) {
134 *priv = callback->priv;
135 spin_unlock(&pdata->dyn_callback_lock);
136 return callback->usage_callback;
138 spin_unlock(&pdata->dyn_callback_lock);
140 return NULL;
143 int sensor_hub_register_callback(struct hid_sensor_hub_device *hsdev,
144 u32 usage_id,
145 struct hid_sensor_hub_callbacks *usage_callback)
147 struct hid_sensor_hub_callbacks_list *callback;
148 struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);
150 spin_lock(&pdata->dyn_callback_lock);
151 list_for_each_entry(callback, &pdata->dyn_callback_list, list)
152 if (callback->usage_id == usage_id) {
153 spin_unlock(&pdata->dyn_callback_lock);
154 return -EINVAL;
156 callback = kzalloc(sizeof(*callback), GFP_ATOMIC);
157 if (!callback) {
158 spin_unlock(&pdata->dyn_callback_lock);
159 return -ENOMEM;
161 callback->usage_callback = usage_callback;
162 callback->usage_id = usage_id;
163 callback->priv = NULL;
164 list_add_tail(&callback->list, &pdata->dyn_callback_list);
165 spin_unlock(&pdata->dyn_callback_lock);
167 return 0;
169 EXPORT_SYMBOL_GPL(sensor_hub_register_callback);
171 int sensor_hub_remove_callback(struct hid_sensor_hub_device *hsdev,
172 u32 usage_id)
174 struct hid_sensor_hub_callbacks_list *callback;
175 struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);
177 spin_lock(&pdata->dyn_callback_lock);
178 list_for_each_entry(callback, &pdata->dyn_callback_list, list)
179 if (callback->usage_id == usage_id) {
180 list_del(&callback->list);
181 kfree(callback);
182 break;
184 spin_unlock(&pdata->dyn_callback_lock);
186 return 0;
188 EXPORT_SYMBOL_GPL(sensor_hub_remove_callback);
190 int sensor_hub_set_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
191 u32 field_index, s32 value)
193 struct hid_report *report;
194 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
195 int ret = 0;
197 mutex_lock(&data->mutex);
198 report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
199 if (!report || (field_index >= report->maxfield)) {
200 ret = -EINVAL;
201 goto done_proc;
203 hid_set_field(report->field[field_index], 0, value);
204 hid_hw_request(hsdev->hdev, report, HID_REQ_SET_REPORT);
205 hid_hw_wait(hsdev->hdev);
207 done_proc:
208 mutex_unlock(&data->mutex);
210 return ret;
212 EXPORT_SYMBOL_GPL(sensor_hub_set_feature);
214 int sensor_hub_get_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
215 u32 field_index, s32 *value)
217 struct hid_report *report;
218 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
219 int ret = 0;
221 mutex_lock(&data->mutex);
222 report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
223 if (!report || (field_index >= report->maxfield) ||
224 report->field[field_index]->report_count < 1) {
225 ret = -EINVAL;
226 goto done_proc;
228 hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
229 hid_hw_wait(hsdev->hdev);
230 *value = report->field[field_index]->value[0];
232 done_proc:
233 mutex_unlock(&data->mutex);
235 return ret;
237 EXPORT_SYMBOL_GPL(sensor_hub_get_feature);
240 int sensor_hub_input_attr_get_raw_value(struct hid_sensor_hub_device *hsdev,
241 u32 usage_id,
242 u32 attr_usage_id, u32 report_id)
244 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
245 unsigned long flags;
246 struct hid_report *report;
247 int ret_val = 0;
249 mutex_lock(&data->mutex);
250 memset(&data->pending, 0, sizeof(data->pending));
251 init_completion(&data->pending.ready);
252 data->pending.usage_id = usage_id;
253 data->pending.attr_usage_id = attr_usage_id;
254 data->pending.raw_size = 0;
256 spin_lock_irqsave(&data->lock, flags);
257 data->pending.status = true;
258 report = sensor_hub_report(report_id, hsdev->hdev, HID_INPUT_REPORT);
259 if (!report) {
260 spin_unlock_irqrestore(&data->lock, flags);
261 goto err_free;
263 hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
264 spin_unlock_irqrestore(&data->lock, flags);
265 wait_for_completion_interruptible_timeout(&data->pending.ready, HZ*5);
266 switch (data->pending.raw_size) {
267 case 1:
268 ret_val = *(u8 *)data->pending.raw_data;
269 break;
270 case 2:
271 ret_val = *(u16 *)data->pending.raw_data;
272 break;
273 case 4:
274 ret_val = *(u32 *)data->pending.raw_data;
275 break;
276 default:
277 ret_val = 0;
279 kfree(data->pending.raw_data);
281 err_free:
282 data->pending.status = false;
283 mutex_unlock(&data->mutex);
285 return ret_val;
287 EXPORT_SYMBOL_GPL(sensor_hub_input_attr_get_raw_value);
289 int sensor_hub_input_get_attribute_info(struct hid_sensor_hub_device *hsdev,
290 u8 type,
291 u32 usage_id,
292 u32 attr_usage_id,
293 struct hid_sensor_hub_attribute_info *info)
295 int ret = -1;
296 int i, j;
297 int collection_index = -1;
298 struct hid_report *report;
299 struct hid_field *field;
300 struct hid_report_enum *report_enum;
301 struct hid_device *hdev = hsdev->hdev;
303 /* Initialize with defaults */
304 info->usage_id = usage_id;
305 info->attrib_id = attr_usage_id;
306 info->report_id = -1;
307 info->index = -1;
308 info->units = -1;
309 info->unit_expo = -1;
311 for (i = 0; i < hdev->maxcollection; ++i) {
312 struct hid_collection *collection = &hdev->collection[i];
313 if (usage_id == collection->usage) {
314 collection_index = i;
315 break;
318 if (collection_index == -1)
319 goto err_ret;
321 report_enum = &hdev->report_enum[type];
322 list_for_each_entry(report, &report_enum->report_list, list) {
323 for (i = 0; i < report->maxfield; ++i) {
324 field = report->field[i];
325 if (field->physical == usage_id &&
326 field->logical == attr_usage_id) {
327 sensor_hub_fill_attr_info(info, i, report->id,
328 field->unit, field->unit_exponent,
329 field->report_size *
330 field->report_count);
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 ==
337 collection_index) {
338 sensor_hub_fill_attr_info(info,
339 i, report->id,
340 field->unit,
341 field->unit_exponent,
342 field->report_size *
343 field->report_count);
344 ret = 0;
345 break;
349 if (ret == 0)
350 break;
354 err_ret:
355 return ret;
357 EXPORT_SYMBOL_GPL(sensor_hub_input_get_attribute_info);
359 #ifdef CONFIG_PM
360 static int sensor_hub_suspend(struct hid_device *hdev, pm_message_t message)
362 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
363 struct hid_sensor_hub_callbacks_list *callback;
365 hid_dbg(hdev, " sensor_hub_suspend\n");
366 spin_lock(&pdata->dyn_callback_lock);
367 list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
368 if (callback->usage_callback->suspend)
369 callback->usage_callback->suspend(
370 pdata->hsdev, callback->priv);
372 spin_unlock(&pdata->dyn_callback_lock);
374 return 0;
377 static int sensor_hub_resume(struct hid_device *hdev)
379 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
380 struct hid_sensor_hub_callbacks_list *callback;
382 hid_dbg(hdev, " sensor_hub_resume\n");
383 spin_lock(&pdata->dyn_callback_lock);
384 list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
385 if (callback->usage_callback->resume)
386 callback->usage_callback->resume(
387 pdata->hsdev, callback->priv);
389 spin_unlock(&pdata->dyn_callback_lock);
391 return 0;
394 static int sensor_hub_reset_resume(struct hid_device *hdev)
396 return 0;
398 #endif
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)
406 int i;
407 u8 *ptr;
408 int sz;
409 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
410 unsigned long flags;
411 struct hid_sensor_hub_callbacks *callback = NULL;
412 struct hid_collection *collection = NULL;
413 void *priv = 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)
419 return 1;
421 ptr = raw_data;
422 ptr++; /* Skip report id */
424 spin_lock_irqsave(&pdata->lock, flags);
426 for (i = 0; i < report->maxfield; ++i) {
427 hid_dbg(hdev, "%d collection_index:%x hid:%x sz:%x\n",
428 i, report->field[i]->usage->collection_index,
429 report->field[i]->usage->hid,
430 (report->field[i]->report_size *
431 report->field[i]->report_count)/8);
432 sz = (report->field[i]->report_size *
433 report->field[i]->report_count)/8;
434 if (pdata->pending.status && pdata->pending.attr_usage_id ==
435 report->field[i]->usage->hid) {
436 hid_dbg(hdev, "data was pending ...\n");
437 pdata->pending.raw_data = kmemdup(ptr, sz, GFP_ATOMIC);
438 if (pdata->pending.raw_data)
439 pdata->pending.raw_size = sz;
440 else
441 pdata->pending.raw_size = 0;
442 complete(&pdata->pending.ready);
444 collection = &hdev->collection[
445 report->field[i]->usage->collection_index];
446 hid_dbg(hdev, "collection->usage %x\n",
447 collection->usage);
448 callback = sensor_hub_get_callback(pdata->hsdev->hdev,
449 report->field[i]->physical,
450 &priv);
451 if (callback && callback->capture_sample) {
452 if (report->field[i]->logical)
453 callback->capture_sample(pdata->hsdev,
454 report->field[i]->logical, sz, ptr,
455 callback->pdev);
456 else
457 callback->capture_sample(pdata->hsdev,
458 report->field[i]->usage->hid, sz, ptr,
459 callback->pdev);
461 ptr += sz;
463 if (callback && collection && callback->send_event)
464 callback->send_event(pdata->hsdev, collection->usage,
465 callback->pdev);
466 spin_unlock_irqrestore(&pdata->lock, flags);
468 return 1;
471 static int sensor_hub_probe(struct hid_device *hdev,
472 const struct hid_device_id *id)
474 int ret;
475 struct sensor_hub_data *sd;
476 int i;
477 char *name;
478 struct hid_report *report;
479 struct hid_report_enum *report_enum;
480 struct hid_field *field;
481 int dev_cnt;
483 sd = devm_kzalloc(&hdev->dev, sizeof(*sd), GFP_KERNEL);
484 if (!sd) {
485 hid_err(hdev, "cannot allocate Sensor data\n");
486 return -ENOMEM;
488 sd->hsdev = devm_kzalloc(&hdev->dev, sizeof(*sd->hsdev), GFP_KERNEL);
489 if (!sd->hsdev) {
490 hid_err(hdev, "cannot allocate hid_sensor_hub_device\n");
491 return -ENOMEM;
493 hid_set_drvdata(hdev, sd);
494 sd->hsdev->hdev = hdev;
495 sd->hsdev->vendor_id = hdev->vendor;
496 sd->hsdev->product_id = hdev->product;
497 spin_lock_init(&sd->lock);
498 spin_lock_init(&sd->dyn_callback_lock);
499 mutex_init(&sd->mutex);
500 ret = hid_parse(hdev);
501 if (ret) {
502 hid_err(hdev, "parse failed\n");
503 return ret;
505 INIT_LIST_HEAD(&hdev->inputs);
507 ret = hid_hw_start(hdev, 0);
508 if (ret) {
509 hid_err(hdev, "hw start failed\n");
510 return ret;
512 ret = hid_hw_open(hdev);
513 if (ret) {
514 hid_err(hdev, "failed to open input interrupt pipe\n");
515 goto err_stop_hw;
518 INIT_LIST_HEAD(&sd->dyn_callback_list);
519 sd->hid_sensor_client_cnt = 0;
520 report_enum = &hdev->report_enum[HID_INPUT_REPORT];
522 dev_cnt = sensor_hub_get_physical_device_count(report_enum);
523 if (dev_cnt > HID_MAX_PHY_DEVICES) {
524 hid_err(hdev, "Invalid Physical device count\n");
525 ret = -EINVAL;
526 goto err_close;
528 sd->hid_sensor_hub_client_devs = kzalloc(dev_cnt *
529 sizeof(struct mfd_cell),
530 GFP_KERNEL);
531 if (sd->hid_sensor_hub_client_devs == NULL) {
532 hid_err(hdev, "Failed to allocate memory for mfd cells\n");
533 ret = -ENOMEM;
534 goto err_close;
536 list_for_each_entry(report, &report_enum->report_list, list) {
537 hid_dbg(hdev, "Report id:%x\n", report->id);
538 field = report->field[0];
539 if (report->maxfield && field &&
540 field->physical) {
541 name = kasprintf(GFP_KERNEL, "HID-SENSOR-%x",
542 field->physical);
543 if (name == NULL) {
544 hid_err(hdev, "Failed MFD device name\n");
545 ret = -ENOMEM;
546 goto err_free_names;
548 sd->hid_sensor_hub_client_devs[
549 sd->hid_sensor_client_cnt].name = name;
550 sd->hid_sensor_hub_client_devs[
551 sd->hid_sensor_client_cnt].platform_data =
552 sd->hsdev;
553 sd->hid_sensor_hub_client_devs[
554 sd->hid_sensor_client_cnt].pdata_size =
555 sizeof(*sd->hsdev);
556 hid_dbg(hdev, "Adding %s:%p\n", name, sd);
557 sd->hid_sensor_client_cnt++;
560 ret = mfd_add_devices(&hdev->dev, 0, sd->hid_sensor_hub_client_devs,
561 sd->hid_sensor_client_cnt, NULL, 0, NULL);
562 if (ret < 0)
563 goto err_free_names;
565 return ret;
567 err_free_names:
568 for (i = 0; i < sd->hid_sensor_client_cnt ; ++i)
569 kfree(sd->hid_sensor_hub_client_devs[i].name);
570 kfree(sd->hid_sensor_hub_client_devs);
571 err_close:
572 hid_hw_close(hdev);
573 err_stop_hw:
574 hid_hw_stop(hdev);
576 return ret;
579 static void sensor_hub_remove(struct hid_device *hdev)
581 struct sensor_hub_data *data = hid_get_drvdata(hdev);
582 unsigned long flags;
583 int i;
585 hid_dbg(hdev, " hardware removed\n");
586 hid_hw_close(hdev);
587 hid_hw_stop(hdev);
588 spin_lock_irqsave(&data->lock, flags);
589 if (data->pending.status)
590 complete(&data->pending.ready);
591 spin_unlock_irqrestore(&data->lock, flags);
592 mfd_remove_devices(&hdev->dev);
593 for (i = 0; i < data->hid_sensor_client_cnt ; ++i)
594 kfree(data->hid_sensor_hub_client_devs[i].name);
595 kfree(data->hid_sensor_hub_client_devs);
596 hid_set_drvdata(hdev, NULL);
597 mutex_destroy(&data->mutex);
600 static const struct hid_device_id sensor_hub_devices[] = {
601 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, HID_ANY_ID,
602 HID_ANY_ID) },
605 MODULE_DEVICE_TABLE(hid, sensor_hub_devices);
607 static struct hid_driver sensor_hub_driver = {
608 .name = "hid-sensor-hub",
609 .id_table = sensor_hub_devices,
610 .probe = sensor_hub_probe,
611 .remove = sensor_hub_remove,
612 .raw_event = sensor_hub_raw_event,
613 #ifdef CONFIG_PM
614 .suspend = sensor_hub_suspend,
615 .resume = sensor_hub_resume,
616 .reset_resume = sensor_hub_reset_resume,
617 #endif
619 module_hid_driver(sensor_hub_driver);
621 MODULE_DESCRIPTION("HID Sensor Hub driver");
622 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
623 MODULE_LICENSE("GPL");