meshx_sem.h File Reference

MeshX Semaphore Interface. More...

#include <stdint.h>
#include "meshx_err.h"

Include dependency graph for meshx_sem.h:

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

Go to the source code of this file.

Data Structures
struct	meshx_sem
	MeshX Semaphore Structure. More...

Typedefs
typedef struct meshx_sem	meshx_sem_t
	MeshX Semaphore Structure.

Functions
meshx_err_t	meshx_sem_create (meshx_sem_t *sem_handle)
	Create a MeshX Semaphore.
meshx_err_t	meshx_sem_delete (meshx_sem_t *sem_handle)
	Delete a MeshX Semaphore.
meshx_err_t	meshx_sem_take (meshx_sem_t *sem_handle, uint32_t delay_ms)
	Take a MeshX Semaphore.
meshx_err_t	meshx_sem_give (meshx_sem_t *sem_handle)
	Give a MeshX Semaphore.

Detailed Description

MeshX Semaphore Interface.

This file contains the MeshX Semaphore Interface.

Author

Pranjal Chanda

Version

1.0

Definition in file meshx_sem.h.

Typedef Documentation

meshx_sem_t

typedef struct meshx_sem meshx_sem_t

MeshX Semaphore Structure.

Function Documentation

meshx_sem_create()

meshx_err_t meshx_sem_create

(

meshx_sem_t *

sem_handle

)

Create a MeshX Semaphore.

This function creates a MeshX Semaphore.

Parameters

[in,out]

sem_handle

Semaphore Handle

Returns

meshx_err_t

Definition at line 27 of file meshx_sem.c.

{
    if (sem_handle == NULL)
    {
        return MESHX_INVALID_ARG;
    }
 
    sem_handle->__sem_handle = xSemaphoreCreateCounting(sem_handle->max_count, sem_handle->init_count);
 
    if (sem_handle->__sem_handle == NULL)
    {
        return MESHX_FAIL;
    }
 
    return MESHX_SUCCESS;
}

meshx_sem_delete()

meshx_err_t meshx_sem_delete

(

meshx_sem_t *

sem_handle

)

Delete a MeshX Semaphore.

This function deletes a MeshX Semaphore.

Parameters

[in]

sem_handle

Semaphore Handle

Returns

meshx_err_t

Definition at line 52 of file meshx_sem.c.

{
    if (sem_handle == NULL)
    {
        return MESHX_INVALID_ARG;
    }
 
    vSemaphoreDelete(sem_handle->__sem_handle);
 
    return MESHX_SUCCESS;
}

meshx_sem_give()

meshx_err_t meshx_sem_give

(

meshx_sem_t *

sem_handle

)

Give a MeshX Semaphore.

This function gives a MeshX Semaphore.

Parameters

[in]

sem_handle

Semaphore Handle

Returns

meshx_err_t

Definition at line 99 of file meshx_sem.c.

{
    if (sem_handle == NULL)
    {
        return MESHX_INVALID_ARG;
    }
 
    if (xSemaphoreGive(sem_handle->__sem_handle) != pdTRUE)
    {
        return MESHX_FAIL;
    }
 
    return MESHX_SUCCESS;
}

meshx_sem_take()

meshx_err_t meshx_sem_take	(	meshx_sem_t *	sem_handle,
		uint32_t	delay_ms )

Take a MeshX Semaphore.

This function takes a MeshX Semaphore.

Parameters

[in]	sem_handle	Semaphore Handle
[in]	delay_ms	Delay in milliseconds

Returns

meshx_err_t

Definition at line 74 of file meshx_sem.c.

{
    if (sem_handle == NULL)
    {
        return MESHX_INVALID_ARG;
    }
 
    BaseType_t err = xPortInIsrContext() ? xSemaphoreTakeFromISR(sem_handle->__sem_handle, NULL) : xSemaphoreTake(sem_handle->__sem_handle, delay_ms);
    if(err != pdPASS)
    {
        return MESHX_FAIL;
    }
 
    return MESHX_SUCCESS;
}