From: Guenter Roeck <linux@roeck-us.net>
To: "Hans de Goede" <hdegoede@redhat.com>,
"Thomas Weißschuh" <linux@weissschuh.net>,
platform-driver-x86@vger.kernel.org,
"Mark Gross" <mgross@linux.intel.com>,
linux-kernel@vger.kernel.org,
"Barnabás Pőcze" <pobrn@protonmail.com>,
"Jean Delvare" <jdelvare@suse.com>,
linux-hwmon@vger.kernel.org
Cc: Matthew Garrett <mjg59@srcf.ucam.org>
Subject: Re: [PATCH v3] platform/x86: add Gigabyte WMI temperature driver
Date: Sat, 10 Apr 2021 08:21:07 -0700 [thread overview]
Message-ID: <2ffc9df4-f5d1-e093-6223-e6c705ef8688@roeck-us.net> (raw)
In-Reply-To: <e1b86746-b04d-0f14-8121-d24da4d10ceb@redhat.com>
On 4/10/21 7:57 AM, Hans de Goede wrote:
> Hi,
>
> On 4/10/21 4:40 PM, Thomas Weißschuh wrote:
>> Changes since v1:
>> * Incorporate feedback from Barnabás Pőcze
>> * Use a WMI driver instead of a platform driver
>> * Let the kernel manage the driver lifecycle
>> * Fix errno/ACPI error confusion
>> * Fix resource cleanup
>> * Document reason for integer casting
>>
>> Changes since v2:
>> * Style cleanups
>> * Test for usability during probing
>> * DMI-based whitelist
>> * CC hwmon maintainers
>>
>> -- >8 --
>>
>> Tested with a X570 I Aorus Pro Wifi.
>> The mainboard contains an ITE IT8688E chip for management.
>> This chips is also handled by drivers/hwmon/i87.c but as it is also used
>> by the firmware itself it needs an ACPI driver.
>>
>> Unfortunately not all sensor registers are handled by the firmware and even
>> less are exposed via WMI.
>>
>> Signed-off-by: Thomas Weißschuh <linux@weissschuh.net>
>
> This looks good, one small nitpick:
>
> I know this is a touchy subject for some, but we are trying to move away
> from the whitelist/blacklist naming where possible and we don't want to
> introduce any new cases, see:
>
> https://github.com/torvalds/linux/blob/master/Documentation/process/coding-style.rst#4-naming
>
> The driver currently uses this twice:
> "Force loading on non-whitelisted platform"
> "Forcing loading on non-whitelisted platform"
>
> Interestingly enough you already avoided naming the dmi_system_id table
> a whitelist (good).
>
> I would like to see "non-whitelisted" replaced with "unknown" so that we end up with:
>
> "Force loading on unknown platform"
> "Forcing loading on unknown platform"
>
> And while at it, I think for the second sentence this would be better English
> (I'm not a native speaker myself):
>
> "Forcing load on unknown platform"
>
Not native either, but I think it is either "Forcing load" or "Force loading".
> If you are ok with these changes I can fix this up while merging, no need
> to send a v4. Although if you prefer to send a v4 that is fine too.
>
Please consider adding an existence check into the is_visible function.
Sysfs attributes for non-existing sensors should not be created.
Thanks,
Guenter
> Either way let me know.
>
> Regards,
>
> Hans
>
> p.s.
>
> For v4 or for a next patch, the way to add the changelog so that it does
> not get picked up / automatically gets snipped by git am is to put it
> below the Signed-off-by at the end of the commit message like this:
>
> Signed-off-by: Thomas Weißschuh <linux@weissschuh.net>
> ---
> Changes since v1:
> * Incorporate feedback from Barnabás Pőcze
> * Use a WMI driver instead of a platform driver
> * Let the kernel manage the driver lifecycle
> * Fix errno/ACPI error confusion
> * Fix resource cleanup
> * Document reason for integer casting
>
> Changes since v2:
> * Style cleanups
> * Test for usability during probing
> * DMI-based whitelist
> * CC hwmon maintainers
>
>
>
>
>
>
>
>> ---
>> MAINTAINERS | 6 +
>> drivers/platform/x86/Kconfig | 11 ++
>> drivers/platform/x86/Makefile | 1 +
>> drivers/platform/x86/gigabyte-wmi.c | 194 ++++++++++++++++++++++++++++
>> 4 files changed, 212 insertions(+)
>> create mode 100644 drivers/platform/x86/gigabyte-wmi.c
>>
>> diff --git a/MAINTAINERS b/MAINTAINERS
>> index d92f85ca831d..9c10cfc00fe8 100644
>> --- a/MAINTAINERS
>> +++ b/MAINTAINERS
>> @@ -7543,6 +7543,12 @@ F: Documentation/filesystems/gfs2*
>> F: fs/gfs2/
>> F: include/uapi/linux/gfs2_ondisk.h
>>
>> +GIGABYTE WMI DRIVER
>> +M: Thomas Weißschuh <linux@weissschuh.net>
>> +L: platform-driver-x86@vger.kernel.org
>> +S: Maintained
>> +F: drivers/platform/x86/gigabyte-wmi.c
>> +
>> GNSS SUBSYSTEM
>> M: Johan Hovold <johan@kernel.org>
>> S: Maintained
>> diff --git a/drivers/platform/x86/Kconfig b/drivers/platform/x86/Kconfig
>> index ad4e630e73e2..96622a2106f7 100644
>> --- a/drivers/platform/x86/Kconfig
>> +++ b/drivers/platform/x86/Kconfig
>> @@ -123,6 +123,17 @@ config XIAOMI_WMI
>> To compile this driver as a module, choose M here: the module will
>> be called xiaomi-wmi.
>>
>> +config GIGABYTE_WMI
>> + tristate "Gigabyte WMI temperature driver"
>> + depends on ACPI_WMI
>> + depends on HWMON
>> + help
>> + Say Y here if you want to support WMI-based temperature reporting on
>> + Gigabyte mainboards.
>> +
>> + To compile this driver as a module, choose M here: the module will
>> + be called gigabyte-wmi.
>> +
>> config ACERHDF
>> tristate "Acer Aspire One temperature and fan driver"
>> depends on ACPI && THERMAL
>> diff --git a/drivers/platform/x86/Makefile b/drivers/platform/x86/Makefile
>> index 60d554073749..1621ebfd04fd 100644
>> --- a/drivers/platform/x86/Makefile
>> +++ b/drivers/platform/x86/Makefile
>> @@ -15,6 +15,7 @@ obj-$(CONFIG_INTEL_WMI_THUNDERBOLT) += intel-wmi-thunderbolt.o
>> obj-$(CONFIG_MXM_WMI) += mxm-wmi.o
>> obj-$(CONFIG_PEAQ_WMI) += peaq-wmi.o
>> obj-$(CONFIG_XIAOMI_WMI) += xiaomi-wmi.o
>> +obj-$(CONFIG_GIGABYTE_WMI) += gigabyte-wmi.o
>>
>> # Acer
>> obj-$(CONFIG_ACERHDF) += acerhdf.o
>> diff --git a/drivers/platform/x86/gigabyte-wmi.c b/drivers/platform/x86/gigabyte-wmi.c
>> new file mode 100644
>> index 000000000000..fb4e6d4c1823
>> --- /dev/null
>> +++ b/drivers/platform/x86/gigabyte-wmi.c
>> @@ -0,0 +1,194 @@
>> +// SPDX-License-Identifier: GPL-2.0-or-later
>> +/*
>> + * Copyright (C) 2021 Thomas Weißschuh <thomas@weissschuh.net>
>> + */
>> +#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
>> +
>> +#include <linux/acpi.h>
>> +#include <linux/dmi.h>
>> +#include <linux/hwmon.h>
>> +#include <linux/module.h>
>> +#include <linux/wmi.h>
>> +
>> +#define GIGABYTE_WMI_GUID "DEADBEEF-2001-0000-00A0-C90629100000"
>> +#define NUM_TEMPERATURE_SENSORS 6
>> +
>> +static bool force_load;
>> +module_param(force_load, bool, 0);
>> +MODULE_PARM_DESC(force_load, "Force loading on non-whitelisted platform");
>> +
>> +enum gigabyte_wmi_commandtype {
>> + GIGABYTE_WMI_BUILD_DATE_QUERY = 0x1,
>> + GIGABYTE_WMI_MAINBOARD_TYPE_QUERY = 0x2,
>> + GIGABYTE_WMI_FIRMWARE_VERSION_QUERY = 0x4,
>> + GIGABYTE_WMI_MAINBOARD_NAME_QUERY = 0x5,
>> + GIGABYTE_WMI_TEMPERATURE_QUERY = 0x125,
>> +};
>> +
>> +struct gigabyte_wmi_args {
>> + u32 arg1;
>> +};
>> +
>> +static int gigabyte_wmi_perform_query(struct wmi_device *wdev,
>> + enum gigabyte_wmi_commandtype command,
>> + struct gigabyte_wmi_args *args, struct acpi_buffer *out)
>> +{
>> + const struct acpi_buffer in = {
>> + .length = sizeof(*args),
>> + .pointer = args,
>> + };
>> +
>> + acpi_status ret = wmidev_evaluate_method(wdev, 0x0, command, &in, out);
>> +
>> + if ACPI_FAILURE(ret)
>> + return -EIO;
>> +
>> + return 0;
>> +}
>> +
>> +static int gigabyte_wmi_query_integer(struct wmi_device *wdev,
>> + enum gigabyte_wmi_commandtype command,
>> + struct gigabyte_wmi_args *args, u64 *res)
>> +{
>> + union acpi_object *obj;
>> + struct acpi_buffer result = { ACPI_ALLOCATE_BUFFER, NULL };
>> + int ret;
>> +
>> + ret = gigabyte_wmi_perform_query(wdev, command, args, &result);
>> + if (ret)
>> + return ret;
>> + obj = result.pointer;
>> + if (obj && obj->type == ACPI_TYPE_INTEGER)
>> + *res = obj->integer.value;
>> + else
>> + ret = -EIO;
>> + kfree(result.pointer);
>> + return ret;
>> +}
>> +
>> +static int gigabyte_wmi_temperature(struct wmi_device *wdev, u8 sensor, long *res)
>> +{
>> + struct gigabyte_wmi_args args = {
>> + .arg1 = sensor,
>> + };
>> + u64 temp;
>> + acpi_status ret;
>> +
>> + ret = gigabyte_wmi_query_integer(wdev, GIGABYTE_WMI_TEMPERATURE_QUERY, &args, &temp);
>> + if (ret == 0) {
>> + if (temp == 0)
>> + return -ENODEV;
>> + *res = (s8)temp * 1000; // value is a signed 8-bit integer
>> + }
>> + return ret;
>> +}
>> +
>> +static int gigabyte_wmi_hwmon_read(struct device *dev, enum hwmon_sensor_types type,
>> + u32 attr, int channel, long *val)
>> +{
>> + struct wmi_device *wdev = dev_get_drvdata(dev);
>> +
>> + return gigabyte_wmi_temperature(wdev, channel, val);
>> +}
>> +
>> +static umode_t gigabyte_wmi_hwmon_is_visible(const void *data, enum hwmon_sensor_types type,
>> + u32 attr, int channel)
>> +{
>> + return 0444;
>> +}
>> +
>> +static const struct hwmon_channel_info *gigabyte_wmi_hwmon_info[] = {
>> + HWMON_CHANNEL_INFO(temp,
>> + HWMON_T_INPUT,
>> + HWMON_T_INPUT,
>> + HWMON_T_INPUT,
>> + HWMON_T_INPUT,
>> + HWMON_T_INPUT,
>> + HWMON_T_INPUT),
>> + NULL
>> +};
>> +
>> +static const struct hwmon_ops gigabyte_wmi_hwmon_ops = {
>> + .read = gigabyte_wmi_hwmon_read,
>> + .is_visible = gigabyte_wmi_hwmon_is_visible,
>> +};
>> +
>> +static const struct hwmon_chip_info gigabyte_wmi_hwmon_chip_info = {
>> + .ops = &gigabyte_wmi_hwmon_ops,
>> + .info = gigabyte_wmi_hwmon_info,
>> +};
>> +
>> +static int gigabyte_wmi_validate_sensor_presence(struct wmi_device *wdev)
>> +{
>> + int working_sensors = 0, i;
>> + long temp;
>> +
>> + for (i = 0; i < NUM_TEMPERATURE_SENSORS; i++) {
>> + if (!gigabyte_wmi_temperature(wdev, i, &temp))
>> + working_sensors++;
>> + }
>> + return working_sensors ? 0 : -ENODEV;
>> +}
>> +
>> +static const struct dmi_system_id gigabyte_wmi_known_working_platforms[] = {
>> + { .matches = {
>> + DMI_EXACT_MATCH(DMI_BOARD_VENDOR, "Gigabyte Technology Co., Ltd."),
>> + DMI_EXACT_MATCH(DMI_BOARD_NAME, "B550 GAMING X V2"),
>> + }},
>> + { .matches = {
>> + DMI_EXACT_MATCH(DMI_BOARD_VENDOR, "Gigabyte Technology Co., Ltd."),
>> + DMI_EXACT_MATCH(DMI_BOARD_NAME, "B550M DS3H"),
>> + }},
>> + { .matches = {
>> + DMI_EXACT_MATCH(DMI_BOARD_VENDOR, "Gigabyte Technology Co., Ltd."),
>> + DMI_EXACT_MATCH(DMI_BOARD_NAME, "Z390 I AORUS PRO WIFI-CF"),
>> + }},
>> + { .matches = {
>> + DMI_EXACT_MATCH(DMI_BOARD_VENDOR, "Gigabyte Technology Co., Ltd."),
>> + DMI_EXACT_MATCH(DMI_BOARD_NAME, "X570 I AORUS PRO WIFI"),
>> + }},
>> + { }
>> +};
>> +
>> +static int gigabyte_wmi_probe(struct wmi_device *wdev, const void *context)
>> +{
>> + struct device *hwmon_dev;
>> + int ret;
>> +
>> + if (!dmi_check_system(gigabyte_wmi_known_working_platforms)) {
>> + if (force_load)
>> + dev_warn(&wdev->dev, "Forcing loading on non-whitelisted platform");
>> + else
>> + return -ENODEV;
>> + }
>> +
>> + ret = gigabyte_wmi_validate_sensor_presence(wdev);
>> + if (ret) {
>> + dev_info(&wdev->dev, "No temperature sensors usable");
>> + return ret;
>> + }
>> +
>> + hwmon_dev = devm_hwmon_device_register_with_info(&wdev->dev, "gigabyte_wmi", wdev,
>> + &gigabyte_wmi_hwmon_chip_info, NULL);
>> +
>> + return PTR_ERR_OR_ZERO(hwmon_dev);
>> +}
>> +
>> +static const struct wmi_device_id gigabyte_wmi_id_table[] = {
>> + { GIGABYTE_WMI_GUID, NULL },
>> + { }
>> +};
>> +
>> +static struct wmi_driver gigabyte_wmi_driver = {
>> + .driver = {
>> + .name = "gigabyte-wmi",
>> + },
>> + .id_table = gigabyte_wmi_id_table,
>> + .probe = gigabyte_wmi_probe,
>> +};
>> +module_wmi_driver(gigabyte_wmi_driver);
>> +
>> +MODULE_DEVICE_TABLE(wmi, gigabyte_wmi_id_table);
>> +MODULE_AUTHOR("Thomas Weißschuh <thomas@weissschuh.net>");
>> +MODULE_DESCRIPTION("Gigabyte WMI temperature Driver");
>> +MODULE_LICENSE("GPL");
>>
>> base-commit: 144c79ef33536b4ecb4951e07dbc1f2b7fa99d32
>>
>
next prev parent reply other threads:[~2021-04-10 15:21 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-04-05 13:20 [PATCH] platform/x86: add Gigabyte WMI temperature driver Thomas Weißschuh
2021-04-05 17:13 ` Barnabás Pőcze
2021-04-05 20:48 ` [PATCH v2] " Thomas Weißschuh
2021-04-07 15:54 ` Hans de Goede
2021-04-07 19:43 ` Thomas Weißschuh
2021-04-08 9:36 ` Hans de Goede
2021-04-08 14:54 ` Thomas Weißschuh
2021-04-08 15:00 ` Guenter Roeck
2021-04-09 6:02 ` Thomas Weißschuh
2021-04-10 6:56 ` Guenter Roeck
2021-04-10 14:21 ` Hans de Goede
2021-04-10 14:40 ` [PATCH v3] " Thomas Weißschuh
2021-04-10 14:57 ` Hans de Goede
2021-04-10 15:21 ` Guenter Roeck [this message]
2021-04-10 15:15 ` Guenter Roeck
2021-04-10 15:23 ` Hans de Goede
2021-04-10 18:18 ` [PATCH v4] " Thomas Weißschuh
2021-04-11 0:58 ` Guenter Roeck
2021-04-11 14:05 ` Barnabás Pőcze
2021-04-12 12:35 ` [PATCH v5] " Thomas Weißschuh
2021-04-13 8:14 ` Hans de Goede
2021-04-07 18:27 ` [PATCH v2] " Barnabás Pőcze
2021-04-08 14:39 ` Thomas Weißschuh
2021-04-08 15:08 ` Guenter Roeck
2021-04-08 16:07 ` Hans de Goede
2021-04-10 6:40 ` Guenter Roeck
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=2ffc9df4-f5d1-e093-6223-e6c705ef8688@roeck-us.net \
--to=linux@roeck-us.net \
--cc=hdegoede@redhat.com \
--cc=jdelvare@suse.com \
--cc=linux-hwmon@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@weissschuh.net \
--cc=mgross@linux.intel.com \
--cc=mjg59@srcf.ucam.org \
--cc=platform-driver-x86@vger.kernel.org \
--cc=pobrn@protonmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).