€•¤ì      Œsphinx.addnodes”Œdocument”“”)”}”(Œ	rawsource”Œ ”Œchildren”]”(Œtranslations”ŒLanguagesNode”“”)”}”(hhh]”(h Œpending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ	refdomain”Œstd”Œreftype”Œdoc”Œ	reftarget”Œ6/translations/zh_CN/devicetree/bindings/writing-schema”Œmodname”NŒ	classname”NŒrefexplicit”ˆuŒtagname”hhhubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ6/translations/zh_TW/devicetree/bindings/writing-schema”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ6/translations/it_IT/devicetree/bindings/writing-schema”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ6/translations/ja_JP/devicetree/bindings/writing-schema”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ6/translations/ko_KR/devicetree/bindings/writing-schema”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒSpanish”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ6/translations/sp_SP/devicetree/bindings/writing-schema”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h
hhŒ	_document”hŒsource”NŒline”NubhŒcomment”“”)”}”(hŒ SPDX-License-Identifier: GPL-2.0”h]”hŒ SPDX-License-Identifier: GPL-2.0”…””}”hh£sbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”uh1h¡hhhžhhŸŒP/var/lib/git/docbuild/linux/Documentation/devicetree/bindings/writing-schema.rst”h KubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒ*Writing Devicetree Bindings in json-schema”h]”hŒ*Writing Devicetree Bindings in json-schema”…””}”(hh»hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hh¶hžhhŸh³h KubhŒ	paragraph”“”)”}”(hX  Devicetree bindings are written using json-schema vocabulary. Schema files are
written in a JSON-compatible subset of YAML. YAML is used instead of JSON as it
is considered more human readable and has some advantages such as allowing
comments (Prefixed with '#').”h]”hX  Devicetree bindings are written using json-schema vocabulary. Schema files are
written in a JSON-compatible subset of YAML. YAML is used instead of JSON as it
is considered more human readable and has some advantages such as allowing
comments (Prefixed with â€˜#â€™).”…””}”(hhËhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khh¶hžhubhÊ)”}”(hŒAlso see :ref:`example-schema`.”h]”(hŒ	Also see ”…””}”(hhÙhžhhŸNh Nubh)”}”(hŒ:ref:`example-schema`”h]”hŒinline”“”)”}”(hhãh]”hŒexample-schema”…””}”(hhçhžhhŸNh Nubah}”(h]”h ]”(Œxref”Œstd”Œstd-ref”eh"]”h$]”h&]”uh1håhháubah}”(h]”h ]”h"]”h$]”h&]”Œrefdoc”Œ"devicetree/bindings/writing-schema”Œ	refdomain”hòŒreftype”Œref”Œrefexplicit”‰Œrefwarn”ˆŒ	reftarget”Œexample-schema”uh1hhŸh³h KhhÙubhŒ.”…””}”(hhÙhžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khh¶hžhubhµ)”}”(hhh]”(hº)”}”(hŒSchema Contents”h]”hŒSchema Contents”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj  hžhhŸh³h KubhÊ)”}”(hŒ¿Each schema doc is a structured json-schema which is defined by a set of
top-level properties. Generally, there is one binding defined per file. The
top-level json-schema properties used are:”h]”hŒ¿Each schema doc is a structured json-schema which is defined by a set of
top-level properties. Generally, there is one binding defined per file. The
top-level json-schema properties used are:”…””}”(hj!  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khj  hžhubhŒdefinition_list”“”)”}”(hhh]”(hŒdefinition_list_item”“”)”}”(hXa  $id
A json-schema unique identifier string. The string must be a valid
URI typically containing the binding's filename and path. For DT schema, it must
begin with "http://devicetree.org/schemas/". The URL is used in constructing
references to other files specified in schema "$ref" properties. A $ref value
with a leading '/' will have the hostname prepended. A $ref value with only a
relative path or filename will be prepended with the hostname and path
components of the current schema file's '$id' value. A URL is used even for
local files, but there may not actually be files present at those locations.
”h]”(hŒterm”“”)”}”(hŒ$id”h]”hŒ$id”…””}”(hj<  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j:  hŸh³h Khj6  ubhŒ
definition”“”)”}”(hhh]”hÊ)”}”(hX\  A json-schema unique identifier string. The string must be a valid
URI typically containing the binding's filename and path. For DT schema, it must
begin with "http://devicetree.org/schemas/". The URL is used in constructing
references to other files specified in schema "$ref" properties. A $ref value
with a leading '/' will have the hostname prepended. A $ref value with only a
relative path or filename will be prepended with the hostname and path
components of the current schema file's '$id' value. A URL is used even for
local files, but there may not actually be files present at those locations.”h]”(hŒ¤A json-schema unique identifier string. The string must be a valid
URI typically containing the bindingâ€™s filename and path. For DT schema, it must
begin with â€œ”…””}”(hjO  hžhhŸNh NubhŒ	reference”“”)”}”(hŒhttp://devicetree.org/schemas/”h]”hŒhttp://devicetree.org/schemas/”…””}”(hjY  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”j[  uh1jW  hjO  ubhX®  â€. The URL is used in constructing
references to other files specified in schema â€œ$refâ€ properties. A $ref value
with a leading â€˜/â€™ will have the hostname prepended. A $ref value with only a
relative path or filename will be prepended with the hostname and path
components of the current schema fileâ€™s â€˜$idâ€™ value. A URL is used even for
local files, but there may not actually be files present at those locations.”…””}”(hjO  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KhjL  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jJ  hj6  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j4  hŸh³h Khj1  ubj5  )”}”(hŒ>$schema
Indicates the meta-schema the schema file adheres to.
”h]”(j;  )”}”(hŒ$schema”h]”hŒ$schema”…””}”(hj‚  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j:  hŸh³h Khj~  ubjK  )”}”(hhh]”hÊ)”}”(hŒ5Indicates the meta-schema the schema file adheres to.”h]”hŒ5Indicates the meta-schema the schema file adheres to.”…””}”(hj“  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jJ  hj~  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j4  hŸh³h Khj1  hžhubj5  )”}”(hŒTtitle
A one-line description of the hardware being described in the binding schema.
”h]”(j;  )”}”(hŒtitle”h]”hŒtitle”…””}”(hj±  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j:  hŸh³h K"hj­  ubjK  )”}”(hhh]”hÊ)”}”(hŒMA one-line description of the hardware being described in the binding schema.”h]”hŒMA one-line description of the hardware being described in the binding schema.”…””}”(hjÂ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K"hj¿  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jJ  hj­  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j4  hŸh³h K"hj1  hžhubj5  )”}”(hŒjmaintainers
A DT specific property. Contains a list of email address(es)
for maintainers of this binding.
”h]”(j;  )”}”(hŒmaintainers”h]”hŒmaintainers”…””}”(hjà  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j:  hŸh³h K&hjÜ  ubjK  )”}”(hhh]”hÊ)”}”(hŒ]A DT specific property. Contains a list of email address(es)
for maintainers of this binding.”h]”hŒ]A DT specific property. Contains a list of email address(es)
for maintainers of this binding.”…””}”(hjñ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K%hjî  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jJ  hjÜ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j4  hŸh³h K&hj1  hžhubj5  )”}”(hXÃ  description
Optional. A multi-line text block containing any detailed
information about this hardware. It should contain things such as what the block
or device does, standards the device conforms to, and links to datasheets for
more information.

The YAML format has several options for defining the formatting of the text
block. The options are controlled with indicator characters following the key
(e.g. "description: \|"). The minimum formatting needed for a block should be
used. The formatting controls can not only affect whether the YAML can be
parsed correctly, but are important when the text blocks are rendered to
another form. The options are as follows.

The default without any indicators is flowed, plain scalar style where single
line breaks and leading whitespace are stripped. Paragraphs are delimited by
blank lines (i.e. double line break). This style cannot contain ": " in it as
it will be interpretted as a key. Any " #" sequence will be interpretted as
a comment. There's other restrictions on characters as well. Most
restrictions are on what the first character can be.

The second style is folded which is indicated by ">" character. In addition
to maintaining line breaks on double line breaks, the folded style also
maintains leading whitespace beyond indentation of the first line. The line
breaks on indented lines are also maintained.

The third style is literal which is indicated by "\|" character. The literal
style maintains all line breaks and whitespace (beyond indentation of the
first line).

The above is not a complete description of YAML text blocks. More details on
multi-line YAML text blocks can be found online:

https://yaml-multiline.info/

https://www.yaml.info/learn/quote.html
”h]”(j;  )”}”(hŒdescription”h]”hŒdescription”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j:  hŸh³h KJhj  ubjK  )”}”(hhh]”(hÊ)”}”(hŒêOptional. A multi-line text block containing any detailed
information about this hardware. It should contain things such as what the block
or device does, standards the device conforms to, and links to datasheets for
more information.”h]”hŒêOptional. A multi-line text block containing any detailed
information about this hardware. It should contain things such as what the block
or device does, standards the device conforms to, and links to datasheets for
more information.”…””}”(hj   hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K)hj  ubhÊ)”}”(hX¤  The YAML format has several options for defining the formatting of the text
block. The options are controlled with indicator characters following the key
(e.g. "description: \|"). The minimum formatting needed for a block should be
used. The formatting controls can not only affect whether the YAML can be
parsed correctly, but are important when the text blocks are rendered to
another form. The options are as follows.”h]”hX¨  The YAML format has several options for defining the formatting of the text
block. The options are controlled with indicator characters following the key
(e.g. â€œdescription:  |â€). The minimum formatting needed for a block should be
used. The formatting controls can not only affect whether the YAML can be
parsed correctly, but are important when the text blocks are rendered to
another form. The options are as follows.”…””}”(hj.  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K.hj  ubhÊ)”}”(hX«  The default without any indicators is flowed, plain scalar style where single
line breaks and leading whitespace are stripped. Paragraphs are delimited by
blank lines (i.e. double line break). This style cannot contain ": " in it as
it will be interpretted as a key. Any " #" sequence will be interpretted as
a comment. There's other restrictions on characters as well. Most
restrictions are on what the first character can be.”h]”hXµ  The default without any indicators is flowed, plain scalar style where single
line breaks and leading whitespace are stripped. Paragraphs are delimited by
blank lines (i.e. double line break). This style cannot contain â€œ: â€œ in it as
it will be interpretted as a key. Any â€œ #â€ sequence will be interpretted as
a comment. Thereâ€™s other restrictions on characters as well. Most
restrictions are on what the first character can be.”…””}”(hj<  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K5hj  ubhÊ)”}”(hX  The second style is folded which is indicated by ">" character. In addition
to maintaining line breaks on double line breaks, the folded style also
maintains leading whitespace beyond indentation of the first line. The line
breaks on indented lines are also maintained.”h]”hX  The second style is folded which is indicated by â€œ>â€ character. In addition
to maintaining line breaks on double line breaks, the folded style also
maintains leading whitespace beyond indentation of the first line. The line
breaks on indented lines are also maintained.”…””}”(hjJ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K<hj  ubhÊ)”}”(hŒ£The third style is literal which is indicated by "\|" character. The literal
style maintains all line breaks and whitespace (beyond indentation of the
first line).”h]”hŒ§The third style is literal which is indicated by â€œ |â€ character. The literal
style maintains all line breaks and whitespace (beyond indentation of the
first line).”…””}”(hjX  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KAhj  ubhÊ)”}”(hŒ}The above is not a complete description of YAML text blocks. More details on
multi-line YAML text blocks can be found online:”h]”hŒ}The above is not a complete description of YAML text blocks. More details on
multi-line YAML text blocks can be found online:”…””}”(hjf  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KEhj  ubhÊ)”}”(hŒhttps://yaml-multiline.info/”h]”jX  )”}”(hjv  h]”hŒhttps://yaml-multiline.info/”…””}”(hjx  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”jv  uh1jW  hjt  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KHhj  ubhÊ)”}”(hŒ&https://www.yaml.info/learn/quote.html”h]”jX  )”}”(hjŽ  h]”hŒ&https://www.yaml.info/learn/quote.html”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”jŽ  uh1jW  hjŒ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KJhj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jJ  hj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j4  hŸh³h KJhj1  hžhubj5  )”}”(hŒàselect
Optional. A json-schema used to match nodes for applying the
schema. By default, without 'select', nodes are matched against their possible
compatible-string values or node name. Most bindings should not need select.
”h]”(j;  )”}”(hŒselect”h]”hŒselect”…””}”(hj´  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j:  hŸh³h KOhj°  ubjK  )”}”(hhh]”hÊ)”}”(hŒØOptional. A json-schema used to match nodes for applying the
schema. By default, without 'select', nodes are matched against their possible
compatible-string values or node name. Most bindings should not need select.”h]”hŒÜOptional. A json-schema used to match nodes for applying the
schema. By default, without â€˜selectâ€™, nodes are matched against their possible
compatible-string values or node name. Most bindings should not need select.”…””}”(hjÅ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KMhjÂ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jJ  hj°  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j4  hŸh³h KOhj1  hžhubj5  )”}”(hŒÉallOf
Optional. A list of other schemas to include. This is used to
include other schemas the binding conforms to. This may be schemas for a
particular class of devices such as I2C or SPI controllers.
”h]”(j;  )”}”(hŒallOf”h]”hŒallOf”…””}”(hjã  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j:  hŸh³h KThjß  ubjK  )”}”(hhh]”hÊ)”}”(hŒÂOptional. A list of other schemas to include. This is used to
include other schemas the binding conforms to. This may be schemas for a
particular class of devices such as I2C or SPI controllers.”h]”hŒÂOptional. A list of other schemas to include. This is used to
include other schemas the binding conforms to. This may be schemas for a
particular class of devices such as I2C or SPI controllers.”…””}”(hjô  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KRhjñ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jJ  hjß  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j4  hŸh³h KThj1  hžhubj5  )”}”(hŒáproperties
A set of sub-schema defining all the DT properties for the
binding. The exact schema syntax depends on whether properties are known,
common properties (e.g. 'interrupts') or are binding/vendor-specific
properties.
”h]”(j;  )”}”(hŒ
properties”h]”hŒ
properties”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j:  hŸh³h KZhj  ubjK  )”}”(hhh]”hÊ)”}”(hŒÕA set of sub-schema defining all the DT properties for the
binding. The exact schema syntax depends on whether properties are known,
common properties (e.g. 'interrupts') or are binding/vendor-specific
properties.”h]”hŒÙA set of sub-schema defining all the DT properties for the
binding. The exact schema syntax depends on whether properties are known,
common properties (e.g. â€˜interruptsâ€™) or are binding/vendor-specific
properties.”…””}”(hj#  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KWhj   ubah}”(h]”h ]”h"]”h$]”h&]”uh1jJ  hj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j4  hŸh³h KZhj1  hžhubeh}”(h]”h ]”h"]”h$]”h&]”uh1j/  hj  hžhhŸh³h NubhÊ)”}”(hŒRA property can also define a child DT node with child properties defined
under it.”h]”hŒRA property can also define a child DT node with child properties defined
under it.”…””}”(hjC  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K\hj  hžhubhÊ)”}”(hŒGFor more details on properties sections, see 'Property Schema' section.”h]”hŒKFor more details on properties sections, see â€˜Property Schemaâ€™ section.”…””}”(hjQ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K_hj  hžhubj0  )”}”(hhh]”(j5  )”}”(hŒJpatternProperties
Optional. Similar to 'properties', but names are regex.
”h]”(j;  )”}”(hŒpatternProperties”h]”hŒpatternProperties”…””}”(hjf  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j:  hŸh³h Kbhjb  ubjK  )”}”(hhh]”hÊ)”}”(hŒ7Optional. Similar to 'properties', but names are regex.”h]”hŒ;Optional. Similar to â€˜propertiesâ€™, but names are regex.”…””}”(hjw  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kbhjt  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jJ  hjb  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j4  hŸh³h Kbhj_  ubj5  )”}”(hŒ\required
A list of DT properties from the 'properties' section that
must always be present.
”h]”(j;  )”}”(hŒrequired”h]”hŒrequired”…””}”(hj•  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j:  hŸh³h Kfhj‘  ubjK  )”}”(hhh]”hÊ)”}”(hŒRA list of DT properties from the 'properties' section that
must always be present.”h]”hŒVA list of DT properties from the â€˜propertiesâ€™ section that
must always be present.”…””}”(hj¦  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kehj£  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jJ  hj‘  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j4  hŸh³h Kfhj_  hžhubj5  )”}”(hX®  additionalProperties / unevaluatedProperties
Keywords controlling how schema will validate properties not matched by this
schema's 'properties' or 'patternProperties'. Each schema is supposed to
have exactly one of these keywords in top-level part, so either
additionalProperties or unevaluatedProperties. Nested nodes, so properties
being objects, are supposed to have one as well.

* additionalProperties: false
    Most common case, where no additional schema is referenced or if this
    binding allows subset of properties from other referenced schemas.

* unevaluatedProperties: false
    Used when this binding references other schema whose all properties
    should be allowed.

* additionalProperties: true
    Rare case, used for schemas implementing common set of properties. Such
    schemas are supposed to be referenced by other schemas, which then use
    'unevaluatedProperties: false'.  Typically bus or common-part schemas.
”h]”(j;  )”}”(hŒ,additionalProperties / unevaluatedProperties”h]”hŒ,additionalProperties / unevaluatedProperties”…””}”(hjÄ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j:  hŸh³h KzhjÀ  ubjK  )”}”(hhh]”(hÊ)”}”(hXQ  Keywords controlling how schema will validate properties not matched by this
schema's 'properties' or 'patternProperties'. Each schema is supposed to
have exactly one of these keywords in top-level part, so either
additionalProperties or unevaluatedProperties. Nested nodes, so properties
being objects, are supposed to have one as well.”h]”hX[  Keywords controlling how schema will validate properties not matched by this
schemaâ€™s â€˜propertiesâ€™ or â€˜patternPropertiesâ€™. Each schema is supposed to
have exactly one of these keywords in top-level part, so either
additionalProperties or unevaluatedProperties. Nested nodes, so properties
being objects, are supposed to have one as well.”…””}”(hjÕ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KihjÒ  ubhŒbullet_list”“”)”}”(hhh]”(hŒ	list_item”“”)”}”(hŒ©additionalProperties: false
  Most common case, where no additional schema is referenced or if this
  binding allows subset of properties from other referenced schemas.
”h]”j0  )”}”(hhh]”j5  )”}”(hŒ¥additionalProperties: false
Most common case, where no additional schema is referenced or if this
binding allows subset of properties from other referenced schemas.
”h]”(j;  )”}”(hŒadditionalProperties: false”h]”hŒadditionalProperties: false”…””}”(hjõ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j:  hŸh³h Kqhjñ  ubjK  )”}”(hhh]”hÊ)”}”(hŒˆMost common case, where no additional schema is referenced or if this
binding allows subset of properties from other referenced schemas.”h]”hŒˆMost common case, where no additional schema is referenced or if this
binding allows subset of properties from other referenced schemas.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kphj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jJ  hjñ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j4  hŸh³h Kqhjî  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j/  hjê  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jè  hjå  ubjé  )”}”(hŒxunevaluatedProperties: false
  Used when this binding references other schema whose all properties
  should be allowed.
”h]”j0  )”}”(hhh]”j5  )”}”(hŒtunevaluatedProperties: false
Used when this binding references other schema whose all properties
should be allowed.
”h]”(j;  )”}”(hŒunevaluatedProperties: false”h]”hŒunevaluatedProperties: false”…””}”(hj7  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j:  hŸh³h Kuhj3  ubjK  )”}”(hhh]”hÊ)”}”(hŒVUsed when this binding references other schema whose all properties
should be allowed.”h]”hŒVUsed when this binding references other schema whose all properties
should be allowed.”…””}”(hjH  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KthjE  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jJ  hj3  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j4  hŸh³h Kuhj0  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j/  hj,  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jè  hjå  ubjé  )”}”(hŒ÷additionalProperties: true
  Rare case, used for schemas implementing common set of properties. Such
  schemas are supposed to be referenced by other schemas, which then use
  'unevaluatedProperties: false'.  Typically bus or common-part schemas.
”h]”j0  )”}”(hhh]”j5  )”}”(hŒñadditionalProperties: true
Rare case, used for schemas implementing common set of properties. Such
schemas are supposed to be referenced by other schemas, which then use
'unevaluatedProperties: false'.  Typically bus or common-part schemas.
”h]”(j;  )”}”(hŒadditionalProperties: true”h]”hŒadditionalProperties: true”…””}”(hjy  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j:  hŸh³h Kzhju  ubjK  )”}”(hhh]”hÊ)”}”(hŒÕRare case, used for schemas implementing common set of properties. Such
schemas are supposed to be referenced by other schemas, which then use
'unevaluatedProperties: false'.  Typically bus or common-part schemas.”h]”hŒÙRare case, used for schemas implementing common set of properties. Such
schemas are supposed to be referenced by other schemas, which then use
â€˜unevaluatedProperties: falseâ€™.  Typically bus or common-part schemas.”…””}”(hjŠ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kxhj‡  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jJ  hju  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j4  hŸh³h Kzhjr  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j/  hjn  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jè  hjå  ubeh}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ*”uh1jã  hŸh³h KohjÒ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jJ  hjÀ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j4  hŸh³h Kzhj_  hžhubj5  )”}”(hX  examples
Optional. A list of one or more DTS hunks implementing this binding only.
Example should not contain unrelated device nodes, e.g. consumer nodes in a
provider binding, other nodes referenced by phandle.
Note: YAML doesn't allow leading tabs, so spaces must be used instead.
”h]”(j;  )”}”(hŒexamples”h]”hŒexamples”…””}”(hjÈ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j:  hŸh³h K€hjÄ  ubjK  )”}”(hhh]”hÊ)”}”(hX  Optional. A list of one or more DTS hunks implementing this binding only.
Example should not contain unrelated device nodes, e.g. consumer nodes in a
provider binding, other nodes referenced by phandle.
Note: YAML doesn't allow leading tabs, so spaces must be used instead.”h]”hX  Optional. A list of one or more DTS hunks implementing this binding only.
Example should not contain unrelated device nodes, e.g. consumer nodes in a
provider binding, other nodes referenced by phandle.
Note: YAML doesnâ€™t allow leading tabs, so spaces must be used instead.”…””}”(hjÙ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K}hjÖ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jJ  hjÄ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j4  hŸh³h K€hj_  hžhubeh}”(h]”h ]”h"]”h$]”h&]”uh1j/  hj  hžhhŸh³h NubhÊ)”}”(hŒ4Unless noted otherwise, all properties are required.”h]”hŒ4Unless noted otherwise, all properties are required.”…””}”(hjù  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K‚hj  hžhubeh}”(h]”Œschema-contents”ah ]”h"]”Œschema contents”ah$]”h&]”uh1h´hh¶hžhhŸh³h Kubhµ)”}”(hhh]”(hº)”}”(hŒProperty Schema”h]”hŒProperty Schema”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj  hžhhŸh³h K…ubhÊ)”}”(hŒõThe 'properties' section of the schema contains all the DT properties for a
binding. Each property contains a set of constraints using json-schema
vocabulary for that property. The properties schemas are what are used for
validation of DT files.”h]”hŒùThe â€˜propertiesâ€™ section of the schema contains all the DT properties for a
binding. Each property contains a set of constraints using json-schema
vocabulary for that property. The properties schemas are what are used for
validation of DT files.”…””}”(hj   hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K‡hj  hžhubhÊ)”}”(hŒ´For common properties, only additional constraints not covered by the common,
binding schema need to be defined such as how many values are valid or what
possible values are valid.”h]”hŒ´For common properties, only additional constraints not covered by the common,
binding schema need to be defined such as how many values are valid or what
possible values are valid.”…””}”(hj.  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KŒhj  hžhubhÊ)”}”(hŒÙVendor-specific properties will typically need more detailed schema. With the
exception of boolean properties, they should have a reference to a type in
schemas/types.yaml. A "description" property is always required.”h]”hŒÝVendor-specific properties will typically need more detailed schema. With the
exception of boolean properties, they should have a reference to a type in
schemas/types.yaml. A â€œdescriptionâ€ property is always required.”…””}”(hj<  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khj  hžhubhÊ)”}”(hX,  The Devicetree schemas don't exactly match the YAML-encoded DT data produced by
dtc. They are simplified to make them more compact and avoid a bunch of
boilerplate. The tools process the schema files to produce the final schema for
validation. There are currently 2 transformations the tools perform.”h]”hX.  The Devicetree schemas donâ€™t exactly match the YAML-encoded DT data produced by
dtc. They are simplified to make them more compact and avoid a bunch of
boilerplate. The tools process the schema files to produce the final schema for
validation. There are currently 2 transformations the tools perform.”…””}”(hjJ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K”hj  hžhubhÊ)”}”(hX[  The default for arrays in json-schema is they are variable-sized and allow more
entries than explicitly defined. This can be restricted by defining 'minItems',
'maxItems', and 'additionalItems'. However, for DeviceTree Schemas, a fixed
size is desired in most cases, so these properties are added based on the
number of entries in an 'items' list.”h]”hXk  The default for arrays in json-schema is they are variable-sized and allow more
entries than explicitly defined. This can be restricted by defining â€˜minItemsâ€™,
â€˜maxItemsâ€™, and â€˜additionalItemsâ€™. However, for DeviceTree Schemas, a fixed
size is desired in most cases, so these properties are added based on the
number of entries in an â€˜itemsâ€™ list.”…””}”(hjX  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K™hj  hžhubhÊ)”}”(hŒãThe YAML Devicetree format also makes all string values an array and scalar
values a matrix (in order to define groupings) even when only a single value
is present. Single entries in schemas are fixed up to match this encoding.”h]”hŒãThe YAML Devicetree format also makes all string values an array and scalar
values a matrix (in order to define groupings) even when only a single value
is present. Single entries in schemas are fixed up to match this encoding.”…””}”(hjf  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KŸhj  hžhubeh}”(h]”Œproperty-schema”ah ]”h"]”Œproperty schema”ah$]”h&]”uh1h´hh¶hžhhŸh³h K…ubhµ)”}”(hhh]”(hº)”}”(hŒCoding style”h]”hŒCoding style”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj|  hžhhŸh³h K¤ubhÊ)”}”(hŒsUse YAML coding style (two-space indentation). For DTS examples in the schema,
preferred is four-space indentation.”h]”hŒsUse YAML coding style (two-space indentation). For DTS examples in the schema,
preferred is four-space indentation.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K¦hj|  hžhubeh}”(h]”Œcoding-style”ah ]”h"]”Œcoding style”ah$]”h&]”uh1h´hh¶hžhhŸh³h K¤ubhµ)”}”(hhh]”(hº)”}”(hŒTesting”h]”hŒTesting”…””}”(hj¦  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj£  hžhhŸh³h Kªubhµ)”}”(hhh]”(hº)”}”(hŒDependencies”h]”hŒDependencies”…””}”(hj·  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj´  hžhhŸh³h K­ubhÊ)”}”(hŒºThe DT schema project must be installed in order to validate the DT schema
binding documents and validate DTS files using the DT schema. The DT schema
project can be installed with pip::”h]”hŒ¹The DT schema project must be installed in order to validate the DT schema
binding documents and validate DTS files using the DT schema. The DT schema
project can be installed with pip:”…””}”(hjÅ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K¯hj´  hžhubhŒliteral_block”“”)”}”(hŒpip3 install dtschema”h]”hŒpip3 install dtschema”…””}”hjÕ  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jÓ  hŸh³h K³hj´  hžhubhÊ)”}”(hŒzNote that 'dtschema' installation requires 'swig' and Python development files
installed first. On Debian/Ubuntu systems::”h]”hŒNote that â€˜dtschemaâ€™ installation requires â€˜swigâ€™ and Python development files
installed first. On Debian/Ubuntu systems:”…””}”(hjã  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kµhj´  hžhubjÔ  )”}”(hŒapt install swig python3-dev”h]”hŒapt install swig python3-dev”…””}”hjñ  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jÓ  hŸh³h K¸hj´  hžhubhÊ)”}”(hŒ‹Several executables (dt-doc-validate, dt-mk-schema, dt-validate) will be
installed. Ensure they are in your PATH (~/.local/bin by default).”h]”hŒ‹Several executables (dt-doc-validate, dt-mk-schema, dt-validate) will be
installed. Ensure they are in your PATH (~/.local/bin by default).”…””}”(hjÿ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kºhj´  hžhubhÊ)”}”(hŒHRecommended is also to install yamllint (used by dtschema when present).”h]”hŒHRecommended is also to install yamllint (used by dtschema when present).”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K½hj´  hžhubeh}”(h]”Œdependencies”ah ]”h"]”Œdependencies”ah$]”h&]”uh1h´hj£  hžhhŸh³h K­ubhµ)”}”(hhh]”(hº)”}”(hŒRunning checks”h]”hŒRunning checks”…””}”(hj&  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj#  hžhhŸh³h KÀubhÊ)”}”(hX   The DT schema binding documents must be validated using the meta-schema (the
schema for the schema) to ensure they are both valid json-schema and valid
binding schema. All of the DT binding documents can be validated using the
``dt_binding_check`` target::”h]”(hŒãThe DT schema binding documents must be validated using the meta-schema (the
schema for the schema) to ensure they are both valid json-schema and valid
binding schema. All of the DT binding documents can be validated using the
”…””}”(hj4  hžhhŸNh NubhŒliteral”“”)”}”(hŒ``dt_binding_check``”h]”hŒdt_binding_check”…””}”(hj>  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j<  hj4  ubhŒ target:”…””}”(hj4  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KÂhj#  hžhubjÔ  )”}”(hŒmake dt_binding_check”h]”hŒmake dt_binding_check”…””}”hjV  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jÓ  hŸh³h KÇhj#  hžhubhÊ)”}”(hŒRIn order to perform validation of DT source files, use the ``dtbs_check`` target::”h]”(hŒ;In order to perform validation of DT source files, use the ”…””}”(hjd  hžhhŸNh Nubj=  )”}”(hŒ``dtbs_check``”h]”hŒ
dtbs_check”…””}”(hjl  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j<  hjd  ubhŒ target:”…””}”(hjd  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KÉhj#  hžhubjÔ  )”}”(hŒmake dtbs_check”h]”hŒmake dtbs_check”…””}”hj„  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jÓ  hŸh³h KËhj#  hžhubhÊ)”}”(hŒ²Note that ``dtbs_check`` will skip any binding schema files with errors. It is
necessary to use ``dt_binding_check`` to get all the validation errors in the
binding schema files.”h]”(hŒ
Note that ”…””}”(hj’  hžhhŸNh Nubj=  )”}”(hŒ``dtbs_check``”h]”hŒ
dtbs_check”…””}”(hjš  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j<  hj’  ubhŒH will skip any binding schema files with errors. It is
necessary to use ”…””}”(hj’  hžhhŸNh Nubj=  )”}”(hŒ``dt_binding_check``”h]”hŒdt_binding_check”…””}”(hj¬  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j<  hj’  ubhŒ> to get all the validation errors in the
binding schema files.”…””}”(hj’  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KÍhj#  hžhubhÊ)”}”(hŒ0It is possible to run both in a single command::”h]”hŒ/It is possible to run both in a single command:”…””}”(hjÄ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KÑhj#  hžhubjÔ  )”}”(hŒ make dt_binding_check dtbs_check”h]”hŒ make dt_binding_check dtbs_check”…””}”hjÒ  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jÓ  hŸh³h KÓhj#  hžhubhÊ)”}”(hŒ÷It is also possible to run checks with a subset of matching schema files by
setting the ``DT_SCHEMA_FILES`` variable to 1 or more specific schema files or
patterns (partial match of a fixed string). Each file or pattern should be
separated by ':'.”h]”(hŒXIt is also possible to run checks with a subset of matching schema files by
setting the ”…””}”(hjà  hžhhŸNh Nubj=  )”}”(hŒ``DT_SCHEMA_FILES``”h]”hŒDT_SCHEMA_FILES”…””}”(hjè  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j<  hjà  ubhŒ variable to 1 or more specific schema files or
patterns (partial match of a fixed string). Each file or pattern should be
separated by â€˜:â€™.”…””}”(hjà  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KÕhj#  hžhubjÔ  )”}”(hŒàmake dt_binding_check DT_SCHEMA_FILES=trivial-devices.yaml
make dt_binding_check DT_SCHEMA_FILES=trivial-devices.yaml:rtc.yaml
make dt_binding_check DT_SCHEMA_FILES=/gpio/
make dtbs_check DT_SCHEMA_FILES=trivial-devices.yaml”h]”hŒàmake dt_binding_check DT_SCHEMA_FILES=trivial-devices.yaml
make dt_binding_check DT_SCHEMA_FILES=trivial-devices.yaml:rtc.yaml
make dt_binding_check DT_SCHEMA_FILES=/gpio/
make dtbs_check DT_SCHEMA_FILES=trivial-devices.yaml”…””}”hj   sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jÓ  hŸh³h KÜhj#  hžhubeh}”(h]”Œrunning-checks”ah ]”h"]”Œrunning checks”ah$]”h&]”uh1h´hj£  hžhhŸh³h KÀubeh}”(h]”Œtesting”ah ]”h"]”Œtesting”ah$]”h&]”uh1h´hh¶hžhhŸh³h Kªubhµ)”}”(hhh]”(hº)”}”(hŒjson-schema Resources”h]”hŒjson-schema Resources”…””}”(hj!  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj  hžhhŸh³h KãubhÊ)”}”(hŒ7`JSON-Schema Specifications <http://json-schema.org/>`_”h]”(jX  )”}”(hj1  h]”hŒJSON-Schema Specifications”…””}”(hj3  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œname”ŒJSON-Schema Specifications”Œrefuri”Œhttp://json-schema.org/”uh1jW  hj/  ubhŒtarget”“”)”}”(hŒ <http://json-schema.org/>”h]”h}”(h]”Œjson-schema-specifications”ah ]”h"]”Œjson-schema specifications”ah$]”h&]”Œrefuri”jC  uh1jD  Œ
referenced”Khj/  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kæhj  hžhubhÊ)”}”(hŒ7`Using JSON Schema Book <http://usingjsonschema.com/>`_”h]”(jX  )”}”(hj\  h]”hŒUsing JSON Schema Book”…””}”(hj^  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œname”ŒUsing JSON Schema Book”jB  Œhttp://usingjsonschema.com/”uh1jW  hjZ  ubjE  )”}”(hŒ <http://usingjsonschema.com/>”h]”h}”(h]”Œusing-json-schema-book”ah ]”h"]”Œusing json schema book”ah$]”h&]”Œrefuri”jm  uh1jD  jS  KhjZ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kèhj  hžhubjE  )”}”(hŒ.. _example-schema:”h]”h}”(h]”h ]”h"]”h$]”h&]”Œrefid”Œexample-schema”uh1jD  h Kêhj  hžhhŸh³ubeh}”(h]”Œjson-schema-resources”ah ]”h"]”Œjson-schema resources”ah$]”h&]”uh1h´hh¶hžhhŸh³h Kãubhµ)”}”(hhh]”(hº)”}”(hŒAnnotated Example Schema”h]”hŒAnnotated Example Schema”…””}”(hj˜  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj•  hžhhŸh³h KíubhÊ)”}”(hŒBAlso available as a separate file: :download:`example-schema.yaml`”h]”(hŒ#Also available as a separate file: ”…””}”(hj¦  hžhhŸNh Nubh Œdownload_reference”“”)”}”(hŒ:download:`example-schema.yaml`”h]”j=  )”}”(hj²  h]”hŒexample-schema.yaml”…””}”(hj´  hžhhŸNh Nubah}”(h]”h ]”(hñŒdownload”eh"]”h$]”h&]”uh1j<  hj°  ubah}”(h]”h ]”h"]”h$]”h&]”Œrefdoc”hþŒ	refdomain”hŒreftype”j¾  Œrefexplicit”‰Œrefwarn”‰j  Œexample-schema.yaml”Œfilename”Œ4bf29fbb4b15af5f11533d4e2b6a0e85b/example-schema.yaml”uh1j®  hŸh³h Kïhj¦  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kïhj•  hžhubjÔ  )”}”(hXÑ#  # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
# Copyright 2018 Linaro Ltd.
%YAML 1.2
---
# All the top-level keys are standard json-schema keywords except for
# 'maintainers' and 'select'

# $id is a unique identifier based on the filename. There may or may not be a
# file present at the URL.
$id: http://devicetree.org/schemas/example-schema.yaml#
# $schema is the meta-schema this schema should be validated with.
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: An Example Device

maintainers:
  - Rob Herring <robh@kernel.org>

description: |
  A more detailed multi-line description of the binding.

  Details about the hardware device and any links to datasheets can go here.

  Literal blocks are marked with the '|' at the beginning. The end is marked by
  indentation less than the first line of the literal block. Lines also cannot
  begin with a tab character.

select: false
  # 'select' is a schema applied to a DT node to determine if this binding
  # schema should be applied to the node. It is optional and by default the
  # possible compatible strings are extracted and used to match.

  # In this case, a 'false' schema will never match.

properties:
  # A dictionary of DT properties for this binding schema
  compatible:
    # More complicated schema can use oneOf (XOR), anyOf (OR), or allOf (AND)
    # to handle different conditions.
    # In this case, it's needed to handle a variable number of values as there
    # isn't another way to express a constraint of the last string value.
    # The boolean schema must be a list of schemas.
    oneOf:
      - items:
          # items is a list of possible values for the property. The number of
          # values is determined by the number of elements in the list.
          # Order in lists is significant, order in dicts is not
          # Must be one of the 1st enums followed by the 2nd enum
          #
          # Each element in items should be 'enum' or 'const'
          - enum:
              - vendor,soc4-ip
              - vendor,soc3-ip
              - vendor,soc2-ip
          - const: vendor,soc1-ip
        # additionalItems being false is implied
        # minItems/maxItems equal to 2 is implied
      - items:
          # 'const' is just a special case of an enum with a single possible value
          - const: vendor,soc1-ip

  reg:
    # The core schema already checks that reg values are numbers, so device
    # specific schema don't need to do those checks.
    # The description of each element defines the order and implicitly defines
    # the number of reg entries.
    items:
      - description: core registers
      - description: aux registers
    # minItems/maxItems equal to 2 is implied

  reg-names:
    # The core schema enforces this (*-names) is a string array
    items:
      - const: core
      - const: aux

  clocks:
    # Cases that have only a single entry just need to express that with maxItems
    maxItems: 1
    description: bus clock. A description is only needed for a single item if
      there's something unique to add.
      The items should have a fixed order, so pattern matching names are
      discouraged.

  clock-names:
    # For single-entry lists in clocks, resets etc., the xxx-names often do not
    # bring any value, especially if they copy the IP block name.  In such case
    # just skip the xxx-names.
    items:
      - const: bus

  interrupts:
    # Either 1 or 2 interrupts can be present
    minItems: 1
    items:
      - description: tx or combined interrupt
      - description: rx interrupt
    description:
      A variable number of interrupts warrants a description of what conditions
      affect the number of interrupts. Otherwise, descriptions on standard
      properties are not necessary.
      The items should have a fixed order, so pattern matching names are
      discouraged.

  interrupt-names:
    # minItems must be specified here because the default would be 2
    minItems: 1
    items:
      - const: tx irq
      - const: rx irq

  # Property names starting with '#' must be quoted
  '#interrupt-cells':
    # A simple case where the value must always be '2'.
    # The core schema handles that this must be a single integer.
    const: 2

  interrupt-controller: true
    # The core checks this is a boolean, so just have to list it here to be
    # valid for this binding.

  clock-frequency:
    # The type is set in the core schema. Per-device schema only need to set
    # constraints on the possible values.
    minimum: 100
    maximum: 400000
    # The value that should be used if the property is not present
    default: 200

  foo-gpios:
    maxItems: 1
    description: A connection of the 'foo' gpio line.

  # *-supply is always a single phandle, so nothing more to define.
  foo-supply: true

  # Vendor-specific properties
  #
  # Vendor-specific properties have slightly different schema requirements than
  # common properties. They must have at least a type definition and
  # 'description'.
  vendor,int-property:
    description: Vendor-specific properties must have a description
    $ref: /schemas/types.yaml#/definitions/uint32
    enum: [2, 4, 6, 8, 10]

  vendor,bool-property:
    description: Vendor-specific properties must have a description. Boolean
      properties are one case where the json-schema 'type' keyword can be used
      directly.
    type: boolean

  vendor,string-array-property:
    description: Vendor-specific properties should reference a type in the
      core schema.
    $ref: /schemas/types.yaml#/definitions/string-array
    items:
      - enum: [foo, bar]
      - enum: [baz, boo]

  vendor,property-in-standard-units-microvolt:
    description: Vendor-specific properties having a standard unit suffix
      don't need a type.
    enum: [ 100, 200, 300 ]

  vendor,int-array-variable-length-and-constrained-values:
    description: Array might define what type of elements might be used (e.g.
      their range).
    $ref: /schemas/types.yaml#/definitions/uint32-array
    minItems: 2
    maxItems: 3
    items:
      minimum: 0
      maximum: 8

  child-node:
    description: Child nodes are just another property from a json-schema
      perspective.
    type: object  # DT nodes are json objects
    # Child nodes also need additionalProperties or unevaluatedProperties
    additionalProperties: false
    properties:
      vendor,a-child-node-property:
        description: Child node properties have all the same schema
          requirements.
        type: boolean

    required:
      - vendor,a-child-node-property

# Describe the relationship between different properties
dependencies:
  # 'vendor,bool-property' is only allowed when 'vendor,string-array-property'
  # is present
  vendor,bool-property: [ 'vendor,string-array-property' ]
  # Expressing 2 properties in both orders means all of the set of properties
  # must be present or none of them.
  vendor,string-array-property: [ 'vendor,bool-property' ]

required:
  - compatible
  - reg
  - interrupts
  - interrupt-controller

# if/then schema can be used to handle conditions on a property affecting
# another property. A typical case is a specific 'compatible' value changes the
# constraints on other properties.
#
# For multiple 'if' schema, group them under an 'allOf'.
#
# If the conditionals become too unweldy, then it may be better to just split
# the binding into separate schema documents.
allOf:
  - if:
      properties:
        compatible:
          contains:
            const: vendor,soc2-ip
    then:
      required:
        - foo-supply
    else:
      # If otherwise the property is not allowed:
      properties:
        foo-supply: false
  # Altering schema depending on presence of properties is usually done by
  # dependencies (see above), however some adjustments might require if:
  - if:
      required:
        - vendor,bool-property
    then:
      properties:
        vendor,int-property:
          enum: [2, 4, 6]

# Ideally, the schema should have this line otherwise any other properties
# present are allowed. There's a few common properties such as 'status' and
# 'pinctrl-*' which are added automatically by the tooling.
#
# This can't be used in cases where another schema is referenced
# (i.e. allOf: [{$ref: ...}]).
# If and only if another schema is referenced and arbitrary children nodes can
# appear, "unevaluatedProperties: false" could be used.  A typical example is
# an I2C controller where no name pattern matching for children can be added.
additionalProperties: false

examples:
  # Examples are now compiled with dtc and validated against the schemas
  #
  # Examples have a default #address-cells and #size-cells value of 1. This can
  # be overridden or an appropriate parent bus node should be shown (such as on
  # i2c buses).
  #
  # Any includes used have to be explicitly included. Use 4-space indentation.
  - |
    node@1000 {
        compatible = "vendor,soc4-ip", "vendor,soc1-ip";
        reg = <0x1000 0x80>,
              <0x3000 0x80>;
        reg-names = "core", "aux";
        interrupts = <10>;
        interrupt-controller;
        #interrupt-cells = <2>;
    };
”h]”hXÑ#  # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
# Copyright 2018 Linaro Ltd.
%YAML 1.2
---
# All the top-level keys are standard json-schema keywords except for
# 'maintainers' and 'select'

