Devicetree IO Channels API

Macros
#define	DT_IO_CHANNELS_CTLR_BY_IDX(node_id, idx)
	Get the node identifier for the node referenced by an io-channels property at an index.
#define	DT_IO_CHANNELS_CTLR_BY_NAME(node_id, name)
	Get the node identifier for the node referenced by an io-channels property by name.
#define	DT_IO_CHANNELS_CTLR(node_id)
	Equivalent to DT_IO_CHANNELS_CTLR_BY_IDX(node_id, 0)
#define	DT_INST_IO_CHANNELS_CTLR_BY_IDX(inst, idx)
	Get the node identifier from a DT_DRV_COMPAT instance's io-channels property at an index.
#define	DT_INST_IO_CHANNELS_CTLR_BY_NAME(inst, name)
	Get the node identifier from a DT_DRV_COMPAT instance's io-channels property by name.
#define	DT_INST_IO_CHANNELS_CTLR(inst)
	Equivalent to DT_INST_IO_CHANNELS_CTLR_BY_IDX(inst, 0)
#define	DT_IO_CHANNELS_INPUT_BY_IDX(node_id, idx)
	Get an io-channels specifier input cell at an index.
#define	DT_IO_CHANNELS_INPUT_BY_NAME(node_id, name)
	Get an io-channels specifier input cell by name.
#define	DT_IO_CHANNELS_INPUT(node_id)
	Equivalent to DT_IO_CHANNELS_INPUT_BY_IDX(node_id, 0)
#define	DT_INST_IO_CHANNELS_INPUT_BY_IDX(inst, idx)
	Get an input cell from the "DT_DRV_INST(inst)" io-channels property at an index.
#define	DT_INST_IO_CHANNELS_INPUT_BY_NAME(inst, name)
	Get an input cell from the "DT_DRV_INST(inst)" io-channels property by name.
#define	DT_INST_IO_CHANNELS_INPUT(inst)
	Equivalent to DT_INST_IO_CHANNELS_INPUT_BY_IDX(inst, 0)

Detailed Description

Macro Definition Documentation

DT_INST_IO_CHANNELS_CTLR

#define DT_INST_IO_CHANNELS_CTLR

(

inst

)

#include <zephyr/devicetree/io-channels.h>

Value:

DT_INST_IO_CHANNELS_CTLR_BY_IDX(inst, 0)

Equivalent to DT_INST_IO_CHANNELS_CTLR_BY_IDX(inst, 0)

Parameters

inst	DT_DRV_COMPAT instance number

Returns

the node identifier for the node referenced at index 0 in the node's "io-channels" property

See also

DT_IO_CHANNELS_CTLR_BY_IDX()

DT_INST_IO_CHANNELS_CTLR_BY_IDX

#define DT_INST_IO_CHANNELS_CTLR_BY_IDX	(		inst,
			idx )

#include <zephyr/devicetree/io-channels.h>

Value:

        DT_IO_CHANNELS_CTLR_BY_IDX(DT_DRV_INST(inst), idx)

Get the node identifier from a DT_DRV_COMPAT instance's io-channels property at an index.

Parameters

inst	DT_DRV_COMPAT instance number
idx	logical index into io-channels property

Returns

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

See also

DT_IO_CHANNELS_CTLR_BY_IDX()

DT_INST_IO_CHANNELS_CTLR_BY_NAME

#define DT_INST_IO_CHANNELS_CTLR_BY_NAME	(		inst,
			name )

#include <zephyr/devicetree/io-channels.h>

Value:

        DT_IO_CHANNELS_CTLR_BY_NAME(DT_DRV_INST(inst), name)

Get the node identifier from a DT_DRV_COMPAT instance's io-channels property by name.

Parameters

inst	DT_DRV_COMPAT instance number
name	lowercase-and-underscores name of an io-channels element as defined by the node's io-channel-names property

Returns

the node identifier for the node referenced at the named element

