diff options
Diffstat (limited to 'include/gtimer/gtimer.h')
| -rw-r--r-- | include/gtimer/gtimer.h | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/include/gtimer/gtimer.h b/include/gtimer/gtimer.h new file mode 100644 index 00000000..623120dc --- /dev/null +++ b/include/gtimer/gtimer.h @@ -0,0 +1,89 @@ +/*
+ ChibiOS/GFX - Copyright (C) 2012
+ Joel Bodenmann aka Tectu <joel@unormal.org>
+
+ This file is part of ChibiOS/GFX.
+
+ ChibiOS/GFX is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 3 of the License, or
+ (at your option) any later version.
+
+ ChibiOS/GFX is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+/**
+ * @file include/gtimer/gtimer.h
+ * @brief GTIMER GFX User Timer subsystem header file.
+ *
+ * @addtogroup GTIMER
+ * @{
+ */
+#ifndef _GTIMER_H
+#define _GTIMER_H
+
+#include "gfx.h"
+
+#if GFX_USE_GTIMER || defined(__DOXYGEN__)
+
+/*===========================================================================*/
+/* Type definitions */
+/*===========================================================================*/
+
+/**
+ * @brief Data part of a static GTimer initializer.
+ */
+#define _GTIMER_DATA() {0,0,0,0,0,0,0}
+
+/**
+ * @brief Static GTimer initializer.
+ */
+#define GTIMER_DECL(name) GTimer name = _GTIMER_DATA()
+
+/**
+ * @brief A callback function (executed in a thread context).
+ */
+typedef void (*GTimerFunction)(void *param);
+
+/**
+ * @brief A GTimer structure
+ */
+typedef struct GTimer_t {
+ GTimerFunction fn;
+ void *param;
+ systime_t when;
+ systime_t period;
+ uint16_t flags;
+ struct GTimer_t *next;
+ struct GTimer_t *prev;
+ } GTimer;
+
+/*===========================================================================*/
+/* External declarations. */
+/*===========================================================================*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+void gtimerInit(GTimer *pt);
+void gtimerStart(GTimer *pt, GTimerFunction fn, void *param, bool_t periodic, systime_t millisec);
+void gtimerStop(GTimer *pt);
+bool_t gtimerIsActive(GTimer *pt);
+void gtimerJab(GTimer *pt);
+void gtimerJabI(GTimer *pt);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* GFX_USE_GTIMER */
+
+#endif /* _GTIMER_H */
+/** @} */
+
|