Skip to content

Commit f59692a

Browse files
57300thst-nordic
authored andcommitted
doc: Describe Nordic owned memory binding changes
Added entries in the NCS 2.8 changelog and migration guide, saying that the `nordic,access` property is recommended, but the old properties are still usable. Signed-off-by: Grzegorz Swiderski <[email protected]>
1 parent 43ef9d8 commit f59692a

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed

doc/nrf/releases_and_maturity/migration/migration_guide_2.8.rst

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,49 @@ Serial LTE Modem (SLM)
183183
The :file:`overlay-native_tls.conf` overlay file is no longer supported with the ``thingy91/nrf9160/ns`` board target due to flash memory constraints.
184184
If you need to use native TLS with Thingy:91, you must disable features from the :file:`prj.conf` and :file:`overlay-native_tls.conf` configuration files to free up flash memory.
185185

186+
Devicetree
187+
----------
188+
189+
.. toggle::
190+
191+
The ``nordic,owned-memory`` and ``nordic,owned-partitions`` bindings have been updated, making these properties deprecated:
192+
193+
* ``owner-id``
194+
* ``perm-read``
195+
* ``perm-write``
196+
* ``perm-execute``
197+
* ``perm-secure``
198+
* ``non-secure-callable``
199+
200+
It is recommended to use the ``nordic,access`` property instead.
201+
The board files and sample overlays in the |NCS| are already updated to use it.
202+
See :file:`ncs/zephyr/dts/bindings/reserved-memory/nordic,owned-memory.yaml` for more details.
203+
204+
If both of the new and deprecated properties are set on the same devicetree node, then only ``nordic,access`` will take effect.
205+
Therefore, it may not be possible to override the default permissions of an existing memory node using the old properties.
206+
207+
Example before:
208+
209+
.. code-block:: devicetree
210+
211+
&cpuapp_ram0x_region {
212+
compatible = "nordic,owned-memory";
213+
owner-id = <2>;
214+
perm-read;
215+
perm-write;
216+
perm-execute;
217+
perm-secure;
218+
};
219+
220+
Example after:
221+
222+
.. code-block:: devicetree
223+
224+
&cpuapp_ram0x_region {
225+
compatible = "nordic,owned-memory";
226+
nordic,access = <NRF_OWNER_ID_APPLICATION NRF_PERM_RWXS>;
227+
};
228+
186229
Libraries
187230
=========
188231

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,17 @@ Build and configuration system
6666
This feature has never been functional.
6767
To configure the signing key, use any available Kconfig method.
6868

69+
* Deprecated the following devicetree properties:
70+
71+
* ``owner-id``
72+
* ``perm-read``
73+
* ``perm-write``
74+
* ``perm-execute``
75+
* ``perm-secure``
76+
* ``non-secure-callable``
77+
78+
It is recommended to replace them with the new devicetree property: ``nordic,access``.
79+
See the :ref:`migration guide <migration_2.8_recommended>` for more information.
6980

7081
Bootloaders and DFU
7182
===================

0 commit comments

Comments
 (0)