Devicetree Partition API

Macros
#define	DT_NODE_BY_PARTITION_LABEL(label)
	Get a node identifier for a partition with a given label property.
#define	DT_HAS_PARTITION_LABEL(label)
	Test if a partition with a given label property exists.
#define	DT_PARTITION_EXISTS(node_id)
	Test if zephyr,mapped-partition, fixed-partitions or fixed-subpartitions compatible node exists.
#define	DT_PARTITION_ID(node_id)
	Get a numeric identifier for a partition.
#define	DT_MEM_FROM_PARTITION(node_id)
	Get the node identifier of the NVM memory for a partition.
#define	DT_MTD_FROM_PARTITION(node_id)
	Get the node identifier of the NVM controller for a partition.
#define	DT_PARTITION_ADDR(node_id)
	Get the absolute address of a partition This macro can only be used with partitions of internal memory addressable by the CPU.

Detailed Description

Macro Definition Documentation

DT_HAS_PARTITION_LABEL

#define DT_HAS_PARTITION_LABEL

(

label

)

#include <zephyr/devicetree/partitions.h>

Value:

UTIL_OR(DT_HAS_MAPPED_PARTITION_LABEL(label), DT_HAS_FIXED_PARTITION_LABEL(label))

Test if a partition with a given label property exists.

Parameters

label

lowercase-and-underscores label property value

Returns

1 if the device has a "zephyr,mapped-partition" or "fixed-subpartitions" compatible, or parent has a "fixed-partitions" compatible, 0 otherwise.

DT_MEM_FROM_PARTITION

#define DT_MEM_FROM_PARTITION

(

node_id

)

#include <zephyr/devicetree/partitions.h>

Value:

COND_CODE_1(DT_NODE_HAS_COMPAT(node_id, zephyr_mapped_partition),       \
            (DT_MEM_FROM_MAPPED_PARTITION(node_id)),                    \
            (DT_MEM_FROM_FIXED_PARTITION(node_id)))

Get the node identifier of the NVM memory for a partition.

Parameters

node_id

node identifier for a partition node

Returns

the node identifier of the internal memory that contains the partition node, or DT_INVALID_NODE if it doesn't exist.

DT_MTD_FROM_PARTITION

#define DT_MTD_FROM_PARTITION

(

node_id

)

#include <zephyr/devicetree/partitions.h>

Value:

COND_CODE_1(DT_NODE_HAS_COMPAT(node_id, zephyr_mapped_partition),       \
            (DT_MTD_FROM_MAPPED_PARTITION(node_id)),                    \
            (DT_MTD_FROM_FIXED_PARTITION(node_id)))

Get the node identifier of the NVM controller for a partition.

Parameters

node_id

node identifier for a partition node

Returns

the node identifier of the memory technology device that contains the partition node.

DT_NODE_BY_PARTITION_LABEL

#define DT_NODE_BY_PARTITION_LABEL

(

label

)

#include <zephyr/devicetree/partitions.h>

Value:

COND_CODE_1(DT_HAS_MAPPED_PARTITION_LABEL(label),       \
            (DT_NODE_BY_MAPPED_PARTITION_LABEL(label)), \
            (DT_NODE_BY_FIXED_PARTITION_LABEL(label)))

Get a node identifier for a partition with a given label property.

Parameters

label

lowercase-and-underscores label property value

Returns

a node identifier for the partition with that label property

DT_PARTITION_ADDR

#define DT_PARTITION_ADDR

(

node_id

)

#include <zephyr/devicetree/partitions.h>

Value:

COND_CODE_1(DT_NODE_HAS_COMPAT(node_id, zephyr_mapped_partition),       \
            (DT_MAPPED_PARTITION_ADDR(node_id)),                        \
            (DT_FIXED_PARTITION_ADDR(node_id)))

Get the absolute address of a partition This macro can only be used with partitions of internal memory addressable by the CPU.

Otherwise, it may produce a compile-time error, such as: '__REG_IDX_0_VAL_ADDRESS' undeclared.

Parameters

node_id

node identifier for a partition node

Returns

the partition's unit address.

DT_PARTITION_EXISTS

#define DT_PARTITION_EXISTS

(

node_id

)

#include <zephyr/devicetree/partitions.h>

Value:

UTIL_OR(DT_MAPPED_PARTITION_EXISTS(node_id),            \
        UTIL_OR(DT_FIXED_PARTITION_EXISTS(node_id),     \
                DT_FIXED_SUBPARTITION_EXISTS(node_id)))

Test if zephyr,mapped-partition, fixed-partitions or fixed-subpartitions compatible node exists.

Parameters

node_id

DTS node to test

Returns

1 if node exists and has a "zephyr,mapped-partition" or "fixed-subpartitions" compatible, or if parent has a "fixed-partitions" compatible, 0 otherwise.

DT_PARTITION_ID

#define DT_PARTITION_ID

(

node_id

)

#include <zephyr/devicetree/partitions.h>

Value:

COND_CODE_1(DT_NODE_HAS_COMPAT(node_id, zephyr_mapped_partition),       \
            (DT_MAPPED_PARTITION_ID(node_id)),                          \
            (DT_FIXED_PARTITION_ID(node_id)))

Get a numeric identifier for a partition.

Parameters

node_id

node identifier for a partition node

Returns

the partition's ID, a unique zero-based index number