blob: 8e75eb76ccd992729785c340e7eaea801026ec89 [file] [log] [blame]
srinivas pandruvadabc1d57ba2012-09-05 13:56:00 +01001/*
2 * HID Sensors Driver
3 * Copyright (c) 2012, Intel Corporation.
4 *
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.
8 *
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
12 * more details.
13 *
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.
17 *
18 */
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"
33
34/*Format: HID-SENSOR-usage_id_in_hex*/
35/*Usage ID from spec for Magnetometer-3D: 0x200083*/
36#define DRIVER_NAME "HID-SENSOR-200083"
37
38enum magn_3d_channel {
39 CHANNEL_SCAN_INDEX_X,
40 CHANNEL_SCAN_INDEX_Y,
41 CHANNEL_SCAN_INDEX_Z,
42 MAGN_3D_CHANNEL_MAX,
43};
44
45struct 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];
50};
51
52static 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
56};
57
58/* Channel definitions */
59static const struct iio_chan_spec magn_3d_channels[] = {
60 {
61 .type = IIO_MAGN,
62 .modified = 1,
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,
69 }, {
70 .type = IIO_MAGN,
71 .modified = 1,
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,
78 }, {
79 .type = IIO_MAGN,
80 .modified = 1,
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,
87 }
88};
89
90/* Adjust channel real bits based on report descriptor */
91static void magn_3d_adjust_channel_bit_mask(struct iio_chan_spec *channels,
92 int channel, int size)
93{
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;
99}
100
101/* Channel read_raw handler */
102static int magn_3d_read_raw(struct iio_dev *indio_dev,
103 struct iio_chan_spec const *chan,
104 int *val, int *val2,
105 long mask)
106{
107 struct magn_3d_state *magn_state = iio_priv(indio_dev);
108 int report_id = -1;
109 u32 address;
110 int ret;
111 int ret_type;
112
113 *val = 0;
114 *val2 = 0;
115 switch (mask) {
116 case 0:
117 report_id =
118 magn_state->magn[chan->scan_index].report_id;
119 address = magn_3d_addresses[chan->scan_index];
120 if (report_id >= 0)
121 *val = sensor_hub_input_attr_get_raw_value(
122 magn_state->common_attributes.hsdev,
123 HID_USAGE_SENSOR_COMPASS_3D, address,
124 report_id);
125 else {
126 *val = 0;
127 return -EINVAL;
128 }
129 ret_type = IIO_VAL_INT;
130 break;
131 case IIO_CHAN_INFO_SCALE:
132 *val = magn_state->magn[CHANNEL_SCAN_INDEX_X].units;
133 ret_type = IIO_VAL_INT;
134 break;
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;
139 break;
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;
144 break;
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;
149 break;
150 default:
151 ret_type = -EINVAL;
152 break;
153 }
154
155 return ret_type;
156}
157
158/* Channel write_raw handler */
159static int magn_3d_write_raw(struct iio_dev *indio_dev,
160 struct iio_chan_spec const *chan,
161 int val,
162 int val2,
163 long mask)
164{
165 struct magn_3d_state *magn_state = iio_priv(indio_dev);
166 int ret = 0;
167
168 switch (mask) {
169 case IIO_CHAN_INFO_SAMP_FREQ:
170 ret = hid_sensor_write_samp_freq_value(
171 &magn_state->common_attributes, val, val2);
172 break;
173 case IIO_CHAN_INFO_HYSTERESIS:
174 ret = hid_sensor_write_raw_hyst_value(
175 &magn_state->common_attributes, val, val2);
176 break;
177 default:
178 ret = -EINVAL;
179 }
180
181 return ret;
182}
183
184static int magn_3d_write_raw_get_fmt(struct iio_dev *indio_dev,
185 struct iio_chan_spec const *chan,
186 long mask)
187{
188 return IIO_VAL_INT_PLUS_MICRO;
189}
190
191static 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,
196};
197
198/* Function to push data to buffer */
199static void hid_sensor_push_data(struct iio_dev *indio_dev, u8 *data, int len)
200{
srinivas pandruvadabc1d57ba2012-09-05 13:56:00 +0100201 dev_dbg(&indio_dev->dev, "hid_sensor_push_data\n");
Jonathan Cameron84b36ce2012-06-30 20:06:00 +0100202 iio_push_to_buffers(indio_dev, (u8 *)data);
srinivas pandruvadabc1d57ba2012-09-05 13:56:00 +0100203}
204
205/* Callback handler to send event after all samples are received and captured */
206static int magn_3d_proc_event(struct hid_sensor_hub_device *hsdev,
207 unsigned usage_id,
208 void *priv)
209{
210 struct iio_dev *indio_dev = platform_get_drvdata(priv);
211 struct magn_3d_state *magn_state = iio_priv(indio_dev);
212
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));
219
220 return 0;
221}
222
223/* Capture samples in local storage */
224static int magn_3d_capture_sample(struct hid_sensor_hub_device *hsdev,
225 unsigned usage_id,
226 size_t raw_len, char *raw_data,
227 void *priv)
228{
229 struct iio_dev *indio_dev = platform_get_drvdata(priv);
230 struct magn_3d_state *magn_state = iio_priv(indio_dev);
231 int offset;
232 int ret = -EINVAL;
233
234 switch (usage_id) {
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] =
240 *(u32 *)raw_data;
241 ret = 0;
242 break;
243 default:
244 break;
245 }
246
247 return ret;
248}
249
250/* Parse report which is specific to an usage id*/
251static int magn_3d_parse_report(struct platform_device *pdev,
252 struct hid_sensor_hub_device *hsdev,
253 struct iio_chan_spec *channels,
254 unsigned usage_id,
255 struct magn_3d_state *st)
256{
257 int ret;
258 int i;
259
260 for (i = 0; i <= CHANNEL_SCAN_INDEX_Z; ++i) {
261 ret = sensor_hub_input_get_attribute_info(hsdev,
262 HID_INPUT_REPORT,
263 usage_id,
264 HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS + i,
265 &st->magn[CHANNEL_SCAN_INDEX_X + i]);
266 if (ret < 0)
267 break;
268 magn_3d_adjust_channel_bit_mask(channels,
269 CHANNEL_SCAN_INDEX_X + i,
270 st->magn[CHANNEL_SCAN_INDEX_X + i].size);
271 }
272 dev_dbg(&pdev->dev, "magn_3d %x:%x, %x:%x, %x:%x\n",
273 st->magn[0].index,
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);
277
278 return ret;
279}
280
281/* Function to initialize the processing for usage id */
282static int __devinit hid_magn_3d_probe(struct platform_device *pdev)
283{
284 int ret = 0;
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;
290
291 indio_dev = iio_device_alloc(sizeof(struct magn_3d_state));
292 if (indio_dev == NULL) {
293 ret = -ENOMEM;
294 goto error_ret;
295 }
296 platform_set_drvdata(pdev, indio_dev);
297
298 magn_state = iio_priv(indio_dev);
299 magn_state->common_attributes.hsdev = hsdev;
300 magn_state->common_attributes.pdev = pdev;
301
302 ret = hid_sensor_parse_common_attributes(hsdev,
303 HID_USAGE_SENSOR_COMPASS_3D,
304 &magn_state->common_attributes);
305 if (ret) {
306 dev_err(&pdev->dev, "failed to setup common attributes\n");
307 goto error_free_dev;
308 }
309
Axel Lin64ebe952012-10-27 16:03:00 +0100310 channels = kmemdup(magn_3d_channels, sizeof(magn_3d_channels),
311 GFP_KERNEL);
srinivas pandruvadabc1d57ba2012-09-05 13:56:00 +0100312 if (!channels) {
Axel Lin64ebe952012-10-27 16:03:00 +0100313 ret = -ENOMEM;
srinivas pandruvadabc1d57ba2012-09-05 13:56:00 +0100314 dev_err(&pdev->dev, "failed to duplicate channels\n");
315 goto error_free_dev;
316 }
317
318 ret = magn_3d_parse_report(pdev, hsdev, channels,
319 HID_USAGE_SENSOR_COMPASS_3D, magn_state);
320 if (ret) {
321 dev_err(&pdev->dev, "failed to setup attributes\n");
322 goto error_free_dev_mem;
323 }
324
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;
331
332 ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time,
333 NULL, NULL);
334 if (ret) {
335 dev_err(&pdev->dev, "failed to initialize trigger buffer\n");
336 goto error_free_dev_mem;
337 }
338 magn_state->common_attributes.data_ready = false;
339 ret = hid_sensor_setup_trigger(indio_dev, name,
340 &magn_state->common_attributes);
341 if (ret < 0) {
342 dev_err(&pdev->dev, "trigger setup failed\n");
343 goto error_unreg_buffer_funcs;
344 }
345
346 ret = iio_device_register(indio_dev);
347 if (ret) {
348 dev_err(&pdev->dev, "device register failed\n");
349 goto error_remove_trigger;
350 }
351
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);
357 if (ret < 0) {
358 dev_err(&pdev->dev, "callback reg failed\n");
359 goto error_iio_unreg;
360 }
361
362 return ret;
363
364error_iio_unreg:
365 iio_device_unregister(indio_dev);
366error_remove_trigger:
367 hid_sensor_remove_trigger(indio_dev);
368error_unreg_buffer_funcs:
369 iio_triggered_buffer_cleanup(indio_dev);
370error_free_dev_mem:
371 kfree(indio_dev->channels);
372error_free_dev:
373 iio_device_free(indio_dev);
374error_ret:
375 return ret;
376}
377
378/* Function to deinitialize the processing for usage id */
379static int __devinit hid_magn_3d_remove(struct platform_device *pdev)
380{
381 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
382 struct iio_dev *indio_dev = platform_get_drvdata(pdev);
383
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);
390
391 return 0;
392}
393
394static struct platform_driver hid_magn_3d_platform_driver = {
395 .driver = {
396 .name = DRIVER_NAME,
397 .owner = THIS_MODULE,
398 },
399 .probe = hid_magn_3d_probe,
400 .remove = hid_magn_3d_remove,
401};
402module_platform_driver(hid_magn_3d_platform_driver);
403
404MODULE_DESCRIPTION("HID Sensor Magnetometer 3D");
405MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
406MODULE_LICENSE("GPL");