Macros
#define	DT_NODE_EXISTS(node_id) IS_ENABLED(DT_CAT(node_id, _EXISTS))
	Does a node identifier refer to a node?

#define	DT_NODE_HAS_STATUS(node_id, status) DT_NODE_HAS_STATUS_INTERNAL(node_id, status)
	Does a node identifier refer to a node with a status?

#define	DT_NODE_HAS_STATUS_OKAY(node_id) DT_NODE_HAS_STATUS(node_id, okay)
	Does a node identifier refer to a node with a status `okay`?

#define	DT_HAS_COMPAT_STATUS_OKAY(compat) IS_ENABLED(DT_CAT(DT_COMPAT_HAS_OKAY_, compat))
	Does the devicetree have a status `okay` node with a compatible?

#define	DT_NUM_INST_STATUS_OKAY(compat)
	Get the number of instances of a given compatible with status `okay`

#define	DT_NODE_HAS_COMPAT(node_id, compat) IS_ENABLED(DT_CAT3(node_id, _COMPAT_MATCHES_, compat))
	Does a devicetree node match a compatible?

#define	DT_NODE_HAS_COMPAT_STATUS(node_id, compat, status) UTIL_AND(DT_NODE_HAS_COMPAT(node_id, compat), DT_NODE_HAS_STATUS(node_id, status))
	Does a devicetree node have a compatible and status?

#define	DT_NODE_HAS_PROP(node_id, prop) IS_ENABLED(DT_CAT4(node_id, _P_, prop, _EXISTS))
	Does a devicetree node have a property?

#define	DT_PHA_HAS_CELL_AT_IDX(node_id, pha, idx, cell)
	Does a phandle array have a named cell specifier at an index?

#define	DT_PHA_HAS_CELL(node_id, pha, cell) DT_PHA_HAS_CELL_AT_IDX(node_id, pha, 0, cell)
	Equivalent to DT_PHA_HAS_CELL_AT_IDX(node_id, pha, 0, cell)

#define	DT_FOREACH_PHA_CELL_BY_IDX(node_id, pha, idx, fn) DT_CAT6(node_id, _P_, pha, _IDX_, idx, _FOREACH_CELL)(fn)
	Iterate over all cells in a phandle array element by index.

#define	DT_FOREACH_PHA_CELL_BY_IDX_SEP(node_id, pha, idx, fn, sep) DT_CAT6(node_id, _P_, pha, _IDX_, idx, _FOREACH_CELL_SEP)(fn, sep)
	Iterate over all cells in a phandle array element by index with separator.

#define	DT_PHA_NUM_CELLS_BY_IDX(node_id, pha, idx) DT_CAT6(node_id, _P_, pha, _IDX_, idx, _NUM_CELLS)
	Get the number of cells in a phandle array element by index.

#define	DT_PHA_ELEM_NAME_BY_IDX(node_id, pha, idx) DT_CAT6(node_id, _P_, pha, _IDX_, idx, _NAME)
	Get the name of a phandle array element by index.

#define	DT_FOREACH_PHA_CELL_BY_NAME(node_id, pha, name, fn) DT_CAT6(node_id, _P_, pha, _NAME_, name, _FOREACH_CELL)(fn)
	Iterate over all cells in a phandle array element by name.

#define	DT_FOREACH_PHA_CELL_BY_NAME_SEP(node_id, pha, name, fn, sep) DT_CAT6(node_id, _P_, pha, _NAME_, name, _FOREACH_CELL_SEP)(fn, sep)
	Iterate over all cells in a phandle array element by name with separator.

#define	DT_PHA_NUM_CELLS_BY_NAME(node_id, pha, name) DT_CAT6(node_id, _P_, pha, _NAME_, name, _NUM_CELLS)
	Get the number of cells in a phandle array element by name.

#define	DT_PHA_ELEM_IDX_BY_NAME(node_id, pha, name) DT_CAT6(node_id, _P_, pha, _NAME_, name, _IDX)
	Get the index of a phandle array element by name.

