summaryrefslogtreecommitdiff
path: root/driver/accelgyro_icm42607.h
blob: f31392bf92088011d4fb880f5ffee15b163a3f8c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
/* Copyright 2021 The Chromium OS Authors. All rights reserved.
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 */

/* ICM-42607 accelerometer and gyroscope for Chrome EC */

#ifndef __CROS_EC_ACCELGYRO_ICM42607_H
#define __CROS_EC_ACCELGYRO_ICM42607_H

#include "accelgyro.h"
#include "common.h"

/*
 * 7-bit address is 110100Xb. Where 'X' is determined
 * by the logic level on pin AP_AD0.
 */
#define ICM42607_ADDR0_FLAGS		(0x68 << 1)
#define ICM42607_ADDR1_FLAGS		(0x69 << 1)

/* Min and Max sampling frequency in mHz */
#define ICM42607_ACCEL_MIN_FREQ		1562
#define ICM42607_ACCEL_MAX_FREQ		\
		MOTION_MAX_SENSOR_FREQUENCY(400000, 100000)
#define ICM42607_GYRO_MIN_FREQ		12500
#define ICM42607_GYRO_MAX_FREQ		\
		MOTION_MAX_SENSOR_FREQUENCY(1600000, 100000)

/* Min and Max Accel FS in g */
#define ICM42607_ACCEL_FS_MIN_VAL	2
#define ICM42607_ACCEL_FS_MAX_VAL	16

/* Min and Max Gyro FS in dps */
#define ICM42607_GYRO_FS_MIN_VAL	250
#define ICM42607_GYRO_FS_MAX_VAL	2000

/* accel stabilization time in us */
#define ICM42607_ACCEL_START_TIME	20000
#define ICM42607_ACCEL_STOP_TIME	0

/* gyro stabilization time in us */
#define ICM42607_GYRO_START_TIME	40000
#define ICM42607_GYRO_STOP_TIME		20000

/* Reg value from Accel FS in G */
#define ICM42607_ACCEL_FS_TO_REG(_fs)	((_fs) <= 2 ? 3 : \
					 (_fs) >= 16 ? 0 : \
					 3 - __fls((_fs) / 2))

/* Accel FSR in G from Reg value */
#define ICM42607_ACCEL_REG_TO_FS(_reg)	((1 << (3 - (_reg))) * 2)

/* Reg value from Gyro FS in dps */
#define ICM42607_GYRO_FS_TO_REG(_fs)	((_fs) <= 250 ? 3 : \
					 (_fs) >= 2000 ? 0 : \
					 3 - __fls((_fs) / 250))

/* Gyro FSR in dps from Reg value */
#define ICM42607_GYRO_REG_TO_FS(_reg)	((1 << (3 - (_reg))) * 250)

/* Reg value from ODR in mHz */
#define ICM42607_ODR_TO_REG(_odr)	((_odr) == 0 ? 0 : \
					 (__fls(1600000 / (_odr)) + 5))

/* ODR in mHz from Reg value */
#define ICM42607_REG_TO_ODR(_reg)	((_reg) <= 5 ? 1600000 : \
					 (1600000 / (1 << ((_reg) - 5))))

/* Reg value for the next higher ODR */
#define ICM42607_ODR_REG_UP(_reg)	((_reg) - 1)

/*
 * Filter bandwidth values from ODR reg
 *   >= 400Hz (7) -> 180Hz (1)
 *   200Hz (8) -> 73Hz (3)
 *   100Hz (9) -> 53Hz (4)
 *   50Hz (10) -> 25Hz (6)
 *   <= 25Hz (11) -> 16Hz (7)
 */
#define ICM42607_ODR_TO_FILT_BW(_odr)	((_odr) <= 7 ? 1 : \
					 (_odr) <= 9 ? (_odr) - 5 : \
					 (_odr) == 10 ? 6 : \
					 7)

/*
 * Register addresses are virtual address on 16 bits.
 * MSB is coding block selection value for MREG registers
 * and LSB real register address.
 * ex: MREG2 (block 0x28) register 03 => 0x2803
 */
#define ICM42607_REG_MCLK_RDY		0x0000
#define ICM42607_MCLK_RDY		BIT(3)

#define ICM426XX_REG_DEVICE_CONFIG	0x0001
#define ICM426XX_SPI_MODE_1_2		BIT(0)
#define ICM426XX_SPI_AP_4WIRE		BIT(2)

#define ICM42607_REG_SIGNAL_PATH_RESET	0x0002
#define ICM42607_SOFT_RESET_DEV_CONFIG	BIT(4)
#define ICM42607_FIFO_FLUSH		BIT(2)

