aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/ginput
diff options
context:
space:
mode:
authorJoel Bodenmann <joel@unormal.org>2014-03-28 19:45:08 +0100
committerJoel Bodenmann <joel@unormal.org>2014-03-28 19:45:08 +0100
commit08e1b0ebc7a5b9a960994e16710465dfb67f66ee (patch)
tree72137dac1330a3ebb41b294a8d762b98dc559553 /drivers/ginput
parent16f86ed2e6980fd0ddfa4cedb6bdaf51881f0e3c (diff)
downloaduGFX-08e1b0ebc7a5b9a960994e16710465dfb67f66ee.tar.gz
uGFX-08e1b0ebc7a5b9a960994e16710465dfb67f66ee.tar.bz2
uGFX-08e1b0ebc7a5b9a960994e16710465dfb67f66ee.zip
Removed the doxygen inside of every driver as doxygen is only meant for highlevel API documentation.
Documenting the drivers interface should be done inside a template driver or the gdisp LLD abstraction.
Diffstat (limited to 'drivers/ginput')
-rw-r--r--drivers/ginput/dial/GADC/ginput_lld_dial.c10
-rw-r--r--drivers/ginput/dial/GADC/ginput_lld_dial_board_template.h11
-rw-r--r--drivers/ginput/dial/GADC/ginput_lld_dial_config.h10
-rw-r--r--drivers/ginput/toggle/Pal/ginput_lld_toggle.c24
-rw-r--r--drivers/ginput/toggle/Pal/ginput_lld_toggle_board_template.h10
-rw-r--r--drivers/ginput/toggle/Pal/ginput_lld_toggle_config.h10
-rw-r--r--drivers/ginput/touch/ADS7843/ginput_lld_mouse.c36
-rw-r--r--drivers/ginput/touch/ADS7843/ginput_lld_mouse_board_template.h40
-rw-r--r--drivers/ginput/touch/ADS7843/ginput_lld_mouse_config.h11
-rw-r--r--drivers/ginput/touch/FT5x06/ft5x06.h10
-rw-r--r--drivers/ginput/touch/FT5x06/ginput_lld_mouse.c30
-rw-r--r--drivers/ginput/touch/FT5x06/ginput_lld_mouse_board_template.h41
-rw-r--r--drivers/ginput/touch/FT5x06/ginput_lld_mouse_config.h11
-rw-r--r--drivers/ginput/touch/MCU/ginput_lld_mouse.c39
-rw-r--r--drivers/ginput/touch/MCU/ginput_lld_mouse_board_template.h68
-rw-r--r--drivers/ginput/touch/MCU/ginput_lld_mouse_config_template.h11
-rw-r--r--drivers/ginput/touch/STMPE811/ginput_lld_mouse.c32
-rw-r--r--drivers/ginput/touch/STMPE811/ginput_lld_mouse_board_template.h41
-rw-r--r--drivers/ginput/touch/STMPE811/ginput_lld_mouse_config.h11
-rw-r--r--drivers/ginput/touch/STMPE811/stmpe811.h9
20 files changed, 1 insertions, 464 deletions
diff --git a/drivers/ginput/dial/GADC/ginput_lld_dial.c b/drivers/ginput/dial/GADC/ginput_lld_dial.c
index cefe5689..c07419bc 100644
--- a/drivers/ginput/dial/GADC/ginput_lld_dial.c
+++ b/drivers/ginput/dial/GADC/ginput_lld_dial.c
@@ -5,15 +5,6 @@
* http://ugfx.org/license.html
*/
-/**
- * @file drivers/ginput/dial/GADC/ginput_lld_dial.c
- * @brief GINPUT Dial low level driver source for GADC hardware.
- *
- * @defgroup Dial Dial
- * @ingroup GINPUT
- * @{
- */
-
#include "gfx.h"
#if GFX_USE_GINPUT && GINPUT_NEED_DIAL
@@ -83,4 +74,3 @@ void ginput_lld_dial_poll(DialCallbackFn fn) {
}
#endif /* GFX_USE_GINPUT && GINPUT_NEED_DIAL */
-/** @} */
diff --git a/drivers/ginput/dial/GADC/ginput_lld_dial_board_template.h b/drivers/ginput/dial/GADC/ginput_lld_dial_board_template.h
index 202b5386..e10e52f6 100644
--- a/drivers/ginput/dial/GADC/ginput_lld_dial_board_template.h
+++ b/drivers/ginput/dial/GADC/ginput_lld_dial_board_template.h
@@ -5,15 +5,6 @@
* http://ugfx.org/license.html
*/
-/**
- * @file drivers/ginput/dial/GADC/ginput_lld_dial_board_template.h
- * @brief GINPUT Dial Driver config file.
- *
- * @defgroup Dial Dial
- * @ingroup GINPUT
- * @{
- */
-
#ifndef _GINPUT_LLD_DIAL_BOARD_H
#define _GINPUT_LLD_DIAL_BOARD_H
@@ -32,5 +23,3 @@
#endif /* GFX_USE_GINPUT && GINPUT_NEED_DIAL */
#endif /* _GINPUT_LLD_DIAL_BOARD_H */
-/** @} */
-
diff --git a/drivers/ginput/dial/GADC/ginput_lld_dial_config.h b/drivers/ginput/dial/GADC/ginput_lld_dial_config.h
index 3e54b4ca..45c61c1d 100644
--- a/drivers/ginput/dial/GADC/ginput_lld_dial_config.h
+++ b/drivers/ginput/dial/GADC/ginput_lld_dial_config.h
@@ -5,15 +5,6 @@
* http://ugfx.org/license.html
*/
-/**
- * @file drivers/ginput/dial/GADC/ginput_lld_dial_config.h
- * @brief GINPUT Dial Driver configuration header.
- *
- * @defgroup Dial Dial
- * @ingroup GINPUT
- * @{
- */
-
#ifndef _GINPUT_LLD_DIAL_CONFIG_H
#define _GINPUT_LLD_DIAL_CONFIG_H
@@ -27,4 +18,3 @@
#endif /* GFX_USE_GDISP && GINPUT_NEED_DIAL */
#endif /* _GINPUT_LLD_DIAL_CONFIG_H */
-/** @} */
diff --git a/drivers/ginput/toggle/Pal/ginput_lld_toggle.c b/drivers/ginput/toggle/Pal/ginput_lld_toggle.c
index 09290f17..f42d222f 100644
--- a/drivers/ginput/toggle/Pal/ginput_lld_toggle.c
+++ b/drivers/ginput/toggle/Pal/ginput_lld_toggle.c
@@ -5,15 +5,6 @@
* http://ugfx.org/license.html
*/
-/**
- * @file drivers/ginput/toggle/Pal/ginput_lld_toggle.c
- * @brief GINPUT Toggle low level driver source for the ChibiOS PAL hardware.
- *
- * @defgroup Toggle Toggle
- * @ingroup GINPUT
- * @{
- */
-
#include "gfx.h"
#if (GFX_USE_GINPUT && GINPUT_NEED_TOGGLE) /*|| defined(__DOXYGEN__)*/
@@ -22,27 +13,12 @@
GINPUT_TOGGLE_DECLARE_STRUCTURE();
-/**
- * @brief Initialise the port.
- *
- * @param[in] ptc A pointer to one of the entries in GInputToggleConfigTable
- *
- * @notapi
- */
void ginput_lld_toggle_init(const GToggleConfig *ptc) {
palSetGroupMode(((IOBus *)ptc->id)->portid, ptc->mask, 0, ptc->mode);
}
-/**
- * @brief Get the bits from the port.
- *
- * @param[in] ptc A pointer to one of the entries in GInputToggleConfigTable
- *
- * @notapi
- */
unsigned ginput_lld_toggle_getbits(const GToggleConfig *ptc) {
return palReadBus((IOBus *)ptc->id);
}
#endif /* GFX_USE_GINPUT && GINPUT_NEED_TOGGLE */
-/** @} */
diff --git a/drivers/ginput/toggle/Pal/ginput_lld_toggle_board_template.h b/drivers/ginput/toggle/Pal/ginput_lld_toggle_board_template.h
index 84038d16..049160f5 100644
--- a/drivers/ginput/toggle/Pal/ginput_lld_toggle_board_template.h
+++ b/drivers/ginput/toggle/Pal/ginput_lld_toggle_board_template.h
@@ -5,15 +5,6 @@
* http://ugfx.org/license.html
*/
-/**
- * @file drivers/ginput/toggle/Pal/ginput_lld_toggle_board_template.h
- * @brief GINPUT Toggle low level driver source for the ChibiOS PAL hardware on the example board.
- *
- * @defgroup Toggle Toggle
- * @ingroup GINPUT
- * @{
- */
-
#ifndef _GDISP_LLD_TOGGLE_BOARD_H
#define _GDISP_LLD_TOGGLE_BOARD_H
@@ -45,4 +36,3 @@
}
#endif /* _GDISP_LLD_TOGGLE_BOARD_H */
-/** @} */
diff --git a/drivers/ginput/toggle/Pal/ginput_lld_toggle_config.h b/drivers/ginput/toggle/Pal/ginput_lld_toggle_config.h
index 84155956..0ae2aa3f 100644
--- a/drivers/ginput/toggle/Pal/ginput_lld_toggle_config.h
+++ b/drivers/ginput/toggle/Pal/ginput_lld_toggle_config.h
@@ -3,15 +3,6 @@
* the license was not distributed with this file, you can obtain one at:
*
* http://ugfx.org/license.html
- */
-
-/**
- * @file drivers/ginput/toggle/Pal/ginput_lld_toggle_config.h
- * @brief GINPUT Toggle Driver configuration header.
- *
- * @defgroup Toggle Toggle
- * @ingroup GINPUT
- * @{
*/
#ifndef _GINPUT_LLD_TOGGLE_CONFIG_H
@@ -25,4 +16,3 @@
#endif /* GFX_USE_GDISP && GINPUT_NEED_TOGGLE */
#endif /* _GINPUT_LLD_TOGGLE_CONFIG_H */
-/** @} */
diff --git a/drivers/ginput/touch/ADS7843/ginput_lld_mouse.c b/drivers/ginput/touch/ADS7843/ginput_lld_mouse.c
index 890b65ae..cb9b6f4e 100644
--- a/drivers/ginput/touch/ADS7843/ginput_lld_mouse.c
+++ b/drivers/ginput/touch/ADS7843/ginput_lld_mouse.c
@@ -5,15 +5,6 @@
* http://ugfx.org/license.html
*/
-/**
- * @file drivers/ginput/touch/ADS7843/ginput_lld_mouse.c
- * @brief GINPUT Touch low level driver source for the ADS7843.
- *
- * @defgroup Mouse Mouse
- * @ingroup GINPUT
- * @{
- */
-
#include "gfx.h"
#if (GFX_USE_GINPUT && GINPUT_NEED_MOUSE) /*|| defined(__DOXYGEN__)*/
@@ -34,13 +25,6 @@
static uint16_t sampleBuf[7];
static coord_t lastx, lasty;
-/**
- * @brief 7-point median filtering code for touch samples
- *
- * @note This is an internally used routine only.
- *
- * @notapi
- */
static void filter(void) {
uint16_t temp;
int i,j;
@@ -57,29 +41,10 @@ static void filter(void) {
}
}
-/**
- * @brief Initialise the mouse/touch.
- *
- * @notapi
- */
void ginput_lld_mouse_init(void) {
init_board();
}
-/**
- * @brief Read the mouse/touch position.
- *
- * @param[in] pt A pointer to the structure to fill
- *
- * @note For drivers that don't support returning a position
- * when the touch is up (most touch devices), it should
- * return the previous position with the new Z value.
- * The z value is the pressure for those touch devices
- * that support it (-100 to 100 where > 0 is touched)
- * or, 0 or 100 for those drivers that don't.
- *
- * @notapi
- */
void ginput_lld_mouse_get_reading(MouseReading *pt) {
uint16_t i;
@@ -127,4 +92,3 @@ void ginput_lld_mouse_get_reading(MouseReading *pt) {
}
#endif /* GFX_USE_GINPUT && GINPUT_NEED_MOUSE */
-/** @} */
diff --git a/drivers/ginput/touch/ADS7843/ginput_lld_mouse_board_template.h b/drivers/ginput/touch/ADS7843/ginput_lld_mouse_board_template.h
index b4699c76..09783adf 100644
--- a/drivers/ginput/touch/ADS7843/ginput_lld_mouse_board_template.h
+++ b/drivers/ginput/touch/ADS7843/ginput_lld_mouse_board_template.h
@@ -5,67 +5,27 @@
* http://ugfx.org/license.html
*/
-/**
- * @file drivers/ginput/touch/ADS7843/ginput_lld_mouse_board_template.h
- * @brief GINPUT Touch low level driver source for the ADS7843 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) {
}
-/**
- * @brief Check whether the surface is currently touched
- * @return TRUE if the surface is currently touched
- *
- * @notapi
- */
static inline bool_t getpin_pressed(void) {
}
-/**
- * @brief Aquire the bus ready for readings
- *
- * @notapi
- */
static inline void aquire_bus(void) {
}
-/**
- * @brief Release the bus after readings
- *
- * @notapi
- */
static inline void release_bus(void) {
}
-/**
- * @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) {
}
#endif /* _GINPUT_LLD_MOUSE_BOARD_H */
-/** @} */
-
diff --git a/drivers/ginput/touch/ADS7843/ginput_lld_mouse_config.h b/drivers/ginput/touch/ADS7843/ginput_lld_mouse_config.h
index 5c959521..31840a51 100644
--- a/drivers/ginput/touch/ADS7843/ginput_lld_mouse_config.h
+++ b/drivers/ginput/touch/ADS7843/ginput_lld_mouse_config.h
@@ -5,16 +5,6 @@
* http://ugfx.org/license.html
*/
-/**
- * @file drivers/ginput/touch/ADS7843/ginput_lld_mouse_config.h
- * @brief GINPUT LLD header file for mouse/touch driver.
- *
- * @defgroup Mouse Mouse
- * @ingroup GINPUT
- *
- * @{
- */
-
#ifndef _LLD_GINPUT_MOUSE_CONFIG_H
#define _LLD_GINPUT_MOUSE_CONFIG_H
@@ -29,4 +19,3 @@
#define GINPUT_MOUSE_CLICK_TIME 500
#endif /* _LLD_GINPUT_MOUSE_CONFIG_H */
-/** @} */
diff --git a/drivers/ginput/touch/FT5x06/ft5x06.h b/drivers/ginput/touch/FT5x06/ft5x06.h
index 2b91d1c6..bfc1d080 100644
--- a/drivers/ginput/touch/FT5x06/ft5x06.h
+++ b/drivers/ginput/touch/FT5x06/ft5x06.h
@@ -5,14 +5,6 @@
* http://ugfx.org/license.html
*/
-/**
- * @file drivers/ginput/touch/FT5x06/ft5x06.h
- * @brief Register definition header for the STMPE811 touch controller.
- *
- * @addtogroup GINPUT
- * @{
- */
-
#ifndef _FT5x06_H
#define _FT5x06_H
@@ -78,5 +70,3 @@
#define FT5x06_ID_G_ERR 0xA9
#endif /* _FT5x06_H */
-/** @} */
-
diff --git a/drivers/ginput/touch/FT5x06/ginput_lld_mouse.c b/drivers/ginput/touch/FT5x06/ginput_lld_mouse.c
index 43baa9b7..7a50c5f6 100644
--- a/drivers/ginput/touch/FT5x06/ginput_lld_mouse.c
+++ b/drivers/ginput/touch/FT5x06/ginput_lld_mouse.c
@@ -5,15 +5,6 @@
* http://ugfx.org/license.html
*/
-/**
- * @file drivers/ginput/touch/STMPE811/ginput_lld_mouse.c
- * @brief GINPUT Touch low level driver source for the STMPE811.
- *
- * @defgroup Mouse Mouse
- * @ingroup GINPUT
- * @{
- */
-
#include "gfx.h"
#if (GFX_USE_GINPUT && GINPUT_NEED_MOUSE) /*|| defined(__DOXYGEN__)*/
@@ -28,11 +19,6 @@
static coord_t x, y, z;
static uint8_t touched;
-/**
- * @brief Initialise the mouse/touch.
- *
- * @notapi
- */
void ginput_lld_mouse_init(void) {
init_board();
@@ -65,20 +51,6 @@ void ginput_lld_mouse_init(void) {
write_reg(FT5x06_ID_G_PERIODMONITOR, 1, 0x28);
}
-/**
- * @brief Read the mouse/touch position.
- *
- * @param[in] pt A pointer to the structure to fill
- *
- * @note For drivers that don't support returning a position
- * when the touch is up (most touch devices), it should
- * return the previous position with the new Z value.
- * The z value is the pressure for those touch devices
- * that support it (-100 to 100 where > 0 is touched)
- * or, 0 or 100 for those drivers that don't.
- *
- * @notapi
- */
void ginput_lld_mouse_get_reading(MouseReading *pt) {
// Poll to get the touched status
uint8_t last_touched;
@@ -114,5 +86,3 @@ void ginput_lld_mouse_get_reading(MouseReading *pt) {
}
#endif /* GFX_USE_GINPUT && GINPUT_NEED_MOUSE */
-/** @} */
-
diff --git a/drivers/ginput/touch/FT5x06/ginput_lld_mouse_board_template.h b/drivers/ginput/touch/FT5x06/ginput_lld_mouse_board_template.h
index d13881da..b7744a49 100644
--- a/drivers/ginput/touch/FT5x06/ginput_lld_mouse_board_template.h
+++ b/drivers/ginput/touch/FT5x06/ginput_lld_mouse_board_template.h
@@ -5,64 +5,23 @@
* http://ugfx.org/license.html
*/
-/**
- * @file drivers/ginput/touch/FT5x06/ginput_lld_mouse_board_template.h
- * @brief GINPUT Touch low level driver source for the FT5x06 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 void init_board(void) {
}
-/**
- * @brief Check whether an interrupt is raised
- * @return TRUE if there is an interrupt signal present
- *
- * @notapi
- */
static inline bool_t getpin_irq(void) {
}
-/**
- * @brief Write a value into a certain register
- *
- * @param[in] reg The register address
- * @param[in] n The amount of bytes (one or two)
- * @param[in] val The value
- *
- * @notapi
- */
static void write_reg(uint8_t reg, uint8_t n, uint16_t val) {
}
-/**
- * @brief Read the value of a certain register
- *
- * @param[in] reg The register address
- * @param[in] n The amount of bytes (one or two)
- *
- * @return Data read from device (one byte or two depending on n param)
- *
- * @notapi
- */
static uint16_t read_reg(uint8_t reg, uint8_t n) {
}
#endif /* _GINPUT_LLD_MOUSE_BOARD_H */
-/** @} */
-
diff --git a/drivers/ginput/touch/FT5x06/ginput_lld_mouse_config.h b/drivers/ginput/touch/FT5x06/ginput_lld_mouse_config.h
index 57d3f135..24335a0a 100644
--- a/drivers/ginput/touch/FT5x06/ginput_lld_mouse_config.h
+++ b/drivers/ginput/touch/FT5x06/ginput_lld_mouse_config.h
@@ -5,16 +5,6 @@
* http://ugfx.org/license.html
*/
-/**
- * @file drivers/ginput/touch/STMPE811/ginput_lld_mouse_config.h
- * @brief GINPUT LLD header file for mouse/touch driver.
- *
- * @defgroup Mouse Mouse
- * @ingroup GINPUT
- *
- * @{
- */
-
#ifndef _LLD_GINPUT_MOUSE_CONFIG_H
#define _LLD_GINPUT_MOUSE_CONFIG_H
@@ -29,4 +19,3 @@
#define GINPUT_MOUSE_CLICK_TIME 450
#endif /* _LLD_GINPUT_MOUSE_CONFIG_H */
-/** @} */
diff --git a/drivers/ginput/touch/MCU/ginput_lld_mouse.c b/drivers/ginput/touch/MCU/ginput_lld_mouse.c
index d7a2e314..ad2519e4 100644
--- a/drivers/ginput/touch/MCU/ginput_lld_mouse.c
+++ b/drivers/ginput/touch/MCU/ginput_lld_mouse.c
@@ -5,16 +5,6 @@
* http://ugfx.org/license.html
*/
-/**
- * @file drivers/ginput/touch/MCU/ginput_lld_mouse.c
- * @brief GINPUT Touch low level driver source for the MCU.
- *
- * @defgroup Mouse Mouse
- * @ingroup GINPUT
- *
- * @{
- */
-
#include "gfx.h"
#if (GFX_USE_GINPUT && GINPUT_NEED_MOUSE) /*|| defined(__DOXYGEN__)*/
@@ -25,13 +15,6 @@
static uint16_t sampleBuf[7];
-/**
- * @brief 7-point median filtering code for touchscreen samples
- *
- * @note This is an internally used routine only.
- *
- * @notapi
- */
static void filter(void) {
uint16_t temp;
int i,j;
@@ -48,31 +31,10 @@ static void filter(void) {
}
}
-/**
- * @brief Initialise the mouse/touch.
- *
- * @notapi
- */
void ginput_lld_mouse_init(void) {
init_board();
}
-/**
- * @brief Read the mouse/touch position.
- *
- * @param[in] pt A pointer to the structure to fill
- *
- * @note We use a 7 sample medium filter on each coordinate to remove analogue noise.
- * @note During touch transition the ADC can return some very strange
- * results. To fix this behaviour we don't return until
- * we have tested the touch is in the same state at both the beginning
- * and the end of the reading.
- * @note Whilst x and y can return readings in any range so long as it fits in 16 bits,
- * the z value must be ranged by the board file to be a rough percentage. Anything
- * greater than 80% pressure is a touch.
- *
- * @notapi
- */
void ginput_lld_mouse_get_reading(MouseReading *pt) {
uint16_t i;
@@ -116,4 +78,3 @@ void ginput_lld_mouse_get_reading(MouseReading *pt) {
}
#endif /* GFX_USE_GINPUT && GINPUT_NEED_MOUSE */
-/** @} */
diff --git a/drivers/ginput/touch/MCU/ginput_lld_mouse_board_template.h b/drivers/ginput/touch/MCU/ginput_lld_mouse_board_template.h
index 52af9269..e213bcb9 100644
--- a/drivers/ginput/touch/MCU/ginput_lld_mouse_board_template.h
+++ b/drivers/ginput/touch/MCU/ginput_lld_mouse_board_template.h
@@ -5,105 +5,37 @@
* http://ugfx.org/license.html
*/
-/**
- * @file drivers/ginput/touch/MCU/ginput_lld_mouse_board_template.h
- * @brief GINPUT Touch low level driver source for the MCU 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) {
}
-/**
- * @brief Acquire the bus ready for readings
- *
- * @notapi
- */
static inline void aquire_bus(void) {
}
-/**
- * @brief Release the bus after readings
- *
- * @notapi
- */
static inline void release_bus(void) {
}
-/**
- * @brief Set up the device for a x coordinate read
- * @note This is performed once followed by multiple
- * x coordinate read's (which are then median filtered)
- *
- * @notapi
- */
static inline void setup_x(void) {
}
-/**
- * @brief Set up the device for a y coordinate read
- * @note This is performed once followed by multiple
- * y coordinate read's (which are then median filtered)
- *
- * @notapi
- */
static inline void setup_y(void) {
}
-/**
- * @brief Set up the device for a z coordinate (pressure) read
- * @note This is performed once followed by multiple
- * z coordinate read's (which are then median filtered)
- *
- * @notapi
- */
static inline void setup_z(void) {
palClearPad(GPIOB, GPIOB_DRIVEA);
palClearPad(GPIOB, GPIOB_DRIVEB);
chThdSleepMilliseconds(2);
}
-/**
- * @brief Read an x value from touch controller
- * @return The value read from the controller
- *
- * @notapi
- */
static inline uint16_t read_x(void) {
}
-/**
- * @brief Read a y value from touch controller
- * @return The value read from the controller
- *
- * @notapi
- */
static inline uint16_t read_y(void) {
}
-/**
- * @brief Read a z value from touch controller
- * @return The value read from the controller.
- * @note The return value must be scaled between 0 and 100.
- * Values over 80 are considered as "touch" down.
- *
- * @notapi
- */
static inline uint16_t read_z(void) {
}
#endif /* _GINPUT_LLD_MOUSE_BOARD_H */
-/** @} */
-
diff --git a/drivers/ginput/touch/MCU/ginput_lld_mouse_config_template.h b/drivers/ginput/touch/MCU/ginput_lld_mouse_config_template.h
index 0c9e9300..328e6337 100644
--- a/drivers/ginput/touch/MCU/ginput_lld_mouse_config_template.h
+++ b/drivers/ginput/touch/MCU/ginput_lld_mouse_config_template.h
@@ -5,16 +5,6 @@
* http://ugfx.org/license.html
*/
-/**
- * @file drivers/ginput/touch/MCU/ginput_lld_mouse_config.h
- * @brief GINPUT LLD header file for touch driver.
- *
- * @defgroup Mouse Mouse
- * @ingroup GINPUT
- *
- * @{
- */
-
#ifndef _LLD_GINPUT_MOUSE_CONFIG_H
#define _LLD_GINPUT_MOUSE_CONFIG_H
@@ -29,4 +19,3 @@
#define GINPUT_MOUSE_CLICK_TIME 500
#endif /* _LLD_GINPUT_MOUSE_CONFIG_H */
-/** @} */
diff --git a/drivers/ginput/touch/STMPE811/ginput_lld_mouse.c b/drivers/ginput/touch/STMPE811/ginput_lld_mouse.c
index d650e603..e658fae2 100644
--- a/drivers/ginput/touch/STMPE811/ginput_lld_mouse.c
+++ b/drivers/ginput/touch/STMPE811/ginput_lld_mouse.c
@@ -4,16 +4,7 @@
*
* http://ugfx.org/license.html
*/
-
-/**
- * @file drivers/ginput/touch/STMPE811/ginput_lld_mouse.c
- * @brief GINPUT Touch low level driver source for the STMPE811.
- *
- * @defgroup Mouse Mouse
- * @ingroup GINPUT
- * @{
- */
-
+
#include "gfx.h"
#if (GFX_USE_GINPUT && GINPUT_NEED_MOUSE) /*|| defined(__DOXYGEN__)*/
@@ -43,11 +34,6 @@ static void setActiveWindow(uint16_t bl_x, uint16_t bl_y, uint16_t tr_x, uint16_
write_reg(STMPE811_REG_WDW_BL_Y, 2, bl_y);
}
-/**
- * @brief Initialise the mouse/touch.
- *
- * @notapi
- */
void ginput_lld_mouse_init(void)
{
init_board();
@@ -81,20 +67,6 @@ void ginput_lld_mouse_init(void)
write_reg(STMPE811_REG_INT_CTRL, 1, 0x01); // Level interrupt, enable intrrupts
}
-/**
- * @brief Read the mouse/touch position.
- *
- * @param[in] pt A pointer to the structure to fill
- *
- * @note For drivers that don't support returning a position
- * when the touch is up (most touch devices), it should
- * return the previous position with the new Z value.
- * The z value is the pressure for those touch devices
- * that support it (-100 to 100 where > 0 is touched)
- * or, 0 or 100 for those drivers that don't.
- *
- * @notapi
- */
void ginput_lld_mouse_get_reading(MouseReading *pt)
{
bool_t clearfifo; // Do we need to clear the FIFO
@@ -158,5 +130,3 @@ void ginput_lld_mouse_get_reading(MouseReading *pt)
}
#endif /* GFX_USE_GINPUT && GINPUT_NEED_MOUSE */
-/** @} */
-
diff --git a/drivers/ginput/touch/STMPE811/ginput_lld_mouse_board_template.h b/drivers/ginput/touch/STMPE811/ginput_lld_mouse_board_template.h
index 3df898da..b7744a49 100644
--- a/drivers/ginput/touch/STMPE811/ginput_lld_mouse_board_template.h
+++ b/drivers/ginput/touch/STMPE811/ginput_lld_mouse_board_template.h
@@ -5,64 +5,23 @@
* http://ugfx.org/license.html
*/
-/**
- * @file drivers/ginput/touch/STMPE811/ginput_lld_mouse_board_template.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 void init_board(void) {
}
-/**
- * @brief Check whether an interrupt is raised
- * @return TRUE if there is an interrupt signal present
- *
- * @notapi
- */
static inline bool_t getpin_irq(void) {
}
-/**
- * @brief Write a value into a certain register
- *
- * @param[in] reg The register address
- * @param[in] n The amount of bytes (one or two)
- * @param[in] val The value
- *
- * @notapi
- */
static void write_reg(uint8_t reg, uint8_t n, uint16_t val) {
}
-/**
- * @brief Read the value of a certain register
- *
- * @param[in] reg The register address
- * @param[in] n The amount of bytes (one or two)
- *
- * @return Data read from device (one byte or two depending on n param)
- *
- * @notapi
- */
static uint16_t read_reg(uint8_t reg, uint8_t n) {
}
#endif /* _GINPUT_LLD_MOUSE_BOARD_H */
-/** @} */
-
diff --git a/drivers/ginput/touch/STMPE811/ginput_lld_mouse_config.h b/drivers/ginput/touch/STMPE811/ginput_lld_mouse_config.h
index c7427958..5cd512eb 100644
--- a/drivers/ginput/touch/STMPE811/ginput_lld_mouse_config.h
+++ b/drivers/ginput/touch/STMPE811/ginput_lld_mouse_config.h
@@ -5,16 +5,6 @@
* http://ugfx.org/license.html
*/
-/**
- * @file drivers/ginput/touch/STMPE811/ginput_lld_mouse_config.h
- * @brief GINPUT LLD header file for mouse/touch driver.
- *
- * @defgroup Mouse Mouse
- * @ingroup GINPUT
- *
- * @{
- */
-
#ifndef _LLD_GINPUT_MOUSE_CONFIG_H
#define _LLD_GINPUT_MOUSE_CONFIG_H
@@ -33,4 +23,3 @@
#define STMP811_NO_GPIO_IRQPIN FALSE
#endif /* _LLD_GINPUT_MOUSE_CONFIG_H */
-/** @} */
diff --git a/drivers/ginput/touch/STMPE811/stmpe811.h b/drivers/ginput/touch/STMPE811/stmpe811.h
index 494b5f5c..1ee9c211 100644
--- a/drivers/ginput/touch/STMPE811/stmpe811.h
+++ b/drivers/ginput/touch/STMPE811/stmpe811.h
@@ -5,14 +5,6 @@
* http://ugfx.org/license.html
*/
-/**
- * @file drivers/ginput/touch/STMPE811/stmpe811.h
- * @brief Register definition header for the STMPE811 touch controller.
- *
- * @addtogroup GINPUT
- * @{
- */
-
#ifndef _STMPE811_H
#define _STMPE811_H
@@ -89,4 +81,3 @@
#define STMPE811_REG_TEMP_TH 0x62
#endif /* _STMPE811_H */
-/** @} */