# $id is a unique identifier based on the filename. There may or may not be a
# file present at the URL.
$id: http://devicetree.org/schemas/example-schema.yaml#
# $schema is the meta-schema this schema should be validated with.
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: An Example Device

maintainers:
  - Rob Herring <robh@kernel.org>

description: |
  A more detailed multi-line description of the binding.

  Details about the hardware device and any links to datasheets can go here.

  Literal blocks are marked with the '|' at the beginning. The end is marked by
  indentation less than the first line of the literal block. Lines also cannot
  begin with a tab character.

select: false
  # 'select' is a schema applied to a DT node to determine if this binding
  # schema should be applied to the node. It is optional and by default the
  # possible compatible strings are extracted and used to match.

  # In this case, a 'false' schema will never match.

properties:
  # A dictionary of DT properties for this binding schema
  compatible:
    # More complicated schema can use oneOf (XOR), anyOf (OR), or allOf (AND)
    # to handle different conditions.
    # In this case, it's needed to handle a variable number of values as there
    # isn't another way to express a constraint of the last string value.
    # The boolean schema must be a list of schemas.
    oneOf:
      - items:
          # items is a list of possible values for the property. The number of
          # values is determined by the number of elements in the list.
          # Order in lists is significant, order in dicts is not
          # Must be one of the 1st enums followed by the 2nd enum
          #
          # Each element in items should be 'enum' or 'const'
          - enum:
              - vendor,soc4-ip
              - vendor,soc3-ip
              - vendor,soc2-ip
          - const: vendor,soc1-ip
        # additionalItems being false is implied
        # minItems/maxItems equal to 2 is implied
      - items:
          # 'const' is just a special case of an enum with a single possible value
          - const: vendor,soc1-ip

  reg:
    # The core schema already checks that reg values are numbers, so device
    # specific schema don't need to do those checks.
    # The description of each element defines the order and implicitly defines
    # the number of reg entries.
    items:
      - description: core registers
      - description: aux registers
    # minItems/maxItems equal to 2 is implied

  reg-names:
    # The core schema enforces this (*-names) is a string array
    items:
      - const: core
      - const: aux

  clocks:
    # Cases that have only a single entry just need to express that with maxItems
    maxItems: 1
    description: bus clock. A description is only needed for a single item if
      there's something unique to add.
      The items should have a fixed order, so pattern matching names are
      discouraged.

  clock-names:
    # For single-entry lists in clocks, resets etc., the xxx-names often do not
    # bring any value, especially if they copy the IP block name.  In such case
    # just skip the xxx-names.
    items:
      - const: bus

  interrupts:
    # Either 1 or 2 interrupts can be present
    minItems: 1
    items:
      - description: tx or combined interrupt
      - description: rx interrupt
    description:
      A variable number of interrupts warrants a description of what conditions
      affect the number of interrupts. Otherwise, descriptions on standard
      properties are not necessary.
      The items should have a fixed order, so pattern matching names are
      discouraged.

  interrupt-names:
    # minItems must be specified here because the default would be 2
    minItems: 1
    items:
      - const: tx irq
      - const: rx irq

  # Property names starting with '#' must be quoted
  '#interrupt-cells':
    # A simple case where the value must always be '2'.
    # The core schema handles that this must be a single integer.
    const: 2

  interrupt-controller: true
    # The core checks this is a boolean, so just have to list it here to be
    # valid for this binding.

  clock-frequency:
    # The type is set in the core schema. Per-device schema only need to set
    # constraints on the possible values.
    minimum: 100
    maximum: 400000
    # The value that should be used if the property is not present
    default: 200

  foo-gpios:
    maxItems: 1
    description: A connection of the 'foo' gpio line.

  # *-supply is always a single phandle, so nothing more to define.
  foo-supply: true

  # Vendor-specific properties
  #
  # Vendor-specific properties have slightly different schema requirements than
  # common properties. They must have at least a type definition and
  # 'description'.
  vendor,int-property:
    description: Vendor-specific properties must have a description
    $ref: /schemas/types.yaml#/definitions/uint32
    enum: [2, 4, 6, 8, 10]

  vendor,bool-property:
    description: Vendor-specific properties must have a description. Boolean
      properties are one case where the json-schema 'type' keyword can be used
      directly.
    type: boolean

  vendor,string-array-property:
    description: Vendor-specific properties should reference a type in the
      core schema.
    $ref: /schemas/types.yaml#/definitions/string-array
    items:
      - enum: [foo, bar]
      - enum: [baz, boo]

  vendor,property-in-standard-units-microvolt:
    description: Vendor-specific properties having a standard unit suffix
      don't need a type.
    enum: [ 100, 200, 300 ]

  vendor,int-array-variable-length-and-constrained-values:
    description: Array might define what type of elements might be used (e.g.
      their range).
    $ref: /schemas/types.yaml#/definitions/uint32-array
    minItems: 2
    maxItems: 3
    items:
      minimum: 0
      maximum: 8

  child-node:
    description: Child nodes are just another property from a json-schema
      perspective.
    type: object  # DT nodes are json objects
    # Child nodes also need additionalProperties or unevaluatedProperties
    additionalProperties: false
    properties:
      vendor,a-child-node-property:
        description: Child node properties have all the same schema
          requirements.
        type: boolean

    required:
      - vendor,a-child-node-property

