A version of xTimerChangePeriod() that can be called from an interrupt service
The handle of the software timer that is having its period changed.
The new period for xTimer. Timer periods are specified in
tick periods, so the constant portTICK_PERIOD_MS can be used to convert a time
that has been specified in milliseconds. For example, if the timer must
expire after 100 ticks, then xNewPeriod should be set to 100. Alternatively,
if the timer must expire after 500ms, then xNewPeriod can be set to
( 500 / portTICK_PERIOD_MS ) provided configTICK_RATE_HZ is less than
or equal to 1000.
The timer service/daemon task spends most
of its time in the Blocked state, waiting for messages to arrive on the timer
command queue. Calling xTimerChangePeriodFromISR() writes a message to the
timer command queue, so has the potential to transition the timer service/
daemon task out of the Blocked state. If calling xTimerChangePeriodFromISR()
causes the timer service/daemon task to leave the Blocked state, and the
timer service/daemon task has a priority equal to or greater than the
currently executing task (the task that was interrupted), then
*pxHigherPriorityTaskWoken will get set to pdTRUE internally within the
xTimerChangePeriodFromISR() function. If xTimerChangePeriodFromISR() sets
this value to pdTRUE, then a context switch should be performed before the
pdFAIL will be returned if the command to change the timers period
could not be sent to the timer command queue. pdPASS will be returned if the
command was successfully sent to the timer command queue. When the command
is actually processed will depend on the priority of the timer service/daemon
task relative to other tasks in the system. The timer service/daemon task
priority is set by the configTIMER_TASK_PRIORITY configuration constant.
/* This scenario assumes xTimer has already been created and started. When
an interrupt occurs, the period of xTimer should be changed to 500ms. */
/* The interrupt service routine that changes the period of xTimer. */
void vAnExampleInterruptServiceRoutine( void )
BaseType_t xHigherPriorityTaskWoken = pdFALSE;
/* The interrupt has occurred - change the period of xTimer to 500ms.
xHigherPriorityTaskWoken was set to pdFALSE where it was defined
(within this function). As this is an interrupt service routine, only
FreeRTOS API functions that end in "FromISR" can be used. */
if( xTimerChangePeriodFromISR( xTimer,
&xHigherPriorityTaskWoken ) != pdPASS )
/* The command to change the timers period was not executed
successfully. Take appropriate action here. */
/* If xHigherPriorityTaskWoken equals pdTRUE, then a context switch
should be performed. The syntax required to perform a context switch
from inside an ISR varies from port to port, and from compiler to
compiler. Inspect the demos for the port you are using to find the
actual syntax required. */
if( xHigherPriorityTaskWoken != pdFALSE )
/* Call the interrupt safe yield function here (actual function
depends on the FreeRTOS port being used). */
Copyright (C) 2004-2010 Richard Barry. Copyright (C) 2010-2016 Real Time Engineers Ltd.
Any and all data, files, source code, html content and documentation included in the FreeRTOSTM distribution or available on this site are the exclusive property of Real Time Engineers Ltd..
See the files license.txt (included in the distribution) and this copyright notice for more information. FreeRTOSTM and FreeRTOS.orgTM are trade marks of Real Time Engineers Ltd.