lps22hb.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 LPS22HB_H
#define LPS22HB_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 LPS22HB_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 LPS22HB_MASTER_I2C                          0
#define LPS22HB_MASTER_SPI                          1
#define LPS22HB_RETVAL  uint8_t
 
#define LPS22HB_OK                                  0x00
#define LPS22HB_INIT_ERROR                          0xFF
#define LPS22HB_DEV_RES_PRES                        4096.0
#define LPS22HB_DEV_RES_TEMP                        100.0
#define LPS22HB_I2C_ADDRESS_0                       0x5C
#define LPS22HB_I2C_ADDRESS_1                       0x5D
#define LPS22HB_REG_INTERRUPT_CFG                   0x0B
#define LPS22HB_REG_THS_P_L                         0x0C
#define LPS22HB_REG_THS_P_H                         0x0D
#define LPS22HB_REG_WHO_AM_I                        0x0F
 
#define LPS22HB_REG_REF_P_XL                        0x15
#define LPS22HB_REG_REF_P_L                         0x16
#define LPS22HB_REG_REF_P_H                         0x17
#define LPS22HB_REG_RPDS_L                          0x18
#define LPS22HB_REG_RPDS_H                          0x19
#define LPS22HB_REG_RES_CONF                        0x1A
#define LPS22HB_REG_INT_SOURCE                      0x25
#define LPS22HB_REG_FIFO_STATUS                     0x26
#define LPS22HB_REG_STATUS                          0x27
#define LPS22HB_REG_PRESS_OUT_XL                    0x28
#define LPS22HB_REG_PRESS_OUT_L                     0x29
#define LPS22HB_REG_PRESS_OUT_H                     0x2A
#define LPS22HB_REG_TEMP_OUT_L                      0x2B
#define LPS22HB_REG_TEMP_OUT_H                      0x2C
#define LPS22HB_REG_CLOCK_TREE_CONFIGURATION        0x43
#define LPS22HB_RES_CONF_NORMAL_MODE                0x00
#define LPS22HB_RES_CONF_LOW_CURRENT_MODE           0x01
#define LPS22HB_CTRL_REG_R1                         0x10
#define LPS22HB_CTRL_REG_R2                         0x11
#define LPS22HB_CTRL_REG_R3                         0x12
#define LPS22HB_CTRL_REG_FIFO                       0x14
 
#define LPS22HB_CTRL_I2C                            0x10
#define LPS22HB_CTRL_SPI                            0x18
#define LPS22HB_MASK_DATA                           0x80
#define LPS22HB_MASK_DATA_RESET                     0x02
#define LPS22HB_MASK_DATA_ODR                       0x30
 
#define LPS22HB_MASK_REG1_ODR                       0x70
#define LPS22HB_MASK_REG1_LPFP                      0x08
#define LPS22HB_MASK_REG1_LPFP_CUTOFF               0x04
#define LPS22HB_MASK_REG1_BDU                       0x02
#define LPS22HB_MASK_REG1_SIM                       0x01
                                                    
#define LPS22HB_MASK_REG2_FIFO_EN                   0x40
#define LPS22HB_MASK_REG2_WTM_EN                    0x20
#define LPS22HB_MASK_REG2_ADD_INC                   0x10
#define LPS22HB_MASK_REG2_I2C                       0x08
#define LPS22HB_MASK_REG2_ONE_SHOT                  0x01
                                                    
#define LPS22HB_MASK_REG3_INT_H_L                   0x80
#define LPS22HB_MASK_REG3_PP_OD                     0x40
#define LPS22HB_MASK_REG3_FIFO_FULL                 0x20
#define LPS22HB_MASK_REG3_FIFO_FTH                  0x10
#define LPS22HB_MASK_REG3_FIFO_OVR                  0x08
#define LPS22HB_MASK_REG3_DRDY                      0x04
#define LPS22HB_MASK_REG3_INT_S12                   0x03
#define LPS22HB_INT_MASK_CFG_AUTORIFP               0x80
#define LPS22HB_INT_MASK_CFG_RESET_ARP              0x40
#define LPS22HB_INT_MASK_CFG_AUTOZERO               0x20
#define LPS22HB_INT_MASK_CFG_RESET_AZ               0x10
#define LPS22HB_INT_MASK_CFG_DIFF_EN                0x08
#define LPS22HB_INT_MASK_CFG_LIR                    0x04
#define LPS22HB_INT_MASK_CFG_PLE                    0x02
#define LPS22HB_INT_MASK_CFG_PHE                    0x01
         
#define LPS22HB_INT_MASK_SOURCE_BOOT_STATUS         0x80
#define LPS22HB_INT_MASK_SOURCE_IA                  0x04
#define LPS22HB_INT_MASK_SOURCE_PL                  0x02
#define LPS22HB_INT_MASK_SOURCE_PH                  0x01
                  
#define LPS22HB_INT_MASK_SOURCE_TOR                 0x20
#define LPS22HB_INT_MASK_SOURCE_POR                 0x10
#define LPS22HB_INT_MASK_SOURCE_TDA                 0x02
#define LPS22HB_INT_MASK_SOURCE_PDA                 0x01
#define LPS22HB_FIFO_MASK_CTRL_MODE                 0xE0
#define LPS22HB_FIFO_MASK_CTRL_WTM_POINT            0x1F
                    
#define LPS22HB_FIFO_MASK_STATUS_FTH                0x80
#define LPS22HB_FIFO_MASK_STATUS_OVR                0x40
#define LPS22HB_FIFO_MASK_STATUS_LEVEL              0x3F
#define LPS22HB_FIFO_STATUS_EMPTY                   0x00
#define LPS22HB_FIFO_STATUS_FULL                    0x20
 // End group macro
 
// --------------------------------------------------------------- PUBLIC TYPES
typedef uint8_t  lps22hb_select_t;
 
typedef void ( *lps22hb_master_io_t )( struct lps22hb_s*, uint8_t, uint8_t*, uint8_t );
 
typedef struct lps22hb_s
{
    // Output pins 
   
    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;
    lps22hb_master_io_t  write_f;
    lps22hb_master_io_t  read_f;
    lps22hb_select_t master_sel;
 
} lps22hb_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;
 
   lps22hb_select_t sel;
 
} lps22hb_cfg_t;
 
 // End types group
 
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
#ifdef __cplusplus
extern "C"{
#endif
 
void lps22hb_cfg_setup ( lps22hb_cfg_t *cfg );
 
LPS22HB_RETVAL lps22hb_init ( lps22hb_t *ctx, lps22hb_cfg_t *cfg );
 
void lps22hb_default_cfg ( lps22hb_t *ctx, lps22hb_cfg_t *cfg  );
 
void lps22hb_generic_write ( lps22hb_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void lps22hb_generic_read ( lps22hb_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void lps22hb_soft_reset ( lps22hb_t *ctx );
 
void lps22hb_start_configuration ( lps22hb_t *ctx );
 
void lps22hb_update_reg ( lps22hb_t *ctx, uint8_t reg_adr, uint8_t reg_val );
 
float lps22hb_get_pressure ( lps22hb_t *ctx );
 
float lps22hb_get_temp ( lps22hb_t *ctx );
 
void lps22hb_set_fifo_mode ( lps22hb_t *ctx, uint8_t mode_sel, uint8_t wm_lvl );
 
uint8_t lps22hb_check_int ( lps22hb_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _LPS22HB_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END