1# Common fields for all devices
2
3include: [pm.yaml]
4
5properties:
6  status:
7    type: string
8    description: |
9      Indicates the operational status of the hardware or other
10      resource that the node represents. In particular:
11
12        - "okay" means the resource is operational and, for example,
13          can be used by device drivers
14        - "disabled" means the resource is not operational and the system
15          should treat it as if it is not present
16
17      For details, see "2.3.4 status" in Devicetree Specification v0.4.
18    enum:
19      - "ok" # Deprecated form
20      - "okay"
21      - "disabled"
22      - "reserved"
23      - "fail"
24      - "fail-sss"
25
26  compatible:
27    type: string-array
28    required: true
29    description: |
30      This property is a list of strings that essentially define what
31      type of hardware or other resource this devicetree node
32      represents. Each device driver checks for specific compatible
33      property values to find the devicetree nodes that represent
34      resources that the driver should manage.
35
36      The recommended format is "vendor,device", The "vendor" part is
37      an abbreviated name of the vendor. The "device" is usually from
38      the datasheet.
39
40      The compatible property can have multiple values, ordered from
41      most- to least-specific. Having additional values is useful when the
42      device is a specific instance of a more general family, to allow the
43      system to match the most specific driver available.
44
45      For details, see "2.3.1 compatible" in Devicetree Specification v0.4.
46
47  reg:
48    type: array
49    description: |
50      Information used to address the device. The value is specific to
51      the device (i.e. is different depending on the compatible
52      property).
53
54      The "reg" property is typically a sequence of (address, length) pairs.
55      Each pair is called a "register block". Values are
56      conventionally written in hex.
57
58      For details, see "2.3.6 reg" in Devicetree Specification v0.4.
59
60  reg-names:
61    type: string-array
62    description: |
63      Optional names given to each register block in the "reg" property.
64      For example:
65
66        / {
67             soc {
68                 #address-cells = <1>;
69                 #size-cells = <1>;
70
71                 uart@1000 {
72                     reg = <0x1000 0x2000>, <0x3000 0x4000>;
73                     reg-names = "foo", "bar";
74                 };
75             };
76        };
77
78      The uart@1000 node has two register blocks:
79
80        - one with base address 0x1000, size 0x2000, and name "foo"
81        - another with base address 0x3000, size 0x4000, and name "bar"
82
83  interrupts:
84    type: array
85    description: |
86      Information about interrupts generated by the device, encoded as an array
87      of one or more interrupt specifiers. The format of the data in this property
88      varies by where the device appears in the interrupt tree. Devices with the same
89      "interrupt-parent" will use the same format in their interrupts properties.
90
91      For details, see "2.4 Interrupts and Interrupt Mapping" in
92      Devicetree Specification v0.4.
93
94  # Does not follow the 'type: phandle-array' scheme, but gets type-checked
95  # by the code. Declare it here just so that other bindings can make it
96  # 'required: true' easily if they want to.
97  interrupts-extended:
98    type: compound
99    description: |
100      Extended interrupt specifier for device, used as an alternative to
101      the "interrupts" property.
102
103      For details, see "2.4 Interrupts and Interrupt Mapping" in
104      Devicetree Specification v0.4.
105
106  interrupt-names:
107    type: string-array
108    description: |
109      Optional names given to each interrupt generated by a device.
110      The interrupts themselves are defined in either "interrupts" or
111      "interrupts-extended" properties.
112
113      For details, see "2.4 Interrupts and Interrupt Mapping" in
114      Devicetree Specification v0.4.
115
116  interrupt-parent:
117    type: phandle
118    description: |
119      If present, this refers to the node which handles interrupts generated
120      by this device.
121
122      For details, see "2.4 Interrupts and Interrupt Mapping" in
123      Devicetree Specification v0.4.
124
125  # description of label should be given in bindings inheriting base.yaml
126  # label property is included here to help enforce its type being string
127  label:
128    type: string
129    description: |
130      Human readable string describing the device. Use of this property is
131      deprecated except as needed on a case-by-case basis.
132
133      For details, see "4.1.2 Miscellaneous Properties" in Devicetree
134      Specification v0.4.
135
136  clocks:
137    type: phandle-array
138    description: |
139      Information about the device's clock providers. In general, this property
140      should follow conventions established in the dt-schema binding:
141
142        https://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/clock/clock.yaml
143
144  clock-names:
145    type: string-array
146    description: |
147      Optional names given to each clock provider in the "clocks" property.
148
149  "#address-cells":
150    type: int
151    description: |
152      This property encodes the number of <u32> cells used by address fields
153      in "reg" properties in this node's children.
154
155      For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
156      Specification v0.4.
157
158  "#size-cells":
159    type: int
160    description: |
161      This property encodes the number of <u32> cells used by size fields in
162      "reg" properties in this node's children.
163
164      For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
165      Specification v0.4.
166
167  dmas:
168    type: phandle-array
169    description: |
170      DMA channel specifiers relevant to the device.
171
172  dma-names:
173    type: string-array
174    description: |
175      Optional names given to the DMA channel specifiers in the "dmas" property.
176
177  io-channels:
178    type: phandle-array
179    description: |
180      IO channel specifiers relevant to the device.
181
182  io-channel-names:
183    type: string-array
184    description: |
185      Optional names given to the IO channel specifiers in the "io-channels" property.
186
187  mboxes:
188    type: phandle-array
189    description: |
190      Mailbox / IPM channel specifiers relevant to the device.
191    specifier-space: mbox
192
193  mbox-names:
194    type: string-array
195    description: |
196      Optional names given to the mbox specifiers in the "mboxes" property.
197
198  power-domains:
199    type: phandle-array
200    description: |
201      Power domain specifiers relevant to the device.
202
203  power-domain-names:
204    type: string-array
205    description: |
206      Optional names given to the power domain specifiers in the "power-domains" property.
207
208  "#power-domain-cells":
209    type: int
210    description: |
211      Number of cells in power-domains property
212
213  zephyr,deferred-init:
214    type: boolean
215    description: |
216      Do not initialize device automatically on boot. Device should be manually
217      initialized using device_init().
218