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