[PATCH v6 09/12] platform/x86: alienware-wmi-wmax: Add a DebugFS interface

Kurt Borja posted 12 patches 9 months, 1 week ago
There is a newer version of this series
[PATCH v6 09/12] platform/x86: alienware-wmi-wmax: Add a DebugFS interface
Posted by Kurt Borja 9 months, 1 week ago
Add a debugfs interface which exposes thermal private data.

Reviewed-by: Armin Wolf <W_Armin@gmx.de>
Signed-off-by: Kurt Borja <kuurtb@gmail.com>
---
 drivers/platform/x86/dell/alienware-wmi-wmax.c | 90 ++++++++++++++++++++++++++
 1 file changed, 90 insertions(+)

diff --git a/drivers/platform/x86/dell/alienware-wmi-wmax.c b/drivers/platform/x86/dell/alienware-wmi-wmax.c
index 823b579260555085ef6ac793b806738a756bb9da..472e6289fec5be0db0a5cb8e76718b750fa558b5 100644
--- a/drivers/platform/x86/dell/alienware-wmi-wmax.c
+++ b/drivers/platform/x86/dell/alienware-wmi-wmax.c
@@ -11,6 +11,7 @@
 #include <linux/bitfield.h>
 #include <linux/bitmap.h>
 #include <linux/bits.h>
+#include <linux/debugfs.h>
 #include <linux/dmi.h>
 #include <linux/hwmon.h>
 #include <linux/hwmon-sysfs.h>
@@ -19,6 +20,7 @@
 #include <linux/moduleparam.h>
 #include <linux/platform_profile.h>
 #include <linux/pm.h>
+#include <linux/seq_file.h>
 #include <linux/units.h>
 #include <linux/wmi.h>
 #include "alienware-wmi.h"
@@ -1252,6 +1254,92 @@ static int awcc_platform_profile_init(struct wmi_device *wdev)
 	return PTR_ERR_OR_ZERO(priv->ppdev);
 }
 
+/*
+ * DebugFS
+ */
+static int awcc_debugfs_system_description_read(struct seq_file *seq, void *data)
+{
+	struct device *dev = seq->private;
+	struct awcc_priv *priv = dev_get_drvdata(dev);
+
+	seq_printf(seq, "0x%08x\n", priv->system_description);
+
+	return 0;
+}
+
+static int awcc_debugfs_hwmon_data_read(struct seq_file *seq, void *data)
+{
+	struct device *dev = seq->private;
+	struct awcc_priv *priv = dev_get_drvdata(dev);
+	const struct awcc_fan_data *fan;
+	unsigned int bit;
+
+	seq_printf(seq, "Number of fans: %u\n", priv->fan_count);
+	seq_printf(seq, "Number of temperature sensors: %u\n\n", priv->temp_count);
+
+	for (u32 i = 0; i < priv->fan_count; i++) {
+		fan = priv->fan_data[i];
+
+		seq_printf(seq, "Fan %u:\n", i);
+		seq_printf(seq, "  ID: 0x%02x\n", fan->id);
+		seq_printf(seq, "  Related temperature sensors bitmap: %lu\n",
+			   fan->auto_channels_temp);
+	}
+
+	seq_puts(seq, "\nTemperature sensor IDs:\n");
+	for_each_set_bit(bit, priv->temp_sensors, AWCC_ID_BITMAP_SIZE)
+		seq_printf(seq, "  0x%02x\n", bit);
+
+	return 0;
+}
+
+static int awcc_debugfs_pprof_data_read(struct seq_file *seq, void *data)
+{
+	struct device *dev = seq->private;
+	struct awcc_priv *priv = dev_get_drvdata(dev);
+
+	seq_printf(seq, "Number of thermal profiles: %u\n\n", priv->profile_count);
+
+	for (u32 i = 0; i < PLATFORM_PROFILE_LAST; i++) {
+		if (!priv->supported_profiles[i])
+			continue;
+
+		seq_printf(seq, "Platform profile %u:\n", i);
+		seq_printf(seq, "  ID: 0x%02x\n", priv->supported_profiles[i]);
+	}
+
+	return 0;
+}
+
+static void awcc_debugfs_remove(void *data)
+{
+	struct dentry *root = data;
+
+	debugfs_remove(root);
+}
+
+static void awcc_debugfs_init(struct wmi_device *wdev)
+{
+	struct dentry *root;
+	char name[64];
+
+	scnprintf(name, ARRAY_SIZE(name), "%s-%s", "alienware-wmi", dev_name(&wdev->dev));
+	root = debugfs_create_dir(name, NULL);
+
+	debugfs_create_devm_seqfile(&wdev->dev, "system_description", root,
+				    awcc_debugfs_system_description_read);
+
+	if (awcc->hwmon)
+		debugfs_create_devm_seqfile(&wdev->dev, "hwmon_data", root,
+					    awcc_debugfs_hwmon_data_read);
+
+	if (awcc->pprof)
+		debugfs_create_devm_seqfile(&wdev->dev, "pprof_data", root,
+					    awcc_debugfs_pprof_data_read);
+
+	devm_add_action_or_reset(&wdev->dev, awcc_debugfs_remove, root);
+}
+
 static int alienware_awcc_setup(struct wmi_device *wdev)
 {
 	struct awcc_priv *priv;
@@ -1290,6 +1378,8 @@ static int alienware_awcc_setup(struct wmi_device *wdev)
 			return ret;
 	}
 
