Merge tag 'rtc-6.4' of git://git.kernel.org/pub/scm/linux/kernel/git/abelloni/linux
[linux-block.git] / Documentation / hwmon / corsair-psu.rst
1 .. SPDX-License-Identifier: GPL-2.0-or-later
2
3 Kernel driver corsair-psu
4 =========================
5
6 Supported devices:
7
8 * Corsair Power Supplies
9
10   Corsair HX550i
11
12   Corsair HX650i
13
14   Corsair HX750i
15
16   Corsair HX850i
17
18   Corsair HX1000i (revision 1 and 2)
19
20   Corsair HX1200i
21
22   Corsair HX1500i
23
24   Corsair RM550i
25
26   Corsair RM650i
27
28   Corsair RM750i
29
30   Corsair RM850i
31
32   Corsair RM1000i
33
34 Author: Wilken Gottwalt
35
36 Description
37 -----------
38
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.
45
46 Sysfs entries
47 -------------
48
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 temp1_input             Temperature of the psu vrm component
73 temp1_crit              Temperature max cirtical value of the psu vrm component
74 temp2_input             Temperature of the psu case
75 temp2_crit              Temperature max critical value of psu case
76 ======================= ========================================================
77
78 Usage Notes
79 -----------
80
81 It is an USB HID device, so it is auto-detected and supports hot-swapping.
82
83 Flickering values in the rail voltage levels can be an indicator for a failing
84 PSU. The driver also provides some additional useful values via debugfs, which
85 do not fit into the hwmon class.
86
87 Debugfs entries
88 ---------------
89
90 ======================= ========================================================
91 ocpmode                 Single or multi rail mode of the PCIe power connectors
92 product                 Product name of the psu
93 uptime                  Session uptime of the psu
94 uptime_total            Total uptime of the psu
95 vendor                  Vendor name of the psu
96 ======================= ========================================================