xref: /linux/drivers/hid/hid-sensor-hub.c (revision 3932b9ca55b0be314a36d3e84faff3e823c081f5)
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 
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 &&
142 			(collection_index >=
143 				callback->hsdev->start_collection_index) &&
144 			(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;
150 		}
151 	spin_unlock(&pdata->dyn_callback_lock);
152 
153 	return NULL;
154 }
155 
156 int sensor_hub_register_callback(struct hid_sensor_hub_device *hsdev,
157 			u32 usage_id,
158 			struct hid_sensor_hub_callbacks *usage_callback)
159 {
160 	struct hid_sensor_hub_callbacks_list *callback;
161 	struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);
162 	unsigned long flags;
163 
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);
169 			return -EINVAL;
170 		}
171 	callback = kzalloc(sizeof(*callback), GFP_ATOMIC);
172 	if (!callback) {
173 		spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
174 		return -ENOMEM;
175 	}
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);
182 
183 	return 0;
184 }
185 EXPORT_SYMBOL_GPL(sensor_hub_register_callback);
186 
187 int sensor_hub_remove_callback(struct hid_sensor_hub_device *hsdev,
188 				u32 usage_id)
189 {
190 	struct hid_sensor_hub_callbacks_list *callback;
191 	struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);
192 	unsigned long flags;
193 
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);
199 			kfree(callback);
200 			break;
201 		}
202 	spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
203 
204 	return 0;
205 }
206 EXPORT_SYMBOL_GPL(sensor_hub_remove_callback);
207 
208 int sensor_hub_set_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
209 				u32 field_index, s32 value)
210 {
211 	struct hid_report *report;
212 	struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
213 	int ret = 0;
214 
215 	mutex_lock(&data->mutex);
216 	report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
217 	if (!report || (field_index >= report->maxfield)) {
218 		ret = -EINVAL;
219 		goto done_proc;
220 	}
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);
224 
225 done_proc:
226 	mutex_unlock(&data->mutex);
227 
228 	return ret;
229 }
230 EXPORT_SYMBOL_GPL(sensor_hub_set_feature);
231 
232 int sensor_hub_get_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
233 				u32 field_index, s32 *value)
234 {
235 	struct hid_report *report;
236 	struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
237 	int ret = 0;
238 
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) {
243 		ret = -EINVAL;
244 		goto done_proc;
245 	}
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];
249 
250 done_proc:
251 	mutex_unlock(&data->mutex);
252 
253 	return ret;
254 }
255 EXPORT_SYMBOL_GPL(sensor_hub_get_feature);
256 
257 
258 int sensor_hub_input_attr_get_raw_value(struct hid_sensor_hub_device *hsdev,
259 					u32 usage_id,
260 					u32 attr_usage_id, u32 report_id)
261 {
262 	struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
263 	unsigned long flags;
264 	struct hid_report *report;
265 	int ret_val = 0;
266 
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;
273 
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);
278 	if (!report)
279 		goto err_free;
280 
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) {
284 	case 1:
285 		ret_val = *(u8 *)data->pending.raw_data;
286 		break;
287 	case 2:
288 		ret_val = *(u16 *)data->pending.raw_data;
289 		break;
290 	case 4:
291 		ret_val = *(u32 *)data->pending.raw_data;
292 		break;
293 	default:
294 		ret_val = 0;
295 	}
296 	kfree(data->pending.raw_data);
297 
298 err_free:
299 	data->pending.status = false;
300 	mutex_unlock(&data->mutex);
301 
302 	return ret_val;
303 }
304 EXPORT_SYMBOL_GPL(sensor_hub_input_attr_get_raw_value);
305 
306 int hid_sensor_get_usage_index(struct hid_sensor_hub_device *hsdev,
307 				u32 report_id, int field_index, u32 usage_id)
308 {
309 	struct hid_report *report;
310 	struct hid_field *field;
311 	int i;
312 
313 	report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
314 	if (!report || (field_index >= report->maxfield))
315 		goto done_proc;
316 
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;
321 	}
322 
323 done_proc:
324 	return -EINVAL;
325 }
326 EXPORT_SYMBOL_GPL(hid_sensor_get_usage_index);
327 
328 int sensor_hub_input_get_attribute_info(struct hid_sensor_hub_device *hsdev,
329 				u8 type,
330 				u32 usage_id,
331 				u32 attr_usage_id,
332 				struct hid_sensor_hub_attribute_info *info)
333 {
334 	int ret = -1;
335 	int i;
336 	struct hid_report *report;
337 	struct hid_field *field;
338 	struct hid_report_enum *report_enum;
339 	struct hid_device *hdev = hsdev->hdev;
340 
341 	/* Initialize with defaults */
342 	info->usage_id = usage_id;
343 	info->attrib_id = attr_usage_id;
344 	info->report_id = -1;
345 	info->index = -1;
346 	info->units = -1;
347 	info->unit_expo = -1;
348 
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 ==
357 							attr_usage_id) &&
358 					(field->usage[0].collection_index >=
359 					hsdev->start_collection_index) &&
360 					(field->usage[0].collection_index <
361 					hsdev->end_collection_index)) {
362 
363 					sensor_hub_fill_attr_info(info, i,
364 								report->id,
365 								field);
366 					ret = 0;
367 					break;
368 				}
369 			}
370 		}
371 
372 	}
373 
374 	return ret;
375 }
376 EXPORT_SYMBOL_GPL(sensor_hub_input_get_attribute_info);
377 
378 #ifdef CONFIG_PM
379 static int sensor_hub_suspend(struct hid_device *hdev, pm_message_t message)
380 {
381 	struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
382 	struct hid_sensor_hub_callbacks_list *callback;
383 	unsigned long flags;
384 
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);
391 	}
392 	spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
393 
394 	return 0;
395 }
396 
397 static int sensor_hub_resume(struct hid_device *hdev)
398 {
399 	struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
400 	struct hid_sensor_hub_callbacks_list *callback;
401 	unsigned long flags;
402 
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);
409 	}
410 	spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
411 
412 	return 0;
413 }
414 
415 static int sensor_hub_reset_resume(struct hid_device *hdev)
416 {
417 	return 0;
418 }
419 #endif
420 
421 /*
422  * Handle raw report as sent by device
423  */
424 static int sensor_hub_raw_event(struct hid_device *hdev,
425 		struct hid_report *report, u8 *raw_data, int size)
426 {
427 	int i;
428 	u8 *ptr;
429 	int sz;
430 	struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
431 	unsigned long flags;
432 	struct hid_sensor_hub_callbacks *callback = NULL;
433 	struct hid_collection *collection = NULL;
434 	void *priv = NULL;
435 	struct hid_sensor_hub_device *hsdev = NULL;
436 
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)
441 		return 1;
442 
443 	ptr = raw_data;
444 	ptr++; /* Skip report id */
445 
446 	spin_lock_irqsave(&pdata->lock, flags);
447 
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;
462 			else
463 				pdata->pending.raw_size = 0;
464 			complete(&pdata->pending.ready);
465 		}
466 		collection = &hdev->collection[
467 				report->field[i]->usage->collection_index];
468 		hid_dbg(hdev, "collection->usage %x\n",
469 					collection->usage);
470 
471 		callback = sensor_hub_get_callback(hdev,
472 				report->field[i]->physical,
473 				report->field[i]->usage[0].collection_index,
474 				&hsdev, &priv);
475 
476 		if (callback && callback->capture_sample) {
477 			if (report->field[i]->logical)
478 				callback->capture_sample(hsdev,
479 					report->field[i]->logical, sz, ptr,
480 					callback->pdev);
481 			else
482 				callback->capture_sample(hsdev,
483 					report->field[i]->usage->hid, sz, ptr,
484 					callback->pdev);
485 		}
486 		ptr += sz;
487 	}
488 	if (callback && collection && callback->send_event)
489 		callback->send_event(hsdev, collection->usage,
490 				callback->pdev);
491 	spin_unlock_irqrestore(&pdata->lock, flags);
492 
493 	return 1;
494 }
495 
496 int sensor_hub_device_open(struct hid_sensor_hub_device *hsdev)
497 {
498 	int ret = 0;
499 	struct sensor_hub_data *data =  hid_get_drvdata(hsdev->hdev);
500 
501 	mutex_lock(&data->mutex);
502 	if (!data->ref_cnt) {
503 		ret = hid_hw_open(hsdev->hdev);
504 		if (ret) {
505 			hid_err(hsdev->hdev, "failed to open hid device\n");
506 			mutex_unlock(&data->mutex);
507 			return ret;
508 		}
509 	}
510 	data->ref_cnt++;
511 	mutex_unlock(&data->mutex);
512 
513 	return ret;
514 }
515 EXPORT_SYMBOL_GPL(sensor_hub_device_open);
516 
517 void sensor_hub_device_close(struct hid_sensor_hub_device *hsdev)
518 {
519 	struct sensor_hub_data *data =  hid_get_drvdata(hsdev->hdev);
520 
521 	mutex_lock(&data->mutex);
522 	data->ref_cnt--;
523 	if (!data->ref_cnt)
524 		hid_hw_close(hsdev->hdev);
525 	mutex_unlock(&data->mutex);
526 }
527 EXPORT_SYMBOL_GPL(sensor_hub_device_close);
528 
529 static __u8 *sensor_hub_report_fixup(struct hid_device *hdev, __u8 *rdesc,
530 		unsigned int *rsize)
531 {
532 	int index;
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};
538 
539 	if (!(sd->quirks & HID_SENSOR_HUB_ENUM_QUIRK)) {
540 		hid_dbg(hdev, "No Enum quirks\n");
541 		return rdesc;
542 	}
543 
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);
551 		}
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);
557 		}
558 	}
559 
560 	return rdesc;
561 }
562 
563 static int sensor_hub_probe(struct hid_device *hdev,
564 				const struct hid_device_id *id)
565 {
566 	int ret;
567 	struct sensor_hub_data *sd;
568 	int i;
569 	char *name;
570 	int dev_cnt;
571 	struct hid_sensor_hub_device *hsdev;
572 	struct hid_sensor_hub_device *last_hsdev = NULL;
573 
574 	sd = devm_kzalloc(&hdev->dev, sizeof(*sd), GFP_KERNEL);
575 	if (!sd) {
576 		hid_err(hdev, "cannot allocate Sensor data\n");
577 		return -ENOMEM;
578 	}
579 
580 	hid_set_drvdata(hdev, sd);
581 	sd->quirks = id->driver_data;
582 
583 	spin_lock_init(&sd->lock);
584 	spin_lock_init(&sd->dyn_callback_lock);
585 	mutex_init(&sd->mutex);
586 	ret = hid_parse(hdev);
587 	if (ret) {
588 		hid_err(hdev, "parse failed\n");
589 		return ret;
590 	}
591 	INIT_LIST_HEAD(&hdev->inputs);
592 
593 	ret = hid_hw_start(hdev, 0);
594 	if (ret) {
595 		hid_err(hdev, "hw start failed\n");
596 		return ret;
597 	}
598 	INIT_LIST_HEAD(&sd->dyn_callback_list);
599 	sd->hid_sensor_client_cnt = 0;
600 
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");
604 		ret = -EINVAL;
605 		goto err_stop_hw;
606 	}
607 	sd->hid_sensor_hub_client_devs = devm_kzalloc(&hdev->dev, dev_cnt *
608 						      sizeof(struct mfd_cell),
609 						      GFP_KERNEL);
610 	if (sd->hid_sensor_hub_client_devs == NULL) {
611 		hid_err(hdev, "Failed to allocate memory for mfd cells\n");
612 			ret = -ENOMEM;
613 			goto err_stop_hw;
614 	}
615 
616 	for (i = 0; i < hdev->maxcollection; ++i) {
617 		struct hid_collection *collection = &hdev->collection[i];
618 
619 		if (collection->type == HID_COLLECTION_PHYSICAL) {
620 
621 			hsdev = devm_kzalloc(&hdev->dev, sizeof(*hsdev),
622 					     GFP_KERNEL);
623 			if (!hsdev) {
624 				hid_err(hdev, "cannot allocate hid_sensor_hub_device\n");
625 				ret = -ENOMEM;
626 				goto err_stop_hw;
627 			}
628 			hsdev->hdev = hdev;
629 			hsdev->vendor_id = hdev->vendor;
630 			hsdev->product_id = hdev->product;
631 			hsdev->start_collection_index = i;
632 			if (last_hsdev)
633 				last_hsdev->end_collection_index = i;
634 			last_hsdev = hsdev;
635 			name = devm_kasprintf(&hdev->dev, GFP_KERNEL,
636 					      "HID-SENSOR-%x",
637 					      collection->usage);
638 			if (name == NULL) {
639 				hid_err(hdev, "Failed MFD device name\n");
640 					ret = -ENOMEM;
641 					goto err_stop_hw;
642 			}
643 			sd->hid_sensor_hub_client_devs[
644 				sd->hid_sensor_client_cnt].id =
645 							PLATFORM_DEVID_AUTO;
646 			sd->hid_sensor_hub_client_devs[
647 				sd->hid_sensor_client_cnt].name = name;
648 			sd->hid_sensor_hub_client_devs[
649 				sd->hid_sensor_client_cnt].platform_data =
650 							hsdev;
651 			sd->hid_sensor_hub_client_devs[
652 				sd->hid_sensor_client_cnt].pdata_size =
653 							sizeof(*hsdev);
654 			hid_dbg(hdev, "Adding %s:%d\n", name,
655 					hsdev->start_collection_index);
656 			sd->hid_sensor_client_cnt++;
657 		}
658 	}
659 	if (last_hsdev)
660 		last_hsdev->end_collection_index = i;
661 
662 	ret = mfd_add_devices(&hdev->dev, 0, sd->hid_sensor_hub_client_devs,
663 		sd->hid_sensor_client_cnt, NULL, 0, NULL);
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_1),
713 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
714 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_TEXAS_INSTRUMENTS,
715 			USB_DEVICE_ID_TEXAS_INSTRUMENTS_LENOVO_YOGA),
716 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
717 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, HID_ANY_ID,
718 		     HID_ANY_ID) },
719 	{ }
720 };
721 MODULE_DEVICE_TABLE(hid, sensor_hub_devices);
722 
723 static struct hid_driver sensor_hub_driver = {
724 	.name = "hid-sensor-hub",
725 	.id_table = sensor_hub_devices,
726 	.probe = sensor_hub_probe,
727 	.remove = sensor_hub_remove,
728 	.raw_event = sensor_hub_raw_event,
729 	.report_fixup = sensor_hub_report_fixup,
730 #ifdef CONFIG_PM
731 	.suspend = sensor_hub_suspend,
732 	.resume = sensor_hub_resume,
733 	.reset_resume = sensor_hub_reset_resume,
734 #endif
735 };
736 module_hid_driver(sensor_hub_driver);
737 
738 MODULE_DESCRIPTION("HID Sensor Hub driver");
739 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
740 MODULE_LICENSE("GPL");
741