xref: /openbmc/linux/drivers/hid/hid-sensor-hub.c (revision 82003e04)
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 	u8 *val_ptr;
255 	int buffer_index = 0;
256 	int i;
257 
258 	mutex_lock(&data->mutex);
259 	report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
260 	if (!report || (field_index >= report->maxfield) ||
261 	    report->field[field_index]->report_count < 1) {
262 		ret = -EINVAL;
263 		goto done_proc;
264 	}
265 	hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
266 	hid_hw_wait(hsdev->hdev);
267 
268 	/* calculate number of bytes required to read this field */
269 	report_size = DIV_ROUND_UP(report->field[field_index]->report_size,
270 				   8) *
271 				   report->field[field_index]->report_count;
272 	if (!report_size) {
273 		ret = -EINVAL;
274 		goto done_proc;
275 	}
276 	ret = min(report_size, buffer_size);
277 
278 	val_ptr = (u8 *)report->field[field_index]->value;
279 	for (i = 0; i < report->field[field_index]->report_count; ++i) {
280 		if (buffer_index >= ret)
281 			break;
282 
283 		memcpy(&((u8 *)buffer)[buffer_index], val_ptr,
284 		       report->field[field_index]->report_size / 8);
285 		val_ptr += sizeof(__s32);
286 		buffer_index += (report->field[field_index]->report_size / 8);
287 	}
288 
289 done_proc:
290 	mutex_unlock(&data->mutex);
291 
292 	return ret;
293 }
294 EXPORT_SYMBOL_GPL(sensor_hub_get_feature);
295 
296 
297 int sensor_hub_input_attr_get_raw_value(struct hid_sensor_hub_device *hsdev,
298 					u32 usage_id,
299 					u32 attr_usage_id, u32 report_id,
300 					enum sensor_hub_read_flags flag)
301 {
302 	struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
303 	unsigned long flags;
304 	struct hid_report *report;
305 	int ret_val = 0;
306 
307 	report = sensor_hub_report(report_id, hsdev->hdev,
308 				   HID_INPUT_REPORT);
309 	if (!report)
310 		return -EINVAL;
311 
312 	mutex_lock(hsdev->mutex_ptr);
313 	if (flag == SENSOR_HUB_SYNC) {
314 		memset(&hsdev->pending, 0, sizeof(hsdev->pending));
315 		init_completion(&hsdev->pending.ready);
316 		hsdev->pending.usage_id = usage_id;
317 		hsdev->pending.attr_usage_id = attr_usage_id;
318 		hsdev->pending.raw_size = 0;
319 
320 		spin_lock_irqsave(&data->lock, flags);
321 		hsdev->pending.status = true;
322 		spin_unlock_irqrestore(&data->lock, flags);
323 	}
324 	mutex_lock(&data->mutex);
325 	hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
326 	mutex_unlock(&data->mutex);
327 	if (flag == SENSOR_HUB_SYNC) {
328 		wait_for_completion_interruptible_timeout(
329 						&hsdev->pending.ready, HZ*5);
330 		switch (hsdev->pending.raw_size) {
331 		case 1:
332 			ret_val = *(u8 *)hsdev->pending.raw_data;
333 			break;
334 		case 2:
335 			ret_val = *(u16 *)hsdev->pending.raw_data;
336 			break;
337 		case 4:
338 			ret_val = *(u32 *)hsdev->pending.raw_data;
339 			break;
340 		default:
341 			ret_val = 0;
342 		}
343 		kfree(hsdev->pending.raw_data);
344 		hsdev->pending.status = false;
345 	}
346 	mutex_unlock(hsdev->mutex_ptr);
347 
348 	return ret_val;
349 }
350 EXPORT_SYMBOL_GPL(sensor_hub_input_attr_get_raw_value);
351 
352 int hid_sensor_get_usage_index(struct hid_sensor_hub_device *hsdev,
353 				u32 report_id, int field_index, u32 usage_id)
354 {
355 	struct hid_report *report;
356 	struct hid_field *field;
357 	int i;
358 
359 	report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
360 	if (!report || (field_index >= report->maxfield))
361 		goto done_proc;
362 
363 	field = report->field[field_index];
364 	for (i = 0; i < field->maxusage; ++i) {
365 		if (field->usage[i].hid == usage_id)
366 			return field->usage[i].usage_index;
367 	}
368 
369 done_proc:
370 	return -EINVAL;
371 }
372 EXPORT_SYMBOL_GPL(hid_sensor_get_usage_index);
373 
374 int sensor_hub_input_get_attribute_info(struct hid_sensor_hub_device *hsdev,
375 				u8 type,
376 				u32 usage_id,
377 				u32 attr_usage_id,
378 				struct hid_sensor_hub_attribute_info *info)
379 {
380 	int ret = -1;
381 	int i;
382 	struct hid_report *report;
383 	struct hid_field *field;
384 	struct hid_report_enum *report_enum;
385 	struct hid_device *hdev = hsdev->hdev;
386 
387 	/* Initialize with defaults */
388 	info->usage_id = usage_id;
389 	info->attrib_id = attr_usage_id;
390 	info->report_id = -1;
391 	info->index = -1;
392 	info->units = -1;
393 	info->unit_expo = -1;
394 
395 	report_enum = &hdev->report_enum[type];
396 	list_for_each_entry(report, &report_enum->report_list, list) {
397 		for (i = 0; i < report->maxfield; ++i) {
398 			field = report->field[i];
399 			if (field->maxusage) {
400 				if (field->physical == usage_id &&
401 					(field->logical == attr_usage_id ||
402 					field->usage[0].hid ==
403 							attr_usage_id) &&
404 					(field->usage[0].collection_index >=
405 					hsdev->start_collection_index) &&
406 					(field->usage[0].collection_index <
407 					hsdev->end_collection_index)) {
408 
409 					sensor_hub_fill_attr_info(info, i,
410 								report->id,
411 								field);
412 					ret = 0;
413 					break;
414 				}
415 			}
416 		}
417 
418 	}
419 
420 	return ret;
421 }
422 EXPORT_SYMBOL_GPL(sensor_hub_input_get_attribute_info);
423 
424 #ifdef CONFIG_PM
425 static int sensor_hub_suspend(struct hid_device *hdev, pm_message_t message)
426 {
427 	struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
428 	struct hid_sensor_hub_callbacks_list *callback;
429 	unsigned long flags;
430 
431 	hid_dbg(hdev, " sensor_hub_suspend\n");
432 	spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
433 	list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
434 		if (callback->usage_callback->suspend)
435 			callback->usage_callback->suspend(
436 					callback->hsdev, callback->priv);
437 	}
438 	spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
439 
440 	return 0;
441 }
442 
443 static int sensor_hub_resume(struct hid_device *hdev)
444 {
445 	struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
446 	struct hid_sensor_hub_callbacks_list *callback;
447 	unsigned long flags;
448 
449 	hid_dbg(hdev, " sensor_hub_resume\n");
450 	spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
451 	list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
452 		if (callback->usage_callback->resume)
453 			callback->usage_callback->resume(
454 					callback->hsdev, callback->priv);
455 	}
456 	spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
457 
458 	return 0;
459 }
460 
461 static int sensor_hub_reset_resume(struct hid_device *hdev)
462 {
463 	return 0;
464 }
465 #endif
466 
467 /*
468  * Handle raw report as sent by device
469  */
470 static int sensor_hub_raw_event(struct hid_device *hdev,
471 		struct hid_report *report, u8 *raw_data, int size)
472 {
473 	int i;
474 	u8 *ptr;
475 	int sz;
476 	struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
477 	unsigned long flags;
478 	struct hid_sensor_hub_callbacks *callback = NULL;
479 	struct hid_collection *collection = NULL;
480 	void *priv = NULL;
481 	struct hid_sensor_hub_device *hsdev = NULL;
482 
483 	hid_dbg(hdev, "sensor_hub_raw_event report id:0x%x size:%d type:%d\n",
484 			 report->id, size, report->type);
485 	hid_dbg(hdev, "maxfield:%d\n", report->maxfield);
486 	if (report->type != HID_INPUT_REPORT)
487 		return 1;
488 
489 	ptr = raw_data;
490 	ptr++; /* Skip report id */
491 
492 	spin_lock_irqsave(&pdata->lock, flags);
493 
494 	for (i = 0; i < report->maxfield; ++i) {
495 		hid_dbg(hdev, "%d collection_index:%x hid:%x sz:%x\n",
496 				i, report->field[i]->usage->collection_index,
497 				report->field[i]->usage->hid,
498 				(report->field[i]->report_size *
499 					report->field[i]->report_count)/8);
500 		sz = (report->field[i]->report_size *
501 					report->field[i]->report_count)/8;
502 		collection = &hdev->collection[
503 				report->field[i]->usage->collection_index];
504 		hid_dbg(hdev, "collection->usage %x\n",
505 					collection->usage);
506 
507 		callback = sensor_hub_get_callback(hdev,
508 				report->field[i]->physical,
509 				report->field[i]->usage[0].collection_index,
510 				&hsdev, &priv);
511 		if (!callback) {
512 			ptr += sz;
513 			continue;
514 		}
515 		if (hsdev->pending.status && (hsdev->pending.attr_usage_id ==
516 					      report->field[i]->usage->hid ||
517 					      hsdev->pending.attr_usage_id ==
518 					      report->field[i]->logical)) {
519 			hid_dbg(hdev, "data was pending ...\n");
520 			hsdev->pending.raw_data = kmemdup(ptr, sz, GFP_ATOMIC);
521 			if (hsdev->pending.raw_data)
522 				hsdev->pending.raw_size = sz;
523 			else
524 				hsdev->pending.raw_size = 0;
525 			complete(&hsdev->pending.ready);
526 		}
527 		if (callback->capture_sample) {
528 			if (report->field[i]->logical)
529 				callback->capture_sample(hsdev,
530 					report->field[i]->logical, sz, ptr,
531 					callback->pdev);
532 			else
533 				callback->capture_sample(hsdev,
534 					report->field[i]->usage->hid, sz, ptr,
535 					callback->pdev);
536 		}
537 		ptr += sz;
538 	}
539 	if (callback && collection && callback->send_event)
540 		callback->send_event(hsdev, collection->usage,
541 				callback->pdev);
542 	spin_unlock_irqrestore(&pdata->lock, flags);
543 
544 	return 1;
545 }
546 
547 int sensor_hub_device_open(struct hid_sensor_hub_device *hsdev)
548 {
549 	int ret = 0;
550 	struct sensor_hub_data *data =  hid_get_drvdata(hsdev->hdev);
551 
552 	mutex_lock(&data->mutex);
553 	if (!data->ref_cnt) {
554 		ret = hid_hw_open(hsdev->hdev);
555 		if (ret) {
556 			hid_err(hsdev->hdev, "failed to open hid device\n");
557 			mutex_unlock(&data->mutex);
558 			return ret;
559 		}
560 	}
561 	data->ref_cnt++;
562 	mutex_unlock(&data->mutex);
563 
564 	return ret;
565 }
566 EXPORT_SYMBOL_GPL(sensor_hub_device_open);
567 
568 void sensor_hub_device_close(struct hid_sensor_hub_device *hsdev)
569 {
570 	struct sensor_hub_data *data =  hid_get_drvdata(hsdev->hdev);
571 
572 	mutex_lock(&data->mutex);
573 	data->ref_cnt--;
574 	if (!data->ref_cnt)
575 		hid_hw_close(hsdev->hdev);
576 	mutex_unlock(&data->mutex);
577 }
578 EXPORT_SYMBOL_GPL(sensor_hub_device_close);
579 
580 static __u8 *sensor_hub_report_fixup(struct hid_device *hdev, __u8 *rdesc,
581 		unsigned int *rsize)
582 {
583 	int index;
584 	struct sensor_hub_data *sd =  hid_get_drvdata(hdev);
585 	unsigned char report_block[] = {
586 				0x0a,  0x16, 0x03, 0x15, 0x00, 0x25, 0x05};
587 	unsigned char power_block[] = {
588 				0x0a,  0x19, 0x03, 0x15, 0x00, 0x25, 0x05};
589 
590 	if (!(sd->quirks & HID_SENSOR_HUB_ENUM_QUIRK)) {
591 		hid_dbg(hdev, "No Enum quirks\n");
592 		return rdesc;
593 	}
594 
595 	/* Looks for power and report state usage id and force to 1 */
596 	for (index = 0; index < *rsize; ++index) {
597 		if (((*rsize - index) > sizeof(report_block)) &&
598 			!memcmp(&rdesc[index], report_block,
599 						sizeof(report_block))) {
600 			rdesc[index + 4] = 0x01;
601 			index += sizeof(report_block);
602 		}
603 		if (((*rsize - index) > sizeof(power_block)) &&
604 			!memcmp(&rdesc[index], power_block,
605 						sizeof(power_block))) {
606 			rdesc[index + 4] = 0x01;
607 			index += sizeof(power_block);
608 		}
609 	}
610 
611 	/* Checks if the report descriptor of Thinkpad Helix 2 has a logical
612 	 * minimum for magnetic flux axis greater than the maximum */
613 	if (hdev->product == USB_DEVICE_ID_TEXAS_INSTRUMENTS_LENOVO_YOGA &&
614 		*rsize == 2558 && rdesc[913] == 0x17 && rdesc[914] == 0x40 &&
615 		rdesc[915] == 0x81 && rdesc[916] == 0x08 &&
616 		rdesc[917] == 0x00 && rdesc[918] == 0x27 &&
617 		rdesc[921] == 0x07 && rdesc[922] == 0x00) {
618 		/* Sets negative logical minimum for mag x, y and z */
619 		rdesc[914] = rdesc[935] = rdesc[956] = 0xc0;
620 		rdesc[915] = rdesc[936] = rdesc[957] = 0x7e;
621 		rdesc[916] = rdesc[937] = rdesc[958] = 0xf7;
622 		rdesc[917] = rdesc[938] = rdesc[959] = 0xff;
623 	}
624 
625 	return rdesc;
626 }
627 
628 static int sensor_hub_probe(struct hid_device *hdev,
629 				const struct hid_device_id *id)
630 {
631 	int ret;
632 	struct sensor_hub_data *sd;
633 	int i;
634 	char *name;
635 	int dev_cnt;
636 	struct hid_sensor_hub_device *hsdev;
637 	struct hid_sensor_hub_device *last_hsdev = NULL;
638 	struct hid_sensor_hub_device *collection_hsdev = NULL;
639 
640 	sd = devm_kzalloc(&hdev->dev, sizeof(*sd), GFP_KERNEL);
641 	if (!sd) {
642 		hid_err(hdev, "cannot allocate Sensor data\n");
643 		return -ENOMEM;
644 	}
645 
646 	hid_set_drvdata(hdev, sd);
647 	sd->quirks = id->driver_data;
648 
649 	spin_lock_init(&sd->lock);
650 	spin_lock_init(&sd->dyn_callback_lock);
651 	mutex_init(&sd->mutex);
652 	ret = hid_parse(hdev);
653 	if (ret) {
654 		hid_err(hdev, "parse failed\n");
655 		return ret;
656 	}
657 	INIT_LIST_HEAD(&hdev->inputs);
658 
659 	ret = hid_hw_start(hdev, 0);
660 	if (ret) {
661 		hid_err(hdev, "hw start failed\n");
662 		return ret;
663 	}
664 	INIT_LIST_HEAD(&sd->dyn_callback_list);
665 	sd->hid_sensor_client_cnt = 0;
666 
667 	dev_cnt = sensor_hub_get_physical_device_count(hdev);
668 	if (dev_cnt > HID_MAX_PHY_DEVICES) {
669 		hid_err(hdev, "Invalid Physical device count\n");
670 		ret = -EINVAL;
671 		goto err_stop_hw;
672 	}
673 	sd->hid_sensor_hub_client_devs = devm_kzalloc(&hdev->dev, dev_cnt *
674 						      sizeof(struct mfd_cell),
675 						      GFP_KERNEL);
676 	if (sd->hid_sensor_hub_client_devs == NULL) {
677 		hid_err(hdev, "Failed to allocate memory for mfd cells\n");
678 		ret = -ENOMEM;
679 		goto err_stop_hw;
680 	}
681 
682 	for (i = 0; i < hdev->maxcollection; ++i) {
683 		struct hid_collection *collection = &hdev->collection[i];
684 
685 		if (collection->type == HID_COLLECTION_PHYSICAL ||
686 		    collection->type == HID_COLLECTION_APPLICATION) {
687 
688 			hsdev = devm_kzalloc(&hdev->dev, sizeof(*hsdev),
689 					     GFP_KERNEL);
690 			if (!hsdev) {
691 				hid_err(hdev, "cannot allocate hid_sensor_hub_device\n");
692 				ret = -ENOMEM;
693 				goto err_stop_hw;
694 			}
695 			hsdev->hdev = hdev;
696 			hsdev->vendor_id = hdev->vendor;
697 			hsdev->product_id = hdev->product;
698 			hsdev->usage = collection->usage;
699 			hsdev->mutex_ptr = devm_kzalloc(&hdev->dev,
700 							sizeof(struct mutex),
701 							GFP_KERNEL);
702 			if (!hsdev->mutex_ptr) {
703 				ret = -ENOMEM;
704 				goto err_stop_hw;
705 			}
706 			mutex_init(hsdev->mutex_ptr);
707 			hsdev->start_collection_index = i;
708 			if (last_hsdev)
709 				last_hsdev->end_collection_index = i;
710 			last_hsdev = hsdev;
711 			name = devm_kasprintf(&hdev->dev, GFP_KERNEL,
712 					      "HID-SENSOR-%x",
713 					      collection->usage);
714 			if (name == NULL) {
715 				hid_err(hdev, "Failed MFD device name\n");
716 				ret = -ENOMEM;
717 				goto err_stop_hw;
718 			}
719 			sd->hid_sensor_hub_client_devs[
720 				sd->hid_sensor_client_cnt].name = name;
721 			sd->hid_sensor_hub_client_devs[
722 				sd->hid_sensor_client_cnt].platform_data =
723 							hsdev;
724 			sd->hid_sensor_hub_client_devs[
725 				sd->hid_sensor_client_cnt].pdata_size =
726 							sizeof(*hsdev);
727 			hid_dbg(hdev, "Adding %s:%d\n", name,
728 					hsdev->start_collection_index);
729 			sd->hid_sensor_client_cnt++;
730 			if (collection_hsdev)
731 				collection_hsdev->end_collection_index = i;
732 			if (collection->type == HID_COLLECTION_APPLICATION &&
733 			    collection->usage == HID_USAGE_SENSOR_COLLECTION)
734 				collection_hsdev = hsdev;
735 		}
736 	}
737 	if (last_hsdev)
738 		last_hsdev->end_collection_index = i;
739 	if (collection_hsdev)
740 		collection_hsdev->end_collection_index = i;
741 
742 	ret = mfd_add_hotplug_devices(&hdev->dev,
743 			sd->hid_sensor_hub_client_devs,
744 			sd->hid_sensor_client_cnt);
745 	if (ret < 0)
746 		goto err_stop_hw;
747 
748 	return ret;
749 
750 err_stop_hw:
751 	hid_hw_stop(hdev);
752 
753 	return ret;
754 }
755 
756 static void sensor_hub_remove(struct hid_device *hdev)
757 {
758 	struct sensor_hub_data *data = hid_get_drvdata(hdev);
759 	unsigned long flags;
760 	int i;
761 
762 	hid_dbg(hdev, " hardware removed\n");
763 	hid_hw_close(hdev);
764 	hid_hw_stop(hdev);
765 	spin_lock_irqsave(&data->lock, flags);
766 	for (i = 0; i < data->hid_sensor_client_cnt; ++i) {
767 		struct hid_sensor_hub_device *hsdev =
768 			data->hid_sensor_hub_client_devs[i].platform_data;
769 		if (hsdev->pending.status)
770 			complete(&hsdev->pending.ready);
771 	}
772 	spin_unlock_irqrestore(&data->lock, flags);
773 	mfd_remove_devices(&hdev->dev);
774 	hid_set_drvdata(hdev, NULL);
775 	mutex_destroy(&data->mutex);
776 }
777 
778 static const struct hid_device_id sensor_hub_devices[] = {
779 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_INTEL_0,
780 			USB_DEVICE_ID_INTEL_HID_SENSOR_0),
781 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
782 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_INTEL_1,
783 			USB_DEVICE_ID_INTEL_HID_SENSOR_0),
784 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
785 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_INTEL_1,
786 			USB_DEVICE_ID_INTEL_HID_SENSOR_1),
787 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
788 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_MICROSOFT,
789 			USB_DEVICE_ID_MS_SURFACE_PRO_2),
790 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
791 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_MICROSOFT,
792 			USB_DEVICE_ID_MS_TOUCH_COVER_2),
793 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
794 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_MICROSOFT,
795 			USB_DEVICE_ID_MS_TYPE_COVER_2),
796 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
797 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_STM_0,
798 			USB_DEVICE_ID_STM_HID_SENSOR),
799 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
800 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_STM_0,
801 			USB_DEVICE_ID_STM_HID_SENSOR_1),
802 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
803 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_TEXAS_INSTRUMENTS,
804 			USB_DEVICE_ID_TEXAS_INSTRUMENTS_LENOVO_YOGA),
805 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
806 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_ITE,
807 			USB_DEVICE_ID_ITE_LENOVO_YOGA),
808 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
809 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_ITE,
810 			USB_DEVICE_ID_ITE_LENOVO_YOGA2),
811 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
812 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_ITE,
813 			USB_DEVICE_ID_ITE_LENOVO_YOGA900),
814 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
815 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_INTEL_0,
816 			0x22D8),
817 			.driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
818 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, HID_ANY_ID,
819 		     HID_ANY_ID) },
820 	{ }
821 };
822 MODULE_DEVICE_TABLE(hid, sensor_hub_devices);
823 
824 static struct hid_driver sensor_hub_driver = {
825 	.name = "hid-sensor-hub",
826 	.id_table = sensor_hub_devices,
827 	.probe = sensor_hub_probe,
828 	.remove = sensor_hub_remove,
829 	.raw_event = sensor_hub_raw_event,
830 	.report_fixup = sensor_hub_report_fixup,
831 #ifdef CONFIG_PM
832 	.suspend = sensor_hub_suspend,
833 	.resume = sensor_hub_resume,
834 	.reset_resume = sensor_hub_reset_resume,
835 #endif
836 };
837 module_hid_driver(sensor_hub_driver);
838 
839 MODULE_DESCRIPTION("HID Sensor Hub driver");
840 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
841 MODULE_LICENSE("GPL");
842