accel28.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 ACCEL28_H
#define ACCEL28_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 ACCEL28_REG_TEMP_L                              0x0B
#define ACCEL28_REG_TEMP_H                              0x0C
#define ACCEL28_REG_WHO_AM_I                            0x0F
#define ACCEL28_REG_ACT_THS                             0x1E
#define ACCEL28_REG_ACT_DUS                             0x1F
#define ACCEL28_REG_CTRL1                               0x20
#define ACCEL28_REG_CTRL2                               0x21
#define ACCEL28_REG_CTRL3                               0x22
#define ACCEL28_REG_CTRL4                               0x23
#define ACCEL28_REG_CTRL5                               0x24
#define ACCEL28_REG_CTRL6                               0x25
#define ACCEL28_REG_CTRL7                               0x26
#define ACCEL28_REG_STATUS                              0x27
#define ACCEL28_REG_OUT_X_L                             0x28
#define ACCEL28_REG_OUT_X_H                             0x29
#define ACCEL28_REG_OUT_Y_L                             0x2A
#define ACCEL28_REG_OUT_Y_H                             0x2B
#define ACCEL28_REG_OUT_Z_L                             0x2C
#define ACCEL28_REG_OUT_Z_H                             0x2D
#define ACCEL28_REG_FIFO_CTRL                           0x2E
#define ACCEL28_REG_FIFO_SRC                            0x2F
#define ACCEL28_REG_IG_CFG1                             0x30
#define ACCEL28_REG_IG_SRC1                             0x31
#define ACCEL28_REG_IG_THS_X1                           0x32
#define ACCEL28_REG_IG_THS_Y1                           0x33
#define ACCEL28_REG_IG_THS_Z1                           0x34
#define ACCEL28_REG_IG_DUR1                             0x35
#define ACCEL28_REG_IG_CFG2                             0x36
#define ACCEL28_REG_IG_SRC2                             0x37
#define ACCEL28_REG_IG_THS2                             0x38
#define ACCEL28_REG_IG_DUR2                             0x39
#define ACCEL28_REG_XL_REFERENCE                        0x3A
#define ACCEL28_REG_XH_REFERENCE                        0x3B
#define ACCEL28_REG_YL_REFERENCE                        0x3C
#define ACCEL28_REG_YH_REFERENCE                        0x3D
#define ACCEL28_REG_ZL_REFERENCE                        0x3E
#define ACCEL28_REG_ZH_REFERENCE                        0x3F
 
 // accel28_reg
 
#define ACCEL28_WHO_AM_I_VALUE                          0x41
 
#define ACCEL28_CTRL1_X_AXIS_ENABLE                     0x01
#define ACCEL28_CTRL1_Y_AXIS_ENABLE                     0x02
#define ACCEL28_CTRL1_Z_AXIS_ENABLE                     0x04
#define ACCEL28_CTRL1_BLOCK_DATA_UPATE_EN               0x08
#define ACCEL28_CTRL1_ODR_POWER_DOWN                    0x00
#define ACCEL28_CTRL1_ODR_10HZ                          0x10
#define ACCEL28_CTRL1_ODR_50HZ                          0x20
#define ACCEL28_CTRL1_ODR_100HZ                         0x30
#define ACCEL28_CTRL1_ODR_200HZ                         0x40
#define ACCEL28_CTRL1_ODR_400HZ                         0x50
#define ACCEL28_CTRL1_ODR_800HZ                         0x60
#define ACCEL28_CTRL1_ODR_NA                            0x70
#define ACCEL28_CTRL1_HR_MODE                           0x80
 
#define ACCEL28_CTRL2_HP_ENABLE_INT2                    0x01
#define ACCEL28_CTRL2_HP_ENABLE_INT1                    0x02
#define ACCEL28_CTRL2_FDS_ENABLE                        0x04
#define ACCEL28_CTRL2_HPM_NORMAL_MODE                   0x00
#define ACCEL28_CTRL2_HPM_REF_SIGNAL_FILTERING          0x08
#define ACCEL28_CTRL2_HPM_FREQ_DEV_50                   0x00
#define ACCEL28_CTRL2_HPM_FREQ_DEV_100                  0x20
#define ACCEL28_CTRL2_HPM_FREQ_DEV_9                    0x40
#define ACCEL28_CTRL2_HPM_FREQ_DEV_400                  0x60 
 
#define ACCEL28_CTRL3_INT1_DRDY_EN                      0x01 
#define ACCEL28_CTRL3_INT1_FTH                          0x02 
#define ACCEL28_CTRL3_INT1_OVR                          0x04 
#define ACCEL28_CTRL3_INT1_IG1                          0x08 
#define ACCEL28_CTRL3_INT1_IG2                          0x10 
#define ACCEL28_CTRL3_INT1_INACT_EN                     0x20 
#define ACCEL28_CTRL3_STOP_FTH                          0x40 
#define ACCEL28_CTRL3_FIFO_EN                           0x80 
 
