bme680_defs.h

Go to the documentation of this file.

#ifndef BME680_DEFS_H_
#define BME680_DEFS_H_

/********************************************************/
/* header includes */
#ifdef __KERNEL__
#include <linux/types.h>
#else
#include <stdint.h>
#endif

#ifdef __KERNEL__
#if (LONG_MAX) > 0x7fffffff
#define __have_long64   1
#elif (LONG_MAX) == 0x7fffffff
#define __have_long32   1
#endif

#if !defined(UINT8_C)
#define INT8_C(x)       x
#if (INT_MAX) > 0x7f
#define UINT8_C(x)      x
#else
#define UINT8_C(x)      x##U
#endif
#endif

#if !defined(UINT16_C)
#define INT16_C(x)      x
#if (INT_MAX) > 0x7fff
#define UINT16_C(x)     x
#else
#define UINT16_C(x)     x##U
#endif
#endif

#if !defined(INT32_C) && !defined(UINT32_C)
#if __have_long32
#define INT32_C(x)      x##L
#define UINT32_C(x)     x##UL
#else
#define INT32_C(x)      x
#define UINT32_C(x)     x##U
#endif
#endif

#if !defined(INT64_C) && !defined(UINT64_C)
#if __have_long64
#define INT64_C(x)      x##L
#define UINT64_C(x)     x##UL
#else
#define INT64_C(x)      x##LL
#define UINT64_C(x)     x##ULL
#endif
#endif
#endif

#ifndef NULL
#ifdef __cplusplus
#define NULL   0
#else
#define NULL   ((void *) 0)
#endif
#endif

#define BME680_POLL_PERIOD_MS       UINT8_C(10)

#define BME680_I2C_ADDR_PRIMARY     UINT8_C(0x76)
#define BME680_I2C_ADDR_SECONDARY   UINT8_C(0x77)

#define BME680_CHIP_ID  UINT8_C(0x61)

#define BME680_COEFF_SIZE       UINT8_C(0x41)
#define BME680_COEFF_ADDR1_LEN      UINT8_C(25)
#define BME680_COEFF_ADDR2_LEN      UINT8_C(16)

#define BME680_FIELD_LENGTH     UINT8_C(15)
#define BME680_FIELD_ADDR_OFFSET    UINT8_C(17)

#define BME680_SOFT_RESET_CMD   UINT8_C(0xb6)

#define BME680_OK       INT8_C(0)
/* Errors */
#define BME680_E_NULL_PTR           INT8_C(-1)
#define BME680_E_COM_FAIL           INT8_C(-2)
#define BME680_E_DEV_NOT_FOUND      INT8_C(-3)
#define BME680_E_INVALID_LENGTH     INT8_C(-4)

/* Warnings */
#define BME680_W_DEFINE_PWR_MODE    INT8_C(1)
#define BME680_W_NO_NEW_DATA        INT8_C(2)

/* Info's */
#define BME680_I_MIN_CORRECTION     UINT8_C(1)
#define BME680_I_MAX_CORRECTION     UINT8_C(2)

#define BME680_ADDR_RES_HEAT_VAL_ADDR   UINT8_C(0x00)
#define BME680_ADDR_RES_HEAT_RANGE_ADDR UINT8_C(0x02)
#define BME680_ADDR_RANGE_SW_ERR_ADDR   UINT8_C(0x04)
#define BME680_ADDR_SENS_CONF_START UINT8_C(0x5A)
#define BME680_ADDR_GAS_CONF_START  UINT8_C(0x64)

#define BME680_FIELD0_ADDR      UINT8_C(0x1d)

#define BME680_RES_HEAT0_ADDR       UINT8_C(0x5a)
#define BME680_GAS_WAIT0_ADDR       UINT8_C(0x64)

#define BME680_CONF_HEAT_CTRL_ADDR      UINT8_C(0x70)
#define BME680_CONF_ODR_RUN_GAS_NBC_ADDR    UINT8_C(0x71)
#define BME680_CONF_OS_H_ADDR           UINT8_C(0x72)
#define BME680_MEM_PAGE_ADDR            UINT8_C(0xf3)
#define BME680_CONF_T_P_MODE_ADDR       UINT8_C(0x74)
#define BME680_CONF_ODR_FILT_ADDR       UINT8_C(0x75)

#define BME680_COEFF_ADDR1  UINT8_C(0x89)
#define BME680_COEFF_ADDR2  UINT8_C(0xe1)

#define BME680_CHIP_ID_ADDR UINT8_C(0xd0)

#define BME680_SOFT_RESET_ADDR      UINT8_C(0xe0)

#define BME680_ENABLE_HEATER        UINT8_C(0x00)
#define BME680_DISABLE_HEATER       UINT8_C(0x08)

#define BME680_DISABLE_GAS_MEAS     UINT8_C(0x00)
#define BME680_ENABLE_GAS_MEAS      UINT8_C(0x01)