See also

DT_IO_CHANNELS_CTLR_BY_NAME()

DT_INST_IO_CHANNELS_INPUT

#define DT_INST_IO_CHANNELS_INPUT

(

inst

)

#include <zephyr/devicetree/io-channels.h>

Value:

DT_INST_IO_CHANNELS_INPUT_BY_IDX(inst, 0)

Equivalent to DT_INST_IO_CHANNELS_INPUT_BY_IDX(inst, 0)

Parameters

inst	DT_DRV_COMPAT instance number

Returns

the input cell in the specifier at index 0

DT_INST_IO_CHANNELS_INPUT_BY_IDX

#define DT_INST_IO_CHANNELS_INPUT_BY_IDX	(		inst,
			idx )

#include <zephyr/devicetree/io-channels.h>

Value:

        DT_IO_CHANNELS_INPUT_BY_IDX(DT_DRV_INST(inst), idx)

Get an input cell from the "DT_DRV_INST(inst)" io-channels property at an index.

Parameters

inst	DT_DRV_COMPAT instance number
idx	logical index into io-channels property

Returns

the input cell in the specifier at index "idx"

See also

DT_IO_CHANNELS_INPUT_BY_IDX()

DT_INST_IO_CHANNELS_INPUT_BY_NAME

#define DT_INST_IO_CHANNELS_INPUT_BY_NAME	(		inst,
			name )

#include <zephyr/devicetree/io-channels.h>

Value:

        DT_IO_CHANNELS_INPUT_BY_NAME(DT_DRV_INST(inst), name)

Get an input cell from the "DT_DRV_INST(inst)" io-channels property by name.

Parameters

inst	DT_DRV_COMPAT instance number
name	lowercase-and-underscores name of an io-channels element as defined by the instance's io-channel-names property

Returns

the input cell in the specifier at the named element

See also

DT_IO_CHANNELS_INPUT_BY_NAME()

DT_IO_CHANNELS_CTLR

#define DT_IO_CHANNELS_CTLR

(

node_id

)

#include <zephyr/devicetree/io-channels.h>

Value:

DT_IO_CHANNELS_CTLR_BY_IDX(node_id, 0)

Equivalent to DT_IO_CHANNELS_CTLR_BY_IDX(node_id, 0)

Parameters

node_id

node identifier for a node with an io-channels property

Returns

the node identifier for the node referenced at index 0 in the node's "io-channels" property

See also

DT_IO_CHANNELS_CTLR_BY_IDX()

DT_IO_CHANNELS_CTLR_BY_IDX

#define DT_IO_CHANNELS_CTLR_BY_IDX	(		node_id,
			idx )

#include <zephyr/devicetree/io-channels.h>

Value:

        DT_PHANDLE_BY_IDX(node_id, io_channels, idx)

Get the node identifier for the node referenced by an io-channels property at an index.

Example devicetree fragment:

adc1: adc@... { ... };

adc2: adc@... { ... };

n: node {
        io-channels = <&adc1 10>, <&adc2 20>;
};

Example usage:

DT_IO_CHANNELS_CTLR_BY_IDX(DT_NODELABEL(n), 0) // DT_NODELABEL(adc1)
DT_IO_CHANNELS_CTLR_BY_IDX(DT_NODELABEL(n), 1) // DT_NODELABEL(adc2)

Parameters

node_id	node identifier for a node with an io-channels property
idx	logical index into io-channels property

Returns

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

See also

DT_PROP_BY_PHANDLE_IDX()

DT_IO_CHANNELS_CTLR_BY_NAME

#define DT_IO_CHANNELS_CTLR_BY_NAME	(		node_id,
			name )

#include <zephyr/devicetree/io-channels.h>

Value:

        DT_PHANDLE_BY_NAME(node_id, io_channels, name)

Get the node identifier for the node referenced by an io-channels property by name.

Example devicetree fragment:

adc1: adc@... { ... };

