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