summaryrefslogtreecommitdiffstats
path: root/Documentation/hwmon/ltc4151.rst
diff options
context:
space:
mode:
authorMauro Carvalho Chehab2019-04-17 11:46:29 +0200
committerGuenter Roeck2019-04-17 19:37:23 +0200
commit7ebd8b66dd9e5a0b65e5ee5e2b8e7ca382ec97b7 (patch)
tree9db30159bd32bec125c7d49e80a79bb7c4da0c8e /Documentation/hwmon/ltc4151.rst
parentdocs: hwmon: convert remaining files to ReST format (diff)
downloadkernel-qcow2-linux-7ebd8b66dd9e5a0b65e5ee5e2b8e7ca382ec97b7.tar.gz
kernel-qcow2-linux-7ebd8b66dd9e5a0b65e5ee5e2b8e7ca382ec97b7.tar.xz
kernel-qcow2-linux-7ebd8b66dd9e5a0b65e5ee5e2b8e7ca382ec97b7.zip
docs: hwmon: Add an index file and rename docs to *.rst
Now that all files were converted to ReST format, rename them and add an index. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
Diffstat (limited to 'Documentation/hwmon/ltc4151.rst')
-rw-r--r--Documentation/hwmon/ltc4151.rst55
1 files changed, 55 insertions, 0 deletions
diff --git a/Documentation/hwmon/ltc4151.rst b/Documentation/hwmon/ltc4151.rst
new file mode 100644
index 000000000000..c39229b19624
--- /dev/null
+++ b/Documentation/hwmon/ltc4151.rst
@@ -0,0 +1,55 @@
+Kernel driver ltc4151
+=====================
+
+Supported chips:
+
+ * Linear Technology LTC4151
+
+ Prefix: 'ltc4151'
+
+ Addresses scanned: -
+
+ Datasheet:
+
+ http://www.linear.com/docs/Datasheet/4151fc.pdf
+
+Author: Per Dalen <per.dalen@appeartv.com>
+
+
+Description
+-----------
+
+The LTC4151 is a High Voltage I2C Current and Voltage Monitor.
+
+
+Usage Notes
+-----------
+
+This driver does not probe for LTC4151 devices, since there is no register
+which can be safely used to identify the chip. You will have to instantiate
+the devices explicitly.
+
+Example: the following will load the driver for an LTC4151 at address 0x6f
+on I2C bus #0::
+
+ # modprobe ltc4151
+ # echo ltc4151 0x6f > /sys/bus/i2c/devices/i2c-0/new_device
+
+
+Sysfs entries
+-------------
+
+Voltage readings provided by this driver are reported as obtained from the ADIN
+and VIN registers.
+
+Current reading provided by this driver is reported as obtained from the Current
+Sense register. The reported value assumes that a 1 mOhm sense resistor is
+installed.
+
+======================= ==================
+in1_input VDIN voltage (mV)
+
+in2_input ADIN voltage (mV)
+
+curr1_input SENSE current (mA)
+======================= ==================