xref: /linux/Documentation/hwmon/asus_ec_sensors.rst (revision 55a42f78ffd386e01a5404419f8c5ded7db70a21)
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 * PRIME Z270-A
12 * Pro WS X570-ACE
13 * Pro WS WRX90E-SAGE SE
14 * ProArt X570-CREATOR WIFI
15 * ProArt X670E-CREATOR WIFI
16 * ProArt X870E-CREATOR WIFI
17 * ProArt B550-CREATOR
18 * ROG CROSSHAIR VIII DARK HERO
19 * ROG CROSSHAIR VIII HERO (WI-FI)
20 * ROG CROSSHAIR VIII FORMULA
21 * ROG CROSSHAIR VIII HERO
22 * ROG CROSSHAIR VIII IMPACT
23 * ROG CROSSHAIR X670E HERO
24 * ROG CROSSHAIR X670E GENE
25 * ROG MAXIMUS XI HERO
26 * ROG MAXIMUS XI HERO (WI-FI)
27 * ROG MAXIMUS Z690 FORMULA
28 * ROG STRIX B550-E GAMING
29 * ROG STRIX B550-I GAMING
30 * ROG STRIX B650E-I GAMING WIFI
31 * ROG STRIX B850-I GAMING WIFI
32 * ROG STRIX X570-E GAMING
33 * ROG STRIX X570-E GAMING WIFI II
34 * ROG STRIX X570-F GAMING
35 * ROG STRIX X570-I GAMING
36 * ROG STRIX X670E-E GAMING WIFI
37 * ROG STRIX X670E-I GAMING WIFI
38 * ROG STRIX X870-I GAMING WIFI
39 * ROG STRIX X870E-E GAMING WIFI
40 * ROG STRIX Z390-F GAMING
41 * ROG STRIX Z490-F GAMING
42 * ROG STRIX Z690-A GAMING WIFI D4
43 * ROG STRIX Z690-E GAMING WIFI
44 * ROG STRIX Z790-E GAMING WIFI II
45 * ROG STRIX Z790-I GAMING WIFI
46 * ROG ZENITH II EXTREME
47 * ROG ZENITH II EXTREME ALPHA
48 * TUF GAMING X670E PLUS
49 * TUF GAMING X670E PLUS WIFI
50
51Authors:
52    - Eugene Shalygin <eugene.shalygin@gmail.com>
53
54Description:
55------------
56ASUS mainboards publish hardware monitoring information via Super I/O
57chip and the ACPI embedded controller (EC) registers. Some of the sensors
58are only available via the EC.
59
60The driver is aware of and reads the following sensors:
61
621. Chipset (PCH) temperature
632. CPU package temperature
643. Motherboard temperature
654. Readings from the T_Sensor header
665. VRM temperature
676. CPU_Opt fan RPM
687. VRM heatsink fan RPM
698. Chipset fan RPM
709. Readings from the "Water flow meter" header (RPM)
7110. Readings from the "Water In" and "Water Out" temperature headers
7211. CPU current
7312. CPU core voltage
74
75Sensor values are read from EC registers, and to avoid race with the board
76firmware the driver acquires ACPI mutex, the one used by the WMI when its
77methods access the EC.
78
79Module Parameters
80-----------------
81 * mutex_path: string
82		The driver holds path to the ACPI mutex for each board (actually,
83		the path is mostly identical for them). If ASUS changes this path
84		in a future BIOS update, this parameter can be used to override
85		the stored in the driver value until it gets updated.
86		A special string ":GLOBAL_LOCK" can be passed to use the ACPI
87		global lock instead of a dedicated mutex.
88