devicetree_regions.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021, Commonwealth Scientific and Industrial Research
 * Organisation (CSIRO) ABN 41 687 119 230.
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Generate memory regions from devicetree nodes.
 */
 
#ifndef ZEPHYR_INCLUDE_LINKER_DEVICETREE_REGIONS_H_
#define ZEPHYR_INCLUDE_LINKER_DEVICETREE_REGIONS_H_
 
#include <zephyr/devicetree.h>
#include <zephyr/sys/util.h>
#include <zephyr/toolchain.h>
 
#define LINKER_DT_NODE_REGION_NAME_TOKEN(node_id) \
        DT_STRING_TOKEN(node_id, zephyr_memory_region)
 
#define LINKER_DT_NODE_REGION_NAME(node_id) \
        STRINGIFY(LINKER_DT_NODE_REGION_NAME_TOKEN(node_id))
 
#define _DT_COMPATIBLE  zephyr_memory_region
 
#define _DT_SECTION_PREFIX(node_id)     UTIL_CAT(__, LINKER_DT_NODE_REGION_NAME_TOKEN(node_id))
#define _DT_SECTION_START(node_id)      UTIL_CAT(_DT_SECTION_PREFIX(node_id), _start)
#define _DT_SECTION_END(node_id)        UTIL_CAT(_DT_SECTION_PREFIX(node_id), _end)
#define _DT_SECTION_SIZE(node_id)       UTIL_CAT(_DT_SECTION_PREFIX(node_id), _size)
#define _DT_SECTION_LOAD(node_id)       UTIL_CAT(_DT_SECTION_PREFIX(node_id), _load_start)
 
#define _DT_ATTR(token)                 UTIL_CAT(UTIL_CAT(REGION_, token), _ATTR)
 
#define _REGION_DECLARE(node_id)                        \
        LINKER_DT_NODE_REGION_NAME_TOKEN(node_id) :     \
        ORIGIN = DT_REG_ADDR(node_id),                  \
        LENGTH = DT_REG_SIZE(node_id)
 
#define _SECTION_DECLARE(node_id)                                                               \
        LINKER_DT_NODE_REGION_NAME_TOKEN(node_id) DT_REG_ADDR(node_id) (NOLOAD) :               \
        {                                                                                       \
                _DT_SECTION_START(node_id) = .;                                                 \
                KEEP(*(LINKER_DT_NODE_REGION_NAME_TOKEN(node_id)))                              \
                KEEP(*(LINKER_DT_NODE_REGION_NAME_TOKEN(node_id).*))                            \
                _DT_SECTION_END(node_id) = .;                                                   \
        } > LINKER_DT_NODE_REGION_NAME_TOKEN(node_id)                                           \
        _DT_SECTION_SIZE(node_id) = _DT_SECTION_END(node_id) - _DT_SECTION_START(node_id);      \
        _DT_SECTION_LOAD(node_id) = LOADADDR(LINKER_DT_NODE_REGION_NAME_TOKEN(node_id));
 
#define _EXPAND_MPU_FN(node_id, MPU_FN, ...)                                    \
        MPU_FN(LINKER_DT_NODE_REGION_NAME(node_id),                             \
               DT_REG_ADDR(node_id),                                            \
               DT_REG_SIZE(node_id),                                            \
               _DT_ATTR(DT_STRING_TOKEN(node_id, zephyr_memory_region_mpu))),
 
#define _CHECK_ATTR_FN(node_id, EXPAND_MPU_FN, ...)                                     \
        COND_CODE_1(UTIL_AND(DT_NODE_HAS_PROP(node_id, zephyr_memory_region_mpu),       \
                             DT_NODE_HAS_PROP(node_id, zephyr_memory_region)),          \
                   (EXPAND_MPU_FN(node_id, __VA_ARGS__)),                               \
                   ())
 
#define _CHECK_APPLY_FN(compat, EXPAND_MPU_FN, ...)                                     \
        DT_FOREACH_STATUS_OKAY_VARGS(compat, _CHECK_ATTR_FN, EXPAND_MPU_FN, __VA_ARGS__)
 
#define LINKER_DT_REGIONS() \
        DT_FOREACH_STATUS_OKAY(_DT_COMPATIBLE, _REGION_DECLARE)
 
#define LINKER_DT_SECTIONS() \
        DT_FOREACH_STATUS_OKAY(_DT_COMPATIBLE, _SECTION_DECLARE)
 
#define LINKER_DT_REGION_MPU(mpu_fn) _CHECK_APPLY_FN(_DT_COMPATIBLE, _EXPAND_MPU_FN, mpu_fn)
 
#endif /* ZEPHYR_INCLUDE_LINKER_DEVICETREE_REGIONS_H_ */