xref: /linux/drivers/hid/hid-sensor-hub.c (revision 98838d95075a5295f3478ceba18bcccf472e30f4)
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 
20 #include <linux/device.h>
21 #include <linux/hid.h>
22 #include <linux/module.h>
23 #include <linux/slab.h>
24 #include <linux/mfd/core.h>
25 #include <linux/list.h>
26 #include <linux/hid-sensor-ids.h>
27 #include <linux/hid-sensor-hub.h>
28 #include "hid-ids.h"
29 
30 #define HID_SENSOR_HUB_ENUM_QUIRK	0x01
31 
32 /**
33  * struct sensor_hub_data - Hold a instance data for a HID hub device
34  * @hsdev:		Stored hid instance for current hub device.
35  * @mutex:		Mutex to serialize synchronous request.
36  * @lock:		Spin lock to protect pending request structure.
37  * @dyn_callback_list:	Holds callback function
38  * @dyn_callback_lock:	spin lock to protect callback list
39  * @hid_sensor_hub_client_devs:	Stores all MFD cells for a hub instance.
40  * @hid_sensor_client_cnt: Number of MFD cells, (no of sensors attached).
41  * @ref_cnt:		Number of MFD clients have opened this device
42  */
43 struct sensor_hub_data {
44 	struct mutex mutex;
45 	spinlock_t lock;
46 	struct list_head dyn_callback_list;
47 	spinlock_t dyn_callback_lock;
48 	struct mfd_cell *hid_sensor_hub_client_devs;
49 	int hid_sensor_client_cnt;
50 	unsigned long quirks;
51 	int ref_cnt;
52 };
53 
54 /**
55  * struct hid_sensor_hub_callbacks_list - Stores callback list
56  * @list:		list head.
57  * @usage_id:		usage id for a physical device.
58  * @usage_callback:	Stores registered callback functions.
59  * @priv:		Private data for a physical device.
60  */
61 struct hid_sensor_hub_callbacks_list {
62 	struct list_head list;
63 	u32 usage_id;
64 	struct hid_sensor_hub_device *hsdev;
65 	struct hid_sensor_hub_callbacks *usage_callback;
66 	void *priv;
67 };
68 
69 static struct hid_report *sensor_hub_report(int id, struct hid_device *hdev,
70 						int dir)
71 {
72 	struct hid_report *report;
73 
74 	list_for_each_entry(report, &hdev->report_enum[dir].report_list, list) {
75 		if (report->id == id)
76 			return report;
77 	}
78 	hid_warn(hdev, "No report with id 0x%x found\n", id);
79 
80 	return NULL;
81 }
82 
83 static int sensor_hub_get_physical_device_count(struct hid_device *hdev)
84 {
85 	int i;
86 	int count = 0;
87 
88 	for (i = 0; i < hdev->maxcollection; ++i) {
89 		struct hid_collection *collection = &hdev->collection[i];
90 		if (collection->type == HID_COLLECTION_PHYSICAL ||
91 		    collection->type == HID_COLLECTION_APPLICATION)
92 			++count;
93 	}
94 
95 	return count;
96 }
97 
98 static void sensor_hub_fill_attr_info(
99 		struct hid_sensor_hub_attribute_info *info,
100 		s32 index, s32 report_id, struct hid_field *field)
101 {
102 	info->index = index;
103 	info->report_id = report_id;
104 	info->units = field->unit;
105 	info->unit_expo = field->unit_exponent;
106 	info->size = (field->report_size * field->report_count)/8;
107 	info->logical_minimum = field->logical_minimum;
108 	info->logical_maximum = field->logical_maximum;
109 }
110 
111 static struct hid_sensor_hub_callbacks *sensor_hub_get_callback(
112 					struct hid_device *hdev,
113 					u32 usage_id,
114 					int collection_index,
115 					struct hid_sensor_hub_device **hsdev,
116 					void **priv)
117 {
118 	struct hid_sensor_hub_callbacks_list *callback;
119 	struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
120 	unsigned long flags;
121 
122 	spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
123 	list_for_each_entry(callback, &pdata->dyn_callback_list, list)
124 		if ((callback->usage_id == usage_id ||
125 		     callback->usage_id == HID_USAGE_SENSOR_COLLECTION) &&
126 			(collection_index >=
127 				callback->hsdev->start_collection_index) &&
128 			(collection_index <
129 				callback->hsdev->end_collection_index)) {
130 			*priv = callback->priv;
131 			*hsdev = callback->hsdev;
132 			spin_unlock_irqrestore(&pdata->dyn_callback_lock,
133 					       flags);
134 			return callback->usage_callback;
135 		}
136 	spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
137 
138 	return NULL;
139 }
140 
141 int sensor_hub_register_callback(struct hid_sensor_hub_device *hsdev,
142 			u32 usage_id,
143 			struct hid_sensor_hub_callbacks *usage_callback)
144 {
145 	struct hid_sensor_hub_callbacks_list *callback;
146 	struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);
147 	unsigned long flags;
148 
149 	spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
150 	list_for_each_entry(callback, &pdata->dyn_callback_list, list)
151 		if (callback->usage_id == usage_id &&
152 						callback->hsdev == hsdev) {
153 			spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
154 			return -EINVAL;
155 		}
156 	callback = kzalloc(sizeof(*callback), GFP_ATOMIC);
157 	if (!callback) {
158 		spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
159 		return -ENOMEM;
160 	}
161 	callback->hsdev = hsdev;
162 	callback->usage_callback = usage_callback;
163 	callback->usage_id = usage_id;
164 	callback->priv = NULL;
165 	/*
166 	 * If there is a handler registered for the collection type, then
167 	 * it will handle all reports for sensors in this collection. If
168 	 * there is also an individual sensor handler registration, then
169 	 * we want to make sure that the reports are directed to collection
170 	 * handler, as this may be a fusion sensor. So add collection handlers
171 	 * to the beginning of the list, so that they are matched first.
172 	 */
173 	if (usage_id == HID_USAGE_SENSOR_COLLECTION)
174 		list_add(&callback->list, &pdata->dyn_callback_list);
175 	else
176 		list_add_tail(&callback->list, &pdata->dyn_callback_list);
177 	spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
178 
179 	return 0;
180 }
181 EXPORT_SYMBOL_GPL(sensor_hub_register_callback);
182 
183 int sensor_hub_remove_callback(struct hid_sensor_hub_device *hsdev,
184 				u32 usage_id)
185 {
186 	struct hid_sensor_hub_callbacks_list *callback;
187 	struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);
188 	unsigned long flags;
189 
190 	spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
191 	list_for_each_entry(callback, &pdata->dyn_callback_list, list)
192 		if (callback->usage_id == usage_id &&
193 						callback->hsdev == hsdev) {
194 			list_del(&callback->list);
195 			kfree(callback);
196 			break;
197 		}
198 	spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
199 
200 	return 0;
201 }
202 EXPORT_SYMBOL_GPL(sensor_hub_remove_callback);
203 
204 int sensor_hub_set_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
205 			   u32 field_index, int buffer_size, void *buffer)
206 {
207 	struct hid_report *report;
208 	struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
209 	__s32 *buf32 = buffer;
210 	int i = 0;
211 	int remaining_bytes;
212 	__s32 value;
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 
222 	remaining_bytes = buffer_size % sizeof(__s32);
223 	buffer_size = buffer_size / sizeof(__s32);
224 	if (buffer_size) {
225 		for (i = 0; i < buffer_size; ++i) {
226 			hid_set_field(report->field[field_index], i,
227 				      (__force __s32)cpu_to_le32(*buf32));
228 			++buf32;
229 		}
230 	}
231 	if (remaining_bytes) {
232 		value = 0;
233 		memcpy(&value, (u8 *)buf32, remaining_bytes);
234 		hid_set_field(report->field[field_index], i,
235 			      (__force __s32)cpu_to_le32(value));
236 	}
237 	hid_hw_request(hsdev->hdev, report, HID_REQ_SET_REPORT);
238 	hid_hw_wait(hsdev->hdev);
239 
240 done_proc:
241 	mutex_unlock(&data->mutex);
242 
243 	return ret;
244 }
245 EXPORT_SYMBOL_GPL(sensor_hub_set_feature);
246 
247 int sensor_hub_get_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
248 			   u32 field_index, int buffer_size, void *buffer)
249 {
250 	struct hid_report *report;
251 	struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
252 	int report_size;
253 	int ret = 0;
254 
255 	mutex_lock(&data->mutex);
256 	report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
257 	if (!report || (field_index >= report->maxfield) ||
258 	    report->field[field_index]->report_count < 1) {
259 		ret = -EINVAL;
260 		goto done_proc;
261 	}
262 	hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
263 	hid_hw_wait(hsdev->hdev);
264 
265 	/* calculate number of bytes required to read this field */
266 	report_size = DIV_ROUND_UP(report->field[field_index]->report_size,
267 				   8) *
268 				   report->field[field_index]->report_count;
269 	if (!report_size) {
270 		ret = -EINVAL;
271 		goto done_proc;
272 	}
273 	ret = min(report_size, buffer_size);
274 	memcpy(buffer, report->field[field_index]->value, ret);
275 
276 done_proc:
277 	mutex_unlock(&data->mutex);
278 
279 	return ret;
280 }
281 EXPORT_SYMBOL_GPL(sensor_hub_get_feature);
282 
283 
284 int sensor_hub_input_attr_get_raw_value(struct hid_sensor_hub_device *hsdev,
285 					u32 usage_id,
286 					u32 attr_usage_id, u32 report_id,
287 					enum sensor_hub_read_flags flag)
288 {
289 	struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
290 	unsigned long flags;
291 	struct hid_report *report;
292 	int ret_val = 0;
293 
294 	report = sensor_hub_report(report_id, hsdev->hdev,
295 				   HID_INPUT_REPORT);
296 	if (!report)
297 		return -EINVAL;
298 
299 	mutex_lock(hsdev->mutex_ptr);
300 	if (flag == SENSOR_HUB_SYNC) {
301 		memset(&hsdev->pending, 0, sizeof(hsdev->pending));
302 		init_completion(&hsdev->pending.ready);
303 		hsdev->pending.usage_id = usage_id;
304 		hsdev->pending.attr_usage_id = attr_usage_id;
305 		hsdev->pending.raw_size = 0;
306 
307 		spin_lock_irqsave(&data->lock, flags);
308 		hsdev->pending.status = true;
309 		spin_unlock_irqrestore(&data->lock, flags);
310 	}
311 	mutex_lock(&data->mutex);
312 	hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
313 	mutex_unlock(&data->mutex);
314 	if (flag == SENSOR_HUB_SYNC) {
315 		wait_for_completion_interruptible_timeout(
316 						&hsdev->pending.ready, HZ*5);
317 		switch (hsdev->pending.raw_size) {
318 		case 1:
319 			ret_val = *(u8 *)hsdev->pending.raw_data;
320 			break;
321 		case 2:
322 			ret_val = *(u16 *)hsdev->pending.raw_data;
323 			break;
324 		case 4:
325 			ret_val = *(u32 *)hsdev->pending.raw_data;
326 			break;
327 		default:
328 			ret_val = 0;
329 		}
330 		kfree(hsdev->pending.raw_data);
331 		hsdev->pending.status = false;
332 	}
333 	mutex_unlock(hsdev->mutex_ptr);
334 
335 	return ret_val;
336 }
337 EXPORT_SYMBOL_GPL(sensor_hub_input_attr_get_raw_value);
338 
339 int hid_sensor_get_usage_index(struct hid_sensor_hub_device *hsdev,
340 				u32 report_id, int field_index, u32 usage_id)
341 {
342 	struct hid_report *report;
343 	struct hid_field *field;
344 	int i;
345 
346 	report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
347 	if (!report || (field_index >= report->maxfield))
348 		goto done_proc;
349 
350 	field = report->field[field_index];
351 	for (i = 0; i < field->maxusage; ++i) {
352 		if (field->usage[i].hid == usage_id)
353 			return field->usage[i].usage_index;
354 	}
355 
356 done_proc:
357 	return -EINVAL;
358 }
359 EXPORT_SYMBOL_GPL(hid_sensor_get_usage_index);
360 
361 int sensor_hub_input_get_attribute_info(struct hid_sensor_hub_device *hsdev,
362 				u8 type,
363 				u32 usage_id,
364 				u32 attr_usage_id,
365 				struct hid_sensor_hub_attribute_info *info)
366 {
367 	int ret = -1;
368 	int i;
369 	struct hid_report *report;
370 	struct hid_field *field;
371 	struct hid_report_enum *report_enum;
372 	struct hid_device *hdev = hsdev->hdev;
373 
374 	/* Initialize with defaults */
375 	info->usage_id = usage_id;
376 	info->attrib_id = attr_usage_id;
377 	info->report_id = -1;
378 	info->index = -1;
379 	info->units = -1;
380 	info->unit_expo = -1;
381 
382 	report_enum = &hdev->report_enum[type];
383 	list_for_each_entry(report, &report_enum->report_list, list) {
384 		for (i = 0; i < report->maxfield; ++i) {
385 			field = report->field[i];
386 			if (field->maxusage) {
387 				if (field->physical == usage_id &&
388 					(field->logical == attr_usage_id ||
389 					field->usage[0].hid ==
390 							attr_usage_id) &&
391 					(field->usage[0].collection_index >=
392 					hsdev->start_collection_index) &&
393 					(field->usage[0].collection_index <
394 					hsdev->end_collection_index)) {
395 
396 					sensor_hub_fill_attr_info(info, i,
397 								report->id,
398 								field);
399 					ret = 0;
400 					break;
401 				}
402 			}
403 		}
404 
405 	}
406 
407 	return ret;
408 }
409 EXPORT_SYMBOL_GPL(sensor_hub_input_get_attribute_info);
410 
411 #ifdef CONFIG_PM
412 static int sensor_hub_suspend(struct hid_device *hdev, pm_message_t message)
413 {
414 	struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
415 	struct hid_sensor_hub_callbacks_list *callback;
416 	unsigned long flags;
417 
418 	hid_dbg(hdev, " sensor_hub_suspend\n");
419 	spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
420 	list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
421 		if (callback->usage_callback->suspend)
422 			callback->usage_callback->suspend(
423 					callback->hsdev, callback->priv);
424 	}
425 	spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
426 
427 	return 0;
428 }
429 
430 static int sensor_hub_resume(struct hid_device *hdev)
431 {
432 	struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
433 	struct hid_sensor_hub_callbacks_list *callback;
434 	unsigned long flags;
435 
436 	hid_dbg(hdev, " sensor_hub_resume\n");
437 	spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
438 	list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
439 		if (callback->usage_callback->resume)
440 			callback->usage_callback->resume(
441 					callback->hsdev, callback->priv);
442 	}
443 	spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
444 
445 	return 0;
446 }
447 
448 static int sensor_hub_reset_resume(struct hid_device *hdev)
449 {
450 	return 0;
451 }
452 #endif
453 
454 /*
455  * Handle raw report as sent by device
456  */
457 static int sensor_hub_raw_event(struct hid_device *hdev,
458 		struct hid_report *report, u8 *raw_data, int size)
459 {
460 	int i;
461 	u8 *ptr;
462 	int sz;
463 	struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
464 	unsigned long flags;
465 	struct hid_sensor_hub_callbacks *callback = NULL;
466 	struct hid_collection *collection = NULL;
467 	void *priv = NULL;
468 	struct hid_sensor_hub_device *hsdev = NULL;
469 
470 	hid_dbg(hdev, "sensor_hub_raw_event report id:0x%x size:%d type:%d\n",
471 			 report->id, size, report->type);
472 	hid_dbg(hdev, "maxfield:%d\n", report->maxfield);
473 	if (report->type != HID_INPUT_REPORT)
474 		return 1;
475 
476 	ptr = raw_data;
477 	ptr++; /* Skip report id */
478 
479 	spin_lock_irqsave(&pdata->lock, flags);
480 
481 	for (i = 0; i < report->maxfield; ++i) {
482 		hid_dbg(hdev, "%d collection_index:%x hid:%x sz:%x\n",
483 				i, report->field[i]->usage->collection_index,
484 				report->field[i]->usage->hid,
485 				(report->field[i]->report_size *
486 					report->field[i]->report_count)/8);
487 		sz = (report->field[i]->report_size *
488 					report->field[i]->report_count)/8;
489 		collection = &hdev->collection[
490 				report->field[i]->usage->collection_index];
491 		hid_dbg(hdev, "collection->usage %x\n",
492 					collection->usage);
493 
494 		callback = sensor_hub_get_callback(hdev,
495 				report->field[i]->physical,
496 				report->field[i]->usage[0].collection_index,
497 				&hsdev, &priv);
498 		if (!callback) {
499 			ptr += sz;
500 			continue;
501 		}
502 		if (hsdev->pending.status && (hsdev->pending.attr_usage_id ==
503 					      report->field[i]->usage->hid ||
504 					      hsdev->pending.attr_usage_id ==
505 					      report->field[i]->logical)) {
506 			hid_dbg(hdev, "data was pending ...\n");
507 			hsdev->pending.raw_data = kmemdup(ptr, sz, GFP_ATOMIC);
508 			if (hsdev->pending.raw_data)
509 				hsdev->pending.raw_size = sz;
510 			else
511 				hsdev->pending.raw_size = 0;
512 			complete(&hsdev->pending.ready);
513 		}
514 		if (callback->capture_sample) {
515 			if (report->field[i]->logical)
516 				callback->capture_sample(hsdev,
517 					report->field[i]->logical, sz, ptr,
518 					callback->pdev);
519 			else
520 				callback->capture_sample(hsdev,
521 					report->field[i]->usage->hid, sz, ptr,
522 					callback->pdev);
523 		}
524 		ptr += sz;
525 	}
526 	if (callback && collection && callback->send_event)
527 		callback->send_event(hsdev, collection->usage,
528 				callback->pdev);
529 	spin_unlock_irqrestore(&pdata->lock, flags);
530 
531 	return 1;
532 }
533 
534 int sensor_hub_device_open(struct hid_sensor_hub_device *hsdev)
535 {
536 	int ret = 0;
537 	struct sensor_hub_data *data =  hid_get_drvdata(hsdev->hdev);
538 
539 	mutex_lock(&data->mutex);
540 	if (!data->ref_cnt) {
541 		ret = hid_hw_open(hsdev->hdev);
542 		if (ret) {
543 			hid_err(hsdev->hdev, "failed to open hid device\n");
544 			mutex_unlock(&data->mutex);
545 			return ret;
546 		}
547 	}
548 	data->ref_cnt++;
549 	mutex_unlock(&data->mutex);
550 
551 	return ret;
552 }
553 EXPORT_SYMBOL_GPL(sensor_hub_device_open);
554 
555 void sensor_hub_device_close(struct hid_sensor_hub_device *hsdev)
556 {
557 	struct sensor_hub_data *data =  hid_get_drvdata(hsdev->hdev);
558 
559 	mutex_lock(&data->mutex);
560 	data->ref_cnt--;
561 	if (!data->ref_cnt)
562 		hid_hw_close(hsdev->hdev);
563 	mutex_unlock(&data->mutex);
564 }
565 EXPORT_SYMBOL_GPL(sensor_hub_device_close);
566 
567 static __u8 *sensor_hub_report_fixup(struct hid_device *hdev, __u8 *rdesc,
568 		unsigned int *rsize)
569 {
570 	int index;
571 	struct sensor_hub_data *sd =  hid_get_drvdata(hdev);
572 	unsigned char report_block[] = {
573 				0x0a,  0x16, 0x03, 0x15, 0x00, 0x25, 0x05};
574 	unsigned char power_block[] = {
575 				0x0a,  0x19, 0x03, 0x15, 0x00, 0x25, 0x05};
576 
577 	if (!(sd->quirks & HID_SENSOR_HUB_ENUM_QUIRK)) {
578 		hid_dbg(hdev, "No Enum quirks\n");
579 		return rdesc;
580 	}
581 
582 	/* Looks for power and report state usage id and force to 1 */
583 	for (index = 0; index < *rsize; ++index) {
584 		if (((*rsize - index) > sizeof(report_block)) &&
585 			!memcmp(&rdesc[index], report_block,
586 						sizeof(report_block))) {
587 			rdesc[index + 4] = 0x01;
588 			index += sizeof(report_block);
589 		}
590 		if (((*rsize - index) > sizeof(power_block)) &&
591 			!memcmp(&rdesc[index], power_block,
592 						sizeof(power_block))) {
593 			rdesc[index + 4] = 0x01;
594 			index += sizeof(power_block);
595 		}
596 	}
597 
598 	/* Checks if the report descriptor of Thinkpad Helix 2 has a logical
599 	 * minimum for magnetic flux axis greater than the maximum */
600 	if (hdev->product == USB_DEVICE_ID_TEXAS_INSTRUMENTS_LENOVO_YOGA &&
601 		*rsize == 2558 && rdesc[913] == 0x17 && rdesc[914] == 0x40 &&
602 		rdesc[915] == 0x81 && rdesc[916] == 0x08 &&
603 		rdesc[917] == 0x00 && rdesc[918] == 0x27 &&
604 		rdesc[921] == 0x07 && rdesc[922] == 0x00) {
605 		/* Sets negative logical minimum for mag x, y and z */
606 		rdesc[914] = rdesc[935] = rdesc[956] = 0xc0;
607 		rdesc[915] = rdesc[936] = rdesc[957] = 0x7e;
608 		rdesc[916] = rdesc[937] = rdesc[958] = 0xf7;
609 		rdesc[917] = rdesc[938] = rdesc[959] = 0xff;
610 	}
611 
612 	return rdesc;
613 }
614 
615 static int sensor_hub_probe(struct hid_device *hdev,
616 				const struct hid_device_id *id)
617 {
618 	int ret;
619 	struct sensor_hub_data *sd;
620 	int i;
621 	char *name;
622 	int dev_cnt;
623 	struct hid_sensor_hub_device *hsdev;
624 	struct hid_sensor_hub_device *last_hsdev = NULL;
625 	struct hid_sensor_hub_device *collection_hsdev = NULL;
626 
627 	sd = devm_kzalloc(&hdev->dev, sizeof(*sd), GFP_KERNEL);
628 	if (!sd) {
629 		hid_err(hdev, "cannot allocate Sensor data\n");
630 		return -ENOMEM;
631 	}
632 
633 	hid_set_drvdata(hdev, sd);
634 	sd->quirks = id->driver_data;
635 
636 	spin_lock_init(&sd->lock);
637 	spin_lock_init(&sd->dyn_callback_lock);
638 	mutex_init(&sd->mutex);
639 	ret = hid_parse(hdev);
640 	if (ret) {
641 		hid_err(hdev, "parse failed\n");
642 		return ret;
643 	}
644 	INIT_LIST_HEAD(&hdev->inputs);
645 
646 	ret = hid_hw_start(hdev, 0);
647 	if (ret) {
648 		hid_err(hdev, "hw start failed\n");
649 		return ret;
650 	}
651 	INIT_LIST_HEAD(&sd->dyn_callback_list);
652 	sd->hid_sensor_client_cnt = 0;
653 
654 	dev_cnt = sensor_hub_get_physical_device_count(hdev);
655 	if (dev_cnt > HID_MAX_PHY_DEVICES) {
656 		hid_err(hdev, "Invalid Physical device count\n");
657 		ret = -EINVAL;
658 		goto err_stop_hw;
659 	}
660 	sd->hid_sensor_hub_client_devs = devm_kzalloc(&hdev->dev, dev_cnt *
661 						      sizeof(struct mfd_cell),
662 						      GFP_KERNEL);
663 	if (sd->hid_sensor_hub_client_devs == NULL) {
664 		hid_err(hdev, "Failed to allocate memory for mfd cells\n");
665 		ret = -ENOMEM;
666 		goto err_stop_hw;
667 	}
668 
669 	for (i = 0; i < hdev->maxcollection; ++i) {
670 		struct hid_collection *collection = &hdev->collection[i];
671 
672 		if (collection->type == HID_COLLECTION_PHYSICAL ||
673 		    collection->type == HID_COLLECTION_APPLICATION) {
674 
675 			hsdev = devm_kzalloc(&hdev->dev, sizeof(*hsdev),
676 					     GFP_KERNEL);
677 			if (!hsdev) {
678 				hid_err(hdev, "cannot allocate hid_sensor_hub_device\n");
679 				ret = -ENOMEM;
680 				goto err_stop_hw;
681 			}
682 			hsdev->hdev = hdev;
683 			hsdev->vendor_id = hdev->vendor;
684 			hsdev->product_id = hdev->product;
685 			hsdev->usage = collection->usage;
686 			hsdev->mutex_ptr = devm_kzalloc(&hdev->dev,
687 							sizeof(struct mutex),
688 							GFP_KERNEL);
689 			if (!hsdev->mutex_ptr) {
690 				ret = -ENOMEM;
691 				goto err_stop_hw;
692 			}
693 			mutex_init(hsdev->mutex_ptr);
694 			hsdev->start_collection_index = i;
695 			if (last_hsdev)
696 				last_hsdev->end_collection_index = i;
697 			last_hsdev = hsdev;
698 			name = devm_kasprintf(&hdev->dev, GFP_KERNEL,
699 					      "HID-SENSOR-%x",
700 					      collection->usage);
701 			if (name == NULL) {
702 				hid_err(hdev, "Failed MFD device name\n");
703 				ret = -ENOMEM;
704 				goto err_stop_hw;
705 			}
706 			sd->hid_sensor_hub_client_devs[
707 				sd->hid_sensor_client_cnt].name = name;
708 			sd->hid_sensor_hub_client_devs[
709 				sd->hid_sensor_client_cnt].platform_data =
710 							hsdev;
711 			sd->hid_sensor_hub_client_devs[
712 				sd->hid_sensor_client_cnt].pdata_size =
713 							sizeof(*hsdev);
714 			hid_dbg(hdev, "Adding %s:%d\n", name,
715 					hsdev->start_collection_index);
716 			sd->hid_sensor_client_cnt++;
717 			if (collection_hsdev)
718 				collection_hsdev->end_collection_index = i;
719 			if (collection->type == HID_COLLECTION_APPLICATION &&
720 			    collection->usage == HID_USAGE_SENSOR_COLLECTION)
721 				collection_hsdev = hsdev;
722 		}
723 	}
724 	if (last_hsdev)
725 		last_hsdev->end_collection_index = i;
726 	if (collection_hsdev)
727 		collection_hsdev->end_collection_index = i;
728 
729 	ret = mfd_add_hotplug_devices(&hdev->dev,
730 			sd->hid_sensor_hub_client_devs,
731 			sd->hid_sensor_client_cnt);
732 	if (ret < 0)
733 		goto err_stop_hw;
734 
735 	return ret;
736 
737 err_stop_hw:
738 	hid_hw_stop(hdev);
739 
740 	return ret;
741 }
742 
743 static void sensor_hub_remove(struct hid_device *hdev)
744 {
745 	struct sensor_hub_data *data = hid_get_drvdata(hdev);
746 	unsigned long flags;
747 	int i;
748 
749 	hid_dbg(hdev, " hardware removed\n");
750 	hid_hw_close(hdev);
751 	hid_hw_stop(hdev);
752 	spin_lock_irqsave(&data->lock, flags);
753 	for (i = 0; i < data->hid_sensor_client_cnt; ++i) {
754 		struct hid_sensor_hub_device *hsdev =
755 			data->hid_sensor_hub_client_devs[i].platform_data;
756 		if (hsdev->pending.status)
757 			complete(&hsdev->pending.ready);
758 	}
759 	spin_unlock_irqrestore(&data->lock, flags);
760 	mfd_remove_devices(&hdev->dev);
761 	hid_set_drvdata(hdev, NULL);
762 	mutex_destroy(&data->mutex);
763 }
764 
765 static const struct hid_device_id sensor_hub_devices[] = {
766 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_INTEL_0,
767 			USB_DEVICE_ID_INTEL_HID_SENSOR_0),
768 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
769 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_INTEL_1,
770 			USB_DEVICE_ID_INTEL_HID_SENSOR_0),
771 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
772 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_INTEL_1,
773 			USB_DEVICE_ID_INTEL_HID_SENSOR_1),
774 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
775 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_MICROSOFT,
776 			USB_DEVICE_ID_MS_SURFACE_PRO_2),
777 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
778 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_MICROSOFT,
779 			USB_DEVICE_ID_MS_TOUCH_COVER_2),
780 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
781 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_MICROSOFT,
782 			USB_DEVICE_ID_MS_TYPE_COVER_2),
783 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
784 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_STM_0,
785 			USB_DEVICE_ID_STM_HID_SENSOR),
786 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
787 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_STM_0,
788 			USB_DEVICE_ID_STM_HID_SENSOR_1),
789 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
790 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_TEXAS_INSTRUMENTS,
791 			USB_DEVICE_ID_TEXAS_INSTRUMENTS_LENOVO_YOGA),
792 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
793 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_ITE,
794 			USB_DEVICE_ID_ITE_LENOVO_YOGA),
795 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
796 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_ITE,
797 			USB_DEVICE_ID_ITE_LENOVO_YOGA2),
798 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
799 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_ITE,
800 			USB_DEVICE_ID_ITE_LENOVO_YOGA900),
801 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
802 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_INTEL_0,
803 			0x22D8),
804 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
805 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, HID_ANY_ID,
806 		     HID_ANY_ID) },
807 	{ }
808 };
809 MODULE_DEVICE_TABLE(hid, sensor_hub_devices);
810 
811 static struct hid_driver sensor_hub_driver = {
812 	.name = "hid-sensor-hub",
813 	.id_table = sensor_hub_devices,
814 	.probe = sensor_hub_probe,
815 	.remove = sensor_hub_remove,
816 	.raw_event = sensor_hub_raw_event,
817 	.report_fixup = sensor_hub_report_fixup,
818 #ifdef CONFIG_PM
819 	.suspend = sensor_hub_suspend,
820 	.resume = sensor_hub_resume,
821 	.reset_resume = sensor_hub_reset_resume,
822 #endif
823 };
824 module_hid_driver(sensor_hub_driver);
825 
826 MODULE_DESCRIPTION("HID Sensor Hub driver");
827 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
828 MODULE_LICENSE("GPL");
829