meshx_rtos_utils.h File Reference

Utility functions for RTOS operations in the MeshX framework. More...

#include "meshx_err.h"
#include "stddef.h"

Include dependency graph for meshx_rtos_utils.h:

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

Go to the source code of this file.

Functions
meshx_err_t	meshx_rtos_get_sys_time (unsigned int *millis)
	Retrieves the current system time in milliseconds.
meshx_err_t	meshx_rtos_malloc (void **ptr, size_t size)
	Allocates memory dynamically in a thread-safe manner using FreeRTOS.
meshx_err_t	meshx_rtos_calloc (void **ptr, size_t num, size_t size)
	Allocates memory for an array of elements and initializes it to zero.
meshx_err_t	meshx_rtos_free (void **ptr)
	Frees memory allocated to a pointer and sets it to NULL.
size_t	meshx_rtos_get_free_heap (void)
	Retrieves the amount of free heap memory available in the system.
meshx_err_t	meshx_rtos_get_curr_task_id_prio (unsigned int *task_id)
	Retrieves the current task ID.

Detailed Description

Utility functions for RTOS operations in the MeshX framework.

This header file provides a set of utility functions for interacting with the RTOS in the MeshX framework. These utilities include functions for retrieving system time, memory allocation and deallocation, and querying the amount of free heap memory.

The functions in this file are designed to simplify common RTOS operations and ensure consistent error handling across the MeshX framework.

Author

Pranjal Chanda

Definition in file meshx_rtos_utils.h.

Function Documentation

meshx_rtos_calloc()

meshx_err_t meshx_rtos_calloc	(	void **	ptr,
		size_t	num,
		size_t	size )

Allocates memory for an array of elements and initializes it to zero.

This function allocates memory for an array of num elements, each of size size, and initializes all bytes in the allocated memory to zero. The allocated memory pointer is returned via the ptr parameter.

Parameters

[out]	ptr	Pointer to the allocated memory. This will be set to NULL if the allocation fails.
[in]	num	Number of elements to allocate.
[in]	size	Size of each element in bytes.

Returns

• MESHX_SUCCESS: Memory allocation was successful.
• MESHX_ERR_NO_MEM: Memory allocation failed due to insufficient memory.

Definition at line 96 of file meshx_utils.c.

{
    if (!ptr || num == 0 || size == 0)
    {
        return MESHX_INVALID_ARG; // Invalid input
    }
 
    *ptr = pvPortMalloc(size);
    if (*ptr == NULL)
    {
        return MESHX_NO_MEM; // Memory allocation failed
    }
 
    memset(*ptr, 0, num * size); // Initialize allocated memory to zero
 
    return MESHX_SUCCESS;
}

meshx_rtos_free()

meshx_err_t meshx_rtos_free

(

void **

ptr

)

Frees memory allocated to a pointer and sets it to NULL.

This function is used to safely deallocate memory that was previously allocated and ensures that the pointer is set to NULL to avoid dangling pointer issues.

Parameters

[in,out]

ptr

A double pointer to the memory to be freed. After the memory is freed, the pointer is set to NULL.

Returns

• MESHX_SUCCESS on successful deallocation.
• MESHX_ERR_INVALID_ARG if the provided pointer is NULL or invalid.
• Other error codes depending on the implementation.

Definition at line 129 of file meshx_utils.c.

{
    if (ptr && *ptr)
    {                    // Ensure pointer is valid
        vPortFree(*ptr); // Free the actual allocated memory
        *ptr = NULL;     // Set pointer to NULL to avoid dangling reference
    }
    MESHX_LOGD(MODULE_ID_COMMON, "ESP Heap available: %d", meshx_rtos_get_free_heap());
    return MESHX_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_rtos_get_curr_task_id_prio()

meshx_err_t meshx_rtos_get_curr_task_id_prio

(

unsigned int *

task_id

)

Retrieves the current task ID.

This function retrieves the current task ID using FreeRTOS APIs. The task ID is stored in the variable pointed to by the task_id parameter.

Parameters

[out]

task_id

Pointer to an unsigned integer where the task ID will be stored.

Returns

• MESHX_SUCCESS: If the task ID was successfully retrieved.
• MESHX_ERR_INVALID_ARG: If the provided pointer is NULL or invalid.

Note

Ensure that the task_id pointer is valid and not NULL before calling this function.

Definition at line 170 of file meshx_utils.c.

{
 
#ifdef configUSE_TRACE_FACILITY
    TaskStatus_t xTaskDetails;
    vTaskGetInfo(NULL, &xTaskDetails, pdTRUE, eInvalid);
    *task_id = xTaskDetails.xTaskNumber << 8 | xTaskDetails.uxCurrentPriority;
#else
    *task_id = 0x5A;    /* Dummy Task ID*/
#endif
    return MESHX_SUCCESS;
 
}

Here is the caller graph for this function:

meshx_rtos_get_free_heap()

size_t meshx_rtos_get_free_heap

(

void

)

Retrieves the amount of free heap memory available in the system.

This function is used to query the current amount of free heap memory available in the system. It is useful for monitoring memory usage and ensuring that the system has sufficient resources for dynamic memory allocation.

Returns

size_t The amount of free heap memory in bytes.

Definition at line 150 of file meshx_utils.c.

{
    return xPortGetFreeHeapSize();
}

Here is the caller graph for this function:

meshx_rtos_get_sys_time()

meshx_err_t meshx_rtos_get_sys_time

(

unsigned int *

millis

)

Retrieves the current system time in milliseconds.

This function calculates the system time in milliseconds based on the FreeRTOS tick count and the configured tick rate. The result is stored in the variable pointed to by the millis parameter.

Parameters

[out]

millis

Pointer to an unsigned integer where the system time in milliseconds will be stored.

Returns

• MESHX_SUCCESS: If the system time was successfully retrieved.

Note

Ensure that the millis pointer is valid and not NULL before calling this function.

Definition at line 36 of file meshx_utils.c.

{
    if(xPortInIsrContext() == pdFALSE)
    {
        *millis = xTaskGetTickCount() * (1000 / configTICK_RATE_HZ);
    }
    else
    {
        *millis = xTaskGetTickCountFromISR() * (1000 / configTICK_RATE_HZ);
    }
    return MESHX_SUCCESS;
}

Here is the caller graph for this function:

meshx_rtos_malloc()

meshx_err_t meshx_rtos_malloc	(	void **	ptr,
		size_t	size )

Allocates memory dynamically in a thread-safe manner using FreeRTOS.

This function wraps the memory allocation process to ensure compatibility with the FreeRTOS environment. It allocates a block of memory of the specified size and assigns the pointer to the provided pointer variable.

Parameters

[out]	ptr	Pointer to the memory location where the allocated memory address will be stored. Must not be NULL.
[in]	size	The size of the memory block to allocate, in bytes.

Returns

• MESHX_SUCCESS on successful memory allocation.
• MESHX_ERR_NO_MEM if memory allocation fails.
• Other error codes as defined in the meshx_err_t enumeration.

Definition at line 65 of file meshx_utils.c.

{
    if (!ptr || size == 0)
    {
        return MESHX_INVALID_ARG; // Invalid input
    }
 
    *ptr = pvPortMalloc(size);
    if (*ptr == NULL)
    {
        return MESHX_NO_MEM; // Memory allocation failed
    }
 
    return MESHX_SUCCESS;
}

Here is the caller graph for this function: