Macros
#define	DT_MBOX_CTLR_BY_NAME(node_id, name)
	Get the node identifier for the MBOX controller from a mboxes property by name.

#define	DT_MBOX_CHANNEL_BY_NAME(node_id, name)
	Get a MBOX channel value by name.

Detailed Description

Macro Definition Documentation

#define DT_MBOX_CHANNEL_BY_NAME	(		node_id,
			name )

Value:

DT_PHA_BY_NAME_OR(node_id, mboxes, name, channel, 0)

#define DT_PHA_BY_NAME_OR(node_id, pha, name, cell, default_value)

Like DT_PHA_BY_NAME(), but with a fallback to default_value.

Definition devicetree.h:1683

Get a MBOX channel value by name.

Example devicetree fragment:

mbox1: mbox@... {
        #mbox-cells = <1>;
};

n: node {
    mboxes = <&mbox1 1>,
             <&mbox1 6>;
    mbox-names = "tx", "rx";
};

Bindings fragment for the mbox compatible:

mbox-cells:
  - channel

Example usage:

DT_MBOX_CHANNEL_BY_NAME(DT_NODELABEL(n), tx) // 1
DT_MBOX_CHANNEL_BY_NAME(DT_NODELABEL(n), rx) // 6

Parameters

node_id	node identifier for a node with a mboxes property
name	lowercase-and-underscores name of a mboxes element as defined by the node's mbox-names property

Returns: the channel value in the specifier at the named element or 0 if no channels are supported

#define DT_MBOX_CTLR_BY_NAME	(		node_id,
			name )

Value:

DT_PHANDLE_BY_NAME(node_id, mboxes, name)

#define DT_PHANDLE_BY_NAME(node_id, pha, name)

Get a phandle's node identifier from a phandle array by name.

Definition devicetree.h:1733

Get the node identifier for the MBOX controller from a mboxes property by name.

Example devicetree fragment:

mbox1: mbox-controller@... { ... };

n: node {
        mboxes = <&mbox1 8>,
                 <&mbox1 9>;
        mbox-names = "tx", "rx";
};

Example usage:

DT_MBOX_CTLR_BY_NAME(DT_NODELABEL(n), tx) // DT_NODELABEL(mbox1)
DT_MBOX_CTLR_BY_NAME(DT_NODELABEL(n), rx) // DT_NODELABEL(mbox1)

Parameters

node_id	node identifier for a node with a mboxes property
name	lowercase-and-underscores name of a mboxes element as defined by the node's mbox-names property

	Zephyr API Documentation 4.1.99 A Scalable Open Source RTOS
4.1.99