[PATCH v2 07/20] alienware-wmi: Add a state container for LED control feature

Kurt Borja posted 20 patches 11 months, 3 weeks ago
[PATCH v2 07/20] alienware-wmi: Add a state container for LED control feature
Posted by Kurt Borja 11 months, 3 weeks ago
Add a state container for the "alienware-wmi" platform device and
initialize it on the new alienfx_probe(). Migrate all LED control functions
to use this state container, as well as hdmi, amplifier, deepslp group
visibility methods, to support upcoming file split.

Additionally move the led_classdev registration to the platform driver
probe and make it device managed.

Drop alienware_zone_init() and alienware_zone_exit() because they are no
longer needed.

Signed-off-by: Kurt Borja <kuurtb@gmail.com>
---
 drivers/platform/x86/dell/alienware-wmi.c | 135 +++++++++++++---------
 1 file changed, 79 insertions(+), 56 deletions(-)

diff --git a/drivers/platform/x86/dell/alienware-wmi.c b/drivers/platform/x86/dell/alienware-wmi.c
index 2c17160473a6..88d4046ed45f 100644
--- a/drivers/platform/x86/dell/alienware-wmi.c
+++ b/drivers/platform/x86/dell/alienware-wmi.c
@@ -404,14 +404,20 @@ struct wmax_u32_args {
 	u8 arg3;
 };
 
+struct alienfx_priv {
+	struct platform_device *pdev;
+	struct quirk_entry *quirks;
+	struct led_classdev global_led;
+	struct color_platform colors[4];
+	u8 global_brightness;
+	u8 lighting_control_state;
+};
+
 static struct platform_device *platform_device;
-static struct color_platform colors[4];
 static struct platform_profile_handler pp_handler;
 static enum wmax_thermal_mode supported_thermal_profiles[PLATFORM_PROFILE_LAST];
 
 static u8 interface;
-static u8 lighting_control_state;
-static u8 global_brightness;
 
 /*
  * Helpers used for zone control
@@ -443,7 +449,7 @@ static int parse_rgb(const char *buf, struct color_platform *colors)
 /*
  * Individual RGB zone control
  */
