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 gyro_3d_channel {
41 struct gyro_3d_state {
42 struct hid_sensor_hub_callbacks callbacks;
43 struct hid_sensor_common common_attributes;
44 struct hid_sensor_hub_attribute_info gyro[GYRO_3D_CHANNEL_MAX];
45 u32 gyro_val[GYRO_3D_CHANNEL_MAX];
52 static const u32 gyro_3d_addresses[GYRO_3D_CHANNEL_MAX] = {
53 HID_USAGE_SENSOR_ANGL_VELOCITY_X_AXIS,
54 HID_USAGE_SENSOR_ANGL_VELOCITY_Y_AXIS,
55 HID_USAGE_SENSOR_ANGL_VELOCITY_Z_AXIS
58 /* Channel definitions */
59 static const struct iio_chan_spec gyro_3d_channels[] = {
63 .channel2 = IIO_MOD_X,
64 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
65 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
66 BIT(IIO_CHAN_INFO_SCALE) |
67 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
68 BIT(IIO_CHAN_INFO_HYSTERESIS),
69 .scan_index = CHANNEL_SCAN_INDEX_X,
73 .channel2 = IIO_MOD_Y,
74 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
75 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
76 BIT(IIO_CHAN_INFO_SCALE) |
77 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
78 BIT(IIO_CHAN_INFO_HYSTERESIS),
79 .scan_index = CHANNEL_SCAN_INDEX_Y,
83 .channel2 = IIO_MOD_Z,
84 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
85 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
86 BIT(IIO_CHAN_INFO_SCALE) |
87 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
88 BIT(IIO_CHAN_INFO_HYSTERESIS),
89 .scan_index = CHANNEL_SCAN_INDEX_Z,
93 /* Adjust channel real bits based on report descriptor */
94 static void gyro_3d_adjust_channel_bit_mask(struct iio_chan_spec *channels,
95 int channel, int size)
97 channels[channel].scan_type.sign = 's';
98 /* Real storage bits will change based on the report desc. */
99 channels[channel].scan_type.realbits = size * 8;
100 /* Maximum size of a sample to capture is u32 */
101 channels[channel].scan_type.storagebits = sizeof(u32) * 8;
104 /* Channel read_raw handler */
105 static int gyro_3d_read_raw(struct iio_dev *indio_dev,
106 struct iio_chan_spec const *chan,
110 struct gyro_3d_state *gyro_state = iio_priv(indio_dev);
118 case IIO_CHAN_INFO_RAW:
119 hid_sensor_power_state(&gyro_state->common_attributes, true);
120 report_id = gyro_state->gyro[chan->scan_index].report_id;
121 address = gyro_3d_addresses[chan->scan_index];
123 *val = sensor_hub_input_attr_get_raw_value(
124 gyro_state->common_attributes.hsdev,
125 HID_USAGE_SENSOR_GYRO_3D, address,
130 hid_sensor_power_state(&gyro_state->common_attributes,
134 hid_sensor_power_state(&gyro_state->common_attributes, false);
135 ret_type = IIO_VAL_INT;
137 case IIO_CHAN_INFO_SCALE:
138 *val = gyro_state->scale_pre_decml;
139 *val2 = gyro_state->scale_post_decml;
140 ret_type = gyro_state->scale_precision;
142 case IIO_CHAN_INFO_OFFSET:
143 *val = gyro_state->value_offset;
144 ret_type = IIO_VAL_INT;
146 case IIO_CHAN_INFO_SAMP_FREQ:
147 ret_type = hid_sensor_read_samp_freq_value(
148 &gyro_state->common_attributes, val, val2);
150 case IIO_CHAN_INFO_HYSTERESIS:
151 ret_type = hid_sensor_read_raw_hyst_value(
152 &gyro_state->common_attributes, val, val2);
162 /* Channel write_raw handler */
163 static int gyro_3d_write_raw(struct iio_dev *indio_dev,
164 struct iio_chan_spec const *chan,
169 struct gyro_3d_state *gyro_state = iio_priv(indio_dev);
173 case IIO_CHAN_INFO_SAMP_FREQ:
174 ret = hid_sensor_write_samp_freq_value(
175 &gyro_state->common_attributes, val, val2);
177 case IIO_CHAN_INFO_HYSTERESIS:
178 ret = hid_sensor_write_raw_hyst_value(
179 &gyro_state->common_attributes, val, val2);
188 static const struct iio_info gyro_3d_info = {
189 .read_raw = &gyro_3d_read_raw,
190 .write_raw = &gyro_3d_write_raw,
193 /* Function to push data to buffer */
194 static void hid_sensor_push_data(struct iio_dev *indio_dev, const void *data,
197 dev_dbg(&indio_dev->dev, "hid_sensor_push_data\n");
198 iio_push_to_buffers(indio_dev, data);
201 /* Callback handler to send event after all samples are received and captured */
202 static int gyro_3d_proc_event(struct hid_sensor_hub_device *hsdev,
206 struct iio_dev *indio_dev = platform_get_drvdata(priv);
207 struct gyro_3d_state *gyro_state = iio_priv(indio_dev);
209 dev_dbg(&indio_dev->dev, "gyro_3d_proc_event\n");
210 if (atomic_read(&gyro_state->common_attributes.data_ready))
211 hid_sensor_push_data(indio_dev,
212 gyro_state->gyro_val,
213 sizeof(gyro_state->gyro_val));
218 /* Capture samples in local storage */
219 static int gyro_3d_capture_sample(struct hid_sensor_hub_device *hsdev,
221 size_t raw_len, char *raw_data,
224 struct iio_dev *indio_dev = platform_get_drvdata(priv);
225 struct gyro_3d_state *gyro_state = iio_priv(indio_dev);
230 case HID_USAGE_SENSOR_ANGL_VELOCITY_X_AXIS:
231 case HID_USAGE_SENSOR_ANGL_VELOCITY_Y_AXIS:
232 case HID_USAGE_SENSOR_ANGL_VELOCITY_Z_AXIS:
233 offset = usage_id - HID_USAGE_SENSOR_ANGL_VELOCITY_X_AXIS;
234 gyro_state->gyro_val[CHANNEL_SCAN_INDEX_X + offset] =
245 /* Parse report which is specific to an usage id*/
246 static int gyro_3d_parse_report(struct platform_device *pdev,
247 struct hid_sensor_hub_device *hsdev,
248 struct iio_chan_spec *channels,
250 struct gyro_3d_state *st)
255 for (i = 0; i <= CHANNEL_SCAN_INDEX_Z; ++i) {
256 ret = sensor_hub_input_get_attribute_info(hsdev,
259 HID_USAGE_SENSOR_ANGL_VELOCITY_X_AXIS + i,
260 &st->gyro[CHANNEL_SCAN_INDEX_X + i]);
263 gyro_3d_adjust_channel_bit_mask(channels,
264 CHANNEL_SCAN_INDEX_X + i,
265 st->gyro[CHANNEL_SCAN_INDEX_X + i].size);
267 dev_dbg(&pdev->dev, "gyro_3d %x:%x, %x:%x, %x:%x\n",
269 st->gyro[0].report_id,
270 st->gyro[1].index, st->gyro[1].report_id,
271 st->gyro[2].index, st->gyro[2].report_id);
273 st->scale_precision = hid_sensor_format_scale(
274 HID_USAGE_SENSOR_GYRO_3D,
275 &st->gyro[CHANNEL_SCAN_INDEX_X],
276 &st->scale_pre_decml, &st->scale_post_decml);
278 /* Set Sensitivity field ids, when there is no individual modifier */
279 if (st->common_attributes.sensitivity.index < 0) {
280 sensor_hub_input_get_attribute_info(hsdev,
281 HID_FEATURE_REPORT, usage_id,
282 HID_USAGE_SENSOR_DATA_MOD_CHANGE_SENSITIVITY_ABS |
283 HID_USAGE_SENSOR_DATA_ANGL_VELOCITY,
284 &st->common_attributes.sensitivity);
285 dev_dbg(&pdev->dev, "Sensitivity index:report %d:%d\n",
286 st->common_attributes.sensitivity.index,
287 st->common_attributes.sensitivity.report_id);
292 /* Function to initialize the processing for usage id */
293 static int hid_gyro_3d_probe(struct platform_device *pdev)
296 static const char *name = "gyro_3d";
297 struct iio_dev *indio_dev;
298 struct gyro_3d_state *gyro_state;
299 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
301 indio_dev = devm_iio_device_alloc(&pdev->dev, sizeof(*gyro_state));
304 platform_set_drvdata(pdev, indio_dev);
306 gyro_state = iio_priv(indio_dev);
307 gyro_state->common_attributes.hsdev = hsdev;
308 gyro_state->common_attributes.pdev = pdev;
310 ret = hid_sensor_parse_common_attributes(hsdev,
311 HID_USAGE_SENSOR_GYRO_3D,
312 &gyro_state->common_attributes);
314 dev_err(&pdev->dev, "failed to setup common attributes\n");
318 indio_dev->channels = kmemdup(gyro_3d_channels,
319 sizeof(gyro_3d_channels), GFP_KERNEL);
320 if (!indio_dev->channels) {
321 dev_err(&pdev->dev, "failed to duplicate channels\n");
325 ret = gyro_3d_parse_report(pdev, hsdev,
326 (struct iio_chan_spec *)indio_dev->channels,
327 HID_USAGE_SENSOR_GYRO_3D, gyro_state);
329 dev_err(&pdev->dev, "failed to setup attributes\n");
330 goto error_free_dev_mem;
333 indio_dev->num_channels = ARRAY_SIZE(gyro_3d_channels);
334 indio_dev->dev.parent = &pdev->dev;
335 indio_dev->info = &gyro_3d_info;
336 indio_dev->name = name;
337 indio_dev->modes = INDIO_DIRECT_MODE;
339 ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time,
342 dev_err(&pdev->dev, "failed to initialize trigger buffer\n");
343 goto error_free_dev_mem;
345 atomic_set(&gyro_state->common_attributes.data_ready, 0);
346 ret = hid_sensor_setup_trigger(indio_dev, name,
347 &gyro_state->common_attributes);
349 dev_err(&pdev->dev, "trigger setup failed\n");
350 goto error_unreg_buffer_funcs;
353 ret = iio_device_register(indio_dev);
355 dev_err(&pdev->dev, "device register failed\n");
356 goto error_remove_trigger;
359 gyro_state->callbacks.send_event = gyro_3d_proc_event;
360 gyro_state->callbacks.capture_sample = gyro_3d_capture_sample;
361 gyro_state->callbacks.pdev = pdev;
362 ret = sensor_hub_register_callback(hsdev, HID_USAGE_SENSOR_GYRO_3D,
363 &gyro_state->callbacks);
365 dev_err(&pdev->dev, "callback reg failed\n");
366 goto error_iio_unreg;
372 iio_device_unregister(indio_dev);
373 error_remove_trigger:
374 hid_sensor_remove_trigger(&gyro_state->common_attributes);
375 error_unreg_buffer_funcs:
376 iio_triggered_buffer_cleanup(indio_dev);
378 kfree(indio_dev->channels);
382 /* Function to deinitialize the processing for usage id */
383 static int hid_gyro_3d_remove(struct platform_device *pdev)
385 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
386 struct iio_dev *indio_dev = platform_get_drvdata(pdev);
387 struct gyro_3d_state *gyro_state = iio_priv(indio_dev);
389 sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_GYRO_3D);
390 iio_device_unregister(indio_dev);
391 hid_sensor_remove_trigger(&gyro_state->common_attributes);
392 iio_triggered_buffer_cleanup(indio_dev);
393 kfree(indio_dev->channels);
398 static const struct platform_device_id hid_gyro_3d_ids[] = {
400 /* Format: HID-SENSOR-usage_id_in_hex_lowercase */
401 .name = "HID-SENSOR-200076",
405 MODULE_DEVICE_TABLE(platform, hid_gyro_3d_ids);
407 static struct platform_driver hid_gyro_3d_platform_driver = {
408 .id_table = hid_gyro_3d_ids,
410 .name = KBUILD_MODNAME,
411 .pm = &hid_sensor_pm_ops,
413 .probe = hid_gyro_3d_probe,
414 .remove = hid_gyro_3d_remove,
416 module_platform_driver(hid_gyro_3d_platform_driver);
418 MODULE_DESCRIPTION("HID Sensor Gyroscope 3D");
419 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
420 MODULE_LICENSE("GPL");