bindings/i3c/i3c.yaml

1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
3 ---
4 $id: http://devicetree.org/schemas/i3c/i3c.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
7 title: I3C bus
10   - Alexandre Belloni <alexandre.belloni@bootlin.com>
11   - Miquel Raynal <miquel.raynal@bootlin.com>
14   I3C busses can be described with a node for the primary I3C controller device
15   and a set of child nodes for each I2C or I3C slave on the bus. Each of them
20     pattern: "^i3c-master@[0-9a-f]+$"
22   "#address-cells":
27       All I3C devices are supposed to support DAA (Dynamic Address Assignment),
28       and are thus discoverable. So, by default, I3C devices do not have to be
32       I3C devices.
34       Another use case for describing an I3C device in the device tree is when
35       this I3C device has a static I2C address and we want to assign it a
36       specific I3C dynamic address before the DAA takes place (so that other
39   "#size-cells":
42   i3c-scl-hz:
44       Frequency of the SCL signal used for I3C transfers. When undefined, the
49   i2c-scl-hz:
51       Frequency of the SCL signal used for I2C transfers. When undefined, the
58   mctp-controller:
62       MCTP over I3C transport.
65   - "#address-cells"
66   - "#size-cells"
69   "@[0-9a-f]+$":
72       I2C child, should be named: <device-type>@<i2c-address>
84           - items:
85               - description: |
87                   10-bit address can't be properly passed through DEFSLVS
91               - const: 0
92               - description: |
93                   Shall encode the I3C LVR (Legacy Virtual Register):
98                            supports high frequency on SCL
101                       * 3-7: reserved
107                       * 0-15: reserved
110       - compatible
111       - reg
113   "@[0-9a-f]+,[0-9a-f]+$":
116       I3C child, should be named: <device-type>@<static-i2c-address>,<i3c-pid>
121           - items:
122               - description: |
127               - description: |
129                   definition provided by the I3C specification).
131                   Contains the manufacturer ID left-shifted by 1.
132               - description: |
134                   definition provided by the I3C specification).
136                   Contains the ORing of the part ID left-shifted by 16,
137                   the instance ID left-shifted by 12 and extra information.
139       assigned-address:
150       - reg
155   - |
156     i3c-master@d040000 {
157         compatible = "cdns,i3c-master";
159         clock-names = "pclk", "sysclk";
162         #address-cells = <3>;
163         #size-cells = <0>;
164         i2c-scl-hz = <100000>;
173         /* I3C device with a static I2C address and assigned address. */
176             assigned-address = <0xa>;
179         /* I3C device with only assigned address. */
182             assigned-address = <0xc>;
186          * I3C device without a static I2C address but requiring