aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAdin Ackerman <[email protected]>2024-01-16 20:00:39 -0800
committerAdin Ackerman <[email protected]>2024-01-16 20:00:39 -0800
commitb825f76c285cc7dae518f67506f0cc0fdc6d540a (patch)
tree29cbef0efe4a96a433594ea6277aeddb7380d87d /docs
parent9cd0beaee37f9e1cc885ad162b63bca795478227 (diff)
add extra info to stable arena usage
Diffstat (limited to 'docs')
-rw-r--r--docs/modules/ROOT/pages/faq.adoc19
1 files changed, 18 insertions, 1 deletions
diff --git a/docs/modules/ROOT/pages/faq.adoc b/docs/modules/ROOT/pages/faq.adoc
index b33623053..147f119b0 100644
--- a/docs/modules/ROOT/pages/faq.adoc
+++ b/docs/modules/ROOT/pages/faq.adoc
@@ -158,8 +158,25 @@ Note that the git revision should match any other embassy patches or git depende
158 158
159When you aren't using the `nightly` feature of `embassy-executor`, the executor uses a bump allocator, which may require configuration. 159When you aren't using the `nightly` feature of `embassy-executor`, the executor uses a bump allocator, which may require configuration.
160 160
161Something like this error will occur at **compile time** if the task arena is *too large* for the target's RAM:
162
163[source,plain]
164----
165rust-lld: error: section '.bss' will not fit in region 'RAM': overflowed by _ bytes
166rust-lld: error: section '.uninit' will not fit in region 'RAM': overflowed by _ bytes
167----
168
169And this message will appear at **runtime** if the task arena is *too small* for the tasks running:
170
171[source,plain]
172----
173ERROR panicked at 'embassy-executor: task arena is full. You must increase the arena size, see the documentation for details: https://docs.embassy.dev/embassy-executor/'
174----
175
176NOTE: If all tasks are spawned at startup, this panic will occur immediately.
177
161Check out link:https://docs.embassy.dev/embassy-executor/git/cortex-m/index.html#task-arena[Task Arena Documentation] for more details. 178Check out link:https://docs.embassy.dev/embassy-executor/git/cortex-m/index.html#task-arena[Task Arena Documentation] for more details.
162 179
163== Can I use manual ISRs alongside Embassy? 180== Can I use manual ISRs alongside Embassy?
164 181
165Yes! This can be useful if you need to respond to an event as fast as possible, and the latency caused by the usual “ISR, wake, return from ISR, context switch to woken task” flow is too much for your application. Simply define a `#[interrupt] fn INTERRUPT_NAME() {}` handler as you would link:https://docs.rust-embedded.org/book/start/interrupts.html[in any other embedded rust project]. \ No newline at end of file 182Yes! This can be useful if you need to respond to an event as fast as possible, and the latency caused by the usual “ISR, wake, return from ISR, context switch to woken task” flow is too much for your application. Simply define a `#[interrupt] fn INTERRUPT_NAME() {}` handler as you would link:https://docs.rust-embedded.org/book/start/interrupts.html[in any other embedded rust project].