From: rentao.bupt@gmail.com
To: Jean Delvare <jdelvare@suse.com>,
Guenter Roeck <linux@roeck-us.net>,
Jonathan Corbet <corbet@lwn.net>,
Alexei Starovoitov <ast@kernel.org>,
Daniel Borkmann <daniel@iogearbox.net>,
"David S . Miller" <davem@davemloft.net>,
Jakub Kicinski <kuba@kernel.org>,
Jesper Dangaard Brouer <hawk@kernel.org>,
John Fastabend <john.fastabend@gmail.com>,
linux-hwmon@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, netdev@vger.kernel.org,
bpf@vger.kernel.org, openbmc@lists.ozlabs.org, taoren@fb.com,
mikechoi@fb.com
Cc: Tao Ren <rentao.bupt@gmail.com>
Subject: [PATCH v2 2/2] docs: hwmon: Document max127 driver
Date: Wed, 18 Nov 2020 15:09:29 -0800 [thread overview]
Message-ID: <20201118230929.18147-3-rentao.bupt@gmail.com> (raw)
In-Reply-To: <20201118230929.18147-1-rentao.bupt@gmail.com>
From: Tao Ren <rentao.bupt@gmail.com>
Add documentation for the max127 hardware monitoring driver.
Signed-off-by: Tao Ren <rentao.bupt@gmail.com>
---
Changes in v2:
- add more description for min/max sysfs nodes.
- convert values from volt to millivolt in the document.
Documentation/hwmon/index.rst | 1 +
Documentation/hwmon/max127.rst | 45 ++++++++++++++++++++++++++++++++++
2 files changed, 46 insertions(+)
create mode 100644 Documentation/hwmon/max127.rst
diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst
index 408760d13813..0a07b6000c20 100644
--- a/Documentation/hwmon/index.rst
+++ b/Documentation/hwmon/index.rst
@@ -111,6 +111,7 @@ Hardware Monitoring Kernel Drivers
ltc4245
ltc4260
ltc4261
+ max127
max16064
max16065
max1619
diff --git a/Documentation/hwmon/max127.rst b/Documentation/hwmon/max127.rst
new file mode 100644
index 000000000000..dc192dd9c37c
--- /dev/null
+++ b/Documentation/hwmon/max127.rst
@@ -0,0 +1,45 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+Kernel driver max127
+====================
+
+Author:
+
+ * Tao Ren <rentao.bupt@gmail.com>
+
+Supported chips:
+
+ * Maxim MAX127
+
+ Prefix: 'max127'
+
+ Datasheet: https://datasheets.maximintegrated.com/en/ds/MAX127-MAX128.pdf
+
+Description
+-----------
+
+The MAX127 is a multirange, 12-bit data acquisition system (DAS) providing
+8 analog input channels that are independently software programmable for
+a variety of ranges. The available ranges are {0,5V}, {0,10V}, {-5,5V}
+and {-10,10V}.
+
+The MAX127 features a 2-wire, I2C-compatible serial interface that allows
+communication among multiple devices using SDA and SCL lines.
+
+Sysfs interface
+---------------
+
+ ============== ==============================================================
+ in[0-7]_input The input voltage (in mV) of the corresponding channel.
+ RO
+
+ in[0-7]_min The lower input limit (in mV) for the corresponding channel.
+ ADC range and LSB will be updated when the limit is changed.
+ For the MAX127, it will be adjusted to -10000, -5000, or 0.
+ RW
+
+ in[0-7]_max The higher input limit (in mV) for the corresponding channel.
+ ADC range and LSB will be updated when the limit is changed.
+ For the MAX127, it will be adjusted to 0, 5000, or 10000.
+ RW
+ ============== ==============================================================
--
2.17.1
next prev parent reply other threads:[~2020-11-18 23:10 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-18 23:09 [PATCH v2 0/2] hwmon: (max127) Add Maxim MAX127 hardware monitoring rentao.bupt
2020-11-18 23:09 ` [PATCH v2 1/2] hwmon: (max127) Add Maxim MAX127 hardware monitoring driver rentao.bupt
2020-11-18 23:09 ` rentao.bupt [this message]
2020-11-18 23:27 ` [PATCH v2 0/2] hwmon: (max127) Add Maxim MAX127 hardware monitoring Andrew Lunn
2020-11-18 23:42 ` Tao Ren
2020-11-19 1:01 ` Guenter Roeck
2020-11-19 1:26 ` Guenter Roeck
2020-11-19 7:22 ` Tao Ren
2020-11-19 15:46 ` Jakub Kicinski
2020-11-19 16:35 ` XDP maintainer match (Was [PATCH v2 0/2] hwmon: (max127) Add Maxim MAX127 hardware monitoring) Jesper Dangaard Brouer
2020-11-19 17:09 ` Joe Perches
2020-11-19 17:59 ` Jakub Kicinski
2020-11-19 20:41 ` Jesper Dangaard Brouer
2020-11-19 16:36 ` [PATCH v2 0/2] hwmon: (max127) Add Maxim MAX127 hardware monitoring Alexei Starovoitov
2020-11-19 1:28 ` Andrew Lunn
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=20201118230929.18147-3-rentao.bupt@gmail.com \
--to=rentao.bupt@gmail.com \
--cc=ast@kernel.org \
--cc=bpf@vger.kernel.org \
--cc=corbet@lwn.net \
--cc=daniel@iogearbox.net \
--cc=davem@davemloft.net \
--cc=hawk@kernel.org \
--cc=jdelvare@suse.com \
--cc=john.fastabend@gmail.com \
--cc=kuba@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-hwmon@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@roeck-us.net \
--cc=mikechoi@fb.com \
--cc=netdev@vger.kernel.org \
--cc=openbmc@lists.ozlabs.org \
--cc=taoren@fb.com \
/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).