asus_ec_sensors.rst

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