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_MEMORY_REGION_FLAGS_TOKEN(n)    DT_STRING_TOKEN(n, zephyr_memory_region_flags)
#define _DT_MEMORY_REGION_FLAGS_UNQUOTED(n) DT_STRING_UNQUOTED(n, zephyr_memory_region_flags)
 
#define _LINKER_L_PAREN (
#define _LINKER_R_PAREN )
#define _LINKER_ENCLOSE_PAREN(x) _LINKER_L_PAREN x _LINKER_R_PAREN
 
#define _LINKER_IS_EMPTY_TOKEN_          1
#define _LINKER_IS_EMPTY_TOKEN_EXPAND(x) _LINKER_IS_EMPTY_TOKEN_##x
#define _LINKER_IS_EMPTY_TOKEN(x)        _LINKER_IS_EMPTY_TOKEN_EXPAND(x)
 
#define LINKER_DT_NODE_REGION_FLAGS(node_id)                                                       \
        COND_CODE_1(DT_NODE_HAS_PROP(node_id, zephyr_memory_region_flags),                         \
                    (COND_CODE_1(_LINKER_IS_EMPTY_TOKEN(_DT_MEMORY_REGION_FLAGS_TOKEN(node_id)),   \
                                 (),                                                               \
                                 (_LINKER_ENCLOSE_PAREN(                                           \
                                        _DT_MEMORY_REGION_FLAGS_UNQUOTED(node_id))                 \
                                 ))),                                                              \
                    (_LINKER_ENCLOSE_PAREN(rw)))
 
#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 _REGION_DECLARE(node_id)                                                                   \
        LINKER_DT_NODE_REGION_NAME_TOKEN(node_id)                                                  \
        LINKER_DT_NODE_REGION_FLAGS(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) (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 LINKER_DT_REGIONS() \
        DT_FOREACH_STATUS_OKAY(_DT_COMPATIBLE, _REGION_DECLARE)
 
#define LINKER_DT_SECTIONS() \
        DT_FOREACH_STATUS_OKAY(_DT_COMPATIBLE, _SECTION_DECLARE)
 
#endif /* ZEPHYR_INCLUDE_LINKER_DEVICETREE_REGIONS_H_ */