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 * ROG CROSSHAIR VIII DARK HERO
12 * ROG CROSSHAIR VIII HERO (WI-FI)
13 * ROG CROSSHAIR VIII FORMULA
14 * ROG CROSSHAIR VIII HERO
15 * ROG CROSSHAIR VIII IMPACT
16 * ROG MAXIMUS XI HERO
17 * ROG MAXIMUS XI HERO (WI-FI)
18 * ROG STRIX B550-E GAMING
19 * ROG STRIX B550-I GAMING
20 * ROG STRIX X570-E GAMING
21 * ROG STRIX X570-E GAMING WIFI II
22 * ROG STRIX X570-F GAMING
23 * ROG STRIX X570-I GAMING
24 * ROG STRIX Z690-A GAMING WIFI D4
25 * ROG ZENITH II EXTREME
26
27Authors:
28    - Eugene Shalygin <eugene.shalygin@gmail.com>
29
30Description:
31------------
32ASUS mainboards publish hardware monitoring information via Super I/O
33chip and the ACPI embedded controller (EC) registers. Some of the sensors
34are only available via the EC.
35
36The driver is aware of and reads the following sensors:
37
381. Chipset (PCH) temperature
392. CPU package temperature
403. Motherboard temperature
414. Readings from the T_Sensor header
425. VRM temperature
436. CPU_Opt fan RPM
447. VRM heatsink fan RPM
458. Chipset fan RPM
469. Readings from the "Water flow meter" header (RPM)
4710. Readings from the "Water In" and "Water Out" temperature headers
4811. CPU current
4912. CPU core voltage
50
51Sensor values are read from EC registers, and to avoid race with the board
52firmware the driver acquires ACPI mutex, the one used by the WMI when its
53methods access the EC.
54
55Module Parameters
56-----------------
57 * mutex_path: string
58		The driver holds path to the ACPI mutex for each board (actually,
59		the path is mostly identical for them). If ASUS changes this path
60		in a future BIOS update, this parameter can be used to override
61		the stored in the driver value until it gets updated.
62		A special string ":GLOBAL_LOCK" can be passed to use the ACPI
63		global lock instead of a dedicated mutex.
64