Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
docs: misc-devices/apds990x.txt: convert to ReST format
- Adjust title markup;
- Adjust identation.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/444743782e5c8b8085d8016c8be3baabe4d23b53.1592203650.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
authored by
Mauro Carvalho Chehab
and committed by
Jonathan Corbet
9f70e48e
0e7ade47
+25
-7
+24
-7
Documentation/misc-devices/apds990x.txt
Documentation/misc-devices/apds990x.rst
+24
-7
Documentation/misc-devices/apds990x.txt
Documentation/misc-devices/apds990x.rst
···
1
+
.. SPDX-License-Identifier: GPL-2.0
2
+
3
+
======================
1
4
Kernel driver apds990x
2
5
======================
3
6
···
53
50
54
51
power_state
55
52
RW - enable / disable chip. Uses counting logic
53
+
56
54
1 enables the chip
57
55
0 disables the chip
58
56
lux0_input
59
57
RO - measured lux value
58
+
60
59
sysfs_notify called when threshold interrupt occurs
61
60
62
61
lux0_sensor_range
63
-
RO - lux0_input max value. Actually never reaches since sensor tends
62
+
RO - lux0_input max value.
63
+
64
+
Actually never reaches since sensor tends
64
65
to saturate much before that. Real max value varies depending
65
66
on the light spectrum etc.
66
67
···
75
68
RO - supported measurement rates
76
69
77
70
lux0_calibscale
78
-
RW - calibration value. Set to neutral value by default.
71
+
RW - calibration value.
72
+
73
+
Set to neutral value by default.
79
74
Output results are multiplied with calibscale / calibscale_default
80
75
value.
81
76
···
85
76
RO - neutral calibration value
86
77
87
78
lux0_thresh_above_value
88
-
RW - HI level threshold value. All results above the value
79
+
RW - HI level threshold value.
80
+
81
+
All results above the value
89
82
trigs an interrupt. 65535 (i.e. sensor_range) disables the above
90
83
interrupt.
91
84
92
85
lux0_thresh_below_value
93
-
RW - LO level threshold value. All results below the value
86
+
RW - LO level threshold value.
87
+
88
+
All results below the value
94
89
trigs an interrupt. 0 disables the below interrupt.
95
90
96
91
prox0_raw
97
92
RO - measured proximity value
93
+
98
94
sysfs_notify called when threshold interrupt occurs
99
95
100
96
prox0_sensor_range
···
107
93
108
94
prox0_raw_en
109
95
RW - enable / disable proximity - uses counting logic
110
-
1 enables the proximity
111
-
0 disables the proximity
96
+
97
+
- 1 enables the proximity
98
+
- 0 disables the proximity
112
99
113
100
prox0_reporting_mode
114
-
RW - trigger / periodic. In "trigger" mode the driver tells two possible
101
+
RW - trigger / periodic.
102
+
103
+
In "trigger" mode the driver tells two possible
115
104
values: 0 or prox0_sensor_range value. 0 means no proximity,
116
105
1023 means proximity. This causes minimal number of interrupts.
117
106
In "periodic" mode the driver reports all values above