]> git.itanic.dy.fi Git - BME280_driver/blobdiff - bme280_defs.h
Hide excess debug messages by default
[BME280_driver] / bme280_defs.h
index f86db481c21a70aabfa5e3272c6358d9394de5f5..686ba6ab138568eaef19314a4252833d55cdcb1b 100644 (file)
-/**
- * Copyright (C) 2016 - 2017 Bosch Sensortec GmbH
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- *
- * Neither the name of the copyright holder nor the names of the
- * contributors may be used to endorse or promote products derived from
- * this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
- * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
- * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER
- * OR CONTRIBUTORS BE LIABLE FOR ANY
- * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
- * OR CONSEQUENTIAL DAMAGES(INCLUDING, BUT NOT LIMITED TO,
- * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
- * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
- * ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
- *
- * The information provided is believed to be accurate and reliable.
- * The copyright holder assumes no responsibility
- * for the consequences of use
- * of such information nor for any infringement of patents or
- * other rights of third parties which may result from its use.
- * No license is granted by implication or otherwise under any patent or
- * patent rights of the copyright holder.
- *
- * @file       bme280_defs.h
- * @date       21 Mar 2017
- * @version    3.2.0
- * @brief
- *
- */
-
-/*! @file bme280_defs.h
-    @brief Sensor driver for BME280 sensor */
-/*!
- * @defgroup BME280 SENSOR API
- * @brief
- * @{*/
-#ifndef BME280_DEFS_H_
-#define BME280_DEFS_H_
-
-/********************************************************/
-/* header includes */
-#ifdef __KERNEL__
-#include <linux/types.h>
-#else
-#include <stdint.h>
-#include <stdio.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
-/**@}*/
-
-/**\name C standard macros */
-#ifndef NULL
-#ifdef __cplusplus
-#define NULL   0
-#else
-#define NULL   ((void *) 0)
-#endif
-#endif
-
-/* #define FLOATING_POINT_REPRESENTATION */
-#define MACHINE_64_BIT
-
-#ifndef TRUE
-#define TRUE                UINT8_C(1)
-#endif
-#ifndef FALSE
-#define FALSE               UINT8_C(0)
-#endif
-
-/**\name I2C addresses */
-#define BME280_I2C_ADDR_PRIM           UINT8_C(0x76)
-#define BME280_I2C_ADDR_SEC            UINT8_C(0x77)
-
-/**\name BME280 chip identifier */
-#define BME280_CHIP_ID  UINT8_C(0x60)
-
-/**\name Register Address */
-#define BME280_CHIP_ID_ADDR                    UINT8_C(0xD0)
-#define BME280_RESET_ADDR                      UINT8_C(0xE0)
-#define BME280_TEMP_PRESS_CALIB_DATA_ADDR      UINT8_C(0x88)
-#define BME280_HUMIDITY_CALIB_DATA_ADDR                UINT8_C(0xE1)
-#define BME280_PWR_CTRL_ADDR                   UINT8_C(0xF4)
-#define BME280_CTRL_HUM_ADDR                   UINT8_C(0xF2)
-#define BME280_CTRL_MEAS_ADDR                  UINT8_C(0xF4)
-#define BME280_CONFIG_ADDR                     UINT8_C(0xF5)
-#define BME280_DATA_ADDR                       UINT8_C(0xF7)
-
-/**\name API success code */
-#define BME280_OK                              INT8_C(0)
-/**\name API error codes */
-#define BME280_E_NULL_PTR                      INT8_C(-1)
-#define BME280_E_DEV_NOT_FOUND                 INT8_C(-2)
-#define BME280_E_INVALID_LEN                   INT8_C(-3)
-#define BME280_E_COMM_FAIL                     INT8_C(-4)
-#define BME280_E_SLEEP_MODE_FAIL               INT8_C(-5)
-/**\name API warning codes */
-#define BME280_W_INVALID_OSR_MACRO             UINT8_C(1)
-
-/**\name Macros related to size */
-#define BME280_TEMP_PRESS_CALIB_DATA_LEN       UINT8_C(26)
-#define BME280_HUMIDITY_CALIB_DATA_LEN         UINT8_C(7)
-#define BME280_P_T_H_DATA_LEN                  UINT8_C(8)
-
-/**\name Sensor power modes */
-#define        BME280_SLEEP_MODE                       UINT8_C(0x00)
-#define        BME280_FORCED_MODE                      UINT8_C(0x01)
-#define        BME280_NORMAL_MODE                      UINT8_C(0x03)
-
-/**\name Macro to combine two 8 bit data's to form a 16 bit data */
-#define BME280_CONCAT_BYTES(msb, lsb)     (((uint16_t)msb << 8) | (uint16_t)lsb)
-
-#define BME280_SET_BITS(reg_data, bitname, data) \
-                               ((reg_data & ~(bitname##_MSK)) | \
-                               ((data << bitname##_POS) & bitname##_MSK))
-#define BME280_SET_BITS_POS_0(reg_data, bitname, data) \
-                               ((reg_data & ~(bitname##_MSK)) | \
-                               (data & bitname##_MSK))
-
-#define BME280_GET_BITS(reg_data, bitname)  ((reg_data & (bitname##_MSK)) >> \
-                                                       (bitname##_POS))
-#define BME280_GET_BITS_POS_0(reg_data, bitname)  (reg_data & (bitname##_MSK))
-
-/**\name Macros for bit masking */
-#define BME280_SENSOR_MODE_MSK         UINT8_C(0x03)
-#define BME280_SENSOR_MODE_POS         UINT8_C(0x00)
-
-#define BME280_CTRL_HUM_MSK            UINT8_C(0x07)
-#define BME280_CTRL_HUM_POS            UINT8_C(0x00)
-
-#define BME280_CTRL_PRESS_MSK          UINT8_C(0x1C)
-#define BME280_CTRL_PRESS_POS          UINT8_C(0x02)
-
-#define BME280_CTRL_TEMP_MSK           UINT8_C(0xE0)
-#define BME280_CTRL_TEMP_POS           UINT8_C(0x05)
-
-#define BME280_FILTER_MSK              UINT8_C(0x1C)
-#define BME280_FILTER_POS              UINT8_C(0x02)
-
-#define BME280_STANDBY_MSK             UINT8_C(0xE0)
-#define BME280_STANDBY_POS             UINT8_C(0x05)
-
-/**\name Sensor component selection macros
-   These values are internal for API implementation. Don't relate this to
-   data sheet.*/
-#define BME280_PRESS                   UINT8_C(1)
-#define BME280_TEMP                    UINT8_C(1 << 1)
-#define BME280_HUM                     UINT8_C(1 << 2)
-#define BME280_ALL                     UINT8_C(0x07)
-
-/**\name Settings selection macros */
-#define BME280_OSR_PRESS_SEL           UINT8_C(1)
-#define BME280_OSR_TEMP_SEL            UINT8_C(1 << 1)
-#define BME280_OSR_HUM_SEL             UINT8_C(1 << 2)
-#define BME280_FILTER_SEL              UINT8_C(1 << 3)
-#define BME280_STANDBY_SEL             UINT8_C(1 << 4)
-#define BME280_ALL_SETTINGS_SEL        UINT8_C(0x1F)
-
-/**\name Oversampling macros */
-#define BME280_NO_OVERSAMPLING         UINT8_C(0x00)
-#define BME280_OVERSAMPLING_1X         UINT8_C(0x01)
-#define BME280_OVERSAMPLING_2X         UINT8_C(0x02)
-#define BME280_OVERSAMPLING_4X         UINT8_C(0x03)
-#define BME280_OVERSAMPLING_8X         UINT8_C(0x04)
-#define BME280_OVERSAMPLING_16X                UINT8_C(0x05)
-
-/**\name Standby duration selection macros */
-#define BME280_STANDBY_TIME_1_MS              (0x00)
-#define BME280_STANDBY_TIME_62_5_MS             (0x01)
-#define BME280_STANDBY_TIME_125_MS                       (0x02)
-#define BME280_STANDBY_TIME_250_MS            (0x03)
-#define BME280_STANDBY_TIME_500_MS            (0x04)
-#define BME280_STANDBY_TIME_1000_MS           (0x05)
-#define BME280_STANDBY_TIME_10_MS             (0x06)
-#define BME280_STANDBY_TIME_20_MS             (0x07)
-
-/**\name Filter coefficient selection macros */
-#define BME280_FILTER_COEFF_OFF               (0x00)
-#define BME280_FILTER_COEFF_2                 (0x01)
-#define BME280_FILTER_COEFF_4                 (0x02)
-#define BME280_FILTER_COEFF_8                 (0x03)
-#define BME280_FILTER_COEFF_16                (0x04)
-
-/*!
- * @brief Interface selection Enums
- */
-enum bme280_intf {
-       /*! SPI interface */
-       BME280_SPI_INTF,
-       /*! I2C interface */
-       BME280_I2C_INTF
-};
-
-/*!
- * @brief Type definitions
- */
-typedef int8_t (*bme280_com_fptr_t)(uint8_t dev_id, uint8_t reg_addr,
-               uint8_t *data, uint16_t len);
-
-typedef void (*bme280_delay_fptr_t)(uint32_t period);
-
-/*!
- * @brief Calibration data
- */
-struct bme280_calib_data {
- /**
- * @ Trim Variables
- */
-/**@{*/
-       uint16_t dig_T1;
-       int16_t dig_T2;
-       int16_t dig_T3;
-       uint16_t dig_P1;
-       int16_t dig_P2;
-       int16_t dig_P3;
-       int16_t dig_P4;
-       int16_t dig_P5;
-       int16_t dig_P6;
-       int16_t dig_P7;
-       int16_t dig_P8;
-       int16_t dig_P9;
-       uint8_t  dig_H1;
-       int16_t dig_H2;
-       uint8_t  dig_H3;
-       int16_t dig_H4;
-       int16_t dig_H5;
-       int8_t  dig_H6;
-       int32_t t_fine;
-/**@}*/
-};
-
-/*!
- * @brief bme280 sensor structure which comprises of temperature, pressure and
- * humidity data
- */
-#ifdef FLOATING_POINT_REPRESENTATION
-struct bme280_data {
-       /*! Compensated pressure */
-       double pressure;
-       /*! Compensated temperature */
-       double temperature;
-       /*! Compensated humidity */
-       double humidity;
-};
-#else
-struct bme280_data {
-       /*! Compensated pressure */
-       uint32_t pressure;
-       /*! Compensated temperature */
-       int32_t temperature;
-       /*! Compensated humidity */
-       uint32_t humidity;
-};
-#endif /* BME280_USE_FLOATING_POINT */
-
-/*!
- * @brief bme280 sensor structure which comprises of uncompensated temperature,
- * pressure and humidity data
- */
-struct bme280_uncomp_data {
-       /*! un-compensated pressure */
-       uint32_t pressure;
-       /*! un-compensated temperature */
-       uint32_t temperature;
-       /*! un-compensated humidity */
-       uint32_t humidity;
-};
-
-/*!
- * @brief bme280 sensor settings structure which comprises of mode,
- * oversampling and filter settings.
- */
-struct bme280_settings {
-       /*! pressure oversampling */
-       uint8_t osr_p;
-       /*! temperature oversampling */
-       uint8_t osr_t;
-       /*! humidity oversampling */
-       uint8_t osr_h;
-       /*! filter coefficient */
-       uint8_t filter;
-       /*! standby time */
-       uint8_t standby_time;
-};
-
-/*!
- * @brief bme280 device structure
- */
-struct bme280_dev {
-       /*! Chip Id */
-       uint8_t chip_id;
-       /*! Device Id */
-       uint8_t id;
-       /*! SPI/I2C interface */
-       enum bme280_intf interface;
-       /*! Read function pointer */
-       bme280_com_fptr_t read;
-       /*! Write function pointer */
-       bme280_com_fptr_t write;
-       /*! Delay function pointer */
-       bme280_delay_fptr_t delay_ms;
-       /*! Trim data */
-       struct bme280_calib_data calib_data;
-       /*! Sensor settings */
-       struct bme280_settings settings;
-};
-
-#endif /* BME280_DEFS_H_ */
-/** @}*/
-/** @}*/
+/**\r
+* Copyright (c) 2020 Bosch Sensortec GmbH. All rights reserved.\r
+*\r
+* BSD-3-Clause\r
+*\r
+* Redistribution and use in source and binary forms, with or without\r
+* modification, are permitted provided that the following conditions are met:\r
+*\r
+* 1. Redistributions of source code must retain the above copyright\r
+*    notice, this list of conditions and the following disclaimer.\r
+*\r
+* 2. Redistributions in binary form must reproduce the above copyright\r
+*    notice, this list of conditions and the following disclaimer in the\r
+*    documentation and/or other materials provided with the distribution.\r
+*\r
+* 3. Neither the name of the copyright holder nor the names of its\r
+*    contributors may be used to endorse or promote products derived from\r
+*    this software without specific prior written permission.\r
+*\r
+* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\r
+* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\r
+* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS\r
+* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE\r
+* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,\r
+* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\r
+* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\r
+* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
+* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,\r
+* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING\r
+* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\r
+* POSSIBILITY OF SUCH DAMAGE.\r
+*\r
+* @file       bme280_defs.h\r
+* @date       2020-03-28\r
+* @version    v3.5.0\r
+*\r
+*/\r
+\r
+#ifndef BME280_DEFS_H_\r
+#define BME280_DEFS_H_\r
+\r
+/********************************************************/\r
+/* header includes */\r
+#ifdef __KERNEL__\r
+#include <linux/types.h>\r
+#include <linux/kernel.h>\r
+#else\r
+#include <stdint.h>\r
+#include <stddef.h>\r
+#endif\r
+\r
+/********************************************************/\r
+/*! @name       Common macros               */\r
+/********************************************************/\r
+\r
+#if !defined(UINT8_C) && !defined(INT8_C)\r
+#define INT8_C(x)    S8_C(x)\r
+#define UINT8_C(x)   U8_C(x)\r
+#endif\r
+\r
+#if !defined(UINT16_C) && !defined(INT16_C)\r
+#define INT16_C(x)   S16_C(x)\r
+#define UINT16_C(x)  U16_C(x)\r
+#endif\r
+\r
+#if !defined(INT32_C) && !defined(UINT32_C)\r
+#define INT32_C(x)   S32_C(x)\r
+#define UINT32_C(x)  U32_C(x)\r
+#endif\r
+\r
+#if !defined(INT64_C) && !defined(UINT64_C)\r
+#define INT64_C(x)   S64_C(x)\r
+#define UINT64_C(x)  U64_C(x)\r
+#endif\r
+\r
+/**@}*/\r
+/**\name C standard macros */\r
+#ifndef NULL\r
+#ifdef __cplusplus\r
+#define NULL         0\r
+#else\r
+#define NULL         ((void *) 0)\r
+#endif\r
+#endif\r
+\r
+/********************************************************/\r
+\r
+#ifndef BME280_64BIT_ENABLE /*< Check if 64-bit integer (using BME280_64BIT_ENABLE) is enabled */\r
+#ifndef BME280_32BIT_ENABLE /*< Check if 32-bit integer (using BME280_32BIT_ENABLE) is enabled */\r
+#ifndef BME280_FLOAT_ENABLE /*< If any of the integer data types not enabled then enable BME280_FLOAT_ENABLE */\r
+#define BME280_FLOAT_ENABLE\r
+#endif\r
+#endif\r
+#endif\r
+\r
+#ifndef TRUE\r
+#define TRUE                                      UINT8_C(1)\r
+#endif\r
+#ifndef FALSE\r
+#define FALSE                                     UINT8_C(0)\r
+#endif\r
+\r
+/**\r
+ * BME280_INTF_RET_TYPE is the read/write interface return type which can be overwritten by the build system.\r
+ */\r
+#ifndef BME280_INTF_RET_TYPE\r
+#define BME280_INTF_RET_TYPE                      int8_t\r
+#endif\r
+\r
+/**\r
+ * The last error code from read/write interface is stored in the device structure as intf_rslt.\r
+ */\r
+#ifndef BME280_INTF_RET_SUCCESS\r
+#define BME280_INTF_RET_SUCCESS                   INT8_C(0)\r
+#endif\r
+\r
+/**\name I2C addresses */\r
+#define BME280_I2C_ADDR_PRIM                      UINT8_C(0x76)\r
+#define BME280_I2C_ADDR_SEC                       UINT8_C(0x77)\r
+\r
+/**\name BME280 chip identifier */\r
+#define BME280_CHIP_ID                            UINT8_C(0x60)\r
+\r
+/**\name Register Address */\r
+#define BME280_CHIP_ID_ADDR                       UINT8_C(0xD0)\r
+#define BME280_RESET_ADDR                         UINT8_C(0xE0)\r
+#define BME280_TEMP_PRESS_CALIB_DATA_ADDR         UINT8_C(0x88)\r
+#define BME280_HUMIDITY_CALIB_DATA_ADDR           UINT8_C(0xE1)\r
+#define BME280_PWR_CTRL_ADDR                      UINT8_C(0xF4)\r
+#define BME280_CTRL_HUM_ADDR                      UINT8_C(0xF2)\r
+#define BME280_CTRL_MEAS_ADDR                     UINT8_C(0xF4)\r
+#define BME280_CONFIG_ADDR                        UINT8_C(0xF5)\r
+#define BME280_DATA_ADDR                          UINT8_C(0xF7)\r
+\r
+/**\name API success code */\r
+#define BME280_OK                                 INT8_C(0)\r
+\r
+/**\name API error codes */\r
+#define BME280_E_NULL_PTR                         INT8_C(-1)\r
+#define BME280_E_DEV_NOT_FOUND                    INT8_C(-2)\r
+#define BME280_E_INVALID_LEN                      INT8_C(-3)\r
+#define BME280_E_COMM_FAIL                        INT8_C(-4)\r
+#define BME280_E_SLEEP_MODE_FAIL                  INT8_C(-5)\r
+#define BME280_E_NVM_COPY_FAILED                  INT8_C(-6)\r
+\r
+/**\name API warning codes */\r
+#define BME280_W_INVALID_OSR_MACRO                INT8_C(1)\r
+\r
+/**\name Macros related to size */\r
+#define BME280_TEMP_PRESS_CALIB_DATA_LEN          UINT8_C(26)\r
+#define BME280_HUMIDITY_CALIB_DATA_LEN            UINT8_C(7)\r
+#define BME280_P_T_H_DATA_LEN                     UINT8_C(8)\r
+\r
+/**\name Sensor power modes */\r
+#define BME280_SLEEP_MODE                         UINT8_C(0x00)\r
+#define BME280_FORCED_MODE                        UINT8_C(0x01)\r
+#define BME280_NORMAL_MODE                        UINT8_C(0x03)\r
+\r
+/**\name Macro to combine two 8 bit data's to form a 16 bit data */\r
+#define BME280_CONCAT_BYTES(msb, lsb)             (((uint16_t)msb << 8) | (uint16_t)lsb)\r
+\r
+#define BME280_SET_BITS(reg_data, bitname, data) \\r
+    ((reg_data & ~(bitname##_MSK)) | \\r
+     ((data << bitname##_POS) & bitname##_MSK))\r
+#define BME280_SET_BITS_POS_0(reg_data, bitname, data) \\r
+    ((reg_data & ~(bitname##_MSK)) | \\r
+     (data & bitname##_MSK))\r
+\r
+#define BME280_GET_BITS(reg_data, bitname)        ((reg_data & (bitname##_MSK)) >> \\r
+                                                   (bitname##_POS))\r
+#define BME280_GET_BITS_POS_0(reg_data, bitname)  (reg_data & (bitname##_MSK))\r
+\r
+/**\name Macros for bit masking */\r
+#define BME280_SENSOR_MODE_MSK                    UINT8_C(0x03)\r
+#define BME280_SENSOR_MODE_POS                    UINT8_C(0x00)\r
+\r
+#define BME280_CTRL_HUM_MSK                       UINT8_C(0x07)\r
+#define BME280_CTRL_HUM_POS                       UINT8_C(0x00)\r
+\r
+#define BME280_CTRL_PRESS_MSK                     UINT8_C(0x1C)\r
+#define BME280_CTRL_PRESS_POS                     UINT8_C(0x02)\r
+\r
+#define BME280_CTRL_TEMP_MSK                      UINT8_C(0xE0)\r
+#define BME280_CTRL_TEMP_POS                      UINT8_C(0x05)\r
+\r
+#define BME280_FILTER_MSK                         UINT8_C(0x1C)\r
+#define BME280_FILTER_POS                         UINT8_C(0x02)\r
+\r
+#define BME280_STANDBY_MSK                        UINT8_C(0xE0)\r
+#define BME280_STANDBY_POS                        UINT8_C(0x05)\r
+\r
+/**\name Sensor component selection macros\r
+ * These values are internal for API implementation. Don't relate this to\r
+ * data sheet.\r
+ */\r
+#define BME280_PRESS                              UINT8_C(1)\r
+#define BME280_TEMP                               UINT8_C(1 << 1)\r
+#define BME280_HUM                                UINT8_C(1 << 2)\r
+#define BME280_ALL                                UINT8_C(0x07)\r
+\r
+/**\name Settings selection macros */\r
+#define BME280_OSR_PRESS_SEL                      UINT8_C(1)\r
+#define BME280_OSR_TEMP_SEL                       UINT8_C(1 << 1)\r
+#define BME280_OSR_HUM_SEL                        UINT8_C(1 << 2)\r
+#define BME280_FILTER_SEL                         UINT8_C(1 << 3)\r
+#define BME280_STANDBY_SEL                        UINT8_C(1 << 4)\r
+#define BME280_ALL_SETTINGS_SEL                   UINT8_C(0x1F)\r
+\r
+/**\name Oversampling macros */\r
+#define BME280_NO_OVERSAMPLING                    UINT8_C(0x00)\r
+#define BME280_OVERSAMPLING_1X                    UINT8_C(0x01)\r
+#define BME280_OVERSAMPLING_2X                    UINT8_C(0x02)\r
+#define BME280_OVERSAMPLING_4X                    UINT8_C(0x03)\r
+#define BME280_OVERSAMPLING_8X                    UINT8_C(0x04)\r
+#define BME280_OVERSAMPLING_16X                   UINT8_C(0x05)\r
+\r
+/**\name Measurement delay calculation macros  */\r
+#define BME280_MEAS_OFFSET                        UINT16_C(1250)\r
+#define BME280_MEAS_DUR                           UINT16_C(2300)\r
+#define BME280_PRES_HUM_MEAS_OFFSET               UINT16_C(575)\r
+#define BME280_MEAS_SCALING_FACTOR                UINT16_C(1000)\r
+\r
+/**\name Standby duration selection macros */\r
+#define BME280_STANDBY_TIME_0_5_MS                (0x00)\r
+#define BME280_STANDBY_TIME_62_5_MS               (0x01)\r
+#define BME280_STANDBY_TIME_125_MS                (0x02)\r
+#define BME280_STANDBY_TIME_250_MS                (0x03)\r
+#define BME280_STANDBY_TIME_500_MS                (0x04)\r
+#define BME280_STANDBY_TIME_1000_MS               (0x05)\r
+#define BME280_STANDBY_TIME_10_MS                 (0x06)\r
+#define BME280_STANDBY_TIME_20_MS                 (0x07)\r
+\r
+/**\name Filter coefficient selection macros */\r
+#define BME280_FILTER_COEFF_OFF                   (0x00)\r
+#define BME280_FILTER_COEFF_2                     (0x01)\r
+#define BME280_FILTER_COEFF_4                     (0x02)\r
+#define BME280_FILTER_COEFF_8                     (0x03)\r
+#define BME280_FILTER_COEFF_16                    (0x04)\r
+\r
+#define BME280_STATUS_REG_ADDR                    (0xF3)\r
+#define BME280_SOFT_RESET_COMMAND                 (0xB6)\r
+#define BME280_STATUS_IM_UPDATE                   (0x01)\r
+\r
+/*!\r
+ * @brief Interface selection Enums\r
+ */\r
+enum bme280_intf {\r
+    /*< SPI interface */\r
+    BME280_SPI_INTF,\r
+    /*< I2C interface */\r
+    BME280_I2C_INTF\r
+};\r
+\r
+/*!\r
+ * @brief Type definitions\r
+ */\r
+\r
+/*!\r
+ * @brief Bus communication function pointer which should be mapped to\r
+ * the platform specific read functions of the user\r
+ *\r
+ * @param[in] reg_addr       : Register address from which data is read.\r
+ * @param[out] reg_data     : Pointer to data buffer where read data is stored.\r
+ * @param[in] len            : Number of bytes of data to be read.\r
+ * @param[in, out] intf_ptr  : Void pointer that can enable the linking of descriptors\r
+ *                                  for interface related call backs.\r
+ *\r
+ * @retval   0 -> Success.\r
+ * @retval Non zero value -> Fail.\r
+ *\r
+ */\r
+typedef BME280_INTF_RET_TYPE (*bme280_read_fptr_t)(uint8_t reg_addr, uint8_t *reg_data, uint32_t len, void *intf_ptr);\r
+\r
+/*!\r
+ * @brief Bus communication function pointer which should be mapped to\r
+ * the platform specific write functions of the user\r
+ *\r
+ * @param[in] reg_addr      : Register address to which the data is written.\r
+ * @param[in] reg_data     : Pointer to data buffer in which data to be written\r
+ *                            is stored.\r
+ * @param[in] len           : Number of bytes of data to be written.\r
+ * @param[in, out] intf_ptr : Void pointer that can enable the linking of descriptors\r
+ *                            for interface related call backs\r
+ *\r
+ * @retval   0   -> Success.\r
+ * @retval Non zero value -> Fail.\r
+ *\r
+ */\r
+typedef BME280_INTF_RET_TYPE (*bme280_write_fptr_t)(uint8_t reg_addr, const uint8_t *reg_data, uint32_t len,\r
+                                                    void *intf_ptr);\r
+\r
+/*!\r
+ * @brief Delay function pointer which should be mapped to\r
+ * delay function of the user\r
+ *\r
+ * @param[in] period              : Delay in microseconds.\r
+ * @param[in, out] intf_ptr       : Void pointer that can enable the linking of descriptors\r
+ *                                  for interface related call backs\r
+ *\r
+ */\r
+typedef void (*bme280_delay_us_fptr_t)(uint32_t period, void *intf_ptr);\r
+\r
+/*!\r
+ * @brief Calibration data\r
+ */\r
+struct bme280_calib_data\r
+{\r
+    /*< Calibration coefficient for the temperature sensor */\r
+    uint16_t dig_t1;\r
+\r
+    /*< Calibration coefficient for the temperature sensor */\r
+    int16_t dig_t2;\r
+\r
+    /*< Calibration coefficient for the temperature sensor */\r
+    int16_t dig_t3;\r
+\r
+    /*< Calibration coefficient for the pressure sensor */\r
+    uint16_t dig_p1;\r
+\r
+    /*< Calibration coefficient for the pressure sensor */\r
+    int16_t dig_p2;\r
+\r
+    /*< Calibration coefficient for the pressure sensor */\r
+    int16_t dig_p3;\r
+\r
+    /*< Calibration coefficient for the pressure sensor */\r
+    int16_t dig_p4;\r
+\r
+    /*< Calibration coefficient for the pressure sensor */\r
+    int16_t dig_p5;\r
+\r
+    /*< Calibration coefficient for the pressure sensor */\r
+    int16_t dig_p6;\r
+\r
+    /*< Calibration coefficient for the pressure sensor */\r
+    int16_t dig_p7;\r
+\r
+    /*< Calibration coefficient for the pressure sensor */\r
+    int16_t dig_p8;\r
+\r
+    /*< Calibration coefficient for the pressure sensor */\r
+    int16_t dig_p9;\r
+\r
+    /*< Calibration coefficient for the humidity sensor */\r
+    uint8_t dig_h1;\r
+\r
+    /*< Calibration coefficient for the humidity sensor */\r
+    int16_t dig_h2;\r
+\r
+    /*< Calibration coefficient for the humidity sensor */\r
+    uint8_t dig_h3;\r
+\r
+    /*< Calibration coefficient for the humidity sensor */\r
+    int16_t dig_h4;\r
+\r
+    /*< Calibration coefficient for the humidity sensor */\r
+    int16_t dig_h5;\r
+\r
+    /*< Calibration coefficient for the humidity sensor */\r
+    int8_t dig_h6;\r
+\r
+    /*< Variable to store the intermediate temperature coefficient */\r
+    int32_t t_fine;\r
+};\r
+\r
+/*!\r
+ * @brief bme280 sensor structure which comprises of temperature, pressure and\r
+ * humidity data\r
+ */\r
+#ifdef BME280_FLOAT_ENABLE\r
+struct bme280_data\r
+{\r
+    /*< Compensated pressure */\r
+    double pressure;\r
+\r
+    /*< Compensated temperature */\r
+    double temperature;\r
+\r
+    /*< Compensated humidity */\r
+    double humidity;\r
+};\r
+#else\r
+struct bme280_data\r
+{\r
+    /*< Compensated pressure */\r
+    uint32_t pressure;\r
+\r
+    /*< Compensated temperature */\r
+    int32_t temperature;\r
+\r
+    /*< Compensated humidity */\r
+    uint32_t humidity;\r
+};\r
+#endif /*! BME280_USE_FLOATING_POINT */\r
+\r
+/*!\r
+ * @brief bme280 sensor structure which comprises of uncompensated temperature,\r
+ * pressure and humidity data\r
+ */\r
+struct bme280_uncomp_data\r
+{\r
+    /*< un-compensated pressure */\r
+    uint32_t pressure;\r
+\r
+    /*< un-compensated temperature */\r
+    uint32_t temperature;\r
+\r
+    /*< un-compensated humidity */\r
+    uint32_t humidity;\r
+};\r
+\r
+/*!\r
+ * @brief bme280 sensor settings structure which comprises of mode,\r
+ * oversampling and filter settings.\r
+ */\r
+struct bme280_settings\r
+{\r
+    /*< pressure oversampling */\r
+    uint8_t osr_p;\r
+\r
+    /*< temperature oversampling */\r
+    uint8_t osr_t;\r
+\r
+    /*< humidity oversampling */\r
+    uint8_t osr_h;\r
+\r
+    /*< filter coefficient */\r
+    uint8_t filter;\r
+\r
+    /*< standby time */\r
+    uint8_t standby_time;\r
+};\r
+\r
+/*!\r
+ * @brief bme280 device structure\r
+ */\r
+struct bme280_dev\r
+{\r
+    /*< Chip Id */\r
+    uint8_t chip_id;\r
+\r
+    /*< Interface function pointer used to enable the device address for I2C and chip selection for SPI */\r
+    void *intf_ptr;\r
+\r
+    /*< Interface Selection\r
+     * For SPI, intf = BME280_SPI_INTF\r
+     * For I2C, intf = BME280_I2C_INTF\r
+     * */\r
+    enum bme280_intf intf;\r
+\r
+    /*< Read function pointer */\r
+    bme280_read_fptr_t read;\r
+\r
+    /*< Write function pointer */\r
+    bme280_write_fptr_t write;\r
+\r
+    /*< Delay function pointer */\r
+    bme280_delay_us_fptr_t delay_us;\r
+\r
+    /*< Trim data */\r
+    struct bme280_calib_data calib_data;\r
+\r
+    /*< Sensor settings */\r
+    struct bme280_settings settings;\r
+\r
+    /*< Variable to store result of read/write function */\r
+    BME280_INTF_RET_TYPE intf_rslt;\r
+};\r
+\r
+#endif /* BME280_DEFS_H_ */\r