pressure23.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 PRESSURE23_H
#define PRESSURE23_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 PRESSURE23_REG_SERIAL_NUMBER_MSB         0x02
#define PRESSURE23_REG_SERIAL_NUMBER_LSB         0x03
#define PRESSURE23_REG_COEF_C1                   0x04
#define PRESSURE23_REG_COEF_C2                   0x05
#define PRESSURE23_REG_COEF_C3                   0x06
#define PRESSURE23_REG_COEF_C4                   0x07
#define PRESSURE23_REG_COEF_C5                   0x08
#define PRESSURE23_REG_COEF_C6                   0x09
#define PRESSURE23_REG_COEF_C7                   0x0A
#define PRESSURE23_REG_COEF_C8                   0x0B
#define PRESSURE23_REG_COEF_C9                   0x0C
#define PRESSURE23_REG_COEF_C10                  0x0D
#define PRESSURE23_REG_PROM_ID_CRC               0x0F
 
 // pressure23_reg
 
#define PRESSURE23_CMD_RESET                     0x10
#define PRESSURE23_CMD_WRITE_CONFIG_PRESS        0x20
#define PRESSURE23_CMD_WRITE_CONFIG_TEMP         0x22
#define PRESSURE23_CMD_READ_CONFIG_PRESS         0x28
#define PRESSURE23_CMD_READ_CONFIG_TEMP          0x2A
#define PRESSURE23_CMD_READ_MEMORY               0xE0
#define PRESSURE23_CMD_START_CONVERSION          0x40
#define PRESSURE23_CMD_START_CONVERSION_PRESS    0x44
#define PRESSURE23_CMD_START_CONVERSION_TEMP     0x48
#define PRESSURE23_CMD_READ_ADC_REG              0x50
#define PRESSURE23_CMD_READ_ADC_REG_PRESS        0x54
#define PRESSURE23_CMD_READ_ADC_REG_TEMP         0x58
#define PRESSURE23_CMD_WRITE_OPERATION_REG       0x14
#define PRESSURE23_CMD_READ_OPERATION_REG        0x16
#define PRESSURE23_CMD_WRITE_INTERRUPT_MASK      0x18
#define PRESSURE23_CMD_READ_INTERRUPT_MASK       0x1A
#define PRESSURE23_CMD_WRITE_INTERRUPT_REG       0x1C
#define PRESSURE23_CMD_READ_INTERRUPT_REG        0x1E
#define PRESSURE23_CMD_WRITE_LIMIT_REG_TEMP_L    0x30
#define PRESSURE23_CMD_WRITE_LIMIT_REG_TEMP_H    0x32
#define PRESSURE23_CMD_WRITE_LIMIT_REG_PRESS_L   0x34
#define PRESSURE23_CMD_WRITE_LIMIT_REG_PRESS_H   0x36
#define PRESSURE23_CMD_READ_LIMIT_REG_TEMP_L     0x38
#define PRESSURE23_CMD_READ_LIMIT_REG_TEMP_H     0x3A
#define PRESSURE23_CMD_READ_LIMIT_REG_PRESS_L    0x3C
#define PRESSURE23_CMD_READ_LIMIT_REG_PRESS_H    0x3E
 
 // pressure23_cmd
 
#define PRESSURE23_SNSR_CFG_SEL_PRESS           0x00
#define PRESSURE23_SNSR_CFG_SEL_TEMP            0x01
#define PRESSURE23_SNSR_CFG_SEL_BIT_MASK        0x01
#define PRESSURE23_SNSR_CFG_RATIO_OFF           0x00
#define PRESSURE23_SNSR_CFG_RATIO_1             0x01
#define PRESSURE23_SNSR_CFG_RATIO_2             0x02
#define PRESSURE23_SNSR_CFG_RATIO_4             0x03
#define PRESSURE23_SNSR_CFG_RATIO_8             0x04
#define PRESSURE23_SNSR_CFG_RATIO_16            0x05
#define PRESSURE23_SNSR_CFG_RATIO_32            0x06
#define PRESSURE23_SNSR_CFG_RATIO_BIT_MASK      0x07
#define PRESSURE23_SNSR_CFG_FILTER_OFF          0x00
#define PRESSURE23_SNSR_CFG_FILTER_2            0x01
#define PRESSURE23_SNSR_CFG_FILTER_4            0x02
#define PRESSURE23_SNSR_CFG_FILTER_8            0x03
#define PRESSURE23_SNSR_CFG_FILTER_16           0x04
#define PRESSURE23_SNSR_CFG_FILTER_32           0x05
#define PRESSURE23_SNSR_CFG_FILTER_BIT_MASK     0x07
#define PRESSURE23_SNSR_CFG_RES_24_BIT          0x00
#define PRESSURE23_SNSR_CFG_RES_16_BIT          0x01
#define PRESSURE23_SNSR_CFG_RES_8_BIT           0x02
#define PRESSURE23_SNSR_CFG_RES_BIT_MASK        0x03
#define PRESSURE23_SNSR_CFG_OSR_0               0x00
#define PRESSURE23_SNSR_CFG_OSR_1               0x01
#define PRESSURE23_SNSR_CFG_OSR_2               0x02
#define PRESSURE23_SNSR_CFG_OSR_3               0x03
#define PRESSURE23_SNSR_CFG_OSR_4               0x04
#define PRESSURE23_SNSR_CFG_OSR_5               0x05
#define PRESSURE23_SNSR_CFG_OSR_6               0x06
#define PRESSURE23_SNSR_CFG_OSR_BIT_MASK        0x07
 
