1 // SPDX-License-Identifier: GPL-2.0-only
4 * Copyright (c) 2012, Intel Corporation.
7 #include <linux/device.h>
9 #include <linux/module.h>
10 #include <linux/slab.h>
11 #include <linux/mfd/core.h>
12 #include <linux/list.h>
13 #include <linux/hid-sensor-ids.h>
14 #include <linux/hid-sensor-hub.h>
17 #define HID_SENSOR_HUB_ENUM_QUIRK 0x01
20 * struct sensor_hub_data - Hold a instance data for a HID hub device
21 * @mutex: Mutex to serialize synchronous request.
22 * @lock: Spin lock to protect pending request structure.
23 * @dyn_callback_list: Holds callback function
24 * @dyn_callback_lock: spin lock to protect callback list
25 * @hid_sensor_hub_client_devs: Stores all MFD cells for a hub instance.
26 * @hid_sensor_client_cnt: Number of MFD cells, (no of sensors attached).
27 * @ref_cnt: Number of MFD clients have opened this device
29 struct sensor_hub_data {
32 struct list_head dyn_callback_list;
33 spinlock_t dyn_callback_lock;
34 struct mfd_cell *hid_sensor_hub_client_devs;
35 int hid_sensor_client_cnt;
40 * struct hid_sensor_hub_callbacks_list - Stores callback list
42 * @usage_id: usage id for a physical device.
43 * @hsdev: Stored hid instance for current hub device.
44 * @usage_callback: Stores registered callback functions.
45 * @priv: Private data for a physical device.
47 struct hid_sensor_hub_callbacks_list {
48 struct list_head list;
50 struct hid_sensor_hub_device *hsdev;
51 struct hid_sensor_hub_callbacks *usage_callback;
55 static struct hid_report *sensor_hub_report(int id, struct hid_device *hdev,
58 struct hid_report *report;
60 list_for_each_entry(report, &hdev->report_enum[dir].report_list, list) {
64 hid_warn(hdev, "No report with id 0x%x found\n", id);
69 static int sensor_hub_get_physical_device_count(struct hid_device *hdev)
74 for (i = 0; i < hdev->maxcollection; ++i) {
75 struct hid_collection *collection = &hdev->collection[i];
76 if (collection->type == HID_COLLECTION_PHYSICAL ||
77 collection->type == HID_COLLECTION_APPLICATION)
84 static void sensor_hub_fill_attr_info(
85 struct hid_sensor_hub_attribute_info *info,
86 s32 index, s32 report_id, struct hid_field *field)
89 info->report_id = report_id;
90 info->units = field->unit;
91 info->unit_expo = field->unit_exponent;
92 info->size = (field->report_size * field->report_count)/8;
93 info->logical_minimum = field->logical_minimum;
94 info->logical_maximum = field->logical_maximum;
97 static struct hid_sensor_hub_callbacks *sensor_hub_get_callback(
98 struct hid_device *hdev,
100 int collection_index,
101 struct hid_sensor_hub_device **hsdev,
104 struct hid_sensor_hub_callbacks_list *callback;
105 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
108 spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
109 list_for_each_entry(callback, &pdata->dyn_callback_list, list)
110 if ((callback->usage_id == usage_id ||
111 callback->usage_id == HID_USAGE_SENSOR_COLLECTION) &&
113 callback->hsdev->start_collection_index) &&
115 callback->hsdev->end_collection_index)) {
116 *priv = callback->priv;
117 *hsdev = callback->hsdev;
118 spin_unlock_irqrestore(&pdata->dyn_callback_lock,
120 return callback->usage_callback;
122 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
127 int sensor_hub_register_callback(struct hid_sensor_hub_device *hsdev,
129 struct hid_sensor_hub_callbacks *usage_callback)
131 struct hid_sensor_hub_callbacks_list *callback;
132 struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);
135 spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
136 list_for_each_entry(callback, &pdata->dyn_callback_list, list)
137 if (callback->usage_id == usage_id &&
138 callback->hsdev == hsdev) {
139 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
142 callback = kzalloc(sizeof(*callback), GFP_ATOMIC);
144 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
147 callback->hsdev = hsdev;
148 callback->usage_callback = usage_callback;
149 callback->usage_id = usage_id;
150 callback->priv = NULL;
152 * If there is a handler registered for the collection type, then
153 * it will handle all reports for sensors in this collection. If
154 * there is also an individual sensor handler registration, then
155 * we want to make sure that the reports are directed to collection
156 * handler, as this may be a fusion sensor. So add collection handlers
157 * to the beginning of the list, so that they are matched first.
159 if (usage_id == HID_USAGE_SENSOR_COLLECTION)
160 list_add(&callback->list, &pdata->dyn_callback_list);
162 list_add_tail(&callback->list, &pdata->dyn_callback_list);
163 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
167 EXPORT_SYMBOL_GPL(sensor_hub_register_callback);
169 int sensor_hub_remove_callback(struct hid_sensor_hub_device *hsdev,
172 struct hid_sensor_hub_callbacks_list *callback;
173 struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);
176 spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
177 list_for_each_entry(callback, &pdata->dyn_callback_list, list)
178 if (callback->usage_id == usage_id &&
179 callback->hsdev == hsdev) {
180 list_del(&callback->list);
184 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
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, int buffer_size, void *buffer)
193 struct hid_report *report;
194 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
195 __s32 *buf32 = buffer;
201 mutex_lock(&data->mutex);
202 report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
203 if (!report || (field_index >= report->maxfield)) {
208 remaining_bytes = buffer_size % sizeof(__s32);
209 buffer_size = buffer_size / sizeof(__s32);
211 for (i = 0; i < buffer_size; ++i) {
212 hid_set_field(report->field[field_index], i,
213 (__force __s32)cpu_to_le32(*buf32));
217 if (remaining_bytes) {
219 memcpy(&value, (u8 *)buf32, remaining_bytes);
220 hid_set_field(report->field[field_index], i,
221 (__force __s32)cpu_to_le32(value));
223 hid_hw_request(hsdev->hdev, report, HID_REQ_SET_REPORT);
224 hid_hw_wait(hsdev->hdev);
227 mutex_unlock(&data->mutex);
231 EXPORT_SYMBOL_GPL(sensor_hub_set_feature);
233 int sensor_hub_get_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
234 u32 field_index, int buffer_size, void *buffer)
236 struct hid_report *report;
237 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
241 int buffer_index = 0;
244 memset(buffer, 0, buffer_size);
246 mutex_lock(&data->mutex);
247 report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
248 if (!report || (field_index >= report->maxfield) ||
249 report->field[field_index]->report_count < 1) {
253 hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
254 hid_hw_wait(hsdev->hdev);
256 /* calculate number of bytes required to read this field */
257 report_size = DIV_ROUND_UP(report->field[field_index]->report_size,
259 report->field[field_index]->report_count;
264 ret = min(report_size, buffer_size);
266 val_ptr = (u8 *)report->field[field_index]->value;
267 for (i = 0; i < report->field[field_index]->report_count; ++i) {
268 if (buffer_index >= ret)
271 memcpy(&((u8 *)buffer)[buffer_index], val_ptr,
272 report->field[field_index]->report_size / 8);
273 val_ptr += sizeof(__s32);
274 buffer_index += (report->field[field_index]->report_size / 8);
278 mutex_unlock(&data->mutex);
282 EXPORT_SYMBOL_GPL(sensor_hub_get_feature);
285 int sensor_hub_input_attr_get_raw_value(struct hid_sensor_hub_device *hsdev,
287 u32 attr_usage_id, u32 report_id,
288 enum sensor_hub_read_flags flag,
291 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
293 struct hid_report *report;
296 report = sensor_hub_report(report_id, hsdev->hdev,
301 mutex_lock(hsdev->mutex_ptr);
302 if (flag == SENSOR_HUB_SYNC) {
303 memset(&hsdev->pending, 0, sizeof(hsdev->pending));
304 init_completion(&hsdev->pending.ready);
305 hsdev->pending.usage_id = usage_id;
306 hsdev->pending.attr_usage_id = attr_usage_id;
307 hsdev->pending.raw_size = 0;
309 spin_lock_irqsave(&data->lock, flags);
310 hsdev->pending.status = true;
311 spin_unlock_irqrestore(&data->lock, flags);
313 mutex_lock(&data->mutex);
314 hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
315 mutex_unlock(&data->mutex);
316 if (flag == SENSOR_HUB_SYNC) {
317 wait_for_completion_interruptible_timeout(
318 &hsdev->pending.ready, HZ*5);
319 switch (hsdev->pending.raw_size) {
322 ret_val = *(s8 *)hsdev->pending.raw_data;
324 ret_val = *(u8 *)hsdev->pending.raw_data;
328 ret_val = *(s16 *)hsdev->pending.raw_data;
330 ret_val = *(u16 *)hsdev->pending.raw_data;
333 ret_val = *(u32 *)hsdev->pending.raw_data;
338 kfree(hsdev->pending.raw_data);
339 hsdev->pending.status = false;
341 mutex_unlock(hsdev->mutex_ptr);
345 EXPORT_SYMBOL_GPL(sensor_hub_input_attr_get_raw_value);
347 int hid_sensor_get_usage_index(struct hid_sensor_hub_device *hsdev,
348 u32 report_id, int field_index, u32 usage_id)
350 struct hid_report *report;
351 struct hid_field *field;
354 report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
355 if (!report || (field_index >= report->maxfield))
358 field = report->field[field_index];
359 for (i = 0; i < field->maxusage; ++i) {
360 if (field->usage[i].hid == usage_id)
361 return field->usage[i].usage_index;
367 EXPORT_SYMBOL_GPL(hid_sensor_get_usage_index);
369 int sensor_hub_input_get_attribute_info(struct hid_sensor_hub_device *hsdev,
373 struct hid_sensor_hub_attribute_info *info)
377 struct hid_report *report;
378 struct hid_field *field;
379 struct hid_report_enum *report_enum;
380 struct hid_device *hdev = hsdev->hdev;
382 /* Initialize with defaults */
383 info->usage_id = usage_id;
384 info->attrib_id = attr_usage_id;
385 info->report_id = -1;
388 info->unit_expo = -1;
390 report_enum = &hdev->report_enum[type];
391 list_for_each_entry(report, &report_enum->report_list, list) {
392 for (i = 0; i < report->maxfield; ++i) {
393 field = report->field[i];
394 if (field->maxusage) {
395 if (field->physical == usage_id &&
396 (field->logical == attr_usage_id ||
397 field->usage[0].hid ==
399 (field->usage[0].collection_index >=
400 hsdev->start_collection_index) &&
401 (field->usage[0].collection_index <
402 hsdev->end_collection_index)) {
404 sensor_hub_fill_attr_info(info, i,
417 EXPORT_SYMBOL_GPL(sensor_hub_input_get_attribute_info);
420 static int sensor_hub_suspend(struct hid_device *hdev, pm_message_t message)
422 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
423 struct hid_sensor_hub_callbacks_list *callback;
426 hid_dbg(hdev, " sensor_hub_suspend\n");
427 spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
428 list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
429 if (callback->usage_callback->suspend)
430 callback->usage_callback->suspend(
431 callback->hsdev, callback->priv);
433 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
438 static int sensor_hub_resume(struct hid_device *hdev)
440 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
441 struct hid_sensor_hub_callbacks_list *callback;
444 hid_dbg(hdev, " sensor_hub_resume\n");
445 spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
446 list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
447 if (callback->usage_callback->resume)
448 callback->usage_callback->resume(
449 callback->hsdev, callback->priv);
451 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
456 static int sensor_hub_reset_resume(struct hid_device *hdev)
463 * Handle raw report as sent by device
465 static int sensor_hub_raw_event(struct hid_device *hdev,
466 struct hid_report *report, u8 *raw_data, int size)
471 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
473 struct hid_sensor_hub_callbacks *callback = NULL;
474 struct hid_collection *collection = NULL;
476 struct hid_sensor_hub_device *hsdev = NULL;
478 hid_dbg(hdev, "sensor_hub_raw_event report id:0x%x size:%d type:%d\n",
479 report->id, size, report->type);
480 hid_dbg(hdev, "maxfield:%d\n", report->maxfield);
481 if (report->type != HID_INPUT_REPORT)
486 ptr++; /* Skip report id */
488 spin_lock_irqsave(&pdata->lock, flags);
490 for (i = 0; i < report->maxfield; ++i) {
491 hid_dbg(hdev, "%d collection_index:%x hid:%x sz:%x\n",
492 i, report->field[i]->usage->collection_index,
493 report->field[i]->usage->hid,
494 (report->field[i]->report_size *
495 report->field[i]->report_count)/8);
496 sz = (report->field[i]->report_size *
497 report->field[i]->report_count)/8;
498 collection = &hdev->collection[
499 report->field[i]->usage->collection_index];
500 hid_dbg(hdev, "collection->usage %x\n",
503 callback = sensor_hub_get_callback(hdev,
504 report->field[i]->physical,
505 report->field[i]->usage[0].collection_index,
511 if (hsdev->pending.status && (hsdev->pending.attr_usage_id ==
512 report->field[i]->usage->hid ||
513 hsdev->pending.attr_usage_id ==
514 report->field[i]->logical)) {
515 hid_dbg(hdev, "data was pending ...\n");
516 hsdev->pending.raw_data = kmemdup(ptr, sz, GFP_ATOMIC);
517 if (hsdev->pending.raw_data)
518 hsdev->pending.raw_size = sz;
520 hsdev->pending.raw_size = 0;
521 complete(&hsdev->pending.ready);
523 if (callback->capture_sample) {
524 if (report->field[i]->logical)
525 callback->capture_sample(hsdev,
526 report->field[i]->logical, sz, ptr,
529 callback->capture_sample(hsdev,
530 report->field[i]->usage->hid, sz, ptr,
535 if (callback && collection && callback->send_event)
536 callback->send_event(hsdev, collection->usage,
538 spin_unlock_irqrestore(&pdata->lock, flags);
543 int sensor_hub_device_open(struct hid_sensor_hub_device *hsdev)
546 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
548 mutex_lock(&data->mutex);
549 if (!data->ref_cnt) {
550 ret = hid_hw_open(hsdev->hdev);
552 hid_err(hsdev->hdev, "failed to open hid device\n");
553 mutex_unlock(&data->mutex);
558 mutex_unlock(&data->mutex);
562 EXPORT_SYMBOL_GPL(sensor_hub_device_open);
564 void sensor_hub_device_close(struct hid_sensor_hub_device *hsdev)
566 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
568 mutex_lock(&data->mutex);
571 hid_hw_close(hsdev->hdev);
572 mutex_unlock(&data->mutex);
574 EXPORT_SYMBOL_GPL(sensor_hub_device_close);
576 static __u8 *sensor_hub_report_fixup(struct hid_device *hdev, __u8 *rdesc,
580 * Checks if the report descriptor of Thinkpad Helix 2 has a logical
581 * minimum for magnetic flux axis greater than the maximum.
583 if (hdev->product == USB_DEVICE_ID_TEXAS_INSTRUMENTS_LENOVO_YOGA &&
584 *rsize == 2558 && rdesc[913] == 0x17 && rdesc[914] == 0x40 &&
585 rdesc[915] == 0x81 && rdesc[916] == 0x08 &&
586 rdesc[917] == 0x00 && rdesc[918] == 0x27 &&
587 rdesc[921] == 0x07 && rdesc[922] == 0x00) {
588 /* Sets negative logical minimum for mag x, y and z */
589 rdesc[914] = rdesc[935] = rdesc[956] = 0xc0;
590 rdesc[915] = rdesc[936] = rdesc[957] = 0x7e;
591 rdesc[916] = rdesc[937] = rdesc[958] = 0xf7;
592 rdesc[917] = rdesc[938] = rdesc[959] = 0xff;
598 static int sensor_hub_probe(struct hid_device *hdev,
599 const struct hid_device_id *id)
602 struct sensor_hub_data *sd;
606 struct hid_sensor_hub_device *hsdev;
607 struct hid_sensor_hub_device *last_hsdev = NULL;
608 struct hid_sensor_hub_device *collection_hsdev = NULL;
610 sd = devm_kzalloc(&hdev->dev, sizeof(*sd), GFP_KERNEL);
612 hid_err(hdev, "cannot allocate Sensor data\n");
616 hid_set_drvdata(hdev, sd);
618 spin_lock_init(&sd->lock);
619 spin_lock_init(&sd->dyn_callback_lock);
620 mutex_init(&sd->mutex);
621 ret = hid_parse(hdev);
623 hid_err(hdev, "parse failed\n");
626 INIT_LIST_HEAD(&hdev->inputs);
628 ret = hid_hw_start(hdev, 0);
630 hid_err(hdev, "hw start failed\n");
633 INIT_LIST_HEAD(&sd->dyn_callback_list);
634 sd->hid_sensor_client_cnt = 0;
636 dev_cnt = sensor_hub_get_physical_device_count(hdev);
637 if (dev_cnt > HID_MAX_PHY_DEVICES) {
638 hid_err(hdev, "Invalid Physical device count\n");
642 sd->hid_sensor_hub_client_devs = devm_kcalloc(&hdev->dev,
644 sizeof(struct mfd_cell),
646 if (sd->hid_sensor_hub_client_devs == NULL) {
647 hid_err(hdev, "Failed to allocate memory for mfd cells\n");
652 for (i = 0; i < hdev->maxcollection; ++i) {
653 struct hid_collection *collection = &hdev->collection[i];
655 if (collection->type == HID_COLLECTION_PHYSICAL ||
656 collection->type == HID_COLLECTION_APPLICATION) {
658 hsdev = devm_kzalloc(&hdev->dev, sizeof(*hsdev),
661 hid_err(hdev, "cannot allocate hid_sensor_hub_device\n");
666 hsdev->vendor_id = hdev->vendor;
667 hsdev->product_id = hdev->product;
668 hsdev->usage = collection->usage;
669 hsdev->mutex_ptr = devm_kzalloc(&hdev->dev,
670 sizeof(struct mutex),
672 if (!hsdev->mutex_ptr) {
676 mutex_init(hsdev->mutex_ptr);
677 hsdev->start_collection_index = i;
679 last_hsdev->end_collection_index = i;
681 name = devm_kasprintf(&hdev->dev, GFP_KERNEL,
685 hid_err(hdev, "Failed MFD device name\n");
689 sd->hid_sensor_hub_client_devs[
690 sd->hid_sensor_client_cnt].name = name;
691 sd->hid_sensor_hub_client_devs[
692 sd->hid_sensor_client_cnt].platform_data =
694 sd->hid_sensor_hub_client_devs[
695 sd->hid_sensor_client_cnt].pdata_size =
697 hid_dbg(hdev, "Adding %s:%d\n", name,
698 hsdev->start_collection_index);
699 sd->hid_sensor_client_cnt++;
700 if (collection_hsdev)
701 collection_hsdev->end_collection_index = i;
702 if (collection->type == HID_COLLECTION_APPLICATION &&
703 collection->usage == HID_USAGE_SENSOR_COLLECTION)
704 collection_hsdev = hsdev;
708 last_hsdev->end_collection_index = i;
709 if (collection_hsdev)
710 collection_hsdev->end_collection_index = i;
712 ret = mfd_add_hotplug_devices(&hdev->dev,
713 sd->hid_sensor_hub_client_devs,
714 sd->hid_sensor_client_cnt);
726 static void sensor_hub_remove(struct hid_device *hdev)
728 struct sensor_hub_data *data = hid_get_drvdata(hdev);
732 hid_dbg(hdev, " hardware removed\n");
735 spin_lock_irqsave(&data->lock, flags);
736 for (i = 0; i < data->hid_sensor_client_cnt; ++i) {
737 struct hid_sensor_hub_device *hsdev =
738 data->hid_sensor_hub_client_devs[i].platform_data;
739 if (hsdev->pending.status)
740 complete(&hsdev->pending.ready);
742 spin_unlock_irqrestore(&data->lock, flags);
743 mfd_remove_devices(&hdev->dev);
744 mutex_destroy(&data->mutex);
747 static const struct hid_device_id sensor_hub_devices[] = {
748 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, HID_ANY_ID,
752 MODULE_DEVICE_TABLE(hid, sensor_hub_devices);
754 static struct hid_driver sensor_hub_driver = {
755 .name = "hid-sensor-hub",
756 .id_table = sensor_hub_devices,
757 .probe = sensor_hub_probe,
758 .remove = sensor_hub_remove,
759 .raw_event = sensor_hub_raw_event,
760 .report_fixup = sensor_hub_report_fixup,
762 .suspend = sensor_hub_suspend,
763 .resume = sensor_hub_resume,
764 .reset_resume = sensor_hub_reset_resume,
767 module_hid_driver(sensor_hub_driver);
769 MODULE_DESCRIPTION("HID Sensor Hub driver");
770 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
771 MODULE_LICENSE("GPL");