summaryrefslogtreecommitdiffstats
path: root/cpukit/score/include/rtems/score/todimpl.h
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2015-07-28 14:45:42 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2015-07-28 14:54:51 +0200
commit21789a2117f7485000e0d88c3f76a6b9d507bb5a (patch)
treef14a8eee3d9c10fd673c43f55f7a50d9b5b58b05 /cpukit/score/include/rtems/score/todimpl.h
parentm68k: Include proper header file (diff)
downloadrtems-21789a2117f7485000e0d88c3f76a6b9d507bb5a.tar.bz2
score: Rename _POSIX_Absolute_timeout_to_ticks()
Rename _POSIX_Absolute_timeout_to_ticks() to _TOD_Absolute_timeout_to_ticks() and move it to the score directory. Delete empty <rtems/posix/time.h>.
Diffstat (limited to 'cpukit/score/include/rtems/score/todimpl.h')
-rw-r--r--cpukit/score/include/rtems/score/todimpl.h39
1 files changed, 39 insertions, 0 deletions
diff --git a/cpukit/score/include/rtems/score/todimpl.h b/cpukit/score/include/rtems/score/todimpl.h
index 56c176d920..a94b140d92 100644
--- a/cpukit/score/include/rtems/score/todimpl.h
+++ b/cpukit/score/include/rtems/score/todimpl.h
@@ -21,6 +21,7 @@
#include <rtems/score/tod.h>
#include <rtems/score/timestamp.h>
#include <rtems/score/timecounterimpl.h>
+#include <rtems/score/watchdog.h>
#include <sys/time.h>
#include <time.h>
@@ -339,6 +340,44 @@ RTEMS_INLINE_ROUTINE bool _TOD_Is_set( void )
return _TOD.is_set;
}
+/**
+ * @brief Absolute timeout conversion results.
+ *
+ * This enumeration defines the possible results of converting
+ * an absolute time used for timeouts to POSIX blocking calls to
+ * a number of ticks for example.
+ */
+typedef enum {
+ /** The timeout is invalid. */
+ TOD_ABSOLUTE_TIMEOUT_INVALID,
+ /** The timeout represents a time that is in the past. */
+ TOD_ABSOLUTE_TIMEOUT_IS_IN_PAST,
+ /** The timeout represents a time that is equal to the current time. */
+ TOD_ABSOLUTE_TIMEOUT_IS_NOW,
+ /** The timeout represents a time that is in the future. */
+ TOD_ABSOLUTE_TIMEOUT_IS_IN_FUTURE,
+} TOD_Absolute_timeout_conversion_results;
+
+/**
+ * @brief Convert absolute timeout to ticks.
+ *
+ * This method takes an absolute time being used as a timeout
+ * to a blocking directive, validates it and returns the number
+ * of corresponding clock ticks for use by the SuperCore.
+ *
+ * @param[in] abstime is a pointer to the timeout
+ * @param[out] ticks_out will contain the number of ticks
+ *
+ * @return This method returns the number of ticks in @a ticks_out
+ * and a status value indicating whether the absolute time
+ * is valid, in the past, equal to the current time or in
+ * the future as it should be.
+ */
+TOD_Absolute_timeout_conversion_results _TOD_Absolute_timeout_to_ticks(
+ const struct timespec *abstime,
+ Watchdog_Interval *ticks_out
+);
+
/**@}*/
#ifdef __cplusplus