diff options
Diffstat (limited to 'drivers')
-rw-r--r-- | drivers/touchpad/ADS7843/touchpad_lld.c | 27 | ||||
-rw-r--r-- | drivers/touchpad/ADS7843/touchpad_lld_config.h | 3 | ||||
-rw-r--r-- | drivers/touchpad/XPT2046/touchpad_lld.c | 24 | ||||
-rw-r--r-- | drivers/touchpad/XPT2046/touchpad_lld_config.h | 3 |
4 files changed, 22 insertions, 35 deletions
diff --git a/drivers/touchpad/ADS7843/touchpad_lld.c b/drivers/touchpad/ADS7843/touchpad_lld.c index ac375e60..74b06095 100644 --- a/drivers/touchpad/ADS7843/touchpad_lld.c +++ b/drivers/touchpad/ADS7843/touchpad_lld.c @@ -19,11 +19,10 @@ */
/**
- * @file drivers/touchpad/ADS7843/touchpad_lld.c
+ * @file drivers/touchpad/XPT2046/touchpad_lld.c
* @brief Touchpad Driver subsystem low level driver source.
*
- * @defgroup ADS7843
- * @ingroup DRIVERS
+ * @addtogroup TOUCHPAD
* @{
*/
@@ -86,6 +85,7 @@ void tp_lld_init(const TOUCHPADDriver *tp) { * @param[in] cmd The command bits to send to the touchpad
*
* @return The read value 12-bit right-justified
+ *
* @note This function only reads data, it is assumed that the pins are
* configured properly and the bus has been acquired beforehand
*
@@ -107,6 +107,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.
*
* @notapi
@@ -128,10 +129,9 @@ static void tp_lld_filter(void) { }
/**
- * @brief Reads out the X value.
- * @note The samples are median filtered for greater noise reduction
+ * @brief Reads out the X direction.
*
- * @return The uncalibrated but filtered X value
+ * @note The samples are median filtered for greater noise reduction
*
* @notapi
*/
@@ -170,11 +170,8 @@ uint16_t tp_lld_read_x(void) { return sampleBuf[3];
}
-/**
- * @brief Reads out the Y value.
- * @note The samples are median filtered for greater noise reduction
- *
- * @return The uncalibrated but filtered Y value
+/*
+ * @brief Reads out the Y direction.
*
* @notapi
*/
@@ -215,8 +212,8 @@ uint16_t tp_lld_read_y(void) { /* ---- Optional Routines ---- */
#if TOUCHPAD_HAS_IRQ || defined(__DOXYGEN__)
- /**
- * @brief For checking if touchpad is pressed or not.
+ /*
+ * @brief for checking if touchpad is pressed or not.
*
* @return 1 if pressed / 0 if not pressed
*
@@ -228,11 +225,9 @@ uint16_t tp_lld_read_y(void) { #endif
#if TOUCHPAD_HAS_PRESSURE || defined(__DOXYGEN__)
- /**
+ /*
* @brief Reads out the Z direction / pressure.
*
- * @return The amount of preasure
- *
* @notapi
*/
uint16_t tp_lld_read_z(void) {
diff --git a/drivers/touchpad/ADS7843/touchpad_lld_config.h b/drivers/touchpad/ADS7843/touchpad_lld_config.h index dd2c9dda..13b48922 100644 --- a/drivers/touchpad/ADS7843/touchpad_lld_config.h +++ b/drivers/touchpad/ADS7843/touchpad_lld_config.h @@ -22,8 +22,7 @@ * @file drivers/touchpad/ADS7843/touchpad_lld_config.h
* @brief Touchpad Driver subsystem low level driver.
*
- * @defgroup ADS7843
- * @ingroup DRIVERS
+ * @addtogroup TOUCHPAD
* @{
*/
diff --git a/drivers/touchpad/XPT2046/touchpad_lld.c b/drivers/touchpad/XPT2046/touchpad_lld.c index 42f3e8d2..50ff6acc 100644 --- a/drivers/touchpad/XPT2046/touchpad_lld.c +++ b/drivers/touchpad/XPT2046/touchpad_lld.c @@ -22,8 +22,7 @@ * @file drivers/touchpad/XPT2046/touchpad_lld.c
* @brief Touchpad Driver subsystem low level driver source.
*
- * @defgroup XPT2046
- * @ingroup DRIVERS
+ * @addtogroup TOUCHPAD
* @{
*/
@@ -108,7 +107,8 @@ 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,9 @@ static void tp_lld_filter(void) { }
/**
- * @brief Reads out the X value.
- * @note The samples are median filtered for greater noise reduction
+ * @brief Reads out the X direction.
*
- * @return The uncalibrated but filtered X value
+ * @note The samples are median filtered for greater noise reduction
*
* @notapi
*/
@@ -171,11 +170,8 @@ uint16_t tp_lld_read_x(void) { return sampleBuf[3];
}
-/**
- * @brief Reads out the Y value.
- * @note The samples are median filtered for greated noise reduction
- *
- * @return The uncalibrated but filtered Y value
+/*
+ * @brief Reads out the Y direction.
*
* @notapi
*/
@@ -216,7 +212,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
@@ -229,11 +225,9 @@ 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) {
diff --git a/drivers/touchpad/XPT2046/touchpad_lld_config.h b/drivers/touchpad/XPT2046/touchpad_lld_config.h index d0d1fb61..f1cd9ff5 100644 --- a/drivers/touchpad/XPT2046/touchpad_lld_config.h +++ b/drivers/touchpad/XPT2046/touchpad_lld_config.h @@ -22,8 +22,7 @@ * @file drivers/touchpad/XPT2046/touchpad_lld_config.h
* @brief Touchppad Driver subsystem low level driver.
*
- * @defgroup XPT2046
- * @ingroup DRIVERS
+ * @addtogroup TOUCHPAD
* @{
*/
|