Detailed Description

Macro Definition Documentation

◆ DT_FOREACH_PHA_CELL_BY_IDX

#define DT_FOREACH_PHA_CELL_BY_IDX	(	node_id,
		pha,
		idx,
		fn
	)	DT_CAT6(node_id, _P_, pha, _IDX_, idx, _FOREACH_CELL)(fn)

#include <include/zephyr/devicetree.h>

Iterate over all cells in a phandle array element by index.

This macro calls fn(cell_value) for each cell value in the phandle array element at index idx.

In general, this macro expands to:

fn(node_id, pha, idx, cell[0]) fn(node_id, pha, idx, cell[1]) [...]
fn(node_id, pha, idx, cell[n-1])

where n is the number of cells in pha, as it would be returned by DT_PHA_NUM_CELLS_BY_IDX(node_id, pha, idx), and cell[x] is the NAME of the cell in the specifier.

Parameters

node_id	node identifier
pha	lowercase-and-underscores property with type `phandle-array`
idx	index of the phandle array element
fn	macro to call for each cell value

◆ DT_FOREACH_PHA_CELL_BY_IDX_SEP

#define DT_FOREACH_PHA_CELL_BY_IDX_SEP	(	node_id,
		pha,
		idx,
		fn,
		sep
	)	DT_CAT6(node_id, _P_, pha, _IDX_, idx, _FOREACH_CELL_SEP)(fn, sep)

#include <include/zephyr/devicetree.h>

Iterate over all cells in a phandle array element by index with separator.

This is like DT_FOREACH_PHA_CELL_BY_IDX(), but sep is placed between each invocation of fn.

Parameters

node_id	node identifier
pha	lowercase-and-underscores property with type `phandle-array`
idx	index of the phandle array element
fn	macro to call for each cell value
sep	separator (e.g. comma or semicolon)

◆ DT_FOREACH_PHA_CELL_BY_NAME

#define DT_FOREACH_PHA_CELL_BY_NAME	(	node_id,
		pha,
		name,
		fn
	)	DT_CAT6(node_id, _P_, pha, _NAME_, name, _FOREACH_CELL)(fn)

#include <include/zephyr/devicetree.h>

Iterate over all cells in a phandle array element by name.

This macro calls fn(cell_value) for each cell value in the phandle array pha element with the given name in the *-names property.

In general, this macro expands to:

fn(node_id, pha, name, cell[0]) fn(node_id, pha, idx, cell[1]) [...]
fn(node_id, pha, idx, cell[n-1])

where n is the number of cells in pha, as it would be returned by DT_PHA_NUM_CELLS_BY_NAME(node_id, pha, name), and cell[x] is the NAME of the cell in the specifier.

Parameters

node_id	node identifier
pha	lowercase-and-underscores property with type `phandle-array`
name	lowercase-and-underscores name of the phandle array element
fn	macro to call for each cell value

◆ DT_FOREACH_PHA_CELL_BY_NAME_SEP

#define DT_FOREACH_PHA_CELL_BY_NAME_SEP	(	node_id,
		pha,
		name,
		fn,
		sep
	)	DT_CAT6(node_id, _P_, pha, _NAME_, name, _FOREACH_CELL_SEP)(fn, sep)

#include <include/zephyr/devicetree.h>

Iterate over all cells in a phandle array element by name with separator.

This is like DT_FOREACH_PHA_CELL_BY_NAME(), but sep is placed between each invocation of fn.

Parameters

node_id	node identifier
pha	lowercase-and-underscores property with type `phandle-array`
name	lowercase-and-underscores name of the phandle array element
fn	macro to call for each cell value
sep	separator (e.g. comma or semicolon)

◆ DT_HAS_COMPAT_STATUS_OKAY

#define DT_HAS_COMPAT_STATUS_OKAY ( compat ) IS_ENABLED(DT_CAT(DT_COMPAT_HAS_OKAY_, compat))

