Conversation
github-actions
bot
added
changelog-entry-required
|
You can find the documentation preview for this PR here. |
lemrey
force-pushed
the
memory-layout
branch
2 times, most recently
from
1ecb0fd to
91d85e6
Compare
| @@ -0,0 +1,501 @@ | |||
| #!/usr/bin/env python3 | |||
There was a problem hiding this comment.
I'm wondering if there is a good way we can run the script to autogenerate the images etc. on doc build instead of running the script manually and adding the files to the repository(?).
doc/_scripts/gen_memory_layouts.py
Outdated
| COLORS = { | ||
| "boot": "#00a9ce", | ||
| "storage": "#e97c25", | ||
| "peer_manager": "#d4883a", | ||
| "storage0": "#f0a050", | ||
| "slot0": "#00b89f", | ||
| "slot1": "#0090b0", | ||
| "softdevice": "#af7fe4", | ||
| "metadata": "#7929d2", | ||
| "(unused)": "#d0d5dd", | ||
| "KMU reserved": "#8b96a8", | ||
| "softdevice_static_ram": "#af7fe4", | ||
| "softdevice_dynamic_ram": "#cb99f6", | ||
| "app_ram": "#00b89f", | ||
| "retained_mem": "#7929d2", |
There was a problem hiding this comment.
The output does not look like it is Nordic brand.
lemrey
force-pushed
the
memory-layout
branch
2 times, most recently
from
4c7c239 to
0a55281
Compare
| "storage0": "Storage0 (ZMS)", | ||
| "slot0": "Application (slot0)", | ||
| "slot1": "FW Loader (slot1)", | ||
| "softdevice": "SoftDevice", |
There was a problem hiding this comment.
If we want to use the short elsewhere.
| "softdevice": "SoftDevice", | |
| "softdevice": "SoftDevice (SD)", |
There was a problem hiding this comment.
Updated to use the full name in the images
| .. rubric:: S145 + MCUboot | ||
|
|
||
| .. image:: images/bm_nrf54l15dk_nrf54l05_cpuapp_s145_softdevice_mcuboot.svg | ||
| :alt: nRF54L05 S145 + MCUboot memory layout |
There was a problem hiding this comment.
Would probably be good with a link here to the https://docs.nordicsemi.com/bundle/nrf-bm-latest/page/nrf-bm/app_dev/dfu/memory_partitioning.html documentation to explain the differences for SoftDevice etc.
lemrey
force-pushed
the
memory-layout
branch
6 times, most recently
from
bbb564c to
b6f10dc
Compare
github-actions
bot
removed
the
changelog-entry-required
lemrey
force-pushed
the
memory-layout
branch
from
b6f10dc to
47f7687
Compare
|
@nrfconnect/ncs-bm-doc please have a look :) |
| - ``app_ram`` | ||
| - RAM available for the application. | ||
| * - Retained Mem | ||
| - ``RetainedMem`` |
There was a problem hiding this comment.
This is not used, did you mean Retained RAM (MCUboot)?
| bm_nrf54lv10dk | ||
| ============== |
There was a problem hiding this comment.
Do we need to split on the DK, can we put LV10 together with the rest?
There was a problem hiding this comment.
Alternatively have two levels of tabs, one with the DK and one with the SoC where needed. Though in general I think the user is mostly interested on the SoC.
Or even three, I think that makes it a lot easier to compare as you can easily switch between different SoCs and see the images changing.
lemrey
force-pushed
the
memory-layout
branch
from
47f7687 to
6f2b27d
Compare
Add a section to show the memory layout for each board. The images are automatically generated by a script, which is also committed and can be run with python doc/_scripts/gen_memory_layouts.py Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>
lemrey
force-pushed
the
memory-layout
branch
from
6f2b27d to
09b59bb
Compare
2 participants
Add a section to show the memory layout for each board.
The images are automatically generated by a script, which is also committed.