aboutsummaryrefslogtreecommitdiffstats
path: root/os/kernel/src/chmtx.c
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2010-09-21 10:22:06 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2010-09-21 10:22:06 +0000
commit07351222e6d0b6b3dcd4f50ecb18bc09e7402d1c (patch)
tree4766a942caadb8937c09c015ec2609d8455ba8c5 /os/kernel/src/chmtx.c
parent16855e1a4e43b4b45e5b5a595628ab1d8c108093 (diff)
downloadChibiOS-07351222e6d0b6b3dcd4f50ecb18bc09e7402d1c.tar.gz
ChibiOS-07351222e6d0b6b3dcd4f50ecb18bc09e7402d1c.tar.bz2
ChibiOS-07351222e6d0b6b3dcd4f50ecb18bc09e7402d1c.zip
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2184 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/kernel/src/chmtx.c')
-rw-r--r--os/kernel/src/chmtx.c18
1 files changed, 16 insertions, 2 deletions
diff --git a/os/kernel/src/chmtx.c b/os/kernel/src/chmtx.c
index 9698d3cd8..b84c4d57e 100644
--- a/os/kernel/src/chmtx.c
+++ b/os/kernel/src/chmtx.c
@@ -70,10 +70,10 @@
/**
* @brief Initializes s @p Mutex structure.
- * @note This function can be invoked before the kernel is initialized
- * because it just prepares a @p Mutex structure.
*
* @param[out] mp pointer to a @p Mutex structure
+ *
+ * @init
*/
void chMtxInit(Mutex *mp) {
@@ -89,6 +89,8 @@ void chMtxInit(Mutex *mp) {
* mutexes.
*
* @param[in] mp pointer to the @p Mutex structure
+ *
+ * @api
*/
void chMtxLock(Mutex *mp) {
@@ -105,6 +107,8 @@ void chMtxLock(Mutex *mp) {
* mutexes.
*
* @param[in] mp pointer to the @p Mutex structure
+ *
+ * @sclass
*/
void chMtxLockS(Mutex *mp) {
Thread *ctp = currp;
@@ -184,6 +188,8 @@ void chMtxLockS(Mutex *mp) {
* @return The operation status.
* @retval TRUE if the mutex has been successfully acquired
* @retval FALSE if the lock attempt failed.
+ *
+ * @api
*/
bool_t chMtxTryLock(Mutex *mp) {
bool_t b;
@@ -210,6 +216,8 @@ bool_t chMtxTryLock(Mutex *mp) {
* @return The operation status.
* @retval TRUE if the mutex has been successfully acquired
* @retval FALSE if the lock attempt failed.
+ *
+ * @sclass
*/
bool_t chMtxTryLockS(Mutex *mp) {
@@ -230,6 +238,8 @@ bool_t chMtxTryLockS(Mutex *mp) {
* owned mutexes.
*
* @return A pointer to the unlocked mutex.
+ *
+ * @api
*/
Mutex *chMtxUnlock(void) {
Thread *ctp = currp;
@@ -288,6 +298,8 @@ Mutex *chMtxUnlock(void) {
* function must be performed before unlocking the kernel.
*
* @return A pointer to the unlocked mutex.
+ *
+ * @sclass
*/
Mutex *chMtxUnlockS(void) {
Thread *ctp = currp;
@@ -342,6 +354,8 @@ Mutex *chMtxUnlockS(void) {
* mutexes one by one and not just because the call overhead,
* this function does not have any overhead related to the priority
* inheritance mechanism.
+ *
+ * @api
*/
void chMtxUnlockAll(void) {
Thread *ctp = currp;