GNU Linux-libre 5.15.72-gnu
[releases.git] / drivers / iio / imu / inv_icm42600 / inv_icm42600.h
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * Copyright (C) 2020 Invensense, Inc.
4  */
5
6 #ifndef INV_ICM42600_H_
7 #define INV_ICM42600_H_
8
9 #include <linux/bits.h>
10 #include <linux/bitfield.h>
11 #include <linux/regmap.h>
12 #include <linux/mutex.h>
13 #include <linux/regulator/consumer.h>
14 #include <linux/pm.h>
15 #include <linux/iio/iio.h>
16
17 #include "inv_icm42600_buffer.h"
18
19 enum inv_icm42600_chip {
20         INV_CHIP_INVALID,
21         INV_CHIP_ICM42600,
22         INV_CHIP_ICM42602,
23         INV_CHIP_ICM42605,
24         INV_CHIP_ICM42622,
25         INV_CHIP_NB,
26 };
27
28 /* serial bus slew rates */
29 enum inv_icm42600_slew_rate {
30         INV_ICM42600_SLEW_RATE_20_60NS,
31         INV_ICM42600_SLEW_RATE_12_36NS,
32         INV_ICM42600_SLEW_RATE_6_18NS,
33         INV_ICM42600_SLEW_RATE_4_12NS,
34         INV_ICM42600_SLEW_RATE_2_6NS,
35         INV_ICM42600_SLEW_RATE_INF_2NS,
36 };
37
38 enum inv_icm42600_sensor_mode {
39         INV_ICM42600_SENSOR_MODE_OFF,
40         INV_ICM42600_SENSOR_MODE_STANDBY,
41         INV_ICM42600_SENSOR_MODE_LOW_POWER,
42         INV_ICM42600_SENSOR_MODE_LOW_NOISE,
43         INV_ICM42600_SENSOR_MODE_NB,
44 };
45
46 /* gyroscope fullscale values */
47 enum inv_icm42600_gyro_fs {
48         INV_ICM42600_GYRO_FS_2000DPS,
49         INV_ICM42600_GYRO_FS_1000DPS,
50         INV_ICM42600_GYRO_FS_500DPS,
51         INV_ICM42600_GYRO_FS_250DPS,
52         INV_ICM42600_GYRO_FS_125DPS,
53         INV_ICM42600_GYRO_FS_62_5DPS,
54         INV_ICM42600_GYRO_FS_31_25DPS,
55         INV_ICM42600_GYRO_FS_15_625DPS,
56         INV_ICM42600_GYRO_FS_NB,
57 };
58
59 /* accelerometer fullscale values */
60 enum inv_icm42600_accel_fs {
61         INV_ICM42600_ACCEL_FS_16G,
62         INV_ICM42600_ACCEL_FS_8G,
63         INV_ICM42600_ACCEL_FS_4G,
64         INV_ICM42600_ACCEL_FS_2G,
65         INV_ICM42600_ACCEL_FS_NB,
66 };
67
68 /* ODR suffixed by LN or LP are Low-Noise or Low-Power mode only */
69 enum inv_icm42600_odr {
70         INV_ICM42600_ODR_8KHZ_LN = 3,
71         INV_ICM42600_ODR_4KHZ_LN,
72         INV_ICM42600_ODR_2KHZ_LN,
73         INV_ICM42600_ODR_1KHZ_LN,
74         INV_ICM42600_ODR_200HZ,
75         INV_ICM42600_ODR_100HZ,
76         INV_ICM42600_ODR_50HZ,
77         INV_ICM42600_ODR_25HZ,
78         INV_ICM42600_ODR_12_5HZ,
79         INV_ICM42600_ODR_6_25HZ_LP,
80         INV_ICM42600_ODR_3_125HZ_LP,
81         INV_ICM42600_ODR_1_5625HZ_LP,
82         INV_ICM42600_ODR_500HZ,
83         INV_ICM42600_ODR_NB,
84 };
85
86 enum inv_icm42600_filter {
87         /* Low-Noise mode sensor data filter (3rd order filter by default) */
88         INV_ICM42600_FILTER_BW_ODR_DIV_2,
89
90         /* Low-Power mode sensor data filter (averaging) */
91         INV_ICM42600_FILTER_AVG_1X = 1,
92         INV_ICM42600_FILTER_AVG_16X = 6,
93 };
94
95 struct inv_icm42600_sensor_conf {
96         int mode;
97         int fs;
98         int odr;
99         int filter;
100 };
101 #define INV_ICM42600_SENSOR_CONF_INIT           {-1, -1, -1, -1}
102
103 struct inv_icm42600_conf {
104         struct inv_icm42600_sensor_conf gyro;
105         struct inv_icm42600_sensor_conf accel;
106         bool temp_en;
107 };
108
109 struct inv_icm42600_suspended {
110         enum inv_icm42600_sensor_mode gyro;
111         enum inv_icm42600_sensor_mode accel;
112         bool temp;
113 };
114
115 /**
116  *  struct inv_icm42600_state - driver state variables
117  *  @lock:              lock for serializing multiple registers access.
118  *  @chip:              chip identifier.
119  *  @name:              chip name.
120  *  @map:               regmap pointer.
121  *  @vdd_supply:        VDD voltage regulator for the chip.
122  *  @vddio_supply:      I/O voltage regulator for the chip.
123  *  @orientation:       sensor chip orientation relative to main hardware.
124  *  @conf:              chip sensors configurations.
125  *  @suspended:         suspended sensors configuration.
126  *  @indio_gyro:        gyroscope IIO device.
127  *  @indio_accel:       accelerometer IIO device.
128  *  @buffer:            data transfer buffer aligned for DMA.
129  *  @fifo:              FIFO management structure.
130  *  @timestamp:         interrupt timestamps.
131  */
132 struct inv_icm42600_state {
133         struct mutex lock;
134         enum inv_icm42600_chip chip;
135         const char *name;
136         struct regmap *map;
137         struct regulator *vdd_supply;
138         struct regulator *vddio_supply;
139         struct iio_mount_matrix orientation;
140         struct inv_icm42600_conf conf;
141         struct inv_icm42600_suspended suspended;
142         struct iio_dev *indio_gyro;
143         struct iio_dev *indio_accel;
144         uint8_t buffer[2] ____cacheline_aligned;
145         struct inv_icm42600_fifo fifo;
146         struct {
147                 int64_t gyro;
148                 int64_t accel;
149         } timestamp;
150 };
151
152 /* Virtual register addresses: @bank on MSB (4 upper bits), @address on LSB */
153
154 /* Bank selection register, available in all banks */
155 #define INV_ICM42600_REG_BANK_SEL                       0x76
156 #define INV_ICM42600_BANK_SEL_MASK                      GENMASK(2, 0)
157
158 /* User bank 0 (MSB 0x00) */
159 #define INV_ICM42600_REG_DEVICE_CONFIG                  0x0011
160 #define INV_ICM42600_DEVICE_CONFIG_SOFT_RESET           BIT(0)
161
162 #define INV_ICM42600_REG_DRIVE_CONFIG                   0x0013
163 #define INV_ICM42600_DRIVE_CONFIG_I2C_MASK              GENMASK(5, 3)
164 #define INV_ICM42600_DRIVE_CONFIG_I2C(_rate)            \
165                 FIELD_PREP(INV_ICM42600_DRIVE_CONFIG_I2C_MASK, (_rate))
166 #define INV_ICM42600_DRIVE_CONFIG_SPI_MASK              GENMASK(2, 0)
167 #define INV_ICM42600_DRIVE_CONFIG_SPI(_rate)            \
168                 FIELD_PREP(INV_ICM42600_DRIVE_CONFIG_SPI_MASK, (_rate))
169
170 #define INV_ICM42600_REG_INT_CONFIG                     0x0014
171 #define INV_ICM42600_INT_CONFIG_INT2_LATCHED            BIT(5)
172 #define INV_ICM42600_INT_CONFIG_INT2_PUSH_PULL          BIT(4)
173 #define INV_ICM42600_INT_CONFIG_INT2_ACTIVE_HIGH        BIT(3)
174 #define INV_ICM42600_INT_CONFIG_INT2_ACTIVE_LOW         0x00
175 #define INV_ICM42600_INT_CONFIG_INT1_LATCHED            BIT(2)
176 #define INV_ICM42600_INT_CONFIG_INT1_PUSH_PULL          BIT(1)
177 #define INV_ICM42600_INT_CONFIG_INT1_ACTIVE_HIGH        BIT(0)
178 #define INV_ICM42600_INT_CONFIG_INT1_ACTIVE_LOW         0x00
179
180 #define INV_ICM42600_REG_FIFO_CONFIG                    0x0016
181 #define INV_ICM42600_FIFO_CONFIG_MASK                   GENMASK(7, 6)
182 #define INV_ICM42600_FIFO_CONFIG_BYPASS                 \
183                 FIELD_PREP(INV_ICM42600_FIFO_CONFIG_MASK, 0)
184 #define INV_ICM42600_FIFO_CONFIG_STREAM                 \
185                 FIELD_PREP(INV_ICM42600_FIFO_CONFIG_MASK, 1)
186 #define INV_ICM42600_FIFO_CONFIG_STOP_ON_FULL           \
187                 FIELD_PREP(INV_ICM42600_FIFO_CONFIG_MASK, 2)
188
189 /* all sensor data are 16 bits (2 registers wide) in big-endian */
190 #define INV_ICM42600_REG_TEMP_DATA                      0x001D
191 #define INV_ICM42600_REG_ACCEL_DATA_X                   0x001F
192 #define INV_ICM42600_REG_ACCEL_DATA_Y                   0x0021
193 #define INV_ICM42600_REG_ACCEL_DATA_Z                   0x0023
194 #define INV_ICM42600_REG_GYRO_DATA_X                    0x0025
195 #define INV_ICM42600_REG_GYRO_DATA_Y                    0x0027
196 #define INV_ICM42600_REG_GYRO_DATA_Z                    0x0029
197 #define INV_ICM42600_DATA_INVALID                       -32768
198
199 #define INV_ICM42600_REG_INT_STATUS                     0x002D
200 #define INV_ICM42600_INT_STATUS_UI_FSYNC                BIT(6)
201 #define INV_ICM42600_INT_STATUS_PLL_RDY                 BIT(5)
202 #define INV_ICM42600_INT_STATUS_RESET_DONE              BIT(4)
203 #define INV_ICM42600_INT_STATUS_DATA_RDY                BIT(3)
204 #define INV_ICM42600_INT_STATUS_FIFO_THS                BIT(2)
205 #define INV_ICM42600_INT_STATUS_FIFO_FULL               BIT(1)
206 #define INV_ICM42600_INT_STATUS_AGC_RDY                 BIT(0)
207
208 /*
209  * FIFO access registers
210  * FIFO count is 16 bits (2 registers) big-endian
211  * FIFO data is a continuous read register to read FIFO content
212  */
213 #define INV_ICM42600_REG_FIFO_COUNT                     0x002E
214 #define INV_ICM42600_REG_FIFO_DATA                      0x0030
215
216 #define INV_ICM42600_REG_SIGNAL_PATH_RESET              0x004B
217 #define INV_ICM42600_SIGNAL_PATH_RESET_DMP_INIT_EN      BIT(6)
218 #define INV_ICM42600_SIGNAL_PATH_RESET_DMP_MEM_RESET    BIT(5)
219 #define INV_ICM42600_SIGNAL_PATH_RESET_RESET            BIT(3)
220 #define INV_ICM42600_SIGNAL_PATH_RESET_TMST_STROBE      BIT(2)
221 #define INV_ICM42600_SIGNAL_PATH_RESET_FIFO_FLUSH       BIT(1)
222
223 /* default configuration: all data big-endian and fifo count in bytes */
224 #define INV_ICM42600_REG_INTF_CONFIG0                   0x004C
225 #define INV_ICM42600_INTF_CONFIG0_FIFO_HOLD_LAST_DATA   BIT(7)
226 #define INV_ICM42600_INTF_CONFIG0_FIFO_COUNT_REC        BIT(6)
227 #define INV_ICM42600_INTF_CONFIG0_FIFO_COUNT_ENDIAN     BIT(5)
228 #define INV_ICM42600_INTF_CONFIG0_SENSOR_DATA_ENDIAN    BIT(4)
229 #define INV_ICM42600_INTF_CONFIG0_UI_SIFS_CFG_MASK      GENMASK(1, 0)
230 #define INV_ICM42600_INTF_CONFIG0_UI_SIFS_CFG_SPI_DIS   \
231                 FIELD_PREP(INV_ICM42600_INTF_CONFIG0_UI_SIFS_CFG_MASK, 2)
232 #define INV_ICM42600_INTF_CONFIG0_UI_SIFS_CFG_I2C_DIS   \
233                 FIELD_PREP(INV_ICM42600_INTF_CONFIG0_UI_SIFS_CFG_MASK, 3)
234
235 #define INV_ICM42600_REG_INTF_CONFIG1                   0x004D
236 #define INV_ICM42600_INTF_CONFIG1_ACCEL_LP_CLK_RC       BIT(3)
237
238 #define INV_ICM42600_REG_PWR_MGMT0                      0x004E
239 #define INV_ICM42600_PWR_MGMT0_TEMP_DIS                 BIT(5)
240 #define INV_ICM42600_PWR_MGMT0_IDLE                     BIT(4)
241 #define INV_ICM42600_PWR_MGMT0_GYRO(_mode)              \
242                 FIELD_PREP(GENMASK(3, 2), (_mode))
243 #define INV_ICM42600_PWR_MGMT0_ACCEL(_mode)             \
244                 FIELD_PREP(GENMASK(1, 0), (_mode))
245
246 #define INV_ICM42600_REG_GYRO_CONFIG0                   0x004F
247 #define INV_ICM42600_GYRO_CONFIG0_FS(_fs)               \
248                 FIELD_PREP(GENMASK(7, 5), (_fs))
249 #define INV_ICM42600_GYRO_CONFIG0_ODR(_odr)             \
250                 FIELD_PREP(GENMASK(3, 0), (_odr))
251
252 #define INV_ICM42600_REG_ACCEL_CONFIG0                  0x0050
253 #define INV_ICM42600_ACCEL_CONFIG0_FS(_fs)              \
254                 FIELD_PREP(GENMASK(7, 5), (_fs))
255 #define INV_ICM42600_ACCEL_CONFIG0_ODR(_odr)            \
256                 FIELD_PREP(GENMASK(3, 0), (_odr))
257
258 #define INV_ICM42600_REG_GYRO_ACCEL_CONFIG0             0x0052
259 #define INV_ICM42600_GYRO_ACCEL_CONFIG0_ACCEL_FILT(_f)  \
260                 FIELD_PREP(GENMASK(7, 4), (_f))
261 #define INV_ICM42600_GYRO_ACCEL_CONFIG0_GYRO_FILT(_f)   \
262                 FIELD_PREP(GENMASK(3, 0), (_f))
263
264 #define INV_ICM42600_REG_TMST_CONFIG                    0x0054
265 #define INV_ICM42600_TMST_CONFIG_MASK                   GENMASK(4, 0)
266 #define INV_ICM42600_TMST_CONFIG_TMST_TO_REGS_EN        BIT(4)
267 #define INV_ICM42600_TMST_CONFIG_TMST_RES_16US          BIT(3)
268 #define INV_ICM42600_TMST_CONFIG_TMST_DELTA_EN          BIT(2)
269 #define INV_ICM42600_TMST_CONFIG_TMST_FSYNC_EN          BIT(1)
270 #define INV_ICM42600_TMST_CONFIG_TMST_EN                BIT(0)
271
272 #define INV_ICM42600_REG_FIFO_CONFIG1                   0x005F
273 #define INV_ICM42600_FIFO_CONFIG1_RESUME_PARTIAL_RD     BIT(6)
274 #define INV_ICM42600_FIFO_CONFIG1_WM_GT_TH              BIT(5)
275 #define INV_ICM42600_FIFO_CONFIG1_TMST_FSYNC_EN         BIT(3)
276 #define INV_ICM42600_FIFO_CONFIG1_TEMP_EN               BIT(2)
277 #define INV_ICM42600_FIFO_CONFIG1_GYRO_EN               BIT(1)
278 #define INV_ICM42600_FIFO_CONFIG1_ACCEL_EN              BIT(0)
279
280 /* FIFO watermark is 16 bits (2 registers wide) in little-endian */
281 #define INV_ICM42600_REG_FIFO_WATERMARK                 0x0060
282 #define INV_ICM42600_FIFO_WATERMARK_VAL(_wm)            \
283                 cpu_to_le16((_wm) & GENMASK(11, 0))
284 /* FIFO is 2048 bytes, let 12 samples for reading latency */
285 #define INV_ICM42600_FIFO_WATERMARK_MAX                 (2048 - 12 * 16)
286
287 #define INV_ICM42600_REG_INT_CONFIG1                    0x0064
288 #define INV_ICM42600_INT_CONFIG1_TPULSE_DURATION        BIT(6)
289 #define INV_ICM42600_INT_CONFIG1_TDEASSERT_DISABLE      BIT(5)
290 #define INV_ICM42600_INT_CONFIG1_ASYNC_RESET            BIT(4)
291
292 #define INV_ICM42600_REG_INT_SOURCE0                    0x0065
293 #define INV_ICM42600_INT_SOURCE0_UI_FSYNC_INT1_EN       BIT(6)
294 #define INV_ICM42600_INT_SOURCE0_PLL_RDY_INT1_EN        BIT(5)
295 #define INV_ICM42600_INT_SOURCE0_RESET_DONE_INT1_EN     BIT(4)
296 #define INV_ICM42600_INT_SOURCE0_UI_DRDY_INT1_EN        BIT(3)
297 #define INV_ICM42600_INT_SOURCE0_FIFO_THS_INT1_EN       BIT(2)
298 #define INV_ICM42600_INT_SOURCE0_FIFO_FULL_INT1_EN      BIT(1)
299 #define INV_ICM42600_INT_SOURCE0_UI_AGC_RDY_INT1_EN     BIT(0)
300
301 #define INV_ICM42600_REG_WHOAMI                         0x0075
302 #define INV_ICM42600_WHOAMI_ICM42600                    0x40
303 #define INV_ICM42600_WHOAMI_ICM42602                    0x41
304 #define INV_ICM42600_WHOAMI_ICM42605                    0x42
305 #define INV_ICM42600_WHOAMI_ICM42622                    0x46
306
307 /* User bank 1 (MSB 0x10) */
308 #define INV_ICM42600_REG_SENSOR_CONFIG0                 0x1003
309 #define INV_ICM42600_SENSOR_CONFIG0_ZG_DISABLE          BIT(5)
310 #define INV_ICM42600_SENSOR_CONFIG0_YG_DISABLE          BIT(4)
311 #define INV_ICM42600_SENSOR_CONFIG0_XG_DISABLE          BIT(3)
312 #define INV_ICM42600_SENSOR_CONFIG0_ZA_DISABLE          BIT(2)
313 #define INV_ICM42600_SENSOR_CONFIG0_YA_DISABLE          BIT(1)
314 #define INV_ICM42600_SENSOR_CONFIG0_XA_DISABLE          BIT(0)
315
316 /* Timestamp value is 20 bits (3 registers) in little-endian */
317 #define INV_ICM42600_REG_TMSTVAL                        0x1062
318 #define INV_ICM42600_TMSTVAL_MASK                       GENMASK(19, 0)
319
320 #define INV_ICM42600_REG_INTF_CONFIG4                   0x107A
321 #define INV_ICM42600_INTF_CONFIG4_I3C_BUS_ONLY          BIT(6)
322 #define INV_ICM42600_INTF_CONFIG4_SPI_AP_4WIRE          BIT(1)
323
324 #define INV_ICM42600_REG_INTF_CONFIG6                   0x107C
325 #define INV_ICM42600_INTF_CONFIG6_MASK                  GENMASK(4, 0)
326 #define INV_ICM42600_INTF_CONFIG6_I3C_EN                BIT(4)
327 #define INV_ICM42600_INTF_CONFIG6_I3C_IBI_BYTE_EN       BIT(3)
328 #define INV_ICM42600_INTF_CONFIG6_I3C_IBI_EN            BIT(2)
329 #define INV_ICM42600_INTF_CONFIG6_I3C_DDR_EN            BIT(1)
330 #define INV_ICM42600_INTF_CONFIG6_I3C_SDR_EN            BIT(0)
331
332 /* User bank 4 (MSB 0x40) */
333 #define INV_ICM42600_REG_INT_SOURCE8                    0x404F
334 #define INV_ICM42600_INT_SOURCE8_FSYNC_IBI_EN           BIT(5)
335 #define INV_ICM42600_INT_SOURCE8_PLL_RDY_IBI_EN         BIT(4)
336 #define INV_ICM42600_INT_SOURCE8_UI_DRDY_IBI_EN         BIT(3)
337 #define INV_ICM42600_INT_SOURCE8_FIFO_THS_IBI_EN        BIT(2)
338 #define INV_ICM42600_INT_SOURCE8_FIFO_FULL_IBI_EN       BIT(1)
339 #define INV_ICM42600_INT_SOURCE8_AGC_RDY_IBI_EN         BIT(0)
340
341 #define INV_ICM42600_REG_OFFSET_USER0                   0x4077
342 #define INV_ICM42600_REG_OFFSET_USER1                   0x4078
343 #define INV_ICM42600_REG_OFFSET_USER2                   0x4079
344 #define INV_ICM42600_REG_OFFSET_USER3                   0x407A
345 #define INV_ICM42600_REG_OFFSET_USER4                   0x407B
346 #define INV_ICM42600_REG_OFFSET_USER5                   0x407C
347 #define INV_ICM42600_REG_OFFSET_USER6                   0x407D
348 #define INV_ICM42600_REG_OFFSET_USER7                   0x407E
349 #define INV_ICM42600_REG_OFFSET_USER8                   0x407F
350
351 /* Sleep times required by the driver */
352 #define INV_ICM42600_POWER_UP_TIME_MS           100
353 #define INV_ICM42600_RESET_TIME_MS              1
354 #define INV_ICM42600_ACCEL_STARTUP_TIME_MS      20
355 #define INV_ICM42600_GYRO_STARTUP_TIME_MS       60
356 #define INV_ICM42600_GYRO_STOP_TIME_MS          150
357 #define INV_ICM42600_TEMP_STARTUP_TIME_MS       14
358 #define INV_ICM42600_SUSPEND_DELAY_MS           2000
359
360 typedef int (*inv_icm42600_bus_setup)(struct inv_icm42600_state *);
361
362 extern const struct regmap_config inv_icm42600_regmap_config;
363 extern const struct dev_pm_ops inv_icm42600_pm_ops;
364
365 const struct iio_mount_matrix *
366 inv_icm42600_get_mount_matrix(const struct iio_dev *indio_dev,
367                               const struct iio_chan_spec *chan);
368
369 uint32_t inv_icm42600_odr_to_period(enum inv_icm42600_odr odr);
370
371 int inv_icm42600_set_accel_conf(struct inv_icm42600_state *st,
372                                 struct inv_icm42600_sensor_conf *conf,
373                                 unsigned int *sleep_ms);
374
375 int inv_icm42600_set_gyro_conf(struct inv_icm42600_state *st,
376                                struct inv_icm42600_sensor_conf *conf,
377                                unsigned int *sleep_ms);
378
379 int inv_icm42600_set_temp_conf(struct inv_icm42600_state *st, bool enable,
380                                unsigned int *sleep_ms);
381
382 int inv_icm42600_debugfs_reg(struct iio_dev *indio_dev, unsigned int reg,
383                              unsigned int writeval, unsigned int *readval);
384
385 int inv_icm42600_core_probe(struct regmap *regmap, int chip, int irq,
386                             inv_icm42600_bus_setup bus_setup);
387
388 struct iio_dev *inv_icm42600_gyro_init(struct inv_icm42600_state *st);
389
390 int inv_icm42600_gyro_parse_fifo(struct iio_dev *indio_dev);
391
392 struct iio_dev *inv_icm42600_accel_init(struct inv_icm42600_state *st);
393
394 int inv_icm42600_accel_parse_fifo(struct iio_dev *indio_dev);
395
396 #endif