linker: aarch32: automatic derivation of region names from devicetree nodes #37279

JordanYates · 2021-07-28T11:17:30Z

Update the aarch32 linker file to automatically derive the name of memory regions from devicetree nodes instead of providing hardcoded values. This is required for automatic generation of regions based on compatibles, and also allows chosen and alias nodes to be used to control variable placement (as desired in #36152).

This PR is the first step to enable automatically generating regions from devicetree.

This is a rework of #36365 to address feedback.

JordanYates · 2021-07-28T11:18:41Z

@galak @mbolivar-nordic @carlescufi

include/devicetree.h

galak

Need to move DT_NODE_LINKER_REGION to different header
Need to update docs for zephyr,linker-region

include/devicetree.h

tests/lib/devicetree/api/app.overlay

mbolivar-nordic · 2021-07-29T23:48:27Z

Need to update docs for zephyr,linker-region

I wonder if it would be enough just to add this property to the specific compatibles that are expected to use it, with a nice multi-line description in the YAML. That would show up in the DT bindings index.

JordanYates · 2021-08-01T02:11:09Z

Bindings have been moved to only mmio-sram and fixed-partition, with additional documentation added.

mbolivar-nordic

LGTM, just a naming nitpick. For which I apologize in advance...

include/linker/devicetree_regions.h

tests/lib/devicetree/api_ext/src/main.c

carlocaione · 2021-11-22T10:40:46Z

include/linker/devicetree_regions.h

you would probably want to consider removing attr at all (that at least for the GNU linker is optional). The problem is that when the MPU is present the actual attribute of the region (in terms of RWX) is defined by the MPU and by the attributes that we are using to mark the region and not by the linker.

If you think to introduce the mpu-attr we could think of obtaining this attr from the mpu-attr but that is hard.

That can be done in future PR's if needed. This is purely about updating where the names are coming from, I don't want to potentially introduce other problems here.

This PR is large enough as it it

Ok, I'm only concerned that all the future needed changes (mpu-attr, the FOR_EACH_.. macro, this fix on the _REGION_DECLARE, etc...) will require deep changes to the current state of this PR.

I have no objections on this PR if this is considered a first step.

carlocaione · 2021-11-22T11:23:29Z

@JordanYates can you rebase and trigger the CI again?

carlocaione · 2021-11-22T17:37:38Z

Opened #40569 for the failing test

carlocaione · 2021-11-23T09:00:08Z

On the other hand @JordanYates can you review #40422? I think a lot of the issues are already solved in my PoC so it could be worthwhile taking that into account.

erwango · 2021-11-25T07:57:25Z

@galak Would you mind reviewing again ?
@JordanYates Maybe you could have a try to rebase on latest master to see if the reported error is fixed now ?

JordanYates · 2021-11-25T09:38:35Z

@JordanYates Maybe you could have a try to rebase on latest master to see if the reported error is fixed now ?

Done, I don't think it will make much difference though as the linked issue is still open

tejlmand

Thanks for this.

Please remember to add same support for the CMake based linker script generator.

And then a minor suggestion on naming,
Implementation wise, things looks good.

dts/bindings/arm/arm,dtcm.yaml

dts/bindings/base/linker.yaml

tests/lib/devicetree/api_ext/CMakeLists.txt

tejlmand · 2021-11-25T14:47:38Z

include/linker/devicetree_regions.h

We should have same behavior here, so that region names are picked up from devicetree if defined regardless of how the linker script is generated.

zephyr/cmake/linker_script/arm/linker.cmake

Lines 37 to 50 in 513517f

# TI CCFG Registers

zephyr_linker_dts_memory(NAME FLASH_CCFG FLAGS rwx NODELABEL ti_ccfg_partition)

# Data & Instruction Tightly Coupled Memory

zephyr_linker_dts_memory(NAME ITCM FLAGS rw CHOSEN "zephyr,itcm")

zephyr_linker_dts_memory(NAME DTCM FLAGS rw CHOSEN "zephyr,dtcm")

zephyr_linker_dts_memory(NAME SRAM1 FLAGS rw NODELABEL sram1)

zephyr_linker_dts_memory(NAME SRAM2 FLAGS rw NODELABEL sram2)

zephyr_linker_dts_memory(NAME SRAM3 FLAGS rw NODELABEL sram3)

zephyr_linker_dts_memory(NAME SRAM4 FLAGS rw NODELABEL sram4)

zephyr_linker_dts_memory(NAME SDRAM1 FLAGS rw NODELABEL sdram1)

zephyr_linker_dts_memory(NAME SDRAM2 FLAGS rw NODELABEL sdram2)

zephyr_linker_dts_memory(NAME BACKUP_SRAM FLAGS rw NODELABEL backup_sram)

which would be in this function where name from region property used, otherwise fallback on node path.

zephyr/cmake/extensions.cmake

Line 3109 in 513517f

function(zephyr_linker_dts_memory)

Introduce optional `zephyr,linker-region` property which signifies that the node should result in a linker memory region and what the name of that region should be. Property added to compatibles likely to result in a linker memory region; 'mmio-sram', 'arm,itcm`, `arm,dtcm`, `nxp,imx-itcm`, `nxp,imx-dtcm` and `fixed-partitions`. Signed-off-by: Jordan Yates <[email protected]>

Add checks to ensure that `zephyr,linker-region` property values are always globally unique. Signed-off-by: Jordan Yates <[email protected]>

Adds a macro to convert a devicetree node to the name of a linker memory region. Signed-off-by: Jordan Yates <[email protected]>

Add a new application for testing non-core devicetree functionality. Add tests for the default and fallback case of `LINKER_DT_NODE_REGION_NAME`. Signed-off-by: Jordan Yates <[email protected]>

As memory region names are now derived purely from devicetree, remove the `name` parameter from `DT_REGION_FROM_NODE_STATUS_OKAY`. Name is `zephyr,linker-region` if it exists, otherwise the node path. Signed-off-by: Jordan Yates <[email protected]>

stale

Update the linker script generator to automatically derive memory region names from the devicetree node according to the same logic in `devicetree_regions.h`. Signed-off-by: Jordan Yates <[email protected]>

Remove the `NAME` function argument from `zephyr_linker_dts_memory` as the name is now automatically derived from the devicetree node. Signed-off-by: Jordan Yates <[email protected]>

Add `zephyr,linker-region` properties to all nodes sram1, sram2, sram3, sram4, sdram1, sdram2, backup_sram, ti_ccfg, dtcm and itcm. Signed-off-by: Jordan Yates <[email protected]>

Link variables into derived section names instead of hardcoded names. Signed-off-by: Jordan Yates <[email protected]>

tejlmand

All changes looks good.

tejlmand · 2021-12-09T14:32:26Z

dts/bindings/base/mem-region.yaml

+# Common fields for devices resulting in linker memory regions
+
+properties:
+  zephyr,memory-region:


Nothing wrong on this line but with the latest update you are now using memory-region
👍 to that :)

