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 /*Format: HID-SENSOR-usage_id_in_hex*/
34 /*Usage ID from spec for Magnetometer-3D: 0x200083*/
35 #define DRIVER_NAME "HID-SENSOR-200083"
37 enum magn_3d_channel {
44 struct magn_3d_state {
45 struct hid_sensor_hub_callbacks callbacks;
46 struct hid_sensor_common common_attributes;
47 struct hid_sensor_hub_attribute_info magn[MAGN_3D_CHANNEL_MAX];
48 u32 magn_val[MAGN_3D_CHANNEL_MAX];
51 static const u32 magn_3d_addresses[MAGN_3D_CHANNEL_MAX] = {
52 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS,
53 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Y_AXIS,
54 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Z_AXIS
57 /* Channel definitions */
58 static const struct iio_chan_spec magn_3d_channels[] = {
62 .channel2 = IIO_MOD_X,
63 .info_mask = IIO_CHAN_INFO_OFFSET_SHARED_BIT |
64 IIO_CHAN_INFO_SCALE_SHARED_BIT |
65 IIO_CHAN_INFO_SAMP_FREQ_SHARED_BIT |
66 IIO_CHAN_INFO_HYSTERESIS_SHARED_BIT,
67 .scan_index = CHANNEL_SCAN_INDEX_X,
71 .channel2 = IIO_MOD_Y,
72 .info_mask = IIO_CHAN_INFO_OFFSET_SHARED_BIT |
73 IIO_CHAN_INFO_SCALE_SHARED_BIT |
74 IIO_CHAN_INFO_SAMP_FREQ_SHARED_BIT |
75 IIO_CHAN_INFO_HYSTERESIS_SHARED_BIT,
76 .scan_index = CHANNEL_SCAN_INDEX_Y,
80 .channel2 = IIO_MOD_Z,
81 .info_mask = IIO_CHAN_INFO_OFFSET_SHARED_BIT |
82 IIO_CHAN_INFO_SCALE_SHARED_BIT |
83 IIO_CHAN_INFO_SAMP_FREQ_SHARED_BIT |
84 IIO_CHAN_INFO_HYSTERESIS_SHARED_BIT,
85 .scan_index = CHANNEL_SCAN_INDEX_Z,
89 /* Adjust channel real bits based on report descriptor */
90 static void magn_3d_adjust_channel_bit_mask(struct iio_chan_spec *channels,
91 int channel, int size)
93 channels[channel].scan_type.sign = 's';
94 /* Real storage bits will change based on the report desc. */
95 channels[channel].scan_type.realbits = size * 8;
96 /* Maximum size of a sample to capture is u32 */
97 channels[channel].scan_type.storagebits = sizeof(u32) * 8;
100 /* Channel read_raw handler */
101 static int magn_3d_read_raw(struct iio_dev *indio_dev,
102 struct iio_chan_spec const *chan,
106 struct magn_3d_state *magn_state = iio_priv(indio_dev);
117 magn_state->magn[chan->scan_index].report_id;
118 address = magn_3d_addresses[chan->scan_index];
120 *val = sensor_hub_input_attr_get_raw_value(
121 magn_state->common_attributes.hsdev,
122 HID_USAGE_SENSOR_COMPASS_3D, address,
128 ret_type = IIO_VAL_INT;
130 case IIO_CHAN_INFO_SCALE:
131 *val = magn_state->magn[CHANNEL_SCAN_INDEX_X].units;
132 ret_type = IIO_VAL_INT;
134 case IIO_CHAN_INFO_OFFSET:
135 *val = hid_sensor_convert_exponent(
136 magn_state->magn[CHANNEL_SCAN_INDEX_X].unit_expo);
137 ret_type = IIO_VAL_INT;
139 case IIO_CHAN_INFO_SAMP_FREQ:
140 ret = hid_sensor_read_samp_freq_value(
141 &magn_state->common_attributes, val, val2);
142 ret_type = IIO_VAL_INT_PLUS_MICRO;
144 case IIO_CHAN_INFO_HYSTERESIS:
145 ret = hid_sensor_read_raw_hyst_value(
146 &magn_state->common_attributes, val, val2);
147 ret_type = IIO_VAL_INT_PLUS_MICRO;
157 /* Channel write_raw handler */
158 static int magn_3d_write_raw(struct iio_dev *indio_dev,
159 struct iio_chan_spec const *chan,
164 struct magn_3d_state *magn_state = iio_priv(indio_dev);
168 case IIO_CHAN_INFO_SAMP_FREQ:
169 ret = hid_sensor_write_samp_freq_value(
170 &magn_state->common_attributes, val, val2);
172 case IIO_CHAN_INFO_HYSTERESIS:
173 ret = hid_sensor_write_raw_hyst_value(
174 &magn_state->common_attributes, val, val2);
183 static int magn_3d_write_raw_get_fmt(struct iio_dev *indio_dev,
184 struct iio_chan_spec const *chan,
187 return IIO_VAL_INT_PLUS_MICRO;
190 static const struct iio_info magn_3d_info = {
191 .driver_module = THIS_MODULE,
192 .read_raw = &magn_3d_read_raw,
193 .write_raw = &magn_3d_write_raw,
194 .write_raw_get_fmt = &magn_3d_write_raw_get_fmt,
197 /* Function to push data to buffer */
198 static void hid_sensor_push_data(struct iio_dev *indio_dev, u8 *data, int len)
200 dev_dbg(&indio_dev->dev, "hid_sensor_push_data\n");
201 iio_push_to_buffers(indio_dev, (u8 *)data);
204 /* Callback handler to send event after all samples are received and captured */
205 static int magn_3d_proc_event(struct hid_sensor_hub_device *hsdev,
209 struct iio_dev *indio_dev = platform_get_drvdata(priv);
210 struct magn_3d_state *magn_state = iio_priv(indio_dev);
212 dev_dbg(&indio_dev->dev, "magn_3d_proc_event [%d]\n",
213 magn_state->common_attributes.data_ready);
214 if (magn_state->common_attributes.data_ready)
215 hid_sensor_push_data(indio_dev,
216 (u8 *)magn_state->magn_val,
217 sizeof(magn_state->magn_val));
222 /* Capture samples in local storage */
223 static int magn_3d_capture_sample(struct hid_sensor_hub_device *hsdev,
225 size_t raw_len, char *raw_data,
228 struct iio_dev *indio_dev = platform_get_drvdata(priv);
229 struct magn_3d_state *magn_state = iio_priv(indio_dev);
234 case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS:
235 case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Y_AXIS:
236 case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Z_AXIS:
237 offset = usage_id - HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS;
238 magn_state->magn_val[CHANNEL_SCAN_INDEX_X + offset] =
249 /* Parse report which is specific to an usage id*/
250 static int magn_3d_parse_report(struct platform_device *pdev,
251 struct hid_sensor_hub_device *hsdev,
252 struct iio_chan_spec *channels,
254 struct magn_3d_state *st)
259 for (i = 0; i <= CHANNEL_SCAN_INDEX_Z; ++i) {
260 ret = sensor_hub_input_get_attribute_info(hsdev,
263 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS + i,
264 &st->magn[CHANNEL_SCAN_INDEX_X + i]);
267 magn_3d_adjust_channel_bit_mask(channels,
268 CHANNEL_SCAN_INDEX_X + i,
269 st->magn[CHANNEL_SCAN_INDEX_X + i].size);
271 dev_dbg(&pdev->dev, "magn_3d %x:%x, %x:%x, %x:%x\n",
273 st->magn[0].report_id,
274 st->magn[1].index, st->magn[1].report_id,
275 st->magn[2].index, st->magn[2].report_id);
280 /* Function to initialize the processing for usage id */
281 static int hid_magn_3d_probe(struct platform_device *pdev)
284 static char *name = "magn_3d";
285 struct iio_dev *indio_dev;
286 struct magn_3d_state *magn_state;
287 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
288 struct iio_chan_spec *channels;
290 indio_dev = iio_device_alloc(sizeof(struct magn_3d_state));
291 if (indio_dev == NULL) {
295 platform_set_drvdata(pdev, indio_dev);
297 magn_state = iio_priv(indio_dev);
298 magn_state->common_attributes.hsdev = hsdev;
299 magn_state->common_attributes.pdev = pdev;
301 ret = hid_sensor_parse_common_attributes(hsdev,
302 HID_USAGE_SENSOR_COMPASS_3D,
303 &magn_state->common_attributes);
305 dev_err(&pdev->dev, "failed to setup common attributes\n");
309 channels = kmemdup(magn_3d_channels, sizeof(magn_3d_channels),
313 dev_err(&pdev->dev, "failed to duplicate channels\n");
317 ret = magn_3d_parse_report(pdev, hsdev, channels,
318 HID_USAGE_SENSOR_COMPASS_3D, magn_state);
320 dev_err(&pdev->dev, "failed to setup attributes\n");
321 goto error_free_dev_mem;
324 indio_dev->channels = channels;
325 indio_dev->num_channels = ARRAY_SIZE(magn_3d_channels);
326 indio_dev->dev.parent = &pdev->dev;
327 indio_dev->info = &magn_3d_info;
328 indio_dev->name = name;
329 indio_dev->modes = INDIO_DIRECT_MODE;
331 ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time,
334 dev_err(&pdev->dev, "failed to initialize trigger buffer\n");
335 goto error_free_dev_mem;
337 magn_state->common_attributes.data_ready = false;
338 ret = hid_sensor_setup_trigger(indio_dev, name,
339 &magn_state->common_attributes);
341 dev_err(&pdev->dev, "trigger setup failed\n");
342 goto error_unreg_buffer_funcs;
345 ret = iio_device_register(indio_dev);
347 dev_err(&pdev->dev, "device register failed\n");
348 goto error_remove_trigger;
351 magn_state->callbacks.send_event = magn_3d_proc_event;
352 magn_state->callbacks.capture_sample = magn_3d_capture_sample;
353 magn_state->callbacks.pdev = pdev;
354 ret = sensor_hub_register_callback(hsdev, HID_USAGE_SENSOR_COMPASS_3D,
355 &magn_state->callbacks);
357 dev_err(&pdev->dev, "callback reg failed\n");
358 goto error_iio_unreg;
364 iio_device_unregister(indio_dev);
365 error_remove_trigger:
366 hid_sensor_remove_trigger(indio_dev);
367 error_unreg_buffer_funcs:
368 iio_triggered_buffer_cleanup(indio_dev);
370 kfree(indio_dev->channels);
372 iio_device_free(indio_dev);
377 /* Function to deinitialize the processing for usage id */
378 static int hid_magn_3d_remove(struct platform_device *pdev)
380 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
381 struct iio_dev *indio_dev = platform_get_drvdata(pdev);
383 sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_COMPASS_3D);
384 iio_device_unregister(indio_dev);
385 hid_sensor_remove_trigger(indio_dev);
386 iio_triggered_buffer_cleanup(indio_dev);
387 kfree(indio_dev->channels);
388 iio_device_free(indio_dev);
393 static struct platform_driver hid_magn_3d_platform_driver = {
396 .owner = THIS_MODULE,
398 .probe = hid_magn_3d_probe,
399 .remove = hid_magn_3d_remove,
401 module_platform_driver(hid_magn_3d_platform_driver);
403 MODULE_DESCRIPTION("HID Sensor Magnetometer 3D");
404 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
405 MODULE_LICENSE("GPL");