Commit 83af1bd81f7b7fb31a681b0c80790866f190d23a
Committed by
Guenter Roeck
Guenter Roeck
1 parent
029756d0b8
Exists in
master
and in
20 other branches
hwmon: lis3: Short explanations of platform data fields
Short documentation at kernel doc format. Signed-off-by: Samu Onkalo <samu.p.onkalo@nokia.com> Acked-by: Jonathan Cameron <jic23@cam.ac.uk> Acked-by: Eric Piel <eric.piel@tremplin-utc.net> Signed-off-by: Guenter Roeck <guenter.roeck@ericsson.com>
Showing 1 changed file with 46 additions and 0 deletions Side-by-side Diff
include/linux/lis3lv02d.h
| 1 | 1 | #ifndef __LIS3LV02D_H_ |
| 2 | 2 | #define __LIS3LV02D_H_ |
| 3 | 3 | |
| 4 | +/** | |
| 5 | + * struct lis3lv02d_platform_data - lis3 chip family platform data | |
| 6 | + * @click_flags: Click detection unit configuration | |
| 7 | + * @click_thresh_x: Click detection unit x axis threshold | |
| 8 | + * @click_thresh_y: Click detection unit y axis threshold | |
| 9 | + * @click_thresh_z: Click detection unit z axis threshold | |
| 10 | + * @click_time_limit: Click detection unit time parameter | |
| 11 | + * @click_latency: Click detection unit latency parameter | |
| 12 | + * @click_window: Click detection unit window parameter | |
| 13 | + * @irq_cfg: On chip irq source and type configuration (click / | |
| 14 | + * data available / wake up, open drain, polarity) | |
| 15 | + * @irq_flags1: Additional irq triggering flags for irq channel 0 | |
| 16 | + * @irq_flags2: Additional irq triggering flags for irq channel 1 | |
| 17 | + * @duration1: Wake up unit 1 duration parameter | |
| 18 | + * @duration2: Wake up unit 2 duration parameter | |
| 19 | + * @wakeup_flags: Wake up unit 1 flags | |
| 20 | + * @wakeup_thresh: Wake up unit 1 threshold value | |
| 21 | + * @wakeup_flags2: Wake up unit 2 flags | |
| 22 | + * @wakeup_thresh2: Wake up unit 2 threshold value | |
| 23 | + * @hipass_ctrl: High pass filter control (enable / disable, cut off | |
| 24 | + * frequency) | |
| 25 | + * @axis_x: Sensor orientation remapping for x-axis | |
| 26 | + * @axis_y: Sensor orientation remapping for y-axis | |
| 27 | + * @axis_z: Sensor orientation remapping for z-axis | |
| 28 | + * @driver_features: Enable bits for different features. Disabled by default | |
| 29 | + * @default_rate: Default sampling rate. 0 means reset default | |
| 30 | + * @setup_resources: Interrupt line setup call back function | |
| 31 | + * @release_resources: Interrupt line release call back function | |
| 32 | + * @st_min_limits[3]: Selftest acceptance minimum values | |
| 33 | + * @st_max_limits[3]: Selftest acceptance maximum values | |
| 34 | + * @irq2: Irq line 2 number | |
| 35 | + * | |
| 36 | + * Platform data is used to setup the sensor chip. Meaning of the different | |
| 37 | + * chip features can be found from the data sheet. It is publicly available | |
| 38 | + * at www.st.com web pages. Currently the platform data is used | |
| 39 | + * only for the 8 bit device. The 8 bit device has two wake up / free fall | |
| 40 | + * detection units and click detection unit. There are plenty of ways to | |
| 41 | + * configure the chip which makes is quite hard to explain deeper meaning of | |
| 42 | + * the fields here. Behaviour of the detection blocks varies heavily depending | |
| 43 | + * on the configuration. For example, interrupt detection block can use high | |
| 44 | + * pass filtered data which makes it react to the changes in the acceleration. | |
| 45 | + * Irq_flags can be used to enable interrupt detection on the both edges. | |
| 46 | + * With proper chip configuration this produces interrupt when some trigger | |
| 47 | + * starts and when it goes away. | |
| 48 | + */ | |
| 49 | + | |
| 4 | 50 | struct lis3lv02d_platform_data { |
| 5 | 51 | /* please note: the 'click' feature is only supported for |
| 6 | 52 | * LIS[32]02DL variants of the chip and will be ignored for |