Merge tag 'clk-fixes-for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux.git] / Documentation / hwmon / corsair-psu.rst
blob7ed794087f848941f4b5f65b1d2bfd6254f232d9
1 .. SPDX-License-Identifier: GPL-2.0-or-later
3 Kernel driver corsair-psu
4 =========================
6 Supported devices:
8 * Corsair Power Supplies
10   Corsair HX550i
12   Corsair HX650i
14   Corsair HX750i
16   Corsair HX850i
18   Corsair HX1000i (Legacy and Series 2023)
20   Corsair HX1200i (Legacy and Series 2023)
22   Corsair HX1500i (Legacy and Series 2023)
24   Corsair RM550i
26   Corsair RM650i
28   Corsair RM750i
30   Corsair RM850i
32   Corsair RM1000i
34 Author: Wilken Gottwalt
36 Description
37 -----------
39 This driver implements the sysfs interface for the Corsair PSUs with a HID protocol
40 interface of the HXi and RMi series.
41 These power supplies provide access to a micro-controller with 2 attached
42 temperature sensors, 1 fan rpm sensor, 4 sensors for volt levels, 4 sensors for
43 power usage and 4 sensors for current levels and additional non-sensor information
44 like uptimes.
46 Sysfs entries
47 -------------
49 ======================= ========================================================
50 curr1_input             Total current usage
51 curr2_input             Current on the 12v psu rail
52 curr2_crit              Current max critical value on the 12v psu rail
53 curr3_input             Current on the 5v psu rail
54 curr3_crit              Current max critical value on the 5v psu rail
55 curr4_input             Current on the 3.3v psu rail
56 curr4_crit              Current max critical value on the 3.3v psu rail
57 fan1_input              RPM of psu fan
58 in0_input               Voltage of the psu ac input
59 in1_input               Voltage of the 12v psu rail
60 in1_crit                Voltage max critical value on the 12v psu rail
61 in1_lcrit               Voltage min critical value on the 12v psu rail
62 in2_input               Voltage of the 5v psu rail
63 in2_crit                Voltage max critical value on the 5v psu rail
64 in2_lcrit               Voltage min critical value on the 5v psu rail
65 in3_input               Voltage of the 3.3v psu rail
66 in3_crit                Voltage max critical value on the 3.3v psu rail
67 in3_lcrit               Voltage min critical value on the 3.3v psu rail
68 power1_input            Total power usage
69 power2_input            Power usage of the 12v psu rail
70 power3_input            Power usage of the 5v psu rail
71 power4_input            Power usage of the 3.3v psu rail
72 pwm1                    PWM value, read only
73 pwm1_enable             PWM mode, read only
74 temp1_input             Temperature of the psu vrm component
75 temp1_crit              Temperature max cirtical value of the psu vrm component
76 temp2_input             Temperature of the psu case
77 temp2_crit              Temperature max critical value of psu case
78 ======================= ========================================================
80 Usage Notes
81 -----------
83 It is an USB HID device, so it is auto-detected, supports hot-swapping and
84 several devices at once.
86 Flickering values in the rail voltage levels can be an indicator for a failing
87 PSU. Accordingly to the default automatic fan speed plan the fan starts at about
88 30% of the wattage rating. If this does not happen, a fan failure is likely. The
89 driver also provides some additional useful values via debugfs, which do not fit
90 into the hwmon class.
92 Debugfs entries
93 ---------------
95 ======================= ========================================================
96 ocpmode                 Single or multi rail mode of the PCIe power connectors
97 product                 Product name of the psu
98 uptime                  Session uptime of the psu
99 uptime_total            Total uptime of the psu
100 vendor                  Vendor name of the psu
101 ======================= ========================================================