Add bindings for CAST CAN Controller
Signed-off-by: William Qiu <[email protected]>
---
.../devicetree/bindings/net/can/cast,can.yaml | 95 +++++++++++++++++++
1 file changed, 95 insertions(+)
create mode 100644 Documentation/devicetree/bindings/net/can/cast,can.yaml
diff --git a/Documentation/devicetree/bindings/net/can/cast,can.yaml b/Documentation/devicetree/bindings/net/can/cast,can.yaml
new file mode 100644
index 000000000000..ea52132d9b1c
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/can/cast,can.yaml
@@ -0,0 +1,95 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/can/cast,can.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: CAST CAN controller
+
+maintainers:
+ - William Qiu <[email protected]>
+
+allOf:
+ - $ref: can-controller.yaml#
+ - if:
+ properties:
+ compatible:
+ contains:
+ const: starfive,can
+ then:
+ required:
+ - starfive,syscon
+
+properties:
+ compatible:
+ enum:
+ - cast,can
+ - cast,canfd
+ - starfive,can
+
+ reg:
+ maxItems: 1
+
+ interrupts:
+ maxItems: 1
+
+ clocks:
+ minItems: 3
+
+ clock-names:
+ items:
+ - const: apb_clk
+ - const: timer_clk
+ - const: can_clk
+
+ resets:
+ minItems: 3
+
+ reset-names:
+ items:
+ - const: rst_apb
+ - const: rst_core
+ - const: rst_timer
+
+ starfive,syscon:
+ $ref: /schemas/types.yaml#/definitions/phandle-array
+ items:
+ - items:
+ - description: phandle to System Register Controller syscon node
+ - description: offset of SYS_SYSCON_NE__SAIF__SYSCFG register for CAN controller
+ - description: shift of SYS_SYSCON_NE__SAIF__SYSCFG register for CAN controller
+ - description: mask of SYS_SYSCON_NE__SAIF__SYSCFG register for CAN controller
+ description:
+ Should be four parameters, the phandle to System Register Controller
+ syscon node and the offset/shift/mask of SYS_SYSCON_NE__SAIF__SYSCFG register
+ for CAN controller.
+
+required:
+ - compatible
+ - reg
+ - interrupts
+ - clocks
+ - clock-names
+ - resets
+ - reset-names
+
+additionalProperties: false
+
+examples:
+ - |
+ can@130d0000{
+ compatible = "starfive,can";
+ reg = <0x130d0000 0x1000>;
+ interrupts = <112>;
+ clocks = <&syscrg 115>,
+ <&syscrg 116>,
+ <&syscrg 117>;
+ clock-names = "apb_clk", "timer_clk", "can_clk";
+ resets = <&syscrg 111>,
+ <&syscrg 112>,
+ <&syscrg 113>;
+ reset-names = "rst_apb", "rst_core", "rst_timer";
+ starfive,syscon = <&sys_syscon 0x10 0x3 0x8>;
+ };
+
+...
--
2.34.1
Hey William,
On Mon, Jan 29, 2024 at 11:12:37AM +0800, William Qiu wrote:
> Add bindings for CAST CAN Controller
>
> Signed-off-by: William Qiu <[email protected]>
> ---
> .../devicetree/bindings/net/can/cast,can.yaml | 95 +++++++++++++++++++
> 1 file changed, 95 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/net/can/cast,can.yaml
>
> diff --git a/Documentation/devicetree/bindings/net/can/cast,can.yaml b/Documentation/devicetree/bindings/net/can/cast,can.yaml
> new file mode 100644
> index 000000000000..ea52132d9b1c
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/can/cast,can.yaml
> @@ -0,0 +1,95 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/can/cast,can.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: CAST CAN controller
> +
> +maintainers:
> + - William Qiu <[email protected]>
> +
> +allOf:
> + - $ref: can-controller.yaml#
> + - if:
> + properties:
> + compatible:
> + contains:
> + const: starfive,can
> + then:
> + required:
> + - starfive,syscon
If you've got property related stuff in the allOf, move it down after
the property definitions.
> +properties:
> + compatible:
> + enum:
> + - cast,can
> + - cast,canfd
I don't like these uber generic compatibles that have no users as a
fallback. Allowing them in the binding only really discourages people
from creating device specific compatibles.
Secondly, this is some purchased IP that I am sure has a versioning
scheme and the compatibles that you have created do not reflect that.
If they were being used as a fallback, I would request some versioning.
That's not going to really work though since the canfd features on the
jh7110 require setting u0_can_ctrl_can_fd_enable, so neither of these
compatibles really has a use right now.
> + - starfive,can
Just "starfive,can"? Can you please add device specific compatibles for
the SoCs on which this is used?
> +
> + reg:
> + maxItems: 1
> +
> + interrupts:
> + maxItems: 1
> +
> + clocks:
> + minItems: 3
> +
> + clock-names:
> + items:
> + - const: apb_clk
> + - const: timer_clk
> + - const: can_clk
Drop _clk, they're all clocks!
> +
> + resets:
> + minItems: 3
> +
> + reset-names:
> + items:
> + - const: rst_apb
> + - const: rst_core
> + - const: rst_timer
Same here, drop rst_
> +
> + starfive,syscon:
> + $ref: /schemas/types.yaml#/definitions/phandle-array
> + items:
> + - items:
> + - description: phandle to System Register Controller syscon node
> + - description: offset of SYS_SYSCON_NE__SAIF__SYSCFG register for CAN controller
The docs I have call this register "SYS_SYSCONSAIF__SYSCFG". Did the
names change since the TRM I have was written?
> + - description: shift of SYS_SYSCON_NE__SAIF__SYSCFG register for CAN controller
> + - description: mask of SYS_SYSCON_NE__SAIF__SYSCFG register for CAN controller
> + description:
> + Should be four parameters, the phandle to System Register Controller
> + syscon node and the offset/shift/mask of SYS_SYSCON_NE__SAIF__SYSCFG register
> + for CAN controller.
Cheers,
Conor.
> -----Original Message-----
> From: Conor Dooley <[email protected]>
> Sent: 2024??1??29?? 23:37
> To: William Qiu <[email protected]>
> Cc: [email protected]; [email protected];
> [email protected]; [email protected]; Emil Renner
> Berthing <[email protected]>; Rob Herring <[email protected]>; Wolfgang
> Grandegger <[email protected]>; Philipp Zabel <[email protected]>;
> Krzysztof Kozlowski <[email protected]>; Conor Dooley
> <[email protected]>; Marc Kleine-Budde <[email protected]>; David S .
> Miller <[email protected]>; Eric Dumazet <[email protected]>;
> Jakub Kicinski <[email protected]>; Paolo Abeni <[email protected]>; Paul
> Walmsley <[email protected]>; Palmer Dabbelt
> <[email protected]>; Albert Ou <[email protected]>
> Subject: Re: [PATCH v1 2/4] dt-bindings: can: Add bindings for CAST CAN
> Controller
>
> Hey William,
>
> On Mon, Jan 29, 2024 at 11:12:37AM +0800, William Qiu wrote:
> > Add bindings for CAST CAN Controller
> >
> > Signed-off-by: William Qiu <[email protected]>
> > ---
> > .../devicetree/bindings/net/can/cast,can.yaml | 95
> > +++++++++++++++++++
> > 1 file changed, 95 insertions(+)
> > create mode 100644
> > Documentation/devicetree/bindings/net/can/cast,can.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/net/can/cast,can.yaml
> > b/Documentation/devicetree/bindings/net/can/cast,can.yaml
> > new file mode 100644
> > index 000000000000..ea52132d9b1c
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/net/can/cast,can.yaml
> > @@ -0,0 +1,95 @@
> > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause %YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/net/can/cast,can.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: CAST CAN controller
> > +
> > +maintainers:
> > + - William Qiu <[email protected]>
> > +
> > +allOf:
> > + - $ref: can-controller.yaml#
> > + - if:
> > + properties:
> > + compatible:
> > + contains:
> > + const: starfive,can
> > + then:
> > + required:
> > + - starfive,syscon
>
> If you've got property related stuff in the allOf, move it down after the property
> definitions.
>
Will update
> > +properties:
> > + compatible:
> > + enum:
> > + - cast,can
> > + - cast,canfd
>
> I don't like these uber generic compatibles that have no users as a fallback.
> Allowing them in the binding only really discourages people from creating device
> specific compatibles.
> Secondly, this is some purchased IP that I am sure has a versioning scheme and
> the compatibles that you have created do not reflect that.
> If they were being used as a fallback, I would request some versioning.
> That's not going to really work though since the canfd features on the
> jh7110 require setting u0_can_ctrl_can_fd_enable, so neither of these
> compatibles really has a use right now.
>
I'll add some tag to do versioning.
> > + - starfive,can
>
> Just "starfive,can"? Can you please add device specific compatibles for the SoCs
> on which this is used?
>
Will add.
> > +
> > + reg:
> > + maxItems: 1
> > +
> > + interrupts:
> > + maxItems: 1
> > +
> > + clocks:
> > + minItems: 3
> > +
> > + clock-names:
> > + items:
> > + - const: apb_clk
> > + - const: timer_clk
> > + - const: can_clk
>
> Drop _clk, they're all clocks!
>
Will drop.
> > +
> > + resets:
> > + minItems: 3
> > +
> > + reset-names:
> > + items:
> > + - const: rst_apb
> > + - const: rst_core
> > + - const: rst_timer
>
> Same here, drop rst_
>Will drop.
> > +
> > + starfive,syscon:
> > + $ref: /schemas/types.yaml#/definitions/phandle-array
> > + items:
> > + - items:
> > + - description: phandle to System Register Controller syscon node
> > + - description: offset of SYS_SYSCON_NE__SAIF__SYSCFG
> > + register for CAN controller
>
> The docs I have call this register "SYS_SYSCONSAIF__SYSCFG". Did the names
> change since the TRM I have was written?
>
They do change on the 8100 SoC.
Other descriptions may be needed for compatibility. I'll think about it.
Thanks,
William
> > + - description: shift of SYS_SYSCON_NE__SAIF__SYSCFG register
> for CAN controller
> > + - description: mask of SYS_SYSCON_NE__SAIF__SYSCFG register
> for CAN controller
> > + description:
> > + Should be four parameters, the phandle to System Register Controller
> > + syscon node and the offset/shift/mask of
> SYS_SYSCON_NE__SAIF__SYSCFG register
> > + for CAN controller.
>
> Cheers,
> Conor.
On Tue, Jan 30, 2024 at 06:30:54AM +0000, William Qiu wrote:
> > From: Conor Dooley <[email protected]>
> > On Mon, Jan 29, 2024 at 11:12:37AM +0800, William Qiu wrote:
> > > +properties:
> > > + compatible:
> > > + enum:
> > > + - cast,can
> > > + - cast,canfd
> >
> > I don't like these uber generic compatibles that have no users as a fallback.
> > Allowing them in the binding only really discourages people from creating device
> > specific compatibles.
> > Secondly, this is some purchased IP that I am sure has a versioning scheme and
> > the compatibles that you have created do not reflect that.
> > If they were being used as a fallback, I would request some versioning.
> > That's not going to really work though since the canfd features on the
> > jh7110 require setting u0_can_ctrl_can_fd_enable, so neither of these
> > compatibles really has a use right now.
> >
> I'll add some tag to do versioning.
I don't want to see a "cast,can-<something>" compatible allowed in
isolation either as there is no user for it.
The generic compatibles like that should only be permitted in
combination with a device specific one - particularly since there are
bits in implementation defined registers that control whether or not
canfd is enabled.