Skip to contentSkip to conversation

dt-bindings: net: can: c_can: convert to json-schema

PATCH In review Dario Binacchi 3 participants 5 messages Aug 5, 2021 – Aug 16, 2021

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

PATCH v5 1/1 dt-bindings: net: can: c_can: convert to json-schema

Convert the Bosch C_CAN/D_CAN controller device tree binding documentation to json-schema.

Document missing properties.
Remove "ti,hwmods" as it is no longer used in TI dts. Make "clocks" required as it is used in all dts. Update the examples.

---

Changes in v5:
- Complete 'interrupts' property description

Changes in v4:
- Fix 'syscon-raminit' property to pass checks.
- Drop 'status' property from CAN node of examples.
- Replace CAN node of examples (compatible = "bosch,d_can") with a recent version taken from socfpga.dtsi dts.
- Update the 'interrupts' property due to the examples updating.
- Add 'resets' property due to the examples updating.

Changes in v3:
- Add type (phandle-array) and size (maxItems: 2) to syscon-raminit property.

Changes in v2:
- Drop Documentation references.

 .../bindings/net/can/bosch,c_can.yaml         | 119 ++++++++++++++++++
 .../devicetree/bindings/net/can/c_can.txt     |  65 ----------
 2 files changed, 119 insertions(+), 65 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/net/can/bosch,c_can.yaml
 delete mode 100644 Documentation/devicetree/bindings/net/can/c_can.txt
Documentation/devicetree/bindings/net/can/bosch,c_can.yaml new file +119 -0
new file mode 100644
index 000000000000..2cd145a642f1
@@ -0,0 +1,119 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/can/bosch,c_can.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Bosch C_CAN/D_CAN controller Device Tree Bindings
+
+description: Bosch C_CAN/D_CAN controller for CAN bus
+
+maintainers:
+  - Dario Binacchi <[email protected]>
+
+allOf:
+  - $ref: can-controller.yaml#
+
+properties:
+  compatible:
+    oneOf:
+      - enum:
+          - bosch,c_can
+          - bosch,d_can
+          - ti,dra7-d_can
+          - ti,am3352-d_can
+      - items:
+          - enum:
+              - ti,am4372-d_can
+          - const: ti,am3352-d_can
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    minItems: 1
+    maxItems: 4
+
+  power-domains:
+    description: |
+      Should contain a phandle to a PM domain provider node and an args
+      specifier containing the DCAN device id value. It's mandatory for
+      Keystone 2 66AK2G SoCs only.
+    maxItems: 1
+
+  clocks:
+    description: |
+      CAN functional clock phandle.
+    maxItems: 1
+
+  clock-names:
+    maxItems: 1
+
+  syscon-raminit:
+    description: |
+      Handle to system control region that contains the RAMINIT register,
+      register offset to the RAMINIT register and the CAN instance number (0
+      offset).
+    $ref: /schemas/types.yaml#/definitions/phandle-array
+    items:
+      items:
+        - description: The phandle to the system control region.
+        - description: The register offset.
+        - description: The CAN instance number.
+
+  resets:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+
+if:
+  properties:
+    compatible:
+      contains:
+        enum:
+          - bosch,d_can
+
+then:
+  properties:
+    interrupts:
+      minItems: 4
+      maxItems: 4
+      items:
+        - description: Error and status IRQ
+        - description: Message object IRQ
+        - description: RAM ECC correctable error IRQ
+        - description: RAM ECC non-correctable error IRQ
+
+else:
+  properties:
+    interrupts:
+      maxItems: 1
+      items:
+        - description: Error and status IRQ
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/reset/altr,rst-mgr.h>
+
+    can@ffc00000 {
+       compatible = "bosch,d_can";
+       reg = <0xffc00000 0x1000>;
+       interrupts = <0 131 4>, <0 132 4>, <0 133 4>, <0 134 4>;
+       clocks = <&can0_clk>;
+       resets = <&rst CAN0_RESET>;
+    };
+  - |
+    can@0 {
+        compatible = "ti,am3352-d_can";
+        reg = <0x0 0x2000>;
+        clocks = <&dcan1_fck>;
+        clock-names = "fck";
+        syscon-raminit = <&scm_conf 0x644 1>;
+        interrupts = <55>;
+    };
Documentation/devicetree/bindings/net/can/c_can.txt deleted +0 -65

