Merge pull request #2386 from embassy-rs/jamesmunns-patch-2

[FAQ]: Link to Arena configuration docs
This commit is contained in:
Dario Nieuwenhuis 2024-01-02 17:48:25 +00:00 committed by GitHub
commit 73c85f5981
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -152,4 +152,10 @@ Note that the git revision should match any other embassy patches or git depende
* When using `InterruptExecutor`:
** disable `executor-thread`
** make `main`` spawn everything, then enable link:https://docs.rs/cortex-m/latest/cortex_m/peripheral/struct.SCB.html#method.set_sleeponexit[SCB.SLEEPONEXIT] and `loop { cortex_m::asm::wfi() }`
** *Note:* If you need 2 priority levels, using 2 interrupt executors is better than 1 thread executor + 1 interrupt executor.
** *Note:* If you need 2 priority levels, using 2 interrupt executors is better than 1 thread executor + 1 interrupt executor.
== How do I set up the task arenas on stable?
When you aren't using the `nightly` feature of `embassy-executor`, the executor uses a bump allocator, which may require configuration.
Check out link:https://docs.embassy.dev/embassy-executor/git/cortex-m/index.html#task-arena[Task Arena Documentation] for more details.