xref: /linux/Documentation/hwmon/asus_ec_sensors.rst (revision 34f2573661e3e644efaf383178af634a2fd67828)
1.. SPDX-License-Identifier: GPL-2.0-or-later
2
3Kernel driver asus_ec_sensors
4=================================
5
6Supported boards:
7 * MAXIMUS VI HERO
8 * PRIME X470-PRO
9 * PRIME X570-PRO
10 * PRIME X670E-PRO WIFI
11 * Pro WS X570-ACE
12 * ProArt X570-CREATOR WIFI
13 * ProArt X670E-CREATOR WIFI
14 * ProArt B550-CREATOR
15 * ROG CROSSHAIR VIII DARK HERO
16 * ROG CROSSHAIR VIII HERO (WI-FI)
17 * ROG CROSSHAIR VIII FORMULA
18 * ROG CROSSHAIR VIII HERO
19 * ROG CROSSHAIR VIII IMPACT
20 * ROG CROSSHAIR X670E HERO
21 * ROG CROSSHAIR X670E GENE
22 * ROG MAXIMUS XI HERO
23 * ROG MAXIMUS XI HERO (WI-FI)
24 * ROG MAXIMUS Z690 FORMULA
25 * ROG STRIX B550-E GAMING
26 * ROG STRIX B550-I GAMING
27 * ROG STRIX X570-E GAMING
28 * ROG STRIX X570-E GAMING WIFI II
29 * ROG STRIX X570-F GAMING
30 * ROG STRIX X570-I GAMING
31 * ROG STRIX Z390-F GAMING
32 * ROG STRIX Z690-A GAMING WIFI D4
33 * ROG ZENITH II EXTREME
34 * ROG ZENITH II EXTREME ALPHA
35 * TUF GAMING X670E PLUS
36
37Authors:
38    - Eugene Shalygin <eugene.shalygin@gmail.com>
39
40Description:
41------------
42ASUS mainboards publish hardware monitoring information via Super I/O
43chip and the ACPI embedded controller (EC) registers. Some of the sensors
44are only available via the EC.
45
46The driver is aware of and reads the following sensors:
47
481. Chipset (PCH) temperature
492. CPU package temperature
503. Motherboard temperature
514. Readings from the T_Sensor header
525. VRM temperature
536. CPU_Opt fan RPM
547. VRM heatsink fan RPM
558. Chipset fan RPM
569. Readings from the "Water flow meter" header (RPM)
5710. Readings from the "Water In" and "Water Out" temperature headers
5811. CPU current
5912. CPU core voltage
60
61Sensor values are read from EC registers, and to avoid race with the board
62firmware the driver acquires ACPI mutex, the one used by the WMI when its
63methods access the EC.
64
65Module Parameters
66-----------------
67 * mutex_path: string
68		The driver holds path to the ACPI mutex for each board (actually,
69		the path is mostly identical for them). If ASUS changes this path
70		in a future BIOS update, this parameter can be used to override
71		the stored in the driver value until it gets updated.
72		A special string ":GLOBAL_LOCK" can be passed to use the ACPI
73		global lock instead of a dedicated mutex.
74