#include <include/zephyr/devicetree.h>

Does the devicetree have a status okay node with a compatible?

Test for whether the devicetree has any nodes with status okay and the given compatible. That is, this returns 1 if and only if there is at least one node_id for which both of these expressions return 1:

DT_NODE_HAS_STATUS(node_id, okay)

DT_NODE_HAS_COMPAT(node_id, compat)

DT_NODE_HAS_STATUS

#define DT_NODE_HAS_STATUS(node_id, status)

Does a node identifier refer to a node with a status?

Definition devicetree.h:3667

DT_NODE_HAS_COMPAT

#define DT_NODE_HAS_COMPAT(node_id, compat)

Does a devicetree node match a compatible?

Definition devicetree.h:3751

As usual, both a missing status and an ok status are treated as okay.

Parameters

compat lowercase-and-underscores compatible, without quotes

Returns: 1 if both of the above conditions are met, 0 otherwise

◆ DT_NODE_EXISTS

#define DT_NODE_EXISTS ( node_id ) IS_ENABLED(DT_CAT(node_id, _EXISTS))

#include <include/zephyr/devicetree.h>

Does a node identifier refer to a node?

Tests whether a node identifier refers to a node which exists, i.e. is defined in the devicetree.

It doesn't matter whether or not the node has a matching binding, or what the node's status value is. This is purely a check of whether the node exists at all.

Parameters

node_id a node identifier

Returns: 1 if the node identifier refers to a node, 0 otherwise.

◆ DT_NODE_HAS_COMPAT

#define DT_NODE_HAS_COMPAT	(	node_id,
		compat
	)	IS_ENABLED(DT_CAT3(node_id, _COMPAT_MATCHES_, compat))

#include <include/zephyr/devicetree.h>

Does a devicetree node match a compatible?

Example devicetree fragment:

n: node {
        compatible = "vnd,specific-device", "generic-device";
}

Example usages which evaluate to 1:

DT_NODE_HAS_COMPAT(DT_NODELABEL(n), vnd_specific_device)

DT_NODE_HAS_COMPAT(DT_NODELABEL(n), generic_device)

DT_NODELABEL

#define DT_NODELABEL(label)

Get a node identifier for a node label.

Definition devicetree.h:196

This macro only uses the value of the compatible property. Whether or not a particular compatible has a matching binding has no effect on its value, nor does the node's status.

Parameters

node_id	node identifier
compat	lowercase-and-underscores compatible, without quotes

Returns: 1 if the node's compatible property contains compat, 0 otherwise.

◆ DT_NODE_HAS_COMPAT_STATUS

#define DT_NODE_HAS_COMPAT_STATUS	(	node_id,
		compat,
		status
	)	UTIL_AND(DT_NODE_HAS_COMPAT(node_id, compat), DT_NODE_HAS_STATUS(node_id, status))

#include <include/zephyr/devicetree.h>

Does a devicetree node have a compatible and status?

This is equivalent to:

(DT_NODE_HAS_COMPAT(node_id, compat) &&

DT_NODE_HAS_STATUS(node_id, status))

Parameters

node_id	node identifier
compat	lowercase-and-underscores compatible, without quotes
status	okay or disabled as a token, not a string

◆ DT_NODE_HAS_PROP

#define DT_NODE_HAS_PROP	(	node_id,
		prop
	)	IS_ENABLED(DT_CAT4(node_id, _P_, prop, _EXISTS))

#include <include/zephyr/devicetree.h>

Does a devicetree node have a property?

Tests whether a devicetree node has a property defined.

This tests whether the property is defined at all, not whether a boolean property is true or false. To get a boolean property's truth value, use DT_PROP(node_id, prop) instead.

Parameters

node_id	node identifier
prop	lowercase-and-underscores property name

Returns: 1 if the node has the property, 0 otherwise.

◆ DT_NODE_HAS_STATUS

