iio_types.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef IIO_TYPES_H_
#define IIO_TYPES_H_
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
 
#include <stdbool.h>
#include <stdint.h>
#include "no_os_circular_buffer.h"
 
/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/
 
 
enum iio_val {
    IIO_VAL_INT = 1,
    IIO_VAL_INT_PLUS_MICRO,
    IIO_VAL_INT_PLUS_NANO,
    IIO_VAL_INT_PLUS_MICRO_DB,
    IIO_VAL_INT_MULTIPLE,
    IIO_VAL_FRACTIONAL = 10,
    IIO_VAL_FRACTIONAL_LOG2,
    IIO_VAL_CHAR
};
 
enum iio_chan_type {
    IIO_VOLTAGE,
    IIO_CURRENT,
    IIO_ALTVOLTAGE,
    IIO_ANGL_VEL,
    IIO_TEMP,
    IIO_CAPACITANCE,
    IIO_ACCEL,
    IIO_RESISTANCE,
    IIO_MAGN,
    IIO_INCLI,
    IIO_VELOCITY,
    IIO_ANGL
};
 
enum iio_modifier {
    IIO_NO_MOD,
    IIO_MOD_X,
    IIO_MOD_Y,
    IIO_MOD_Z,
    IIO_MOD_TEMP_AMBIENT
};
 
struct iio_ch_info {
    int16_t ch_num;
    bool ch_out;
    enum iio_chan_type type;
    bool differential;
    uint32_t address;
};
 
#define END_ATTRIBUTES_ARRAY {.name = NULL}
 
enum iio_attribute_shared {
    IIO_SEPARATE,
    IIO_SHARED_BY_TYPE,
    IIO_SHARED_BY_DIR,
    IIO_SHARED_BY_ALL,
};
 
struct iio_context_attribute {
    const char *name;
    const char *value;
};
 
struct iio_attribute {
    const char *name;
    intptr_t priv;
    enum iio_attribute_shared shared;
    int (*show)(void *device, char *buf, uint32_t len,
            const struct iio_ch_info *channel, intptr_t priv);
    int (*store)(void *device, char *buf, uint32_t len,
             const struct iio_ch_info *channel, intptr_t priv);
};
 
struct scan_type {
    char            sign;
    uint8_t         realbits;
    uint8_t         storagebits;
    uint8_t         shift;
    bool            is_big_endian;
};
 
struct iio_channel {
    const char      *name;
    enum iio_chan_type  ch_type;
    int             channel;
    int             channel2;
    unsigned long       address;
    int         scan_index;
    struct scan_type    *scan_type;
    struct iio_attribute    *attributes;
    bool            ch_out;
    bool            modified;
    bool            indexed;
    /* Set if the channel is differential. */
    bool            diferential;
};
 
enum iio_buffer_direction {
    IIO_DIRECTION_INPUT,
    IIO_DIRECTION_OUTPUT
};
 
struct iio_cyclic_buffer_info {
    bool is_cyclic;
    uint32_t buff_index;
};
 
struct iio_buffer {
    /* Mask with active channels */
    uint32_t active_mask;
    /* Size in bytes */
    uint32_t size;
    /* Number of bytes per sample * number of active channels */
    uint32_t bytes_per_scan;
    /* Buffer direction */
    enum iio_buffer_direction dir;
    /* Buffer where data is stored */
    struct no_os_circular_buffer *buf;
    /* Stores cyclic buffer specific information */
    struct iio_cyclic_buffer_info cyclic_info;
};
 
struct iio_device_data {
    void *dev;
    struct iio_buffer *buffer;
};
 
struct iio_trigger {
    bool is_synchronous;
    struct iio_attribute *attributes;
    int (*enable)(void *trig);
    int (*disable)(void *trig);
};
 
struct iio_device {
    struct no_os_irq_ctrl_desc *irq_desc;
    uint16_t num_ch;
    struct iio_channel *channels;
    struct iio_attribute *attributes;
    struct iio_attribute *debug_attributes;
    struct iio_attribute *buffer_attributes;
    /* Numbers of bytes will be:
     * samples * (storage_size_of_first_active_ch / 8) * nb_active_channels
     * DEPRECATED.
     */
    int32_t (*read_dev)(void *dev, void *buff, uint32_t nb_samples);
    /* Numbers of bytes will be:
     * samples * (storage_size_of_first_active_ch / 8) * nb_active_channels
     * DEPRECATED.
     */
    int32_t (*write_dev)(void *dev, void *buff, uint32_t nb_samples);
 
    /* Bufer callbacks */
    int32_t (*pre_enable)(void *dev, uint32_t mask);
    int32_t (*post_disable)(void *dev);
    int32_t (*submit)(struct iio_device_data *dev);
    int32_t (*trigger_handler)(struct iio_device_data *dev);
 
    /* Read device register */
    int32_t (*debug_reg_read)(void *dev, uint32_t reg, uint32_t *readval);
    /* Write device register */
    int32_t (*debug_reg_write)(void *dev, uint32_t reg, uint32_t writeval);
 
};
 
#endif /* IIO_TYPES_H_ */