michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: dts: macros.bnf: add docs for new for-each macros

Browse source 
Document the new DT_FOREACH_OKAY_INST_<compat> and
DT_FOREACH_OKAY_INST_VARGS_<compat> macros that are generated by
gen_defines.py and explain how they are used in devicetree.h.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
This commit is contained in:
Martí Bolívar 2021-08-05 15:45:06 -07:00 • committed by Kumar Gala
commit fd73eb8b60
1 changed files with 4 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/guides/dts/macros.bnf
View file

@ -167,6 +167,10 @@ prop-suf = 1*( "_" gen-name ["_" dt-name] )
other-macro = %s"DT_N_" alternate-id
; Total count of enabled instances of a compatible.
other-macro =/ %s"DT_N_INST_" dt-name %s"_NUM_OKAY"
; These are used internally by DT_FOREACH_STATUS_OKAY,
; which iterates over each enabled node of a compatible.
other-macro =/ %s"DT_FOREACH_OKAY_" dt-name
other-macro =/ %s"DT_FOREACH_OKAY_VARGS_" dt-name
; These are used internally by DT_INST_FOREACH_STATUS_OKAY,
; which iterates over each enabled instance of a compatible.
other-macro =/ %s"DT_FOREACH_OKAY_INST_" dt-name