summaryrefslogtreecommitdiffstats
path: root/Documentation/hwmon/emc2305.rst
diff options
context:
space:
mode:
authorMichael Shych <michaelsh@nvidia.com>2022-08-10 20:15:52 +0300
committerGuenter Roeck <linux@roeck-us.net>2022-09-19 06:17:06 -0700
commit005cc9b4f1118309301f5af6c6ee7e74a5b1f46c (patch)
tree50cb19b5fd80404cd2ea44d8351b71637dc380ff /Documentation/hwmon/emc2305.rst
parent0d8400c5a2ce1595f31b2f99e3139cf5bc5f35fd (diff)
downloadlinux-stable-005cc9b4f1118309301f5af6c6ee7e74a5b1f46c.tar.gz
linux-stable-005cc9b4f1118309301f5af6c6ee7e74a5b1f46c.tar.bz2
linux-stable-005cc9b4f1118309301f5af6c6ee7e74a5b1f46c.zip
docs: hwmon: add emc2305.rst to docs
Add description of emc2305 driver. Signed-off-by: Michael Shych <michaelsh@nvidia.com> Reviewed-by: Vadim Pasternak <vadimp@nvidia.com> Link: https://lore.kernel.org/r/20220810171552.56417-4-michaelsh@nvidia.com [groeck: Fixed htmldocs warnings] Signed-off-by: Guenter Roeck <linux@roeck-us.net>
Diffstat (limited to 'Documentation/hwmon/emc2305.rst')
-rw-r--r--Documentation/hwmon/emc2305.rst37
1 files changed, 37 insertions, 0 deletions
diff --git a/Documentation/hwmon/emc2305.rst b/Documentation/hwmon/emc2305.rst
new file mode 100644
index 000000000000..2403dbaf2728
--- /dev/null
+++ b/Documentation/hwmon/emc2305.rst
@@ -0,0 +1,37 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+Kernel driver emc2305
+=====================
+
+Supported chips:
+ Microchip EMC2305, EMC2303, EMC2302, EMC2301
+
+ Addresses scanned: I2C 0x27, 0x2c, 0x2d, 0x2e, 0x2f, 0x4c, 0x4d
+ Prefixes: 'emc2305'
+
+ Datasheet: Publicly available at the Microchip website :
+ https://www.microchip.com/en-us/product/EMC2305
+
+Description:
+------------
+This driver implements support for Microchip EMC2301/2/3/5 RPM-based PWM Fan Controller.
+The EMC2305 Fan Controller supports up to 5 independently controlled PWM fan drives.
+Fan rotation speeds are reported in RPM.
+The driver supports the RPM-based PWM control to keep a fan at the desired speed.
+The driver provides the possibility to have one common PWM interface for all FANs
+or up to the maximum available or configured independent PWMs.
+
+The driver provides the following sysfs interfaces in hwmon subsystem:
+
+================= == ===================================================
+fan[1-5]_fault RO files for tachometers TACH1-TACH5 fault indication
+fan[1-5]_input RO files for tachometers TACH1-TACH5 input (in RPM)
+pwm[1-5] RW file for fan[1-5] target duty cycle (0..255)
+================= == ===================================================
+
+sysfs interfaces in thermal subsystem:
+
+================= == ========================================================================
+cur_state RW file for the current cooling state of the cooling device (0..max_state)
+max_state RO file for the maximum cooling state of the cooling device
+================= == ========================================================================