1 /*
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/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"
33
34 enum gyro_3d_channel {
35 CHANNEL_SCAN_INDEX_X,
36 CHANNEL_SCAN_INDEX_Y,
37 CHANNEL_SCAN_INDEX_Z,
38 GYRO_3D_CHANNEL_MAX,
39 };
40
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];
46 int scale_pre_decml;
47 int scale_post_decml;
48 int scale_precision;
49 int value_offset;
50 };
51
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
56 };
57
58 /* Channel definitions */
59 static const struct iio_chan_spec gyro_3d_channels[] = {
60 {
61 .type = IIO_ANGL_VEL,
62 .modified = 1,
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,
70 }, {
71 .type = IIO_ANGL_VEL,
72 .modified = 1,
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,
80 }, {
81 .type = IIO_ANGL_VEL,
82 .modified = 1,
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,
90 }
91 };
92
93 /* Adjust channel real bits based on report descriptor */
gyro_3d_adjust_channel_bit_mask(struct iio_chan_spec * channels,int channel,int size)94 static void gyro_3d_adjust_channel_bit_mask(struct iio_chan_spec *channels,
95 int channel, int size)
96 {
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;
102 }
103
104 /* Channel read_raw handler */
gyro_3d_read_raw(struct iio_dev * indio_dev,struct iio_chan_spec const * chan,int * val,int * val2,long mask)105 static int gyro_3d_read_raw(struct iio_dev *indio_dev,
106 struct iio_chan_spec const *chan,
107 int *val, int *val2,
108 long mask)
109 {
110 struct gyro_3d_state *gyro_state = iio_priv(indio_dev);
111 int report_id = -1;
112 u32 address;
113 int ret_type;
114 s32 poll_value;
115
116 *val = 0;
117 *val2 = 0;
118 switch (mask) {
119 case 0:
120 poll_value = hid_sensor_read_poll_value(
121 &gyro_state->common_attributes);
122 if (poll_value < 0)
123 return -EINVAL;
124
125 hid_sensor_power_state(&gyro_state->common_attributes, true);
126 msleep_interruptible(poll_value * 2);
127 report_id = gyro_state->gyro[chan->scan_index].report_id;
128 address = gyro_3d_addresses[chan->scan_index];
129 if (report_id >= 0)
130 *val = sensor_hub_input_attr_get_raw_value(
131 gyro_state->common_attributes.hsdev,
132 HID_USAGE_SENSOR_GYRO_3D, address,
133 report_id);
134 else {
135 *val = 0;
136 hid_sensor_power_state(&gyro_state->common_attributes,
137 false);
138 return -EINVAL;
139 }
140 hid_sensor_power_state(&gyro_state->common_attributes, false);
141 ret_type = IIO_VAL_INT;
142 break;
143 case IIO_CHAN_INFO_SCALE:
144 *val = gyro_state->scale_pre_decml;
145 *val2 = gyro_state->scale_post_decml;
146 ret_type = gyro_state->scale_precision;
147 break;
148 case IIO_CHAN_INFO_OFFSET:
149 *val = gyro_state->value_offset;
150 ret_type = IIO_VAL_INT;
151 break;
152 case IIO_CHAN_INFO_SAMP_FREQ:
153 ret_type = hid_sensor_read_samp_freq_value(
154 &gyro_state->common_attributes, val, val2);
155 break;
156 case IIO_CHAN_INFO_HYSTERESIS:
157 ret_type = hid_sensor_read_raw_hyst_value(
158 &gyro_state->common_attributes, val, val2);
159 break;
160 default:
161 ret_type = -EINVAL;
162 break;
163 }
164
165 return ret_type;
166 }
167
168 /* Channel write_raw handler */
gyro_3d_write_raw(struct iio_dev * indio_dev,struct iio_chan_spec const * chan,int val,int val2,long mask)169 static int gyro_3d_write_raw(struct iio_dev *indio_dev,
170 struct iio_chan_spec const *chan,
171 int val,
172 int val2,
173 long mask)
174 {
175 struct gyro_3d_state *gyro_state = iio_priv(indio_dev);
176 int ret = 0;
177
178 switch (mask) {
179 case IIO_CHAN_INFO_SAMP_FREQ:
180 ret = hid_sensor_write_samp_freq_value(
181 &gyro_state->common_attributes, val, val2);
182 break;
183 case IIO_CHAN_INFO_HYSTERESIS:
184 ret = hid_sensor_write_raw_hyst_value(
185 &gyro_state->common_attributes, val, val2);
186 break;
187 default:
188 ret = -EINVAL;
189 }
190
191 return ret;
192 }
193
194 static const struct iio_info gyro_3d_info = {
195 .driver_module = THIS_MODULE,
196 .read_raw = &gyro_3d_read_raw,
197 .write_raw = &gyro_3d_write_raw,
198 };
199
200 /* Function to push data to buffer */
hid_sensor_push_data(struct iio_dev * indio_dev,const void * data,int len)201 static void hid_sensor_push_data(struct iio_dev *indio_dev, const void *data,
202 int len)
203 {
204 dev_dbg(&indio_dev->dev, "hid_sensor_push_data\n");
205 iio_push_to_buffers(indio_dev, data);
206 }
207
208 /* Callback handler to send event after all samples are received and captured */
gyro_3d_proc_event(struct hid_sensor_hub_device * hsdev,unsigned usage_id,void * priv)209 static int gyro_3d_proc_event(struct hid_sensor_hub_device *hsdev,
210 unsigned usage_id,
211 void *priv)
212 {
213 struct iio_dev *indio_dev = platform_get_drvdata(priv);
214 struct gyro_3d_state *gyro_state = iio_priv(indio_dev);
215
216 dev_dbg(&indio_dev->dev, "gyro_3d_proc_event\n");
217 if (atomic_read(&gyro_state->common_attributes.data_ready))
218 hid_sensor_push_data(indio_dev,
219 gyro_state->gyro_val,
220 sizeof(gyro_state->gyro_val));
221
222 return 0;
223 }
224
225 /* Capture samples in local storage */
gyro_3d_capture_sample(struct hid_sensor_hub_device * hsdev,unsigned usage_id,size_t raw_len,char * raw_data,void * priv)226 static int gyro_3d_capture_sample(struct hid_sensor_hub_device *hsdev,
227 unsigned usage_id,
228 size_t raw_len, char *raw_data,
229 void *priv)
230 {
231 struct iio_dev *indio_dev = platform_get_drvdata(priv);
232 struct gyro_3d_state *gyro_state = iio_priv(indio_dev);
233 int offset;
234 int ret = -EINVAL;
235
236 switch (usage_id) {
237 case HID_USAGE_SENSOR_ANGL_VELOCITY_X_AXIS:
238 case HID_USAGE_SENSOR_ANGL_VELOCITY_Y_AXIS:
239 case HID_USAGE_SENSOR_ANGL_VELOCITY_Z_AXIS:
240 offset = usage_id - HID_USAGE_SENSOR_ANGL_VELOCITY_X_AXIS;
241 gyro_state->gyro_val[CHANNEL_SCAN_INDEX_X + offset] =
242 *(u32 *)raw_data;
243 ret = 0;
244 break;
245 default:
246 break;
247 }
248
249 return ret;
250 }
251
252 /* Parse report which is specific to an usage id*/
gyro_3d_parse_report(struct platform_device * pdev,struct hid_sensor_hub_device * hsdev,struct iio_chan_spec * channels,unsigned usage_id,struct gyro_3d_state * st)253 static int gyro_3d_parse_report(struct platform_device *pdev,
254 struct hid_sensor_hub_device *hsdev,
255 struct iio_chan_spec *channels,
256 unsigned usage_id,
257 struct gyro_3d_state *st)
258 {
259 int ret;
260 int i;
261
262 for (i = 0; i <= CHANNEL_SCAN_INDEX_Z; ++i) {
263 ret = sensor_hub_input_get_attribute_info(hsdev,
264 HID_INPUT_REPORT,
265 usage_id,
266 HID_USAGE_SENSOR_ANGL_VELOCITY_X_AXIS + i,
267 &st->gyro[CHANNEL_SCAN_INDEX_X + i]);
268 if (ret < 0)
269 break;
270 gyro_3d_adjust_channel_bit_mask(channels,
271 CHANNEL_SCAN_INDEX_X + i,
272 st->gyro[CHANNEL_SCAN_INDEX_X + i].size);
273 }
274 dev_dbg(&pdev->dev, "gyro_3d %x:%x, %x:%x, %x:%x\n",
275 st->gyro[0].index,
276 st->gyro[0].report_id,
277 st->gyro[1].index, st->gyro[1].report_id,
278 st->gyro[2].index, st->gyro[2].report_id);
279
280 st->scale_precision = hid_sensor_format_scale(
281 HID_USAGE_SENSOR_GYRO_3D,
282 &st->gyro[CHANNEL_SCAN_INDEX_X],
283 &st->scale_pre_decml, &st->scale_post_decml);
284
285 /* Set Sensitivity field ids, when there is no individual modifier */
286 if (st->common_attributes.sensitivity.index < 0) {
287 sensor_hub_input_get_attribute_info(hsdev,
288 HID_FEATURE_REPORT, usage_id,
289 HID_USAGE_SENSOR_DATA_MOD_CHANGE_SENSITIVITY_ABS |
290 HID_USAGE_SENSOR_DATA_ANGL_VELOCITY,
291 &st->common_attributes.sensitivity);
292 dev_dbg(&pdev->dev, "Sensitivity index:report %d:%d\n",
293 st->common_attributes.sensitivity.index,
294 st->common_attributes.sensitivity.report_id);
295 }
296 return ret;
297 }
298
299 /* Function to initialize the processing for usage id */
hid_gyro_3d_probe(struct platform_device * pdev)300 static int hid_gyro_3d_probe(struct platform_device *pdev)
301 {
302 int ret = 0;
303 static const char *name = "gyro_3d";
304 struct iio_dev *indio_dev;
305 struct gyro_3d_state *gyro_state;
306 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
307
308 indio_dev = devm_iio_device_alloc(&pdev->dev, sizeof(*gyro_state));
309 if (!indio_dev)
310 return -ENOMEM;
311 platform_set_drvdata(pdev, indio_dev);
312
313 gyro_state = iio_priv(indio_dev);
314 gyro_state->common_attributes.hsdev = hsdev;
315 gyro_state->common_attributes.pdev = pdev;
316
317 ret = hid_sensor_parse_common_attributes(hsdev,
318 HID_USAGE_SENSOR_GYRO_3D,
319 &gyro_state->common_attributes);
320 if (ret) {
321 dev_err(&pdev->dev, "failed to setup common attributes\n");
322 return ret;
323 }
324
325 indio_dev->channels = kmemdup(gyro_3d_channels,
326 sizeof(gyro_3d_channels), GFP_KERNEL);
327 if (!indio_dev->channels) {
328 dev_err(&pdev->dev, "failed to duplicate channels\n");
329 return -ENOMEM;
330 }
331
332 ret = gyro_3d_parse_report(pdev, hsdev,
333 (struct iio_chan_spec *)indio_dev->channels,
334 HID_USAGE_SENSOR_GYRO_3D, gyro_state);
335 if (ret) {
336 dev_err(&pdev->dev, "failed to setup attributes\n");
337 goto error_free_dev_mem;
338 }
339
340 indio_dev->num_channels = ARRAY_SIZE(gyro_3d_channels);
341 indio_dev->dev.parent = &pdev->dev;
342 indio_dev->info = &gyro_3d_info;
343 indio_dev->name = name;
344 indio_dev->modes = INDIO_DIRECT_MODE;
345
346 ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time,
347 NULL, NULL);
348 if (ret) {
349 dev_err(&pdev->dev, "failed to initialize trigger buffer\n");
350 goto error_free_dev_mem;
351 }
352 atomic_set(&gyro_state->common_attributes.data_ready, 0);
353 ret = hid_sensor_setup_trigger(indio_dev, name,
354 &gyro_state->common_attributes);
355 if (ret < 0) {
356 dev_err(&pdev->dev, "trigger setup failed\n");
357 goto error_unreg_buffer_funcs;
358 }
359
360 ret = iio_device_register(indio_dev);
361 if (ret) {
362 dev_err(&pdev->dev, "device register failed\n");
363 goto error_remove_trigger;
364 }
365
366 gyro_state->callbacks.send_event = gyro_3d_proc_event;
367 gyro_state->callbacks.capture_sample = gyro_3d_capture_sample;
368 gyro_state->callbacks.pdev = pdev;
369 ret = sensor_hub_register_callback(hsdev, HID_USAGE_SENSOR_GYRO_3D,
370 &gyro_state->callbacks);
371 if (ret < 0) {
372 dev_err(&pdev->dev, "callback reg failed\n");
373 goto error_iio_unreg;
374 }
375
376 return ret;
377
378 error_iio_unreg:
379 iio_device_unregister(indio_dev);
380 error_remove_trigger:
381 hid_sensor_remove_trigger(&gyro_state->common_attributes);
382 error_unreg_buffer_funcs:
383 iio_triggered_buffer_cleanup(indio_dev);
384 error_free_dev_mem:
385 kfree(indio_dev->channels);
386 return ret;
387 }
388
389 /* Function to deinitialize the processing for usage id */
hid_gyro_3d_remove(struct platform_device * pdev)390 static int hid_gyro_3d_remove(struct platform_device *pdev)
391 {
392 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
393 struct iio_dev *indio_dev = platform_get_drvdata(pdev);
394 struct gyro_3d_state *gyro_state = iio_priv(indio_dev);
395
396 sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_GYRO_3D);
397 iio_device_unregister(indio_dev);
398 hid_sensor_remove_trigger(&gyro_state->common_attributes);
399 iio_triggered_buffer_cleanup(indio_dev);
400 kfree(indio_dev->channels);
401
402 return 0;
403 }
404
405 static struct platform_device_id hid_gyro_3d_ids[] = {
406 {
407 /* Format: HID-SENSOR-usage_id_in_hex_lowercase */
408 .name = "HID-SENSOR-200076",
409 },
410 { /* sentinel */ }
411 };
412 MODULE_DEVICE_TABLE(platform, hid_gyro_3d_ids);
413
414 static struct platform_driver hid_gyro_3d_platform_driver = {
415 .id_table = hid_gyro_3d_ids,
416 .driver = {
417 .name = KBUILD_MODNAME,
418 },
419 .probe = hid_gyro_3d_probe,
420 .remove = hid_gyro_3d_remove,
421 };
422 module_platform_driver(hid_gyro_3d_platform_driver);
423
424 MODULE_DESCRIPTION("HID Sensor Gyroscope 3D");
425 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
426 MODULE_LICENSE("GPL");
427