-
Notifications
You must be signed in to change notification settings - Fork 8.2k
[RFC] Make zephyr,memory-attr a capabilities bitmask
#61009
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[RFC] Make zephyr,memory-attr a capabilities bitmask
#61009
Conversation
zephyr,memory-attr to a capabilities bitmaskzephyr,memory-attr a capabilities bitmask
zephyr,memory-attr a capabilities bitmaskzephyr,memory-attr a capabilities bitmask
|
I'm a little confused. I understand I can use But would these result in the same MPU entry if added to an ARM's .dts file? |
No, you can create an
I tried to be as much clear as possible here: https://github.com/zephyrproject-rtos/zephyr/blob/5664796d1f5b525dc27bb6dfc862c35e7c5b7b13/doc/services/mem_mgmt/index.rst?plain=1#L57-L64 |
|
LGTM on Xtensa. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the nice doc and for a smooth migration path. I have a few minor questions and nitpicks
Given that @teburd and @evgeniy-paltsev are both in the conversation I will dismiss the -1 after we get a +1 from both. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
refresh +1
|
@carlocaione please rebase |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, a couple of nonblocking suggestions. Thanks for taking the time to document the transition guide.
|
Adding DNM because this needs to be squashed before merging. |
This is the final step in making the `zephyr,memory-attr` property
actually useful.
The problem with the current implementation is that `zephyr,memory-attr`
is an enum type, this is making very difficult to use that to actually
describe the memory capabilities. The solution proposed in this PR is to
use the `zephyr,memory-attr` property as an OR-ed bitmask of memory
attributes.
With the change proposed in this PR it is possible in the DeviceTree to
mark the memory regions with a bitmask of attributes by using the
`zephyr,memory-attr` property. This property and the related memory
region can then be retrieved at run-time by leveraging a provided helper
library or the usual DT helpers.
The set of general attributes that can be specified in the property are
defined and explained in
`include/zephyr/dt-bindings/memory-attr/memory-attr.h` (the list can be
extended when needed).
For example, to mark a memory region in the DeviceTree as volatile,
non-cacheable, out-of-order:
mem: memory@10000000 {
compatible = "mmio-sram";
reg = <0x10000000 0x1000>;
zephyr,memory-attr = <( DT_MEM_VOLATILE |
DT_MEM_NON_CACHEABLE |
DT_MEM_OOO )>;
};
The `zephyr,memory-attr` property can also be used to set
architecture-specific custom attributes that can be interpreted at run
time. This is leveraged, among other things, to create MPU regions out
of DeviceTree defined memory regions on ARM, for example:
mem: memory@10000000 {
compatible = "mmio-sram";
reg = <0x10000000 0x1000>;
zephyr,memory-region = "NOCACHE_REGION";
zephyr,memory-attr = <( DT_ARM_MPU(ATTR_MPU_RAM_NOCACHE) )>;
};
See `include/zephyr/dt-bindings/memory-attr/memory-attr-mpu.h` to see
how an architecture can define its own special memory attributes (in
this case ARM MPU).
The property can also be used to set custom software-specific
attributes. For example we can think of marking a memory region as
available to be used for memory allocation (not yet implemented):
mem: memory@10000000 {
compatible = "mmio-sram";
reg = <0x10000000 0x1000>;
zephyr,memory-attr = <( DT_MEM_NON_CACHEABLE |
DT_MEM_SW_ALLOCATABLE )>;
};
Or maybe we can leverage the property to specify some alignment
requirements for the region:
mem: memory@10000000 {
compatible = "mmio-sram";
reg = <0x10000000 0x1000>;
zephyr,memory-attr = <( DT_MEM_CACHEABLE |
DT_MEM_SW_ALIGN(32) )>;
};
The conventional and recommended way to deal and manage with memory
regions marked with attributes is by using the provided `mem-attr`
helper library by enabling `CONFIG_MEM_ATTR` (or by using the usual DT
helpers).
When this option is enabled the list of memory regions and their
attributes are compiled in a user-accessible array and a set of
functions is made available that can be used to query, probe and act on
regions and attributes, see `include/zephyr/mem_mgmt/mem_attr.h`
Note that the `zephyr,memory-attr` property is only a descriptive
property of the capabilities of the associated memory region, but it
does not result in any actual setting for the memory to be set. The
user, code or subsystem willing to use this information to do some work
(for example creating an MPU region out of the property) must use either
the provided `mem-attr` library or the usual DeviceTree helpers to
perform the required work / setting.
Signed-off-by: Carlo Caione <[email protected]>
This is the final step in making the
zephyr,memory-attrproperty actually useful.The problem with the current implementation is that
zephyr,memory-attris an enum type, this is making very difficult to use that to actually describe the memory capabilities. The solution proposed in this PR is to use thezephyr,memory-attrproperty as an OR-ed bitmask of memory attributes.Important
With the change proposed in this PR it is possible in the DeviceTree to mark the memory regions with a bitmask of attributes by using the
zephyr,memory-attrproperty. This property and the related memory region can then be retrieved at run-time by leveraging a provided helper library or the usual DT helpers.The set of general attributes that can be specified in the property are defined and explained in
include/zephyr/dt-bindings/memory-attr/memory-attr.h(the list can be extended when needed).https://github.com/zephyrproject-rtos/zephyr/blob/5664796d1f5b525dc27bb6dfc862c35e7c5b7b13/include/zephyr/dt-bindings/memory-attr/memory-attr.h#L16-L20
For example, to mark a memory region in the DeviceTree as volatile, non-cacheable, out-of-order:
Important
The
zephyr,memory-attrproperty can also be used to set architecture-specific custom attributes that can be interpreted at run time. This is leveraged, among other things, to create MPU regions out of DeviceTree defined memory regions on ARM, for example:See
include/zephyr/dt-bindings/memory-attr/memory-attr-mpu.hto see how an architecture can define its own special memory attributes (in this case ARM MPU).Important
The property can also be used to set custom software-specific attributes. For example we can think of marking a memory region as available to be used for memory allocation (not yet implemented):
Or maybe we can leverage the property to specify some alignment requirements for the region:
Important
The conventional and recommended way to deal and manage with memory regions marked with attributes is by using the provided
mem-attrhelper library by enablingCONFIG_MEM_ATTR(or by using the usual DT helpers).When this option is enabled the list of memory regions and their attributes are compiled in a user-accessible array and a set of functions is made available that can be used to query, probe and act on regions and attributes, see
include/zephyr/mem_mgmt/mem_attr.hNote
Note that the
zephyr,memory-attrproperty is only a descriptive property of the capabilities of the associated memory region, but it does not result in any actual setting for the memory to be set. The user, code or subsystem willing to use this information to do some work (for example creating an MPU region out of the property) must use either the providedmem-attrlibrary or the usual DeviceTree helpers to perform the required work / setting.Note: how to review this PR
Warning
Unfortunately this PR cannot be divided into smaller PRs to not break bisectability.
In general this PR we are:
zephyr,memory-attr, these were recently introduced but proved to not be up to the taskintversion of the DT property, seedts/bindings/base/zephyr,memory-attr.yaml,include/zephyr/dt-bindings/memory-attr/memory-attr.handinclude/zephyr/dt-bindings/memory-attr/memory-attr-mpu.hmem-attrlibrary, seeinclude/zephyr/mem_mgmt/mem_attr.handsubsys/mem_mgmt/mem_attr.cmem-attrto create the DT-defined MPU regions: seearch/arm/core/aarch32/mpu/arm_mpu.candarch/arm64/core/cortex_r/arm_mpu.cenumtointdoc/services/mem_mgmt/index.rst