#error INCLUDE_xTimerPendCallbackFromISR must also be set to one to make the xEventGroupSetBitFromISR() function available.\r
#endif\r
\r
-\r
+/* The following bit fields convey control information in a task's event list\r
+item value. It is important they don't clash with the\r
+taskEVENT_LIST_ITEM_VALUE_IN_USE definition. */\r
#if configUSE_16_BIT_TICKS == 1\r
- #define taskCLEAR_EVENTS_ON_EXIT_BIT 0x0100U\r
- #define taskUNBLOCKED_DUE_TO_BIT_SET 0x0200U\r
- #define taskWAIT_FOR_ALL_BITS 0x0400U\r
- #define taskEVENT_BITS_CONTROL_BYTES 0xff00U\r
+ #define eventCLEAR_EVENTS_ON_EXIT_BIT 0x0100U\r
+ #define eventUNBLOCKED_DUE_TO_BIT_SET 0x0200U\r
+ #define eventWAIT_FOR_ALL_BITS 0x0400U\r
+ #define eventEVENT_BITS_CONTROL_BYTES 0xff00U\r
#else\r
- #define taskCLEAR_EVENTS_ON_EXIT_BIT 0x01000000UL\r
- #define taskUNBLOCKED_DUE_TO_BIT_SET 0x02000000UL\r
- #define taskWAIT_FOR_ALL_BITS 0x04000000UL\r
- #define taskEVENT_BITS_CONTROL_BYTES 0xff000000UL\r
+ #define eventCLEAR_EVENTS_ON_EXIT_BIT 0x01000000UL\r
+ #define eventUNBLOCKED_DUE_TO_BIT_SET 0x02000000UL\r
+ #define eventWAIT_FOR_ALL_BITS 0x04000000UL\r
+ #define eventEVENT_BITS_CONTROL_BYTES 0xff000000UL\r
#endif\r
\r
typedef struct EventBitsDefinition\r
\r
/*-----------------------------------------------------------*/\r
\r
+/*\r
+ * Test the bits set in uxCurrentEventBits to see if the wait condition is met.\r
+ * The wait condition is defined by xWaitForAllBits. If xWaitForAllBits is\r
+ * pdTRUE then the wait condition is met if all the bits set in uxBitsToWaitFor\r
+ * are also set in uxCurrentEventBits. If xWaitForAllBits is pdFALSE then the\r
+ * wait condition is met if any of the bits set in uxBitsToWait for are also set\r
+ * in uxCurrentEventBits.\r
+ */\r
+static portBASE_TYPE prvTestWaitCondition( const xEventBitsType uxCurrentEventBits, const xEventBitsType uxBitsToWaitFor, const portBASE_TYPE xWaitForAllBits );\r
+\r
+/*-----------------------------------------------------------*/\r
+\r
xEventGroupHandle xEventGroupCreate( void )\r
{\r
xEVENT_BITS *pxEventBits;\r
{\r
pxEventBits->uxEventBits = 0;\r
vListInitialise( &( pxEventBits->xTasksWaitingForBits ) );\r
- traceEVENT_GROUP_CREATE( pxEventBits ); \r
+ traceEVENT_GROUP_CREATE( pxEventBits );\r
}\r
else\r
{\r
}\r
/*-----------------------------------------------------------*/\r
\r
-xEventBitsType xEventGroupSync( xEventGroupHandle xEventGroup, xEventBitsType uxBitsToSet, xEventBitsType uxBitsToWaitFor, portTickType xTicksToWait )\r
+xEventBitsType xEventGroupSync( xEventGroupHandle xEventGroup, const xEventBitsType uxBitsToSet, const xEventBitsType uxBitsToWaitFor, portTickType xTicksToWait )\r
{\r
xEventBitsType uxOriginalBitValue, uxReturn;\r
xEVENT_BITS *pxEventBits = ( xEVENT_BITS * ) xEventGroup;\r
-portBASE_TYPE xYieldedAlready;\r
+portBASE_TYPE xAlreadyYielded;\r
\r
+ configASSERT( ( uxBitsToWaitFor & eventEVENT_BITS_CONTROL_BYTES ) == 0 );\r
+ configASSERT( uxBitsToWaitFor != 0 );\r
#if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )\r
{\r
configASSERT( !( ( xTaskGetSchedulerState() == taskSCHEDULER_SUSPENDED ) && ( xTicksToWait != 0 ) ) );\r
\r
if( ( ( uxOriginalBitValue | uxBitsToSet ) & uxBitsToWaitFor ) == uxBitsToWaitFor )\r
{\r
- /* All the rendezvous bits will have been set once this task set\r
- its bits - no need to block. */\r
+ /* All the rendezvous bits are now set - no need to block. */\r
uxReturn = ( uxOriginalBitValue | uxBitsToSet );\r
\r
/* Rendezvous always clear the bits. They will have been cleared\r
/* Store the bits that the calling task is waiting for in the\r
task's event list item so the kernel knows when a match is\r
found. Then enter the blocked state. */\r
- vTaskPlaceOnUnorderedEventList( &( pxEventBits->xTasksWaitingForBits ), ( uxBitsToWaitFor | taskCLEAR_EVENTS_ON_EXIT_BIT | taskWAIT_FOR_ALL_BITS ), xTicksToWait );\r
+ vTaskPlaceOnUnorderedEventList( &( pxEventBits->xTasksWaitingForBits ), ( uxBitsToWaitFor | eventCLEAR_EVENTS_ON_EXIT_BIT | eventWAIT_FOR_ALL_BITS ), xTicksToWait );\r
\r
- /* This is obsolete as it will get set after the task unblocks,\r
- but some compilers mistakenly generate a warning about the\r
- variable being returned without being set if it is not done. */\r
+ /* This assignment is obsolete as uxReturn will get set after\r
+ the task unblocks, but some compilers mistakenly generate a\r
+ warning about uxReturn being returned without being set if the\r
+ assignment is omitted. */\r
uxReturn = 0;\r
}\r
else\r
}\r
}\r
}\r
- xYieldedAlready = xTaskResumeAll();\r
+ xAlreadyYielded = xTaskResumeAll();\r
\r
if( xTicksToWait != ( portTickType ) 0 )\r
{\r
- if( xYieldedAlready == pdFALSE )\r
+ if( xAlreadyYielded == pdFALSE )\r
{\r
portYIELD_WITHIN_API();\r
}\r
+ else\r
+ {\r
+ mtBRANCH_TEST_INSTRUCTION();\r
+ }\r
\r
/* The task blocked to wait for its required bits to be set - at this\r
point either the required bits were set or the block time expired. If\r
event list item, and they should now be retrieved then cleared. */\r
uxReturn = uxTaskResetEventItemValue();\r
\r
- if( ( uxReturn & taskUNBLOCKED_DUE_TO_BIT_SET ) == ( xEventBitsType ) 0 )\r
+ if( ( uxReturn & eventUNBLOCKED_DUE_TO_BIT_SET ) == ( xEventBitsType ) 0 )\r
{\r
/* The task timed out, just return the current event bit value. */\r
- uxReturn = pxEventBits->uxEventBits;\r
+ taskENTER_CRITICAL();\r
+ {\r
+ uxReturn = pxEventBits->uxEventBits;\r
+\r
+ /* Although the task got here because it timed out before the\r
+ bits it was waiting for were set, it is possible that since it\r
+ unblocked another task has set the bits. If this is the case\r
+ then it may be required to clear the bits before exiting. */\r
+ if( ( uxReturn & uxBitsToWaitFor ) == uxBitsToWaitFor )\r
+ {\r
+ pxEventBits->uxEventBits &= ~uxBitsToWaitFor;\r
+ }\r
+ else\r
+ {\r
+ mtBRANCH_TEST_INSTRUCTION();\r
+ }\r
+ }\r
+ taskEXIT_CRITICAL();\r
}\r
else\r
{\r
/* The task unblocked because the bits were set. Clear the control\r
bits before returning the value. */\r
- uxReturn &= ~taskEVENT_BITS_CONTROL_BYTES;\r
+ uxReturn &= ~eventEVENT_BITS_CONTROL_BYTES;\r
}\r
}\r
\r
}\r
/*-----------------------------------------------------------*/\r
\r
-xEventBitsType xEventGroupWaitBits( xEventGroupHandle xEventGroup, xEventBitsType uxBitsToWaitFor, portBASE_TYPE xClearOnExit, portBASE_TYPE xWaitForAllBits, portTickType xTicksToWait )\r
+xEventBitsType xEventGroupWaitBits( xEventGroupHandle xEventGroup, const xEventBitsType uxBitsToWaitFor, const portBASE_TYPE xClearOnExit, const portBASE_TYPE xWaitForAllBits, portTickType xTicksToWait )\r
{\r
xEVENT_BITS *pxEventBits = ( xEVENT_BITS * ) xEventGroup;\r
xEventBitsType uxReturn, uxControlBits = 0;\r
+portBASE_TYPE xWaitConditionMet, xAlreadyYielded;\r
\r
/* Check the user is not attempting to wait on the bits used by the kernel\r
itself, and that at least one bit is being requested. */\r
- configASSERT( ( uxBitsToWaitFor & taskEVENT_BITS_CONTROL_BYTES ) == 0 );\r
+ configASSERT( ( uxBitsToWaitFor & eventEVENT_BITS_CONTROL_BYTES ) == 0 );\r
configASSERT( uxBitsToWaitFor != 0 );\r
#if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )\r
{\r
}\r
#endif\r
\r
- taskENTER_CRITICAL();\r
+ vTaskSuspendAll();\r
{\r
const xEventBitsType uxCurrentEventBits = pxEventBits->uxEventBits;\r
\r
traceEVENT_GROUP_WAIT_BITS_START( xEventGroup, uxBitsToWaitFor );\r
\r
- if( xWaitForAllBits == pdFALSE )\r
- {\r
- /* Task only has to wait for one bit within uxBitsToWaitFor to be set. Is\r
- one already set? */\r
- if( ( uxCurrentEventBits & uxBitsToWaitFor ) != ( xEventBitsType ) 0 )\r
- {\r
- /* At least one of the bits was set. No need to block. */\r
- xTicksToWait = 0;\r
- }\r
- }\r
- else\r
- {\r
- /* Task has to wait for all the bits in uxBitsToWaitFor to be set. Are they\r
- set already? */\r
- if( ( uxCurrentEventBits & uxBitsToWaitFor ) == uxBitsToWaitFor )\r
- {\r
- /* All the bits were set, no need to block. */\r
- xTicksToWait = 0;\r
- }\r
- }\r
+ /* Check to see if the wait condition is already met or not. */\r
+ xWaitConditionMet = prvTestWaitCondition( uxCurrentEventBits, uxBitsToWaitFor, xWaitForAllBits );\r
\r
- /* The task can return now if either its wait condition is already met\r
- or the requested block time is 0. */\r
- if( xTicksToWait == ( portTickType ) 0 )\r
+ if( xWaitConditionMet != pdFALSE )\r
{\r
- /* No need to block, just set the return value. */\r
+ /* The wait condition has already been met so there is no need to\r
+ block. */\r
uxReturn = uxCurrentEventBits;\r
+ xTicksToWait = ( portTickType ) 0;\r
\r
+ /* Clear the wait bits if requested to do so. */\r
if( xClearOnExit != pdFALSE )\r
{\r
- /* The user requested the bits be cleared again prior to exiting\r
- this function. */\r
pxEventBits->uxEventBits &= ~uxBitsToWaitFor;\r
}\r
+ else\r
+ {\r
+ mtBRANCH_TEST_INSTRUCTION();\r
+ }\r
+ }\r
+ else if( xTicksToWait == ( portTickType ) 0 )\r
+ {\r
+ /* The wait condition has not been met, but no block time was\r
+ specified, so just return the current value. */\r
+ uxReturn = uxCurrentEventBits;\r
}\r
else\r
{\r
unblock the task. */\r
if( xClearOnExit != pdFALSE )\r
{\r
- uxControlBits |= taskCLEAR_EVENTS_ON_EXIT_BIT;\r
+ uxControlBits |= eventCLEAR_EVENTS_ON_EXIT_BIT;\r
+ }\r
+ else\r
+ {\r
+ mtBRANCH_TEST_INSTRUCTION();\r
}\r
\r
if( xWaitForAllBits != pdFALSE )\r
{\r
- uxControlBits |= taskWAIT_FOR_ALL_BITS;\r
+ uxControlBits |= eventWAIT_FOR_ALL_BITS;\r
+ }\r
+ else\r
+ {\r
+ mtBRANCH_TEST_INSTRUCTION();\r
}\r
\r
/* Store the bits that the calling task is waiting for in the\r
task's event list item so the kernel knows when a match is\r
found. Then enter the blocked state. */\r
vTaskPlaceOnUnorderedEventList( &( pxEventBits->xTasksWaitingForBits ), ( uxBitsToWaitFor | uxControlBits ), xTicksToWait );\r
- portYIELD_WITHIN_API();\r
\r
/* This is obsolete as it will get set after the task unblocks, but\r
some compilers mistakenly generate a warning about the variable\r
uxReturn = 0;\r
}\r
}\r
- taskEXIT_CRITICAL();\r
+ xAlreadyYielded = xTaskResumeAll();\r
\r
if( xTicksToWait != ( portTickType ) 0 )\r
{\r
+ if( xAlreadyYielded == pdFALSE )\r
+ {\r
+ portYIELD_WITHIN_API();\r
+ }\r
+ else\r
+ {\r
+ mtBRANCH_TEST_INSTRUCTION();\r
+ }\r
+\r
/* The task blocked to wait for its required bits to be set - at this\r
point either the required bits were set or the block time expired. If\r
the required bits were set they will have been stored in the task's\r
event list item, and they should now be retrieved then cleared. */\r
uxReturn = uxTaskResetEventItemValue();\r
\r
- if( ( uxReturn & taskUNBLOCKED_DUE_TO_BIT_SET ) == ( xEventBitsType ) 0 )\r
+ if( ( uxReturn & eventUNBLOCKED_DUE_TO_BIT_SET ) == ( xEventBitsType ) 0 )\r
{\r
- /* The task timed out, just return the current event bit value. */\r
- uxReturn = pxEventBits->uxEventBits;\r
+ taskENTER_CRITICAL();\r
+ {\r
+ /* The task timed out, just return the current event bit value. */\r
+ uxReturn = pxEventBits->uxEventBits;\r
+\r
+ /* It is possible that the event bits were updated between this\r
+ task leaving the Blocked state and running again. */\r
+ if( prvTestWaitCondition( uxReturn, uxBitsToWaitFor, xWaitForAllBits ) != pdFALSE )\r
+ {\r
+ if( xClearOnExit != pdFALSE )\r
+ {\r
+ pxEventBits->uxEventBits &= ~uxBitsToWaitFor;\r
+ }\r
+ else\r
+ {\r
+ mtBRANCH_TEST_INSTRUCTION();\r
+ }\r
+ }\r
+ else\r
+ {\r
+ mtBRANCH_TEST_INSTRUCTION();\r
+ }\r
+ }\r
+ taskEXIT_CRITICAL();\r
}\r
else\r
{\r
/* The task unblocked because the bits were set. Clear the control\r
bits before returning the value. */\r
- uxReturn &= ~taskEVENT_BITS_CONTROL_BYTES;\r
+ uxReturn &= ~eventEVENT_BITS_CONTROL_BYTES;\r
}\r
}\r
\r
}\r
/*-----------------------------------------------------------*/\r
\r
-xEventBitsType xEventGroupClearBits( xEventGroupHandle xEventGroup, xEventBitsType uxBitsToClear )\r
+xEventBitsType xEventGroupClearBits( xEventGroupHandle xEventGroup, const xEventBitsType uxBitsToClear )\r
{\r
xEVENT_BITS *pxEventBits = ( xEVENT_BITS * ) xEventGroup;\r
xEventBitsType uxReturn;\r
\r
/* Check the user is not attempting to clear the bits used by the kernel\r
itself. */\r
- configASSERT( ( uxBitsToClear & taskEVENT_BITS_CONTROL_BYTES ) == 0 );\r
+ configASSERT( ( uxBitsToClear & eventEVENT_BITS_CONTROL_BYTES ) == 0 );\r
\r
- uxBitsToClear = ~uxBitsToClear;\r
taskENTER_CRITICAL();\r
{\r
- traceEVENT_GROUP_CLEAR_BITS( xEventGroup, ~uxBitsToClear );\r
+ traceEVENT_GROUP_CLEAR_BITS( xEventGroup, uxBitsToClear );\r
\r
/* The value returned is the event group value prior to the bits being\r
cleared. */\r
uxReturn = pxEventBits->uxEventBits;\r
\r
/* Clear the bits. */\r
- pxEventBits->uxEventBits &= uxBitsToClear;\r
+ pxEventBits->uxEventBits &= ~uxBitsToClear;\r
}\r
taskEXIT_CRITICAL();\r
\r
}\r
/*-----------------------------------------------------------*/\r
\r
-xEventBitsType xEventGroupSetBits( xEventGroupHandle xEventGroup, xEventBitsType uxBitsToSet )\r
+xEventBitsType xEventGroupSetBits( xEventGroupHandle xEventGroup, const xEventBitsType uxBitsToSet )\r
{\r
xListItem *pxListItem, *pxNext;\r
xListItem const *pxListEnd;\r
\r
/* Check the user is not attempting to set the bits used by the kernel\r
itself. */\r
- configASSERT( ( uxBitsToSet & taskEVENT_BITS_CONTROL_BYTES ) == 0 );\r
+ configASSERT( ( uxBitsToSet & eventEVENT_BITS_CONTROL_BYTES ) == 0 );\r
\r
pxList = &( pxEventBits->xTasksWaitingForBits );\r
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. */\r
xMatchFound = pdFALSE;\r
\r
/* Split the bits waited for from the control bits. */\r
- uxControlBits = uxBitsWaitedFor & taskEVENT_BITS_CONTROL_BYTES;\r
- uxBitsWaitedFor &= ~taskEVENT_BITS_CONTROL_BYTES;\r
+ uxControlBits = uxBitsWaitedFor & eventEVENT_BITS_CONTROL_BYTES;\r
+ uxBitsWaitedFor &= ~eventEVENT_BITS_CONTROL_BYTES;\r
\r
- if( ( uxControlBits & taskWAIT_FOR_ALL_BITS ) == ( xEventBitsType ) 0 )\r
+ if( ( uxControlBits & eventWAIT_FOR_ALL_BITS ) == ( xEventBitsType ) 0 )\r
{\r
/* Just looking for single bit being set. */\r
if( ( uxBitsWaitedFor & pxEventBits->uxEventBits ) != ( xEventBitsType ) 0 )\r
{\r
xMatchFound = pdTRUE;\r
}\r
+ else\r
+ {\r
+ mtBRANCH_TEST_INSTRUCTION();\r
+ }\r
}\r
else if( ( uxBitsWaitedFor & pxEventBits->uxEventBits ) == uxBitsWaitedFor )\r
{\r
if( xMatchFound != pdFALSE )\r
{\r
/* The bits match. Should the bits be cleared on exit? */\r
- if( ( uxControlBits & taskCLEAR_EVENTS_ON_EXIT_BIT ) != ( xEventBitsType ) 0 )\r
+ if( ( uxControlBits & eventCLEAR_EVENTS_ON_EXIT_BIT ) != ( xEventBitsType ) 0 )\r
{\r
uxBitsToClear |= uxBitsWaitedFor;\r
}\r
+ else\r
+ {\r
+ mtBRANCH_TEST_INSTRUCTION();\r
+ }\r
\r
/* Store the actual event flag value in the task's event list\r
item before removing the task from the event list. The\r
- taskUNBLOCKED_DUE_TO_BIT_SET bit is set so the task knows\r
+ eventUNBLOCKED_DUE_TO_BIT_SET bit is set so the task knows\r
that is was unblocked due to its required bits matching, rather\r
than because it timed out. */\r
- ( void ) xTaskRemoveFromUnorderedEventList( pxListItem, pxEventBits->uxEventBits | taskUNBLOCKED_DUE_TO_BIT_SET );\r
+ ( void ) xTaskRemoveFromUnorderedEventList( pxListItem, pxEventBits->uxEventBits | eventUNBLOCKED_DUE_TO_BIT_SET );\r
}\r
\r
/* Move onto the next list item. Note pxListItem->pxNext is not\r
pxListItem = pxNext;\r
}\r
\r
- /* Clear any bits that matched when the taskCLEAR_EVENTS_ON_EXIT_BIT\r
+ /* Clear any bits that matched when the eventCLEAR_EVENTS_ON_EXIT_BIT\r
bit was set in the control word. */\r
pxEventBits->uxEventBits &= ~uxBitsToClear;\r
}\r
/* Unblock the task, returning 0 as the event list is being deleted\r
and cannot therefore have any bits set. */\r
configASSERT( pxTasksWaitingForBits->xListEnd.pxNext != ( xListItem * ) &( pxTasksWaitingForBits->xListEnd ) );\r
- ( void ) xTaskRemoveFromUnorderedEventList( pxTasksWaitingForBits->xListEnd.pxNext, ( portTickType ) taskUNBLOCKED_DUE_TO_BIT_SET );\r
+ ( void ) xTaskRemoveFromUnorderedEventList( pxTasksWaitingForBits->xListEnd.pxNext, ( portTickType ) eventUNBLOCKED_DUE_TO_BIT_SET );\r
}\r
\r
vPortFree( pxEventBits );\r
\r
/* For internal use only - execute a 'set bits' command that was pended from\r
an interrupt. */\r
-void vEventGroupSetBitsCallback( void *pvEventGroup, unsigned long ulBitsToSet )\r
+void vEventGroupSetBitsCallback( void *pvEventGroup, const unsigned long ulBitsToSet )\r
{\r
( void ) xEventGroupSetBits( pvEventGroup, ( xEventBitsType ) ulBitsToSet );\r
}\r
+/*-----------------------------------------------------------*/\r
+\r
+static portBASE_TYPE prvTestWaitCondition( const xEventBitsType uxCurrentEventBits, const xEventBitsType uxBitsToWaitFor, const portBASE_TYPE xWaitForAllBits )\r
+{\r
+portBASE_TYPE xWaitConditionMet = pdFALSE;\r
+\r
+ if( xWaitForAllBits == pdFALSE )\r
+ {\r
+ /* Task only has to wait for one bit within uxBitsToWaitFor to be\r
+ set. Is one already set? */\r
+ if( ( uxCurrentEventBits & uxBitsToWaitFor ) != ( xEventBitsType ) 0 )\r
+ {\r
+ xWaitConditionMet = pdTRUE;\r
+ }\r
+ else\r
+ {\r
+ mtBRANCH_TEST_INSTRUCTION();\r
+ }\r
+ }\r
+ else\r
+ {\r
+ /* Task has to wait for all the bits in uxBitsToWaitFor to be set.\r
+ Are they set already? */\r
+ if( ( uxCurrentEventBits & uxBitsToWaitFor ) == uxBitsToWaitFor )\r
+ {\r
+ xWaitConditionMet = pdTRUE;\r
+ }\r
+ else\r
+ {\r
+ mtBRANCH_TEST_INSTRUCTION();\r
+ }\r
+ }\r
+\r
+ return xWaitConditionMet;\r
+}\r
\r
\r
projects / freertos / blobdiff