meshx_sem.c File Reference

Implementation of MeshX Semaphore APIs using FreeRTOS. This file provides functions to create, delete, take, and give semaphores for synchronization in the MeshX framework. More...

#include "interface/rtos/meshx_sem.h"
#include "freertos/FreeRTOS.h"
#include "freertos/semphr.h"
#include "esp_system.h"

Include dependency graph for meshx_sem.c:

Go to the source code of this file.

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

Implementation of MeshX Semaphore APIs using FreeRTOS. This file provides functions to create, delete, take, and give semaphores for synchronization in the MeshX framework.

Copyright (c) 2024 - 2025 MeshX

Author

Pranjal Chanda

Definition in file meshx_sem.c.

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;
}