X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=FreeRTOS%2FSource%2Finclude%2Ftask.h;h=2a16adbcf1beb92a79cc8f5fb4d741f065a7b7e1;hb=5f44200b88f5a6ec99f3bdcc7479308b3b90f1be;hp=fa7a85a10a21de788b9ea7b8c462bacc9c0dbbf5;hpb=d77fac87c3796fb1b4ebe959c8f776f5c6bc05b8;p=freertos

diff --git a/FreeRTOS/Source/include/task.h b/FreeRTOS/Source/include/task.h
index fa7a85a10..2a16adbcf 100644
--- a/FreeRTOS/Source/include/task.h
+++ b/FreeRTOS/Source/include/task.h
@@ -67,8 +67,8 @@
     Integrity Systems, who sell the code with commercial support,
     indemnification and middleware, under the OpenRTOS brand.
 
-    http://www.SafeRTOS.com - High Integrity Systems also provide a safety 
-    engineered and independently SIL3 certified version for use in safety and 
+    http://www.SafeRTOS.com - High Integrity Systems also provide a safety
+    engineered and independently SIL3 certified version for use in safety and
     mission critical applications that require provable dependability.
 */
 
@@ -1210,9 +1210,14 @@ xTaskHandle xTaskGetIdleTaskHandle( void );
  * Called from the real time kernel tick (either preemptive or cooperative),
  * this increments the tick count and checks if any tasks that are blocked
  * for a finite period required removing from a blocked list and placing on
- * a ready list.
+ * a ready list.  If a non-zero value is returned then a context switch is
+ * required because either:
+ *   + A task was removed from a blocked list because its timeout had expired,
+ *     or
+ *   + Time slicing is in use and there is a task of equal priority to the
+ *     currently running task.
  */
-void vTaskIncrementTick( void ) PRIVILEGED_FUNCTION;
+portBASE_TYPE xTaskIncrementTick( void ) PRIVILEGED_FUNCTION;
 
 /*
  * THIS FUNCTION MUST NOT BE USED FROM APPLICATION CODE.  IT IS AN