Map portTICK_RATE_MS to portTICK_PERIOD_MS.

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

diff --git a/FreeRTOS/Source/include/task.h b/FreeRTOS/Source/include/task.h
index b09c64a3592c5990d46f57342efe420a97d5a35a..39de192f510cead4d71f2a00ab9985a55f0a1d04 100644 (file)
--- a/FreeRTOS/Source/include/task.h
+++ b/FreeRTOS/Source/include/task.h
@@ -494,7 +494,7 @@ void vTaskDelete( TaskHandle_t xTaskToDelete ) PRIVILEGED_FUNCTION;
  *\r
  * Delay a task for a given number of ticks.  The actual time that the\r
  * task remains blocked depends on the tick rate.  The constant\r
- * portTICK_RATE_MS can be used to calculate real time from the tick\r
+ * portTICK_PERIOD_MS can be used to calculate real time from the tick\r
  * rate - with the resolution of one tick period.\r
  *\r
  * INCLUDE_vTaskDelay must be defined as 1 for this function to be available.\r
@@ -521,7 +521,7 @@ void vTaskDelete( TaskHandle_t xTaskToDelete ) PRIVILEGED_FUNCTION;
  void vTaskFunction( void * pvParameters )\r
  {\r
  // Block for 500ms.\r
- const TickType_t xDelay = 500 / portTICK_RATE_MS;\r
+ const TickType_t xDelay = 500 / portTICK_PERIOD_MS;\r
 \r
         for( ;; )\r
         {\r
@@ -558,7 +558,7 @@ void vTaskDelay( const TickType_t xTicksToDelay ) PRIVILEGED_FUNCTION;
  * is called, vTaskDelayUntil () specifies the absolute (exact) time at which it wishes to\r
  * unblock.\r
  *\r
- * The constant portTICK_RATE_MS can be used to calculate real time from the tick\r
+ * The constant portTICK_PERIOD_MS can be used to calculate real time from the tick\r
  * rate - with the resolution of one tick period.\r
  *\r
  * @param pxPreviousWakeTime Pointer to a variable that holds the time at which the\r
@@ -1415,7 +1415,7 @@ BaseType_t xTaskIncrementTick( void ) PRIVILEGED_FUNCTION;
  *\r
  * @param xTicksToWait The maximum amount of time that the task should wait\r
  * for the event to occur.  This is specified in kernel ticks,the constant\r
- * portTICK_RATE_MS can be used to convert kernel ticks into a real time\r
+ * portTICK_PERIOD_MS can be used to convert kernel ticks into a real time\r
  * period.\r
  */\r
 void vTaskPlaceOnEventList( List_t * const pxEventList, const TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r