accel3.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 ACCEL3_H
#define ACCEL3_H
 
#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"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define ACCEL3_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 ACCEL3_MASTER_I2C                  0
#define ACCEL3_MASTER_SPI                  1
#define ACCEL3_RETVAL  uint8_t
 
#define ACCEL3_OK                          0x00
#define ACCEL3_INIT_ERROR                  0xFF
#define ACCEL3_I2C_ADDRESS                 0x18
#define ACCEL3_REG_WHO_AM_I                0x0F
#define ACCEL3_REG_HP_FILTER_RESET         0x25
#define ACCEL3_REG_REFERENCE               0x26
#define ACCEL3_REG_STATUS                  0x27
#define ACCEL3_CTRL_REG1                   0x20
#define ACCEL3_CTRL_REG2                   0x21
#define ACCEL3_CTRL_REG3                   0x22
#define ACCEL3_CTRL_REG4                   0x23
#define ACCEL3_CTRL_REG5                   0x24
#define ACCEL3_OUT_X_L                     0x28
#define ACCEL3_OUT_X_H                     0x29
#define ACCEL3_OUT_Y_L                     0x2A
#define ACCEL3_OUT_Y_H                     0x2B
#define ACCEL3_OUT_Z_L                     0x2C
#define ACCEL3_OUT_Z_H                     0x2D
#define ACCEL3_ENABLE_AXIS                 0x27
#define ACCEL3_FULL_SCALE                  0x00
#define ACCEL3_DATA_MASK                   0x80
#define ACCEL3_DEVICE_IDENTIFIER           0x32
#define ACCEL3_TRUE                        0x00
#define ACCEL3_FALSE                       0x01
#define ACCEL3_START_VALUE                 0x00
 // End group macro 
 
// --------------------------------------------------------------- PUBLIC TYPES
typedef uint8_t  accel3_select_t;
 
typedef void ( *accel3_master_io_t )( struct accel3_s*, uint8_t, uint8_t*, uint8_t );
 
typedef struct accel3_s
{
    // Output pins 
 
    digital_out_t int_pin;
    digital_out_t cs;
    
    // Modules 
 
    i2c_master_t i2c;
    spi_master_t spi;
 
    // ctx variable 
 
    uint8_t slave_address;
    pin_name_t chip_select;
    accel3_master_io_t  write_f;
    accel3_master_io_t  read_f;
    accel3_select_t master_sel;
 
} accel3_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;
    uint8_t  spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
   accel3_select_t sel;
 
} accel3_cfg_t;
 
 // End types group
 
typedef struct
{
    int16_t x;
    int16_t y;
    int16_t z;
 
} accel3_data_t;
 
 // Measurement data
 
// ------------------------------------------------------------------ CONSTANTS
 // End constants group
 
// ------------------------------------------------------------------ VARIABLES
 // End variable group
 
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
#ifdef __cplusplus
extern "C"{
#endif
 
void accel3_cfg_setup ( accel3_cfg_t *cfg );
 
ACCEL3_RETVAL accel3_init ( accel3_t *ctx, accel3_cfg_t *cfg );
 
void accel3_default_cfg ( accel3_t *ctx, accel3_cfg_t *cfg );
 
void accel3_generic_write ( accel3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void accel3_generic_read ( accel3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
uint8_t accel3_check_id ( accel3_t *ctx );
 
void accel3_read_data ( accel3_t *ctx, accel3_data_t *accel3_data );
 
#ifdef __cplusplus
}
#endif
#endif  // _ACCEL3_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END