Merge tag 'drm-misc-fixes-2022-05-26' of git://anongit.freedesktop.org/drm/drm-misc...
[linux-2.6-microblaze.git] / Documentation / hwmon / asus_ec_sensors.rst
1 .. SPDX-License-Identifier: GPL-2.0-or-later
2
3 Kernel driver asus_ec_sensors
4 =================================
5
6 Supported boards:
7  * PRIME X470-PRO
8  * PRIME X570-PRO
9  * Pro WS X570-ACE
10  * ProArt X570-CREATOR WIFI
11  * ROG CROSSHAIR VIII DARK HERO
12  * ROG CROSSHAIR VIII HERO (WI-FI)
13  * ROG CROSSHAIR VIII FORMULA
14  * ROG CROSSHAIR VIII HERO
15  * ROG CROSSHAIR VIII IMPACT
16  * ROG STRIX B550-E GAMING
17  * ROG STRIX B550-I GAMING
18  * ROG STRIX X570-E GAMING
19  * ROG STRIX X570-E GAMING WIFI II
20  * ROG STRIX X570-F GAMING
21  * ROG STRIX X570-I GAMING
22
23 Authors:
24     - Eugene Shalygin <eugene.shalygin@gmail.com>
25
26 Description:
27 ------------
28 ASUS mainboards publish hardware monitoring information via Super I/O
29 chip and the ACPI embedded controller (EC) registers. Some of the sensors
30 are only available via the EC.
31
32 The driver is aware of and reads the following sensors:
33
34 1. Chipset (PCH) temperature
35 2. CPU package temperature
36 3. Motherboard temperature
37 4. Readings from the T_Sensor header
38 5. VRM temperature
39 6. CPU_Opt fan RPM
40 7. VRM heatsink fan RPM
41 8. Chipset fan RPM
42 9. Readings from the "Water flow meter" header (RPM)
43 10. Readings from the "Water In" and "Water Out" temperature headers
44 11. CPU current
45 12. CPU core voltage
46
47 Sensor values are read from EC registers, and to avoid race with the board
48 firmware the driver acquires ACPI mutex, the one used by the WMI when its
49 methods access the EC.
50
51 Module Parameters
52 -----------------
53  * mutex_path: string
54                 The driver holds path to the ACPI mutex for each board (actually,
55                 the path is mostly identical for them). If ASUS changes this path
56                 in a future BIOS update, this parameter can be used to override
57                 the stored in the driver value until it gets updated.
58                 A special string ":GLOBAL_LOCK" can be passed to use the ACPI
59                 global lock instead of a dedicated mutex.