+	awcc_debugfs_init(wdev);
+
 	return 0;
 }
 

-- 
2.48.1
Re: [PATCH v6 09/12] platform/x86: alienware-wmi-wmax: Add a DebugFS interface
Posted by Ilpo Järvinen 8 months, 3 weeks ago
On Thu, 13 Mar 2025, Kurt Borja wrote:

> Add a debugfs interface which exposes thermal private data.
> 
> Reviewed-by: Armin Wolf <W_Armin@gmx.de>
> Signed-off-by: Kurt Borja <kuurtb@gmail.com>
> ---
>  drivers/platform/x86/dell/alienware-wmi-wmax.c | 90 ++++++++++++++++++++++++++
>  1 file changed, 90 insertions(+)
> 
> diff --git a/drivers/platform/x86/dell/alienware-wmi-wmax.c b/drivers/platform/x86/dell/alienware-wmi-wmax.c
> index 823b579260555085ef6ac793b806738a756bb9da..472e6289fec5be0db0a5cb8e76718b750fa558b5 100644
> --- a/drivers/platform/x86/dell/alienware-wmi-wmax.c
> +++ b/drivers/platform/x86/dell/alienware-wmi-wmax.c
> @@ -11,6 +11,7 @@
>  #include <linux/bitfield.h>
>  #include <linux/bitmap.h>
>  #include <linux/bits.h>
> +#include <linux/debugfs.h>
>  #include <linux/dmi.h>
>  #include <linux/hwmon.h>
>  #include <linux/hwmon-sysfs.h>
> @@ -19,6 +20,7 @@
>  #include <linux/moduleparam.h>
>  #include <linux/platform_profile.h>
>  #include <linux/pm.h>
> +#include <linux/seq_file.h>
>  #include <linux/units.h>
>  #include <linux/wmi.h>
>  #include "alienware-wmi.h"
> @@ -1252,6 +1254,92 @@ static int awcc_platform_profile_init(struct wmi_device *wdev)
>  	return PTR_ERR_OR_ZERO(priv->ppdev);
>  }
>  
> +/*
> + * DebugFS
> + */
> +static int awcc_debugfs_system_description_read(struct seq_file *seq, void *data)
> +{
> +	struct device *dev = seq->private;
> +	struct awcc_priv *priv = dev_get_drvdata(dev);
> +
> +	seq_printf(seq, "0x%08x\n", priv->system_description);
> +
> +	return 0;
> +}
> +
> +static int awcc_debugfs_hwmon_data_read(struct seq_file *seq, void *data)
> +{
> +	struct device *dev = seq->private;
> +	struct awcc_priv *priv = dev_get_drvdata(dev);
> +	const struct awcc_fan_data *fan;
> +	unsigned int bit;
> +
> +	seq_printf(seq, "Number of fans: %u\n", priv->fan_count);
> +	seq_printf(seq, "Number of temperature sensors: %u\n\n", priv->temp_count);
> +
> +	for (u32 i = 0; i < priv->fan_count; i++) {
> +		fan = priv->fan_data[i];
> +
> +		seq_printf(seq, "Fan %u:\n", i);
> +		seq_printf(seq, "  ID: 0x%02x\n", fan->id);
> +		seq_printf(seq, "  Related temperature sensors bitmap: %lu\n",
> +			   fan->auto_channels_temp);
> +	}
> +
> +	seq_puts(seq, "\nTemperature sensor IDs:\n");
> +	for_each_set_bit(bit, priv->temp_sensors, AWCC_ID_BITMAP_SIZE)
> +		seq_printf(seq, "  0x%02x\n", bit);
> +
> +	return 0;
> +}
> +
> +static int awcc_debugfs_pprof_data_read(struct seq_file *seq, void *data)
> +{
> +	struct device *dev = seq->private;
> +	struct awcc_priv *priv = dev_get_drvdata(dev);
> +
> +	seq_printf(seq, "Number of thermal profiles: %u\n\n", priv->profile_count);
> +
> +	for (u32 i = 0; i < PLATFORM_PROFILE_LAST; i++) {
> +		if (!priv->supported_profiles[i])
> +			continue;
> +
> +		seq_printf(seq, "Platform profile %u:\n", i);
> +		seq_printf(seq, "  ID: 0x%02x\n", priv->supported_profiles[i]);
> +	}
> +
> +	return 0;
> +}
> +
> +static void awcc_debugfs_remove(void *data)
> +{
> +	struct dentry *root = data;
> +
> +	debugfs_remove(root);
> +}
> +
> +static void awcc_debugfs_init(struct wmi_device *wdev)
> +{
> +	struct dentry *root;
> +	char name[64];
> +
> +	scnprintf(name, ARRAY_SIZE(name), "%s-%s", "alienware-wmi", dev_name(&wdev->dev));

You'd need to add include for ARRAY_SIZE() but can't you just use 
sizeof()?

> +	root = debugfs_create_dir(name, NULL);
> +
> +	debugfs_create_devm_seqfile(&wdev->dev, "system_description", root,
> +				    awcc_debugfs_system_description_read);
> +
> +	if (awcc->hwmon)
> +		debugfs_create_devm_seqfile(&wdev->dev, "hwmon_data", root,
> +					    awcc_debugfs_hwmon_data_read);
> +
> +	if (awcc->pprof)
> +		debugfs_create_devm_seqfile(&wdev->dev, "pprof_data", root,
> +					    awcc_debugfs_pprof_data_read);
> +
> +	devm_add_action_or_reset(&wdev->dev, awcc_debugfs_remove, root);
> +}
> +
>  static int alienware_awcc_setup(struct wmi_device *wdev)
>  {
>  	struct awcc_priv *priv;
> @@ -1290,6 +1378,8 @@ static int alienware_awcc_setup(struct wmi_device *wdev)
>  			return ret;
>  	}
>  
> +	awcc_debugfs_init(wdev);
> +
>  	return 0;
>  }
>  
> 
> 

