task_mutex.h File Reference

#include <zrtos/zrtos.h>
#include <zrtos/error.h>

Include dependency graph for task_mutex.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	_zrtos_task_mutex_t

Macros
#define	ZRTOS_TASK_MUTEX__INITIALIZER   {.is_locked = 0}

Typedefs
typedef struct _zrtos_task_mutex_t	zrtos_task_mutex_t

Functions
bool	zrtos_task_mutex__init (zrtos_task_mutex_t *thiz)
void	zrtos_task_mutex__deinit (zrtos_task_mutex_t *thiz)
int	zrtos_task_mutex__try_lock (zrtos_task_mutex_t *thiz)
int	zrtos_task_mutex__lock (zrtos_task_mutex_t *thiz)
int	zrtos_task_mutex__unlock (zrtos_task_mutex_t *thiz)

Macro Definition Documentation

ZRTOS_TASK_MUTEX__INITIALIZER

#define ZRTOS_TASK_MUTEX__INITIALIZER   {.is_locked = 0}

Definition at line 22 of file task_mutex.h.

Typedef Documentation

zrtos_task_mutex_t

typedef struct _zrtos_task_mutex_t zrtos_task_mutex_t

Function Documentation

zrtos_task_mutex__deinit()

void zrtos_task_mutex__deinit

(

zrtos_task_mutex_t *

thiz

)

Definition at line 29 of file task_mutex.h.

                                                       {
    
}

Here is the caller graph for this function:

zrtos_task_mutex__init()

bool zrtos_task_mutex__init

(

zrtos_task_mutex_t *

thiz

)

Definition at line 24 of file task_mutex.h.

                                                     {
    thiz->is_locked = false;
    return true;
}

Here is the caller graph for this function:

zrtos_task_mutex__lock()

int zrtos_task_mutex__lock

(

zrtos_task_mutex_t *

thiz

)

Definition at line 44 of file task_mutex.h.

                                                    {
    bool ret = true;
    bool is_locked;
    uint8_t limit = 0xFF;
    do{
        ZRTOS_TASK_SCHEDULER__DO_NOT_DISTURB_EX(is_locked,{
            if(thiz->is_locked == false){
                thiz->is_locked = true;
                ret = false;
            }
        });
        if(ret){
            zrtos_task_scheduler__delay_ms(0);
        }
    }while(ret && !is_locked && limit--);
    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_task_mutex__try_lock()

int zrtos_task_mutex__try_lock

(

zrtos_task_mutex_t *

thiz

)

Definition at line 33 of file task_mutex.h.

                                                        {
    int ret = ZRTOS_ERROR__BUSY;
    ZRTOS_TASK_SCHEDULER__DO_NOT_DISTURB({
        if(thiz->is_locked == false){
            thiz->is_locked = true;
            ret = 0;
        }
    });
    return ret;
}

Here is the caller graph for this function:

zrtos_task_mutex__unlock()

int zrtos_task_mutex__unlock

(

zrtos_task_mutex_t *

thiz

)

Definition at line 62 of file task_mutex.h.

                                                      {
    ZRTOS_TASK_SCHEDULER__DO_NOT_DISTURB({
        thiz->is_locked = false;
    });
    return 0;
}

Here is the caller graph for this function: