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/hid-sensor-hub.h>
26 #include <linux/iio/iio.h>
27 #include <linux/iio/sysfs.h>
28 #include <linux/iio/buffer.h>
29 #include <linux/iio/trigger_consumer.h>
30 #include <linux/iio/triggered_buffer.h>
31 #include "../common/hid-sensors/hid-sensor-trigger.h"
33 enum accel_3d_channel
{
40 struct accel_3d_state
{
41 struct hid_sensor_hub_callbacks callbacks
;
42 struct hid_sensor_common common_attributes
;
43 struct hid_sensor_hub_attribute_info accel
[ACCEL_3D_CHANNEL_MAX
];
44 u32 accel_val
[ACCEL_3D_CHANNEL_MAX
];
47 static const u32 accel_3d_addresses
[ACCEL_3D_CHANNEL_MAX
] = {
48 HID_USAGE_SENSOR_ACCEL_X_AXIS
,
49 HID_USAGE_SENSOR_ACCEL_Y_AXIS
,
50 HID_USAGE_SENSOR_ACCEL_Z_AXIS
53 /* Channel definitions */
54 static const struct iio_chan_spec accel_3d_channels
[] = {
58 .channel2
= IIO_MOD_X
,
59 .info_mask_shared_by_type
= BIT(IIO_CHAN_INFO_OFFSET
) |
60 BIT(IIO_CHAN_INFO_SCALE
) |
61 BIT(IIO_CHAN_INFO_SAMP_FREQ
) |
62 BIT(IIO_CHAN_INFO_HYSTERESIS
),
63 .scan_index
= CHANNEL_SCAN_INDEX_X
,
67 .channel2
= IIO_MOD_Y
,
68 .info_mask_shared_by_type
= BIT(IIO_CHAN_INFO_OFFSET
) |
69 BIT(IIO_CHAN_INFO_SCALE
) |
70 BIT(IIO_CHAN_INFO_SAMP_FREQ
) |
71 BIT(IIO_CHAN_INFO_HYSTERESIS
),
72 .scan_index
= CHANNEL_SCAN_INDEX_Y
,
76 .channel2
= IIO_MOD_Z
,
77 .info_mask_shared_by_type
= BIT(IIO_CHAN_INFO_OFFSET
) |
78 BIT(IIO_CHAN_INFO_SCALE
) |
79 BIT(IIO_CHAN_INFO_SAMP_FREQ
) |
80 BIT(IIO_CHAN_INFO_HYSTERESIS
),
81 .scan_index
= CHANNEL_SCAN_INDEX_Z
,
85 /* Adjust channel real bits based on report descriptor */
86 static void accel_3d_adjust_channel_bit_mask(struct iio_chan_spec
*channels
,
87 int channel
, int size
)
89 channels
[channel
].scan_type
.sign
= 's';
90 /* Real storage bits will change based on the report desc. */
91 channels
[channel
].scan_type
.realbits
= size
* 8;
92 /* Maximum size of a sample to capture is u32 */
93 channels
[channel
].scan_type
.storagebits
= sizeof(u32
) * 8;
96 /* Channel read_raw handler */
97 static int accel_3d_read_raw(struct iio_dev
*indio_dev
,
98 struct iio_chan_spec
const *chan
,
102 struct accel_3d_state
*accel_state
= iio_priv(indio_dev
);
112 report_id
= accel_state
->accel
[chan
->scan_index
].report_id
;
113 address
= accel_3d_addresses
[chan
->scan_index
];
115 *val
= sensor_hub_input_attr_get_raw_value(
116 accel_state
->common_attributes
.hsdev
,
117 HID_USAGE_SENSOR_ACCEL_3D
, address
,
123 ret_type
= IIO_VAL_INT
;
125 case IIO_CHAN_INFO_SCALE
:
126 *val
= accel_state
->accel
[CHANNEL_SCAN_INDEX_X
].units
;
127 ret_type
= IIO_VAL_INT
;
129 case IIO_CHAN_INFO_OFFSET
:
130 *val
= hid_sensor_convert_exponent(
131 accel_state
->accel
[CHANNEL_SCAN_INDEX_X
].unit_expo
);
132 ret_type
= IIO_VAL_INT
;
134 case IIO_CHAN_INFO_SAMP_FREQ
:
135 ret
= hid_sensor_read_samp_freq_value(
136 &accel_state
->common_attributes
, val
, val2
);
137 ret_type
= IIO_VAL_INT_PLUS_MICRO
;
139 case IIO_CHAN_INFO_HYSTERESIS
:
140 ret
= hid_sensor_read_raw_hyst_value(
141 &accel_state
->common_attributes
, val
, val2
);
142 ret_type
= IIO_VAL_INT_PLUS_MICRO
;
152 /* Channel write_raw handler */
153 static int accel_3d_write_raw(struct iio_dev
*indio_dev
,
154 struct iio_chan_spec
const *chan
,
159 struct accel_3d_state
*accel_state
= iio_priv(indio_dev
);
163 case IIO_CHAN_INFO_SAMP_FREQ
:
164 ret
= hid_sensor_write_samp_freq_value(
165 &accel_state
->common_attributes
, val
, val2
);
167 case IIO_CHAN_INFO_HYSTERESIS
:
168 ret
= hid_sensor_write_raw_hyst_value(
169 &accel_state
->common_attributes
, val
, val2
);
178 static const struct iio_info accel_3d_info
= {
179 .driver_module
= THIS_MODULE
,
180 .read_raw
= &accel_3d_read_raw
,
181 .write_raw
= &accel_3d_write_raw
,
184 /* Function to push data to buffer */
185 static void hid_sensor_push_data(struct iio_dev
*indio_dev
, u8
*data
, int len
)
187 dev_dbg(&indio_dev
->dev
, "hid_sensor_push_data\n");
188 iio_push_to_buffers(indio_dev
, (u8
*)data
);
191 /* Callback handler to send event after all samples are received and captured */
192 static int accel_3d_proc_event(struct hid_sensor_hub_device
*hsdev
,
196 struct iio_dev
*indio_dev
= platform_get_drvdata(priv
);
197 struct accel_3d_state
*accel_state
= iio_priv(indio_dev
);
199 dev_dbg(&indio_dev
->dev
, "accel_3d_proc_event [%d]\n",
200 accel_state
->common_attributes
.data_ready
);
201 if (accel_state
->common_attributes
.data_ready
)
202 hid_sensor_push_data(indio_dev
,
203 (u8
*)accel_state
->accel_val
,
204 sizeof(accel_state
->accel_val
));
209 /* Capture samples in local storage */
210 static int accel_3d_capture_sample(struct hid_sensor_hub_device
*hsdev
,
212 size_t raw_len
, char *raw_data
,
215 struct iio_dev
*indio_dev
= platform_get_drvdata(priv
);
216 struct accel_3d_state
*accel_state
= iio_priv(indio_dev
);
221 case HID_USAGE_SENSOR_ACCEL_X_AXIS
:
222 case HID_USAGE_SENSOR_ACCEL_Y_AXIS
:
223 case HID_USAGE_SENSOR_ACCEL_Z_AXIS
:
224 offset
= usage_id
- HID_USAGE_SENSOR_ACCEL_X_AXIS
;
225 accel_state
->accel_val
[CHANNEL_SCAN_INDEX_X
+ offset
] =
236 /* Parse report which is specific to an usage id*/
237 static int accel_3d_parse_report(struct platform_device
*pdev
,
238 struct hid_sensor_hub_device
*hsdev
,
239 struct iio_chan_spec
*channels
,
241 struct accel_3d_state
*st
)
246 for (i
= 0; i
<= CHANNEL_SCAN_INDEX_Z
; ++i
) {
247 ret
= sensor_hub_input_get_attribute_info(hsdev
,
250 HID_USAGE_SENSOR_ACCEL_X_AXIS
+ i
,
251 &st
->accel
[CHANNEL_SCAN_INDEX_X
+ i
]);
254 accel_3d_adjust_channel_bit_mask(channels
,
255 CHANNEL_SCAN_INDEX_X
+ i
,
256 st
->accel
[CHANNEL_SCAN_INDEX_X
+ i
].size
);
258 dev_dbg(&pdev
->dev
, "accel_3d %x:%x, %x:%x, %x:%x\n",
260 st
->accel
[0].report_id
,
261 st
->accel
[1].index
, st
->accel
[1].report_id
,
262 st
->accel
[2].index
, st
->accel
[2].report_id
);
267 /* Function to initialize the processing for usage id */
268 static int hid_accel_3d_probe(struct platform_device
*pdev
)
271 static const char *name
= "accel_3d";
272 struct iio_dev
*indio_dev
;
273 struct accel_3d_state
*accel_state
;
274 struct hid_sensor_hub_device
*hsdev
= pdev
->dev
.platform_data
;
275 struct iio_chan_spec
*channels
;
277 indio_dev
= devm_iio_device_alloc(&pdev
->dev
,
278 sizeof(struct accel_3d_state
));
279 if (indio_dev
== NULL
)
282 platform_set_drvdata(pdev
, indio_dev
);
284 accel_state
= iio_priv(indio_dev
);
285 accel_state
->common_attributes
.hsdev
= hsdev
;
286 accel_state
->common_attributes
.pdev
= pdev
;
288 ret
= hid_sensor_parse_common_attributes(hsdev
,
289 HID_USAGE_SENSOR_ACCEL_3D
,
290 &accel_state
->common_attributes
);
292 dev_err(&pdev
->dev
, "failed to setup common attributes\n");
296 channels
= kmemdup(accel_3d_channels
, sizeof(accel_3d_channels
),
299 dev_err(&pdev
->dev
, "failed to duplicate channels\n");
303 ret
= accel_3d_parse_report(pdev
, hsdev
, channels
,
304 HID_USAGE_SENSOR_ACCEL_3D
, accel_state
);
306 dev_err(&pdev
->dev
, "failed to setup attributes\n");
307 goto error_free_dev_mem
;
310 indio_dev
->channels
= channels
;
311 indio_dev
->num_channels
= ARRAY_SIZE(accel_3d_channels
);
312 indio_dev
->dev
.parent
= &pdev
->dev
;
313 indio_dev
->info
= &accel_3d_info
;
314 indio_dev
->name
= name
;
315 indio_dev
->modes
= INDIO_DIRECT_MODE
;
317 ret
= iio_triggered_buffer_setup(indio_dev
, &iio_pollfunc_store_time
,
320 dev_err(&pdev
->dev
, "failed to initialize trigger buffer\n");
321 goto error_free_dev_mem
;
323 accel_state
->common_attributes
.data_ready
= false;
324 ret
= hid_sensor_setup_trigger(indio_dev
, name
,
325 &accel_state
->common_attributes
);
327 dev_err(&pdev
->dev
, "trigger setup failed\n");
328 goto error_unreg_buffer_funcs
;
331 ret
= iio_device_register(indio_dev
);
333 dev_err(&pdev
->dev
, "device register failed\n");
334 goto error_remove_trigger
;
337 accel_state
->callbacks
.send_event
= accel_3d_proc_event
;
338 accel_state
->callbacks
.capture_sample
= accel_3d_capture_sample
;
339 accel_state
->callbacks
.pdev
= pdev
;
340 ret
= sensor_hub_register_callback(hsdev
, HID_USAGE_SENSOR_ACCEL_3D
,
341 &accel_state
->callbacks
);
343 dev_err(&pdev
->dev
, "callback reg failed\n");
344 goto error_iio_unreg
;
350 iio_device_unregister(indio_dev
);
351 error_remove_trigger
:
352 hid_sensor_remove_trigger(indio_dev
);
353 error_unreg_buffer_funcs
:
354 iio_triggered_buffer_cleanup(indio_dev
);
356 kfree(indio_dev
->channels
);
360 /* Function to deinitialize the processing for usage id */
361 static int hid_accel_3d_remove(struct platform_device
*pdev
)
363 struct hid_sensor_hub_device
*hsdev
= pdev
->dev
.platform_data
;
364 struct iio_dev
*indio_dev
= platform_get_drvdata(pdev
);
366 sensor_hub_remove_callback(hsdev
, HID_USAGE_SENSOR_ACCEL_3D
);
367 iio_device_unregister(indio_dev
);
368 hid_sensor_remove_trigger(indio_dev
);
369 iio_triggered_buffer_cleanup(indio_dev
);
370 kfree(indio_dev
->channels
);
375 static struct platform_device_id hid_accel_3d_ids
[] = {
377 /* Format: HID-SENSOR-usage_id_in_hex_lowercase */
378 .name
= "HID-SENSOR-200073",
382 MODULE_DEVICE_TABLE(platform
, hid_accel_3d_ids
);
384 static struct platform_driver hid_accel_3d_platform_driver
= {
385 .id_table
= hid_accel_3d_ids
,
387 .name
= KBUILD_MODNAME
,
388 .owner
= THIS_MODULE
,
390 .probe
= hid_accel_3d_probe
,
391 .remove
= hid_accel_3d_remove
,
393 module_platform_driver(hid_accel_3d_platform_driver
);
395 MODULE_DESCRIPTION("HID Sensor Accel 3D");
396 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
397 MODULE_LICENSE("GPL");