accel.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 ACCEL_H
#define ACCEL_H
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define ACCEL_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 ); 
#define ACCEL_MASTER_I2C                    0
#define ACCEL_MASTER_SPI                    1
#define ACCEL_OK                            0
#define ACCEL_ERROR                        -1
#define ACCEL_I2C_ADR_VCC                   0x1D
#define ACCEL_I2C_ADR_GND                   0x53
#define ACCEL_REG_DEVID                     0x00
#define ACCEL_REG_THRESH_TAP                0x1D
#define ACCEL_REG_OFSX                      0x1E
#define ACCEL_REG_OFSY                      0x1F
#define ACCEL_REG_OFSZ                      0x20
#define ACCEL_REG_DUR                       0x21
#define ACCEL_REG_LATENT                    0x22
#define ACCEL_REG_WINDOW                    0x23
#define ACCEL_REG_THRESH_ACT                0x24
#define ACCEL_REG_THRESH_INACT              0x25
#define ACCEL_REG_TIME_INACT                0x26
#define ACCEL_REG_ACT_INACT_CTL             0x27
#define ACCEL_REG_THRESH_FF                 0x28
#define ACCEL_REG_TIME_FF                   0x29
#define ACCEL_REG_TAP_AXES                  0x2A
#define ACCEL_REG_ACT_TAP_STATUS            0x2B
#define ACCEL_REG_BW_RATE                   0x2C
#define ACCEL_REG_POWER_CTL                 0x2D
#define ACCEL_REG_INT_ENABLE                0x2E
#define ACCEL_REG_INT_MAP                   0x2F
#define ACCEL_REG_INT_SOURCE                0x30
#define ACCEL_REG_DATA_FORMAT               0x31
#define ACCEL_REG_DATA_X_LSB                0x32
#define ACCEL_REG_DATA_X_MSB                0x33
#define ACCEL_REG_DATA_Y_LSB                0x34
#define ACCEL_REG_DATA_Y_MSB                0x35
#define ACCEL_REG_DATA_Z_LSB                0x36
#define ACCEL_REG_DATA_Z_MSB                0x37
#define ACCEL_REG_FIFO_CTL                  0x38
#define ACCEL_REG_FIFO_STATUS               0x39
#define ACCEL_DEVID                         0xE5
#define ACCEL_POWER_CTL_LINK                0x20
#define ACCEL_POWER_CTL_AUTO_SLEEP          0x10
#define ACCEL_POWER_CTL_MEASURE             0x08
#define ACCEL_POWER_CTL_SLEEP               0x04
#define ACCEL_POWER_CTL_WAKEUP_8            0x03
#define ACCEL_POWER_CTL_WAKEUP_4            0x02
#define ACCEL_POWER_CTL_WAKEUP_2            0x01
#define ACCEL_POWER_CTL_WAKEUP_1            0x00
#define ACCEL_DATA_FORMAT_SELF_TEST         0x80
#define ACCEL_DATA_FORMAT_SPI               0x40
#define ACCEL_DATA_FORMAT_INT_INVERT        0x20
#define ACCEL_DATA_FORMAT_FULL_RES          0x08
#define ACCEL_DATA_FORMAT_JUSTIFY           0x04
#define ACCEL_DATA_FORMAT_RANGE_16          0x03
#define ACCEL_DATA_FORMAT_RANGE_8           0x02
#define ACCEL_DATA_FORMAT_RANGE_4           0x01
#define ACCEL_DATA_FORMAT_RANGE_2           0x00
#define ACCEL_BW_RATE_LOW_POWER             0x10
#define ACCEL_BW_RATE_1600                  0x0F
#define ACCEL_BW_RATE_800                   0x0E
#define ACCEL_BW_RATE_400                   0x0D
#define ACCEL_BW_RATE_200                   0x0C
#define ACCEL_BW_RATE_100                   0x0B
#define ACCEL_BW_RATE_50                    0x0A
#define ACCEL_BW_RATE_25                    0x09
#define ACCEL_BW_RATE_12_5                  0x08
#define ACCEL_BW_RATE_6_25                  0x07
#define ACCEL_BW_RATE_3_13                  0x06
#define ACCEL_BW_RATE_1_56                  0x05
#define ACCEL_BW_RATE_0_78                  0x04
#define ACCEL_BW_RATE_0_39                  0x03
#define ACCEL_BW_RATE_0_2                   0x02
#define ACCEL_BW_RATE_0_1                   0x01
#define ACCEL_BW_RATE_0_05                  0x00
#define ACCEL_FIFO_CTL_FIFO_MODE_BYPASS     0x00
#define ACCEL_FIFO_CTL_FIFO_MODE_ENABLE     0x40
#define ACCEL_FIFO_CTL_FIFO_MODE_STREAM     0x80
#define ACCEL_FIFO_CTL_FIFO_MODE_TRIGGER    0x60
#define ACCEL_FIFO_CTL_TRIGGER_INT2         0x20
#define ACCEL_DATA_RES_LSB_PER_G            256.0f
#define ACCEL_SET_DATA_SAMPLE_EDGE          SET_SPI_DATA_SAMPLE_EDGE
#define ACCEL_SET_DATA_SAMPLE_MIDDLE        SET_SPI_DATA_SAMPLE_MIDDLE
 
 
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef uint8_t  accel_select_t;
 
typedef void ( *accel_master_io_t )( struct accel_s*, uint8_t, uint8_t*, uint8_t );
 
typedef struct accel_s
{
    digital_out_t cs;
 
    // Input pins 
    digital_in_t int_pin;
    
    // Modules 
    i2c_master_t i2c;
    spi_master_t spi;
 
    // ctx variable 
    uint8_t slave_address;
    pin_name_t chip_select;
    accel_master_io_t  write_f;
    accel_master_io_t  read_f;
    accel_select_t master_sel;
 
} accel_t;
 
typedef struct
{
    // Communication gpio pins 
    pin_name_t scl;
    pin_name_t sda;
    pin_name_t miso;
    pin_name_t mosi;
    pin_name_t sck;
    pin_name_t cs;
    
    // Additional gpio pins 
    pin_name_t int_pin;
 
    // static variable 
    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;
 
    accel_select_t sel;
 
} accel_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
#ifdef __cplusplus
extern "C"{
#endif
 
void accel_cfg_setup ( accel_cfg_t *cfg );
 
err_t accel_init ( accel_t *ctx, accel_cfg_t *cfg );
 
void accel_default_cfg ( accel_t *ctx );
 
void accel_generic_write ( accel_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void accel_generic_read ( accel_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
int16_t accel_read_x_axis ( accel_t *ctx );
 
int16_t accel_read_y_axis ( accel_t *ctx );
 
int16_t accel_read_z_axis ( accel_t *ctx );
 
uint8_t accel_check_int_pin ( accel_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _ACCEL_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END