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