Interfaces RTOS

Each product has a number of interfaces, see the image below:

We focus on the interface to the RTOS - please refer to the description on all interfaces on details for non-RTOS interfaces. All RXF source files always include WSTRTOS.h

Example:

#include "RxfConstants.h"
#include "WSTProduct.h"
#include "WSTProlog.h"
#include "WSTCompiler.h"
#include "WSTTarget.h"
#include "WSTRTOS.h"
#include "WSTPMF.h"
#include "RxfDimensions.h"

.. (include files for ANSI-C like stddef.h, include files for RXF)

#include "WSTEpilog.h"

#DEFINEs to force error handler calls also in debug buildset

The following defines are supported to make sure the error handler is being called also when _DEBUG is defined:

WST_FORCE_ALLOC_FAILED
WST_FORCE_EMPTY_ME_PTR
WST_FORCE_MSGQ_CLEANUP_FAILED
WST_FORCE_MSGQ_GET_FAILED
WST_FORCE_MSGQ_INIT_FAILED
WST_FORCE_MSGQ_PEND_FAILED
WST_FORCE_MUTEX_CLEANUP_FAILED
WST_FORCE_MUTEX_FREE_FAILED
WST_FORCE_MUTEX_INIT_FAILED
WST_FORCE_MUTEX_LOCK_FAILED
WST_FORCE_RTOS_ERROR
WST_FORCE_SEMA_CLEANUP_FAILED
WST_FORCE_SEMA_INIT_FAILED
WST_FORCE_SEMA_SIGNAL_FAILED
WST_FORCE_SEMA_WAIT_FAILED
WST_FORCE_TASK_CLEANUP_FAILED
WST_FORCE_TASK_INIT_FAILED
WST_FORCE_TASK_PRIORITY_FAILED
WST_FORCE_TASK_START_FAILED
WST_FORCE_TIMER_DELETE_FAILED
WST_FORCE_TIMER_INIT_FAILED

there is also an additional tick check which can also be activated in the release buildset, when defining:

WST_FORCE_TICKS_CHECK

Interface RTOS implementation RL-ARM

Files

Description

WSTRTOS.h

This file defines the following functions:

WSTRTOS_Init	This function is called as second call in RiCOXFInit(), which is the first call generated by Rhapsody in WST_RXF_Main(). So this is the place to hook code into when your RTOS is not already initialized by your startup code, prior to calling main(). Its prototype is: void WSTRTOS_Init( void );
WSTRTOS_Cleanup	This function is not called by the RXF. You must implement it and call it in your <Rhapsody component>__Cleanup() if you need it. Its prototype is: void WSTRTOS_Cleanup( void );

This file defines the following macros:

RIC_MS_PER_TICK	10 (default value of OS_TICK)
RiCOSDefaultThreadPriority	(long) RTOS_PRIORITY_NORMAL
RiCOSDefaultStackSize	(long) RTOS_DEFAULT_STACK
RiCOSDefaultMessageQueueSize	(long) RTOS_MQ_DEFAULT_SIZE
RTOS_PRIORITY_NORMAL	120
RTOS_PRIORITY_ABOVE_NORMAL	130
RTOS_PRIORITY_HIGH	255
RTOS_PRIORITY_LOW	0
RTOS_DEFAULT_STACK	256
RTOS_MQ_DEFAULT_SIZE	32
WST_MAIN_STK_SIZE	512
RiC_RAW_MEMORY_ALIGNMENT	16
RiCOSMemoryAllocation_malloc	malloc is mapped to this function
RiCOSMemoryAllocation_calloc	calloc is mapped to this function
RiCOSMemoryAllocation_realloc	realloc is mapped to this function
RiCOSMemoryAllocation_free	free is mapped to this function

The constant RIC_OS_MUTEX_LOCK_AS_OPERATION is defined.

WSTRTOS.c

This file is used in the GettingStarted example. It implements the following functions:

WSTRTOS_Init

Is implemented as a call to

RiCOSMutex_InitSysVars()

RiCOSMemoryAllocation_Init()

WSTRTOS_Cleanup

THis function is left empty.