Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct doxygen for mutex_try_enter #392

Merged
merged 1 commit into from
May 10, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions src/common/pico_sync/include/pico/mutex.h
Original file line number Diff line number Diff line change
Expand Up @@ -65,13 +65,15 @@ void recursive_mutex_init(mutex_t *mtx);
*/
void mutex_enter_blocking(mutex_t *mtx);

/*! \brief Check to see if a mutex is available
/*! \brief Attempt to take ownership of a mutex
* \ingroup mutex
*
* Will return true if the mutex is unowned, false otherwise
* If the mutex wasn't owned, this will claim the mutex and return true.
* Otherwise (if the mutex was already owned) this will return false and the
* calling core will *NOT* own the mutex.
*
* \param mtx Pointer to mutex structure
* \param owner_out If mutex is owned, and this pointer is non-zero, it will be filled in with the core number of the current owner of the mutex
* \param owner_out If mutex was already owned, and this pointer is non-zero, it will be filled in with the core number of the current owner of the mutex
*/
bool mutex_try_enter(mutex_t *mtx, uint32_t *owner_out);

Expand Down