+ Moved the History.txt file from the website git repo into the source code SVN repo.

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

diff --git a/FreeRTOS/Source/include/task.h b/FreeRTOS/Source/include/task.h
index 3a57726526fd22f41c2e59ea5560b1800b39b26f..b4e246fb9bddcfbbe0ea9e034d35325b65601aa7 100644 (file)
--- a/FreeRTOS/Source/include/task.h
+++ b/FreeRTOS/Source/include/task.h
@@ -1738,7 +1738,7 @@ void vTaskGetRunTimeStats( char *pcWriteBuffer ) PRIVILEGED_FUNCTION; /*lint !e9
 \r
 /**\r
 * task. h\r
-* <PRE>TickType_t xTaskGetIdleRunTimeCounter( void );</PRE>\r
+* <PRE>uint32_t ulTaskGetIdleRunTimeCounter( void );</PRE>\r
 *\r
 * configGENERATE_RUN_TIME_STATS and configUSE_STATS_FORMATTING_FUNCTIONS\r
 * must both be defined as 1 for this function to be available.  The application\r
@@ -1753,7 +1753,7 @@ void vTaskGetRunTimeStats( char *pcWriteBuffer ) PRIVILEGED_FUNCTION; /*lint !e9
 * of the accumulated time value depends on the frequency of the timer\r
 * configured by the portCONFIGURE_TIMER_FOR_RUN_TIME_STATS() macro.\r
 * While uxTaskGetSystemState() and vTaskGetRunTimeStats() writes the total\r
-* execution time of each task into a buffer, xTaskGetIdleRunTimeCounter()\r
+* execution time of each task into a buffer, ulTaskGetIdleRunTimeCounter()\r
 * returns the total execution time of just the idle task.\r
 *\r
 * @return The total run time of the idle task.  This is the amount of time the\r
@@ -1761,10 +1761,10 @@ void vTaskGetRunTimeStats( char *pcWriteBuffer ) PRIVILEGED_FUNCTION; /*lint !e9
 * frequency configured using the portCONFIGURE_TIMER_FOR_RUN_TIME_STATS() and\r
 * portGET_RUN_TIME_COUNTER_VALUE() macros.\r
 *\r
-* \defgroup xTaskGetIdleRunTimeCounter xTaskGetIdleRunTimeCounter\r
+* \defgroup ulTaskGetIdleRunTimeCounter ulTaskGetIdleRunTimeCounter\r
 * \ingroup TaskUtils\r
 */\r
-TickType_t xTaskGetIdleRunTimeCounter( void ) PRIVILEGED_FUNCTION;\r
+uint32_t ulTaskGetIdleRunTimeCounter( void ) PRIVILEGED_FUNCTION;\r
 \r
 /**\r
  * task. h\r
@@ -2383,6 +2383,19 @@ void vTaskSetTaskNumber( TaskHandle_t xTask, const UBaseType_t uxHandle ) PRIVIL
  */\r
 void vTaskStepTick( const TickType_t xTicksToJump ) PRIVILEGED_FUNCTION;\r
 \r
+/* Correct the tick count value after the application code has held\r
+interrupts disabled for an extended period.  xTicksToCatchUp is the number\r
+of tick interrupts that have been missed due to interrupts being disabled.\r
+Its value is not computed automatically, so must be computed by the\r
+application writer.\r
+\r
+This function is similar to vTaskStepTick(), however, unlike\r
+vTaskStepTick(), xTaskCatchUpTicks() may move the tick count forward past a\r
+time at which a task should be removed from the blocked state.  That means\r
+tasks may have to be removed from the blocked state as the tick count is\r
+moved. */\r
+BaseType_t xTaskCatchUpTicks( TickType_t xTicksToCatchUp ) PRIVILEGED_FUNCTION;\r
+\r
 /*\r
  * Only available when configUSE_TICKLESS_IDLE is set to 1.\r
  * Provided for use within portSUPPRESS_TICKS_AND_SLEEP() to allow the port\r