[1/2] backlight: pwm_bl: Move the checks for initial power state to a separate function

Submitted by Péter Ujfalusi on Sept. 30, 2016, 7:02 a.m.

Details

Message ID 20160930070259.5710-2-peter.ujfalusi@ti.com
State New
Headers show

Commit Message

Péter Ujfalusi Sept. 30, 2016, 7:02 a.m.
Move the check for gpio and regulator initial state to a new function and
document better what we are checking and why.

It is going to be easier to fix or improve the initial power state
configuration later and it is easier to read the code.

Signed-off-by: Peter Ujfalusi <peter.ujfalusi@ti.com>
---
 drivers/video/backlight/pwm_bl.c | 55 +++++++++++++++++++++++++---------------
 1 file changed, 35 insertions(+), 20 deletions(-)

Comments

Lee Jones Oct. 26, 2016, 12:12 p.m.
On Fri, 30 Sep 2016, Peter Ujfalusi wrote:

> Move the check for gpio and regulator initial state to a new function and
> document better what we are checking and why.
> 
> It is going to be easier to fix or improve the initial power state
> configuration later and it is easier to read the code.
> 
> Signed-off-by: Peter Ujfalusi <peter.ujfalusi@ti.com>
> ---
>  drivers/video/backlight/pwm_bl.c | 55 +++++++++++++++++++++++++---------------
>  1 file changed, 35 insertions(+), 20 deletions(-)
> 
> diff --git a/drivers/video/backlight/pwm_bl.c b/drivers/video/backlight/pwm_bl.c
> index b2b366bb0f97..9bc4715bf116 100644
> --- a/drivers/video/backlight/pwm_bl.c
> +++ b/drivers/video/backlight/pwm_bl.c
> @@ -192,6 +192,40 @@ static int pwm_backlight_parse_dt(struct device *dev,
>  }
>  #endif
>  
> +static int pwm_backlight_initial_power_state(const struct pwm_bl_data *pb)
> +{
> +	struct device_node *node = pb->dev->of_node;
> +
> +	/* Not booted with device tree or no phandle link to the node */
> +	if (!node || !node->phandle)
> +		return FB_BLANK_UNBLANK;

This changes the semantics of the current implementation.

In the code you're removing, if the enable_gpio is present and no DT
is found, we set the GPIO direction to output.  In your implementation,
if no DT is found you don't do anything regardless.

Is that intentional?

> +	/*
> +	 * If the driver is probed from the device tree and there is a
> +	 * phandle link pointing to the backlight node, it is safe to
> +	 * assume that another driver will enable the backlight at the
> +	 * appropriate time. Therefore, if it is disabled, keep it so.
> +	 */
> +
> +	/*
> +	 * if the enable GPIO is set as output and it is disabled, do not enable
> +	 * the backlight
> +	 */
> +	if (pb->enable_gpio) {
> +		if (gpiod_get_direction(pb->enable_gpio) == GPIOF_DIR_OUT &&
> +		    gpiod_get_value(pb->enable_gpio) == 0)
> +			return FB_BLANK_POWERDOWN;
> +
> +		gpiod_direction_output(pb->enable_gpio, 1);
> +	}
> +
> +	/* The regulator is disabled, do not enable the backlight */
> +	if (!regulator_is_enabled(pb->power_supply))
> +		return FB_BLANK_POWERDOWN;
> +
> +	return FB_BLANK_UNBLANK;
> +}
> +
>  static int pwm_backlight_probe(struct platform_device *pdev)
>  {
>  	struct platform_pwm_backlight_data *data = dev_get_platdata(&pdev->dev);
> @@ -200,7 +234,6 @@ static int pwm_backlight_probe(struct platform_device *pdev)
>  	struct backlight_device *bl;
>  	struct device_node *node = pdev->dev.of_node;
>  	struct pwm_bl_data *pb;
> -	int initial_blank = FB_BLANK_UNBLANK;
>  	struct pwm_args pargs;
>  	int ret;
>  
> @@ -267,30 +300,12 @@ static int pwm_backlight_probe(struct platform_device *pdev)
>  		pb->enable_gpio = gpio_to_desc(data->enable_gpio);
>  	}
>  
> -	if (pb->enable_gpio) {
> -		/*
> -		 * If the driver is probed from the device tree and there is a
> -		 * phandle link pointing to the backlight node, it is safe to
> -		 * assume that another driver will enable the backlight at the
> -		 * appropriate time. Therefore, if it is disabled, keep it so.
> -		 */
> -		if (node && node->phandle &&
> -		    gpiod_get_direction(pb->enable_gpio) == GPIOF_DIR_OUT &&
> -		    gpiod_get_value(pb->enable_gpio) == 0)
> -			initial_blank = FB_BLANK_POWERDOWN;
> -		else
> -			gpiod_direction_output(pb->enable_gpio, 1);
> -	}
> -
>  	pb->power_supply = devm_regulator_get(&pdev->dev, "power");
>  	if (IS_ERR(pb->power_supply)) {
>  		ret = PTR_ERR(pb->power_supply);
>  		goto err_alloc;
>  	}
>  
> -	if (node && node->phandle && !regulator_is_enabled(pb->power_supply))
> -		initial_blank = FB_BLANK_POWERDOWN;
> -
>  	pb->pwm = devm_pwm_get(&pdev->dev, NULL);
>  	if (IS_ERR(pb->pwm) && PTR_ERR(pb->pwm) != -EPROBE_DEFER && !node) {
>  		dev_err(&pdev->dev, "unable to request PWM, trying legacy API\n");
> @@ -347,7 +362,7 @@ static int pwm_backlight_probe(struct platform_device *pdev)
>  	}
>  
>  	bl->props.brightness = data->dft_brightness;
> -	bl->props.power = initial_blank;
> +	bl->props.power = pwm_backlight_initial_power_state(pb);
>  	backlight_update_status(bl);
>  
>  	platform_set_drvdata(pdev, bl);
Péter Ujfalusi Oct. 26, 2016, 1:02 p.m.
On 10/26/16 15:12, Lee Jones wrote:
> On Fri, 30 Sep 2016, Peter Ujfalusi wrote:
> 
>> Move the check for gpio and regulator initial state to a new function and
>> document better what we are checking and why.
>>
>> It is going to be easier to fix or improve the initial power state
>> configuration later and it is easier to read the code.
>>
>> Signed-off-by: Peter Ujfalusi <peter.ujfalusi@ti.com>
>> ---
>>  drivers/video/backlight/pwm_bl.c | 55 +++++++++++++++++++++++++---------------
>>  1 file changed, 35 insertions(+), 20 deletions(-)
>>
>> diff --git a/drivers/video/backlight/pwm_bl.c b/drivers/video/backlight/pwm_bl.c
>> index b2b366bb0f97..9bc4715bf116 100644
>> --- a/drivers/video/backlight/pwm_bl.c
>> +++ b/drivers/video/backlight/pwm_bl.c
>> @@ -192,6 +192,40 @@ static int pwm_backlight_parse_dt(struct device *dev,
>>  }
>>  #endif
>>  
>> +static int pwm_backlight_initial_power_state(const struct pwm_bl_data *pb)
>> +{
>> +	struct device_node *node = pb->dev->of_node;
>> +
>> +	/* Not booted with device tree or no phandle link to the node */
>> +	if (!node || !node->phandle)
>> +		return FB_BLANK_UNBLANK;
> 
> This changes the semantics of the current implementation.
> 
> In the code you're removing, if the enable_gpio is present and no DT
> is found, we set the GPIO direction to output.  In your implementation,
> if no DT is found you don't do anything regardless.
> 
> Is that intentional?

Argh, no, it is not intentional.

It should have been like this:

	/* Not booted with device tree or no phandle link to the node */
	if (!node || !node->phandle) {
		/* Set enable GPIO if it is valid */
		if (pb->enable_gpio)
			gpiod_direction_output(pb->enable_gpio, 1);

		return FB_BLANK_UNBLANK;
	}

On the other hand we are not doing the same for the regulator in case of non
DT boot or when the backlight has no users. So we do enable the GPIO, but the
regulator might be left disabled...

I'll resend the series with this change.

> 
>> +	/*
>> +	 * If the driver is probed from the device tree and there is a
>> +	 * phandle link pointing to the backlight node, it is safe to
>> +	 * assume that another driver will enable the backlight at the
>> +	 * appropriate time. Therefore, if it is disabled, keep it so.
>> +	 */
>> +
>> +	/*
>> +	 * if the enable GPIO is set as output and it is disabled, do not enable
>> +	 * the backlight
>> +	 */
>> +	if (pb->enable_gpio) {
>> +		if (gpiod_get_direction(pb->enable_gpio) == GPIOF_DIR_OUT &&
>> +		    gpiod_get_value(pb->enable_gpio) == 0)
>> +			return FB_BLANK_POWERDOWN;
>> +
>> +		gpiod_direction_output(pb->enable_gpio, 1);
>> +	}
>> +
>> +	/* The regulator is disabled, do not enable the backlight */
>> +	if (!regulator_is_enabled(pb->power_supply))
>> +		return FB_BLANK_POWERDOWN;
>> +
>> +	return FB_BLANK_UNBLANK;
>> +}
>> +
>>  static int pwm_backlight_probe(struct platform_device *pdev)
>>  {
>>  	struct platform_pwm_backlight_data *data = dev_get_platdata(&pdev->dev);
>> @@ -200,7 +234,6 @@ static int pwm_backlight_probe(struct platform_device *pdev)
>>  	struct backlight_device *bl;
>>  	struct device_node *node = pdev->dev.of_node;
>>  	struct pwm_bl_data *pb;
>> -	int initial_blank = FB_BLANK_UNBLANK;
>>  	struct pwm_args pargs;
>>  	int ret;
>>  
>> @@ -267,30 +300,12 @@ static int pwm_backlight_probe(struct platform_device *pdev)
>>  		pb->enable_gpio = gpio_to_desc(data->enable_gpio);
>>  	}
>>  
>> -	if (pb->enable_gpio) {
>> -		/*
>> -		 * If the driver is probed from the device tree and there is a
>> -		 * phandle link pointing to the backlight node, it is safe to
>> -		 * assume that another driver will enable the backlight at the
>> -		 * appropriate time. Therefore, if it is disabled, keep it so.
>> -		 */
>> -		if (node && node->phandle &&
>> -		    gpiod_get_direction(pb->enable_gpio) == GPIOF_DIR_OUT &&
>> -		    gpiod_get_value(pb->enable_gpio) == 0)
>> -			initial_blank = FB_BLANK_POWERDOWN;
>> -		else
>> -			gpiod_direction_output(pb->enable_gpio, 1);
>> -	}
>> -
>>  	pb->power_supply = devm_regulator_get(&pdev->dev, "power");
>>  	if (IS_ERR(pb->power_supply)) {
>>  		ret = PTR_ERR(pb->power_supply);
>>  		goto err_alloc;
>>  	}
>>  
>> -	if (node && node->phandle && !regulator_is_enabled(pb->power_supply))
>> -		initial_blank = FB_BLANK_POWERDOWN;
>> -
>>  	pb->pwm = devm_pwm_get(&pdev->dev, NULL);
>>  	if (IS_ERR(pb->pwm) && PTR_ERR(pb->pwm) != -EPROBE_DEFER && !node) {
>>  		dev_err(&pdev->dev, "unable to request PWM, trying legacy API\n");
>> @@ -347,7 +362,7 @@ static int pwm_backlight_probe(struct platform_device *pdev)
>>  	}
>>  
>>  	bl->props.brightness = data->dft_brightness;
>> -	bl->props.power = initial_blank;
>> +	bl->props.power = pwm_backlight_initial_power_state(pb);
>>  	backlight_update_status(bl);
>>  
>>  	platform_set_drvdata(pdev, bl);
>
Péter Ujfalusi Oct. 27, 2016, 7:18 a.m.
On 10/26/16 16:02, Peter Ujfalusi wrote:
> On 10/26/16 15:12, Lee Jones wrote:
>> On Fri, 30 Sep 2016, Peter Ujfalusi wrote:
>>
>>> Move the check for gpio and regulator initial state to a new function and
>>> document better what we are checking and why.
>>>
>>> It is going to be easier to fix or improve the initial power state
>>> configuration later and it is easier to read the code.
>>>
>>> Signed-off-by: Peter Ujfalusi <peter.ujfalusi@ti.com>
>>> ---
>>>  drivers/video/backlight/pwm_bl.c | 55 +++++++++++++++++++++++++---------------
>>>  1 file changed, 35 insertions(+), 20 deletions(-)
>>>
>>> diff --git a/drivers/video/backlight/pwm_bl.c b/drivers/video/backlight/pwm_bl.c
>>> index b2b366bb0f97..9bc4715bf116 100644
>>> --- a/drivers/video/backlight/pwm_bl.c
>>> +++ b/drivers/video/backlight/pwm_bl.c
>>> @@ -192,6 +192,40 @@ static int pwm_backlight_parse_dt(struct device *dev,
>>>  }
>>>  #endif
>>>  
>>> +static int pwm_backlight_initial_power_state(const struct pwm_bl_data *pb)
>>> +{
>>> +	struct device_node *node = pb->dev->of_node;
>>> +
>>> +	/* Not booted with device tree or no phandle link to the node */
>>> +	if (!node || !node->phandle)
>>> +		return FB_BLANK_UNBLANK;
>>
>> This changes the semantics of the current implementation.
>>
>> In the code you're removing, if the enable_gpio is present and no DT
>> is found, we set the GPIO direction to output.  In your implementation,
>> if no DT is found you don't do anything regardless.
>>
>> Is that intentional?
> 
> Argh, no, it is not intentional.
> 
> It should have been like this:
> 
> 	/* Not booted with device tree or no phandle link to the node */
> 	if (!node || !node->phandle) {
> 		/* Set enable GPIO if it is valid */
> 		if (pb->enable_gpio)
> 			gpiod_direction_output(pb->enable_gpio, 1);
> 
> 		return FB_BLANK_UNBLANK;
> 	}
> 
> On the other hand we are not doing the same for the regulator in case of non
> DT boot or when the backlight has no users. So we do enable the GPIO, but the
> regulator might be left disabled...
> 
> I'll resend the series with this change.

This is not really correct either.

If we boot in legacy mode the data->enable_gpio number is used to get the GPIO
and we configure the initial state as GPIOF_OUT_INIT_HIGH. So legacy boot will
have the line high in any case.

I think the only case we should handle differently is when the GPIO is
configured as input (I don't think it happens, but just to be sure). In that
case we need to change the direction to output and set the GPIO as disabled.
If it was input, it was not driving the line.

In the pwm_backlight_initial_power_state() function we will not need to check
for GPIO direction as it is guaranteed that it is output, we can only check
for the value of the GPIO.

I will resubmit with this change.

> 
>>
>>> +	/*
>>> +	 * If the driver is probed from the device tree and there is a
>>> +	 * phandle link pointing to the backlight node, it is safe to
>>> +	 * assume that another driver will enable the backlight at the
>>> +	 * appropriate time. Therefore, if it is disabled, keep it so.
>>> +	 */
>>> +
>>> +	/*
>>> +	 * if the enable GPIO is set as output and it is disabled, do not enable
>>> +	 * the backlight
>>> +	 */
>>> +	if (pb->enable_gpio) {
>>> +		if (gpiod_get_direction(pb->enable_gpio) == GPIOF_DIR_OUT &&
>>> +		    gpiod_get_value(pb->enable_gpio) == 0)
>>> +			return FB_BLANK_POWERDOWN;
>>> +
>>> +		gpiod_direction_output(pb->enable_gpio, 1);
>>> +	}
>>> +
>>> +	/* The regulator is disabled, do not enable the backlight */
>>> +	if (!regulator_is_enabled(pb->power_supply))
>>> +		return FB_BLANK_POWERDOWN;
>>> +
>>> +	return FB_BLANK_UNBLANK;
>>> +}
>>> +
>>>  static int pwm_backlight_probe(struct platform_device *pdev)
>>>  {
>>>  	struct platform_pwm_backlight_data *data = dev_get_platdata(&pdev->dev);
>>> @@ -200,7 +234,6 @@ static int pwm_backlight_probe(struct platform_device *pdev)
>>>  	struct backlight_device *bl;
>>>  	struct device_node *node = pdev->dev.of_node;
>>>  	struct pwm_bl_data *pb;
>>> -	int initial_blank = FB_BLANK_UNBLANK;
>>>  	struct pwm_args pargs;
>>>  	int ret;
>>>  
>>> @@ -267,30 +300,12 @@ static int pwm_backlight_probe(struct platform_device *pdev)
>>>  		pb->enable_gpio = gpio_to_desc(data->enable_gpio);
>>>  	}
>>>  
>>> -	if (pb->enable_gpio) {
>>> -		/*
>>> -		 * If the driver is probed from the device tree and there is a
>>> -		 * phandle link pointing to the backlight node, it is safe to
>>> -		 * assume that another driver will enable the backlight at the
>>> -		 * appropriate time. Therefore, if it is disabled, keep it so.
>>> -		 */
>>> -		if (node && node->phandle &&
>>> -		    gpiod_get_direction(pb->enable_gpio) == GPIOF_DIR_OUT &&
>>> -		    gpiod_get_value(pb->enable_gpio) == 0)
>>> -			initial_blank = FB_BLANK_POWERDOWN;
>>> -		else
>>> -			gpiod_direction_output(pb->enable_gpio, 1);
>>> -	}
>>> -
>>>  	pb->power_supply = devm_regulator_get(&pdev->dev, "power");
>>>  	if (IS_ERR(pb->power_supply)) {
>>>  		ret = PTR_ERR(pb->power_supply);
>>>  		goto err_alloc;
>>>  	}
>>>  
>>> -	if (node && node->phandle && !regulator_is_enabled(pb->power_supply))
>>> -		initial_blank = FB_BLANK_POWERDOWN;
>>> -
>>>  	pb->pwm = devm_pwm_get(&pdev->dev, NULL);
>>>  	if (IS_ERR(pb->pwm) && PTR_ERR(pb->pwm) != -EPROBE_DEFER && !node) {
>>>  		dev_err(&pdev->dev, "unable to request PWM, trying legacy API\n");
>>> @@ -347,7 +362,7 @@ static int pwm_backlight_probe(struct platform_device *pdev)
>>>  	}
>>>  
>>>  	bl->props.brightness = data->dft_brightness;
>>> -	bl->props.power = initial_blank;
>>> +	bl->props.power = pwm_backlight_initial_power_state(pb);
>>>  	backlight_update_status(bl);
>>>  
>>>  	platform_set_drvdata(pdev, bl);
>>
> 
>

Patch hide | download patch | download mbox

diff --git a/drivers/video/backlight/pwm_bl.c b/drivers/video/backlight/pwm_bl.c
index b2b366bb0f97..9bc4715bf116 100644
--- a/drivers/video/backlight/pwm_bl.c
+++ b/drivers/video/backlight/pwm_bl.c
@@ -192,6 +192,40 @@  static int pwm_backlight_parse_dt(struct device *dev,
 }
 #endif
 
+static int pwm_backlight_initial_power_state(const struct pwm_bl_data *pb)
+{
+	struct device_node *node = pb->dev->of_node;
+
+	/* Not booted with device tree or no phandle link to the node */
+	if (!node || !node->phandle)
+		return FB_BLANK_UNBLANK;
+
+	/*
+	 * If the driver is probed from the device tree and there is a
+	 * phandle link pointing to the backlight node, it is safe to
+	 * assume that another driver will enable the backlight at the
+	 * appropriate time. Therefore, if it is disabled, keep it so.
+	 */
+
+	/*
+	 * if the enable GPIO is set as output and it is disabled, do not enable
+	 * the backlight
+	 */
+	if (pb->enable_gpio) {
+		if (gpiod_get_direction(pb->enable_gpio) == GPIOF_DIR_OUT &&
+		    gpiod_get_value(pb->enable_gpio) == 0)
+			return FB_BLANK_POWERDOWN;
+
+		gpiod_direction_output(pb->enable_gpio, 1);
+	}
+
+	/* The regulator is disabled, do not enable the backlight */
+	if (!regulator_is_enabled(pb->power_supply))
+		return FB_BLANK_POWERDOWN;
+
+	return FB_BLANK_UNBLANK;
+}
+
 static int pwm_backlight_probe(struct platform_device *pdev)
 {
 	struct platform_pwm_backlight_data *data = dev_get_platdata(&pdev->dev);
@@ -200,7 +234,6 @@  static int pwm_backlight_probe(struct platform_device *pdev)
 	struct backlight_device *bl;
 	struct device_node *node = pdev->dev.of_node;
 	struct pwm_bl_data *pb;
-	int initial_blank = FB_BLANK_UNBLANK;
 	struct pwm_args pargs;
 	int ret;
 
@@ -267,30 +300,12 @@  static int pwm_backlight_probe(struct platform_device *pdev)
 		pb->enable_gpio = gpio_to_desc(data->enable_gpio);
 	}
 
-	if (pb->enable_gpio) {
-		/*
-		 * If the driver is probed from the device tree and there is a
-		 * phandle link pointing to the backlight node, it is safe to
-		 * assume that another driver will enable the backlight at the
-		 * appropriate time. Therefore, if it is disabled, keep it so.
-		 */
-		if (node && node->phandle &&
-		    gpiod_get_direction(pb->enable_gpio) == GPIOF_DIR_OUT &&
-		    gpiod_get_value(pb->enable_gpio) == 0)
-			initial_blank = FB_BLANK_POWERDOWN;
-		else
-			gpiod_direction_output(pb->enable_gpio, 1);
-	}
-
 	pb->power_supply = devm_regulator_get(&pdev->dev, "power");
 	if (IS_ERR(pb->power_supply)) {
 		ret = PTR_ERR(pb->power_supply);
 		goto err_alloc;
 	}
 
-	if (node && node->phandle && !regulator_is_enabled(pb->power_supply))
-		initial_blank = FB_BLANK_POWERDOWN;
-
 	pb->pwm = devm_pwm_get(&pdev->dev, NULL);
 	if (IS_ERR(pb->pwm) && PTR_ERR(pb->pwm) != -EPROBE_DEFER && !node) {
 		dev_err(&pdev->dev, "unable to request PWM, trying legacy API\n");
@@ -347,7 +362,7 @@  static int pwm_backlight_probe(struct platform_device *pdev)
 	}
 
 	bl->props.brightness = data->dft_brightness;
-	bl->props.power = initial_blank;
+	bl->props.power = pwm_backlight_initial_power_state(pb);
 	backlight_update_status(bl);
 
 	platform_set_drvdata(pdev, bl);