diff mbox

gpio: mvebu: change compatible string for PWM support

Message ID 20170601200820.22396-1-ralph.sennhauser@gmail.com (mailing list archive)
State New, archived
Headers show

Commit Message

Ralph Sennhauser June 1, 2017, 8:08 p.m. UTC
As it turns out more than just Armada 370 and XP support using GPIO
lines as PWM lines. For example the Armada 38x family has the same
hardware support. As such "marvell,armada-370-xp-gpio" for the
compatible string is a misnomer.

Change the compatible string to "marvell,armada-370-gpio" before the
driver makes it out of the -rc stage. This also follows the practice of
using only the first device family supported as part of the name.

Also update the documentation and comments in the code accordingly.

Fixes: 757642f9a584 ("gpio: mvebu: Add limited PWM support")
Signed-off-by: Ralph Sennhauser <ralph.sennhauser@gmail.com>

---

Hi everyone,

The suggestion to change the compatible string last minute comes from
Gregory CLEMENT after we realized the bad choice of name due to Richard
Genoud reporting an issue when he used the driver with an Armada-388.

Rob Herring just requested to use a separate compatible string but not
what it should look like. So I assume he is fine with the new one as
well. The rest of this patch is rather minor.

Nothing in tree is using this driver so far, first consumers will be
added with 4.13.

Ralph

---
 Documentation/devicetree/bindings/gpio/gpio-mvebu.txt | 6 +++---
 drivers/gpio/gpio-mvebu.c                             | 6 +++---
 2 files changed, 6 insertions(+), 6 deletions(-)

Comments

Gregory CLEMENT June 2, 2017, 9:24 a.m. UTC | #1
Hi Ralph,
 
 On jeu., juin 01 2017, Ralph Sennhauser <ralph.sennhauser@gmail.com> wrote:

> As it turns out more than just Armada 370 and XP support using GPIO
> lines as PWM lines. For example the Armada 38x family has the same
> hardware support. As such "marvell,armada-370-xp-gpio" for the
> compatible string is a misnomer.
>
> Change the compatible string to "marvell,armada-370-gpio" before the
> driver makes it out of the -rc stage. This also follows the practice of
> using only the first device family supported as part of the name.
>
> Also update the documentation and comments in the code accordingly.
>

As I suggested it obviously:

Acked-by: Gregory CLEMENT <gregory.clement@free-electrons.com>

Thanks,

Gregory


> Fixes: 757642f9a584 ("gpio: mvebu: Add limited PWM support")
> Signed-off-by: Ralph Sennhauser <ralph.sennhauser@gmail.com>
>
> ---
>
> Hi everyone,
>
> The suggestion to change the compatible string last minute comes from
> Gregory CLEMENT after we realized the bad choice of name due to Richard
> Genoud reporting an issue when he used the driver with an Armada-388.
>
> Rob Herring just requested to use a separate compatible string but not
> what it should look like. So I assume he is fine with the new one as
> well. The rest of this patch is rather minor.
>
> Nothing in tree is using this driver so far, first consumers will be
> added with 4.13.
>
> Ralph
>
> ---
>  Documentation/devicetree/bindings/gpio/gpio-mvebu.txt | 6 +++---
>  drivers/gpio/gpio-mvebu.c                             | 6 +++---
>  2 files changed, 6 insertions(+), 6 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/gpio/gpio-mvebu.txt b/Documentation/devicetree/bindings/gpio/gpio-mvebu.txt
> index 42c3bb2..01e331a 100644
> --- a/Documentation/devicetree/bindings/gpio/gpio-mvebu.txt
> +++ b/Documentation/devicetree/bindings/gpio/gpio-mvebu.txt
> @@ -41,9 +41,9 @@ Required properties:
>  Optional properties:
>  
>  In order to use the GPIO lines in PWM mode, some additional optional
> -properties are required. Only Armada 370 and XP support these properties.
> +properties are required.
>  
> -- compatible: Must contain "marvell,armada-370-xp-gpio"
> +- compatible: Must contain "marvell,armada-370-gpio"
>  
>  - reg: an additional register set is needed, for the GPIO Blink
>    Counter on/off registers.
> @@ -71,7 +71,7 @@ Example:
>  		};
>  
>  		gpio1: gpio@18140 {
> -			compatible = "marvell,armada-370-xp-gpio";
> +			compatible = "marvell,armada-370-gpio";
>  			reg = <0x18140 0x40>, <0x181c8 0x08>;
>  			reg-names = "gpio", "pwm";
>  			ngpios = <17>;
> diff --git a/drivers/gpio/gpio-mvebu.c b/drivers/gpio/gpio-mvebu.c
> index 19a92ef..f94fd47 100644
> --- a/drivers/gpio/gpio-mvebu.c
> +++ b/drivers/gpio/gpio-mvebu.c
> @@ -721,7 +721,7 @@ static int mvebu_pwm_probe(struct platform_device *pdev,
>  	u32 set;
>  
>  	if (!of_device_is_compatible(mvchip->chip.of_node,
> -				     "marvell,armada-370-xp-gpio"))
> +				     "marvell,armada-370-gpio"))
>  		return 0;
>  
>  	if (IS_ERR(mvchip->clk))
> @@ -845,7 +845,7 @@ static const struct of_device_id mvebu_gpio_of_match[] = {
>  		.data	    = (void *) MVEBU_GPIO_SOC_VARIANT_ARMADAXP,
>  	},
>  	{
> -		.compatible = "marvell,armada-370-xp-gpio",
> +		.compatible = "marvell,armada-370-gpio",
>  		.data	    = (void *) MVEBU_GPIO_SOC_VARIANT_ORION,
>  	},
>  	{
> @@ -1121,7 +1121,7 @@ static int mvebu_gpio_probe(struct platform_device *pdev)
>  						 mvchip);
>  	}
>  
> -	/* Armada 370/XP has simple PWM support for GPIO lines */
> +	/* Some MVEBU SoCs have simple PWM support for GPIO lines */
>  	if (IS_ENABLED(CONFIG_PWM))
>  		return mvebu_pwm_probe(pdev, mvchip, id);
>  
> -- 
> 2.10.2
>
Rob Herring June 7, 2017, 10:13 p.m. UTC | #2
On Thu, Jun 01, 2017 at 10:08:20PM +0200, Ralph Sennhauser wrote:
> As it turns out more than just Armada 370 and XP support using GPIO
> lines as PWM lines. For example the Armada 38x family has the same
> hardware support. As such "marvell,armada-370-xp-gpio" for the
> compatible string is a misnomer.
> 
> Change the compatible string to "marvell,armada-370-gpio" before the
> driver makes it out of the -rc stage. This also follows the practice of
> using only the first device family supported as part of the name.
> 
> Also update the documentation and comments in the code accordingly.
> 
> Fixes: 757642f9a584 ("gpio: mvebu: Add limited PWM support")
> Signed-off-by: Ralph Sennhauser <ralph.sennhauser@gmail.com>
> 
> ---
> 
> Hi everyone,
> 
> The suggestion to change the compatible string last minute comes from
> Gregory CLEMENT after we realized the bad choice of name due to Richard
> Genoud reporting an issue when he used the driver with an Armada-388.
> 
> Rob Herring just requested to use a separate compatible string but not
> what it should look like. So I assume he is fine with the new one as
> well. The rest of this patch is rather minor.
> 
> Nothing in tree is using this driver so far, first consumers will be
> added with 4.13.
> 
> Ralph
> 
> ---
>  Documentation/devicetree/bindings/gpio/gpio-mvebu.txt | 6 +++---
>  drivers/gpio/gpio-mvebu.c                             | 6 +++---
>  2 files changed, 6 insertions(+), 6 deletions(-)

