2 * Copyright (C) 2014 Intel Corporation.
9 #include <hardware/sensors.h>
10 #include "enumeration.h"
11 #include "description.h"
13 #include "transform.h"
14 #include "description.h"
16 #include "calibration.h"
17 #include "filtering.h"
20 * This table maps syfs entries in scan_elements directories to sensor types,
21 * and will also be used to determine other sysfs names as well as the iio
22 * device number associated to a specific sensor.
26 * We duplicate entries for the uncalibrated types after their respective base
27 * sensor. This is because all sensor entries must have an associated catalog entry
28 * and also because when only the uncal sensor is active it needs to take it's data
29 * from the same iio device as the base one.
32 struct sensor_catalog_entry_t sensor_catalog[] = {
33 DECLARE_SENSOR3("accel", SENSOR_TYPE_ACCELEROMETER, "x", "y", "z")
34 DECLARE_SENSOR3("anglvel", SENSOR_TYPE_GYROSCOPE, "x", "y", "z")
35 DECLARE_SENSOR3("magn", SENSOR_TYPE_MAGNETIC_FIELD, "x", "y", "z")
36 DECLARE_SENSOR1("intensity", SENSOR_TYPE_LIGHT, "both" )
37 DECLARE_SENSOR0("illuminance",SENSOR_TYPE_LIGHT )
38 DECLARE_SENSOR3("incli", SENSOR_TYPE_ORIENTATION, "x", "y", "z")
39 DECLARE_SENSOR4("rot", SENSOR_TYPE_ROTATION_VECTOR,
40 "quat_x", "quat_y", "quat_z", "quat_w")
41 DECLARE_SENSOR0("temp", SENSOR_TYPE_AMBIENT_TEMPERATURE )
42 DECLARE_SENSOR0("proximity", SENSOR_TYPE_PROXIMITY )
43 DECLARE_SENSOR3("anglvel", SENSOR_TYPE_GYROSCOPE_UNCALIBRATED, "x", "y", "z")
46 #define CATALOG_SIZE ARRAY_SIZE(sensor_catalog)
48 /* ACPI PLD (physical location of device) definitions, as used with sensors */
53 /* We equate sensor handles to indices in these tables */
55 struct sensor_t sensor_desc[MAX_SENSORS]; /* Android-level descriptors */
56 struct sensor_info_t sensor_info[MAX_SENSORS]; /* Internal descriptors */
57 int sensor_count; /* Detected sensors */
60 static void setup_properties_from_pld(int s, int panel, int rotation,
64 * Generate suitable order and opt_scale directives from the PLD panel
65 * and rotation codes we got. This can later be superseded by the usual
66 * properties if necessary. Eventually we'll need to replace these
67 * mechanisms by a less convoluted one, such as a 3x3 placement matrix.
74 int angle = rotation * 45;
76 /* Only deal with 3 axis chips for now */
80 if (panel == PANEL_BACK) {
81 /* Chip placed on the back panel ; negate x and z */
87 case 90: /* 90° clockwise: negate y then swap x,y */
92 case 180: /* Upside down: negate x and y */
97 case 270: /* 90° counter clockwise: negate x then swap x,y */
104 sensor_info[s].order[0] = 1;
105 sensor_info[s].order[1] = 0;
106 sensor_info[s].order[2] = 2;
107 sensor_info[s].quirks |= QUIRK_FIELD_ORDERING;
110 sensor_info[s].channel[0].opt_scale = x;
111 sensor_info[s].channel[1].opt_scale = y;
112 sensor_info[s].channel[2].opt_scale = z;
116 static int is_valid_pld (int panel, int rotation)
118 if (panel != PANEL_FRONT && panel != PANEL_BACK) {
119 ALOGW("Unhandled PLD panel spec: %d\n", panel);
123 /* Only deal with 90° rotations for now */
124 if (rotation < 0 || rotation > 7 || (rotation & 1)) {
125 ALOGW("Unhandled PLD rotation spec: %d\n", rotation);
133 static int read_pld_from_properties (int s, int* panel, int* rotation)
137 if (sensor_get_prop(s, "panel", &p))
140 if (sensor_get_prop(s, "rotation", &r))
143 if (!is_valid_pld(p, r))
149 ALOGI("S%d PLD from properties: panel=%d, rotation=%d\n", s, p, r);
155 static int read_pld_from_sysfs (int s, int dev_num, int* panel, int* rotation)
157 char sysfs_path[PATH_MAX];
160 sprintf(sysfs_path, BASE_PATH "../firmware_node/pld/panel", dev_num);
162 if (sysfs_read_int(sysfs_path, &p))
165 sprintf(sysfs_path, BASE_PATH "../firmware_node/pld/rotation", dev_num);
167 if (sysfs_read_int(sysfs_path, &r))
170 if (!is_valid_pld(p, r))
176 ALOGI("S%d PLD from sysfs: panel=%d, rotation=%d\n", s, p, r);
182 static void decode_placement_information (int dev_num, int num_channels, int s)
185 * See if we have optional "physical location of device" ACPI tags.
186 * We're only interested in panel and rotation specifiers. Use the
187 * .panel and .rotation properties in priority, and the actual ACPI
188 * values as a second source.
194 if (read_pld_from_properties(s, &panel, &rotation) &&
195 read_pld_from_sysfs(s, dev_num, &panel, &rotation))
196 return; /* No PLD data available */
198 /* Map that to field ordering and scaling mechanisms */
199 setup_properties_from_pld(s, panel, rotation, num_channels);
203 static void add_sensor (int dev_num, int catalog_index, int use_polling)
208 char sysfs_path[PATH_MAX];
215 char suffix[MAX_NAME_SIZE + 8];
217 if (sensor_count == MAX_SENSORS) {
218 ALOGE("Too many sensors!\n");
222 sensor_type = sensor_catalog[catalog_index].type;
225 * At this point we could check that the expected sysfs attributes are
226 * present ; that would enable having multiple catalog entries with the
227 * same sensor type, accomodating different sets of sysfs attributes.
232 sensor_info[s].dev_num = dev_num;
233 sensor_info[s].catalog_index = catalog_index;
234 sensor_info[s].type = sensor_type;
236 num_channels = sensor_catalog[catalog_index].num_channels;
239 sensor_info[s].num_channels = 0;
241 sensor_info[s].num_channels = num_channels;
243 prefix = sensor_catalog[catalog_index].tag;
246 * receiving the illumination sensor calibration inputs from
247 * the Android properties and setting it within sysfs
249 if (sensor_type == SENSOR_TYPE_LIGHT) {
250 retval = sensor_get_illumincalib(s);
252 sprintf(sysfs_path, ILLUMINATION_CALIBPATH, dev_num);
253 sysfs_write_int(sysfs_path, retval);
257 /* Read name attribute, if available */
258 sprintf(sysfs_path, NAME_PATH, dev_num);
259 sysfs_read_str(sysfs_path, sensor_info[s].internal_name, MAX_NAME_SIZE);
261 /* See if we have general offsets and scale values for this sensor */
263 sprintf(sysfs_path, SENSOR_OFFSET_PATH, dev_num, prefix);
264 sysfs_read_float(sysfs_path, &sensor_info[s].offset);
266 sprintf(sysfs_path, SENSOR_SCALE_PATH, dev_num, prefix);
267 if (!sysfs_read_float(sysfs_path, &scale)) {
268 sensor_info[s].scale = scale;
269 ALOGI("Scale path:%s scale:%f dev_num:%d\n",
270 sysfs_path, scale, dev_num);
272 sensor_info[s].scale = 1;
274 /* Read channel specific scale if any*/
275 for (c = 0; c < num_channels; c++)
277 sprintf(sysfs_path, BASE_PATH "%s", dev_num,
278 sensor_catalog[catalog_index].channel[c].scale_path);
280 if (!sysfs_read_float(sysfs_path, &scale)) {
281 sensor_info[s].channel[c].scale = scale;
282 sensor_info[s].scale = 0;
284 ALOGI( "Scale path:%s "
285 "channel scale:%f dev_num:%d\n",
286 sysfs_path, scale, dev_num);
291 /* Set default scaling - if num_channels is zero, we have one channel */
293 sensor_info[s].channel[0].opt_scale = 1;
295 for (c = 1; c < num_channels; c++)
296 sensor_info[s].channel[c].opt_scale = 1;
298 /* Read ACPI _PLD attributes for this sensor, if there are any */
299 decode_placement_information(dev_num, num_channels, s);
302 * See if we have optional correction scaling factors for each of the
303 * channels of this sensor. These would be expressed using properties
304 * like iio.accel.y.opt_scale = -1. In case of a single channel we also
305 * support things such as iio.temp.opt_scale = -1. Note that this works
306 * for all types of sensors, and whatever transform is selected, on top
307 * of any previous conversions.
311 for (c = 0; c < num_channels; c++) {
312 ch_name = sensor_catalog[catalog_index].channel[c].name;
313 sprintf(suffix, "%s.opt_scale", ch_name);
314 if (!sensor_get_fl_prop(s, suffix, &opt_scale))
315 sensor_info[s].channel[c].opt_scale = opt_scale;
318 if (!sensor_get_fl_prop(s, "opt_scale", &opt_scale))
319 sensor_info[s].channel[0].opt_scale = opt_scale;
321 /* Initialize Android-visible descriptor */
322 sensor_desc[s].name = sensor_get_name(s);
323 sensor_desc[s].vendor = sensor_get_vendor(s);
324 sensor_desc[s].version = sensor_get_version(s);
325 sensor_desc[s].handle = s;
326 sensor_desc[s].type = sensor_type;
327 sensor_desc[s].maxRange = sensor_get_max_range(s);
328 sensor_desc[s].resolution = sensor_get_resolution(s);
329 sensor_desc[s].power = sensor_get_power(s);
330 sensor_desc[s].stringType = sensor_get_string_type(s);
332 /* None of our supported sensors requires a special permission.
333 * If this will be the case we should implement a sensor_get_perm
335 sensor_desc[s].requiredPermission = "";
336 sensor_desc[s].flags = sensor_get_flags(s);
337 sensor_desc[s].minDelay = sensor_get_min_delay(s);
338 sensor_desc[s].maxDelay = sensor_get_max_delay(s);
339 ALOGI("Sensor %d (%s) type(%d) minD(%d) maxD(%d) flags(%2.2x)\n",
340 s, sensor_info[s].friendly_name, sensor_desc[s].type,
341 sensor_desc[s].minDelay, sensor_desc[s].maxDelay, sensor_desc[s].flags);
343 /* We currently do not implement batching when we'll so
344 * these should be overriden appropriately
346 sensor_desc[s].fifoReservedEventCount = 0;
347 sensor_desc[s].fifoMaxEventCount = 0;
349 if (sensor_info[s].internal_name[0] == '\0') {
351 * In case the kernel-mode driver doesn't expose a name for
352 * the iio device, use (null)-dev%d as the trigger name...
353 * This can be considered a kernel-mode iio driver bug.
355 ALOGW("Using null trigger on sensor %d (dev %d)\n", s, dev_num);
356 strcpy(sensor_info[s].internal_name, "(null)");
359 if (sensor_type == SENSOR_TYPE_GYROSCOPE ||
360 sensor_type == SENSOR_TYPE_GYROSCOPE_UNCALIBRATED) {
361 struct gyro_cal* calibration_data = calloc(1, sizeof(struct gyro_cal));
362 sensor_info[s].cal_data = calibration_data;
363 denoise_median_init(s, 3, 7);
366 if (sensor_type == SENSOR_TYPE_MAGNETIC_FIELD) {
367 struct compass_cal* calibration_data = calloc(1, sizeof(struct compass_cal));
368 sensor_info[s].cal_data = calibration_data;
371 /* Select one of the available sensor sample processing styles */
374 /* Initialize fields related to sysfs reads offloading */
375 sensor_info[s].thread_data_fd[0] = -1;
376 sensor_info[s].thread_data_fd[1] = -1;
377 sensor_info[s].acquisition_thread = -1;
379 /* Check if we have a special ordering property on this sensor */
380 if (sensor_get_order(s, sensor_info[s].order))
381 sensor_info[s].quirks |= QUIRK_FIELD_ORDERING;
387 static void discover_poll_sensors (int dev_num, char map[CATALOG_SIZE])
389 char base_dir[PATH_MAX];
395 memset(map, 0, CATALOG_SIZE);
397 snprintf(base_dir, sizeof(base_dir), BASE_PATH, dev_num);
399 dir = opendir(base_dir);
404 /* Enumerate entries in this iio device's base folder */
406 while ((d = readdir(dir))) {
407 if (!strcmp(d->d_name, ".") || !strcmp(d->d_name, ".."))
410 /* If the name matches a catalog entry, flag it */
411 for (i = 0; i<CATALOG_SIZE; i++) {
412 /* This will be added separately later */
413 if (sensor_catalog[i].type == SENSOR_TYPE_GYROSCOPE_UNCALIBRATED)
415 for (c=0; c<sensor_catalog[i].num_channels; c++)
416 if (!strcmp(d->d_name,sensor_catalog[i].channel[c].raw_path) ||
417 !strcmp(d->d_name, sensor_catalog[i].channel[c].input_path)) {
428 static void discover_trig_sensors (int dev_num, char map[CATALOG_SIZE])
430 char scan_elem_dir[PATH_MAX];
435 memset(map, 0, CATALOG_SIZE);
437 /* Enumerate entries in this iio device's scan_elements folder */
439 snprintf(scan_elem_dir, sizeof(scan_elem_dir), CHANNEL_PATH, dev_num);
441 dir = opendir(scan_elem_dir);
446 while ((d = readdir(dir))) {
447 if (!strcmp(d->d_name, ".") || !strcmp(d->d_name, ".."))
450 /* Compare en entry to known ones and create matching sensors */
452 for (i = 0; i<CATALOG_SIZE; i++) {
453 if (sensor_catalog[i].type == SENSOR_TYPE_GYROSCOPE_UNCALIBRATED)
455 if (!strcmp(d->d_name,
456 sensor_catalog[i].channel[0].en_path)) {
467 static void orientation_sensor_check(void)
470 * If we have accel + gyro + magn but no rotation vector sensor,
471 * SensorService replaces the HAL provided orientation sensor by the
472 * AOSP version... provided we report one. So initialize a virtual
473 * orientation sensor with zero values, which will get replaced. See:
474 * frameworks/native/services/sensorservice/SensorService.cpp, looking
475 * for SENSOR_TYPE_ROTATION_VECTOR; that code should presumably fall
476 * back to mUserSensorList.add instead of replaceAt, but accommodate it.
485 int catalog_size = CATALOG_SIZE;
487 for (i=0; i<sensor_count; i++)
488 switch (sensor_info[i].type) {
489 case SENSOR_TYPE_ACCELEROMETER:
492 case SENSOR_TYPE_GYROSCOPE:
495 case SENSOR_TYPE_MAGNETIC_FIELD:
498 case SENSOR_TYPE_ORIENTATION:
501 case SENSOR_TYPE_ROTATION_VECTOR:
506 if (has_acc && has_gyr && has_mag && !has_rot && !has_ori)
507 for (i=0; i<catalog_size; i++)
508 if (sensor_catalog[i].type == SENSOR_TYPE_ORIENTATION) {
509 ALOGI("Adding placeholder orientation sensor");
515 static void propose_new_trigger (int s, char trigger_name[MAX_NAME_SIZE],
519 * A new trigger has been enumerated for this sensor. Check if it makes
520 * sense to use it over the currently selected one, and select it if it
521 * is so. The format is something like sensor_name-dev0.
524 const char *suffix = trigger_name + sensor_name_len + 1;
526 /* dev is the default, and lowest priority; no need to update */
527 if (!memcmp(suffix, "dev", 3))
530 /* If we found any-motion trigger, record it */
532 if (!memcmp(suffix, "any-motion-", 11)) {
533 strcpy(sensor_info[s].motion_trigger_name, trigger_name);
538 * It's neither the default "dev" nor an "any-motion" one. Make sure we
539 * use this though, as we may not have any other indication of the name
540 * of the trigger to use with this sensor.
542 strcpy(sensor_info[s].init_trigger_name, trigger_name);
546 static void update_sensor_matching_trigger_name (char name[MAX_NAME_SIZE])
549 * Check if we have a sensor matching the specified trigger name,
550 * which should then begin with the sensor name, and end with a number
551 * equal to the iio device number the sensor is associated to. If so,
552 * update the string we're going to write to trigger/current_trigger
553 * when enabling this sensor.
563 * First determine the iio device number this trigger refers to. We
564 * expect the last few characters (typically one) of the trigger name
565 * to be this number, so perform a few checks.
567 len = strnlen(name, MAX_NAME_SIZE);
572 cursor = name + len - 1;
574 if (!isdigit(*cursor))
577 while (len && isdigit(*cursor)) {
582 dev_num = atoi(cursor+1);
584 /* See if that matches a sensor */
585 for (s=0; s<sensor_count; s++)
586 if (sensor_info[s].dev_num == dev_num) {
588 sensor_name_len = strlen(sensor_info[s].internal_name);
591 sensor_info[s].internal_name,
593 /* Switch to new trigger if appropriate */
594 propose_new_trigger(s, name, sensor_name_len);
599 static void setup_trigger_names (void)
601 char filename[PATH_MAX];
602 char buf[MAX_NAME_SIZE];
608 /* By default, use the name-dev convention that most drivers use */
609 for (s=0; s<sensor_count; s++)
610 snprintf(sensor_info[s].init_trigger_name,
611 MAX_NAME_SIZE, "%s-dev%d",
612 sensor_info[s].internal_name, sensor_info[s].dev_num);
614 /* Now have a look to /sys/bus/iio/devices/triggerX entries */
616 for (trigger=0; trigger<MAX_TRIGGERS; trigger++) {
618 snprintf(filename, sizeof(filename), TRIGGER_FILE_PATH,trigger);
620 ret = sysfs_read_str(filename, buf, sizeof(buf));
625 /* Record initial and any-motion triggers names */
626 update_sensor_matching_trigger_name(buf);
630 * Certain drivers expose only motion triggers even though they should
631 * be continous. For these, use the default trigger name as the motion
632 * trigger. The code generating intermediate events is dependent on
633 * motion_trigger_name being set to a non empty string.
636 for (s=0; s<sensor_count; s++)
637 if ((sensor_info[s].quirks & QUIRK_TERSE_DRIVER) &&
638 sensor_info[s].motion_trigger_name[0] == '\0')
639 strcpy( sensor_info[s].motion_trigger_name,
640 sensor_info[s].init_trigger_name);
642 for (s=0; s<sensor_count; s++)
643 if (sensor_info[s].num_channels) {
644 ALOGI("Sensor %d (%s) default trigger: %s\n", s,
645 sensor_info[s].friendly_name,
646 sensor_info[s].init_trigger_name);
647 if (sensor_info[s].motion_trigger_name[0])
648 ALOGI("Sensor %d (%s) motion trigger: %s\n",
649 s, sensor_info[s].friendly_name,
650 sensor_info[s].motion_trigger_name);
654 static void uncalibrated_gyro_check (void)
656 unsigned int has_gyr = 0;
657 unsigned int dev_num;
659 unsigned int is_poll_sensor;
660 char buf[MAX_NAME_SIZE];
664 int catalog_size = CATALOG_SIZE; /* Avoid GCC sign comparison warning */
666 /* Checking to see if we have a gyroscope - we can only have uncal if we have the base sensor */
667 for (i=0; i < sensor_count; i++)
668 if (sensor_info[i].type == SENSOR_TYPE_GYROSCOPE) {
670 dev_num = sensor_info[i].dev_num;
671 is_poll_sensor = !sensor_info[i].num_channels;
677 * If we have a gyro we can add the uncalibrated sensor of the same type and
678 * on the same dev_num. We will save indexes for easy finding and also save the
679 * channel specific information.
682 for (i=0; i<catalog_size; i++)
683 if (sensor_catalog[i].type == SENSOR_TYPE_GYROSCOPE_UNCALIBRATED) {
684 add_sensor(dev_num, i, is_poll_sensor);
686 uncal_idx = sensor_count - 1; /* Just added uncalibrated sensor */
688 /* Similar to build_sensor_report_maps */
689 for (c = 0; c < sensor_info[uncal_idx].num_channels; c++)
691 memcpy( &(sensor_info[uncal_idx].channel[c].type_spec),
692 &(sensor_info[cal_idx].channel[c].type_spec),
693 sizeof(sensor_info[uncal_idx].channel[c].type_spec));
694 sensor_info[uncal_idx].channel[c].type_info = sensor_info[cal_idx].channel[c].type_info;
695 sensor_info[uncal_idx].channel[c].offset = sensor_info[cal_idx].channel[c].offset;
696 sensor_info[uncal_idx].channel[c].size = sensor_info[cal_idx].channel[c].size;
698 sensor_info[uncal_idx].pair_idx = cal_idx;
699 sensor_info[cal_idx].pair_idx = uncal_idx;
700 strncpy(sensor_info[uncal_idx].init_trigger_name,
701 sensor_info[cal_idx].init_trigger_name,
703 strncpy(sensor_info[uncal_idx].motion_trigger_name,
704 sensor_info[cal_idx].motion_trigger_name,
707 /* Add "Uncalibrated " prefix to sensor name */
708 strcpy(buf, sensor_info[cal_idx].friendly_name);
709 snprintf(sensor_info[uncal_idx].friendly_name,
711 "%s %s", "Uncalibrated", buf);
716 void enumerate_sensors (void)
719 * Discover supported sensors and allocate control structures for them.
720 * Multiple sensors can potentially rely on a single iio device (each
721 * using their own channels). We can't have multiple sensors of the same
722 * type on the same device. In case of detection as both a poll-mode
723 * and trigger-based sensor, use the trigger usage mode.
725 char poll_sensors[CATALOG_SIZE];
726 char trig_sensors[CATALOG_SIZE];
731 for (dev_num=0; dev_num<MAX_DEVICES; dev_num++) {
734 discover_poll_sensors(dev_num, poll_sensors);
735 discover_trig_sensors(dev_num, trig_sensors);
737 for (i=0; i<CATALOG_SIZE; i++)
738 if (trig_sensors[i]) {
739 add_sensor(dev_num, i, 0);
744 add_sensor(dev_num, i, 1);
747 build_sensor_report_maps(dev_num);
751 ALOGI("Discovered %d sensors\n", sensor_count);
753 /* Set up default - as well as custom - trigger names */
754 setup_trigger_names();
756 /* Make sure Android fall backs to its own orientation sensor */
757 orientation_sensor_check();
760 * Create the uncalibrated counterpart to the compensated gyroscope.
761 * This is is a new sensor type in Android 4.4.
763 uncalibrated_gyro_check();
767 void delete_enumeration_data (void)
770 for (i = 0; i < sensor_count; i++)
771 switch (sensor_info[i].type) {
772 case SENSOR_TYPE_MAGNETIC_FIELD:
773 if (sensor_info[i].cal_data != NULL) {
774 free(sensor_info[i].cal_data);
775 sensor_info[i].cal_data = NULL;
776 sensor_info[i].cal_level = 0;
779 case SENSOR_TYPE_GYROSCOPE_UNCALIBRATED:
780 case SENSOR_TYPE_GYROSCOPE:
781 if (sensor_info[i].cal_data != NULL) {
782 free(sensor_info[i].cal_data);
783 sensor_info[i].cal_data = NULL;
784 sensor_info[i].cal_level = 0;
787 if (sensor_info[i].filter != NULL) {
788 denoise_median_release(i);
793 /* Reset sensor count */
798 int get_sensors_list( struct sensors_module_t* module,
799 struct sensor_t const** list)