Lines Matching +full:json +full:- +full:schema
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
7 written in a JSON compatible subset of YAML. YAML is used instead of JSON as it
11 Also see :ref:`example-schema`.
13 Schema Contents
14 ---------------
16 Each schema doc is a structured json-schema which is defined by a set of
17 top-level properties. Generally, there is one binding defined per file. The
18 top-level json-schema properties used are:
21 A json-schema unique identifier string. The string must be a valid
22 URI typically containing the binding's filename and path. For DT schema, it must
24 references to other files specified in schema "$ref" properties. A $ref value
27 of the current schema file's '$id' value. A URL is used even for local files,
30 $schema
31 Indicates the meta-schema the schema file adheres to.
34 A one line description on the contents of the binding schema.
41 Optional. A multi-line text block containing any detailed
47 Optional. A json-schema used to match nodes for applying the
48 schema. By default without 'select', nodes are matched against their possible
57 A set of sub-schema defining all the DT properties for the
58 binding. The exact schema syntax depends on whether properties are known,
64 For more details on properties sections, see 'Property Schema' section.
79 Property Schema
80 ---------------
82 The 'properties' section of the schema contains all the DT properties for a
83 binding. Each property contains a set of constraints using json-schema
88 binding schema need to be defined such as how many values are valid or what
91 Vendor specific properties will typically need more detailed schema. With the
97 boilerplate. The tools process the schema files to produce the final schema for
100 The default for arrays in json-schema is they are variable sized and allow more
111 -------
116 The DT schema project must be installed in order to validate the DT schema
117 binding documents and validate DTS files using the DT schema. The DT schema
120 pip3 install git+https://github.com/devicetree-org/dt-schema.git@master
122 Several executables (dt-doc-validate, dt-mk-schema, dt-validate) will be
131 apt-get install libyaml-dev
135 dnf -y install libyaml-devel
140 The DT schema binding documents must be validated using the meta-schema (the
141 schema for the schema) to ensure they are both valid json-schema and valid
142 binding schema. All of the DT binding documents can be validated using the
151 Note that ``dtbs_check`` will skip any binding schema files with errors. It is
153 binding schema files.
159 It is also possible to run checks with a single schema file by setting the
160 ``DT_SCHEMA_FILES`` variable to a specific schema file.
164 make dt_binding_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/trivial-devices.yaml
165 make dtbs_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/trivial-devices.yaml
168 json-schema Resources
169 ---------------------
172 `JSON-Schema Specifications <http://json-schema.org/>`_
174 `Using JSON Schema Book <http://usingjsonschema.com/>`_
176 .. _example-schema:
178 Annotated Example Schema
179 ------------------------
181 Also available as a separate file: :download:`example-schema.yaml`
183 .. literalinclude:: example-schema.yaml