Skip to content

Commit 1305ad9

Browse files
Andy GrossAnas Nashif
authored andcommitted
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 <[email protected]>
1 parent 2747242 commit 1305ad9

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: <Title should describe what node you are describing>
3+
version: 0.1
4+
5+
description: >
6+
Describe in free form text w/ spanning lines what you
7+
are describing
8+
9+
# properties will be the contents of the device tree node
10+
# property names must match the property names in the DT
11+
12+
properties:
13+
14+
# A typical property entry will look like the following
15+
# - <name of property as it is in device tree>
16+
# category: <required | optional>
17+
# type: <string | int | array>
18+
# description: <description of property>
19+
# generation: <define | structure>
20+
21+
# At a minimum, the compatible is required for matching nodes
22+
- compatible: <list of string compatible matches>
23+
category: required
24+
type: string
25+
description: compatible of node
26+
27+
# reg is used to denote mmio registers
28+
- reg:
29+
type: array
30+
description: mmio register space
31+
generation: define
32+
category: required
33+
34+
# interrupts specifies the interrupts that the driver may utilize
35+
- interrupts:
36+
type: array
37+
category: required
38+
description: required interrupts
39+
generation: define
40+
41+
# If a node is a interrupt controller, gpio controller, pinmux device
42+
# or any device which is referenced via phandle plus some number of cells
43+
# then the cell fiels below must be present.
44+
cell_string: <cell string prefix>
45+
46+
"#cells":
47+
- cell0 # name of first cell
48+
- cell1 # name of second cell
49+
- cell2 # name of third cell
50+
- and so on and so forth
51+
...

0 commit comments

Comments
 (0)