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-attributes.h"
32 #include "../common/hid-sensors/hid-sensor-trigger.h"
34 /*Format: HID-SENSOR-usage_id_in_hex*/
35 /*Usage ID from spec for Magnetometer-3D: 0x200083*/
36 #define DRIVER_NAME "HID-SENSOR-200083"
38 enum magn_3d_channel {
45 struct magn_3d_state {
46 struct hid_sensor_hub_callbacks callbacks;
47 struct hid_sensor_iio_common common_attributes;
48 struct hid_sensor_hub_attribute_info magn[MAGN_3D_CHANNEL_MAX];
49 u32 magn_val[MAGN_3D_CHANNEL_MAX];
52 static const u32 magn_3d_addresses[MAGN_3D_CHANNEL_MAX] = {
53 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS,
54 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Y_AXIS,
55 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Z_AXIS
58 /* Channel definitions */
59 static const struct iio_chan_spec magn_3d_channels[] = {
63 .channel2 = IIO_MOD_X,
64 .info_mask = IIO_CHAN_INFO_OFFSET_SHARED_BIT |
65 IIO_CHAN_INFO_SCALE_SHARED_BIT |
66 IIO_CHAN_INFO_SAMP_FREQ_SHARED_BIT |
67 IIO_CHAN_INFO_HYSTERESIS_SHARED_BIT,
68 .scan_index = CHANNEL_SCAN_INDEX_X,
72 .channel2 = IIO_MOD_Y,
73 .info_mask = IIO_CHAN_INFO_OFFSET_SHARED_BIT |
74 IIO_CHAN_INFO_SCALE_SHARED_BIT |
75 IIO_CHAN_INFO_SAMP_FREQ_SHARED_BIT |
76 IIO_CHAN_INFO_HYSTERESIS_SHARED_BIT,
77 .scan_index = CHANNEL_SCAN_INDEX_Y,
81 .channel2 = IIO_MOD_Z,
82 .info_mask = IIO_CHAN_INFO_OFFSET_SHARED_BIT |
83 IIO_CHAN_INFO_SCALE_SHARED_BIT |
84 IIO_CHAN_INFO_SAMP_FREQ_SHARED_BIT |
85 IIO_CHAN_INFO_HYSTERESIS_SHARED_BIT,
86 .scan_index = CHANNEL_SCAN_INDEX_Z,
90 /* Adjust channel real bits based on report descriptor */
91 static void magn_3d_adjust_channel_bit_mask(struct iio_chan_spec *channels,
92 int channel, int size)
94 channels[channel].scan_type.sign = 's';
95 /* Real storage bits will change based on the report desc. */
96 channels[channel].scan_type.realbits = size * 8;
97 /* Maximum size of a sample to capture is u32 */
98 channels[channel].scan_type.storagebits = sizeof(u32) * 8;
101 /* Channel read_raw handler */
102 static int magn_3d_read_raw(struct iio_dev *indio_dev,
103 struct iio_chan_spec const *chan,
107 struct magn_3d_state *magn_state = iio_priv(indio_dev);
118 magn_state->magn[chan->scan_index].report_id;
119 address = magn_3d_addresses[chan->scan_index];
121 *val = sensor_hub_input_attr_get_raw_value(
122 magn_state->common_attributes.hsdev,
123 HID_USAGE_SENSOR_COMPASS_3D, address,
129 ret_type = IIO_VAL_INT;
131 case IIO_CHAN_INFO_SCALE:
132 *val = magn_state->magn[CHANNEL_SCAN_INDEX_X].units;
133 ret_type = IIO_VAL_INT;
135 case IIO_CHAN_INFO_OFFSET:
136 *val = hid_sensor_convert_exponent(
137 magn_state->magn[CHANNEL_SCAN_INDEX_X].unit_expo);
138 ret_type = IIO_VAL_INT;
140 case IIO_CHAN_INFO_SAMP_FREQ:
141 ret = hid_sensor_read_samp_freq_value(
142 &magn_state->common_attributes, val, val2);
143 ret_type = IIO_VAL_INT_PLUS_MICRO;
145 case IIO_CHAN_INFO_HYSTERESIS:
146 ret = hid_sensor_read_raw_hyst_value(
147 &magn_state->common_attributes, val, val2);
148 ret_type = IIO_VAL_INT_PLUS_MICRO;
158 /* Channel write_raw handler */
159 static int magn_3d_write_raw(struct iio_dev *indio_dev,
160 struct iio_chan_spec const *chan,
165 struct magn_3d_state *magn_state = iio_priv(indio_dev);
169 case IIO_CHAN_INFO_SAMP_FREQ:
170 ret = hid_sensor_write_samp_freq_value(
171 &magn_state->common_attributes, val, val2);
173 case IIO_CHAN_INFO_HYSTERESIS:
174 ret = hid_sensor_write_raw_hyst_value(
175 &magn_state->common_attributes, val, val2);
184 static int magn_3d_write_raw_get_fmt(struct iio_dev *indio_dev,
185 struct iio_chan_spec const *chan,
188 return IIO_VAL_INT_PLUS_MICRO;
191 static const struct iio_info magn_3d_info = {
192 .driver_module = THIS_MODULE,
193 .read_raw = &magn_3d_read_raw,
194 .write_raw = &magn_3d_write_raw,
195 .write_raw_get_fmt = &magn_3d_write_raw_get_fmt,
198 /* Function to push data to buffer */
199 static void hid_sensor_push_data(struct iio_dev *indio_dev, u8 *data, int len)
201 dev_dbg(&indio_dev->dev, "hid_sensor_push_data\n");
202 iio_push_to_buffers(indio_dev, (u8 *)data);
205 /* Callback handler to send event after all samples are received and captured */
206 static int magn_3d_proc_event(struct hid_sensor_hub_device *hsdev,
210 struct iio_dev *indio_dev = platform_get_drvdata(priv);
211 struct magn_3d_state *magn_state = iio_priv(indio_dev);
213 dev_dbg(&indio_dev->dev, "magn_3d_proc_event [%d]\n",
214 magn_state->common_attributes.data_ready);
215 if (magn_state->common_attributes.data_ready)
216 hid_sensor_push_data(indio_dev,
217 (u8 *)magn_state->magn_val,
218 sizeof(magn_state->magn_val));
223 /* Capture samples in local storage */
224 static int magn_3d_capture_sample(struct hid_sensor_hub_device *hsdev,
226 size_t raw_len, char *raw_data,
229 struct iio_dev *indio_dev = platform_get_drvdata(priv);
230 struct magn_3d_state *magn_state = iio_priv(indio_dev);
235 case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS:
236 case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Y_AXIS:
237 case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Z_AXIS:
238 offset = usage_id - HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS;
239 magn_state->magn_val[CHANNEL_SCAN_INDEX_X + offset] =
250 /* Parse report which is specific to an usage id*/
251 static int magn_3d_parse_report(struct platform_device *pdev,
252 struct hid_sensor_hub_device *hsdev,
253 struct iio_chan_spec *channels,
255 struct magn_3d_state *st)
260 for (i = 0; i <= CHANNEL_SCAN_INDEX_Z; ++i) {
261 ret = sensor_hub_input_get_attribute_info(hsdev,
264 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS + i,
265 &st->magn[CHANNEL_SCAN_INDEX_X + i]);
268 magn_3d_adjust_channel_bit_mask(channels,
269 CHANNEL_SCAN_INDEX_X + i,
270 st->magn[CHANNEL_SCAN_INDEX_X + i].size);
272 dev_dbg(&pdev->dev, "magn_3d %x:%x, %x:%x, %x:%x\n",
274 st->magn[0].report_id,
275 st->magn[1].index, st->magn[1].report_id,
276 st->magn[2].index, st->magn[2].report_id);
281 /* Function to initialize the processing for usage id */
282 static int __devinit hid_magn_3d_probe(struct platform_device *pdev)
285 static char *name = "magn_3d";
286 struct iio_dev *indio_dev;
287 struct magn_3d_state *magn_state;
288 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
289 struct iio_chan_spec *channels;
291 indio_dev = iio_device_alloc(sizeof(struct magn_3d_state));
292 if (indio_dev == NULL) {
296 platform_set_drvdata(pdev, indio_dev);
298 magn_state = iio_priv(indio_dev);
299 magn_state->common_attributes.hsdev = hsdev;
300 magn_state->common_attributes.pdev = pdev;
302 ret = hid_sensor_parse_common_attributes(hsdev,
303 HID_USAGE_SENSOR_COMPASS_3D,
304 &magn_state->common_attributes);
306 dev_err(&pdev->dev, "failed to setup common attributes\n");
310 channels = kmemdup(magn_3d_channels, sizeof(magn_3d_channels),
314 dev_err(&pdev->dev, "failed to duplicate channels\n");
318 ret = magn_3d_parse_report(pdev, hsdev, channels,
319 HID_USAGE_SENSOR_COMPASS_3D, magn_state);
321 dev_err(&pdev->dev, "failed to setup attributes\n");
322 goto error_free_dev_mem;
325 indio_dev->channels = channels;
326 indio_dev->num_channels = ARRAY_SIZE(magn_3d_channels);
327 indio_dev->dev.parent = &pdev->dev;
328 indio_dev->info = &magn_3d_info;
329 indio_dev->name = name;
330 indio_dev->modes = INDIO_DIRECT_MODE;
332 ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time,
335 dev_err(&pdev->dev, "failed to initialize trigger buffer\n");
336 goto error_free_dev_mem;
338 magn_state->common_attributes.data_ready = false;
339 ret = hid_sensor_setup_trigger(indio_dev, name,
340 &magn_state->common_attributes);
342 dev_err(&pdev->dev, "trigger setup failed\n");
343 goto error_unreg_buffer_funcs;
346 ret = iio_device_register(indio_dev);
348 dev_err(&pdev->dev, "device register failed\n");
349 goto error_remove_trigger;
352 magn_state->callbacks.send_event = magn_3d_proc_event;
353 magn_state->callbacks.capture_sample = magn_3d_capture_sample;
354 magn_state->callbacks.pdev = pdev;
355 ret = sensor_hub_register_callback(hsdev, HID_USAGE_SENSOR_COMPASS_3D,
356 &magn_state->callbacks);
358 dev_err(&pdev->dev, "callback reg failed\n");
359 goto error_iio_unreg;
365 iio_device_unregister(indio_dev);
366 error_remove_trigger:
367 hid_sensor_remove_trigger(indio_dev);
368 error_unreg_buffer_funcs:
369 iio_triggered_buffer_cleanup(indio_dev);
371 kfree(indio_dev->channels);
373 iio_device_free(indio_dev);
378 /* Function to deinitialize the processing for usage id */
379 static int __devinit hid_magn_3d_remove(struct platform_device *pdev)
381 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
382 struct iio_dev *indio_dev = platform_get_drvdata(pdev);
384 sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_COMPASS_3D);
385 iio_device_unregister(indio_dev);
386 hid_sensor_remove_trigger(indio_dev);
387 iio_triggered_buffer_cleanup(indio_dev);
388 kfree(indio_dev->channels);
389 iio_device_free(indio_dev);
394 static struct platform_driver hid_magn_3d_platform_driver = {
397 .owner = THIS_MODULE,
399 .probe = hid_magn_3d_probe,
400 .remove = hid_magn_3d_remove,
402 module_platform_driver(hid_magn_3d_platform_driver);
404 MODULE_DESCRIPTION("HID Sensor Magnetometer 3D");
405 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
406 MODULE_LICENSE("GPL");