Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support a .noinit section for variables #996

Merged
merged 1 commit into from
Mar 19, 2020

Conversation

matthijskooijman
Copy link
Contributor

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-script linker script, and change the
main 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 addition
to
the default linker script, while adding an extra .noinit output
section 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.data entry
to 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:

unsigned boot_count __attribute__((__section__(".noinit")));

void setup() {
    Serial.begin(115200);
    while (!Serial); // Wait for serial port open

    // Initialize the variable only on first power-on reset
    if (__HAL_RCC_GET_FLAG(RCC_FLAG_PORRST))
        boot_count = 1;
    __HAL_RCC_CLEAR_RESET_FLAGS();
    
    Serial.print("Boot number: ");
    Serial.println(boot_count);
    ++boot_count;
}

void loop() { }

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.

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-script` linker script, and change the
main 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 addition
to* the default linker script, while adding an extra `.noinit` output
section 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.data` entry
to include this new section.
@fpistm fpistm self-requested a review March 19, 2020 11:08
@fpistm fpistm added this to In progress in STM32 core based on ST HAL via automation Mar 19, 2020
@fpistm fpistm added this to the 1.9.0 milestone Mar 19, 2020
STM32 core based on ST HAL automation moved this from In progress to Reviewer approved Mar 19, 2020
Copy link
Member

@fpistm fpistm left a 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 fpistm merged commit 57cdf76 into stm32duino:master Mar 19, 2020
STM32 core based on ST HAL automation moved this from Reviewer approved to Done Mar 19, 2020
@fpistm
Copy link
Member

fpistm commented Mar 19, 2020

@matthijskooijman
Please, could you add this to the wiki?

@matthijskooijman
Copy link
Contributor Author

Thanks for the quick merge :-)

Please, could you add this to the wiki?

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
Copy link
Member

fpistm commented Mar 19, 2020

Sound good for me.

@matthijskooijman matthijskooijman deleted the noinit-section branch March 20, 2020 10:49
@matthijskooijman
Copy link
Contributor Author

Documented here: https://github.com/stm32duino/wiki/wiki/API#Remembering-variables-across-resets

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants