mirror of
https://github.com/edk2-porting/linux-next.git
synced 2024-12-22 20:23:57 +08:00
Input: cma3000_d0x - convert documentation into ReST format
This file require minimum adjustments to be a valid ReST file. Do it, in order to be able to parse it with Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Dmitry Torokhov <dmitry.torokhov@gmail.com>
This commit is contained in:
parent
f6e390d9f3
commit
4d0f486615
@ -1,30 +1,37 @@
|
||||
Kernel driver for CMA3000-D0x
|
||||
============================
|
||||
=============================
|
||||
|
||||
Supported chips:
|
||||
* VTI CMA3000-D0x
|
||||
|
||||
Datasheet:
|
||||
CMA3000-D0X Product Family Specification 8281000A.02.pdf
|
||||
<http://www.vti.fi/en/>
|
||||
|
||||
Author: Hemanth V <hemanthv@ti.com>
|
||||
:Author: Hemanth V <hemanthv@ti.com>
|
||||
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
CMA3000 Tri-axis accelerometer supports Motion detect, Measurement and
|
||||
Free fall modes.
|
||||
|
||||
Motion Detect Mode: Its the low power mode where interrupts are generated only
|
||||
when motion exceeds the defined thresholds.
|
||||
Motion Detect Mode:
|
||||
Its the low power mode where interrupts are generated only
|
||||
when motion exceeds the defined thresholds.
|
||||
|
||||
Measurement Mode: This mode is used to read the acceleration data on X,Y,Z
|
||||
axis and supports 400, 100, 40 Hz sample frequency.
|
||||
Measurement Mode:
|
||||
This mode is used to read the acceleration data on X,Y,Z
|
||||
axis and supports 400, 100, 40 Hz sample frequency.
|
||||
|
||||
Free fall Mode: This mode is intended to save system resources.
|
||||
Free fall Mode:
|
||||
This mode is intended to save system resources.
|
||||
|
||||
Threshold values: Chip supports defining threshold values for above modes
|
||||
which includes time and g value. Refer product specifications for more details.
|
||||
Threshold values:
|
||||
Chip supports defining threshold values for above modes
|
||||
which includes time and g value. Refer product specifications for
|
||||
more details.
|
||||
|
||||
CMA3000 chip supports mutually exclusive I2C and SPI interfaces for
|
||||
communication, currently the driver supports I2C based communication only.
|
||||
@ -38,28 +45,40 @@ Platform data need to be configured for initial default values.
|
||||
|
||||
Platform Data
|
||||
-------------
|
||||
fuzz_x: Noise on X Axis
|
||||
|
||||
fuzz_y: Noise on Y Axis
|
||||
fuzz_x:
|
||||
Noise on X Axis
|
||||
|
||||
fuzz_z: Noise on Z Axis
|
||||
fuzz_y:
|
||||
Noise on Y Axis
|
||||
|
||||
g_range: G range in milli g i.e 2000 or 8000
|
||||
fuzz_z:
|
||||
Noise on Z Axis
|
||||
|
||||
mode: Default Operating mode
|
||||
g_range:
|
||||
G range in milli g i.e 2000 or 8000
|
||||
|
||||
mdthr: Motion detect g range threshold value
|
||||
mode:
|
||||
Default Operating mode
|
||||
|
||||
mdfftmr: Motion detect and free fall time threshold value
|
||||
mdthr:
|
||||
Motion detect g range threshold value
|
||||
|
||||
ffthr: Free fall g range threshold value
|
||||
mdfftmr:
|
||||
Motion detect and free fall time threshold value
|
||||
|
||||
ffthr:
|
||||
Free fall g range threshold value
|
||||
|
||||
Input Interface
|
||||
--------------
|
||||
---------------
|
||||
|
||||
Input driver version is 1.0.0
|
||||
Input device ID: bus 0x18 vendor 0x0 product 0x0 version 0x0
|
||||
Input device name: "cma3000-accelerometer"
|
||||
Supported events:
|
||||
|
||||
Supported events::
|
||||
|
||||
Event type 0 (Sync)
|
||||
Event type 3 (Absolute)
|
||||
Event code 0 (X)
|
||||
@ -87,7 +106,8 @@ Supported events:
|
||||
Register/Platform parameters Description
|
||||
----------------------------------------
|
||||
|
||||
mode:
|
||||
mode::
|
||||
|
||||
0: power down mode
|
||||
1: 100 Hz Measurement mode
|
||||
2: 400 Hz Measurement mode
|
||||
@ -97,19 +117,23 @@ mode:
|
||||
6: 40 Hz Free fall mode
|
||||
7: Power off mode
|
||||
|
||||
grange:
|
||||
grange::
|
||||
|
||||
2000: 2000 mg or 2G Range
|
||||
8000: 8000 mg or 8G Range
|
||||
|
||||
mdthr:
|
||||
mdthr::
|
||||
|
||||
X: X * 71mg (8G Range)
|
||||
X: X * 18mg (2G Range)
|
||||
|
||||
mdfftmr:
|
||||
mdfftmr::
|
||||
|
||||
X: (X & 0x70) * 100 ms (MDTMR)
|
||||
(X & 0x0F) * 2.5 ms (FFTMR 400 Hz)
|
||||
(X & 0x0F) * 10 ms (FFTMR 100 Hz)
|
||||
|
||||
ffthr:
|
||||
ffthr::
|
||||
|
||||
X: (X >> 2) * 18mg (2G Range)
|
||||
X: (X & 0x0F) * 71 mg (8G Range)
|
||||
|
Loading…
Reference in New Issue
Block a user