Acked-by: Rob Herring <robh@kernel.org>
Linus Walleij June 9, 2017, 7:42 a.m. UTC | #3
On Thu, Jun 1, 2017 at 10:08 PM, Ralph Sennhauser
<ralph.sennhauser@gmail.com> wrote:

> As it turns out more than just Armada 370 and XP support using GPIO
> lines as PWM lines. For example the Armada 38x family has the same
> hardware support. As such "marvell,armada-370-xp-gpio" for the
> compatible string is a misnomer.
>
> Change the compatible string to "marvell,armada-370-gpio" before the
> driver makes it out of the -rc stage. This also follows the practice of
> using only the first device family supported as part of the name.
>
> Also update the documentation and comments in the code accordingly.
>
> Fixes: 757642f9a584 ("gpio: mvebu: Add limited PWM support")
> Signed-off-by: Ralph Sennhauser <ralph.sennhauser@gmail.com>

Patch applied for next with the tags.

Yours,
Linus Walleij
Richard Genoud June 9, 2017, 7:45 a.m. UTC | #4
2017-06-09 9:42 GMT+02:00 Linus Walleij <linus.walleij@linaro.org>:
> On Thu, Jun 1, 2017 at 10:08 PM, Ralph Sennhauser
> <ralph.sennhauser@gmail.com> wrote:
>
>> As it turns out more than just Armada 370 and XP support using GPIO
>> lines as PWM lines. For example the Armada 38x family has the same
>> hardware support. As such "marvell,armada-370-xp-gpio" for the
>> compatible string is a misnomer.
>>
>> Change the compatible string to "marvell,armada-370-gpio" before the
>> driver makes it out of the -rc stage. This also follows the practice of
>> using only the first device family supported as part of the name.
>>
>> Also update the documentation and comments in the code accordingly.
>>
>> Fixes: 757642f9a584 ("gpio: mvebu: Add limited PWM support")
>> Signed-off-by: Ralph Sennhauser <ralph.sennhauser@gmail.com>
>
> Patch applied for next with the tags.
You mean for fixes right ?
The goal was to correct "marvell,armada-370-xp-gpio" before 4.12 is out.

>
> Yours,
> Linus Walleij

Regards,
Richard
Ralph Sennhauser June 9, 2017, 8:12 p.m. UTC | #5
On Fri, 9 Jun 2017 09:42:26 +0200
Linus Walleij <linus.walleij@linaro.org> wrote:

