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.
20 #include <linux/device.h>
21 #include <linux/hid.h>
22 #include <linux/module.h>
23 #include <linux/slab.h>
24 #include <linux/mfd/core.h>
25 #include <linux/list.h>
26 #include <linux/hid-sensor-ids.h>
27 #include <linux/hid-sensor-hub.h>
30 #define HID_SENSOR_HUB_ENUM_QUIRK 0x01
33 * struct sensor_hub_data - Hold a instance data for a HID hub device
34 * @hsdev: Stored hid instance for current hub device.
35 * @mutex: Mutex to serialize synchronous request.
36 * @lock: Spin lock to protect pending request structure.
37 * @dyn_callback_list: Holds callback function
38 * @dyn_callback_lock: spin lock to protect callback list
39 * @hid_sensor_hub_client_devs: Stores all MFD cells for a hub instance.
40 * @hid_sensor_client_cnt: Number of MFD cells, (no of sensors attached).
41 * @ref_cnt: Number of MFD clients have opened this device
43 struct sensor_hub_data {
46 struct list_head dyn_callback_list;
47 spinlock_t dyn_callback_lock;
48 struct mfd_cell *hid_sensor_hub_client_devs;
49 int hid_sensor_client_cnt;
55 * struct hid_sensor_hub_callbacks_list - Stores callback list
57 * @usage_id: usage id for a physical device.
58 * @usage_callback: Stores registered callback functions.
59 * @priv: Private data for a physical device.
61 struct hid_sensor_hub_callbacks_list {
62 struct list_head list;
64 struct hid_sensor_hub_device *hsdev;
65 struct hid_sensor_hub_callbacks *usage_callback;
69 static struct hid_report *sensor_hub_report(int id, struct hid_device *hdev,
72 struct hid_report *report;
74 list_for_each_entry(report, &hdev->report_enum[dir].report_list, list) {
78 hid_warn(hdev, "No report with id 0x%x found\n", id);
83 static int sensor_hub_get_physical_device_count(struct hid_device *hdev)
88 for (i = 0; i < hdev->maxcollection; ++i) {
89 struct hid_collection *collection = &hdev->collection[i];
90 if (collection->type == HID_COLLECTION_PHYSICAL ||
91 collection->type == HID_COLLECTION_APPLICATION)
98 static void sensor_hub_fill_attr_info(
99 struct hid_sensor_hub_attribute_info *info,
100 s32 index, s32 report_id, struct hid_field *field)
103 info->report_id = report_id;
104 info->units = field->unit;
105 info->unit_expo = field->unit_exponent;
106 info->size = (field->report_size * field->report_count)/8;
107 info->logical_minimum = field->logical_minimum;
108 info->logical_maximum = field->logical_maximum;
111 static struct hid_sensor_hub_callbacks *sensor_hub_get_callback(
112 struct hid_device *hdev,
114 int collection_index,
115 struct hid_sensor_hub_device **hsdev,
118 struct hid_sensor_hub_callbacks_list *callback;
119 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
122 spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
123 list_for_each_entry(callback, &pdata->dyn_callback_list, list)
124 if ((callback->usage_id == usage_id ||
125 callback->usage_id == HID_USAGE_SENSOR_COLLECTION) &&
127 callback->hsdev->start_collection_index) &&
129 callback->hsdev->end_collection_index)) {
130 *priv = callback->priv;
131 *hsdev = callback->hsdev;
132 spin_unlock_irqrestore(&pdata->dyn_callback_lock,
134 return callback->usage_callback;
136 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
141 int sensor_hub_register_callback(struct hid_sensor_hub_device *hsdev,
143 struct hid_sensor_hub_callbacks *usage_callback)
145 struct hid_sensor_hub_callbacks_list *callback;
146 struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);
149 spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
150 list_for_each_entry(callback, &pdata->dyn_callback_list, list)
151 if (callback->usage_id == usage_id &&
152 callback->hsdev == hsdev) {
153 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
156 callback = kzalloc(sizeof(*callback), GFP_ATOMIC);
158 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
161 callback->hsdev = hsdev;
162 callback->usage_callback = usage_callback;
163 callback->usage_id = usage_id;
164 callback->priv = NULL;
166 * If there is a handler registered for the collection type, then
167 * it will handle all reports for sensors in this collection. If
168 * there is also an individual sensor handler registration, then
169 * we want to make sure that the reports are directed to collection
170 * handler, as this may be a fusion sensor. So add collection handlers
171 * to the beginning of the list, so that they are matched first.
173 if (usage_id == HID_USAGE_SENSOR_COLLECTION)
174 list_add(&callback->list, &pdata->dyn_callback_list);
176 list_add_tail(&callback->list, &pdata->dyn_callback_list);
177 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
181 EXPORT_SYMBOL_GPL(sensor_hub_register_callback);
183 int sensor_hub_remove_callback(struct hid_sensor_hub_device *hsdev,
186 struct hid_sensor_hub_callbacks_list *callback;
187 struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);
190 spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
191 list_for_each_entry(callback, &pdata->dyn_callback_list, list)
192 if (callback->usage_id == usage_id &&
193 callback->hsdev == hsdev) {
194 list_del(&callback->list);
198 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
202 EXPORT_SYMBOL_GPL(sensor_hub_remove_callback);
204 int sensor_hub_set_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
205 u32 field_index, int buffer_size, void *buffer)
207 struct hid_report *report;
208 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
209 __s32 *buf32 = buffer;
215 mutex_lock(&data->mutex);
216 report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
217 if (!report || (field_index >= report->maxfield)) {
222 remaining_bytes = buffer_size % sizeof(__s32);
223 buffer_size = buffer_size / sizeof(__s32);
225 for (i = 0; i < buffer_size; ++i) {
226 ret = hid_set_field(report->field[field_index], i,
227 (__force __s32)cpu_to_le32(*buf32));
234 if (remaining_bytes) {
236 memcpy(&value, (u8 *)buf32, remaining_bytes);
237 ret = hid_set_field(report->field[field_index], i,
238 (__force __s32)cpu_to_le32(value));
242 hid_hw_request(hsdev->hdev, report, HID_REQ_SET_REPORT);
243 hid_hw_wait(hsdev->hdev);
246 mutex_unlock(&data->mutex);
250 EXPORT_SYMBOL_GPL(sensor_hub_set_feature);
252 int sensor_hub_get_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
253 u32 field_index, int buffer_size, void *buffer)
255 struct hid_report *report;
256 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
260 int buffer_index = 0;
263 memset(buffer, 0, buffer_size);
265 mutex_lock(&data->mutex);
266 report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
267 if (!report || (field_index >= report->maxfield) ||
268 report->field[field_index]->report_count < 1) {
272 hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
273 hid_hw_wait(hsdev->hdev);
275 /* calculate number of bytes required to read this field */
276 report_size = DIV_ROUND_UP(report->field[field_index]->report_size,
278 report->field[field_index]->report_count;
283 ret = min(report_size, buffer_size);
285 val_ptr = (u8 *)report->field[field_index]->value;
286 for (i = 0; i < report->field[field_index]->report_count; ++i) {
287 if (buffer_index >= ret)
290 memcpy(&((u8 *)buffer)[buffer_index], val_ptr,
291 report->field[field_index]->report_size / 8);
292 val_ptr += sizeof(__s32);
293 buffer_index += (report->field[field_index]->report_size / 8);
297 mutex_unlock(&data->mutex);
301 EXPORT_SYMBOL_GPL(sensor_hub_get_feature);
304 int sensor_hub_input_attr_get_raw_value(struct hid_sensor_hub_device *hsdev,
306 u32 attr_usage_id, u32 report_id,
307 enum sensor_hub_read_flags flag,
310 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
312 struct hid_report *report;
315 report = sensor_hub_report(report_id, hsdev->hdev,
320 mutex_lock(hsdev->mutex_ptr);
321 if (flag == SENSOR_HUB_SYNC) {
322 memset(&hsdev->pending, 0, sizeof(hsdev->pending));
323 init_completion(&hsdev->pending.ready);
324 hsdev->pending.usage_id = usage_id;
325 hsdev->pending.attr_usage_id = attr_usage_id;
326 hsdev->pending.raw_size = 0;
328 spin_lock_irqsave(&data->lock, flags);
329 hsdev->pending.status = true;
330 spin_unlock_irqrestore(&data->lock, flags);
332 mutex_lock(&data->mutex);
333 hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
334 mutex_unlock(&data->mutex);
335 if (flag == SENSOR_HUB_SYNC) {
336 wait_for_completion_interruptible_timeout(
337 &hsdev->pending.ready, HZ*5);
338 switch (hsdev->pending.raw_size) {
341 ret_val = *(s8 *)hsdev->pending.raw_data;
343 ret_val = *(u8 *)hsdev->pending.raw_data;
347 ret_val = *(s16 *)hsdev->pending.raw_data;
349 ret_val = *(u16 *)hsdev->pending.raw_data;
352 ret_val = *(u32 *)hsdev->pending.raw_data;
357 kfree(hsdev->pending.raw_data);
358 hsdev->pending.status = false;
360 mutex_unlock(hsdev->mutex_ptr);
364 EXPORT_SYMBOL_GPL(sensor_hub_input_attr_get_raw_value);
366 int hid_sensor_get_usage_index(struct hid_sensor_hub_device *hsdev,
367 u32 report_id, int field_index, u32 usage_id)
369 struct hid_report *report;
370 struct hid_field *field;
373 report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
374 if (!report || (field_index >= report->maxfield))
377 field = report->field[field_index];
378 for (i = 0; i < field->maxusage; ++i) {
379 if (field->usage[i].hid == usage_id)
380 return field->usage[i].usage_index;
386 EXPORT_SYMBOL_GPL(hid_sensor_get_usage_index);
388 int sensor_hub_input_get_attribute_info(struct hid_sensor_hub_device *hsdev,
392 struct hid_sensor_hub_attribute_info *info)
396 struct hid_report *report;
397 struct hid_field *field;
398 struct hid_report_enum *report_enum;
399 struct hid_device *hdev = hsdev->hdev;
401 /* Initialize with defaults */
402 info->usage_id = usage_id;
403 info->attrib_id = attr_usage_id;
404 info->report_id = -1;
407 info->unit_expo = -1;
409 report_enum = &hdev->report_enum[type];
410 list_for_each_entry(report, &report_enum->report_list, list) {
411 for (i = 0; i < report->maxfield; ++i) {
412 field = report->field[i];
413 if (field->maxusage) {
414 if (field->physical == usage_id &&
415 (field->logical == attr_usage_id ||
416 field->usage[0].hid ==
418 (field->usage[0].collection_index >=
419 hsdev->start_collection_index) &&
420 (field->usage[0].collection_index <
421 hsdev->end_collection_index)) {
423 sensor_hub_fill_attr_info(info, i,
436 EXPORT_SYMBOL_GPL(sensor_hub_input_get_attribute_info);
439 static int sensor_hub_suspend(struct hid_device *hdev, pm_message_t message)
441 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
442 struct hid_sensor_hub_callbacks_list *callback;
445 hid_dbg(hdev, " sensor_hub_suspend\n");
446 spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
447 list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
448 if (callback->usage_callback->suspend)
449 callback->usage_callback->suspend(
450 callback->hsdev, callback->priv);
452 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
457 static int sensor_hub_resume(struct hid_device *hdev)
459 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
460 struct hid_sensor_hub_callbacks_list *callback;
463 hid_dbg(hdev, " sensor_hub_resume\n");
464 spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
465 list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
466 if (callback->usage_callback->resume)
467 callback->usage_callback->resume(
468 callback->hsdev, callback->priv);
470 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
475 static int sensor_hub_reset_resume(struct hid_device *hdev)
482 * Handle raw report as sent by device
484 static int sensor_hub_raw_event(struct hid_device *hdev,
485 struct hid_report *report, u8 *raw_data, int size)
490 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
492 struct hid_sensor_hub_callbacks *callback = NULL;
493 struct hid_collection *collection = NULL;
495 struct hid_sensor_hub_device *hsdev = NULL;
497 hid_dbg(hdev, "sensor_hub_raw_event report id:0x%x size:%d type:%d\n",
498 report->id, size, report->type);
499 hid_dbg(hdev, "maxfield:%d\n", report->maxfield);
500 if (report->type != HID_INPUT_REPORT)
505 ptr++; /* Skip report id */
507 spin_lock_irqsave(&pdata->lock, flags);
509 for (i = 0; i < report->maxfield; ++i) {
510 hid_dbg(hdev, "%d collection_index:%x hid:%x sz:%x\n",
511 i, report->field[i]->usage->collection_index,
512 report->field[i]->usage->hid,
513 (report->field[i]->report_size *
514 report->field[i]->report_count)/8);
515 sz = (report->field[i]->report_size *
516 report->field[i]->report_count)/8;
517 collection = &hdev->collection[
518 report->field[i]->usage->collection_index];
519 hid_dbg(hdev, "collection->usage %x\n",
522 callback = sensor_hub_get_callback(hdev,
523 report->field[i]->physical,
524 report->field[i]->usage[0].collection_index,
530 if (hsdev->pending.status && (hsdev->pending.attr_usage_id ==
531 report->field[i]->usage->hid ||
532 hsdev->pending.attr_usage_id ==
533 report->field[i]->logical)) {
534 hid_dbg(hdev, "data was pending ...\n");
535 hsdev->pending.raw_data = kmemdup(ptr, sz, GFP_ATOMIC);
536 if (hsdev->pending.raw_data)
537 hsdev->pending.raw_size = sz;
539 hsdev->pending.raw_size = 0;
540 complete(&hsdev->pending.ready);
542 if (callback->capture_sample) {
543 if (report->field[i]->logical)
544 callback->capture_sample(hsdev,
545 report->field[i]->logical, sz, ptr,
548 callback->capture_sample(hsdev,
549 report->field[i]->usage->hid, sz, ptr,
554 if (callback && collection && callback->send_event)
555 callback->send_event(hsdev, collection->usage,
557 spin_unlock_irqrestore(&pdata->lock, flags);
562 int sensor_hub_device_open(struct hid_sensor_hub_device *hsdev)
565 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
567 mutex_lock(&data->mutex);
568 if (!data->ref_cnt) {
569 ret = hid_hw_open(hsdev->hdev);
571 hid_err(hsdev->hdev, "failed to open hid device\n");
572 mutex_unlock(&data->mutex);
577 mutex_unlock(&data->mutex);
581 EXPORT_SYMBOL_GPL(sensor_hub_device_open);
583 void sensor_hub_device_close(struct hid_sensor_hub_device *hsdev)
585 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
587 mutex_lock(&data->mutex);
590 hid_hw_close(hsdev->hdev);
591 mutex_unlock(&data->mutex);
593 EXPORT_SYMBOL_GPL(sensor_hub_device_close);
595 static __u8 *sensor_hub_report_fixup(struct hid_device *hdev, __u8 *rdesc,
599 * Checks if the report descriptor of Thinkpad Helix 2 has a logical
600 * minimum for magnetic flux axis greater than the maximum.
602 if (hdev->product == USB_DEVICE_ID_TEXAS_INSTRUMENTS_LENOVO_YOGA &&
603 *rsize == 2558 && rdesc[913] == 0x17 && rdesc[914] == 0x40 &&
604 rdesc[915] == 0x81 && rdesc[916] == 0x08 &&
605 rdesc[917] == 0x00 && rdesc[918] == 0x27 &&
606 rdesc[921] == 0x07 && rdesc[922] == 0x00) {
607 /* Sets negative logical minimum for mag x, y and z */
608 rdesc[914] = rdesc[935] = rdesc[956] = 0xc0;
609 rdesc[915] = rdesc[936] = rdesc[957] = 0x7e;
610 rdesc[916] = rdesc[937] = rdesc[958] = 0xf7;
611 rdesc[917] = rdesc[938] = rdesc[959] = 0xff;
617 static int sensor_hub_probe(struct hid_device *hdev,
618 const struct hid_device_id *id)
621 struct sensor_hub_data *sd;
625 struct hid_sensor_hub_device *hsdev;
626 struct hid_sensor_hub_device *last_hsdev = NULL;
627 struct hid_sensor_hub_device *collection_hsdev = NULL;
629 sd = devm_kzalloc(&hdev->dev, sizeof(*sd), GFP_KERNEL);
631 hid_err(hdev, "cannot allocate Sensor data\n");
635 hid_set_drvdata(hdev, sd);
636 sd->quirks = id->driver_data;
638 spin_lock_init(&sd->lock);
639 spin_lock_init(&sd->dyn_callback_lock);
640 mutex_init(&sd->mutex);
641 ret = hid_parse(hdev);
643 hid_err(hdev, "parse failed\n");
646 INIT_LIST_HEAD(&hdev->inputs);
648 ret = hid_hw_start(hdev, 0);
650 hid_err(hdev, "hw start failed\n");
653 INIT_LIST_HEAD(&sd->dyn_callback_list);
654 sd->hid_sensor_client_cnt = 0;
656 dev_cnt = sensor_hub_get_physical_device_count(hdev);
657 if (dev_cnt > HID_MAX_PHY_DEVICES) {
658 hid_err(hdev, "Invalid Physical device count\n");
662 sd->hid_sensor_hub_client_devs = devm_kcalloc(&hdev->dev,
664 sizeof(struct mfd_cell),
666 if (sd->hid_sensor_hub_client_devs == NULL) {
667 hid_err(hdev, "Failed to allocate memory for mfd cells\n");
672 for (i = 0; i < hdev->maxcollection; ++i) {
673 struct hid_collection *collection = &hdev->collection[i];
675 if (collection->type == HID_COLLECTION_PHYSICAL ||
676 collection->type == HID_COLLECTION_APPLICATION) {
678 hsdev = devm_kzalloc(&hdev->dev, sizeof(*hsdev),
681 hid_err(hdev, "cannot allocate hid_sensor_hub_device\n");
686 hsdev->vendor_id = hdev->vendor;
687 hsdev->product_id = hdev->product;
688 hsdev->usage = collection->usage;
689 hsdev->mutex_ptr = devm_kzalloc(&hdev->dev,
690 sizeof(struct mutex),
692 if (!hsdev->mutex_ptr) {
696 mutex_init(hsdev->mutex_ptr);
697 hsdev->start_collection_index = i;
699 last_hsdev->end_collection_index = i;
701 name = devm_kasprintf(&hdev->dev, GFP_KERNEL,
705 hid_err(hdev, "Failed MFD device name\n");
709 sd->hid_sensor_hub_client_devs[
710 sd->hid_sensor_client_cnt].name = name;
711 sd->hid_sensor_hub_client_devs[
712 sd->hid_sensor_client_cnt].platform_data =
714 sd->hid_sensor_hub_client_devs[
715 sd->hid_sensor_client_cnt].pdata_size =
717 hid_dbg(hdev, "Adding %s:%d\n", name,
718 hsdev->start_collection_index);
719 sd->hid_sensor_client_cnt++;
720 if (collection_hsdev)
721 collection_hsdev->end_collection_index = i;
722 if (collection->type == HID_COLLECTION_APPLICATION &&
723 collection->usage == HID_USAGE_SENSOR_COLLECTION)
724 collection_hsdev = hsdev;
728 last_hsdev->end_collection_index = i;
729 if (collection_hsdev)
730 collection_hsdev->end_collection_index = i;
732 ret = mfd_add_hotplug_devices(&hdev->dev,
733 sd->hid_sensor_hub_client_devs,
734 sd->hid_sensor_client_cnt);
746 static void sensor_hub_remove(struct hid_device *hdev)
748 struct sensor_hub_data *data = hid_get_drvdata(hdev);
752 hid_dbg(hdev, " hardware removed\n");
755 spin_lock_irqsave(&data->lock, flags);
756 for (i = 0; i < data->hid_sensor_client_cnt; ++i) {
757 struct hid_sensor_hub_device *hsdev =
758 data->hid_sensor_hub_client_devs[i].platform_data;
759 if (hsdev->pending.status)
760 complete(&hsdev->pending.ready);
762 spin_unlock_irqrestore(&data->lock, flags);
763 mfd_remove_devices(&hdev->dev);
764 hid_set_drvdata(hdev, NULL);
765 mutex_destroy(&data->mutex);
768 static const struct hid_device_id sensor_hub_devices[] = {
769 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, HID_ANY_ID,
773 MODULE_DEVICE_TABLE(hid, sensor_hub_devices);
775 static struct hid_driver sensor_hub_driver = {
776 .name = "hid-sensor-hub",
777 .id_table = sensor_hub_devices,
778 .probe = sensor_hub_probe,
779 .remove = sensor_hub_remove,
780 .raw_event = sensor_hub_raw_event,
781 .report_fixup = sensor_hub_report_fixup,
783 .suspend = sensor_hub_suspend,
784 .resume = sensor_hub_resume,
785 .reset_resume = sensor_hub_reset_resume,
788 module_hid_driver(sensor_hub_driver);
790 MODULE_DESCRIPTION("HID Sensor Hub driver");
791 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
792 MODULE_LICENSE("GPL");