diff mbox series

[v5,2/4] docs: hwmon: add max31760 documentation

Message ID 20220901125906.929-3-Ibrahim.Tilki@analog.com (mailing list archive)
State Changes Requested
Headers show
Series hwmon: Add max31760 fan speed controller | expand

Commit Message

Tilki, Ibrahim Sept. 1, 2022, 12:59 p.m. UTC 
Adding documentation for max31760 fan speed controller

Signed-off-by: Ibrahim Tilki <Ibrahim.Tilki@analog.com>
---
 Documentation/hwmon/max31760.rst | 67 ++++++++++++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 Documentation/hwmon/max31760.rst

Comments

Guenter Roeck Sept. 4, 2022, 4:06 p.m. UTC | #1 
On Thu, Sep 01, 2022 at 03:59:04PM +0300, Ibrahim Tilki wrote:
> Adding documentation for max31760 fan speed controller
> 
> Signed-off-by: Ibrahim Tilki <Ibrahim.Tilki@analog.com>
> ---
>  Documentation/hwmon/max31760.rst | 67 ++++++++++++++++++++++++++++++++

The file also needs to be added to index.rst.

>  1 file changed, 67 insertions(+)
>  create mode 100644 Documentation/hwmon/max31760.rst
> 
> diff --git a/Documentation/hwmon/max31760.rst b/Documentation/hwmon/max31760.rst
> new file mode 100644
> index 000000000..fd67c1318
> --- /dev/null
> +++ b/Documentation/hwmon/max31760.rst
> @@ -0,0 +1,67 @@
> +.. SPDX-License-Identifier: GPL-2.0-or-later
> +
> +Kernel driver max31760
> +======================
> +
> +Supported chips:
> +  * Analog Devices MAX31760
> +
> +    Prefix: 'max31760'
> +
> +    Addresses scanned: none
> +
> +    Datasheet: https://datasheets.maximintegrated.com/en/ds/MAX31760.pdf
> +
> +
> +Author: Ibrahim Tilki <Ibrahim.Tilki@analog.com>
> +
> +Description
> +-----------
> +
> +MAX31760 is a precision fan speed controller with nonvolatile lookup table.
> +Device has one internal and one external temperature sensor support.
> +Controls two fans and measures their speeds.
> +Generates hardware alerts when programmable max and critical temperatures are exceeded.
> +Supports direct and temperature based automatic fan control.
> +

Please use full sentences.

Thanks,
Guenter

> +Temperature measurement range: from -55°C to 125°C
> +
> +Temperature Resolution: 11 Bits, ±0.125°C
> +
> +Please refer how to instantiate this driver: Documentation/i2c/instantiating-devices.rst
> +
> +Lookup table for auto fan control
> +---------------------------------
> +
> +========= =================================
> +LUT Index Name
> +========= =================================
> +1         PWM value for T < +18°C
> +2         PWM value for +18°C ≤ T < +20°C
> +3         PWM value for +20°C ≤ T < +22°C
> +...       ...
> +47        PWM value for +108°C ≤ T < +110°C
> +48        PWM value for T ≥ +110°C
> +========= =================================
> +
> +Sysfs entries
> +-------------
> +
> +=============================== =================================================================================
> +fan[1-2]_input                  Fan speed (in RPM)
> +fan[1-2]_enable                 Enable fan readings and fan fault alarms
> +fan[1-2]_fault                  Fan fault status
> +temp[1-2]_label                 "Remote" and "Local" temperature channel labels
> +temp[1-2]_input                 Temperature sensor readings (in millidegrees Celsius)
> +temp1_fault                     Remote temperature sensor fault status
> +temp[1-2]_max                   Temperature max value. Asserts "ALERT" pin when exceeded
> +temp[1-2]_max_alarm             Temperature max alarm status
> +temp[1-2]_crit                  Temperature critical value. Asserts "SHDN" pin when exceeded
> +temp[1-2]_crit_alarm            Temperature critical alarm status
> +pwm1                            PWM value for direct fan control
> +pwm1_enable                     1: direct fan control, 2: temperature based auto fan control
> +pwm1_freq                       PWM frequency in hertz
> +pwm1_auto_channels_temp         Temperature source for auto fan control. 1: temp1, 2: temp2, 3: max(temp1, temp2)
> +pwm1_auto_point[1-48]_pwm       PWM value for LUT point
> +pwm1_auto_point_temp_hyst       Temperature hysteresis for auto fan control. Can be either 2000mC or 4000mC
> +=============================== =================================================================================
diff mbox series

Patch

diff --git a/Documentation/hwmon/max31760.rst b/Documentation/hwmon/max31760.rst
new file mode 100644
index 000000000..fd67c1318
--- /dev/null
+++ b/Documentation/hwmon/max31760.rst
@@ -0,0 +1,67 @@ 
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+Kernel driver max31760
+======================
+
+Supported chips:
+  * Analog Devices MAX31760
+
+    Prefix: 'max31760'
+
+    Addresses scanned: none
+
+    Datasheet: https://datasheets.maximintegrated.com/en/ds/MAX31760.pdf
+
+
+Author: Ibrahim Tilki <Ibrahim.Tilki@analog.com>
+
+Description
+-----------
+
+MAX31760 is a precision fan speed controller with nonvolatile lookup table.
+Device has one internal and one external temperature sensor support.
+Controls two fans and measures their speeds.
+Generates hardware alerts when programmable max and critical temperatures are exceeded.
+Supports direct and temperature based automatic fan control.
+
+Temperature measurement range: from -55°C to 125°C
+
+Temperature Resolution: 11 Bits, ±0.125°C
+
+Please refer how to instantiate this driver: Documentation/i2c/instantiating-devices.rst
+
+Lookup table for auto fan control
+---------------------------------
+
+========= =================================
+LUT Index Name
+========= =================================
+1         PWM value for T < +18°C
+2         PWM value for +18°C ≤ T < +20°C
+3         PWM value for +20°C ≤ T < +22°C
+...       ...
+47        PWM value for +108°C ≤ T < +110°C
+48        PWM value for T ≥ +110°C
+========= =================================
+
+Sysfs entries
+-------------
+
+=============================== =================================================================================
+fan[1-2]_input                  Fan speed (in RPM)
+fan[1-2]_enable                 Enable fan readings and fan fault alarms
+fan[1-2]_fault                  Fan fault status
+temp[1-2]_label                 "Remote" and "Local" temperature channel labels
+temp[1-2]_input                 Temperature sensor readings (in millidegrees Celsius)
+temp1_fault                     Remote temperature sensor fault status
+temp[1-2]_max                   Temperature max value. Asserts "ALERT" pin when exceeded
+temp[1-2]_max_alarm             Temperature max alarm status
+temp[1-2]_crit                  Temperature critical value. Asserts "SHDN" pin when exceeded
+temp[1-2]_crit_alarm            Temperature critical alarm status
+pwm1                            PWM value for direct fan control
+pwm1_enable                     1: direct fan control, 2: temperature based auto fan control
+pwm1_freq                       PWM frequency in hertz
+pwm1_auto_channels_temp         Temperature source for auto fan control. 1: temp1, 2: temp2, 3: max(temp1, temp2)
+pwm1_auto_point[1-48]_pwm       PWM value for LUT point
+pwm1_auto_point_temp_hyst       Temperature hysteresis for auto fan control. Can be either 2000mC or 4000mC
+=============================== =================================================================================