kopia lustrzana https://github.com/espressif/esp-idf
freertos: Update the docuementation of the ulBitsToClearOnEntry parameter in xTaskGenericNotifyWait() function.
Closes https://github.com/espressif/esp-idf/issues/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().pull/9485/head
rodzic
3f161b9c98
commit
421a408b42
|
@ -2656,12 +2656,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
|
||||||
|
|
Ładowanie…
Reference in New Issue