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