Devicetree WUC Controller API

Macros
#define	DT_WUC_BY_IDX(node_id, idx)
	Get the node identifier for the controller phandle from a "wakeup-ctrls" phandle-array property at an index.
#define	DT_WUC(node_id)
	Equivalent to DT_WUC_BY_IDX(node_id, 0).
#define	DT_WUC_CELL_BY_IDX(node_id, idx, cell)
	Get a wakeup controller specifier's cell value at an index.
#define	DT_WUC_CELL(node_id, cell)
	Equivalent to DT_WUC_CELL_BY_IDX(node_id, 0, cell).
#define	DT_INST_WUC_BY_IDX(inst, idx)
	Get the node identifier for the controller phandle from a "wakeup-ctrls" phandle-array property at an index.
#define	DT_INST_WUC(inst)
	Equivalent to DT_INST_WUC_BY_IDX(inst, 0).
#define	DT_INST_WUC_CELL_BY_IDX(inst, idx, cell)
	Get a DT_DRV_COMPAT instance's wakeup controller specifier's cell value at an index.
#define	DT_INST_WUC_CELL(inst, cell)
	Equivalent to DT_INST_WUC_CELL_BY_IDX(inst, 0, cell).
#define	DT_WUC_ID_BY_IDX(node_id, idx)
	Get a Wakeup Controller specifier's id cell at an index.
#define	DT_WUC_ID(node_id)
	Equivalent to DT_WUC_ID_BY_IDX(node_id, 0).
#define	DT_INST_WUC_ID_BY_IDX(inst, idx)
	Get a DT_DRV_COMPAT instance's Wakeup Controller specifier's id cell value at an index.
#define	DT_INST_WUC_ID(inst)
	Equivalent to DT_INST_WUC_ID_BY_IDX(inst, 0).

Detailed Description

Macro Definition Documentation

DT_INST_WUC

#define DT_INST_WUC

(

inst

)

#include <zephyr/devicetree/wuc.h>

Value:

DT_INST_WUC_BY_IDX(inst, 0)

Equivalent to DT_INST_WUC_BY_IDX(inst, 0).

Parameters

inst	instance number

Returns

a node identifier for the wakeup controller at index 0 in "wakeup-ctrls"

See also

DT_WUC_BY_IDX()

DT_INST_WUC_BY_IDX

#define DT_INST_WUC_BY_IDX	(		inst,
			idx )

#include <zephyr/devicetree/wuc.h>

Value:

DT_WUC_BY_IDX(DT_DRV_INST(inst), idx)

Get the node identifier for the controller phandle from a "wakeup-ctrls" phandle-array property at an index.

Parameters

inst	instance number
idx	logical index into "wakeup-ctrls"

Returns

the node identifier for the wakeup controller referenced at index "idx"

See also

DT_WUC_BY_IDX()

DT_INST_WUC_CELL

#define DT_INST_WUC_CELL	(		inst,
			cell )

#include <zephyr/devicetree/wuc.h>

Value:

DT_INST_WUC_CELL_BY_IDX(inst, 0, cell)

Equivalent to DT_INST_WUC_CELL_BY_IDX(inst, 0, cell).

Parameters

inst	DT_DRV_COMPAT instance number
cell	lowercase-and-underscores cell name

Returns

the value of the cell inside the specifier at index 0

DT_INST_WUC_CELL_BY_IDX

#define DT_INST_WUC_CELL_BY_IDX	(		inst,
			idx,
			cell )

#include <zephyr/devicetree/wuc.h>

Value:

DT_WUC_CELL_BY_IDX(DT_DRV_INST(inst), idx, cell)

Get a DT_DRV_COMPAT instance's wakeup controller specifier's cell value at an index.

Parameters

inst	DT_DRV_COMPAT instance number
idx	logical index into wakeup-ctrls property
cell	lowercase-and-underscores cell name

Returns

the cell value at index "idx"

See also

DT_WUC_CELL_BY_IDX()

DT_INST_WUC_ID

#define DT_INST_WUC_ID

(

inst

)

#include <zephyr/devicetree/wuc.h>

Value:

DT_INST_WUC_ID_BY_IDX(inst, 0)

Equivalent to DT_INST_WUC_ID_BY_IDX(inst, 0).

Parameters

inst	DT_DRV_COMPAT instance number

Returns

the id cell value at index 0

See also

DT_INST_WUC_ID_BY_IDX()

DT_INST_WUC_ID_BY_IDX

#define DT_INST_WUC_ID_BY_IDX	(		inst,
			idx )

#include <zephyr/devicetree/wuc.h>

Value:

DT_WUC_ID_BY_IDX(DT_DRV_INST(inst), idx)

