Re: [ASUS EC Sensors v8 2/3] hwmon: (asus-ec-sensors) update documentation

[Oleksandr Natalenko <oleksandr@natalenko.name>]

On pondělí 24. ledna 2022 2:56:44 CET Eugene Shalygin wrote:
> Signed-off-by: Eugene Shalygin <eugene.shalygin@gmail.com>

I believe some commit message is desired here.

> ---
>  Documentation/hwmon/asus_ec_sensors.rst     | 52 +++++++++++++++++++++
>  Documentation/hwmon/asus_wmi_ec_sensors.rst | 38 ---------------
>  2 files changed, 52 insertions(+), 38 deletions(-)
>  create mode 100644 Documentation/hwmon/asus_ec_sensors.rst
>  delete mode 100644 Documentation/hwmon/asus_wmi_ec_sensors.rst
> 
> diff --git a/Documentation/hwmon/asus_ec_sensors.rst b/Documentation/hwmon/asus_ec_sensors.rst
> new file mode 100644
> index 000000000000..b12ac7ebeb1a
> --- /dev/null
> +++ b/Documentation/hwmon/asus_ec_sensors.rst
> @@ -0,0 +1,52 @@
> +.. SPDX-License-Identifier: GPL-2.0-or-later
> +
> +Kernel driver asus_ec_sensors
> +=================================
> +
> +Supported boards:
> + * PRIME X570-PRO,
> + * Pro WS X570-ACE,
> + * ROG CROSSHAIR VIII DARK HERO,
> + * ROG CROSSHAIR VIII FORMULA,
> + * ROG CROSSHAIR VIII HERO,
> + * ROG CROSSHAIR VIII IMPACT,
> + * ROG STRIX B550-E GAMING,
> + * ROG STRIX B550-I GAMING,
> + * ROG STRIX X570-E GAMING,
> + * ROG STRIX X570-F GAMING,
> + * ROG STRIX X570-I GAMING
> +
> +Authors:
> +    - Eugene Shalygin <eugene.shalygin@gmail.com>
> +
> +Description:
> +------------
> +ASUS mainboards publish hardware monitoring information via Super I/O
> +chip and the ACPI embedded controller (EC) registers. Some of the sensors
> +are only available via the EC.
> +
> +The driver is aware of and reads the following sensors:
> +
> +1. Chipset (PCH) temperature
> +2. CPU package temperature
> +3. Motherboard temperature
> +4. Readings from the T_Sensor header
> +5. VRM temperature
> +6. CPU_Opt fan RPM
> +7. VRM heatsink fan RPM
> +8. Chipset fan RPM
> +9. Readings from the "Water flow meter" header (RPM)
> +10. Readings from the "Water In" and "Water Out" temperature headers
> +11. CPU current
> +
> +Sensor values are read from EC registers, and to avoid race with the board
> +firmware the driver acquires ACPI mutex, the one used by the WMI when its
> +methods access the EC.
> +
> +Module Parameters
> +-----------------
> + * mutex_path: string
> +		The driver holds path to the ACPI mutex for each board (actually,
> +		the path is mostly identical for them). If ASUS changes this path
> +		in a future BIOS update, this parameter can be used to override
> +		the stored in the driver value until it gets updated.
> diff --git a/Documentation/hwmon/asus_wmi_ec_sensors.rst b/Documentation/hwmon/asus_wmi_ec_sensors.rst
> deleted file mode 100644
> index 1b287f229e86..000000000000
> --- a/Documentation/hwmon/asus_wmi_ec_sensors.rst
> +++ /dev/null
> @@ -1,38 +0,0 @@
> -.. SPDX-License-Identifier: GPL-2.0-or-later
> -
> -Kernel driver asus_wmi_ec_sensors
> -=================================
> -
> -Supported boards:
> - * PRIME X570-PRO,
> - * Pro WS X570-ACE,
> - * ROG CROSSHAIR VIII DARK HERO,
> - * ROG CROSSHAIR VIII FORMULA,
> - * ROG CROSSHAIR VIII HERO,
> - * ROG STRIX B550-E GAMING,
> - * ROG STRIX B550-I GAMING,
> - * ROG STRIX X570-E GAMING.
> -
> -Authors:
> -    - Eugene Shalygin <eugene.shalygin@gmail.com>
> -
> -Description:
> -------------
> -ASUS mainboards publish hardware monitoring information via Super I/O
> -chip and the ACPI embedded controller (EC) registers. Some of the sensors
> -are only available via the EC.
> -
> -ASUS WMI interface provides a method (BREC) to read data from EC registers,
> -which is utilized by this driver to publish those sensor readings to the
> -HWMON system. The driver is aware of and reads the following sensors:
> -
> -1. Chipset (PCH) temperature
> -2. CPU package temperature
> -3. Motherboard temperature
> -4. Readings from the T_Sensor header
> -5. VRM temperature
> -6. CPU_Opt fan RPM
> -7. Chipset fan RPM
> -8. Readings from the "Water flow meter" header (RPM)
> -9. Readings from the "Water In" and "Water Out" temperature headers
> -10. CPU current
> 


-- 
Oleksandr Natalenko (post-factum)