accel19.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef ACCEL19_H
#define ACCEL19_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"
 
#define ACCEL19_REG_OUT_T_L                       0x0D
#define ACCEL19_REG_OUT_T_H                       0x0E
#define ACCEL19_REG_WHO_AM_I                      0x0F
#define ACCEL19_REG_CTRL1                         0x20
#define ACCEL19_REG_CTRL2                         0x21
#define ACCEL19_REG_CTRL3                         0x22
#define ACCEL19_REG_CTRL4_INT1_PAD_CTRL           0x23
#define ACCEL19_REG_CTRL5_INT2_PAD_CTRL           0x24
#define ACCEL19_REG_CTRL6                         0x25
#define ACCEL19_REG_STATUS                        0x27
#define ACCEL19_REG_OUT_X_L                       0x28
#define ACCEL19_REG_OUT_X_H                       0x29
#define ACCEL19_REG_OUT_Y_L                       0x2A
#define ACCEL19_REG_OUT_Y_H                       0x2B
#define ACCEL19_REG_OUT_Z_L                       0x2C
#define ACCEL19_REG_OUT_Z_H                       0x2D    
#define ACCEL19_REG_FIFO_CTRL                     0x2E
#define ACCEL19_REG_FIFO_SAMPLES                  0x2F
#define ACCEL19_REG_TAP_THS_X                     0x30
#define ACCEL19_REG_TAP_THS_Y                     0x31
#define ACCEL19_REG_TAP_THS_Z                     0x32
#define ACCEL19_REG_INT_DUR                       0x33
#define ACCEL19_REG_WAKE_UP_THS                   0x34
#define ACCEL19_REG_WAKE_UP_DUR                   0x35
#define ACCEL19_REG_FREE_FALL                     0x36
#define ACCEL19_REG_STATUS_DUP                    0x37
#define ACCEL19_REG_WAKE_UP_SRC                   0x38
#define ACCEL19_REG_TAP_SRC                       0x39
#define ACCEL19_REG_SIXD_SRC                      0x3A
#define ACCEL19_REG_ALL_INT_SRC                   0x3B
#define ACCEL19_REG_X_OFS_USR                     0x3C
#define ACCEL19_REG_Y_OFS_USR                     0x3D
#define ACCEL19_REG_Z_OFS_USR                     0x3E
#define ACCEL19_REG_CTRL7                         0x3F
 
 // accel19_reg
 
#define ACCEL19_DEVICE_ID                         0x44
 
#define ACCEL19_CTRL1_ODR_BIT_MASK                0xF0
#define ACCEL19_CTRL1_ODR_POWER_DOWN              0x00
#define ACCEL19_CTRL1_ODR_LP_1_6_Hz               0x10
#define ACCEL19_CTRL1_ODR_HP_12_5_Hz              0x10
#define ACCEL19_CTRL1_ODR_HP_LP_12_5_Hz           0x20
#define ACCEL19_CTRL1_ODR_HP_LP_25_Hz             0x30
#define ACCEL19_CTRL1_ODR_HP_LP_50_Hz             0x40
#define ACCEL19_CTRL1_ODR_HP_LP_100_Hz            0x50
#define ACCEL19_CTRL1_ODR_HP_LP_200_Hz            0x60
#define ACCEL19_CTRL1_ODR_LP_200_Hz               0x70
#define ACCEL19_CTRL1_ODR_HP_400_Hz               0x70
#define ACCEL19_CTRL1_ODR_HP_800_Hz               0x80
#define ACCEL19_CTRL1_ODR_HP_1600_Hz              0x90
 
#define ACCEL19_CTRL1_OP_MODE_BIT_MASK            0x0C
#define ACCEL19_CTRL1_OP_MODE_LOW_POWER_MODE      0x00
#define ACCEL19_CTRL1_OP_MODE_HIGH_POWER_MODE     0x04
#define ACCEL19_CTRL1_OP_MODE_SINGLE_DATA_CONV    0x08
 
#define ACCEL19_CTRL1_LP_MODE_BIT_MASK            0x03
#define ACCEL19_CTRL1_LP_MODE1_RES_12_bit         0x00
#define ACCEL19_CTRL1_LP_MODE2_RES_14_bit         0x01
#define ACCEL19_CTRL1_LP_MODE3_RES_14_bit         0x02
#define ACCEL19_CTRL1_LP_MODE4_RES_14_bit         0x03
 
