aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/ginput/touch/STMPE811/ginput_lld_mouse_board_example.h
diff options
context:
space:
mode:
Diffstat (limited to 'drivers/ginput/touch/STMPE811/ginput_lld_mouse_board_example.h')
-rw-r--r--drivers/ginput/touch/STMPE811/ginput_lld_mouse_board_example.h88
1 files changed, 88 insertions, 0 deletions
diff --git a/drivers/ginput/touch/STMPE811/ginput_lld_mouse_board_example.h b/drivers/ginput/touch/STMPE811/ginput_lld_mouse_board_example.h
new file mode 100644
index 00000000..fbedcb60
--- /dev/null
+++ b/drivers/ginput/touch/STMPE811/ginput_lld_mouse_board_example.h
@@ -0,0 +1,88 @@
+/*
+ ChibiOS/GFX - Copyright (C) 2012, 2013
+ 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 drivers/ginput/touch/STMPE811/ginput_lld_mouse_board_example.h
+ * @brief GINPUT Touch low level driver source for the STMPE811 on the example board.
+ *
+ * @defgroup Mouse Mouse
+ * @ingroup GINPUT
+ * @{
+ */
+
+#ifndef _GINPUT_LLD_MOUSE_BOARD_H
+#define _GINPUT_LLD_MOUSE_BOARD_H
+
+/**
+ * @brief Initialise the board for the touch.
+ *
+ * @notapi
+ */
+static inline void init_board(void) {
+ /* Code here */
+ #error "ginputSTMPE811: You must supply a definition for init_board for your board"
+}
+
+/**
+ * @brief Check whether the surface is currently touched
+ * @return TRUE if the surface is currently touched
+ *
+ * @notapi
+ */
+static inline bool_t getpin_pressed(void) {
+ /* Code here */
+ #error "ginputSTMPE811: You must supply a definition for getpin_pressed for your board"
+}
+
+/**
+ * @brief Aquire the bus ready for readings
+ *
+ * @notapi
+ */
+static inline void aquire_bus(void) {
+ /* Code here */
+ #error "ginputSTMPE811: You must supply a definition for aquire_bus for your board"
+}
+
+/**
+ * @brief Release the bus after readings
+ *
+ * @notapi
+ */
+static inline void release_bus(void) {
+ /* Code here */
+ #error "ginputSTMPE811: You must supply a definition for release_bus for your board"
+}
+
+/**
+ * @brief Read a value from touch controller
+ * @return The value read from the controller
+ *
+ * params[in] port The controller port to read.
+ *
+ * @notapi
+ */
+static inline uint16_t read_value(uint16_t port) {
+ /* Code here */
+ #error "ginputSTMPE811: You must supply a definition for read_value for your board"
+}
+
+#endif /* _GINPUT_LLD_MOUSE_BOARD_H */
+/** @} */