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
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
32Author: Wilken Gottwalt
33
34Description
35-----------
36
37This driver implements the sysfs interface for the Corsair PSUs with a HID protocol
38interface of the HXi and RMi series.
39These power supplies provide access to a micro-controller with 2 attached
40temperature sensors, 1 fan rpm sensor, 4 sensors for volt levels, 4 sensors for
41power usage and 4 sensors for current levels and addtional non-sensor information
42like uptimes.
43
44Sysfs entries
45-------------
46
47=======================	========================================================
48curr1_input		Total current usage
49curr2_input		Current on the 12v psu rail
50curr2_crit		Current max critical value on the 12v psu rail
51curr3_input		Current on the 5v psu rail
52curr3_crit		Current max critical value on the 5v psu rail
53curr4_input		Current on the 3.3v psu rail
54curr4_crit		Current max critical value on the 3.3v psu rail
55fan1_input		RPM of psu fan
56in0_input		Voltage of the psu ac input
57in1_input		Voltage of the 12v psu rail
58in1_crit		Voltage max critical value on the 12v psu rail
59in1_lcrit		Voltage min critical value on the 12v psu rail
60in2_input		Voltage of the 5v psu rail
61in2_crit		Voltage max critical value on the 5v psu rail
62in2_lcrit		Voltage min critical value on the 5v psu rail
63in3_input		Voltage of the 3.3v psu rail
64in3_crit		Voltage max critical value on the 3.3v psu rail
65in3_lcrit		Voltage min critical value on the 3.3v psu rail
66power1_input		Total power usage
67power2_input		Power usage of the 12v psu rail
68power3_input		Power usage of the 5v psu rail
69power4_input		Power usage of the 3.3v psu rail
70temp1_input		Temperature of the psu vrm component
71temp1_crit		Temperature max cirtical value of the psu vrm component
72temp2_input		Temperature of the psu case
73temp2_crit		Temperature max critical value of psu case
74=======================	========================================================
75
76Usage Notes
77-----------
78
79It is an USB HID device, so it is auto-detected and supports hot-swapping.
80
81Flickering values in the rail voltage levels can be an indicator for a failing
82PSU. The driver also provides some additional useful values via debugfs, which
83do not fit into the hwmon class.
84
85Debugfs entries
86---------------
87
88=======================	========================================================
89uptime			Current uptime of the psu
90uptime_total		Total uptime of the psu
91vendor			Vendor name of the psu
92product			Product name of the psu
93=======================	========================================================
94