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).
59 * @ref_cnt: Number of MFD clients have opened this device
61 struct sensor_hub_data {
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;
74 * struct hid_sensor_hub_callbacks_list - Stores callback list
76 * @usage_id: usage id for a physical device.
77 * @usage_callback: Stores registered callback functions.
78 * @priv: Private data for a physical device.
80 struct hid_sensor_hub_callbacks_list {
81 struct list_head list;
83 struct hid_sensor_hub_device *hsdev;
84 struct hid_sensor_hub_callbacks *usage_callback;
88 static struct hid_report *sensor_hub_report(int id, struct hid_device *hdev,
91 struct hid_report *report;
93 list_for_each_entry(report, &hdev->report_enum[dir].report_list, list) {
97 hid_warn(hdev, "No report with id 0x%x found\n", id);
102 static int sensor_hub_get_physical_device_count(struct hid_device *hdev)
107 for (i = 0; i < hdev->maxcollection; ++i) {
108 struct hid_collection *collection = &hdev->collection[i];
109 if (collection->type == HID_COLLECTION_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,
132 int collection_index,
133 struct hid_sensor_hub_device **hsdev,
136 struct hid_sensor_hub_callbacks_list *callback;
137 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
139 spin_lock(&pdata->dyn_callback_lock);
140 list_for_each_entry(callback, &pdata->dyn_callback_list, list)
141 if (callback->usage_id == usage_id &&
143 callback->hsdev->start_collection_index) &&
145 callback->hsdev->end_collection_index)) {
146 *priv = callback->priv;
147 *hsdev = callback->hsdev;
148 spin_unlock(&pdata->dyn_callback_lock);
149 return callback->usage_callback;
151 spin_unlock(&pdata->dyn_callback_lock);
156 int sensor_hub_register_callback(struct hid_sensor_hub_device *hsdev,
158 struct hid_sensor_hub_callbacks *usage_callback)
160 struct hid_sensor_hub_callbacks_list *callback;
161 struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);
164 spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
165 list_for_each_entry(callback, &pdata->dyn_callback_list, list)
166 if (callback->usage_id == usage_id &&
167 callback->hsdev == hsdev) {
168 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
171 callback = kzalloc(sizeof(*callback), GFP_ATOMIC);
173 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
176 callback->hsdev = hsdev;
177 callback->usage_callback = usage_callback;
178 callback->usage_id = usage_id;
179 callback->priv = NULL;
180 list_add_tail(&callback->list, &pdata->dyn_callback_list);
181 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
185 EXPORT_SYMBOL_GPL(sensor_hub_register_callback);
187 int sensor_hub_remove_callback(struct hid_sensor_hub_device *hsdev,
190 struct hid_sensor_hub_callbacks_list *callback;
191 struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);
194 spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
195 list_for_each_entry(callback, &pdata->dyn_callback_list, list)
196 if (callback->usage_id == usage_id &&
197 callback->hsdev == hsdev) {
198 list_del(&callback->list);
202 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
206 EXPORT_SYMBOL_GPL(sensor_hub_remove_callback);
208 int sensor_hub_set_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
209 u32 field_index, s32 value)
211 struct hid_report *report;
212 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
215 mutex_lock(&data->mutex);
216 report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
217 if (!report || (field_index >= report->maxfield)) {
221 hid_set_field(report->field[field_index], 0, value);
222 hid_hw_request(hsdev->hdev, report, HID_REQ_SET_REPORT);
223 hid_hw_wait(hsdev->hdev);
226 mutex_unlock(&data->mutex);
230 EXPORT_SYMBOL_GPL(sensor_hub_set_feature);
232 int sensor_hub_get_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
233 u32 field_index, s32 *value)
235 struct hid_report *report;
236 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
239 mutex_lock(&data->mutex);
240 report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
241 if (!report || (field_index >= report->maxfield) ||
242 report->field[field_index]->report_count < 1) {
246 hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
247 hid_hw_wait(hsdev->hdev);
248 *value = report->field[field_index]->value[0];
251 mutex_unlock(&data->mutex);
255 EXPORT_SYMBOL_GPL(sensor_hub_get_feature);
258 int sensor_hub_input_attr_get_raw_value(struct hid_sensor_hub_device *hsdev,
260 u32 attr_usage_id, u32 report_id)
262 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
264 struct hid_report *report;
267 mutex_lock(&data->mutex);
268 memset(&data->pending, 0, sizeof(data->pending));
269 init_completion(&data->pending.ready);
270 data->pending.usage_id = usage_id;
271 data->pending.attr_usage_id = attr_usage_id;
272 data->pending.raw_size = 0;
274 spin_lock_irqsave(&data->lock, flags);
275 data->pending.status = true;
276 spin_unlock_irqrestore(&data->lock, flags);
277 report = sensor_hub_report(report_id, hsdev->hdev, HID_INPUT_REPORT);
281 hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
282 wait_for_completion_interruptible_timeout(&data->pending.ready, HZ*5);
283 switch (data->pending.raw_size) {
285 ret_val = *(u8 *)data->pending.raw_data;
288 ret_val = *(u16 *)data->pending.raw_data;
291 ret_val = *(u32 *)data->pending.raw_data;
296 kfree(data->pending.raw_data);
299 data->pending.status = false;
300 mutex_unlock(&data->mutex);
304 EXPORT_SYMBOL_GPL(sensor_hub_input_attr_get_raw_value);
306 int hid_sensor_get_usage_index(struct hid_sensor_hub_device *hsdev,
307 u32 report_id, int field_index, u32 usage_id)
309 struct hid_report *report;
310 struct hid_field *field;
313 report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
314 if (!report || (field_index >= report->maxfield))
317 field = report->field[field_index];
318 for (i = 0; i < field->maxusage; ++i) {
319 if (field->usage[i].hid == usage_id)
320 return field->usage[i].usage_index;
326 EXPORT_SYMBOL_GPL(hid_sensor_get_usage_index);
328 int sensor_hub_input_get_attribute_info(struct hid_sensor_hub_device *hsdev,
332 struct hid_sensor_hub_attribute_info *info)
336 struct hid_report *report;
337 struct hid_field *field;
338 struct hid_report_enum *report_enum;
339 struct hid_device *hdev = hsdev->hdev;
341 /* Initialize with defaults */
342 info->usage_id = usage_id;
343 info->attrib_id = attr_usage_id;
344 info->report_id = -1;
347 info->unit_expo = -1;
349 report_enum = &hdev->report_enum[type];
350 list_for_each_entry(report, &report_enum->report_list, list) {
351 for (i = 0; i < report->maxfield; ++i) {
352 field = report->field[i];
353 if (field->maxusage) {
354 if (field->physical == usage_id &&
355 (field->logical == attr_usage_id ||
356 field->usage[0].hid ==
358 (field->usage[0].collection_index >=
359 hsdev->start_collection_index) &&
360 (field->usage[0].collection_index <
361 hsdev->end_collection_index)) {
363 sensor_hub_fill_attr_info(info, i,
376 EXPORT_SYMBOL_GPL(sensor_hub_input_get_attribute_info);
379 static int sensor_hub_suspend(struct hid_device *hdev, pm_message_t message)
381 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
382 struct hid_sensor_hub_callbacks_list *callback;
385 hid_dbg(hdev, " sensor_hub_suspend\n");
386 spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
387 list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
388 if (callback->usage_callback->suspend)
389 callback->usage_callback->suspend(
390 callback->hsdev, callback->priv);
392 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
397 static int sensor_hub_resume(struct hid_device *hdev)
399 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
400 struct hid_sensor_hub_callbacks_list *callback;
403 hid_dbg(hdev, " sensor_hub_resume\n");
404 spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
405 list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
406 if (callback->usage_callback->resume)
407 callback->usage_callback->resume(
408 callback->hsdev, callback->priv);
410 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
415 static int sensor_hub_reset_resume(struct hid_device *hdev)
422 * Handle raw report as sent by device
424 static int sensor_hub_raw_event(struct hid_device *hdev,
425 struct hid_report *report, u8 *raw_data, int size)
430 struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
432 struct hid_sensor_hub_callbacks *callback = NULL;
433 struct hid_collection *collection = NULL;
435 struct hid_sensor_hub_device *hsdev = NULL;
437 hid_dbg(hdev, "sensor_hub_raw_event report id:0x%x size:%d type:%d\n",
438 report->id, size, report->type);
439 hid_dbg(hdev, "maxfield:%d\n", report->maxfield);
440 if (report->type != HID_INPUT_REPORT)
444 ptr++; /* Skip report id */
446 spin_lock_irqsave(&pdata->lock, flags);
448 for (i = 0; i < report->maxfield; ++i) {
449 hid_dbg(hdev, "%d collection_index:%x hid:%x sz:%x\n",
450 i, report->field[i]->usage->collection_index,
451 report->field[i]->usage->hid,
452 (report->field[i]->report_size *
453 report->field[i]->report_count)/8);
454 sz = (report->field[i]->report_size *
455 report->field[i]->report_count)/8;
456 if (pdata->pending.status && pdata->pending.attr_usage_id ==
457 report->field[i]->usage->hid) {
458 hid_dbg(hdev, "data was pending ...\n");
459 pdata->pending.raw_data = kmemdup(ptr, sz, GFP_ATOMIC);
460 if (pdata->pending.raw_data)
461 pdata->pending.raw_size = sz;
463 pdata->pending.raw_size = 0;
464 complete(&pdata->pending.ready);
466 collection = &hdev->collection[
467 report->field[i]->usage->collection_index];
468 hid_dbg(hdev, "collection->usage %x\n",
471 callback = sensor_hub_get_callback(hdev,
472 report->field[i]->physical,
473 report->field[i]->usage[0].collection_index,
476 if (callback && callback->capture_sample) {
477 if (report->field[i]->logical)
478 callback->capture_sample(hsdev,
479 report->field[i]->logical, sz, ptr,
482 callback->capture_sample(hsdev,
483 report->field[i]->usage->hid, sz, ptr,
488 if (callback && collection && callback->send_event)
489 callback->send_event(hsdev, collection->usage,
491 spin_unlock_irqrestore(&pdata->lock, flags);
496 int sensor_hub_device_open(struct hid_sensor_hub_device *hsdev)
499 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
501 mutex_lock(&data->mutex);
502 if (!data->ref_cnt) {
503 ret = hid_hw_open(hsdev->hdev);
505 hid_err(hsdev->hdev, "failed to open hid device\n");
506 mutex_unlock(&data->mutex);
511 mutex_unlock(&data->mutex);
515 EXPORT_SYMBOL_GPL(sensor_hub_device_open);
517 void sensor_hub_device_close(struct hid_sensor_hub_device *hsdev)
519 struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
521 mutex_lock(&data->mutex);
524 hid_hw_close(hsdev->hdev);
525 mutex_unlock(&data->mutex);
527 EXPORT_SYMBOL_GPL(sensor_hub_device_close);
529 static __u8 *sensor_hub_report_fixup(struct hid_device *hdev, __u8 *rdesc,
533 struct sensor_hub_data *sd = hid_get_drvdata(hdev);
534 unsigned char report_block[] = {
535 0x0a, 0x16, 0x03, 0x15, 0x00, 0x25, 0x05};
536 unsigned char power_block[] = {
537 0x0a, 0x19, 0x03, 0x15, 0x00, 0x25, 0x05};
539 if (!(sd->quirks & HID_SENSOR_HUB_ENUM_QUIRK)) {
540 hid_dbg(hdev, "No Enum quirks\n");
544 /* Looks for power and report state usage id and force to 1 */
545 for (index = 0; index < *rsize; ++index) {
546 if (((*rsize - index) > sizeof(report_block)) &&
547 !memcmp(&rdesc[index], report_block,
548 sizeof(report_block))) {
549 rdesc[index + 4] = 0x01;
550 index += sizeof(report_block);
552 if (((*rsize - index) > sizeof(power_block)) &&
553 !memcmp(&rdesc[index], power_block,
554 sizeof(power_block))) {
555 rdesc[index + 4] = 0x01;
556 index += sizeof(power_block);
563 static int sensor_hub_probe(struct hid_device *hdev,
564 const struct hid_device_id *id)
567 struct sensor_hub_data *sd;
571 struct hid_sensor_hub_device *hsdev;
572 struct hid_sensor_hub_device *last_hsdev = NULL;
574 sd = devm_kzalloc(&hdev->dev, sizeof(*sd), GFP_KERNEL);
576 hid_err(hdev, "cannot allocate Sensor data\n");
580 hid_set_drvdata(hdev, sd);
581 sd->quirks = id->driver_data;
583 spin_lock_init(&sd->lock);
584 spin_lock_init(&sd->dyn_callback_lock);
585 mutex_init(&sd->mutex);
586 ret = hid_parse(hdev);
588 hid_err(hdev, "parse failed\n");
591 INIT_LIST_HEAD(&hdev->inputs);
593 ret = hid_hw_start(hdev, 0);
595 hid_err(hdev, "hw start failed\n");
598 INIT_LIST_HEAD(&sd->dyn_callback_list);
599 sd->hid_sensor_client_cnt = 0;
601 dev_cnt = sensor_hub_get_physical_device_count(hdev);
602 if (dev_cnt > HID_MAX_PHY_DEVICES) {
603 hid_err(hdev, "Invalid Physical device count\n");
607 sd->hid_sensor_hub_client_devs = devm_kzalloc(&hdev->dev, dev_cnt *
608 sizeof(struct mfd_cell),
610 if (sd->hid_sensor_hub_client_devs == NULL) {
611 hid_err(hdev, "Failed to allocate memory for mfd cells\n");
616 for (i = 0; i < hdev->maxcollection; ++i) {
617 struct hid_collection *collection = &hdev->collection[i];
619 if (collection->type == HID_COLLECTION_PHYSICAL) {
621 hsdev = devm_kzalloc(&hdev->dev, sizeof(*hsdev),
624 hid_err(hdev, "cannot allocate hid_sensor_hub_device\n");
629 hsdev->vendor_id = hdev->vendor;
630 hsdev->product_id = hdev->product;
631 hsdev->start_collection_index = i;
633 last_hsdev->end_collection_index = i;
635 name = devm_kasprintf(&hdev->dev, GFP_KERNEL,
639 hid_err(hdev, "Failed MFD device name\n");
643 sd->hid_sensor_hub_client_devs[
644 sd->hid_sensor_client_cnt].name = name;
645 sd->hid_sensor_hub_client_devs[
646 sd->hid_sensor_client_cnt].platform_data =
648 sd->hid_sensor_hub_client_devs[
649 sd->hid_sensor_client_cnt].pdata_size =
651 hid_dbg(hdev, "Adding %s:%d\n", name,
652 hsdev->start_collection_index);
653 sd->hid_sensor_client_cnt++;
657 last_hsdev->end_collection_index = i;
659 ret = mfd_add_hotplug_devices(&hdev->dev,
660 sd->hid_sensor_hub_client_devs,
661 sd->hid_sensor_client_cnt);
673 static void sensor_hub_remove(struct hid_device *hdev)
675 struct sensor_hub_data *data = hid_get_drvdata(hdev);
678 hid_dbg(hdev, " hardware removed\n");
681 spin_lock_irqsave(&data->lock, flags);
682 if (data->pending.status)
683 complete(&data->pending.ready);
684 spin_unlock_irqrestore(&data->lock, flags);
685 mfd_remove_devices(&hdev->dev);
686 hid_set_drvdata(hdev, NULL);
687 mutex_destroy(&data->mutex);
690 static const struct hid_device_id sensor_hub_devices[] = {
691 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_INTEL_0,
692 USB_DEVICE_ID_INTEL_HID_SENSOR_0),
693 .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
694 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_INTEL_1,
695 USB_DEVICE_ID_INTEL_HID_SENSOR_0),
696 .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
697 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_INTEL_1,
698 USB_DEVICE_ID_INTEL_HID_SENSOR_1),
699 .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
700 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_MICROSOFT,
701 USB_DEVICE_ID_MS_SURFACE_PRO_2),
702 .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
703 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_MICROSOFT,
704 USB_DEVICE_ID_MS_TOUCH_COVER_2),
705 .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
706 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_MICROSOFT,
707 USB_DEVICE_ID_MS_TYPE_COVER_2),
708 .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
709 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_STM_0,
710 USB_DEVICE_ID_STM_HID_SENSOR),
711 .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
712 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_STM_0,
713 USB_DEVICE_ID_STM_HID_SENSOR_1),
714 .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
715 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_TEXAS_INSTRUMENTS,
716 USB_DEVICE_ID_TEXAS_INSTRUMENTS_LENOVO_YOGA),
717 .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
718 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, HID_ANY_ID,
722 MODULE_DEVICE_TABLE(hid, sensor_hub_devices);
724 static struct hid_driver sensor_hub_driver = {
725 .name = "hid-sensor-hub",
726 .id_table = sensor_hub_devices,
727 .probe = sensor_hub_probe,
728 .remove = sensor_hub_remove,
729 .raw_event = sensor_hub_raw_event,
730 .report_fixup = sensor_hub_report_fixup,
732 .suspend = sensor_hub_suspend,
733 .resume = sensor_hub_resume,
734 .reset_resume = sensor_hub_reset_resume,
737 module_hid_driver(sensor_hub_driver);
739 MODULE_DESCRIPTION("HID Sensor Hub driver");
740 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
741 MODULE_LICENSE("GPL");