Get a DT_DRV_COMPAT instance's Wakeup Controller specifier's id cell value at an index.

Parameters

inst	DT_DRV_COMPAT instance number
idx	logical index into "wakeup-ctrls"

Returns

the id cell value at index "idx"

See also

DT_WUC_ID_BY_IDX()

DT_WUC

#define DT_WUC

(

node_id

)

#include <zephyr/devicetree/wuc.h>

Value:

DT_WUC_BY_IDX(node_id, 0)

Equivalent to DT_WUC_BY_IDX(node_id, 0).

Parameters

node_id

node identifier

Returns

a node identifier for the wakeup controller at index 0 in "wakeup-ctrls"

See also

DT_WUC_BY_IDX()

DT_WUC_BY_IDX

#define DT_WUC_BY_IDX	(		node_id,
			idx )

#include <zephyr/devicetree/wuc.h>

Value:

DT_PHANDLE_BY_IDX(node_id, wakeup_ctrls, idx)

Get the node identifier for the controller phandle from a "wakeup-ctrls" phandle-array property at an index.

Example devicetree fragment:

wuc1: wakeup-controller@... { ... };

wuc2: wakeup-controller@... { ... };

n: node {
        wakeup-ctrls = <&wuc1 10>, <&wuc2 20>;
};

Example usage:

DT_WUC_BY_IDX(DT_NODELABEL(n), 0) // DT_NODELABEL(wuc1)
DT_WUC_BY_IDX(DT_NODELABEL(n), 1) // DT_NODELABEL(wuc2)

Parameters

node_id	node identifier
idx	logical index into "wakeup-ctrls"

Returns

the node identifier for the wakeup controller referenced at index "idx"

See also

DT_PHANDLE_BY_IDX()

DT_WUC_CELL

#define DT_WUC_CELL	(		node_id,
			cell )

#include <zephyr/devicetree/wuc.h>

Value:

DT_WUC_CELL_BY_IDX(node_id, 0, cell)

Equivalent to DT_WUC_CELL_BY_IDX(node_id, 0, cell).

Parameters

node_id	node identifier for a node with a wakeup-ctrls property
cell	lowercase-and-underscores cell name

Returns

the cell value at index 0

See also

DT_WUC_CELL_BY_IDX()

DT_WUC_CELL_BY_IDX

#define DT_WUC_CELL_BY_IDX	(		node_id,
			idx,
			cell )

#include <zephyr/devicetree/wuc.h>

Value:

DT_PHA_BY_IDX(node_id, wakeup_ctrls, idx, cell)

Get a wakeup controller specifier's cell value at an index.

Example devicetree fragment:

wuc: wakeup-controller@... {
        compatible = "vnd,wuc";
        #wakeup-ctrl-cells = <1>;
};

n: node {
        wakeup-ctrls = <&wuc 10>;
};

Bindings fragment for the vnd,wuc compatible:

wakeup-ctrl-cells:
  - id

Example usage:

DT_WUC_CELL_BY_IDX(DT_NODELABEL(n), 0, id) // 10

Parameters

node_id	node identifier for a node with a wakeup-ctrls property
idx	logical index into wakeup-ctrls property
cell	lowercase-and-underscores cell name

Returns

the cell value at index "idx"

See also

DT_PHA_BY_IDX()

DT_WUC_ID

#define DT_WUC_ID

(

node_id

)

#include <zephyr/devicetree/wuc.h>

Value:

DT_WUC_ID_BY_IDX(node_id, 0)

Equivalent to DT_WUC_ID_BY_IDX(node_id, 0).

Parameters

node_id

node identifier

Returns

the id cell value at index 0

See also

DT_WUC_ID_BY_IDX()

DT_WUC_ID_BY_IDX

#define DT_WUC_ID_BY_IDX	(		node_id,
			idx )

#include <zephyr/devicetree/wuc.h>

Value:

DT_PHA_BY_IDX(node_id, wakeup_ctrls, idx, id)

Get a Wakeup Controller specifier's id cell at an index.

This macro only works for Wakeup Controller specifiers with cells named "id". Refer to the node's binding to check if necessary.

Example devicetree fragment:

wuc: wakeup-controller@... {
        compatible = "vnd,wuc";
        #wakeup-ctrl-cells = <1>;
};

n: node {
        wakeup-ctrls = <&wuc 10>;
};

Bindings fragment for the vnd,wuc compatible:

wakeup-ctrl-cells:
  - id

Example usage:

DT_WUC_ID_BY_IDX(DT_NODELABEL(n), 0) // 10

Parameters

node_id	node identifier
idx	logical index into "wakeup-ctrls"

Returns

the id cell value at index "idx"

See also

DT_PHA_BY_IDX()