1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3 * HID Sensors Driver
4 * Copyright (c) 2012, Intel Corporation.
5 */
6 #include <linux/bitops.h>
7 #include <linux/device.h>
8 #include <linux/platform_device.h>
9 #include <linux/module.h>
10 #include <linux/hid-sensor-hub.h>
11 #include <linux/iio/iio.h>
12 #include <linux/iio/buffer.h>
13 #include "../common/hid-sensors/hid-sensor-trigger.h"
14
15 enum magn_3d_channel {
16 CHANNEL_SCAN_INDEX_X,
17 CHANNEL_SCAN_INDEX_Y,
18 CHANNEL_SCAN_INDEX_Z,
19 CHANNEL_SCAN_INDEX_NORTH_MAGN_TILT_COMP,
20 CHANNEL_SCAN_INDEX_NORTH_TRUE_TILT_COMP,
21 CHANNEL_SCAN_INDEX_NORTH_MAGN,
22 CHANNEL_SCAN_INDEX_NORTH_TRUE,
23 CHANNEL_SCAN_INDEX_TIMESTAMP,
24 MAGN_3D_CHANNEL_MAX,
25 };
26
27 struct common_attributes {
28 int scale_pre_decml;
29 int scale_post_decml;
30 int scale_precision;
31 int value_offset;
32 };
33
34 struct magn_3d_state {
35 struct hid_sensor_hub_callbacks callbacks;
36 struct hid_sensor_common magn_flux_attributes;
37 struct hid_sensor_common rot_attributes;
38 struct hid_sensor_hub_attribute_info magn[MAGN_3D_CHANNEL_MAX];
39
40 /* dynamically sized array to hold sensor values */
41 u32 *iio_vals;
42 /* array of pointers to sensor value */
43 u32 *magn_val_addr[MAGN_3D_CHANNEL_MAX];
44
45 struct common_attributes magn_flux_attr;
46 struct common_attributes rot_attr;
47 s64 timestamp;
48 };
49
50 static const u32 magn_3d_addresses[MAGN_3D_CHANNEL_MAX] = {
51 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS,
52 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Y_AXIS,
53 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Z_AXIS,
54 HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH,
55 HID_USAGE_SENSOR_ORIENT_COMP_TRUE_NORTH,
56 HID_USAGE_SENSOR_ORIENT_MAGN_NORTH,
57 HID_USAGE_SENSOR_ORIENT_TRUE_NORTH,
58 HID_USAGE_SENSOR_TIME_TIMESTAMP,
59 };
60
61 static const u32 magn_3d_sensitivity_addresses[] = {
62 HID_USAGE_SENSOR_DATA_ORIENTATION,
63 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX,
64 };
65
66 /* Channel definitions */
67 static const struct iio_chan_spec magn_3d_channels[] = {
68 {
69 .type = IIO_MAGN,
70 .modified = 1,
71 .channel2 = IIO_MOD_X,
72 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
73 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
74 BIT(IIO_CHAN_INFO_SCALE) |
75 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
76 BIT(IIO_CHAN_INFO_HYSTERESIS),
77 }, {
78 .type = IIO_MAGN,
79 .modified = 1,
80 .channel2 = IIO_MOD_Y,
81 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
82 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
83 BIT(IIO_CHAN_INFO_SCALE) |
84 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
85 BIT(IIO_CHAN_INFO_HYSTERESIS),
86 }, {
87 .type = IIO_MAGN,
88 .modified = 1,
89 .channel2 = IIO_MOD_Z,
90 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
91 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
92 BIT(IIO_CHAN_INFO_SCALE) |
93 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
94 BIT(IIO_CHAN_INFO_HYSTERESIS),
95 }, {
96 .type = IIO_ROT,
97 .modified = 1,
98 .channel2 = IIO_MOD_NORTH_MAGN_TILT_COMP,
99 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
100 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
101 BIT(IIO_CHAN_INFO_SCALE) |
102 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
103 BIT(IIO_CHAN_INFO_HYSTERESIS),
104 }, {
105 .type = IIO_ROT,
106 .modified = 1,
107 .channel2 = IIO_MOD_NORTH_TRUE_TILT_COMP,
108 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
109 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
110 BIT(IIO_CHAN_INFO_SCALE) |
111 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
112 BIT(IIO_CHAN_INFO_HYSTERESIS),
113 }, {
114 .type = IIO_ROT,
115 .modified = 1,
116 .channel2 = IIO_MOD_NORTH_MAGN,
117 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
118 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
119 BIT(IIO_CHAN_INFO_SCALE) |
120 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
121 BIT(IIO_CHAN_INFO_HYSTERESIS),
122 }, {
123 .type = IIO_ROT,
124 .modified = 1,
125 .channel2 = IIO_MOD_NORTH_TRUE,
126 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
127 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
128 BIT(IIO_CHAN_INFO_SCALE) |
129 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
130 BIT(IIO_CHAN_INFO_HYSTERESIS),
131 },
132 IIO_CHAN_SOFT_TIMESTAMP(7)
133 };
134
135 /* Channel read_raw handler */
magn_3d_read_raw(struct iio_dev * indio_dev,struct iio_chan_spec const * chan,int * val,int * val2,long mask)136 static int magn_3d_read_raw(struct iio_dev *indio_dev,
137 struct iio_chan_spec const *chan,
138 int *val, int *val2, long mask)
139 {
140 struct magn_3d_state *magn_state = iio_priv(indio_dev);
141 int report_id = -1;
142 u32 address;
143 int ret_type;
144 s32 min;
145
146 *val = 0;
147 *val2 = 0;
148 switch (mask) {
149 case IIO_CHAN_INFO_RAW:
150 hid_sensor_power_state(&magn_state->magn_flux_attributes, true);
151 report_id = magn_state->magn[chan->address].report_id;
152 min = magn_state->magn[chan->address].logical_minimum;
153 address = magn_3d_addresses[chan->address];
154 if (report_id >= 0)
155 *val = sensor_hub_input_attr_get_raw_value(
156 magn_state->magn_flux_attributes.hsdev,
157 HID_USAGE_SENSOR_COMPASS_3D, address,
158 report_id,
159 SENSOR_HUB_SYNC,
160 min < 0);
161 else {
162 *val = 0;
163 hid_sensor_power_state(
164 &magn_state->magn_flux_attributes,
165 false);
166 return -EINVAL;
167 }
168 hid_sensor_power_state(&magn_state->magn_flux_attributes, false);
169 ret_type = IIO_VAL_INT;
170 break;
171 case IIO_CHAN_INFO_SCALE:
172 switch (chan->type) {
173 case IIO_MAGN:
174 *val = magn_state->magn_flux_attr.scale_pre_decml;
175 *val2 = magn_state->magn_flux_attr.scale_post_decml;
176 ret_type = magn_state->magn_flux_attr.scale_precision;
177 break;
178 case IIO_ROT:
179 *val = magn_state->rot_attr.scale_pre_decml;
180 *val2 = magn_state->rot_attr.scale_post_decml;
181 ret_type = magn_state->rot_attr.scale_precision;
182 break;
183 default:
184 ret_type = -EINVAL;
185 }
186 break;
187 case IIO_CHAN_INFO_OFFSET:
188 switch (chan->type) {
189 case IIO_MAGN:
190 *val = magn_state->magn_flux_attr.value_offset;
191 ret_type = IIO_VAL_INT;
192 break;
193 case IIO_ROT:
194 *val = magn_state->rot_attr.value_offset;
195 ret_type = IIO_VAL_INT;
196 break;
197 default:
198 ret_type = -EINVAL;
199 }
200 break;
201 case IIO_CHAN_INFO_SAMP_FREQ:
202 ret_type = hid_sensor_read_samp_freq_value(
203 &magn_state->magn_flux_attributes, val, val2);
204 break;
205 case IIO_CHAN_INFO_HYSTERESIS:
206 switch (chan->type) {
207 case IIO_MAGN:
208 ret_type = hid_sensor_read_raw_hyst_value(
209 &magn_state->magn_flux_attributes, val, val2);
210 break;
211 case IIO_ROT:
212 ret_type = hid_sensor_read_raw_hyst_value(
213 &magn_state->rot_attributes, val, val2);
214 break;
215 default:
216 ret_type = -EINVAL;
217 }
218 break;
219 default:
220 ret_type = -EINVAL;
221 break;
222 }
223
224 return ret_type;
225 }
226
227 /* Channel write_raw handler */
magn_3d_write_raw(struct iio_dev * indio_dev,struct iio_chan_spec const * chan,int val,int val2,long mask)228 static int magn_3d_write_raw(struct iio_dev *indio_dev,
229 struct iio_chan_spec const *chan,
230 int val, int val2, long mask)
231 {
232 struct magn_3d_state *magn_state = iio_priv(indio_dev);
233 int ret = 0;
234
235 switch (mask) {
236 case IIO_CHAN_INFO_SAMP_FREQ:
237 ret = hid_sensor_write_samp_freq_value(
238 &magn_state->magn_flux_attributes, val, val2);
239 break;
240 case IIO_CHAN_INFO_HYSTERESIS:
241 switch (chan->type) {
242 case IIO_MAGN:
243 ret = hid_sensor_write_raw_hyst_value(
244 &magn_state->magn_flux_attributes, val, val2);
245 break;
246 case IIO_ROT:
247 ret = hid_sensor_write_raw_hyst_value(
248 &magn_state->rot_attributes, val, val2);
249 break;
250 default:
251 ret = -EINVAL;
252 }
253 break;
254 default:
255 ret = -EINVAL;
256 }
257
258 return ret;
259 }
260
261 static const struct iio_info magn_3d_info = {
262 .read_raw = &magn_3d_read_raw,
263 .write_raw = &magn_3d_write_raw,
264 };
265
266 /* Callback handler to send event after all samples are received and captured */
magn_3d_proc_event(struct hid_sensor_hub_device * hsdev,u32 usage_id,void * priv)267 static int magn_3d_proc_event(struct hid_sensor_hub_device *hsdev,
268 u32 usage_id, void *priv)
269 {
270 struct iio_dev *indio_dev = platform_get_drvdata(priv);
271 struct magn_3d_state *magn_state = iio_priv(indio_dev);
272
273 dev_dbg(&indio_dev->dev, "magn_3d_proc_event\n");
274 if (atomic_read(&magn_state->magn_flux_attributes.data_ready)) {
275 if (!magn_state->timestamp)
276 magn_state->timestamp = iio_get_time_ns(indio_dev);
277
278 iio_push_to_buffers_with_timestamp(indio_dev,
279 magn_state->iio_vals,
280 magn_state->timestamp);
281 magn_state->timestamp = 0;
282 }
283
284 return 0;
285 }
286
287 /* Capture samples in local storage */
magn_3d_capture_sample(struct hid_sensor_hub_device * hsdev,u32 usage_id,size_t raw_len,char * raw_data,void * priv)288 static int magn_3d_capture_sample(struct hid_sensor_hub_device *hsdev,
289 u32 usage_id,
290 size_t raw_len, char *raw_data,
291 void *priv)
292 {
293 struct iio_dev *indio_dev = platform_get_drvdata(priv);
294 struct magn_3d_state *magn_state = iio_priv(indio_dev);
295 int offset;
296 int ret = 0;
297 u32 *iio_val = NULL;
298
299 switch (usage_id) {
300 case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS:
301 case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Y_AXIS:
302 case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Z_AXIS:
303 offset = (usage_id - HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS)
304 + CHANNEL_SCAN_INDEX_X;
305 break;
306 case HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH:
307 case HID_USAGE_SENSOR_ORIENT_COMP_TRUE_NORTH:
308 case HID_USAGE_SENSOR_ORIENT_MAGN_NORTH:
309 case HID_USAGE_SENSOR_ORIENT_TRUE_NORTH:
310 offset = (usage_id - HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH)
311 + CHANNEL_SCAN_INDEX_NORTH_MAGN_TILT_COMP;
312 break;
313 case HID_USAGE_SENSOR_TIME_TIMESTAMP:
314 magn_state->timestamp =
315 hid_sensor_convert_timestamp(&magn_state->magn_flux_attributes,
316 *(s64 *)raw_data);
317 return ret;
318 default:
319 return -EINVAL;
320 }
321
322 iio_val = magn_state->magn_val_addr[offset];
323
324 if (iio_val)
325 *iio_val = *((u32 *)raw_data);
326 else
327 ret = -EINVAL;
328
329 return ret;
330 }
331
332 /* Parse report which is specific to an usage id*/
magn_3d_parse_report(struct platform_device * pdev,struct hid_sensor_hub_device * hsdev,struct iio_chan_spec ** channels,int * chan_count,u32 usage_id,struct magn_3d_state * st)333 static int magn_3d_parse_report(struct platform_device *pdev,
334 struct hid_sensor_hub_device *hsdev,
335 struct iio_chan_spec **channels,
336 int *chan_count,
337 u32 usage_id,
338 struct magn_3d_state *st)
339 {
340 int i;
341 int attr_count = 0;
342 struct iio_chan_spec *_channels;
343
344 /* Scan for each usage attribute supported */
345 for (i = 0; i < MAGN_3D_CHANNEL_MAX; i++) {
346 int status;
347 u32 address = magn_3d_addresses[i];
348
349 /* Check if usage attribute exists in the sensor hub device */
350 status = sensor_hub_input_get_attribute_info(hsdev,
351 HID_INPUT_REPORT,
352 usage_id,
353 address,
354 &(st->magn[i]));
355 if (!status)
356 attr_count++;
357 }
358
359 if (attr_count <= 0) {
360 dev_err(&pdev->dev,
361 "failed to find any supported usage attributes in report\n");
362 return -EINVAL;
363 }
364
365 dev_dbg(&pdev->dev, "magn_3d Found %d usage attributes\n", attr_count);
366 dev_dbg(&pdev->dev, "magn_3d X: %x:%x Y: %x:%x Z: %x:%x\n",
367 st->magn[0].index,
368 st->magn[0].report_id,
369 st->magn[1].index, st->magn[1].report_id,
370 st->magn[2].index, st->magn[2].report_id);
371
372 /* Setup IIO channel array */
373 _channels = devm_kcalloc(&pdev->dev, attr_count,
374 sizeof(struct iio_chan_spec),
375 GFP_KERNEL);
376 if (!_channels) {
377 dev_err(&pdev->dev,
378 "failed to allocate space for iio channels\n");
379 return -ENOMEM;
380 }
381
382 /* attr_count include timestamp channel, and the iio_vals should be aligned to 8byte */
383 st->iio_vals = devm_kcalloc(&pdev->dev,
384 ((attr_count + 1) % 2 + (attr_count + 1) / 2) * 2,
385 sizeof(u32), GFP_KERNEL);
386 if (!st->iio_vals) {
387 dev_err(&pdev->dev,
388 "failed to allocate space for iio values array\n");
389 return -ENOMEM;
390 }
391
392 for (i = 0, *chan_count = 0;
393 i < MAGN_3D_CHANNEL_MAX && *chan_count < attr_count;
394 i++){
395 if (st->magn[i].index >= 0) {
396 /* Setup IIO channel struct */
397 (_channels[*chan_count]) = magn_3d_channels[i];
398 (_channels[*chan_count]).scan_index = *chan_count;
399 (_channels[*chan_count]).address = i;
400
401 if (i != CHANNEL_SCAN_INDEX_TIMESTAMP) {
402 /* Set magn_val_addr to iio value address */
403 st->magn_val_addr[i] = &st->iio_vals[*chan_count];
404 _channels[*chan_count].scan_type = (struct iio_scan_type) {
405 .format = 's',
406 .realbits = BYTES_TO_BITS(st->magn[i].size),
407 .storagebits = BITS_PER_TYPE(u32),
408 };
409 }
410 (*chan_count)++;
411 }
412 }
413
414 if (*chan_count <= 0) {
415 dev_err(&pdev->dev,
416 "failed to find any magnetic channels setup\n");
417 return -EINVAL;
418 }
419
420 *channels = _channels;
421
422 dev_dbg(&pdev->dev, "magn_3d Setup %d IIO channels\n", *chan_count);
423
424 st->magn_flux_attr.scale_precision = hid_sensor_format_scale(
425 HID_USAGE_SENSOR_COMPASS_3D,
426 &st->magn[CHANNEL_SCAN_INDEX_X],
427 &st->magn_flux_attr.scale_pre_decml,
428 &st->magn_flux_attr.scale_post_decml);
429 st->rot_attr.scale_precision
430 = hid_sensor_format_scale(
431 HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH,
432 &st->magn[CHANNEL_SCAN_INDEX_NORTH_MAGN_TILT_COMP],
433 &st->rot_attr.scale_pre_decml,
434 &st->rot_attr.scale_post_decml);
435
436 if (st->rot_attributes.sensitivity.index < 0) {
437 sensor_hub_input_get_attribute_info(hsdev,
438 HID_FEATURE_REPORT, usage_id,
439 HID_USAGE_SENSOR_DATA_MOD_CHANGE_SENSITIVITY_ABS |
440 HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH,
441 &st->rot_attributes.sensitivity);
442 dev_dbg(&pdev->dev, "Sensitivity index:report %d:%d\n",
443 st->rot_attributes.sensitivity.index,
444 st->rot_attributes.sensitivity.report_id);
445 }
446
447 return 0;
448 }
449
450 /* Function to initialize the processing for usage id */
hid_magn_3d_probe(struct platform_device * pdev)451 static int hid_magn_3d_probe(struct platform_device *pdev)
452 {
453 struct hid_sensor_hub_device *hsdev = dev_get_platdata(&pdev->dev);
454 int ret = 0;
455 static char *name = "magn_3d";
456 struct iio_dev *indio_dev;
457 struct magn_3d_state *magn_state;
458 struct iio_chan_spec *channels;
459 int chan_count = 0;
460
461 indio_dev = devm_iio_device_alloc(&pdev->dev,
462 sizeof(struct magn_3d_state));
463 if (!indio_dev)
464 return -ENOMEM;
465
466 platform_set_drvdata(pdev, indio_dev);
467
468 magn_state = iio_priv(indio_dev);
469 magn_state->magn_flux_attributes.hsdev = hsdev;
470 magn_state->magn_flux_attributes.pdev = pdev;
471
472 ret = hid_sensor_parse_common_attributes(hsdev,
473 HID_USAGE_SENSOR_COMPASS_3D,
474 &magn_state->magn_flux_attributes,
475 magn_3d_sensitivity_addresses,
476 ARRAY_SIZE(magn_3d_sensitivity_addresses));
477 if (ret) {
478 dev_err(&pdev->dev, "failed to setup common attributes\n");
479 return ret;
480 }
481 magn_state->rot_attributes = magn_state->magn_flux_attributes;
482 /* sensitivity of rot_attribute is not the same as magn_flux_attributes */
483 magn_state->rot_attributes.sensitivity.index = -1;
484
485 ret = magn_3d_parse_report(pdev, hsdev,
486 &channels, &chan_count,
487 HID_USAGE_SENSOR_COMPASS_3D, magn_state);
488 if (ret) {
489 dev_err(&pdev->dev, "failed to parse report\n");
490 return ret;
491 }
492
493 indio_dev->channels = channels;
494 indio_dev->num_channels = chan_count;
495 indio_dev->info = &magn_3d_info;
496 indio_dev->name = name;
497 indio_dev->modes = INDIO_DIRECT_MODE;
498
499 atomic_set(&magn_state->magn_flux_attributes.data_ready, 0);
500
501 ret = hid_sensor_setup_trigger(indio_dev, name,
502 &magn_state->magn_flux_attributes);
503 if (ret < 0) {
504 dev_err(&pdev->dev, "trigger setup failed\n");
505 return ret;
506 }
507
508 magn_state->callbacks.send_event = magn_3d_proc_event;
509 magn_state->callbacks.capture_sample = magn_3d_capture_sample;
510 magn_state->callbacks.pdev = pdev;
511 ret = sensor_hub_register_callback(hsdev, HID_USAGE_SENSOR_COMPASS_3D,
512 &magn_state->callbacks);
513 if (ret < 0) {
514 dev_err(&pdev->dev, "callback reg failed\n");
515 goto error_remove_trigger;
516 }
517
518 ret = iio_device_register(indio_dev);
519 if (ret) {
520 dev_err(&pdev->dev, "device register failed\n");
521 goto error_remove_callback;
522 }
523
524 return ret;
525
526 error_remove_callback:
527 sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_COMPASS_3D);
528 error_remove_trigger:
529 hid_sensor_remove_trigger(indio_dev, &magn_state->magn_flux_attributes);
530 return ret;
531 }
532
533 /* Function to deinitialize the processing for usage id */
hid_magn_3d_remove(struct platform_device * pdev)534 static void hid_magn_3d_remove(struct platform_device *pdev)
535 {
536 struct hid_sensor_hub_device *hsdev = dev_get_platdata(&pdev->dev);
537 struct iio_dev *indio_dev = platform_get_drvdata(pdev);
538 struct magn_3d_state *magn_state = iio_priv(indio_dev);
539
540 iio_device_unregister(indio_dev);
541 sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_COMPASS_3D);
542 hid_sensor_remove_trigger(indio_dev, &magn_state->magn_flux_attributes);
543 }
544
545 static const struct platform_device_id hid_magn_3d_ids[] = {
546 {
547 /* Format: HID-SENSOR-usage_id_in_hex_lowercase */
548 .name = "HID-SENSOR-200083",
549 },
550 { }
551 };
552 MODULE_DEVICE_TABLE(platform, hid_magn_3d_ids);
553
554 static struct platform_driver hid_magn_3d_platform_driver = {
555 .id_table = hid_magn_3d_ids,
556 .driver = {
557 .name = KBUILD_MODNAME,
558 .pm = &hid_sensor_pm_ops,
559 },
560 .probe = hid_magn_3d_probe,
561 .remove = hid_magn_3d_remove,
562 };
563 module_platform_driver(hid_magn_3d_platform_driver);
564
565 MODULE_DESCRIPTION("HID Sensor Magnetometer 3D");
566 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
567 MODULE_LICENSE("GPL");
568 MODULE_IMPORT_NS("IIO_HID");
569