OSDN Git Service

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