espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-02 20:24:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'bugfix/update-doc-freertos-task-header_v4.4' into 'release/v4.4'

Browse Source 
freertos: Update the documentation of the ulBitsToClearOnEntry parameter (v4.4)

See merge request espressif/esp-idf!19661
This commit is contained in:
Zim Kalinowski
2022-08-19 21:04:47 +08:00
parent 4851e0b9ca c6aa0928ab
commit 4bb3ebd6e5
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
components/freertos/include/freertos/task.h
View File

@@ -2655,12 +2655,13 @@ BaseType_t xTaskGenericNotifyFromISR( TaskHandle_t xTaskToNotify,
* not have this parameter and always waits for notifications on index 0. * not have this parameter and always waits for notifications on index 0.
* *
* @param ulBitsToClearOnEntry Bits that are set in ulBitsToClearOnEntry value * @param ulBitsToClearOnEntry Bits that are set in ulBitsToClearOnEntry value
* will be cleared in the calling task's notification value before the task * will be cleared in the calling task's notification value before the task is
* checks to see if any notifications are pending, and optionally blocks if no * marked as waiting for a new notification (provided a notification is not
* notifications are pending. Setting ulBitsToClearOnEntry to ULONG_MAX (if * already pending). Optionally blocks if no notifications are pending. Setting
* limits.h is included) or 0xffffffffUL (if limits.h is not included) will have * ulBitsToClearOnEntry to ULONG_MAX (if limits.h is included) or 0xffffffffUL
* the effect of resetting the task's notification value to 0. Setting * (if limits.h is not included) will have the effect of resetting the task's
* ulBitsToClearOnEntry to 0 will leave the task's notification value unchanged. * 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 * @param ulBitsToClearOnExit If a notification is pending or received before
* the calling task exits the xTaskNotifyWait() function then the task's * the calling task exits the xTaskNotifyWait() function then the task's