diff mbox series

[11/14] dt-bindings: can: rcar_can: document r8a77965 can support

Message ID 20180804231114.21420-12-erosca@de.adit-jv.com (mailing list archive)
State Superseded
Delegated to: Simon Horman
Headers show
Series Add minimal DTS support for M3-N Starter Kit | expand

Commit Message

Eugeniu Rosca Aug. 4, 2018, 11:11 p.m. UTC
After adding CAN support to arch/arm64/boot/dts/renesas/r8a77965.dtsi,
checkpatch complained that the new compatible string
"renesas,can-r8a77965" is not documented. Fix the warning.

Signed-off-by: Eugeniu Rosca <erosca@de.adit-jv.com>
---
 Documentation/devicetree/bindings/net/can/rcar_can.txt | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

Comments

Kieran Bingham Aug. 6, 2018, 10:56 a.m. UTC | #1
Hi Eugeniu

On 05/08/18 00:11, Eugeniu Rosca wrote:
> After adding CAN support to arch/arm64/boot/dts/renesas/r8a77965.dtsi,
> checkpatch complained that the new compatible string
> "renesas,can-r8a77965" is not documented. Fix the warning.
> 

Thanks to the correct ordering of your patches, (you have this one
*before* adding the CAN support to r8a77965) This commit message seems
to be predicting the future somewhat.

Perhaps just a simpler commit message would suffice:

"Document the support for rcar_can on R8A77965 SoC devices."


> Signed-off-by: Eugeniu Rosca <erosca@de.adit-jv.com>
> ---
>  Documentation/devicetree/bindings/net/can/rcar_can.txt | 10 +++++++---
>  1 file changed, 7 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/net/can/rcar_can.txt b/Documentation/devicetree/bindings/net/can/rcar_can.txt
> index 94a7f33ac5e9..23264451a5a4 100644
> --- a/Documentation/devicetree/bindings/net/can/rcar_can.txt
> +++ b/Documentation/devicetree/bindings/net/can/rcar_can.txt
> @@ -13,6 +13,7 @@ Required properties:
>  	      "renesas,can-r8a7794" if CAN controller is a part of R8A7794 SoC.
>  	      "renesas,can-r8a7795" if CAN controller is a part of R8A7795 SoC.
>  	      "renesas,can-r8a7796" if CAN controller is a part of R8A7796 SoC.
> +	      "renesas,can-r8a77965" if CAN controller is a part of R8A77965 SoC.
>  	      "renesas,rcar-gen1-can" for a generic R-Car Gen1 compatible device.
>  	      "renesas,rcar-gen2-can" for a generic R-Car Gen2 or RZ/G1
>  	      compatible device.
> @@ -28,9 +29,8 @@ Required properties:
>  - pinctrl-0: pin control group to be used for this controller.
>  - pinctrl-names: must be "default".
>  
> -Required properties for "renesas,can-r8a7795" and "renesas,can-r8a7796"
> -compatible:
> -In R8A7795 and R8A7796 SoCs, "clkp2" can be CANFD clock. This is a div6 clock
> +Required properties for compatibles [A], [B] and [C]:
> +For the denoted SoCs, "clkp2" can be CANFD clock. This is a div6 clock


This paragraph could be rewrapped...

>  and can be used by both CAN and CAN FD controller at the same time. It needs to
>  be scaled to maximum frequency if any of these controllers use it. This is done
>  using the below properties:
> @@ -38,6 +38,10 @@ using the below properties:
>  - assigned-clocks: phandle of clkp2(CANFD) clock.
>  - assigned-clock-rates: maximum frequency of this clock.
>  
> +[A] "renesas,can-r8a7795"
> +[B] "renesas,can-r8a7796"
> +[C] "renesas,can-r8a77965"
> +>  Optional properties:
>  - renesas,can-clock-select: R-Car CAN Clock Source Select. Valid values are:
>  			    <0x0> (default) : Peripheral clock (clkp1)
>
Sergei Shtylyov Aug. 6, 2018, 3:21 p.m. UTC | #2
Hello!

