1.. SPDX-License-Identifier: GPL-2.0-or-later
2
3Kernel driver asus_ec_sensors
4=================================
5
6Supported boards:
7 * PRIME X570-PRO,
8 * Pro WS X570-ACE,
9 * ROG CROSSHAIR VIII DARK HERO,
10 * ROG CROSSHAIR VIII HERO (WI-FI)
11 * ROG CROSSHAIR VIII FORMULA,
12 * ROG CROSSHAIR VIII HERO,
13 * ROG CROSSHAIR VIII IMPACT,
14 * ROG STRIX B550-E GAMING,
15 * ROG STRIX B550-I GAMING,
16 * ROG STRIX X570-E GAMING,
17 * ROG STRIX X570-F GAMING,
18 * ROG STRIX X570-I GAMING
19
20Authors:
21    - Eugene Shalygin <eugene.shalygin@gmail.com>
22
23Description:
24------------
25ASUS mainboards publish hardware monitoring information via Super I/O
26chip and the ACPI embedded controller (EC) registers. Some of the sensors
27are only available via the EC.
28
29The driver is aware of and reads the following sensors:
30
311. Chipset (PCH) temperature
322. CPU package temperature
333. Motherboard temperature
344. Readings from the T_Sensor header
355. VRM temperature
366. CPU_Opt fan RPM
377. VRM heatsink fan RPM
388. Chipset fan RPM
399. Readings from the "Water flow meter" header (RPM)
4010. Readings from the "Water In" and "Water Out" temperature headers
4111. CPU current
4212. CPU core voltage
43
44Sensor values are read from EC registers, and to avoid race with the board
45firmware the driver acquires ACPI mutex, the one used by the WMI when its
46methods access the EC.
47
48Module Parameters
49-----------------
50 * mutex_path: string
51		The driver holds path to the ACPI mutex for each board (actually,
52		the path is mostly identical for them). If ASUS changes this path
53		in a future BIOS update, this parameter can be used to override
54		the stored in the driver value until it gets updated.
55