-- 
 i.
Re: [PATCH v6 09/12] platform/x86: alienware-wmi-wmax: Add a DebugFS interface
Posted by Kurt Borja 8 months, 3 weeks ago
On Fri Mar 28, 2025 at 1:18 PM -03, Ilpo Järvinen wrote:
> On Thu, 13 Mar 2025, Kurt Borja wrote:
>
>> Add a debugfs interface which exposes thermal private data.
>> 
>> Reviewed-by: Armin Wolf <W_Armin@gmx.de>
>> Signed-off-by: Kurt Borja <kuurtb@gmail.com>
>> ---
>>  drivers/platform/x86/dell/alienware-wmi-wmax.c | 90 ++++++++++++++++++++++++++
>>  1 file changed, 90 insertions(+)
>> 
>> diff --git a/drivers/platform/x86/dell/alienware-wmi-wmax.c b/drivers/platform/x86/dell/alienware-wmi-wmax.c
>> index 823b579260555085ef6ac793b806738a756bb9da..472e6289fec5be0db0a5cb8e76718b750fa558b5 100644
>> --- a/drivers/platform/x86/dell/alienware-wmi-wmax.c
>> +++ b/drivers/platform/x86/dell/alienware-wmi-wmax.c
>> @@ -11,6 +11,7 @@
>>  #include <linux/bitfield.h>
>>  #include <linux/bitmap.h>
>>  #include <linux/bits.h>
>> +#include <linux/debugfs.h>
>>  #include <linux/dmi.h>
>>  #include <linux/hwmon.h>
>>  #include <linux/hwmon-sysfs.h>
>> @@ -19,6 +20,7 @@
>>  #include <linux/moduleparam.h>
>>  #include <linux/platform_profile.h>
>>  #include <linux/pm.h>
>> +#include <linux/seq_file.h>
>>  #include <linux/units.h>
>>  #include <linux/wmi.h>
>>  #include "alienware-wmi.h"
>> @@ -1252,6 +1254,92 @@ static int awcc_platform_profile_init(struct wmi_device *wdev)
>>  	return PTR_ERR_OR_ZERO(priv->ppdev);
>>  }
>>  
>> +/*
>> + * DebugFS
>> + */
>> +static int awcc_debugfs_system_description_read(struct seq_file *seq, void *data)
>> +{
>> +	struct device *dev = seq->private;
>> +	struct awcc_priv *priv = dev_get_drvdata(dev);
>> +
>> +	seq_printf(seq, "0x%08x\n", priv->system_description);
>> +
>> +	return 0;
>> +}
>> +
>> +static int awcc_debugfs_hwmon_data_read(struct seq_file *seq, void *data)
>> +{
>> +	struct device *dev = seq->private;
>> +	struct awcc_priv *priv = dev_get_drvdata(dev);
>> +	const struct awcc_fan_data *fan;
>> +	unsigned int bit;
>> +
>> +	seq_printf(seq, "Number of fans: %u\n", priv->fan_count);
>> +	seq_printf(seq, "Number of temperature sensors: %u\n\n", priv->temp_count);
>> +
>> +	for (u32 i = 0; i < priv->fan_count; i++) {
>> +		fan = priv->fan_data[i];
>> +
>> +		seq_printf(seq, "Fan %u:\n", i);
>> +		seq_printf(seq, "  ID: 0x%02x\n", fan->id);
>> +		seq_printf(seq, "  Related temperature sensors bitmap: %lu\n",
>> +			   fan->auto_channels_temp);
>> +	}
>> +
>> +	seq_puts(seq, "\nTemperature sensor IDs:\n");
>> +	for_each_set_bit(bit, priv->temp_sensors, AWCC_ID_BITMAP_SIZE)
>> +		seq_printf(seq, "  0x%02x\n", bit);
>> +
>> +	return 0;
>> +}
>> +
>> +static int awcc_debugfs_pprof_data_read(struct seq_file *seq, void *data)
>> +{
>> +	struct device *dev = seq->private;
>> +	struct awcc_priv *priv = dev_get_drvdata(dev);
>> +
>> +	seq_printf(seq, "Number of thermal profiles: %u\n\n", priv->profile_count);
>> +
>> +	for (u32 i = 0; i < PLATFORM_PROFILE_LAST; i++) {
>> +		if (!priv->supported_profiles[i])
>> +			continue;
>> +
>> +		seq_printf(seq, "Platform profile %u:\n", i);
>> +		seq_printf(seq, "  ID: 0x%02x\n", priv->supported_profiles[i]);
>> +	}
>> +
>> +	return 0;
>> +}
>> +
>> +static void awcc_debugfs_remove(void *data)
>> +{
>> +	struct dentry *root = data;
>> +
>> +	debugfs_remove(root);
>> +}
>> +
>> +static void awcc_debugfs_init(struct wmi_device *wdev)
>> +{
>> +	struct dentry *root;
>> +	char name[64];
>> +
>> +	scnprintf(name, ARRAY_SIZE(name), "%s-%s", "alienware-wmi", dev_name(&wdev->dev));
>
> You'd need to add include for ARRAY_SIZE() but can't you just use 
> sizeof()?

Sure, it's 1 byte anyway. Though I think I use ARRAY_SIZE somewhere
else so I'll add the include too.

Thank you so much for your feedback! I'll send v7 this weekend.

-- 
 ~ Kurt

>
>> +	root = debugfs_create_dir(name, NULL);
>> +
>> +	debugfs_create_devm_seqfile(&wdev->dev, "system_description", root,
>> +				    awcc_debugfs_system_description_read);
>> +
>> +	if (awcc->hwmon)
>> +		debugfs_create_devm_seqfile(&wdev->dev, "hwmon_data", root,
>> +					    awcc_debugfs_hwmon_data_read);
>> +
>> +	if (awcc->pprof)
>> +		debugfs_create_devm_seqfile(&wdev->dev, "pprof_data", root,
>> +					    awcc_debugfs_pprof_data_read);
>> +
>> +	devm_add_action_or_reset(&wdev->dev, awcc_debugfs_remove, root);
>> +}
>> +
>>  static int alienware_awcc_setup(struct wmi_device *wdev)
>>  {
>>  	struct awcc_priv *priv;
>> @@ -1290,6 +1378,8 @@ static int alienware_awcc_setup(struct wmi_device *wdev)
>>  			return ret;
>>  	}
>>  
>> +	awcc_debugfs_init(wdev);
>> +
>>  	return 0;
>>  }
>>  
>> 
>>