michaelh/zephyr
1
0
Fork 0
Code Releases Activity

docs: Add missing retval for sys_mutex_unlock()

Browse source 
Should return 0 if mutex is unlocked, like k_mutex_unlock()

Signed-off-by: Guðni Már Gilbert <gudni.m.g@gmail.com>
This commit is contained in:
Guðni Már Gilbert 2021-03-05 20:35:09 +00:00 • committed by Anas Nashif
commit fd6737ebc4
1 changed files with 1 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
include/sys/mutex.h
View file

@ -118,6 +118,7 @@ static inline int sys_mutex_lock(struct sys_mutex *mutex, k_timeout_t timeout)
* thread. * thread.
* *
* @param mutex Address of the mutex, which may reside in user memory * @param mutex Address of the mutex, which may reside in user memory
* @retval 0 Mutex unlocked
* @retval -EACCES Caller has no access to provided mutex address * @retval -EACCES Caller has no access to provided mutex address
* @retval -EINVAL Provided mutex not recognized by the kernel or mutex wasn't * @retval -EINVAL Provided mutex not recognized by the kernel or mutex wasn't
* locked * locked