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
33Authors:
34    - Eugene Shalygin <eugene.shalygin@gmail.com>
35
36Description:
37------------
38ASUS mainboards publish hardware monitoring information via Super I/O
39chip and the ACPI embedded controller (EC) registers. Some of the sensors
40are only available via the EC.
41
42The driver is aware of and reads the following sensors:
43
441. Chipset (PCH) temperature
452. CPU package temperature
463. Motherboard temperature
474. Readings from the T_Sensor header
485. VRM temperature
496. CPU_Opt fan RPM
507. VRM heatsink fan RPM
518. Chipset fan RPM
529. Readings from the "Water flow meter" header (RPM)
5310. Readings from the "Water In" and "Water Out" temperature headers
5411. CPU current
5512. CPU core voltage
56
57Sensor values are read from EC registers, and to avoid race with the board
58firmware the driver acquires ACPI mutex, the one used by the WMI when its
59methods access the EC.
60
61Module Parameters
62-----------------
63 * mutex_path: string
64		The driver holds path to the ACPI mutex for each board (actually,
65		the path is mostly identical for them). If ASUS changes this path
66		in a future BIOS update, this parameter can be used to override
67		the stored in the driver value until it gets updated.
68		A special string ":GLOBAL_LOCK" can be passed to use the ACPI
69		global lock instead of a dedicated mutex.
70