-static int alienware_update_led(u8 location)
+static int alienware_update_led(struct alienfx_priv *priv, u8 location)
 {
 	int method_id;
 	acpi_status status;
@@ -453,21 +459,21 @@ static int alienware_update_led(u8 location)
 	struct wmax_led_args wmax_basic_args;
 	if (interface == WMAX) {
 		wmax_basic_args.led_mask = 1 << location;
-		wmax_basic_args.colors = colors[location];
-		wmax_basic_args.state = lighting_control_state;
+		wmax_basic_args.colors = priv->colors[location];
+		wmax_basic_args.state = priv->lighting_control_state;
 		guid = WMAX_CONTROL_GUID;
 		method_id = WMAX_METHOD_ZONE_CONTROL;
 
 		input.length = sizeof(wmax_basic_args);
 		input.pointer = &wmax_basic_args;
 	} else {
-		legacy_args.colors = colors[location];
-		legacy_args.brightness = global_brightness;
+		legacy_args.colors = priv->colors[location];
+		legacy_args.brightness = priv->global_brightness;
 		legacy_args.state = 0;
-		if (lighting_control_state == LEGACY_BOOTING ||
-		    lighting_control_state == LEGACY_SUSPEND) {
+		if (priv->lighting_control_state == LEGACY_BOOTING ||
+		    priv->lighting_control_state == LEGACY_SUSPEND) {
 			guid = LEGACY_POWER_CONTROL_GUID;
-			legacy_args.state = lighting_control_state;
+			legacy_args.state = priv->lighting_control_state;
 		} else
 			guid = LEGACY_CONTROL_GUID;
 		method_id = location + 1;
@@ -486,22 +492,26 @@ static int alienware_update_led(u8 location)
 static ssize_t zone_show(struct device *dev, struct device_attribute *attr,
 			 char *buf, u8 location)
 {
+	struct alienfx_priv *priv = dev_get_drvdata(dev);
+	struct color_platform *colors = &priv->colors[location];
+
 	return sprintf(buf, "red: %d, green: %d, blue: %d\n",
-		       colors[location].red, colors[location].green,
-		       colors[location].blue);
+		       colors->red, colors->green, colors->blue);
 
 }
 
 static ssize_t zone_store(struct device *dev, struct device_attribute *attr,
 			  const char *buf, size_t count, u8 location)
 {
+	struct alienfx_priv *priv = dev_get_drvdata(dev);
+	struct color_platform *colors = &priv->colors[location];
 	int ret;
 
-	ret = parse_rgb(buf, &colors[location]);
+	ret = parse_rgb(buf, colors);
 	if (ret)
 		return ret;
 
-	ret = alienware_update_led(location);
+	ret = alienware_update_led(priv, location);
 
 	return ret ? ret : count;
 }
@@ -569,9 +579,11 @@ static ssize_t lighting_control_state_show(struct device *dev,
 					   struct device_attribute *attr,
 					   char *buf)
 {
-	if (lighting_control_state == LEGACY_BOOTING)
+	struct alienfx_priv *priv = dev_get_drvdata(dev);
+
+	if (priv->lighting_control_state == LEGACY_BOOTING)
 		return sysfs_emit(buf, "[booting] running suspend\n");
-	else if (lighting_control_state == LEGACY_SUSPEND)
+	else if (priv->lighting_control_state == LEGACY_SUSPEND)
 		return sysfs_emit(buf, "booting running [suspend]\n");
 
 	return sysfs_emit(buf, "booting [running] suspend\n");
@@ -581,6 +593,7 @@ static ssize_t lighting_control_state_store(struct device *dev,
 					    struct device_attribute *attr,
 					    const char *buf, size_t count)
 {
+	struct alienfx_priv *priv = dev_get_drvdata(dev);
 	u8 val;
 
 	if (strcmp(buf, "booting\n") == 0)
@@ -592,9 +605,9 @@ static ssize_t lighting_control_state_store(struct device *dev,
 	else
 		val = WMAX_RUNNING;
 
-	lighting_control_state = val;
+	priv->lighting_control_state = val;
 	pr_debug("alienware-wmi: updated control state to %d\n",
-		 lighting_control_state);
+		 priv->lighting_control_state);
 
 	return count;
 }
@@ -651,43 +664,26 @@ static int wmax_brightness(int brightness)
 static void global_led_set(struct led_classdev *led_cdev,
 			   enum led_brightness brightness)
 {
+	struct alienfx_priv *priv = container_of(led_cdev, struct alienfx_priv,
+						 global_led);
 	int ret;
-	global_brightness = brightness;
+
+	priv->global_brightness = brightness;
+
 	if (interface == WMAX)
 		ret = wmax_brightness(brightness);
 	else
-		ret = alienware_update_led(0);
+		ret = alienware_update_led(priv, 0);
 	if (ret)
 		pr_err("LED brightness update failed\n");
 }
 
 static enum led_brightness global_led_get(struct led_classdev *led_cdev)
 {
-	return global_brightness;
-}
-
-static struct led_classdev global_led = {
-	.brightness_set = global_led_set,
-	.brightness_get = global_led_get,
-	.name = "alienware::global_brightness",
-};
+	struct alienfx_priv *priv = container_of(led_cdev, struct alienfx_priv,
+						 global_led);
 
-static int alienware_zone_init(struct platform_device *dev)
-{
-	if (interface == WMAX) {
-		lighting_control_state = WMAX_RUNNING;
-	} else if (interface == LEGACY) {
-		lighting_control_state = LEGACY_RUNNING;
-	}
-	global_led.max_brightness = 0x0F;
-	global_brightness = global_led.max_brightness;
-
-	return led_classdev_register(&dev->dev, &global_led);
-}
-
-static void alienware_zone_exit(struct platform_device *dev)
-{
-	led_classdev_unregister(&global_led);
+	return priv->global_brightness;
 }
 
 static acpi_status alienware_wmax_command(void *in_args, size_t in_size,
@@ -792,7 +788,9 @@ static DEVICE_ATTR_RW(source);
 
 static bool hdmi_group_visible(struct kobject *kobj)
 {
-	return quirks->hdmi_mux;
+	struct alienfx_priv *priv = dev_get_drvdata(kobj_to_dev(kobj));
+
+	return priv->quirks->hdmi_mux;
 }
 DEFINE_SIMPLE_SYSFS_GROUP_VISIBLE(hdmi);
 
@@ -838,7 +836,9 @@ static DEVICE_ATTR_RO(status);
 
 static bool amplifier_group_visible(struct kobject *kobj)
 {
-	return quirks->amplifier;
+	struct alienfx_priv *priv = dev_get_drvdata(kobj_to_dev(kobj));
+
+	return priv->quirks->amplifier;
 }
 DEFINE_SIMPLE_SYSFS_GROUP_VISIBLE(amplifier);
 
@@ -906,7 +906,9 @@ static DEVICE_ATTR_RW(deepsleep);
 
 static bool deepsleep_group_visible(struct kobject *kobj)
 {
-	return quirks->deepslp;
+	struct alienfx_priv *priv = dev_get_drvdata(kobj_to_dev(kobj));
+
+	return priv->quirks->deepslp;
 }
 DEFINE_SIMPLE_SYSFS_GROUP_VISIBLE(deepsleep);
 
@@ -1133,6 +1135,33 @@ static void remove_thermal_profile(void)
 /*
  * Platform Driver
  */
+static int alienfx_probe(struct platform_device *pdev)
+{
+	struct alienfx_priv *priv;
+
+	priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL);
+	if (!priv)
+		return -ENOMEM;
+
+	platform_set_drvdata(pdev, priv);
+	priv->pdev = pdev;
+	priv->quirks = quirks;
+
+	if (interface == WMAX)
+		priv->lighting_control_state = WMAX_RUNNING;
+	else if (interface == LEGACY)
+		priv->lighting_control_state = LEGACY_RUNNING;
+
+	priv->global_led.name = "alienware::global_brightness";
+	priv->global_led.brightness_set = global_led_set;
+	priv->global_led.brightness_get = global_led_get;
+	priv->global_led.max_brightness = 0x0F;
+
+	priv->global_brightness = priv->global_led.max_brightness;
+
+	return devm_led_classdev_register(&pdev->dev, &priv->global_led);
+}
+
 static const struct attribute_group *alienfx_groups[] = {
 	&zone_attribute_group,
 	&hdmi_attribute_group,
@@ -1145,7 +1174,9 @@ static struct platform_driver platform_driver = {
 	.driver = {
 		.name = "alienware-wmi",
 		.dev_groups = alienfx_groups,
+		.probe_type = PROBE_FORCE_SYNCHRONOUS,
 	},
+	.probe = alienfx_probe,
 };
 
 static int __init alienware_wmi_init(void)
@@ -1193,15 +1224,8 @@ static int __init alienware_wmi_init(void)
 			goto fail_prep_thermal_profile;
 	}
 
-	ret = alienware_zone_init(platform_device);
-	if (ret)
-		goto fail_prep_zones;
-
 	return 0;
 
-fail_prep_zones:
-	alienware_zone_exit(platform_device);
-	remove_thermal_profile();
 fail_prep_thermal_profile:
 	platform_device_del(platform_device);
 fail_platform_device2:
@@ -1216,7 +1240,6 @@ module_init(alienware_wmi_init);
 
 static void __exit alienware_wmi_exit(void)
 {
-	alienware_zone_exit(platform_device);
 	remove_thermal_profile();
 	platform_device_unregister(platform_device);
 	platform_driver_unregister(&platform_driver);
-- 
2.47.1
Re: [PATCH v2 07/20] alienware-wmi: Add a state container for LED control feature
Posted by Armin Wolf 11 months, 2 weeks ago
Am 29.12.24 um 20:44 schrieb Kurt Borja:

> Add a state container for the "alienware-wmi" platform device and
> initialize it on the new alienfx_probe(). Migrate all LED control functions
> to use this state container, as well as hdmi, amplifier, deepslp group
> visibility methods, to support upcoming file split.
>
> Additionally move the led_classdev registration to the platform driver
> probe and make it device managed.
>
> Drop alienware_zone_init() and alienware_zone_exit() because they are no
> longer needed.
>
> Signed-off-by: Kurt Borja <kuurtb@gmail.com>
> ---
>   drivers/platform/x86/dell/alienware-wmi.c | 135 +++++++++++++---------
>   1 file changed, 79 insertions(+), 56 deletions(-)
>
> diff --git a/drivers/platform/x86/dell/alienware-wmi.c b/drivers/platform/x86/dell/alienware-wmi.c
> index 2c17160473a6..88d4046ed45f 100644
> --- a/drivers/platform/x86/dell/alienware-wmi.c
> +++ b/drivers/platform/x86/dell/alienware-wmi.c
> @@ -404,14 +404,20 @@ struct wmax_u32_args {
>   	u8 arg3;
>   };
>
> +struct alienfx_priv {
> +	struct platform_device *pdev;
> +	struct quirk_entry *quirks;
> +	struct led_classdev global_led;
> +	struct color_platform colors[4];
> +	u8 global_brightness;
> +	u8 lighting_control_state;
> +};
> +
>   static struct platform_device *platform_device;
> -static struct color_platform colors[4];
>   static struct platform_profile_handler pp_handler;
>   static enum wmax_thermal_mode supported_thermal_profiles[PLATFORM_PROFILE_LAST];
>
>   static u8 interface;
> -static u8 lighting_control_state;
> -static u8 global_brightness;
>
>   /*
>    * Helpers used for zone control
> @@ -443,7 +449,7 @@ static int parse_rgb(const char *buf, struct color_platform *colors)
>   /*
>    * Individual RGB zone control
>    */
> -static int alienware_update_led(u8 location)
> +static int alienware_update_led(struct alienfx_priv *priv, u8 location)
>   {
>   	int method_id;
>   	acpi_status status;
> @@ -453,21 +459,21 @@ static int alienware_update_led(u8 location)
>   	struct wmax_led_args wmax_basic_args;
>   	if (interface == WMAX) {
>   		wmax_basic_args.led_mask = 1 << location;
> -		wmax_basic_args.colors = colors[location];
> -		wmax_basic_args.state = lighting_control_state;
> +		wmax_basic_args.colors = priv->colors[location];
> +		wmax_basic_args.state = priv->lighting_control_state;
>   		guid = WMAX_CONTROL_GUID;
>   		method_id = WMAX_METHOD_ZONE_CONTROL;
>
>   		input.length = sizeof(wmax_basic_args);
>   		input.pointer = &wmax_basic_args;
>   	} else {
> -		legacy_args.colors = colors[location];
> -		legacy_args.brightness = global_brightness;
> +		legacy_args.colors = priv->colors[location];
> +		legacy_args.brightness = priv->global_brightness;
>   		legacy_args.state = 0;
> -		if (lighting_control_state == LEGACY_BOOTING ||
> -		    lighting_control_state == LEGACY_SUSPEND) {
> +		if (priv->lighting_control_state == LEGACY_BOOTING ||
> +		    priv->lighting_control_state == LEGACY_SUSPEND) {
>   			guid = LEGACY_POWER_CONTROL_GUID;
> -			legacy_args.state = lighting_control_state;
> +			legacy_args.state = priv->lighting_control_state;
>   		} else
>   			guid = LEGACY_CONTROL_GUID;
>   		method_id = location + 1;
> @@ -486,22 +492,26 @@ static int alienware_update_led(u8 location)
>   static ssize_t zone_show(struct device *dev, struct device_attribute *attr,
>   			 char *buf, u8 location)
>   {
> +	struct alienfx_priv *priv = dev_get_drvdata(dev);
> +	struct color_platform *colors = &priv->colors[location];
> +
>   	return sprintf(buf, "red: %d, green: %d, blue: %d\n",
> -		       colors[location].red, colors[location].green,
> -		       colors[location].blue);
> +		       colors->red, colors->green, colors->blue);
>
>   }
>
>   static ssize_t zone_store(struct device *dev, struct device_attribute *attr,
>   			  const char *buf, size_t count, u8 location)
>   {
> +	struct alienfx_priv *priv = dev_get_drvdata(dev);
> +	struct color_platform *colors = &priv->colors[location];
>   	int ret;
>
> -	ret = parse_rgb(buf, &colors[location]);
> +	ret = parse_rgb(buf, colors);
>   	if (ret)
>   		return ret;
>
> -	ret = alienware_update_led(location);
> +	ret = alienware_update_led(priv, location);
>
>   	return ret ? ret : count;
>   }
> @@ -569,9 +579,11 @@ static ssize_t lighting_control_state_show(struct device *dev,
>   					   struct device_attribute *attr,
>   					   char *buf)
>   {
> -	if (lighting_control_state == LEGACY_BOOTING)
> +	struct alienfx_priv *priv = dev_get_drvdata(dev);
> +
> +	if (priv->lighting_control_state == LEGACY_BOOTING)
>   		return sysfs_emit(buf, "[booting] running suspend\n");
> -	else if (lighting_control_state == LEGACY_SUSPEND)
> +	else if (priv->lighting_control_state == LEGACY_SUSPEND)
>   		return sysfs_emit(buf, "booting running [suspend]\n");
>
>   	return sysfs_emit(buf, "booting [running] suspend\n");
> @@ -581,6 +593,7 @@ static ssize_t lighting_control_state_store(struct device *dev,
>   					    struct device_attribute *attr,
>   					    const char *buf, size_t count)
>   {
> +	struct alienfx_priv *priv = dev_get_drvdata(dev);
>   	u8 val;
>
>   	if (strcmp(buf, "booting\n") == 0)
> @@ -592,9 +605,9 @@ static ssize_t lighting_control_state_store(struct device *dev,
>   	else
>   		val = WMAX_RUNNING;
>
> -	lighting_control_state = val;
> +	priv->lighting_control_state = val;
>   	pr_debug("alienware-wmi: updated control state to %d\n",
> -		 lighting_control_state);
> +		 priv->lighting_control_state);
>
>   	return count;
>   }
> @@ -651,43 +664,26 @@ static int wmax_brightness(int brightness)
>   static void global_led_set(struct led_classdev *led_cdev,
>   			   enum led_brightness brightness)
>   {
> +	struct alienfx_priv *priv = container_of(led_cdev, struct alienfx_priv,
> +						 global_led);
>   	int ret;
> -	global_brightness = brightness;
> +
> +	priv->global_brightness = brightness;
> +
>   	if (interface == WMAX)
>   		ret = wmax_brightness(brightness);
>   	else
> -		ret = alienware_update_led(0);
> +		ret = alienware_update_led(priv, 0);
>   	if (ret)
>   		pr_err("LED brightness update failed\n");
>   }
>
>   static enum led_brightness global_led_get(struct led_classdev *led_cdev)
>   {
> -	return global_brightness;
> -}
> -
> -static struct led_classdev global_led = {
> -	.brightness_set = global_led_set,
> -	.brightness_get = global_led_get,
> -	.name = "alienware::global_brightness",
> -};
> +	struct alienfx_priv *priv = container_of(led_cdev, struct alienfx_priv,
> +						 global_led);
>
> -static int alienware_zone_init(struct platform_device *dev)
> -{
> -	if (interface == WMAX) {
> -		lighting_control_state = WMAX_RUNNING;
> -	} else if (interface == LEGACY) {
> -		lighting_control_state = LEGACY_RUNNING;
> -	}
> -	global_led.max_brightness = 0x0F;
> -	global_brightness = global_led.max_brightness;
> -
> -	return led_classdev_register(&dev->dev, &global_led);
> -}
> -
> -static void alienware_zone_exit(struct platform_device *dev)
> -{
> -	led_classdev_unregister(&global_led);
> +	return priv->global_brightness;
>   }
>
>   static acpi_status alienware_wmax_command(void *in_args, size_t in_size,
> @@ -792,7 +788,9 @@ static DEVICE_ATTR_RW(source);
>
>   static bool hdmi_group_visible(struct kobject *kobj)
>   {
> -	return quirks->hdmi_mux;
> +	struct alienfx_priv *priv = dev_get_drvdata(kobj_to_dev(kobj));
> +
> +	return priv->quirks->hdmi_mux;
>   }
>   DEFINE_SIMPLE_SYSFS_GROUP_VISIBLE(hdmi);
>
> @@ -838,7 +836,9 @@ static DEVICE_ATTR_RO(status);
>
>   static bool amplifier_group_visible(struct kobject *kobj)
>   {
> -	return quirks->amplifier;
> +	struct alienfx_priv *priv = dev_get_drvdata(kobj_to_dev(kobj));
> +
> +	return priv->quirks->amplifier;
>   }
>   DEFINE_SIMPLE_SYSFS_GROUP_VISIBLE(amplifier);
>
> @@ -906,7 +906,9 @@ static DEVICE_ATTR_RW(deepsleep);
>
>   static bool deepsleep_group_visible(struct kobject *kobj)
>   {
> -	return quirks->deepslp;
> +	struct alienfx_priv *priv = dev_get_drvdata(kobj_to_dev(kobj));
> +
> +	return priv->quirks->deepslp;
>   }
>   DEFINE_SIMPLE_SYSFS_GROUP_VISIBLE(deepsleep);
>
> @@ -1133,6 +1135,33 @@ static void remove_thermal_profile(void)
>   /*
>    * Platform Driver
>    */
> +static int alienfx_probe(struct platform_device *pdev)
> +{
> +	struct alienfx_priv *priv;
> +
> +	priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL);
> +	if (!priv)
> +		return -ENOMEM;
> +
> +	platform_set_drvdata(pdev, priv);
> +	priv->pdev = pdev;
> +	priv->quirks = quirks;
> +
> +	if (interface == WMAX)
> +		priv->lighting_control_state = WMAX_RUNNING;
> +	else if (interface == LEGACY)
> +		priv->lighting_control_state = LEGACY_RUNNING;
> +
> +	priv->global_led.name = "alienware::global_brightness";
> +	priv->global_led.brightness_set = global_led_set;
> +	priv->global_led.brightness_get = global_led_get;
> +	priv->global_led.max_brightness = 0x0F;
> +
> +	priv->global_brightness = priv->global_led.max_brightness;
> +
> +	return devm_led_classdev_register(&pdev->dev, &priv->global_led);
> +}
> +
>   static const struct attribute_group *alienfx_groups[] = {
>   	&zone_attribute_group,
>   	&hdmi_attribute_group,
> @@ -1145,7 +1174,9 @@ static struct platform_driver platform_driver = {
>   	.driver = {
>   		.name = "alienware-wmi",
>   		.dev_groups = alienfx_groups,
> +		.probe_type = PROBE_FORCE_SYNCHRONOUS,

Can you please explain to me why this is exactly necessary?

Thanks,
Armin Wolf

>   	},
> +	.probe = alienfx_probe,
>   };
>
>   static int __init alienware_wmi_init(void)
> @@ -1193,15 +1224,8 @@ static int __init alienware_wmi_init(void)
>   			goto fail_prep_thermal_profile;
>   	}
>
> -	ret = alienware_zone_init(platform_device);
> -	if (ret)
> -		goto fail_prep_zones;
> -
>   	return 0;
>
> -fail_prep_zones:
> -	alienware_zone_exit(platform_device);
> -	remove_thermal_profile();
>   fail_prep_thermal_profile:
>   	platform_device_del(platform_device);
>   fail_platform_device2:
> @@ -1216,7 +1240,6 @@ module_init(alienware_wmi_init);
>
>   static void __exit alienware_wmi_exit(void)
>   {
> -	alienware_zone_exit(platform_device);
>   	remove_thermal_profile();
>   	platform_device_unregister(platform_device);
>   	platform_driver_unregister(&platform_driver);
Re: [PATCH v2 07/20] alienware-wmi: Add a state container for LED control feature
Posted by Kurt Borja 11 months, 2 weeks ago
On Thu, Jan 02, 2025 at 05:07:16PM +0100, Armin Wolf wrote:
> Am 29.12.24 um 20:44 schrieb Kurt Borja:
> 
> > Add a state container for the "alienware-wmi" platform device and
> > initialize it on the new alienfx_probe(). Migrate all LED control functions
> > to use this state container, as well as hdmi, amplifier, deepslp group
> > visibility methods, to support upcoming file split.
> > 
> > Additionally move the led_classdev registration to the platform driver
> > probe and make it device managed.
> > 
> > Drop alienware_zone_init() and alienware_zone_exit() because they are no
> > longer needed.
> > 
> > Signed-off-by: Kurt Borja <kuurtb@gmail.com>
> > ---
> >   drivers/platform/x86/dell/alienware-wmi.c | 135 +++++++++++++---------
> >   1 file changed, 79 insertions(+), 56 deletions(-)
> > 
> > diff --git a/drivers/platform/x86/dell/alienware-wmi.c b/drivers/platform/x86/dell/alienware-wmi.c
> > index 2c17160473a6..88d4046ed45f 100644
> > --- a/drivers/platform/x86/dell/alienware-wmi.c
> > +++ b/drivers/platform/x86/dell/alienware-wmi.c
> > @@ -404,14 +404,20 @@ struct wmax_u32_args {
> >   	u8 arg3;
> >   };
> > 
> > +struct alienfx_priv {
> > +	struct platform_device *pdev;
> > +	struct quirk_entry *quirks;
> > +	struct led_classdev global_led;
> > +	struct color_platform colors[4];
> > +	u8 global_brightness;
> > +	u8 lighting_control_state;
> > +};
> > +
> >   static struct platform_device *platform_device;
> > -static struct color_platform colors[4];
> >   static struct platform_profile_handler pp_handler;
> >   static enum wmax_thermal_mode supported_thermal_profiles[PLATFORM_PROFILE_LAST];
> > 
> >   static u8 interface;
> > -static u8 lighting_control_state;
> > -static u8 global_brightness;
> > 
> >   /*
> >    * Helpers used for zone control
> > @@ -443,7 +449,7 @@ static int parse_rgb(const char *buf, struct color_platform *colors)
> >   /*
> >    * Individual RGB zone control
> >    */
> > -static int alienware_update_led(u8 location)
> > +static int alienware_update_led(struct alienfx_priv *priv, u8 location)
> >   {
> >   	int method_id;
> >   	acpi_status status;
> > @@ -453,21 +459,21 @@ static int alienware_update_led(u8 location)
> >   	struct wmax_led_args wmax_basic_args;
> >   	if (interface == WMAX) {
> >   		wmax_basic_args.led_mask = 1 << location;
> > -		wmax_basic_args.colors = colors[location];
> > -		wmax_basic_args.state = lighting_control_state;
> > +		wmax_basic_args.colors = priv->colors[location];
> > +		wmax_basic_args.state = priv->lighting_control_state;
> >   		guid = WMAX_CONTROL_GUID;
> >   		method_id = WMAX_METHOD_ZONE_CONTROL;
> > 
> >   		input.length = sizeof(wmax_basic_args);
> >   		input.pointer = &wmax_basic_args;
> >   	} else {
> > -		legacy_args.colors = colors[location];
> > -		legacy_args.brightness = global_brightness;
> > +		legacy_args.colors = priv->colors[location];
> > +		legacy_args.brightness = priv->global_brightness;
> >   		legacy_args.state = 0;
> > -		if (lighting_control_state == LEGACY_BOOTING ||
> > -		    lighting_control_state == LEGACY_SUSPEND) {
> > +		if (priv->lighting_control_state == LEGACY_BOOTING ||
> > +		    priv->lighting_control_state == LEGACY_SUSPEND) {
> >   			guid = LEGACY_POWER_CONTROL_GUID;
> > -			legacy_args.state = lighting_control_state;
> > +			legacy_args.state = priv->lighting_control_state;
> >   		} else
> >   			guid = LEGACY_CONTROL_GUID;
> >   		method_id = location + 1;
> > @@ -486,22 +492,26 @@ static int alienware_update_led(u8 location)
> >   static ssize_t zone_show(struct device *dev, struct device_attribute *attr,
> >   			 char *buf, u8 location)
> >   {
> > +	struct alienfx_priv *priv = dev_get_drvdata(dev);
> > +	struct color_platform *colors = &priv->colors[location];
> > +
> >   	return sprintf(buf, "red: %d, green: %d, blue: %d\n",
> > -		       colors[location].red, colors[location].green,
> > -		       colors[location].blue);
> > +		       colors->red, colors->green, colors->blue);
> > 
> >   }
> > 
> >   static ssize_t zone_store(struct device *dev, struct device_attribute *attr,
> >   			  const char *buf, size_t count, u8 location)
> >   {
> > +	struct alienfx_priv *priv = dev_get_drvdata(dev);
> > +	struct color_platform *colors = &priv->colors[location];
> >   	int ret;
> > 
> > -	ret = parse_rgb(buf, &colors[location]);
> > +	ret = parse_rgb(buf, colors);
> >   	if (ret)
> >   		return ret;
> > 
> > -	ret = alienware_update_led(location);
> > +	ret = alienware_update_led(priv, location);
> > 
> >   	return ret ? ret : count;
> >   }
> > @@ -569,9 +579,11 @@ static ssize_t lighting_control_state_show(struct device *dev,
> >   					   struct device_attribute *attr,
> >   					   char *buf)
> >   {
> > -	if (lighting_control_state == LEGACY_BOOTING)
> > +	struct alienfx_priv *priv = dev_get_drvdata(dev);
> > +
> > +	if (priv->lighting_control_state == LEGACY_BOOTING)
> >   		return sysfs_emit(buf, "[booting] running suspend\n");
> > -	else if (lighting_control_state == LEGACY_SUSPEND)
> > +	else if (priv->lighting_control_state == LEGACY_SUSPEND)
> >   		return sysfs_emit(buf, "booting running [suspend]\n");
> > 
> >   	return sysfs_emit(buf, "booting [running] suspend\n");
> > @@ -581,6 +593,7 @@ static ssize_t lighting_control_state_store(struct device *dev,
> >   					    struct device_attribute *attr,
> >   					    const char *buf, size_t count)
> >   {
> > +	struct alienfx_priv *priv = dev_get_drvdata(dev);
> >   	u8 val;
> > 
> >   	if (strcmp(buf, "booting\n") == 0)
> > @@ -592,9 +605,9 @@ static ssize_t lighting_control_state_store(struct device *dev,
> >   	else
> >   		val = WMAX_RUNNING;
> > 
> > -	lighting_control_state = val;
> > +	priv->lighting_control_state = val;
> >   	pr_debug("alienware-wmi: updated control state to %d\n",
> > -		 lighting_control_state);
> > +		 priv->lighting_control_state);
> > 
> >   	return count;
> >   }
> > @@ -651,43 +664,26 @@ static int wmax_brightness(int brightness)
> >   static void global_led_set(struct led_classdev *led_cdev,
> >   			   enum led_brightness brightness)
> >   {
> > +	struct alienfx_priv *priv = container_of(led_cdev, struct alienfx_priv,
> > +						 global_led);
> >   	int ret;
> > -	global_brightness = brightness;
> > +
> > +	priv->global_brightness = brightness;
> > +
> >   	if (interface == WMAX)
> >   		ret = wmax_brightness(brightness);
> >   	else
> > -		ret = alienware_update_led(0);
> > +		ret = alienware_update_led(priv, 0);
> >   	if (ret)
> >   		pr_err("LED brightness update failed\n");
> >   }
> > 
> >   static enum led_brightness global_led_get(struct led_classdev *led_cdev)
> >   {
> > -	return global_brightness;
> > -}
> > -
> > -static struct led_classdev global_led = {
> > -	.brightness_set = global_led_set,
> > -	.brightness_get = global_led_get,
> > -	.name = "alienware::global_brightness",
> > -};
> > +	struct alienfx_priv *priv = container_of(led_cdev, struct alienfx_priv,
> > +						 global_led);
> > 
> > -static int alienware_zone_init(struct platform_device *dev)
> > -{
> > -	if (interface == WMAX) {
> > -		lighting_control_state = WMAX_RUNNING;
> > -	} else if (interface == LEGACY) {
> > -		lighting_control_state = LEGACY_RUNNING;
> > -	}
> > -	global_led.max_brightness = 0x0F;
> > -	global_brightness = global_led.max_brightness;
> > -
> > -	return led_classdev_register(&dev->dev, &global_led);
> > -}
> > -
> > -static void alienware_zone_exit(struct platform_device *dev)
> > -{
> > -	led_classdev_unregister(&global_led);
> > +	return priv->global_brightness;
> >   }
> > 
> >   static acpi_status alienware_wmax_command(void *in_args, size_t in_size,
> > @@ -792,7 +788,9 @@ static DEVICE_ATTR_RW(source);
> > 
> >   static bool hdmi_group_visible(struct kobject *kobj)
> >   {
> > -	return quirks->hdmi_mux;
> > +	struct alienfx_priv *priv = dev_get_drvdata(kobj_to_dev(kobj));
> > +
> > +	return priv->quirks->hdmi_mux;
> >   }
> >   DEFINE_SIMPLE_SYSFS_GROUP_VISIBLE(hdmi);
> > 
> > @@ -838,7 +836,9 @@ static DEVICE_ATTR_RO(status);
> > 
> >   static bool amplifier_group_visible(struct kobject *kobj)
> >   {
> > -	return quirks->amplifier;
> > +	struct alienfx_priv *priv = dev_get_drvdata(kobj_to_dev(kobj));
> > +
> > +	return priv->quirks->amplifier;
> >   }
> >   DEFINE_SIMPLE_SYSFS_GROUP_VISIBLE(amplifier);
> > 
> > @@ -906,7 +906,9 @@ static DEVICE_ATTR_RW(deepsleep);
> > 
> >   static bool deepsleep_group_visible(struct kobject *kobj)
> >   {
> > -	return quirks->deepslp;
> > +	struct alienfx_priv *priv = dev_get_drvdata(kobj_to_dev(kobj));
> > +
> > +	return priv->quirks->deepslp;
> >   }
> >   DEFINE_SIMPLE_SYSFS_GROUP_VISIBLE(deepsleep);
> > 
> > @@ -1133,6 +1135,33 @@ static void remove_thermal_profile(void)
> >   /*
> >    * Platform Driver
> >    */
> > +static int alienfx_probe(struct platform_device *pdev)
> > +{
> > +	struct alienfx_priv *priv;
> > +
> > +	priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL);
> > +	if (!priv)
> > +		return -ENOMEM;
> > +
> > +	platform_set_drvdata(pdev, priv);
> > +	priv->pdev = pdev;
> > +	priv->quirks = quirks;
> > +
> > +	if (interface == WMAX)
> > +		priv->lighting_control_state = WMAX_RUNNING;
> > +	else if (interface == LEGACY)
> > +		priv->lighting_control_state = LEGACY_RUNNING;
> > +
> > +	priv->global_led.name = "alienware::global_brightness";
> > +	priv->global_led.brightness_set = global_led_set;
> > +	priv->global_led.brightness_get = global_led_get;
> > +	priv->global_led.max_brightness = 0x0F;
> > +
> > +	priv->global_brightness = priv->global_led.max_brightness;
> > +
> > +	return devm_led_classdev_register(&pdev->dev, &priv->global_led);
> > +}
> > +
> >   static const struct attribute_group *alienfx_groups[] = {
> >   	&zone_attribute_group,
> >   	&hdmi_attribute_group,
> > @@ -1145,7 +1174,9 @@ static struct platform_driver platform_driver = {
> >   	.driver = {
> >   		.name = "alienware-wmi",
> >   		.dev_groups = alienfx_groups,
> > +		.probe_type = PROBE_FORCE_SYNCHRONOUS,
> 
> Can you please explain to me why this is exactly necessary?

Because I want to add wmax_alienfx_groups after the platform_device has
finished probing. I think it's not exactly "necessary" because those
methods only access `platdata` which is set before probing, but to me it
doesn't feel right to race with alienfx_probe().

I wanted to somehow mimic platform_create_bundle(), which I can't use
because that function needs to be called from an __init section.

If this is unnecessary I will drop it, otherwise I think it makes more
sense to move this to [8/20].

> 
> Thanks,
> Armin Wolf
> 
> >   	},
> > +	.probe = alienfx_probe,
> >   };
> > 
> >   static int __init alienware_wmi_init(void)
> > @@ -1193,15 +1224,8 @@ static int __init alienware_wmi_init(void)
> >   			goto fail_prep_thermal_profile;
> >   	}
> > 
> > -	ret = alienware_zone_init(platform_device);
> > -	if (ret)
> > -		goto fail_prep_zones;
> > -
> >   	return 0;
> > 
> > -fail_prep_zones:
> > -	alienware_zone_exit(platform_device);
> > -	remove_thermal_profile();
> >   fail_prep_thermal_profile:
> >   	platform_device_del(platform_device);
> >   fail_platform_device2:
> > @@ -1216,7 +1240,6 @@ module_init(alienware_wmi_init);
> > 
> >   static void __exit alienware_wmi_exit(void)
> >   {
> > -	alienware_zone_exit(platform_device);
> >   	remove_thermal_profile();
> >   	platform_device_unregister(platform_device);
> >   	platform_driver_unregister(&platform_driver);
Re: [PATCH v2 07/20] alienware-wmi: Add a state container for LED control feature
Posted by Armin Wolf 11 months, 2 weeks ago
Am 02.01.25 um 19:45 schrieb Kurt Borja:

> On Thu, Jan 02, 2025 at 05:07:16PM +0100, Armin Wolf wrote:
>> Am 29.12.24 um 20:44 schrieb Kurt Borja:
>>
>>> Add a state container for the "alienware-wmi" platform device and
>>> initialize it on the new alienfx_probe(). Migrate all LED control functions
>>> to use this state container, as well as hdmi, amplifier, deepslp group
>>> visibility methods, to support upcoming file split.
>>>
>>> Additionally move the led_classdev registration to the platform driver
>>> probe and make it device managed.
>>>
>>> Drop alienware_zone_init() and alienware_zone_exit() because they are no
>>> longer needed.
>>>
>>> Signed-off-by: Kurt Borja <kuurtb@gmail.com>
>>> ---
>>>    drivers/platform/x86/dell/alienware-wmi.c | 135 +++++++++++++---------
>>>    1 file changed, 79 insertions(+), 56 deletions(-)
>>>
>>> diff --git a/drivers/platform/x86/dell/alienware-wmi.c b/drivers/platform/x86/dell/alienware-wmi.c
>>> index 2c17160473a6..88d4046ed45f 100644
>>> --- a/drivers/platform/x86/dell/alienware-wmi.c
>>> +++ b/drivers/platform/x86/dell/alienware-wmi.c
>>> @@ -404,14 +404,20 @@ struct wmax_u32_args {
>>>    	u8 arg3;
>>>    };
>>>
>>> +struct alienfx_priv {
>>> +	struct platform_device *pdev;
>>> +	struct quirk_entry *quirks;
>>> +	struct led_classdev global_led;
>>> +	struct color_platform colors[4];
>>> +	u8 global_brightness;
>>> +	u8 lighting_control_state;
>>> +};
>>> +
>>>    static struct platform_device *platform_device;
>>> -static struct color_platform colors[4];
>>>    static struct platform_profile_handler pp_handler;
>>>    static enum wmax_thermal_mode supported_thermal_profiles[PLATFORM_PROFILE_LAST];
>>>
>>>    static u8 interface;
>>> -static u8 lighting_control_state;
>>> -static u8 global_brightness;
>>>
>>>    /*
>>>     * Helpers used for zone control
>>> @@ -443,7 +449,7 @@ static int parse_rgb(const char *buf, struct color_platform *colors)
>>>    /*
>>>     * Individual RGB zone control
>>>     */
>>> -static int alienware_update_led(u8 location)
>>> +static int alienware_update_led(struct alienfx_priv *priv, u8 location)
>>>    {
>>>    	int method_id;
>>>    	acpi_status status;
>>> @@ -453,21 +459,21 @@ static int alienware_update_led(u8 location)
>>>    	struct wmax_led_args wmax_basic_args;
>>>    	if (interface == WMAX) {
>>>    		wmax_basic_args.led_mask = 1 << location;
>>> -		wmax_basic_args.colors = colors[location];
>>> -		wmax_basic_args.state = lighting_control_state;
>>> +		wmax_basic_args.colors = priv->colors[location];
>>> +		wmax_basic_args.state = priv->lighting_control_state;
>>>    		guid = WMAX_CONTROL_GUID;
>>>    		method_id = WMAX_METHOD_ZONE_CONTROL;
>>>
>>>    		input.length = sizeof(wmax_basic_args);
>>>    		input.pointer = &wmax_basic_args;
>>>    	} else {
>>> -		legacy_args.colors = colors[location];
>>> -		legacy_args.brightness = global_brightness;
>>> +		legacy_args.colors = priv->colors[location];
>>> +		legacy_args.brightness = priv->global_brightness;
>>>    		legacy_args.state = 0;
>>> -		if (lighting_control_state == LEGACY_BOOTING ||
>>> -		    lighting_control_state == LEGACY_SUSPEND) {
>>> +		if (priv->lighting_control_state == LEGACY_BOOTING ||
>>> +		    priv->lighting_control_state == LEGACY_SUSPEND) {
>>>    			guid = LEGACY_POWER_CONTROL_GUID;
>>> -			legacy_args.state = lighting_control_state;
>>> +			legacy_args.state = priv->lighting_control_state;
>>>    		} else
>>>    			guid = LEGACY_CONTROL_GUID;
>>>    		method_id = location + 1;
>>> @@ -486,22 +492,26 @@ static int alienware_update_led(u8 location)
>>>    static ssize_t zone_show(struct device *dev, struct device_attribute *attr,
>>>    			 char *buf, u8 location)
>>>    {
>>> +	struct alienfx_priv *priv = dev_get_drvdata(dev);
>>> +	struct color_platform *colors = &priv->colors[location];
>>> +
>>>    	return sprintf(buf, "red: %d, green: %d, blue: %d\n",
>>> -		       colors[location].red, colors[location].green,
>>> -		       colors[location].blue);
>>> +		       colors->red, colors->green, colors->blue);
>>>
>>>    }
>>>
>>>    static ssize_t zone_store(struct device *dev, struct device_attribute *attr,
>>>    			  const char *buf, size_t count, u8 location)
>>>    {
>>> +	struct alienfx_priv *priv = dev_get_drvdata(dev);
>>> +	struct color_platform *colors = &priv->colors[location];
>>>    	int ret;
>>>
>>> -	ret = parse_rgb(buf, &colors[location]);
>>> +	ret = parse_rgb(buf, colors);
>>>    	if (ret)
>>>    		return ret;
>>>
>>> -	ret = alienware_update_led(location);
>>> +	ret = alienware_update_led(priv, location);
>>>
>>>    	return ret ? ret : count;
>>>    }
>>> @@ -569,9 +579,11 @@ static ssize_t lighting_control_state_show(struct device *dev,
>>>    					   struct device_attribute *attr,
>>>    					   char *buf)
>>>    {
>>> -	if (lighting_control_state == LEGACY_BOOTING)
>>> +	struct alienfx_priv *priv = dev_get_drvdata(dev);
>>> +
>>> +	if (priv->lighting_control_state == LEGACY_BOOTING)
>>>    		return sysfs_emit(buf, "[booting] running suspend\n");
>>> -	else if (lighting_control_state == LEGACY_SUSPEND)
>>> +	else if (priv->lighting_control_state == LEGACY_SUSPEND)
>>>    		return sysfs_emit(buf, "booting running [suspend]\n");
>>>
>>>    	return sysfs_emit(buf, "booting [running] suspend\n");
>>> @@ -581,6 +593,7 @@ static ssize_t lighting_control_state_store(struct device *dev,
>>>    					    struct device_attribute *attr,
>>>    					    const char *buf, size_t count)
>>>    {
>>> +	struct alienfx_priv *priv = dev_get_drvdata(dev);
>>>    	u8 val;
>>>
>>>    	if (strcmp(buf, "booting\n") == 0)
>>> @@ -592,9 +605,9 @@ static ssize_t lighting_control_state_store(struct device *dev,
>>>    	else
>>>    		val = WMAX_RUNNING;
>>>
>>> -	lighting_control_state = val;
>>> +	priv->lighting_control_state = val;
>>>    	pr_debug("alienware-wmi: updated control state to %d\n",
>>> -		 lighting_control_state);
>>> +		 priv->lighting_control_state);
>>>
>>>    	return count;
>>>    }
>>> @@ -651,43 +664,26 @@ static int wmax_brightness(int brightness)
>>>    static void global_led_set(struct led_classdev *led_cdev,
>>>    			   enum led_brightness brightness)
>>>    {
>>> +	struct alienfx_priv *priv = container_of(led_cdev, struct alienfx_priv,
>>> +						 global_led);
>>>    	int ret;
>>> -	global_brightness = brightness;
>>> +
>>> +	priv->global_brightness = brightness;
>>> +
>>>    	if (interface == WMAX)
>>>    		ret = wmax_brightness(brightness);
>>>    	else
>>> -		ret = alienware_update_led(0);
>>> +		ret = alienware_update_led(priv, 0);
>>>    	if (ret)
>>>    		pr_err("LED brightness update failed\n");
>>>    }
>>>
>>>    static enum led_brightness global_led_get(struct led_classdev *led_cdev)
>>>    {
>>> -	return global_brightness;
>>> -}
>>> -
>>> -static struct led_classdev global_led = {
>>> -	.brightness_set = global_led_set,
>>> -	.brightness_get = global_led_get,
>>> -	.name = "alienware::global_brightness",
>>> -};
>>> +	struct alienfx_priv *priv = container_of(led_cdev, struct alienfx_priv,
>>> +						 global_led);
>>>
>>> -static int alienware_zone_init(struct platform_device *dev)
>>> -{
>>> -	if (interface == WMAX) {
>>> -		lighting_control_state = WMAX_RUNNING;
>>> -	} else if (interface == LEGACY) {
>>> -		lighting_control_state = LEGACY_RUNNING;
>>> -	}
>>> -	global_led.max_brightness = 0x0F;
>>> -	global_brightness = global_led.max_brightness;
>>> -
>>> -	return led_classdev_register(&dev->dev, &global_led);
>>> -}
>>> -
>>> -static void alienware_zone_exit(struct platform_device *dev)
>>> -{
>>> -	led_classdev_unregister(&global_led);
>>> +	return priv->global_brightness;
>>>    }
>>>
>>>    static acpi_status alienware_wmax_command(void *in_args, size_t in_size,
>>> @@ -792,7 +788,9 @@ static DEVICE_ATTR_RW(source);
>>>
>>>    static bool hdmi_group_visible(struct kobject *kobj)
>>>    {
>>> -	return quirks->hdmi_mux;
>>> +	struct alienfx_priv *priv = dev_get_drvdata(kobj_to_dev(kobj));
>>> +
>>> +	return priv->quirks->hdmi_mux;
>>>    }
>>>    DEFINE_SIMPLE_SYSFS_GROUP_VISIBLE(hdmi);
>>>
>>> @@ -838,7 +836,9 @@ static DEVICE_ATTR_RO(status);
>>>
>>>    static bool amplifier_group_visible(struct kobject *kobj)
>>>    {
>>> -	return quirks->amplifier;
>>> +	struct alienfx_priv *priv = dev_get_drvdata(kobj_to_dev(kobj));
>>> +
>>> +	return priv->quirks->amplifier;
>>>    }
>>>    DEFINE_SIMPLE_SYSFS_GROUP_VISIBLE(amplifier);
>>>
>>> @@ -906,7 +906,9 @@ static DEVICE_ATTR_RW(deepsleep);
>>>
>>>    static bool deepsleep_group_visible(struct kobject *kobj)
>>>    {
>>> -	return quirks->deepslp;
>>> +	struct alienfx_priv *priv = dev_get_drvdata(kobj_to_dev(kobj));
>>> +
>>> +	return priv->quirks->deepslp;
>>>    }
>>>    DEFINE_SIMPLE_SYSFS_GROUP_VISIBLE(deepsleep);
>>>
>>> @@ -1133,6 +1135,33 @@ static void remove_thermal_profile(void)
>>>    /*
>>>     * Platform Driver
>>>     */
>>> +static int alienfx_probe(struct platform_device *pdev)
>>> +{
>>> +	struct alienfx_priv *priv;
>>> +
>>> +	priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL);
>>> +	if (!priv)
>>> +		return -ENOMEM;
>>> +
>>> +	platform_set_drvdata(pdev, priv);
>>> +	priv->pdev = pdev;
>>> +	priv->quirks = quirks;
>>> +
>>> +	if (interface == WMAX)
>>> +		priv->lighting_control_state = WMAX_RUNNING;
>>> +	else if (interface == LEGACY)
>>> +		priv->lighting_control_state = LEGACY_RUNNING;
>>> +
>>> +	priv->global_led.name = "alienware::global_brightness";
>>> +	priv->global_led.brightness_set = global_led_set;
>>> +	priv->global_led.brightness_get = global_led_get;
>>> +	priv->global_led.max_brightness = 0x0F;
>>> +
>>> +	priv->global_brightness = priv->global_led.max_brightness;
>>> +
>>> +	return devm_led_classdev_register(&pdev->dev, &priv->global_led);
>>> +}
>>> +
>>>    static const struct attribute_group *alienfx_groups[] = {
>>>    	&zone_attribute_group,
>>>    	&hdmi_attribute_group,
>>> @@ -1145,7 +1174,9 @@ static struct platform_driver platform_driver = {
>>>    	.driver = {
>>>    		.name = "alienware-wmi",
>>>    		.dev_groups = alienfx_groups,
>>> +		.probe_type = PROBE_FORCE_SYNCHRONOUS,
>> Can you please explain to me why this is exactly necessary?
> Because I want to add wmax_alienfx_groups after the platform_device has
> finished probing. I think it's not exactly "necessary" because those
> methods only access `platdata` which is set before probing, but to me it
> doesn't feel right to race with alienfx_probe().
>
> I wanted to somehow mimic platform_create_bundle(), which I can't use
> because that function needs to be called from an __init section.
>
> If this is unnecessary I will drop it, otherwise I think it makes more
> sense to move this to [8/20].
>
I just saw that the *_is_visible() callbacks use alienfx_priv which is only available
after the driver has finished probing.

I would prefer if you make the quirk values available outside of alienware-wmi-base so
that those callbacks can access them without having to use alienfx_priv. This would allow
us to omit PROBE_FORCE_SYNCHRONOUS.

Thanks,
Armin Wolf

>> Thanks,
>> Armin Wolf
>>
>>>    	},
>>> +	.probe = alienfx_probe,
>>>    };
>>>
>>>    static int __init alienware_wmi_init(void)
>>> @@ -1193,15 +1224,8 @@ static int __init alienware_wmi_init(void)
>>>    			goto fail_prep_thermal_profile;
>>>    	}
>>>
>>> -	ret = alienware_zone_init(platform_device);
>>> -	if (ret)
>>> -		goto fail_prep_zones;
>>> -
>>>    	return 0;
>>>
>>> -fail_prep_zones:
>>> -	alienware_zone_exit(platform_device);
>>> -	remove_thermal_profile();
>>>    fail_prep_thermal_profile:
>>>    	platform_device_del(platform_device);
>>>    fail_platform_device2:
>>> @@ -1216,7 +1240,6 @@ module_init(alienware_wmi_init);
>>>
>>>    static void __exit alienware_wmi_exit(void)
>>>    {
>>> -	alienware_zone_exit(platform_device);
>>>    	remove_thermal_profile();
>>>    	platform_device_unregister(platform_device);
>>>    	platform_driver_unregister(&platform_driver);
Re: [PATCH v2 07/20] alienware-wmi: Add a state container for LED control feature
Posted by Kurt Borja 11 months, 2 weeks ago
On Thu, Jan 02, 2025 at 08:20:48PM +0100, Armin Wolf wrote:
> Am 02.01.25 um 19:45 schrieb Kurt Borja:
> 
> > On Thu, Jan 02, 2025 at 05:07:16PM +0100, Armin Wolf wrote:
> > > Am 29.12.24 um 20:44 schrieb Kurt Borja:
> > > 
> > > > Add a state container for the "alienware-wmi" platform device and
> > > > initialize it on the new alienfx_probe(). Migrate all LED control functions
> > > > to use this state container, as well as hdmi, amplifier, deepslp group
> > > > visibility methods, to support upcoming file split.
> > > > 
> > > > Additionally move the led_classdev registration to the platform driver
> > > > probe and make it device managed.
> > > > 
> > > > Drop alienware_zone_init() and alienware_zone_exit() because they are no
> > > > longer needed.
> > > > 
> > > > Signed-off-by: Kurt Borja <kuurtb@gmail.com>
> > > > ---
> > > >    drivers/platform/x86/dell/alienware-wmi.c | 135 +++++++++++++---------
> > > >    1 file changed, 79 insertions(+), 56 deletions(-)
> > > > 
> > > > diff --git a/drivers/platform/x86/dell/alienware-wmi.c b/drivers/platform/x86/dell/alienware-wmi.c
> > > > index 2c17160473a6..88d4046ed45f 100644
> > > > --- a/drivers/platform/x86/dell/alienware-wmi.c
> > > > +++ b/drivers/platform/x86/dell/alienware-wmi.c
> > > > @@ -404,14 +404,20 @@ struct wmax_u32_args {
> > > >    	u8 arg3;
> > > >    };
> > > > 
> > > > +struct alienfx_priv {
> > > > +	struct platform_device *pdev;
> > > > +	struct quirk_entry *quirks;
> > > > +	struct led_classdev global_led;
> > > > +	struct color_platform colors[4];
> > > > +	u8 global_brightness;
> > > > +	u8 lighting_control_state;
> > > > +};
> > > > +
> > > >    static struct platform_device *platform_device;
> > > > -static struct color_platform colors[4];
> > > >    static struct platform_profile_handler pp_handler;
> > > >    static enum wmax_thermal_mode supported_thermal_profiles[PLATFORM_PROFILE_LAST];
> > > > 
> > > >    static u8 interface;
> > > > -static u8 lighting_control_state;
> > > > -static u8 global_brightness;
> > > > 
> > > >    /*
> > > >     * Helpers used for zone control
> > > > @@ -443,7 +449,7 @@ static int parse_rgb(const char *buf, struct color_platform *colors)
> > > >    /*
> > > >     * Individual RGB zone control
> > > >     */
> > > > -static int alienware_update_led(u8 location)
> > > > +static int alienware_update_led(struct alienfx_priv *priv, u8 location)
> > > >    {
> > > >    	int method_id;
> > > >    	acpi_status status;
> > > > @@ -453,21 +459,21 @@ static int alienware_update_led(u8 location)
> > > >    	struct wmax_led_args wmax_basic_args;
> > > >    	if (interface == WMAX) {
> > > >    		wmax_basic_args.led_mask = 1 << location;
> > > > -		wmax_basic_args.colors = colors[location];
> > > > -		wmax_basic_args.state = lighting_control_state;
> > > > +		wmax_basic_args.colors = priv->colors[location];
> > > > +		wmax_basic_args.state = priv->lighting_control_state;
> > > >    		guid = WMAX_CONTROL_GUID;
> > > >    		method_id = WMAX_METHOD_ZONE_CONTROL;
> > > > 
> > > >    		input.length = sizeof(wmax_basic_args);
> > > >    		input.pointer = &wmax_basic_args;
> > > >    	} else {
> > > > -		legacy_args.colors = colors[location];
> > > > -		legacy_args.brightness = global_brightness;
> > > > +		legacy_args.colors = priv->colors[location];
> > > > +		legacy_args.brightness = priv->global_brightness;
> > > >    		legacy_args.state = 0;
> > > > -		if (lighting_control_state == LEGACY_BOOTING ||
> > > > -		    lighting_control_state == LEGACY_SUSPEND) {
> > > > +		if (priv->lighting_control_state == LEGACY_BOOTING ||
> > > > +		    priv->lighting_control_state == LEGACY_SUSPEND) {
> > > >    			guid = LEGACY_POWER_CONTROL_GUID;
> > > > -			legacy_args.state = lighting_control_state;
> > > > +			legacy_args.state = priv->lighting_control_state;
> > > >    		} else
> > > >    			guid = LEGACY_CONTROL_GUID;
> > > >    		method_id = location + 1;
> > > > @@ -486,22 +492,26 @@ static int alienware_update_led(u8 location)
> > > >    static ssize_t zone_show(struct device *dev, struct device_attribute *attr,
> > > >    			 char *buf, u8 location)
> > > >    {
> > > > +	struct alienfx_priv *priv = dev_get_drvdata(dev);
> > > > +	struct color_platform *colors = &priv->colors[location];
> > > > +
> > > >    	return sprintf(buf, "red: %d, green: %d, blue: %d\n",
> > > > -		       colors[location].red, colors[location].green,
> > > > -		       colors[location].blue);
> > > > +		       colors->red, colors->green, colors->blue);
> > > > 
> > > >    }
> > > > 
> > > >    static ssize_t zone_store(struct device *dev, struct device_attribute *attr,
> > > >    			  const char *buf, size_t count, u8 location)
> > > >    {
> > > > +	struct alienfx_priv *priv = dev_get_drvdata(dev);
> > > > +	struct color_platform *colors = &priv->colors[location];
> > > >    	int ret;
> > > > 
> > > > -	ret = parse_rgb(buf, &colors[location]);
> > > > +	ret = parse_rgb(buf, colors);
> > > >    	if (ret)
> > > >    		return ret;
> > > > 
> > > > -	ret = alienware_update_led(location);
> > > > +	ret = alienware_update_led(priv, location);
> > > > 
> > > >    	return ret ? ret : count;
> > > >    }
> > > > @@ -569,9 +579,11 @@ static ssize_t lighting_control_state_show(struct device *dev,
> > > >    					   struct device_attribute *attr,
> > > >    					   char *buf)
> > > >    {
> > > > -	if (lighting_control_state == LEGACY_BOOTING)
> > > > +	struct alienfx_priv *priv = dev_get_drvdata(dev);
> > > > +
> > > > +	if (priv->lighting_control_state == LEGACY_BOOTING)
> > > >    		return sysfs_emit(buf, "[booting] running suspend\n");
> > > > -	else if (lighting_control_state == LEGACY_SUSPEND)
> > > > +	else if (priv->lighting_control_state == LEGACY_SUSPEND)
> > > >    		return sysfs_emit(buf, "booting running [suspend]\n");
> > > > 
> > > >    	return sysfs_emit(buf, "booting [running] suspend\n");
> > > > @@ -581,6 +593,7 @@ static ssize_t lighting_control_state_store(struct device *dev,
> > > >    					    struct device_attribute *attr,
> > > >    					    const char *buf, size_t count)
> > > >    {
> > > > +	struct alienfx_priv *priv = dev_get_drvdata(dev);
> > > >    	u8 val;
> > > > 
> > > >    	if (strcmp(buf, "booting\n") == 0)
> > > > @@ -592,9 +605,9 @@ static ssize_t lighting_control_state_store(struct device *dev,
> > > >    	else
> > > >    		val = WMAX_RUNNING;
> > > > 
> > > > -	lighting_control_state = val;
> > > > +	priv->lighting_control_state = val;
> > > >    	pr_debug("alienware-wmi: updated control state to %d\n",
> > > > -		 lighting_control_state);
> > > > +		 priv->lighting_control_state);
> > > > 
> > > >    	return count;
> > > >    }
> > > > @@ -651,43 +664,26 @@ static int wmax_brightness(int brightness)
> > > >    static void global_led_set(struct led_classdev *led_cdev,
> > > >    			   enum led_brightness brightness)
> > > >    {
> > > > +	struct alienfx_priv *priv = container_of(led_cdev, struct alienfx_priv,
> > > > +						 global_led);
> > > >    	int ret;
> > > > -	global_brightness = brightness;
> > > > +
> > > > +	priv->global_brightness = brightness;
> > > > +
> > > >    	if (interface == WMAX)
> > > >    		ret = wmax_brightness(brightness);
> > > >    	else
> > > > -		ret = alienware_update_led(0);
> > > > +		ret = alienware_update_led(priv, 0);
> > > >    	if (ret)
> > > >    		pr_err("LED brightness update failed\n");
> > > >    }
> > > > 
> > > >    static enum led_brightness global_led_get(struct led_classdev *led_cdev)
> > > >    {
> > > > -	return global_brightness;
> > > > -}
> > > > -
> > > > -static struct led_classdev global_led = {
> > > > -	.brightness_set = global_led_set,
> > > > -	.brightness_get = global_led_get,
> > > > -	.name = "alienware::global_brightness",
> > > > -};
> > > > +	struct alienfx_priv *priv = container_of(led_cdev, struct alienfx_priv,
> > > > +						 global_led);
> > > > 
> > > > -static int alienware_zone_init(struct platform_device *dev)
> > > > -{
> > > > -	if (interface == WMAX) {
> > > > -		lighting_control_state = WMAX_RUNNING;
> > > > -	} else if (interface == LEGACY) {
> > > > -		lighting_control_state = LEGACY_RUNNING;
> > > > -	}
> > > > -	global_led.max_brightness = 0x0F;
> > > > -	global_brightness = global_led.max_brightness;
> > > > -
> > > > -	return led_classdev_register(&dev->dev, &global_led);
> > > > -}
> > > > -
> > > > -static void alienware_zone_exit(struct platform_device *dev)
> > > > -{
> > > > -	led_classdev_unregister(&global_led);
> > > > +	return priv->global_brightness;
> > > >    }
> > > > 
> > > >    static acpi_status alienware_wmax_command(void *in_args, size_t in_size,
> > > > @@ -792,7 +788,9 @@ static DEVICE_ATTR_RW(source);
> > > > 
> > > >    static bool hdmi_group_visible(struct kobject *kobj)
> > > >    {
> > > > -	return quirks->hdmi_mux;
> > > > +	struct alienfx_priv *priv = dev_get_drvdata(kobj_to_dev(kobj));
> > > > +
> > > > +	return priv->quirks->hdmi_mux;
> > > >    }
> > > >    DEFINE_SIMPLE_SYSFS_GROUP_VISIBLE(hdmi);
> > > > 
> > > > @@ -838,7 +836,9 @@ static DEVICE_ATTR_RO(status);
> > > > 
> > > >    static bool amplifier_group_visible(struct kobject *kobj)
> > > >    {
> > > > -	return quirks->amplifier;
> > > > +	struct alienfx_priv *priv = dev_get_drvdata(kobj_to_dev(kobj));
> > > > +
> > > > +	return priv->quirks->amplifier;
> > > >    }
> > > >    DEFINE_SIMPLE_SYSFS_GROUP_VISIBLE(amplifier);
> > > > 
> > > > @@ -906,7 +906,9 @@ static DEVICE_ATTR_RW(deepsleep);
> > > > 
> > > >    static bool deepsleep_group_visible(struct kobject *kobj)
> > > >    {
> > > > -	return quirks->deepslp;
> > > > +	struct alienfx_priv *priv = dev_get_drvdata(kobj_to_dev(kobj));
> > > > +
> > > > +	return priv->quirks->deepslp;
> > > >    }
> > > >    DEFINE_SIMPLE_SYSFS_GROUP_VISIBLE(deepsleep);
> > > > 
> > > > @@ -1133,6 +1135,33 @@ static void remove_thermal_profile(void)
> > > >    /*
> > > >     * Platform Driver
> > > >     */
> > > > +static int alienfx_probe(struct platform_device *pdev)
> > > > +{
> > > > +	struct alienfx_priv *priv;
> > > > +
> > > > +	priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL);
> > > > +	if (!priv)
> > > > +		return -ENOMEM;
> > > > +
> > > > +	platform_set_drvdata(pdev, priv);
> > > > +	priv->pdev = pdev;
> > > > +	priv->quirks = quirks;
> > > > +
> > > > +	if (interface == WMAX)
> > > > +		priv->lighting_control_state = WMAX_RUNNING;
> > > > +	else if (interface == LEGACY)
> > > > +		priv->lighting_control_state = LEGACY_RUNNING;
> > > > +
> > > > +	priv->global_led.name = "alienware::global_brightness";
> > > > +	priv->global_led.brightness_set = global_led_set;
> > > > +	priv->global_led.brightness_get = global_led_get;
> > > > +	priv->global_led.max_brightness = 0x0F;
> > > > +
> > > > +	priv->global_brightness = priv->global_led.max_brightness;
> > > > +
> > > > +	return devm_led_classdev_register(&pdev->dev, &priv->global_led);
> > > > +}
> > > > +
> > > >    static const struct attribute_group *alienfx_groups[] = {
> > > >    	&zone_attribute_group,
> > > >    	&hdmi_attribute_group,
> > > > @@ -1145,7 +1174,9 @@ static struct platform_driver platform_driver = {
> > > >    	.driver = {
> > > >    		.name = "alienware-wmi",
> > > >    		.dev_groups = alienfx_groups,
> > > > +		.probe_type = PROBE_FORCE_SYNCHRONOUS,
> > > Can you please explain to me why this is exactly necessary?
> > Because I want to add wmax_alienfx_groups after the platform_device has
> > finished probing. I think it's not exactly "necessary" because those
> > methods only access `platdata` which is set before probing, but to me it
> > doesn't feel right to race with alienfx_probe().
> > 
> > I wanted to somehow mimic platform_create_bundle(), which I can't use
> > because that function needs to be called from an __init section.
> > 
> > If this is unnecessary I will drop it, otherwise I think it makes more
> > sense to move this to [8/20].
> > 
> I just saw that the *_is_visible() callbacks use alienfx_priv which is only available
> after the driver has finished probing.
> 
> I would prefer if you make the quirk values available outside of alienware-wmi-base so
> that those callbacks can access them without having to use alienfx_priv. This would allow
> us to omit PROBE_FORCE_SYNCHRONOUS.

Right! I forgot about that. Then I will make it available in alienware-wmi.h and drop
PROBE_FORCE_SYNCHRONOUS.

> 
> Thanks,
> Armin Wolf
> 
> > > Thanks,
> > > Armin Wolf
> > > 
> > > >    	},
> > > > +	.probe = alienfx_probe,
> > > >    };
> > > > 
> > > >    static int __init alienware_wmi_init(void)
> > > > @@ -1193,15 +1224,8 @@ static int __init alienware_wmi_init(void)
> > > >    			goto fail_prep_thermal_profile;
> > > >    	}
> > > > 
> > > > -	ret = alienware_zone_init(platform_device);
> > > > -	if (ret)
> > > > -		goto fail_prep_zones;
> > > > -
> > > >    	return 0;
> > > > 
> > > > -fail_prep_zones:
> > > > -	alienware_zone_exit(platform_device);
> > > > -	remove_thermal_profile();
> > > >    fail_prep_thermal_profile:
> > > >    	platform_device_del(platform_device);
> > > >    fail_platform_device2:
> > > > @@ -1216,7 +1240,6 @@ module_init(alienware_wmi_init);
> > > > 
> > > >    static void __exit alienware_wmi_exit(void)
> > > >    {
> > > > -	alienware_zone_exit(platform_device);
> > > >    	remove_thermal_profile();
> > > >    	platform_device_unregister(platform_device);
> > > >    	platform_driver_unregister(&platform_driver);