common.h

   1 /*
   2  * Copyright (C) 2014 Intel Corporation.
   3  */
   4
   5 #ifndef __COMMON_H__
   6 #define __COMMON_H__
   7
   8 #define MAX_DEVICES     8       /* Check iio devices 0 to MAX_DEVICES-1 */
   9 #define MAX_SENSORS     10      /* We can handle as many sensors */
  10 #define MAX_CHANNELS    4       /* We can handle as many channels per sensor */
  11 #define MAX_TRIGGERS    8       /* Check for triggers 0 to MAX_TRIGGERS-1 */
  12
  13 #define DEV_FILE_PATH           "/dev/iio:device%d"
  14 #define BASE_PATH               "/sys/bus/iio/devices/iio:device%d/"
  15 #define TRIGGER_FILE_PATH       "/sys/bus/iio/devices/trigger%d/name"
  16
  17 #define CHANNEL_PATH            BASE_PATH "scan_elements/"
  18 #define ENABLE_PATH             BASE_PATH "buffer/enable"
  19 #define NAME_PATH               BASE_PATH "name"
  20 #define TRIGGER_PATH            BASE_PATH "trigger/current_trigger"
  21 #define SENSOR_OFFSET_PATH      BASE_PATH "in_%s_offset"
  22 #define SENSOR_SCALE_PATH       BASE_PATH "in_%s_scale"
  23 #define SENSOR_SAMPLING_PATH    BASE_PATH "in_%s_sampling_frequency"
  24 #define DEVICE_SAMPLING_PATH    BASE_PATH "sampling_frequency"
  25 #define DEVICE_AVAIL_FREQ_PATH  BASE_PATH "sampling_frequency_available"
  26 #define ILLUMINATION_CALIBPATH  BASE_PATH "in_illuminance_calibscale"
  27
  28 #define PROP_BASE               "ro.iio.%s.%s" /* Note: PROPERTY_KEY_MAX is small */
  29
  30 #define MAX_TYPE_SPEC_LEN       32      /* Channel type spec len; ex: "le:u10/16>>0" */
  31 #define MAX_SENSOR_REPORT_SIZE  32      /* Sensor report buffer size */
  32 #define MAX_DEVICE_REPORT_SIZE  32      /* iio device scan buffer size */
  33
  34 #define MAX_NAME_SIZE           32
  35
  36 #define MAX_SENSOR_BASES        3       /* Max number of base sensors a sensor can rely on */
  37
  38 #define ARRAY_SIZE(x) sizeof(x)/sizeof(x[0])
  39 #define REPORTING_MODE(x)       ((x) & 0x06)
  40
  41 #define FILTER_TYPE_NONE                0
  42 #define FILTER_TYPE_MOVING_AVERAGE      1
  43 #define FILTER_TYPE_MEDIAN              2
  44
  45 typedef struct
  46 {
  47         const char *name;       /* channel name ; ex: x */
  48
  49         /* sysfs entries located under scan_elements */
  50         const char *en_path;    /* Enabled sysfs file name ; ex: "in_temp_en" */
  51         const char *type_path;  /* _type sysfs file name  */
  52         const char *index_path; /* _index sysfs file name */
  53
  54         /* sysfs entries located in /sys/bus/iio/devices/iio:deviceX */
  55         const char *raw_path;   /* _raw sysfs file name  */
  56         const char *input_path; /* _input sysfs file name */
  57         const char *scale_path; /* _scale sysfs file name */
  58 }
  59 channel_descriptor_t;
  60
  61
  62 typedef struct
  63 {
  64         const char *tag;        /* Prefix such as "accel", "gyro", "temp"... */
  65         const int type;         /* Sensor type ; ex: SENSOR_TYPE_ACCELEROMETER */
  66         const int num_channels; /* Expected iio channels for this sensor */
  67         const int is_virtual;   /* Is the sensor virtual or not */
  68         channel_descriptor_t channel[MAX_CHANNELS];
  69 }
  70 sensor_catalog_entry_t;
  71
  72
  73 typedef struct
  74 {
  75         char sign;
  76         char endianness;
  77         short realbits;
  78         short storagebits;
  79         short shift;
  80 }
  81 datum_info_t;
  82
  83
  84 typedef struct
  85 {
  86         int offset;     /* Offset in bytes within the iio character device report */
  87         int size;       /* Field size in bytes */
  88         float scale;    /* scale for each channel */
  89         char type_spec[MAX_TYPE_SPEC_LEN];      /* From driver; ex: le:u10/16>>0 */
  90         datum_info_t type_info;                 /* Decoded contents of type spec */
  91         float opt_scale; /*
  92                           * Optional correction scale read from a property such as iio.accel.x.scale, allowing late compensation of
  93                           * problems such as misconfigured axes ; set to 1 by default. Applied at the end of the scaling process.
  94                           */
  95 }
  96 channel_info_t;
  97
  98
  99 typedef struct
 100 {
 101         /* Conversion function called once per channel */
 102         float (*transform) (int s, int c, unsigned char* sample_data);
 103
 104         /* Function called once per sample */
 105         int (*finalize) (int s, sensors_event_t* data);
 106 }
 107 sample_ops_t;
 108
 109
 110 /*
 111  * Whenever we have sensor data recorded for a sensor in the associated
 112  * sensor cell, its report_pending field is set to a non-zero value
 113  * indicating how we got this data.
 114  */
 115 #define DATA_TRIGGER    1       /* From /dev/iio:device fd              */
 116 #define DATA_SYSFS      2       /* Through polling                      */
 117 #define DATA_DUPLICATE  3       /* Duplicate of triggered motion sample */
 118
 119
 120 typedef struct
 121 {
 122         char friendly_name[MAX_NAME_SIZE];      /* ex: Accelerometer         */
 123         char internal_name[MAX_NAME_SIZE];      /* ex: accel_3d              */
 124         char vendor_name[MAX_NAME_SIZE];        /* ex: Intel                 */
 125         char init_trigger_name[MAX_NAME_SIZE];  /* ex: accel-name-dev1       */
 126         char motion_trigger_name[MAX_NAME_SIZE];/* ex: accel-any-motion-dev1 */
 127         float max_range;
 128         float resolution;
 129         float power;
 130
 131         /*
 132          * Currently active trigger - either a pointer to the initial (default) trigger name buffer, or a pointer to the motion trigger name buffer,
 133          * 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
 134          * the default trigger to the motion trigger for a sensor, or rather for the interrupt-driven sensors associated to a given iio device.
 135          */
 136         const char* selected_trigger;
 137
 138         float offset;           /* (cooked = raw + offset) * scale                      */
 139         float scale;            /* default:1. when set to 0, use channel specific value */
 140         float illumincalib;     /* to set the calibration for the ALS                   */
 141
 142         float requested_rate;   /* requested events / second                            */
 143         float sampling_rate;    /* setup events / second                                */
 144
 145         float min_supported_rate;
 146         float max_supported_rate;
 147
 148         int dev_num;            /* Associated iio dev num, ex: 3 for /dev/iio:device3   */
 149
 150         int catalog_index;      /* Associated entry within the sensor_catalog array     */
 151         int type;               /* Sensor type, such as SENSOR_TYPE_GYROSCOPE           */
 152
 153         int num_channels;       /* Actual channel count ; 0 for poll mode sensors       */
 154
 155         int is_polling;         /* 1 if we use the sensor in poll mode, 0 if triggered  */
 156
 157         /*
 158          * The array below indicates where to gather report data for this sensor inside the reports that we read from the iio character device.
 159          * It is updated whenever channels are enabled or disabled on the same device. Channel size indicates the size in bytes of fields, and
 160          * should be zero for disabled channels. The type field indicates how a specific channel data item is structured.
 161          */
 162         channel_info_t channel[MAX_CHANNELS];
 163
 164         /*
 165          * 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
 166          * contains that data. Valid values are 0: empty, 1: normal, 2: repeat of last acquired value after timeout.
 167          */
 168         int report_pending;
 169
 170         /* This flag is set if we have a meta data event pending */
 171         int meta_data_pending;
 172
 173         /*
 174          * Timestamp closely matching the date of sampling, preferably retrieved from a iio channel alongside sample data. Value zero indicates that
 175          * we couldn't get such a closely correlated timestamp, and that one has to be generated before the report gets sent up to Android.
 176          */
 177         int64_t report_ts;
 178
 179         /* Buffer containing the last generated sensor report for this sensor */
 180         unsigned char report_buffer[MAX_SENSOR_REPORT_SIZE];
 181
 182         /* Whether or not the above buffer contains data from a device report */
 183         int report_initialized;
 184
 185         /* Channel and sample finalization callbacks for this sensor */
 186         sample_ops_t ops;
 187
 188         int cal_level; /* 0 means not calibrated */
 189
 190         /*
 191          * Depending on the sensor, calibration may take too much time at higher levels. Allow optional capping to a certain level.
 192          */
 193         int max_cal_level;
 194
 195         void *cal_data; /* Sensor calibration data, e.g. for magnetometer */
 196
 197         /* Filtering data for noisy sensors */
 198         void* filter;
 199
 200         float prev_val; /* Previously reported value, for on-change sensors */
 201
 202         /*
 203          * Certain sensors expose their readings through sysfs files that have a long response time (100-200 ms for ALS). Rather than block our
 204          * global control loop for several hundred ms each second, offload those lengthy blocking reads to dedicated threads, which will then report
 205          * their data through a fd that we can add to our poll fd set.
 206          */
 207         int thread_data_fd[2];
 208         pthread_t acquisition_thread;
 209
 210         int base_count; /* How many base sensors is the sensor depending on */
 211         int base[MAX_SENSOR_BASES];
 212
 213         uint32_t quirks; /* Bit mask expressing the need for special tweaks */
 214
 215         /* Note: we may have to explicitely serialize access to some fields */
 216
 217         int is_virtual;                 /* Composite sensor, exposed from data acquired through other sensors */
 218
 219         uint32_t ref_count;             /* Dependency count - for a real sensor how many active virtual sensors are depending on it */
 220
 221         uint32_t directly_enabled;      /* Flag showing if a sensor was enabled directly by Android */
 222
 223         /*
 224          * 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
 225          * more than one at a later time.
 226          */
 227         sensors_event_t sample;
 228
 229         /*
 230          * 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
 231          * before transmitting them to Android ; they form a mapping between the indices of the input and output arrays: ex: 0123 is identity for
 232          * a sample containing 4 fields.
 233          */
 234         unsigned char order[MAX_CHANNELS];
 235
 236         /* A few variables used for data filtering */
 237         float *history;         /* Working buffer containing recorded samples */
 238         float *history_sum;     /* The current sum of the history elements    */
 239         int history_size;       /* Number of recorded samples                 */
 240         int history_entries;    /* How many of these are initialized          */
 241         int history_index;      /* Index of sample to evict next time         */
 242
 243         /*
 244          * 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
 245          * events before filtering kicks in. We can also use it for statistics.
 246          */
 247         uint64_t event_count;
 248
 249         int filter_type;        /* FILTER_ specification for this sensor ; default is FILTER_NONE */
 250 }
 251 sensor_info_t;
 252
 253
 254 /* Reference a few commonly used variables... */
 255 extern int                      sensor_count;
 256 extern struct sensor_t          sensor_desc[MAX_SENSORS];
 257 extern sensor_info_t            sensor[MAX_SENSORS];
 258 extern sensor_catalog_entry_t   sensor_catalog[];
 259
 260 #endif