- Notifications
You must be signed in to change notification settings - Fork1k
Support a .noinit section for variables#996
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
This is inspired by the linker sripts on the AVR architecture, whichsupport a .noinit section (or any section starting with .noinit,actually) for variables that should be allocated an address in RAM, butnot be initialized to any particular value (not even zero) on startup.These can then be used to remember values across resets.From the sketch perspective, this works exactly the same as on AVR: Justannote a global variable with `__attribute__((__section__(".noinit")))`and it will have an unpredictable value on power-up and retain its valueduring resets.To implement this without having to change all board-specific linkerscripts, the linker commandline is changed to pass the board-specificlinker script to the `--default-script` linker script, and change themain linker script (passed to `--script`, previously `-T`) to a generic"override" linker script. This new generic linker script contains an`INSERT BEFORE` command, which causes the linker to load it *in additionto* the default linker script, while adding an extra `.noinit` outputsection in the right place.Because these new variables take up RAM but have their own section inthe .elf file, they should be accounted for in the size summary aftercompilation. This is done by adapting the `recipe.size.regex.data` entryto include this new section.
fpistm left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Thanks@matthijskooijman
LGTM
fpistm commentedMar 19, 2020
@matthijskooijman |
matthijskooijman commentedMar 19, 2020
Thanks for the quick merge :-)
Of course, any suggestion on where would be appropriate? I was thinking maybe here:https://github.com/stm32duino/wiki/wiki/API and then make a new section "Other" (on the same level as "Built-in library") with "Uninitialized variables" under there? |
fpistm commentedMar 19, 2020
Sound good for me. |
This is inspired by the linker sripts on the AVR architecture, which
support a .noinit section (or any section starting with .noinit,
actually) for variables that should be allocated an address in RAM, but
not be initialized to any particular value (not even zero) on startup.
These can then be used to remember values across resets.
From the sketch perspective, this works exactly the same as on AVR: Just
annote a global variable with
__attribute__((__section__(".noinit")))and it will have an unpredictable value on power-up and retain its value
during resets.
To implement this without having to change all board-specific linker
scripts, the linker commandline is changed to pass the board-specific
linker script to the
--default-scriptlinker script, and change themain linker script (passed to
--script, previously-T) to a generic"override" linker script. This new generic linker script contains an
INSERT BEFOREcommand, which causes the linker to load itin additionto the default linker script, while adding an extra
.noinitoutputsection in the right place.
Because these new variables take up RAM but have their own section in
the .elf file, they should be accounted for in the size summary after
compilation. This is done by adapting the
recipe.size.regex.dataentryto include this new section.
I originally implemented this for the reset-to-bootloader in#710, but I think this is useful by itself as well, for sketches to use, even when#710 might not end up using this. Also, since this is distinct feature, it helps unclutter#710 by merging this separately.
To test it, consider the following sketch:
This shows the number of boots since the last POR by incrementing a noinit variable across resets. Note that when you first upload this, it might not start at 1 but at some arbitrary value, because typically the first boot after an upload is not a power-on-reset. To start at 1, disconnect and reconnect power.