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 hid_set_field(report->field[field_index], i,
227 (__force __s32)cpu_to_le32(*buf32));
231 if (remaining_bytes) {
233 memcpy(&value, (u8 *)buf32, remaining_bytes);
234 hid_set_field(report->field[field_index], i,
235 (__force __s32)cpu_to_le32(value));
237 hid_hw_request(hsdev->hdev, report, HID_REQ_SET_REPORT);
238 hid_hw_wait(hsdev->hdev);
241 mutex_unlock(&data->mutex);
245 EXPORT_SYMBOL_GPL(sensor_hub_set_feature);
247 int sensor_hub_get_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
248 u32 field_index, int buffer_size, void *buffer)
250 struct hid_report *report;
251 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
255 int buffer_index = 0;
258 memset(buffer, 0, buffer_size);
260 mutex_lock(&data->mutex);
261 report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
262 if (!report || (field_index >= report->maxfield) ||
263 report->field[field_index]->report_count < 1) {
267 hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
268 hid_hw_wait(hsdev->hdev);
270 /* calculate number of bytes required to read this field */
271 report_size = DIV_ROUND_UP(report->field[field_index]->report_size,
273 report->field[field_index]->report_count;
278 ret = min(report_size, buffer_size);
280 val_ptr = (u8 *)report->field[field_index]->value;
281 for (i = 0; i < report->field[field_index]->report_count; ++i) {
282 if (buffer_index >= ret)
285 memcpy(&((u8 *)buffer)[buffer_index], val_ptr,
286 report->field[field_index]->report_size / 8);
287 val_ptr += sizeof(__s32);
288 buffer_index += (report->field[field_index]->report_size / 8);
292 mutex_unlock(&data->mutex);
296 EXPORT_SYMBOL_GPL(sensor_hub_get_feature);
299 int sensor_hub_input_attr_get_raw_value(struct hid_sensor_hub_device *hsdev,
301 u32 attr_usage_id, u32 report_id,
302 enum sensor_hub_read_flags flag,
305 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
307 struct hid_report *report;
310 report = sensor_hub_report(report_id, hsdev->hdev,
315 mutex_lock(hsdev->mutex_ptr);
316 if (flag == SENSOR_HUB_SYNC) {
317 memset(&hsdev->pending, 0, sizeof(hsdev->pending));
318 init_completion(&hsdev->pending.ready);
319 hsdev->pending.usage_id = usage_id;
320 hsdev->pending.attr_usage_id = attr_usage_id;
321 hsdev->pending.raw_size = 0;
323 spin_lock_irqsave(&data->lock, flags);
324 hsdev->pending.status = true;
325 spin_unlock_irqrestore(&data->lock, flags);
327 mutex_lock(&data->mutex);
328 hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
329 mutex_unlock(&data->mutex);
330 if (flag == SENSOR_HUB_SYNC) {
331 wait_for_completion_interruptible_timeout(
332 &hsdev->pending.ready, HZ*5);
333 switch (hsdev->pending.raw_size) {
336 ret_val = *(s8 *)hsdev->pending.raw_data;
338 ret_val = *(u8 *)hsdev->pending.raw_data;
342 ret_val = *(s16 *)hsdev->pending.raw_data;
344 ret_val = *(u16 *)hsdev->pending.raw_data;
347 ret_val = *(u32 *)hsdev->pending.raw_data;
352 kfree(hsdev->pending.raw_data);
353 hsdev->pending.status = false;
355 mutex_unlock(hsdev->mutex_ptr);
359 EXPORT_SYMBOL_GPL(sensor_hub_input_attr_get_raw_value);
361 int hid_sensor_get_usage_index(struct hid_sensor_hub_device *hsdev,
362 u32 report_id, int field_index, u32 usage_id)
364 struct hid_report *report;
365 struct hid_field *field;
368 report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
369 if (!report || (field_index >= report->maxfield))
372 field = report->field[field_index];
373 for (i = 0; i < field->maxusage; ++i) {
374 if (field->usage[i].hid == usage_id)
375 return field->usage[i].usage_index;
381 EXPORT_SYMBOL_GPL(hid_sensor_get_usage_index);
383 int sensor_hub_input_get_attribute_info(struct hid_sensor_hub_device *hsdev,
387 struct hid_sensor_hub_attribute_info *info)
391 struct hid_report *report;
392 struct hid_field *field;
393 struct hid_report_enum *report_enum;
394 struct hid_device *hdev = hsdev->hdev;
396 /* Initialize with defaults */
397 info->usage_id = usage_id;
398 info->attrib_id = attr_usage_id;
399 info->report_id = -1;
402 info->unit_expo = -1;
404 report_enum = &hdev->report_enum[type];
405 list_for_each_entry(report, &report_enum->report_list, list) {
406 for (i = 0; i < report->maxfield; ++i) {
407 field = report->field[i];
408 if (field->maxusage) {
409 if (field->physical == usage_id &&
410 (field->logical == attr_usage_id ||
411 field->usage[0].hid ==
413 (field->usage[0].collection_index >=
414 hsdev->start_collection_index) &&
415 (field->usage[0].collection_index <
416 hsdev->end_collection_index)) {
418 sensor_hub_fill_attr_info(info, i,
431 EXPORT_SYMBOL_GPL(sensor_hub_input_get_attribute_info);
434 static int sensor_hub_suspend(struct hid_device *hdev, pm_message_t message)
436 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
437 struct hid_sensor_hub_callbacks_list *callback;
440 hid_dbg(hdev, " sensor_hub_suspend\n");
441 spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
442 list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
443 if (callback->usage_callback->suspend)
444 callback->usage_callback->suspend(
445 callback->hsdev, callback->priv);
447 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
452 static int sensor_hub_resume(struct hid_device *hdev)
454 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
455 struct hid_sensor_hub_callbacks_list *callback;
458 hid_dbg(hdev, " sensor_hub_resume\n");
459 spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
460 list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
461 if (callback->usage_callback->resume)
462 callback->usage_callback->resume(
463 callback->hsdev, callback->priv);
465 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
470 static int sensor_hub_reset_resume(struct hid_device *hdev)
477 * Handle raw report as sent by device
479 static int sensor_hub_raw_event(struct hid_device *hdev,
480 struct hid_report *report, u8 *raw_data, int size)
485 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
487 struct hid_sensor_hub_callbacks *callback = NULL;
488 struct hid_collection *collection = NULL;
490 struct hid_sensor_hub_device *hsdev = NULL;
492 hid_dbg(hdev, "sensor_hub_raw_event report id:0x%x size:%d type:%d\n",
493 report->id, size, report->type);
494 hid_dbg(hdev, "maxfield:%d\n", report->maxfield);
495 if (report->type != HID_INPUT_REPORT)
499 ptr++; /* Skip report id */
501 spin_lock_irqsave(&pdata->lock, flags);
503 for (i = 0; i < report->maxfield; ++i) {
504 hid_dbg(hdev, "%d collection_index:%x hid:%x sz:%x\n",
505 i, report->field[i]->usage->collection_index,
506 report->field[i]->usage->hid,
507 (report->field[i]->report_size *
508 report->field[i]->report_count)/8);
509 sz = (report->field[i]->report_size *
510 report->field[i]->report_count)/8;
511 collection = &hdev->collection[
512 report->field[i]->usage->collection_index];
513 hid_dbg(hdev, "collection->usage %x\n",
516 callback = sensor_hub_get_callback(hdev,
517 report->field[i]->physical,
518 report->field[i]->usage[0].collection_index,
524 if (hsdev->pending.status && (hsdev->pending.attr_usage_id ==
525 report->field[i]->usage->hid ||
526 hsdev->pending.attr_usage_id ==
527 report->field[i]->logical)) {
528 hid_dbg(hdev, "data was pending ...\n");
529 hsdev->pending.raw_data = kmemdup(ptr, sz, GFP_ATOMIC);
530 if (hsdev->pending.raw_data)
531 hsdev->pending.raw_size = sz;
533 hsdev->pending.raw_size = 0;
534 complete(&hsdev->pending.ready);
536 if (callback->capture_sample) {
537 if (report->field[i]->logical)
538 callback->capture_sample(hsdev,
539 report->field[i]->logical, sz, ptr,
542 callback->capture_sample(hsdev,
543 report->field[i]->usage->hid, sz, ptr,
548 if (callback && collection && callback->send_event)
549 callback->send_event(hsdev, collection->usage,
551 spin_unlock_irqrestore(&pdata->lock, flags);
556 int sensor_hub_device_open(struct hid_sensor_hub_device *hsdev)
559 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
561 mutex_lock(&data->mutex);
562 if (!data->ref_cnt) {
563 ret = hid_hw_open(hsdev->hdev);
565 hid_err(hsdev->hdev, "failed to open hid device\n");
566 mutex_unlock(&data->mutex);
571 mutex_unlock(&data->mutex);
575 EXPORT_SYMBOL_GPL(sensor_hub_device_open);
577 void sensor_hub_device_close(struct hid_sensor_hub_device *hsdev)
579 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
581 mutex_lock(&data->mutex);
584 hid_hw_close(hsdev->hdev);
585 mutex_unlock(&data->mutex);
587 EXPORT_SYMBOL_GPL(sensor_hub_device_close);
589 static __u8 *sensor_hub_report_fixup(struct hid_device *hdev, __u8 *rdesc,
593 * Checks if the report descriptor of Thinkpad Helix 2 has a logical
594 * minimum for magnetic flux axis greater than the maximum.
596 if (hdev->product == USB_DEVICE_ID_TEXAS_INSTRUMENTS_LENOVO_YOGA &&
597 *rsize == 2558 && rdesc[913] == 0x17 && rdesc[914] == 0x40 &&
598 rdesc[915] == 0x81 && rdesc[916] == 0x08 &&
599 rdesc[917] == 0x00 && rdesc[918] == 0x27 &&
600 rdesc[921] == 0x07 && rdesc[922] == 0x00) {
601 /* Sets negative logical minimum for mag x, y and z */
602 rdesc[914] = rdesc[935] = rdesc[956] = 0xc0;
603 rdesc[915] = rdesc[936] = rdesc[957] = 0x7e;
604 rdesc[916] = rdesc[937] = rdesc[958] = 0xf7;
605 rdesc[917] = rdesc[938] = rdesc[959] = 0xff;
611 static int sensor_hub_probe(struct hid_device *hdev,
612 const struct hid_device_id *id)
615 struct sensor_hub_data *sd;
619 struct hid_sensor_hub_device *hsdev;
620 struct hid_sensor_hub_device *last_hsdev = NULL;
621 struct hid_sensor_hub_device *collection_hsdev = NULL;
623 sd = devm_kzalloc(&hdev->dev, sizeof(*sd), GFP_KERNEL);
625 hid_err(hdev, "cannot allocate Sensor data\n");
629 hid_set_drvdata(hdev, sd);
630 sd->quirks = id->driver_data;
632 spin_lock_init(&sd->lock);
633 spin_lock_init(&sd->dyn_callback_lock);
634 mutex_init(&sd->mutex);
635 ret = hid_parse(hdev);
637 hid_err(hdev, "parse failed\n");
640 INIT_LIST_HEAD(&hdev->inputs);
642 ret = hid_hw_start(hdev, 0);
644 hid_err(hdev, "hw start failed\n");
647 INIT_LIST_HEAD(&sd->dyn_callback_list);
648 sd->hid_sensor_client_cnt = 0;
650 dev_cnt = sensor_hub_get_physical_device_count(hdev);
651 if (dev_cnt > HID_MAX_PHY_DEVICES) {
652 hid_err(hdev, "Invalid Physical device count\n");
656 sd->hid_sensor_hub_client_devs = devm_kcalloc(&hdev->dev,
658 sizeof(struct mfd_cell),
660 if (sd->hid_sensor_hub_client_devs == NULL) {
661 hid_err(hdev, "Failed to allocate memory for mfd cells\n");
666 for (i = 0; i < hdev->maxcollection; ++i) {
667 struct hid_collection *collection = &hdev->collection[i];
669 if (collection->type == HID_COLLECTION_PHYSICAL ||
670 collection->type == HID_COLLECTION_APPLICATION) {
672 hsdev = devm_kzalloc(&hdev->dev, sizeof(*hsdev),
675 hid_err(hdev, "cannot allocate hid_sensor_hub_device\n");
680 hsdev->vendor_id = hdev->vendor;
681 hsdev->product_id = hdev->product;
682 hsdev->usage = collection->usage;
683 hsdev->mutex_ptr = devm_kzalloc(&hdev->dev,
684 sizeof(struct mutex),
686 if (!hsdev->mutex_ptr) {
690 mutex_init(hsdev->mutex_ptr);
691 hsdev->start_collection_index = i;
693 last_hsdev->end_collection_index = i;
695 name = devm_kasprintf(&hdev->dev, GFP_KERNEL,
699 hid_err(hdev, "Failed MFD device name\n");
703 sd->hid_sensor_hub_client_devs[
704 sd->hid_sensor_client_cnt].name = name;
705 sd->hid_sensor_hub_client_devs[
706 sd->hid_sensor_client_cnt].platform_data =
708 sd->hid_sensor_hub_client_devs[
709 sd->hid_sensor_client_cnt].pdata_size =
711 hid_dbg(hdev, "Adding %s:%d\n", name,
712 hsdev->start_collection_index);
713 sd->hid_sensor_client_cnt++;
714 if (collection_hsdev)
715 collection_hsdev->end_collection_index = i;
716 if (collection->type == HID_COLLECTION_APPLICATION &&
717 collection->usage == HID_USAGE_SENSOR_COLLECTION)
718 collection_hsdev = hsdev;
722 last_hsdev->end_collection_index = i;
723 if (collection_hsdev)
724 collection_hsdev->end_collection_index = i;
726 ret = mfd_add_hotplug_devices(&hdev->dev,
727 sd->hid_sensor_hub_client_devs,
728 sd->hid_sensor_client_cnt);
740 static void sensor_hub_remove(struct hid_device *hdev)
742 struct sensor_hub_data *data = hid_get_drvdata(hdev);
746 hid_dbg(hdev, " hardware removed\n");
749 spin_lock_irqsave(&data->lock, flags);
750 for (i = 0; i < data->hid_sensor_client_cnt; ++i) {
751 struct hid_sensor_hub_device *hsdev =
752 data->hid_sensor_hub_client_devs[i].platform_data;
753 if (hsdev->pending.status)
754 complete(&hsdev->pending.ready);
756 spin_unlock_irqrestore(&data->lock, flags);
757 mfd_remove_devices(&hdev->dev);
758 hid_set_drvdata(hdev, NULL);
759 mutex_destroy(&data->mutex);
762 static const struct hid_device_id sensor_hub_devices[] = {
763 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, HID_ANY_ID,
767 MODULE_DEVICE_TABLE(hid, sensor_hub_devices);
769 static struct hid_driver sensor_hub_driver = {
770 .name = "hid-sensor-hub",
771 .id_table = sensor_hub_devices,
772 .probe = sensor_hub_probe,
773 .remove = sensor_hub_remove,
774 .raw_event = sensor_hub_raw_event,
775 .report_fixup = sensor_hub_report_fixup,
777 .suspend = sensor_hub_suspend,
778 .resume = sensor_hub_resume,
779 .reset_resume = sensor_hub_reset_resume,
782 module_hid_driver(sensor_hub_driver);
784 MODULE_DESCRIPTION("HID Sensor Hub driver");
786 MODULE_LICENSE("GPL");