But the commit message still says e06bc25:

dts: bindings: zephyr,linker-region property

Introduce optional zephyr,linker-region property

Note: same goes for some other commit messages.

tejlmand · 2021-12-09T14:50:37Z

cmake/extensions.cmake

+  if (NOT DEFINED name)
+    # Fallback to the node path
+    set(name ${DTS_MEMORY_PATH})
+  endif()


minor nit, it's possible to do:

Suggested change

if (NOT DEFINED name)

# Fallback to the node path

set(name ${DTS_MEMORY_PATH})

endif()

set_ifndef(name ${DTS_MEMORY_PATH})

zephyr/cmake/extensions.cmake

Line 1619 in 92fbd7d

function(set_ifndef variable value)

tejlmand

Consider cleanup the commit message before merging to avoid later confusion if later doing a bisect.

Approving as code looks good.

JordanYates requested review from ABOSTM, FRASTM, MaureenHelm, andyross, bwitherspoon, carlescufi, dcpleung, dleach02, erwango, galak, ioannisg, mbolivar-nordic, mmahadevan108, nandojve and nashif as code owners July 28, 2021 11:17

github-actions bot added area: Boards area: Devicetree platform: STM32 ST Micro STM32 labels Jul 28, 2021

galak reviewed Jul 28, 2021

View reviewed changes

include/devicetree.h Outdated Show resolved Hide resolved

galak requested changes Jul 28, 2021

View reviewed changes

zephyrbot added platform: NXP NXP platform: nRF Nordic nRFx labels Jul 28, 2021

zephyrbot assigned erwango Jul 28, 2021

mbolivar-nordic reviewed Jul 29, 2021

View reviewed changes

include/devicetree.h Outdated Show resolved Hide resolved

tests/lib/devicetree/api/app.overlay Outdated Show resolved Hide resolved

mbolivar-nordic mentioned this pull request Aug 5, 2021

linker: rename DT_REGION_FROM_NODE_STATUS_OKAY #37484

Merged

mbolivar-nordic reviewed Aug 5, 2021

View reviewed changes

include/linker/devicetree_regions.h Outdated Show resolved Hide resolved

mbolivar-nordic reviewed Aug 9, 2021

View reviewed changes

tests/lib/devicetree/api_ext/src/main.c Outdated Show resolved Hide resolved

carlocaione reviewed Nov 22, 2021

View reviewed changes

carlocaione approved these changes Nov 22, 2021

View reviewed changes

erwango approved these changes Nov 22, 2021

View reviewed changes

carlocaione mentioned this pull request Nov 23, 2021

