Lines Matching +full:dt +full:- +full:property
1 .. SPDX-License-Identifier: GPL-2.0
3 Writing DeviceTree Bindings in json-schema
6 Devicetree bindings are written using json-schema vocabulary. Schema files are
12 ---------------
14 Each schema doc is a structured json-schema which is defined by a set of
15 top-level properties. Generally, there is one binding defined per file. The
16 top-level json-schema properties used are:
19 A json-schema unique identifier string. The string must be a valid
20 URI typically containing the binding's filename and path. For DT schema, it must
29 Indicates the meta-schema the schema file adheres to.
35 A DT specific property. Contains a list of email address(es)
39 Optional. A multi-line text block containing any detailed
45 Optional. A json-schema used to match nodes for applying the
55 A set of sub-schema defining all the DT properties for the
59 A property can also define a child DT node with child properties defined
62 For more details on properties sections, see 'Property Schema' section.
68 A list of DT properties from the 'properties' section that
77 Property Schema
78 ---------------
80 The 'properties' section of the schema contains all the DT properties for a
81 binding. Each property contains a set of constraints using json-schema
82 vocabulary for that property. The properties schemas are what is used for
83 validation of DT files.
91 schemas/types.yaml. A "description" property is always required.
93 The Devicetree schemas don't exactly match the YAML encoded DT data produced by
98 The default for arrays in json-schema is they are variable sized and allow more
109 -------
114 The DT schema project must be installed in order to validate the DT schema
115 binding documents and validate DTS files using the DT schema. The DT schema
118 pip3 install git+https://github.com/devicetree-org/dt-schema.git@master
120 Several executables (dt-doc-validate, dt-mk-schema, dt-validate) will be
129 apt-get install libyaml-dev
133 dnf -y install libyaml-devel
138 The DT schema binding documents must be validated using the meta-schema (the
139 schema for the schema) to ensure they are both valid json-schema and valid
140 binding schema. All of the DT binding documents can be validated using the
145 In order to perform validation of DT source files, use the ``dtbs_check`` target::
162 make dt_binding_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/trivial-devices.yaml
163 make dtbs_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/trivial-devices.yaml
166 json-schema Resources
167 ---------------------
170 `JSON-Schema Specifications <http://json-schema.org/>`_