1# SPDX-License-Identifier: GPL-2.0
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/net/can/bosch,m_can.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Bosch MCAN controller Bindings
8
9description: Bosch MCAN controller for CAN bus
10
11maintainers:
12  - Sriram Dash <sriram.dash@samsung.com>
13
14properties:
15  compatible:
16    const: bosch,m_can
17
18  reg:
19    items:
20      - description: M_CAN registers map
21      - description: message RAM
22
23  reg-names:
24    items:
25      - const: m_can
26      - const: message_ram
27
28  interrupts:
29    items:
30      - description: interrupt line0
31      - description: interrupt line1
32    minItems: 1
33
34  interrupt-names:
35    items:
36      - const: int0
37      - const: int1
38    minItems: 1
39
40  clocks:
41    items:
42      - description: peripheral clock
43      - description: bus clock
44
45  clock-names:
46    items:
47      - const: hclk
48      - const: cclk
49
50  bosch,mram-cfg:
51    description: |
52      Message RAM configuration data.
53      Multiple M_CAN instances can share the same Message RAM
54      and each element(e.g Rx FIFO or Tx Buffer and etc) number
55      in Message RAM is also configurable, so this property is
56      telling driver how the shared or private Message RAM are
57      used by this M_CAN controller.
58
59      The format should be as follows:
60      <offset sidf_elems xidf_elems rxf0_elems rxf1_elems rxb_elems txe_elems txb_elems>
61      The 'offset' is an address offset of the Message RAM where
62      the following elements start from. This is usually set to
63      0x0 if you're using a private Message RAM. The remain cells
64      are used to specify how many elements are used for each FIFO/Buffer.
65
66      M_CAN includes the following elements according to user manual:
67      11-bit Filter	0-128 elements / 0-128 words
68      29-bit Filter	0-64 elements / 0-128 words
69      Rx FIFO 0	0-64 elements / 0-1152 words
70      Rx FIFO 1	0-64 elements / 0-1152 words
71      Rx Buffers	0-64 elements / 0-1152 words
72      Tx Event FIFO	0-32 elements / 0-64 words
73      Tx Buffers	0-32 elements / 0-576 words
74
75      Please refer to 2.4.1 Message RAM Configuration in Bosch
76      M_CAN user manual for details.
77    $ref: /schemas/types.yaml#/definitions/int32-array
78    items:
79      - description: The 'offset' is an address offset of the Message RAM where
80          the following elements start from. This is usually set to 0x0 if
81          you're using a private Message RAM.
82        default: 0
83      - description: 11-bit Filter 0-128 elements / 0-128 words
84        minimum: 0
85        maximum: 128
86      - description: 29-bit Filter 0-64 elements / 0-128 words
87        minimum: 0
88        maximum: 64
89      - description: Rx FIFO 0 0-64 elements / 0-1152 words
90        minimum: 0
91        maximum: 64
92      - description: Rx FIFO 1 0-64 elements / 0-1152 words
93        minimum: 0
94        maximum: 64
95      - description: Rx Buffers 0-64 elements / 0-1152 words
96        minimum: 0
97        maximum: 64
98      - description: Tx Event FIFO 0-32 elements / 0-64 words
99        minimum: 0
100        maximum: 32
101      - description: Tx Buffers 0-32 elements / 0-576 words
102        minimum: 0
103        maximum: 32
104
105  power-domains:
106    description:
107      Power domain provider node and an args specifier containing
108      the can device id value.
109    maxItems: 1
110
111  can-transceiver:
112    $ref: can-transceiver.yaml#
113
114  phys:
115    maxItems: 1
116
117required:
118  - compatible
119  - reg
120  - reg-names
121  - interrupts
122  - interrupt-names
123  - clocks
124  - clock-names
125  - bosch,mram-cfg
126
127additionalProperties: false
128
129examples:
130  - |
131    #include <dt-bindings/clock/imx6sx-clock.h>
132    can@20e8000 {
133      compatible = "bosch,m_can";
134      reg = <0x020e8000 0x4000>, <0x02298000 0x4000>;
135      reg-names = "m_can", "message_ram";
136      interrupts = <0 114 0x04>, <0 114 0x04>;
137      interrupt-names = "int0", "int1";
138      clocks = <&clks IMX6SX_CLK_CANFD>,
139               <&clks IMX6SX_CLK_CANFD>;
140      clock-names = "hclk", "cclk";
141      bosch,mram-cfg = <0x0 0 0 32 0 0 0 1>;
142
143      can-transceiver {
144        max-bitrate = <5000000>;
145      };
146    };
147
148...
149