tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
dt-bindings: can: rcar_can: Convert to json-schema
Convert the Renesas R-Car CAN Controller Device Tree binding
documentation to json-schema.
Document missing properties.
Update the example to match reality.
Link: https://lore.kernel.org/r/561c35648e22a3c1e3b5477ae27fd1a50da7fe98.1620323639.git.geert+renesas@glider.be
Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
Reviewed-by: Ulrich Hecht <uli+renesas@fpond.eu>
Signed-off-by: Marc Kleine-Budde <mkl@pengutronix.de>
authored by
Geert Uytterhoeven
and committed by
Marc Kleine-Budde
75a78026
59c56342
+139
-80
-80
Documentation/devicetree/bindings/net/can/rcar_can.txt
-80
Documentation/devicetree/bindings/net/can/rcar_can.txt
···
1
-
Renesas R-Car CAN controller Device Tree Bindings
2
-
-------------------------------------------------
3
-
4
-
Required properties:
5
-
- compatible: "renesas,can-r8a7742" if CAN controller is a part of R8A7742 SoC.
6
-
"renesas,can-r8a7743" if CAN controller is a part of R8A7743 SoC.
7
-
"renesas,can-r8a7744" if CAN controller is a part of R8A7744 SoC.
8
-
"renesas,can-r8a7745" if CAN controller is a part of R8A7745 SoC.
9
-
"renesas,can-r8a77470" if CAN controller is a part of R8A77470 SoC.
10
-
"renesas,can-r8a774a1" if CAN controller is a part of R8A774A1 SoC.
11
-
"renesas,can-r8a774b1" if CAN controller is a part of R8A774B1 SoC.
12
-
"renesas,can-r8a774c0" if CAN controller is a part of R8A774C0 SoC.
13
-
"renesas,can-r8a774e1" if CAN controller is a part of R8A774E1 SoC.
14
-
"renesas,can-r8a7778" if CAN controller is a part of R8A7778 SoC.
15
-
"renesas,can-r8a7779" if CAN controller is a part of R8A7779 SoC.
16
-
"renesas,can-r8a7790" if CAN controller is a part of R8A7790 SoC.
17
-
"renesas,can-r8a7791" if CAN controller is a part of R8A7791 SoC.
18
-
"renesas,can-r8a7792" if CAN controller is a part of R8A7792 SoC.
19
-
"renesas,can-r8a7793" if CAN controller is a part of R8A7793 SoC.
20
-
"renesas,can-r8a7794" if CAN controller is a part of R8A7794 SoC.
21
-
"renesas,can-r8a7795" if CAN controller is a part of R8A7795 SoC.
22
-
"renesas,can-r8a7796" if CAN controller is a part of R8A77960 SoC.
23
-
"renesas,can-r8a77961" if CAN controller is a part of R8A77961 SoC.
24
-
"renesas,can-r8a77965" if CAN controller is a part of R8A77965 SoC.
25
-
"renesas,can-r8a77990" if CAN controller is a part of R8A77990 SoC.
26
-
"renesas,can-r8a77995" if CAN controller is a part of R8A77995 SoC.
27
-
"renesas,rcar-gen1-can" for a generic R-Car Gen1 compatible device.
28
-
"renesas,rcar-gen2-can" for a generic R-Car Gen2 or RZ/G1
29
-
compatible device.
30
-
"renesas,rcar-gen3-can" for a generic R-Car Gen3 or RZ/G2
31
-
compatible device.
32
-
When compatible with the generic version, nodes must list the
33
-
SoC-specific version corresponding to the platform first
34
-
followed by the generic version.
35
-
36
-
- reg: physical base address and size of the R-Car CAN register map.
37
-
- interrupts: interrupt specifier for the sole interrupt.
38
-
- clocks: phandles and clock specifiers for 3 CAN clock inputs.
39
-
- clock-names: 3 clock input name strings: "clkp1", "clkp2", and "can_clk".
40
-
- pinctrl-0: pin control group to be used for this controller.
41
-
- pinctrl-names: must be "default".
42
-
43
-
Required properties for R8A774A1, R8A774B1, R8A774C0, R8A774E1, R8A7795,
44
-
R8A77960, R8A77961, R8A77965, R8A77990, and R8A77995:
45
-
For the denoted SoCs, "clkp2" can be CANFD clock. This is a div6 clock and can
46
-
be used by both CAN and CAN FD controller at the same time. It needs to be
47
-
scaled to maximum frequency if any of these controllers use it. This is done
48
-
using the below properties:
49
-
50
-
- assigned-clocks: phandle of clkp2(CANFD) clock.
51
-
- assigned-clock-rates: maximum frequency of this clock.
52
-
53
-
Optional properties:
54
-
- renesas,can-clock-select: R-Car CAN Clock Source Select. Valid values are:
55
-
<0x0> (default) : Peripheral clock (clkp1)
56
-
<0x1> : Peripheral clock (clkp2)
57
-
<0x3> : External input clock
58
-
59
-
Example
60
-
-------
61
-
62
-
SoC common .dtsi file:
63
-
64
-
can0: can@e6e80000 {
65
-
compatible = "renesas,can-r8a7791", "renesas,rcar-gen2-can";
66
-
reg = <0 0xe6e80000 0 0x1000>;
67
-
interrupts = <0 186 IRQ_TYPE_LEVEL_HIGH>;
68
-
clocks = <&mstp9_clks R8A7791_CLK_RCAN0>,
69
-
<&cpg_clocks R8A7791_CLK_RCAN>, <&can_clk>;
70
-
clock-names = "clkp1", "clkp2", "can_clk";
71
-
status = "disabled";
72
-
};
73
-
74
-
Board specific .dts file:
75
-
76
-
&can0 {
77
-
pinctrl-0 = <&can0_pins>;
78
-
pinctrl-names = "default";
79
-
status = "okay";
80
-
};
+139
Documentation/devicetree/bindings/net/can/renesas,rcar-can.yaml
+139
Documentation/devicetree/bindings/net/can/renesas,rcar-can.yaml
···
1
+
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2
+
%YAML 1.2
3
+
---
4
+
$id: http://devicetree.org/schemas/net/can/renesas,rcar-can.yaml#
5
+
$schema: http://devicetree.org/meta-schemas/core.yaml#
6
+
7
+
title: Renesas R-Car CAN Controller
8
+
9
+
maintainers:
10
+
- Sergei Shtylyov <sergei.shtylyov@gmail.com>
11
+
12
+
properties:
13
+
compatible:
14
+
oneOf:
15
+
- items:
16
+
- enum:
17
+
- renesas,can-r8a7778 # R-Car M1-A
18
+
- renesas,can-r8a7779 # R-Car H1
19
+
- const: renesas,rcar-gen1-can # R-Car Gen1
20
+
21
+
- items:
22
+
- enum:
23
+
- renesas,can-r8a7742 # RZ/G1H
24
+
- renesas,can-r8a7743 # RZ/G1M
25
+
- renesas,can-r8a7744 # RZ/G1N
26
+
- renesas,can-r8a7745 # RZ/G1E
27
+
- renesas,can-r8a77470 # RZ/G1C
28
+
- renesas,can-r8a7790 # R-Car H2
29
+
- renesas,can-r8a7791 # R-Car M2-W
30
+
- renesas,can-r8a7792 # R-Car V2H
31
+
- renesas,can-r8a7793 # R-Car M2-N
32
+
- renesas,can-r8a7794 # R-Car E2
33
+
- const: renesas,rcar-gen2-can # R-Car Gen2 and RZ/G1
34
+
35
+
- items:
36
+
- enum:
37
+
- renesas,can-r8a774a1 # RZ/G2M
38
+
- renesas,can-r8a774b1 # RZ/G2N
39
+
- renesas,can-r8a774c0 # RZ/G2E
40
+
- renesas,can-r8a774e1 # RZ/G2H
41
+
- renesas,can-r8a7795 # R-Car H3
42
+
- renesas,can-r8a7796 # R-Car M3-W
43
+
- renesas,can-r8a77961 # R-Car M3-W+
44
+
- renesas,can-r8a77965 # R-Car M3-N
45
+
- renesas,can-r8a77990 # R-Car E3
46
+
- renesas,can-r8a77995 # R-Car D3
47
+
- const: renesas,rcar-gen3-can # R-Car Gen3 and RZ/G2
48
+
49
+
reg:
50
+
maxItems: 1
51
+
52
+
interrupts:
53
+
maxItems: 1
54
+
55
+
clocks:
56
+
maxItems: 3
57
+
58
+
clock-names:
59
+
items:
60
+
- const: clkp1
61
+
- const: clkp2
62
+
- const: can_clk
63
+
64
+
power-domains:
65
+
maxItems: 1
66
+
67
+
resets:
68
+
maxItems: 1
69
+
70
+
renesas,can-clock-select:
71
+
$ref: /schemas/types.yaml#/definitions/uint32
72
+
enum: [ 0, 1, 3 ]
73
+
default: 0
74
+
description: |
75
+
R-Car CAN Clock Source Select. Valid values are:
76
+
<0x0> (default) : Peripheral clock (clkp1)
77
+
<0x1> : Peripheral clock (clkp2)
78
+
<0x3> : External input clock
79
+
80
+
assigned-clocks:
81
+
description:
82
+
Reference to the clkp2 (CANFD) clock.
83
+
On R-Car Gen3 and RZ/G2 SoCs, "clkp2" is the CANFD clock. This is a div6
84
+
clock and can be used by both CAN and CAN FD controllers at the same
85
+
time. It needs to be scaled to maximum frequency if any of these
86
+
controllers use it.
87
+
88
+
assigned-clock-rates:
89
+
description: Maximum frequency of the CANFD clock.
90
+
91
+
required:
92
+
- compatible
93
+
- reg
94
+
- interrupts
95
+
- clocks
96
+
- clock-names
97
+
- power-domains
98
+
99
+
allOf:
100
+
- $ref: can-controller.yaml#
101
+
102
+
- if:
103
+
not:
104
+
properties:
105
+
compatible:
106
+
contains:
107
+
const: renesas,rcar-gen1-can
108
+
then:
109
+
required:
110
+
- resets
111
+
112
+
- if:
113
+
properties:
114
+
compatible:
115
+
contains:
116
+
const: renesas,rcar-gen3-can
117
+
then:
118
+
required:
119
+
- assigned-clocks
120
+
- assigned-clock-rates
121
+
122
+
unevaluatedProperties: false
123
+
124
+
examples:
125
+
- |
126
+
#include <dt-bindings/clock/r8a7791-cpg-mssr.h>
127
+
#include <dt-bindings/interrupt-controller/arm-gic.h>
128
+
#include <dt-bindings/power/r8a7791-sysc.h>
129
+
130
+
can0: can@e6e80000 {
131
+
compatible = "renesas,can-r8a7791", "renesas,rcar-gen2-can";
132
+
reg = <0xe6e80000 0x1000>;
133
+
interrupts = <GIC_SPI 186 IRQ_TYPE_LEVEL_HIGH>;
134
+
clocks = <&cpg CPG_MOD 916>,
135
+
<&cpg CPG_CORE R8A7791_CLK_RCAN>, <&can_clk>;
136
+
clock-names = "clkp1", "clkp2", "can_clk";
137
+
power-domains = <&sysc R8A7791_PD_ALWAYS_ON>;
138
+
resets = <&cpg 916>;
139
+
};