1 // SPDX-License-Identifier: GPL-2.0-only
4 * Copyright (c) 2012, Intel Corporation.
6 #include <linux/device.h>
7 #include <linux/platform_device.h>
8 #include <linux/module.h>
9 #include <linux/interrupt.h>
10 #include <linux/irq.h>
11 #include <linux/slab.h>
12 #include <linux/delay.h>
13 #include <linux/hid-sensor-hub.h>
14 #include <linux/iio/iio.h>
15 #include <linux/iio/sysfs.h>
16 #include <linux/iio/buffer.h>
17 #include "../common/hid-sensors/hid-sensor-trigger.h"
19 enum magn_3d_channel {
23 CHANNEL_SCAN_INDEX_NORTH_MAGN_TILT_COMP,
24 CHANNEL_SCAN_INDEX_NORTH_TRUE_TILT_COMP,
25 CHANNEL_SCAN_INDEX_NORTH_MAGN,
26 CHANNEL_SCAN_INDEX_NORTH_TRUE,
27 CHANNEL_SCAN_INDEX_TIMESTAMP,
31 struct common_attributes {
38 struct magn_3d_state {
39 struct hid_sensor_hub_callbacks callbacks;
40 struct hid_sensor_common magn_flux_attributes;
41 struct hid_sensor_common rot_attributes;
42 struct hid_sensor_hub_attribute_info magn[MAGN_3D_CHANNEL_MAX];
44 /* dynamically sized array to hold sensor values */
46 /* array of pointers to sensor value */
47 u32 *magn_val_addr[MAGN_3D_CHANNEL_MAX];
49 struct common_attributes magn_flux_attr;
50 struct common_attributes rot_attr;
54 static const u32 magn_3d_addresses[MAGN_3D_CHANNEL_MAX] = {
55 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS,
56 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Y_AXIS,
57 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Z_AXIS,
58 HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH,
59 HID_USAGE_SENSOR_ORIENT_COMP_TRUE_NORTH,
60 HID_USAGE_SENSOR_ORIENT_MAGN_NORTH,
61 HID_USAGE_SENSOR_ORIENT_TRUE_NORTH,
62 HID_USAGE_SENSOR_TIME_TIMESTAMP,
65 /* Channel definitions */
66 static const struct iio_chan_spec magn_3d_channels[] = {
70 .channel2 = IIO_MOD_X,
71 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
72 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
73 BIT(IIO_CHAN_INFO_SCALE) |
74 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
75 BIT(IIO_CHAN_INFO_HYSTERESIS),
79 .channel2 = IIO_MOD_Y,
80 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
81 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
82 BIT(IIO_CHAN_INFO_SCALE) |
83 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
84 BIT(IIO_CHAN_INFO_HYSTERESIS),
88 .channel2 = IIO_MOD_Z,
89 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
90 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
91 BIT(IIO_CHAN_INFO_SCALE) |
92 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
93 BIT(IIO_CHAN_INFO_HYSTERESIS),
97 .channel2 = IIO_MOD_NORTH_MAGN_TILT_COMP,
98 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
99 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
100 BIT(IIO_CHAN_INFO_SCALE) |
101 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
102 BIT(IIO_CHAN_INFO_HYSTERESIS),
106 .channel2 = IIO_MOD_NORTH_TRUE_TILT_COMP,
107 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
108 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
109 BIT(IIO_CHAN_INFO_SCALE) |
110 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
111 BIT(IIO_CHAN_INFO_HYSTERESIS),
115 .channel2 = IIO_MOD_NORTH_MAGN,
116 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
117 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
118 BIT(IIO_CHAN_INFO_SCALE) |
119 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
120 BIT(IIO_CHAN_INFO_HYSTERESIS),
124 .channel2 = IIO_MOD_NORTH_TRUE,
125 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
126 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
127 BIT(IIO_CHAN_INFO_SCALE) |
128 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
129 BIT(IIO_CHAN_INFO_HYSTERESIS),
131 IIO_CHAN_SOFT_TIMESTAMP(7)
134 /* Adjust channel real bits based on report descriptor */
135 static void magn_3d_adjust_channel_bit_mask(struct iio_chan_spec *channels,
136 int channel, int size)
138 channels[channel].scan_type.sign = 's';
139 /* Real storage bits will change based on the report desc. */
140 channels[channel].scan_type.realbits = size * 8;
141 /* Maximum size of a sample to capture is u32 */
142 channels[channel].scan_type.storagebits = sizeof(u32) * 8;
145 /* Channel read_raw handler */
146 static int magn_3d_read_raw(struct iio_dev *indio_dev,
147 struct iio_chan_spec const *chan,
151 struct magn_3d_state *magn_state = iio_priv(indio_dev);
160 case IIO_CHAN_INFO_RAW:
161 hid_sensor_power_state(&magn_state->magn_flux_attributes, true);
162 report_id = magn_state->magn[chan->address].report_id;
163 min = magn_state->magn[chan->address].logical_minimum;
164 address = magn_3d_addresses[chan->address];
166 *val = sensor_hub_input_attr_get_raw_value(
167 magn_state->magn_flux_attributes.hsdev,
168 HID_USAGE_SENSOR_COMPASS_3D, address,
174 hid_sensor_power_state(
175 &magn_state->magn_flux_attributes,
179 hid_sensor_power_state(&magn_state->magn_flux_attributes,
181 ret_type = IIO_VAL_INT;
183 case IIO_CHAN_INFO_SCALE:
184 switch (chan->type) {
186 *val = magn_state->magn_flux_attr.scale_pre_decml;
187 *val2 = magn_state->magn_flux_attr.scale_post_decml;
188 ret_type = magn_state->magn_flux_attr.scale_precision;
191 *val = magn_state->rot_attr.scale_pre_decml;
192 *val2 = magn_state->rot_attr.scale_post_decml;
193 ret_type = magn_state->rot_attr.scale_precision;
199 case IIO_CHAN_INFO_OFFSET:
200 switch (chan->type) {
202 *val = magn_state->magn_flux_attr.value_offset;
203 ret_type = IIO_VAL_INT;
206 *val = magn_state->rot_attr.value_offset;
207 ret_type = IIO_VAL_INT;
213 case IIO_CHAN_INFO_SAMP_FREQ:
214 ret_type = hid_sensor_read_samp_freq_value(
215 &magn_state->magn_flux_attributes, val, val2);
217 case IIO_CHAN_INFO_HYSTERESIS:
218 switch (chan->type) {
220 ret_type = hid_sensor_read_raw_hyst_value(
221 &magn_state->magn_flux_attributes, val, val2);
224 ret_type = hid_sensor_read_raw_hyst_value(
225 &magn_state->rot_attributes, val, val2);
239 /* Channel write_raw handler */
240 static int magn_3d_write_raw(struct iio_dev *indio_dev,
241 struct iio_chan_spec const *chan,
246 struct magn_3d_state *magn_state = iio_priv(indio_dev);
250 case IIO_CHAN_INFO_SAMP_FREQ:
251 ret = hid_sensor_write_samp_freq_value(
252 &magn_state->magn_flux_attributes, val, val2);
254 case IIO_CHAN_INFO_HYSTERESIS:
255 switch (chan->type) {
257 ret = hid_sensor_write_raw_hyst_value(
258 &magn_state->magn_flux_attributes, val, val2);
261 ret = hid_sensor_write_raw_hyst_value(
262 &magn_state->rot_attributes, val, val2);
275 static const struct iio_info magn_3d_info = {
276 .read_raw = &magn_3d_read_raw,
277 .write_raw = &magn_3d_write_raw,
280 /* Callback handler to send event after all samples are received and captured */
281 static int magn_3d_proc_event(struct hid_sensor_hub_device *hsdev,
285 struct iio_dev *indio_dev = platform_get_drvdata(priv);
286 struct magn_3d_state *magn_state = iio_priv(indio_dev);
288 dev_dbg(&indio_dev->dev, "magn_3d_proc_event\n");
289 if (atomic_read(&magn_state->magn_flux_attributes.data_ready)) {
290 if (!magn_state->timestamp)
291 magn_state->timestamp = iio_get_time_ns(indio_dev);
293 iio_push_to_buffers_with_timestamp(indio_dev,
294 magn_state->iio_vals,
295 magn_state->timestamp);
296 magn_state->timestamp = 0;
302 /* Capture samples in local storage */
303 static int magn_3d_capture_sample(struct hid_sensor_hub_device *hsdev,
305 size_t raw_len, char *raw_data,
308 struct iio_dev *indio_dev = platform_get_drvdata(priv);
309 struct magn_3d_state *magn_state = iio_priv(indio_dev);
315 case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS:
316 case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Y_AXIS:
317 case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Z_AXIS:
318 offset = (usage_id - HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS)
319 + CHANNEL_SCAN_INDEX_X;
321 case HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH:
322 case HID_USAGE_SENSOR_ORIENT_COMP_TRUE_NORTH:
323 case HID_USAGE_SENSOR_ORIENT_MAGN_NORTH:
324 case HID_USAGE_SENSOR_ORIENT_TRUE_NORTH:
325 offset = (usage_id - HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH)
326 + CHANNEL_SCAN_INDEX_NORTH_MAGN_TILT_COMP;
328 case HID_USAGE_SENSOR_TIME_TIMESTAMP:
329 magn_state->timestamp =
330 hid_sensor_convert_timestamp(&magn_state->magn_flux_attributes,
337 iio_val = magn_state->magn_val_addr[offset];
340 *iio_val = *((u32 *)raw_data);
347 /* Parse report which is specific to an usage id*/
348 static int magn_3d_parse_report(struct platform_device *pdev,
349 struct hid_sensor_hub_device *hsdev,
350 struct iio_chan_spec **channels,
353 struct magn_3d_state *st)
357 struct iio_chan_spec *_channels;
359 /* Scan for each usage attribute supported */
360 for (i = 0; i < MAGN_3D_CHANNEL_MAX; i++) {
362 u32 address = magn_3d_addresses[i];
364 /* Check if usage attribute exists in the sensor hub device */
365 status = sensor_hub_input_get_attribute_info(hsdev,
374 if (attr_count <= 0) {
376 "failed to find any supported usage attributes in report\n");
380 dev_dbg(&pdev->dev, "magn_3d Found %d usage attributes\n",
382 dev_dbg(&pdev->dev, "magn_3d X: %x:%x Y: %x:%x Z: %x:%x\n",
384 st->magn[0].report_id,
385 st->magn[1].index, st->magn[1].report_id,
386 st->magn[2].index, st->magn[2].report_id);
388 /* Setup IIO channel array */
389 _channels = devm_kcalloc(&pdev->dev, attr_count,
390 sizeof(struct iio_chan_spec),
394 "failed to allocate space for iio channels\n");
398 /* attr_count include timestamp channel, and the iio_vals should be aligned to 8byte */
399 st->iio_vals = devm_kcalloc(&pdev->dev,
400 ((attr_count + 1) % 2 + (attr_count + 1) / 2) * 2,
401 sizeof(u32), GFP_KERNEL);
404 "failed to allocate space for iio values array\n");
408 for (i = 0, *chan_count = 0;
409 i < MAGN_3D_CHANNEL_MAX && *chan_count < attr_count;
411 if (st->magn[i].index >= 0) {
412 /* Setup IIO channel struct */
413 (_channels[*chan_count]) = magn_3d_channels[i];
414 (_channels[*chan_count]).scan_index = *chan_count;
415 (_channels[*chan_count]).address = i;
417 if (i != CHANNEL_SCAN_INDEX_TIMESTAMP) {
418 /* Set magn_val_addr to iio value address */
419 st->magn_val_addr[i] = &st->iio_vals[*chan_count];
420 magn_3d_adjust_channel_bit_mask(_channels,
428 if (*chan_count <= 0) {
430 "failed to find any magnetic channels setup\n");
434 *channels = _channels;
436 dev_dbg(&pdev->dev, "magn_3d Setup %d IIO channels\n",
439 st->magn_flux_attr.scale_precision = hid_sensor_format_scale(
440 HID_USAGE_SENSOR_COMPASS_3D,
441 &st->magn[CHANNEL_SCAN_INDEX_X],
442 &st->magn_flux_attr.scale_pre_decml,
443 &st->magn_flux_attr.scale_post_decml);
444 st->rot_attr.scale_precision
445 = hid_sensor_format_scale(
446 HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH,
447 &st->magn[CHANNEL_SCAN_INDEX_NORTH_MAGN_TILT_COMP],
448 &st->rot_attr.scale_pre_decml,
449 &st->rot_attr.scale_post_decml);
451 /* Set Sensitivity field ids, when there is no individual modifier */
452 if (st->magn_flux_attributes.sensitivity.index < 0) {
453 sensor_hub_input_get_attribute_info(hsdev,
454 HID_FEATURE_REPORT, usage_id,
455 HID_USAGE_SENSOR_DATA_MOD_CHANGE_SENSITIVITY_ABS |
456 HID_USAGE_SENSOR_DATA_ORIENTATION,
457 &st->magn_flux_attributes.sensitivity);
458 dev_dbg(&pdev->dev, "Sensitivity index:report %d:%d\n",
459 st->magn_flux_attributes.sensitivity.index,
460 st->magn_flux_attributes.sensitivity.report_id);
462 if (st->magn_flux_attributes.sensitivity.index < 0) {
463 sensor_hub_input_get_attribute_info(hsdev,
464 HID_FEATURE_REPORT, usage_id,
465 HID_USAGE_SENSOR_DATA_MOD_CHANGE_SENSITIVITY_ABS |
466 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX,
467 &st->magn_flux_attributes.sensitivity);
468 dev_dbg(&pdev->dev, "Sensitivity index:report %d:%d\n",
469 st->magn_flux_attributes.sensitivity.index,
470 st->magn_flux_attributes.sensitivity.report_id);
472 if (st->rot_attributes.sensitivity.index < 0) {
473 sensor_hub_input_get_attribute_info(hsdev,
474 HID_FEATURE_REPORT, usage_id,
475 HID_USAGE_SENSOR_DATA_MOD_CHANGE_SENSITIVITY_ABS |
476 HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH,
477 &st->rot_attributes.sensitivity);
478 dev_dbg(&pdev->dev, "Sensitivity index:report %d:%d\n",
479 st->rot_attributes.sensitivity.index,
480 st->rot_attributes.sensitivity.report_id);
486 /* Function to initialize the processing for usage id */
487 static int hid_magn_3d_probe(struct platform_device *pdev)
490 static char *name = "magn_3d";
491 struct iio_dev *indio_dev;
492 struct magn_3d_state *magn_state;
493 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
494 struct iio_chan_spec *channels;
497 indio_dev = devm_iio_device_alloc(&pdev->dev,
498 sizeof(struct magn_3d_state));
499 if (indio_dev == NULL)
502 platform_set_drvdata(pdev, indio_dev);
504 magn_state = iio_priv(indio_dev);
505 magn_state->magn_flux_attributes.hsdev = hsdev;
506 magn_state->magn_flux_attributes.pdev = pdev;
508 ret = hid_sensor_parse_common_attributes(hsdev,
509 HID_USAGE_SENSOR_COMPASS_3D,
510 &magn_state->magn_flux_attributes);
512 dev_err(&pdev->dev, "failed to setup common attributes\n");
515 magn_state->rot_attributes = magn_state->magn_flux_attributes;
517 ret = magn_3d_parse_report(pdev, hsdev,
518 &channels, &chan_count,
519 HID_USAGE_SENSOR_COMPASS_3D, magn_state);
521 dev_err(&pdev->dev, "failed to parse report\n");
525 indio_dev->channels = channels;
526 indio_dev->num_channels = chan_count;
527 indio_dev->info = &magn_3d_info;
528 indio_dev->name = name;
529 indio_dev->modes = INDIO_DIRECT_MODE;
531 atomic_set(&magn_state->magn_flux_attributes.data_ready, 0);
533 ret = hid_sensor_setup_trigger(indio_dev, name,
534 &magn_state->magn_flux_attributes);
536 dev_err(&pdev->dev, "trigger setup failed\n");
540 ret = iio_device_register(indio_dev);
542 dev_err(&pdev->dev, "device register failed\n");
543 goto error_remove_trigger;
546 magn_state->callbacks.send_event = magn_3d_proc_event;
547 magn_state->callbacks.capture_sample = magn_3d_capture_sample;
548 magn_state->callbacks.pdev = pdev;
549 ret = sensor_hub_register_callback(hsdev, HID_USAGE_SENSOR_COMPASS_3D,
550 &magn_state->callbacks);
552 dev_err(&pdev->dev, "callback reg failed\n");
553 goto error_iio_unreg;
559 iio_device_unregister(indio_dev);
560 error_remove_trigger:
561 hid_sensor_remove_trigger(indio_dev, &magn_state->magn_flux_attributes);
565 /* Function to deinitialize the processing for usage id */
566 static int hid_magn_3d_remove(struct platform_device *pdev)
568 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
569 struct iio_dev *indio_dev = platform_get_drvdata(pdev);
570 struct magn_3d_state *magn_state = iio_priv(indio_dev);
572 sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_COMPASS_3D);
573 iio_device_unregister(indio_dev);
574 hid_sensor_remove_trigger(indio_dev, &magn_state->magn_flux_attributes);
579 static const struct platform_device_id hid_magn_3d_ids[] = {
581 /* Format: HID-SENSOR-usage_id_in_hex_lowercase */
582 .name = "HID-SENSOR-200083",
586 MODULE_DEVICE_TABLE(platform, hid_magn_3d_ids);
588 static struct platform_driver hid_magn_3d_platform_driver = {
589 .id_table = hid_magn_3d_ids,
591 .name = KBUILD_MODNAME,
592 .pm = &hid_sensor_pm_ops,
594 .probe = hid_magn_3d_probe,
595 .remove = hid_magn_3d_remove,
597 module_platform_driver(hid_magn_3d_platform_driver);
599 MODULE_DESCRIPTION("HID Sensor Magnetometer 3D");
600 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
601 MODULE_LICENSE("GPL");