OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/dts/bindings/device_node.yaml.template

61 lines
1.8 KiB
Plaintext
Raw Normal View History

dts: yaml: Add YAML template file This patch adds a YAML template file that describes the format of a Zephyr device tree YAML specification. Signed-off-by: Andy Gross <andy.gross@linaro.org>
2017-05-24 13:26:04 +08:00
---
title: <Title should describe what node you are describing>
version: 0.1
description: >
Describe in free form text w/ spanning lines what you
are describing
dts: bindings: provide generic yaml description for i2c-devices Provide generic yaml description for i2c-devices such as sensors New yaml binding category 'parent/child' is added. It aims at binding two types of related node such as bus master and bus slave. In case of i2c-device object, parent property is 'bus' with value 'i2c'. In the mean time, i2c node gets child property bus. Master and slave bus values should match. As such, 'i2c' node is bus master and 'i2c-devices' nodes are bus slaves Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
2017-10-19 22:31:44 +08:00
< parent | child >:
# parent/child is used to document implicit relation between nodes.
# This information is required to generate parent related bits in child
# attributes.
# In case parent has 'bus', slave inherits some information from master.
# parent and child should share same bus-type value.
bus: <bus-type>
dts: yaml: Add YAML template file This patch adds a YAML template file that describes the format of a Zephyr device tree YAML specification. Signed-off-by: Andy Gross <andy.gross@linaro.org>
2017-05-24 13:26:04 +08:00
# properties will be the contents of the device tree node
# property names must match the property names in the DT
properties:
# A typical property entry will look like the following
yaml: fix properties syntax to 'mapping' instead of 'series' According to yaml syntaxic rules, 'properties' described in dts bindings yaml files could be seen as 'mapping'(key/value couple), instead of 'series' (list of single elements). yaml 'mappings' will then be converted by yaml python library as python 'dict' which will ease treatment (instead of current list as were before this commit). Same treatment is applied to 'inherits'. script extract_dts_inlcude is updated to take change of yaml_list structre into account. This allows some code simplification. Largest impact is yaml_collapse function which works now allow complete overload method on all the attributes of a yaml nodes. Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
2017-11-23 15:48:10 +08:00
# <name of property as it is in device tree>
dts: yaml: Add YAML template file This patch adds a YAML template file that describes the format of a Zephyr device tree YAML specification. Signed-off-by: Andy Gross <andy.gross@linaro.org>
2017-05-24 13:26:04 +08:00
# category: <required | optional>
# type: <string | int | array>
# description: <description of property>
# generation: <define | structure>
# At a minimum, the compatible is required for matching nodes
yaml: fix properties syntax to 'mapping' instead of 'series' According to yaml syntaxic rules, 'properties' described in dts bindings yaml files could be seen as 'mapping'(key/value couple), instead of 'series' (list of single elements). yaml 'mappings' will then be converted by yaml python library as python 'dict' which will ease treatment (instead of current list as were before this commit). Same treatment is applied to 'inherits'. script extract_dts_inlcude is updated to take change of yaml_list structre into account. This allows some code simplification. Largest impact is yaml_collapse function which works now allow complete overload method on all the attributes of a yaml nodes. Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
2017-11-23 15:48:10 +08:00
compatible: <list of string compatible matches>
dts: yaml: Add YAML template file This patch adds a YAML template file that describes the format of a Zephyr device tree YAML specification. Signed-off-by: Andy Gross <andy.gross@linaro.org>
2017-05-24 13:26:04 +08:00
category: required
type: string
description: compatible of node
# reg is used to denote mmio registers
yaml: fix properties syntax to 'mapping' instead of 'series' According to yaml syntaxic rules, 'properties' described in dts bindings yaml files could be seen as 'mapping'(key/value couple), instead of 'series' (list of single elements). yaml 'mappings' will then be converted by yaml python library as python 'dict' which will ease treatment (instead of current list as were before this commit). Same treatment is applied to 'inherits'. script extract_dts_inlcude is updated to take change of yaml_list structre into account. This allows some code simplification. Largest impact is yaml_collapse function which works now allow complete overload method on all the attributes of a yaml nodes. Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
2017-11-23 15:48:10 +08:00
reg:
dts: yaml: Add YAML template file This patch adds a YAML template file that describes the format of a Zephyr device tree YAML specification. Signed-off-by: Andy Gross <andy.gross@linaro.org>
2017-05-24 13:26:04 +08:00
type: array
description: mmio register space
generation: define
category: required
# interrupts specifies the interrupts that the driver may utilize
yaml: fix properties syntax to 'mapping' instead of 'series' According to yaml syntaxic rules, 'properties' described in dts bindings yaml files could be seen as 'mapping'(key/value couple), instead of 'series' (list of single elements). yaml 'mappings' will then be converted by yaml python library as python 'dict' which will ease treatment (instead of current list as were before this commit). Same treatment is applied to 'inherits'. script extract_dts_inlcude is updated to take change of yaml_list structre into account. This allows some code simplification. Largest impact is yaml_collapse function which works now allow complete overload method on all the attributes of a yaml nodes. Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
2017-11-23 15:48:10 +08:00
interrupts:
dts: yaml: Add YAML template file This patch adds a YAML template file that describes the format of a Zephyr device tree YAML specification. Signed-off-by: Andy Gross <andy.gross@linaro.org>
2017-05-24 13:26:04 +08:00
type: array
category: required
description: required interrupts
generation: define
# If a node is a interrupt controller, gpio controller, pinmux device
# or any device which is referenced via phandle plus some number of cells
# then the cell fiels below must be present.
cell_string: <cell string prefix>
"#cells":
- cell0 # name of first cell
- cell1 # name of second cell
- cell2 # name of third cell
- and so on and so forth
...