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

[Armin Wolf <W_Armin@gmx.de>]

Am 21.12.24 um 06:59 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.
>
> 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 | 128 +++++++++++++---------
>   1 file changed, 76 insertions(+), 52 deletions(-)
>
> diff --git a/drivers/platform/x86/dell/alienware-wmi.c b/drivers/platform/x86/dell/alienware-wmi.c
> index 67cf376df0f5..4b68d64bd742 100644
> --- a/drivers/platform/x86/dell/alienware-wmi.c
> +++ b/drivers/platform/x86/dell/alienware-wmi.c
> @@ -404,14 +404,19 @@ struct wmax_u32_args {
>   	u8 arg3;
>   };
>
> +struct alienfx_priv {
> +	struct platform_device *pdev;
> +	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 +448,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 +458,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 +491,32 @@ static int alienware_update_led(u8 location)
>   static ssize_t zone_show(struct device *dev, struct device_attribute *attr,
>   			 char *buf, u8 location)
>   {
> +	struct color_platform *colors;
> +	struct alienfx_priv *priv;
> +
> +	priv = dev_get_drvdata(dev);

Please use "struct color_platform *colors = dev_get_drvdata(dev);" in such cases.

> +	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 color_platform *colors;
> +	struct alienfx_priv *priv;
>   	int ret;
>
> -	ret = parse_rgb(buf, &colors[location]);
> +	priv = dev_get_drvdata(dev);

Same as above.

> +	colors = &priv->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;
>   }
> @@ -539,9 +554,13 @@ 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;
> +
> +	priv = dev_get_drvdata(dev);

Same as above.

> +
> +	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");
> @@ -551,8 +570,11 @@ static ssize_t lighting_control_state_store(struct device *dev,
>   					    struct device_attribute *attr,
>   					    const char *buf, size_t count)
>   {
> +	struct alienfx_priv *priv;
>   	u8 val;
>
> +	priv = dev_get_drvdata(dev);

Same as above.

> +
>   	if (strcmp(buf, "booting\n") == 0)
>   		val = LEGACY_BOOTING;
>   	else if (strcmp(buf, "suspend\n") == 0)
> @@ -562,9 +584,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;
>   }
> @@ -621,43 +643,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;
>   	int ret;
> -	global_brightness = brightness;
> +
> +	priv = container_of(led_cdev, struct alienfx_priv, global_led);

Same as above, but with container_of().

> +	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",
> -};
> -
> -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;
> +	struct alienfx_priv *priv;
>
> -	return led_classdev_register(&dev->dev, &global_led);
> -}
> +	priv = container_of(led_cdev, struct alienfx_priv, global_led);

Same as above.

>
> -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,
> @@ -1106,6 +1111,32 @@ static void remove_thermal_profile(void)
>   /*
>    * Platform Driver
>    */
> +static int alienfx_probe(struct platform_device *pdev)
> +{
> +	struct alienfx_priv *priv;
> +	struct led_classdev *leds;
> +
> +	priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL);

Missing error handling.

> +	platform_set_drvdata(pdev, priv);
> +
> +	priv->pdev = pdev;
> +
> +	if (interface == WMAX)
> +		priv->lighting_control_state = WMAX_RUNNING;
> +	else if (interface == LEGACY)
> +		priv->lighting_control_state = LEGACY_RUNNING;
> +
> +	leds = &priv->global_led;

I do not think that "leds" has any real benefit here, please use "priv->global_led" directly.

Thanks,
Armin Wolf

> +	leds->name = "alienware::global_brightness";
> +	leds->brightness_set = global_led_set;
> +	leds->brightness_get = global_led_get;
> +	leds->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,
> @@ -1119,6 +1150,7 @@ static struct platform_driver platform_driver = {
>   		.name = "alienware-wmi",
>   		.dev_groups = alienfx_groups,
>   	},
> +	.probe = alienfx_probe,
>   };
>
>   static int __init alienware_wmi_init(void)
> @@ -1166,15 +1198,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:
> @@ -1189,7 +1214,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);