Compiler error for any target when stack dump is enabled

[ghseb]

Description of defect
Compiler error due to undefined macro INITIAL_SP in

mbed-os/platform/source/mbed_error.c

Line 537 in e4b81f6

uint32_t msp_size = MAX(0, (int)INITIAL_SP - (int)msp_sp);

The related change was introduced via https://github.com/ARMmbed/mbed-os/pull/12140/files.

Target(s) affected by this defect ?
STM32

Toolchain(s) (name and version) displaying this defect ?
n/a

What version of Mbed-os are you using (tag or sha) ?
https://github.com/ARMmbed/mbed-os/tree/mbed-os-5.15.4

What version(s) of tools are you using. List all that apply (E.g. mbed-cli)
n/a

How is this defect reproduced ?
Set the following configuration parameters in mbed_app.json:

"platform.error-all-threads-info": true,
"platform.stack-dump-enabled": true,

[ciarmcom]

@ghseb This issue has an incomplete or old issue template.For future reference please use an up to date clone of the repository before raising issues. Many thanks.

[ciarmcom]

Thank you for raising this detailed GitHub issue. I am now notifying our internal issue triagers.
Internal Jira reference: https://jira.arm.com/browse/IOTOSM-3603

[jeromecoutant]

I think INITIAL_SP should be calculated from linker script ?

[ghseb]

Yes generating it from the linker script would be best. Setting the macro via mbed_app.json or targets.json works but its ugly and error prone (as the previous solution with mbed_rtx.h was and actually is for non STM32 targets).

There should some API (or reuse INITIAL_SP) that allows to retrieve the value and internally uses compiler dependent functionality. E.g. the following for IAR:

#pragma segment="CSTACK"
__segment_end("CSTACK");

[Patater]

This may be broken on any target, not just ST targets.

[jeromecoutant]

@Patater #14622 is requesting the same correction...

[0xc0170]

mbed_error uses INITIAL_SP. This is still documented as requirement (however it was removed from STM rtx file). See our docs: https://os.mbed.com/docs/mbed-os/v6.9/porting/porting-bootstrap.html

Steps to fix this:

• update mbed_error.c to use __INITIAL_SP that comes from cmsis (all toolchains)
• remove documentation requirement to defined INITIAL_SP

I'll send a fix now to do the first and we agree it is the right fix, I can fix docs as well.