]> git.itanic.dy.fi Git - BME280_driver/blob - bme280_defs.h
- Changed macro FLOATING_POINT_REPRESENTATION to BME280_FLOAT_ENABLE
[BME280_driver] / 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        13 Jul 2017
44  * @version     3.3.0
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 #else
63 #include <stdint.h>
64 #include <stdio.h>
65 #endif
66
67 #ifdef __KERNEL__
68 #if (LONG_MAX) > 0x7fffffff
69 #define __have_long64   1
70 #elif (LONG_MAX) == 0x7fffffff
71 #define __have_long32   1
72 #endif
73
74 #if !defined(UINT8_C)
75 #define INT8_C(x)       x
76 #if (INT_MAX) > 0x7f
77 #define UINT8_C(x)      x
78 #else
79 #define UINT8_C(x)      x##U
80 #endif
81 #endif
82
83 #if !defined(UINT16_C)
84 #define INT16_C(x)      x
85 #if (INT_MAX) > 0x7fff
86 #define UINT16_C(x)     x
87 #else
88 #define UINT16_C(x)     x##U
89 #endif
90 #endif
91
92 #if !defined(INT32_C) && !defined(UINT32_C)
93 #if __have_long32
94 #define INT32_C(x)      x##L
95 #define UINT32_C(x)     x##UL
96 #else
97 #define INT32_C(x)      x
98 #define UINT32_C(x)     x##U
99 #endif
100 #endif
101
102 #if !defined(INT64_C) && !defined(UINT64_C)
103 #if __have_long64
104 #define INT64_C(x)      x##L
105 #define UINT64_C(x)     x##UL
106 #else
107 #define INT64_C(x)      x##LL
108 #define UINT64_C(x)     x##ULL
109 #endif
110 #endif
111 #endif
112 /**@}*/
113
114 /**\name C standard macros */
115 #ifndef NULL
116 #ifdef __cplusplus
117 #define NULL   0
118 #else
119 #define NULL   ((void *) 0)
120 #endif
121 #endif
122
123 #ifndef BME280_FLOAT_ENABLE
124 //#define BME280_FLOAT_ENABLE
125 #endif
126
127 #ifndef BME280_FLOAT_ENABLE
128 #       ifndef BME280_64BIT_ENABLE
129 #               define BME280_64BIT_ENABLE
130 #       endif
131 #endif
132
133 #ifndef TRUE
134 #define TRUE                UINT8_C(1)
135 #endif
136 #ifndef FALSE
137 #define FALSE               UINT8_C(0)
138 #endif
139
140 /**\name I2C addresses */
141 #define BME280_I2C_ADDR_PRIM    UINT8_C(0x76)
142 #define BME280_I2C_ADDR_SEC             UINT8_C(0x77)
143
144 /**\name BME280 chip identifier */
145 #define BME280_CHIP_ID  UINT8_C(0x60)
146
147 /**\name Register Address */
148 #define BME280_CHIP_ID_ADDR                                     UINT8_C(0xD0)
149 #define BME280_RESET_ADDR                                       UINT8_C(0xE0)
150 #define BME280_TEMP_PRESS_CALIB_DATA_ADDR       UINT8_C(0x88)
151 #define BME280_HUMIDITY_CALIB_DATA_ADDR         UINT8_C(0xE1)
152 #define BME280_PWR_CTRL_ADDR                            UINT8_C(0xF4)
153 #define BME280_CTRL_HUM_ADDR                            UINT8_C(0xF2)
154 #define BME280_CTRL_MEAS_ADDR                           UINT8_C(0xF4)
155 #define BME280_CONFIG_ADDR                                      UINT8_C(0xF5)
156 #define BME280_DATA_ADDR                                        UINT8_C(0xF7)
157
158 /**\name API success code */
159 #define BME280_OK                                       INT8_C(0)
160 /**\name API error codes */
161 #define BME280_E_NULL_PTR                       INT8_C(-1)
162 #define BME280_E_DEV_NOT_FOUND          INT8_C(-2)
163 #define BME280_E_INVALID_LEN            INT8_C(-3)
164 #define BME280_E_COMM_FAIL                      INT8_C(-4)
165 #define BME280_E_SLEEP_MODE_FAIL        INT8_C(-5)
166 /**\name API warning codes */
167 #define BME280_W_INVALID_OSR_MACRO      UINT8_C(1)
168
169 /**\name Macros related to size */
170 #define BME280_TEMP_PRESS_CALIB_DATA_LEN        UINT8_C(26)
171 #define BME280_HUMIDITY_CALIB_DATA_LEN          UINT8_C(7)
172 #define BME280_P_T_H_DATA_LEN                           UINT8_C(8)
173
174 /**\name Sensor power modes */
175 #define BME280_SLEEP_MODE               UINT8_C(0x00)
176 #define BME280_FORCED_MODE              UINT8_C(0x01)
177 #define BME280_NORMAL_MODE              UINT8_C(0x03)
178
179 /**\name Macro to combine two 8 bit data's to form a 16 bit data */
180 #define BME280_CONCAT_BYTES(msb, lsb)     (((uint16_t)msb << 8) | (uint16_t)lsb)
181
182 #define BME280_SET_BITS(reg_data, bitname, data) \
183                                 ((reg_data & ~(bitname##_MSK)) | \
184                                 ((data << bitname##_POS) & bitname##_MSK))
185 #define BME280_SET_BITS_POS_0(reg_data, bitname, data) \
186                                 ((reg_data & ~(bitname##_MSK)) | \
187                                 (data & bitname##_MSK))
188
189 #define BME280_GET_BITS(reg_data, bitname)  ((reg_data & (bitname##_MSK)) >> \
190                                                         (bitname##_POS))
191 #define BME280_GET_BITS_POS_0(reg_data, bitname)  (reg_data & (bitname##_MSK))
192
193 /**\name Macros for bit masking */
194 #define BME280_SENSOR_MODE_MSK  UINT8_C(0x03)
195 #define BME280_SENSOR_MODE_POS  UINT8_C(0x00)
196
197 #define BME280_CTRL_HUM_MSK             UINT8_C(0x07)
198 #define BME280_CTRL_HUM_POS             UINT8_C(0x00)
199
200 #define BME280_CTRL_PRESS_MSK   UINT8_C(0x1C)
201 #define BME280_CTRL_PRESS_POS   UINT8_C(0x02)
202
203 #define BME280_CTRL_TEMP_MSK    UINT8_C(0xE0)
204 #define BME280_CTRL_TEMP_POS    UINT8_C(0x05)
205
206 #define BME280_FILTER_MSK               UINT8_C(0x1C)
207 #define BME280_FILTER_POS               UINT8_C(0x02)
208
209 #define BME280_STANDBY_MSK              UINT8_C(0xE0)
210 #define BME280_STANDBY_POS              UINT8_C(0x05)
211
212 /**\name Sensor component selection macros
213    These values are internal for API implementation. Don't relate this to
214    data sheet.*/
215 #define BME280_PRESS            UINT8_C(1)
216 #define BME280_TEMP                     UINT8_C(1 << 1)
217 #define BME280_HUM                      UINT8_C(1 << 2)
218 #define BME280_ALL                      UINT8_C(0x07)
219
220 /**\name Settings selection macros */
221 #define BME280_OSR_PRESS_SEL            UINT8_C(1)
222 #define BME280_OSR_TEMP_SEL                     UINT8_C(1 << 1)
223 #define BME280_OSR_HUM_SEL                      UINT8_C(1 << 2)
224 #define BME280_FILTER_SEL                       UINT8_C(1 << 3)
225 #define BME280_STANDBY_SEL                      UINT8_C(1 << 4)
226 #define BME280_ALL_SETTINGS_SEL         UINT8_C(0x1F)
227
228 /**\name Oversampling macros */
229 #define BME280_NO_OVERSAMPLING          UINT8_C(0x00)
230 #define BME280_OVERSAMPLING_1X          UINT8_C(0x01)
231 #define BME280_OVERSAMPLING_2X          UINT8_C(0x02)
232 #define BME280_OVERSAMPLING_4X          UINT8_C(0x03)
233 #define BME280_OVERSAMPLING_8X          UINT8_C(0x04)
234 #define BME280_OVERSAMPLING_16X         UINT8_C(0x05)
235
236 /**\name Standby duration selection macros */
237 #define BME280_STANDBY_TIME_1_MS              (0x00)
238 #define BME280_STANDBY_TIME_62_5_MS           (0x01)
239 #define BME280_STANDBY_TIME_125_MS                        (0x02)
240 #define BME280_STANDBY_TIME_250_MS            (0x03)
241 #define BME280_STANDBY_TIME_500_MS            (0x04)
242 #define BME280_STANDBY_TIME_1000_MS           (0x05)
243 #define BME280_STANDBY_TIME_10_MS             (0x06)
244 #define BME280_STANDBY_TIME_20_MS             (0x07)
245
246 /**\name Filter coefficient selection macros */
247 #define BME280_FILTER_COEFF_OFF               (0x00)
248 #define BME280_FILTER_COEFF_2                 (0x01)
249 #define BME280_FILTER_COEFF_4                 (0x02)
250 #define BME280_FILTER_COEFF_8                 (0x03)
251 #define BME280_FILTER_COEFF_16                (0x04)
252
253 /*!
254  * @brief Interface selection Enums
255  */
256 enum bme280_intf {
257         /*! SPI interface */
258         BME280_SPI_INTF,
259         /*! I2C interface */
260         BME280_I2C_INTF
261 };
262
263 /*!
264  * @brief Type definitions
265  */
266 typedef int8_t (*bme280_com_fptr_t)(uint8_t dev_id, uint8_t reg_addr,
267                 uint8_t *data, uint16_t len);
268
269 typedef void (*bme280_delay_fptr_t)(uint32_t period);
270
271 /*!
272  * @brief Calibration data
273  */
274 struct bme280_calib_data {
275  /**
276  * @ Trim Variables
277  */
278 /**@{*/
279         uint16_t dig_T1;
280         int16_t dig_T2;
281         int16_t dig_T3;
282         uint16_t dig_P1;
283         int16_t dig_P2;
284         int16_t dig_P3;
285         int16_t dig_P4;
286         int16_t dig_P5;
287         int16_t dig_P6;
288         int16_t dig_P7;
289         int16_t dig_P8;
290         int16_t dig_P9;
291         uint8_t  dig_H1;
292         int16_t dig_H2;
293         uint8_t  dig_H3;
294         int16_t dig_H4;
295         int16_t dig_H5;
296         int8_t  dig_H6;
297         int32_t t_fine;
298 /**@}*/
299 };
300
301 /*!
302  * @brief bme280 sensor structure which comprises of temperature, pressure and
303  * humidity data
304  */
305 #ifdef BME280_FLOAT_ENABLE
306 struct bme280_data {
307         /*! Compensated pressure */
308         double pressure;
309         /*! Compensated temperature */
310         double temperature;
311         /*! Compensated humidity */
312         double humidity;
313 };
314 #else
315 struct bme280_data {
316         /*! Compensated pressure */
317         uint32_t pressure;
318         /*! Compensated temperature */
319         int32_t temperature;
320         /*! Compensated humidity */
321         uint32_t humidity;
322 };
323 #endif /* BME280_USE_FLOATING_POINT */
324
325 /*!
326  * @brief bme280 sensor structure which comprises of uncompensated temperature,
327  * pressure and humidity data
328  */
329 struct bme280_uncomp_data {
330         /*! un-compensated pressure */
331         uint32_t pressure;
332         /*! un-compensated temperature */
333         uint32_t temperature;
334         /*! un-compensated humidity */
335         uint32_t humidity;
336 };
337
338 /*!
339  * @brief bme280 sensor settings structure which comprises of mode,
340  * oversampling and filter settings.
341  */
342 struct bme280_settings {
343         /*! pressure oversampling */
344         uint8_t osr_p;
345         /*! temperature oversampling */
346         uint8_t osr_t;
347         /*! humidity oversampling */
348         uint8_t osr_h;
349         /*! filter coefficient */
350         uint8_t filter;
351         /*! standby time */
352         uint8_t standby_time;
353 };
354
355 /*!
356  * @brief bme280 device structure
357  */
358 struct bme280_dev {
359         /*! Chip Id */
360         uint8_t chip_id;
361         /*! Device Id */
362         uint8_t dev_id;
363         /*! SPI/I2C interface */
364         enum bme280_intf intf;
365         /*! Read function pointer */
366         bme280_com_fptr_t read;
367         /*! Write function pointer */
368         bme280_com_fptr_t write;
369         /*! Delay function pointer */
370         bme280_delay_fptr_t delay_ms;
371         /*! Trim data */
372         struct bme280_calib_data calib_data;
373         /*! Sensor settings */
374         struct bme280_settings settings;
375 };
376
377 #endif /* BME280_DEFS_H_ */
378 /** @}*/
379 /** @}*/