lis2dh12.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018 Freie Universität Berlin
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef LIS2DH12_H
#define LIS2DH12_H
 
#include <stdint.h>
 
#include "saul.h"
 
#include "periph/gpio.h"
#ifdef MODULE_LIS2DH12_SPI
#include "periph/spi.h"
#else
#include "periph/i2c.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if defined(MODULE_LIS2DH12) || defined(DOXYGEN)
 
#define LIS2DH12_ADDR_DEFAULT       (0x19)
#endif
 
typedef enum {
    LIS2DH12_SCALE_2G  = 0x00,      
    LIS2DH12_SCALE_4G  = 0x10,      
    LIS2DH12_SCALE_8G  = 0x20,      
    LIS2DH12_SCALE_16G = 0x30,      
} lis2dh12_scale_t;
 
typedef enum {
    LIS2DH12_RATE_1HZ   = 0x17,     
    LIS2DH12_RATE_10HZ  = 0x27,     
    LIS2DH12_RATE_25HZ  = 0x37,     
    LIS2DH12_RATE_50HZ  = 0x47,     
    LIS2DH12_RATE_100HZ = 0x57,     
    LIS2DH12_RATE_200HZ = 0x67,     
    LIS2DH12_RATE_400HZ = 0x77,     
} lis2dh12_rate_t;
 
typedef struct {
#if MODULE_LIS2DH12_SPI || DOXYGEN
    spi_t spi;                      
    gpio_t cs;                      
#else
    i2c_t i2c;                      
    uint8_t addr;                   
#endif
#if MODULE_LIS2DH12_INT || DOXYGEN
    gpio_t int1_pin;                
    gpio_t int2_pin;                
#endif
    lis2dh12_scale_t scale;         
    lis2dh12_rate_t rate;           
} lis2dh12_params_t;
 
typedef struct {
    const lis2dh12_params_t *p;     
    uint16_t comp;                  
} lis2dh12_t;
 
enum {
    LIS2DH12_OK    =  0,            
    LIS2DH12_NOBUS = -1,            
    LIS2DH12_NODEV = -2,            
    LIS2DH12_NOINT = -3,            
    LIS2DH12_NODATA= -4,            
};
 
#if MODULE_LIS2DH12_INT || DOXYGEN
/*
 * @brief Interrupt lines
 */
enum{
    LIS2DH12_INT1 = 1,              
    LIS2DH12_INT2 = 2,              
};
 
enum {
    LIS2DH12_INT_CFG_XLIE = 0x01,   
    LIS2DH12_INT_CFG_XHIE = 0x02,   
    LIS2DH12_INT_CFG_YLIE = 0x04,   
    LIS2DH12_INT_CFG_YHIE = 0x08,   
    LIS2DH12_INT_CFG_ZLIE = 0x10,   
    LIS2DH12_INT_CFG_ZHIE = 0x20,   
    LIS2DH12_INT_CFG_6D   = 0x40,   
    LIS2DH12_INT_CFG_AOI  = 0x80,   
};
 
enum {
    /* for interrupt 1 (CTRL_REG3) */
    LIS2DH12_INT_TYPE_I1_OVERRUN = 0x02, 
    LIS2DH12_INT_TYPE_I1_WTM     = 0x04, 
    LIS2DH12_INT_TYPE_I1_ZYXDA   = 0x10, 
    LIS2DH12_INT_TYPE_I1_IA2     = 0x20, 
    LIS2DH12_INT_TYPE_I1_IA1     = 0x40, 
    LIS2DH12_INT_TYPE_I1_CLICK   = 0x80, 
    /* for interrupt 2 (CTRL_REG6) */
    LIS2DH12_INT_TYPE_INT_POLARITY = 0x02, 
    LIS2DH12_INT_TYPE_I2_ACT       = 0x08, 
    LIS2DH12_INT_TYPE_I2_BOOT      = 0x10, 
    LIS2DH12_INT_TYPE_I2_IA2       = 0x20, 
    LIS2DH12_INT_TYPE_I2_IA1       = 0x40, 
    LIS2DH12_INT_TYPE_I2_CLICK     = 0x80, 
};
 
typedef struct {
    uint8_t int_config;             
    uint8_t int_threshold:7;        
    uint8_t int_duration:7;         
    uint8_t int_type;               
    gpio_cb_t cb;                   
    void *arg;                      
} lis2dh12_int_params_t;
 
#define LIS2DH12_INT_SRC_XL     (0x01)  
#define LIS2DH12_INT_SRC_XH     (0x02)  
#define LIS2DH12_INT_SRC_YL     (0x04)  
#define LIS2DH12_INT_SRC_YH     (0x08)  
#define LIS2DH12_INT_SRC_ZL     (0x10)  
#define LIS2DH12_INT_SRC_ZH     (0x20)  
#define LIS2DH12_INT_SRC_IA     (0x40)  
#endif /* MODULE_LIS2DH12_INT */
 
#define LIS2DH12_STATUS_XDA     (0x01)  
#define LIS2DH12_STATUS_YDA     (0x02)  
#define LIS2DH12_STATUS_ZDA     (0x04)  
#define LIS2DH12_STATUS_ZYXDA   (0x08)  
#define LIS2DH12_STATUS_XOR     (0x10)  
#define LIS2DH12_STATUS_YOR     (0x20)  
#define LIS2DH12_STATUS_ZOR     (0x40)  
#define LIS2DH12_STATUS_ZYXOR   (0x80)  
extern const saul_driver_t lis2dh12_saul_driver;
 
#if MODULE_LIS2DH12_INT || DOXYGEN
 
int lis2dh12_set_int(const lis2dh12_t *dev, const lis2dh12_int_params_t *params, uint8_t int_line);
 
int lis2dh12_read_int_src(const lis2dh12_t *dev, uint8_t *data, uint8_t int_line);
#endif /* MODULE_LIS2DH12_INT */
 
int lis2dh12_init(lis2dh12_t *dev, const lis2dh12_params_t *params);
 
int lis2dh12_read(const lis2dh12_t *dev, int16_t *data);
 
int lis2dh12_poweron(const lis2dh12_t *dev);
 
int lis2dh12_poweroff(const lis2dh12_t *dev);
 
#ifdef __cplusplus
}
#endif
 
#endif /* LIS2DH12_H */