65 lines not on this page · raw message

Signature · 1 line
2.17.1
#1 lore raw
Quoted 9 lines · Dario Binacchi

Convert the Bosch C_CAN/D_CAN controller device tree binding documentation to json-schema.

Document missing properties.
Remove "ti,hwmods" as it is no longer used in TI dts. Make "clocks" required as it is used in all dts. Update the examples.

[...]

Documentation/devicetree/bindings/net/can/bosch,c_can.yaml line 84

Quoted 12 lines
Documentation/devicetree/bindings/net/can/bosch,c_can.yaml new file +12 -0
+if:
+  properties:
+    compatible:
+      contains:
+        enum:
+          - bosch,d_can
+
+then:
+  properties:
+    interrupts:
+      minItems: 4
+      maxItems: 4

The driver uses only 1 interrupt, on the other hand the only in-tree user the bosch,d_can compatible specifies 4 interrupts.

Marc

Signature · 4 lines
Pengutronix e.K.                 | Marc Kleine-Budde           |
Embedded Linux                   | https://www.pengutronix.de  |
Vertretung West/Dortmund         | Phone: +49-231-2826-924     |
Amtsgericht Hildesheim, HRA 2686 | Fax:   +49-5121-206917-5555 |
maintainer
#2 lore raw
Quoted 13 lines · Marc Kleine-Budde
Quoted 9 lines · Dario Binacchi

Convert the Bosch C_CAN/D_CAN controller device tree binding documentation to json-schema.

Document missing properties.
Remove "ti,hwmods" as it is no longer used in TI dts. Make "clocks" required as it is used in all dts. Update the examples.

[...]

Quoted 15 lines

Documentation/devicetree/bindings/net/can/bosch,c_can.yaml line 84

Quoted 12 lines
Documentation/devicetree/bindings/net/can/bosch,c_can.yaml new file +12 -0
+if:
+  properties:
+    compatible:
+      contains:
+        enum:
+          - bosch,d_can
+
+then:
+  properties:
+    interrupts:
+      minItems: 4
+      maxItems: 4

The driver uses only 1 interrupt, on the other hand the only in-tree user the bosch,d_can compatible specifies 4 interrupts.

The DT should reflect all the interrupts. It can't know what some OS or some version of OS actually uses.

Rob

maintainer Reviewed-by on v5 1/1
#3 lore raw
In reply to Dario Binacchi
Quoted 27 lines · Dario Binacchi

Convert the Bosch C_CAN/D_CAN controller device tree binding documentation to json-schema.

Document missing properties.
Remove "ti,hwmods" as it is no longer used in TI dts. Make "clocks" required as it is used in all dts. Update the examples.

---

Changes in v5:
- Complete 'interrupts' property description

Changes in v4:
- Fix 'syscon-raminit' property to pass checks.
- Drop 'status' property from CAN node of examples.
- Replace CAN node of examples (compatible = "bosch,d_can") with a recent version taken from socfpga.dtsi dts.
- Update the 'interrupts' property due to the examples updating.
- Add 'resets' property due to the examples updating.

Changes in v3:
- Add type (phandle-array) and size (maxItems: 2) to syscon-raminit property.

Quoted 9 lines

Changes in v2:
- Drop Documentation references.

 .../bindings/net/can/bosch,c_can.yaml         | 119 ++++++++++++++++++
 .../devicetree/bindings/net/can/c_can.txt     |  65 ----------
 2 files changed, 119 insertions(+), 65 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/net/can/bosch,c_can.yaml
 delete mode 100644 Documentation/devicetree/bindings/net/can/c_can.txt
#4 lore raw
In reply to Dario Binacchi
Quoted 9 lines · Dario Binacchi

Convert the Bosch C_CAN/D_CAN controller device tree binding documentation to json-schema.

Document missing properties.
Remove "ti,hwmods" as it is no longer used in TI dts. Make "clocks" required as it is used in all dts. Update the examples.

Applied to linux-can-next/testing.

Thanks,
Marc

Signature · 4 lines
Pengutronix e.K.                 | Marc Kleine-Budde           |
Embedded Linux                   | https://www.pengutronix.de  |
Vertretung West/Dortmund         | Phone: +49-231-2826-924     |
Amtsgericht Hildesheim, HRA 2686 | Fax:   +49-5121-206917-5555 |