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 STRIX B550-E GAMING
17 * ROG STRIX B550-I GAMING
18 * ROG STRIX X570-E GAMING
19 * ROG STRIX X570-E GAMING WIFI II
20 * ROG STRIX X570-F GAMING
21 * ROG STRIX X570-I GAMING
22
23Authors:
24    - Eugene Shalygin <eugene.shalygin@gmail.com>
25
26Description:
27------------
28ASUS mainboards publish hardware monitoring information via Super I/O
29chip and the ACPI embedded controller (EC) registers. Some of the sensors
30are only available via the EC.
31
32The driver is aware of and reads the following sensors:
33
341. Chipset (PCH) temperature
352. CPU package temperature
363. Motherboard temperature
374. Readings from the T_Sensor header
385. VRM temperature
396. CPU_Opt fan RPM
407. VRM heatsink fan RPM
418. Chipset fan RPM
429. Readings from the "Water flow meter" header (RPM)
4310. Readings from the "Water In" and "Water Out" temperature headers
4411. CPU current
4512. CPU core voltage
46
47Sensor values are read from EC registers, and to avoid race with the board
48firmware the driver acquires ACPI mutex, the one used by the WMI when its
49methods access the EC.
50
51Module Parameters
52-----------------
53 * mutex_path: string
54		The driver holds path to the ACPI mutex for each board (actually,
55		the path is mostly identical for them). If ASUS changes this path
56		in a future BIOS update, this parameter can be used to override
57		the stored in the driver value until it gets updated.
58		A special string ":GLOBAL_LOCK" can be passed to use the ACPI
59		global lock instead of a dedicated mutex.
60