git.itanic.dy.fi Git - BME280_driver/blob - bme280_defs.h

   1 /**
   2  * Copyright (C) 2016 - 2017 Bosch Sensortec GmbH
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  * Redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer.
   9  *
  10  * Redistributions in binary form must reproduce the above copyright
  11  * notice, this list of conditions and the following disclaimer in the
  12  * documentation and/or other materials provided with the distribution.
  13  *
  14  * Neither the name of the copyright holder nor the names of the
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  19  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
  20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22  * DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER
  23  * OR CONTRIBUTORS BE LIABLE FOR ANY
  24  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
  25  * OR CONSEQUENTIAL DAMAGES(INCLUDING, BUT NOT LIMITED TO,
  26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  29  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  31  * ANY WAY OUT OF THE USE OF THIS
  32  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
  33  *
  34  * The information provided is believed to be accurate and reliable.
  35  * The copyright holder assumes no responsibility
  36  * for the consequences of use
  37  * of such information nor for any infringement of patents or
  38  * other rights of third parties which may result from its use.
  39  * No license is granted by implication or otherwise under any patent or
  40  * patent rights of the copyright holder.
  41  *
  42  * @file        bme280_defs.h
  43  * @date        14 Feb 2018
  44  * @version     3.3.4
  45  * @brief
  46  *
  47  */
  48
  49 /*! @file bme280_defs.h
  50     @brief Sensor driver for BME280 sensor */
  51 /*!
  52  * @defgroup BME280 SENSOR API
  53  * @brief
  54  * @{*/
  55 #ifndef BME280_DEFS_H_
  56 #define BME280_DEFS_H_
  57
  58 /********************************************************/
  59 /* header includes */
  60 #ifdef __KERNEL__
  61 #include <linux/types.h>
  62 #include <linux/kernel.h>
  63 #else
  64 #include <stdint.h>
  65 #include <stddef.h>
  66 #endif
  67
  68 /********************************************************/
  69 /*! @name               Common macros                   */
  70 /********************************************************/
  71
  72 #if !defined(UINT8_C) && !defined(INT8_C)
  73 #define INT8_C(x)       S8_C(x)
  74 #define UINT8_C(x)      U8_C(x)
  75 #endif
  76
  77 #if !defined(UINT16_C) && !defined(INT16_C)
  78 #define INT16_C(x)      S16_C(x)
  79 #define UINT16_C(x)     U16_C(x)
  80 #endif
  81
  82 #if !defined(INT32_C) && !defined(UINT32_C)
  83 #define INT32_C(x)      S32_C(x)
  84 #define UINT32_C(x)     U32_C(x)
  85 #endif
  86
  87 #if !defined(INT64_C) && !defined(UINT64_C)
  88 #define INT64_C(x)      S64_C(x)
  89 #define UINT64_C(x)     U64_C(x)
  90 #endif
  91
  92 /**@}*/
  93
  94 /**\name C standard macros */
  95 #ifndef NULL
  96 #ifdef __cplusplus
  97 #define NULL   0
  98 #else
  99 #define NULL   ((void *) 0)
 100 #endif
 101 #endif
 102 /********************************************************/
 103
 104 #ifndef BME280_FLOAT_ENABLE
 105 /* #define BME280_FLOAT_ENABLE */
 106 #endif
 107
 108 #ifndef BME280_FLOAT_ENABLE
 109 #ifndef BME280_64BIT_ENABLE
 110 #define BME280_64BIT_ENABLE
 111 #endif
 112 #endif
 113
 114 #ifndef TRUE
 115 #define TRUE                UINT8_C(1)
 116 #endif
 117 #ifndef FALSE
 118 #define FALSE               UINT8_C(0)
 119 #endif
 120
 121 /**\name I2C addresses */
 122 #define BME280_I2C_ADDR_PRIM    UINT8_C(0x76)
 123 #define BME280_I2C_ADDR_SEC             UINT8_C(0x77)
 124
 125 /**\name BME280 chip identifier */
 126 #define BME280_CHIP_ID  UINT8_C(0x60)
 127
 128 /**\name Register Address */
 129 #define BME280_CHIP_ID_ADDR                                     UINT8_C(0xD0)
 130 #define BME280_RESET_ADDR                                       UINT8_C(0xE0)
 131 #define BME280_TEMP_PRESS_CALIB_DATA_ADDR       UINT8_C(0x88)
 132 #define BME280_HUMIDITY_CALIB_DATA_ADDR         UINT8_C(0xE1)
 133 #define BME280_PWR_CTRL_ADDR                            UINT8_C(0xF4)
 134 #define BME280_CTRL_HUM_ADDR                            UINT8_C(0xF2)
 135 #define BME280_CTRL_MEAS_ADDR                           UINT8_C(0xF4)
 136 #define BME280_CONFIG_ADDR                                      UINT8_C(0xF5)
 137 #define BME280_DATA_ADDR                                        UINT8_C(0xF7)
 138
 139 /**\name API success code */
 140 #define BME280_OK                                       INT8_C(0)
 141
 142 /**\name API error codes */
 143 #define BME280_E_NULL_PTR                       INT8_C(-1)
 144 #define BME280_E_DEV_NOT_FOUND          INT8_C(-2)
 145 #define BME280_E_INVALID_LEN            INT8_C(-3)
 146 #define BME280_E_COMM_FAIL                      INT8_C(-4)
 147 #define BME280_E_SLEEP_MODE_FAIL        INT8_C(-5)
 148
 149 /**\name API warning codes */
 150 #define BME280_W_INVALID_OSR_MACRO      INT8_C(1)
 151
 152 /**\name Macros related to size */
 153 #define BME280_TEMP_PRESS_CALIB_DATA_LEN        UINT8_C(26)
 154 #define BME280_HUMIDITY_CALIB_DATA_LEN          UINT8_C(7)
 155 #define BME280_P_T_H_DATA_LEN                           UINT8_C(8)
 156
 157 /**\name Sensor power modes */
 158 #define BME280_SLEEP_MODE               UINT8_C(0x00)
 159 #define BME280_FORCED_MODE              UINT8_C(0x01)
 160 #define BME280_NORMAL_MODE              UINT8_C(0x03)
 161
 162 /**\name Macro to combine two 8 bit data's to form a 16 bit data */
 163 #define BME280_CONCAT_BYTES(msb, lsb)     (((uint16_t)msb << 8) | (uint16_t)lsb)
 164
 165 #define BME280_SET_BITS(reg_data, bitname, data) \
 166                                 ((reg_data & ~(bitname##_MSK)) | \
 167                                 ((data << bitname##_POS) & bitname##_MSK))
 168 #define BME280_SET_BITS_POS_0(reg_data, bitname, data) \
 169                                 ((reg_data & ~(bitname##_MSK)) | \
 170                                 (data & bitname##_MSK))
 171
 172 #define BME280_GET_BITS(reg_data, bitname)  ((reg_data & (bitname##_MSK)) >> \
 173                                                         (bitname##_POS))
 174 #define BME280_GET_BITS_POS_0(reg_data, bitname)  (reg_data & (bitname##_MSK))
 175
 176 /**\name Macros for bit masking */
 177 #define BME280_SENSOR_MODE_MSK  UINT8_C(0x03)
 178 #define BME280_SENSOR_MODE_POS  UINT8_C(0x00)
 179
 180 #define BME280_CTRL_HUM_MSK             UINT8_C(0x07)
 181 #define BME280_CTRL_HUM_POS             UINT8_C(0x00)
 182
 183 #define BME280_CTRL_PRESS_MSK   UINT8_C(0x1C)
 184 #define BME280_CTRL_PRESS_POS   UINT8_C(0x02)
 185
 186 #define BME280_CTRL_TEMP_MSK    UINT8_C(0xE0)
 187 #define BME280_CTRL_TEMP_POS    UINT8_C(0x05)
 188
 189 #define BME280_FILTER_MSK               UINT8_C(0x1C)
 190 #define BME280_FILTER_POS               UINT8_C(0x02)
 191
 192 #define BME280_STANDBY_MSK              UINT8_C(0xE0)
 193 #define BME280_STANDBY_POS              UINT8_C(0x05)
 194
 195 /**\name Sensor component selection macros
 196    These values are internal for API implementation. Don't relate this to
 197    data sheet.*/
 198 #define BME280_PRESS            UINT8_C(1)
 199 #define BME280_TEMP                     UINT8_C(1 << 1)
 200 #define BME280_HUM                      UINT8_C(1 << 2)
 201 #define BME280_ALL                      UINT8_C(0x07)
 202
 203 /**\name Settings selection macros */
 204 #define BME280_OSR_PRESS_SEL            UINT8_C(1)
 205 #define BME280_OSR_TEMP_SEL                     UINT8_C(1 << 1)
 206 #define BME280_OSR_HUM_SEL                      UINT8_C(1 << 2)
 207 #define BME280_FILTER_SEL                       UINT8_C(1 << 3)
 208 #define BME280_STANDBY_SEL                      UINT8_C(1 << 4)
 209 #define BME280_ALL_SETTINGS_SEL         UINT8_C(0x1F)
 210
 211 /**\name Oversampling macros */
 212 #define BME280_NO_OVERSAMPLING          UINT8_C(0x00)
 213 #define BME280_OVERSAMPLING_1X          UINT8_C(0x01)
 214 #define BME280_OVERSAMPLING_2X          UINT8_C(0x02)
 215 #define BME280_OVERSAMPLING_4X          UINT8_C(0x03)
 216 #define BME280_OVERSAMPLING_8X          UINT8_C(0x04)
 217 #define BME280_OVERSAMPLING_16X         UINT8_C(0x05)
 218
 219 /**\name Standby duration selection macros */
 220 #define BME280_STANDBY_TIME_1_MS              (0x00)
 221 #define BME280_STANDBY_TIME_62_5_MS           (0x01)
 222 #define BME280_STANDBY_TIME_125_MS                        (0x02)
 223 #define BME280_STANDBY_TIME_250_MS            (0x03)
 224 #define BME280_STANDBY_TIME_500_MS            (0x04)
 225 #define BME280_STANDBY_TIME_1000_MS           (0x05)
 226 #define BME280_STANDBY_TIME_10_MS             (0x06)
 227 #define BME280_STANDBY_TIME_20_MS             (0x07)
 228
 229 /**\name Filter coefficient selection macros */
 230 #define BME280_FILTER_COEFF_OFF               (0x00)
 231 #define BME280_FILTER_COEFF_2                 (0x01)
 232 #define BME280_FILTER_COEFF_4                 (0x02)
 233 #define BME280_FILTER_COEFF_8                 (0x03)
 234 #define BME280_FILTER_COEFF_16                (0x04)
 235
 236 /*!
 237  * @brief Interface selection Enums
 238  */
 239 enum bme280_intf {
 240         /*! SPI interface */
 241         BME280_SPI_INTF,
 242         /*! I2C interface */
 243         BME280_I2C_INTF
 244 };
 245
 246 /*!
 247  * @brief Type definitions
 248  */
 249 typedef int8_t (*bme280_com_fptr_t)(uint8_t dev_id, uint8_t reg_addr,
 250                 uint8_t *data, uint16_t len);
 251
 252 typedef void (*bme280_delay_fptr_t)(uint32_t period);
 253
 254 /*!
 255  * @brief Calibration data
 256  */
 257 struct bme280_calib_data {
 258  /**
 259  * @ Trim Variables
 260  */
 261 /**@{*/
 262         uint16_t dig_T1;
 263         int16_t dig_T2;
 264         int16_t dig_T3;
 265         uint16_t dig_P1;
 266         int16_t dig_P2;
 267         int16_t dig_P3;
 268         int16_t dig_P4;
 269         int16_t dig_P5;
 270         int16_t dig_P6;
 271         int16_t dig_P7;
 272         int16_t dig_P8;
 273         int16_t dig_P9;
 274         uint8_t  dig_H1;
 275         int16_t dig_H2;
 276         uint8_t  dig_H3;
 277         int16_t dig_H4;
 278         int16_t dig_H5;
 279         int8_t  dig_H6;
 280         int32_t t_fine;
 281 /**@}*/
 282 };
 283
 284 /*!
 285  * @brief bme280 sensor structure which comprises of temperature, pressure and
 286  * humidity data
 287  */
 288 #ifdef BME280_FLOAT_ENABLE
 289 struct bme280_data {
 290         /*! Compensated pressure */
 291         double pressure;
 292         /*! Compensated temperature */
 293         double temperature;
 294         /*! Compensated humidity */
 295         double humidity;
 296 };
 297 #else
 298 struct bme280_data {
 299         /*! Compensated pressure */
 300         uint32_t pressure;
 301         /*! Compensated temperature */
 302         int32_t temperature;
 303         /*! Compensated humidity */
 304         uint32_t humidity;
 305 };
 306 #endif /* BME280_USE_FLOATING_POINT */
 307
 308 /*!
 309  * @brief bme280 sensor structure which comprises of uncompensated temperature,
 310  * pressure and humidity data
 311  */
 312 struct bme280_uncomp_data {
 313         /*! un-compensated pressure */
 314         uint32_t pressure;
 315         /*! un-compensated temperature */
 316         uint32_t temperature;
 317         /*! un-compensated humidity */
 318         uint32_t humidity;
 319 };
 320
 321 /*!
 322  * @brief bme280 sensor settings structure which comprises of mode,
 323  * oversampling and filter settings.
 324  */
 325 struct bme280_settings {
 326         /*! pressure oversampling */
 327         uint8_t osr_p;
 328         /*! temperature oversampling */
 329         uint8_t osr_t;
 330         /*! humidity oversampling */
 331         uint8_t osr_h;
 332         /*! filter coefficient */
 333         uint8_t filter;
 334         /*! standby time */
 335         uint8_t standby_time;
 336 };
 337
 338 /*!
 339  * @brief bme280 device structure
 340  */
 341 struct bme280_dev {
 342         /*! Chip Id */
 343         uint8_t chip_id;
 344         /*! Device Id */
 345         uint8_t dev_id;
 346         /*! SPI/I2C interface */
 347         enum bme280_intf intf;
 348         /*! Read function pointer */
 349         bme280_com_fptr_t read;
 350         /*! Write function pointer */
 351         bme280_com_fptr_t write;
 352         /*! Delay function pointer */
 353         bme280_delay_fptr_t delay_ms;
 354         /*! Trim data */
 355         struct bme280_calib_data calib_data;
 356         /*! Sensor settings */
 357         struct bme280_settings settings;
 358 };
 359
 360 #endif /* BME280_DEFS_H_ */
 361 /** @}*/
 362 /** @}*/