diff mbox series

[1/2] dt-bindings: can: rcar_canfd: document r8a77965 support

Message ID 20181118173201.4645-1-marek.vasut+renesas@gmail.com (mailing list archive)
State Superseded
Delegated to: Geert Uytterhoeven
Headers show
Series [1/2] dt-bindings: can: rcar_canfd: document r8a77965 support | expand

Commit Message

Marek Vasut Nov. 18, 2018, 5:32 p.m. UTC
Document the support for rcar_canfd on R8A77965 SoC devices.

Signed-off-by: Marek Vasut <marek.vasut+renesas@gmail.com>
Cc: Eugeniu Rosca <erosca@de.adit-jv.com>
Cc: Geert Uytterhoeven <geert+renesas@glider.be>
Cc: Marc Kleine-Budde <mkl@pengutronix.de>
Cc: Rob Herring <robh@kernel.org>
Cc: Simon Horman <horms+renesas@verge.net.au>
Cc: Wolfram Sang <wsa+renesas@sang-engineering.com>
Cc: linux-renesas-soc@vger.kernel.org
---
 .../devicetree/bindings/net/can/rcar_canfd.txt      | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

Comments

Wolfram Sang Nov. 18, 2018, 11:18 p.m. UTC | #1
> +  - "renesas,r8a77965-canfd" for R8A77965 (R-Car M3-N) compatible controller.

