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 float sensor_get_max_freq (int s)
 216 {
 217         float max_freq;
 218
 219         if (!sensor_get_fl_prop(s, "max_freq", &max_freq))
 220                 return max_freq;
 221
 222         return 1000;
 223 }
 224
 225 int sensor_get_cal_steps (int s)
 226 {
 227         int cal_steps;
 228         if (!sensor_get_prop(s, "cal_steps", &cal_steps))
 229                 return cal_steps;
 230
 231         return 0;
 232 }
 233
 234 float sensor_get_resolution (int s)
 235 {
 236         if (sensor_info[s].resolution != 0.0 ||
 237                 !sensor_get_fl_prop(s, "resolution", &sensor_info[s].resolution))
 238                         return sensor_info[s].resolution;
 239
 240         return 0;
 241 }
 242
 243
 244 float sensor_get_power (int s)
 245 {
 246         /* mA used while sensor is in use ; not sure about volts :) */
 247         if (sensor_info[s].power != 0.0 ||
 248                 !sensor_get_fl_prop(s, "power", &sensor_info[s].power))
 249                         return sensor_info[s].power;
 250
 251         return 0;
 252 }
 253
 254
 255 float sensor_get_illumincalib (int s)
 256 {
 257         /* calibrating the ALS Sensor*/
 258         if (sensor_info[s].illumincalib != 0.0 ||
 259                 !sensor_get_fl_prop(s, "illumincalib", &sensor_info[s].illumincalib)) {
 260                         return sensor_info[s].illumincalib;
 261         }
 262
 263         return 0;
 264 }
 265
 266
 267 uint32_t sensor_get_quirks (int s)
 268 {
 269         char quirks_buf[MAX_NAME_SIZE];
 270
 271         /* Read and decode quirks property on first reference */
 272         if (!(sensor_info[s].quirks & QUIRK_ALREADY_DECODED)) {
 273                 quirks_buf[0] = '\0';
 274                 sensor_get_st_prop(s, "quirks", quirks_buf);
 275
 276                 if (strstr(quirks_buf, "init-rate"))
 277                         sensor_info[s].quirks |= QUIRK_INITIAL_RATE;
 278
 279                 if (strstr(quirks_buf, "continuous"))
 280                         sensor_info[s].quirks |= QUIRK_FORCE_CONTINUOUS;
 281
 282                 if (strstr(quirks_buf, "terse"))
 283                         sensor_info[s].quirks |= QUIRK_TERSE_DRIVER;
 284
 285                 if (strstr(quirks_buf, "noisy"))
 286                         sensor_info[s].quirks |= QUIRK_NOISY;
 287
 288                 sensor_info[s].quirks |= QUIRK_ALREADY_DECODED;
 289         }
 290
 291         return sensor_info[s].quirks;
 292 }
 293
 294
 295 int sensor_get_order (int s, unsigned char map[MAX_CHANNELS])
 296 {
 297         char buf[MAX_NAME_SIZE];
 298         int i;
 299         int count = sensor_catalog[sensor_info[s].catalog_index].num_channels;
 300
 301         if  (sensor_get_st_prop(s, "order", buf))
 302                 return 0; /* No order property */
 303
 304         /* Assume ASCII characters, in the '0'..'9' range */
 305
 306         for (i=0; i<count; i++)
 307                 if (buf[i] - '0' >= count) {
 308                         ALOGE("Order index out of range for sensor %d\n", s);
 309                         return 0;
 310                 }
 311
 312         for (i=0; i<count; i++)
 313                 map[i] = buf[i] - '0';
 314
 315         return 1;       /* OK to use modified ordering map */
 316 }
 317
 318 char* sensor_get_string_type (int s)
 319 {
 320         switch (sensor_info[s].type) {
 321                 case SENSOR_TYPE_ACCELEROMETER:
 322                         return SENSOR_STRING_TYPE_ACCELEROMETER;
 323
 324                 case SENSOR_TYPE_MAGNETIC_FIELD:
 325                         return SENSOR_STRING_TYPE_MAGNETIC_FIELD;
 326
 327                 case SENSOR_TYPE_ORIENTATION:
 328                         return SENSOR_STRING_TYPE_ORIENTATION;
 329
 330                 case SENSOR_TYPE_GYROSCOPE:
 331                         return SENSOR_STRING_TYPE_GYROSCOPE;
 332
 333                 case SENSOR_TYPE_GYROSCOPE_UNCALIBRATED:
 334                         return SENSOR_STRING_TYPE_GYROSCOPE_UNCALIBRATED;
 335
 336                 case SENSOR_TYPE_LIGHT:
 337                         return SENSOR_STRING_TYPE_LIGHT;
 338
 339                 case SENSOR_TYPE_AMBIENT_TEMPERATURE:
 340                         return SENSOR_STRING_TYPE_AMBIENT_TEMPERATURE;
 341
 342                 case SENSOR_TYPE_TEMPERATURE:
 343                         return SENSOR_STRING_TYPE_TEMPERATURE;
 344
 345                 case SENSOR_TYPE_PROXIMITY:
 346                         return SENSOR_STRING_TYPE_PROXIMITY;
 347
 348                 case SENSOR_TYPE_PRESSURE:
 349                         return SENSOR_STRING_TYPE_PRESSURE;
 350
 351                 case SENSOR_TYPE_RELATIVE_HUMIDITY:
 352                         return SENSOR_STRING_TYPE_RELATIVE_HUMIDITY;
 353
 354                 default:
 355                         return "";
 356                 }
 357 }
 358
 359 flag_t sensor_get_flags (int s)
 360 {
 361         flag_t flags = 0x0;
 362
 363         switch (sensor_info[s].type) {
 364                 case SENSOR_TYPE_ACCELEROMETER:
 365                 case SENSOR_TYPE_MAGNETIC_FIELD:
 366                 case SENSOR_TYPE_ORIENTATION:
 367                 case SENSOR_TYPE_GYROSCOPE:
 368                 case SENSOR_TYPE_GYROSCOPE_UNCALIBRATED:
 369                 case SENSOR_TYPE_PRESSURE:
 370                         flags |= SENSOR_FLAG_CONTINUOUS_MODE;
 371                         break;
 372
 373                 case SENSOR_TYPE_LIGHT:
 374                 case SENSOR_TYPE_AMBIENT_TEMPERATURE:
 375                 case SENSOR_TYPE_TEMPERATURE:
 376                 case SENSOR_TYPE_RELATIVE_HUMIDITY:
 377                         flags |= SENSOR_FLAG_ON_CHANGE_MODE;
 378                         break;
 379
 380
 381                 case SENSOR_TYPE_PROXIMITY:
 382                         flags |= SENSOR_FLAG_WAKE_UP;
 383                         flags |= SENSOR_FLAG_ON_CHANGE_MODE;
 384                         break;
 385
 386                 default:
 387                         ALOGI("Unknown sensor");
 388                 }
 389         return flags;
 390 }
 391
 392 int get_cdd_freq (int s, int must)
 393 {
 394         switch (sensor_info[s].type) {
 395                 case SENSOR_TYPE_ACCELEROMETER:
 396                         return (must ? 100 : 200); /* must 100 Hz, should 200 Hz, CDD compliant */
 397                 case SENSOR_TYPE_GYROSCOPE:
 398                 case SENSOR_TYPE_GYROSCOPE_UNCALIBRATED:
 399                         return (must ? 200 : 200); /* must 200 Hz, should 200 Hz, CDD compliant */
 400                 case SENSOR_TYPE_MAGNETIC_FIELD:
 401                         return (must ? 10 : 50);   /* must 10 Hz, should 50 Hz, CDD compliant */
 402                 case SENSOR_TYPE_LIGHT:
 403                 case SENSOR_TYPE_AMBIENT_TEMPERATURE:
 404                 case SENSOR_TYPE_TEMPERATURE:
 405                         return (must ? 1 : 2);     /* must 1 Hz, should 2Hz, not mentioned in CDD */
 406                 default:
 407                         return 0;
 408         }
 409 }
 410
 411 /* This value is defined only for continuous mode and on-change sensors. It is the delay between
 412  * two sensor events corresponding to the lowest frequency that this sensor supports. When lower
 413  * frequencies are requested through batch()/setDelay() the events will be generated at this
 414  * frequency instead. It can be used by the framework or applications to estimate when the batch
 415  * FIFO may be full.
 416  *
 417  * NOTE: 1) period_ns is in nanoseconds where as maxDelay/minDelay are in microseconds.
 418  *              continuous, on-change: maximum sampling period allowed in microseconds.
 419  *              one-shot, special : 0
 420  *   2) maxDelay should always fit within a 32 bit signed integer. It is declared as 64 bit
 421  *      on 64 bit architectures only for binary compatibility reasons.
 422  * Availability: SENSORS_DEVICE_API_VERSION_1_3
 423  */
 424 max_delay_t sensor_get_max_delay (int s)
 425 {
 426         char avail_sysfs_path[PATH_MAX];
 427         int dev_num     = sensor_info[s].dev_num;
 428         char freqs_buf[100];
 429         char* cursor;
 430         float min_supported_rate = 1000;
 431         float sr;
 432
 433         /* continuous, on-change: maximum sampling period allowed in microseconds.
 434          * one-shot, special : 0
 435          */
 436         if (REPORTING_MODE(sensor_desc[s].flags) == SENSOR_FLAG_ONE_SHOT_MODE ||
 437             REPORTING_MODE(sensor_desc[s].flags) == SENSOR_FLAG_SPECIAL_REPORTING_MODE)
 438                 return 0;
 439
 440         sprintf(avail_sysfs_path, DEVICE_AVAIL_FREQ_PATH, dev_num);
 441
 442         if (sysfs_read_str(avail_sysfs_path, freqs_buf, sizeof(freqs_buf)) < 0) {
 443                 /* If poll mode sensor */
 444                 if (!sensor_info[s].num_channels) {
 445                         /* The must rate */
 446                         min_supported_rate = get_cdd_freq(s, 1);
 447                 }
 448         } else {
 449                 cursor = freqs_buf;
 450                 while (*cursor && cursor[0]) {
 451
 452                         /* Decode a single value */
 453                         sr = strtod(cursor, NULL);
 454
 455                         if (sr < min_supported_rate)
 456                                 min_supported_rate = sr;
 457
 458                         /* Skip digits */
 459                         while (cursor[0] && !isspace(cursor[0]))
 460                                 cursor++;
 461
 462                         /* Skip spaces */
 463                         while (cursor[0] && isspace(cursor[0]))
 464                                 cursor++;
 465                 }
 466         }
 467
 468         /* return 0 for wrong values */
 469         if (min_supported_rate < 0.1)
 470                 return 0;
 471
 472         /* Return microseconds */
 473         return (max_delay_t)(1000000.0 / min_supported_rate);
 474 }
 475
 476 /* this value depends on the reporting mode:
 477  *
 478  *   continuous: minimum sample period allowed in microseconds
 479  *   on-change : 0
 480  *   one-shot  :-1
 481  *   special   : 0, unless otherwise noted
 482  */
 483 int32_t sensor_get_min_delay(int s)
 484 {
 485         char avail_sysfs_path[PATH_MAX];
 486         int dev_num     = sensor_info[s].dev_num;
 487         char freqs_buf[100];
 488         char* cursor;
 489         float max_supported_rate = 0;
 490         float sr;
 491
 492         /* continuous: minimum sampling period allowed in microseconds.
 493          * on-change, special : 0
 494          * one-shot  :-1
 495          */
 496         if (REPORTING_MODE(sensor_desc[s].flags) == SENSOR_FLAG_ON_CHANGE_MODE ||
 497             REPORTING_MODE(sensor_desc[s].flags) == SENSOR_FLAG_SPECIAL_REPORTING_MODE)
 498                 return 0;
 499
 500         if (REPORTING_MODE(sensor_desc[s].flags) == SENSOR_FLAG_ONE_SHOT_MODE)
 501                 return -1;
 502
 503         sprintf(avail_sysfs_path, DEVICE_AVAIL_FREQ_PATH, dev_num);
 504
 505         if (sysfs_read_str(avail_sysfs_path, freqs_buf, sizeof(freqs_buf)) < 0) {
 506                 /* If poll mode sensor */
 507                 if (!sensor_info[s].num_channels) {
 508                         /* The should rate */
 509                         max_supported_rate = get_cdd_freq(s, 0);
 510                 }
 511         } else {
 512                 cursor = freqs_buf;
 513                 while (*cursor && cursor[0]) {
 514
 515                         /* Decode a single value */
 516                         sr = strtod(cursor, NULL);
 517
 518                         if (sr > max_supported_rate && sr <= sensor_get_max_freq(s))
 519                                 max_supported_rate = sr;
 520
 521                         /* Skip digits */
 522                         while (cursor[0] && !isspace(cursor[0]))
 523                                 cursor++;
 524
 525                         /* Skip spaces */
 526                         while (cursor[0] && isspace(cursor[0]))
 527                                 cursor++;
 528                 }
 529         }
 530
 531         /* return 0 for wrong values */
 532         if (max_supported_rate < 0.1)
 533                 return 0;
 534
 535         /* Return microseconds */
 536         return (int32_t)(1000000.0 / max_supported_rate);
 537 }