From: Lei YU <mine260309@gmail.com>
To: Mark Rutland <mark.rutland@arm.com>,
Jean Delvare <jdelvare@suse.com>,
Guenter Roeck <linux@roeck-us.net>,
Jonathan Corbet <corbet@lwn.net>,
Jiri Kosina <trivial@kernel.org>
Cc: Lei YU <mine260309@gmail.com>,
devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-hwmon@vger.kernel.org, Joel Stanley <joel@jms.id.au>,
Andrew Jeffery <andrew@aj.id.au>
Subject: [PATCH v4 3/3] hwmon: (w83773g) Add documentation
Date: Mon, 13 Nov 2017 11:27:34 +0800 [thread overview]
Message-ID: <1510543655-27059-4-git-send-email-mine260309@gmail.com> (raw)
In-Reply-To: <1510543655-27059-1-git-send-email-mine260309@gmail.com>
Add documentation for the w83773g driver.
Signed-off-by: Lei YU <mine260309@gmail.com>
---
v2:
- Add notes for offset and update_interval
---
Documentation/hwmon/w83773g | 33 +++++++++++++++++++++++++++++++++
1 file changed, 33 insertions(+)
create mode 100644 Documentation/hwmon/w83773g
diff --git a/Documentation/hwmon/w83773g b/Documentation/hwmon/w83773g
new file mode 100644
index 0000000..4cc6c0b
--- /dev/null
+++ b/Documentation/hwmon/w83773g
@@ -0,0 +1,33 @@
+Kernel driver w83773g
+====================
+
+Supported chips:
+ * Nuvoton W83773G
+ Prefix: 'w83773g'
+ Addresses scanned: I2C 0x4c and 0x4d
+ Datasheet: https://www.nuvoton.com/resource-files/W83773G_SG_DatasheetV1_2.pdf
+
+Authors:
+ Lei YU <mine260309@gmail.com>
+
+Description
+-----------
+
+This driver implements support for Nuvoton W83773G temperature sensor
+chip. This chip implements one local and two remote sensors.
+The chip also features offsets for the two remote sensors which get added to
+the input readings. The chip does all the scaling by itself and the driver
+therefore reports true temperatures that don't need any user-space adjustments.
+Temperature is measured in degrees Celsius.
+The chip is wired over I2C/SMBus and specified over a temperature
+range of -40 to +125 degrees Celsius (for local sensor) and -40 to +127
+degrees Celsius (for remote sensors).
+Resolution for both the local and remote channels is 0.125 degree C.
+
+The chip supports only temperature measurement. The driver exports
+the temperature values via the following sysfs files:
+
+temp[1-3]_input
+temp[2-3]_fault
+temp[2-3]_offset
+update_interval
--
1.9.1
next prev parent reply other threads:[~2017-11-13 3:27 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-11-13 3:27 [PATCH v4 0/3] Add W83773G hwmon sensor driver and doc Lei YU
2017-11-13 3:27 ` [PATCH v4 1/3] DT: i2c: W83773G is a trivial device Lei YU
2017-11-16 4:33 ` Rob Herring
2017-11-13 3:27 ` [PATCH v4 2/3] drivers: hwmon: Add W83773G driver Lei YU
2017-11-18 16:15 ` [v4,2/3] " Guenter Roeck
2017-11-23 6:32 ` Joel Stanley
[not found] ` <CACPK8Xc5zmHCmDikYFPA+GdVCydHwgiLMY0X1RTyOmzS+m9W7A-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2017-11-23 9:01 ` Guenter Roeck
2017-11-13 3:27 ` Lei YU [this message]
2017-11-18 16:16 ` [v4,3/3] hwmon: (w83773g) Add documentation Guenter Roeck
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=1510543655-27059-4-git-send-email-mine260309@gmail.com \
--to=mine260309@gmail.com \
--cc=andrew@aj.id.au \
--cc=corbet@lwn.net \
--cc=devicetree@vger.kernel.org \
--cc=jdelvare@suse.com \
--cc=joel@jms.id.au \
--cc=linux-hwmon@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@roeck-us.net \
--cc=mark.rutland@arm.com \
--cc=trivial@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).