On 08/05/2018 02:11 AM, Eugeniu Rosca wrote:

> After adding CAN support to arch/arm64/boot/dts/renesas/r8a77965.dtsi,
> checkpatch complained that the new compatible string
> "renesas,can-r8a77965" is not documented. Fix the warning.
> 
> Signed-off-by: Eugeniu Rosca <erosca@de.adit-jv.com>
> ---
>  Documentation/devicetree/bindings/net/can/rcar_can.txt | 10 +++++++---
>  1 file changed, 7 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/net/can/rcar_can.txt b/Documentation/devicetree/bindings/net/can/rcar_can.txt
> index 94a7f33ac5e9..23264451a5a4 100644
> --- a/Documentation/devicetree/bindings/net/can/rcar_can.txt
> +++ b/Documentation/devicetree/bindings/net/can/rcar_can.txt
[...]
> @@ -28,9 +29,8 @@ Required properties:
>  - pinctrl-0: pin control group to be used for this controller.
>  - pinctrl-names: must be "default".
>  
> -Required properties for "renesas,can-r8a7795" and "renesas,can-r8a7796"
> -compatible:
> -In R8A7795 and R8A7796 SoCs, "clkp2" can be CANFD clock. This is a div6 clock
> +Required properties for compatibles [A], [B] and [C]:

   I'd suggest to avoid the footnotes:

Required properties for compatibles R8A7795, R8A7796, and R8A77965:

> +For the denoted SoCs, "clkp2" can be CANFD clock. This is a div6 clock
>  and can be used by both CAN and CAN FD controller at the same time. It needs to
>  be scaled to maximum frequency if any of these controllers use it. This is done
>  using the below properties:
[...]

MBR, Sergei
Eugeniu Rosca Aug. 6, 2018, 7:23 p.m. UTC | #3
Hi Sergei,

On Mon, Aug 06, 2018 at 06:21:09PM +0300, Sergei Shtylyov wrote:
> Hello!
> 
> On 08/05/2018 02:11 AM, Eugeniu Rosca wrote:
> 
> > After adding CAN support to arch/arm64/boot/dts/renesas/r8a77965.dtsi,
> > checkpatch complained that the new compatible string
> > "renesas,can-r8a77965" is not documented. Fix the warning.
> > 
> > Signed-off-by: Eugeniu Rosca <erosca@de.adit-jv.com>
> > ---
> >  Documentation/devicetree/bindings/net/can/rcar_can.txt | 10 +++++++---
> >  1 file changed, 7 insertions(+), 3 deletions(-)
> > 
> > diff --git a/Documentation/devicetree/bindings/net/can/rcar_can.txt b/Documentation/devicetree/bindings/net/can/rcar_can.txt
> > index 94a7f33ac5e9..23264451a5a4 100644
> > --- a/Documentation/devicetree/bindings/net/can/rcar_can.txt
> > +++ b/Documentation/devicetree/bindings/net/can/rcar_can.txt
> [...]
> > @@ -28,9 +29,8 @@ Required properties:
> >  - pinctrl-0: pin control group to be used for this controller.
> >  - pinctrl-names: must be "default".
> >  
> > -Required properties for "renesas,can-r8a7795" and "renesas,can-r8a7796"
> > -compatible:
> > -In R8A7795 and R8A7796 SoCs, "clkp2" can be CANFD clock. This is a div6 clock
> > +Required properties for compatibles [A], [B] and [C]:
> 
>    I'd suggest to avoid the footnotes:
> 
> Required properties for compatibles R8A7795, R8A7796, and R8A77965:

I like this proposal, since it is the least intrusive and allows future
addition of SoC models with minimum amount of lines changed. Will use it
in v2.

> 
> > +For the denoted SoCs, "clkp2" can be CANFD clock. This is a div6 clock
> >  and can be used by both CAN and CAN FD controller at the same time. It needs to
> >  be scaled to maximum frequency if any of these controllers use it. This is done
> >  using the below properties:
> [...]
> 
> MBR, Sergei