[POC | RFC | DNM] Introducing framework to configure MPU regions from DT-defined SRAM regions #40422

Closed

tejlmand requested changes Nov 25, 2021

View reviewed changes

carlocaione closed this Dec 9, 2021

carlocaione reopened this Dec 9, 2021

Jordan Yates added 5 commits December 9, 2021 20:34

scripts: gen_defines: zephyr,linker-region unique

cebc913

Add checks to ensure that `zephyr,linker-region` property values are always globally unique. Signed-off-by: Jordan Yates <[email protected]>

devicetree: LINKER_DT_NODE_REGION_NAME added

29f510c

Adds a macro to convert a devicetree node to the name of a linker memory region. Signed-off-by: Jordan Yates <[email protected]>

tests: devicetree: test LINKER_DT_NODE_REGION_NAME

fe500bb

Add a new application for testing non-core devicetree functionality. Add tests for the default and fallback case of `LINKER_DT_NODE_REGION_NAME`. Signed-off-by: Jordan Yates <[email protected]>

cmake: zephyr_linker_dts_memory auto-name

a55b6e4

Update the linker script generator to automatically derive memory region names from the devicetree node according to the same logic in `devicetree_regions.h`. Signed-off-by: Jordan Yates <[email protected]>

github-actions bot added the area: Build System label Dec 9, 2021

Jordan Yates added 3 commits December 9, 2021 21:53

cmake: zephyr_linker_dts_memory no name param

773c637

Remove the `NAME` function argument from `zephyr_linker_dts_memory` as the name is now automatically derived from the devicetree node. Signed-off-by: Jordan Yates <[email protected]>

dts: linker region properties

4846b0d

Add `zephyr,linker-region` properties to all nodes sram1, sram2, sram3, sram4, sdram1, sdram2, backup_sram, ti_ccfg, dtcm and itcm. Signed-off-by: Jordan Yates <[email protected]>

linker: link into derived section names

47646a5

Link variables into derived section names instead of hardcoded names. Signed-off-by: Jordan Yates <[email protected]>

tejlmand reviewed Dec 9, 2021

View reviewed changes

tejlmand approved these changes Dec 9, 2021

View reviewed changes

carlescufi approved these changes Dec 9, 2021

View reviewed changes

carlescufi merged commit f408f42 into zephyrproject-rtos:main Dec 9, 2021

fabiobaltieri mentioned this pull request Dec 9, 2021

Fix few missing memory region names on stm32 boards #41049

Merged

carlocaione mentioned this pull request Dec 15, 2021

dt/mpu: Generate MPU regions from SRAM DT nodes #41223

Closed

JordanYates deleted the 210728_linker_name_prop branch August 15, 2022 11:43

	# TI CCFG Registers
	zephyr_linker_dts_memory(NAME FLASH_CCFG FLAGS rwx NODELABEL ti_ccfg_partition)

	# Data & Instruction Tightly Coupled Memory
	zephyr_linker_dts_memory(NAME ITCM FLAGS rw CHOSEN "zephyr,itcm")
	zephyr_linker_dts_memory(NAME DTCM FLAGS rw CHOSEN "zephyr,dtcm")

	zephyr_linker_dts_memory(NAME SRAM1 FLAGS rw NODELABEL sram1)
	zephyr_linker_dts_memory(NAME SRAM2 FLAGS rw NODELABEL sram2)
	zephyr_linker_dts_memory(NAME SRAM3 FLAGS rw NODELABEL sram3)
	zephyr_linker_dts_memory(NAME SRAM4 FLAGS rw NODELABEL sram4)
	zephyr_linker_dts_memory(NAME SDRAM1 FLAGS rw NODELABEL sdram1)
	zephyr_linker_dts_memory(NAME SDRAM2 FLAGS rw NODELABEL sdram2)
	zephyr_linker_dts_memory(NAME BACKUP_SRAM FLAGS rw NODELABEL backup_sram)

linker: aarch32: automatic derivation of region names from devicetree nodes #37279

linker: aarch32: automatic derivation of region names from devicetree nodes #37279

Uh oh!

Conversation

JordanYates commented Jul 28, 2021

Uh oh!

JordanYates commented Jul 28, 2021

Uh oh!

Uh oh!

galak left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mbolivar-nordic commented Jul 29, 2021

Uh oh!

JordanYates commented Aug 1, 2021

Uh oh!

mbolivar-nordic left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

carlocaione commented Nov 22, 2021

Uh oh!

carlocaione commented Nov 22, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

carlocaione commented Nov 23, 2021

Uh oh!

erwango commented Nov 25, 2021

Uh oh!

JordanYates commented Nov 25, 2021

Uh oh!

tejlmand left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tejlmand left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tejlmand left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

carlocaione commented Nov 22, 2021 •

edited

Loading