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>
29 #define HID_SENSOR_HUB_ENUM_QUIRK 0x01
32 * struct sensor_hub_pending - Synchronous read pending information
33 * @status: Pending status true/false.
34 * @ready: Completion synchronization data.
35 * @usage_id: Usage id for physical device, E.g. Gyro usage id.
36 * @attr_usage_id: Usage Id of a field, E.g. X-AXIS for a gyro.
37 * @raw_size: Response size for a read request.
38 * @raw_data: Place holder for received response.
40 struct sensor_hub_pending {
42 struct completion ready;
50 * struct sensor_hub_data - Hold a instance data for a HID hub device
51 * @hsdev: Stored hid instance for current hub device.
52 * @mutex: Mutex to serialize synchronous request.
53 * @lock: Spin lock to protect pending request structure.
54 * @pending: Holds information of pending sync read request.
55 * @dyn_callback_list: Holds callback function
56 * @dyn_callback_lock: spin lock to protect callback list
57 * @hid_sensor_hub_client_devs: Stores all MFD cells for a hub instance.
58 * @hid_sensor_client_cnt: Number of MFD cells, (no of sensors attached).
60 struct sensor_hub_data {
61 struct hid_sensor_hub_device *hsdev;
64 struct sensor_hub_pending pending;
65 struct list_head dyn_callback_list;
66 spinlock_t dyn_callback_lock;
67 struct mfd_cell *hid_sensor_hub_client_devs;
68 int hid_sensor_client_cnt;
73 * struct hid_sensor_hub_callbacks_list - Stores callback list
75 * @usage_id: usage id for a physical device.
76 * @usage_callback: Stores registered callback functions.
77 * @priv: Private data for a physical device.
79 struct hid_sensor_hub_callbacks_list {
80 struct list_head list;
82 struct hid_sensor_hub_callbacks *usage_callback;
86 static struct hid_report *sensor_hub_report(int id, struct hid_device *hdev,
89 struct hid_report *report;
91 list_for_each_entry(report, &hdev->report_enum[dir].report_list, list) {
95 hid_warn(hdev, "No report with id 0x%x found\n", id);
100 static int sensor_hub_get_physical_device_count(
101 struct hid_report_enum *report_enum)
103 struct hid_report *report;
104 struct hid_field *field;
107 list_for_each_entry(report, &report_enum->report_list, list) {
108 field = report->field[0];
109 if (report->maxfield && field && field->physical)
116 static void sensor_hub_fill_attr_info(
117 struct hid_sensor_hub_attribute_info *info,
118 s32 index, s32 report_id, struct hid_field *field)
121 info->report_id = report_id;
122 info->units = field->unit;
123 info->unit_expo = field->unit_exponent;
124 info->size = (field->report_size * field->report_count)/8;
125 info->logical_minimum = field->logical_minimum;
126 info->logical_maximum = field->logical_maximum;
129 static struct hid_sensor_hub_callbacks *sensor_hub_get_callback(
130 struct hid_device *hdev,
131 u32 usage_id, void **priv)
133 struct hid_sensor_hub_callbacks_list *callback;
134 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
136 spin_lock(&pdata->dyn_callback_lock);
137 list_for_each_entry(callback, &pdata->dyn_callback_list, list)
138 if (callback->usage_id == usage_id) {
139 *priv = callback->priv;
140 spin_unlock(&pdata->dyn_callback_lock);
141 return callback->usage_callback;
143 spin_unlock(&pdata->dyn_callback_lock);
148 int sensor_hub_register_callback(struct hid_sensor_hub_device *hsdev,
150 struct hid_sensor_hub_callbacks *usage_callback)
152 struct hid_sensor_hub_callbacks_list *callback;
153 struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);
155 spin_lock(&pdata->dyn_callback_lock);
156 list_for_each_entry(callback, &pdata->dyn_callback_list, list)
157 if (callback->usage_id == usage_id) {
158 spin_unlock(&pdata->dyn_callback_lock);
161 callback = kzalloc(sizeof(*callback), GFP_ATOMIC);
163 spin_unlock(&pdata->dyn_callback_lock);
166 callback->usage_callback = usage_callback;
167 callback->usage_id = usage_id;
168 callback->priv = NULL;
169 list_add_tail(&callback->list, &pdata->dyn_callback_list);
170 spin_unlock(&pdata->dyn_callback_lock);
174 EXPORT_SYMBOL_GPL(sensor_hub_register_callback);
176 int sensor_hub_remove_callback(struct hid_sensor_hub_device *hsdev,
179 struct hid_sensor_hub_callbacks_list *callback;
180 struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);
182 spin_lock(&pdata->dyn_callback_lock);
183 list_for_each_entry(callback, &pdata->dyn_callback_list, list)
184 if (callback->usage_id == usage_id) {
185 list_del(&callback->list);
189 spin_unlock(&pdata->dyn_callback_lock);
193 EXPORT_SYMBOL_GPL(sensor_hub_remove_callback);
195 int sensor_hub_set_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
196 u32 field_index, s32 value)
198 struct hid_report *report;
199 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
202 mutex_lock(&data->mutex);
203 report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
204 if (!report || (field_index >= report->maxfield)) {
208 hid_set_field(report->field[field_index], 0, value);
209 hid_hw_request(hsdev->hdev, report, HID_REQ_SET_REPORT);
210 hid_hw_wait(hsdev->hdev);
213 mutex_unlock(&data->mutex);
217 EXPORT_SYMBOL_GPL(sensor_hub_set_feature);
219 int sensor_hub_get_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
220 u32 field_index, s32 *value)
222 struct hid_report *report;
223 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
226 mutex_lock(&data->mutex);
227 report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
228 if (!report || (field_index >= report->maxfield) ||
229 report->field[field_index]->report_count < 1) {
233 hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
234 hid_hw_wait(hsdev->hdev);
235 *value = report->field[field_index]->value[0];
238 mutex_unlock(&data->mutex);
242 EXPORT_SYMBOL_GPL(sensor_hub_get_feature);
245 int sensor_hub_input_attr_get_raw_value(struct hid_sensor_hub_device *hsdev,
247 u32 attr_usage_id, u32 report_id)
249 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
251 struct hid_report *report;
254 mutex_lock(&data->mutex);
255 memset(&data->pending, 0, sizeof(data->pending));
256 init_completion(&data->pending.ready);
257 data->pending.usage_id = usage_id;
258 data->pending.attr_usage_id = attr_usage_id;
259 data->pending.raw_size = 0;
261 spin_lock_irqsave(&data->lock, flags);
262 data->pending.status = true;
263 spin_unlock_irqrestore(&data->lock, flags);
264 report = sensor_hub_report(report_id, hsdev->hdev, HID_INPUT_REPORT);
268 hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
269 wait_for_completion_interruptible_timeout(&data->pending.ready, HZ*5);
270 switch (data->pending.raw_size) {
272 ret_val = *(u8 *)data->pending.raw_data;
275 ret_val = *(u16 *)data->pending.raw_data;
278 ret_val = *(u32 *)data->pending.raw_data;
283 kfree(data->pending.raw_data);
286 data->pending.status = false;
287 mutex_unlock(&data->mutex);
291 EXPORT_SYMBOL_GPL(sensor_hub_input_attr_get_raw_value);
293 int sensor_hub_input_get_attribute_info(struct hid_sensor_hub_device *hsdev,
297 struct hid_sensor_hub_attribute_info *info)
301 int collection_index = -1;
302 struct hid_report *report;
303 struct hid_field *field;
304 struct hid_report_enum *report_enum;
305 struct hid_device *hdev = hsdev->hdev;
307 /* Initialize with defaults */
308 info->usage_id = usage_id;
309 info->attrib_id = attr_usage_id;
310 info->report_id = -1;
313 info->unit_expo = -1;
315 for (i = 0; i < hdev->maxcollection; ++i) {
316 struct hid_collection *collection = &hdev->collection[i];
317 if (usage_id == collection->usage) {
318 collection_index = i;
322 if (collection_index == -1)
325 report_enum = &hdev->report_enum[type];
326 list_for_each_entry(report, &report_enum->report_list, list) {
327 for (i = 0; i < report->maxfield; ++i) {
328 field = report->field[i];
329 if (field->physical == usage_id &&
330 field->logical == attr_usage_id) {
331 sensor_hub_fill_attr_info(info, i, report->id,
335 for (j = 0; j < field->maxusage; ++j) {
336 if (field->usage[j].hid ==
338 field->usage[j].collection_index ==
340 sensor_hub_fill_attr_info(info,
341 i, report->id, field);
355 EXPORT_SYMBOL_GPL(sensor_hub_input_get_attribute_info);
358 static int sensor_hub_suspend(struct hid_device *hdev, pm_message_t message)
360 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
361 struct hid_sensor_hub_callbacks_list *callback;
363 hid_dbg(hdev, " sensor_hub_suspend\n");
364 spin_lock(&pdata->dyn_callback_lock);
365 list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
366 if (callback->usage_callback->suspend)
367 callback->usage_callback->suspend(
368 pdata->hsdev, callback->priv);
370 spin_unlock(&pdata->dyn_callback_lock);
375 static int sensor_hub_resume(struct hid_device *hdev)
377 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
378 struct hid_sensor_hub_callbacks_list *callback;
380 hid_dbg(hdev, " sensor_hub_resume\n");
381 spin_lock(&pdata->dyn_callback_lock);
382 list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
383 if (callback->usage_callback->resume)
384 callback->usage_callback->resume(
385 pdata->hsdev, callback->priv);
387 spin_unlock(&pdata->dyn_callback_lock);
392 static int sensor_hub_reset_resume(struct hid_device *hdev)
399 * Handle raw report as sent by device
401 static int sensor_hub_raw_event(struct hid_device *hdev,
402 struct hid_report *report, u8 *raw_data, int size)
407 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
409 struct hid_sensor_hub_callbacks *callback = NULL;
410 struct hid_collection *collection = NULL;
413 hid_dbg(hdev, "sensor_hub_raw_event report id:0x%x size:%d type:%d\n",
414 report->id, size, report->type);
415 hid_dbg(hdev, "maxfield:%d\n", report->maxfield);
416 if (report->type != HID_INPUT_REPORT)
420 ptr++; /* Skip report id */
422 spin_lock_irqsave(&pdata->lock, flags);
424 for (i = 0; i < report->maxfield; ++i) {
425 hid_dbg(hdev, "%d collection_index:%x hid:%x sz:%x\n",
426 i, report->field[i]->usage->collection_index,
427 report->field[i]->usage->hid,
428 (report->field[i]->report_size *
429 report->field[i]->report_count)/8);
430 sz = (report->field[i]->report_size *
431 report->field[i]->report_count)/8;
432 if (pdata->pending.status && pdata->pending.attr_usage_id ==
433 report->field[i]->usage->hid) {
434 hid_dbg(hdev, "data was pending ...\n");
435 pdata->pending.raw_data = kmemdup(ptr, sz, GFP_ATOMIC);
436 if (pdata->pending.raw_data)
437 pdata->pending.raw_size = sz;
439 pdata->pending.raw_size = 0;
440 complete(&pdata->pending.ready);
442 collection = &hdev->collection[
443 report->field[i]->usage->collection_index];
444 hid_dbg(hdev, "collection->usage %x\n",
446 callback = sensor_hub_get_callback(pdata->hsdev->hdev,
447 report->field[i]->physical,
449 if (callback && callback->capture_sample) {
450 if (report->field[i]->logical)
451 callback->capture_sample(pdata->hsdev,
452 report->field[i]->logical, sz, ptr,
455 callback->capture_sample(pdata->hsdev,
456 report->field[i]->usage->hid, sz, ptr,
461 if (callback && collection && callback->send_event)
462 callback->send_event(pdata->hsdev, collection->usage,
464 spin_unlock_irqrestore(&pdata->lock, flags);
469 int sensor_hub_device_open(struct hid_sensor_hub_device *hsdev)
472 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
474 mutex_lock(&data->mutex);
475 if (!hsdev->ref_cnt) {
476 ret = hid_hw_open(hsdev->hdev);
478 hid_err(hsdev->hdev, "failed to open hid device\n");
479 mutex_unlock(&data->mutex);
484 mutex_unlock(&data->mutex);
488 EXPORT_SYMBOL_GPL(sensor_hub_device_open);
490 void sensor_hub_device_close(struct hid_sensor_hub_device *hsdev)
492 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
494 mutex_lock(&data->mutex);
497 hid_hw_close(hsdev->hdev);
498 mutex_unlock(&data->mutex);
500 EXPORT_SYMBOL_GPL(sensor_hub_device_close);
502 static __u8 *sensor_hub_report_fixup(struct hid_device *hdev, __u8 *rdesc,
506 struct sensor_hub_data *sd = hid_get_drvdata(hdev);
507 unsigned char report_block[] = {
508 0x0a, 0x16, 0x03, 0x15, 0x00, 0x25, 0x05};
509 unsigned char power_block[] = {
510 0x0a, 0x19, 0x03, 0x15, 0x00, 0x25, 0x05};
512 if (!(sd->quirks & HID_SENSOR_HUB_ENUM_QUIRK)) {
513 hid_dbg(hdev, "No Enum quirks\n");
517 /* Looks for power and report state usage id and force to 1 */
518 for (index = 0; index < *rsize; ++index) {
519 if (((*rsize - index) > sizeof(report_block)) &&
520 !memcmp(&rdesc[index], report_block,
521 sizeof(report_block))) {
522 rdesc[index + 4] = 0x01;
523 index += sizeof(report_block);
525 if (((*rsize - index) > sizeof(power_block)) &&
526 !memcmp(&rdesc[index], power_block,
527 sizeof(power_block))) {
528 rdesc[index + 4] = 0x01;
529 index += sizeof(power_block);
536 static int sensor_hub_probe(struct hid_device *hdev,
537 const struct hid_device_id *id)
540 struct sensor_hub_data *sd;
543 struct hid_report *report;
544 struct hid_report_enum *report_enum;
545 struct hid_field *field;
548 sd = devm_kzalloc(&hdev->dev, sizeof(*sd), GFP_KERNEL);
550 hid_err(hdev, "cannot allocate Sensor data\n");
553 sd->hsdev = devm_kzalloc(&hdev->dev, sizeof(*sd->hsdev), GFP_KERNEL);
555 hid_err(hdev, "cannot allocate hid_sensor_hub_device\n");
558 hid_set_drvdata(hdev, sd);
559 sd->quirks = id->driver_data;
560 sd->hsdev->hdev = hdev;
561 sd->hsdev->vendor_id = hdev->vendor;
562 sd->hsdev->product_id = hdev->product;
563 spin_lock_init(&sd->lock);
564 spin_lock_init(&sd->dyn_callback_lock);
565 mutex_init(&sd->mutex);
566 ret = hid_parse(hdev);
568 hid_err(hdev, "parse failed\n");
571 INIT_LIST_HEAD(&hdev->inputs);
573 ret = hid_hw_start(hdev, 0);
575 hid_err(hdev, "hw start failed\n");
578 INIT_LIST_HEAD(&sd->dyn_callback_list);
579 sd->hid_sensor_client_cnt = 0;
580 report_enum = &hdev->report_enum[HID_INPUT_REPORT];
582 dev_cnt = sensor_hub_get_physical_device_count(report_enum);
583 if (dev_cnt > HID_MAX_PHY_DEVICES) {
584 hid_err(hdev, "Invalid Physical device count\n");
588 sd->hid_sensor_hub_client_devs = kzalloc(dev_cnt *
589 sizeof(struct mfd_cell),
591 if (sd->hid_sensor_hub_client_devs == NULL) {
592 hid_err(hdev, "Failed to allocate memory for mfd cells\n");
596 list_for_each_entry(report, &report_enum->report_list, list) {
597 hid_dbg(hdev, "Report id:%x\n", report->id);
598 field = report->field[0];
599 if (report->maxfield && field &&
601 name = kasprintf(GFP_KERNEL, "HID-SENSOR-%x",
604 hid_err(hdev, "Failed MFD device name\n");
608 sd->hid_sensor_hub_client_devs[
609 sd->hid_sensor_client_cnt].id = PLATFORM_DEVID_AUTO;
610 sd->hid_sensor_hub_client_devs[
611 sd->hid_sensor_client_cnt].name = name;
612 sd->hid_sensor_hub_client_devs[
613 sd->hid_sensor_client_cnt].platform_data =
615 sd->hid_sensor_hub_client_devs[
616 sd->hid_sensor_client_cnt].pdata_size =
618 hid_dbg(hdev, "Adding %s:%p\n", name, sd);
619 sd->hid_sensor_client_cnt++;
622 ret = mfd_add_devices(&hdev->dev, 0, sd->hid_sensor_hub_client_devs,
623 sd->hid_sensor_client_cnt, NULL, 0, NULL);
630 for (i = 0; i < sd->hid_sensor_client_cnt ; ++i)
631 kfree(sd->hid_sensor_hub_client_devs[i].name);
632 kfree(sd->hid_sensor_hub_client_devs);
639 static void sensor_hub_remove(struct hid_device *hdev)
641 struct sensor_hub_data *data = hid_get_drvdata(hdev);
645 hid_dbg(hdev, " hardware removed\n");
648 spin_lock_irqsave(&data->lock, flags);
649 if (data->pending.status)
650 complete(&data->pending.ready);
651 spin_unlock_irqrestore(&data->lock, flags);
652 mfd_remove_devices(&hdev->dev);
653 for (i = 0; i < data->hid_sensor_client_cnt ; ++i)
654 kfree(data->hid_sensor_hub_client_devs[i].name);
655 kfree(data->hid_sensor_hub_client_devs);
656 hid_set_drvdata(hdev, NULL);
657 mutex_destroy(&data->mutex);
660 static const struct hid_device_id sensor_hub_devices[] = {
661 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_INTEL_0,
662 USB_DEVICE_ID_INTEL_HID_SENSOR),
663 .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
664 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_INTEL_1,
665 USB_DEVICE_ID_INTEL_HID_SENSOR),
666 .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
667 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_STM_0,
668 USB_DEVICE_ID_STM_HID_SENSOR),
669 .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
670 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, HID_ANY_ID,
674 MODULE_DEVICE_TABLE(hid, sensor_hub_devices);
676 static struct hid_driver sensor_hub_driver = {
677 .name = "hid-sensor-hub",
678 .id_table = sensor_hub_devices,
679 .probe = sensor_hub_probe,
680 .remove = sensor_hub_remove,
681 .raw_event = sensor_hub_raw_event,
682 .report_fixup = sensor_hub_report_fixup,
684 .suspend = sensor_hub_suspend,
685 .resume = sensor_hub_resume,
686 .reset_resume = sensor_hub_reset_resume,
689 module_hid_driver(sensor_hub_driver);
691 MODULE_DESCRIPTION("HID Sensor Hub driver");
692 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
693 MODULE_LICENSE("GPL");