#define ICM42607_REG_DRIVE_CONFIG1	0x0003

#define ICM42607_REG_DRIVE_CONFIG2	0x0004

#define ICM42607_REG_DRIVE_CONFIG3	0x0005

/* default int configuration is pulsed mode, open drain, and active low */
#define ICM42607_REG_INT_CONFIG		0x0006
#define ICM42607_INT2_MASK		GENMASK(5, 3)
#define ICM42607_INT2_LATCHED		BIT(5)
#define ICM42607_INT2_PUSH_PULL		BIT(4)
#define ICM42607_INT2_ACTIVE_HIGH	BIT(3)
#define ICM42607_INT1_MASK		GENMASK(2, 0)
#define ICM42607_INT1_LATCHED		BIT(2)
#define ICM42607_INT1_PUSH_PULL		BIT(1)
#define ICM42607_INT1_ACTIVE_HIGH	BIT(0)

/* data are 16 bits */
#define ICM42607_REG_TEMP_DATA		0x0009

/* X + Y + Z: 3 * 16 bits */
#define ICM42607_REG_ACCEL_DATA_XYZ	0x000B
#define ICM42607_REG_GYRO_DATA_XYZ	0x0011

#define ICM42607_INVALID_DATA		-32768

/* data are 16 bits */
#define ICM42607_REG_TMST_FSYNCH	0x0017

#define ICM42607_REG_PWR_MGMT0		0x001F
#define ICM42607_ACCEL_LP_CLK_SEL	BIT(7)
#define ICM42607_IDLE			BIT(4)
#define ICM42607_GYRO_MODE_MASK		GENMASK(3, 2)
#define ICM42607_GYRO_MODE(_m)		(((_m) & 0x03) << 2)
#define ICM42607_ACCEL_MODE_MASK	GENMASK(1, 0)
#define ICM42607_ACCEL_MODE(_m)		((_m) & 0x03)

enum icm42607_sensor_mode {
	ICM42607_MODE_OFF,
	ICM42607_MODE_STANDBY,
	ICM42607_MODE_LOW_POWER,
	ICM42607_MODE_LOW_NOISE,
};

#define ICM42607_REG_GYRO_CONFIG0	0x0020
#define ICM42607_REG_ACCEL_CONFIG0	0x0021
#define ICM42607_FS_MASK		GENMASK(6, 5)
#define ICM42607_FS_SEL(_fs)		(((_fs) & 0x03) << 5)
#define ICM42607_ODR_MASK		GENMASK(3, 0)
#define ICM42607_ODR(_odr)		((_odr) & 0x0F)

#define ICM42607_REG_TEMP_CONFIG0	0x0022

enum icm42607_ui_avg {
	ICM42607_UI_AVG_2X,
	ICM42607_UI_AVG_4X,
	ICM42607_UI_AVG_8X,
	ICM42607_UI_AVG_16X,
	ICM42607_UI_AVG_32X,
	ICM42607_UI_AVG_64X,
};

enum icm42607_ui_filt_bw {
	ICM42607_UI_FILT_BW_DISABLED,
	ICM42607_UI_FILT_BW_180HZ,
	ICM42607_UI_FILT_BW_121HZ,
	ICM42607_UI_FILT_BW_73HZ,
	ICM42607_UI_FILT_BW_53HZ,
	ICM42607_UI_FILT_BW_34HZ,
	ICM42607_UI_FILT_BW_25HZ,
	ICM42607_UI_FILT_BW_16HZ,
};

#define ICM42607_REG_GYRO_CONFIG1	0x0023
#define ICM42607_REG_ACCEL_CONFIG1	0x0024
#define ICM42607_UI_AVG_MASK		GENMASK(6, 4)
#define ICM42607_UI_AVG_SET(_avg)	(((_avg) & 0x07) << 4)
#define ICM42607_UI_FILT_BW_MASK	GENMASK(2, 0)
#define ICM42607_UI_FILT_BW_SET(_filt)	((_filt) & 0x07)

#define ICM42607_REG_FIFO_CONFIG1	0x0028
#define ICM42607_FIFO_STOP_ON_FULL_MODE	BIT(1)
#define ICM42607_FIFO_BYPASS		BIT(0)
#define ICM42607_FIFO_MODE_STREAM	0x00

/* FIFO watermark value is 16 bits little endian */
#define ICM42607_REG_FIFO_WM		0x0029

