devicetree/bindings/example-schema.yaml

1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
4 ---
5 # All the top-level keys are standard json-schema keywords except for
10 $id: http://devicetree.org/schemas/example-schema.yaml#
11 # $schema is the meta-schema this schema should be validated with.
12 $schema: http://devicetree.org/meta-schemas/core.yaml#
14 title: An example schema annotated with jsonschema details
17   - Rob Herring <robh@kernel.org>
20   A more detailed multi-line description of the binding.
29   # 'select' is a schema applied to a DT node to determine if this binding
30   # schema should be applied to the node. It is optional and by default the
33   # In this case, a 'false' schema will never match.
36   # A dictionary of DT properties for this binding schema
38     # More complicated schema can use oneOf (XOR), anyOf (OR), or allOf (AND)
42     # The boolean schema must be a list of schemas.
44       - items:
51           - enum:
52               - vendor,soc4-ip
53               - vendor,soc3-ip
54               - vendor,soc2-ip
55           - enum:
56               - vendor,soc1-ip
59       - items:
61           - const: vendor,soc1-ip
64     # The core schema already checks that reg values are numbers, so device
65     # specific schema don't need to do those checks.
69       - description: core registers
70       - description: aux registers
73   reg-names:
74     # The core schema enforces this (*-names) is a string array
76       - const: core
77       - const: aux
87   clock-names:
89       - const: bus
96       - description: tx or combined interrupt
97       - description: rx interrupt
105   interrupt-names:
110       - const: tx irq
111       - const: rx irq
114   '#interrupt-cells':
116     # The core schema handles that this must be a single integer.
119   interrupt-controller: true
123   clock-frequency:
124     # The type is set in the core schema. Per device schema only need to set
131   foo-gpios:
135   # *-supply is always a single phandle, so nothing more to define.
136   foo-supply: true
140   # Vendor specific properties have slightly different schema requirements than
143   vendor,int-property:
148   vendor,bool-property:
150       properties are one case where the json-schema 'type' keyword can be used
154   vendor,string-array-property:
156       core schema.
157     $ref: /schemas/types.yaml#/definitions/string-array
159       - enum: [foo, bar]
160       - enum: [baz, boo]
162   vendor,property-in-standard-units-microvolt:
167   child-node:
168     description: Child nodes are just another property from a json-schema
170     type: object  # DT nodes are json objects
172       vendor,a-child-node-property:
173         description: Child node properties have all the same schema
178       - vendor,a-child-node-property
182   # 'vendor,bool-property' is only allowed when 'vendor,string-array-property'
184   vendor,bool-property: [ 'vendor,string-array-property' ]
187   vendor,string-array-property: [ 'vendor,bool-property' ]
190   - compatible
191   - reg
192   - interrupts
193   - interrupt-controller
195 # if/then schema can be used to handle conditions on a property affecting
199 # For multiple 'if' schema, group them under an 'allOf'.
202 # the binding into separate schema documents.
204   - if:
208             const: vendor,soc2-ip
211         - foo-supply
212   # Altering schema depending on presence of properties is usually done by
214   - if:
216         - vendor,bool-property
219         vendor,int-property:
222 # Ideally, the schema should have this line otherwise any other properties
224 # 'pinctrl-*' which are added automatically by the tooling.
226 # This can't be used in cases where another schema is referenced
228 # If and only if another schema is referenced and arbitrary children nodes can
236   # Examples have a default #address-cells and #size-cells value of 1. This can
241   - |
243           compatible = "vendor,soc4-ip", "vendor,soc1-ip";
246           reg-names = "core", "aux";
248           interrupt-controller;