map.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025 TOKITA Hiroshi
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DEVICETREE_MAP_H_
#define ZEPHYR_INCLUDE_DEVICETREE_MAP_H_
 
#define DT_NODE_HAS_MAP(node_id, prop) DT_NODE_HAS_PROP(node_id, prop)
 
#define DT_MAP_LEN(node_id, prop) DT_PROP_LEN(node_id, prop)
 
#define DT_MAP_HAS_ENTRY_BY_IDX(node_id, prop, entry_idx)                                          \
        IS_ENABLED(DT_CAT6(node_id, _P_, prop, _MAP_ENTRY_, entry_idx, _EXISTS))
 
#define DT_MAP_HAS_ENTRY(node_id, prop) DT_MAP_HAS_ENTRY_BY_IDX(node_id, prop, 0)
 
#define DT_MAP_ENTRY_CHILD_ADDRESS_LEN(node_id, prop, entry_idx)                                   \
        DT_CAT6(node_id, _P_, prop, _MAP_ENTRY_, entry_idx, _CHILD_ADDRESS_LEN)
 
#define DT_MAP_ENTRY_HAS_CHILD_ADDRESS_BY_IDX(node_id, prop, entry_idx, param_idx)                 \
        IS_ENABLED(DT_CAT8(node_id, _P_, prop, _MAP_ENTRY_, entry_idx, _CHILD_ADDRESS_IDX_,        \
                           param_idx, _EXISTS))
 
#define DT_MAP_ENTRY_HAS_CHILD_ADDRESS(node_id, prop, entry_idx)                                   \
        DT_MAP_ENTRY_HAS_CHILD_ADDRESS_BY_IDX(node_id, prop, entry_idx, 0)
 
#define DT_MAP_ENTRY_CHILD_ADDRESS_BY_IDX(node_id, prop, entry_idx, param_idx)                     \
        DT_CAT7(node_id, _P_, prop, _MAP_ENTRY_, entry_idx, _CHILD_ADDRESS_IDX_, param_idx)
 
#define DT_MAP_ENTRY_CHILD_ADDRESS(node_id, prop, entry_idx)                                       \
        DT_MAP_ENTRY_CHILD_ADDRESS_BY_IDX(node_id, prop, entry_idx, 0)
 
#define DT_MAP_ENTRY_CHILD_SPECIFIER_LEN(node_id, prop, entry_idx)                                 \
        DT_CAT6(node_id, _P_, prop, _MAP_ENTRY_, entry_idx, _CHILD_SPECIFIER_LEN)
 
#define DT_MAP_ENTRY_HAS_CHILD_SPECIFIER_BY_IDX(node_id, prop, entry_idx, param_idx)               \
        IS_ENABLED(DT_CAT8(node_id, _P_, prop, _MAP_ENTRY_, entry_idx, _CHILD_SPECIFIER_IDX_,      \
                           param_idx, _EXISTS))
 
#define DT_MAP_ENTRY_HAS_CHILD_SPECIFIER(node_id, prop, entry_idx)                                 \
        DT_MAP_ENTRY_HAS_CHILD_SPECIFIER_BY_IDX(node_id, prop, entry_idx, 0)
 
#define DT_MAP_ENTRY_CHILD_SPECIFIER_BY_IDX(node_id, prop, entry_idx, param_idx)                   \
        DT_CAT7(node_id, _P_, prop, _MAP_ENTRY_, entry_idx, _CHILD_SPECIFIER_IDX_, param_idx)
 
#define DT_MAP_ENTRY_CHILD_SPECIFIER(node_id, prop, entry_idx)                                     \
        DT_MAP_ENTRY_CHILD_SPECIFIER_BY_IDX(node_id, prop, entry_idx, 0)
 
#define DT_MAP_ENTRY_PARENT_BY_IDX(node_id, prop, entry_idx)                                       \
        DT_CAT6(node_id, _P_, prop, _MAP_ENTRY_, entry_idx, _PARENT)
 
#define DT_MAP_ENTRY_PARENT(node_id, prop)                                       \
        DT_MAP_ENTRY_PARENT_BY_IDX(node_id, prop, 0)
 
