begriffs open source - freertos/blob - include/event_groups.h

   1 /*
   2  * FreeRTOS Kernel <DEVELOPMENT BRANCH>
   3  * Copyright (C) 2021 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
   4  *
   5  * SPDX-License-Identifier: MIT
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy of
   8  * this software and associated documentation files (the "Software"), to deal in
   9  * the Software without restriction, including without limitation the rights to
  10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
  11  * the Software, and to permit persons to whom the Software is furnished to do so,
  12  * subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in all
  15  * copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
  19  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
  20  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  21  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  *
  24  * https://www.FreeRTOS.org
  25  * https://github.com/FreeRTOS
  26  *
  27  */
  28
  29 #ifndef EVENT_GROUPS_H
  30 #define EVENT_GROUPS_H
  31
  32 #ifndef INC_FREERTOS_H
  33     #error "include FreeRTOS.h" must appear in source files before "include event_groups.h"
  34 #endif
  35
  36 /* FreeRTOS includes. */
  37 #include "timers.h"
  38
  39 /* *INDENT-OFF* */
  40 #ifdef __cplusplus
  41     extern "C" {
  42 #endif
  43 /* *INDENT-ON* */
  44
  45 /**
  46  * An event group is a collection of bits to which an application can assign a
  47  * meaning.  For example, an application may create an event group to convey
  48  * the status of various CAN bus related events in which bit 0 might mean "A CAN
  49  * message has been received and is ready for processing", bit 1 might mean "The
  50  * application has queued a message that is ready for sending onto the CAN
  51  * network", and bit 2 might mean "It is time to send a SYNC message onto the
  52  * CAN network" etc.  A task can then test the bit values to see which events
  53  * are active, and optionally enter the Blocked state to wait for a specified
  54  * bit or a group of specified bits to be active.  To continue the CAN bus
  55  * example, a CAN controlling task can enter the Blocked state (and therefore
  56  * not consume any processing time) until either bit 0, bit 1 or bit 2 are
  57  * active, at which time the bit that was actually active would inform the task
  58  * which action it had to take (process a received message, send a message, or
  59  * send a SYNC).
  60  *
  61  * The event groups implementation contains intelligence to avoid race
  62  * conditions that would otherwise occur were an application to use a simple
  63  * variable for the same purpose.  This is particularly important with respect
  64  * to when a bit within an event group is to be cleared, and when bits have to
  65  * be set and then tested atomically - as is the case where event groups are
  66  * used to create a synchronisation point between multiple tasks (a
  67  * 'rendezvous').
  68  *
  69  * \defgroup EventGroup
  70  */
  71
  72
  73
  74 /**
  75  * event_groups.h
  76  *
  77  * Type by which event groups are referenced.  For example, a call to
  78  * xEventGroupCreate() returns an EventGroupHandle_t variable that can then
  79  * be used as a parameter to other event group functions.
  80  *
  81  * \defgroup EventGroupHandle_t EventGroupHandle_t
  82  * \ingroup EventGroup
  83  */
  84 struct EventGroupDef_t;
  85 typedef struct EventGroupDef_t   * EventGroupHandle_t;
  86
  87 /*
  88  * The type that holds event bits always matches TickType_t - therefore the
  89  * number of bits it holds is set by configUSE_16_BIT_TICKS (16 bits if set to 1,
  90  * 32 bits if set to 0.
  91  *
  92  * \defgroup EventBits_t EventBits_t
  93  * \ingroup EventGroup
  94  */
  95 typedef TickType_t               EventBits_t;
  96
  97 /**
  98  * event_groups.h
  99  * @code{c}
 100  * EventGroupHandle_t xEventGroupCreate( void );
 101  * @endcode
 102  *
 103  * Create a new event group.
 104  *
 105  * Internally, within the FreeRTOS implementation, event groups use a [small]
 106  * block of memory, in which the event group's structure is stored.  If an event
 107  * groups is created using xEventGroupCreate() then the required memory is
 108  * automatically dynamically allocated inside the xEventGroupCreate() function.
 109  * (see https://www.FreeRTOS.org/a00111.html).  If an event group is created
 110  * using xEventGroupCreateStatic() then the application writer must instead
 111  * provide the memory that will get used by the event group.
 112  * xEventGroupCreateStatic() therefore allows an event group to be created
 113  * without using any dynamic memory allocation.
 114  *
 115  * Although event groups are not related to ticks, for internal implementation
 116  * reasons the number of bits available for use in an event group is dependent
 117  * on the configUSE_16_BIT_TICKS setting in FreeRTOSConfig.h.  If
 118  * configUSE_16_BIT_TICKS is 1 then each event group contains 8 usable bits (bit
 119  * 0 to bit 7).  If configUSE_16_BIT_TICKS is set to 0 then each event group has
 120  * 24 usable bits (bit 0 to bit 23).  The EventBits_t type is used to store
 121  * event bits within an event group.
 122  *
 123  * @return If the event group was created then a handle to the event group is
 124  * returned.  If there was insufficient FreeRTOS heap available to create the
 125  * event group then NULL is returned.  See https://www.FreeRTOS.org/a00111.html
 126  *
 127  * Example usage:
 128  * @code{c}
 129  *  // Declare a variable to hold the created event group.
 130  *  EventGroupHandle_t xCreatedEventGroup;
 131  *
 132  *  // Attempt to create the event group.
 133  *  xCreatedEventGroup = xEventGroupCreate();
 134  *
 135  *  // Was the event group created successfully?
 136  *  if( xCreatedEventGroup == NULL )
 137  *  {
 138  *      // The event group was not created because there was insufficient
 139  *      // FreeRTOS heap available.
 140  *  }
 141  *  else
 142  *  {
 143  *      // The event group was created.
 144  *  }
 145  * @endcode
 146  * \defgroup xEventGroupCreate xEventGroupCreate
 147  * \ingroup EventGroup
 148  */
 149 #if ( configSUPPORT_DYNAMIC_ALLOCATION == 1 )
 150     EventGroupHandle_t xEventGroupCreate( void ) PRIVILEGED_FUNCTION;
 151 #endif
 152
 153 /**
 154  * event_groups.h
 155  * @code{c}
 156  * EventGroupHandle_t xEventGroupCreateStatic( EventGroupHandle_t * pxEventGroupBuffer );
 157  * @endcode
 158  *
 159  * Create a new event group.
 160  *
 161  * Internally, within the FreeRTOS implementation, event groups use a [small]
 162  * block of memory, in which the event group's structure is stored.  If an event
 163  * groups is created using xEventGroupCreate() then the required memory is
 164  * automatically dynamically allocated inside the xEventGroupCreate() function.
 165  * (see https://www.FreeRTOS.org/a00111.html).  If an event group is created
 166  * using xEventGroupCreateStatic() then the application writer must instead
 167  * provide the memory that will get used by the event group.
 168  * xEventGroupCreateStatic() therefore allows an event group to be created
 169  * without using any dynamic memory allocation.
 170  *
 171  * Although event groups are not related to ticks, for internal implementation
 172  * reasons the number of bits available for use in an event group is dependent
 173  * on the configUSE_16_BIT_TICKS setting in FreeRTOSConfig.h.  If
 174  * configUSE_16_BIT_TICKS is 1 then each event group contains 8 usable bits (bit
 175  * 0 to bit 7).  If configUSE_16_BIT_TICKS is set to 0 then each event group has
 176  * 24 usable bits (bit 0 to bit 23).  The EventBits_t type is used to store
 177  * event bits within an event group.
 178  *
 179  * @param pxEventGroupBuffer pxEventGroupBuffer must point to a variable of type
 180  * StaticEventGroup_t, which will be then be used to hold the event group's data
 181  * structures, removing the need for the memory to be allocated dynamically.
 182  *
 183  * @return If the event group was created then a handle to the event group is
 184  * returned.  If pxEventGroupBuffer was NULL then NULL is returned.
 185  *
 186  * Example usage:
 187  * @code{c}
 188  *  // StaticEventGroup_t is a publicly accessible structure that has the same
 189  *  // size and alignment requirements as the real event group structure.  It is
 190  *  // provided as a mechanism for applications to know the size of the event
 191  *  // group (which is dependent on the architecture and configuration file
 192  *  // settings) without breaking the strict data hiding policy by exposing the
 193  *  // real event group internals.  This StaticEventGroup_t variable is passed
 194  *  // into the xSemaphoreCreateEventGroupStatic() function and is used to store
 195  *  // the event group's data structures
 196  *  StaticEventGroup_t xEventGroupBuffer;
 197  *
 198  *  // Create the event group without dynamically allocating any memory.
 199  *  xEventGroup = xEventGroupCreateStatic( &xEventGroupBuffer );
 200  * @endcode
 201  */
 202 #if ( configSUPPORT_STATIC_ALLOCATION == 1 )
 203     EventGroupHandle_t xEventGroupCreateStatic( StaticEventGroup_t * pxEventGroupBuffer ) PRIVILEGED_FUNCTION;
 204 #endif
 205
 206 /**
 207  * event_groups.h
 208  * @code{c}
 209  *  EventBits_t xEventGroupWaitBits(    EventGroupHandle_t xEventGroup,
 210  *                                      const EventBits_t uxBitsToWaitFor,
 211  *                                      const BaseType_t xClearOnExit,
 212  *                                      const BaseType_t xWaitForAllBits,
 213  *                                      const TickType_t xTicksToWait );
 214  * @endcode
 215  *
 216  * [Potentially] block to wait for one or more bits to be set within a
 217  * previously created event group.
 218  *
 219  * This function cannot be called from an interrupt.
 220  *
 221  * @param xEventGroup The event group in which the bits are being tested.  The
 222  * event group must have previously been created using a call to
 223  * xEventGroupCreate().
 224  *
 225  * @param uxBitsToWaitFor A bitwise value that indicates the bit or bits to test
 226  * inside the event group.  For example, to wait for bit 0 and/or bit 2 set
 227  * uxBitsToWaitFor to 0x05.  To wait for bits 0 and/or bit 1 and/or bit 2 set
 228  * uxBitsToWaitFor to 0x07.  Etc.
 229  *
 230  * @param xClearOnExit If xClearOnExit is set to pdTRUE then any bits within
 231  * uxBitsToWaitFor that are set within the event group will be cleared before
 232  * xEventGroupWaitBits() returns if the wait condition was met (if the function
 233  * returns for a reason other than a timeout).  If xClearOnExit is set to
 234  * pdFALSE then the bits set in the event group are not altered when the call to
 235  * xEventGroupWaitBits() returns.
 236  *
 237  * @param xWaitForAllBits If xWaitForAllBits is set to pdTRUE then
 238  * xEventGroupWaitBits() will return when either all the bits in uxBitsToWaitFor
 239  * are set or the specified block time expires.  If xWaitForAllBits is set to
 240  * pdFALSE then xEventGroupWaitBits() will return when any one of the bits set
 241  * in uxBitsToWaitFor is set or the specified block time expires.  The block
 242  * time is specified by the xTicksToWait parameter.
 243  *
 244  * @param xTicksToWait The maximum amount of time (specified in 'ticks') to wait
 245  * for one/all (depending on the xWaitForAllBits value) of the bits specified by
 246  * uxBitsToWaitFor to become set. A value of portMAX_DELAY can be used to block
 247  * indefinitely (provided INCLUDE_vTaskSuspend is set to 1 in FreeRTOSConfig.h).
 248  *
 249  * @return The value of the event group at the time either the bits being waited
 250  * for became set, or the block time expired.  Test the return value to know
 251  * which bits were set.  If xEventGroupWaitBits() returned because its timeout
 252  * expired then not all the bits being waited for will be set.  If
 253  * xEventGroupWaitBits() returned because the bits it was waiting for were set
 254  * then the returned value is the event group value before any bits were
 255  * automatically cleared in the case that xClearOnExit parameter was set to
 256  * pdTRUE.
 257  *
 258  * Example usage:
 259  * @code{c}
 260  * #define BIT_0 ( 1 << 0 )
 261  * #define BIT_4 ( 1 << 4 )
 262  *
 263  * void aFunction( EventGroupHandle_t xEventGroup )
 264  * {
 265  * EventBits_t uxBits;
 266  * const TickType_t xTicksToWait = 100 / portTICK_PERIOD_MS;
 267  *
 268  *      // Wait a maximum of 100ms for either bit 0 or bit 4 to be set within
 269  *      // the event group.  Clear the bits before exiting.
 270  *      uxBits = xEventGroupWaitBits(
 271  *                  xEventGroup,    // The event group being tested.
 272  *                  BIT_0 | BIT_4,  // The bits within the event group to wait for.
 273  *                  pdTRUE,         // BIT_0 and BIT_4 should be cleared before returning.
 274  *                  pdFALSE,        // Don't wait for both bits, either bit will do.
 275  *                  xTicksToWait ); // Wait a maximum of 100ms for either bit to be set.
 276  *
 277  *      if( ( uxBits & ( BIT_0 | BIT_4 ) ) == ( BIT_0 | BIT_4 ) )
 278  *      {
 279  *          // xEventGroupWaitBits() returned because both bits were set.
 280  *      }
 281  *      else if( ( uxBits & BIT_0 ) != 0 )
 282  *      {
 283  *          // xEventGroupWaitBits() returned because just BIT_0 was set.
 284  *      }
 285  *      else if( ( uxBits & BIT_4 ) != 0 )
 286  *      {
 287  *          // xEventGroupWaitBits() returned because just BIT_4 was set.
 288  *      }
 289  *      else
 290  *      {
 291  *          // xEventGroupWaitBits() returned because xTicksToWait ticks passed
 292  *          // without either BIT_0 or BIT_4 becoming set.
 293  *      }
 294  * }
 295  * @endcode
 296  * \defgroup xEventGroupWaitBits xEventGroupWaitBits
 297  * \ingroup EventGroup
 298  */
 299 EventBits_t xEventGroupWaitBits( EventGroupHandle_t xEventGroup,
 300                                  const EventBits_t uxBitsToWaitFor,
 301                                  const BaseType_t xClearOnExit,
 302                                  const BaseType_t xWaitForAllBits,
 303                                  TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;
 304
 305 /**
 306  * event_groups.h
 307  * @code{c}
 308  *  EventBits_t xEventGroupClearBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear );
 309  * @endcode
 310  *
 311  * Clear bits within an event group.  This function cannot be called from an
 312  * interrupt.
 313  *
 314  * @param xEventGroup The event group in which the bits are to be cleared.
 315  *
 316  * @param uxBitsToClear A bitwise value that indicates the bit or bits to clear
 317  * in the event group.  For example, to clear bit 3 only, set uxBitsToClear to
 318  * 0x08.  To clear bit 3 and bit 0 set uxBitsToClear to 0x09.
 319  *
 320  * @return The value of the event group before the specified bits were cleared.
 321  *
 322  * Example usage:
 323  * @code{c}
 324  * #define BIT_0 ( 1 << 0 )
 325  * #define BIT_4 ( 1 << 4 )
 326  *
 327  * void aFunction( EventGroupHandle_t xEventGroup )
 328  * {
 329  * EventBits_t uxBits;
 330  *
 331  *      // Clear bit 0 and bit 4 in xEventGroup.
 332  *      uxBits = xEventGroupClearBits(
 333  *                              xEventGroup,    // The event group being updated.
 334  *                              BIT_0 | BIT_4 );// The bits being cleared.
 335  *
 336  *      if( ( uxBits & ( BIT_0 | BIT_4 ) ) == ( BIT_0 | BIT_4 ) )
 337  *      {
 338  *          // Both bit 0 and bit 4 were set before xEventGroupClearBits() was
 339  *          // called.  Both will now be clear (not set).
 340  *      }
 341  *      else if( ( uxBits & BIT_0 ) != 0 )
 342  *      {
 343  *          // Bit 0 was set before xEventGroupClearBits() was called.  It will
 344  *          // now be clear.
 345  *      }
 346  *      else if( ( uxBits & BIT_4 ) != 0 )
 347  *      {
 348  *          // Bit 4 was set before xEventGroupClearBits() was called.  It will
 349  *          // now be clear.
 350  *      }
 351  *      else
 352  *      {
 353  *          // Neither bit 0 nor bit 4 were set in the first place.
 354  *      }
 355  * }
 356  * @endcode
 357  * \defgroup xEventGroupClearBits xEventGroupClearBits
 358  * \ingroup EventGroup
 359  */
 360 EventBits_t xEventGroupClearBits( EventGroupHandle_t xEventGroup,
 361                                   const EventBits_t uxBitsToClear ) PRIVILEGED_FUNCTION;
 362
 363 /**
 364  * event_groups.h
 365  * @code{c}
 366  *  BaseType_t xEventGroupClearBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet );
 367  * @endcode
 368  *
 369  * A version of xEventGroupClearBits() that can be called from an interrupt.
 370  *
 371  * Setting bits in an event group is not a deterministic operation because there
 372  * are an unknown number of tasks that may be waiting for the bit or bits being
 373  * set.  FreeRTOS does not allow nondeterministic operations to be performed
 374  * while interrupts are disabled, so protects event groups that are accessed
 375  * from tasks by suspending the scheduler rather than disabling interrupts.  As
 376  * a result event groups cannot be accessed directly from an interrupt service
 377  * routine.  Therefore xEventGroupClearBitsFromISR() sends a message to the
 378  * timer task to have the clear operation performed in the context of the timer
 379  * task.
 380  *
 381  * @param xEventGroup The event group in which the bits are to be cleared.
 382  *
 383  * @param uxBitsToClear A bitwise value that indicates the bit or bits to clear.
 384  * For example, to clear bit 3 only, set uxBitsToClear to 0x08.  To clear bit 3
 385  * and bit 0 set uxBitsToClear to 0x09.
 386  *
 387  * @return If the request to execute the function was posted successfully then
 388  * pdPASS is returned, otherwise pdFALSE is returned.  pdFALSE will be returned
 389  * if the timer service queue was full.
 390  *
 391  * Example usage:
 392  * @code{c}
 393  * #define BIT_0 ( 1 << 0 )
 394  * #define BIT_4 ( 1 << 4 )
 395  *
 396  * // An event group which it is assumed has already been created by a call to
 397  * // xEventGroupCreate().
 398  * EventGroupHandle_t xEventGroup;
 399  *
 400  * void anInterruptHandler( void )
 401  * {
 402  *      // Clear bit 0 and bit 4 in xEventGroup.
 403  *      xResult = xEventGroupClearBitsFromISR(
 404  *                          xEventGroup,     // The event group being updated.
 405  *                          BIT_0 | BIT_4 ); // The bits being set.
 406  *
 407  *      if( xResult == pdPASS )
 408  *      {
 409  *          // The message was posted successfully.
 410  *      }
 411  * }
 412  * @endcode
 413  * \defgroup xEventGroupClearBitsFromISR xEventGroupClearBitsFromISR
 414  * \ingroup EventGroup
 415  */
 416 #if ( configUSE_TRACE_FACILITY == 1 )
 417     BaseType_t xEventGroupClearBitsFromISR( EventGroupHandle_t xEventGroup,
 418                                             const EventBits_t uxBitsToClear ) PRIVILEGED_FUNCTION;
 419 #else
 420     #define xEventGroupClearBitsFromISR( xEventGroup, uxBitsToClear ) \
 421     xTimerPendFunctionCallFromISR( vEventGroupClearBitsCallback, ( void * ) xEventGroup, ( uint32_t ) uxBitsToClear, NULL )
 422 #endif
 423
 424 /**
 425  * event_groups.h
 426  * @code{c}
 427  *  EventBits_t xEventGroupSetBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet );
 428  * @endcode
 429  *
 430  * Set bits within an event group.
 431  * This function cannot be called from an interrupt.  xEventGroupSetBitsFromISR()
 432  * is a version that can be called from an interrupt.
 433  *
 434  * Setting bits in an event group will automatically unblock tasks that are
 435  * blocked waiting for the bits.
 436  *
 437  * @param xEventGroup The event group in which the bits are to be set.
 438  *
 439  * @param uxBitsToSet A bitwise value that indicates the bit or bits to set.
 440  * For example, to set bit 3 only, set uxBitsToSet to 0x08.  To set bit 3
 441  * and bit 0 set uxBitsToSet to 0x09.
 442  *
 443  * @return The value of the event group at the time the call to
 444  * xEventGroupSetBits() returns.  There are two reasons why the returned value
 445  * might have the bits specified by the uxBitsToSet parameter cleared.  First,
 446  * if setting a bit results in a task that was waiting for the bit leaving the
 447  * blocked state then it is possible the bit will be cleared automatically
 448  * (see the xClearBitOnExit parameter of xEventGroupWaitBits()).  Second, any
 449  * unblocked (or otherwise Ready state) task that has a priority above that of
 450  * the task that called xEventGroupSetBits() will execute and may change the
 451  * event group value before the call to xEventGroupSetBits() returns.
 452  *
 453  * Example usage:
 454  * @code{c}
 455  * #define BIT_0 ( 1 << 0 )
 456  * #define BIT_4 ( 1 << 4 )
 457  *
 458  * void aFunction( EventGroupHandle_t xEventGroup )
 459  * {
 460  * EventBits_t uxBits;
 461  *
 462  *      // Set bit 0 and bit 4 in xEventGroup.
 463  *      uxBits = xEventGroupSetBits(
 464  *                          xEventGroup,    // The event group being updated.
 465  *                          BIT_0 | BIT_4 );// The bits being set.
 466  *
 467  *      if( ( uxBits & ( BIT_0 | BIT_4 ) ) == ( BIT_0 | BIT_4 ) )
 468  *      {
 469  *          // Both bit 0 and bit 4 remained set when the function returned.
 470  *      }
 471  *      else if( ( uxBits & BIT_0 ) != 0 )
 472  *      {
 473  *          // Bit 0 remained set when the function returned, but bit 4 was
 474  *          // cleared.  It might be that bit 4 was cleared automatically as a
 475  *          // task that was waiting for bit 4 was removed from the Blocked
 476  *          // state.
 477  *      }
 478  *      else if( ( uxBits & BIT_4 ) != 0 )
 479  *      {
 480  *          // Bit 4 remained set when the function returned, but bit 0 was
 481  *          // cleared.  It might be that bit 0 was cleared automatically as a
 482  *          // task that was waiting for bit 0 was removed from the Blocked
 483  *          // state.
 484  *      }
 485  *      else
 486  *      {
 487  *          // Neither bit 0 nor bit 4 remained set.  It might be that a task
 488  *          // was waiting for both of the bits to be set, and the bits were
 489  *          // cleared as the task left the Blocked state.
 490  *      }
 491  * }
 492  * @endcode
 493  * \defgroup xEventGroupSetBits xEventGroupSetBits
 494  * \ingroup EventGroup
 495  */
 496 EventBits_t xEventGroupSetBits( EventGroupHandle_t xEventGroup,
 497                                 const EventBits_t uxBitsToSet ) PRIVILEGED_FUNCTION;
 498
 499 /**
 500  * event_groups.h
 501  * @code{c}
 502  *  BaseType_t xEventGroupSetBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet, BaseType_t *pxHigherPriorityTaskWoken );
 503  * @endcode
 504  *
 505  * A version of xEventGroupSetBits() that can be called from an interrupt.
 506  *
 507  * Setting bits in an event group is not a deterministic operation because there
 508  * are an unknown number of tasks that may be waiting for the bit or bits being
 509  * set.  FreeRTOS does not allow nondeterministic operations to be performed in
 510  * interrupts or from critical sections.  Therefore xEventGroupSetBitsFromISR()
 511  * sends a message to the timer task to have the set operation performed in the
 512  * context of the timer task - where a scheduler lock is used in place of a
 513  * critical section.
 514  *
 515  * @param xEventGroup The event group in which the bits are to be set.
 516  *
 517  * @param uxBitsToSet A bitwise value that indicates the bit or bits to set.
 518  * For example, to set bit 3 only, set uxBitsToSet to 0x08.  To set bit 3
 519  * and bit 0 set uxBitsToSet to 0x09.
 520  *
 521  * @param pxHigherPriorityTaskWoken As mentioned above, calling this function
 522  * will result in a message being sent to the timer daemon task.  If the
 523  * priority of the timer daemon task is higher than the priority of the
 524  * currently running task (the task the interrupt interrupted) then
 525  * *pxHigherPriorityTaskWoken will be set to pdTRUE by
 526  * xEventGroupSetBitsFromISR(), indicating that a context switch should be
 527  * requested before the interrupt exits.  For that reason
 528  * *pxHigherPriorityTaskWoken must be initialised to pdFALSE.  See the
 529  * example code below.
 530  *
 531  * @return If the request to execute the function was posted successfully then
 532  * pdPASS is returned, otherwise pdFALSE is returned.  pdFALSE will be returned
 533  * if the timer service queue was full.
 534  *
 535  * Example usage:
 536  * @code{c}
 537  * #define BIT_0 ( 1 << 0 )
 538  * #define BIT_4 ( 1 << 4 )
 539  *
 540  * // An event group which it is assumed has already been created by a call to
 541  * // xEventGroupCreate().
 542  * EventGroupHandle_t xEventGroup;
 543  *
 544  * void anInterruptHandler( void )
 545  * {
 546  * BaseType_t xHigherPriorityTaskWoken, xResult;
 547  *
 548  *      // xHigherPriorityTaskWoken must be initialised to pdFALSE.
 549  *      xHigherPriorityTaskWoken = pdFALSE;
 550  *
 551  *      // Set bit 0 and bit 4 in xEventGroup.
 552  *      xResult = xEventGroupSetBitsFromISR(
 553  *                          xEventGroup,    // The event group being updated.
 554  *                          BIT_0 | BIT_4   // The bits being set.
 555  *                          &xHigherPriorityTaskWoken );
 556  *
 557  *      // Was the message posted successfully?
 558  *      if( xResult == pdPASS )
 559  *      {
 560  *          // If xHigherPriorityTaskWoken is now set to pdTRUE then a context
 561  *          // switch should be requested.  The macro used is port specific and
 562  *          // will be either portYIELD_FROM_ISR() or portEND_SWITCHING_ISR() -
 563  *          // refer to the documentation page for the port being used.
 564  *          portYIELD_FROM_ISR( xHigherPriorityTaskWoken );
 565  *      }
 566  * }
 567  * @endcode
 568  * \defgroup xEventGroupSetBitsFromISR xEventGroupSetBitsFromISR
 569  * \ingroup EventGroup
 570  */
 571 #if ( configUSE_TRACE_FACILITY == 1 )
 572     BaseType_t xEventGroupSetBitsFromISR( EventGroupHandle_t xEventGroup,
 573                                           const EventBits_t uxBitsToSet,
 574                                           BaseType_t * pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;
 575 #else
 576     #define xEventGroupSetBitsFromISR( xEventGroup, uxBitsToSet, pxHigherPriorityTaskWoken ) \
 577     xTimerPendFunctionCallFromISR( vEventGroupSetBitsCallback, ( void * ) xEventGroup, ( uint32_t ) uxBitsToSet, pxHigherPriorityTaskWoken )
 578 #endif
 579
 580 /**
 581  * event_groups.h
 582  * @code{c}
 583  *  EventBits_t xEventGroupSync(    EventGroupHandle_t xEventGroup,
 584  *                                  const EventBits_t uxBitsToSet,
 585  *                                  const EventBits_t uxBitsToWaitFor,
 586  *                                  TickType_t xTicksToWait );
 587  * @endcode
 588  *
 589  * Atomically set bits within an event group, then wait for a combination of
 590  * bits to be set within the same event group.  This functionality is typically
 591  * used to synchronise multiple tasks, where each task has to wait for the other
 592  * tasks to reach a synchronisation point before proceeding.
 593  *
 594  * This function cannot be used from an interrupt.
 595  *
 596  * The function will return before its block time expires if the bits specified
 597  * by the uxBitsToWait parameter are set, or become set within that time.  In
 598  * this case all the bits specified by uxBitsToWait will be automatically
 599  * cleared before the function returns.
 600  *
 601  * @param xEventGroup The event group in which the bits are being tested.  The
 602  * event group must have previously been created using a call to
 603  * xEventGroupCreate().
 604  *
 605  * @param uxBitsToSet The bits to set in the event group before determining
 606  * if, and possibly waiting for, all the bits specified by the uxBitsToWait
 607  * parameter are set.
 608  *
 609  * @param uxBitsToWaitFor A bitwise value that indicates the bit or bits to test
 610  * inside the event group.  For example, to wait for bit 0 and bit 2 set
 611  * uxBitsToWaitFor to 0x05.  To wait for bits 0 and bit 1 and bit 2 set
 612  * uxBitsToWaitFor to 0x07.  Etc.
 613  *
 614  * @param xTicksToWait The maximum amount of time (specified in 'ticks') to wait
 615  * for all of the bits specified by uxBitsToWaitFor to become set.
 616  *
 617  * @return The value of the event group at the time either the bits being waited
 618  * for became set, or the block time expired.  Test the return value to know
 619  * which bits were set.  If xEventGroupSync() returned because its timeout
 620  * expired then not all the bits being waited for will be set.  If
 621  * xEventGroupSync() returned because all the bits it was waiting for were
 622  * set then the returned value is the event group value before any bits were
 623  * automatically cleared.
 624  *
 625  * Example usage:
 626  * @code{c}
 627  * // Bits used by the three tasks.
 628  * #define TASK_0_BIT     ( 1 << 0 )
 629  * #define TASK_1_BIT     ( 1 << 1 )
 630  * #define TASK_2_BIT     ( 1 << 2 )
 631  *
 632  * #define ALL_SYNC_BITS ( TASK_0_BIT | TASK_1_BIT | TASK_2_BIT )
 633  *
 634  * // Use an event group to synchronise three tasks.  It is assumed this event
 635  * // group has already been created elsewhere.
 636  * EventGroupHandle_t xEventBits;
 637  *
 638  * void vTask0( void *pvParameters )
 639  * {
 640  * EventBits_t uxReturn;
 641  * TickType_t xTicksToWait = 100 / portTICK_PERIOD_MS;
 642  *
 643  *   for( ;; )
 644  *   {
 645  *      // Perform task functionality here.
 646  *
 647  *      // Set bit 0 in the event flag to note this task has reached the
 648  *      // sync point.  The other two tasks will set the other two bits defined
 649  *      // by ALL_SYNC_BITS.  All three tasks have reached the synchronisation
 650  *      // point when all the ALL_SYNC_BITS are set.  Wait a maximum of 100ms
 651  *      // for this to happen.
 652  *      uxReturn = xEventGroupSync( xEventBits, TASK_0_BIT, ALL_SYNC_BITS, xTicksToWait );
 653  *
 654  *      if( ( uxReturn & ALL_SYNC_BITS ) == ALL_SYNC_BITS )
 655  *      {
 656  *          // All three tasks reached the synchronisation point before the call
 657  *          // to xEventGroupSync() timed out.
 658  *      }
 659  *  }
 660  * }
 661  *
 662  * void vTask1( void *pvParameters )
 663  * {
 664  *   for( ;; )
 665  *   {
 666  *      // Perform task functionality here.
 667  *
 668  *      // Set bit 1 in the event flag to note this task has reached the
 669  *      // synchronisation point.  The other two tasks will set the other two
 670  *      // bits defined by ALL_SYNC_BITS.  All three tasks have reached the
 671  *      // synchronisation point when all the ALL_SYNC_BITS are set.  Wait
 672  *      // indefinitely for this to happen.
 673  *      xEventGroupSync( xEventBits, TASK_1_BIT, ALL_SYNC_BITS, portMAX_DELAY );
 674  *
 675  *      // xEventGroupSync() was called with an indefinite block time, so
 676  *      // this task will only reach here if the synchronisation was made by all
 677  *      // three tasks, so there is no need to test the return value.
 678  *   }
 679  * }
 680  *
 681  * void vTask2( void *pvParameters )
 682  * {
 683  *   for( ;; )
 684  *   {
 685  *      // Perform task functionality here.
 686  *
 687  *      // Set bit 2 in the event flag to note this task has reached the
 688  *      // synchronisation point.  The other two tasks will set the other two
 689  *      // bits defined by ALL_SYNC_BITS.  All three tasks have reached the
 690  *      // synchronisation point when all the ALL_SYNC_BITS are set.  Wait
 691  *      // indefinitely for this to happen.
 692  *      xEventGroupSync( xEventBits, TASK_2_BIT, ALL_SYNC_BITS, portMAX_DELAY );
 693  *
 694  *      // xEventGroupSync() was called with an indefinite block time, so
 695  *      // this task will only reach here if the synchronisation was made by all
 696  *      // three tasks, so there is no need to test the return value.
 697  *  }
 698  * }
 699  *
 700  * @endcode
 701  * \defgroup xEventGroupSync xEventGroupSync
 702  * \ingroup EventGroup
 703  */
 704 EventBits_t xEventGroupSync( EventGroupHandle_t xEventGroup,
 705                              const EventBits_t uxBitsToSet,
 706                              const EventBits_t uxBitsToWaitFor,
 707                              TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;
 708
 709
 710 /**
 711  * event_groups.h
 712  * @code{c}
 713  *  EventBits_t xEventGroupGetBits( EventGroupHandle_t xEventGroup );
 714  * @endcode
 715  *
 716  * Returns the current value of the bits in an event group.  This function
 717  * cannot be used from an interrupt.
 718  *
 719  * @param xEventGroup The event group being queried.
 720  *
 721  * @return The event group bits at the time xEventGroupGetBits() was called.
 722  *
 723  * \defgroup xEventGroupGetBits xEventGroupGetBits
 724  * \ingroup EventGroup
 725  */
 726 #define xEventGroupGetBits( xEventGroup )    xEventGroupClearBits( xEventGroup, 0 )
 727
 728 /**
 729  * event_groups.h
 730  * @code{c}
 731  *  EventBits_t xEventGroupGetBitsFromISR( EventGroupHandle_t xEventGroup );
 732  * @endcode
 733  *
 734  * A version of xEventGroupGetBits() that can be called from an ISR.
 735  *
 736  * @param xEventGroup The event group being queried.
 737  *
 738  * @return The event group bits at the time xEventGroupGetBitsFromISR() was called.
 739  *
 740  * \defgroup xEventGroupGetBitsFromISR xEventGroupGetBitsFromISR
 741  * \ingroup EventGroup
 742  */
 743 EventBits_t xEventGroupGetBitsFromISR( EventGroupHandle_t xEventGroup ) PRIVILEGED_FUNCTION;
 744
 745 /**
 746  * event_groups.h
 747  * @code{c}
 748  *  void xEventGroupDelete( EventGroupHandle_t xEventGroup );
 749  * @endcode
 750  *
 751  * Delete an event group that was previously created by a call to
 752  * xEventGroupCreate().  Tasks that are blocked on the event group will be
 753  * unblocked and obtain 0 as the event group's value.
 754  *
 755  * @param xEventGroup The event group being deleted.
 756  */
 757 void vEventGroupDelete( EventGroupHandle_t xEventGroup ) PRIVILEGED_FUNCTION;
 758
 759 /* For internal use only. */
 760 void vEventGroupSetBitsCallback( void * pvEventGroup,
 761                                  const uint32_t ulBitsToSet ) PRIVILEGED_FUNCTION;
 762 void vEventGroupClearBitsCallback( void * pvEventGroup,
 763                                    const uint32_t ulBitsToClear ) PRIVILEGED_FUNCTION;
 764
 765
 766 #if ( configUSE_TRACE_FACILITY == 1 )
 767     UBaseType_t uxEventGroupGetNumber( void * xEventGroup ) PRIVILEGED_FUNCTION;
 768     void vEventGroupSetNumber( void * xEventGroup,
 769                                UBaseType_t uxEventGroupNumber ) PRIVILEGED_FUNCTION;
 770 #endif
 771
 772 /* *INDENT-OFF* */
 773 #ifdef __cplusplus
 774     }
 775 #endif
 776 /* *INDENT-ON* */
 777
 778 #endif /* EVENT_GROUPS_H */