Skip to content

Commit 8eb3a72

Browse files
committed
doc(port_arm_m): discourage from calling a kernel function with interrupts disabled
1 parent 8408a5c commit 8eb3a72

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/r3_port_arm_m/src/lib.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,10 @@ As a general thumb rule, you should not directly access hardware registers (e.g.
4949

5050
This port agrees with `::cortex_m` in that updating `PRIMASK` is `unsafe` because using it incorrectly can break a certain type of critical section.
5151

52+
Calling a kernel function with interrupts disabled is strongly discouraged as doing so will lead to a deadlock or a [`BadContext`][] error.
53+
54+
[`BadContext`]: r3_core::kernel::ResultCode::BadContext
55+
5256
## Stack Overflow
5357

5458
This port doesn't support detecting stack overflow.

0 commit comments

Comments
 (0)