#define ICM42607_REG_INT_SOURCE0	0x002B
#define ICM42607_ST_INT1_EN		BIT(7)
#define ICM42607_FSYNC_INT1_EN		BIT(6)
#define ICM42607_PLL_RDY_INT1_EN	BIT(5)
#define ICM42607_RESET_DONE_INT1_EN	BIT(4)
#define ICM42607_DRDY_INT1_EN		BIT(3)
#define ICM42607_FIFO_THS_INT1_EN	BIT(2)
#define ICM42607_FIFO_FULL_INT1_EN	BIT(1)
#define ICM42607_UI_AGC_RDY_INT1_EN	BIT(0)

#define ICM42607_REG_INTF_CONFIG0	0x0035
#define ICM42607_FIFO_COUNT_FORMAT	BIT(6)
#define ICM42607_FIFO_COUNT_ENDIAN	BIT(5)
#define ICM42607_SENSOR_DATA_ENDIAN	BIT(4)

#define ICM42607_REG_INTF_CONFIG1	0x0036
#define ICM42607_I3C_SDR_EN		BIT(3)
#define ICM42607_I3C_DDR_EN		BIT(2)
#define ICM42607_CLKSEL_MASK		GENMASK(1, 0)
#define ICM42607_CLKSEL_PLL_ENABLE	0x01

#define ICM42607_REG_INT_STATUS_DRDY	0x0039
#define ICM42607_DATA_RDY_INT		BIT(0)

#define ICM42607_REG_INT_STATUS		0x003A
#define ICM42607_ST_INT			BIT(7)
#define ICM42607_FSYNC_INT		BIT(6)
#define ICM42607_PLL_RDY_INT		BIT(5)
#define ICM42607_RESET_DONE_INT		BIT(4)
#define ICM42607_FIFO_THS_INT		BIT(2)
#define ICM42607_FIFO_FULL_INT		BIT(1)
#define ICM42607_AGC_RDY_INT		BIT(0)

/* FIFO count is 16 bits */
#define ICM42607_REG_FIFO_COUNT		0x003D

#define ICM42607_REG_FIFO_DATA		0x003F

#define ICM42607_REG_APEX_CONFIG0	0x0025
#define ICM42607_DMP_SRAM_RESET_APEX	BIT(0)

#define ICM42607_REG_APEX_CONFIG1	0x0026
#define ICM42607_DMP_ODR_50HZ		BIT(1)

#define ICM42607_REG_WHO_AM_I		0x0075
#define ICM42607_CHIP_ICM42607P		0x60

/* MREG read access registers */
#define ICM42607_REG_BLK_SEL_W		0x0079
#define ICM42607_REG_MADDR_W		0x007A
#define ICM42607_REG_M_W		0x007B

/* MREG write access registers */
#define ICM42607_REG_BLK_SEL_R		0x007C
#define ICM42607_REG_MADDR_R		0x007D
#define ICM42607_REG_M_R		0x007E

/* USER BANK MREG1 */
#define ICM42607_MREG_FIFO_CONFIG5	0x0001
#define ICM42607_FIFO_WM_GT_TH		BIT(5)
#define ICM42607_FIFO_RESUME_PARTIAL_RD	BIT(4)
#define ICM42607_FIFO_HIRES_EN		BIT(3)
#define ICM42607_FIFO_TMST_FSYNC_EN	BIT(2)
#define ICM42607_FIFO_GYRO_EN		BIT(1)
#define ICM42607_FIFO_ACCEL_EN		BIT(0)

#define ICM42607_MREG_OTP_CONFIG	0x002B
#define ICM42607_OTP_COPY_MODE_MASK	GENMASK(3, 2)
#define ICM42607_OTP_COPY_TRIM		(0x01 << 2)
#define ICM42607_OTP_COPY_ST_DATA	(0x03 << 2)

#define ICM42607_MREG_OFFSET_USER0	0x004E
#define ICM42607_MREG_OFFSET_USER1	0x004F
#define ICM42607_MREG_OFFSET_USER2	0x0050
#define ICM42607_MREG_OFFSET_USER3	0x0051
#define ICM42607_MREG_OFFSET_USER4	0x0052
#define ICM42607_MREG_OFFSET_USER5	0x0053
#define ICM42607_MREG_OFFSET_USER6	0x0054
#define ICM42607_MREG_OFFSET_USER7	0x0055
#define ICM42607_MREG_OFFSET_USER8	0x0056

/* USER BANK MREG2 */
#define ICM42607_MREG_OTP_CTRL7		0x2806
#define ICM42607_OTP_RELOAD		BIT(3)
#define ICM42607_OTP_PWR_DOWN		BIT(1)

extern const struct accelgyro_drv icm42607_drv;

void icm42607_interrupt(enum gpio_signal signal);

#endif /* __CROS_EC_ACCELGYRO_ICM42607_H */