adxrs290.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef ADXRS290_H_
#define ADXRS290_H_
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
 
#include <stdlib.h>
#include <stdbool.h>
#include "no_os_gpio.h"
#include "no_os_spi.h"
#include "no_os_util.h"
 
/******************************************************************************/
/********************** Macros and Constants Definitions **********************/
/******************************************************************************/
 
/* ADXRS290 ID */
#define ADXRS290_ADI_ID             0xAD
#define ADXRS290_MEMS_ID            0x1D
#define ADXRS290_DEV_ID             0x92
 
/* ADXRS290 Registers */
#define ADXRS290_REG_ADI_ID         0x00
#define ADXRS290_REG_MEMS_ID            0x01
#define ADXRS290_REG_DEV_ID         0x02
#define ADXRS290_REG_REV_ID         0x03
#define ADXRS290_REG_SN0            0x04
#define ADXRS290_REG_SN1            0x05
#define ADXRS290_REG_SN2            0x06
#define ADXRS290_REG_SN3            0x07
#define ADXRS290_REG_DATAX0         0x08
#define ADXRS290_REG_DATAX1         0x09
#define ADXRS290_REG_DATAY0         0x0A
#define ADXRS290_REG_DATAY1         0x0B
#define ADXRS290_REG_TEMP0          0x0C
#define ADXRS290_REG_TEMP1          0x0D
 
#define ADXRS290_REG_POWER_CTL          0x10
#define ADXRS290_REG_FILTER         0x11
#define ADXRS290_REG_DATA_READY         0x12
 
#define ADXRS290_READ               NO_OS_BIT(7)
#define ADXRS290_TSM                NO_OS_BIT(0)
#define ADXRS290_MEASUREMENT            NO_OS_BIT(1)
#define ADXRS290_DATA_RDY_OUT           NO_OS_BIT(0)
#define ADXRS290_SYNC_MASK          0x03
#define ADXRS290_SYNC(x)            (x) & ADXRS290_SYNC_MASK
#define ADXRS290_LPF_MASK           0x07
#define ADXRS290_LPF(x)             (x) & ADXRS290_LPF_MASK
#define ADXRS290_HPF_MASK           0xF0
#define ADXRS290_HPF(x)             ((x) & ADXRS290_HPF_MASK ) >> 4
 
#define ADXRS290_READ_REG(reg)  (ADXRS290_READ | (reg))
 
#define ADXRS290_MAX_TRANSITION_TIME_MS 100
#define ADXRS290_CHANNEL_COUNT          3
#define ADXRS290_CHANNEL_MASK           0x07
/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/
 
enum adxrs290_mode {
    ADXRS290_MODE_STANDBY,
    ADXRS290_MODE_MEASUREMENT,
};
 
enum adxrs290_channel {
    ADXRS290_CHANNEL_X,
    ADXRS290_CHANNEL_Y,
    ADXRS290_CHANNEL_TEMP,
};
 
enum adxrs290_lpf {
    ADXRS290_LPF_480HZ,
    ADXRS290_LPF_320HZ,
    ADXRS290_LPF_160HZ,
    ADXRS290_LPF_80HZ,
    ADXRS290_LPF_56HZ6,
    ADXRS290_LPF_40HZ,
    ADXRS290_LPF_28HZ3,
    ADXRS290_LPF_20HZ
};
 
enum adxrs290_hpf {
    ADXRS290_HPF_ALL_PASS,
    ADXRS290_HPF_0HZ011,
    ADXRS290_HPF_0HZ022,
    ADXRS290_HPF_0HZ044,
    ADXRS290_HPF_0HZ087,
    ADXRS290_HPF_0HZ175,
    ADXRS290_HPF_0HZ350,
    ADXRS290_HPF_0HZ700,
    ADXRS290_HPF_1HZ400,
    ADXRS290_HPF_2HZ800,
    ADXRS290_HPF_11HZ30
};
 
struct adxrs290_init_param {
    struct no_os_spi_init_param spi_init;
    struct no_os_gpio_init_param    *gpio_sync;
    enum adxrs290_mode  mode;
    enum adxrs290_lpf   lpf;
    enum adxrs290_hpf   hpf;
};
 
struct adxrs290_dev {
    struct no_os_spi_desc       *spi_desc;
    struct no_os_gpio_desc  *gpio_sync;
    uint8_t         ch_mask;
};
 
/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/
 
/* Read device register. */
int32_t adxrs290_reg_read(struct adxrs290_dev *dev, uint8_t address,
              uint8_t *data);
 
/* Write device register. */
int32_t adxrs290_reg_write(struct adxrs290_dev *dev, uint8_t address,
               uint8_t data);
 
/* Set mode */
int32_t adxrs290_set_op_mode(struct adxrs290_dev *dev, enum adxrs290_mode mode);
 
/* Get the low-pass filter pole location. */
int32_t adxrs290_get_lpf(struct adxrs290_dev *dev, enum adxrs290_lpf *lpf);
 
/* Set the low-pass filter pole location. */
int32_t adxrs290_set_lpf(struct adxrs290_dev *dev, enum adxrs290_lpf lpf);
 
/* Get the high-pass filter pole location. */
int32_t adxrs290_get_hpf(struct adxrs290_dev *dev, enum adxrs290_hpf *hpf);
 
/* Set the high-pass filter pole location. */
int32_t adxrs290_set_hpf(struct adxrs290_dev *dev, enum adxrs290_hpf hpf);
 
/* Read X or Y angular velocity data */
int32_t adxrs290_get_rate_data(struct adxrs290_dev *dev,
                   enum adxrs290_channel ch, int16_t *rate);
 
/* Read Temperature data */
int32_t adxrs290_get_temp_data(struct adxrs290_dev *dev, int16_t *temp);
 
/* Get the burst data */
int32_t adxrs290_get_burst_data(struct adxrs290_dev *dev, int16_t *burst_data,
                uint8_t *ch_cnt);
 
/* Set the ADXRS290 active channels */
int32_t adxrs290_set_active_channels(struct adxrs290_dev *dev, uint32_t mask);
 
/* Get the data ready state */
int32_t adxrs290_get_data_ready(struct adxrs290_dev *dev, bool *rdy);
 
/* Init. the comm. peripheral and checks if the ADXRS290 part is present. */
int32_t adxrs290_init(struct adxrs290_dev **device,
              const struct adxrs290_init_param *init_param);
 
/* Free the resources allocated by adxrs290_init(). */
int32_t adxrs290_remove(struct adxrs290_dev *dev);
 
 
#endif /* ADXRS290_H_ */