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 accel_3d_channel {
41 struct accel_3d_state {
42 struct hid_sensor_hub_callbacks callbacks;
43 struct hid_sensor_common common_attributes;
44 struct hid_sensor_hub_attribute_info accel[ACCEL_3D_CHANNEL_MAX];
45 /* Ensure timestamp is naturally aligned */
48 s64 timestamp __aligned(8);
57 static const u32 accel_3d_addresses[ACCEL_3D_CHANNEL_MAX] = {
58 HID_USAGE_SENSOR_ACCEL_X_AXIS,
59 HID_USAGE_SENSOR_ACCEL_Y_AXIS,
60 HID_USAGE_SENSOR_ACCEL_Z_AXIS
63 /* Channel definitions */
64 static const struct iio_chan_spec accel_3d_channels[] = {
68 .channel2 = IIO_MOD_X,
69 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
70 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
71 BIT(IIO_CHAN_INFO_SCALE) |
72 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
73 BIT(IIO_CHAN_INFO_HYSTERESIS),
74 .scan_index = CHANNEL_SCAN_INDEX_X,
78 .channel2 = IIO_MOD_Y,
79 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
80 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
81 BIT(IIO_CHAN_INFO_SCALE) |
82 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
83 BIT(IIO_CHAN_INFO_HYSTERESIS),
84 .scan_index = CHANNEL_SCAN_INDEX_Y,
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),
94 .scan_index = CHANNEL_SCAN_INDEX_Z,
96 IIO_CHAN_SOFT_TIMESTAMP(3)
99 /* Channel definitions */
100 static const struct iio_chan_spec gravity_channels[] = {
104 .channel2 = IIO_MOD_X,
105 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
106 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
107 BIT(IIO_CHAN_INFO_SCALE) |
108 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
109 BIT(IIO_CHAN_INFO_HYSTERESIS),
110 .scan_index = CHANNEL_SCAN_INDEX_X,
114 .channel2 = IIO_MOD_Y,
115 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
116 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
117 BIT(IIO_CHAN_INFO_SCALE) |
118 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
119 BIT(IIO_CHAN_INFO_HYSTERESIS),
120 .scan_index = CHANNEL_SCAN_INDEX_Y,
124 .channel2 = IIO_MOD_Z,
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),
130 .scan_index = CHANNEL_SCAN_INDEX_Z,
134 /* Adjust channel real bits based on report descriptor */
135 static void accel_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 accel_3d_read_raw(struct iio_dev *indio_dev,
147 struct iio_chan_spec const *chan,
151 struct accel_3d_state *accel_state = iio_priv(indio_dev);
156 struct hid_sensor_hub_device *hsdev =
157 accel_state->common_attributes.hsdev;
163 hid_sensor_power_state(&accel_state->common_attributes, true);
164 report_id = accel_state->accel[chan->scan_index].report_id;
165 min = accel_state->accel[chan->scan_index].logical_minimum;
166 address = accel_3d_addresses[chan->scan_index];
168 *val = sensor_hub_input_attr_get_raw_value(
169 accel_state->common_attributes.hsdev,
170 hsdev->usage, address, report_id,
175 hid_sensor_power_state(&accel_state->common_attributes,
179 hid_sensor_power_state(&accel_state->common_attributes, false);
180 ret_type = IIO_VAL_INT;
182 case IIO_CHAN_INFO_SCALE:
183 *val = accel_state->scale_pre_decml;
184 *val2 = accel_state->scale_post_decml;
185 ret_type = accel_state->scale_precision;
187 case IIO_CHAN_INFO_OFFSET:
188 *val = accel_state->value_offset;
189 ret_type = IIO_VAL_INT;
191 case IIO_CHAN_INFO_SAMP_FREQ:
192 ret_type = hid_sensor_read_samp_freq_value(
193 &accel_state->common_attributes, val, val2);
195 case IIO_CHAN_INFO_HYSTERESIS:
196 ret_type = hid_sensor_read_raw_hyst_value(
197 &accel_state->common_attributes, val, val2);
207 /* Channel write_raw handler */
208 static int accel_3d_write_raw(struct iio_dev *indio_dev,
209 struct iio_chan_spec const *chan,
214 struct accel_3d_state *accel_state = iio_priv(indio_dev);
218 case IIO_CHAN_INFO_SAMP_FREQ:
219 ret = hid_sensor_write_samp_freq_value(
220 &accel_state->common_attributes, val, val2);
222 case IIO_CHAN_INFO_HYSTERESIS:
223 ret = hid_sensor_write_raw_hyst_value(
224 &accel_state->common_attributes, val, val2);
233 static const struct iio_info accel_3d_info = {
234 .driver_module = THIS_MODULE,
235 .read_raw = &accel_3d_read_raw,
236 .write_raw = &accel_3d_write_raw,
239 /* Function to push data to buffer */
240 static void hid_sensor_push_data(struct iio_dev *indio_dev, void *data,
241 int len, int64_t timestamp)
243 dev_dbg(&indio_dev->dev, "hid_sensor_push_data\n");
244 iio_push_to_buffers_with_timestamp(indio_dev, data, timestamp);
247 /* Callback handler to send event after all samples are received and captured */
248 static int accel_3d_proc_event(struct hid_sensor_hub_device *hsdev,
252 struct iio_dev *indio_dev = platform_get_drvdata(priv);
253 struct accel_3d_state *accel_state = iio_priv(indio_dev);
255 dev_dbg(&indio_dev->dev, "accel_3d_proc_event\n");
256 if (atomic_read(&accel_state->common_attributes.data_ready)) {
257 if (!accel_state->timestamp)
258 accel_state->timestamp = iio_get_time_ns(indio_dev);
260 hid_sensor_push_data(indio_dev,
262 sizeof(accel_state->scan),
263 accel_state->timestamp);
265 accel_state->timestamp = 0;
271 /* Capture samples in local storage */
272 static int accel_3d_capture_sample(struct hid_sensor_hub_device *hsdev,
274 size_t raw_len, char *raw_data,
277 struct iio_dev *indio_dev = platform_get_drvdata(priv);
278 struct accel_3d_state *accel_state = iio_priv(indio_dev);
283 case HID_USAGE_SENSOR_ACCEL_X_AXIS:
284 case HID_USAGE_SENSOR_ACCEL_Y_AXIS:
285 case HID_USAGE_SENSOR_ACCEL_Z_AXIS:
286 offset = usage_id - HID_USAGE_SENSOR_ACCEL_X_AXIS;
287 accel_state->scan.accel_val[CHANNEL_SCAN_INDEX_X + offset] =
291 case HID_USAGE_SENSOR_TIME_TIMESTAMP:
292 accel_state->timestamp =
293 hid_sensor_convert_timestamp(
294 &accel_state->common_attributes,
295 *(int64_t *)raw_data);
304 /* Parse report which is specific to an usage id*/
305 static int accel_3d_parse_report(struct platform_device *pdev,
306 struct hid_sensor_hub_device *hsdev,
307 struct iio_chan_spec *channels,
309 struct accel_3d_state *st)
314 for (i = 0; i <= CHANNEL_SCAN_INDEX_Z; ++i) {
315 ret = sensor_hub_input_get_attribute_info(hsdev,
318 HID_USAGE_SENSOR_ACCEL_X_AXIS + i,
319 &st->accel[CHANNEL_SCAN_INDEX_X + i]);
322 accel_3d_adjust_channel_bit_mask(channels,
323 CHANNEL_SCAN_INDEX_X + i,
324 st->accel[CHANNEL_SCAN_INDEX_X + i].size);
326 dev_dbg(&pdev->dev, "accel_3d %x:%x, %x:%x, %x:%x\n",
328 st->accel[0].report_id,
329 st->accel[1].index, st->accel[1].report_id,
330 st->accel[2].index, st->accel[2].report_id);
332 st->scale_precision = hid_sensor_format_scale(
334 &st->accel[CHANNEL_SCAN_INDEX_X],
335 &st->scale_pre_decml, &st->scale_post_decml);
337 /* Set Sensitivity field ids, when there is no individual modifier */
338 if (st->common_attributes.sensitivity.index < 0) {
339 sensor_hub_input_get_attribute_info(hsdev,
340 HID_FEATURE_REPORT, usage_id,
341 HID_USAGE_SENSOR_DATA_MOD_CHANGE_SENSITIVITY_ABS |
342 HID_USAGE_SENSOR_DATA_ACCELERATION,
343 &st->common_attributes.sensitivity);
344 dev_dbg(&pdev->dev, "Sensitivity index:report %d:%d\n",
345 st->common_attributes.sensitivity.index,
346 st->common_attributes.sensitivity.report_id);
352 /* Function to initialize the processing for usage id */
353 static int hid_accel_3d_probe(struct platform_device *pdev)
357 struct iio_dev *indio_dev;
358 struct accel_3d_state *accel_state;
359 const struct iio_chan_spec *channel_spec;
362 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
364 indio_dev = devm_iio_device_alloc(&pdev->dev,
365 sizeof(struct accel_3d_state));
366 if (indio_dev == NULL)
369 platform_set_drvdata(pdev, indio_dev);
371 accel_state = iio_priv(indio_dev);
372 accel_state->common_attributes.hsdev = hsdev;
373 accel_state->common_attributes.pdev = pdev;
375 if (hsdev->usage == HID_USAGE_SENSOR_ACCEL_3D) {
377 channel_spec = accel_3d_channels;
378 channel_size = sizeof(accel_3d_channels);
379 indio_dev->num_channels = ARRAY_SIZE(accel_3d_channels);
382 channel_spec = gravity_channels;
383 channel_size = sizeof(gravity_channels);
384 indio_dev->num_channels = ARRAY_SIZE(gravity_channels);
386 ret = hid_sensor_parse_common_attributes(hsdev, hsdev->usage,
387 &accel_state->common_attributes);
389 dev_err(&pdev->dev, "failed to setup common attributes\n");
392 indio_dev->channels = kmemdup(channel_spec, channel_size, GFP_KERNEL);
394 if (!indio_dev->channels) {
395 dev_err(&pdev->dev, "failed to duplicate channels\n");
398 ret = accel_3d_parse_report(pdev, hsdev,
399 (struct iio_chan_spec *)indio_dev->channels,
400 hsdev->usage, accel_state);
402 dev_err(&pdev->dev, "failed to setup attributes\n");
403 goto error_free_dev_mem;
406 indio_dev->dev.parent = &pdev->dev;
407 indio_dev->info = &accel_3d_info;
408 indio_dev->name = name;
409 indio_dev->modes = INDIO_DIRECT_MODE;
411 ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time,
414 dev_err(&pdev->dev, "failed to initialize trigger buffer\n");
415 goto error_free_dev_mem;
417 atomic_set(&accel_state->common_attributes.data_ready, 0);
418 ret = hid_sensor_setup_trigger(indio_dev, name,
419 &accel_state->common_attributes);
421 dev_err(&pdev->dev, "trigger setup failed\n");
422 goto error_unreg_buffer_funcs;
425 ret = iio_device_register(indio_dev);
427 dev_err(&pdev->dev, "device register failed\n");
428 goto error_remove_trigger;
431 accel_state->callbacks.send_event = accel_3d_proc_event;
432 accel_state->callbacks.capture_sample = accel_3d_capture_sample;
433 accel_state->callbacks.pdev = pdev;
434 ret = sensor_hub_register_callback(hsdev, hsdev->usage,
435 &accel_state->callbacks);
437 dev_err(&pdev->dev, "callback reg failed\n");
438 goto error_iio_unreg;
444 iio_device_unregister(indio_dev);
445 error_remove_trigger:
446 hid_sensor_remove_trigger(&accel_state->common_attributes);
447 error_unreg_buffer_funcs:
448 iio_triggered_buffer_cleanup(indio_dev);
450 kfree(indio_dev->channels);
454 /* Function to deinitialize the processing for usage id */
455 static int hid_accel_3d_remove(struct platform_device *pdev)
457 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
458 struct iio_dev *indio_dev = platform_get_drvdata(pdev);
459 struct accel_3d_state *accel_state = iio_priv(indio_dev);
461 sensor_hub_remove_callback(hsdev, hsdev->usage);
462 iio_device_unregister(indio_dev);
463 hid_sensor_remove_trigger(&accel_state->common_attributes);
464 iio_triggered_buffer_cleanup(indio_dev);
465 kfree(indio_dev->channels);
470 static const struct platform_device_id hid_accel_3d_ids[] = {
472 /* Format: HID-SENSOR-usage_id_in_hex_lowercase */
473 .name = "HID-SENSOR-200073",
475 { /* gravity sensor */
476 .name = "HID-SENSOR-20007b",
480 MODULE_DEVICE_TABLE(platform, hid_accel_3d_ids);
482 static struct platform_driver hid_accel_3d_platform_driver = {
483 .id_table = hid_accel_3d_ids,
485 .name = KBUILD_MODNAME,
486 .pm = &hid_sensor_pm_ops,
488 .probe = hid_accel_3d_probe,
489 .remove = hid_accel_3d_remove,
491 module_platform_driver(hid_accel_3d_platform_driver);
493 MODULE_DESCRIPTION("HID Sensor Accel 3D");
494 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
495 MODULE_LICENSE("GPL");