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 * @hsdev: Stored hid instance for current hub device.
22 * @mutex: Mutex to serialize synchronous request.
23 * @lock: Spin lock to protect pending request structure.
24 * @dyn_callback_list: Holds callback function
25 * @dyn_callback_lock: spin lock to protect callback list
26 * @hid_sensor_hub_client_devs: Stores all MFD cells for a hub instance.
27 * @hid_sensor_client_cnt: Number of MFD cells, (no of sensors attached).
28 * @ref_cnt: Number of MFD clients have opened this device
30 struct sensor_hub_data {
33 struct list_head dyn_callback_list;
34 spinlock_t dyn_callback_lock;
35 struct mfd_cell *hid_sensor_hub_client_devs;
36 int hid_sensor_client_cnt;
42 * struct hid_sensor_hub_callbacks_list - Stores callback list
44 * @usage_id: usage id for a physical device.
45 * @usage_callback: Stores registered callback functions.
46 * @priv: Private data for a physical device.
48 struct hid_sensor_hub_callbacks_list {
49 struct list_head list;
51 struct hid_sensor_hub_device *hsdev;
52 struct hid_sensor_hub_callbacks *usage_callback;
56 static struct hid_report *sensor_hub_report(int id, struct hid_device *hdev,
59 struct hid_report *report;
61 list_for_each_entry(report, &hdev->report_enum[dir].report_list, list) {
65 hid_warn(hdev, "No report with id 0x%x found\n", id);
70 static int sensor_hub_get_physical_device_count(struct hid_device *hdev)
75 for (i = 0; i < hdev->maxcollection; ++i) {
76 struct hid_collection *collection = &hdev->collection[i];
77 if (collection->type == HID_COLLECTION_PHYSICAL ||
78 collection->type == HID_COLLECTION_APPLICATION)
85 static void sensor_hub_fill_attr_info(
86 struct hid_sensor_hub_attribute_info *info,
87 s32 index, s32 report_id, struct hid_field *field)
90 info->report_id = report_id;
91 info->units = field->unit;
92 info->unit_expo = field->unit_exponent;
93 info->size = (field->report_size * field->report_count)/8;
94 info->logical_minimum = field->logical_minimum;
95 info->logical_maximum = field->logical_maximum;
98 static struct hid_sensor_hub_callbacks *sensor_hub_get_callback(
99 struct hid_device *hdev,
101 int collection_index,
102 struct hid_sensor_hub_device **hsdev,
105 struct hid_sensor_hub_callbacks_list *callback;
106 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
109 spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
110 list_for_each_entry(callback, &pdata->dyn_callback_list, list)
111 if ((callback->usage_id == usage_id ||
112 callback->usage_id == HID_USAGE_SENSOR_COLLECTION) &&
114 callback->hsdev->start_collection_index) &&
116 callback->hsdev->end_collection_index)) {
117 *priv = callback->priv;
118 *hsdev = callback->hsdev;
119 spin_unlock_irqrestore(&pdata->dyn_callback_lock,
121 return callback->usage_callback;
123 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
128 int sensor_hub_register_callback(struct hid_sensor_hub_device *hsdev,
130 struct hid_sensor_hub_callbacks *usage_callback)
132 struct hid_sensor_hub_callbacks_list *callback;
133 struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);
136 spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
137 list_for_each_entry(callback, &pdata->dyn_callback_list, list)
138 if (callback->usage_id == usage_id &&
139 callback->hsdev == hsdev) {
140 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
143 callback = kzalloc(sizeof(*callback), GFP_ATOMIC);
145 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
148 callback->hsdev = hsdev;
149 callback->usage_callback = usage_callback;
150 callback->usage_id = usage_id;
151 callback->priv = NULL;
153 * If there is a handler registered for the collection type, then
154 * it will handle all reports for sensors in this collection. If
155 * there is also an individual sensor handler registration, then
156 * we want to make sure that the reports are directed to collection
157 * handler, as this may be a fusion sensor. So add collection handlers
158 * to the beginning of the list, so that they are matched first.
160 if (usage_id == HID_USAGE_SENSOR_COLLECTION)
161 list_add(&callback->list, &pdata->dyn_callback_list);
163 list_add_tail(&callback->list, &pdata->dyn_callback_list);
164 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
168 EXPORT_SYMBOL_GPL(sensor_hub_register_callback);
170 int sensor_hub_remove_callback(struct hid_sensor_hub_device *hsdev,
173 struct hid_sensor_hub_callbacks_list *callback;
174 struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);
177 spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
178 list_for_each_entry(callback, &pdata->dyn_callback_list, list)
179 if (callback->usage_id == usage_id &&
180 callback->hsdev == hsdev) {
181 list_del(&callback->list);
185 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
189 EXPORT_SYMBOL_GPL(sensor_hub_remove_callback);
191 int sensor_hub_set_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
192 u32 field_index, int buffer_size, void *buffer)
194 struct hid_report *report;
195 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
196 __s32 *buf32 = buffer;
202 mutex_lock(&data->mutex);
203 report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
204 if (!report || (field_index >= report->maxfield)) {
209 remaining_bytes = buffer_size % sizeof(__s32);
210 buffer_size = buffer_size / sizeof(__s32);
212 for (i = 0; i < buffer_size; ++i) {
213 ret = hid_set_field(report->field[field_index], i,
214 (__force __s32)cpu_to_le32(*buf32));
221 if (remaining_bytes) {
223 memcpy(&value, (u8 *)buf32, remaining_bytes);
224 ret = hid_set_field(report->field[field_index], i,
225 (__force __s32)cpu_to_le32(value));
229 hid_hw_request(hsdev->hdev, report, HID_REQ_SET_REPORT);
230 hid_hw_wait(hsdev->hdev);
233 mutex_unlock(&data->mutex);
237 EXPORT_SYMBOL_GPL(sensor_hub_set_feature);
239 int sensor_hub_get_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
240 u32 field_index, int buffer_size, void *buffer)
242 struct hid_report *report;
243 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
247 int buffer_index = 0;
250 memset(buffer, 0, buffer_size);
252 mutex_lock(&data->mutex);
253 report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
254 if (!report || (field_index >= report->maxfield) ||
255 report->field[field_index]->report_count < 1) {
259 hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
260 hid_hw_wait(hsdev->hdev);
262 /* calculate number of bytes required to read this field */
263 report_size = DIV_ROUND_UP(report->field[field_index]->report_size,
265 report->field[field_index]->report_count;
270 ret = min(report_size, buffer_size);
272 val_ptr = (u8 *)report->field[field_index]->value;
273 for (i = 0; i < report->field[field_index]->report_count; ++i) {
274 if (buffer_index >= ret)
277 memcpy(&((u8 *)buffer)[buffer_index], val_ptr,
278 report->field[field_index]->report_size / 8);
279 val_ptr += sizeof(__s32);
280 buffer_index += (report->field[field_index]->report_size / 8);
284 mutex_unlock(&data->mutex);
288 EXPORT_SYMBOL_GPL(sensor_hub_get_feature);
291 int sensor_hub_input_attr_get_raw_value(struct hid_sensor_hub_device *hsdev,
293 u32 attr_usage_id, u32 report_id,
294 enum sensor_hub_read_flags flag,
297 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
299 struct hid_report *report;
302 report = sensor_hub_report(report_id, hsdev->hdev,
307 mutex_lock(hsdev->mutex_ptr);
308 if (flag == SENSOR_HUB_SYNC) {
309 memset(&hsdev->pending, 0, sizeof(hsdev->pending));
310 init_completion(&hsdev->pending.ready);
311 hsdev->pending.usage_id = usage_id;
312 hsdev->pending.attr_usage_id = attr_usage_id;
313 hsdev->pending.raw_size = 0;
315 spin_lock_irqsave(&data->lock, flags);
316 hsdev->pending.status = true;
317 spin_unlock_irqrestore(&data->lock, flags);
319 mutex_lock(&data->mutex);
320 hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
321 mutex_unlock(&data->mutex);
322 if (flag == SENSOR_HUB_SYNC) {
323 wait_for_completion_interruptible_timeout(
324 &hsdev->pending.ready, HZ*5);
325 switch (hsdev->pending.raw_size) {
328 ret_val = *(s8 *)hsdev->pending.raw_data;
330 ret_val = *(u8 *)hsdev->pending.raw_data;
334 ret_val = *(s16 *)hsdev->pending.raw_data;
336 ret_val = *(u16 *)hsdev->pending.raw_data;
339 ret_val = *(u32 *)hsdev->pending.raw_data;
344 kfree(hsdev->pending.raw_data);
345 hsdev->pending.status = false;
347 mutex_unlock(hsdev->mutex_ptr);
351 EXPORT_SYMBOL_GPL(sensor_hub_input_attr_get_raw_value);
353 int hid_sensor_get_usage_index(struct hid_sensor_hub_device *hsdev,
354 u32 report_id, int field_index, u32 usage_id)
356 struct hid_report *report;
357 struct hid_field *field;
360 report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
361 if (!report || (field_index >= report->maxfield))
364 field = report->field[field_index];
365 for (i = 0; i < field->maxusage; ++i) {
366 if (field->usage[i].hid == usage_id)
367 return field->usage[i].usage_index;
373 EXPORT_SYMBOL_GPL(hid_sensor_get_usage_index);
375 int sensor_hub_input_get_attribute_info(struct hid_sensor_hub_device *hsdev,
379 struct hid_sensor_hub_attribute_info *info)
383 struct hid_report *report;
384 struct hid_field *field;
385 struct hid_report_enum *report_enum;
386 struct hid_device *hdev = hsdev->hdev;
388 /* Initialize with defaults */
389 info->usage_id = usage_id;
390 info->attrib_id = attr_usage_id;
391 info->report_id = -1;
394 info->unit_expo = -1;
396 report_enum = &hdev->report_enum[type];
397 list_for_each_entry(report, &report_enum->report_list, list) {
398 for (i = 0; i < report->maxfield; ++i) {
399 field = report->field[i];
400 if (field->maxusage) {
401 if (field->physical == usage_id &&
402 (field->logical == attr_usage_id ||
403 field->usage[0].hid ==
405 (field->usage[0].collection_index >=
406 hsdev->start_collection_index) &&
407 (field->usage[0].collection_index <
408 hsdev->end_collection_index)) {
410 sensor_hub_fill_attr_info(info, i,
423 EXPORT_SYMBOL_GPL(sensor_hub_input_get_attribute_info);
426 static int sensor_hub_suspend(struct hid_device *hdev, pm_message_t message)
428 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
429 struct hid_sensor_hub_callbacks_list *callback;
432 hid_dbg(hdev, " sensor_hub_suspend\n");
433 spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
434 list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
435 if (callback->usage_callback->suspend)
436 callback->usage_callback->suspend(
437 callback->hsdev, callback->priv);
439 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
444 static int sensor_hub_resume(struct hid_device *hdev)
446 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
447 struct hid_sensor_hub_callbacks_list *callback;
450 hid_dbg(hdev, " sensor_hub_resume\n");
451 spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
452 list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
453 if (callback->usage_callback->resume)
454 callback->usage_callback->resume(
455 callback->hsdev, callback->priv);
457 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
462 static int sensor_hub_reset_resume(struct hid_device *hdev)
469 * Handle raw report as sent by device
471 static int sensor_hub_raw_event(struct hid_device *hdev,
472 struct hid_report *report, u8 *raw_data, int size)
477 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
479 struct hid_sensor_hub_callbacks *callback = NULL;
480 struct hid_collection *collection = NULL;
482 struct hid_sensor_hub_device *hsdev = NULL;
484 hid_dbg(hdev, "sensor_hub_raw_event report id:0x%x size:%d type:%d\n",
485 report->id, size, report->type);
486 hid_dbg(hdev, "maxfield:%d\n", report->maxfield);
487 if (report->type != HID_INPUT_REPORT)
492 ptr++; /* Skip report id */
494 spin_lock_irqsave(&pdata->lock, flags);
496 for (i = 0; i < report->maxfield; ++i) {
497 hid_dbg(hdev, "%d collection_index:%x hid:%x sz:%x\n",
498 i, report->field[i]->usage->collection_index,
499 report->field[i]->usage->hid,
500 (report->field[i]->report_size *
501 report->field[i]->report_count)/8);
502 sz = (report->field[i]->report_size *
503 report->field[i]->report_count)/8;
504 collection = &hdev->collection[
505 report->field[i]->usage->collection_index];
506 hid_dbg(hdev, "collection->usage %x\n",
509 callback = sensor_hub_get_callback(hdev,
510 report->field[i]->physical,
511 report->field[i]->usage[0].collection_index,
517 if (hsdev->pending.status && (hsdev->pending.attr_usage_id ==
518 report->field[i]->usage->hid ||
519 hsdev->pending.attr_usage_id ==
520 report->field[i]->logical)) {
521 hid_dbg(hdev, "data was pending ...\n");
522 hsdev->pending.raw_data = kmemdup(ptr, sz, GFP_ATOMIC);
523 if (hsdev->pending.raw_data)
524 hsdev->pending.raw_size = sz;
526 hsdev->pending.raw_size = 0;
527 complete(&hsdev->pending.ready);
529 if (callback->capture_sample) {
530 if (report->field[i]->logical)
531 callback->capture_sample(hsdev,
532 report->field[i]->logical, sz, ptr,
535 callback->capture_sample(hsdev,
536 report->field[i]->usage->hid, sz, ptr,
541 if (callback && collection && callback->send_event)
542 callback->send_event(hsdev, collection->usage,
544 spin_unlock_irqrestore(&pdata->lock, flags);
549 int sensor_hub_device_open(struct hid_sensor_hub_device *hsdev)
552 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
554 mutex_lock(&data->mutex);
555 if (!data->ref_cnt) {
556 ret = hid_hw_open(hsdev->hdev);
558 hid_err(hsdev->hdev, "failed to open hid device\n");
559 mutex_unlock(&data->mutex);
564 mutex_unlock(&data->mutex);
568 EXPORT_SYMBOL_GPL(sensor_hub_device_open);
570 void sensor_hub_device_close(struct hid_sensor_hub_device *hsdev)
572 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
574 mutex_lock(&data->mutex);
577 hid_hw_close(hsdev->hdev);
578 mutex_unlock(&data->mutex);
580 EXPORT_SYMBOL_GPL(sensor_hub_device_close);
582 static __u8 *sensor_hub_report_fixup(struct hid_device *hdev, __u8 *rdesc,
586 * Checks if the report descriptor of Thinkpad Helix 2 has a logical
587 * minimum for magnetic flux axis greater than the maximum.
589 if (hdev->product == USB_DEVICE_ID_TEXAS_INSTRUMENTS_LENOVO_YOGA &&
590 *rsize == 2558 && rdesc[913] == 0x17 && rdesc[914] == 0x40 &&
591 rdesc[915] == 0x81 && rdesc[916] == 0x08 &&
592 rdesc[917] == 0x00 && rdesc[918] == 0x27 &&
593 rdesc[921] == 0x07 && rdesc[922] == 0x00) {
594 /* Sets negative logical minimum for mag x, y and z */
595 rdesc[914] = rdesc[935] = rdesc[956] = 0xc0;
596 rdesc[915] = rdesc[936] = rdesc[957] = 0x7e;
597 rdesc[916] = rdesc[937] = rdesc[958] = 0xf7;
598 rdesc[917] = rdesc[938] = rdesc[959] = 0xff;
604 static int sensor_hub_probe(struct hid_device *hdev,
605 const struct hid_device_id *id)
608 struct sensor_hub_data *sd;
612 struct hid_sensor_hub_device *hsdev;
613 struct hid_sensor_hub_device *last_hsdev = NULL;
614 struct hid_sensor_hub_device *collection_hsdev = NULL;
616 sd = devm_kzalloc(&hdev->dev, sizeof(*sd), GFP_KERNEL);
618 hid_err(hdev, "cannot allocate Sensor data\n");
622 hid_set_drvdata(hdev, sd);
623 sd->quirks = id->driver_data;
625 spin_lock_init(&sd->lock);
626 spin_lock_init(&sd->dyn_callback_lock);
627 mutex_init(&sd->mutex);
628 ret = hid_parse(hdev);
630 hid_err(hdev, "parse failed\n");
633 INIT_LIST_HEAD(&hdev->inputs);
635 ret = hid_hw_start(hdev, 0);
637 hid_err(hdev, "hw start failed\n");
640 INIT_LIST_HEAD(&sd->dyn_callback_list);
641 sd->hid_sensor_client_cnt = 0;
643 dev_cnt = sensor_hub_get_physical_device_count(hdev);
644 if (dev_cnt > HID_MAX_PHY_DEVICES) {
645 hid_err(hdev, "Invalid Physical device count\n");
649 sd->hid_sensor_hub_client_devs = devm_kcalloc(&hdev->dev,
651 sizeof(struct mfd_cell),
653 if (sd->hid_sensor_hub_client_devs == NULL) {
654 hid_err(hdev, "Failed to allocate memory for mfd cells\n");
659 for (i = 0; i < hdev->maxcollection; ++i) {
660 struct hid_collection *collection = &hdev->collection[i];
662 if (collection->type == HID_COLLECTION_PHYSICAL ||
663 collection->type == HID_COLLECTION_APPLICATION) {
665 hsdev = devm_kzalloc(&hdev->dev, sizeof(*hsdev),
668 hid_err(hdev, "cannot allocate hid_sensor_hub_device\n");
673 hsdev->vendor_id = hdev->vendor;
674 hsdev->product_id = hdev->product;
675 hsdev->usage = collection->usage;
676 hsdev->mutex_ptr = devm_kzalloc(&hdev->dev,
677 sizeof(struct mutex),
679 if (!hsdev->mutex_ptr) {
683 mutex_init(hsdev->mutex_ptr);
684 hsdev->start_collection_index = i;
686 last_hsdev->end_collection_index = i;
688 name = devm_kasprintf(&hdev->dev, GFP_KERNEL,
692 hid_err(hdev, "Failed MFD device name\n");
696 sd->hid_sensor_hub_client_devs[
697 sd->hid_sensor_client_cnt].name = name;
698 sd->hid_sensor_hub_client_devs[
699 sd->hid_sensor_client_cnt].platform_data =
701 sd->hid_sensor_hub_client_devs[
702 sd->hid_sensor_client_cnt].pdata_size =
704 hid_dbg(hdev, "Adding %s:%d\n", name,
705 hsdev->start_collection_index);
706 sd->hid_sensor_client_cnt++;
707 if (collection_hsdev)
708 collection_hsdev->end_collection_index = i;
709 if (collection->type == HID_COLLECTION_APPLICATION &&
710 collection->usage == HID_USAGE_SENSOR_COLLECTION)
711 collection_hsdev = hsdev;
715 last_hsdev->end_collection_index = i;
716 if (collection_hsdev)
717 collection_hsdev->end_collection_index = i;
719 ret = mfd_add_hotplug_devices(&hdev->dev,
720 sd->hid_sensor_hub_client_devs,
721 sd->hid_sensor_client_cnt);
733 static void sensor_hub_remove(struct hid_device *hdev)
735 struct sensor_hub_data *data = hid_get_drvdata(hdev);
739 hid_dbg(hdev, " hardware removed\n");
742 spin_lock_irqsave(&data->lock, flags);
743 for (i = 0; i < data->hid_sensor_client_cnt; ++i) {
744 struct hid_sensor_hub_device *hsdev =
745 data->hid_sensor_hub_client_devs[i].platform_data;
746 if (hsdev->pending.status)
747 complete(&hsdev->pending.ready);
749 spin_unlock_irqrestore(&data->lock, flags);
750 mfd_remove_devices(&hdev->dev);
751 mutex_destroy(&data->mutex);
754 static const struct hid_device_id sensor_hub_devices[] = {
755 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, HID_ANY_ID,
759 MODULE_DEVICE_TABLE(hid, sensor_hub_devices);
761 static struct hid_driver sensor_hub_driver = {
762 .name = "hid-sensor-hub",
763 .id_table = sensor_hub_devices,
764 .probe = sensor_hub_probe,
765 .remove = sensor_hub_remove,
766 .raw_event = sensor_hub_raw_event,
767 .report_fixup = sensor_hub_report_fixup,
769 .suspend = sensor_hub_suspend,
770 .resume = sensor_hub_resume,
771 .reset_resume = sensor_hub_reset_resume,
774 module_hid_driver(sensor_hub_driver);
776 MODULE_DESCRIPTION("HID Sensor Hub driver");
777 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
778 MODULE_LICENSE("GPL");