Map portTICK_RATE_MS to portTICK_PERIOD_MS.

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

diff --git a/FreeRTOS/Source/include/timers.h b/FreeRTOS/Source/include/timers.h
index 6ef9d91bbb0eac6924abaa36de5a736623dfd5e9..7c8a9cd7bc744c12be788ea6414bb826024af819 100644 (file)
--- a/FreeRTOS/Source/include/timers.h
+++ b/FreeRTOS/Source/include/timers.h
@@ -133,11 +133,11 @@ typedef void (*PendedFunction_t)( void *, uint32_t );
  * by its handle, and never by its name.\r
  *\r
  * @param xTimerPeriodInTicks The timer period.  The time is defined in tick\r
- * periods so the constant portTICK_RATE_MS can be used to convert a time that\r
+ * periods so the constant portTICK_PERIOD_MS can be used to convert a time that\r
  * has been specified in milliseconds.  For example, if the timer must expire\r
  * after 100 ticks, then xTimerPeriodInTicks should be set to 100.\r
  * Alternatively, if the timer must expire after 500ms, then xPeriod can be set\r
- * to ( 500 / portTICK_RATE_MS ) provided configTICK_RATE_HZ is less than or\r
+ * to ( 500 / portTICK_PERIOD_MS ) provided configTICK_RATE_HZ is less than or\r
  * equal to 1000.\r
  *\r
  * @param uxAutoReload If uxAutoReload is set to pdTRUE then the timer will\r
@@ -431,11 +431,11 @@ TaskHandle_t xTimerGetTimerDaemonTaskHandle( void );
  * @param xTimer The handle of the timer that is having its period changed.\r
  *\r
  * @param xNewPeriod The new period for xTimer. Timer periods are specified in\r
- * tick periods, so the constant portTICK_RATE_MS can be used to convert a time\r
+ * tick periods, so the constant portTICK_PERIOD_MS can be used to convert a time\r
  * that has been specified in milliseconds.  For example, if the timer must\r
  * expire after 100 ticks, then xNewPeriod should be set to 100.  Alternatively,\r
  * if the timer must expire after 500ms, then xNewPeriod can be set to\r
- * ( 500 / portTICK_RATE_MS ) provided configTICK_RATE_HZ is less than\r
+ * ( 500 / portTICK_PERIOD_MS ) provided configTICK_RATE_HZ is less than\r
  * or equal to 1000.\r
  *\r
  * @param xBlockTime Specifies the time, in ticks, that the calling task should\r
@@ -472,7 +472,7 @@ TaskHandle_t xTimerGetTimerDaemonTaskHandle( void );
  *         // cause the timer to start.  Block for a maximum of 100 ticks if the\r
  *         // change period command cannot immediately be sent to the timer\r
  *         // command queue.\r
- *         if( xTimerChangePeriod( xTimer, 500 / portTICK_RATE_MS, 100 ) == pdPASS )\r
+ *         if( xTimerChangePeriod( xTimer, 500 / portTICK_PERIOD_MS, 100 ) == pdPASS )\r
  *         {\r
  *             // The command was successfully sent.\r
  *         }\r
@@ -613,7 +613,7 @@ TaskHandle_t xTimerGetTimerDaemonTaskHandle( void );
  *     // Create then start the one-shot timer that is responsible for turning\r
  *     // the back-light off if no keys are pressed within a 5 second period.\r
  *     xBacklightTimer = xTimerCreate( "BacklightTimer",           // Just a text name, not used by the kernel.\r
- *                                     ( 5000 / portTICK_RATE_MS), // The timer period in ticks.\r
+ *                                     ( 5000 / portTICK_PERIOD_MS), // The timer period in ticks.\r
  *                                     pdFALSE,                    // The timer is a one-shot timer.\r
  *                                     0,                          // The id is not used by the callback so can take any value.\r
  *                                     vBacklightTimerCallback     // The callback function that switches the LCD back-light off.\r
@@ -809,11 +809,11 @@ TaskHandle_t xTimerGetTimerDaemonTaskHandle( void );
  * @param xTimer The handle of the timer that is having its period changed.\r
  *\r
  * @param xNewPeriod The new period for xTimer. Timer periods are specified in\r
- * tick periods, so the constant portTICK_RATE_MS can be used to convert a time\r
+ * tick periods, so the constant portTICK_PERIOD_MS can be used to convert a time\r
  * that has been specified in milliseconds.  For example, if the timer must\r
  * expire after 100 ticks, then xNewPeriod should be set to 100.  Alternatively,\r
  * if the timer must expire after 500ms, then xNewPeriod can be set to\r
- * ( 500 / portTICK_RATE_MS ) provided configTICK_RATE_HZ is less than\r
+ * ( 500 / portTICK_PERIOD_MS ) provided configTICK_RATE_HZ is less than\r
  * or equal to 1000.\r
  *\r
  * @param pxHigherPriorityTaskWoken The timer service/daemon task spends most\r