Thanks,
Eugeniu.
Sergei Shtylyov Aug. 6, 2018, 7:26 p.m. UTC | #4
On 08/06/2018 06:21 PM, Sergei Shtylyov wrote:

>> After adding CAN support to arch/arm64/boot/dts/renesas/r8a77965.dtsi,
>> checkpatch complained that the new compatible string
>> "renesas,can-r8a77965" is not documented. Fix the warning.
>>
>> Signed-off-by: Eugeniu Rosca <erosca@de.adit-jv.com>
>> ---
>>  Documentation/devicetree/bindings/net/can/rcar_can.txt | 10 +++++++---
>>  1 file changed, 7 insertions(+), 3 deletions(-)
>>
>> diff --git a/Documentation/devicetree/bindings/net/can/rcar_can.txt b/Documentation/devicetree/bindings/net/can/rcar_can.txt
>> index 94a7f33ac5e9..23264451a5a4 100644
>> --- a/Documentation/devicetree/bindings/net/can/rcar_can.txt
>> +++ b/Documentation/devicetree/bindings/net/can/rcar_can.txt
> [...]
>> @@ -28,9 +29,8 @@ Required properties:
>>  - pinctrl-0: pin control group to be used for this controller.
>>  - pinctrl-names: must be "default".
>>  
>> -Required properties for "renesas,can-r8a7795" and "renesas,can-r8a7796"
>> -compatible:
>> -In R8A7795 and R8A7796 SoCs, "clkp2" can be CANFD clock. This is a div6 clock
>> +Required properties for compatibles [A], [B] and [C]:
> 
>    I'd suggest to avoid the footnotes:
> 
> Required properties for compatibles R8A7795, R8A7796, and R8A77965:

   Oops, the word "compatibles" shouldn't have been there...

>> +For the denoted SoCs, "clkp2" can be CANFD clock. This is a div6 clock
>>  and can be used by both CAN and CAN FD controller at the same time. It needs to
>>  be scaled to maximum frequency if any of these controllers use it. This is done
>>  using the below properties:
> [...]

MBR, Sergei
Eugeniu Rosca Aug. 6, 2018, 7:39 p.m. UTC | #5
Hi Kieran,

On Mon, Aug 06, 2018 at 11:56:56AM +0100, Kieran Bingham wrote:
> Hi Eugeniu
> 
> On 05/08/18 00:11, Eugeniu Rosca wrote:
> > After adding CAN support to arch/arm64/boot/dts/renesas/r8a77965.dtsi,
> > checkpatch complained that the new compatible string
> > "renesas,can-r8a77965" is not documented. Fix the warning.
> > 
> 
> Thanks to the correct ordering of your patches, (you have this one
> *before* adding the CAN support to r8a77965) This commit message seems
> to be predicting the future somewhat.
> 
> Perhaps just a simpler commit message would suffice:
> 
> "Document the support for rcar_can on R8A77965 SoC devices."

I like giving the true story behind the patch and the story was that I
was hit by the checkpatch warning, fixed it and re-ordered the commits.
But I will use your version if it sounds better to you.

