10314c6acSEugene Shalygin.. SPDX-License-Identifier: GPL-2.0-or-later
20314c6acSEugene Shalygin
30314c6acSEugene ShalyginKernel driver asus_ec_sensors
40314c6acSEugene Shalygin=================================
50314c6acSEugene Shalygin
60314c6acSEugene ShalyginSupported boards:
70314c6acSEugene Shalygin * PRIME X570-PRO,
80314c6acSEugene Shalygin * Pro WS X570-ACE,
9d7cc063fSEugene Shalygin * ProArt X570-CREATOR WIFI
100314c6acSEugene Shalygin * ROG CROSSHAIR VIII DARK HERO,
112f66cb5bSEugene Shalygin * ROG CROSSHAIR VIII HERO (WI-FI)
120314c6acSEugene Shalygin * ROG CROSSHAIR VIII FORMULA,
130314c6acSEugene Shalygin * ROG CROSSHAIR VIII HERO,
140314c6acSEugene Shalygin * ROG CROSSHAIR VIII IMPACT,
150314c6acSEugene Shalygin * ROG STRIX B550-E GAMING,
160314c6acSEugene Shalygin * ROG STRIX B550-I GAMING,
170314c6acSEugene Shalygin * ROG STRIX X570-E GAMING,
180314c6acSEugene Shalygin * ROG STRIX X570-F GAMING,
190314c6acSEugene Shalygin * ROG STRIX X570-I GAMING
200314c6acSEugene Shalygin
210314c6acSEugene ShalyginAuthors:
220314c6acSEugene Shalygin    - Eugene Shalygin <eugene.shalygin@gmail.com>
230314c6acSEugene Shalygin
240314c6acSEugene ShalyginDescription:
250314c6acSEugene Shalygin------------
260314c6acSEugene ShalyginASUS mainboards publish hardware monitoring information via Super I/O
270314c6acSEugene Shalyginchip and the ACPI embedded controller (EC) registers. Some of the sensors
280314c6acSEugene Shalyginare only available via the EC.
290314c6acSEugene Shalygin
300314c6acSEugene ShalyginThe driver is aware of and reads the following sensors:
310314c6acSEugene Shalygin
320314c6acSEugene Shalygin1. Chipset (PCH) temperature
330314c6acSEugene Shalygin2. CPU package temperature
340314c6acSEugene Shalygin3. Motherboard temperature
350314c6acSEugene Shalygin4. Readings from the T_Sensor header
360314c6acSEugene Shalygin5. VRM temperature
370314c6acSEugene Shalygin6. CPU_Opt fan RPM
380314c6acSEugene Shalygin7. VRM heatsink fan RPM
390314c6acSEugene Shalygin8. Chipset fan RPM
400314c6acSEugene Shalygin9. Readings from the "Water flow meter" header (RPM)
410314c6acSEugene Shalygin10. Readings from the "Water In" and "Water Out" temperature headers
420314c6acSEugene Shalygin11. CPU current
43f545a2fdSEugene Shalygin12. CPU core voltage
440314c6acSEugene Shalygin
450314c6acSEugene ShalyginSensor values are read from EC registers, and to avoid race with the board
460314c6acSEugene Shalyginfirmware the driver acquires ACPI mutex, the one used by the WMI when its
470314c6acSEugene Shalyginmethods access the EC.
480314c6acSEugene Shalygin
490314c6acSEugene ShalyginModule Parameters
500314c6acSEugene Shalygin-----------------
510314c6acSEugene Shalygin * mutex_path: string
520314c6acSEugene Shalygin		The driver holds path to the ACPI mutex for each board (actually,
530314c6acSEugene Shalygin		the path is mostly identical for them). If ASUS changes this path
540314c6acSEugene Shalygin		in a future BIOS update, this parameter can be used to override
550314c6acSEugene Shalygin		the stored in the driver value until it gets updated.
56*de8fbac5SEugene Shalygin		A special string ":GLOBAL_LOCK" can be passed to use the ACPI
57*de8fbac5SEugene Shalygin		global lock instead of a dedicated mutex.
58