bindings/i3c/i3c.yaml

1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
3 ---
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
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@[0-9a-f]+$"
22   "#address-cells":
25       Each I2C device connected to the bus should be described in a subnode.
35       this I3C device has a static I2C address and we want to assign it a
39   "#size-cells":
42   i3c-scl-hz:
49   i2c-scl-hz:
51       Frequency of the SCL signal used for I2C transfers. When undefined, the
53       I2C devices described in the device tree to determine the maximum I2C
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>
74       All properties described in dtschema schemas/i2c/i2c-controller.yaml
80           Compatible of the I2C device.
84           - items:
85               - description: |
86                   I2C address. 10 bit addressing is not supported. Devices with
87                   10-bit address can't be properly passed through DEFSLVS
91               - const: 0
92               - description: |
94                   See include/dt-bindings/i3c/i3c.h
96                     bit[7:5]: I2C device index. Possible values:
97                       * 0: I2C device has a 50 ns spike filter
98                       * 1: I2C device does not have a 50 ns spike filter but
100                       * 2: I2C device does not have a 50 ns spike filter and is
102                       * 3-7: reserved
108                       * 0-15: reserved
111       - compatible
112       - reg
114   "@[0-9a-f]+,[0-9a-f]+$":
117       I3C child, should be named: <device-type>@<static-i2c-address>,<i3c-pid>
122           - items:
123               - description: |
124                   Encodes the static I2C address. Should be 0 if the device does
125                   not have one (0 is not a valid I2C address).
128               - description: |
132                   Contains the manufacturer ID left-shifted by 1.
133               - description: |
137                   Contains the ORing of the part ID left-shifted by 16,
138                   the instance ID left-shifted by 12 and extra information.
140       assigned-address:
151       - reg
156   - |
157     #include <dt-bindings/i3c/i3c.h>
160         compatible = "cdns,i3c-master";
162         clock-names = "pclk", "sysclk";
165         #address-cells = <3>;
166         #size-cells = <0>;
167         i2c-scl-hz = <100000>;
169         /* I2C device. */
176         /* I3C device with a static I2C address and assigned address. */
179             assigned-address = <0xa>;
185             assigned-address = <0xc>;
189          * I3C device without a static I2C address but requiring