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
  12 #define DEV_FILE_PATH   "/dev/iio:device%d"
  13
  14 #define BASE_PATH       "/sys/bus/iio/devices/iio:device%d/"
  15
  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
  38 struct channel_descriptor_t
  39 {
  40         /* sysfs entries located under scan_elements */
  41         const char *en_path;    /* Enabled sysfs file name ; ex: "in_temp_en" */
  42         const char *type_path;  /* _type sysfs file name  */
  43         const char *index_path; /* _index sysfs file name */
  44
  45         /* sysfs entries located in /sys/bus/iio/devices/iio:deviceX */
  46         const char *raw_path;   /* _raw sysfs file name  */
  47         const char *input_path; /* _input sysfs file name */
  48         const char *scale_path; /* _scale sysfs file name */
  49 };
  50
  51 struct sensor_catalog_entry_t
  52 {
  53         const char *tag; /* Prefix such as "accel", "gyro", "temp"... */
  54         const int type;  /* Sensor type ; ex: SENSOR_TYPE_ACCELEROMETER */
  55         const int num_channels; /* Expected iio channels for this sensor */
  56         struct channel_descriptor_t channel[MAX_CHANNELS];
  57 };
  58
  59 struct datum_info_t
  60 {
  61         char sign;
  62         char endianness;
  63         short realbits;
  64         short storagebits;
  65         short shift;
  66 };
  67
  68 struct channel_info_t
  69 {
  70         int offset; /* Offset in bytes within the iio character device report */
  71         int size;                       /* Field size in bytes */
  72         float scale;                    /* scale for each channel */
  73         char type_spec[MAX_TYPE_SPEC_LEN]; /* From driver; ex: le:u10/16>>0 */
  74         struct datum_info_t type_info;     /* Decoded contents of type spec */
  75 };
  76
  77 struct sample_ops_t
  78 {
  79         /* Conversion function called once per channel */
  80         float (*transform)(int s, int c, unsigned char* sample_data);
  81
  82         /* Function called once per sample */
  83         void (*finalize)(int s, struct sensors_event_t* data);
  84 };
  85
  86 struct sensor_info_t
  87 {
  88         char friendly_name[MAX_NAME_SIZE];      /* ex: Accelerometer */
  89         char internal_name[MAX_NAME_SIZE];      /* ex: accel_3d */
  90         char vendor_name[MAX_NAME_SIZE];        /* ex: Intel */
  91
  92         float max_range;
  93         float resolution;
  94         float power;
  95
  96         float offset;   /* (cooked = raw + offset) * scale */
  97         float scale;    /*default: 1. when set to 0, use channel specific value*/
  98         float illumincalib;     /* to set the calibration for the ALS */
  99
 100         int sampling_rate;      /* requested events / second */
 101
 102         int dev_num;    /* Associated iio dev num, ex: 3 for /dev/iio:device3 */
 103         int enable_count;
 104
 105         int catalog_index;/* Associated entry within the sensor_catalog array */
 106
 107         int num_channels; /* Actual channel count ; 0 for poll mode sensors */
 108
 109         /*
 110          * The array below indicates where to gather report data for this
 111          * sensor inside the reports that we read from the iio character device.
 112          * It is updated whenever channels are enabled or disabled on the same
 113          * device. Channel size indicates the size in bytes of fields, and
 114          * should be zero for disabled channels. The type field indicates how a
 115          * specific channel data item is structured.
 116          */
 117         struct channel_info_t channel[MAX_CHANNELS];
 118
 119         /*
 120          * This flag is set if we acquired data from the sensor but did not
 121          * forward it to upper layers (i.e. Android) yet. If so, report_buffer
 122          * contains that data.
 123          */
 124         int report_pending;
 125
 126         unsigned char report_buffer[MAX_SENSOR_REPORT_SIZE];
 127
 128         int64_t last_integration_ts; /* Last time an event was reported */
 129
 130         struct sample_ops_t ops;
 131
 132         /* Note: we may have to explicitely serialize access to some fields */
 133 };
 134
 135 /* Reference a few commonly used variables... */
 136 extern int                              sensor_count;
 137 extern struct sensor_info_t             sensor_info[MAX_SENSORS];
 138 extern struct sensor_catalog_entry_t    sensor_catalog[];
 139
 140 #endif