pressure.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 _PRESSURE_H_
#define _PRESSURE_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 PRESSURE_REG_REF_P_XLB      0x8        //  Reference pressure (LSB)
#define PRESSURE_REG_REF_P_LSB      0x9        //  Reference pressure (middle)
#define PRESSURE_REG_REF_P_MSB      0xA        //  Reference pressure (MSB)
#define PRESSURE_REG_DEVICE_ID      0xF        //  Device identification
#define PRESSURE_REG_RES_CFG        0x10       //  Pressure resolution
#define PRESSURE_REG_CTRL_REG1      0x20       //  Control register 1
#define PRESSURE_REG_CTRL_REG2      0x21       //  Control register 2
#define PRESSURE_REG_CTRL_REG3      0x22       //  Control register 3
#define PRESSURE_REG_INT_CFG        0x23       //  Interrupt configuration
#define PRESSURE_REG_INT_SOURCE     0x24       //  Interrupt source
#define PRESSURE_REG_THSH_P_LSB     0x25       //  Threshold pressure (LSB)
#define PRESSURE_REG_THSH_P_MSB     0x26       //  Threshold pressure (MSB)
#define PRESSURE_REG_STATUS         0x27       //  Status register
#define PRESSURE_REG_PRESS_OUT_XLB  0x28       //  Pressure data (LSB)
#define PRESSURE_REG_PRESS_OUT_LSB  0x29       //  Pressure data (middle)
#define PRESSURE_REG_PRESS_OUT_MSB  0x2A       //  Pressure data (MSB)
#define PRESSURE_REG_TEMP_OUT_LSB   0x2B       //  Temperature data (LSB)
#define PRESSURE_REG_TEMP_OUT_MSB   0x2C       //  Temperature data (MSB)
#define PRESSURE_REG_AMP_CTRL       0x30       //  Analog front and control
#define PRESSURE_WHO_AM_I  0xBB
#define PRESSURE_SET_RES_AVG_1    0x0
#define PRESSURE_SET_RES_AVG_2    0x1
#define PRESSURE_SET_RES_AVG_4    0x2
#define PRESSURE_SET_RES_AVG_8    0x3
#define PRESSURE_SET_RES_AVG_16   0x4
#define PRESSURE_SET_RES_AVG_32   0x5
#define PRESSURE_SET_RES_AVG_64   0x6
#define PRESSURE_SET_RES_AVG_128  0x7
#define PRESSURE_SET_RES_AVG_256  0x8
#define PRESSURE_SET_RES_AVG_384  0x9
#define PRESSURE_SET_RES_AVG_512  0xA
#define PRESSURE_SET_PWR_UP_DEV          0x80
#define PRESSURE_SET_PWR_UP_INT          0x8
#define PRESSURE_SET_BLOCK_DATA_UPDATE   0x4
#define PRESSURE_SET_PWR_UP_DELTA_PRESS  0x2
#define PRESSURE_SET_SPI_3_WIRE          0x1
#define PRESSURE_SET_REBOOT_MEM_CONTENT  0x80
#define PRESSURE_SET_SW_RESET            0x4
#define PRESSURE_SET_AUTOZERO_EN         0x2
#define PRESSURE_SET_ONESHOT_EN          0x1
#define PRESSURE_SET_NORMAL_MODE         0x0
#define PRESSURE_SET_INT_ACT_LOW        0x80
#define PRESSURE_SET_INT_OPEN_DRAIN     0x40
#define PRESSURE_SET_INT_GND            0x0
#define PRESSURE_SET_INT_PRESS_HIGH     0x1
#define PRESSURE_SET_INT_PRESS_LOW      0x2
#define PRESSURE_SET_INT_P_LOW_OR_HIGH  0x3
#define PRESSURE_SET_INT_DATA_RDY       0x4
#define PRESSURE_SET_INT_TRI_STATE      0x7
 //  End settings group
 
#define PRESSURE_FLAG_MASK_P_DATA_OR   0x20
#define PRESSURE_FLAG_MASK_T_DATA_OR   0x10
#define PRESSURE_FLAG_MASK_P_DATA_RDY  0x2
#define PRESSURE_FLAG_MASK_T_DATA_RDY  0x1
#define PRESSURE_FLAG_MASK_INT_ACT      0x4
#define PRESSURE_FLAG_MASK_DIFF_P_LOW   0x2
#define PRESSURE_FLAG_MASK_DIFF_P_HIGH  0x1
 //  End status group
 
#define PRESSURE_DATA_NUMBER_MIN  1
#define PRESSURE_DATA_NUMBER_MAX  49
 //  End registers group
 
