drivers/iio/common/hid-sensors/hid-sensor-attributes.c

   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/hid-sensor-hub.h>
  26 #include <linux/iio/iio.h>
  27 #include <linux/iio/sysfs.h>
  28
  29 static struct {
  30         u32 usage_id;
  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},
  40
  41         {HID_USAGE_SENSOR_GRAVITY_VECTOR, 0, 9, 806650000},
  42         {HID_USAGE_SENSOR_GRAVITY_VECTOR,
  43                 HID_USAGE_SENSOR_UNITS_METERS_PER_SEC_SQRD, 1, 0},
  44         {HID_USAGE_SENSOR_GRAVITY_VECTOR,
  45                 HID_USAGE_SENSOR_UNITS_G, 9, 806650000},
  46
  47         {HID_USAGE_SENSOR_GYRO_3D, 0, 0, 17453293},
  48         {HID_USAGE_SENSOR_GYRO_3D,
  49                 HID_USAGE_SENSOR_UNITS_RADIANS_PER_SECOND, 1, 0},
  50         {HID_USAGE_SENSOR_GYRO_3D,
  51                 HID_USAGE_SENSOR_UNITS_DEGREES_PER_SECOND, 0, 17453293},
  52
  53         {HID_USAGE_SENSOR_COMPASS_3D, 0, 0, 1000000},
  54         {HID_USAGE_SENSOR_COMPASS_3D, HID_USAGE_SENSOR_UNITS_GAUSS, 1, 0},
  55
  56         {HID_USAGE_SENSOR_INCLINOMETER_3D, 0, 0, 17453293},
  57         {HID_USAGE_SENSOR_INCLINOMETER_3D,
  58                 HID_USAGE_SENSOR_UNITS_DEGREES, 0, 17453293},
  59         {HID_USAGE_SENSOR_INCLINOMETER_3D,
  60                 HID_USAGE_SENSOR_UNITS_RADIANS, 1, 0},
  61
  62         {HID_USAGE_SENSOR_ALS, 0, 1, 0},
  63         {HID_USAGE_SENSOR_ALS, HID_USAGE_SENSOR_UNITS_LUX, 1, 0},
  64
  65         {HID_USAGE_SENSOR_PRESSURE, 0, 100, 0},
  66         {HID_USAGE_SENSOR_PRESSURE, HID_USAGE_SENSOR_UNITS_PASCAL, 0, 1000000},
  67
  68         {HID_USAGE_SENSOR_TIME_TIMESTAMP, 0, 1000000000, 0},
  69         {HID_USAGE_SENSOR_TIME_TIMESTAMP, HID_USAGE_SENSOR_UNITS_MILLISECOND,
  70                 1000000, 0},
  71
  72         {HID_USAGE_SENSOR_TEMPERATURE, 0, 1000, 0},
  73         {HID_USAGE_SENSOR_TEMPERATURE, HID_USAGE_SENSOR_UNITS_DEGREES, 1000, 0},
  74
  75         {HID_USAGE_SENSOR_HUMIDITY, 0, 1000, 0},
  76 };
  77
  78 static int pow_10(unsigned power)
  79 {
  80         int i;
  81         int ret = 1;
  82         for (i = 0; i < power; ++i)
  83                 ret = ret * 10;
  84
  85         return ret;
  86 }
  87
  88 static void simple_div(int dividend, int divisor, int *whole,
  89                                 int *micro_frac)
  90 {
  91         int rem;
  92         int exp = 0;
  93
  94         *micro_frac = 0;
  95         if (divisor == 0) {
  96                 *whole = 0;
  97                 return;
  98         }
  99         *whole = dividend/divisor;
 100         rem = dividend % divisor;
 101         if (rem) {
 102                 while (rem <= divisor) {
 103                         rem *= 10;
 104                         exp++;
 105                 }
 106                 *micro_frac = (rem / divisor) * pow_10(6-exp);
 107         }
 108 }
 109
 110 static void split_micro_fraction(unsigned int no, int exp, int *val1, int *val2)
 111 {
 112         *val1 = no/pow_10(exp);
 113         *val2 = no%pow_10(exp) * pow_10(6-exp);
 114 }
 115
 116 /*
 117 VTF format uses exponent and variable size format.
 118 For example if the size is 2 bytes
 119 0x0067 with VTF16E14 format -> +1.03
 120 To convert just change to 0x67 to decimal and use two decimal as E14 stands
 121 for 10^-2.
 122 Negative numbers are 2's complement
 123 */
 124 static void convert_from_vtf_format(u32 value, int size, int exp,
 125                                         int *val1, int *val2)
 126 {
 127         int sign = 1;
 128
 129         if (value & BIT(size*8 - 1)) {
 130                 value =  ((1LL << (size * 8)) - value);
 131                 sign = -1;
 132         }
 133         exp = hid_sensor_convert_exponent(exp);
 134         if (exp >= 0) {
 135                 *val1 = sign * value * pow_10(exp);
 136                 *val2 = 0;
 137         } else {
 138                 split_micro_fraction(value, -exp, val1, val2);
 139                 if (*val1)
 140                         *val1 = sign * (*val1);
 141                 else
 142                         *val2 = sign * (*val2);
 143         }
 144 }
 145
 146 static u32 convert_to_vtf_format(int size, int exp, int val1, int val2)
 147 {
 148         u32 value;
 149         int sign = 1;
 150
 151         if (val1 < 0 || val2 < 0)
 152                 sign = -1;
 153         exp = hid_sensor_convert_exponent(exp);
 154         if (exp < 0) {
 155                 value = abs(val1) * pow_10(-exp);
 156                 value += abs(val2) / pow_10(6+exp);
 157         } else
 158                 value = abs(val1) / pow_10(exp);
 159         if (sign < 0)
 160                 value =  ((1LL << (size * 8)) - value);
 161
 162         return value;
 163 }
 164
 165 s32 hid_sensor_read_poll_value(struct hid_sensor_common *st)
 166 {
 167         s32 value = 0;
 168         int ret;
 169
 170         ret = sensor_hub_get_feature(st->hsdev,
 171                                      st->poll.report_id,
 172                                      st->poll.index, sizeof(value), &value);
 173
 174         if (ret < 0 || value < 0) {
 175                 return -EINVAL;
 176         } else {
 177                 if (st->poll.units == HID_USAGE_SENSOR_UNITS_SECOND)
 178                         value = value * 1000;
 179         }
 180
 181         return value;
 182 }
 183 EXPORT_SYMBOL(hid_sensor_read_poll_value);
 184
 185 int hid_sensor_read_samp_freq_value(struct hid_sensor_common *st,
 186                                 int *val1, int *val2)
 187 {
 188         s32 value;
 189         int ret;
 190
 191         ret = sensor_hub_get_feature(st->hsdev,
 192                                      st->poll.report_id,
 193                                      st->poll.index, sizeof(value), &value);
 194         if (ret < 0 || value < 0) {
 195                 *val1 = *val2 = 0;
 196                 return -EINVAL;
 197         } else {
 198                 if (st->poll.units == HID_USAGE_SENSOR_UNITS_MILLISECOND)
 199                         simple_div(1000, value, val1, val2);
 200                 else if (st->poll.units == HID_USAGE_SENSOR_UNITS_SECOND)
 201                         simple_div(1, value, val1, val2);
 202                 else {
 203                         *val1 = *val2 = 0;
 204                         return -EINVAL;
 205                 }
 206         }
 207
 208         return IIO_VAL_INT_PLUS_MICRO;
 209 }
 210 EXPORT_SYMBOL(hid_sensor_read_samp_freq_value);
 211
 212 int hid_sensor_write_samp_freq_value(struct hid_sensor_common *st,
 213                                 int val1, int val2)
 214 {
 215         s32 value;
 216         int ret;
 217
 218         if (val1 < 0 || val2 < 0)
 219                 return -EINVAL;
 220
 221         value = val1 * pow_10(6) + val2;
 222         if (value) {
 223                 if (st->poll.units == HID_USAGE_SENSOR_UNITS_MILLISECOND)
 224                         value = pow_10(9)/value;
 225                 else if (st->poll.units == HID_USAGE_SENSOR_UNITS_SECOND)
 226                         value = pow_10(6)/value;
 227                 else
 228                         value = 0;
 229         }
 230         ret = sensor_hub_set_feature(st->hsdev, st->poll.report_id,
 231                                      st->poll.index, sizeof(value), &value);
 232         if (ret < 0 || value < 0)
 233                 ret = -EINVAL;
 234
 235         ret = sensor_hub_get_feature(st->hsdev,
 236                                      st->poll.report_id,
 237                                      st->poll.index, sizeof(value), &value);
 238         if (ret < 0 || value < 0)
 239                 return -EINVAL;
 240
 241         st->poll_interval = value;
 242
 243         return 0;
 244 }
 245 EXPORT_SYMBOL(hid_sensor_write_samp_freq_value);
 246
 247 int hid_sensor_read_raw_hyst_value(struct hid_sensor_common *st,
 248                                 int *val1, int *val2)
 249 {
 250         s32 value;
 251         int ret;
 252
 253         ret = sensor_hub_get_feature(st->hsdev,
 254                                      st->sensitivity.report_id,
 255                                      st->sensitivity.index, sizeof(value),
 256                                      &value);
 257         if (ret < 0 || value < 0) {
 258                 *val1 = *val2 = 0;
 259                 return -EINVAL;
 260         } else {
 261                 convert_from_vtf_format(value, st->sensitivity.size,
 262                                         st->sensitivity.unit_expo,
 263                                         val1, val2);
 264         }
 265
 266         return IIO_VAL_INT_PLUS_MICRO;
 267 }
 268 EXPORT_SYMBOL(hid_sensor_read_raw_hyst_value);
 269
 270 int hid_sensor_write_raw_hyst_value(struct hid_sensor_common *st,
 271                                         int val1, int val2)
 272 {
 273         s32 value;
 274         int ret;
 275
 276         if (val1 < 0 || val2 < 0)
 277                 return -EINVAL;
 278
 279         value = convert_to_vtf_format(st->sensitivity.size,
 280                                 st->sensitivity.unit_expo,
 281                                 val1, val2);
 282         ret = sensor_hub_set_feature(st->hsdev, st->sensitivity.report_id,
 283                                      st->sensitivity.index, sizeof(value),
 284                                      &value);
 285         if (ret < 0 || value < 0)
 286                 ret = -EINVAL;
 287
 288         ret = sensor_hub_get_feature(st->hsdev,
 289                                      st->sensitivity.report_id,
 290                                      st->sensitivity.index, sizeof(value),
 291                                      &value);
 292         if (ret < 0 || value < 0)
 293                 return -EINVAL;
 294
 295         st->raw_hystersis = value;
 296
 297         return 0;
 298 }
 299 EXPORT_SYMBOL(hid_sensor_write_raw_hyst_value);
 300
 301 /*
 302  * This fuction applies the unit exponent to the scale.
 303  * For example:
 304  * 9.806650000 ->exp:2-> val0[980]val1[665000000]
 305  * 9.000806000 ->exp:2-> val0[900]val1[80600000]
 306  * 0.174535293 ->exp:2-> val0[17]val1[453529300]
 307  * 1.001745329 ->exp:0-> val0[1]val1[1745329]
 308  * 1.001745329 ->exp:2-> val0[100]val1[174532900]
 309  * 1.001745329 ->exp:4-> val0[10017]val1[453290000]
 310  * 9.806650000 ->exp:-2-> val0[0]val1[98066500]
 311  */
 312 static void adjust_exponent_nano(int *val0, int *val1, int scale0,
 313                                   int scale1, int exp)
 314 {
 315         int i;
 316         int x;
 317         int res;
 318         int rem;
 319
 320         if (exp > 0) {
 321                 *val0 = scale0 * pow_10(exp);
 322                 res = 0;
 323                 if (exp > 9) {
 324                         *val1 = 0;
 325                         return;
 326                 }
 327                 for (i = 0; i < exp; ++i) {
 328                         x = scale1 / pow_10(8 - i);
 329                         res += (pow_10(exp - 1 - i) * x);
 330                         scale1 = scale1 % pow_10(8 - i);
 331                 }
 332                 *val0 += res;
 333                         *val1 = scale1 * pow_10(exp);
 334         } else if (exp < 0) {
 335                 exp = abs(exp);
 336                 if (exp > 9) {
 337                         *val0 = *val1 = 0;
 338                         return;
 339                 }
 340                 *val0 = scale0 / pow_10(exp);
 341                 rem = scale0 % pow_10(exp);
 342                 res = 0;
 343                 for (i = 0; i < (9 - exp); ++i) {
 344                         x = scale1 / pow_10(8 - i);
 345                         res += (pow_10(8 - exp - i) * x);
 346                         scale1 = scale1 % pow_10(8 - i);
 347                 }
 348                 *val1 = rem * pow_10(9 - exp) + res;
 349         } else {
 350                 *val0 = scale0;
 351                 *val1 = scale1;
 352         }
 353 }
 354
 355 int hid_sensor_format_scale(u32 usage_id,
 356                         struct hid_sensor_hub_attribute_info *attr_info,
 357                         int *val0, int *val1)
 358 {
 359         int i;
 360         int exp;
 361
 362         *val0 = 1;
 363         *val1 = 0;
 364
 365         for (i = 0; i < ARRAY_SIZE(unit_conversion); ++i) {
 366                 if (unit_conversion[i].usage_id == usage_id &&
 367                         unit_conversion[i].unit == attr_info->units) {
 368                         exp  = hid_sensor_convert_exponent(
 369                                                 attr_info->unit_expo);
 370                         adjust_exponent_nano(val0, val1,
 371                                         unit_conversion[i].scale_val0,
 372                                         unit_conversion[i].scale_val1, exp);
 373                         break;
 374                 }
 375         }
 376
 377         return IIO_VAL_INT_PLUS_NANO;
 378 }
 379 EXPORT_SYMBOL(hid_sensor_format_scale);
 380
 381 int64_t hid_sensor_convert_timestamp(struct hid_sensor_common *st,
 382                                      int64_t raw_value)
 383 {
 384         return st->timestamp_ns_scale * raw_value;
 385 }
 386 EXPORT_SYMBOL(hid_sensor_convert_timestamp);
 387
 388 static
 389 int hid_sensor_get_reporting_interval(struct hid_sensor_hub_device *hsdev,
 390                                         u32 usage_id,
 391                                         struct hid_sensor_common *st)
 392 {
 393         sensor_hub_input_get_attribute_info(hsdev,
 394                                         HID_FEATURE_REPORT, usage_id,
 395                                         HID_USAGE_SENSOR_PROP_REPORT_INTERVAL,
 396                                         &st->poll);
 397         /* Default unit of measure is milliseconds */
 398         if (st->poll.units == 0)
 399                 st->poll.units = HID_USAGE_SENSOR_UNITS_MILLISECOND;
 400
 401         st->poll_interval = -1;
 402
 403         return 0;
 404
 405 }
 406
 407 int hid_sensor_parse_common_attributes(struct hid_sensor_hub_device *hsdev,
 408                                         u32 usage_id,
 409                                         struct hid_sensor_common *st)
 410 {
 411
 412         struct hid_sensor_hub_attribute_info timestamp;
 413         s32 value;
 414         int ret;
 415
 416         hid_sensor_get_reporting_interval(hsdev, usage_id, st);
 417
 418         sensor_hub_input_get_attribute_info(hsdev,
 419                                         HID_FEATURE_REPORT, usage_id,
 420                                         HID_USAGE_SENSOR_PROP_REPORT_STATE,
 421                                         &st->report_state);
 422
 423         sensor_hub_input_get_attribute_info(hsdev,
 424                                         HID_FEATURE_REPORT, usage_id,
 425                                         HID_USAGE_SENSOR_PROY_POWER_STATE,
 426                                         &st->power_state);
 427
 428         sensor_hub_input_get_attribute_info(hsdev,
 429                         HID_FEATURE_REPORT, usage_id,
 430                         HID_USAGE_SENSOR_PROP_SENSITIVITY_ABS,
 431                          &st->sensitivity);
 432
 433         st->raw_hystersis = -1;
 434
 435         sensor_hub_input_get_attribute_info(hsdev,
 436                                             HID_INPUT_REPORT, usage_id,
 437                                             HID_USAGE_SENSOR_TIME_TIMESTAMP,
 438                                             &timestamp);
 439         if (timestamp.index >= 0 && timestamp.report_id) {
 440                 int val0, val1;
 441
 442                 hid_sensor_format_scale(HID_USAGE_SENSOR_TIME_TIMESTAMP,
 443                                         &timestamp, &val0, &val1);
 444                 st->timestamp_ns_scale = val0;
 445         } else
 446                 st->timestamp_ns_scale = 1000000000;
 447
 448         hid_dbg(hsdev->hdev, "common attributes: %x:%x, %x:%x, %x:%x %x:%x %x:%x\n",
 449                 st->poll.index, st->poll.report_id,
 450                 st->report_state.index, st->report_state.report_id,
 451                 st->power_state.index, st->power_state.report_id,
 452                 st->sensitivity.index, st->sensitivity.report_id,
 453                 timestamp.index, timestamp.report_id);
 454
 455         ret = sensor_hub_get_feature(hsdev,
 456                                 st->power_state.report_id,
 457                                 st->power_state.index, sizeof(value), &value);
 458         if (ret < 0)
 459                 return ret;
 460         if (value < 0)
 461                 return -EINVAL;
 462
 463         return 0;
 464 }
 465 EXPORT_SYMBOL(hid_sensor_parse_common_attributes);
 466
 467 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
 468 MODULE_DESCRIPTION("HID Sensor common attribute processing");
 469 MODULE_LICENSE("GPL");