Skip to contentSkip to conversation

README: Clarify use of BSS during SPL board_init_f()

PATCH New Andreas Dannenberg 3 participants 3 messages Aug 8, 2019 – Aug 21, 2019

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 README: Clarify use of BSS during SPL board_init_f()

The earlier commit....

commit a5a5d997b41a ("spl: Allow performing BSS init early before board_init_f()")

...introduced the ability to use BSS from SPL's board_init_f() as it may be required in certain exceptional use cases so go ahead and update the README to reflect this change. Note that as highlighted with the changes the use of the associated CONFIG option is generally not recommended.

---

Simon, as per separate discussion thread here is a proposal for an update to the README. I tried to limit the changes to the what I thought was the most relevant section (the details section) of the document to strike a balance between documenting it and limiting the amount of attention drawn to it...

--
Andreas Dannenberg
Texas Instruments Inc

 README | 7 +++++++
 1 file changed, 7 insertions(+)
README +7 -0
index b493ffeb2d..be3805689e 100644
@@ -267,6 +267,13 @@ board_init_f():
 	- preloader_console_init() can be called here in extremis
 	- should set up SDRAM, and anything needed to make the UART work
 	- these is no need to clear BSS, it will be done by crt0.S
+	- for specific scenarios on certain architectures an early BSS *can*
+	  be made available (via CONFIG_SPL_EARLY_BSS by moving the clearing
+	  of BSS prior to entering board_init_f()) but doing so is discouraged.
+	  Instead it is strongly recommended to architect any code changes
+	  or additions such to not depend on the availability of BSS during
+	  board_init_f() as indicated in other sections of this README to
+	  maintain compatibility and consistency across the entire code base.
 	- must return normally from this function (don't call board_init_r()
 		directly)
 
Signature · 1 line
2.17.1
#1 lore raw

PATCH 1/1 README: Clarify use of BSS during SPL board_init_f()

Am 08.08.2019 um 19:54 schrieb Andreas Dannenberg:

Quoted 10 lines

The earlier commit....

commit a5a5d997b41a ("spl: Allow performing BSS init early before board_init_f()")

...introduced the ability to use BSS from SPL's board_init_f() as it may be required in certain exceptional use cases so go ahead and update the README to reflect this change. Note that as highlighted with the changes the use of the associated CONFIG option is generally not recommended.

Since I expect the patch adding CONFIG_SPL_EARLY_BSS will stay with us:

Still, I'd be very happy if someone could come up with an idea of how we can detect usage of BSS before board_init_r. And patches fixing such invalid usage would be cool as well.

Regards,
Simon

Quoted 37 lines

---

Simon, as per separate discussion thread here is a proposal for an update to the README. I tried to limit the changes to the what I thought was the most relevant section (the details section) of the document to strike a balance between documenting it and limiting the amount of attention drawn to it...

--
Andreas Dannenberg
Texas Instruments Inc

  README | 7 +++++++
  1 file changed, 7 insertions(+)
README +7 -0
index b493ffeb2d..be3805689e 100644
@@ -267,6 +267,13 @@ board_init_f():
  	- preloader_console_init() can be called here in extremis
  	- should set up SDRAM, and anything needed to make the UART work
  	- these is no need to clear BSS, it will be done by crt0.S
+	- for specific scenarios on certain architectures an early BSS *can*
+	  be made available (via CONFIG_SPL_EARLY_BSS by moving the clearing
+	  of BSS prior to entering board_init_f()) but doing so is discouraged.
+	  Instead it is strongly recommended to architect any code changes
+	  or additions such to not depend on the availability of BSS during
+	  board_init_f() as indicated in other sections of this README to
+	  maintain compatibility and consistency across the entire code base.
  	- must return normally from this function (don't call board_init_r()
  		directly)
 
#2 lore raw

PATCH 1/1 README: Clarify use of BSS during SPL board_init_f()

In reply to Andreas Dannenberg
Quoted 11 lines · Andreas Dannenberg

The earlier commit....

commit a5a5d997b41a ("spl: Allow performing BSS init early before board_init_f()")

...introduced the ability to use BSS from SPL's board_init_f() as it may be required in certain exceptional use cases so go ahead and update the README to reflect this change. Note that as highlighted with the changes the use of the associated CONFIG option is generally not recommended.

Applied to u-boot/master, thanks!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20190821/bd39971e/attachment.sig>