#define PRESSURE_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.cs      = MIKROBUS( mikrobus, MIKROBUS_CS   ); \
    cfg.sck     = MIKROBUS( mikrobus, MIKROBUS_SCK  ); \
    cfg.sdo     = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.sdi     = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT  ); \
    cfg.scl     = MIKROBUS( mikrobus, MIKROBUS_SCL  ); \
    cfg.sda     = MIKROBUS( mikrobus, MIKROBUS_SDA  )
 //  End macros group
// --------------------------------------------------------------- PUBLIC TYPES
typedef void ( *pressure_master_transfer_t )( struct pressure_s*, uint8_t, uint8_t*, uint8_t );
 
typedef enum
{
    PRESSURE_OK = 0x0,
    PRESSURE_ERR_INIT_DRV = 0xFD,
    PRESSURE_ERR_ADDR,
    PRESSURE_ERR_NDATA
 
} pressure_err_t;
 
typedef enum
{
    PRESSURE_DRV_SEL_I2C = 0,
    PRESSURE_DRV_SEL_SPI
 
} pressure_drv_select_t;
 
typedef enum
{
    PRESSURE_ODR_ONE_SHOT = 0,
    PRESSURE_ODR_P1HZ_T1HZ,
    PRESSURE_ODR_P7HZ_T1HZ,
    PRESSURE_ODR_P12HZ_T1HZ,
    PRESSURE_ODR_P25HZ_T1HZ,
    PRESSURE_ODR_P7HZ_T7HZ,
    PRESSURE_ODR_P12HZ_T12HZ,
    PRESSURE_ODR_P25HZ_T25HZ
 
} pressure_odr_t;
 
typedef enum
{
    PRESSURE_PWR_DOWN = 0,
    PRESSURE_PWR_UP
 
} pressure_pwr_ctrl_t;
 
typedef struct pressure_s
{
    // Output pin 
    digital_out_t cs;
 
    //  Interrupt pin.
    digital_in_t  int_pin;
 
    //  Modules.
    i2c_master_t  i2c;
    spi_master_t  spi;
 
    //  Context variables.
    uint8_t slave_addr;
    pin_name_t chip_select;
    pressure_master_transfer_t  write;
    pressure_master_transfer_t  read;
 
} pressure_t;
 
typedef struct
{
    //  Communication gpio pins.
    pin_name_t  cs;
    pin_name_t  sck;
    pin_name_t  sdo;
    pin_name_t  sdi;
    pin_name_t  scl;
    pin_name_t  sda;
 
    //  Additional gpio pins.
    pin_name_t  int_pin;
 
    //  Configuration variables.
    bool                    i2c_addr;
    uint32_t                i2c_speed;
    uint32_t spi_speed;
    spi_master_mode_t   spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
    pressure_drv_select_t   drv_sel;
 
} pressure_cfg_t;
 
 //  End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
#ifdef __cplusplus
extern "C"{
#endif
 
void
pressure_cfg_setup( pressure_cfg_t *cfg );
 
pressure_err_t
pressure_init( pressure_t *ctx, pressure_cfg_t *cfg );
 
void
pressure_default_cfg( pressure_t *ctx );
 
pressure_err_t
pressure_generic_single_write( pressure_t *ctx, uint8_t reg_addr,
                               uint8_t data_in );
 
pressure_err_t
pressure_generic_multiple_write( pressure_t *ctx, uint8_t reg_addr,
                                 uint8_t *data_in, uint8_t n_data );
 
pressure_err_t
pressure_generic_multiple_read( pressure_t *ctx, uint8_t reg_addr,
                                uint8_t *data_out, uint8_t n_data );
 
uint8_t
pressure_read_id( pressure_t *ctx );
 
void
pressure_set_odr( pressure_t *ctx, pressure_odr_t odr );
 
void
pressure_pwr_ctrl( pressure_t *ctx, pressure_pwr_ctrl_t state );
 
void
pressure_pwr_ctrl_interrupt( pressure_t *ctx, pressure_pwr_ctrl_t state );
 
void
pressure_block_data_update( pressure_t *ctx, pressure_pwr_ctrl_t state );
 
void
pressure_pwr_ctrl_delta_pressure( pressure_t *ctx, pressure_pwr_ctrl_t state );
 
void
pressure_reboot_memory( pressure_t *ctx );
 
void
pressure_sw_reset( pressure_t *ctx );
 
float
pressure_get_pressure( pressure_t *ctx );
 
float
pressure_get_temperature( pressure_t *ctx );
 
uint8_t
pressure_get_status( pressure_t *ctx, uint8_t bit_mask );
 
uint8_t
pressure_get_int_pin( pressure_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  //  _PRESSURE_H_
 
 //  End public_function group
 
// ------------------------------------------------------------------------ END