Commit | Line | Data |
---|---|---|
a61127c2 | 1 | // SPDX-License-Identifier: GPL-2.0-only |
c5bdbef7 | 2 | /* |
3 | * HID Sensors Driver | |
4 | * Copyright (c) 2012, Intel Corporation. | |
c5bdbef7 | 5 | */ |
6 | #include <linux/device.h> | |
7 | #include <linux/platform_device.h> | |
8 | #include <linux/module.h> | |
fb226ae7 | 9 | #include <linux/mod_devicetable.h> |
c5bdbef7 | 10 | #include <linux/slab.h> |
11 | #include <linux/hid-sensor-hub.h> | |
12 | #include <linux/iio/iio.h> | |
c5bdbef7 | 13 | #include <linux/iio/buffer.h> |
c5bdbef7 | 14 | #include "../common/hid-sensors/hid-sensor-trigger.h" |
15 | ||
c5bdbef7 | 16 | enum gyro_3d_channel { |
17 | CHANNEL_SCAN_INDEX_X, | |
18 | CHANNEL_SCAN_INDEX_Y, | |
19 | CHANNEL_SCAN_INDEX_Z, | |
20 | GYRO_3D_CHANNEL_MAX, | |
21 | }; | |
22 | ||
4648cbd8 | 23 | #define CHANNEL_SCAN_INDEX_TIMESTAMP GYRO_3D_CHANNEL_MAX |
c5bdbef7 | 24 | struct gyro_3d_state { |
25 | struct hid_sensor_hub_callbacks callbacks; | |
e07c6d17 | 26 | struct hid_sensor_common common_attributes; |
c5bdbef7 | 27 | struct hid_sensor_hub_attribute_info gyro[GYRO_3D_CHANNEL_MAX]; |
4648cbd8 YX |
28 | struct { |
29 | u32 gyro_val[GYRO_3D_CHANNEL_MAX]; | |
30 | u64 timestamp __aligned(8); | |
31 | } scan; | |
6c7db77e SP |
32 | int scale_pre_decml; |
33 | int scale_post_decml; | |
34 | int scale_precision; | |
35 | int value_offset; | |
4648cbd8 | 36 | s64 timestamp; |
c5bdbef7 | 37 | }; |
38 | ||
39 | static const u32 gyro_3d_addresses[GYRO_3D_CHANNEL_MAX] = { | |
40 | HID_USAGE_SENSOR_ANGL_VELOCITY_X_AXIS, | |
41 | HID_USAGE_SENSOR_ANGL_VELOCITY_Y_AXIS, | |
42 | HID_USAGE_SENSOR_ANGL_VELOCITY_Z_AXIS | |
43 | }; | |
44 | ||
0e41fd51 YX |
45 | static const u32 gryo_3d_sensitivity_addresses[] = { |
46 | HID_USAGE_SENSOR_DATA_ANGL_VELOCITY, | |
47 | }; | |
48 | ||
c5bdbef7 | 49 | /* Channel definitions */ |
50 | static const struct iio_chan_spec gyro_3d_channels[] = { | |
51 | { | |
52 | .type = IIO_ANGL_VEL, | |
53 | .modified = 1, | |
54 | .channel2 = IIO_MOD_X, | |
0964f706 | 55 | .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), |
ecbe18f2 JC |
56 | .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) | |
57 | BIT(IIO_CHAN_INFO_SCALE) | | |
58 | BIT(IIO_CHAN_INFO_SAMP_FREQ) | | |
59 | BIT(IIO_CHAN_INFO_HYSTERESIS), | |
c5bdbef7 | 60 | .scan_index = CHANNEL_SCAN_INDEX_X, |
61 | }, { | |
62 | .type = IIO_ANGL_VEL, | |
63 | .modified = 1, | |
64 | .channel2 = IIO_MOD_Y, | |
0964f706 | 65 | .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), |
ecbe18f2 JC |
66 | .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) | |
67 | BIT(IIO_CHAN_INFO_SCALE) | | |
68 | BIT(IIO_CHAN_INFO_SAMP_FREQ) | | |
69 | BIT(IIO_CHAN_INFO_HYSTERESIS), | |
c5bdbef7 | 70 | .scan_index = CHANNEL_SCAN_INDEX_Y, |
71 | }, { | |
72 | .type = IIO_ANGL_VEL, | |
73 | .modified = 1, | |
74 | .channel2 = IIO_MOD_Z, | |
0964f706 | 75 | .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), |
ecbe18f2 JC |
76 | .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) | |
77 | BIT(IIO_CHAN_INFO_SCALE) | | |
78 | BIT(IIO_CHAN_INFO_SAMP_FREQ) | | |
79 | BIT(IIO_CHAN_INFO_HYSTERESIS), | |
c5bdbef7 | 80 | .scan_index = CHANNEL_SCAN_INDEX_Z, |
4648cbd8 YX |
81 | }, |
82 | IIO_CHAN_SOFT_TIMESTAMP(CHANNEL_SCAN_INDEX_TIMESTAMP) | |
c5bdbef7 | 83 | }; |
84 | ||
85 | /* Adjust channel real bits based on report descriptor */ | |
86 | static void gyro_3d_adjust_channel_bit_mask(struct iio_chan_spec *channels, | |
87 | int channel, int size) | |
88 | { | |
89 | channels[channel].scan_type.sign = 's'; | |
90 | /* Real storage bits will change based on the report desc. */ | |
91 | channels[channel].scan_type.realbits = size * 8; | |
92 | /* Maximum size of a sample to capture is u32 */ | |
93 | channels[channel].scan_type.storagebits = sizeof(u32) * 8; | |
94 | } | |
95 | ||
96 | /* Channel read_raw handler */ | |
97 | static int gyro_3d_read_raw(struct iio_dev *indio_dev, | |
98 | struct iio_chan_spec const *chan, | |
99 | int *val, int *val2, | |
100 | long mask) | |
101 | { | |
102 | struct gyro_3d_state *gyro_state = iio_priv(indio_dev); | |
103 | int report_id = -1; | |
104 | u32 address; | |
c5bdbef7 | 105 | int ret_type; |
0145b505 | 106 | s32 min; |
c5bdbef7 | 107 | |
108 | *val = 0; | |
109 | *val2 = 0; | |
110 | switch (mask) { | |
67464a54 | 111 | case IIO_CHAN_INFO_RAW: |
0964f706 | 112 | hid_sensor_power_state(&gyro_state->common_attributes, true); |
c5bdbef7 | 113 | report_id = gyro_state->gyro[chan->scan_index].report_id; |
0145b505 | 114 | min = gyro_state->gyro[chan->scan_index].logical_minimum; |
c5bdbef7 | 115 | address = gyro_3d_addresses[chan->scan_index]; |
116 | if (report_id >= 0) | |
117 | *val = sensor_hub_input_attr_get_raw_value( | |
0964f706 SP |
118 | gyro_state->common_attributes.hsdev, |
119 | HID_USAGE_SENSOR_GYRO_3D, address, | |
b3f4737d | 120 | report_id, |
0145b505 HG |
121 | SENSOR_HUB_SYNC, |
122 | min < 0); | |
c5bdbef7 | 123 | else { |
124 | *val = 0; | |
0964f706 SP |
125 | hid_sensor_power_state(&gyro_state->common_attributes, |
126 | false); | |
c5bdbef7 | 127 | return -EINVAL; |
128 | } | |
0964f706 | 129 | hid_sensor_power_state(&gyro_state->common_attributes, false); |
c5bdbef7 | 130 | ret_type = IIO_VAL_INT; |
131 | break; | |
132 | case IIO_CHAN_INFO_SCALE: | |
6c7db77e SP |
133 | *val = gyro_state->scale_pre_decml; |
134 | *val2 = gyro_state->scale_post_decml; | |
135 | ret_type = gyro_state->scale_precision; | |
c5bdbef7 | 136 | break; |
137 | case IIO_CHAN_INFO_OFFSET: | |
6c7db77e | 138 | *val = gyro_state->value_offset; |
c5bdbef7 | 139 | ret_type = IIO_VAL_INT; |
140 | break; | |
141 | case IIO_CHAN_INFO_SAMP_FREQ: | |
27793803 | 142 | ret_type = hid_sensor_read_samp_freq_value( |
c5bdbef7 | 143 | &gyro_state->common_attributes, val, val2); |
c5bdbef7 | 144 | break; |
145 | case IIO_CHAN_INFO_HYSTERESIS: | |
27793803 | 146 | ret_type = hid_sensor_read_raw_hyst_value( |
c5bdbef7 | 147 | &gyro_state->common_attributes, val, val2); |
c5bdbef7 | 148 | break; |
149 | default: | |
150 | ret_type = -EINVAL; | |
151 | break; | |
152 | } | |
153 | ||
154 | return ret_type; | |
155 | } | |
156 | ||
157 | /* Channel write_raw handler */ | |
158 | static int gyro_3d_write_raw(struct iio_dev *indio_dev, | |
159 | struct iio_chan_spec const *chan, | |
160 | int val, | |
161 | int val2, | |
162 | long mask) | |
163 | { | |
164 | struct gyro_3d_state *gyro_state = iio_priv(indio_dev); | |
165 | int ret = 0; | |
166 | ||
167 | switch (mask) { | |
168 | case IIO_CHAN_INFO_SAMP_FREQ: | |
169 | ret = hid_sensor_write_samp_freq_value( | |
170 | &gyro_state->common_attributes, val, val2); | |
171 | break; | |
172 | case IIO_CHAN_INFO_HYSTERESIS: | |
173 | ret = hid_sensor_write_raw_hyst_value( | |
174 | &gyro_state->common_attributes, val, val2); | |
175 | break; | |
176 | default: | |
177 | ret = -EINVAL; | |
178 | } | |
179 | ||
180 | return ret; | |
181 | } | |
182 | ||
c5bdbef7 | 183 | static const struct iio_info gyro_3d_info = { |
c5bdbef7 | 184 | .read_raw = &gyro_3d_read_raw, |
185 | .write_raw = &gyro_3d_write_raw, | |
c5bdbef7 | 186 | }; |
187 | ||
c5bdbef7 | 188 | /* Callback handler to send event after all samples are received and captured */ |
189 | static int gyro_3d_proc_event(struct hid_sensor_hub_device *hsdev, | |
190 | unsigned usage_id, | |
191 | void *priv) | |
192 | { | |
193 | struct iio_dev *indio_dev = platform_get_drvdata(priv); | |
194 | struct gyro_3d_state *gyro_state = iio_priv(indio_dev); | |
195 | ||
56ff6be6 | 196 | dev_dbg(&indio_dev->dev, "gyro_3d_proc_event\n"); |
4648cbd8 YX |
197 | if (atomic_read(&gyro_state->common_attributes.data_ready)) { |
198 | if (!gyro_state->timestamp) | |
199 | gyro_state->timestamp = iio_get_time_ns(indio_dev); | |
200 | ||
201 | iio_push_to_buffers_with_timestamp(indio_dev, &gyro_state->scan, | |
202 | gyro_state->timestamp); | |
203 | ||
204 | gyro_state->timestamp = 0; | |
205 | } | |
c5bdbef7 | 206 | |
207 | return 0; | |
208 | } | |
209 | ||
210 | /* Capture samples in local storage */ | |
211 | static int gyro_3d_capture_sample(struct hid_sensor_hub_device *hsdev, | |
212 | unsigned usage_id, | |
213 | size_t raw_len, char *raw_data, | |
214 | void *priv) | |
215 | { | |
216 | struct iio_dev *indio_dev = platform_get_drvdata(priv); | |
217 | struct gyro_3d_state *gyro_state = iio_priv(indio_dev); | |
218 | int offset; | |
219 | int ret = -EINVAL; | |
220 | ||
221 | switch (usage_id) { | |
222 | case HID_USAGE_SENSOR_ANGL_VELOCITY_X_AXIS: | |
223 | case HID_USAGE_SENSOR_ANGL_VELOCITY_Y_AXIS: | |
224 | case HID_USAGE_SENSOR_ANGL_VELOCITY_Z_AXIS: | |
225 | offset = usage_id - HID_USAGE_SENSOR_ANGL_VELOCITY_X_AXIS; | |
4648cbd8 YX |
226 | gyro_state->scan.gyro_val[CHANNEL_SCAN_INDEX_X + offset] = |
227 | *(u32 *)raw_data; | |
c5bdbef7 | 228 | ret = 0; |
229 | break; | |
4648cbd8 YX |
230 | case HID_USAGE_SENSOR_TIME_TIMESTAMP: |
231 | gyro_state->timestamp = | |
232 | hid_sensor_convert_timestamp(&gyro_state->common_attributes, | |
233 | *(s64 *)raw_data); | |
eb50cd5b | 234 | ret = 0; |
4648cbd8 | 235 | break; |
c5bdbef7 | 236 | default: |
237 | break; | |
238 | } | |
239 | ||
240 | return ret; | |
241 | } | |
242 | ||
243 | /* Parse report which is specific to an usage id*/ | |
244 | static int gyro_3d_parse_report(struct platform_device *pdev, | |
245 | struct hid_sensor_hub_device *hsdev, | |
246 | struct iio_chan_spec *channels, | |
247 | unsigned usage_id, | |
248 | struct gyro_3d_state *st) | |
249 | { | |
250 | int ret; | |
251 | int i; | |
252 | ||
253 | for (i = 0; i <= CHANNEL_SCAN_INDEX_Z; ++i) { | |
254 | ret = sensor_hub_input_get_attribute_info(hsdev, | |
255 | HID_INPUT_REPORT, | |
256 | usage_id, | |
257 | HID_USAGE_SENSOR_ANGL_VELOCITY_X_AXIS + i, | |
258 | &st->gyro[CHANNEL_SCAN_INDEX_X + i]); | |
259 | if (ret < 0) | |
260 | break; | |
261 | gyro_3d_adjust_channel_bit_mask(channels, | |
262 | CHANNEL_SCAN_INDEX_X + i, | |
263 | st->gyro[CHANNEL_SCAN_INDEX_X + i].size); | |
264 | } | |
265 | dev_dbg(&pdev->dev, "gyro_3d %x:%x, %x:%x, %x:%x\n", | |
266 | st->gyro[0].index, | |
267 | st->gyro[0].report_id, | |
268 | st->gyro[1].index, st->gyro[1].report_id, | |
269 | st->gyro[2].index, st->gyro[2].report_id); | |
270 | ||
6c7db77e SP |
271 | st->scale_precision = hid_sensor_format_scale( |
272 | HID_USAGE_SENSOR_GYRO_3D, | |
273 | &st->gyro[CHANNEL_SCAN_INDEX_X], | |
274 | &st->scale_pre_decml, &st->scale_post_decml); | |
275 | ||
c5bdbef7 | 276 | return ret; |
277 | } | |
278 | ||
279 | /* Function to initialize the processing for usage id */ | |
fc52692c | 280 | static int hid_gyro_3d_probe(struct platform_device *pdev) |
c5bdbef7 | 281 | { |
282 | int ret = 0; | |
283 | static const char *name = "gyro_3d"; | |
284 | struct iio_dev *indio_dev; | |
285 | struct gyro_3d_state *gyro_state; | |
286 | struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data; | |
c5bdbef7 | 287 | |
1ba15cf2 SK |
288 | indio_dev = devm_iio_device_alloc(&pdev->dev, sizeof(*gyro_state)); |
289 | if (!indio_dev) | |
290 | return -ENOMEM; | |
c5bdbef7 | 291 | platform_set_drvdata(pdev, indio_dev); |
292 | ||
293 | gyro_state = iio_priv(indio_dev); | |
294 | gyro_state->common_attributes.hsdev = hsdev; | |
295 | gyro_state->common_attributes.pdev = pdev; | |
296 | ||
297 | ret = hid_sensor_parse_common_attributes(hsdev, | |
298 | HID_USAGE_SENSOR_GYRO_3D, | |
0e41fd51 YX |
299 | &gyro_state->common_attributes, |
300 | gryo_3d_sensitivity_addresses, | |
301 | ARRAY_SIZE(gryo_3d_sensitivity_addresses)); | |
c5bdbef7 | 302 | if (ret) { |
303 | dev_err(&pdev->dev, "failed to setup common attributes\n"); | |
1ba15cf2 | 304 | return ret; |
c5bdbef7 | 305 | } |
306 | ||
8b2ac516 AA |
307 | indio_dev->channels = devm_kmemdup(&pdev->dev, gyro_3d_channels, |
308 | sizeof(gyro_3d_channels), GFP_KERNEL); | |
d8c9d23e | 309 | if (!indio_dev->channels) { |
c5bdbef7 | 310 | dev_err(&pdev->dev, "failed to duplicate channels\n"); |
1ba15cf2 | 311 | return -ENOMEM; |
c5bdbef7 | 312 | } |
313 | ||
d8c9d23e FE |
314 | ret = gyro_3d_parse_report(pdev, hsdev, |
315 | (struct iio_chan_spec *)indio_dev->channels, | |
316 | HID_USAGE_SENSOR_GYRO_3D, gyro_state); | |
c5bdbef7 | 317 | if (ret) { |
318 | dev_err(&pdev->dev, "failed to setup attributes\n"); | |
8b2ac516 | 319 | return ret; |
c5bdbef7 | 320 | } |
321 | ||
c5bdbef7 | 322 | indio_dev->num_channels = ARRAY_SIZE(gyro_3d_channels); |
c5bdbef7 | 323 | indio_dev->info = &gyro_3d_info; |
324 | indio_dev->name = name; | |
325 | indio_dev->modes = INDIO_DIRECT_MODE; | |
326 | ||
56ff6be6 | 327 | atomic_set(&gyro_state->common_attributes.data_ready, 0); |
067fda1c | 328 | |
c5bdbef7 | 329 | ret = hid_sensor_setup_trigger(indio_dev, name, |
330 | &gyro_state->common_attributes); | |
331 | if (ret < 0) { | |
332 | dev_err(&pdev->dev, "trigger setup failed\n"); | |
8b2ac516 | 333 | return ret; |
c5bdbef7 | 334 | } |
335 | ||
336 | ret = iio_device_register(indio_dev); | |
337 | if (ret) { | |
338 | dev_err(&pdev->dev, "device register failed\n"); | |
339 | goto error_remove_trigger; | |
340 | } | |
341 | ||
342 | gyro_state->callbacks.send_event = gyro_3d_proc_event; | |
343 | gyro_state->callbacks.capture_sample = gyro_3d_capture_sample; | |
344 | gyro_state->callbacks.pdev = pdev; | |
345 | ret = sensor_hub_register_callback(hsdev, HID_USAGE_SENSOR_GYRO_3D, | |
346 | &gyro_state->callbacks); | |
347 | if (ret < 0) { | |
348 | dev_err(&pdev->dev, "callback reg failed\n"); | |
349 | goto error_iio_unreg; | |
350 | } | |
351 | ||
352 | return ret; | |
353 | ||
354 | error_iio_unreg: | |
355 | iio_device_unregister(indio_dev); | |
356 | error_remove_trigger: | |
067fda1c | 357 | hid_sensor_remove_trigger(indio_dev, &gyro_state->common_attributes); |
c5bdbef7 | 358 | return ret; |
359 | } | |
360 | ||
361 | /* Function to deinitialize the processing for usage id */ | |
3a879973 | 362 | static void hid_gyro_3d_remove(struct platform_device *pdev) |
c5bdbef7 | 363 | { |
364 | struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data; | |
365 | struct iio_dev *indio_dev = platform_get_drvdata(pdev); | |
ec7f68e0 | 366 | struct gyro_3d_state *gyro_state = iio_priv(indio_dev); |
c5bdbef7 | 367 | |
368 | sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_GYRO_3D); | |
369 | iio_device_unregister(indio_dev); | |
067fda1c | 370 | hid_sensor_remove_trigger(indio_dev, &gyro_state->common_attributes); |
c5bdbef7 | 371 | } |
372 | ||
322a3b1e | 373 | static const struct platform_device_id hid_gyro_3d_ids[] = { |
a411e735 AH |
374 | { |
375 | /* Format: HID-SENSOR-usage_id_in_hex_lowercase */ | |
376 | .name = "HID-SENSOR-200076", | |
377 | }, | |
378 | { /* sentinel */ } | |
379 | }; | |
380 | MODULE_DEVICE_TABLE(platform, hid_gyro_3d_ids); | |
381 | ||
c5bdbef7 | 382 | static struct platform_driver hid_gyro_3d_platform_driver = { |
a411e735 | 383 | .id_table = hid_gyro_3d_ids, |
c5bdbef7 | 384 | .driver = { |
a411e735 | 385 | .name = KBUILD_MODNAME, |
27ce4239 | 386 | .pm = &hid_sensor_pm_ops, |
c5bdbef7 | 387 | }, |
388 | .probe = hid_gyro_3d_probe, | |
3a879973 | 389 | .remove_new = hid_gyro_3d_remove, |
c5bdbef7 | 390 | }; |
391 | module_platform_driver(hid_gyro_3d_platform_driver); | |
392 | ||
393 | MODULE_DESCRIPTION("HID Sensor Gyroscope 3D"); | |
394 | MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>"); | |
395 | MODULE_LICENSE("GPL"); | |
12f13d1f | 396 | MODULE_IMPORT_NS(IIO_HID); |