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>
31 int unit; /* 0 for default others from HID sensor spec */
32 int scale_val0; /* scale, whole number */
33 int scale_val1; /* scale, fraction in nanos */
34 } unit_conversion[] = {
35 {HID_USAGE_SENSOR_ACCEL_3D, 0, 9, 806650000},
36 {HID_USAGE_SENSOR_ACCEL_3D,
37 HID_USAGE_SENSOR_UNITS_METERS_PER_SEC_SQRD, 1, 0},
38 {HID_USAGE_SENSOR_ACCEL_3D,
39 HID_USAGE_SENSOR_UNITS_G, 9, 806650000},
41 {HID_USAGE_SENSOR_GYRO_3D, 0, 0, 17453293},
42 {HID_USAGE_SENSOR_GYRO_3D,
43 HID_USAGE_SENSOR_UNITS_RADIANS_PER_SECOND, 1, 0},
44 {HID_USAGE_SENSOR_GYRO_3D,
45 HID_USAGE_SENSOR_UNITS_DEGREES_PER_SECOND, 0, 17453293},
47 {HID_USAGE_SENSOR_COMPASS_3D, 0, 0, 1000000},
48 {HID_USAGE_SENSOR_COMPASS_3D, HID_USAGE_SENSOR_UNITS_GAUSS, 1, 0},
50 {HID_USAGE_SENSOR_INCLINOMETER_3D, 0, 0, 17453293},
51 {HID_USAGE_SENSOR_INCLINOMETER_3D,
52 HID_USAGE_SENSOR_UNITS_DEGREES, 0, 17453293},
53 {HID_USAGE_SENSOR_INCLINOMETER_3D,
54 HID_USAGE_SENSOR_UNITS_RADIANS, 1, 0},
56 {HID_USAGE_SENSOR_ALS, 0, 1, 0},
57 {HID_USAGE_SENSOR_ALS, HID_USAGE_SENSOR_UNITS_LUX, 1, 0},
59 {HID_USAGE_SENSOR_PRESSURE, 0, 100, 0},
60 {HID_USAGE_SENSOR_PRESSURE, HID_USAGE_SENSOR_UNITS_PASCAL, 0, 1000000},
62 {HID_USAGE_SENSOR_TIME_TIMESTAMP, 0, 1000000000, 0},
63 {HID_USAGE_SENSOR_TIME_TIMESTAMP, HID_USAGE_SENSOR_UNITS_MILLISECOND,
67 static int pow_10(unsigned power)
71 for (i = 0; i < power; ++i)
77 static void simple_div(int dividend, int divisor, int *whole,
88 *whole = dividend/divisor;
89 rem = dividend % divisor;
91 while (rem <= divisor) {
95 *micro_frac = (rem / divisor) * pow_10(6-exp);
99 static void split_micro_fraction(unsigned int no, int exp, int *val1, int *val2)
101 *val1 = no/pow_10(exp);
102 *val2 = no%pow_10(exp) * pow_10(6-exp);
106 VTF format uses exponent and variable size format.
107 For example if the size is 2 bytes
108 0x0067 with VTF16E14 format -> +1.03
109 To convert just change to 0x67 to decimal and use two decimal as E14 stands
111 Negative numbers are 2's complement
113 static void convert_from_vtf_format(u32 value, int size, int exp,
114 int *val1, int *val2)
118 if (value & BIT(size*8 - 1)) {
119 value = ((1LL << (size * 8)) - value);
122 exp = hid_sensor_convert_exponent(exp);
124 *val1 = sign * value * pow_10(exp);
127 split_micro_fraction(value, -exp, val1, val2);
129 *val1 = sign * (*val1);
131 *val2 = sign * (*val2);
135 static u32 convert_to_vtf_format(int size, int exp, int val1, int val2)
140 if (val1 < 0 || val2 < 0)
142 exp = hid_sensor_convert_exponent(exp);
144 value = abs(val1) * pow_10(-exp);
145 value += abs(val2) / pow_10(6+exp);
147 value = abs(val1) / pow_10(exp);
149 value = ((1LL << (size * 8)) - value);
154 s32 hid_sensor_read_poll_value(struct hid_sensor_common *st)
159 ret = sensor_hub_get_feature(st->hsdev,
161 st->poll.index, sizeof(value), &value);
163 if (ret < 0 || value < 0) {
166 if (st->poll.units == HID_USAGE_SENSOR_UNITS_SECOND)
167 value = value * 1000;
172 EXPORT_SYMBOL(hid_sensor_read_poll_value);
174 int hid_sensor_read_samp_freq_value(struct hid_sensor_common *st,
175 int *val1, int *val2)
180 ret = sensor_hub_get_feature(st->hsdev,
182 st->poll.index, sizeof(value), &value);
183 if (ret < 0 || value < 0) {
187 if (st->poll.units == HID_USAGE_SENSOR_UNITS_MILLISECOND)
188 simple_div(1000, value, val1, val2);
189 else if (st->poll.units == HID_USAGE_SENSOR_UNITS_SECOND)
190 simple_div(1, value, val1, val2);
197 return IIO_VAL_INT_PLUS_MICRO;
199 EXPORT_SYMBOL(hid_sensor_read_samp_freq_value);
201 int hid_sensor_write_samp_freq_value(struct hid_sensor_common *st,
207 if (val1 < 0 || val2 < 0)
210 value = val1 * pow_10(6) + val2;
212 if (st->poll.units == HID_USAGE_SENSOR_UNITS_MILLISECOND)
213 value = pow_10(9)/value;
214 else if (st->poll.units == HID_USAGE_SENSOR_UNITS_SECOND)
215 value = pow_10(6)/value;
219 ret = sensor_hub_set_feature(st->hsdev, st->poll.report_id,
220 st->poll.index, sizeof(value), &value);
221 if (ret < 0 || value < 0)
226 EXPORT_SYMBOL(hid_sensor_write_samp_freq_value);
228 int hid_sensor_read_raw_hyst_value(struct hid_sensor_common *st,
229 int *val1, int *val2)
234 ret = sensor_hub_get_feature(st->hsdev,
235 st->sensitivity.report_id,
236 st->sensitivity.index, sizeof(value),
238 if (ret < 0 || value < 0) {
242 convert_from_vtf_format(value, st->sensitivity.size,
243 st->sensitivity.unit_expo,
247 return IIO_VAL_INT_PLUS_MICRO;
249 EXPORT_SYMBOL(hid_sensor_read_raw_hyst_value);
251 int hid_sensor_write_raw_hyst_value(struct hid_sensor_common *st,
257 if (val1 < 0 || val2 < 0)
260 value = convert_to_vtf_format(st->sensitivity.size,
261 st->sensitivity.unit_expo,
263 ret = sensor_hub_set_feature(st->hsdev, st->sensitivity.report_id,
264 st->sensitivity.index, sizeof(value),
266 if (ret < 0 || value < 0)
271 EXPORT_SYMBOL(hid_sensor_write_raw_hyst_value);
274 * This fuction applies the unit exponent to the scale.
276 * 9.806650000 ->exp:2-> val0[980]val1[665000000]
277 * 9.000806000 ->exp:2-> val0[900]val1[80600000]
278 * 0.174535293 ->exp:2-> val0[17]val1[453529300]
279 * 1.001745329 ->exp:0-> val0[1]val1[1745329]
280 * 1.001745329 ->exp:2-> val0[100]val1[174532900]
281 * 1.001745329 ->exp:4-> val0[10017]val1[453290000]
282 * 9.806650000 ->exp:-2-> val0[0]val1[98066500]
284 static void adjust_exponent_nano(int *val0, int *val1, int scale0,
293 *val0 = scale0 * pow_10(exp);
299 for (i = 0; i < exp; ++i) {
300 x = scale1 / pow_10(8 - i);
301 res += (pow_10(exp - 1 - i) * x);
302 scale1 = scale1 % pow_10(8 - i);
305 *val1 = scale1 * pow_10(exp);
306 } else if (exp < 0) {
312 *val0 = scale0 / pow_10(exp);
313 rem = scale0 % pow_10(exp);
315 for (i = 0; i < (9 - exp); ++i) {
316 x = scale1 / pow_10(8 - i);
317 res += (pow_10(8 - exp - i) * x);
318 scale1 = scale1 % pow_10(8 - i);
320 *val1 = rem * pow_10(9 - exp) + res;
327 int hid_sensor_format_scale(u32 usage_id,
328 struct hid_sensor_hub_attribute_info *attr_info,
329 int *val0, int *val1)
337 for (i = 0; i < ARRAY_SIZE(unit_conversion); ++i) {
338 if (unit_conversion[i].usage_id == usage_id &&
339 unit_conversion[i].unit == attr_info->units) {
340 exp = hid_sensor_convert_exponent(
341 attr_info->unit_expo);
342 adjust_exponent_nano(val0, val1,
343 unit_conversion[i].scale_val0,
344 unit_conversion[i].scale_val1, exp);
349 return IIO_VAL_INT_PLUS_NANO;
351 EXPORT_SYMBOL(hid_sensor_format_scale);
353 int64_t hid_sensor_convert_timestamp(struct hid_sensor_common *st,
356 return st->timestamp_ns_scale * raw_value;
358 EXPORT_SYMBOL(hid_sensor_convert_timestamp);
361 int hid_sensor_get_reporting_interval(struct hid_sensor_hub_device *hsdev,
363 struct hid_sensor_common *st)
365 sensor_hub_input_get_attribute_info(hsdev,
366 HID_FEATURE_REPORT, usage_id,
367 HID_USAGE_SENSOR_PROP_REPORT_INTERVAL,
369 /* Default unit of measure is milliseconds */
370 if (st->poll.units == 0)
371 st->poll.units = HID_USAGE_SENSOR_UNITS_MILLISECOND;
376 int hid_sensor_parse_common_attributes(struct hid_sensor_hub_device *hsdev,
378 struct hid_sensor_common *st)
381 struct hid_sensor_hub_attribute_info timestamp;
385 hid_sensor_get_reporting_interval(hsdev, usage_id, st);
387 sensor_hub_input_get_attribute_info(hsdev,
388 HID_FEATURE_REPORT, usage_id,
389 HID_USAGE_SENSOR_PROP_REPORT_STATE,
392 sensor_hub_input_get_attribute_info(hsdev,
393 HID_FEATURE_REPORT, usage_id,
394 HID_USAGE_SENSOR_PROY_POWER_STATE,
397 sensor_hub_input_get_attribute_info(hsdev,
398 HID_FEATURE_REPORT, usage_id,
399 HID_USAGE_SENSOR_PROP_SENSITIVITY_ABS,
402 sensor_hub_input_get_attribute_info(hsdev,
403 HID_INPUT_REPORT, usage_id,
404 HID_USAGE_SENSOR_TIME_TIMESTAMP,
406 if (timestamp.index >= 0 && timestamp.report_id) {
409 hid_sensor_format_scale(HID_USAGE_SENSOR_TIME_TIMESTAMP,
410 ×tamp, &val0, &val1);
411 st->timestamp_ns_scale = val0;
413 st->timestamp_ns_scale = 1000000000;
415 hid_dbg(hsdev->hdev, "common attributes: %x:%x, %x:%x, %x:%x %x:%x %x:%x\n",
416 st->poll.index, st->poll.report_id,
417 st->report_state.index, st->report_state.report_id,
418 st->power_state.index, st->power_state.report_id,
419 st->sensitivity.index, st->sensitivity.report_id,
420 timestamp.index, timestamp.report_id);
422 ret = sensor_hub_get_feature(hsdev,
423 st->power_state.report_id,
424 st->power_state.index, sizeof(value), &value);
432 EXPORT_SYMBOL(hid_sensor_parse_common_attributes);
434 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
435 MODULE_DESCRIPTION("HID Sensor common attribute processing");
436 MODULE_LICENSE("GPL");