diff options
Diffstat (limited to 'drivers/touchpad/XPT2046/touchpad_lld.c')
| -rw-r--r-- | drivers/touchpad/XPT2046/touchpad_lld.c | 24 |
1 files changed, 15 insertions, 9 deletions
diff --git a/drivers/touchpad/XPT2046/touchpad_lld.c b/drivers/touchpad/XPT2046/touchpad_lld.c index 50ff6acc..42f3e8d2 100644 --- a/drivers/touchpad/XPT2046/touchpad_lld.c +++ b/drivers/touchpad/XPT2046/touchpad_lld.c @@ -22,7 +22,8 @@ * @file drivers/touchpad/XPT2046/touchpad_lld.c
* @brief Touchpad Driver subsystem low level driver source.
*
- * @addtogroup TOUCHPAD
+ * @defgroup XPT2046
+ * @ingroup DRIVERS
* @{
*/
@@ -107,8 +108,7 @@ uint16_t tp_lld_read_value(uint8_t cmd) { /**
* @brief 7-point median filtering code for touchpad samples
- *
- * @note This is an internally used routine only.
+ * @note This is an internally used routine only
*
* @notapi
*/
@@ -129,10 +129,11 @@ static void tp_lld_filter(void) { }
/**
- * @brief Reads out the X direction.
- *
+ * @brief Reads out the X value.
* @note The samples are median filtered for greater noise reduction
*
+ * @return The uncalibrated but filtered X value
+ *
* @notapi
*/
uint16_t tp_lld_read_x(void) {
@@ -170,8 +171,11 @@ uint16_t tp_lld_read_x(void) { return sampleBuf[3];
}
-/*
- * @brief Reads out the Y direction.
+/**
+ * @brief Reads out the Y value.
+ * @note The samples are median filtered for greated noise reduction
+ *
+ * @return The uncalibrated but filtered Y value
*
* @notapi
*/
@@ -212,7 +216,7 @@ uint16_t tp_lld_read_y(void) { /* ---- Optional Routines ---- */
#if TOUCHPAD_HAS_IRQ || defined(__DOXYGEN__)
- /*
+ /**
* @brief for checking if touchpad is pressed or not.
*
* @return 1 if pressed / 0 if not pressed
@@ -225,9 +229,11 @@ uint16_t tp_lld_read_y(void) { #endif
#if TOUCHPAD_HAS_PRESSURE || defined(__DOXYGEN__)
- /*
+ /**
* @brief Reads out the Z direction / pressure.
*
+ * @return The mount of preasure
+ *
* @notapi
*/
uint16_t tp_lld_read_z(void) {
|