c1d101dd41
This commit backports the following features from FreeRTOS v9.0.0 - uxSemaphoreGetCount() - vTimerSetTimerId(), xTimerGetPeriod(), xTimerGetExpiryTime() - xTimerCreateStatic() - xEventGroupCreateStatic() - uxSemaphoreGetCount() Functions backported previously - xTaskCreateStatic() - xQueueCreateStatic() - xSemaphoreCreateBinaryStatic(), xSemaphoreCreateCountingStatic() - xSemaphoreCreateMutexStatic(), xSemaphoreCreateRecursiveMutexStatic() - pcQueueGetName() - vTaskSetThreadLocalStoragePointer() - pvTaskGetThreadLocalStoragePointer() Unit tests were also written for the functions above (except for pcQueueGetName which is tested in a separate Queue Registry MR). The original tlsp and del cb test case was deleted and integrated into the test cases of this MR.
778 lines
26 KiB
C
778 lines
26 KiB
C
/*
|
|
FreeRTOS V8.2.0 - Copyright (C) 2015 Real Time Engineers Ltd.
|
|
All rights reserved
|
|
|
|
VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
|
|
|
|
This file is part of the FreeRTOS distribution.
|
|
|
|
FreeRTOS is free software; you can redistribute it and/or modify it under
|
|
the terms of the GNU General Public License (version 2) as published by the
|
|
Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.
|
|
|
|
***************************************************************************
|
|
>>! NOTE: The modification to the GPL is included to allow you to !<<
|
|
>>! distribute a combined work that includes FreeRTOS without being !<<
|
|
>>! obliged to provide the source code for proprietary components !<<
|
|
>>! outside of the FreeRTOS kernel. !<<
|
|
***************************************************************************
|
|
|
|
FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
FOR A PARTICULAR PURPOSE. Full license text is available on the following
|
|
link: http://www.freertos.org/a00114.html
|
|
|
|
***************************************************************************
|
|
* *
|
|
* FreeRTOS provides completely free yet professionally developed, *
|
|
* robust, strictly quality controlled, supported, and cross *
|
|
* platform software that is more than just the market leader, it *
|
|
* is the industry's de facto standard. *
|
|
* *
|
|
* Help yourself get started quickly while simultaneously helping *
|
|
* to support the FreeRTOS project by purchasing a FreeRTOS *
|
|
* tutorial book, reference manual, or both: *
|
|
* http://www.FreeRTOS.org/Documentation *
|
|
* *
|
|
***************************************************************************
|
|
|
|
http://www.FreeRTOS.org/FAQHelp.html - Having a problem? Start by reading
|
|
the FAQ page "My application does not run, what could be wrong?". Have you
|
|
defined configASSERT()?
|
|
|
|
http://www.FreeRTOS.org/support - In return for receiving this top quality
|
|
embedded software for free we request you assist our global community by
|
|
participating in the support forum.
|
|
|
|
http://www.FreeRTOS.org/training - Investing in training allows your team to
|
|
be as productive as possible as early as possible. Now you can receive
|
|
FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers
|
|
Ltd, and the world's leading authority on the world's leading RTOS.
|
|
|
|
http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
|
|
including FreeRTOS+Trace - an indispensable productivity tool, a DOS
|
|
compatible FAT file system, and our tiny thread aware UDP/IP stack.
|
|
|
|
http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
|
|
Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.
|
|
|
|
http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High
|
|
Integrity Systems ltd. to sell under the OpenRTOS brand. Low cost OpenRTOS
|
|
licenses offer ticketed support, indemnification and commercial middleware.
|
|
|
|
http://www.SafeRTOS.com - High Integrity Systems also provide a safety
|
|
engineered and independently SIL3 certified version for use in safety and
|
|
mission critical applications that require provable dependability.
|
|
|
|
1 tab == 4 spaces!
|
|
*/
|
|
|
|
/* Standard includes. */
|
|
#include <stdlib.h>
|
|
|
|
/* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining
|
|
all the API functions to use the MPU wrappers. That should only be done when
|
|
task.h is included from an application file. */
|
|
#define MPU_WRAPPERS_INCLUDED_FROM_API_FILE
|
|
|
|
/* FreeRTOS includes. */
|
|
#include "FreeRTOS.h"
|
|
#include "task.h"
|
|
#include "timers.h"
|
|
#include "event_groups.h"
|
|
|
|
/* Lint e961 and e750 are suppressed as a MISRA exception justified because the
|
|
MPU ports require MPU_WRAPPERS_INCLUDED_FROM_API_FILE to be defined for the
|
|
header files above, but not in this file, in order to generate the correct
|
|
privileged Vs unprivileged linkage and placement. */
|
|
#undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE /*lint !e961 !e750. */
|
|
|
|
#if ( INCLUDE_xEventGroupSetBitFromISR == 1 ) && ( configUSE_TIMERS == 0 )
|
|
#error configUSE_TIMERS must be set to 1 to make the xEventGroupSetBitFromISR() function available.
|
|
#endif
|
|
|
|
#if ( INCLUDE_xEventGroupSetBitFromISR == 1 ) && ( INCLUDE_xTimerPendFunctionCall == 0 )
|
|
#error INCLUDE_xTimerPendFunctionCall must also be set to one to make the xEventGroupSetBitFromISR() function available.
|
|
#endif
|
|
|
|
/* The following bit fields convey control information in a task's event list
|
|
item value. It is important they don't clash with the
|
|
taskEVENT_LIST_ITEM_VALUE_IN_USE definition. */
|
|
#if configUSE_16_BIT_TICKS == 1
|
|
#define eventCLEAR_EVENTS_ON_EXIT_BIT 0x0100U
|
|
#define eventUNBLOCKED_DUE_TO_BIT_SET 0x0200U
|
|
#define eventWAIT_FOR_ALL_BITS 0x0400U
|
|
#define eventEVENT_BITS_CONTROL_BYTES 0xff00U
|
|
#else
|
|
#define eventCLEAR_EVENTS_ON_EXIT_BIT 0x01000000UL
|
|
#define eventUNBLOCKED_DUE_TO_BIT_SET 0x02000000UL
|
|
#define eventWAIT_FOR_ALL_BITS 0x04000000UL
|
|
#define eventEVENT_BITS_CONTROL_BYTES 0xff000000UL
|
|
#endif
|
|
|
|
typedef struct xEventGroupDefinition
|
|
{
|
|
EventBits_t uxEventBits;
|
|
List_t xTasksWaitingForBits; /*< List of tasks waiting for a bit to be set. */
|
|
|
|
#if( configUSE_TRACE_FACILITY == 1 )
|
|
UBaseType_t uxEventGroupNumber;
|
|
#endif
|
|
|
|
#if( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )
|
|
uint8_t ucStaticallyAllocated; /*< Set to pdTRUE if the event group is statically allocated to ensure no attempt is made to free the memory. */
|
|
#endif
|
|
|
|
portMUX_TYPE eventGroupMux; //Mutex required due to SMP
|
|
} EventGroup_t;
|
|
|
|
|
|
/*-----------------------------------------------------------*/
|
|
|
|
/*
|
|
* Test the bits set in uxCurrentEventBits to see if the wait condition is met.
|
|
* The wait condition is defined by xWaitForAllBits. If xWaitForAllBits is
|
|
* pdTRUE then the wait condition is met if all the bits set in uxBitsToWaitFor
|
|
* are also set in uxCurrentEventBits. If xWaitForAllBits is pdFALSE then the
|
|
* wait condition is met if any of the bits set in uxBitsToWait for are also set
|
|
* in uxCurrentEventBits.
|
|
*/
|
|
static BaseType_t prvTestWaitCondition( const EventBits_t uxCurrentEventBits, const EventBits_t uxBitsToWaitFor, const BaseType_t xWaitForAllBits );
|
|
|
|
/*-----------------------------------------------------------*/
|
|
|
|
#if( configSUPPORT_STATIC_ALLOCATION == 1 )
|
|
|
|
EventGroupHandle_t xEventGroupCreateStatic( StaticEventGroup_t *pxEventGroupBuffer )
|
|
{
|
|
EventGroup_t *pxEventBits;
|
|
|
|
/* A StaticEventGroup_t object must be provided. */
|
|
configASSERT( pxEventGroupBuffer );
|
|
|
|
/* The user has provided a statically allocated event group - use it. */
|
|
pxEventBits = ( EventGroup_t * ) pxEventGroupBuffer; /*lint !e740 EventGroup_t and StaticEventGroup_t are guaranteed to have the same size and alignment requirement - checked by configASSERT(). */
|
|
|
|
if( pxEventBits != NULL )
|
|
{
|
|
pxEventBits->uxEventBits = 0;
|
|
vListInitialise( &( pxEventBits->xTasksWaitingForBits ) );
|
|
|
|
#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )
|
|
{
|
|
/* Both static and dynamic allocation can be used, so note that
|
|
this event group was created statically in case the event group
|
|
is later deleted. */
|
|
pxEventBits->ucStaticallyAllocated = pdTRUE;
|
|
}
|
|
#endif /* configSUPPORT_DYNAMIC_ALLOCATION */
|
|
|
|
vPortCPUInitializeMutex(&pxEventBits->eventGroupMux);
|
|
|
|
traceEVENT_GROUP_CREATE( pxEventBits );
|
|
}
|
|
else
|
|
{
|
|
traceEVENT_GROUP_CREATE_FAILED();
|
|
}
|
|
|
|
return ( EventGroupHandle_t ) pxEventBits;
|
|
}
|
|
|
|
#endif /* configSUPPORT_STATIC_ALLOCATION */
|
|
/*-----------------------------------------------------------*/
|
|
|
|
#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )
|
|
|
|
EventGroupHandle_t xEventGroupCreate( void )
|
|
{
|
|
EventGroup_t *pxEventBits;
|
|
|
|
/* Allocate the event group. */
|
|
pxEventBits = ( EventGroup_t * ) pvPortMalloc( sizeof( EventGroup_t ) );
|
|
|
|
if( pxEventBits != NULL )
|
|
{
|
|
pxEventBits->uxEventBits = 0;
|
|
vListInitialise( &( pxEventBits->xTasksWaitingForBits ) );
|
|
|
|
#if( configSUPPORT_STATIC_ALLOCATION == 1 )
|
|
{
|
|
/* Both static and dynamic allocation can be used, so note this
|
|
event group was allocated statically in case the event group is
|
|
later deleted. */
|
|
pxEventBits->ucStaticallyAllocated = pdFALSE;
|
|
}
|
|
#endif /* configSUPPORT_STATIC_ALLOCATION */
|
|
|
|
vPortCPUInitializeMutex(&pxEventBits->eventGroupMux);
|
|
|
|
traceEVENT_GROUP_CREATE( pxEventBits );
|
|
}
|
|
else
|
|
{
|
|
traceEVENT_GROUP_CREATE_FAILED();
|
|
}
|
|
|
|
return ( EventGroupHandle_t ) pxEventBits;
|
|
}
|
|
|
|
#endif /* configSUPPORT_DYNAMIC_ALLOCATION */
|
|
/*-----------------------------------------------------------*/
|
|
|
|
EventBits_t xEventGroupSync( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet, const EventBits_t uxBitsToWaitFor, TickType_t xTicksToWait )
|
|
{
|
|
EventBits_t uxOriginalBitValue, uxReturn;
|
|
EventGroup_t *pxEventBits = ( EventGroup_t * ) xEventGroup;
|
|
BaseType_t xAlreadyYielded;
|
|
BaseType_t xTimeoutOccurred = pdFALSE;
|
|
|
|
configASSERT( ( uxBitsToWaitFor & eventEVENT_BITS_CONTROL_BYTES ) == 0 );
|
|
configASSERT( uxBitsToWaitFor != 0 );
|
|
#if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )
|
|
{
|
|
configASSERT( !( ( xTaskGetSchedulerState() == taskSCHEDULER_SUSPENDED ) && ( xTicksToWait != 0 ) ) );
|
|
}
|
|
#endif
|
|
|
|
vTaskSuspendAll();
|
|
taskENTER_CRITICAL(&pxEventBits->eventGroupMux);
|
|
{
|
|
uxOriginalBitValue = pxEventBits->uxEventBits;
|
|
|
|
( void ) xEventGroupSetBits( xEventGroup, uxBitsToSet );
|
|
|
|
if( ( ( uxOriginalBitValue | uxBitsToSet ) & uxBitsToWaitFor ) == uxBitsToWaitFor )
|
|
{
|
|
/* All the rendezvous bits are now set - no need to block. */
|
|
uxReturn = ( uxOriginalBitValue | uxBitsToSet );
|
|
|
|
/* Rendezvous always clear the bits. They will have been cleared
|
|
already unless this is the only task in the rendezvous. */
|
|
pxEventBits->uxEventBits &= ~uxBitsToWaitFor;
|
|
|
|
xTicksToWait = 0;
|
|
}
|
|
else
|
|
{
|
|
if( xTicksToWait != ( TickType_t ) 0 )
|
|
{
|
|
traceEVENT_GROUP_SYNC_BLOCK( xEventGroup, uxBitsToSet, uxBitsToWaitFor );
|
|
|
|
/* Store the bits that the calling task is waiting for in the
|
|
task's event list item so the kernel knows when a match is
|
|
found. Then enter the blocked state. */
|
|
vTaskPlaceOnUnorderedEventList( &( pxEventBits->xTasksWaitingForBits ), ( uxBitsToWaitFor | eventCLEAR_EVENTS_ON_EXIT_BIT | eventWAIT_FOR_ALL_BITS ), xTicksToWait );
|
|
|
|
/* This assignment is obsolete as uxReturn will get set after
|
|
the task unblocks, but some compilers mistakenly generate a
|
|
warning about uxReturn being returned without being set if the
|
|
assignment is omitted. */
|
|
uxReturn = 0;
|
|
}
|
|
else
|
|
{
|
|
/* The rendezvous bits were not set, but no block time was
|
|
specified - just return the current event bit value. */
|
|
uxReturn = pxEventBits->uxEventBits;
|
|
}
|
|
}
|
|
}
|
|
taskEXIT_CRITICAL( &pxEventBits->eventGroupMux );
|
|
xAlreadyYielded = xTaskResumeAll();
|
|
|
|
if( xTicksToWait != ( TickType_t ) 0 )
|
|
{
|
|
if( xAlreadyYielded == pdFALSE )
|
|
{
|
|
portYIELD_WITHIN_API();
|
|
}
|
|
else
|
|
{
|
|
mtCOVERAGE_TEST_MARKER();
|
|
}
|
|
|
|
/* The task blocked to wait for its required bits to be set - at this
|
|
point either the required bits were set or the block time expired. If
|
|
the required bits were set they will have been stored in the task's
|
|
event list item, and they should now be retrieved then cleared. */
|
|
uxReturn = uxTaskResetEventItemValue();
|
|
|
|
if( ( uxReturn & eventUNBLOCKED_DUE_TO_BIT_SET ) == ( EventBits_t ) 0 )
|
|
{
|
|
/* The task timed out, just return the current event bit value. */
|
|
taskENTER_CRITICAL( &pxEventBits->eventGroupMux );
|
|
{
|
|
uxReturn = pxEventBits->uxEventBits;
|
|
|
|
/* Although the task got here because it timed out before the
|
|
bits it was waiting for were set, it is possible that since it
|
|
unblocked another task has set the bits. If this is the case
|
|
then it needs to clear the bits before exiting. */
|
|
if( ( uxReturn & uxBitsToWaitFor ) == uxBitsToWaitFor )
|
|
{
|
|
pxEventBits->uxEventBits &= ~uxBitsToWaitFor;
|
|
}
|
|
else
|
|
{
|
|
mtCOVERAGE_TEST_MARKER();
|
|
}
|
|
}
|
|
taskEXIT_CRITICAL( &pxEventBits->eventGroupMux );
|
|
|
|
xTimeoutOccurred = pdTRUE;
|
|
}
|
|
else
|
|
{
|
|
/* The task unblocked because the bits were set. */
|
|
}
|
|
|
|
/* Control bits might be set as the task had blocked should not be
|
|
returned. */
|
|
uxReturn &= ~eventEVENT_BITS_CONTROL_BYTES;
|
|
}
|
|
|
|
traceEVENT_GROUP_SYNC_END( xEventGroup, uxBitsToSet, uxBitsToWaitFor, xTimeoutOccurred );
|
|
|
|
return uxReturn;
|
|
}
|
|
/*-----------------------------------------------------------*/
|
|
|
|
EventBits_t xEventGroupWaitBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToWaitFor, const BaseType_t xClearOnExit, const BaseType_t xWaitForAllBits, TickType_t xTicksToWait )
|
|
{
|
|
EventGroup_t *pxEventBits = ( EventGroup_t * ) xEventGroup;
|
|
EventBits_t uxReturn, uxControlBits = 0;
|
|
BaseType_t xWaitConditionMet, xAlreadyYielded;
|
|
BaseType_t xTimeoutOccurred = pdFALSE;
|
|
|
|
/* Check the user is not attempting to wait on the bits used by the kernel
|
|
itself, and that at least one bit is being requested. */
|
|
configASSERT( xEventGroup );
|
|
configASSERT( ( uxBitsToWaitFor & eventEVENT_BITS_CONTROL_BYTES ) == 0 );
|
|
configASSERT( uxBitsToWaitFor != 0 );
|
|
#if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )
|
|
{
|
|
configASSERT( !( ( xTaskGetSchedulerState() == taskSCHEDULER_SUSPENDED ) && ( xTicksToWait != 0 ) ) );
|
|
}
|
|
#endif
|
|
|
|
vTaskSuspendAll();
|
|
taskENTER_CRITICAL( &pxEventBits->eventGroupMux );
|
|
{
|
|
const EventBits_t uxCurrentEventBits = pxEventBits->uxEventBits;
|
|
|
|
/* Check to see if the wait condition is already met or not. */
|
|
xWaitConditionMet = prvTestWaitCondition( uxCurrentEventBits, uxBitsToWaitFor, xWaitForAllBits );
|
|
|
|
if( xWaitConditionMet != pdFALSE )
|
|
{
|
|
/* The wait condition has already been met so there is no need to
|
|
block. */
|
|
uxReturn = uxCurrentEventBits;
|
|
xTicksToWait = ( TickType_t ) 0;
|
|
|
|
/* Clear the wait bits if requested to do so. */
|
|
if( xClearOnExit != pdFALSE )
|
|
{
|
|
pxEventBits->uxEventBits &= ~uxBitsToWaitFor;
|
|
}
|
|
else
|
|
{
|
|
mtCOVERAGE_TEST_MARKER();
|
|
}
|
|
}
|
|
else if( xTicksToWait == ( TickType_t ) 0 )
|
|
{
|
|
/* The wait condition has not been met, but no block time was
|
|
specified, so just return the current value. */
|
|
uxReturn = uxCurrentEventBits;
|
|
}
|
|
else
|
|
{
|
|
/* The task is going to block to wait for its required bits to be
|
|
set. uxControlBits are used to remember the specified behaviour of
|
|
this call to xEventGroupWaitBits() - for use when the event bits
|
|
unblock the task. */
|
|
if( xClearOnExit != pdFALSE )
|
|
{
|
|
uxControlBits |= eventCLEAR_EVENTS_ON_EXIT_BIT;
|
|
}
|
|
else
|
|
{
|
|
mtCOVERAGE_TEST_MARKER();
|
|
}
|
|
|
|
if( xWaitForAllBits != pdFALSE )
|
|
{
|
|
uxControlBits |= eventWAIT_FOR_ALL_BITS;
|
|
}
|
|
else
|
|
{
|
|
mtCOVERAGE_TEST_MARKER();
|
|
}
|
|
|
|
/* Store the bits that the calling task is waiting for in the
|
|
task's event list item so the kernel knows when a match is
|
|
found. Then enter the blocked state. */
|
|
vTaskPlaceOnUnorderedEventList( &( pxEventBits->xTasksWaitingForBits ), ( uxBitsToWaitFor | uxControlBits ), xTicksToWait );
|
|
|
|
/* This is obsolete as it will get set after the task unblocks, but
|
|
some compilers mistakenly generate a warning about the variable
|
|
being returned without being set if it is not done. */
|
|
uxReturn = 0;
|
|
|
|
traceEVENT_GROUP_WAIT_BITS_BLOCK( xEventGroup, uxBitsToWaitFor );
|
|
}
|
|
}
|
|
taskEXIT_CRITICAL( &pxEventBits->eventGroupMux );
|
|
xAlreadyYielded = xTaskResumeAll();
|
|
|
|
if( xTicksToWait != ( TickType_t ) 0 )
|
|
{
|
|
if( xAlreadyYielded == pdFALSE )
|
|
{
|
|
portYIELD_WITHIN_API();
|
|
}
|
|
else
|
|
{
|
|
mtCOVERAGE_TEST_MARKER();
|
|
}
|
|
|
|
/* The task blocked to wait for its required bits to be set - at this
|
|
point either the required bits were set or the block time expired. If
|
|
the required bits were set they will have been stored in the task's
|
|
event list item, and they should now be retrieved then cleared. */
|
|
uxReturn = uxTaskResetEventItemValue();
|
|
|
|
if( ( uxReturn & eventUNBLOCKED_DUE_TO_BIT_SET ) == ( EventBits_t ) 0 )
|
|
{
|
|
taskENTER_CRITICAL( &pxEventBits->eventGroupMux );
|
|
{
|
|
/* The task timed out, just return the current event bit value. */
|
|
uxReturn = pxEventBits->uxEventBits;
|
|
|
|
/* It is possible that the event bits were updated between this
|
|
task leaving the Blocked state and running again. */
|
|
if( prvTestWaitCondition( uxReturn, uxBitsToWaitFor, xWaitForAllBits ) != pdFALSE )
|
|
{
|
|
if( xClearOnExit != pdFALSE )
|
|
{
|
|
pxEventBits->uxEventBits &= ~uxBitsToWaitFor;
|
|
}
|
|
else
|
|
{
|
|
mtCOVERAGE_TEST_MARKER();
|
|
}
|
|
}
|
|
else
|
|
{
|
|
mtCOVERAGE_TEST_MARKER();
|
|
}
|
|
}
|
|
taskEXIT_CRITICAL( &pxEventBits->eventGroupMux );
|
|
|
|
/* Prevent compiler warnings when trace macros are not used. */
|
|
xTimeoutOccurred = pdFALSE;
|
|
}
|
|
else
|
|
{
|
|
/* The task unblocked because the bits were set. */
|
|
}
|
|
|
|
/* The task blocked so control bits may have been set. */
|
|
uxReturn &= ~eventEVENT_BITS_CONTROL_BYTES;
|
|
}
|
|
traceEVENT_GROUP_WAIT_BITS_END( xEventGroup, uxBitsToWaitFor, xTimeoutOccurred );
|
|
|
|
return uxReturn;
|
|
}
|
|
/*-----------------------------------------------------------*/
|
|
|
|
EventBits_t xEventGroupClearBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear )
|
|
{
|
|
EventGroup_t *pxEventBits = ( EventGroup_t * ) xEventGroup;
|
|
EventBits_t uxReturn;
|
|
|
|
/* Check the user is not attempting to clear the bits used by the kernel
|
|
itself. */
|
|
configASSERT( xEventGroup );
|
|
configASSERT( ( uxBitsToClear & eventEVENT_BITS_CONTROL_BYTES ) == 0 );
|
|
|
|
taskENTER_CRITICAL( &pxEventBits->eventGroupMux );
|
|
{
|
|
traceEVENT_GROUP_CLEAR_BITS( xEventGroup, uxBitsToClear );
|
|
|
|
/* The value returned is the event group value prior to the bits being
|
|
cleared. */
|
|
uxReturn = pxEventBits->uxEventBits;
|
|
|
|
/* Clear the bits. */
|
|
pxEventBits->uxEventBits &= ~uxBitsToClear;
|
|
}
|
|
taskEXIT_CRITICAL( &pxEventBits->eventGroupMux );
|
|
|
|
return uxReturn;
|
|
}
|
|
/*-----------------------------------------------------------*/
|
|
|
|
#if ( ( configUSE_TRACE_FACILITY == 1 ) && ( INCLUDE_xTimerPendFunctionCall == 1 ) && ( configUSE_TIMERS == 1 ) )
|
|
|
|
BaseType_t xEventGroupClearBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear )
|
|
{
|
|
BaseType_t xReturn;
|
|
|
|
traceEVENT_GROUP_CLEAR_BITS_FROM_ISR( xEventGroup, uxBitsToClear );
|
|
xReturn = xTimerPendFunctionCallFromISR( vEventGroupClearBitsCallback, ( void * ) xEventGroup, ( uint32_t ) uxBitsToClear, NULL );
|
|
|
|
return xReturn;
|
|
}
|
|
|
|
#endif
|
|
/*-----------------------------------------------------------*/
|
|
|
|
EventBits_t xEventGroupGetBitsFromISR( EventGroupHandle_t xEventGroup )
|
|
{
|
|
UBaseType_t uxSavedInterruptStatus;
|
|
EventGroup_t *pxEventBits = ( EventGroup_t * ) xEventGroup;
|
|
EventBits_t uxReturn;
|
|
|
|
uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();
|
|
{
|
|
uxReturn = pxEventBits->uxEventBits;
|
|
}
|
|
portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
|
|
|
|
return uxReturn;
|
|
}
|
|
/*-----------------------------------------------------------*/
|
|
|
|
EventBits_t xEventGroupSetBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet )
|
|
{
|
|
ListItem_t *pxListItem, *pxNext;
|
|
ListItem_t const *pxListEnd;
|
|
List_t *pxList;
|
|
EventBits_t uxBitsToClear = 0, uxBitsWaitedFor, uxControlBits;
|
|
EventGroup_t *pxEventBits = ( EventGroup_t * ) xEventGroup;
|
|
BaseType_t xMatchFound = pdFALSE;
|
|
|
|
/* Check the user is not attempting to set the bits used by the kernel
|
|
itself. */
|
|
configASSERT( xEventGroup );
|
|
configASSERT( ( uxBitsToSet & eventEVENT_BITS_CONTROL_BYTES ) == 0 );
|
|
|
|
pxList = &( pxEventBits->xTasksWaitingForBits );
|
|
pxListEnd = listGET_END_MARKER( pxList ); /*lint !e826 !e740 The mini list structure is used as the list end to save RAM. This is checked and valid. */
|
|
|
|
vTaskSuspendAll();
|
|
taskENTER_CRITICAL(&pxEventBits->eventGroupMux);
|
|
{
|
|
traceEVENT_GROUP_SET_BITS( xEventGroup, uxBitsToSet );
|
|
|
|
pxListItem = listGET_HEAD_ENTRY( pxList );
|
|
|
|
/* Set the bits. */
|
|
pxEventBits->uxEventBits |= uxBitsToSet;
|
|
|
|
/* See if the new bit value should unblock any tasks. */
|
|
while( pxListItem != pxListEnd )
|
|
{
|
|
pxNext = listGET_NEXT( pxListItem );
|
|
uxBitsWaitedFor = listGET_LIST_ITEM_VALUE( pxListItem );
|
|
xMatchFound = pdFALSE;
|
|
|
|
/* Split the bits waited for from the control bits. */
|
|
uxControlBits = uxBitsWaitedFor & eventEVENT_BITS_CONTROL_BYTES;
|
|
uxBitsWaitedFor &= ~eventEVENT_BITS_CONTROL_BYTES;
|
|
|
|
if( ( uxControlBits & eventWAIT_FOR_ALL_BITS ) == ( EventBits_t ) 0 )
|
|
{
|
|
/* Just looking for single bit being set. */
|
|
if( ( uxBitsWaitedFor & pxEventBits->uxEventBits ) != ( EventBits_t ) 0 )
|
|
{
|
|
xMatchFound = pdTRUE;
|
|
}
|
|
else
|
|
{
|
|
mtCOVERAGE_TEST_MARKER();
|
|
}
|
|
}
|
|
else if( ( uxBitsWaitedFor & pxEventBits->uxEventBits ) == uxBitsWaitedFor )
|
|
{
|
|
/* All bits are set. */
|
|
xMatchFound = pdTRUE;
|
|
}
|
|
else
|
|
{
|
|
/* Need all bits to be set, but not all the bits were set. */
|
|
}
|
|
|
|
if( xMatchFound != pdFALSE )
|
|
{
|
|
/* The bits match. Should the bits be cleared on exit? */
|
|
if( ( uxControlBits & eventCLEAR_EVENTS_ON_EXIT_BIT ) != ( EventBits_t ) 0 )
|
|
{
|
|
uxBitsToClear |= uxBitsWaitedFor;
|
|
}
|
|
else
|
|
{
|
|
mtCOVERAGE_TEST_MARKER();
|
|
}
|
|
|
|
/* Store the actual event flag value in the task's event list
|
|
item before removing the task from the event list. The
|
|
eventUNBLOCKED_DUE_TO_BIT_SET bit is set so the task knows
|
|
that is was unblocked due to its required bits matching, rather
|
|
than because it timed out. */
|
|
( void ) xTaskRemoveFromUnorderedEventList( pxListItem, pxEventBits->uxEventBits | eventUNBLOCKED_DUE_TO_BIT_SET );
|
|
}
|
|
|
|
/* Move onto the next list item. Note pxListItem->pxNext is not
|
|
used here as the list item may have been removed from the event list
|
|
and inserted into the ready/pending reading list. */
|
|
pxListItem = pxNext;
|
|
}
|
|
|
|
/* Clear any bits that matched when the eventCLEAR_EVENTS_ON_EXIT_BIT
|
|
bit was set in the control word. */
|
|
pxEventBits->uxEventBits &= ~uxBitsToClear;
|
|
}
|
|
taskEXIT_CRITICAL(&pxEventBits->eventGroupMux);
|
|
( void ) xTaskResumeAll();
|
|
|
|
return pxEventBits->uxEventBits;
|
|
}
|
|
/*-----------------------------------------------------------*/
|
|
|
|
void vEventGroupDelete( EventGroupHandle_t xEventGroup )
|
|
{
|
|
EventGroup_t *pxEventBits = ( EventGroup_t * ) xEventGroup;
|
|
const List_t *pxTasksWaitingForBits = &( pxEventBits->xTasksWaitingForBits );
|
|
|
|
vTaskSuspendAll();
|
|
taskENTER_CRITICAL( &pxEventBits->eventGroupMux );
|
|
{
|
|
traceEVENT_GROUP_DELETE( xEventGroup );
|
|
|
|
while( listCURRENT_LIST_LENGTH( pxTasksWaitingForBits ) > ( UBaseType_t ) 0 )
|
|
{
|
|
/* Unblock the task, returning 0 as the event list is being deleted
|
|
and cannot therefore have any bits set. */
|
|
configASSERT( pxTasksWaitingForBits->xListEnd.pxNext != ( ListItem_t * ) &( pxTasksWaitingForBits->xListEnd ) );
|
|
( void ) xTaskRemoveFromUnorderedEventList( pxTasksWaitingForBits->xListEnd.pxNext, eventUNBLOCKED_DUE_TO_BIT_SET );
|
|
}
|
|
|
|
#if( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 0 ) )
|
|
{
|
|
/* The event group can only have been allocated dynamically - free
|
|
it again. */
|
|
taskEXIT_CRITICAL( &pxEventBits->eventGroupMux );
|
|
vPortFree( pxEventBits );
|
|
}
|
|
#elif( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )
|
|
{
|
|
/* The event group could have been allocated statically or
|
|
dynamically, so check before attempting to free the memory. */
|
|
if( pxEventBits->ucStaticallyAllocated == ( uint8_t ) pdFALSE )
|
|
{
|
|
taskEXIT_CRITICAL( &pxEventBits->eventGroupMux ); //Exit mux of event group before deleting it
|
|
vPortFree( pxEventBits );
|
|
}
|
|
else
|
|
{
|
|
taskEXIT_CRITICAL( &pxEventBits->eventGroupMux );
|
|
mtCOVERAGE_TEST_MARKER();
|
|
}
|
|
}
|
|
#endif /* configSUPPORT_DYNAMIC_ALLOCATION */
|
|
}
|
|
( void ) xTaskResumeAll();
|
|
}
|
|
/*-----------------------------------------------------------*/
|
|
|
|
/* For internal use only - execute a 'set bits' command that was pended from
|
|
an interrupt. */
|
|
void vEventGroupSetBitsCallback( void *pvEventGroup, const uint32_t ulBitsToSet )
|
|
{
|
|
( void ) xEventGroupSetBits( pvEventGroup, ( EventBits_t ) ulBitsToSet );
|
|
}
|
|
/*-----------------------------------------------------------*/
|
|
|
|
/* For internal use only - execute a 'clear bits' command that was pended from
|
|
an interrupt. */
|
|
void vEventGroupClearBitsCallback( void *pvEventGroup, const uint32_t ulBitsToClear )
|
|
{
|
|
( void ) xEventGroupClearBits( pvEventGroup, ( EventBits_t ) ulBitsToClear );
|
|
}
|
|
/*-----------------------------------------------------------*/
|
|
|
|
static BaseType_t prvTestWaitCondition( const EventBits_t uxCurrentEventBits, const EventBits_t uxBitsToWaitFor, const BaseType_t xWaitForAllBits )
|
|
{
|
|
BaseType_t xWaitConditionMet = pdFALSE;
|
|
|
|
if( xWaitForAllBits == pdFALSE )
|
|
{
|
|
/* Task only has to wait for one bit within uxBitsToWaitFor to be
|
|
set. Is one already set? */
|
|
if( ( uxCurrentEventBits & uxBitsToWaitFor ) != ( EventBits_t ) 0 )
|
|
{
|
|
xWaitConditionMet = pdTRUE;
|
|
}
|
|
else
|
|
{
|
|
mtCOVERAGE_TEST_MARKER();
|
|
}
|
|
}
|
|
else
|
|
{
|
|
/* Task has to wait for all the bits in uxBitsToWaitFor to be set.
|
|
Are they set already? */
|
|
if( ( uxCurrentEventBits & uxBitsToWaitFor ) == uxBitsToWaitFor )
|
|
{
|
|
xWaitConditionMet = pdTRUE;
|
|
}
|
|
else
|
|
{
|
|
mtCOVERAGE_TEST_MARKER();
|
|
}
|
|
}
|
|
|
|
return xWaitConditionMet;
|
|
}
|
|
/*-----------------------------------------------------------*/
|
|
|
|
#if ( ( configUSE_TRACE_FACILITY == 1 ) && ( INCLUDE_xTimerPendFunctionCall == 1 ) && ( configUSE_TIMERS == 1 ) )
|
|
|
|
BaseType_t xEventGroupSetBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet, BaseType_t *pxHigherPriorityTaskWoken )
|
|
{
|
|
BaseType_t xReturn;
|
|
|
|
traceEVENT_GROUP_SET_BITS_FROM_ISR( xEventGroup, uxBitsToSet );
|
|
xReturn = xTimerPendFunctionCallFromISR( vEventGroupSetBitsCallback, ( void * ) xEventGroup, ( uint32_t ) uxBitsToSet, pxHigherPriorityTaskWoken );
|
|
|
|
return xReturn;
|
|
}
|
|
|
|
#endif
|
|
/*-----------------------------------------------------------*/
|
|
|
|
#if (configUSE_TRACE_FACILITY == 1)
|
|
|
|
UBaseType_t uxEventGroupGetNumber( void* xEventGroup )
|
|
{
|
|
UBaseType_t xReturn;
|
|
EventGroup_t *pxEventBits = ( EventGroup_t * ) xEventGroup;
|
|
|
|
if( xEventGroup == NULL )
|
|
{
|
|
xReturn = 0;
|
|
}
|
|
else
|
|
{
|
|
xReturn = pxEventBits->uxEventGroupNumber;
|
|
}
|
|
|
|
return xReturn;
|
|
}
|
|
|
|
#endif
|
|
|