From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>
Subject: [PATCH 12/22] docs: misc-devices/apds990x.txt: convert to ReST format
Date: Mon, 15 Jun 2020 08:50:17 +0200 [thread overview]
Message-ID: <444743782e5c8b8085d8016c8be3baabe4d23b53.1592203650.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1592203650.git.mchehab+huawei@kernel.org>
- Adjust title markup;
- Adjust identation.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
.../{apds990x.txt => apds990x.rst} | 31 ++++++++++++++-----
Documentation/misc-devices/index.rst | 1 +
2 files changed, 25 insertions(+), 7 deletions(-)
rename Documentation/misc-devices/{apds990x.txt => apds990x.rst} (86%)
diff --git a/Documentation/misc-devices/apds990x.txt b/Documentation/misc-devices/apds990x.rst
similarity index 86%
rename from Documentation/misc-devices/apds990x.txt
rename to Documentation/misc-devices/apds990x.rst
index 454d95d623b3..e2f75577f731 100644
--- a/Documentation/misc-devices/apds990x.txt
+++ b/Documentation/misc-devices/apds990x.rst
@@ -1,3 +1,6 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+======================
Kernel driver apds990x
======================
@@ -50,14 +53,18 @@ chip_id
power_state
RW - enable / disable chip. Uses counting logic
+
1 enables the chip
0 disables the chip
lux0_input
RO - measured lux value
+
sysfs_notify called when threshold interrupt occurs
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
on the light spectrum etc.
@@ -68,7 +75,9 @@ lux0_rate_avail
RO - supported measurement rates
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
value.
@@ -76,16 +85,21 @@ lux0_calibscale_default
RO - neutral calibration 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
interrupt.
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.
prox0_raw
RO - measured proximity value
+
sysfs_notify called when threshold interrupt occurs
prox0_sensor_range
@@ -93,11 +107,14 @@ prox0_sensor_range
prox0_raw_en
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
- 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,
1023 means proximity. This causes minimal number of interrupts.
In "periodic" mode the driver reports all values above
diff --git a/Documentation/misc-devices/index.rst b/Documentation/misc-devices/index.rst
index edf66b59f2d4..46072ce3d7ef 100644
--- a/Documentation/misc-devices/index.rst
+++ b/Documentation/misc-devices/index.rst
@@ -15,6 +15,7 @@ fit into other categories.
:maxdepth: 2
ad525x_dpot
+ apds990x
bh1770glc
eeprom
c2port
--
2.26.2
next prev parent reply other threads:[~2020-06-15 6:50 UTC|newest]
Thread overview: 33+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <cover.1592203650.git.mchehab+huawei@kernel.org>
2020-06-15 6:50 ` [PATCH 01/22] docs: dt: convert booting-without-of.txt to ReST format Mauro Carvalho Chehab
2020-06-19 20:00 ` Jonathan Corbet
2020-06-15 6:50 ` [PATCH 02/22] docs: thermal: convert cpu-idle-cooling.rst to ReST Mauro Carvalho Chehab
2020-06-19 20:02 ` Jonathan Corbet
2020-06-15 6:50 ` [PATCH 03/22] docs: crypto: convert asymmetric-keys.txt " Mauro Carvalho Chehab
2020-06-19 20:03 ` Jonathan Corbet
2020-06-15 6:50 ` [PATCH 04/22] docs: crypto: convert api-intro.txt to ReST format Mauro Carvalho Chehab
2020-06-15 6:50 ` [PATCH 05/22] docs: crypto: convert async-tx-api.txt " Mauro Carvalho Chehab
2020-06-15 6:50 ` [PATCH 06/22] docs: crypto: descore-readme.txt: convert " Mauro Carvalho Chehab
2020-06-15 6:50 ` [PATCH 07/22] docs: misc-devices/spear-pcie-gadget.txt: convert to ReST Mauro Carvalho Chehab
2020-06-15 6:50 ` [PATCH 08/22] docs: misc-devices/pci-endpoint-test.txt: " Mauro Carvalho Chehab
2020-06-15 6:50 ` [PATCH 09/22] " Mauro Carvalho Chehab
2020-06-15 6:50 ` [PATCH 10/22] docs: misc-devices/c2port.txt: convert to ReST format Mauro Carvalho Chehab
2020-06-15 6:50 ` [PATCH 11/22] docs: misc-devices/bh1770glc.txt: convert to ReST Mauro Carvalho Chehab
2020-06-15 6:50 ` Mauro Carvalho Chehab [this message]
2020-06-15 6:50 ` [PATCH 13/22] docs: pci: endpoint/function/binding/pci-test.txt " Mauro Carvalho Chehab
2020-06-15 6:50 ` [PATCH 14/22] docs: arm64: convert perf.txt to ReST format Mauro Carvalho Chehab
2020-06-15 6:50 ` [PATCH 15/22] docs: powerpc: convert vcpudispatch_stats.txt to ReST Mauro Carvalho Chehab
2020-06-15 6:50 ` [PATCH 16/22] docs: sh: convert new-machine.txt " Mauro Carvalho Chehab
2020-06-15 6:50 ` [PATCH 17/22] docs: sh: convert register-banks.txt " Mauro Carvalho Chehab
2020-06-15 6:50 ` [PATCH 18/22] docs: trace: ring-buffer-design.txt: convert to ReST format Mauro Carvalho Chehab
2020-06-15 17:48 ` Joe Perches
2020-06-16 7:19 ` Mauro Carvalho Chehab
2020-06-19 20:13 ` Jonathan Corbet
2020-06-19 20:41 ` Steven Rostedt
2020-06-23 8:24 ` Mauro Carvalho Chehab
2020-06-15 6:50 ` [PATCH 19/22] docs: move other kAPI documents to core-api Mauro Carvalho Chehab
2020-06-15 6:50 ` [PATCH 20/22] docs: move remaining stuff under Documentation/*.txt to Documentation/staging Mauro Carvalho Chehab
2020-06-15 14:03 ` Masami Hiramatsu
2020-06-15 16:18 ` Mathieu Poirier
2020-06-15 6:50 ` [PATCH 21/22] docs: staging: don't use literalinclude Mauro Carvalho Chehab
2020-06-15 6:50 ` [PATCH 22/22] docs: staging: use small font for literal includes Mauro Carvalho Chehab
2020-06-19 20:18 ` Jonathan Corbet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=444743782e5c8b8085d8016c8be3baabe4d23b53.1592203650.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).