#define DT_MAP_ENTRY_PARENT_ADDRESS_LEN(node_id, prop, entry_idx)                                  \
        DT_CAT6(node_id, _P_, prop, _MAP_ENTRY_, entry_idx, _PARENT_ADDRESS_LEN)
 
#define DT_MAP_ENTRY_HAS_PARENT_ADDRESS_BY_IDX(node_id, prop, entry_idx, param_idx)                \
        IS_ENABLED(DT_CAT8(node_id, _P_, prop, _MAP_ENTRY_, entry_idx, _PARENT_ADDRESS_IDX_,       \
                           param_idx, _EXISTS))
 
#define DT_MAP_ENTRY_HAS_PARENT_ADDRESS(node_id, prop, entry_idx)                                  \
        DT_MAP_ENTRY_HAS_PARENT_ADDRESS_BY_IDX(node_id, prop, entry_idx, 0)
 
#define DT_MAP_ENTRY_PARENT_ADDRESS_BY_IDX(node_id, prop, entry_idx, param_idx)                    \
        DT_CAT7(node_id, _P_, prop, _MAP_ENTRY_, entry_idx, _PARENT_ADDRESS_IDX_, param_idx)
 
#define DT_MAP_ENTRY_PARENT_ADDRESS(node_id, prop, entry_idx)                                      \
        DT_MAP_ENTRY_PARENT_ADDRESS_BY_IDX(node_id, prop, entry_idx, 0)
 
#define DT_MAP_ENTRY_PARENT_SPECIFIER_LEN(node_id, prop, entry_idx)                                \
        DT_CAT6(node_id, _P_, prop, _MAP_ENTRY_, entry_idx, _PARENT_SPECIFIER_LEN)
 
#define DT_MAP_ENTRY_HAS_PARENT_SPECIFIER_BY_IDX(node_id, prop, entry_idx, param_idx)              \
        IS_ENABLED(DT_CAT8(node_id, _P_, prop, _MAP_ENTRY_, entry_idx, _PARENT_SPECIFIER_IDX_,     \
                           param_idx, _EXISTS))
 
#define DT_MAP_ENTRY_HAS_PARENT_SPECIFIER(node_id, prop, entry_idx)                                \
        DT_MAP_ENTRY_HAS_PARENT_SPECIFIER_BY_IDX(node_id, prop, entry_idx, 0)
 
#define DT_MAP_ENTRY_PARENT_SPECIFIER_BY_IDX(node_id, prop, entry_idx, param_idx)                  \
        DT_CAT7(node_id, _P_, prop, _MAP_ENTRY_, entry_idx, _PARENT_SPECIFIER_IDX_, param_idx)
 
#define DT_MAP_ENTRY_PARENT_SPECIFIER(node_id, prop, entry_idx)                                    \
        DT_MAP_ENTRY_PARENT_SPECIFIER_BY_IDX(node_id, prop, entry_idx, 0)
 
#define DT_FOREACH_MAP_ENTRY(node_id, prop, fn) DT_CAT4(node_id, _P_, prop, _FOREACH_MAP_ENTRY)(fn)
 
#define DT_FOREACH_MAP_ENTRY_SEP(node_id, prop, fn, sep)                                           \
        DT_CAT4(node_id, _P_, prop, _FOREACH_MAP_ENTRY_SEP)(fn, sep)
 
#define DT_FOREACH_MAP_ENTRY_VARGS(node_id, prop, fn, ...)                                         \
        DT_CAT4(node_id, _P_, prop, _FOREACH_MAP_ENTRY_VARGS)(fn, __VA_ARGS__)
 
#define DT_FOREACH_MAP_ENTRY_SEP_VARGS(node_id, prop, fn, sep, ...)                                \
        DT_CAT4(node_id, _P_, prop, _FOREACH_MAP_ENTRY_SEP_VARGS)(fn, sep, __VA_ARGS__)
 
#endif /* ZEPHYR_INCLUDE_DEVICETREE_MAP_H_ */