xref: /openbmc/linux/drivers/hid/hid-sensor-hub.c (revision a03a8dbe20eff6d57aae3147577bf84b52aba4e6)
1 /*
2  * HID Sensors Driver
3  * Copyright (c) 2012, Intel Corporation.
4  *
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.
8  *
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
12  * more details.
13  *
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.
17  *
18  */
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>
27 #include "hid-ids.h"
28 
29 #define HID_SENSOR_HUB_ENUM_QUIRK	0x01
30 
31 /**
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.
39  */
40 struct sensor_hub_pending {
41 	bool status;
42 	struct completion ready;
43 	u32 usage_id;
44 	u32 attr_usage_id;
45 	int raw_size;
46 	u8  *raw_data;
47 };
48 
49 /**
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
60  */
61 struct sensor_hub_data {
62 	struct mutex mutex;
63 	spinlock_t lock;
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;
69 	unsigned long quirks;
70 	int ref_cnt;
71 };
72 
73 /**
74  * struct hid_sensor_hub_callbacks_list - Stores callback list
75  * @list:		list head.
76  * @usage_id:		usage id for a physical device.
77  * @usage_callback:	Stores registered callback functions.
78  * @priv:		Private data for a physical device.
79  */
80 struct hid_sensor_hub_callbacks_list {
81 	struct list_head list;
82 	u32 usage_id;
83 	struct hid_sensor_hub_device *hsdev;
84 	struct hid_sensor_hub_callbacks *usage_callback;
85 	void *priv;
86 };
87 
88 static struct hid_report *sensor_hub_report(int id, struct hid_device *hdev,
89 						int dir)
90 {
91 	struct hid_report *report;
92 
93 	list_for_each_entry(report, &hdev->report_enum[dir].report_list, list) {
94 		if (report->id == id)
95 			return report;
96 	}
97 	hid_warn(hdev, "No report with id 0x%x found\n", id);
98 
99 	return NULL;
100 }
101 
102 static int sensor_hub_get_physical_device_count(struct hid_device *hdev)
103 {
104 	int i;
105 	int count = 0;
106 
107 	for (i = 0; i < hdev->maxcollection; ++i) {
108 		struct hid_collection *collection = &hdev->collection[i];
109 		if (collection->type == HID_COLLECTION_PHYSICAL)
110 			++count;
111 	}
112 
113 	return count;
114 }
115 
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)
119 {
120 	info->index = index;
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;
127 }
128 
129 static struct hid_sensor_hub_callbacks *sensor_hub_get_callback(
130 					struct hid_device *hdev,
131 					u32 usage_id,
132 					int collection_index,
133 					struct hid_sensor_hub_device **hsdev,
134 					void **priv)
135 {
136 	struct hid_sensor_hub_callbacks_list *callback;
137 	struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
138 	unsigned long flags;
139 
140 	spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
141 	list_for_each_entry(callback, &pdata->dyn_callback_list, list)
142 		if (callback->usage_id == usage_id &&
143 			(collection_index >=
144 				callback->hsdev->start_collection_index) &&
145 			(collection_index <
146 				callback->hsdev->end_collection_index)) {
147 			*priv = callback->priv;
148 			*hsdev = callback->hsdev;
149 			spin_unlock_irqrestore(&pdata->dyn_callback_lock,
150 					       flags);
151 			return callback->usage_callback;
152 		}
153 	spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
154 
155 	return NULL;
156 }
157 
158 int sensor_hub_register_callback(struct hid_sensor_hub_device *hsdev,
159 			u32 usage_id,
160 			struct hid_sensor_hub_callbacks *usage_callback)
161 {
162 	struct hid_sensor_hub_callbacks_list *callback;
163 	struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);
164 	unsigned long flags;
165 
166 	spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
167 	list_for_each_entry(callback, &pdata->dyn_callback_list, list)
168 		if (callback->usage_id == usage_id &&
169 						callback->hsdev == hsdev) {
170 			spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
171 			return -EINVAL;
172 		}
173 	callback = kzalloc(sizeof(*callback), GFP_ATOMIC);
174 	if (!callback) {
175 		spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
176 		return -ENOMEM;
177 	}
178 	callback->hsdev = hsdev;
179 	callback->usage_callback = usage_callback;
180 	callback->usage_id = usage_id;
181 	callback->priv = NULL;
182 	list_add_tail(&callback->list, &pdata->dyn_callback_list);
183 	spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
184 
185 	return 0;
186 }
187 EXPORT_SYMBOL_GPL(sensor_hub_register_callback);
188 
189 int sensor_hub_remove_callback(struct hid_sensor_hub_device *hsdev,
190 				u32 usage_id)
191 {
192 	struct hid_sensor_hub_callbacks_list *callback;
193 	struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);
194 	unsigned long flags;
195 
196 	spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
197 	list_for_each_entry(callback, &pdata->dyn_callback_list, list)
198 		if (callback->usage_id == usage_id &&
199 						callback->hsdev == hsdev) {
200 			list_del(&callback->list);
201 			kfree(callback);
202 			break;
203 		}
204 	spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
205 
206 	return 0;
207 }
208 EXPORT_SYMBOL_GPL(sensor_hub_remove_callback);
209 
210 int sensor_hub_set_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
211 				u32 field_index, s32 value)
212 {
213 	struct hid_report *report;
214 	struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
215 	int ret = 0;
216 
217 	mutex_lock(&data->mutex);
218 	report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
219 	if (!report || (field_index >= report->maxfield)) {
220 		ret = -EINVAL;
221 		goto done_proc;
222 	}
223 	hid_set_field(report->field[field_index], 0, value);
224 	hid_hw_request(hsdev->hdev, report, HID_REQ_SET_REPORT);
225 	hid_hw_wait(hsdev->hdev);
226 
227 done_proc:
228 	mutex_unlock(&data->mutex);
229 
230 	return ret;
231 }
232 EXPORT_SYMBOL_GPL(sensor_hub_set_feature);
233 
234 int sensor_hub_get_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
235 				u32 field_index, s32 *value)
236 {
237 	struct hid_report *report;
238 	struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
239 	int ret = 0;
240 
241 	mutex_lock(&data->mutex);
242 	report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
243 	if (!report || (field_index >= report->maxfield) ||
244 	    report->field[field_index]->report_count < 1) {
245 		ret = -EINVAL;
246 		goto done_proc;
247 	}
248 	hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
249 	hid_hw_wait(hsdev->hdev);
250 	*value = report->field[field_index]->value[0];
251 
252 done_proc:
253 	mutex_unlock(&data->mutex);
254 
255 	return ret;
256 }
257 EXPORT_SYMBOL_GPL(sensor_hub_get_feature);
258 
259 
260 int sensor_hub_input_attr_get_raw_value(struct hid_sensor_hub_device *hsdev,
261 					u32 usage_id,
262 					u32 attr_usage_id, u32 report_id)
263 {
264 	struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
265 	unsigned long flags;
266 	struct hid_report *report;
267 	int ret_val = 0;
268 
269 	mutex_lock(&data->mutex);
270 	memset(&data->pending, 0, sizeof(data->pending));
271 	init_completion(&data->pending.ready);
272 	data->pending.usage_id = usage_id;
273 	data->pending.attr_usage_id = attr_usage_id;
274 	data->pending.raw_size = 0;
275 
276 	spin_lock_irqsave(&data->lock, flags);
277 	data->pending.status = true;
278 	spin_unlock_irqrestore(&data->lock, flags);
279 	report = sensor_hub_report(report_id, hsdev->hdev, HID_INPUT_REPORT);
280 	if (!report)
281 		goto err_free;
282 
283 	hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
284 	wait_for_completion_interruptible_timeout(&data->pending.ready, HZ*5);
285 	switch (data->pending.raw_size) {
286 	case 1:
287 		ret_val = *(u8 *)data->pending.raw_data;
288 		break;
289 	case 2:
290 		ret_val = *(u16 *)data->pending.raw_data;
291 		break;
292 	case 4:
293 		ret_val = *(u32 *)data->pending.raw_data;
294 		break;
295 	default:
296 		ret_val = 0;
297 	}
298 	kfree(data->pending.raw_data);
299 
300 err_free:
301 	data->pending.status = false;
302 	mutex_unlock(&data->mutex);
303 
304 	return ret_val;
305 }
306 EXPORT_SYMBOL_GPL(sensor_hub_input_attr_get_raw_value);
307 
308 int hid_sensor_get_usage_index(struct hid_sensor_hub_device *hsdev,
309 				u32 report_id, int field_index, u32 usage_id)
310 {
311 	struct hid_report *report;
312 	struct hid_field *field;
313 	int i;
314 
315 	report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
316 	if (!report || (field_index >= report->maxfield))
317 		goto done_proc;
318 
319 	field = report->field[field_index];
320 	for (i = 0; i < field->maxusage; ++i) {
321 		if (field->usage[i].hid == usage_id)
322 			return field->usage[i].usage_index;
323 	}
324 
325 done_proc:
326 	return -EINVAL;
327 }
328 EXPORT_SYMBOL_GPL(hid_sensor_get_usage_index);
329 
330 int sensor_hub_input_get_attribute_info(struct hid_sensor_hub_device *hsdev,
331 				u8 type,
332 				u32 usage_id,
333 				u32 attr_usage_id,
334 				struct hid_sensor_hub_attribute_info *info)
335 {
336 	int ret = -1;
337 	int i;
338 	struct hid_report *report;
339 	struct hid_field *field;
340 	struct hid_report_enum *report_enum;
341 	struct hid_device *hdev = hsdev->hdev;
342 
343 	/* Initialize with defaults */
344 	info->usage_id = usage_id;
345 	info->attrib_id = attr_usage_id;
346 	info->report_id = -1;
347 	info->index = -1;
348 	info->units = -1;
349 	info->unit_expo = -1;
350 
351 	report_enum = &hdev->report_enum[type];
352 	list_for_each_entry(report, &report_enum->report_list, list) {
353 		for (i = 0; i < report->maxfield; ++i) {
354 			field = report->field[i];
355 			if (field->maxusage) {
356 				if (field->physical == usage_id &&
357 					(field->logical == attr_usage_id ||
358 					field->usage[0].hid ==
359 							attr_usage_id) &&
360 					(field->usage[0].collection_index >=
361 					hsdev->start_collection_index) &&
362 					(field->usage[0].collection_index <
363 					hsdev->end_collection_index)) {
364 
365 					sensor_hub_fill_attr_info(info, i,
366 								report->id,
367 								field);
368 					ret = 0;
369 					break;
370 				}
371 			}
372 		}
373 
374 	}
375 
376 	return ret;
377 }
378 EXPORT_SYMBOL_GPL(sensor_hub_input_get_attribute_info);
379 
380 #ifdef CONFIG_PM
381 static int sensor_hub_suspend(struct hid_device *hdev, pm_message_t message)
382 {
383 	struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
384 	struct hid_sensor_hub_callbacks_list *callback;
385 	unsigned long flags;
386 
387 	hid_dbg(hdev, " sensor_hub_suspend\n");
388 	spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
389 	list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
390 		if (callback->usage_callback->suspend)
391 			callback->usage_callback->suspend(
392 					callback->hsdev, callback->priv);
393 	}
394 	spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
395 
396 	return 0;
397 }
398 
399 static int sensor_hub_resume(struct hid_device *hdev)
400 {
401 	struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
402 	struct hid_sensor_hub_callbacks_list *callback;
403 	unsigned long flags;
404 
405 	hid_dbg(hdev, " sensor_hub_resume\n");
406 	spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
407 	list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
408 		if (callback->usage_callback->resume)
409 			callback->usage_callback->resume(
410 					callback->hsdev, callback->priv);
411 	}
412 	spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
413 
414 	return 0;
415 }
416 
417 static int sensor_hub_reset_resume(struct hid_device *hdev)
418 {
419 	return 0;
420 }
421 #endif
422 
423 /*
424  * Handle raw report as sent by device
425  */
426 static int sensor_hub_raw_event(struct hid_device *hdev,
427 		struct hid_report *report, u8 *raw_data, int size)
428 {
429 	int i;
430 	u8 *ptr;
431 	int sz;
432 	struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
433 	unsigned long flags;
434 	struct hid_sensor_hub_callbacks *callback = NULL;
435 	struct hid_collection *collection = NULL;
436 	void *priv = NULL;
437 	struct hid_sensor_hub_device *hsdev = NULL;
438 
439 	hid_dbg(hdev, "sensor_hub_raw_event report id:0x%x size:%d type:%d\n",
440 			 report->id, size, report->type);
441 	hid_dbg(hdev, "maxfield:%d\n", report->maxfield);
442 	if (report->type != HID_INPUT_REPORT)
443 		return 1;
444 
445 	ptr = raw_data;
446 	ptr++; /* Skip report id */
447 
448 	spin_lock_irqsave(&pdata->lock, flags);
449 
450 	for (i = 0; i < report->maxfield; ++i) {
451 		hid_dbg(hdev, "%d collection_index:%x hid:%x sz:%x\n",
452 				i, report->field[i]->usage->collection_index,
453 				report->field[i]->usage->hid,
454 				(report->field[i]->report_size *
455 					report->field[i]->report_count)/8);
456 		sz = (report->field[i]->report_size *
457 					report->field[i]->report_count)/8;
458 		if (pdata->pending.status && pdata->pending.attr_usage_id ==
459 				report->field[i]->usage->hid) {
460 			hid_dbg(hdev, "data was pending ...\n");
461 			pdata->pending.raw_data = kmemdup(ptr, sz, GFP_ATOMIC);
462 			if (pdata->pending.raw_data)
463 				pdata->pending.raw_size = sz;
464 			else
465 				pdata->pending.raw_size = 0;
466 			complete(&pdata->pending.ready);
467 		}
468 		collection = &hdev->collection[
469 				report->field[i]->usage->collection_index];
470 		hid_dbg(hdev, "collection->usage %x\n",
471 					collection->usage);
472 
473 		callback = sensor_hub_get_callback(hdev,
474 				report->field[i]->physical,
475 				report->field[i]->usage[0].collection_index,
476 				&hsdev, &priv);
477 
478 		if (callback && callback->capture_sample) {
479 			if (report->field[i]->logical)
480 				callback->capture_sample(hsdev,
481 					report->field[i]->logical, sz, ptr,
482 					callback->pdev);
483 			else
484 				callback->capture_sample(hsdev,
485 					report->field[i]->usage->hid, sz, ptr,
486 					callback->pdev);
487 		}
488 		ptr += sz;
489 	}
490 	if (callback && collection && callback->send_event)
491 		callback->send_event(hsdev, collection->usage,
492 				callback->pdev);
493 	spin_unlock_irqrestore(&pdata->lock, flags);
494 
495 	return 1;
496 }
497 
498 int sensor_hub_device_open(struct hid_sensor_hub_device *hsdev)
499 {
500 	int ret = 0;
501 	struct sensor_hub_data *data =  hid_get_drvdata(hsdev->hdev);
502 
503 	mutex_lock(&data->mutex);
504 	if (!data->ref_cnt) {
505 		ret = hid_hw_open(hsdev->hdev);
506 		if (ret) {
507 			hid_err(hsdev->hdev, "failed to open hid device\n");
508 			mutex_unlock(&data->mutex);
509 			return ret;
510 		}
511 	}
512 	data->ref_cnt++;
513 	mutex_unlock(&data->mutex);
514 
515 	return ret;
516 }
517 EXPORT_SYMBOL_GPL(sensor_hub_device_open);
518 
519 void sensor_hub_device_close(struct hid_sensor_hub_device *hsdev)
520 {
521 	struct sensor_hub_data *data =  hid_get_drvdata(hsdev->hdev);
522 
523 	mutex_lock(&data->mutex);
524 	data->ref_cnt--;
525 	if (!data->ref_cnt)
526 		hid_hw_close(hsdev->hdev);
527 	mutex_unlock(&data->mutex);
528 }
529 EXPORT_SYMBOL_GPL(sensor_hub_device_close);
530 
531 static __u8 *sensor_hub_report_fixup(struct hid_device *hdev, __u8 *rdesc,
532 		unsigned int *rsize)
533 {
534 	int index;
535 	struct sensor_hub_data *sd =  hid_get_drvdata(hdev);
536 	unsigned char report_block[] = {
537 				0x0a,  0x16, 0x03, 0x15, 0x00, 0x25, 0x05};
538 	unsigned char power_block[] = {
539 				0x0a,  0x19, 0x03, 0x15, 0x00, 0x25, 0x05};
540 
541 	if (!(sd->quirks & HID_SENSOR_HUB_ENUM_QUIRK)) {
542 		hid_dbg(hdev, "No Enum quirks\n");
543 		return rdesc;
544 	}
545 
546 	/* Looks for power and report state usage id and force to 1 */
547 	for (index = 0; index < *rsize; ++index) {
548 		if (((*rsize - index) > sizeof(report_block)) &&
549 			!memcmp(&rdesc[index], report_block,
550 						sizeof(report_block))) {
551 			rdesc[index + 4] = 0x01;
552 			index += sizeof(report_block);
553 		}
554 		if (((*rsize - index) > sizeof(power_block)) &&
555 			!memcmp(&rdesc[index], power_block,
556 						sizeof(power_block))) {
557 			rdesc[index + 4] = 0x01;
558 			index += sizeof(power_block);
559 		}
560 	}
561 
562 	return rdesc;
563 }
564 
565 static int sensor_hub_probe(struct hid_device *hdev,
566 				const struct hid_device_id *id)
567 {
568 	int ret;
569 	struct sensor_hub_data *sd;
570 	int i;
571 	char *name;
572 	int dev_cnt;
573 	struct hid_sensor_hub_device *hsdev;
574 	struct hid_sensor_hub_device *last_hsdev = NULL;
575 
576 	sd = devm_kzalloc(&hdev->dev, sizeof(*sd), GFP_KERNEL);
577 	if (!sd) {
578 		hid_err(hdev, "cannot allocate Sensor data\n");
579 		return -ENOMEM;
580 	}
581 
582 	hid_set_drvdata(hdev, sd);
583 	sd->quirks = id->driver_data;
584 
585 	spin_lock_init(&sd->lock);
586 	spin_lock_init(&sd->dyn_callback_lock);
587 	mutex_init(&sd->mutex);
588 	ret = hid_parse(hdev);
589 	if (ret) {
590 		hid_err(hdev, "parse failed\n");
591 		return ret;
592 	}
593 	INIT_LIST_HEAD(&hdev->inputs);
594 
595 	ret = hid_hw_start(hdev, 0);
596 	if (ret) {
597 		hid_err(hdev, "hw start failed\n");
598 		return ret;
599 	}
600 	INIT_LIST_HEAD(&sd->dyn_callback_list);
601 	sd->hid_sensor_client_cnt = 0;
602 
603 	dev_cnt = sensor_hub_get_physical_device_count(hdev);
604 	if (dev_cnt > HID_MAX_PHY_DEVICES) {
605 		hid_err(hdev, "Invalid Physical device count\n");
606 		ret = -EINVAL;
607 		goto err_stop_hw;
608 	}
609 	sd->hid_sensor_hub_client_devs = devm_kzalloc(&hdev->dev, dev_cnt *
610 						      sizeof(struct mfd_cell),
611 						      GFP_KERNEL);
612 	if (sd->hid_sensor_hub_client_devs == NULL) {
613 		hid_err(hdev, "Failed to allocate memory for mfd cells\n");
614 			ret = -ENOMEM;
615 			goto err_stop_hw;
616 	}
617 
618 	for (i = 0; i < hdev->maxcollection; ++i) {
619 		struct hid_collection *collection = &hdev->collection[i];
620 
621 		if (collection->type == HID_COLLECTION_PHYSICAL) {
622 
623 			hsdev = devm_kzalloc(&hdev->dev, sizeof(*hsdev),
624 					     GFP_KERNEL);
625 			if (!hsdev) {
626 				hid_err(hdev, "cannot allocate hid_sensor_hub_device\n");
627 				ret = -ENOMEM;
628 				goto err_stop_hw;
629 			}
630 			hsdev->hdev = hdev;
631 			hsdev->vendor_id = hdev->vendor;
632 			hsdev->product_id = hdev->product;
633 			hsdev->start_collection_index = i;
634 			if (last_hsdev)
635 				last_hsdev->end_collection_index = i;
636 			last_hsdev = hsdev;
637 			name = devm_kasprintf(&hdev->dev, GFP_KERNEL,
638 					      "HID-SENSOR-%x",
639 					      collection->usage);
640 			if (name == NULL) {
641 				hid_err(hdev, "Failed MFD device name\n");
642 					ret = -ENOMEM;
643 					goto err_stop_hw;
644 			}
645 			sd->hid_sensor_hub_client_devs[
646 				sd->hid_sensor_client_cnt].name = name;
647 			sd->hid_sensor_hub_client_devs[
648 				sd->hid_sensor_client_cnt].platform_data =
649 							hsdev;
650 			sd->hid_sensor_hub_client_devs[
651 				sd->hid_sensor_client_cnt].pdata_size =
652 							sizeof(*hsdev);
653 			hid_dbg(hdev, "Adding %s:%d\n", name,
654 					hsdev->start_collection_index);
655 			sd->hid_sensor_client_cnt++;
656 		}
657 	}
658 	if (last_hsdev)
659 		last_hsdev->end_collection_index = i;
660 
661 	ret = mfd_add_hotplug_devices(&hdev->dev,
662 			sd->hid_sensor_hub_client_devs,
663 			sd->hid_sensor_client_cnt);
664 	if (ret < 0)
665 		goto err_stop_hw;
666 
667 	return ret;
668 
669 err_stop_hw:
670 	hid_hw_stop(hdev);
671 
672 	return ret;
673 }
674 
675 static void sensor_hub_remove(struct hid_device *hdev)
676 {
677 	struct sensor_hub_data *data = hid_get_drvdata(hdev);
678 	unsigned long flags;
679 
680 	hid_dbg(hdev, " hardware removed\n");
681 	hid_hw_close(hdev);
682 	hid_hw_stop(hdev);
683 	spin_lock_irqsave(&data->lock, flags);
684 	if (data->pending.status)
685 		complete(&data->pending.ready);
686 	spin_unlock_irqrestore(&data->lock, flags);
687 	mfd_remove_devices(&hdev->dev);
688 	hid_set_drvdata(hdev, NULL);
689 	mutex_destroy(&data->mutex);
690 }
691 
692 static const struct hid_device_id sensor_hub_devices[] = {
693 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_INTEL_0,
694 			USB_DEVICE_ID_INTEL_HID_SENSOR_0),
695 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
696 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_INTEL_1,
697 			USB_DEVICE_ID_INTEL_HID_SENSOR_0),
698 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
699 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_INTEL_1,
700 			USB_DEVICE_ID_INTEL_HID_SENSOR_1),
701 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
702 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_MICROSOFT,
703 			USB_DEVICE_ID_MS_SURFACE_PRO_2),
704 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
705 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_MICROSOFT,
706 			USB_DEVICE_ID_MS_TOUCH_COVER_2),
707 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
708 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_MICROSOFT,
709 			USB_DEVICE_ID_MS_TYPE_COVER_2),
710 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
711 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_STM_0,
712 			USB_DEVICE_ID_STM_HID_SENSOR),
713 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
714 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_STM_0,
715 			USB_DEVICE_ID_STM_HID_SENSOR_1),
716 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
717 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_TEXAS_INSTRUMENTS,
718 			USB_DEVICE_ID_TEXAS_INSTRUMENTS_LENOVO_YOGA),
719 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
720 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, HID_ANY_ID,
721 		     HID_ANY_ID) },
722 	{ }
723 };
724 MODULE_DEVICE_TABLE(hid, sensor_hub_devices);
725 
726 static struct hid_driver sensor_hub_driver = {
727 	.name = "hid-sensor-hub",
728 	.id_table = sensor_hub_devices,
729 	.probe = sensor_hub_probe,
730 	.remove = sensor_hub_remove,
731 	.raw_event = sensor_hub_raw_event,
732 	.report_fixup = sensor_hub_report_fixup,
733 #ifdef CONFIG_PM
734 	.suspend = sensor_hub_suspend,
735 	.resume = sensor_hub_resume,
736 	.reset_resume = sensor_hub_reset_resume,
737 #endif
738 };
739 module_hid_driver(sensor_hub_driver);
740 
741 MODULE_DESCRIPTION("HID Sensor Hub driver");
742 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
743 MODULE_LICENSE("GPL");
744