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
  33 #define MAX_NAME_SIZE           32
  34
  35 #define ARRAY_SIZE(x) sizeof(x)/sizeof(x[0])
  36
  37 #ifdef __LP64__
  38         typedef uint64_t flag_t;
  39         typedef int64_t max_delay_t;
  40 #else
  41         typedef uint32_t flag_t;
  42         typedef int32_t max_delay_t;
  43 #endif
  44
  45 struct channel_descriptor_t
  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
  60 struct sensor_catalog_entry_t
  61 {
  62         const char *tag; /* Prefix such as "accel", "gyro", "temp"... */
  63         const int type;  /* Sensor type ; ex: SENSOR_TYPE_ACCELEROMETER */
  64         const int num_channels; /* Expected iio channels for this sensor */
  65         struct channel_descriptor_t channel[MAX_CHANNELS];
  66 };
  67
  68 struct datum_info_t
  69 {
  70         char sign;
  71         char endianness;
  72         short realbits;
  73         short storagebits;
  74         short shift;
  75 };
  76
  77 struct channel_info_t
  78 {
  79         int offset; /* Offset in bytes within the iio character device report */
  80         int size;                       /* Field size in bytes */
  81         float scale;                    /* scale for each channel */
  82         char type_spec[MAX_TYPE_SPEC_LEN]; /* From driver; ex: le:u10/16>>0 */
  83         struct datum_info_t type_info;     /* Decoded contents of type spec */
  84         float opt_scale; /* Optional correction scale read from a property such
  85                           * as iio.accel.x.scale, allowing late compensation of
  86                           * problems such as misconfigured axes ; set to 1 by
  87                           * default. Applied at the end of the scaling process.
  88                           */
  89 };
  90
  91 struct sample_ops_t
  92 {
  93         /* Conversion function called once per channel */
  94         float (*transform)(int s, int c, unsigned char* sample_data);
  95
  96         /* Function called once per sample */
  97         int (*finalize)(int s, struct sensors_event_t* data);
  98 };
  99
 100 struct sensor_info_t
 101 {
 102         char friendly_name[MAX_NAME_SIZE];      /* ex: Accelerometer */
 103         char internal_name[MAX_NAME_SIZE];      /* ex: accel_3d */
 104         char vendor_name[MAX_NAME_SIZE];        /* ex: Intel */
 105         char trigger_name[MAX_NAME_SIZE];       /* ex: accel-name-dev1 */
 106         float max_range;
 107         float resolution;
 108         float power;
 109
 110         float offset;   /* (cooked = raw + offset) * scale */
 111         float scale;    /*default: 1. when set to 0, use channel specific value*/
 112         float illumincalib;     /* to set the calibration for the ALS */
 113
 114         float sampling_rate;    /* requested events / second */
 115
 116         int dev_num;    /* Associated iio dev num, ex: 3 for /dev/iio:device3 */
 117         int enable_count;
 118
 119         int catalog_index;/* Associated entry within the sensor_catalog array */
 120
 121         int num_channels; /* Actual channel count ; 0 for poll mode sensors */
 122
 123         /*
 124          * The array below indicates where to gather report data for this
 125          * sensor inside the reports that we read from the iio character device.
 126          * It is updated whenever channels are enabled or disabled on the same
 127          * device. Channel size indicates the size in bytes of fields, and
 128          * should be zero for disabled channels. The type field indicates how a
 129          * specific channel data item is structured.
 130          */
 131         struct channel_info_t channel[MAX_CHANNELS];
 132
 133         /*
 134          * This flag is set if we acquired data from the sensor but did not
 135          * forward it to upper layers (i.e. Android) yet. If so, report_buffer
 136          * contains that data.
 137          */
 138         int report_pending;
 139
 140         /*
 141          * Timestamp closely matching the date of sampling, preferably retrieved
 142          * from a iio channel alongside sample data. Value zero indicates that
 143          * we couldn't get such a closely correlated timestamp, and that one
 144          * has to be generated before the report gets sent up to Android.
 145          */
 146         int64_t report_ts;
 147
 148         /* Buffer containing the last generated sensor report for this sensor */
 149         unsigned char report_buffer[MAX_SENSOR_REPORT_SIZE];
 150
 151         /* Whether or not the above buffer contains data from a device report */
 152         int report_initialized;
 153
 154         struct sample_ops_t ops;
 155
 156         int calibrated;
 157         void* cal_data;
 158
 159         float prev_val; /* Previously reported value, for on-change sensors */
 160
 161         /*
 162          * Certain sensors expose their readings through sysfs files that have
 163          * a long response time (100-200 ms for ALS). Rather than block our
 164          * global control loop for several hundred ms each second, offload those
 165          * lengthy blocking reads to dedicated threads, which will then report
 166          * their data through a fd that we can add to our poll fd set.
 167          */
 168         int thread_data_fd[2];
 169         pthread_t acquisition_thread;
 170
 171         /* For cal-uncal sensor pairs - index to the pair sensor in sensor_info */
 172         int pair_idx;
 173
 174         uint32_t quirks; /* Bit mask expressing the need for special tweaks */
 175
 176         /* Note: we may have to explicitely serialize access to some fields */
 177
 178
 179         /*
 180          * If the QUIRK_FIELD_ORDERING bit is set in quirks, the contents of
 181          * this array are used in the finalization stage to swap sample fields
 182          * before transmitting them to Android ; they form a mapping between
 183          * the indices of the input and output arrays: ex: 0123 is identity for
 184          * a sample containing 4 fields.
 185          */
 186         unsigned char order[MAX_CHANNELS];
 187
 188         /* A few variables used for data filtering */
 189         float *history;         /* Working buffer containing recorded samples */
 190         int history_size;       /* Number of recorded samples                 */
 191         int history_entries;    /* How many of these are initialized          */
 192         int history_index;      /* Index of sample to evict next time         */
 193 };
 194
 195 /* Reference a few commonly used variables... */
 196 extern int                              sensor_count;
 197 extern struct sensor_t      sensor_desc[MAX_SENSORS];
 198 extern struct sensor_info_t             sensor_info[MAX_SENSORS];
 199 extern struct sensor_catalog_entry_t    sensor_catalog[];
 200
 201 #endif