xref: /linux/Documentation/hwmon/asus_ec_sensors.rst (revision e7e86d7697c6ed1dbbde18d7185c35b6967945ed)
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 X870E-CREATOR WIFI
15 * ProArt B550-CREATOR
16 * ROG CROSSHAIR VIII DARK HERO
17 * ROG CROSSHAIR VIII HERO (WI-FI)
18 * ROG CROSSHAIR VIII FORMULA
19 * ROG CROSSHAIR VIII HERO
20 * ROG CROSSHAIR VIII IMPACT
21 * ROG CROSSHAIR X670E HERO
22 * ROG CROSSHAIR X670E GENE
23 * ROG MAXIMUS XI HERO
24 * ROG MAXIMUS XI HERO (WI-FI)
25 * ROG MAXIMUS Z690 FORMULA
26 * ROG STRIX B550-E GAMING
27 * ROG STRIX B550-I GAMING
28 * ROG STRIX X570-E GAMING
29 * ROG STRIX X570-E GAMING WIFI II
30 * ROG STRIX X570-F GAMING
31 * ROG STRIX X570-I GAMING
32 * ROG STRIX Z390-F GAMING
33 * ROG STRIX Z490-F GAMING
34 * ROG STRIX Z690-A GAMING WIFI D4
35 * ROG ZENITH II EXTREME
36 * ROG ZENITH II EXTREME ALPHA
37 * TUF GAMING X670E PLUS
38
39Authors:
40    - Eugene Shalygin <eugene.shalygin@gmail.com>
41
42Description:
43------------
44ASUS mainboards publish hardware monitoring information via Super I/O
45chip and the ACPI embedded controller (EC) registers. Some of the sensors
46are only available via the EC.
47
48The driver is aware of and reads the following sensors:
49
501. Chipset (PCH) temperature
512. CPU package temperature
523. Motherboard temperature
534. Readings from the T_Sensor header
545. VRM temperature
556. CPU_Opt fan RPM
567. VRM heatsink fan RPM
578. Chipset fan RPM
589. Readings from the "Water flow meter" header (RPM)
5910. Readings from the "Water In" and "Water Out" temperature headers
6011. CPU current
6112. CPU core voltage
62
63Sensor values are read from EC registers, and to avoid race with the board
64firmware the driver acquires ACPI mutex, the one used by the WMI when its
65methods access the EC.
66
67Module Parameters
68-----------------
69 * mutex_path: string
70		The driver holds path to the ACPI mutex for each board (actually,
71		the path is mostly identical for them). If ASUS changes this path
72		in a future BIOS update, this parameter can be used to override
73		the stored in the driver value until it gets updated.
74		A special string ":GLOBAL_LOCK" can be passed to use the ACPI
75		global lock instead of a dedicated mutex.
76