#define PRESSURE23_CNV_ADC_SEL_PRESS            0x00
#define PRESSURE23_CNV_ADC_SEL_TEMP             0x01
#define PRESSURE23_CNV_ADC_BIT_MASK             0x01
#define PRESSURE23_CNV_ADC_REG_BIT_MASK         0x04
 
#define PRESSURE23_OP_REG_FIFO_INT_TH_OFF       0x00
#define PRESSURE23_OP_REG_FIFO_INT_TH_BIT_MASK  0x1F
#define PRESSURE23_OP_REG_FIFO_MODE_OFF         0x00
#define PRESSURE23_OP_REG_FIFO_MODE_BIT_MASK    0x03
#define PRESSURE23_OP_REG_DELAY_OFF             0x00
#define PRESSURE23_OP_REG_DELAY_5_MS            0x01
#define PRESSURE23_OP_REG_DELAY_10_MS           0x02
#define PRESSURE23_OP_REG_DELAY_20_MS           0x03
#define PRESSURE23_OP_REG_DELAY_50_MS           0x04
#define PRESSURE23_OP_REG_DELAY_100_MS          0x05
#define PRESSURE23_OP_REG_DELAY_200_MS          0x06
#define PRESSURE23_OP_REG_DELAY_500_MS          0x07
#define PRESSURE23_OP_REG_DELAY_1_SEC           0x08
#define PRESSURE23_OP_REG_DELAY_2_SEC           0x09
#define PRESSURE23_OP_REG_DELAY_5_SEC           0x0A
#define PRESSURE23_OP_REG_DELAY_10_SEC          0x0B
#define PRESSURE23_OP_REG_DELAY_20_SEC          0x0C
#define PRESSURE23_OP_REG_DELAY_60_SEC          0x0D
#define PRESSURE23_OP_REG_DELAY_BIT_MASK        0x0F
 
#define PRESSURE23_LIM_REG_SEL_TEMP             0x00
#define PRESSURE23_LIM_REG_SEL_PRESS            0x01
#define PRESSURE23_LIM_REG_SEL_BIT_MASK         0x01
#define PRESSURE23_LIM_REG_LIM_LOW              0x00
#define PRESSURE23_LIM_REG_LIM_HIGH             0x01
#define PRESSURE23_LIM_REG_LIM_BIT_MASK         0x01
 
#define PRESSURE23_COEF_TEMP_D2_DIV             536870912.0f
#define PRESSURE23_COEF_TEMP_D1_DIV             34359738368.0f
#define PRESSURE23_COEF_TEMP_C2_DIV             64.0f
#define PRESSURE23_COEF_OFF_SENS_DIV            512.0f
#define PRESSURE23_COEF_PRESS_DIV               4194304.0f
 
#define PRESSURE23_DEVICE_ADDRESS_GND            0x77
#define PRESSURE23_DEVICE_ADDRESS_VCC            0x76
 
#define PRESSURE23_SET_DATA_SAMPLE_EDGE          SET_SPI_DATA_SAMPLE_EDGE
#define PRESSURE23_SET_DATA_SAMPLE_MIDDLE        SET_SPI_DATA_SAMPLE_MIDDLE
 
 // pressure23_set
 
#define PRESSURE23_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 )
 
 // pressure23_map
 // pressure23
 
typedef enum
{
    PRESSURE23_DRV_SEL_SPI,      
    PRESSURE23_DRV_SEL_I2C       
} pressure23_drv_t;
 
