OSDN Git Service

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