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 magn_3d_state {
46 struct hid_sensor_hub_callbacks callbacks;
47 struct hid_sensor_common common_attributes;
48 struct hid_sensor_hub_attribute_info magn[MAGN_3D_CHANNEL_MAX];
50 /* dynamically sized array to hold sensor values */
52 /* array of pointers to sensor value */
53 u32 *magn_val_addr[MAGN_3D_CHANNEL_MAX];
61 static const u32 magn_3d_addresses[MAGN_3D_CHANNEL_MAX] = {
62 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS,
63 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Y_AXIS,
64 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Z_AXIS,
65 HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH,
66 HID_USAGE_SENSOR_ORIENT_COMP_TRUE_NORTH,
67 HID_USAGE_SENSOR_ORIENT_MAGN_NORTH,
68 HID_USAGE_SENSOR_ORIENT_TRUE_NORTH,
71 /* Channel definitions */
72 static const struct iio_chan_spec magn_3d_channels[] = {
76 .channel2 = IIO_MOD_X,
77 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
78 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
79 BIT(IIO_CHAN_INFO_SCALE) |
80 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
81 BIT(IIO_CHAN_INFO_HYSTERESIS),
85 .channel2 = IIO_MOD_Y,
86 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
87 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
88 BIT(IIO_CHAN_INFO_SCALE) |
89 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
90 BIT(IIO_CHAN_INFO_HYSTERESIS),
94 .channel2 = IIO_MOD_Z,
95 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
96 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
97 BIT(IIO_CHAN_INFO_SCALE) |
98 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
99 BIT(IIO_CHAN_INFO_HYSTERESIS),
103 .channel2 = IIO_MOD_NORTH_MAGN_TILT_COMP,
104 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
105 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
106 BIT(IIO_CHAN_INFO_SCALE) |
107 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
108 BIT(IIO_CHAN_INFO_HYSTERESIS),
112 .channel2 = IIO_MOD_NORTH_TRUE_TILT_COMP,
113 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
114 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
115 BIT(IIO_CHAN_INFO_SCALE) |
116 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
117 BIT(IIO_CHAN_INFO_HYSTERESIS),
121 .channel2 = IIO_MOD_NORTH_MAGN,
122 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
123 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
124 BIT(IIO_CHAN_INFO_SCALE) |
125 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
126 BIT(IIO_CHAN_INFO_HYSTERESIS),
130 .channel2 = IIO_MOD_NORTH_TRUE,
131 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
132 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
133 BIT(IIO_CHAN_INFO_SCALE) |
134 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
135 BIT(IIO_CHAN_INFO_HYSTERESIS),
139 /* Adjust channel real bits based on report descriptor */
140 static void magn_3d_adjust_channel_bit_mask(struct iio_chan_spec *channels,
141 int channel, int size)
143 channels[channel].scan_type.sign = 's';
144 /* Real storage bits will change based on the report desc. */
145 channels[channel].scan_type.realbits = size * 8;
146 /* Maximum size of a sample to capture is u32 */
147 channels[channel].scan_type.storagebits = sizeof(u32) * 8;
150 /* Channel read_raw handler */
151 static int magn_3d_read_raw(struct iio_dev *indio_dev,
152 struct iio_chan_spec const *chan,
156 struct magn_3d_state *magn_state = iio_priv(indio_dev);
165 hid_sensor_power_state(&magn_state->common_attributes, true);
167 magn_state->magn[chan->address].report_id;
168 address = magn_3d_addresses[chan->address];
170 *val = sensor_hub_input_attr_get_raw_value(
171 magn_state->common_attributes.hsdev,
172 HID_USAGE_SENSOR_COMPASS_3D, address,
176 hid_sensor_power_state(&magn_state->common_attributes,
180 hid_sensor_power_state(&magn_state->common_attributes, false);
181 ret_type = IIO_VAL_INT;
183 case IIO_CHAN_INFO_SCALE:
184 *val = magn_state->scale_pre_decml;
185 *val2 = magn_state->scale_post_decml;
186 ret_type = magn_state->scale_precision;
188 case IIO_CHAN_INFO_OFFSET:
189 *val = magn_state->value_offset;
190 ret_type = IIO_VAL_INT;
192 case IIO_CHAN_INFO_SAMP_FREQ:
193 ret_type = hid_sensor_read_samp_freq_value(
194 &magn_state->common_attributes, val, val2);
196 case IIO_CHAN_INFO_HYSTERESIS:
197 ret_type = hid_sensor_read_raw_hyst_value(
198 &magn_state->common_attributes, val, val2);
208 /* Channel write_raw handler */
209 static int magn_3d_write_raw(struct iio_dev *indio_dev,
210 struct iio_chan_spec const *chan,
215 struct magn_3d_state *magn_state = iio_priv(indio_dev);
219 case IIO_CHAN_INFO_SAMP_FREQ:
220 ret = hid_sensor_write_samp_freq_value(
221 &magn_state->common_attributes, val, val2);
223 case IIO_CHAN_INFO_HYSTERESIS:
224 ret = hid_sensor_write_raw_hyst_value(
225 &magn_state->common_attributes, val, val2);
234 static const struct iio_info magn_3d_info = {
235 .driver_module = THIS_MODULE,
236 .read_raw = &magn_3d_read_raw,
237 .write_raw = &magn_3d_write_raw,
240 /* Function to push data to buffer */
241 static void hid_sensor_push_data(struct iio_dev *indio_dev, const void *data)
243 dev_dbg(&indio_dev->dev, "hid_sensor_push_data\n");
244 iio_push_to_buffers(indio_dev, data);
247 /* Callback handler to send event after all samples are received and captured */
248 static int magn_3d_proc_event(struct hid_sensor_hub_device *hsdev,
252 struct iio_dev *indio_dev = platform_get_drvdata(priv);
253 struct magn_3d_state *magn_state = iio_priv(indio_dev);
255 dev_dbg(&indio_dev->dev, "magn_3d_proc_event\n");
256 if (atomic_read(&magn_state->common_attributes.data_ready))
257 hid_sensor_push_data(indio_dev, magn_state->iio_vals);
262 /* Capture samples in local storage */
263 static int magn_3d_capture_sample(struct hid_sensor_hub_device *hsdev,
265 size_t raw_len, char *raw_data,
268 struct iio_dev *indio_dev = platform_get_drvdata(priv);
269 struct magn_3d_state *magn_state = iio_priv(indio_dev);
275 case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS:
276 case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Y_AXIS:
277 case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Z_AXIS:
278 offset = (usage_id - HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS)
279 + CHANNEL_SCAN_INDEX_X;
281 case HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH:
282 case HID_USAGE_SENSOR_ORIENT_COMP_TRUE_NORTH:
283 case HID_USAGE_SENSOR_ORIENT_MAGN_NORTH:
284 case HID_USAGE_SENSOR_ORIENT_TRUE_NORTH:
285 offset = (usage_id - HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH)
286 + CHANNEL_SCAN_INDEX_NORTH_MAGN_TILT_COMP;
292 iio_val = magn_state->magn_val_addr[offset];
295 *iio_val = *((u32 *)raw_data);
302 /* Parse report which is specific to an usage id*/
303 static int magn_3d_parse_report(struct platform_device *pdev,
304 struct hid_sensor_hub_device *hsdev,
305 struct iio_chan_spec **channels,
308 struct magn_3d_state *st)
312 struct iio_chan_spec *_channels;
314 /* Scan for each usage attribute supported */
315 for (i = 0; i < MAGN_3D_CHANNEL_MAX; i++) {
317 u32 address = magn_3d_addresses[i];
319 /* Check if usage attribute exists in the sensor hub device */
320 status = sensor_hub_input_get_attribute_info(hsdev,
329 if (attr_count <= 0) {
331 "failed to find any supported usage attributes in report\n");
335 dev_dbg(&pdev->dev, "magn_3d Found %d usage attributes\n",
337 dev_dbg(&pdev->dev, "magn_3d X: %x:%x Y: %x:%x Z: %x:%x\n",
339 st->magn[0].report_id,
340 st->magn[1].index, st->magn[1].report_id,
341 st->magn[2].index, st->magn[2].report_id);
343 /* Setup IIO channel array */
344 _channels = devm_kcalloc(&pdev->dev, attr_count,
345 sizeof(struct iio_chan_spec),
349 "failed to allocate space for iio channels\n");
353 st->iio_vals = devm_kcalloc(&pdev->dev, attr_count,
358 "failed to allocate space for iio values array\n");
362 for (i = 0, *chan_count = 0;
363 i < MAGN_3D_CHANNEL_MAX && *chan_count < attr_count;
365 if (st->magn[i].index >= 0) {
366 /* Setup IIO channel struct */
367 (_channels[*chan_count]) = magn_3d_channels[i];
368 (_channels[*chan_count]).scan_index = *chan_count;
369 (_channels[*chan_count]).address = i;
371 /* Set magn_val_addr to iio value address */
372 st->magn_val_addr[i] = &(st->iio_vals[*chan_count]);
373 magn_3d_adjust_channel_bit_mask(_channels,
380 if (*chan_count <= 0) {
382 "failed to find any magnetic channels setup\n");
386 *channels = _channels;
388 dev_dbg(&pdev->dev, "magn_3d Setup %d IIO channels\n",
391 st->scale_precision = hid_sensor_format_scale(
392 HID_USAGE_SENSOR_COMPASS_3D,
393 &st->magn[CHANNEL_SCAN_INDEX_X],
394 &st->scale_pre_decml, &st->scale_post_decml);
396 /* Set Sensitivity field ids, when there is no individual modifier */
397 if (st->common_attributes.sensitivity.index < 0) {
398 sensor_hub_input_get_attribute_info(hsdev,
399 HID_FEATURE_REPORT, usage_id,
400 HID_USAGE_SENSOR_DATA_MOD_CHANGE_SENSITIVITY_ABS |
401 HID_USAGE_SENSOR_DATA_ORIENTATION,
402 &st->common_attributes.sensitivity);
403 dev_dbg(&pdev->dev, "Sensitivity index:report %d:%d\n",
404 st->common_attributes.sensitivity.index,
405 st->common_attributes.sensitivity.report_id);
411 /* Function to initialize the processing for usage id */
412 static int hid_magn_3d_probe(struct platform_device *pdev)
415 static char *name = "magn_3d";
416 struct iio_dev *indio_dev;
417 struct magn_3d_state *magn_state;
418 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
419 struct iio_chan_spec *channels;
422 indio_dev = devm_iio_device_alloc(&pdev->dev,
423 sizeof(struct magn_3d_state));
424 if (indio_dev == NULL)
427 platform_set_drvdata(pdev, indio_dev);
429 magn_state = iio_priv(indio_dev);
430 magn_state->common_attributes.hsdev = hsdev;
431 magn_state->common_attributes.pdev = pdev;
433 ret = hid_sensor_parse_common_attributes(hsdev,
434 HID_USAGE_SENSOR_COMPASS_3D,
435 &magn_state->common_attributes);
437 dev_err(&pdev->dev, "failed to setup common attributes\n");
441 ret = magn_3d_parse_report(pdev, hsdev,
442 &channels, &chan_count,
443 HID_USAGE_SENSOR_COMPASS_3D, magn_state);
445 dev_err(&pdev->dev, "failed to parse report\n");
449 indio_dev->channels = channels;
450 indio_dev->num_channels = chan_count;
451 indio_dev->dev.parent = &pdev->dev;
452 indio_dev->info = &magn_3d_info;
453 indio_dev->name = name;
454 indio_dev->modes = INDIO_DIRECT_MODE;
456 ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time,
459 dev_err(&pdev->dev, "failed to initialize trigger buffer\n");
462 atomic_set(&magn_state->common_attributes.data_ready, 0);
463 ret = hid_sensor_setup_trigger(indio_dev, name,
464 &magn_state->common_attributes);
466 dev_err(&pdev->dev, "trigger setup failed\n");
467 goto error_unreg_buffer_funcs;
470 ret = iio_device_register(indio_dev);
472 dev_err(&pdev->dev, "device register failed\n");
473 goto error_remove_trigger;
476 magn_state->callbacks.send_event = magn_3d_proc_event;
477 magn_state->callbacks.capture_sample = magn_3d_capture_sample;
478 magn_state->callbacks.pdev = pdev;
479 ret = sensor_hub_register_callback(hsdev, HID_USAGE_SENSOR_COMPASS_3D,
480 &magn_state->callbacks);
482 dev_err(&pdev->dev, "callback reg failed\n");
483 goto error_iio_unreg;
489 iio_device_unregister(indio_dev);
490 error_remove_trigger:
491 hid_sensor_remove_trigger(&magn_state->common_attributes);
492 error_unreg_buffer_funcs:
493 iio_triggered_buffer_cleanup(indio_dev);
497 /* Function to deinitialize the processing for usage id */
498 static int hid_magn_3d_remove(struct platform_device *pdev)
500 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
501 struct iio_dev *indio_dev = platform_get_drvdata(pdev);
502 struct magn_3d_state *magn_state = iio_priv(indio_dev);
504 sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_COMPASS_3D);
505 iio_device_unregister(indio_dev);
506 hid_sensor_remove_trigger(&magn_state->common_attributes);
507 iio_triggered_buffer_cleanup(indio_dev);
512 static struct platform_device_id hid_magn_3d_ids[] = {
514 /* Format: HID-SENSOR-usage_id_in_hex_lowercase */
515 .name = "HID-SENSOR-200083",
519 MODULE_DEVICE_TABLE(platform, hid_magn_3d_ids);
521 static struct platform_driver hid_magn_3d_platform_driver = {
522 .id_table = hid_magn_3d_ids,
524 .name = KBUILD_MODNAME,
525 .pm = &hid_sensor_pm_ops,
527 .probe = hid_magn_3d_probe,
528 .remove = hid_magn_3d_remove,
530 module_platform_driver(hid_magn_3d_platform_driver);
532 MODULE_DESCRIPTION("HID Sensor Magnetometer 3D");
533 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
534 MODULE_LICENSE("GPL");