From 80b81ef122e68744744df9e866fec3263a0d7e11 Mon Sep 17 00:00:00 2001 From: Nathan Date: Thu, 29 Dec 2022 10:20:46 -0600 Subject: [PATCH] Update example with SRP priority ceiling --- book/en/src/internals/targets.md | 41 +++++++++++++++++++------------- 1 file changed, 24 insertions(+), 17 deletions(-) diff --git a/book/en/src/internals/targets.md b/book/en/src/internals/targets.md index da55937157..dfb68deaef 100644 --- a/book/en/src/internals/targets.md +++ b/book/en/src/internals/targets.md @@ -1,12 +1,17 @@ # Target Architecture While RTIC can currently target all Cortex-m devices there are some key architecure differences that -users should be aware of. Namely the absence of Base Priority Mask Register (`BASEPRI`) which lends itself exceptionally well to the hardware priority ceiling support used in RTIC, in the -ARMv6-M and ARMv8-M-base architectures, which forces RTIC to use source masking instead. For each implementation of lock and a detailed commentary of pros and cons, see the implementation of [lock in src/export.rs][src_export]. +users should be aware of. Namely the absence of Base Priority Mask Register (`BASEPRI`) which lends +itself exceptionally well to the hardware priority ceiling support used in RTIC, in the ARMv6-M and +ARMv8-M-base architectures, which forces RTIC to use source masking instead. For each implementation +of lock and a detailed commentary of pros and cons, see the implementation of +[lock in src/export.rs][src_export]. [src_export]: https://github.com/rtic-rs/cortex-m-rtic/blob/master/src/export.rs -These differences influence how critical sections are realized, but functionality should be the same except that ARMv6-M/ARMv8-M-base cannot have tasks with shared resources bound to exception handlers, as these cannot be masked in hardware. +These differences influence how critical sections are realized, but functionality should be the same +except that ARMv6-M/ARMv8-M-base cannot have tasks with shared resources bound to exception +handlers, as these cannot be masked in hardware. Table 1 below shows a list of Cortex-m processors and which type of critical section they employ. @@ -18,21 +23,20 @@ Table 1 below shows a list of Cortex-m processors and which type of critical sec | Cortex-M0+ | ARMv6-M | | ઙ | | Cortex-M3 | ARMv7-M | ઙ | | | Cortex-M4 | ARMv7-M | ઙ | | +| Cortex-M7 | ARMv7-M | ઙ | | | Cortex-M23 | ARMv8-M-base | | ઙ | | Cortex-M33 | ARMv8-M-main | ઙ | | -| Cortex-M7 | ARMv7-M | ઙ | | ## Priority Ceiling -This implementation is covered in depth by Chapter 4.5 of this book. +This implementation is covered in depth by the [Critical Sections][critical_sections] page of this book. ## Source Masking Without a `BASEPRI` register which allows for directly setting a priority ceiling in the Nested Vectored Interrupt Controller (NVIC), RTIC must instead rely on disabling (masking) interrupts. - -Consider Figure 1 below, -showing two tasks A and B where A has higher priority but shares a resource with B. +Consider Figure 1 below, showing two tasks A and B where A has higher priority but shares a resource +with B. #### *Figure 1: Shared Resources and Source Masking* @@ -50,15 +54,18 @@ showing two tasks A and B where A has higher priority but shares a resource with t1 t2 t3 t4 ``` -At time *t1*, task B locks the shared resource by selectively disabling all other tasks which share -the resource using the NVIC. In effect this raises the virtual priority ceiling. Task A is one such -task that shares resources with task B. At time *t2*, task A is either spawned by task B or becomes -pending through an interrupt condition, but does not yet preempt task B even though its priority is -greater. This is because the NVIC is preventing it from starting due to task A's source mask being -disabled. At time *t3*, task B releases the lock by re-enabling the tasks in the NVIC. Because -task A was pending and has a higher priority than task B, it immediately preempts task B and is -free to use the shared resource without risk of data race conditions. At time *t4*, task A completes -and returns the execution context to B. +At time *t1*, task B locks the shared resource by selectively disabling (using the NVIC) all other +tasks which have a priority equal to or less than any task which shares resouces with B. In effect +this creates a virtual priority ceiling, miroring the `BASEPRI` approach described in the +[Critical Sections][critical_Sections] page. Task A is one such task that shares resources with +task B. At time *t2*, task A is either spawned by task B or becomes pending through an interrupt +condition, but does not yet preempt task B even though its priority is greater. This is because the +NVIC is preventing it from starting due to task A being being disabled. At time *t3*, task B +releases the lock by re-enabling the tasks in the NVIC. Because task A was pending and has a higher +priority than task B, it immediately preempts task B and is free to use the shared resource without +risk of data race conditions. At time *t4*, task A completes and returns the execution context to B. Since source masking relies on use of the NVIC, core exception sources such as HardFault, SVCall, PendSV, and SysTick cannot share data with other tasks. + +[critical_sections]: https://github.com/rtic-rs/cortex-m-rtic/blob/master/book/en/src/internals/critical-sections.md