FreeRTOS Abstraction Layer

The Kinetis SDK provides the FreeRTOS Abstraction Layer for synchronization, mutual exclusion, message queue, etc. More...

Overview

Data Structures
struct	event_freertos
	Type for an event group object in FreeRTOS OS. More...

Macros
#define	OSA_WAIT_FOREVER   0xFFFFFFFFU
	Constant to pass as timeout value in order to wait indefinitely. More...
#define	FSL_OSA_TIME_RANGE   0xFFFFFFFFU
	OSA's time range in millisecond, OSA time wraps if exceeds this value. More...
#define	OSA_DEFAULT_INT_HANDLER   ((osa_int_handler_t)(&DefaultISR))
	The default interrupt handler installed in vector table. More...
#define	OSA_MAX_ISR_CRITICAL_SECTION_DEPTH   0x8U
	The Max depth of Enter/Exist Critical could be nested in interrupt. More...

Typedefs
typedef TaskHandle_t	task_handler_t
	Type for a task handler, returned by the OSA_TaskCreate function. More...
typedef portSTACK_TYPE	task_stack_t
	Type for a task stack. More...
typedef void *	task_param_t
	Type for task parameter.
typedef pdTASK_CODE	task_t
	Type for a task function. More...
typedef xSemaphoreHandle	mutex_t
	Type for a mutex. More...
typedef xSemaphoreHandle	semaphore_t
	Type for a semaphore. More...
typedef EventBits_t	event_flags_t
	Type for an event flags object. More...
typedef event_freertos	event_t
	Type for an event group object.
typedef xQueueHandle	msg_queue_t
	Type for a message queue declaration and creation. More...
typedef xQueueHandle	msg_queue_handler_t
	Type for a message queue handler.

Thread management
#define	OSA_TASK_DEFINE(task, stackSize)
	Creates a task descriptor that is used to create the task with OSA_TaskCreate. More...
#define	PRIORITY_OSA_TO_RTOS(osa_prio)   (configMAX_PRIORITIES - (osa_prio) -2)
	To provide unified task piority for upper layer, OSA layer makes conversion.
#define	PRIORITY_RTOS_TO_OSA(rtos_prio)   (configMAX_PRIORITIES - (rtos_prio) -2)

Message queues
#define	MSG_QUEUE_DECLARE(name, number, size)   msg_queue_t *name = NULL
	This macro statically reserves the memory required for the queue. More...

---

Data Structure Documentation

struct event_freertos

Data Fields
EventGroupHandle_t	eventHandler
	FreeRTOS OS event handler.
osa_event_clear_mode_t	clearMode
	Auto clear or manual clear.

Macro Definition Documentation

#define OSA_WAIT_FOREVER   0xFFFFFFFFU

#define FSL_OSA_TIME_RANGE   0xFFFFFFFFU

#define OSA_DEFAULT_INT_HANDLER   ((osa_int_handler_t)(&DefaultISR))

#define OSA_MAX_ISR_CRITICAL_SECTION_DEPTH   0x8U

#define OSA_TASK_DEFINE	(		task,
			stackSize
	)

Value:

task_stack_t* task##_stack = NULL;   \
    task_handler_t task##_task_handler

Parameters

task	The task function.
stackSize	Number of elements in the stack for this task.

#define MSG_QUEUE_DECLARE	(		name,
			number,
			size
	)		msg_queue_t *name = NULL

Parameters

name	Identifier for the memory region.
number	Number of elements in the queue.
size	Size of every elements in words.

Typedef Documentation

typedef TaskHandle_t task_handler_t

typedef portSTACK_TYPE task_stack_t

typedef pdTASK_CODE task_t

typedef xSemaphoreHandle mutex_t

typedef xSemaphoreHandle semaphore_t

typedef EventBits_t event_flags_t

typedef xQueueHandle msg_queue_t