Eeeks, the 'canfd' is a suffix here not a prefix :( Not your issue,
of course. But Simon, shall we fix that for all CANFD?

> -Required properties for "renesas,r8a7795-canfd" and "renesas,r8a7796-canfd"
> -compatible:
> -In R8A7795 and R8A7796 SoCs, canfd clock 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:
> +Required properties for "renesas,r8a7795-canfd", "renesas,r8a7796-canfd" and
> +"renesas,r8a77965-canfd" compatible:
> +In R8A7795, R8A7796 and R8A77965 SoCs, canfd clock 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:

I think updating this paragraph does not scale. Maybe we should reformat
it the way as for plain CAN, so only in the header the new SoC gets
added? We can fix this incrementally, though, doesn't need to be
addressed within this patch.
Marek Vasut Nov. 18, 2018, 11:21 p.m. UTC | #2
On 11/19/2018 12:18 AM, Wolfram Sang wrote:
> 
>> +  - "renesas,r8a77965-canfd" for R8A77965 (R-Car M3-N) compatible controller.
> 
> Eeeks, the 'canfd' is a suffix here not a prefix :( Not your issue,
> of course. But Simon, shall we fix that for all CANFD?
> 
>> -Required properties for "renesas,r8a7795-canfd" and "renesas,r8a7796-canfd"
>> -compatible:
>> -In R8A7795 and R8A7796 SoCs, canfd clock 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:
>> +Required properties for "renesas,r8a7795-canfd", "renesas,r8a7796-canfd" and
>> +"renesas,r8a77965-canfd" compatible:
>> +In R8A7795, R8A7796 and R8A77965 SoCs, canfd clock 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:
> 
> I think updating this paragraph does not scale. Maybe we should reformat
> it the way as for plain CAN, so only in the header the new SoC gets
> added? We can fix this incrementally, though, doesn't need to be
> addressed within this patch.

Sure, although I don't expect it to grow much more than this.
Geert Uytterhoeven Nov. 19, 2018, 8:43 a.m. UTC | #3
Hi Wolfram,

On Mon, Nov 19, 2018 at 12:18 AM Wolfram Sang <wsa@the-dreams.de> wrote:
> > +  - "renesas,r8a77965-canfd" for R8A77965 (R-Car M3-N) compatible controller.
>
> Eeeks, the 'canfd' is a suffix here not a prefix :( Not your issue,
> of course. But Simon, shall we fix that for all CANFD?

Unfortunately we cannot, due to backwards compatibility.
Hence we keep following existing compatible value conventions for existing
bindings, but follow the recommended way for new devices/bindings.

Gr{oetje,eeting}s,

                        Geert
Geert Uytterhoeven Nov. 19, 2018, 9:40 a.m. UTC | #4
Hi Wolfram,

On Mon, Nov 19, 2018 at 9:43 AM Geert Uytterhoeven <geert@linux-m68k.org> wrote:
> On Mon, Nov 19, 2018 at 12:18 AM Wolfram Sang <wsa@the-dreams.de> wrote:
> > > +  - "renesas,r8a77965-canfd" for R8A77965 (R-Car M3-N) compatible controller.
> >
> > Eeeks, the 'canfd' is a suffix here not a prefix :( Not your issue,
> > of course. But Simon, shall we fix that for all CANFD?
>
> Unfortunately we cannot, due to backwards compatibility.
> Hence we keep following existing compatible value conventions for existing
> bindings, but follow the recommended way for new devices/bindings.

So that's what I wrote _before_ my mornin' coffee...

"renesas,r8a77965-canfd" _is_ using the recommended order.
"renesas,can-r8a77965" is not.

But my main argument is still valid, of course.

Gr{oetje,eeting}s,

                        Geert
Simon Horman Nov. 19, 2018, 10:41 a.m. UTC | #5
On Mon, Nov 19, 2018 at 12:18:07AM +0100, Wolfram Sang wrote:
> 
> > +  - "renesas,r8a77965-canfd" for R8A77965 (R-Car M3-N) compatible controller.
> 
> Eeeks, the 'canfd' is a suffix here not a prefix :( Not your issue,
> of course. But Simon, shall we fix that for all CANFD?

I think its too late to fix it for existing bindings.
We could move to a new scheme for r8a77965 and beyond,
but that is rather messy. I lean to wards continuing with
using 'canfd' as a suffix.

> 
> > -Required properties for "renesas,r8a7795-canfd" and "renesas,r8a7796-canfd"
> > -compatible:
> > -In R8A7795 and R8A7796 SoCs, canfd clock 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:
> > +Required properties for "renesas,r8a7795-canfd", "renesas,r8a7796-canfd" and
> > +"renesas,r8a77965-canfd" compatible:
> > +In R8A7795, R8A7796 and R8A77965 SoCs, canfd clock 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:
> 
> I think updating this paragraph does not scale. Maybe we should reformat
> it the way as for plain CAN, so only in the header the new SoC gets
> added? We can fix this incrementally, though, doesn't need to be
> addressed within this patch.
>
Wolfram Sang Nov. 19, 2018, 10:53 a.m. UTC | #6
On Mon, Nov 19, 2018 at 11:41:39AM +0100, Simon Horman wrote:
> On Mon, Nov 19, 2018 at 12:18:07AM +0100, Wolfram Sang wrote:
> > 
> > > +  - "renesas,r8a77965-canfd" for R8A77965 (R-Car M3-N) compatible controller.
> > 
> > Eeeks, the 'canfd' is a suffix here not a prefix :( Not your issue,
> > of course. But Simon, shall we fix that for all CANFD?
> 
> I think its too late to fix it for existing bindings.
> We could move to a new scheme for r8a77965 and beyond,
> but that is rather messy. I lean to wards continuing with
> using 'canfd' as a suffix.

Geert, Simon: OK, thanks for the answers.
Simon Horman Nov. 21, 2018, 10:20 a.m. UTC | #7
On Mon, Nov 19, 2018 at 11:53:58AM +0100, Wolfram Sang wrote:
> On Mon, Nov 19, 2018 at 11:41:39AM +0100, Simon Horman wrote:
> > On Mon, Nov 19, 2018 at 12:18:07AM +0100, Wolfram Sang wrote:
> > > 
> > > > +  - "renesas,r8a77965-canfd" for R8A77965 (R-Car M3-N) compatible controller.
> > > 
> > > Eeeks, the 'canfd' is a suffix here not a prefix :( Not your issue,
> > > of course. But Simon, shall we fix that for all CANFD?
> > 
> > I think its too late to fix it for existing bindings.
> > We could move to a new scheme for r8a77965 and beyond,
> > but that is rather messy. I lean to wards continuing with
> > using 'canfd' as a suffix.
> 
> Geert, Simon: OK, thanks for the answers.

I think this is good to go as-is.

Reviewed-by: Simon Horman <horms+renesas@verge.net.au>
Rob Herring (Arm) Dec. 4, 2018, 10:56 p.m. UTC | #8
On Sun, Nov 18, 2018 at 06:32:00PM +0100, Marek Vasut wrote:
> Document the support for rcar_canfd on R8A77965 SoC devices.
> 
> Signed-off-by: Marek Vasut <marek.vasut+renesas@gmail.com>
> Cc: Eugeniu Rosca <erosca@de.adit-jv.com>
> Cc: Geert Uytterhoeven <geert+renesas@glider.be>
> Cc: Marc Kleine-Budde <mkl@pengutronix.de>
> Cc: Rob Herring <robh@kernel.org>
> Cc: Simon Horman <horms+renesas@verge.net.au>
> Cc: Wolfram Sang <wsa+renesas@sang-engineering.com>
> Cc: linux-renesas-soc@vger.kernel.org
> ---
>  .../devicetree/bindings/net/can/rcar_canfd.txt      | 13 +++++++------
>  1 file changed, 7 insertions(+), 6 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/net/can/rcar_canfd.txt b/Documentation/devicetree/bindings/net/can/rcar_canfd.txt
> index ac71daa46195..4720e916fbdd 100644
> --- a/Documentation/devicetree/bindings/net/can/rcar_canfd.txt
> +++ b/Documentation/devicetree/bindings/net/can/rcar_canfd.txt
> @@ -6,6 +6,7 @@ Required properties:
>    - "renesas,rcar-gen3-canfd" for R-Car Gen3 compatible controller.
>    - "renesas,r8a7795-canfd" for R8A7795 (R-Car H3) compatible controller.
>    - "renesas,r8a7796-canfd" for R8A7796 (R-Car M3-W) compatible controller.
> +  - "renesas,r8a77965-canfd" for R8A77965 (R-Car M3-N) compatible controller.
>    - "renesas,r8a77970-canfd" for R8A77970 (R-Car V3M) compatible controller.
>    - "renesas,r8a77980-canfd" for R8A77980 (R-Car V3H) compatible controller.
>  
> @@ -26,12 +27,12 @@ The name of the child nodes are "channel0" and "channel1" respectively. Each
>  child node supports the "status" property only, which is used to
>  enable/disable the respective channel.
>  
> -Required properties for "renesas,r8a7795-canfd" and "renesas,r8a7796-canfd"
> -compatible:
> -In R8A7795 and R8A7796 SoCs, canfd clock 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:
> +Required properties for "renesas,r8a7795-canfd", "renesas,r8a7796-canfd" and
> +"renesas,r8a77965-canfd" compatible:
> +In R8A7795, R8A7796 and R8A77965 SoCs, canfd clock is a div6 clock and can

Do we have to list the SoCs twice so that the paragraph has to be 
reformatted every time? Just the compatibles above should be enough.

> +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:
>  
>  - assigned-clocks: phandle of canfd clock.
>  - assigned-clock-rates: maximum frequency of this clock.
> -- 
> 2.18.0
>
Marek Vasut Dec. 4, 2018, 11:44 p.m. UTC | #9
On 12/04/2018 11:56 PM, Rob Herring wrote:
> On Sun, Nov 18, 2018 at 06:32:00PM +0100, Marek Vasut wrote:
>> Document the support for rcar_canfd on R8A77965 SoC devices.
>>
>> Signed-off-by: Marek Vasut <marek.vasut+renesas@gmail.com>
>> Cc: Eugeniu Rosca <erosca@de.adit-jv.com>
>> Cc: Geert Uytterhoeven <geert+renesas@glider.be>
>> Cc: Marc Kleine-Budde <mkl@pengutronix.de>
>> Cc: Rob Herring <robh@kernel.org>
>> Cc: Simon Horman <horms+renesas@verge.net.au>
>> Cc: Wolfram Sang <wsa+renesas@sang-engineering.com>
>> Cc: linux-renesas-soc@vger.kernel.org
>> ---
>>  .../devicetree/bindings/net/can/rcar_canfd.txt      | 13 +++++++------
>>  1 file changed, 7 insertions(+), 6 deletions(-)
>>
>> diff --git a/Documentation/devicetree/bindings/net/can/rcar_canfd.txt b/Documentation/devicetree/bindings/net/can/rcar_canfd.txt
>> index ac71daa46195..4720e916fbdd 100644
>> --- a/Documentation/devicetree/bindings/net/can/rcar_canfd.txt
>> +++ b/Documentation/devicetree/bindings/net/can/rcar_canfd.txt
>> @@ -6,6 +6,7 @@ Required properties:
>>    - "renesas,rcar-gen3-canfd" for R-Car Gen3 compatible controller.
>>    - "renesas,r8a7795-canfd" for R8A7795 (R-Car H3) compatible controller.
>>    - "renesas,r8a7796-canfd" for R8A7796 (R-Car M3-W) compatible controller.
>> +  - "renesas,r8a77965-canfd" for R8A77965 (R-Car M3-N) compatible controller.
>>    - "renesas,r8a77970-canfd" for R8A77970 (R-Car V3M) compatible controller.
>>    - "renesas,r8a77980-canfd" for R8A77980 (R-Car V3H) compatible controller.
>>  
>> @@ -26,12 +27,12 @@ The name of the child nodes are "channel0" and "channel1" respectively. Each
>>  child node supports the "status" property only, which is used to
>>  enable/disable the respective channel.
>>  
>> -Required properties for "renesas,r8a7795-canfd" and "renesas,r8a7796-canfd"
>> -compatible:
>> -In R8A7795 and R8A7796 SoCs, canfd clock 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:
>> +Required properties for "renesas,r8a7795-canfd", "renesas,r8a7796-canfd" and
>> +"renesas,r8a77965-canfd" compatible:
>> +In R8A7795, R8A7796 and R8A77965 SoCs, canfd clock is a div6 clock and can
> 
> Do we have to list the SoCs twice so that the paragraph has to be 
> reformatted every time? Just the compatibles above should be enough.

We don't , but that's about it for the SoCs that need this.

>> +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:
>>  
>>  - assigned-clocks: phandle of canfd clock.
>>  - assigned-clock-rates: maximum frequency of this clock.
>> -- 
>> 2.18.0
>>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/net/can/rcar_canfd.txt b/Documentation/devicetree/bindings/net/can/rcar_canfd.txt
index ac71daa46195..4720e916fbdd 100644
--- a/Documentation/devicetree/bindings/net/can/rcar_canfd.txt
+++ b/Documentation/devicetree/bindings/net/can/rcar_canfd.txt
@@ -6,6 +6,7 @@  Required properties:
   - "renesas,rcar-gen3-canfd" for R-Car Gen3 compatible controller.
   - "renesas,r8a7795-canfd" for R8A7795 (R-Car H3) compatible controller.
   - "renesas,r8a7796-canfd" for R8A7796 (R-Car M3-W) compatible controller.
+  - "renesas,r8a77965-canfd" for R8A77965 (R-Car M3-N) compatible controller.
   - "renesas,r8a77970-canfd" for R8A77970 (R-Car V3M) compatible controller.
   - "renesas,r8a77980-canfd" for R8A77980 (R-Car V3H) compatible controller.
 
@@ -26,12 +27,12 @@  The name of the child nodes are "channel0" and "channel1" respectively. Each
 child node supports the "status" property only, which is used to
 enable/disable the respective channel.
 
-Required properties for "renesas,r8a7795-canfd" and "renesas,r8a7796-canfd"
-compatible:
-In R8A7795 and R8A7796 SoCs, canfd clock 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:
+Required properties for "renesas,r8a7795-canfd", "renesas,r8a7796-canfd" and
+"renesas,r8a77965-canfd" compatible:
+In R8A7795, R8A7796 and R8A77965 SoCs, canfd clock 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:
 
 - assigned-clocks: phandle of canfd clock.
 - assigned-clock-rates: maximum frequency of this clock.