#define BME680_OS_NONE      UINT8_C(0)
#define BME680_OS_1X        UINT8_C(1)
#define BME680_OS_2X        UINT8_C(2)
#define BME680_OS_4X        UINT8_C(3)
#define BME680_OS_8X        UINT8_C(4)
#define BME680_OS_16X       UINT8_C(5)

#define BME680_FILTER_SIZE_0    UINT8_C(0)
#define BME680_FILTER_SIZE_1    UINT8_C(1)
#define BME680_FILTER_SIZE_3    UINT8_C(2)
#define BME680_FILTER_SIZE_7    UINT8_C(3)
#define BME680_FILTER_SIZE_15   UINT8_C(4)
#define BME680_FILTER_SIZE_31   UINT8_C(5)
#define BME680_FILTER_SIZE_63   UINT8_C(6)
#define BME680_FILTER_SIZE_127  UINT8_C(7)

#define BME680_SLEEP_MODE   UINT8_C(0)
#define BME680_FORCED_MODE  UINT8_C(1)

#define BME680_RESET_PERIOD     UINT32_C(10)

#define BME680_MEM_PAGE0    UINT8_C(0x10)
#define BME680_MEM_PAGE1    UINT8_C(0x00)

#define BME680_HUM_REG_SHIFT_VAL    UINT8_C(4)

#define BME680_RUN_GAS_DISABLE  UINT8_C(0)
#define BME680_RUN_GAS_ENABLE   UINT8_C(1)

#define BME680_TMP_BUFFER_LENGTH    UINT8_C(40)
#define BME680_REG_BUFFER_LENGTH    UINT8_C(6)
#define BME680_FIELD_DATA_LENGTH    UINT8_C(3)
#define BME680_GAS_REG_BUF_LENGTH   UINT8_C(20)
#define BME680_GAS_HEATER_PROF_LEN_MAX  UINT8_C(10)

#define BME680_OST_SEL          UINT16_C(1)
#define BME680_OSP_SEL          UINT16_C(2)
#define BME680_OSH_SEL          UINT16_C(4)
#define BME680_GAS_MEAS_SEL     UINT16_C(8)
#define BME680_FILTER_SEL       UINT16_C(16)
#define BME680_HCNTRL_SEL       UINT16_C(32)
#define BME680_RUN_GAS_SEL      UINT16_C(64)
#define BME680_NBCONV_SEL       128
#define BME680_GAS_SENSOR_SEL       UINT16_C(BME680_GAS_MEAS_SEL | BME680_RUN_GAS_SEL | BME680_NBCONV_SEL)

#define BME680_NBCONV_MIN       UINT8_C(0)
#define BME680_NBCONV_MAX       UINT8_C(10)

#define BME680_GAS_MEAS_MSK UINT8_C(0x30)
#define BME680_NBCONV_MSK   UINT8_C(0X0F)
#define BME680_FILTER_MSK   UINT8_C(0X1C)
#define BME680_OST_MSK      UINT8_C(0XE0)
#define BME680_OSP_MSK      UINT8_C(0X1C)
#define BME680_OSH_MSK      UINT8_C(0X07)
#define BME680_HCTRL_MSK    UINT8_C(0x08)
#define BME680_RUN_GAS_MSK  UINT8_C(0x10)
#define BME680_MODE_MSK     UINT8_C(0x03)
#define BME680_RHRANGE_MSK  UINT8_C(0x30)
#define BME680_RSERROR_MSK  UINT8_C(0xf0)
#define BME680_NEW_DATA_MSK UINT8_C(0x80)
#define BME680_GAS_INDEX_MSK    UINT8_C(0x0f)
#define BME680_GAS_RANGE_MSK    UINT8_C(0x0f)
#define BME680_GASM_VALID_MSK   UINT8_C(0x20)
#define BME680_HEAT_STAB_MSK    UINT8_C(0x10)
#define BME680_MEM_PAGE_MSK UINT8_C(0x10)
#define BME680_SPI_RD_MSK   UINT8_C(0x80)
#define BME680_SPI_WR_MSK   UINT8_C(0x7f)
#define BME680_BIT_H1_DATA_MSK  UINT8_C(0x0F)

#define BME680_GAS_MEAS_POS UINT8_C(4)
#define BME680_FILTER_POS   UINT8_C(2)
#define BME680_OST_POS      UINT8_C(5)
#define BME680_OSP_POS      UINT8_C(2)
#define BME680_RUN_GAS_POS  UINT8_C(4)

