Skip to content

Commit

Permalink
freertos: Update the docuementation of the ulBitsToClearOnEntry param…
Browse files Browse the repository at this point in the history
…eter in xTaskGenericNotifyWait() function.

Closes #7207

The description of how the xTaskGenericNotifyWait parameter is handled in the
xTaskGenericNotifyWait() function was inaccurate.

In this commit, the description was updated to match the implementation of xTaskGenericNotifyWait().
  • Loading branch information
SoucheSouche committed Aug 19, 2022
1 parent 91e6b5d commit c6aa092
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions components/freertos/include/freertos/task.h
Original file line number Diff line number Diff line change
Expand Up @@ -2655,12 +2655,13 @@ BaseType_t xTaskGenericNotifyFromISR( TaskHandle_t xTaskToNotify,
* not have this parameter and always waits for notifications on index 0.
*
* @param ulBitsToClearOnEntry Bits that are set in ulBitsToClearOnEntry value
* will be cleared in the calling task's notification value before the task
* checks to see if any notifications are pending, and optionally blocks if no
* notifications are pending. Setting ulBitsToClearOnEntry to ULONG_MAX (if
* limits.h is included) or 0xffffffffUL (if limits.h is not included) will have
* the effect of resetting the task's notification value to 0. Setting
* ulBitsToClearOnEntry to 0 will leave the task's notification value unchanged.
* will be cleared in the calling task's notification value before the task is
* marked as waiting for a new notification (provided a notification is not
* already pending). Optionally blocks if no notifications are pending. Setting
* ulBitsToClearOnEntry to ULONG_MAX (if limits.h is included) or 0xffffffffUL
* (if limits.h is not included) will have the effect of resetting the task's
* notification value to 0. Setting ulBitsToClearOnEntry to 0 will leave the
* task's notification value unchanged.
*
* @param ulBitsToClearOnExit If a notification is pending or received before
* the calling task exits the xTaskNotifyWait() function then the task's
Expand Down

0 comments on commit c6aa092

Please sign in to comment.