Devicetree Display API

Macros
#define	DT_ZEPHYR_DISPLAY(idx)
	Get display node identifier by logical index from "displays" property of node with compatible "zephyr,displays".
#define	DT_ZEPHYR_DISPLAYS_COUNT
	Get number of zephyr displays.

Detailed Description

Macro Definition Documentation

DT_ZEPHYR_DISPLAY

#define DT_ZEPHYR_DISPLAY

(

idx

)

#include <zephyr/devicetree/display.h>

Value:

        DT_PHANDLE_BY_IDX(DT_COMPAT_GET_ANY_STATUS_OKAY(zephyr_displays), displays, idx)

Get display node identifier by logical index from "displays" property of node with compatible "zephyr,displays".

Example devicetree fragment:

 displays_node: my-displays {
    compatible = "zephyr,displays";
    displays = <&n2 &n3>;
    status = "okay";
 };
 
n2: node-2 { ... };
n3: node-3 { ... };

Above, displays property has two elements:

• index 0 has phandle &n2, which is node-2's phandle
• index 1 has phandle &n3, which is node-3's phandle

Example usage:

DT_ZEPHYR_DISPLAY(0) // node identifier for display node node-2
DT_ZEPHYR_DISPLAY(1) // node identifier for display node node-3

Parameters

idx	logical index of display node's phandle in "displays" property

Returns

display node identifier, DT_INVALID_NODE otherwise

DT_ZEPHYR_DISPLAYS_COUNT

#define DT_ZEPHYR_DISPLAYS_COUNT

#include <zephyr/devicetree/display.h>

Value:

        COND_CODE_1(DT_HAS_COMPAT_STATUS_OKAY(zephyr_displays),                                    \
                    (DT_PROP_LEN(DT_COMPAT_GET_ANY_STATUS_OKAY(zephyr_displays), displays)),       \
                    (DT_HAS_CHOSEN(zephyr_display)))

Get number of zephyr displays.

Returns

number of displays designated by "displays" property of "zephyr,displays" compatible node, if it exists, otherwise 1 if "zephyr,display" chosen property exists, 0 otherwise