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