Ensure queue functions go into the privileged code section when the MPU version is...

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

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