barometer8.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 BAROMETER8_H
#define BAROMETER8_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 BAROMETER8_REG_INTERRUPT_CFG            0x0B
#define BAROMETER8_REG_THS_P_L                  0x0C
#define BAROMETER8_REG_THS_P_H                  0x0D
#define BAROMETER8_REG_IF_CTRL                  0x0E
#define BAROMETER8_REG_WHO_AM_I                 0x0F
#define BAROMETER8_REG_CTRL_REG1                0x10
#define BAROMETER8_REG_CTRL_REG2                0x11
#define BAROMETER8_REG_CTRL_REG3                0x12
#define BAROMETER8_REG_FIFO_CTRL                0x14
#define BAROMETER8_REG_FIFO_WTM                 0x15
#define BAROMETER8_REG_REF_P_L                  0x16
#define BAROMETER8_REG_REF_P_H                  0x17
#define BAROMETER8_REG_I3C_IF_CTRL              0x19
#define BAROMETER8_REG_RPDS_L                   0x1A
#define BAROMETER8_REG_RPDS_H                   0x1B
#define BAROMETER8_REG_INT_SOURCE               0x24
#define BAROMETER8_REG_FIFO_STATUS1             0x25
#define BAROMETER8_REG_FIFO_STATUS2             0x26
#define BAROMETER8_REG_STATUS                   0x27
#define BAROMETER8_REG_PRESSURE_OUT_XL          0x28
#define BAROMETER8_REG_PRESSURE_OUT_L           0x29
#define BAROMETER8_REG_PRESSURE_OUT_H           0x2A
#define BAROMETER8_REG_TEMP_OUT_L               0x2B
#define BAROMETER8_REG_TEMP_OUT_H               0x2C
#define BAROMETER8_REG_FIFO_DATA_OUT_PRESS_XL   0x78
#define BAROMETER8_REG_FIFO_DATA_OUT_PRESS_L    0x79
#define BAROMETER8_REG_FIFO_DATA_OUT_PRESS_H    0x7A
 
 // barometer8_reg
 
#define BAROMETER8_DISABLE_I2C_AND_I3C          0x40
#define BAROMETER8_ENABLE_SPI_READ              0x20
#define BAROMETER8_SDA_PULL_UP                  0x10
#define BAROMETER8_CS_PULL_UP_DISC              0x02
 
#define BAROMETER8_WHO_AM_I                     0xB4
 
#define BAROMETER8_ODR_PD_OR_ONE_SHOT           0x00
#define BAROMETER8_ODR_1HZ                      0x08
#define BAROMETER8_ODR_4HZ                      0x10
#define BAROMETER8_ODR_10HZ                     0x18
#define BAROMETER8_ODR_25HZ                     0x20
#define BAROMETER8_ODR_50HZ                     0x28
#define BAROMETER8_ODR_75HZ                     0x30
#define BAROMETER8_ODR_100HZ                    0x38
#define BAROMETER8_ODR_200HZ                    0x40
#define BAROMETER8_ODR_BIT_MASK                 0x78
#define BAROMETER8_AVG_4                        0x00
#define BAROMETER8_AVG_8                        0x01
#define BAROMETER8_AVG_16                       0x02
#define BAROMETER8_AVG_32                       0x03
#define BAROMETER8_AVG_64                       0x04
#define BAROMETER8_AVG_128                      0x05
#define BAROMETER8_AVG_512                      0x07
#define BAROMETER8_AVG_BIT_MASK                 0x07
 
#define BAROMETER8_BOOT_NORMAL                  0x00
#define BAROMETER8_REBOOT_MEMORY                0x80
#define BAROMETER8_FS_MODE_1                    0x00
#define BAROMETER8_FS_MODE_2                    0x40
#define BAROMETER8_LFPF_CFG_ODR_4               0x00
#define BAROMETER8_LFPF_CFG_ODR_9               0x20
#define BAROMETER8_DISABLE_LPFP                 0x00
#define BAROMETER8_ENABLE_LPFP                  0x10
#define BAROMETER8_BDU_CONTINUOUS               0x00
#define BAROMETER8_BDU_MSB_LSB_READ             0x08
#define BAROMETER8_SWRESET                      0x04
#define BAROMETER8_ONESHOT_IDLE                 0x00
#define BAROMETER8_ONESHOT_NEW_DATA             0x01
 
#define BAROMETER8_STATUS_T_OR                  0x20
#define BAROMETER8_STATUS_P_OR                  0x10
#define BAROMETER8_STATUS_T_DA                  0x02
#define BAROMETER8_STATUS_P_DA                  0x01
 
#define BAROMETER8_PRESSURE_FS_MODE_1_RES       4096.0
#define BAROMETER8_PRESSURE_FS_MODE_2_RES       2048.0
#define BAROMETER8_TEMPERATURE_RES              0.01
 
#define BAROMETER8_SET_DEVICE_ADDRESS           0x5C
 
#define BAROMETER8_SET_DATA_SAMPLE_EDGE         SET_SPI_DATA_SAMPLE_EDGE
#define BAROMETER8_SET_DATA_SAMPLE_MIDDLE       SET_SPI_DATA_SAMPLE_MIDDLE
 
 // barometer8_set
 
#define BAROMETER8_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 );
 
 // barometer8_map
 // barometer8
 
typedef enum
{
    BAROMETER8_DRV_SEL_SPI,             
    BAROMETER8_DRV_SEL_I2C              
} barometer8_drv_t;
 
typedef err_t ( *barometer8_master_io_t )( struct barometer8_s*, uint8_t, uint8_t*, uint8_t ); 
typedef struct barometer8_s
{
    i2c_master_t  i2c;                  
    spi_master_t  spi;                  
    uint8_t     slave_address;          
    pin_name_t  chip_select;            
    barometer8_drv_t  drv_sel;          
    barometer8_master_io_t  write_f;    
    barometer8_master_io_t  read_f;     
    uint8_t ctrl_reg2;                  
} barometer8_t;
 
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;                     
    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;     
    barometer8_drv_t  drv_sel;          
} barometer8_cfg_t;
 
typedef enum
{
    BAROMETER8_OK = 0,
    BAROMETER8_ERROR = -1
 
} barometer8_return_value_t;
 
void barometer8_cfg_setup ( barometer8_cfg_t *cfg );
 
void barometer8_drv_interface_selection ( barometer8_cfg_t *cfg, barometer8_drv_t drv_sel );
 
err_t barometer8_init ( barometer8_t *ctx, barometer8_cfg_t *cfg );
 
err_t barometer8_default_cfg ( barometer8_t *ctx );
 
err_t barometer8_generic_write ( barometer8_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t barometer8_generic_read ( barometer8_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t barometer8_write_register ( barometer8_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t barometer8_read_register ( barometer8_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t barometer8_check_communication ( barometer8_t *ctx );
 
err_t barometer8_software_reset ( barometer8_t *ctx );
 
err_t barometer8_read_data ( barometer8_t *ctx, float *pressure, float *temperature );
 
#ifdef __cplusplus
}
#endif
#endif // BAROMETER8_H
 
 // barometer8
 
// ------------------------------------------------------------------------ END