adc2: adc@... { ... };

n: node {
        io-channels = <&adc1 10>, <&adc2 20>;
        io-channel-names = "SENSOR", "BANDGAP";
};

Example usage:

DT_IO_CHANNELS_CTLR_BY_NAME(DT_NODELABEL(n), sensor) // DT_NODELABEL(adc1) DT_IO_CHANNELS_CTLR_BY_NAME(DT_NODELABEL(n), bandgap) // DT_NODELABEL(adc2)

Parameters

node_id	node identifier for a node with an io-channels property
name	lowercase-and-underscores name of an io-channels element as defined by the node's io-channel-names property

Returns

the node identifier for the node referenced at the named element

See also

DT_PHANDLE_BY_NAME()

DT_IO_CHANNELS_INPUT

#define DT_IO_CHANNELS_INPUT

(

node_id

)

#include <zephyr/devicetree/io-channels.h>

Value:

DT_IO_CHANNELS_INPUT_BY_IDX(node_id, 0)

Equivalent to DT_IO_CHANNELS_INPUT_BY_IDX(node_id, 0)

Parameters

node_id

node identifier for a node with an io-channels property

Returns

the input cell in the specifier at index 0

See also

DT_IO_CHANNELS_INPUT_BY_IDX()

DT_IO_CHANNELS_INPUT_BY_IDX

#define DT_IO_CHANNELS_INPUT_BY_IDX	(		node_id,
			idx )

#include <zephyr/devicetree/io-channels.h>

Value:

        DT_PHA_BY_IDX(node_id, io_channels, idx, input)

Get an io-channels specifier input cell at an index.

This macro only works for io-channels specifiers with cells named "input". Refer to the node's binding to check if necessary.

Example devicetree fragment:

adc1: adc@... {
        compatible = "vnd,adc";
        #io-channel-cells = <1>;
};

adc2: adc@... {
        compatible = "vnd,adc";
        #io-channel-cells = <1>;
};

n: node {
        io-channels = <&adc1 10>, <&adc2 20>;
};

Bindings fragment for the vnd,adc compatible:

io-channel-cells:

• input

Example usage:

DT_IO_CHANNELS_INPUT_BY_IDX(DT_NODELABEL(n), 0) // 10
DT_IO_CHANNELS_INPUT_BY_IDX(DT_NODELABEL(n), 1) // 20

Parameters

node_id	node identifier for a node with an io-channels property
idx	logical index into io-channels property

Returns

the input cell in the specifier at index "idx"

See also

DT_PHA_BY_IDX()

DT_IO_CHANNELS_INPUT_BY_NAME

#define DT_IO_CHANNELS_INPUT_BY_NAME	(		node_id,
			name )

#include <zephyr/devicetree/io-channels.h>

Value:

        DT_PHA_BY_NAME(node_id, io_channels, name, input)

Get an io-channels specifier input cell by name.

This macro only works for io-channels specifiers with cells named "input". Refer to the node's binding to check if necessary.

Example devicetree fragment:

adc1: adc@... {
        compatible = "vnd,adc";
        #io-channel-cells = <1>;
};

adc2: adc@... {
        compatible = "vnd,adc";
        #io-channel-cells = <1>;
};

n: node {
        io-channels = <&adc1 10>, <&adc2 20>;
        io-channel-names = "SENSOR", "BANDGAP";
};

Bindings fragment for the vnd,adc compatible:

io-channel-cells:

• input

Example usage:

DT_IO_CHANNELS_INPUT_BY_NAME(DT_NODELABEL(n), sensor) // 10
DT_IO_CHANNELS_INPUT_BY_NAME(DT_NODELABEL(n), bandgap) // 20

Parameters

node_id	node identifier for a node with an io-channels property
name	lowercase-and-underscores name of an io-channels element as defined by the node's io-channel-names property

Returns

the input cell in the specifier at the named element

See also

DT_PHA_BY_NAME()