#define ACCEL19_CTRL2_SOFT_RESET                  0x40
 
#define ACCEL19_INT_DRDY                          0x00
#define ACCEL19_STATUS_DRDY                       0x01
 
#define ACCEL19_CTRL6_BW_FILT_BIT_MASK            0xC0
#define ACCEL19_CTRL6_BW_FILT_ODR_2               0x00
#define ACCEL19_CTRL6_BW_FILT_ODR_4               0x40
#define ACCEL19_CTRL6_BW_FILT_ODR_10              0x80
#define ACCEL19_CTRL6_BW_FILT_ODR_20              0xC0
 
#define ACCEL19_CTRL6_FS_BIT_MASK                 0x30
#define ACCEL19_CTRL6_FS_2g                       0x00
#define ACCEL19_CTRL6_FS_4g                       0x10
#define ACCEL19_CTRL6_FS_8g                       0x20
#define ACCEL19_CTRL6_FS_16g                      0x30
 
#define ACCEL19_SET_DEV_ADDR_0                    0x18
#define ACCEL19_SET_DEV_ADDR_1                    0x19
 
#define ACCEL19_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define ACCEL19_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // accel19_set
 
#define ACCEL19_MAP_MIKROBUS( cfg, mikrobus )       \
    cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL );  \
    cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA );  \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK );  \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS );   \
    cfg.in2 = MIKROBUS( mikrobus, MIKROBUS_PWM );   \
    cfg.in1 = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // accel19_map
 // accel19
 
typedef enum
{
    ACCEL19_DRV_SEL_SPI,      
    ACCEL19_DRV_SEL_I2C       
} accel19_drv_t;
 
typedef err_t ( *accel19_master_io_t )( struct accel19_s*, uint8_t, uint8_t*, uint8_t ); 
typedef struct accel19_s
{
    digital_in_t  in2;    
    digital_in_t  in1;    
    i2c_master_t  i2c;    
    spi_master_t  spi;    
    uint8_t     slave_address;       
    pin_name_t  chip_select;         
    accel19_drv_t  drv_sel;          
    accel19_master_io_t  write_f;    
    accel19_master_io_t  read_f;     
} accel19_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  miso;       
    pin_name_t  mosi;       
    pin_name_t  sck;        
    pin_name_t  cs;         
    pin_name_t  in2;        
    pin_name_t  in1;        
    uint32_t  i2c_speed;                                
    uint8_t   i2c_address;                              
    uint32_t                           spi_speed;       
    spi_master_mode_t                  spi_mode;        
    spi_master_chip_select_polarity_t  cs_polarity;     
    accel19_drv_t  drv_sel;                             
} accel19_cfg_t;
 
typedef struct
{
    int16_t x;
    int16_t y;
    int16_t z;
 
} accel19_axis_t;
 
typedef enum
{
    ACCEL19_OK = 0,
    ACCEL19_ERROR = -1
 
} accel19_return_value_t;
 
void accel19_cfg_setup ( accel19_cfg_t *cfg );
 
void accel19_drv_interface_selection ( accel19_cfg_t *cfg, accel19_drv_t drv_sel );
 
err_t accel19_init ( accel19_t *ctx, accel19_cfg_t *cfg );
 
err_t accel19_default_cfg ( accel19_t *ctx );
 
err_t accel19_generic_write ( accel19_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t accel19_generic_read ( accel19_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t accel19_get_temperature ( accel19_t *ctx, float *temperature );
 
err_t accel19_check_device_id ( accel19_t *ctx );
 
err_t accel19_set_control ( accel19_t *ctx, uint8_t odr, uint8_t op_mode, uint8_t lp_mode );
 
err_t accel19_soft_reset ( accel19_t *ctx );
 
err_t accel19_get_status ( accel19_t *ctx, uint8_t *status );
 
uint8_t accel19_data_ready (accel19_t *ctx );
 
err_t accel19_set_full_scale ( accel19_t *ctx, uint8_t full_scale );
 
err_t accel19_set_bw_filt_odr ( accel19_t *ctx, uint8_t bw_filt_odr );
 
err_t accel19_get_axis_data ( accel19_t *ctx, accel19_axis_t *axis );
 
uint8_t accel19_get_int_1 ( accel19_t *ctx );
 
uint8_t accel19_get_int_2 ( accel19_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // ACCEL19_H
 
 // accel19
 
// ------------------------------------------------------------------------ END