len0rd/FreeRTOS-Kernel
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2025-04-20 05:21:59 -04:00
Code Issues Packages Projects Releases Wiki Activity

fixed documentation for ulTaskNotifyTake() and ulTaskNotifyTakeIndexed() (#269)

Browse source
This commit is contained in:
Joseph Julicher 2021-03-03 10:38:12 -07:00 committed by GitHub
parent 4fde4a8d0a
commit 5e45472d6e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
include/task.h
View file

@ -1934,9 +1934,8 @@ uint32_t ulTaskGetIdleRunTimeCounter( void ) PRIVILEGED_FUNCTION;
* that way task notifications can be used to send data to a task, or be used as * that way task notifications can be used to send data to a task, or be used as
* light weight and fast binary or counting semaphores. * light weight and fast binary or counting semaphores.
* *
* A task can use xTaskNotifyWaitIndexed() to [optionally] block to wait for a * A task can use xTaskNotifyWaitIndexed() or ulTaskNotifyTakeIndexed() to
* notification to be pending, or ulTaskNotifyTakeIndexed() to [optionally] block * [optionally] block to wait for a notification to be pending. The task does
* to wait for a notification value to have a non-zero value. The task does
* not consume any CPU time while it is in the Blocked state. * not consume any CPU time while it is in the Blocked state.
* *
* A notification sent to a task will remain pending until it is cleared by the * A notification sent to a task will remain pending until it is cleared by the
@ -2522,8 +2521,8 @@ void vTaskGenericNotifyGiveFromISR( TaskHandle_t xTaskToNotify,
* value acts like a counting semaphore. * value acts like a counting semaphore.
* *
* A task can use ulTaskNotifyTakeIndexed() to [optionally] block to wait for * A task can use ulTaskNotifyTakeIndexed() to [optionally] block to wait for
* the task's notification value to be non-zero. The task does not consume any * a notification. The task does not consume any CPU time while it is in the
* CPU time while it is in the Blocked state. * Blocked state.
* *
* Where as xTaskNotifyWaitIndexed() will return when a notification is pending, * Where as xTaskNotifyWaitIndexed() will return when a notification is pending,
* ulTaskNotifyTakeIndexed() will return when the task's notification value is * ulTaskNotifyTakeIndexed() will return when the task's notification value is