Commit 9f70e48e authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet

docs: misc-devices/apds990x.txt: convert to ReST format

- Adjust title markup;
- Adjust identation.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/444743782e5c8b8085d8016c8be3baabe4d23b53.1592203650.git.mchehab+huawei@kernel.orgSigned-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 0e7ade47
.. SPDX-License-Identifier: GPL-2.0
======================
Kernel driver apds990x Kernel driver apds990x
====================== ======================
...@@ -50,14 +53,18 @@ chip_id ...@@ -50,14 +53,18 @@ chip_id
power_state power_state
RW - enable / disable chip. Uses counting logic RW - enable / disable chip. Uses counting logic
1 enables the chip 1 enables the chip
0 disables the chip 0 disables the chip
lux0_input lux0_input
RO - measured lux value RO - measured lux value
sysfs_notify called when threshold interrupt occurs sysfs_notify called when threshold interrupt occurs
lux0_sensor_range lux0_sensor_range
RO - lux0_input max value. Actually never reaches since sensor tends RO - lux0_input max value.
Actually never reaches since sensor tends
to saturate much before that. Real max value varies depending to saturate much before that. Real max value varies depending
on the light spectrum etc. on the light spectrum etc.
...@@ -68,7 +75,9 @@ lux0_rate_avail ...@@ -68,7 +75,9 @@ lux0_rate_avail
RO - supported measurement rates RO - supported measurement rates
lux0_calibscale lux0_calibscale
RW - calibration value. Set to neutral value by default. RW - calibration value.
Set to neutral value by default.
Output results are multiplied with calibscale / calibscale_default Output results are multiplied with calibscale / calibscale_default
value. value.
...@@ -76,16 +85,21 @@ lux0_calibscale_default ...@@ -76,16 +85,21 @@ lux0_calibscale_default
RO - neutral calibration value RO - neutral calibration value
lux0_thresh_above_value lux0_thresh_above_value
RW - HI level threshold value. All results above the value RW - HI level threshold value.
All results above the value
trigs an interrupt. 65535 (i.e. sensor_range) disables the above trigs an interrupt. 65535 (i.e. sensor_range) disables the above
interrupt. interrupt.
lux0_thresh_below_value lux0_thresh_below_value
RW - LO level threshold value. All results below the value RW - LO level threshold value.
All results below the value
trigs an interrupt. 0 disables the below interrupt. trigs an interrupt. 0 disables the below interrupt.
prox0_raw prox0_raw
RO - measured proximity value RO - measured proximity value
sysfs_notify called when threshold interrupt occurs sysfs_notify called when threshold interrupt occurs
prox0_sensor_range prox0_sensor_range
...@@ -93,11 +107,14 @@ prox0_sensor_range ...@@ -93,11 +107,14 @@ prox0_sensor_range
prox0_raw_en prox0_raw_en
RW - enable / disable proximity - uses counting logic RW - enable / disable proximity - uses counting logic
1 enables the proximity
0 disables the proximity - 1 enables the proximity
- 0 disables the proximity
prox0_reporting_mode prox0_reporting_mode
RW - trigger / periodic. In "trigger" mode the driver tells two possible RW - trigger / periodic.
In "trigger" mode the driver tells two possible
values: 0 or prox0_sensor_range value. 0 means no proximity, values: 0 or prox0_sensor_range value. 0 means no proximity,
1023 means proximity. This causes minimal number of interrupts. 1023 means proximity. This causes minimal number of interrupts.
In "periodic" mode the driver reports all values above In "periodic" mode the driver reports all values above
......
...@@ -15,6 +15,7 @@ fit into other categories. ...@@ -15,6 +15,7 @@ fit into other categories.
:maxdepth: 2 :maxdepth: 2
ad525x_dpot ad525x_dpot
apds990x
bh1770glc bh1770glc
eeprom eeprom
c2port c2port
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment