| /* |
| * 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> |
| |
| /** |
| * @brief Get the linker memory-region name in a token form |
| * |
| * This attempts to use the zephyr,memory-region property (with |
| * non-alphanumeric characters replaced with underscores) returning a token. |
| * |
| * Example devicetree fragment: |
| * |
| * @code{.dts} |
| * / { |
| * soc { |
| * sram1: memory@2000000 { |
| * zephyr,memory-region = "MY_NAME"; |
| * }; |
| * sram2: memory@2001000 { |
| * zephyr,memory-region = "MY@OTHER@NAME"; |
| * }; |
| * }; |
| * }; |
| * @endcode |
| * |
| * Example usage: |
| * |
| * @code{.c} |
| * LINKER_DT_NODE_REGION_NAME_TOKEN(DT_NODELABEL(sram1)) // MY_NAME |
| * LINKER_DT_NODE_REGION_NAME_TOKEN(DT_NODELABEL(sram2)) // MY_OTHER_NAME |
| * @endcode |
| * |
| * @param node_id node identifier |
| * @return the name of the memory memory region the node will generate |
| */ |
| #define LINKER_DT_NODE_REGION_NAME_TOKEN(node_id) \ |
| DT_STRING_TOKEN(node_id, zephyr_memory_region) |
| |
| /** |
| * @brief Get the linker memory-region name |
| * |
| * This attempts to use the zephyr,memory-region property (with |
| * non-alphanumeric characters replaced with underscores). |
| * |
| * Example devicetree fragment: |
| * |
| * @code{.dts} |
| * / { |
| * soc { |
| * sram1: memory@2000000 { |
| * zephyr,memory-region = "MY_NAME"; |
| * }; |
| * sram2: memory@2001000 { |
| * zephyr,memory-region = "MY@OTHER@NAME"; |
| * }; |
| * }; |
| * }; |
| * @endcode |
| * |
| * Example usage: |
| * |
| * @code{.c} |
| * LINKER_DT_NODE_REGION_NAME(DT_NODELABEL(sram1)) // "MY_NAME" |
| * LINKER_DT_NODE_REGION_NAME(DT_NODELABEL(sram2)) // "MY_OTHER_NAME" |
| * @endcode |
| * |
| * @param node_id node identifier |
| * @return the name of the memory memory region the node will generate |
| */ |
| #define LINKER_DT_NODE_REGION_NAME(node_id) \ |
| STRINGIFY(LINKER_DT_NODE_REGION_NAME_TOKEN(node_id)) |
| |
| /** @cond INTERNAL_HIDDEN */ |
| |
| #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) |
| |
| /** |
| * @brief Declare a memory region |
| * |
| * Example devicetree fragment: |
| * |
| * @code{.dts} |
| * test_sram: sram@20010000 { |
| * compatible = "zephyr,memory-region", "mmio-sram"; |
| * reg = < 0x20010000 0x1000 >; |
| * zephyr,memory-region = "FOOBAR"; |
| * }; |
| * @endcode |
| * |
| * will result in: |
| * |
| * @code{.unparsed} |
| * FOOBAR (rw) : ORIGIN = (0x20010000), LENGTH = (0x1000) |
| * @endcode |
| * |
| * @param node_id devicetree node identifier |
| * @param attr region attributes |
| */ |
| #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) |
| |
| /** |
| * @brief Declare a memory section from the device tree nodes with |
| * compatible 'zephyr,memory-region' |
| * |
| * Example devicetree fragment: |
| * |
| * @code{.dts} |
| * test_sram: sram@20010000 { |
| * compatible = "zephyr,memory-region", "mmio-sram"; |
| * reg = < 0x20010000 0x1000 >; |
| * zephyr,memory-region = "FOOBAR"; |
| * }; |
| * @endcode |
| * |
| * will result in: |
| * |
| * @code{.unparsed} |
| * FOOBAR (NOLOAD) : |
| * { |
| * __FOOBAR_start = .; |
| * KEEP(*(FOOBAR)) |
| * KEEP(*(FOOBAR.*)) |
| * __FOOBAR_end = .; |
| * } > FOOBAR |
| * __FOOBAR_size = __FOOBAR_end - __FOOBAR_start; |
| * __FOOBAR_load_start = LOADADDR(FOOBAR); |
| * @endcode |
| * |
| * @param node_id devicetree node identifier |
| */ |
| #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)); |
| |
| /** @endcond */ |
| |
| /** |
| * @brief Generate linker memory regions from the device tree nodes with |
| * compatible 'zephyr,memory-region' |
| * |
| * Note: for now we do not deal with MEMORY attributes since those are |
| * optional, not actually used by Zephyr and they will likely conflict with the |
| * MPU configuration. |
| */ |
| #define LINKER_DT_REGIONS() \ |
| DT_FOREACH_STATUS_OKAY(_DT_COMPATIBLE, _REGION_DECLARE) |
| |
| /** |
| * @brief Generate linker memory sections from the device tree nodes with |
| * compatible 'zephyr,memory-region' |
| */ |
| #define LINKER_DT_SECTIONS() \ |
| DT_FOREACH_STATUS_OKAY(_DT_COMPATIBLE, _SECTION_DECLARE) |
| |
| #endif /* ZEPHYR_INCLUDE_LINKER_DEVICETREE_REGIONS_H_ */ |