On 7/26/22 05:28, Ibrahim Tilki wrote:
Adding documentation for max31760 fan speed controller Signed-off-by: Ibrahim Tilki <Ibrahim.Tilki@xxxxxxxxxx> --- Documentation/hwmon/max31760.rst | 53 ++++++++++++++++++++++++++++++++ 1 file changed, 53 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..11055722b --- /dev/null +++ b/Documentation/hwmon/max31760.rst @@ -0,0 +1,53 @@ +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@xxxxxxxxxx> + +Description +----------- + +MAX31760 is a presicion fan speed controller with nonvolatile lookup table.
precision
+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 + + +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
This needs to be explained further. No one will know that "3" reflects max(temp1, temp2).
+pwm1_auto_point[1-48]_pwm RW PWM value for LUT point +pwm1_auto_point[1-48]_temp RO Temperature value for LUT point +pwm1_auto_point[1-48]_temp_hyst RW Temperature hysteresis value for LUT point
Temperatures are fixed, and there is only one hysteresis value. That means there will be 96 sysfs attributes with effectively just a single controllable value, and otherwise constants. This is just confusing and has no value. Drop all those, document the relationship between temperatures and pwm1_auto_point[1-48]_pwm, and provide just a single attribute for the hysteresis. Guenter
+=============================== ============================================================
