michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Fix sys_mutex and futex missing documentation

Browse source 
Adds API reference for sys_mutex and futex to mutex documentation,
adds Doxygen documentation for SYS_MUTEX_DEFINE and fixes typo in
futex documentation.

Fixes #27829

Signed-off-by: Lauren Murphy <lauren.murphy@intel.com>
This commit is contained in:
Lauren Murphy 2021-02-01 21:24:47 -06:00 • committed by Anas Nashif
commit d922fed7f7
3 changed files with 45 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
include/kernel.h
View file

@ -1945,8 +1945,8 @@ static inline void *z_impl_k_queue_peek_tail(struct k_queue *queue)
* A k_futex is a lightweight mutual exclusion primitive designed
* to minimize kernel involvement. Uncontended operation relies
* only on atomic access to shared memory. k_futex are tracked as
* kernel objects and can live in user memory so any access bypass
* the kernel object permission management mechanism.
* kernel objects and can live in user memory so that any access
* bypasses the kernel object permission management mechanism.
*/
struct k_futex {
atomic_t val;