Add documentation for the rockchip rk3576 CAN-FD controller.

Signed-off-by: Elaine Zhang <zhangqing@rock-chips.com>
---
 .../net/can/rockchip,rk3576-canfd.yaml        | 82 +++++++++++++++++++
 1 file changed, 82 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/net/can/rockchip,rk3576-canfd.yaml

diff --git a/Documentation/devicetree/bindings/net/can/rockchip,rk3576-canfd.yaml b/Documentation/devicetree/bindings/net/can/rockchip,rk3576-canfd.yaml
new file mode 100644
index 000000000000..85caf6d19607
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/can/rockchip,rk3576-canfd.yaml
@@ -0,0 +1,82 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/can/rockchip,rk3568v2-canfd.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title:
+  Rk3576 CAN-FD controller
+
+maintainers:
+  - Elaine Zhang <zhangqing@rock-chips.com>
+
+allOf:
+  - $ref: can-controller.yaml#
+
+properties:
+  compatible:
+    oneOf:
+      - const: rockchip,rk3576-canfd
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    maxItems: 2
+
+  clock-names:
+    items:
+      - const: baud
+      - const: pclk
+
+  resets:
+    maxItems: 2
+
+  reset-names:
+    items:
+      - const: core
+      - const: apb
+
+  dmas:
+    maxItems: 1
+
+  dma-names:
+    items:
+      - const: rx
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+  - resets
+  - dmas
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/rockchip,rk3576-cru.h>
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    #include <dt-bindings/interrupt-controller/irq.h>
+
+    soc {
+        #address-cells = <2>;
+        #size-cells = <2>;
+
+        can0: can@2ac00000 {
+            compatible = "rockchip,rk3576-canfd";
+	    reg = <0x0 0x2ac00000 0x0 0x1000>;
+	    interrupts = <GIC_SPI 121 IRQ_TYPE_LEVEL_HIGH>;
+	    clocks = <&cru CLK_CAN0>, <&cru HCLK_CAN0>;
+	    clock-names = "baud", "pclk";
+	    resets = <&cru SRST_CAN0>, <&cru SRST_H_CAN0>;
+	    reset-names = "can", "can-apb";
+	    dmas = <&dmac0 20>;
+	    dma-names = "rx";
+	    status = "disabled";
+	};
+    };
-- 
2.34.1

On 22/05/2025 08:32, Elaine Zhang wrote:
> Add documentation for the rockchip rk3576 CAN-FD controller.
> 
> Signed-off-by: Elaine Zhang <zhangqing@rock-chips.com>
> ---
>  .../net/can/rockchip,rk3576-canfd.yaml        | 82 +++++++++++++++++++
>  1 file changed, 82 insertions(+)

There is no cover letter (maybe something got lost on the lists?), no
changelog. What was happening with this patch?


>  create mode 100644 Documentation/devicetree/bindings/net/can/rockchip,rk3576-canfd.yaml
> 
> diff --git a/Documentation/devicetree/bindings/net/can/rockchip,rk3576-canfd.yaml b/Documentation/devicetree/bindings/net/can/rockchip,rk3576-canfd.yaml
> new file mode 100644
> index 000000000000..85caf6d19607
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/can/rockchip,rk3576-canfd.yaml
> @@ -0,0 +1,82 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/can/rockchip,rk3568v2-canfd.yaml#

Never tested, so just quick glance, not review.

> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title:


That's never a line break. Open existing files and look how it is done
there.


> +  Rk3576 CAN-FD controller


...


> +
> +        can0: can@2ac00000 {

Drop label

> +            compatible = "rockchip,rk3576-canfd";

Messed indentation

> +	    reg = <0x0 0x2ac00000 0x0 0x1000>;
> +	    interrupts = <GIC_SPI 121 IRQ_TYPE_LEVEL_HIGH>;
> +	    clocks = <&cru CLK_CAN0>, <&cru HCLK_CAN0>;
> +	    clock-names = "baud", "pclk";
> +	    resets = <&cru SRST_CAN0>, <&cru SRST_H_CAN0>;
> +	    reset-names = "can", "can-apb";
> +	    dmas = <&dmac0 20>;
> +	    dma-names = "rx";
> +	    status = "disabled";

No, it cannot be disabled. Drop. Look at other bindings or example-schema.

> +	};
> +    };


Best regards,
Krzysztof