#define DT_NODE_HAS_STATUS	(	node_id,
		status
	)	DT_NODE_HAS_STATUS_INTERNAL(node_id, status)

#include <include/zephyr/devicetree.h>

Does a node identifier refer to a node with a status?

Example uses:

DT_NODE_HAS_STATUS(DT_PATH(soc, i2c_12340000), okay)

DT_NODE_HAS_STATUS(DT_PATH(soc, i2c_12340000), disabled)

DT_PATH

#define DT_PATH(...)

Get a node identifier for a devicetree path.

Definition devicetree.h:140

Tests whether a node identifier refers to a node which:

exists in the devicetree, and
has a status property matching the second argument (except that either a missing status or an ok status in the devicetree is treated as if it were okay instead)

Parameters

node_id	a node identifier
status	a status as one of the tokens okay or disabled, not a string

Returns: 1 if the node has the given status, 0 otherwise.

◆ DT_NODE_HAS_STATUS_OKAY

#define DT_NODE_HAS_STATUS_OKAY ( node_id ) DT_NODE_HAS_STATUS(node_id, okay)

#include <include/zephyr/devicetree.h>

Does a node identifier refer to a node with a status okay?

Example uses:

DT_NODE_HAS_STATUS_OKAY(DT_PATH(soc, i2c_12340000))

DT_NODE_HAS_STATUS_OKAY

#define DT_NODE_HAS_STATUS_OKAY(node_id)

Does a node identifier refer to a node with a status okay?

Definition devicetree.h:3690

Tests whether a node identifier refers to a node which:

exists in the devicetree, and
has a status property as okay

As usual, both a missing status and an ok status are treated as okay.

Parameters

node_id a node identifier

Returns: 1 if the node has status as okay, 0 otherwise.

◆ DT_NUM_INST_STATUS_OKAY

#define DT_NUM_INST_STATUS_OKAY ( compat )

#include <include/zephyr/devicetree.h>

Value:

UTIL_AND(DT_HAS_COMPAT_STATUS_OKAY(compat), \

UTIL_CAT(DT_N_INST, DT_DASH(compat, NUM_OKAY)))

DT_HAS_COMPAT_STATUS_OKAY

#define DT_HAS_COMPAT_STATUS_OKAY(compat)

Does the devicetree have a status okay node with a compatible?

Definition devicetree.h:3711

UTIL_AND

#define UTIL_AND(a, b)

Like a && b, but does evaluation and short-circuiting at C preprocessor time.

Definition util_macro.h:427

UTIL_CAT

#define UTIL_CAT(a,...)

Definition util_internal.h:104

Get the number of instances of a given compatible with status okay

Parameters

compat lowercase-and-underscores compatible, without quotes

Returns: Number of instances with status okay

◆ DT_PHA_ELEM_IDX_BY_NAME

#define DT_PHA_ELEM_IDX_BY_NAME	(	node_id,
		pha,
		name
	)	DT_CAT6(node_id, _P_, pha, _NAME_, name, _IDX)

#include <include/zephyr/devicetree.h>

Get the index of a phandle array element by name.

This returns the index of the pha which has the name name in the corresponding *-names property.

Parameters

node_id	node identifier
pha	lowercase-and-underscores property with type `phandle-array`
name	lowercase-and-underscores name of the phandle array element

Returns: index of the element with the given name

◆ DT_PHA_ELEM_NAME_BY_IDX

#define DT_PHA_ELEM_NAME_BY_IDX	(	node_id,
		pha,
		idx
	)	DT_CAT6(node_id, _P_, pha, _IDX_, idx, _NAME)

#include <include/zephyr/devicetree.h>

Get the name of a phandle array element by index.

This returns the name in the *-names property of the node corresponding to the index idx of pha

Parameters

node_id	node identifier
pha	lowercase-and-underscores property with type `phandle-array`
idx	index of the phandle array element

Returns: name of the element at index idx

◆ DT_PHA_HAS_CELL

