2 * Copyright (C) 2014 Intel Corporation.
8 #include <cutils/properties.h>
9 #include <hardware/sensors.h>
11 #include "enumeration.h"
12 #include "description.h"
15 #define IIO_SENSOR_HAL_VERSION 1
20 * We acquire a number of parameters about sensors by reading properties.
21 * The idea here is that someone (either a script, or daemon, sets them
22 * depending on the set of sensors present on the machine.
24 * There are fallback paths in case the properties are not defined, but it is
25 * highly desirable to at least have the following for each sensor:
27 * ro.iio.anglvel.name = Gyroscope
28 * ro.iio.anglvel.vendor = Intel
29 * ro.iio.anglvel.max_range = 35
30 * ro.iio.anglvel.resolution = 0.002
31 * ro.iio.anglvel.power = 6.1
33 * Besides these, we have a couple of knobs initially used to cope with Intel
34 * Sensor Hub oddities, such as HID inspired units or firmware bugs:
36 * ro.iio.anglvel.transform = ISH
37 * ro.iio.anglvel.quirks = init-rate
39 * The "terse" quirk indicates that the underlying driver only sends events
40 * when the sensor reports a change. The HAL then periodically generates
41 * duplicate events so the sensor behaves as a continously firing one.
43 * The "noisy" quirk indicates that the underlying driver has a unusually high
44 * level of noise in its readings, and that the HAL has to accomodate it
45 * somehow, e.g. in the magnetometer calibration code path.
47 * This one is used specifically to pass a calibration scale to ALS drivers:
49 * ro.iio.illuminance.name = CPLM3218x Ambient Light Sensor
50 * ro.iio.illuminance.vendor = Capella Microsystems
51 * ro.iio.illuminance.max_range = 167000
52 * ro.iio.illuminance.resolution = 1
53 * ro.iio.illuminance.power = .001
54 * ro.iio.illuminance.illumincalib = 7400
56 * There's a 'opt_scale' specifier, documented as follows:
58 * This adds support for a scaling factor that can be expressed
59 * using properties, for all sensors, on a channel basis. That
60 * scaling factor is applied after all other transforms have been
61 * applied, and is intended as a way to compensate for problems
62 * such as an incorrect axis polarity for a given sensor.
64 * The syntax is <usual property prefix>.<channel>.opt_scale, e.g.
65 * ro.iio.accel.y.opt_scale = -1 to negate the sign of the y readings
66 * for the accelerometer.
68 * For sensors using a single channel - and only those - the channel
69 * name is implicitly void and a syntax such as ro.iio.illuminance.
70 * opt_scale = 3 has to be used.
72 * 'panel' and 'rotation' specifiers can be used to express ACPI PLD placement
73 * information ; if found they will be used in priority over the actual ACPI
74 * data. That is intended as a way to verify values during development.
76 * It's possible to use the contents of the iio device name as a way to
77 * discriminate between sensors. Several sensors of the same type can coexist:
78 * e.g. ro.iio.temp.bmg160.name = BMG160 Thermometer will be used in priority
79 * over ro.iio.temp.name = BMC150 Thermometer if the sensor for which we query
80 * properties values happen to have its iio device name set to bmg160.
83 static int sensor_get_st_prop (int s, const char* sel, char val[MAX_NAME_SIZE])
85 char prop_name[PROP_NAME_MAX];
86 char prop_val[PROP_VALUE_MAX];
87 char extended_sel[PROP_VALUE_MAX];
89 int i = sensor_info[s].catalog_index;
90 const char *prefix = sensor_catalog[i].tag;
92 /* First try most specialized form, like ro.iio.anglvel.bmg160.name */
94 snprintf(extended_sel, PROP_NAME_MAX, "%s.%s",
95 sensor_info[s].internal_name, sel);
97 snprintf(prop_name, PROP_NAME_MAX, PROP_BASE, prefix, extended_sel);
99 if (property_get(prop_name, prop_val, "")) {
100 strncpy(val, prop_val, MAX_NAME_SIZE-1);
101 val[MAX_NAME_SIZE-1] = '\0';
105 /* Fall back to simple form, like ro.iio.anglvel.name */
107 sprintf(prop_name, PROP_BASE, prefix, sel);
109 if (property_get(prop_name, prop_val, "")) {
110 strncpy(val, prop_val, MAX_NAME_SIZE-1);
111 val[MAX_NAME_SIZE-1] = '\0';
119 int sensor_get_prop (int s, const char* sel, int* val)
121 char buf[MAX_NAME_SIZE];
123 if (sensor_get_st_prop(s, sel, buf))
131 int sensor_get_fl_prop (int s, const char* sel, float* val)
133 char buf[MAX_NAME_SIZE];
135 if (sensor_get_st_prop(s, sel, buf))
138 *val = (float) strtod(buf, NULL);
143 char* sensor_get_name (int s)
145 if (sensor_info[s].friendly_name[0] != '\0' ||
146 !sensor_get_st_prop(s, "name", sensor_info[s].friendly_name))
147 return sensor_info[s].friendly_name;
149 /* If we got a iio device name from sysfs, use it */
150 if (sensor_info[s].internal_name[0]) {
151 snprintf(sensor_info[s].friendly_name, MAX_NAME_SIZE, "S%d-%s",
152 s, sensor_info[s].internal_name);
154 sprintf(sensor_info[s].friendly_name, "S%d", s);
157 return sensor_info[s].friendly_name;
161 char* sensor_get_vendor (int s)
163 if (sensor_info[s].vendor_name[0] ||
164 !sensor_get_st_prop(s, "vendor", sensor_info[s].vendor_name))
165 return sensor_info[s].vendor_name;
171 int sensor_get_version (int s)
173 return IIO_SENSOR_HAL_VERSION;
177 float sensor_get_max_range (int s)
179 if (sensor_info[s].max_range != 0.0 ||
180 !sensor_get_fl_prop(s, "max_range", &sensor_info[s].max_range))
181 return sensor_info[s].max_range;
183 /* Try returning a sensible value given the sensor type */
185 /* We should cap returned samples accordingly... */
187 switch (sensor_info[s].type) {
188 case SENSOR_TYPE_ACCELEROMETER: /* m/s^2 */
191 case SENSOR_TYPE_MAGNETIC_FIELD: /* micro-tesla */
194 case SENSOR_TYPE_ORIENTATION: /* degrees */
197 case SENSOR_TYPE_GYROSCOPE: /* radians/s */
200 case SENSOR_TYPE_LIGHT: /* SI lux units */
203 case SENSOR_TYPE_AMBIENT_TEMPERATURE: /* °C */
204 case SENSOR_TYPE_TEMPERATURE: /* °C */
205 case SENSOR_TYPE_PROXIMITY: /* centimeters */
206 case SENSOR_TYPE_PRESSURE: /* hecto-pascal */
207 case SENSOR_TYPE_RELATIVE_HUMIDITY: /* percent */
215 float sensor_get_max_freq (int s)
219 if (!sensor_get_fl_prop(s, "max_freq", &max_freq))
225 float sensor_get_resolution (int s)
227 if (sensor_info[s].resolution != 0.0 ||
228 !sensor_get_fl_prop(s, "resolution", &sensor_info[s].resolution))
229 return sensor_info[s].resolution;
235 float sensor_get_power (int s)
237 /* mA used while sensor is in use ; not sure about volts :) */
238 if (sensor_info[s].power != 0.0 ||
239 !sensor_get_fl_prop(s, "power", &sensor_info[s].power))
240 return sensor_info[s].power;
246 float sensor_get_illumincalib (int s)
248 /* calibrating the ALS Sensor*/
249 if (sensor_info[s].illumincalib != 0.0 ||
250 !sensor_get_fl_prop(s, "illumincalib", &sensor_info[s].illumincalib)) {
251 return sensor_info[s].illumincalib;
258 uint32_t sensor_get_quirks (int s)
260 char quirks_buf[MAX_NAME_SIZE];
262 /* Read and decode quirks property on first reference */
263 if (!(sensor_info[s].quirks & QUIRK_ALREADY_DECODED)) {
264 quirks_buf[0] = '\0';
265 sensor_get_st_prop(s, "quirks", quirks_buf);
267 if (strstr(quirks_buf, "init-rate"))
268 sensor_info[s].quirks |= QUIRK_INITIAL_RATE;
270 if (strstr(quirks_buf, "continuous"))
271 sensor_info[s].quirks |= QUIRK_FORCE_CONTINUOUS;
273 if (strstr(quirks_buf, "terse"))
274 sensor_info[s].quirks |= QUIRK_TERSE_DRIVER;
276 if (strstr(quirks_buf, "noisy"))
277 sensor_info[s].quirks |= QUIRK_NOISY;
279 sensor_info[s].quirks |= QUIRK_ALREADY_DECODED;
282 return sensor_info[s].quirks;
286 int sensor_get_order (int s, unsigned char map[MAX_CHANNELS])
288 char buf[MAX_NAME_SIZE];
290 int count = sensor_catalog[sensor_info[s].catalog_index].num_channels;
292 if (sensor_get_st_prop(s, "order", buf))
293 return 0; /* No order property */
295 /* Assume ASCII characters, in the '0'..'9' range */
297 for (i=0; i<count; i++)
298 if (buf[i] - '0' >= count) {
299 ALOGE("Order index out of range for sensor %d\n", s);
303 for (i=0; i<count; i++)
304 map[i] = buf[i] - '0';
306 return 1; /* OK to use modified ordering map */
309 char* sensor_get_string_type (int s)
311 switch (sensor_info[s].type) {
312 case SENSOR_TYPE_ACCELEROMETER:
313 return SENSOR_STRING_TYPE_ACCELEROMETER;
315 case SENSOR_TYPE_MAGNETIC_FIELD:
316 return SENSOR_STRING_TYPE_MAGNETIC_FIELD;
318 case SENSOR_TYPE_ORIENTATION:
319 return SENSOR_STRING_TYPE_ORIENTATION;
321 case SENSOR_TYPE_GYROSCOPE:
322 return SENSOR_STRING_TYPE_GYROSCOPE;
324 case SENSOR_TYPE_GYROSCOPE_UNCALIBRATED:
325 return SENSOR_STRING_TYPE_GYROSCOPE_UNCALIBRATED;
327 case SENSOR_TYPE_LIGHT:
328 return SENSOR_STRING_TYPE_LIGHT;
330 case SENSOR_TYPE_AMBIENT_TEMPERATURE:
331 return SENSOR_STRING_TYPE_AMBIENT_TEMPERATURE;
333 case SENSOR_TYPE_TEMPERATURE:
334 return SENSOR_STRING_TYPE_TEMPERATURE;
336 case SENSOR_TYPE_PROXIMITY:
337 return SENSOR_STRING_TYPE_PROXIMITY;
339 case SENSOR_TYPE_PRESSURE:
340 return SENSOR_STRING_TYPE_PRESSURE;
342 case SENSOR_TYPE_RELATIVE_HUMIDITY:
343 return SENSOR_STRING_TYPE_RELATIVE_HUMIDITY;
350 flag_t sensor_get_flags (int s)
354 switch (sensor_info[s].type) {
355 case SENSOR_TYPE_ACCELEROMETER:
356 case SENSOR_TYPE_MAGNETIC_FIELD:
357 case SENSOR_TYPE_ORIENTATION:
358 case SENSOR_TYPE_GYROSCOPE:
359 case SENSOR_TYPE_GYROSCOPE_UNCALIBRATED:
360 case SENSOR_TYPE_PRESSURE:
361 flags |= SENSOR_FLAG_CONTINUOUS_MODE;
364 case SENSOR_TYPE_LIGHT:
365 case SENSOR_TYPE_AMBIENT_TEMPERATURE:
366 case SENSOR_TYPE_TEMPERATURE:
367 case SENSOR_TYPE_RELATIVE_HUMIDITY:
368 flags |= SENSOR_FLAG_ON_CHANGE_MODE;
372 case SENSOR_TYPE_PROXIMITY:
373 flags |= SENSOR_FLAG_WAKE_UP;
374 flags |= SENSOR_FLAG_ON_CHANGE_MODE;
378 ALOGI("Unknown sensor");
383 int get_cdd_freq (int s, int must)
385 switch (sensor_info[s].type) {
386 case SENSOR_TYPE_ACCELEROMETER:
387 return (must ? 100 : 200); /* must 100 Hz, should 200 Hz, CDD compliant */
388 case SENSOR_TYPE_GYROSCOPE:
389 case SENSOR_TYPE_GYROSCOPE_UNCALIBRATED:
390 return (must ? 200 : 200); /* must 200 Hz, should 200 Hz, CDD compliant */
391 case SENSOR_TYPE_MAGNETIC_FIELD:
392 return (must ? 10 : 50); /* must 10 Hz, should 50 Hz, CDD compliant */
393 case SENSOR_TYPE_LIGHT:
394 case SENSOR_TYPE_AMBIENT_TEMPERATURE:
395 case SENSOR_TYPE_TEMPERATURE:
396 return (must ? 1 : 2); /* must 1 Hz, should 2Hz, not mentioned in CDD */
402 /* This value is defined only for continuous mode and on-change sensors. It is the delay between
403 * two sensor events corresponding to the lowest frequency that this sensor supports. When lower
404 * frequencies are requested through batch()/setDelay() the events will be generated at this
405 * frequency instead. It can be used by the framework or applications to estimate when the batch
408 * NOTE: 1) period_ns is in nanoseconds where as maxDelay/minDelay are in microseconds.
409 * continuous, on-change: maximum sampling period allowed in microseconds.
410 * one-shot, special : 0
411 * 2) maxDelay should always fit within a 32 bit signed integer. It is declared as 64 bit
412 * on 64 bit architectures only for binary compatibility reasons.
413 * Availability: SENSORS_DEVICE_API_VERSION_1_3
415 max_delay_t sensor_get_max_delay (int s)
417 char avail_sysfs_path[PATH_MAX];
418 int dev_num = sensor_info[s].dev_num;
421 float min_supported_rate = 1000;
424 /* continuous, on-change: maximum sampling period allowed in microseconds.
425 * one-shot, special : 0
427 if (REPORTING_MODE(sensor_desc[s].flags) == SENSOR_FLAG_ONE_SHOT_MODE ||
428 REPORTING_MODE(sensor_desc[s].flags) == SENSOR_FLAG_SPECIAL_REPORTING_MODE)
431 sprintf(avail_sysfs_path, DEVICE_AVAIL_FREQ_PATH, dev_num);
433 if (sysfs_read_str(avail_sysfs_path, freqs_buf, sizeof(freqs_buf)) < 0) {
434 /* If poll mode sensor */
435 if (!sensor_info[s].num_channels) {
437 min_supported_rate = get_cdd_freq(s, 1);
441 while (*cursor && cursor[0]) {
443 /* Decode a single value */
444 sr = strtod(cursor, NULL);
446 if (sr < min_supported_rate)
447 min_supported_rate = sr;
450 while (cursor[0] && !isspace(cursor[0]))
454 while (cursor[0] && isspace(cursor[0]))
459 /* return 0 for wrong values */
460 if (min_supported_rate < 0.1)
463 /* Return microseconds */
464 return (max_delay_t)(1000000.0 / min_supported_rate);
467 /* this value depends on the reporting mode:
469 * continuous: minimum sample period allowed in microseconds
472 * special : 0, unless otherwise noted
474 int32_t sensor_get_min_delay(int s)
476 char avail_sysfs_path[PATH_MAX];
477 int dev_num = sensor_info[s].dev_num;
480 float max_supported_rate = 0;
483 /* continuous: minimum sampling period allowed in microseconds.
484 * on-change, special : 0
487 if (REPORTING_MODE(sensor_desc[s].flags) == SENSOR_FLAG_ON_CHANGE_MODE ||
488 REPORTING_MODE(sensor_desc[s].flags) == SENSOR_FLAG_SPECIAL_REPORTING_MODE)
491 if (REPORTING_MODE(sensor_desc[s].flags) == SENSOR_FLAG_ONE_SHOT_MODE)
494 sprintf(avail_sysfs_path, DEVICE_AVAIL_FREQ_PATH, dev_num);
496 if (sysfs_read_str(avail_sysfs_path, freqs_buf, sizeof(freqs_buf)) < 0) {
497 /* If poll mode sensor */
498 if (!sensor_info[s].num_channels) {
499 /* The should rate */
500 max_supported_rate = get_cdd_freq(s, 0);
504 while (*cursor && cursor[0]) {
506 /* Decode a single value */
507 sr = strtod(cursor, NULL);
509 if (sr > max_supported_rate && sr <= sensor_get_max_freq(s))
510 max_supported_rate = sr;
513 while (cursor[0] && !isspace(cursor[0]))
517 while (cursor[0] && isspace(cursor[0]))
522 /* return 0 for wrong values */
523 if (max_supported_rate < 0.1)
526 /* Return microseconds */
527 return (int32_t)(1000000.0 / max_supported_rate);