Devicetree Port Endpoint API

Macros
#define	DT_INST_PORT_BY_ID(inst, pid)
	Get a port node from its id.
#define	DT_INST_ENDPOINT_BY_ID(inst, pid, eid)
	Get an endpoint node from its id and its parent port id.
#define	DT_NODE_BY_ENDPOINT(ep)
	Get the device node from its endpoint node.
#define	DT_NODE_REMOTE_DEVICE(ep)
	Get the remote device node from a local endpoint node.

Detailed Description

Macro Definition Documentation

DT_INST_ENDPOINT_BY_ID

#define DT_INST_ENDPOINT_BY_ID	(		inst,
			pid,
			eid )

#include <zephyr/devicetree/port-endpoint.h>

Value:

        COND_CODE_1(DT_NODE_EXISTS(_DT_INST_ENDPOINT_BY_ID(inst, pid, eid)),                       \
                (_DT_INST_ENDPOINT_BY_ID(inst, pid, eid)),                                         \
                        (DT_CHILD(DT_INST_PORT_BY_ID(inst, pid), endpoint)))

Get an endpoint node from its id and its parent port id.

Given a device instance number, a port ID and an endpoint ID, return the endpoint node. It handles various ways of how a port and an endpoint could be defined as described in DT_INST_PORT_BY_ID and below.

Example usage with DT_INST_ENDPOINT_BY_ID() to get the endpoint or endpoint@0 node:

DT_INST_ENDPOINT_BY_ID(inst, 0, 0)

Example devicetree fragment:

&device {
   port {
           endpoint {
           };
   };
};

&device {
   port {
           #address-cells = <1>;
           #size-cells = <0>;
           endpoint@0 {
                   reg = <0x0>;
           };
   };
};

&device {
   ports {
           #address-cells = <1>;
           #size-cells = <0>;
           port@0 {
                   reg = <0x0>;
                   #address-cells = <1>;
                   #size-cells = <0>;
                   endpoint@0 {
                           reg = <0x0>;
                   };
           };
   };
};

Parameters

inst	instance number
pid	port ID
eid	endpoint ID

Returns

endpoint node associated with eid and pid

DT_INST_PORT_BY_ID

#define DT_INST_PORT_BY_ID	(		inst,
			pid )

#include <zephyr/devicetree/port-endpoint.h>

Value:

        COND_CODE_1(DT_NODE_EXISTS(_DT_INST_PORT_BY_ID(inst, pid)),                                \
                (_DT_INST_PORT_BY_ID(inst, pid)), (DT_INST_CHILD(inst, port)))

Get a port node from its id.

Given a device instance number, return a port node specified by its ID. It handles various ways of how a port could be defined.

Example usage with DT_INST_PORT_BY_ID() to get the port@0 or port node:

DT_INST_PORT_BY_ID(inst, 0)

Example devicetree fragment:

&device {
   ports {
           #address-cells = <1>;
           #size-cells = <0>;
           port@0 {
                   reg = <0x0>;
           };
   };
};

&device {
   #address-cells = <1>;
   #size-cells = <0>;
   port@0 {
           reg = <0x0>;
   };
};

&device {
   port {
   };
};

Parameters

inst	instance number
pid	port ID

Returns

port node associated with pid

DT_NODE_BY_ENDPOINT

#define DT_NODE_BY_ENDPOINT

(

ep

)

#include <zephyr/devicetree/port-endpoint.h>

Value:

        COND_CODE_1(DT_NODE_EXISTS(DT_CHILD(DT_PARENT(DT_GPARENT(ep)), ports)),                    \
                (DT_PARENT(DT_GPARENT(ep))), (DT_GPARENT(ep)))

Get the device node from its endpoint node.

Given an endpoint node id, return its device node id. This handles various ways of how a port and an endpoint could be defined as described in DT_NODE_BY_ENDPOINT.

Example usage with DT_NODE_BY_ENDPOINT() to get the &device node from its ep0 node:

DT_NODE_BY_ENDPOINT(DT_NODELABEL(ep0))

Example devicetree fragment:

&device {
   port {
           #address-cells = <1>;
           #size-cells = <0>;
           ep0: endpoint@0 {
                   reg = <0x0>;
           };
   };
};

&device {
   ports {
           #address-cells = <1>;
           #size-cells = <0>;
           port@0 {
                   reg = <0x0>;
                   #address-cells = <1>;
                   #size-cells = <0>;
                   ep0: endpoint@0 {
                           reg = <0x0>;
                   };
           };
   };
};

Parameters

ep	endpoint node

Returns

device node associated with ep

DT_NODE_REMOTE_DEVICE

#define DT_NODE_REMOTE_DEVICE

(

ep

)

#include <zephyr/devicetree/port-endpoint.h>

Value:

        DT_NODE_BY_ENDPOINT(DT_NODELABEL(DT_STRING_TOKEN(ep, remote_endpoint_label)))

Get the remote device node from a local endpoint node.

Given an endpoint node id, return the remote device node that connects to this device via this local endpoint. This handles various ways of how a port and an endpoint could be defined as described in DT_INST_PORT_BY_ID and DT_INST_ENDPOINT_BY_ID.

Example usage with DT_NODE_REMOTE_DEVICE() to get the remote device node &device1 from the local endpoint endpoint@0 node of the device &device0 node:

DT_NODE_REMOTE_DEVICE(DT_NODELABEL(device0_ep_out))

Example devicetree fragment:

&device0 {
   port {
           #address-cells = <1>;
           #size-cells = <0>;
           device0_ep_out: endpoint@0 {
                   reg = <0x0>;
                   remote-endpoint-label = "device1_ep_in";
           };
   };
};
 
&device1 {
   ports {
           #address-cells = <1>;
           #size-cells = <0>;
           port@0 {
                   reg = <0x0>;
                   device1_ep_in: endpoint {
                           remote-endpoint-label = "device0_ep_out";
                   };
           };
   };
};

Parameters

ep	endpoint node

Returns

remote device node that connects to this device via ep