> 
> > Signed-off-by: Eugeniu Rosca <erosca@de.adit-jv.com>
> > ---
> >  Documentation/devicetree/bindings/net/can/rcar_can.txt | 10 +++++++---
> >  1 file changed, 7 insertions(+), 3 deletions(-)
> > 
> > diff --git a/Documentation/devicetree/bindings/net/can/rcar_can.txt b/Documentation/devicetree/bindings/net/can/rcar_can.txt
> > index 94a7f33ac5e9..23264451a5a4 100644
> > --- a/Documentation/devicetree/bindings/net/can/rcar_can.txt
> > +++ b/Documentation/devicetree/bindings/net/can/rcar_can.txt
> > @@ -13,6 +13,7 @@ Required properties:
> >  	      "renesas,can-r8a7794" if CAN controller is a part of R8A7794 SoC.
> >  	      "renesas,can-r8a7795" if CAN controller is a part of R8A7795 SoC.
> >  	      "renesas,can-r8a7796" if CAN controller is a part of R8A7796 SoC.
> > +	      "renesas,can-r8a77965" if CAN controller is a part of R8A77965 SoC.
> >  	      "renesas,rcar-gen1-can" for a generic R-Car Gen1 compatible device.
> >  	      "renesas,rcar-gen2-can" for a generic R-Car Gen2 or RZ/G1
> >  	      compatible device.
> > @@ -28,9 +29,8 @@ Required properties:
> >  - pinctrl-0: pin control group to be used for this controller.
> >  - pinctrl-names: must be "default".
> >  
> > -Required properties for "renesas,can-r8a7795" and "renesas,can-r8a7796"
> > -compatible:
> > -In R8A7795 and R8A7796 SoCs, "clkp2" can be CANFD clock. This is a div6 clock
> > +Required properties for compatibles [A], [B] and [C]:
> > +For the denoted SoCs, "clkp2" can be CANFD clock. This is a div6 clock
> 
> 
> This paragraph could be rewrapped...

Will implement in v2.

> 
> >  and can be used by both CAN and CAN FD controller at the same time. It needs to
> >  be scaled to maximum frequency if any of these controllers use it. This is done
> >  using the below properties:
> > @@ -38,6 +38,10 @@ using the below properties:
> >  - assigned-clocks: phandle of clkp2(CANFD) clock.
> >  - assigned-clock-rates: maximum frequency of this clock.
> >  
> > +[A] "renesas,can-r8a7795"
> > +[B] "renesas,can-r8a7796"
> > +[C] "renesas,can-r8a77965"
> > +>  Optional properties:
> >  - renesas,can-clock-select: R-Car CAN Clock Source Select. Valid values are:
> >  			    <0x0> (default) : Peripheral clock (clkp1)
> > 
> 

Thanks,
Eugeniu.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/net/can/rcar_can.txt b/Documentation/devicetree/bindings/net/can/rcar_can.txt
index 94a7f33ac5e9..23264451a5a4 100644
--- a/Documentation/devicetree/bindings/net/can/rcar_can.txt
+++ b/Documentation/devicetree/bindings/net/can/rcar_can.txt
@@ -13,6 +13,7 @@  Required properties:
 	      "renesas,can-r8a7794" if CAN controller is a part of R8A7794 SoC.
 	      "renesas,can-r8a7795" if CAN controller is a part of R8A7795 SoC.
 	      "renesas,can-r8a7796" if CAN controller is a part of R8A7796 SoC.
+	      "renesas,can-r8a77965" if CAN controller is a part of R8A77965 SoC.
 	      "renesas,rcar-gen1-can" for a generic R-Car Gen1 compatible device.
 	      "renesas,rcar-gen2-can" for a generic R-Car Gen2 or RZ/G1
 	      compatible device.
@@ -28,9 +29,8 @@  Required properties:
 - pinctrl-0: pin control group to be used for this controller.
 - pinctrl-names: must be "default".
 
-Required properties for "renesas,can-r8a7795" and "renesas,can-r8a7796"
-compatible:
-In R8A7795 and R8A7796 SoCs, "clkp2" can be CANFD clock. This is a div6 clock
+Required properties for compatibles [A], [B] and [C]:
+For the denoted SoCs, "clkp2" can be CANFD clock. This is a div6 clock
 and can be used by both CAN and CAN FD controller at the same time. It needs to
 be scaled to maximum frequency if any of these controllers use it. This is done
 using the below properties:
@@ -38,6 +38,10 @@  using the below properties:
 - assigned-clocks: phandle of clkp2(CANFD) clock.
 - assigned-clock-rates: maximum frequency of this clock.
 
+[A] "renesas,can-r8a7795"
+[B] "renesas,can-r8a7796"
+[C] "renesas,can-r8a77965"
+
 Optional properties:
 - renesas,can-clock-select: R-Car CAN Clock Source Select. Valid values are:
 			    <0x0> (default) : Peripheral clock (clkp1)