accel4.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 ACCEL4_H
#define ACCEL4_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 ACCEL4_REG_INT_STATUS             0x00
#define ACCEL4_REG_TEMP_OUT               0x01
#define ACCEL4_REG_VECM_LSB               0x02
#define ACCEL4_REG_VECM_MSB               0x03
#define ACCEL4_REG_OUT_X_LSB              0x04
#define ACCEL4_REG_OUT_X_MSB              0x05
#define ACCEL4_REG_OUT_Y_LSB              0x06
#define ACCEL4_REG_OUT_Y_MSB              0x07
#define ACCEL4_REG_OUT_Z_LSB              0x08
#define ACCEL4_REG_OUT_Z_MSB              0x09
#define ACCEL4_REG_BUF_STATUS             0x0B
#define ACCEL4_REG_BUF_X_LSB              0x0C
#define ACCEL4_REG_BUF_X_MSB              0x0D
#define ACCEL4_REG_BUF_Y_LSB              0x0E
#define ACCEL4_REG_BUF_Y_MSB              0x0F
#define ACCEL4_REG_BUF_Z_LSB              0x10
#define ACCEL4_REG_BUF_Z_MSB              0x11
#define ACCEL4_REG_PROD_REV               0x12
#define ACCEL4_REG_WHO_AM_I               0x13
#define ACCEL4_REG_SYS_MODE               0x14
#define ACCEL4_REG_SENS_CONFIG1           0x15
#define ACCEL4_REG_SENS_CONFIG2           0x16
#define ACCEL4_REG_SENS_CONFIG3           0x17
#define ACCEL4_REG_SENS_CONFIG4           0x18
#define ACCEL4_REG_SENS_CONFIG5           0x19
#define ACCEL4_REG_WAKE_IDLE_LSB          0x1A
#define ACCEL4_REG_WAKE_IDLE_MSB          0x1B
#define ACCEL4_REG_SLEEP_IDLE_LSB         0x1C
#define ACCEL4_REG_SLEEP_IDLE_MSB         0x1D
#define ACCEL4_REG_ASLP_COUINT_LSB        0x1E
#define ACCEL4_REG_ASLP_COUINT_MSB        0x1F
#define ACCEL4_REG_INT_EN                 0x20
#define ACCEL4_REG_INT_PIN_SEL            0x21
#define ACCEL4_REG_OFF_X                  0x22
#define ACCEL4_REG_OFF_Y                  0x23
#define ACCEL4_REG_OFF_Z                  0x24
#define ACCEL4_REG_BUF_CONFIG1            0x26
#define ACCEL4_REG_BUF_CONFIG2            0x27
#define ACCEL4_REG_ORIENT_STATUS          0x28
#define ACCEL4_REG_ORIENT_CONFIG          0x29
#define ACCEL4_REG_ORINET_DBCOUNT         0x2A
#define ACCEL4_REG_ORIENT_BF_ZCOMP        0x2B
#define ACCEL4_REG_ORIENT_THS_REG         0x2C
#define ACCEL4_REG_SDCD_INT_SRC1          0x2D
#define ACCEL4_REG_SDCD_INT_SRC2          0x2E
#define ACCEL4_REG_SDCD_CONFIG1           0x2F
#define ACCEL4_REG_SDCD_CONFIG2           0x30
#define ACCEL4_REG_SDCD_OT_DBCNT          0x31
#define ACCEL4_REG_SDCD_WT_DBCNT          0x32
#define ACCEL4_REG_SDCD_LTHS_LSB          0x33
#define ACCEL4_REG_SDCD_LTHS_MSB          0x34
#define ACCEL4_REG_SDCD_UTHS_LSB          0x35
#define ACCEL4_REG_SDCD_UTHS_MSB          0x36
#define ACCEL4_REG_SELF_TEST_CONFIG1      0x37
#define ACCEL4_REG_SELF_TEST_CONFIG2      0x38
 
 // accel4_reg
 
#define ACCEL4_DEVICE_ID                    0x84
 
#define ACCEL4_SET_DEV_ADDR                 0x18
 
#define ACCEL4_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define ACCEL4_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // accel4_set
 
#define ACCEL4_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.int2 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.int1 = MIKROBUS( mikrobus, MIKROBUS_INT )
#define ACCEL4_MAP_MIKROBUS( cfg, mikrobus ) \ …
 
 // accel4_map
 // accel4
 
typedef enum
{
   ACCEL4_DRV_SEL_SPI,      
   ACCEL4_DRV_SEL_I2C       
} accel4_drv_t;
typedef enum {…};
 
typedef err_t ( *accel4_master_io_t )( struct accel4_s*, uint8_t, uint8_t*, uint8_t ); 
typedef struct accel4_s
{
    digital_in_t  int2;             
    digital_in_t  int1;             
    i2c_master_t  i2c;              
    spi_master_t  spi;              
    uint8_t     slave_address;      
    pin_name_t  chip_select;        
    accel4_drv_t  drv_sel;          
    accel4_master_io_t  write_f;    
    accel4_master_io_t  read_f;     
    float resolution;
 
} accel4_t;
typedef struct accel4_s {…};
 
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  int2;       
    pin_name_t  int1;       
    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;     
   accel4_drv_t  drv_sel;   
} accel4_cfg_t;
typedef struct {…};
 
typedef struct
{
   float x; 
   float y; 
   float z; 
} accel4_axes_t;
typedef struct {…};
 
typedef enum
{
   ACCEL4_OK = 0,
   ACCEL4_ERROR = -1
 
} accel4_return_value_t;
typedef enum {…};
 
void accel4_cfg_setup ( accel4_cfg_t *cfg );
 
void accel4_drv_interface_selection ( accel4_cfg_t *cfg, accel4_drv_t drv_sel );
 
err_t accel4_init ( accel4_t *ctx, accel4_cfg_t *cfg );
 
err_t accel4_default_cfg ( accel4_t *ctx );
 
err_t accel4_generic_write ( accel4_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t accel4_generic_read ( accel4_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
uint8_t accel4_get_int1 ( accel4_t *ctx );
 
uint8_t accel4_get_int2 ( accel4_t *ctx );
 
err_t accel4_get_axes_data ( accel4_t *ctx, accel4_axes_t *axes );
 
float accel4_axes_get_resolution ( accel4_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // ACCEL4_H
 
 // accel4
 
// ------------------------------------------------------------------------ END