description.c

   1 /*
   2  * Copyright (C) 2014 Intel Corporation.
   3  */
   4
   5 #include <stdlib.h>
   6 #include <ctype.h>
   7 #include <utils/Log.h>
   8 #include <cutils/properties.h>
   9 #include <hardware/sensors.h>
  10 #include "common.h"
  11 #include "enumeration.h"
  12 #include "description.h"
  13 #include "utils.h"
  14
  15 #define IIO_SENSOR_HAL_VERSION  1
  16
  17 /*
  18  * About properties
  19  *
  20  * We acquire a number of parameters about sensors by reading properties.
  21  * The idea here is that someone (either a script, or daemon, sets them
  22  * depending on the set of sensors present on the machine.
  23  *
  24  * There are fallback paths in case the properties are not defined, but it is
  25  * highly desirable to at least have the following for each sensor:
  26  *
  27  * ro.iio.anglvel.name = Gyroscope
  28  * ro.iio.anglvel.vendor = Intel
  29  * ro.iio.anglvel.max_range = 35
  30  * ro.iio.anglvel.resolution = 0.002
  31  * ro.iio.anglvel.power = 6.1
  32  *
  33  * Besides these, we have a couple of knobs initially used to cope with Intel
  34  * Sensor Hub oddities, such as HID inspired units or firmware bugs:
  35  *
  36  * ro.iio.anglvel.transform = ISH
  37  * ro.iio.anglvel.quirks = init-rate
  38  *
  39  * The "terse" quirk indicates that the underlying driver only sends events
  40  * when the sensor reports a change. The HAL then periodically generates
  41  * duplicate events so the sensor behaves as a continously firing one.
  42  *
  43  * The "noisy" quirk indicates that the underlying driver has a unusually high
  44  * level of noise in its readings, and that the HAL has to accomodate it
  45  * somehow, e.g. in the magnetometer calibration code path.
  46  *
  47  * This one is used specifically to pass a calibration scale to ALS drivers:
  48  *
  49  * ro.iio.illuminance.name = CPLM3218x Ambient Light Sensor
  50  * ro.iio.illuminance.vendor = Capella Microsystems
  51  * ro.iio.illuminance.max_range = 167000
  52  * ro.iio.illuminance.resolution = 1
  53  * ro.iio.illuminance.power = .001
  54  * ro.iio.illuminance.illumincalib = 7400
  55  *
  56  * There's a 'opt_scale' specifier, documented as follows:
  57  *
  58  *  This adds support for a scaling factor that can be expressed
  59  *  using properties, for all sensors, on a channel basis. That
  60  *  scaling factor is applied after all other transforms have been
  61  *  applied, and is intended as a way to compensate for problems
  62  *  such as an incorrect axis polarity for a given sensor.
  63  *
  64  *  The syntax is <usual property prefix>.<channel>.opt_scale, e.g.
  65  *  ro.iio.accel.y.opt_scale = -1 to negate the sign of the y readings
  66  *  for the accelerometer.
  67  *
  68  *  For sensors using a single channel - and only those - the channel
  69  *  name is implicitly void and a syntax such as ro.iio.illuminance.
  70  *  opt_scale = 3 has to be used.
  71  *
  72  * 'panel' and 'rotation' specifiers can be used to express ACPI PLD placement
  73  * information ; if found they will be used in priority over the actual ACPI
  74  * data. That is intended as a way to verify values during development.
  75  *
  76  * It's possible to use the contents of the iio device name as a way to
  77  * discriminate between sensors. Several sensors of the same type can coexist:
  78  * e.g. ro.iio.temp.bmg160.name = BMG160 Thermometer will be used in priority
  79  * over ro.iio.temp.name = BMC150 Thermometer if the sensor for which we query
  80  * properties values happen to have its iio device name set to bmg160.
  81  */
  82
  83 static int sensor_get_st_prop (int s, const char* sel, char val[MAX_NAME_SIZE])
  84 {
  85         char prop_name[PROP_NAME_MAX];
  86         char prop_val[PROP_VALUE_MAX];
  87         char extended_sel[PROP_VALUE_MAX];
  88
  89         int i                   = sensor_info[s].catalog_index;
  90         const char *prefix      = sensor_catalog[i].tag;
  91
  92         /* First try most specialized form, like ro.iio.anglvel.bmg160.name */
  93
  94         snprintf(extended_sel, PROP_NAME_MAX, "%s.%s",
  95                  sensor_info[s].internal_name, sel);
  96
  97         snprintf(prop_name, PROP_NAME_MAX, PROP_BASE, prefix, extended_sel);
  98
  99         if (property_get(prop_name, prop_val, "")) {
 100                 strncpy(val, prop_val, MAX_NAME_SIZE-1);
 101                 val[MAX_NAME_SIZE-1] = '\0';
 102                 return 0;
 103         }
 104
 105         /* Fall back to simple form, like ro.iio.anglvel.name */
 106
 107         sprintf(prop_name, PROP_BASE, prefix, sel);
 108
 109         if (property_get(prop_name, prop_val, "")) {
 110                 strncpy(val, prop_val, MAX_NAME_SIZE-1);
 111                 val[MAX_NAME_SIZE-1] = '\0';
 112                 return 0;
 113         }
 114
 115         return -1;
 116 }
 117
 118
 119 int sensor_get_prop (int s, const char* sel, int* val)
 120 {
 121         char buf[MAX_NAME_SIZE];
 122
 123         if (sensor_get_st_prop(s, sel, buf))
 124                 return -1;
 125
 126         *val = atoi(buf);
 127         return 0;
 128 }
 129
 130
 131 int sensor_get_fl_prop (int s, const char* sel, float* val)
 132 {
 133         char buf[MAX_NAME_SIZE];
 134
 135         if (sensor_get_st_prop(s, sel, buf))
 136                 return -1;
 137
 138         *val = (float) strtod(buf, NULL);
 139         return 0;
 140 }
 141
 142
 143 char* sensor_get_name (int s)
 144 {
 145         if (sensor_info[s].friendly_name[0] != '\0' ||
 146                 !sensor_get_st_prop(s, "name", sensor_info[s].friendly_name))
 147                         return sensor_info[s].friendly_name;
 148
 149         /* If we got a iio device name from sysfs, use it */
 150         if (sensor_info[s].internal_name[0]) {
 151                 snprintf(sensor_info[s].friendly_name, MAX_NAME_SIZE, "S%d-%s",
 152                          s, sensor_info[s].internal_name);
 153         } else {
 154                 sprintf(sensor_info[s].friendly_name, "S%d", s);
 155         }
 156
 157         return sensor_info[s].friendly_name;
 158 }
 159
 160
 161 char* sensor_get_vendor (int s)
 162 {
 163         if (sensor_info[s].vendor_name[0] ||
 164                 !sensor_get_st_prop(s, "vendor", sensor_info[s].vendor_name))
 165                         return sensor_info[s].vendor_name;
 166
 167         return "";
 168 }
 169
 170
 171 int sensor_get_version (int s)
 172 {
 173         return IIO_SENSOR_HAL_VERSION;
 174 }
 175
 176
 177 float sensor_get_max_range (int s)
 178 {
 179         if (sensor_info[s].max_range != 0.0 ||
 180                 !sensor_get_fl_prop(s, "max_range", &sensor_info[s].max_range))
 181                         return sensor_info[s].max_range;
 182
 183         /* Try returning a sensible value given the sensor type */
 184
 185         /* We should cap returned samples accordingly... */
 186
 187         switch (sensor_info[s].type) {
 188                 case SENSOR_TYPE_ACCELEROMETER:         /* m/s^2        */
 189                         return 50;
 190
 191                 case SENSOR_TYPE_MAGNETIC_FIELD:        /* micro-tesla  */
 192                         return 500;
 193
 194                 case SENSOR_TYPE_ORIENTATION:           /* degrees      */
 195                         return 360;
 196
 197                 case SENSOR_TYPE_GYROSCOPE:             /* radians/s    */
 198                         return 10;
 199
 200                 case SENSOR_TYPE_LIGHT:                 /* SI lux units */
 201                         return 50000;
 202
 203                 case SENSOR_TYPE_AMBIENT_TEMPERATURE:   /* °C          */
 204                 case SENSOR_TYPE_TEMPERATURE:           /* °C          */
 205                 case SENSOR_TYPE_PROXIMITY:             /* centimeters  */
 206                 case SENSOR_TYPE_PRESSURE:              /* hecto-pascal */
 207                 case SENSOR_TYPE_RELATIVE_HUMIDITY:     /* percent */
 208                         return 100;
 209
 210                 default:
 211                         return 0.0;
 212                 }
 213 }
 214
 215 static float sensor_get_min_freq (int s)
 216 {
 217         /*
 218          * Check if a low cap has been specified for this sensor sampling rate.
 219          * In some case, even when the driver supports lower rate, we still
 220          * wish to receive a certain number of samples per seconds for various
 221          * reasons (calibration, filtering, no change in power consumption...).
 222          */
 223
 224         float min_freq;
 225
 226         if (!sensor_get_fl_prop(s, "min_freq", &min_freq))
 227                 return min_freq;
 228
 229         return 0;
 230 }
 231
 232
 233 static float sensor_get_max_freq (int s)
 234 {
 235         float max_freq;
 236
 237         if (!sensor_get_fl_prop(s, "max_freq", &max_freq))
 238                 return max_freq;
 239
 240         return 1000;
 241 }
 242
 243 int sensor_get_cal_steps (int s)
 244 {
 245         int cal_steps;
 246         if (!sensor_get_prop(s, "cal_steps", &cal_steps))
 247                 return cal_steps;
 248
 249         return 0;
 250 }
 251
 252 float sensor_get_resolution (int s)
 253 {
 254         if (sensor_info[s].resolution != 0.0 ||
 255                 !sensor_get_fl_prop(s, "resolution", &sensor_info[s].resolution))
 256                         return sensor_info[s].resolution;
 257
 258         return 0;
 259 }
 260
 261
 262 float sensor_get_power (int s)
 263 {
 264         /* mA used while sensor is in use ; not sure about volts :) */
 265         if (sensor_info[s].power != 0.0 ||
 266                 !sensor_get_fl_prop(s, "power", &sensor_info[s].power))
 267                         return sensor_info[s].power;
 268
 269         return 0;
 270 }
 271
 272
 273 float sensor_get_illumincalib (int s)
 274 {
 275         /* calibrating the ALS Sensor*/
 276         if (sensor_info[s].illumincalib != 0.0 ||
 277                 !sensor_get_fl_prop(s, "illumincalib", &sensor_info[s].illumincalib)) {
 278                         return sensor_info[s].illumincalib;
 279         }
 280
 281         return 0;
 282 }
 283
 284
 285 uint32_t sensor_get_quirks (int s)
 286 {
 287         char quirks_buf[MAX_NAME_SIZE];
 288
 289         /* Read and decode quirks property on first reference */
 290         if (!(sensor_info[s].quirks & QUIRK_ALREADY_DECODED)) {
 291                 quirks_buf[0] = '\0';
 292                 sensor_get_st_prop(s, "quirks", quirks_buf);
 293
 294                 if (strstr(quirks_buf, "init-rate"))
 295                         sensor_info[s].quirks |= QUIRK_INITIAL_RATE;
 296
 297                 if (strstr(quirks_buf, "continuous"))
 298                         sensor_info[s].quirks |= QUIRK_FORCE_CONTINUOUS;
 299
 300                 if (strstr(quirks_buf, "terse"))
 301                         sensor_info[s].quirks |= QUIRK_TERSE_DRIVER;
 302
 303                 if (strstr(quirks_buf, "noisy"))
 304                         sensor_info[s].quirks |= QUIRK_NOISY;
 305
 306                 sensor_info[s].quirks |= QUIRK_ALREADY_DECODED;
 307         }
 308
 309         return sensor_info[s].quirks;
 310 }
 311
 312
 313 int sensor_get_order (int s, unsigned char map[MAX_CHANNELS])
 314 {
 315         char buf[MAX_NAME_SIZE];
 316         int i;
 317         int count = sensor_catalog[sensor_info[s].catalog_index].num_channels;
 318
 319         if  (sensor_get_st_prop(s, "order", buf))
 320                 return 0; /* No order property */
 321
 322         /* Assume ASCII characters, in the '0'..'9' range */
 323
 324         for (i=0; i<count; i++)
 325                 if (buf[i] - '0' >= count) {
 326                         ALOGE("Order index out of range for sensor %d\n", s);
 327                         return 0;
 328                 }
 329
 330         for (i=0; i<count; i++)
 331                 map[i] = buf[i] - '0';
 332
 333         return 1;       /* OK to use modified ordering map */
 334 }
 335
 336 char* sensor_get_string_type (int s)
 337 {
 338         switch (sensor_info[s].type) {
 339                 case SENSOR_TYPE_ACCELEROMETER:
 340                         return SENSOR_STRING_TYPE_ACCELEROMETER;
 341
 342                 case SENSOR_TYPE_MAGNETIC_FIELD:
 343                         return SENSOR_STRING_TYPE_MAGNETIC_FIELD;
 344
 345                 case SENSOR_TYPE_ORIENTATION:
 346                         return SENSOR_STRING_TYPE_ORIENTATION;
 347
 348                 case SENSOR_TYPE_GYROSCOPE:
 349                         return SENSOR_STRING_TYPE_GYROSCOPE;
 350
 351                 case SENSOR_TYPE_GYROSCOPE_UNCALIBRATED:
 352                         return SENSOR_STRING_TYPE_GYROSCOPE_UNCALIBRATED;
 353
 354                 case SENSOR_TYPE_LIGHT:
 355                         return SENSOR_STRING_TYPE_LIGHT;
 356
 357                 case SENSOR_TYPE_AMBIENT_TEMPERATURE:
 358                         return SENSOR_STRING_TYPE_AMBIENT_TEMPERATURE;
 359
 360                 case SENSOR_TYPE_TEMPERATURE:
 361                         return SENSOR_STRING_TYPE_TEMPERATURE;
 362
 363                 case SENSOR_TYPE_PROXIMITY:
 364                         return SENSOR_STRING_TYPE_PROXIMITY;
 365
 366                 case SENSOR_TYPE_PRESSURE:
 367                         return SENSOR_STRING_TYPE_PRESSURE;
 368
 369                 case SENSOR_TYPE_RELATIVE_HUMIDITY:
 370                         return SENSOR_STRING_TYPE_RELATIVE_HUMIDITY;
 371
 372                 default:
 373                         return "";
 374                 }
 375 }
 376
 377 flag_t sensor_get_flags (int s)
 378 {
 379         flag_t flags = 0x0;
 380
 381         switch (sensor_info[s].type) {
 382                 case SENSOR_TYPE_ACCELEROMETER:
 383                 case SENSOR_TYPE_MAGNETIC_FIELD:
 384                 case SENSOR_TYPE_ORIENTATION:
 385                 case SENSOR_TYPE_GYROSCOPE:
 386                 case SENSOR_TYPE_GYROSCOPE_UNCALIBRATED:
 387                 case SENSOR_TYPE_PRESSURE:
 388                         flags |= SENSOR_FLAG_CONTINUOUS_MODE;
 389                         break;
 390
 391                 case SENSOR_TYPE_LIGHT:
 392                 case SENSOR_TYPE_AMBIENT_TEMPERATURE:
 393                 case SENSOR_TYPE_TEMPERATURE:
 394                 case SENSOR_TYPE_RELATIVE_HUMIDITY:
 395                         flags |= SENSOR_FLAG_ON_CHANGE_MODE;
 396                         break;
 397
 398
 399                 case SENSOR_TYPE_PROXIMITY:
 400                         flags |= SENSOR_FLAG_WAKE_UP;
 401                         flags |= SENSOR_FLAG_ON_CHANGE_MODE;
 402                         break;
 403
 404                 default:
 405                         ALOGI("Unknown sensor");
 406                 }
 407         return flags;
 408 }
 409
 410 int get_cdd_freq (int s, int must)
 411 {
 412         switch (sensor_info[s].type) {
 413                 case SENSOR_TYPE_ACCELEROMETER:
 414                         return (must ? 100 : 200); /* must 100 Hz, should 200 Hz, CDD compliant */
 415                 case SENSOR_TYPE_GYROSCOPE:
 416                 case SENSOR_TYPE_GYROSCOPE_UNCALIBRATED:
 417                         return (must ? 200 : 200); /* must 200 Hz, should 200 Hz, CDD compliant */
 418                 case SENSOR_TYPE_MAGNETIC_FIELD:
 419                         return (must ? 10 : 50);   /* must 10 Hz, should 50 Hz, CDD compliant */
 420                 case SENSOR_TYPE_LIGHT:
 421                 case SENSOR_TYPE_AMBIENT_TEMPERATURE:
 422                 case SENSOR_TYPE_TEMPERATURE:
 423                         return (must ? 1 : 2);     /* must 1 Hz, should 2Hz, not mentioned in CDD */
 424                 default:
 425                         return 0;
 426         }
 427 }
 428
 429 /* This value is defined only for continuous mode and on-change sensors. It is the delay between
 430  * two sensor events corresponding to the lowest frequency that this sensor supports. When lower
 431  * frequencies are requested through batch()/setDelay() the events will be generated at this
 432  * frequency instead. It can be used by the framework or applications to estimate when the batch
 433  * FIFO may be full.
 434  *
 435  * NOTE: 1) period_ns is in nanoseconds where as maxDelay/minDelay are in microseconds.
 436  *              continuous, on-change: maximum sampling period allowed in microseconds.
 437  *              one-shot, special : 0
 438  *   2) maxDelay should always fit within a 32 bit signed integer. It is declared as 64 bit
 439  *      on 64 bit architectures only for binary compatibility reasons.
 440  * Availability: SENSORS_DEVICE_API_VERSION_1_3
 441  */
 442 max_delay_t sensor_get_max_delay (int s)
 443 {
 444         char avail_sysfs_path[PATH_MAX];
 445         int dev_num     = sensor_info[s].dev_num;
 446         char freqs_buf[100];
 447         char* cursor;
 448         float min_supported_rate = 1000;
 449         float rate_cap;
 450         float sr;
 451
 452         /* continuous, on-change: maximum sampling period allowed in microseconds.
 453          * one-shot, special : 0
 454          */
 455         if (REPORTING_MODE(sensor_desc[s].flags) == SENSOR_FLAG_ONE_SHOT_MODE ||
 456             REPORTING_MODE(sensor_desc[s].flags) == SENSOR_FLAG_SPECIAL_REPORTING_MODE)
 457                 return 0;
 458
 459         sprintf(avail_sysfs_path, DEVICE_AVAIL_FREQ_PATH, dev_num);
 460
 461         if (sysfs_read_str(avail_sysfs_path, freqs_buf, sizeof(freqs_buf)) < 0) {
 462                 /* If poll mode sensor */
 463                 if (!sensor_info[s].num_channels) {
 464                         /* The must rate */
 465                         min_supported_rate = get_cdd_freq(s, 1);
 466                 }
 467         } else {
 468                 cursor = freqs_buf;
 469                 while (*cursor && cursor[0]) {
 470
 471                         /* Decode a single value */
 472                         sr = strtod(cursor, NULL);
 473
 474                         if (sr < min_supported_rate)
 475                                 min_supported_rate = sr;
 476
 477                         /* Skip digits */
 478                         while (cursor[0] && !isspace(cursor[0]))
 479                                 cursor++;
 480
 481                         /* Skip spaces */
 482                         while (cursor[0] && isspace(cursor[0]))
 483                                 cursor++;
 484                 }
 485         }
 486
 487         /* Check if a minimum rate was specified for this sensor */
 488         rate_cap = sensor_get_min_freq(s);
 489
 490         if (min_supported_rate < rate_cap)
 491                 min_supported_rate = rate_cap;
 492
 493         /* return 0 for wrong values */
 494         if (min_supported_rate < 0.1)
 495                 return 0;
 496
 497         /* Return microseconds */
 498         return (max_delay_t)(1000000.0 / min_supported_rate);
 499 }
 500
 501 /* this value depends on the reporting mode:
 502  *
 503  *   continuous: minimum sample period allowed in microseconds
 504  *   on-change : 0
 505  *   one-shot  :-1
 506  *   special   : 0, unless otherwise noted
 507  */
 508 int32_t sensor_get_min_delay(int s)
 509 {
 510         char avail_sysfs_path[PATH_MAX];
 511         int dev_num     = sensor_info[s].dev_num;
 512         char freqs_buf[100];
 513         char* cursor;
 514         float max_supported_rate = 0;
 515         float sr;
 516
 517         /* continuous: minimum sampling period allowed in microseconds.
 518          * on-change, special : 0
 519          * one-shot  :-1
 520          */
 521         if (REPORTING_MODE(sensor_desc[s].flags) == SENSOR_FLAG_ON_CHANGE_MODE ||
 522             REPORTING_MODE(sensor_desc[s].flags) == SENSOR_FLAG_SPECIAL_REPORTING_MODE)
 523                 return 0;
 524
 525         if (REPORTING_MODE(sensor_desc[s].flags) == SENSOR_FLAG_ONE_SHOT_MODE)
 526                 return -1;
 527
 528         sprintf(avail_sysfs_path, DEVICE_AVAIL_FREQ_PATH, dev_num);
 529
 530         if (sysfs_read_str(avail_sysfs_path, freqs_buf, sizeof(freqs_buf)) < 0) {
 531                 /* If poll mode sensor */
 532                 if (!sensor_info[s].num_channels) {
 533                         /* The should rate */
 534                         max_supported_rate = get_cdd_freq(s, 0);
 535                 }
 536         } else {
 537                 cursor = freqs_buf;
 538                 while (*cursor && cursor[0]) {
 539
 540                         /* Decode a single value */
 541                         sr = strtod(cursor, NULL);
 542
 543                         if (sr > max_supported_rate && sr <= sensor_get_max_freq(s))
 544                                 max_supported_rate = sr;
 545
 546                         /* Skip digits */
 547                         while (cursor[0] && !isspace(cursor[0]))
 548                                 cursor++;
 549
 550                         /* Skip spaces */
 551                         while (cursor[0] && isspace(cursor[0]))
 552                                 cursor++;
 553                 }
 554         }
 555
 556         /* return 0 for wrong values */
 557         if (max_supported_rate < 0.1)
 558                 return 0;
 559
 560         /* Return microseconds */
 561         return (int32_t)(1000000.0 / max_supported_rate);
 562 }