#define ACCEL28_CTRL4_SPI_MODE_3_WIRE                   0x01 
#define ACCEL28_CTRL4_SPI_MODE_4_WIRE                   0x00 
#define ACCEL28_CTRL4_I2C_DISABLED                      0x02 
#define ACCEL28_CTRL4_I2C_ENABLED                       0x00 
#define ACCEL28_CTRL4_ADD_INC_ENABLED                   0x04 
#define ACCEL28_CTRL4_BW_SCALE_ODR                      0x00 
#define ACCEL28_CTRL4_BW_SCALE_BW                       0x08 
#define ACCEL28_CTRL4_FS_2G                             0x00 
#define ACCEL28_CTRL4_FS_4G                             0x20 
#define ACCEL28_CTRL4_FS_8G                             0x30 
#define ACCEL28_CTRL4_FS_MASK                           0x30 
#define ACCEL28_CTRL4_BW_400HZ                          0x00 
#define ACCEL28_CTRL4_BW_200HZ                          0x40 
#define ACCEL28_CTRL4_BW_100HZ                          0x80 
#define ACCEL28_CTRL4_BW_50HZ                           0xC0 
 
#define ACCEL28_CTRL5_INT_PUSH_PULL                     0x00 
#define ACCEL28_CTRL5_INT_OPEN_DRAIN                    0x01 
#define ACCEL28_CTRL5_INT_ACTIVE_HIGH                   0x00 
#define ACCEL28_CTRL5_INT_ACTIVE_LOW                    0x02 
#define ACCEL28_CTRL5_NORMAL_MODE                       0x00 
#define ACCEL28_CTRL5_POSITIVE_SELF_TEST                0x04
#define ACCEL28_CTRL5_NEGATIVE_SELF_TEST                0x08
#define ACCEL28_CTRL5_DEC_UDATE_OFF                     0x00
#define ACCEL28_CTRL5_DEC_UDATE_2_SAMPLES               0x10
#define ACCEL28_CTRL5_DEC_UDATE_4_SAMPLES               0x20
#define ACCEL28_CTRL5_DEC_UDATE_8_SAMPLES               0x30
#define ACCEL28_CTRL5_SW_RESET                          0x40
#define ACCEL28_CTRL5_DEBUG_MODE                        0x80
 
#define ACCEL28_CTRL6_INT2_DRDY                         0x01
#define ACCEL28_CTRL6_INT2_FTH                          0x02
#define ACCEL28_CTRL6_INT2_EMPTY                        0x04
#define ACCEL28_CTRL6_INT2_IG1                          0x08
#define ACCEL28_CTRL6_INT2_IG2                          0x10
#define ACCEL28_CTRL6_INT2_BOOT                         0x20
#define ACCEL28_CTRL6_BOOT                              0x80
 
#define ACCEL28_STATUS_X_DATA_AVL                       0x01
#define ACCEL28_STATUS_Y_DATA_AVL                       0x02 
#define ACCEL28_STATUS_Z_DATA_AVL                       0x04 
#define ACCEL28_STATUS_ZYX_DATA_AVL                     0x08 
#define ACCEL28_STATUS_X_DATA_OVERRUN                   0x10
#define ACCEL28_STATUS_Y_DATA_OVERRUN                   0x20 
#define ACCEL28_STATUS_Z_DATA_OVERRUN                   0x40 
#define ACCEL28_STATUS_ZYX_DATA_OVERRUN                 0x80
 
#define ACCEL28_2G_DATA_CONV                            0.061f
#define ACCEL28_4G_DATA_CONV                            0.122f
#define ACCEL28_8G_DATA_CONV                            0.244f
 
#define ACCEL28_PIN_STATE_HIGH                          0x01
#define ACCEL28_PIN_STATE_LOW                           0x00
 
#define ACCEL28_DEVICE_ADDRESS_0                        0x1E
#define ACCEL28_DEVICE_ADDRESS_1                        0x1D
 
#define ACCEL28_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define ACCEL28_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // accel28_set
 
#define ACCEL28_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.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // accel28_map
 // accel28
 
typedef enum
{
    ACCEL28_DRV_SEL_SPI,      
    ACCEL28_DRV_SEL_I2C       
} accel28_drv_t;
 
typedef err_t ( *accel28_master_io_t )( struct accel28_s*, uint8_t, uint8_t*, uint8_t ); 
typedef struct accel28_s
{
    digital_in_t int_pin;           
    i2c_master_t i2c;               
    spi_master_t spi;               
    uint8_t      slave_address;     
    pin_name_t   chip_select;       
    accel28_drv_t drv_sel;          
    accel28_master_io_t write_f;    
    accel28_master_io_t read_f;     
} accel28_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 int_pin;         
    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;  
    accel28_drv_t drv_sel;                
} accel28_cfg_t;
 
typedef struct
{
    float x_data;           
    float y_data;           
    float z_data;           
} accel28_data_t;
 
typedef enum
{
    ACCEL28_OK = 0,
    ACCEL28_ERROR = -1
 
} accel28_return_value_t;
 
void accel28_cfg_setup ( accel28_cfg_t *cfg );
 
void accel28_drv_interface_selection ( accel28_cfg_t *cfg, accel28_drv_t drv_sel );
 
err_t accel28_init ( accel28_t *ctx, accel28_cfg_t *cfg );
 
err_t accel28_default_cfg ( accel28_t *ctx );
 
err_t accel28_generic_write ( accel28_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t accel28_generic_read ( accel28_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
uint8_t accel28_get_int_state ( accel28_t *ctx );
 
err_t accel28_get_raw_data ( accel28_t *ctx, accel28_data_t *data_out );
 
err_t accel28_get_data ( accel28_t *ctx, accel28_data_t *data_out );
 
err_t accel28_write_reg ( accel28_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t accel28_read_reg ( accel28_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t accel28_sw_reset ( accel28_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // ACCEL28_H
 
 // accel28
 
// ------------------------------------------------------------------------ END