module: Convert symbol namespace to string literal
[linux.git] / Documentation / hwmon / asus_ec_sensors.rst
blobca38922f4ec5639840d4980f47b8a15bd9e2a133
1 .. SPDX-License-Identifier: GPL-2.0-or-later
3 Kernel driver asus_ec_sensors
4 =================================
6 Supported 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
33 Authors:
34     - Eugene Shalygin <eugene.shalygin@gmail.com>
36 Description:
37 ------------
38 ASUS mainboards publish hardware monitoring information via Super I/O
39 chip and the ACPI embedded controller (EC) registers. Some of the sensors
40 are only available via the EC.
42 The driver is aware of and reads the following sensors:
44 1. Chipset (PCH) temperature
45 2. CPU package temperature
46 3. Motherboard temperature
47 4. Readings from the T_Sensor header
48 5. VRM temperature
49 6. CPU_Opt fan RPM
50 7. VRM heatsink fan RPM
51 8. Chipset fan RPM
52 9. Readings from the "Water flow meter" header (RPM)
53 10. Readings from the "Water In" and "Water Out" temperature headers
54 11. CPU current
55 12. CPU core voltage
57 Sensor values are read from EC registers, and to avoid race with the board
58 firmware the driver acquires ACPI mutex, the one used by the WMI when its
59 methods access the EC.
61 Module 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.