Update libraries and sundry check-ins ready for the V10.3.0 kernel release.

[freertos] / FreeRTOS / Source / include / task.h

diff --git a/FreeRTOS/Source/include/task.h b/FreeRTOS/Source/include/task.h
index 40e1e533ddf8a7ff3e7be2ac3a0dcb8bfa35d4a5..62302f066745d47820d829f8a868493d5c3b5836 100644 (file)
--- a/FreeRTOS/Source/include/task.h
+++ b/FreeRTOS/Source/include/task.h
@@ -831,6 +831,11 @@ void vTaskDelayUntil( TickType_t * const pxPreviousWakeTime, const TickType_t xT
  * task will leave the Blocked state, and return from whichever function call\r
  * placed the task into the Blocked state.\r
  *\r
+ * There is no 'FromISR' version of this function as an interrupt would need to\r
+ * know which object a task was blocked on in order to know which actions to\r
+ * take.  For example, if the task was blocked on a queue the interrupt handler\r
+ * would then need to know if the queue was locked.\r
+ *\r
  * @param xTask The handle of the task to remove from the Blocked state.\r
  *\r
  * @return If the task referenced by xTask was not in the Blocked state then\r
@@ -841,39 +846,6 @@ void vTaskDelayUntil( TickType_t * const pxPreviousWakeTime, const TickType_t xT
  */\r
 BaseType_t xTaskAbortDelay( TaskHandle_t xTask ) PRIVILEGED_FUNCTION;\r
 \r
-/**\r
-* task. h\r
-* <pre>BaseType_t xTaskAbortDelayFromISR( TaskHandle_t xTask, BaseType_t * const pxHigherPriorityTaskWoken )</pre>\r
-*\r
-* INCLUDE_xTaskAbortDelay must be defined as 1 in FreeRTOSConfig.h for this\r
-* function to be available.\r
-*\r
-* A version of xTaskAbortDelay() that can be used from an interrupt service routine.\r
-*\r
-* A task will enter the Blocked state when it is waiting for an event.  The\r
-* event it is waiting for can be a temporal event (waiting for a time), such\r
-* as when vTaskDelay() is called, or an event on an object, such as when\r
-* xQueueReceive() or ulTaskNotifyTake() is called.  If the handle of a task\r
-* that is in the Blocked state is used in a call to xTaskAbortDelay() then the\r
-* task will leave the Blocked state, and return from whichever function call\r
-* placed the task into the Blocked state.\r
-*\r
-* @param xTask The handle of the task to remove from the Blocked state.\r
-*\r
-* @param pxHigherPriorityTaskWoken xTaskAbortDelayFromISR() will set\r
-* *pxHigherPriorityTaskWoken to pdTRUE if a task was removed from the Blocked state,\r
-* and the task that was removed from the Blocked state has a priority higher than the\r
-* currently running task.  If xTaskAbortDelayFromISR() sets this value to pdTRUE then\r
-* a context switch should be requested before the interrupt is exited.\r
-*\r
-* @return If the task referenced by xTask was not in the Blocked state then\r
-* pdFAIL is returned.  Otherwise pdPASS is returned.\r
-*\r
-* \defgroup xTaskAbortDelay xTaskAbortDelayFromISR\r
-* \ingroup TaskCtrl\r
-*/\r
-BaseType_t xTaskAbortDelayFromISR( TaskHandle_t xTask, BaseType_t * const pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
-\r
 /**\r
  * task. h\r
  * <pre>UBaseType_t uxTaskPriorityGet( const TaskHandle_t xTask );</pre>\r