xref: /linux/drivers/iio/chemical/bme680.h (revision 7f71507851fc7764b36a3221839607d3a45c2025)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef BME680_H_
3 #define BME680_H_
4 
5 #include <linux/regmap.h>
6 
7 #define BME680_REG_CHIP_ID			0xD0
8 #define   BME680_CHIP_ID_VAL			0x61
9 #define BME680_REG_SOFT_RESET			0xE0
10 #define   BME680_CMD_SOFTRESET			0xB6
11 #define BME680_REG_STATUS			0x73
12 #define   BME680_SPI_MEM_PAGE_BIT		BIT(4)
13 #define     BME680_SPI_MEM_PAGE_1_VAL		1
14 
15 #define BME680_REG_TEMP_MSB			0x22
16 #define BME680_REG_PRESS_MSB			0x1F
17 #define BME680_REG_HUMIDITY_MSB			0x25
18 #define BME680_REG_GAS_MSB			0x2A
19 #define BME680_REG_GAS_R_LSB			0x2B
20 #define   BME680_GAS_STAB_BIT			BIT(4)
21 #define   BME680_GAS_RANGE_MASK			GENMASK(3, 0)
22 
23 #define BME680_REG_CTRL_HUMIDITY		0x72
24 #define   BME680_OSRS_HUMIDITY_MASK		GENMASK(2, 0)
25 
26 #define BME680_REG_CTRL_MEAS			0x74
27 #define   BME680_OSRS_TEMP_MASK			GENMASK(7, 5)
28 #define   BME680_OSRS_PRESS_MASK		GENMASK(4, 2)
29 #define   BME680_MODE_MASK			GENMASK(1, 0)
30 
31 #define BME680_REG_CONFIG			0x75
32 #define   BME680_FILTER_MASK			GENMASK(4, 2)
33 #define     BME680_FILTER_COEFF_VAL		BIT(1)
34 
35 /* TEMP/PRESS/HUMID reading skipped */
36 #define BME680_MEAS_SKIPPED			0x8000
37 
38 #define BME680_MAX_OVERFLOW_VAL			0x40000000
39 #define BME680_HUM_REG_SHIFT_VAL		4
40 #define BME680_BIT_H1_DATA_MASK			GENMASK(3, 0)
41 
42 #define   BME680_RHRANGE_MASK			GENMASK(5, 4)
43 #define BME680_REG_RES_HEAT_VAL			0x00
44 #define   BME680_RSERROR_MASK			GENMASK(7, 4)
45 #define BME680_REG_IDAC_HEAT_0			0x50
46 #define BME680_REG_RES_HEAT_0			0x5A
47 #define BME680_REG_GAS_WAIT_0			0x64
48 #define BME680_ADC_GAS_RES			GENMASK(15, 6)
49 #define BME680_AMB_TEMP				25
50 
51 #define BME680_REG_CTRL_GAS_1			0x71
52 #define   BME680_RUN_GAS_MASK			BIT(4)
53 #define   BME680_NB_CONV_MASK			GENMASK(3, 0)
54 
55 #define BME680_REG_MEAS_STAT_0			0x1D
56 #define   BME680_NEW_DATA_BIT			BIT(7)
57 #define   BME680_GAS_MEAS_BIT			BIT(6)
58 #define   BME680_MEAS_BIT			BIT(5)
59 
60 #define BME680_TEMP_NUM_BYTES			3
61 #define BME680_PRESS_NUM_BYTES			3
62 #define BME680_HUMID_NUM_BYTES			2
63 #define BME680_GAS_NUM_BYTES			2
64 
65 #define BME680_MEAS_TRIM_MASK			GENMASK(24, 4)
66 
67 /* Datasheet Section 1.1, Table 1 */
68 #define BME680_STARTUP_TIME_US			2000
69 
70 #define BME680_NUM_CHANNELS			4
71 #define BME680_NUM_BULK_READ_REGS		15
72 
73 /* Calibration Parameters */
74 #define BME680_T2_LSB_REG	0x8A
75 #define BME680_H2_MSB_REG	0xE1
76 #define BME680_GH3_REG		0xEE
77 
78 #define BME680_CALIB_RANGE_1_LEN               23
79 #define BME680_CALIB_RANGE_2_LEN               14
80 #define BME680_CALIB_RANGE_3_LEN               5
81 
82 extern const struct regmap_config bme680_regmap_config;
83 
84 int bme680_core_probe(struct device *dev, struct regmap *regmap,
85 		      const char *name);
86 
87 #endif  /* BME680_H_ */
88