#define BME680_T2_LSB_REG   (1)
#define BME680_T2_MSB_REG   (2)
#define BME680_T3_REG       (3)
#define BME680_P1_LSB_REG   (5)
#define BME680_P1_MSB_REG   (6)
#define BME680_P2_LSB_REG   (7)
#define BME680_P2_MSB_REG   (8)
#define BME680_P3_REG       (9)
#define BME680_P4_LSB_REG   (11)
#define BME680_P4_MSB_REG   (12)
#define BME680_P5_LSB_REG   (13)
#define BME680_P5_MSB_REG   (14)
#define BME680_P7_REG       (15)
#define BME680_P6_REG       (16)
#define BME680_P8_LSB_REG   (19)
#define BME680_P8_MSB_REG   (20)
#define BME680_P9_LSB_REG   (21)
#define BME680_P9_MSB_REG   (22)
#define BME680_P10_REG      (23)
#define BME680_H2_MSB_REG   (25)
#define BME680_H2_LSB_REG   (26)
#define BME680_H1_LSB_REG   (26)
#define BME680_H1_MSB_REG   (27)
#define BME680_H3_REG       (28)
#define BME680_H4_REG       (29)
#define BME680_H5_REG       (30)
#define BME680_H6_REG       (31)
#define BME680_H7_REG       (32)
#define BME680_T1_LSB_REG   (33)
#define BME680_T1_MSB_REG   (34)
#define BME680_GH2_LSB_REG  (35)
#define BME680_GH2_MSB_REG  (36)
#define BME680_GH1_REG      (37)
#define BME680_GH3_REG      (38)

#define BME680_REG_FILTER_INDEX     UINT8_C(5)
#define BME680_REG_TEMP_INDEX       UINT8_C(4)
#define BME680_REG_PRES_INDEX       UINT8_C(4)
#define BME680_REG_HUM_INDEX        UINT8_C(2)
#define BME680_REG_NBCONV_INDEX     UINT8_C(1)
#define BME680_REG_RUN_GAS_INDEX    UINT8_C(1)
#define BME680_REG_HCTRL_INDEX      UINT8_C(0)

#define BME680_CONCAT_BYTES(msb, lsb)   (((uint16_t)msb << 8) | (uint16_t)lsb)

#define BME680_SET_BITS(reg_data, bitname, data) \
        ((reg_data & ~(bitname##_MSK)) | \
        ((data << bitname##_POS) & bitname##_MSK))
#define BME680_GET_BITS(reg_data, bitname)  ((reg_data & (bitname##_MSK)) >> \
    (bitname##_POS))

#define BME680_SET_BITS_POS_0(reg_data, bitname, data) \
                ((reg_data & ~(bitname##_MSK)) | \
                (data & bitname##_MSK))
#define BME680_GET_BITS_POS_0(reg_data, bitname)  (reg_data & (bitname##_MSK))

/*
 * Generic communication function pointer
 * @param[in] dev_id: Place holder to store the id of the device structure
 *                      Can be used to store the index of the Chip select or
 *                      I2C address of the device.
 * @param[in] reg_addr: Used to select the register the where data needs to
 *                      be read from or written to.
 * @param[in/out] reg_data: Data array to read/write
 * @param[in] len: Length of the data array
 */
typedef int8_t (*bme680_com_fptr_t)(uint8_t dev_id, uint8_t reg_addr, uint8_t *data, uint16_t len);

/*
 * Delay function pointer
 * @param[in] period: Time period in milliseconds
 */
typedef void (*bme680_delay_fptr_t)(uint32_t period);

enum bme680_intf {
    BME680_SPI_INTF,
    BME680_I2C_INTF
};

/* structure definitions */
struct  bme680_field_data {
    uint8_t status;
    uint8_t gas_index;
    uint8_t meas_index;
    int16_t temperature;
    uint32_t pressure;
    uint32_t humidity;
    uint32_t gas_resistance;
};

struct  bme680_calib_data {
    uint16_t par_h1;
    uint16_t par_h2;
    int8_t par_h3;
    int8_t par_h4;
    int8_t par_h5;
    uint8_t par_h6;
    int8_t par_h7;
    int8_t par_gh1;
    int16_t par_gh2;
    int8_t par_gh3;
    uint16_t par_t1;
    int16_t par_t2;
    int8_t par_t3;
    uint16_t par_p1;
    int16_t par_p2;
    int8_t par_p3;
    int16_t par_p4;
    int16_t par_p5;
    int8_t par_p6;
    int8_t par_p7;
    int16_t par_p8;
    int16_t par_p9;
    uint8_t par_p10;
    int32_t t_fine;
    uint8_t res_heat_range;
    int8_t res_heat_val;
    int8_t range_sw_err;
};

struct  bme680_tph_sett {
    uint8_t os_hum;
    uint8_t os_temp;
    uint8_t os_pres;
    uint8_t filter;
};

struct  bme680_gas_sett {
    uint8_t nb_conv;
    uint8_t heatr_ctrl;
    uint8_t run_gas;
    uint16_t heatr_temp;
    uint16_t heatr_dur;
};

struct  bme680_dev {
    uint8_t chip_id;
    uint8_t dev_id;
    enum bme680_intf intf;
    uint8_t mem_page;
    int8_t amb_temp;
    struct bme680_calib_data calib;
    struct bme680_tph_sett tph_sett;
    struct bme680_gas_sett gas_sett;
    uint8_t power_mode;
    uint8_t new_fields;
    uint8_t info_msg;
    bme680_com_fptr_t read;
    bme680_com_fptr_t write;
    bme680_delay_fptr_t delay_ms;
    int8_t com_rslt;
};

#endif /* BME680_DEFS_H_ */