Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
docs: iio: adxl345: grammar and formatting cleanups
Correct several grammatical errors, typos, and pluralization issues
throughout the ADXL345 documentation.
Key changes include:
- Changing 'generic' to 'general-purpose'
- Correcting 'axis' to 'axes' in multiple tables and descriptions
- Improving phrasing in the device attributes section
- Fixing 'latent' to 'latency' in usage examples
- Sorting the existing event attribute table alphabetically for
better readability and to establish a clean baseline for future
additions.
Suggested-by: David Lechner <dlechner@baylibre.com>
Signed-off-by: Taha Ed-Dafili <0rayn.dev@gmail.com>
Reviewed-by: David Lechner <dlechner@baylibre.com>
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
authored by
Taha Ed-Dafili
and committed by
Jonathan Cameron
a1fe33e0
8021729a
+20
-20
+20
-20
Documentation/iio/adxl345.rst
+20
-20
Documentation/iio/adxl345.rst
···
12
12
* `ADXL345 <https://www.analog.com/ADXL345>`_
13
13
* `ADXL375 <https://www.analog.com/ADXL375>`_
14
14
15
-
The ADXL345 is a generic purpose low power, 3-axis accelerometer with selectable
15
+
The ADXL345 is a general-purpose, low-power, 3-axis accelerometer with selectable
16
16
measurement ranges. The ADXL345 supports the ±2 g, ±4 g, ±8 g, and ±16 g ranges.
17
17
18
18
2. Device Attributes
19
19
====================
20
20
21
-
Each IIO device, has a device folder under ``/sys/bus/iio/devices/iio:deviceX``,
21
+
Each IIO device has a device folder under ``/sys/bus/iio/devices/iio:deviceX``,
22
22
where X is the IIO index of the device. Under these folders reside a set of
23
23
device files, depending on the characteristics and features of the hardware
24
-
device in questions. These files are consistently generalized and documented in
24
+
device in question. These files are consistently generalized and documented in
25
25
the IIO ABI documentation.
26
26
27
27
The following table shows the ADXL345 related device files, found in the
···
42
42
+-------------------------------------------+----------------------------------------------------------+
43
43
| in_accel_x_raw | Raw X-axis accelerometer channel value. |
44
44
+-------------------------------------------+----------------------------------------------------------+
45
-
| in_accel_y_calibbias | y-axis acceleration offset correction |
45
+
| in_accel_y_calibbias | Y-axis acceleration offset correction |
46
46
+-------------------------------------------+----------------------------------------------------------+
47
47
| in_accel_y_raw | Raw Y-axis accelerometer channel value. |
48
48
+-------------------------------------------+----------------------------------------------------------+
···
68
68
+-------------------------------------+---------------------------+
69
69
| Channel type | Measurement unit |
70
70
+-------------------------------------+---------------------------+
71
-
| Acceleration on X, Y, and Z axis | Meters per second squared |
71
+
| Acceleration on X, Y, and Z axes | Meters per second squared |
72
72
+-------------------------------------+---------------------------+
73
73
74
74
Sensor Events
···
78
78
driver supports either none or a single active interrupt (INT) line, selectable
79
79
from the two available options: INT1 or INT2. The active INT line should be
80
80
specified in the device tree. If no INT line is configured, the sensor defaults
81
-
to FIFO bypass mode, where event detection is disabled and only X, Y, and Z axis
82
-
measurements are available.
81
+
to FIFO bypass mode, where event detection is disabled and only individual
82
+
X, Y, and Z axis measurements are available.
83
83
84
84
The table below lists the ADXL345-related device files located in the
85
85
device-specific path: ``/sys/bus/iio/devices/iio:deviceX/events``.
···
90
90
+---------------------------------------------+---------------------------------------------+
91
91
| Event handle | Description |
92
92
+---------------------------------------------+---------------------------------------------+
93
-
| in_accel_gesture_doubletap_en | Enable double tap detection on all axis |
93
+
| in_accel_gesture_doubletap_en | Enable double tap detection on all axes |
94
94
+---------------------------------------------+---------------------------------------------+
95
95
| in_accel_gesture_doubletap_reset_timeout | Double tap window in [us] |
96
96
+---------------------------------------------+---------------------------------------------+
97
-
| in_accel_gesture_doubletap_tap2_min_delay | Double tap latent in [us] |
97
+
| in_accel_gesture_doubletap_tap2_min_delay | Double tap latency in [us] |
98
98
+---------------------------------------------+---------------------------------------------+
99
99
| in_accel_gesture_singletap_timeout | Single tap duration in [us] |
100
100
+---------------------------------------------+---------------------------------------------+
101
101
| in_accel_gesture_singletap_value | Single tap threshold value in 62.5/LSB |
102
102
+---------------------------------------------+---------------------------------------------+
103
-
| in_accel_mag_falling_period | Inactivity time in seconds |
104
-
+---------------------------------------------+---------------------------------------------+
105
-
| in_accel_mag_falling_value | Inactivity threshold value in 62.5/LSB |
106
-
+---------------------------------------------+---------------------------------------------+
107
-
| in_accel_mag_adaptive_rising_en | Enable AC coupled activity on X axis |
108
-
+---------------------------------------------+---------------------------------------------+
109
103
| in_accel_mag_adaptive_falling_period | AC coupled inactivity time in seconds |
110
104
+---------------------------------------------+---------------------------------------------+
111
105
| in_accel_mag_adaptive_falling_value | AC coupled inactivity threshold in 62.5/LSB |
112
106
+---------------------------------------------+---------------------------------------------+
107
+
| in_accel_mag_adaptive_rising_en | Enable AC coupled activity on X axis |
108
+
+---------------------------------------------+---------------------------------------------+
113
109
| in_accel_mag_adaptive_rising_value | AC coupled activity threshold in 62.5/LSB |
110
+
+---------------------------------------------+---------------------------------------------+
111
+
| in_accel_mag_falling_period | Inactivity time in seconds |
112
+
+---------------------------------------------+---------------------------------------------+
113
+
| in_accel_mag_falling_value | Inactivity threshold value in 62.5/LSB |
114
114
+---------------------------------------------+---------------------------------------------+
115
115
| in_accel_mag_rising_en | Enable activity detection on X axis |
116
116
+---------------------------------------------+---------------------------------------------+
117
117
| in_accel_mag_rising_value | Activity threshold value in 62.5/LSB |
118
118
+---------------------------------------------+---------------------------------------------+
119
+
| in_accel_x&y&z_mag_adaptive_falling_en | Enable AC coupled inactivity on all axes |
120
+
+---------------------------------------------+---------------------------------------------+
121
+
| in_accel_x&y&z_mag_falling_en | Enable inactivity detection on all axes |
122
+
+---------------------------------------------+---------------------------------------------+
119
123
| in_accel_x_gesture_singletap_en | Enable single tap detection on X axis |
120
-
+---------------------------------------------+---------------------------------------------+
121
-
| in_accel_x&y&z_mag_falling_en | Enable inactivity detection on all axis |
122
-
+---------------------------------------------+---------------------------------------------+
123
-
| in_accel_x&y&z_mag_adaptive_falling_en | Enable AC coupled inactivity on all axis |
124
124
+---------------------------------------------+---------------------------------------------+
125
125
| in_accel_y_gesture_singletap_en | Enable single tap detection on Y axis |
126
126
+---------------------------------------------+---------------------------------------------+
···
330
330
## doubletap, window [us]
331
331
root:/sys/bus/iio/devices/iio:device0> echo 0.025 > ./events/in_accel_gesture_doubletap_reset_timeout
332
332
333
-
## doubletap, latent [us]
333
+
## doubletap, latency [us]
334
334
root:/sys/bus/iio/devices/iio:device0> echo 0.025 > ./events/in_accel_gesture_doubletap_tap2_min_delay
335
335
336
336
## AC coupled activity, enable