linux-loongson/Documentation/hwmon/kfan.rst
Gerhard Engleder 9b96f82c78 hwmon: Add KEBA fan controller support
The KEBA fan controller is found in the system FPGA of KEBA PLC devices.
It detects if the fan is removed or blocked. For fans with tacho signal
the monitoring of the speed of the fan is supported. It also supports to
regulate the speed of fans with PWM input.

The auxiliary device for this driver is instantiated by the cp500 misc
driver.

Signed-off-by: Gerhard Engleder <eg@keba.com>
Link: https://lore.kernel.org/r/20250425194823.54664-1-gerhard@engleder-embedded.com
[groeck: Added various missing "break;" statements]
Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2025-05-12 18:05:54 -07:00

40 lines
1.3 KiB
ReStructuredText

.. SPDX-License-Identifier: GPL-2.0
Kernel driver kfan
==================
Supported chips:
* KEBA fan controller (IP core in FPGA)
Prefix: 'kfan'
Authors:
Gerhard Engleder <eg@keba.com>
Petar Bojanic <boja@keba.com>
Description
-----------
The KEBA fan controller is an IP core for FPGAs, which monitors the health
and controls the speed of a fan. The fan is typically used to cool the CPU
and the whole device. E.g., the CP500 FPGA includes this IP core to monitor
and control the fan of PLCs and the corresponding cp500 driver creates an
auxiliary device for the kfan driver.
This driver provides information about the fan health to user space.
The user space shall be informed if the fan is removed or blocked.
Additionally, the speed in RPM is reported for fans with tacho signal.
For fan control PWM is supported. For PWM 255 equals 100%. None-regulable
fans can be turned on with PWM 255 and turned off with PWM 0.
====================== ==== ===================================================
Attribute R/W Contents
====================== ==== ===================================================
fan1_fault R Fan fault
fan1_input R Fan tachometer input (in RPM)
pwm1 RW Fan target duty cycle (0..255)
====================== ==== ===================================================