aboutsummaryrefslogtreecommitdiffstats
path: root/include/gtimer
diff options
context:
space:
mode:
authorJoel Bodenmann <joel@unormal.org>2012-12-18 23:15:47 +0100
committerJoel Bodenmann <joel@unormal.org>2012-12-18 23:15:47 +0100
commita520a32209cc6057b985bde5d0ad21a8f4186bf2 (patch)
treeea0aad71d6370c9ef1840607ed69680dd7f6a159 /include/gtimer
parenta75653f7a1dbe7fc8317fcc3d8d2331855d3a036 (diff)
downloaduGFX-a520a32209cc6057b985bde5d0ad21a8f4186bf2.tar.gz
uGFX-a520a32209cc6057b985bde5d0ad21a8f4186bf2.tar.bz2
uGFX-a520a32209cc6057b985bde5d0ad21a8f4186bf2.zip
more doxygen
Diffstat (limited to 'include/gtimer')
-rw-r--r--include/gtimer/gtimer.h12
1 files changed, 12 insertions, 0 deletions
diff --git a/include/gtimer/gtimer.h b/include/gtimer/gtimer.h
index 623120dc..b286d84e 100644
--- a/include/gtimer/gtimer.h
+++ b/include/gtimer/gtimer.h
@@ -22,6 +22,18 @@
* @brief GTIMER GFX User Timer subsystem header file.
*
* @addtogroup GTIMER
+ *
+ * @details The reason why ChibiOS/GFX has it's own timer abstraction is because
+ * virtual timers provided by ChibiOS/RT are interrupt context only.
+ * While great for what they are designed for, they make coding of the input
+ * drivers much more complex.
+ * For non-performance critical drivers like these input drivers, it would also
+ * hog an in-ordinate amount of critical (interrupt locked) system time.
+ * This contrary to the goals of a real-time operating system. So a user-land
+ * (thread based) timer mechanism is also required.
+ *
+ * @pre GFX_USE_GTIMER must be set to TRUE in your gfxconf.h
+ *
* @{
*/
#ifndef _GTIMER_H