1 | /* SPDX-License-Identifier: GPL-2.0-or-later */ |
2 | /* |
3 | * include/linux/input/adxl34x.h |
4 | * |
5 | * Digital Accelerometer characteristics are highly application specific |
6 | * and may vary between boards and models. The platform_data for the |
7 | * device's "struct device" holds this information. |
8 | * |
9 | * Copyright 2009 Analog Devices Inc. |
10 | */ |
11 | |
12 | #ifndef __LINUX_INPUT_ADXL34X_H__ |
13 | #define __LINUX_INPUT_ADXL34X_H__ |
14 | |
15 | #include <linux/input.h> |
16 | |
17 | struct adxl34x_platform_data { |
18 | |
19 | /* |
20 | * X,Y,Z Axis Offset: |
21 | * offer user offset adjustments in twoscompliment |
22 | * form with a scale factor of 15.6 mg/LSB (i.e. 0x7F = +2 g) |
23 | */ |
24 | |
25 | s8 x_axis_offset; |
26 | s8 y_axis_offset; |
27 | s8 z_axis_offset; |
28 | |
29 | /* |
30 | * TAP_X/Y/Z Enable: Setting TAP_X, Y, or Z Enable enables X, |
31 | * Y, or Z participation in Tap detection. A '0' excludes the |
32 | * selected axis from participation in Tap detection. |
33 | * Setting the SUPPRESS bit suppresses Double Tap detection if |
34 | * acceleration greater than tap_threshold is present during the |
35 | * tap_latency period, i.e. after the first tap but before the |
36 | * opening of the second tap window. |
37 | */ |
38 | |
39 | #define ADXL_SUPPRESS (1 << 3) |
40 | #define ADXL_TAP_X_EN (1 << 2) |
41 | #define ADXL_TAP_Y_EN (1 << 1) |
42 | #define ADXL_TAP_Z_EN (1 << 0) |
43 | |
44 | u8 tap_axis_control; |
45 | |
46 | /* |
47 | * tap_threshold: |
48 | * holds the threshold value for tap detection/interrupts. |
49 | * The data format is unsigned. The scale factor is 62.5 mg/LSB |
50 | * (i.e. 0xFF = +16 g). A zero value may result in undesirable |
51 | * behavior if Tap/Double Tap is enabled. |
52 | */ |
53 | |
54 | u8 tap_threshold; |
55 | |
56 | /* |
57 | * tap_duration: |
58 | * is an unsigned time value representing the maximum |
59 | * time that an event must be above the tap_threshold threshold |
60 | * to qualify as a tap event. The scale factor is 625 us/LSB. A zero |
61 | * value will prevent Tap/Double Tap functions from working. |
62 | */ |
63 | |
64 | u8 tap_duration; |
65 | |
66 | /* |
67 | * tap_latency: |
68 | * is an unsigned time value representing the wait time |
69 | * from the detection of a tap event to the opening of the time |
70 | * window tap_window for a possible second tap event. The scale |
71 | * factor is 1.25 ms/LSB. A zero value will disable the Double Tap |
72 | * function. |
73 | */ |
74 | |
75 | u8 tap_latency; |
76 | |
77 | /* |
78 | * tap_window: |
79 | * is an unsigned time value representing the amount |
80 | * of time after the expiration of tap_latency during which a second |
81 | * tap can begin. The scale factor is 1.25 ms/LSB. A zero value will |
82 | * disable the Double Tap function. |
83 | */ |
84 | |
85 | u8 tap_window; |
86 | |
87 | /* |
88 | * act_axis_control: |
89 | * X/Y/Z Enable: A '1' enables X, Y, or Z participation in activity |
90 | * or inactivity detection. A '0' excludes the selected axis from |
91 | * participation. If all of the axes are excluded, the function is |
92 | * disabled. |
93 | * AC/DC: A '0' = DC coupled operation and a '1' = AC coupled |
94 | * operation. In DC coupled operation, the current acceleration is |
95 | * compared with activity_threshold and inactivity_threshold directly |
96 | * to determine whether activity or inactivity is detected. In AC |
97 | * coupled operation for activity detection, the acceleration value |
98 | * at the start of activity detection is taken as a reference value. |
99 | * New samples of acceleration are then compared to this |
100 | * reference value and if the magnitude of the difference exceeds |
101 | * activity_threshold the device will trigger an activity interrupt. In |
102 | * AC coupled operation for inactivity detection, a reference value |
103 | * is used again for comparison and is updated whenever the |
104 | * device exceeds the inactivity threshold. Once the reference |
105 | * value is selected, the device compares the magnitude of the |
106 | * difference between the reference value and the current |
107 | * acceleration with inactivity_threshold. If the difference is below |
108 | * inactivity_threshold for a total of inactivity_time, the device is |
109 | * considered inactive and the inactivity interrupt is triggered. |
110 | */ |
111 | |
112 | #define ADXL_ACT_ACDC (1 << 7) |
113 | #define ADXL_ACT_X_EN (1 << 6) |
114 | #define ADXL_ACT_Y_EN (1 << 5) |
115 | #define ADXL_ACT_Z_EN (1 << 4) |
116 | #define ADXL_INACT_ACDC (1 << 3) |
117 | #define ADXL_INACT_X_EN (1 << 2) |
118 | #define ADXL_INACT_Y_EN (1 << 1) |
119 | #define ADXL_INACT_Z_EN (1 << 0) |
120 | |
121 | u8 act_axis_control; |
122 | |
123 | /* |
124 | * activity_threshold: |
125 | * holds the threshold value for activity detection. |
126 | * The data format is unsigned. The scale factor is |
127 | * 62.5 mg/LSB. A zero value may result in undesirable behavior if |
128 | * Activity interrupt is enabled. |
129 | */ |
130 | |
131 | u8 activity_threshold; |
132 | |
133 | /* |
134 | * inactivity_threshold: |
135 | * holds the threshold value for inactivity |
136 | * detection. The data format is unsigned. The scale |
137 | * factor is 62.5 mg/LSB. A zero value may result in undesirable |
138 | * behavior if Inactivity interrupt is enabled. |
139 | */ |
140 | |
141 | u8 inactivity_threshold; |
142 | |
143 | /* |
144 | * inactivity_time: |
145 | * is an unsigned time value representing the |
146 | * amount of time that acceleration must be below the value in |
147 | * inactivity_threshold for inactivity to be declared. The scale factor |
148 | * is 1 second/LSB. Unlike the other interrupt functions, which |
149 | * operate on unfiltered data, the inactivity function operates on the |
150 | * filtered output data. At least one output sample must be |
151 | * generated for the inactivity interrupt to be triggered. This will |
152 | * result in the function appearing un-responsive if the |
153 | * inactivity_time register is set with a value less than the time |
154 | * constant of the Output Data Rate. A zero value will result in an |
155 | * interrupt when the output data is below inactivity_threshold. |
156 | */ |
157 | |
158 | u8 inactivity_time; |
159 | |
160 | /* |
161 | * free_fall_threshold: |
162 | * holds the threshold value for Free-Fall detection. |
163 | * The data format is unsigned. The root-sum-square(RSS) value |
164 | * of all axes is calculated and compared to the value in |
165 | * free_fall_threshold to determine if a free fall event may be |
166 | * occurring. The scale factor is 62.5 mg/LSB. A zero value may |
167 | * result in undesirable behavior if Free-Fall interrupt is |
168 | * enabled. Values between 300 and 600 mg (0x05 to 0x09) are |
169 | * recommended. |
170 | */ |
171 | |
172 | u8 free_fall_threshold; |
173 | |
174 | /* |
175 | * free_fall_time: |
176 | * is an unsigned time value representing the minimum |
177 | * time that the RSS value of all axes must be less than |
178 | * free_fall_threshold to generate a Free-Fall interrupt. The |
179 | * scale factor is 5 ms/LSB. A zero value may result in |
180 | * undesirable behavior if Free-Fall interrupt is enabled. |
181 | * Values between 100 to 350 ms (0x14 to 0x46) are recommended. |
182 | */ |
183 | |
184 | u8 free_fall_time; |
185 | |
186 | /* |
187 | * data_rate: |
188 | * Selects device bandwidth and output data rate. |
189 | * RATE = 3200 Hz / (2^(15 - x)). Default value is 0x0A, or 100 Hz |
190 | * Output Data Rate. An Output Data Rate should be selected that |
191 | * is appropriate for the communication protocol and frequency |
192 | * selected. Selecting too high of an Output Data Rate with a low |
193 | * communication speed will result in samples being discarded. |
194 | */ |
195 | |
196 | u8 data_rate; |
197 | |
198 | /* |
199 | * data_range: |
200 | * FULL_RES: When this bit is set with the device is |
201 | * in Full-Resolution Mode, where the output resolution increases |
202 | * with RANGE to maintain a 4 mg/LSB scale factor. When this |
203 | * bit is cleared the device is in 10-bit Mode and RANGE determine the |
204 | * maximum g-Range and scale factor. |
205 | */ |
206 | |
207 | #define ADXL_FULL_RES (1 << 3) |
208 | #define ADXL_RANGE_PM_2g 0 |
209 | #define ADXL_RANGE_PM_4g 1 |
210 | #define ADXL_RANGE_PM_8g 2 |
211 | #define ADXL_RANGE_PM_16g 3 |
212 | |
213 | u8 data_range; |
214 | |
215 | /* |
216 | * low_power_mode: |
217 | * A '0' = Normal operation and a '1' = Reduced |
218 | * power operation with somewhat higher noise. |
219 | */ |
220 | |
221 | u8 low_power_mode; |
222 | |
223 | /* |
224 | * power_mode: |
225 | * LINK: A '1' with both the activity and inactivity functions |
226 | * enabled will delay the start of the activity function until |
227 | * inactivity is detected. Once activity is detected, inactivity |
228 | * detection will begin and prevent the detection of activity. This |
229 | * bit serially links the activity and inactivity functions. When '0' |
230 | * the inactivity and activity functions are concurrent. Additional |
231 | * information can be found in the ADXL34x datasheet's Application |
232 | * section under Link Mode. |
233 | * AUTO_SLEEP: A '1' sets the ADXL34x to switch to Sleep Mode |
234 | * when inactivity (acceleration has been below inactivity_threshold |
235 | * for at least inactivity_time) is detected and the LINK bit is set. |
236 | * A '0' disables automatic switching to Sleep Mode. See the |
237 | * Sleep Bit section of the ADXL34x datasheet for more information. |
238 | */ |
239 | |
240 | #define ADXL_LINK (1 << 5) |
241 | #define ADXL_AUTO_SLEEP (1 << 4) |
242 | |
243 | u8 power_mode; |
244 | |
245 | /* |
246 | * fifo_mode: |
247 | * BYPASS The FIFO is bypassed |
248 | * FIFO FIFO collects up to 32 values then stops collecting data |
249 | * STREAM FIFO holds the last 32 data values. Once full, the FIFO's |
250 | * oldest data is lost as it is replaced with newer data |
251 | * |
252 | * DEFAULT should be ADXL_FIFO_STREAM |
253 | */ |
254 | |
255 | #define ADXL_FIFO_BYPASS 0 |
256 | #define ADXL_FIFO_FIFO 1 |
257 | #define ADXL_FIFO_STREAM 2 |
258 | |
259 | u8 fifo_mode; |
260 | |
261 | /* |
262 | * watermark: |
263 | * The Watermark feature can be used to reduce the interrupt load |
264 | * of the system. The FIFO fills up to the value stored in watermark |
265 | * [1..32] and then generates an interrupt. |
266 | * A '0' disables the watermark feature. |
267 | */ |
268 | |
269 | u8 watermark; |
270 | |
271 | /* |
272 | * When acceleration measurements are received from the ADXL34x |
273 | * events are sent to the event subsystem. The following settings |
274 | * select the event type and event code for new x, y and z axis data |
275 | * respectively. |
276 | */ |
277 | u32 ev_type; /* EV_ABS or EV_REL */ |
278 | |
279 | u32 ev_code_x; /* ABS_X,Y,Z or REL_X,Y,Z */ |
280 | u32 ev_code_y; /* ABS_X,Y,Z or REL_X,Y,Z */ |
281 | u32 ev_code_z; /* ABS_X,Y,Z or REL_X,Y,Z */ |
282 | |
283 | /* |
284 | * A valid BTN or KEY Code; use tap_axis_control to disable |
285 | * event reporting |
286 | */ |
287 | |
288 | u32 ev_code_tap[3]; /* EV_KEY {X-Axis, Y-Axis, Z-Axis} */ |
289 | |
290 | /* |
291 | * A valid BTN or KEY Code for Free-Fall or Activity enables |
292 | * input event reporting. A '0' disables the Free-Fall or |
293 | * Activity reporting. |
294 | */ |
295 | |
296 | u32 ev_code_ff; /* EV_KEY */ |
297 | u32 ev_code_act_inactivity; /* EV_KEY */ |
298 | |
299 | /* |
300 | * Use ADXL34x INT2 pin instead of INT1 pin for interrupt output |
301 | */ |
302 | u8 use_int2; |
303 | |
304 | /* |
305 | * ADXL346 only ORIENTATION SENSING feature |
306 | * The orientation function of the ADXL346 reports both 2-D and |
307 | * 3-D orientation concurrently. |
308 | */ |
309 | |
310 | #define ADXL_EN_ORIENTATION_2D 1 |
311 | #define ADXL_EN_ORIENTATION_3D 2 |
312 | #define ADXL_EN_ORIENTATION_2D_3D 3 |
313 | |
314 | u8 orientation_enable; |
315 | |
316 | /* |
317 | * The width of the deadzone region between two or more |
318 | * orientation positions is determined by setting the Deadzone |
319 | * value. The deadzone region size can be specified with a |
320 | * resolution of 3.6deg. The deadzone angle represents the total |
321 | * angle where the orientation is considered invalid. |
322 | */ |
323 | |
324 | #define ADXL_DEADZONE_ANGLE_0p0 0 /* !!!0.0 [deg] */ |
325 | #define ADXL_DEADZONE_ANGLE_3p6 1 /* 3.6 [deg] */ |
326 | #define ADXL_DEADZONE_ANGLE_7p2 2 /* 7.2 [deg] */ |
327 | #define ADXL_DEADZONE_ANGLE_10p8 3 /* 10.8 [deg] */ |
328 | #define ADXL_DEADZONE_ANGLE_14p4 4 /* 14.4 [deg] */ |
329 | #define ADXL_DEADZONE_ANGLE_18p0 5 /* 18.0 [deg] */ |
330 | #define ADXL_DEADZONE_ANGLE_21p6 6 /* 21.6 [deg] */ |
331 | #define ADXL_DEADZONE_ANGLE_25p2 7 /* 25.2 [deg] */ |
332 | |
333 | u8 deadzone_angle; |
334 | |
335 | /* |
336 | * To eliminate most human motion such as walking or shaking, |
337 | * a Divisor value should be selected to effectively limit the |
338 | * orientation bandwidth. Set the depth of the filter used to |
339 | * low-pass filter the measured acceleration for stable |
340 | * orientation sensing |
341 | */ |
342 | |
343 | #define ADXL_LP_FILTER_DIVISOR_2 0 |
344 | #define ADXL_LP_FILTER_DIVISOR_4 1 |
345 | #define ADXL_LP_FILTER_DIVISOR_8 2 |
346 | #define ADXL_LP_FILTER_DIVISOR_16 3 |
347 | #define ADXL_LP_FILTER_DIVISOR_32 4 |
348 | #define ADXL_LP_FILTER_DIVISOR_64 5 |
349 | #define ADXL_LP_FILTER_DIVISOR_128 6 |
350 | #define ADXL_LP_FILTER_DIVISOR_256 7 |
351 | |
352 | u8 divisor_length; |
353 | |
354 | u32 ev_codes_orient_2d[4]; /* EV_KEY {+X, -X, +Y, -Y} */ |
355 | u32 ev_codes_orient_3d[6]; /* EV_KEY {+Z, +Y, +X, -X, -Y, -Z} */ |
356 | }; |
357 | #endif |
358 | |