> On Thu, Jun 1, 2017 at 10:08 PM, Ralph Sennhauser
> <ralph.sennhauser@gmail.com> wrote:
> 
> > As it turns out more than just Armada 370 and XP support using GPIO
> > lines as PWM lines. For example the Armada 38x family has the same
> > hardware support. As such "marvell,armada-370-xp-gpio" for the
> > compatible string is a misnomer.
> >
> > Change the compatible string to "marvell,armada-370-gpio" before the
> > driver makes it out of the -rc stage. This also follows the
> > practice of using only the first device family supported as part of
> > the name.
> >
> > Also update the documentation and comments in the code accordingly.
> >
> > Fixes: 757642f9a584 ("gpio: mvebu: Add limited PWM support")
> > Signed-off-by: Ralph Sennhauser <ralph.sennhauser@gmail.com>  
> 
> Patch applied for next with the tags.

Hi Linus,

As Richard already correctly pointed out this needs to go into 4.12 as
we can't really change the compatible string after 4.12 final was
released. So this commit was pushed to the wrong branch. Sorry for
not having been more explicit in my wording.

Thanks
Ralph
Linus Walleij June 16, 2017, 9:13 a.m. UTC | #6
On Fri, Jun 9, 2017 at 9:45 AM, Richard Genoud <richard.genoud@gmail.com> wrote:
> 2017-06-09 9:42 GMT+02:00 Linus Walleij <linus.walleij@linaro.org>:
>> On Thu, Jun 1, 2017 at 10:08 PM, Ralph Sennhauser
>> <ralph.sennhauser@gmail.com> wrote:
>>
>>> As it turns out more than just Armada 370 and XP support using GPIO
>>> lines as PWM lines. For example the Armada 38x family has the same
>>> hardware support. As such "marvell,armada-370-xp-gpio" for the
>>> compatible string is a misnomer.
>>>
>>> Change the compatible string to "marvell,armada-370-gpio" before the
>>> driver makes it out of the -rc stage. This also follows the practice of
>>> using only the first device family supported as part of the name.
>>>
>>> Also update the documentation and comments in the code accordingly.
>>>
>>> Fixes: 757642f9a584 ("gpio: mvebu: Add limited PWM support")
>>> Signed-off-by: Ralph Sennhauser <ralph.sennhauser@gmail.com>
>>
>> Patch applied for next with the tags.
> You mean for fixes right ?
> The goal was to correct "marvell,armada-370-xp-gpio" before 4.12 is out.

OK I moved it to fixes.

Yours,
Linus Walleij
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/gpio/gpio-mvebu.txt b/Documentation/devicetree/bindings/gpio/gpio-mvebu.txt
index 42c3bb2..01e331a 100644
--- a/Documentation/devicetree/bindings/gpio/gpio-mvebu.txt
+++ b/Documentation/devicetree/bindings/gpio/gpio-mvebu.txt
@@ -41,9 +41,9 @@  Required properties:
 Optional properties:
 
 In order to use the GPIO lines in PWM mode, some additional optional
-properties are required. Only Armada 370 and XP support these properties.
+properties are required.
 
-- compatible: Must contain "marvell,armada-370-xp-gpio"
+- compatible: Must contain "marvell,armada-370-gpio"
 
 - reg: an additional register set is needed, for the GPIO Blink
   Counter on/off registers.
@@ -71,7 +71,7 @@  Example:
 		};
 
 		gpio1: gpio@18140 {
-			compatible = "marvell,armada-370-xp-gpio";
+			compatible = "marvell,armada-370-gpio";
 			reg = <0x18140 0x40>, <0x181c8 0x08>;
 			reg-names = "gpio", "pwm";
 			ngpios = <17>;
diff --git a/drivers/gpio/gpio-mvebu.c b/drivers/gpio/gpio-mvebu.c
index 19a92ef..f94fd47 100644
--- a/drivers/gpio/gpio-mvebu.c
+++ b/drivers/gpio/gpio-mvebu.c
@@ -721,7 +721,7 @@  static int mvebu_pwm_probe(struct platform_device *pdev,
 	u32 set;
 
 	if (!of_device_is_compatible(mvchip->chip.of_node,
-				     "marvell,armada-370-xp-gpio"))
+				     "marvell,armada-370-gpio"))
 		return 0;
 
 	if (IS_ERR(mvchip->clk))
@@ -845,7 +845,7 @@  static const struct of_device_id mvebu_gpio_of_match[] = {
 		.data	    = (void *) MVEBU_GPIO_SOC_VARIANT_ARMADAXP,
 	},
 	{
-		.compatible = "marvell,armada-370-xp-gpio",
+		.compatible = "marvell,armada-370-gpio",
 		.data	    = (void *) MVEBU_GPIO_SOC_VARIANT_ORION,
 	},
 	{
@@ -1121,7 +1121,7 @@  static int mvebu_gpio_probe(struct platform_device *pdev)
 						 mvchip);
 	}
 
-	/* Armada 370/XP has simple PWM support for GPIO lines */
+	/* Some MVEBU SoCs have simple PWM support for GPIO lines */
 	if (IS_ENABLED(CONFIG_PWM))
 		return mvebu_pwm_probe(pdev, mvchip, id);