Update readme to answer commonly asked questions
This commit is contained in:
ed
parent
8daafd45d1
commit
1a1f8a829d
25
README.md
25
README.md
|
|
@ -1,8 +1,8 @@
|
|||
# Linux ASUS WMI Sensor driver.
|
||||
# Linux ASUS WMI Sensor driver
|
||||
|
||||
## General info
|
||||
|
||||
Provides a Linux kernel module "asus_wmi_sensors" that provides sensor readouts via ASUS' WMI interface present in the UEFI of some recent Ryzen motherboards.
|
||||
Provides a Linux kernel module "asus_wmi_sensors" that provides sensor readouts via ASUS' WMI interface present in the UEFI of some X370/X470/B450/X399 Ryzen motherboards.
|
||||
|
||||
## Features
|
||||
- Reports all values scaled and named identically to in the UEFI interface
|
||||
|
|
@ -21,6 +21,7 @@ Provides a Linux kernel module "asus_wmi_sensors" that provides sensor readouts
|
|||
|ROG STRIX B450-F GAMING | 2406 |
|
||||
|ROG STRIX B450-I GAMING | 2406 |
|
||||
|ROG STRIX X470-F GAMING | 5007 |
|
||||
|ROG STRIX X470-I GAMING | ? |
|
||||
|ROG STRIX X399-E GAMING | |
|
||||
|ASUS Zenith Extreme | 1607/1701 |
|
||||
|ASUS Zenith Extreme Alpha | 0207 |
|
||||
|
|
@ -34,6 +35,8 @@ Provides a Linux kernel module "asus_wmi_sensors" that provides sensor readouts
|
|||
|X570 boards (no WMI interface - use `nct6775` driver instead)|
|
||||
|Prime B450-Plus|
|
||||
|Prime X370-Pro|
|
||||
|TUF B450-PLUS GAMING|
|
||||
|TUF X470-PLUS GAMING|
|
||||
|
||||
## How to install
|
||||
|
||||
|
|
@ -50,6 +53,9 @@ The module can be manually loaded by issuing ```sudo modprobe asus_wmi_sensors``
|
|||
|
||||
Run ```sensors``` and you should see a ```asuswmisensors-isa-0000``` device and readouts as you see in the UEFI interface.
|
||||
|
||||
### Gentoo
|
||||
An ebuild is available in gyakovlev's overlay. https://github.com/gyakovlev/gentoo-overlay/tree/master/sys-kernel/asus-wmi-sensors
|
||||
|
||||
### Other distributions
|
||||
|
||||
Clone the git repository: ```git clone https://github.com/electrified/asus-wmi-sensors.git```
|
||||
|
|
@ -70,6 +76,9 @@ First verify that WMI hardware monitoring is working for your board under Window
|
|||
### Why do some of my temperatures return 216 deg C?
|
||||
This is the value returned for temperature sensor headers with no sensor connected.
|
||||
|
||||
### Why are some of the sensors (e.g. CPU Core Voltage) duplicated?
|
||||
The driver simply returns all the sensors available in the WMI output. CPU Voltage and others are included twice, in the Embedded Controller and SIO banks.
|
||||
|
||||
### Why is reading from the sensors so slow?
|
||||
This driver is not reading from the SuperIO/ Embedded controller directly, it uses a WMI interface put in the UEFI firmware by ASUS. Reading from this WMI interface seems inherently slow. I am investigating calling the underlying ACPI methods that the WMI interface calls which I have been told performs better.
|
||||
|
||||
|
|
@ -80,6 +89,14 @@ Many of Asus' recent Ryzen motherboards have the ITE IT8665E sensor IC, which do
|
|||
- The existing drivers are basic platform devices rather than using the kernels' WMI bus
|
||||
- These new sensor methods are on a different WMI class - "ASUSHW" than the existing "ASUSManagment" class which the other driver uses. The existing driver largely deals with laptop functionality (hotkeys, WiFi kill switches, screen brightness). Adding to that driver support for this additional sensors functionality would make it quite large.
|
||||
|
||||
### Is it possible to control the speed of fans with this driver?
|
||||
No, fan control is not part of the Asus sensors WMI interface. It may be possible via an undocumented method, but that would require reverse engineering effort.
|
||||
|
||||
### I am using Ubutu with a Ukuu kernel and the module won't build
|
||||
If you use ukuu, or any other method to install a kernel, you should use the version of GCC used to build the kernel to build any additional out-of-tree modules otherwise you may run into issues.
|
||||
|
||||
Check `cat /proc/version` to see the version of GCC used to build the kernel, and upgrade your GCC install appropriately. (Usually an upgrade from GCC 7 to GCC 9 is needed)
|
||||
|
||||
## Example sensors output
|
||||
|
||||
```
|
||||
|
|
@ -119,6 +136,10 @@ Water Out: +28.0°C
|
|||
CPU VRM Output Current: +1.00 A
|
||||
```
|
||||
|
||||
## Known Issues
|
||||
- The WMI implementation in some of Asus' BIOSes is buggy. This can result in fans stopping, fans getting stuck at max speed, or temperature readouts getting stuck. This is not an issue with the driver, but the BIOS. The Prime X470 Pro seems particularly bad for this. The more frequently the WMI interface is polled the greater the potential for this to happen. Until you have subjected your computer to an extended soak test while polling the sensors frequently, don't leave you computer unattended. I can personally say I've seen the issue on the Crosshair VII with BIOS 2606 and a Ryzen 2700X, upgrading to 3004 rectified the issue.
|
||||
- A few boards report 12v voltages to be ~10v. Once again this is a BIOS issue.
|
||||
|
||||
## Thanks
|
||||
- Ray Hinchcliffe, author of SIV for info
|
||||
- Original authors of the IT87 makefile
|
||||
|
|
|
|||
Loading…
Reference in New Issue