Merge tag 'efi_updates_for_v5.11' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux-2.6-microblaze.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
19
20   Corsair HX1200i
21
22   Corsair RM550i
23
24   Corsair RM650i
25
26   Corsair RM750i
27
28   Corsair RM850i
29
30   Corsair RM1000i
31
32 Author: Wilken Gottwalt
33
34 Description
35 -----------
36
37 This driver implements the sysfs interface for the Corsair PSUs with a HID protocol
38 interface of the HXi and RMi series.
39 These power supplies provide access to a micro-controller with 2 attached
40 temperature sensors, 1 fan rpm sensor, 4 sensors for volt levels, 4 sensors for
41 power usage and 4 sensors for current levels and addtional non-sensor information
42 like uptimes.
43
44 Sysfs entries
45 -------------
46
47 ======================= ========================================================
48 curr1_input             Total current usage
49 curr2_input             Current on the 12v psu rail
50 curr3_input             Current on the 5v psu rail
51 curr4_input             Current on the 3.3v psu rail
52 fan1_input              RPM of psu fan
53 in0_input               Voltage of the psu ac input
54 in1_input               Voltage of the 12v psu rail
55 in2_input               Voltage of the 5v psu rail
56 in3_input               Voltage of the 3.3 psu rail
57 power1_input            Total power usage
58 power2_input            Power usage of the 12v psu rail
59 power3_input            Power usage of the 5v psu rail
60 power4_input            Power usage of the 3.3v psu rail
61 temp1_input             Temperature of the psu vrm component
62 temp2_input             Temperature of the psu case
63 ======================= ========================================================
64
65 Usage Notes
66 -----------
67
68 It is an USB HID device, so it is auto-detected and supports hot-swapping.
69
70 Flickering values in the rail voltage levels can be an indicator for a failing
71 PSU. The driver also provides some additional useful values via debugfs, which
72 do not fit into the hwmon class.
73
74 Debugfs entries
75 ---------------
76
77 ======================= ========================================================
78 uptime                  Current uptime of the psu
79 uptime_total            Total uptime of the psu
80 vendor                  Vendor name of the psu
81 product                 Product name of the psu
82 ======================= ========================================================