typedef err_t ( *pressure23_master_io_t )( struct pressure23_s*, uint8_t, uint8_t*, uint8_t ); 
typedef struct pressure23_s
{
    digital_in_t int_pin;            
    i2c_master_t i2c;                
    spi_master_t spi;                
    uint8_t      slave_address;      
    pin_name_t   chip_select;        
    pressure23_drv_t drv_sel;        
    // Calibration data (factory calibrated) from PROM   
    uint32_t   prom_serial_num;      
    uint8_t    prom_product_id;      
    uint8_t    prom_crc;             
    uint16_t   prom_c1;              
    uint16_t   prom_c2;              
    uint16_t   prom_c3;              
    uint16_t   prom_c4;              
    uint16_t   prom_c5;              
    uint16_t   prom_c6;              
    uint16_t   prom_c7;              
    uint16_t   prom_c8;              
    uint16_t   prom_c9;              
    uint16_t   prom_c10;             
    uint8_t    osr_press;            
    uint8_t    osr_temp;             
    pressure23_master_io_t write_f;  
    pressure23_master_io_t read_f;   
} pressure23_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;              
    pin_name_t int_pin;         
    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;  
    pressure23_drv_t drv_sel;                       
} pressure23_cfg_t;
 
typedef struct
{
    uint8_t    sel;           
    uint8_t    ratio;         
    uint8_t    filter;        
    uint8_t    resolution;    
    uint8_t    osr;           
} pressure23_sensor_cfg_t;
 
typedef enum
{
    PRESSURE23_OK = 0,
    PRESSURE23_ERROR = -1
 
} pressure23_return_value_t;
 
void pressure23_cfg_setup ( pressure23_cfg_t *cfg );
 
void pressure23_drv_interface_selection ( pressure23_cfg_t *cfg, pressure23_drv_t drv_sel );
 
err_t pressure23_init ( pressure23_t *ctx, pressure23_cfg_t *cfg );
 
err_t pressure23_default_cfg ( pressure23_t *ctx );
 
err_t pressure23_generic_write ( pressure23_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t pressure23_generic_read ( pressure23_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t pressure23_set_command ( pressure23_t *ctx, uint8_t cmd );
 
err_t pressure23_sw_reset ( pressure23_t *ctx );
 
err_t pressure23_read_memory ( pressure23_t *ctx, uint8_t reg, uint16_t *prom );
 
err_t pressure23_start_conversion ( pressure23_t *ctx, uint8_t sel_cnv );
 
err_t pressure23_write_config ( pressure23_t *ctx, pressure23_sensor_cfg_t config );
 
err_t pressure23_read_config ( pressure23_t *ctx, uint8_t sel_cfg, pressure23_sensor_cfg_t *config );
 
err_t pressure23_read_adc ( pressure23_t *ctx, uint8_t sel_data, uint32_t *adc_data );
 
err_t pressure23_write_op_reg ( pressure23_t *ctx, uint8_t fifo_int_th, uint8_t fifo_mode, uint8_t delay );
 
err_t pressure23_read_op_reg ( pressure23_t *ctx, uint8_t *fifo_int_th, uint8_t *fifo_mode, uint8_t *delay );
 
err_t pressure23_write_int_mask ( pressure23_t *ctx, uint16_t int_mask_data );
 
err_t pressure23_read_int_mask ( pressure23_t *ctx, uint16_t *int_mask_data );
 
err_t pressure23_write_int_reg ( pressure23_t *ctx, uint16_t int_reg_data );
 
err_t pressure23_read_int_reg ( pressure23_t *ctx, uint16_t *int_reg_data );
 
err_t pressure23_write_lim_reg ( pressure23_t *ctx, uint8_t sel_adr, uint8_t sel_lim, uint16_t lim_reg_data );
 
err_t pressure23_read_lim_reg ( pressure23_t *ctx, uint8_t sel_adr, uint8_t sel_lim, uint16_t *lim_reg_data );
 
err_t pressure23_get_adc_data_press ( pressure23_t *ctx, uint32_t *pressure );
 
err_t pressure23_get_adc_data_temp ( pressure23_t *ctx, uint32_t *temperature );
 
err_t pressure23_get_calibration_data ( pressure23_t *ctx );
 
err_t pressure23_get_measurement_data ( pressure23_t *ctx, float *pressure, float *temperature );
 
uint8_t pressure23_get_interrupt ( pressure23_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // PRESSURE23_H
 
 // pressure23
 
// ------------------------------------------------------------------------ END