Skip to content

Commit

Permalink
README: Clarify use of BSS during SPL board_init_f()
Browse files Browse the repository at this point in the history
The earlier commit....

commit a5a5d99 ("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.

Signed-off-by: Andreas Dannenberg <[email protected]>
Reviewed-by: Simon Goldschmidt <[email protected]>
  • Loading branch information
Andreas Dannenberg authored and trini committed Aug 20, 2019
1 parent a2ca54f commit 1425465
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down

0 comments on commit 1425465

Please sign in to comment.