1 # SPDX-License-Identifier: (GPL-2.0-only OR BS
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/i3c/i3c.yam
5 $schema: http://devicetree.org/meta-schemas/co
6
7 title: I3C bus
8
9 maintainers:
10 - Alexandre Belloni <alexandre.belloni@bootli
11 - Miquel Raynal <miquel.raynal@bootlin.com>
12
13 description: |
14 I3C busses can be described with a node for
15 and a set of child nodes for each I2C or I3C
16 may, during the life of the bus, request mas
17
18 properties:
19 $nodename:
20 pattern: "^i3c@[0-9a-f]+$"
21
22 "#address-cells":
23 const: 3
24 description: |
25 Each I2C device connected to the bus sho
26
27 All I3C devices are supposed to support
28 and are thus discoverable. So, by defaul
29 described in the device tree. This being
30 extra resources to these devices, and th
31 described in the device tree, which in t
32 I3C devices.
33
34 Another use case for describing an I3C d
35 this I3C device has a static I2C address
36 specific I3C dynamic address before the
37 devices on the bus can't take this dynam
38
39 "#size-cells":
40 const: 0
41
42 i3c-scl-hz:
43 description: |
44 Frequency of the SCL signal used for I3C
45 default value should be 12.5MHz.
46
47 May not be supported by all controllers.
48
49 i2c-scl-hz:
50 description: |
51 Frequency of the SCL signal used for I2C
52 default should be to look at LVR (Legacy
53 I2C devices described in the device tree
54 frequency.
55
56 May not be supported by all controllers.
57
58 mctp-controller:
59 type: boolean
60 description: |
61 Indicates that the system is accessible
62 MCTP over I3C transport.
63
64 required:
65 - "#address-cells"
66 - "#size-cells"
67
68 patternProperties:
69 "@[0-9a-f]+$":
70 type: object
71 description: |
72 I2C child, should be named: <device-type>
73
74 All properties described in dtschema sch
75 are valid here, except the reg property
76
77 properties:
78 compatible:
79 description:
80 Compatible of the I2C device.
81
82 reg:
83 items:
84 - items:
85 - description: |
86 I2C address. 10 bit addressi
87 10-bit address can't be prop
88 command.
89 minimum: 0
90 maximum: 0x7f
91 - const: 0
92 - description: |
93 Shall encode the I3C LVR (Le
94 See include/dt-bindings/i3c/
95 bit[31:8]: unused/ignored
96 bit[7:5]: I2C device index
97 * 0: I2C device has a 50
98 * 1: I2C device does not
99 supports high frequ
100 * 2: I2C device does not
101 not tolerant to hig
102 * 3-7: reserved
103 bit[4]: tell whether the d
104 or FM+ mode:
105 * 0: FM+ mode
106 * 1: FM mode
107 bit[3:0]: device type
108 * 0-15: reserved
109
110 required:
111 - compatible
112 - reg
113
114 "@[0-9a-f]+,[0-9a-f]+$":
115 type: object
116 description: |
117 I3C child, should be named: <device-type>
118
119 properties:
120 reg:
121 items:
122 - items:
123 - description: |
124 Encodes the static I2C addre
125 not have one (0 is not a val
126 minimum: 0
127 maximum: 0x7f
128 - description: |
129 First half of the Provisione
130 definition provided by the I
131
132 Contains the manufacturer ID
133 - description: |
134 Second half of the Provision
135 definition provided by the I
136
137 Contains the ORing of the pa
138 the instance ID left-shifted
139
140 assigned-address:
141 $ref: /schemas/types.yaml#/definitions
142 minimum: 0x1
143 maximum: 0xff
144 description: |
145 Dynamic address to be assigned to th
146 present (first cell of the reg prope
147 through SETDASA. If static address i
148 through SETNEWDA after assigning a t
149
150 required:
151 - reg
152
153 additionalProperties: true
154
155 examples:
156 - |
157 #include <dt-bindings/i3c/i3c.h>
158
159 i3c@d040000 {
160 compatible = "cdns,i3c-master";
161 clocks = <&coreclock>, <&i3csysclock>;
162 clock-names = "pclk", "sysclk";
163 interrupts = <3 0>;
164 reg = <0x0d040000 0x1000>;
165 #address-cells = <3>;
166 #size-cells = <0>;
167 i2c-scl-hz = <100000>;
168
169 /* I2C device. */
170 eeprom@57 {
171 compatible = "atmel,24c01";
172 reg = <0x57 0x0 (I2C_FM | I2C_FILT
173 pagesize = <0x8>;
174 };
175
176 /* I3C device with a static I2C addres
177 thermal_sensor: sensor@68,39200144004
178 reg = <0x68 0x392 0x144004>;
179 assigned-address = <0xa>;
180 };
181
182 /* I3C device with only assigned addre
183 pressure_sensor: sensor@0,39200124004
184 reg = <0x0 0x392 0x124000>;
185 assigned-address = <0xc>;
186 };
187
188 /*
189 * I3C device without a static I2C add
190 * resources described in the DT.
191 */
192 sensor@0,39200154004 {
193 reg = <0x0 0x392 0x154004>;
194 clocks = <&clock_provider 0>;
195 };
196 };
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.