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