# Describe the relationship between different properties
dependencies:
  # 'vendor,bool-property' is only allowed when 'vendor,string-array-property'
  # is present
  vendor,bool-property: [ 'vendor,string-array-property' ]
  # Expressing 2 properties in both orders means all of the set of properties
  # must be present or none of them.
  vendor,string-array-property: [ 'vendor,bool-property' ]

required:
  - compatible
  - reg
  - interrupts
  - interrupt-controller

# if/then schema can be used to handle conditions on a property affecting
# another property. A typical case is a specific 'compatible' value changes the
# constraints on other properties.
#
# For multiple 'if' schema, group them under an 'allOf'.
#
# If the conditionals become too unweldy, then it may be better to just split
# the binding into separate schema documents.
allOf:
  - if:
      properties:
        compatible:
          contains:
            const: vendor,soc2-ip
    then:
      required:
        - foo-supply
    else:
      # If otherwise the property is not allowed:
      properties:
        foo-supply: false
  # Altering schema depending on presence of properties is usually done by
  # dependencies (see above), however some adjustments might require if:
  - if:
      required:
        - vendor,bool-property
    then:
      properties:
        vendor,int-property:
          enum: [2, 4, 6]

# Ideally, the schema should have this line otherwise any other properties
# present are allowed. There's a few common properties such as 'status' and
# 'pinctrl-*' which are added automatically by the tooling.
#
# This can't be used in cases where another schema is referenced
# (i.e. allOf: [{$ref: ...}]).
# If and only if another schema is referenced and arbitrary children nodes can
# appear, "unevaluatedProperties: false" could be used.  A typical example is
# an I2C controller where no name pattern matching for children can be added.
additionalProperties: false

