common.h

   1 /*
   2 // Copyright (c) 2015 Intel Corporation
   3 //
   4 // Licensed under the Apache License, Version 2.0 (the "License");
   5 // you may not use this file except in compliance with the License.
   6 // You may obtain a copy of the License at
   7 //
   8 //      http://www.apache.org/licenses/LICENSE-2.0
   9 //
  10 // Unless required by applicable law or agreed to in writing, software
  11 // distributed under the License is distributed on an "AS IS" BASIS,
  12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 // See the License for the specific language governing permissions and
  14 // limitations under the License.
  15 */
  16
  17 #ifndef __COMMON_H__
  18 #define __COMMON_H__
  19
  20 #include <string.h>
  21
  22 #define MAX_DEVICES     9       /* Check iio devices 0 to MAX_DEVICES-1 */
  23 #define MAX_SENSORS     12      /* We can handle as many sensors */
  24 #define MAX_CHANNELS    4       /* We can handle as many channels per sensor */
  25 #define MAX_EVENTS      2       /* We can handle as many events per channel */
  26 #define MAX_TRIGGERS    8       /* Check for triggers 0 to MAX_TRIGGERS-1 */
  27
  28 #define DEV_FILE_PATH           "/dev/iio:device%d"
  29 #define BASE_PATH               "/sys/bus/iio/devices/iio:device%d/"
  30 #define TRIGGER_FILE_PATH       "/sys/bus/iio/devices/trigger%d/name"
  31 #define IIO_DEVICES             "/sys/bus/iio/devices/"
  32
  33 #define CHANNEL_PATH            BASE_PATH "scan_elements/"
  34 #define ENABLE_PATH             BASE_PATH "buffer/enable"
  35 #define BUFFER_LENGTH_PATH      BASE_PATH "buffer/length"
  36 #define NAME_PATH               BASE_PATH "name"
  37 #define TRIGGER_PATH            BASE_PATH "trigger/current_trigger"
  38 #define EVENTS_PATH             BASE_PATH "events/"
  39 #define SENSOR_ENABLE_PATH      BASE_PATH "in_%s_en"
  40 #define SENSOR_OFFSET_PATH      BASE_PATH "in_%s_offset"
  41 #define SENSOR_SCALE_PATH       BASE_PATH "in_%s_scale"
  42 #define SENSOR_SAMPLING_PATH    BASE_PATH "in_%s_sampling_frequency"
  43 #define SENSOR_AVAIL_FREQ_PATH  BASE_PATH "in_%s_sampling_frequency_available"
  44 #define DEVICE_SAMPLING_PATH    BASE_PATH "sampling_frequency"
  45 #define DEVICE_AVAIL_FREQ_PATH  BASE_PATH "sampling_frequency_available"
  46 #define ILLUMINATION_CALIBPATH  BASE_PATH "in_illuminance_calibscale"
  47 #define SENSOR_CALIB_BIAS_PATH  BASE_PATH "in_%s_calibbias"
  48 #define MOUNTING_MATRIX_PATH    BASE_PATH "mounting_matrix"
  49
  50 #define CONFIGFS_TRIGGER_PATH   "/sys/kernel/config/iio/triggers/"
  51
  52 #define PROP_BASE               "ro.iio.%s.%s" /* Note: PROPERTY_KEY_MAX is small */
  53
  54 #define MAX_TYPE_SPEC_LEN       32      /* Channel type spec len; ex: "le:u10/16>>0" */
  55 #define MAX_SENSOR_REPORT_SIZE  32      /* Sensor report buffer size */
  56 #define MAX_DEVICE_REPORT_SIZE  32      /* iio device scan buffer size */
  57
  58 #define MAX_NAME_SIZE           64
  59
  60 #define MAX_SENSOR_BASES        3       /* Max number of base sensors a sensor can rely on */
  61
  62 #define ARRAY_SIZE(x) sizeof(x)/sizeof(x[0])
  63 #define REPORTING_MODE(x)       ((x) & 0x06)
  64
  65 #define FILTER_TYPE_NONE                0
  66 #define FILTER_TYPE_MOVING_AVERAGE      1
  67 #define FILTER_TYPE_MEDIAN              2
  68
  69 #define MODE_AUTO       0 /* autodetect */
  70 #define MODE_POLL       1
  71 #define MODE_TRIGGER    2
  72 #define MODE_EVENT      3
  73
  74
  75 typedef struct
  76 {
  77         const char *type; /* event type; e.g: transition */
  78         const char *dir;  /* event direction; e.g: rising */
  79
  80         /* sysfs entries located in /sys/bus/iio/devices/iio:deviceX/events/ */
  81         const char *ev_en_path;
  82         const char *ev_value_path;
  83 }
  84 event_descriptor_t;
  85
  86
  87 typedef struct
  88 {
  89         const char *name;       /* channel name ; ex: x */
  90
  91         /* sysfs entries located under scan_elements */
  92         const char *en_path;    /* Enabled sysfs file name ; ex: "in_temp_en" */
  93         const char *type_path;  /* _type sysfs file name  */
  94         const char *index_path; /* _index sysfs file name */
  95
  96         /* sysfs entries located in /sys/bus/iio/devices/iio:deviceX */
  97         const char *raw_path;   /* _raw sysfs file name  */
  98         const char *input_path; /* _input sysfs file name */
  99         const char *scale_path; /* _scale sysfs file name */
 100
 101         const int num_events;
 102         event_descriptor_t event[MAX_EVENTS];
 103 }
 104 channel_descriptor_t;
 105
 106
 107 typedef struct
 108 {
 109         const char *tag;        /* Prefix such as "accel", "gyro", "temp"... */
 110         const char *shorthand;
 111         const int type;         /* Sensor type ; ex: SENSOR_TYPE_ACCELEROMETER */
 112         const int num_channels; /* Expected iio channels for this sensor */
 113         const int is_virtual;   /* Is the sensor virtual or not */
 114         channel_descriptor_t channel[MAX_CHANNELS];
 115 }
 116 sensor_catalog_entry_t;
 117
 118
 119 typedef struct
 120 {
 121         char sign;
 122         char endianness;
 123         short realbits;
 124         short storagebits;
 125         short shift;
 126 }
 127 datum_info_t;
 128
 129
 130 typedef struct
 131 {
 132         int offset;     /* Offset in bytes within the iio character device report */
 133         int size;       /* Field size in bytes */
 134         float scale;    /* Scale for each channel */
 135         char type_spec[MAX_TYPE_SPEC_LEN];      /* From driver; ex: le:u10/16>>0 */
 136         datum_info_t type_info;                 /* Decoded contents of type spec */
 137         float opt_scale; /*
 138                           * Optional correction scale read from a property such as iio.accel.x.scale, allowing late compensation of
 139                           * problems such as misconfigured axes ; set to 1 by default. Applied at the end of the scaling process.
 140                           */
 141         int raw_path_present;   /* Flag signalling the presence of in_<sens>_<axis>_raw file */
 142         int input_path_present; /* Flag signalling the presence of in_<sens>_input file */
 143 }
 144 channel_info_t;
 145
 146
 147 typedef struct
 148 {
 149         /* Conversion function called once per channel */
 150         float (*transform) (int s, int c, unsigned char* sample_data);
 151
 152         /* Function called once per sample */
 153         int (*finalize) (int s, sensors_event_t* data);
 154 }
 155 sample_ops_t;
 156
 157
 158 /*
 159  * Whenever we have sensor data recorded for a sensor in the associated
 160  * sensor cell, its report_pending field is set to a non-zero value
 161  * indicating how we got this data.
 162  */
 163 #define DATA_TRIGGER    1       /* From /dev/iio:device fd              */
 164 #define DATA_SYSFS      2       /* Through polling                      */
 165 #define DATA_DUPLICATE  3       /* Duplicate of triggered motion sample */
 166
 167
 168 typedef struct
 169 {
 170         char friendly_name[MAX_NAME_SIZE];      /* ex: Accelerometer         */
 171         char internal_name[MAX_NAME_SIZE];      /* ex: accel_3d              */
 172         char vendor_name[MAX_NAME_SIZE];        /* ex: Intel                 */
 173         char init_trigger_name[MAX_NAME_SIZE];  /* ex: accel-name-dev1       */
 174         char motion_trigger_name[MAX_NAME_SIZE];/* ex: accel-any-motion-dev1 */
 175         char hrtimer_trigger_name[MAX_NAME_SIZE]; /*ex: accel-hr-dev1 */
 176         int trigger_nr; /* trigger number associated with this device */
 177         float max_range;
 178         float resolution;
 179         float power;
 180
 181         /*
 182          * Currently active trigger - either a pointer to the initial (default) trigger name buffer, or a pointer to the motion trigger name buffer,
 183          * or something else (typically NULL or a pointer to some static "\n". This is used to determine if the conditions are met to switch from
 184          * the default trigger to the motion trigger for a sensor, or rather for the interrupt-driven sensors associated to a given iio device.
 185          */
 186         const char* selected_trigger;
 187
 188         float offset;           /* (cooked = raw + offset) * scale                      */
 189         float scale;            /* default:1. when set to 0, use channel specific value */
 190         float illumincalib;     /* to set the calibration for the ALS                   */
 191
 192         float requested_rate;   /* requested events / second                            */
 193         float sampling_rate;    /* setup events / second                                */
 194
 195         float min_supported_rate;
 196         float max_supported_rate;
 197
 198         int dev_num;            /* Associated iio dev num, ex: 3 for /dev/iio:device3   */
 199
 200         int catalog_index;      /* Associated entry within the sensor_catalog array     */
 201         int type;               /* Sensor type, such as SENSOR_TYPE_GYROSCOPE           */
 202
 203         int num_channels;       /* Actual channel count ; 0 for poll mode sensors       */
 204
 205         int mode;       /* Usage mode, ex: poll, trigger ... */
 206
 207         /*
 208          * The array below indicates where to gather report data for this sensor inside the reports that we read from the iio character device.
 209          * It is updated whenever channels are enabled or disabled on the same device. Channel size indicates the size in bytes of fields, and
 210          * should be zero for disabled channels. The type field indicates how a specific channel data item is structured.
 211          */
 212         channel_info_t channel[MAX_CHANNELS];
 213
 214         /*
 215          * This flag is set if we acquired data from the sensor but did not forward it to upper layers (i.e. Android) yet. If so, report_buffer
 216          * contains that data. Valid values are 0: empty, 1: normal, 2: repeat of last acquired value after timeout.
 217          */
 218         int report_pending;
 219
 220         /* This flag is set if we have a meta data event pending */
 221         int meta_data_pending;
 222
 223         /*
 224          * Timestamp closely matching the date of sampling, preferably retrieved from a iio channel alongside sample data. Value zero indicates that
 225          * we couldn't get such a closely correlated timestamp, and that one has to be generated before the report gets sent up to Android.
 226          */
 227         int64_t report_ts;
 228
 229         /* Buffer containing the last generated sensor report for this sensor */
 230         unsigned char report_buffer[MAX_SENSOR_REPORT_SIZE];
 231
 232         /* Whether or not the above buffer contains data from a device report */
 233         int report_initialized;
 234
 235         /* Channel and sample finalization callbacks for this sensor */
 236         sample_ops_t ops;
 237
 238         int cal_level; /* 0 means not calibrated */
 239
 240         /*
 241          * Depending on the sensor, calibration may take too much time at higher levels. Allow optional capping to a certain level.
 242          */
 243         int max_cal_level;
 244
 245         void *cal_data; /* Sensor calibration data, e.g. for magnetometer */
 246
 247         void* filter;   /* Filtering data for noisy sensors */
 248         int filter_type;/* FILTER_ specification for this sensor ; default is FILTER_NONE */
 249
 250         /* Previously reported value, for on-change sensors */
 251         union {
 252                 float data;
 253                 uint64_t data64;
 254         } prev_val;
 255         /*
 256          * Certain sensors expose their readings through sysfs files that have a long response time (100-200 ms for ALS). Rather than block our
 257          * global control loop for several hundred ms each second, offload those lengthy blocking reads to dedicated threads, which will then report
 258          * their data through a fd that we can add to our poll fd set.
 259          */
 260         int thread_data_fd[2];
 261         pthread_t acquisition_thread;
 262
 263         int base_count; /* How many base sensors is the sensor depending on */
 264         int base[MAX_SENSOR_BASES];
 265
 266         uint32_t quirks; /* Bit mask expressing the need for special tweaks */
 267
 268         /* Note: we may have to explicitely serialize access to some fields */
 269
 270         int is_virtual;                 /* Composite sensor, exposed from data acquired through other sensors */
 271
 272         uint32_t ref_count;             /* Dependency count - for a real sensor how many active virtual sensors are depending on it */
 273
 274         uint32_t directly_enabled;      /* Flag showing if a sensor was enabled directly by Android */
 275
 276         /*
 277          * Current sample for a virtual sensor - when a report is ready we'll keep the data here until it's finally processed. Can be modified for
 278          * more than one at a later time.
 279          */
 280         sensors_event_t sample;
 281         uint64_t event_id;
 282
 283         /*
 284          * If the QUIRK_FIELD_ORDERING bit is set in quirks, the contents of this array are used in the finalization stage to swap sample fields
 285          * before transmitting them to Android ; they form a mapping between the indices of the input and output arrays: ex: 0123 is identity for
 286          * a sample containing 4 fields.
 287          */
 288         unsigned char order[MAX_CHANNELS];
 289
 290         /*
 291          * If the QUIRK_MOUNTING_MATRIX bit is set in quirks, the contents of this matrix is used to correct the sample values so that it takes
 292          * into account the way the sensor has been mounted on the PCB.
 293          */
 294         float mounting_matrix[9];
 295
 296         /** Count of available frequencies */
 297         int avail_freqs_count;
 298
 299         /** Array of available frequencies */
 300         float* avail_freqs;
 301
 302         /*
 303          * Event counter - will be used to check if we have a significant sample for noisy sensors. We want to make sure we do not send any wrong
 304          * events before filtering kicks in. We can also use it for statistics.
 305          */
 306         uint64_t event_count;
 307
 308         /* Some polled sensors need to be first enabled so that they start
 309          * computing a set of values in hardware (e.g step counter). Enabling
 310          * is done through a sysfs attribute in_<tag>_en
 311          */
 312         int needs_enable;
 313
 314         float semi_arbitrated_rate;     /* Arbitrated sampling rate before we considered other sensors co-located on the same iio device */
 315 }
 316 sensor_info_t;
 317
 318
 319 /* Reference a few commonly used variables... */
 320 extern int                      sensor_count;
 321 extern struct sensor_t          sensor_desc[MAX_SENSORS];
 322 extern sensor_info_t            sensor[MAX_SENSORS];
 323 extern sensor_catalog_entry_t   sensor_catalog[];
 324 extern unsigned int             catalog_size;
 325
 326 /* Needed both in sensors and activity HALs */
 327 void check_trig_sensors (int i, char *sysfs_file, char map[catalog_size]);
 328 void check_poll_sensors (int i, char *sysfs_file, char map[catalog_size]);
 329 void check_event_sensors (int i, char *sysfs_file, char map[catalog_size]);
 330 void discover_sensors(int dev_num, char *sysfs_base_path, char map[catalog_size],
 331                       void (*discover_sensor)(int, char*, char*));
 332
 333 /*
 334  * Macros associating iio sysfs entries to to sensor types ; see
 335  * linux/kernel/drivers/iio/industrialio-core.c and
 336  * hardware/libhardware/include/hardware/sensor.h
 337  */
 338
 339 #define DECLARE_VOID_CHANNEL(tag)       \
 340                         tag,    \
 341                         "",     \
 342                         "",     \
 343                         "",     \
 344                         "",     \
 345                         "",     \
 346                         "",     \
 347
 348 #define DECLARE_CHANNEL(tag, spacer, name)              \
 349                         name,                           \
 350                         "in_"tag spacer name"_en",      \
 351                         "in_"tag spacer name"_type",    \
 352                         "in_"tag spacer name"_index",   \
 353                         "in_"tag spacer name"_raw",     \
 354                         "in_"tag spacer name"_input",   \
 355                         "in_"tag spacer name"_scale",   \
 356                         0, {{0}},
 357
 358 #define DECLARE_NAMED_CHANNEL(tag, name)        DECLARE_CHANNEL(tag, "_", name)
 359
 360 #define DECLARE_GENERIC_CHANNEL(tag)            DECLARE_CHANNEL(tag, "", "")
 361
 362 #define DECLARE_EVENT(tag, spacer1, name, spacer2, type, spacer3, dir)          \
 363                       type, dir,                                                \
 364                       "in_"tag spacer1 name spacer2 type spacer3 dir"_en",      \
 365                       "in_"tag spacer1 name spacer2 type spacer3 dir"_value",   \
 366
 367 #define DECLARE_GENERIC_EVENT(tag, name, type, dir) \
 368                 DECLARE_EVENT(tag, "_", name, "_", type, "_", dir)
 369 #define DECLARE_NAMED_EVENT(tag, name) \
 370                 DECLARE_EVENT(tag, "_", name, "","","","")
 371
 372 #endif