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