diff options
Diffstat (limited to 'pw_sync_baremetal/docs.rst')
| -rw-r--r-- | pw_sync_baremetal/docs.rst | 37 |
1 files changed, 22 insertions, 15 deletions
diff --git a/pw_sync_baremetal/docs.rst b/pw_sync_baremetal/docs.rst index 827679140..421af51a9 100644 --- a/pw_sync_baremetal/docs.rst +++ b/pw_sync_baremetal/docs.rst @@ -7,22 +7,29 @@ This is a set of backends for pw_sync that works on baremetal targets. It is not ready for use, and is under construction. .. note:: - All constructs in this baremetal backend do not support hardware multi-threading - (SMP, SMT, etc). + All constructs in this baremetal backend do not support hardware + multi-threading (SMP, SMT, etc). .. warning:: - It does not perform interrupt masking or disable global interrupts. This is not - safe to use yet! + It does not perform interrupt masking or disable global interrupts. This is + not safe to use yet! -------------------------------------- -pw_sync_baremetal's InterruptSpinLock -------------------------------------- -The interrupt spin-lock implementation makes a single attempt to acquire the lock -and asserts if it is unavailable. It does not perform interrupt masking or disable global -interrupts. +----------------- +InterruptSpinLock +----------------- +The interrupt spin-lock implementation makes a single attempt to acquire the +lock and asserts if it is unavailable. It does not perform interrupt masking or +disable global interrupts. -------------------------- -pw_sync_baremetal's Mutex -------------------------- -The mutex implementation makes a single attempt to acquire the lock and asserts if -it is unavailable. +----- +Mutex +----- +The mutex implementation makes a single attempt to acquire the lock and asserts +if it is unavailable. + +-------------- +RecursiveMutex +-------------- +The recursive mutex implementation counts the number of lock and unlock calls +and asserts if the mutex is unlocked too many times or destroyed while locked. +Note that recursive mutexes are not available for general use in Pigweed. |