#define DT_PHA_HAS_CELL	(	node_id,
		pha,
		cell
	)	DT_PHA_HAS_CELL_AT_IDX(node_id, pha, 0, cell)

#include <include/zephyr/devicetree.h>

Equivalent to DT_PHA_HAS_CELL_AT_IDX(node_id, pha, 0, cell)

Parameters

node_id	node identifier
pha	lowercase-and-underscores property with type `phandle-array`
cell	lowercase-and-underscores cell name whose existence to check at index `idx`

Returns: 1 if the named cell exists in the specifier at index 0, 0 otherwise.

◆ DT_PHA_HAS_CELL_AT_IDX

#define DT_PHA_HAS_CELL_AT_IDX	(	node_id,
		pha,
		idx,
		cell
	)

#include <include/zephyr/devicetree.h>

Value:

IS_ENABLED(DT_CAT8(node_id, _P_, pha, \

_IDX_, idx, _VAL_, cell, _EXISTS))

IS_ENABLED

#define IS_ENABLED(config_macro)

Check for macro definition in compiler-visible expressions.

Definition util_macro.h:148

Does a phandle array have a named cell specifier at an index?

If this returns 1, then the phandle-array property pha has a cell named cell at index idx, and therefore DT_PHA_BY_IDX(node_id, pha, idx, cell) is valid. If it returns 0, it's an error to use DT_PHA_BY_IDX() with the same arguments.

Parameters

node_id	node identifier
pha	lowercase-and-underscores property with type `phandle-array`
idx	index to check within `pha`
cell	lowercase-and-underscores cell name whose existence to check at index `idx`

Returns: 1 if the named cell exists in the specifier at index idx, 0 otherwise.

◆ DT_PHA_NUM_CELLS_BY_IDX

#define DT_PHA_NUM_CELLS_BY_IDX	(	node_id,
		pha,
		idx
	)	DT_CAT6(node_id, _P_, pha, _IDX_, idx, _NUM_CELLS)

#include <include/zephyr/devicetree.h>

Get the number of cells in a phandle array element by index.

Parameters

node_id	node identifier
pha	lowercase-and-underscores property with type `phandle-array`
idx	index of the phandle array element

Returns: number of cells in the element at index idx

◆ DT_PHA_NUM_CELLS_BY_NAME

#define DT_PHA_NUM_CELLS_BY_NAME	(	node_id,
		pha,
		name
	)	DT_CAT6(node_id, _P_, pha, _NAME_, name, _NUM_CELLS)

#include <include/zephyr/devicetree.h>

Get the number of cells in a phandle array element by name.

Parameters

node_id	node identifier
pha	lowercase-and-underscores property with type `phandle-array`
name	lowercase-and-underscores name of the phandle array element

Returns: number of cells in the element with the given name

Macros

Detailed Description

Macro Definition Documentation

◆ DT_FOREACH_PHA_CELL_BY_IDX

◆ DT_FOREACH_PHA_CELL_BY_IDX_SEP

◆ DT_FOREACH_PHA_CELL_BY_NAME

◆ DT_FOREACH_PHA_CELL_BY_NAME_SEP

◆ DT_HAS_COMPAT_STATUS_OKAY

◆ DT_NODE_EXISTS

◆ DT_NODE_HAS_COMPAT

◆ DT_NODE_HAS_COMPAT_STATUS

◆ DT_NODE_HAS_PROP

◆ DT_NODE_HAS_STATUS

◆ DT_NODE_HAS_STATUS_OKAY

◆ DT_NUM_INST_STATUS_OKAY

◆ DT_PHA_ELEM_IDX_BY_NAME

◆ DT_PHA_ELEM_NAME_BY_IDX

◆ DT_PHA_HAS_CELL

◆ DT_PHA_HAS_CELL_AT_IDX

◆ DT_PHA_NUM_CELLS_BY_IDX

◆ DT_PHA_NUM_CELLS_BY_NAME