segger_rtt: mark allocated struct as _SEGGER_RTT in ELF
#4124
Conversation
kernel/src/utilities/static_init.rs
Outdated
| // initialized. | ||
| &mut BUF.0 | ||
| }}; | ||
| ($T:ty, $N:expr) => {{ |
There was a problem hiding this comment.
| ($T:ty, $N:expr) => {{ | |
| ($T:ty, $N:expr $(,)?) => {{ |
There was a problem hiding this comment.
I think this should be a new macro that can be documented as to what the second parameter is and when it should be used. Macros are hard to document as it is, and the static_X infrastructure is fairly confusing already. This seems like a very niche use case and since we are already copying the macro I think it makes sense to not change the existing static_buf macro.
|
For posterity, if you like me were wondering how this worked already, the standard way that host-side tools find the RTT buffer is by looking for a sentinel in RAM. However, it does seem that Segger does suggest using the symbol |
|
Come to think of it, in concept this is somewhat similar to I don't know whether it could be combined with |
I will note that |
This is a de-facto standard for tools that interact with Segger RTT that allows them to find the shared memory buffer in the ELF
|
@bradjc @alexandruradovici @lschuermann revised to be a separate macro (that also fixes the syntax parsing error @alexandruradovici noticed). Suggestions on the documentation for the macro are welcome, I'm not sure how or what to say about how to use this beyond "it adds an export name". |
…y of `static_named_buf` Co-authored-by: Brad Campbell <bradjc5@gmail.com>
Pull Request Overview
This PR adds an ELF section name to the statically allocated Segger RTT struct to marking for tools on the host where to find that memory. This is a de-facto standard for tools that interact with Segger RTT that allows them to find the shared memory buffer in the ELF. For example,
probe-rsuses this.Testing Strategy
Running
probe-rs run --chip nRF52840_xxAA target/thumbv7em-none-eabi/release/sma_q3with an sma_q3 connected and watch for the Segger RTT output.TODO or Help Wanted
N/A
Documentation Updated
/docs, or no updates are required.Formatting
make prepush.