examples:
  # Examples are now compiled with dtc and validated against the schemas
  #
  # Examples have a default #address-cells and #size-cells value of 1. This can
  # be overridden or an appropriate parent bus node should be shown (such as on
  # i2c buses).
  #
  # Any includes used have to be explicitly included. Use 4-space indentation.
  - |
    node@1000 {
        compatible = "vendor,soc4-ip", "vendor,soc1-ip";
        reg = <0x1000 0x80>,
              <0x3000 0x80>;
        reg-names = "core", "aux";
        interrupts = <10>;
        interrupt-controller;
        #interrupt-cells = <2>;
    };
”…””}”hjÖ  sbah}”(h]”h ]”h"]”h$]”h&]”Œsource”ŒQ/var/lib/git/docbuild/linux/Documentation/devicetree/bindings/example-schema.yaml”h±h²Œforce”‰Œhighlight_args”}”Œlinenostart”Ksuh1jÓ  hŸh³h Kñhj•  hžhubeh}”(h]”(Œannotated-example-schema”jŒ  eh ]”h"]”(Œannotated example schema”Œexample-schema”eh$]”h&]”uh1h´hh¶hžhhŸh³h KíŒexpect_referenced_by_name”}”jð  j  sŒexpect_referenced_by_id”}”jŒ  j  subeh}”(h]”Œ*writing-devicetree-bindings-in-json-schema”ah ]”h"]”Œ*writing devicetree bindings in json-schema”ah$]”h&]”uh1h´hhhžhhŸh³h Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”h³uh1hŒcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(h¹NŒ	generator”NŒ	datestamp”NŒsource_link”NŒ
source_url”NŒtoc_backlinks”Œentry”Œfootnote_backlinks”KŒsectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒstrip_classes”NŒreport_level”KŒ
halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ	traceback”ˆŒinput_encoding”Œ	utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”j"  Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œlanguage_code”Œen”Œrecord_dependencies”NŒconfig”NŒ	id_prefix”hŒauto_id_prefix”Œid”Œdump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”h³Œ_destination”NŒ_config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒraw_enabled”KŒline_length_limit”M'Œpep_references”NŒpep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ	tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œdocinfo_xform”KŒsectsubtitle_xform”‰Œimage_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”jŒ  ]”j  asŒnameids”}”(jü  jù  j  j	  jy  jv  j   j  j  j  j   j  j  j  j’  j  jO  jL  jw  jt  jð  jŒ  jï  jì  uŒ	nametypes”}”(jü  ‰j  ‰jy  ‰j   ‰j  ‰j   ‰j  ‰j’  ‰jO  ˆjw  ˆjð  ˆjï  ‰uh}”(jù  h¶j	  j  jv  j  j  j|  j  j£  j  j´  j  j#  j  j  jL  jF  jt  jn  jŒ  j•  jì  j•  uŒfootnote_refs”}”Œcitation_refs”}”Œautofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ	footnotes”]”Œ	citations”]”Œautofootnote_start”KŒsymbol_footnote_start”K Œ
id_counter”Œcollections”ŒCounter”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”hŒsystem_message”“”)”}”(hhh]”hÊ)”}”(hhh]”hŒ4Hyperlink target "example-schema" is not referenced.”…””}”hjŒ  sbah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhj‰  ubah}”(h]”h ]”h"]”h$]”h&]”Œlevel”KŒtype”ŒINFO”Œsource”h³Œline”Kêuh1j‡  ubaŒtransformer”NŒinclude_log”]”Œ
decoration”Nhžhub.