1 # SPDX-License-Identifier: (GPL-2.0-only OR BS 1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2 # Copyright 2018 Linaro Ltd. 2 # Copyright 2018 Linaro Ltd.
3 %YAML 1.2 3 %YAML 1.2
4 --- 4 ---
5 # All the top-level keys are standard json-sch 5 # All the top-level keys are standard json-schema keywords except for
6 # 'maintainers' and 'select' 6 # 'maintainers' and 'select'
7 7
8 # $id is a unique identifier based on the file 8 # $id is a unique identifier based on the filename. There may or may not be a
9 # file present at the URL. 9 # file present at the URL.
10 $id: http://devicetree.org/schemas/example-sch 10 $id: http://devicetree.org/schemas/example-schema.yaml#
11 # $schema is the meta-schema this schema shoul 11 # $schema is the meta-schema this schema should be validated with.
12 $schema: http://devicetree.org/meta-schemas/co 12 $schema: http://devicetree.org/meta-schemas/core.yaml#
13 13
14 title: An Example Device !! 14 title: An example schema annotated with jsonschema details
15 15
16 maintainers: 16 maintainers:
17 - Rob Herring <robh@kernel.org> 17 - Rob Herring <robh@kernel.org>
18 18
19 description: | 19 description: |
20 A more detailed multi-line description of th 20 A more detailed multi-line description of the binding.
21 21
22 Details about the hardware device and any li 22 Details about the hardware device and any links to datasheets can go here.
23 23
24 Literal blocks are marked with the '|' at th 24 Literal blocks are marked with the '|' at the beginning. The end is marked by
25 indentation less than the first line of the 25 indentation less than the first line of the literal block. Lines also cannot
26 begin with a tab character. 26 begin with a tab character.
27 27
28 select: false 28 select: false
29 # 'select' is a schema applied to a DT node 29 # 'select' is a schema applied to a DT node to determine if this binding
30 # schema should be applied to the node. It i 30 # schema should be applied to the node. It is optional and by default the
31 # possible compatible strings are extracted 31 # possible compatible strings are extracted and used to match.
32 32
33 # In this case, a 'false' schema will never 33 # In this case, a 'false' schema will never match.
34 34
35 properties: 35 properties:
36 # A dictionary of DT properties for this bin 36 # A dictionary of DT properties for this binding schema
37 compatible: 37 compatible:
38 # More complicated schema can use oneOf (X 38 # More complicated schema can use oneOf (XOR), anyOf (OR), or allOf (AND)
39 # to handle different conditions. 39 # to handle different conditions.
40 # In this case, it's needed to handle a va 40 # In this case, it's needed to handle a variable number of values as there
41 # isn't another way to express a constrain 41 # isn't another way to express a constraint of the last string value.
42 # The boolean schema must be a list of sch 42 # The boolean schema must be a list of schemas.
43 oneOf: 43 oneOf:
44 - items: 44 - items:
45 # items is a list of possible values 45 # items is a list of possible values for the property. The number of
46 # values is determined by the number 46 # values is determined by the number of elements in the list.
47 # Order in lists is significant, ord 47 # Order in lists is significant, order in dicts is not
48 # Must be one of the 1st enums follo 48 # Must be one of the 1st enums followed by the 2nd enum
49 # 49 #
50 # Each element in items should be 'e 50 # Each element in items should be 'enum' or 'const'
51 - enum: 51 - enum:
52 - vendor,soc4-ip 52 - vendor,soc4-ip
53 - vendor,soc3-ip 53 - vendor,soc3-ip
54 - vendor,soc2-ip 54 - vendor,soc2-ip
55 - const: vendor,soc1-ip !! 55 - enum:
>> 56 - vendor,soc1-ip
56 # additionalItems being false is impli 57 # additionalItems being false is implied
57 # minItems/maxItems equal to 2 is impl 58 # minItems/maxItems equal to 2 is implied
58 - items: 59 - items:
59 # 'const' is just a special case of 60 # 'const' is just a special case of an enum with a single possible value
60 - const: vendor,soc1-ip 61 - const: vendor,soc1-ip
61 62
62 reg: 63 reg:
63 # The core schema already checks that reg 64 # The core schema already checks that reg values are numbers, so device
64 # specific schema don't need to do those c 65 # specific schema don't need to do those checks.
65 # The description of each element defines 66 # The description of each element defines the order and implicitly defines
66 # the number of reg entries. 67 # the number of reg entries.
67 items: 68 items:
68 - description: core registers 69 - description: core registers
69 - description: aux registers 70 - description: aux registers
70 # minItems/maxItems equal to 2 is implied 71 # minItems/maxItems equal to 2 is implied
71 72
72 reg-names: 73 reg-names:
73 # The core schema enforces this (*-names) 74 # The core schema enforces this (*-names) is a string array
74 items: 75 items:
75 - const: core 76 - const: core
76 - const: aux 77 - const: aux
77 78
78 clocks: 79 clocks:
79 # Cases that have only a single entry just 80 # Cases that have only a single entry just need to express that with maxItems
80 maxItems: 1 81 maxItems: 1
81 description: bus clock. A description is o 82 description: bus clock. A description is only needed for a single item if
82 there's something unique to add. 83 there's something unique to add.
83 The items should have a fixed order, so 84 The items should have a fixed order, so pattern matching names are
84 discouraged. 85 discouraged.
85 86
86 clock-names: 87 clock-names:
87 # For single-entry lists in clocks, resets <<
88 # bring any value, especially if they copy <<
89 # just skip the xxx-names. <<
90 items: 88 items:
91 - const: bus 89 - const: bus
92 90
93 interrupts: 91 interrupts:
94 # Either 1 or 2 interrupts can be present 92 # Either 1 or 2 interrupts can be present
95 minItems: 1 93 minItems: 1
>> 94 maxItems: 2
96 items: 95 items:
97 - description: tx or combined interrupt 96 - description: tx or combined interrupt
98 - description: rx interrupt 97 - description: rx interrupt
99 description: 98 description:
100 A variable number of interrupts warrants 99 A variable number of interrupts warrants a description of what conditions
101 affect the number of interrupts. Otherwi 100 affect the number of interrupts. Otherwise, descriptions on standard
102 properties are not necessary. 101 properties are not necessary.
103 The items should have a fixed order, so 102 The items should have a fixed order, so pattern matching names are
104 discouraged. 103 discouraged.
105 104
106 interrupt-names: 105 interrupt-names:
107 # minItems must be specified here because 106 # minItems must be specified here because the default would be 2
108 minItems: 1 107 minItems: 1
>> 108 maxItems: 2
109 items: 109 items:
110 - const: tx irq 110 - const: tx irq
111 - const: rx irq 111 - const: rx irq
112 112
113 # Property names starting with '#' must be q 113 # Property names starting with '#' must be quoted
114 '#interrupt-cells': 114 '#interrupt-cells':
115 # A simple case where the value must alway 115 # A simple case where the value must always be '2'.
116 # The core schema handles that this must b 116 # The core schema handles that this must be a single integer.
117 const: 2 117 const: 2
118 118
119 interrupt-controller: true 119 interrupt-controller: true
120 # The core checks this is a boolean, so ju 120 # The core checks this is a boolean, so just have to list it here to be
121 # valid for this binding. 121 # valid for this binding.
122 122
123 clock-frequency: 123 clock-frequency:
124 # The type is set in the core schema. Per- !! 124 # The type is set in the core schema. Per device schema only need to set
125 # constraints on the possible values. 125 # constraints on the possible values.
126 minimum: 100 126 minimum: 100
127 maximum: 400000 127 maximum: 400000
128 # The value that should be used if the pro 128 # The value that should be used if the property is not present
129 default: 200 129 default: 200
130 130
131 foo-gpios: 131 foo-gpios:
132 maxItems: 1 132 maxItems: 1
133 description: A connection of the 'foo' gpi 133 description: A connection of the 'foo' gpio line.
134 134
135 # *-supply is always a single phandle, so no 135 # *-supply is always a single phandle, so nothing more to define.
136 foo-supply: true 136 foo-supply: true
137 137
138 # Vendor-specific properties !! 138 # Vendor specific properties
139 # 139 #
140 # Vendor-specific properties have slightly d !! 140 # Vendor specific properties have slightly different schema requirements than
141 # common properties. They must have at least 141 # common properties. They must have at least a type definition and
142 # 'description'. 142 # 'description'.
143 vendor,int-property: 143 vendor,int-property:
144 description: Vendor-specific properties mu !! 144 description: Vendor specific properties must have a description
145 $ref: /schemas/types.yaml#/definitions/uin 145 $ref: /schemas/types.yaml#/definitions/uint32
146 enum: [2, 4, 6, 8, 10] 146 enum: [2, 4, 6, 8, 10]
147 147
148 vendor,bool-property: 148 vendor,bool-property:
149 description: Vendor-specific properties mu !! 149 description: Vendor specific properties must have a description. Boolean
150 properties are one case where the json-s 150 properties are one case where the json-schema 'type' keyword can be used
151 directly. 151 directly.
152 type: boolean 152 type: boolean
153 153
154 vendor,string-array-property: 154 vendor,string-array-property:
155 description: Vendor-specific properties sh !! 155 description: Vendor specific properties should reference a type in the
156 core schema. 156 core schema.
157 $ref: /schemas/types.yaml#/definitions/str 157 $ref: /schemas/types.yaml#/definitions/string-array
158 items: 158 items:
159 - enum: [foo, bar] 159 - enum: [foo, bar]
160 - enum: [baz, boo] 160 - enum: [baz, boo]
161 161
162 vendor,property-in-standard-units-microvolt: 162 vendor,property-in-standard-units-microvolt:
163 description: Vendor-specific properties ha !! 163 description: Vendor specific properties having a standard unit suffix
164 don't need a type. 164 don't need a type.
165 enum: [ 100, 200, 300 ] 165 enum: [ 100, 200, 300 ]
166 166
167 vendor,int-array-variable-length-and-constra <<
168 description: Array might define what type <<
169 their range). <<
170 $ref: /schemas/types.yaml#/definitions/uin <<
171 minItems: 2 <<
172 maxItems: 3 <<
173 items: <<
174 minimum: 0 <<
175 maximum: 8 <<
176 <<
177 child-node: 167 child-node:
178 description: Child nodes are just another 168 description: Child nodes are just another property from a json-schema
179 perspective. 169 perspective.
180 type: object # DT nodes are json objects 170 type: object # DT nodes are json objects
181 # Child nodes also need additionalProperti <<
182 additionalProperties: false <<
183 properties: 171 properties:
184 vendor,a-child-node-property: 172 vendor,a-child-node-property:
185 description: Child node properties hav 173 description: Child node properties have all the same schema
186 requirements. 174 requirements.
187 type: boolean 175 type: boolean
188 176
189 required: 177 required:
190 - vendor,a-child-node-property 178 - vendor,a-child-node-property
191 179
192 # Describe the relationship between different 180 # Describe the relationship between different properties
193 dependencies: 181 dependencies:
194 # 'vendor,bool-property' is only allowed whe 182 # 'vendor,bool-property' is only allowed when 'vendor,string-array-property'
195 # is present 183 # is present
196 vendor,bool-property: [ 'vendor,string-array 184 vendor,bool-property: [ 'vendor,string-array-property' ]
197 # Expressing 2 properties in both orders mea 185 # Expressing 2 properties in both orders means all of the set of properties
198 # must be present or none of them. 186 # must be present or none of them.
199 vendor,string-array-property: [ 'vendor,bool 187 vendor,string-array-property: [ 'vendor,bool-property' ]
200 188
201 required: 189 required:
202 - compatible 190 - compatible
203 - reg 191 - reg
204 - interrupts 192 - interrupts
205 - interrupt-controller 193 - interrupt-controller
206 194
207 # if/then schema can be used to handle conditi 195 # if/then schema can be used to handle conditions on a property affecting
208 # another property. A typical case is a specif 196 # another property. A typical case is a specific 'compatible' value changes the
209 # constraints on other properties. 197 # constraints on other properties.
210 # 198 #
211 # For multiple 'if' schema, group them under a 199 # For multiple 'if' schema, group them under an 'allOf'.
212 # 200 #
213 # If the conditionals become too unweldy, then 201 # If the conditionals become too unweldy, then it may be better to just split
214 # the binding into separate schema documents. 202 # the binding into separate schema documents.
215 allOf: 203 allOf:
216 - if: 204 - if:
217 properties: 205 properties:
218 compatible: 206 compatible:
219 contains: 207 contains:
220 const: vendor,soc2-ip 208 const: vendor,soc2-ip
221 then: 209 then:
222 required: 210 required:
223 - foo-supply 211 - foo-supply
224 else: <<
225 # If otherwise the property is not allow <<
226 properties: <<
227 foo-supply: false <<
228 # Altering schema depending on presence of p 212 # Altering schema depending on presence of properties is usually done by
229 # dependencies (see above), however some adj 213 # dependencies (see above), however some adjustments might require if:
230 - if: 214 - if:
231 required: 215 required:
232 - vendor,bool-property 216 - vendor,bool-property
233 then: 217 then:
234 properties: 218 properties:
235 vendor,int-property: 219 vendor,int-property:
236 enum: [2, 4, 6] 220 enum: [2, 4, 6]
237 221
238 # Ideally, the schema should have this line ot 222 # Ideally, the schema should have this line otherwise any other properties
239 # present are allowed. There's a few common pr 223 # present are allowed. There's a few common properties such as 'status' and
240 # 'pinctrl-*' which are added automatically by 224 # 'pinctrl-*' which are added automatically by the tooling.
241 # 225 #
242 # This can't be used in cases where another sc 226 # This can't be used in cases where another schema is referenced
243 # (i.e. allOf: [{$ref: ...}]). 227 # (i.e. allOf: [{$ref: ...}]).
244 # If and only if another schema is referenced 228 # If and only if another schema is referenced and arbitrary children nodes can
245 # appear, "unevaluatedProperties: false" could 229 # appear, "unevaluatedProperties: false" could be used. A typical example is
246 # an I2C controller where no name pattern matc 230 # an I2C controller where no name pattern matching for children can be added.
247 additionalProperties: false 231 additionalProperties: false
248 232
249 examples: 233 examples:
250 # Examples are now compiled with dtc and val 234 # Examples are now compiled with dtc and validated against the schemas
251 # 235 #
252 # Examples have a default #address-cells and 236 # Examples have a default #address-cells and #size-cells value of 1. This can
253 # be overridden or an appropriate parent bus 237 # be overridden or an appropriate parent bus node should be shown (such as on
254 # i2c buses). 238 # i2c buses).
255 # 239 #
256 # Any includes used have to be explicitly in !! 240 # Any includes used have to be explicitly included.
257 - | 241 - |
258 node@1000 { 242 node@1000 {
259 compatible = "vendor,soc4-ip", "vendor !! 243 compatible = "vendor,soc4-ip", "vendor,soc1-ip";
260 reg = <0x1000 0x80>, !! 244 reg = <0x1000 0x80>,
261 <0x3000 0x80>; !! 245 <0x3000 0x80>;
262 reg-names = "core", "aux"; !! 246 reg-names = "core", "aux";
263 interrupts = <10>; !! 247 interrupts = <10>;
264 interrupt-controller; !! 248 interrupt-controller;
265 }; 249 };
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.