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 struct iio_buffer
*buffer
= indio_dev
->buffer
;
204 dev_dbg(&indio_dev
->dev
, "hid_sensor_push_data\n");
206 dev_err(&indio_dev
->dev
, "Buffer == NULL\n");
209 datum_sz
= buffer
->access
->get_bytes_per_datum(buffer
);
210 if (len
> datum_sz
) {
211 dev_err(&indio_dev
->dev
, "Datum size mismatch %d:%d\n", len
,
215 iio_push_to_buffer(buffer
, (u8
*)data
);
218 /* Callback handler to send event after all samples are received and captured */
219 static int magn_3d_proc_event(struct hid_sensor_hub_device
*hsdev
,
223 struct iio_dev
*indio_dev
= platform_get_drvdata(priv
);
224 struct magn_3d_state
*magn_state
= iio_priv(indio_dev
);
226 dev_dbg(&indio_dev
->dev
, "magn_3d_proc_event [%d]\n",
227 magn_state
->common_attributes
.data_ready
);
228 if (magn_state
->common_attributes
.data_ready
)
229 hid_sensor_push_data(indio_dev
,
230 (u8
*)magn_state
->magn_val
,
231 sizeof(magn_state
->magn_val
));
236 /* Capture samples in local storage */
237 static int magn_3d_capture_sample(struct hid_sensor_hub_device
*hsdev
,
239 size_t raw_len
, char *raw_data
,
242 struct iio_dev
*indio_dev
= platform_get_drvdata(priv
);
243 struct magn_3d_state
*magn_state
= iio_priv(indio_dev
);
248 case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS
:
249 case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Y_AXIS
:
250 case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Z_AXIS
:
251 offset
= usage_id
- HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS
;
252 magn_state
->magn_val
[CHANNEL_SCAN_INDEX_X
+ offset
] =
263 /* Parse report which is specific to an usage id*/
264 static int magn_3d_parse_report(struct platform_device
*pdev
,
265 struct hid_sensor_hub_device
*hsdev
,
266 struct iio_chan_spec
*channels
,
268 struct magn_3d_state
*st
)
273 for (i
= 0; i
<= CHANNEL_SCAN_INDEX_Z
; ++i
) {
274 ret
= sensor_hub_input_get_attribute_info(hsdev
,
277 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS
+ i
,
278 &st
->magn
[CHANNEL_SCAN_INDEX_X
+ i
]);
281 magn_3d_adjust_channel_bit_mask(channels
,
282 CHANNEL_SCAN_INDEX_X
+ i
,
283 st
->magn
[CHANNEL_SCAN_INDEX_X
+ i
].size
);
285 dev_dbg(&pdev
->dev
, "magn_3d %x:%x, %x:%x, %x:%x\n",
287 st
->magn
[0].report_id
,
288 st
->magn
[1].index
, st
->magn
[1].report_id
,
289 st
->magn
[2].index
, st
->magn
[2].report_id
);
294 /* Function to initialize the processing for usage id */
295 static int __devinit
hid_magn_3d_probe(struct platform_device
*pdev
)
298 static char *name
= "magn_3d";
299 struct iio_dev
*indio_dev
;
300 struct magn_3d_state
*magn_state
;
301 struct hid_sensor_hub_device
*hsdev
= pdev
->dev
.platform_data
;
302 struct iio_chan_spec
*channels
;
304 indio_dev
= iio_device_alloc(sizeof(struct magn_3d_state
));
305 if (indio_dev
== NULL
) {
309 platform_set_drvdata(pdev
, indio_dev
);
311 magn_state
= iio_priv(indio_dev
);
312 magn_state
->common_attributes
.hsdev
= hsdev
;
313 magn_state
->common_attributes
.pdev
= pdev
;
315 ret
= hid_sensor_parse_common_attributes(hsdev
,
316 HID_USAGE_SENSOR_COMPASS_3D
,
317 &magn_state
->common_attributes
);
319 dev_err(&pdev
->dev
, "failed to setup common attributes\n");
323 channels
= kmemdup(magn_3d_channels
,
324 sizeof(magn_3d_channels
),
327 dev_err(&pdev
->dev
, "failed to duplicate channels\n");
331 ret
= magn_3d_parse_report(pdev
, hsdev
, channels
,
332 HID_USAGE_SENSOR_COMPASS_3D
, magn_state
);
334 dev_err(&pdev
->dev
, "failed to setup attributes\n");
335 goto error_free_dev_mem
;
338 indio_dev
->channels
= channels
;
339 indio_dev
->num_channels
= ARRAY_SIZE(magn_3d_channels
);
340 indio_dev
->dev
.parent
= &pdev
->dev
;
341 indio_dev
->info
= &magn_3d_info
;
342 indio_dev
->name
= name
;
343 indio_dev
->modes
= INDIO_DIRECT_MODE
;
345 ret
= iio_triggered_buffer_setup(indio_dev
, &iio_pollfunc_store_time
,
348 dev_err(&pdev
->dev
, "failed to initialize trigger buffer\n");
349 goto error_free_dev_mem
;
351 magn_state
->common_attributes
.data_ready
= false;
352 ret
= hid_sensor_setup_trigger(indio_dev
, name
,
353 &magn_state
->common_attributes
);
355 dev_err(&pdev
->dev
, "trigger setup failed\n");
356 goto error_unreg_buffer_funcs
;
359 ret
= iio_device_register(indio_dev
);
361 dev_err(&pdev
->dev
, "device register failed\n");
362 goto error_remove_trigger
;
365 magn_state
->callbacks
.send_event
= magn_3d_proc_event
;
366 magn_state
->callbacks
.capture_sample
= magn_3d_capture_sample
;
367 magn_state
->callbacks
.pdev
= pdev
;
368 ret
= sensor_hub_register_callback(hsdev
, HID_USAGE_SENSOR_COMPASS_3D
,
369 &magn_state
->callbacks
);
371 dev_err(&pdev
->dev
, "callback reg failed\n");
372 goto error_iio_unreg
;
378 iio_device_unregister(indio_dev
);
379 error_remove_trigger
:
380 hid_sensor_remove_trigger(indio_dev
);
381 error_unreg_buffer_funcs
:
382 iio_triggered_buffer_cleanup(indio_dev
);
384 kfree(indio_dev
->channels
);
386 iio_device_free(indio_dev
);
391 /* Function to deinitialize the processing for usage id */
392 static int __devinit
hid_magn_3d_remove(struct platform_device
*pdev
)
394 struct hid_sensor_hub_device
*hsdev
= pdev
->dev
.platform_data
;
395 struct iio_dev
*indio_dev
= platform_get_drvdata(pdev
);
397 sensor_hub_remove_callback(hsdev
, HID_USAGE_SENSOR_COMPASS_3D
);
398 iio_device_unregister(indio_dev
);
399 hid_sensor_remove_trigger(indio_dev
);
400 iio_triggered_buffer_cleanup(indio_dev
);
401 kfree(indio_dev
->channels
);
402 iio_device_free(indio_dev
);
407 static struct platform_driver hid_magn_3d_platform_driver
= {
410 .owner
= THIS_MODULE
,
412 .probe
= hid_magn_3d_probe
,
413 .remove
= hid_magn_3d_remove
,
415 module_platform_driver(hid_magn_3d_platform_driver
);
417 MODULE_DESCRIPTION("HID Sensor Magnetometer 3D");
418 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
419 MODULE_LICENSE("GPL");