control.c

   1 /*
   2  * Copyright (C) 2014 Intel Corporation.
   3  */
   4
   5 #include <stdlib.h>
   6 #include <ctype.h>
   7 #include <fcntl.h>
   8 #include <pthread.h>
   9 #include <time.h>
  10 #include <math.h>
  11 #include <sys/epoll.h>
  12 #include <sys/socket.h>
  13 #include <utils/Log.h>
  14 #include <hardware/sensors.h>
  15 #include "control.h"
  16 #include "enumeration.h"
  17 #include "utils.h"
  18 #include "transform.h"
  19 #include "calibration.h"
  20 #include "description.h"
  21 #include "filtering.h"
  22
  23 /* Currently active sensors count, per device */
  24 static int poll_sensors_per_dev[MAX_DEVICES];           /* poll-mode sensors                            */
  25 static int trig_sensors_per_dev[MAX_DEVICES];           /* trigger, event based                         */
  26
  27 static int device_fd[MAX_DEVICES];                      /* fd on the /dev/iio:deviceX file              */
  28 static int has_iio_ts[MAX_DEVICES];                     /* ts channel available on this iio dev         */
  29 static int expected_dev_report_size[MAX_DEVICES];       /* expected iio scan len                        */
  30 static int poll_fd;                                     /* epoll instance covering all enabled sensors  */
  31
  32 static int active_poll_sensors;                         /* Number of enabled poll-mode sensors          */
  33
  34 /* We use pthread condition variables to get worker threads out of sleep */
  35 static pthread_condattr_t thread_cond_attr      [MAX_SENSORS];
  36 static pthread_cond_t     thread_release_cond   [MAX_SENSORS];
  37 static pthread_mutex_t    thread_release_mutex  [MAX_SENSORS];
  38
  39 /*
  40  * We associate tags to each of our poll set entries. These tags have the following values:
  41  * - a iio device number if the fd is a iio character device fd
  42  * - THREAD_REPORT_TAG_BASE + sensor handle if the fd is the receiving end of a pipe used by a sysfs data acquisition thread
  43  */
  44 #define THREAD_REPORT_TAG_BASE          1000
  45
  46 /* If buffer enable fails, we may want to retry a few times before giving up */
  47 #define ENABLE_BUFFER_RETRIES           3
  48 #define ENABLE_BUFFER_RETRY_DELAY_MS    10
  49
  50
  51 inline int is_enabled (int s)
  52 {
  53         return sensor[s].directly_enabled || sensor[s].ref_count;
  54 }
  55
  56
  57 static int check_state_change (int s, int enabled, int from_virtual)
  58 {
  59         if (enabled) {
  60                 if (sensor[s].directly_enabled)
  61                         return 0;                       /* We're being enabled but already were directly activated: no change. */
  62
  63                 if (!from_virtual)
  64                         sensor[s].directly_enabled = 1; /* We're being directly enabled */
  65
  66                 if (sensor[s].ref_count)
  67                         return 0;                       /* We were already indirectly enabled */
  68
  69                 return 1;                               /* Do continue enabling this sensor */
  70         }
  71
  72         if (!is_enabled(s))
  73                 return 0;                               /* We are being disabled but already were: no change */
  74
  75         if (from_virtual && sensor[s].directly_enabled)
  76                 return 0;                               /* We're indirectly disabled but the base is still active */
  77
  78         sensor[s].directly_enabled = 0;                 /* We're now directly disabled */
  79
  80         if (!from_virtual && sensor[s].ref_count)
  81                 return 0;                               /* We still have ref counts */
  82
  83         return 1;                                       /* Do continue disabling this sensor */
  84 }
  85
  86
  87 static int enable_buffer (int dev_num, int enabled)
  88 {
  89         char sysfs_path[PATH_MAX];
  90         int retries = ENABLE_BUFFER_RETRIES;
  91
  92         sprintf(sysfs_path, ENABLE_PATH, dev_num);
  93
  94         while (retries) {
  95                 /* Low level, non-multiplexed, enable/disable routine */
  96                 if (sysfs_write_int(sysfs_path, enabled) > 0)
  97                         return 0;
  98
  99                 ALOGE("Failed enabling buffer on dev%d, retrying", dev_num);
 100                 usleep(ENABLE_BUFFER_RETRY_DELAY_MS*1000);
 101                 retries--;
 102         }
 103
 104         ALOGE("Could not enable buffer\n");
 105         return -EIO;
 106 }
 107
 108
 109 static int setup_trigger (int s, const char* trigger_val)
 110 {
 111         char sysfs_path[PATH_MAX];
 112         int ret = -1, attempts = 5;
 113
 114         sprintf(sysfs_path, TRIGGER_PATH, sensor[s].dev_num);
 115
 116         if (trigger_val[0] != '\n')
 117                 ALOGI("Setting S%d (%s) trigger to %s\n", s, sensor[s].friendly_name, trigger_val);
 118
 119         while (ret == -1 && attempts) {
 120                 ret = sysfs_write_str(sysfs_path, trigger_val);
 121                 attempts--;
 122         }
 123
 124         if (ret != -1)
 125                 sensor[s].selected_trigger = trigger_val;
 126         else
 127                 ALOGE("Setting S%d (%s) trigger to %s FAILED.\n", s, sensor[s].friendly_name, trigger_val);
 128         return ret;
 129 }
 130
 131
 132 static void enable_iio_timestamp (int dev_num, int known_channels)
 133 {
 134         /* Check if we have a dedicated iio timestamp channel */
 135
 136         char spec_buf[MAX_TYPE_SPEC_LEN];
 137         char sysfs_path[PATH_MAX];
 138         int n;
 139
 140         sprintf(sysfs_path, CHANNEL_PATH "%s", dev_num, "in_timestamp_type");
 141
 142         n = sysfs_read_str(sysfs_path, spec_buf, sizeof(spec_buf));
 143
 144         if (n <= 0)
 145                 return;
 146
 147         if (strcmp(spec_buf, "le:s64/64>>0"))
 148                 return;
 149
 150         /* OK, type is int64_t as expected, in little endian representation */
 151
 152         sprintf(sysfs_path, CHANNEL_PATH"%s", dev_num, "in_timestamp_index");
 153
 154         if (sysfs_read_int(sysfs_path, &n))
 155                 return;
 156
 157         /* Check that the timestamp comes after the other fields we read */
 158         if (n != known_channels)
 159                 return;
 160
 161         /* Try enabling that channel */
 162         sprintf(sysfs_path, CHANNEL_PATH "%s", dev_num, "in_timestamp_en");
 163
 164         sysfs_write_int(sysfs_path, 1);
 165
 166         if (sysfs_read_int(sysfs_path, &n))
 167                 return;
 168
 169         if (n) {
 170                 ALOGI("Detected timestamp channel on iio device %d\n", dev_num);
 171                 has_iio_ts[dev_num] = 1;
 172         }
 173 }
 174
 175
 176 static int decode_type_spec (const char type_buf[MAX_TYPE_SPEC_LEN], datum_info_t *type_info)
 177 {
 178         /* Return size in bytes for this type specification, or -1 in error */
 179         char sign;
 180         char endianness;
 181         unsigned int realbits, storagebits, shift;
 182         int tokens;
 183
 184         /* Valid specs: "le:u10/16>>0", "le:s16/32>>0" or "le:s32/32>>0" */
 185
 186         tokens = sscanf(type_buf, "%ce:%c%u/%u>>%u", &endianness, &sign, &realbits, &storagebits, &shift);
 187
 188         if (tokens != 5 || (endianness != 'b' && endianness != 'l') || (sign != 'u' && sign != 's') ||
 189             realbits > storagebits || (storagebits != 16 && storagebits != 32 && storagebits != 64)) {
 190                         ALOGE("Invalid iio channel type spec: %s\n", type_buf);
 191                         return -1;
 192         }
 193
 194         type_info->endianness   =               endianness;
 195         type_info->sign         =               sign;
 196         type_info->realbits     =       (short) realbits;
 197         type_info->storagebits  =       (short) storagebits;
 198         type_info->shift        =       (short) shift;
 199
 200         return storagebits / 8;
 201 }
 202
 203
 204 void build_sensor_report_maps (int dev_num)
 205 {
 206         /*
 207          * Read sysfs files from a iio device's scan_element directory, and build a couple of tables from that data. These tables will tell, for
 208          * each sensor, where to gather relevant data in a device report, i.e. the structure that we read from the /dev/iio:deviceX file in order to
 209          * sensor report, itself being the data that we return to Android when a sensor poll completes. The mapping should be straightforward in the
 210          * case where we have a single sensor active per iio device but, this is not the general case. In general several sensors can be handled
 211          * through a single iio device, and the _en, _index and _type syfs entries all concur to paint a picture of what the structure of the
 212          * device report is.
 213          */
 214
 215         int s;
 216         int c;
 217         int n;
 218         int i;
 219         int ch_index;
 220         char* ch_spec;
 221         char spec_buf[MAX_TYPE_SPEC_LEN];
 222         datum_info_t* ch_info;
 223         int size;
 224         char sysfs_path[PATH_MAX];
 225         int known_channels;
 226         int offset;
 227         int channel_size_from_index[MAX_SENSORS * MAX_CHANNELS] = { 0 };
 228         int sensor_handle_from_index[MAX_SENSORS * MAX_CHANNELS] = { 0 };
 229         int channel_number_from_index[MAX_SENSORS * MAX_CHANNELS] = { 0 };
 230
 231         known_channels = 0;
 232
 233         /* For each sensor that is linked to this device */
 234         for (s=0; s<sensor_count; s++) {
 235                 if (sensor[s].dev_num != dev_num)
 236                         continue;
 237
 238                 i = sensor[s].catalog_index;
 239
 240                 /* Read channel details through sysfs attributes */
 241                 for (c=0; c<sensor[s].num_channels; c++) {
 242
 243                         /* Read _type file */
 244                         sprintf(sysfs_path, CHANNEL_PATH "%s", sensor[s].dev_num, sensor_catalog[i].channel[c].type_path);
 245
 246                         n = sysfs_read_str(sysfs_path, spec_buf, sizeof(spec_buf));
 247
 248                         if (n == -1) {
 249                                         ALOGW(  "Failed to read type: %s\n", sysfs_path);
 250                                         continue;
 251                         }
 252
 253                         ch_spec = sensor[s].channel[c].type_spec;
 254
 255                         memcpy(ch_spec, spec_buf, sizeof(spec_buf));
 256
 257                         ch_info = &sensor[s].channel[c].type_info;
 258
 259                         size = decode_type_spec(ch_spec, ch_info);
 260
 261                         /* Read _index file */
 262                         sprintf(sysfs_path, CHANNEL_PATH "%s", sensor[s].dev_num, sensor_catalog[i].channel[c].index_path);
 263
 264                         n = sysfs_read_int(sysfs_path, &ch_index);
 265
 266                         if (n == -1) {
 267                                         ALOGW(  "Failed to read index: %s\n", sysfs_path);
 268                                         continue;
 269                         }
 270
 271                         if (ch_index >= MAX_SENSORS) {
 272                                 ALOGE("Index out of bounds!: %s\n", sysfs_path);
 273                                 continue;
 274                         }
 275
 276                         /* Record what this index is about */
 277
 278                         sensor_handle_from_index [ch_index] = s;
 279                         channel_number_from_index[ch_index] = c;
 280                         channel_size_from_index  [ch_index] = size;
 281
 282                         known_channels++;
 283                 }
 284
 285                 /* Stop sampling - if we are recovering from hal restart */
 286                 enable_buffer(dev_num, 0);
 287                 setup_trigger(s, "\n");
 288
 289                 /* Turn on channels we're aware of */
 290                 for (c=0;c<sensor[s].num_channels; c++) {
 291                         sprintf(sysfs_path, CHANNEL_PATH "%s", sensor[s].dev_num, sensor_catalog[i].channel[c].en_path);
 292                         sysfs_write_int(sysfs_path, 1);
 293                 }
 294         }
 295
 296         ALOGI("Found %d channels on iio device %d\n", known_channels, dev_num);
 297
 298         /*
 299          * Now that we know which channels are defined, their sizes and their ordering, update channels offsets within device report. Note: there
 300          * is a possibility that several sensors share the same index, with their data fields being isolated by masking and shifting as specified
 301          * through the real bits and shift values in type attributes. This case is not currently supported. Also, the code below assumes no hole in
 302          * the sequence of indices, so it is dependent on discovery of all sensors.
 303          */
 304          offset = 0;
 305
 306          for (i=0; i<MAX_SENSORS * MAX_CHANNELS; i++) {
 307                 s =     sensor_handle_from_index[i];
 308                 c =     channel_number_from_index[i];
 309                 size =  channel_size_from_index[i];
 310
 311                 if (!size)
 312                         continue;
 313
 314                 ALOGI("S%d C%d : offset %d, size %d, type %s\n", s, c, offset, size, sensor[s].channel[c].type_spec);
 315
 316                 sensor[s].channel[c].offset     = offset;
 317                 sensor[s].channel[c].size               = size;
 318
 319                 offset += size;
 320          }
 321
 322         /* Enable the timestamp channel if there is one available */
 323         enable_iio_timestamp(dev_num, known_channels);
 324
 325         /* Add padding and timestamp size if it's enabled on this iio device */
 326         if (has_iio_ts[dev_num])
 327                 offset = (offset+7)/8*8 + sizeof(int64_t);
 328
 329         expected_dev_report_size[dev_num] = offset;
 330         ALOGI("Expecting %d scan length on iio dev %d\n", offset, dev_num);
 331
 332         if (expected_dev_report_size[dev_num] > MAX_DEVICE_REPORT_SIZE) {
 333                 ALOGE("Unexpectedly large scan buffer on iio dev%d: %d bytes\n", dev_num, expected_dev_report_size[dev_num]);
 334
 335                 expected_dev_report_size[dev_num] = MAX_DEVICE_REPORT_SIZE;
 336         }
 337 }
 338
 339
 340 int adjust_counters (int s, int enabled, int from_virtual)
 341 {
 342         /*
 343          * Adjust counters based on sensor enable action. Return values are:
 344          *  0 if the operation was completed and we're all set
 345          *  1 if we toggled the state of the sensor and there's work left
 346          */
 347
 348         int dev_num = sensor[s].dev_num;
 349
 350         if (!check_state_change(s, enabled, from_virtual))
 351                 return 0; /* The state of the sensor remains the same: we're done */
 352
 353         if (enabled) {
 354                 ALOGI("Enabling sensor %d (iio device %d: %s)\n", s, dev_num, sensor[s].friendly_name);
 355
 356                 switch (sensor[s].type) {
 357                         case SENSOR_TYPE_MAGNETIC_FIELD:
 358                                 compass_read_data(&sensor[s]);
 359                                 break;
 360
 361                         case SENSOR_TYPE_GYROSCOPE:
 362                                 gyro_cal_init(&sensor[s]);
 363                                 break;
 364                 }
 365         } else {
 366                 ALOGI("Disabling sensor %d (iio device %d: %s)\n", s, dev_num, sensor[s].friendly_name);
 367
 368                 /* Sensor disabled, lower report available flag */
 369                 sensor[s].report_pending = 0;
 370
 371                 if (sensor[s].type == SENSOR_TYPE_MAGNETIC_FIELD)
 372                         compass_store_data(&sensor[s]);
 373
 374                 if (sensor[s].type == SENSOR_TYPE_GYROSCOPE)
 375                         gyro_store_data(&sensor[s]);
 376         }
 377
 378         /* We changed the state of a sensor: adjust device ref counts */
 379
 380         if (!sensor[s].is_polling) {
 381
 382                         if (enabled)
 383                                 trig_sensors_per_dev[dev_num]++;
 384                         else
 385                                 trig_sensors_per_dev[dev_num]--;
 386
 387                         return 1;
 388         }
 389
 390         if (enabled) {
 391                 active_poll_sensors++;
 392                 poll_sensors_per_dev[dev_num]++;
 393                 return 1;
 394         }
 395
 396         active_poll_sensors--;
 397         poll_sensors_per_dev[dev_num]--;
 398         return 1;
 399 }
 400
 401
 402 static int get_field_count (int s)
 403 {
 404         switch (sensor[s].type) {
 405                 case SENSOR_TYPE_ACCELEROMETER:         /* m/s^2        */
 406                 case SENSOR_TYPE_MAGNETIC_FIELD:        /* micro-tesla  */
 407                 case SENSOR_TYPE_ORIENTATION:           /* degrees      */
 408                 case SENSOR_TYPE_GYROSCOPE_UNCALIBRATED:
 409                 case SENSOR_TYPE_GYROSCOPE:             /* radians/s    */
 410                         return 3;
 411
 412                 case SENSOR_TYPE_LIGHT:                 /* SI lux units */
 413                 case SENSOR_TYPE_AMBIENT_TEMPERATURE:   /* °C          */
 414                 case SENSOR_TYPE_TEMPERATURE:           /* °C          */
 415                 case SENSOR_TYPE_PROXIMITY:             /* centimeters  */
 416                 case SENSOR_TYPE_PRESSURE:              /* hecto-pascal */
 417                 case SENSOR_TYPE_RELATIVE_HUMIDITY:     /* percent */
 418                         return 1;
 419
 420                 case SENSOR_TYPE_ROTATION_VECTOR:
 421                         return 4;
 422
 423                 default:
 424                         ALOGE("Unknown sensor type!\n");
 425                         return 0;                       /* Drop sample */
 426         }
 427 }
 428
 429
 430 static void* acquisition_routine (void* param)
 431 {
 432         /*
 433          * Data acquisition routine run in a dedicated thread, covering a single sensor. This loop will periodically retrieve sampling data through
 434          * sysfs, then package it as a sample and transfer it to our master poll loop through a report fd. Checks for a cancellation signal quite
 435          * frequently, as the thread may be disposed of at any time. Note that Bionic does not provide pthread_cancel / pthread_testcancel...
 436          */
 437
 438         int s = (int) (size_t) param;
 439         int num_fields;
 440         sensors_event_t data = {0};
 441         int c;
 442         int ret;
 443         struct timespec target_time;
 444         int64_t timestamp, period, start, stop;
 445
 446         if (s < 0 || s >= sensor_count) {
 447                 ALOGE("Invalid sensor handle!\n");
 448                 return NULL;
 449         }
 450
 451         ALOGI("Entering S%d (%s) data acquisition thread: rate:%g\n", s, sensor[s].friendly_name, sensor[s].sampling_rate);
 452
 453         if (sensor[s].sampling_rate <= 0) {
 454                 ALOGE("Invalid rate in acquisition routine for sensor %d: %g\n", s, sensor[s].sampling_rate);
 455                 return NULL;
 456         }
 457
 458         /* Initialize data fields that will be shared by all sensor reports */
 459         data.version    = sizeof(sensors_event_t);
 460         data.sensor     = s;
 461         data.type       = sensor[s].type;
 462
 463         num_fields = get_field_count(s);
 464
 465         /*
 466          * Each condition variable is associated to a mutex that has to be locked by the thread that's waiting on it. We use these condition
 467          * variables to get the acquisition threads out of sleep quickly after the sampling rate is adjusted, or the sensor is disabled.
 468          */
 469         pthread_mutex_lock(&thread_release_mutex[s]);
 470
 471         /* Pinpoint the moment we start sampling */
 472         timestamp = get_timestamp_monotonic();
 473
 474         /* Check and honor termination requests */
 475         while (sensor[s].thread_data_fd[1] != -1) {
 476                 start = get_timestamp_boot();
 477
 478                 /* Read values through sysfs */
 479                 for (c=0; c<num_fields; c++) {
 480                         data.data[c] = acquire_immediate_value(s, c);
 481
 482                         /* Check and honor termination requests */
 483                         if (sensor[s].thread_data_fd[1] == -1)
 484                                 goto exit;
 485                 }
 486                 stop = get_timestamp_boot();
 487                 data.timestamp = start/2 + stop/2;
 488
 489                 /* If the sample looks good */
 490                 if (sensor[s].ops.finalize(s, &data)) {
 491
 492                         /* Pipe it for transmission to poll loop */
 493                         ret = write(sensor[s].thread_data_fd[1], &data, sizeof(sensors_event_t));
 494
 495                         if (ret != sizeof(sensors_event_t))
 496                                 ALOGE("S%d write failure: wrote %d, got %d\n", s, sizeof(sensors_event_t), ret);
 497                 }
 498
 499                 /* Check and honor termination requests */
 500                 if (sensor[s].thread_data_fd[1] == -1)
 501                         goto exit;
 502
 503                 /* Recalculate period assuming sensor[s].sampling_rate can be changed dynamically during the thread run */
 504                 if (sensor[s].sampling_rate <= 0) {
 505                         ALOGE("Unexpected sampling rate for sensor %d: %g\n", s, sensor[s].sampling_rate);
 506                         goto exit;
 507                 }
 508
 509                 period = (int64_t) (1000000000.0 / sensor[s].sampling_rate);
 510                 timestamp += period;
 511                 set_timestamp(&target_time, timestamp);
 512
 513                 /* Wait until the sampling time elapses, or a rate change is signaled, or a thread exit is requested */
 514                 ret = pthread_cond_timedwait(&thread_release_cond[s], &thread_release_mutex[s], &target_time);
 515         }
 516
 517 exit:
 518         ALOGV("Acquisition thread for S%d exiting\n", s);
 519         pthread_mutex_unlock(&thread_release_mutex[s]);
 520         pthread_exit(0);
 521         return NULL;
 522 }
 523
 524
 525 static void start_acquisition_thread (int s)
 526 {
 527         int incoming_data_fd;
 528         int ret;
 529
 530         struct epoll_event ev = {0};
 531
 532         ALOGV("Initializing acquisition context for sensor %d\n", s);
 533
 534         /* Create condition variable and mutex for quick thread release */
 535         ret = pthread_condattr_init(&thread_cond_attr[s]);
 536         ret = pthread_condattr_setclock(&thread_cond_attr[s], CLOCK_MONOTONIC);
 537         ret = pthread_cond_init(&thread_release_cond[s], &thread_cond_attr[s]);
 538         ret = pthread_mutex_init(&thread_release_mutex[s], NULL);
 539
 540         /* Create a pipe for inter thread communication */
 541         ret = pipe(sensor[s].thread_data_fd);
 542
 543         incoming_data_fd = sensor[s].thread_data_fd[0];
 544
 545         ev.events = EPOLLIN;
 546         ev.data.u32 = THREAD_REPORT_TAG_BASE + s;
 547
 548         /* Add incoming side of pipe to our poll set, with a suitable tag */
 549         ret = epoll_ctl(poll_fd, EPOLL_CTL_ADD, incoming_data_fd , &ev);
 550
 551         /* Create and start worker thread */
 552         ret = pthread_create(&sensor[s].acquisition_thread, NULL, acquisition_routine, (void*) (size_t) s);
 553 }
 554
 555
 556 static void stop_acquisition_thread (int s)
 557 {
 558         int incoming_data_fd = sensor[s].thread_data_fd[0];
 559         int outgoing_data_fd = sensor[s].thread_data_fd[1];
 560
 561         ALOGV("Tearing down acquisition context for sensor %d\n", s);
 562
 563         /* Delete the incoming side of the pipe from our poll set */
 564         epoll_ctl(poll_fd, EPOLL_CTL_DEL, incoming_data_fd, NULL);
 565
 566         /* Mark the pipe ends as invalid ; that's a cheap exit flag */
 567         sensor[s].thread_data_fd[0] = -1;
 568         sensor[s].thread_data_fd[1] = -1;
 569
 570         /* Close both sides of our pipe */
 571         close(incoming_data_fd);
 572         close(outgoing_data_fd);
 573
 574         /* Stop acquisition thread and clean up thread handle */
 575         pthread_cond_signal(&thread_release_cond[s]);
 576         pthread_join(sensor[s].acquisition_thread, NULL);
 577
 578         /* Clean up our sensor descriptor */
 579         sensor[s].acquisition_thread = -1;
 580
 581         /* Delete condition variable and mutex */
 582         pthread_cond_destroy(&thread_release_cond[s]);
 583         pthread_mutex_destroy(&thread_release_mutex[s]);
 584 }
 585
 586
 587 static int is_fast_accelerometer (int s)
 588 {
 589         /*
 590          * Some games don't react well to accelerometers using any-motion triggers. Even very low thresholds seem to trip them, and they tend to
 591          * request fairly high event rates. Favor continuous triggers if the sensor is an accelerometer and uses a sampling rate of at least 25.
 592          */
 593
 594         if (sensor[s].type != SENSOR_TYPE_ACCELEROMETER)
 595                 return 0;
 596
 597         if (sensor[s].sampling_rate < 25)
 598                 return 0;
 599
 600         return 1;
 601 }
 602
 603
 604 static void tentative_switch_trigger (int s)
 605 {
 606         /*
 607          * Under certain situations it may be beneficial to use an alternate trigger:
 608          *
 609          * - for applications using the accelerometer with high sampling rates, prefer the continuous trigger over the any-motion one, to avoid
 610          *   jumps related to motion thresholds
 611          */
 612
 613         if (is_fast_accelerometer(s) && !(sensor[s].quirks & QUIRK_TERSE_DRIVER) && sensor[s].selected_trigger == sensor[s].motion_trigger_name)
 614                 setup_trigger(s, sensor[s].init_trigger_name);
 615 }
 616
 617
 618 static float get_group_max_sampling_rate (int s)
 619 {
 620         /* Review the sampling rates of linked sensors and return the maximum */
 621
 622         int i, vi;
 623
 624         float arbitrated_rate = 0;
 625
 626         if (is_enabled(s))
 627                 arbitrated_rate = sensor[s].requested_rate;
 628
 629         /* If any of the currently active sensors built on top of this one need a higher sampling rate, switch to this rate */
 630         for (i = 0; i < sensor_count; i++)
 631                 for (vi = 0; vi < sensor[i].base_count; vi++)
 632                         if (sensor[i].base[vi] == s && is_enabled(i) && sensor[i].requested_rate > arbitrated_rate)     /* If sensor i depends on sensor s */
 633                                 arbitrated_rate = sensor[i].requested_rate;
 634
 635         /* If any of the currently active sensors we rely on is using a higher sampling rate, switch to this rate */
 636         for (vi = 0; vi < sensor[s].base_count; vi++) {
 637                 i = sensor[s].base[vi];
 638                 if (is_enabled(i) && sensor[i].requested_rate > arbitrated_rate)
 639                         arbitrated_rate = sensor[i].requested_rate;
 640         }
 641
 642         return arbitrated_rate;
 643 }
 644
 645
 646 static int sensor_set_rate (int s, float requested_rate)
 647 {
 648         /* Set the rate at which a specific sensor should report events. See Android sensors.h for indication on sensor trigger modes */
 649
 650         char sysfs_path[PATH_MAX];
 651         char avail_sysfs_path[PATH_MAX];
 652         int dev_num             =       sensor[s].dev_num;
 653         int i                   =       sensor[s].catalog_index;
 654         const char *prefix      =       sensor_catalog[i].tag;
 655         int per_sensor_sampling_rate;
 656         int per_device_sampling_rate;
 657         char freqs_buf[100];
 658         char* cursor;
 659         int n;
 660         float sr;
 661         float group_max_sampling_rate;
 662         float cur_sampling_rate; /* Currently used sampling rate              */
 663         float arb_sampling_rate; /* Granted sampling rate after arbitration   */
 664
 665         ALOGV("Sampling rate %g requested on sensor %d (%s)\n", requested_rate, s, sensor[s].friendly_name);
 666
 667         sensor[s].requested_rate = requested_rate;
 668
 669         arb_sampling_rate = requested_rate;
 670
 671         if (arb_sampling_rate < sensor[s].min_supported_rate) {
 672                 ALOGV("Sampling rate %g too low for %s, using %g instead\n", arb_sampling_rate, sensor[s].friendly_name, sensor[s].min_supported_rate);
 673                 arb_sampling_rate = sensor[s].min_supported_rate;
 674         }
 675
 676         /* If one of the linked sensors uses a higher rate, adopt it */
 677         group_max_sampling_rate = get_group_max_sampling_rate(s);
 678
 679         if (arb_sampling_rate < group_max_sampling_rate) {
 680                 ALOGV("Using %s sampling rate to %g too due to dependency\n", sensor[s].friendly_name, arb_sampling_rate);
 681                 arb_sampling_rate = group_max_sampling_rate;
 682         }
 683
 684         if (sensor[s].max_supported_rate && arb_sampling_rate > sensor[s].max_supported_rate) {
 685                 ALOGV("Sampling rate %g too high for %s, using %g instead\n", arb_sampling_rate, sensor[s].friendly_name, sensor[s].max_supported_rate);
 686                 arb_sampling_rate = sensor[s].max_supported_rate;
 687         }
 688
 689         sensor[s].sampling_rate = arb_sampling_rate;
 690
 691         /* If the sensor is virtual, we're done */
 692         if (sensor[s].is_virtual)
 693                 return 0;
 694
 695         /* If we're dealing with a poll-mode sensor */
 696         if (sensor[s].is_polling) {
 697                 if (is_enabled(s))
 698                         pthread_cond_signal(&thread_release_cond[s]); /* Wake up thread so the new sampling rate gets used */
 699                 return 0;
 700         }
 701
 702         sprintf(sysfs_path, SENSOR_SAMPLING_PATH, dev_num, prefix);
 703
 704         if (sysfs_read_float(sysfs_path, &cur_sampling_rate) != -1) {
 705                 per_sensor_sampling_rate = 1;
 706                 per_device_sampling_rate = 0;
 707         } else {
 708                 per_sensor_sampling_rate = 0;
 709
 710                 sprintf(sysfs_path, DEVICE_SAMPLING_PATH, dev_num);
 711
 712                 if (sysfs_read_float(sysfs_path, &cur_sampling_rate) != -1)
 713                         per_device_sampling_rate = 1;
 714                 else
 715                         per_device_sampling_rate = 0;
 716         }
 717
 718         if (!per_sensor_sampling_rate && !per_device_sampling_rate) {
 719                 ALOGE("No way to adjust sampling rate on sensor %d\n", s);
 720                 return -ENOSYS;
 721         }
 722
 723         /* Check if we have contraints on allowed sampling rates */
 724
 725         sprintf(avail_sysfs_path, DEVICE_AVAIL_FREQ_PATH, dev_num);
 726
 727         if (sysfs_read_str(avail_sysfs_path, freqs_buf, sizeof(freqs_buf)) > 0) {
 728                 cursor = freqs_buf;
 729
 730                 /* Decode allowed sampling rates string, ex: "10 20 50 100" */
 731
 732                 /* While we're not at the end of the string */
 733                 while (*cursor && cursor[0]) {
 734
 735                         /* Decode a single value */
 736                         sr = strtod(cursor, NULL);
 737
 738                         /* If this matches the selected rate, we're happy.  Have some tolerance for rounding errors and avoid needless jumps to higher rates */
 739                         if (fabs(arb_sampling_rate - sr) <= 0.001) {
 740                                 arb_sampling_rate = sr;
 741                                 break;
 742                         }
 743
 744                         /*
 745                          * If we reached a higher value than the desired rate, adjust selected rate so it matches the first higher available one and
 746                          * stop parsing - this makes the assumption that rates are sorted by increasing value in the allowed frequencies string.
 747                          */
 748                         if (sr > arb_sampling_rate) {
 749                                 arb_sampling_rate = sr;
 750                                 break;
 751                         }
 752
 753                         /* Skip digits */
 754                         while (cursor[0] && !isspace(cursor[0]))
 755                                 cursor++;
 756
 757                         /* Skip spaces */
 758                         while (cursor[0] && isspace(cursor[0]))
 759                                         cursor++;
 760                 }
 761         }
 762
 763         if (sensor[s].max_supported_rate &&
 764                 arb_sampling_rate > sensor[s].max_supported_rate) {
 765                 arb_sampling_rate = sensor[s].max_supported_rate;
 766         }
 767
 768         /* Coordinate with others active sensors on the same device, if any */
 769         if (per_device_sampling_rate)
 770                 for (n=0; n<sensor_count; n++)
 771                         if (n != s && sensor[n].dev_num == dev_num && sensor[n].num_channels && is_enabled(n) && sensor[n].sampling_rate > arb_sampling_rate) {
 772                                 ALOGV("Sampling rate shared between %s and %s, using %g instead of %g\n", sensor[s].friendly_name, sensor[n].friendly_name,
 773                                                                                                           sensor[n].sampling_rate, arb_sampling_rate);
 774                                 arb_sampling_rate = sensor[n].sampling_rate;
 775                         }
 776
 777         sensor[s].sampling_rate = arb_sampling_rate;
 778
 779         /* Update actual sampling rate field for this sensor and others which may be sharing the same sampling rate */
 780         if (per_device_sampling_rate)
 781                 for (n=0; n<sensor_count; n++)
 782                         if (sensor[n].dev_num == dev_num && n != s && sensor[n].num_channels)
 783                                 sensor[n].sampling_rate = arb_sampling_rate;
 784
 785         /* If the desired rate is already active we're all set */
 786         if (arb_sampling_rate == cur_sampling_rate)
 787                 return 0;
 788
 789         ALOGI("Sensor %d (%s) sampling rate set to %g\n", s, sensor[s].friendly_name, arb_sampling_rate);
 790
 791         if (trig_sensors_per_dev[dev_num])
 792                 enable_buffer(dev_num, 0);
 793
 794         sysfs_write_float(sysfs_path, arb_sampling_rate);
 795
 796         /* Check if it makes sense to use an alternate trigger */
 797         tentative_switch_trigger(s);
 798
 799         if (trig_sensors_per_dev[dev_num])
 800                 enable_buffer(dev_num, 1);
 801
 802         return 0;
 803 }
 804
 805
 806 static void reapply_sampling_rates (int s)
 807 {
 808         /*
 809          * The specified sensor was either enabled or disabled. Other sensors in the same group may have constraints related to this sensor
 810          * sampling rate on their own sampling rate, so reevaluate them by retrying to use their requested sampling rate, rather than the one
 811          * that ended up being used after arbitration.
 812          */
 813
 814         int i, j, base, user;
 815
 816         if (sensor[s].is_virtual) {
 817                 /* Take care of downwards dependencies */
 818                 for (i=0; i<sensor[s].base_count; i++) {
 819                         base = sensor[s].base[i];
 820                         sensor_set_rate(base, sensor[base].requested_rate);
 821                 }
 822                 return;
 823         }
 824
 825         /* Upwards too */
 826         for (i=0; i<sensor_count; i++)
 827                 for (j=0; j<sensor[i].base_count; j++)
 828                         if (sensor[i].base[j] == s) /* If sensor i depends on sensor s */
 829                                 sensor_set_rate(i, sensor[i].requested_rate);
 830 }
 831
 832
 833 static int sensor_activate_virtual (int s, int enabled, int from_virtual)
 834 {
 835         int i, base;
 836
 837         sensor[s].event_count = 0;
 838         sensor[s].meta_data_pending = 0;
 839
 840         if (!check_state_change(s, enabled, from_virtual))
 841                 return 0;       /* The state of the sensor remains the same ; we're done */
 842
 843         if (enabled)
 844                 ALOGI("Enabling sensor %d (%s)\n", s, sensor[s].friendly_name);
 845         else
 846                 ALOGI("Disabling sensor %d (%s)\n", s, sensor[s].friendly_name);
 847
 848         sensor[s].report_pending = 0;
 849
 850         for (i=0; i<sensor[s].base_count; i++) {
 851
 852                 base = sensor[s].base[i];
 853                 sensor_activate(base, enabled, 1);
 854
 855                 if (enabled)
 856                         sensor[base].ref_count++;
 857                 else
 858                         sensor[base].ref_count--;
 859         }
 860
 861         /* Reevaluate sampling rates of linked sensors */
 862         reapply_sampling_rates(s);
 863         return 0;
 864 }
 865
 866
 867 int sensor_activate (int s, int enabled, int from_virtual)
 868 {
 869         char device_name[PATH_MAX];
 870         struct epoll_event ev = {0};
 871         int dev_fd;
 872         int ret;
 873         int dev_num = sensor[s].dev_num;
 874
 875         if (sensor[s].is_virtual)
 876                 return sensor_activate_virtual(s, enabled, from_virtual);
 877
 878         /* Prepare the report timestamp field for the first event, see set_report_ts method */
 879         sensor[s].report_ts = 0;
 880
 881         ret = adjust_counters(s, enabled, from_virtual);
 882
 883         /* If the operation was neutral in terms of state, we're done */
 884         if (ret <= 0)
 885                 return ret;
 886
 887         sensor[s].event_count = 0;
 888         sensor[s].meta_data_pending = 0;
 889
 890         if (enabled && (sensor[s].quirks & QUIRK_NOISY))
 891                 setup_noise_filtering(s);       /* Initialize filtering data if required */
 892
 893         if (!sensor[s].is_polling) {
 894
 895                 /* Stop sampling */
 896                 enable_buffer(dev_num, 0);
 897                 setup_trigger(s, "\n");
 898
 899                 /* If there's at least one sensor enabled on this iio device */
 900                 if (trig_sensors_per_dev[dev_num]) {
 901
 902                         /* Start sampling */
 903                         setup_trigger(s, sensor[s].init_trigger_name);
 904                         enable_buffer(dev_num, 1);
 905                 }
 906         }
 907
 908         /*
 909          * Make sure we have a fd on the character device ; conversely, close the fd if no one is using associated sensors anymore. The assumption
 910          * here is that the underlying driver will power on the relevant hardware block while someone holds a fd on the device.
 911          */
 912         dev_fd = device_fd[dev_num];
 913
 914         if (!enabled) {
 915                 if (sensor[s].is_polling)
 916                         stop_acquisition_thread(s);
 917
 918                 if (dev_fd != -1 && !poll_sensors_per_dev[dev_num] && !trig_sensors_per_dev[dev_num]) {
 919                                 /* Stop watching this fd. This should be a no-op in case this fd was not in the poll set. */
 920                                 epoll_ctl(poll_fd, EPOLL_CTL_DEL, dev_fd, NULL);
 921
 922                                 close(dev_fd);
 923                                 device_fd[dev_num] = -1;
 924                 }
 925
 926                 /* Release any filtering data we may have accumulated */
 927                 release_noise_filtering_data(s);
 928
 929                 /* Reevaluate sampling rates of linked sensors */
 930                 reapply_sampling_rates(s);
 931                 return 0;
 932         }
 933
 934         if (dev_fd == -1) {
 935                 /* First enabled sensor on this iio device */
 936                 sprintf(device_name, DEV_FILE_PATH, dev_num);
 937                 dev_fd = open(device_name, O_RDONLY | O_NONBLOCK);
 938
 939                 device_fd[dev_num] = dev_fd;
 940
 941                 if (dev_fd == -1) {
 942                         ALOGE("Could not open fd on %s (%s)\n", device_name, strerror(errno));
 943                         adjust_counters(s, 0, from_virtual);
 944                         return -1;
 945                 }
 946
 947                 ALOGV("Opened %s: fd=%d\n", device_name, dev_fd);
 948
 949                 if (!sensor[s].is_polling) {
 950
 951                         /* Add this iio device fd to the set of watched fds */
 952                         ev.events = EPOLLIN;
 953                         ev.data.u32 = dev_num;
 954
 955                         ret = epoll_ctl(poll_fd, EPOLL_CTL_ADD, dev_fd, &ev);
 956
 957                         if (ret == -1) {
 958                                 ALOGE("Failed adding %d to poll set (%s)\n", dev_fd, strerror(errno));
 959                                 return -1;
 960                         }
 961
 962                         /* Note: poll-mode fds are not readable */
 963                 }
 964         }
 965
 966         /* Ensure that on-change sensors send at least one event after enable */
 967         sensor[s].prev_val = -1;
 968
 969         if (sensor[s].is_polling)
 970                 start_acquisition_thread(s);
 971
 972         /* Reevaluate sampling rates of linked sensors */
 973         reapply_sampling_rates(s);
 974
 975         return 0;
 976 }
 977
 978
 979 static void enable_motion_trigger (int dev_num)
 980 {
 981         /*
 982          * In the ideal case, we enumerate two triggers per iio device ; the default (periodically firing) trigger, and another one (the motion
 983          * trigger) that only fires up when motion is detected. This second one allows for lesser energy consumption, but requires periodic sample
 984          * duplication at the HAL level for sensors that Android defines as continuous. This "duplicate last sample" logic can only be engaged
 985          * once we got a first sample for the driver, so we start with the default trigger when an iio device is first opened, then adjust the
 986          * trigger when we got events for all active sensors. Unfortunately in the general case several sensors can be associated to a given iio
 987          * device, they can independently be controlled, and we have to adjust the trigger in use at the iio device level depending on whether or
 988          * not appropriate conditions are met at the sensor level.
 989          */
 990
 991         int s;
 992         int i;
 993         int active_sensors = trig_sensors_per_dev[dev_num];
 994         int candidate[MAX_SENSORS];
 995         int candidate_count = 0;
 996
 997         if  (!active_sensors)
 998                 return;
 999
1000         /* Check that all active sensors are ready to switch */
1001
1002         for (s=0; s<MAX_SENSORS; s++)
1003                 if (sensor[s].dev_num == dev_num && is_enabled(s) && sensor[s].num_channels &&
1004                     (!sensor[s].motion_trigger_name[0] || !sensor[s].report_initialized || is_fast_accelerometer(s) ||
1005                      (sensor[s].quirks & QUIRK_FORCE_CONTINUOUS)))
1006                         return; /* Nope */
1007
1008         /* Record which particular sensors need to switch */
1009
1010         for (s=0; s<MAX_SENSORS; s++)
1011                 if (sensor[s].dev_num == dev_num && is_enabled(s) && sensor[s].num_channels && sensor[s].selected_trigger != sensor[s].motion_trigger_name)
1012                                 candidate[candidate_count++] = s;
1013
1014         if (!candidate_count)
1015                 return;
1016
1017         /* Now engage the motion trigger for sensors which aren't using it */
1018
1019         enable_buffer(dev_num, 0);
1020
1021         for (i=0; i<candidate_count; i++) {
1022                 s = candidate[i];
1023                 setup_trigger(s, sensor[s].motion_trigger_name);
1024         }
1025
1026         enable_buffer(dev_num, 1);
1027 }
1028
1029
1030 /*
1031  *  CTS acceptable thresholds:
1032  *      EventGapVerification.java: (th <= 1.8)
1033  *      FrequencyVerification.java: (0.9)*(expected freq) => (th <= 1.1111)
1034  */
1035 #define THRESHOLD 1.10
1036 #define MAX_DELAY 500000000 /* 500 ms */
1037
1038 void set_report_ts(int s, int64_t ts)
1039 {
1040         int64_t maxTs, period;
1041
1042         /*
1043         *  A bit of a hack to please a bunch of cts tests. They
1044         *  expect the timestamp to be exacly according to the set-up
1045         *  frequency but if we're simply getting the timestamp at hal level
1046         *  this may not be the case. Perhaps we'll get rid of this when
1047         *  we'll be reading the timestamp from the iio channel for all sensors
1048         */
1049         if (sensor[s].report_ts && sensor[s].sampling_rate &&
1050                 REPORTING_MODE(sensor_desc[s].flags) == SENSOR_FLAG_CONTINUOUS_MODE)
1051         {
1052                 period = (int64_t) (1000000000.0 / sensor[s].sampling_rate);
1053                 maxTs = sensor[s].report_ts + THRESHOLD * period;
1054                 /* If we're too far behind get back on track */
1055                 if (ts - maxTs >= MAX_DELAY)
1056                         maxTs = ts;
1057                 sensor[s].report_ts = (ts < maxTs ? ts : maxTs);
1058         } else {
1059                 sensor[s].report_ts = ts;
1060         }
1061 }
1062
1063
1064 static void stamp_reports (int dev_num, int64_t ts)
1065 {
1066         int s;
1067
1068         for (s=0; s<MAX_SENSORS; s++)
1069                 if (sensor[s].dev_num == dev_num && is_enabled(s))
1070                         set_report_ts(s, ts);
1071 }
1072
1073
1074 static int integrate_device_report (int dev_num)
1075 {
1076         int len;
1077         int s,c;
1078         unsigned char buf[MAX_DEVICE_REPORT_SIZE] = { 0 };
1079         int sr_offset;
1080         unsigned char *target;
1081         unsigned char *source;
1082         int size;
1083         int64_t ts = 0;
1084         int ts_offset = 0;      /* Offset of iio timestamp, if provided */
1085         int64_t boot_to_rt_delta;
1086
1087         /* There's an incoming report on the specified iio device char dev fd */
1088
1089         if (dev_num < 0 || dev_num >= MAX_DEVICES) {
1090                 ALOGE("Event reported on unexpected iio device %d\n", dev_num);
1091                 return -1;
1092         }
1093
1094         if (device_fd[dev_num] == -1) {
1095                 ALOGE("Ignoring stale report on iio device %d\n", dev_num);
1096                 return -1;
1097         }
1098
1099         len = read(device_fd[dev_num], buf, expected_dev_report_size[dev_num]);
1100
1101         if (len == -1) {
1102                 ALOGE("Could not read report from iio device %d (%s)\n", dev_num, strerror(errno));
1103                 return -1;
1104         }
1105
1106         ALOGV("Read %d bytes from iio device %d\n", len, dev_num);
1107
1108         /* Map device report to sensor reports */
1109
1110         for (s=0; s<MAX_SENSORS; s++)
1111                 if (sensor[s].dev_num == dev_num && is_enabled(s)) {
1112
1113                         sr_offset = 0;
1114
1115                         /* Copy data from device to sensor report buffer */
1116                         for (c=0; c<sensor[s].num_channels; c++) {
1117
1118                                 target = sensor[s].report_buffer + sr_offset;
1119
1120                                 source = buf + sensor[s].channel[c].offset;
1121
1122                                 size = sensor[s].channel[c].size;
1123
1124                                 memcpy(target, source, size);
1125
1126                                 sr_offset += size;
1127                         }
1128
1129                         ALOGV("Sensor %d report available (%d bytes)\n", s, sr_offset);
1130
1131                         sensor[s].report_pending = DATA_TRIGGER;
1132                         sensor[s].report_initialized = 1;
1133
1134                         ts_offset += sr_offset;
1135                 }
1136
1137         /* Tentatively switch to an any-motion trigger if conditions are met */
1138         enable_motion_trigger(dev_num);
1139
1140         /* If no iio timestamp channel was detected for this device, bail out */
1141         if (!has_iio_ts[dev_num]) {
1142                 stamp_reports(dev_num, get_timestamp_boot());
1143                 return 0;
1144         }
1145
1146         /* Don't trust the timestamp channel in any-motion mode */
1147         for (s=0; s<MAX_SENSORS; s++)
1148                 if (sensor[s].dev_num == dev_num && is_enabled(s) && sensor[s].selected_trigger == sensor[s].motion_trigger_name) {
1149                         stamp_reports(dev_num, get_timestamp_boot());
1150                         return 0;
1151                 }
1152
1153         /* Align on a 64 bits boundary */
1154         ts_offset = (ts_offset + 7)/8*8;
1155
1156         /* If we read an amount of data consistent with timestamp presence */
1157         if (len == expected_dev_report_size[dev_num])
1158                 ts = *(int64_t*) (buf + ts_offset);
1159
1160         if (ts == 0) {
1161                 ALOGV("Unreliable timestamp channel on iio dev %d\n", dev_num);
1162                 stamp_reports(dev_num, get_timestamp_boot());
1163                 return 0;
1164         }
1165
1166         ALOGV("Driver timestamp on iio device %d: ts=%lld\n", dev_num, ts);
1167
1168         boot_to_rt_delta = get_timestamp_boot() - get_timestamp_realtime();
1169
1170         stamp_reports(dev_num, ts + boot_to_rt_delta);
1171
1172         return 0;
1173 }
1174
1175
1176 static int propagate_vsensor_report (int s, sensors_event_t *data)
1177 {
1178         /* There's a new report stored in sensor.sample for this sensor; transmit it */
1179
1180         memcpy(data, &sensor[s].sample, sizeof(sensors_event_t));
1181
1182         data->sensor    = s;
1183         data->type      = sensor[s].type;
1184         return 1;
1185 }
1186
1187
1188 static int propagate_sensor_report (int s, sensors_event_t *data)
1189 {
1190         /* There's a sensor report pending for this sensor ; transmit it */
1191
1192         int num_fields    = get_field_count(s);
1193         int c;
1194         unsigned char* current_sample;
1195
1196         /* If there's nothing to return... we're done */
1197         if (!num_fields)
1198                 return 0;
1199
1200         ALOGV("Sample on sensor %d (type %d):\n", s, sensor[s].type);
1201
1202         if (sensor[s].is_polling) {
1203                 /* Use the data provided by the acquisition thread */
1204                 ALOGV("Reporting data from worker thread for S%d\n", s);
1205                 memcpy(data, &sensor[s].sample, sizeof(sensors_event_t));
1206                 data->timestamp = sensor[s].report_ts;
1207                 return 1;
1208         }
1209
1210         memset(data, 0, sizeof(sensors_event_t));
1211
1212         data->version   = sizeof(sensors_event_t);
1213         data->sensor    = s;
1214         data->type      = sensor[s].type;
1215         data->timestamp = sensor[s].report_ts;
1216
1217         /* Convert the data into the expected Android-level format */
1218
1219         current_sample = sensor[s].report_buffer;
1220
1221         for (c=0; c<num_fields; c++) {
1222
1223                 data->data[c] = sensor[s].ops.transform (s, c, current_sample);
1224
1225                 ALOGV("\tfield %d: %g\n", c, data->data[c]);
1226                 current_sample += sensor[s].channel[c].size;
1227         }
1228
1229         /* The finalize routine, in addition to its late sample processing duty, has the final say on whether or not the sample gets sent to Android */
1230         return sensor[s].ops.finalize(s, data);
1231 }
1232
1233
1234 static void synthetize_duplicate_samples (void)
1235 {
1236         /*
1237          * Some sensor types (ex: gyroscope) are defined as continuously firing by Android, despite the fact that
1238          * we can be dealing with iio drivers that only report events for new samples. For these we generate reports
1239          * periodically, duplicating the last data we got from the driver. This is not necessary for polling sensors.
1240          */
1241
1242         int s;
1243         int64_t current_ts;
1244         int64_t target_ts;
1245         int64_t period;
1246
1247         for (s=0; s<sensor_count; s++) {
1248
1249                 /* Ignore disabled sensors */
1250                 if (!is_enabled(s))
1251                         continue;
1252
1253                 /* If the sensor is continuously firing, leave it alone */
1254                 if (sensor[s].selected_trigger != sensor[s].motion_trigger_name)
1255                         continue;
1256
1257                 /* If we haven't seen a sample, there's nothing to duplicate */
1258                 if (!sensor[s].report_initialized)
1259                         continue;
1260
1261                 /* If a sample was recently buffered, leave it alone too */
1262                 if (sensor[s].report_pending)
1263                         continue;
1264
1265                 /* We also need a valid sampling rate to be configured */
1266                 if (!sensor[s].sampling_rate)
1267                         continue;
1268
1269                 period = (int64_t) (1000000000.0 / sensor[s].sampling_rate);
1270
1271                 current_ts = get_timestamp_boot();
1272                 target_ts = sensor[s].report_ts + period;
1273
1274                 if (target_ts <= current_ts) {
1275                         /* Mark the sensor for event generation */
1276                         set_report_ts(s, current_ts);
1277                         sensor[s].report_pending = DATA_DUPLICATE;
1278                 }
1279         }
1280 }
1281
1282
1283 static void integrate_thread_report (uint32_t tag)
1284 {
1285         int s = tag - THREAD_REPORT_TAG_BASE;
1286         int len;
1287
1288         len = read(sensor[s].thread_data_fd[0], &sensor[s].sample, sizeof(sensors_event_t));
1289
1290         if (len == sizeof(sensors_event_t)) {
1291                 set_report_ts(s, sensor[s].sample.timestamp);
1292                 sensor[s].report_pending = DATA_SYSFS;
1293         }
1294 }
1295
1296
1297 static int get_poll_wait_timeout (void)
1298 {
1299         /*
1300          * Compute an appropriate timeout value, in ms, for the epoll_wait call that's going to await
1301          * for iio device reports and incoming reports from our sensor sysfs data reader threads.
1302          */
1303
1304         int s;
1305         int64_t target_ts = INT64_MAX;
1306         int64_t ms_to_wait;
1307         int64_t period;
1308
1309         /*
1310          * Check if we're dealing with a driver that only send events when there is motion, despite the fact that the associated Android sensor
1311          * type is continuous rather than on-change. In that case we have to duplicate events. Check deadline for the nearest upcoming event.
1312          */
1313         for (s=0; s<sensor_count; s++)
1314                 if (is_enabled(s) && sensor[s].selected_trigger == sensor[s].motion_trigger_name && sensor[s].sampling_rate) {
1315                         period = (int64_t) (1000000000.0 / sensor[s].sampling_rate);
1316
1317                         if (sensor[s].report_ts + period < target_ts)
1318                                 target_ts = sensor[s].report_ts + period;
1319                 }
1320
1321         /* If we don't have such a driver to deal with */
1322         if (target_ts == INT64_MAX)
1323                 return -1; /* Infinite wait */
1324
1325         ms_to_wait = (target_ts - get_timestamp_boot()) / 1000000;
1326
1327         /* If the target timestamp is already behind us, don't wait */
1328         if (ms_to_wait < 1)
1329                 return 0;
1330
1331         return ms_to_wait;
1332 }
1333
1334
1335 int sensor_poll (sensors_event_t* data, int count)
1336 {
1337         int s;
1338         int i;
1339         int nfds;
1340         struct epoll_event ev[MAX_DEVICES];
1341         int returned_events;
1342         int event_count;
1343         int uncal_start;
1344
1345         /* Get one or more events from our collection of sensors */
1346 return_available_sensor_reports:
1347
1348         /* Synthetize duplicate samples if needed */
1349         synthetize_duplicate_samples();
1350
1351         returned_events = 0;
1352
1353         /* Check our sensor collection for available reports */
1354         for (s=0; s<sensor_count && returned_events < count; s++) {
1355
1356                 if (sensor[s].report_pending) {
1357                         event_count = 0;
1358
1359                         if (sensor[s].is_virtual)
1360                                 event_count = propagate_vsensor_report(s, &data[returned_events]);
1361                         else
1362                                 /* Report this event if it looks OK */
1363                                 event_count = propagate_sensor_report(s, &data[returned_events]);
1364
1365                         /* Lower flag */
1366                         sensor[s].report_pending = 0;
1367                         returned_events += event_count;
1368
1369                         /*
1370                          * If the sample was deemed invalid or unreportable, e.g. had the same value as the previously reported
1371                          * value for a 'on change' sensor, silently drop it.
1372                          */
1373                 }
1374
1375                 while (sensor[s].meta_data_pending) {
1376                         /* See sensors.h on these */
1377                         data[returned_events].version = META_DATA_VERSION;
1378                         data[returned_events].sensor = 0;
1379                         data[returned_events].type = SENSOR_TYPE_META_DATA;
1380                         data[returned_events].reserved0 = 0;
1381                         data[returned_events].timestamp = 0;
1382                         data[returned_events].meta_data.sensor = s;
1383                         data[returned_events].meta_data.what = META_DATA_FLUSH_COMPLETE;
1384                         returned_events++;
1385                         sensor[s].meta_data_pending--;
1386                 }
1387         }
1388
1389         if (returned_events)
1390                 return returned_events;
1391
1392 await_event:
1393
1394         ALOGV("Awaiting sensor data\n");
1395
1396         nfds = epoll_wait(poll_fd, ev, MAX_DEVICES, get_poll_wait_timeout());
1397
1398         if (nfds == -1) {
1399                 ALOGE("epoll_wait returned -1 (%s)\n", strerror(errno));
1400                 goto await_event;
1401         }
1402
1403         ALOGV("%d fds signalled\n", nfds);
1404
1405         /* For each of the signalled sources */
1406         for (i=0; i<nfds; i++)
1407                 if (ev[i].events == EPOLLIN)
1408                         switch (ev[i].data.u32) {
1409                                 case 0 ... MAX_DEVICES-1:
1410                                         /* Read report from iio char dev fd */
1411                                         integrate_device_report(ev[i].data.u32);
1412                                         break;
1413
1414                                 case THREAD_REPORT_TAG_BASE ...
1415                                      THREAD_REPORT_TAG_BASE + MAX_SENSORS-1:
1416                                         /* Get report from acquisition thread */
1417                                         integrate_thread_report(ev[i].data.u32);
1418                                         break;
1419
1420                                 default:
1421                                         ALOGW("Unexpected event source!\n");
1422                                         break;
1423                         }
1424
1425         goto return_available_sensor_reports;
1426 }
1427
1428
1429 int sensor_set_delay (int s, int64_t ns)
1430 {
1431         float requested_sampling_rate;
1432
1433         if (ns <= 0) {
1434                 ALOGE("Invalid delay requested on sensor %d: %lld\n", s, ns);
1435                 return -EINVAL;
1436         }
1437
1438         requested_sampling_rate = 1000000000.0 / ns;
1439
1440         ALOGV("Entering set delay S%d (%s): current rate: %g, requested: %g\n", s, sensor[s].friendly_name, sensor[s].sampling_rate, requested_sampling_rate);
1441
1442         /*
1443          * Only try to adjust the low level sampling rate if it's different from the current one, as set by the HAL. This saves a few sysfs
1444          * reads and writes as well as buffer enable/disable operations, since at the iio level most drivers require the buffer to be turned off
1445          * in order to accept a sampling rate change. Of course that implies that this field has to be kept up to date and that only this library
1446          * is changing the sampling rate.
1447          */
1448
1449         if (requested_sampling_rate != sensor[s].sampling_rate)
1450                 return sensor_set_rate(s, requested_sampling_rate);
1451
1452         return 0;
1453 }
1454
1455
1456 int sensor_flush (int s)
1457 {
1458         /* If one shot or not enabled return -EINVAL */
1459         if (sensor_desc[s].flags & SENSOR_FLAG_ONE_SHOT_MODE || !is_enabled(s))
1460                 return -EINVAL;
1461
1462         sensor[s].meta_data_pending++;
1463         return 0;
1464 }
1465
1466
1467 int allocate_control_data (void)
1468 {
1469         int i;
1470
1471         for (i=0; i<MAX_DEVICES; i++)
1472                 device_fd[i] = -1;
1473
1474         poll_fd = epoll_create(MAX_DEVICES);
1475
1476         if (poll_fd == -1) {
1477                 ALOGE("Can't create epoll instance for iio sensors!\n");
1478                 return -1;
1479         }
1480
1481         return poll_fd;
1482 }
1483
1484
1485 void delete_control_data (void)
1486 {
1487 }