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