diff options
author | Joel Bodenmann <joel@unormal.org> | 2014-03-28 19:45:08 +0100 |
---|---|---|
committer | Joel Bodenmann <joel@unormal.org> | 2014-03-28 19:45:08 +0100 |
commit | 08e1b0ebc7a5b9a960994e16710465dfb67f66ee (patch) | |
tree | 72137dac1330a3ebb41b294a8d762b98dc559553 /drivers/ginput/touch/MCU | |
parent | 16f86ed2e6980fd0ddfa4cedb6bdaf51881f0e3c (diff) | |
download | uGFX-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/touch/MCU')
-rw-r--r-- | drivers/ginput/touch/MCU/ginput_lld_mouse.c | 39 | ||||
-rw-r--r-- | drivers/ginput/touch/MCU/ginput_lld_mouse_board_template.h | 68 | ||||
-rw-r--r-- | drivers/ginput/touch/MCU/ginput_lld_mouse_config_template.h | 11 |
3 files changed, 0 insertions, 118 deletions
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 */ -/** @} */ |