From 9585c8f45f44f976c359286d71f1b8f2ae6fdf5f Mon Sep 17 00:00:00 2001 From: Neha Malcom Francis Date: Wed, 10 Sep 2025 09:40:39 -0600 Subject: doc: memory: Restore missing diagram When applying the patch that became commit a2d881f5bcd3 ("doc: memory: Add documentation for system RAM") one of the diagrams was missed. Re-add this missing file. Reported-by: Adriano Carvalho Fixes: a2d881f5bcd3 doc: memory: Add documentation for system RAM Signed-off-by: Neha Malcom Francis [trini: Take Neha's original svg and re-apply it] Signed-off-by: Tom Rini --- doc/develop/pics/spl_before_reloc.svg | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'doc/develop') diff --git a/doc/develop/pics/spl_before_reloc.svg b/doc/develop/pics/spl_before_reloc.svg index e69de29bb2d..f3a42ab7792 100644 --- a/doc/develop/pics/spl_before_reloc.svg +++ b/doc/develop/pics/spl_before_reloc.svg @@ -0,0 +1,4 @@ + + + +
Stack
Global Data
SPL BSS
Heap
0x0
CONFIG_SPL_SIZE_LIMIT_PROVIDE_STACK
gd->malloc_base
CONFIG_SPL_STACK or CONFIG_SYS_INIT_SP_ADDR
gd, gd->start_addr_sp
CONFIG_SYS_MALLOC_F_LEN
CONFIG_SPL_BSS_MAX_SIZE
Ready RAM (SRAM, locked cache etc.) SPL before relocation
CONFIG_SPL_BSS_START_ADDR
 \ No newline at end of file -- cgit v1.2.3 From 0e4fad5f419eb55b0e141c8c229e520724c5b378 Mon Sep 17 00:00:00 2001 From: Anshul Dalal Date: Wed, 17 Sep 2025 18:57:31 +0530 Subject: doc: memory: fix encodings for spl layout diagrams The commit 284ef1bbcefc ("doc: memory: Add documentation for system RAM") added documentation for U-Boot's memory usage along with diagrams showcasing the SPL's memory usage. Although the SVGs for the diagrams were improperly encoded. Therefore, this patch fixes the older SVGs with one's with better encoding and reduced size created using inkscape[1]. [1]: https://inkscape.org/ Reported-by: Alexander Dahl Fixes: 284ef1bbcefc ("doc: memory: Add documentation for system RAM") Signed-off-by: Anshul Dalal --- doc/develop/pics/spl_after_reloc.svg | 297 +++++++++++++++++++++++++- doc/develop/pics/spl_before_reloc.svg | 390 +++++++++++++++++++++++++++++++++- 2 files changed, 679 insertions(+), 8 deletions(-) (limited to 'doc/develop') diff --git a/doc/develop/pics/spl_after_reloc.svg b/doc/develop/pics/spl_after_reloc.svg index 93e3d599526..052ae3fcc8f 100644 --- a/doc/develop/pics/spl_after_reloc.svg +++ b/doc/develop/pics/spl_after_reloc.svg @@ -1,4 +1,293 @@ - - - -
Heap (simple_malloc)
Global Data
Stack
0x0
CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN
gd->malloc_base
gd, gd->start_addr_sp
CONFIG_SPL_STACK_R_ADDR
DRAM SPL after relocation
SPL BSS
CONFIG_SPL_BSS_MAX_SIZE
CONFIG_SPL_BSS_START_ADDR
 \ No newline at end of file + + + + + + + + + + + + + + + + + + + + + + + + + + + + DRAM SPL after relocation + + + Heap (simple_malloc) + Global Data + Stack + SPL BSS + + + + + + + gd, gd->start_addr_sp + CONFIG_SPL_STACK_R_ADDR + CONFIG_SPL_BSS_START_ADDR + CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN + 0x0 + + + gd->malloc_base + + + CONFIG_SPL_BSS_MAX_SIZE + + + diff --git a/doc/develop/pics/spl_before_reloc.svg b/doc/develop/pics/spl_before_reloc.svg index f3a42ab7792..7b967097ff9 100644 --- a/doc/develop/pics/spl_before_reloc.svg +++ b/doc/develop/pics/spl_before_reloc.svg @@ -1,4 +1,386 @@ - - - -
Stack
Global Data
SPL BSS
Heap
0x0
CONFIG_SPL_SIZE_LIMIT_PROVIDE_STACK
gd->malloc_base
CONFIG_SPL_STACK or CONFIG_SYS_INIT_SP_ADDR
gd, gd->start_addr_sp
CONFIG_SYS_MALLOC_F_LEN
CONFIG_SPL_BSS_MAX_SIZE
Ready RAM (SRAM, locked cache etc.) SPL before relocation
CONFIG_SPL_BSS_START_ADDR
 \ No newline at end of file + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Ready RAM (SRAM, locked cache etc.) SPL before relocation + + + Stack + Global Data + Heap + SPL BSS + + + + + + + + + + gd, gd->start_addr_sp + gd->malloc_base + CONFIG_SPL_STACK orCONFIG_SYS_INIT_SP_ADDR + CONFIG_SPL_BSS_START_ADDR + CONFIG_SPL_SIZE_LIMIT_PROVIDE_STACK + 0x0 + + + + + CONFIG_SYS_MALLOC_F_LEN + CONFIG_SPL_BSS_MAX_SIZE + + + -- cgit v1.2.3 From 7b5e66a2b3a2501dcff077fcc26ea55d6c5fba6e Mon Sep 17 00:00:00 2001 From: Tom Rini Date: Tue, 23 Sep 2025 11:54:29 -0600 Subject: doc: develop: process: Add note about asking for feedback It can be unclear to contributors what to do if they haven't gotten any feedback on patches they have submitted. Add a sentence saying that if they feel it's been too long without any comment, it's OK to reply again. Signed-off-by: Tom Rini --- doc/develop/process.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'doc/develop') diff --git a/doc/develop/process.rst b/doc/develop/process.rst index 0c6fb31e87b..4bfbf0eb9c6 100644 --- a/doc/develop/process.rst +++ b/doc/develop/process.rst @@ -139,7 +139,9 @@ comments). Even a "I have no time now, will look into it later" message is better than nothing. Also, if there are remarks to a patch, these should leave no doubt if they were just comments and the patch will be accepted anyway, or if the patch should be -reworked/resubmitted, or if it was rejected. +reworked/resubmitted, or if it was rejected. However, if a submitter +feels it has been too long since posting their patch and not received +any feedback, it is OK to follow-up and ask. Review Process, Git Tags ------------------------ -- cgit v1.2.3 From c9aad6dbd97b44fccaf761a1f07932ae567d76b7 Mon Sep 17 00:00:00 2001 From: E Shattow Date: Tue, 23 Sep 2025 15:30:50 -0700 Subject: doc: Update mentions of README.fdt-control Update documents 'README.fdt-control' reference to replacement 'control.rst': doc/arch/nios2.rst dts/Makefile Also convert some adjacent pathname mentions to rST links where applicable Fixes: 3e9fddfc4f14 "doc: Move devicetree control doc to rST" Signed-off-by: E Shattow --- doc/develop/devicetree/control.rst | 2 +- doc/develop/driver-model/ethernet.rst | 2 +- doc/develop/spl.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) (limited to 'doc/develop') diff --git a/doc/develop/devicetree/control.rst b/doc/develop/devicetree/control.rst index 0233945f8b6..8811e1d5c23 100644 --- a/doc/develop/devicetree/control.rst +++ b/doc/develop/devicetree/control.rst @@ -282,7 +282,7 @@ U-Boot can be divided into three phases: TPL, SPL and U-Boot proper. The full devicetree is available to U-Boot proper, but normally only a subset (or none at all) is available to TPL and SPL. See 'Pre-Relocation Support' and -'SPL Support' in doc/driver-model/design.rst for more details. +'SPL Support' in :doc:`/develop/driver-model/design` for more details. Using several DTBs in the SPL (SPL_MULTI_DTB_FIT Kconfig option) diff --git a/doc/develop/driver-model/ethernet.rst b/doc/develop/driver-model/ethernet.rst index 73c3a728dbf..2e1df744d4a 100644 --- a/doc/develop/driver-model/ethernet.rst +++ b/doc/develop/driver-model/ethernet.rst @@ -8,7 +8,7 @@ own ethernet device driver. Here we will describe a new pseudo 'APE' driver. Most existing drivers do already - and new network driver MUST - use the U-Boot core driver model. Generic information about this can be found in -doc/driver-model/design.rst, this document will thus focus on the network +:doc:`/develop/driver-model/design`, this document will thus focus on the network specific code parts. Some drivers are still using the old Ethernet interface, differences between the two and hints about porting will be handled at the end. diff --git a/doc/develop/spl.rst b/doc/develop/spl.rst index 7f2eac50806..08b51172014 100644 --- a/doc/develop/spl.rst +++ b/doc/develop/spl.rst @@ -145,7 +145,7 @@ fdtgrep is also used to remove: 'bootph-verify' (VPL)) All the nodes remaining in the SPL devicetree are bound -(see doc/driver-model/design.rst). +(see :doc:`/develop/driver-model/design`). NOTE: U-Boot migrated to a new schema for the u-boot,dm-* tags in 2023. Please update to use the new bootph-* tags as described in the -- cgit v1.2.3