3 * Copyright (c) 2012, Intel Corporation.
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.
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
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.
19 #include <linux/device.h>
20 #include <linux/platform_device.h>
21 #include <linux/module.h>
22 #include <linux/interrupt.h>
23 #include <linux/irq.h>
24 #include <linux/slab.h>
25 #include <linux/delay.h>
26 #include <linux/hid-sensor-hub.h>
27 #include <linux/iio/iio.h>
28 #include <linux/iio/sysfs.h>
29 #include <linux/iio/buffer.h>
30 #include <linux/iio/trigger_consumer.h>
31 #include <linux/iio/triggered_buffer.h>
32 #include "../common/hid-sensors/hid-sensor-trigger.h"
34 enum magn_3d_channel
{
38 CHANNEL_SCAN_INDEX_NORTH_MAGN_TILT_COMP
,
39 CHANNEL_SCAN_INDEX_NORTH_TRUE_TILT_COMP
,
40 CHANNEL_SCAN_INDEX_NORTH_MAGN
,
41 CHANNEL_SCAN_INDEX_NORTH_TRUE
,
45 struct common_attributes
{
52 struct magn_3d_state
{
53 struct hid_sensor_hub_callbacks callbacks
;
54 struct hid_sensor_common magn_flux_attributes
;
55 struct hid_sensor_common rot_attributes
;
56 struct hid_sensor_hub_attribute_info magn
[MAGN_3D_CHANNEL_MAX
];
58 /* dynamically sized array to hold sensor values */
60 /* array of pointers to sensor value */
61 u32
*magn_val_addr
[MAGN_3D_CHANNEL_MAX
];
63 struct common_attributes magn_flux_attr
;
64 struct common_attributes rot_attr
;
67 static const u32 magn_3d_addresses
[MAGN_3D_CHANNEL_MAX
] = {
68 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS
,
69 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Y_AXIS
,
70 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Z_AXIS
,
71 HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH
,
72 HID_USAGE_SENSOR_ORIENT_COMP_TRUE_NORTH
,
73 HID_USAGE_SENSOR_ORIENT_MAGN_NORTH
,
74 HID_USAGE_SENSOR_ORIENT_TRUE_NORTH
,
77 /* Channel definitions */
78 static const struct iio_chan_spec magn_3d_channels
[] = {
82 .channel2
= IIO_MOD_X
,
83 .info_mask_separate
= BIT(IIO_CHAN_INFO_RAW
),
84 .info_mask_shared_by_type
= BIT(IIO_CHAN_INFO_OFFSET
) |
85 BIT(IIO_CHAN_INFO_SCALE
) |
86 BIT(IIO_CHAN_INFO_SAMP_FREQ
) |
87 BIT(IIO_CHAN_INFO_HYSTERESIS
),
91 .channel2
= IIO_MOD_Y
,
92 .info_mask_separate
= BIT(IIO_CHAN_INFO_RAW
),
93 .info_mask_shared_by_type
= BIT(IIO_CHAN_INFO_OFFSET
) |
94 BIT(IIO_CHAN_INFO_SCALE
) |
95 BIT(IIO_CHAN_INFO_SAMP_FREQ
) |
96 BIT(IIO_CHAN_INFO_HYSTERESIS
),
100 .channel2
= IIO_MOD_Z
,
101 .info_mask_separate
= BIT(IIO_CHAN_INFO_RAW
),
102 .info_mask_shared_by_type
= BIT(IIO_CHAN_INFO_OFFSET
) |
103 BIT(IIO_CHAN_INFO_SCALE
) |
104 BIT(IIO_CHAN_INFO_SAMP_FREQ
) |
105 BIT(IIO_CHAN_INFO_HYSTERESIS
),
109 .channel2
= IIO_MOD_NORTH_MAGN_TILT_COMP
,
110 .info_mask_separate
= BIT(IIO_CHAN_INFO_RAW
),
111 .info_mask_shared_by_type
= BIT(IIO_CHAN_INFO_OFFSET
) |
112 BIT(IIO_CHAN_INFO_SCALE
) |
113 BIT(IIO_CHAN_INFO_SAMP_FREQ
) |
114 BIT(IIO_CHAN_INFO_HYSTERESIS
),
118 .channel2
= IIO_MOD_NORTH_TRUE_TILT_COMP
,
119 .info_mask_separate
= BIT(IIO_CHAN_INFO_RAW
),
120 .info_mask_shared_by_type
= BIT(IIO_CHAN_INFO_OFFSET
) |
121 BIT(IIO_CHAN_INFO_SCALE
) |
122 BIT(IIO_CHAN_INFO_SAMP_FREQ
) |
123 BIT(IIO_CHAN_INFO_HYSTERESIS
),
127 .channel2
= IIO_MOD_NORTH_MAGN
,
128 .info_mask_separate
= BIT(IIO_CHAN_INFO_RAW
),
129 .info_mask_shared_by_type
= BIT(IIO_CHAN_INFO_OFFSET
) |
130 BIT(IIO_CHAN_INFO_SCALE
) |
131 BIT(IIO_CHAN_INFO_SAMP_FREQ
) |
132 BIT(IIO_CHAN_INFO_HYSTERESIS
),
136 .channel2
= IIO_MOD_NORTH_TRUE
,
137 .info_mask_separate
= BIT(IIO_CHAN_INFO_RAW
),
138 .info_mask_shared_by_type
= BIT(IIO_CHAN_INFO_OFFSET
) |
139 BIT(IIO_CHAN_INFO_SCALE
) |
140 BIT(IIO_CHAN_INFO_SAMP_FREQ
) |
141 BIT(IIO_CHAN_INFO_HYSTERESIS
),
145 /* Adjust channel real bits based on report descriptor */
146 static void magn_3d_adjust_channel_bit_mask(struct iio_chan_spec
*channels
,
147 int channel
, int size
)
149 channels
[channel
].scan_type
.sign
= 's';
150 /* Real storage bits will change based on the report desc. */
151 channels
[channel
].scan_type
.realbits
= size
* 8;
152 /* Maximum size of a sample to capture is u32 */
153 channels
[channel
].scan_type
.storagebits
= sizeof(u32
) * 8;
156 /* Channel read_raw handler */
157 static int magn_3d_read_raw(struct iio_dev
*indio_dev
,
158 struct iio_chan_spec
const *chan
,
162 struct magn_3d_state
*magn_state
= iio_priv(indio_dev
);
171 case IIO_CHAN_INFO_RAW
:
172 hid_sensor_power_state(&magn_state
->magn_flux_attributes
, true);
173 report_id
= magn_state
->magn
[chan
->address
].report_id
;
174 min
= magn_state
->magn
[chan
->address
].logical_minimum
;
175 address
= magn_3d_addresses
[chan
->address
];
177 *val
= sensor_hub_input_attr_get_raw_value(
178 magn_state
->magn_flux_attributes
.hsdev
,
179 HID_USAGE_SENSOR_COMPASS_3D
, address
,
185 hid_sensor_power_state(
186 &magn_state
->magn_flux_attributes
,
190 hid_sensor_power_state(&magn_state
->magn_flux_attributes
,
192 ret_type
= IIO_VAL_INT
;
194 case IIO_CHAN_INFO_SCALE
:
195 switch (chan
->type
) {
197 *val
= magn_state
->magn_flux_attr
.scale_pre_decml
;
198 *val2
= magn_state
->magn_flux_attr
.scale_post_decml
;
199 ret_type
= magn_state
->magn_flux_attr
.scale_precision
;
202 *val
= magn_state
->rot_attr
.scale_pre_decml
;
203 *val2
= magn_state
->rot_attr
.scale_post_decml
;
204 ret_type
= magn_state
->rot_attr
.scale_precision
;
210 case IIO_CHAN_INFO_OFFSET
:
211 switch (chan
->type
) {
213 *val
= magn_state
->magn_flux_attr
.value_offset
;
214 ret_type
= IIO_VAL_INT
;
217 *val
= magn_state
->rot_attr
.value_offset
;
218 ret_type
= IIO_VAL_INT
;
224 case IIO_CHAN_INFO_SAMP_FREQ
:
225 ret_type
= hid_sensor_read_samp_freq_value(
226 &magn_state
->magn_flux_attributes
, val
, val2
);
228 case IIO_CHAN_INFO_HYSTERESIS
:
229 switch (chan
->type
) {
231 ret_type
= hid_sensor_read_raw_hyst_value(
232 &magn_state
->magn_flux_attributes
, val
, val2
);
235 ret_type
= hid_sensor_read_raw_hyst_value(
236 &magn_state
->rot_attributes
, val
, val2
);
250 /* Channel write_raw handler */
251 static int magn_3d_write_raw(struct iio_dev
*indio_dev
,
252 struct iio_chan_spec
const *chan
,
257 struct magn_3d_state
*magn_state
= iio_priv(indio_dev
);
261 case IIO_CHAN_INFO_SAMP_FREQ
:
262 ret
= hid_sensor_write_samp_freq_value(
263 &magn_state
->magn_flux_attributes
, val
, val2
);
265 case IIO_CHAN_INFO_HYSTERESIS
:
266 switch (chan
->type
) {
268 ret
= hid_sensor_write_raw_hyst_value(
269 &magn_state
->magn_flux_attributes
, val
, val2
);
272 ret
= hid_sensor_write_raw_hyst_value(
273 &magn_state
->rot_attributes
, val
, val2
);
286 static const struct iio_info magn_3d_info
= {
287 .read_raw
= &magn_3d_read_raw
,
288 .write_raw
= &magn_3d_write_raw
,
291 /* Function to push data to buffer */
292 static void hid_sensor_push_data(struct iio_dev
*indio_dev
, const void *data
)
294 dev_dbg(&indio_dev
->dev
, "hid_sensor_push_data\n");
295 iio_push_to_buffers(indio_dev
, data
);
298 /* Callback handler to send event after all samples are received and captured */
299 static int magn_3d_proc_event(struct hid_sensor_hub_device
*hsdev
,
303 struct iio_dev
*indio_dev
= platform_get_drvdata(priv
);
304 struct magn_3d_state
*magn_state
= iio_priv(indio_dev
);
306 dev_dbg(&indio_dev
->dev
, "magn_3d_proc_event\n");
307 if (atomic_read(&magn_state
->magn_flux_attributes
.data_ready
))
308 hid_sensor_push_data(indio_dev
, magn_state
->iio_vals
);
313 /* Capture samples in local storage */
314 static int magn_3d_capture_sample(struct hid_sensor_hub_device
*hsdev
,
316 size_t raw_len
, char *raw_data
,
319 struct iio_dev
*indio_dev
= platform_get_drvdata(priv
);
320 struct magn_3d_state
*magn_state
= iio_priv(indio_dev
);
326 case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS
:
327 case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Y_AXIS
:
328 case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Z_AXIS
:
329 offset
= (usage_id
- HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS
)
330 + CHANNEL_SCAN_INDEX_X
;
332 case HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH
:
333 case HID_USAGE_SENSOR_ORIENT_COMP_TRUE_NORTH
:
334 case HID_USAGE_SENSOR_ORIENT_MAGN_NORTH
:
335 case HID_USAGE_SENSOR_ORIENT_TRUE_NORTH
:
336 offset
= (usage_id
- HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH
)
337 + CHANNEL_SCAN_INDEX_NORTH_MAGN_TILT_COMP
;
343 iio_val
= magn_state
->magn_val_addr
[offset
];
346 *iio_val
= *((u32
*)raw_data
);
353 /* Parse report which is specific to an usage id*/
354 static int magn_3d_parse_report(struct platform_device
*pdev
,
355 struct hid_sensor_hub_device
*hsdev
,
356 struct iio_chan_spec
**channels
,
359 struct magn_3d_state
*st
)
363 struct iio_chan_spec
*_channels
;
365 /* Scan for each usage attribute supported */
366 for (i
= 0; i
< MAGN_3D_CHANNEL_MAX
; i
++) {
368 u32 address
= magn_3d_addresses
[i
];
370 /* Check if usage attribute exists in the sensor hub device */
371 status
= sensor_hub_input_get_attribute_info(hsdev
,
380 if (attr_count
<= 0) {
382 "failed to find any supported usage attributes in report\n");
386 dev_dbg(&pdev
->dev
, "magn_3d Found %d usage attributes\n",
388 dev_dbg(&pdev
->dev
, "magn_3d X: %x:%x Y: %x:%x Z: %x:%x\n",
390 st
->magn
[0].report_id
,
391 st
->magn
[1].index
, st
->magn
[1].report_id
,
392 st
->magn
[2].index
, st
->magn
[2].report_id
);
394 /* Setup IIO channel array */
395 _channels
= devm_kcalloc(&pdev
->dev
, attr_count
,
396 sizeof(struct iio_chan_spec
),
400 "failed to allocate space for iio channels\n");
404 st
->iio_vals
= devm_kcalloc(&pdev
->dev
, attr_count
,
409 "failed to allocate space for iio values array\n");
413 for (i
= 0, *chan_count
= 0;
414 i
< MAGN_3D_CHANNEL_MAX
&& *chan_count
< attr_count
;
416 if (st
->magn
[i
].index
>= 0) {
417 /* Setup IIO channel struct */
418 (_channels
[*chan_count
]) = magn_3d_channels
[i
];
419 (_channels
[*chan_count
]).scan_index
= *chan_count
;
420 (_channels
[*chan_count
]).address
= i
;
422 /* Set magn_val_addr to iio value address */
423 st
->magn_val_addr
[i
] = &(st
->iio_vals
[*chan_count
]);
424 magn_3d_adjust_channel_bit_mask(_channels
,
431 if (*chan_count
<= 0) {
433 "failed to find any magnetic channels setup\n");
437 *channels
= _channels
;
439 dev_dbg(&pdev
->dev
, "magn_3d Setup %d IIO channels\n",
442 st
->magn_flux_attr
.scale_precision
= hid_sensor_format_scale(
443 HID_USAGE_SENSOR_COMPASS_3D
,
444 &st
->magn
[CHANNEL_SCAN_INDEX_X
],
445 &st
->magn_flux_attr
.scale_pre_decml
,
446 &st
->magn_flux_attr
.scale_post_decml
);
447 st
->rot_attr
.scale_precision
448 = hid_sensor_format_scale(
449 HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH
,
450 &st
->magn
[CHANNEL_SCAN_INDEX_NORTH_MAGN_TILT_COMP
],
451 &st
->rot_attr
.scale_pre_decml
,
452 &st
->rot_attr
.scale_post_decml
);
454 /* Set Sensitivity field ids, when there is no individual modifier */
455 if (st
->magn_flux_attributes
.sensitivity
.index
< 0) {
456 sensor_hub_input_get_attribute_info(hsdev
,
457 HID_FEATURE_REPORT
, usage_id
,
458 HID_USAGE_SENSOR_DATA_MOD_CHANGE_SENSITIVITY_ABS
|
459 HID_USAGE_SENSOR_DATA_ORIENTATION
,
460 &st
->magn_flux_attributes
.sensitivity
);
461 dev_dbg(&pdev
->dev
, "Sensitivity index:report %d:%d\n",
462 st
->magn_flux_attributes
.sensitivity
.index
,
463 st
->magn_flux_attributes
.sensitivity
.report_id
);
465 if (st
->magn_flux_attributes
.sensitivity
.index
< 0) {
466 sensor_hub_input_get_attribute_info(hsdev
,
467 HID_FEATURE_REPORT
, usage_id
,
468 HID_USAGE_SENSOR_DATA_MOD_CHANGE_SENSITIVITY_ABS
|
469 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX
,
470 &st
->magn_flux_attributes
.sensitivity
);
471 dev_dbg(&pdev
->dev
, "Sensitivity index:report %d:%d\n",
472 st
->magn_flux_attributes
.sensitivity
.index
,
473 st
->magn_flux_attributes
.sensitivity
.report_id
);
475 if (st
->rot_attributes
.sensitivity
.index
< 0) {
476 sensor_hub_input_get_attribute_info(hsdev
,
477 HID_FEATURE_REPORT
, usage_id
,
478 HID_USAGE_SENSOR_DATA_MOD_CHANGE_SENSITIVITY_ABS
|
479 HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH
,
480 &st
->rot_attributes
.sensitivity
);
481 dev_dbg(&pdev
->dev
, "Sensitivity index:report %d:%d\n",
482 st
->rot_attributes
.sensitivity
.index
,
483 st
->rot_attributes
.sensitivity
.report_id
);
489 /* Function to initialize the processing for usage id */
490 static int hid_magn_3d_probe(struct platform_device
*pdev
)
493 static char *name
= "magn_3d";
494 struct iio_dev
*indio_dev
;
495 struct magn_3d_state
*magn_state
;
496 struct hid_sensor_hub_device
*hsdev
= pdev
->dev
.platform_data
;
497 struct iio_chan_spec
*channels
;
500 indio_dev
= devm_iio_device_alloc(&pdev
->dev
,
501 sizeof(struct magn_3d_state
));
502 if (indio_dev
== NULL
)
505 platform_set_drvdata(pdev
, indio_dev
);
507 magn_state
= iio_priv(indio_dev
);
508 magn_state
->magn_flux_attributes
.hsdev
= hsdev
;
509 magn_state
->magn_flux_attributes
.pdev
= pdev
;
511 ret
= hid_sensor_parse_common_attributes(hsdev
,
512 HID_USAGE_SENSOR_COMPASS_3D
,
513 &magn_state
->magn_flux_attributes
);
515 dev_err(&pdev
->dev
, "failed to setup common attributes\n");
518 magn_state
->rot_attributes
= magn_state
->magn_flux_attributes
;
520 ret
= magn_3d_parse_report(pdev
, hsdev
,
521 &channels
, &chan_count
,
522 HID_USAGE_SENSOR_COMPASS_3D
, magn_state
);
524 dev_err(&pdev
->dev
, "failed to parse report\n");
528 indio_dev
->channels
= channels
;
529 indio_dev
->num_channels
= chan_count
;
530 indio_dev
->dev
.parent
= &pdev
->dev
;
531 indio_dev
->info
= &magn_3d_info
;
532 indio_dev
->name
= name
;
533 indio_dev
->modes
= INDIO_DIRECT_MODE
;
535 ret
= iio_triggered_buffer_setup(indio_dev
, &iio_pollfunc_store_time
,
538 dev_err(&pdev
->dev
, "failed to initialize trigger buffer\n");
541 atomic_set(&magn_state
->magn_flux_attributes
.data_ready
, 0);
542 ret
= hid_sensor_setup_trigger(indio_dev
, name
,
543 &magn_state
->magn_flux_attributes
);
545 dev_err(&pdev
->dev
, "trigger setup failed\n");
546 goto error_unreg_buffer_funcs
;
549 ret
= iio_device_register(indio_dev
);
551 dev_err(&pdev
->dev
, "device register failed\n");
552 goto error_remove_trigger
;
555 magn_state
->callbacks
.send_event
= magn_3d_proc_event
;
556 magn_state
->callbacks
.capture_sample
= magn_3d_capture_sample
;
557 magn_state
->callbacks
.pdev
= pdev
;
558 ret
= sensor_hub_register_callback(hsdev
, HID_USAGE_SENSOR_COMPASS_3D
,
559 &magn_state
->callbacks
);
561 dev_err(&pdev
->dev
, "callback reg failed\n");
562 goto error_iio_unreg
;
568 iio_device_unregister(indio_dev
);
569 error_remove_trigger
:
570 hid_sensor_remove_trigger(&magn_state
->magn_flux_attributes
);
571 error_unreg_buffer_funcs
:
572 iio_triggered_buffer_cleanup(indio_dev
);
576 /* Function to deinitialize the processing for usage id */
577 static int hid_magn_3d_remove(struct platform_device
*pdev
)
579 struct hid_sensor_hub_device
*hsdev
= pdev
->dev
.platform_data
;
580 struct iio_dev
*indio_dev
= platform_get_drvdata(pdev
);
581 struct magn_3d_state
*magn_state
= iio_priv(indio_dev
);
583 sensor_hub_remove_callback(hsdev
, HID_USAGE_SENSOR_COMPASS_3D
);
584 iio_device_unregister(indio_dev
);
585 hid_sensor_remove_trigger(&magn_state
->magn_flux_attributes
);
586 iio_triggered_buffer_cleanup(indio_dev
);
591 static const struct platform_device_id hid_magn_3d_ids
[] = {
593 /* Format: HID-SENSOR-usage_id_in_hex_lowercase */
594 .name
= "HID-SENSOR-200083",
598 MODULE_DEVICE_TABLE(platform
, hid_magn_3d_ids
);
600 static struct platform_driver hid_magn_3d_platform_driver
= {
601 .id_table
= hid_magn_3d_ids
,
603 .name
= KBUILD_MODNAME
,
604 .pm
= &hid_sensor_pm_ops
,
606 .probe
= hid_magn_3d_probe
,
607 .remove
= hid_magn_3d_remove
,
609 module_platform_driver(hid_magn_3d_platform_driver
);
611 MODULE_DESCRIPTION("HID Sensor Magnetometer 3D");
612 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
613 MODULE_LICENSE("GPL");