[linux,dev-4.10,2/3] hwmon: (w83773g) Add documentation

Message ID 1509589519-26697-1-git-send-email-mine260309@gmail.com
State New
Headers show
Series
  • [linux,dev-4.10,1/3] drivers: hwmon: Add W83773G driver
Related show

Commit Message

Lei YU Nov. 2, 2017, 2:25 a.m.
Add documentation for the w83773g driver.

Signed-off-by: Lei YU <mine260309@gmail.com>
---
 Documentation/hwmon/w83773g | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 Documentation/hwmon/w83773g

Patch

diff --git a/Documentation/hwmon/w83773g b/Documentation/hwmon/w83773g
new file mode 100644
index 0000000..da28731
--- /dev/null
+++ b/Documentation/hwmon/w83773g
@@ -0,0 +1,28 @@ 
+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.
+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