Added time conversions to RT counter code. Documentation improvements.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@3728 35acf78f-673a-0410-8e92-d51de3d6d3f4

1 files changed, 15 insertions, 0 deletions

diff --git a/os/kernel/include/chvt.h b/os/kernel/include/chvt.h
index 0038e3d0a..e74a7f713 100644
--- a/os/kernel/include/chvt.h
+++ b/os/kernel/include/chvt.h
@@ -37,6 +37,11 @@
  * @brief   Seconds to system ticks.

  * @details Converts from seconds to system ticks number.

  * @note    The result is rounded upward to the next tick boundary.

+ *

+ * @param[in] sec       number of seconds

+ * @return              The number of ticks.

+ *

+ * @api

  */

 #define S2ST(sec)   ((systime_t)((sec) * CH_FREQUENCY))

 

@@ -44,6 +49,11 @@
  * @brief   Milliseconds t0 system ticks.

  * @details Converts from milliseconds to system ticks number.

  * @note    The result is rounded upward to the next tick boundary.

+ *

+ * @param[in] msec      number of milliseconds

+ * @return              The number of ticks.

+ *

+ * @api

  */

 #define MS2ST(msec) ((systime_t)(((((msec) - 1L) * CH_FREQUENCY) / 1000L) + 1L))

 

@@ -51,6 +61,11 @@
  * @brief   Microseconds to system ticks.

  * @details Converts from microseconds to system ticks number.

  * @note    The result is rounded upward to the next tick boundary.

+ *

+ * @param[in] usec      number of microseconds

+ * @return              The number of ticks.

+ *

+ * @api

  */

 #define US2ST(usec) ((systime_t)(((((usec) - 1L) * CH_FREQUENCY) / 1000000L) + 1L))

 /** @} */