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